From b8ff4eee30ff0d4cce398fc3be248fe7390d39b9 Mon Sep 17 00:00:00 2001 From: Duncan Beevers Date: Thu, 5 May 2022 06:03:52 -0500 Subject: [PATCH 1/2] fix: Error on missing prettier config When a prettier config file is specified but can't be found a default prettier config is silently used as a fallback. This change causes an error to be raised when the specified prettier config doesn't exist. Closes #908 --- src/index.ts | 5 +- test/bin/cli.test.js | 8 +- test/v2/expected/manifold.immutable.ts | 950 +- test/v2/expected/manifold.ts | 950 +- test/v2/expected/null-in-enum.immutable.ts | 28 +- test/v2/expected/null-in-enum.ts | 28 +- test/v2/expected/petstore.immutable.ts | 468 +- test/v2/expected/petstore.ts | 468 +- .../reference-to-properties.immutable.ts | 26 +- test/v2/expected/reference-to-properties.ts | 26 +- test/v2/expected/stripe.immutable.ts | 34617 ++++++----- test/v2/expected/stripe.ts | 34574 ++++++----- test/v2/fixtures/.prettierrc | 6 + test/v2/index.test.js | 13 +- test/v3/expected/consts-enums.additional.ts | 22 +- .../v3/expected/consts-enums.exported-type.ts | 30 +- test/v3/expected/consts-enums.immutable.ts | 22 +- .../consts-enums.support-array-length.ts | 22 +- test/v3/expected/consts-enums.ts | 22 +- test/v3/expected/consts-object.additional.ts | 16 +- .../expected/consts-object.exported-type.ts | 24 +- test/v3/expected/consts-object.immutable.ts | 16 +- .../consts-object.support-array-length.ts | 16 +- test/v3/expected/consts-object.ts | 16 +- test/v3/expected/github.additional.ts | 39191 ++++++------ test/v3/expected/github.exported-type.ts | 39173 ++++++------ test/v3/expected/github.immutable.ts | 39171 ++++++------ .../expected/github.support-array-length.ts | 39313 ++++++------ test/v3/expected/github.ts | 39165 ++++++------ test/v3/expected/jsdoc.additional.ts | 136 +- test/v3/expected/jsdoc.exported-type.ts | 144 +- test/v3/expected/jsdoc.immutable.ts | 136 +- .../v3/expected/jsdoc.support-array-length.ts | 136 +- test/v3/expected/jsdoc.ts | 136 +- test/v3/expected/manifold.additional.ts | 1092 +- test/v3/expected/manifold.exported-type.ts | 1100 +- test/v3/expected/manifold.immutable.ts | 1092 +- .../expected/manifold.support-array-length.ts | 1092 +- test/v3/expected/manifold.ts | 1092 +- test/v3/expected/null-in-enum.additional.ts | 28 +- .../v3/expected/null-in-enum.exported-type.ts | 36 +- test/v3/expected/null-in-enum.immutable.ts | 28 +- .../null-in-enum.support-array-length.ts | 28 +- test/v3/expected/null-in-enum.ts | 28 +- test/v3/expected/one-of-empty.additional.ts | 20 +- .../v3/expected/one-of-empty.exported-type.ts | 28 +- test/v3/expected/one-of-empty.immutable.ts | 20 +- .../one-of-empty.support-array-length.ts | 20 +- test/v3/expected/one-of-empty.ts | 20 +- .../petstore-openapitools.additional.ts | 532 +- .../petstore-openapitools.exported-type.ts | 540 +- .../petstore-openapitools.immutable.ts | 532 +- ...store-openapitools.support-array-length.ts | 532 +- test/v3/expected/petstore-openapitools.ts | 532 +- test/v3/expected/petstore.additional.ts | 520 +- test/v3/expected/petstore.exported-type.ts | 528 +- test/v3/expected/petstore.immutable.ts | 520 +- .../expected/petstore.support-array-length.ts | 520 +- test/v3/expected/petstore.ts | 520 +- .../reference-to-properties.additional.ts | 28 +- .../reference-to-properties.exported-type.ts | 36 +- .../reference-to-properties.immutable.ts | 28 +- ...ence-to-properties.support-array-length.ts | 28 +- test/v3/expected/reference-to-properties.ts | 28 +- test/v3/expected/stripe.additional.ts | 51150 ++++++++-------- test/v3/expected/stripe.exported-type.ts | 50637 ++++++++------- test/v3/expected/stripe.immutable.ts | 50759 ++++++++------- .../expected/stripe.support-array-length.ts | 50629 ++++++++------- test/v3/expected/stripe.ts | 50629 ++++++++------- test/v3/fixtures/.prettierrc | 6 + test/v3/index.test.js | 26 +- 71 files changed, 266008 insertions(+), 268050 deletions(-) create mode 100644 test/v2/fixtures/.prettierrc create mode 100644 test/v3/fixtures/.prettierrc diff --git a/src/index.ts b/src/index.ts index 5d6714274..3f45ffc1d 100644 --- a/src/index.ts +++ b/src/index.ts @@ -1,5 +1,6 @@ import type { GlobalContext, OpenAPI2, OpenAPI3, SchemaObject, SwaggerToTSOptions } from "./types.js"; import path from "path"; +import fs from "fs"; import prettier from "prettier"; import parserTypescript from "prettier/parser-typescript.js"; import { Readable } from "stream"; @@ -115,7 +116,9 @@ async function openapiTS( }; if (options && options.prettierConfig) { try { - const userOptions = await prettier.resolveConfig(path.resolve(process.cwd(), options.prettierConfig)); + const prettierConfigFile = path.resolve(process.cwd(), options.prettierConfig); + await fs.promises.access(prettierConfigFile, fs.constants.F_OK); + const userOptions = await prettier.resolveConfig(prettierConfigFile); prettierOptions = { ...(userOptions || {}), ...prettierOptions, diff --git a/test/bin/cli.test.js b/test/bin/cli.test.js index 89318223f..3af089430 100644 --- a/test/bin/cli.test.js +++ b/test/bin/cli.test.js @@ -20,7 +20,7 @@ describe("cli", () => { }); it("--prettier-config (.js)", async () => { - execSync(`${cmd} specs/petstore.yaml -o generated/prettier-js.ts --prettier-config fixtures/prettier.config.js`, { + execSync(`${cmd} specs/petstore.yaml -o generated/prettier-js.ts --prettier-config fixtures/prettier.config.cjs`, { cwd, }); const generated = fs.readFileSync(new URL("./generated/prettier-js.ts", cwd), "utf8"); @@ -28,6 +28,12 @@ describe("cli", () => { expect(generated).to.equal(expected); }); + it("--prettier-config (missing)", async () => { + expect(() => { + execSync(`${cmd} specs/petstore.yaml -o generated/prettier-missing.ts --prettier-config NO_SUCH_FILE`); + }).to.throw('NO_SUCH_FILE'); + }); + it("stdout", async () => { const generated = execSync(`${cmd} specs/petstore.yaml`, { cwd }); const expected = eol.lf(fs.readFileSync(new URL("./expected/stdout.ts", cwd), "utf8")); diff --git a/test/v2/expected/manifold.immutable.ts b/test/v2/expected/manifold.immutable.ts index 16c385573..c2769e8f7 100644 --- a/test/v2/expected/manifold.immutable.ts +++ b/test/v2/expected/manifold.immutable.ts @@ -4,224 +4,224 @@ */ export interface paths { - readonly "/regions/": { + readonly '/regions/': { readonly get: { readonly parameters: { readonly query: { /** Filter results to only include the regions that have this location. */ - readonly location?: string; + readonly location?: string /** * Filter results to only include the regions that are on this * platform. */ - readonly platform?: string; - }; - }; + readonly platform?: string + } + } readonly responses: { /** A list of regions. */ readonly 200: { - readonly schema: readonly definitions["Region"][]; - }; + readonly schema: readonly definitions['Region'][] + } /** Unexpected Error */ readonly 500: { - readonly schema: definitions["Error"]; - }; - }; - }; + readonly schema: definitions['Error'] + } + } + } readonly post: { readonly parameters: { readonly body: { /** Region create request */ - readonly body: definitions["CreateRegion"]; - }; - }; + readonly body: definitions['CreateRegion'] + } + } readonly responses: { /** Complete region object */ readonly 201: { - readonly schema: definitions["Region"]; - }; + readonly schema: definitions['Region'] + } /** Invalid request provided */ readonly 400: { - readonly schema: definitions["Error"]; - }; + readonly schema: definitions['Error'] + } /** Region already exists for that platform and location */ readonly 409: { - readonly schema: definitions["Error"]; - }; + readonly schema: definitions['Error'] + } /** Unexpected Error */ readonly 500: { - readonly schema: definitions["Error"]; - }; - }; - }; - }; - readonly "/regions/{id}": { + readonly schema: definitions['Error'] + } + } + } + } + readonly '/regions/{id}': { readonly get: { readonly parameters: { readonly path: { /** ID of the region to lookup, stored as a base32 encoded 18 byte identifier. */ - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** A region. */ readonly 200: { - readonly schema: definitions["Region"]; - }; + readonly schema: definitions['Region'] + } /** Provided Region ID is Invalid */ readonly 400: { - readonly schema: definitions["Error"]; - }; + readonly schema: definitions['Error'] + } /** Region could not be found */ readonly 404: { - readonly schema: definitions["Error"]; - }; + readonly schema: definitions['Error'] + } /** Unexpected Error */ readonly 500: { - readonly schema: definitions["Error"]; - }; - }; - }; + readonly schema: definitions['Error'] + } + } + } readonly patch: { readonly parameters: { readonly path: { /** ID of the region to lookup, stored as a base32 encoded 18 byte identifier. */ - readonly id: string; - }; + readonly id: string + } readonly body: { /** Region update request */ - readonly body: definitions["UpdateRegion"]; - }; - }; + readonly body: definitions['UpdateRegion'] + } + } readonly responses: { /** Complete region object */ readonly 200: { - readonly schema: definitions["Region"]; - }; + readonly schema: definitions['Region'] + } /** Invalid request provided */ readonly 400: { - readonly schema: definitions["Error"]; - }; + readonly schema: definitions['Error'] + } /** Unexpected Error */ readonly 500: { - readonly schema: definitions["Error"]; - }; - }; - }; - }; - readonly "/providers/": { + readonly schema: definitions['Error'] + } + } + } + } + readonly '/providers/': { readonly get: { readonly parameters: { readonly query: { /** Filter results to only include those that have this label. */ - readonly label?: parameters["LabelFilter"]; - }; - }; + readonly label?: parameters['LabelFilter'] + } + } readonly responses: { /** A list of providers. */ readonly 200: { - readonly schema: readonly definitions["Provider"][]; - }; + readonly schema: readonly definitions['Provider'][] + } /** Unexpected Error */ readonly 500: { - readonly schema: definitions["Error"]; - }; - }; - }; + readonly schema: definitions['Error'] + } + } + } readonly post: { readonly parameters: { readonly body: { /** Provider create request */ - readonly body: definitions["CreateProvider"]; - }; - }; + readonly body: definitions['CreateProvider'] + } + } readonly responses: { /** Complete provider object */ readonly 201: { - readonly schema: definitions["Provider"]; - }; + readonly schema: definitions['Provider'] + } /** Invalid request provided */ readonly 400: { - readonly schema: definitions["Error"]; - }; + readonly schema: definitions['Error'] + } /** Forbidden */ readonly 403: { - readonly schema: definitions["Error"]; - }; + readonly schema: definitions['Error'] + } /** Provider already exists with that label */ readonly 409: { - readonly schema: definitions["Error"]; - }; + readonly schema: definitions['Error'] + } /** Unexpected Error */ readonly 500: { - readonly schema: definitions["Error"]; - }; - }; - }; - }; - readonly "/providers/{id}": { + readonly schema: definitions['Error'] + } + } + } + } + readonly '/providers/{id}': { readonly get: { readonly parameters: { readonly path: { /** ID of the provider to lookup, stored as a base32 encoded 18 byte identifier. */ - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** A provider. */ readonly 200: { - readonly schema: definitions["Provider"]; - }; + readonly schema: definitions['Provider'] + } /** Unknown provider error */ readonly 404: { - readonly schema: definitions["Error"]; - }; + readonly schema: definitions['Error'] + } /** Unexpected Error */ readonly 500: { - readonly schema: definitions["Error"]; - }; - }; - }; + readonly schema: definitions['Error'] + } + } + } readonly patch: { readonly parameters: { readonly path: { /** ID of the provider to update, stored as a base32 encoded 18 byte identifier. */ - readonly id: string; - }; + readonly id: string + } readonly body: { /** Provider update request */ - readonly body: definitions["UpdateProvider"]; - }; - }; + readonly body: definitions['UpdateProvider'] + } + } readonly responses: { /** Complete provider object */ readonly 200: { - readonly schema: definitions["Provider"]; - }; + readonly schema: definitions['Provider'] + } /** Invalid request provided */ readonly 400: { - readonly schema: definitions["Error"]; - }; + readonly schema: definitions['Error'] + } /** Forbidden */ readonly 403: { - readonly schema: definitions["Error"]; - }; + readonly schema: definitions['Error'] + } /** Provider not found */ readonly 404: { - readonly schema: definitions["Error"]; - }; + readonly schema: definitions['Error'] + } /** Provider already exists with that label */ readonly 409: { - readonly schema: definitions["Error"]; - }; + readonly schema: definitions['Error'] + } /** Unexpected Error */ readonly 500: { - readonly schema: definitions["Error"]; - }; - }; - }; - }; - readonly "/products/": { + readonly schema: definitions['Error'] + } + } + } + } + readonly '/products/': { readonly get: { readonly parameters: { readonly query: { @@ -229,60 +229,60 @@ export interface paths { * Base32 encoded 18 byte identifier of the provider that these * products must belong to. */ - readonly provider_id?: string; + readonly provider_id?: string /** Filter results to only include those that have this label. */ - readonly label?: parameters["LabelFilter"]; + readonly label?: parameters['LabelFilter'] /** Return only products matching at least one of the tags. */ - readonly tags?: readonly string[]; - }; - }; + readonly tags?: readonly string[] + } + } readonly responses: { /** A product. */ readonly 200: { - readonly schema: readonly definitions["Product"][]; - }; + readonly schema: readonly definitions['Product'][] + } /** Invalid provider_id supplied */ readonly 400: { - readonly schema: definitions["Error"]; - }; + readonly schema: definitions['Error'] + } /** Unexpected Error */ readonly 500: { - readonly schema: definitions["Error"]; - }; - }; - }; + readonly schema: definitions['Error'] + } + } + } readonly post: { readonly parameters: { readonly body: { /** Product create request */ - readonly body: definitions["CreateProduct"]; - }; - }; + readonly body: definitions['CreateProduct'] + } + } readonly responses: { /** Complete product object */ readonly 201: { - readonly schema: definitions["Product"]; - }; + readonly schema: definitions['Product'] + } /** Invalid request provided */ readonly 400: { - readonly schema: definitions["Error"]; - }; + readonly schema: definitions['Error'] + } /** Forbidden */ readonly 403: { - readonly schema: definitions["Error"]; - }; + readonly schema: definitions['Error'] + } /** Product already exists with that label */ readonly 409: { - readonly schema: definitions["Error"]; - }; + readonly schema: definitions['Error'] + } /** Unexpected Error */ readonly 500: { - readonly schema: definitions["Error"]; - }; - }; - }; - }; - readonly "/internal/products": { + readonly schema: definitions['Error'] + } + } + } + } + readonly '/internal/products': { readonly get: { readonly parameters: { readonly query: { @@ -290,32 +290,32 @@ export interface paths { * Base32 encoded 18 byte identifier of the provider that these * products must belong to. */ - readonly provider_id?: string; + readonly provider_id?: string /** Filter results to only include those that have this label. */ - readonly label?: parameters["LabelFilter"]; + readonly label?: parameters['LabelFilter'] /** Return only products matching at least one of the tags. */ - readonly tags?: readonly string[]; + readonly tags?: readonly string[] /** Return product listings without plan information */ - readonly include_plans?: boolean; - }; - }; + readonly include_plans?: boolean + } + } readonly responses: { /** A product. */ readonly 200: { - readonly schema: readonly definitions["ExpandedProduct"][]; - }; + readonly schema: readonly definitions['ExpandedProduct'][] + } /** Invalid provider_id supplied */ readonly 400: { - readonly schema: definitions["Error"]; - }; + readonly schema: definitions['Error'] + } /** Unexpected Error */ readonly 500: { - readonly schema: definitions["Error"]; - }; - }; - }; - }; - readonly "/products/{id}": { + readonly schema: definitions['Error'] + } + } + } + } + readonly '/products/{id}': { readonly get: { readonly parameters: { readonly path: { @@ -323,28 +323,28 @@ export interface paths { * ID of the product to lookup, stored as a base32 encoded 18 byte * identifier. */ - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** A product. */ readonly 200: { - readonly schema: definitions["Product"]; - }; + readonly schema: definitions['Product'] + } /** Invalid Product ID */ readonly 400: { - readonly schema: definitions["Error"]; - }; + readonly schema: definitions['Error'] + } /** Product not found error */ readonly 404: { - readonly schema: definitions["Error"]; - }; + readonly schema: definitions['Error'] + } /** Unexpected error */ readonly 500: { - readonly schema: definitions["Error"]; - }; - }; - }; + readonly schema: definitions['Error'] + } + } + } readonly patch: { readonly parameters: { readonly path: { @@ -352,34 +352,34 @@ export interface paths { * ID of the product to lookup, stored as a base32 encoded 18 byte * identifier. */ - readonly id: string; - }; + readonly id: string + } readonly body: { /** Product update request */ - readonly body: definitions["UpdateProduct"]; - }; - }; + readonly body: definitions['UpdateProduct'] + } + } readonly responses: { /** Complete product object */ readonly 200: { - readonly schema: definitions["Product"]; - }; + readonly schema: definitions['Product'] + } /** Invalid Product ID */ readonly 400: { - readonly schema: definitions["Error"]; - }; + readonly schema: definitions['Error'] + } /** Product not found error */ readonly 404: { - readonly schema: definitions["Error"]; - }; + readonly schema: definitions['Error'] + } /** Unexpected error */ readonly 500: { - readonly schema: definitions["Error"]; - }; - }; - }; - }; - readonly "/plans/{id}": { + readonly schema: definitions['Error'] + } + } + } + } + readonly '/plans/{id}': { readonly get: { readonly parameters: { readonly path: { @@ -387,28 +387,28 @@ export interface paths { * ID of the plan to lookup, stored as a base32 encoded 18 byte * identifier. */ - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** A plan. */ readonly 200: { - readonly schema: definitions["ExpandedPlan"]; - }; + readonly schema: definitions['ExpandedPlan'] + } /** Invalid Plan ID Provided */ readonly 400: { - readonly schema: definitions["Error"]; - }; + readonly schema: definitions['Error'] + } /** Unknown plan error */ readonly 404: { - readonly schema: definitions["Error"]; - }; + readonly schema: definitions['Error'] + } /** Unexpected error */ readonly default: { - readonly schema: definitions["Error"]; - }; - }; - }; + readonly schema: definitions['Error'] + } + } + } readonly patch: { readonly parameters: { readonly path: { @@ -416,93 +416,93 @@ export interface paths { * ID of the plan to lookup, stored as a base32 encoded 18 byte * identifier. */ - readonly id: string; - }; + readonly id: string + } readonly body: { /** Plan update request */ - readonly body: definitions["UpdatePlan"]; - }; - }; + readonly body: definitions['UpdatePlan'] + } + } readonly responses: { /** Complete product plan */ readonly 200: { - readonly schema: definitions["Plan"]; - }; + readonly schema: definitions['Plan'] + } /** Invalid Plan ID */ readonly 400: { - readonly schema: definitions["Error"]; - }; + readonly schema: definitions['Error'] + } /** Plan not found error */ readonly 404: { - readonly schema: definitions["Error"]; - }; + readonly schema: definitions['Error'] + } /** Unexpected error */ readonly 500: { - readonly schema: definitions["Error"]; - }; - }; - }; - }; - readonly "/plans/": { + readonly schema: definitions['Error'] + } + } + } + } + readonly '/plans/': { readonly get: { readonly parameters: { readonly query: { /** Return the plans that are associated with this product. */ - readonly product_id: readonly string[]; + readonly product_id: readonly string[] /** Filter results to only include those that have this label. */ - readonly label?: parameters["LabelFilter"]; - }; - }; + readonly label?: parameters['LabelFilter'] + } + } readonly responses: { /** A list of plans for the given product. */ readonly 200: { - readonly schema: readonly definitions["ExpandedPlan"][]; - }; + readonly schema: readonly definitions['ExpandedPlan'][] + } /** Invalid Parameters Provided */ readonly 400: { - readonly schema: definitions["Error"]; - }; + readonly schema: definitions['Error'] + } /** Could not find product */ readonly 404: { - readonly schema: definitions["Error"]; - }; + readonly schema: definitions['Error'] + } /** Unexpected error */ readonly 500: { - readonly schema: definitions["Error"]; - }; - }; - }; + readonly schema: definitions['Error'] + } + } + } readonly post: { readonly parameters: { readonly body: { /** Plan create request */ - readonly body: definitions["CreatePlan"]; - }; - }; + readonly body: definitions['CreatePlan'] + } + } readonly responses: { /** Complete plan object */ readonly 201: { - readonly schema: definitions["Plan"]; - }; + readonly schema: definitions['Plan'] + } /** Invalid request provided */ readonly 400: { - readonly schema: definitions["Error"]; - }; + readonly schema: definitions['Error'] + } /** Forbidden */ readonly 403: { - readonly schema: definitions["Error"]; - }; + readonly schema: definitions['Error'] + } /** Plan already exists with that label */ readonly 409: { - readonly schema: definitions["Error"]; - }; + readonly schema: definitions['Error'] + } /** Unexpected Error */ readonly 500: { - readonly schema: definitions["Error"]; - }; - }; - }; - }; + readonly schema: definitions['Error'] + } + } + } + } } export interface definitions { @@ -510,205 +510,205 @@ export interface definitions { * Format: base32ID * @description A base32 encoded 18 byte identifier. */ - readonly ID: string; + readonly ID: string /** * Format: base32ID * @description A base32 encoded 18 byte identifier. */ - readonly OptionalID: string; + readonly OptionalID: string /** @description A flexible identifier for internal or external entities. */ - readonly FlexID: string; + readonly FlexID: string /** @description A flexible identifier for internal or external entities. */ - readonly OptionalFlexID: string; + readonly OptionalFlexID: string /** @description A machine readable unique label, which is url safe. */ - readonly Label: string; + readonly Label: string /** @description A machine readable unique label, which is url safe. */ - readonly OptionalLabel: string; + readonly OptionalLabel: string /** @description A machine readable unique label, which is url safe. */ - readonly FeatureValueLabel: string; + readonly FeatureValueLabel: string /** @description A location of where a potential resource can be provisioned. */ - readonly Location: string; + readonly Location: string /** @description A name of a platform which is used to provision resources. */ - readonly Platform: string; + readonly Platform: string /** @description A name of an entity which is displayed to a human. */ - readonly Name: string; + readonly Name: string /** @description A name of an entity which is displayed to a human. */ - readonly OptionalName: string; + readonly OptionalName: string /** * Format: url * @description Logo used for Provider and Product listings. * * Must be square (same width and height) and minimum 400px. Maximum of 800px. */ - readonly LogoURL: string; + readonly LogoURL: string /** * Format: url * @description Logo used for Provider and Product listings. * * Must be square (same width and height) and minimum 400px. Maximum of 800px. */ - readonly OptionalLogoURL: string; + readonly OptionalLogoURL: string readonly RegionBody: { - readonly platform: definitions["Platform"]; - readonly location: definitions["Location"]; - readonly name: string; - readonly priority: number; - }; + readonly platform: definitions['Platform'] + readonly location: definitions['Location'] + readonly name: string + readonly priority: number + } readonly Region: { - readonly id: definitions["ID"]; + readonly id: definitions['ID'] /** @enum {string} */ - readonly type: "region"; + readonly type: 'region' /** @enum {integer} */ - readonly version: 1; - readonly body: definitions["RegionBody"]; - }; + readonly version: 1 + readonly body: definitions['RegionBody'] + } readonly CreateRegion: { - readonly body: definitions["RegionBody"]; - }; + readonly body: definitions['RegionBody'] + } readonly UpdateRegion: { - readonly name: string; - }; + readonly name: string + } readonly ProviderBody: { - readonly owner_id?: definitions["OptionalFlexID"]; - readonly team_id?: definitions["OptionalID"]; - readonly label: definitions["Label"]; - readonly name: definitions["Name"]; - readonly logo_url?: definitions["LogoURL"]; + readonly owner_id?: definitions['OptionalFlexID'] + readonly team_id?: definitions['OptionalID'] + readonly label: definitions['Label'] + readonly name: definitions['Name'] + readonly logo_url?: definitions['LogoURL'] /** Format: email */ - readonly support_email?: string; + readonly support_email?: string /** Format: url */ - readonly documentation_url?: string; - }; + readonly documentation_url?: string + } readonly UpdateProviderBody: { - readonly owner_id?: definitions["OptionalFlexID"]; - readonly team_id?: definitions["OptionalID"]; - readonly label?: definitions["OptionalLabel"]; - readonly name?: definitions["OptionalName"]; - readonly logo_url?: definitions["OptionalLogoURL"]; + readonly owner_id?: definitions['OptionalFlexID'] + readonly team_id?: definitions['OptionalID'] + readonly label?: definitions['OptionalLabel'] + readonly name?: definitions['OptionalName'] + readonly logo_url?: definitions['OptionalLogoURL'] /** Format: email */ - readonly support_email?: string; + readonly support_email?: string /** Format: url */ - readonly documentation_url?: string; - }; + readonly documentation_url?: string + } readonly Provider: { - readonly id: definitions["ID"]; + readonly id: definitions['ID'] /** @enum {integer} */ - readonly version: 1; + readonly version: 1 /** @enum {string} */ - readonly type: "provider"; - readonly body: definitions["ProviderBody"]; - }; + readonly type: 'provider' + readonly body: definitions['ProviderBody'] + } readonly CreateProvider: { - readonly body: definitions["ProviderBody"]; - }; + readonly body: definitions['ProviderBody'] + } readonly UpdateProvider: { - readonly id: definitions["ID"]; - readonly body: definitions["UpdateProviderBody"]; - }; + readonly id: definitions['ID'] + readonly body: definitions['UpdateProviderBody'] + } readonly UpdateProduct: { - readonly id: definitions["ID"]; - readonly body: definitions["UpdateProductBody"]; - }; + readonly id: definitions['ID'] + readonly body: definitions['UpdateProductBody'] + } readonly UpdateProductBody: { - readonly name?: definitions["Name"]; - readonly label?: definitions["Label"]; - readonly logo_url?: definitions["LogoURL"]; - readonly listing?: definitions["ProductListing"]; + readonly name?: definitions['Name'] + readonly label?: definitions['Label'] + readonly logo_url?: definitions['LogoURL'] + readonly listing?: definitions['ProductListing'] /** @description 140 character sentence positioning the product. */ - readonly tagline?: string; + readonly tagline?: string /** @description A list of value propositions of the product. */ - readonly value_props?: readonly definitions["ValueProp"][]; + readonly value_props?: readonly definitions['ValueProp'][] /** @description A list of getting started steps for the product */ - readonly setup_steps?: readonly string[]; - readonly images?: readonly definitions["ProductImageURL"][]; + readonly setup_steps?: readonly string[] + readonly images?: readonly definitions['ProductImageURL'][] /** Format: email */ - readonly support_email?: string; + readonly support_email?: string /** Format: url */ - readonly documentation_url?: string; + readonly documentation_url?: string /** * @description URL to this Product's Terms of Service. If provided is true, then * a url must be set. Otherwise, provided is false. */ - readonly terms_url?: string; - readonly feature_types?: readonly definitions["FeatureType"][]; + readonly terms_url?: string + readonly feature_types?: readonly definitions['FeatureType'][] readonly integration?: { - readonly provisioning?: definitions["ProductProvisioning"]; + readonly provisioning?: definitions['ProductProvisioning'] /** Format: url */ - readonly base_url?: string; + readonly base_url?: string /** Format: url */ - readonly sso_url?: string; + readonly sso_url?: string /** @enum {string} */ - readonly version?: "v1"; + readonly version?: 'v1' /** @default [object Object] */ readonly features?: { - readonly access_code?: boolean; - readonly sso?: boolean; - readonly plan_change?: boolean; + readonly access_code?: boolean + readonly sso?: boolean + readonly plan_change?: boolean /** * @default multiple * @enum {string} */ - readonly credential?: "none" | "single" | "multiple" | "unknown"; - }; - }; + readonly credential?: 'none' | 'single' | 'multiple' | 'unknown' + } + } /** @description An array of platform ids to restrict this product for. */ - readonly platform_ids?: readonly definitions["ID"][]; - readonly tags?: definitions["ProductTags"]; - }; + readonly platform_ids?: readonly definitions['ID'][] + readonly tags?: definitions['ProductTags'] + } readonly UpdatePlan: { - readonly id: definitions["ID"]; - readonly body: definitions["UpdatePlanBody"]; - }; + readonly id: definitions['ID'] + readonly body: definitions['UpdatePlanBody'] + } readonly UpdatePlanBody: { - readonly name?: definitions["Name"]; - readonly label?: definitions["Label"]; - readonly state?: definitions["PlanState"]; + readonly name?: definitions['Name'] + readonly label?: definitions['Label'] + readonly state?: definitions['PlanState'] /** @description Used in conjuction with resizable_to to set or unset the list */ - readonly has_resize_constraints?: boolean; - readonly resizable_to?: definitions["PlanResizeList"]; + readonly has_resize_constraints?: boolean + readonly resizable_to?: definitions['PlanResizeList'] /** @description Array of Region IDs */ - readonly regions?: readonly definitions["ID"][]; + readonly regions?: readonly definitions['ID'][] /** @description Array of Feature Values */ - readonly features?: readonly definitions["FeatureValue"][]; + readonly features?: readonly definitions['FeatureValue'][] /** * @description The number of days a user gets as a free trial when subscribing to * this plan. Trials are valid only once per product; changing plans * or adding an additional subscription will not start a new trial. */ - readonly trial_days?: number; + readonly trial_days?: number /** @description Dollar value in cents */ - readonly cost?: number; - }; + readonly cost?: number + } /** * @description A feature type represents the different aspects of a product that are * offered, these features can manifest differently depending on the plan. */ readonly FeatureType: { - readonly label: definitions["Label"]; - readonly name: definitions["Name"]; + readonly label: definitions['Label'] + readonly name: definitions['Name'] /** @enum {string} */ - readonly type: "boolean" | "string" | "number"; + readonly type: 'boolean' | 'string' | 'number' /** @description This sets whether or not the feature can be customized by a consumer. */ - readonly customizable?: boolean; + readonly customizable?: boolean /** * @description This sets whether or not the feature can be upgraded by the consumer after the * resource has provisioned. Upgrading means setting a higher value or selecting a * higher element in the list. */ - readonly upgradable?: boolean; + readonly upgradable?: boolean /** * @description This sets whether or not the feature can be downgraded by the consumer after the * resource has provisioned. Downgrading means setting a lower value or selecting a * lower element in the list. */ - readonly downgradable?: boolean; + readonly downgradable?: boolean /** * @description Sets if this feature’s value is trackable from the provider, * this only really affects numeric constraints. */ - readonly measurable?: boolean; - readonly values?: definitions["FeatureValuesList"]; - }; + readonly measurable?: boolean + readonly values?: definitions['FeatureValuesList'] + } /** * @description A list of allowable values for the feature. * To define values for a boolean feature type, only `true` is required, @@ -717,16 +717,16 @@ export interface definitions { * `numeric_details` definition, and the plan will determine which * `numeric_details` set is used based on it's setting. */ - readonly FeatureValuesList: readonly definitions["FeatureValueDetails"][]; + readonly FeatureValuesList: readonly definitions['FeatureValueDetails'][] readonly FeatureValueDetails: { - readonly label: definitions["FeatureValueLabel"]; - readonly name: definitions["Name"]; + readonly label: definitions['FeatureValueLabel'] + readonly name: definitions['Name'] /** * @description The cost that will be added to the monthly plan cost when this value * is selected or is default for the plan. * Cost is deprecated in favor of the `price.cost` field. */ - readonly cost?: number; + readonly cost?: number /** * @description Price describes the cost of a feature. It should be preferred over * the `cost` property. @@ -737,24 +737,24 @@ export interface definitions { * when this value is selected or is default for the plan. * Number features should use the cost range instead. */ - readonly cost?: number; + readonly cost?: number /** * @description When a feature is used to multiply the cost of the plan or of * another feature, multiply factor is used for calculation. * A feature cannot have both a cost and a multiply factor. */ - readonly multiply_factor?: number; + readonly multiply_factor?: number /** * @description Price describes how the feature cost should be calculated. * * @example [object Object] */ - readonly formula?: definitions["PriceFormula"]; + readonly formula?: definitions['PriceFormula'] /** @description Description explains how a feature is calculated to the user. */ - readonly description?: string; - }; - readonly numeric_details?: definitions["FeatureNumericDetails"]; - }; + readonly description?: string + } + readonly numeric_details?: definitions['FeatureNumericDetails'] + } /** * @description Optional container for additional details relating to numeric features. * This is required if the feature is measurable and numeric. @@ -770,15 +770,15 @@ export interface definitions { * * @default 1 */ - readonly increment?: number; + readonly increment?: number /** @description Minimum value that can be set by a user if customizable */ - readonly min?: number; + readonly min?: number /** @description Maximum value that can be set by a user if customizable */ - readonly max?: number; + readonly max?: number /** @description Applied to the end of the number for display, for example the ‘GB’ in ‘20 GB’. */ - readonly suffix?: string; - readonly cost_ranges?: readonly definitions["FeatureNumericRange"][]; - }; + readonly suffix?: string + readonly cost_ranges?: readonly definitions['FeatureNumericRange'][] + } readonly FeatureNumericRange: { /** * @description Defines the end of the range ( inclusive ), from the previous, or 0; @@ -786,41 +786,41 @@ export interface definitions { * range to infinity, or the maximum integer the system can handle * ( whichever comes first ). */ - readonly limit?: number; + readonly limit?: number /** * @description An integer in 10,000,000ths of cents, will be multiplied by the * numeric value set in the feature to determine the cost. */ - readonly cost_multiple?: number; - }; + readonly cost_multiple?: number + } readonly FeatureValue: { - readonly feature: definitions["Label"]; - readonly value: definitions["FeatureValueLabel"]; - }; + readonly feature: definitions['Label'] + readonly value: definitions['FeatureValueLabel'] + } readonly ValueProp: { /** @description Heading of a value proposition. */ - readonly header: string; + readonly header: string /** @description Body of a value proposition. */ - readonly body: string; - }; + readonly body: string + } /** * Format: url * @description Image URL used for Product listings. * * Minimum 660px wide, 400px high. */ - readonly ProductImageURL: string; + readonly ProductImageURL: string /** @description List of tags for product categorization and search */ - readonly ProductTags: readonly definitions["Label"][]; + readonly ProductTags: readonly definitions['Label'][] /** @enum {string} */ - readonly ProductState: "available" | "hidden" | "grandfathered" | "new" | "upcoming"; + readonly ProductState: 'available' | 'hidden' | 'grandfathered' | 'new' | 'upcoming' /** @default [object Object] */ readonly ProductListing: { /** * @description When true, everyone can see the product when requested. When false it will * not be visible to anyone except those on the provider team. */ - readonly public?: boolean; + readonly public?: boolean /** * @description When true, the product will be displayed in product listings alongside * other products. When false the product will be excluded from listings, @@ -828,7 +828,7 @@ export interface definitions { * Any pages that display information about the product when not listed, * should indicate to webcrawlers that the content should not be indexed. */ - readonly listed?: boolean; + readonly listed?: boolean /** * @description Object to hold various flags for marketing purposes only. These are values * that need to be stored, but should not affect decision making in code. If @@ -843,21 +843,21 @@ export interface definitions { * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. */ - readonly beta?: boolean; + readonly beta?: boolean /** * @description Indicates whether or not the product is in `New` and should be * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. */ - readonly new?: boolean; + readonly new?: boolean /** * @description Indicates whether or not the product is in `New` and should be * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. */ - readonly featured?: boolean; - }; - }; + readonly featured?: boolean + } + } /** * @description Provider Only, implies that the product should only be provisionable by the * provider; so members of the provider team, no one else should be allowed. @@ -867,24 +867,24 @@ export interface definitions { * * @enum {string} */ - readonly ProductProvisioning: "provider-only" | "pre-order" | "public"; + readonly ProductProvisioning: 'provider-only' | 'pre-order' | 'public' /** @default [object Object] */ readonly ProductIntegrationFeatures: { /** * @description Indicates whether or not this product supports resource transitions to * manifold by access_code. */ - readonly access_code?: boolean; + readonly access_code?: boolean /** * @description Represents whether or not this product supports Single * Sign On */ - readonly sso?: boolean; + readonly sso?: boolean /** * @description Represents whether or not this product supports changing * the plan of a resource. */ - readonly plan_change?: boolean; + readonly plan_change?: boolean /** * @description Describes how the region for a resource is specified, if * unspecified, then regions have no impact on this @@ -892,7 +892,7 @@ export interface definitions { * * @enum {string} */ - readonly region?: "user-specified" | "unspecified"; + readonly region?: 'user-specified' | 'unspecified' /** * @description Describes the credential type that is supported by this product. * @@ -904,131 +904,131 @@ export interface definitions { * @default multiple * @enum {string} */ - readonly credential?: "none" | "single" | "multiple" | "unknown"; - }; + readonly credential?: 'none' | 'single' | 'multiple' | 'unknown' + } readonly ProductBody: { - readonly provider_id: definitions["ID"]; + readonly provider_id: definitions['ID'] /** @description Product labels are globally unique and contain the provider name. */ - readonly label: definitions["Label"]; - readonly name: definitions["Name"]; - readonly state: definitions["ProductState"]; - readonly listing: definitions["ProductListing"]; - readonly logo_url: definitions["LogoURL"]; + readonly label: definitions['Label'] + readonly name: definitions['Name'] + readonly state: definitions['ProductState'] + readonly listing: definitions['ProductListing'] + readonly logo_url: definitions['LogoURL'] /** @description 140 character sentence positioning the product. */ - readonly tagline: string; + readonly tagline: string /** @description A list of value propositions of the product. */ - readonly value_props: readonly definitions["ValueProp"][]; + readonly value_props: readonly definitions['ValueProp'][] /** @description A list of getting started steps for the product */ - readonly setup_steps?: readonly string[]; - readonly images: readonly definitions["ProductImageURL"][]; + readonly setup_steps?: readonly string[] + readonly images: readonly definitions['ProductImageURL'][] /** Format: email */ - readonly support_email: string; + readonly support_email: string /** Format: url */ - readonly documentation_url: string; + readonly documentation_url: string /** * @description URL to this Product's Terms of Service. If provided is true, then * a url must be set. Otherwise, provided is false. */ readonly terms: { /** Format: url */ - readonly url?: string; - readonly provided: boolean; - }; - readonly feature_types: readonly definitions["FeatureType"][]; + readonly url?: string + readonly provided: boolean + } + readonly feature_types: readonly definitions['FeatureType'][] readonly billing: { /** @enum {string} */ - readonly type: "monthly-prorated" | "monthly-anniversary" | "annual-anniversary"; + readonly type: 'monthly-prorated' | 'monthly-anniversary' | 'annual-anniversary' /** @enum {string} */ - readonly currency: "usd"; - }; + readonly currency: 'usd' + } readonly integration: { - readonly provisioning: definitions["ProductProvisioning"]; + readonly provisioning: definitions['ProductProvisioning'] /** Format: url */ - readonly base_url: string; + readonly base_url: string /** Format: url */ - readonly sso_url?: string; + readonly sso_url?: string /** @enum {string} */ - readonly version: "v1"; - readonly features: definitions["ProductIntegrationFeatures"]; - }; - readonly tags?: definitions["ProductTags"]; - }; + readonly version: 'v1' + readonly features: definitions['ProductIntegrationFeatures'] + } + readonly tags?: definitions['ProductTags'] + } readonly Product: { - readonly id: definitions["ID"]; + readonly id: definitions['ID'] /** @enum {integer} */ - readonly version: 1; + readonly version: 1 /** @enum {string} */ - readonly type: "product"; - readonly body: definitions["ProductBody"]; - }; + readonly type: 'product' + readonly body: definitions['ProductBody'] + } readonly CreateProduct: { - readonly body: definitions["ProductBody"]; - }; + readonly body: definitions['ProductBody'] + } /** @description Array of Plan IDs that this Plan can be resized to, if null all will be assumed */ - readonly PlanResizeList: readonly definitions["ID"][]; + readonly PlanResizeList: readonly definitions['ID'][] readonly PlanBody: { - readonly provider_id: definitions["ID"]; - readonly product_id: definitions["ID"]; - readonly name: definitions["Name"]; - readonly label: definitions["Label"]; - readonly state: definitions["PlanState"]; - readonly resizable_to?: definitions["PlanResizeList"]; + readonly provider_id: definitions['ID'] + readonly product_id: definitions['ID'] + readonly name: definitions['Name'] + readonly label: definitions['Label'] + readonly state: definitions['PlanState'] + readonly resizable_to?: definitions['PlanResizeList'] /** @description Array of Region IDs */ - readonly regions: readonly definitions["ID"][]; + readonly regions: readonly definitions['ID'][] /** @description Array of Feature Values */ - readonly features: readonly definitions["FeatureValue"][]; + readonly features: readonly definitions['FeatureValue'][] /** * @description The number of days a user gets as a free trial when subscribing to * this plan. Trials are valid only once per product; changing plans * or adding an additional subscription will not start a new trial. */ - readonly trial_days?: number; + readonly trial_days?: number /** @description Dollar value in cents. */ - readonly cost: number; - }; + readonly cost: number + } /** @enum {string} */ - readonly PlanState: "hidden" | "available" | "grandfathered" | "unlisted"; - readonly ExpandedPlanBody: definitions["PlanBody"] & { + readonly PlanState: 'hidden' | 'available' | 'grandfathered' | 'unlisted' + readonly ExpandedPlanBody: definitions['PlanBody'] & { /** @description An array of feature definitions for the plan, as defined on the Product. */ - readonly expanded_features: readonly definitions["ExpandedFeature"][]; + readonly expanded_features: readonly definitions['ExpandedFeature'][] /** @description A boolean flag that indicates if a plan is free or not based on it's cost and features. */ - readonly free: boolean; + readonly free: boolean /** @description Plan cost using its default features plus base cost. */ - readonly defaultCost?: number; + readonly defaultCost?: number /** @description A boolean flag that indicates if a plan has customizable features. */ - readonly customizable?: boolean; - }; - readonly ExpandedFeature: definitions["FeatureType"] & { + readonly customizable?: boolean + } + readonly ExpandedFeature: definitions['FeatureType'] & { /** @description The string value set for the feature on the plan, this should only be used if the value property is null. */ - readonly value_string: string; - readonly value: definitions["FeatureValueDetails"]; - }; + readonly value_string: string + readonly value: definitions['FeatureValueDetails'] + } readonly Plan: { - readonly id: definitions["ID"]; + readonly id: definitions['ID'] /** @enum {integer} */ - readonly version: 1; + readonly version: 1 /** @enum {string} */ - readonly type: "plan"; - readonly body: definitions["PlanBody"]; - }; + readonly type: 'plan' + readonly body: definitions['PlanBody'] + } readonly ExpandedPlan: { - readonly id: definitions["ID"]; + readonly id: definitions['ID'] /** @enum {integer} */ - readonly version: 1; + readonly version: 1 /** @enum {string} */ - readonly type: "plan"; - readonly body: definitions["ExpandedPlanBody"]; - }; + readonly type: 'plan' + readonly body: definitions['ExpandedPlanBody'] + } readonly CreatePlan: { - readonly body: definitions["PlanBody"]; - }; + readonly body: definitions['PlanBody'] + } /** @description Unexpected error */ readonly Error: { /** @description The error type */ - readonly type: string; + readonly type: string /** @description Explanation of the errors */ - readonly message: readonly string[]; - }; + readonly message: readonly string[] + } /** * @description Describes how a feature cost should be calculated. An empty * string defaults to the normal price calculation using the value cost. @@ -1052,17 +1052,17 @@ export interface definitions { * - `another-feature-label#number` is the numeric value of a number feature * In a feature formula, plan base cost and total cost cannot be used */ - readonly PriceFormula: string; + readonly PriceFormula: string readonly ExpandedProduct: { - readonly id: definitions["ID"]; + readonly id: definitions['ID'] /** @enum {integer} */ - readonly version: 1; + readonly version: 1 /** @enum {string} */ - readonly type: "product"; - readonly body: definitions["ProductBody"]; - readonly plans?: readonly definitions["ExpandedPlan"][]; - readonly provider: definitions["Provider"]; - }; + readonly type: 'product' + readonly body: definitions['ProductBody'] + readonly plans?: readonly definitions['ExpandedPlan'][] + readonly provider: definitions['Provider'] + } } export interface parameters { @@ -1070,7 +1070,7 @@ export interface parameters { * Format: label * @description Filter results to only include those that have this label. */ - readonly LabelFilter: string; + readonly LabelFilter: string } export interface operations {} diff --git a/test/v2/expected/manifold.ts b/test/v2/expected/manifold.ts index b6ea325a3..8a83a64d6 100644 --- a/test/v2/expected/manifold.ts +++ b/test/v2/expected/manifold.ts @@ -4,224 +4,224 @@ */ export interface paths { - "/regions/": { + '/regions/': { get: { parameters: { query: { /** Filter results to only include the regions that have this location. */ - location?: string; + location?: string /** * Filter results to only include the regions that are on this * platform. */ - platform?: string; - }; - }; + platform?: string + } + } responses: { /** A list of regions. */ 200: { - schema: definitions["Region"][]; - }; + schema: definitions['Region'][] + } /** Unexpected Error */ 500: { - schema: definitions["Error"]; - }; - }; - }; + schema: definitions['Error'] + } + } + } post: { parameters: { body: { /** Region create request */ - body: definitions["CreateRegion"]; - }; - }; + body: definitions['CreateRegion'] + } + } responses: { /** Complete region object */ 201: { - schema: definitions["Region"]; - }; + schema: definitions['Region'] + } /** Invalid request provided */ 400: { - schema: definitions["Error"]; - }; + schema: definitions['Error'] + } /** Region already exists for that platform and location */ 409: { - schema: definitions["Error"]; - }; + schema: definitions['Error'] + } /** Unexpected Error */ 500: { - schema: definitions["Error"]; - }; - }; - }; - }; - "/regions/{id}": { + schema: definitions['Error'] + } + } + } + } + '/regions/{id}': { get: { parameters: { path: { /** ID of the region to lookup, stored as a base32 encoded 18 byte identifier. */ - id: string; - }; - }; + id: string + } + } responses: { /** A region. */ 200: { - schema: definitions["Region"]; - }; + schema: definitions['Region'] + } /** Provided Region ID is Invalid */ 400: { - schema: definitions["Error"]; - }; + schema: definitions['Error'] + } /** Region could not be found */ 404: { - schema: definitions["Error"]; - }; + schema: definitions['Error'] + } /** Unexpected Error */ 500: { - schema: definitions["Error"]; - }; - }; - }; + schema: definitions['Error'] + } + } + } patch: { parameters: { path: { /** ID of the region to lookup, stored as a base32 encoded 18 byte identifier. */ - id: string; - }; + id: string + } body: { /** Region update request */ - body: definitions["UpdateRegion"]; - }; - }; + body: definitions['UpdateRegion'] + } + } responses: { /** Complete region object */ 200: { - schema: definitions["Region"]; - }; + schema: definitions['Region'] + } /** Invalid request provided */ 400: { - schema: definitions["Error"]; - }; + schema: definitions['Error'] + } /** Unexpected Error */ 500: { - schema: definitions["Error"]; - }; - }; - }; - }; - "/providers/": { + schema: definitions['Error'] + } + } + } + } + '/providers/': { get: { parameters: { query: { /** Filter results to only include those that have this label. */ - label?: parameters["LabelFilter"]; - }; - }; + label?: parameters['LabelFilter'] + } + } responses: { /** A list of providers. */ 200: { - schema: definitions["Provider"][]; - }; + schema: definitions['Provider'][] + } /** Unexpected Error */ 500: { - schema: definitions["Error"]; - }; - }; - }; + schema: definitions['Error'] + } + } + } post: { parameters: { body: { /** Provider create request */ - body: definitions["CreateProvider"]; - }; - }; + body: definitions['CreateProvider'] + } + } responses: { /** Complete provider object */ 201: { - schema: definitions["Provider"]; - }; + schema: definitions['Provider'] + } /** Invalid request provided */ 400: { - schema: definitions["Error"]; - }; + schema: definitions['Error'] + } /** Forbidden */ 403: { - schema: definitions["Error"]; - }; + schema: definitions['Error'] + } /** Provider already exists with that label */ 409: { - schema: definitions["Error"]; - }; + schema: definitions['Error'] + } /** Unexpected Error */ 500: { - schema: definitions["Error"]; - }; - }; - }; - }; - "/providers/{id}": { + schema: definitions['Error'] + } + } + } + } + '/providers/{id}': { get: { parameters: { path: { /** ID of the provider to lookup, stored as a base32 encoded 18 byte identifier. */ - id: string; - }; - }; + id: string + } + } responses: { /** A provider. */ 200: { - schema: definitions["Provider"]; - }; + schema: definitions['Provider'] + } /** Unknown provider error */ 404: { - schema: definitions["Error"]; - }; + schema: definitions['Error'] + } /** Unexpected Error */ 500: { - schema: definitions["Error"]; - }; - }; - }; + schema: definitions['Error'] + } + } + } patch: { parameters: { path: { /** ID of the provider to update, stored as a base32 encoded 18 byte identifier. */ - id: string; - }; + id: string + } body: { /** Provider update request */ - body: definitions["UpdateProvider"]; - }; - }; + body: definitions['UpdateProvider'] + } + } responses: { /** Complete provider object */ 200: { - schema: definitions["Provider"]; - }; + schema: definitions['Provider'] + } /** Invalid request provided */ 400: { - schema: definitions["Error"]; - }; + schema: definitions['Error'] + } /** Forbidden */ 403: { - schema: definitions["Error"]; - }; + schema: definitions['Error'] + } /** Provider not found */ 404: { - schema: definitions["Error"]; - }; + schema: definitions['Error'] + } /** Provider already exists with that label */ 409: { - schema: definitions["Error"]; - }; + schema: definitions['Error'] + } /** Unexpected Error */ 500: { - schema: definitions["Error"]; - }; - }; - }; - }; - "/products/": { + schema: definitions['Error'] + } + } + } + } + '/products/': { get: { parameters: { query: { @@ -229,60 +229,60 @@ export interface paths { * Base32 encoded 18 byte identifier of the provider that these * products must belong to. */ - provider_id?: string; + provider_id?: string /** Filter results to only include those that have this label. */ - label?: parameters["LabelFilter"]; + label?: parameters['LabelFilter'] /** Return only products matching at least one of the tags. */ - tags?: string[]; - }; - }; + tags?: string[] + } + } responses: { /** A product. */ 200: { - schema: definitions["Product"][]; - }; + schema: definitions['Product'][] + } /** Invalid provider_id supplied */ 400: { - schema: definitions["Error"]; - }; + schema: definitions['Error'] + } /** Unexpected Error */ 500: { - schema: definitions["Error"]; - }; - }; - }; + schema: definitions['Error'] + } + } + } post: { parameters: { body: { /** Product create request */ - body: definitions["CreateProduct"]; - }; - }; + body: definitions['CreateProduct'] + } + } responses: { /** Complete product object */ 201: { - schema: definitions["Product"]; - }; + schema: definitions['Product'] + } /** Invalid request provided */ 400: { - schema: definitions["Error"]; - }; + schema: definitions['Error'] + } /** Forbidden */ 403: { - schema: definitions["Error"]; - }; + schema: definitions['Error'] + } /** Product already exists with that label */ 409: { - schema: definitions["Error"]; - }; + schema: definitions['Error'] + } /** Unexpected Error */ 500: { - schema: definitions["Error"]; - }; - }; - }; - }; - "/internal/products": { + schema: definitions['Error'] + } + } + } + } + '/internal/products': { get: { parameters: { query: { @@ -290,32 +290,32 @@ export interface paths { * Base32 encoded 18 byte identifier of the provider that these * products must belong to. */ - provider_id?: string; + provider_id?: string /** Filter results to only include those that have this label. */ - label?: parameters["LabelFilter"]; + label?: parameters['LabelFilter'] /** Return only products matching at least one of the tags. */ - tags?: string[]; + tags?: string[] /** Return product listings without plan information */ - include_plans?: boolean; - }; - }; + include_plans?: boolean + } + } responses: { /** A product. */ 200: { - schema: definitions["ExpandedProduct"][]; - }; + schema: definitions['ExpandedProduct'][] + } /** Invalid provider_id supplied */ 400: { - schema: definitions["Error"]; - }; + schema: definitions['Error'] + } /** Unexpected Error */ 500: { - schema: definitions["Error"]; - }; - }; - }; - }; - "/products/{id}": { + schema: definitions['Error'] + } + } + } + } + '/products/{id}': { get: { parameters: { path: { @@ -323,28 +323,28 @@ export interface paths { * ID of the product to lookup, stored as a base32 encoded 18 byte * identifier. */ - id: string; - }; - }; + id: string + } + } responses: { /** A product. */ 200: { - schema: definitions["Product"]; - }; + schema: definitions['Product'] + } /** Invalid Product ID */ 400: { - schema: definitions["Error"]; - }; + schema: definitions['Error'] + } /** Product not found error */ 404: { - schema: definitions["Error"]; - }; + schema: definitions['Error'] + } /** Unexpected error */ 500: { - schema: definitions["Error"]; - }; - }; - }; + schema: definitions['Error'] + } + } + } patch: { parameters: { path: { @@ -352,34 +352,34 @@ export interface paths { * ID of the product to lookup, stored as a base32 encoded 18 byte * identifier. */ - id: string; - }; + id: string + } body: { /** Product update request */ - body: definitions["UpdateProduct"]; - }; - }; + body: definitions['UpdateProduct'] + } + } responses: { /** Complete product object */ 200: { - schema: definitions["Product"]; - }; + schema: definitions['Product'] + } /** Invalid Product ID */ 400: { - schema: definitions["Error"]; - }; + schema: definitions['Error'] + } /** Product not found error */ 404: { - schema: definitions["Error"]; - }; + schema: definitions['Error'] + } /** Unexpected error */ 500: { - schema: definitions["Error"]; - }; - }; - }; - }; - "/plans/{id}": { + schema: definitions['Error'] + } + } + } + } + '/plans/{id}': { get: { parameters: { path: { @@ -387,28 +387,28 @@ export interface paths { * ID of the plan to lookup, stored as a base32 encoded 18 byte * identifier. */ - id: string; - }; - }; + id: string + } + } responses: { /** A plan. */ 200: { - schema: definitions["ExpandedPlan"]; - }; + schema: definitions['ExpandedPlan'] + } /** Invalid Plan ID Provided */ 400: { - schema: definitions["Error"]; - }; + schema: definitions['Error'] + } /** Unknown plan error */ 404: { - schema: definitions["Error"]; - }; + schema: definitions['Error'] + } /** Unexpected error */ default: { - schema: definitions["Error"]; - }; - }; - }; + schema: definitions['Error'] + } + } + } patch: { parameters: { path: { @@ -416,93 +416,93 @@ export interface paths { * ID of the plan to lookup, stored as a base32 encoded 18 byte * identifier. */ - id: string; - }; + id: string + } body: { /** Plan update request */ - body: definitions["UpdatePlan"]; - }; - }; + body: definitions['UpdatePlan'] + } + } responses: { /** Complete product plan */ 200: { - schema: definitions["Plan"]; - }; + schema: definitions['Plan'] + } /** Invalid Plan ID */ 400: { - schema: definitions["Error"]; - }; + schema: definitions['Error'] + } /** Plan not found error */ 404: { - schema: definitions["Error"]; - }; + schema: definitions['Error'] + } /** Unexpected error */ 500: { - schema: definitions["Error"]; - }; - }; - }; - }; - "/plans/": { + schema: definitions['Error'] + } + } + } + } + '/plans/': { get: { parameters: { query: { /** Return the plans that are associated with this product. */ - product_id: string[]; + product_id: string[] /** Filter results to only include those that have this label. */ - label?: parameters["LabelFilter"]; - }; - }; + label?: parameters['LabelFilter'] + } + } responses: { /** A list of plans for the given product. */ 200: { - schema: definitions["ExpandedPlan"][]; - }; + schema: definitions['ExpandedPlan'][] + } /** Invalid Parameters Provided */ 400: { - schema: definitions["Error"]; - }; + schema: definitions['Error'] + } /** Could not find product */ 404: { - schema: definitions["Error"]; - }; + schema: definitions['Error'] + } /** Unexpected error */ 500: { - schema: definitions["Error"]; - }; - }; - }; + schema: definitions['Error'] + } + } + } post: { parameters: { body: { /** Plan create request */ - body: definitions["CreatePlan"]; - }; - }; + body: definitions['CreatePlan'] + } + } responses: { /** Complete plan object */ 201: { - schema: definitions["Plan"]; - }; + schema: definitions['Plan'] + } /** Invalid request provided */ 400: { - schema: definitions["Error"]; - }; + schema: definitions['Error'] + } /** Forbidden */ 403: { - schema: definitions["Error"]; - }; + schema: definitions['Error'] + } /** Plan already exists with that label */ 409: { - schema: definitions["Error"]; - }; + schema: definitions['Error'] + } /** Unexpected Error */ 500: { - schema: definitions["Error"]; - }; - }; - }; - }; + schema: definitions['Error'] + } + } + } + } } export interface definitions { @@ -510,205 +510,205 @@ export interface definitions { * Format: base32ID * @description A base32 encoded 18 byte identifier. */ - ID: string; + ID: string /** * Format: base32ID * @description A base32 encoded 18 byte identifier. */ - OptionalID: string; + OptionalID: string /** @description A flexible identifier for internal or external entities. */ - FlexID: string; + FlexID: string /** @description A flexible identifier for internal or external entities. */ - OptionalFlexID: string; + OptionalFlexID: string /** @description A machine readable unique label, which is url safe. */ - Label: string; + Label: string /** @description A machine readable unique label, which is url safe. */ - OptionalLabel: string; + OptionalLabel: string /** @description A machine readable unique label, which is url safe. */ - FeatureValueLabel: string; + FeatureValueLabel: string /** @description A location of where a potential resource can be provisioned. */ - Location: string; + Location: string /** @description A name of a platform which is used to provision resources. */ - Platform: string; + Platform: string /** @description A name of an entity which is displayed to a human. */ - Name: string; + Name: string /** @description A name of an entity which is displayed to a human. */ - OptionalName: string; + OptionalName: string /** * Format: url * @description Logo used for Provider and Product listings. * * Must be square (same width and height) and minimum 400px. Maximum of 800px. */ - LogoURL: string; + LogoURL: string /** * Format: url * @description Logo used for Provider and Product listings. * * Must be square (same width and height) and minimum 400px. Maximum of 800px. */ - OptionalLogoURL: string; + OptionalLogoURL: string RegionBody: { - platform: definitions["Platform"]; - location: definitions["Location"]; - name: string; - priority: number; - }; + platform: definitions['Platform'] + location: definitions['Location'] + name: string + priority: number + } Region: { - id: definitions["ID"]; + id: definitions['ID'] /** @enum {string} */ - type: "region"; + type: 'region' /** @enum {integer} */ - version: 1; - body: definitions["RegionBody"]; - }; + version: 1 + body: definitions['RegionBody'] + } CreateRegion: { - body: definitions["RegionBody"]; - }; + body: definitions['RegionBody'] + } UpdateRegion: { - name: string; - }; + name: string + } ProviderBody: { - owner_id?: definitions["OptionalFlexID"]; - team_id?: definitions["OptionalID"]; - label: definitions["Label"]; - name: definitions["Name"]; - logo_url?: definitions["LogoURL"]; + owner_id?: definitions['OptionalFlexID'] + team_id?: definitions['OptionalID'] + label: definitions['Label'] + name: definitions['Name'] + logo_url?: definitions['LogoURL'] /** Format: email */ - support_email?: string; + support_email?: string /** Format: url */ - documentation_url?: string; - }; + documentation_url?: string + } UpdateProviderBody: { - owner_id?: definitions["OptionalFlexID"]; - team_id?: definitions["OptionalID"]; - label?: definitions["OptionalLabel"]; - name?: definitions["OptionalName"]; - logo_url?: definitions["OptionalLogoURL"]; + owner_id?: definitions['OptionalFlexID'] + team_id?: definitions['OptionalID'] + label?: definitions['OptionalLabel'] + name?: definitions['OptionalName'] + logo_url?: definitions['OptionalLogoURL'] /** Format: email */ - support_email?: string; + support_email?: string /** Format: url */ - documentation_url?: string; - }; + documentation_url?: string + } Provider: { - id: definitions["ID"]; + id: definitions['ID'] /** @enum {integer} */ - version: 1; + version: 1 /** @enum {string} */ - type: "provider"; - body: definitions["ProviderBody"]; - }; + type: 'provider' + body: definitions['ProviderBody'] + } CreateProvider: { - body: definitions["ProviderBody"]; - }; + body: definitions['ProviderBody'] + } UpdateProvider: { - id: definitions["ID"]; - body: definitions["UpdateProviderBody"]; - }; + id: definitions['ID'] + body: definitions['UpdateProviderBody'] + } UpdateProduct: { - id: definitions["ID"]; - body: definitions["UpdateProductBody"]; - }; + id: definitions['ID'] + body: definitions['UpdateProductBody'] + } UpdateProductBody: { - name?: definitions["Name"]; - label?: definitions["Label"]; - logo_url?: definitions["LogoURL"]; - listing?: definitions["ProductListing"]; + name?: definitions['Name'] + label?: definitions['Label'] + logo_url?: definitions['LogoURL'] + listing?: definitions['ProductListing'] /** @description 140 character sentence positioning the product. */ - tagline?: string; + tagline?: string /** @description A list of value propositions of the product. */ - value_props?: definitions["ValueProp"][]; + value_props?: definitions['ValueProp'][] /** @description A list of getting started steps for the product */ - setup_steps?: string[]; - images?: definitions["ProductImageURL"][]; + setup_steps?: string[] + images?: definitions['ProductImageURL'][] /** Format: email */ - support_email?: string; + support_email?: string /** Format: url */ - documentation_url?: string; + documentation_url?: string /** * @description URL to this Product's Terms of Service. If provided is true, then * a url must be set. Otherwise, provided is false. */ - terms_url?: string; - feature_types?: definitions["FeatureType"][]; + terms_url?: string + feature_types?: definitions['FeatureType'][] integration?: { - provisioning?: definitions["ProductProvisioning"]; + provisioning?: definitions['ProductProvisioning'] /** Format: url */ - base_url?: string; + base_url?: string /** Format: url */ - sso_url?: string; + sso_url?: string /** @enum {string} */ - version?: "v1"; + version?: 'v1' /** @default [object Object] */ features?: { - access_code?: boolean; - sso?: boolean; - plan_change?: boolean; + access_code?: boolean + sso?: boolean + plan_change?: boolean /** * @default multiple * @enum {string} */ - credential?: "none" | "single" | "multiple" | "unknown"; - }; - }; + credential?: 'none' | 'single' | 'multiple' | 'unknown' + } + } /** @description An array of platform ids to restrict this product for. */ - platform_ids?: definitions["ID"][]; - tags?: definitions["ProductTags"]; - }; + platform_ids?: definitions['ID'][] + tags?: definitions['ProductTags'] + } UpdatePlan: { - id: definitions["ID"]; - body: definitions["UpdatePlanBody"]; - }; + id: definitions['ID'] + body: definitions['UpdatePlanBody'] + } UpdatePlanBody: { - name?: definitions["Name"]; - label?: definitions["Label"]; - state?: definitions["PlanState"]; + name?: definitions['Name'] + label?: definitions['Label'] + state?: definitions['PlanState'] /** @description Used in conjuction with resizable_to to set or unset the list */ - has_resize_constraints?: boolean; - resizable_to?: definitions["PlanResizeList"]; + has_resize_constraints?: boolean + resizable_to?: definitions['PlanResizeList'] /** @description Array of Region IDs */ - regions?: definitions["ID"][]; + regions?: definitions['ID'][] /** @description Array of Feature Values */ - features?: definitions["FeatureValue"][]; + features?: definitions['FeatureValue'][] /** * @description The number of days a user gets as a free trial when subscribing to * this plan. Trials are valid only once per product; changing plans * or adding an additional subscription will not start a new trial. */ - trial_days?: number; + trial_days?: number /** @description Dollar value in cents */ - cost?: number; - }; + cost?: number + } /** * @description A feature type represents the different aspects of a product that are * offered, these features can manifest differently depending on the plan. */ FeatureType: { - label: definitions["Label"]; - name: definitions["Name"]; + label: definitions['Label'] + name: definitions['Name'] /** @enum {string} */ - type: "boolean" | "string" | "number"; + type: 'boolean' | 'string' | 'number' /** @description This sets whether or not the feature can be customized by a consumer. */ - customizable?: boolean; + customizable?: boolean /** * @description This sets whether or not the feature can be upgraded by the consumer after the * resource has provisioned. Upgrading means setting a higher value or selecting a * higher element in the list. */ - upgradable?: boolean; + upgradable?: boolean /** * @description This sets whether or not the feature can be downgraded by the consumer after the * resource has provisioned. Downgrading means setting a lower value or selecting a * lower element in the list. */ - downgradable?: boolean; + downgradable?: boolean /** * @description Sets if this feature’s value is trackable from the provider, * this only really affects numeric constraints. */ - measurable?: boolean; - values?: definitions["FeatureValuesList"]; - }; + measurable?: boolean + values?: definitions['FeatureValuesList'] + } /** * @description A list of allowable values for the feature. * To define values for a boolean feature type, only `true` is required, @@ -717,16 +717,16 @@ export interface definitions { * `numeric_details` definition, and the plan will determine which * `numeric_details` set is used based on it's setting. */ - FeatureValuesList: definitions["FeatureValueDetails"][]; + FeatureValuesList: definitions['FeatureValueDetails'][] FeatureValueDetails: { - label: definitions["FeatureValueLabel"]; - name: definitions["Name"]; + label: definitions['FeatureValueLabel'] + name: definitions['Name'] /** * @description The cost that will be added to the monthly plan cost when this value * is selected or is default for the plan. * Cost is deprecated in favor of the `price.cost` field. */ - cost?: number; + cost?: number /** * @description Price describes the cost of a feature. It should be preferred over * the `cost` property. @@ -737,24 +737,24 @@ export interface definitions { * when this value is selected or is default for the plan. * Number features should use the cost range instead. */ - cost?: number; + cost?: number /** * @description When a feature is used to multiply the cost of the plan or of * another feature, multiply factor is used for calculation. * A feature cannot have both a cost and a multiply factor. */ - multiply_factor?: number; + multiply_factor?: number /** * @description Price describes how the feature cost should be calculated. * * @example [object Object] */ - formula?: definitions["PriceFormula"]; + formula?: definitions['PriceFormula'] /** @description Description explains how a feature is calculated to the user. */ - description?: string; - }; - numeric_details?: definitions["FeatureNumericDetails"]; - }; + description?: string + } + numeric_details?: definitions['FeatureNumericDetails'] + } /** * @description Optional container for additional details relating to numeric features. * This is required if the feature is measurable and numeric. @@ -770,15 +770,15 @@ export interface definitions { * * @default 1 */ - increment?: number; + increment?: number /** @description Minimum value that can be set by a user if customizable */ - min?: number; + min?: number /** @description Maximum value that can be set by a user if customizable */ - max?: number; + max?: number /** @description Applied to the end of the number for display, for example the ‘GB’ in ‘20 GB’. */ - suffix?: string; - cost_ranges?: definitions["FeatureNumericRange"][]; - }; + suffix?: string + cost_ranges?: definitions['FeatureNumericRange'][] + } FeatureNumericRange: { /** * @description Defines the end of the range ( inclusive ), from the previous, or 0; @@ -786,41 +786,41 @@ export interface definitions { * range to infinity, or the maximum integer the system can handle * ( whichever comes first ). */ - limit?: number; + limit?: number /** * @description An integer in 10,000,000ths of cents, will be multiplied by the * numeric value set in the feature to determine the cost. */ - cost_multiple?: number; - }; + cost_multiple?: number + } FeatureValue: { - feature: definitions["Label"]; - value: definitions["FeatureValueLabel"]; - }; + feature: definitions['Label'] + value: definitions['FeatureValueLabel'] + } ValueProp: { /** @description Heading of a value proposition. */ - header: string; + header: string /** @description Body of a value proposition. */ - body: string; - }; + body: string + } /** * Format: url * @description Image URL used for Product listings. * * Minimum 660px wide, 400px high. */ - ProductImageURL: string; + ProductImageURL: string /** @description List of tags for product categorization and search */ - ProductTags: definitions["Label"][]; + ProductTags: definitions['Label'][] /** @enum {string} */ - ProductState: "available" | "hidden" | "grandfathered" | "new" | "upcoming"; + ProductState: 'available' | 'hidden' | 'grandfathered' | 'new' | 'upcoming' /** @default [object Object] */ ProductListing: { /** * @description When true, everyone can see the product when requested. When false it will * not be visible to anyone except those on the provider team. */ - public?: boolean; + public?: boolean /** * @description When true, the product will be displayed in product listings alongside * other products. When false the product will be excluded from listings, @@ -828,7 +828,7 @@ export interface definitions { * Any pages that display information about the product when not listed, * should indicate to webcrawlers that the content should not be indexed. */ - listed?: boolean; + listed?: boolean /** * @description Object to hold various flags for marketing purposes only. These are values * that need to be stored, but should not affect decision making in code. If @@ -843,21 +843,21 @@ export interface definitions { * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. */ - beta?: boolean; + beta?: boolean /** * @description Indicates whether or not the product is in `New` and should be * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. */ - new?: boolean; + new?: boolean /** * @description Indicates whether or not the product is in `New` and should be * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. */ - featured?: boolean; - }; - }; + featured?: boolean + } + } /** * @description Provider Only, implies that the product should only be provisionable by the * provider; so members of the provider team, no one else should be allowed. @@ -867,24 +867,24 @@ export interface definitions { * * @enum {string} */ - ProductProvisioning: "provider-only" | "pre-order" | "public"; + ProductProvisioning: 'provider-only' | 'pre-order' | 'public' /** @default [object Object] */ ProductIntegrationFeatures: { /** * @description Indicates whether or not this product supports resource transitions to * manifold by access_code. */ - access_code?: boolean; + access_code?: boolean /** * @description Represents whether or not this product supports Single * Sign On */ - sso?: boolean; + sso?: boolean /** * @description Represents whether or not this product supports changing * the plan of a resource. */ - plan_change?: boolean; + plan_change?: boolean /** * @description Describes how the region for a resource is specified, if * unspecified, then regions have no impact on this @@ -892,7 +892,7 @@ export interface definitions { * * @enum {string} */ - region?: "user-specified" | "unspecified"; + region?: 'user-specified' | 'unspecified' /** * @description Describes the credential type that is supported by this product. * @@ -904,131 +904,131 @@ export interface definitions { * @default multiple * @enum {string} */ - credential?: "none" | "single" | "multiple" | "unknown"; - }; + credential?: 'none' | 'single' | 'multiple' | 'unknown' + } ProductBody: { - provider_id: definitions["ID"]; + provider_id: definitions['ID'] /** @description Product labels are globally unique and contain the provider name. */ - label: definitions["Label"]; - name: definitions["Name"]; - state: definitions["ProductState"]; - listing: definitions["ProductListing"]; - logo_url: definitions["LogoURL"]; + label: definitions['Label'] + name: definitions['Name'] + state: definitions['ProductState'] + listing: definitions['ProductListing'] + logo_url: definitions['LogoURL'] /** @description 140 character sentence positioning the product. */ - tagline: string; + tagline: string /** @description A list of value propositions of the product. */ - value_props: definitions["ValueProp"][]; + value_props: definitions['ValueProp'][] /** @description A list of getting started steps for the product */ - setup_steps?: string[]; - images: definitions["ProductImageURL"][]; + setup_steps?: string[] + images: definitions['ProductImageURL'][] /** Format: email */ - support_email: string; + support_email: string /** Format: url */ - documentation_url: string; + documentation_url: string /** * @description URL to this Product's Terms of Service. If provided is true, then * a url must be set. Otherwise, provided is false. */ terms: { /** Format: url */ - url?: string; - provided: boolean; - }; - feature_types: definitions["FeatureType"][]; + url?: string + provided: boolean + } + feature_types: definitions['FeatureType'][] billing: { /** @enum {string} */ - type: "monthly-prorated" | "monthly-anniversary" | "annual-anniversary"; + type: 'monthly-prorated' | 'monthly-anniversary' | 'annual-anniversary' /** @enum {string} */ - currency: "usd"; - }; + currency: 'usd' + } integration: { - provisioning: definitions["ProductProvisioning"]; + provisioning: definitions['ProductProvisioning'] /** Format: url */ - base_url: string; + base_url: string /** Format: url */ - sso_url?: string; + sso_url?: string /** @enum {string} */ - version: "v1"; - features: definitions["ProductIntegrationFeatures"]; - }; - tags?: definitions["ProductTags"]; - }; + version: 'v1' + features: definitions['ProductIntegrationFeatures'] + } + tags?: definitions['ProductTags'] + } Product: { - id: definitions["ID"]; + id: definitions['ID'] /** @enum {integer} */ - version: 1; + version: 1 /** @enum {string} */ - type: "product"; - body: definitions["ProductBody"]; - }; + type: 'product' + body: definitions['ProductBody'] + } CreateProduct: { - body: definitions["ProductBody"]; - }; + body: definitions['ProductBody'] + } /** @description Array of Plan IDs that this Plan can be resized to, if null all will be assumed */ - PlanResizeList: definitions["ID"][]; + PlanResizeList: definitions['ID'][] PlanBody: { - provider_id: definitions["ID"]; - product_id: definitions["ID"]; - name: definitions["Name"]; - label: definitions["Label"]; - state: definitions["PlanState"]; - resizable_to?: definitions["PlanResizeList"]; + provider_id: definitions['ID'] + product_id: definitions['ID'] + name: definitions['Name'] + label: definitions['Label'] + state: definitions['PlanState'] + resizable_to?: definitions['PlanResizeList'] /** @description Array of Region IDs */ - regions: definitions["ID"][]; + regions: definitions['ID'][] /** @description Array of Feature Values */ - features: definitions["FeatureValue"][]; + features: definitions['FeatureValue'][] /** * @description The number of days a user gets as a free trial when subscribing to * this plan. Trials are valid only once per product; changing plans * or adding an additional subscription will not start a new trial. */ - trial_days?: number; + trial_days?: number /** @description Dollar value in cents. */ - cost: number; - }; + cost: number + } /** @enum {string} */ - PlanState: "hidden" | "available" | "grandfathered" | "unlisted"; - ExpandedPlanBody: definitions["PlanBody"] & { + PlanState: 'hidden' | 'available' | 'grandfathered' | 'unlisted' + ExpandedPlanBody: definitions['PlanBody'] & { /** @description An array of feature definitions for the plan, as defined on the Product. */ - expanded_features: definitions["ExpandedFeature"][]; + expanded_features: definitions['ExpandedFeature'][] /** @description A boolean flag that indicates if a plan is free or not based on it's cost and features. */ - free: boolean; + free: boolean /** @description Plan cost using its default features plus base cost. */ - defaultCost?: number; + defaultCost?: number /** @description A boolean flag that indicates if a plan has customizable features. */ - customizable?: boolean; - }; - ExpandedFeature: definitions["FeatureType"] & { + customizable?: boolean + } + ExpandedFeature: definitions['FeatureType'] & { /** @description The string value set for the feature on the plan, this should only be used if the value property is null. */ - value_string: string; - value: definitions["FeatureValueDetails"]; - }; + value_string: string + value: definitions['FeatureValueDetails'] + } Plan: { - id: definitions["ID"]; + id: definitions['ID'] /** @enum {integer} */ - version: 1; + version: 1 /** @enum {string} */ - type: "plan"; - body: definitions["PlanBody"]; - }; + type: 'plan' + body: definitions['PlanBody'] + } ExpandedPlan: { - id: definitions["ID"]; + id: definitions['ID'] /** @enum {integer} */ - version: 1; + version: 1 /** @enum {string} */ - type: "plan"; - body: definitions["ExpandedPlanBody"]; - }; + type: 'plan' + body: definitions['ExpandedPlanBody'] + } CreatePlan: { - body: definitions["PlanBody"]; - }; + body: definitions['PlanBody'] + } /** @description Unexpected error */ Error: { /** @description The error type */ - type: string; + type: string /** @description Explanation of the errors */ - message: string[]; - }; + message: string[] + } /** * @description Describes how a feature cost should be calculated. An empty * string defaults to the normal price calculation using the value cost. @@ -1052,17 +1052,17 @@ export interface definitions { * - `another-feature-label#number` is the numeric value of a number feature * In a feature formula, plan base cost and total cost cannot be used */ - PriceFormula: string; + PriceFormula: string ExpandedProduct: { - id: definitions["ID"]; + id: definitions['ID'] /** @enum {integer} */ - version: 1; + version: 1 /** @enum {string} */ - type: "product"; - body: definitions["ProductBody"]; - plans?: definitions["ExpandedPlan"][]; - provider: definitions["Provider"]; - }; + type: 'product' + body: definitions['ProductBody'] + plans?: definitions['ExpandedPlan'][] + provider: definitions['Provider'] + } } export interface parameters { @@ -1070,7 +1070,7 @@ export interface parameters { * Format: label * @description Filter results to only include those that have this label. */ - LabelFilter: string; + LabelFilter: string } export interface operations {} diff --git a/test/v2/expected/null-in-enum.immutable.ts b/test/v2/expected/null-in-enum.immutable.ts index 25e168011..c2eae00f3 100644 --- a/test/v2/expected/null-in-enum.immutable.ts +++ b/test/v2/expected/null-in-enum.immutable.ts @@ -4,41 +4,41 @@ */ export interface paths { - readonly "/test": { - readonly post: operations["addTest"]; - }; + readonly '/test': { + readonly post: operations['addTest'] + } } export interface definitions { /** @description Enum with null and nullable */ readonly MyType: { /** @enum {string|null} */ - readonly myField?: ("foo" | "bar" | null) | null; - }; + readonly myField?: ('foo' | 'bar' | null) | null + } /** @description Enum with null */ readonly MyTypeNotNullable: { /** @enum {string} */ - readonly myField?: "foo" | "bar" | null; - }; + readonly myField?: 'foo' | 'bar' | null + } /** @description Enum with null */ readonly MyTypeNotNullableNotNull: { /** @enum {string} */ - readonly myField?: "foo" | "bar"; - }; + readonly myField?: 'foo' | 'bar' + } /** @description Enum with null */ readonly MyTypeMixed: { /** @enum {string} */ - readonly myField?: "foo" | 2 | false | null; - }; + readonly myField?: 'foo' | 2 | false | null + } } export interface operations { readonly addTest: { readonly responses: { /** OK */ - readonly 200: unknown; - }; - }; + readonly 200: unknown + } + } } export interface external {} diff --git a/test/v2/expected/null-in-enum.ts b/test/v2/expected/null-in-enum.ts index 1173795f1..21b1ca5f3 100644 --- a/test/v2/expected/null-in-enum.ts +++ b/test/v2/expected/null-in-enum.ts @@ -4,41 +4,41 @@ */ export interface paths { - "/test": { - post: operations["addTest"]; - }; + '/test': { + post: operations['addTest'] + } } export interface definitions { /** @description Enum with null and nullable */ MyType: { /** @enum {string|null} */ - myField?: ("foo" | "bar" | null) | null; - }; + myField?: ('foo' | 'bar' | null) | null + } /** @description Enum with null */ MyTypeNotNullable: { /** @enum {string} */ - myField?: "foo" | "bar" | null; - }; + myField?: 'foo' | 'bar' | null + } /** @description Enum with null */ MyTypeNotNullableNotNull: { /** @enum {string} */ - myField?: "foo" | "bar"; - }; + myField?: 'foo' | 'bar' + } /** @description Enum with null */ MyTypeMixed: { /** @enum {string} */ - myField?: "foo" | 2 | false | null; - }; + myField?: 'foo' | 2 | false | null + } } export interface operations { addTest: { responses: { /** OK */ - 200: unknown; - }; - }; + 200: unknown + } + } } export interface external {} diff --git a/test/v2/expected/petstore.immutable.ts b/test/v2/expected/petstore.immutable.ts index 6f66eae0e..019045295 100644 --- a/test/v2/expected/petstore.immutable.ts +++ b/test/v2/expected/petstore.immutable.ts @@ -4,127 +4,127 @@ */ export interface paths { - readonly "/pet": { - readonly put: operations["updatePet"]; - readonly post: operations["addPet"]; - }; - readonly "/pet/findByStatus": { + readonly '/pet': { + readonly put: operations['updatePet'] + readonly post: operations['addPet'] + } + readonly '/pet/findByStatus': { /** Multiple status values can be provided with comma separated strings */ - readonly get: operations["findPetsByStatus"]; - }; - readonly "/pet/findByTags": { + readonly get: operations['findPetsByStatus'] + } + readonly '/pet/findByTags': { /** Muliple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. */ - readonly get: operations["findPetsByTags"]; - }; - readonly "/pet/{petId}": { + readonly get: operations['findPetsByTags'] + } + readonly '/pet/{petId}': { /** Returns a single pet */ - readonly get: operations["getPetById"]; - readonly post: operations["updatePetWithForm"]; - readonly delete: operations["deletePet"]; - }; - readonly "/pet/{petId}/uploadImage": { - readonly post: operations["uploadFile"]; - }; - readonly "/store/inventory": { + readonly get: operations['getPetById'] + readonly post: operations['updatePetWithForm'] + readonly delete: operations['deletePet'] + } + readonly '/pet/{petId}/uploadImage': { + readonly post: operations['uploadFile'] + } + readonly '/store/inventory': { /** Returns a map of status codes to quantities */ - readonly get: operations["getInventory"]; - }; - readonly "/store/order": { - readonly post: operations["placeOrder"]; - }; - readonly "/store/order/{orderId}": { + readonly get: operations['getInventory'] + } + readonly '/store/order': { + readonly post: operations['placeOrder'] + } + readonly '/store/order/{orderId}': { /** For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions */ - readonly get: operations["getOrderById"]; + readonly get: operations['getOrderById'] /** For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors */ - readonly delete: operations["deleteOrder"]; - }; - readonly "/user": { + readonly delete: operations['deleteOrder'] + } + readonly '/user': { /** This can only be done by the logged in user. */ - readonly post: operations["createUser"]; - }; - readonly "/user/createWithArray": { - readonly post: operations["createUsersWithArrayInput"]; - }; - readonly "/user/createWithList": { - readonly post: operations["createUsersWithListInput"]; - }; - readonly "/user/login": { - readonly get: operations["loginUser"]; - }; - readonly "/user/logout": { - readonly get: operations["logoutUser"]; - }; - readonly "/user/{username}": { - readonly get: operations["getUserByName"]; + readonly post: operations['createUser'] + } + readonly '/user/createWithArray': { + readonly post: operations['createUsersWithArrayInput'] + } + readonly '/user/createWithList': { + readonly post: operations['createUsersWithListInput'] + } + readonly '/user/login': { + readonly get: operations['loginUser'] + } + readonly '/user/logout': { + readonly get: operations['logoutUser'] + } + readonly '/user/{username}': { + readonly get: operations['getUserByName'] /** This can only be done by the logged in user. */ - readonly put: operations["updateUser"]; + readonly put: operations['updateUser'] /** This can only be done by the logged in user. */ - readonly delete: operations["deleteUser"]; - }; + readonly delete: operations['deleteUser'] + } } export interface definitions { readonly Order: { /** Format: int64 */ - readonly id?: number; + readonly id?: number /** Format: int64 */ - readonly petId?: number; + readonly petId?: number /** Format: int32 */ - readonly quantity?: number; + readonly quantity?: number /** Format: date-time */ - readonly shipDate?: string; + readonly shipDate?: string /** * @description Order Status * @enum {string} */ - readonly status?: "placed" | "approved" | "delivered"; - readonly complete?: boolean; - }; + readonly status?: 'placed' | 'approved' | 'delivered' + readonly complete?: boolean + } readonly Category: { /** Format: int64 */ - readonly id?: number; - readonly name?: string; - }; + readonly id?: number + readonly name?: string + } readonly User: { /** Format: int64 */ - readonly id?: number; - readonly username?: string; - readonly firstName?: string; - readonly lastName?: string; - readonly email?: string; - readonly password?: string; - readonly phone?: string; + readonly id?: number + readonly username?: string + readonly firstName?: string + readonly lastName?: string + readonly email?: string + readonly password?: string + readonly phone?: string /** * Format: int32 * @description User Status */ - readonly userStatus?: number; - }; + readonly userStatus?: number + } readonly Tag: { /** Format: int64 */ - readonly id?: number; - readonly name?: string; - }; + readonly id?: number + readonly name?: string + } readonly Pet: { /** Format: int64 */ - readonly id?: number; - readonly category?: definitions["Category"]; + readonly id?: number + readonly category?: definitions['Category'] /** @example doggie */ - readonly name: string; - readonly photoUrls: readonly string[]; - readonly tags?: readonly definitions["Tag"][]; + readonly name: string + readonly photoUrls: readonly string[] + readonly tags?: readonly definitions['Tag'][] /** * @description pet status in the store * @enum {string} */ - readonly status?: "available" | "pending" | "sold"; - }; + readonly status?: 'available' | 'pending' | 'sold' + } readonly ApiResponse: { /** Format: int32 */ - readonly code?: number; - readonly type?: string; - readonly message?: string; - }; + readonly code?: number + readonly type?: string + readonly message?: string + } } export interface operations { @@ -132,313 +132,313 @@ export interface operations { readonly parameters: { readonly body: { /** Pet object that needs to be added to the store */ - readonly body: definitions["Pet"]; - }; - }; + readonly body: definitions['Pet'] + } + } readonly responses: { /** Invalid ID supplied */ - readonly 400: unknown; + readonly 400: unknown /** Pet not found */ - readonly 404: unknown; + readonly 404: unknown /** Validation exception */ - readonly 405: unknown; - }; - }; + readonly 405: unknown + } + } readonly addPet: { readonly parameters: { readonly body: { /** Pet object that needs to be added to the store */ - readonly body: definitions["Pet"]; - }; - }; + readonly body: definitions['Pet'] + } + } readonly responses: { /** Invalid input */ - readonly 405: unknown; - }; - }; + readonly 405: unknown + } + } /** Multiple status values can be provided with comma separated strings */ readonly findPetsByStatus: { readonly parameters: { readonly query: { /** Status values that need to be considered for filter */ - readonly status: readonly ("available" | "pending" | "sold")[]; - }; - }; + readonly status: readonly ('available' | 'pending' | 'sold')[] + } + } readonly responses: { /** successful operation */ readonly 200: { - readonly schema: readonly definitions["Pet"][]; - }; + readonly schema: readonly definitions['Pet'][] + } /** Invalid status value */ - readonly 400: unknown; - }; - }; + readonly 400: unknown + } + } /** Muliple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. */ readonly findPetsByTags: { readonly parameters: { readonly query: { /** Tags to filter by */ - readonly tags: readonly string[]; - }; - }; + readonly tags: readonly string[] + } + } readonly responses: { /** successful operation */ readonly 200: { - readonly schema: readonly definitions["Pet"][]; - }; + readonly schema: readonly definitions['Pet'][] + } /** Invalid tag value */ - readonly 400: unknown; - }; - }; + readonly 400: unknown + } + } /** Returns a single pet */ readonly getPetById: { readonly parameters: { readonly path: { /** ID of pet to return */ - readonly petId: number; - }; - }; + readonly petId: number + } + } readonly responses: { /** successful operation */ readonly 200: { - readonly schema: definitions["Pet"]; - }; + readonly schema: definitions['Pet'] + } /** Invalid ID supplied */ - readonly 400: unknown; + readonly 400: unknown /** Pet not found */ - readonly 404: unknown; - }; - }; + readonly 404: unknown + } + } readonly updatePetWithForm: { readonly parameters: { readonly path: { /** ID of pet that needs to be updated */ - readonly petId: number; - }; + readonly petId: number + } readonly formData: { /** Updated name of the pet */ - readonly name?: string; + readonly name?: string /** Updated status of the pet */ - readonly status?: string; - }; - }; + readonly status?: string + } + } readonly responses: { /** Invalid input */ - readonly 405: unknown; - }; - }; + readonly 405: unknown + } + } readonly deletePet: { readonly parameters: { readonly header: { - readonly api_key?: string; - }; + readonly api_key?: string + } readonly path: { /** Pet id to delete */ - readonly petId: number; - }; - }; + readonly petId: number + } + } readonly responses: { /** Invalid ID supplied */ - readonly 400: unknown; + readonly 400: unknown /** Pet not found */ - readonly 404: unknown; - }; - }; + readonly 404: unknown + } + } readonly uploadFile: { readonly parameters: { readonly path: { /** ID of pet to update */ - readonly petId: number; - }; + readonly petId: number + } readonly formData: { /** Additional data to pass to server */ - readonly additionalMetadata?: string; + readonly additionalMetadata?: string /** file to upload */ - readonly file?: unknown; - }; - }; + readonly file?: unknown + } + } readonly responses: { /** successful operation */ readonly 200: { - readonly schema: definitions["ApiResponse"]; - }; - }; - }; + readonly schema: definitions['ApiResponse'] + } + } + } /** Returns a map of status codes to quantities */ readonly getInventory: { - readonly parameters: {}; + readonly parameters: {} readonly responses: { /** successful operation */ readonly 200: { - readonly schema: { readonly [key: string]: number }; - }; - }; - }; + readonly schema: { readonly [key: string]: number } + } + } + } readonly placeOrder: { readonly parameters: { readonly body: { /** order placed for purchasing the pet */ - readonly body: definitions["Order"]; - }; - }; + readonly body: definitions['Order'] + } + } readonly responses: { /** successful operation */ readonly 200: { - readonly schema: definitions["Order"]; - }; + readonly schema: definitions['Order'] + } /** Invalid Order */ - readonly 400: unknown; - }; - }; + readonly 400: unknown + } + } /** For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions */ readonly getOrderById: { readonly parameters: { readonly path: { /** ID of pet that needs to be fetched */ - readonly orderId: number; - }; - }; + readonly orderId: number + } + } readonly responses: { /** successful operation */ readonly 200: { - readonly schema: definitions["Order"]; - }; + readonly schema: definitions['Order'] + } /** Invalid ID supplied */ - readonly 400: unknown; + readonly 400: unknown /** Order not found */ - readonly 404: unknown; - }; - }; + readonly 404: unknown + } + } /** For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors */ readonly deleteOrder: { readonly parameters: { readonly path: { /** ID of the order that needs to be deleted */ - readonly orderId: number; - }; - }; + readonly orderId: number + } + } readonly responses: { /** Invalid ID supplied */ - readonly 400: unknown; + readonly 400: unknown /** Order not found */ - readonly 404: unknown; - }; - }; + readonly 404: unknown + } + } /** This can only be done by the logged in user. */ readonly createUser: { readonly parameters: { readonly body: { /** Created user object */ - readonly body: definitions["User"]; - }; - }; + readonly body: definitions['User'] + } + } readonly responses: { /** successful operation */ - readonly default: unknown; - }; - }; + readonly default: unknown + } + } readonly createUsersWithArrayInput: { readonly parameters: { readonly body: { /** List of user object */ - readonly body: readonly definitions["User"][]; - }; - }; + readonly body: readonly definitions['User'][] + } + } readonly responses: { /** successful operation */ - readonly default: unknown; - }; - }; + readonly default: unknown + } + } readonly createUsersWithListInput: { readonly parameters: { readonly body: { /** List of user object */ - readonly body: readonly definitions["User"][]; - }; - }; + readonly body: readonly definitions['User'][] + } + } readonly responses: { /** successful operation */ - readonly default: unknown; - }; - }; + readonly default: unknown + } + } readonly loginUser: { readonly parameters: { readonly query: { /** The user name for login */ - readonly username: string; + readonly username: string /** The password for login in clear text */ - readonly password: string; - }; - }; + readonly password: string + } + } readonly responses: { /** successful operation */ readonly 200: { - readonly headers: {}; - readonly schema: string; - }; + readonly headers: {} + readonly schema: string + } /** Invalid username/password supplied */ - readonly 400: unknown; - }; - }; + readonly 400: unknown + } + } readonly logoutUser: { - readonly parameters: {}; + readonly parameters: {} readonly responses: { /** successful operation */ - readonly default: unknown; - }; - }; + readonly default: unknown + } + } readonly getUserByName: { readonly parameters: { readonly path: { /** The name that needs to be fetched. Use user1 for testing. */ - readonly username: string; - }; - }; + readonly username: string + } + } readonly responses: { /** successful operation */ readonly 200: { - readonly schema: definitions["User"]; - }; + readonly schema: definitions['User'] + } /** Invalid username supplied */ - readonly 400: unknown; + readonly 400: unknown /** User not found */ - readonly 404: unknown; - }; - }; + readonly 404: unknown + } + } /** This can only be done by the logged in user. */ readonly updateUser: { readonly parameters: { readonly path: { /** name that need to be updated */ - readonly username: string; - }; + readonly username: string + } readonly body: { /** Updated user object */ - readonly body: definitions["User"]; - }; - }; + readonly body: definitions['User'] + } + } readonly responses: { /** Invalid user supplied */ - readonly 400: unknown; + readonly 400: unknown /** User not found */ - readonly 404: unknown; - }; - }; + readonly 404: unknown + } + } /** This can only be done by the logged in user. */ readonly deleteUser: { readonly parameters: { readonly path: { /** The name that needs to be deleted */ - readonly username: string; - }; - }; + readonly username: string + } + } readonly responses: { /** Invalid username supplied */ - readonly 400: unknown; + readonly 400: unknown /** User not found */ - readonly 404: unknown; - }; - }; + readonly 404: unknown + } + } } export interface external {} diff --git a/test/v2/expected/petstore.ts b/test/v2/expected/petstore.ts index 313827642..062705bbf 100644 --- a/test/v2/expected/petstore.ts +++ b/test/v2/expected/petstore.ts @@ -4,127 +4,127 @@ */ export interface paths { - "/pet": { - put: operations["updatePet"]; - post: operations["addPet"]; - }; - "/pet/findByStatus": { + '/pet': { + put: operations['updatePet'] + post: operations['addPet'] + } + '/pet/findByStatus': { /** Multiple status values can be provided with comma separated strings */ - get: operations["findPetsByStatus"]; - }; - "/pet/findByTags": { + get: operations['findPetsByStatus'] + } + '/pet/findByTags': { /** Muliple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. */ - get: operations["findPetsByTags"]; - }; - "/pet/{petId}": { + get: operations['findPetsByTags'] + } + '/pet/{petId}': { /** Returns a single pet */ - get: operations["getPetById"]; - post: operations["updatePetWithForm"]; - delete: operations["deletePet"]; - }; - "/pet/{petId}/uploadImage": { - post: operations["uploadFile"]; - }; - "/store/inventory": { + get: operations['getPetById'] + post: operations['updatePetWithForm'] + delete: operations['deletePet'] + } + '/pet/{petId}/uploadImage': { + post: operations['uploadFile'] + } + '/store/inventory': { /** Returns a map of status codes to quantities */ - get: operations["getInventory"]; - }; - "/store/order": { - post: operations["placeOrder"]; - }; - "/store/order/{orderId}": { + get: operations['getInventory'] + } + '/store/order': { + post: operations['placeOrder'] + } + '/store/order/{orderId}': { /** For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions */ - get: operations["getOrderById"]; + get: operations['getOrderById'] /** For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors */ - delete: operations["deleteOrder"]; - }; - "/user": { + delete: operations['deleteOrder'] + } + '/user': { /** This can only be done by the logged in user. */ - post: operations["createUser"]; - }; - "/user/createWithArray": { - post: operations["createUsersWithArrayInput"]; - }; - "/user/createWithList": { - post: operations["createUsersWithListInput"]; - }; - "/user/login": { - get: operations["loginUser"]; - }; - "/user/logout": { - get: operations["logoutUser"]; - }; - "/user/{username}": { - get: operations["getUserByName"]; + post: operations['createUser'] + } + '/user/createWithArray': { + post: operations['createUsersWithArrayInput'] + } + '/user/createWithList': { + post: operations['createUsersWithListInput'] + } + '/user/login': { + get: operations['loginUser'] + } + '/user/logout': { + get: operations['logoutUser'] + } + '/user/{username}': { + get: operations['getUserByName'] /** This can only be done by the logged in user. */ - put: operations["updateUser"]; + put: operations['updateUser'] /** This can only be done by the logged in user. */ - delete: operations["deleteUser"]; - }; + delete: operations['deleteUser'] + } } export interface definitions { Order: { /** Format: int64 */ - id?: number; + id?: number /** Format: int64 */ - petId?: number; + petId?: number /** Format: int32 */ - quantity?: number; + quantity?: number /** Format: date-time */ - shipDate?: string; + shipDate?: string /** * @description Order Status * @enum {string} */ - status?: "placed" | "approved" | "delivered"; - complete?: boolean; - }; + status?: 'placed' | 'approved' | 'delivered' + complete?: boolean + } Category: { /** Format: int64 */ - id?: number; - name?: string; - }; + id?: number + name?: string + } User: { /** Format: int64 */ - id?: number; - username?: string; - firstName?: string; - lastName?: string; - email?: string; - password?: string; - phone?: string; + id?: number + username?: string + firstName?: string + lastName?: string + email?: string + password?: string + phone?: string /** * Format: int32 * @description User Status */ - userStatus?: number; - }; + userStatus?: number + } Tag: { /** Format: int64 */ - id?: number; - name?: string; - }; + id?: number + name?: string + } Pet: { /** Format: int64 */ - id?: number; - category?: definitions["Category"]; + id?: number + category?: definitions['Category'] /** @example doggie */ - name: string; - photoUrls: string[]; - tags?: definitions["Tag"][]; + name: string + photoUrls: string[] + tags?: definitions['Tag'][] /** * @description pet status in the store * @enum {string} */ - status?: "available" | "pending" | "sold"; - }; + status?: 'available' | 'pending' | 'sold' + } ApiResponse: { /** Format: int32 */ - code?: number; - type?: string; - message?: string; - }; + code?: number + type?: string + message?: string + } } export interface operations { @@ -132,313 +132,313 @@ export interface operations { parameters: { body: { /** Pet object that needs to be added to the store */ - body: definitions["Pet"]; - }; - }; + body: definitions['Pet'] + } + } responses: { /** Invalid ID supplied */ - 400: unknown; + 400: unknown /** Pet not found */ - 404: unknown; + 404: unknown /** Validation exception */ - 405: unknown; - }; - }; + 405: unknown + } + } addPet: { parameters: { body: { /** Pet object that needs to be added to the store */ - body: definitions["Pet"]; - }; - }; + body: definitions['Pet'] + } + } responses: { /** Invalid input */ - 405: unknown; - }; - }; + 405: unknown + } + } /** Multiple status values can be provided with comma separated strings */ findPetsByStatus: { parameters: { query: { /** Status values that need to be considered for filter */ - status: ("available" | "pending" | "sold")[]; - }; - }; + status: ('available' | 'pending' | 'sold')[] + } + } responses: { /** successful operation */ 200: { - schema: definitions["Pet"][]; - }; + schema: definitions['Pet'][] + } /** Invalid status value */ - 400: unknown; - }; - }; + 400: unknown + } + } /** Muliple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. */ findPetsByTags: { parameters: { query: { /** Tags to filter by */ - tags: string[]; - }; - }; + tags: string[] + } + } responses: { /** successful operation */ 200: { - schema: definitions["Pet"][]; - }; + schema: definitions['Pet'][] + } /** Invalid tag value */ - 400: unknown; - }; - }; + 400: unknown + } + } /** Returns a single pet */ getPetById: { parameters: { path: { /** ID of pet to return */ - petId: number; - }; - }; + petId: number + } + } responses: { /** successful operation */ 200: { - schema: definitions["Pet"]; - }; + schema: definitions['Pet'] + } /** Invalid ID supplied */ - 400: unknown; + 400: unknown /** Pet not found */ - 404: unknown; - }; - }; + 404: unknown + } + } updatePetWithForm: { parameters: { path: { /** ID of pet that needs to be updated */ - petId: number; - }; + petId: number + } formData: { /** Updated name of the pet */ - name?: string; + name?: string /** Updated status of the pet */ - status?: string; - }; - }; + status?: string + } + } responses: { /** Invalid input */ - 405: unknown; - }; - }; + 405: unknown + } + } deletePet: { parameters: { header: { - api_key?: string; - }; + api_key?: string + } path: { /** Pet id to delete */ - petId: number; - }; - }; + petId: number + } + } responses: { /** Invalid ID supplied */ - 400: unknown; + 400: unknown /** Pet not found */ - 404: unknown; - }; - }; + 404: unknown + } + } uploadFile: { parameters: { path: { /** ID of pet to update */ - petId: number; - }; + petId: number + } formData: { /** Additional data to pass to server */ - additionalMetadata?: string; + additionalMetadata?: string /** file to upload */ - file?: unknown; - }; - }; + file?: unknown + } + } responses: { /** successful operation */ 200: { - schema: definitions["ApiResponse"]; - }; - }; - }; + schema: definitions['ApiResponse'] + } + } + } /** Returns a map of status codes to quantities */ getInventory: { - parameters: {}; + parameters: {} responses: { /** successful operation */ 200: { - schema: { [key: string]: number }; - }; - }; - }; + schema: { [key: string]: number } + } + } + } placeOrder: { parameters: { body: { /** order placed for purchasing the pet */ - body: definitions["Order"]; - }; - }; + body: definitions['Order'] + } + } responses: { /** successful operation */ 200: { - schema: definitions["Order"]; - }; + schema: definitions['Order'] + } /** Invalid Order */ - 400: unknown; - }; - }; + 400: unknown + } + } /** For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions */ getOrderById: { parameters: { path: { /** ID of pet that needs to be fetched */ - orderId: number; - }; - }; + orderId: number + } + } responses: { /** successful operation */ 200: { - schema: definitions["Order"]; - }; + schema: definitions['Order'] + } /** Invalid ID supplied */ - 400: unknown; + 400: unknown /** Order not found */ - 404: unknown; - }; - }; + 404: unknown + } + } /** For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors */ deleteOrder: { parameters: { path: { /** ID of the order that needs to be deleted */ - orderId: number; - }; - }; + orderId: number + } + } responses: { /** Invalid ID supplied */ - 400: unknown; + 400: unknown /** Order not found */ - 404: unknown; - }; - }; + 404: unknown + } + } /** This can only be done by the logged in user. */ createUser: { parameters: { body: { /** Created user object */ - body: definitions["User"]; - }; - }; + body: definitions['User'] + } + } responses: { /** successful operation */ - default: unknown; - }; - }; + default: unknown + } + } createUsersWithArrayInput: { parameters: { body: { /** List of user object */ - body: definitions["User"][]; - }; - }; + body: definitions['User'][] + } + } responses: { /** successful operation */ - default: unknown; - }; - }; + default: unknown + } + } createUsersWithListInput: { parameters: { body: { /** List of user object */ - body: definitions["User"][]; - }; - }; + body: definitions['User'][] + } + } responses: { /** successful operation */ - default: unknown; - }; - }; + default: unknown + } + } loginUser: { parameters: { query: { /** The user name for login */ - username: string; + username: string /** The password for login in clear text */ - password: string; - }; - }; + password: string + } + } responses: { /** successful operation */ 200: { - headers: {}; - schema: string; - }; + headers: {} + schema: string + } /** Invalid username/password supplied */ - 400: unknown; - }; - }; + 400: unknown + } + } logoutUser: { - parameters: {}; + parameters: {} responses: { /** successful operation */ - default: unknown; - }; - }; + default: unknown + } + } getUserByName: { parameters: { path: { /** The name that needs to be fetched. Use user1 for testing. */ - username: string; - }; - }; + username: string + } + } responses: { /** successful operation */ 200: { - schema: definitions["User"]; - }; + schema: definitions['User'] + } /** Invalid username supplied */ - 400: unknown; + 400: unknown /** User not found */ - 404: unknown; - }; - }; + 404: unknown + } + } /** This can only be done by the logged in user. */ updateUser: { parameters: { path: { /** name that need to be updated */ - username: string; - }; + username: string + } body: { /** Updated user object */ - body: definitions["User"]; - }; - }; + body: definitions['User'] + } + } responses: { /** Invalid user supplied */ - 400: unknown; + 400: unknown /** User not found */ - 404: unknown; - }; - }; + 404: unknown + } + } /** This can only be done by the logged in user. */ deleteUser: { parameters: { path: { /** The name that needs to be deleted */ - username: string; - }; - }; + username: string + } + } responses: { /** Invalid username supplied */ - 400: unknown; + 400: unknown /** User not found */ - 404: unknown; - }; - }; + 404: unknown + } + } } export interface external {} diff --git a/test/v2/expected/reference-to-properties.immutable.ts b/test/v2/expected/reference-to-properties.immutable.ts index 6211b699b..67d6cc327 100644 --- a/test/v2/expected/reference-to-properties.immutable.ts +++ b/test/v2/expected/reference-to-properties.immutable.ts @@ -4,18 +4,18 @@ */ export interface paths { - readonly "/pet": { - readonly post: operations["addPet"]; - }; + readonly '/pet': { + readonly post: operations['addPet'] + } } export interface definitions { readonly Pet: { /** Format: int64 */ - readonly id?: number; + readonly id?: number /** @example doggie */ - readonly name: string; - }; + readonly name: string + } } export interface operations { @@ -23,14 +23,14 @@ export interface operations { readonly parameters: { readonly body: { readonly body: { - readonly name?: definitions["Pet"]["name"]; - }; - }; - }; + readonly name?: definitions['Pet']['name'] + } + } + } readonly responses: { - readonly 200: unknown; - }; - }; + readonly 200: unknown + } + } } export interface external {} diff --git a/test/v2/expected/reference-to-properties.ts b/test/v2/expected/reference-to-properties.ts index 98db35f41..050d2b3c7 100644 --- a/test/v2/expected/reference-to-properties.ts +++ b/test/v2/expected/reference-to-properties.ts @@ -4,18 +4,18 @@ */ export interface paths { - "/pet": { - post: operations["addPet"]; - }; + '/pet': { + post: operations['addPet'] + } } export interface definitions { Pet: { /** Format: int64 */ - id?: number; + id?: number /** @example doggie */ - name: string; - }; + name: string + } } export interface operations { @@ -23,14 +23,14 @@ export interface operations { parameters: { body: { body: { - name?: definitions["Pet"]["name"]; - }; - }; - }; + name?: definitions['Pet']['name'] + } + } + } responses: { - 200: unknown; - }; - }; + 200: unknown + } + } } export interface external {} diff --git a/test/v2/expected/stripe.immutable.ts b/test/v2/expected/stripe.immutable.ts index 5270ce517..68f924fec 100644 --- a/test/v2/expected/stripe.immutable.ts +++ b/test/v2/expected/stripe.immutable.ts @@ -4,23 +4,23 @@ */ export interface paths { - readonly "/v1/3d_secure": { + readonly '/v1/3d_secure': { /**

Initiate 3D Secure authentication.

*/ - readonly post: operations["Post3dSecure"]; - }; - readonly "/v1/3d_secure/{three_d_secure}": { + readonly post: operations['Post3dSecure'] + } + readonly '/v1/3d_secure/{three_d_secure}': { /**

Retrieves a 3D Secure object.

*/ - readonly get: operations["Get3dSecureThreeDSecure"]; - }; - readonly "/v1/account": { + readonly get: operations['Get3dSecureThreeDSecure'] + } + readonly '/v1/account': { /**

Retrieves the details of an account.

*/ - readonly get: operations["GetAccount"]; + readonly get: operations['GetAccount'] /** *

Updates a connected Express or Custom account by setting the values of the parameters passed. Any parameters not provided are left unchanged. Most parameters can be changed only for Custom accounts. (These are marked Custom Only below.) Parameters marked Custom and Express are supported by both account types.

* *

To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.

*/ - readonly post: operations["PostAccount"]; + readonly post: operations['PostAccount'] /** *

With Connect, you can delete Custom or Express accounts you manage.

* @@ -28,101 +28,101 @@ export interface paths { * *

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

*/ - readonly delete: operations["DeleteAccount"]; - }; - readonly "/v1/account/bank_accounts": { + readonly delete: operations['DeleteAccount'] + } + readonly '/v1/account/bank_accounts': { /**

Create an external account for a given account.

*/ - readonly post: operations["PostAccountBankAccounts"]; - }; - readonly "/v1/account/bank_accounts/{id}": { + readonly post: operations['PostAccountBankAccounts'] + } + readonly '/v1/account/bank_accounts/{id}': { /**

Retrieve a specified external account for a given account.

*/ - readonly get: operations["GetAccountBankAccountsId"]; + readonly get: operations['GetAccountBankAccountsId'] /** *

Updates the metadata, account holder name, and account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

*

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

*/ - readonly post: operations["PostAccountBankAccountsId"]; + readonly post: operations['PostAccountBankAccountsId'] /**

Delete a specified external account for a given account.

*/ - readonly delete: operations["DeleteAccountBankAccountsId"]; - }; - readonly "/v1/account/capabilities": { + readonly delete: operations['DeleteAccountBankAccountsId'] + } + readonly '/v1/account/capabilities': { /**

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

*/ - readonly get: operations["GetAccountCapabilities"]; - }; - readonly "/v1/account/capabilities/{capability}": { + readonly get: operations['GetAccountCapabilities'] + } + readonly '/v1/account/capabilities/{capability}': { /**

Retrieves information about the specified Account Capability.

*/ - readonly get: operations["GetAccountCapabilitiesCapability"]; + readonly get: operations['GetAccountCapabilitiesCapability'] /**

Updates an existing Account Capability.

*/ - readonly post: operations["PostAccountCapabilitiesCapability"]; - }; - readonly "/v1/account/external_accounts": { + readonly post: operations['PostAccountCapabilitiesCapability'] + } + readonly '/v1/account/external_accounts': { /**

List external accounts for an account.

*/ - readonly get: operations["GetAccountExternalAccounts"]; + readonly get: operations['GetAccountExternalAccounts'] /**

Create an external account for a given account.

*/ - readonly post: operations["PostAccountExternalAccounts"]; - }; - readonly "/v1/account/external_accounts/{id}": { + readonly post: operations['PostAccountExternalAccounts'] + } + readonly '/v1/account/external_accounts/{id}': { /**

Retrieve a specified external account for a given account.

*/ - readonly get: operations["GetAccountExternalAccountsId"]; + readonly get: operations['GetAccountExternalAccountsId'] /** *

Updates the metadata, account holder name, and account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

*

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

*/ - readonly post: operations["PostAccountExternalAccountsId"]; + readonly post: operations['PostAccountExternalAccountsId'] /**

Delete a specified external account for a given account.

*/ - readonly delete: operations["DeleteAccountExternalAccountsId"]; - }; - readonly "/v1/account/login_links": { + readonly delete: operations['DeleteAccountExternalAccountsId'] + } + readonly '/v1/account/login_links': { /** *

Creates a single-use login link for an Express account to access their Stripe dashboard.

* *

You may only create login links for Express accounts connected to your platform.

*/ - readonly post: operations["PostAccountLoginLinks"]; - }; - readonly "/v1/account/logout": { + readonly post: operations['PostAccountLoginLinks'] + } + readonly '/v1/account/logout': { /** *

Invalidates all sessions for a light account, for a platform to use during platform logout.

* *

You may only log out Express accounts connected to your platform.

*/ - readonly put: operations["PutAccountLogout"]; - }; - readonly "/v1/account/people": { + readonly put: operations['PutAccountLogout'] + } + readonly '/v1/account/people': { /**

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.

*/ - readonly get: operations["GetAccountPeople"]; + readonly get: operations['GetAccountPeople'] /**

Creates a new person.

*/ - readonly post: operations["PostAccountPeople"]; - }; - readonly "/v1/account/people/{person}": { + readonly post: operations['PostAccountPeople'] + } + readonly '/v1/account/people/{person}': { /**

Retrieves an existing person.

*/ - readonly get: operations["GetAccountPeoplePerson"]; + readonly get: operations['GetAccountPeoplePerson'] /**

Updates an existing person.

*/ - readonly post: operations["PostAccountPeoplePerson"]; + readonly post: operations['PostAccountPeoplePerson'] /**

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.

*/ - readonly delete: operations["DeleteAccountPeoplePerson"]; - }; - readonly "/v1/account/persons": { + readonly delete: operations['DeleteAccountPeoplePerson'] + } + readonly '/v1/account/persons': { /**

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.

*/ - readonly get: operations["GetAccountPersons"]; + readonly get: operations['GetAccountPersons'] /**

Creates a new person.

*/ - readonly post: operations["PostAccountPersons"]; - }; - readonly "/v1/account/persons/{person}": { + readonly post: operations['PostAccountPersons'] + } + readonly '/v1/account/persons/{person}': { /**

Retrieves an existing person.

*/ - readonly get: operations["GetAccountPersonsPerson"]; + readonly get: operations['GetAccountPersonsPerson'] /**

Updates an existing person.

*/ - readonly post: operations["PostAccountPersonsPerson"]; + readonly post: operations['PostAccountPersonsPerson'] /**

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.

*/ - readonly delete: operations["DeleteAccountPersonsPerson"]; - }; - readonly "/v1/account_links": { + readonly delete: operations['DeleteAccountPersonsPerson'] + } + readonly '/v1/account_links': { /**

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

*/ - readonly post: operations["PostAccountLinks"]; - }; - readonly "/v1/accounts": { + readonly post: operations['PostAccountLinks'] + } + readonly '/v1/accounts': { /**

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

*/ - readonly get: operations["GetAccounts"]; + readonly get: operations['GetAccounts'] /** *

With Connect, you can create Stripe accounts for your users. * To do this, you’ll first need to register your platform.

@@ -130,17 +130,17 @@ export interface paths { *

For Standard accounts, parameters other than country, email, and type * are used to prefill the account application that we ask the account holder to complete.

*/ - readonly post: operations["PostAccounts"]; - }; - readonly "/v1/accounts/{account}": { + readonly post: operations['PostAccounts'] + } + readonly '/v1/accounts/{account}': { /**

Retrieves the details of an account.

*/ - readonly get: operations["GetAccountsAccount"]; + readonly get: operations['GetAccountsAccount'] /** *

Updates a connected Express or Custom account by setting the values of the parameters passed. Any parameters not provided are left unchanged. Most parameters can be changed only for Custom accounts. (These are marked Custom Only below.) Parameters marked Custom and Express are supported by both account types.

* *

To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.

*/ - readonly post: operations["PostAccountsAccount"]; + readonly post: operations['PostAccountsAccount'] /** *

With Connect, you can delete Custom or Express accounts you manage.

* @@ -148,138 +148,138 @@ export interface paths { * *

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

*/ - readonly delete: operations["DeleteAccountsAccount"]; - }; - readonly "/v1/accounts/{account}/bank_accounts": { + readonly delete: operations['DeleteAccountsAccount'] + } + readonly '/v1/accounts/{account}/bank_accounts': { /**

Create an external account for a given account.

*/ - readonly post: operations["PostAccountsAccountBankAccounts"]; - }; - readonly "/v1/accounts/{account}/bank_accounts/{id}": { + readonly post: operations['PostAccountsAccountBankAccounts'] + } + readonly '/v1/accounts/{account}/bank_accounts/{id}': { /**

Retrieve a specified external account for a given account.

*/ - readonly get: operations["GetAccountsAccountBankAccountsId"]; + readonly get: operations['GetAccountsAccountBankAccountsId'] /** *

Updates the metadata, account holder name, and account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

*

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

*/ - readonly post: operations["PostAccountsAccountBankAccountsId"]; + readonly post: operations['PostAccountsAccountBankAccountsId'] /**

Delete a specified external account for a given account.

*/ - readonly delete: operations["DeleteAccountsAccountBankAccountsId"]; - }; - readonly "/v1/accounts/{account}/capabilities": { + readonly delete: operations['DeleteAccountsAccountBankAccountsId'] + } + readonly '/v1/accounts/{account}/capabilities': { /**

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

*/ - readonly get: operations["GetAccountsAccountCapabilities"]; - }; - readonly "/v1/accounts/{account}/capabilities/{capability}": { + readonly get: operations['GetAccountsAccountCapabilities'] + } + readonly '/v1/accounts/{account}/capabilities/{capability}': { /**

Retrieves information about the specified Account Capability.

*/ - readonly get: operations["GetAccountsAccountCapabilitiesCapability"]; + readonly get: operations['GetAccountsAccountCapabilitiesCapability'] /**

Updates an existing Account Capability.

*/ - readonly post: operations["PostAccountsAccountCapabilitiesCapability"]; - }; - readonly "/v1/accounts/{account}/external_accounts": { + readonly post: operations['PostAccountsAccountCapabilitiesCapability'] + } + readonly '/v1/accounts/{account}/external_accounts': { /**

List external accounts for an account.

*/ - readonly get: operations["GetAccountsAccountExternalAccounts"]; + readonly get: operations['GetAccountsAccountExternalAccounts'] /**

Create an external account for a given account.

*/ - readonly post: operations["PostAccountsAccountExternalAccounts"]; - }; - readonly "/v1/accounts/{account}/external_accounts/{id}": { + readonly post: operations['PostAccountsAccountExternalAccounts'] + } + readonly '/v1/accounts/{account}/external_accounts/{id}': { /**

Retrieve a specified external account for a given account.

*/ - readonly get: operations["GetAccountsAccountExternalAccountsId"]; + readonly get: operations['GetAccountsAccountExternalAccountsId'] /** *

Updates the metadata, account holder name, and account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

*

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

*/ - readonly post: operations["PostAccountsAccountExternalAccountsId"]; + readonly post: operations['PostAccountsAccountExternalAccountsId'] /**

Delete a specified external account for a given account.

*/ - readonly delete: operations["DeleteAccountsAccountExternalAccountsId"]; - }; - readonly "/v1/accounts/{account}/login_links": { + readonly delete: operations['DeleteAccountsAccountExternalAccountsId'] + } + readonly '/v1/accounts/{account}/login_links': { /** *

Creates a single-use login link for an Express account to access their Stripe dashboard.

* *

You may only create login links for Express accounts connected to your platform.

*/ - readonly post: operations["PostAccountsAccountLoginLinks"]; - }; - readonly "/v1/accounts/{account}/logout": { + readonly post: operations['PostAccountsAccountLoginLinks'] + } + readonly '/v1/accounts/{account}/logout': { /** *

Invalidates all sessions for a light account, for a platform to use during platform logout.

* *

You may only log out Express accounts connected to your platform.

*/ - readonly put: operations["PutAccountsAccountLogout"]; - }; - readonly "/v1/accounts/{account}/people": { + readonly put: operations['PutAccountsAccountLogout'] + } + readonly '/v1/accounts/{account}/people': { /**

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.

*/ - readonly get: operations["GetAccountsAccountPeople"]; + readonly get: operations['GetAccountsAccountPeople'] /**

Creates a new person.

*/ - readonly post: operations["PostAccountsAccountPeople"]; - }; - readonly "/v1/accounts/{account}/people/{person}": { + readonly post: operations['PostAccountsAccountPeople'] + } + readonly '/v1/accounts/{account}/people/{person}': { /**

Retrieves an existing person.

*/ - readonly get: operations["GetAccountsAccountPeoplePerson"]; + readonly get: operations['GetAccountsAccountPeoplePerson'] /**

Updates an existing person.

*/ - readonly post: operations["PostAccountsAccountPeoplePerson"]; + readonly post: operations['PostAccountsAccountPeoplePerson'] /**

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.

*/ - readonly delete: operations["DeleteAccountsAccountPeoplePerson"]; - }; - readonly "/v1/accounts/{account}/persons": { + readonly delete: operations['DeleteAccountsAccountPeoplePerson'] + } + readonly '/v1/accounts/{account}/persons': { /**

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.

*/ - readonly get: operations["GetAccountsAccountPersons"]; + readonly get: operations['GetAccountsAccountPersons'] /**

Creates a new person.

*/ - readonly post: operations["PostAccountsAccountPersons"]; - }; - readonly "/v1/accounts/{account}/persons/{person}": { + readonly post: operations['PostAccountsAccountPersons'] + } + readonly '/v1/accounts/{account}/persons/{person}': { /**

Retrieves an existing person.

*/ - readonly get: operations["GetAccountsAccountPersonsPerson"]; + readonly get: operations['GetAccountsAccountPersonsPerson'] /**

Updates an existing person.

*/ - readonly post: operations["PostAccountsAccountPersonsPerson"]; + readonly post: operations['PostAccountsAccountPersonsPerson'] /**

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.

*/ - readonly delete: operations["DeleteAccountsAccountPersonsPerson"]; - }; - readonly "/v1/accounts/{account}/reject": { + readonly delete: operations['DeleteAccountsAccountPersonsPerson'] + } + readonly '/v1/accounts/{account}/reject': { /** *

With Connect, you may flag accounts as suspicious.

* *

Test-mode Custom and Express accounts can be rejected at any time. Accounts created using live-mode keys may only be rejected once all balances are zero.

*/ - readonly post: operations["PostAccountsAccountReject"]; - }; - readonly "/v1/apple_pay/domains": { + readonly post: operations['PostAccountsAccountReject'] + } + readonly '/v1/apple_pay/domains': { /**

List apple pay domains.

*/ - readonly get: operations["GetApplePayDomains"]; + readonly get: operations['GetApplePayDomains'] /**

Create an apple pay domain.

*/ - readonly post: operations["PostApplePayDomains"]; - }; - readonly "/v1/apple_pay/domains/{domain}": { + readonly post: operations['PostApplePayDomains'] + } + readonly '/v1/apple_pay/domains/{domain}': { /**

Retrieve an apple pay domain.

*/ - readonly get: operations["GetApplePayDomainsDomain"]; + readonly get: operations['GetApplePayDomainsDomain'] /**

Delete an apple pay domain.

*/ - readonly delete: operations["DeleteApplePayDomainsDomain"]; - }; - readonly "/v1/application_fees": { + readonly delete: operations['DeleteApplePayDomainsDomain'] + } + readonly '/v1/application_fees': { /**

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.

*/ - readonly get: operations["GetApplicationFees"]; - }; - readonly "/v1/application_fees/{fee}/refunds/{id}": { + readonly get: operations['GetApplicationFees'] + } + readonly '/v1/application_fees/{fee}/refunds/{id}': { /**

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.

*/ - readonly get: operations["GetApplicationFeesFeeRefundsId"]; + readonly get: operations['GetApplicationFeesFeeRefundsId'] /** *

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

* *

This request only accepts metadata as an argument.

*/ - readonly post: operations["PostApplicationFeesFeeRefundsId"]; - }; - readonly "/v1/application_fees/{id}": { + readonly post: operations['PostApplicationFeesFeeRefundsId'] + } + readonly '/v1/application_fees/{id}': { /**

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

*/ - readonly get: operations["GetApplicationFeesId"]; - }; - readonly "/v1/application_fees/{id}/refund": { - readonly post: operations["PostApplicationFeesIdRefund"]; - }; - readonly "/v1/application_fees/{id}/refunds": { + readonly get: operations['GetApplicationFeesId'] + } + readonly '/v1/application_fees/{id}/refund': { + readonly post: operations['PostApplicationFeesIdRefund'] + } + readonly '/v1/application_fees/{id}/refunds': { /**

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.

*/ - readonly get: operations["GetApplicationFeesIdRefunds"]; + readonly get: operations['GetApplicationFeesIdRefunds'] /** *

Refunds an application fee that has previously been collected but not yet refunded. * Funds will be refunded to the Stripe account from which the fee was originally collected.

@@ -291,96 +291,96 @@ export interface paths { * This method will raise an error when called on an already-refunded application fee, * or when trying to refund more money than is left on an application fee.

*/ - readonly post: operations["PostApplicationFeesIdRefunds"]; - }; - readonly "/v1/balance": { + readonly post: operations['PostApplicationFeesIdRefunds'] + } + readonly '/v1/balance': { /** *

Retrieves the current account balance, based on the authentication that was used to make the request. * For a sample request, see Accounting for negative balances.

*/ - readonly get: operations["GetBalance"]; - }; - readonly "/v1/balance/history": { + readonly get: operations['GetBalance'] + } + readonly '/v1/balance/history': { /** *

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

* *

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

*/ - readonly get: operations["GetBalanceHistory"]; - }; - readonly "/v1/balance/history/{id}": { + readonly get: operations['GetBalanceHistory'] + } + readonly '/v1/balance/history/{id}': { /** *

Retrieves the balance transaction with the given ID.

* *

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

*/ - readonly get: operations["GetBalanceHistoryId"]; - }; - readonly "/v1/balance_transactions": { + readonly get: operations['GetBalanceHistoryId'] + } + readonly '/v1/balance_transactions': { /** *

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

* *

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

*/ - readonly get: operations["GetBalanceTransactions"]; - }; - readonly "/v1/balance_transactions/{id}": { + readonly get: operations['GetBalanceTransactions'] + } + readonly '/v1/balance_transactions/{id}': { /** *

Retrieves the balance transaction with the given ID.

* *

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

*/ - readonly get: operations["GetBalanceTransactionsId"]; - }; - readonly "/v1/billing_portal/sessions": { + readonly get: operations['GetBalanceTransactionsId'] + } + readonly '/v1/billing_portal/sessions': { /**

Creates a session of the self-serve Portal.

*/ - readonly post: operations["PostBillingPortalSessions"]; - }; - readonly "/v1/bitcoin/receivers": { + readonly post: operations['PostBillingPortalSessions'] + } + readonly '/v1/bitcoin/receivers': { /**

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

*/ - readonly get: operations["GetBitcoinReceivers"]; - }; - readonly "/v1/bitcoin/receivers/{id}": { + readonly get: operations['GetBitcoinReceivers'] + } + readonly '/v1/bitcoin/receivers/{id}': { /**

Retrieves the Bitcoin receiver with the given ID.

*/ - readonly get: operations["GetBitcoinReceiversId"]; - }; - readonly "/v1/bitcoin/receivers/{receiver}/transactions": { + readonly get: operations['GetBitcoinReceiversId'] + } + readonly '/v1/bitcoin/receivers/{receiver}/transactions': { /**

List bitcoin transacitons for a given receiver.

*/ - readonly get: operations["GetBitcoinReceiversReceiverTransactions"]; - }; - readonly "/v1/bitcoin/transactions": { + readonly get: operations['GetBitcoinReceiversReceiverTransactions'] + } + readonly '/v1/bitcoin/transactions': { /**

List bitcoin transacitons for a given receiver.

*/ - readonly get: operations["GetBitcoinTransactions"]; - }; - readonly "/v1/charges": { + readonly get: operations['GetBitcoinTransactions'] + } + readonly '/v1/charges': { /**

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

*/ - readonly get: operations["GetCharges"]; + readonly get: operations['GetCharges'] /**

To charge a credit card or other payment source, you create a Charge object. If your API key is in test mode, the supplied payment source (e.g., card) won’t actually be charged, although everything else will occur as if in live mode. (Stripe assumes that the charge would have completed successfully).

*/ - readonly post: operations["PostCharges"]; - }; - readonly "/v1/charges/{charge}": { + readonly post: operations['PostCharges'] + } + readonly '/v1/charges/{charge}': { /**

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.

*/ - readonly get: operations["GetChargesCharge"]; + readonly get: operations['GetChargesCharge'] /**

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

*/ - readonly post: operations["PostChargesCharge"]; - }; - readonly "/v1/charges/{charge}/capture": { + readonly post: operations['PostChargesCharge'] + } + readonly '/v1/charges/{charge}/capture': { /** *

Capture the payment of an existing, uncaptured, charge. This is the second half of the two-step payment flow, where first you created a charge with the capture option set to false.

* *

Uncaptured payments expire exactly seven days after they are created. If they are not captured by that point in time, they will be marked as refunded and will no longer be capturable.

*/ - readonly post: operations["PostChargesChargeCapture"]; - }; - readonly "/v1/charges/{charge}/dispute": { + readonly post: operations['PostChargesChargeCapture'] + } + readonly '/v1/charges/{charge}/dispute': { /**

Retrieve a dispute for a specified charge.

*/ - readonly get: operations["GetChargesChargeDispute"]; - readonly post: operations["PostChargesChargeDispute"]; - }; - readonly "/v1/charges/{charge}/dispute/close": { - readonly post: operations["PostChargesChargeDisputeClose"]; - }; - readonly "/v1/charges/{charge}/refund": { + readonly get: operations['GetChargesChargeDispute'] + readonly post: operations['PostChargesChargeDispute'] + } + readonly '/v1/charges/{charge}/dispute/close': { + readonly post: operations['PostChargesChargeDisputeClose'] + } + readonly '/v1/charges/{charge}/refund': { /** *

When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.

* @@ -394,59 +394,59 @@ export interface paths { * 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.

*/ - readonly post: operations["PostChargesChargeRefund"]; - }; - readonly "/v1/charges/{charge}/refunds": { + readonly post: operations['PostChargesChargeRefund'] + } + readonly '/v1/charges/{charge}/refunds': { /**

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.

*/ - readonly get: operations["GetChargesChargeRefunds"]; + readonly get: operations['GetChargesChargeRefunds'] /**

Create a refund.

*/ - readonly post: operations["PostChargesChargeRefunds"]; - }; - readonly "/v1/charges/{charge}/refunds/{refund}": { + readonly post: operations['PostChargesChargeRefunds'] + } + readonly '/v1/charges/{charge}/refunds/{refund}': { /**

Retrieves the details of an existing refund.

*/ - readonly get: operations["GetChargesChargeRefundsRefund"]; + readonly get: operations['GetChargesChargeRefundsRefund'] /**

Update a specified refund.

*/ - readonly post: operations["PostChargesChargeRefundsRefund"]; - }; - readonly "/v1/checkout/sessions": { + readonly post: operations['PostChargesChargeRefundsRefund'] + } + readonly '/v1/checkout/sessions': { /**

Returns a list of Checkout Sessions.

*/ - readonly get: operations["GetCheckoutSessions"]; + readonly get: operations['GetCheckoutSessions'] /**

Creates a Session object.

*/ - readonly post: operations["PostCheckoutSessions"]; - }; - readonly "/v1/checkout/sessions/{session}": { + readonly post: operations['PostCheckoutSessions'] + } + readonly '/v1/checkout/sessions/{session}': { /**

Retrieves a Session object.

*/ - readonly get: operations["GetCheckoutSessionsSession"]; - }; - readonly "/v1/country_specs": { + readonly get: operations['GetCheckoutSessionsSession'] + } + readonly '/v1/country_specs': { /**

Lists all Country Spec objects available in the API.

*/ - readonly get: operations["GetCountrySpecs"]; - }; - readonly "/v1/country_specs/{country}": { + readonly get: operations['GetCountrySpecs'] + } + readonly '/v1/country_specs/{country}': { /**

Returns a Country Spec for a given Country code.

*/ - readonly get: operations["GetCountrySpecsCountry"]; - }; - readonly "/v1/coupons": { + readonly get: operations['GetCountrySpecsCountry'] + } + readonly '/v1/coupons': { /**

Returns a list of your coupons.

*/ - readonly get: operations["GetCoupons"]; + readonly get: operations['GetCoupons'] /** *

You can create coupons easily via the coupon management page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.

* *

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.

*/ - readonly post: operations["PostCoupons"]; - }; - readonly "/v1/coupons/{coupon}": { + readonly post: operations['PostCoupons'] + } + readonly '/v1/coupons/{coupon}': { /**

Retrieves the coupon with the given ID.

*/ - readonly get: operations["GetCouponsCoupon"]; + readonly get: operations['GetCouponsCoupon'] /**

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

*/ - readonly post: operations["PostCouponsCoupon"]; + readonly post: operations['PostCouponsCoupon'] /**

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.

*/ - readonly delete: operations["DeleteCouponsCoupon"]; - }; - readonly "/v1/credit_notes": { + readonly delete: operations['DeleteCouponsCoupon'] + } + readonly '/v1/credit_notes': { /**

Returns a list of credit notes.

*/ - readonly get: operations["GetCreditNotes"]; + readonly get: operations['GetCreditNotes'] /** *

Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces * its amount_due. For a status=paid invoice, a credit note does not affect its amount_due. Instead, it can result @@ -463,63 +463,63 @@ export interface paths { *

You may issue multiple credit notes for an invoice. Each credit note will increment the invoice’s pre_payment_credit_notes_amount * or post_payment_credit_notes_amount depending on its status at the time of credit note creation.

*/ - readonly post: operations["PostCreditNotes"]; - }; - readonly "/v1/credit_notes/preview": { + readonly post: operations['PostCreditNotes'] + } + readonly '/v1/credit_notes/preview': { /**

Get a preview of a credit note without creating it.

*/ - readonly get: operations["GetCreditNotesPreview"]; - }; - readonly "/v1/credit_notes/preview/lines": { + readonly get: operations['GetCreditNotesPreview'] + } + readonly '/v1/credit_notes/preview/lines': { /**

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.

*/ - readonly get: operations["GetCreditNotesPreviewLines"]; - }; - readonly "/v1/credit_notes/{credit_note}/lines": { + readonly get: operations['GetCreditNotesPreviewLines'] + } + readonly '/v1/credit_notes/{credit_note}/lines': { /**

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

*/ - readonly get: operations["GetCreditNotesCreditNoteLines"]; - }; - readonly "/v1/credit_notes/{id}": { + readonly get: operations['GetCreditNotesCreditNoteLines'] + } + readonly '/v1/credit_notes/{id}': { /**

Retrieves the credit note object with the given identifier.

*/ - readonly get: operations["GetCreditNotesId"]; + readonly get: operations['GetCreditNotesId'] /**

Updates an existing credit note.

*/ - readonly post: operations["PostCreditNotesId"]; - }; - readonly "/v1/credit_notes/{id}/void": { + readonly post: operations['PostCreditNotesId'] + } + readonly '/v1/credit_notes/{id}/void': { /**

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

*/ - readonly post: operations["PostCreditNotesIdVoid"]; - }; - readonly "/v1/customers": { + readonly post: operations['PostCreditNotesIdVoid'] + } + readonly '/v1/customers': { /**

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

*/ - readonly get: operations["GetCustomers"]; + readonly get: operations['GetCustomers'] /**

Creates a new customer object.

*/ - readonly post: operations["PostCustomers"]; - }; - readonly "/v1/customers/{customer}": { + readonly post: operations['PostCustomers'] + } + readonly '/v1/customers/{customer}': { /**

Retrieves the details of an existing customer. You need only supply the unique customer identifier that was returned upon customer creation.

*/ - readonly get: operations["GetCustomersCustomer"]; + readonly get: operations['GetCustomersCustomer'] /** *

Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the source parameter, that becomes the customer’s active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the source parameter: for each of the customer’s current subscriptions, if the subscription bills automatically and is in the past_due state, then the latest open invoice for the subscription with automatic collection enabled will be retried. This retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice. Changing the default_source for a customer will not trigger this behavior.

* *

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

*/ - readonly post: operations["PostCustomersCustomer"]; + readonly post: operations['PostCustomersCustomer'] /**

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

*/ - readonly delete: operations["DeleteCustomersCustomer"]; - }; - readonly "/v1/customers/{customer}/balance_transactions": { + readonly delete: operations['DeleteCustomersCustomer'] + } + readonly '/v1/customers/{customer}/balance_transactions': { /**

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

*/ - readonly get: operations["GetCustomersCustomerBalanceTransactions"]; + readonly get: operations['GetCustomersCustomerBalanceTransactions'] /**

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

*/ - readonly post: operations["PostCustomersCustomerBalanceTransactions"]; - }; - readonly "/v1/customers/{customer}/balance_transactions/{transaction}": { + readonly post: operations['PostCustomersCustomerBalanceTransactions'] + } + readonly '/v1/customers/{customer}/balance_transactions/{transaction}': { /**

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

*/ - readonly get: operations["GetCustomersCustomerBalanceTransactionsTransaction"]; + readonly get: operations['GetCustomersCustomerBalanceTransactionsTransaction'] /**

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

*/ - readonly post: operations["PostCustomersCustomerBalanceTransactionsTransaction"]; - }; - readonly "/v1/customers/{customer}/bank_accounts": { + readonly post: operations['PostCustomersCustomerBalanceTransactionsTransaction'] + } + readonly '/v1/customers/{customer}/bank_accounts': { /**

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.

*/ - readonly get: operations["GetCustomersCustomerBankAccounts"]; + readonly get: operations['GetCustomersCustomerBankAccounts'] /** *

When you create a new credit card, you must specify a customer or recipient on which to create it.

* @@ -527,27 +527,27 @@ export interface paths { * 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.

*/ - readonly post: operations["PostCustomersCustomerBankAccounts"]; - }; - readonly "/v1/customers/{customer}/bank_accounts/{id}": { + readonly post: operations['PostCustomersCustomerBankAccounts'] + } + readonly '/v1/customers/{customer}/bank_accounts/{id}': { /**

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.

*/ - readonly get: operations["GetCustomersCustomerBankAccountsId"]; + readonly get: operations['GetCustomersCustomerBankAccountsId'] /**

Update a specified source for a given customer.

*/ - readonly post: operations["PostCustomersCustomerBankAccountsId"]; + readonly post: operations['PostCustomersCustomerBankAccountsId'] /**

Delete a specified source for a given customer.

*/ - readonly delete: operations["DeleteCustomersCustomerBankAccountsId"]; - }; - readonly "/v1/customers/{customer}/bank_accounts/{id}/verify": { + readonly delete: operations['DeleteCustomersCustomerBankAccountsId'] + } + readonly '/v1/customers/{customer}/bank_accounts/{id}/verify': { /**

Verify a specified bank account for a given customer.

*/ - readonly post: operations["PostCustomersCustomerBankAccountsIdVerify"]; - }; - readonly "/v1/customers/{customer}/cards": { + readonly post: operations['PostCustomersCustomerBankAccountsIdVerify'] + } + readonly '/v1/customers/{customer}/cards': { /** *

You can see a list of the cards belonging to a customer. * Note that the 10 most recent sources are always available on the Customer 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 cards.

*/ - readonly get: operations["GetCustomersCustomerCards"]; + readonly get: operations['GetCustomersCustomerCards'] /** *

When you create a new credit card, you must specify a customer or recipient on which to create it.

* @@ -555,24 +555,24 @@ export interface paths { * 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.

*/ - readonly post: operations["PostCustomersCustomerCards"]; - }; - readonly "/v1/customers/{customer}/cards/{id}": { + readonly post: operations['PostCustomersCustomerCards'] + } + readonly '/v1/customers/{customer}/cards/{id}': { /**

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.

*/ - readonly get: operations["GetCustomersCustomerCardsId"]; + readonly get: operations['GetCustomersCustomerCardsId'] /**

Update a specified source for a given customer.

*/ - readonly post: operations["PostCustomersCustomerCardsId"]; + readonly post: operations['PostCustomersCustomerCardsId'] /**

Delete a specified source for a given customer.

*/ - readonly delete: operations["DeleteCustomersCustomerCardsId"]; - }; - readonly "/v1/customers/{customer}/discount": { - readonly get: operations["GetCustomersCustomerDiscount"]; + readonly delete: operations['DeleteCustomersCustomerCardsId'] + } + readonly '/v1/customers/{customer}/discount': { + readonly get: operations['GetCustomersCustomerDiscount'] /**

Removes the currently applied discount on a customer.

*/ - readonly delete: operations["DeleteCustomersCustomerDiscount"]; - }; - readonly "/v1/customers/{customer}/sources": { + readonly delete: operations['DeleteCustomersCustomerDiscount'] + } + readonly '/v1/customers/{customer}/sources': { /**

List sources for a specified customer.

*/ - readonly get: operations["GetCustomersCustomerSources"]; + readonly get: operations['GetCustomersCustomerSources'] /** *

When you create a new credit card, you must specify a customer or recipient on which to create it.

* @@ -580,31 +580,31 @@ export interface paths { * 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.

*/ - readonly post: operations["PostCustomersCustomerSources"]; - }; - readonly "/v1/customers/{customer}/sources/{id}": { + readonly post: operations['PostCustomersCustomerSources'] + } + readonly '/v1/customers/{customer}/sources/{id}': { /**

Retrieve a specified source for a given customer.

*/ - readonly get: operations["GetCustomersCustomerSourcesId"]; + readonly get: operations['GetCustomersCustomerSourcesId'] /**

Update a specified source for a given customer.

*/ - readonly post: operations["PostCustomersCustomerSourcesId"]; + readonly post: operations['PostCustomersCustomerSourcesId'] /**

Delete a specified source for a given customer.

*/ - readonly delete: operations["DeleteCustomersCustomerSourcesId"]; - }; - readonly "/v1/customers/{customer}/sources/{id}/verify": { + readonly delete: operations['DeleteCustomersCustomerSourcesId'] + } + readonly '/v1/customers/{customer}/sources/{id}/verify': { /**

Verify a specified bank account for a given customer.

*/ - readonly post: operations["PostCustomersCustomerSourcesIdVerify"]; - }; - readonly "/v1/customers/{customer}/subscriptions": { + readonly post: operations['PostCustomersCustomerSourcesIdVerify'] + } + readonly '/v1/customers/{customer}/subscriptions': { /**

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.

*/ - readonly get: operations["GetCustomersCustomerSubscriptions"]; + readonly get: operations['GetCustomersCustomerSubscriptions'] /**

Creates a new subscription on an existing customer.

*/ - readonly post: operations["PostCustomersCustomerSubscriptions"]; - }; - readonly "/v1/customers/{customer}/subscriptions/{subscription_exposed_id}": { + readonly post: operations['PostCustomersCustomerSubscriptions'] + } + readonly '/v1/customers/{customer}/subscriptions/{subscription_exposed_id}': { /**

Retrieves the subscription with the given ID.

*/ - readonly get: operations["GetCustomersCustomerSubscriptionsSubscriptionExposedId"]; + readonly get: operations['GetCustomersCustomerSubscriptionsSubscriptionExposedId'] /**

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.

*/ - readonly post: operations["PostCustomersCustomerSubscriptionsSubscriptionExposedId"]; + readonly post: operations['PostCustomersCustomerSubscriptionsSubscriptionExposedId'] /** *

Cancels a customer’s subscription. If you set the at_period_end parameter to true, the subscription will remain active until the end of the period, at which point it will be canceled and not renewed. Otherwise, with the default false value, the subscription is terminated immediately. In either case, the customer will not be charged again for the subscription.

* @@ -612,118 +612,118 @@ export interface paths { * *

By default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.

*/ - readonly delete: operations["DeleteCustomersCustomerSubscriptionsSubscriptionExposedId"]; - }; - readonly "/v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discount": { - readonly get: operations["GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount"]; + readonly delete: operations['DeleteCustomersCustomerSubscriptionsSubscriptionExposedId'] + } + readonly '/v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discount': { + readonly get: operations['GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount'] /**

Removes the currently applied discount on a customer.

*/ - readonly delete: operations["DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount"]; - }; - readonly "/v1/customers/{customer}/tax_ids": { + readonly delete: operations['DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount'] + } + readonly '/v1/customers/{customer}/tax_ids': { /**

Returns a list of tax IDs for a customer.

*/ - readonly get: operations["GetCustomersCustomerTaxIds"]; + readonly get: operations['GetCustomersCustomerTaxIds'] /**

Creates a new TaxID object for a customer.

*/ - readonly post: operations["PostCustomersCustomerTaxIds"]; - }; - readonly "/v1/customers/{customer}/tax_ids/{id}": { + readonly post: operations['PostCustomersCustomerTaxIds'] + } + readonly '/v1/customers/{customer}/tax_ids/{id}': { /**

Retrieves the TaxID object with the given identifier.

*/ - readonly get: operations["GetCustomersCustomerTaxIdsId"]; + readonly get: operations['GetCustomersCustomerTaxIdsId'] /**

Deletes an existing TaxID object.

*/ - readonly delete: operations["DeleteCustomersCustomerTaxIdsId"]; - }; - readonly "/v1/disputes": { + readonly delete: operations['DeleteCustomersCustomerTaxIdsId'] + } + readonly '/v1/disputes': { /**

Returns a list of your disputes.

*/ - readonly get: operations["GetDisputes"]; - }; - readonly "/v1/disputes/{dispute}": { + readonly get: operations['GetDisputes'] + } + readonly '/v1/disputes/{dispute}': { /**

Retrieves the dispute with the given ID.

*/ - readonly get: operations["GetDisputesDispute"]; + readonly get: operations['GetDisputesDispute'] /** *

When you get a dispute, contacting your customer is always the best first step. If that doesn’t work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your dashboard, but if you prefer, you can use the API to submit evidence programmatically.

* *

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.

*/ - readonly post: operations["PostDisputesDispute"]; - }; - readonly "/v1/disputes/{dispute}/close": { + readonly post: operations['PostDisputesDispute'] + } + readonly '/v1/disputes/{dispute}/close': { /** *

Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.

* *

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

*/ - readonly post: operations["PostDisputesDisputeClose"]; - }; - readonly "/v1/ephemeral_keys": { + readonly post: operations['PostDisputesDisputeClose'] + } + readonly '/v1/ephemeral_keys': { /**

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

*/ - readonly post: operations["PostEphemeralKeys"]; - }; - readonly "/v1/ephemeral_keys/{key}": { + readonly post: operations['PostEphemeralKeys'] + } + readonly '/v1/ephemeral_keys/{key}': { /**

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

*/ - readonly delete: operations["DeleteEphemeralKeysKey"]; - }; - readonly "/v1/events": { + readonly delete: operations['DeleteEphemeralKeysKey'] + } + readonly '/v1/events': { /**

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).

*/ - readonly get: operations["GetEvents"]; - }; - readonly "/v1/events/{id}": { + readonly get: operations['GetEvents'] + } + readonly '/v1/events/{id}': { /**

Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.

*/ - readonly get: operations["GetEventsId"]; - }; - readonly "/v1/exchange_rates": { + readonly get: operations['GetEventsId'] + } + readonly '/v1/exchange_rates': { /**

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.

*/ - readonly get: operations["GetExchangeRates"]; - }; - readonly "/v1/exchange_rates/{currency}": { + readonly get: operations['GetExchangeRates'] + } + readonly '/v1/exchange_rates/{currency}': { /**

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

*/ - readonly get: operations["GetExchangeRatesCurrency"]; - }; - readonly "/v1/file_links": { + readonly get: operations['GetExchangeRatesCurrency'] + } + readonly '/v1/file_links': { /**

Returns a list of file links.

*/ - readonly get: operations["GetFileLinks"]; + readonly get: operations['GetFileLinks'] /**

Creates a new file link object.

*/ - readonly post: operations["PostFileLinks"]; - }; - readonly "/v1/file_links/{link}": { + readonly post: operations['PostFileLinks'] + } + readonly '/v1/file_links/{link}': { /**

Retrieves the file link with the given ID.

*/ - readonly get: operations["GetFileLinksLink"]; + readonly get: operations['GetFileLinksLink'] /**

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

*/ - readonly post: operations["PostFileLinksLink"]; - }; - readonly "/v1/files": { + readonly post: operations['PostFileLinksLink'] + } + readonly '/v1/files': { /**

Returns a list of the files that your account has access to. The files are returned sorted by creation date, with the most recently created files appearing first.

*/ - readonly get: operations["GetFiles"]; + readonly get: operations['GetFiles'] /** *

To upload a file to Stripe, you’ll need to send a request of type multipart/form-data. The request should contain the file you would like to upload, as well as the parameters for creating a file.

* *

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

*/ - readonly post: operations["PostFiles"]; - }; - readonly "/v1/files/{file}": { + readonly post: operations['PostFiles'] + } + readonly '/v1/files/{file}': { /**

Retrieves the details of an existing file object. Supply the unique file ID from a file, and Stripe will return the corresponding file object. To access file contents, see the File Upload Guide.

*/ - readonly get: operations["GetFilesFile"]; - }; - readonly "/v1/invoiceitems": { + readonly get: operations['GetFilesFile'] + } + readonly '/v1/invoiceitems': { /**

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

*/ - readonly get: operations["GetInvoiceitems"]; + readonly get: operations['GetInvoiceitems'] /**

Creates an item to be added to a draft invoice. If no invoice is specified, the item will be on the next invoice created for the customer specified.

*/ - readonly post: operations["PostInvoiceitems"]; - }; - readonly "/v1/invoiceitems/{invoiceitem}": { + readonly post: operations['PostInvoiceitems'] + } + readonly '/v1/invoiceitems/{invoiceitem}': { /**

Retrieves the invoice item with the given ID.

*/ - readonly get: operations["GetInvoiceitemsInvoiceitem"]; + readonly get: operations['GetInvoiceitemsInvoiceitem'] /**

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.

*/ - readonly post: operations["PostInvoiceitemsInvoiceitem"]; + readonly post: operations['PostInvoiceitemsInvoiceitem'] /**

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.

*/ - readonly delete: operations["DeleteInvoiceitemsInvoiceitem"]; - }; - readonly "/v1/invoices": { + readonly delete: operations['DeleteInvoiceitemsInvoiceitem'] + } + readonly '/v1/invoices': { /**

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.

*/ - readonly get: operations["GetInvoices"]; + readonly get: operations['GetInvoices'] /**

This endpoint creates a draft invoice for a given customer. The draft invoice created pulls in all pending invoice items on that customer, including prorations.

*/ - readonly post: operations["PostInvoices"]; - }; - readonly "/v1/invoices/upcoming": { + readonly post: operations['PostInvoices'] + } + readonly '/v1/invoices/upcoming': { /** *

At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discount that is applicable to the customer.

* @@ -731,15 +731,15 @@ export interface paths { * *

You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass a proration_date parameter when doing the actual subscription update. The value passed in should be the same as the subscription_proration_date returned on the upcoming invoice resource. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_proration_date on the upcoming invoice resource.

*/ - readonly get: operations["GetInvoicesUpcoming"]; - }; - readonly "/v1/invoices/upcoming/lines": { + readonly get: operations['GetInvoicesUpcoming'] + } + readonly '/v1/invoices/upcoming/lines': { /**

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.

*/ - readonly get: operations["GetInvoicesUpcomingLines"]; - }; - readonly "/v1/invoices/{invoice}": { + readonly get: operations['GetInvoicesUpcomingLines'] + } + readonly '/v1/invoices/{invoice}': { /**

Retrieves the invoice with the given ID.

*/ - readonly get: operations["GetInvoicesInvoice"]; + readonly get: operations['GetInvoicesInvoice'] /** *

Draft invoices are fully editable. Once an invoice is finalized, * monetary values, as well as collection_method, become uneditable.

@@ -748,159 +748,159 @@ export interface paths { * sending reminders for, or automatically reconciling invoices, pass * auto_advance=false.

*/ - readonly post: operations["PostInvoicesInvoice"]; + readonly post: operations['PostInvoicesInvoice'] /**

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

*/ - readonly delete: operations["DeleteInvoicesInvoice"]; - }; - readonly "/v1/invoices/{invoice}/finalize": { + readonly delete: operations['DeleteInvoicesInvoice'] + } + readonly '/v1/invoices/{invoice}/finalize': { /**

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.

*/ - readonly post: operations["PostInvoicesInvoiceFinalize"]; - }; - readonly "/v1/invoices/{invoice}/lines": { + readonly post: operations['PostInvoicesInvoiceFinalize'] + } + readonly '/v1/invoices/{invoice}/lines': { /**

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.

*/ - readonly get: operations["GetInvoicesInvoiceLines"]; - }; - readonly "/v1/invoices/{invoice}/mark_uncollectible": { + readonly get: operations['GetInvoicesInvoiceLines'] + } + readonly '/v1/invoices/{invoice}/mark_uncollectible': { /**

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

*/ - readonly post: operations["PostInvoicesInvoiceMarkUncollectible"]; - }; - readonly "/v1/invoices/{invoice}/pay": { + readonly post: operations['PostInvoicesInvoiceMarkUncollectible'] + } + readonly '/v1/invoices/{invoice}/pay': { /**

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.

*/ - readonly post: operations["PostInvoicesInvoicePay"]; - }; - readonly "/v1/invoices/{invoice}/send": { + readonly post: operations['PostInvoicesInvoicePay'] + } + readonly '/v1/invoices/{invoice}/send': { /** *

Stripe will automatically send invoices to customers according to your subscriptions settings. However, if you’d like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.

* *

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

*/ - readonly post: operations["PostInvoicesInvoiceSend"]; - }; - readonly "/v1/invoices/{invoice}/void": { + readonly post: operations['PostInvoicesInvoiceSend'] + } + readonly '/v1/invoices/{invoice}/void': { /**

Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.

*/ - readonly post: operations["PostInvoicesInvoiceVoid"]; - }; - readonly "/v1/issuer_fraud_records": { + readonly post: operations['PostInvoicesInvoiceVoid'] + } + readonly '/v1/issuer_fraud_records': { /**

Returns a list of issuer fraud records.

*/ - readonly get: operations["GetIssuerFraudRecords"]; - }; - readonly "/v1/issuer_fraud_records/{issuer_fraud_record}": { + readonly get: operations['GetIssuerFraudRecords'] + } + readonly '/v1/issuer_fraud_records/{issuer_fraud_record}': { /** *

Retrieves the details of an issuer fraud record that has previously been created.

* *

Please refer to the issuer fraud record object reference for more details.

*/ - readonly get: operations["GetIssuerFraudRecordsIssuerFraudRecord"]; - }; - readonly "/v1/issuing/authorizations": { + readonly get: operations['GetIssuerFraudRecordsIssuerFraudRecord'] + } + readonly '/v1/issuing/authorizations': { /**

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.

*/ - readonly get: operations["GetIssuingAuthorizations"]; - }; - readonly "/v1/issuing/authorizations/{authorization}": { + readonly get: operations['GetIssuingAuthorizations'] + } + readonly '/v1/issuing/authorizations/{authorization}': { /**

Retrieves an Issuing Authorization object.

*/ - readonly get: operations["GetIssuingAuthorizationsAuthorization"]; + readonly get: operations['GetIssuingAuthorizationsAuthorization'] /**

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

*/ - readonly post: operations["PostIssuingAuthorizationsAuthorization"]; - }; - readonly "/v1/issuing/authorizations/{authorization}/approve": { + readonly post: operations['PostIssuingAuthorizationsAuthorization'] + } + readonly '/v1/issuing/authorizations/{authorization}/approve': { /**

Approves a pending Issuing Authorization object. This request should be made within the timeout window of the real-time authorization flow.

*/ - readonly post: operations["PostIssuingAuthorizationsAuthorizationApprove"]; - }; - readonly "/v1/issuing/authorizations/{authorization}/decline": { + readonly post: operations['PostIssuingAuthorizationsAuthorizationApprove'] + } + readonly '/v1/issuing/authorizations/{authorization}/decline': { /**

Declines a pending Issuing Authorization object. This request should be made within the timeout window of the real time authorization flow.

*/ - readonly post: operations["PostIssuingAuthorizationsAuthorizationDecline"]; - }; - readonly "/v1/issuing/cardholders": { + readonly post: operations['PostIssuingAuthorizationsAuthorizationDecline'] + } + readonly '/v1/issuing/cardholders': { /**

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

*/ - readonly get: operations["GetIssuingCardholders"]; + readonly get: operations['GetIssuingCardholders'] /**

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

*/ - readonly post: operations["PostIssuingCardholders"]; - }; - readonly "/v1/issuing/cardholders/{cardholder}": { + readonly post: operations['PostIssuingCardholders'] + } + readonly '/v1/issuing/cardholders/{cardholder}': { /**

Retrieves an Issuing Cardholder object.

*/ - readonly get: operations["GetIssuingCardholdersCardholder"]; + readonly get: operations['GetIssuingCardholdersCardholder'] /**

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

*/ - readonly post: operations["PostIssuingCardholdersCardholder"]; - }; - readonly "/v1/issuing/cards": { + readonly post: operations['PostIssuingCardholdersCardholder'] + } + readonly '/v1/issuing/cards': { /**

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

*/ - readonly get: operations["GetIssuingCards"]; + readonly get: operations['GetIssuingCards'] /**

Creates an Issuing Card object.

*/ - readonly post: operations["PostIssuingCards"]; - }; - readonly "/v1/issuing/cards/{card}": { + readonly post: operations['PostIssuingCards'] + } + readonly '/v1/issuing/cards/{card}': { /**

Retrieves an Issuing Card object.

*/ - readonly get: operations["GetIssuingCardsCard"]; + readonly get: operations['GetIssuingCardsCard'] /**

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

*/ - readonly post: operations["PostIssuingCardsCard"]; - }; - readonly "/v1/issuing/disputes": { + readonly post: operations['PostIssuingCardsCard'] + } + readonly '/v1/issuing/disputes': { /**

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

*/ - readonly get: operations["GetIssuingDisputes"]; + readonly get: operations['GetIssuingDisputes'] /**

Creates an Issuing Dispute object.

*/ - readonly post: operations["PostIssuingDisputes"]; - }; - readonly "/v1/issuing/disputes/{dispute}": { + readonly post: operations['PostIssuingDisputes'] + } + readonly '/v1/issuing/disputes/{dispute}': { /**

Retrieves an Issuing Dispute object.

*/ - readonly get: operations["GetIssuingDisputesDispute"]; + readonly get: operations['GetIssuingDisputesDispute'] /**

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

*/ - readonly post: operations["PostIssuingDisputesDispute"]; - }; - readonly "/v1/issuing/settlements": { + readonly post: operations['PostIssuingDisputesDispute'] + } + readonly '/v1/issuing/settlements': { /**

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

*/ - readonly get: operations["GetIssuingSettlements"]; - }; - readonly "/v1/issuing/settlements/{settlement}": { + readonly get: operations['GetIssuingSettlements'] + } + readonly '/v1/issuing/settlements/{settlement}': { /**

Retrieves an Issuing Settlement object.

*/ - readonly get: operations["GetIssuingSettlementsSettlement"]; + readonly get: operations['GetIssuingSettlementsSettlement'] /**

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

*/ - readonly post: operations["PostIssuingSettlementsSettlement"]; - }; - readonly "/v1/issuing/transactions": { + readonly post: operations['PostIssuingSettlementsSettlement'] + } + readonly '/v1/issuing/transactions': { /**

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.

*/ - readonly get: operations["GetIssuingTransactions"]; - }; - readonly "/v1/issuing/transactions/{transaction}": { + readonly get: operations['GetIssuingTransactions'] + } + readonly '/v1/issuing/transactions/{transaction}': { /**

Retrieves an Issuing Transaction object.

*/ - readonly get: operations["GetIssuingTransactionsTransaction"]; + readonly get: operations['GetIssuingTransactionsTransaction'] /**

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

*/ - readonly post: operations["PostIssuingTransactionsTransaction"]; - }; - readonly "/v1/mandates/{mandate}": { + readonly post: operations['PostIssuingTransactionsTransaction'] + } + readonly '/v1/mandates/{mandate}': { /**

Retrieves a Mandate object.

*/ - readonly get: operations["GetMandatesMandate"]; - }; - readonly "/v1/order_returns": { + readonly get: operations['GetMandatesMandate'] + } + readonly '/v1/order_returns': { /**

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

*/ - readonly get: operations["GetOrderReturns"]; - }; - readonly "/v1/order_returns/{id}": { + readonly get: operations['GetOrderReturns'] + } + readonly '/v1/order_returns/{id}': { /**

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

*/ - readonly get: operations["GetOrderReturnsId"]; - }; - readonly "/v1/orders": { + readonly get: operations['GetOrderReturnsId'] + } + readonly '/v1/orders': { /**

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

*/ - readonly get: operations["GetOrders"]; + readonly get: operations['GetOrders'] /**

Creates a new order object.

*/ - readonly post: operations["PostOrders"]; - }; - readonly "/v1/orders/{id}": { + readonly post: operations['PostOrders'] + } + readonly '/v1/orders/{id}': { /**

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

*/ - readonly get: operations["GetOrdersId"]; + readonly get: operations['GetOrdersId'] /**

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

*/ - readonly post: operations["PostOrdersId"]; - }; - readonly "/v1/orders/{id}/pay": { + readonly post: operations['PostOrdersId'] + } + readonly '/v1/orders/{id}/pay': { /**

Pay an order by providing a source to create a payment.

*/ - readonly post: operations["PostOrdersIdPay"]; - }; - readonly "/v1/orders/{id}/returns": { + readonly post: operations['PostOrdersIdPay'] + } + readonly '/v1/orders/{id}/returns': { /**

Return all or part of an order. The order must have a status of paid or fulfilled before it can be returned. Once all items have been returned, the order will become canceled or returned depending on which status the order started in.

*/ - readonly post: operations["PostOrdersIdReturns"]; - }; - readonly "/v1/payment_intents": { + readonly post: operations['PostOrdersIdReturns'] + } + readonly '/v1/payment_intents': { /**

Returns a list of PaymentIntents.

*/ - readonly get: operations["GetPaymentIntents"]; + readonly get: operations['GetPaymentIntents'] /** *

Creates a PaymentIntent object.

* @@ -913,9 +913,9 @@ export interface paths { * available in the confirm API when confirm=true * is supplied.

*/ - readonly post: operations["PostPaymentIntents"]; - }; - readonly "/v1/payment_intents/{intent}": { + readonly post: operations['PostPaymentIntents'] + } + readonly '/v1/payment_intents/{intent}': { /** *

Retrieves the details of a PaymentIntent that has previously been created.

* @@ -923,7 +923,7 @@ export interface paths { * *

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

*/ - readonly get: operations["GetPaymentIntentsIntent"]; + readonly get: operations['GetPaymentIntentsIntent'] /** *

Updates properties on a PaymentIntent object without confirming.

* @@ -933,17 +933,17 @@ export interface paths { * update and confirm at the same time, we recommend updating properties via * the confirm API instead.

*/ - readonly post: operations["PostPaymentIntentsIntent"]; - }; - readonly "/v1/payment_intents/{intent}/cancel": { + readonly post: operations['PostPaymentIntentsIntent'] + } + readonly '/v1/payment_intents/{intent}/cancel': { /** *

A PaymentIntent object can be canceled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action.

* *

Once canceled, no additional charges will be made by the PaymentIntent and any operations on the PaymentIntent will fail with an error. For PaymentIntents with status='requires_capture', the remaining amount_capturable will automatically be refunded.

*/ - readonly post: operations["PostPaymentIntentsIntentCancel"]; - }; - readonly "/v1/payment_intents/{intent}/capture": { + readonly post: operations['PostPaymentIntentsIntentCancel'] + } + readonly '/v1/payment_intents/{intent}/capture': { /** *

Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.

* @@ -951,9 +951,9 @@ export interface paths { * *

Learn more about separate authorization and capture.

*/ - readonly post: operations["PostPaymentIntentsIntentCapture"]; - }; - readonly "/v1/payment_intents/{intent}/confirm": { + readonly post: operations['PostPaymentIntentsIntentCapture'] + } + readonly '/v1/payment_intents/{intent}/confirm': { /** *

Confirm that your customer intends to pay with current or provided * payment method. Upon confirmation, the PaymentIntent will attempt to initiate @@ -981,21 +981,21 @@ export interface paths { * attempt. Read the expanded documentation * to learn more about manual confirmation.

*/ - readonly post: operations["PostPaymentIntentsIntentConfirm"]; - }; - readonly "/v1/payment_methods": { + readonly post: operations['PostPaymentIntentsIntentConfirm'] + } + readonly '/v1/payment_methods': { /**

Returns a list of PaymentMethods for a given Customer

*/ - readonly get: operations["GetPaymentMethods"]; + readonly get: operations['GetPaymentMethods'] /**

Creates a PaymentMethod object. Read the Stripe.js reference to learn how to create PaymentMethods via Stripe.js.

*/ - readonly post: operations["PostPaymentMethods"]; - }; - readonly "/v1/payment_methods/{payment_method}": { + readonly post: operations['PostPaymentMethods'] + } + readonly '/v1/payment_methods/{payment_method}': { /**

Retrieves a PaymentMethod object.

*/ - readonly get: operations["GetPaymentMethodsPaymentMethod"]; + readonly get: operations['GetPaymentMethodsPaymentMethod'] /**

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

*/ - readonly post: operations["PostPaymentMethodsPaymentMethod"]; - }; - readonly "/v1/payment_methods/{payment_method}/attach": { + readonly post: operations['PostPaymentMethodsPaymentMethod'] + } + readonly '/v1/payment_methods/{payment_method}/attach': { /** *

Attaches a PaymentMethod object to a Customer.

* @@ -1009,15 +1009,15 @@ export interface paths { * set invoice_settings.default_payment_method, * on the Customer to the PaymentMethod’s ID.

*/ - readonly post: operations["PostPaymentMethodsPaymentMethodAttach"]; - }; - readonly "/v1/payment_methods/{payment_method}/detach": { + readonly post: operations['PostPaymentMethodsPaymentMethodAttach'] + } + readonly '/v1/payment_methods/{payment_method}/detach': { /**

Detaches a PaymentMethod object from a Customer.

*/ - readonly post: operations["PostPaymentMethodsPaymentMethodDetach"]; - }; - readonly "/v1/payouts": { + readonly post: operations['PostPaymentMethodsPaymentMethodDetach'] + } + readonly '/v1/payouts': { /**

Returns a list of existing payouts sent to third-party bank accounts or that Stripe has sent you. The payouts are returned in sorted order, with the most recently created payouts appearing first.

*/ - readonly get: operations["GetPayouts"]; + readonly get: operations['GetPayouts'] /** *

To send funds to your own bank account, you create a new payout object. Your Stripe balance must be able to cover the payout amount, or you’ll receive an “Insufficient Funds” error.

* @@ -1025,96 +1025,96 @@ export interface paths { * *

If you are creating a manual payout on a Stripe account that uses multiple payment source types, you’ll need to specify the source type balance that the payout should draw from. The balance object details available and pending amounts by source type.

*/ - readonly post: operations["PostPayouts"]; - }; - readonly "/v1/payouts/{payout}": { + readonly post: operations['PostPayouts'] + } + readonly '/v1/payouts/{payout}': { /**

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

*/ - readonly get: operations["GetPayoutsPayout"]; + readonly get: operations['GetPayoutsPayout'] /**

Updates the specified payout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request accepts only the metadata as arguments.

*/ - readonly post: operations["PostPayoutsPayout"]; - }; - readonly "/v1/payouts/{payout}/cancel": { + readonly post: operations['PostPayoutsPayout'] + } + readonly '/v1/payouts/{payout}/cancel': { /**

A previously created payout can be canceled if it has not yet been paid out. Funds will be refunded to your available balance. You may not cancel automatic Stripe payouts.

*/ - readonly post: operations["PostPayoutsPayoutCancel"]; - }; - readonly "/v1/plans": { + readonly post: operations['PostPayoutsPayoutCancel'] + } + readonly '/v1/plans': { /**

Returns a list of your plans.

*/ - readonly get: operations["GetPlans"]; + readonly get: operations['GetPlans'] /**

You can create plans using the API, or in the Stripe Dashboard.

*/ - readonly post: operations["PostPlans"]; - }; - readonly "/v1/plans/{plan}": { + readonly post: operations['PostPlans'] + } + readonly '/v1/plans/{plan}': { /**

Retrieves the plan with the given ID.

*/ - readonly get: operations["GetPlansPlan"]; + readonly get: operations['GetPlansPlan'] /**

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.

*/ - readonly post: operations["PostPlansPlan"]; + readonly post: operations['PostPlansPlan'] /**

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

*/ - readonly delete: operations["DeletePlansPlan"]; - }; - readonly "/v1/products": { + readonly delete: operations['DeletePlansPlan'] + } + readonly '/v1/products': { /**

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

*/ - readonly get: operations["GetProducts"]; + readonly get: operations['GetProducts'] /**

Creates a new product object.

*/ - readonly post: operations["PostProducts"]; - }; - readonly "/v1/products/{id}": { + readonly post: operations['PostProducts'] + } + readonly '/v1/products/{id}': { /**

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.

*/ - readonly get: operations["GetProductsId"]; + readonly get: operations['GetProductsId'] /**

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

*/ - readonly post: operations["PostProductsId"]; + readonly post: operations['PostProductsId'] /**

Delete a product. Deleting a product with type=good is only possible if it has no SKUs associated with it. Deleting a product with type=service is only possible if it has no plans associated with it.

*/ - readonly delete: operations["DeleteProductsId"]; - }; - readonly "/v1/radar/early_fraud_warnings": { + readonly delete: operations['DeleteProductsId'] + } + readonly '/v1/radar/early_fraud_warnings': { /**

Returns a list of early fraud warnings.

*/ - readonly get: operations["GetRadarEarlyFraudWarnings"]; - }; - readonly "/v1/radar/early_fraud_warnings/{early_fraud_warning}": { + readonly get: operations['GetRadarEarlyFraudWarnings'] + } + readonly '/v1/radar/early_fraud_warnings/{early_fraud_warning}': { /** *

Retrieves the details of an early fraud warning that has previously been created.

* *

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

*/ - readonly get: operations["GetRadarEarlyFraudWarningsEarlyFraudWarning"]; - }; - readonly "/v1/radar/value_list_items": { + readonly get: operations['GetRadarEarlyFraudWarningsEarlyFraudWarning'] + } + readonly '/v1/radar/value_list_items': { /**

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

*/ - readonly get: operations["GetRadarValueListItems"]; + readonly get: operations['GetRadarValueListItems'] /**

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

*/ - readonly post: operations["PostRadarValueListItems"]; - }; - readonly "/v1/radar/value_list_items/{item}": { + readonly post: operations['PostRadarValueListItems'] + } + readonly '/v1/radar/value_list_items/{item}': { /**

Retrieves a ValueListItem object.

*/ - readonly get: operations["GetRadarValueListItemsItem"]; + readonly get: operations['GetRadarValueListItemsItem'] /**

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

*/ - readonly delete: operations["DeleteRadarValueListItemsItem"]; - }; - readonly "/v1/radar/value_lists": { + readonly delete: operations['DeleteRadarValueListItemsItem'] + } + readonly '/v1/radar/value_lists': { /**

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

*/ - readonly get: operations["GetRadarValueLists"]; + readonly get: operations['GetRadarValueLists'] /**

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

*/ - readonly post: operations["PostRadarValueLists"]; - }; - readonly "/v1/radar/value_lists/{value_list}": { + readonly post: operations['PostRadarValueLists'] + } + readonly '/v1/radar/value_lists/{value_list}': { /**

Retrieves a ValueList object.

*/ - readonly get: operations["GetRadarValueListsValueList"]; + readonly get: operations['GetRadarValueListsValueList'] /**

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.

*/ - readonly post: operations["PostRadarValueListsValueList"]; + readonly post: operations['PostRadarValueListsValueList'] /**

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.

*/ - readonly delete: operations["DeleteRadarValueListsValueList"]; - }; - readonly "/v1/recipients": { + readonly delete: operations['DeleteRadarValueListsValueList'] + } + readonly '/v1/recipients': { /**

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

*/ - readonly get: operations["GetRecipients"]; + readonly get: operations['GetRecipients'] /** *

Creates a new Recipient object and verifies the recipient’s identity. * Also verifies the recipient’s bank account information or debit card, if either is provided.

*/ - readonly post: operations["PostRecipients"]; - }; - readonly "/v1/recipients/{id}": { + readonly post: operations['PostRecipients'] + } + readonly '/v1/recipients/{id}': { /**

Retrieves the details of an existing recipient. You need only supply the unique recipient identifier that was returned upon recipient creation.

*/ - readonly get: operations["GetRecipientsId"]; + readonly get: operations['GetRecipientsId'] /** *

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

@@ -1122,68 +1122,68 @@ export interface paths { *

If you update the name or tax ID, the identity verification will automatically be rerun. * If you update the bank account, the bank account validation will automatically be rerun.

*/ - readonly post: operations["PostRecipientsId"]; + readonly post: operations['PostRecipientsId'] /**

Permanently deletes a recipient. It cannot be undone.

*/ - readonly delete: operations["DeleteRecipientsId"]; - }; - readonly "/v1/refunds": { + readonly delete: operations['DeleteRecipientsId'] + } + readonly '/v1/refunds': { /**

Returns a list of all refunds you’ve previously created. The refunds are returned in sorted order, with the most recent refunds appearing first. For convenience, the 10 most recent refunds are always available by default on the charge object.

*/ - readonly get: operations["GetRefunds"]; + readonly get: operations['GetRefunds'] /**

Create a refund.

*/ - readonly post: operations["PostRefunds"]; - }; - readonly "/v1/refunds/{refund}": { + readonly post: operations['PostRefunds'] + } + readonly '/v1/refunds/{refund}': { /**

Retrieves the details of an existing refund.

*/ - readonly get: operations["GetRefundsRefund"]; + readonly get: operations['GetRefundsRefund'] /** *

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

* *

This request only accepts metadata as an argument.

*/ - readonly post: operations["PostRefundsRefund"]; - }; - readonly "/v1/reporting/report_runs": { + readonly post: operations['PostRefundsRefund'] + } + readonly '/v1/reporting/report_runs': { /**

Returns a list of Report Runs, with the most recent appearing first. (Requires a live-mode API key.)

*/ - readonly get: operations["GetReportingReportRuns"]; + readonly get: operations['GetReportingReportRuns'] /**

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

*/ - readonly post: operations["PostReportingReportRuns"]; - }; - readonly "/v1/reporting/report_runs/{report_run}": { + readonly post: operations['PostReportingReportRuns'] + } + readonly '/v1/reporting/report_runs/{report_run}': { /**

Retrieves the details of an existing Report Run. (Requires a live-mode API key.)

*/ - readonly get: operations["GetReportingReportRunsReportRun"]; - }; - readonly "/v1/reporting/report_types": { + readonly get: operations['GetReportingReportRunsReportRun'] + } + readonly '/v1/reporting/report_types': { /**

Returns a full list of Report Types. (Requires a live-mode API key.)

*/ - readonly get: operations["GetReportingReportTypes"]; - }; - readonly "/v1/reporting/report_types/{report_type}": { + readonly get: operations['GetReportingReportTypes'] + } + readonly '/v1/reporting/report_types/{report_type}': { /**

Retrieves the details of a Report Type. (Requires a live-mode API key.)

*/ - readonly get: operations["GetReportingReportTypesReportType"]; - }; - readonly "/v1/reviews": { + readonly get: operations['GetReportingReportTypesReportType'] + } + readonly '/v1/reviews': { /**

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.

*/ - readonly get: operations["GetReviews"]; - }; - readonly "/v1/reviews/{review}": { + readonly get: operations['GetReviews'] + } + readonly '/v1/reviews/{review}': { /**

Retrieves a Review object.

*/ - readonly get: operations["GetReviewsReview"]; - }; - readonly "/v1/reviews/{review}/approve": { + readonly get: operations['GetReviewsReview'] + } + readonly '/v1/reviews/{review}/approve': { /**

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

*/ - readonly post: operations["PostReviewsReviewApprove"]; - }; - readonly "/v1/setup_intents": { + readonly post: operations['PostReviewsReviewApprove'] + } + readonly '/v1/setup_intents': { /**

Returns a list of SetupIntents.

*/ - readonly get: operations["GetSetupIntents"]; + readonly get: operations['GetSetupIntents'] /** *

Creates a SetupIntent object.

* *

After the SetupIntent is created, attach a payment method and confirm * to collect any required permissions to charge the payment method later.

*/ - readonly post: operations["PostSetupIntents"]; - }; - readonly "/v1/setup_intents/{intent}": { + readonly post: operations['PostSetupIntents'] + } + readonly '/v1/setup_intents/{intent}': { /** *

Retrieves the details of a SetupIntent that has previously been created.

* @@ -1191,19 +1191,19 @@ export interface paths { * *

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

*/ - readonly get: operations["GetSetupIntentsIntent"]; + readonly get: operations['GetSetupIntentsIntent'] /**

Updates a SetupIntent object.

*/ - readonly post: operations["PostSetupIntentsIntent"]; - }; - readonly "/v1/setup_intents/{intent}/cancel": { + readonly post: operations['PostSetupIntentsIntent'] + } + readonly '/v1/setup_intents/{intent}/cancel': { /** *

A SetupIntent object can be canceled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action.

* *

Once canceled, setup is abandoned and any operations on the SetupIntent will fail with an error.

*/ - readonly post: operations["PostSetupIntentsIntentCancel"]; - }; - readonly "/v1/setup_intents/{intent}/confirm": { + readonly post: operations['PostSetupIntentsIntentCancel'] + } + readonly '/v1/setup_intents/{intent}/confirm': { /** *

Confirm that your customer intends to set up the current or * provided payment method. For example, you would confirm a SetupIntent @@ -1219,87 +1219,87 @@ export interface paths { * the SetupIntent will transition to the * requires_payment_method status.

*/ - readonly post: operations["PostSetupIntentsIntentConfirm"]; - }; - readonly "/v1/sigma/scheduled_query_runs": { + readonly post: operations['PostSetupIntentsIntentConfirm'] + } + readonly '/v1/sigma/scheduled_query_runs': { /**

Returns a list of scheduled query runs.

*/ - readonly get: operations["GetSigmaScheduledQueryRuns"]; - }; - readonly "/v1/sigma/scheduled_query_runs/{scheduled_query_run}": { + readonly get: operations['GetSigmaScheduledQueryRuns'] + } + readonly '/v1/sigma/scheduled_query_runs/{scheduled_query_run}': { /**

Retrieves the details of an scheduled query run.

*/ - readonly get: operations["GetSigmaScheduledQueryRunsScheduledQueryRun"]; - }; - readonly "/v1/skus": { + readonly get: operations['GetSigmaScheduledQueryRunsScheduledQueryRun'] + } + readonly '/v1/skus': { /**

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

*/ - readonly get: operations["GetSkus"]; + readonly get: operations['GetSkus'] /**

Creates a new SKU associated with a product.

*/ - readonly post: operations["PostSkus"]; - }; - readonly "/v1/skus/{id}": { + readonly post: operations['PostSkus'] + } + readonly '/v1/skus/{id}': { /**

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

*/ - readonly get: operations["GetSkusId"]; + readonly get: operations['GetSkusId'] /** *

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

* *

Note that a SKU’s attributes are not editable. Instead, you would need to deactivate the existing SKU and create a new one with the new attribute values.

*/ - readonly post: operations["PostSkusId"]; + readonly post: operations['PostSkusId'] /**

Delete a SKU. Deleting a SKU is only possible until it has been used in an order.

*/ - readonly delete: operations["DeleteSkusId"]; - }; - readonly "/v1/sources": { + readonly delete: operations['DeleteSkusId'] + } + readonly '/v1/sources': { /**

Creates a new source object.

*/ - readonly post: operations["PostSources"]; - }; - readonly "/v1/sources/{source}": { + readonly post: operations['PostSources'] + } + readonly '/v1/sources/{source}': { /**

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.

*/ - readonly get: operations["GetSourcesSource"]; + readonly get: operations['GetSourcesSource'] /** *

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

* *

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.

*/ - readonly post: operations["PostSourcesSource"]; - }; - readonly "/v1/sources/{source}/mandate_notifications/{mandate_notification}": { + readonly post: operations['PostSourcesSource'] + } + readonly '/v1/sources/{source}/mandate_notifications/{mandate_notification}': { /**

Retrieves a new Source MandateNotification.

*/ - readonly get: operations["GetSourcesSourceMandateNotificationsMandateNotification"]; - }; - readonly "/v1/sources/{source}/source_transactions": { + readonly get: operations['GetSourcesSourceMandateNotificationsMandateNotification'] + } + readonly '/v1/sources/{source}/source_transactions': { /**

List source transactions for a given source.

*/ - readonly get: operations["GetSourcesSourceSourceTransactions"]; - }; - readonly "/v1/sources/{source}/source_transactions/{source_transaction}": { + readonly get: operations['GetSourcesSourceSourceTransactions'] + } + readonly '/v1/sources/{source}/source_transactions/{source_transaction}': { /**

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.

*/ - readonly get: operations["GetSourcesSourceSourceTransactionsSourceTransaction"]; - }; - readonly "/v1/sources/{source}/verify": { + readonly get: operations['GetSourcesSourceSourceTransactionsSourceTransaction'] + } + readonly '/v1/sources/{source}/verify': { /**

Verify a given source.

*/ - readonly post: operations["PostSourcesSourceVerify"]; - }; - readonly "/v1/subscription_items": { + readonly post: operations['PostSourcesSourceVerify'] + } + readonly '/v1/subscription_items': { /**

Returns a list of your subscription items for a given subscription.

*/ - readonly get: operations["GetSubscriptionItems"]; + readonly get: operations['GetSubscriptionItems'] /**

Adds a new item to an existing subscription. No existing items will be changed or replaced.

*/ - readonly post: operations["PostSubscriptionItems"]; - }; - readonly "/v1/subscription_items/{item}": { + readonly post: operations['PostSubscriptionItems'] + } + readonly '/v1/subscription_items/{item}': { /**

Retrieves the invoice item with the given ID.

*/ - readonly get: operations["GetSubscriptionItemsItem"]; + readonly get: operations['GetSubscriptionItemsItem'] /**

Updates the plan or quantity of an item on a current subscription.

*/ - readonly post: operations["PostSubscriptionItemsItem"]; + readonly post: operations['PostSubscriptionItemsItem'] /**

Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.

*/ - readonly delete: operations["DeleteSubscriptionItemsItem"]; - }; - readonly "/v1/subscription_items/{subscription_item}/usage_record_summaries": { + readonly delete: operations['DeleteSubscriptionItemsItem'] + } + readonly '/v1/subscription_items/{subscription_item}/usage_record_summaries': { /** *

For the specified subscription item, returns a list of summary objects. Each object in the list provides usage information that’s been summarized from multiple usage records and over a subscription billing period (e.g., 15 usage records in the billing plan’s month of September).

* *

The list is sorted in reverse-chronological order (newest first). The first list item represents the most current usage period that hasn’t ended yet. Since new usage records can still be added, the returned summary information for the subscription item’s ID should be seen as unstable until the subscription billing period ends.

*/ - readonly get: operations["GetSubscriptionItemsSubscriptionItemUsageRecordSummaries"]; - }; - readonly "/v1/subscription_items/{subscription_item}/usage_records": { + readonly get: operations['GetSubscriptionItemsSubscriptionItemUsageRecordSummaries'] + } + readonly '/v1/subscription_items/{subscription_item}/usage_records': { /** *

Creates a usage record for a specified subscription item and date, and fills it with a quantity.

* @@ -1309,39 +1309,39 @@ export interface paths { * *

The default pricing model for metered billing is per-unit pricing. For finer granularity, you can configure metered billing to have a tiered pricing model.

*/ - readonly post: operations["PostSubscriptionItemsSubscriptionItemUsageRecords"]; - }; - readonly "/v1/subscription_schedules": { + readonly post: operations['PostSubscriptionItemsSubscriptionItemUsageRecords'] + } + readonly '/v1/subscription_schedules': { /**

Retrieves the list of your subscription schedules.

*/ - readonly get: operations["GetSubscriptionSchedules"]; + readonly get: operations['GetSubscriptionSchedules'] /**

Creates a new subscription schedule object. Each customer can have up to 25 active or scheduled subscriptions.

*/ - readonly post: operations["PostSubscriptionSchedules"]; - }; - readonly "/v1/subscription_schedules/{schedule}": { + readonly post: operations['PostSubscriptionSchedules'] + } + readonly '/v1/subscription_schedules/{schedule}': { /**

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.

*/ - readonly get: operations["GetSubscriptionSchedulesSchedule"]; + readonly get: operations['GetSubscriptionSchedulesSchedule'] /**

Updates an existing subscription schedule.

*/ - readonly post: operations["PostSubscriptionSchedulesSchedule"]; - }; - readonly "/v1/subscription_schedules/{schedule}/cancel": { + readonly post: operations['PostSubscriptionSchedulesSchedule'] + } + readonly '/v1/subscription_schedules/{schedule}/cancel': { /**

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.

*/ - readonly post: operations["PostSubscriptionSchedulesScheduleCancel"]; - }; - readonly "/v1/subscription_schedules/{schedule}/release": { + readonly post: operations['PostSubscriptionSchedulesScheduleCancel'] + } + readonly '/v1/subscription_schedules/{schedule}/release': { /**

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.

*/ - readonly post: operations["PostSubscriptionSchedulesScheduleRelease"]; - }; - readonly "/v1/subscriptions": { + readonly post: operations['PostSubscriptionSchedulesScheduleRelease'] + } + readonly '/v1/subscriptions': { /**

By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.

*/ - readonly get: operations["GetSubscriptions"]; + readonly get: operations['GetSubscriptions'] /**

Creates a new subscription on an existing customer. Each customer can have up to 25 active or scheduled subscriptions.

*/ - readonly post: operations["PostSubscriptions"]; - }; - readonly "/v1/subscriptions/{subscription_exposed_id}": { + readonly post: operations['PostSubscriptions'] + } + readonly '/v1/subscriptions/{subscription_exposed_id}': { /**

Retrieves the subscription with the given ID.

*/ - readonly get: operations["GetSubscriptionsSubscriptionExposedId"]; + readonly get: operations['GetSubscriptionsSubscriptionExposedId'] /**

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.

*/ - readonly post: operations["PostSubscriptionsSubscriptionExposedId"]; + readonly post: operations['PostSubscriptionsSubscriptionExposedId'] /** *

Cancels a customer’s subscription immediately. The customer will not be charged again for the subscription.

* @@ -1349,92 +1349,92 @@ export interface paths { * *

By default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.

*/ - readonly delete: operations["DeleteSubscriptionsSubscriptionExposedId"]; - }; - readonly "/v1/subscriptions/{subscription_exposed_id}/discount": { + readonly delete: operations['DeleteSubscriptionsSubscriptionExposedId'] + } + readonly '/v1/subscriptions/{subscription_exposed_id}/discount': { /**

Removes the currently applied discount on a subscription.

*/ - readonly delete: operations["DeleteSubscriptionsSubscriptionExposedIdDiscount"]; - }; - readonly "/v1/tax_rates": { + readonly delete: operations['DeleteSubscriptionsSubscriptionExposedIdDiscount'] + } + readonly '/v1/tax_rates': { /**

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

*/ - readonly get: operations["GetTaxRates"]; + readonly get: operations['GetTaxRates'] /**

Creates a new tax rate.

*/ - readonly post: operations["PostTaxRates"]; - }; - readonly "/v1/tax_rates/{tax_rate}": { + readonly post: operations['PostTaxRates'] + } + readonly '/v1/tax_rates/{tax_rate}': { /**

Retrieves a tax rate with the given ID

*/ - readonly get: operations["GetTaxRatesTaxRate"]; + readonly get: operations['GetTaxRatesTaxRate'] /**

Updates an existing tax rate.

*/ - readonly post: operations["PostTaxRatesTaxRate"]; - }; - readonly "/v1/terminal/connection_tokens": { + readonly post: operations['PostTaxRatesTaxRate'] + } + readonly '/v1/terminal/connection_tokens': { /**

To connect to a reader the Stripe Terminal SDK needs to retrieve a short-lived connection token from Stripe, proxied through your server. On your backend, add an endpoint that creates and returns a connection token.

*/ - readonly post: operations["PostTerminalConnectionTokens"]; - }; - readonly "/v1/terminal/locations": { + readonly post: operations['PostTerminalConnectionTokens'] + } + readonly '/v1/terminal/locations': { /**

Returns a list of Location objects.

*/ - readonly get: operations["GetTerminalLocations"]; + readonly get: operations['GetTerminalLocations'] /**

Creates a new Location object.

*/ - readonly post: operations["PostTerminalLocations"]; - }; - readonly "/v1/terminal/locations/{location}": { + readonly post: operations['PostTerminalLocations'] + } + readonly '/v1/terminal/locations/{location}': { /**

Retrieves a Location object.

*/ - readonly get: operations["GetTerminalLocationsLocation"]; + readonly get: operations['GetTerminalLocationsLocation'] /**

Updates a Location object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ - readonly post: operations["PostTerminalLocationsLocation"]; + readonly post: operations['PostTerminalLocationsLocation'] /**

Deletes a Location object.

*/ - readonly delete: operations["DeleteTerminalLocationsLocation"]; - }; - readonly "/v1/terminal/readers": { + readonly delete: operations['DeleteTerminalLocationsLocation'] + } + readonly '/v1/terminal/readers': { /**

Returns a list of Reader objects.

*/ - readonly get: operations["GetTerminalReaders"]; + readonly get: operations['GetTerminalReaders'] /**

Creates a new Reader object.

*/ - readonly post: operations["PostTerminalReaders"]; - }; - readonly "/v1/terminal/readers/{reader}": { + readonly post: operations['PostTerminalReaders'] + } + readonly '/v1/terminal/readers/{reader}': { /**

Retrieves a Reader object.

*/ - readonly get: operations["GetTerminalReadersReader"]; + readonly get: operations['GetTerminalReadersReader'] /**

Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ - readonly post: operations["PostTerminalReadersReader"]; + readonly post: operations['PostTerminalReadersReader'] /**

Deletes a Reader object.

*/ - readonly delete: operations["DeleteTerminalReadersReader"]; - }; - readonly "/v1/tokens": { + readonly delete: operations['DeleteTerminalReadersReader'] + } + readonly '/v1/tokens': { /** *

Creates a single-use token that represents a bank account’s details. * This token can be used with any API method in place of a bank account dictionary. This token can be used only once, by attaching it to a Custom account.

*/ - readonly post: operations["PostTokens"]; - }; - readonly "/v1/tokens/{token}": { + readonly post: operations['PostTokens'] + } + readonly '/v1/tokens/{token}': { /**

Retrieves the token with the given ID.

*/ - readonly get: operations["GetTokensToken"]; - }; - readonly "/v1/topups": { + readonly get: operations['GetTokensToken'] + } + readonly '/v1/topups': { /**

Returns a list of top-ups.

*/ - readonly get: operations["GetTopups"]; + readonly get: operations['GetTopups'] /**

Top up the balance of an account

*/ - readonly post: operations["PostTopups"]; - }; - readonly "/v1/topups/{topup}": { + readonly post: operations['PostTopups'] + } + readonly '/v1/topups/{topup}': { /**

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.

*/ - readonly get: operations["GetTopupsTopup"]; + readonly get: operations['GetTopupsTopup'] /**

Updates the metadata of a top-up. Other top-up details are not editable by design.

*/ - readonly post: operations["PostTopupsTopup"]; - }; - readonly "/v1/topups/{topup}/cancel": { + readonly post: operations['PostTopupsTopup'] + } + readonly '/v1/topups/{topup}/cancel': { /**

Cancels a top-up. Only pending top-ups can be canceled.

*/ - readonly post: operations["PostTopupsTopupCancel"]; - }; - readonly "/v1/transfers": { + readonly post: operations['PostTopupsTopupCancel'] + } + readonly '/v1/transfers': { /**

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.

*/ - readonly get: operations["GetTransfers"]; + readonly get: operations['GetTransfers'] /**

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.

*/ - readonly post: operations["PostTransfers"]; - }; - readonly "/v1/transfers/{id}/reversals": { + readonly post: operations['PostTransfers'] + } + readonly '/v1/transfers/{id}/reversals': { /**

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.

*/ - readonly get: operations["GetTransfersIdReversals"]; + readonly get: operations['GetTransfersIdReversals'] /** *

When you create a new reversal, you must specify a transfer to create it on.

* @@ -1442,42 +1442,42 @@ export interface paths { * *

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.

*/ - readonly post: operations["PostTransfersIdReversals"]; - }; - readonly "/v1/transfers/{transfer}": { + readonly post: operations['PostTransfersIdReversals'] + } + readonly '/v1/transfers/{transfer}': { /**

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.

*/ - readonly get: operations["GetTransfersTransfer"]; + readonly get: operations['GetTransfersTransfer'] /** *

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

* *

This request accepts only metadata as an argument.

*/ - readonly post: operations["PostTransfersTransfer"]; - }; - readonly "/v1/transfers/{transfer}/reversals/{id}": { + readonly post: operations['PostTransfersTransfer'] + } + readonly '/v1/transfers/{transfer}/reversals/{id}': { /**

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.

*/ - readonly get: operations["GetTransfersTransferReversalsId"]; + readonly get: operations['GetTransfersTransferReversalsId'] /** *

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

* *

This request only accepts metadata and description as arguments.

*/ - readonly post: operations["PostTransfersTransferReversalsId"]; - }; - readonly "/v1/webhook_endpoints": { + readonly post: operations['PostTransfersTransferReversalsId'] + } + readonly '/v1/webhook_endpoints': { /**

Returns a list of your webhook endpoints.

*/ - readonly get: operations["GetWebhookEndpoints"]; + readonly get: operations['GetWebhookEndpoints'] /**

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.

*/ - readonly post: operations["PostWebhookEndpoints"]; - }; - readonly "/v1/webhook_endpoints/{webhook_endpoint}": { + readonly post: operations['PostWebhookEndpoints'] + } + readonly '/v1/webhook_endpoints/{webhook_endpoint}': { /**

Retrieves the webhook endpoint with the given ID.

*/ - readonly get: operations["GetWebhookEndpointsWebhookEndpoint"]; + readonly get: operations['GetWebhookEndpointsWebhookEndpoint'] /**

Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.

*/ - readonly post: operations["PostWebhookEndpointsWebhookEndpoint"]; + readonly post: operations['PostWebhookEndpointsWebhookEndpoint'] /**

You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.

*/ - readonly delete: operations["DeleteWebhookEndpointsWebhookEndpoint"]; - }; + readonly delete: operations['DeleteWebhookEndpointsWebhookEndpoint'] + } } export interface definitions { @@ -1491,173 +1491,173 @@ export interface definitions { * [create and manage Express or Custom accounts](https://stripe.com/docs/connect/accounts). */ readonly account: { - readonly business_profile?: definitions["account_business_profile"]; + readonly business_profile?: definitions['account_business_profile'] /** * @description The business type. * @enum {string} */ - readonly business_type?: "company" | "government_entity" | "individual" | "non_profit"; - readonly capabilities?: definitions["account_capabilities"]; + readonly business_type?: 'company' | 'government_entity' | 'individual' | 'non_profit' + readonly capabilities?: definitions['account_capabilities'] /** @description Whether the account can create live charges. */ - readonly charges_enabled?: boolean; - readonly company?: definitions["legal_entity_company"]; + readonly charges_enabled?: boolean + readonly company?: definitions['legal_entity_company'] /** @description The account's country. */ - readonly country?: string; + readonly country?: string /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created?: number; + readonly created?: number /** @description 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). */ - readonly default_currency?: string; + readonly default_currency?: string /** @description Whether account details have been submitted. Standard accounts cannot receive payouts before this is true. */ - readonly details_submitted?: boolean; + readonly details_submitted?: boolean /** @description The primary user's email address. */ - readonly email?: string; + readonly email?: string /** * ExternalAccountList * @description External accounts (bank accounts and debit cards) currently attached to this account */ readonly external_accounts?: { /** @description The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards. */ - readonly data: readonly definitions["bank_account"][]; + readonly data: readonly definitions['bank_account'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; + readonly url: string + } /** @description Unique identifier for the object. */ - readonly id: string; - readonly individual?: definitions["person"]; + readonly id: string + readonly individual?: definitions['person'] /** @description 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. */ - readonly metadata?: { readonly [key: string]: unknown }; + readonly metadata?: { readonly [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "account"; + readonly object: 'account' /** @description Whether Stripe can send payouts to this account. */ - readonly payouts_enabled?: boolean; - readonly requirements?: definitions["account_requirements"]; - readonly settings?: definitions["account_settings"]; - readonly tos_acceptance?: definitions["account_tos_acceptance"]; + readonly payouts_enabled?: boolean + readonly requirements?: definitions['account_requirements'] + readonly settings?: definitions['account_settings'] + readonly tos_acceptance?: definitions['account_tos_acceptance'] /** * @description The Stripe account type. Can be `standard`, `express`, or `custom`. * @enum {string} */ - readonly type?: "custom" | "express" | "standard"; - }; + readonly type?: 'custom' | 'express' | 'standard' + } /** AccountBrandingSettings */ readonly account_branding_settings: { /** @description (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. */ - readonly icon?: string; + readonly icon?: string /** @description (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. */ - readonly logo?: string; + readonly logo?: string /** @description A CSS hex color value representing the primary branding color for this account */ - readonly primary_color?: string; + readonly primary_color?: string /** @description A CSS hex color value representing the secondary branding color for this account */ - readonly secondary_color?: string; - }; + readonly secondary_color?: string + } /** AccountBusinessProfile */ readonly account_business_profile: { /** @description [The merchant category code for the account](https://stripe.com/docs/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide. */ - readonly mcc?: string; + readonly mcc?: string /** @description The customer-facing business name. */ - readonly name?: string; + readonly name?: string /** @description Internal-only description of the product sold or service provided by the business. It's used by Stripe for risk and underwriting purposes. */ - readonly product_description?: string; - readonly support_address?: definitions["address"]; + readonly product_description?: string + readonly support_address?: definitions['address'] /** @description A publicly available email address for sending support issues to. */ - readonly support_email?: string; + readonly support_email?: string /** @description A publicly available phone number to call with support issues. */ - readonly support_phone?: string; + readonly support_phone?: string /** @description A publicly available website for handling support issues. */ - readonly support_url?: string; + readonly support_url?: string /** @description The business's publicly available website. */ - readonly url?: string; - }; + readonly url?: string + } /** AccountCapabilities */ readonly account_capabilities: { /** * @description 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. * @enum {string} */ - readonly au_becs_debit_payments?: "active" | "inactive" | "pending"; + readonly au_becs_debit_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the card issuing capability of the account, or whether you can use Issuing to distribute funds on cards * @enum {string} */ - readonly card_issuing?: "active" | "inactive" | "pending"; + readonly card_issuing?: 'active' | 'inactive' | 'pending' /** * @description The status of the card payments capability of the account, or whether the account can directly process credit and debit card charges. * @enum {string} */ - readonly card_payments?: "active" | "inactive" | "pending"; + readonly card_payments?: 'active' | 'inactive' | 'pending' /** * @description 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. * @enum {string} */ - readonly jcb_payments?: "active" | "inactive" | "pending"; + readonly jcb_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the legacy payments capability of the account. * @enum {string} */ - readonly legacy_payments?: "active" | "inactive" | "pending"; + readonly legacy_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the tax reporting 1099-K (US) capability of the account. * @enum {string} */ - readonly tax_reporting_us_1099_k?: "active" | "inactive" | "pending"; + readonly tax_reporting_us_1099_k?: 'active' | 'inactive' | 'pending' /** * @description The status of the tax reporting 1099-MISC (US) capability of the account. * @enum {string} */ - readonly tax_reporting_us_1099_misc?: "active" | "inactive" | "pending"; + readonly tax_reporting_us_1099_misc?: 'active' | 'inactive' | 'pending' /** * @description The status of the transfers capability of the account, or whether your platform can transfer funds to the account. * @enum {string} */ - readonly transfers?: "active" | "inactive" | "pending"; - }; + readonly transfers?: 'active' | 'inactive' | 'pending' + } /** AccountCapabilityRequirements */ readonly account_capability_requirements: { /** @description The date the fields in `currently_due` must be collected by to keep the capability enabled for the account. */ - readonly current_deadline?: number; + readonly current_deadline?: number /** @description The fields that need to be collected to keep the capability enabled. If not collected by the `current_deadline`, these fields appear in `past_due` as well, and the capability is disabled. */ - readonly currently_due: readonly string[]; + readonly currently_due: readonly string[] /** @description If the capability is disabled, this string describes why. Possible values are `requirement.fields_needed`, `pending.onboarding`, `pending.review`, `rejected_fraud`, or `rejected.other`. */ - readonly disabled_reason?: string; + readonly disabled_reason?: string /** @description The fields that need to be collected again because validation or verification failed for some reason. */ - readonly errors: readonly definitions["account_requirements_error"][]; + readonly errors: readonly definitions['account_requirements_error'][] /** @description The fields that need to be collected assuming all volume thresholds are reached. As they become required, these fields appear in `currently_due` as well, and the `current_deadline` is set. */ - readonly eventually_due: readonly string[]; + readonly eventually_due: readonly string[] /** @description The fields that weren't collected by the `current_deadline`. These fields need to be collected to enable the capability for the account. */ - readonly past_due: readonly string[]; + readonly past_due: readonly string[] /** @description Fields that may become required depending on the results of verification or review. An empty array unless an asynchronous verification is pending. If verification fails, the fields in this array become required and move to `currently_due` or `past_due`. */ - readonly pending_verification: readonly string[]; - }; + readonly pending_verification: readonly string[] + } /** AccountCardPaymentsSettings */ readonly account_card_payments_settings: { - readonly decline_on?: definitions["account_decline_charge_on"]; + readonly decline_on?: definitions['account_decline_charge_on'] /** @description 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. */ - readonly statement_descriptor_prefix?: string; - }; + readonly statement_descriptor_prefix?: string + } /** AccountDashboardSettings */ readonly account_dashboard_settings: { /** @description The display name for this account. This is used on the Stripe Dashboard to differentiate between accounts. */ - readonly display_name?: string; + readonly display_name?: string /** @description 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). */ - readonly timezone?: string; - }; + readonly timezone?: string + } /** AccountDeclineChargeOn */ readonly account_decline_charge_on: { /** @description 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. */ - readonly avs_failure: boolean; + readonly avs_failure: boolean /** @description Whether Stripe automatically declines charges with an incorrect CVC. This setting only applies when a CVC is provided and it fails bank verification. */ - readonly cvc_failure: boolean; - }; + readonly cvc_failure: boolean + } /** * AccountLink * @description Account Links are the means by which a Connect platform grants a connected account permission to access @@ -1667,51 +1667,51 @@ export interface definitions { */ readonly account_link: { /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description The timestamp at which this account link will expire. */ - readonly expires_at: number; + readonly expires_at: number /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "account_link"; + readonly object: 'account_link' /** @description The URL for the account link. */ - readonly url: string; - }; + readonly url: string + } /** AccountPaymentsSettings */ readonly account_payments_settings: { /** @description 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. */ - readonly statement_descriptor?: string; + readonly statement_descriptor?: string /** @description The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only) */ - readonly statement_descriptor_kana?: string; + readonly statement_descriptor_kana?: string /** @description The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only) */ - readonly statement_descriptor_kanji?: string; - }; + readonly statement_descriptor_kanji?: string + } /** AccountPayoutSettings */ readonly account_payout_settings: { /** @description A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See our [Understanding Connect Account Balances](https://stripe.com/docs/connect/account-balances) documentation for details. Default value is `true` for Express accounts and `false` for Custom accounts. */ - readonly debit_negative_balances: boolean; - readonly schedule: definitions["transfer_schedule"]; + readonly debit_negative_balances: boolean + readonly schedule: definitions['transfer_schedule'] /** @description 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. */ - readonly statement_descriptor?: string; - }; + readonly statement_descriptor?: string + } /** AccountRequirements */ readonly account_requirements: { /** @description The date the fields in `currently_due` must be collected by to keep payouts enabled for the account. These fields might block payouts sooner if the next threshold is reached before these fields are collected. */ - readonly current_deadline?: number; + readonly current_deadline?: number /** @description The fields that need to be collected to keep the account enabled. If not collected by the `current_deadline`, these fields appear in `past_due` as well, and the account is disabled. */ - readonly currently_due?: readonly string[]; + readonly currently_due?: readonly string[] /** @description If the account is disabled, this string describes why the account can’t create charges or receive payouts. Can be `requirements.past_due`, `requirements.pending_verification`, `rejected.fraud`, `rejected.terms_of_service`, `rejected.listed`, `rejected.other`, `listed`, `under_review`, or `other`. */ - readonly disabled_reason?: string; + readonly disabled_reason?: string /** @description The fields that need to be collected again because validation or verification failed for some reason. */ - readonly errors?: readonly definitions["account_requirements_error"][]; + readonly errors?: readonly definitions['account_requirements_error'][] /** @description The fields that need to be collected assuming all volume thresholds are reached. As they become required, these fields appear in `currently_due` as well, and the `current_deadline` is set. */ - readonly eventually_due?: readonly string[]; + readonly eventually_due?: readonly string[] /** @description The fields that weren't collected by the `current_deadline`. These fields need to be collected to re-enable the account. */ - readonly past_due?: readonly string[]; + readonly past_due?: readonly string[] /** @description Fields that may become required depending on the results of verification or review. An empty array unless an asynchronous verification is pending. If verification fails, the fields in this array become required and move to `currently_due` or `past_due`. */ - readonly pending_verification?: readonly string[]; - }; + readonly pending_verification?: readonly string[] + } /** AccountRequirementsError */ readonly account_requirements_error: { /** @@ -1719,218 +1719,218 @@ export interface definitions { * @enum {string} */ readonly code: - | "invalid_address_city_state_postal_code" - | "invalid_street_address" - | "invalid_value_other" - | "verification_document_address_mismatch" - | "verification_document_address_missing" - | "verification_document_corrupt" - | "verification_document_country_not_supported" - | "verification_document_dob_mismatch" - | "verification_document_duplicate_type" - | "verification_document_expired" - | "verification_document_failed_copy" - | "verification_document_failed_greyscale" - | "verification_document_failed_other" - | "verification_document_failed_test_mode" - | "verification_document_fraudulent" - | "verification_document_id_number_mismatch" - | "verification_document_id_number_missing" - | "verification_document_incomplete" - | "verification_document_invalid" - | "verification_document_manipulated" - | "verification_document_missing_back" - | "verification_document_missing_front" - | "verification_document_name_mismatch" - | "verification_document_name_missing" - | "verification_document_nationality_mismatch" - | "verification_document_not_readable" - | "verification_document_not_uploaded" - | "verification_document_photo_mismatch" - | "verification_document_too_large" - | "verification_document_type_not_supported" - | "verification_failed_address_match" - | "verification_failed_business_iec_number" - | "verification_failed_document_match" - | "verification_failed_id_number_match" - | "verification_failed_keyed_identity" - | "verification_failed_keyed_match" - | "verification_failed_name_match" - | "verification_failed_other"; + | 'invalid_address_city_state_postal_code' + | 'invalid_street_address' + | 'invalid_value_other' + | 'verification_document_address_mismatch' + | 'verification_document_address_missing' + | 'verification_document_corrupt' + | 'verification_document_country_not_supported' + | 'verification_document_dob_mismatch' + | 'verification_document_duplicate_type' + | 'verification_document_expired' + | 'verification_document_failed_copy' + | 'verification_document_failed_greyscale' + | 'verification_document_failed_other' + | 'verification_document_failed_test_mode' + | 'verification_document_fraudulent' + | 'verification_document_id_number_mismatch' + | 'verification_document_id_number_missing' + | 'verification_document_incomplete' + | 'verification_document_invalid' + | 'verification_document_manipulated' + | 'verification_document_missing_back' + | 'verification_document_missing_front' + | 'verification_document_name_mismatch' + | 'verification_document_name_missing' + | 'verification_document_nationality_mismatch' + | 'verification_document_not_readable' + | 'verification_document_not_uploaded' + | 'verification_document_photo_mismatch' + | 'verification_document_too_large' + | 'verification_document_type_not_supported' + | 'verification_failed_address_match' + | 'verification_failed_business_iec_number' + | 'verification_failed_document_match' + | 'verification_failed_id_number_match' + | 'verification_failed_keyed_identity' + | 'verification_failed_keyed_match' + | 'verification_failed_name_match' + | 'verification_failed_other' /** @description An informative message that indicates the error type and provides additional details about the error. */ - readonly reason: string; + readonly reason: string /** @description The specific user onboarding requirement field (in the requirements hash) that needs to be resolved. */ - readonly requirement: string; - }; + readonly requirement: string + } /** AccountSettings */ readonly account_settings: { - readonly branding: definitions["account_branding_settings"]; - readonly card_payments: definitions["account_card_payments_settings"]; - readonly dashboard: definitions["account_dashboard_settings"]; - readonly payments: definitions["account_payments_settings"]; - readonly payouts?: definitions["account_payout_settings"]; - }; + readonly branding: definitions['account_branding_settings'] + readonly card_payments: definitions['account_card_payments_settings'] + readonly dashboard: definitions['account_dashboard_settings'] + readonly payments: definitions['account_payments_settings'] + readonly payouts?: definitions['account_payout_settings'] + } /** AccountTOSAcceptance */ readonly account_tos_acceptance: { /** @description The Unix timestamp marking when the Stripe Services Agreement was accepted by the account representative */ - readonly date?: number; + readonly date?: number /** @description The IP address from which the Stripe Services Agreement was accepted by the account representative */ - readonly ip?: string; + readonly ip?: string /** @description The user agent of the browser from which the Stripe Services Agreement was accepted by the account representative */ - readonly user_agent?: string; - }; + readonly user_agent?: string + } /** Address */ readonly address: { /** @description City, district, suburb, town, or village. */ - readonly city?: string; + readonly city?: string /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ - readonly country?: string; + readonly country?: string /** @description Address line 1 (e.g., street, PO Box, or company name). */ - readonly line1?: string; + readonly line1?: string /** @description Address line 2 (e.g., apartment, suite, unit, or building). */ - readonly line2?: string; + readonly line2?: string /** @description ZIP or postal code. */ - readonly postal_code?: string; + readonly postal_code?: string /** @description State, county, province, or region. */ - readonly state?: string; - }; + readonly state?: string + } /** AlipayAccount */ readonly alipay_account: { /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description The ID of the customer associated with this Alipay Account. */ - readonly customer?: string; + readonly customer?: string /** @description Uniquely identifies the account and will be the same across all Alipay account objects that are linked to the same Alipay account. */ - readonly fingerprint: string; + readonly fingerprint: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata?: { readonly [key: string]: unknown }; + readonly metadata?: { readonly [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "alipay_account"; + readonly object: 'alipay_account' /** @description If the Alipay account object is not reusable, the exact amount that you can create a charge for. */ - readonly payment_amount?: number; + readonly payment_amount?: number /** @description If the Alipay account object is not reusable, the exact currency that you can create a charge for. */ - readonly payment_currency?: string; + readonly payment_currency?: string /** @description True if you can create multiple payments using this account. If the account is reusable, then you can freely choose the amount of each payment. */ - readonly reusable: boolean; + readonly reusable: boolean /** @description Whether this Alipay account object has ever been used for a payment. */ - readonly used: boolean; + readonly used: boolean /** @description The username for the Alipay account. */ - readonly username: string; - }; + readonly username: string + } /** APIErrors */ readonly api_errors: { /** @description For card errors, the ID of the failed charge. */ - readonly charge?: string; + readonly charge?: string /** @description For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported. */ - readonly code?: string; + readonly code?: string /** @description 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. */ - readonly decline_code?: string; + readonly decline_code?: string /** @description A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported. */ - readonly doc_url?: string; + readonly doc_url?: string /** @description A human-readable message providing more details about the error. For card errors, these messages can be shown to your users. */ - readonly message?: string; + readonly message?: string /** @description 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. */ - readonly param?: string; - readonly payment_intent?: definitions["payment_intent"]; - readonly payment_method?: definitions["payment_method"]; - readonly setup_intent?: definitions["setup_intent"]; - readonly source?: definitions["bank_account"]; + readonly param?: string + readonly payment_intent?: definitions['payment_intent'] + readonly payment_method?: definitions['payment_method'] + readonly setup_intent?: definitions['setup_intent'] + readonly source?: definitions['bank_account'] /** * @description The type of error returned. One of `api_connection_error`, `api_error`, `authentication_error`, `card_error`, `idempotency_error`, `invalid_request_error`, or `rate_limit_error` * @enum {string} */ readonly type: - | "api_connection_error" - | "api_error" - | "authentication_error" - | "card_error" - | "idempotency_error" - | "invalid_request_error" - | "rate_limit_error"; - }; + | 'api_connection_error' + | 'api_error' + | 'authentication_error' + | 'card_error' + | 'idempotency_error' + | 'invalid_request_error' + | 'rate_limit_error' + } /** ApplePayDomain */ readonly apple_pay_domain: { /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; - readonly domain_name: string; + readonly created: number + readonly domain_name: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "apple_pay_domain"; - }; + readonly object: 'apple_pay_domain' + } /** Application */ readonly application: { /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description The name of the application. */ - readonly name?: string; + readonly name?: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "application"; - }; + readonly object: 'application' + } /** PlatformFee */ readonly application_fee: { /** @description ID of the Stripe account this fee was taken from. */ - readonly account: string; + readonly account: string /** @description Amount earned, in %s. */ - readonly amount: number; + readonly amount: number /** @description Amount in %s refunded (can be less than the amount attribute on the fee if a partial refund was issued) */ - readonly amount_refunded: number; + readonly amount_refunded: number /** @description ID of the Connect application that earned the fee. */ - readonly application: string; + readonly application: string /** @description Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds). */ - readonly balance_transaction?: string; + readonly balance_transaction?: string /** @description ID of the charge that the application fee was taken from. */ - readonly charge: string; + readonly charge: string /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "application_fee"; + readonly object: 'application_fee' /** @description ID of the corresponding charge on the platform account, if this fee was the result of a charge using the `destination` parameter. */ - readonly originating_transaction?: string; + readonly originating_transaction?: string /** @description Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false. */ - readonly refunded: boolean; + readonly refunded: boolean /** * FeeRefundList * @description A list of refunds that have been applied to the fee. */ readonly refunds: { /** @description Details about each object. */ - readonly data: readonly definitions["fee_refund"][]; + readonly data: readonly definitions['fee_refund'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** * Balance * @description This is an object representing your Stripe balance. You can retrieve it to see @@ -1947,36 +1947,36 @@ export interface definitions { */ readonly balance: { /** @description Funds that are available to be transferred or paid out, whether automatically by Stripe or explicitly via the [Transfers API](https://stripe.com/docs/api#transfers) or [Payouts API](https://stripe.com/docs/api#payouts). The available balance for each currency and payment type can be found in the `source_types` property. */ - readonly available: readonly definitions["balance_amount"][]; + readonly available: readonly definitions['balance_amount'][] /** @description Funds held due to negative balances on connected Custom accounts. The connect reserve balance for each currency and payment type can be found in the `source_types` property. */ - readonly connect_reserved?: readonly definitions["balance_amount"][]; + readonly connect_reserved?: readonly definitions['balance_amount'][] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "balance"; + readonly object: 'balance' /** @description Funds that are not yet available in the balance, due to the 7-day rolling pay cycle. The pending balance for each currency, and for each payment type, can be found in the `source_types` property. */ - readonly pending: readonly definitions["balance_amount"][]; - }; + readonly pending: readonly definitions['balance_amount'][] + } /** BalanceAmount */ readonly balance_amount: { /** @description Balance amount. */ - readonly amount: number; + readonly amount: number /** @description 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). */ - readonly currency: string; - readonly source_types?: definitions["balance_amount_by_source_type"]; - }; + readonly currency: string + readonly source_types?: definitions['balance_amount_by_source_type'] + } /** BalanceAmountBySourceType */ readonly balance_amount_by_source_type: { /** @description Amount for bank account. */ - readonly bank_account?: number; + readonly bank_account?: number /** @description Amount for card. */ - readonly card?: number; + readonly card?: number /** @description Amount for FPX. */ - readonly fpx?: number; - }; + readonly fpx?: number + } /** * BalanceTransaction * @description Balance transactions represent funds moving through your Stripe account. @@ -1986,71 +1986,71 @@ export interface definitions { */ readonly balance_transaction: { /** @description Gross amount of the transaction, in %s. */ - readonly amount: number; + readonly amount: number /** @description The date the transaction's net funds will become available in the Stripe balance. */ - readonly available_on: number; + readonly available_on: number /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string; + readonly description?: string /** @description The exchange rate used, if applicable, for this transaction. Specifically, if money was converted from currency A to currency B, then the `amount` in currency A, times `exchange_rate`, would be the `amount` in currency B. For example, suppose you charged a customer 10.00 EUR. Then the PaymentIntent's `amount` would be `1000` and `currency` would be `eur`. Suppose this was converted into 12.34 USD in your Stripe account. Then the BalanceTransaction's `amount` would be `1234`, `currency` would be `usd`, and `exchange_rate` would be `1.234`. */ - readonly exchange_rate?: number; + readonly exchange_rate?: number /** @description Fees (in %s) paid for this transaction. */ - readonly fee: number; + readonly fee: number /** @description Detailed breakdown of fees (in %s) paid for this transaction. */ - readonly fee_details: readonly definitions["fee"][]; + readonly fee_details: readonly definitions['fee'][] /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Net amount of the transaction, in %s. */ - readonly net: number; + readonly net: number /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "balance_transaction"; + readonly object: 'balance_transaction' /** @description [Learn more](https://stripe.com/docs/reports/reporting-categories) about how reporting categories can help you understand balance transactions from an accounting perspective. */ - readonly reporting_category: string; + readonly reporting_category: string /** @description The Stripe object to which this transaction is related. */ - readonly source?: string; + readonly source?: string /** @description If the transaction's net funds are available in the Stripe balance yet. Either `available` or `pending`. */ - readonly status: string; + readonly status: string /** * @description Transaction type: `adjustment`, `advance`, `advance_funding`, `application_fee`, `application_fee_refund`, `charge`, `connect_collection_transfer`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_transaction`, `payment`, `payment_failure_refund`, `payment_refund`, `payout`, `payout_cancel`, `payout_failure`, `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](https://stripe.com/docs/reports/balance-transaction-types) about balance transaction types and what they represent. If you are looking to classify transactions for accounting purposes, you might want to consider `reporting_category` instead. * @enum {string} */ readonly type: - | "adjustment" - | "advance" - | "advance_funding" - | "application_fee" - | "application_fee_refund" - | "charge" - | "connect_collection_transfer" - | "issuing_authorization_hold" - | "issuing_authorization_release" - | "issuing_transaction" - | "payment" - | "payment_failure_refund" - | "payment_refund" - | "payout" - | "payout_cancel" - | "payout_failure" - | "refund" - | "refund_failure" - | "reserve_transaction" - | "reserved_funds" - | "stripe_fee" - | "stripe_fx_fee" - | "tax_fee" - | "topup" - | "topup_reversal" - | "transfer" - | "transfer_cancel" - | "transfer_failure" - | "transfer_refund"; - }; + | 'adjustment' + | 'advance' + | 'advance_funding' + | 'application_fee' + | 'application_fee_refund' + | 'charge' + | 'connect_collection_transfer' + | 'issuing_authorization_hold' + | 'issuing_authorization_release' + | 'issuing_transaction' + | 'payment' + | 'payment_failure_refund' + | 'payment_refund' + | 'payout' + | 'payout_cancel' + | 'payout_failure' + | 'refund' + | 'refund_failure' + | 'reserve_transaction' + | 'reserved_funds' + | 'stripe_fee' + | 'stripe_fx_fee' + | 'tax_fee' + | 'topup' + | 'topup_reversal' + | 'transfer' + | 'transfer_cancel' + | 'transfer_failure' + | 'transfer_refund' + } /** * BankAccount * @description These bank accounts are payment methods on `Customer` objects. @@ -2063,53 +2063,53 @@ export interface definitions { */ readonly bank_account: { /** @description The ID of the account that the bank account is associated with. */ - readonly account?: string; + readonly account?: string /** @description The name of the person or business that owns the bank account. */ - readonly account_holder_name?: string; + readonly account_holder_name?: string /** @description The type of entity that holds the account. This can be either `individual` or `company`. */ - readonly account_holder_type?: string; + readonly account_holder_type?: string /** @description Name of the bank associated with the routing number (e.g., `WELLS FARGO`). */ - readonly bank_name?: string; + readonly bank_name?: string /** @description Two-letter ISO code representing the country the bank account is located in. */ - readonly country: string; + readonly country: string /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. */ - readonly currency: string; + readonly currency: string /** @description The ID of the customer that the bank account is associated with. */ - readonly customer?: string; + readonly customer?: string /** @description Whether this bank account is the default external account for its currency. */ - readonly default_for_currency?: boolean; + readonly default_for_currency?: boolean /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - readonly fingerprint?: string; + readonly fingerprint?: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description The last four digits of the bank account number. */ - readonly last4: string; + readonly last4: string /** @description 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. */ - readonly metadata?: { readonly [key: string]: unknown }; + readonly metadata?: { readonly [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "bank_account"; + readonly object: 'bank_account' /** @description The routing transit number for the bank account. */ - readonly routing_number?: string; + readonly routing_number?: string /** * @description For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a transfer sent to this bank account fails, we'll set the status to `errored` and will not continue to send transfers until the bank details are updated. * * For external accounts, possible values are `new` and `errored`. Validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply. If a transfer fails, the status is set to `errored` and transfers are stopped until account details are updated. */ - readonly status: string; - }; + readonly status: string + } /** billing_details */ readonly billing_details: { - readonly address?: definitions["address"]; + readonly address?: definitions['address'] /** @description Email address. */ - readonly email?: string; + readonly email?: string /** @description Full name. */ - readonly name?: string; + readonly name?: string /** @description Billing phone number (including extension). */ - readonly phone?: string; - }; + readonly phone?: string + } /** * PortalSession * @description A Session describes the instantiation of the self-serve portal for @@ -2120,110 +2120,110 @@ export interface definitions { * * Related guide: [self-serve Portal](https://stripe.com/docs/billing/subscriptions/integrating-self-serve). */ - readonly "billing_portal.session": { + readonly 'billing_portal.session': { /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description The ID of the customer for this session. */ - readonly customer: string; + readonly customer: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "billing_portal.session"; + readonly object: 'billing_portal.session' /** @description The URL to which Stripe should send customers when they click on the link to return to your website. */ - readonly return_url: string; + readonly return_url: string /** @description The short-lived URL of the session giving customers access to the self-serve portal. */ - readonly url: string; - }; + readonly url: string + } /** BitcoinReceiver */ readonly bitcoin_receiver: { /** @description True when this bitcoin receiver has received a non-zero amount of bitcoin. */ - readonly active: boolean; + readonly active: boolean /** @description The amount of `currency` that you are collecting as payment. */ - readonly amount: number; + readonly amount: number /** @description The amount of `currency` to which `bitcoin_amount_received` has been converted. */ - readonly amount_received: number; + readonly amount_received: number /** @description The amount of bitcoin that the customer should send to fill the receiver. The `bitcoin_amount` is denominated in Satoshi: there are 10^8 Satoshi in one bitcoin. */ - readonly bitcoin_amount: number; + readonly bitcoin_amount: number /** @description The amount of bitcoin that has been sent by the customer to this receiver. */ - readonly bitcoin_amount_received: number; + readonly bitcoin_amount_received: number /** @description This URI can be displayed to the customer as a clickable link (to activate their bitcoin client) or as a QR code (for mobile wallets). */ - readonly bitcoin_uri: string; + readonly bitcoin_uri: string /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) to which the bitcoin will be converted. */ - readonly currency: string; + readonly currency: string /** @description The customer ID of the bitcoin receiver. */ - readonly customer?: string; + readonly customer?: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string; + readonly description?: string /** @description The customer's email address, set by the API call that creates the receiver. */ - readonly email?: string; + readonly email?: string /** @description This flag is initially false and updates to true when the customer sends the `bitcoin_amount` to this receiver. */ - readonly filled: boolean; + readonly filled: boolean /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description A bitcoin address that is specific to this receiver. The customer can send bitcoin to this address to fill the receiver. */ - readonly inbound_address: string; + readonly inbound_address: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata: { readonly [key: string]: unknown }; + readonly metadata: { readonly [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "bitcoin_receiver"; + readonly object: 'bitcoin_receiver' /** @description The ID of the payment created from the receiver, if any. Hidden when viewing the receiver with a publishable key. */ - readonly payment?: string; + readonly payment?: string /** @description The refund address of this bitcoin receiver. */ - readonly refund_address?: string; + readonly refund_address?: string /** * BitcoinTransactionList * @description A list with one entry for each time that the customer sent bitcoin to the receiver. Hidden when viewing the receiver with a publishable key. */ readonly transactions?: { /** @description Details about each object. */ - readonly data: readonly definitions["bitcoin_transaction"][]; + readonly data: readonly definitions['bitcoin_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; + readonly url: string + } /** @description This receiver contains uncaptured funds that can be used for a payment or refunded. */ - readonly uncaptured_funds: boolean; + readonly uncaptured_funds: boolean /** @description Indicate if this source is used for payment. */ - readonly used_for_payment?: boolean; - }; + readonly used_for_payment?: boolean + } /** BitcoinTransaction */ readonly bitcoin_transaction: { /** @description The amount of `currency` that the transaction was converted to in real-time. */ - readonly amount: number; + readonly amount: number /** @description The amount of bitcoin contained in the transaction. */ - readonly bitcoin_amount: number; + readonly bitcoin_amount: number /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) to which this transaction was converted. */ - readonly currency: string; + readonly currency: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "bitcoin_transaction"; + readonly object: 'bitcoin_transaction' /** @description The receiver to which this transaction was sent. */ - readonly receiver: string; - }; + readonly receiver: string + } /** * AccountCapability * @description This is an object representing a capability for a Stripe account. @@ -2232,25 +2232,25 @@ export interface definitions { */ readonly capability: { /** @description The account for which the capability enables functionality. */ - readonly account: string; + readonly account: string /** @description The identifier for the capability. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "capability"; + readonly object: 'capability' /** @description Whether the capability has been requested. */ - readonly requested: boolean; + readonly requested: boolean /** @description Time at which the capability was requested. Measured in seconds since the Unix epoch. */ - readonly requested_at?: number; - readonly requirements?: definitions["account_capability_requirements"]; + readonly requested_at?: number + readonly requirements?: definitions['account_capability_requirements'] /** * @description The status of the capability. Can be `active`, `inactive`, `pending`, or `unrequested`. * @enum {string} */ - readonly status: "active" | "disabled" | "inactive" | "pending" | "unrequested"; - }; + readonly status: 'active' | 'disabled' | 'inactive' | 'pending' | 'unrequested' + } /** * Card * @description You can store multiple cards on a customer in order to charge the customer @@ -2261,66 +2261,66 @@ export interface definitions { */ readonly card: { /** @description 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. */ - readonly account?: string; + readonly account?: string /** @description City/District/Suburb/Town/Village. */ - readonly address_city?: string; + readonly address_city?: string /** @description Billing address country, if provided when creating card. */ - readonly address_country?: string; + readonly address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - readonly address_line1?: string; + readonly address_line1?: string /** @description If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. */ - readonly address_line1_check?: string; + readonly address_line1_check?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - readonly address_line2?: string; + readonly address_line2?: string /** @description State/County/Province/Region. */ - readonly address_state?: string; + readonly address_state?: string /** @description ZIP or postal code. */ - readonly address_zip?: string; + readonly address_zip?: string /** @description If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. */ - readonly address_zip_check?: string; + readonly address_zip_check?: string /** @description A set of available payout methods for this card. Will be either `["standard"]` or `["standard", "instant"]`. Only values from this set should be passed as the `method` when creating a transfer. */ - readonly available_payout_methods?: readonly ("instant" | "standard")[]; + readonly available_payout_methods?: readonly ('instant' | 'standard')[] /** @description Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`. */ - readonly brand: string; + readonly brand: string /** @description 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. */ - readonly country?: string; - readonly currency?: string; + readonly country?: string + readonly currency?: string /** @description 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. */ - readonly customer?: string; + readonly customer?: string /** @description If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. */ - readonly cvc_check?: string; + readonly cvc_check?: string /** @description Whether this card is the default external account for its currency. */ - readonly default_for_currency?: boolean; + readonly default_for_currency?: boolean /** @description (For tokenized numbers only.) The last four digits of the device account number. */ - readonly dynamic_last4?: string; + readonly dynamic_last4?: string /** @description Two-digit number representing the card's expiration month. */ - readonly exp_month: number; + readonly exp_month: number /** @description Four-digit number representing the card's expiration year. */ - readonly exp_year: number; + readonly exp_year: number /** @description 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. */ - readonly fingerprint?: string; + readonly fingerprint?: string /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ - readonly funding: string; + readonly funding: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description The last four digits of the card. */ - readonly last4: string; + readonly last4: string /** @description 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. */ - readonly metadata: { readonly [key: string]: unknown }; + readonly metadata: { readonly [key: string]: unknown } /** @description Cardholder name. */ - readonly name?: string; + readonly name?: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "card"; + readonly object: 'card' /** @description The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead. */ - readonly recipient?: string; + readonly recipient?: string /** @description If the card number is tokenized, this is the method that was used. Can be `amex_express_checkout`, `android_pay` (includes Google Pay), `apple_pay`, `masterpass`, `visa_checkout`, or null. */ - readonly tokenization_method?: string; - }; + readonly tokenization_method?: string + } /** card_mandate_payment_method_details */ - readonly card_mandate_payment_method_details: { readonly [key: string]: unknown }; + readonly card_mandate_payment_method_details: { readonly [key: string]: unknown } /** * Charge * @description To charge a credit or a debit card, you create a `Charge` object. You can @@ -2331,135 +2331,135 @@ export interface definitions { */ readonly charge: { /** @description 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). */ - readonly amount: number; + readonly amount: number /** @description Amount in %s refunded (can be less than the amount attribute on the charge if a partial refund was issued). */ - readonly amount_refunded: number; + readonly amount_refunded: number /** @description ID of the Connect application that created the charge. */ - readonly application?: string; + readonly application?: string /** @description The application fee (if any) for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees) for details. */ - readonly application_fee?: string; + readonly application_fee?: string /** @description The amount of the application fee (if any) for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees) for details. */ - readonly application_fee_amount?: number; + readonly application_fee_amount?: number /** @description ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes). */ - readonly balance_transaction?: string; - readonly billing_details: definitions["billing_details"]; + readonly balance_transaction?: string + readonly billing_details: definitions['billing_details'] /** @description 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. */ - readonly calculated_statement_descriptor?: string; + readonly calculated_statement_descriptor?: string /** @description If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured. */ - readonly captured: boolean; + readonly captured: boolean /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description ID of the customer this charge is for if one exists. */ - readonly customer?: string; + readonly customer?: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string; + readonly description?: string /** @description Whether the charge has been disputed. */ - readonly disputed: boolean; + readonly disputed: boolean /** @description Error code explaining reason for charge failure if available (see [the errors section](https://stripe.com/docs/api#errors) for a list of codes). */ - readonly failure_code?: string; + readonly failure_code?: string /** @description Message to user further explaining reason for charge failure if available. */ - readonly failure_message?: string; - readonly fraud_details?: definitions["charge_fraud_details"]; + readonly failure_message?: string + readonly fraud_details?: definitions['charge_fraud_details'] /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description ID of the invoice this charge is for if one exists. */ - readonly invoice?: string; + readonly invoice?: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata: { readonly [key: string]: unknown }; + readonly metadata: { readonly [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "charge"; + readonly object: 'charge' /** @description 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/charges-transfers) for details. */ - readonly on_behalf_of?: string; + readonly on_behalf_of?: string /** @description ID of the order this charge is for if one exists. */ - readonly order?: string; - readonly outcome?: definitions["charge_outcome"]; + readonly order?: string + readonly outcome?: definitions['charge_outcome'] /** @description `true` if the charge succeeded, or was successfully authorized for later capture. */ - readonly paid: boolean; + readonly paid: boolean /** @description ID of the PaymentIntent associated with this charge, if one exists. */ - readonly payment_intent?: string; + readonly payment_intent?: string /** @description ID of the payment method used in this charge. */ - readonly payment_method?: string; - readonly payment_method_details?: definitions["payment_method_details"]; + readonly payment_method?: string + readonly payment_method_details?: definitions['payment_method_details'] /** @description This is the email address that the receipt for this charge was sent to. */ - readonly receipt_email?: string; + readonly receipt_email?: string /** @description 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. */ - readonly receipt_number?: string; + readonly receipt_number?: string /** @description 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. */ - readonly receipt_url?: string; + readonly receipt_url?: string /** @description Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false. */ - readonly refunded: boolean; + readonly refunded: boolean /** * RefundList * @description A list of refunds that have been applied to the charge. */ readonly refunds: { /** @description Details about each object. */ - readonly data: readonly definitions["refund"][]; + readonly data: readonly definitions['refund'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; + readonly url: string + } /** @description ID of the review associated with this charge if one exists. */ - readonly review?: string; - readonly shipping?: definitions["shipping"]; + readonly review?: string + readonly shipping?: definitions['shipping'] /** @description The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details. */ - readonly source_transfer?: string; + readonly source_transfer?: string /** @description For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - readonly statement_descriptor?: string; + readonly statement_descriptor?: string /** @description Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - readonly statement_descriptor_suffix?: string; + readonly statement_descriptor_suffix?: string /** @description The status of the payment is either `succeeded`, `pending`, or `failed`. */ - readonly status: string; + readonly status: string /** @description ID of the transfer to the `destination` account (only applicable if the charge was created using the `destination` parameter). */ - readonly transfer?: string; - readonly transfer_data?: definitions["charge_transfer_data"]; + readonly transfer?: string + readonly transfer_data?: definitions['charge_transfer_data'] /** @description A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-options) for details. */ - readonly transfer_group?: string; - }; + readonly transfer_group?: string + } /** ChargeFraudDetails */ readonly charge_fraud_details: { /** @description Assessments from Stripe. If set, the value is `fraudulent`. */ - readonly stripe_report?: string; + readonly stripe_report?: string /** @description Assessments reported by you. If set, possible values of are `safe` and `fraudulent`. */ - readonly user_report?: string; - }; + readonly user_report?: string + } /** ChargeOutcome */ readonly charge_outcome: { /** @description 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. */ - readonly network_status?: string; + readonly network_status?: string /** @description 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. */ - readonly reason?: string; + readonly reason?: string /** @description Stripe'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`. */ - readonly risk_level?: string; + readonly risk_level?: string /** @description Stripe'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. */ - readonly risk_score?: number; + readonly risk_score?: number /** @description The ID of the Radar rule that matched the payment, if applicable. */ - readonly rule?: string; + readonly rule?: string /** @description A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer. */ - readonly seller_message?: string; + readonly seller_message?: string /** @description 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. */ - readonly type: string; - }; + readonly type: string + } /** ChargeTransferData */ readonly charge_transfer_data: { /** @description The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account. */ - readonly amount?: number; + readonly amount?: number /** @description ID of an existing, connected Stripe account to transfer funds to if `transfer_data` was specified in the charge request. */ - readonly destination: string; - }; + readonly destination: string + } /** * Session * @description A Checkout Session represents your customer's session as they pay for @@ -2476,20 +2476,20 @@ export interface definitions { * * Related guide: [Checkout Server Quickstart](https://stripe.com/docs/payments/checkout/api). */ - readonly "checkout.session": { + readonly 'checkout.session': { /** * @description The value (`auto` or `required`) for whether Checkout collected the * customer's billing address. */ - readonly billing_address_collection?: string; + readonly billing_address_collection?: string /** @description The URL the customer will be directed to if they decide to cancel payment and return to your website. */ - readonly cancel_url: string; + readonly cancel_url: string /** * @description A unique string to reference the Checkout Session. This can be a * customer ID, a cart ID, or similar, and can be used to reconcile the * session with your internal systems. */ - readonly client_reference_id?: string; + readonly client_reference_id?: string /** * @description The ID of the customer for this session. * For Checkout Sessions in `payment` or `subscription` mode, Checkout @@ -2497,7 +2497,7 @@ export interface definitions { * during the session unless an existing customer was provided when * the session was created. */ - readonly customer?: string; + readonly customer?: string /** * @description 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. @@ -2505,61 +2505,44 @@ export interface definitions { * on file. To access information about the customer once a session is * complete, use the `customer` field. */ - readonly customer_email?: string; + readonly customer_email?: string /** @description The line items, plans, or SKUs purchased by the customer. */ - readonly display_items?: readonly definitions["checkout_session_display_item"][]; + readonly display_items?: readonly definitions['checkout_session_display_item'][] /** * @description Unique identifier for the object. Used to pass to `redirectToCheckout` * in Stripe.js. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used. * @enum {string} */ - readonly locale?: - | "auto" - | "da" - | "de" - | "en" - | "es" - | "fi" - | "fr" - | "it" - | "ja" - | "ms" - | "nb" - | "nl" - | "pl" - | "pt" - | "pt-BR" - | "sv" - | "zh"; + readonly locale?: 'auto' | 'da' | 'de' | 'en' | 'es' | 'fi' | 'fr' | 'it' | 'ja' | 'ms' | 'nb' | 'nl' | 'pl' | 'pt' | 'pt-BR' | 'sv' | 'zh' /** @description 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. */ - readonly metadata?: { readonly [key: string]: unknown }; + readonly metadata?: { readonly [key: string]: unknown } /** * @description The mode of the Checkout Session, one of `payment`, `setup`, or `subscription`. * @enum {string} */ - readonly mode?: "payment" | "setup" | "subscription"; + readonly mode?: 'payment' | 'setup' | 'subscription' /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "checkout.session"; + readonly object: 'checkout.session' /** @description The ID of the PaymentIntent for Checkout Sessions in `payment` mode. */ - readonly payment_intent?: string; + readonly payment_intent?: string /** * @description A list of the types of payment methods (e.g. card) this Checkout * Session is allowed to accept. */ - readonly payment_method_types: readonly string[]; + readonly payment_method_types: readonly string[] /** @description The ID of the SetupIntent for Checkout Sessions in `setup` mode. */ - readonly setup_intent?: string; - readonly shipping?: definitions["shipping"]; - readonly shipping_address_collection?: definitions["payment_pages_payment_page_resources_shipping_address_collection"]; + readonly setup_intent?: string + readonly shipping?: definitions['shipping'] + readonly shipping_address_collection?: definitions['payment_pages_payment_page_resources_shipping_address_collection'] /** * @description Describes the type of transaction being performed by Checkout in order to customize * relevant text on the page, such as the submit button. `submit_type` can only be @@ -2567,56 +2550,56 @@ export interface definitions { * in `subscription` or `setup` mode. * @enum {string} */ - readonly submit_type?: "auto" | "book" | "donate" | "pay"; + readonly submit_type?: 'auto' | 'book' | 'donate' | 'pay' /** @description The ID of the subscription for Checkout Sessions in `subscription` mode. */ - readonly subscription?: string; + readonly subscription?: string /** * @description The URL the customer will be directed to after the payment or * subscription creation is successful. */ - readonly success_url: string; - }; + readonly success_url: string + } /** checkout_session_custom_display_item_description */ readonly checkout_session_custom_display_item_description: { /** @description The description of the line item. */ - readonly description?: string; + readonly description?: string /** @description The images of the line item. */ - readonly images?: readonly string[]; + readonly images?: readonly string[] /** @description The name of the line item. */ - readonly name: string; - }; + readonly name: string + } /** checkout_session_display_item */ readonly checkout_session_display_item: { /** @description Amount for the display item. */ - readonly amount?: number; + readonly amount?: number /** @description 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). */ - readonly currency?: string; - readonly custom?: definitions["checkout_session_custom_display_item_description"]; - readonly plan?: definitions["plan"]; + readonly currency?: string + readonly custom?: definitions['checkout_session_custom_display_item_description'] + readonly plan?: definitions['plan'] /** @description Quantity of the display item being purchased. */ - readonly quantity?: number; - readonly sku?: definitions["sku"]; + readonly quantity?: number + readonly sku?: definitions['sku'] /** @description The type of display item. One of `custom`, `plan` or `sku` */ - readonly type?: string; - }; + readonly type?: string + } /** ConnectCollectionTransfer */ readonly connect_collection_transfer: { /** @description Amount transferred, in %s. */ - readonly amount: number; + readonly amount: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description ID of the account that funds are being collected for. */ - readonly destination: string; + readonly destination: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "connect_collection_transfer"; - }; + readonly object: 'connect_collection_transfer' + } /** * CountrySpec * @description Stripe needs to collect certain pieces of information about each account @@ -2628,36 +2611,36 @@ export interface definitions { */ readonly country_spec: { /** @description The default currency for this country. This applies to both payment methods and bank accounts. */ - readonly default_currency: string; + readonly default_currency: string /** @description Unique identifier for the object. Represented as the ISO country code for this country. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "country_spec"; + readonly object: 'country_spec' /** @description Currencies that can be accepted in the specific country (for transfers). */ - readonly supported_bank_account_currencies: { readonly [key: string]: unknown }; + readonly supported_bank_account_currencies: { readonly [key: string]: unknown } /** @description Currencies that can be accepted in the specified country (for payments). */ - readonly supported_payment_currencies: readonly string[]; + readonly supported_payment_currencies: readonly string[] /** @description 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). */ - readonly supported_payment_methods: readonly string[]; + readonly supported_payment_methods: readonly string[] /** @description Countries that can accept transfers from the specified country. */ - readonly supported_transfer_countries: readonly string[]; - readonly verification_fields: definitions["country_spec_verification_fields"]; - }; + readonly supported_transfer_countries: readonly string[] + readonly verification_fields: definitions['country_spec_verification_fields'] + } /** CountrySpecVerificationFieldDetails */ readonly country_spec_verification_field_details: { /** @description Additional fields which are only required for some users. */ - readonly additional: readonly string[]; + readonly additional: readonly string[] /** @description Fields which every account must eventually provide. */ - readonly minimum: readonly string[]; - }; + readonly minimum: readonly string[] + } /** CountrySpecVerificationFields */ readonly country_spec_verification_fields: { - readonly company: definitions["country_spec_verification_field_details"]; - readonly individual: definitions["country_spec_verification_field_details"]; - }; + readonly company: definitions['country_spec_verification_field_details'] + readonly individual: definitions['country_spec_verification_field_details'] + } /** * Coupon * @description A coupon contains information about a percent-off or amount-off discount you @@ -2666,42 +2649,42 @@ export interface definitions { */ readonly coupon: { /** @description Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer. */ - readonly amount_off?: number; + readonly amount_off?: number /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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. */ - readonly currency?: string; + readonly currency?: string /** * @description One of `forever`, `once`, and `repeating`. Describes how long a customer who applies this coupon will get the discount. * @enum {string} */ - readonly duration: "forever" | "once" | "repeating"; + readonly duration: 'forever' | 'once' | 'repeating' /** @description If `duration` is `repeating`, the number of months the coupon applies. Null if coupon `duration` is `forever` or `once`. */ - readonly duration_in_months?: number; + readonly duration_in_months?: number /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid. */ - readonly max_redemptions?: number; + readonly max_redemptions?: number /** @description 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. */ - readonly metadata: { readonly [key: string]: unknown }; + readonly metadata: { readonly [key: string]: unknown } /** @description Name of the coupon displayed to customers on for instance invoices or receipts. */ - readonly name?: string; + readonly name?: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "coupon"; + readonly object: 'coupon' /** @description 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 %s100 invoice %s50 instead. */ - readonly percent_off?: number; + readonly percent_off?: number /** @description Date after which the coupon can no longer be redeemed. */ - readonly redeem_by?: number; + readonly redeem_by?: number /** @description Number of times this coupon has been applied to a customer. */ - readonly times_redeemed: number; + readonly times_redeemed: number /** @description Taking account of the above properties, whether this coupon can still be applied to a customer. */ - readonly valid: boolean; - }; + readonly valid: boolean + } /** * CreditNote * @description Issue a credit note to adjust an invoice's amount after the invoice is finalized. @@ -2710,125 +2693,125 @@ export interface definitions { */ readonly credit_note: { /** @description The integer amount in **%s** representing the total amount of the credit note, including tax. */ - readonly amount: number; + readonly amount: number /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description ID of the customer. */ - readonly customer: string; + readonly customer: string /** @description Customer balance transaction related to this credit note. */ - readonly customer_balance_transaction?: string; + readonly customer_balance_transaction?: string /** @description The integer amount in **%s** representing the amount of the discount that was credited. */ - readonly discount_amount: number; + readonly discount_amount: number /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description ID of the invoice. */ - readonly invoice: string; + readonly invoice: string /** * CreditNoteLinesList * @description Line items that make up the credit note */ readonly lines: { /** @description Details about each object. */ - readonly data: readonly definitions["credit_note_line_item"][]; + readonly data: readonly definitions['credit_note_line_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; + readonly url: string + } /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description Customer-facing text that appears on the credit note PDF. */ - readonly memo?: string; + readonly memo?: string /** @description 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. */ - readonly metadata: { readonly [key: string]: unknown }; + readonly metadata: { readonly [key: string]: unknown } /** @description A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice. */ - readonly number: string; + readonly number: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "credit_note"; + readonly object: 'credit_note' /** @description Amount that was credited outside of Stripe. */ - readonly out_of_band_amount?: number; + readonly out_of_band_amount?: number /** @description The link to download the PDF of the credit note. */ - readonly pdf: string; + readonly pdf: string /** * @description Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` * @enum {string} */ - readonly reason?: "duplicate" | "fraudulent" | "order_change" | "product_unsatisfactory"; + readonly reason?: 'duplicate' | 'fraudulent' | 'order_change' | 'product_unsatisfactory' /** @description Refund related to this credit note. */ - readonly refund?: string; + readonly refund?: string /** * @description 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). * @enum {string} */ - readonly status: "issued" | "void"; + readonly status: 'issued' | 'void' /** @description The integer amount in **%s** representing the amount of the credit note, excluding tax and discount. */ - readonly subtotal: number; + readonly subtotal: number /** @description The aggregate amounts calculated per tax rate for all line items. */ - readonly tax_amounts: readonly definitions["credit_note_tax_amount"][]; + readonly tax_amounts: readonly definitions['credit_note_tax_amount'][] /** @description The integer amount in **%s** representing the total amount of the credit note, including tax and discount. */ - readonly total: number; + readonly total: number /** * @description 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. * @enum {string} */ - readonly type: "post_payment" | "pre_payment"; + readonly type: 'post_payment' | 'pre_payment' /** @description The time that the credit note was voided. */ - readonly voided_at?: number; - }; + readonly voided_at?: number + } /** CreditNoteLineItem */ readonly credit_note_line_item: { /** @description The integer amount in **%s** representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts. */ - readonly amount: number; + readonly amount: number /** @description Description of the item being credited. */ - readonly description?: string; + readonly description?: string /** @description The integer amount in **%s** representing the discount being credited for this line item. */ - readonly discount_amount: number; + readonly discount_amount: number /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description ID of the invoice line item being credited */ - readonly invoice_line_item?: string; + readonly invoice_line_item?: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "credit_note_line_item"; + readonly object: 'credit_note_line_item' /** @description The number of units of product being credited. */ - readonly quantity?: number; + readonly quantity?: number /** @description The amount of tax calculated per tax rate for this line item */ - readonly tax_amounts: readonly definitions["credit_note_tax_amount"][]; + readonly tax_amounts: readonly definitions['credit_note_tax_amount'][] /** @description The tax rates which apply to the line item. */ - readonly tax_rates: readonly definitions["tax_rate"][]; + readonly tax_rates: readonly definitions['tax_rate'][] /** * @description 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. * @enum {string} */ - readonly type: "custom_line_item" | "invoice_line_item"; + readonly type: 'custom_line_item' | 'invoice_line_item' /** @description The cost of each unit of product being credited. */ - readonly unit_amount?: number; + readonly unit_amount?: number /** @description Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. */ - readonly unit_amount_decimal?: string; - }; + readonly unit_amount_decimal?: string + } /** CreditNoteTaxAmount */ readonly credit_note_tax_amount: { /** @description The amount, in %s, of the tax. */ - readonly amount: number; + readonly amount: number /** @description Whether this tax amount is inclusive or exclusive. */ - readonly inclusive: boolean; + readonly inclusive: boolean /** @description The tax rate that was applied to get this tax amount. */ - readonly tax_rate: string; - }; + readonly tax_rate: string + } /** * Customer * @description `Customer` objects allow you to perform recurring charges, and to track @@ -2839,118 +2822,118 @@ export interface definitions { * Related guide: [Saving Cards with Customers](https://stripe.com/docs/saving-cards). */ readonly customer: { - readonly address?: definitions["address"]; + readonly address?: definitions['address'] /** @description Current balance, if any, being 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 will be added to their next invoice. The balance does not refer to any unpaid invoices; it solely takes into account amounts that have yet to be successfully applied to any invoice. This balance is only taken into account as invoices are finalized. */ - readonly balance?: number; + readonly balance?: number /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes. */ - readonly currency?: string; + readonly currency?: string /** * @description ID of the default payment source for the customer. * * If you are using payment methods created via 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. */ - readonly default_source?: string; + readonly default_source?: string /** @description When the customer's latest invoice is billed by charging automatically, delinquent is true if the invoice's latest charge is failed. When the customer's latest invoice is billed by sending an invoice, delinquent is true if the invoice is not paid by its due date. */ - readonly delinquent?: boolean; + readonly delinquent?: boolean /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string; - readonly discount?: definitions["discount"]; + readonly description?: string + readonly discount?: definitions['discount'] /** @description The customer's email address. */ - readonly email?: string; + readonly email?: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description The prefix for the customer used to generate unique invoice numbers. */ - readonly invoice_prefix?: string; - readonly invoice_settings?: definitions["invoice_setting_customer_setting"]; + readonly invoice_prefix?: string + readonly invoice_settings?: definitions['invoice_setting_customer_setting'] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata?: { readonly [key: string]: unknown }; + readonly metadata?: { readonly [key: string]: unknown } /** @description The customer's full name or business name. */ - readonly name?: string; + readonly name?: string /** @description The suffix of the customer's next invoice number, e.g., 0001. */ - readonly next_invoice_sequence?: number; + readonly next_invoice_sequence?: number /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "customer"; + readonly object: 'customer' /** @description The customer's phone number. */ - readonly phone?: string; + readonly phone?: string /** @description The customer's preferred locales (languages), ordered by preference. */ - readonly preferred_locales?: readonly string[]; - readonly shipping?: definitions["shipping"]; + readonly preferred_locales?: readonly string[] + readonly shipping?: definitions['shipping'] /** * ApmsSourcesSourceList * @description The customer's payment sources, if any. */ readonly sources: { /** @description Details about each object. */ - readonly data: readonly definitions["alipay_account"][]; + readonly data: readonly definitions['alipay_account'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; + readonly url: string + } /** * SubscriptionList * @description The customer's current subscriptions, if any. */ readonly subscriptions?: { /** @description Details about each object. */ - readonly data: readonly definitions["subscription"][]; + readonly data: readonly definitions['subscription'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; + readonly url: string + } /** * @description Describes the customer's tax exemption status. One of `none`, `exempt`, or `reverse`. When set to `reverse`, invoice and receipt PDFs include the text **"Reverse charge"**. * @enum {string} */ - readonly tax_exempt?: "exempt" | "none" | "reverse"; + readonly tax_exempt?: 'exempt' | 'none' | 'reverse' /** * TaxIDsList * @description The customer's tax IDs. */ readonly tax_ids?: { /** @description Details about each object. */ - readonly data: readonly definitions["tax_id"][]; + readonly data: readonly definitions['tax_id'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** customer_acceptance */ readonly customer_acceptance: { /** @description The time at which the customer accepted the Mandate. */ - readonly accepted_at?: number; - readonly offline?: definitions["offline_acceptance"]; - readonly online?: definitions["online_acceptance"]; + readonly accepted_at?: number + readonly offline?: definitions['offline_acceptance'] + readonly online?: definitions['online_acceptance'] /** * @description The type of customer acceptance information included with the Mandate. One of `online` or `offline`. * @enum {string} */ - readonly type: "offline" | "online"; - }; + readonly type: 'offline' | 'online' + } /** * CustomerBalanceTransaction * @description Each customer has a [`balance`](https://stripe.com/docs/api/customers/object#customer_object-balance) value, @@ -2962,437 +2945,437 @@ export interface definitions { */ readonly customer_balance_transaction: { /** @description 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`. */ - readonly amount: number; + readonly amount: number /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description The ID of the credit note (if any) related to the transaction. */ - readonly credit_note?: string; + readonly credit_note?: string /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description The ID of the customer the transaction belongs to. */ - readonly customer: string; + readonly customer: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string; + readonly description?: string /** @description 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. */ - readonly ending_balance: number; + readonly ending_balance: number /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description The ID of the invoice (if any) related to the transaction. */ - readonly invoice?: string; + readonly invoice?: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata?: { readonly [key: string]: unknown }; + readonly metadata?: { readonly [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "customer_balance_transaction"; + readonly object: 'customer_balance_transaction' /** * @description Transaction type: `adjustment`, `applied_to_invoice`, `credit_note`, `initial`, `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. * @enum {string} */ readonly type: - | "adjustment" - | "applied_to_invoice" - | "credit_note" - | "initial" - | "invoice_too_large" - | "invoice_too_small" - | "migration" - | "unapplied_from_invoice" - | "unspent_receiver_credit"; - }; + | 'adjustment' + | 'applied_to_invoice' + | 'credit_note' + | 'initial' + | 'invoice_too_large' + | 'invoice_too_small' + | 'migration' + | 'unapplied_from_invoice' + | 'unspent_receiver_credit' + } /** DeletedAccount */ readonly deleted_account: { /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "account"; - }; + readonly object: 'account' + } /** AlipayDeletedAccount */ readonly deleted_alipay_account: { /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "alipay_account"; - }; + readonly object: 'alipay_account' + } /** DeletedApplePayDomain */ readonly deleted_apple_pay_domain: { /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "apple_pay_domain"; - }; + readonly object: 'apple_pay_domain' + } /** DeletedBankAccount */ readonly deleted_bank_account: { /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. */ - readonly currency?: string; + readonly currency?: string /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "bank_account"; - }; + readonly object: 'bank_account' + } /** BitcoinDeletedReceiver */ readonly deleted_bitcoin_receiver: { /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "bitcoin_receiver"; - }; + readonly object: 'bitcoin_receiver' + } /** DeletedCard */ readonly deleted_card: { /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. */ - readonly currency?: string; + readonly currency?: string /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "card"; - }; + readonly object: 'card' + } /** DeletedCoupon */ readonly deleted_coupon: { /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "coupon"; - }; + readonly object: 'coupon' + } /** DeletedCustomer */ readonly deleted_customer: { /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "customer"; - }; + readonly object: 'customer' + } /** DeletedDiscount */ readonly deleted_discount: { /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "discount"; - }; + readonly object: 'discount' + } /** Polymorphic */ readonly deleted_external_account: { /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. */ - readonly currency?: string; + readonly currency?: string /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "bank_account"; - }; + readonly object: 'bank_account' + } /** DeletedInvoice */ readonly deleted_invoice: { /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "invoice"; - }; + readonly object: 'invoice' + } /** DeletedInvoiceItem */ readonly deleted_invoiceitem: { /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "invoiceitem"; - }; + readonly object: 'invoiceitem' + } /** Polymorphic */ readonly deleted_payment_source: { /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "alipay_account"; - }; + readonly object: 'alipay_account' + } /** DeletedPerson */ readonly deleted_person: { /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "person"; - }; + readonly object: 'person' + } /** DeletedPlan */ readonly deleted_plan: { /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "plan"; - }; + readonly object: 'plan' + } /** DeletedProduct */ readonly deleted_product: { /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "product"; - }; + readonly object: 'product' + } /** RadarListDeletedList */ - readonly "deleted_radar.value_list": { + readonly 'deleted_radar.value_list': { /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "radar.value_list"; - }; + readonly object: 'radar.value_list' + } /** RadarListDeletedListItem */ - readonly "deleted_radar.value_list_item": { + readonly 'deleted_radar.value_list_item': { /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "radar.value_list_item"; - }; + readonly object: 'radar.value_list_item' + } /** DeletedTransferRecipient */ readonly deleted_recipient: { /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "recipient"; - }; + readonly object: 'recipient' + } /** DeletedSKU */ readonly deleted_sku: { /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "sku"; - }; + readonly object: 'sku' + } /** DeletedSubscriptionItem */ readonly deleted_subscription_item: { /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "subscription_item"; - }; + readonly object: 'subscription_item' + } /** deleted_tax_id */ readonly deleted_tax_id: { /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "tax_id"; - }; + readonly object: 'tax_id' + } /** TerminalLocationDeletedLocation */ - readonly "deleted_terminal.location": { + readonly 'deleted_terminal.location': { /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "terminal.location"; - }; + readonly object: 'terminal.location' + } /** TerminalReaderDeletedReader */ - readonly "deleted_terminal.reader": { + readonly 'deleted_terminal.reader': { /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "terminal.reader"; - }; + readonly object: 'terminal.reader' + } /** NotificationWebhookEndpointDeleted */ readonly deleted_webhook_endpoint: { /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "webhook_endpoint"; - }; + readonly object: 'webhook_endpoint' + } /** DeliveryEstimate */ readonly delivery_estimate: { /** @description If `type` is `"exact"`, `date` will be the expected delivery date in the format YYYY-MM-DD. */ - readonly date?: string; + readonly date?: string /** @description If `type` is `"range"`, `earliest` will be be the earliest delivery date in the format YYYY-MM-DD. */ - readonly earliest?: string; + readonly earliest?: string /** @description If `type` is `"range"`, `latest` will be the latest delivery date in the format YYYY-MM-DD. */ - readonly latest?: string; + readonly latest?: string /** @description The type of estimate. Must be either `"range"` or `"exact"`. */ - readonly type: string; - }; + readonly type: string + } /** * Discount * @description A discount represents the actual application of a coupon to a particular @@ -3402,21 +3385,21 @@ export interface definitions { * Related guide: [Applying Discounts to Subscriptions](https://stripe.com/docs/billing/subscriptions/discounts). */ readonly discount: { - readonly coupon: definitions["coupon"]; + readonly coupon: definitions['coupon'] /** @description The ID of the customer associated with this discount. */ - readonly customer?: string; + readonly customer?: string /** @description 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. */ - readonly end?: number; + readonly end?: number /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "discount"; + readonly object: 'discount' /** @description Date that the coupon was applied. */ - readonly start: number; + readonly start: number /** @description The subscription that this coupon is applied to, if it is applied to a particular subscription. */ - readonly subscription?: string; - }; + readonly subscription?: string + } /** * Dispute * @description A dispute occurs when a customer questions your charge with their card issuer. @@ -3429,138 +3412,138 @@ export interface definitions { */ readonly dispute: { /** @description Disputed amount. Usually the amount of the charge, but can differ (usually because of currency fluctuation or because only part of the order is disputed). */ - readonly amount: number; + readonly amount: number /** @description List of zero, one, or two balance transactions that show funds withdrawn and reinstated to your Stripe account as a result of this dispute. */ - readonly balance_transactions: readonly definitions["balance_transaction"][]; + readonly balance_transactions: readonly definitions['balance_transaction'][] /** @description ID of the charge that was disputed. */ - readonly charge: string; + readonly charge: string /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; - readonly evidence: definitions["dispute_evidence"]; - readonly evidence_details: definitions["dispute_evidence_details"]; + readonly currency: string + readonly evidence: definitions['dispute_evidence'] + readonly evidence_details: definitions['dispute_evidence_details'] /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description If true, it is still possible to refund the disputed payment. Once the payment has been fully refunded, no further funds will be withdrawn from your Stripe account as a result of this dispute. */ - readonly is_charge_refundable: boolean; + readonly is_charge_refundable: boolean /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata: { readonly [key: string]: unknown }; + readonly metadata: { readonly [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "dispute"; + readonly object: 'dispute' /** @description ID of the PaymentIntent that was disputed. */ - readonly payment_intent?: string; + readonly payment_intent?: string /** @description 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`. Read more about [dispute reasons](https://stripe.com/docs/disputes/categories). */ - readonly reason: string; + readonly reason: string /** * @description Current status of dispute. Possible values are `warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `charge_refunded`, `won`, or `lost`. * @enum {string} */ readonly status: - | "charge_refunded" - | "lost" - | "needs_response" - | "under_review" - | "warning_closed" - | "warning_needs_response" - | "warning_under_review" - | "won"; - }; + | 'charge_refunded' + | 'lost' + | 'needs_response' + | 'under_review' + | 'warning_closed' + | 'warning_needs_response' + | 'warning_under_review' + | 'won' + } /** DisputeEvidence */ readonly dispute_evidence: { /** @description 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. */ - readonly access_activity_log?: string; + readonly access_activity_log?: string /** @description The billing address provided by the customer. */ - readonly billing_address?: string; + readonly billing_address?: string /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your subscription cancellation policy, as shown to the customer. */ - readonly cancellation_policy?: string; + readonly cancellation_policy?: string /** @description An explanation of how and when the customer was shown your refund policy prior to purchase. */ - readonly cancellation_policy_disclosure?: string; + readonly cancellation_policy_disclosure?: string /** @description A justification for why the customer's subscription was not canceled. */ - readonly cancellation_rebuttal?: string; + readonly cancellation_rebuttal?: string /** @description (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. */ - readonly customer_communication?: string; + readonly customer_communication?: string /** @description The email address of the customer. */ - readonly customer_email_address?: string; + readonly customer_email_address?: string /** @description The name of the customer. */ - readonly customer_name?: string; + readonly customer_name?: string /** @description The IP address that the customer used when making the purchase. */ - readonly customer_purchase_ip?: string; + readonly customer_purchase_ip?: string /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A relevant document or contract showing the customer's signature. */ - readonly customer_signature?: string; + readonly customer_signature?: string /** @description (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. */ - readonly duplicate_charge_documentation?: string; + readonly duplicate_charge_documentation?: string /** @description An explanation of the difference between the disputed charge versus the prior charge that appears to be a duplicate. */ - readonly duplicate_charge_explanation?: string; + readonly duplicate_charge_explanation?: string /** @description The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge. */ - readonly duplicate_charge_id?: string; + readonly duplicate_charge_id?: string /** @description A description of the product or service that was sold. */ - readonly product_description?: string; + readonly product_description?: string /** @description (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. */ - readonly receipt?: string; + readonly receipt?: string /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your refund policy, as shown to the customer. */ - readonly refund_policy?: string; + readonly refund_policy?: string /** @description Documentation demonstrating that the customer was shown your refund policy prior to purchase. */ - readonly refund_policy_disclosure?: string; + readonly refund_policy_disclosure?: string /** @description A justification for why the customer is not entitled to a refund. */ - readonly refund_refusal_explanation?: string; + readonly refund_refusal_explanation?: string /** @description The date on which the customer received or began receiving the purchased service, in a clear human-readable format. */ - readonly service_date?: string; + readonly service_date?: string /** @description (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. */ - readonly service_documentation?: string; + readonly service_documentation?: string /** @description The address to which a physical product was shipped. You should try to include as complete address information as possible. */ - readonly shipping_address?: string; + readonly shipping_address?: string /** @description 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. */ - readonly shipping_carrier?: string; + readonly shipping_carrier?: string /** @description The date on which a physical product began its route to the shipping address, in a clear human-readable format. */ - readonly shipping_date?: string; + readonly shipping_date?: string /** @description (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. */ - readonly shipping_documentation?: string; + readonly shipping_documentation?: string /** @description 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. */ - readonly shipping_tracking_number?: string; + readonly shipping_tracking_number?: string /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any additional evidence or statements. */ - readonly uncategorized_file?: string; + readonly uncategorized_file?: string /** @description Any additional evidence or statements. */ - readonly uncategorized_text?: string; - }; + readonly uncategorized_text?: string + } /** DisputeEvidenceDetails */ readonly dispute_evidence_details: { /** @description Date by which evidence must be submitted in order to successfully challenge dispute. Will be null if the customer's bank or credit card company doesn't allow a response for this particular dispute. */ - readonly due_by?: number; + readonly due_by?: number /** @description Whether evidence has been staged for this dispute. */ - readonly has_evidence: boolean; + readonly has_evidence: boolean /** @description 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. */ - readonly past_due: boolean; + readonly past_due: boolean /** @description The number of times evidence has been submitted. Typically, you may only submit evidence once. */ - readonly submission_count: number; - }; + readonly submission_count: number + } /** EphemeralKey */ readonly ephemeral_key: { /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description Time at which the key will expire. Measured in seconds since the Unix epoch. */ - readonly expires: number; + readonly expires: number /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "ephemeral_key"; + readonly object: 'ephemeral_key' /** @description The key's secret. You can use this value to make authorized requests to the Stripe API. */ - readonly secret?: string; - }; + readonly secret?: string + } /** @description An error response from the Stripe API */ readonly error: { - readonly error: definitions["api_errors"]; - }; + readonly error: definitions['api_errors'] + } /** * NotificationEvent * @description Events are our way of letting you know when something interesting happens in @@ -3595,27 +3578,27 @@ export interface definitions { */ readonly event: { /** @description The connected account that originated the event. */ - readonly account?: string; + readonly account?: string /** @description The Stripe API version used to render `data`. *Note: This property is populated only for events on or after October 31, 2014*. */ - readonly api_version?: string; + readonly api_version?: string /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; - readonly data: definitions["notification_event_data"]; + readonly created: number + readonly data: definitions['notification_event_data'] /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "event"; + readonly object: 'event' /** @description Number of webhooks that have yet to be successfully delivered (i.e., to return a 20x response) to the URLs you've specified. */ - readonly pending_webhooks: number; - readonly request?: definitions["notification_event_request"]; + readonly pending_webhooks: number + readonly request?: definitions['notification_event_request'] /** @description Description of the event (e.g., `invoice.created` or `charge.refunded`). */ - readonly type: string; - }; + readonly type: string + } /** * ExchangeRate * @description `Exchange Rate` objects allow you to determine the rates that Stripe is @@ -3632,54 +3615,54 @@ export interface definitions { */ readonly exchange_rate: { /** @description Unique identifier for the object. Represented as the three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "exchange_rate"; + readonly object: 'exchange_rate' /** @description 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. */ - readonly rates: { readonly [key: string]: unknown }; - }; + readonly rates: { readonly [key: string]: unknown } + } /** Polymorphic */ readonly external_account: { /** @description The ID of the account that the bank account is associated with. */ - readonly account?: string; + readonly account?: string /** @description Two-letter ISO code representing the country the bank account is located in. */ - readonly country: string; + readonly country: string /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. */ - readonly currency: string; + readonly currency: string /** @description The ID of the customer that the bank account is associated with. */ - readonly customer?: string; + readonly customer?: string /** @description Whether this bank account is the default external account for its currency. */ - readonly default_for_currency?: boolean; + readonly default_for_currency?: boolean /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - readonly fingerprint?: string; + readonly fingerprint?: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description The last four digits of the bank account number. */ - readonly last4: string; + readonly last4: string /** @description 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. */ - readonly metadata?: { readonly [key: string]: unknown }; + readonly metadata?: { readonly [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "bank_account"; - }; + readonly object: 'bank_account' + } /** Fee */ readonly fee: { /** @description Amount of the fee, in cents. */ - readonly amount: number; + readonly amount: number /** @description ID of the Connect application that earned the fee. */ - readonly application?: string; + readonly application?: string /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string; + readonly description?: string /** @description Type of the fee, one of: `application_fee`, `stripe_fee` or `tax`. */ - readonly type: string; - }; + readonly type: string + } /** * FeeRefund * @description `Application Fee Refund` objects allow you to refund an application fee that @@ -3690,25 +3673,25 @@ export interface definitions { */ readonly fee_refund: { /** @description Amount, in %s. */ - readonly amount: number; + readonly amount: number /** @description Balance transaction that describes the impact on your account balance. */ - readonly balance_transaction?: string; + readonly balance_transaction?: string /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description ID of the application fee that was refunded. */ - readonly fee: string; + readonly fee: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description 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. */ - readonly metadata: { readonly [key: string]: unknown }; + readonly metadata: { readonly [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "fee_refund"; - }; + readonly object: 'fee_refund' + } /** * File * @description This is an object representing a file hosted on Stripe's servers. The @@ -3721,44 +3704,44 @@ export interface definitions { */ readonly file: { /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description A filename for the file, suitable for saving to a filesystem. */ - readonly filename?: string; + readonly filename?: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * FileFileLinkList * @description A list of [file links](https://stripe.com/docs/api#file_links) that point at this file. */ readonly links?: { /** @description Details about each object. */ - readonly data: readonly definitions["file_link"][]; + readonly data: readonly definitions['file_link'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; + readonly url: string + } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "file"; + readonly object: 'file' /** @description The purpose of the file. Possible values are `additional_verification`, `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `finance_report_run`, `identity_document`, `pci_document`, `sigma_scheduled_query`, or `tax_document_user_upload`. */ - readonly purpose: string; + readonly purpose: string /** @description The size in bytes of the file object. */ - readonly size: number; + readonly size: number /** @description A user friendly title for the document. */ - readonly title?: string; + readonly title?: string /** @description The type of the file returned (e.g., `csv`, `pdf`, `jpg`, or `png`). */ - readonly type?: string; + readonly type?: string /** @description The URL from which the file can be downloaded using your live secret API key. */ - readonly url?: string; - }; + readonly url?: string + } /** * FileLink * @description To share the contents of a `File` object with non-Stripe users, you can @@ -3767,55 +3750,55 @@ export interface definitions { */ readonly file_link: { /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description Whether this link is already expired. */ - readonly expired: boolean; + readonly expired: boolean /** @description Time at which the link expires. */ - readonly expires_at?: number; + readonly expires_at?: number /** @description The file object this link points to. */ - readonly file: string; + readonly file: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata: { readonly [key: string]: unknown }; + readonly metadata: { readonly [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "file_link"; + readonly object: 'file_link' /** @description The publicly accessible URL to download the file. */ - readonly url?: string; - }; + readonly url?: string + } /** FinancialReportingFinanceReportRunRunParameters */ readonly financial_reporting_finance_report_run_run_parameters: { /** @description The set of output columns requested for inclusion in the report run. */ - readonly columns?: readonly string[]; + readonly columns?: readonly string[] /** @description Connected account ID by which to filter the report run. */ - readonly connected_account?: string; + readonly connected_account?: string /** @description Currency of objects to be included in the report run. */ - readonly currency?: string; + readonly currency?: string /** @description Ending timestamp of data to be included in the report run (exclusive). */ - readonly interval_end?: number; + readonly interval_end?: number /** @description Starting timestamp of data to be included in the report run. */ - readonly interval_start?: number; + readonly interval_start?: number /** @description Payout ID by which to filter the report run. */ - readonly payout?: string; + readonly payout?: string /** @description Category of balance transactions to be included in the report run. */ - readonly reporting_category?: string; + readonly reporting_category?: string /** @description 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`. */ - readonly timezone?: string; - }; + readonly timezone?: string + } /** Inventory */ readonly inventory: { /** @description The count of inventory available. Will be present if and only if `type` is `finite`. */ - readonly quantity?: number; + readonly quantity?: number /** @description Inventory type. Possible values are `finite`, `bucket` (not quantified), and `infinite`. */ - readonly type: string; + readonly type: string /** @description An indicator of the inventory available. Possible values are `in_stock`, `limited`, and `out_of_stock`. Will be present if and only if `type` is `bucket`. */ - readonly value?: string; - }; + readonly value?: string + } /** * Invoice * @description Invoices are statements of amounts owed by a customer, and are either @@ -3853,210 +3836,210 @@ export interface definitions { */ readonly invoice: { /** @description The country of the business associated with this invoice, most often the business creating the invoice. */ - readonly account_country?: string; + readonly account_country?: string /** @description The public name of the business associated with this invoice, most often the business creating the invoice. */ - readonly account_name?: string; + readonly account_name?: string /** @description 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`. */ - readonly amount_due: number; + readonly amount_due: number /** @description The amount, in %s, that was paid. */ - readonly amount_paid: number; + readonly amount_paid: number /** @description The amount remaining, in %s, that is due. */ - readonly amount_remaining: number; + readonly amount_remaining: number /** @description The fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account when the invoice is paid. */ - readonly application_fee_amount?: number; + readonly application_fee_amount?: number /** @description 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. */ - readonly attempt_count: number; + readonly attempt_count: number /** @description 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. */ - readonly attempted: boolean; + readonly attempted: boolean /** @description Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice. When `false`, the invoice's state will not automatically advance without an explicit action. */ - readonly auto_advance?: boolean; + readonly auto_advance?: boolean /** * @description Indicates the reason why the invoice was created. `subscription_cycle` indicates an invoice created by a subscription advancing into a new period. `subscription_create` indicates an invoice created due to creating a subscription. `subscription_update` indicates an invoice created due to updating a subscription. `subscription` is set for all old invoices to indicate either a change to a subscription or a period advancement. `manual` is set for all invoices unrelated to a subscription (for example: created via the invoice editor). The `upcoming` value is reserved for simulated invoices per the upcoming invoice endpoint. `subscription_threshold` indicates an invoice created due to a billing threshold being reached. * @enum {string} */ readonly billing_reason?: - | "automatic_pending_invoice_item_invoice" - | "manual" - | "subscription" - | "subscription_create" - | "subscription_cycle" - | "subscription_threshold" - | "subscription_update" - | "upcoming"; + | 'automatic_pending_invoice_item_invoice' + | 'manual' + | 'subscription' + | 'subscription_create' + | 'subscription_cycle' + | 'subscription_threshold' + | 'subscription_update' + | 'upcoming' /** @description ID of the latest charge generated for this invoice, if any. */ - readonly charge?: string; + readonly charge?: string /** * @description 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. * @enum {string} */ - readonly collection_method?: "charge_automatically" | "send_invoice"; + readonly collection_method?: 'charge_automatically' | 'send_invoice' /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description Custom fields displayed on the invoice. */ - readonly custom_fields?: readonly definitions["invoice_setting_custom_field"][]; + readonly custom_fields?: readonly definitions['invoice_setting_custom_field'][] /** @description The ID of the customer who will be billed. */ - readonly customer: string; - readonly customer_address?: definitions["address"]; + readonly customer: string + readonly customer_address?: definitions['address'] /** @description 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. */ - readonly customer_email?: string; + readonly customer_email?: string /** @description 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. */ - readonly customer_name?: string; + readonly customer_name?: string /** @description 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. */ - readonly customer_phone?: string; - readonly customer_shipping?: definitions["shipping"]; + readonly customer_phone?: string + readonly customer_shipping?: definitions['shipping'] /** * @description 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. * @enum {string} */ - readonly customer_tax_exempt?: "exempt" | "none" | "reverse"; + readonly customer_tax_exempt?: 'exempt' | 'none' | 'reverse' /** @description 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. */ - readonly customer_tax_ids?: readonly definitions["invoices_resource_invoice_tax_id"][]; + readonly customer_tax_ids?: readonly definitions['invoices_resource_invoice_tax_id'][] /** @description 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. */ - readonly default_payment_method?: string; + readonly default_payment_method?: string /** @description 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. */ - readonly default_source?: string; + readonly default_source?: string /** @description The tax rates applied to this invoice, if any. */ - readonly default_tax_rates?: readonly definitions["tax_rate"][]; + readonly default_tax_rates?: readonly definitions['tax_rate'][] /** @description An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. */ - readonly description?: string; - readonly discount?: definitions["discount"]; + readonly description?: string + readonly discount?: definitions['discount'] /** @description The date on which payment for this invoice is due. This value will be `null` for invoices where `collection_method=charge_automatically`. */ - readonly due_date?: number; + readonly due_date?: number /** @description 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. */ - readonly ending_balance?: number; + readonly ending_balance?: number /** @description Footer displayed on the invoice. */ - readonly footer?: string; + readonly footer?: string /** @description 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. */ - readonly hosted_invoice_url?: string; + readonly hosted_invoice_url?: string /** @description Unique identifier for the object. */ - readonly id?: string; + readonly id?: string /** @description The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null. */ - readonly invoice_pdf?: string; + readonly invoice_pdf?: string /** * InvoiceLinesList * @description The individual line items that make up the invoice. `lines` is sorted as follows: invoice items in reverse chronological order, followed by the subscription, if any. */ readonly lines: { /** @description Details about each object. */ - readonly data: readonly definitions["line_item"][]; + readonly data: readonly definitions['line_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; + readonly url: string + } /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata?: { readonly [key: string]: unknown }; + readonly metadata?: { readonly [key: string]: unknown } /** @description The time at which payment will next be attempted. This value will be `null` for invoices where `collection_method=send_invoice`. */ - readonly next_payment_attempt?: number; + readonly next_payment_attempt?: number /** @description 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. */ - readonly number?: string; + readonly number?: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "invoice"; + readonly object: 'invoice' /** @description 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. */ - readonly paid: boolean; + readonly paid: boolean /** @description 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. */ - readonly payment_intent?: string; + readonly payment_intent?: string /** @description End of the usage period during which invoice items were added to this invoice. */ - readonly period_end: number; + readonly period_end: number /** @description Start of the usage period during which invoice items were added to this invoice. */ - readonly period_start: number; + readonly period_start: number /** @description Total amount of all post-payment credit notes issued for this invoice. */ - readonly post_payment_credit_notes_amount: number; + readonly post_payment_credit_notes_amount: number /** @description Total amount of all pre-payment credit notes issued for this invoice. */ - readonly pre_payment_credit_notes_amount: number; + readonly pre_payment_credit_notes_amount: number /** @description This is the transaction number that appears on email receipts sent for this invoice. */ - readonly receipt_number?: string; + readonly receipt_number?: string /** @description Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. */ - readonly starting_balance: number; + readonly starting_balance: number /** @description Extra information about an invoice for the customer's credit card statement. */ - readonly statement_descriptor?: string; + readonly statement_descriptor?: string /** * @description The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview) * @enum {string} */ - readonly status?: "deleted" | "draft" | "open" | "paid" | "uncollectible" | "void"; - readonly status_transitions: definitions["invoices_status_transitions"]; + readonly status?: 'deleted' | 'draft' | 'open' | 'paid' | 'uncollectible' | 'void' + readonly status_transitions: definitions['invoices_status_transitions'] /** @description The subscription that this invoice was prepared for, if any. */ - readonly subscription?: string; + readonly subscription?: string /** @description Only set for upcoming invoices that preview prorations. The time used to calculate prorations. */ - readonly subscription_proration_date?: number; + readonly subscription_proration_date?: number /** @description Total of all subscriptions, invoice items, and prorations on the invoice before any discount or tax is applied. */ - readonly subtotal: number; + readonly subtotal: number /** @description The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice. */ - readonly tax?: number; + readonly tax?: number /** @description This percentage of the subtotal has been added to the total amount of the invoice, including invoice line items and discounts. This field is inherited from the subscription's `tax_percent` field, but can be changed before the invoice is paid. This field defaults to null. */ - readonly tax_percent?: number; - readonly threshold_reason?: definitions["invoice_threshold_reason"]; + readonly tax_percent?: number + readonly threshold_reason?: definitions['invoice_threshold_reason'] /** @description Total after discounts and taxes. */ - readonly total: number; + readonly total: number /** @description The aggregate amounts calculated per tax rate for all line items. */ - readonly total_tax_amounts?: readonly definitions["invoice_tax_amount"][]; + readonly total_tax_amounts?: readonly definitions['invoice_tax_amount'][] /** @description 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. */ - readonly webhooks_delivered_at?: number; - }; + readonly webhooks_delivered_at?: number + } /** InvoiceItemThresholdReason */ readonly invoice_item_threshold_reason: { /** @description The IDs of the line items that triggered the threshold invoice. */ - readonly line_item_ids: readonly string[]; + readonly line_item_ids: readonly string[] /** @description The quantity threshold boundary that applied to the given line item. */ - readonly usage_gte: number; - }; + readonly usage_gte: number + } /** InvoiceLineItemPeriod */ readonly invoice_line_item_period: { /** @description End of the line item's billing period */ - readonly end: number; + readonly end: number /** @description Start of the line item's billing period */ - readonly start: number; - }; + readonly start: number + } /** InvoiceSettingCustomField */ readonly invoice_setting_custom_field: { /** @description The name of the custom field. */ - readonly name: string; + readonly name: string /** @description The value of the custom field. */ - readonly value: string; - }; + readonly value: string + } /** InvoiceSettingCustomerSetting */ readonly invoice_setting_customer_setting: { /** @description Default custom fields to be displayed on invoices for this customer. */ - readonly custom_fields?: readonly definitions["invoice_setting_custom_field"][]; + readonly custom_fields?: readonly definitions['invoice_setting_custom_field'][] /** @description 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. */ - readonly default_payment_method?: string; + readonly default_payment_method?: string /** @description Default footer to be displayed on invoices for this customer. */ - readonly footer?: string; - }; + readonly footer?: string + } /** InvoiceSettingSubscriptionScheduleSetting */ readonly invoice_setting_subscription_schedule_setting: { /** @description 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`. */ - readonly days_until_due?: number; - }; + readonly days_until_due?: number + } /** InvoiceTaxAmount */ readonly invoice_tax_amount: { /** @description The amount, in %s, of the tax. */ - readonly amount: number; + readonly amount: number /** @description Whether this tax amount is inclusive or exclusive. */ - readonly inclusive: boolean; + readonly inclusive: boolean /** @description The tax rate that was applied to get this tax amount. */ - readonly tax_rate: string; - }; + readonly tax_rate: string + } /** InvoiceThresholdReason */ readonly invoice_threshold_reason: { /** @description The total invoice amount threshold boundary if it triggered the threshold invoice. */ - readonly amount_gte?: number; + readonly amount_gte?: number /** @description Indicates which line items triggered a threshold invoice. */ - readonly item_reasons: readonly definitions["invoice_item_threshold_reason"][]; - }; + readonly item_reasons: readonly definitions['invoice_item_threshold_reason'][] + } /** * InvoiceItem * @description Sometimes you want to add a charge or credit to a customer, but actually @@ -4069,47 +4052,47 @@ export interface definitions { */ readonly invoiceitem: { /** @description Amount (in the `currency` specified) of the invoice item. This should always be equal to `unit_amount * quantity`. */ - readonly amount: number; + readonly amount: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description The ID of the customer who will be billed when this invoice item is billed. */ - readonly customer: string; + readonly customer: string /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly date: number; + readonly date: number /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string; + readonly description?: string /** @description If true, discounts will apply to this invoice item. Always false for prorations. */ - readonly discountable: boolean; + readonly discountable: boolean /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description The ID of the invoice this invoice item belongs to. */ - readonly invoice?: string; + readonly invoice?: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata: { readonly [key: string]: unknown }; + readonly metadata: { readonly [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "invoiceitem"; - readonly period: definitions["invoice_line_item_period"]; - readonly plan?: definitions["plan"]; + readonly object: 'invoiceitem' + readonly period: definitions['invoice_line_item_period'] + readonly plan?: definitions['plan'] /** @description Whether the invoice item was created automatically as a proration adjustment when the customer switched plans. */ - readonly proration: boolean; + readonly proration: boolean /** @description 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. */ - readonly quantity: number; + readonly quantity: number /** @description The subscription that this invoice item has been created for, if any. */ - readonly subscription?: string; + readonly subscription?: string /** @description The subscription item that this invoice item has been created for, if any. */ - readonly subscription_item?: string; + readonly subscription_item?: string /** @description 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. */ - readonly tax_rates?: readonly definitions["tax_rate"][]; + readonly tax_rates?: readonly definitions['tax_rate'][] /** @description Unit Amount (in the `currency` specified) of the invoice item. */ - readonly unit_amount?: number; + readonly unit_amount?: number /** @description Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. */ - readonly unit_amount_decimal?: string; - }; + readonly unit_amount_decimal?: string + } /** InvoicesResourceInvoiceTaxID */ readonly invoices_resource_invoice_tax_id: { /** @@ -4117,44 +4100,44 @@ export interface definitions { * @enum {string} */ readonly type: - | "au_abn" - | "ca_bn" - | "ca_qst" - | "ch_vat" - | "es_cif" - | "eu_vat" - | "hk_br" - | "in_gst" - | "jp_cn" - | "kr_brn" - | "li_uid" - | "mx_rfc" - | "my_itn" - | "my_sst" - | "no_vat" - | "nz_gst" - | "ru_inn" - | "sg_gst" - | "sg_uen" - | "th_vat" - | "tw_vat" - | "unknown" - | "us_ein" - | "za_vat"; + | 'au_abn' + | 'ca_bn' + | 'ca_qst' + | 'ch_vat' + | 'es_cif' + | 'eu_vat' + | 'hk_br' + | 'in_gst' + | 'jp_cn' + | 'kr_brn' + | 'li_uid' + | 'mx_rfc' + | 'my_itn' + | 'my_sst' + | 'no_vat' + | 'nz_gst' + | 'ru_inn' + | 'sg_gst' + | 'sg_uen' + | 'th_vat' + | 'tw_vat' + | 'unknown' + | 'us_ein' + | 'za_vat' /** @description The value of the tax ID. */ - readonly value?: string; - }; + readonly value?: string + } /** InvoicesStatusTransitions */ readonly invoices_status_transitions: { /** @description The time that the invoice draft was finalized. */ - readonly finalized_at?: number; + readonly finalized_at?: number /** @description The time that the invoice was marked uncollectible. */ - readonly marked_uncollectible_at?: number; + readonly marked_uncollectible_at?: number /** @description The time that the invoice was paid. */ - readonly paid_at?: number; + readonly paid_at?: number /** @description The time that the invoice was voided. */ - readonly voided_at?: number; - }; + readonly voided_at?: number + } /** * IssuerFraudRecord * @description This resource has been renamed to [Early Fraud @@ -4163,27 +4146,27 @@ export interface definitions { */ readonly issuer_fraud_record: { /** @description An IFR 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 IFR, in order to avoid receiving a dispute later. */ - readonly actionable: boolean; + readonly actionable: boolean /** @description ID of the charge this issuer fraud record is for, optionally expanded. */ - readonly charge: string; + readonly charge: string /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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`. */ - readonly fraud_type: string; + readonly fraud_type: string /** @description If true, the associated charge is subject to [liability shift](https://stripe.com/docs/payments/3d-secure#disputed-payments). */ - readonly has_liability_shift: boolean; + readonly has_liability_shift: boolean /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "issuer_fraud_record"; + readonly object: 'issuer_fraud_record' /** @description The timestamp at which the card issuer posted the issuer fraud record. */ - readonly post_date: number; - }; + readonly post_date: number + } /** * IssuingAuthorization * @description When an [issued card](https://stripe.com/docs/issuing) is used to make a purchase, an Issuing `Authorization` @@ -4192,218 +4175,218 @@ export interface definitions { * * Related guide: [Issued Card Authorizations](https://stripe.com/docs/issuing/purchases/authorizations). */ - readonly "issuing.authorization": { + readonly 'issuing.authorization': { /** @description The total amount that was authorized or rejected. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ - readonly amount: number; + readonly amount: number /** @description Whether the authorization has been approved. */ - readonly approved: boolean; + readonly approved: boolean /** * @description How the card details were provided. * @enum {string} */ - readonly authorization_method: "chip" | "contactless" | "keyed_in" | "online" | "swipe"; + readonly authorization_method: 'chip' | 'contactless' | 'keyed_in' | 'online' | 'swipe' /** @description List of balance transactions associated with this authorization. */ - readonly balance_transactions: readonly definitions["balance_transaction"][]; - readonly card: definitions["issuing.card"]; + readonly balance_transactions: readonly definitions['balance_transaction'][] + readonly card: definitions['issuing.card'] /** @description The cardholder to whom this authorization belongs. */ - readonly cardholder?: string; + readonly cardholder?: string /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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). */ - readonly merchant_amount: number; + readonly merchant_amount: number /** @description The currency that was 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). */ - readonly merchant_currency: string; - readonly merchant_data: definitions["issuing_authorization_merchant_data"]; + readonly merchant_currency: string + readonly merchant_data: definitions['issuing_authorization_merchant_data'] /** @description 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. */ - readonly metadata: { readonly [key: string]: unknown }; + readonly metadata: { readonly [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "issuing.authorization"; - readonly pending_request?: definitions["issuing_authorization_pending_request"]; + readonly object: 'issuing.authorization' + readonly pending_request?: definitions['issuing_authorization_pending_request'] /** @description History of every time the authorization was approved/denied (whether approved/denied by you directly or by Stripe based on your `spending_controls`). If the merchant changes the authorization by performing an [incremental authorization or partial capture](https://stripe.com/docs/issuing/purchases/authorizations), you can look at this field to see the previous states of the authorization. */ - readonly request_history: readonly definitions["issuing_authorization_request"][]; + readonly request_history: readonly definitions['issuing_authorization_request'][] /** * @description The current status of the authorization in its lifecycle. * @enum {string} */ - readonly status: "closed" | "pending" | "reversed"; + readonly status: 'closed' | 'pending' | 'reversed' /** @description List of [transactions](https://stripe.com/docs/api/issuing/transactions) associated with this authorization. */ - readonly transactions: readonly definitions["issuing.transaction"][]; - readonly verification_data: definitions["issuing_authorization_verification_data"]; + readonly transactions: readonly definitions['issuing.transaction'][] + readonly verification_data: definitions['issuing_authorization_verification_data'] /** @description What, if any, digital wallet was used for this authorization. One of `apple_pay`, `google_pay`, or `samsung_pay`. */ - readonly wallet?: string; - }; + readonly wallet?: string + } /** * IssuingCard * @description You can [create physical or virtual cards](https://stripe.com/docs/issuing/cards) that are issued to cardholders. */ - readonly "issuing.card": { + readonly 'issuing.card': { /** @description The brand of the card. */ - readonly brand: string; + readonly brand: string /** * @description The reason why the card was canceled. * @enum {string} */ - readonly cancellation_reason?: "lost" | "stolen"; - readonly cardholder: definitions["issuing.cardholder"]; + readonly cancellation_reason?: 'lost' | 'stolen' + readonly cardholder: definitions['issuing.cardholder'] /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description 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. */ - readonly cvc?: string; + readonly cvc?: string /** @description The expiration month of the card. */ - readonly exp_month: number; + readonly exp_month: number /** @description The expiration year of the card. */ - readonly exp_year: number; + readonly exp_year: number /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description The last 4 digits of the card number. */ - readonly last4: string; + readonly last4: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata: { readonly [key: string]: unknown }; + readonly metadata: { readonly [key: string]: unknown } /** @description 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. */ - readonly number?: string; + readonly number?: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "issuing.card"; + readonly object: 'issuing.card' /** @description The latest card that replaces this card, if any. */ - readonly replaced_by?: string; + readonly replaced_by?: string /** @description The card this card replaces, if any. */ - readonly replacement_for?: string; + readonly replacement_for?: string /** * @description The reason why the previous card needed to be replaced. * @enum {string} */ - readonly replacement_reason?: "damaged" | "expired" | "lost" | "stolen"; - readonly shipping?: definitions["issuing_card_shipping"]; - readonly spending_controls: definitions["issuing_card_authorization_controls"]; + readonly replacement_reason?: 'damaged' | 'expired' | 'lost' | 'stolen' + readonly shipping?: definitions['issuing_card_shipping'] + readonly spending_controls: definitions['issuing_card_authorization_controls'] /** * @description Whether authorizations can be approved on this card. * @enum {string} */ - readonly status: "active" | "canceled" | "inactive"; + readonly status: 'active' | 'canceled' | 'inactive' /** * @description The type of the card. * @enum {string} */ - readonly type: "physical" | "virtual"; - }; + readonly type: 'physical' | 'virtual' + } /** * IssuingCardholder * @description An Issuing `Cardholder` object represents an individual or business entity who is [issued](https://stripe.com/docs/issuing) cards. * * Related guide: [How to create a Cardholder](https://stripe.com/docs/issuing/cards#create-cardholder) */ - readonly "issuing.cardholder": { - readonly billing: definitions["issuing_cardholder_address"]; - readonly company?: definitions["issuing_cardholder_company"]; + readonly 'issuing.cardholder': { + readonly billing: definitions['issuing_cardholder_address'] + readonly company?: definitions['issuing_cardholder_company'] /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description The cardholder's email address. */ - readonly email?: string; + readonly email?: string /** @description Unique identifier for the object. */ - readonly id: string; - readonly individual?: definitions["issuing_cardholder_individual"]; + readonly id: string + readonly individual?: definitions['issuing_cardholder_individual'] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata: { readonly [key: string]: unknown }; + readonly metadata: { readonly [key: string]: unknown } /** @description The cardholder's name. This will be printed on cards issued to them. */ - readonly name: string; + readonly name: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "issuing.cardholder"; + readonly object: 'issuing.cardholder' /** @description The cardholder's phone number. */ - readonly phone_number?: string; - readonly requirements: definitions["issuing_cardholder_requirements"]; - readonly spending_controls?: definitions["issuing_cardholder_authorization_controls"]; + readonly phone_number?: string + readonly requirements: definitions['issuing_cardholder_requirements'] + readonly spending_controls?: definitions['issuing_cardholder_authorization_controls'] /** * @description Specifies whether to permit authorizations on this cardholder's cards. * @enum {string} */ - readonly status: "active" | "blocked" | "inactive"; + readonly status: 'active' | 'blocked' | 'inactive' /** * @description One of `individual` or `company`. * @enum {string} */ - readonly type: "company" | "individual"; - }; + readonly type: 'company' | 'individual' + } /** * IssuingDispute * @description As a [card issuer](https://stripe.com/docs/issuing), you can [dispute](https://stripe.com/docs/issuing/purchases/disputes) transactions that you do not recognize, suspect to be fraudulent, or have some other issue. * * Related guide: [Disputing Transactions](https://stripe.com/docs/issuing/purchases/disputes) */ - readonly "issuing.dispute": { + readonly 'issuing.dispute': { /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "issuing.dispute"; - }; + readonly object: 'issuing.dispute' + } /** * IssuingSettlement * @description 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. */ - readonly "issuing.settlement": { + readonly 'issuing.settlement': { /** @description The Bank Identification Number reflecting this settlement record. */ - readonly bin: string; + readonly bin: string /** @description The date that the transactions are cleared and posted to user's accounts. */ - readonly clearing_date: number; + readonly clearing_date: number /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description The total interchange received as reimbursement for the transactions. */ - readonly interchange_fees: number; + readonly interchange_fees: number /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata: { readonly [key: string]: unknown }; + readonly metadata: { readonly [key: string]: unknown } /** @description The total net amount required to settle with the network. */ - readonly net_total: number; + readonly net_total: number /** * @description The card network for this settlement report. One of ["visa"] * @enum {string} */ - readonly network: "visa"; + readonly network: 'visa' /** @description The total amount of fees owed to the network. */ - readonly network_fees: number; + readonly network_fees: number /** @description The Settlement Identification Number assigned by the network. */ - readonly network_settlement_identifier: string; + readonly network_settlement_identifier: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "issuing.settlement"; + readonly object: 'issuing.settlement' /** @description One of `international` or `uk_national_net`. */ - readonly settlement_service: string; + readonly settlement_service: string /** @description The total number of transactions reflected in this settlement. */ - readonly transaction_count: number; + readonly transaction_count: number /** @description The total transaction amount reflected in this settlement. */ - readonly transaction_volume: number; - }; + readonly transaction_volume: number + } /** * IssuingTransaction * @description Any use of an [issued card](https://stripe.com/docs/issuing) that results in funds entering or leaving @@ -4412,2247 +4395,2247 @@ export interface definitions { * * Related guide: [Issued Card Transactions](https://stripe.com/docs/issuing/purchases/transactions). */ - readonly "issuing.transaction": { + readonly 'issuing.transaction': { /** @description 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). */ - readonly amount: number; + readonly amount: number /** @description The `Authorization` object that led to this transaction. */ - readonly authorization?: string; + readonly authorization?: string /** @description ID of the [balance transaction](https://stripe.com/docs/api/balance_transactions) associated with this transaction. */ - readonly balance_transaction?: string; + readonly balance_transaction?: string /** @description The card used to make this transaction. */ - readonly card: string; + readonly card: string /** @description The cardholder to whom this transaction belongs. */ - readonly cardholder?: string; + readonly cardholder?: string /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly merchant_amount: number; + readonly merchant_amount: number /** @description The currency with which the merchant is taking payment. */ - readonly merchant_currency: string; - readonly merchant_data: definitions["issuing_authorization_merchant_data"]; + readonly merchant_currency: string + readonly merchant_data: definitions['issuing_authorization_merchant_data'] /** @description 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. */ - readonly metadata: { readonly [key: string]: unknown }; + readonly metadata: { readonly [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "issuing.transaction"; + readonly object: 'issuing.transaction' /** * @description The nature of the transaction. * @enum {string} */ - readonly type: "capture" | "refund"; - }; + readonly type: 'capture' | 'refund' + } /** IssuingAuthorizationMerchantData */ readonly issuing_authorization_merchant_data: { /** @description 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. */ - readonly category: string; + readonly category: string /** @description City where the seller is located */ - readonly city?: string; + readonly city?: string /** @description Country where the seller is located */ - readonly country?: string; + readonly country?: string /** @description Name of the seller */ - readonly name?: string; + readonly name?: string /** @description Identifier assigned to the seller by the card brand */ - readonly network_id: string; + readonly network_id: string /** @description Postal code where the seller is located */ - readonly postal_code?: string; + readonly postal_code?: string /** @description State where the seller is located */ - readonly state?: string; - }; + readonly state?: string + } /** IssuingAuthorizationPendingRequest */ readonly issuing_authorization_pending_request: { /** @description 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). */ - readonly amount: number; + readonly amount: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description 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. */ - readonly is_amount_controllable: boolean; + readonly is_amount_controllable: boolean /** @description 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). */ - readonly merchant_amount: number; + readonly merchant_amount: number /** @description The local currency the merchant is requesting to authorize. */ - readonly merchant_currency: string; - }; + readonly merchant_currency: string + } /** IssuingAuthorizationRequest */ readonly issuing_authorization_request: { /** @description The authorization amount 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. */ - readonly amount: number; + readonly amount: number /** @description Whether this request was approved. */ - readonly approved: boolean; + readonly approved: boolean /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description The amount that was authorized at the time of this request. This amount is in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ - readonly merchant_amount: number; + readonly merchant_amount: number /** @description 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). */ - readonly merchant_currency: string; + readonly merchant_currency: string /** * @description The reason for the approval or decline. * @enum {string} */ readonly reason: - | "account_disabled" - | "card_active" - | "card_inactive" - | "cardholder_inactive" - | "cardholder_verification_required" - | "insufficient_funds" - | "not_allowed" - | "spending_controls" - | "suspected_fraud" - | "verification_failed" - | "webhook_approved" - | "webhook_declined" - | "webhook_timeout"; - }; + | 'account_disabled' + | 'card_active' + | 'card_inactive' + | 'cardholder_inactive' + | 'cardholder_verification_required' + | 'insufficient_funds' + | 'not_allowed' + | 'spending_controls' + | 'suspected_fraud' + | 'verification_failed' + | 'webhook_approved' + | 'webhook_declined' + | 'webhook_timeout' + } /** IssuingAuthorizationVerificationData */ readonly issuing_authorization_verification_data: { /** * @description Whether the cardholder provided an address first line and if it matched the cardholder’s `billing.address.line1`. * @enum {string} */ - readonly address_line1_check: "match" | "mismatch" | "not_provided"; + readonly address_line1_check: 'match' | 'mismatch' | 'not_provided' /** * @description Whether the cardholder provided a postal code and if it matched the cardholder’s `billing.address.postal_code`. * @enum {string} */ - readonly address_postal_code_check: "match" | "mismatch" | "not_provided"; + readonly address_postal_code_check: 'match' | 'mismatch' | 'not_provided' /** * @description Whether the cardholder provided a CVC and if it matched Stripe’s record. * @enum {string} */ - readonly cvc_check: "match" | "mismatch" | "not_provided"; + readonly cvc_check: 'match' | 'mismatch' | 'not_provided' /** * @description Whether the cardholder provided an expiry date and if it matched Stripe’s record. * @enum {string} */ - readonly expiry_check: "match" | "mismatch" | "not_provided"; - }; + readonly expiry_check: 'match' | 'mismatch' | 'not_provided' + } /** IssuingCardAuthorizationControls */ readonly issuing_card_authorization_controls: { /** @description Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations permitted on this card. */ readonly allowed_categories?: readonly ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] /** @description Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to always decline on this card. */ readonly blocked_categories?: readonly ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] /** @description Limit the spending with rules based on time intervals and categories. */ - readonly spending_limits?: readonly definitions["issuing_card_spending_limit"][]; + readonly spending_limits?: readonly definitions['issuing_card_spending_limit'][] /** @description Currency for the amounts within spending_limits. Locked to the currency of the card. */ - readonly spending_limits_currency?: string; - }; + readonly spending_limits_currency?: string + } /** IssuingCardShipping */ readonly issuing_card_shipping: { - readonly address: definitions["address"]; + readonly address: definitions['address'] /** * @description The delivery company that shipped a card. * @enum {string} */ - readonly carrier?: "fedex" | "usps"; + readonly carrier?: 'fedex' | 'usps' /** @description A unix timestamp representing a best estimate of when the card will be delivered. */ - readonly eta?: number; + readonly eta?: number /** @description Recipient name. */ - readonly name: string; + readonly name: string /** * @description Shipment service, such as `standard` or `express`. * @enum {string} */ - readonly service: "express" | "priority" | "standard"; + readonly service: 'express' | 'priority' | 'standard' /** * @description The delivery status of the card. * @enum {string} */ - readonly status?: "canceled" | "delivered" | "failure" | "pending" | "returned" | "shipped"; + readonly status?: 'canceled' | 'delivered' | 'failure' | 'pending' | 'returned' | 'shipped' /** @description A tracking number for a card shipment. */ - readonly tracking_number?: string; + readonly tracking_number?: string /** @description A link to the shipping carrier's site where you can view detailed information about a card shipment. */ - readonly tracking_url?: string; + readonly tracking_url?: string /** * @description Packaging options. * @enum {string} */ - readonly type: "bulk" | "individual"; - }; + readonly type: 'bulk' | 'individual' + } /** IssuingCardSpendingLimit */ readonly issuing_card_spending_limit: { /** @description Maximum amount allowed to spend per time interval. */ - readonly amount: number; + readonly amount: number /** @description Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) on which to apply the spending limit. Leave this blank to limit all charges. */ readonly categories?: readonly ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] /** * @description The time interval or event with which to apply this spending limit towards. * @enum {string} */ - readonly interval: "all_time" | "daily" | "monthly" | "per_authorization" | "weekly" | "yearly"; - }; + readonly interval: 'all_time' | 'daily' | 'monthly' | 'per_authorization' | 'weekly' | 'yearly' + } /** IssuingCardholderAddress */ readonly issuing_cardholder_address: { - readonly address: definitions["address"]; - }; + readonly address: definitions['address'] + } /** IssuingCardholderAuthorizationControls */ readonly issuing_cardholder_authorization_controls: { /** @description Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations permitted on this cardholder's cards. */ readonly allowed_categories?: readonly ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] /** @description Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to always decline on this cardholder's cards. */ readonly blocked_categories?: readonly ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] /** @description Limit the spending with rules based on time intervals and categories. */ - readonly spending_limits?: readonly definitions["issuing_cardholder_spending_limit"][]; + readonly spending_limits?: readonly definitions['issuing_cardholder_spending_limit'][] /** @description Currency for the amounts within spending_limits. */ - readonly spending_limits_currency?: string; - }; + readonly spending_limits_currency?: string + } /** IssuingCardholderCompany */ readonly issuing_cardholder_company: { /** @description Whether the company's business ID number was provided. */ - readonly tax_id_provided: boolean; - }; + readonly tax_id_provided: boolean + } /** IssuingCardholderIdDocument */ readonly issuing_cardholder_id_document: { /** @description The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. */ - readonly back?: string; + readonly back?: string /** @description The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. */ - readonly front?: string; - }; + readonly front?: string + } /** IssuingCardholderIndividual */ readonly issuing_cardholder_individual: { - readonly dob?: definitions["issuing_cardholder_individual_dob"]; + readonly dob?: definitions['issuing_cardholder_individual_dob'] /** @description The first name of this cardholder. */ - readonly first_name: string; + readonly first_name: string /** @description The last name of this cardholder. */ - readonly last_name: string; - readonly verification?: definitions["issuing_cardholder_verification"]; - }; + readonly last_name: string + readonly verification?: definitions['issuing_cardholder_verification'] + } /** IssuingCardholderIndividualDOB */ readonly issuing_cardholder_individual_dob: { /** @description The day of birth, between 1 and 31. */ - readonly day?: number; + readonly day?: number /** @description The month of birth, between 1 and 12. */ - readonly month?: number; + readonly month?: number /** @description The four-digit year of birth. */ - readonly year?: number; - }; + readonly year?: number + } /** IssuingCardholderRequirements */ readonly issuing_cardholder_requirements: { /** * @description If `disabled_reason` is present, all cards will decline authorizations with `cardholder_verification_required` reason. * @enum {string} */ - readonly disabled_reason?: "listed" | "rejected.listed" | "under_review"; + readonly disabled_reason?: 'listed' | 'rejected.listed' | 'under_review' /** @description Array of fields that need to be collected in order to verify and re-enable the cardholder. */ readonly past_due?: readonly ( - | "company.tax_id" - | "individual.dob.day" - | "individual.dob.month" - | "individual.dob.year" - | "individual.first_name" - | "individual.last_name" - | "individual.verification.document" - )[]; - }; + | 'company.tax_id' + | 'individual.dob.day' + | 'individual.dob.month' + | 'individual.dob.year' + | 'individual.first_name' + | 'individual.last_name' + | 'individual.verification.document' + )[] + } /** IssuingCardholderSpendingLimit */ readonly issuing_cardholder_spending_limit: { /** @description Maximum amount allowed to spend per time interval. */ - readonly amount: number; + readonly amount: number /** @description Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) on which to apply the spending limit. Leave this blank to limit all charges. */ readonly categories?: readonly ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] /** * @description The time interval or event with which to apply this spending limit towards. * @enum {string} */ - readonly interval: "all_time" | "daily" | "monthly" | "per_authorization" | "weekly" | "yearly"; - }; + readonly interval: 'all_time' | 'daily' | 'monthly' | 'per_authorization' | 'weekly' | 'yearly' + } /** IssuingCardholderVerification */ readonly issuing_cardholder_verification: { - readonly document?: definitions["issuing_cardholder_id_document"]; - }; + readonly document?: definitions['issuing_cardholder_id_document'] + } /** LegalEntityCompany */ readonly legal_entity_company: { - readonly address?: definitions["address"]; - readonly address_kana?: definitions["legal_entity_japan_address"]; - readonly address_kanji?: definitions["legal_entity_japan_address"]; + readonly address?: definitions['address'] + readonly address_kana?: definitions['legal_entity_japan_address'] + readonly address_kanji?: definitions['legal_entity_japan_address'] /** @description 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). */ - readonly directors_provided?: boolean; + readonly directors_provided?: boolean /** @description 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. */ - readonly executives_provided?: boolean; + readonly executives_provided?: boolean /** @description The company's legal name. */ - readonly name?: string; + readonly name?: string /** @description The Kana variation of the company's legal name (Japan only). */ - readonly name_kana?: string; + readonly name_kana?: string /** @description The Kanji variation of the company's legal name (Japan only). */ - readonly name_kanji?: string; + readonly name_kanji?: string /** @description 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). */ - readonly owners_provided?: boolean; + readonly owners_provided?: boolean /** @description The company's phone number (used for verification). */ - readonly phone?: string; + readonly phone?: string /** * @description 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. * @enum {string} */ readonly structure?: - | "government_instrumentality" - | "governmental_unit" - | "incorporated_non_profit" - | "limited_liability_partnership" - | "multi_member_llc" - | "private_company" - | "private_corporation" - | "private_partnership" - | "public_company" - | "public_corporation" - | "public_partnership" - | "sole_proprietorship" - | "tax_exempt_government_instrumentality" - | "unincorporated_association" - | "unincorporated_non_profit"; + | 'government_instrumentality' + | 'governmental_unit' + | 'incorporated_non_profit' + | 'limited_liability_partnership' + | 'multi_member_llc' + | 'private_company' + | 'private_corporation' + | 'private_partnership' + | 'public_company' + | 'public_corporation' + | 'public_partnership' + | 'sole_proprietorship' + | 'tax_exempt_government_instrumentality' + | 'unincorporated_association' + | 'unincorporated_non_profit' /** @description Whether the company's business ID number was provided. */ - readonly tax_id_provided?: boolean; + readonly tax_id_provided?: boolean /** @description The jurisdiction in which the `tax_id` is registered (Germany-based companies only). */ - readonly tax_id_registrar?: string; + readonly tax_id_registrar?: string /** @description Whether the company's business VAT number was provided. */ - readonly vat_id_provided?: boolean; - readonly verification?: definitions["legal_entity_company_verification"]; - }; + readonly vat_id_provided?: boolean + readonly verification?: definitions['legal_entity_company_verification'] + } /** LegalEntityCompanyVerification */ readonly legal_entity_company_verification: { - readonly document: definitions["legal_entity_company_verification_document"]; - }; + readonly document: definitions['legal_entity_company_verification_document'] + } /** LegalEntityCompanyVerificationDocument */ readonly legal_entity_company_verification_document: { /** @description The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. */ - readonly back?: string; + readonly back?: string /** @description A user-displayable string describing the verification state of this document. */ - readonly details?: string; + readonly details?: string /** @description 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. */ - readonly details_code?: string; + readonly details_code?: string /** @description The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. */ - readonly front?: string; - }; + readonly front?: string + } /** LegalEntityDOB */ readonly legal_entity_dob: { /** @description The day of birth, between 1 and 31. */ - readonly day?: number; + readonly day?: number /** @description The month of birth, between 1 and 12. */ - readonly month?: number; + readonly month?: number /** @description The four-digit year of birth. */ - readonly year?: number; - }; + readonly year?: number + } /** LegalEntityJapanAddress */ readonly legal_entity_japan_address: { /** @description City/Ward. */ - readonly city?: string; + readonly city?: string /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ - readonly country?: string; + readonly country?: string /** @description Block/Building number. */ - readonly line1?: string; + readonly line1?: string /** @description Building details. */ - readonly line2?: string; + readonly line2?: string /** @description ZIP or postal code. */ - readonly postal_code?: string; + readonly postal_code?: string /** @description Prefecture. */ - readonly state?: string; + readonly state?: string /** @description Town/cho-me. */ - readonly town?: string; - }; + readonly town?: string + } /** LegalEntityPersonVerification */ readonly legal_entity_person_verification: { - readonly additional_document?: definitions["legal_entity_person_verification_document"]; + readonly additional_document?: definitions['legal_entity_person_verification_document'] /** @description A user-displayable string describing the verification state for the person. For example, this may say "Provided identity information could not be verified". */ - readonly details?: string; + readonly details?: string /** @description 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. */ - readonly details_code?: string; - readonly document?: definitions["legal_entity_person_verification_document"]; + readonly details_code?: string + readonly document?: definitions['legal_entity_person_verification_document'] /** @description The state of verification for the person. Possible values are `unverified`, `pending`, or `verified`. */ - readonly status: string; - }; + readonly status: string + } /** LegalEntityPersonVerificationDocument */ readonly legal_entity_person_verification_document: { /** @description The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. */ - readonly back?: string; + readonly back?: string /** @description 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". */ - readonly details?: string; + readonly details?: string /** @description 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. */ - readonly details_code?: string; + readonly details_code?: string /** @description The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. */ - readonly front?: string; - }; + readonly front?: string + } /** LightAccountLogout */ - readonly light_account_logout: { readonly [key: string]: unknown }; + readonly light_account_logout: { readonly [key: string]: unknown } /** InvoiceLineItem */ readonly line_item: { /** @description The amount, in %s. */ - readonly amount: number; + readonly amount: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string; + readonly description?: string /** @description If true, discounts will apply to this line item. Always false for prorations. */ - readonly discountable: boolean; + readonly discountable: boolean /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description The ID of the [invoice item](https://stripe.com/docs/api/invoiceitems) associated with this line item if any. */ - readonly invoice_item?: string; + readonly invoice_item?: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. Note that for line items with `type=subscription` this will reflect the metadata of the subscription that caused the line item to be created. */ - readonly metadata: { readonly [key: string]: unknown }; + readonly metadata: { readonly [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "line_item"; - readonly period: definitions["invoice_line_item_period"]; - readonly plan?: definitions["plan"]; + readonly object: 'line_item' + readonly period: definitions['invoice_line_item_period'] + readonly plan?: definitions['plan'] /** @description Whether this is a proration. */ - readonly proration: boolean; + readonly proration: boolean /** @description The quantity of the subscription, if the line item is a subscription or a proration. */ - readonly quantity?: number; + readonly quantity?: number /** @description The subscription that the invoice item pertains to, if any. */ - readonly subscription?: string; + readonly subscription?: string /** @description The subscription item that generated this invoice item. Left empty if the line item is not an explicit result of a subscription. */ - readonly subscription_item?: string; + readonly subscription_item?: string /** @description The amount of tax calculated per tax rate for this line item */ - readonly tax_amounts?: readonly definitions["invoice_tax_amount"][]; + readonly tax_amounts?: readonly definitions['invoice_tax_amount'][] /** @description The tax rates which apply to the line item. */ - readonly tax_rates?: readonly definitions["tax_rate"][]; + readonly tax_rates?: readonly definitions['tax_rate'][] /** * @description A string identifying the type of the source of this line item, either an `invoiceitem` or a `subscription`. * @enum {string} */ - readonly type: "invoiceitem" | "subscription"; - }; + readonly type: 'invoiceitem' | 'subscription' + } /** LoginLink */ readonly login_link: { /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "login_link"; + readonly object: 'login_link' /** @description The URL for the login link. */ - readonly url: string; - }; + readonly url: string + } /** * Mandate * @description A Mandate is a record of the permission a customer has given you to debit their payment method. */ readonly mandate: { - readonly customer_acceptance: definitions["customer_acceptance"]; + readonly customer_acceptance: definitions['customer_acceptance'] /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; - readonly multi_use?: definitions["mandate_multi_use"]; + readonly livemode: boolean + readonly multi_use?: definitions['mandate_multi_use'] /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "mandate"; + readonly object: 'mandate' /** @description ID of the payment method associated with this mandate. */ - readonly payment_method: string; - readonly payment_method_details: definitions["mandate_payment_method_details"]; - readonly single_use?: definitions["mandate_single_use"]; + readonly payment_method: string + readonly payment_method_details: definitions['mandate_payment_method_details'] + readonly single_use?: definitions['mandate_single_use'] /** * @description The status of the mandate, which indicates whether it can be used to initiate a payment. * @enum {string} */ - readonly status: "active" | "inactive" | "pending"; + readonly status: 'active' | 'inactive' | 'pending' /** * @description The type of the mandate. * @enum {string} */ - readonly type: "multi_use" | "single_use"; - }; + readonly type: 'multi_use' | 'single_use' + } /** mandate_au_becs_debit */ readonly mandate_au_becs_debit: { /** @description The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively. */ - readonly url: string; - }; + readonly url: string + } /** mandate_multi_use */ - readonly mandate_multi_use: { readonly [key: string]: unknown }; + readonly mandate_multi_use: { readonly [key: string]: unknown } /** mandate_payment_method_details */ readonly mandate_payment_method_details: { - readonly au_becs_debit?: definitions["mandate_au_becs_debit"]; - readonly card?: definitions["card_mandate_payment_method_details"]; - readonly sepa_debit?: definitions["mandate_sepa_debit"]; + readonly au_becs_debit?: definitions['mandate_au_becs_debit'] + readonly card?: definitions['card_mandate_payment_method_details'] + readonly sepa_debit?: definitions['mandate_sepa_debit'] /** @description The type of the payment method associated with this mandate. An additional hash is included on `payment_method_details` with a name matching this value. It contains mandate information specific to the payment method. */ - readonly type: string; - }; + readonly type: string + } /** mandate_sepa_debit */ readonly mandate_sepa_debit: { /** @description The unique reference of the mandate. */ - readonly reference: string; + readonly reference: string /** @description The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively. */ - readonly url: string; - }; + readonly url: string + } /** mandate_single_use */ readonly mandate_single_use: { /** @description On a single use mandate, the amount of the payment. */ - readonly amount: number; + readonly amount: number /** @description On a single use mandate, the currency of the payment. */ - readonly currency: string; - }; + readonly currency: string + } /** NotificationEventData */ readonly notification_event_data: { /** @description 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. */ - readonly object: { readonly [key: string]: unknown }; + readonly object: { readonly [key: string]: unknown } /** @description Object containing the names of the attributes that have changed, and their previous values (sent along only with *.updated events). */ - readonly previous_attributes?: { readonly [key: string]: unknown }; - }; + readonly previous_attributes?: { readonly [key: string]: unknown } + } /** NotificationEventRequest */ readonly notification_event_request: { /** @description 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. */ - readonly id?: string; + readonly id?: string /** @description The idempotency key transmitted during the request, if any. *Note: This property is populated only for events on or after May 23, 2017*. */ - readonly idempotency_key?: string; - }; + readonly idempotency_key?: string + } /** offline_acceptance */ - readonly offline_acceptance: { readonly [key: string]: unknown }; + readonly offline_acceptance: { readonly [key: string]: unknown } /** online_acceptance */ readonly online_acceptance: { /** @description The IP address from which the Mandate was accepted by the customer. */ - readonly ip_address?: string; + readonly ip_address?: string /** @description The user agent of the browser from which the Mandate was accepted by the customer. */ - readonly user_agent?: string; - }; + readonly user_agent?: string + } /** * Order * @description Order objects are created to handle end customers' purchases of previously @@ -6663,68 +6646,68 @@ export interface definitions { */ readonly order: { /** @description 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. */ - readonly amount: number; + readonly amount: number /** @description The total amount that was returned to the customer. */ - readonly amount_returned?: number; + readonly amount_returned?: number /** @description ID of the Connect Application that created the order. */ - readonly application?: string; + readonly application?: string /** @description A fee in cents that will be applied to the order and transferred to the application owner’s Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees documentation. */ - readonly application_fee?: number; + readonly application_fee?: number /** @description The ID of the payment used to pay for the order. Present if the order status is `paid`, `fulfilled`, or `refunded`. */ - readonly charge?: string; + readonly charge?: string /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description The customer used for the order. */ - readonly customer?: string; + readonly customer?: string /** @description The email address of the customer placing the order. */ - readonly email?: string; + readonly email?: string /** @description External coupon code to load for this order. */ - readonly external_coupon_code?: string; + readonly external_coupon_code?: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description List of items constituting the order. An order can have up to 25 items. */ - readonly items: readonly definitions["order_item"][]; + readonly items: readonly definitions['order_item'][] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata: { readonly [key: string]: unknown }; + readonly metadata: { readonly [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "order"; + readonly object: 'order' /** * OrderReturnList * @description A list of returns that have taken place for this order. */ readonly returns?: { /** @description Details about each object. */ - readonly data: readonly definitions["order_return"][]; + readonly data: readonly definitions['order_return'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; + readonly url: string + } /** @description The shipping method that is currently selected for this order, if any. If present, it is equal to one of the `id`s of shipping methods in the `shipping_methods` array. At order creation time, if there are multiple shipping methods, Stripe will automatically selected the first method. */ - readonly selected_shipping_method?: string; - readonly shipping?: definitions["shipping"]; + readonly selected_shipping_method?: string + readonly shipping?: definitions['shipping'] /** @description A list of supported shipping methods for this order. The desired shipping method can be specified either by updating the order, or when paying it. */ - readonly shipping_methods?: readonly definitions["shipping_method"][]; + readonly shipping_methods?: readonly definitions['shipping_method'][] /** @description Current order status. One of `created`, `paid`, `canceled`, `fulfilled`, or `returned`. More details in the [Orders Guide](https://stripe.com/docs/orders/guide#understanding-order-statuses). */ - readonly status: string; - readonly status_transitions?: definitions["status_transitions"]; + readonly status: string + readonly status_transitions?: definitions['status_transitions'] /** @description Time at which the object was last updated. Measured in seconds since the Unix epoch. */ - readonly updated?: number; + readonly updated?: number /** @description The user's order ID if it is different from the Stripe order ID. */ - readonly upstream_id?: string; - }; + readonly upstream_id?: string + } /** * OrderItem * @description A representation of the constituent items of any given order. Can be used to @@ -6734,23 +6717,23 @@ export interface definitions { */ readonly order_item: { /** @description 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 line item. */ - readonly amount: number; + readonly amount: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description Description of the line item, meant to be displayable to the user (e.g., `"Express shipping"`). */ - readonly description: string; + readonly description: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "order_item"; + readonly object: 'order_item' /** @description The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a SKU). */ - readonly parent?: string; + readonly parent?: string /** @description A positive integer representing the number of instances of `parent` that are included in this order item. Applicable/present only if `type` is `sku`. */ - readonly quantity?: number; + readonly quantity?: number /** @description The type of line item. One of `sku`, `tax`, `shipping`, or `discount`. */ - readonly type: string; - }; + readonly type: string + } /** * OrderReturn * @description A return represents the full or partial return of a number of [order items](https://stripe.com/docs/api#order_items). @@ -6760,38 +6743,38 @@ export interface definitions { */ readonly order_return: { /** @description 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 returned line item. */ - readonly amount: number; + readonly amount: number /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description The items included in this order return. */ - readonly items: readonly definitions["order_item"][]; + readonly items: readonly definitions['order_item'][] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "order_return"; + readonly object: 'order_return' /** @description The order that this return includes items from. */ - readonly order?: string; + readonly order?: string /** @description The ID of the refund issued for this return. */ - readonly refund?: string; - }; + readonly refund?: string + } /** PackageDimensions */ readonly package_dimensions: { /** @description Height, in inches. */ - readonly height: number; + readonly height: number /** @description Length, in inches. */ - readonly length: number; + readonly length: number /** @description Weight, in ounces. */ - readonly weight: number; + readonly weight: number /** @description Width, in inches. */ - readonly width: number; - }; + readonly width: number + } /** * PaymentIntent * @description A PaymentIntent guides you through the process of collecting a payment from your customer. @@ -6808,51 +6791,51 @@ export interface definitions { */ readonly payment_intent: { /** @description 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). */ - readonly amount: number; + readonly amount: number /** @description Amount that can be captured from this PaymentIntent. */ - readonly amount_capturable?: number; + readonly amount_capturable?: number /** @description Amount that was collected by this PaymentIntent. */ - readonly amount_received?: number; + readonly amount_received?: number /** @description ID of the Connect application that created the PaymentIntent. */ - readonly application?: string; + readonly application?: string /** @description The amount of the application fee (if any) for the resulting payment. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. */ - readonly application_fee_amount?: number; + readonly application_fee_amount?: number /** @description Populated when `status` is `canceled`, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch. */ - readonly canceled_at?: number; + readonly canceled_at?: number /** * @description 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`). * @enum {string} */ readonly cancellation_reason?: - | "abandoned" - | "automatic" - | "duplicate" - | "failed_invoice" - | "fraudulent" - | "requested_by_customer" - | "void_invoice"; + | 'abandoned' + | 'automatic' + | 'duplicate' + | 'failed_invoice' + | 'fraudulent' + | 'requested_by_customer' + | 'void_invoice' /** * @description Controls when the funds will be captured from the customer's account. * @enum {string} */ - readonly capture_method: "automatic" | "manual"; + readonly capture_method: 'automatic' | 'manual' /** * PaymentFlowsPaymentIntentResourceChargeList * @description Charges that were created by this PaymentIntent, if any. */ readonly charges?: { /** @description This list only contains the latest charge, even if there were previously multiple unsuccessful charges. To view all previous charges for a PaymentIntent, you can filter the charges list using the `payment_intent` [parameter](https://stripe.com/docs/api/charges/list#list_charges-payment_intent). */ - readonly data: readonly definitions["charge"][]; + readonly data: readonly definitions['charge'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; + readonly url: string + } /** * @description The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key. * @@ -6860,13 +6843,13 @@ export interface definitions { * * Refer to our docs to [accept a payment](https://stripe.com/docs/payments/accept-a-payment) and learn about how `client_secret` should be handled. */ - readonly client_secret?: string; + readonly client_secret?: string /** @enum {string} */ - readonly confirmation_method: "automatic" | "manual"; + readonly confirmation_method: 'automatic' | 'manual' /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** * @description ID of the Customer this PaymentIntent belongs to, if one exists. * @@ -6874,35 +6857,35 @@ export interface definitions { * * If present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. */ - readonly customer?: string; + readonly customer?: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string; + readonly description?: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description ID of the invoice that created this PaymentIntent, if it exists. */ - readonly invoice?: string; - readonly last_payment_error?: definitions["api_errors"]; + readonly invoice?: string + readonly last_payment_error?: definitions['api_errors'] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. For more information, see the [documentation](https://stripe.com/docs/payments/payment-intents/creating-payment-intents#storing-information-in-metadata). */ - readonly metadata?: { readonly [key: string]: unknown }; - readonly next_action?: definitions["payment_intent_next_action"]; + readonly metadata?: { readonly [key: string]: unknown } + readonly next_action?: definitions['payment_intent_next_action'] /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "payment_intent"; + readonly object: 'payment_intent' /** @description 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. */ - readonly on_behalf_of?: string; + readonly on_behalf_of?: string /** @description ID of the payment method used in this PaymentIntent. */ - readonly payment_method?: string; - readonly payment_method_options?: definitions["payment_intent_payment_method_options"]; + readonly payment_method?: string + readonly payment_method_options?: definitions['payment_intent_payment_method_options'] /** @description The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. */ - readonly payment_method_types: readonly string[]; + readonly payment_method_types: readonly string[] /** @description Email address that the receipt for the resulting payment will be sent to. */ - readonly receipt_email?: string; + readonly receipt_email?: string /** @description ID of the review associated with this PaymentIntent, if any. */ - readonly review?: string; + readonly review?: string /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * @@ -6911,56 +6894,56 @@ export interface definitions { * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ - readonly setup_future_usage?: "off_session" | "on_session"; - readonly shipping?: definitions["shipping"]; + readonly setup_future_usage?: 'off_session' | 'on_session' + readonly shipping?: definitions['shipping'] /** @description For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - readonly statement_descriptor?: string; + readonly statement_descriptor?: string /** @description Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - readonly statement_descriptor_suffix?: string; + readonly statement_descriptor_suffix?: string /** * @description 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). * @enum {string} */ readonly status: - | "canceled" - | "processing" - | "requires_action" - | "requires_capture" - | "requires_confirmation" - | "requires_payment_method" - | "succeeded"; - readonly transfer_data?: definitions["transfer_data"]; + | 'canceled' + | 'processing' + | 'requires_action' + | 'requires_capture' + | 'requires_confirmation' + | 'requires_payment_method' + | 'succeeded' + readonly transfer_data?: definitions['transfer_data'] /** @description A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. */ - readonly transfer_group?: string; - }; + readonly transfer_group?: string + } /** PaymentIntentNextAction */ readonly payment_intent_next_action: { - readonly redirect_to_url?: definitions["payment_intent_next_action_redirect_to_url"]; + readonly redirect_to_url?: definitions['payment_intent_next_action_redirect_to_url'] /** @description Type of the next action to perform, one of `redirect_to_url` or `use_stripe_sdk`. */ - readonly type: string; + readonly type: string /** @description 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. */ - readonly use_stripe_sdk?: { readonly [key: string]: unknown }; - }; + readonly use_stripe_sdk?: { readonly [key: string]: unknown } + } /** PaymentIntentNextActionRedirectToUrl */ readonly payment_intent_next_action_redirect_to_url: { /** @description If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion. */ - readonly return_url?: string; + readonly return_url?: string /** @description The URL you must redirect your customer to in order to authenticate the payment. */ - readonly url?: string; - }; + readonly url?: string + } /** PaymentIntentPaymentMethodOptions */ readonly payment_intent_payment_method_options: { - readonly card?: definitions["payment_intent_payment_method_options_card"]; - }; + readonly card?: definitions['payment_intent_payment_method_options_card'] + } /** payment_intent_payment_method_options_card */ readonly payment_intent_payment_method_options_card: { - readonly installments?: definitions["payment_method_options_card_installments"]; + readonly installments?: definitions['payment_method_options_card_installments'] /** * @description 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. Permitted values include: `automatic` or `any`. If not provided, defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. * @enum {string} */ - readonly request_three_d_secure?: "any" | "automatic" | "challenge_only"; - }; + readonly request_three_d_secure?: 'any' | 'automatic' | 'challenge_only' + } /** * PaymentMethod * @description PaymentMethod objects represent your customer's payment instruments. @@ -6970,375 +6953,363 @@ export interface definitions { * Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios). */ readonly payment_method: { - readonly au_becs_debit?: definitions["payment_method_au_becs_debit"]; - readonly billing_details: definitions["billing_details"]; - readonly card?: definitions["payment_method_card"]; - readonly card_present?: definitions["payment_method_card_present"]; + readonly au_becs_debit?: definitions['payment_method_au_becs_debit'] + readonly billing_details: definitions['billing_details'] + readonly card?: definitions['payment_method_card'] + readonly card_present?: definitions['payment_method_card_present'] /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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. */ - readonly customer?: string; - readonly fpx?: definitions["payment_method_fpx"]; + readonly customer?: string + readonly fpx?: definitions['payment_method_fpx'] /** @description Unique identifier for the object. */ - readonly id: string; - readonly ideal?: definitions["payment_method_ideal"]; + readonly id: string + readonly ideal?: definitions['payment_method_ideal'] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata: { readonly [key: string]: unknown }; + readonly metadata: { readonly [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "payment_method"; - readonly sepa_debit?: definitions["payment_method_sepa_debit"]; + readonly object: 'payment_method' + readonly sepa_debit?: definitions['payment_method_sepa_debit'] /** * @description 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. * @enum {string} */ - readonly type: "au_becs_debit" | "card" | "fpx" | "ideal" | "sepa_debit"; - }; + readonly type: 'au_becs_debit' | 'card' | 'fpx' | 'ideal' | 'sepa_debit' + } /** payment_method_au_becs_debit */ readonly payment_method_au_becs_debit: { /** @description Six-digit number identifying bank and branch associated with this bank account. */ - readonly bsb_number?: string; + readonly bsb_number?: string /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - readonly fingerprint?: string; + readonly fingerprint?: string /** @description Last four digits of the bank account number. */ - readonly last4?: string; - }; + readonly last4?: string + } /** payment_method_card */ readonly payment_method_card: { /** @description Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ - readonly brand: string; - readonly checks?: definitions["payment_method_card_checks"]; + readonly brand: string + readonly checks?: definitions['payment_method_card_checks'] /** @description 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. */ - readonly country?: string; + readonly country?: string /** @description Two-digit number representing the card's expiration month. */ - readonly exp_month: number; + readonly exp_month: number /** @description Four-digit number representing the card's expiration year. */ - readonly exp_year: number; + readonly exp_year: number /** @description 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. */ - readonly fingerprint?: string; + readonly fingerprint?: string /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ - readonly funding: string; - readonly generated_from?: definitions["payment_method_card_generated_card"]; + readonly funding: string + readonly generated_from?: definitions['payment_method_card_generated_card'] /** @description The last four digits of the card. */ - readonly last4: string; - readonly three_d_secure_usage?: definitions["three_d_secure_usage"]; - readonly wallet?: definitions["payment_method_card_wallet"]; - }; + readonly last4: string + readonly three_d_secure_usage?: definitions['three_d_secure_usage'] + readonly wallet?: definitions['payment_method_card_wallet'] + } /** payment_method_card_checks */ readonly payment_method_card_checks: { /** @description If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ - readonly address_line1_check?: string; + readonly address_line1_check?: string /** @description If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ - readonly address_postal_code_check?: string; + readonly address_postal_code_check?: string /** @description If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ - readonly cvc_check?: string; - }; + readonly cvc_check?: string + } /** payment_method_card_generated_card */ readonly payment_method_card_generated_card: { /** @description The charge that created this object. */ - readonly charge?: string; - readonly payment_method_details?: definitions["payment_method_details"]; - }; + readonly charge?: string + readonly payment_method_details?: definitions['payment_method_details'] + } /** payment_method_card_present */ - readonly payment_method_card_present: { readonly [key: string]: unknown }; + readonly payment_method_card_present: { readonly [key: string]: unknown } /** payment_method_card_wallet */ readonly payment_method_card_wallet: { - readonly amex_express_checkout?: definitions["payment_method_card_wallet_amex_express_checkout"]; - readonly apple_pay?: definitions["payment_method_card_wallet_apple_pay"]; + readonly amex_express_checkout?: definitions['payment_method_card_wallet_amex_express_checkout'] + readonly apple_pay?: definitions['payment_method_card_wallet_apple_pay'] /** @description (For tokenized numbers only.) The last four digits of the device account number. */ - readonly dynamic_last4?: string; - readonly google_pay?: definitions["payment_method_card_wallet_google_pay"]; - readonly masterpass?: definitions["payment_method_card_wallet_masterpass"]; - readonly samsung_pay?: definitions["payment_method_card_wallet_samsung_pay"]; + readonly dynamic_last4?: string + readonly google_pay?: definitions['payment_method_card_wallet_google_pay'] + readonly masterpass?: definitions['payment_method_card_wallet_masterpass'] + readonly samsung_pay?: definitions['payment_method_card_wallet_samsung_pay'] /** * @description The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, or `visa_checkout`. 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. * @enum {string} */ - readonly type: - | "amex_express_checkout" - | "apple_pay" - | "google_pay" - | "masterpass" - | "samsung_pay" - | "visa_checkout"; - readonly visa_checkout?: definitions["payment_method_card_wallet_visa_checkout"]; - }; + readonly type: 'amex_express_checkout' | 'apple_pay' | 'google_pay' | 'masterpass' | 'samsung_pay' | 'visa_checkout' + readonly visa_checkout?: definitions['payment_method_card_wallet_visa_checkout'] + } /** payment_method_card_wallet_amex_express_checkout */ - readonly payment_method_card_wallet_amex_express_checkout: { readonly [key: string]: unknown }; + readonly payment_method_card_wallet_amex_express_checkout: { readonly [key: string]: unknown } /** payment_method_card_wallet_apple_pay */ - readonly payment_method_card_wallet_apple_pay: { readonly [key: string]: unknown }; + readonly payment_method_card_wallet_apple_pay: { readonly [key: string]: unknown } /** payment_method_card_wallet_google_pay */ - readonly payment_method_card_wallet_google_pay: { readonly [key: string]: unknown }; + readonly payment_method_card_wallet_google_pay: { readonly [key: string]: unknown } /** payment_method_card_wallet_masterpass */ readonly payment_method_card_wallet_masterpass: { - readonly billing_address?: definitions["address"]; + readonly billing_address?: definitions['address'] /** @description 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. */ - readonly email?: string; + readonly email?: string /** @description 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. */ - readonly name?: string; - readonly shipping_address?: definitions["address"]; - }; + readonly name?: string + readonly shipping_address?: definitions['address'] + } /** payment_method_card_wallet_samsung_pay */ - readonly payment_method_card_wallet_samsung_pay: { readonly [key: string]: unknown }; + readonly payment_method_card_wallet_samsung_pay: { readonly [key: string]: unknown } /** payment_method_card_wallet_visa_checkout */ readonly payment_method_card_wallet_visa_checkout: { - readonly billing_address?: definitions["address"]; + readonly billing_address?: definitions['address'] /** @description 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. */ - readonly email?: string; + readonly email?: string /** @description 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. */ - readonly name?: string; - readonly shipping_address?: definitions["address"]; - }; + readonly name?: string + readonly shipping_address?: definitions['address'] + } /** payment_method_details */ readonly payment_method_details: { - readonly ach_credit_transfer?: definitions["payment_method_details_ach_credit_transfer"]; - readonly ach_debit?: definitions["payment_method_details_ach_debit"]; - readonly alipay?: definitions["payment_method_details_alipay"]; - readonly au_becs_debit?: definitions["payment_method_details_au_becs_debit"]; - readonly bancontact?: definitions["payment_method_details_bancontact"]; - readonly card?: definitions["payment_method_details_card"]; - readonly card_present?: definitions["payment_method_details_card_present"]; - readonly eps?: definitions["payment_method_details_eps"]; - readonly fpx?: definitions["payment_method_details_fpx"]; - readonly giropay?: definitions["payment_method_details_giropay"]; - readonly ideal?: definitions["payment_method_details_ideal"]; - readonly klarna?: definitions["payment_method_details_klarna"]; - readonly multibanco?: definitions["payment_method_details_multibanco"]; - readonly p24?: definitions["payment_method_details_p24"]; - readonly sepa_debit?: definitions["payment_method_details_sepa_debit"]; - readonly sofort?: definitions["payment_method_details_sofort"]; - readonly stripe_account?: definitions["payment_method_details_stripe_account"]; + readonly ach_credit_transfer?: definitions['payment_method_details_ach_credit_transfer'] + readonly ach_debit?: definitions['payment_method_details_ach_debit'] + readonly alipay?: definitions['payment_method_details_alipay'] + readonly au_becs_debit?: definitions['payment_method_details_au_becs_debit'] + readonly bancontact?: definitions['payment_method_details_bancontact'] + readonly card?: definitions['payment_method_details_card'] + readonly card_present?: definitions['payment_method_details_card_present'] + readonly eps?: definitions['payment_method_details_eps'] + readonly fpx?: definitions['payment_method_details_fpx'] + readonly giropay?: definitions['payment_method_details_giropay'] + readonly ideal?: definitions['payment_method_details_ideal'] + readonly klarna?: definitions['payment_method_details_klarna'] + readonly multibanco?: definitions['payment_method_details_multibanco'] + readonly p24?: definitions['payment_method_details_p24'] + readonly sepa_debit?: definitions['payment_method_details_sepa_debit'] + readonly sofort?: definitions['payment_method_details_sofort'] + readonly stripe_account?: definitions['payment_method_details_stripe_account'] /** * @description The type of transaction-specific details of the payment method used in the payment, one of `ach_credit_transfer`, `ach_debit`, `alipay`, `au_becs_debit`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `klarna`, `multibanco`, `p24`, `sepa_debit`, `sofort`, `stripe_account`, or `wechat`. * An additional hash is included on `payment_method_details` with a name matching this value. * It contains information specific to the payment method. */ - readonly type: string; - readonly wechat?: definitions["payment_method_details_wechat"]; - }; + readonly type: string + readonly wechat?: definitions['payment_method_details_wechat'] + } /** payment_method_details_ach_credit_transfer */ readonly payment_method_details_ach_credit_transfer: { /** @description Account number to transfer funds to. */ - readonly account_number?: string; + readonly account_number?: string /** @description Name of the bank associated with the routing number. */ - readonly bank_name?: string; + readonly bank_name?: string /** @description Routing transit number for the bank account to transfer funds to. */ - readonly routing_number?: string; + readonly routing_number?: string /** @description SWIFT code of the bank associated with the routing number. */ - readonly swift_code?: string; - }; + readonly swift_code?: string + } /** payment_method_details_ach_debit */ readonly payment_method_details_ach_debit: { /** * @description Type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - readonly account_holder_type?: "company" | "individual"; + readonly account_holder_type?: 'company' | 'individual' /** @description Name of the bank associated with the bank account. */ - readonly bank_name?: string; + readonly bank_name?: string /** @description Two-letter ISO code representing the country the bank account is located in. */ - readonly country?: string; + readonly country?: string /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - readonly fingerprint?: string; + readonly fingerprint?: string /** @description Last four digits of the bank account number. */ - readonly last4?: string; + readonly last4?: string /** @description Routing transit number of the bank account. */ - readonly routing_number?: string; - }; + readonly routing_number?: string + } /** payment_method_details_alipay */ - readonly payment_method_details_alipay: { readonly [key: string]: unknown }; + readonly payment_method_details_alipay: { readonly [key: string]: unknown } /** payment_method_details_au_becs_debit */ readonly payment_method_details_au_becs_debit: { /** @description Bank-State-Branch number of the bank account. */ - readonly bsb_number?: string; + readonly bsb_number?: string /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - readonly fingerprint?: string; + readonly fingerprint?: string /** @description Last four digits of the bank account number. */ - readonly last4?: string; + readonly last4?: string /** @description ID of the mandate used to make this payment. */ - readonly mandate?: string; - }; + readonly mandate?: string + } /** payment_method_details_bancontact */ readonly payment_method_details_bancontact: { /** @description Bank code of bank associated with the bank account. */ - readonly bank_code?: string; + readonly bank_code?: string /** @description Name of the bank associated with the bank account. */ - readonly bank_name?: string; + readonly bank_name?: string /** @description Bank Identifier Code of the bank associated with the bank account. */ - readonly bic?: string; + readonly bic?: string /** @description Last four characters of the IBAN. */ - readonly iban_last4?: string; + readonly iban_last4?: string /** * @description Preferred language of the Bancontact authorization page that the customer is redirected to. * Can be one of `en`, `de`, `fr`, or `nl` * @enum {string} */ - readonly preferred_language?: "de" | "en" | "fr" | "nl"; + readonly preferred_language?: 'de' | 'en' | 'fr' | 'nl' /** * @description Owner's verified full name. Values are verified or provided by Bancontact directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - readonly verified_name?: string; - }; + readonly verified_name?: string + } /** payment_method_details_card */ readonly payment_method_details_card: { /** @description Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ - readonly brand?: string; - readonly checks?: definitions["payment_method_details_card_checks"]; + readonly brand?: string + readonly checks?: definitions['payment_method_details_card_checks'] /** @description 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. */ - readonly country?: string; + readonly country?: string /** @description Two-digit number representing the card's expiration month. */ - readonly exp_month?: number; + readonly exp_month?: number /** @description Four-digit number representing the card's expiration year. */ - readonly exp_year?: number; + readonly exp_year?: number /** @description 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. */ - readonly fingerprint?: string; + readonly fingerprint?: string /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ - readonly funding?: string; - readonly installments?: definitions["payment_method_details_card_installments"]; + readonly funding?: string + readonly installments?: definitions['payment_method_details_card_installments'] /** @description The last four digits of the card. */ - readonly last4?: string; + readonly last4?: string /** @description Identifies which network this charge was processed on. Can be `amex`, `diners`, `discover`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ - readonly network?: string; - readonly three_d_secure?: definitions["three_d_secure_details"]; - readonly wallet?: definitions["payment_method_details_card_wallet"]; - }; + readonly network?: string + readonly three_d_secure?: definitions['three_d_secure_details'] + readonly wallet?: definitions['payment_method_details_card_wallet'] + } /** payment_method_details_card_checks */ readonly payment_method_details_card_checks: { /** @description If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ - readonly address_line1_check?: string; + readonly address_line1_check?: string /** @description If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ - readonly address_postal_code_check?: string; + readonly address_postal_code_check?: string /** @description If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ - readonly cvc_check?: string; - }; + readonly cvc_check?: string + } /** payment_method_details_card_installments */ readonly payment_method_details_card_installments: { - readonly plan?: definitions["payment_method_details_card_installments_plan"]; - }; + readonly plan?: definitions['payment_method_details_card_installments_plan'] + } /** payment_method_details_card_installments_plan */ readonly payment_method_details_card_installments_plan: { /** @description For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card. */ - readonly count?: number; + readonly count?: number /** * @description For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card. * One of `month`. * @enum {string} */ - readonly interval?: "month"; + readonly interval?: 'month' /** * @description Type of installment plan, one of `fixed_count`. * @enum {string} */ - readonly type: "fixed_count"; - }; + readonly type: 'fixed_count' + } /** payment_method_details_card_present */ readonly payment_method_details_card_present: { /** @description Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ - readonly brand?: string; + readonly brand?: string /** @description 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 (`/`). */ - readonly cardholder_name?: string; + readonly cardholder_name?: string /** @description 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. */ - readonly country?: string; + readonly country?: string /** @description Authorization response cryptogram. */ - readonly emv_auth_data?: string; + readonly emv_auth_data?: string /** @description Two-digit number representing the card's expiration month. */ - readonly exp_month?: number; + readonly exp_month?: number /** @description Four-digit number representing the card's expiration year. */ - readonly exp_year?: number; + readonly exp_year?: number /** @description 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. */ - readonly fingerprint?: string; + readonly fingerprint?: string /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ - readonly funding?: string; + readonly funding?: string /** @description 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. */ - readonly generated_card?: string; + readonly generated_card?: string /** @description The last four digits of the card. */ - readonly last4?: string; + readonly last4?: string /** @description Identifies which network this charge was processed on. Can be `amex`, `diners`, `discover`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ - readonly network?: string; + readonly network?: string /** @description How were card details read in this transaction. Can be contact_emv, contactless_emv, magnetic_stripe_fallback, magnetic_stripe_track2, or contactless_magstripe_mode */ - readonly read_method?: string; - readonly receipt?: definitions["payment_method_details_card_present_receipt"]; - }; + readonly read_method?: string + readonly receipt?: definitions['payment_method_details_card_present_receipt'] + } /** payment_method_details_card_present_receipt */ readonly payment_method_details_card_present_receipt: { /** @description EMV tag 9F26, cryptogram generated by the integrated circuit chip. */ - readonly application_cryptogram?: string; + readonly application_cryptogram?: string /** @description Mnenomic of the Application Identifier. */ - readonly application_preferred_name?: string; + readonly application_preferred_name?: string /** @description Identifier for this transaction. */ - readonly authorization_code?: string; + readonly authorization_code?: string /** @description EMV tag 8A. A code returned by the card issuer. */ - readonly authorization_response_code?: string; + readonly authorization_response_code?: string /** @description How the cardholder verified ownership of the card. */ - readonly cardholder_verification_method?: string; + readonly cardholder_verification_method?: string /** @description EMV tag 84. Similar to the application identifier stored on the integrated circuit chip. */ - readonly dedicated_file_name?: string; + readonly dedicated_file_name?: string /** @description The outcome of a series of EMV functions performed by the card reader. */ - readonly terminal_verification_results?: string; + readonly terminal_verification_results?: string /** @description An indication of various EMV functions performed during the transaction. */ - readonly transaction_status_information?: string; - }; + readonly transaction_status_information?: string + } /** payment_method_details_card_wallet */ readonly payment_method_details_card_wallet: { - readonly amex_express_checkout?: definitions["payment_method_details_card_wallet_amex_express_checkout"]; - readonly apple_pay?: definitions["payment_method_details_card_wallet_apple_pay"]; + readonly amex_express_checkout?: definitions['payment_method_details_card_wallet_amex_express_checkout'] + readonly apple_pay?: definitions['payment_method_details_card_wallet_apple_pay'] /** @description (For tokenized numbers only.) The last four digits of the device account number. */ - readonly dynamic_last4?: string; - readonly google_pay?: definitions["payment_method_details_card_wallet_google_pay"]; - readonly masterpass?: definitions["payment_method_details_card_wallet_masterpass"]; - readonly samsung_pay?: definitions["payment_method_details_card_wallet_samsung_pay"]; + readonly dynamic_last4?: string + readonly google_pay?: definitions['payment_method_details_card_wallet_google_pay'] + readonly masterpass?: definitions['payment_method_details_card_wallet_masterpass'] + readonly samsung_pay?: definitions['payment_method_details_card_wallet_samsung_pay'] /** * @description The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, or `visa_checkout`. 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. * @enum {string} */ - readonly type: - | "amex_express_checkout" - | "apple_pay" - | "google_pay" - | "masterpass" - | "samsung_pay" - | "visa_checkout"; - readonly visa_checkout?: definitions["payment_method_details_card_wallet_visa_checkout"]; - }; + readonly type: 'amex_express_checkout' | 'apple_pay' | 'google_pay' | 'masterpass' | 'samsung_pay' | 'visa_checkout' + readonly visa_checkout?: definitions['payment_method_details_card_wallet_visa_checkout'] + } /** payment_method_details_card_wallet_amex_express_checkout */ - readonly payment_method_details_card_wallet_amex_express_checkout: { readonly [key: string]: unknown }; + readonly payment_method_details_card_wallet_amex_express_checkout: { readonly [key: string]: unknown } /** payment_method_details_card_wallet_apple_pay */ - readonly payment_method_details_card_wallet_apple_pay: { readonly [key: string]: unknown }; + readonly payment_method_details_card_wallet_apple_pay: { readonly [key: string]: unknown } /** payment_method_details_card_wallet_google_pay */ - readonly payment_method_details_card_wallet_google_pay: { readonly [key: string]: unknown }; + readonly payment_method_details_card_wallet_google_pay: { readonly [key: string]: unknown } /** payment_method_details_card_wallet_masterpass */ readonly payment_method_details_card_wallet_masterpass: { - readonly billing_address?: definitions["address"]; + readonly billing_address?: definitions['address'] /** @description 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. */ - readonly email?: string; + readonly email?: string /** @description 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. */ - readonly name?: string; - readonly shipping_address?: definitions["address"]; - }; + readonly name?: string + readonly shipping_address?: definitions['address'] + } /** payment_method_details_card_wallet_samsung_pay */ - readonly payment_method_details_card_wallet_samsung_pay: { readonly [key: string]: unknown }; + readonly payment_method_details_card_wallet_samsung_pay: { readonly [key: string]: unknown } /** payment_method_details_card_wallet_visa_checkout */ readonly payment_method_details_card_wallet_visa_checkout: { - readonly billing_address?: definitions["address"]; + readonly billing_address?: definitions['address'] /** @description 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. */ - readonly email?: string; + readonly email?: string /** @description 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. */ - readonly name?: string; - readonly shipping_address?: definitions["address"]; - }; + readonly name?: string + readonly shipping_address?: definitions['address'] + } /** payment_method_details_eps */ readonly payment_method_details_eps: { /** * @description Owner's verified full name. Values are verified or provided by EPS directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - readonly verified_name?: string; - }; + readonly verified_name?: string + } /** payment_method_details_fpx */ readonly payment_method_details_fpx: { /** @@ -7346,43 +7317,43 @@ export interface definitions { * @enum {string} */ readonly bank: - | "affin_bank" - | "alliance_bank" - | "ambank" - | "bank_islam" - | "bank_muamalat" - | "bank_rakyat" - | "bsn" - | "cimb" - | "deutsche_bank" - | "hong_leong_bank" - | "hsbc" - | "kfh" - | "maybank2e" - | "maybank2u" - | "ocbc" - | "pb_enterprise" - | "public_bank" - | "rhb" - | "standard_chartered" - | "uob"; + | 'affin_bank' + | 'alliance_bank' + | 'ambank' + | 'bank_islam' + | 'bank_muamalat' + | 'bank_rakyat' + | 'bsn' + | 'cimb' + | 'deutsche_bank' + | 'hong_leong_bank' + | 'hsbc' + | 'kfh' + | 'maybank2e' + | 'maybank2u' + | 'ocbc' + | 'pb_enterprise' + | 'public_bank' + | 'rhb' + | 'standard_chartered' + | 'uob' /** @description Unique transaction id generated by FPX for every request from the merchant */ - readonly transaction_id?: string; - }; + readonly transaction_id?: string + } /** payment_method_details_giropay */ readonly payment_method_details_giropay: { /** @description Bank code of bank associated with the bank account. */ - readonly bank_code?: string; + readonly bank_code?: string /** @description Name of the bank associated with the bank account. */ - readonly bank_name?: string; + readonly bank_name?: string /** @description Bank Identifier Code of the bank associated with the bank account. */ - readonly bic?: string; + readonly bic?: string /** * @description Owner's verified full name. Values are verified or provided by Giropay directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - readonly verified_name?: string; - }; + readonly verified_name?: string + } /** payment_method_details_ideal */ readonly payment_method_details_ideal: { /** @@ -7390,99 +7361,99 @@ export interface definitions { * @enum {string} */ readonly bank?: - | "abn_amro" - | "asn_bank" - | "bunq" - | "handelsbanken" - | "ing" - | "knab" - | "moneyou" - | "rabobank" - | "regiobank" - | "sns_bank" - | "triodos_bank" - | "van_lanschot"; + | 'abn_amro' + | 'asn_bank' + | 'bunq' + | 'handelsbanken' + | 'ing' + | 'knab' + | 'moneyou' + | 'rabobank' + | 'regiobank' + | 'sns_bank' + | 'triodos_bank' + | 'van_lanschot' /** * @description The Bank Identifier Code of the customer's bank. * @enum {string} */ readonly bic?: - | "ABNANL2A" - | "ASNBNL21" - | "BUNQNL2A" - | "FVLBNL22" - | "HANDNL2A" - | "INGBNL2A" - | "KNABNL2H" - | "MOYONL21" - | "RABONL2U" - | "RBRBNL21" - | "SNSBNL2A" - | "TRIONL2U"; + | 'ABNANL2A' + | 'ASNBNL21' + | 'BUNQNL2A' + | 'FVLBNL22' + | 'HANDNL2A' + | 'INGBNL2A' + | 'KNABNL2H' + | 'MOYONL21' + | 'RABONL2U' + | 'RBRBNL21' + | 'SNSBNL2A' + | 'TRIONL2U' /** @description Last four characters of the IBAN. */ - readonly iban_last4?: string; + readonly iban_last4?: string /** * @description Owner's verified full name. Values are verified or provided by iDEAL directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - readonly verified_name?: string; - }; + readonly verified_name?: string + } /** payment_method_details_klarna */ - readonly payment_method_details_klarna: { readonly [key: string]: unknown }; + readonly payment_method_details_klarna: { readonly [key: string]: unknown } /** payment_method_details_multibanco */ readonly payment_method_details_multibanco: { /** @description Entity number associated with this Multibanco payment. */ - readonly entity?: string; + readonly entity?: string /** @description Reference number associated with this Multibanco payment. */ - readonly reference?: string; - }; + readonly reference?: string + } /** payment_method_details_p24 */ readonly payment_method_details_p24: { /** @description Unique reference for this Przelewy24 payment. */ - readonly reference?: string; + readonly reference?: string /** * @description Owner's verified full name. Values are verified or provided by Przelewy24 directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - readonly verified_name?: string; - }; + readonly verified_name?: string + } /** payment_method_details_sepa_debit */ readonly payment_method_details_sepa_debit: { /** @description Bank code of bank associated with the bank account. */ - readonly bank_code?: string; + readonly bank_code?: string /** @description Branch code of bank associated with the bank account. */ - readonly branch_code?: string; + readonly branch_code?: string /** @description Two-letter ISO code representing the country the bank account is located in. */ - readonly country?: string; + readonly country?: string /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - readonly fingerprint?: string; + readonly fingerprint?: string /** @description Last four characters of the IBAN. */ - readonly last4?: string; + readonly last4?: string /** @description ID of the mandate used to make this payment. */ - readonly mandate?: string; - }; + readonly mandate?: string + } /** payment_method_details_sofort */ readonly payment_method_details_sofort: { /** @description Bank code of bank associated with the bank account. */ - readonly bank_code?: string; + readonly bank_code?: string /** @description Name of the bank associated with the bank account. */ - readonly bank_name?: string; + readonly bank_name?: string /** @description Bank Identifier Code of the bank associated with the bank account. */ - readonly bic?: string; + readonly bic?: string /** @description Two-letter ISO code representing the country the bank account is located in. */ - readonly country?: string; + readonly country?: string /** @description Last four characters of the IBAN. */ - readonly iban_last4?: string; + readonly iban_last4?: string /** * @description Owner's verified full name. Values are verified or provided by SOFORT directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - readonly verified_name?: string; - }; + readonly verified_name?: string + } /** payment_method_details_stripe_account */ - readonly payment_method_details_stripe_account: { readonly [key: string]: unknown }; + readonly payment_method_details_stripe_account: { readonly [key: string]: unknown } /** payment_method_details_wechat */ - readonly payment_method_details_wechat: { readonly [key: string]: unknown }; + readonly payment_method_details_wechat: { readonly [key: string]: unknown } /** payment_method_fpx */ readonly payment_method_fpx: { /** @@ -7490,27 +7461,27 @@ export interface definitions { * @enum {string} */ readonly bank: - | "affin_bank" - | "alliance_bank" - | "ambank" - | "bank_islam" - | "bank_muamalat" - | "bank_rakyat" - | "bsn" - | "cimb" - | "deutsche_bank" - | "hong_leong_bank" - | "hsbc" - | "kfh" - | "maybank2e" - | "maybank2u" - | "ocbc" - | "pb_enterprise" - | "public_bank" - | "rhb" - | "standard_chartered" - | "uob"; - }; + | 'affin_bank' + | 'alliance_bank' + | 'ambank' + | 'bank_islam' + | 'bank_muamalat' + | 'bank_rakyat' + | 'bsn' + | 'cimb' + | 'deutsche_bank' + | 'hong_leong_bank' + | 'hsbc' + | 'kfh' + | 'maybank2e' + | 'maybank2u' + | 'ocbc' + | 'pb_enterprise' + | 'public_bank' + | 'rhb' + | 'standard_chartered' + | 'uob' + } /** payment_method_ideal */ readonly payment_method_ideal: { /** @@ -7518,57 +7489,57 @@ export interface definitions { * @enum {string} */ readonly bank?: - | "abn_amro" - | "asn_bank" - | "bunq" - | "handelsbanken" - | "ing" - | "knab" - | "moneyou" - | "rabobank" - | "regiobank" - | "sns_bank" - | "triodos_bank" - | "van_lanschot"; + | 'abn_amro' + | 'asn_bank' + | 'bunq' + | 'handelsbanken' + | 'ing' + | 'knab' + | 'moneyou' + | 'rabobank' + | 'regiobank' + | 'sns_bank' + | 'triodos_bank' + | 'van_lanschot' /** * @description The Bank Identifier Code of the customer's bank, if the bank was provided. * @enum {string} */ readonly bic?: - | "ABNANL2A" - | "ASNBNL21" - | "BUNQNL2A" - | "FVLBNL22" - | "HANDNL2A" - | "INGBNL2A" - | "KNABNL2H" - | "MOYONL21" - | "RABONL2U" - | "RBRBNL21" - | "SNSBNL2A" - | "TRIONL2U"; - }; + | 'ABNANL2A' + | 'ASNBNL21' + | 'BUNQNL2A' + | 'FVLBNL22' + | 'HANDNL2A' + | 'INGBNL2A' + | 'KNABNL2H' + | 'MOYONL21' + | 'RABONL2U' + | 'RBRBNL21' + | 'SNSBNL2A' + | 'TRIONL2U' + } /** payment_method_options_card_installments */ readonly payment_method_options_card_installments: { /** @description Installment plans that may be selected for this PaymentIntent. */ - readonly available_plans?: readonly definitions["payment_method_details_card_installments_plan"][]; + readonly available_plans?: readonly definitions['payment_method_details_card_installments_plan'][] /** @description Whether Installments are enabled for this PaymentIntent. */ - readonly enabled: boolean; - readonly plan?: definitions["payment_method_details_card_installments_plan"]; - }; + readonly enabled: boolean + readonly plan?: definitions['payment_method_details_card_installments_plan'] + } /** payment_method_sepa_debit */ readonly payment_method_sepa_debit: { /** @description Bank code of bank associated with the bank account. */ - readonly bank_code?: string; + readonly bank_code?: string /** @description Branch code of bank associated with the bank account. */ - readonly branch_code?: string; + readonly branch_code?: string /** @description Two-letter ISO code representing the country the bank account is located in. */ - readonly country?: string; + readonly country?: string /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - readonly fingerprint?: string; + readonly fingerprint?: string /** @description Last four characters of the IBAN. */ - readonly last4?: string; - }; + readonly last4?: string + } /** PaymentPagesPaymentPageResourcesShippingAddressCollection */ readonly payment_pages_payment_page_resources_shipping_address_collection: { /** @@ -7576,257 +7547,257 @@ export interface definitions { * shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI`. */ readonly allowed_countries: readonly ( - | "AC" - | "AD" - | "AE" - | "AF" - | "AG" - | "AI" - | "AL" - | "AM" - | "AO" - | "AQ" - | "AR" - | "AT" - | "AU" - | "AW" - | "AX" - | "AZ" - | "BA" - | "BB" - | "BD" - | "BE" - | "BF" - | "BG" - | "BH" - | "BI" - | "BJ" - | "BL" - | "BM" - | "BN" - | "BO" - | "BQ" - | "BR" - | "BS" - | "BT" - | "BV" - | "BW" - | "BY" - | "BZ" - | "CA" - | "CD" - | "CF" - | "CG" - | "CH" - | "CI" - | "CK" - | "CL" - | "CM" - | "CN" - | "CO" - | "CR" - | "CV" - | "CW" - | "CY" - | "CZ" - | "DE" - | "DJ" - | "DK" - | "DM" - | "DO" - | "DZ" - | "EC" - | "EE" - | "EG" - | "EH" - | "ER" - | "ES" - | "ET" - | "FI" - | "FJ" - | "FK" - | "FO" - | "FR" - | "GA" - | "GB" - | "GD" - | "GE" - | "GF" - | "GG" - | "GH" - | "GI" - | "GL" - | "GM" - | "GN" - | "GP" - | "GQ" - | "GR" - | "GS" - | "GT" - | "GU" - | "GW" - | "GY" - | "HK" - | "HN" - | "HR" - | "HT" - | "HU" - | "ID" - | "IE" - | "IL" - | "IM" - | "IN" - | "IO" - | "IQ" - | "IS" - | "IT" - | "JE" - | "JM" - | "JO" - | "JP" - | "KE" - | "KG" - | "KH" - | "KI" - | "KM" - | "KN" - | "KR" - | "KW" - | "KY" - | "KZ" - | "LA" - | "LB" - | "LC" - | "LI" - | "LK" - | "LR" - | "LS" - | "LT" - | "LU" - | "LV" - | "LY" - | "MA" - | "MC" - | "MD" - | "ME" - | "MF" - | "MG" - | "MK" - | "ML" - | "MM" - | "MN" - | "MO" - | "MQ" - | "MR" - | "MS" - | "MT" - | "MU" - | "MV" - | "MW" - | "MX" - | "MY" - | "MZ" - | "NA" - | "NC" - | "NE" - | "NG" - | "NI" - | "NL" - | "NO" - | "NP" - | "NR" - | "NU" - | "NZ" - | "OM" - | "PA" - | "PE" - | "PF" - | "PG" - | "PH" - | "PK" - | "PL" - | "PM" - | "PN" - | "PR" - | "PS" - | "PT" - | "PY" - | "QA" - | "RE" - | "RO" - | "RS" - | "RU" - | "RW" - | "SA" - | "SB" - | "SC" - | "SE" - | "SG" - | "SH" - | "SI" - | "SJ" - | "SK" - | "SL" - | "SM" - | "SN" - | "SO" - | "SR" - | "SS" - | "ST" - | "SV" - | "SX" - | "SZ" - | "TA" - | "TC" - | "TD" - | "TF" - | "TG" - | "TH" - | "TJ" - | "TK" - | "TL" - | "TM" - | "TN" - | "TO" - | "TR" - | "TT" - | "TV" - | "TW" - | "TZ" - | "UA" - | "UG" - | "US" - | "UY" - | "UZ" - | "VA" - | "VC" - | "VE" - | "VG" - | "VN" - | "VU" - | "WF" - | "WS" - | "XK" - | "YE" - | "YT" - | "ZA" - | "ZM" - | "ZW" - | "ZZ" - )[]; - }; + | 'AC' + | 'AD' + | 'AE' + | 'AF' + | 'AG' + | 'AI' + | 'AL' + | 'AM' + | 'AO' + | 'AQ' + | 'AR' + | 'AT' + | 'AU' + | 'AW' + | 'AX' + | 'AZ' + | 'BA' + | 'BB' + | 'BD' + | 'BE' + | 'BF' + | 'BG' + | 'BH' + | 'BI' + | 'BJ' + | 'BL' + | 'BM' + | 'BN' + | 'BO' + | 'BQ' + | 'BR' + | 'BS' + | 'BT' + | 'BV' + | 'BW' + | 'BY' + | 'BZ' + | 'CA' + | 'CD' + | 'CF' + | 'CG' + | 'CH' + | 'CI' + | 'CK' + | 'CL' + | 'CM' + | 'CN' + | 'CO' + | 'CR' + | 'CV' + | 'CW' + | 'CY' + | 'CZ' + | 'DE' + | 'DJ' + | 'DK' + | 'DM' + | 'DO' + | 'DZ' + | 'EC' + | 'EE' + | 'EG' + | 'EH' + | 'ER' + | 'ES' + | 'ET' + | 'FI' + | 'FJ' + | 'FK' + | 'FO' + | 'FR' + | 'GA' + | 'GB' + | 'GD' + | 'GE' + | 'GF' + | 'GG' + | 'GH' + | 'GI' + | 'GL' + | 'GM' + | 'GN' + | 'GP' + | 'GQ' + | 'GR' + | 'GS' + | 'GT' + | 'GU' + | 'GW' + | 'GY' + | 'HK' + | 'HN' + | 'HR' + | 'HT' + | 'HU' + | 'ID' + | 'IE' + | 'IL' + | 'IM' + | 'IN' + | 'IO' + | 'IQ' + | 'IS' + | 'IT' + | 'JE' + | 'JM' + | 'JO' + | 'JP' + | 'KE' + | 'KG' + | 'KH' + | 'KI' + | 'KM' + | 'KN' + | 'KR' + | 'KW' + | 'KY' + | 'KZ' + | 'LA' + | 'LB' + | 'LC' + | 'LI' + | 'LK' + | 'LR' + | 'LS' + | 'LT' + | 'LU' + | 'LV' + | 'LY' + | 'MA' + | 'MC' + | 'MD' + | 'ME' + | 'MF' + | 'MG' + | 'MK' + | 'ML' + | 'MM' + | 'MN' + | 'MO' + | 'MQ' + | 'MR' + | 'MS' + | 'MT' + | 'MU' + | 'MV' + | 'MW' + | 'MX' + | 'MY' + | 'MZ' + | 'NA' + | 'NC' + | 'NE' + | 'NG' + | 'NI' + | 'NL' + | 'NO' + | 'NP' + | 'NR' + | 'NU' + | 'NZ' + | 'OM' + | 'PA' + | 'PE' + | 'PF' + | 'PG' + | 'PH' + | 'PK' + | 'PL' + | 'PM' + | 'PN' + | 'PR' + | 'PS' + | 'PT' + | 'PY' + | 'QA' + | 'RE' + | 'RO' + | 'RS' + | 'RU' + | 'RW' + | 'SA' + | 'SB' + | 'SC' + | 'SE' + | 'SG' + | 'SH' + | 'SI' + | 'SJ' + | 'SK' + | 'SL' + | 'SM' + | 'SN' + | 'SO' + | 'SR' + | 'SS' + | 'ST' + | 'SV' + | 'SX' + | 'SZ' + | 'TA' + | 'TC' + | 'TD' + | 'TF' + | 'TG' + | 'TH' + | 'TJ' + | 'TK' + | 'TL' + | 'TM' + | 'TN' + | 'TO' + | 'TR' + | 'TT' + | 'TV' + | 'TW' + | 'TZ' + | 'UA' + | 'UG' + | 'US' + | 'UY' + | 'UZ' + | 'VA' + | 'VC' + | 'VE' + | 'VG' + | 'VN' + | 'VU' + | 'WF' + | 'WS' + | 'XK' + | 'YE' + | 'YT' + | 'ZA' + | 'ZM' + | 'ZW' + | 'ZZ' + )[] + } /** Polymorphic */ readonly payment_source: { /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description 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. */ - readonly metadata?: { readonly [key: string]: unknown }; + readonly metadata?: { readonly [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "account"; - }; + readonly object: 'account' + } /** * Payout * @description A `Payout` object is created when you receive funds from Stripe, or when you @@ -7840,59 +7811,59 @@ export interface definitions { */ readonly payout: { /** @description Amount (in %s) to be transferred to your bank account or debit card. */ - readonly amount: number; + readonly amount: number /** @description Date the payout is expected to arrive in the bank. This factors in delays like weekends or bank holidays. */ - readonly arrival_date: number; + readonly arrival_date: number /** @description Returns `true` if the payout was created by an [automated payout schedule](https://stripe.com/docs/payouts#payout-schedule), and `false` if it was [requested manually](https://stripe.com/docs/payouts#manual-payouts). */ - readonly automatic: boolean; + readonly automatic: boolean /** @description ID of the balance transaction that describes the impact of this payout on your account balance. */ - readonly balance_transaction?: string; + readonly balance_transaction?: string /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string; + readonly description?: string /** @description ID of the bank account or card the payout was sent to. */ - readonly destination?: string; + readonly destination?: string /** @description If the payout failed or was canceled, this will be the ID of the balance transaction that reversed the initial balance transaction, and puts the funds from the failed payout back in your balance. */ - readonly failure_balance_transaction?: string; + readonly failure_balance_transaction?: string /** @description Error code explaining reason for payout failure if available. See [Types of payout failures](https://stripe.com/docs/api#payout_failures) for a list of failure codes. */ - readonly failure_code?: string; + readonly failure_code?: string /** @description Message to user further explaining reason for payout failure if available. */ - readonly failure_message?: string; + readonly failure_message?: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata: { readonly [key: string]: unknown }; + readonly metadata: { readonly [key: string]: unknown } /** @description The method used to send this payout, which can be `standard` or `instant`. `instant` is only supported for payouts to debit cards. (See [Instant payouts for marketplaces](https://stripe.com/blog/instant-payouts-for-marketplaces) for more information.) */ - readonly method: string; + readonly method: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "payout"; + readonly object: 'payout' /** @description The source balance this payout came from. One of `card`, `fpx`, or `bank_account`. */ - readonly source_type: string; + readonly source_type: string /** @description Extra information about a payout to be displayed on the user's bank statement. */ - readonly statement_descriptor?: string; + readonly statement_descriptor?: string /** @description Current status of the payout: `paid`, `pending`, `in_transit`, `canceled` or `failed`. A payout is `pending` until it is submitted to the bank, when it becomes `in_transit`. The status then changes to `paid` if the transaction goes through, or to `failed` or `canceled` (within 5 business days). Some failed payouts may initially show as `paid` but then change to `failed`. */ - readonly status: string; + readonly status: string /** * @description Can be `bank_account` or `card`. * @enum {string} */ - readonly type: "bank_account" | "card"; - }; + readonly type: 'bank_account' | 'card' + } /** Period */ readonly period: { /** @description The end date of this usage period. All usage up to and including this point in time is included. */ - readonly end?: number; + readonly end?: number /** @description The start date of this usage period. All usage after this point in time is included. */ - readonly start?: number; - }; + readonly start?: number + } /** * Person * @description This is an object representing a person associated with a Stripe account. @@ -7900,66 +7871,66 @@ export interface definitions { * Related guide: [Handling Identity Verification with the API](https://stripe.com/docs/connect/identity-verification-api#person-information). */ readonly person: { - readonly account: string; - readonly address?: definitions["address"]; - readonly address_kana?: definitions["legal_entity_japan_address"]; - readonly address_kanji?: definitions["legal_entity_japan_address"]; + readonly account: string + readonly address?: definitions['address'] + readonly address_kana?: definitions['legal_entity_japan_address'] + readonly address_kanji?: definitions['legal_entity_japan_address'] /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; - readonly dob?: definitions["legal_entity_dob"]; - readonly email?: string; - readonly first_name?: string; - readonly first_name_kana?: string; - readonly first_name_kanji?: string; - readonly gender?: string; + readonly created: number + readonly dob?: definitions['legal_entity_dob'] + readonly email?: string + readonly first_name?: string + readonly first_name_kana?: string + readonly first_name_kanji?: string + readonly gender?: string /** @description Unique identifier for the object. */ - readonly id: string; - readonly id_number_provided?: boolean; - readonly last_name?: string; - readonly last_name_kana?: string; - readonly last_name_kanji?: string; - readonly maiden_name?: string; + readonly id: string + readonly id_number_provided?: boolean + readonly last_name?: string + readonly last_name_kana?: string + readonly last_name_kanji?: string + readonly maiden_name?: string /** @description 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. */ - readonly metadata?: { readonly [key: string]: unknown }; + readonly metadata?: { readonly [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "person"; - readonly phone?: string; - readonly relationship?: definitions["person_relationship"]; - readonly requirements?: definitions["person_requirements"]; - readonly ssn_last_4_provided?: boolean; - readonly verification?: definitions["legal_entity_person_verification"]; - }; + readonly object: 'person' + readonly phone?: string + readonly relationship?: definitions['person_relationship'] + readonly requirements?: definitions['person_requirements'] + readonly ssn_last_4_provided?: boolean + readonly verification?: definitions['legal_entity_person_verification'] + } /** PersonRelationship */ readonly person_relationship: { /** @description Whether the person is a director of the account's legal entity. Currently only required for accounts in the EU. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations. */ - readonly director?: boolean; + readonly director?: boolean /** @description Whether the person has significant responsibility to control, manage, or direct the organization. */ - readonly executive?: boolean; + readonly executive?: boolean /** @description Whether the person is an owner of the account’s legal entity. */ - readonly owner?: boolean; + readonly owner?: boolean /** @description The percent owned by the person of the account's legal entity. */ - readonly percent_ownership?: number; + readonly percent_ownership?: number /** @description 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. */ - readonly representative?: boolean; + readonly representative?: boolean /** @description The person's title (e.g., CEO, Support Engineer). */ - readonly title?: string; - }; + readonly title?: string + } /** PersonRequirements */ readonly person_requirements: { /** @description 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. */ - readonly currently_due: readonly string[]; + readonly currently_due: readonly string[] /** @description The fields that need to be collected again because validation or verification failed for some reason. */ - readonly errors: readonly definitions["account_requirements_error"][]; + readonly errors: readonly definitions['account_requirements_error'][] /** @description Fields that need to be collected assuming all volume thresholds are reached. As fields are needed, they are moved to `currently_due` and the account's `current_deadline` is set. */ - readonly eventually_due: readonly string[]; + readonly eventually_due: readonly string[] /** @description Fields that weren't collected by the account's `current_deadline`. These fields need to be collected to enable payouts for the person's account. */ - readonly past_due: readonly string[]; + readonly past_due: readonly string[] /** @description Fields that may become required depending on the results of verification or review. An empty array unless an asynchronous verification is pending. If verification fails, the fields in this array become required and move to `currently_due` or `past_due`. */ - readonly pending_verification: readonly string[]; - }; + readonly pending_verification: readonly string[] + } /** * Plan * @description Plans define the base price, currency, and billing cycle for recurring purchases of products. @@ -7971,92 +7942,92 @@ export interface definitions { */ readonly plan: { /** @description Whether the plan can be used for new purchases. */ - readonly active: boolean; + readonly active: boolean /** * @description 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`. * @enum {string} */ - readonly aggregate_usage?: "last_during_period" | "last_ever" | "max" | "sum"; + readonly aggregate_usage?: 'last_during_period' | 'last_ever' | 'max' | 'sum' /** @description The amount in %s to be charged on the interval specified. */ - readonly amount?: number; + readonly amount?: number /** @description Same as `amount`, but contains a decimal value with at most 12 decimal places. */ - readonly amount_decimal?: string; + readonly amount_decimal?: string /** * @description 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. * @enum {string} */ - readonly billing_scheme: "per_unit" | "tiered"; + readonly billing_scheme: 'per_unit' | 'tiered' /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`. * @enum {string} */ - readonly interval: "day" | "month" | "week" | "year"; + readonly interval: 'day' | 'month' | 'week' | 'year' /** @description The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. */ - readonly interval_count: number; + readonly interval_count: number /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata: { readonly [key: string]: unknown }; + readonly metadata: { readonly [key: string]: unknown } /** @description A brief description of the plan, hidden from customers. */ - readonly nickname?: string; + readonly nickname?: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "plan"; + readonly object: 'plan' /** @description The product whose pricing this plan determines. */ - readonly product?: string; + readonly product?: string /** @description Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. */ - readonly tiers?: readonly definitions["plan_tier"][]; + readonly tiers?: readonly definitions['plan_tier'][] /** * @description 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. * @enum {string} */ - readonly tiers_mode?: "graduated" | "volume"; - readonly transform_usage?: definitions["transform_usage"]; + readonly tiers_mode?: 'graduated' | 'volume' + readonly transform_usage?: definitions['transform_usage'] /** @description 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). */ - readonly trial_period_days?: number; + readonly trial_period_days?: number /** * @description 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`. * @enum {string} */ - readonly usage_type: "licensed" | "metered"; - }; + readonly usage_type: 'licensed' | 'metered' + } /** PlanTier */ readonly plan_tier: { /** @description Price for the entire tier. */ - readonly flat_amount?: number; + readonly flat_amount?: number /** @description Same as `flat_amount`, but contains a decimal value with at most 12 decimal places. */ - readonly flat_amount_decimal?: string; + readonly flat_amount_decimal?: string /** @description Per unit price for units relevant to the tier. */ - readonly unit_amount?: number; + readonly unit_amount?: number /** @description Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. */ - readonly unit_amount_decimal?: string; + readonly unit_amount_decimal?: string /** @description Up to and including to this quantity will be contained in the tier. */ - readonly up_to?: number; - }; + readonly up_to?: number + } /** PlatformTax */ readonly platform_tax_fee: { /** @description The Connected account that incurred this charge. */ - readonly account: string; + readonly account: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "platform_tax_fee"; + readonly object: 'platform_tax_fee' /** @description The payment object that caused this tax to be inflicted. */ - readonly source_transaction: string; + readonly source_transaction: string /** @description The type of tax (VAT). */ - readonly type: string; - }; + readonly type: string + } /** * Product * @description Products describe the specific goods or services you offer to your customers. @@ -8067,49 +8038,49 @@ export interface definitions { */ readonly product: { /** @description Whether the product is currently available for purchase. */ - readonly active: boolean; + readonly active: boolean /** @description A list of up to 5 attributes that each SKU can provide values for (e.g., `["color", "size"]`). */ - readonly attributes?: readonly string[]; + readonly attributes?: readonly string[] /** @description A short one-line description of the product, meant to be displayable to the customer. Only applicable to products of `type=good`. */ - readonly caption?: string; + readonly caption?: string /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description An array of connect application identifiers that cannot purchase this product. Only applicable to products of `type=good`. */ - readonly deactivate_on?: readonly string[]; + readonly deactivate_on?: readonly string[] /** @description 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. */ - readonly description?: string; + readonly description?: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description A list of up to 8 URLs of images for this product, meant to be displayable to the customer. */ - readonly images: readonly string[]; + readonly images: readonly string[] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata: { readonly [key: string]: unknown }; + readonly metadata: { readonly [key: string]: unknown } /** @description The product's name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions. */ - readonly name: string; + readonly name: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "product"; - readonly package_dimensions?: definitions["package_dimensions"]; + readonly object: 'product' + readonly package_dimensions?: definitions['package_dimensions'] /** @description Whether this product is a shipped good. Only applicable to products of `type=good`. */ - readonly shippable?: boolean; + readonly shippable?: boolean /** @description 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. */ - readonly statement_descriptor?: string; + readonly statement_descriptor?: string /** * @description The type of the product. The product is either of type `good`, which is eligible for use with Orders and SKUs, or `service`, which is eligible for use with Subscriptions and Plans. * @enum {string} */ - readonly type: "good" | "service"; + readonly type: 'good' | 'service' /** @description A label that represents units of this product in Stripe and on customers’ receipts and invoices. When set, this will be included in associated invoice line item descriptions. */ - readonly unit_label?: string; + readonly unit_label?: string /** @description Time at which the object was last updated. Measured in seconds since the Unix epoch. */ - readonly updated: number; + readonly updated: number /** @description A URL of a publicly-accessible webpage for this product. Only applicable to products of `type=good`. */ - readonly url?: string; - }; + readonly url?: string + } /** * RadarEarlyFraudWarning * @description An early fraud warning indicates that the card issuer has notified us that a @@ -8117,130 +8088,123 @@ export interface definitions { * * Related guide: [Early Fraud Warnings](https://stripe.com/docs/disputes/measuring#early-fraud-warnings). */ - readonly "radar.early_fraud_warning": { + readonly 'radar.early_fraud_warning': { /** @description 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. */ - readonly actionable: boolean; + readonly actionable: boolean /** @description ID of the charge this early fraud warning is for, optionally expanded. */ - readonly charge: string; + readonly charge: string /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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`. */ - readonly fraud_type: string; + readonly fraud_type: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "radar.early_fraud_warning"; - }; + readonly object: 'radar.early_fraud_warning' + } /** * RadarListList * @description Value lists allow you to group values together which can then be referenced in rules. * * Related guide: [Default Stripe Lists](https://stripe.com/docs/radar/lists#managing-list-items). */ - readonly "radar.value_list": { + readonly 'radar.value_list': { /** @description The name of the value list for use in rules. */ - readonly alias: string; + readonly alias: string /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description The name or email address of the user who created this value list. */ - readonly created_by: string; + readonly created_by: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description The type of items in the value list. One of `card_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, or `case_sensitive_string`. * @enum {string} */ - readonly item_type: - | "card_bin" - | "card_fingerprint" - | "case_sensitive_string" - | "country" - | "email" - | "ip_address" - | "string"; + readonly item_type: 'card_bin' | 'card_fingerprint' | 'case_sensitive_string' | 'country' | 'email' | 'ip_address' | 'string' /** * RadarListListItemList * @description List of items contained within this value list. */ readonly list_items: { /** @description Details about each object. */ - readonly data: readonly definitions["radar.value_list_item"][]; + readonly data: readonly definitions['radar.value_list_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; + readonly url: string + } /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata: { readonly [key: string]: unknown }; + readonly metadata: { readonly [key: string]: unknown } /** @description The name of the value list. */ - readonly name: string; + readonly name: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "radar.value_list"; - }; + readonly object: 'radar.value_list' + } /** * RadarListListItem * @description Value list items allow you to add specific values to a given Radar value list, which can then be used in rules. * * Related guide: [Managing List Items](https://stripe.com/docs/radar/lists#managing-list-items). */ - readonly "radar.value_list_item": { + readonly 'radar.value_list_item': { /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description The name or email address of the user who added this item to the value list. */ - readonly created_by: string; + readonly created_by: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "radar.value_list_item"; + readonly object: 'radar.value_list_item' /** @description The value of the item. */ - readonly value: string; + readonly value: string /** @description The identifier of the value list this item belongs to. */ - readonly value_list: string; - }; + readonly value_list: string + } /** RadarReviewResourceLocation */ readonly radar_review_resource_location: { /** @description The city where the payment originated. */ - readonly city?: string; + readonly city?: string /** @description Two-letter ISO code representing the country where the payment originated. */ - readonly country?: string; + readonly country?: string /** @description The geographic latitude where the payment originated. */ - readonly latitude?: number; + readonly latitude?: number /** @description The geographic longitude where the payment originated. */ - readonly longitude?: number; + readonly longitude?: number /** @description The state/county/province/region where the payment originated. */ - readonly region?: string; - }; + readonly region?: string + } /** RadarReviewResourceSession */ readonly radar_review_resource_session: { /** @description The browser used in this browser session (e.g., `Chrome`). */ - readonly browser?: string; + readonly browser?: string /** @description Information about the device used for the browser session (e.g., `Samsung SM-G930T`). */ - readonly device?: string; + readonly device?: string /** @description The platform for the browser session (e.g., `Macintosh`). */ - readonly platform?: string; + readonly platform?: string /** @description The version for the browser session (e.g., `61.0.3163.100`). */ - readonly version?: string; - }; + readonly version?: string + } /** * TransferRecipient * @description With `Recipient` objects, you can transfer money from your Stripe account to a @@ -8256,46 +8220,46 @@ export interface definitions { * [migration guide](https://stripe.com/docs/connect/recipient-account-migrations) for more information.** */ readonly recipient: { - readonly active_account?: definitions["bank_account"]; + readonly active_account?: definitions['bank_account'] /** CardList */ readonly cards?: { - readonly data: readonly definitions["card"][]; + readonly data: readonly definitions['card'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; + readonly url: string + } /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description The default card to use for creating transfers to this recipient. */ - readonly default_card?: string; + readonly default_card?: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string; - readonly email?: string; + readonly description?: string + readonly email?: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata: { readonly [key: string]: unknown }; + readonly metadata: { readonly [key: string]: unknown } /** @description The ID of the [Custom account](https://stripe.com/docs/connect/custom-accounts) this recipient was migrated to. If set, the recipient can no longer be updated, nor can transfers be made to it: use the Custom account instead. */ - readonly migrated_to?: string; + readonly migrated_to?: string /** @description Full, legal name of the recipient. */ - readonly name?: string; + readonly name?: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "recipient"; - readonly rolled_back_from?: string; + readonly object: 'recipient' + readonly rolled_back_from?: string /** @description Type of the recipient, one of `individual` or `corporation`. */ - readonly type: string; - }; + readonly type: string + } /** * Refund * @description `Refund` objects allow you to refund a charge that has previously been created @@ -8306,43 +8270,43 @@ export interface definitions { */ readonly refund: { /** @description Amount, in %s. */ - readonly amount: number; + readonly amount: number /** @description Balance transaction that describes the impact on your account balance. */ - readonly balance_transaction?: string; + readonly balance_transaction?: string /** @description ID of the charge that was refunded. */ - readonly charge?: string; + readonly charge?: string /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. (Available on non-card refunds only) */ - readonly description?: string; + readonly description?: string /** @description If the refund failed, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction. */ - readonly failure_balance_transaction?: string; + readonly failure_balance_transaction?: string /** @description If the refund failed, the reason for refund failure if known. Possible values are `lost_or_stolen_card`, `expired_or_canceled_card`, or `unknown`. */ - readonly failure_reason?: string; + readonly failure_reason?: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description 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. */ - readonly metadata: { readonly [key: string]: unknown }; + readonly metadata: { readonly [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "refund"; + readonly object: 'refund' /** @description ID of the PaymentIntent that was refunded. */ - readonly payment_intent?: string; + readonly payment_intent?: string /** @description Reason for the refund, either user-provided (`duplicate`, `fraudulent`, or `requested_by_customer`) or generated by Stripe internally (`expired_uncaptured_charge`). */ - readonly reason?: string; + readonly reason?: string /** @description This is the transaction number that appears on email receipts sent for this refund. */ - readonly receipt_number?: string; + readonly receipt_number?: string /** @description The transfer reversal that is associated with the refund. Only present if the charge came from another Stripe account. See the Connect documentation for details. */ - readonly source_transfer_reversal?: string; + readonly source_transfer_reversal?: string /** @description Status of the refund. For credit card refunds, this can be `pending`, `succeeded`, or `failed`. For other types of refunds, it can be `pending`, `succeeded`, `failed`, or `canceled`. Refer to our [refunds](https://stripe.com/docs/refunds#failed-refunds) documentation for more details. */ - readonly status?: string; + readonly status?: string /** @description If the accompanying transfer was reversed, the transfer reversal object. Only applicable if the charge was created using the destination parameter. */ - readonly transfer_reversal?: string; - }; + readonly transfer_reversal?: string + } /** * reporting_report_run * @description The Report Run object represents an instance of a report type generated with @@ -8355,39 +8319,39 @@ export interface definitions { * data), and thus related requests must be made with a * [live-mode API key](https://stripe.com/docs/keys#test-live-modes). */ - readonly "reporting.report_run": { + readonly 'reporting.report_run': { /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** * @description If something should go wrong during the run, a message about the failure (populated when * `status=failed`). */ - readonly error?: string; + readonly error?: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Always `true`: reports can only be run on live-mode data. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "reporting.report_run"; - readonly parameters: definitions["financial_reporting_finance_report_run_run_parameters"]; + readonly object: 'reporting.report_run' + readonly parameters: definitions['financial_reporting_finance_report_run_run_parameters'] /** @description The ID of the [report type](https://stripe.com/docs/reporting/statements/api#report-types) to run, such as `"balance.summary.1"`. */ - readonly report_type: string; - readonly result?: definitions["file"]; + readonly report_type: string + readonly result?: definitions['file'] /** * @description 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. * Rarely, we may encounter an error, at which point this will be set to `failed` and the `error` field will be populated. */ - readonly status: string; + readonly status: string /** * @description Timestamp at which this run successfully finished (populated when * `status=succeeded`). Measured in seconds since the Unix epoch. */ - readonly succeeded_at?: number; - }; + readonly succeeded_at?: number + } /** * reporting_report_type * @description The Report Type resource corresponds to a particular type of report, such as @@ -8400,42 +8364,42 @@ export interface definitions { * data), and thus related requests must be made with a * [live-mode API key](https://stripe.com/docs/keys#test-live-modes). */ - readonly "reporting.report_type": { + readonly 'reporting.report_type': { /** @description Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch. */ - readonly data_available_end: number; + readonly data_available_end: number /** @description Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch. */ - readonly data_available_start: number; + readonly data_available_start: number /** @description 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.) */ - readonly default_columns?: readonly string[]; + readonly default_columns?: readonly string[] /** @description The [ID of the Report Type](https://stripe.com/docs/reporting/statements/api#available-report-types), such as `balance.summary.1`. */ - readonly id: string; + readonly id: string /** @description Human-readable name of the Report Type */ - readonly name: string; + readonly name: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "reporting.report_type"; + readonly object: 'reporting.report_type' /** @description When this Report Type was latest updated. Measured in seconds since the Unix epoch. */ - readonly updated: number; + readonly updated: number /** @description 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. */ - readonly version: number; - }; + readonly version: number + } /** ReserveTransaction */ readonly reserve_transaction: { - readonly amount: number; + readonly amount: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string; + readonly description?: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "reserve_transaction"; - }; + readonly object: 'reserve_transaction' + } /** * RadarReview * @description Reviews can be used to supplement automated fraud detection with human expertise. @@ -8445,50 +8409,50 @@ export interface definitions { */ readonly review: { /** @description The ZIP or postal code of the card used, if applicable. */ - readonly billing_zip?: string; + readonly billing_zip?: string /** @description The charge associated with this review. */ - readonly charge?: string; + readonly charge?: string /** * @description The reason the review was closed, or null if it has not yet been closed. One of `approved`, `refunded`, `refunded_as_fraud`, or `disputed`. * @enum {string} */ - readonly closed_reason?: "approved" | "disputed" | "refunded" | "refunded_as_fraud"; + readonly closed_reason?: 'approved' | 'disputed' | 'refunded' | 'refunded_as_fraud' /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description The IP address where the payment originated. */ - readonly ip_address?: string; - readonly ip_address_location?: definitions["radar_review_resource_location"]; + readonly ip_address?: string + readonly ip_address_location?: definitions['radar_review_resource_location'] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "review"; + readonly object: 'review' /** @description If `true`, the review needs action. */ - readonly open: boolean; + readonly open: boolean /** * @description The reason the review was opened. One of `rule` or `manual`. * @enum {string} */ - readonly opened_reason: "manual" | "rule"; + readonly opened_reason: 'manual' | 'rule' /** @description The PaymentIntent ID associated with this review, if one exists. */ - readonly payment_intent?: string; + readonly payment_intent?: string /** @description The reason the review is currently open or closed. One of `rule`, `manual`, `approved`, `refunded`, `refunded_as_fraud`, or `disputed`. */ - readonly reason: string; - readonly session?: definitions["radar_review_resource_session"]; - }; + readonly reason: string + readonly session?: definitions['radar_review_resource_session'] + } /** RadarRule */ readonly rule: { /** @description The action taken on the payment. */ - readonly action: string; + readonly action: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description The predicate to evaluate the payment against. */ - readonly predicate: string; - }; + readonly predicate: string + } /** * ScheduledQueryRun * @description If you have [scheduled a Sigma query](https://stripe.com/docs/sigma/scheduled-queries), you'll @@ -8498,29 +8462,29 @@ export interface definitions { */ readonly scheduled_query_run: { /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description When the query was run, Sigma contained a snapshot of your Stripe data at this time. */ - readonly data_load_time: number; - readonly error?: definitions["sigma_scheduled_query_run_error"]; - readonly file?: definitions["file"]; + readonly data_load_time: number + readonly error?: definitions['sigma_scheduled_query_run_error'] + readonly file?: definitions['file'] /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "scheduled_query_run"; + readonly object: 'scheduled_query_run' /** @description Time at which the result expires and is no longer available for download. */ - readonly result_available_until: number; + readonly result_available_until: number /** @description SQL for the query. */ - readonly sql: string; + readonly sql: string /** @description The query's execution status, which will be `completed` for successful runs, and `canceled`, `failed`, or `timed_out` otherwise. */ - readonly status: string; + readonly status: string /** @description Title of the query. */ - readonly title: string; - }; + readonly title: string + } /** * SetupIntent * @description A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. @@ -8548,126 +8512,120 @@ export interface definitions { */ readonly setup_intent: { /** @description ID of the Connect application that created the SetupIntent. */ - readonly application?: string; + readonly application?: string /** * @description Reason for cancellation of this SetupIntent, one of `abandoned`, `requested_by_customer`, or `duplicate`. * @enum {string} */ - readonly cancellation_reason?: "abandoned" | "duplicate" | "requested_by_customer"; + readonly cancellation_reason?: 'abandoned' | 'duplicate' | 'requested_by_customer' /** * @description The client secret of this SetupIntent. Used for client-side retrieval using a publishable key. * * The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, embedded in URLs, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret. */ - readonly client_secret?: string; + readonly client_secret?: string /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** * @description ID of the Customer this SetupIntent belongs to, if one exists. * * If 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. */ - readonly customer?: string; + readonly customer?: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string; + readonly description?: string /** @description Unique identifier for the object. */ - readonly id: string; - readonly last_setup_error?: definitions["api_errors"]; + readonly id: string + readonly last_setup_error?: definitions['api_errors'] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description ID of the multi use Mandate generated by the SetupIntent. */ - readonly mandate?: string; + readonly mandate?: string /** @description 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. */ - readonly metadata?: { readonly [key: string]: unknown }; - readonly next_action?: definitions["setup_intent_next_action"]; + readonly metadata?: { readonly [key: string]: unknown } + readonly next_action?: definitions['setup_intent_next_action'] /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "setup_intent"; + readonly object: 'setup_intent' /** @description The account (if any) for which the setup is intended. */ - readonly on_behalf_of?: string; + readonly on_behalf_of?: string /** @description ID of the payment method used with this SetupIntent. */ - readonly payment_method?: string; - readonly payment_method_options?: definitions["setup_intent_payment_method_options"]; + readonly payment_method?: string + readonly payment_method_options?: definitions['setup_intent_payment_method_options'] /** @description The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. */ - readonly payment_method_types: readonly string[]; + readonly payment_method_types: readonly string[] /** @description ID of the single_use Mandate generated by the SetupIntent. */ - readonly single_use_mandate?: string; + readonly single_use_mandate?: string /** * @description [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`. * @enum {string} */ - readonly status: - | "canceled" - | "processing" - | "requires_action" - | "requires_confirmation" - | "requires_payment_method" - | "succeeded"; + readonly status: 'canceled' | 'processing' | 'requires_action' | 'requires_confirmation' | 'requires_payment_method' | 'succeeded' /** * @description Indicates how the payment method is intended to be used in the future. * * Use `on_session` if you intend to only reuse the payment method when the customer is in your checkout flow. Use `off_session` if your customer may or may not be in your checkout flow. If not provided, this value defaults to `off_session`. */ - readonly usage: string; - }; + readonly usage: string + } /** SetupIntentNextAction */ readonly setup_intent_next_action: { - readonly redirect_to_url?: definitions["setup_intent_next_action_redirect_to_url"]; + readonly redirect_to_url?: definitions['setup_intent_next_action_redirect_to_url'] /** @description Type of the next action to perform, one of `redirect_to_url` or `use_stripe_sdk`. */ - readonly type: string; + readonly type: string /** @description 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. */ - readonly use_stripe_sdk?: { readonly [key: string]: unknown }; - }; + readonly use_stripe_sdk?: { readonly [key: string]: unknown } + } /** SetupIntentNextActionRedirectToUrl */ readonly setup_intent_next_action_redirect_to_url: { /** @description If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion. */ - readonly return_url?: string; + readonly return_url?: string /** @description The URL you must redirect your customer to in order to authenticate. */ - readonly url?: string; - }; + readonly url?: string + } /** SetupIntentPaymentMethodOptions */ readonly setup_intent_payment_method_options: { - readonly card?: definitions["setup_intent_payment_method_options_card"]; - }; + readonly card?: definitions['setup_intent_payment_method_options_card'] + } /** setup_intent_payment_method_options_card */ readonly setup_intent_payment_method_options_card: { /** * @description 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. Permitted values include: `automatic` or `any`. If not provided, defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. * @enum {string} */ - readonly request_three_d_secure?: "any" | "automatic" | "challenge_only"; - }; + readonly request_three_d_secure?: 'any' | 'automatic' | 'challenge_only' + } /** Shipping */ readonly shipping: { - readonly address?: definitions["address"]; + readonly address?: definitions['address'] /** @description The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. */ - readonly carrier?: string; + readonly carrier?: string /** @description Recipient name. */ - readonly name?: string; + readonly name?: string /** @description Recipient phone (including extension). */ - readonly phone?: string; + readonly phone?: string /** @description 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. */ - readonly tracking_number?: string; - }; + readonly tracking_number?: string + } /** ShippingMethod */ readonly shipping_method: { /** @description 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 line item. */ - readonly amount: number; + readonly amount: number /** @description 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). */ - readonly currency: string; - readonly delivery_estimate?: definitions["delivery_estimate"]; + readonly currency: string + readonly delivery_estimate?: definitions['delivery_estimate'] /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description: string; + readonly description: string /** @description Unique identifier for the object. */ - readonly id: string; - }; + readonly id: string + } /** SigmaScheduledQueryRunError */ readonly sigma_scheduled_query_run_error: { /** @description Information about the run failure. */ - readonly message: string; - }; + readonly message: string + } /** * SKU * @description Stores representations of [stock keeping units](http://en.wikipedia.org/wiki/Stock_keeping_unit). @@ -8681,35 +8639,35 @@ export interface definitions { */ readonly sku: { /** @description Whether the SKU is available for purchase. */ - readonly active: boolean; + readonly active: boolean /** @description A dictionary of attributes and values for the attributes defined by the product. If, for example, a product's attributes are `["size", "gender"]`, a valid SKU has the following dictionary of attributes: `{"size": "Medium", "gender": "Unisex"}`. */ - readonly attributes: { readonly [key: string]: unknown }; + readonly attributes: { readonly [key: string]: unknown } /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description The URL of an image for this SKU, meant to be displayable to the customer. */ - readonly image?: string; - readonly inventory: definitions["inventory"]; + readonly image?: string + readonly inventory: definitions['inventory'] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata: { readonly [key: string]: unknown }; + readonly metadata: { readonly [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "sku"; - readonly package_dimensions?: definitions["package_dimensions"]; + readonly object: 'sku' + readonly package_dimensions?: definitions['package_dimensions'] /** @description The cost of the item as a positive integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a zero-decimal currency). */ - readonly price: number; + readonly price: number /** @description The ID of the product this SKU is associated with. The product must be currently active. */ - readonly product: string; + readonly product: string /** @description Time at which the object was last updated. Measured in seconds since the Unix epoch. */ - readonly updated: number; - }; + readonly updated: number + } /** * Source * @description `Source` objects allow you to accept a variety of payment methods. They @@ -8720,87 +8678,87 @@ export interface definitions { * Related guides: [Sources API](https://stripe.com/docs/sources) and [Sources & Customers](https://stripe.com/docs/sources/customers). */ readonly source: { - readonly ach_credit_transfer?: definitions["source_type_ach_credit_transfer"]; - readonly ach_debit?: definitions["source_type_ach_debit"]; - readonly alipay?: definitions["source_type_alipay"]; + readonly ach_credit_transfer?: definitions['source_type_ach_credit_transfer'] + readonly ach_debit?: definitions['source_type_ach_debit'] + readonly alipay?: definitions['source_type_alipay'] /** @description 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. */ - readonly amount?: number; - readonly au_becs_debit?: definitions["source_type_au_becs_debit"]; - readonly bancontact?: definitions["source_type_bancontact"]; - readonly card?: definitions["source_type_card"]; - readonly card_present?: definitions["source_type_card_present"]; + readonly amount?: number + readonly au_becs_debit?: definitions['source_type_au_becs_debit'] + readonly bancontact?: definitions['source_type_bancontact'] + readonly card?: definitions['source_type_card'] + readonly card_present?: definitions['source_type_card_present'] /** @description The client secret of the source. Used for client-side retrieval using a publishable key. */ - readonly client_secret: string; - readonly code_verification?: definitions["source_code_verification_flow"]; + readonly client_secret: string + readonly code_verification?: definitions['source_code_verification_flow'] /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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. */ - readonly currency?: string; + readonly currency?: string /** @description 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. */ - readonly customer?: string; - readonly eps?: definitions["source_type_eps"]; + readonly customer?: string + readonly eps?: definitions['source_type_eps'] /** @description The authentication `flow` of the source. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`. */ - readonly flow: string; - readonly giropay?: definitions["source_type_giropay"]; + readonly flow: string + readonly giropay?: definitions['source_type_giropay'] /** @description Unique identifier for the object. */ - readonly id: string; - readonly ideal?: definitions["source_type_ideal"]; - readonly klarna?: definitions["source_type_klarna"]; + readonly id: string + readonly ideal?: definitions['source_type_ideal'] + readonly klarna?: definitions['source_type_klarna'] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata?: { readonly [key: string]: unknown }; - readonly multibanco?: definitions["source_type_multibanco"]; + readonly metadata?: { readonly [key: string]: unknown } + readonly multibanco?: definitions['source_type_multibanco'] /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "source"; - readonly owner?: definitions["source_owner"]; - readonly p24?: definitions["source_type_p24"]; - readonly receiver?: definitions["source_receiver_flow"]; - readonly redirect?: definitions["source_redirect_flow"]; - readonly sepa_debit?: definitions["source_type_sepa_debit"]; - readonly sofort?: definitions["source_type_sofort"]; - readonly source_order?: definitions["source_order"]; + readonly object: 'source' + readonly owner?: definitions['source_owner'] + readonly p24?: definitions['source_type_p24'] + readonly receiver?: definitions['source_receiver_flow'] + readonly redirect?: definitions['source_redirect_flow'] + readonly sepa_debit?: definitions['source_type_sepa_debit'] + readonly sofort?: definitions['source_type_sofort'] + readonly source_order?: definitions['source_order'] /** @description Extra information about a source. This will appear on your customer's statement every time you charge the source. */ - readonly statement_descriptor?: string; + readonly statement_descriptor?: string /** @description The status of the source, one of `canceled`, `chargeable`, `consumed`, `failed`, or `pending`. Only `chargeable` sources can be used to create a charge. */ - readonly status: string; - readonly three_d_secure?: definitions["source_type_three_d_secure"]; + readonly status: string + readonly three_d_secure?: definitions['source_type_three_d_secure'] /** * @description 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. * @enum {string} */ readonly type: - | "ach_credit_transfer" - | "ach_debit" - | "alipay" - | "au_becs_debit" - | "bancontact" - | "card" - | "card_present" - | "eps" - | "giropay" - | "ideal" - | "klarna" - | "multibanco" - | "p24" - | "sepa_debit" - | "sofort" - | "three_d_secure" - | "wechat"; + | 'ach_credit_transfer' + | 'ach_debit' + | 'alipay' + | 'au_becs_debit' + | 'bancontact' + | 'card' + | 'card_present' + | 'eps' + | 'giropay' + | 'ideal' + | 'klarna' + | 'multibanco' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'three_d_secure' + | 'wechat' /** @description 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. */ - readonly usage?: string; - readonly wechat?: definitions["source_type_wechat"]; - }; + readonly usage?: string + readonly wechat?: definitions['source_type_wechat'] + } /** SourceCodeVerificationFlow */ readonly source_code_verification_flow: { /** @description The number of attempts remaining to authenticate the source object with a verification code. */ - readonly attempts_remaining: number; + readonly attempts_remaining: number /** @description 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). */ - readonly status: string; - }; + readonly status: string + } /** * SourceMandateNotification * @description Source mandate notifications should be created when a notification related to @@ -8809,110 +8767,110 @@ export interface definitions { */ readonly source_mandate_notification: { /** @description 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`. */ - readonly amount?: number; - readonly bacs_debit?: definitions["source_mandate_notification_bacs_debit_data"]; + readonly amount?: number + readonly bacs_debit?: definitions['source_mandate_notification_bacs_debit_data'] /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "source_mandate_notification"; + readonly object: 'source_mandate_notification' /** @description The reason of the mandate notification. Valid reasons are `mandate_confirmed` or `debit_initiated`. */ - readonly reason: string; - readonly sepa_debit?: definitions["source_mandate_notification_sepa_debit_data"]; - readonly source: definitions["source"]; + readonly reason: string + readonly sepa_debit?: definitions['source_mandate_notification_sepa_debit_data'] + readonly source: definitions['source'] /** @description The status of the mandate notification. Valid statuses are `pending` or `submitted`. */ - readonly status: string; + readonly status: string /** @description 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`. */ - readonly type: string; - }; + readonly type: string + } /** SourceMandateNotificationBacsDebitData */ readonly source_mandate_notification_bacs_debit_data: { /** @description Last 4 digits of the account number associated with the debit. */ - readonly last4?: string; - }; + readonly last4?: string + } /** SourceMandateNotificationSepaDebitData */ readonly source_mandate_notification_sepa_debit_data: { /** @description SEPA creditor ID. */ - readonly creditor_identifier?: string; + readonly creditor_identifier?: string /** @description Last 4 digits of the account number associated with the debit. */ - readonly last4?: string; + readonly last4?: string /** @description Mandate reference associated with the debit. */ - readonly mandate_reference?: string; - }; + readonly mandate_reference?: string + } /** SourceOrder */ readonly source_order: { /** @description 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. */ - readonly amount: number; + readonly amount: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description The email address of the customer placing the order. */ - readonly email?: string; + readonly email?: string /** @description List of items constituting the order. */ - readonly items?: readonly definitions["source_order_item"][]; - readonly shipping?: definitions["shipping"]; - }; + readonly items?: readonly definitions['source_order_item'][] + readonly shipping?: definitions['shipping'] + } /** SourceOrderItem */ readonly source_order_item: { /** @description The amount (price) for this order item. */ - readonly amount?: number; + readonly amount?: number /** @description This currency of this order item. Required when `amount` is present. */ - readonly currency?: string; + readonly currency?: string /** @description Human-readable description for this order item. */ - readonly description?: string; + readonly description?: string /** @description The quantity of this order item. When type is `sku`, this is the number of instances of the SKU to be ordered. */ - readonly quantity?: number; + readonly quantity?: number /** @description The type of this order item. Must be `sku`, `tax`, or `shipping`. */ - readonly type?: string; - }; + readonly type?: string + } /** SourceOwner */ readonly source_owner: { - readonly address?: definitions["address"]; + readonly address?: definitions['address'] /** @description Owner's email address. */ - readonly email?: string; + readonly email?: string /** @description Owner's full name. */ - readonly name?: string; + readonly name?: string /** @description Owner's phone number (including extension). */ - readonly phone?: string; - readonly verified_address?: definitions["address"]; + readonly phone?: string + readonly verified_address?: definitions['address'] /** @description 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. */ - readonly verified_email?: string; + readonly verified_email?: string /** @description 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. */ - readonly verified_name?: string; + readonly verified_name?: string /** @description 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. */ - readonly verified_phone?: string; - }; + readonly verified_phone?: string + } /** SourceReceiverFlow */ readonly source_receiver_flow: { /** @description The address of the receiver source. This is the value that should be communicated to the customer to send their funds to. */ - readonly address?: string; + readonly address?: string /** @description 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. */ - readonly amount_charged: number; + readonly amount_charged: number /** @description 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. */ - readonly amount_received: number; + readonly amount_received: number /** @description The total amount that was returned to the customer. The amount returned is expressed in the source's currency. */ - readonly amount_returned: number; + readonly amount_returned: number /** @description Type of refund attribute method, one of `email`, `manual`, or `none`. */ - readonly refund_attributes_method: string; + readonly refund_attributes_method: string /** @description Type of refund attribute status, one of `missing`, `requested`, or `available`. */ - readonly refund_attributes_status: string; - }; + readonly refund_attributes_status: string + } /** SourceRedirectFlow */ readonly source_redirect_flow: { /** @description 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`. */ - readonly failure_reason?: string; + readonly failure_reason?: string /** @description The URL you provide to redirect the customer to after they authenticated their payment. */ - readonly return_url: string; + readonly return_url: string /** @description 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). */ - readonly status: string; + readonly status: string /** @description The URL provided to you to redirect a customer to as part of a `redirect` authentication flow. */ - readonly url: string; - }; + readonly url: string + } /** * SourceTransaction * @description Some payment methods have no required amount that a customer must send. @@ -8921,297 +8879,297 @@ export interface definitions { * transactions. */ readonly source_transaction: { - readonly ach_credit_transfer?: definitions["source_transaction_ach_credit_transfer_data"]; + readonly ach_credit_transfer?: definitions['source_transaction_ach_credit_transfer_data'] /** @description 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. */ - readonly amount: number; - readonly chf_credit_transfer?: definitions["source_transaction_chf_credit_transfer_data"]; + readonly amount: number + readonly chf_credit_transfer?: definitions['source_transaction_chf_credit_transfer_data'] /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; - readonly gbp_credit_transfer?: definitions["source_transaction_gbp_credit_transfer_data"]; + readonly currency: string + readonly gbp_credit_transfer?: definitions['source_transaction_gbp_credit_transfer_data'] /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "source_transaction"; - readonly paper_check?: definitions["source_transaction_paper_check_data"]; - readonly sepa_credit_transfer?: definitions["source_transaction_sepa_credit_transfer_data"]; + readonly object: 'source_transaction' + readonly paper_check?: definitions['source_transaction_paper_check_data'] + readonly sepa_credit_transfer?: definitions['source_transaction_sepa_credit_transfer_data'] /** @description The ID of the source this transaction is attached to. */ - readonly source: string; + readonly source: string /** @description The status of the transaction, one of `succeeded`, `pending`, or `failed`. */ - readonly status: string; + readonly status: string /** * @description The type of source this transaction is attached to. * @enum {string} */ readonly type: - | "ach_credit_transfer" - | "ach_debit" - | "alipay" - | "bancontact" - | "card" - | "card_present" - | "eps" - | "giropay" - | "ideal" - | "klarna" - | "multibanco" - | "p24" - | "sepa_debit" - | "sofort" - | "three_d_secure" - | "wechat"; - }; + | 'ach_credit_transfer' + | 'ach_debit' + | 'alipay' + | 'bancontact' + | 'card' + | 'card_present' + | 'eps' + | 'giropay' + | 'ideal' + | 'klarna' + | 'multibanco' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'three_d_secure' + | 'wechat' + } /** SourceTransactionAchCreditTransferData */ readonly source_transaction_ach_credit_transfer_data: { /** @description Customer data associated with the transfer. */ - readonly customer_data?: string; + readonly customer_data?: string /** @description Bank account fingerprint associated with the transfer. */ - readonly fingerprint?: string; + readonly fingerprint?: string /** @description Last 4 digits of the account number associated with the transfer. */ - readonly last4?: string; + readonly last4?: string /** @description Routing number associated with the transfer. */ - readonly routing_number?: string; - }; + readonly routing_number?: string + } /** SourceTransactionChfCreditTransferData */ readonly source_transaction_chf_credit_transfer_data: { /** @description Reference associated with the transfer. */ - readonly reference?: string; + readonly reference?: string /** @description Sender's country address. */ - readonly sender_address_country?: string; + readonly sender_address_country?: string /** @description Sender's line 1 address. */ - readonly sender_address_line1?: string; + readonly sender_address_line1?: string /** @description Sender's bank account IBAN. */ - readonly sender_iban?: string; + readonly sender_iban?: string /** @description Sender's name. */ - readonly sender_name?: string; - }; + readonly sender_name?: string + } /** SourceTransactionGbpCreditTransferData */ readonly source_transaction_gbp_credit_transfer_data: { /** @description Bank account fingerprint associated with the Stripe owned bank account receiving the transfer. */ - readonly fingerprint?: string; + readonly fingerprint?: string /** @description 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. */ - readonly funding_method?: string; + readonly funding_method?: string /** @description Last 4 digits of sender account number associated with the transfer. */ - readonly last4?: string; + readonly last4?: string /** @description Sender entered arbitrary information about the transfer. */ - readonly reference?: string; + readonly reference?: string /** @description Sender account number associated with the transfer. */ - readonly sender_account_number?: string; + readonly sender_account_number?: string /** @description Sender name associated with the transfer. */ - readonly sender_name?: string; + readonly sender_name?: string /** @description Sender sort code associated with the transfer. */ - readonly sender_sort_code?: string; - }; + readonly sender_sort_code?: string + } /** SourceTransactionPaperCheckData */ readonly source_transaction_paper_check_data: { /** @description Time at which the deposited funds will be available for use. Measured in seconds since the Unix epoch. */ - readonly available_at?: string; + readonly available_at?: string /** @description Comma-separated list of invoice IDs associated with the paper check. */ - readonly invoices?: string; - }; + readonly invoices?: string + } /** SourceTransactionSepaCreditTransferData */ readonly source_transaction_sepa_credit_transfer_data: { /** @description Reference associated with the transfer. */ - readonly reference?: string; + readonly reference?: string /** @description Sender's bank account IBAN. */ - readonly sender_iban?: string; + readonly sender_iban?: string /** @description Sender's name. */ - readonly sender_name?: string; - }; + readonly sender_name?: string + } readonly source_type_ach_credit_transfer: { - readonly account_number?: string; - readonly bank_name?: string; - readonly fingerprint?: string; - readonly refund_account_holder_name?: string; - readonly refund_account_holder_type?: string; - readonly refund_routing_number?: string; - readonly routing_number?: string; - readonly swift_code?: string; - }; + readonly account_number?: string + readonly bank_name?: string + readonly fingerprint?: string + readonly refund_account_holder_name?: string + readonly refund_account_holder_type?: string + readonly refund_routing_number?: string + readonly routing_number?: string + readonly swift_code?: string + } readonly source_type_ach_debit: { - readonly bank_name?: string; - readonly country?: string; - readonly fingerprint?: string; - readonly last4?: string; - readonly routing_number?: string; - readonly type?: string; - }; + readonly bank_name?: string + readonly country?: string + readonly fingerprint?: string + readonly last4?: string + readonly routing_number?: string + readonly type?: string + } readonly source_type_alipay: { - readonly data_string?: string; - readonly native_url?: string; - readonly statement_descriptor?: string; - }; + readonly data_string?: string + readonly native_url?: string + readonly statement_descriptor?: string + } readonly source_type_au_becs_debit: { - readonly bsb_number?: string; - readonly fingerprint?: string; - readonly last4?: string; - }; + readonly bsb_number?: string + readonly fingerprint?: string + readonly last4?: string + } readonly source_type_bancontact: { - readonly bank_code?: string; - readonly bank_name?: string; - readonly bic?: string; - readonly iban_last4?: string; - readonly preferred_language?: string; - readonly statement_descriptor?: string; - }; + readonly bank_code?: string + readonly bank_name?: string + readonly bic?: string + readonly iban_last4?: string + readonly preferred_language?: string + readonly statement_descriptor?: string + } readonly source_type_card: { - readonly address_line1_check?: string; - readonly address_zip_check?: string; - readonly brand?: string; - readonly country?: string; - readonly cvc_check?: string; - readonly dynamic_last4?: string; - readonly exp_month?: number; - readonly exp_year?: number; - readonly fingerprint?: string; - readonly funding?: string; - readonly last4?: string; - readonly name?: string; - readonly three_d_secure?: string; - readonly tokenization_method?: string; - }; + readonly address_line1_check?: string + readonly address_zip_check?: string + readonly brand?: string + readonly country?: string + readonly cvc_check?: string + readonly dynamic_last4?: string + readonly exp_month?: number + readonly exp_year?: number + readonly fingerprint?: string + readonly funding?: string + readonly last4?: string + readonly name?: string + readonly three_d_secure?: string + readonly tokenization_method?: string + } readonly source_type_card_present: { - readonly application_cryptogram?: string; - readonly application_preferred_name?: string; - readonly authorization_code?: string; - readonly authorization_response_code?: string; - readonly brand?: string; - readonly country?: string; - readonly cvm_type?: string; - readonly data_type?: string; - readonly dedicated_file_name?: string; - readonly emv_auth_data?: string; - readonly evidence_customer_signature?: string; - readonly evidence_transaction_certificate?: string; - readonly exp_month?: number; - readonly exp_year?: number; - readonly fingerprint?: string; - readonly funding?: string; - readonly last4?: string; - readonly pos_device_id?: string; - readonly pos_entry_mode?: string; - readonly read_method?: string; - readonly reader?: string; - readonly terminal_verification_results?: string; - readonly transaction_status_information?: string; - }; + readonly application_cryptogram?: string + readonly application_preferred_name?: string + readonly authorization_code?: string + readonly authorization_response_code?: string + readonly brand?: string + readonly country?: string + readonly cvm_type?: string + readonly data_type?: string + readonly dedicated_file_name?: string + readonly emv_auth_data?: string + readonly evidence_customer_signature?: string + readonly evidence_transaction_certificate?: string + readonly exp_month?: number + readonly exp_year?: number + readonly fingerprint?: string + readonly funding?: string + readonly last4?: string + readonly pos_device_id?: string + readonly pos_entry_mode?: string + readonly read_method?: string + readonly reader?: string + readonly terminal_verification_results?: string + readonly transaction_status_information?: string + } readonly source_type_eps: { - readonly reference?: string; - readonly statement_descriptor?: string; - }; + readonly reference?: string + readonly statement_descriptor?: string + } readonly source_type_giropay: { - readonly bank_code?: string; - readonly bank_name?: string; - readonly bic?: string; - readonly statement_descriptor?: string; - }; + readonly bank_code?: string + readonly bank_name?: string + readonly bic?: string + readonly statement_descriptor?: string + } readonly source_type_ideal: { - readonly bank?: string; - readonly bic?: string; - readonly iban_last4?: string; - readonly statement_descriptor?: string; - }; + readonly bank?: string + readonly bic?: string + readonly iban_last4?: string + readonly statement_descriptor?: string + } readonly source_type_klarna: { - readonly background_image_url?: string; - readonly client_token?: string; - readonly first_name?: string; - readonly last_name?: string; - readonly locale?: string; - readonly logo_url?: string; - readonly page_title?: string; - readonly pay_later_asset_urls_descriptive?: string; - readonly pay_later_asset_urls_standard?: string; - readonly pay_later_name?: string; - readonly pay_later_redirect_url?: string; - readonly pay_now_asset_urls_descriptive?: string; - readonly pay_now_asset_urls_standard?: string; - readonly pay_now_name?: string; - readonly pay_now_redirect_url?: string; - readonly pay_over_time_asset_urls_descriptive?: string; - readonly pay_over_time_asset_urls_standard?: string; - readonly pay_over_time_name?: string; - readonly pay_over_time_redirect_url?: string; - readonly payment_method_categories?: string; - readonly purchase_country?: string; - readonly purchase_type?: string; - readonly redirect_url?: string; - readonly shipping_first_name?: string; - readonly shipping_last_name?: string; - }; + readonly background_image_url?: string + readonly client_token?: string + readonly first_name?: string + readonly last_name?: string + readonly locale?: string + readonly logo_url?: string + readonly page_title?: string + readonly pay_later_asset_urls_descriptive?: string + readonly pay_later_asset_urls_standard?: string + readonly pay_later_name?: string + readonly pay_later_redirect_url?: string + readonly pay_now_asset_urls_descriptive?: string + readonly pay_now_asset_urls_standard?: string + readonly pay_now_name?: string + readonly pay_now_redirect_url?: string + readonly pay_over_time_asset_urls_descriptive?: string + readonly pay_over_time_asset_urls_standard?: string + readonly pay_over_time_name?: string + readonly pay_over_time_redirect_url?: string + readonly payment_method_categories?: string + readonly purchase_country?: string + readonly purchase_type?: string + readonly redirect_url?: string + readonly shipping_first_name?: string + readonly shipping_last_name?: string + } readonly source_type_multibanco: { - readonly entity?: string; - readonly reference?: string; - readonly refund_account_holder_address_city?: string; - readonly refund_account_holder_address_country?: string; - readonly refund_account_holder_address_line1?: string; - readonly refund_account_holder_address_line2?: string; - readonly refund_account_holder_address_postal_code?: string; - readonly refund_account_holder_address_state?: string; - readonly refund_account_holder_name?: string; - readonly refund_iban?: string; - }; + readonly entity?: string + readonly reference?: string + readonly refund_account_holder_address_city?: string + readonly refund_account_holder_address_country?: string + readonly refund_account_holder_address_line1?: string + readonly refund_account_holder_address_line2?: string + readonly refund_account_holder_address_postal_code?: string + readonly refund_account_holder_address_state?: string + readonly refund_account_holder_name?: string + readonly refund_iban?: string + } readonly source_type_p24: { - readonly reference?: string; - }; + readonly reference?: string + } readonly source_type_sepa_debit: { - readonly bank_code?: string; - readonly branch_code?: string; - readonly country?: string; - readonly fingerprint?: string; - readonly last4?: string; - readonly mandate_reference?: string; - readonly mandate_url?: string; - }; + readonly bank_code?: string + readonly branch_code?: string + readonly country?: string + readonly fingerprint?: string + readonly last4?: string + readonly mandate_reference?: string + readonly mandate_url?: string + } readonly source_type_sofort: { - readonly bank_code?: string; - readonly bank_name?: string; - readonly bic?: string; - readonly country?: string; - readonly iban_last4?: string; - readonly preferred_language?: string; - readonly statement_descriptor?: string; - }; + readonly bank_code?: string + readonly bank_name?: string + readonly bic?: string + readonly country?: string + readonly iban_last4?: string + readonly preferred_language?: string + readonly statement_descriptor?: string + } readonly source_type_three_d_secure: { - readonly address_line1_check?: string; - readonly address_zip_check?: string; - readonly authenticated?: boolean; - readonly brand?: string; - readonly card?: string; - readonly country?: string; - readonly customer?: string; - readonly cvc_check?: string; - readonly dynamic_last4?: string; - readonly exp_month?: number; - readonly exp_year?: number; - readonly fingerprint?: string; - readonly funding?: string; - readonly last4?: string; - readonly name?: string; - readonly three_d_secure?: string; - readonly tokenization_method?: string; - }; + readonly address_line1_check?: string + readonly address_zip_check?: string + readonly authenticated?: boolean + readonly brand?: string + readonly card?: string + readonly country?: string + readonly customer?: string + readonly cvc_check?: string + readonly dynamic_last4?: string + readonly exp_month?: number + readonly exp_year?: number + readonly fingerprint?: string + readonly funding?: string + readonly last4?: string + readonly name?: string + readonly three_d_secure?: string + readonly tokenization_method?: string + } readonly source_type_wechat: { - readonly prepay_id?: string; - readonly qr_code_url?: string; - readonly statement_descriptor?: string; - }; + readonly prepay_id?: string + readonly qr_code_url?: string + readonly statement_descriptor?: string + } /** StatusTransitions */ readonly status_transitions: { /** @description The time that the order was canceled. */ - readonly canceled?: number; + readonly canceled?: number /** @description The time that the order was fulfilled. */ - readonly fulfiled?: number; + readonly fulfiled?: number /** @description The time that the order was paid. */ - readonly paid?: number; + readonly paid?: number /** @description The time that the order was returned. */ - readonly returned?: number; - }; + readonly returned?: number + } /** * Subscription * @description Subscriptions allow you to charge a customer on a recurring basis. @@ -9220,84 +9178,84 @@ export interface definitions { */ readonly subscription: { /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. */ - readonly application_fee_percent?: number; + readonly application_fee_percent?: number /** @description Determines the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. */ - readonly billing_cycle_anchor: number; - readonly billing_thresholds?: definitions["subscription_billing_thresholds"]; + readonly billing_cycle_anchor: number + readonly billing_thresholds?: definitions['subscription_billing_thresholds'] /** @description A date in the future at which the subscription will automatically get canceled */ - readonly cancel_at?: number; + readonly cancel_at?: number /** @description If the subscription has been canceled with the `at_period_end` flag set to `true`, `cancel_at_period_end` on the subscription will be true. You can use this attribute to determine whether a subscription that has a status of active is scheduled to be canceled at the end of the current period. */ - readonly cancel_at_period_end: boolean; + readonly cancel_at_period_end: boolean /** @description If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with `cancel_at_period_end`, `canceled_at` will still reflect the date of the initial cancellation request, not the end of the subscription period when the subscription is automatically moved to a canceled state. */ - readonly canceled_at?: number; + readonly canceled_at?: number /** * @description 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. * @enum {string} */ - readonly collection_method?: "charge_automatically" | "send_invoice"; + readonly collection_method?: 'charge_automatically' | 'send_invoice' /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created. */ - readonly current_period_end: number; + readonly current_period_end: number /** @description Start of the current period that the subscription has been invoiced for. */ - readonly current_period_start: number; + readonly current_period_start: number /** @description ID of the customer who owns the subscription. */ - readonly customer: string; + readonly customer: string /** @description 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`. */ - readonly days_until_due?: number; + readonly days_until_due?: number /** @description ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. If not set, invoices will use the default payment method in the customer's invoice settings. */ - readonly default_payment_method?: string; + readonly default_payment_method?: string /** @description 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 not set, defaults to the customer's default source. */ - readonly default_source?: string; + readonly default_source?: string /** @description 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. */ - readonly default_tax_rates?: readonly definitions["tax_rate"][]; - readonly discount?: definitions["discount"]; + readonly default_tax_rates?: readonly definitions['tax_rate'][] + readonly discount?: definitions['discount'] /** @description If the subscription has ended, the date the subscription ended. */ - readonly ended_at?: number; + readonly ended_at?: number /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * SubscriptionItemList * @description List of subscription items, each with an attached plan. */ readonly items: { /** @description Details about each object. */ - readonly data: readonly definitions["subscription_item"][]; + readonly data: readonly definitions['subscription_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; + readonly url: string + } /** @description The most recent invoice this subscription has generated. */ - readonly latest_invoice?: string; + readonly latest_invoice?: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata: { readonly [key: string]: unknown }; + readonly metadata: { readonly [key: string]: unknown } /** @description Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at `pending_invoice_item_interval`. */ - readonly next_pending_invoice_item_invoice?: number; + readonly next_pending_invoice_item_invoice?: number /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "subscription"; - readonly pause_collection?: definitions["subscriptions_resource_pause_collection"]; - readonly pending_invoice_item_interval?: definitions["subscription_pending_invoice_item_interval"]; + readonly object: 'subscription' + readonly pause_collection?: definitions['subscriptions_resource_pause_collection'] + readonly pending_invoice_item_interval?: definitions['subscription_pending_invoice_item_interval'] /** @description 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). */ - readonly pending_setup_intent?: string; - readonly pending_update?: definitions["subscriptions_resource_pending_update"]; - readonly plan?: definitions["plan"]; + readonly pending_setup_intent?: string + readonly pending_update?: definitions['subscriptions_resource_pending_update'] + readonly plan?: definitions['plan'] /** @description The quantity of the plan to which the customer is subscribed. For example, if your plan is $10/user/month, and your customer has 5 users, you could pass 5 as the quantity to have the customer charged $50 (5 x $10) monthly. Only set if the subscription contains a single plan. */ - readonly quantity?: number; + readonly quantity?: number /** @description The schedule attached to the subscription */ - readonly schedule?: string; + readonly schedule?: string /** @description Date when the subscription was first created. The date might differ from the `created` date due to backdating. */ - readonly start_date: number; + readonly start_date: number /** * @description Possible values are `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `canceled`, or `unpaid`. * @@ -9310,62 +9268,62 @@ export interface definitions { * If 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. * @enum {string} */ - readonly status: "active" | "canceled" | "incomplete" | "incomplete_expired" | "past_due" | "trialing" | "unpaid"; + readonly status: 'active' | 'canceled' | 'incomplete' | 'incomplete_expired' | 'past_due' | 'trialing' | 'unpaid' /** @description If provided, each invoice created by this subscription will apply the tax rate, increasing the amount billed to the customer. */ - readonly tax_percent?: number; + readonly tax_percent?: number /** @description If the subscription has a trial, the end of that trial. */ - readonly trial_end?: number; + readonly trial_end?: number /** @description If the subscription has a trial, the beginning of that trial. */ - readonly trial_start?: number; - }; + readonly trial_start?: number + } /** SubscriptionBillingThresholds */ readonly subscription_billing_thresholds: { /** @description Monetary threshold that triggers the subscription to create an invoice */ - readonly amount_gte?: number; + readonly amount_gte?: number /** @description 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`. */ - readonly reset_billing_cycle_anchor?: boolean; - }; + readonly reset_billing_cycle_anchor?: boolean + } /** * SubscriptionItem * @description Subscription items allow you to create customer subscriptions with more than * one plan, making it easy to represent complex billing relationships. */ readonly subscription_item: { - readonly billing_thresholds?: definitions["subscription_item_billing_thresholds"]; + readonly billing_thresholds?: definitions['subscription_item_billing_thresholds'] /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description 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. */ - readonly metadata: { readonly [key: string]: unknown }; + readonly metadata: { readonly [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "subscription_item"; - readonly plan: definitions["plan"]; + readonly object: 'subscription_item' + readonly plan: definitions['plan'] /** @description The [quantity](https://stripe.com/docs/subscriptions/quantities) of the plan to which the customer should be subscribed. */ - readonly quantity?: number; + readonly quantity?: number /** @description The `subscription` this `subscription_item` belongs to. */ - readonly subscription: string; + readonly subscription: string /** @description 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`. */ - readonly tax_rates?: readonly definitions["tax_rate"][]; - }; + readonly tax_rates?: readonly definitions['tax_rate'][] + } /** SubscriptionItemBillingThresholds */ readonly subscription_item_billing_thresholds: { /** @description Usage threshold that triggers the subscription to create an invoice */ - readonly usage_gte?: number; - }; + readonly usage_gte?: number + } /** SubscriptionPendingInvoiceItemInterval */ readonly subscription_pending_invoice_item_interval: { /** * @description Specifies invoicing frequency. Either `day`, `week`, `month` or `year`. * @enum {string} */ - readonly interval: "day" | "month" | "week" | "year"; + readonly interval: 'day' | 'month' | 'week' | 'year' /** @description 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). */ - readonly interval_count: number; - }; + readonly interval_count: number + } /** * SubscriptionSchedule * @description A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes. @@ -9374,113 +9332,113 @@ export interface definitions { */ readonly subscription_schedule: { /** @description Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch. */ - readonly canceled_at?: number; + readonly canceled_at?: number /** @description Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch. */ - readonly completed_at?: number; + readonly completed_at?: number /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; - readonly current_phase?: definitions["subscription_schedule_current_phase"]; + readonly created: number + readonly current_phase?: definitions['subscription_schedule_current_phase'] /** @description ID of the customer who owns the subscription schedule. */ - readonly customer: string; - readonly default_settings: definitions["subscription_schedules_resource_default_settings"]; + readonly customer: string + readonly default_settings: definitions['subscription_schedules_resource_default_settings'] /** * @description Behavior of the subscription schedule and underlying subscription when it ends. * @enum {string} */ - readonly end_behavior: "cancel" | "none" | "release" | "renew"; + readonly end_behavior: 'cancel' | 'none' | 'release' | 'renew' /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata?: { readonly [key: string]: unknown }; + readonly metadata?: { readonly [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "subscription_schedule"; + readonly object: 'subscription_schedule' /** @description Configuration for the subscription schedule's phases. */ - readonly phases: readonly definitions["subscription_schedule_phase_configuration"][]; + readonly phases: readonly definitions['subscription_schedule_phase_configuration'][] /** @description Time at which the subscription schedule was released. Measured in seconds since the Unix epoch. */ - readonly released_at?: number; + readonly released_at?: number /** @description ID of the subscription once managed by the subscription schedule (if it is released). */ - readonly released_subscription?: string; + readonly released_subscription?: string /** * @description 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). * @enum {string} */ - readonly status: "active" | "canceled" | "completed" | "not_started" | "released"; + readonly status: 'active' | 'canceled' | 'completed' | 'not_started' | 'released' /** @description ID of the subscription managed by the subscription schedule. */ - readonly subscription?: string; - }; + readonly subscription?: string + } /** * SubscriptionScheduleConfigurationItem * @description A phase item describes the plan and quantity of a phase. */ readonly subscription_schedule_configuration_item: { - readonly billing_thresholds?: definitions["subscription_item_billing_thresholds"]; + readonly billing_thresholds?: definitions['subscription_item_billing_thresholds'] /** @description ID of the plan to which the customer should be subscribed. */ - readonly plan: string; + readonly plan: string /** @description Quantity of the plan to which the customer should be subscribed. */ - readonly quantity?: number; + readonly quantity?: number /** @description 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`. */ - readonly tax_rates?: readonly definitions["tax_rate"][]; - }; + readonly tax_rates?: readonly definitions['tax_rate'][] + } /** SubscriptionScheduleCurrentPhase */ readonly subscription_schedule_current_phase: { /** @description The end of this phase of the subscription schedule. */ - readonly end_date: number; + readonly end_date: number /** @description The start of this phase of the subscription schedule. */ - readonly start_date: number; - }; + readonly start_date: number + } /** * SubscriptionSchedulePhaseConfiguration * @description A phase describes the plans, coupon, and trialing status of a subscription for a predefined time period. */ readonly subscription_schedule_phase_configuration: { /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account during this phase of the schedule. */ - readonly application_fee_percent?: number; - readonly billing_thresholds?: definitions["subscription_billing_thresholds"]; + readonly application_fee_percent?: number + readonly billing_thresholds?: definitions['subscription_billing_thresholds'] /** * @description 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. * @enum {string} */ - readonly collection_method?: "charge_automatically" | "send_invoice"; + readonly collection_method?: 'charge_automatically' | 'send_invoice' /** @description ID of the coupon to use during this phase of the subscription schedule. */ - readonly coupon?: string; + readonly coupon?: string /** @description 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. */ - readonly default_payment_method?: string; + readonly default_payment_method?: string /** @description The default tax rates to apply to the subscription during this phase of the subscription schedule. */ - readonly default_tax_rates?: readonly definitions["tax_rate"][]; + readonly default_tax_rates?: readonly definitions['tax_rate'][] /** @description The end of this phase of the subscription schedule. */ - readonly end_date: number; - readonly invoice_settings?: definitions["invoice_setting_subscription_schedule_setting"]; + readonly end_date: number + readonly invoice_settings?: definitions['invoice_setting_subscription_schedule_setting'] /** @description Plans to subscribe during this phase of the subscription schedule. */ - readonly plans: readonly definitions["subscription_schedule_configuration_item"][]; + readonly plans: readonly definitions['subscription_schedule_configuration_item'][] /** * @description Controls whether or not the subscription schedule will prorate when transitioning to this phase. Values are `create_prorations` and `none`. * @enum {string} */ - readonly proration_behavior?: "always_invoice" | "create_prorations" | "none"; + readonly proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** @description The start of this phase of the subscription schedule. */ - readonly start_date: number; + readonly start_date: number /** @description If provided, each invoice created during this phase of the subscription schedule will apply the tax rate, increasing the amount billed to the customer. */ - readonly tax_percent?: number; + readonly tax_percent?: number /** @description When the trial ends within the phase. */ - readonly trial_end?: number; - }; + readonly trial_end?: number + } /** SubscriptionSchedulesResourceDefaultSettings */ readonly subscription_schedules_resource_default_settings: { - readonly billing_thresholds?: definitions["subscription_billing_thresholds"]; + readonly billing_thresholds?: definitions['subscription_billing_thresholds'] /** * @description 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. * @enum {string} */ - readonly collection_method?: "charge_automatically" | "send_invoice"; + readonly collection_method?: 'charge_automatically' | 'send_invoice' /** @description 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. */ - readonly default_payment_method?: string; - readonly invoice_settings?: definitions["invoice_setting_subscription_schedule_setting"]; - }; + readonly default_payment_method?: string + readonly invoice_settings?: definitions['invoice_setting_subscription_schedule_setting'] + } /** * SubscriptionsResourcePauseCollection * @description The Pause Collection settings determine how we will pause collection for this subscription and for how long the subscription @@ -9491,10 +9449,10 @@ export interface definitions { * @description The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`. * @enum {string} */ - readonly behavior: "keep_as_draft" | "mark_uncollectible" | "void"; + readonly behavior: 'keep_as_draft' | 'mark_uncollectible' | 'void' /** @description The time after which the subscription will resume collecting payments. */ - readonly resumes_at?: number; - }; + readonly resumes_at?: number + } /** * SubscriptionsResourcePendingUpdate * @description Pending Updates store the changes pending from a previous update that will be applied @@ -9502,32 +9460,32 @@ export interface definitions { */ readonly subscriptions_resource_pending_update: { /** @description 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. */ - readonly billing_cycle_anchor?: number; + readonly billing_cycle_anchor?: number /** @description The point after which the changes reflected by this update will be discarded and no longer applied. */ - readonly expires_at: number; + readonly expires_at: number /** @description List of subscription items, each with an attached plan, that will be set if the update is applied. */ - readonly subscription_items?: readonly definitions["subscription_item"][]; + readonly subscription_items?: readonly definitions['subscription_item'][] /** @description 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. */ - readonly trial_end?: number; + readonly trial_end?: number /** @description 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. */ - readonly trial_from_plan?: boolean; - }; + readonly trial_from_plan?: boolean + } /** TaxDeductedAtSource */ readonly tax_deducted_at_source: { /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "tax_deducted_at_source"; + readonly object: 'tax_deducted_at_source' /** @description The end of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period. */ - readonly period_end: number; + readonly period_end: number /** @description The start of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period. */ - readonly period_start: number; + readonly period_start: number /** @description The TAN that was supplied to Stripe when TDS was assessed */ - readonly tax_deduction_account_number: string; - }; + readonly tax_deduction_account_number: string + } /** * tax_id * @description You can add one or multiple tax IDs to a [customer](https://stripe.com/docs/api/customers). @@ -9537,65 +9495,65 @@ export interface definitions { */ readonly tax_id: { /** @description Two-letter ISO code representing the country of the tax ID. */ - readonly country?: string; + readonly country?: string /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description ID of the customer. */ - readonly customer: string; + readonly customer: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "tax_id"; + readonly object: 'tax_id' /** * @description Type of the tax ID, one of `au_abn`, `ca_bn`, `ca_qst`, `ch_vat`, `es_cif`, `eu_vat`, `hk_br`, `in_gst`, `jp_cn`, `kr_brn`, `li_uid`, `mx_rfc`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `ru_inn`, `sg_gst`, `sg_uen`, `th_vat`, `tw_vat`, `us_ein`, or `za_vat`. Note that some legacy tax IDs have type `unknown` * @enum {string} */ readonly type: - | "au_abn" - | "ca_bn" - | "ca_qst" - | "ch_vat" - | "es_cif" - | "eu_vat" - | "hk_br" - | "in_gst" - | "jp_cn" - | "kr_brn" - | "li_uid" - | "mx_rfc" - | "my_itn" - | "my_sst" - | "no_vat" - | "nz_gst" - | "ru_inn" - | "sg_gst" - | "sg_uen" - | "th_vat" - | "tw_vat" - | "unknown" - | "us_ein" - | "za_vat"; + | 'au_abn' + | 'ca_bn' + | 'ca_qst' + | 'ch_vat' + | 'es_cif' + | 'eu_vat' + | 'hk_br' + | 'in_gst' + | 'jp_cn' + | 'kr_brn' + | 'li_uid' + | 'mx_rfc' + | 'my_itn' + | 'my_sst' + | 'no_vat' + | 'nz_gst' + | 'ru_inn' + | 'sg_gst' + | 'sg_uen' + | 'th_vat' + | 'tw_vat' + | 'unknown' + | 'us_ein' + | 'za_vat' /** @description Value of the tax ID. */ - readonly value: string; - readonly verification: definitions["tax_id_verification"]; - }; + readonly value: string + readonly verification: definitions['tax_id_verification'] + } /** tax_id_verification */ readonly tax_id_verification: { /** * @description Verification status, one of `pending`, `verified`, `unverified`, or `unavailable`. * @enum {string} */ - readonly status: "pending" | "unavailable" | "unverified" | "verified"; + readonly status: 'pending' | 'unavailable' | 'unverified' | 'verified' /** @description Verified address. */ - readonly verified_address?: string; + readonly verified_address?: string /** @description Verified name. */ - readonly verified_name?: string; - }; + readonly verified_name?: string + } /** * TaxRate * @description Tax rates can be applied to invoices and subscriptions to collect tax. @@ -9604,106 +9562,106 @@ export interface definitions { */ readonly tax_rate: { /** @description Defaults to `true`. When set to `false`, this tax rate cannot be applied to objects in the API, but will still be applied to subscriptions and invoices that already have it set. */ - readonly active: boolean; + readonly active: boolean /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. */ - readonly description?: string; + readonly description?: string /** @description The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page. */ - readonly display_name: string; + readonly display_name: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description This specifies if the tax rate is inclusive or exclusive. */ - readonly inclusive: boolean; + readonly inclusive: boolean /** @description The jurisdiction for the tax rate. */ - readonly jurisdiction?: string; + readonly jurisdiction?: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata: { readonly [key: string]: unknown }; + readonly metadata: { readonly [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "tax_rate"; + readonly object: 'tax_rate' /** @description This represents the tax rate percent out of 100. */ - readonly percentage: number; - }; + readonly percentage: number + } /** * TerminalConnectionToken * @description A Connection Token is used by the Stripe Terminal SDK to connect to a reader. * * Related guide: [Fleet Management](https://stripe.com/docs/terminal/readers/fleet-management#create). */ - readonly "terminal.connection_token": { + readonly 'terminal.connection_token': { /** @description The id of the location that this connection token is scoped to. */ - readonly location?: string; + readonly location?: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "terminal.connection_token"; + readonly object: 'terminal.connection_token' /** @description Your application should pass this token to the Stripe Terminal SDK. */ - readonly secret: string; - }; + readonly secret: string + } /** * TerminalLocationLocation * @description A Location represents a grouping of readers. * * Related guide: [Fleet Management](https://stripe.com/docs/terminal/readers/fleet-management#create). */ - readonly "terminal.location": { - readonly address: definitions["address"]; + readonly 'terminal.location': { + readonly address: definitions['address'] /** @description The display name of the location. */ - readonly display_name: string; + readonly display_name: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata: { readonly [key: string]: unknown }; + readonly metadata: { readonly [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "terminal.location"; - }; + readonly object: 'terminal.location' + } /** * TerminalReaderReader * @description A Reader represents a physical device for accepting payment details. * * Related guide: [Connecting to a Reader](https://stripe.com/docs/terminal/readers/connecting). */ - readonly "terminal.reader": { + readonly 'terminal.reader': { /** @description The current software version of the reader. */ - readonly device_sw_version?: string; + readonly device_sw_version?: string /** * @description Type of reader, one of `bbpos_chipper2x` or `verifone_P400`. * @enum {string} */ - readonly device_type: "bbpos_chipper2x" | "verifone_P400"; + readonly device_type: 'bbpos_chipper2x' | 'verifone_P400' /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description The local IP address of the reader. */ - readonly ip_address?: string; + readonly ip_address?: string /** @description Custom label given to the reader for easier identification. */ - readonly label: string; + readonly label: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description The location identifier of the reader. */ - readonly location?: string; + readonly location?: string /** @description 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. */ - readonly metadata: { readonly [key: string]: unknown }; + readonly metadata: { readonly [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "terminal.reader"; + readonly object: 'terminal.reader' /** @description Serial number of the reader. */ - readonly serial_number: string; + readonly serial_number: string /** @description The networking status of the reader. */ - readonly status?: string; - }; + readonly status?: string + } /** * ThreeDSecure * @description Cardholder authentication via 3D Secure is initiated by creating a `3D Secure` @@ -9712,42 +9670,42 @@ export interface definitions { */ readonly three_d_secure: { /** @description Amount of the charge that you will create when authentication completes. */ - readonly amount: number; + readonly amount: number /** @description True if the cardholder went through the authentication flow and their bank indicated that authentication succeeded. */ - readonly authenticated: boolean; - readonly card: definitions["card"]; + readonly authenticated: boolean + readonly card: definitions['card'] /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "three_d_secure"; + readonly object: 'three_d_secure' /** @description If present, this is the URL that you should send the cardholder to for authentication. If you are going to use Stripe.js to display the authentication page in an iframe, you should use the value "_callback". */ - readonly redirect_url?: string; + readonly redirect_url?: string /** @description Possible values are `redirect_pending`, `succeeded`, or `failed`. When the cardholder can be authenticated, the object starts with status `redirect_pending`. When liability will be shifted to the cardholder's bank (either because the cardholder was successfully authenticated, or because the bank has not implemented 3D Secure, the object wlil be in status `succeeded`. `failed` indicates that authentication was attempted unsuccessfully. */ - readonly status: string; - }; + readonly status: string + } /** three_d_secure_details */ readonly three_d_secure_details: { /** @description Whether or not authentication was performed. 3D Secure will succeed without authentication when the card is not enrolled. */ - readonly authenticated?: boolean; + readonly authenticated?: boolean /** @description Whether or not 3D Secure succeeded. */ - readonly succeeded?: boolean; + readonly succeeded?: boolean /** @description The version of 3D Secure that was used for this payment. */ - readonly version: string; - }; + readonly version: string + } /** three_d_secure_usage */ readonly three_d_secure_usage: { /** @description Whether 3D Secure is supported on this card. */ - readonly supported: boolean; - }; + readonly supported: boolean + } /** * Token * @description Tokenization is the process Stripe uses to collect sensitive card or bank @@ -9774,26 +9732,26 @@ export interface definitions { * Related guide: [Accept a payment](https://stripe.com/docs/payments/accept-a-payment-charges#web-create-token) */ readonly token: { - readonly bank_account?: definitions["bank_account"]; - readonly card?: definitions["card"]; + readonly bank_account?: definitions['bank_account'] + readonly card?: definitions['card'] /** @description IP address of the client that generated the token. */ - readonly client_ip?: string; + readonly client_ip?: string /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "token"; + readonly object: 'token' /** @description Type of the token: `account`, `bank_account`, `card`, or `pii`. */ - readonly type: string; + readonly type: string /** @description Whether this token has already been used (tokens can be used only once). */ - readonly used: boolean; - }; + readonly used: boolean + } /** * Topup * @description To top up your Stripe balance, you create a top-up object. You can retrieve @@ -9804,43 +9762,43 @@ export interface definitions { */ readonly topup: { /** @description Amount transferred. */ - readonly amount: number; + readonly amount: number /** @description 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. */ - readonly balance_transaction?: string; + readonly balance_transaction?: string /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string; + readonly description?: string /** @description 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. */ - readonly expected_availability_date?: number; + readonly expected_availability_date?: number /** @description 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). */ - readonly failure_code?: string; + readonly failure_code?: string /** @description Message to user further explaining reason for top-up failure if available. */ - readonly failure_message?: string; + readonly failure_message?: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata: { readonly [key: string]: unknown }; + readonly metadata: { readonly [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "topup"; - readonly source: definitions["source"]; + readonly object: 'topup' + readonly source: definitions['source'] /** @description Extra information about a top-up. This will appear on your source's bank statement. It must contain at least one letter. */ - readonly statement_descriptor?: string; + readonly statement_descriptor?: string /** * @description The status of the top-up is either `canceled`, `failed`, `pending`, `reversed`, or `succeeded`. * @enum {string} */ - readonly status: "canceled" | "failed" | "pending" | "reversed" | "succeeded"; + readonly status: 'canceled' | 'failed' | 'pending' | 'reversed' | 'succeeded' /** @description A string that identifies this top-up as part of a group. */ - readonly transfer_group?: string; - }; + readonly transfer_group?: string + } /** * Transfer * @description A `Transfer` object is created when you move funds between Stripe accounts as @@ -9856,69 +9814,69 @@ export interface definitions { */ readonly transfer: { /** @description Amount in %s to be transferred. */ - readonly amount: number; + readonly amount: number /** @description Amount in %s reversed (can be less than the amount attribute on the transfer if a partial reversal was issued). */ - readonly amount_reversed: number; + readonly amount_reversed: number /** @description Balance transaction that describes the impact of this transfer on your account balance. */ - readonly balance_transaction?: string; + readonly balance_transaction?: string /** @description Time that this record of the transfer was first created. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string; + readonly description?: string /** @description ID of the Stripe account the transfer was sent to. */ - readonly destination?: string; + readonly destination?: string /** @description If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer. */ - readonly destination_payment?: string; + readonly destination_payment?: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata: { readonly [key: string]: unknown }; + readonly metadata: { readonly [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "transfer"; + readonly object: 'transfer' /** * TransferReversalList * @description A list of reversals that have been applied to the transfer. */ readonly reversals: { /** @description Details about each object. */ - readonly data: readonly definitions["transfer_reversal"][]; + readonly data: readonly definitions['transfer_reversal'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; + readonly url: string + } /** @description Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false. */ - readonly reversed: boolean; + readonly reversed: boolean /** @description ID of the charge or payment that was used to fund the transfer. If null, the transfer was funded from the available balance. */ - readonly source_transaction?: string; + readonly source_transaction?: string /** @description The source balance this transfer came from. One of `card`, `fpx`, or `bank_account`. */ - readonly source_type?: string; + readonly source_type?: string /** @description A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-options) for details. */ - readonly transfer_group?: string; - }; + readonly transfer_group?: string + } /** transfer_data */ readonly transfer_data: { /** @description 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). */ - readonly amount?: number; + readonly amount?: number /** * @description The account (if any) the payment will be attributed to for tax * reporting, and where funds from the payment will be transferred to upon * payment success. */ - readonly destination: string; - }; + readonly destination: string + } /** * TransferReversal * @description [Stripe Connect](https://stripe.com/docs/connect) platforms can reverse transfers made to a @@ -9937,50 +9895,50 @@ export interface definitions { */ readonly transfer_reversal: { /** @description Amount, in %s. */ - readonly amount: number; + readonly amount: number /** @description Balance transaction that describes the impact on your account balance. */ - readonly balance_transaction?: string; + readonly balance_transaction?: string /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description Linked payment refund for the transfer reversal. */ - readonly destination_payment_refund?: string; + readonly destination_payment_refund?: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description 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. */ - readonly metadata: { readonly [key: string]: unknown }; + readonly metadata: { readonly [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "transfer_reversal"; + readonly object: 'transfer_reversal' /** @description ID of the refund responsible for the transfer reversal. */ - readonly source_refund?: string; + readonly source_refund?: string /** @description ID of the transfer that was reversed. */ - readonly transfer: string; - }; + readonly transfer: string + } /** TransferSchedule */ readonly transfer_schedule: { /** @description The number of days charges for the account will be held before being paid out. */ - readonly delay_days: number; + readonly delay_days: number /** @description How frequently funds will be paid out. One of `manual` (payouts only created via API call), `daily`, `weekly`, or `monthly`. */ - readonly interval: string; + readonly interval: string /** @description 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. */ - readonly monthly_anchor?: number; + readonly monthly_anchor?: number /** @description The day of the week funds will be paid out, of the style 'monday', 'tuesday', etc. Only shown if `interval` is weekly. */ - readonly weekly_anchor?: string; - }; + readonly weekly_anchor?: string + } /** TransformUsage */ readonly transform_usage: { /** @description Divide usage by this number. */ - readonly divide_by: number; + readonly divide_by: number /** * @description After division, either round the result `up` or `down`. * @enum {string} */ - readonly round: "down" | "up"; - }; + readonly round: 'down' | 'up' + } /** * UsageRecord * @description Usage records allow you to report customer usage and metrics to Stripe for @@ -9990,40 +9948,40 @@ export interface definitions { */ readonly usage_record: { /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "usage_record"; + readonly object: 'usage_record' /** @description The usage quantity for the specified date. */ - readonly quantity: number; + readonly quantity: number /** @description The ID of the subscription item this usage record contains data for. */ - readonly subscription_item: string; + readonly subscription_item: string /** @description The timestamp when this usage occurred. */ - readonly timestamp: number; - }; + readonly timestamp: number + } /** UsageRecordSummary */ readonly usage_record_summary: { /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description The invoice in which this usage period has been billed for. */ - readonly invoice?: string; + readonly invoice?: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "usage_record_summary"; - readonly period: definitions["period"]; + readonly object: 'usage_record_summary' + readonly period: definitions['period'] /** @description The ID of the subscription item this summary is describing. */ - readonly subscription_item: string; + readonly subscription_item: string /** @description The total usage within this usage period. */ - readonly total_usage: number; - }; + readonly total_usage: number + } /** * NotificationWebhookEndpoint * @description You can configure [webhook endpoints](https://stripe.com/docs/webhooks/) via the API to be @@ -10036,33 +9994,33 @@ export interface definitions { */ readonly webhook_endpoint: { /** @description The API version events are rendered as for this webhook endpoint. */ - readonly api_version?: string; + readonly api_version?: string /** @description The ID of the associated Connect application. */ - readonly application?: string; + readonly application?: string /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description An optional description of what the wehbook is used for. */ - readonly description?: string; + readonly description?: string /** @description The list of events to enable for this endpoint. `['*']` indicates that all events are enabled, except those that require explicit selection. */ - readonly enabled_events: readonly string[]; + readonly enabled_events: readonly string[] /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata: { readonly [key: string]: unknown }; + readonly metadata: { readonly [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "webhook_endpoint"; + readonly object: 'webhook_endpoint' /** @description The endpoint's secret, used to generate [webhook signatures](https://stripe.com/docs/webhooks/signatures). Only returned at creation. */ - readonly secret?: string; + readonly secret?: string /** @description The status of the webhook. It can be `enabled` or `disabled`. */ - readonly status: string; + readonly status: string /** @description The URL of the webhook endpoint. */ - readonly url: string; - }; + readonly url: string + } } export interface operations { @@ -10073,72 +10031,72 @@ export interface operations { /** Body parameters for the request. */ readonly payload: { /** @description Amount of the charge that you will create when authentication completes. */ - readonly amount: number; + readonly amount: number /** @description The ID of a card token, or the ID of a card belonging to the given customer. */ - readonly card?: string; + readonly card?: string /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description The customer associated with this 3D secure authentication. */ - readonly customer?: string; + readonly customer?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The URL that the cardholder's browser will be returned to when authentication completes. */ - readonly return_url: string; - }; - }; - }; + readonly return_url: string + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["three_d_secure"]; - }; + readonly schema: definitions['three_d_secure'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves a 3D Secure object.

*/ readonly Get3dSecureThreeDSecure: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly three_d_secure: string; - }; - }; + readonly three_d_secure: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["three_d_secure"]; - }; + readonly schema: definitions['three_d_secure'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves the details of an account.

*/ readonly GetAccount: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; - }; + readonly expand?: readonly unknown[] + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["account"]; - }; + readonly schema: definitions['account'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

Updates a connected Express or Custom account by setting the values of the parameters passed. Any parameters not provided are left unchanged. Most parameters can be changed only for Custom accounts. (These are marked Custom Only below.) Parameters marked Custom and Express are supported by both account types.

* @@ -10150,27 +10108,27 @@ export interface operations { /** Body parameters for the request. */ readonly payload?: { /** @description An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account. */ - readonly account_token?: string; + readonly account_token?: string /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js), or a dictionary containing a user's bank account details. */ - readonly bank_account?: unknown; + readonly bank_account?: unknown /** * business_profile_specs * @description Business information about the account. */ readonly business_profile?: { - readonly mcc?: string; - readonly name?: string; - readonly product_description?: string; - readonly support_email?: string; - readonly support_phone?: string; - readonly support_url?: string; - readonly url?: string; - }; + readonly mcc?: string + readonly name?: string + readonly product_description?: string + readonly support_email?: string + readonly support_phone?: string + readonly support_url?: string + readonly url?: string + } /** * @description The business type. * @enum {string} */ - readonly business_type?: "company" | "government_entity" | "individual" | "non_profit"; + readonly business_type?: 'company' | 'government_entity' | 'individual' | 'non_profit' /** * company_specs * @description Information about the company or business. This field is null unless `business_type` is set to `company`, `government_entity`, or `non_profit`. @@ -10178,78 +10136,78 @@ export interface operations { readonly company?: { /** address_specs */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } /** japan_address_kana_specs */ readonly address_kana?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** japan_address_kanji_specs */ readonly address_kanji?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; - readonly directors_provided?: boolean; - readonly executives_provided?: boolean; - readonly name?: string; - readonly name_kana?: string; - readonly name_kanji?: string; - readonly owners_provided?: boolean; - readonly phone?: string; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } + readonly directors_provided?: boolean + readonly executives_provided?: boolean + readonly name?: string + readonly name_kana?: string + readonly name_kanji?: string + readonly owners_provided?: boolean + readonly phone?: string /** @enum {string} */ readonly structure?: - | "" - | "government_instrumentality" - | "governmental_unit" - | "incorporated_non_profit" - | "limited_liability_partnership" - | "multi_member_llc" - | "private_company" - | "private_corporation" - | "private_partnership" - | "public_company" - | "public_corporation" - | "public_partnership" - | "sole_proprietorship" - | "tax_exempt_government_instrumentality" - | "unincorporated_association" - | "unincorporated_non_profit"; - readonly tax_id?: string; - readonly tax_id_registrar?: string; - readonly vat_id?: string; + | '' + | 'government_instrumentality' + | 'governmental_unit' + | 'incorporated_non_profit' + | 'limited_liability_partnership' + | 'multi_member_llc' + | 'private_company' + | 'private_corporation' + | 'private_partnership' + | 'public_company' + | 'public_corporation' + | 'public_partnership' + | 'sole_proprietorship' + | 'tax_exempt_government_instrumentality' + | 'unincorporated_association' + | 'unincorporated_non_profit' + readonly tax_id?: string + readonly tax_id_registrar?: string + readonly vat_id?: string /** verification_specs */ readonly verification?: { /** verification_document_specs */ readonly document?: { - readonly back?: string; - readonly front?: string; - }; - }; - }; + readonly back?: string + readonly front?: string + } + } + } /** @description 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). */ - readonly default_currency?: string; + readonly default_currency?: string /** @description Email address of the account representative. For Standard accounts, this is used to ask them to claim their Stripe account. For Custom accounts, this only makes the account easier to identify to platforms; Stripe does not email the account representative. */ - readonly email?: string; + readonly email?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description A card or bank account to attach to the account. You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://stripe.com/docs/api#account_create_bank_account) creation.

By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the bank account or card creation API. */ - readonly external_account?: string; + readonly external_account?: string /** * individual_specs * @description Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. @@ -10257,74 +10215,74 @@ export interface operations { readonly individual?: { /** address_specs */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } /** japan_address_kana_specs */ readonly address_kana?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** japan_address_kanji_specs */ readonly address_kanji?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; - readonly dob?: unknown; - readonly email?: string; - readonly first_name?: string; - readonly first_name_kana?: string; - readonly first_name_kanji?: string; - readonly gender?: string; - readonly id_number?: string; - readonly last_name?: string; - readonly last_name_kana?: string; - readonly last_name_kanji?: string; - readonly maiden_name?: string; - readonly metadata?: unknown; - readonly phone?: string; - readonly ssn_last_4?: string; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } + readonly dob?: unknown + readonly email?: string + readonly first_name?: string + readonly first_name_kana?: string + readonly first_name_kanji?: string + readonly gender?: string + readonly id_number?: string + readonly last_name?: string + readonly last_name_kana?: string + readonly last_name_kanji?: string + readonly maiden_name?: string + readonly metadata?: unknown + readonly phone?: string + readonly ssn_last_4?: string /** person_verification_specs */ readonly verification?: { /** person_verification_document_specs */ readonly additional_document?: { - readonly back?: string; - readonly front?: string; - }; + readonly back?: string + readonly front?: string + } /** person_verification_document_specs */ readonly document?: { - readonly back?: string; - readonly front?: string; - }; - }; - }; + readonly back?: string + readonly front?: string + } + } + } /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description The set of capabilities you want to unlock for this account. Each capability will be inactive until you have provided its specific requirements and Stripe has verified them. An account may have some of its requested capabilities be active and some be inactive. */ readonly requested_capabilities?: readonly ( - | "au_becs_debit_payments" - | "card_issuing" - | "card_payments" - | "jcb_payments" - | "legacy_payments" - | "tax_reporting_us_1099_k" - | "tax_reporting_us_1099_misc" - | "transfers" - )[]; + | 'au_becs_debit_payments' + | 'card_issuing' + | 'card_payments' + | 'jcb_payments' + | 'legacy_payments' + | 'tax_reporting_us_1099_k' + | 'tax_reporting_us_1099_misc' + | 'transfers' + )[] /** * settings_specs * @description Options for customizing how the account functions within Stripe. @@ -10332,71 +10290,64 @@ export interface operations { readonly settings?: { /** branding_settings_specs */ readonly branding?: { - readonly icon?: string; - readonly logo?: string; - readonly primary_color?: string; - readonly secondary_color?: string; - }; + readonly icon?: string + readonly logo?: string + readonly primary_color?: string + readonly secondary_color?: string + } /** card_payments_settings_specs */ readonly card_payments?: { /** decline_charge_on_specs */ readonly decline_on?: { - readonly avs_failure?: boolean; - readonly cvc_failure?: boolean; - }; - readonly statement_descriptor_prefix?: string; - }; + readonly avs_failure?: boolean + readonly cvc_failure?: boolean + } + readonly statement_descriptor_prefix?: string + } /** payments_settings_specs */ readonly payments?: { - readonly statement_descriptor?: string; - readonly statement_descriptor_kana?: string; - readonly statement_descriptor_kanji?: string; - }; + readonly statement_descriptor?: string + readonly statement_descriptor_kana?: string + readonly statement_descriptor_kanji?: string + } /** payout_settings_specs */ readonly payouts?: { - readonly debit_negative_balances?: boolean; + readonly debit_negative_balances?: boolean /** transfer_schedule_specs */ readonly schedule?: { - readonly delay_days?: unknown; + readonly delay_days?: unknown /** @enum {string} */ - readonly interval?: "daily" | "manual" | "monthly" | "weekly"; - readonly monthly_anchor?: number; + readonly interval?: 'daily' | 'manual' | 'monthly' | 'weekly' + readonly monthly_anchor?: number /** @enum {string} */ - readonly weekly_anchor?: - | "friday" - | "monday" - | "saturday" - | "sunday" - | "thursday" - | "tuesday" - | "wednesday"; - }; - readonly statement_descriptor?: string; - }; - }; + readonly weekly_anchor?: 'friday' | 'monday' | 'saturday' | 'sunday' | 'thursday' | 'tuesday' | 'wednesday' + } + readonly statement_descriptor?: string + } + } /** * tos_acceptance_specs * @description Details on the account's acceptance of the [Stripe Services Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance). */ readonly tos_acceptance?: { - readonly date?: number; - readonly ip?: string; - readonly user_agent?: string; - }; - }; - }; - }; + readonly date?: number + readonly ip?: string + readonly user_agent?: string + } + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["account"]; - }; + readonly schema: definitions['account'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

With Connect, you can delete Custom or Express accounts you manage.

* @@ -10409,21 +10360,21 @@ export interface operations { readonly body: { /** Body parameters for the request. */ readonly payload?: { - readonly account?: string; - }; - }; - }; + readonly account?: string + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["deleted_account"]; - }; + readonly schema: definitions['deleted_account'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Create an external account for a given account.

*/ readonly PostAccountBankAccounts: { readonly parameters: { @@ -10431,51 +10382,51 @@ export interface operations { /** Body parameters for the request. */ readonly payload?: { /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js), or a dictionary containing a user's bank account details. */ - readonly bank_account?: unknown; + readonly bank_account?: unknown /** @description When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency. */ - readonly default_for_currency?: boolean; + readonly default_for_currency?: boolean /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - readonly external_account?: string; + readonly external_account?: string /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: { readonly [key: string]: unknown }; - }; - }; - }; + readonly metadata?: { readonly [key: string]: unknown } + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["external_account"]; - }; + readonly schema: definitions['external_account'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieve a specified external account for a given account.

*/ readonly GetAccountBankAccountsId: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["external_account"]; - }; + readonly schema: definitions['external_account'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

Updates the metadata, account holder name, and account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

*

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

@@ -10483,190 +10434,190 @@ export interface operations { readonly PostAccountBankAccountsId: { readonly parameters: { readonly path: { - readonly id: string; - }; + readonly id: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description The name of the person or business that owns the bank account. */ - readonly account_holder_name?: string; + readonly account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - readonly account_holder_type?: "" | "company" | "individual"; + readonly account_holder_type?: '' | 'company' | 'individual' /** @description City/District/Suburb/Town/Village. */ - readonly address_city?: string; + readonly address_city?: string /** @description Billing address country, if provided when creating card. */ - readonly address_country?: string; + readonly address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - readonly address_line1?: string; + readonly address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - readonly address_line2?: string; + readonly address_line2?: string /** @description State/County/Province/Region. */ - readonly address_state?: string; + readonly address_state?: string /** @description ZIP or postal code. */ - readonly address_zip?: string; + readonly address_zip?: string /** @description When set to true, this becomes the default external account for its currency. */ - readonly default_for_currency?: boolean; + readonly default_for_currency?: boolean /** @description Two digit number representing the card’s expiration month. */ - readonly exp_month?: string; + readonly exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - readonly exp_year?: string; + readonly exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description Cardholder name. */ - readonly name?: string; - }; - }; - }; + readonly name?: string + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["external_account"]; - }; + readonly schema: definitions['external_account'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Delete a specified external account for a given account.

*/ readonly DeleteAccountBankAccountsId: { readonly parameters: { readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["deleted_external_account"]; - }; + readonly schema: definitions['deleted_external_account'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly GetAccountCapabilities: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; - }; + readonly expand?: readonly unknown[] + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["capability"][]; + readonly data: readonly definitions['capability'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves information about the specified Account Capability.

*/ readonly GetAccountCapabilitiesCapability: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly capability: string; - }; - }; + readonly capability: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["capability"]; - }; + readonly schema: definitions['capability'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Updates an existing Account Capability.

*/ readonly PostAccountCapabilitiesCapability: { readonly parameters: { readonly path: { - readonly capability: string; - }; + readonly capability: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. */ - readonly requested?: boolean; - }; - }; - }; + readonly requested?: boolean + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["capability"]; - }; + readonly schema: definitions['capability'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

List external accounts for an account.

*/ readonly GetAccountExternalAccounts: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { /** @description The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards. */ - readonly data: readonly definitions["bank_account"][]; + readonly data: readonly definitions['bank_account'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Create an external account for a given account.

*/ readonly PostAccountExternalAccounts: { readonly parameters: { @@ -10674,51 +10625,51 @@ export interface operations { /** Body parameters for the request. */ readonly payload?: { /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js), or a dictionary containing a user's bank account details. */ - readonly bank_account?: unknown; + readonly bank_account?: unknown /** @description When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency. */ - readonly default_for_currency?: boolean; + readonly default_for_currency?: boolean /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - readonly external_account?: string; + readonly external_account?: string /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: { readonly [key: string]: unknown }; - }; - }; - }; + readonly metadata?: { readonly [key: string]: unknown } + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["external_account"]; - }; + readonly schema: definitions['external_account'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieve a specified external account for a given account.

*/ readonly GetAccountExternalAccountsId: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["external_account"]; - }; + readonly schema: definitions['external_account'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

Updates the metadata, account holder name, and account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

*

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

@@ -10726,74 +10677,74 @@ export interface operations { readonly PostAccountExternalAccountsId: { readonly parameters: { readonly path: { - readonly id: string; - }; + readonly id: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description The name of the person or business that owns the bank account. */ - readonly account_holder_name?: string; + readonly account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - readonly account_holder_type?: "" | "company" | "individual"; + readonly account_holder_type?: '' | 'company' | 'individual' /** @description City/District/Suburb/Town/Village. */ - readonly address_city?: string; + readonly address_city?: string /** @description Billing address country, if provided when creating card. */ - readonly address_country?: string; + readonly address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - readonly address_line1?: string; + readonly address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - readonly address_line2?: string; + readonly address_line2?: string /** @description State/County/Province/Region. */ - readonly address_state?: string; + readonly address_state?: string /** @description ZIP or postal code. */ - readonly address_zip?: string; + readonly address_zip?: string /** @description When set to true, this becomes the default external account for its currency. */ - readonly default_for_currency?: boolean; + readonly default_for_currency?: boolean /** @description Two digit number representing the card’s expiration month. */ - readonly exp_month?: string; + readonly exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - readonly exp_year?: string; + readonly exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description Cardholder name. */ - readonly name?: string; - }; - }; - }; + readonly name?: string + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["external_account"]; - }; + readonly schema: definitions['external_account'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Delete a specified external account for a given account.

*/ readonly DeleteAccountExternalAccountsId: { readonly parameters: { readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["deleted_external_account"]; - }; + readonly schema: definitions['deleted_external_account'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

Creates a single-use login link for an Express account to access their Stripe dashboard.

* @@ -10804,25 +10755,25 @@ export interface operations { readonly body: { /** Body parameters for the request. */ readonly payload: { - readonly account: string; + readonly account: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description Where to redirect the user after they log out of their dashboard. */ - readonly redirect_url?: string; - }; - }; - }; + readonly redirect_url?: string + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["login_link"]; - }; + readonly schema: definitions['login_link'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

Invalidates all sessions for a light account, for a platform to use during platform logout.

* @@ -10833,150 +10784,150 @@ export interface operations { readonly body: { /** Body parameters for the request. */ readonly payload: { - readonly account: string; + readonly account: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["light_account_logout"]; - }; + readonly schema: definitions['light_account_logout'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly GetAccountPeople: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** Filters on the list of people returned based on the person's relationship to the account's company. */ - readonly relationship?: string; + readonly relationship?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["person"][]; + readonly data: readonly definitions['person'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Creates a new person.

*/ readonly PostAccountPeople: { readonly parameters: { readonly body: { /** Body parameters for the request. */ readonly payload?: { - readonly account?: string; + readonly account?: string /** * address_specs * @description The person's address. */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ readonly address_kana?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ readonly address_kanji?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** @description The person's date of birth. */ - readonly dob?: unknown; + readonly dob?: unknown /** @description The person's email address. */ - readonly email?: string; + readonly email?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The person's first name. */ - readonly first_name?: string; + readonly first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - readonly first_name_kana?: string; + readonly first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - readonly first_name_kanji?: string; + readonly first_name_kanji?: string /** @description The person's gender (International regulations require either "male" or "female"). */ - readonly gender?: string; + readonly gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/stripe.js#collecting-pii-data). */ - readonly id_number?: string; + readonly id_number?: string /** @description The person's last name. */ - readonly last_name?: string; + readonly last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - readonly last_name_kana?: string; + readonly last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - readonly last_name_kanji?: string; + readonly last_name_kanji?: string /** @description The person's maiden name. */ - readonly maiden_name?: string; + readonly maiden_name?: string /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - readonly person_token?: string; + readonly person_token?: string /** @description The person's phone number. */ - readonly phone?: string; + readonly phone?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ readonly relationship?: { - readonly director?: boolean; - readonly executive?: boolean; - readonly owner?: boolean; - readonly percent_ownership?: unknown; - readonly representative?: boolean; - readonly title?: string; - }; + readonly director?: boolean + readonly executive?: boolean + readonly owner?: boolean + readonly percent_ownership?: unknown + readonly representative?: boolean + readonly title?: string + } /** @description The last 4 digits of the person's social security number. */ - readonly ssn_last_4?: string; + readonly ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -10984,143 +10935,143 @@ export interface operations { readonly verification?: { /** person_verification_document_specs */ readonly additional_document?: { - readonly back?: string; - readonly front?: string; - }; + readonly back?: string + readonly front?: string + } /** person_verification_document_specs */ readonly document?: { - readonly back?: string; - readonly front?: string; - }; - }; - }; - }; - }; + readonly back?: string + readonly front?: string + } + } + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["person"]; - }; + readonly schema: definitions['person'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves an existing person.

*/ readonly GetAccountPeoplePerson: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly person: string; - }; - }; + readonly person: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["person"]; - }; + readonly schema: definitions['person'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Updates an existing person.

*/ readonly PostAccountPeoplePerson: { readonly parameters: { readonly path: { - readonly person: string; - }; + readonly person: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { - readonly account?: string; + readonly account?: string /** * address_specs * @description The person's address. */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ readonly address_kana?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ readonly address_kanji?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** @description The person's date of birth. */ - readonly dob?: unknown; + readonly dob?: unknown /** @description The person's email address. */ - readonly email?: string; + readonly email?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The person's first name. */ - readonly first_name?: string; + readonly first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - readonly first_name_kana?: string; + readonly first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - readonly first_name_kanji?: string; + readonly first_name_kanji?: string /** @description The person's gender (International regulations require either "male" or "female"). */ - readonly gender?: string; + readonly gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/stripe.js#collecting-pii-data). */ - readonly id_number?: string; + readonly id_number?: string /** @description The person's last name. */ - readonly last_name?: string; + readonly last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - readonly last_name_kana?: string; + readonly last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - readonly last_name_kanji?: string; + readonly last_name_kanji?: string /** @description The person's maiden name. */ - readonly maiden_name?: string; + readonly maiden_name?: string /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - readonly person_token?: string; + readonly person_token?: string /** @description The person's phone number. */ - readonly phone?: string; + readonly phone?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ readonly relationship?: { - readonly director?: boolean; - readonly executive?: boolean; - readonly owner?: boolean; - readonly percent_ownership?: unknown; - readonly representative?: boolean; - readonly title?: string; - }; + readonly director?: boolean + readonly executive?: boolean + readonly owner?: boolean + readonly percent_ownership?: unknown + readonly representative?: boolean + readonly title?: string + } /** @description The last 4 digits of the person's social security number. */ - readonly ssn_last_4?: string; + readonly ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -11128,174 +11079,174 @@ export interface operations { readonly verification?: { /** person_verification_document_specs */ readonly additional_document?: { - readonly back?: string; - readonly front?: string; - }; + readonly back?: string + readonly front?: string + } /** person_verification_document_specs */ readonly document?: { - readonly back?: string; - readonly front?: string; - }; - }; - }; - }; - }; + readonly back?: string + readonly front?: string + } + } + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["person"]; - }; + readonly schema: definitions['person'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly DeleteAccountPeoplePerson: { readonly parameters: { readonly path: { - readonly person: string; - }; - }; + readonly person: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["deleted_person"]; - }; + readonly schema: definitions['deleted_person'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly GetAccountPersons: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** Filters on the list of people returned based on the person's relationship to the account's company. */ - readonly relationship?: string; + readonly relationship?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["person"][]; + readonly data: readonly definitions['person'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Creates a new person.

*/ readonly PostAccountPersons: { readonly parameters: { readonly body: { /** Body parameters for the request. */ readonly payload?: { - readonly account?: string; + readonly account?: string /** * address_specs * @description The person's address. */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ readonly address_kana?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ readonly address_kanji?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** @description The person's date of birth. */ - readonly dob?: unknown; + readonly dob?: unknown /** @description The person's email address. */ - readonly email?: string; + readonly email?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The person's first name. */ - readonly first_name?: string; + readonly first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - readonly first_name_kana?: string; + readonly first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - readonly first_name_kanji?: string; + readonly first_name_kanji?: string /** @description The person's gender (International regulations require either "male" or "female"). */ - readonly gender?: string; + readonly gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/stripe.js#collecting-pii-data). */ - readonly id_number?: string; + readonly id_number?: string /** @description The person's last name. */ - readonly last_name?: string; + readonly last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - readonly last_name_kana?: string; + readonly last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - readonly last_name_kanji?: string; + readonly last_name_kanji?: string /** @description The person's maiden name. */ - readonly maiden_name?: string; + readonly maiden_name?: string /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - readonly person_token?: string; + readonly person_token?: string /** @description The person's phone number. */ - readonly phone?: string; + readonly phone?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ readonly relationship?: { - readonly director?: boolean; - readonly executive?: boolean; - readonly owner?: boolean; - readonly percent_ownership?: unknown; - readonly representative?: boolean; - readonly title?: string; - }; + readonly director?: boolean + readonly executive?: boolean + readonly owner?: boolean + readonly percent_ownership?: unknown + readonly representative?: boolean + readonly title?: string + } /** @description The last 4 digits of the person's social security number. */ - readonly ssn_last_4?: string; + readonly ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -11303,143 +11254,143 @@ export interface operations { readonly verification?: { /** person_verification_document_specs */ readonly additional_document?: { - readonly back?: string; - readonly front?: string; - }; + readonly back?: string + readonly front?: string + } /** person_verification_document_specs */ readonly document?: { - readonly back?: string; - readonly front?: string; - }; - }; - }; - }; - }; + readonly back?: string + readonly front?: string + } + } + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["person"]; - }; + readonly schema: definitions['person'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves an existing person.

*/ readonly GetAccountPersonsPerson: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly person: string; - }; - }; + readonly person: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["person"]; - }; + readonly schema: definitions['person'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Updates an existing person.

*/ readonly PostAccountPersonsPerson: { readonly parameters: { readonly path: { - readonly person: string; - }; + readonly person: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { - readonly account?: string; + readonly account?: string /** * address_specs * @description The person's address. */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ readonly address_kana?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ readonly address_kanji?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** @description The person's date of birth. */ - readonly dob?: unknown; + readonly dob?: unknown /** @description The person's email address. */ - readonly email?: string; + readonly email?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The person's first name. */ - readonly first_name?: string; + readonly first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - readonly first_name_kana?: string; + readonly first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - readonly first_name_kanji?: string; + readonly first_name_kanji?: string /** @description The person's gender (International regulations require either "male" or "female"). */ - readonly gender?: string; + readonly gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/stripe.js#collecting-pii-data). */ - readonly id_number?: string; + readonly id_number?: string /** @description The person's last name. */ - readonly last_name?: string; + readonly last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - readonly last_name_kana?: string; + readonly last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - readonly last_name_kanji?: string; + readonly last_name_kanji?: string /** @description The person's maiden name. */ - readonly maiden_name?: string; + readonly maiden_name?: string /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - readonly person_token?: string; + readonly person_token?: string /** @description The person's phone number. */ - readonly phone?: string; + readonly phone?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ readonly relationship?: { - readonly director?: boolean; - readonly executive?: boolean; - readonly owner?: boolean; - readonly percent_ownership?: unknown; - readonly representative?: boolean; - readonly title?: string; - }; + readonly director?: boolean + readonly executive?: boolean + readonly owner?: boolean + readonly percent_ownership?: unknown + readonly representative?: boolean + readonly title?: string + } /** @description The last 4 digits of the person's social security number. */ - readonly ssn_last_4?: string; + readonly ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -11447,47 +11398,47 @@ export interface operations { readonly verification?: { /** person_verification_document_specs */ readonly additional_document?: { - readonly back?: string; - readonly front?: string; - }; + readonly back?: string + readonly front?: string + } /** person_verification_document_specs */ readonly document?: { - readonly back?: string; - readonly front?: string; - }; - }; - }; - }; - }; + readonly back?: string + readonly front?: string + } + } + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["person"]; - }; + readonly schema: definitions['person'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly DeleteAccountPersonsPerson: { readonly parameters: { readonly path: { - readonly person: string; - }; - }; + readonly person: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["deleted_person"]; - }; + readonly schema: definitions['deleted_person'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly PostAccountLinks: { readonly parameters: { @@ -11495,74 +11446,74 @@ export interface operations { /** Body parameters for the request. */ readonly payload: { /** @description The identifier of the account to create an account link for. */ - readonly account: string; + readonly account: string /** * @description Which information the platform needs to collect from the user. One of `currently_due` or `eventually_due`. Default is `currently_due`. * @enum {string} */ - readonly collect?: "currently_due" | "eventually_due"; + readonly collect?: 'currently_due' | 'eventually_due' /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The URL that the user will be redirected to if the account link is no longer valid. */ - readonly failure_url: string; + readonly failure_url: string /** @description The URL that the user will be redirected to upon leaving or completing the linked flow successfully. */ - readonly success_url: string; + readonly success_url: string /** * @description The type of account link the user is requesting. Possible values are `custom_account_verification` or `custom_account_update`. * @enum {string} */ - readonly type: "custom_account_update" | "custom_account_verification"; - }; - }; - }; + readonly type: 'custom_account_update' | 'custom_account_verification' + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["account_link"]; - }; + readonly schema: definitions['account_link'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly GetAccounts: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - readonly created?: number; + readonly expand?: readonly unknown[] + readonly created?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["account"][]; + readonly data: readonly definitions['account'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

With Connect, you can create Stripe accounts for your users. * To do this, you’ll first need to register your platform.

@@ -11576,27 +11527,27 @@ export interface operations { /** Body parameters for the request. */ readonly payload?: { /** @description An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account. */ - readonly account_token?: string; + readonly account_token?: string /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js), or a dictionary containing a user's bank account details. */ - readonly bank_account?: unknown; + readonly bank_account?: unknown /** * business_profile_specs * @description Business information about the account. */ readonly business_profile?: { - readonly mcc?: string; - readonly name?: string; - readonly product_description?: string; - readonly support_email?: string; - readonly support_phone?: string; - readonly support_url?: string; - readonly url?: string; - }; + readonly mcc?: string + readonly name?: string + readonly product_description?: string + readonly support_email?: string + readonly support_phone?: string + readonly support_url?: string + readonly url?: string + } /** * @description The business type. * @enum {string} */ - readonly business_type?: "company" | "government_entity" | "individual" | "non_profit"; + readonly business_type?: 'company' | 'government_entity' | 'individual' | 'non_profit' /** * company_specs * @description Information about the company or business. This field is null unless `business_type` is set to `company`, `government_entity`, or `non_profit`. @@ -11604,80 +11555,80 @@ export interface operations { readonly company?: { /** address_specs */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } /** japan_address_kana_specs */ readonly address_kana?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** japan_address_kanji_specs */ readonly address_kanji?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; - readonly directors_provided?: boolean; - readonly executives_provided?: boolean; - readonly name?: string; - readonly name_kana?: string; - readonly name_kanji?: string; - readonly owners_provided?: boolean; - readonly phone?: string; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } + readonly directors_provided?: boolean + readonly executives_provided?: boolean + readonly name?: string + readonly name_kana?: string + readonly name_kanji?: string + readonly owners_provided?: boolean + readonly phone?: string /** @enum {string} */ readonly structure?: - | "" - | "government_instrumentality" - | "governmental_unit" - | "incorporated_non_profit" - | "limited_liability_partnership" - | "multi_member_llc" - | "private_company" - | "private_corporation" - | "private_partnership" - | "public_company" - | "public_corporation" - | "public_partnership" - | "sole_proprietorship" - | "tax_exempt_government_instrumentality" - | "unincorporated_association" - | "unincorporated_non_profit"; - readonly tax_id?: string; - readonly tax_id_registrar?: string; - readonly vat_id?: string; + | '' + | 'government_instrumentality' + | 'governmental_unit' + | 'incorporated_non_profit' + | 'limited_liability_partnership' + | 'multi_member_llc' + | 'private_company' + | 'private_corporation' + | 'private_partnership' + | 'public_company' + | 'public_corporation' + | 'public_partnership' + | 'sole_proprietorship' + | 'tax_exempt_government_instrumentality' + | 'unincorporated_association' + | 'unincorporated_non_profit' + readonly tax_id?: string + readonly tax_id_registrar?: string + readonly vat_id?: string /** verification_specs */ readonly verification?: { /** verification_document_specs */ readonly document?: { - readonly back?: string; - readonly front?: string; - }; - }; - }; + readonly back?: string + readonly front?: string + } + } + } /** @description The country in which the account holder resides, or in which the business is legally established. This should be an ISO 3166-1 alpha-2 country code. For example, if you are in the United States and the business for which you're creating an account is legally represented in Canada, you would use `CA` as the country for the account being created. */ - readonly country?: string; + readonly country?: string /** @description 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). */ - readonly default_currency?: string; + readonly default_currency?: string /** @description The email address of the account holder. For Custom accounts, this is only to make the account easier to identify to you: Stripe will never directly email your users. */ - readonly email?: string; + readonly email?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description A card or bank account to attach to the account. You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://stripe.com/docs/api#account_create_bank_account) creation.

By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the bank account or card creation API. */ - readonly external_account?: string; + readonly external_account?: string /** * individual_specs * @description Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. @@ -11685,74 +11636,74 @@ export interface operations { readonly individual?: { /** address_specs */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } /** japan_address_kana_specs */ readonly address_kana?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** japan_address_kanji_specs */ readonly address_kanji?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; - readonly dob?: unknown; - readonly email?: string; - readonly first_name?: string; - readonly first_name_kana?: string; - readonly first_name_kanji?: string; - readonly gender?: string; - readonly id_number?: string; - readonly last_name?: string; - readonly last_name_kana?: string; - readonly last_name_kanji?: string; - readonly maiden_name?: string; - readonly metadata?: unknown; - readonly phone?: string; - readonly ssn_last_4?: string; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } + readonly dob?: unknown + readonly email?: string + readonly first_name?: string + readonly first_name_kana?: string + readonly first_name_kanji?: string + readonly gender?: string + readonly id_number?: string + readonly last_name?: string + readonly last_name_kana?: string + readonly last_name_kanji?: string + readonly maiden_name?: string + readonly metadata?: unknown + readonly phone?: string + readonly ssn_last_4?: string /** person_verification_specs */ readonly verification?: { /** person_verification_document_specs */ readonly additional_document?: { - readonly back?: string; - readonly front?: string; - }; + readonly back?: string + readonly front?: string + } /** person_verification_document_specs */ readonly document?: { - readonly back?: string; - readonly front?: string; - }; - }; - }; + readonly back?: string + readonly front?: string + } + } + } /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description The set of capabilities you want to unlock for this account. Each capability will be inactive until you have provided its specific requirements and Stripe has verified them. An account may have some of its requested capabilities be active and some be inactive. */ readonly requested_capabilities?: readonly ( - | "au_becs_debit_payments" - | "card_issuing" - | "card_payments" - | "jcb_payments" - | "legacy_payments" - | "tax_reporting_us_1099_k" - | "tax_reporting_us_1099_misc" - | "transfers" - )[]; + | 'au_becs_debit_payments' + | 'card_issuing' + | 'card_payments' + | 'jcb_payments' + | 'legacy_payments' + | 'tax_reporting_us_1099_k' + | 'tax_reporting_us_1099_misc' + | 'transfers' + )[] /** * settings_specs * @description Options for customizing how the account functions within Stripe. @@ -11760,98 +11711,91 @@ export interface operations { readonly settings?: { /** branding_settings_specs */ readonly branding?: { - readonly icon?: string; - readonly logo?: string; - readonly primary_color?: string; - readonly secondary_color?: string; - }; + readonly icon?: string + readonly logo?: string + readonly primary_color?: string + readonly secondary_color?: string + } /** card_payments_settings_specs */ readonly card_payments?: { /** decline_charge_on_specs */ readonly decline_on?: { - readonly avs_failure?: boolean; - readonly cvc_failure?: boolean; - }; - readonly statement_descriptor_prefix?: string; - }; + readonly avs_failure?: boolean + readonly cvc_failure?: boolean + } + readonly statement_descriptor_prefix?: string + } /** payments_settings_specs */ readonly payments?: { - readonly statement_descriptor?: string; - readonly statement_descriptor_kana?: string; - readonly statement_descriptor_kanji?: string; - }; + readonly statement_descriptor?: string + readonly statement_descriptor_kana?: string + readonly statement_descriptor_kanji?: string + } /** payout_settings_specs */ readonly payouts?: { - readonly debit_negative_balances?: boolean; + readonly debit_negative_balances?: boolean /** transfer_schedule_specs */ readonly schedule?: { - readonly delay_days?: unknown; + readonly delay_days?: unknown /** @enum {string} */ - readonly interval?: "daily" | "manual" | "monthly" | "weekly"; - readonly monthly_anchor?: number; + readonly interval?: 'daily' | 'manual' | 'monthly' | 'weekly' + readonly monthly_anchor?: number /** @enum {string} */ - readonly weekly_anchor?: - | "friday" - | "monday" - | "saturday" - | "sunday" - | "thursday" - | "tuesday" - | "wednesday"; - }; - readonly statement_descriptor?: string; - }; - }; + readonly weekly_anchor?: 'friday' | 'monday' | 'saturday' | 'sunday' | 'thursday' | 'tuesday' | 'wednesday' + } + readonly statement_descriptor?: string + } + } /** * tos_acceptance_specs * @description Details on the account's acceptance of the [Stripe Services Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance). */ readonly tos_acceptance?: { - readonly date?: number; - readonly ip?: string; - readonly user_agent?: string; - }; + readonly date?: number + readonly ip?: string + readonly user_agent?: string + } /** * @description The type of Stripe account to create. Currently must be `custom`, as only [Custom accounts](https://stripe.com/docs/connect/custom-accounts) may be created via the API. * @enum {string} */ - readonly type?: "custom" | "express" | "standard"; - }; - }; - }; + readonly type?: 'custom' | 'express' | 'standard' + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["account"]; - }; + readonly schema: definitions['account'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves the details of an account.

*/ readonly GetAccountsAccount: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly account: string; - }; - }; + readonly account: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["account"]; - }; + readonly schema: definitions['account'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

Updates a connected Express or Custom account by setting the values of the parameters passed. Any parameters not provided are left unchanged. Most parameters can be changed only for Custom accounts. (These are marked Custom Only below.) Parameters marked Custom and Express are supported by both account types.

* @@ -11860,33 +11804,33 @@ export interface operations { readonly PostAccountsAccount: { readonly parameters: { readonly path: { - readonly account: string; - }; + readonly account: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account. */ - readonly account_token?: string; + readonly account_token?: string /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js), or a dictionary containing a user's bank account details. */ - readonly bank_account?: unknown; + readonly bank_account?: unknown /** * business_profile_specs * @description Business information about the account. */ readonly business_profile?: { - readonly mcc?: string; - readonly name?: string; - readonly product_description?: string; - readonly support_email?: string; - readonly support_phone?: string; - readonly support_url?: string; - readonly url?: string; - }; + readonly mcc?: string + readonly name?: string + readonly product_description?: string + readonly support_email?: string + readonly support_phone?: string + readonly support_url?: string + readonly url?: string + } /** * @description The business type. * @enum {string} */ - readonly business_type?: "company" | "government_entity" | "individual" | "non_profit"; + readonly business_type?: 'company' | 'government_entity' | 'individual' | 'non_profit' /** * company_specs * @description Information about the company or business. This field is null unless `business_type` is set to `company`, `government_entity`, or `non_profit`. @@ -11894,78 +11838,78 @@ export interface operations { readonly company?: { /** address_specs */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } /** japan_address_kana_specs */ readonly address_kana?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** japan_address_kanji_specs */ readonly address_kanji?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; - readonly directors_provided?: boolean; - readonly executives_provided?: boolean; - readonly name?: string; - readonly name_kana?: string; - readonly name_kanji?: string; - readonly owners_provided?: boolean; - readonly phone?: string; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } + readonly directors_provided?: boolean + readonly executives_provided?: boolean + readonly name?: string + readonly name_kana?: string + readonly name_kanji?: string + readonly owners_provided?: boolean + readonly phone?: string /** @enum {string} */ readonly structure?: - | "" - | "government_instrumentality" - | "governmental_unit" - | "incorporated_non_profit" - | "limited_liability_partnership" - | "multi_member_llc" - | "private_company" - | "private_corporation" - | "private_partnership" - | "public_company" - | "public_corporation" - | "public_partnership" - | "sole_proprietorship" - | "tax_exempt_government_instrumentality" - | "unincorporated_association" - | "unincorporated_non_profit"; - readonly tax_id?: string; - readonly tax_id_registrar?: string; - readonly vat_id?: string; + | '' + | 'government_instrumentality' + | 'governmental_unit' + | 'incorporated_non_profit' + | 'limited_liability_partnership' + | 'multi_member_llc' + | 'private_company' + | 'private_corporation' + | 'private_partnership' + | 'public_company' + | 'public_corporation' + | 'public_partnership' + | 'sole_proprietorship' + | 'tax_exempt_government_instrumentality' + | 'unincorporated_association' + | 'unincorporated_non_profit' + readonly tax_id?: string + readonly tax_id_registrar?: string + readonly vat_id?: string /** verification_specs */ readonly verification?: { /** verification_document_specs */ readonly document?: { - readonly back?: string; - readonly front?: string; - }; - }; - }; + readonly back?: string + readonly front?: string + } + } + } /** @description 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). */ - readonly default_currency?: string; + readonly default_currency?: string /** @description Email address of the account representative. For Standard accounts, this is used to ask them to claim their Stripe account. For Custom accounts, this only makes the account easier to identify to platforms; Stripe does not email the account representative. */ - readonly email?: string; + readonly email?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description A card or bank account to attach to the account. You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://stripe.com/docs/api#account_create_bank_account) creation.

By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the bank account or card creation API. */ - readonly external_account?: string; + readonly external_account?: string /** * individual_specs * @description Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. @@ -11973,74 +11917,74 @@ export interface operations { readonly individual?: { /** address_specs */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } /** japan_address_kana_specs */ readonly address_kana?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** japan_address_kanji_specs */ readonly address_kanji?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; - readonly dob?: unknown; - readonly email?: string; - readonly first_name?: string; - readonly first_name_kana?: string; - readonly first_name_kanji?: string; - readonly gender?: string; - readonly id_number?: string; - readonly last_name?: string; - readonly last_name_kana?: string; - readonly last_name_kanji?: string; - readonly maiden_name?: string; - readonly metadata?: unknown; - readonly phone?: string; - readonly ssn_last_4?: string; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } + readonly dob?: unknown + readonly email?: string + readonly first_name?: string + readonly first_name_kana?: string + readonly first_name_kanji?: string + readonly gender?: string + readonly id_number?: string + readonly last_name?: string + readonly last_name_kana?: string + readonly last_name_kanji?: string + readonly maiden_name?: string + readonly metadata?: unknown + readonly phone?: string + readonly ssn_last_4?: string /** person_verification_specs */ readonly verification?: { /** person_verification_document_specs */ readonly additional_document?: { - readonly back?: string; - readonly front?: string; - }; + readonly back?: string + readonly front?: string + } /** person_verification_document_specs */ readonly document?: { - readonly back?: string; - readonly front?: string; - }; - }; - }; + readonly back?: string + readonly front?: string + } + } + } /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description The set of capabilities you want to unlock for this account. Each capability will be inactive until you have provided its specific requirements and Stripe has verified them. An account may have some of its requested capabilities be active and some be inactive. */ readonly requested_capabilities?: readonly ( - | "au_becs_debit_payments" - | "card_issuing" - | "card_payments" - | "jcb_payments" - | "legacy_payments" - | "tax_reporting_us_1099_k" - | "tax_reporting_us_1099_misc" - | "transfers" - )[]; + | 'au_becs_debit_payments' + | 'card_issuing' + | 'card_payments' + | 'jcb_payments' + | 'legacy_payments' + | 'tax_reporting_us_1099_k' + | 'tax_reporting_us_1099_misc' + | 'transfers' + )[] /** * settings_specs * @description Options for customizing how the account functions within Stripe. @@ -12048,71 +11992,64 @@ export interface operations { readonly settings?: { /** branding_settings_specs */ readonly branding?: { - readonly icon?: string; - readonly logo?: string; - readonly primary_color?: string; - readonly secondary_color?: string; - }; + readonly icon?: string + readonly logo?: string + readonly primary_color?: string + readonly secondary_color?: string + } /** card_payments_settings_specs */ readonly card_payments?: { /** decline_charge_on_specs */ readonly decline_on?: { - readonly avs_failure?: boolean; - readonly cvc_failure?: boolean; - }; - readonly statement_descriptor_prefix?: string; - }; + readonly avs_failure?: boolean + readonly cvc_failure?: boolean + } + readonly statement_descriptor_prefix?: string + } /** payments_settings_specs */ readonly payments?: { - readonly statement_descriptor?: string; - readonly statement_descriptor_kana?: string; - readonly statement_descriptor_kanji?: string; - }; + readonly statement_descriptor?: string + readonly statement_descriptor_kana?: string + readonly statement_descriptor_kanji?: string + } /** payout_settings_specs */ readonly payouts?: { - readonly debit_negative_balances?: boolean; + readonly debit_negative_balances?: boolean /** transfer_schedule_specs */ readonly schedule?: { - readonly delay_days?: unknown; + readonly delay_days?: unknown /** @enum {string} */ - readonly interval?: "daily" | "manual" | "monthly" | "weekly"; - readonly monthly_anchor?: number; + readonly interval?: 'daily' | 'manual' | 'monthly' | 'weekly' + readonly monthly_anchor?: number /** @enum {string} */ - readonly weekly_anchor?: - | "friday" - | "monday" - | "saturday" - | "sunday" - | "thursday" - | "tuesday" - | "wednesday"; - }; - readonly statement_descriptor?: string; - }; - }; + readonly weekly_anchor?: 'friday' | 'monday' | 'saturday' | 'sunday' | 'thursday' | 'tuesday' | 'wednesday' + } + readonly statement_descriptor?: string + } + } /** * tos_acceptance_specs * @description Details on the account's acceptance of the [Stripe Services Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance). */ readonly tos_acceptance?: { - readonly date?: number; - readonly ip?: string; - readonly user_agent?: string; - }; - }; - }; - }; + readonly date?: number + readonly ip?: string + readonly user_agent?: string + } + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["account"]; - }; + readonly schema: definitions['account'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

With Connect, you can delete Custom or Express accounts you manage.

* @@ -12123,76 +12060,76 @@ export interface operations { readonly DeleteAccountsAccount: { readonly parameters: { readonly path: { - readonly account: string; - }; - }; + readonly account: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["deleted_account"]; - }; + readonly schema: definitions['deleted_account'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Create an external account for a given account.

*/ readonly PostAccountsAccountBankAccounts: { readonly parameters: { readonly path: { - readonly account: string; - }; + readonly account: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js), or a dictionary containing a user's bank account details. */ - readonly bank_account?: unknown; + readonly bank_account?: unknown /** @description When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency. */ - readonly default_for_currency?: boolean; + readonly default_for_currency?: boolean /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - readonly external_account?: string; + readonly external_account?: string /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: { readonly [key: string]: unknown }; - }; - }; - }; + readonly metadata?: { readonly [key: string]: unknown } + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["external_account"]; - }; + readonly schema: definitions['external_account'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieve a specified external account for a given account.

*/ readonly GetAccountsAccountBankAccountsId: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly account: string; - readonly id: string; - }; - }; + readonly account: string + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["external_account"]; - }; + readonly schema: definitions['external_account'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

Updates the metadata, account holder name, and account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

*

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

@@ -12200,256 +12137,256 @@ export interface operations { readonly PostAccountsAccountBankAccountsId: { readonly parameters: { readonly path: { - readonly account: string; - readonly id: string; - }; + readonly account: string + readonly id: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description The name of the person or business that owns the bank account. */ - readonly account_holder_name?: string; + readonly account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - readonly account_holder_type?: "" | "company" | "individual"; + readonly account_holder_type?: '' | 'company' | 'individual' /** @description City/District/Suburb/Town/Village. */ - readonly address_city?: string; + readonly address_city?: string /** @description Billing address country, if provided when creating card. */ - readonly address_country?: string; + readonly address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - readonly address_line1?: string; + readonly address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - readonly address_line2?: string; + readonly address_line2?: string /** @description State/County/Province/Region. */ - readonly address_state?: string; + readonly address_state?: string /** @description ZIP or postal code. */ - readonly address_zip?: string; + readonly address_zip?: string /** @description When set to true, this becomes the default external account for its currency. */ - readonly default_for_currency?: boolean; + readonly default_for_currency?: boolean /** @description Two digit number representing the card’s expiration month. */ - readonly exp_month?: string; + readonly exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - readonly exp_year?: string; + readonly exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description Cardholder name. */ - readonly name?: string; - }; - }; - }; + readonly name?: string + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["external_account"]; - }; + readonly schema: definitions['external_account'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Delete a specified external account for a given account.

*/ readonly DeleteAccountsAccountBankAccountsId: { readonly parameters: { readonly path: { - readonly account: string; - readonly id: string; - }; - }; + readonly account: string + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["deleted_external_account"]; - }; + readonly schema: definitions['deleted_external_account'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly GetAccountsAccountCapabilities: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly account: string; - }; - }; + readonly account: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["capability"][]; + readonly data: readonly definitions['capability'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves information about the specified Account Capability.

*/ readonly GetAccountsAccountCapabilitiesCapability: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly account: string; - readonly capability: string; - }; - }; + readonly account: string + readonly capability: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["capability"]; - }; + readonly schema: definitions['capability'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Updates an existing Account Capability.

*/ readonly PostAccountsAccountCapabilitiesCapability: { readonly parameters: { readonly path: { - readonly account: string; - readonly capability: string; - }; + readonly account: string + readonly capability: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. */ - readonly requested?: boolean; - }; - }; - }; + readonly requested?: boolean + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["capability"]; - }; + readonly schema: definitions['capability'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

List external accounts for an account.

*/ readonly GetAccountsAccountExternalAccounts: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; + readonly starting_after?: string + } readonly path: { - readonly account: string; - }; - }; + readonly account: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { /** @description The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards. */ - readonly data: readonly definitions["bank_account"][]; + readonly data: readonly definitions['bank_account'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Create an external account for a given account.

*/ readonly PostAccountsAccountExternalAccounts: { readonly parameters: { readonly path: { - readonly account: string; - }; + readonly account: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js), or a dictionary containing a user's bank account details. */ - readonly bank_account?: unknown; + readonly bank_account?: unknown /** @description When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency. */ - readonly default_for_currency?: boolean; + readonly default_for_currency?: boolean /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - readonly external_account?: string; + readonly external_account?: string /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: { readonly [key: string]: unknown }; - }; - }; - }; + readonly metadata?: { readonly [key: string]: unknown } + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["external_account"]; - }; + readonly schema: definitions['external_account'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieve a specified external account for a given account.

*/ readonly GetAccountsAccountExternalAccountsId: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly account: string; - readonly id: string; - }; - }; + readonly account: string + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["external_account"]; - }; + readonly schema: definitions['external_account'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

Updates the metadata, account holder name, and account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

*

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

@@ -12457,76 +12394,76 @@ export interface operations { readonly PostAccountsAccountExternalAccountsId: { readonly parameters: { readonly path: { - readonly account: string; - readonly id: string; - }; + readonly account: string + readonly id: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description The name of the person or business that owns the bank account. */ - readonly account_holder_name?: string; + readonly account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - readonly account_holder_type?: "" | "company" | "individual"; + readonly account_holder_type?: '' | 'company' | 'individual' /** @description City/District/Suburb/Town/Village. */ - readonly address_city?: string; + readonly address_city?: string /** @description Billing address country, if provided when creating card. */ - readonly address_country?: string; + readonly address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - readonly address_line1?: string; + readonly address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - readonly address_line2?: string; + readonly address_line2?: string /** @description State/County/Province/Region. */ - readonly address_state?: string; + readonly address_state?: string /** @description ZIP or postal code. */ - readonly address_zip?: string; + readonly address_zip?: string /** @description When set to true, this becomes the default external account for its currency. */ - readonly default_for_currency?: boolean; + readonly default_for_currency?: boolean /** @description Two digit number representing the card’s expiration month. */ - readonly exp_month?: string; + readonly exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - readonly exp_year?: string; + readonly exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description Cardholder name. */ - readonly name?: string; - }; - }; - }; + readonly name?: string + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["external_account"]; - }; + readonly schema: definitions['external_account'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Delete a specified external account for a given account.

*/ readonly DeleteAccountsAccountExternalAccountsId: { readonly parameters: { readonly path: { - readonly account: string; - readonly id: string; - }; - }; + readonly account: string + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["deleted_external_account"]; - }; + readonly schema: definitions['deleted_external_account'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

Creates a single-use login link for an Express account to access their Stripe dashboard.

* @@ -12535,29 +12472,29 @@ export interface operations { readonly PostAccountsAccountLoginLinks: { readonly parameters: { readonly path: { - readonly account: string; - }; + readonly account: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description Where to redirect the user after they log out of their dashboard. */ - readonly redirect_url?: string; - }; - }; - }; + readonly redirect_url?: string + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["login_link"]; - }; + readonly schema: definitions['login_link'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

Invalidates all sessions for a light account, for a platform to use during platform logout.

* @@ -12566,74 +12503,74 @@ export interface operations { readonly PutAccountsAccountLogout: { readonly parameters: { readonly path: { - readonly account: string; - }; + readonly account: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["light_account_logout"]; - }; + readonly schema: definitions['light_account_logout'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly GetAccountsAccountPeople: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** Filters on the list of people returned based on the person's relationship to the account's company. */ - readonly relationship?: string; + readonly relationship?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; + readonly starting_after?: string + } readonly path: { - readonly account: string; - }; - }; + readonly account: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["person"][]; + readonly data: readonly definitions['person'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Creates a new person.

*/ readonly PostAccountsAccountPeople: { readonly parameters: { readonly path: { - readonly account: string; - }; + readonly account: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { @@ -12642,83 +12579,83 @@ export interface operations { * @description The person's address. */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ readonly address_kana?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ readonly address_kanji?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** @description The person's date of birth. */ - readonly dob?: unknown; + readonly dob?: unknown /** @description The person's email address. */ - readonly email?: string; + readonly email?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The person's first name. */ - readonly first_name?: string; + readonly first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - readonly first_name_kana?: string; + readonly first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - readonly first_name_kanji?: string; + readonly first_name_kanji?: string /** @description The person's gender (International regulations require either "male" or "female"). */ - readonly gender?: string; + readonly gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/stripe.js#collecting-pii-data). */ - readonly id_number?: string; + readonly id_number?: string /** @description The person's last name. */ - readonly last_name?: string; + readonly last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - readonly last_name_kana?: string; + readonly last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - readonly last_name_kanji?: string; + readonly last_name_kanji?: string /** @description The person's maiden name. */ - readonly maiden_name?: string; + readonly maiden_name?: string /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - readonly person_token?: string; + readonly person_token?: string /** @description The person's phone number. */ - readonly phone?: string; + readonly phone?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ readonly relationship?: { - readonly director?: boolean; - readonly executive?: boolean; - readonly owner?: boolean; - readonly percent_ownership?: unknown; - readonly representative?: boolean; - readonly title?: string; - }; + readonly director?: boolean + readonly executive?: boolean + readonly owner?: boolean + readonly percent_ownership?: unknown + readonly representative?: boolean + readonly title?: string + } /** @description The last 4 digits of the person's social security number. */ - readonly ssn_last_4?: string; + readonly ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -12726,59 +12663,59 @@ export interface operations { readonly verification?: { /** person_verification_document_specs */ readonly additional_document?: { - readonly back?: string; - readonly front?: string; - }; + readonly back?: string + readonly front?: string + } /** person_verification_document_specs */ readonly document?: { - readonly back?: string; - readonly front?: string; - }; - }; - }; - }; - }; + readonly back?: string + readonly front?: string + } + } + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["person"]; - }; + readonly schema: definitions['person'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves an existing person.

*/ readonly GetAccountsAccountPeoplePerson: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly account: string; - readonly person: string; - }; - }; + readonly account: string + readonly person: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["person"]; - }; + readonly schema: definitions['person'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Updates an existing person.

*/ readonly PostAccountsAccountPeoplePerson: { readonly parameters: { readonly path: { - readonly account: string; - readonly person: string; - }; + readonly account: string + readonly person: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { @@ -12787,83 +12724,83 @@ export interface operations { * @description The person's address. */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ readonly address_kana?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ readonly address_kanji?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** @description The person's date of birth. */ - readonly dob?: unknown; + readonly dob?: unknown /** @description The person's email address. */ - readonly email?: string; + readonly email?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The person's first name. */ - readonly first_name?: string; + readonly first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - readonly first_name_kana?: string; + readonly first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - readonly first_name_kanji?: string; + readonly first_name_kanji?: string /** @description The person's gender (International regulations require either "male" or "female"). */ - readonly gender?: string; + readonly gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/stripe.js#collecting-pii-data). */ - readonly id_number?: string; + readonly id_number?: string /** @description The person's last name. */ - readonly last_name?: string; + readonly last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - readonly last_name_kana?: string; + readonly last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - readonly last_name_kanji?: string; + readonly last_name_kanji?: string /** @description The person's maiden name. */ - readonly maiden_name?: string; + readonly maiden_name?: string /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - readonly person_token?: string; + readonly person_token?: string /** @description The person's phone number. */ - readonly phone?: string; + readonly phone?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ readonly relationship?: { - readonly director?: boolean; - readonly executive?: boolean; - readonly owner?: boolean; - readonly percent_ownership?: unknown; - readonly representative?: boolean; - readonly title?: string; - }; + readonly director?: boolean + readonly executive?: boolean + readonly owner?: boolean + readonly percent_ownership?: unknown + readonly representative?: boolean + readonly title?: string + } /** @description The last 4 digits of the person's social security number. */ - readonly ssn_last_4?: string; + readonly ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -12871,95 +12808,95 @@ export interface operations { readonly verification?: { /** person_verification_document_specs */ readonly additional_document?: { - readonly back?: string; - readonly front?: string; - }; + readonly back?: string + readonly front?: string + } /** person_verification_document_specs */ readonly document?: { - readonly back?: string; - readonly front?: string; - }; - }; - }; - }; - }; + readonly back?: string + readonly front?: string + } + } + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["person"]; - }; + readonly schema: definitions['person'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly DeleteAccountsAccountPeoplePerson: { readonly parameters: { readonly path: { - readonly account: string; - readonly person: string; - }; - }; + readonly account: string + readonly person: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["deleted_person"]; - }; + readonly schema: definitions['deleted_person'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly GetAccountsAccountPersons: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** Filters on the list of people returned based on the person's relationship to the account's company. */ - readonly relationship?: string; + readonly relationship?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; + readonly starting_after?: string + } readonly path: { - readonly account: string; - }; - }; + readonly account: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["person"][]; + readonly data: readonly definitions['person'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Creates a new person.

*/ readonly PostAccountsAccountPersons: { readonly parameters: { readonly path: { - readonly account: string; - }; + readonly account: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { @@ -12968,83 +12905,83 @@ export interface operations { * @description The person's address. */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ readonly address_kana?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ readonly address_kanji?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** @description The person's date of birth. */ - readonly dob?: unknown; + readonly dob?: unknown /** @description The person's email address. */ - readonly email?: string; + readonly email?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The person's first name. */ - readonly first_name?: string; + readonly first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - readonly first_name_kana?: string; + readonly first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - readonly first_name_kanji?: string; + readonly first_name_kanji?: string /** @description The person's gender (International regulations require either "male" or "female"). */ - readonly gender?: string; + readonly gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/stripe.js#collecting-pii-data). */ - readonly id_number?: string; + readonly id_number?: string /** @description The person's last name. */ - readonly last_name?: string; + readonly last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - readonly last_name_kana?: string; + readonly last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - readonly last_name_kanji?: string; + readonly last_name_kanji?: string /** @description The person's maiden name. */ - readonly maiden_name?: string; + readonly maiden_name?: string /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - readonly person_token?: string; + readonly person_token?: string /** @description The person's phone number. */ - readonly phone?: string; + readonly phone?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ readonly relationship?: { - readonly director?: boolean; - readonly executive?: boolean; - readonly owner?: boolean; - readonly percent_ownership?: unknown; - readonly representative?: boolean; - readonly title?: string; - }; + readonly director?: boolean + readonly executive?: boolean + readonly owner?: boolean + readonly percent_ownership?: unknown + readonly representative?: boolean + readonly title?: string + } /** @description The last 4 digits of the person's social security number. */ - readonly ssn_last_4?: string; + readonly ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -13052,59 +12989,59 @@ export interface operations { readonly verification?: { /** person_verification_document_specs */ readonly additional_document?: { - readonly back?: string; - readonly front?: string; - }; + readonly back?: string + readonly front?: string + } /** person_verification_document_specs */ readonly document?: { - readonly back?: string; - readonly front?: string; - }; - }; - }; - }; - }; + readonly back?: string + readonly front?: string + } + } + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["person"]; - }; + readonly schema: definitions['person'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves an existing person.

*/ readonly GetAccountsAccountPersonsPerson: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly account: string; - readonly person: string; - }; - }; + readonly account: string + readonly person: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["person"]; - }; + readonly schema: definitions['person'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Updates an existing person.

*/ readonly PostAccountsAccountPersonsPerson: { readonly parameters: { readonly path: { - readonly account: string; - readonly person: string; - }; + readonly account: string + readonly person: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { @@ -13113,83 +13050,83 @@ export interface operations { * @description The person's address. */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ readonly address_kana?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ readonly address_kanji?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** @description The person's date of birth. */ - readonly dob?: unknown; + readonly dob?: unknown /** @description The person's email address. */ - readonly email?: string; + readonly email?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The person's first name. */ - readonly first_name?: string; + readonly first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - readonly first_name_kana?: string; + readonly first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - readonly first_name_kanji?: string; + readonly first_name_kanji?: string /** @description The person's gender (International regulations require either "male" or "female"). */ - readonly gender?: string; + readonly gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/stripe.js#collecting-pii-data). */ - readonly id_number?: string; + readonly id_number?: string /** @description The person's last name. */ - readonly last_name?: string; + readonly last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - readonly last_name_kana?: string; + readonly last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - readonly last_name_kanji?: string; + readonly last_name_kanji?: string /** @description The person's maiden name. */ - readonly maiden_name?: string; + readonly maiden_name?: string /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - readonly person_token?: string; + readonly person_token?: string /** @description The person's phone number. */ - readonly phone?: string; + readonly phone?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ readonly relationship?: { - readonly director?: boolean; - readonly executive?: boolean; - readonly owner?: boolean; - readonly percent_ownership?: unknown; - readonly representative?: boolean; - readonly title?: string; - }; + readonly director?: boolean + readonly executive?: boolean + readonly owner?: boolean + readonly percent_ownership?: unknown + readonly representative?: boolean + readonly title?: string + } /** @description The last 4 digits of the person's social security number. */ - readonly ssn_last_4?: string; + readonly ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -13197,48 +13134,48 @@ export interface operations { readonly verification?: { /** person_verification_document_specs */ readonly additional_document?: { - readonly back?: string; - readonly front?: string; - }; + readonly back?: string + readonly front?: string + } /** person_verification_document_specs */ readonly document?: { - readonly back?: string; - readonly front?: string; - }; - }; - }; - }; - }; + readonly back?: string + readonly front?: string + } + } + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["person"]; - }; + readonly schema: definitions['person'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly DeleteAccountsAccountPersonsPerson: { readonly parameters: { readonly path: { - readonly account: string; - readonly person: string; - }; - }; + readonly account: string + readonly person: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["deleted_person"]; - }; + readonly schema: definitions['deleted_person'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

With Connect, you may flag accounts as suspicious.

* @@ -13247,191 +13184,191 @@ export interface operations { readonly PostAccountsAccountReject: { readonly parameters: { readonly path: { - readonly account: string; - }; + readonly account: string + } readonly body: { /** Body parameters for the request. */ readonly payload: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The reason for rejecting the account. Can be `fraud`, `terms_of_service`, or `other`. */ - readonly reason: string; - }; - }; - }; + readonly reason: string + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["account"]; - }; + readonly schema: definitions['account'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

List apple pay domains.

*/ readonly GetApplePayDomains: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - readonly domain_name?: string; + readonly expand?: readonly unknown[] + readonly domain_name?: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["apple_pay_domain"][]; + readonly data: readonly definitions['apple_pay_domain'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Create an apple pay domain.

*/ readonly PostApplePayDomains: { readonly parameters: { readonly body: { /** Body parameters for the request. */ readonly payload: { - readonly domain_name: string; + readonly domain_name: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["apple_pay_domain"]; - }; + readonly schema: definitions['apple_pay_domain'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieve an apple pay domain.

*/ readonly GetApplePayDomainsDomain: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly domain: string; - }; - }; + readonly domain: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["apple_pay_domain"]; - }; + readonly schema: definitions['apple_pay_domain'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Delete an apple pay domain.

*/ readonly DeleteApplePayDomainsDomain: { readonly parameters: { readonly path: { - readonly domain: string; - }; - }; + readonly domain: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["deleted_apple_pay_domain"]; - }; + readonly schema: definitions['deleted_apple_pay_domain'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly GetApplicationFees: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** Only return application fees for the charge specified by this charge ID. */ - readonly charge?: string; - readonly created?: number; + readonly charge?: string + readonly created?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["application_fee"][]; + readonly data: readonly definitions['application_fee'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly GetApplicationFeesFeeRefundsId: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly fee: string; - readonly id: string; - }; - }; + readonly fee: string + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["fee_refund"]; - }; + readonly schema: definitions['fee_refund'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

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

* @@ -13440,118 +13377,118 @@ export interface operations { readonly PostApplicationFeesFeeRefundsId: { readonly parameters: { readonly path: { - readonly fee: string; - readonly id: string; - }; + readonly fee: string + readonly id: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; - }; - }; - }; + readonly metadata?: unknown + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["fee_refund"]; - }; + readonly schema: definitions['fee_refund'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly GetApplicationFeesId: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["application_fee"]; - }; + readonly schema: definitions['application_fee'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } readonly PostApplicationFeesIdRefund: { readonly parameters: { readonly path: { - readonly id: string; - }; + readonly id: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { - readonly amount?: number; - readonly directive?: string; + readonly amount?: number + readonly directive?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["application_fee"]; - }; + readonly schema: definitions['application_fee'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly GetApplicationFeesIdRefunds: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; + readonly starting_after?: string + } readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { /** @description Details about each object. */ - readonly data: readonly definitions["fee_refund"][]; + readonly data: readonly definitions['fee_refund'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

Refunds an application fee that has previously been collected but not yet refunded. * Funds will be refunded to the Stripe account from which the fee was originally collected.

@@ -13566,31 +13503,31 @@ export interface operations { readonly PostApplicationFeesIdRefunds: { readonly parameters: { readonly path: { - readonly id: string; - }; + readonly id: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description A positive integer, in _%s_, representing how much of this fee to refund. Can refund only up to the remaining unrefunded amount of the fee. */ - readonly amount?: number; + readonly amount?: number /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: { readonly [key: string]: unknown }; - }; - }; - }; + readonly metadata?: { readonly [key: string]: unknown } + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["fee_refund"]; - }; + readonly schema: definitions['fee_refund'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

Retrieves the current account balance, based on the authentication that was used to make the request. * For a sample request, see Accounting for negative balances.

@@ -13599,20 +13536,20 @@ export interface operations { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; - }; + readonly expand?: readonly unknown[] + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["balance"]; - }; + readonly schema: definitions['balance'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

* @@ -13622,47 +13559,47 @@ export interface operations { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - readonly available_on?: number; - readonly created?: number; + readonly expand?: readonly unknown[] + readonly available_on?: number + readonly created?: number /** 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). */ - readonly currency?: string; + readonly currency?: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID. */ - readonly payout?: string; + readonly payout?: string /** Only returns the original transaction. */ - readonly source?: string; + readonly source?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** Only returns transactions of the given type. One of: `charge`, `refund`, `adjustment`, `application_fee`, `application_fee_refund`, `transfer`, `payment`, `payout`, `payout_failure`, `stripe_fee`, or `network_cost`. */ - readonly type?: string; - }; - }; + readonly type?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["balance_transaction"][]; + readonly data: readonly definitions['balance_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

Retrieves the balance transaction with the given ID.

* @@ -13672,23 +13609,23 @@ export interface operations { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["balance_transaction"]; - }; + readonly schema: definitions['balance_transaction'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

* @@ -13698,47 +13635,47 @@ export interface operations { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - readonly available_on?: number; - readonly created?: number; + readonly expand?: readonly unknown[] + readonly available_on?: number + readonly created?: number /** 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). */ - readonly currency?: string; + readonly currency?: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID. */ - readonly payout?: string; + readonly payout?: string /** Only returns the original transaction. */ - readonly source?: string; + readonly source?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** Only returns transactions of the given type. One of: `charge`, `refund`, `adjustment`, `application_fee`, `application_fee_refund`, `transfer`, `payment`, `payout`, `payout_failure`, `stripe_fee`, or `network_cost`. */ - readonly type?: string; - }; - }; + readonly type?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["balance_transaction"][]; + readonly data: readonly definitions['balance_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

Retrieves the balance transaction with the given ID.

* @@ -13748,23 +13685,23 @@ export interface operations { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["balance_transaction"]; - }; + readonly schema: definitions['balance_transaction'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Creates a session of the self-serve Portal.

*/ readonly PostBillingPortalSessions: { readonly parameters: { @@ -13772,214 +13709,214 @@ export interface operations { /** Body parameters for the request. */ readonly payload: { /** @description The ID of an existing customer. */ - readonly customer: string; + readonly customer: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The URL to which Stripe should send customers when they click on the link to return to your website. This field is required if a default return URL has not been configured for the portal. */ - readonly return_url?: string; - }; - }; - }; + readonly return_url?: string + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["billing_portal.session"]; - }; + readonly schema: definitions['billing_portal.session'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly GetBitcoinReceivers: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** Filter for active receivers. */ - readonly active?: boolean; + readonly active?: boolean /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Filter for filled receivers. */ - readonly filled?: boolean; + readonly filled?: boolean /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** Filter for receivers with uncaptured funds. */ - readonly uncaptured_funds?: boolean; - }; - }; + readonly uncaptured_funds?: boolean + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["bitcoin_receiver"][]; + readonly data: readonly definitions['bitcoin_receiver'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves the Bitcoin receiver with the given ID.

*/ readonly GetBitcoinReceiversId: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["bitcoin_receiver"]; - }; + readonly schema: definitions['bitcoin_receiver'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

List bitcoin transacitons for a given receiver.

*/ readonly GetBitcoinReceiversReceiverTransactions: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** Only return transactions for the customer specified by this customer ID. */ - readonly customer?: string; + readonly customer?: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; + readonly starting_after?: string + } readonly path: { - readonly receiver: string; - }; - }; + readonly receiver: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { /** @description Details about each object. */ - readonly data: readonly definitions["bitcoin_transaction"][]; + readonly data: readonly definitions['bitcoin_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

List bitcoin transacitons for a given receiver.

*/ readonly GetBitcoinTransactions: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** Only return transactions for the customer specified by this customer ID. */ - readonly customer?: string; + readonly customer?: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; - readonly receiver?: string; + readonly limit?: number + readonly receiver?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { /** @description Details about each object. */ - readonly data: readonly definitions["bitcoin_transaction"][]; + readonly data: readonly definitions['bitcoin_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly GetCharges: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - readonly created?: number; + readonly expand?: readonly unknown[] + readonly created?: number /** Only return charges for the customer specified by this customer ID. */ - readonly customer?: string; + readonly customer?: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** Only return charges that were created by the PaymentIntent specified by this PaymentIntent ID. */ - readonly payment_intent?: string; + readonly payment_intent?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** Only return charges for this transfer group. */ - readonly transfer_group?: string; - }; - }; + readonly transfer_group?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["charge"][]; + readonly data: readonly definitions['charge'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

To charge a credit card or other payment source, you create a Charge object. If your API key is in test mode, the supplied payment source (e.g., card) won’t actually be charged, although everything else will occur as if in live mode. (Stripe assumes that the charge would have completed successfully).

*/ readonly PostCharges: { readonly parameters: { @@ -13987,33 +13924,33 @@ export interface operations { /** Body parameters for the request. */ readonly payload?: { /** @description 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). */ - readonly amount?: number; - readonly application_fee?: number; + readonly amount?: number + readonly application_fee?: number /** @description A fee in %s that will be applied to the charge and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the `Stripe-Account` header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees). */ - readonly application_fee_amount?: number; + readonly application_fee_amount?: number /** @description Whether to immediately capture the charge. Defaults to `true`. When `false`, the charge issues an authorization (or pre-authorization), and will need to be [captured](https://stripe.com/docs/api#capture_charge) later. Uncaptured charges expire in _seven days_. For more information, see the [authorizing charges and settling later](https://stripe.com/docs/charges/placing-a-hold) documentation. */ - readonly capture?: boolean; + readonly capture?: boolean /** @description A token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js). */ - readonly card?: unknown; + readonly card?: unknown /** @description 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). */ - readonly currency?: string; + readonly currency?: string /** @description The ID of an existing customer that will be charged in this request. */ - readonly customer?: string; + readonly customer?: string /** @description An arbitrary string which you can attach to a `Charge` object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the `description` of the charge(s) that they are describing. */ - readonly description?: string; + readonly description?: string /** destination_specs */ readonly destination?: { - readonly account: string; - readonly amount?: number; - }; + readonly account: string + readonly amount?: number + } /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description The Stripe account ID for which these funds are intended. Automatically set if you use the `destination` parameter. For details, see [Creating Separate Charges and Transfers](https://stripe.com/docs/connect/charges-transfers#on-behalf-of). */ - readonly on_behalf_of?: string; + readonly on_behalf_of?: string /** @description The email address to which this charge's [receipt](https://stripe.com/docs/dashboard/receipts) will be sent. The receipt will not be sent until the charge is paid, and no receipts will be sent for test mode charges. If this charge is for a [Customer](https://stripe.com/docs/api/customers/object), the email address specified here will override the customer's email address. If `receipt_email` is specified for a charge in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails). */ - readonly receipt_email?: string; + readonly receipt_email?: string /** * shipping * @description Shipping information for the charge. Helps prevent fraud on charges for physical goods. @@ -14021,97 +13958,97 @@ export interface operations { readonly shipping?: { /** address */ readonly address: { - readonly city?: string; - readonly country?: string; - readonly line1: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; - readonly carrier?: string; - readonly name: string; - readonly phone?: string; - readonly tracking_number?: string; - }; + readonly city?: string + readonly country?: string + readonly line1: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } + readonly carrier?: string + readonly name: string + readonly phone?: string + readonly tracking_number?: string + } /** @description A payment source to be charged. This can be the ID of a [card](https://stripe.com/docs/api#cards) (i.e., credit or debit card), a [bank account](https://stripe.com/docs/api#bank_accounts), a [source](https://stripe.com/docs/api#sources), a [token](https://stripe.com/docs/api#tokens), or a [connected account](https://stripe.com/docs/connect/account-debits#charging-a-connected-account). For certain sources---namely, [cards](https://stripe.com/docs/api#cards), [bank accounts](https://stripe.com/docs/api#bank_accounts), and attached [sources](https://stripe.com/docs/api#sources)---you must also pass the ID of the associated customer. */ - readonly source?: string; + readonly source?: string /** @description For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - readonly statement_descriptor?: string; + readonly statement_descriptor?: string /** @description Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - readonly statement_descriptor_suffix?: string; + readonly statement_descriptor_suffix?: string /** * transfer_data_specs * @description 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. */ readonly transfer_data?: { - readonly amount?: number; - readonly destination: string; - }; + readonly amount?: number + readonly destination: string + } /** @description A string that identifies this transaction as part of a group. For details, see [Grouping transactions](https://stripe.com/docs/connect/charges-transfers#transfer-options). */ - readonly transfer_group?: string; - }; - }; - }; + readonly transfer_group?: string + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["charge"]; - }; + readonly schema: definitions['charge'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly GetChargesCharge: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly charge: string; - }; - }; + readonly charge: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["charge"]; - }; + readonly schema: definitions['charge'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly PostChargesCharge: { readonly parameters: { readonly path: { - readonly charge: string; - }; + readonly charge: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description The ID of an existing customer that will be associated with this request. This field may only be updated if there is no existing associated customer with this charge. */ - readonly customer?: string; + readonly customer?: string /** @description An arbitrary string which you can attach to a charge object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the `description` of the charge(s) that they are describing. */ - readonly description?: string; + readonly description?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** * fraud_details * @description A set of key-value pairs you can attach to a charge giving information about its riskiness. If you believe a charge is fraudulent, include a `user_report` key with a value of `fraudulent`. If you believe a charge is safe, include a `user_report` key with a value of `safe`. Stripe will use the information you send to improve our fraud detection algorithms. */ readonly fraud_details?: { /** @enum {string} */ - readonly user_report: "" | "fraudulent" | "safe"; - }; + readonly user_report: '' | 'fraudulent' | 'safe' + } /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description This is the email address that the receipt for this charge will be sent to. If this field is updated, then a new email receipt will be sent to the updated address. */ - readonly receipt_email?: string; + readonly receipt_email?: string /** * shipping * @description Shipping information for the charge. Helps prevent fraud on charges for physical goods. @@ -14119,34 +14056,34 @@ export interface operations { readonly shipping?: { /** address */ readonly address: { - readonly city?: string; - readonly country?: string; - readonly line1: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; - readonly carrier?: string; - readonly name: string; - readonly phone?: string; - readonly tracking_number?: string; - }; + readonly city?: string + readonly country?: string + readonly line1: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } + readonly carrier?: string + readonly name: string + readonly phone?: string + readonly tracking_number?: string + } /** @description A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-options) for details. */ - readonly transfer_group?: string; - }; - }; - }; + readonly transfer_group?: string + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["charge"]; - }; + readonly schema: definitions['charge'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

Capture the payment of an existing, uncaptured, charge. This is the second half of the two-step payment flow, where first you created a charge with the capture option set to false.

* @@ -14155,75 +14092,75 @@ export interface operations { readonly PostChargesChargeCapture: { readonly parameters: { readonly path: { - readonly charge: string; - }; + readonly charge: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description The amount to capture, which must be less than or equal to the original amount. Any additional amount will be automatically refunded. */ - readonly amount?: number; + readonly amount?: number /** @description An application fee to add on to this charge. */ - readonly application_fee?: number; + readonly application_fee?: number /** @description An application fee amount to add on to this charge, which must be less than or equal to the original amount. */ - readonly application_fee_amount?: number; + readonly application_fee_amount?: number /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The email address to send this charge's receipt to. This will override the previously-specified email address for this charge, if one was set. Receipts will not be sent in test mode. */ - readonly receipt_email?: string; + readonly receipt_email?: string /** @description For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - readonly statement_descriptor?: string; + readonly statement_descriptor?: string /** @description Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - readonly statement_descriptor_suffix?: string; + readonly statement_descriptor_suffix?: string /** * transfer_data_specs * @description 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. */ readonly transfer_data?: { - readonly amount?: number; - }; + readonly amount?: number + } /** @description A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-options) for details. */ - readonly transfer_group?: string; - }; - }; - }; + readonly transfer_group?: string + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["charge"]; - }; + readonly schema: definitions['charge'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieve a dispute for a specified charge.

*/ readonly GetChargesChargeDispute: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly charge: string; - }; - }; + readonly charge: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["dispute"]; - }; + readonly schema: definitions['dispute'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } readonly PostChargesChargeDispute: { readonly parameters: { readonly path: { - readonly charge: string; - }; + readonly charge: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { @@ -14232,78 +14169,78 @@ export interface operations { * @description Evidence to upload, to respond to a dispute. Updating any field in the hash will submit all fields in the hash for review. The combined character count of all fields is limited to 150,000. */ readonly evidence?: { - readonly access_activity_log?: string; - readonly billing_address?: string; - readonly cancellation_policy?: string; - readonly cancellation_policy_disclosure?: string; - readonly cancellation_rebuttal?: string; - readonly customer_communication?: string; - readonly customer_email_address?: string; - readonly customer_name?: string; - readonly customer_purchase_ip?: string; - readonly customer_signature?: string; - readonly duplicate_charge_documentation?: string; - readonly duplicate_charge_explanation?: string; - readonly duplicate_charge_id?: string; - readonly product_description?: string; - readonly receipt?: string; - readonly refund_policy?: string; - readonly refund_policy_disclosure?: string; - readonly refund_refusal_explanation?: string; - readonly service_date?: string; - readonly service_documentation?: string; - readonly shipping_address?: string; - readonly shipping_carrier?: string; - readonly shipping_date?: string; - readonly shipping_documentation?: string; - readonly shipping_tracking_number?: string; - readonly uncategorized_file?: string; - readonly uncategorized_text?: string; - }; + readonly access_activity_log?: string + readonly billing_address?: string + readonly cancellation_policy?: string + readonly cancellation_policy_disclosure?: string + readonly cancellation_rebuttal?: string + readonly customer_communication?: string + readonly customer_email_address?: string + readonly customer_name?: string + readonly customer_purchase_ip?: string + readonly customer_signature?: string + readonly duplicate_charge_documentation?: string + readonly duplicate_charge_explanation?: string + readonly duplicate_charge_id?: string + readonly product_description?: string + readonly receipt?: string + readonly refund_policy?: string + readonly refund_policy_disclosure?: string + readonly refund_refusal_explanation?: string + readonly service_date?: string + readonly service_documentation?: string + readonly shipping_address?: string + readonly shipping_carrier?: string + readonly shipping_date?: string + readonly shipping_documentation?: string + readonly shipping_tracking_number?: string + readonly uncategorized_file?: string + readonly uncategorized_text?: string + } /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description Whether to immediately submit evidence to the bank. If `false`, evidence is staged on the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank by making another request with this attribute set to `true` (the default). */ - readonly submit?: boolean; - }; - }; - }; + readonly submit?: boolean + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["dispute"]; - }; + readonly schema: definitions['dispute'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } readonly PostChargesChargeDisputeClose: { readonly parameters: { readonly path: { - readonly charge: string; - }; + readonly charge: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["dispute"]; - }; + readonly schema: definitions['dispute'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.

* @@ -14320,197 +14257,197 @@ export interface operations { readonly PostChargesChargeRefund: { readonly parameters: { readonly path: { - readonly charge: string; - }; + readonly charge: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { - readonly amount?: number; + readonly amount?: number /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - readonly metadata?: unknown; - readonly payment_intent?: string; + readonly expand?: readonly string[] + readonly metadata?: unknown + readonly payment_intent?: string /** @enum {string} */ - readonly reason?: "duplicate" | "fraudulent" | "requested_by_customer"; - readonly refund_application_fee?: boolean; - readonly reverse_transfer?: boolean; - }; - }; - }; + readonly reason?: 'duplicate' | 'fraudulent' | 'requested_by_customer' + readonly refund_application_fee?: boolean + readonly reverse_transfer?: boolean + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["charge"]; - }; + readonly schema: definitions['charge'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly GetChargesChargeRefunds: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; + readonly starting_after?: string + } readonly path: { - readonly charge: string; - }; - }; + readonly charge: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { /** @description Details about each object. */ - readonly data: readonly definitions["refund"][]; + readonly data: readonly definitions['refund'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Create a refund.

*/ readonly PostChargesChargeRefunds: { readonly parameters: { readonly path: { - readonly charge: string; - }; + readonly charge: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { - readonly amount?: number; + readonly amount?: number /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: { readonly [key: string]: unknown }; - readonly payment_intent?: string; + readonly metadata?: { readonly [key: string]: unknown } + readonly payment_intent?: string /** @enum {string} */ - readonly reason?: "duplicate" | "fraudulent" | "requested_by_customer"; - readonly refund_application_fee?: boolean; - readonly reverse_transfer?: boolean; - }; - }; - }; + readonly reason?: 'duplicate' | 'fraudulent' | 'requested_by_customer' + readonly refund_application_fee?: boolean + readonly reverse_transfer?: boolean + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["refund"]; - }; + readonly schema: definitions['refund'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves the details of an existing refund.

*/ readonly GetChargesChargeRefundsRefund: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly charge: string; - readonly refund: string; - }; - }; + readonly charge: string + readonly refund: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["refund"]; - }; + readonly schema: definitions['refund'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Update a specified refund.

*/ readonly PostChargesChargeRefundsRefund: { readonly parameters: { readonly path: { - readonly charge: string; - readonly refund: string; - }; + readonly charge: string + readonly refund: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - readonly metadata?: unknown; - }; - }; - }; + readonly expand?: readonly string[] + readonly metadata?: unknown + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["refund"]; - }; + readonly schema: definitions['refund'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Returns a list of Checkout Sessions.

*/ readonly GetCheckoutSessions: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** Only return the Checkout Session for the PaymentIntent specified. */ - readonly payment_intent?: string; + readonly payment_intent?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** Only return the Checkout Session for the subscription specified. */ - readonly subscription?: string; - }; - }; + readonly subscription?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["checkout.session"][]; + readonly data: readonly definitions['checkout.session'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Creates a Session object.

*/ readonly PostCheckoutSessions: { readonly parameters: { @@ -14521,15 +14458,15 @@ export interface operations { * @description Specify whether Checkout should collect the customer's billing address. * @enum {string} */ - readonly billing_address_collection?: "auto" | "required"; + readonly billing_address_collection?: 'auto' | 'required' /** @description The URL the customer will be directed to if they decide to cancel payment and return to your website. */ - readonly cancel_url: string; + readonly cancel_url: string /** * @description A unique string to reference the Checkout Session. This can be a * customer ID, a cart ID, or similar, and can be used to reconcile the * session with your internal systems. */ - readonly client_reference_id?: string; + readonly client_reference_id?: string /** * @description ID of an existing customer, if one exists. The email stored on the * customer will be used to prefill the email field on the Checkout page. @@ -14539,7 +14476,7 @@ export interface operations { * Checkout will create a new customer object based on information * provided during the session. */ - readonly customer?: string; + readonly customer?: string /** * @description 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. @@ -14547,346 +14484,329 @@ export interface operations { * on file. To access information about the customer once a session is * complete, use the `customer` field. */ - readonly customer_email?: string; + readonly customer_email?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** * @description A list of items the customer is purchasing. Use this parameter for * one-time payments or adding invoice line items to a subscription (used * in conjunction with `subscription_data`). */ readonly line_items?: readonly { - readonly amount?: number; - readonly currency?: string; - readonly description?: string; - readonly images?: readonly string[]; - readonly name?: string; - readonly quantity: number; - readonly tax_rates?: readonly string[]; - }[]; + readonly amount?: number + readonly currency?: string + readonly description?: string + readonly images?: readonly string[] + readonly name?: string + readonly quantity: number + readonly tax_rates?: readonly string[] + }[] /** * @description The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used. * @enum {string} */ - readonly locale?: - | "auto" - | "da" - | "de" - | "en" - | "es" - | "fi" - | "fr" - | "it" - | "ja" - | "ms" - | "nb" - | "nl" - | "pl" - | "pt" - | "pt-BR" - | "sv" - | "zh"; + readonly locale?: 'auto' | 'da' | 'de' | 'en' | 'es' | 'fi' | 'fr' | 'it' | 'ja' | 'ms' | 'nb' | 'nl' | 'pl' | 'pt' | 'pt-BR' | 'sv' | 'zh' /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: { readonly [key: string]: unknown }; + readonly metadata?: { readonly [key: string]: unknown } /** * @description The mode of the Checkout Session, one of `payment`, `setup`, or `subscription`. * @enum {string} */ - readonly mode?: "payment" | "setup" | "subscription"; + readonly mode?: 'payment' | 'setup' | 'subscription' /** * payment_intent_data_params * @description A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode. */ readonly payment_intent_data?: { - readonly application_fee_amount?: number; + readonly application_fee_amount?: number /** @enum {string} */ - readonly capture_method?: "automatic" | "manual"; - readonly description?: string; - readonly metadata?: { readonly [key: string]: unknown }; - readonly on_behalf_of?: string; - readonly receipt_email?: string; + readonly capture_method?: 'automatic' | 'manual' + readonly description?: string + readonly metadata?: { readonly [key: string]: unknown } + readonly on_behalf_of?: string + readonly receipt_email?: string /** @enum {string} */ - readonly setup_future_usage?: "off_session" | "on_session"; + readonly setup_future_usage?: 'off_session' | 'on_session' /** shipping */ readonly shipping?: { /** address */ readonly address: { - readonly city?: string; - readonly country?: string; - readonly line1: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; - readonly carrier?: string; - readonly name: string; - readonly phone?: string; - readonly tracking_number?: string; - }; - readonly statement_descriptor?: string; - readonly statement_descriptor_suffix?: string; + readonly city?: string + readonly country?: string + readonly line1: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } + readonly carrier?: string + readonly name: string + readonly phone?: string + readonly tracking_number?: string + } + readonly statement_descriptor?: string + readonly statement_descriptor_suffix?: string /** transfer_data_params */ readonly transfer_data?: { - readonly amount?: number; - readonly destination: string; - }; - }; + readonly amount?: number + readonly destination: string + } + } /** @description A list of the types of payment methods (e.g., card) this Checkout session can accept. */ - readonly payment_method_types: readonly ("card" | "fpx" | "ideal")[]; + readonly payment_method_types: readonly ('card' | 'fpx' | 'ideal')[] /** * setup_intent_data_param * @description A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in `setup` mode. */ readonly setup_intent_data?: { - readonly description?: string; - readonly metadata?: { readonly [key: string]: unknown }; - readonly on_behalf_of?: string; - }; + readonly description?: string + readonly metadata?: { readonly [key: string]: unknown } + readonly on_behalf_of?: string + } /** * shipping_address_collection_params * @description When set, provides configuration for Checkout to collect a shipping address from a customer. */ readonly shipping_address_collection?: { readonly allowed_countries: readonly ( - | "AC" - | "AD" - | "AE" - | "AF" - | "AG" - | "AI" - | "AL" - | "AM" - | "AO" - | "AQ" - | "AR" - | "AT" - | "AU" - | "AW" - | "AX" - | "AZ" - | "BA" - | "BB" - | "BD" - | "BE" - | "BF" - | "BG" - | "BH" - | "BI" - | "BJ" - | "BL" - | "BM" - | "BN" - | "BO" - | "BQ" - | "BR" - | "BS" - | "BT" - | "BV" - | "BW" - | "BY" - | "BZ" - | "CA" - | "CD" - | "CF" - | "CG" - | "CH" - | "CI" - | "CK" - | "CL" - | "CM" - | "CN" - | "CO" - | "CR" - | "CV" - | "CW" - | "CY" - | "CZ" - | "DE" - | "DJ" - | "DK" - | "DM" - | "DO" - | "DZ" - | "EC" - | "EE" - | "EG" - | "EH" - | "ER" - | "ES" - | "ET" - | "FI" - | "FJ" - | "FK" - | "FO" - | "FR" - | "GA" - | "GB" - | "GD" - | "GE" - | "GF" - | "GG" - | "GH" - | "GI" - | "GL" - | "GM" - | "GN" - | "GP" - | "GQ" - | "GR" - | "GS" - | "GT" - | "GU" - | "GW" - | "GY" - | "HK" - | "HN" - | "HR" - | "HT" - | "HU" - | "ID" - | "IE" - | "IL" - | "IM" - | "IN" - | "IO" - | "IQ" - | "IS" - | "IT" - | "JE" - | "JM" - | "JO" - | "JP" - | "KE" - | "KG" - | "KH" - | "KI" - | "KM" - | "KN" - | "KR" - | "KW" - | "KY" - | "KZ" - | "LA" - | "LB" - | "LC" - | "LI" - | "LK" - | "LR" - | "LS" - | "LT" - | "LU" - | "LV" - | "LY" - | "MA" - | "MC" - | "MD" - | "ME" - | "MF" - | "MG" - | "MK" - | "ML" - | "MM" - | "MN" - | "MO" - | "MQ" - | "MR" - | "MS" - | "MT" - | "MU" - | "MV" - | "MW" - | "MX" - | "MY" - | "MZ" - | "NA" - | "NC" - | "NE" - | "NG" - | "NI" - | "NL" - | "NO" - | "NP" - | "NR" - | "NU" - | "NZ" - | "OM" - | "PA" - | "PE" - | "PF" - | "PG" - | "PH" - | "PK" - | "PL" - | "PM" - | "PN" - | "PR" - | "PS" - | "PT" - | "PY" - | "QA" - | "RE" - | "RO" - | "RS" - | "RU" - | "RW" - | "SA" - | "SB" - | "SC" - | "SE" - | "SG" - | "SH" - | "SI" - | "SJ" - | "SK" - | "SL" - | "SM" - | "SN" - | "SO" - | "SR" - | "SS" - | "ST" - | "SV" - | "SX" - | "SZ" - | "TA" - | "TC" - | "TD" - | "TF" - | "TG" - | "TH" - | "TJ" - | "TK" - | "TL" - | "TM" - | "TN" - | "TO" - | "TR" - | "TT" - | "TV" - | "TW" - | "TZ" - | "UA" - | "UG" - | "US" - | "UY" - | "UZ" - | "VA" - | "VC" - | "VE" - | "VG" - | "VN" - | "VU" - | "WF" - | "WS" - | "XK" - | "YE" - | "YT" - | "ZA" - | "ZM" - | "ZW" - | "ZZ" - )[]; - }; + | 'AC' + | 'AD' + | 'AE' + | 'AF' + | 'AG' + | 'AI' + | 'AL' + | 'AM' + | 'AO' + | 'AQ' + | 'AR' + | 'AT' + | 'AU' + | 'AW' + | 'AX' + | 'AZ' + | 'BA' + | 'BB' + | 'BD' + | 'BE' + | 'BF' + | 'BG' + | 'BH' + | 'BI' + | 'BJ' + | 'BL' + | 'BM' + | 'BN' + | 'BO' + | 'BQ' + | 'BR' + | 'BS' + | 'BT' + | 'BV' + | 'BW' + | 'BY' + | 'BZ' + | 'CA' + | 'CD' + | 'CF' + | 'CG' + | 'CH' + | 'CI' + | 'CK' + | 'CL' + | 'CM' + | 'CN' + | 'CO' + | 'CR' + | 'CV' + | 'CW' + | 'CY' + | 'CZ' + | 'DE' + | 'DJ' + | 'DK' + | 'DM' + | 'DO' + | 'DZ' + | 'EC' + | 'EE' + | 'EG' + | 'EH' + | 'ER' + | 'ES' + | 'ET' + | 'FI' + | 'FJ' + | 'FK' + | 'FO' + | 'FR' + | 'GA' + | 'GB' + | 'GD' + | 'GE' + | 'GF' + | 'GG' + | 'GH' + | 'GI' + | 'GL' + | 'GM' + | 'GN' + | 'GP' + | 'GQ' + | 'GR' + | 'GS' + | 'GT' + | 'GU' + | 'GW' + | 'GY' + | 'HK' + | 'HN' + | 'HR' + | 'HT' + | 'HU' + | 'ID' + | 'IE' + | 'IL' + | 'IM' + | 'IN' + | 'IO' + | 'IQ' + | 'IS' + | 'IT' + | 'JE' + | 'JM' + | 'JO' + | 'JP' + | 'KE' + | 'KG' + | 'KH' + | 'KI' + | 'KM' + | 'KN' + | 'KR' + | 'KW' + | 'KY' + | 'KZ' + | 'LA' + | 'LB' + | 'LC' + | 'LI' + | 'LK' + | 'LR' + | 'LS' + | 'LT' + | 'LU' + | 'LV' + | 'LY' + | 'MA' + | 'MC' + | 'MD' + | 'ME' + | 'MF' + | 'MG' + | 'MK' + | 'ML' + | 'MM' + | 'MN' + | 'MO' + | 'MQ' + | 'MR' + | 'MS' + | 'MT' + | 'MU' + | 'MV' + | 'MW' + | 'MX' + | 'MY' + | 'MZ' + | 'NA' + | 'NC' + | 'NE' + | 'NG' + | 'NI' + | 'NL' + | 'NO' + | 'NP' + | 'NR' + | 'NU' + | 'NZ' + | 'OM' + | 'PA' + | 'PE' + | 'PF' + | 'PG' + | 'PH' + | 'PK' + | 'PL' + | 'PM' + | 'PN' + | 'PR' + | 'PS' + | 'PT' + | 'PY' + | 'QA' + | 'RE' + | 'RO' + | 'RS' + | 'RU' + | 'RW' + | 'SA' + | 'SB' + | 'SC' + | 'SE' + | 'SG' + | 'SH' + | 'SI' + | 'SJ' + | 'SK' + | 'SL' + | 'SM' + | 'SN' + | 'SO' + | 'SR' + | 'SS' + | 'ST' + | 'SV' + | 'SX' + | 'SZ' + | 'TA' + | 'TC' + | 'TD' + | 'TF' + | 'TG' + | 'TH' + | 'TJ' + | 'TK' + | 'TL' + | 'TM' + | 'TN' + | 'TO' + | 'TR' + | 'TT' + | 'TV' + | 'TW' + | 'TZ' + | 'UA' + | 'UG' + | 'US' + | 'UY' + | 'UZ' + | 'VA' + | 'VC' + | 'VE' + | 'VG' + | 'VN' + | 'VU' + | 'WF' + | 'WS' + | 'XK' + | 'YE' + | 'YT' + | 'ZA' + | 'ZM' + | 'ZW' + | 'ZZ' + )[] + } /** * @description Describes the type of transaction being performed by Checkout in order to customize * relevant text on the page, such as the submit button. `submit_type` can only be @@ -14894,25 +14814,25 @@ export interface operations { * in `subscription` or `setup` mode. * @enum {string} */ - readonly submit_type?: "auto" | "book" | "donate" | "pay"; + readonly submit_type?: 'auto' | 'book' | 'donate' | 'pay' /** * subscription_data_params * @description A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode. */ readonly subscription_data?: { - readonly application_fee_percent?: number; - readonly coupon?: string; - readonly default_tax_rates?: readonly string[]; + readonly application_fee_percent?: number + readonly coupon?: string + readonly default_tax_rates?: readonly string[] readonly items?: readonly { - readonly plan: string; - readonly quantity?: number; - readonly tax_rates?: readonly string[]; - }[]; - readonly metadata?: { readonly [key: string]: unknown }; - readonly trial_end?: number; - readonly trial_from_plan?: boolean; - readonly trial_period_days?: number; - }; + readonly plan: string + readonly quantity?: number + readonly tax_rates?: readonly string[] + }[] + readonly metadata?: { readonly [key: string]: unknown } + readonly trial_end?: number + readonly trial_from_plan?: boolean + readonly trial_period_days?: number + } /** * @description The URL to which Stripe should send customers when payment or setup * is complete. @@ -14920,139 +14840,139 @@ export interface operations { * payment, read more about it in our guide on [fulfilling your payments * with webhooks](/docs/payments/checkout/fulfillment#webhooks). */ - readonly success_url: string; - }; - }; - }; + readonly success_url: string + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["checkout.session"]; - }; + readonly schema: definitions['checkout.session'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves a Session object.

*/ readonly GetCheckoutSessionsSession: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly session: string; - }; - }; + readonly session: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["checkout.session"]; - }; + readonly schema: definitions['checkout.session'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Lists all Country Spec objects available in the API.

*/ readonly GetCountrySpecs: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["country_spec"][]; + readonly data: readonly definitions['country_spec'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Returns a Country Spec for a given Country code.

*/ readonly GetCountrySpecsCountry: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly country: string; - }; - }; + readonly country: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["country_spec"]; - }; + readonly schema: definitions['country_spec'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Returns a list of your coupons.

*/ readonly GetCoupons: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** 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. */ - readonly created?: number; + readonly created?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["coupon"][]; + readonly data: readonly definitions['coupon'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

You can create coupons easily via the coupon management page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.

* @@ -15064,153 +14984,153 @@ export interface operations { /** Body parameters for the request. */ readonly payload: { /** @description A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed). */ - readonly amount_off?: number; + readonly amount_off?: number /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed). */ - readonly currency?: string; + readonly currency?: string /** * @description Specifies how long the discount will be in effect. Can be `forever`, `once`, or `repeating`. * @enum {string} */ - readonly duration: "forever" | "once" | "repeating"; + readonly duration: 'forever' | 'once' | 'repeating' /** @description Required only if `duration` is `repeating`, in which case it must be a positive integer that specifies the number of months the discount will be in effect. */ - readonly duration_in_months?: number; + readonly duration_in_months?: number /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description Unique string of your choice that will be used to identify this coupon when applying it to a customer. This is often a specific code you'll give to your customer to use when signing up (e.g., `FALL25OFF`). If you don't want to specify a particular code, you can leave the ID blank and we'll generate a random code for you. */ - readonly id?: string; + readonly id?: string /** @description A positive integer specifying the number of times the coupon can be redeemed before it's no longer valid. For example, you might have a 50% off coupon that the first 20 readers of your blog can use. */ - readonly max_redemptions?: number; + readonly max_redemptions?: number /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set. */ - readonly name?: string; + readonly name?: string /** @description A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if `amount_off` is not passed). */ - readonly percent_off?: number; + readonly percent_off?: number /** @description Unix timestamp specifying the last time at which the coupon can be redeemed. After the redeem_by date, the coupon can no longer be applied to new customers. */ - readonly redeem_by?: number; - }; - }; - }; + readonly redeem_by?: number + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["coupon"]; - }; + readonly schema: definitions['coupon'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves the coupon with the given ID.

*/ readonly GetCouponsCoupon: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly coupon: string; - }; - }; + readonly coupon: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["coupon"]; - }; + readonly schema: definitions['coupon'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly PostCouponsCoupon: { readonly parameters: { readonly path: { - readonly coupon: string; - }; + readonly coupon: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set. */ - readonly name?: string; - }; - }; - }; + readonly name?: string + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["coupon"]; - }; + readonly schema: definitions['coupon'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly DeleteCouponsCoupon: { readonly parameters: { readonly path: { - readonly coupon: string; - }; - }; + readonly coupon: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["deleted_coupon"]; - }; + readonly schema: definitions['deleted_coupon'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Returns a list of credit notes.

*/ readonly GetCreditNotes: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** Only return credit notes for the customer specified by this customer ID. */ - readonly customer?: string; + readonly customer?: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** Only return credit notes for the invoice specified by this invoice ID. */ - readonly invoice?: string; + readonly invoice?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["credit_note"][]; + readonly data: readonly definitions['credit_note'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces * its amount_due. For a status=paid invoice, a credit note does not affect its amount_due. Instead, it can result @@ -15233,305 +15153,305 @@ export interface operations { /** Body parameters for the request. */ readonly payload: { /** @description The integer amount in **%s** representing the total amount of the credit note. */ - readonly amount?: number; + readonly amount?: number /** @description The integer amount in **%s** representing the amount to credit the customer's balance, which will be automatically applied to their next invoice. */ - readonly credit_amount?: number; + readonly credit_amount?: number /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description ID of the invoice. */ - readonly invoice: string; + readonly invoice: string /** @description Line items that make up the credit note. */ readonly lines?: readonly { - readonly amount?: number; - readonly description?: string; - readonly invoice_line_item?: string; - readonly quantity?: number; - readonly tax_rates?: readonly string[]; + readonly amount?: number + readonly description?: string + readonly invoice_line_item?: string + readonly quantity?: number + readonly tax_rates?: readonly string[] /** @enum {string} */ - readonly type: "custom_line_item" | "invoice_line_item"; - readonly unit_amount?: number; - readonly unit_amount_decimal?: string; - }[]; + readonly type: 'custom_line_item' | 'invoice_line_item' + readonly unit_amount?: number + readonly unit_amount_decimal?: string + }[] /** @description The credit note's memo appears on the credit note PDF. */ - readonly memo?: string; + readonly memo?: string /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: { readonly [key: string]: unknown }; + readonly metadata?: { readonly [key: string]: unknown } /** @description The integer amount in **%s** representing the amount that is credited outside of Stripe. */ - readonly out_of_band_amount?: number; + readonly out_of_band_amount?: number /** * @description Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` * @enum {string} */ - readonly reason?: "duplicate" | "fraudulent" | "order_change" | "product_unsatisfactory"; + readonly reason?: 'duplicate' | 'fraudulent' | 'order_change' | 'product_unsatisfactory' /** @description ID of an existing refund to link this credit note to. */ - readonly refund?: string; + readonly refund?: string /** @description The integer amount in **%s** representing the amount to refund. If set, a refund will be created for the charge associated with the invoice. */ - readonly refund_amount?: number; - }; - }; - }; + readonly refund_amount?: number + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["credit_note"]; - }; + readonly schema: definitions['credit_note'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Get a preview of a credit note without creating it.

*/ readonly GetCreditNotesPreview: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** The integer amount in **%s** representing the total amount of the credit note. */ - readonly amount?: number; + readonly amount?: number /** The integer amount in **%s** representing the amount to credit the customer's balance, which will be automatically applied to their next invoice. */ - readonly credit_amount?: number; + readonly credit_amount?: number /** ID of the invoice. */ - readonly invoice: string; + readonly invoice: string /** Line items that make up the credit note. */ - readonly lines?: readonly unknown[]; + readonly lines?: readonly unknown[] /** The credit note's memo appears on the credit note PDF. */ - readonly memo?: string; + readonly memo?: string /** 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: string; + readonly metadata?: string /** The integer amount in **%s** representing the amount that is credited outside of Stripe. */ - readonly out_of_band_amount?: number; + readonly out_of_band_amount?: number /** Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` */ - readonly reason?: string; + readonly reason?: string /** ID of an existing refund to link this credit note to. */ - readonly refund?: string; + readonly refund?: string /** The integer amount in **%s** representing the amount to refund. If set, a refund will be created for the charge associated with the invoice. */ - readonly refund_amount?: number; - }; - }; + readonly refund_amount?: number + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["credit_note"]; - }; + readonly schema: definitions['credit_note'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly GetCreditNotesPreviewLines: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** The integer amount in **%s** representing the total amount of the credit note. */ - readonly amount?: number; + readonly amount?: number /** The integer amount in **%s** representing the amount to credit the customer's balance, which will be automatically applied to their next invoice. */ - readonly credit_amount?: number; + readonly credit_amount?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** ID of the invoice. */ - readonly invoice: string; + readonly invoice: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** Line items that make up the credit note. */ - readonly lines?: readonly unknown[]; + readonly lines?: readonly unknown[] /** The credit note's memo appears on the credit note PDF. */ - readonly memo?: string; + readonly memo?: string /** 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: string; + readonly metadata?: string /** The integer amount in **%s** representing the amount that is credited outside of Stripe. */ - readonly out_of_band_amount?: number; + readonly out_of_band_amount?: number /** Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` */ - readonly reason?: string; + readonly reason?: string /** ID of an existing refund to link this credit note to. */ - readonly refund?: string; + readonly refund?: string /** The integer amount in **%s** representing the amount to refund. If set, a refund will be created for the charge associated with the invoice. */ - readonly refund_amount?: number; + readonly refund_amount?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { /** @description Details about each object. */ - readonly data: readonly definitions["credit_note_line_item"][]; + readonly data: readonly definitions['credit_note_line_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly GetCreditNotesCreditNoteLines: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; + readonly starting_after?: string + } readonly path: { - readonly credit_note: string; - }; - }; + readonly credit_note: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { /** @description Details about each object. */ - readonly data: readonly definitions["credit_note_line_item"][]; + readonly data: readonly definitions['credit_note_line_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves the credit note object with the given identifier.

*/ readonly GetCreditNotesId: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["credit_note"]; - }; + readonly schema: definitions['credit_note'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Updates an existing credit note.

*/ readonly PostCreditNotesId: { readonly parameters: { readonly path: { - readonly id: string; - }; + readonly id: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description Credit note memo. */ - readonly memo?: string; + readonly memo?: string /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: { readonly [key: string]: unknown }; - }; - }; - }; + readonly metadata?: { readonly [key: string]: unknown } + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["credit_note"]; - }; + readonly schema: definitions['credit_note'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly PostCreditNotesIdVoid: { readonly parameters: { readonly path: { - readonly id: string; - }; + readonly id: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["credit_note"]; - }; + readonly schema: definitions['credit_note'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly GetCustomers: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - readonly created?: number; + readonly expand?: readonly unknown[] + readonly created?: number /** A filter on the list based on the customer's `email` field. The value must be a string. */ - readonly email?: string; + readonly email?: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["customer"][]; + readonly data: readonly definitions['customer'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Creates a new customer object.

*/ readonly PostCustomers: { readonly parameters: { @@ -15539,45 +15459,45 @@ export interface operations { /** Body parameters for the request. */ readonly payload?: { /** @description The customer's address. */ - readonly address?: unknown; + readonly address?: unknown /** @description An integer amount in %s that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice. */ - readonly balance?: number; + readonly balance?: number /** @description The code of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. */ - readonly coupon?: string; + readonly coupon?: string /** @description An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard. */ - readonly description?: string; + readonly description?: string /** @description Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*. */ - readonly email?: string; + readonly email?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers. */ - readonly invoice_prefix?: string; + readonly invoice_prefix?: string /** * customer_param * @description Default invoice settings for this customer. */ readonly invoice_settings?: { readonly custom_fields?: readonly { - readonly name: string; - readonly value: string; - }[]; - readonly default_payment_method?: string; - readonly footer?: string; - }; + readonly name: string + readonly value: string + }[] + readonly default_payment_method?: string + readonly footer?: string + } /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description The customer's full name or business name. */ - readonly name?: string; + readonly name?: string /** @description The sequence to be used on the customer's next invoice. Defaults to 1. */ - readonly next_invoice_sequence?: number; + readonly next_invoice_sequence?: number /** @description ID of the PaymentMethod to attach to the customer */ - readonly payment_method?: string; + readonly payment_method?: string /** @description The customer's phone number. */ - readonly phone?: string; + readonly phone?: string /** @description Customer's preferred languages, ordered by preference. */ - readonly preferred_locales?: readonly string[]; + readonly preferred_locales?: readonly string[] /** @description The customer's shipping information. Appears on invoices emailed to this customer. */ - readonly shipping?: unknown; + readonly shipping?: unknown /** * @description The source can be a [Token](https://stripe.com/docs/api#tokens) or a [Source](https://stripe.com/docs/api#sources), as returned by [Elements](https://stripe.com/docs/elements). You must provide a source if the customer does not already have a valid source attached, and you are subscribing the customer to be charged automatically for a plan that is not free. * @@ -15585,77 +15505,77 @@ export interface operations { * * Whenever you attach a card to a customer, Stripe will automatically validate the card. */ - readonly source?: string; + readonly source?: string /** * @description The customer's tax exemption. One of `none`, `exempt`, or `reverse`. * @enum {string} */ - readonly tax_exempt?: "" | "exempt" | "none" | "reverse"; + readonly tax_exempt?: '' | 'exempt' | 'none' | 'reverse' /** @description The customer's tax IDs. */ readonly tax_id_data?: readonly { /** @enum {string} */ readonly type: - | "au_abn" - | "ca_bn" - | "ca_qst" - | "ch_vat" - | "es_cif" - | "eu_vat" - | "hk_br" - | "in_gst" - | "jp_cn" - | "kr_brn" - | "li_uid" - | "mx_rfc" - | "my_itn" - | "my_sst" - | "no_vat" - | "nz_gst" - | "ru_inn" - | "sg_gst" - | "sg_uen" - | "th_vat" - | "tw_vat" - | "us_ein" - | "za_vat"; - readonly value: string; - }[]; - }; - }; - }; - readonly responses: { - /** Successful response. */ - readonly 200: { - readonly schema: definitions["customer"]; - }; - /** Error response. */ - readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + | 'au_abn' + | 'ca_bn' + | 'ca_qst' + | 'ch_vat' + | 'es_cif' + | 'eu_vat' + | 'hk_br' + | 'in_gst' + | 'jp_cn' + | 'kr_brn' + | 'li_uid' + | 'mx_rfc' + | 'my_itn' + | 'my_sst' + | 'no_vat' + | 'nz_gst' + | 'ru_inn' + | 'sg_gst' + | 'sg_uen' + | 'th_vat' + | 'tw_vat' + | 'us_ein' + | 'za_vat' + readonly value: string + }[] + } + } + } + readonly responses: { + /** Successful response. */ + readonly 200: { + readonly schema: definitions['customer'] + } + /** Error response. */ + readonly default: { + readonly schema: definitions['error'] + } + } + } /**

Retrieves the details of an existing customer. You need only supply the unique customer identifier that was returned upon customer creation.

*/ readonly GetCustomersCustomer: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly customer: string; - }; - }; + readonly customer: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["customer"]; - }; + readonly schema: definitions['customer'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the source parameter, that becomes the customer’s active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the source parameter: for each of the customer’s current subscriptions, if the subscription bills automatically and is in the past_due state, then the latest open invoice for the subscription with automatic collection enabled will be retried. This retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice. Changing the default_source for a customer will not trigger this behavior.

* @@ -15664,27 +15584,27 @@ export interface operations { readonly PostCustomersCustomer: { readonly parameters: { readonly path: { - readonly customer: string; - }; + readonly customer: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description The customer's address. */ - readonly address?: unknown; + readonly address?: unknown /** @description An integer amount in %s that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice. */ - readonly balance?: number; + readonly balance?: number /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js), or a dictionary containing a user's bank account details. */ - readonly bank_account?: unknown; + readonly bank_account?: unknown /** @description A token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js). */ - readonly card?: unknown; + readonly card?: unknown /** @description The code of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. */ - readonly coupon?: string; + readonly coupon?: string /** @description ID of Alipay account to make the customer's new default for invoice payments. */ - readonly default_alipay_account?: string; + readonly default_alipay_account?: string /** @description ID of bank account to make the customer's new default for invoice payments. */ - readonly default_bank_account?: string; + readonly default_bank_account?: string /** @description ID of card to make the customer's new default for invoice payments. */ - readonly default_card?: string; + readonly default_card?: string /** * @description If you are using payment methods created via the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method) parameter. * @@ -15692,39 +15612,39 @@ export interface operations { * * If you want to add a new payment source and make it the default, see the [source](https://stripe.com/docs/api/customers/update#update_customer-source) property. */ - readonly default_source?: string; + readonly default_source?: string /** @description An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard. */ - readonly description?: string; + readonly description?: string /** @description Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*. */ - readonly email?: string; + readonly email?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers. */ - readonly invoice_prefix?: string; + readonly invoice_prefix?: string /** * customer_param * @description Default invoice settings for this customer. */ readonly invoice_settings?: { readonly custom_fields?: readonly { - readonly name: string; - readonly value: string; - }[]; - readonly default_payment_method?: string; - readonly footer?: string; - }; + readonly name: string + readonly value: string + }[] + readonly default_payment_method?: string + readonly footer?: string + } /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description The customer's full name or business name. */ - readonly name?: string; + readonly name?: string /** @description The sequence to be used on the customer's next invoice. Defaults to 1. */ - readonly next_invoice_sequence?: number; + readonly next_invoice_sequence?: number /** @description The customer's phone number. */ - readonly phone?: string; + readonly phone?: string /** @description Customer's preferred languages, ordered by preference. */ - readonly preferred_locales?: readonly string[]; + readonly preferred_locales?: readonly string[] /** @description The customer's shipping information. Appears on invoices emailed to this customer. */ - readonly shipping?: unknown; + readonly shipping?: unknown /** * @description The source can be a [Token](https://stripe.com/docs/api#tokens) or a [Source](https://stripe.com/docs/api#sources), as returned by [Elements](https://stripe.com/docs/elements). You must provide a source if the customer does not already have a valid source attached, and you are subscribing the customer to be charged automatically for a plan that is not free. * @@ -15732,212 +15652,212 @@ export interface operations { * * Whenever you attach a card to a customer, Stripe will automatically validate the card. */ - readonly source?: string; + readonly source?: string /** * @description The customer's tax exemption. One of `none`, `exempt`, or `reverse`. * @enum {string} */ - readonly tax_exempt?: "" | "exempt" | "none" | "reverse"; + readonly tax_exempt?: '' | 'exempt' | 'none' | 'reverse' /** @description Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. */ - readonly trial_end?: unknown; - }; - }; - }; + readonly trial_end?: unknown + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["customer"]; - }; + readonly schema: definitions['customer'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly DeleteCustomersCustomer: { readonly parameters: { readonly path: { - readonly customer: string; - }; - }; + readonly customer: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["deleted_customer"]; - }; + readonly schema: definitions['deleted_customer'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly GetCustomersCustomerBalanceTransactions: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; + readonly starting_after?: string + } readonly path: { - readonly customer: string; - }; - }; + readonly customer: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { /** @description Details about each object. */ - readonly data: readonly definitions["customer_balance_transaction"][]; + readonly data: readonly definitions['customer_balance_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly PostCustomersCustomerBalanceTransactions: { readonly parameters: { readonly path: { - readonly customer: string; - }; + readonly customer: string + } readonly body: { /** Body parameters for the request. */ readonly payload: { /** @description The integer amount in **%s** to apply to the customer's balance. Pass a negative amount to credit the customer's balance, and pass in a positive amount to debit the customer's balance. */ - readonly amount: number; + readonly amount: number /** @description 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 the customer's [`currency`](https://stripe.com/docs/api/customers/object#customer_object-currency) is set, this value must match it. If the customer's `currency` is not set, it will be updated to this value. */ - readonly currency: string; + readonly currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string; + readonly description?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; - }; - }; - }; + readonly metadata?: unknown + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["customer_balance_transaction"]; - }; + readonly schema: definitions['customer_balance_transaction'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly GetCustomersCustomerBalanceTransactionsTransaction: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly customer: string; - readonly transaction: string; - }; - }; + readonly customer: string + readonly transaction: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["customer_balance_transaction"]; - }; + readonly schema: definitions['customer_balance_transaction'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly PostCustomersCustomerBalanceTransactionsTransaction: { readonly parameters: { readonly path: { - readonly customer: string; - readonly transaction: string; - }; + readonly customer: string + readonly transaction: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string; + readonly description?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; - }; - }; - }; + readonly metadata?: unknown + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["customer_balance_transaction"]; - }; + readonly schema: definitions['customer_balance_transaction'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly GetCustomersCustomerBankAccounts: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; + readonly starting_after?: string + } readonly path: { - readonly customer: string; - }; - }; + readonly customer: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { /** @description Details about each object. */ - readonly data: readonly definitions["bank_account"][]; + readonly data: readonly definitions['bank_account'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

When you create a new credit card, you must specify a customer or recipient on which to create it.

* @@ -15948,182 +15868,182 @@ export interface operations { readonly PostCustomersCustomerBankAccounts: { readonly parameters: { readonly path: { - readonly customer: string; - }; + readonly customer: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description A token returned by [Stripe.js](https://stripe.com/docs/stripe.js) representing the user’s Alipay account details. */ - readonly alipay_account?: string; + readonly alipay_account?: string /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js), or a dictionary containing a user's bank account details. */ - readonly bank_account?: unknown; + readonly bank_account?: unknown /** @description A token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js). */ - readonly card?: unknown; + readonly card?: unknown /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: { readonly [key: string]: unknown }; + readonly metadata?: { readonly [key: string]: unknown } /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - readonly source?: string; - }; - }; - }; + readonly source?: string + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["payment_source"]; - }; + readonly schema: definitions['payment_source'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly GetCustomersCustomerBankAccountsId: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly customer: string; - readonly id: string; - }; - }; + readonly customer: string + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["bank_account"]; - }; + readonly schema: definitions['bank_account'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Update a specified source for a given customer.

*/ readonly PostCustomersCustomerBankAccountsId: { readonly parameters: { readonly path: { - readonly customer: string; - readonly id: string; - }; + readonly customer: string + readonly id: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description The name of the person or business that owns the bank account. */ - readonly account_holder_name?: string; + readonly account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - readonly account_holder_type?: "company" | "individual"; + readonly account_holder_type?: 'company' | 'individual' /** @description City/District/Suburb/Town/Village. */ - readonly address_city?: string; + readonly address_city?: string /** @description Billing address country, if provided when creating card. */ - readonly address_country?: string; + readonly address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - readonly address_line1?: string; + readonly address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - readonly address_line2?: string; + readonly address_line2?: string /** @description State/County/Province/Region. */ - readonly address_state?: string; + readonly address_state?: string /** @description ZIP or postal code. */ - readonly address_zip?: string; + readonly address_zip?: string /** @description Two digit number representing the card’s expiration month. */ - readonly exp_month?: string; + readonly exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - readonly exp_year?: string; + readonly exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description Cardholder name. */ - readonly name?: string; + readonly name?: string /** owner */ readonly owner?: { /** source_address */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; - readonly email?: string; - readonly name?: string; - readonly phone?: string; - }; - }; - }; - }; - readonly responses: { - /** Successful response. */ - readonly 200: { - readonly schema: definitions["bank_account"]; - }; - /** Error response. */ - readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } + readonly email?: string + readonly name?: string + readonly phone?: string + } + } + } + } + readonly responses: { + /** Successful response. */ + readonly 200: { + readonly schema: definitions['bank_account'] + } + /** Error response. */ + readonly default: { + readonly schema: definitions['error'] + } + } + } /**

Delete a specified source for a given customer.

*/ readonly DeleteCustomersCustomerBankAccountsId: { readonly parameters: { readonly path: { - readonly customer: string; - readonly id: string; - }; + readonly customer: string + readonly id: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["deleted_payment_source"]; - }; + readonly schema: definitions['deleted_payment_source'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Verify a specified bank account for a given customer.

*/ readonly PostCustomersCustomerBankAccountsIdVerify: { readonly parameters: { readonly path: { - readonly customer: string; - readonly id: string; - }; + readonly customer: string + readonly id: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account. */ - readonly amounts?: readonly number[]; + readonly amounts?: readonly number[] /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["bank_account"]; - }; + readonly schema: definitions['bank_account'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

You can see a list of the cards belonging to a customer. * Note that the 10 most recent sources are always available on the Customer object. @@ -16133,40 +16053,40 @@ export interface operations { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; + readonly starting_after?: string + } readonly path: { - readonly customer: string; - }; - }; + readonly customer: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["card"][]; + readonly data: readonly definitions['card'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

When you create a new credit card, you must specify a customer or recipient on which to create it.

* @@ -16177,235 +16097,235 @@ export interface operations { readonly PostCustomersCustomerCards: { readonly parameters: { readonly path: { - readonly customer: string; - }; + readonly customer: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description A token returned by [Stripe.js](https://stripe.com/docs/stripe.js) representing the user’s Alipay account details. */ - readonly alipay_account?: string; + readonly alipay_account?: string /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js), or a dictionary containing a user's bank account details. */ - readonly bank_account?: unknown; + readonly bank_account?: unknown /** @description A token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js). */ - readonly card?: unknown; + readonly card?: unknown /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: { readonly [key: string]: unknown }; + readonly metadata?: { readonly [key: string]: unknown } /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - readonly source?: string; - }; - }; - }; + readonly source?: string + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["payment_source"]; - }; + readonly schema: definitions['payment_source'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly GetCustomersCustomerCardsId: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly customer: string; - readonly id: string; - }; - }; + readonly customer: string + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["card"]; - }; + readonly schema: definitions['card'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Update a specified source for a given customer.

*/ readonly PostCustomersCustomerCardsId: { readonly parameters: { readonly path: { - readonly customer: string; - readonly id: string; - }; + readonly customer: string + readonly id: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description The name of the person or business that owns the bank account. */ - readonly account_holder_name?: string; + readonly account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - readonly account_holder_type?: "company" | "individual"; + readonly account_holder_type?: 'company' | 'individual' /** @description City/District/Suburb/Town/Village. */ - readonly address_city?: string; + readonly address_city?: string /** @description Billing address country, if provided when creating card. */ - readonly address_country?: string; + readonly address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - readonly address_line1?: string; + readonly address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - readonly address_line2?: string; + readonly address_line2?: string /** @description State/County/Province/Region. */ - readonly address_state?: string; + readonly address_state?: string /** @description ZIP or postal code. */ - readonly address_zip?: string; + readonly address_zip?: string /** @description Two digit number representing the card’s expiration month. */ - readonly exp_month?: string; + readonly exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - readonly exp_year?: string; + readonly exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description Cardholder name. */ - readonly name?: string; + readonly name?: string /** owner */ readonly owner?: { /** source_address */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; - readonly email?: string; - readonly name?: string; - readonly phone?: string; - }; - }; - }; - }; - readonly responses: { - /** Successful response. */ - readonly 200: { - readonly schema: definitions["bank_account"]; - }; - /** Error response. */ - readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } + readonly email?: string + readonly name?: string + readonly phone?: string + } + } + } + } + readonly responses: { + /** Successful response. */ + readonly 200: { + readonly schema: definitions['bank_account'] + } + /** Error response. */ + readonly default: { + readonly schema: definitions['error'] + } + } + } /**

Delete a specified source for a given customer.

*/ readonly DeleteCustomersCustomerCardsId: { readonly parameters: { readonly path: { - readonly customer: string; - readonly id: string; - }; + readonly customer: string + readonly id: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["deleted_payment_source"]; - }; + readonly schema: definitions['deleted_payment_source'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } readonly GetCustomersCustomerDiscount: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly customer: string; - }; - }; + readonly customer: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["discount"]; - }; + readonly schema: definitions['discount'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Removes the currently applied discount on a customer.

*/ readonly DeleteCustomersCustomerDiscount: { readonly parameters: { readonly path: { - readonly customer: string; - }; - }; + readonly customer: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["deleted_discount"]; - }; + readonly schema: definitions['deleted_discount'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

List sources for a specified customer.

*/ readonly GetCustomersCustomerSources: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** Filter sources according to a particular object type. */ - readonly object?: string; + readonly object?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; + readonly starting_after?: string + } readonly path: { - readonly customer: string; - }; - }; + readonly customer: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { /** @description Details about each object. */ - readonly data: readonly definitions["alipay_account"][]; + readonly data: readonly definitions['alipay_account'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

When you create a new credit card, you must specify a customer or recipient on which to create it.

* @@ -16416,272 +16336,272 @@ export interface operations { readonly PostCustomersCustomerSources: { readonly parameters: { readonly path: { - readonly customer: string; - }; + readonly customer: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description A token returned by [Stripe.js](https://stripe.com/docs/stripe.js) representing the user’s Alipay account details. */ - readonly alipay_account?: string; + readonly alipay_account?: string /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js), or a dictionary containing a user's bank account details. */ - readonly bank_account?: unknown; + readonly bank_account?: unknown /** @description A token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js). */ - readonly card?: unknown; + readonly card?: unknown /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: { readonly [key: string]: unknown }; + readonly metadata?: { readonly [key: string]: unknown } /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - readonly source?: string; - }; - }; - }; + readonly source?: string + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["payment_source"]; - }; + readonly schema: definitions['payment_source'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieve a specified source for a given customer.

*/ readonly GetCustomersCustomerSourcesId: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly customer: string; - readonly id: string; - }; - }; + readonly customer: string + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["payment_source"]; - }; + readonly schema: definitions['payment_source'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Update a specified source for a given customer.

*/ readonly PostCustomersCustomerSourcesId: { readonly parameters: { readonly path: { - readonly customer: string; - readonly id: string; - }; + readonly customer: string + readonly id: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description The name of the person or business that owns the bank account. */ - readonly account_holder_name?: string; + readonly account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - readonly account_holder_type?: "company" | "individual"; + readonly account_holder_type?: 'company' | 'individual' /** @description City/District/Suburb/Town/Village. */ - readonly address_city?: string; + readonly address_city?: string /** @description Billing address country, if provided when creating card. */ - readonly address_country?: string; + readonly address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - readonly address_line1?: string; + readonly address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - readonly address_line2?: string; + readonly address_line2?: string /** @description State/County/Province/Region. */ - readonly address_state?: string; + readonly address_state?: string /** @description ZIP or postal code. */ - readonly address_zip?: string; + readonly address_zip?: string /** @description Two digit number representing the card’s expiration month. */ - readonly exp_month?: string; + readonly exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - readonly exp_year?: string; + readonly exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description Cardholder name. */ - readonly name?: string; + readonly name?: string /** owner */ readonly owner?: { /** source_address */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; - readonly email?: string; - readonly name?: string; - readonly phone?: string; - }; - }; - }; - }; - readonly responses: { - /** Successful response. */ - readonly 200: { - readonly schema: definitions["bank_account"]; - }; - /** Error response. */ - readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } + readonly email?: string + readonly name?: string + readonly phone?: string + } + } + } + } + readonly responses: { + /** Successful response. */ + readonly 200: { + readonly schema: definitions['bank_account'] + } + /** Error response. */ + readonly default: { + readonly schema: definitions['error'] + } + } + } /**

Delete a specified source for a given customer.

*/ readonly DeleteCustomersCustomerSourcesId: { readonly parameters: { readonly path: { - readonly customer: string; - readonly id: string; - }; + readonly customer: string + readonly id: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["deleted_payment_source"]; - }; + readonly schema: definitions['deleted_payment_source'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Verify a specified bank account for a given customer.

*/ readonly PostCustomersCustomerSourcesIdVerify: { readonly parameters: { readonly path: { - readonly customer: string; - readonly id: string; - }; + readonly customer: string + readonly id: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account. */ - readonly amounts?: readonly number[]; + readonly amounts?: readonly number[] /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["bank_account"]; - }; + readonly schema: definitions['bank_account'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly GetCustomersCustomerSubscriptions: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; + readonly starting_after?: string + } readonly path: { - readonly customer: string; - }; - }; + readonly customer: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { /** @description Details about each object. */ - readonly data: readonly definitions["subscription"][]; + readonly data: readonly definitions['subscription'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Creates a new subscription on an existing customer.

*/ readonly PostCustomersCustomerSubscriptions: { readonly parameters: { readonly path: { - readonly customer: string; - }; + readonly customer: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). */ - readonly application_fee_percent?: number; + readonly application_fee_percent?: number /** @description For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor. */ - readonly backdate_start_date?: number; + readonly backdate_start_date?: number /** @description 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. */ - readonly billing_cycle_anchor?: number; + readonly billing_cycle_anchor?: number /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. */ - readonly billing_thresholds?: unknown; + readonly billing_thresholds?: unknown /** @description 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. */ - readonly cancel_at?: number; + readonly cancel_at?: number /** @description Boolean indicating whether this subscription should cancel at the end of the current period. */ - readonly cancel_at_period_end?: boolean; + readonly cancel_at_period_end?: boolean /** * @description 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. Defaults to `charge_automatically`. * @enum {string} */ - readonly collection_method?: "charge_automatically" | "send_invoice"; + readonly collection_method?: 'charge_automatically' | 'send_invoice' /** @description The code of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. */ - readonly coupon?: string; + readonly coupon?: string /** @description Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. */ - readonly days_until_due?: number; + readonly days_until_due?: number /** @description ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. If not set, invoices will use the default payment method in the customer's invoice settings. */ - readonly default_payment_method?: string; + readonly default_payment_method?: string /** @description 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 not set, defaults to the customer's default source. */ - readonly default_source?: string; + readonly default_source?: string /** @description 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. */ - readonly default_tax_rates?: readonly string[]; + readonly default_tax_rates?: readonly string[] /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description A list of up to 20 subscription items, each with an attached plan. */ readonly items?: readonly { - readonly billing_thresholds?: unknown; - readonly metadata?: { readonly [key: string]: unknown }; - readonly plan?: string; - readonly quantity?: number; - readonly tax_rates?: readonly string[]; - }[]; + readonly billing_thresholds?: unknown + readonly metadata?: { readonly [key: string]: unknown } + readonly plan?: string + readonly quantity?: number + readonly tax_rates?: readonly string[] + }[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. */ - readonly off_session?: boolean; + readonly off_session?: boolean /** * @description Use `allow_incomplete` to create subscriptions with `status=incomplete` if the first invoice cannot be paid. Creating subscriptions with this status allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * @@ -16690,120 +16610,120 @@ export interface operations { * `pending_if_incomplete` is only used with updates and cannot be passed when creating a subscription. * @enum {string} */ - readonly payment_behavior?: "allow_incomplete" | "error_if_incomplete" | "pending_if_incomplete"; + readonly payment_behavior?: 'allow_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete' /** @description 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. */ - readonly pending_invoice_item_interval?: unknown; + readonly pending_invoice_item_interval?: unknown /** @description This field has been renamed to `proration_behavior`. `prorate=true` can be replaced with `proration_behavior=create_prorations` and `prorate=false` can be replaced with `proration_behavior=none`. */ - readonly prorate?: boolean; + readonly prorate?: boolean /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) resulting from the `billing_cycle_anchor`. Valid values are `create_prorations` or `none`. * * Passing `create_prorations` will cause proration invoice items to be created when applicable. Prorations can be disabled by passing `none`. If no value is passed, the default is `create_prorations`. * @enum {string} */ - readonly proration_behavior?: "always_invoice" | "create_prorations" | "none"; + readonly proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** @description A non-negative decimal (with at most four decimal places) between 0 and 100. This represents the percentage of the subscription invoice subtotal that will be calculated and added as tax to the final amount in each billing period. For example, a plan which charges $10/month with a `tax_percent` of `20.0` will charge $12 per invoice. To unset a previously-set value, pass an empty string. This field has been deprecated and will be removed in a future API version, for further information view the [migration docs](https://stripe.com/docs/billing/migration/taxes) for `tax_rates`. */ - readonly tax_percent?: unknown; + readonly tax_percent?: unknown /** @description Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. */ - readonly trial_end?: unknown; + readonly trial_end?: unknown /** @description 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. */ - readonly trial_from_plan?: boolean; + readonly trial_from_plan?: boolean /** @description Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. */ - readonly trial_period_days?: number; - }; - }; - }; + readonly trial_period_days?: number + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["subscription"]; - }; + readonly schema: definitions['subscription'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves the subscription with the given ID.

*/ readonly GetCustomersCustomerSubscriptionsSubscriptionExposedId: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly customer: string; - readonly subscription_exposed_id: string; - }; - }; + readonly customer: string + readonly subscription_exposed_id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["subscription"]; - }; + readonly schema: definitions['subscription'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly PostCustomersCustomerSubscriptionsSubscriptionExposedId: { readonly parameters: { readonly path: { - readonly customer: string; - readonly subscription_exposed_id: string; - }; + readonly customer: string + readonly subscription_exposed_id: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). */ - readonly application_fee_percent?: number; + readonly application_fee_percent?: number /** * @description Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). * @enum {string} */ - readonly billing_cycle_anchor?: "now" | "unchanged"; + readonly billing_cycle_anchor?: 'now' | 'unchanged' /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. */ - readonly billing_thresholds?: unknown; + readonly billing_thresholds?: unknown /** @description 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. */ - readonly cancel_at?: unknown; + readonly cancel_at?: unknown /** @description Boolean indicating whether this subscription should cancel at the end of the current period. */ - readonly cancel_at_period_end?: boolean; + readonly cancel_at_period_end?: boolean /** * @description 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. Defaults to `charge_automatically`. * @enum {string} */ - readonly collection_method?: "charge_automatically" | "send_invoice"; + readonly collection_method?: 'charge_automatically' | 'send_invoice' /** @description The code of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. */ - readonly coupon?: string; + readonly coupon?: string /** @description Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. */ - readonly days_until_due?: number; + readonly days_until_due?: number /** @description ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. If not set, invoices will use the default payment method in the customer's invoice settings. */ - readonly default_payment_method?: string; + readonly default_payment_method?: string /** @description 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 not set, defaults to the customer's default source. */ - readonly default_source?: string; + readonly default_source?: string /** @description 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. Pass an empty string to remove previously-defined tax rates. */ - readonly default_tax_rates?: readonly string[]; + readonly default_tax_rates?: readonly string[] /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description List of subscription items, each with an attached plan. */ readonly items?: readonly { - readonly billing_thresholds?: unknown; - readonly clear_usage?: boolean; - readonly deleted?: boolean; - readonly id?: string; - readonly metadata?: unknown; - readonly plan?: string; - readonly quantity?: number; - readonly tax_rates?: readonly string[]; - }[]; + readonly billing_thresholds?: unknown + readonly clear_usage?: boolean + readonly deleted?: boolean + readonly id?: string + readonly metadata?: unknown + readonly plan?: string + readonly quantity?: number + readonly tax_rates?: readonly string[] + }[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. */ - readonly off_session?: boolean; + readonly off_session?: boolean /** @description If specified, payment collection for this subscription will be paused. */ - readonly pause_collection?: unknown; + readonly pause_collection?: unknown /** * @description Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * @@ -16812,11 +16732,11 @@ export interface operations { * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not create a subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. * @enum {string} */ - readonly payment_behavior?: "allow_incomplete" | "error_if_incomplete" | "pending_if_incomplete"; + readonly payment_behavior?: 'allow_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete' /** @description 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. */ - readonly pending_invoice_item_interval?: unknown; + readonly pending_invoice_item_interval?: unknown /** @description This field has been renamed to `proration_behavior`. `prorate=true` can be replaced with `proration_behavior=create_prorations` and `prorate=false` can be replaced with `proration_behavior=none`. */ - readonly prorate?: boolean; + readonly prorate?: boolean /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -16825,29 +16745,29 @@ export interface operations { * Prorations can be disabled by passing `none`. * @enum {string} */ - readonly proration_behavior?: "always_invoice" | "create_prorations" | "none"; + readonly proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations. */ - readonly proration_date?: number; + readonly proration_date?: number /** @description A non-negative decimal (with at most four decimal places) between 0 and 100. This represents the percentage of the subscription invoice subtotal that will be calculated and added as tax to the final amount in each billing period. For example, a plan which charges $10/month with a `tax_percent` of `20.0` will charge $12 per invoice. To unset a previously-set value, pass an empty string. This field has been deprecated and will be removed in a future API version, for further information view the [migration docs](https://stripe.com/docs/billing/migration/taxes) for `tax_rates`. */ - readonly tax_percent?: unknown; + readonly tax_percent?: unknown /** @description Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. */ - readonly trial_end?: unknown; + readonly trial_end?: unknown /** @description 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. */ - readonly trial_from_plan?: boolean; - }; - }; - }; + readonly trial_from_plan?: boolean + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["subscription"]; - }; + readonly schema: definitions['subscription'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

Cancels a customer’s subscription. If you set the at_period_end parameter to true, the subscription will remain active until the end of the period, at which point it will be canceled and not renewed. Otherwise, with the default false value, the subscription is terminated immediately. In either case, the customer will not be charged again for the subscription.

* @@ -16858,273 +16778,273 @@ export interface operations { readonly DeleteCustomersCustomerSubscriptionsSubscriptionExposedId: { readonly parameters: { readonly path: { - readonly customer: string; - readonly subscription_exposed_id: string; - }; + readonly customer: string + readonly subscription_exposed_id: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description Can be set to `true` if `at_period_end` is not set to `true`. Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items. */ - readonly invoice_now?: boolean; + readonly invoice_now?: boolean /** @description Can be set to `true` if `at_period_end` is not set to `true`. Will generate a proration invoice item that credits remaining unused time until the subscription period end. */ - readonly prorate?: boolean; - }; - }; - }; + readonly prorate?: boolean + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["subscription"]; - }; + readonly schema: definitions['subscription'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } readonly GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly customer: string; - readonly subscription_exposed_id: string; - }; - }; + readonly customer: string + readonly subscription_exposed_id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["discount"]; - }; + readonly schema: definitions['discount'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Removes the currently applied discount on a customer.

*/ readonly DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount: { readonly parameters: { readonly path: { - readonly customer: string; - readonly subscription_exposed_id: string; - }; - }; + readonly customer: string + readonly subscription_exposed_id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["deleted_discount"]; - }; + readonly schema: definitions['deleted_discount'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Returns a list of tax IDs for a customer.

*/ readonly GetCustomersCustomerTaxIds: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; + readonly starting_after?: string + } readonly path: { - readonly customer: string; - }; - }; + readonly customer: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { /** @description Details about each object. */ - readonly data: readonly definitions["tax_id"][]; + readonly data: readonly definitions['tax_id'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Creates a new TaxID object for a customer.

*/ readonly PostCustomersCustomerTaxIds: { readonly parameters: { readonly path: { - readonly customer: string; - }; + readonly customer: string + } readonly body: { /** Body parameters for the request. */ readonly payload: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** * @description Type of the tax ID, one of `eu_vat`, `nz_gst`, `au_abn`, `in_gst`, `no_vat`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `my_sst`, or `sg_gst` * @enum {string} */ readonly type: - | "au_abn" - | "ca_bn" - | "ca_qst" - | "ch_vat" - | "es_cif" - | "eu_vat" - | "hk_br" - | "in_gst" - | "jp_cn" - | "kr_brn" - | "li_uid" - | "mx_rfc" - | "my_itn" - | "my_sst" - | "no_vat" - | "nz_gst" - | "ru_inn" - | "sg_gst" - | "sg_uen" - | "th_vat" - | "tw_vat" - | "us_ein" - | "za_vat"; + | 'au_abn' + | 'ca_bn' + | 'ca_qst' + | 'ch_vat' + | 'es_cif' + | 'eu_vat' + | 'hk_br' + | 'in_gst' + | 'jp_cn' + | 'kr_brn' + | 'li_uid' + | 'mx_rfc' + | 'my_itn' + | 'my_sst' + | 'no_vat' + | 'nz_gst' + | 'ru_inn' + | 'sg_gst' + | 'sg_uen' + | 'th_vat' + | 'tw_vat' + | 'us_ein' + | 'za_vat' /** @description Value of the tax ID. */ - readonly value: string; - }; - }; - }; + readonly value: string + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["tax_id"]; - }; + readonly schema: definitions['tax_id'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves the TaxID object with the given identifier.

*/ readonly GetCustomersCustomerTaxIdsId: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly customer: string; - readonly id: string; - }; - }; + readonly customer: string + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["tax_id"]; - }; + readonly schema: definitions['tax_id'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Deletes an existing TaxID object.

*/ readonly DeleteCustomersCustomerTaxIdsId: { readonly parameters: { readonly path: { - readonly customer: string; - readonly id: string; - }; - }; + readonly customer: string + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["deleted_tax_id"]; - }; + readonly schema: definitions['deleted_tax_id'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Returns a list of your disputes.

*/ readonly GetDisputes: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** Only return disputes associated to the charge specified by this charge ID. */ - readonly charge?: string; - readonly created?: number; + readonly charge?: string + readonly created?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** Only return disputes associated to the PaymentIntent specified by this PaymentIntent ID. */ - readonly payment_intent?: string; + readonly payment_intent?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["dispute"][]; + readonly data: readonly definitions['dispute'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves the dispute with the given ID.

*/ readonly GetDisputesDispute: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly dispute: string; - }; - }; + readonly dispute: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["dispute"]; - }; + readonly schema: definitions['dispute'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

When you get a dispute, contacting your customer is always the best first step. If that doesn’t work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your dashboard, but if you prefer, you can use the API to submit evidence programmatically.

* @@ -17133,8 +17053,8 @@ export interface operations { readonly PostDisputesDispute: { readonly parameters: { readonly path: { - readonly dispute: string; - }; + readonly dispute: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { @@ -17143,54 +17063,54 @@ export interface operations { * @description Evidence to upload, to respond to a dispute. Updating any field in the hash will submit all fields in the hash for review. The combined character count of all fields is limited to 150,000. */ readonly evidence?: { - readonly access_activity_log?: string; - readonly billing_address?: string; - readonly cancellation_policy?: string; - readonly cancellation_policy_disclosure?: string; - readonly cancellation_rebuttal?: string; - readonly customer_communication?: string; - readonly customer_email_address?: string; - readonly customer_name?: string; - readonly customer_purchase_ip?: string; - readonly customer_signature?: string; - readonly duplicate_charge_documentation?: string; - readonly duplicate_charge_explanation?: string; - readonly duplicate_charge_id?: string; - readonly product_description?: string; - readonly receipt?: string; - readonly refund_policy?: string; - readonly refund_policy_disclosure?: string; - readonly refund_refusal_explanation?: string; - readonly service_date?: string; - readonly service_documentation?: string; - readonly shipping_address?: string; - readonly shipping_carrier?: string; - readonly shipping_date?: string; - readonly shipping_documentation?: string; - readonly shipping_tracking_number?: string; - readonly uncategorized_file?: string; - readonly uncategorized_text?: string; - }; + readonly access_activity_log?: string + readonly billing_address?: string + readonly cancellation_policy?: string + readonly cancellation_policy_disclosure?: string + readonly cancellation_rebuttal?: string + readonly customer_communication?: string + readonly customer_email_address?: string + readonly customer_name?: string + readonly customer_purchase_ip?: string + readonly customer_signature?: string + readonly duplicate_charge_documentation?: string + readonly duplicate_charge_explanation?: string + readonly duplicate_charge_id?: string + readonly product_description?: string + readonly receipt?: string + readonly refund_policy?: string + readonly refund_policy_disclosure?: string + readonly refund_refusal_explanation?: string + readonly service_date?: string + readonly service_documentation?: string + readonly shipping_address?: string + readonly shipping_carrier?: string + readonly shipping_date?: string + readonly shipping_documentation?: string + readonly shipping_tracking_number?: string + readonly uncategorized_file?: string + readonly uncategorized_text?: string + } /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description Whether to immediately submit evidence to the bank. If `false`, evidence is staged on the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank by making another request with this attribute set to `true` (the default). */ - readonly submit?: boolean; - }; - }; - }; + readonly submit?: boolean + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["dispute"]; - }; + readonly schema: definitions['dispute'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.

* @@ -17199,27 +17119,27 @@ export interface operations { readonly PostDisputesDisputeClose: { readonly parameters: { readonly path: { - readonly dispute: string; - }; + readonly dispute: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["dispute"]; - }; + readonly schema: definitions['dispute'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly PostEphemeralKeys: { readonly parameters: { @@ -17227,214 +17147,214 @@ export interface operations { /** Body parameters for the request. */ readonly payload?: { /** @description The ID of the Customer you'd like to modify using the resulting ephemeral key. */ - readonly customer?: string; + readonly customer?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The ID of the Issuing Card you'd like to access using the resulting ephemeral key. */ - readonly issuing_card?: string; - }; - }; - }; + readonly issuing_card?: string + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["ephemeral_key"]; - }; + readonly schema: definitions['ephemeral_key'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly DeleteEphemeralKeysKey: { readonly parameters: { readonly path: { - readonly key: string; - }; + readonly key: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["ephemeral_key"]; - }; + readonly schema: definitions['ephemeral_key'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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).

*/ readonly GetEvents: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - readonly created?: number; + readonly expand?: readonly unknown[] + readonly created?: number /** 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. */ - readonly delivery_success?: boolean; + readonly delivery_success?: boolean /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** 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. */ - readonly type?: string; + readonly type?: string /** 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. */ - readonly types?: readonly unknown[]; - }; - }; + readonly types?: readonly unknown[] + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["event"][]; + readonly data: readonly definitions['event'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.

*/ readonly GetEventsId: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["event"]; - }; + readonly schema: definitions['event'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly GetExchangeRates: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** 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. */ - readonly limit?: number; + readonly limit?: number /** 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. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["exchange_rate"][]; + readonly data: readonly definitions['exchange_rate'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly GetExchangeRatesCurrency: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly currency: string; - }; - }; + readonly currency: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["exchange_rate"]; - }; + readonly schema: definitions['exchange_rate'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Returns a list of file links.

*/ readonly GetFileLinks: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - readonly created?: number; + readonly expand?: readonly unknown[] + readonly created?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Filter links by their expiration status. By default, all links are returned. */ - readonly expired?: boolean; + readonly expired?: boolean /** Only return links for the given file. */ - readonly file?: string; + readonly file?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["file_link"][]; + readonly data: readonly definitions['file_link'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Creates a new file link object.

*/ readonly PostFileLinks: { readonly parameters: { @@ -17442,117 +17362,117 @@ export interface operations { /** Body parameters for the request. */ readonly payload: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description A future timestamp after which the link will no longer be usable. */ - readonly expires_at?: number; + readonly expires_at?: number /** @description The ID of the file. The file's `purpose` must be one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `finance_report_run`, `pci_document`, `sigma_scheduled_query`, or `tax_document_user_upload`. */ - readonly file: string; + readonly file: string /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; - }; - }; - }; + readonly metadata?: unknown + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["file_link"]; - }; + readonly schema: definitions['file_link'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves the file link with the given ID.

*/ readonly GetFileLinksLink: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly link: string; - }; - }; + readonly link: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["file_link"]; - }; + readonly schema: definitions['file_link'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly PostFileLinksLink: { readonly parameters: { readonly path: { - readonly link: string; - }; + readonly link: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description A future timestamp after which the link will no longer be usable, or `now` to expire the link immediately. */ - readonly expires_at?: unknown; + readonly expires_at?: unknown /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; - }; - }; - }; + readonly metadata?: unknown + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["file_link"]; - }; + readonly schema: definitions['file_link'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Returns a list of the files that your account has access to. The files are returned sorted by creation date, with the most recently created files appearing first.

*/ readonly GetFiles: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - readonly created?: number; + readonly expand?: readonly unknown[] + readonly created?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** The file purpose to filter queries by. If none is provided, files will not be filtered by purpose. */ - readonly purpose?: string; + readonly purpose?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["file"][]; + readonly data: readonly definitions['file'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

To upload a file to Stripe, you’ll need to send a request of type multipart/form-data. The request should contain the file you would like to upload, as well as the parameters for creating a file.

* @@ -17564,110 +17484,110 @@ export interface operations { /** Body parameters for the request. */ readonly payload: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description A file to upload. The file should follow the specifications of RFC 2388 (which defines file transfers for the `multipart/form-data` protocol). */ - readonly file: string; + readonly file: string /** * file_link_creation_params * @description Optional parameters to automatically create a [file link](https://stripe.com/docs/api#file_links) for the newly created file. */ readonly file_link_data?: { - readonly create: boolean; - readonly expires_at?: number; - readonly metadata?: unknown; - }; + readonly create: boolean + readonly expires_at?: number + readonly metadata?: unknown + } /** * @description The purpose of the uploaded file. Possible values are `additional_verification`, `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `identity_document`, `pci_document`, or `tax_document_user_upload`. * @enum {string} */ readonly purpose: - | "additional_verification" - | "business_icon" - | "business_logo" - | "customer_signature" - | "dispute_evidence" - | "identity_document" - | "pci_document" - | "tax_document_user_upload"; - }; - }; - }; + | 'additional_verification' + | 'business_icon' + | 'business_logo' + | 'customer_signature' + | 'dispute_evidence' + | 'identity_document' + | 'pci_document' + | 'tax_document_user_upload' + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["file"]; - }; + readonly schema: definitions['file'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves the details of an existing file object. Supply the unique file ID from a file, and Stripe will return the corresponding file object. To access file contents, see the File Upload Guide.

*/ readonly GetFilesFile: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly file: string; - }; - }; + readonly file: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["file"]; - }; + readonly schema: definitions['file'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly GetInvoiceitems: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - readonly created?: number; + readonly expand?: readonly unknown[] + readonly created?: number /** The identifier of the customer whose invoice items to return. If none is provided, all invoice items will be returned. */ - readonly customer?: string; + readonly customer?: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** 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. */ - readonly invoice?: string; + readonly invoice?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** 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. */ - readonly pending?: boolean; + readonly pending?: boolean /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["invoiceitem"][]; + readonly data: readonly definitions['invoiceitem'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Creates an item to be added to a draft invoice. If no invoice is specified, the item will be on the next invoice created for the customer specified.

*/ readonly PostInvoiceitems: { readonly parameters: { @@ -17675,188 +17595,188 @@ export interface operations { /** Body parameters for the request. */ readonly payload: { /** @description The integer amount in **%s** of the charge to be applied to the upcoming invoice. Passing in a negative `amount` will reduce the `amount_due` on the invoice. */ - readonly amount?: number; + readonly amount?: number /** @description 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). */ - readonly currency?: string; + readonly currency?: string /** @description The ID of the customer who will be billed when this invoice item is billed. */ - readonly customer: string; + readonly customer: string /** @description An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking. */ - readonly description?: string; + readonly description?: string /** @description Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items. */ - readonly discountable?: boolean; + readonly discountable?: boolean /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The ID of an existing invoice to add this invoice item to. When left blank, the invoice item will be added to the next upcoming scheduled invoice. This is useful when adding invoice items in response to an invoice.created webhook. You can only add invoice items to draft invoices. */ - readonly invoice?: string; + readonly invoice?: string /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** * period * @description The period associated with this invoice item. */ readonly period?: { - readonly end: number; - readonly start: number; - }; + readonly end: number + readonly start: number + } /** @description Non-negative integer. The quantity of units for the invoice item. */ - readonly quantity?: number; + readonly quantity?: number /** @description The ID of a subscription to add this invoice item to. When left blank, the invoice item will be be added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription. */ - readonly subscription?: string; + readonly subscription?: string /** @description 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. */ - readonly tax_rates?: readonly string[]; + readonly tax_rates?: readonly string[] /** @description The integer unit amount in **%s** of the charge to be applied to the upcoming invoice. This `unit_amount` will be multiplied by the quantity to get the full amount. Passing in a negative `unit_amount` will reduce the `amount_due` on the invoice. */ - readonly unit_amount?: number; + readonly unit_amount?: number /** @description Same as `unit_amount`, but accepts a decimal value with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. */ - readonly unit_amount_decimal?: string; - }; - }; - }; + readonly unit_amount_decimal?: string + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["invoiceitem"]; - }; + readonly schema: definitions['invoiceitem'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves the invoice item with the given ID.

*/ readonly GetInvoiceitemsInvoiceitem: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly invoiceitem: string; - }; - }; + readonly invoiceitem: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["invoiceitem"]; - }; + readonly schema: definitions['invoiceitem'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly PostInvoiceitemsInvoiceitem: { readonly parameters: { readonly path: { - readonly invoiceitem: string; - }; + readonly invoiceitem: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description The integer amount in **%s** of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount. */ - readonly amount?: number; + readonly amount?: number /** @description An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking. */ - readonly description?: string; + readonly description?: string /** @description Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items. Cannot be set to true for prorations. */ - readonly discountable?: boolean; + readonly discountable?: boolean /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** * period * @description The period associated with this invoice item. */ readonly period?: { - readonly end: number; - readonly start: number; - }; + readonly end: number + readonly start: number + } /** @description Non-negative integer. The quantity of units for the invoice item. */ - readonly quantity?: number; + readonly quantity?: number /** @description 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. Pass an empty string to remove previously-defined tax rates. */ - readonly tax_rates?: readonly string[]; + readonly tax_rates?: readonly string[] /** @description The integer unit amount in **%s** of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount. */ - readonly unit_amount?: number; + readonly unit_amount?: number /** @description Same as `unit_amount`, but accepts a decimal value with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. */ - readonly unit_amount_decimal?: string; - }; - }; - }; + readonly unit_amount_decimal?: string + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["invoiceitem"]; - }; + readonly schema: definitions['invoiceitem'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly DeleteInvoiceitemsInvoiceitem: { readonly parameters: { readonly path: { - readonly invoiceitem: string; - }; - }; + readonly invoiceitem: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["deleted_invoiceitem"]; - }; + readonly schema: definitions['deleted_invoiceitem'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly GetInvoices: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** The collection method of the invoice to retrieve. Either `charge_automatically` or `send_invoice`. */ - readonly collection_method?: string; - readonly created?: number; + readonly collection_method?: string + readonly created?: number /** Only return invoices for the customer specified by this customer ID. */ - readonly customer?: string; - readonly due_date?: number; + readonly customer?: string + readonly due_date?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview) */ - readonly status?: string; + readonly status?: string /** Only return invoices for the subscription specified by this subscription ID. */ - readonly subscription?: string; - }; - }; + readonly subscription?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["invoice"][]; + readonly data: readonly definitions['invoice'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

This endpoint creates a draft invoice for a given customer. The draft invoice created pulls in all pending invoice items on that customer, including prorations.

*/ readonly PostInvoices: { readonly parameters: { @@ -17864,59 +17784,59 @@ export interface operations { /** Body parameters for the request. */ readonly payload: { /** @description A fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#invoices). */ - readonly application_fee_amount?: number; + readonly application_fee_amount?: number /** @description Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice. When `false`, the invoice's state will not automatically advance without an explicit action. */ - readonly auto_advance?: boolean; + readonly auto_advance?: boolean /** * @description 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. Defaults to `charge_automatically`. * @enum {string} */ - readonly collection_method?: "charge_automatically" | "send_invoice"; + readonly collection_method?: 'charge_automatically' | 'send_invoice' /** @description A list of up to 4 custom fields to be displayed on the invoice. */ readonly custom_fields?: readonly { - readonly name: string; - readonly value: string; - }[]; + readonly name: string + readonly value: string + }[] /** @description The ID of the customer who will be billed. */ - readonly customer: string; + readonly customer: string /** @description The number of days from when the invoice is created until it is due. Valid only for invoices where `collection_method=send_invoice`. */ - readonly days_until_due?: number; + readonly days_until_due?: number /** @description 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. */ - readonly default_payment_method?: string; + readonly default_payment_method?: string /** @description 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. */ - readonly default_source?: string; + readonly default_source?: string /** @description The tax rates that will apply to any line item that does not have `tax_rates` set. */ - readonly default_tax_rates?: readonly string[]; + readonly default_tax_rates?: readonly string[] /** @description An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. */ - readonly description?: string; + readonly description?: string /** @description The date on which payment for this invoice is due. Valid only for invoices where `collection_method=send_invoice`. */ - readonly due_date?: number; + readonly due_date?: number /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description Footer to be displayed on the invoice. */ - readonly footer?: string; + readonly footer?: string /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`. */ - readonly statement_descriptor?: string; + readonly statement_descriptor?: string /** @description The ID of the subscription to invoice, if any. If not set, the created invoice will include all pending invoice items for the customer. If set, the created invoice will only include pending invoice items for that subscription and pending invoice items not associated with any subscription. The subscription's billing cycle and regular subscription events won't be affected. */ - readonly subscription?: string; + readonly subscription?: string /** @description The percent tax rate applied to the invoice, represented as a decimal number. This field has been deprecated and will be removed in a future API version, for further information view the [migration docs](https://stripe.com/docs/billing/migration/taxes) for `tax_rates`. */ - readonly tax_percent?: number; - }; - }; - }; + readonly tax_percent?: number + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["invoice"]; - }; + readonly schema: definitions['invoice'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discount that is applicable to the customer.

* @@ -17928,31 +17848,31 @@ export interface operations { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** The code of the coupon to apply. If `subscription` or `subscription_items` is provided, the invoice returned will preview updating or creating a subscription with that coupon. Otherwise, it will preview applying that coupon to the customer for the next upcoming invoice from among the customer's subscriptions. The invoice can be previewed without a coupon by passing this value as an empty string. */ - readonly coupon?: string; + readonly coupon?: string /** The identifier of the customer whose upcoming invoice you'd like to retrieve. */ - readonly customer?: string; + readonly customer?: string /** List of invoice items to add or update in the upcoming invoice preview. */ - readonly invoice_items?: readonly unknown[]; + readonly invoice_items?: readonly unknown[] /** The identifier of the unstarted schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields. */ - readonly schedule?: string; + readonly schedule?: string /** The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions. */ - readonly subscription?: string; + readonly subscription?: string /** 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`. */ - readonly subscription_billing_cycle_anchor?: string; + readonly subscription_billing_cycle_anchor?: string /** Timestamp indicating when the subscription should be scheduled to cancel. Will prorate if within the current period and prorations have been enabled using `proration_behavior`.` */ - readonly subscription_cancel_at?: string; + readonly subscription_cancel_at?: string /** Boolean indicating whether this subscription should cancel at the end of the current period. */ - readonly subscription_cancel_at_period_end?: boolean; + readonly subscription_cancel_at_period_end?: boolean /** This simulates the subscription being canceled or expired immediately. */ - readonly subscription_cancel_now?: boolean; + readonly subscription_cancel_now?: boolean /** 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. */ - readonly subscription_default_tax_rates?: string; + readonly subscription_default_tax_rates?: string /** List of subscription items, each with an attached plan. */ - readonly subscription_items?: readonly unknown[]; + readonly subscription_items?: readonly unknown[] /** This field has been renamed to `subscription_proration_behavior`. `subscription_prorate=true` can be replaced with `subscription_proration_behavior=create_prorations` and `subscription_prorate=false` can be replaced with `subscription_proration_behavior=none`. */ - readonly subscription_prorate?: boolean; + readonly subscription_prorate?: boolean /** * Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -17960,66 +17880,66 @@ export interface operations { * * Prorations can be disabled by passing `none`. */ - readonly subscription_proration_behavior?: string; + readonly subscription_proration_behavior?: string /** 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 cannot be before the subscription was on its current plan. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration` cannot be set to false. */ - readonly subscription_proration_date?: number; + readonly subscription_proration_date?: number /** Date a subscription is intended to start (can be future or past) */ - readonly subscription_start_date?: number; + readonly subscription_start_date?: number /** If provided, the invoice returned will preview updating or creating a subscription with that tax percent. If set, one of `subscription_items` or `subscription` is required. This field has been deprecated and will be removed in a future API version, for further information view the [migration docs](https://stripe.com/docs/billing/migration/taxes) for `tax_rates`. */ - readonly subscription_tax_percent?: number; + readonly subscription_tax_percent?: number /** 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. */ - readonly subscription_trial_end?: string; + readonly subscription_trial_end?: string /** Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `subscription_trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `subscription_trial_end` is not allowed. */ - readonly subscription_trial_from_plan?: boolean; - }; - }; + readonly subscription_trial_from_plan?: boolean + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["invoice"]; - }; + readonly schema: definitions['invoice'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly GetInvoicesUpcomingLines: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** The code of the coupon to apply. If `subscription` or `subscription_items` is provided, the invoice returned will preview updating or creating a subscription with that coupon. Otherwise, it will preview applying that coupon to the customer for the next upcoming invoice from among the customer's subscriptions. The invoice can be previewed without a coupon by passing this value as an empty string. */ - readonly coupon?: string; + readonly coupon?: string /** The identifier of the customer whose upcoming invoice you'd like to retrieve. */ - readonly customer?: string; + readonly customer?: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** List of invoice items to add or update in the upcoming invoice preview. */ - readonly invoice_items?: readonly unknown[]; + readonly invoice_items?: readonly unknown[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** The identifier of the unstarted schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields. */ - readonly schedule?: string; + readonly schedule?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions. */ - readonly subscription?: string; + readonly subscription?: string /** 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`. */ - readonly subscription_billing_cycle_anchor?: string; + readonly subscription_billing_cycle_anchor?: string /** Timestamp indicating when the subscription should be scheduled to cancel. Will prorate if within the current period and prorations have been enabled using `proration_behavior`.` */ - readonly subscription_cancel_at?: string; + readonly subscription_cancel_at?: string /** Boolean indicating whether this subscription should cancel at the end of the current period. */ - readonly subscription_cancel_at_period_end?: boolean; + readonly subscription_cancel_at_period_end?: boolean /** This simulates the subscription being canceled or expired immediately. */ - readonly subscription_cancel_now?: boolean; + readonly subscription_cancel_now?: boolean /** 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. */ - readonly subscription_default_tax_rates?: string; + readonly subscription_default_tax_rates?: string /** List of subscription items, each with an attached plan. */ - readonly subscription_items?: readonly unknown[]; + readonly subscription_items?: readonly unknown[] /** If previewing an update to a subscription, this decides whether the preview will show the result of applying prorations or not. If set, one of `subscription_items` or `subscription`, and one of `subscription_items` or `subscription_trial_end` are required. */ - readonly subscription_prorate?: boolean; + readonly subscription_prorate?: boolean /** * Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -18027,64 +17947,64 @@ export interface operations { * * Prorations can be disabled by passing `none`. */ - readonly subscription_proration_behavior?: string; + readonly subscription_proration_behavior?: string /** 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 cannot be before the subscription was on its current plan. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration` cannot be set to false. */ - readonly subscription_proration_date?: number; + readonly subscription_proration_date?: number /** Date a subscription is intended to start (can be future or past) */ - readonly subscription_start_date?: number; + readonly subscription_start_date?: number /** If provided, the invoice returned will preview updating or creating a subscription with that tax percent. If set, one of `subscription_items` or `subscription` is required. This field has been deprecated and will be removed in a future API version, for further information view the [migration docs](https://stripe.com/docs/billing/migration/taxes) for `tax_rates`. */ - readonly subscription_tax_percent?: number; + readonly subscription_tax_percent?: number /** 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. */ - readonly subscription_trial_end?: string; + readonly subscription_trial_end?: string /** Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `subscription_trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `subscription_trial_end` is not allowed. */ - readonly subscription_trial_from_plan?: boolean; - }; - }; + readonly subscription_trial_from_plan?: boolean + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { /** @description Details about each object. */ - readonly data: readonly definitions["line_item"][]; + readonly data: readonly definitions['line_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves the invoice with the given ID.

*/ readonly GetInvoicesInvoice: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly invoice: string; - }; - }; + readonly invoice: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["invoice"]; - }; + readonly schema: definitions['invoice'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

Draft invoices are fully editable. Once an invoice is finalized, * monetary values, as well as collection_method, become uneditable.

@@ -18096,210 +18016,210 @@ export interface operations { readonly PostInvoicesInvoice: { readonly parameters: { readonly path: { - readonly invoice: string; - }; + readonly invoice: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description A fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#invoices). */ - readonly application_fee_amount?: number; + readonly application_fee_amount?: number /** @description Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice. */ - readonly auto_advance?: boolean; + readonly auto_advance?: boolean /** * @description Either `charge_automatically` or `send_invoice`. This field can be updated only on `draft` invoices. * @enum {string} */ - readonly collection_method?: "charge_automatically" | "send_invoice"; + readonly collection_method?: 'charge_automatically' | 'send_invoice' /** @description A list of up to 4 custom fields to be displayed on the invoice. If a value for `custom_fields` is specified, the list specified will replace the existing custom field list on this invoice. Pass an empty string to remove previously-defined fields. */ readonly custom_fields?: readonly { - readonly name: string; - readonly value: string; - }[]; + readonly name: string + readonly value: string + }[] /** @description The number of days from which the invoice is created until it is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices. */ - readonly days_until_due?: number; + readonly days_until_due?: number /** @description 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. */ - readonly default_payment_method?: string; + readonly default_payment_method?: string /** @description 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. */ - readonly default_source?: string; + readonly default_source?: string /** @description The tax rates that will apply to any line item that does not have `tax_rates` set. Pass an empty string to remove previously-defined tax rates. */ - readonly default_tax_rates?: readonly string[]; + readonly default_tax_rates?: readonly string[] /** @description An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. */ - readonly description?: string; + readonly description?: string /** @description The date on which payment for this invoice is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices. */ - readonly due_date?: number; + readonly due_date?: number /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description Footer to be displayed on the invoice. */ - readonly footer?: string; + readonly footer?: string /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`. */ - readonly statement_descriptor?: string; + readonly statement_descriptor?: string /** @description The percent tax rate applied to the invoice, represented as a non-negative decimal number (with at most four decimal places) between 0 and 100. To unset a previously-set value, pass an empty string. This field can be updated only on `draft` invoices. This field has been deprecated and will be removed in a future API version, for further information view the [migration docs](https://stripe.com/docs/billing/migration/taxes) for `tax_rates`. */ - readonly tax_percent?: unknown; - }; - }; - }; + readonly tax_percent?: unknown + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["invoice"]; - }; + readonly schema: definitions['invoice'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly DeleteInvoicesInvoice: { readonly parameters: { readonly path: { - readonly invoice: string; - }; - }; + readonly invoice: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["deleted_invoice"]; - }; + readonly schema: definitions['deleted_invoice'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly PostInvoicesInvoiceFinalize: { readonly parameters: { readonly path: { - readonly invoice: string; - }; + readonly invoice: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice. When `false`, the invoice's state will not automatically advance without an explicit action. */ - readonly auto_advance?: boolean; + readonly auto_advance?: boolean /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["invoice"]; - }; + readonly schema: definitions['invoice'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly GetInvoicesInvoiceLines: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; + readonly starting_after?: string + } readonly path: { - readonly invoice: string; - }; - }; + readonly invoice: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { /** @description Details about each object. */ - readonly data: readonly definitions["line_item"][]; + readonly data: readonly definitions['line_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly PostInvoicesInvoiceMarkUncollectible: { readonly parameters: { readonly path: { - readonly invoice: string; - }; + readonly invoice: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["invoice"]; - }; + readonly schema: definitions['invoice'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly PostInvoicesInvoicePay: { readonly parameters: { readonly path: { - readonly invoice: string; - }; + readonly invoice: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** * @description In cases where the source used to pay the invoice has insufficient funds, passing `forgive=true` controls whether a charge should be attempted for the full amount available on the source, up to the amount to fully pay the invoice. This effectively forgives the difference between the amount available on the source and the amount due. * * Passing `forgive=false` will fail the charge if the source hasn't been pre-funded with the right amount. An example for this case is with ACH Credit Transfers and wires: if the amount wired is less than the amount due by a small amount, you might want to forgive the difference. */ - readonly forgive?: boolean; + readonly forgive?: boolean /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. */ - readonly off_session?: boolean; + readonly off_session?: boolean /** @description Boolean representing whether an invoice is paid outside of Stripe. This will result in no charge being made. */ - readonly paid_out_of_band?: boolean; + readonly paid_out_of_band?: boolean /** @description A PaymentMethod to be charged. The PaymentMethod must be the ID of a PaymentMethod belonging to the customer associated with the invoice being paid. */ - readonly payment_method?: string; + readonly payment_method?: string /** @description A payment source to be charged. The source must be the ID of a source belonging to the customer associated with the invoice being paid. */ - readonly source?: string; - }; - }; - }; + readonly source?: string + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["invoice"]; - }; + readonly schema: definitions['invoice'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

Stripe will automatically send invoices to customers according to your subscriptions settings. However, if you’d like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.

* @@ -18308,90 +18228,90 @@ export interface operations { readonly PostInvoicesInvoiceSend: { readonly parameters: { readonly path: { - readonly invoice: string; - }; + readonly invoice: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["invoice"]; - }; + readonly schema: definitions['invoice'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.

*/ readonly PostInvoicesInvoiceVoid: { readonly parameters: { readonly path: { - readonly invoice: string; - }; + readonly invoice: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["invoice"]; - }; + readonly schema: definitions['invoice'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Returns a list of issuer fraud records.

*/ readonly GetIssuerFraudRecords: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** Only return issuer fraud records for the charge specified by this charge ID. */ - readonly charge?: string; + readonly charge?: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["issuer_fraud_record"][]; + readonly data: readonly definitions['issuer_fraud_record'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

Retrieves the details of an issuer fraud record that has previously been created.

* @@ -18401,218 +18321,218 @@ export interface operations { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly issuer_fraud_record: string; - }; - }; + readonly issuer_fraud_record: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["issuer_fraud_record"]; - }; + readonly schema: definitions['issuer_fraud_record'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly GetIssuingAuthorizations: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** Only return issuing transactions that belong to the given card. */ - readonly card?: string; + readonly card?: string /** Only return authorizations belonging to the given cardholder. */ - readonly cardholder?: string; + readonly cardholder?: string /** Only return authorizations that were created during the given date interval. */ - readonly created?: number; + readonly created?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** Only return authorizations with the given status. One of `pending`, `closed`, or `reversed`. */ - readonly status?: string; - }; - }; + readonly status?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["issuing.authorization"][]; + readonly data: readonly definitions['issuing.authorization'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves an Issuing Authorization object.

*/ readonly GetIssuingAuthorizationsAuthorization: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly authorization: string; - }; - }; + readonly authorization: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["issuing.authorization"]; - }; + readonly schema: definitions['issuing.authorization'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly PostIssuingAuthorizationsAuthorization: { readonly parameters: { readonly path: { - readonly authorization: string; - }; + readonly authorization: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; - }; - }; - }; + readonly metadata?: unknown + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["issuing.authorization"]; - }; + readonly schema: definitions['issuing.authorization'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Approves a pending Issuing Authorization object. This request should be made within the timeout window of the real-time authorization flow.

*/ readonly PostIssuingAuthorizationsAuthorizationApprove: { readonly parameters: { readonly path: { - readonly authorization: string; - }; + readonly authorization: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description If the authorization's `pending_request.is_amount_controllable` property is `true`, you may provide this value to control how much to hold for the authorization. Must be positive (use [`decline`](https://stripe.com/docs/api/issuing/authorizations/decline) to decline an authorization request). */ - readonly amount?: number; + readonly amount?: number /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; - }; - }; - }; + readonly metadata?: unknown + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["issuing.authorization"]; - }; + readonly schema: definitions['issuing.authorization'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Declines a pending Issuing Authorization object. This request should be made within the timeout window of the real time authorization flow.

*/ readonly PostIssuingAuthorizationsAuthorizationDecline: { readonly parameters: { readonly path: { - readonly authorization: string; - }; + readonly authorization: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; - }; - }; - }; + readonly metadata?: unknown + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["issuing.authorization"]; - }; + readonly schema: definitions['issuing.authorization'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly GetIssuingCardholders: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** Only return cardholders that were created during the given date interval. */ - readonly created?: number; + readonly created?: number /** Only return cardholders that have the given email address. */ - readonly email?: string; + readonly email?: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** Only return cardholders that have the given phone number. */ - readonly phone_number?: string; + readonly phone_number?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** Only return cardholders that have the given status. One of `active`, `inactive`, or `blocked`. */ - readonly status?: string; + readonly status?: string /** Only return cardholders that have the given type. One of `individual` or `company`. */ - readonly type?: string; - }; - }; + readonly type?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["issuing.cardholder"][]; + readonly data: readonly definitions['issuing.cardholder'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly PostIssuingCardholders: { readonly parameters: { @@ -18626,25 +18546,25 @@ export interface operations { readonly billing: { /** required_address */ readonly address: { - readonly city: string; - readonly country: string; - readonly line1: string; - readonly line2?: string; - readonly postal_code: string; - readonly state?: string; - }; - }; + readonly city: string + readonly country: string + readonly line1: string + readonly line2?: string + readonly postal_code: string + readonly state?: string + } + } /** * company_param * @description Additional information about a `company` cardholder. */ readonly company?: { - readonly tax_id?: string; - }; + readonly tax_id?: string + } /** @description The cardholder's email address. */ - readonly email?: string; + readonly email?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** * individual_param * @description Additional information about an `individual` cardholder. @@ -18652,961 +18572,961 @@ export interface operations { readonly individual?: { /** date_of_birth_specs */ readonly dob?: { - readonly day: number; - readonly month: number; - readonly year: number; - }; - readonly first_name: string; - readonly last_name: string; + readonly day: number + readonly month: number + readonly year: number + } + readonly first_name: string + readonly last_name: string /** person_verification_param */ readonly verification?: { /** person_verification_document_param */ readonly document?: { - readonly back?: string; - readonly front?: string; - }; - }; - }; + readonly back?: string + readonly front?: string + } + } + } /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: { readonly [key: string]: unknown }; + readonly metadata?: { readonly [key: string]: unknown } /** @description The cardholder's name. This will be printed on cards issued to them. */ - readonly name: string; + readonly name: string /** @description The cardholder's phone number. This will be transformed to [E.164](https://en.wikipedia.org/wiki/E.164) if it is not provided in that format already. */ - readonly phone_number?: string; + readonly phone_number?: string /** * authorization_controls_param_v2 * @description Spending rules that give you control over how your cardholders can make charges. Refer to our [authorizations](https://stripe.com/docs/issuing/purchases/authorizations) documentation for more details. */ readonly spending_controls?: { readonly allowed_categories?: readonly ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] readonly blocked_categories?: readonly ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] readonly spending_limits?: readonly { - readonly amount: number; + readonly amount: number readonly categories?: readonly ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] /** @enum {string} */ - readonly interval: "all_time" | "daily" | "monthly" | "per_authorization" | "weekly" | "yearly"; - }[]; - readonly spending_limits_currency?: string; - }; + readonly interval: 'all_time' | 'daily' | 'monthly' | 'per_authorization' | 'weekly' | 'yearly' + }[] + readonly spending_limits_currency?: string + } /** * @description Specifies whether to permit authorizations on this cardholder's cards. Defaults to `active`. * @enum {string} */ - readonly status?: "active" | "inactive"; + readonly status?: 'active' | 'inactive' /** * @description One of `individual` or `company`. * @enum {string} */ - readonly type: "company" | "individual"; - }; - }; - }; + readonly type: 'company' | 'individual' + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["issuing.cardholder"]; - }; + readonly schema: definitions['issuing.cardholder'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves an Issuing Cardholder object.

*/ readonly GetIssuingCardholdersCardholder: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly cardholder: string; - }; - }; + readonly cardholder: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["issuing.cardholder"]; - }; + readonly schema: definitions['issuing.cardholder'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly PostIssuingCardholdersCardholder: { readonly parameters: { readonly path: { - readonly cardholder: string; - }; + readonly cardholder: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { @@ -19617,25 +19537,25 @@ export interface operations { readonly billing?: { /** required_address */ readonly address: { - readonly city: string; - readonly country: string; - readonly line1: string; - readonly line2?: string; - readonly postal_code: string; - readonly state?: string; - }; - }; + readonly city: string + readonly country: string + readonly line1: string + readonly line2?: string + readonly postal_code: string + readonly state?: string + } + } /** * company_param * @description Additional information about a `company` cardholder. */ readonly company?: { - readonly tax_id?: string; - }; + readonly tax_id?: string + } /** @description The cardholder's email address. */ - readonly email?: string; + readonly email?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** * individual_param * @description Additional information about an `individual` cardholder. @@ -19643,976 +19563,976 @@ export interface operations { readonly individual?: { /** date_of_birth_specs */ readonly dob?: { - readonly day: number; - readonly month: number; - readonly year: number; - }; - readonly first_name: string; - readonly last_name: string; + readonly day: number + readonly month: number + readonly year: number + } + readonly first_name: string + readonly last_name: string /** person_verification_param */ readonly verification?: { /** person_verification_document_param */ readonly document?: { - readonly back?: string; - readonly front?: string; - }; - }; - }; + readonly back?: string + readonly front?: string + } + } + } /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: { readonly [key: string]: unknown }; + readonly metadata?: { readonly [key: string]: unknown } /** @description The cardholder's phone number. */ - readonly phone_number?: string; + readonly phone_number?: string /** * authorization_controls_param_v2 * @description Spending rules that give you some control over how your cards can be used. Refer to our [authorizations](https://stripe.com/docs/issuing/purchases/authorizations) documentation for more details. */ readonly spending_controls?: { readonly allowed_categories?: readonly ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] readonly blocked_categories?: readonly ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] readonly spending_limits?: readonly { - readonly amount: number; + readonly amount: number readonly categories?: readonly ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] /** @enum {string} */ - readonly interval: "all_time" | "daily" | "monthly" | "per_authorization" | "weekly" | "yearly"; - }[]; - readonly spending_limits_currency?: string; - }; + readonly interval: 'all_time' | 'daily' | 'monthly' | 'per_authorization' | 'weekly' | 'yearly' + }[] + readonly spending_limits_currency?: string + } /** * @description Specifies whether to permit authorizations on this cardholder's cards. * @enum {string} */ - readonly status?: "active" | "inactive"; - }; - }; - }; + readonly status?: 'active' | 'inactive' + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["issuing.cardholder"]; - }; + readonly schema: definitions['issuing.cardholder'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly GetIssuingCards: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** Only return cards belonging to the Cardholder with the provided ID. */ - readonly cardholder?: string; + readonly cardholder?: string /** Only return cards that were issued during the given date interval. */ - readonly created?: number; + readonly created?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Only return cards that have the given expiration month. */ - readonly exp_month?: number; + readonly exp_month?: number /** Only return cards that have the given expiration year. */ - readonly exp_year?: number; + readonly exp_year?: number /** Only return cards that have the given last four digits. */ - readonly last4?: string; + readonly last4?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** Only return cards that have the given status. One of `active`, `inactive`, or `canceled`. */ - readonly status?: string; + readonly status?: string /** Only return cards that have the given type. One of `virtual` or `physical`. */ - readonly type?: string; - }; - }; + readonly type?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["issuing.card"][]; + readonly data: readonly definitions['issuing.card'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Creates an Issuing Card object.

*/ readonly PostIssuingCards: { readonly parameters: { @@ -20620,20 +20540,20 @@ export interface operations { /** Body parameters for the request. */ readonly payload: { /** @description The [Cardholder](https://stripe.com/docs/api#issuing_cardholder_object) object with which the card will be associated. */ - readonly cardholder?: string; + readonly cardholder?: string /** @description The currency for the card. This currently must be `usd`. */ - readonly currency: string; + readonly currency: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: { readonly [key: string]: unknown }; + readonly metadata?: { readonly [key: string]: unknown } /** @description The card this is meant to be a replacement for (if any). */ - readonly replacement_for?: string; + readonly replacement_for?: string /** * @description If `replacement_for` is specified, this should indicate why that card is being replaced. * @enum {string} */ - readonly replacement_reason?: "damaged" | "expired" | "lost" | "stolen"; + readonly replacement_reason?: 'damaged' | 'expired' | 'lost' | 'stolen' /** * shipping_specs * @description The address where the card will be shipped. @@ -20641,952 +20561,952 @@ export interface operations { readonly shipping?: { /** required_address */ readonly address: { - readonly city: string; - readonly country: string; - readonly line1: string; - readonly line2?: string; - readonly postal_code: string; - readonly state?: string; - }; - readonly name: string; + readonly city: string + readonly country: string + readonly line1: string + readonly line2?: string + readonly postal_code: string + readonly state?: string + } + readonly name: string /** @enum {string} */ - readonly service?: "express" | "priority" | "standard"; + readonly service?: 'express' | 'priority' | 'standard' /** @enum {string} */ - readonly type?: "bulk" | "individual"; - }; + readonly type?: 'bulk' | 'individual' + } /** * authorization_controls_param * @description Spending rules that give you some control over how your cards can be used. Refer to our [authorizations](https://stripe.com/docs/issuing/purchases/authorizations) documentation for more details. */ readonly spending_controls?: { readonly allowed_categories?: readonly ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] readonly blocked_categories?: readonly ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] readonly spending_limits?: readonly { - readonly amount: number; + readonly amount: number readonly categories?: readonly ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] /** @enum {string} */ - readonly interval: "all_time" | "daily" | "monthly" | "per_authorization" | "weekly" | "yearly"; - }[]; - }; + readonly interval: 'all_time' | 'daily' | 'monthly' | 'per_authorization' | 'weekly' | 'yearly' + }[] + } /** * @description Whether authorizations can be approved on this card. Defaults to `inactive`. * @enum {string} */ - readonly status?: "active" | "inactive"; + readonly status?: 'active' | 'inactive' /** * @description The type of card to issue. Possible values are `physical` or `virtual`. * @enum {string} */ - readonly type: "physical" | "virtual"; - }; - }; - }; + readonly type: 'physical' | 'virtual' + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["issuing.card"]; - }; + readonly schema: definitions['issuing.card'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves an Issuing Card object.

*/ readonly GetIssuingCardsCard: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly card: string; - }; - }; + readonly card: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["issuing.card"]; - }; + readonly schema: definitions['issuing.card'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly PostIssuingCardsCard: { readonly parameters: { readonly path: { - readonly card: string; - }; + readonly card: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { @@ -21594,947 +21514,947 @@ export interface operations { * @description Reason why the `status` of this card is `canceled`. * @enum {string} */ - readonly cancellation_reason?: "lost" | "stolen"; + readonly cancellation_reason?: 'lost' | 'stolen' /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** * authorization_controls_param * @description Spending rules that give you some control over how your cards can be used. Refer to our [authorizations](https://stripe.com/docs/issuing/purchases/authorizations) documentation for more details. */ readonly spending_controls?: { readonly allowed_categories?: readonly ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] readonly blocked_categories?: readonly ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] readonly spending_limits?: readonly { - readonly amount: number; + readonly amount: number readonly categories?: readonly ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] /** @enum {string} */ - readonly interval: "all_time" | "daily" | "monthly" | "per_authorization" | "weekly" | "yearly"; - }[]; - }; + readonly interval: 'all_time' | 'daily' | 'monthly' | 'per_authorization' | 'weekly' | 'yearly' + }[] + } /** * @description Dictates whether authorizations can be approved on this card. If this card is being canceled because it was lost or stolen, this information should be provided as `cancellation_reason`. * @enum {string} */ - readonly status?: "active" | "canceled" | "inactive"; - }; - }; - }; + readonly status?: 'active' | 'canceled' | 'inactive' + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["issuing.card"]; - }; + readonly schema: definitions['issuing.card'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly GetIssuingDisputes: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["issuing.dispute"][]; + readonly data: readonly definitions['issuing.dispute'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Creates an Issuing Dispute object.

*/ readonly PostIssuingDisputes: { readonly parameters: { @@ -22542,382 +22462,382 @@ export interface operations { /** Body parameters for the request. */ readonly payload?: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: { readonly [key: string]: unknown }; - }; - }; - }; + readonly metadata?: { readonly [key: string]: unknown } + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["issuing.dispute"]; - }; + readonly schema: definitions['issuing.dispute'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves an Issuing Dispute object.

*/ readonly GetIssuingDisputesDispute: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly dispute: string; - }; - }; + readonly dispute: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["issuing.dispute"]; - }; + readonly schema: definitions['issuing.dispute'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly PostIssuingDisputesDispute: { readonly parameters: { readonly path: { - readonly dispute: string; - }; + readonly dispute: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: { readonly [key: string]: unknown }; - }; - }; - }; + readonly metadata?: { readonly [key: string]: unknown } + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["issuing.dispute"]; - }; + readonly schema: definitions['issuing.dispute'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly GetIssuingSettlements: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** Only return issuing settlements that were created during the given date interval. */ - readonly created?: number; + readonly created?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["issuing.settlement"][]; + readonly data: readonly definitions['issuing.settlement'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves an Issuing Settlement object.

*/ readonly GetIssuingSettlementsSettlement: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly settlement: string; - }; - }; + readonly settlement: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["issuing.settlement"]; - }; + readonly schema: definitions['issuing.settlement'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly PostIssuingSettlementsSettlement: { readonly parameters: { readonly path: { - readonly settlement: string; - }; + readonly settlement: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: { readonly [key: string]: unknown }; - }; - }; - }; + readonly metadata?: { readonly [key: string]: unknown } + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["issuing.settlement"]; - }; + readonly schema: definitions['issuing.settlement'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly GetIssuingTransactions: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** Only return transactions that belong to the given card. */ - readonly card?: string; + readonly card?: string /** Only return transactions that belong to the given cardholder. */ - readonly cardholder?: string; + readonly cardholder?: string /** Only return transactions that were created during the given date interval. */ - readonly created?: number; + readonly created?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["issuing.transaction"][]; + readonly data: readonly definitions['issuing.transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves an Issuing Transaction object.

*/ readonly GetIssuingTransactionsTransaction: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly transaction: string; - }; - }; + readonly transaction: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["issuing.transaction"]; - }; + readonly schema: definitions['issuing.transaction'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly PostIssuingTransactionsTransaction: { readonly parameters: { readonly path: { - readonly transaction: string; - }; + readonly transaction: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; - }; - }; - }; + readonly metadata?: unknown + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["issuing.transaction"]; - }; + readonly schema: definitions['issuing.transaction'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves a Mandate object.

*/ readonly GetMandatesMandate: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly mandate: string; - }; - }; + readonly mandate: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["mandate"]; - }; + readonly schema: definitions['mandate'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly GetOrderReturns: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** Date this return was created. */ - readonly created?: number; + readonly created?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** The order to retrieve returns for. */ - readonly order?: string; + readonly order?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["order_return"][]; + readonly data: readonly definitions['order_return'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly GetOrderReturnsId: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["order_return"]; - }; + readonly schema: definitions['order_return'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly GetOrders: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** Date this order was created. */ - readonly created?: number; + readonly created?: number /** Only return orders for the given customer. */ - readonly customer?: string; + readonly customer?: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** Only return orders with the given IDs. */ - readonly ids?: readonly unknown[]; + readonly ids?: readonly unknown[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** Only return orders that have the given status. One of `created`, `paid`, `fulfilled`, or `refunded`. */ - readonly status?: string; + readonly status?: string /** Filter orders based on when they were paid, fulfilled, canceled, or returned. */ - readonly status_transitions?: string; + readonly status_transitions?: string /** Only return orders with the given upstream order IDs. */ - readonly upstream_ids?: readonly unknown[]; - }; - }; + readonly upstream_ids?: readonly unknown[] + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["order"][]; + readonly data: readonly definitions['order'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Creates a new order object.

*/ readonly PostOrders: { readonly parameters: { @@ -22925,27 +22845,27 @@ export interface operations { /** Body parameters for the request. */ readonly payload: { /** @description A coupon code that represents a discount to be applied to this order. Must be one-time duration and in same currency as the order. An order can have multiple coupons. */ - readonly coupon?: string; + readonly coupon?: string /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description The ID of an existing customer to use for this order. If provided, the customer email and shipping address will be used to create the order. Subsequently, the customer will also be charged to pay the order. If `email` or `shipping` are also provided, they will override the values retrieved from the customer object. */ - readonly customer?: string; + readonly customer?: string /** @description The email address of the customer placing the order. */ - readonly email?: string; + readonly email?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description List of items constituting the order. An order can have up to 25 items. */ readonly items?: readonly { - readonly amount?: number; - readonly currency?: string; - readonly description?: string; - readonly parent?: string; - readonly quantity?: number; + readonly amount?: number + readonly currency?: string + readonly description?: string + readonly parent?: string + readonly quantity?: number /** @enum {string} */ - readonly type?: "discount" | "shipping" | "sku" | "tax"; - }[]; + readonly type?: 'discount' | 'shipping' | 'sku' | 'tax' + }[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: { readonly [key: string]: unknown }; + readonly metadata?: { readonly [key: string]: unknown } /** * customer_shipping * @description Shipping address for the order. Required if any of the SKUs are for products that have `shippable` set to true. @@ -22953,205 +22873,205 @@ export interface operations { readonly shipping?: { /** address */ readonly address: { - readonly city?: string; - readonly country?: string; - readonly line1: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; - readonly name: string; - readonly phone?: string; - }; - }; - }; - }; - readonly responses: { - /** Successful response. */ - readonly 200: { - readonly schema: definitions["order"]; - }; - /** Error response. */ - readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly city?: string + readonly country?: string + readonly line1: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } + readonly name: string + readonly phone?: string + } + } + } + } + readonly responses: { + /** Successful response. */ + readonly 200: { + readonly schema: definitions['order'] + } + /** Error response. */ + readonly default: { + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly GetOrdersId: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["order"]; - }; + readonly schema: definitions['order'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly PostOrdersId: { readonly parameters: { readonly path: { - readonly id: string; - }; + readonly id: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description A coupon code that represents a discount to be applied to this order. Must be one-time duration and in same currency as the order. An order can have multiple coupons. */ - readonly coupon?: string; + readonly coupon?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description The shipping method to select for fulfilling this order. If specified, must be one of the `id`s of a shipping method in the `shipping_methods` array. If specified, will overwrite the existing selected shipping method, updating `items` as necessary. */ - readonly selected_shipping_method?: string; + readonly selected_shipping_method?: string /** * shipping_tracking_params * @description Tracking information once the order has been fulfilled. */ readonly shipping?: { - readonly carrier: string; - readonly tracking_number: string; - }; + readonly carrier: string + readonly tracking_number: string + } /** * @description Current order status. One of `created`, `paid`, `canceled`, `fulfilled`, or `returned`. More detail in the [Orders Guide](https://stripe.com/docs/orders/guide#understanding-order-statuses). * @enum {string} */ - readonly status?: "canceled" | "created" | "fulfilled" | "paid" | "returned"; - }; - }; - }; + readonly status?: 'canceled' | 'created' | 'fulfilled' | 'paid' | 'returned' + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["order"]; - }; + readonly schema: definitions['order'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Pay an order by providing a source to create a payment.

*/ readonly PostOrdersIdPay: { readonly parameters: { readonly path: { - readonly id: string; - }; + readonly id: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description A fee in %s that will be applied to the order and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the `Stripe-Account` header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees). */ - readonly application_fee?: number; + readonly application_fee?: number /** @description The ID of an existing customer that will be charged for this order. If no customer was attached to the order at creation, either `source` or `customer` is required. Otherwise, the specified customer will be charged instead of the one attached to the order. */ - readonly customer?: string; + readonly customer?: string /** @description The email address of the customer placing the order. Required if not previously specified for the order. */ - readonly email?: string; + readonly email?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: { readonly [key: string]: unknown }; + readonly metadata?: { readonly [key: string]: unknown } /** @description A [Token](https://stripe.com/docs/api#tokens)'s or a [Source](https://stripe.com/docs/api#sources)'s ID, as returned by [Elements](https://stripe.com/docs/elements). If no customer was attached to the order at creation, either `source` or `customer` is required. Otherwise, the specified source will be charged intead of the customer attached to the order. */ - readonly source?: string; - }; - }; - }; + readonly source?: string + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["order"]; - }; + readonly schema: definitions['order'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Return all or part of an order. The order must have a status of paid or fulfilled before it can be returned. Once all items have been returned, the order will become canceled or returned depending on which status the order started in.

*/ readonly PostOrdersIdReturns: { readonly parameters: { readonly path: { - readonly id: string; - }; + readonly id: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description List of items to return. */ readonly items?: readonly { - readonly amount?: number; - readonly description?: string; - readonly parent?: string; - readonly quantity?: number; + readonly amount?: number + readonly description?: string + readonly parent?: string + readonly quantity?: number /** @enum {string} */ - readonly type?: "discount" | "shipping" | "sku" | "tax"; - }[]; - }; - }; - }; + readonly type?: 'discount' | 'shipping' | 'sku' | 'tax' + }[] + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["order_return"]; - }; + readonly schema: definitions['order_return'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Returns a list of PaymentIntents.

*/ readonly GetPaymentIntents: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** 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. */ - readonly created?: number; + readonly created?: number /** Only return PaymentIntents for the customer specified by this customer ID. */ - readonly customer?: string; + readonly customer?: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["payment_intent"][]; + readonly data: readonly definitions['payment_intent'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

Creates a PaymentIntent object.

* @@ -23170,24 +23090,24 @@ export interface operations { /** Body parameters for the request. */ readonly payload: { /** @description 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). */ - readonly amount: number; + readonly amount: number /** * @description The amount of the application fee (if any) that will be applied to the * payment and transferred to the application owner's Stripe account. For * more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ - readonly application_fee_amount?: number; + readonly application_fee_amount?: number /** * @description Controls when the funds will be captured from the customer's account. * @enum {string} */ - readonly capture_method?: "automatic" | "manual"; + readonly capture_method?: 'automatic' | 'manual' /** @description Set to `true` to attempt to [confirm](https://stripe.com/docs/api/payment_intents/confirm) this PaymentIntent immediately. This parameter defaults to `false`. When creating and confirming a PaymentIntent at the same time, parameters available in the [confirm](https://stripe.com/docs/api/payment_intents/confirm) API may also be provided. */ - readonly confirm?: boolean; + readonly confirm?: boolean /** @enum {string} */ - readonly confirmation_method?: "automatic" | "manual"; + readonly confirmation_method?: 'automatic' | 'manual' /** @description 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). */ - readonly currency: string; + readonly currency: string /** * @description ID of the Customer this PaymentIntent belongs to, if one exists. * @@ -23195,15 +23115,15 @@ export interface operations { * * If present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. */ - readonly customer?: string; + readonly customer?: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string; + readonly description?: string /** @description Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. This parameter is intended for simpler integrations that do not handle customer actions, like [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). */ - readonly error_on_requires_action?: boolean; + readonly error_on_requires_action?: boolean /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description ID of the mandate to be used for this payment. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). */ - readonly mandate?: string; + readonly mandate?: string /** * secret_key_param * @description This hash contains details about the Mandate to create. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). @@ -23211,43 +23131,43 @@ export interface operations { readonly mandate_data?: { /** customer_acceptance_param */ readonly customer_acceptance: { - readonly accepted_at?: number; + readonly accepted_at?: number /** offline_param */ - readonly offline?: { readonly [key: string]: unknown }; + readonly offline?: { readonly [key: string]: unknown } /** online_param */ readonly online?: { - readonly ip_address: string; - readonly user_agent: string; - }; + readonly ip_address: string + readonly user_agent: string + } /** @enum {string} */ - readonly type: "offline" | "online"; - }; - }; + readonly type: 'offline' | 'online' + } + } /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: { readonly [key: string]: unknown }; + readonly metadata?: { readonly [key: string]: unknown } /** @description Set to `true` to indicate that the customer is not in your checkout flow during this payment attempt, and therefore is unable to authenticate. This parameter is intended for scenarios where you collect card details and [charge them later](https://stripe.com/docs/payments/cards/charging-saved-cards). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). */ - readonly off_session?: unknown; + readonly off_session?: unknown /** @description The Stripe account ID for which these funds are intended. For details, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ - readonly on_behalf_of?: string; + readonly on_behalf_of?: string /** * @description ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods#compatibility) object) to attach to this PaymentIntent. * * If this parameter is omitted with `confirm=true`, `customer.default_source` will be attached as this PaymentIntent's payment instrument to improve the migration experience for users of the Charges API. We recommend that you explicitly provide the `payment_method` going forward. */ - readonly payment_method?: string; + readonly payment_method?: string /** * payment_method_options_param * @description Payment-method-specific configuration for this PaymentIntent. */ readonly payment_method_options?: { - readonly card?: unknown; - }; + readonly card?: unknown + } /** @description The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. If this is not provided, defaults to ["card"]. */ - readonly payment_method_types?: readonly string[]; + readonly payment_method_types?: readonly string[] /** @description Email address that the receipt for the resulting payment will be sent to. */ - readonly receipt_email?: string; + readonly receipt_email?: string /** @description The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). */ - readonly return_url?: string; + readonly return_url?: string /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * @@ -23256,7 +23176,7 @@ export interface operations { * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ - readonly setup_future_usage?: "off_session" | "on_session"; + readonly setup_future_usage?: 'off_session' | 'on_session' /** * shipping * @description Shipping information for this PaymentIntent. @@ -23264,49 +23184,49 @@ export interface operations { readonly shipping?: { /** address */ readonly address: { - readonly city?: string; - readonly country?: string; - readonly line1: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; - readonly carrier?: string; - readonly name: string; - readonly phone?: string; - readonly tracking_number?: string; - }; + readonly city?: string + readonly country?: string + readonly line1: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } + readonly carrier?: string + readonly name: string + readonly phone?: string + readonly tracking_number?: string + } /** @description For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - readonly statement_descriptor?: string; + readonly statement_descriptor?: string /** @description Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - readonly statement_descriptor_suffix?: string; + readonly statement_descriptor_suffix?: string /** * transfer_data_creation_params * @description The parameters used to automatically create a Transfer when the payment succeeds. * For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ readonly transfer_data?: { - readonly amount?: number; - readonly destination: string; - }; + readonly amount?: number + readonly destination: string + } /** @description A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. */ - readonly transfer_group?: string; + readonly transfer_group?: string /** @description Set to `true` only when using manual confirmation and the iOS or Android SDKs to handle additional authentication steps. */ - readonly use_stripe_sdk?: boolean; - }; - }; - }; + readonly use_stripe_sdk?: boolean + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["payment_intent"]; - }; + readonly schema: definitions['payment_intent'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

Retrieves the details of a PaymentIntent that has previously been created.

* @@ -23318,25 +23238,25 @@ export interface operations { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** The client secret of the PaymentIntent. Required if a publishable key is used to retrieve the source. */ - readonly client_secret?: string; - }; + readonly client_secret?: string + } readonly path: { - readonly intent: string; - }; - }; + readonly intent: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["payment_intent"]; - }; + readonly schema: definitions['payment_intent'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

Updates properties on a PaymentIntent object without confirming.

* @@ -23349,17 +23269,17 @@ export interface operations { readonly PostPaymentIntentsIntent: { readonly parameters: { readonly path: { - readonly intent: string; - }; + readonly intent: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description 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). */ - readonly amount?: number; + readonly amount?: number /** @description The amount of the application fee (if any) for the resulting payment. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. */ - readonly application_fee_amount?: unknown; + readonly application_fee_amount?: unknown /** @description 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). */ - readonly currency?: string; + readonly currency?: string /** * @description ID of the Customer this PaymentIntent belongs to, if one exists. * @@ -23367,26 +23287,26 @@ export interface operations { * * If present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. */ - readonly customer?: string; + readonly customer?: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string; + readonly description?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods#compatibility) object) to attach to this PaymentIntent. */ - readonly payment_method?: string; + readonly payment_method?: string /** * payment_method_options_param * @description Payment-method-specific configuration for this PaymentIntent. */ readonly payment_method_options?: { - readonly card?: unknown; - }; + readonly card?: unknown + } /** @description The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. */ - readonly payment_method_types?: readonly string[]; + readonly payment_method_types?: readonly string[] /** @description Email address that the receipt for the resulting payment will be sent to. */ - readonly receipt_email?: string; + readonly receipt_email?: string /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * @@ -23397,36 +23317,36 @@ export interface operations { * If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. * @enum {string} */ - readonly setup_future_usage?: "" | "off_session" | "on_session"; + readonly setup_future_usage?: '' | 'off_session' | 'on_session' /** @description Shipping information for this PaymentIntent. */ - readonly shipping?: unknown; + readonly shipping?: unknown /** @description For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - readonly statement_descriptor?: string; + readonly statement_descriptor?: string /** @description Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - readonly statement_descriptor_suffix?: string; + readonly statement_descriptor_suffix?: string /** * transfer_data_update_params * @description The parameters used to automatically create a Transfer when the payment succeeds. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ readonly transfer_data?: { - readonly amount?: number; - }; + readonly amount?: number + } /** @description A string that identifies the resulting payment as part of a group. `transfer_group` may only be provided if it has not been set. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. */ - readonly transfer_group?: string; - }; - }; - }; + readonly transfer_group?: string + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["payment_intent"]; - }; + readonly schema: definitions['payment_intent'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

A PaymentIntent object can be canceled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action.

* @@ -23435,8 +23355,8 @@ export interface operations { readonly PostPaymentIntentsIntentCancel: { readonly parameters: { readonly path: { - readonly intent: string; - }; + readonly intent: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { @@ -23444,23 +23364,23 @@ export interface operations { * @description Reason for canceling this PaymentIntent. Possible values are `duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned` * @enum {string} */ - readonly cancellation_reason?: "abandoned" | "duplicate" | "fraudulent" | "requested_by_customer"; + readonly cancellation_reason?: 'abandoned' | 'duplicate' | 'fraudulent' | 'requested_by_customer' /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["payment_intent"]; - }; + readonly schema: definitions['payment_intent'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.

* @@ -23471,47 +23391,47 @@ export interface operations { readonly PostPaymentIntentsIntentCapture: { readonly parameters: { readonly path: { - readonly intent: string; - }; + readonly intent: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description The amount to capture from the PaymentIntent, which must be less than or equal to the original amount. Any additional amount will be automatically refunded. Defaults to the full `amount_capturable` if not provided. */ - readonly amount_to_capture?: number; + readonly amount_to_capture?: number /** * @description The amount of the application fee (if any) that will be applied to the * payment and transferred to the application owner's Stripe account. For * more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ - readonly application_fee_amount?: number; + readonly application_fee_amount?: number /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - readonly statement_descriptor?: string; + readonly statement_descriptor?: string /** @description Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - readonly statement_descriptor_suffix?: string; + readonly statement_descriptor_suffix?: string /** * transfer_data_update_params * @description The parameters used to automatically create a Transfer when the payment * is captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ readonly transfer_data?: { - readonly amount?: number; - }; - }; - }; - }; + readonly amount?: number + } + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["payment_intent"]; - }; + readonly schema: definitions['payment_intent'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

Confirm that your customer intends to pay with current or provided * payment method. Upon confirmation, the PaymentIntent will attempt to initiate @@ -23542,19 +23462,19 @@ export interface operations { readonly PostPaymentIntentsIntentConfirm: { readonly parameters: { readonly path: { - readonly intent: string; - }; + readonly intent: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description The client secret of the PaymentIntent. */ - readonly client_secret?: string; + readonly client_secret?: string /** @description Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. This parameter is intended for simpler integrations that do not handle customer actions, like [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication). */ - readonly error_on_requires_action?: boolean; + readonly error_on_requires_action?: boolean /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description ID of the mandate to be used for this payment. */ - readonly mandate?: string; + readonly mandate?: string /** * secret_key_param * @description This hash contains details about the Mandate to create @@ -23562,39 +23482,39 @@ export interface operations { readonly mandate_data?: { /** customer_acceptance_param */ readonly customer_acceptance: { - readonly accepted_at?: number; + readonly accepted_at?: number /** offline_param */ - readonly offline?: { readonly [key: string]: unknown }; + readonly offline?: { readonly [key: string]: unknown } /** online_param */ readonly online?: { - readonly ip_address: string; - readonly user_agent: string; - }; + readonly ip_address: string + readonly user_agent: string + } /** @enum {string} */ - readonly type: "offline" | "online"; - }; - }; + readonly type: 'offline' | 'online' + } + } /** @description Set to `true` to indicate that the customer is not in your checkout flow during this payment attempt, and therefore is unable to authenticate. This parameter is intended for scenarios where you collect card details and [charge them later](https://stripe.com/docs/payments/cards/charging-saved-cards). */ - readonly off_session?: unknown; + readonly off_session?: unknown /** @description ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods#compatibility) object) to attach to this PaymentIntent. */ - readonly payment_method?: string; + readonly payment_method?: string /** * payment_method_options_param * @description Payment-method-specific configuration for this PaymentIntent. */ readonly payment_method_options?: { - readonly card?: unknown; - }; + readonly card?: unknown + } /** @description The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. */ - readonly payment_method_types?: readonly string[]; + readonly payment_method_types?: readonly string[] /** @description Email address that the receipt for the resulting payment will be sent to. */ - readonly receipt_email?: string; + readonly receipt_email?: string /** * @description The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. * If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. * This parameter is only used for cards and other redirect-based payment methods. */ - readonly return_url?: string; + readonly return_url?: string /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * @@ -23605,65 +23525,65 @@ export interface operations { * If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. * @enum {string} */ - readonly setup_future_usage?: "" | "off_session" | "on_session"; + readonly setup_future_usage?: '' | 'off_session' | 'on_session' /** @description Shipping information for this PaymentIntent. */ - readonly shipping?: unknown; + readonly shipping?: unknown /** @description Set to `true` only when using manual confirmation and the iOS or Android SDKs to handle additional authentication steps. */ - readonly use_stripe_sdk?: boolean; - }; - }; - }; + readonly use_stripe_sdk?: boolean + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["payment_intent"]; - }; + readonly schema: definitions['payment_intent'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Returns a list of PaymentMethods for a given Customer

*/ readonly GetPaymentMethods: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** The ID of the customer whose PaymentMethods will be retrieved. */ - readonly customer: string; + readonly customer: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** A required filter on the list, based on the object `type` field. */ - readonly type: string; - }; - }; + readonly type: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["payment_method"][]; + readonly data: readonly definitions['payment_method'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Creates a PaymentMethod object. Read the Stripe.js reference to learn how to create PaymentMethods via Stripe.js.

*/ readonly PostPaymentMethods: { readonly parameters: { @@ -23675,9 +23595,9 @@ export interface operations { * @description If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account. */ readonly au_becs_debit?: { - readonly account_number: string; - readonly bsb_number: string; - }; + readonly account_number: string + readonly bsb_number: string + } /** * billing_details_inner_params * @description Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods. @@ -23685,23 +23605,23 @@ export interface operations { readonly billing_details?: { /** billing_details_address */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; - readonly email?: string; - readonly name?: string; - readonly phone?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } + readonly email?: string + readonly name?: string + readonly phone?: string + } /** @description If this is a `card` PaymentMethod, this hash contains the user's card details. For backwards compatibility, you can alternatively provide a Stripe token (e.g., for Apple Pay, Amex Express Checkout, or legacy Checkout) into the card hash with format `card: {token: "tok_visa"}`. When creating with a card number, you must meet the requirements for [PCI compliance](https://stripe.com/docs/security#validating-pci-compliance). We strongly recommend using Stripe.js instead of interacting with this API directly. */ - readonly card?: { readonly [key: string]: unknown }; + readonly card?: { readonly [key: string]: unknown } /** @description The `Customer` to whom the original PaymentMethod is attached. */ - readonly customer?: string; + readonly customer?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** * param * @description If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method. @@ -23709,27 +23629,27 @@ export interface operations { readonly fpx?: { /** @enum {string} */ readonly bank: - | "affin_bank" - | "alliance_bank" - | "ambank" - | "bank_islam" - | "bank_muamalat" - | "bank_rakyat" - | "bsn" - | "cimb" - | "deutsche_bank" - | "hong_leong_bank" - | "hsbc" - | "kfh" - | "maybank2e" - | "maybank2u" - | "ocbc" - | "pb_enterprise" - | "public_bank" - | "rhb" - | "standard_chartered" - | "uob"; - }; + | 'affin_bank' + | 'alliance_bank' + | 'ambank' + | 'bank_islam' + | 'bank_muamalat' + | 'bank_rakyat' + | 'bsn' + | 'cimb' + | 'deutsche_bank' + | 'hong_leong_bank' + | 'hsbc' + | 'kfh' + | 'maybank2e' + | 'maybank2u' + | 'ocbc' + | 'pb_enterprise' + | 'public_bank' + | 'rhb' + | 'standard_chartered' + | 'uob' + } /** * param * @description If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method. @@ -23737,77 +23657,77 @@ export interface operations { readonly ideal?: { /** @enum {string} */ readonly bank?: - | "abn_amro" - | "asn_bank" - | "bunq" - | "handelsbanken" - | "ing" - | "knab" - | "moneyou" - | "rabobank" - | "regiobank" - | "sns_bank" - | "triodos_bank" - | "van_lanschot"; - }; + | 'abn_amro' + | 'asn_bank' + | 'bunq' + | 'handelsbanken' + | 'ing' + | 'knab' + | 'moneyou' + | 'rabobank' + | 'regiobank' + | 'sns_bank' + | 'triodos_bank' + | 'van_lanschot' + } /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: { readonly [key: string]: unknown }; + readonly metadata?: { readonly [key: string]: unknown } /** @description The PaymentMethod to share. */ - readonly payment_method?: string; + readonly payment_method?: string /** * param * @description If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account. */ readonly sepa_debit?: { - readonly iban: string; - }; + readonly iban: string + } /** * @description 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. Required unless `payment_method` is specified (see the [Cloning PaymentMethods](https://stripe.com/docs/payments/payment-methods/connect#cloning-payment-methods) guide) * @enum {string} */ - readonly type?: "au_becs_debit" | "card" | "fpx" | "ideal" | "sepa_debit"; - }; - }; - }; + readonly type?: 'au_becs_debit' | 'card' | 'fpx' | 'ideal' | 'sepa_debit' + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["payment_method"]; - }; + readonly schema: definitions['payment_method'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves a PaymentMethod object.

*/ readonly GetPaymentMethodsPaymentMethod: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly payment_method: string; - }; - }; + readonly payment_method: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["payment_method"]; - }; + readonly schema: definitions['payment_method'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly PostPaymentMethodsPaymentMethod: { readonly parameters: { readonly path: { - readonly payment_method: string; - }; + readonly payment_method: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { @@ -23818,48 +23738,48 @@ export interface operations { readonly billing_details?: { /** billing_details_address */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; - readonly email?: string; - readonly name?: string; - readonly phone?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } + readonly email?: string + readonly name?: string + readonly phone?: string + } /** * update_api_param * @description If this is a `card` PaymentMethod, this hash contains the user's card details. */ readonly card?: { - readonly exp_month?: number; - readonly exp_year?: number; - }; + readonly exp_month?: number + readonly exp_year?: number + } /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** * update_param * @description If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account. */ - readonly sepa_debit?: { readonly [key: string]: unknown }; - }; - }; - }; + readonly sepa_debit?: { readonly [key: string]: unknown } + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["payment_method"]; - }; + readonly schema: definitions['payment_method'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

Attaches a PaymentMethod object to a Customer.

* @@ -23876,96 +23796,96 @@ export interface operations { readonly PostPaymentMethodsPaymentMethodAttach: { readonly parameters: { readonly path: { - readonly payment_method: string; - }; + readonly payment_method: string + } readonly body: { /** Body parameters for the request. */ readonly payload: { /** @description The ID of the customer to which to attach the PaymentMethod. */ - readonly customer: string; + readonly customer: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["payment_method"]; - }; + readonly schema: definitions['payment_method'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Detaches a PaymentMethod object from a Customer.

*/ readonly PostPaymentMethodsPaymentMethodDetach: { readonly parameters: { readonly path: { - readonly payment_method: string; - }; + readonly payment_method: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["payment_method"]; - }; + readonly schema: definitions['payment_method'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Returns a list of existing payouts sent to third-party bank accounts or that Stripe has sent you. The payouts are returned in sorted order, with the most recently created payouts appearing first.

*/ readonly GetPayouts: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - readonly arrival_date?: number; - readonly created?: number; + readonly expand?: readonly unknown[] + readonly arrival_date?: number + readonly created?: number /** The ID of an external account - only return payouts sent to this external account. */ - readonly destination?: string; + readonly destination?: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** Only return payouts that have the given status: `pending`, `paid`, `failed`, or `canceled`. */ - readonly status?: string; - }; - }; + readonly status?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["payout"][]; + readonly data: readonly definitions['payout'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

To send funds to your own bank account, you create a new payout object. Your Stripe balance must be able to cover the payout amount, or you’ll receive an “Insufficient Funds” error.

* @@ -23979,159 +23899,159 @@ export interface operations { /** Body parameters for the request. */ readonly payload: { /** @description A positive integer in cents representing how much to payout. */ - readonly amount: number; + readonly amount: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string; + readonly description?: string /** @description The ID of a bank account or a card to send the payout to. If no destination is supplied, the default external account for the specified currency will be used. */ - readonly destination?: string; + readonly destination?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: { readonly [key: string]: unknown }; + readonly metadata?: { readonly [key: string]: unknown } /** * @description The method used to send this payout, which can be `standard` or `instant`. `instant` is only supported for payouts to debit cards. (See [Instant payouts for marketplaces for more information](https://stripe.com/blog/instant-payouts-for-marketplaces).) * @enum {string} */ - readonly method?: "instant" | "standard"; + readonly method?: 'instant' | 'standard' /** * @description The balance type of your Stripe balance to draw this payout from. Balances for different payment sources are kept separately. You can find the amounts with the balances API. One of `bank_account`, `card`, or `fpx`. * @enum {string} */ - readonly source_type?: "bank_account" | "card" | "fpx"; + readonly source_type?: 'bank_account' | 'card' | 'fpx' /** @description A string to be displayed on the recipient's bank or card statement. This may be at most 22 characters. Attempting to use a `statement_descriptor` longer than 22 characters will return an error. Note: Most banks will truncate this information and/or display it inconsistently. Some may not display it at all. */ - readonly statement_descriptor?: string; - }; - }; - }; + readonly statement_descriptor?: string + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["payout"]; - }; + readonly schema: definitions['payout'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly GetPayoutsPayout: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly payout: string; - }; - }; + readonly payout: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["payout"]; - }; + readonly schema: definitions['payout'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Updates the specified payout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request accepts only the metadata as arguments.

*/ readonly PostPayoutsPayout: { readonly parameters: { readonly path: { - readonly payout: string; - }; + readonly payout: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; - }; - }; - }; + readonly metadata?: unknown + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["payout"]; - }; + readonly schema: definitions['payout'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

A previously created payout can be canceled if it has not yet been paid out. Funds will be refunded to your available balance. You may not cancel automatic Stripe payouts.

*/ readonly PostPayoutsPayoutCancel: { readonly parameters: { readonly path: { - readonly payout: string; - }; + readonly payout: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["payout"]; - }; + readonly schema: definitions['payout'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Returns a list of your plans.

*/ readonly GetPlans: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** Only return plans that are active or inactive (e.g., pass `false` to list all inactive plans). */ - readonly active?: boolean; + readonly active?: boolean /** 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. */ - readonly created?: number; + readonly created?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** Only return plans for the given product. */ - readonly product?: string; + readonly product?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["plan"][]; + readonly data: readonly definitions['plan'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

You can create plans using the API, or in the Stripe Dashboard.

*/ readonly PostPlans: { readonly parameters: { @@ -24139,216 +24059,216 @@ export interface operations { /** Body parameters for the request. */ readonly payload: { /** @description Whether the plan is currently available for new subscriptions. Defaults to `true`. */ - readonly active?: boolean; + readonly active?: boolean /** * @description 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`. * @enum {string} */ - readonly aggregate_usage?: "last_during_period" | "last_ever" | "max" | "sum"; + readonly aggregate_usage?: 'last_during_period' | 'last_ever' | 'max' | 'sum' /** @description A positive integer in %s (or 0 for a free plan) representing how much to charge on a recurring basis. */ - readonly amount?: number; + readonly amount?: number /** @description Same as `amount`, but accepts a decimal value with at most 12 decimal places. Only one of `amount` and `amount_decimal` can be set. */ - readonly amount_decimal?: string; + readonly amount_decimal?: string /** * @description 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. * @enum {string} */ - readonly billing_scheme?: "per_unit" | "tiered"; + readonly billing_scheme?: 'per_unit' | 'tiered' /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description An identifier randomly generated by Stripe. Used to identify this plan when subscribing a customer. You can optionally override this ID, but the ID must be unique across all plans in your Stripe account. You can, however, use the same plan ID in both live and test modes. */ - readonly id?: string; + readonly id?: string /** * @description Specifies billing frequency. Either `day`, `week`, `month` or `year`. * @enum {string} */ - readonly interval: "day" | "month" | "week" | "year"; + readonly interval: 'day' | 'month' | 'week' | 'year' /** @description The number of intervals between subscription billings. 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). */ - readonly interval_count?: number; + readonly interval_count?: number /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description A brief description of the plan, hidden from customers. */ - readonly nickname?: string; + readonly nickname?: string /** * inline_product_params * @description The product whose pricing the created plan will represent. This can either be the ID of an existing product, or a dictionary containing fields used to create a [service product](https://stripe.com/docs/api#product_object-type). */ readonly product?: { - readonly active?: boolean; - readonly id?: string; - readonly metadata?: { readonly [key: string]: unknown }; - readonly name: string; - readonly statement_descriptor?: string; - readonly unit_label?: string; - }; + readonly active?: boolean + readonly id?: string + readonly metadata?: { readonly [key: string]: unknown } + readonly name: string + readonly statement_descriptor?: string + readonly unit_label?: string + } /** @description Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. */ readonly tiers?: readonly { - readonly flat_amount?: number; - readonly flat_amount_decimal?: string; - readonly unit_amount?: number; - readonly unit_amount_decimal?: string; - readonly up_to: unknown; - }[]; + readonly flat_amount?: number + readonly flat_amount_decimal?: string + readonly unit_amount?: number + readonly unit_amount_decimal?: string + readonly up_to: unknown + }[] /** * @description 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 successively change as the quantity grows. * @enum {string} */ - readonly tiers_mode?: "graduated" | "volume"; + readonly tiers_mode?: 'graduated' | 'volume' /** * transform_usage_param * @description Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`. */ readonly transform_usage?: { - readonly divide_by: number; + readonly divide_by: number /** @enum {string} */ - readonly round: "down" | "up"; - }; + readonly round: 'down' | 'up' + } /** @description 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). */ - readonly trial_period_days?: number; + readonly trial_period_days?: number /** * @description 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`. * @enum {string} */ - readonly usage_type?: "licensed" | "metered"; - }; - }; - }; + readonly usage_type?: 'licensed' | 'metered' + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["plan"]; - }; + readonly schema: definitions['plan'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves the plan with the given ID.

*/ readonly GetPlansPlan: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly plan: string; - }; - }; + readonly plan: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["plan"]; - }; + readonly schema: definitions['plan'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly PostPlansPlan: { readonly parameters: { readonly path: { - readonly plan: string; - }; + readonly plan: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Whether the plan is currently available for new subscriptions. */ - readonly active?: boolean; + readonly active?: boolean /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description A brief description of the plan, hidden from customers. */ - readonly nickname?: string; + readonly nickname?: string /** @description The product the plan belongs to. Note that after updating, statement descriptors and line items of the plan in active subscriptions will be affected. */ - readonly product?: string; + readonly product?: string /** @description 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). */ - readonly trial_period_days?: number; - }; - }; - }; + readonly trial_period_days?: number + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["plan"]; - }; + readonly schema: definitions['plan'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly DeletePlansPlan: { readonly parameters: { readonly path: { - readonly plan: string; - }; - }; + readonly plan: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["deleted_plan"]; - }; + readonly schema: definitions['deleted_plan'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly GetProducts: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** Only return products that are active or inactive (e.g., pass `false` to list all inactive products). */ - readonly active?: boolean; + readonly active?: boolean /** Only return products that were created during the given date interval. */ - readonly created?: number; + readonly created?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Only return products with the given IDs. */ - readonly ids?: readonly unknown[]; + readonly ids?: readonly unknown[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** Only return products that can be shipped (i.e., physical, not digital products). */ - readonly shippable?: boolean; + readonly shippable?: boolean /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** Only return products of this type. */ - readonly type?: string; + readonly type?: string /** Only return products with the given url. */ - readonly url?: string; - }; - }; + readonly url?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["product"][]; + readonly data: readonly definitions['product'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Creates a new product object.

*/ readonly PostProducts: { readonly parameters: { @@ -24356,201 +24276,201 @@ export interface operations { /** Body parameters for the request. */ readonly payload: { /** @description Whether the product is currently available for purchase. Defaults to `true`. */ - readonly active?: boolean; + readonly active?: boolean /** @description A list of up to 5 alphanumeric attributes. */ - readonly attributes?: readonly string[]; + readonly attributes?: readonly string[] /** @description A short one-line description of the product, meant to be displayable to the customer. May only be set if type=`good`. */ - readonly caption?: string; + readonly caption?: string /** @description An array of Connect application names or identifiers that should not be able to order the SKUs for this product. May only be set if type=`good`. */ - readonly deactivate_on?: readonly string[]; + readonly deactivate_on?: readonly string[] /** @description 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. */ - readonly description?: string; + readonly description?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description An identifier will be randomly generated by Stripe. You can optionally override this ID, but the ID must be unique across all products in your Stripe account. */ - readonly id?: string; + readonly id?: string /** @description A list of up to 8 URLs of images for this product, meant to be displayable to the customer. */ - readonly images?: readonly string[]; + readonly images?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: { readonly [key: string]: unknown }; + readonly metadata?: { readonly [key: string]: unknown } /** @description The product's name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions. */ - readonly name: string; + readonly name: string /** * package_dimensions_specs * @description The dimensions of this product for shipping purposes. A SKU associated with this product can override this value by having its own `package_dimensions`. May only be set if type=`good`. */ readonly package_dimensions?: { - readonly height: number; - readonly length: number; - readonly weight: number; - readonly width: number; - }; + readonly height: number + readonly length: number + readonly weight: number + readonly width: number + } /** @description Whether this product is shipped (i.e., physical goods). Defaults to `true`. May only be set if type=`good`. */ - readonly shippable?: boolean; + readonly shippable?: boolean /** * @description An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all. * * This may be up to 22 characters. The statement description may not include `<`, `>`, `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. * It must contain at least one letter. */ - readonly statement_descriptor?: string; + readonly statement_descriptor?: string /** * @description The type of the product. Defaults to `service` if not explicitly specified, enabling use of this product with Subscriptions and Plans. Set this parameter to `good` to use this product with Orders and SKUs. On API versions before `2018-02-05`, this field defaults to `good` for compatibility reasons. * @enum {string} */ - readonly type?: "good" | "service"; + readonly type?: 'good' | 'service' /** @description A label that represents units of this product in Stripe and on customers’ receipts and invoices. When set, this will be included in associated invoice line item descriptions. */ - readonly unit_label?: string; + readonly unit_label?: string /** @description A URL of a publicly-accessible webpage for this product. May only be set if type=`good`. */ - readonly url?: string; - }; - }; - }; + readonly url?: string + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["product"]; - }; + readonly schema: definitions['product'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly GetProductsId: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["product"]; - }; + readonly schema: definitions['product'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly PostProductsId: { readonly parameters: { readonly path: { - readonly id: string; - }; + readonly id: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Whether the product is available for purchase. */ - readonly active?: boolean; + readonly active?: boolean /** @description A list of up to 5 alphanumeric attributes that each SKU can provide values for (e.g., `["color", "size"]`). If a value for `attributes` is specified, the list specified will replace the existing attributes list on this product. Any attributes not present after the update will be deleted from the SKUs for this product. */ - readonly attributes?: readonly string[]; + readonly attributes?: readonly string[] /** @description A short one-line description of the product, meant to be displayable to the customer. May only be set if `type=good`. */ - readonly caption?: string; + readonly caption?: string /** @description An array of Connect application names or identifiers that should not be able to order the SKUs for this product. May only be set if `type=good`. */ - readonly deactivate_on?: readonly string[]; + readonly deactivate_on?: readonly string[] /** @description 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. */ - readonly description?: string; + readonly description?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description A list of up to 8 URLs of images for this product, meant to be displayable to the customer. */ - readonly images?: readonly string[]; + readonly images?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description The product's name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions. */ - readonly name?: string; + readonly name?: string /** @description The dimensions of this product for shipping purposes. A SKU associated with this product can override this value by having its own `package_dimensions`. May only be set if `type=good`. */ - readonly package_dimensions?: unknown; + readonly package_dimensions?: unknown /** @description Whether this product is shipped (i.e., physical goods). Defaults to `true`. May only be set if `type=good`. */ - readonly shippable?: boolean; + readonly shippable?: boolean /** * @description An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all. * * This may be up to 22 characters. The statement description may not include `<`, `>`, `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. * It must contain at least one letter. May only be set if `type=service`. */ - readonly statement_descriptor?: string; + readonly statement_descriptor?: string /** @description A label that represents units of this product in Stripe and on customers’ receipts and invoices. When set, this will be included in associated invoice line item descriptions. May only be set if `type=service`. */ - readonly unit_label?: string; + readonly unit_label?: string /** @description A URL of a publicly-accessible webpage for this product. May only be set if `type=good`. */ - readonly url?: string; - }; - }; - }; + readonly url?: string + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["product"]; - }; + readonly schema: definitions['product'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Delete a product. Deleting a product with type=good is only possible if it has no SKUs associated with it. Deleting a product with type=service is only possible if it has no plans associated with it.

*/ readonly DeleteProductsId: { readonly parameters: { readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["deleted_product"]; - }; + readonly schema: definitions['deleted_product'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Returns a list of early fraud warnings.

*/ readonly GetRadarEarlyFraudWarnings: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** Only return early fraud warnings for the charge specified by this charge ID. */ - readonly charge?: string; + readonly charge?: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["radar.early_fraud_warning"][]; + readonly data: readonly definitions['radar.early_fraud_warning'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

Retrieves the details of an early fraud warning that has previously been created.

* @@ -24560,64 +24480,64 @@ export interface operations { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly early_fraud_warning: string; - }; - }; + readonly early_fraud_warning: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["radar.early_fraud_warning"]; - }; + readonly schema: definitions['radar.early_fraud_warning'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly GetRadarValueListItems: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - readonly created?: number; + readonly expand?: readonly unknown[] + readonly created?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** Return items belonging to the parent list whose value matches the specified value (using an "is like" match). */ - readonly value?: string; + readonly value?: string /** Identifier for the parent value list this item belongs to. */ - readonly value_list: string; - }; - }; + readonly value_list: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["radar.value_list_item"][]; + readonly data: readonly definitions['radar.value_list_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly PostRadarValueListItems: { readonly parameters: { @@ -24625,106 +24545,106 @@ export interface operations { /** Body parameters for the request. */ readonly payload: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The value of the item (whose type must match the type of the parent value list). */ - readonly value: string; + readonly value: string /** @description The identifier of the value list which the created item will be added to. */ - readonly value_list: string; - }; - }; - }; + readonly value_list: string + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["radar.value_list_item"]; - }; + readonly schema: definitions['radar.value_list_item'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves a ValueListItem object.

*/ readonly GetRadarValueListItemsItem: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly item: string; - }; - }; + readonly item: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["radar.value_list_item"]; - }; + readonly schema: definitions['radar.value_list_item'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly DeleteRadarValueListItemsItem: { readonly parameters: { readonly path: { - readonly item: string; - }; - }; + readonly item: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["deleted_radar.value_list_item"]; - }; + readonly schema: definitions['deleted_radar.value_list_item'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly GetRadarValueLists: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** The alias used to reference the value list when writing rules. */ - readonly alias?: string; + readonly alias?: string /** A value contained within a value list - returns all value lists containing this value. */ - readonly contains?: string; - readonly created?: number; + readonly contains?: string + readonly created?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["radar.value_list"][]; + readonly data: readonly definitions['radar.value_list'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly PostRadarValueLists: { readonly parameters: { @@ -24732,150 +24652,143 @@ export interface operations { /** Body parameters for the request. */ readonly payload: { /** @description The name of the value list for use in rules. */ - readonly alias: string; + readonly alias: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** * @description Type of the items in the value list. One of `card_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, or `case_sensitive_string`. Use `string` if the item type is unknown or mixed. * @enum {string} */ - readonly item_type?: - | "card_bin" - | "card_fingerprint" - | "case_sensitive_string" - | "country" - | "email" - | "ip_address" - | "string"; + readonly item_type?: 'card_bin' | 'card_fingerprint' | 'case_sensitive_string' | 'country' | 'email' | 'ip_address' | 'string' /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: { readonly [key: string]: unknown }; + readonly metadata?: { readonly [key: string]: unknown } /** @description The human-readable name of the value list. */ - readonly name: string; - }; - }; - }; + readonly name: string + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["radar.value_list"]; - }; + readonly schema: definitions['radar.value_list'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves a ValueList object.

*/ readonly GetRadarValueListsValueList: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly value_list: string; - }; - }; + readonly value_list: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["radar.value_list"]; - }; + readonly schema: definitions['radar.value_list'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly PostRadarValueListsValueList: { readonly parameters: { readonly path: { - readonly value_list: string; - }; + readonly value_list: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description The name of the value list for use in rules. */ - readonly alias?: string; + readonly alias?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: { readonly [key: string]: unknown }; + readonly metadata?: { readonly [key: string]: unknown } /** @description The human-readable name of the value list. */ - readonly name?: string; - }; - }; - }; + readonly name?: string + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["radar.value_list"]; - }; + readonly schema: definitions['radar.value_list'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly DeleteRadarValueListsValueList: { readonly parameters: { readonly path: { - readonly value_list: string; - }; - }; + readonly value_list: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["deleted_radar.value_list"]; - }; + readonly schema: definitions['deleted_radar.value_list'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly GetRecipients: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - readonly created?: number; + readonly expand?: readonly unknown[] + readonly created?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - readonly type?: string; + readonly starting_after?: string + readonly type?: string /** Only return recipients that are verified or unverified. */ - readonly verified?: boolean; - }; - }; + readonly verified?: boolean + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["recipient"][]; + readonly data: readonly definitions['recipient'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

Creates a new Recipient object and verifies the recipient’s identity. * Also verifies the recipient’s bank account information or debit card, if either is provided.

@@ -24886,59 +24799,59 @@ export interface operations { /** Body parameters for the request. */ readonly payload: { /** @description A bank account to attach to the recipient. You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe-js), or a dictionary containing a user's bank account details, with the options described below. */ - readonly bank_account?: string; + readonly bank_account?: string /** @description A U.S. Visa or MasterCard debit card (_not_ prepaid) to attach to the recipient. If the debit card is not valid, recipient creation will fail. You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe-js), or a dictionary containing a user's debit card details, with the options described below. Although not all information is required, the extra info helps prevent fraud. */ - readonly card?: string; + readonly card?: string /** @description An arbitrary string which you can attach to a `Recipient` object. It is displayed alongside the recipient in the web interface. */ - readonly description?: string; + readonly description?: string /** @description The recipient's email address. It is displayed alongside the recipient in the web interface, and can be useful for searching and tracking. */ - readonly email?: string; + readonly email?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description The recipient's full, legal name. For type `individual`, should be in the format `First Last`, `First Middle Last`, or `First M Last` (no prefixes or suffixes). For `corporation`, the full, incorporated name. */ - readonly name: string; + readonly name: string /** @description The recipient's tax ID, as a string. For type `individual`, the full SSN; for type `corporation`, the full EIN. */ - readonly tax_id?: string; + readonly tax_id?: string /** @description Type of the recipient: either `individual` or `corporation`. */ - readonly type: string; - }; - }; - }; + readonly type: string + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["recipient"]; - }; + readonly schema: definitions['recipient'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves the details of an existing recipient. You need only supply the unique recipient identifier that was returned upon recipient creation.

*/ readonly GetRecipientsId: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["deleted_recipient"]; - }; + readonly schema: definitions['deleted_recipient'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

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

@@ -24949,155 +24862,155 @@ export interface operations { readonly PostRecipientsId: { readonly parameters: { readonly path: { - readonly id: string; - }; + readonly id: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description A bank account to attach to the recipient. You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe-js), or a dictionary containing a user's bank account details, with the options described below. */ - readonly bank_account?: string; + readonly bank_account?: string /** @description A U.S. Visa or MasterCard debit card (not prepaid) to attach to the recipient. You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe-js), or a dictionary containing a user's debit card details, with the options described below. Passing `card` will create a new card, make it the new recipient default card, and delete the old recipient default (if one exists). If you want to add additional debit cards instead of replacing the existing default, use the [card creation API](https://stripe.com/docs/api#create_card). Whenever you attach a card to a recipient, Stripe will automatically validate the debit card. */ - readonly card?: string; + readonly card?: string /** @description ID of the card to set as the recipient's new default for payouts. */ - readonly default_card?: string; + readonly default_card?: string /** @description An arbitrary string which you can attach to a `Recipient` object. It is displayed alongside the recipient in the web interface. */ - readonly description?: string; + readonly description?: string /** @description The recipient's email address. It is displayed alongside the recipient in the web interface, and can be useful for searching and tracking. */ - readonly email?: string; + readonly email?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description The recipient's full, legal name. For type `individual`, should be in the format `First Last`, `First Middle Last`, or `First M Last` (no prefixes or suffixes). For `corporation`, the full, incorporated name. */ - readonly name?: string; + readonly name?: string /** @description The recipient's tax ID, as a string. For type `individual`, the full SSN; for type `corporation`, the full EIN. */ - readonly tax_id?: string; - }; - }; - }; + readonly tax_id?: string + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["recipient"]; - }; + readonly schema: definitions['recipient'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Permanently deletes a recipient. It cannot be undone.

*/ readonly DeleteRecipientsId: { readonly parameters: { readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["deleted_recipient"]; - }; + readonly schema: definitions['deleted_recipient'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Returns a list of all refunds you’ve previously created. The refunds are returned in sorted order, with the most recent refunds appearing first. For convenience, the 10 most recent refunds are always available by default on the charge object.

*/ readonly GetRefunds: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** Only return refunds for the charge specified by this charge ID. */ - readonly charge?: string; - readonly created?: number; + readonly charge?: string + readonly created?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** Only return refunds for the PaymentIntent specified by this ID. */ - readonly payment_intent?: string; + readonly payment_intent?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["refund"][]; + readonly data: readonly definitions['refund'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Create a refund.

*/ readonly PostRefunds: { readonly parameters: { readonly body: { /** Body parameters for the request. */ readonly payload?: { - readonly amount?: number; - readonly charge?: string; + readonly amount?: number + readonly charge?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: { readonly [key: string]: unknown }; - readonly payment_intent?: string; + readonly metadata?: { readonly [key: string]: unknown } + readonly payment_intent?: string /** @enum {string} */ - readonly reason?: "duplicate" | "fraudulent" | "requested_by_customer"; - readonly refund_application_fee?: boolean; - readonly reverse_transfer?: boolean; - }; - }; - }; + readonly reason?: 'duplicate' | 'fraudulent' | 'requested_by_customer' + readonly refund_application_fee?: boolean + readonly reverse_transfer?: boolean + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["refund"]; - }; + readonly schema: definitions['refund'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves the details of an existing refund.

*/ readonly GetRefundsRefund: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly refund: string; - }; - }; + readonly refund: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["refund"]; - }; + readonly schema: definitions['refund'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

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

* @@ -25106,66 +25019,66 @@ export interface operations { readonly PostRefundsRefund: { readonly parameters: { readonly path: { - readonly refund: string; - }; + readonly refund: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; - }; - }; - }; + readonly metadata?: unknown + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["refund"]; - }; + readonly schema: definitions['refund'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Returns a list of Report Runs, with the most recent appearing first. (Requires a live-mode API key.)

*/ readonly GetReportingReportRuns: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - readonly created?: number; + readonly expand?: readonly unknown[] + readonly created?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["reporting.report_run"][]; + readonly data: readonly definitions['reporting.report_run'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly PostReportingReportRuns: { readonly parameters: { @@ -25173,864 +25086,864 @@ export interface operations { /** Body parameters for the request. */ readonly payload: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** * run_parameter_specs * @description Parameters specifying how the report should be run. Different Report Types have different required and optional parameters, listed in the [API Access to Reports](https://stripe.com/docs/reporting/statements/api) documentation. */ readonly parameters?: { - readonly columns?: readonly string[]; - readonly connected_account?: string; - readonly currency?: string; - readonly interval_end?: number; - readonly interval_start?: number; - readonly payout?: string; + readonly columns?: readonly string[] + readonly connected_account?: string + readonly currency?: string + readonly interval_end?: number + readonly interval_start?: number + readonly payout?: string /** @enum {string} */ readonly reporting_category?: - | "advance" - | "advance_funding" - | "charge" - | "charge_failure" - | "connect_collection_transfer" - | "connect_reserved_funds" - | "dispute" - | "dispute_reversal" - | "fee" - | "financing_paydown" - | "financing_paydown_reversal" - | "financing_payout" - | "financing_payout_reversal" - | "issuing_authorization_hold" - | "issuing_authorization_release" - | "issuing_transaction" - | "network_cost" - | "other_adjustment" - | "partial_capture_reversal" - | "payout" - | "payout_reversal" - | "platform_earning" - | "platform_earning_refund" - | "refund" - | "refund_failure" - | "risk_reserved_funds" - | "tax" - | "topup" - | "topup_reversal" - | "transfer" - | "transfer_reversal"; + | 'advance' + | 'advance_funding' + | 'charge' + | 'charge_failure' + | 'connect_collection_transfer' + | 'connect_reserved_funds' + | 'dispute' + | 'dispute_reversal' + | 'fee' + | 'financing_paydown' + | 'financing_paydown_reversal' + | 'financing_payout' + | 'financing_payout_reversal' + | 'issuing_authorization_hold' + | 'issuing_authorization_release' + | 'issuing_transaction' + | 'network_cost' + | 'other_adjustment' + | 'partial_capture_reversal' + | 'payout' + | 'payout_reversal' + | 'platform_earning' + | 'platform_earning_refund' + | 'refund' + | 'refund_failure' + | 'risk_reserved_funds' + | 'tax' + | 'topup' + | 'topup_reversal' + | 'transfer' + | 'transfer_reversal' /** @enum {string} */ readonly timezone?: - | "Africa/Abidjan" - | "Africa/Accra" - | "Africa/Addis_Ababa" - | "Africa/Algiers" - | "Africa/Asmara" - | "Africa/Asmera" - | "Africa/Bamako" - | "Africa/Bangui" - | "Africa/Banjul" - | "Africa/Bissau" - | "Africa/Blantyre" - | "Africa/Brazzaville" - | "Africa/Bujumbura" - | "Africa/Cairo" - | "Africa/Casablanca" - | "Africa/Ceuta" - | "Africa/Conakry" - | "Africa/Dakar" - | "Africa/Dar_es_Salaam" - | "Africa/Djibouti" - | "Africa/Douala" - | "Africa/El_Aaiun" - | "Africa/Freetown" - | "Africa/Gaborone" - | "Africa/Harare" - | "Africa/Johannesburg" - | "Africa/Juba" - | "Africa/Kampala" - | "Africa/Khartoum" - | "Africa/Kigali" - | "Africa/Kinshasa" - | "Africa/Lagos" - | "Africa/Libreville" - | "Africa/Lome" - | "Africa/Luanda" - | "Africa/Lubumbashi" - | "Africa/Lusaka" - | "Africa/Malabo" - | "Africa/Maputo" - | "Africa/Maseru" - | "Africa/Mbabane" - | "Africa/Mogadishu" - | "Africa/Monrovia" - | "Africa/Nairobi" - | "Africa/Ndjamena" - | "Africa/Niamey" - | "Africa/Nouakchott" - | "Africa/Ouagadougou" - | "Africa/Porto-Novo" - | "Africa/Sao_Tome" - | "Africa/Timbuktu" - | "Africa/Tripoli" - | "Africa/Tunis" - | "Africa/Windhoek" - | "America/Adak" - | "America/Anchorage" - | "America/Anguilla" - | "America/Antigua" - | "America/Araguaina" - | "America/Argentina/Buenos_Aires" - | "America/Argentina/Catamarca" - | "America/Argentina/ComodRivadavia" - | "America/Argentina/Cordoba" - | "America/Argentina/Jujuy" - | "America/Argentina/La_Rioja" - | "America/Argentina/Mendoza" - | "America/Argentina/Rio_Gallegos" - | "America/Argentina/Salta" - | "America/Argentina/San_Juan" - | "America/Argentina/San_Luis" - | "America/Argentina/Tucuman" - | "America/Argentina/Ushuaia" - | "America/Aruba" - | "America/Asuncion" - | "America/Atikokan" - | "America/Atka" - | "America/Bahia" - | "America/Bahia_Banderas" - | "America/Barbados" - | "America/Belem" - | "America/Belize" - | "America/Blanc-Sablon" - | "America/Boa_Vista" - | "America/Bogota" - | "America/Boise" - | "America/Buenos_Aires" - | "America/Cambridge_Bay" - | "America/Campo_Grande" - | "America/Cancun" - | "America/Caracas" - | "America/Catamarca" - | "America/Cayenne" - | "America/Cayman" - | "America/Chicago" - | "America/Chihuahua" - | "America/Coral_Harbour" - | "America/Cordoba" - | "America/Costa_Rica" - | "America/Creston" - | "America/Cuiaba" - | "America/Curacao" - | "America/Danmarkshavn" - | "America/Dawson" - | "America/Dawson_Creek" - | "America/Denver" - | "America/Detroit" - | "America/Dominica" - | "America/Edmonton" - | "America/Eirunepe" - | "America/El_Salvador" - | "America/Ensenada" - | "America/Fort_Nelson" - | "America/Fort_Wayne" - | "America/Fortaleza" - | "America/Glace_Bay" - | "America/Godthab" - | "America/Goose_Bay" - | "America/Grand_Turk" - | "America/Grenada" - | "America/Guadeloupe" - | "America/Guatemala" - | "America/Guayaquil" - | "America/Guyana" - | "America/Halifax" - | "America/Havana" - | "America/Hermosillo" - | "America/Indiana/Indianapolis" - | "America/Indiana/Knox" - | "America/Indiana/Marengo" - | "America/Indiana/Petersburg" - | "America/Indiana/Tell_City" - | "America/Indiana/Vevay" - | "America/Indiana/Vincennes" - | "America/Indiana/Winamac" - | "America/Indianapolis" - | "America/Inuvik" - | "America/Iqaluit" - | "America/Jamaica" - | "America/Jujuy" - | "America/Juneau" - | "America/Kentucky/Louisville" - | "America/Kentucky/Monticello" - | "America/Knox_IN" - | "America/Kralendijk" - | "America/La_Paz" - | "America/Lima" - | "America/Los_Angeles" - | "America/Louisville" - | "America/Lower_Princes" - | "America/Maceio" - | "America/Managua" - | "America/Manaus" - | "America/Marigot" - | "America/Martinique" - | "America/Matamoros" - | "America/Mazatlan" - | "America/Mendoza" - | "America/Menominee" - | "America/Merida" - | "America/Metlakatla" - | "America/Mexico_City" - | "America/Miquelon" - | "America/Moncton" - | "America/Monterrey" - | "America/Montevideo" - | "America/Montreal" - | "America/Montserrat" - | "America/Nassau" - | "America/New_York" - | "America/Nipigon" - | "America/Nome" - | "America/Noronha" - | "America/North_Dakota/Beulah" - | "America/North_Dakota/Center" - | "America/North_Dakota/New_Salem" - | "America/Ojinaga" - | "America/Panama" - | "America/Pangnirtung" - | "America/Paramaribo" - | "America/Phoenix" - | "America/Port-au-Prince" - | "America/Port_of_Spain" - | "America/Porto_Acre" - | "America/Porto_Velho" - | "America/Puerto_Rico" - | "America/Punta_Arenas" - | "America/Rainy_River" - | "America/Rankin_Inlet" - | "America/Recife" - | "America/Regina" - | "America/Resolute" - | "America/Rio_Branco" - | "America/Rosario" - | "America/Santa_Isabel" - | "America/Santarem" - | "America/Santiago" - | "America/Santo_Domingo" - | "America/Sao_Paulo" - | "America/Scoresbysund" - | "America/Shiprock" - | "America/Sitka" - | "America/St_Barthelemy" - | "America/St_Johns" - | "America/St_Kitts" - | "America/St_Lucia" - | "America/St_Thomas" - | "America/St_Vincent" - | "America/Swift_Current" - | "America/Tegucigalpa" - | "America/Thule" - | "America/Thunder_Bay" - | "America/Tijuana" - | "America/Toronto" - | "America/Tortola" - | "America/Vancouver" - | "America/Virgin" - | "America/Whitehorse" - | "America/Winnipeg" - | "America/Yakutat" - | "America/Yellowknife" - | "Antarctica/Casey" - | "Antarctica/Davis" - | "Antarctica/DumontDUrville" - | "Antarctica/Macquarie" - | "Antarctica/Mawson" - | "Antarctica/McMurdo" - | "Antarctica/Palmer" - | "Antarctica/Rothera" - | "Antarctica/South_Pole" - | "Antarctica/Syowa" - | "Antarctica/Troll" - | "Antarctica/Vostok" - | "Arctic/Longyearbyen" - | "Asia/Aden" - | "Asia/Almaty" - | "Asia/Amman" - | "Asia/Anadyr" - | "Asia/Aqtau" - | "Asia/Aqtobe" - | "Asia/Ashgabat" - | "Asia/Ashkhabad" - | "Asia/Atyrau" - | "Asia/Baghdad" - | "Asia/Bahrain" - | "Asia/Baku" - | "Asia/Bangkok" - | "Asia/Barnaul" - | "Asia/Beirut" - | "Asia/Bishkek" - | "Asia/Brunei" - | "Asia/Calcutta" - | "Asia/Chita" - | "Asia/Choibalsan" - | "Asia/Chongqing" - | "Asia/Chungking" - | "Asia/Colombo" - | "Asia/Dacca" - | "Asia/Damascus" - | "Asia/Dhaka" - | "Asia/Dili" - | "Asia/Dubai" - | "Asia/Dushanbe" - | "Asia/Famagusta" - | "Asia/Gaza" - | "Asia/Harbin" - | "Asia/Hebron" - | "Asia/Ho_Chi_Minh" - | "Asia/Hong_Kong" - | "Asia/Hovd" - | "Asia/Irkutsk" - | "Asia/Istanbul" - | "Asia/Jakarta" - | "Asia/Jayapura" - | "Asia/Jerusalem" - | "Asia/Kabul" - | "Asia/Kamchatka" - | "Asia/Karachi" - | "Asia/Kashgar" - | "Asia/Kathmandu" - | "Asia/Katmandu" - | "Asia/Khandyga" - | "Asia/Kolkata" - | "Asia/Krasnoyarsk" - | "Asia/Kuala_Lumpur" - | "Asia/Kuching" - | "Asia/Kuwait" - | "Asia/Macao" - | "Asia/Macau" - | "Asia/Magadan" - | "Asia/Makassar" - | "Asia/Manila" - | "Asia/Muscat" - | "Asia/Nicosia" - | "Asia/Novokuznetsk" - | "Asia/Novosibirsk" - | "Asia/Omsk" - | "Asia/Oral" - | "Asia/Phnom_Penh" - | "Asia/Pontianak" - | "Asia/Pyongyang" - | "Asia/Qatar" - | "Asia/Qostanay" - | "Asia/Qyzylorda" - | "Asia/Rangoon" - | "Asia/Riyadh" - | "Asia/Saigon" - | "Asia/Sakhalin" - | "Asia/Samarkand" - | "Asia/Seoul" - | "Asia/Shanghai" - | "Asia/Singapore" - | "Asia/Srednekolymsk" - | "Asia/Taipei" - | "Asia/Tashkent" - | "Asia/Tbilisi" - | "Asia/Tehran" - | "Asia/Tel_Aviv" - | "Asia/Thimbu" - | "Asia/Thimphu" - | "Asia/Tokyo" - | "Asia/Tomsk" - | "Asia/Ujung_Pandang" - | "Asia/Ulaanbaatar" - | "Asia/Ulan_Bator" - | "Asia/Urumqi" - | "Asia/Ust-Nera" - | "Asia/Vientiane" - | "Asia/Vladivostok" - | "Asia/Yakutsk" - | "Asia/Yangon" - | "Asia/Yekaterinburg" - | "Asia/Yerevan" - | "Atlantic/Azores" - | "Atlantic/Bermuda" - | "Atlantic/Canary" - | "Atlantic/Cape_Verde" - | "Atlantic/Faeroe" - | "Atlantic/Faroe" - | "Atlantic/Jan_Mayen" - | "Atlantic/Madeira" - | "Atlantic/Reykjavik" - | "Atlantic/South_Georgia" - | "Atlantic/St_Helena" - | "Atlantic/Stanley" - | "Australia/ACT" - | "Australia/Adelaide" - | "Australia/Brisbane" - | "Australia/Broken_Hill" - | "Australia/Canberra" - | "Australia/Currie" - | "Australia/Darwin" - | "Australia/Eucla" - | "Australia/Hobart" - | "Australia/LHI" - | "Australia/Lindeman" - | "Australia/Lord_Howe" - | "Australia/Melbourne" - | "Australia/NSW" - | "Australia/North" - | "Australia/Perth" - | "Australia/Queensland" - | "Australia/South" - | "Australia/Sydney" - | "Australia/Tasmania" - | "Australia/Victoria" - | "Australia/West" - | "Australia/Yancowinna" - | "Brazil/Acre" - | "Brazil/DeNoronha" - | "Brazil/East" - | "Brazil/West" - | "CET" - | "CST6CDT" - | "Canada/Atlantic" - | "Canada/Central" - | "Canada/Eastern" - | "Canada/Mountain" - | "Canada/Newfoundland" - | "Canada/Pacific" - | "Canada/Saskatchewan" - | "Canada/Yukon" - | "Chile/Continental" - | "Chile/EasterIsland" - | "Cuba" - | "EET" - | "EST" - | "EST5EDT" - | "Egypt" - | "Eire" - | "Etc/GMT" - | "Etc/GMT+0" - | "Etc/GMT+1" - | "Etc/GMT+10" - | "Etc/GMT+11" - | "Etc/GMT+12" - | "Etc/GMT+2" - | "Etc/GMT+3" - | "Etc/GMT+4" - | "Etc/GMT+5" - | "Etc/GMT+6" - | "Etc/GMT+7" - | "Etc/GMT+8" - | "Etc/GMT+9" - | "Etc/GMT-0" - | "Etc/GMT-1" - | "Etc/GMT-10" - | "Etc/GMT-11" - | "Etc/GMT-12" - | "Etc/GMT-13" - | "Etc/GMT-14" - | "Etc/GMT-2" - | "Etc/GMT-3" - | "Etc/GMT-4" - | "Etc/GMT-5" - | "Etc/GMT-6" - | "Etc/GMT-7" - | "Etc/GMT-8" - | "Etc/GMT-9" - | "Etc/GMT0" - | "Etc/Greenwich" - | "Etc/UCT" - | "Etc/UTC" - | "Etc/Universal" - | "Etc/Zulu" - | "Europe/Amsterdam" - | "Europe/Andorra" - | "Europe/Astrakhan" - | "Europe/Athens" - | "Europe/Belfast" - | "Europe/Belgrade" - | "Europe/Berlin" - | "Europe/Bratislava" - | "Europe/Brussels" - | "Europe/Bucharest" - | "Europe/Budapest" - | "Europe/Busingen" - | "Europe/Chisinau" - | "Europe/Copenhagen" - | "Europe/Dublin" - | "Europe/Gibraltar" - | "Europe/Guernsey" - | "Europe/Helsinki" - | "Europe/Isle_of_Man" - | "Europe/Istanbul" - | "Europe/Jersey" - | "Europe/Kaliningrad" - | "Europe/Kiev" - | "Europe/Kirov" - | "Europe/Lisbon" - | "Europe/Ljubljana" - | "Europe/London" - | "Europe/Luxembourg" - | "Europe/Madrid" - | "Europe/Malta" - | "Europe/Mariehamn" - | "Europe/Minsk" - | "Europe/Monaco" - | "Europe/Moscow" - | "Europe/Nicosia" - | "Europe/Oslo" - | "Europe/Paris" - | "Europe/Podgorica" - | "Europe/Prague" - | "Europe/Riga" - | "Europe/Rome" - | "Europe/Samara" - | "Europe/San_Marino" - | "Europe/Sarajevo" - | "Europe/Saratov" - | "Europe/Simferopol" - | "Europe/Skopje" - | "Europe/Sofia" - | "Europe/Stockholm" - | "Europe/Tallinn" - | "Europe/Tirane" - | "Europe/Tiraspol" - | "Europe/Ulyanovsk" - | "Europe/Uzhgorod" - | "Europe/Vaduz" - | "Europe/Vatican" - | "Europe/Vienna" - | "Europe/Vilnius" - | "Europe/Volgograd" - | "Europe/Warsaw" - | "Europe/Zagreb" - | "Europe/Zaporozhye" - | "Europe/Zurich" - | "Factory" - | "GB" - | "GB-Eire" - | "GMT" - | "GMT+0" - | "GMT-0" - | "GMT0" - | "Greenwich" - | "HST" - | "Hongkong" - | "Iceland" - | "Indian/Antananarivo" - | "Indian/Chagos" - | "Indian/Christmas" - | "Indian/Cocos" - | "Indian/Comoro" - | "Indian/Kerguelen" - | "Indian/Mahe" - | "Indian/Maldives" - | "Indian/Mauritius" - | "Indian/Mayotte" - | "Indian/Reunion" - | "Iran" - | "Israel" - | "Jamaica" - | "Japan" - | "Kwajalein" - | "Libya" - | "MET" - | "MST" - | "MST7MDT" - | "Mexico/BajaNorte" - | "Mexico/BajaSur" - | "Mexico/General" - | "NZ" - | "NZ-CHAT" - | "Navajo" - | "PRC" - | "PST8PDT" - | "Pacific/Apia" - | "Pacific/Auckland" - | "Pacific/Bougainville" - | "Pacific/Chatham" - | "Pacific/Chuuk" - | "Pacific/Easter" - | "Pacific/Efate" - | "Pacific/Enderbury" - | "Pacific/Fakaofo" - | "Pacific/Fiji" - | "Pacific/Funafuti" - | "Pacific/Galapagos" - | "Pacific/Gambier" - | "Pacific/Guadalcanal" - | "Pacific/Guam" - | "Pacific/Honolulu" - | "Pacific/Johnston" - | "Pacific/Kiritimati" - | "Pacific/Kosrae" - | "Pacific/Kwajalein" - | "Pacific/Majuro" - | "Pacific/Marquesas" - | "Pacific/Midway" - | "Pacific/Nauru" - | "Pacific/Niue" - | "Pacific/Norfolk" - | "Pacific/Noumea" - | "Pacific/Pago_Pago" - | "Pacific/Palau" - | "Pacific/Pitcairn" - | "Pacific/Pohnpei" - | "Pacific/Ponape" - | "Pacific/Port_Moresby" - | "Pacific/Rarotonga" - | "Pacific/Saipan" - | "Pacific/Samoa" - | "Pacific/Tahiti" - | "Pacific/Tarawa" - | "Pacific/Tongatapu" - | "Pacific/Truk" - | "Pacific/Wake" - | "Pacific/Wallis" - | "Pacific/Yap" - | "Poland" - | "Portugal" - | "ROC" - | "ROK" - | "Singapore" - | "Turkey" - | "UCT" - | "US/Alaska" - | "US/Aleutian" - | "US/Arizona" - | "US/Central" - | "US/East-Indiana" - | "US/Eastern" - | "US/Hawaii" - | "US/Indiana-Starke" - | "US/Michigan" - | "US/Mountain" - | "US/Pacific" - | "US/Pacific-New" - | "US/Samoa" - | "UTC" - | "Universal" - | "W-SU" - | "WET" - | "Zulu"; - }; + | 'Africa/Abidjan' + | 'Africa/Accra' + | 'Africa/Addis_Ababa' + | 'Africa/Algiers' + | 'Africa/Asmara' + | 'Africa/Asmera' + | 'Africa/Bamako' + | 'Africa/Bangui' + | 'Africa/Banjul' + | 'Africa/Bissau' + | 'Africa/Blantyre' + | 'Africa/Brazzaville' + | 'Africa/Bujumbura' + | 'Africa/Cairo' + | 'Africa/Casablanca' + | 'Africa/Ceuta' + | 'Africa/Conakry' + | 'Africa/Dakar' + | 'Africa/Dar_es_Salaam' + | 'Africa/Djibouti' + | 'Africa/Douala' + | 'Africa/El_Aaiun' + | 'Africa/Freetown' + | 'Africa/Gaborone' + | 'Africa/Harare' + | 'Africa/Johannesburg' + | 'Africa/Juba' + | 'Africa/Kampala' + | 'Africa/Khartoum' + | 'Africa/Kigali' + | 'Africa/Kinshasa' + | 'Africa/Lagos' + | 'Africa/Libreville' + | 'Africa/Lome' + | 'Africa/Luanda' + | 'Africa/Lubumbashi' + | 'Africa/Lusaka' + | 'Africa/Malabo' + | 'Africa/Maputo' + | 'Africa/Maseru' + | 'Africa/Mbabane' + | 'Africa/Mogadishu' + | 'Africa/Monrovia' + | 'Africa/Nairobi' + | 'Africa/Ndjamena' + | 'Africa/Niamey' + | 'Africa/Nouakchott' + | 'Africa/Ouagadougou' + | 'Africa/Porto-Novo' + | 'Africa/Sao_Tome' + | 'Africa/Timbuktu' + | 'Africa/Tripoli' + | 'Africa/Tunis' + | 'Africa/Windhoek' + | 'America/Adak' + | 'America/Anchorage' + | 'America/Anguilla' + | 'America/Antigua' + | 'America/Araguaina' + | 'America/Argentina/Buenos_Aires' + | 'America/Argentina/Catamarca' + | 'America/Argentina/ComodRivadavia' + | 'America/Argentina/Cordoba' + | 'America/Argentina/Jujuy' + | 'America/Argentina/La_Rioja' + | 'America/Argentina/Mendoza' + | 'America/Argentina/Rio_Gallegos' + | 'America/Argentina/Salta' + | 'America/Argentina/San_Juan' + | 'America/Argentina/San_Luis' + | 'America/Argentina/Tucuman' + | 'America/Argentina/Ushuaia' + | 'America/Aruba' + | 'America/Asuncion' + | 'America/Atikokan' + | 'America/Atka' + | 'America/Bahia' + | 'America/Bahia_Banderas' + | 'America/Barbados' + | 'America/Belem' + | 'America/Belize' + | 'America/Blanc-Sablon' + | 'America/Boa_Vista' + | 'America/Bogota' + | 'America/Boise' + | 'America/Buenos_Aires' + | 'America/Cambridge_Bay' + | 'America/Campo_Grande' + | 'America/Cancun' + | 'America/Caracas' + | 'America/Catamarca' + | 'America/Cayenne' + | 'America/Cayman' + | 'America/Chicago' + | 'America/Chihuahua' + | 'America/Coral_Harbour' + | 'America/Cordoba' + | 'America/Costa_Rica' + | 'America/Creston' + | 'America/Cuiaba' + | 'America/Curacao' + | 'America/Danmarkshavn' + | 'America/Dawson' + | 'America/Dawson_Creek' + | 'America/Denver' + | 'America/Detroit' + | 'America/Dominica' + | 'America/Edmonton' + | 'America/Eirunepe' + | 'America/El_Salvador' + | 'America/Ensenada' + | 'America/Fort_Nelson' + | 'America/Fort_Wayne' + | 'America/Fortaleza' + | 'America/Glace_Bay' + | 'America/Godthab' + | 'America/Goose_Bay' + | 'America/Grand_Turk' + | 'America/Grenada' + | 'America/Guadeloupe' + | 'America/Guatemala' + | 'America/Guayaquil' + | 'America/Guyana' + | 'America/Halifax' + | 'America/Havana' + | 'America/Hermosillo' + | 'America/Indiana/Indianapolis' + | 'America/Indiana/Knox' + | 'America/Indiana/Marengo' + | 'America/Indiana/Petersburg' + | 'America/Indiana/Tell_City' + | 'America/Indiana/Vevay' + | 'America/Indiana/Vincennes' + | 'America/Indiana/Winamac' + | 'America/Indianapolis' + | 'America/Inuvik' + | 'America/Iqaluit' + | 'America/Jamaica' + | 'America/Jujuy' + | 'America/Juneau' + | 'America/Kentucky/Louisville' + | 'America/Kentucky/Monticello' + | 'America/Knox_IN' + | 'America/Kralendijk' + | 'America/La_Paz' + | 'America/Lima' + | 'America/Los_Angeles' + | 'America/Louisville' + | 'America/Lower_Princes' + | 'America/Maceio' + | 'America/Managua' + | 'America/Manaus' + | 'America/Marigot' + | 'America/Martinique' + | 'America/Matamoros' + | 'America/Mazatlan' + | 'America/Mendoza' + | 'America/Menominee' + | 'America/Merida' + | 'America/Metlakatla' + | 'America/Mexico_City' + | 'America/Miquelon' + | 'America/Moncton' + | 'America/Monterrey' + | 'America/Montevideo' + | 'America/Montreal' + | 'America/Montserrat' + | 'America/Nassau' + | 'America/New_York' + | 'America/Nipigon' + | 'America/Nome' + | 'America/Noronha' + | 'America/North_Dakota/Beulah' + | 'America/North_Dakota/Center' + | 'America/North_Dakota/New_Salem' + | 'America/Ojinaga' + | 'America/Panama' + | 'America/Pangnirtung' + | 'America/Paramaribo' + | 'America/Phoenix' + | 'America/Port-au-Prince' + | 'America/Port_of_Spain' + | 'America/Porto_Acre' + | 'America/Porto_Velho' + | 'America/Puerto_Rico' + | 'America/Punta_Arenas' + | 'America/Rainy_River' + | 'America/Rankin_Inlet' + | 'America/Recife' + | 'America/Regina' + | 'America/Resolute' + | 'America/Rio_Branco' + | 'America/Rosario' + | 'America/Santa_Isabel' + | 'America/Santarem' + | 'America/Santiago' + | 'America/Santo_Domingo' + | 'America/Sao_Paulo' + | 'America/Scoresbysund' + | 'America/Shiprock' + | 'America/Sitka' + | 'America/St_Barthelemy' + | 'America/St_Johns' + | 'America/St_Kitts' + | 'America/St_Lucia' + | 'America/St_Thomas' + | 'America/St_Vincent' + | 'America/Swift_Current' + | 'America/Tegucigalpa' + | 'America/Thule' + | 'America/Thunder_Bay' + | 'America/Tijuana' + | 'America/Toronto' + | 'America/Tortola' + | 'America/Vancouver' + | 'America/Virgin' + | 'America/Whitehorse' + | 'America/Winnipeg' + | 'America/Yakutat' + | 'America/Yellowknife' + | 'Antarctica/Casey' + | 'Antarctica/Davis' + | 'Antarctica/DumontDUrville' + | 'Antarctica/Macquarie' + | 'Antarctica/Mawson' + | 'Antarctica/McMurdo' + | 'Antarctica/Palmer' + | 'Antarctica/Rothera' + | 'Antarctica/South_Pole' + | 'Antarctica/Syowa' + | 'Antarctica/Troll' + | 'Antarctica/Vostok' + | 'Arctic/Longyearbyen' + | 'Asia/Aden' + | 'Asia/Almaty' + | 'Asia/Amman' + | 'Asia/Anadyr' + | 'Asia/Aqtau' + | 'Asia/Aqtobe' + | 'Asia/Ashgabat' + | 'Asia/Ashkhabad' + | 'Asia/Atyrau' + | 'Asia/Baghdad' + | 'Asia/Bahrain' + | 'Asia/Baku' + | 'Asia/Bangkok' + | 'Asia/Barnaul' + | 'Asia/Beirut' + | 'Asia/Bishkek' + | 'Asia/Brunei' + | 'Asia/Calcutta' + | 'Asia/Chita' + | 'Asia/Choibalsan' + | 'Asia/Chongqing' + | 'Asia/Chungking' + | 'Asia/Colombo' + | 'Asia/Dacca' + | 'Asia/Damascus' + | 'Asia/Dhaka' + | 'Asia/Dili' + | 'Asia/Dubai' + | 'Asia/Dushanbe' + | 'Asia/Famagusta' + | 'Asia/Gaza' + | 'Asia/Harbin' + | 'Asia/Hebron' + | 'Asia/Ho_Chi_Minh' + | 'Asia/Hong_Kong' + | 'Asia/Hovd' + | 'Asia/Irkutsk' + | 'Asia/Istanbul' + | 'Asia/Jakarta' + | 'Asia/Jayapura' + | 'Asia/Jerusalem' + | 'Asia/Kabul' + | 'Asia/Kamchatka' + | 'Asia/Karachi' + | 'Asia/Kashgar' + | 'Asia/Kathmandu' + | 'Asia/Katmandu' + | 'Asia/Khandyga' + | 'Asia/Kolkata' + | 'Asia/Krasnoyarsk' + | 'Asia/Kuala_Lumpur' + | 'Asia/Kuching' + | 'Asia/Kuwait' + | 'Asia/Macao' + | 'Asia/Macau' + | 'Asia/Magadan' + | 'Asia/Makassar' + | 'Asia/Manila' + | 'Asia/Muscat' + | 'Asia/Nicosia' + | 'Asia/Novokuznetsk' + | 'Asia/Novosibirsk' + | 'Asia/Omsk' + | 'Asia/Oral' + | 'Asia/Phnom_Penh' + | 'Asia/Pontianak' + | 'Asia/Pyongyang' + | 'Asia/Qatar' + | 'Asia/Qostanay' + | 'Asia/Qyzylorda' + | 'Asia/Rangoon' + | 'Asia/Riyadh' + | 'Asia/Saigon' + | 'Asia/Sakhalin' + | 'Asia/Samarkand' + | 'Asia/Seoul' + | 'Asia/Shanghai' + | 'Asia/Singapore' + | 'Asia/Srednekolymsk' + | 'Asia/Taipei' + | 'Asia/Tashkent' + | 'Asia/Tbilisi' + | 'Asia/Tehran' + | 'Asia/Tel_Aviv' + | 'Asia/Thimbu' + | 'Asia/Thimphu' + | 'Asia/Tokyo' + | 'Asia/Tomsk' + | 'Asia/Ujung_Pandang' + | 'Asia/Ulaanbaatar' + | 'Asia/Ulan_Bator' + | 'Asia/Urumqi' + | 'Asia/Ust-Nera' + | 'Asia/Vientiane' + | 'Asia/Vladivostok' + | 'Asia/Yakutsk' + | 'Asia/Yangon' + | 'Asia/Yekaterinburg' + | 'Asia/Yerevan' + | 'Atlantic/Azores' + | 'Atlantic/Bermuda' + | 'Atlantic/Canary' + | 'Atlantic/Cape_Verde' + | 'Atlantic/Faeroe' + | 'Atlantic/Faroe' + | 'Atlantic/Jan_Mayen' + | 'Atlantic/Madeira' + | 'Atlantic/Reykjavik' + | 'Atlantic/South_Georgia' + | 'Atlantic/St_Helena' + | 'Atlantic/Stanley' + | 'Australia/ACT' + | 'Australia/Adelaide' + | 'Australia/Brisbane' + | 'Australia/Broken_Hill' + | 'Australia/Canberra' + | 'Australia/Currie' + | 'Australia/Darwin' + | 'Australia/Eucla' + | 'Australia/Hobart' + | 'Australia/LHI' + | 'Australia/Lindeman' + | 'Australia/Lord_Howe' + | 'Australia/Melbourne' + | 'Australia/NSW' + | 'Australia/North' + | 'Australia/Perth' + | 'Australia/Queensland' + | 'Australia/South' + | 'Australia/Sydney' + | 'Australia/Tasmania' + | 'Australia/Victoria' + | 'Australia/West' + | 'Australia/Yancowinna' + | 'Brazil/Acre' + | 'Brazil/DeNoronha' + | 'Brazil/East' + | 'Brazil/West' + | 'CET' + | 'CST6CDT' + | 'Canada/Atlantic' + | 'Canada/Central' + | 'Canada/Eastern' + | 'Canada/Mountain' + | 'Canada/Newfoundland' + | 'Canada/Pacific' + | 'Canada/Saskatchewan' + | 'Canada/Yukon' + | 'Chile/Continental' + | 'Chile/EasterIsland' + | 'Cuba' + | 'EET' + | 'EST' + | 'EST5EDT' + | 'Egypt' + | 'Eire' + | 'Etc/GMT' + | 'Etc/GMT+0' + | 'Etc/GMT+1' + | 'Etc/GMT+10' + | 'Etc/GMT+11' + | 'Etc/GMT+12' + | 'Etc/GMT+2' + | 'Etc/GMT+3' + | 'Etc/GMT+4' + | 'Etc/GMT+5' + | 'Etc/GMT+6' + | 'Etc/GMT+7' + | 'Etc/GMT+8' + | 'Etc/GMT+9' + | 'Etc/GMT-0' + | 'Etc/GMT-1' + | 'Etc/GMT-10' + | 'Etc/GMT-11' + | 'Etc/GMT-12' + | 'Etc/GMT-13' + | 'Etc/GMT-14' + | 'Etc/GMT-2' + | 'Etc/GMT-3' + | 'Etc/GMT-4' + | 'Etc/GMT-5' + | 'Etc/GMT-6' + | 'Etc/GMT-7' + | 'Etc/GMT-8' + | 'Etc/GMT-9' + | 'Etc/GMT0' + | 'Etc/Greenwich' + | 'Etc/UCT' + | 'Etc/UTC' + | 'Etc/Universal' + | 'Etc/Zulu' + | 'Europe/Amsterdam' + | 'Europe/Andorra' + | 'Europe/Astrakhan' + | 'Europe/Athens' + | 'Europe/Belfast' + | 'Europe/Belgrade' + | 'Europe/Berlin' + | 'Europe/Bratislava' + | 'Europe/Brussels' + | 'Europe/Bucharest' + | 'Europe/Budapest' + | 'Europe/Busingen' + | 'Europe/Chisinau' + | 'Europe/Copenhagen' + | 'Europe/Dublin' + | 'Europe/Gibraltar' + | 'Europe/Guernsey' + | 'Europe/Helsinki' + | 'Europe/Isle_of_Man' + | 'Europe/Istanbul' + | 'Europe/Jersey' + | 'Europe/Kaliningrad' + | 'Europe/Kiev' + | 'Europe/Kirov' + | 'Europe/Lisbon' + | 'Europe/Ljubljana' + | 'Europe/London' + | 'Europe/Luxembourg' + | 'Europe/Madrid' + | 'Europe/Malta' + | 'Europe/Mariehamn' + | 'Europe/Minsk' + | 'Europe/Monaco' + | 'Europe/Moscow' + | 'Europe/Nicosia' + | 'Europe/Oslo' + | 'Europe/Paris' + | 'Europe/Podgorica' + | 'Europe/Prague' + | 'Europe/Riga' + | 'Europe/Rome' + | 'Europe/Samara' + | 'Europe/San_Marino' + | 'Europe/Sarajevo' + | 'Europe/Saratov' + | 'Europe/Simferopol' + | 'Europe/Skopje' + | 'Europe/Sofia' + | 'Europe/Stockholm' + | 'Europe/Tallinn' + | 'Europe/Tirane' + | 'Europe/Tiraspol' + | 'Europe/Ulyanovsk' + | 'Europe/Uzhgorod' + | 'Europe/Vaduz' + | 'Europe/Vatican' + | 'Europe/Vienna' + | 'Europe/Vilnius' + | 'Europe/Volgograd' + | 'Europe/Warsaw' + | 'Europe/Zagreb' + | 'Europe/Zaporozhye' + | 'Europe/Zurich' + | 'Factory' + | 'GB' + | 'GB-Eire' + | 'GMT' + | 'GMT+0' + | 'GMT-0' + | 'GMT0' + | 'Greenwich' + | 'HST' + | 'Hongkong' + | 'Iceland' + | 'Indian/Antananarivo' + | 'Indian/Chagos' + | 'Indian/Christmas' + | 'Indian/Cocos' + | 'Indian/Comoro' + | 'Indian/Kerguelen' + | 'Indian/Mahe' + | 'Indian/Maldives' + | 'Indian/Mauritius' + | 'Indian/Mayotte' + | 'Indian/Reunion' + | 'Iran' + | 'Israel' + | 'Jamaica' + | 'Japan' + | 'Kwajalein' + | 'Libya' + | 'MET' + | 'MST' + | 'MST7MDT' + | 'Mexico/BajaNorte' + | 'Mexico/BajaSur' + | 'Mexico/General' + | 'NZ' + | 'NZ-CHAT' + | 'Navajo' + | 'PRC' + | 'PST8PDT' + | 'Pacific/Apia' + | 'Pacific/Auckland' + | 'Pacific/Bougainville' + | 'Pacific/Chatham' + | 'Pacific/Chuuk' + | 'Pacific/Easter' + | 'Pacific/Efate' + | 'Pacific/Enderbury' + | 'Pacific/Fakaofo' + | 'Pacific/Fiji' + | 'Pacific/Funafuti' + | 'Pacific/Galapagos' + | 'Pacific/Gambier' + | 'Pacific/Guadalcanal' + | 'Pacific/Guam' + | 'Pacific/Honolulu' + | 'Pacific/Johnston' + | 'Pacific/Kiritimati' + | 'Pacific/Kosrae' + | 'Pacific/Kwajalein' + | 'Pacific/Majuro' + | 'Pacific/Marquesas' + | 'Pacific/Midway' + | 'Pacific/Nauru' + | 'Pacific/Niue' + | 'Pacific/Norfolk' + | 'Pacific/Noumea' + | 'Pacific/Pago_Pago' + | 'Pacific/Palau' + | 'Pacific/Pitcairn' + | 'Pacific/Pohnpei' + | 'Pacific/Ponape' + | 'Pacific/Port_Moresby' + | 'Pacific/Rarotonga' + | 'Pacific/Saipan' + | 'Pacific/Samoa' + | 'Pacific/Tahiti' + | 'Pacific/Tarawa' + | 'Pacific/Tongatapu' + | 'Pacific/Truk' + | 'Pacific/Wake' + | 'Pacific/Wallis' + | 'Pacific/Yap' + | 'Poland' + | 'Portugal' + | 'ROC' + | 'ROK' + | 'Singapore' + | 'Turkey' + | 'UCT' + | 'US/Alaska' + | 'US/Aleutian' + | 'US/Arizona' + | 'US/Central' + | 'US/East-Indiana' + | 'US/Eastern' + | 'US/Hawaii' + | 'US/Indiana-Starke' + | 'US/Michigan' + | 'US/Mountain' + | 'US/Pacific' + | 'US/Pacific-New' + | 'US/Samoa' + | 'UTC' + | 'Universal' + | 'W-SU' + | 'WET' + | 'Zulu' + } /** @description The ID of the [report type](https://stripe.com/docs/reporting/statements/api#report-types) to run, such as `"balance.summary.1"`. */ - readonly report_type: string; - }; - }; - }; + readonly report_type: string + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["reporting.report_run"]; - }; + readonly schema: definitions['reporting.report_run'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves the details of an existing Report Run. (Requires a live-mode API key.)

*/ readonly GetReportingReportRunsReportRun: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly report_run: string; - }; - }; + readonly report_run: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["reporting.report_run"]; - }; + readonly schema: definitions['reporting.report_run'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Returns a full list of Report Types. (Requires a live-mode API key.)

*/ readonly GetReportingReportTypes: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; - }; + readonly expand?: readonly unknown[] + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["reporting.report_type"][]; + readonly data: readonly definitions['reporting.report_type'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves the details of a Report Type. (Requires a live-mode API key.)

*/ readonly GetReportingReportTypesReportType: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly report_type: string; - }; - }; + readonly report_type: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["reporting.report_type"]; - }; + readonly schema: definitions['reporting.report_type'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly GetReviews: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - readonly created?: number; + readonly expand?: readonly unknown[] + readonly created?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["review"][]; + readonly data: readonly definitions['review'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves a Review object.

*/ readonly GetReviewsReview: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly review: string; - }; - }; + readonly review: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["review"]; - }; + readonly schema: definitions['review'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly PostReviewsReviewApprove: { readonly parameters: { readonly path: { - readonly review: string; - }; + readonly review: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["review"]; - }; + readonly schema: definitions['review'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Returns a list of SetupIntents.

*/ readonly GetSetupIntents: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** 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. */ - readonly created?: number; + readonly created?: number /** Only return SetupIntents for the customer specified by this customer ID. */ - readonly customer?: string; + readonly customer?: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** Only return SetupIntents associated with the specified payment method. */ - readonly payment_method?: string; + readonly payment_method?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["setup_intent"][]; + readonly data: readonly definitions['setup_intent'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

Creates a SetupIntent object.

* @@ -26043,17 +25956,17 @@ export interface operations { /** Body parameters for the request. */ readonly payload?: { /** @description Set to `true` to attempt to confirm this SetupIntent immediately. This parameter defaults to `false`. If the payment method attached is a card, a return_url may be provided in case additional authentication is required. */ - readonly confirm?: boolean; + readonly confirm?: boolean /** * @description ID of the Customer this SetupIntent belongs to, if one exists. * * If 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. */ - readonly customer?: string; + readonly customer?: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string; + readonly description?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** * secret_key_param * @description This hash contains details about the Mandate to create. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm). @@ -26061,24 +25974,24 @@ export interface operations { readonly mandate_data?: { /** customer_acceptance_param */ readonly customer_acceptance: { - readonly accepted_at?: number; + readonly accepted_at?: number /** offline_param */ - readonly offline?: { readonly [key: string]: unknown }; + readonly offline?: { readonly [key: string]: unknown } /** online_param */ readonly online?: { - readonly ip_address: string; - readonly user_agent: string; - }; + readonly ip_address: string + readonly user_agent: string + } /** @enum {string} */ - readonly type: "offline" | "online"; - }; - }; + readonly type: 'offline' | 'online' + } + } /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: { readonly [key: string]: unknown }; + readonly metadata?: { readonly [key: string]: unknown } /** @description The Stripe account ID for which this SetupIntent is created. */ - readonly on_behalf_of?: string; + readonly on_behalf_of?: string /** @description ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. */ - readonly payment_method?: string; + readonly payment_method?: string /** * payment_method_options_param * @description Payment-method-specific configuration for this SetupIntent. @@ -26087,40 +26000,40 @@ export interface operations { /** setup_intent_param */ readonly card?: { /** @enum {string} */ - readonly request_three_d_secure?: "any" | "automatic"; - }; - }; + readonly request_three_d_secure?: 'any' | 'automatic' + } + } /** @description The list of payment method types (e.g. card) that this SetupIntent is allowed to use. If this is not provided, defaults to ["card"]. */ - readonly payment_method_types?: readonly string[]; + readonly payment_method_types?: readonly string[] /** @description The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm). */ - readonly return_url?: string; + readonly return_url?: string /** * setup_intent_single_use_params * @description If this hash is populated, this SetupIntent will generate a single_use Mandate on success. */ readonly single_use?: { - readonly amount: number; - readonly currency: string; - }; + readonly amount: number + readonly currency: string + } /** * @description Indicates how the payment method is intended to be used in the future. If not provided, this value defaults to `off_session`. * @enum {string} */ - readonly usage?: "off_session" | "on_session"; - }; - }; - }; + readonly usage?: 'off_session' | 'on_session' + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["setup_intent"]; - }; + readonly schema: definitions['setup_intent'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

Retrieves the details of a SetupIntent that has previously been created.

* @@ -26132,31 +26045,31 @@ export interface operations { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** The client secret of the SetupIntent. Required if a publishable key is used to retrieve the SetupIntent. */ - readonly client_secret?: string; - }; + readonly client_secret?: string + } readonly path: { - readonly intent: string; - }; - }; + readonly intent: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["setup_intent"]; - }; + readonly schema: definitions['setup_intent'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Updates a SetupIntent object.

*/ readonly PostSetupIntentsIntent: { readonly parameters: { readonly path: { - readonly intent: string; - }; + readonly intent: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { @@ -26165,15 +26078,15 @@ export interface operations { * * If 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. */ - readonly customer?: string; + readonly customer?: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string; + readonly description?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. */ - readonly payment_method?: string; + readonly payment_method?: string /** * payment_method_options_param * @description Payment-method-specific configuration for this SetupIntent. @@ -26182,25 +26095,25 @@ export interface operations { /** setup_intent_param */ readonly card?: { /** @enum {string} */ - readonly request_three_d_secure?: "any" | "automatic"; - }; - }; + readonly request_three_d_secure?: 'any' | 'automatic' + } + } /** @description The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. If this is not provided, defaults to ["card"]. */ - readonly payment_method_types?: readonly string[]; - }; - }; - }; + readonly payment_method_types?: readonly string[] + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["setup_intent"]; - }; + readonly schema: definitions['setup_intent'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

A SetupIntent object can be canceled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action.

* @@ -26209,8 +26122,8 @@ export interface operations { readonly PostSetupIntentsIntentCancel: { readonly parameters: { readonly path: { - readonly intent: string; - }; + readonly intent: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { @@ -26218,23 +26131,23 @@ export interface operations { * @description Reason for canceling this SetupIntent. Possible values are `abandoned`, `requested_by_customer`, or `duplicate` * @enum {string} */ - readonly cancellation_reason?: "abandoned" | "duplicate" | "requested_by_customer"; + readonly cancellation_reason?: 'abandoned' | 'duplicate' | 'requested_by_customer' /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["setup_intent"]; - }; + readonly schema: definitions['setup_intent'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

Confirm that your customer intends to set up the current or * provided payment method. For example, you would confirm a SetupIntent @@ -26253,15 +26166,15 @@ export interface operations { readonly PostSetupIntentsIntentConfirm: { readonly parameters: { readonly path: { - readonly intent: string; - }; + readonly intent: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description The client secret of the SetupIntent. */ - readonly client_secret?: string; + readonly client_secret?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** * secret_key_param * @description This hash contains details about the Mandate to create @@ -26269,20 +26182,20 @@ export interface operations { readonly mandate_data?: { /** customer_acceptance_param */ readonly customer_acceptance: { - readonly accepted_at?: number; + readonly accepted_at?: number /** offline_param */ - readonly offline?: { readonly [key: string]: unknown }; + readonly offline?: { readonly [key: string]: unknown } /** online_param */ readonly online?: { - readonly ip_address: string; - readonly user_agent: string; - }; + readonly ip_address: string + readonly user_agent: string + } /** @enum {string} */ - readonly type: "offline" | "online"; - }; - }; + readonly type: 'offline' | 'online' + } + } /** @description ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. */ - readonly payment_method?: string; + readonly payment_method?: string /** * payment_method_options_param * @description Payment-method-specific configuration for this SetupIntent. @@ -26291,133 +26204,133 @@ export interface operations { /** setup_intent_param */ readonly card?: { /** @enum {string} */ - readonly request_three_d_secure?: "any" | "automatic"; - }; - }; + readonly request_three_d_secure?: 'any' | 'automatic' + } + } /** * @description The URL to redirect your customer back to after they authenticate on the payment method's app or site. * If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. * This parameter is only used for cards and other redirect-based payment methods. */ - readonly return_url?: string; - }; - }; - }; + readonly return_url?: string + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["setup_intent"]; - }; + readonly schema: definitions['setup_intent'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Returns a list of scheduled query runs.

*/ readonly GetSigmaScheduledQueryRuns: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["scheduled_query_run"][]; + readonly data: readonly definitions['scheduled_query_run'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves the details of an scheduled query run.

*/ readonly GetSigmaScheduledQueryRunsScheduledQueryRun: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly scheduled_query_run: string; - }; - }; + readonly scheduled_query_run: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["scheduled_query_run"]; - }; + readonly schema: definitions['scheduled_query_run'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly GetSkus: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** Only return SKUs that are active or inactive (e.g., pass `false` to list all inactive products). */ - readonly active?: boolean; + readonly active?: boolean /** Only return SKUs that have the specified key-value pairs in this partially constructed dictionary. Can be specified only if `product` is also supplied. For instance, if the associated product has attributes `["color", "size"]`, passing in `attributes[color]=red` returns all the SKUs for this product that have `color` set to `red`. */ - readonly attributes?: string; + readonly attributes?: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** Only return SKUs with the given IDs. */ - readonly ids?: readonly unknown[]; + readonly ids?: readonly unknown[] /** Only return SKUs that are either in stock or out of stock (e.g., pass `false` to list all SKUs that are out of stock). If no value is provided, all SKUs are returned. */ - readonly in_stock?: boolean; + readonly in_stock?: boolean /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** The ID of the product whose SKUs will be retrieved. Must be a product with type `good`. */ - readonly product?: string; + readonly product?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["sku"][]; + readonly data: readonly definitions['sku'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Creates a new SKU associated with a product.

*/ readonly PostSkus: { readonly parameters: { @@ -26425,80 +26338,80 @@ export interface operations { /** Body parameters for the request. */ readonly payload: { /** @description Whether the SKU is available for purchase. Default to `true`. */ - readonly active?: boolean; + readonly active?: boolean /** @description A dictionary of attributes and values for the attributes defined by the product. If, for example, a product's attributes are `["size", "gender"]`, a valid SKU has the following dictionary of attributes: `{"size": "Medium", "gender": "Unisex"}`. */ - readonly attributes?: { readonly [key: string]: unknown }; + readonly attributes?: { readonly [key: string]: unknown } /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The identifier for the SKU. Must be unique. If not provided, an identifier will be randomly generated. */ - readonly id?: string; + readonly id?: string /** @description The URL of an image for this SKU, meant to be displayable to the customer. */ - readonly image?: string; + readonly image?: string /** * inventory_specs * @description Description of the SKU's inventory. */ readonly inventory: { - readonly quantity?: number; + readonly quantity?: number /** @enum {string} */ - readonly type?: "bucket" | "finite" | "infinite"; + readonly type?: 'bucket' | 'finite' | 'infinite' /** @enum {string} */ - readonly value?: "" | "in_stock" | "limited" | "out_of_stock"; - }; + readonly value?: '' | 'in_stock' | 'limited' | 'out_of_stock' + } /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: { readonly [key: string]: unknown }; + readonly metadata?: { readonly [key: string]: unknown } /** * package_dimensions_specs * @description The dimensions of this SKU for shipping purposes. */ readonly package_dimensions?: { - readonly height: number; - readonly length: number; - readonly weight: number; - readonly width: number; - }; + readonly height: number + readonly length: number + readonly weight: number + readonly width: number + } /** @description The cost of the item as a nonnegative integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a zero-decimal currency). */ - readonly price: number; + readonly price: number /** @description The ID of the product this SKU is associated with. Must be a product with type `good`. */ - readonly product: string; - }; - }; - }; + readonly product: string + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["sku"]; - }; + readonly schema: definitions['sku'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly GetSkusId: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["deleted_sku"]; - }; + readonly schema: definitions['deleted_sku'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

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

* @@ -26507,72 +26420,72 @@ export interface operations { readonly PostSkusId: { readonly parameters: { readonly path: { - readonly id: string; - }; + readonly id: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Whether this SKU is available for purchase. */ - readonly active?: boolean; + readonly active?: boolean /** @description A dictionary of attributes and values for the attributes defined by the product. When specified, `attributes` will partially update the existing attributes dictionary on the product, with the postcondition that a value must be present for each attribute key on the product. */ - readonly attributes?: { readonly [key: string]: unknown }; + readonly attributes?: { readonly [key: string]: unknown } /** @description 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). */ - readonly currency?: string; + readonly currency?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The URL of an image for this SKU, meant to be displayable to the customer. */ - readonly image?: string; + readonly image?: string /** * inventory_update_specs * @description Description of the SKU's inventory. */ readonly inventory?: { - readonly quantity?: number; + readonly quantity?: number /** @enum {string} */ - readonly type?: "bucket" | "finite" | "infinite"; + readonly type?: 'bucket' | 'finite' | 'infinite' /** @enum {string} */ - readonly value?: "" | "in_stock" | "limited" | "out_of_stock"; - }; + readonly value?: '' | 'in_stock' | 'limited' | 'out_of_stock' + } /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description The dimensions of this SKU for shipping purposes. */ - readonly package_dimensions?: unknown; + readonly package_dimensions?: unknown /** @description The cost of the item as a positive integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a zero-decimal currency). */ - readonly price?: number; + readonly price?: number /** @description The ID of the product that this SKU should belong to. The product must exist, have the same set of attribute names as the SKU's current product, and be of type `good`. */ - readonly product?: string; - }; - }; - }; + readonly product?: string + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["sku"]; - }; + readonly schema: definitions['sku'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Delete a SKU. Deleting a SKU is only possible until it has been used in an order.

*/ readonly DeleteSkusId: { readonly parameters: { readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["deleted_sku"]; - }; + readonly schema: definitions['deleted_sku'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Creates a new source object.

*/ readonly PostSources: { readonly parameters: { @@ -26580,18 +26493,18 @@ export interface operations { /** Body parameters for the request. */ readonly payload?: { /** @description Amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources. Not supported for `receiver` type sources, where charge amount may not be specified until funds land. */ - readonly amount?: number; + readonly amount?: number /** @description 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. */ - readonly currency?: string; + readonly currency?: string /** @description The `Customer` to whom the original source is attached to. Must be set when the original source is not a `Source` (e.g., `Card`). */ - readonly customer?: string; + readonly customer?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** * @description The authentication `flow` of the source to create. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`. It is generally inferred unless a type supports multiple flows. * @enum {string} */ - readonly flow?: "code_verification" | "none" | "receiver" | "redirect"; + readonly flow?: 'code_verification' | 'none' | 'receiver' | 'redirect' /** * mandate_params * @description Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status. @@ -26599,35 +26512,35 @@ export interface operations { readonly mandate?: { /** mandate_acceptance_params */ readonly acceptance?: { - readonly date?: number; - readonly ip?: string; + readonly date?: number + readonly ip?: string /** mandate_offline_acceptance_params */ readonly offline?: { - readonly contact_email: string; - }; + readonly contact_email: string + } /** mandate_online_acceptance_params */ readonly online?: { - readonly date?: number; - readonly ip?: string; - readonly user_agent?: string; - }; + readonly date?: number + readonly ip?: string + readonly user_agent?: string + } /** @enum {string} */ - readonly status: "accepted" | "pending" | "refused" | "revoked"; + readonly status: 'accepted' | 'pending' | 'refused' | 'revoked' /** @enum {string} */ - readonly type?: "offline" | "online"; - readonly user_agent?: string; - }; - readonly amount?: unknown; - readonly currency?: string; + readonly type?: 'offline' | 'online' + readonly user_agent?: string + } + readonly amount?: unknown + readonly currency?: string /** @enum {string} */ - readonly interval?: "one_time" | "scheduled" | "variable"; + readonly interval?: 'one_time' | 'scheduled' | 'variable' /** @enum {string} */ - readonly notification_method?: "deprecated_none" | "email" | "manual" | "none" | "stripe_email"; - }; + readonly notification_method?: 'deprecated_none' | 'email' | 'manual' | 'none' | 'stripe_email' + } /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: { readonly [key: string]: unknown }; + readonly metadata?: { readonly [key: string]: unknown } /** @description The source to share. */ - readonly original_source?: string; + readonly original_source?: string /** * owner * @description Information about the owner of the payment instrument that may be used or required by particular source types. @@ -26635,112 +26548,112 @@ export interface operations { readonly owner?: { /** source_address */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; - readonly email?: string; - readonly name?: string; - readonly phone?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } + readonly email?: string + readonly name?: string + readonly phone?: string + } /** * receiver_params * @description Optional parameters for the receiver flow. Can be set only if the source is a receiver (`flow` is `receiver`). */ readonly receiver?: { /** @enum {string} */ - readonly refund_attributes_method?: "email" | "manual" | "none"; - }; + readonly refund_attributes_method?: 'email' | 'manual' | 'none' + } /** * redirect_params * @description Parameters required for the redirect flow. Required if the source is authenticated by a redirect (`flow` is `redirect`). */ readonly redirect?: { - readonly return_url: string; - }; + readonly return_url: string + } /** * shallow_order_specs * @description Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it. */ readonly source_order?: { readonly items?: readonly { - readonly amount?: number; - readonly currency?: string; - readonly description?: string; - readonly parent?: string; - readonly quantity?: number; + readonly amount?: number + readonly currency?: string + readonly description?: string + readonly parent?: string + readonly quantity?: number /** @enum {string} */ - readonly type?: "discount" | "shipping" | "sku" | "tax"; - }[]; + readonly type?: 'discount' | 'shipping' | 'sku' | 'tax' + }[] /** order_shipping */ readonly shipping?: { /** address */ readonly address: { - readonly city?: string; - readonly country?: string; - readonly line1: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; - readonly carrier?: string; - readonly name?: string; - readonly phone?: string; - readonly tracking_number?: string; - }; - }; + readonly city?: string + readonly country?: string + readonly line1: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } + readonly carrier?: string + readonly name?: string + readonly phone?: string + readonly tracking_number?: string + } + } /** @description An arbitrary string to be displayed on your customer's statement. As an example, if your website is `RunClub` and the item you're charging for is a race ticket, you may want to specify a `statement_descriptor` of `RunClub 5K race ticket.` While many payment types will display this information, some may not display it at all. */ - readonly statement_descriptor?: string; + readonly statement_descriptor?: string /** @description An optional token used to create the source. When passed, token properties will override source parameters. */ - readonly token?: string; + readonly token?: string /** @description The `type` of the source to create. Required unless `customer` and `original_source` are specified (see the [Cloning card Sources](https://stripe.com/docs/sources/connect#cloning-card-sources) guide) */ - readonly type?: string; + readonly type?: string /** * @description 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. * @enum {string} */ - readonly usage?: "reusable" | "single_use"; - }; - }; - }; + readonly usage?: 'reusable' | 'single_use' + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["source"]; - }; + readonly schema: definitions['source'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly GetSourcesSource: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** The client secret of the source. Required if a publishable key is used to retrieve the source. */ - readonly client_secret?: string; - }; + readonly client_secret?: string + } readonly path: { - readonly source: string; - }; - }; + readonly source: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["source"]; - }; + readonly schema: definitions['source'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

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

* @@ -26749,15 +26662,15 @@ export interface operations { readonly PostSourcesSource: { readonly parameters: { readonly path: { - readonly source: string; - }; + readonly source: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Amount associated with the source. */ - readonly amount?: number; + readonly amount?: number /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** * mandate_params * @description Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status. @@ -26765,33 +26678,33 @@ export interface operations { readonly mandate?: { /** mandate_acceptance_params */ readonly acceptance?: { - readonly date?: number; - readonly ip?: string; + readonly date?: number + readonly ip?: string /** mandate_offline_acceptance_params */ readonly offline?: { - readonly contact_email: string; - }; + readonly contact_email: string + } /** mandate_online_acceptance_params */ readonly online?: { - readonly date?: number; - readonly ip?: string; - readonly user_agent?: string; - }; + readonly date?: number + readonly ip?: string + readonly user_agent?: string + } /** @enum {string} */ - readonly status: "accepted" | "pending" | "refused" | "revoked"; + readonly status: 'accepted' | 'pending' | 'refused' | 'revoked' /** @enum {string} */ - readonly type?: "offline" | "online"; - readonly user_agent?: string; - }; - readonly amount?: unknown; - readonly currency?: string; + readonly type?: 'offline' | 'online' + readonly user_agent?: string + } + readonly amount?: unknown + readonly currency?: string /** @enum {string} */ - readonly interval?: "one_time" | "scheduled" | "variable"; + readonly interval?: 'one_time' | 'scheduled' | 'variable' /** @enum {string} */ - readonly notification_method?: "deprecated_none" | "email" | "manual" | "none" | "stripe_email"; - }; + readonly notification_method?: 'deprecated_none' | 'email' | 'manual' | 'none' | 'stripe_email' + } /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** * owner * @description Information about the owner of the payment instrument that may be used or required by particular source types. @@ -26799,212 +26712,212 @@ export interface operations { readonly owner?: { /** source_address */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; - readonly email?: string; - readonly name?: string; - readonly phone?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } + readonly email?: string + readonly name?: string + readonly phone?: string + } /** * order_params * @description Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it. */ readonly source_order?: { readonly items?: readonly { - readonly amount?: number; - readonly currency?: string; - readonly description?: string; - readonly parent?: string; - readonly quantity?: number; + readonly amount?: number + readonly currency?: string + readonly description?: string + readonly parent?: string + readonly quantity?: number /** @enum {string} */ - readonly type?: "discount" | "shipping" | "sku" | "tax"; - }[]; + readonly type?: 'discount' | 'shipping' | 'sku' | 'tax' + }[] /** order_shipping */ readonly shipping?: { /** address */ readonly address: { - readonly city?: string; - readonly country?: string; - readonly line1: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; - readonly carrier?: string; - readonly name?: string; - readonly phone?: string; - readonly tracking_number?: string; - }; - }; - }; - }; - }; - readonly responses: { - /** Successful response. */ - readonly 200: { - readonly schema: definitions["source"]; - }; - /** Error response. */ - readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly city?: string + readonly country?: string + readonly line1: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } + readonly carrier?: string + readonly name?: string + readonly phone?: string + readonly tracking_number?: string + } + } + } + } + } + readonly responses: { + /** Successful response. */ + readonly 200: { + readonly schema: definitions['source'] + } + /** Error response. */ + readonly default: { + readonly schema: definitions['error'] + } + } + } /**

Retrieves a new Source MandateNotification.

*/ readonly GetSourcesSourceMandateNotificationsMandateNotification: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly mandate_notification: string; - readonly source: string; - }; - }; + readonly mandate_notification: string + readonly source: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["source_mandate_notification"]; - }; + readonly schema: definitions['source_mandate_notification'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

List source transactions for a given source.

*/ readonly GetSourcesSourceSourceTransactions: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; + readonly starting_after?: string + } readonly path: { - readonly source: string; - }; - }; + readonly source: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["source_transaction"][]; + readonly data: readonly definitions['source_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly GetSourcesSourceSourceTransactionsSourceTransaction: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly source: string; - readonly source_transaction: string; - }; - }; + readonly source: string + readonly source_transaction: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["source_transaction"]; - }; + readonly schema: definitions['source_transaction'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Verify a given source.

*/ readonly PostSourcesSourceVerify: { readonly parameters: { readonly path: { - readonly source: string; - }; + readonly source: string + } readonly body: { /** Body parameters for the request. */ readonly payload: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The values needed to verify the source. */ - readonly values: readonly string[]; - }; - }; - }; + readonly values: readonly string[] + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["source"]; - }; + readonly schema: definitions['source'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Returns a list of your subscription items for a given subscription.

*/ readonly GetSubscriptionItems: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** The ID of the subscription whose items will be retrieved. */ - readonly subscription: string; - }; - }; + readonly subscription: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["subscription_item"][]; + readonly data: readonly definitions['subscription_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Adds a new item to an existing subscription. No existing items will be changed or replaced.

*/ readonly PostSubscriptionItems: { readonly parameters: { @@ -27012,11 +26925,11 @@ export interface operations { /** Body parameters for the request. */ readonly payload: { /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. */ - readonly billing_thresholds?: unknown; + readonly billing_thresholds?: unknown /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: { readonly [key: string]: unknown }; + readonly metadata?: { readonly [key: string]: unknown } /** * @description Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * @@ -27025,11 +26938,11 @@ export interface operations { * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not create a subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. * @enum {string} */ - readonly payment_behavior?: "allow_incomplete" | "error_if_incomplete" | "pending_if_incomplete"; + readonly payment_behavior?: 'allow_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete' /** @description The identifier of the plan to add to the subscription. */ - readonly plan?: string; + readonly plan?: string /** @description This field has been renamed to `proration_behavior`. `prorate=true` can be replaced with `proration_behavior=create_prorations` and `prorate=false` can be replaced with `proration_behavior=none`. */ - readonly prorate?: boolean; + readonly prorate?: boolean /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -27038,68 +26951,68 @@ export interface operations { * Prorations can be disabled by passing `none`. * @enum {string} */ - readonly proration_behavior?: "always_invoice" | "create_prorations" | "none"; + readonly proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. */ - readonly proration_date?: number; + readonly proration_date?: number /** @description The quantity you'd like to apply to the subscription item you're creating. */ - readonly quantity?: number; + readonly quantity?: number /** @description The identifier of the subscription to modify. */ - readonly subscription: string; + readonly subscription: string /** @description A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. */ - readonly tax_rates?: readonly string[]; - }; - }; - }; + readonly tax_rates?: readonly string[] + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["subscription_item"]; - }; + readonly schema: definitions['subscription_item'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves the invoice item with the given ID.

*/ readonly GetSubscriptionItemsItem: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly item: string; - }; - }; + readonly item: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["subscription_item"]; - }; + readonly schema: definitions['subscription_item'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Updates the plan or quantity of an item on a current subscription.

*/ readonly PostSubscriptionItemsItem: { readonly parameters: { readonly path: { - readonly item: string; - }; + readonly item: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. */ - readonly billing_thresholds?: unknown; + readonly billing_thresholds?: unknown /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. */ - readonly off_session?: boolean; + readonly off_session?: boolean /** * @description Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * @@ -27108,11 +27021,11 @@ export interface operations { * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not create a subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. * @enum {string} */ - readonly payment_behavior?: "allow_incomplete" | "error_if_incomplete" | "pending_if_incomplete"; + readonly payment_behavior?: 'allow_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete' /** @description The identifier of the new plan for this subscription item. */ - readonly plan?: string; + readonly plan?: string /** @description This field has been renamed to `proration_behavior`. `prorate=true` can be replaced with `proration_behavior=create_prorations` and `prorate=false` can be replaced with `proration_behavior=none`. */ - readonly prorate?: boolean; + readonly prorate?: boolean /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -27121,40 +27034,40 @@ export interface operations { * Prorations can be disabled by passing `none`. * @enum {string} */ - readonly proration_behavior?: "always_invoice" | "create_prorations" | "none"; + readonly proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. */ - readonly proration_date?: number; + readonly proration_date?: number /** @description The quantity you'd like to apply to the subscription item you're creating. */ - readonly quantity?: number; + readonly quantity?: number /** @description A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. */ - readonly tax_rates?: readonly string[]; - }; - }; - }; + readonly tax_rates?: readonly string[] + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["subscription_item"]; - }; + readonly schema: definitions['subscription_item'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.

*/ readonly DeleteSubscriptionItemsItem: { readonly parameters: { readonly path: { - readonly item: string; - }; + readonly item: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Delete all usage for the given subscription item. Allowed only when the current plan's `usage_type` is `metered`. */ - readonly clear_usage?: boolean; + readonly clear_usage?: boolean /** @description This field has been renamed to `proration_behavior`. `prorate=true` can be replaced with `proration_behavior=create_prorations` and `prorate=false` can be replaced with `proration_behavior=none`. */ - readonly prorate?: boolean; + readonly prorate?: boolean /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -27163,23 +27076,23 @@ export interface operations { * Prorations can be disabled by passing `none`. * @enum {string} */ - readonly proration_behavior?: "always_invoice" | "create_prorations" | "none"; + readonly proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. */ - readonly proration_date?: number; - }; - }; - }; + readonly proration_date?: number + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["deleted_subscription_item"]; - }; + readonly schema: definitions['deleted_subscription_item'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

For the specified subscription item, returns a list of summary objects. Each object in the list provides usage information that’s been summarized from multiple usage records and over a subscription billing period (e.g., 15 usage records in the billing plan’s month of September).

* @@ -27189,40 +27102,40 @@ export interface operations { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; + readonly starting_after?: string + } readonly path: { - readonly subscription_item: string; - }; - }; + readonly subscription_item: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["usage_record_summary"][]; + readonly data: readonly definitions['usage_record_summary'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

Creates a usage record for a specified subscription item and date, and fills it with a quantity.

* @@ -27235,8 +27148,8 @@ export interface operations { readonly PostSubscriptionItemsSubscriptionItemUsageRecords: { readonly parameters: { readonly path: { - readonly subscription_item: string; - }; + readonly subscription_item: string + } readonly body: { /** Body parameters for the request. */ readonly payload: { @@ -27244,75 +27157,75 @@ export interface operations { * @description Valid values are `increment` (default) or `set`. When using `increment` the specified `quantity` will be added to the usage at the specified timestamp. The `set` action will overwrite the usage quantity at that timestamp. If the subscription has [billing thresholds](https://stripe.com/docs/api/subscriptions/object#subscription_object-billing_thresholds), `increment` is the only allowed value. * @enum {string} */ - readonly action?: "increment" | "set"; + readonly action?: 'increment' | 'set' /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The usage quantity for the specified timestamp. */ - readonly quantity: number; + readonly quantity: number /** @description The timestamp for the usage event. This timestamp must be within the current billing period of the subscription of the provided `subscription_item`. */ - readonly timestamp: number; - }; - }; - }; + readonly timestamp: number + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["usage_record"]; - }; + readonly schema: definitions['usage_record'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves the list of your subscription schedules.

*/ readonly GetSubscriptionSchedules: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** Only return subscription schedules that were created canceled the given date interval. */ - readonly canceled_at?: number; + readonly canceled_at?: number /** Only return subscription schedules that completed during the given date interval. */ - readonly completed_at?: number; + readonly completed_at?: number /** Only return subscription schedules that were created during the given date interval. */ - readonly created?: number; + readonly created?: number /** Only return subscription schedules for the given customer. */ - readonly customer?: string; + readonly customer?: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** Only return subscription schedules that were released during the given date interval. */ - readonly released_at?: number; + readonly released_at?: number /** Only return subscription schedules that have not started yet. */ - readonly scheduled?: boolean; + readonly scheduled?: boolean /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["subscription_schedule"][]; + readonly data: readonly definitions['subscription_schedule'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Creates a new subscription schedule object. Each customer can have up to 25 active or scheduled subscriptions.

*/ readonly PostSubscriptionSchedules: { readonly parameters: { @@ -27320,103 +27233,103 @@ export interface operations { /** Body parameters for the request. */ readonly payload?: { /** @description The identifier of the customer to create the subscription schedule for. */ - readonly customer?: string; + readonly customer?: string /** * default_settings_params * @description Object representing the subscription schedule's default settings. */ readonly default_settings?: { - readonly billing_thresholds?: unknown; + readonly billing_thresholds?: unknown /** @enum {string} */ - readonly collection_method?: "charge_automatically" | "send_invoice"; - readonly default_payment_method?: string; + readonly collection_method?: 'charge_automatically' | 'send_invoice' + readonly default_payment_method?: string /** subscription_schedules_param */ readonly invoice_settings?: { - readonly days_until_due?: number; - }; - }; + readonly days_until_due?: number + } + } /** * @description Configures how the subscription schedule behaves 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. * @enum {string} */ - readonly end_behavior?: "cancel" | "none" | "release" | "renew"; + readonly end_behavior?: 'cancel' | 'none' | 'release' | 'renew' /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's plan(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls. */ - readonly from_subscription?: string; + readonly from_subscription?: string /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. */ readonly phases?: readonly { - readonly application_fee_percent?: number; - readonly billing_thresholds?: unknown; + readonly application_fee_percent?: number + readonly billing_thresholds?: unknown /** @enum {string} */ - readonly collection_method?: "charge_automatically" | "send_invoice"; - readonly coupon?: string; - readonly default_payment_method?: string; - readonly default_tax_rates?: readonly string[]; - readonly end_date?: number; + readonly collection_method?: 'charge_automatically' | 'send_invoice' + readonly coupon?: string + readonly default_payment_method?: string + readonly default_tax_rates?: readonly string[] + readonly end_date?: number /** subscription_schedules_param */ readonly invoice_settings?: { - readonly days_until_due?: number; - }; - readonly iterations?: number; + readonly days_until_due?: number + } + readonly iterations?: number readonly plans: readonly { - readonly billing_thresholds?: unknown; - readonly plan?: string; - readonly quantity?: number; - readonly tax_rates?: readonly string[]; - }[]; + readonly billing_thresholds?: unknown + readonly plan?: string + readonly quantity?: number + readonly tax_rates?: readonly string[] + }[] /** @enum {string} */ - readonly proration_behavior?: "always_invoice" | "create_prorations" | "none"; - readonly tax_percent?: number; - readonly trial?: boolean; - readonly trial_end?: number; - }[]; + readonly proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' + readonly tax_percent?: number + readonly trial?: boolean + readonly trial_end?: number + }[] /** @description When the subscription schedule starts. We recommend using `now` so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on. */ - readonly start_date?: unknown; - }; - }; - }; + readonly start_date?: unknown + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["subscription_schedule"]; - }; + readonly schema: definitions['subscription_schedule'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly GetSubscriptionSchedulesSchedule: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly schedule: string; - }; - }; + readonly schedule: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["subscription_schedule"]; - }; + readonly schema: definitions['subscription_schedule'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Updates an existing subscription schedule.

*/ readonly PostSubscriptionSchedulesSchedule: { readonly parameters: { readonly path: { - readonly schedule: string; - }; + readonly schedule: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { @@ -27425,176 +27338,176 @@ export interface operations { * @description Object representing the subscription schedule's default settings. */ readonly default_settings?: { - readonly billing_thresholds?: unknown; + readonly billing_thresholds?: unknown /** @enum {string} */ - readonly collection_method?: "charge_automatically" | "send_invoice"; - readonly default_payment_method?: string; + readonly collection_method?: 'charge_automatically' | 'send_invoice' + readonly default_payment_method?: string /** subscription_schedules_param */ readonly invoice_settings?: { - readonly days_until_due?: number; - }; - }; + readonly days_until_due?: number + } + } /** * @description Configures how the subscription schedule behaves 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. * @enum {string} */ - readonly end_behavior?: "cancel" | "none" | "release" | "renew"; + readonly end_behavior?: 'cancel' | 'none' | 'release' | 'renew' /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. Note that past phases can be omitted. */ readonly phases?: readonly { - readonly application_fee_percent?: number; - readonly billing_thresholds?: unknown; + readonly application_fee_percent?: number + readonly billing_thresholds?: unknown /** @enum {string} */ - readonly collection_method?: "charge_automatically" | "send_invoice"; - readonly coupon?: string; - readonly default_payment_method?: string; - readonly default_tax_rates?: readonly string[]; - readonly end_date?: unknown; + readonly collection_method?: 'charge_automatically' | 'send_invoice' + readonly coupon?: string + readonly default_payment_method?: string + readonly default_tax_rates?: readonly string[] + readonly end_date?: unknown /** subscription_schedules_param */ readonly invoice_settings?: { - readonly days_until_due?: number; - }; - readonly iterations?: number; + readonly days_until_due?: number + } + readonly iterations?: number readonly plans: readonly { - readonly billing_thresholds?: unknown; - readonly plan?: string; - readonly quantity?: number; - readonly tax_rates?: readonly string[]; - }[]; + readonly billing_thresholds?: unknown + readonly plan?: string + readonly quantity?: number + readonly tax_rates?: readonly string[] + }[] /** @enum {string} */ - readonly proration_behavior?: "always_invoice" | "create_prorations" | "none"; - readonly start_date?: unknown; - readonly tax_percent?: number; - readonly trial?: boolean; - readonly trial_end?: unknown; - }[]; + readonly proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' + readonly start_date?: unknown + readonly tax_percent?: number + readonly trial?: boolean + readonly trial_end?: unknown + }[] /** @description This field has been renamed to `proration_behavior`. `prorate=true` can be replaced with `proration_behavior=create_prorations` and `prorate=false` can be replaced with `proration_behavior=none`. */ - readonly prorate?: boolean; + readonly prorate?: boolean /** * @description If the update changes the current phase, indicates if the changes should be prorated. Valid values are `create_prorations` or `none`, and the default value is `create_prorations`. * @enum {string} */ - readonly proration_behavior?: "always_invoice" | "create_prorations" | "none"; - }; - }; - }; + readonly proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["subscription_schedule"]; - }; + readonly schema: definitions['subscription_schedule'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly PostSubscriptionSchedulesScheduleCancel: { readonly parameters: { readonly path: { - readonly schedule: string; - }; + readonly schedule: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description If the subscription schedule is `active`, indicates whether or not to generate a final invoice that contains any un-invoiced metered usage and new/pending proration invoice items. Defaults to `true`. */ - readonly invoice_now?: boolean; + readonly invoice_now?: boolean /** @description If the subscription schedule is `active`, indicates if the cancellation should be prorated. Defaults to `true`. */ - readonly prorate?: boolean; - }; - }; - }; + readonly prorate?: boolean + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["subscription_schedule"]; - }; + readonly schema: definitions['subscription_schedule'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly PostSubscriptionSchedulesScheduleRelease: { readonly parameters: { readonly path: { - readonly schedule: string; - }; + readonly schedule: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description Keep any cancellation on the subscription that the schedule has set */ - readonly preserve_cancel_date?: boolean; - }; - }; - }; + readonly preserve_cancel_date?: boolean + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["subscription_schedule"]; - }; + readonly schema: definitions['subscription_schedule'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.

*/ readonly GetSubscriptions: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** The collection method of the subscriptions to retrieve. Either `charge_automatically` or `send_invoice`. */ - readonly collection_method?: string; - readonly created?: number; - readonly current_period_end?: number; - readonly current_period_start?: number; + readonly collection_method?: string + readonly created?: number + readonly current_period_end?: number + readonly current_period_start?: number /** The ID of the customer whose subscriptions will be retrieved. */ - readonly customer?: string; + readonly customer?: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** The ID of the plan whose subscriptions will be retrieved. */ - readonly plan?: string; + readonly plan?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** The status of the subscriptions to retrieve. One of: `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `unpaid`, `canceled`, or `all`. Passing in a value of `canceled` will return all canceled subscriptions, including those belonging to deleted customers. Passing in a value of `all` will return subscriptions of all statuses. */ - readonly status?: string; - }; - }; + readonly status?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["subscription"][]; + readonly data: readonly definitions['subscription'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Creates a new subscription on an existing customer. Each customer can have up to 25 active or scheduled subscriptions.

*/ readonly PostSubscriptions: { readonly parameters: { @@ -27602,48 +27515,48 @@ export interface operations { /** Body parameters for the request. */ readonly payload: { /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). */ - readonly application_fee_percent?: number; + readonly application_fee_percent?: number /** @description For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor. */ - readonly backdate_start_date?: number; + readonly backdate_start_date?: number /** @description 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. */ - readonly billing_cycle_anchor?: number; + readonly billing_cycle_anchor?: number /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. */ - readonly billing_thresholds?: unknown; + readonly billing_thresholds?: unknown /** @description 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. */ - readonly cancel_at?: number; + readonly cancel_at?: number /** @description Boolean indicating whether this subscription should cancel at the end of the current period. */ - readonly cancel_at_period_end?: boolean; + readonly cancel_at_period_end?: boolean /** * @description 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. Defaults to `charge_automatically`. * @enum {string} */ - readonly collection_method?: "charge_automatically" | "send_invoice"; + readonly collection_method?: 'charge_automatically' | 'send_invoice' /** @description The code of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. */ - readonly coupon?: string; + readonly coupon?: string /** @description The identifier of the customer to subscribe. */ - readonly customer: string; + readonly customer: string /** @description Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. */ - readonly days_until_due?: number; + readonly days_until_due?: number /** @description ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. If not set, invoices will use the default payment method in the customer's invoice settings. */ - readonly default_payment_method?: string; + readonly default_payment_method?: string /** @description 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 not set, defaults to the customer's default source. */ - readonly default_source?: string; + readonly default_source?: string /** @description 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. */ - readonly default_tax_rates?: readonly string[]; + readonly default_tax_rates?: readonly string[] /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description A list of up to 20 subscription items, each with an attached plan. */ readonly items?: readonly { - readonly billing_thresholds?: unknown; - readonly metadata?: { readonly [key: string]: unknown }; - readonly plan?: string; - readonly quantity?: number; - readonly tax_rates?: readonly string[]; - }[]; + readonly billing_thresholds?: unknown + readonly metadata?: { readonly [key: string]: unknown } + readonly plan?: string + readonly quantity?: number + readonly tax_rates?: readonly string[] + }[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. */ - readonly off_session?: boolean; + readonly off_session?: boolean /** * @description Use `allow_incomplete` to create subscriptions with `status=incomplete` if the first invoice cannot be paid. Creating subscriptions with this status allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * @@ -27652,118 +27565,118 @@ export interface operations { * `pending_if_incomplete` is only used with updates and cannot be passed when creating a subscription. * @enum {string} */ - readonly payment_behavior?: "allow_incomplete" | "error_if_incomplete" | "pending_if_incomplete"; + readonly payment_behavior?: 'allow_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete' /** @description 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. */ - readonly pending_invoice_item_interval?: unknown; + readonly pending_invoice_item_interval?: unknown /** @description This field has been renamed to `proration_behavior`. `prorate=true` can be replaced with `proration_behavior=create_prorations` and `prorate=false` can be replaced with `proration_behavior=none`. */ - readonly prorate?: boolean; + readonly prorate?: boolean /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) resulting from the `billing_cycle_anchor`. Valid values are `create_prorations` or `none`. * * Passing `create_prorations` will cause proration invoice items to be created when applicable. Prorations can be disabled by passing `none`. If no value is passed, the default is `create_prorations`. * @enum {string} */ - readonly proration_behavior?: "always_invoice" | "create_prorations" | "none"; + readonly proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** @description A non-negative decimal (with at most four decimal places) between 0 and 100. This represents the percentage of the subscription invoice subtotal that will be calculated and added as tax to the final amount in each billing period. For example, a plan which charges $10/month with a `tax_percent` of `20.0` will charge $12 per invoice. To unset a previously-set value, pass an empty string. This field has been deprecated and will be removed in a future API version, for further information view the [migration docs](https://stripe.com/docs/billing/migration/taxes) for `tax_rates`. */ - readonly tax_percent?: unknown; + readonly tax_percent?: unknown /** @description Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. */ - readonly trial_end?: unknown; + readonly trial_end?: unknown /** @description 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. */ - readonly trial_from_plan?: boolean; + readonly trial_from_plan?: boolean /** @description Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. */ - readonly trial_period_days?: number; - }; - }; - }; + readonly trial_period_days?: number + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["subscription"]; - }; + readonly schema: definitions['subscription'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves the subscription with the given ID.

*/ readonly GetSubscriptionsSubscriptionExposedId: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly subscription_exposed_id: string; - }; - }; + readonly subscription_exposed_id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["subscription"]; - }; + readonly schema: definitions['subscription'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly PostSubscriptionsSubscriptionExposedId: { readonly parameters: { readonly path: { - readonly subscription_exposed_id: string; - }; + readonly subscription_exposed_id: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). */ - readonly application_fee_percent?: number; + readonly application_fee_percent?: number /** * @description Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). * @enum {string} */ - readonly billing_cycle_anchor?: "now" | "unchanged"; + readonly billing_cycle_anchor?: 'now' | 'unchanged' /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. */ - readonly billing_thresholds?: unknown; + readonly billing_thresholds?: unknown /** @description 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. */ - readonly cancel_at?: unknown; + readonly cancel_at?: unknown /** @description Boolean indicating whether this subscription should cancel at the end of the current period. */ - readonly cancel_at_period_end?: boolean; + readonly cancel_at_period_end?: boolean /** * @description 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. Defaults to `charge_automatically`. * @enum {string} */ - readonly collection_method?: "charge_automatically" | "send_invoice"; + readonly collection_method?: 'charge_automatically' | 'send_invoice' /** @description The code of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. */ - readonly coupon?: string; + readonly coupon?: string /** @description Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. */ - readonly days_until_due?: number; + readonly days_until_due?: number /** @description ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. If not set, invoices will use the default payment method in the customer's invoice settings. */ - readonly default_payment_method?: string; + readonly default_payment_method?: string /** @description 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 not set, defaults to the customer's default source. */ - readonly default_source?: string; + readonly default_source?: string /** @description 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. Pass an empty string to remove previously-defined tax rates. */ - readonly default_tax_rates?: readonly string[]; + readonly default_tax_rates?: readonly string[] /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description List of subscription items, each with an attached plan. */ readonly items?: readonly { - readonly billing_thresholds?: unknown; - readonly clear_usage?: boolean; - readonly deleted?: boolean; - readonly id?: string; - readonly metadata?: unknown; - readonly plan?: string; - readonly quantity?: number; - readonly tax_rates?: readonly string[]; - }[]; + readonly billing_thresholds?: unknown + readonly clear_usage?: boolean + readonly deleted?: boolean + readonly id?: string + readonly metadata?: unknown + readonly plan?: string + readonly quantity?: number + readonly tax_rates?: readonly string[] + }[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. */ - readonly off_session?: boolean; + readonly off_session?: boolean /** @description If specified, payment collection for this subscription will be paused. */ - readonly pause_collection?: unknown; + readonly pause_collection?: unknown /** * @description Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * @@ -27772,11 +27685,11 @@ export interface operations { * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not create a subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. * @enum {string} */ - readonly payment_behavior?: "allow_incomplete" | "error_if_incomplete" | "pending_if_incomplete"; + readonly payment_behavior?: 'allow_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete' /** @description 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. */ - readonly pending_invoice_item_interval?: unknown; + readonly pending_invoice_item_interval?: unknown /** @description This field has been renamed to `proration_behavior`. `prorate=true` can be replaced with `proration_behavior=create_prorations` and `prorate=false` can be replaced with `proration_behavior=none`. */ - readonly prorate?: boolean; + readonly prorate?: boolean /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -27785,29 +27698,29 @@ export interface operations { * Prorations can be disabled by passing `none`. * @enum {string} */ - readonly proration_behavior?: "always_invoice" | "create_prorations" | "none"; + readonly proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations. */ - readonly proration_date?: number; + readonly proration_date?: number /** @description A non-negative decimal (with at most four decimal places) between 0 and 100. This represents the percentage of the subscription invoice subtotal that will be calculated and added as tax to the final amount in each billing period. For example, a plan which charges $10/month with a `tax_percent` of `20.0` will charge $12 per invoice. To unset a previously-set value, pass an empty string. This field has been deprecated and will be removed in a future API version, for further information view the [migration docs](https://stripe.com/docs/billing/migration/taxes) for `tax_rates`. */ - readonly tax_percent?: unknown; + readonly tax_percent?: unknown /** @description Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. */ - readonly trial_end?: unknown; + readonly trial_end?: unknown /** @description 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. */ - readonly trial_from_plan?: boolean; - }; - }; - }; + readonly trial_from_plan?: boolean + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["subscription"]; - }; + readonly schema: definitions['subscription'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

Cancels a customer’s subscription immediately. The customer will not be charged again for the subscription.

* @@ -27818,91 +27731,91 @@ export interface operations { readonly DeleteSubscriptionsSubscriptionExposedId: { readonly parameters: { readonly path: { - readonly subscription_exposed_id: string; - }; + readonly subscription_exposed_id: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items. */ - readonly invoice_now?: boolean; + readonly invoice_now?: boolean /** @description Will generate a proration invoice item that credits remaining unused time until the subscription period end. */ - readonly prorate?: boolean; - }; - }; - }; + readonly prorate?: boolean + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["subscription"]; - }; + readonly schema: definitions['subscription'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Removes the currently applied discount on a subscription.

*/ readonly DeleteSubscriptionsSubscriptionExposedIdDiscount: { readonly parameters: { readonly path: { - readonly subscription_exposed_id: string; - }; - }; + readonly subscription_exposed_id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["deleted_discount"]; - }; + readonly schema: definitions['deleted_discount'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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

*/ readonly GetTaxRates: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** Optional flag to filter by tax rates that are either active or not active (archived) */ - readonly active?: boolean; + readonly active?: boolean /** Optional range for filtering created date */ - readonly created?: number; + readonly created?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Optional flag to filter by tax rates that are inclusive (or those that are not inclusive) */ - readonly inclusive?: boolean; + readonly inclusive?: boolean /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["tax_rate"][]; + readonly data: readonly definitions['tax_rate'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Creates a new tax rate.

*/ readonly PostTaxRates: { readonly parameters: { @@ -27910,92 +27823,92 @@ export interface operations { /** Body parameters for the request. */ readonly payload: { /** @description Flag determining whether the tax rate is active or inactive. Inactive tax rates continue to work where they are currently applied however they cannot be used for new applications. */ - readonly active?: boolean; + readonly active?: boolean /** @description An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. */ - readonly description?: string; + readonly description?: string /** @description The display name of the tax rate, which will be shown to users. */ - readonly display_name: string; + readonly display_name: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description This specifies if the tax rate is inclusive or exclusive. */ - readonly inclusive: boolean; + readonly inclusive: boolean /** @description The jurisdiction for the tax rate. */ - readonly jurisdiction?: string; + readonly jurisdiction?: string /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: { readonly [key: string]: unknown }; + readonly metadata?: { readonly [key: string]: unknown } /** @description This represents the tax rate percent out of 100. */ - readonly percentage: number; - }; - }; - }; + readonly percentage: number + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["tax_rate"]; - }; + readonly schema: definitions['tax_rate'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves a tax rate with the given ID

*/ readonly GetTaxRatesTaxRate: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly tax_rate: string; - }; - }; + readonly tax_rate: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["tax_rate"]; - }; + readonly schema: definitions['tax_rate'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Updates an existing tax rate.

*/ readonly PostTaxRatesTaxRate: { readonly parameters: { readonly path: { - readonly tax_rate: string; - }; + readonly tax_rate: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Flag determining whether the tax rate is active or inactive. Inactive tax rates continue to work where they are currently applied however they cannot be used for new applications. */ - readonly active?: boolean; + readonly active?: boolean /** @description An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. */ - readonly description?: string; + readonly description?: string /** @description The display name of the tax rate, which will be shown to users. */ - readonly display_name?: string; + readonly display_name?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The jurisdiction for the tax rate. */ - readonly jurisdiction?: string; + readonly jurisdiction?: string /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; - }; - }; - }; + readonly metadata?: unknown + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["tax_rate"]; - }; + readonly schema: definitions['tax_rate'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

To connect to a reader the Stripe Terminal SDK needs to retrieve a short-lived connection token from Stripe, proxied through your server. On your backend, add an endpoint that creates and returns a connection token.

*/ readonly PostTerminalConnectionTokens: { readonly parameters: { @@ -28003,59 +27916,59 @@ export interface operations { /** Body parameters for the request. */ readonly payload?: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The id of the location that this connection token is scoped to. If specified the connection token will only be usable with readers assigned to that location, otherwise the connection token will be usable with all readers. */ - readonly location?: string; - }; - }; - }; + readonly location?: string + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["terminal.connection_token"]; - }; + readonly schema: definitions['terminal.connection_token'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Returns a list of Location objects.

*/ readonly GetTerminalLocations: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["terminal.location"][]; + readonly data: readonly definitions['terminal.location'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Creates a new Location object.

*/ readonly PostTerminalLocations: { readonly parameters: { @@ -28067,61 +27980,61 @@ export interface operations { * @description The full address of the location. */ readonly address: { - readonly city?: string; - readonly country: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; + readonly city?: string + readonly country: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } /** @description A name for the location. */ - readonly display_name: string; + readonly display_name: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; - }; - }; - }; + readonly metadata?: unknown + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["terminal.location"]; - }; + readonly schema: definitions['terminal.location'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves a Location object.

*/ readonly GetTerminalLocationsLocation: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly location: string; - }; - }; + readonly location: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["terminal.location"]; - }; + readonly schema: definitions['terminal.location'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Updates a Location object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ readonly PostTerminalLocationsLocation: { readonly parameters: { readonly path: { - readonly location: string; - }; + readonly location: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { @@ -28130,94 +28043,94 @@ export interface operations { * @description The full address of the location. */ readonly address?: { - readonly city?: string; - readonly country: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; + readonly city?: string + readonly country: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } /** @description A name for the location. */ - readonly display_name?: string; + readonly display_name?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; - }; - }; - }; + readonly metadata?: unknown + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["terminal.location"]; - }; + readonly schema: definitions['terminal.location'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Deletes a Location object.

*/ readonly DeleteTerminalLocationsLocation: { readonly parameters: { readonly path: { - readonly location: string; - }; - }; + readonly location: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["deleted_terminal.location"]; - }; + readonly schema: definitions['deleted_terminal.location'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Returns a list of Reader objects.

*/ readonly GetTerminalReaders: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** Filters readers by device type */ - readonly device_type?: string; + readonly device_type?: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A location ID to filter the response list to only readers at the specific location */ - readonly location?: string; + readonly location?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** A status filter to filter readers to only offline or online readers */ - readonly status?: string; - }; - }; + readonly status?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { /** @description A list of readers */ - readonly data: readonly definitions["terminal.reader"][]; + readonly data: readonly definitions['terminal.reader'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Creates a new Reader object.

*/ readonly PostTerminalReaders: { readonly parameters: { @@ -28225,98 +28138,98 @@ export interface operations { /** Body parameters for the request. */ readonly payload: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description Custom label given to the reader for easier identification. If no label is specified, the registration code will be used. */ - readonly label?: string; + readonly label?: string /** @description The location to assign the reader to. If no location is specified, the reader will be assigned to the account's default location. */ - readonly location?: string; + readonly location?: string /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description A code generated by the reader used for registering to an account. */ - readonly registration_code: string; - }; - }; - }; + readonly registration_code: string + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["terminal.reader"]; - }; + readonly schema: definitions['terminal.reader'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves a Reader object.

*/ readonly GetTerminalReadersReader: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly reader: string; - }; - }; + readonly reader: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["terminal.reader"]; - }; + readonly schema: definitions['terminal.reader'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ readonly PostTerminalReadersReader: { readonly parameters: { readonly path: { - readonly reader: string; - }; + readonly reader: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The new label of the reader. */ - readonly label?: string; + readonly label?: string /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; - }; - }; - }; + readonly metadata?: unknown + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["terminal.reader"]; - }; + readonly schema: definitions['terminal.reader'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Deletes a Reader object.

*/ readonly DeleteTerminalReadersReader: { readonly parameters: { readonly path: { - readonly reader: string; - }; - }; + readonly reader: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["deleted_terminal.reader"]; - }; + readonly schema: definitions['deleted_terminal.reader'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

Creates a single-use token that represents a bank account’s details. * This token can be used with any API method in place of a bank account dictionary. This token can be used only once, by attaching it to a Custom account.

@@ -28332,154 +28245,154 @@ export interface operations { */ readonly account?: { /** @enum {string} */ - readonly business_type?: "company" | "government_entity" | "individual" | "non_profit"; + readonly business_type?: 'company' | 'government_entity' | 'individual' | 'non_profit' /** company_specs */ readonly company?: { /** address_specs */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } /** japan_address_kana_specs */ readonly address_kana?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** japan_address_kanji_specs */ readonly address_kanji?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; - readonly directors_provided?: boolean; - readonly executives_provided?: boolean; - readonly name?: string; - readonly name_kana?: string; - readonly name_kanji?: string; - readonly owners_provided?: boolean; - readonly phone?: string; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } + readonly directors_provided?: boolean + readonly executives_provided?: boolean + readonly name?: string + readonly name_kana?: string + readonly name_kanji?: string + readonly owners_provided?: boolean + readonly phone?: string /** @enum {string} */ readonly structure?: - | "" - | "government_instrumentality" - | "governmental_unit" - | "incorporated_non_profit" - | "limited_liability_partnership" - | "multi_member_llc" - | "private_company" - | "private_corporation" - | "private_partnership" - | "public_company" - | "public_corporation" - | "public_partnership" - | "sole_proprietorship" - | "tax_exempt_government_instrumentality" - | "unincorporated_association" - | "unincorporated_non_profit"; - readonly tax_id?: string; - readonly tax_id_registrar?: string; - readonly vat_id?: string; + | '' + | 'government_instrumentality' + | 'governmental_unit' + | 'incorporated_non_profit' + | 'limited_liability_partnership' + | 'multi_member_llc' + | 'private_company' + | 'private_corporation' + | 'private_partnership' + | 'public_company' + | 'public_corporation' + | 'public_partnership' + | 'sole_proprietorship' + | 'tax_exempt_government_instrumentality' + | 'unincorporated_association' + | 'unincorporated_non_profit' + readonly tax_id?: string + readonly tax_id_registrar?: string + readonly vat_id?: string /** verification_specs */ readonly verification?: { /** verification_document_specs */ readonly document?: { - readonly back?: string; - readonly front?: string; - }; - }; - }; + readonly back?: string + readonly front?: string + } + } + } /** individual_specs */ readonly individual?: { /** address_specs */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } /** japan_address_kana_specs */ readonly address_kana?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** japan_address_kanji_specs */ readonly address_kanji?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; - readonly dob?: unknown; - readonly email?: string; - readonly first_name?: string; - readonly first_name_kana?: string; - readonly first_name_kanji?: string; - readonly gender?: string; - readonly id_number?: string; - readonly last_name?: string; - readonly last_name_kana?: string; - readonly last_name_kanji?: string; - readonly maiden_name?: string; - readonly metadata?: unknown; - readonly phone?: string; - readonly ssn_last_4?: string; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } + readonly dob?: unknown + readonly email?: string + readonly first_name?: string + readonly first_name_kana?: string + readonly first_name_kanji?: string + readonly gender?: string + readonly id_number?: string + readonly last_name?: string + readonly last_name_kana?: string + readonly last_name_kanji?: string + readonly maiden_name?: string + readonly metadata?: unknown + readonly phone?: string + readonly ssn_last_4?: string /** person_verification_specs */ readonly verification?: { /** person_verification_document_specs */ readonly additional_document?: { - readonly back?: string; - readonly front?: string; - }; + readonly back?: string + readonly front?: string + } /** person_verification_document_specs */ readonly document?: { - readonly back?: string; - readonly front?: string; - }; - }; - }; - readonly tos_shown_and_accepted?: boolean; - }; + readonly back?: string + readonly front?: string + } + } + } + readonly tos_shown_and_accepted?: boolean + } /** * token_create_bank_account * @description The bank account this token will represent. */ readonly bank_account?: { - readonly account_holder_name?: string; + readonly account_holder_name?: string /** @enum {string} */ - readonly account_holder_type?: "company" | "individual"; - readonly account_number: string; - readonly country: string; - readonly currency?: string; - readonly routing_number?: string; - }; - readonly card?: unknown; + readonly account_holder_type?: 'company' | 'individual' + readonly account_number: string + readonly country: string + readonly currency?: string + readonly routing_number?: string + } + readonly card?: unknown /** @description The customer (owned by the application's account) for which to create a token. This can be used only with an [OAuth access token](https://stripe.com/docs/connect/standard-accounts) or [Stripe-Account header](https://stripe.com/docs/connect/authentication). For more details, see [Cloning Saved Payment Methods](https://stripe.com/docs/connect/cloning-saved-payment-methods). */ - readonly customer?: string; + readonly customer?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** * person_token_specs * @description Information for the person this token will represent. @@ -28487,155 +28400,155 @@ export interface operations { readonly person?: { /** address_specs */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } /** japan_address_kana_specs */ readonly address_kana?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** japan_address_kanji_specs */ readonly address_kanji?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; - readonly dob?: unknown; - readonly email?: string; - readonly first_name?: string; - readonly first_name_kana?: string; - readonly first_name_kanji?: string; - readonly gender?: string; - readonly id_number?: string; - readonly last_name?: string; - readonly last_name_kana?: string; - readonly last_name_kanji?: string; - readonly maiden_name?: string; - readonly metadata?: unknown; - readonly phone?: string; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } + readonly dob?: unknown + readonly email?: string + readonly first_name?: string + readonly first_name_kana?: string + readonly first_name_kanji?: string + readonly gender?: string + readonly id_number?: string + readonly last_name?: string + readonly last_name_kana?: string + readonly last_name_kanji?: string + readonly maiden_name?: string + readonly metadata?: unknown + readonly phone?: string /** relationship_specs */ readonly relationship?: { - readonly director?: boolean; - readonly executive?: boolean; - readonly owner?: boolean; - readonly percent_ownership?: unknown; - readonly representative?: boolean; - readonly title?: string; - }; - readonly ssn_last_4?: string; + readonly director?: boolean + readonly executive?: boolean + readonly owner?: boolean + readonly percent_ownership?: unknown + readonly representative?: boolean + readonly title?: string + } + readonly ssn_last_4?: string /** person_verification_specs */ readonly verification?: { /** person_verification_document_specs */ readonly additional_document?: { - readonly back?: string; - readonly front?: string; - }; + readonly back?: string + readonly front?: string + } /** person_verification_document_specs */ readonly document?: { - readonly back?: string; - readonly front?: string; - }; - }; - }; + readonly back?: string + readonly front?: string + } + } + } /** * pii_token_specs * @description The PII this token will represent. */ readonly pii?: { - readonly id_number?: string; - }; - }; - }; - }; + readonly id_number?: string + } + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["token"]; - }; + readonly schema: definitions['token'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves the token with the given ID.

*/ readonly GetTokensToken: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly token: string; - }; - }; + readonly token: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["token"]; - }; + readonly schema: definitions['token'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Returns a list of top-ups.

*/ readonly GetTopups: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** A positive integer representing how much to transfer. */ - readonly amount?: number; + readonly amount?: number /** 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. */ - readonly created?: number; + readonly created?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** Only return top-ups that have the given status. One of `canceled`, `failed`, `pending` or `succeeded`. */ - readonly status?: string; - }; - }; + readonly status?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["topup"][]; + readonly data: readonly definitions['topup'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Top up the balance of an account

*/ readonly PostTopups: { readonly parameters: { @@ -28643,153 +28556,153 @@ export interface operations { /** Body parameters for the request. */ readonly payload: { /** @description A positive integer representing how much to transfer. */ - readonly amount: number; + readonly amount: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string; + readonly description?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description The ID of a source to transfer funds from. For most users, this should be left unspecified which will use the bank account that was set up in the dashboard for the specified currency. In test mode, this can be a test bank token (see [Testing Top-ups](https://stripe.com/docs/connect/testing#testing-top-ups)). */ - readonly source?: string; + readonly source?: string /** @description Extra information about a top-up for the source's bank statement. Limited to 15 ASCII characters. */ - readonly statement_descriptor?: string; + readonly statement_descriptor?: string /** @description A string that identifies this top-up as part of a group. */ - readonly transfer_group?: string; - }; - }; - }; + readonly transfer_group?: string + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["topup"]; - }; + readonly schema: definitions['topup'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly GetTopupsTopup: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly topup: string; - }; - }; + readonly topup: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["topup"]; - }; + readonly schema: definitions['topup'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Updates the metadata of a top-up. Other top-up details are not editable by design.

*/ readonly PostTopupsTopup: { readonly parameters: { readonly path: { - readonly topup: string; - }; + readonly topup: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string; + readonly description?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; - }; - }; - }; + readonly metadata?: unknown + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["topup"]; - }; + readonly schema: definitions['topup'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Cancels a top-up. Only pending top-ups can be canceled.

*/ readonly PostTopupsTopupCancel: { readonly parameters: { readonly path: { - readonly topup: string; - }; + readonly topup: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["topup"]; - }; + readonly schema: definitions['topup'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly GetTransfers: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - readonly created?: number; + readonly expand?: readonly unknown[] + readonly created?: number /** Only return transfers for the destination specified by this account ID. */ - readonly destination?: string; + readonly destination?: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** Only return transfers with the specified transfer group. */ - readonly transfer_group?: string; - }; - }; + readonly transfer_group?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { /** @description Details about each object. */ - readonly data: readonly definitions["transfer"][]; + readonly data: readonly definitions['transfer'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly PostTransfers: { readonly parameters: { @@ -28797,80 +28710,80 @@ export interface operations { /** Body parameters for the request. */ readonly payload: { /** @description A positive integer in %s representing how much to transfer. */ - readonly amount?: number; + readonly amount?: number /** @description 3-letter [ISO code for currency](https://stripe.com/docs/payouts). */ - readonly currency: string; + readonly currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string; + readonly description?: string /** @description The ID of a connected Stripe account. See the Connect documentation for details. */ - readonly destination: string; + readonly destination: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: { readonly [key: string]: unknown }; + readonly metadata?: { readonly [key: string]: unknown } /** @description You can use this parameter to transfer funds from a charge before they are added to your available balance. A pending balance will transfer immediately but the funds will not become available until the original charge becomes available. [See the Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-availability) for details. */ - readonly source_transaction?: string; + readonly source_transaction?: string /** * @description The source balance to use for this transfer. One of `bank_account`, `card`, or `fpx`. For most users, this will default to `card`. * @enum {string} */ - readonly source_type?: "bank_account" | "card" | "fpx"; + readonly source_type?: 'bank_account' | 'card' | 'fpx' /** @description A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-options) for details. */ - readonly transfer_group?: string; - }; - }; - }; + readonly transfer_group?: string + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["transfer"]; - }; + readonly schema: definitions['transfer'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly GetTransfersIdReversals: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; + readonly starting_after?: string + } readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { /** @description Details about each object. */ - readonly data: readonly definitions["transfer_reversal"][]; + readonly data: readonly definitions['transfer_reversal'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

When you create a new reversal, you must specify a transfer to create it on.

* @@ -28881,57 +28794,57 @@ export interface operations { readonly PostTransfersIdReversals: { readonly parameters: { readonly path: { - readonly id: string; - }; + readonly id: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description A positive integer in %s representing how much of this transfer to reverse. Can only reverse up to the unreversed amount remaining of the transfer. Partial transfer reversals are only allowed for transfers to Stripe Accounts. Defaults to the entire transfer amount. */ - readonly amount?: number; + readonly amount?: number /** @description An arbitrary string which you can attach to a reversal object. It is displayed alongside the reversal in the Dashboard. This will be unset if you POST an empty value. */ - readonly description?: string; + readonly description?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description Boolean indicating whether the application fee should be refunded when reversing this transfer. If a full transfer reversal is given, the full application fee will be refunded. Otherwise, the application fee will be refunded with an amount proportional to the amount of the transfer reversed. */ - readonly refund_application_fee?: boolean; - }; - }; - }; + readonly refund_application_fee?: boolean + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["transfer_reversal"]; - }; + readonly schema: definitions['transfer_reversal'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly GetTransfersTransfer: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly transfer: string; - }; - }; + readonly transfer: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["transfer"]; - }; + readonly schema: definitions['transfer'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

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

* @@ -28940,54 +28853,54 @@ export interface operations { readonly PostTransfersTransfer: { readonly parameters: { readonly path: { - readonly transfer: string; - }; + readonly transfer: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string; + readonly description?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; - }; - }; - }; + readonly metadata?: unknown + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["transfer"]; - }; + readonly schema: definitions['transfer'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly GetTransfersTransferReversalsId: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly id: string; - readonly transfer: string; - }; - }; + readonly id: string + readonly transfer: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["transfer_reversal"]; - }; + readonly schema: definitions['transfer_reversal'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /** *

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

* @@ -28996,66 +28909,66 @@ export interface operations { readonly PostTransfersTransferReversalsId: { readonly parameters: { readonly path: { - readonly id: string; - readonly transfer: string; - }; + readonly id: string + readonly transfer: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; - }; - }; - }; + readonly metadata?: unknown + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["transfer_reversal"]; - }; + readonly schema: definitions['transfer_reversal'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Returns a list of your webhook endpoints.

*/ readonly GetWebhookEndpoints: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; + readonly expand?: readonly unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly schema: { - readonly data: readonly definitions["webhook_endpoint"][]; + readonly data: readonly definitions['webhook_endpoint'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

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.

*/ readonly PostWebhookEndpoints: { readonly parameters: { @@ -29067,502 +28980,502 @@ export interface operations { * @enum {string} */ readonly api_version?: - | "2011-01-01" - | "2011-06-21" - | "2011-06-28" - | "2011-08-01" - | "2011-09-15" - | "2011-11-17" - | "2012-02-23" - | "2012-03-25" - | "2012-06-18" - | "2012-06-28" - | "2012-07-09" - | "2012-09-24" - | "2012-10-26" - | "2012-11-07" - | "2013-02-11" - | "2013-02-13" - | "2013-07-05" - | "2013-08-12" - | "2013-08-13" - | "2013-10-29" - | "2013-12-03" - | "2014-01-31" - | "2014-03-13" - | "2014-03-28" - | "2014-05-19" - | "2014-06-13" - | "2014-06-17" - | "2014-07-22" - | "2014-07-26" - | "2014-08-04" - | "2014-08-20" - | "2014-09-08" - | "2014-10-07" - | "2014-11-05" - | "2014-11-20" - | "2014-12-08" - | "2014-12-17" - | "2014-12-22" - | "2015-01-11" - | "2015-01-26" - | "2015-02-10" - | "2015-02-16" - | "2015-02-18" - | "2015-03-24" - | "2015-04-07" - | "2015-06-15" - | "2015-07-07" - | "2015-07-13" - | "2015-07-28" - | "2015-08-07" - | "2015-08-19" - | "2015-09-03" - | "2015-09-08" - | "2015-09-23" - | "2015-10-01" - | "2015-10-12" - | "2015-10-16" - | "2016-02-03" - | "2016-02-19" - | "2016-02-22" - | "2016-02-23" - | "2016-02-29" - | "2016-03-07" - | "2016-06-15" - | "2016-07-06" - | "2016-10-19" - | "2017-01-27" - | "2017-02-14" - | "2017-04-06" - | "2017-05-25" - | "2017-06-05" - | "2017-08-15" - | "2017-12-14" - | "2018-01-23" - | "2018-02-05" - | "2018-02-06" - | "2018-02-28" - | "2018-05-21" - | "2018-07-27" - | "2018-08-23" - | "2018-09-06" - | "2018-09-24" - | "2018-10-31" - | "2018-11-08" - | "2019-02-11" - | "2019-02-19" - | "2019-03-14" - | "2019-05-16" - | "2019-08-14" - | "2019-09-09" - | "2019-10-08" - | "2019-10-17" - | "2019-11-05" - | "2019-12-03" - | "2020-03-02"; + | '2011-01-01' + | '2011-06-21' + | '2011-06-28' + | '2011-08-01' + | '2011-09-15' + | '2011-11-17' + | '2012-02-23' + | '2012-03-25' + | '2012-06-18' + | '2012-06-28' + | '2012-07-09' + | '2012-09-24' + | '2012-10-26' + | '2012-11-07' + | '2013-02-11' + | '2013-02-13' + | '2013-07-05' + | '2013-08-12' + | '2013-08-13' + | '2013-10-29' + | '2013-12-03' + | '2014-01-31' + | '2014-03-13' + | '2014-03-28' + | '2014-05-19' + | '2014-06-13' + | '2014-06-17' + | '2014-07-22' + | '2014-07-26' + | '2014-08-04' + | '2014-08-20' + | '2014-09-08' + | '2014-10-07' + | '2014-11-05' + | '2014-11-20' + | '2014-12-08' + | '2014-12-17' + | '2014-12-22' + | '2015-01-11' + | '2015-01-26' + | '2015-02-10' + | '2015-02-16' + | '2015-02-18' + | '2015-03-24' + | '2015-04-07' + | '2015-06-15' + | '2015-07-07' + | '2015-07-13' + | '2015-07-28' + | '2015-08-07' + | '2015-08-19' + | '2015-09-03' + | '2015-09-08' + | '2015-09-23' + | '2015-10-01' + | '2015-10-12' + | '2015-10-16' + | '2016-02-03' + | '2016-02-19' + | '2016-02-22' + | '2016-02-23' + | '2016-02-29' + | '2016-03-07' + | '2016-06-15' + | '2016-07-06' + | '2016-10-19' + | '2017-01-27' + | '2017-02-14' + | '2017-04-06' + | '2017-05-25' + | '2017-06-05' + | '2017-08-15' + | '2017-12-14' + | '2018-01-23' + | '2018-02-05' + | '2018-02-06' + | '2018-02-28' + | '2018-05-21' + | '2018-07-27' + | '2018-08-23' + | '2018-09-06' + | '2018-09-24' + | '2018-10-31' + | '2018-11-08' + | '2019-02-11' + | '2019-02-19' + | '2019-03-14' + | '2019-05-16' + | '2019-08-14' + | '2019-09-09' + | '2019-10-08' + | '2019-10-17' + | '2019-11-05' + | '2019-12-03' + | '2020-03-02' /** @description Whether this endpoint should receive events from connected accounts (`true`), or from your account (`false`). Defaults to `false`. */ - readonly connect?: boolean; + readonly connect?: boolean /** @description An optional description of what the wehbook is used for. */ - readonly description?: string; + readonly description?: string /** @description The list of events to enable for this endpoint. You may specify `['*']` to enable all events, except those that require explicit selection. */ readonly enabled_events: readonly ( - | "*" - | "account.application.authorized" - | "account.application.deauthorized" - | "account.external_account.created" - | "account.external_account.deleted" - | "account.external_account.updated" - | "account.updated" - | "application_fee.created" - | "application_fee.refund.updated" - | "application_fee.refunded" - | "balance.available" - | "capability.updated" - | "charge.captured" - | "charge.dispute.closed" - | "charge.dispute.created" - | "charge.dispute.funds_reinstated" - | "charge.dispute.funds_withdrawn" - | "charge.dispute.updated" - | "charge.expired" - | "charge.failed" - | "charge.pending" - | "charge.refund.updated" - | "charge.refunded" - | "charge.succeeded" - | "charge.updated" - | "checkout.session.completed" - | "coupon.created" - | "coupon.deleted" - | "coupon.updated" - | "credit_note.created" - | "credit_note.updated" - | "credit_note.voided" - | "customer.created" - | "customer.deleted" - | "customer.discount.created" - | "customer.discount.deleted" - | "customer.discount.updated" - | "customer.source.created" - | "customer.source.deleted" - | "customer.source.expiring" - | "customer.source.updated" - | "customer.subscription.created" - | "customer.subscription.deleted" - | "customer.subscription.pending_update_applied" - | "customer.subscription.pending_update_expired" - | "customer.subscription.trial_will_end" - | "customer.subscription.updated" - | "customer.tax_id.created" - | "customer.tax_id.deleted" - | "customer.tax_id.updated" - | "customer.updated" - | "file.created" - | "invoice.created" - | "invoice.deleted" - | "invoice.finalized" - | "invoice.marked_uncollectible" - | "invoice.payment_action_required" - | "invoice.payment_failed" - | "invoice.payment_succeeded" - | "invoice.sent" - | "invoice.upcoming" - | "invoice.updated" - | "invoice.voided" - | "invoiceitem.created" - | "invoiceitem.deleted" - | "invoiceitem.updated" - | "issuing_authorization.created" - | "issuing_authorization.request" - | "issuing_authorization.updated" - | "issuing_card.created" - | "issuing_card.updated" - | "issuing_cardholder.created" - | "issuing_cardholder.updated" - | "issuing_transaction.created" - | "issuing_transaction.updated" - | "mandate.updated" - | "order.created" - | "order.payment_failed" - | "order.payment_succeeded" - | "order.updated" - | "order_return.created" - | "payment_intent.amount_capturable_updated" - | "payment_intent.canceled" - | "payment_intent.created" - | "payment_intent.payment_failed" - | "payment_intent.processing" - | "payment_intent.succeeded" - | "payment_method.attached" - | "payment_method.card_automatically_updated" - | "payment_method.detached" - | "payment_method.updated" - | "payout.canceled" - | "payout.created" - | "payout.failed" - | "payout.paid" - | "payout.updated" - | "person.created" - | "person.deleted" - | "person.updated" - | "plan.created" - | "plan.deleted" - | "plan.updated" - | "product.created" - | "product.deleted" - | "product.updated" - | "radar.early_fraud_warning.created" - | "radar.early_fraud_warning.updated" - | "recipient.created" - | "recipient.deleted" - | "recipient.updated" - | "reporting.report_run.failed" - | "reporting.report_run.succeeded" - | "reporting.report_type.updated" - | "review.closed" - | "review.opened" - | "setup_intent.canceled" - | "setup_intent.created" - | "setup_intent.setup_failed" - | "setup_intent.succeeded" - | "sigma.scheduled_query_run.created" - | "sku.created" - | "sku.deleted" - | "sku.updated" - | "source.canceled" - | "source.chargeable" - | "source.failed" - | "source.mandate_notification" - | "source.refund_attributes_required" - | "source.transaction.created" - | "source.transaction.updated" - | "subscription_schedule.aborted" - | "subscription_schedule.canceled" - | "subscription_schedule.completed" - | "subscription_schedule.created" - | "subscription_schedule.expiring" - | "subscription_schedule.released" - | "subscription_schedule.updated" - | "tax_rate.created" - | "tax_rate.updated" - | "topup.canceled" - | "topup.created" - | "topup.failed" - | "topup.reversed" - | "topup.succeeded" - | "transfer.created" - | "transfer.failed" - | "transfer.paid" - | "transfer.reversed" - | "transfer.updated" - )[]; + | '*' + | 'account.application.authorized' + | 'account.application.deauthorized' + | 'account.external_account.created' + | 'account.external_account.deleted' + | 'account.external_account.updated' + | 'account.updated' + | 'application_fee.created' + | 'application_fee.refund.updated' + | 'application_fee.refunded' + | 'balance.available' + | 'capability.updated' + | 'charge.captured' + | 'charge.dispute.closed' + | 'charge.dispute.created' + | 'charge.dispute.funds_reinstated' + | 'charge.dispute.funds_withdrawn' + | 'charge.dispute.updated' + | 'charge.expired' + | 'charge.failed' + | 'charge.pending' + | 'charge.refund.updated' + | 'charge.refunded' + | 'charge.succeeded' + | 'charge.updated' + | 'checkout.session.completed' + | 'coupon.created' + | 'coupon.deleted' + | 'coupon.updated' + | 'credit_note.created' + | 'credit_note.updated' + | 'credit_note.voided' + | 'customer.created' + | 'customer.deleted' + | 'customer.discount.created' + | 'customer.discount.deleted' + | 'customer.discount.updated' + | 'customer.source.created' + | 'customer.source.deleted' + | 'customer.source.expiring' + | 'customer.source.updated' + | 'customer.subscription.created' + | 'customer.subscription.deleted' + | 'customer.subscription.pending_update_applied' + | 'customer.subscription.pending_update_expired' + | 'customer.subscription.trial_will_end' + | 'customer.subscription.updated' + | 'customer.tax_id.created' + | 'customer.tax_id.deleted' + | 'customer.tax_id.updated' + | 'customer.updated' + | 'file.created' + | 'invoice.created' + | 'invoice.deleted' + | 'invoice.finalized' + | 'invoice.marked_uncollectible' + | 'invoice.payment_action_required' + | 'invoice.payment_failed' + | 'invoice.payment_succeeded' + | 'invoice.sent' + | 'invoice.upcoming' + | 'invoice.updated' + | 'invoice.voided' + | 'invoiceitem.created' + | 'invoiceitem.deleted' + | 'invoiceitem.updated' + | 'issuing_authorization.created' + | 'issuing_authorization.request' + | 'issuing_authorization.updated' + | 'issuing_card.created' + | 'issuing_card.updated' + | 'issuing_cardholder.created' + | 'issuing_cardholder.updated' + | 'issuing_transaction.created' + | 'issuing_transaction.updated' + | 'mandate.updated' + | 'order.created' + | 'order.payment_failed' + | 'order.payment_succeeded' + | 'order.updated' + | 'order_return.created' + | 'payment_intent.amount_capturable_updated' + | 'payment_intent.canceled' + | 'payment_intent.created' + | 'payment_intent.payment_failed' + | 'payment_intent.processing' + | 'payment_intent.succeeded' + | 'payment_method.attached' + | 'payment_method.card_automatically_updated' + | 'payment_method.detached' + | 'payment_method.updated' + | 'payout.canceled' + | 'payout.created' + | 'payout.failed' + | 'payout.paid' + | 'payout.updated' + | 'person.created' + | 'person.deleted' + | 'person.updated' + | 'plan.created' + | 'plan.deleted' + | 'plan.updated' + | 'product.created' + | 'product.deleted' + | 'product.updated' + | 'radar.early_fraud_warning.created' + | 'radar.early_fraud_warning.updated' + | 'recipient.created' + | 'recipient.deleted' + | 'recipient.updated' + | 'reporting.report_run.failed' + | 'reporting.report_run.succeeded' + | 'reporting.report_type.updated' + | 'review.closed' + | 'review.opened' + | 'setup_intent.canceled' + | 'setup_intent.created' + | 'setup_intent.setup_failed' + | 'setup_intent.succeeded' + | 'sigma.scheduled_query_run.created' + | 'sku.created' + | 'sku.deleted' + | 'sku.updated' + | 'source.canceled' + | 'source.chargeable' + | 'source.failed' + | 'source.mandate_notification' + | 'source.refund_attributes_required' + | 'source.transaction.created' + | 'source.transaction.updated' + | 'subscription_schedule.aborted' + | 'subscription_schedule.canceled' + | 'subscription_schedule.completed' + | 'subscription_schedule.created' + | 'subscription_schedule.expiring' + | 'subscription_schedule.released' + | 'subscription_schedule.updated' + | 'tax_rate.created' + | 'tax_rate.updated' + | 'topup.canceled' + | 'topup.created' + | 'topup.failed' + | 'topup.reversed' + | 'topup.succeeded' + | 'transfer.created' + | 'transfer.failed' + | 'transfer.paid' + | 'transfer.reversed' + | 'transfer.updated' + )[] /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description The URL of the webhook endpoint. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["webhook_endpoint"]; - }; + readonly schema: definitions['webhook_endpoint'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Retrieves the webhook endpoint with the given ID.

*/ readonly GetWebhookEndpointsWebhookEndpoint: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly unknown[]; - }; + readonly expand?: readonly unknown[] + } readonly path: { - readonly webhook_endpoint: string; - }; - }; + readonly webhook_endpoint: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["webhook_endpoint"]; - }; + readonly schema: definitions['webhook_endpoint'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.

*/ readonly PostWebhookEndpointsWebhookEndpoint: { readonly parameters: { readonly path: { - readonly webhook_endpoint: string; - }; + readonly webhook_endpoint: string + } readonly body: { /** Body parameters for the request. */ readonly payload?: { /** @description An optional description of what the wehbook is used for. */ - readonly description?: string; + readonly description?: string /** @description Disable the webhook endpoint if set to true. */ - readonly disabled?: boolean; + readonly disabled?: boolean /** @description The list of events to enable for this endpoint. You may specify `['*']` to enable all events, except those that require explicit selection. */ readonly enabled_events?: readonly ( - | "*" - | "account.application.authorized" - | "account.application.deauthorized" - | "account.external_account.created" - | "account.external_account.deleted" - | "account.external_account.updated" - | "account.updated" - | "application_fee.created" - | "application_fee.refund.updated" - | "application_fee.refunded" - | "balance.available" - | "capability.updated" - | "charge.captured" - | "charge.dispute.closed" - | "charge.dispute.created" - | "charge.dispute.funds_reinstated" - | "charge.dispute.funds_withdrawn" - | "charge.dispute.updated" - | "charge.expired" - | "charge.failed" - | "charge.pending" - | "charge.refund.updated" - | "charge.refunded" - | "charge.succeeded" - | "charge.updated" - | "checkout.session.completed" - | "coupon.created" - | "coupon.deleted" - | "coupon.updated" - | "credit_note.created" - | "credit_note.updated" - | "credit_note.voided" - | "customer.created" - | "customer.deleted" - | "customer.discount.created" - | "customer.discount.deleted" - | "customer.discount.updated" - | "customer.source.created" - | "customer.source.deleted" - | "customer.source.expiring" - | "customer.source.updated" - | "customer.subscription.created" - | "customer.subscription.deleted" - | "customer.subscription.pending_update_applied" - | "customer.subscription.pending_update_expired" - | "customer.subscription.trial_will_end" - | "customer.subscription.updated" - | "customer.tax_id.created" - | "customer.tax_id.deleted" - | "customer.tax_id.updated" - | "customer.updated" - | "file.created" - | "invoice.created" - | "invoice.deleted" - | "invoice.finalized" - | "invoice.marked_uncollectible" - | "invoice.payment_action_required" - | "invoice.payment_failed" - | "invoice.payment_succeeded" - | "invoice.sent" - | "invoice.upcoming" - | "invoice.updated" - | "invoice.voided" - | "invoiceitem.created" - | "invoiceitem.deleted" - | "invoiceitem.updated" - | "issuing_authorization.created" - | "issuing_authorization.request" - | "issuing_authorization.updated" - | "issuing_card.created" - | "issuing_card.updated" - | "issuing_cardholder.created" - | "issuing_cardholder.updated" - | "issuing_transaction.created" - | "issuing_transaction.updated" - | "mandate.updated" - | "order.created" - | "order.payment_failed" - | "order.payment_succeeded" - | "order.updated" - | "order_return.created" - | "payment_intent.amount_capturable_updated" - | "payment_intent.canceled" - | "payment_intent.created" - | "payment_intent.payment_failed" - | "payment_intent.processing" - | "payment_intent.succeeded" - | "payment_method.attached" - | "payment_method.card_automatically_updated" - | "payment_method.detached" - | "payment_method.updated" - | "payout.canceled" - | "payout.created" - | "payout.failed" - | "payout.paid" - | "payout.updated" - | "person.created" - | "person.deleted" - | "person.updated" - | "plan.created" - | "plan.deleted" - | "plan.updated" - | "product.created" - | "product.deleted" - | "product.updated" - | "radar.early_fraud_warning.created" - | "radar.early_fraud_warning.updated" - | "recipient.created" - | "recipient.deleted" - | "recipient.updated" - | "reporting.report_run.failed" - | "reporting.report_run.succeeded" - | "reporting.report_type.updated" - | "review.closed" - | "review.opened" - | "setup_intent.canceled" - | "setup_intent.created" - | "setup_intent.setup_failed" - | "setup_intent.succeeded" - | "sigma.scheduled_query_run.created" - | "sku.created" - | "sku.deleted" - | "sku.updated" - | "source.canceled" - | "source.chargeable" - | "source.failed" - | "source.mandate_notification" - | "source.refund_attributes_required" - | "source.transaction.created" - | "source.transaction.updated" - | "subscription_schedule.aborted" - | "subscription_schedule.canceled" - | "subscription_schedule.completed" - | "subscription_schedule.created" - | "subscription_schedule.expiring" - | "subscription_schedule.released" - | "subscription_schedule.updated" - | "tax_rate.created" - | "tax_rate.updated" - | "topup.canceled" - | "topup.created" - | "topup.failed" - | "topup.reversed" - | "topup.succeeded" - | "transfer.created" - | "transfer.failed" - | "transfer.paid" - | "transfer.reversed" - | "transfer.updated" - )[]; + | '*' + | 'account.application.authorized' + | 'account.application.deauthorized' + | 'account.external_account.created' + | 'account.external_account.deleted' + | 'account.external_account.updated' + | 'account.updated' + | 'application_fee.created' + | 'application_fee.refund.updated' + | 'application_fee.refunded' + | 'balance.available' + | 'capability.updated' + | 'charge.captured' + | 'charge.dispute.closed' + | 'charge.dispute.created' + | 'charge.dispute.funds_reinstated' + | 'charge.dispute.funds_withdrawn' + | 'charge.dispute.updated' + | 'charge.expired' + | 'charge.failed' + | 'charge.pending' + | 'charge.refund.updated' + | 'charge.refunded' + | 'charge.succeeded' + | 'charge.updated' + | 'checkout.session.completed' + | 'coupon.created' + | 'coupon.deleted' + | 'coupon.updated' + | 'credit_note.created' + | 'credit_note.updated' + | 'credit_note.voided' + | 'customer.created' + | 'customer.deleted' + | 'customer.discount.created' + | 'customer.discount.deleted' + | 'customer.discount.updated' + | 'customer.source.created' + | 'customer.source.deleted' + | 'customer.source.expiring' + | 'customer.source.updated' + | 'customer.subscription.created' + | 'customer.subscription.deleted' + | 'customer.subscription.pending_update_applied' + | 'customer.subscription.pending_update_expired' + | 'customer.subscription.trial_will_end' + | 'customer.subscription.updated' + | 'customer.tax_id.created' + | 'customer.tax_id.deleted' + | 'customer.tax_id.updated' + | 'customer.updated' + | 'file.created' + | 'invoice.created' + | 'invoice.deleted' + | 'invoice.finalized' + | 'invoice.marked_uncollectible' + | 'invoice.payment_action_required' + | 'invoice.payment_failed' + | 'invoice.payment_succeeded' + | 'invoice.sent' + | 'invoice.upcoming' + | 'invoice.updated' + | 'invoice.voided' + | 'invoiceitem.created' + | 'invoiceitem.deleted' + | 'invoiceitem.updated' + | 'issuing_authorization.created' + | 'issuing_authorization.request' + | 'issuing_authorization.updated' + | 'issuing_card.created' + | 'issuing_card.updated' + | 'issuing_cardholder.created' + | 'issuing_cardholder.updated' + | 'issuing_transaction.created' + | 'issuing_transaction.updated' + | 'mandate.updated' + | 'order.created' + | 'order.payment_failed' + | 'order.payment_succeeded' + | 'order.updated' + | 'order_return.created' + | 'payment_intent.amount_capturable_updated' + | 'payment_intent.canceled' + | 'payment_intent.created' + | 'payment_intent.payment_failed' + | 'payment_intent.processing' + | 'payment_intent.succeeded' + | 'payment_method.attached' + | 'payment_method.card_automatically_updated' + | 'payment_method.detached' + | 'payment_method.updated' + | 'payout.canceled' + | 'payout.created' + | 'payout.failed' + | 'payout.paid' + | 'payout.updated' + | 'person.created' + | 'person.deleted' + | 'person.updated' + | 'plan.created' + | 'plan.deleted' + | 'plan.updated' + | 'product.created' + | 'product.deleted' + | 'product.updated' + | 'radar.early_fraud_warning.created' + | 'radar.early_fraud_warning.updated' + | 'recipient.created' + | 'recipient.deleted' + | 'recipient.updated' + | 'reporting.report_run.failed' + | 'reporting.report_run.succeeded' + | 'reporting.report_type.updated' + | 'review.closed' + | 'review.opened' + | 'setup_intent.canceled' + | 'setup_intent.created' + | 'setup_intent.setup_failed' + | 'setup_intent.succeeded' + | 'sigma.scheduled_query_run.created' + | 'sku.created' + | 'sku.deleted' + | 'sku.updated' + | 'source.canceled' + | 'source.chargeable' + | 'source.failed' + | 'source.mandate_notification' + | 'source.refund_attributes_required' + | 'source.transaction.created' + | 'source.transaction.updated' + | 'subscription_schedule.aborted' + | 'subscription_schedule.canceled' + | 'subscription_schedule.completed' + | 'subscription_schedule.created' + | 'subscription_schedule.expiring' + | 'subscription_schedule.released' + | 'subscription_schedule.updated' + | 'tax_rate.created' + | 'tax_rate.updated' + | 'topup.canceled' + | 'topup.created' + | 'topup.failed' + | 'topup.reversed' + | 'topup.succeeded' + | 'transfer.created' + | 'transfer.failed' + | 'transfer.paid' + | 'transfer.reversed' + | 'transfer.updated' + )[] /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - readonly metadata?: unknown; + readonly metadata?: unknown /** @description The URL of the webhook endpoint. */ - readonly url?: string; - }; - }; - }; + readonly url?: string + } + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["webhook_endpoint"]; - }; + readonly schema: definitions['webhook_endpoint'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } /**

You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.

*/ readonly DeleteWebhookEndpointsWebhookEndpoint: { readonly parameters: { readonly path: { - readonly webhook_endpoint: string; - }; - }; + readonly webhook_endpoint: string + } + } readonly responses: { /** Successful response. */ readonly 200: { - readonly schema: definitions["deleted_webhook_endpoint"]; - }; + readonly schema: definitions['deleted_webhook_endpoint'] + } /** Error response. */ readonly default: { - readonly schema: definitions["error"]; - }; - }; - }; + readonly schema: definitions['error'] + } + } + } } export interface external {} diff --git a/test/v2/expected/stripe.ts b/test/v2/expected/stripe.ts index fa91e5be1..f5a618451 100644 --- a/test/v2/expected/stripe.ts +++ b/test/v2/expected/stripe.ts @@ -4,23 +4,23 @@ */ export interface paths { - "/v1/3d_secure": { + '/v1/3d_secure': { /**

Initiate 3D Secure authentication.

*/ - post: operations["Post3dSecure"]; - }; - "/v1/3d_secure/{three_d_secure}": { + post: operations['Post3dSecure'] + } + '/v1/3d_secure/{three_d_secure}': { /**

Retrieves a 3D Secure object.

*/ - get: operations["Get3dSecureThreeDSecure"]; - }; - "/v1/account": { + get: operations['Get3dSecureThreeDSecure'] + } + '/v1/account': { /**

Retrieves the details of an account.

*/ - get: operations["GetAccount"]; + get: operations['GetAccount'] /** *

Updates a connected Express or Custom account by setting the values of the parameters passed. Any parameters not provided are left unchanged. Most parameters can be changed only for Custom accounts. (These are marked Custom Only below.) Parameters marked Custom and Express are supported by both account types.

* *

To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.

*/ - post: operations["PostAccount"]; + post: operations['PostAccount'] /** *

With Connect, you can delete Custom or Express accounts you manage.

* @@ -28,101 +28,101 @@ export interface paths { * *

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

*/ - delete: operations["DeleteAccount"]; - }; - "/v1/account/bank_accounts": { + delete: operations['DeleteAccount'] + } + '/v1/account/bank_accounts': { /**

Create an external account for a given account.

*/ - post: operations["PostAccountBankAccounts"]; - }; - "/v1/account/bank_accounts/{id}": { + post: operations['PostAccountBankAccounts'] + } + '/v1/account/bank_accounts/{id}': { /**

Retrieve a specified external account for a given account.

*/ - get: operations["GetAccountBankAccountsId"]; + get: operations['GetAccountBankAccountsId'] /** *

Updates the metadata, account holder name, and account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

*

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

*/ - post: operations["PostAccountBankAccountsId"]; + post: operations['PostAccountBankAccountsId'] /**

Delete a specified external account for a given account.

*/ - delete: operations["DeleteAccountBankAccountsId"]; - }; - "/v1/account/capabilities": { + delete: operations['DeleteAccountBankAccountsId'] + } + '/v1/account/capabilities': { /**

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

*/ - get: operations["GetAccountCapabilities"]; - }; - "/v1/account/capabilities/{capability}": { + get: operations['GetAccountCapabilities'] + } + '/v1/account/capabilities/{capability}': { /**

Retrieves information about the specified Account Capability.

*/ - get: operations["GetAccountCapabilitiesCapability"]; + get: operations['GetAccountCapabilitiesCapability'] /**

Updates an existing Account Capability.

*/ - post: operations["PostAccountCapabilitiesCapability"]; - }; - "/v1/account/external_accounts": { + post: operations['PostAccountCapabilitiesCapability'] + } + '/v1/account/external_accounts': { /**

List external accounts for an account.

*/ - get: operations["GetAccountExternalAccounts"]; + get: operations['GetAccountExternalAccounts'] /**

Create an external account for a given account.

*/ - post: operations["PostAccountExternalAccounts"]; - }; - "/v1/account/external_accounts/{id}": { + post: operations['PostAccountExternalAccounts'] + } + '/v1/account/external_accounts/{id}': { /**

Retrieve a specified external account for a given account.

*/ - get: operations["GetAccountExternalAccountsId"]; + get: operations['GetAccountExternalAccountsId'] /** *

Updates the metadata, account holder name, and account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

*

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

*/ - post: operations["PostAccountExternalAccountsId"]; + post: operations['PostAccountExternalAccountsId'] /**

Delete a specified external account for a given account.

*/ - delete: operations["DeleteAccountExternalAccountsId"]; - }; - "/v1/account/login_links": { + delete: operations['DeleteAccountExternalAccountsId'] + } + '/v1/account/login_links': { /** *

Creates a single-use login link for an Express account to access their Stripe dashboard.

* *

You may only create login links for Express accounts connected to your platform.

*/ - post: operations["PostAccountLoginLinks"]; - }; - "/v1/account/logout": { + post: operations['PostAccountLoginLinks'] + } + '/v1/account/logout': { /** *

Invalidates all sessions for a light account, for a platform to use during platform logout.

* *

You may only log out Express accounts connected to your platform.

*/ - put: operations["PutAccountLogout"]; - }; - "/v1/account/people": { + put: operations['PutAccountLogout'] + } + '/v1/account/people': { /**

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.

*/ - get: operations["GetAccountPeople"]; + get: operations['GetAccountPeople'] /**

Creates a new person.

*/ - post: operations["PostAccountPeople"]; - }; - "/v1/account/people/{person}": { + post: operations['PostAccountPeople'] + } + '/v1/account/people/{person}': { /**

Retrieves an existing person.

*/ - get: operations["GetAccountPeoplePerson"]; + get: operations['GetAccountPeoplePerson'] /**

Updates an existing person.

*/ - post: operations["PostAccountPeoplePerson"]; + post: operations['PostAccountPeoplePerson'] /**

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.

*/ - delete: operations["DeleteAccountPeoplePerson"]; - }; - "/v1/account/persons": { + delete: operations['DeleteAccountPeoplePerson'] + } + '/v1/account/persons': { /**

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.

*/ - get: operations["GetAccountPersons"]; + get: operations['GetAccountPersons'] /**

Creates a new person.

*/ - post: operations["PostAccountPersons"]; - }; - "/v1/account/persons/{person}": { + post: operations['PostAccountPersons'] + } + '/v1/account/persons/{person}': { /**

Retrieves an existing person.

*/ - get: operations["GetAccountPersonsPerson"]; + get: operations['GetAccountPersonsPerson'] /**

Updates an existing person.

*/ - post: operations["PostAccountPersonsPerson"]; + post: operations['PostAccountPersonsPerson'] /**

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.

*/ - delete: operations["DeleteAccountPersonsPerson"]; - }; - "/v1/account_links": { + delete: operations['DeleteAccountPersonsPerson'] + } + '/v1/account_links': { /**

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

*/ - post: operations["PostAccountLinks"]; - }; - "/v1/accounts": { + post: operations['PostAccountLinks'] + } + '/v1/accounts': { /**

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

*/ - get: operations["GetAccounts"]; + get: operations['GetAccounts'] /** *

With Connect, you can create Stripe accounts for your users. * To do this, you’ll first need to register your platform.

@@ -130,17 +130,17 @@ export interface paths { *

For Standard accounts, parameters other than country, email, and type * are used to prefill the account application that we ask the account holder to complete.

*/ - post: operations["PostAccounts"]; - }; - "/v1/accounts/{account}": { + post: operations['PostAccounts'] + } + '/v1/accounts/{account}': { /**

Retrieves the details of an account.

*/ - get: operations["GetAccountsAccount"]; + get: operations['GetAccountsAccount'] /** *

Updates a connected Express or Custom account by setting the values of the parameters passed. Any parameters not provided are left unchanged. Most parameters can be changed only for Custom accounts. (These are marked Custom Only below.) Parameters marked Custom and Express are supported by both account types.

* *

To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.

*/ - post: operations["PostAccountsAccount"]; + post: operations['PostAccountsAccount'] /** *

With Connect, you can delete Custom or Express accounts you manage.

* @@ -148,138 +148,138 @@ export interface paths { * *

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

*/ - delete: operations["DeleteAccountsAccount"]; - }; - "/v1/accounts/{account}/bank_accounts": { + delete: operations['DeleteAccountsAccount'] + } + '/v1/accounts/{account}/bank_accounts': { /**

Create an external account for a given account.

*/ - post: operations["PostAccountsAccountBankAccounts"]; - }; - "/v1/accounts/{account}/bank_accounts/{id}": { + post: operations['PostAccountsAccountBankAccounts'] + } + '/v1/accounts/{account}/bank_accounts/{id}': { /**

Retrieve a specified external account for a given account.

*/ - get: operations["GetAccountsAccountBankAccountsId"]; + get: operations['GetAccountsAccountBankAccountsId'] /** *

Updates the metadata, account holder name, and account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

*

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

*/ - post: operations["PostAccountsAccountBankAccountsId"]; + post: operations['PostAccountsAccountBankAccountsId'] /**

Delete a specified external account for a given account.

*/ - delete: operations["DeleteAccountsAccountBankAccountsId"]; - }; - "/v1/accounts/{account}/capabilities": { + delete: operations['DeleteAccountsAccountBankAccountsId'] + } + '/v1/accounts/{account}/capabilities': { /**

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

*/ - get: operations["GetAccountsAccountCapabilities"]; - }; - "/v1/accounts/{account}/capabilities/{capability}": { + get: operations['GetAccountsAccountCapabilities'] + } + '/v1/accounts/{account}/capabilities/{capability}': { /**

Retrieves information about the specified Account Capability.

*/ - get: operations["GetAccountsAccountCapabilitiesCapability"]; + get: operations['GetAccountsAccountCapabilitiesCapability'] /**

Updates an existing Account Capability.

*/ - post: operations["PostAccountsAccountCapabilitiesCapability"]; - }; - "/v1/accounts/{account}/external_accounts": { + post: operations['PostAccountsAccountCapabilitiesCapability'] + } + '/v1/accounts/{account}/external_accounts': { /**

List external accounts for an account.

*/ - get: operations["GetAccountsAccountExternalAccounts"]; + get: operations['GetAccountsAccountExternalAccounts'] /**

Create an external account for a given account.

*/ - post: operations["PostAccountsAccountExternalAccounts"]; - }; - "/v1/accounts/{account}/external_accounts/{id}": { + post: operations['PostAccountsAccountExternalAccounts'] + } + '/v1/accounts/{account}/external_accounts/{id}': { /**

Retrieve a specified external account for a given account.

*/ - get: operations["GetAccountsAccountExternalAccountsId"]; + get: operations['GetAccountsAccountExternalAccountsId'] /** *

Updates the metadata, account holder name, and account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

*

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

*/ - post: operations["PostAccountsAccountExternalAccountsId"]; + post: operations['PostAccountsAccountExternalAccountsId'] /**

Delete a specified external account for a given account.

*/ - delete: operations["DeleteAccountsAccountExternalAccountsId"]; - }; - "/v1/accounts/{account}/login_links": { + delete: operations['DeleteAccountsAccountExternalAccountsId'] + } + '/v1/accounts/{account}/login_links': { /** *

Creates a single-use login link for an Express account to access their Stripe dashboard.

* *

You may only create login links for Express accounts connected to your platform.

*/ - post: operations["PostAccountsAccountLoginLinks"]; - }; - "/v1/accounts/{account}/logout": { + post: operations['PostAccountsAccountLoginLinks'] + } + '/v1/accounts/{account}/logout': { /** *

Invalidates all sessions for a light account, for a platform to use during platform logout.

* *

You may only log out Express accounts connected to your platform.

*/ - put: operations["PutAccountsAccountLogout"]; - }; - "/v1/accounts/{account}/people": { + put: operations['PutAccountsAccountLogout'] + } + '/v1/accounts/{account}/people': { /**

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.

*/ - get: operations["GetAccountsAccountPeople"]; + get: operations['GetAccountsAccountPeople'] /**

Creates a new person.

*/ - post: operations["PostAccountsAccountPeople"]; - }; - "/v1/accounts/{account}/people/{person}": { + post: operations['PostAccountsAccountPeople'] + } + '/v1/accounts/{account}/people/{person}': { /**

Retrieves an existing person.

*/ - get: operations["GetAccountsAccountPeoplePerson"]; + get: operations['GetAccountsAccountPeoplePerson'] /**

Updates an existing person.

*/ - post: operations["PostAccountsAccountPeoplePerson"]; + post: operations['PostAccountsAccountPeoplePerson'] /**

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.

*/ - delete: operations["DeleteAccountsAccountPeoplePerson"]; - }; - "/v1/accounts/{account}/persons": { + delete: operations['DeleteAccountsAccountPeoplePerson'] + } + '/v1/accounts/{account}/persons': { /**

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.

*/ - get: operations["GetAccountsAccountPersons"]; + get: operations['GetAccountsAccountPersons'] /**

Creates a new person.

*/ - post: operations["PostAccountsAccountPersons"]; - }; - "/v1/accounts/{account}/persons/{person}": { + post: operations['PostAccountsAccountPersons'] + } + '/v1/accounts/{account}/persons/{person}': { /**

Retrieves an existing person.

*/ - get: operations["GetAccountsAccountPersonsPerson"]; + get: operations['GetAccountsAccountPersonsPerson'] /**

Updates an existing person.

*/ - post: operations["PostAccountsAccountPersonsPerson"]; + post: operations['PostAccountsAccountPersonsPerson'] /**

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.

*/ - delete: operations["DeleteAccountsAccountPersonsPerson"]; - }; - "/v1/accounts/{account}/reject": { + delete: operations['DeleteAccountsAccountPersonsPerson'] + } + '/v1/accounts/{account}/reject': { /** *

With Connect, you may flag accounts as suspicious.

* *

Test-mode Custom and Express accounts can be rejected at any time. Accounts created using live-mode keys may only be rejected once all balances are zero.

*/ - post: operations["PostAccountsAccountReject"]; - }; - "/v1/apple_pay/domains": { + post: operations['PostAccountsAccountReject'] + } + '/v1/apple_pay/domains': { /**

List apple pay domains.

*/ - get: operations["GetApplePayDomains"]; + get: operations['GetApplePayDomains'] /**

Create an apple pay domain.

*/ - post: operations["PostApplePayDomains"]; - }; - "/v1/apple_pay/domains/{domain}": { + post: operations['PostApplePayDomains'] + } + '/v1/apple_pay/domains/{domain}': { /**

Retrieve an apple pay domain.

*/ - get: operations["GetApplePayDomainsDomain"]; + get: operations['GetApplePayDomainsDomain'] /**

Delete an apple pay domain.

*/ - delete: operations["DeleteApplePayDomainsDomain"]; - }; - "/v1/application_fees": { + delete: operations['DeleteApplePayDomainsDomain'] + } + '/v1/application_fees': { /**

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.

*/ - get: operations["GetApplicationFees"]; - }; - "/v1/application_fees/{fee}/refunds/{id}": { + get: operations['GetApplicationFees'] + } + '/v1/application_fees/{fee}/refunds/{id}': { /**

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.

*/ - get: operations["GetApplicationFeesFeeRefundsId"]; + get: operations['GetApplicationFeesFeeRefundsId'] /** *

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

* *

This request only accepts metadata as an argument.

*/ - post: operations["PostApplicationFeesFeeRefundsId"]; - }; - "/v1/application_fees/{id}": { + post: operations['PostApplicationFeesFeeRefundsId'] + } + '/v1/application_fees/{id}': { /**

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

*/ - get: operations["GetApplicationFeesId"]; - }; - "/v1/application_fees/{id}/refund": { - post: operations["PostApplicationFeesIdRefund"]; - }; - "/v1/application_fees/{id}/refunds": { + get: operations['GetApplicationFeesId'] + } + '/v1/application_fees/{id}/refund': { + post: operations['PostApplicationFeesIdRefund'] + } + '/v1/application_fees/{id}/refunds': { /**

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.

*/ - get: operations["GetApplicationFeesIdRefunds"]; + get: operations['GetApplicationFeesIdRefunds'] /** *

Refunds an application fee that has previously been collected but not yet refunded. * Funds will be refunded to the Stripe account from which the fee was originally collected.

@@ -291,96 +291,96 @@ export interface paths { * This method will raise an error when called on an already-refunded application fee, * or when trying to refund more money than is left on an application fee.

*/ - post: operations["PostApplicationFeesIdRefunds"]; - }; - "/v1/balance": { + post: operations['PostApplicationFeesIdRefunds'] + } + '/v1/balance': { /** *

Retrieves the current account balance, based on the authentication that was used to make the request. * For a sample request, see Accounting for negative balances.

*/ - get: operations["GetBalance"]; - }; - "/v1/balance/history": { + get: operations['GetBalance'] + } + '/v1/balance/history': { /** *

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

* *

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

*/ - get: operations["GetBalanceHistory"]; - }; - "/v1/balance/history/{id}": { + get: operations['GetBalanceHistory'] + } + '/v1/balance/history/{id}': { /** *

Retrieves the balance transaction with the given ID.

* *

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

*/ - get: operations["GetBalanceHistoryId"]; - }; - "/v1/balance_transactions": { + get: operations['GetBalanceHistoryId'] + } + '/v1/balance_transactions': { /** *

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

* *

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

*/ - get: operations["GetBalanceTransactions"]; - }; - "/v1/balance_transactions/{id}": { + get: operations['GetBalanceTransactions'] + } + '/v1/balance_transactions/{id}': { /** *

Retrieves the balance transaction with the given ID.

* *

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

*/ - get: operations["GetBalanceTransactionsId"]; - }; - "/v1/billing_portal/sessions": { + get: operations['GetBalanceTransactionsId'] + } + '/v1/billing_portal/sessions': { /**

Creates a session of the self-serve Portal.

*/ - post: operations["PostBillingPortalSessions"]; - }; - "/v1/bitcoin/receivers": { + post: operations['PostBillingPortalSessions'] + } + '/v1/bitcoin/receivers': { /**

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

*/ - get: operations["GetBitcoinReceivers"]; - }; - "/v1/bitcoin/receivers/{id}": { + get: operations['GetBitcoinReceivers'] + } + '/v1/bitcoin/receivers/{id}': { /**

Retrieves the Bitcoin receiver with the given ID.

*/ - get: operations["GetBitcoinReceiversId"]; - }; - "/v1/bitcoin/receivers/{receiver}/transactions": { + get: operations['GetBitcoinReceiversId'] + } + '/v1/bitcoin/receivers/{receiver}/transactions': { /**

List bitcoin transacitons for a given receiver.

*/ - get: operations["GetBitcoinReceiversReceiverTransactions"]; - }; - "/v1/bitcoin/transactions": { + get: operations['GetBitcoinReceiversReceiverTransactions'] + } + '/v1/bitcoin/transactions': { /**

List bitcoin transacitons for a given receiver.

*/ - get: operations["GetBitcoinTransactions"]; - }; - "/v1/charges": { + get: operations['GetBitcoinTransactions'] + } + '/v1/charges': { /**

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

*/ - get: operations["GetCharges"]; + get: operations['GetCharges'] /**

To charge a credit card or other payment source, you create a Charge object. If your API key is in test mode, the supplied payment source (e.g., card) won’t actually be charged, although everything else will occur as if in live mode. (Stripe assumes that the charge would have completed successfully).

*/ - post: operations["PostCharges"]; - }; - "/v1/charges/{charge}": { + post: operations['PostCharges'] + } + '/v1/charges/{charge}': { /**

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.

*/ - get: operations["GetChargesCharge"]; + get: operations['GetChargesCharge'] /**

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

*/ - post: operations["PostChargesCharge"]; - }; - "/v1/charges/{charge}/capture": { + post: operations['PostChargesCharge'] + } + '/v1/charges/{charge}/capture': { /** *

Capture the payment of an existing, uncaptured, charge. This is the second half of the two-step payment flow, where first you created a charge with the capture option set to false.

* *

Uncaptured payments expire exactly seven days after they are created. If they are not captured by that point in time, they will be marked as refunded and will no longer be capturable.

*/ - post: operations["PostChargesChargeCapture"]; - }; - "/v1/charges/{charge}/dispute": { + post: operations['PostChargesChargeCapture'] + } + '/v1/charges/{charge}/dispute': { /**

Retrieve a dispute for a specified charge.

*/ - get: operations["GetChargesChargeDispute"]; - post: operations["PostChargesChargeDispute"]; - }; - "/v1/charges/{charge}/dispute/close": { - post: operations["PostChargesChargeDisputeClose"]; - }; - "/v1/charges/{charge}/refund": { + get: operations['GetChargesChargeDispute'] + post: operations['PostChargesChargeDispute'] + } + '/v1/charges/{charge}/dispute/close': { + post: operations['PostChargesChargeDisputeClose'] + } + '/v1/charges/{charge}/refund': { /** *

When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.

* @@ -394,59 +394,59 @@ export interface paths { * 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.

*/ - post: operations["PostChargesChargeRefund"]; - }; - "/v1/charges/{charge}/refunds": { + post: operations['PostChargesChargeRefund'] + } + '/v1/charges/{charge}/refunds': { /**

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.

*/ - get: operations["GetChargesChargeRefunds"]; + get: operations['GetChargesChargeRefunds'] /**

Create a refund.

*/ - post: operations["PostChargesChargeRefunds"]; - }; - "/v1/charges/{charge}/refunds/{refund}": { + post: operations['PostChargesChargeRefunds'] + } + '/v1/charges/{charge}/refunds/{refund}': { /**

Retrieves the details of an existing refund.

*/ - get: operations["GetChargesChargeRefundsRefund"]; + get: operations['GetChargesChargeRefundsRefund'] /**

Update a specified refund.

*/ - post: operations["PostChargesChargeRefundsRefund"]; - }; - "/v1/checkout/sessions": { + post: operations['PostChargesChargeRefundsRefund'] + } + '/v1/checkout/sessions': { /**

Returns a list of Checkout Sessions.

*/ - get: operations["GetCheckoutSessions"]; + get: operations['GetCheckoutSessions'] /**

Creates a Session object.

*/ - post: operations["PostCheckoutSessions"]; - }; - "/v1/checkout/sessions/{session}": { + post: operations['PostCheckoutSessions'] + } + '/v1/checkout/sessions/{session}': { /**

Retrieves a Session object.

*/ - get: operations["GetCheckoutSessionsSession"]; - }; - "/v1/country_specs": { + get: operations['GetCheckoutSessionsSession'] + } + '/v1/country_specs': { /**

Lists all Country Spec objects available in the API.

*/ - get: operations["GetCountrySpecs"]; - }; - "/v1/country_specs/{country}": { + get: operations['GetCountrySpecs'] + } + '/v1/country_specs/{country}': { /**

Returns a Country Spec for a given Country code.

*/ - get: operations["GetCountrySpecsCountry"]; - }; - "/v1/coupons": { + get: operations['GetCountrySpecsCountry'] + } + '/v1/coupons': { /**

Returns a list of your coupons.

*/ - get: operations["GetCoupons"]; + get: operations['GetCoupons'] /** *

You can create coupons easily via the coupon management page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.

* *

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.

*/ - post: operations["PostCoupons"]; - }; - "/v1/coupons/{coupon}": { + post: operations['PostCoupons'] + } + '/v1/coupons/{coupon}': { /**

Retrieves the coupon with the given ID.

*/ - get: operations["GetCouponsCoupon"]; + get: operations['GetCouponsCoupon'] /**

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

*/ - post: operations["PostCouponsCoupon"]; + post: operations['PostCouponsCoupon'] /**

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.

*/ - delete: operations["DeleteCouponsCoupon"]; - }; - "/v1/credit_notes": { + delete: operations['DeleteCouponsCoupon'] + } + '/v1/credit_notes': { /**

Returns a list of credit notes.

*/ - get: operations["GetCreditNotes"]; + get: operations['GetCreditNotes'] /** *

Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces * its amount_due. For a status=paid invoice, a credit note does not affect its amount_due. Instead, it can result @@ -463,63 +463,63 @@ export interface paths { *

You may issue multiple credit notes for an invoice. Each credit note will increment the invoice’s pre_payment_credit_notes_amount * or post_payment_credit_notes_amount depending on its status at the time of credit note creation.

*/ - post: operations["PostCreditNotes"]; - }; - "/v1/credit_notes/preview": { + post: operations['PostCreditNotes'] + } + '/v1/credit_notes/preview': { /**

Get a preview of a credit note without creating it.

*/ - get: operations["GetCreditNotesPreview"]; - }; - "/v1/credit_notes/preview/lines": { + get: operations['GetCreditNotesPreview'] + } + '/v1/credit_notes/preview/lines': { /**

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.

*/ - get: operations["GetCreditNotesPreviewLines"]; - }; - "/v1/credit_notes/{credit_note}/lines": { + get: operations['GetCreditNotesPreviewLines'] + } + '/v1/credit_notes/{credit_note}/lines': { /**

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

*/ - get: operations["GetCreditNotesCreditNoteLines"]; - }; - "/v1/credit_notes/{id}": { + get: operations['GetCreditNotesCreditNoteLines'] + } + '/v1/credit_notes/{id}': { /**

Retrieves the credit note object with the given identifier.

*/ - get: operations["GetCreditNotesId"]; + get: operations['GetCreditNotesId'] /**

Updates an existing credit note.

*/ - post: operations["PostCreditNotesId"]; - }; - "/v1/credit_notes/{id}/void": { + post: operations['PostCreditNotesId'] + } + '/v1/credit_notes/{id}/void': { /**

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

*/ - post: operations["PostCreditNotesIdVoid"]; - }; - "/v1/customers": { + post: operations['PostCreditNotesIdVoid'] + } + '/v1/customers': { /**

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

*/ - get: operations["GetCustomers"]; + get: operations['GetCustomers'] /**

Creates a new customer object.

*/ - post: operations["PostCustomers"]; - }; - "/v1/customers/{customer}": { + post: operations['PostCustomers'] + } + '/v1/customers/{customer}': { /**

Retrieves the details of an existing customer. You need only supply the unique customer identifier that was returned upon customer creation.

*/ - get: operations["GetCustomersCustomer"]; + get: operations['GetCustomersCustomer'] /** *

Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the source parameter, that becomes the customer’s active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the source parameter: for each of the customer’s current subscriptions, if the subscription bills automatically and is in the past_due state, then the latest open invoice for the subscription with automatic collection enabled will be retried. This retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice. Changing the default_source for a customer will not trigger this behavior.

* *

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

*/ - post: operations["PostCustomersCustomer"]; + post: operations['PostCustomersCustomer'] /**

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

*/ - delete: operations["DeleteCustomersCustomer"]; - }; - "/v1/customers/{customer}/balance_transactions": { + delete: operations['DeleteCustomersCustomer'] + } + '/v1/customers/{customer}/balance_transactions': { /**

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

*/ - get: operations["GetCustomersCustomerBalanceTransactions"]; + get: operations['GetCustomersCustomerBalanceTransactions'] /**

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

*/ - post: operations["PostCustomersCustomerBalanceTransactions"]; - }; - "/v1/customers/{customer}/balance_transactions/{transaction}": { + post: operations['PostCustomersCustomerBalanceTransactions'] + } + '/v1/customers/{customer}/balance_transactions/{transaction}': { /**

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

*/ - get: operations["GetCustomersCustomerBalanceTransactionsTransaction"]; + get: operations['GetCustomersCustomerBalanceTransactionsTransaction'] /**

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

*/ - post: operations["PostCustomersCustomerBalanceTransactionsTransaction"]; - }; - "/v1/customers/{customer}/bank_accounts": { + post: operations['PostCustomersCustomerBalanceTransactionsTransaction'] + } + '/v1/customers/{customer}/bank_accounts': { /**

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.

*/ - get: operations["GetCustomersCustomerBankAccounts"]; + get: operations['GetCustomersCustomerBankAccounts'] /** *

When you create a new credit card, you must specify a customer or recipient on which to create it.

* @@ -527,27 +527,27 @@ export interface paths { * 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.

*/ - post: operations["PostCustomersCustomerBankAccounts"]; - }; - "/v1/customers/{customer}/bank_accounts/{id}": { + post: operations['PostCustomersCustomerBankAccounts'] + } + '/v1/customers/{customer}/bank_accounts/{id}': { /**

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.

*/ - get: operations["GetCustomersCustomerBankAccountsId"]; + get: operations['GetCustomersCustomerBankAccountsId'] /**

Update a specified source for a given customer.

*/ - post: operations["PostCustomersCustomerBankAccountsId"]; + post: operations['PostCustomersCustomerBankAccountsId'] /**

Delete a specified source for a given customer.

*/ - delete: operations["DeleteCustomersCustomerBankAccountsId"]; - }; - "/v1/customers/{customer}/bank_accounts/{id}/verify": { + delete: operations['DeleteCustomersCustomerBankAccountsId'] + } + '/v1/customers/{customer}/bank_accounts/{id}/verify': { /**

Verify a specified bank account for a given customer.

*/ - post: operations["PostCustomersCustomerBankAccountsIdVerify"]; - }; - "/v1/customers/{customer}/cards": { + post: operations['PostCustomersCustomerBankAccountsIdVerify'] + } + '/v1/customers/{customer}/cards': { /** *

You can see a list of the cards belonging to a customer. * Note that the 10 most recent sources are always available on the Customer 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 cards.

*/ - get: operations["GetCustomersCustomerCards"]; + get: operations['GetCustomersCustomerCards'] /** *

When you create a new credit card, you must specify a customer or recipient on which to create it.

* @@ -555,24 +555,24 @@ export interface paths { * 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.

*/ - post: operations["PostCustomersCustomerCards"]; - }; - "/v1/customers/{customer}/cards/{id}": { + post: operations['PostCustomersCustomerCards'] + } + '/v1/customers/{customer}/cards/{id}': { /**

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.

*/ - get: operations["GetCustomersCustomerCardsId"]; + get: operations['GetCustomersCustomerCardsId'] /**

Update a specified source for a given customer.

*/ - post: operations["PostCustomersCustomerCardsId"]; + post: operations['PostCustomersCustomerCardsId'] /**

Delete a specified source for a given customer.

*/ - delete: operations["DeleteCustomersCustomerCardsId"]; - }; - "/v1/customers/{customer}/discount": { - get: operations["GetCustomersCustomerDiscount"]; + delete: operations['DeleteCustomersCustomerCardsId'] + } + '/v1/customers/{customer}/discount': { + get: operations['GetCustomersCustomerDiscount'] /**

Removes the currently applied discount on a customer.

*/ - delete: operations["DeleteCustomersCustomerDiscount"]; - }; - "/v1/customers/{customer}/sources": { + delete: operations['DeleteCustomersCustomerDiscount'] + } + '/v1/customers/{customer}/sources': { /**

List sources for a specified customer.

*/ - get: operations["GetCustomersCustomerSources"]; + get: operations['GetCustomersCustomerSources'] /** *

When you create a new credit card, you must specify a customer or recipient on which to create it.

* @@ -580,31 +580,31 @@ export interface paths { * 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.

*/ - post: operations["PostCustomersCustomerSources"]; - }; - "/v1/customers/{customer}/sources/{id}": { + post: operations['PostCustomersCustomerSources'] + } + '/v1/customers/{customer}/sources/{id}': { /**

Retrieve a specified source for a given customer.

*/ - get: operations["GetCustomersCustomerSourcesId"]; + get: operations['GetCustomersCustomerSourcesId'] /**

Update a specified source for a given customer.

*/ - post: operations["PostCustomersCustomerSourcesId"]; + post: operations['PostCustomersCustomerSourcesId'] /**

Delete a specified source for a given customer.

*/ - delete: operations["DeleteCustomersCustomerSourcesId"]; - }; - "/v1/customers/{customer}/sources/{id}/verify": { + delete: operations['DeleteCustomersCustomerSourcesId'] + } + '/v1/customers/{customer}/sources/{id}/verify': { /**

Verify a specified bank account for a given customer.

*/ - post: operations["PostCustomersCustomerSourcesIdVerify"]; - }; - "/v1/customers/{customer}/subscriptions": { + post: operations['PostCustomersCustomerSourcesIdVerify'] + } + '/v1/customers/{customer}/subscriptions': { /**

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.

*/ - get: operations["GetCustomersCustomerSubscriptions"]; + get: operations['GetCustomersCustomerSubscriptions'] /**

Creates a new subscription on an existing customer.

*/ - post: operations["PostCustomersCustomerSubscriptions"]; - }; - "/v1/customers/{customer}/subscriptions/{subscription_exposed_id}": { + post: operations['PostCustomersCustomerSubscriptions'] + } + '/v1/customers/{customer}/subscriptions/{subscription_exposed_id}': { /**

Retrieves the subscription with the given ID.

*/ - get: operations["GetCustomersCustomerSubscriptionsSubscriptionExposedId"]; + get: operations['GetCustomersCustomerSubscriptionsSubscriptionExposedId'] /**

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.

*/ - post: operations["PostCustomersCustomerSubscriptionsSubscriptionExposedId"]; + post: operations['PostCustomersCustomerSubscriptionsSubscriptionExposedId'] /** *

Cancels a customer’s subscription. If you set the at_period_end parameter to true, the subscription will remain active until the end of the period, at which point it will be canceled and not renewed. Otherwise, with the default false value, the subscription is terminated immediately. In either case, the customer will not be charged again for the subscription.

* @@ -612,118 +612,118 @@ export interface paths { * *

By default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.

*/ - delete: operations["DeleteCustomersCustomerSubscriptionsSubscriptionExposedId"]; - }; - "/v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discount": { - get: operations["GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount"]; + delete: operations['DeleteCustomersCustomerSubscriptionsSubscriptionExposedId'] + } + '/v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discount': { + get: operations['GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount'] /**

Removes the currently applied discount on a customer.

*/ - delete: operations["DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount"]; - }; - "/v1/customers/{customer}/tax_ids": { + delete: operations['DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount'] + } + '/v1/customers/{customer}/tax_ids': { /**

Returns a list of tax IDs for a customer.

*/ - get: operations["GetCustomersCustomerTaxIds"]; + get: operations['GetCustomersCustomerTaxIds'] /**

Creates a new TaxID object for a customer.

*/ - post: operations["PostCustomersCustomerTaxIds"]; - }; - "/v1/customers/{customer}/tax_ids/{id}": { + post: operations['PostCustomersCustomerTaxIds'] + } + '/v1/customers/{customer}/tax_ids/{id}': { /**

Retrieves the TaxID object with the given identifier.

*/ - get: operations["GetCustomersCustomerTaxIdsId"]; + get: operations['GetCustomersCustomerTaxIdsId'] /**

Deletes an existing TaxID object.

*/ - delete: operations["DeleteCustomersCustomerTaxIdsId"]; - }; - "/v1/disputes": { + delete: operations['DeleteCustomersCustomerTaxIdsId'] + } + '/v1/disputes': { /**

Returns a list of your disputes.

*/ - get: operations["GetDisputes"]; - }; - "/v1/disputes/{dispute}": { + get: operations['GetDisputes'] + } + '/v1/disputes/{dispute}': { /**

Retrieves the dispute with the given ID.

*/ - get: operations["GetDisputesDispute"]; + get: operations['GetDisputesDispute'] /** *

When you get a dispute, contacting your customer is always the best first step. If that doesn’t work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your dashboard, but if you prefer, you can use the API to submit evidence programmatically.

* *

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.

*/ - post: operations["PostDisputesDispute"]; - }; - "/v1/disputes/{dispute}/close": { + post: operations['PostDisputesDispute'] + } + '/v1/disputes/{dispute}/close': { /** *

Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.

* *

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

*/ - post: operations["PostDisputesDisputeClose"]; - }; - "/v1/ephemeral_keys": { + post: operations['PostDisputesDisputeClose'] + } + '/v1/ephemeral_keys': { /**

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

*/ - post: operations["PostEphemeralKeys"]; - }; - "/v1/ephemeral_keys/{key}": { + post: operations['PostEphemeralKeys'] + } + '/v1/ephemeral_keys/{key}': { /**

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

*/ - delete: operations["DeleteEphemeralKeysKey"]; - }; - "/v1/events": { + delete: operations['DeleteEphemeralKeysKey'] + } + '/v1/events': { /**

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).

*/ - get: operations["GetEvents"]; - }; - "/v1/events/{id}": { + get: operations['GetEvents'] + } + '/v1/events/{id}': { /**

Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.

*/ - get: operations["GetEventsId"]; - }; - "/v1/exchange_rates": { + get: operations['GetEventsId'] + } + '/v1/exchange_rates': { /**

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.

*/ - get: operations["GetExchangeRates"]; - }; - "/v1/exchange_rates/{currency}": { + get: operations['GetExchangeRates'] + } + '/v1/exchange_rates/{currency}': { /**

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

*/ - get: operations["GetExchangeRatesCurrency"]; - }; - "/v1/file_links": { + get: operations['GetExchangeRatesCurrency'] + } + '/v1/file_links': { /**

Returns a list of file links.

*/ - get: operations["GetFileLinks"]; + get: operations['GetFileLinks'] /**

Creates a new file link object.

*/ - post: operations["PostFileLinks"]; - }; - "/v1/file_links/{link}": { + post: operations['PostFileLinks'] + } + '/v1/file_links/{link}': { /**

Retrieves the file link with the given ID.

*/ - get: operations["GetFileLinksLink"]; + get: operations['GetFileLinksLink'] /**

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

*/ - post: operations["PostFileLinksLink"]; - }; - "/v1/files": { + post: operations['PostFileLinksLink'] + } + '/v1/files': { /**

Returns a list of the files that your account has access to. The files are returned sorted by creation date, with the most recently created files appearing first.

*/ - get: operations["GetFiles"]; + get: operations['GetFiles'] /** *

To upload a file to Stripe, you’ll need to send a request of type multipart/form-data. The request should contain the file you would like to upload, as well as the parameters for creating a file.

* *

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

*/ - post: operations["PostFiles"]; - }; - "/v1/files/{file}": { + post: operations['PostFiles'] + } + '/v1/files/{file}': { /**

Retrieves the details of an existing file object. Supply the unique file ID from a file, and Stripe will return the corresponding file object. To access file contents, see the File Upload Guide.

*/ - get: operations["GetFilesFile"]; - }; - "/v1/invoiceitems": { + get: operations['GetFilesFile'] + } + '/v1/invoiceitems': { /**

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

*/ - get: operations["GetInvoiceitems"]; + get: operations['GetInvoiceitems'] /**

Creates an item to be added to a draft invoice. If no invoice is specified, the item will be on the next invoice created for the customer specified.

*/ - post: operations["PostInvoiceitems"]; - }; - "/v1/invoiceitems/{invoiceitem}": { + post: operations['PostInvoiceitems'] + } + '/v1/invoiceitems/{invoiceitem}': { /**

Retrieves the invoice item with the given ID.

*/ - get: operations["GetInvoiceitemsInvoiceitem"]; + get: operations['GetInvoiceitemsInvoiceitem'] /**

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.

*/ - post: operations["PostInvoiceitemsInvoiceitem"]; + post: operations['PostInvoiceitemsInvoiceitem'] /**

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.

*/ - delete: operations["DeleteInvoiceitemsInvoiceitem"]; - }; - "/v1/invoices": { + delete: operations['DeleteInvoiceitemsInvoiceitem'] + } + '/v1/invoices': { /**

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.

*/ - get: operations["GetInvoices"]; + get: operations['GetInvoices'] /**

This endpoint creates a draft invoice for a given customer. The draft invoice created pulls in all pending invoice items on that customer, including prorations.

*/ - post: operations["PostInvoices"]; - }; - "/v1/invoices/upcoming": { + post: operations['PostInvoices'] + } + '/v1/invoices/upcoming': { /** *

At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discount that is applicable to the customer.

* @@ -731,15 +731,15 @@ export interface paths { * *

You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass a proration_date parameter when doing the actual subscription update. The value passed in should be the same as the subscription_proration_date returned on the upcoming invoice resource. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_proration_date on the upcoming invoice resource.

*/ - get: operations["GetInvoicesUpcoming"]; - }; - "/v1/invoices/upcoming/lines": { + get: operations['GetInvoicesUpcoming'] + } + '/v1/invoices/upcoming/lines': { /**

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.

*/ - get: operations["GetInvoicesUpcomingLines"]; - }; - "/v1/invoices/{invoice}": { + get: operations['GetInvoicesUpcomingLines'] + } + '/v1/invoices/{invoice}': { /**

Retrieves the invoice with the given ID.

*/ - get: operations["GetInvoicesInvoice"]; + get: operations['GetInvoicesInvoice'] /** *

Draft invoices are fully editable. Once an invoice is finalized, * monetary values, as well as collection_method, become uneditable.

@@ -748,159 +748,159 @@ export interface paths { * sending reminders for, or automatically reconciling invoices, pass * auto_advance=false.

*/ - post: operations["PostInvoicesInvoice"]; + post: operations['PostInvoicesInvoice'] /**

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

*/ - delete: operations["DeleteInvoicesInvoice"]; - }; - "/v1/invoices/{invoice}/finalize": { + delete: operations['DeleteInvoicesInvoice'] + } + '/v1/invoices/{invoice}/finalize': { /**

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.

*/ - post: operations["PostInvoicesInvoiceFinalize"]; - }; - "/v1/invoices/{invoice}/lines": { + post: operations['PostInvoicesInvoiceFinalize'] + } + '/v1/invoices/{invoice}/lines': { /**

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.

*/ - get: operations["GetInvoicesInvoiceLines"]; - }; - "/v1/invoices/{invoice}/mark_uncollectible": { + get: operations['GetInvoicesInvoiceLines'] + } + '/v1/invoices/{invoice}/mark_uncollectible': { /**

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

*/ - post: operations["PostInvoicesInvoiceMarkUncollectible"]; - }; - "/v1/invoices/{invoice}/pay": { + post: operations['PostInvoicesInvoiceMarkUncollectible'] + } + '/v1/invoices/{invoice}/pay': { /**

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.

*/ - post: operations["PostInvoicesInvoicePay"]; - }; - "/v1/invoices/{invoice}/send": { + post: operations['PostInvoicesInvoicePay'] + } + '/v1/invoices/{invoice}/send': { /** *

Stripe will automatically send invoices to customers according to your subscriptions settings. However, if you’d like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.

* *

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

*/ - post: operations["PostInvoicesInvoiceSend"]; - }; - "/v1/invoices/{invoice}/void": { + post: operations['PostInvoicesInvoiceSend'] + } + '/v1/invoices/{invoice}/void': { /**

Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.

*/ - post: operations["PostInvoicesInvoiceVoid"]; - }; - "/v1/issuer_fraud_records": { + post: operations['PostInvoicesInvoiceVoid'] + } + '/v1/issuer_fraud_records': { /**

Returns a list of issuer fraud records.

*/ - get: operations["GetIssuerFraudRecords"]; - }; - "/v1/issuer_fraud_records/{issuer_fraud_record}": { + get: operations['GetIssuerFraudRecords'] + } + '/v1/issuer_fraud_records/{issuer_fraud_record}': { /** *

Retrieves the details of an issuer fraud record that has previously been created.

* *

Please refer to the issuer fraud record object reference for more details.

*/ - get: operations["GetIssuerFraudRecordsIssuerFraudRecord"]; - }; - "/v1/issuing/authorizations": { + get: operations['GetIssuerFraudRecordsIssuerFraudRecord'] + } + '/v1/issuing/authorizations': { /**

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.

*/ - get: operations["GetIssuingAuthorizations"]; - }; - "/v1/issuing/authorizations/{authorization}": { + get: operations['GetIssuingAuthorizations'] + } + '/v1/issuing/authorizations/{authorization}': { /**

Retrieves an Issuing Authorization object.

*/ - get: operations["GetIssuingAuthorizationsAuthorization"]; + get: operations['GetIssuingAuthorizationsAuthorization'] /**

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

*/ - post: operations["PostIssuingAuthorizationsAuthorization"]; - }; - "/v1/issuing/authorizations/{authorization}/approve": { + post: operations['PostIssuingAuthorizationsAuthorization'] + } + '/v1/issuing/authorizations/{authorization}/approve': { /**

Approves a pending Issuing Authorization object. This request should be made within the timeout window of the real-time authorization flow.

*/ - post: operations["PostIssuingAuthorizationsAuthorizationApprove"]; - }; - "/v1/issuing/authorizations/{authorization}/decline": { + post: operations['PostIssuingAuthorizationsAuthorizationApprove'] + } + '/v1/issuing/authorizations/{authorization}/decline': { /**

Declines a pending Issuing Authorization object. This request should be made within the timeout window of the real time authorization flow.

*/ - post: operations["PostIssuingAuthorizationsAuthorizationDecline"]; - }; - "/v1/issuing/cardholders": { + post: operations['PostIssuingAuthorizationsAuthorizationDecline'] + } + '/v1/issuing/cardholders': { /**

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

*/ - get: operations["GetIssuingCardholders"]; + get: operations['GetIssuingCardholders'] /**

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

*/ - post: operations["PostIssuingCardholders"]; - }; - "/v1/issuing/cardholders/{cardholder}": { + post: operations['PostIssuingCardholders'] + } + '/v1/issuing/cardholders/{cardholder}': { /**

Retrieves an Issuing Cardholder object.

*/ - get: operations["GetIssuingCardholdersCardholder"]; + get: operations['GetIssuingCardholdersCardholder'] /**

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

*/ - post: operations["PostIssuingCardholdersCardholder"]; - }; - "/v1/issuing/cards": { + post: operations['PostIssuingCardholdersCardholder'] + } + '/v1/issuing/cards': { /**

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

*/ - get: operations["GetIssuingCards"]; + get: operations['GetIssuingCards'] /**

Creates an Issuing Card object.

*/ - post: operations["PostIssuingCards"]; - }; - "/v1/issuing/cards/{card}": { + post: operations['PostIssuingCards'] + } + '/v1/issuing/cards/{card}': { /**

Retrieves an Issuing Card object.

*/ - get: operations["GetIssuingCardsCard"]; + get: operations['GetIssuingCardsCard'] /**

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

*/ - post: operations["PostIssuingCardsCard"]; - }; - "/v1/issuing/disputes": { + post: operations['PostIssuingCardsCard'] + } + '/v1/issuing/disputes': { /**

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

*/ - get: operations["GetIssuingDisputes"]; + get: operations['GetIssuingDisputes'] /**

Creates an Issuing Dispute object.

*/ - post: operations["PostIssuingDisputes"]; - }; - "/v1/issuing/disputes/{dispute}": { + post: operations['PostIssuingDisputes'] + } + '/v1/issuing/disputes/{dispute}': { /**

Retrieves an Issuing Dispute object.

*/ - get: operations["GetIssuingDisputesDispute"]; + get: operations['GetIssuingDisputesDispute'] /**

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

*/ - post: operations["PostIssuingDisputesDispute"]; - }; - "/v1/issuing/settlements": { + post: operations['PostIssuingDisputesDispute'] + } + '/v1/issuing/settlements': { /**

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

*/ - get: operations["GetIssuingSettlements"]; - }; - "/v1/issuing/settlements/{settlement}": { + get: operations['GetIssuingSettlements'] + } + '/v1/issuing/settlements/{settlement}': { /**

Retrieves an Issuing Settlement object.

*/ - get: operations["GetIssuingSettlementsSettlement"]; + get: operations['GetIssuingSettlementsSettlement'] /**

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

*/ - post: operations["PostIssuingSettlementsSettlement"]; - }; - "/v1/issuing/transactions": { + post: operations['PostIssuingSettlementsSettlement'] + } + '/v1/issuing/transactions': { /**

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.

*/ - get: operations["GetIssuingTransactions"]; - }; - "/v1/issuing/transactions/{transaction}": { + get: operations['GetIssuingTransactions'] + } + '/v1/issuing/transactions/{transaction}': { /**

Retrieves an Issuing Transaction object.

*/ - get: operations["GetIssuingTransactionsTransaction"]; + get: operations['GetIssuingTransactionsTransaction'] /**

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

*/ - post: operations["PostIssuingTransactionsTransaction"]; - }; - "/v1/mandates/{mandate}": { + post: operations['PostIssuingTransactionsTransaction'] + } + '/v1/mandates/{mandate}': { /**

Retrieves a Mandate object.

*/ - get: operations["GetMandatesMandate"]; - }; - "/v1/order_returns": { + get: operations['GetMandatesMandate'] + } + '/v1/order_returns': { /**

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

*/ - get: operations["GetOrderReturns"]; - }; - "/v1/order_returns/{id}": { + get: operations['GetOrderReturns'] + } + '/v1/order_returns/{id}': { /**

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

*/ - get: operations["GetOrderReturnsId"]; - }; - "/v1/orders": { + get: operations['GetOrderReturnsId'] + } + '/v1/orders': { /**

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

*/ - get: operations["GetOrders"]; + get: operations['GetOrders'] /**

Creates a new order object.

*/ - post: operations["PostOrders"]; - }; - "/v1/orders/{id}": { + post: operations['PostOrders'] + } + '/v1/orders/{id}': { /**

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

*/ - get: operations["GetOrdersId"]; + get: operations['GetOrdersId'] /**

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

*/ - post: operations["PostOrdersId"]; - }; - "/v1/orders/{id}/pay": { + post: operations['PostOrdersId'] + } + '/v1/orders/{id}/pay': { /**

Pay an order by providing a source to create a payment.

*/ - post: operations["PostOrdersIdPay"]; - }; - "/v1/orders/{id}/returns": { + post: operations['PostOrdersIdPay'] + } + '/v1/orders/{id}/returns': { /**

Return all or part of an order. The order must have a status of paid or fulfilled before it can be returned. Once all items have been returned, the order will become canceled or returned depending on which status the order started in.

*/ - post: operations["PostOrdersIdReturns"]; - }; - "/v1/payment_intents": { + post: operations['PostOrdersIdReturns'] + } + '/v1/payment_intents': { /**

Returns a list of PaymentIntents.

*/ - get: operations["GetPaymentIntents"]; + get: operations['GetPaymentIntents'] /** *

Creates a PaymentIntent object.

* @@ -913,9 +913,9 @@ export interface paths { * available in the confirm API when confirm=true * is supplied.

*/ - post: operations["PostPaymentIntents"]; - }; - "/v1/payment_intents/{intent}": { + post: operations['PostPaymentIntents'] + } + '/v1/payment_intents/{intent}': { /** *

Retrieves the details of a PaymentIntent that has previously been created.

* @@ -923,7 +923,7 @@ export interface paths { * *

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

*/ - get: operations["GetPaymentIntentsIntent"]; + get: operations['GetPaymentIntentsIntent'] /** *

Updates properties on a PaymentIntent object without confirming.

* @@ -933,17 +933,17 @@ export interface paths { * update and confirm at the same time, we recommend updating properties via * the confirm API instead.

*/ - post: operations["PostPaymentIntentsIntent"]; - }; - "/v1/payment_intents/{intent}/cancel": { + post: operations['PostPaymentIntentsIntent'] + } + '/v1/payment_intents/{intent}/cancel': { /** *

A PaymentIntent object can be canceled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action.

* *

Once canceled, no additional charges will be made by the PaymentIntent and any operations on the PaymentIntent will fail with an error. For PaymentIntents with status='requires_capture', the remaining amount_capturable will automatically be refunded.

*/ - post: operations["PostPaymentIntentsIntentCancel"]; - }; - "/v1/payment_intents/{intent}/capture": { + post: operations['PostPaymentIntentsIntentCancel'] + } + '/v1/payment_intents/{intent}/capture': { /** *

Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.

* @@ -951,9 +951,9 @@ export interface paths { * *

Learn more about separate authorization and capture.

*/ - post: operations["PostPaymentIntentsIntentCapture"]; - }; - "/v1/payment_intents/{intent}/confirm": { + post: operations['PostPaymentIntentsIntentCapture'] + } + '/v1/payment_intents/{intent}/confirm': { /** *

Confirm that your customer intends to pay with current or provided * payment method. Upon confirmation, the PaymentIntent will attempt to initiate @@ -981,21 +981,21 @@ export interface paths { * attempt. Read the expanded documentation * to learn more about manual confirmation.

*/ - post: operations["PostPaymentIntentsIntentConfirm"]; - }; - "/v1/payment_methods": { + post: operations['PostPaymentIntentsIntentConfirm'] + } + '/v1/payment_methods': { /**

Returns a list of PaymentMethods for a given Customer

*/ - get: operations["GetPaymentMethods"]; + get: operations['GetPaymentMethods'] /**

Creates a PaymentMethod object. Read the Stripe.js reference to learn how to create PaymentMethods via Stripe.js.

*/ - post: operations["PostPaymentMethods"]; - }; - "/v1/payment_methods/{payment_method}": { + post: operations['PostPaymentMethods'] + } + '/v1/payment_methods/{payment_method}': { /**

Retrieves a PaymentMethod object.

*/ - get: operations["GetPaymentMethodsPaymentMethod"]; + get: operations['GetPaymentMethodsPaymentMethod'] /**

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

*/ - post: operations["PostPaymentMethodsPaymentMethod"]; - }; - "/v1/payment_methods/{payment_method}/attach": { + post: operations['PostPaymentMethodsPaymentMethod'] + } + '/v1/payment_methods/{payment_method}/attach': { /** *

Attaches a PaymentMethod object to a Customer.

* @@ -1009,15 +1009,15 @@ export interface paths { * set invoice_settings.default_payment_method, * on the Customer to the PaymentMethod’s ID.

*/ - post: operations["PostPaymentMethodsPaymentMethodAttach"]; - }; - "/v1/payment_methods/{payment_method}/detach": { + post: operations['PostPaymentMethodsPaymentMethodAttach'] + } + '/v1/payment_methods/{payment_method}/detach': { /**

Detaches a PaymentMethod object from a Customer.

*/ - post: operations["PostPaymentMethodsPaymentMethodDetach"]; - }; - "/v1/payouts": { + post: operations['PostPaymentMethodsPaymentMethodDetach'] + } + '/v1/payouts': { /**

Returns a list of existing payouts sent to third-party bank accounts or that Stripe has sent you. The payouts are returned in sorted order, with the most recently created payouts appearing first.

*/ - get: operations["GetPayouts"]; + get: operations['GetPayouts'] /** *

To send funds to your own bank account, you create a new payout object. Your Stripe balance must be able to cover the payout amount, or you’ll receive an “Insufficient Funds” error.

* @@ -1025,96 +1025,96 @@ export interface paths { * *

If you are creating a manual payout on a Stripe account that uses multiple payment source types, you’ll need to specify the source type balance that the payout should draw from. The balance object details available and pending amounts by source type.

*/ - post: operations["PostPayouts"]; - }; - "/v1/payouts/{payout}": { + post: operations['PostPayouts'] + } + '/v1/payouts/{payout}': { /**

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

*/ - get: operations["GetPayoutsPayout"]; + get: operations['GetPayoutsPayout'] /**

Updates the specified payout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request accepts only the metadata as arguments.

*/ - post: operations["PostPayoutsPayout"]; - }; - "/v1/payouts/{payout}/cancel": { + post: operations['PostPayoutsPayout'] + } + '/v1/payouts/{payout}/cancel': { /**

A previously created payout can be canceled if it has not yet been paid out. Funds will be refunded to your available balance. You may not cancel automatic Stripe payouts.

*/ - post: operations["PostPayoutsPayoutCancel"]; - }; - "/v1/plans": { + post: operations['PostPayoutsPayoutCancel'] + } + '/v1/plans': { /**

Returns a list of your plans.

*/ - get: operations["GetPlans"]; + get: operations['GetPlans'] /**

You can create plans using the API, or in the Stripe Dashboard.

*/ - post: operations["PostPlans"]; - }; - "/v1/plans/{plan}": { + post: operations['PostPlans'] + } + '/v1/plans/{plan}': { /**

Retrieves the plan with the given ID.

*/ - get: operations["GetPlansPlan"]; + get: operations['GetPlansPlan'] /**

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.

*/ - post: operations["PostPlansPlan"]; + post: operations['PostPlansPlan'] /**

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

*/ - delete: operations["DeletePlansPlan"]; - }; - "/v1/products": { + delete: operations['DeletePlansPlan'] + } + '/v1/products': { /**

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

*/ - get: operations["GetProducts"]; + get: operations['GetProducts'] /**

Creates a new product object.

*/ - post: operations["PostProducts"]; - }; - "/v1/products/{id}": { + post: operations['PostProducts'] + } + '/v1/products/{id}': { /**

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.

*/ - get: operations["GetProductsId"]; + get: operations['GetProductsId'] /**

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

*/ - post: operations["PostProductsId"]; + post: operations['PostProductsId'] /**

Delete a product. Deleting a product with type=good is only possible if it has no SKUs associated with it. Deleting a product with type=service is only possible if it has no plans associated with it.

*/ - delete: operations["DeleteProductsId"]; - }; - "/v1/radar/early_fraud_warnings": { + delete: operations['DeleteProductsId'] + } + '/v1/radar/early_fraud_warnings': { /**

Returns a list of early fraud warnings.

*/ - get: operations["GetRadarEarlyFraudWarnings"]; - }; - "/v1/radar/early_fraud_warnings/{early_fraud_warning}": { + get: operations['GetRadarEarlyFraudWarnings'] + } + '/v1/radar/early_fraud_warnings/{early_fraud_warning}': { /** *

Retrieves the details of an early fraud warning that has previously been created.

* *

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

*/ - get: operations["GetRadarEarlyFraudWarningsEarlyFraudWarning"]; - }; - "/v1/radar/value_list_items": { + get: operations['GetRadarEarlyFraudWarningsEarlyFraudWarning'] + } + '/v1/radar/value_list_items': { /**

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

*/ - get: operations["GetRadarValueListItems"]; + get: operations['GetRadarValueListItems'] /**

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

*/ - post: operations["PostRadarValueListItems"]; - }; - "/v1/radar/value_list_items/{item}": { + post: operations['PostRadarValueListItems'] + } + '/v1/radar/value_list_items/{item}': { /**

Retrieves a ValueListItem object.

*/ - get: operations["GetRadarValueListItemsItem"]; + get: operations['GetRadarValueListItemsItem'] /**

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

*/ - delete: operations["DeleteRadarValueListItemsItem"]; - }; - "/v1/radar/value_lists": { + delete: operations['DeleteRadarValueListItemsItem'] + } + '/v1/radar/value_lists': { /**

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

*/ - get: operations["GetRadarValueLists"]; + get: operations['GetRadarValueLists'] /**

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

*/ - post: operations["PostRadarValueLists"]; - }; - "/v1/radar/value_lists/{value_list}": { + post: operations['PostRadarValueLists'] + } + '/v1/radar/value_lists/{value_list}': { /**

Retrieves a ValueList object.

*/ - get: operations["GetRadarValueListsValueList"]; + get: operations['GetRadarValueListsValueList'] /**

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.

*/ - post: operations["PostRadarValueListsValueList"]; + post: operations['PostRadarValueListsValueList'] /**

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.

*/ - delete: operations["DeleteRadarValueListsValueList"]; - }; - "/v1/recipients": { + delete: operations['DeleteRadarValueListsValueList'] + } + '/v1/recipients': { /**

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

*/ - get: operations["GetRecipients"]; + get: operations['GetRecipients'] /** *

Creates a new Recipient object and verifies the recipient’s identity. * Also verifies the recipient’s bank account information or debit card, if either is provided.

*/ - post: operations["PostRecipients"]; - }; - "/v1/recipients/{id}": { + post: operations['PostRecipients'] + } + '/v1/recipients/{id}': { /**

Retrieves the details of an existing recipient. You need only supply the unique recipient identifier that was returned upon recipient creation.

*/ - get: operations["GetRecipientsId"]; + get: operations['GetRecipientsId'] /** *

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

@@ -1122,68 +1122,68 @@ export interface paths { *

If you update the name or tax ID, the identity verification will automatically be rerun. * If you update the bank account, the bank account validation will automatically be rerun.

*/ - post: operations["PostRecipientsId"]; + post: operations['PostRecipientsId'] /**

Permanently deletes a recipient. It cannot be undone.

*/ - delete: operations["DeleteRecipientsId"]; - }; - "/v1/refunds": { + delete: operations['DeleteRecipientsId'] + } + '/v1/refunds': { /**

Returns a list of all refunds you’ve previously created. The refunds are returned in sorted order, with the most recent refunds appearing first. For convenience, the 10 most recent refunds are always available by default on the charge object.

*/ - get: operations["GetRefunds"]; + get: operations['GetRefunds'] /**

Create a refund.

*/ - post: operations["PostRefunds"]; - }; - "/v1/refunds/{refund}": { + post: operations['PostRefunds'] + } + '/v1/refunds/{refund}': { /**

Retrieves the details of an existing refund.

*/ - get: operations["GetRefundsRefund"]; + get: operations['GetRefundsRefund'] /** *

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

* *

This request only accepts metadata as an argument.

*/ - post: operations["PostRefundsRefund"]; - }; - "/v1/reporting/report_runs": { + post: operations['PostRefundsRefund'] + } + '/v1/reporting/report_runs': { /**

Returns a list of Report Runs, with the most recent appearing first. (Requires a live-mode API key.)

*/ - get: operations["GetReportingReportRuns"]; + get: operations['GetReportingReportRuns'] /**

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

*/ - post: operations["PostReportingReportRuns"]; - }; - "/v1/reporting/report_runs/{report_run}": { + post: operations['PostReportingReportRuns'] + } + '/v1/reporting/report_runs/{report_run}': { /**

Retrieves the details of an existing Report Run. (Requires a live-mode API key.)

*/ - get: operations["GetReportingReportRunsReportRun"]; - }; - "/v1/reporting/report_types": { + get: operations['GetReportingReportRunsReportRun'] + } + '/v1/reporting/report_types': { /**

Returns a full list of Report Types. (Requires a live-mode API key.)

*/ - get: operations["GetReportingReportTypes"]; - }; - "/v1/reporting/report_types/{report_type}": { + get: operations['GetReportingReportTypes'] + } + '/v1/reporting/report_types/{report_type}': { /**

Retrieves the details of a Report Type. (Requires a live-mode API key.)

*/ - get: operations["GetReportingReportTypesReportType"]; - }; - "/v1/reviews": { + get: operations['GetReportingReportTypesReportType'] + } + '/v1/reviews': { /**

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.

*/ - get: operations["GetReviews"]; - }; - "/v1/reviews/{review}": { + get: operations['GetReviews'] + } + '/v1/reviews/{review}': { /**

Retrieves a Review object.

*/ - get: operations["GetReviewsReview"]; - }; - "/v1/reviews/{review}/approve": { + get: operations['GetReviewsReview'] + } + '/v1/reviews/{review}/approve': { /**

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

*/ - post: operations["PostReviewsReviewApprove"]; - }; - "/v1/setup_intents": { + post: operations['PostReviewsReviewApprove'] + } + '/v1/setup_intents': { /**

Returns a list of SetupIntents.

*/ - get: operations["GetSetupIntents"]; + get: operations['GetSetupIntents'] /** *

Creates a SetupIntent object.

* *

After the SetupIntent is created, attach a payment method and confirm * to collect any required permissions to charge the payment method later.

*/ - post: operations["PostSetupIntents"]; - }; - "/v1/setup_intents/{intent}": { + post: operations['PostSetupIntents'] + } + '/v1/setup_intents/{intent}': { /** *

Retrieves the details of a SetupIntent that has previously been created.

* @@ -1191,19 +1191,19 @@ export interface paths { * *

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

*/ - get: operations["GetSetupIntentsIntent"]; + get: operations['GetSetupIntentsIntent'] /**

Updates a SetupIntent object.

*/ - post: operations["PostSetupIntentsIntent"]; - }; - "/v1/setup_intents/{intent}/cancel": { + post: operations['PostSetupIntentsIntent'] + } + '/v1/setup_intents/{intent}/cancel': { /** *

A SetupIntent object can be canceled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action.

* *

Once canceled, setup is abandoned and any operations on the SetupIntent will fail with an error.

*/ - post: operations["PostSetupIntentsIntentCancel"]; - }; - "/v1/setup_intents/{intent}/confirm": { + post: operations['PostSetupIntentsIntentCancel'] + } + '/v1/setup_intents/{intent}/confirm': { /** *

Confirm that your customer intends to set up the current or * provided payment method. For example, you would confirm a SetupIntent @@ -1219,87 +1219,87 @@ export interface paths { * the SetupIntent will transition to the * requires_payment_method status.

*/ - post: operations["PostSetupIntentsIntentConfirm"]; - }; - "/v1/sigma/scheduled_query_runs": { + post: operations['PostSetupIntentsIntentConfirm'] + } + '/v1/sigma/scheduled_query_runs': { /**

Returns a list of scheduled query runs.

*/ - get: operations["GetSigmaScheduledQueryRuns"]; - }; - "/v1/sigma/scheduled_query_runs/{scheduled_query_run}": { + get: operations['GetSigmaScheduledQueryRuns'] + } + '/v1/sigma/scheduled_query_runs/{scheduled_query_run}': { /**

Retrieves the details of an scheduled query run.

*/ - get: operations["GetSigmaScheduledQueryRunsScheduledQueryRun"]; - }; - "/v1/skus": { + get: operations['GetSigmaScheduledQueryRunsScheduledQueryRun'] + } + '/v1/skus': { /**

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

*/ - get: operations["GetSkus"]; + get: operations['GetSkus'] /**

Creates a new SKU associated with a product.

*/ - post: operations["PostSkus"]; - }; - "/v1/skus/{id}": { + post: operations['PostSkus'] + } + '/v1/skus/{id}': { /**

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

*/ - get: operations["GetSkusId"]; + get: operations['GetSkusId'] /** *

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

* *

Note that a SKU’s attributes are not editable. Instead, you would need to deactivate the existing SKU and create a new one with the new attribute values.

*/ - post: operations["PostSkusId"]; + post: operations['PostSkusId'] /**

Delete a SKU. Deleting a SKU is only possible until it has been used in an order.

*/ - delete: operations["DeleteSkusId"]; - }; - "/v1/sources": { + delete: operations['DeleteSkusId'] + } + '/v1/sources': { /**

Creates a new source object.

*/ - post: operations["PostSources"]; - }; - "/v1/sources/{source}": { + post: operations['PostSources'] + } + '/v1/sources/{source}': { /**

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.

*/ - get: operations["GetSourcesSource"]; + get: operations['GetSourcesSource'] /** *

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

* *

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.

*/ - post: operations["PostSourcesSource"]; - }; - "/v1/sources/{source}/mandate_notifications/{mandate_notification}": { + post: operations['PostSourcesSource'] + } + '/v1/sources/{source}/mandate_notifications/{mandate_notification}': { /**

Retrieves a new Source MandateNotification.

*/ - get: operations["GetSourcesSourceMandateNotificationsMandateNotification"]; - }; - "/v1/sources/{source}/source_transactions": { + get: operations['GetSourcesSourceMandateNotificationsMandateNotification'] + } + '/v1/sources/{source}/source_transactions': { /**

List source transactions for a given source.

*/ - get: operations["GetSourcesSourceSourceTransactions"]; - }; - "/v1/sources/{source}/source_transactions/{source_transaction}": { + get: operations['GetSourcesSourceSourceTransactions'] + } + '/v1/sources/{source}/source_transactions/{source_transaction}': { /**

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.

*/ - get: operations["GetSourcesSourceSourceTransactionsSourceTransaction"]; - }; - "/v1/sources/{source}/verify": { + get: operations['GetSourcesSourceSourceTransactionsSourceTransaction'] + } + '/v1/sources/{source}/verify': { /**

Verify a given source.

*/ - post: operations["PostSourcesSourceVerify"]; - }; - "/v1/subscription_items": { + post: operations['PostSourcesSourceVerify'] + } + '/v1/subscription_items': { /**

Returns a list of your subscription items for a given subscription.

*/ - get: operations["GetSubscriptionItems"]; + get: operations['GetSubscriptionItems'] /**

Adds a new item to an existing subscription. No existing items will be changed or replaced.

*/ - post: operations["PostSubscriptionItems"]; - }; - "/v1/subscription_items/{item}": { + post: operations['PostSubscriptionItems'] + } + '/v1/subscription_items/{item}': { /**

Retrieves the invoice item with the given ID.

*/ - get: operations["GetSubscriptionItemsItem"]; + get: operations['GetSubscriptionItemsItem'] /**

Updates the plan or quantity of an item on a current subscription.

*/ - post: operations["PostSubscriptionItemsItem"]; + post: operations['PostSubscriptionItemsItem'] /**

Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.

*/ - delete: operations["DeleteSubscriptionItemsItem"]; - }; - "/v1/subscription_items/{subscription_item}/usage_record_summaries": { + delete: operations['DeleteSubscriptionItemsItem'] + } + '/v1/subscription_items/{subscription_item}/usage_record_summaries': { /** *

For the specified subscription item, returns a list of summary objects. Each object in the list provides usage information that’s been summarized from multiple usage records and over a subscription billing period (e.g., 15 usage records in the billing plan’s month of September).

* *

The list is sorted in reverse-chronological order (newest first). The first list item represents the most current usage period that hasn’t ended yet. Since new usage records can still be added, the returned summary information for the subscription item’s ID should be seen as unstable until the subscription billing period ends.

*/ - get: operations["GetSubscriptionItemsSubscriptionItemUsageRecordSummaries"]; - }; - "/v1/subscription_items/{subscription_item}/usage_records": { + get: operations['GetSubscriptionItemsSubscriptionItemUsageRecordSummaries'] + } + '/v1/subscription_items/{subscription_item}/usage_records': { /** *

Creates a usage record for a specified subscription item and date, and fills it with a quantity.

* @@ -1309,39 +1309,39 @@ export interface paths { * *

The default pricing model for metered billing is per-unit pricing. For finer granularity, you can configure metered billing to have a tiered pricing model.

*/ - post: operations["PostSubscriptionItemsSubscriptionItemUsageRecords"]; - }; - "/v1/subscription_schedules": { + post: operations['PostSubscriptionItemsSubscriptionItemUsageRecords'] + } + '/v1/subscription_schedules': { /**

Retrieves the list of your subscription schedules.

*/ - get: operations["GetSubscriptionSchedules"]; + get: operations['GetSubscriptionSchedules'] /**

Creates a new subscription schedule object. Each customer can have up to 25 active or scheduled subscriptions.

*/ - post: operations["PostSubscriptionSchedules"]; - }; - "/v1/subscription_schedules/{schedule}": { + post: operations['PostSubscriptionSchedules'] + } + '/v1/subscription_schedules/{schedule}': { /**

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.

*/ - get: operations["GetSubscriptionSchedulesSchedule"]; + get: operations['GetSubscriptionSchedulesSchedule'] /**

Updates an existing subscription schedule.

*/ - post: operations["PostSubscriptionSchedulesSchedule"]; - }; - "/v1/subscription_schedules/{schedule}/cancel": { + post: operations['PostSubscriptionSchedulesSchedule'] + } + '/v1/subscription_schedules/{schedule}/cancel': { /**

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.

*/ - post: operations["PostSubscriptionSchedulesScheduleCancel"]; - }; - "/v1/subscription_schedules/{schedule}/release": { + post: operations['PostSubscriptionSchedulesScheduleCancel'] + } + '/v1/subscription_schedules/{schedule}/release': { /**

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.

*/ - post: operations["PostSubscriptionSchedulesScheduleRelease"]; - }; - "/v1/subscriptions": { + post: operations['PostSubscriptionSchedulesScheduleRelease'] + } + '/v1/subscriptions': { /**

By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.

*/ - get: operations["GetSubscriptions"]; + get: operations['GetSubscriptions'] /**

Creates a new subscription on an existing customer. Each customer can have up to 25 active or scheduled subscriptions.

*/ - post: operations["PostSubscriptions"]; - }; - "/v1/subscriptions/{subscription_exposed_id}": { + post: operations['PostSubscriptions'] + } + '/v1/subscriptions/{subscription_exposed_id}': { /**

Retrieves the subscription with the given ID.

*/ - get: operations["GetSubscriptionsSubscriptionExposedId"]; + get: operations['GetSubscriptionsSubscriptionExposedId'] /**

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.

*/ - post: operations["PostSubscriptionsSubscriptionExposedId"]; + post: operations['PostSubscriptionsSubscriptionExposedId'] /** *

Cancels a customer’s subscription immediately. The customer will not be charged again for the subscription.

* @@ -1349,92 +1349,92 @@ export interface paths { * *

By default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.

*/ - delete: operations["DeleteSubscriptionsSubscriptionExposedId"]; - }; - "/v1/subscriptions/{subscription_exposed_id}/discount": { + delete: operations['DeleteSubscriptionsSubscriptionExposedId'] + } + '/v1/subscriptions/{subscription_exposed_id}/discount': { /**

Removes the currently applied discount on a subscription.

*/ - delete: operations["DeleteSubscriptionsSubscriptionExposedIdDiscount"]; - }; - "/v1/tax_rates": { + delete: operations['DeleteSubscriptionsSubscriptionExposedIdDiscount'] + } + '/v1/tax_rates': { /**

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

*/ - get: operations["GetTaxRates"]; + get: operations['GetTaxRates'] /**

Creates a new tax rate.

*/ - post: operations["PostTaxRates"]; - }; - "/v1/tax_rates/{tax_rate}": { + post: operations['PostTaxRates'] + } + '/v1/tax_rates/{tax_rate}': { /**

Retrieves a tax rate with the given ID

*/ - get: operations["GetTaxRatesTaxRate"]; + get: operations['GetTaxRatesTaxRate'] /**

Updates an existing tax rate.

*/ - post: operations["PostTaxRatesTaxRate"]; - }; - "/v1/terminal/connection_tokens": { + post: operations['PostTaxRatesTaxRate'] + } + '/v1/terminal/connection_tokens': { /**

To connect to a reader the Stripe Terminal SDK needs to retrieve a short-lived connection token from Stripe, proxied through your server. On your backend, add an endpoint that creates and returns a connection token.

*/ - post: operations["PostTerminalConnectionTokens"]; - }; - "/v1/terminal/locations": { + post: operations['PostTerminalConnectionTokens'] + } + '/v1/terminal/locations': { /**

Returns a list of Location objects.

*/ - get: operations["GetTerminalLocations"]; + get: operations['GetTerminalLocations'] /**

Creates a new Location object.

*/ - post: operations["PostTerminalLocations"]; - }; - "/v1/terminal/locations/{location}": { + post: operations['PostTerminalLocations'] + } + '/v1/terminal/locations/{location}': { /**

Retrieves a Location object.

*/ - get: operations["GetTerminalLocationsLocation"]; + get: operations['GetTerminalLocationsLocation'] /**

Updates a Location object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ - post: operations["PostTerminalLocationsLocation"]; + post: operations['PostTerminalLocationsLocation'] /**

Deletes a Location object.

*/ - delete: operations["DeleteTerminalLocationsLocation"]; - }; - "/v1/terminal/readers": { + delete: operations['DeleteTerminalLocationsLocation'] + } + '/v1/terminal/readers': { /**

Returns a list of Reader objects.

*/ - get: operations["GetTerminalReaders"]; + get: operations['GetTerminalReaders'] /**

Creates a new Reader object.

*/ - post: operations["PostTerminalReaders"]; - }; - "/v1/terminal/readers/{reader}": { + post: operations['PostTerminalReaders'] + } + '/v1/terminal/readers/{reader}': { /**

Retrieves a Reader object.

*/ - get: operations["GetTerminalReadersReader"]; + get: operations['GetTerminalReadersReader'] /**

Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ - post: operations["PostTerminalReadersReader"]; + post: operations['PostTerminalReadersReader'] /**

Deletes a Reader object.

*/ - delete: operations["DeleteTerminalReadersReader"]; - }; - "/v1/tokens": { + delete: operations['DeleteTerminalReadersReader'] + } + '/v1/tokens': { /** *

Creates a single-use token that represents a bank account’s details. * This token can be used with any API method in place of a bank account dictionary. This token can be used only once, by attaching it to a Custom account.

*/ - post: operations["PostTokens"]; - }; - "/v1/tokens/{token}": { + post: operations['PostTokens'] + } + '/v1/tokens/{token}': { /**

Retrieves the token with the given ID.

*/ - get: operations["GetTokensToken"]; - }; - "/v1/topups": { + get: operations['GetTokensToken'] + } + '/v1/topups': { /**

Returns a list of top-ups.

*/ - get: operations["GetTopups"]; + get: operations['GetTopups'] /**

Top up the balance of an account

*/ - post: operations["PostTopups"]; - }; - "/v1/topups/{topup}": { + post: operations['PostTopups'] + } + '/v1/topups/{topup}': { /**

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.

*/ - get: operations["GetTopupsTopup"]; + get: operations['GetTopupsTopup'] /**

Updates the metadata of a top-up. Other top-up details are not editable by design.

*/ - post: operations["PostTopupsTopup"]; - }; - "/v1/topups/{topup}/cancel": { + post: operations['PostTopupsTopup'] + } + '/v1/topups/{topup}/cancel': { /**

Cancels a top-up. Only pending top-ups can be canceled.

*/ - post: operations["PostTopupsTopupCancel"]; - }; - "/v1/transfers": { + post: operations['PostTopupsTopupCancel'] + } + '/v1/transfers': { /**

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.

*/ - get: operations["GetTransfers"]; + get: operations['GetTransfers'] /**

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.

*/ - post: operations["PostTransfers"]; - }; - "/v1/transfers/{id}/reversals": { + post: operations['PostTransfers'] + } + '/v1/transfers/{id}/reversals': { /**

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.

*/ - get: operations["GetTransfersIdReversals"]; + get: operations['GetTransfersIdReversals'] /** *

When you create a new reversal, you must specify a transfer to create it on.

* @@ -1442,42 +1442,42 @@ export interface paths { * *

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.

*/ - post: operations["PostTransfersIdReversals"]; - }; - "/v1/transfers/{transfer}": { + post: operations['PostTransfersIdReversals'] + } + '/v1/transfers/{transfer}': { /**

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.

*/ - get: operations["GetTransfersTransfer"]; + get: operations['GetTransfersTransfer'] /** *

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

* *

This request accepts only metadata as an argument.

*/ - post: operations["PostTransfersTransfer"]; - }; - "/v1/transfers/{transfer}/reversals/{id}": { + post: operations['PostTransfersTransfer'] + } + '/v1/transfers/{transfer}/reversals/{id}': { /**

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.

*/ - get: operations["GetTransfersTransferReversalsId"]; + get: operations['GetTransfersTransferReversalsId'] /** *

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

* *

This request only accepts metadata and description as arguments.

*/ - post: operations["PostTransfersTransferReversalsId"]; - }; - "/v1/webhook_endpoints": { + post: operations['PostTransfersTransferReversalsId'] + } + '/v1/webhook_endpoints': { /**

Returns a list of your webhook endpoints.

*/ - get: operations["GetWebhookEndpoints"]; + get: operations['GetWebhookEndpoints'] /**

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.

*/ - post: operations["PostWebhookEndpoints"]; - }; - "/v1/webhook_endpoints/{webhook_endpoint}": { + post: operations['PostWebhookEndpoints'] + } + '/v1/webhook_endpoints/{webhook_endpoint}': { /**

Retrieves the webhook endpoint with the given ID.

*/ - get: operations["GetWebhookEndpointsWebhookEndpoint"]; + get: operations['GetWebhookEndpointsWebhookEndpoint'] /**

Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.

*/ - post: operations["PostWebhookEndpointsWebhookEndpoint"]; + post: operations['PostWebhookEndpointsWebhookEndpoint'] /**

You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.

*/ - delete: operations["DeleteWebhookEndpointsWebhookEndpoint"]; - }; + delete: operations['DeleteWebhookEndpointsWebhookEndpoint'] + } } export interface definitions { @@ -1491,173 +1491,173 @@ export interface definitions { * [create and manage Express or Custom accounts](https://stripe.com/docs/connect/accounts). */ account: { - business_profile?: definitions["account_business_profile"]; + business_profile?: definitions['account_business_profile'] /** * @description The business type. * @enum {string} */ - business_type?: "company" | "government_entity" | "individual" | "non_profit"; - capabilities?: definitions["account_capabilities"]; + business_type?: 'company' | 'government_entity' | 'individual' | 'non_profit' + capabilities?: definitions['account_capabilities'] /** @description Whether the account can create live charges. */ - charges_enabled?: boolean; - company?: definitions["legal_entity_company"]; + charges_enabled?: boolean + company?: definitions['legal_entity_company'] /** @description The account's country. */ - country?: string; + country?: string /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created?: number; + created?: number /** @description 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?: string; + default_currency?: string /** @description Whether account details have been submitted. Standard accounts cannot receive payouts before this is true. */ - details_submitted?: boolean; + details_submitted?: boolean /** @description The primary user's email address. */ - email?: string; + email?: string /** * ExternalAccountList * @description External accounts (bank accounts and debit cards) currently attached to this account */ external_accounts?: { /** @description The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards. */ - data: definitions["bank_account"][]; + data: definitions['bank_account'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** @description Unique identifier for the object. */ - id: string; - individual?: definitions["person"]; + id: string + individual?: definitions['person'] /** @description 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?: { [key: string]: unknown }; + metadata?: { [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "account"; + object: 'account' /** @description Whether Stripe can send payouts to this account. */ - payouts_enabled?: boolean; - requirements?: definitions["account_requirements"]; - settings?: definitions["account_settings"]; - tos_acceptance?: definitions["account_tos_acceptance"]; + payouts_enabled?: boolean + requirements?: definitions['account_requirements'] + settings?: definitions['account_settings'] + tos_acceptance?: definitions['account_tos_acceptance'] /** * @description The Stripe account type. Can be `standard`, `express`, or `custom`. * @enum {string} */ - type?: "custom" | "express" | "standard"; - }; + type?: 'custom' | 'express' | 'standard' + } /** AccountBrandingSettings */ account_branding_settings: { /** @description (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?: string; + icon?: string /** @description (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?: string; + logo?: string /** @description A CSS hex color value representing the primary branding color for this account */ - primary_color?: string; + primary_color?: string /** @description A CSS hex color value representing the secondary branding color for this account */ - secondary_color?: string; - }; + secondary_color?: string + } /** AccountBusinessProfile */ account_business_profile: { /** @description [The merchant category code for the account](https://stripe.com/docs/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide. */ - mcc?: string; + mcc?: string /** @description The customer-facing business name. */ - name?: string; + name?: string /** @description 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?: string; - support_address?: definitions["address"]; + product_description?: string + support_address?: definitions['address'] /** @description A publicly available email address for sending support issues to. */ - support_email?: string; + support_email?: string /** @description A publicly available phone number to call with support issues. */ - support_phone?: string; + support_phone?: string /** @description A publicly available website for handling support issues. */ - support_url?: string; + support_url?: string /** @description The business's publicly available website. */ - url?: string; - }; + url?: string + } /** AccountCapabilities */ account_capabilities: { /** * @description 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. * @enum {string} */ - au_becs_debit_payments?: "active" | "inactive" | "pending"; + au_becs_debit_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the card issuing capability of the account, or whether you can use Issuing to distribute funds on cards * @enum {string} */ - card_issuing?: "active" | "inactive" | "pending"; + card_issuing?: 'active' | 'inactive' | 'pending' /** * @description The status of the card payments capability of the account, or whether the account can directly process credit and debit card charges. * @enum {string} */ - card_payments?: "active" | "inactive" | "pending"; + card_payments?: 'active' | 'inactive' | 'pending' /** * @description 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. * @enum {string} */ - jcb_payments?: "active" | "inactive" | "pending"; + jcb_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the legacy payments capability of the account. * @enum {string} */ - legacy_payments?: "active" | "inactive" | "pending"; + legacy_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the tax reporting 1099-K (US) capability of the account. * @enum {string} */ - tax_reporting_us_1099_k?: "active" | "inactive" | "pending"; + tax_reporting_us_1099_k?: 'active' | 'inactive' | 'pending' /** * @description The status of the tax reporting 1099-MISC (US) capability of the account. * @enum {string} */ - tax_reporting_us_1099_misc?: "active" | "inactive" | "pending"; + tax_reporting_us_1099_misc?: 'active' | 'inactive' | 'pending' /** * @description The status of the transfers capability of the account, or whether your platform can transfer funds to the account. * @enum {string} */ - transfers?: "active" | "inactive" | "pending"; - }; + transfers?: 'active' | 'inactive' | 'pending' + } /** AccountCapabilityRequirements */ account_capability_requirements: { /** @description The date the fields in `currently_due` must be collected by to keep the capability enabled for the account. */ - current_deadline?: number; + current_deadline?: number /** @description The fields that need to be collected to keep the capability enabled. If not collected by the `current_deadline`, these fields appear in `past_due` as well, and the capability is disabled. */ - currently_due: string[]; + currently_due: string[] /** @description If the capability is disabled, this string describes why. Possible values are `requirement.fields_needed`, `pending.onboarding`, `pending.review`, `rejected_fraud`, or `rejected.other`. */ - disabled_reason?: string; + disabled_reason?: string /** @description The fields that need to be collected again because validation or verification failed for some reason. */ - errors: definitions["account_requirements_error"][]; + errors: definitions['account_requirements_error'][] /** @description The fields that need to be collected assuming all volume thresholds are reached. As they become required, these fields appear in `currently_due` as well, and the `current_deadline` is set. */ - eventually_due: string[]; + eventually_due: string[] /** @description The fields that weren't collected by the `current_deadline`. These fields need to be collected to enable the capability for the account. */ - past_due: string[]; + past_due: string[] /** @description Fields that may become required depending on the results of verification or review. An empty array unless an asynchronous verification is pending. If verification fails, the fields in this array become required and move to `currently_due` or `past_due`. */ - pending_verification: string[]; - }; + pending_verification: string[] + } /** AccountCardPaymentsSettings */ account_card_payments_settings: { - decline_on?: definitions["account_decline_charge_on"]; + decline_on?: definitions['account_decline_charge_on'] /** @description 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?: string; - }; + statement_descriptor_prefix?: string + } /** AccountDashboardSettings */ account_dashboard_settings: { /** @description The display name for this account. This is used on the Stripe Dashboard to differentiate between accounts. */ - display_name?: string; + display_name?: string /** @description 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?: string; - }; + timezone?: string + } /** AccountDeclineChargeOn */ account_decline_charge_on: { /** @description 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: boolean; + avs_failure: boolean /** @description 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: boolean; - }; + cvc_failure: boolean + } /** * AccountLink * @description Account Links are the means by which a Connect platform grants a connected account permission to access @@ -1667,51 +1667,51 @@ export interface definitions { */ account_link: { /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The timestamp at which this account link will expire. */ - expires_at: number; + expires_at: number /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "account_link"; + object: 'account_link' /** @description The URL for the account link. */ - url: string; - }; + url: string + } /** AccountPaymentsSettings */ account_payments_settings: { /** @description 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?: string; + statement_descriptor?: string /** @description The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only) */ - statement_descriptor_kana?: string; + statement_descriptor_kana?: string /** @description The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only) */ - statement_descriptor_kanji?: string; - }; + statement_descriptor_kanji?: string + } /** AccountPayoutSettings */ account_payout_settings: { /** @description A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See our [Understanding Connect Account Balances](https://stripe.com/docs/connect/account-balances) documentation for details. Default value is `true` for Express accounts and `false` for Custom accounts. */ - debit_negative_balances: boolean; - schedule: definitions["transfer_schedule"]; + debit_negative_balances: boolean + schedule: definitions['transfer_schedule'] /** @description 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?: string; - }; + statement_descriptor?: string + } /** AccountRequirements */ account_requirements: { /** @description The date the fields in `currently_due` must be collected by to keep payouts enabled for the account. These fields might block payouts sooner if the next threshold is reached before these fields are collected. */ - current_deadline?: number; + current_deadline?: number /** @description The fields that need to be collected to keep the account enabled. If not collected by the `current_deadline`, these fields appear in `past_due` as well, and the account is disabled. */ - currently_due?: string[]; + currently_due?: string[] /** @description If the account is disabled, this string describes why the account can’t create charges or receive payouts. Can be `requirements.past_due`, `requirements.pending_verification`, `rejected.fraud`, `rejected.terms_of_service`, `rejected.listed`, `rejected.other`, `listed`, `under_review`, or `other`. */ - disabled_reason?: string; + disabled_reason?: string /** @description The fields that need to be collected again because validation or verification failed for some reason. */ - errors?: definitions["account_requirements_error"][]; + errors?: definitions['account_requirements_error'][] /** @description The fields that need to be collected assuming all volume thresholds are reached. As they become required, these fields appear in `currently_due` as well, and the `current_deadline` is set. */ - eventually_due?: string[]; + eventually_due?: string[] /** @description The fields that weren't collected by the `current_deadline`. These fields need to be collected to re-enable the account. */ - past_due?: string[]; + past_due?: string[] /** @description Fields that may become required depending on the results of verification or review. An empty array unless an asynchronous verification is pending. If verification fails, the fields in this array become required and move to `currently_due` or `past_due`. */ - pending_verification?: string[]; - }; + pending_verification?: string[] + } /** AccountRequirementsError */ account_requirements_error: { /** @@ -1719,218 +1719,218 @@ export interface definitions { * @enum {string} */ code: - | "invalid_address_city_state_postal_code" - | "invalid_street_address" - | "invalid_value_other" - | "verification_document_address_mismatch" - | "verification_document_address_missing" - | "verification_document_corrupt" - | "verification_document_country_not_supported" - | "verification_document_dob_mismatch" - | "verification_document_duplicate_type" - | "verification_document_expired" - | "verification_document_failed_copy" - | "verification_document_failed_greyscale" - | "verification_document_failed_other" - | "verification_document_failed_test_mode" - | "verification_document_fraudulent" - | "verification_document_id_number_mismatch" - | "verification_document_id_number_missing" - | "verification_document_incomplete" - | "verification_document_invalid" - | "verification_document_manipulated" - | "verification_document_missing_back" - | "verification_document_missing_front" - | "verification_document_name_mismatch" - | "verification_document_name_missing" - | "verification_document_nationality_mismatch" - | "verification_document_not_readable" - | "verification_document_not_uploaded" - | "verification_document_photo_mismatch" - | "verification_document_too_large" - | "verification_document_type_not_supported" - | "verification_failed_address_match" - | "verification_failed_business_iec_number" - | "verification_failed_document_match" - | "verification_failed_id_number_match" - | "verification_failed_keyed_identity" - | "verification_failed_keyed_match" - | "verification_failed_name_match" - | "verification_failed_other"; + | 'invalid_address_city_state_postal_code' + | 'invalid_street_address' + | 'invalid_value_other' + | 'verification_document_address_mismatch' + | 'verification_document_address_missing' + | 'verification_document_corrupt' + | 'verification_document_country_not_supported' + | 'verification_document_dob_mismatch' + | 'verification_document_duplicate_type' + | 'verification_document_expired' + | 'verification_document_failed_copy' + | 'verification_document_failed_greyscale' + | 'verification_document_failed_other' + | 'verification_document_failed_test_mode' + | 'verification_document_fraudulent' + | 'verification_document_id_number_mismatch' + | 'verification_document_id_number_missing' + | 'verification_document_incomplete' + | 'verification_document_invalid' + | 'verification_document_manipulated' + | 'verification_document_missing_back' + | 'verification_document_missing_front' + | 'verification_document_name_mismatch' + | 'verification_document_name_missing' + | 'verification_document_nationality_mismatch' + | 'verification_document_not_readable' + | 'verification_document_not_uploaded' + | 'verification_document_photo_mismatch' + | 'verification_document_too_large' + | 'verification_document_type_not_supported' + | 'verification_failed_address_match' + | 'verification_failed_business_iec_number' + | 'verification_failed_document_match' + | 'verification_failed_id_number_match' + | 'verification_failed_keyed_identity' + | 'verification_failed_keyed_match' + | 'verification_failed_name_match' + | 'verification_failed_other' /** @description An informative message that indicates the error type and provides additional details about the error. */ - reason: string; + reason: string /** @description The specific user onboarding requirement field (in the requirements hash) that needs to be resolved. */ - requirement: string; - }; + requirement: string + } /** AccountSettings */ account_settings: { - branding: definitions["account_branding_settings"]; - card_payments: definitions["account_card_payments_settings"]; - dashboard: definitions["account_dashboard_settings"]; - payments: definitions["account_payments_settings"]; - payouts?: definitions["account_payout_settings"]; - }; + branding: definitions['account_branding_settings'] + card_payments: definitions['account_card_payments_settings'] + dashboard: definitions['account_dashboard_settings'] + payments: definitions['account_payments_settings'] + payouts?: definitions['account_payout_settings'] + } /** AccountTOSAcceptance */ account_tos_acceptance: { /** @description The Unix timestamp marking when the Stripe Services Agreement was accepted by the account representative */ - date?: number; + date?: number /** @description The IP address from which the Stripe Services Agreement was accepted by the account representative */ - ip?: string; + ip?: string /** @description The user agent of the browser from which the Stripe Services Agreement was accepted by the account representative */ - user_agent?: string; - }; + user_agent?: string + } /** Address */ address: { /** @description City, district, suburb, town, or village. */ - city?: string; + city?: string /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ - country?: string; + country?: string /** @description Address line 1 (e.g., street, PO Box, or company name). */ - line1?: string; + line1?: string /** @description Address line 2 (e.g., apartment, suite, unit, or building). */ - line2?: string; + line2?: string /** @description ZIP or postal code. */ - postal_code?: string; + postal_code?: string /** @description State, county, province, or region. */ - state?: string; - }; + state?: string + } /** AlipayAccount */ alipay_account: { /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The ID of the customer associated with this Alipay Account. */ - customer?: string; + customer?: string /** @description Uniquely identifies the account and will be the same across all Alipay account objects that are linked to the same Alipay account. */ - fingerprint: string; + fingerprint: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: unknown }; + metadata?: { [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "alipay_account"; + object: 'alipay_account' /** @description If the Alipay account object is not reusable, the exact amount that you can create a charge for. */ - payment_amount?: number; + payment_amount?: number /** @description If the Alipay account object is not reusable, the exact currency that you can create a charge for. */ - payment_currency?: string; + payment_currency?: string /** @description True if you can create multiple payments using this account. If the account is reusable, then you can freely choose the amount of each payment. */ - reusable: boolean; + reusable: boolean /** @description Whether this Alipay account object has ever been used for a payment. */ - used: boolean; + used: boolean /** @description The username for the Alipay account. */ - username: string; - }; + username: string + } /** APIErrors */ api_errors: { /** @description For card errors, the ID of the failed charge. */ - charge?: string; + charge?: string /** @description For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported. */ - code?: string; + code?: string /** @description 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?: string; + decline_code?: string /** @description A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported. */ - doc_url?: string; + doc_url?: string /** @description A human-readable message providing more details about the error. For card errors, these messages can be shown to your users. */ - message?: string; + message?: string /** @description 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?: string; - payment_intent?: definitions["payment_intent"]; - payment_method?: definitions["payment_method"]; - setup_intent?: definitions["setup_intent"]; - source?: definitions["bank_account"]; + param?: string + payment_intent?: definitions['payment_intent'] + payment_method?: definitions['payment_method'] + setup_intent?: definitions['setup_intent'] + source?: definitions['bank_account'] /** * @description The type of error returned. One of `api_connection_error`, `api_error`, `authentication_error`, `card_error`, `idempotency_error`, `invalid_request_error`, or `rate_limit_error` * @enum {string} */ type: - | "api_connection_error" - | "api_error" - | "authentication_error" - | "card_error" - | "idempotency_error" - | "invalid_request_error" - | "rate_limit_error"; - }; + | 'api_connection_error' + | 'api_error' + | 'authentication_error' + | 'card_error' + | 'idempotency_error' + | 'invalid_request_error' + | 'rate_limit_error' + } /** ApplePayDomain */ apple_pay_domain: { /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; - domain_name: string; + created: number + domain_name: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "apple_pay_domain"; - }; + object: 'apple_pay_domain' + } /** Application */ application: { /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The name of the application. */ - name?: string; + name?: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "application"; - }; + object: 'application' + } /** PlatformFee */ application_fee: { /** @description ID of the Stripe account this fee was taken from. */ - account: string; + account: string /** @description Amount earned, in %s. */ - amount: number; + amount: number /** @description Amount in %s refunded (can be less than the amount attribute on the fee if a partial refund was issued) */ - amount_refunded: number; + amount_refunded: number /** @description ID of the Connect application that earned the fee. */ - application: string; + application: string /** @description Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds). */ - balance_transaction?: string; + balance_transaction?: string /** @description ID of the charge that the application fee was taken from. */ - charge: string; + charge: string /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "application_fee"; + object: 'application_fee' /** @description ID of the corresponding charge on the platform account, if this fee was the result of a charge using the `destination` parameter. */ - originating_transaction?: string; + originating_transaction?: string /** @description Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false. */ - refunded: boolean; + refunded: boolean /** * FeeRefundList * @description A list of refunds that have been applied to the fee. */ refunds: { /** @description Details about each object. */ - data: definitions["fee_refund"][]; + data: definitions['fee_refund'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** * Balance * @description This is an object representing your Stripe balance. You can retrieve it to see @@ -1947,36 +1947,36 @@ export interface definitions { */ balance: { /** @description Funds that are available to be transferred or paid out, whether automatically by Stripe or explicitly via the [Transfers API](https://stripe.com/docs/api#transfers) or [Payouts API](https://stripe.com/docs/api#payouts). The available balance for each currency and payment type can be found in the `source_types` property. */ - available: definitions["balance_amount"][]; + available: definitions['balance_amount'][] /** @description Funds held due to negative balances on connected Custom accounts. The connect reserve balance for each currency and payment type can be found in the `source_types` property. */ - connect_reserved?: definitions["balance_amount"][]; + connect_reserved?: definitions['balance_amount'][] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "balance"; + object: 'balance' /** @description Funds that are not yet available in the balance, due to the 7-day rolling pay cycle. The pending balance for each currency, and for each payment type, can be found in the `source_types` property. */ - pending: definitions["balance_amount"][]; - }; + pending: definitions['balance_amount'][] + } /** BalanceAmount */ balance_amount: { /** @description Balance amount. */ - amount: number; + amount: number /** @description 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: string; - source_types?: definitions["balance_amount_by_source_type"]; - }; + currency: string + source_types?: definitions['balance_amount_by_source_type'] + } /** BalanceAmountBySourceType */ balance_amount_by_source_type: { /** @description Amount for bank account. */ - bank_account?: number; + bank_account?: number /** @description Amount for card. */ - card?: number; + card?: number /** @description Amount for FPX. */ - fpx?: number; - }; + fpx?: number + } /** * BalanceTransaction * @description Balance transactions represent funds moving through your Stripe account. @@ -1986,71 +1986,71 @@ export interface definitions { */ balance_transaction: { /** @description Gross amount of the transaction, in %s. */ - amount: number; + amount: number /** @description The date the transaction's net funds will become available in the Stripe balance. */ - available_on: number; + available_on: number /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description The exchange rate used, if applicable, for this transaction. Specifically, if money was converted from currency A to currency B, then the `amount` in currency A, times `exchange_rate`, would be the `amount` in currency B. For example, suppose you charged a customer 10.00 EUR. Then the PaymentIntent's `amount` would be `1000` and `currency` would be `eur`. Suppose this was converted into 12.34 USD in your Stripe account. Then the BalanceTransaction's `amount` would be `1234`, `currency` would be `usd`, and `exchange_rate` would be `1.234`. */ - exchange_rate?: number; + exchange_rate?: number /** @description Fees (in %s) paid for this transaction. */ - fee: number; + fee: number /** @description Detailed breakdown of fees (in %s) paid for this transaction. */ - fee_details: definitions["fee"][]; + fee_details: definitions['fee'][] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Net amount of the transaction, in %s. */ - net: number; + net: number /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "balance_transaction"; + object: 'balance_transaction' /** @description [Learn more](https://stripe.com/docs/reports/reporting-categories) about how reporting categories can help you understand balance transactions from an accounting perspective. */ - reporting_category: string; + reporting_category: string /** @description The Stripe object to which this transaction is related. */ - source?: string; + source?: string /** @description If the transaction's net funds are available in the Stripe balance yet. Either `available` or `pending`. */ - status: string; + status: string /** * @description Transaction type: `adjustment`, `advance`, `advance_funding`, `application_fee`, `application_fee_refund`, `charge`, `connect_collection_transfer`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_transaction`, `payment`, `payment_failure_refund`, `payment_refund`, `payout`, `payout_cancel`, `payout_failure`, `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](https://stripe.com/docs/reports/balance-transaction-types) about balance transaction types and what they represent. If you are looking to classify transactions for accounting purposes, you might want to consider `reporting_category` instead. * @enum {string} */ type: - | "adjustment" - | "advance" - | "advance_funding" - | "application_fee" - | "application_fee_refund" - | "charge" - | "connect_collection_transfer" - | "issuing_authorization_hold" - | "issuing_authorization_release" - | "issuing_transaction" - | "payment" - | "payment_failure_refund" - | "payment_refund" - | "payout" - | "payout_cancel" - | "payout_failure" - | "refund" - | "refund_failure" - | "reserve_transaction" - | "reserved_funds" - | "stripe_fee" - | "stripe_fx_fee" - | "tax_fee" - | "topup" - | "topup_reversal" - | "transfer" - | "transfer_cancel" - | "transfer_failure" - | "transfer_refund"; - }; + | 'adjustment' + | 'advance' + | 'advance_funding' + | 'application_fee' + | 'application_fee_refund' + | 'charge' + | 'connect_collection_transfer' + | 'issuing_authorization_hold' + | 'issuing_authorization_release' + | 'issuing_transaction' + | 'payment' + | 'payment_failure_refund' + | 'payment_refund' + | 'payout' + | 'payout_cancel' + | 'payout_failure' + | 'refund' + | 'refund_failure' + | 'reserve_transaction' + | 'reserved_funds' + | 'stripe_fee' + | 'stripe_fx_fee' + | 'tax_fee' + | 'topup' + | 'topup_reversal' + | 'transfer' + | 'transfer_cancel' + | 'transfer_failure' + | 'transfer_refund' + } /** * BankAccount * @description These bank accounts are payment methods on `Customer` objects. @@ -2063,53 +2063,53 @@ export interface definitions { */ bank_account: { /** @description The ID of the account that the bank account is associated with. */ - account?: string; + account?: string /** @description The name of the person or business that owns the bank account. */ - account_holder_name?: string; + account_holder_name?: string /** @description The type of entity that holds the account. This can be either `individual` or `company`. */ - account_holder_type?: string; + account_holder_type?: string /** @description Name of the bank associated with the routing number (e.g., `WELLS FARGO`). */ - bank_name?: string; + bank_name?: string /** @description Two-letter ISO code representing the country the bank account is located in. */ - country: string; + country: string /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. */ - currency: string; + currency: string /** @description The ID of the customer that the bank account is associated with. */ - customer?: string; + customer?: string /** @description Whether this bank account is the default external account for its currency. */ - default_for_currency?: boolean; + default_for_currency?: boolean /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string; + fingerprint?: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The last four digits of the bank account number. */ - last4: string; + last4: string /** @description 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?: { [key: string]: unknown }; + metadata?: { [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "bank_account"; + object: 'bank_account' /** @description The routing transit number for the bank account. */ - routing_number?: string; + routing_number?: string /** * @description For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a transfer sent to this bank account fails, we'll set the status to `errored` and will not continue to send transfers until the bank details are updated. * * For external accounts, possible values are `new` and `errored`. Validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply. If a transfer fails, the status is set to `errored` and transfers are stopped until account details are updated. */ - status: string; - }; + status: string + } /** billing_details */ billing_details: { - address?: definitions["address"]; + address?: definitions['address'] /** @description Email address. */ - email?: string; + email?: string /** @description Full name. */ - name?: string; + name?: string /** @description Billing phone number (including extension). */ - phone?: string; - }; + phone?: string + } /** * PortalSession * @description A Session describes the instantiation of the self-serve portal for @@ -2120,110 +2120,110 @@ export interface definitions { * * Related guide: [self-serve Portal](https://stripe.com/docs/billing/subscriptions/integrating-self-serve). */ - "billing_portal.session": { + 'billing_portal.session': { /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The ID of the customer for this session. */ - customer: string; + customer: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "billing_portal.session"; + object: 'billing_portal.session' /** @description The URL to which Stripe should send customers when they click on the link to return to your website. */ - return_url: string; + return_url: string /** @description The short-lived URL of the session giving customers access to the self-serve portal. */ - url: string; - }; + url: string + } /** BitcoinReceiver */ bitcoin_receiver: { /** @description True when this bitcoin receiver has received a non-zero amount of bitcoin. */ - active: boolean; + active: boolean /** @description The amount of `currency` that you are collecting as payment. */ - amount: number; + amount: number /** @description The amount of `currency` to which `bitcoin_amount_received` has been converted. */ - amount_received: number; + amount_received: number /** @description The amount of bitcoin that the customer should send to fill the receiver. The `bitcoin_amount` is denominated in Satoshi: there are 10^8 Satoshi in one bitcoin. */ - bitcoin_amount: number; + bitcoin_amount: number /** @description The amount of bitcoin that has been sent by the customer to this receiver. */ - bitcoin_amount_received: number; + bitcoin_amount_received: number /** @description This URI can be displayed to the customer as a clickable link (to activate their bitcoin client) or as a QR code (for mobile wallets). */ - bitcoin_uri: string; + bitcoin_uri: string /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) to which the bitcoin will be converted. */ - currency: string; + currency: string /** @description The customer ID of the bitcoin receiver. */ - customer?: string; + customer?: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description The customer's email address, set by the API call that creates the receiver. */ - email?: string; + email?: string /** @description This flag is initially false and updates to true when the customer sends the `bitcoin_amount` to this receiver. */ - filled: boolean; + filled: boolean /** @description Unique identifier for the object. */ - id: string; + id: string /** @description A bitcoin address that is specific to this receiver. The customer can send bitcoin to this address to fill the receiver. */ - inbound_address: string; + inbound_address: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: unknown }; + metadata: { [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "bitcoin_receiver"; + object: 'bitcoin_receiver' /** @description The ID of the payment created from the receiver, if any. Hidden when viewing the receiver with a publishable key. */ - payment?: string; + payment?: string /** @description The refund address of this bitcoin receiver. */ - refund_address?: string; + refund_address?: string /** * BitcoinTransactionList * @description A list with one entry for each time that the customer sent bitcoin to the receiver. Hidden when viewing the receiver with a publishable key. */ transactions?: { /** @description Details about each object. */ - data: definitions["bitcoin_transaction"][]; + data: definitions['bitcoin_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** @description This receiver contains uncaptured funds that can be used for a payment or refunded. */ - uncaptured_funds: boolean; + uncaptured_funds: boolean /** @description Indicate if this source is used for payment. */ - used_for_payment?: boolean; - }; + used_for_payment?: boolean + } /** BitcoinTransaction */ bitcoin_transaction: { /** @description The amount of `currency` that the transaction was converted to in real-time. */ - amount: number; + amount: number /** @description The amount of bitcoin contained in the transaction. */ - bitcoin_amount: number; + bitcoin_amount: number /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) to which this transaction was converted. */ - currency: string; + currency: string /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "bitcoin_transaction"; + object: 'bitcoin_transaction' /** @description The receiver to which this transaction was sent. */ - receiver: string; - }; + receiver: string + } /** * AccountCapability * @description This is an object representing a capability for a Stripe account. @@ -2232,25 +2232,25 @@ export interface definitions { */ capability: { /** @description The account for which the capability enables functionality. */ - account: string; + account: string /** @description The identifier for the capability. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "capability"; + object: 'capability' /** @description Whether the capability has been requested. */ - requested: boolean; + requested: boolean /** @description Time at which the capability was requested. Measured in seconds since the Unix epoch. */ - requested_at?: number; - requirements?: definitions["account_capability_requirements"]; + requested_at?: number + requirements?: definitions['account_capability_requirements'] /** * @description The status of the capability. Can be `active`, `inactive`, `pending`, or `unrequested`. * @enum {string} */ - status: "active" | "disabled" | "inactive" | "pending" | "unrequested"; - }; + status: 'active' | 'disabled' | 'inactive' | 'pending' | 'unrequested' + } /** * Card * @description You can store multiple cards on a customer in order to charge the customer @@ -2261,66 +2261,66 @@ export interface definitions { */ card: { /** @description 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. */ - account?: string; + account?: string /** @description City/District/Suburb/Town/Village. */ - address_city?: string; + address_city?: string /** @description Billing address country, if provided when creating card. */ - address_country?: string; + address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - address_line1?: string; + address_line1?: string /** @description If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. */ - address_line1_check?: string; + address_line1_check?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - address_line2?: string; + address_line2?: string /** @description State/County/Province/Region. */ - address_state?: string; + address_state?: string /** @description ZIP or postal code. */ - address_zip?: string; + address_zip?: string /** @description If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. */ - address_zip_check?: string; + address_zip_check?: string /** @description A set of available payout methods for this card. Will be either `["standard"]` or `["standard", "instant"]`. Only values from this set should be passed as the `method` when creating a transfer. */ - available_payout_methods?: ("instant" | "standard")[]; + available_payout_methods?: ('instant' | 'standard')[] /** @description Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`. */ - brand: string; + brand: string /** @description 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?: string; - currency?: string; + country?: string + currency?: string /** @description 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?: string; + customer?: string /** @description If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. */ - cvc_check?: string; + cvc_check?: string /** @description Whether this card is the default external account for its currency. */ - default_for_currency?: boolean; + default_for_currency?: boolean /** @description (For tokenized numbers only.) The last four digits of the device account number. */ - dynamic_last4?: string; + dynamic_last4?: string /** @description Two-digit number representing the card's expiration month. */ - exp_month: number; + exp_month: number /** @description Four-digit number representing the card's expiration year. */ - exp_year: number; + exp_year: number /** @description 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. */ - fingerprint?: string; + fingerprint?: string /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ - funding: string; + funding: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The last four digits of the card. */ - last4: string; + last4: string /** @description 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: { [key: string]: unknown }; + metadata: { [key: string]: unknown } /** @description Cardholder name. */ - name?: string; + name?: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "card"; + object: 'card' /** @description The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead. */ - recipient?: string; + recipient?: string /** @description If the card number is tokenized, this is the method that was used. Can be `amex_express_checkout`, `android_pay` (includes Google Pay), `apple_pay`, `masterpass`, `visa_checkout`, or null. */ - tokenization_method?: string; - }; + tokenization_method?: string + } /** card_mandate_payment_method_details */ - card_mandate_payment_method_details: { [key: string]: unknown }; + card_mandate_payment_method_details: { [key: string]: unknown } /** * Charge * @description To charge a credit or a debit card, you create a `Charge` object. You can @@ -2331,135 +2331,135 @@ export interface definitions { */ charge: { /** @description 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: number; + amount: number /** @description Amount in %s refunded (can be less than the amount attribute on the charge if a partial refund was issued). */ - amount_refunded: number; + amount_refunded: number /** @description ID of the Connect application that created the charge. */ - application?: string; + application?: string /** @description The application fee (if any) for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees) for details. */ - application_fee?: string; + application_fee?: string /** @description The amount of the application fee (if any) for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees) for details. */ - application_fee_amount?: number; + application_fee_amount?: number /** @description ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes). */ - balance_transaction?: string; - billing_details: definitions["billing_details"]; + balance_transaction?: string + billing_details: definitions['billing_details'] /** @description 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. */ - calculated_statement_descriptor?: string; + calculated_statement_descriptor?: string /** @description If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured. */ - captured: boolean; + captured: boolean /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description ID of the customer this charge is for if one exists. */ - customer?: string; + customer?: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Whether the charge has been disputed. */ - disputed: boolean; + disputed: boolean /** @description Error code explaining reason for charge failure if available (see [the errors section](https://stripe.com/docs/api#errors) for a list of codes). */ - failure_code?: string; + failure_code?: string /** @description Message to user further explaining reason for charge failure if available. */ - failure_message?: string; - fraud_details?: definitions["charge_fraud_details"]; + failure_message?: string + fraud_details?: definitions['charge_fraud_details'] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description ID of the invoice this charge is for if one exists. */ - invoice?: string; + invoice?: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: unknown }; + metadata: { [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "charge"; + object: 'charge' /** @description 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/charges-transfers) for details. */ - on_behalf_of?: string; + on_behalf_of?: string /** @description ID of the order this charge is for if one exists. */ - order?: string; - outcome?: definitions["charge_outcome"]; + order?: string + outcome?: definitions['charge_outcome'] /** @description `true` if the charge succeeded, or was successfully authorized for later capture. */ - paid: boolean; + paid: boolean /** @description ID of the PaymentIntent associated with this charge, if one exists. */ - payment_intent?: string; + payment_intent?: string /** @description ID of the payment method used in this charge. */ - payment_method?: string; - payment_method_details?: definitions["payment_method_details"]; + payment_method?: string + payment_method_details?: definitions['payment_method_details'] /** @description This is the email address that the receipt for this charge was sent to. */ - receipt_email?: string; + receipt_email?: string /** @description 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?: string; + receipt_number?: string /** @description 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?: string; + receipt_url?: string /** @description Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false. */ - refunded: boolean; + refunded: boolean /** * RefundList * @description A list of refunds that have been applied to the charge. */ refunds: { /** @description Details about each object. */ - data: definitions["refund"][]; + data: definitions['refund'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** @description ID of the review associated with this charge if one exists. */ - review?: string; - shipping?: definitions["shipping"]; + review?: string + shipping?: definitions['shipping'] /** @description The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details. */ - source_transfer?: string; + source_transfer?: string /** @description For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - statement_descriptor_suffix?: string; + statement_descriptor_suffix?: string /** @description The status of the payment is either `succeeded`, `pending`, or `failed`. */ - status: string; + status: string /** @description ID of the transfer to the `destination` account (only applicable if the charge was created using the `destination` parameter). */ - transfer?: string; - transfer_data?: definitions["charge_transfer_data"]; + transfer?: string + transfer_data?: definitions['charge_transfer_data'] /** @description A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-options) for details. */ - transfer_group?: string; - }; + transfer_group?: string + } /** ChargeFraudDetails */ charge_fraud_details: { /** @description Assessments from Stripe. If set, the value is `fraudulent`. */ - stripe_report?: string; + stripe_report?: string /** @description Assessments reported by you. If set, possible values of are `safe` and `fraudulent`. */ - user_report?: string; - }; + user_report?: string + } /** ChargeOutcome */ charge_outcome: { /** @description 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?: string; + network_status?: string /** @description 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?: string; + reason?: string /** @description Stripe'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`. */ - risk_level?: string; + risk_level?: string /** @description Stripe'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?: number; + risk_score?: number /** @description The ID of the Radar rule that matched the payment, if applicable. */ - rule?: string; + rule?: string /** @description A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer. */ - seller_message?: string; + seller_message?: string /** @description 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: string; - }; + type: string + } /** ChargeTransferData */ charge_transfer_data: { /** @description The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account. */ - amount?: number; + amount?: number /** @description ID of an existing, connected Stripe account to transfer funds to if `transfer_data` was specified in the charge request. */ - destination: string; - }; + destination: string + } /** * Session * @description A Checkout Session represents your customer's session as they pay for @@ -2476,20 +2476,20 @@ export interface definitions { * * Related guide: [Checkout Server Quickstart](https://stripe.com/docs/payments/checkout/api). */ - "checkout.session": { + 'checkout.session': { /** * @description The value (`auto` or `required`) for whether Checkout collected the * customer's billing address. */ - billing_address_collection?: string; + billing_address_collection?: string /** @description The URL the customer will be directed to if they decide to cancel payment and return to your website. */ - cancel_url: string; + cancel_url: string /** * @description A unique string to reference the Checkout Session. This can be a * customer ID, a cart ID, or similar, and can be used to reconcile the * session with your internal systems. */ - client_reference_id?: string; + client_reference_id?: string /** * @description The ID of the customer for this session. * For Checkout Sessions in `payment` or `subscription` mode, Checkout @@ -2497,7 +2497,7 @@ export interface definitions { * during the session unless an existing customer was provided when * the session was created. */ - customer?: string; + customer?: string /** * @description 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. @@ -2505,61 +2505,44 @@ export interface definitions { * on file. To access information about the customer once a session is * complete, use the `customer` field. */ - customer_email?: string; + customer_email?: string /** @description The line items, plans, or SKUs purchased by the customer. */ - display_items?: definitions["checkout_session_display_item"][]; + display_items?: definitions['checkout_session_display_item'][] /** * @description Unique identifier for the object. Used to pass to `redirectToCheckout` * in Stripe.js. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used. * @enum {string} */ - locale?: - | "auto" - | "da" - | "de" - | "en" - | "es" - | "fi" - | "fr" - | "it" - | "ja" - | "ms" - | "nb" - | "nl" - | "pl" - | "pt" - | "pt-BR" - | "sv" - | "zh"; + locale?: 'auto' | 'da' | 'de' | 'en' | 'es' | 'fi' | 'fr' | 'it' | 'ja' | 'ms' | 'nb' | 'nl' | 'pl' | 'pt' | 'pt-BR' | 'sv' | 'zh' /** @description 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?: { [key: string]: unknown }; + metadata?: { [key: string]: unknown } /** * @description The mode of the Checkout Session, one of `payment`, `setup`, or `subscription`. * @enum {string} */ - mode?: "payment" | "setup" | "subscription"; + mode?: 'payment' | 'setup' | 'subscription' /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "checkout.session"; + object: 'checkout.session' /** @description The ID of the PaymentIntent for Checkout Sessions in `payment` mode. */ - payment_intent?: string; + payment_intent?: string /** * @description A list of the types of payment methods (e.g. card) this Checkout * Session is allowed to accept. */ - payment_method_types: string[]; + payment_method_types: string[] /** @description The ID of the SetupIntent for Checkout Sessions in `setup` mode. */ - setup_intent?: string; - shipping?: definitions["shipping"]; - shipping_address_collection?: definitions["payment_pages_payment_page_resources_shipping_address_collection"]; + setup_intent?: string + shipping?: definitions['shipping'] + shipping_address_collection?: definitions['payment_pages_payment_page_resources_shipping_address_collection'] /** * @description Describes the type of transaction being performed by Checkout in order to customize * relevant text on the page, such as the submit button. `submit_type` can only be @@ -2567,56 +2550,56 @@ export interface definitions { * in `subscription` or `setup` mode. * @enum {string} */ - submit_type?: "auto" | "book" | "donate" | "pay"; + submit_type?: 'auto' | 'book' | 'donate' | 'pay' /** @description The ID of the subscription for Checkout Sessions in `subscription` mode. */ - subscription?: string; + subscription?: string /** * @description The URL the customer will be directed to after the payment or * subscription creation is successful. */ - success_url: string; - }; + success_url: string + } /** checkout_session_custom_display_item_description */ checkout_session_custom_display_item_description: { /** @description The description of the line item. */ - description?: string; + description?: string /** @description The images of the line item. */ - images?: string[]; + images?: string[] /** @description The name of the line item. */ - name: string; - }; + name: string + } /** checkout_session_display_item */ checkout_session_display_item: { /** @description Amount for the display item. */ - amount?: number; + amount?: number /** @description 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?: string; - custom?: definitions["checkout_session_custom_display_item_description"]; - plan?: definitions["plan"]; + currency?: string + custom?: definitions['checkout_session_custom_display_item_description'] + plan?: definitions['plan'] /** @description Quantity of the display item being purchased. */ - quantity?: number; - sku?: definitions["sku"]; + quantity?: number + sku?: definitions['sku'] /** @description The type of display item. One of `custom`, `plan` or `sku` */ - type?: string; - }; + type?: string + } /** ConnectCollectionTransfer */ connect_collection_transfer: { /** @description Amount transferred, in %s. */ - amount: number; + amount: number /** @description 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: string; + currency: string /** @description ID of the account that funds are being collected for. */ - destination: string; + destination: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "connect_collection_transfer"; - }; + object: 'connect_collection_transfer' + } /** * CountrySpec * @description Stripe needs to collect certain pieces of information about each account @@ -2628,36 +2611,36 @@ export interface definitions { */ country_spec: { /** @description The default currency for this country. This applies to both payment methods and bank accounts. */ - default_currency: string; + default_currency: string /** @description Unique identifier for the object. Represented as the ISO country code for this country. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "country_spec"; + object: 'country_spec' /** @description Currencies that can be accepted in the specific country (for transfers). */ - supported_bank_account_currencies: { [key: string]: unknown }; + supported_bank_account_currencies: { [key: string]: unknown } /** @description Currencies that can be accepted in the specified country (for payments). */ - supported_payment_currencies: string[]; + supported_payment_currencies: string[] /** @description 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: string[]; + supported_payment_methods: string[] /** @description Countries that can accept transfers from the specified country. */ - supported_transfer_countries: string[]; - verification_fields: definitions["country_spec_verification_fields"]; - }; + supported_transfer_countries: string[] + verification_fields: definitions['country_spec_verification_fields'] + } /** CountrySpecVerificationFieldDetails */ country_spec_verification_field_details: { /** @description Additional fields which are only required for some users. */ - additional: string[]; + additional: string[] /** @description Fields which every account must eventually provide. */ - minimum: string[]; - }; + minimum: string[] + } /** CountrySpecVerificationFields */ country_spec_verification_fields: { - company: definitions["country_spec_verification_field_details"]; - individual: definitions["country_spec_verification_field_details"]; - }; + company: definitions['country_spec_verification_field_details'] + individual: definitions['country_spec_verification_field_details'] + } /** * Coupon * @description A coupon contains information about a percent-off or amount-off discount you @@ -2666,42 +2649,42 @@ export interface definitions { */ coupon: { /** @description Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer. */ - amount_off?: number; + amount_off?: number /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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?: string; + currency?: string /** * @description One of `forever`, `once`, and `repeating`. Describes how long a customer who applies this coupon will get the discount. * @enum {string} */ - duration: "forever" | "once" | "repeating"; + duration: 'forever' | 'once' | 'repeating' /** @description If `duration` is `repeating`, the number of months the coupon applies. Null if coupon `duration` is `forever` or `once`. */ - duration_in_months?: number; + duration_in_months?: number /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid. */ - max_redemptions?: number; + max_redemptions?: number /** @description 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: { [key: string]: unknown }; + metadata: { [key: string]: unknown } /** @description Name of the coupon displayed to customers on for instance invoices or receipts. */ - name?: string; + name?: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "coupon"; + object: 'coupon' /** @description 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 %s100 invoice %s50 instead. */ - percent_off?: number; + percent_off?: number /** @description Date after which the coupon can no longer be redeemed. */ - redeem_by?: number; + redeem_by?: number /** @description Number of times this coupon has been applied to a customer. */ - times_redeemed: number; + times_redeemed: number /** @description Taking account of the above properties, whether this coupon can still be applied to a customer. */ - valid: boolean; - }; + valid: boolean + } /** * CreditNote * @description Issue a credit note to adjust an invoice's amount after the invoice is finalized. @@ -2710,125 +2693,125 @@ export interface definitions { */ credit_note: { /** @description The integer amount in **%s** representing the total amount of the credit note, including tax. */ - amount: number; + amount: number /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description ID of the customer. */ - customer: string; + customer: string /** @description Customer balance transaction related to this credit note. */ - customer_balance_transaction?: string; + customer_balance_transaction?: string /** @description The integer amount in **%s** representing the amount of the discount that was credited. */ - discount_amount: number; + discount_amount: number /** @description Unique identifier for the object. */ - id: string; + id: string /** @description ID of the invoice. */ - invoice: string; + invoice: string /** * CreditNoteLinesList * @description Line items that make up the credit note */ lines: { /** @description Details about each object. */ - data: definitions["credit_note_line_item"][]; + data: definitions['credit_note_line_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description Customer-facing text that appears on the credit note PDF. */ - memo?: string; + memo?: string /** @description 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: { [key: string]: unknown }; + metadata: { [key: string]: unknown } /** @description A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice. */ - number: string; + number: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "credit_note"; + object: 'credit_note' /** @description Amount that was credited outside of Stripe. */ - out_of_band_amount?: number; + out_of_band_amount?: number /** @description The link to download the PDF of the credit note. */ - pdf: string; + pdf: string /** * @description Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` * @enum {string} */ - reason?: "duplicate" | "fraudulent" | "order_change" | "product_unsatisfactory"; + reason?: 'duplicate' | 'fraudulent' | 'order_change' | 'product_unsatisfactory' /** @description Refund related to this credit note. */ - refund?: string; + refund?: string /** * @description 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). * @enum {string} */ - status: "issued" | "void"; + status: 'issued' | 'void' /** @description The integer amount in **%s** representing the amount of the credit note, excluding tax and discount. */ - subtotal: number; + subtotal: number /** @description The aggregate amounts calculated per tax rate for all line items. */ - tax_amounts: definitions["credit_note_tax_amount"][]; + tax_amounts: definitions['credit_note_tax_amount'][] /** @description The integer amount in **%s** representing the total amount of the credit note, including tax and discount. */ - total: number; + total: number /** * @description 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. * @enum {string} */ - type: "post_payment" | "pre_payment"; + type: 'post_payment' | 'pre_payment' /** @description The time that the credit note was voided. */ - voided_at?: number; - }; + voided_at?: number + } /** CreditNoteLineItem */ credit_note_line_item: { /** @description The integer amount in **%s** representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts. */ - amount: number; + amount: number /** @description Description of the item being credited. */ - description?: string; + description?: string /** @description The integer amount in **%s** representing the discount being credited for this line item. */ - discount_amount: number; + discount_amount: number /** @description Unique identifier for the object. */ - id: string; + id: string /** @description ID of the invoice line item being credited */ - invoice_line_item?: string; + invoice_line_item?: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "credit_note_line_item"; + object: 'credit_note_line_item' /** @description The number of units of product being credited. */ - quantity?: number; + quantity?: number /** @description The amount of tax calculated per tax rate for this line item */ - tax_amounts: definitions["credit_note_tax_amount"][]; + tax_amounts: definitions['credit_note_tax_amount'][] /** @description The tax rates which apply to the line item. */ - tax_rates: definitions["tax_rate"][]; + tax_rates: definitions['tax_rate'][] /** * @description 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. * @enum {string} */ - type: "custom_line_item" | "invoice_line_item"; + type: 'custom_line_item' | 'invoice_line_item' /** @description The cost of each unit of product being credited. */ - unit_amount?: number; + unit_amount?: number /** @description Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. */ - unit_amount_decimal?: string; - }; + unit_amount_decimal?: string + } /** CreditNoteTaxAmount */ credit_note_tax_amount: { /** @description The amount, in %s, of the tax. */ - amount: number; + amount: number /** @description Whether this tax amount is inclusive or exclusive. */ - inclusive: boolean; + inclusive: boolean /** @description The tax rate that was applied to get this tax amount. */ - tax_rate: string; - }; + tax_rate: string + } /** * Customer * @description `Customer` objects allow you to perform recurring charges, and to track @@ -2839,118 +2822,118 @@ export interface definitions { * Related guide: [Saving Cards with Customers](https://stripe.com/docs/saving-cards). */ customer: { - address?: definitions["address"]; + address?: definitions['address'] /** @description Current balance, if any, being 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 will be added to their next invoice. The balance does not refer to any unpaid invoices; it solely takes into account amounts that have yet to be successfully applied to any invoice. This balance is only taken into account as invoices are finalized. */ - balance?: number; + balance?: number /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes. */ - currency?: string; + currency?: string /** * @description ID of the default payment source for the customer. * * If you are using payment methods created via 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. */ - default_source?: string; + default_source?: string /** @description When the customer's latest invoice is billed by charging automatically, delinquent is true if the invoice's latest charge is failed. When the customer's latest invoice is billed by sending an invoice, delinquent is true if the invoice is not paid by its due date. */ - delinquent?: boolean; + delinquent?: boolean /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; - discount?: definitions["discount"]; + description?: string + discount?: definitions['discount'] /** @description The customer's email address. */ - email?: string; + email?: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The prefix for the customer used to generate unique invoice numbers. */ - invoice_prefix?: string; - invoice_settings?: definitions["invoice_setting_customer_setting"]; + invoice_prefix?: string + invoice_settings?: definitions['invoice_setting_customer_setting'] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: unknown }; + metadata?: { [key: string]: unknown } /** @description The customer's full name or business name. */ - name?: string; + name?: string /** @description The suffix of the customer's next invoice number, e.g., 0001. */ - next_invoice_sequence?: number; + next_invoice_sequence?: number /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "customer"; + object: 'customer' /** @description The customer's phone number. */ - phone?: string; + phone?: string /** @description The customer's preferred locales (languages), ordered by preference. */ - preferred_locales?: string[]; - shipping?: definitions["shipping"]; + preferred_locales?: string[] + shipping?: definitions['shipping'] /** * ApmsSourcesSourceList * @description The customer's payment sources, if any. */ sources: { /** @description Details about each object. */ - data: definitions["alipay_account"][]; + data: definitions['alipay_account'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** * SubscriptionList * @description The customer's current subscriptions, if any. */ subscriptions?: { /** @description Details about each object. */ - data: definitions["subscription"][]; + data: definitions['subscription'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** * @description Describes the customer's tax exemption status. One of `none`, `exempt`, or `reverse`. When set to `reverse`, invoice and receipt PDFs include the text **"Reverse charge"**. * @enum {string} */ - tax_exempt?: "exempt" | "none" | "reverse"; + tax_exempt?: 'exempt' | 'none' | 'reverse' /** * TaxIDsList * @description The customer's tax IDs. */ tax_ids?: { /** @description Details about each object. */ - data: definitions["tax_id"][]; + data: definitions['tax_id'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** customer_acceptance */ customer_acceptance: { /** @description The time at which the customer accepted the Mandate. */ - accepted_at?: number; - offline?: definitions["offline_acceptance"]; - online?: definitions["online_acceptance"]; + accepted_at?: number + offline?: definitions['offline_acceptance'] + online?: definitions['online_acceptance'] /** * @description The type of customer acceptance information included with the Mandate. One of `online` or `offline`. * @enum {string} */ - type: "offline" | "online"; - }; + type: 'offline' | 'online' + } /** * CustomerBalanceTransaction * @description Each customer has a [`balance`](https://stripe.com/docs/api/customers/object#customer_object-balance) value, @@ -2962,437 +2945,437 @@ export interface definitions { */ customer_balance_transaction: { /** @description 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: number; + amount: number /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The ID of the credit note (if any) related to the transaction. */ - credit_note?: string; + credit_note?: string /** @description 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: string; + currency: string /** @description The ID of the customer the transaction belongs to. */ - customer: string; + customer: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description 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: number; + ending_balance: number /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The ID of the invoice (if any) related to the transaction. */ - invoice?: string; + invoice?: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: unknown }; + metadata?: { [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "customer_balance_transaction"; + object: 'customer_balance_transaction' /** * @description Transaction type: `adjustment`, `applied_to_invoice`, `credit_note`, `initial`, `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. * @enum {string} */ type: - | "adjustment" - | "applied_to_invoice" - | "credit_note" - | "initial" - | "invoice_too_large" - | "invoice_too_small" - | "migration" - | "unapplied_from_invoice" - | "unspent_receiver_credit"; - }; + | 'adjustment' + | 'applied_to_invoice' + | 'credit_note' + | 'initial' + | 'invoice_too_large' + | 'invoice_too_small' + | 'migration' + | 'unapplied_from_invoice' + | 'unspent_receiver_credit' + } /** DeletedAccount */ deleted_account: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "account"; - }; + object: 'account' + } /** AlipayDeletedAccount */ deleted_alipay_account: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "alipay_account"; - }; + object: 'alipay_account' + } /** DeletedApplePayDomain */ deleted_apple_pay_domain: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "apple_pay_domain"; - }; + object: 'apple_pay_domain' + } /** DeletedBankAccount */ deleted_bank_account: { /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. */ - currency?: string; + currency?: string /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "bank_account"; - }; + object: 'bank_account' + } /** BitcoinDeletedReceiver */ deleted_bitcoin_receiver: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "bitcoin_receiver"; - }; + object: 'bitcoin_receiver' + } /** DeletedCard */ deleted_card: { /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. */ - currency?: string; + currency?: string /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "card"; - }; + object: 'card' + } /** DeletedCoupon */ deleted_coupon: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "coupon"; - }; + object: 'coupon' + } /** DeletedCustomer */ deleted_customer: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "customer"; - }; + object: 'customer' + } /** DeletedDiscount */ deleted_discount: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "discount"; - }; + object: 'discount' + } /** Polymorphic */ deleted_external_account: { /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. */ - currency?: string; + currency?: string /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "bank_account"; - }; + object: 'bank_account' + } /** DeletedInvoice */ deleted_invoice: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "invoice"; - }; + object: 'invoice' + } /** DeletedInvoiceItem */ deleted_invoiceitem: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "invoiceitem"; - }; + object: 'invoiceitem' + } /** Polymorphic */ deleted_payment_source: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "alipay_account"; - }; + object: 'alipay_account' + } /** DeletedPerson */ deleted_person: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "person"; - }; + object: 'person' + } /** DeletedPlan */ deleted_plan: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "plan"; - }; + object: 'plan' + } /** DeletedProduct */ deleted_product: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "product"; - }; + object: 'product' + } /** RadarListDeletedList */ - "deleted_radar.value_list": { + 'deleted_radar.value_list': { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "radar.value_list"; - }; + object: 'radar.value_list' + } /** RadarListDeletedListItem */ - "deleted_radar.value_list_item": { + 'deleted_radar.value_list_item': { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "radar.value_list_item"; - }; + object: 'radar.value_list_item' + } /** DeletedTransferRecipient */ deleted_recipient: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "recipient"; - }; + object: 'recipient' + } /** DeletedSKU */ deleted_sku: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "sku"; - }; + object: 'sku' + } /** DeletedSubscriptionItem */ deleted_subscription_item: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "subscription_item"; - }; + object: 'subscription_item' + } /** deleted_tax_id */ deleted_tax_id: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "tax_id"; - }; + object: 'tax_id' + } /** TerminalLocationDeletedLocation */ - "deleted_terminal.location": { + 'deleted_terminal.location': { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "terminal.location"; - }; + object: 'terminal.location' + } /** TerminalReaderDeletedReader */ - "deleted_terminal.reader": { + 'deleted_terminal.reader': { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "terminal.reader"; - }; + object: 'terminal.reader' + } /** NotificationWebhookEndpointDeleted */ deleted_webhook_endpoint: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "webhook_endpoint"; - }; + object: 'webhook_endpoint' + } /** DeliveryEstimate */ delivery_estimate: { /** @description If `type` is `"exact"`, `date` will be the expected delivery date in the format YYYY-MM-DD. */ - date?: string; + date?: string /** @description If `type` is `"range"`, `earliest` will be be the earliest delivery date in the format YYYY-MM-DD. */ - earliest?: string; + earliest?: string /** @description If `type` is `"range"`, `latest` will be the latest delivery date in the format YYYY-MM-DD. */ - latest?: string; + latest?: string /** @description The type of estimate. Must be either `"range"` or `"exact"`. */ - type: string; - }; + type: string + } /** * Discount * @description A discount represents the actual application of a coupon to a particular @@ -3402,21 +3385,21 @@ export interface definitions { * Related guide: [Applying Discounts to Subscriptions](https://stripe.com/docs/billing/subscriptions/discounts). */ discount: { - coupon: definitions["coupon"]; + coupon: definitions['coupon'] /** @description The ID of the customer associated with this discount. */ - customer?: string; + customer?: string /** @description 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?: number; + end?: number /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "discount"; + object: 'discount' /** @description Date that the coupon was applied. */ - start: number; + start: number /** @description The subscription that this coupon is applied to, if it is applied to a particular subscription. */ - subscription?: string; - }; + subscription?: string + } /** * Dispute * @description A dispute occurs when a customer questions your charge with their card issuer. @@ -3429,138 +3412,138 @@ export interface definitions { */ dispute: { /** @description Disputed amount. Usually the amount of the charge, but can differ (usually because of currency fluctuation or because only part of the order is disputed). */ - amount: number; + amount: number /** @description 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: definitions["balance_transaction"][]; + balance_transactions: definitions['balance_transaction'][] /** @description ID of the charge that was disputed. */ - charge: string; + charge: string /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; - evidence: definitions["dispute_evidence"]; - evidence_details: definitions["dispute_evidence_details"]; + currency: string + evidence: definitions['dispute_evidence'] + evidence_details: definitions['dispute_evidence_details'] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description If true, it is still possible to refund the disputed payment. Once the payment has been fully refunded, no further funds will be withdrawn from your Stripe account as a result of this dispute. */ - is_charge_refundable: boolean; + is_charge_refundable: boolean /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: unknown }; + metadata: { [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "dispute"; + object: 'dispute' /** @description ID of the PaymentIntent that was disputed. */ - payment_intent?: string; + payment_intent?: string /** @description 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`. Read more about [dispute reasons](https://stripe.com/docs/disputes/categories). */ - reason: string; + reason: string /** * @description Current status of dispute. Possible values are `warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `charge_refunded`, `won`, or `lost`. * @enum {string} */ status: - | "charge_refunded" - | "lost" - | "needs_response" - | "under_review" - | "warning_closed" - | "warning_needs_response" - | "warning_under_review" - | "won"; - }; + | 'charge_refunded' + | 'lost' + | 'needs_response' + | 'under_review' + | 'warning_closed' + | 'warning_needs_response' + | 'warning_under_review' + | 'won' + } /** DisputeEvidence */ dispute_evidence: { /** @description 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?: string; + access_activity_log?: string /** @description The billing address provided by the customer. */ - billing_address?: string; + billing_address?: string /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your subscription cancellation policy, as shown to the customer. */ - cancellation_policy?: string; + cancellation_policy?: string /** @description An explanation of how and when the customer was shown your refund policy prior to purchase. */ - cancellation_policy_disclosure?: string; + cancellation_policy_disclosure?: string /** @description A justification for why the customer's subscription was not canceled. */ - cancellation_rebuttal?: string; + cancellation_rebuttal?: string /** @description (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?: string; + customer_communication?: string /** @description The email address of the customer. */ - customer_email_address?: string; + customer_email_address?: string /** @description The name of the customer. */ - customer_name?: string; + customer_name?: string /** @description The IP address that the customer used when making the purchase. */ - customer_purchase_ip?: string; + customer_purchase_ip?: string /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A relevant document or contract showing the customer's signature. */ - customer_signature?: string; + customer_signature?: string /** @description (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?: string; + duplicate_charge_documentation?: string /** @description An explanation of the difference between the disputed charge versus the prior charge that appears to be a duplicate. */ - duplicate_charge_explanation?: string; + duplicate_charge_explanation?: string /** @description The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge. */ - duplicate_charge_id?: string; + duplicate_charge_id?: string /** @description A description of the product or service that was sold. */ - product_description?: string; + product_description?: string /** @description (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?: string; + receipt?: string /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your refund policy, as shown to the customer. */ - refund_policy?: string; + refund_policy?: string /** @description Documentation demonstrating that the customer was shown your refund policy prior to purchase. */ - refund_policy_disclosure?: string; + refund_policy_disclosure?: string /** @description A justification for why the customer is not entitled to a refund. */ - refund_refusal_explanation?: string; + refund_refusal_explanation?: string /** @description The date on which the customer received or began receiving the purchased service, in a clear human-readable format. */ - service_date?: string; + service_date?: string /** @description (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?: string; + service_documentation?: string /** @description The address to which a physical product was shipped. You should try to include as complete address information as possible. */ - shipping_address?: string; + shipping_address?: string /** @description 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?: string; + shipping_carrier?: string /** @description The date on which a physical product began its route to the shipping address, in a clear human-readable format. */ - shipping_date?: string; + shipping_date?: string /** @description (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?: string; + shipping_documentation?: string /** @description 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?: string; + shipping_tracking_number?: string /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any additional evidence or statements. */ - uncategorized_file?: string; + uncategorized_file?: string /** @description Any additional evidence or statements. */ - uncategorized_text?: string; - }; + uncategorized_text?: string + } /** DisputeEvidenceDetails */ dispute_evidence_details: { /** @description Date by which evidence must be submitted in order to successfully challenge dispute. Will be null if the customer's bank or credit card company doesn't allow a response for this particular dispute. */ - due_by?: number; + due_by?: number /** @description Whether evidence has been staged for this dispute. */ - has_evidence: boolean; + has_evidence: boolean /** @description 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: boolean; + past_due: boolean /** @description The number of times evidence has been submitted. Typically, you may only submit evidence once. */ - submission_count: number; - }; + submission_count: number + } /** EphemeralKey */ ephemeral_key: { /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Time at which the key will expire. Measured in seconds since the Unix epoch. */ - expires: number; + expires: number /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "ephemeral_key"; + object: 'ephemeral_key' /** @description The key's secret. You can use this value to make authorized requests to the Stripe API. */ - secret?: string; - }; + secret?: string + } /** @description An error response from the Stripe API */ error: { - error: definitions["api_errors"]; - }; + error: definitions['api_errors'] + } /** * NotificationEvent * @description Events are our way of letting you know when something interesting happens in @@ -3595,27 +3578,27 @@ export interface definitions { */ event: { /** @description The connected account that originated the event. */ - account?: string; + account?: string /** @description The Stripe API version used to render `data`. *Note: This property is populated only for events on or after October 31, 2014*. */ - api_version?: string; + api_version?: string /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; - data: definitions["notification_event_data"]; + created: number + data: definitions['notification_event_data'] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "event"; + object: 'event' /** @description Number of webhooks that have yet to be successfully delivered (i.e., to return a 20x response) to the URLs you've specified. */ - pending_webhooks: number; - request?: definitions["notification_event_request"]; + pending_webhooks: number + request?: definitions['notification_event_request'] /** @description Description of the event (e.g., `invoice.created` or `charge.refunded`). */ - type: string; - }; + type: string + } /** * ExchangeRate * @description `Exchange Rate` objects allow you to determine the rates that Stripe is @@ -3632,54 +3615,54 @@ export interface definitions { */ exchange_rate: { /** @description 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: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "exchange_rate"; + object: 'exchange_rate' /** @description 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: { [key: string]: unknown }; - }; + rates: { [key: string]: unknown } + } /** Polymorphic */ external_account: { /** @description The ID of the account that the bank account is associated with. */ - account?: string; + account?: string /** @description Two-letter ISO code representing the country the bank account is located in. */ - country: string; + country: string /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. */ - currency: string; + currency: string /** @description The ID of the customer that the bank account is associated with. */ - customer?: string; + customer?: string /** @description Whether this bank account is the default external account for its currency. */ - default_for_currency?: boolean; + default_for_currency?: boolean /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string; + fingerprint?: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The last four digits of the bank account number. */ - last4: string; + last4: string /** @description 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?: { [key: string]: unknown }; + metadata?: { [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "bank_account"; - }; + object: 'bank_account' + } /** Fee */ fee: { /** @description Amount of the fee, in cents. */ - amount: number; + amount: number /** @description ID of the Connect application that earned the fee. */ - application?: string; + application?: string /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Type of the fee, one of: `application_fee`, `stripe_fee` or `tax`. */ - type: string; - }; + type: string + } /** * FeeRefund * @description `Application Fee Refund` objects allow you to refund an application fee that @@ -3690,25 +3673,25 @@ export interface definitions { */ fee_refund: { /** @description Amount, in %s. */ - amount: number; + amount: number /** @description Balance transaction that describes the impact on your account balance. */ - balance_transaction?: string; + balance_transaction?: string /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description ID of the application fee that was refunded. */ - fee: string; + fee: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description 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: { [key: string]: unknown }; + metadata: { [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "fee_refund"; - }; + object: 'fee_refund' + } /** * File * @description This is an object representing a file hosted on Stripe's servers. The @@ -3721,44 +3704,44 @@ export interface definitions { */ file: { /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description A filename for the file, suitable for saving to a filesystem. */ - filename?: string; + filename?: string /** @description Unique identifier for the object. */ - id: string; + id: string /** * FileFileLinkList * @description A list of [file links](https://stripe.com/docs/api#file_links) that point at this file. */ links?: { /** @description Details about each object. */ - data: definitions["file_link"][]; + data: definitions['file_link'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "file"; + object: 'file' /** @description The purpose of the file. Possible values are `additional_verification`, `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `finance_report_run`, `identity_document`, `pci_document`, `sigma_scheduled_query`, or `tax_document_user_upload`. */ - purpose: string; + purpose: string /** @description The size in bytes of the file object. */ - size: number; + size: number /** @description A user friendly title for the document. */ - title?: string; + title?: string /** @description The type of the file returned (e.g., `csv`, `pdf`, `jpg`, or `png`). */ - type?: string; + type?: string /** @description The URL from which the file can be downloaded using your live secret API key. */ - url?: string; - }; + url?: string + } /** * FileLink * @description To share the contents of a `File` object with non-Stripe users, you can @@ -3767,55 +3750,55 @@ export interface definitions { */ file_link: { /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Whether this link is already expired. */ - expired: boolean; + expired: boolean /** @description Time at which the link expires. */ - expires_at?: number; + expires_at?: number /** @description The file object this link points to. */ - file: string; + file: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: unknown }; + metadata: { [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "file_link"; + object: 'file_link' /** @description The publicly accessible URL to download the file. */ - url?: string; - }; + url?: string + } /** FinancialReportingFinanceReportRunRunParameters */ financial_reporting_finance_report_run_run_parameters: { /** @description The set of output columns requested for inclusion in the report run. */ - columns?: string[]; + columns?: string[] /** @description Connected account ID by which to filter the report run. */ - connected_account?: string; + connected_account?: string /** @description Currency of objects to be included in the report run. */ - currency?: string; + currency?: string /** @description Ending timestamp of data to be included in the report run (exclusive). */ - interval_end?: number; + interval_end?: number /** @description Starting timestamp of data to be included in the report run. */ - interval_start?: number; + interval_start?: number /** @description Payout ID by which to filter the report run. */ - payout?: string; + payout?: string /** @description Category of balance transactions to be included in the report run. */ - reporting_category?: string; + reporting_category?: string /** @description 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?: string; - }; + timezone?: string + } /** Inventory */ inventory: { /** @description The count of inventory available. Will be present if and only if `type` is `finite`. */ - quantity?: number; + quantity?: number /** @description Inventory type. Possible values are `finite`, `bucket` (not quantified), and `infinite`. */ - type: string; + type: string /** @description An indicator of the inventory available. Possible values are `in_stock`, `limited`, and `out_of_stock`. Will be present if and only if `type` is `bucket`. */ - value?: string; - }; + value?: string + } /** * Invoice * @description Invoices are statements of amounts owed by a customer, and are either @@ -3853,210 +3836,210 @@ export interface definitions { */ invoice: { /** @description The country of the business associated with this invoice, most often the business creating the invoice. */ - account_country?: string; + account_country?: string /** @description The public name of the business associated with this invoice, most often the business creating the invoice. */ - account_name?: string; + account_name?: string /** @description 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: number; + amount_due: number /** @description The amount, in %s, that was paid. */ - amount_paid: number; + amount_paid: number /** @description The amount remaining, in %s, that is due. */ - amount_remaining: number; + amount_remaining: number /** @description The fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account when the invoice is paid. */ - application_fee_amount?: number; + application_fee_amount?: number /** @description 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. */ - attempt_count: number; + attempt_count: number /** @description 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: boolean; + attempted: boolean /** @description Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice. When `false`, the invoice's state will not automatically advance without an explicit action. */ - auto_advance?: boolean; + auto_advance?: boolean /** * @description Indicates the reason why the invoice was created. `subscription_cycle` indicates an invoice created by a subscription advancing into a new period. `subscription_create` indicates an invoice created due to creating a subscription. `subscription_update` indicates an invoice created due to updating a subscription. `subscription` is set for all old invoices to indicate either a change to a subscription or a period advancement. `manual` is set for all invoices unrelated to a subscription (for example: created via the invoice editor). The `upcoming` value is reserved for simulated invoices per the upcoming invoice endpoint. `subscription_threshold` indicates an invoice created due to a billing threshold being reached. * @enum {string} */ billing_reason?: - | "automatic_pending_invoice_item_invoice" - | "manual" - | "subscription" - | "subscription_create" - | "subscription_cycle" - | "subscription_threshold" - | "subscription_update" - | "upcoming"; + | 'automatic_pending_invoice_item_invoice' + | 'manual' + | 'subscription' + | 'subscription_create' + | 'subscription_cycle' + | 'subscription_threshold' + | 'subscription_update' + | 'upcoming' /** @description ID of the latest charge generated for this invoice, if any. */ - charge?: string; + charge?: string /** * @description 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. * @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Custom fields displayed on the invoice. */ - custom_fields?: definitions["invoice_setting_custom_field"][]; + custom_fields?: definitions['invoice_setting_custom_field'][] /** @description The ID of the customer who will be billed. */ - customer: string; - customer_address?: definitions["address"]; + customer: string + customer_address?: definitions['address'] /** @description 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?: string; + customer_email?: string /** @description 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?: string; + customer_name?: string /** @description 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?: string; - customer_shipping?: definitions["shipping"]; + customer_phone?: string + customer_shipping?: definitions['shipping'] /** * @description 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. * @enum {string} */ - customer_tax_exempt?: "exempt" | "none" | "reverse"; + customer_tax_exempt?: 'exempt' | 'none' | 'reverse' /** @description 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?: definitions["invoices_resource_invoice_tax_id"][]; + customer_tax_ids?: definitions['invoices_resource_invoice_tax_id'][] /** @description 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?: string; + default_payment_method?: string /** @description 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?: string; + default_source?: string /** @description The tax rates applied to this invoice, if any. */ - default_tax_rates?: definitions["tax_rate"][]; + default_tax_rates?: definitions['tax_rate'][] /** @description An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. */ - description?: string; - discount?: definitions["discount"]; + description?: string + discount?: definitions['discount'] /** @description The date on which payment for this invoice is due. This value will be `null` for invoices where `collection_method=charge_automatically`. */ - due_date?: number; + due_date?: number /** @description 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?: number; + ending_balance?: number /** @description Footer displayed on the invoice. */ - footer?: string; + footer?: string /** @description 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?: string; + hosted_invoice_url?: string /** @description Unique identifier for the object. */ - id?: string; + id?: string /** @description The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null. */ - invoice_pdf?: string; + invoice_pdf?: string /** * InvoiceLinesList * @description The individual line items that make up the invoice. `lines` is sorted as follows: invoice items in reverse chronological order, followed by the subscription, if any. */ lines: { /** @description Details about each object. */ - data: definitions["line_item"][]; + data: definitions['line_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: unknown }; + metadata?: { [key: string]: unknown } /** @description The time at which payment will next be attempted. This value will be `null` for invoices where `collection_method=send_invoice`. */ - next_payment_attempt?: number; + next_payment_attempt?: number /** @description 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?: string; + number?: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "invoice"; + object: 'invoice' /** @description 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: boolean; + paid: boolean /** @description 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?: string; + payment_intent?: string /** @description End of the usage period during which invoice items were added to this invoice. */ - period_end: number; + period_end: number /** @description Start of the usage period during which invoice items were added to this invoice. */ - period_start: number; + period_start: number /** @description Total amount of all post-payment credit notes issued for this invoice. */ - post_payment_credit_notes_amount: number; + post_payment_credit_notes_amount: number /** @description Total amount of all pre-payment credit notes issued for this invoice. */ - pre_payment_credit_notes_amount: number; + pre_payment_credit_notes_amount: number /** @description This is the transaction number that appears on email receipts sent for this invoice. */ - receipt_number?: string; + receipt_number?: string /** @description Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. */ - starting_balance: number; + starting_balance: number /** @description Extra information about an invoice for the customer's credit card statement. */ - statement_descriptor?: string; + statement_descriptor?: string /** * @description The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview) * @enum {string} */ - status?: "deleted" | "draft" | "open" | "paid" | "uncollectible" | "void"; - status_transitions: definitions["invoices_status_transitions"]; + status?: 'deleted' | 'draft' | 'open' | 'paid' | 'uncollectible' | 'void' + status_transitions: definitions['invoices_status_transitions'] /** @description The subscription that this invoice was prepared for, if any. */ - subscription?: string; + subscription?: string /** @description Only set for upcoming invoices that preview prorations. The time used to calculate prorations. */ - subscription_proration_date?: number; + subscription_proration_date?: number /** @description Total of all subscriptions, invoice items, and prorations on the invoice before any discount or tax is applied. */ - subtotal: number; + subtotal: number /** @description The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice. */ - tax?: number; + tax?: number /** @description This percentage of the subtotal has been added to the total amount of the invoice, including invoice line items and discounts. This field is inherited from the subscription's `tax_percent` field, but can be changed before the invoice is paid. This field defaults to null. */ - tax_percent?: number; - threshold_reason?: definitions["invoice_threshold_reason"]; + tax_percent?: number + threshold_reason?: definitions['invoice_threshold_reason'] /** @description Total after discounts and taxes. */ - total: number; + total: number /** @description The aggregate amounts calculated per tax rate for all line items. */ - total_tax_amounts?: definitions["invoice_tax_amount"][]; + total_tax_amounts?: definitions['invoice_tax_amount'][] /** @description 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?: number; - }; + webhooks_delivered_at?: number + } /** InvoiceItemThresholdReason */ invoice_item_threshold_reason: { /** @description The IDs of the line items that triggered the threshold invoice. */ - line_item_ids: string[]; + line_item_ids: string[] /** @description The quantity threshold boundary that applied to the given line item. */ - usage_gte: number; - }; + usage_gte: number + } /** InvoiceLineItemPeriod */ invoice_line_item_period: { /** @description End of the line item's billing period */ - end: number; + end: number /** @description Start of the line item's billing period */ - start: number; - }; + start: number + } /** InvoiceSettingCustomField */ invoice_setting_custom_field: { /** @description The name of the custom field. */ - name: string; + name: string /** @description The value of the custom field. */ - value: string; - }; + value: string + } /** InvoiceSettingCustomerSetting */ invoice_setting_customer_setting: { /** @description Default custom fields to be displayed on invoices for this customer. */ - custom_fields?: definitions["invoice_setting_custom_field"][]; + custom_fields?: definitions['invoice_setting_custom_field'][] /** @description 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?: string; + default_payment_method?: string /** @description Default footer to be displayed on invoices for this customer. */ - footer?: string; - }; + footer?: string + } /** InvoiceSettingSubscriptionScheduleSetting */ invoice_setting_subscription_schedule_setting: { /** @description 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?: number; - }; + days_until_due?: number + } /** InvoiceTaxAmount */ invoice_tax_amount: { /** @description The amount, in %s, of the tax. */ - amount: number; + amount: number /** @description Whether this tax amount is inclusive or exclusive. */ - inclusive: boolean; + inclusive: boolean /** @description The tax rate that was applied to get this tax amount. */ - tax_rate: string; - }; + tax_rate: string + } /** InvoiceThresholdReason */ invoice_threshold_reason: { /** @description The total invoice amount threshold boundary if it triggered the threshold invoice. */ - amount_gte?: number; + amount_gte?: number /** @description Indicates which line items triggered a threshold invoice. */ - item_reasons: definitions["invoice_item_threshold_reason"][]; - }; + item_reasons: definitions['invoice_item_threshold_reason'][] + } /** * InvoiceItem * @description Sometimes you want to add a charge or credit to a customer, but actually @@ -4069,47 +4052,47 @@ export interface definitions { */ invoiceitem: { /** @description Amount (in the `currency` specified) of the invoice item. This should always be equal to `unit_amount * quantity`. */ - amount: number; + amount: number /** @description 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: string; + currency: string /** @description The ID of the customer who will be billed when this invoice item is billed. */ - customer: string; + customer: string /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - date: number; + date: number /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description If true, discounts will apply to this invoice item. Always false for prorations. */ - discountable: boolean; + discountable: boolean /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The ID of the invoice this invoice item belongs to. */ - invoice?: string; + invoice?: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: unknown }; + metadata: { [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "invoiceitem"; - period: definitions["invoice_line_item_period"]; - plan?: definitions["plan"]; + object: 'invoiceitem' + period: definitions['invoice_line_item_period'] + plan?: definitions['plan'] /** @description Whether the invoice item was created automatically as a proration adjustment when the customer switched plans. */ - proration: boolean; + proration: boolean /** @description 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: number; + quantity: number /** @description The subscription that this invoice item has been created for, if any. */ - subscription?: string; + subscription?: string /** @description The subscription item that this invoice item has been created for, if any. */ - subscription_item?: string; + subscription_item?: string /** @description 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?: definitions["tax_rate"][]; + tax_rates?: definitions['tax_rate'][] /** @description Unit Amount (in the `currency` specified) of the invoice item. */ - unit_amount?: number; + unit_amount?: number /** @description Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. */ - unit_amount_decimal?: string; - }; + unit_amount_decimal?: string + } /** InvoicesResourceInvoiceTaxID */ invoices_resource_invoice_tax_id: { /** @@ -4117,44 +4100,44 @@ export interface definitions { * @enum {string} */ type: - | "au_abn" - | "ca_bn" - | "ca_qst" - | "ch_vat" - | "es_cif" - | "eu_vat" - | "hk_br" - | "in_gst" - | "jp_cn" - | "kr_brn" - | "li_uid" - | "mx_rfc" - | "my_itn" - | "my_sst" - | "no_vat" - | "nz_gst" - | "ru_inn" - | "sg_gst" - | "sg_uen" - | "th_vat" - | "tw_vat" - | "unknown" - | "us_ein" - | "za_vat"; + | 'au_abn' + | 'ca_bn' + | 'ca_qst' + | 'ch_vat' + | 'es_cif' + | 'eu_vat' + | 'hk_br' + | 'in_gst' + | 'jp_cn' + | 'kr_brn' + | 'li_uid' + | 'mx_rfc' + | 'my_itn' + | 'my_sst' + | 'no_vat' + | 'nz_gst' + | 'ru_inn' + | 'sg_gst' + | 'sg_uen' + | 'th_vat' + | 'tw_vat' + | 'unknown' + | 'us_ein' + | 'za_vat' /** @description The value of the tax ID. */ - value?: string; - }; + value?: string + } /** InvoicesStatusTransitions */ invoices_status_transitions: { /** @description The time that the invoice draft was finalized. */ - finalized_at?: number; + finalized_at?: number /** @description The time that the invoice was marked uncollectible. */ - marked_uncollectible_at?: number; + marked_uncollectible_at?: number /** @description The time that the invoice was paid. */ - paid_at?: number; + paid_at?: number /** @description The time that the invoice was voided. */ - voided_at?: number; - }; + voided_at?: number + } /** * IssuerFraudRecord * @description This resource has been renamed to [Early Fraud @@ -4163,27 +4146,27 @@ export interface definitions { */ issuer_fraud_record: { /** @description An IFR 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 IFR, in order to avoid receiving a dispute later. */ - actionable: boolean; + actionable: boolean /** @description ID of the charge this issuer fraud record is for, optionally expanded. */ - charge: string; + charge: string /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + fraud_type: string /** @description If true, the associated charge is subject to [liability shift](https://stripe.com/docs/payments/3d-secure#disputed-payments). */ - has_liability_shift: boolean; + has_liability_shift: boolean /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "issuer_fraud_record"; + object: 'issuer_fraud_record' /** @description The timestamp at which the card issuer posted the issuer fraud record. */ - post_date: number; - }; + post_date: number + } /** * IssuingAuthorization * @description When an [issued card](https://stripe.com/docs/issuing) is used to make a purchase, an Issuing `Authorization` @@ -4192,218 +4175,218 @@ export interface definitions { * * Related guide: [Issued Card Authorizations](https://stripe.com/docs/issuing/purchases/authorizations). */ - "issuing.authorization": { + 'issuing.authorization': { /** @description The total amount that was authorized or rejected. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ - amount: number; + amount: number /** @description Whether the authorization has been approved. */ - approved: boolean; + approved: boolean /** * @description How the card details were provided. * @enum {string} */ - authorization_method: "chip" | "contactless" | "keyed_in" | "online" | "swipe"; + authorization_method: 'chip' | 'contactless' | 'keyed_in' | 'online' | 'swipe' /** @description List of balance transactions associated with this authorization. */ - balance_transactions: definitions["balance_transaction"][]; - card: definitions["issuing.card"]; + balance_transactions: definitions['balance_transaction'][] + card: definitions['issuing.card'] /** @description The cardholder to whom this authorization belongs. */ - cardholder?: string; + cardholder?: string /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: number; + merchant_amount: number /** @description The currency that was 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: string; - merchant_data: definitions["issuing_authorization_merchant_data"]; + merchant_currency: string + merchant_data: definitions['issuing_authorization_merchant_data'] /** @description 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: { [key: string]: unknown }; + metadata: { [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "issuing.authorization"; - pending_request?: definitions["issuing_authorization_pending_request"]; + object: 'issuing.authorization' + pending_request?: definitions['issuing_authorization_pending_request'] /** @description History of every time the authorization was approved/denied (whether approved/denied by you directly or by Stripe based on your `spending_controls`). If the merchant changes the authorization by performing an [incremental authorization or partial capture](https://stripe.com/docs/issuing/purchases/authorizations), you can look at this field to see the previous states of the authorization. */ - request_history: definitions["issuing_authorization_request"][]; + request_history: definitions['issuing_authorization_request'][] /** * @description The current status of the authorization in its lifecycle. * @enum {string} */ - status: "closed" | "pending" | "reversed"; + status: 'closed' | 'pending' | 'reversed' /** @description List of [transactions](https://stripe.com/docs/api/issuing/transactions) associated with this authorization. */ - transactions: definitions["issuing.transaction"][]; - verification_data: definitions["issuing_authorization_verification_data"]; + transactions: definitions['issuing.transaction'][] + verification_data: definitions['issuing_authorization_verification_data'] /** @description What, if any, digital wallet was used for this authorization. One of `apple_pay`, `google_pay`, or `samsung_pay`. */ - wallet?: string; - }; + wallet?: string + } /** * IssuingCard * @description You can [create physical or virtual cards](https://stripe.com/docs/issuing/cards) that are issued to cardholders. */ - "issuing.card": { + 'issuing.card': { /** @description The brand of the card. */ - brand: string; + brand: string /** * @description The reason why the card was canceled. * @enum {string} */ - cancellation_reason?: "lost" | "stolen"; - cardholder: definitions["issuing.cardholder"]; + cancellation_reason?: 'lost' | 'stolen' + cardholder: definitions['issuing.cardholder'] /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description 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?: string; + cvc?: string /** @description The expiration month of the card. */ - exp_month: number; + exp_month: number /** @description The expiration year of the card. */ - exp_year: number; + exp_year: number /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The last 4 digits of the card number. */ - last4: string; + last4: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: unknown }; + metadata: { [key: string]: unknown } /** @description 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?: string; + number?: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "issuing.card"; + object: 'issuing.card' /** @description The latest card that replaces this card, if any. */ - replaced_by?: string; + replaced_by?: string /** @description The card this card replaces, if any. */ - replacement_for?: string; + replacement_for?: string /** * @description The reason why the previous card needed to be replaced. * @enum {string} */ - replacement_reason?: "damaged" | "expired" | "lost" | "stolen"; - shipping?: definitions["issuing_card_shipping"]; - spending_controls: definitions["issuing_card_authorization_controls"]; + replacement_reason?: 'damaged' | 'expired' | 'lost' | 'stolen' + shipping?: definitions['issuing_card_shipping'] + spending_controls: definitions['issuing_card_authorization_controls'] /** * @description Whether authorizations can be approved on this card. * @enum {string} */ - status: "active" | "canceled" | "inactive"; + status: 'active' | 'canceled' | 'inactive' /** * @description The type of the card. * @enum {string} */ - type: "physical" | "virtual"; - }; + type: 'physical' | 'virtual' + } /** * IssuingCardholder * @description An Issuing `Cardholder` object represents an individual or business entity who is [issued](https://stripe.com/docs/issuing) cards. * * Related guide: [How to create a Cardholder](https://stripe.com/docs/issuing/cards#create-cardholder) */ - "issuing.cardholder": { - billing: definitions["issuing_cardholder_address"]; - company?: definitions["issuing_cardholder_company"]; + 'issuing.cardholder': { + billing: definitions['issuing_cardholder_address'] + company?: definitions['issuing_cardholder_company'] /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The cardholder's email address. */ - email?: string; + email?: string /** @description Unique identifier for the object. */ - id: string; - individual?: definitions["issuing_cardholder_individual"]; + id: string + individual?: definitions['issuing_cardholder_individual'] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: unknown }; + metadata: { [key: string]: unknown } /** @description The cardholder's name. This will be printed on cards issued to them. */ - name: string; + name: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "issuing.cardholder"; + object: 'issuing.cardholder' /** @description The cardholder's phone number. */ - phone_number?: string; - requirements: definitions["issuing_cardholder_requirements"]; - spending_controls?: definitions["issuing_cardholder_authorization_controls"]; + phone_number?: string + requirements: definitions['issuing_cardholder_requirements'] + spending_controls?: definitions['issuing_cardholder_authorization_controls'] /** * @description Specifies whether to permit authorizations on this cardholder's cards. * @enum {string} */ - status: "active" | "blocked" | "inactive"; + status: 'active' | 'blocked' | 'inactive' /** * @description One of `individual` or `company`. * @enum {string} */ - type: "company" | "individual"; - }; + type: 'company' | 'individual' + } /** * IssuingDispute * @description As a [card issuer](https://stripe.com/docs/issuing), you can [dispute](https://stripe.com/docs/issuing/purchases/disputes) transactions that you do not recognize, suspect to be fraudulent, or have some other issue. * * Related guide: [Disputing Transactions](https://stripe.com/docs/issuing/purchases/disputes) */ - "issuing.dispute": { + 'issuing.dispute': { /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "issuing.dispute"; - }; + object: 'issuing.dispute' + } /** * IssuingSettlement * @description 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. */ - "issuing.settlement": { + 'issuing.settlement': { /** @description The Bank Identification Number reflecting this settlement record. */ - bin: string; + bin: string /** @description The date that the transactions are cleared and posted to user's accounts. */ - clearing_date: number; + clearing_date: number /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The total interchange received as reimbursement for the transactions. */ - interchange_fees: number; + interchange_fees: number /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: unknown }; + metadata: { [key: string]: unknown } /** @description The total net amount required to settle with the network. */ - net_total: number; + net_total: number /** * @description The card network for this settlement report. One of ["visa"] * @enum {string} */ - network: "visa"; + network: 'visa' /** @description The total amount of fees owed to the network. */ - network_fees: number; + network_fees: number /** @description The Settlement Identification Number assigned by the network. */ - network_settlement_identifier: string; + network_settlement_identifier: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "issuing.settlement"; + object: 'issuing.settlement' /** @description One of `international` or `uk_national_net`. */ - settlement_service: string; + settlement_service: string /** @description The total number of transactions reflected in this settlement. */ - transaction_count: number; + transaction_count: number /** @description The total transaction amount reflected in this settlement. */ - transaction_volume: number; - }; + transaction_volume: number + } /** * IssuingTransaction * @description Any use of an [issued card](https://stripe.com/docs/issuing) that results in funds entering or leaving @@ -4412,2247 +4395,2247 @@ export interface definitions { * * Related guide: [Issued Card Transactions](https://stripe.com/docs/issuing/purchases/transactions). */ - "issuing.transaction": { + 'issuing.transaction': { /** @description 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: number; + amount: number /** @description The `Authorization` object that led to this transaction. */ - authorization?: string; + authorization?: string /** @description ID of the [balance transaction](https://stripe.com/docs/api/balance_transactions) associated with this transaction. */ - balance_transaction?: string; + balance_transaction?: string /** @description The card used to make this transaction. */ - card: string; + card: string /** @description The cardholder to whom this transaction belongs. */ - cardholder?: string; + cardholder?: string /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: number; + merchant_amount: number /** @description The currency with which the merchant is taking payment. */ - merchant_currency: string; - merchant_data: definitions["issuing_authorization_merchant_data"]; + merchant_currency: string + merchant_data: definitions['issuing_authorization_merchant_data'] /** @description 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: { [key: string]: unknown }; + metadata: { [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "issuing.transaction"; + object: 'issuing.transaction' /** * @description The nature of the transaction. * @enum {string} */ - type: "capture" | "refund"; - }; + type: 'capture' | 'refund' + } /** IssuingAuthorizationMerchantData */ issuing_authorization_merchant_data: { /** @description 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: string; + category: string /** @description City where the seller is located */ - city?: string; + city?: string /** @description Country where the seller is located */ - country?: string; + country?: string /** @description Name of the seller */ - name?: string; + name?: string /** @description Identifier assigned to the seller by the card brand */ - network_id: string; + network_id: string /** @description Postal code where the seller is located */ - postal_code?: string; + postal_code?: string /** @description State where the seller is located */ - state?: string; - }; + state?: string + } /** IssuingAuthorizationPendingRequest */ issuing_authorization_pending_request: { /** @description 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: number; + amount: number /** @description 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: string; + currency: string /** @description 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: boolean; + is_amount_controllable: boolean /** @description 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: number; + merchant_amount: number /** @description The local currency the merchant is requesting to authorize. */ - merchant_currency: string; - }; + merchant_currency: string + } /** IssuingAuthorizationRequest */ issuing_authorization_request: { /** @description The authorization amount 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: number; + amount: number /** @description Whether this request was approved. */ - approved: boolean; + approved: boolean /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description The amount that was authorized at the time of this request. This amount is in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ - merchant_amount: number; + merchant_amount: number /** @description 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: string; + merchant_currency: string /** * @description The reason for the approval or decline. * @enum {string} */ reason: - | "account_disabled" - | "card_active" - | "card_inactive" - | "cardholder_inactive" - | "cardholder_verification_required" - | "insufficient_funds" - | "not_allowed" - | "spending_controls" - | "suspected_fraud" - | "verification_failed" - | "webhook_approved" - | "webhook_declined" - | "webhook_timeout"; - }; + | 'account_disabled' + | 'card_active' + | 'card_inactive' + | 'cardholder_inactive' + | 'cardholder_verification_required' + | 'insufficient_funds' + | 'not_allowed' + | 'spending_controls' + | 'suspected_fraud' + | 'verification_failed' + | 'webhook_approved' + | 'webhook_declined' + | 'webhook_timeout' + } /** IssuingAuthorizationVerificationData */ issuing_authorization_verification_data: { /** * @description Whether the cardholder provided an address first line and if it matched the cardholder’s `billing.address.line1`. * @enum {string} */ - address_line1_check: "match" | "mismatch" | "not_provided"; + address_line1_check: 'match' | 'mismatch' | 'not_provided' /** * @description Whether the cardholder provided a postal code and if it matched the cardholder’s `billing.address.postal_code`. * @enum {string} */ - address_postal_code_check: "match" | "mismatch" | "not_provided"; + address_postal_code_check: 'match' | 'mismatch' | 'not_provided' /** * @description Whether the cardholder provided a CVC and if it matched Stripe’s record. * @enum {string} */ - cvc_check: "match" | "mismatch" | "not_provided"; + cvc_check: 'match' | 'mismatch' | 'not_provided' /** * @description Whether the cardholder provided an expiry date and if it matched Stripe’s record. * @enum {string} */ - expiry_check: "match" | "mismatch" | "not_provided"; - }; + expiry_check: 'match' | 'mismatch' | 'not_provided' + } /** IssuingCardAuthorizationControls */ issuing_card_authorization_controls: { /** @description Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations permitted on this card. */ allowed_categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] /** @description Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to always decline on this card. */ blocked_categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] /** @description Limit the spending with rules based on time intervals and categories. */ - spending_limits?: definitions["issuing_card_spending_limit"][]; + spending_limits?: definitions['issuing_card_spending_limit'][] /** @description Currency for the amounts within spending_limits. Locked to the currency of the card. */ - spending_limits_currency?: string; - }; + spending_limits_currency?: string + } /** IssuingCardShipping */ issuing_card_shipping: { - address: definitions["address"]; + address: definitions['address'] /** * @description The delivery company that shipped a card. * @enum {string} */ - carrier?: "fedex" | "usps"; + carrier?: 'fedex' | 'usps' /** @description A unix timestamp representing a best estimate of when the card will be delivered. */ - eta?: number; + eta?: number /** @description Recipient name. */ - name: string; + name: string /** * @description Shipment service, such as `standard` or `express`. * @enum {string} */ - service: "express" | "priority" | "standard"; + service: 'express' | 'priority' | 'standard' /** * @description The delivery status of the card. * @enum {string} */ - status?: "canceled" | "delivered" | "failure" | "pending" | "returned" | "shipped"; + status?: 'canceled' | 'delivered' | 'failure' | 'pending' | 'returned' | 'shipped' /** @description A tracking number for a card shipment. */ - tracking_number?: string; + tracking_number?: string /** @description A link to the shipping carrier's site where you can view detailed information about a card shipment. */ - tracking_url?: string; + tracking_url?: string /** * @description Packaging options. * @enum {string} */ - type: "bulk" | "individual"; - }; + type: 'bulk' | 'individual' + } /** IssuingCardSpendingLimit */ issuing_card_spending_limit: { /** @description Maximum amount allowed to spend per time interval. */ - amount: number; + amount: number /** @description Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) on which to apply the spending limit. Leave this blank to limit all charges. */ categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] /** * @description The time interval or event with which to apply this spending limit towards. * @enum {string} */ - interval: "all_time" | "daily" | "monthly" | "per_authorization" | "weekly" | "yearly"; - }; + interval: 'all_time' | 'daily' | 'monthly' | 'per_authorization' | 'weekly' | 'yearly' + } /** IssuingCardholderAddress */ issuing_cardholder_address: { - address: definitions["address"]; - }; + address: definitions['address'] + } /** IssuingCardholderAuthorizationControls */ issuing_cardholder_authorization_controls: { /** @description Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations permitted on this cardholder's cards. */ allowed_categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] /** @description Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to always decline on this cardholder's cards. */ blocked_categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] /** @description Limit the spending with rules based on time intervals and categories. */ - spending_limits?: definitions["issuing_cardholder_spending_limit"][]; + spending_limits?: definitions['issuing_cardholder_spending_limit'][] /** @description Currency for the amounts within spending_limits. */ - spending_limits_currency?: string; - }; + spending_limits_currency?: string + } /** IssuingCardholderCompany */ issuing_cardholder_company: { /** @description Whether the company's business ID number was provided. */ - tax_id_provided: boolean; - }; + tax_id_provided: boolean + } /** IssuingCardholderIdDocument */ issuing_cardholder_id_document: { /** @description 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?: string; + back?: string /** @description 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?: string; - }; + front?: string + } /** IssuingCardholderIndividual */ issuing_cardholder_individual: { - dob?: definitions["issuing_cardholder_individual_dob"]; + dob?: definitions['issuing_cardholder_individual_dob'] /** @description The first name of this cardholder. */ - first_name: string; + first_name: string /** @description The last name of this cardholder. */ - last_name: string; - verification?: definitions["issuing_cardholder_verification"]; - }; + last_name: string + verification?: definitions['issuing_cardholder_verification'] + } /** IssuingCardholderIndividualDOB */ issuing_cardholder_individual_dob: { /** @description The day of birth, between 1 and 31. */ - day?: number; + day?: number /** @description The month of birth, between 1 and 12. */ - month?: number; + month?: number /** @description The four-digit year of birth. */ - year?: number; - }; + year?: number + } /** IssuingCardholderRequirements */ issuing_cardholder_requirements: { /** * @description If `disabled_reason` is present, all cards will decline authorizations with `cardholder_verification_required` reason. * @enum {string} */ - disabled_reason?: "listed" | "rejected.listed" | "under_review"; + disabled_reason?: 'listed' | 'rejected.listed' | 'under_review' /** @description Array of fields that need to be collected in order to verify and re-enable the cardholder. */ past_due?: ( - | "company.tax_id" - | "individual.dob.day" - | "individual.dob.month" - | "individual.dob.year" - | "individual.first_name" - | "individual.last_name" - | "individual.verification.document" - )[]; - }; + | 'company.tax_id' + | 'individual.dob.day' + | 'individual.dob.month' + | 'individual.dob.year' + | 'individual.first_name' + | 'individual.last_name' + | 'individual.verification.document' + )[] + } /** IssuingCardholderSpendingLimit */ issuing_cardholder_spending_limit: { /** @description Maximum amount allowed to spend per time interval. */ - amount: number; + amount: number /** @description Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) on which to apply the spending limit. Leave this blank to limit all charges. */ categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] /** * @description The time interval or event with which to apply this spending limit towards. * @enum {string} */ - interval: "all_time" | "daily" | "monthly" | "per_authorization" | "weekly" | "yearly"; - }; + interval: 'all_time' | 'daily' | 'monthly' | 'per_authorization' | 'weekly' | 'yearly' + } /** IssuingCardholderVerification */ issuing_cardholder_verification: { - document?: definitions["issuing_cardholder_id_document"]; - }; + document?: definitions['issuing_cardholder_id_document'] + } /** LegalEntityCompany */ legal_entity_company: { - address?: definitions["address"]; - address_kana?: definitions["legal_entity_japan_address"]; - address_kanji?: definitions["legal_entity_japan_address"]; + address?: definitions['address'] + address_kana?: definitions['legal_entity_japan_address'] + address_kanji?: definitions['legal_entity_japan_address'] /** @description 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?: boolean; + directors_provided?: boolean /** @description 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?: boolean; + executives_provided?: boolean /** @description The company's legal name. */ - name?: string; + name?: string /** @description The Kana variation of the company's legal name (Japan only). */ - name_kana?: string; + name_kana?: string /** @description The Kanji variation of the company's legal name (Japan only). */ - name_kanji?: string; + name_kanji?: string /** @description 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?: boolean; + owners_provided?: boolean /** @description The company's phone number (used for verification). */ - phone?: string; + phone?: string /** * @description 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. * @enum {string} */ structure?: - | "government_instrumentality" - | "governmental_unit" - | "incorporated_non_profit" - | "limited_liability_partnership" - | "multi_member_llc" - | "private_company" - | "private_corporation" - | "private_partnership" - | "public_company" - | "public_corporation" - | "public_partnership" - | "sole_proprietorship" - | "tax_exempt_government_instrumentality" - | "unincorporated_association" - | "unincorporated_non_profit"; + | 'government_instrumentality' + | 'governmental_unit' + | 'incorporated_non_profit' + | 'limited_liability_partnership' + | 'multi_member_llc' + | 'private_company' + | 'private_corporation' + | 'private_partnership' + | 'public_company' + | 'public_corporation' + | 'public_partnership' + | 'sole_proprietorship' + | 'tax_exempt_government_instrumentality' + | 'unincorporated_association' + | 'unincorporated_non_profit' /** @description Whether the company's business ID number was provided. */ - tax_id_provided?: boolean; + tax_id_provided?: boolean /** @description The jurisdiction in which the `tax_id` is registered (Germany-based companies only). */ - tax_id_registrar?: string; + tax_id_registrar?: string /** @description Whether the company's business VAT number was provided. */ - vat_id_provided?: boolean; - verification?: definitions["legal_entity_company_verification"]; - }; + vat_id_provided?: boolean + verification?: definitions['legal_entity_company_verification'] + } /** LegalEntityCompanyVerification */ legal_entity_company_verification: { - document: definitions["legal_entity_company_verification_document"]; - }; + document: definitions['legal_entity_company_verification_document'] + } /** LegalEntityCompanyVerificationDocument */ legal_entity_company_verification_document: { /** @description 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?: string; + back?: string /** @description A user-displayable string describing the verification state of this document. */ - details?: string; + details?: string /** @description 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?: string; + details_code?: string /** @description 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?: string; - }; + front?: string + } /** LegalEntityDOB */ legal_entity_dob: { /** @description The day of birth, between 1 and 31. */ - day?: number; + day?: number /** @description The month of birth, between 1 and 12. */ - month?: number; + month?: number /** @description The four-digit year of birth. */ - year?: number; - }; + year?: number + } /** LegalEntityJapanAddress */ legal_entity_japan_address: { /** @description City/Ward. */ - city?: string; + city?: string /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ - country?: string; + country?: string /** @description Block/Building number. */ - line1?: string; + line1?: string /** @description Building details. */ - line2?: string; + line2?: string /** @description ZIP or postal code. */ - postal_code?: string; + postal_code?: string /** @description Prefecture. */ - state?: string; + state?: string /** @description Town/cho-me. */ - town?: string; - }; + town?: string + } /** LegalEntityPersonVerification */ legal_entity_person_verification: { - additional_document?: definitions["legal_entity_person_verification_document"]; + additional_document?: definitions['legal_entity_person_verification_document'] /** @description A user-displayable string describing the verification state for the person. For example, this may say "Provided identity information could not be verified". */ - details?: string; + details?: string /** @description 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?: string; - document?: definitions["legal_entity_person_verification_document"]; + details_code?: string + document?: definitions['legal_entity_person_verification_document'] /** @description The state of verification for the person. Possible values are `unverified`, `pending`, or `verified`. */ - status: string; - }; + status: string + } /** LegalEntityPersonVerificationDocument */ legal_entity_person_verification_document: { /** @description 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?: string; + back?: string /** @description 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?: string; + details?: string /** @description 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?: string; + details_code?: string /** @description 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?: string; - }; + front?: string + } /** LightAccountLogout */ - light_account_logout: { [key: string]: unknown }; + light_account_logout: { [key: string]: unknown } /** InvoiceLineItem */ line_item: { /** @description The amount, in %s. */ - amount: number; + amount: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description If true, discounts will apply to this line item. Always false for prorations. */ - discountable: boolean; + discountable: boolean /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The ID of the [invoice item](https://stripe.com/docs/api/invoiceitems) associated with this line item if any. */ - invoice_item?: string; + invoice_item?: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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. Note that for line items with `type=subscription` this will reflect the metadata of the subscription that caused the line item to be created. */ - metadata: { [key: string]: unknown }; + metadata: { [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "line_item"; - period: definitions["invoice_line_item_period"]; - plan?: definitions["plan"]; + object: 'line_item' + period: definitions['invoice_line_item_period'] + plan?: definitions['plan'] /** @description Whether this is a proration. */ - proration: boolean; + proration: boolean /** @description The quantity of the subscription, if the line item is a subscription or a proration. */ - quantity?: number; + quantity?: number /** @description The subscription that the invoice item pertains to, if any. */ - subscription?: string; + subscription?: string /** @description The subscription item that generated this invoice item. Left empty if the line item is not an explicit result of a subscription. */ - subscription_item?: string; + subscription_item?: string /** @description The amount of tax calculated per tax rate for this line item */ - tax_amounts?: definitions["invoice_tax_amount"][]; + tax_amounts?: definitions['invoice_tax_amount'][] /** @description The tax rates which apply to the line item. */ - tax_rates?: definitions["tax_rate"][]; + tax_rates?: definitions['tax_rate'][] /** * @description A string identifying the type of the source of this line item, either an `invoiceitem` or a `subscription`. * @enum {string} */ - type: "invoiceitem" | "subscription"; - }; + type: 'invoiceitem' | 'subscription' + } /** LoginLink */ login_link: { /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "login_link"; + object: 'login_link' /** @description The URL for the login link. */ - url: string; - }; + url: string + } /** * Mandate * @description A Mandate is a record of the permission a customer has given you to debit their payment method. */ mandate: { - customer_acceptance: definitions["customer_acceptance"]; + customer_acceptance: definitions['customer_acceptance'] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; - multi_use?: definitions["mandate_multi_use"]; + livemode: boolean + multi_use?: definitions['mandate_multi_use'] /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "mandate"; + object: 'mandate' /** @description ID of the payment method associated with this mandate. */ - payment_method: string; - payment_method_details: definitions["mandate_payment_method_details"]; - single_use?: definitions["mandate_single_use"]; + payment_method: string + payment_method_details: definitions['mandate_payment_method_details'] + single_use?: definitions['mandate_single_use'] /** * @description The status of the mandate, which indicates whether it can be used to initiate a payment. * @enum {string} */ - status: "active" | "inactive" | "pending"; + status: 'active' | 'inactive' | 'pending' /** * @description The type of the mandate. * @enum {string} */ - type: "multi_use" | "single_use"; - }; + type: 'multi_use' | 'single_use' + } /** mandate_au_becs_debit */ mandate_au_becs_debit: { /** @description The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively. */ - url: string; - }; + url: string + } /** mandate_multi_use */ - mandate_multi_use: { [key: string]: unknown }; + mandate_multi_use: { [key: string]: unknown } /** mandate_payment_method_details */ mandate_payment_method_details: { - au_becs_debit?: definitions["mandate_au_becs_debit"]; - card?: definitions["card_mandate_payment_method_details"]; - sepa_debit?: definitions["mandate_sepa_debit"]; + au_becs_debit?: definitions['mandate_au_becs_debit'] + card?: definitions['card_mandate_payment_method_details'] + sepa_debit?: definitions['mandate_sepa_debit'] /** @description The type of the payment method associated with this mandate. An additional hash is included on `payment_method_details` with a name matching this value. It contains mandate information specific to the payment method. */ - type: string; - }; + type: string + } /** mandate_sepa_debit */ mandate_sepa_debit: { /** @description The unique reference of the mandate. */ - reference: string; + reference: string /** @description The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively. */ - url: string; - }; + url: string + } /** mandate_single_use */ mandate_single_use: { /** @description On a single use mandate, the amount of the payment. */ - amount: number; + amount: number /** @description On a single use mandate, the currency of the payment. */ - currency: string; - }; + currency: string + } /** NotificationEventData */ notification_event_data: { /** @description 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: { [key: string]: unknown }; + object: { [key: string]: unknown } /** @description Object containing the names of the attributes that have changed, and their previous values (sent along only with *.updated events). */ - previous_attributes?: { [key: string]: unknown }; - }; + previous_attributes?: { [key: string]: unknown } + } /** NotificationEventRequest */ notification_event_request: { /** @description 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?: string; + id?: string /** @description 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?: string; - }; + idempotency_key?: string + } /** offline_acceptance */ - offline_acceptance: { [key: string]: unknown }; + offline_acceptance: { [key: string]: unknown } /** online_acceptance */ online_acceptance: { /** @description The IP address from which the Mandate was accepted by the customer. */ - ip_address?: string; + ip_address?: string /** @description The user agent of the browser from which the Mandate was accepted by the customer. */ - user_agent?: string; - }; + user_agent?: string + } /** * Order * @description Order objects are created to handle end customers' purchases of previously @@ -6663,68 +6646,68 @@ export interface definitions { */ order: { /** @description 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: number; + amount: number /** @description The total amount that was returned to the customer. */ - amount_returned?: number; + amount_returned?: number /** @description ID of the Connect Application that created the order. */ - application?: string; + application?: string /** @description A fee in cents that will be applied to the order and transferred to the application owner’s Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees documentation. */ - application_fee?: number; + application_fee?: number /** @description The ID of the payment used to pay for the order. Present if the order status is `paid`, `fulfilled`, or `refunded`. */ - charge?: string; + charge?: string /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description The customer used for the order. */ - customer?: string; + customer?: string /** @description The email address of the customer placing the order. */ - email?: string; + email?: string /** @description External coupon code to load for this order. */ - external_coupon_code?: string; + external_coupon_code?: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description List of items constituting the order. An order can have up to 25 items. */ - items: definitions["order_item"][]; + items: definitions['order_item'][] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: unknown }; + metadata: { [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "order"; + object: 'order' /** * OrderReturnList * @description A list of returns that have taken place for this order. */ returns?: { /** @description Details about each object. */ - data: definitions["order_return"][]; + data: definitions['order_return'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** @description The shipping method that is currently selected for this order, if any. If present, it is equal to one of the `id`s of shipping methods in the `shipping_methods` array. At order creation time, if there are multiple shipping methods, Stripe will automatically selected the first method. */ - selected_shipping_method?: string; - shipping?: definitions["shipping"]; + selected_shipping_method?: string + shipping?: definitions['shipping'] /** @description A list of supported shipping methods for this order. The desired shipping method can be specified either by updating the order, or when paying it. */ - shipping_methods?: definitions["shipping_method"][]; + shipping_methods?: definitions['shipping_method'][] /** @description Current order status. One of `created`, `paid`, `canceled`, `fulfilled`, or `returned`. More details in the [Orders Guide](https://stripe.com/docs/orders/guide#understanding-order-statuses). */ - status: string; - status_transitions?: definitions["status_transitions"]; + status: string + status_transitions?: definitions['status_transitions'] /** @description Time at which the object was last updated. Measured in seconds since the Unix epoch. */ - updated?: number; + updated?: number /** @description The user's order ID if it is different from the Stripe order ID. */ - upstream_id?: string; - }; + upstream_id?: string + } /** * OrderItem * @description A representation of the constituent items of any given order. Can be used to @@ -6734,23 +6717,23 @@ export interface definitions { */ order_item: { /** @description 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 line item. */ - amount: number; + amount: number /** @description 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: string; + currency: string /** @description Description of the line item, meant to be displayable to the user (e.g., `"Express shipping"`). */ - description: string; + description: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "order_item"; + object: 'order_item' /** @description The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a SKU). */ - parent?: string; + parent?: string /** @description A positive integer representing the number of instances of `parent` that are included in this order item. Applicable/present only if `type` is `sku`. */ - quantity?: number; + quantity?: number /** @description The type of line item. One of `sku`, `tax`, `shipping`, or `discount`. */ - type: string; - }; + type: string + } /** * OrderReturn * @description A return represents the full or partial return of a number of [order items](https://stripe.com/docs/api#order_items). @@ -6760,38 +6743,38 @@ export interface definitions { */ order_return: { /** @description 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 returned line item. */ - amount: number; + amount: number /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The items included in this order return. */ - items: definitions["order_item"][]; + items: definitions['order_item'][] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "order_return"; + object: 'order_return' /** @description The order that this return includes items from. */ - order?: string; + order?: string /** @description The ID of the refund issued for this return. */ - refund?: string; - }; + refund?: string + } /** PackageDimensions */ package_dimensions: { /** @description Height, in inches. */ - height: number; + height: number /** @description Length, in inches. */ - length: number; + length: number /** @description Weight, in ounces. */ - weight: number; + weight: number /** @description Width, in inches. */ - width: number; - }; + width: number + } /** * PaymentIntent * @description A PaymentIntent guides you through the process of collecting a payment from your customer. @@ -6808,51 +6791,44 @@ export interface definitions { */ payment_intent: { /** @description 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: number; + amount: number /** @description Amount that can be captured from this PaymentIntent. */ - amount_capturable?: number; + amount_capturable?: number /** @description Amount that was collected by this PaymentIntent. */ - amount_received?: number; + amount_received?: number /** @description ID of the Connect application that created the PaymentIntent. */ - application?: string; + application?: string /** @description The amount of the application fee (if any) for the resulting payment. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. */ - application_fee_amount?: number; + application_fee_amount?: number /** @description Populated when `status` is `canceled`, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch. */ - canceled_at?: number; + canceled_at?: number /** * @description 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`). * @enum {string} */ - cancellation_reason?: - | "abandoned" - | "automatic" - | "duplicate" - | "failed_invoice" - | "fraudulent" - | "requested_by_customer" - | "void_invoice"; + cancellation_reason?: 'abandoned' | 'automatic' | 'duplicate' | 'failed_invoice' | 'fraudulent' | 'requested_by_customer' | 'void_invoice' /** * @description Controls when the funds will be captured from the customer's account. * @enum {string} */ - capture_method: "automatic" | "manual"; + capture_method: 'automatic' | 'manual' /** * PaymentFlowsPaymentIntentResourceChargeList * @description Charges that were created by this PaymentIntent, if any. */ charges?: { /** @description This list only contains the latest charge, even if there were previously multiple unsuccessful charges. To view all previous charges for a PaymentIntent, you can filter the charges list using the `payment_intent` [parameter](https://stripe.com/docs/api/charges/list#list_charges-payment_intent). */ - data: definitions["charge"][]; + data: definitions['charge'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** * @description The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key. * @@ -6860,13 +6836,13 @@ export interface definitions { * * Refer to our docs to [accept a payment](https://stripe.com/docs/payments/accept-a-payment) and learn about how `client_secret` should be handled. */ - client_secret?: string; + client_secret?: string /** @enum {string} */ - confirmation_method: "automatic" | "manual"; + confirmation_method: 'automatic' | 'manual' /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** * @description ID of the Customer this PaymentIntent belongs to, if one exists. * @@ -6874,35 +6850,35 @@ export interface definitions { * * If present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. */ - customer?: string; + customer?: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description ID of the invoice that created this PaymentIntent, if it exists. */ - invoice?: string; - last_payment_error?: definitions["api_errors"]; + invoice?: string + last_payment_error?: definitions['api_errors'] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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. For more information, see the [documentation](https://stripe.com/docs/payments/payment-intents/creating-payment-intents#storing-information-in-metadata). */ - metadata?: { [key: string]: unknown }; - next_action?: definitions["payment_intent_next_action"]; + metadata?: { [key: string]: unknown } + next_action?: definitions['payment_intent_next_action'] /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "payment_intent"; + object: 'payment_intent' /** @description 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?: string; + on_behalf_of?: string /** @description ID of the payment method used in this PaymentIntent. */ - payment_method?: string; - payment_method_options?: definitions["payment_intent_payment_method_options"]; + payment_method?: string + payment_method_options?: definitions['payment_intent_payment_method_options'] /** @description The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. */ - payment_method_types: string[]; + payment_method_types: string[] /** @description Email address that the receipt for the resulting payment will be sent to. */ - receipt_email?: string; + receipt_email?: string /** @description ID of the review associated with this PaymentIntent, if any. */ - review?: string; + review?: string /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * @@ -6911,56 +6887,49 @@ export interface definitions { * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ - setup_future_usage?: "off_session" | "on_session"; - shipping?: definitions["shipping"]; + setup_future_usage?: 'off_session' | 'on_session' + shipping?: definitions['shipping'] /** @description For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - statement_descriptor_suffix?: string; + statement_descriptor_suffix?: string /** * @description 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). * @enum {string} */ - status: - | "canceled" - | "processing" - | "requires_action" - | "requires_capture" - | "requires_confirmation" - | "requires_payment_method" - | "succeeded"; - transfer_data?: definitions["transfer_data"]; + status: 'canceled' | 'processing' | 'requires_action' | 'requires_capture' | 'requires_confirmation' | 'requires_payment_method' | 'succeeded' + transfer_data?: definitions['transfer_data'] /** @description A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. */ - transfer_group?: string; - }; + transfer_group?: string + } /** PaymentIntentNextAction */ payment_intent_next_action: { - redirect_to_url?: definitions["payment_intent_next_action_redirect_to_url"]; + redirect_to_url?: definitions['payment_intent_next_action_redirect_to_url'] /** @description Type of the next action to perform, one of `redirect_to_url` or `use_stripe_sdk`. */ - type: string; + type: string /** @description 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?: { [key: string]: unknown }; - }; + use_stripe_sdk?: { [key: string]: unknown } + } /** PaymentIntentNextActionRedirectToUrl */ payment_intent_next_action_redirect_to_url: { /** @description If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion. */ - return_url?: string; + return_url?: string /** @description The URL you must redirect your customer to in order to authenticate the payment. */ - url?: string; - }; + url?: string + } /** PaymentIntentPaymentMethodOptions */ payment_intent_payment_method_options: { - card?: definitions["payment_intent_payment_method_options_card"]; - }; + card?: definitions['payment_intent_payment_method_options_card'] + } /** payment_intent_payment_method_options_card */ payment_intent_payment_method_options_card: { - installments?: definitions["payment_method_options_card_installments"]; + installments?: definitions['payment_method_options_card_installments'] /** * @description 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. Permitted values include: `automatic` or `any`. If not provided, defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. * @enum {string} */ - request_three_d_secure?: "any" | "automatic" | "challenge_only"; - }; + request_three_d_secure?: 'any' | 'automatic' | 'challenge_only' + } /** * PaymentMethod * @description PaymentMethod objects represent your customer's payment instruments. @@ -6970,363 +6939,363 @@ export interface definitions { * Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios). */ payment_method: { - au_becs_debit?: definitions["payment_method_au_becs_debit"]; - billing_details: definitions["billing_details"]; - card?: definitions["payment_method_card"]; - card_present?: definitions["payment_method_card_present"]; + au_becs_debit?: definitions['payment_method_au_becs_debit'] + billing_details: definitions['billing_details'] + card?: definitions['payment_method_card'] + card_present?: definitions['payment_method_card_present'] /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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?: string; - fpx?: definitions["payment_method_fpx"]; + customer?: string + fpx?: definitions['payment_method_fpx'] /** @description Unique identifier for the object. */ - id: string; - ideal?: definitions["payment_method_ideal"]; + id: string + ideal?: definitions['payment_method_ideal'] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: unknown }; + metadata: { [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "payment_method"; - sepa_debit?: definitions["payment_method_sepa_debit"]; + object: 'payment_method' + sepa_debit?: definitions['payment_method_sepa_debit'] /** * @description 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. * @enum {string} */ - type: "au_becs_debit" | "card" | "fpx" | "ideal" | "sepa_debit"; - }; + type: 'au_becs_debit' | 'card' | 'fpx' | 'ideal' | 'sepa_debit' + } /** payment_method_au_becs_debit */ payment_method_au_becs_debit: { /** @description Six-digit number identifying bank and branch associated with this bank account. */ - bsb_number?: string; + bsb_number?: string /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string; + fingerprint?: string /** @description Last four digits of the bank account number. */ - last4?: string; - }; + last4?: string + } /** payment_method_card */ payment_method_card: { /** @description Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ - brand: string; - checks?: definitions["payment_method_card_checks"]; + brand: string + checks?: definitions['payment_method_card_checks'] /** @description 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?: string; + country?: string /** @description Two-digit number representing the card's expiration month. */ - exp_month: number; + exp_month: number /** @description Four-digit number representing the card's expiration year. */ - exp_year: number; + exp_year: number /** @description 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. */ - fingerprint?: string; + fingerprint?: string /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ - funding: string; - generated_from?: definitions["payment_method_card_generated_card"]; + funding: string + generated_from?: definitions['payment_method_card_generated_card'] /** @description The last four digits of the card. */ - last4: string; - three_d_secure_usage?: definitions["three_d_secure_usage"]; - wallet?: definitions["payment_method_card_wallet"]; - }; + last4: string + three_d_secure_usage?: definitions['three_d_secure_usage'] + wallet?: definitions['payment_method_card_wallet'] + } /** payment_method_card_checks */ payment_method_card_checks: { /** @description If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ - address_line1_check?: string; + address_line1_check?: string /** @description If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ - address_postal_code_check?: string; + address_postal_code_check?: string /** @description If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ - cvc_check?: string; - }; + cvc_check?: string + } /** payment_method_card_generated_card */ payment_method_card_generated_card: { /** @description The charge that created this object. */ - charge?: string; - payment_method_details?: definitions["payment_method_details"]; - }; + charge?: string + payment_method_details?: definitions['payment_method_details'] + } /** payment_method_card_present */ - payment_method_card_present: { [key: string]: unknown }; + payment_method_card_present: { [key: string]: unknown } /** payment_method_card_wallet */ payment_method_card_wallet: { - amex_express_checkout?: definitions["payment_method_card_wallet_amex_express_checkout"]; - apple_pay?: definitions["payment_method_card_wallet_apple_pay"]; + amex_express_checkout?: definitions['payment_method_card_wallet_amex_express_checkout'] + apple_pay?: definitions['payment_method_card_wallet_apple_pay'] /** @description (For tokenized numbers only.) The last four digits of the device account number. */ - dynamic_last4?: string; - google_pay?: definitions["payment_method_card_wallet_google_pay"]; - masterpass?: definitions["payment_method_card_wallet_masterpass"]; - samsung_pay?: definitions["payment_method_card_wallet_samsung_pay"]; + dynamic_last4?: string + google_pay?: definitions['payment_method_card_wallet_google_pay'] + masterpass?: definitions['payment_method_card_wallet_masterpass'] + samsung_pay?: definitions['payment_method_card_wallet_samsung_pay'] /** * @description The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, or `visa_checkout`. 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. * @enum {string} */ - type: "amex_express_checkout" | "apple_pay" | "google_pay" | "masterpass" | "samsung_pay" | "visa_checkout"; - visa_checkout?: definitions["payment_method_card_wallet_visa_checkout"]; - }; + type: 'amex_express_checkout' | 'apple_pay' | 'google_pay' | 'masterpass' | 'samsung_pay' | 'visa_checkout' + visa_checkout?: definitions['payment_method_card_wallet_visa_checkout'] + } /** payment_method_card_wallet_amex_express_checkout */ - payment_method_card_wallet_amex_express_checkout: { [key: string]: unknown }; + payment_method_card_wallet_amex_express_checkout: { [key: string]: unknown } /** payment_method_card_wallet_apple_pay */ - payment_method_card_wallet_apple_pay: { [key: string]: unknown }; + payment_method_card_wallet_apple_pay: { [key: string]: unknown } /** payment_method_card_wallet_google_pay */ - payment_method_card_wallet_google_pay: { [key: string]: unknown }; + payment_method_card_wallet_google_pay: { [key: string]: unknown } /** payment_method_card_wallet_masterpass */ payment_method_card_wallet_masterpass: { - billing_address?: definitions["address"]; + billing_address?: definitions['address'] /** @description 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?: string; + email?: string /** @description 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?: string; - shipping_address?: definitions["address"]; - }; + name?: string + shipping_address?: definitions['address'] + } /** payment_method_card_wallet_samsung_pay */ - payment_method_card_wallet_samsung_pay: { [key: string]: unknown }; + payment_method_card_wallet_samsung_pay: { [key: string]: unknown } /** payment_method_card_wallet_visa_checkout */ payment_method_card_wallet_visa_checkout: { - billing_address?: definitions["address"]; + billing_address?: definitions['address'] /** @description 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?: string; + email?: string /** @description 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?: string; - shipping_address?: definitions["address"]; - }; + name?: string + shipping_address?: definitions['address'] + } /** payment_method_details */ payment_method_details: { - ach_credit_transfer?: definitions["payment_method_details_ach_credit_transfer"]; - ach_debit?: definitions["payment_method_details_ach_debit"]; - alipay?: definitions["payment_method_details_alipay"]; - au_becs_debit?: definitions["payment_method_details_au_becs_debit"]; - bancontact?: definitions["payment_method_details_bancontact"]; - card?: definitions["payment_method_details_card"]; - card_present?: definitions["payment_method_details_card_present"]; - eps?: definitions["payment_method_details_eps"]; - fpx?: definitions["payment_method_details_fpx"]; - giropay?: definitions["payment_method_details_giropay"]; - ideal?: definitions["payment_method_details_ideal"]; - klarna?: definitions["payment_method_details_klarna"]; - multibanco?: definitions["payment_method_details_multibanco"]; - p24?: definitions["payment_method_details_p24"]; - sepa_debit?: definitions["payment_method_details_sepa_debit"]; - sofort?: definitions["payment_method_details_sofort"]; - stripe_account?: definitions["payment_method_details_stripe_account"]; + ach_credit_transfer?: definitions['payment_method_details_ach_credit_transfer'] + ach_debit?: definitions['payment_method_details_ach_debit'] + alipay?: definitions['payment_method_details_alipay'] + au_becs_debit?: definitions['payment_method_details_au_becs_debit'] + bancontact?: definitions['payment_method_details_bancontact'] + card?: definitions['payment_method_details_card'] + card_present?: definitions['payment_method_details_card_present'] + eps?: definitions['payment_method_details_eps'] + fpx?: definitions['payment_method_details_fpx'] + giropay?: definitions['payment_method_details_giropay'] + ideal?: definitions['payment_method_details_ideal'] + klarna?: definitions['payment_method_details_klarna'] + multibanco?: definitions['payment_method_details_multibanco'] + p24?: definitions['payment_method_details_p24'] + sepa_debit?: definitions['payment_method_details_sepa_debit'] + sofort?: definitions['payment_method_details_sofort'] + stripe_account?: definitions['payment_method_details_stripe_account'] /** * @description The type of transaction-specific details of the payment method used in the payment, one of `ach_credit_transfer`, `ach_debit`, `alipay`, `au_becs_debit`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `klarna`, `multibanco`, `p24`, `sepa_debit`, `sofort`, `stripe_account`, or `wechat`. * An additional hash is included on `payment_method_details` with a name matching this value. * It contains information specific to the payment method. */ - type: string; - wechat?: definitions["payment_method_details_wechat"]; - }; + type: string + wechat?: definitions['payment_method_details_wechat'] + } /** payment_method_details_ach_credit_transfer */ payment_method_details_ach_credit_transfer: { /** @description Account number to transfer funds to. */ - account_number?: string; + account_number?: string /** @description Name of the bank associated with the routing number. */ - bank_name?: string; + bank_name?: string /** @description Routing transit number for the bank account to transfer funds to. */ - routing_number?: string; + routing_number?: string /** @description SWIFT code of the bank associated with the routing number. */ - swift_code?: string; - }; + swift_code?: string + } /** payment_method_details_ach_debit */ payment_method_details_ach_debit: { /** * @description Type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - account_holder_type?: "company" | "individual"; + account_holder_type?: 'company' | 'individual' /** @description Name of the bank associated with the bank account. */ - bank_name?: string; + bank_name?: string /** @description Two-letter ISO code representing the country the bank account is located in. */ - country?: string; + country?: string /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string; + fingerprint?: string /** @description Last four digits of the bank account number. */ - last4?: string; + last4?: string /** @description Routing transit number of the bank account. */ - routing_number?: string; - }; + routing_number?: string + } /** payment_method_details_alipay */ - payment_method_details_alipay: { [key: string]: unknown }; + payment_method_details_alipay: { [key: string]: unknown } /** payment_method_details_au_becs_debit */ payment_method_details_au_becs_debit: { /** @description Bank-State-Branch number of the bank account. */ - bsb_number?: string; + bsb_number?: string /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string; + fingerprint?: string /** @description Last four digits of the bank account number. */ - last4?: string; + last4?: string /** @description ID of the mandate used to make this payment. */ - mandate?: string; - }; + mandate?: string + } /** payment_method_details_bancontact */ payment_method_details_bancontact: { /** @description Bank code of bank associated with the bank account. */ - bank_code?: string; + bank_code?: string /** @description Name of the bank associated with the bank account. */ - bank_name?: string; + bank_name?: string /** @description Bank Identifier Code of the bank associated with the bank account. */ - bic?: string; + bic?: string /** @description Last four characters of the IBAN. */ - iban_last4?: string; + iban_last4?: string /** * @description Preferred language of the Bancontact authorization page that the customer is redirected to. * Can be one of `en`, `de`, `fr`, or `nl` * @enum {string} */ - preferred_language?: "de" | "en" | "fr" | "nl"; + preferred_language?: 'de' | 'en' | 'fr' | 'nl' /** * @description Owner's verified full name. Values are verified or provided by Bancontact directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - verified_name?: string; - }; + verified_name?: string + } /** payment_method_details_card */ payment_method_details_card: { /** @description Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ - brand?: string; - checks?: definitions["payment_method_details_card_checks"]; + brand?: string + checks?: definitions['payment_method_details_card_checks'] /** @description 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?: string; + country?: string /** @description Two-digit number representing the card's expiration month. */ - exp_month?: number; + exp_month?: number /** @description Four-digit number representing the card's expiration year. */ - exp_year?: number; + exp_year?: number /** @description 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. */ - fingerprint?: string; + fingerprint?: string /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ - funding?: string; - installments?: definitions["payment_method_details_card_installments"]; + funding?: string + installments?: definitions['payment_method_details_card_installments'] /** @description The last four digits of the card. */ - last4?: string; + last4?: string /** @description Identifies which network this charge was processed on. Can be `amex`, `diners`, `discover`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ - network?: string; - three_d_secure?: definitions["three_d_secure_details"]; - wallet?: definitions["payment_method_details_card_wallet"]; - }; + network?: string + three_d_secure?: definitions['three_d_secure_details'] + wallet?: definitions['payment_method_details_card_wallet'] + } /** payment_method_details_card_checks */ payment_method_details_card_checks: { /** @description If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ - address_line1_check?: string; + address_line1_check?: string /** @description If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ - address_postal_code_check?: string; + address_postal_code_check?: string /** @description If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ - cvc_check?: string; - }; + cvc_check?: string + } /** payment_method_details_card_installments */ payment_method_details_card_installments: { - plan?: definitions["payment_method_details_card_installments_plan"]; - }; + plan?: definitions['payment_method_details_card_installments_plan'] + } /** payment_method_details_card_installments_plan */ payment_method_details_card_installments_plan: { /** @description For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card. */ - count?: number; + count?: number /** * @description For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card. * One of `month`. * @enum {string} */ - interval?: "month"; + interval?: 'month' /** * @description Type of installment plan, one of `fixed_count`. * @enum {string} */ - type: "fixed_count"; - }; + type: 'fixed_count' + } /** payment_method_details_card_present */ payment_method_details_card_present: { /** @description Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ - brand?: string; + brand?: string /** @description 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 (`/`). */ - cardholder_name?: string; + cardholder_name?: string /** @description 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?: string; + country?: string /** @description Authorization response cryptogram. */ - emv_auth_data?: string; + emv_auth_data?: string /** @description Two-digit number representing the card's expiration month. */ - exp_month?: number; + exp_month?: number /** @description Four-digit number representing the card's expiration year. */ - exp_year?: number; + exp_year?: number /** @description 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. */ - fingerprint?: string; + fingerprint?: string /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ - funding?: string; + funding?: string /** @description 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?: string; + generated_card?: string /** @description The last four digits of the card. */ - last4?: string; + last4?: string /** @description Identifies which network this charge was processed on. Can be `amex`, `diners`, `discover`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ - network?: string; + network?: string /** @description How were card details read in this transaction. Can be contact_emv, contactless_emv, magnetic_stripe_fallback, magnetic_stripe_track2, or contactless_magstripe_mode */ - read_method?: string; - receipt?: definitions["payment_method_details_card_present_receipt"]; - }; + read_method?: string + receipt?: definitions['payment_method_details_card_present_receipt'] + } /** payment_method_details_card_present_receipt */ payment_method_details_card_present_receipt: { /** @description EMV tag 9F26, cryptogram generated by the integrated circuit chip. */ - application_cryptogram?: string; + application_cryptogram?: string /** @description Mnenomic of the Application Identifier. */ - application_preferred_name?: string; + application_preferred_name?: string /** @description Identifier for this transaction. */ - authorization_code?: string; + authorization_code?: string /** @description EMV tag 8A. A code returned by the card issuer. */ - authorization_response_code?: string; + authorization_response_code?: string /** @description How the cardholder verified ownership of the card. */ - cardholder_verification_method?: string; + cardholder_verification_method?: string /** @description EMV tag 84. Similar to the application identifier stored on the integrated circuit chip. */ - dedicated_file_name?: string; + dedicated_file_name?: string /** @description The outcome of a series of EMV functions performed by the card reader. */ - terminal_verification_results?: string; + terminal_verification_results?: string /** @description An indication of various EMV functions performed during the transaction. */ - transaction_status_information?: string; - }; + transaction_status_information?: string + } /** payment_method_details_card_wallet */ payment_method_details_card_wallet: { - amex_express_checkout?: definitions["payment_method_details_card_wallet_amex_express_checkout"]; - apple_pay?: definitions["payment_method_details_card_wallet_apple_pay"]; + amex_express_checkout?: definitions['payment_method_details_card_wallet_amex_express_checkout'] + apple_pay?: definitions['payment_method_details_card_wallet_apple_pay'] /** @description (For tokenized numbers only.) The last four digits of the device account number. */ - dynamic_last4?: string; - google_pay?: definitions["payment_method_details_card_wallet_google_pay"]; - masterpass?: definitions["payment_method_details_card_wallet_masterpass"]; - samsung_pay?: definitions["payment_method_details_card_wallet_samsung_pay"]; + dynamic_last4?: string + google_pay?: definitions['payment_method_details_card_wallet_google_pay'] + masterpass?: definitions['payment_method_details_card_wallet_masterpass'] + samsung_pay?: definitions['payment_method_details_card_wallet_samsung_pay'] /** * @description The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, or `visa_checkout`. 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. * @enum {string} */ - type: "amex_express_checkout" | "apple_pay" | "google_pay" | "masterpass" | "samsung_pay" | "visa_checkout"; - visa_checkout?: definitions["payment_method_details_card_wallet_visa_checkout"]; - }; + type: 'amex_express_checkout' | 'apple_pay' | 'google_pay' | 'masterpass' | 'samsung_pay' | 'visa_checkout' + visa_checkout?: definitions['payment_method_details_card_wallet_visa_checkout'] + } /** payment_method_details_card_wallet_amex_express_checkout */ - payment_method_details_card_wallet_amex_express_checkout: { [key: string]: unknown }; + payment_method_details_card_wallet_amex_express_checkout: { [key: string]: unknown } /** payment_method_details_card_wallet_apple_pay */ - payment_method_details_card_wallet_apple_pay: { [key: string]: unknown }; + payment_method_details_card_wallet_apple_pay: { [key: string]: unknown } /** payment_method_details_card_wallet_google_pay */ - payment_method_details_card_wallet_google_pay: { [key: string]: unknown }; + payment_method_details_card_wallet_google_pay: { [key: string]: unknown } /** payment_method_details_card_wallet_masterpass */ payment_method_details_card_wallet_masterpass: { - billing_address?: definitions["address"]; + billing_address?: definitions['address'] /** @description 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?: string; + email?: string /** @description 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?: string; - shipping_address?: definitions["address"]; - }; + name?: string + shipping_address?: definitions['address'] + } /** payment_method_details_card_wallet_samsung_pay */ - payment_method_details_card_wallet_samsung_pay: { [key: string]: unknown }; + payment_method_details_card_wallet_samsung_pay: { [key: string]: unknown } /** payment_method_details_card_wallet_visa_checkout */ payment_method_details_card_wallet_visa_checkout: { - billing_address?: definitions["address"]; + billing_address?: definitions['address'] /** @description 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?: string; + email?: string /** @description 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?: string; - shipping_address?: definitions["address"]; - }; + name?: string + shipping_address?: definitions['address'] + } /** payment_method_details_eps */ payment_method_details_eps: { /** * @description Owner's verified full name. Values are verified or provided by EPS directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - verified_name?: string; - }; + verified_name?: string + } /** payment_method_details_fpx */ payment_method_details_fpx: { /** @@ -7334,43 +7303,43 @@ export interface definitions { * @enum {string} */ bank: - | "affin_bank" - | "alliance_bank" - | "ambank" - | "bank_islam" - | "bank_muamalat" - | "bank_rakyat" - | "bsn" - | "cimb" - | "deutsche_bank" - | "hong_leong_bank" - | "hsbc" - | "kfh" - | "maybank2e" - | "maybank2u" - | "ocbc" - | "pb_enterprise" - | "public_bank" - | "rhb" - | "standard_chartered" - | "uob"; + | 'affin_bank' + | 'alliance_bank' + | 'ambank' + | 'bank_islam' + | 'bank_muamalat' + | 'bank_rakyat' + | 'bsn' + | 'cimb' + | 'deutsche_bank' + | 'hong_leong_bank' + | 'hsbc' + | 'kfh' + | 'maybank2e' + | 'maybank2u' + | 'ocbc' + | 'pb_enterprise' + | 'public_bank' + | 'rhb' + | 'standard_chartered' + | 'uob' /** @description Unique transaction id generated by FPX for every request from the merchant */ - transaction_id?: string; - }; + transaction_id?: string + } /** payment_method_details_giropay */ payment_method_details_giropay: { /** @description Bank code of bank associated with the bank account. */ - bank_code?: string; + bank_code?: string /** @description Name of the bank associated with the bank account. */ - bank_name?: string; + bank_name?: string /** @description Bank Identifier Code of the bank associated with the bank account. */ - bic?: string; + bic?: string /** * @description Owner's verified full name. Values are verified or provided by Giropay directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - verified_name?: string; - }; + verified_name?: string + } /** payment_method_details_ideal */ payment_method_details_ideal: { /** @@ -7378,99 +7347,99 @@ export interface definitions { * @enum {string} */ bank?: - | "abn_amro" - | "asn_bank" - | "bunq" - | "handelsbanken" - | "ing" - | "knab" - | "moneyou" - | "rabobank" - | "regiobank" - | "sns_bank" - | "triodos_bank" - | "van_lanschot"; + | 'abn_amro' + | 'asn_bank' + | 'bunq' + | 'handelsbanken' + | 'ing' + | 'knab' + | 'moneyou' + | 'rabobank' + | 'regiobank' + | 'sns_bank' + | 'triodos_bank' + | 'van_lanschot' /** * @description The Bank Identifier Code of the customer's bank. * @enum {string} */ bic?: - | "ABNANL2A" - | "ASNBNL21" - | "BUNQNL2A" - | "FVLBNL22" - | "HANDNL2A" - | "INGBNL2A" - | "KNABNL2H" - | "MOYONL21" - | "RABONL2U" - | "RBRBNL21" - | "SNSBNL2A" - | "TRIONL2U"; + | 'ABNANL2A' + | 'ASNBNL21' + | 'BUNQNL2A' + | 'FVLBNL22' + | 'HANDNL2A' + | 'INGBNL2A' + | 'KNABNL2H' + | 'MOYONL21' + | 'RABONL2U' + | 'RBRBNL21' + | 'SNSBNL2A' + | 'TRIONL2U' /** @description Last four characters of the IBAN. */ - iban_last4?: string; + iban_last4?: string /** * @description Owner's verified full name. Values are verified or provided by iDEAL directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - verified_name?: string; - }; + verified_name?: string + } /** payment_method_details_klarna */ - payment_method_details_klarna: { [key: string]: unknown }; + payment_method_details_klarna: { [key: string]: unknown } /** payment_method_details_multibanco */ payment_method_details_multibanco: { /** @description Entity number associated with this Multibanco payment. */ - entity?: string; + entity?: string /** @description Reference number associated with this Multibanco payment. */ - reference?: string; - }; + reference?: string + } /** payment_method_details_p24 */ payment_method_details_p24: { /** @description Unique reference for this Przelewy24 payment. */ - reference?: string; + reference?: string /** * @description Owner's verified full name. Values are verified or provided by Przelewy24 directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - verified_name?: string; - }; + verified_name?: string + } /** payment_method_details_sepa_debit */ payment_method_details_sepa_debit: { /** @description Bank code of bank associated with the bank account. */ - bank_code?: string; + bank_code?: string /** @description Branch code of bank associated with the bank account. */ - branch_code?: string; + branch_code?: string /** @description Two-letter ISO code representing the country the bank account is located in. */ - country?: string; + country?: string /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string; + fingerprint?: string /** @description Last four characters of the IBAN. */ - last4?: string; + last4?: string /** @description ID of the mandate used to make this payment. */ - mandate?: string; - }; + mandate?: string + } /** payment_method_details_sofort */ payment_method_details_sofort: { /** @description Bank code of bank associated with the bank account. */ - bank_code?: string; + bank_code?: string /** @description Name of the bank associated with the bank account. */ - bank_name?: string; + bank_name?: string /** @description Bank Identifier Code of the bank associated with the bank account. */ - bic?: string; + bic?: string /** @description Two-letter ISO code representing the country the bank account is located in. */ - country?: string; + country?: string /** @description Last four characters of the IBAN. */ - iban_last4?: string; + iban_last4?: string /** * @description Owner's verified full name. Values are verified or provided by SOFORT directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - verified_name?: string; - }; + verified_name?: string + } /** payment_method_details_stripe_account */ - payment_method_details_stripe_account: { [key: string]: unknown }; + payment_method_details_stripe_account: { [key: string]: unknown } /** payment_method_details_wechat */ - payment_method_details_wechat: { [key: string]: unknown }; + payment_method_details_wechat: { [key: string]: unknown } /** payment_method_fpx */ payment_method_fpx: { /** @@ -7478,27 +7447,27 @@ export interface definitions { * @enum {string} */ bank: - | "affin_bank" - | "alliance_bank" - | "ambank" - | "bank_islam" - | "bank_muamalat" - | "bank_rakyat" - | "bsn" - | "cimb" - | "deutsche_bank" - | "hong_leong_bank" - | "hsbc" - | "kfh" - | "maybank2e" - | "maybank2u" - | "ocbc" - | "pb_enterprise" - | "public_bank" - | "rhb" - | "standard_chartered" - | "uob"; - }; + | 'affin_bank' + | 'alliance_bank' + | 'ambank' + | 'bank_islam' + | 'bank_muamalat' + | 'bank_rakyat' + | 'bsn' + | 'cimb' + | 'deutsche_bank' + | 'hong_leong_bank' + | 'hsbc' + | 'kfh' + | 'maybank2e' + | 'maybank2u' + | 'ocbc' + | 'pb_enterprise' + | 'public_bank' + | 'rhb' + | 'standard_chartered' + | 'uob' + } /** payment_method_ideal */ payment_method_ideal: { /** @@ -7506,57 +7475,57 @@ export interface definitions { * @enum {string} */ bank?: - | "abn_amro" - | "asn_bank" - | "bunq" - | "handelsbanken" - | "ing" - | "knab" - | "moneyou" - | "rabobank" - | "regiobank" - | "sns_bank" - | "triodos_bank" - | "van_lanschot"; + | 'abn_amro' + | 'asn_bank' + | 'bunq' + | 'handelsbanken' + | 'ing' + | 'knab' + | 'moneyou' + | 'rabobank' + | 'regiobank' + | 'sns_bank' + | 'triodos_bank' + | 'van_lanschot' /** * @description The Bank Identifier Code of the customer's bank, if the bank was provided. * @enum {string} */ bic?: - | "ABNANL2A" - | "ASNBNL21" - | "BUNQNL2A" - | "FVLBNL22" - | "HANDNL2A" - | "INGBNL2A" - | "KNABNL2H" - | "MOYONL21" - | "RABONL2U" - | "RBRBNL21" - | "SNSBNL2A" - | "TRIONL2U"; - }; + | 'ABNANL2A' + | 'ASNBNL21' + | 'BUNQNL2A' + | 'FVLBNL22' + | 'HANDNL2A' + | 'INGBNL2A' + | 'KNABNL2H' + | 'MOYONL21' + | 'RABONL2U' + | 'RBRBNL21' + | 'SNSBNL2A' + | 'TRIONL2U' + } /** payment_method_options_card_installments */ payment_method_options_card_installments: { /** @description Installment plans that may be selected for this PaymentIntent. */ - available_plans?: definitions["payment_method_details_card_installments_plan"][]; + available_plans?: definitions['payment_method_details_card_installments_plan'][] /** @description Whether Installments are enabled for this PaymentIntent. */ - enabled: boolean; - plan?: definitions["payment_method_details_card_installments_plan"]; - }; + enabled: boolean + plan?: definitions['payment_method_details_card_installments_plan'] + } /** payment_method_sepa_debit */ payment_method_sepa_debit: { /** @description Bank code of bank associated with the bank account. */ - bank_code?: string; + bank_code?: string /** @description Branch code of bank associated with the bank account. */ - branch_code?: string; + branch_code?: string /** @description Two-letter ISO code representing the country the bank account is located in. */ - country?: string; + country?: string /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string; + fingerprint?: string /** @description Last four characters of the IBAN. */ - last4?: string; - }; + last4?: string + } /** PaymentPagesPaymentPageResourcesShippingAddressCollection */ payment_pages_payment_page_resources_shipping_address_collection: { /** @@ -7564,257 +7533,257 @@ export interface definitions { * shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI`. */ allowed_countries: ( - | "AC" - | "AD" - | "AE" - | "AF" - | "AG" - | "AI" - | "AL" - | "AM" - | "AO" - | "AQ" - | "AR" - | "AT" - | "AU" - | "AW" - | "AX" - | "AZ" - | "BA" - | "BB" - | "BD" - | "BE" - | "BF" - | "BG" - | "BH" - | "BI" - | "BJ" - | "BL" - | "BM" - | "BN" - | "BO" - | "BQ" - | "BR" - | "BS" - | "BT" - | "BV" - | "BW" - | "BY" - | "BZ" - | "CA" - | "CD" - | "CF" - | "CG" - | "CH" - | "CI" - | "CK" - | "CL" - | "CM" - | "CN" - | "CO" - | "CR" - | "CV" - | "CW" - | "CY" - | "CZ" - | "DE" - | "DJ" - | "DK" - | "DM" - | "DO" - | "DZ" - | "EC" - | "EE" - | "EG" - | "EH" - | "ER" - | "ES" - | "ET" - | "FI" - | "FJ" - | "FK" - | "FO" - | "FR" - | "GA" - | "GB" - | "GD" - | "GE" - | "GF" - | "GG" - | "GH" - | "GI" - | "GL" - | "GM" - | "GN" - | "GP" - | "GQ" - | "GR" - | "GS" - | "GT" - | "GU" - | "GW" - | "GY" - | "HK" - | "HN" - | "HR" - | "HT" - | "HU" - | "ID" - | "IE" - | "IL" - | "IM" - | "IN" - | "IO" - | "IQ" - | "IS" - | "IT" - | "JE" - | "JM" - | "JO" - | "JP" - | "KE" - | "KG" - | "KH" - | "KI" - | "KM" - | "KN" - | "KR" - | "KW" - | "KY" - | "KZ" - | "LA" - | "LB" - | "LC" - | "LI" - | "LK" - | "LR" - | "LS" - | "LT" - | "LU" - | "LV" - | "LY" - | "MA" - | "MC" - | "MD" - | "ME" - | "MF" - | "MG" - | "MK" - | "ML" - | "MM" - | "MN" - | "MO" - | "MQ" - | "MR" - | "MS" - | "MT" - | "MU" - | "MV" - | "MW" - | "MX" - | "MY" - | "MZ" - | "NA" - | "NC" - | "NE" - | "NG" - | "NI" - | "NL" - | "NO" - | "NP" - | "NR" - | "NU" - | "NZ" - | "OM" - | "PA" - | "PE" - | "PF" - | "PG" - | "PH" - | "PK" - | "PL" - | "PM" - | "PN" - | "PR" - | "PS" - | "PT" - | "PY" - | "QA" - | "RE" - | "RO" - | "RS" - | "RU" - | "RW" - | "SA" - | "SB" - | "SC" - | "SE" - | "SG" - | "SH" - | "SI" - | "SJ" - | "SK" - | "SL" - | "SM" - | "SN" - | "SO" - | "SR" - | "SS" - | "ST" - | "SV" - | "SX" - | "SZ" - | "TA" - | "TC" - | "TD" - | "TF" - | "TG" - | "TH" - | "TJ" - | "TK" - | "TL" - | "TM" - | "TN" - | "TO" - | "TR" - | "TT" - | "TV" - | "TW" - | "TZ" - | "UA" - | "UG" - | "US" - | "UY" - | "UZ" - | "VA" - | "VC" - | "VE" - | "VG" - | "VN" - | "VU" - | "WF" - | "WS" - | "XK" - | "YE" - | "YT" - | "ZA" - | "ZM" - | "ZW" - | "ZZ" - )[]; - }; + | 'AC' + | 'AD' + | 'AE' + | 'AF' + | 'AG' + | 'AI' + | 'AL' + | 'AM' + | 'AO' + | 'AQ' + | 'AR' + | 'AT' + | 'AU' + | 'AW' + | 'AX' + | 'AZ' + | 'BA' + | 'BB' + | 'BD' + | 'BE' + | 'BF' + | 'BG' + | 'BH' + | 'BI' + | 'BJ' + | 'BL' + | 'BM' + | 'BN' + | 'BO' + | 'BQ' + | 'BR' + | 'BS' + | 'BT' + | 'BV' + | 'BW' + | 'BY' + | 'BZ' + | 'CA' + | 'CD' + | 'CF' + | 'CG' + | 'CH' + | 'CI' + | 'CK' + | 'CL' + | 'CM' + | 'CN' + | 'CO' + | 'CR' + | 'CV' + | 'CW' + | 'CY' + | 'CZ' + | 'DE' + | 'DJ' + | 'DK' + | 'DM' + | 'DO' + | 'DZ' + | 'EC' + | 'EE' + | 'EG' + | 'EH' + | 'ER' + | 'ES' + | 'ET' + | 'FI' + | 'FJ' + | 'FK' + | 'FO' + | 'FR' + | 'GA' + | 'GB' + | 'GD' + | 'GE' + | 'GF' + | 'GG' + | 'GH' + | 'GI' + | 'GL' + | 'GM' + | 'GN' + | 'GP' + | 'GQ' + | 'GR' + | 'GS' + | 'GT' + | 'GU' + | 'GW' + | 'GY' + | 'HK' + | 'HN' + | 'HR' + | 'HT' + | 'HU' + | 'ID' + | 'IE' + | 'IL' + | 'IM' + | 'IN' + | 'IO' + | 'IQ' + | 'IS' + | 'IT' + | 'JE' + | 'JM' + | 'JO' + | 'JP' + | 'KE' + | 'KG' + | 'KH' + | 'KI' + | 'KM' + | 'KN' + | 'KR' + | 'KW' + | 'KY' + | 'KZ' + | 'LA' + | 'LB' + | 'LC' + | 'LI' + | 'LK' + | 'LR' + | 'LS' + | 'LT' + | 'LU' + | 'LV' + | 'LY' + | 'MA' + | 'MC' + | 'MD' + | 'ME' + | 'MF' + | 'MG' + | 'MK' + | 'ML' + | 'MM' + | 'MN' + | 'MO' + | 'MQ' + | 'MR' + | 'MS' + | 'MT' + | 'MU' + | 'MV' + | 'MW' + | 'MX' + | 'MY' + | 'MZ' + | 'NA' + | 'NC' + | 'NE' + | 'NG' + | 'NI' + | 'NL' + | 'NO' + | 'NP' + | 'NR' + | 'NU' + | 'NZ' + | 'OM' + | 'PA' + | 'PE' + | 'PF' + | 'PG' + | 'PH' + | 'PK' + | 'PL' + | 'PM' + | 'PN' + | 'PR' + | 'PS' + | 'PT' + | 'PY' + | 'QA' + | 'RE' + | 'RO' + | 'RS' + | 'RU' + | 'RW' + | 'SA' + | 'SB' + | 'SC' + | 'SE' + | 'SG' + | 'SH' + | 'SI' + | 'SJ' + | 'SK' + | 'SL' + | 'SM' + | 'SN' + | 'SO' + | 'SR' + | 'SS' + | 'ST' + | 'SV' + | 'SX' + | 'SZ' + | 'TA' + | 'TC' + | 'TD' + | 'TF' + | 'TG' + | 'TH' + | 'TJ' + | 'TK' + | 'TL' + | 'TM' + | 'TN' + | 'TO' + | 'TR' + | 'TT' + | 'TV' + | 'TW' + | 'TZ' + | 'UA' + | 'UG' + | 'US' + | 'UY' + | 'UZ' + | 'VA' + | 'VC' + | 'VE' + | 'VG' + | 'VN' + | 'VU' + | 'WF' + | 'WS' + | 'XK' + | 'YE' + | 'YT' + | 'ZA' + | 'ZM' + | 'ZW' + | 'ZZ' + )[] + } /** Polymorphic */ payment_source: { /** @description Unique identifier for the object. */ - id: string; + id: string /** @description 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?: { [key: string]: unknown }; + metadata?: { [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "account"; - }; + object: 'account' + } /** * Payout * @description A `Payout` object is created when you receive funds from Stripe, or when you @@ -7828,59 +7797,59 @@ export interface definitions { */ payout: { /** @description Amount (in %s) to be transferred to your bank account or debit card. */ - amount: number; + amount: number /** @description Date the payout is expected to arrive in the bank. This factors in delays like weekends or bank holidays. */ - arrival_date: number; + arrival_date: number /** @description Returns `true` if the payout was created by an [automated payout schedule](https://stripe.com/docs/payouts#payout-schedule), and `false` if it was [requested manually](https://stripe.com/docs/payouts#manual-payouts). */ - automatic: boolean; + automatic: boolean /** @description ID of the balance transaction that describes the impact of this payout on your account balance. */ - balance_transaction?: string; + balance_transaction?: string /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description ID of the bank account or card the payout was sent to. */ - destination?: string; + destination?: string /** @description If the payout failed or was canceled, this will be the ID of the balance transaction that reversed the initial balance transaction, and puts the funds from the failed payout back in your balance. */ - failure_balance_transaction?: string; + failure_balance_transaction?: string /** @description Error code explaining reason for payout failure if available. See [Types of payout failures](https://stripe.com/docs/api#payout_failures) for a list of failure codes. */ - failure_code?: string; + failure_code?: string /** @description Message to user further explaining reason for payout failure if available. */ - failure_message?: string; + failure_message?: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: unknown }; + metadata: { [key: string]: unknown } /** @description The method used to send this payout, which can be `standard` or `instant`. `instant` is only supported for payouts to debit cards. (See [Instant payouts for marketplaces](https://stripe.com/blog/instant-payouts-for-marketplaces) for more information.) */ - method: string; + method: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "payout"; + object: 'payout' /** @description The source balance this payout came from. One of `card`, `fpx`, or `bank_account`. */ - source_type: string; + source_type: string /** @description Extra information about a payout to be displayed on the user's bank statement. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description Current status of the payout: `paid`, `pending`, `in_transit`, `canceled` or `failed`. A payout is `pending` until it is submitted to the bank, when it becomes `in_transit`. The status then changes to `paid` if the transaction goes through, or to `failed` or `canceled` (within 5 business days). Some failed payouts may initially show as `paid` but then change to `failed`. */ - status: string; + status: string /** * @description Can be `bank_account` or `card`. * @enum {string} */ - type: "bank_account" | "card"; - }; + type: 'bank_account' | 'card' + } /** Period */ period: { /** @description The end date of this usage period. All usage up to and including this point in time is included. */ - end?: number; + end?: number /** @description The start date of this usage period. All usage after this point in time is included. */ - start?: number; - }; + start?: number + } /** * Person * @description This is an object representing a person associated with a Stripe account. @@ -7888,66 +7857,66 @@ export interface definitions { * Related guide: [Handling Identity Verification with the API](https://stripe.com/docs/connect/identity-verification-api#person-information). */ person: { - account: string; - address?: definitions["address"]; - address_kana?: definitions["legal_entity_japan_address"]; - address_kanji?: definitions["legal_entity_japan_address"]; + account: string + address?: definitions['address'] + address_kana?: definitions['legal_entity_japan_address'] + address_kanji?: definitions['legal_entity_japan_address'] /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; - dob?: definitions["legal_entity_dob"]; - email?: string; - first_name?: string; - first_name_kana?: string; - first_name_kanji?: string; - gender?: string; + created: number + dob?: definitions['legal_entity_dob'] + email?: string + first_name?: string + first_name_kana?: string + first_name_kanji?: string + gender?: string /** @description Unique identifier for the object. */ - id: string; - id_number_provided?: boolean; - last_name?: string; - last_name_kana?: string; - last_name_kanji?: string; - maiden_name?: string; + id: string + id_number_provided?: boolean + last_name?: string + last_name_kana?: string + last_name_kanji?: string + maiden_name?: string /** @description 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?: { [key: string]: unknown }; + metadata?: { [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "person"; - phone?: string; - relationship?: definitions["person_relationship"]; - requirements?: definitions["person_requirements"]; - ssn_last_4_provided?: boolean; - verification?: definitions["legal_entity_person_verification"]; - }; + object: 'person' + phone?: string + relationship?: definitions['person_relationship'] + requirements?: definitions['person_requirements'] + ssn_last_4_provided?: boolean + verification?: definitions['legal_entity_person_verification'] + } /** PersonRelationship */ person_relationship: { /** @description Whether the person is a director of the account's legal entity. Currently only required for accounts in the EU. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations. */ - director?: boolean; + director?: boolean /** @description Whether the person has significant responsibility to control, manage, or direct the organization. */ - executive?: boolean; + executive?: boolean /** @description Whether the person is an owner of the account’s legal entity. */ - owner?: boolean; + owner?: boolean /** @description The percent owned by the person of the account's legal entity. */ - percent_ownership?: number; + percent_ownership?: number /** @description 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?: boolean; + representative?: boolean /** @description The person's title (e.g., CEO, Support Engineer). */ - title?: string; - }; + title?: string + } /** PersonRequirements */ person_requirements: { /** @description 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: string[]; + currently_due: string[] /** @description The fields that need to be collected again because validation or verification failed for some reason. */ - errors: definitions["account_requirements_error"][]; + errors: definitions['account_requirements_error'][] /** @description Fields that need to be collected assuming all volume thresholds are reached. As fields are needed, they are moved to `currently_due` and the account's `current_deadline` is set. */ - eventually_due: string[]; + eventually_due: string[] /** @description Fields that weren't collected by the account's `current_deadline`. These fields need to be collected to enable payouts for the person's account. */ - past_due: string[]; + past_due: string[] /** @description Fields that may become required depending on the results of verification or review. An empty array unless an asynchronous verification is pending. If verification fails, the fields in this array become required and move to `currently_due` or `past_due`. */ - pending_verification: string[]; - }; + pending_verification: string[] + } /** * Plan * @description Plans define the base price, currency, and billing cycle for recurring purchases of products. @@ -7959,92 +7928,92 @@ export interface definitions { */ plan: { /** @description Whether the plan can be used for new purchases. */ - active: boolean; + active: boolean /** * @description 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`. * @enum {string} */ - aggregate_usage?: "last_during_period" | "last_ever" | "max" | "sum"; + aggregate_usage?: 'last_during_period' | 'last_ever' | 'max' | 'sum' /** @description The amount in %s to be charged on the interval specified. */ - amount?: number; + amount?: number /** @description Same as `amount`, but contains a decimal value with at most 12 decimal places. */ - amount_decimal?: string; + amount_decimal?: string /** * @description 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. * @enum {string} */ - billing_scheme: "per_unit" | "tiered"; + billing_scheme: 'per_unit' | 'tiered' /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`. * @enum {string} */ - interval: "day" | "month" | "week" | "year"; + interval: 'day' | 'month' | 'week' | 'year' /** @description 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: number; + interval_count: number /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: unknown }; + metadata: { [key: string]: unknown } /** @description A brief description of the plan, hidden from customers. */ - nickname?: string; + nickname?: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "plan"; + object: 'plan' /** @description The product whose pricing this plan determines. */ - product?: string; + product?: string /** @description Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. */ - tiers?: definitions["plan_tier"][]; + tiers?: definitions['plan_tier'][] /** * @description 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. * @enum {string} */ - tiers_mode?: "graduated" | "volume"; - transform_usage?: definitions["transform_usage"]; + tiers_mode?: 'graduated' | 'volume' + transform_usage?: definitions['transform_usage'] /** @description 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?: number; + trial_period_days?: number /** * @description 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`. * @enum {string} */ - usage_type: "licensed" | "metered"; - }; + usage_type: 'licensed' | 'metered' + } /** PlanTier */ plan_tier: { /** @description Price for the entire tier. */ - flat_amount?: number; + flat_amount?: number /** @description Same as `flat_amount`, but contains a decimal value with at most 12 decimal places. */ - flat_amount_decimal?: string; + flat_amount_decimal?: string /** @description Per unit price for units relevant to the tier. */ - unit_amount?: number; + unit_amount?: number /** @description Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. */ - unit_amount_decimal?: string; + unit_amount_decimal?: string /** @description Up to and including to this quantity will be contained in the tier. */ - up_to?: number; - }; + up_to?: number + } /** PlatformTax */ platform_tax_fee: { /** @description The Connected account that incurred this charge. */ - account: string; + account: string /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "platform_tax_fee"; + object: 'platform_tax_fee' /** @description The payment object that caused this tax to be inflicted. */ - source_transaction: string; + source_transaction: string /** @description The type of tax (VAT). */ - type: string; - }; + type: string + } /** * Product * @description Products describe the specific goods or services you offer to your customers. @@ -8055,49 +8024,49 @@ export interface definitions { */ product: { /** @description Whether the product is currently available for purchase. */ - active: boolean; + active: boolean /** @description A list of up to 5 attributes that each SKU can provide values for (e.g., `["color", "size"]`). */ - attributes?: string[]; + attributes?: string[] /** @description A short one-line description of the product, meant to be displayable to the customer. Only applicable to products of `type=good`. */ - caption?: string; + caption?: string /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description An array of connect application identifiers that cannot purchase this product. Only applicable to products of `type=good`. */ - deactivate_on?: string[]; + deactivate_on?: string[] /** @description 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?: string; + description?: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description A list of up to 8 URLs of images for this product, meant to be displayable to the customer. */ - images: string[]; + images: string[] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: unknown }; + metadata: { [key: string]: unknown } /** @description The product's name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions. */ - name: string; + name: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "product"; - package_dimensions?: definitions["package_dimensions"]; + object: 'product' + package_dimensions?: definitions['package_dimensions'] /** @description Whether this product is a shipped good. Only applicable to products of `type=good`. */ - shippable?: boolean; + shippable?: boolean /** @description 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. */ - statement_descriptor?: string; + statement_descriptor?: string /** * @description The type of the product. The product is either of type `good`, which is eligible for use with Orders and SKUs, or `service`, which is eligible for use with Subscriptions and Plans. * @enum {string} */ - type: "good" | "service"; + type: 'good' | 'service' /** @description A label that represents units of this product in Stripe and on customers’ receipts and invoices. When set, this will be included in associated invoice line item descriptions. */ - unit_label?: string; + unit_label?: string /** @description Time at which the object was last updated. Measured in seconds since the Unix epoch. */ - updated: number; + updated: number /** @description A URL of a publicly-accessible webpage for this product. Only applicable to products of `type=good`. */ - url?: string; - }; + url?: string + } /** * RadarEarlyFraudWarning * @description An early fraud warning indicates that the card issuer has notified us that a @@ -8105,130 +8074,123 @@ export interface definitions { * * Related guide: [Early Fraud Warnings](https://stripe.com/docs/disputes/measuring#early-fraud-warnings). */ - "radar.early_fraud_warning": { + 'radar.early_fraud_warning': { /** @description 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: boolean; + actionable: boolean /** @description ID of the charge this early fraud warning is for, optionally expanded. */ - charge: string; + charge: string /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + fraud_type: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "radar.early_fraud_warning"; - }; + object: 'radar.early_fraud_warning' + } /** * RadarListList * @description Value lists allow you to group values together which can then be referenced in rules. * * Related guide: [Default Stripe Lists](https://stripe.com/docs/radar/lists#managing-list-items). */ - "radar.value_list": { + 'radar.value_list': { /** @description The name of the value list for use in rules. */ - alias: string; + alias: string /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The name or email address of the user who created this value list. */ - created_by: string; + created_by: string /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description The type of items in the value list. One of `card_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, or `case_sensitive_string`. * @enum {string} */ - item_type: - | "card_bin" - | "card_fingerprint" - | "case_sensitive_string" - | "country" - | "email" - | "ip_address" - | "string"; + item_type: 'card_bin' | 'card_fingerprint' | 'case_sensitive_string' | 'country' | 'email' | 'ip_address' | 'string' /** * RadarListListItemList * @description List of items contained within this value list. */ list_items: { /** @description Details about each object. */ - data: definitions["radar.value_list_item"][]; + data: definitions['radar.value_list_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: unknown }; + metadata: { [key: string]: unknown } /** @description The name of the value list. */ - name: string; + name: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "radar.value_list"; - }; + object: 'radar.value_list' + } /** * RadarListListItem * @description Value list items allow you to add specific values to a given Radar value list, which can then be used in rules. * * Related guide: [Managing List Items](https://stripe.com/docs/radar/lists#managing-list-items). */ - "radar.value_list_item": { + 'radar.value_list_item': { /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The name or email address of the user who added this item to the value list. */ - created_by: string; + created_by: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "radar.value_list_item"; + object: 'radar.value_list_item' /** @description The value of the item. */ - value: string; + value: string /** @description The identifier of the value list this item belongs to. */ - value_list: string; - }; + value_list: string + } /** RadarReviewResourceLocation */ radar_review_resource_location: { /** @description The city where the payment originated. */ - city?: string; + city?: string /** @description Two-letter ISO code representing the country where the payment originated. */ - country?: string; + country?: string /** @description The geographic latitude where the payment originated. */ - latitude?: number; + latitude?: number /** @description The geographic longitude where the payment originated. */ - longitude?: number; + longitude?: number /** @description The state/county/province/region where the payment originated. */ - region?: string; - }; + region?: string + } /** RadarReviewResourceSession */ radar_review_resource_session: { /** @description The browser used in this browser session (e.g., `Chrome`). */ - browser?: string; + browser?: string /** @description Information about the device used for the browser session (e.g., `Samsung SM-G930T`). */ - device?: string; + device?: string /** @description The platform for the browser session (e.g., `Macintosh`). */ - platform?: string; + platform?: string /** @description The version for the browser session (e.g., `61.0.3163.100`). */ - version?: string; - }; + version?: string + } /** * TransferRecipient * @description With `Recipient` objects, you can transfer money from your Stripe account to a @@ -8244,46 +8206,46 @@ export interface definitions { * [migration guide](https://stripe.com/docs/connect/recipient-account-migrations) for more information.** */ recipient: { - active_account?: definitions["bank_account"]; + active_account?: definitions['bank_account'] /** CardList */ cards?: { - data: definitions["card"][]; + data: definitions['card'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The default card to use for creating transfers to this recipient. */ - default_card?: string; + default_card?: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; - email?: string; + description?: string + email?: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: unknown }; + metadata: { [key: string]: unknown } /** @description The ID of the [Custom account](https://stripe.com/docs/connect/custom-accounts) this recipient was migrated to. If set, the recipient can no longer be updated, nor can transfers be made to it: use the Custom account instead. */ - migrated_to?: string; + migrated_to?: string /** @description Full, legal name of the recipient. */ - name?: string; + name?: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "recipient"; - rolled_back_from?: string; + object: 'recipient' + rolled_back_from?: string /** @description Type of the recipient, one of `individual` or `corporation`. */ - type: string; - }; + type: string + } /** * Refund * @description `Refund` objects allow you to refund a charge that has previously been created @@ -8294,43 +8256,43 @@ export interface definitions { */ refund: { /** @description Amount, in %s. */ - amount: number; + amount: number /** @description Balance transaction that describes the impact on your account balance. */ - balance_transaction?: string; + balance_transaction?: string /** @description ID of the charge that was refunded. */ - charge?: string; + charge?: string /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. (Available on non-card refunds only) */ - description?: string; + description?: string /** @description If the refund failed, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction. */ - failure_balance_transaction?: string; + failure_balance_transaction?: string /** @description If the refund failed, the reason for refund failure if known. Possible values are `lost_or_stolen_card`, `expired_or_canceled_card`, or `unknown`. */ - failure_reason?: string; + failure_reason?: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description 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: { [key: string]: unknown }; + metadata: { [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "refund"; + object: 'refund' /** @description ID of the PaymentIntent that was refunded. */ - payment_intent?: string; + payment_intent?: string /** @description Reason for the refund, either user-provided (`duplicate`, `fraudulent`, or `requested_by_customer`) or generated by Stripe internally (`expired_uncaptured_charge`). */ - reason?: string; + reason?: string /** @description This is the transaction number that appears on email receipts sent for this refund. */ - receipt_number?: string; + receipt_number?: string /** @description The transfer reversal that is associated with the refund. Only present if the charge came from another Stripe account. See the Connect documentation for details. */ - source_transfer_reversal?: string; + source_transfer_reversal?: string /** @description Status of the refund. For credit card refunds, this can be `pending`, `succeeded`, or `failed`. For other types of refunds, it can be `pending`, `succeeded`, `failed`, or `canceled`. Refer to our [refunds](https://stripe.com/docs/refunds#failed-refunds) documentation for more details. */ - status?: string; + status?: string /** @description If the accompanying transfer was reversed, the transfer reversal object. Only applicable if the charge was created using the destination parameter. */ - transfer_reversal?: string; - }; + transfer_reversal?: string + } /** * reporting_report_run * @description The Report Run object represents an instance of a report type generated with @@ -8343,39 +8305,39 @@ export interface definitions { * data), and thus related requests must be made with a * [live-mode API key](https://stripe.com/docs/keys#test-live-modes). */ - "reporting.report_run": { + 'reporting.report_run': { /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** * @description If something should go wrong during the run, a message about the failure (populated when * `status=failed`). */ - error?: string; + error?: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Always `true`: reports can only be run on live-mode data. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "reporting.report_run"; - parameters: definitions["financial_reporting_finance_report_run_run_parameters"]; + object: 'reporting.report_run' + parameters: definitions['financial_reporting_finance_report_run_run_parameters'] /** @description The ID of the [report type](https://stripe.com/docs/reporting/statements/api#report-types) to run, such as `"balance.summary.1"`. */ - report_type: string; - result?: definitions["file"]; + report_type: string + result?: definitions['file'] /** * @description 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. * Rarely, we may encounter an error, at which point this will be set to `failed` and the `error` field will be populated. */ - status: string; + status: string /** * @description Timestamp at which this run successfully finished (populated when * `status=succeeded`). Measured in seconds since the Unix epoch. */ - succeeded_at?: number; - }; + succeeded_at?: number + } /** * reporting_report_type * @description The Report Type resource corresponds to a particular type of report, such as @@ -8388,42 +8350,42 @@ export interface definitions { * data), and thus related requests must be made with a * [live-mode API key](https://stripe.com/docs/keys#test-live-modes). */ - "reporting.report_type": { + 'reporting.report_type': { /** @description Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch. */ - data_available_end: number; + data_available_end: number /** @description Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch. */ - data_available_start: number; + data_available_start: number /** @description 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?: string[]; + default_columns?: string[] /** @description The [ID of the Report Type](https://stripe.com/docs/reporting/statements/api#available-report-types), such as `balance.summary.1`. */ - id: string; + id: string /** @description Human-readable name of the Report Type */ - name: string; + name: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "reporting.report_type"; + object: 'reporting.report_type' /** @description When this Report Type was latest updated. Measured in seconds since the Unix epoch. */ - updated: number; + updated: number /** @description 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: number; - }; + version: number + } /** ReserveTransaction */ reserve_transaction: { - amount: number; + amount: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "reserve_transaction"; - }; + object: 'reserve_transaction' + } /** * RadarReview * @description Reviews can be used to supplement automated fraud detection with human expertise. @@ -8433,50 +8395,50 @@ export interface definitions { */ review: { /** @description The ZIP or postal code of the card used, if applicable. */ - billing_zip?: string; + billing_zip?: string /** @description The charge associated with this review. */ - charge?: string; + charge?: string /** * @description The reason the review was closed, or null if it has not yet been closed. One of `approved`, `refunded`, `refunded_as_fraud`, or `disputed`. * @enum {string} */ - closed_reason?: "approved" | "disputed" | "refunded" | "refunded_as_fraud"; + closed_reason?: 'approved' | 'disputed' | 'refunded' | 'refunded_as_fraud' /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The IP address where the payment originated. */ - ip_address?: string; - ip_address_location?: definitions["radar_review_resource_location"]; + ip_address?: string + ip_address_location?: definitions['radar_review_resource_location'] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "review"; + object: 'review' /** @description If `true`, the review needs action. */ - open: boolean; + open: boolean /** * @description The reason the review was opened. One of `rule` or `manual`. * @enum {string} */ - opened_reason: "manual" | "rule"; + opened_reason: 'manual' | 'rule' /** @description The PaymentIntent ID associated with this review, if one exists. */ - payment_intent?: string; + payment_intent?: string /** @description The reason the review is currently open or closed. One of `rule`, `manual`, `approved`, `refunded`, `refunded_as_fraud`, or `disputed`. */ - reason: string; - session?: definitions["radar_review_resource_session"]; - }; + reason: string + session?: definitions['radar_review_resource_session'] + } /** RadarRule */ rule: { /** @description The action taken on the payment. */ - action: string; + action: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The predicate to evaluate the payment against. */ - predicate: string; - }; + predicate: string + } /** * ScheduledQueryRun * @description If you have [scheduled a Sigma query](https://stripe.com/docs/sigma/scheduled-queries), you'll @@ -8486,29 +8448,29 @@ export interface definitions { */ scheduled_query_run: { /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description When the query was run, Sigma contained a snapshot of your Stripe data at this time. */ - data_load_time: number; - error?: definitions["sigma_scheduled_query_run_error"]; - file?: definitions["file"]; + data_load_time: number + error?: definitions['sigma_scheduled_query_run_error'] + file?: definitions['file'] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "scheduled_query_run"; + object: 'scheduled_query_run' /** @description Time at which the result expires and is no longer available for download. */ - result_available_until: number; + result_available_until: number /** @description SQL for the query. */ - sql: string; + sql: string /** @description The query's execution status, which will be `completed` for successful runs, and `canceled`, `failed`, or `timed_out` otherwise. */ - status: string; + status: string /** @description Title of the query. */ - title: string; - }; + title: string + } /** * SetupIntent * @description A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. @@ -8536,126 +8498,120 @@ export interface definitions { */ setup_intent: { /** @description ID of the Connect application that created the SetupIntent. */ - application?: string; + application?: string /** * @description Reason for cancellation of this SetupIntent, one of `abandoned`, `requested_by_customer`, or `duplicate`. * @enum {string} */ - cancellation_reason?: "abandoned" | "duplicate" | "requested_by_customer"; + cancellation_reason?: 'abandoned' | 'duplicate' | 'requested_by_customer' /** * @description The client secret of this SetupIntent. Used for client-side retrieval using a publishable key. * * The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, embedded in URLs, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret. */ - client_secret?: string; + client_secret?: string /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** * @description ID of the Customer this SetupIntent belongs to, if one exists. * * If 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. */ - customer?: string; + customer?: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Unique identifier for the object. */ - id: string; - last_setup_error?: definitions["api_errors"]; + id: string + last_setup_error?: definitions['api_errors'] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description ID of the multi use Mandate generated by the SetupIntent. */ - mandate?: string; + mandate?: string /** @description 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?: { [key: string]: unknown }; - next_action?: definitions["setup_intent_next_action"]; + metadata?: { [key: string]: unknown } + next_action?: definitions['setup_intent_next_action'] /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "setup_intent"; + object: 'setup_intent' /** @description The account (if any) for which the setup is intended. */ - on_behalf_of?: string; + on_behalf_of?: string /** @description ID of the payment method used with this SetupIntent. */ - payment_method?: string; - payment_method_options?: definitions["setup_intent_payment_method_options"]; + payment_method?: string + payment_method_options?: definitions['setup_intent_payment_method_options'] /** @description The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. */ - payment_method_types: string[]; + payment_method_types: string[] /** @description ID of the single_use Mandate generated by the SetupIntent. */ - single_use_mandate?: string; + single_use_mandate?: string /** * @description [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`. * @enum {string} */ - status: - | "canceled" - | "processing" - | "requires_action" - | "requires_confirmation" - | "requires_payment_method" - | "succeeded"; + status: 'canceled' | 'processing' | 'requires_action' | 'requires_confirmation' | 'requires_payment_method' | 'succeeded' /** * @description Indicates how the payment method is intended to be used in the future. * * Use `on_session` if you intend to only reuse the payment method when the customer is in your checkout flow. Use `off_session` if your customer may or may not be in your checkout flow. If not provided, this value defaults to `off_session`. */ - usage: string; - }; + usage: string + } /** SetupIntentNextAction */ setup_intent_next_action: { - redirect_to_url?: definitions["setup_intent_next_action_redirect_to_url"]; + redirect_to_url?: definitions['setup_intent_next_action_redirect_to_url'] /** @description Type of the next action to perform, one of `redirect_to_url` or `use_stripe_sdk`. */ - type: string; + type: string /** @description 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?: { [key: string]: unknown }; - }; + use_stripe_sdk?: { [key: string]: unknown } + } /** SetupIntentNextActionRedirectToUrl */ setup_intent_next_action_redirect_to_url: { /** @description If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion. */ - return_url?: string; + return_url?: string /** @description The URL you must redirect your customer to in order to authenticate. */ - url?: string; - }; + url?: string + } /** SetupIntentPaymentMethodOptions */ setup_intent_payment_method_options: { - card?: definitions["setup_intent_payment_method_options_card"]; - }; + card?: definitions['setup_intent_payment_method_options_card'] + } /** setup_intent_payment_method_options_card */ setup_intent_payment_method_options_card: { /** * @description 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. Permitted values include: `automatic` or `any`. If not provided, defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. * @enum {string} */ - request_three_d_secure?: "any" | "automatic" | "challenge_only"; - }; + request_three_d_secure?: 'any' | 'automatic' | 'challenge_only' + } /** Shipping */ shipping: { - address?: definitions["address"]; + address?: definitions['address'] /** @description The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. */ - carrier?: string; + carrier?: string /** @description Recipient name. */ - name?: string; + name?: string /** @description Recipient phone (including extension). */ - phone?: string; + phone?: string /** @description 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?: string; - }; + tracking_number?: string + } /** ShippingMethod */ shipping_method: { /** @description 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 line item. */ - amount: number; + amount: number /** @description 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: string; - delivery_estimate?: definitions["delivery_estimate"]; + currency: string + delivery_estimate?: definitions['delivery_estimate'] /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description: string; + description: string /** @description Unique identifier for the object. */ - id: string; - }; + id: string + } /** SigmaScheduledQueryRunError */ sigma_scheduled_query_run_error: { /** @description Information about the run failure. */ - message: string; - }; + message: string + } /** * SKU * @description Stores representations of [stock keeping units](http://en.wikipedia.org/wiki/Stock_keeping_unit). @@ -8669,35 +8625,35 @@ export interface definitions { */ sku: { /** @description Whether the SKU is available for purchase. */ - active: boolean; + active: boolean /** @description A dictionary of attributes and values for the attributes defined by the product. If, for example, a product's attributes are `["size", "gender"]`, a valid SKU has the following dictionary of attributes: `{"size": "Medium", "gender": "Unisex"}`. */ - attributes: { [key: string]: unknown }; + attributes: { [key: string]: unknown } /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The URL of an image for this SKU, meant to be displayable to the customer. */ - image?: string; - inventory: definitions["inventory"]; + image?: string + inventory: definitions['inventory'] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: unknown }; + metadata: { [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "sku"; - package_dimensions?: definitions["package_dimensions"]; + object: 'sku' + package_dimensions?: definitions['package_dimensions'] /** @description The cost of the item as a positive integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a zero-decimal currency). */ - price: number; + price: number /** @description The ID of the product this SKU is associated with. The product must be currently active. */ - product: string; + product: string /** @description Time at which the object was last updated. Measured in seconds since the Unix epoch. */ - updated: number; - }; + updated: number + } /** * Source * @description `Source` objects allow you to accept a variety of payment methods. They @@ -8708,87 +8664,87 @@ export interface definitions { * Related guides: [Sources API](https://stripe.com/docs/sources) and [Sources & Customers](https://stripe.com/docs/sources/customers). */ source: { - ach_credit_transfer?: definitions["source_type_ach_credit_transfer"]; - ach_debit?: definitions["source_type_ach_debit"]; - alipay?: definitions["source_type_alipay"]; + ach_credit_transfer?: definitions['source_type_ach_credit_transfer'] + ach_debit?: definitions['source_type_ach_debit'] + alipay?: definitions['source_type_alipay'] /** @description 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?: number; - au_becs_debit?: definitions["source_type_au_becs_debit"]; - bancontact?: definitions["source_type_bancontact"]; - card?: definitions["source_type_card"]; - card_present?: definitions["source_type_card_present"]; + amount?: number + au_becs_debit?: definitions['source_type_au_becs_debit'] + bancontact?: definitions['source_type_bancontact'] + card?: definitions['source_type_card'] + card_present?: definitions['source_type_card_present'] /** @description The client secret of the source. Used for client-side retrieval using a publishable key. */ - client_secret: string; - code_verification?: definitions["source_code_verification_flow"]; + client_secret: string + code_verification?: definitions['source_code_verification_flow'] /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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?: string; + currency?: string /** @description 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?: string; - eps?: definitions["source_type_eps"]; + customer?: string + eps?: definitions['source_type_eps'] /** @description The authentication `flow` of the source. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`. */ - flow: string; - giropay?: definitions["source_type_giropay"]; + flow: string + giropay?: definitions['source_type_giropay'] /** @description Unique identifier for the object. */ - id: string; - ideal?: definitions["source_type_ideal"]; - klarna?: definitions["source_type_klarna"]; + id: string + ideal?: definitions['source_type_ideal'] + klarna?: definitions['source_type_klarna'] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: unknown }; - multibanco?: definitions["source_type_multibanco"]; + metadata?: { [key: string]: unknown } + multibanco?: definitions['source_type_multibanco'] /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "source"; - owner?: definitions["source_owner"]; - p24?: definitions["source_type_p24"]; - receiver?: definitions["source_receiver_flow"]; - redirect?: definitions["source_redirect_flow"]; - sepa_debit?: definitions["source_type_sepa_debit"]; - sofort?: definitions["source_type_sofort"]; - source_order?: definitions["source_order"]; + object: 'source' + owner?: definitions['source_owner'] + p24?: definitions['source_type_p24'] + receiver?: definitions['source_receiver_flow'] + redirect?: definitions['source_redirect_flow'] + sepa_debit?: definitions['source_type_sepa_debit'] + sofort?: definitions['source_type_sofort'] + source_order?: definitions['source_order'] /** @description Extra information about a source. This will appear on your customer's statement every time you charge the source. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description The status of the source, one of `canceled`, `chargeable`, `consumed`, `failed`, or `pending`. Only `chargeable` sources can be used to create a charge. */ - status: string; - three_d_secure?: definitions["source_type_three_d_secure"]; + status: string + three_d_secure?: definitions['source_type_three_d_secure'] /** * @description 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. * @enum {string} */ type: - | "ach_credit_transfer" - | "ach_debit" - | "alipay" - | "au_becs_debit" - | "bancontact" - | "card" - | "card_present" - | "eps" - | "giropay" - | "ideal" - | "klarna" - | "multibanco" - | "p24" - | "sepa_debit" - | "sofort" - | "three_d_secure" - | "wechat"; + | 'ach_credit_transfer' + | 'ach_debit' + | 'alipay' + | 'au_becs_debit' + | 'bancontact' + | 'card' + | 'card_present' + | 'eps' + | 'giropay' + | 'ideal' + | 'klarna' + | 'multibanco' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'three_d_secure' + | 'wechat' /** @description 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?: string; - wechat?: definitions["source_type_wechat"]; - }; + usage?: string + wechat?: definitions['source_type_wechat'] + } /** SourceCodeVerificationFlow */ source_code_verification_flow: { /** @description The number of attempts remaining to authenticate the source object with a verification code. */ - attempts_remaining: number; + attempts_remaining: number /** @description 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: string; - }; + status: string + } /** * SourceMandateNotification * @description Source mandate notifications should be created when a notification related to @@ -8797,110 +8753,110 @@ export interface definitions { */ source_mandate_notification: { /** @description 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?: number; - bacs_debit?: definitions["source_mandate_notification_bacs_debit_data"]; + amount?: number + bacs_debit?: definitions['source_mandate_notification_bacs_debit_data'] /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "source_mandate_notification"; + object: 'source_mandate_notification' /** @description The reason of the mandate notification. Valid reasons are `mandate_confirmed` or `debit_initiated`. */ - reason: string; - sepa_debit?: definitions["source_mandate_notification_sepa_debit_data"]; - source: definitions["source"]; + reason: string + sepa_debit?: definitions['source_mandate_notification_sepa_debit_data'] + source: definitions['source'] /** @description The status of the mandate notification. Valid statuses are `pending` or `submitted`. */ - status: string; + status: string /** @description 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: string; - }; + type: string + } /** SourceMandateNotificationBacsDebitData */ source_mandate_notification_bacs_debit_data: { /** @description Last 4 digits of the account number associated with the debit. */ - last4?: string; - }; + last4?: string + } /** SourceMandateNotificationSepaDebitData */ source_mandate_notification_sepa_debit_data: { /** @description SEPA creditor ID. */ - creditor_identifier?: string; + creditor_identifier?: string /** @description Last 4 digits of the account number associated with the debit. */ - last4?: string; + last4?: string /** @description Mandate reference associated with the debit. */ - mandate_reference?: string; - }; + mandate_reference?: string + } /** SourceOrder */ source_order: { /** @description 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: number; + amount: number /** @description 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: string; + currency: string /** @description The email address of the customer placing the order. */ - email?: string; + email?: string /** @description List of items constituting the order. */ - items?: definitions["source_order_item"][]; - shipping?: definitions["shipping"]; - }; + items?: definitions['source_order_item'][] + shipping?: definitions['shipping'] + } /** SourceOrderItem */ source_order_item: { /** @description The amount (price) for this order item. */ - amount?: number; + amount?: number /** @description This currency of this order item. Required when `amount` is present. */ - currency?: string; + currency?: string /** @description Human-readable description for this order item. */ - description?: string; + description?: string /** @description The quantity of this order item. When type is `sku`, this is the number of instances of the SKU to be ordered. */ - quantity?: number; + quantity?: number /** @description The type of this order item. Must be `sku`, `tax`, or `shipping`. */ - type?: string; - }; + type?: string + } /** SourceOwner */ source_owner: { - address?: definitions["address"]; + address?: definitions['address'] /** @description Owner's email address. */ - email?: string; + email?: string /** @description Owner's full name. */ - name?: string; + name?: string /** @description Owner's phone number (including extension). */ - phone?: string; - verified_address?: definitions["address"]; + phone?: string + verified_address?: definitions['address'] /** @description 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?: string; + verified_email?: string /** @description 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?: string; + verified_name?: string /** @description 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?: string; - }; + verified_phone?: string + } /** SourceReceiverFlow */ source_receiver_flow: { /** @description The address of the receiver source. This is the value that should be communicated to the customer to send their funds to. */ - address?: string; + address?: string /** @description 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: number; + amount_charged: number /** @description 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: number; + amount_received: number /** @description The total amount that was returned to the customer. The amount returned is expressed in the source's currency. */ - amount_returned: number; + amount_returned: number /** @description Type of refund attribute method, one of `email`, `manual`, or `none`. */ - refund_attributes_method: string; + refund_attributes_method: string /** @description Type of refund attribute status, one of `missing`, `requested`, or `available`. */ - refund_attributes_status: string; - }; + refund_attributes_status: string + } /** SourceRedirectFlow */ source_redirect_flow: { /** @description 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?: string; + failure_reason?: string /** @description The URL you provide to redirect the customer to after they authenticated their payment. */ - return_url: string; + return_url: string /** @description 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: string; + status: string /** @description The URL provided to you to redirect a customer to as part of a `redirect` authentication flow. */ - url: string; - }; + url: string + } /** * SourceTransaction * @description Some payment methods have no required amount that a customer must send. @@ -8909,297 +8865,297 @@ export interface definitions { * transactions. */ source_transaction: { - ach_credit_transfer?: definitions["source_transaction_ach_credit_transfer_data"]; + ach_credit_transfer?: definitions['source_transaction_ach_credit_transfer_data'] /** @description 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: number; - chf_credit_transfer?: definitions["source_transaction_chf_credit_transfer_data"]; + amount: number + chf_credit_transfer?: definitions['source_transaction_chf_credit_transfer_data'] /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; - gbp_credit_transfer?: definitions["source_transaction_gbp_credit_transfer_data"]; + currency: string + gbp_credit_transfer?: definitions['source_transaction_gbp_credit_transfer_data'] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "source_transaction"; - paper_check?: definitions["source_transaction_paper_check_data"]; - sepa_credit_transfer?: definitions["source_transaction_sepa_credit_transfer_data"]; + object: 'source_transaction' + paper_check?: definitions['source_transaction_paper_check_data'] + sepa_credit_transfer?: definitions['source_transaction_sepa_credit_transfer_data'] /** @description The ID of the source this transaction is attached to. */ - source: string; + source: string /** @description The status of the transaction, one of `succeeded`, `pending`, or `failed`. */ - status: string; + status: string /** * @description The type of source this transaction is attached to. * @enum {string} */ type: - | "ach_credit_transfer" - | "ach_debit" - | "alipay" - | "bancontact" - | "card" - | "card_present" - | "eps" - | "giropay" - | "ideal" - | "klarna" - | "multibanco" - | "p24" - | "sepa_debit" - | "sofort" - | "three_d_secure" - | "wechat"; - }; + | 'ach_credit_transfer' + | 'ach_debit' + | 'alipay' + | 'bancontact' + | 'card' + | 'card_present' + | 'eps' + | 'giropay' + | 'ideal' + | 'klarna' + | 'multibanco' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'three_d_secure' + | 'wechat' + } /** SourceTransactionAchCreditTransferData */ source_transaction_ach_credit_transfer_data: { /** @description Customer data associated with the transfer. */ - customer_data?: string; + customer_data?: string /** @description Bank account fingerprint associated with the transfer. */ - fingerprint?: string; + fingerprint?: string /** @description Last 4 digits of the account number associated with the transfer. */ - last4?: string; + last4?: string /** @description Routing number associated with the transfer. */ - routing_number?: string; - }; + routing_number?: string + } /** SourceTransactionChfCreditTransferData */ source_transaction_chf_credit_transfer_data: { /** @description Reference associated with the transfer. */ - reference?: string; + reference?: string /** @description Sender's country address. */ - sender_address_country?: string; + sender_address_country?: string /** @description Sender's line 1 address. */ - sender_address_line1?: string; + sender_address_line1?: string /** @description Sender's bank account IBAN. */ - sender_iban?: string; + sender_iban?: string /** @description Sender's name. */ - sender_name?: string; - }; + sender_name?: string + } /** SourceTransactionGbpCreditTransferData */ source_transaction_gbp_credit_transfer_data: { /** @description Bank account fingerprint associated with the Stripe owned bank account receiving the transfer. */ - fingerprint?: string; + fingerprint?: string /** @description 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?: string; + funding_method?: string /** @description Last 4 digits of sender account number associated with the transfer. */ - last4?: string; + last4?: string /** @description Sender entered arbitrary information about the transfer. */ - reference?: string; + reference?: string /** @description Sender account number associated with the transfer. */ - sender_account_number?: string; + sender_account_number?: string /** @description Sender name associated with the transfer. */ - sender_name?: string; + sender_name?: string /** @description Sender sort code associated with the transfer. */ - sender_sort_code?: string; - }; + sender_sort_code?: string + } /** SourceTransactionPaperCheckData */ source_transaction_paper_check_data: { /** @description Time at which the deposited funds will be available for use. Measured in seconds since the Unix epoch. */ - available_at?: string; + available_at?: string /** @description Comma-separated list of invoice IDs associated with the paper check. */ - invoices?: string; - }; + invoices?: string + } /** SourceTransactionSepaCreditTransferData */ source_transaction_sepa_credit_transfer_data: { /** @description Reference associated with the transfer. */ - reference?: string; + reference?: string /** @description Sender's bank account IBAN. */ - sender_iban?: string; + sender_iban?: string /** @description Sender's name. */ - sender_name?: string; - }; + sender_name?: string + } source_type_ach_credit_transfer: { - account_number?: string; - bank_name?: string; - fingerprint?: string; - refund_account_holder_name?: string; - refund_account_holder_type?: string; - refund_routing_number?: string; - routing_number?: string; - swift_code?: string; - }; + account_number?: string + bank_name?: string + fingerprint?: string + refund_account_holder_name?: string + refund_account_holder_type?: string + refund_routing_number?: string + routing_number?: string + swift_code?: string + } source_type_ach_debit: { - bank_name?: string; - country?: string; - fingerprint?: string; - last4?: string; - routing_number?: string; - type?: string; - }; + bank_name?: string + country?: string + fingerprint?: string + last4?: string + routing_number?: string + type?: string + } source_type_alipay: { - data_string?: string; - native_url?: string; - statement_descriptor?: string; - }; + data_string?: string + native_url?: string + statement_descriptor?: string + } source_type_au_becs_debit: { - bsb_number?: string; - fingerprint?: string; - last4?: string; - }; + bsb_number?: string + fingerprint?: string + last4?: string + } source_type_bancontact: { - bank_code?: string; - bank_name?: string; - bic?: string; - iban_last4?: string; - preferred_language?: string; - statement_descriptor?: string; - }; + bank_code?: string + bank_name?: string + bic?: string + iban_last4?: string + preferred_language?: string + statement_descriptor?: string + } source_type_card: { - address_line1_check?: string; - address_zip_check?: string; - brand?: string; - country?: string; - cvc_check?: string; - dynamic_last4?: string; - exp_month?: number; - exp_year?: number; - fingerprint?: string; - funding?: string; - last4?: string; - name?: string; - three_d_secure?: string; - tokenization_method?: string; - }; + address_line1_check?: string + address_zip_check?: string + brand?: string + country?: string + cvc_check?: string + dynamic_last4?: string + exp_month?: number + exp_year?: number + fingerprint?: string + funding?: string + last4?: string + name?: string + three_d_secure?: string + tokenization_method?: string + } source_type_card_present: { - application_cryptogram?: string; - application_preferred_name?: string; - authorization_code?: string; - authorization_response_code?: string; - brand?: string; - country?: string; - cvm_type?: string; - data_type?: string; - dedicated_file_name?: string; - emv_auth_data?: string; - evidence_customer_signature?: string; - evidence_transaction_certificate?: string; - exp_month?: number; - exp_year?: number; - fingerprint?: string; - funding?: string; - last4?: string; - pos_device_id?: string; - pos_entry_mode?: string; - read_method?: string; - reader?: string; - terminal_verification_results?: string; - transaction_status_information?: string; - }; + application_cryptogram?: string + application_preferred_name?: string + authorization_code?: string + authorization_response_code?: string + brand?: string + country?: string + cvm_type?: string + data_type?: string + dedicated_file_name?: string + emv_auth_data?: string + evidence_customer_signature?: string + evidence_transaction_certificate?: string + exp_month?: number + exp_year?: number + fingerprint?: string + funding?: string + last4?: string + pos_device_id?: string + pos_entry_mode?: string + read_method?: string + reader?: string + terminal_verification_results?: string + transaction_status_information?: string + } source_type_eps: { - reference?: string; - statement_descriptor?: string; - }; + reference?: string + statement_descriptor?: string + } source_type_giropay: { - bank_code?: string; - bank_name?: string; - bic?: string; - statement_descriptor?: string; - }; + bank_code?: string + bank_name?: string + bic?: string + statement_descriptor?: string + } source_type_ideal: { - bank?: string; - bic?: string; - iban_last4?: string; - statement_descriptor?: string; - }; + bank?: string + bic?: string + iban_last4?: string + statement_descriptor?: string + } source_type_klarna: { - background_image_url?: string; - client_token?: string; - first_name?: string; - last_name?: string; - locale?: string; - logo_url?: string; - page_title?: string; - pay_later_asset_urls_descriptive?: string; - pay_later_asset_urls_standard?: string; - pay_later_name?: string; - pay_later_redirect_url?: string; - pay_now_asset_urls_descriptive?: string; - pay_now_asset_urls_standard?: string; - pay_now_name?: string; - pay_now_redirect_url?: string; - pay_over_time_asset_urls_descriptive?: string; - pay_over_time_asset_urls_standard?: string; - pay_over_time_name?: string; - pay_over_time_redirect_url?: string; - payment_method_categories?: string; - purchase_country?: string; - purchase_type?: string; - redirect_url?: string; - shipping_first_name?: string; - shipping_last_name?: string; - }; + background_image_url?: string + client_token?: string + first_name?: string + last_name?: string + locale?: string + logo_url?: string + page_title?: string + pay_later_asset_urls_descriptive?: string + pay_later_asset_urls_standard?: string + pay_later_name?: string + pay_later_redirect_url?: string + pay_now_asset_urls_descriptive?: string + pay_now_asset_urls_standard?: string + pay_now_name?: string + pay_now_redirect_url?: string + pay_over_time_asset_urls_descriptive?: string + pay_over_time_asset_urls_standard?: string + pay_over_time_name?: string + pay_over_time_redirect_url?: string + payment_method_categories?: string + purchase_country?: string + purchase_type?: string + redirect_url?: string + shipping_first_name?: string + shipping_last_name?: string + } source_type_multibanco: { - entity?: string; - reference?: string; - refund_account_holder_address_city?: string; - refund_account_holder_address_country?: string; - refund_account_holder_address_line1?: string; - refund_account_holder_address_line2?: string; - refund_account_holder_address_postal_code?: string; - refund_account_holder_address_state?: string; - refund_account_holder_name?: string; - refund_iban?: string; - }; + entity?: string + reference?: string + refund_account_holder_address_city?: string + refund_account_holder_address_country?: string + refund_account_holder_address_line1?: string + refund_account_holder_address_line2?: string + refund_account_holder_address_postal_code?: string + refund_account_holder_address_state?: string + refund_account_holder_name?: string + refund_iban?: string + } source_type_p24: { - reference?: string; - }; + reference?: string + } source_type_sepa_debit: { - bank_code?: string; - branch_code?: string; - country?: string; - fingerprint?: string; - last4?: string; - mandate_reference?: string; - mandate_url?: string; - }; + bank_code?: string + branch_code?: string + country?: string + fingerprint?: string + last4?: string + mandate_reference?: string + mandate_url?: string + } source_type_sofort: { - bank_code?: string; - bank_name?: string; - bic?: string; - country?: string; - iban_last4?: string; - preferred_language?: string; - statement_descriptor?: string; - }; + bank_code?: string + bank_name?: string + bic?: string + country?: string + iban_last4?: string + preferred_language?: string + statement_descriptor?: string + } source_type_three_d_secure: { - address_line1_check?: string; - address_zip_check?: string; - authenticated?: boolean; - brand?: string; - card?: string; - country?: string; - customer?: string; - cvc_check?: string; - dynamic_last4?: string; - exp_month?: number; - exp_year?: number; - fingerprint?: string; - funding?: string; - last4?: string; - name?: string; - three_d_secure?: string; - tokenization_method?: string; - }; + address_line1_check?: string + address_zip_check?: string + authenticated?: boolean + brand?: string + card?: string + country?: string + customer?: string + cvc_check?: string + dynamic_last4?: string + exp_month?: number + exp_year?: number + fingerprint?: string + funding?: string + last4?: string + name?: string + three_d_secure?: string + tokenization_method?: string + } source_type_wechat: { - prepay_id?: string; - qr_code_url?: string; - statement_descriptor?: string; - }; + prepay_id?: string + qr_code_url?: string + statement_descriptor?: string + } /** StatusTransitions */ status_transitions: { /** @description The time that the order was canceled. */ - canceled?: number; + canceled?: number /** @description The time that the order was fulfilled. */ - fulfiled?: number; + fulfiled?: number /** @description The time that the order was paid. */ - paid?: number; + paid?: number /** @description The time that the order was returned. */ - returned?: number; - }; + returned?: number + } /** * Subscription * @description Subscriptions allow you to charge a customer on a recurring basis. @@ -9208,84 +9164,84 @@ export interface definitions { */ subscription: { /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. */ - application_fee_percent?: number; + application_fee_percent?: number /** @description Determines the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. */ - billing_cycle_anchor: number; - billing_thresholds?: definitions["subscription_billing_thresholds"]; + billing_cycle_anchor: number + billing_thresholds?: definitions['subscription_billing_thresholds'] /** @description A date in the future at which the subscription will automatically get canceled */ - cancel_at?: number; + cancel_at?: number /** @description If the subscription has been canceled with the `at_period_end` flag set to `true`, `cancel_at_period_end` on the subscription will be true. You can use this attribute to determine whether a subscription that has a status of active is scheduled to be canceled at the end of the current period. */ - cancel_at_period_end: boolean; + cancel_at_period_end: boolean /** @description If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with `cancel_at_period_end`, `canceled_at` will still reflect the date of the initial cancellation request, not the end of the subscription period when the subscription is automatically moved to a canceled state. */ - canceled_at?: number; + canceled_at?: number /** * @description 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. * @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: number; + current_period_end: number /** @description Start of the current period that the subscription has been invoiced for. */ - current_period_start: number; + current_period_start: number /** @description ID of the customer who owns the subscription. */ - customer: string; + customer: string /** @description 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?: number; + days_until_due?: number /** @description ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. If not set, invoices will use the default payment method in the customer's invoice settings. */ - default_payment_method?: string; + default_payment_method?: string /** @description 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 not set, defaults to the customer's default source. */ - default_source?: string; + default_source?: string /** @description 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?: definitions["tax_rate"][]; - discount?: definitions["discount"]; + default_tax_rates?: definitions['tax_rate'][] + discount?: definitions['discount'] /** @description If the subscription has ended, the date the subscription ended. */ - ended_at?: number; + ended_at?: number /** @description Unique identifier for the object. */ - id: string; + id: string /** * SubscriptionItemList * @description List of subscription items, each with an attached plan. */ items: { /** @description Details about each object. */ - data: definitions["subscription_item"][]; + data: definitions['subscription_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** @description The most recent invoice this subscription has generated. */ - latest_invoice?: string; + latest_invoice?: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: unknown }; + metadata: { [key: string]: unknown } /** @description 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?: number; + next_pending_invoice_item_invoice?: number /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "subscription"; - pause_collection?: definitions["subscriptions_resource_pause_collection"]; - pending_invoice_item_interval?: definitions["subscription_pending_invoice_item_interval"]; + object: 'subscription' + pause_collection?: definitions['subscriptions_resource_pause_collection'] + pending_invoice_item_interval?: definitions['subscription_pending_invoice_item_interval'] /** @description 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?: string; - pending_update?: definitions["subscriptions_resource_pending_update"]; - plan?: definitions["plan"]; + pending_setup_intent?: string + pending_update?: definitions['subscriptions_resource_pending_update'] + plan?: definitions['plan'] /** @description The quantity of the plan to which the customer is subscribed. For example, if your plan is $10/user/month, and your customer has 5 users, you could pass 5 as the quantity to have the customer charged $50 (5 x $10) monthly. Only set if the subscription contains a single plan. */ - quantity?: number; + quantity?: number /** @description The schedule attached to the subscription */ - schedule?: string; + schedule?: string /** @description Date when the subscription was first created. The date might differ from the `created` date due to backdating. */ - start_date: number; + start_date: number /** * @description Possible values are `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `canceled`, or `unpaid`. * @@ -9298,62 +9254,62 @@ export interface definitions { * If 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. * @enum {string} */ - status: "active" | "canceled" | "incomplete" | "incomplete_expired" | "past_due" | "trialing" | "unpaid"; + status: 'active' | 'canceled' | 'incomplete' | 'incomplete_expired' | 'past_due' | 'trialing' | 'unpaid' /** @description If provided, each invoice created by this subscription will apply the tax rate, increasing the amount billed to the customer. */ - tax_percent?: number; + tax_percent?: number /** @description If the subscription has a trial, the end of that trial. */ - trial_end?: number; + trial_end?: number /** @description If the subscription has a trial, the beginning of that trial. */ - trial_start?: number; - }; + trial_start?: number + } /** SubscriptionBillingThresholds */ subscription_billing_thresholds: { /** @description Monetary threshold that triggers the subscription to create an invoice */ - amount_gte?: number; + amount_gte?: number /** @description 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?: boolean; - }; + reset_billing_cycle_anchor?: boolean + } /** * SubscriptionItem * @description Subscription items allow you to create customer subscriptions with more than * one plan, making it easy to represent complex billing relationships. */ subscription_item: { - billing_thresholds?: definitions["subscription_item_billing_thresholds"]; + billing_thresholds?: definitions['subscription_item_billing_thresholds'] /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Unique identifier for the object. */ - id: string; + id: string /** @description 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: { [key: string]: unknown }; + metadata: { [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "subscription_item"; - plan: definitions["plan"]; + object: 'subscription_item' + plan: definitions['plan'] /** @description The [quantity](https://stripe.com/docs/subscriptions/quantities) of the plan to which the customer should be subscribed. */ - quantity?: number; + quantity?: number /** @description The `subscription` this `subscription_item` belongs to. */ - subscription: string; + subscription: string /** @description 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?: definitions["tax_rate"][]; - }; + tax_rates?: definitions['tax_rate'][] + } /** SubscriptionItemBillingThresholds */ subscription_item_billing_thresholds: { /** @description Usage threshold that triggers the subscription to create an invoice */ - usage_gte?: number; - }; + usage_gte?: number + } /** SubscriptionPendingInvoiceItemInterval */ subscription_pending_invoice_item_interval: { /** * @description Specifies invoicing frequency. Either `day`, `week`, `month` or `year`. * @enum {string} */ - interval: "day" | "month" | "week" | "year"; + interval: 'day' | 'month' | 'week' | 'year' /** @description 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: number; - }; + interval_count: number + } /** * SubscriptionSchedule * @description A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes. @@ -9362,113 +9318,113 @@ export interface definitions { */ subscription_schedule: { /** @description Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch. */ - canceled_at?: number; + canceled_at?: number /** @description Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch. */ - completed_at?: number; + completed_at?: number /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; - current_phase?: definitions["subscription_schedule_current_phase"]; + created: number + current_phase?: definitions['subscription_schedule_current_phase'] /** @description ID of the customer who owns the subscription schedule. */ - customer: string; - default_settings: definitions["subscription_schedules_resource_default_settings"]; + customer: string + default_settings: definitions['subscription_schedules_resource_default_settings'] /** * @description Behavior of the subscription schedule and underlying subscription when it ends. * @enum {string} */ - end_behavior: "cancel" | "none" | "release" | "renew"; + end_behavior: 'cancel' | 'none' | 'release' | 'renew' /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: unknown }; + metadata?: { [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "subscription_schedule"; + object: 'subscription_schedule' /** @description Configuration for the subscription schedule's phases. */ - phases: definitions["subscription_schedule_phase_configuration"][]; + phases: definitions['subscription_schedule_phase_configuration'][] /** @description Time at which the subscription schedule was released. Measured in seconds since the Unix epoch. */ - released_at?: number; + released_at?: number /** @description ID of the subscription once managed by the subscription schedule (if it is released). */ - released_subscription?: string; + released_subscription?: string /** * @description 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). * @enum {string} */ - status: "active" | "canceled" | "completed" | "not_started" | "released"; + status: 'active' | 'canceled' | 'completed' | 'not_started' | 'released' /** @description ID of the subscription managed by the subscription schedule. */ - subscription?: string; - }; + subscription?: string + } /** * SubscriptionScheduleConfigurationItem * @description A phase item describes the plan and quantity of a phase. */ subscription_schedule_configuration_item: { - billing_thresholds?: definitions["subscription_item_billing_thresholds"]; + billing_thresholds?: definitions['subscription_item_billing_thresholds'] /** @description ID of the plan to which the customer should be subscribed. */ - plan: string; + plan: string /** @description Quantity of the plan to which the customer should be subscribed. */ - quantity?: number; + quantity?: number /** @description 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?: definitions["tax_rate"][]; - }; + tax_rates?: definitions['tax_rate'][] + } /** SubscriptionScheduleCurrentPhase */ subscription_schedule_current_phase: { /** @description The end of this phase of the subscription schedule. */ - end_date: number; + end_date: number /** @description The start of this phase of the subscription schedule. */ - start_date: number; - }; + start_date: number + } /** * SubscriptionSchedulePhaseConfiguration * @description A phase describes the plans, coupon, and trialing status of a subscription for a predefined time period. */ subscription_schedule_phase_configuration: { /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account during this phase of the schedule. */ - application_fee_percent?: number; - billing_thresholds?: definitions["subscription_billing_thresholds"]; + application_fee_percent?: number + billing_thresholds?: definitions['subscription_billing_thresholds'] /** * @description 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. * @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' /** @description ID of the coupon to use during this phase of the subscription schedule. */ - coupon?: string; + coupon?: string /** @description 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?: string; + default_payment_method?: string /** @description The default tax rates to apply to the subscription during this phase of the subscription schedule. */ - default_tax_rates?: definitions["tax_rate"][]; + default_tax_rates?: definitions['tax_rate'][] /** @description The end of this phase of the subscription schedule. */ - end_date: number; - invoice_settings?: definitions["invoice_setting_subscription_schedule_setting"]; + end_date: number + invoice_settings?: definitions['invoice_setting_subscription_schedule_setting'] /** @description Plans to subscribe during this phase of the subscription schedule. */ - plans: definitions["subscription_schedule_configuration_item"][]; + plans: definitions['subscription_schedule_configuration_item'][] /** * @description Controls whether or not the subscription schedule will prorate when transitioning to this phase. Values are `create_prorations` and `none`. * @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** @description The start of this phase of the subscription schedule. */ - start_date: number; + start_date: number /** @description If provided, each invoice created during this phase of the subscription schedule will apply the tax rate, increasing the amount billed to the customer. */ - tax_percent?: number; + tax_percent?: number /** @description When the trial ends within the phase. */ - trial_end?: number; - }; + trial_end?: number + } /** SubscriptionSchedulesResourceDefaultSettings */ subscription_schedules_resource_default_settings: { - billing_thresholds?: definitions["subscription_billing_thresholds"]; + billing_thresholds?: definitions['subscription_billing_thresholds'] /** * @description 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. * @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' /** @description 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?: string; - invoice_settings?: definitions["invoice_setting_subscription_schedule_setting"]; - }; + default_payment_method?: string + invoice_settings?: definitions['invoice_setting_subscription_schedule_setting'] + } /** * SubscriptionsResourcePauseCollection * @description The Pause Collection settings determine how we will pause collection for this subscription and for how long the subscription @@ -9479,10 +9435,10 @@ export interface definitions { * @description The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`. * @enum {string} */ - behavior: "keep_as_draft" | "mark_uncollectible" | "void"; + behavior: 'keep_as_draft' | 'mark_uncollectible' | 'void' /** @description The time after which the subscription will resume collecting payments. */ - resumes_at?: number; - }; + resumes_at?: number + } /** * SubscriptionsResourcePendingUpdate * @description Pending Updates store the changes pending from a previous update that will be applied @@ -9490,32 +9446,32 @@ export interface definitions { */ subscriptions_resource_pending_update: { /** @description 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. */ - billing_cycle_anchor?: number; + billing_cycle_anchor?: number /** @description The point after which the changes reflected by this update will be discarded and no longer applied. */ - expires_at: number; + expires_at: number /** @description List of subscription items, each with an attached plan, that will be set if the update is applied. */ - subscription_items?: definitions["subscription_item"][]; + subscription_items?: definitions['subscription_item'][] /** @description 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?: number; + trial_end?: number /** @description 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. */ - trial_from_plan?: boolean; - }; + trial_from_plan?: boolean + } /** TaxDeductedAtSource */ tax_deducted_at_source: { /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "tax_deducted_at_source"; + object: 'tax_deducted_at_source' /** @description The end of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period. */ - period_end: number; + period_end: number /** @description The start of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period. */ - period_start: number; + period_start: number /** @description The TAN that was supplied to Stripe when TDS was assessed */ - tax_deduction_account_number: string; - }; + tax_deduction_account_number: string + } /** * tax_id * @description You can add one or multiple tax IDs to a [customer](https://stripe.com/docs/api/customers). @@ -9525,65 +9481,65 @@ export interface definitions { */ tax_id: { /** @description Two-letter ISO code representing the country of the tax ID. */ - country?: string; + country?: string /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description ID of the customer. */ - customer: string; + customer: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "tax_id"; + object: 'tax_id' /** * @description Type of the tax ID, one of `au_abn`, `ca_bn`, `ca_qst`, `ch_vat`, `es_cif`, `eu_vat`, `hk_br`, `in_gst`, `jp_cn`, `kr_brn`, `li_uid`, `mx_rfc`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `ru_inn`, `sg_gst`, `sg_uen`, `th_vat`, `tw_vat`, `us_ein`, or `za_vat`. Note that some legacy tax IDs have type `unknown` * @enum {string} */ type: - | "au_abn" - | "ca_bn" - | "ca_qst" - | "ch_vat" - | "es_cif" - | "eu_vat" - | "hk_br" - | "in_gst" - | "jp_cn" - | "kr_brn" - | "li_uid" - | "mx_rfc" - | "my_itn" - | "my_sst" - | "no_vat" - | "nz_gst" - | "ru_inn" - | "sg_gst" - | "sg_uen" - | "th_vat" - | "tw_vat" - | "unknown" - | "us_ein" - | "za_vat"; + | 'au_abn' + | 'ca_bn' + | 'ca_qst' + | 'ch_vat' + | 'es_cif' + | 'eu_vat' + | 'hk_br' + | 'in_gst' + | 'jp_cn' + | 'kr_brn' + | 'li_uid' + | 'mx_rfc' + | 'my_itn' + | 'my_sst' + | 'no_vat' + | 'nz_gst' + | 'ru_inn' + | 'sg_gst' + | 'sg_uen' + | 'th_vat' + | 'tw_vat' + | 'unknown' + | 'us_ein' + | 'za_vat' /** @description Value of the tax ID. */ - value: string; - verification: definitions["tax_id_verification"]; - }; + value: string + verification: definitions['tax_id_verification'] + } /** tax_id_verification */ tax_id_verification: { /** * @description Verification status, one of `pending`, `verified`, `unverified`, or `unavailable`. * @enum {string} */ - status: "pending" | "unavailable" | "unverified" | "verified"; + status: 'pending' | 'unavailable' | 'unverified' | 'verified' /** @description Verified address. */ - verified_address?: string; + verified_address?: string /** @description Verified name. */ - verified_name?: string; - }; + verified_name?: string + } /** * TaxRate * @description Tax rates can be applied to invoices and subscriptions to collect tax. @@ -9592,106 +9548,106 @@ export interface definitions { */ tax_rate: { /** @description Defaults to `true`. When set to `false`, this tax rate cannot be applied to objects in the API, but will still be applied to subscriptions and invoices that already have it set. */ - active: boolean; + active: boolean /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. */ - description?: string; + description?: string /** @description 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: string; + display_name: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description This specifies if the tax rate is inclusive or exclusive. */ - inclusive: boolean; + inclusive: boolean /** @description The jurisdiction for the tax rate. */ - jurisdiction?: string; + jurisdiction?: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: unknown }; + metadata: { [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "tax_rate"; + object: 'tax_rate' /** @description This represents the tax rate percent out of 100. */ - percentage: number; - }; + percentage: number + } /** * TerminalConnectionToken * @description A Connection Token is used by the Stripe Terminal SDK to connect to a reader. * * Related guide: [Fleet Management](https://stripe.com/docs/terminal/readers/fleet-management#create). */ - "terminal.connection_token": { + 'terminal.connection_token': { /** @description The id of the location that this connection token is scoped to. */ - location?: string; + location?: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "terminal.connection_token"; + object: 'terminal.connection_token' /** @description Your application should pass this token to the Stripe Terminal SDK. */ - secret: string; - }; + secret: string + } /** * TerminalLocationLocation * @description A Location represents a grouping of readers. * * Related guide: [Fleet Management](https://stripe.com/docs/terminal/readers/fleet-management#create). */ - "terminal.location": { - address: definitions["address"]; + 'terminal.location': { + address: definitions['address'] /** @description The display name of the location. */ - display_name: string; + display_name: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: unknown }; + metadata: { [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "terminal.location"; - }; + object: 'terminal.location' + } /** * TerminalReaderReader * @description A Reader represents a physical device for accepting payment details. * * Related guide: [Connecting to a Reader](https://stripe.com/docs/terminal/readers/connecting). */ - "terminal.reader": { + 'terminal.reader': { /** @description The current software version of the reader. */ - device_sw_version?: string; + device_sw_version?: string /** * @description Type of reader, one of `bbpos_chipper2x` or `verifone_P400`. * @enum {string} */ - device_type: "bbpos_chipper2x" | "verifone_P400"; + device_type: 'bbpos_chipper2x' | 'verifone_P400' /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The local IP address of the reader. */ - ip_address?: string; + ip_address?: string /** @description Custom label given to the reader for easier identification. */ - label: string; + label: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description The location identifier of the reader. */ - location?: string; + location?: string /** @description 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: { [key: string]: unknown }; + metadata: { [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "terminal.reader"; + object: 'terminal.reader' /** @description Serial number of the reader. */ - serial_number: string; + serial_number: string /** @description The networking status of the reader. */ - status?: string; - }; + status?: string + } /** * ThreeDSecure * @description Cardholder authentication via 3D Secure is initiated by creating a `3D Secure` @@ -9700,42 +9656,42 @@ export interface definitions { */ three_d_secure: { /** @description Amount of the charge that you will create when authentication completes. */ - amount: number; + amount: number /** @description True if the cardholder went through the authentication flow and their bank indicated that authentication succeeded. */ - authenticated: boolean; - card: definitions["card"]; + authenticated: boolean + card: definitions['card'] /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "three_d_secure"; + object: 'three_d_secure' /** @description If present, this is the URL that you should send the cardholder to for authentication. If you are going to use Stripe.js to display the authentication page in an iframe, you should use the value "_callback". */ - redirect_url?: string; + redirect_url?: string /** @description Possible values are `redirect_pending`, `succeeded`, or `failed`. When the cardholder can be authenticated, the object starts with status `redirect_pending`. When liability will be shifted to the cardholder's bank (either because the cardholder was successfully authenticated, or because the bank has not implemented 3D Secure, the object wlil be in status `succeeded`. `failed` indicates that authentication was attempted unsuccessfully. */ - status: string; - }; + status: string + } /** three_d_secure_details */ three_d_secure_details: { /** @description Whether or not authentication was performed. 3D Secure will succeed without authentication when the card is not enrolled. */ - authenticated?: boolean; + authenticated?: boolean /** @description Whether or not 3D Secure succeeded. */ - succeeded?: boolean; + succeeded?: boolean /** @description The version of 3D Secure that was used for this payment. */ - version: string; - }; + version: string + } /** three_d_secure_usage */ three_d_secure_usage: { /** @description Whether 3D Secure is supported on this card. */ - supported: boolean; - }; + supported: boolean + } /** * Token * @description Tokenization is the process Stripe uses to collect sensitive card or bank @@ -9762,26 +9718,26 @@ export interface definitions { * Related guide: [Accept a payment](https://stripe.com/docs/payments/accept-a-payment-charges#web-create-token) */ token: { - bank_account?: definitions["bank_account"]; - card?: definitions["card"]; + bank_account?: definitions['bank_account'] + card?: definitions['card'] /** @description IP address of the client that generated the token. */ - client_ip?: string; + client_ip?: string /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "token"; + object: 'token' /** @description Type of the token: `account`, `bank_account`, `card`, or `pii`. */ - type: string; + type: string /** @description Whether this token has already been used (tokens can be used only once). */ - used: boolean; - }; + used: boolean + } /** * Topup * @description To top up your Stripe balance, you create a top-up object. You can retrieve @@ -9792,43 +9748,43 @@ export interface definitions { */ topup: { /** @description Amount transferred. */ - amount: number; + amount: number /** @description 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?: string; + balance_transaction?: string /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description 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?: number; + expected_availability_date?: number /** @description 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?: string; + failure_code?: string /** @description Message to user further explaining reason for top-up failure if available. */ - failure_message?: string; + failure_message?: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: unknown }; + metadata: { [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "topup"; - source: definitions["source"]; + object: 'topup' + source: definitions['source'] /** @description Extra information about a top-up. This will appear on your source's bank statement. It must contain at least one letter. */ - statement_descriptor?: string; + statement_descriptor?: string /** * @description The status of the top-up is either `canceled`, `failed`, `pending`, `reversed`, or `succeeded`. * @enum {string} */ - status: "canceled" | "failed" | "pending" | "reversed" | "succeeded"; + status: 'canceled' | 'failed' | 'pending' | 'reversed' | 'succeeded' /** @description A string that identifies this top-up as part of a group. */ - transfer_group?: string; - }; + transfer_group?: string + } /** * Transfer * @description A `Transfer` object is created when you move funds between Stripe accounts as @@ -9844,69 +9800,69 @@ export interface definitions { */ transfer: { /** @description Amount in %s to be transferred. */ - amount: number; + amount: number /** @description Amount in %s reversed (can be less than the amount attribute on the transfer if a partial reversal was issued). */ - amount_reversed: number; + amount_reversed: number /** @description Balance transaction that describes the impact of this transfer on your account balance. */ - balance_transaction?: string; + balance_transaction?: string /** @description Time that this record of the transfer was first created. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description ID of the Stripe account the transfer was sent to. */ - destination?: string; + destination?: string /** @description 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?: string; + destination_payment?: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: unknown }; + metadata: { [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "transfer"; + object: 'transfer' /** * TransferReversalList * @description A list of reversals that have been applied to the transfer. */ reversals: { /** @description Details about each object. */ - data: definitions["transfer_reversal"][]; + data: definitions['transfer_reversal'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** @description Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false. */ - reversed: boolean; + reversed: boolean /** @description ID of the charge or payment that was used to fund the transfer. If null, the transfer was funded from the available balance. */ - source_transaction?: string; + source_transaction?: string /** @description The source balance this transfer came from. One of `card`, `fpx`, or `bank_account`. */ - source_type?: string; + source_type?: string /** @description A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-options) for details. */ - transfer_group?: string; - }; + transfer_group?: string + } /** transfer_data */ transfer_data: { /** @description 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?: number; + amount?: number /** * @description The account (if any) the payment will be attributed to for tax * reporting, and where funds from the payment will be transferred to upon * payment success. */ - destination: string; - }; + destination: string + } /** * TransferReversal * @description [Stripe Connect](https://stripe.com/docs/connect) platforms can reverse transfers made to a @@ -9925,50 +9881,50 @@ export interface definitions { */ transfer_reversal: { /** @description Amount, in %s. */ - amount: number; + amount: number /** @description Balance transaction that describes the impact on your account balance. */ - balance_transaction?: string; + balance_transaction?: string /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Linked payment refund for the transfer reversal. */ - destination_payment_refund?: string; + destination_payment_refund?: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description 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: { [key: string]: unknown }; + metadata: { [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "transfer_reversal"; + object: 'transfer_reversal' /** @description ID of the refund responsible for the transfer reversal. */ - source_refund?: string; + source_refund?: string /** @description ID of the transfer that was reversed. */ - transfer: string; - }; + transfer: string + } /** TransferSchedule */ transfer_schedule: { /** @description The number of days charges for the account will be held before being paid out. */ - delay_days: number; + delay_days: number /** @description How frequently funds will be paid out. One of `manual` (payouts only created via API call), `daily`, `weekly`, or `monthly`. */ - interval: string; + interval: string /** @description 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?: number; + monthly_anchor?: number /** @description The day of the week funds will be paid out, of the style 'monday', 'tuesday', etc. Only shown if `interval` is weekly. */ - weekly_anchor?: string; - }; + weekly_anchor?: string + } /** TransformUsage */ transform_usage: { /** @description Divide usage by this number. */ - divide_by: number; + divide_by: number /** * @description After division, either round the result `up` or `down`. * @enum {string} */ - round: "down" | "up"; - }; + round: 'down' | 'up' + } /** * UsageRecord * @description Usage records allow you to report customer usage and metrics to Stripe for @@ -9978,40 +9934,40 @@ export interface definitions { */ usage_record: { /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "usage_record"; + object: 'usage_record' /** @description The usage quantity for the specified date. */ - quantity: number; + quantity: number /** @description The ID of the subscription item this usage record contains data for. */ - subscription_item: string; + subscription_item: string /** @description The timestamp when this usage occurred. */ - timestamp: number; - }; + timestamp: number + } /** UsageRecordSummary */ usage_record_summary: { /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The invoice in which this usage period has been billed for. */ - invoice?: string; + invoice?: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "usage_record_summary"; - period: definitions["period"]; + object: 'usage_record_summary' + period: definitions['period'] /** @description The ID of the subscription item this summary is describing. */ - subscription_item: string; + subscription_item: string /** @description The total usage within this usage period. */ - total_usage: number; - }; + total_usage: number + } /** * NotificationWebhookEndpoint * @description You can configure [webhook endpoints](https://stripe.com/docs/webhooks/) via the API to be @@ -10024,33 +9980,33 @@ export interface definitions { */ webhook_endpoint: { /** @description The API version events are rendered as for this webhook endpoint. */ - api_version?: string; + api_version?: string /** @description The ID of the associated Connect application. */ - application?: string; + application?: string /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description An optional description of what the wehbook is used for. */ - description?: string; + description?: string /** @description The list of events to enable for this endpoint. `['*']` indicates that all events are enabled, except those that require explicit selection. */ - enabled_events: string[]; + enabled_events: string[] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: unknown }; + metadata: { [key: string]: unknown } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "webhook_endpoint"; + object: 'webhook_endpoint' /** @description The endpoint's secret, used to generate [webhook signatures](https://stripe.com/docs/webhooks/signatures). Only returned at creation. */ - secret?: string; + secret?: string /** @description The status of the webhook. It can be `enabled` or `disabled`. */ - status: string; + status: string /** @description The URL of the webhook endpoint. */ - url: string; - }; + url: string + } } export interface operations { @@ -10061,72 +10017,72 @@ export interface operations { /** Body parameters for the request. */ payload: { /** @description Amount of the charge that you will create when authentication completes. */ - amount: number; + amount: number /** @description The ID of a card token, or the ID of a card belonging to the given customer. */ - card?: string; + card?: string /** @description 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: string; + currency: string /** @description The customer associated with this 3D secure authentication. */ - customer?: string; + customer?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The URL that the cardholder's browser will be returned to when authentication completes. */ - return_url: string; - }; - }; - }; + return_url: string + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["three_d_secure"]; - }; + schema: definitions['three_d_secure'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves a 3D Secure object.

*/ Get3dSecureThreeDSecure: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - three_d_secure: string; - }; - }; + three_d_secure: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["three_d_secure"]; - }; + schema: definitions['three_d_secure'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves the details of an account.

*/ GetAccount: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; - }; + expand?: unknown[] + } + } responses: { /** Successful response. */ 200: { - schema: definitions["account"]; - }; + schema: definitions['account'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

Updates a connected Express or Custom account by setting the values of the parameters passed. Any parameters not provided are left unchanged. Most parameters can be changed only for Custom accounts. (These are marked Custom Only below.) Parameters marked Custom and Express are supported by both account types.

* @@ -10138,27 +10094,27 @@ export interface operations { /** Body parameters for the request. */ payload?: { /** @description An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account. */ - account_token?: string; + account_token?: string /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js), or a dictionary containing a user's bank account details. */ - bank_account?: unknown; + bank_account?: unknown /** * business_profile_specs * @description Business information about the account. */ business_profile?: { - mcc?: string; - name?: string; - product_description?: string; - support_email?: string; - support_phone?: string; - support_url?: string; - url?: string; - }; + mcc?: string + name?: string + product_description?: string + support_email?: string + support_phone?: string + support_url?: string + url?: string + } /** * @description The business type. * @enum {string} */ - business_type?: "company" | "government_entity" | "individual" | "non_profit"; + business_type?: 'company' | 'government_entity' | 'individual' | 'non_profit' /** * company_specs * @description Information about the company or business. This field is null unless `business_type` is set to `company`, `government_entity`, or `non_profit`. @@ -10166,78 +10122,78 @@ export interface operations { company?: { /** address_specs */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** japan_address_kana_specs */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** japan_address_kanji_specs */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; - directors_provided?: boolean; - executives_provided?: boolean; - name?: string; - name_kana?: string; - name_kanji?: string; - owners_provided?: boolean; - phone?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } + directors_provided?: boolean + executives_provided?: boolean + name?: string + name_kana?: string + name_kanji?: string + owners_provided?: boolean + phone?: string /** @enum {string} */ structure?: - | "" - | "government_instrumentality" - | "governmental_unit" - | "incorporated_non_profit" - | "limited_liability_partnership" - | "multi_member_llc" - | "private_company" - | "private_corporation" - | "private_partnership" - | "public_company" - | "public_corporation" - | "public_partnership" - | "sole_proprietorship" - | "tax_exempt_government_instrumentality" - | "unincorporated_association" - | "unincorporated_non_profit"; - tax_id?: string; - tax_id_registrar?: string; - vat_id?: string; + | '' + | 'government_instrumentality' + | 'governmental_unit' + | 'incorporated_non_profit' + | 'limited_liability_partnership' + | 'multi_member_llc' + | 'private_company' + | 'private_corporation' + | 'private_partnership' + | 'public_company' + | 'public_corporation' + | 'public_partnership' + | 'sole_proprietorship' + | 'tax_exempt_government_instrumentality' + | 'unincorporated_association' + | 'unincorporated_non_profit' + tax_id?: string + tax_id_registrar?: string + vat_id?: string /** verification_specs */ verification?: { /** verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; + back?: string + front?: string + } + } + } /** @description 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?: string; + default_currency?: string /** @description Email address of the account representative. For Standard accounts, this is used to ask them to claim their Stripe account. For Custom accounts, this only makes the account easier to identify to platforms; Stripe does not email the account representative. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A card or bank account to attach to the account. You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://stripe.com/docs/api#account_create_bank_account) creation.

By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the bank account or card creation API. */ - external_account?: string; + external_account?: string /** * individual_specs * @description Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. @@ -10245,74 +10201,74 @@ export interface operations { individual?: { /** address_specs */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** japan_address_kana_specs */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** japan_address_kanji_specs */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; - dob?: unknown; - email?: string; - first_name?: string; - first_name_kana?: string; - first_name_kanji?: string; - gender?: string; - id_number?: string; - last_name?: string; - last_name_kana?: string; - last_name_kanji?: string; - maiden_name?: string; - metadata?: unknown; - phone?: string; - ssn_last_4?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } + dob?: unknown + email?: string + first_name?: string + first_name_kana?: string + first_name_kanji?: string + gender?: string + id_number?: string + last_name?: string + last_name_kana?: string + last_name_kanji?: string + maiden_name?: string + metadata?: unknown + phone?: string + ssn_last_4?: string /** person_verification_specs */ verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; + back?: string + front?: string + } + } + } /** @description 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. 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?: unknown; + metadata?: unknown /** @description The set of capabilities you want to unlock for this account. Each capability will be inactive until you have provided its specific requirements and Stripe has verified them. An account may have some of its requested capabilities be active and some be inactive. */ requested_capabilities?: ( - | "au_becs_debit_payments" - | "card_issuing" - | "card_payments" - | "jcb_payments" - | "legacy_payments" - | "tax_reporting_us_1099_k" - | "tax_reporting_us_1099_misc" - | "transfers" - )[]; + | 'au_becs_debit_payments' + | 'card_issuing' + | 'card_payments' + | 'jcb_payments' + | 'legacy_payments' + | 'tax_reporting_us_1099_k' + | 'tax_reporting_us_1099_misc' + | 'transfers' + )[] /** * settings_specs * @description Options for customizing how the account functions within Stripe. @@ -10320,64 +10276,64 @@ export interface operations { settings?: { /** branding_settings_specs */ branding?: { - icon?: string; - logo?: string; - primary_color?: string; - secondary_color?: string; - }; + icon?: string + logo?: string + primary_color?: string + secondary_color?: string + } /** card_payments_settings_specs */ card_payments?: { /** decline_charge_on_specs */ decline_on?: { - avs_failure?: boolean; - cvc_failure?: boolean; - }; - statement_descriptor_prefix?: string; - }; + avs_failure?: boolean + cvc_failure?: boolean + } + statement_descriptor_prefix?: string + } /** payments_settings_specs */ payments?: { - statement_descriptor?: string; - statement_descriptor_kana?: string; - statement_descriptor_kanji?: string; - }; + statement_descriptor?: string + statement_descriptor_kana?: string + statement_descriptor_kanji?: string + } /** payout_settings_specs */ payouts?: { - debit_negative_balances?: boolean; + debit_negative_balances?: boolean /** transfer_schedule_specs */ schedule?: { - delay_days?: unknown; + delay_days?: unknown /** @enum {string} */ - interval?: "daily" | "manual" | "monthly" | "weekly"; - monthly_anchor?: number; + interval?: 'daily' | 'manual' | 'monthly' | 'weekly' + monthly_anchor?: number /** @enum {string} */ - weekly_anchor?: "friday" | "monday" | "saturday" | "sunday" | "thursday" | "tuesday" | "wednesday"; - }; - statement_descriptor?: string; - }; - }; + weekly_anchor?: 'friday' | 'monday' | 'saturday' | 'sunday' | 'thursday' | 'tuesday' | 'wednesday' + } + statement_descriptor?: string + } + } /** * tos_acceptance_specs * @description Details on the account's acceptance of the [Stripe Services Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance). */ tos_acceptance?: { - date?: number; - ip?: string; - user_agent?: string; - }; - }; - }; - }; + date?: number + ip?: string + user_agent?: string + } + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["account"]; - }; + schema: definitions['account'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

With Connect, you can delete Custom or Express accounts you manage.

* @@ -10390,21 +10346,21 @@ export interface operations { body: { /** Body parameters for the request. */ payload?: { - account?: string; - }; - }; - }; + account?: string + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["deleted_account"]; - }; + schema: definitions['deleted_account'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Create an external account for a given account.

*/ PostAccountBankAccounts: { parameters: { @@ -10412,51 +10368,51 @@ export interface operations { /** Body parameters for the request. */ payload?: { /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js), or a dictionary containing a user's bank account details. */ - bank_account?: unknown; + bank_account?: unknown /** @description When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency. */ - default_for_currency?: boolean; + default_for_currency?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - external_account?: string; + external_account?: string /** @description 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. 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?: { [key: string]: unknown }; - }; - }; - }; + metadata?: { [key: string]: unknown } + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["external_account"]; - }; + schema: definitions['external_account'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieve a specified external account for a given account.

*/ GetAccountBankAccountsId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["external_account"]; - }; + schema: definitions['external_account'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

Updates the metadata, account holder name, and account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

*

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

@@ -10464,190 +10420,190 @@ export interface operations { PostAccountBankAccountsId: { parameters: { path: { - id: string; - }; + id: string + } body: { /** Body parameters for the request. */ payload?: { /** @description The name of the person or business that owns the bank account. */ - account_holder_name?: string; + account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - account_holder_type?: "" | "company" | "individual"; + account_holder_type?: '' | 'company' | 'individual' /** @description City/District/Suburb/Town/Village. */ - address_city?: string; + address_city?: string /** @description Billing address country, if provided when creating card. */ - address_country?: string; + address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - address_line1?: string; + address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - address_line2?: string; + address_line2?: string /** @description State/County/Province/Region. */ - address_state?: string; + address_state?: string /** @description ZIP or postal code. */ - address_zip?: string; + address_zip?: string /** @description When set to true, this becomes the default external account for its currency. */ - default_for_currency?: boolean; + default_for_currency?: boolean /** @description Two digit number representing the card’s expiration month. */ - exp_month?: string; + exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - exp_year?: string; + exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: unknown; + metadata?: unknown /** @description Cardholder name. */ - name?: string; - }; - }; - }; + name?: string + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["external_account"]; - }; + schema: definitions['external_account'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Delete a specified external account for a given account.

*/ DeleteAccountBankAccountsId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["deleted_external_account"]; - }; + schema: definitions['deleted_external_account'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ GetAccountCapabilities: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; - }; + expand?: unknown[] + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["capability"][]; + data: definitions['capability'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves information about the specified Account Capability.

*/ GetAccountCapabilitiesCapability: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - capability: string; - }; - }; + capability: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["capability"]; - }; + schema: definitions['capability'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Updates an existing Account Capability.

*/ PostAccountCapabilitiesCapability: { parameters: { path: { - capability: string; - }; + capability: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. */ - requested?: boolean; - }; - }; - }; + requested?: boolean + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["capability"]; - }; + schema: definitions['capability'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

List external accounts for an account.

*/ GetAccountExternalAccounts: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { schema: { /** @description The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards. */ - data: definitions["bank_account"][]; + data: definitions['bank_account'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Create an external account for a given account.

*/ PostAccountExternalAccounts: { parameters: { @@ -10655,51 +10611,51 @@ export interface operations { /** Body parameters for the request. */ payload?: { /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js), or a dictionary containing a user's bank account details. */ - bank_account?: unknown; + bank_account?: unknown /** @description When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency. */ - default_for_currency?: boolean; + default_for_currency?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - external_account?: string; + external_account?: string /** @description 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. 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?: { [key: string]: unknown }; - }; - }; - }; + metadata?: { [key: string]: unknown } + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["external_account"]; - }; + schema: definitions['external_account'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieve a specified external account for a given account.

*/ GetAccountExternalAccountsId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["external_account"]; - }; + schema: definitions['external_account'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

Updates the metadata, account holder name, and account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

*

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

@@ -10707,74 +10663,74 @@ export interface operations { PostAccountExternalAccountsId: { parameters: { path: { - id: string; - }; + id: string + } body: { /** Body parameters for the request. */ payload?: { /** @description The name of the person or business that owns the bank account. */ - account_holder_name?: string; + account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - account_holder_type?: "" | "company" | "individual"; + account_holder_type?: '' | 'company' | 'individual' /** @description City/District/Suburb/Town/Village. */ - address_city?: string; + address_city?: string /** @description Billing address country, if provided when creating card. */ - address_country?: string; + address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - address_line1?: string; + address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - address_line2?: string; + address_line2?: string /** @description State/County/Province/Region. */ - address_state?: string; + address_state?: string /** @description ZIP or postal code. */ - address_zip?: string; + address_zip?: string /** @description When set to true, this becomes the default external account for its currency. */ - default_for_currency?: boolean; + default_for_currency?: boolean /** @description Two digit number representing the card’s expiration month. */ - exp_month?: string; + exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - exp_year?: string; + exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: unknown; + metadata?: unknown /** @description Cardholder name. */ - name?: string; - }; - }; - }; + name?: string + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["external_account"]; - }; + schema: definitions['external_account'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Delete a specified external account for a given account.

*/ DeleteAccountExternalAccountsId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["deleted_external_account"]; - }; + schema: definitions['deleted_external_account'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

Creates a single-use login link for an Express account to access their Stripe dashboard.

* @@ -10785,25 +10741,25 @@ export interface operations { body: { /** Body parameters for the request. */ payload: { - account: string; + account: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Where to redirect the user after they log out of their dashboard. */ - redirect_url?: string; - }; - }; - }; + redirect_url?: string + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["login_link"]; - }; + schema: definitions['login_link'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

Invalidates all sessions for a light account, for a platform to use during platform logout.

* @@ -10814,150 +10770,150 @@ export interface operations { body: { /** Body parameters for the request. */ payload: { - account: string; + account: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; + expand?: string[] + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["light_account_logout"]; - }; + schema: definitions['light_account_logout'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ GetAccountPeople: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Filters on the list of people returned based on the person's relationship to the account's company. */ - relationship?: string; + relationship?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["person"][]; + data: definitions['person'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Creates a new person.

*/ PostAccountPeople: { parameters: { body: { /** Body parameters for the request. */ payload?: { - account?: string; + account?: string /** * address_specs * @description The person's address. */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** @description The person's date of birth. */ - dob?: unknown; + dob?: unknown /** @description The person's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The person's first name. */ - first_name?: string; + first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - first_name_kana?: string; + first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - first_name_kanji?: string; + first_name_kanji?: string /** @description The person's gender (International regulations require either "male" or "female"). */ - gender?: string; + gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/stripe.js#collecting-pii-data). */ - id_number?: string; + id_number?: string /** @description The person's last name. */ - last_name?: string; + last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - last_name_kana?: string; + last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - last_name_kanji?: string; + last_name_kanji?: string /** @description The person's maiden name. */ - maiden_name?: string; + maiden_name?: string /** @description 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. 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?: unknown; + metadata?: unknown /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - person_token?: string; + person_token?: string /** @description The person's phone number. */ - phone?: string; + phone?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - percent_ownership?: unknown; - representative?: boolean; - title?: string; - }; + director?: boolean + executive?: boolean + owner?: boolean + percent_ownership?: unknown + representative?: boolean + title?: string + } /** @description The last 4 digits of the person's social security number. */ - ssn_last_4?: string; + ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -10965,143 +10921,143 @@ export interface operations { verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; - }; - }; + back?: string + front?: string + } + } + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["person"]; - }; + schema: definitions['person'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves an existing person.

*/ GetAccountPeoplePerson: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - person: string; - }; - }; + person: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["person"]; - }; + schema: definitions['person'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Updates an existing person.

*/ PostAccountPeoplePerson: { parameters: { path: { - person: string; - }; + person: string + } body: { /** Body parameters for the request. */ payload?: { - account?: string; + account?: string /** * address_specs * @description The person's address. */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** @description The person's date of birth. */ - dob?: unknown; + dob?: unknown /** @description The person's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The person's first name. */ - first_name?: string; + first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - first_name_kana?: string; + first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - first_name_kanji?: string; + first_name_kanji?: string /** @description The person's gender (International regulations require either "male" or "female"). */ - gender?: string; + gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/stripe.js#collecting-pii-data). */ - id_number?: string; + id_number?: string /** @description The person's last name. */ - last_name?: string; + last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - last_name_kana?: string; + last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - last_name_kanji?: string; + last_name_kanji?: string /** @description The person's maiden name. */ - maiden_name?: string; + maiden_name?: string /** @description 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. 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?: unknown; + metadata?: unknown /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - person_token?: string; + person_token?: string /** @description The person's phone number. */ - phone?: string; + phone?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - percent_ownership?: unknown; - representative?: boolean; - title?: string; - }; + director?: boolean + executive?: boolean + owner?: boolean + percent_ownership?: unknown + representative?: boolean + title?: string + } /** @description The last 4 digits of the person's social security number. */ - ssn_last_4?: string; + ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -11109,174 +11065,174 @@ export interface operations { verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; - }; - }; + back?: string + front?: string + } + } + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["person"]; - }; + schema: definitions['person'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ DeleteAccountPeoplePerson: { parameters: { path: { - person: string; - }; - }; + person: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["deleted_person"]; - }; + schema: definitions['deleted_person'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ GetAccountPersons: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Filters on the list of people returned based on the person's relationship to the account's company. */ - relationship?: string; + relationship?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["person"][]; + data: definitions['person'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Creates a new person.

*/ PostAccountPersons: { parameters: { body: { /** Body parameters for the request. */ payload?: { - account?: string; + account?: string /** * address_specs * @description The person's address. */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** @description The person's date of birth. */ - dob?: unknown; + dob?: unknown /** @description The person's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The person's first name. */ - first_name?: string; + first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - first_name_kana?: string; + first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - first_name_kanji?: string; + first_name_kanji?: string /** @description The person's gender (International regulations require either "male" or "female"). */ - gender?: string; + gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/stripe.js#collecting-pii-data). */ - id_number?: string; + id_number?: string /** @description The person's last name. */ - last_name?: string; + last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - last_name_kana?: string; + last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - last_name_kanji?: string; + last_name_kanji?: string /** @description The person's maiden name. */ - maiden_name?: string; + maiden_name?: string /** @description 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. 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?: unknown; + metadata?: unknown /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - person_token?: string; + person_token?: string /** @description The person's phone number. */ - phone?: string; + phone?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - percent_ownership?: unknown; - representative?: boolean; - title?: string; - }; + director?: boolean + executive?: boolean + owner?: boolean + percent_ownership?: unknown + representative?: boolean + title?: string + } /** @description The last 4 digits of the person's social security number. */ - ssn_last_4?: string; + ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -11284,143 +11240,143 @@ export interface operations { verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; - }; - }; + back?: string + front?: string + } + } + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["person"]; - }; + schema: definitions['person'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves an existing person.

*/ GetAccountPersonsPerson: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - person: string; - }; - }; + person: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["person"]; - }; + schema: definitions['person'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Updates an existing person.

*/ PostAccountPersonsPerson: { parameters: { path: { - person: string; - }; + person: string + } body: { /** Body parameters for the request. */ payload?: { - account?: string; + account?: string /** * address_specs * @description The person's address. */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** @description The person's date of birth. */ - dob?: unknown; + dob?: unknown /** @description The person's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The person's first name. */ - first_name?: string; + first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - first_name_kana?: string; + first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - first_name_kanji?: string; + first_name_kanji?: string /** @description The person's gender (International regulations require either "male" or "female"). */ - gender?: string; + gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/stripe.js#collecting-pii-data). */ - id_number?: string; + id_number?: string /** @description The person's last name. */ - last_name?: string; + last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - last_name_kana?: string; + last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - last_name_kanji?: string; + last_name_kanji?: string /** @description The person's maiden name. */ - maiden_name?: string; + maiden_name?: string /** @description 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. 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?: unknown; + metadata?: unknown /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - person_token?: string; + person_token?: string /** @description The person's phone number. */ - phone?: string; + phone?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - percent_ownership?: unknown; - representative?: boolean; - title?: string; - }; + director?: boolean + executive?: boolean + owner?: boolean + percent_ownership?: unknown + representative?: boolean + title?: string + } /** @description The last 4 digits of the person's social security number. */ - ssn_last_4?: string; + ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -11428,47 +11384,47 @@ export interface operations { verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; - }; - }; + back?: string + front?: string + } + } + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["person"]; - }; + schema: definitions['person'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ DeleteAccountPersonsPerson: { parameters: { path: { - person: string; - }; - }; + person: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["deleted_person"]; - }; + schema: definitions['deleted_person'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ PostAccountLinks: { parameters: { @@ -11476,74 +11432,74 @@ export interface operations { /** Body parameters for the request. */ payload: { /** @description The identifier of the account to create an account link for. */ - account: string; + account: string /** * @description Which information the platform needs to collect from the user. One of `currently_due` or `eventually_due`. Default is `currently_due`. * @enum {string} */ - collect?: "currently_due" | "eventually_due"; + collect?: 'currently_due' | 'eventually_due' /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The URL that the user will be redirected to if the account link is no longer valid. */ - failure_url: string; + failure_url: string /** @description The URL that the user will be redirected to upon leaving or completing the linked flow successfully. */ - success_url: string; + success_url: string /** * @description The type of account link the user is requesting. Possible values are `custom_account_verification` or `custom_account_update`. * @enum {string} */ - type: "custom_account_update" | "custom_account_verification"; - }; - }; - }; + type: 'custom_account_update' | 'custom_account_verification' + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["account_link"]; - }; + schema: definitions['account_link'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ GetAccounts: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - created?: number; + expand?: unknown[] + created?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["account"][]; + data: definitions['account'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

With Connect, you can create Stripe accounts for your users. * To do this, you’ll first need to register your platform.

@@ -11557,27 +11513,27 @@ export interface operations { /** Body parameters for the request. */ payload?: { /** @description An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account. */ - account_token?: string; + account_token?: string /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js), or a dictionary containing a user's bank account details. */ - bank_account?: unknown; + bank_account?: unknown /** * business_profile_specs * @description Business information about the account. */ business_profile?: { - mcc?: string; - name?: string; - product_description?: string; - support_email?: string; - support_phone?: string; - support_url?: string; - url?: string; - }; + mcc?: string + name?: string + product_description?: string + support_email?: string + support_phone?: string + support_url?: string + url?: string + } /** * @description The business type. * @enum {string} */ - business_type?: "company" | "government_entity" | "individual" | "non_profit"; + business_type?: 'company' | 'government_entity' | 'individual' | 'non_profit' /** * company_specs * @description Information about the company or business. This field is null unless `business_type` is set to `company`, `government_entity`, or `non_profit`. @@ -11585,80 +11541,80 @@ export interface operations { company?: { /** address_specs */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** japan_address_kana_specs */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** japan_address_kanji_specs */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; - directors_provided?: boolean; - executives_provided?: boolean; - name?: string; - name_kana?: string; - name_kanji?: string; - owners_provided?: boolean; - phone?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } + directors_provided?: boolean + executives_provided?: boolean + name?: string + name_kana?: string + name_kanji?: string + owners_provided?: boolean + phone?: string /** @enum {string} */ structure?: - | "" - | "government_instrumentality" - | "governmental_unit" - | "incorporated_non_profit" - | "limited_liability_partnership" - | "multi_member_llc" - | "private_company" - | "private_corporation" - | "private_partnership" - | "public_company" - | "public_corporation" - | "public_partnership" - | "sole_proprietorship" - | "tax_exempt_government_instrumentality" - | "unincorporated_association" - | "unincorporated_non_profit"; - tax_id?: string; - tax_id_registrar?: string; - vat_id?: string; + | '' + | 'government_instrumentality' + | 'governmental_unit' + | 'incorporated_non_profit' + | 'limited_liability_partnership' + | 'multi_member_llc' + | 'private_company' + | 'private_corporation' + | 'private_partnership' + | 'public_company' + | 'public_corporation' + | 'public_partnership' + | 'sole_proprietorship' + | 'tax_exempt_government_instrumentality' + | 'unincorporated_association' + | 'unincorporated_non_profit' + tax_id?: string + tax_id_registrar?: string + vat_id?: string /** verification_specs */ verification?: { /** verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; + back?: string + front?: string + } + } + } /** @description The country in which the account holder resides, or in which the business is legally established. This should be an ISO 3166-1 alpha-2 country code. For example, if you are in the United States and the business for which you're creating an account is legally represented in Canada, you would use `CA` as the country for the account being created. */ - country?: string; + country?: string /** @description 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?: string; + default_currency?: string /** @description The email address of the account holder. For Custom accounts, this is only to make the account easier to identify to you: Stripe will never directly email your users. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A card or bank account to attach to the account. You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://stripe.com/docs/api#account_create_bank_account) creation.

By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the bank account or card creation API. */ - external_account?: string; + external_account?: string /** * individual_specs * @description Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. @@ -11666,74 +11622,74 @@ export interface operations { individual?: { /** address_specs */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** japan_address_kana_specs */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** japan_address_kanji_specs */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; - dob?: unknown; - email?: string; - first_name?: string; - first_name_kana?: string; - first_name_kanji?: string; - gender?: string; - id_number?: string; - last_name?: string; - last_name_kana?: string; - last_name_kanji?: string; - maiden_name?: string; - metadata?: unknown; - phone?: string; - ssn_last_4?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } + dob?: unknown + email?: string + first_name?: string + first_name_kana?: string + first_name_kanji?: string + gender?: string + id_number?: string + last_name?: string + last_name_kana?: string + last_name_kanji?: string + maiden_name?: string + metadata?: unknown + phone?: string + ssn_last_4?: string /** person_verification_specs */ verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; + back?: string + front?: string + } + } + } /** @description 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. 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?: unknown; + metadata?: unknown /** @description The set of capabilities you want to unlock for this account. Each capability will be inactive until you have provided its specific requirements and Stripe has verified them. An account may have some of its requested capabilities be active and some be inactive. */ requested_capabilities?: ( - | "au_becs_debit_payments" - | "card_issuing" - | "card_payments" - | "jcb_payments" - | "legacy_payments" - | "tax_reporting_us_1099_k" - | "tax_reporting_us_1099_misc" - | "transfers" - )[]; + | 'au_becs_debit_payments' + | 'card_issuing' + | 'card_payments' + | 'jcb_payments' + | 'legacy_payments' + | 'tax_reporting_us_1099_k' + | 'tax_reporting_us_1099_misc' + | 'transfers' + )[] /** * settings_specs * @description Options for customizing how the account functions within Stripe. @@ -11741,91 +11697,91 @@ export interface operations { settings?: { /** branding_settings_specs */ branding?: { - icon?: string; - logo?: string; - primary_color?: string; - secondary_color?: string; - }; + icon?: string + logo?: string + primary_color?: string + secondary_color?: string + } /** card_payments_settings_specs */ card_payments?: { /** decline_charge_on_specs */ decline_on?: { - avs_failure?: boolean; - cvc_failure?: boolean; - }; - statement_descriptor_prefix?: string; - }; + avs_failure?: boolean + cvc_failure?: boolean + } + statement_descriptor_prefix?: string + } /** payments_settings_specs */ payments?: { - statement_descriptor?: string; - statement_descriptor_kana?: string; - statement_descriptor_kanji?: string; - }; + statement_descriptor?: string + statement_descriptor_kana?: string + statement_descriptor_kanji?: string + } /** payout_settings_specs */ payouts?: { - debit_negative_balances?: boolean; + debit_negative_balances?: boolean /** transfer_schedule_specs */ schedule?: { - delay_days?: unknown; + delay_days?: unknown /** @enum {string} */ - interval?: "daily" | "manual" | "monthly" | "weekly"; - monthly_anchor?: number; + interval?: 'daily' | 'manual' | 'monthly' | 'weekly' + monthly_anchor?: number /** @enum {string} */ - weekly_anchor?: "friday" | "monday" | "saturday" | "sunday" | "thursday" | "tuesday" | "wednesday"; - }; - statement_descriptor?: string; - }; - }; + weekly_anchor?: 'friday' | 'monday' | 'saturday' | 'sunday' | 'thursday' | 'tuesday' | 'wednesday' + } + statement_descriptor?: string + } + } /** * tos_acceptance_specs * @description Details on the account's acceptance of the [Stripe Services Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance). */ tos_acceptance?: { - date?: number; - ip?: string; - user_agent?: string; - }; + date?: number + ip?: string + user_agent?: string + } /** * @description The type of Stripe account to create. Currently must be `custom`, as only [Custom accounts](https://stripe.com/docs/connect/custom-accounts) may be created via the API. * @enum {string} */ - type?: "custom" | "express" | "standard"; - }; - }; - }; + type?: 'custom' | 'express' | 'standard' + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["account"]; - }; + schema: definitions['account'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves the details of an account.

*/ GetAccountsAccount: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - account: string; - }; - }; + account: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["account"]; - }; + schema: definitions['account'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

Updates a connected Express or Custom account by setting the values of the parameters passed. Any parameters not provided are left unchanged. Most parameters can be changed only for Custom accounts. (These are marked Custom Only below.) Parameters marked Custom and Express are supported by both account types.

* @@ -11834,33 +11790,33 @@ export interface operations { PostAccountsAccount: { parameters: { path: { - account: string; - }; + account: string + } body: { /** Body parameters for the request. */ payload?: { /** @description An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account. */ - account_token?: string; + account_token?: string /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js), or a dictionary containing a user's bank account details. */ - bank_account?: unknown; + bank_account?: unknown /** * business_profile_specs * @description Business information about the account. */ business_profile?: { - mcc?: string; - name?: string; - product_description?: string; - support_email?: string; - support_phone?: string; - support_url?: string; - url?: string; - }; + mcc?: string + name?: string + product_description?: string + support_email?: string + support_phone?: string + support_url?: string + url?: string + } /** * @description The business type. * @enum {string} */ - business_type?: "company" | "government_entity" | "individual" | "non_profit"; + business_type?: 'company' | 'government_entity' | 'individual' | 'non_profit' /** * company_specs * @description Information about the company or business. This field is null unless `business_type` is set to `company`, `government_entity`, or `non_profit`. @@ -11868,78 +11824,78 @@ export interface operations { company?: { /** address_specs */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** japan_address_kana_specs */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** japan_address_kanji_specs */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; - directors_provided?: boolean; - executives_provided?: boolean; - name?: string; - name_kana?: string; - name_kanji?: string; - owners_provided?: boolean; - phone?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } + directors_provided?: boolean + executives_provided?: boolean + name?: string + name_kana?: string + name_kanji?: string + owners_provided?: boolean + phone?: string /** @enum {string} */ structure?: - | "" - | "government_instrumentality" - | "governmental_unit" - | "incorporated_non_profit" - | "limited_liability_partnership" - | "multi_member_llc" - | "private_company" - | "private_corporation" - | "private_partnership" - | "public_company" - | "public_corporation" - | "public_partnership" - | "sole_proprietorship" - | "tax_exempt_government_instrumentality" - | "unincorporated_association" - | "unincorporated_non_profit"; - tax_id?: string; - tax_id_registrar?: string; - vat_id?: string; + | '' + | 'government_instrumentality' + | 'governmental_unit' + | 'incorporated_non_profit' + | 'limited_liability_partnership' + | 'multi_member_llc' + | 'private_company' + | 'private_corporation' + | 'private_partnership' + | 'public_company' + | 'public_corporation' + | 'public_partnership' + | 'sole_proprietorship' + | 'tax_exempt_government_instrumentality' + | 'unincorporated_association' + | 'unincorporated_non_profit' + tax_id?: string + tax_id_registrar?: string + vat_id?: string /** verification_specs */ verification?: { /** verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; + back?: string + front?: string + } + } + } /** @description 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?: string; + default_currency?: string /** @description Email address of the account representative. For Standard accounts, this is used to ask them to claim their Stripe account. For Custom accounts, this only makes the account easier to identify to platforms; Stripe does not email the account representative. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A card or bank account to attach to the account. You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://stripe.com/docs/api#account_create_bank_account) creation.

By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the bank account or card creation API. */ - external_account?: string; + external_account?: string /** * individual_specs * @description Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. @@ -11947,74 +11903,74 @@ export interface operations { individual?: { /** address_specs */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** japan_address_kana_specs */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** japan_address_kanji_specs */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; - dob?: unknown; - email?: string; - first_name?: string; - first_name_kana?: string; - first_name_kanji?: string; - gender?: string; - id_number?: string; - last_name?: string; - last_name_kana?: string; - last_name_kanji?: string; - maiden_name?: string; - metadata?: unknown; - phone?: string; - ssn_last_4?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } + dob?: unknown + email?: string + first_name?: string + first_name_kana?: string + first_name_kanji?: string + gender?: string + id_number?: string + last_name?: string + last_name_kana?: string + last_name_kanji?: string + maiden_name?: string + metadata?: unknown + phone?: string + ssn_last_4?: string /** person_verification_specs */ verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; + back?: string + front?: string + } + } + } /** @description 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. 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?: unknown; + metadata?: unknown /** @description The set of capabilities you want to unlock for this account. Each capability will be inactive until you have provided its specific requirements and Stripe has verified them. An account may have some of its requested capabilities be active and some be inactive. */ requested_capabilities?: ( - | "au_becs_debit_payments" - | "card_issuing" - | "card_payments" - | "jcb_payments" - | "legacy_payments" - | "tax_reporting_us_1099_k" - | "tax_reporting_us_1099_misc" - | "transfers" - )[]; + | 'au_becs_debit_payments' + | 'card_issuing' + | 'card_payments' + | 'jcb_payments' + | 'legacy_payments' + | 'tax_reporting_us_1099_k' + | 'tax_reporting_us_1099_misc' + | 'transfers' + )[] /** * settings_specs * @description Options for customizing how the account functions within Stripe. @@ -12022,64 +11978,64 @@ export interface operations { settings?: { /** branding_settings_specs */ branding?: { - icon?: string; - logo?: string; - primary_color?: string; - secondary_color?: string; - }; + icon?: string + logo?: string + primary_color?: string + secondary_color?: string + } /** card_payments_settings_specs */ card_payments?: { /** decline_charge_on_specs */ decline_on?: { - avs_failure?: boolean; - cvc_failure?: boolean; - }; - statement_descriptor_prefix?: string; - }; + avs_failure?: boolean + cvc_failure?: boolean + } + statement_descriptor_prefix?: string + } /** payments_settings_specs */ payments?: { - statement_descriptor?: string; - statement_descriptor_kana?: string; - statement_descriptor_kanji?: string; - }; + statement_descriptor?: string + statement_descriptor_kana?: string + statement_descriptor_kanji?: string + } /** payout_settings_specs */ payouts?: { - debit_negative_balances?: boolean; + debit_negative_balances?: boolean /** transfer_schedule_specs */ schedule?: { - delay_days?: unknown; + delay_days?: unknown /** @enum {string} */ - interval?: "daily" | "manual" | "monthly" | "weekly"; - monthly_anchor?: number; + interval?: 'daily' | 'manual' | 'monthly' | 'weekly' + monthly_anchor?: number /** @enum {string} */ - weekly_anchor?: "friday" | "monday" | "saturday" | "sunday" | "thursday" | "tuesday" | "wednesday"; - }; - statement_descriptor?: string; - }; - }; + weekly_anchor?: 'friday' | 'monday' | 'saturday' | 'sunday' | 'thursday' | 'tuesday' | 'wednesday' + } + statement_descriptor?: string + } + } /** * tos_acceptance_specs * @description Details on the account's acceptance of the [Stripe Services Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance). */ tos_acceptance?: { - date?: number; - ip?: string; - user_agent?: string; - }; - }; - }; - }; + date?: number + ip?: string + user_agent?: string + } + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["account"]; - }; + schema: definitions['account'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

With Connect, you can delete Custom or Express accounts you manage.

* @@ -12090,76 +12046,76 @@ export interface operations { DeleteAccountsAccount: { parameters: { path: { - account: string; - }; - }; + account: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["deleted_account"]; - }; + schema: definitions['deleted_account'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Create an external account for a given account.

*/ PostAccountsAccountBankAccounts: { parameters: { path: { - account: string; - }; + account: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js), or a dictionary containing a user's bank account details. */ - bank_account?: unknown; + bank_account?: unknown /** @description When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency. */ - default_for_currency?: boolean; + default_for_currency?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - external_account?: string; + external_account?: string /** @description 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. 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?: { [key: string]: unknown }; - }; - }; - }; + metadata?: { [key: string]: unknown } + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["external_account"]; - }; + schema: definitions['external_account'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieve a specified external account for a given account.

*/ GetAccountsAccountBankAccountsId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - account: string; - id: string; - }; - }; + account: string + id: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["external_account"]; - }; + schema: definitions['external_account'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

Updates the metadata, account holder name, and account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

*

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

@@ -12167,256 +12123,256 @@ export interface operations { PostAccountsAccountBankAccountsId: { parameters: { path: { - account: string; - id: string; - }; + account: string + id: string + } body: { /** Body parameters for the request. */ payload?: { /** @description The name of the person or business that owns the bank account. */ - account_holder_name?: string; + account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - account_holder_type?: "" | "company" | "individual"; + account_holder_type?: '' | 'company' | 'individual' /** @description City/District/Suburb/Town/Village. */ - address_city?: string; + address_city?: string /** @description Billing address country, if provided when creating card. */ - address_country?: string; + address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - address_line1?: string; + address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - address_line2?: string; + address_line2?: string /** @description State/County/Province/Region. */ - address_state?: string; + address_state?: string /** @description ZIP or postal code. */ - address_zip?: string; + address_zip?: string /** @description When set to true, this becomes the default external account for its currency. */ - default_for_currency?: boolean; + default_for_currency?: boolean /** @description Two digit number representing the card’s expiration month. */ - exp_month?: string; + exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - exp_year?: string; + exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: unknown; + metadata?: unknown /** @description Cardholder name. */ - name?: string; - }; - }; - }; + name?: string + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["external_account"]; - }; + schema: definitions['external_account'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Delete a specified external account for a given account.

*/ DeleteAccountsAccountBankAccountsId: { parameters: { path: { - account: string; - id: string; - }; - }; + account: string + id: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["deleted_external_account"]; - }; + schema: definitions['deleted_external_account'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ GetAccountsAccountCapabilities: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - account: string; - }; - }; + account: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["capability"][]; + data: definitions['capability'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves information about the specified Account Capability.

*/ GetAccountsAccountCapabilitiesCapability: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - account: string; - capability: string; - }; - }; + account: string + capability: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["capability"]; - }; + schema: definitions['capability'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Updates an existing Account Capability.

*/ PostAccountsAccountCapabilitiesCapability: { parameters: { path: { - account: string; - capability: string; - }; + account: string + capability: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. */ - requested?: boolean; - }; - }; - }; + requested?: boolean + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["capability"]; - }; + schema: definitions['capability'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

List external accounts for an account.

*/ GetAccountsAccountExternalAccounts: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - account: string; - }; - }; + account: string + } + } responses: { /** Successful response. */ 200: { schema: { /** @description The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards. */ - data: definitions["bank_account"][]; + data: definitions['bank_account'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Create an external account for a given account.

*/ PostAccountsAccountExternalAccounts: { parameters: { path: { - account: string; - }; + account: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js), or a dictionary containing a user's bank account details. */ - bank_account?: unknown; + bank_account?: unknown /** @description When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency. */ - default_for_currency?: boolean; + default_for_currency?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - external_account?: string; + external_account?: string /** @description 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. 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?: { [key: string]: unknown }; - }; - }; - }; + metadata?: { [key: string]: unknown } + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["external_account"]; - }; + schema: definitions['external_account'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieve a specified external account for a given account.

*/ GetAccountsAccountExternalAccountsId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - account: string; - id: string; - }; - }; + account: string + id: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["external_account"]; - }; + schema: definitions['external_account'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

Updates the metadata, account holder name, and account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

*

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

@@ -12424,76 +12380,76 @@ export interface operations { PostAccountsAccountExternalAccountsId: { parameters: { path: { - account: string; - id: string; - }; + account: string + id: string + } body: { /** Body parameters for the request. */ payload?: { /** @description The name of the person or business that owns the bank account. */ - account_holder_name?: string; + account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - account_holder_type?: "" | "company" | "individual"; + account_holder_type?: '' | 'company' | 'individual' /** @description City/District/Suburb/Town/Village. */ - address_city?: string; + address_city?: string /** @description Billing address country, if provided when creating card. */ - address_country?: string; + address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - address_line1?: string; + address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - address_line2?: string; + address_line2?: string /** @description State/County/Province/Region. */ - address_state?: string; + address_state?: string /** @description ZIP or postal code. */ - address_zip?: string; + address_zip?: string /** @description When set to true, this becomes the default external account for its currency. */ - default_for_currency?: boolean; + default_for_currency?: boolean /** @description Two digit number representing the card’s expiration month. */ - exp_month?: string; + exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - exp_year?: string; + exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: unknown; + metadata?: unknown /** @description Cardholder name. */ - name?: string; - }; - }; - }; + name?: string + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["external_account"]; - }; + schema: definitions['external_account'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Delete a specified external account for a given account.

*/ DeleteAccountsAccountExternalAccountsId: { parameters: { path: { - account: string; - id: string; - }; - }; + account: string + id: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["deleted_external_account"]; - }; + schema: definitions['deleted_external_account'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

Creates a single-use login link for an Express account to access their Stripe dashboard.

* @@ -12502,29 +12458,29 @@ export interface operations { PostAccountsAccountLoginLinks: { parameters: { path: { - account: string; - }; + account: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Where to redirect the user after they log out of their dashboard. */ - redirect_url?: string; - }; - }; - }; + redirect_url?: string + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["login_link"]; - }; + schema: definitions['login_link'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

Invalidates all sessions for a light account, for a platform to use during platform logout.

* @@ -12533,74 +12489,74 @@ export interface operations { PutAccountsAccountLogout: { parameters: { path: { - account: string; - }; + account: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; + expand?: string[] + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["light_account_logout"]; - }; + schema: definitions['light_account_logout'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ GetAccountsAccountPeople: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Filters on the list of people returned based on the person's relationship to the account's company. */ - relationship?: string; + relationship?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - account: string; - }; - }; + account: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["person"][]; + data: definitions['person'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Creates a new person.

*/ PostAccountsAccountPeople: { parameters: { path: { - account: string; - }; + account: string + } body: { /** Body parameters for the request. */ payload?: { @@ -12609,83 +12565,83 @@ export interface operations { * @description The person's address. */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** @description The person's date of birth. */ - dob?: unknown; + dob?: unknown /** @description The person's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The person's first name. */ - first_name?: string; + first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - first_name_kana?: string; + first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - first_name_kanji?: string; + first_name_kanji?: string /** @description The person's gender (International regulations require either "male" or "female"). */ - gender?: string; + gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/stripe.js#collecting-pii-data). */ - id_number?: string; + id_number?: string /** @description The person's last name. */ - last_name?: string; + last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - last_name_kana?: string; + last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - last_name_kanji?: string; + last_name_kanji?: string /** @description The person's maiden name. */ - maiden_name?: string; + maiden_name?: string /** @description 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. 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?: unknown; + metadata?: unknown /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - person_token?: string; + person_token?: string /** @description The person's phone number. */ - phone?: string; + phone?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - percent_ownership?: unknown; - representative?: boolean; - title?: string; - }; + director?: boolean + executive?: boolean + owner?: boolean + percent_ownership?: unknown + representative?: boolean + title?: string + } /** @description The last 4 digits of the person's social security number. */ - ssn_last_4?: string; + ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -12693,59 +12649,59 @@ export interface operations { verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; - }; - }; + back?: string + front?: string + } + } + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["person"]; - }; + schema: definitions['person'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves an existing person.

*/ GetAccountsAccountPeoplePerson: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - account: string; - person: string; - }; - }; + account: string + person: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["person"]; - }; + schema: definitions['person'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Updates an existing person.

*/ PostAccountsAccountPeoplePerson: { parameters: { path: { - account: string; - person: string; - }; + account: string + person: string + } body: { /** Body parameters for the request. */ payload?: { @@ -12754,83 +12710,83 @@ export interface operations { * @description The person's address. */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** @description The person's date of birth. */ - dob?: unknown; + dob?: unknown /** @description The person's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The person's first name. */ - first_name?: string; + first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - first_name_kana?: string; + first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - first_name_kanji?: string; + first_name_kanji?: string /** @description The person's gender (International regulations require either "male" or "female"). */ - gender?: string; + gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/stripe.js#collecting-pii-data). */ - id_number?: string; + id_number?: string /** @description The person's last name. */ - last_name?: string; + last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - last_name_kana?: string; + last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - last_name_kanji?: string; + last_name_kanji?: string /** @description The person's maiden name. */ - maiden_name?: string; + maiden_name?: string /** @description 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. 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?: unknown; + metadata?: unknown /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - person_token?: string; + person_token?: string /** @description The person's phone number. */ - phone?: string; + phone?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - percent_ownership?: unknown; - representative?: boolean; - title?: string; - }; + director?: boolean + executive?: boolean + owner?: boolean + percent_ownership?: unknown + representative?: boolean + title?: string + } /** @description The last 4 digits of the person's social security number. */ - ssn_last_4?: string; + ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -12838,95 +12794,95 @@ export interface operations { verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; - }; - }; + back?: string + front?: string + } + } + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["person"]; - }; + schema: definitions['person'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ DeleteAccountsAccountPeoplePerson: { parameters: { path: { - account: string; - person: string; - }; - }; + account: string + person: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["deleted_person"]; - }; + schema: definitions['deleted_person'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ GetAccountsAccountPersons: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Filters on the list of people returned based on the person's relationship to the account's company. */ - relationship?: string; + relationship?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - account: string; - }; - }; + account: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["person"][]; + data: definitions['person'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Creates a new person.

*/ PostAccountsAccountPersons: { parameters: { path: { - account: string; - }; + account: string + } body: { /** Body parameters for the request. */ payload?: { @@ -12935,83 +12891,83 @@ export interface operations { * @description The person's address. */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** @description The person's date of birth. */ - dob?: unknown; + dob?: unknown /** @description The person's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The person's first name. */ - first_name?: string; + first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - first_name_kana?: string; + first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - first_name_kanji?: string; + first_name_kanji?: string /** @description The person's gender (International regulations require either "male" or "female"). */ - gender?: string; + gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/stripe.js#collecting-pii-data). */ - id_number?: string; + id_number?: string /** @description The person's last name. */ - last_name?: string; + last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - last_name_kana?: string; + last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - last_name_kanji?: string; + last_name_kanji?: string /** @description The person's maiden name. */ - maiden_name?: string; + maiden_name?: string /** @description 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. 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?: unknown; + metadata?: unknown /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - person_token?: string; + person_token?: string /** @description The person's phone number. */ - phone?: string; + phone?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - percent_ownership?: unknown; - representative?: boolean; - title?: string; - }; + director?: boolean + executive?: boolean + owner?: boolean + percent_ownership?: unknown + representative?: boolean + title?: string + } /** @description The last 4 digits of the person's social security number. */ - ssn_last_4?: string; + ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -13019,59 +12975,59 @@ export interface operations { verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; - }; - }; + back?: string + front?: string + } + } + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["person"]; - }; + schema: definitions['person'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves an existing person.

*/ GetAccountsAccountPersonsPerson: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - account: string; - person: string; - }; - }; + account: string + person: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["person"]; - }; + schema: definitions['person'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Updates an existing person.

*/ PostAccountsAccountPersonsPerson: { parameters: { path: { - account: string; - person: string; - }; + account: string + person: string + } body: { /** Body parameters for the request. */ payload?: { @@ -13080,83 +13036,83 @@ export interface operations { * @description The person's address. */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** @description The person's date of birth. */ - dob?: unknown; + dob?: unknown /** @description The person's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The person's first name. */ - first_name?: string; + first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - first_name_kana?: string; + first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - first_name_kanji?: string; + first_name_kanji?: string /** @description The person's gender (International regulations require either "male" or "female"). */ - gender?: string; + gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/stripe.js#collecting-pii-data). */ - id_number?: string; + id_number?: string /** @description The person's last name. */ - last_name?: string; + last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - last_name_kana?: string; + last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - last_name_kanji?: string; + last_name_kanji?: string /** @description The person's maiden name. */ - maiden_name?: string; + maiden_name?: string /** @description 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. 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?: unknown; + metadata?: unknown /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - person_token?: string; + person_token?: string /** @description The person's phone number. */ - phone?: string; + phone?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - percent_ownership?: unknown; - representative?: boolean; - title?: string; - }; + director?: boolean + executive?: boolean + owner?: boolean + percent_ownership?: unknown + representative?: boolean + title?: string + } /** @description The last 4 digits of the person's social security number. */ - ssn_last_4?: string; + ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -13164,48 +13120,48 @@ export interface operations { verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; - }; - }; + back?: string + front?: string + } + } + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["person"]; - }; + schema: definitions['person'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ DeleteAccountsAccountPersonsPerson: { parameters: { path: { - account: string; - person: string; - }; - }; + account: string + person: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["deleted_person"]; - }; + schema: definitions['deleted_person'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

With Connect, you may flag accounts as suspicious.

* @@ -13214,191 +13170,191 @@ export interface operations { PostAccountsAccountReject: { parameters: { path: { - account: string; - }; + account: string + } body: { /** Body parameters for the request. */ payload: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The reason for rejecting the account. Can be `fraud`, `terms_of_service`, or `other`. */ - reason: string; - }; - }; - }; + reason: string + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["account"]; - }; + schema: definitions['account'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

List apple pay domains.

*/ GetApplePayDomains: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - domain_name?: string; + expand?: unknown[] + domain_name?: 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. */ - ending_before?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["apple_pay_domain"][]; + data: definitions['apple_pay_domain'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Create an apple pay domain.

*/ PostApplePayDomains: { parameters: { body: { /** Body parameters for the request. */ payload: { - domain_name: string; + domain_name: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; + expand?: string[] + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["apple_pay_domain"]; - }; + schema: definitions['apple_pay_domain'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieve an apple pay domain.

*/ GetApplePayDomainsDomain: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - domain: string; - }; - }; + domain: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["apple_pay_domain"]; - }; + schema: definitions['apple_pay_domain'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Delete an apple pay domain.

*/ DeleteApplePayDomainsDomain: { parameters: { path: { - domain: string; - }; - }; + domain: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["deleted_apple_pay_domain"]; - }; + schema: definitions['deleted_apple_pay_domain'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ GetApplicationFees: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** Only return application fees for the charge specified by this charge ID. */ - charge?: string; - created?: number; + charge?: string + created?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["application_fee"][]; + data: definitions['application_fee'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ GetApplicationFeesFeeRefundsId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - fee: string; - id: string; - }; - }; + fee: string + id: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["fee_refund"]; - }; + schema: definitions['fee_refund'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

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

* @@ -13407,118 +13363,118 @@ export interface operations { PostApplicationFeesFeeRefundsId: { parameters: { path: { - fee: string; - id: string; - }; + fee: string + id: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: unknown; - }; - }; - }; + metadata?: unknown + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["fee_refund"]; - }; + schema: definitions['fee_refund'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ GetApplicationFeesId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["application_fee"]; - }; + schema: definitions['application_fee'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } PostApplicationFeesIdRefund: { parameters: { path: { - id: string; - }; + id: string + } body: { /** Body parameters for the request. */ payload?: { - amount?: number; - directive?: string; + amount?: number + directive?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; + expand?: string[] + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["application_fee"]; - }; + schema: definitions['application_fee'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ GetApplicationFeesIdRefunds: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { schema: { /** @description Details about each object. */ - data: definitions["fee_refund"][]; + data: definitions['fee_refund'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

Refunds an application fee that has previously been collected but not yet refunded. * Funds will be refunded to the Stripe account from which the fee was originally collected.

@@ -13533,31 +13489,31 @@ export interface operations { PostApplicationFeesIdRefunds: { parameters: { path: { - id: string; - }; + id: string + } body: { /** Body parameters for the request. */ payload?: { /** @description A positive integer, in _%s_, representing how much of this fee to refund. Can refund only up to the remaining unrefunded amount of the fee. */ - amount?: number; + amount?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: { [key: string]: unknown }; - }; - }; - }; + metadata?: { [key: string]: unknown } + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["fee_refund"]; - }; + schema: definitions['fee_refund'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

Retrieves the current account balance, based on the authentication that was used to make the request. * For a sample request, see Accounting for negative balances.

@@ -13566,20 +13522,20 @@ export interface operations { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; - }; + expand?: unknown[] + } + } responses: { /** Successful response. */ 200: { - schema: definitions["balance"]; - }; + schema: definitions['balance'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

* @@ -13589,47 +13545,47 @@ export interface operations { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - available_on?: number; - created?: number; + expand?: unknown[] + available_on?: number + created?: number /** 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?: string; + currency?: 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. */ - ending_before?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID. */ - payout?: string; + payout?: string /** Only returns the original transaction. */ - source?: string; + source?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only returns transactions of the given type. One of: `charge`, `refund`, `adjustment`, `application_fee`, `application_fee_refund`, `transfer`, `payment`, `payout`, `payout_failure`, `stripe_fee`, or `network_cost`. */ - type?: string; - }; - }; + type?: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["balance_transaction"][]; + data: definitions['balance_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

Retrieves the balance transaction with the given ID.

* @@ -13639,23 +13595,23 @@ export interface operations { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["balance_transaction"]; - }; + schema: definitions['balance_transaction'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

* @@ -13665,47 +13621,47 @@ export interface operations { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - available_on?: number; - created?: number; + expand?: unknown[] + available_on?: number + created?: number /** 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?: string; + currency?: 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. */ - ending_before?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID. */ - payout?: string; + payout?: string /** Only returns the original transaction. */ - source?: string; + source?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only returns transactions of the given type. One of: `charge`, `refund`, `adjustment`, `application_fee`, `application_fee_refund`, `transfer`, `payment`, `payout`, `payout_failure`, `stripe_fee`, or `network_cost`. */ - type?: string; - }; - }; + type?: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["balance_transaction"][]; + data: definitions['balance_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

Retrieves the balance transaction with the given ID.

* @@ -13715,23 +13671,23 @@ export interface operations { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["balance_transaction"]; - }; + schema: definitions['balance_transaction'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Creates a session of the self-serve Portal.

*/ PostBillingPortalSessions: { parameters: { @@ -13739,214 +13695,214 @@ export interface operations { /** Body parameters for the request. */ payload: { /** @description The ID of an existing customer. */ - customer: string; + customer: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The URL to which Stripe should send customers when they click on the link to return to your website. This field is required if a default return URL has not been configured for the portal. */ - return_url?: string; - }; - }; - }; + return_url?: string + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["billing_portal.session"]; - }; + schema: definitions['billing_portal.session'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ GetBitcoinReceivers: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** Filter for active receivers. */ - active?: boolean; + active?: boolean /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Filter for filled receivers. */ - filled?: boolean; + filled?: boolean /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Filter for receivers with uncaptured funds. */ - uncaptured_funds?: boolean; - }; - }; + uncaptured_funds?: boolean + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["bitcoin_receiver"][]; + data: definitions['bitcoin_receiver'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves the Bitcoin receiver with the given ID.

*/ GetBitcoinReceiversId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["bitcoin_receiver"]; - }; + schema: definitions['bitcoin_receiver'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

List bitcoin transacitons for a given receiver.

*/ GetBitcoinReceiversReceiverTransactions: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** Only return transactions for the customer specified by this customer ID. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - receiver: string; - }; - }; + receiver: string + } + } responses: { /** Successful response. */ 200: { schema: { /** @description Details about each object. */ - data: definitions["bitcoin_transaction"][]; + data: definitions['bitcoin_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

List bitcoin transacitons for a given receiver.

*/ GetBitcoinTransactions: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** Only return transactions for the customer specified by this customer ID. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; - receiver?: string; + limit?: number + receiver?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { schema: { /** @description Details about each object. */ - data: definitions["bitcoin_transaction"][]; + data: definitions['bitcoin_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ GetCharges: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - created?: number; + expand?: unknown[] + created?: number /** Only return charges for the customer specified by this customer ID. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return charges that were created by the PaymentIntent specified by this PaymentIntent ID. */ - payment_intent?: string; + payment_intent?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return charges for this transfer group. */ - transfer_group?: string; - }; - }; + transfer_group?: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["charge"][]; + data: definitions['charge'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

To charge a credit card or other payment source, you create a Charge object. If your API key is in test mode, the supplied payment source (e.g., card) won’t actually be charged, although everything else will occur as if in live mode. (Stripe assumes that the charge would have completed successfully).

*/ PostCharges: { parameters: { @@ -13954,33 +13910,33 @@ export interface operations { /** Body parameters for the request. */ payload?: { /** @description 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?: number; - application_fee?: number; + amount?: number + application_fee?: number /** @description A fee in %s that will be applied to the charge and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the `Stripe-Account` header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees). */ - application_fee_amount?: number; + application_fee_amount?: number /** @description Whether to immediately capture the charge. Defaults to `true`. When `false`, the charge issues an authorization (or pre-authorization), and will need to be [captured](https://stripe.com/docs/api#capture_charge) later. Uncaptured charges expire in _seven days_. For more information, see the [authorizing charges and settling later](https://stripe.com/docs/charges/placing-a-hold) documentation. */ - capture?: boolean; + capture?: boolean /** @description A token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js). */ - card?: unknown; + card?: unknown /** @description 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?: string; + currency?: string /** @description The ID of an existing customer that will be charged in this request. */ - customer?: string; + customer?: string /** @description An arbitrary string which you can attach to a `Charge` object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the `description` of the charge(s) that they are describing. */ - description?: string; + description?: string /** destination_specs */ destination?: { - account: string; - amount?: number; - }; + account: string + amount?: number + } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: unknown; + metadata?: unknown /** @description The Stripe account ID for which these funds are intended. Automatically set if you use the `destination` parameter. For details, see [Creating Separate Charges and Transfers](https://stripe.com/docs/connect/charges-transfers#on-behalf-of). */ - on_behalf_of?: string; + on_behalf_of?: string /** @description The email address to which this charge's [receipt](https://stripe.com/docs/dashboard/receipts) will be sent. The receipt will not be sent until the charge is paid, and no receipts will be sent for test mode charges. If this charge is for a [Customer](https://stripe.com/docs/api/customers/object), the email address specified here will override the customer's email address. If `receipt_email` is specified for a charge in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails). */ - receipt_email?: string; + receipt_email?: string /** * shipping * @description Shipping information for the charge. Helps prevent fraud on charges for physical goods. @@ -13988,97 +13944,97 @@ export interface operations { shipping?: { /** address */ address: { - city?: string; - country?: string; - line1: string; - line2?: string; - postal_code?: string; - state?: string; - }; - carrier?: string; - name: string; - phone?: string; - tracking_number?: string; - }; + city?: string + country?: string + line1: string + line2?: string + postal_code?: string + state?: string + } + carrier?: string + name: string + phone?: string + tracking_number?: string + } /** @description A payment source to be charged. This can be the ID of a [card](https://stripe.com/docs/api#cards) (i.e., credit or debit card), a [bank account](https://stripe.com/docs/api#bank_accounts), a [source](https://stripe.com/docs/api#sources), a [token](https://stripe.com/docs/api#tokens), or a [connected account](https://stripe.com/docs/connect/account-debits#charging-a-connected-account). For certain sources---namely, [cards](https://stripe.com/docs/api#cards), [bank accounts](https://stripe.com/docs/api#bank_accounts), and attached [sources](https://stripe.com/docs/api#sources)---you must also pass the ID of the associated customer. */ - source?: string; + source?: string /** @description For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - statement_descriptor_suffix?: string; + statement_descriptor_suffix?: string /** * transfer_data_specs * @description 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?: { - amount?: number; - destination: string; - }; + amount?: number + destination: string + } /** @description A string that identifies this transaction as part of a group. For details, see [Grouping transactions](https://stripe.com/docs/connect/charges-transfers#transfer-options). */ - transfer_group?: string; - }; - }; - }; + transfer_group?: string + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["charge"]; - }; + schema: definitions['charge'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ GetChargesCharge: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - charge: string; - }; - }; + charge: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["charge"]; - }; + schema: definitions['charge'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ PostChargesCharge: { parameters: { path: { - charge: string; - }; + charge: string + } body: { /** Body parameters for the request. */ payload?: { /** @description The ID of an existing customer that will be associated with this request. This field may only be updated if there is no existing associated customer with this charge. */ - customer?: string; + customer?: string /** @description An arbitrary string which you can attach to a charge object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the `description` of the charge(s) that they are describing. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * fraud_details * @description A set of key-value pairs you can attach to a charge giving information about its riskiness. If you believe a charge is fraudulent, include a `user_report` key with a value of `fraudulent`. If you believe a charge is safe, include a `user_report` key with a value of `safe`. Stripe will use the information you send to improve our fraud detection algorithms. */ fraud_details?: { /** @enum {string} */ - user_report: "" | "fraudulent" | "safe"; - }; + user_report: '' | 'fraudulent' | 'safe' + } /** @description 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. 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?: unknown; + metadata?: unknown /** @description This is the email address that the receipt for this charge will be sent to. If this field is updated, then a new email receipt will be sent to the updated address. */ - receipt_email?: string; + receipt_email?: string /** * shipping * @description Shipping information for the charge. Helps prevent fraud on charges for physical goods. @@ -14086,34 +14042,34 @@ export interface operations { shipping?: { /** address */ address: { - city?: string; - country?: string; - line1: string; - line2?: string; - postal_code?: string; - state?: string; - }; - carrier?: string; - name: string; - phone?: string; - tracking_number?: string; - }; + city?: string + country?: string + line1: string + line2?: string + postal_code?: string + state?: string + } + carrier?: string + name: string + phone?: string + tracking_number?: string + } /** @description A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-options) for details. */ - transfer_group?: string; - }; - }; - }; + transfer_group?: string + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["charge"]; - }; + schema: definitions['charge'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

Capture the payment of an existing, uncaptured, charge. This is the second half of the two-step payment flow, where first you created a charge with the capture option set to false.

* @@ -14122,75 +14078,75 @@ export interface operations { PostChargesChargeCapture: { parameters: { path: { - charge: string; - }; + charge: string + } body: { /** Body parameters for the request. */ payload?: { /** @description The amount to capture, which must be less than or equal to the original amount. Any additional amount will be automatically refunded. */ - amount?: number; + amount?: number /** @description An application fee to add on to this charge. */ - application_fee?: number; + application_fee?: number /** @description An application fee amount to add on to this charge, which must be less than or equal to the original amount. */ - application_fee_amount?: number; + application_fee_amount?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The email address to send this charge's receipt to. This will override the previously-specified email address for this charge, if one was set. Receipts will not be sent in test mode. */ - receipt_email?: string; + receipt_email?: string /** @description For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - statement_descriptor_suffix?: string; + statement_descriptor_suffix?: string /** * transfer_data_specs * @description 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?: { - amount?: number; - }; + amount?: number + } /** @description A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-options) for details. */ - transfer_group?: string; - }; - }; - }; + transfer_group?: string + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["charge"]; - }; + schema: definitions['charge'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieve a dispute for a specified charge.

*/ GetChargesChargeDispute: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - charge: string; - }; - }; + charge: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["dispute"]; - }; + schema: definitions['dispute'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } PostChargesChargeDispute: { parameters: { path: { - charge: string; - }; + charge: string + } body: { /** Body parameters for the request. */ payload?: { @@ -14199,78 +14155,78 @@ export interface operations { * @description Evidence to upload, to respond to a dispute. Updating any field in the hash will submit all fields in the hash for review. The combined character count of all fields is limited to 150,000. */ evidence?: { - access_activity_log?: string; - billing_address?: string; - cancellation_policy?: string; - cancellation_policy_disclosure?: string; - cancellation_rebuttal?: string; - customer_communication?: string; - customer_email_address?: string; - customer_name?: string; - customer_purchase_ip?: string; - customer_signature?: string; - duplicate_charge_documentation?: string; - duplicate_charge_explanation?: string; - duplicate_charge_id?: string; - product_description?: string; - receipt?: string; - refund_policy?: string; - refund_policy_disclosure?: string; - refund_refusal_explanation?: string; - service_date?: string; - service_documentation?: string; - shipping_address?: string; - shipping_carrier?: string; - shipping_date?: string; - shipping_documentation?: string; - shipping_tracking_number?: string; - uncategorized_file?: string; - uncategorized_text?: string; - }; + access_activity_log?: string + billing_address?: string + cancellation_policy?: string + cancellation_policy_disclosure?: string + cancellation_rebuttal?: string + customer_communication?: string + customer_email_address?: string + customer_name?: string + customer_purchase_ip?: string + customer_signature?: string + duplicate_charge_documentation?: string + duplicate_charge_explanation?: string + duplicate_charge_id?: string + product_description?: string + receipt?: string + refund_policy?: string + refund_policy_disclosure?: string + refund_refusal_explanation?: string + service_date?: string + service_documentation?: string + shipping_address?: string + shipping_carrier?: string + shipping_date?: string + shipping_documentation?: string + shipping_tracking_number?: string + uncategorized_file?: string + uncategorized_text?: string + } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: unknown; + metadata?: unknown /** @description Whether to immediately submit evidence to the bank. If `false`, evidence is staged on the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank by making another request with this attribute set to `true` (the default). */ - submit?: boolean; - }; - }; - }; + submit?: boolean + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["dispute"]; - }; + schema: definitions['dispute'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } PostChargesChargeDisputeClose: { parameters: { path: { - charge: string; - }; + charge: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; + expand?: string[] + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["dispute"]; - }; + schema: definitions['dispute'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.

* @@ -14287,197 +14243,197 @@ export interface operations { PostChargesChargeRefund: { parameters: { path: { - charge: string; - }; + charge: string + } body: { /** Body parameters for the request. */ payload?: { - amount?: number; + amount?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - metadata?: unknown; - payment_intent?: string; + expand?: string[] + metadata?: unknown + payment_intent?: string /** @enum {string} */ - reason?: "duplicate" | "fraudulent" | "requested_by_customer"; - refund_application_fee?: boolean; - reverse_transfer?: boolean; - }; - }; - }; + reason?: 'duplicate' | 'fraudulent' | 'requested_by_customer' + refund_application_fee?: boolean + reverse_transfer?: boolean + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["charge"]; - }; + schema: definitions['charge'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ GetChargesChargeRefunds: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - charge: string; - }; - }; + charge: string + } + } responses: { /** Successful response. */ 200: { schema: { /** @description Details about each object. */ - data: definitions["refund"][]; + data: definitions['refund'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Create a refund.

*/ PostChargesChargeRefunds: { parameters: { path: { - charge: string; - }; + charge: string + } body: { /** Body parameters for the request. */ payload?: { - amount?: number; + amount?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: { [key: string]: unknown }; - payment_intent?: string; + metadata?: { [key: string]: unknown } + payment_intent?: string /** @enum {string} */ - reason?: "duplicate" | "fraudulent" | "requested_by_customer"; - refund_application_fee?: boolean; - reverse_transfer?: boolean; - }; - }; - }; + reason?: 'duplicate' | 'fraudulent' | 'requested_by_customer' + refund_application_fee?: boolean + reverse_transfer?: boolean + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["refund"]; - }; + schema: definitions['refund'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves the details of an existing refund.

*/ GetChargesChargeRefundsRefund: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - charge: string; - refund: string; - }; - }; + charge: string + refund: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["refund"]; - }; + schema: definitions['refund'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Update a specified refund.

*/ PostChargesChargeRefundsRefund: { parameters: { path: { - charge: string; - refund: string; - }; + charge: string + refund: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - metadata?: unknown; - }; - }; - }; + expand?: string[] + metadata?: unknown + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["refund"]; - }; + schema: definitions['refund'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Returns a list of Checkout Sessions.

*/ GetCheckoutSessions: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return the Checkout Session for the PaymentIntent specified. */ - payment_intent?: string; + payment_intent?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return the Checkout Session for the subscription specified. */ - subscription?: string; - }; - }; + subscription?: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["checkout.session"][]; + data: definitions['checkout.session'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Creates a Session object.

*/ PostCheckoutSessions: { parameters: { @@ -14488,15 +14444,15 @@ export interface operations { * @description Specify whether Checkout should collect the customer's billing address. * @enum {string} */ - billing_address_collection?: "auto" | "required"; + billing_address_collection?: 'auto' | 'required' /** @description The URL the customer will be directed to if they decide to cancel payment and return to your website. */ - cancel_url: string; + cancel_url: string /** * @description A unique string to reference the Checkout Session. This can be a * customer ID, a cart ID, or similar, and can be used to reconcile the * session with your internal systems. */ - client_reference_id?: string; + client_reference_id?: string /** * @description ID of an existing customer, if one exists. The email stored on the * customer will be used to prefill the email field on the Checkout page. @@ -14506,7 +14462,7 @@ export interface operations { * Checkout will create a new customer object based on information * provided during the session. */ - customer?: string; + customer?: string /** * @description 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. @@ -14514,346 +14470,329 @@ export interface operations { * on file. To access information about the customer once a session is * complete, use the `customer` field. */ - customer_email?: string; + customer_email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * @description A list of items the customer is purchasing. Use this parameter for * one-time payments or adding invoice line items to a subscription (used * in conjunction with `subscription_data`). */ line_items?: { - amount?: number; - currency?: string; - description?: string; - images?: string[]; - name?: string; - quantity: number; - tax_rates?: string[]; - }[]; + amount?: number + currency?: string + description?: string + images?: string[] + name?: string + quantity: number + tax_rates?: string[] + }[] /** * @description The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used. * @enum {string} */ - locale?: - | "auto" - | "da" - | "de" - | "en" - | "es" - | "fi" - | "fr" - | "it" - | "ja" - | "ms" - | "nb" - | "nl" - | "pl" - | "pt" - | "pt-BR" - | "sv" - | "zh"; + locale?: 'auto' | 'da' | 'de' | 'en' | 'es' | 'fi' | 'fr' | 'it' | 'ja' | 'ms' | 'nb' | 'nl' | 'pl' | 'pt' | 'pt-BR' | 'sv' | 'zh' /** @description 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. 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?: { [key: string]: unknown }; + metadata?: { [key: string]: unknown } /** * @description The mode of the Checkout Session, one of `payment`, `setup`, or `subscription`. * @enum {string} */ - mode?: "payment" | "setup" | "subscription"; + mode?: 'payment' | 'setup' | 'subscription' /** * payment_intent_data_params * @description A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode. */ payment_intent_data?: { - application_fee_amount?: number; + application_fee_amount?: number /** @enum {string} */ - capture_method?: "automatic" | "manual"; - description?: string; - metadata?: { [key: string]: unknown }; - on_behalf_of?: string; - receipt_email?: string; + capture_method?: 'automatic' | 'manual' + description?: string + metadata?: { [key: string]: unknown } + on_behalf_of?: string + receipt_email?: string /** @enum {string} */ - setup_future_usage?: "off_session" | "on_session"; + setup_future_usage?: 'off_session' | 'on_session' /** shipping */ shipping?: { /** address */ address: { - city?: string; - country?: string; - line1: string; - line2?: string; - postal_code?: string; - state?: string; - }; - carrier?: string; - name: string; - phone?: string; - tracking_number?: string; - }; - statement_descriptor?: string; - statement_descriptor_suffix?: string; + city?: string + country?: string + line1: string + line2?: string + postal_code?: string + state?: string + } + carrier?: string + name: string + phone?: string + tracking_number?: string + } + statement_descriptor?: string + statement_descriptor_suffix?: string /** transfer_data_params */ transfer_data?: { - amount?: number; - destination: string; - }; - }; + amount?: number + destination: string + } + } /** @description A list of the types of payment methods (e.g., card) this Checkout session can accept. */ - payment_method_types: ("card" | "fpx" | "ideal")[]; + payment_method_types: ('card' | 'fpx' | 'ideal')[] /** * setup_intent_data_param * @description A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in `setup` mode. */ setup_intent_data?: { - description?: string; - metadata?: { [key: string]: unknown }; - on_behalf_of?: string; - }; + description?: string + metadata?: { [key: string]: unknown } + on_behalf_of?: string + } /** * shipping_address_collection_params * @description When set, provides configuration for Checkout to collect a shipping address from a customer. */ shipping_address_collection?: { allowed_countries: ( - | "AC" - | "AD" - | "AE" - | "AF" - | "AG" - | "AI" - | "AL" - | "AM" - | "AO" - | "AQ" - | "AR" - | "AT" - | "AU" - | "AW" - | "AX" - | "AZ" - | "BA" - | "BB" - | "BD" - | "BE" - | "BF" - | "BG" - | "BH" - | "BI" - | "BJ" - | "BL" - | "BM" - | "BN" - | "BO" - | "BQ" - | "BR" - | "BS" - | "BT" - | "BV" - | "BW" - | "BY" - | "BZ" - | "CA" - | "CD" - | "CF" - | "CG" - | "CH" - | "CI" - | "CK" - | "CL" - | "CM" - | "CN" - | "CO" - | "CR" - | "CV" - | "CW" - | "CY" - | "CZ" - | "DE" - | "DJ" - | "DK" - | "DM" - | "DO" - | "DZ" - | "EC" - | "EE" - | "EG" - | "EH" - | "ER" - | "ES" - | "ET" - | "FI" - | "FJ" - | "FK" - | "FO" - | "FR" - | "GA" - | "GB" - | "GD" - | "GE" - | "GF" - | "GG" - | "GH" - | "GI" - | "GL" - | "GM" - | "GN" - | "GP" - | "GQ" - | "GR" - | "GS" - | "GT" - | "GU" - | "GW" - | "GY" - | "HK" - | "HN" - | "HR" - | "HT" - | "HU" - | "ID" - | "IE" - | "IL" - | "IM" - | "IN" - | "IO" - | "IQ" - | "IS" - | "IT" - | "JE" - | "JM" - | "JO" - | "JP" - | "KE" - | "KG" - | "KH" - | "KI" - | "KM" - | "KN" - | "KR" - | "KW" - | "KY" - | "KZ" - | "LA" - | "LB" - | "LC" - | "LI" - | "LK" - | "LR" - | "LS" - | "LT" - | "LU" - | "LV" - | "LY" - | "MA" - | "MC" - | "MD" - | "ME" - | "MF" - | "MG" - | "MK" - | "ML" - | "MM" - | "MN" - | "MO" - | "MQ" - | "MR" - | "MS" - | "MT" - | "MU" - | "MV" - | "MW" - | "MX" - | "MY" - | "MZ" - | "NA" - | "NC" - | "NE" - | "NG" - | "NI" - | "NL" - | "NO" - | "NP" - | "NR" - | "NU" - | "NZ" - | "OM" - | "PA" - | "PE" - | "PF" - | "PG" - | "PH" - | "PK" - | "PL" - | "PM" - | "PN" - | "PR" - | "PS" - | "PT" - | "PY" - | "QA" - | "RE" - | "RO" - | "RS" - | "RU" - | "RW" - | "SA" - | "SB" - | "SC" - | "SE" - | "SG" - | "SH" - | "SI" - | "SJ" - | "SK" - | "SL" - | "SM" - | "SN" - | "SO" - | "SR" - | "SS" - | "ST" - | "SV" - | "SX" - | "SZ" - | "TA" - | "TC" - | "TD" - | "TF" - | "TG" - | "TH" - | "TJ" - | "TK" - | "TL" - | "TM" - | "TN" - | "TO" - | "TR" - | "TT" - | "TV" - | "TW" - | "TZ" - | "UA" - | "UG" - | "US" - | "UY" - | "UZ" - | "VA" - | "VC" - | "VE" - | "VG" - | "VN" - | "VU" - | "WF" - | "WS" - | "XK" - | "YE" - | "YT" - | "ZA" - | "ZM" - | "ZW" - | "ZZ" - )[]; - }; + | 'AC' + | 'AD' + | 'AE' + | 'AF' + | 'AG' + | 'AI' + | 'AL' + | 'AM' + | 'AO' + | 'AQ' + | 'AR' + | 'AT' + | 'AU' + | 'AW' + | 'AX' + | 'AZ' + | 'BA' + | 'BB' + | 'BD' + | 'BE' + | 'BF' + | 'BG' + | 'BH' + | 'BI' + | 'BJ' + | 'BL' + | 'BM' + | 'BN' + | 'BO' + | 'BQ' + | 'BR' + | 'BS' + | 'BT' + | 'BV' + | 'BW' + | 'BY' + | 'BZ' + | 'CA' + | 'CD' + | 'CF' + | 'CG' + | 'CH' + | 'CI' + | 'CK' + | 'CL' + | 'CM' + | 'CN' + | 'CO' + | 'CR' + | 'CV' + | 'CW' + | 'CY' + | 'CZ' + | 'DE' + | 'DJ' + | 'DK' + | 'DM' + | 'DO' + | 'DZ' + | 'EC' + | 'EE' + | 'EG' + | 'EH' + | 'ER' + | 'ES' + | 'ET' + | 'FI' + | 'FJ' + | 'FK' + | 'FO' + | 'FR' + | 'GA' + | 'GB' + | 'GD' + | 'GE' + | 'GF' + | 'GG' + | 'GH' + | 'GI' + | 'GL' + | 'GM' + | 'GN' + | 'GP' + | 'GQ' + | 'GR' + | 'GS' + | 'GT' + | 'GU' + | 'GW' + | 'GY' + | 'HK' + | 'HN' + | 'HR' + | 'HT' + | 'HU' + | 'ID' + | 'IE' + | 'IL' + | 'IM' + | 'IN' + | 'IO' + | 'IQ' + | 'IS' + | 'IT' + | 'JE' + | 'JM' + | 'JO' + | 'JP' + | 'KE' + | 'KG' + | 'KH' + | 'KI' + | 'KM' + | 'KN' + | 'KR' + | 'KW' + | 'KY' + | 'KZ' + | 'LA' + | 'LB' + | 'LC' + | 'LI' + | 'LK' + | 'LR' + | 'LS' + | 'LT' + | 'LU' + | 'LV' + | 'LY' + | 'MA' + | 'MC' + | 'MD' + | 'ME' + | 'MF' + | 'MG' + | 'MK' + | 'ML' + | 'MM' + | 'MN' + | 'MO' + | 'MQ' + | 'MR' + | 'MS' + | 'MT' + | 'MU' + | 'MV' + | 'MW' + | 'MX' + | 'MY' + | 'MZ' + | 'NA' + | 'NC' + | 'NE' + | 'NG' + | 'NI' + | 'NL' + | 'NO' + | 'NP' + | 'NR' + | 'NU' + | 'NZ' + | 'OM' + | 'PA' + | 'PE' + | 'PF' + | 'PG' + | 'PH' + | 'PK' + | 'PL' + | 'PM' + | 'PN' + | 'PR' + | 'PS' + | 'PT' + | 'PY' + | 'QA' + | 'RE' + | 'RO' + | 'RS' + | 'RU' + | 'RW' + | 'SA' + | 'SB' + | 'SC' + | 'SE' + | 'SG' + | 'SH' + | 'SI' + | 'SJ' + | 'SK' + | 'SL' + | 'SM' + | 'SN' + | 'SO' + | 'SR' + | 'SS' + | 'ST' + | 'SV' + | 'SX' + | 'SZ' + | 'TA' + | 'TC' + | 'TD' + | 'TF' + | 'TG' + | 'TH' + | 'TJ' + | 'TK' + | 'TL' + | 'TM' + | 'TN' + | 'TO' + | 'TR' + | 'TT' + | 'TV' + | 'TW' + | 'TZ' + | 'UA' + | 'UG' + | 'US' + | 'UY' + | 'UZ' + | 'VA' + | 'VC' + | 'VE' + | 'VG' + | 'VN' + | 'VU' + | 'WF' + | 'WS' + | 'XK' + | 'YE' + | 'YT' + | 'ZA' + | 'ZM' + | 'ZW' + | 'ZZ' + )[] + } /** * @description Describes the type of transaction being performed by Checkout in order to customize * relevant text on the page, such as the submit button. `submit_type` can only be @@ -14861,25 +14800,25 @@ export interface operations { * in `subscription` or `setup` mode. * @enum {string} */ - submit_type?: "auto" | "book" | "donate" | "pay"; + submit_type?: 'auto' | 'book' | 'donate' | 'pay' /** * subscription_data_params * @description A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode. */ subscription_data?: { - application_fee_percent?: number; - coupon?: string; - default_tax_rates?: string[]; + application_fee_percent?: number + coupon?: string + default_tax_rates?: string[] items?: { - plan: string; - quantity?: number; - tax_rates?: string[]; - }[]; - metadata?: { [key: string]: unknown }; - trial_end?: number; - trial_from_plan?: boolean; - trial_period_days?: number; - }; + plan: string + quantity?: number + tax_rates?: string[] + }[] + metadata?: { [key: string]: unknown } + trial_end?: number + trial_from_plan?: boolean + trial_period_days?: number + } /** * @description The URL to which Stripe should send customers when payment or setup * is complete. @@ -14887,139 +14826,139 @@ export interface operations { * payment, read more about it in our guide on [fulfilling your payments * with webhooks](/docs/payments/checkout/fulfillment#webhooks). */ - success_url: string; - }; - }; - }; + success_url: string + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["checkout.session"]; - }; + schema: definitions['checkout.session'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves a Session object.

*/ GetCheckoutSessionsSession: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - session: string; - }; - }; + session: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["checkout.session"]; - }; + schema: definitions['checkout.session'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Lists all Country Spec objects available in the API.

*/ GetCountrySpecs: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["country_spec"][]; + data: definitions['country_spec'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Returns a Country Spec for a given Country code.

*/ GetCountrySpecsCountry: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - country: string; - }; - }; + country: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["country_spec"]; - }; + schema: definitions['country_spec'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Returns a list of your coupons.

*/ GetCoupons: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** 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?: number; + created?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["coupon"][]; + data: definitions['coupon'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

You can create coupons easily via the coupon management page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.

* @@ -15031,153 +14970,153 @@ export interface operations { /** Body parameters for the request. */ payload: { /** @description A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed). */ - amount_off?: number; + amount_off?: number /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed). */ - currency?: string; + currency?: string /** * @description Specifies how long the discount will be in effect. Can be `forever`, `once`, or `repeating`. * @enum {string} */ - duration: "forever" | "once" | "repeating"; + duration: 'forever' | 'once' | 'repeating' /** @description Required only if `duration` is `repeating`, in which case it must be a positive integer that specifies the number of months the discount will be in effect. */ - duration_in_months?: number; + duration_in_months?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Unique string of your choice that will be used to identify this coupon when applying it to a customer. This is often a specific code you'll give to your customer to use when signing up (e.g., `FALL25OFF`). If you don't want to specify a particular code, you can leave the ID blank and we'll generate a random code for you. */ - id?: string; + id?: string /** @description A positive integer specifying the number of times the coupon can be redeemed before it's no longer valid. For example, you might have a 50% off coupon that the first 20 readers of your blog can use. */ - max_redemptions?: number; + max_redemptions?: number /** @description 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. 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?: unknown; + metadata?: unknown /** @description Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set. */ - name?: string; + name?: string /** @description A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if `amount_off` is not passed). */ - percent_off?: number; + percent_off?: number /** @description Unix timestamp specifying the last time at which the coupon can be redeemed. After the redeem_by date, the coupon can no longer be applied to new customers. */ - redeem_by?: number; - }; - }; - }; + redeem_by?: number + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["coupon"]; - }; + schema: definitions['coupon'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves the coupon with the given ID.

*/ GetCouponsCoupon: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - coupon: string; - }; - }; + coupon: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["coupon"]; - }; + schema: definitions['coupon'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ PostCouponsCoupon: { parameters: { path: { - coupon: string; - }; + coupon: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: unknown; + metadata?: unknown /** @description Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set. */ - name?: string; - }; - }; - }; + name?: string + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["coupon"]; - }; + schema: definitions['coupon'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ DeleteCouponsCoupon: { parameters: { path: { - coupon: string; - }; - }; + coupon: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["deleted_coupon"]; - }; + schema: definitions['deleted_coupon'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Returns a list of credit notes.

*/ GetCreditNotes: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** Only return credit notes for the customer specified by this customer ID. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Only return credit notes for the invoice specified by this invoice ID. */ - invoice?: string; + invoice?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["credit_note"][]; + data: definitions['credit_note'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces * its amount_due. For a status=paid invoice, a credit note does not affect its amount_due. Instead, it can result @@ -15200,305 +15139,305 @@ export interface operations { /** Body parameters for the request. */ payload: { /** @description The integer amount in **%s** representing the total amount of the credit note. */ - amount?: number; + amount?: number /** @description The integer amount in **%s** representing the amount to credit the customer's balance, which will be automatically applied to their next invoice. */ - credit_amount?: number; + credit_amount?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description ID of the invoice. */ - invoice: string; + invoice: string /** @description Line items that make up the credit note. */ lines?: { - amount?: number; - description?: string; - invoice_line_item?: string; - quantity?: number; - tax_rates?: string[]; + amount?: number + description?: string + invoice_line_item?: string + quantity?: number + tax_rates?: string[] /** @enum {string} */ - type: "custom_line_item" | "invoice_line_item"; - unit_amount?: number; - unit_amount_decimal?: string; - }[]; + type: 'custom_line_item' | 'invoice_line_item' + unit_amount?: number + unit_amount_decimal?: string + }[] /** @description The credit note's memo appears on the credit note PDF. */ - memo?: string; + memo?: string /** @description 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. 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?: { [key: string]: unknown }; + metadata?: { [key: string]: unknown } /** @description The integer amount in **%s** representing the amount that is credited outside of Stripe. */ - out_of_band_amount?: number; + out_of_band_amount?: number /** * @description Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` * @enum {string} */ - reason?: "duplicate" | "fraudulent" | "order_change" | "product_unsatisfactory"; + reason?: 'duplicate' | 'fraudulent' | 'order_change' | 'product_unsatisfactory' /** @description ID of an existing refund to link this credit note to. */ - refund?: string; + refund?: string /** @description The integer amount in **%s** representing the amount to refund. If set, a refund will be created for the charge associated with the invoice. */ - refund_amount?: number; - }; - }; - }; + refund_amount?: number + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["credit_note"]; - }; + schema: definitions['credit_note'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Get a preview of a credit note without creating it.

*/ GetCreditNotesPreview: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** The integer amount in **%s** representing the total amount of the credit note. */ - amount?: number; + amount?: number /** The integer amount in **%s** representing the amount to credit the customer's balance, which will be automatically applied to their next invoice. */ - credit_amount?: number; + credit_amount?: number /** ID of the invoice. */ - invoice: string; + invoice: string /** Line items that make up the credit note. */ - lines?: unknown[]; + lines?: unknown[] /** The credit note's memo appears on the credit note PDF. */ - memo?: string; + memo?: string /** 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. 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?: string; + metadata?: string /** The integer amount in **%s** representing the amount that is credited outside of Stripe. */ - out_of_band_amount?: number; + out_of_band_amount?: number /** Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` */ - reason?: string; + reason?: string /** ID of an existing refund to link this credit note to. */ - refund?: string; + refund?: string /** The integer amount in **%s** representing the amount to refund. If set, a refund will be created for the charge associated with the invoice. */ - refund_amount?: number; - }; - }; + refund_amount?: number + } + } responses: { /** Successful response. */ 200: { - schema: definitions["credit_note"]; - }; + schema: definitions['credit_note'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ GetCreditNotesPreviewLines: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** The integer amount in **%s** representing the total amount of the credit note. */ - amount?: number; + amount?: number /** The integer amount in **%s** representing the amount to credit the customer's balance, which will be automatically applied to their next invoice. */ - credit_amount?: number; + credit_amount?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** ID of the invoice. */ - invoice: string; + invoice: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Line items that make up the credit note. */ - lines?: unknown[]; + lines?: unknown[] /** The credit note's memo appears on the credit note PDF. */ - memo?: string; + memo?: string /** 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. 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?: string; + metadata?: string /** The integer amount in **%s** representing the amount that is credited outside of Stripe. */ - out_of_band_amount?: number; + out_of_band_amount?: number /** Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` */ - reason?: string; + reason?: string /** ID of an existing refund to link this credit note to. */ - refund?: string; + refund?: string /** The integer amount in **%s** representing the amount to refund. If set, a refund will be created for the charge associated with the invoice. */ - refund_amount?: number; + refund_amount?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { schema: { /** @description Details about each object. */ - data: definitions["credit_note_line_item"][]; + data: definitions['credit_note_line_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ GetCreditNotesCreditNoteLines: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - credit_note: string; - }; - }; + credit_note: string + } + } responses: { /** Successful response. */ 200: { schema: { /** @description Details about each object. */ - data: definitions["credit_note_line_item"][]; + data: definitions['credit_note_line_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves the credit note object with the given identifier.

*/ GetCreditNotesId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["credit_note"]; - }; + schema: definitions['credit_note'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Updates an existing credit note.

*/ PostCreditNotesId: { parameters: { path: { - id: string; - }; + id: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Credit note memo. */ - memo?: string; + memo?: string /** @description 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. 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?: { [key: string]: unknown }; - }; - }; - }; + metadata?: { [key: string]: unknown } + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["credit_note"]; - }; + schema: definitions['credit_note'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ PostCreditNotesIdVoid: { parameters: { path: { - id: string; - }; + id: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; + expand?: string[] + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["credit_note"]; - }; + schema: definitions['credit_note'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ GetCustomers: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - created?: number; + expand?: unknown[] + created?: number /** A filter on the list based on the customer's `email` field. The value must be a string. */ - email?: string; + email?: 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. */ - ending_before?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["customer"][]; + data: definitions['customer'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Creates a new customer object.

*/ PostCustomers: { parameters: { @@ -15506,45 +15445,45 @@ export interface operations { /** Body parameters for the request. */ payload?: { /** @description The customer's address. */ - address?: unknown; + address?: unknown /** @description An integer amount in %s that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice. */ - balance?: number; + balance?: number /** @description The code of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. */ - coupon?: string; + coupon?: string /** @description An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard. */ - description?: string; + description?: string /** @description Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers. */ - invoice_prefix?: string; + invoice_prefix?: string /** * customer_param * @description Default invoice settings for this customer. */ invoice_settings?: { custom_fields?: { - name: string; - value: string; - }[]; - default_payment_method?: string; - footer?: string; - }; + name: string + value: string + }[] + default_payment_method?: string + footer?: string + } /** @description 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. 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?: unknown; + metadata?: unknown /** @description The customer's full name or business name. */ - name?: string; + name?: string /** @description The sequence to be used on the customer's next invoice. Defaults to 1. */ - next_invoice_sequence?: number; + next_invoice_sequence?: number /** @description ID of the PaymentMethod to attach to the customer */ - payment_method?: string; + payment_method?: string /** @description The customer's phone number. */ - phone?: string; + phone?: string /** @description Customer's preferred languages, ordered by preference. */ - preferred_locales?: string[]; + preferred_locales?: string[] /** @description The customer's shipping information. Appears on invoices emailed to this customer. */ - shipping?: unknown; + shipping?: unknown /** * @description The source can be a [Token](https://stripe.com/docs/api#tokens) or a [Source](https://stripe.com/docs/api#sources), as returned by [Elements](https://stripe.com/docs/elements). You must provide a source if the customer does not already have a valid source attached, and you are subscribing the customer to be charged automatically for a plan that is not free. * @@ -15552,77 +15491,77 @@ export interface operations { * * Whenever you attach a card to a customer, Stripe will automatically validate the card. */ - source?: string; + source?: string /** * @description The customer's tax exemption. One of `none`, `exempt`, or `reverse`. * @enum {string} */ - tax_exempt?: "" | "exempt" | "none" | "reverse"; + tax_exempt?: '' | 'exempt' | 'none' | 'reverse' /** @description The customer's tax IDs. */ tax_id_data?: { /** @enum {string} */ type: - | "au_abn" - | "ca_bn" - | "ca_qst" - | "ch_vat" - | "es_cif" - | "eu_vat" - | "hk_br" - | "in_gst" - | "jp_cn" - | "kr_brn" - | "li_uid" - | "mx_rfc" - | "my_itn" - | "my_sst" - | "no_vat" - | "nz_gst" - | "ru_inn" - | "sg_gst" - | "sg_uen" - | "th_vat" - | "tw_vat" - | "us_ein" - | "za_vat"; - value: string; - }[]; - }; - }; - }; - responses: { - /** Successful response. */ - 200: { - schema: definitions["customer"]; - }; - /** Error response. */ - default: { - schema: definitions["error"]; - }; - }; - }; + | 'au_abn' + | 'ca_bn' + | 'ca_qst' + | 'ch_vat' + | 'es_cif' + | 'eu_vat' + | 'hk_br' + | 'in_gst' + | 'jp_cn' + | 'kr_brn' + | 'li_uid' + | 'mx_rfc' + | 'my_itn' + | 'my_sst' + | 'no_vat' + | 'nz_gst' + | 'ru_inn' + | 'sg_gst' + | 'sg_uen' + | 'th_vat' + | 'tw_vat' + | 'us_ein' + | 'za_vat' + value: string + }[] + } + } + } + responses: { + /** Successful response. */ + 200: { + schema: definitions['customer'] + } + /** Error response. */ + default: { + schema: definitions['error'] + } + } + } /**

Retrieves the details of an existing customer. You need only supply the unique customer identifier that was returned upon customer creation.

*/ GetCustomersCustomer: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - customer: string; - }; - }; + customer: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["customer"]; - }; + schema: definitions['customer'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the source parameter, that becomes the customer’s active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the source parameter: for each of the customer’s current subscriptions, if the subscription bills automatically and is in the past_due state, then the latest open invoice for the subscription with automatic collection enabled will be retried. This retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice. Changing the default_source for a customer will not trigger this behavior.

* @@ -15631,27 +15570,27 @@ export interface operations { PostCustomersCustomer: { parameters: { path: { - customer: string; - }; + customer: string + } body: { /** Body parameters for the request. */ payload?: { /** @description The customer's address. */ - address?: unknown; + address?: unknown /** @description An integer amount in %s that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice. */ - balance?: number; + balance?: number /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js), or a dictionary containing a user's bank account details. */ - bank_account?: unknown; + bank_account?: unknown /** @description A token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js). */ - card?: unknown; + card?: unknown /** @description The code of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. */ - coupon?: string; + coupon?: string /** @description ID of Alipay account to make the customer's new default for invoice payments. */ - default_alipay_account?: string; + default_alipay_account?: string /** @description ID of bank account to make the customer's new default for invoice payments. */ - default_bank_account?: string; + default_bank_account?: string /** @description ID of card to make the customer's new default for invoice payments. */ - default_card?: string; + default_card?: string /** * @description If you are using payment methods created via the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method) parameter. * @@ -15659,39 +15598,39 @@ export interface operations { * * If you want to add a new payment source and make it the default, see the [source](https://stripe.com/docs/api/customers/update#update_customer-source) property. */ - default_source?: string; + default_source?: string /** @description An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard. */ - description?: string; + description?: string /** @description Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers. */ - invoice_prefix?: string; + invoice_prefix?: string /** * customer_param * @description Default invoice settings for this customer. */ invoice_settings?: { custom_fields?: { - name: string; - value: string; - }[]; - default_payment_method?: string; - footer?: string; - }; + name: string + value: string + }[] + default_payment_method?: string + footer?: string + } /** @description 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. 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?: unknown; + metadata?: unknown /** @description The customer's full name or business name. */ - name?: string; + name?: string /** @description The sequence to be used on the customer's next invoice. Defaults to 1. */ - next_invoice_sequence?: number; + next_invoice_sequence?: number /** @description The customer's phone number. */ - phone?: string; + phone?: string /** @description Customer's preferred languages, ordered by preference. */ - preferred_locales?: string[]; + preferred_locales?: string[] /** @description The customer's shipping information. Appears on invoices emailed to this customer. */ - shipping?: unknown; + shipping?: unknown /** * @description The source can be a [Token](https://stripe.com/docs/api#tokens) or a [Source](https://stripe.com/docs/api#sources), as returned by [Elements](https://stripe.com/docs/elements). You must provide a source if the customer does not already have a valid source attached, and you are subscribing the customer to be charged automatically for a plan that is not free. * @@ -15699,212 +15638,212 @@ export interface operations { * * Whenever you attach a card to a customer, Stripe will automatically validate the card. */ - source?: string; + source?: string /** * @description The customer's tax exemption. One of `none`, `exempt`, or `reverse`. * @enum {string} */ - tax_exempt?: "" | "exempt" | "none" | "reverse"; + tax_exempt?: '' | 'exempt' | 'none' | 'reverse' /** @description Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. */ - trial_end?: unknown; - }; - }; - }; + trial_end?: unknown + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["customer"]; - }; + schema: definitions['customer'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ DeleteCustomersCustomer: { parameters: { path: { - customer: string; - }; - }; + customer: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["deleted_customer"]; - }; + schema: definitions['deleted_customer'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ GetCustomersCustomerBalanceTransactions: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - customer: string; - }; - }; + customer: string + } + } responses: { /** Successful response. */ 200: { schema: { /** @description Details about each object. */ - data: definitions["customer_balance_transaction"][]; + data: definitions['customer_balance_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ PostCustomersCustomerBalanceTransactions: { parameters: { path: { - customer: string; - }; + customer: string + } body: { /** Body parameters for the request. */ payload: { /** @description The integer amount in **%s** to apply to the customer's balance. Pass a negative amount to credit the customer's balance, and pass in a positive amount to debit the customer's balance. */ - amount: number; + amount: number /** @description 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 the customer's [`currency`](https://stripe.com/docs/api/customers/object#customer_object-currency) is set, this value must match it. If the customer's `currency` is not set, it will be updated to this value. */ - currency: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: unknown; - }; - }; - }; + metadata?: unknown + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["customer_balance_transaction"]; - }; + schema: definitions['customer_balance_transaction'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ GetCustomersCustomerBalanceTransactionsTransaction: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - customer: string; - transaction: string; - }; - }; + customer: string + transaction: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["customer_balance_transaction"]; - }; + schema: definitions['customer_balance_transaction'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ PostCustomersCustomerBalanceTransactionsTransaction: { parameters: { path: { - customer: string; - transaction: string; - }; + customer: string + transaction: string + } body: { /** Body parameters for the request. */ payload?: { /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: unknown; - }; - }; - }; + metadata?: unknown + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["customer_balance_transaction"]; - }; + schema: definitions['customer_balance_transaction'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ GetCustomersCustomerBankAccounts: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - customer: string; - }; - }; + customer: string + } + } responses: { /** Successful response. */ 200: { schema: { /** @description Details about each object. */ - data: definitions["bank_account"][]; + data: definitions['bank_account'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

When you create a new credit card, you must specify a customer or recipient on which to create it.

* @@ -15915,182 +15854,182 @@ export interface operations { PostCustomersCustomerBankAccounts: { parameters: { path: { - customer: string; - }; + customer: string + } body: { /** Body parameters for the request. */ payload?: { /** @description A token returned by [Stripe.js](https://stripe.com/docs/stripe.js) representing the user’s Alipay account details. */ - alipay_account?: string; + alipay_account?: string /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js), or a dictionary containing a user's bank account details. */ - bank_account?: unknown; + bank_account?: unknown /** @description A token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js). */ - card?: unknown; + card?: unknown /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: { [key: string]: unknown }; + metadata?: { [key: string]: unknown } /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - source?: string; - }; - }; - }; + source?: string + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["payment_source"]; - }; + schema: definitions['payment_source'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ GetCustomersCustomerBankAccountsId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - customer: string; - id: string; - }; - }; + customer: string + id: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["bank_account"]; - }; + schema: definitions['bank_account'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Update a specified source for a given customer.

*/ PostCustomersCustomerBankAccountsId: { parameters: { path: { - customer: string; - id: string; - }; + customer: string + id: string + } body: { /** Body parameters for the request. */ payload?: { /** @description The name of the person or business that owns the bank account. */ - account_holder_name?: string; + account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - account_holder_type?: "company" | "individual"; + account_holder_type?: 'company' | 'individual' /** @description City/District/Suburb/Town/Village. */ - address_city?: string; + address_city?: string /** @description Billing address country, if provided when creating card. */ - address_country?: string; + address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - address_line1?: string; + address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - address_line2?: string; + address_line2?: string /** @description State/County/Province/Region. */ - address_state?: string; + address_state?: string /** @description ZIP or postal code. */ - address_zip?: string; + address_zip?: string /** @description Two digit number representing the card’s expiration month. */ - exp_month?: string; + exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - exp_year?: string; + exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: unknown; + metadata?: unknown /** @description Cardholder name. */ - name?: string; + name?: string /** owner */ owner?: { /** source_address */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - email?: string; - name?: string; - phone?: string; - }; - }; - }; - }; - responses: { - /** Successful response. */ - 200: { - schema: definitions["bank_account"]; - }; - /** Error response. */ - default: { - schema: definitions["error"]; - }; - }; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + email?: string + name?: string + phone?: string + } + } + } + } + responses: { + /** Successful response. */ + 200: { + schema: definitions['bank_account'] + } + /** Error response. */ + default: { + schema: definitions['error'] + } + } + } /**

Delete a specified source for a given customer.

*/ DeleteCustomersCustomerBankAccountsId: { parameters: { path: { - customer: string; - id: string; - }; + customer: string + id: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; + expand?: string[] + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["deleted_payment_source"]; - }; + schema: definitions['deleted_payment_source'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Verify a specified bank account for a given customer.

*/ PostCustomersCustomerBankAccountsIdVerify: { parameters: { path: { - customer: string; - id: string; - }; + customer: string + id: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account. */ - amounts?: number[]; + amounts?: number[] /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; + expand?: string[] + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["bank_account"]; - }; + schema: definitions['bank_account'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

You can see a list of the cards belonging to a customer. * Note that the 10 most recent sources are always available on the Customer object. @@ -16100,40 +16039,40 @@ export interface operations { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - customer: string; - }; - }; + customer: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["card"][]; + data: definitions['card'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

When you create a new credit card, you must specify a customer or recipient on which to create it.

* @@ -16144,235 +16083,235 @@ export interface operations { PostCustomersCustomerCards: { parameters: { path: { - customer: string; - }; + customer: string + } body: { /** Body parameters for the request. */ payload?: { /** @description A token returned by [Stripe.js](https://stripe.com/docs/stripe.js) representing the user’s Alipay account details. */ - alipay_account?: string; + alipay_account?: string /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js), or a dictionary containing a user's bank account details. */ - bank_account?: unknown; + bank_account?: unknown /** @description A token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js). */ - card?: unknown; + card?: unknown /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: { [key: string]: unknown }; + metadata?: { [key: string]: unknown } /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - source?: string; - }; - }; - }; + source?: string + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["payment_source"]; - }; + schema: definitions['payment_source'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ GetCustomersCustomerCardsId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - customer: string; - id: string; - }; - }; + customer: string + id: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["card"]; - }; + schema: definitions['card'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Update a specified source for a given customer.

*/ PostCustomersCustomerCardsId: { parameters: { path: { - customer: string; - id: string; - }; + customer: string + id: string + } body: { /** Body parameters for the request. */ payload?: { /** @description The name of the person or business that owns the bank account. */ - account_holder_name?: string; + account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - account_holder_type?: "company" | "individual"; + account_holder_type?: 'company' | 'individual' /** @description City/District/Suburb/Town/Village. */ - address_city?: string; + address_city?: string /** @description Billing address country, if provided when creating card. */ - address_country?: string; + address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - address_line1?: string; + address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - address_line2?: string; + address_line2?: string /** @description State/County/Province/Region. */ - address_state?: string; + address_state?: string /** @description ZIP or postal code. */ - address_zip?: string; + address_zip?: string /** @description Two digit number representing the card’s expiration month. */ - exp_month?: string; + exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - exp_year?: string; + exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: unknown; + metadata?: unknown /** @description Cardholder name. */ - name?: string; + name?: string /** owner */ owner?: { /** source_address */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - email?: string; - name?: string; - phone?: string; - }; - }; - }; - }; - responses: { - /** Successful response. */ - 200: { - schema: definitions["bank_account"]; - }; - /** Error response. */ - default: { - schema: definitions["error"]; - }; - }; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + email?: string + name?: string + phone?: string + } + } + } + } + responses: { + /** Successful response. */ + 200: { + schema: definitions['bank_account'] + } + /** Error response. */ + default: { + schema: definitions['error'] + } + } + } /**

Delete a specified source for a given customer.

*/ DeleteCustomersCustomerCardsId: { parameters: { path: { - customer: string; - id: string; - }; + customer: string + id: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; + expand?: string[] + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["deleted_payment_source"]; - }; + schema: definitions['deleted_payment_source'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } GetCustomersCustomerDiscount: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - customer: string; - }; - }; + customer: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["discount"]; - }; + schema: definitions['discount'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Removes the currently applied discount on a customer.

*/ DeleteCustomersCustomerDiscount: { parameters: { path: { - customer: string; - }; - }; + customer: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["deleted_discount"]; - }; + schema: definitions['deleted_discount'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

List sources for a specified customer.

*/ GetCustomersCustomerSources: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Filter sources according to a particular object type. */ - object?: string; + object?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - customer: string; - }; - }; + customer: string + } + } responses: { /** Successful response. */ 200: { schema: { /** @description Details about each object. */ - data: definitions["alipay_account"][]; + data: definitions['alipay_account'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

When you create a new credit card, you must specify a customer or recipient on which to create it.

* @@ -16383,272 +16322,272 @@ export interface operations { PostCustomersCustomerSources: { parameters: { path: { - customer: string; - }; + customer: string + } body: { /** Body parameters for the request. */ payload?: { /** @description A token returned by [Stripe.js](https://stripe.com/docs/stripe.js) representing the user’s Alipay account details. */ - alipay_account?: string; + alipay_account?: string /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js), or a dictionary containing a user's bank account details. */ - bank_account?: unknown; + bank_account?: unknown /** @description A token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js). */ - card?: unknown; + card?: unknown /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: { [key: string]: unknown }; + metadata?: { [key: string]: unknown } /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - source?: string; - }; - }; - }; + source?: string + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["payment_source"]; - }; + schema: definitions['payment_source'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieve a specified source for a given customer.

*/ GetCustomersCustomerSourcesId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - customer: string; - id: string; - }; - }; + customer: string + id: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["payment_source"]; - }; + schema: definitions['payment_source'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Update a specified source for a given customer.

*/ PostCustomersCustomerSourcesId: { parameters: { path: { - customer: string; - id: string; - }; + customer: string + id: string + } body: { /** Body parameters for the request. */ payload?: { /** @description The name of the person or business that owns the bank account. */ - account_holder_name?: string; + account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - account_holder_type?: "company" | "individual"; + account_holder_type?: 'company' | 'individual' /** @description City/District/Suburb/Town/Village. */ - address_city?: string; + address_city?: string /** @description Billing address country, if provided when creating card. */ - address_country?: string; + address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - address_line1?: string; + address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - address_line2?: string; + address_line2?: string /** @description State/County/Province/Region. */ - address_state?: string; + address_state?: string /** @description ZIP or postal code. */ - address_zip?: string; + address_zip?: string /** @description Two digit number representing the card’s expiration month. */ - exp_month?: string; + exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - exp_year?: string; + exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: unknown; + metadata?: unknown /** @description Cardholder name. */ - name?: string; + name?: string /** owner */ owner?: { /** source_address */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - email?: string; - name?: string; - phone?: string; - }; - }; - }; - }; - responses: { - /** Successful response. */ - 200: { - schema: definitions["bank_account"]; - }; - /** Error response. */ - default: { - schema: definitions["error"]; - }; - }; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + email?: string + name?: string + phone?: string + } + } + } + } + responses: { + /** Successful response. */ + 200: { + schema: definitions['bank_account'] + } + /** Error response. */ + default: { + schema: definitions['error'] + } + } + } /**

Delete a specified source for a given customer.

*/ DeleteCustomersCustomerSourcesId: { parameters: { path: { - customer: string; - id: string; - }; + customer: string + id: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; + expand?: string[] + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["deleted_payment_source"]; - }; + schema: definitions['deleted_payment_source'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Verify a specified bank account for a given customer.

*/ PostCustomersCustomerSourcesIdVerify: { parameters: { path: { - customer: string; - id: string; - }; + customer: string + id: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account. */ - amounts?: number[]; + amounts?: number[] /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; + expand?: string[] + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["bank_account"]; - }; + schema: definitions['bank_account'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ GetCustomersCustomerSubscriptions: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - customer: string; - }; - }; + customer: string + } + } responses: { /** Successful response. */ 200: { schema: { /** @description Details about each object. */ - data: definitions["subscription"][]; + data: definitions['subscription'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Creates a new subscription on an existing customer.

*/ PostCustomersCustomerSubscriptions: { parameters: { path: { - customer: string; - }; + customer: string + } body: { /** Body parameters for the request. */ payload?: { /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). */ - application_fee_percent?: number; + application_fee_percent?: number /** @description For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor. */ - backdate_start_date?: number; + backdate_start_date?: number /** @description 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. */ - billing_cycle_anchor?: number; + billing_cycle_anchor?: number /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. */ - billing_thresholds?: unknown; + billing_thresholds?: unknown /** @description 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. */ - cancel_at?: number; + cancel_at?: number /** @description Boolean indicating whether this subscription should cancel at the end of the current period. */ - cancel_at_period_end?: boolean; + cancel_at_period_end?: boolean /** * @description 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. Defaults to `charge_automatically`. * @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' /** @description The code of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. */ - coupon?: string; + coupon?: string /** @description Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. */ - days_until_due?: number; + days_until_due?: number /** @description ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. If not set, invoices will use the default payment method in the customer's invoice settings. */ - default_payment_method?: string; + default_payment_method?: string /** @description 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 not set, defaults to the customer's default source. */ - default_source?: string; + default_source?: string /** @description 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?: string[]; + default_tax_rates?: string[] /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A list of up to 20 subscription items, each with an attached plan. */ items?: { - billing_thresholds?: unknown; - metadata?: { [key: string]: unknown }; - plan?: string; - quantity?: number; - tax_rates?: string[]; - }[]; + billing_thresholds?: unknown + metadata?: { [key: string]: unknown } + plan?: string + quantity?: number + tax_rates?: string[] + }[] /** @description 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. 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?: unknown; + metadata?: unknown /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. */ - off_session?: boolean; + off_session?: boolean /** * @description Use `allow_incomplete` to create subscriptions with `status=incomplete` if the first invoice cannot be paid. Creating subscriptions with this status allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * @@ -16657,120 +16596,120 @@ export interface operations { * `pending_if_incomplete` is only used with updates and cannot be passed when creating a subscription. * @enum {string} */ - payment_behavior?: "allow_incomplete" | "error_if_incomplete" | "pending_if_incomplete"; + payment_behavior?: 'allow_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete' /** @description 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?: unknown; + pending_invoice_item_interval?: unknown /** @description This field has been renamed to `proration_behavior`. `prorate=true` can be replaced with `proration_behavior=create_prorations` and `prorate=false` can be replaced with `proration_behavior=none`. */ - prorate?: boolean; + prorate?: boolean /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) resulting from the `billing_cycle_anchor`. Valid values are `create_prorations` or `none`. * * Passing `create_prorations` will cause proration invoice items to be created when applicable. Prorations can be disabled by passing `none`. If no value is passed, the default is `create_prorations`. * @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** @description A non-negative decimal (with at most four decimal places) between 0 and 100. This represents the percentage of the subscription invoice subtotal that will be calculated and added as tax to the final amount in each billing period. For example, a plan which charges $10/month with a `tax_percent` of `20.0` will charge $12 per invoice. To unset a previously-set value, pass an empty string. This field has been deprecated and will be removed in a future API version, for further information view the [migration docs](https://stripe.com/docs/billing/migration/taxes) for `tax_rates`. */ - tax_percent?: unknown; + tax_percent?: unknown /** @description Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. */ - trial_end?: unknown; + trial_end?: unknown /** @description 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. */ - trial_from_plan?: boolean; + trial_from_plan?: boolean /** @description Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. */ - trial_period_days?: number; - }; - }; - }; + trial_period_days?: number + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["subscription"]; - }; + schema: definitions['subscription'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves the subscription with the given ID.

*/ GetCustomersCustomerSubscriptionsSubscriptionExposedId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - customer: string; - subscription_exposed_id: string; - }; - }; + customer: string + subscription_exposed_id: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["subscription"]; - }; + schema: definitions['subscription'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ PostCustomersCustomerSubscriptionsSubscriptionExposedId: { parameters: { path: { - customer: string; - subscription_exposed_id: string; - }; + customer: string + subscription_exposed_id: string + } body: { /** Body parameters for the request. */ payload?: { /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). */ - application_fee_percent?: number; + application_fee_percent?: number /** * @description Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). * @enum {string} */ - billing_cycle_anchor?: "now" | "unchanged"; + billing_cycle_anchor?: 'now' | 'unchanged' /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. */ - billing_thresholds?: unknown; + billing_thresholds?: unknown /** @description 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. */ - cancel_at?: unknown; + cancel_at?: unknown /** @description Boolean indicating whether this subscription should cancel at the end of the current period. */ - cancel_at_period_end?: boolean; + cancel_at_period_end?: boolean /** * @description 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. Defaults to `charge_automatically`. * @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' /** @description The code of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. */ - coupon?: string; + coupon?: string /** @description Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. */ - days_until_due?: number; + days_until_due?: number /** @description ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. If not set, invoices will use the default payment method in the customer's invoice settings. */ - default_payment_method?: string; + default_payment_method?: string /** @description 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 not set, defaults to the customer's default source. */ - default_source?: string; + default_source?: string /** @description 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. Pass an empty string to remove previously-defined tax rates. */ - default_tax_rates?: string[]; + default_tax_rates?: string[] /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description List of subscription items, each with an attached plan. */ items?: { - billing_thresholds?: unknown; - clear_usage?: boolean; - deleted?: boolean; - id?: string; - metadata?: unknown; - plan?: string; - quantity?: number; - tax_rates?: string[]; - }[]; + billing_thresholds?: unknown + clear_usage?: boolean + deleted?: boolean + id?: string + metadata?: unknown + plan?: string + quantity?: number + tax_rates?: string[] + }[] /** @description 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. 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?: unknown; + metadata?: unknown /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. */ - off_session?: boolean; + off_session?: boolean /** @description If specified, payment collection for this subscription will be paused. */ - pause_collection?: unknown; + pause_collection?: unknown /** * @description Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * @@ -16779,11 +16718,11 @@ export interface operations { * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not create a subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. * @enum {string} */ - payment_behavior?: "allow_incomplete" | "error_if_incomplete" | "pending_if_incomplete"; + payment_behavior?: 'allow_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete' /** @description 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?: unknown; + pending_invoice_item_interval?: unknown /** @description This field has been renamed to `proration_behavior`. `prorate=true` can be replaced with `proration_behavior=create_prorations` and `prorate=false` can be replaced with `proration_behavior=none`. */ - prorate?: boolean; + prorate?: boolean /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -16792,29 +16731,29 @@ export interface operations { * Prorations can be disabled by passing `none`. * @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations. */ - proration_date?: number; + proration_date?: number /** @description A non-negative decimal (with at most four decimal places) between 0 and 100. This represents the percentage of the subscription invoice subtotal that will be calculated and added as tax to the final amount in each billing period. For example, a plan which charges $10/month with a `tax_percent` of `20.0` will charge $12 per invoice. To unset a previously-set value, pass an empty string. This field has been deprecated and will be removed in a future API version, for further information view the [migration docs](https://stripe.com/docs/billing/migration/taxes) for `tax_rates`. */ - tax_percent?: unknown; + tax_percent?: unknown /** @description Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. */ - trial_end?: unknown; + trial_end?: unknown /** @description 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. */ - trial_from_plan?: boolean; - }; - }; - }; + trial_from_plan?: boolean + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["subscription"]; - }; + schema: definitions['subscription'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

Cancels a customer’s subscription. If you set the at_period_end parameter to true, the subscription will remain active until the end of the period, at which point it will be canceled and not renewed. Otherwise, with the default false value, the subscription is terminated immediately. In either case, the customer will not be charged again for the subscription.

* @@ -16825,273 +16764,273 @@ export interface operations { DeleteCustomersCustomerSubscriptionsSubscriptionExposedId: { parameters: { path: { - customer: string; - subscription_exposed_id: string; - }; + customer: string + subscription_exposed_id: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Can be set to `true` if `at_period_end` is not set to `true`. Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items. */ - invoice_now?: boolean; + invoice_now?: boolean /** @description Can be set to `true` if `at_period_end` is not set to `true`. Will generate a proration invoice item that credits remaining unused time until the subscription period end. */ - prorate?: boolean; - }; - }; - }; + prorate?: boolean + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["subscription"]; - }; + schema: definitions['subscription'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - customer: string; - subscription_exposed_id: string; - }; - }; + customer: string + subscription_exposed_id: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["discount"]; - }; + schema: definitions['discount'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Removes the currently applied discount on a customer.

*/ DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount: { parameters: { path: { - customer: string; - subscription_exposed_id: string; - }; - }; + customer: string + subscription_exposed_id: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["deleted_discount"]; - }; + schema: definitions['deleted_discount'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Returns a list of tax IDs for a customer.

*/ GetCustomersCustomerTaxIds: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - customer: string; - }; - }; + customer: string + } + } responses: { /** Successful response. */ 200: { schema: { /** @description Details about each object. */ - data: definitions["tax_id"][]; + data: definitions['tax_id'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Creates a new TaxID object for a customer.

*/ PostCustomersCustomerTaxIds: { parameters: { path: { - customer: string; - }; + customer: string + } body: { /** Body parameters for the request. */ payload: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * @description Type of the tax ID, one of `eu_vat`, `nz_gst`, `au_abn`, `in_gst`, `no_vat`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `my_sst`, or `sg_gst` * @enum {string} */ type: - | "au_abn" - | "ca_bn" - | "ca_qst" - | "ch_vat" - | "es_cif" - | "eu_vat" - | "hk_br" - | "in_gst" - | "jp_cn" - | "kr_brn" - | "li_uid" - | "mx_rfc" - | "my_itn" - | "my_sst" - | "no_vat" - | "nz_gst" - | "ru_inn" - | "sg_gst" - | "sg_uen" - | "th_vat" - | "tw_vat" - | "us_ein" - | "za_vat"; + | 'au_abn' + | 'ca_bn' + | 'ca_qst' + | 'ch_vat' + | 'es_cif' + | 'eu_vat' + | 'hk_br' + | 'in_gst' + | 'jp_cn' + | 'kr_brn' + | 'li_uid' + | 'mx_rfc' + | 'my_itn' + | 'my_sst' + | 'no_vat' + | 'nz_gst' + | 'ru_inn' + | 'sg_gst' + | 'sg_uen' + | 'th_vat' + | 'tw_vat' + | 'us_ein' + | 'za_vat' /** @description Value of the tax ID. */ - value: string; - }; - }; - }; + value: string + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["tax_id"]; - }; + schema: definitions['tax_id'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves the TaxID object with the given identifier.

*/ GetCustomersCustomerTaxIdsId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - customer: string; - id: string; - }; - }; + customer: string + id: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["tax_id"]; - }; + schema: definitions['tax_id'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Deletes an existing TaxID object.

*/ DeleteCustomersCustomerTaxIdsId: { parameters: { path: { - customer: string; - id: string; - }; - }; + customer: string + id: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["deleted_tax_id"]; - }; + schema: definitions['deleted_tax_id'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Returns a list of your disputes.

*/ GetDisputes: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** Only return disputes associated to the charge specified by this charge ID. */ - charge?: string; - created?: number; + charge?: string + created?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return disputes associated to the PaymentIntent specified by this PaymentIntent ID. */ - payment_intent?: string; + payment_intent?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["dispute"][]; + data: definitions['dispute'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves the dispute with the given ID.

*/ GetDisputesDispute: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - dispute: string; - }; - }; + dispute: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["dispute"]; - }; + schema: definitions['dispute'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

When you get a dispute, contacting your customer is always the best first step. If that doesn’t work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your dashboard, but if you prefer, you can use the API to submit evidence programmatically.

* @@ -17100,8 +17039,8 @@ export interface operations { PostDisputesDispute: { parameters: { path: { - dispute: string; - }; + dispute: string + } body: { /** Body parameters for the request. */ payload?: { @@ -17110,54 +17049,54 @@ export interface operations { * @description Evidence to upload, to respond to a dispute. Updating any field in the hash will submit all fields in the hash for review. The combined character count of all fields is limited to 150,000. */ evidence?: { - access_activity_log?: string; - billing_address?: string; - cancellation_policy?: string; - cancellation_policy_disclosure?: string; - cancellation_rebuttal?: string; - customer_communication?: string; - customer_email_address?: string; - customer_name?: string; - customer_purchase_ip?: string; - customer_signature?: string; - duplicate_charge_documentation?: string; - duplicate_charge_explanation?: string; - duplicate_charge_id?: string; - product_description?: string; - receipt?: string; - refund_policy?: string; - refund_policy_disclosure?: string; - refund_refusal_explanation?: string; - service_date?: string; - service_documentation?: string; - shipping_address?: string; - shipping_carrier?: string; - shipping_date?: string; - shipping_documentation?: string; - shipping_tracking_number?: string; - uncategorized_file?: string; - uncategorized_text?: string; - }; + access_activity_log?: string + billing_address?: string + cancellation_policy?: string + cancellation_policy_disclosure?: string + cancellation_rebuttal?: string + customer_communication?: string + customer_email_address?: string + customer_name?: string + customer_purchase_ip?: string + customer_signature?: string + duplicate_charge_documentation?: string + duplicate_charge_explanation?: string + duplicate_charge_id?: string + product_description?: string + receipt?: string + refund_policy?: string + refund_policy_disclosure?: string + refund_refusal_explanation?: string + service_date?: string + service_documentation?: string + shipping_address?: string + shipping_carrier?: string + shipping_date?: string + shipping_documentation?: string + shipping_tracking_number?: string + uncategorized_file?: string + uncategorized_text?: string + } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: unknown; + metadata?: unknown /** @description Whether to immediately submit evidence to the bank. If `false`, evidence is staged on the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank by making another request with this attribute set to `true` (the default). */ - submit?: boolean; - }; - }; - }; + submit?: boolean + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["dispute"]; - }; + schema: definitions['dispute'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.

* @@ -17166,27 +17105,27 @@ export interface operations { PostDisputesDisputeClose: { parameters: { path: { - dispute: string; - }; + dispute: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; + expand?: string[] + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["dispute"]; - }; + schema: definitions['dispute'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ PostEphemeralKeys: { parameters: { @@ -17194,214 +17133,214 @@ export interface operations { /** Body parameters for the request. */ payload?: { /** @description The ID of the Customer you'd like to modify using the resulting ephemeral key. */ - customer?: string; + customer?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The ID of the Issuing Card you'd like to access using the resulting ephemeral key. */ - issuing_card?: string; - }; - }; - }; + issuing_card?: string + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["ephemeral_key"]; - }; + schema: definitions['ephemeral_key'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ DeleteEphemeralKeysKey: { parameters: { path: { - key: string; - }; + key: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; + expand?: string[] + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["ephemeral_key"]; - }; + schema: definitions['ephemeral_key'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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).

*/ GetEvents: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - created?: number; + expand?: unknown[] + created?: number /** 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?: boolean; + delivery_success?: boolean /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** 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?: string; + type?: string /** 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?: unknown[]; - }; - }; + types?: unknown[] + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["event"][]; + data: definitions['event'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.

*/ GetEventsId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["event"]; - }; + schema: definitions['event'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ GetExchangeRates: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** 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?: string; + ending_before?: string /** 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?: number; + limit?: number /** 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["exchange_rate"][]; + data: definitions['exchange_rate'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ GetExchangeRatesCurrency: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - currency: string; - }; - }; + currency: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["exchange_rate"]; - }; + schema: definitions['exchange_rate'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Returns a list of file links.

*/ GetFileLinks: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - created?: number; + expand?: unknown[] + created?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Filter links by their expiration status. By default, all links are returned. */ - expired?: boolean; + expired?: boolean /** Only return links for the given file. */ - file?: string; + file?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["file_link"][]; + data: definitions['file_link'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Creates a new file link object.

*/ PostFileLinks: { parameters: { @@ -17409,117 +17348,117 @@ export interface operations { /** Body parameters for the request. */ payload: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A future timestamp after which the link will no longer be usable. */ - expires_at?: number; + expires_at?: number /** @description The ID of the file. The file's `purpose` must be one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `finance_report_run`, `pci_document`, `sigma_scheduled_query`, or `tax_document_user_upload`. */ - file: string; + file: string /** @description 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. 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?: unknown; - }; - }; - }; + metadata?: unknown + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["file_link"]; - }; + schema: definitions['file_link'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves the file link with the given ID.

*/ GetFileLinksLink: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - link: string; - }; - }; + link: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["file_link"]; - }; + schema: definitions['file_link'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ PostFileLinksLink: { parameters: { path: { - link: string; - }; + link: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A future timestamp after which the link will no longer be usable, or `now` to expire the link immediately. */ - expires_at?: unknown; + expires_at?: unknown /** @description 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. 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?: unknown; - }; - }; - }; + metadata?: unknown + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["file_link"]; - }; + schema: definitions['file_link'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Returns a list of the files that your account has access to. The files are returned sorted by creation date, with the most recently created files appearing first.

*/ GetFiles: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - created?: number; + expand?: unknown[] + created?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** The file purpose to filter queries by. If none is provided, files will not be filtered by purpose. */ - purpose?: string; + purpose?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["file"][]; + data: definitions['file'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

To upload a file to Stripe, you’ll need to send a request of type multipart/form-data. The request should contain the file you would like to upload, as well as the parameters for creating a file.

* @@ -17531,110 +17470,110 @@ export interface operations { /** Body parameters for the request. */ payload: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A file to upload. The file should follow the specifications of RFC 2388 (which defines file transfers for the `multipart/form-data` protocol). */ - file: string; + file: string /** * file_link_creation_params * @description Optional parameters to automatically create a [file link](https://stripe.com/docs/api#file_links) for the newly created file. */ file_link_data?: { - create: boolean; - expires_at?: number; - metadata?: unknown; - }; + create: boolean + expires_at?: number + metadata?: unknown + } /** * @description The purpose of the uploaded file. Possible values are `additional_verification`, `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `identity_document`, `pci_document`, or `tax_document_user_upload`. * @enum {string} */ purpose: - | "additional_verification" - | "business_icon" - | "business_logo" - | "customer_signature" - | "dispute_evidence" - | "identity_document" - | "pci_document" - | "tax_document_user_upload"; - }; - }; - }; + | 'additional_verification' + | 'business_icon' + | 'business_logo' + | 'customer_signature' + | 'dispute_evidence' + | 'identity_document' + | 'pci_document' + | 'tax_document_user_upload' + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["file"]; - }; + schema: definitions['file'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves the details of an existing file object. Supply the unique file ID from a file, and Stripe will return the corresponding file object. To access file contents, see the File Upload Guide.

*/ GetFilesFile: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - file: string; - }; - }; + file: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["file"]; - }; + schema: definitions['file'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ GetInvoiceitems: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - created?: number; + expand?: unknown[] + created?: number /** The identifier of the customer whose invoice items to return. If none is provided, all invoice items will be returned. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** 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?: string; + invoice?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** 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?: boolean; + pending?: boolean /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["invoiceitem"][]; + data: definitions['invoiceitem'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Creates an item to be added to a draft invoice. If no invoice is specified, the item will be on the next invoice created for the customer specified.

*/ PostInvoiceitems: { parameters: { @@ -17642,188 +17581,188 @@ export interface operations { /** Body parameters for the request. */ payload: { /** @description The integer amount in **%s** of the charge to be applied to the upcoming invoice. Passing in a negative `amount` will reduce the `amount_due` on the invoice. */ - amount?: number; + amount?: number /** @description 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?: string; + currency?: string /** @description The ID of the customer who will be billed when this invoice item is billed. */ - customer: string; + customer: string /** @description An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking. */ - description?: string; + description?: string /** @description Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items. */ - discountable?: boolean; + discountable?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The ID of an existing invoice to add this invoice item to. When left blank, the invoice item will be added to the next upcoming scheduled invoice. This is useful when adding invoice items in response to an invoice.created webhook. You can only add invoice items to draft invoices. */ - invoice?: string; + invoice?: string /** @description 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. 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?: unknown; + metadata?: unknown /** * period * @description The period associated with this invoice item. */ period?: { - end: number; - start: number; - }; + end: number + start: number + } /** @description Non-negative integer. The quantity of units for the invoice item. */ - quantity?: number; + quantity?: number /** @description The ID of a subscription to add this invoice item to. When left blank, the invoice item will be be added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription. */ - subscription?: string; + subscription?: string /** @description 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?: string[]; + tax_rates?: string[] /** @description The integer unit amount in **%s** of the charge to be applied to the upcoming invoice. This `unit_amount` will be multiplied by the quantity to get the full amount. Passing in a negative `unit_amount` will reduce the `amount_due` on the invoice. */ - unit_amount?: number; + unit_amount?: number /** @description Same as `unit_amount`, but accepts a decimal value with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. */ - unit_amount_decimal?: string; - }; - }; - }; + unit_amount_decimal?: string + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["invoiceitem"]; - }; + schema: definitions['invoiceitem'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves the invoice item with the given ID.

*/ GetInvoiceitemsInvoiceitem: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - invoiceitem: string; - }; - }; + invoiceitem: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["invoiceitem"]; - }; + schema: definitions['invoiceitem'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ PostInvoiceitemsInvoiceitem: { parameters: { path: { - invoiceitem: string; - }; + invoiceitem: string + } body: { /** Body parameters for the request. */ payload?: { /** @description The integer amount in **%s** of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount. */ - amount?: number; + amount?: number /** @description An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking. */ - description?: string; + description?: string /** @description Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items. Cannot be set to true for prorations. */ - discountable?: boolean; + discountable?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: unknown; + metadata?: unknown /** * period * @description The period associated with this invoice item. */ period?: { - end: number; - start: number; - }; + end: number + start: number + } /** @description Non-negative integer. The quantity of units for the invoice item. */ - quantity?: number; + quantity?: number /** @description 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. Pass an empty string to remove previously-defined tax rates. */ - tax_rates?: string[]; + tax_rates?: string[] /** @description The integer unit amount in **%s** of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount. */ - unit_amount?: number; + unit_amount?: number /** @description Same as `unit_amount`, but accepts a decimal value with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. */ - unit_amount_decimal?: string; - }; - }; - }; + unit_amount_decimal?: string + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["invoiceitem"]; - }; + schema: definitions['invoiceitem'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ DeleteInvoiceitemsInvoiceitem: { parameters: { path: { - invoiceitem: string; - }; - }; + invoiceitem: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["deleted_invoiceitem"]; - }; + schema: definitions['deleted_invoiceitem'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ GetInvoices: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** The collection method of the invoice to retrieve. Either `charge_automatically` or `send_invoice`. */ - collection_method?: string; - created?: number; + collection_method?: string + created?: number /** Only return invoices for the customer specified by this customer ID. */ - customer?: string; - due_date?: number; + customer?: string + due_date?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** 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?: string; + status?: string /** Only return invoices for the subscription specified by this subscription ID. */ - subscription?: string; - }; - }; + subscription?: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["invoice"][]; + data: definitions['invoice'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

This endpoint creates a draft invoice for a given customer. The draft invoice created pulls in all pending invoice items on that customer, including prorations.

*/ PostInvoices: { parameters: { @@ -17831,59 +17770,59 @@ export interface operations { /** Body parameters for the request. */ payload: { /** @description A fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#invoices). */ - application_fee_amount?: number; + application_fee_amount?: number /** @description Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice. When `false`, the invoice's state will not automatically advance without an explicit action. */ - auto_advance?: boolean; + auto_advance?: boolean /** * @description 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. Defaults to `charge_automatically`. * @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' /** @description A list of up to 4 custom fields to be displayed on the invoice. */ custom_fields?: { - name: string; - value: string; - }[]; + name: string + value: string + }[] /** @description The ID of the customer who will be billed. */ - customer: string; + customer: string /** @description The number of days from when the invoice is created until it is due. Valid only for invoices where `collection_method=send_invoice`. */ - days_until_due?: number; + days_until_due?: number /** @description 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?: string; + default_payment_method?: string /** @description 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?: string; + default_source?: string /** @description The tax rates that will apply to any line item that does not have `tax_rates` set. */ - default_tax_rates?: string[]; + default_tax_rates?: string[] /** @description An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. */ - description?: string; + description?: string /** @description The date on which payment for this invoice is due. Valid only for invoices where `collection_method=send_invoice`. */ - due_date?: number; + due_date?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Footer to be displayed on the invoice. */ - footer?: string; + footer?: string /** @description 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. 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?: unknown; + metadata?: unknown /** @description Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description The ID of the subscription to invoice, if any. If not set, the created invoice will include all pending invoice items for the customer. If set, the created invoice will only include pending invoice items for that subscription and pending invoice items not associated with any subscription. The subscription's billing cycle and regular subscription events won't be affected. */ - subscription?: string; + subscription?: string /** @description The percent tax rate applied to the invoice, represented as a decimal number. This field has been deprecated and will be removed in a future API version, for further information view the [migration docs](https://stripe.com/docs/billing/migration/taxes) for `tax_rates`. */ - tax_percent?: number; - }; - }; - }; + tax_percent?: number + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["invoice"]; - }; + schema: definitions['invoice'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discount that is applicable to the customer.

* @@ -17895,31 +17834,31 @@ export interface operations { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** The code of the coupon to apply. If `subscription` or `subscription_items` is provided, the invoice returned will preview updating or creating a subscription with that coupon. Otherwise, it will preview applying that coupon to the customer for the next upcoming invoice from among the customer's subscriptions. The invoice can be previewed without a coupon by passing this value as an empty string. */ - coupon?: string; + coupon?: string /** The identifier of the customer whose upcoming invoice you'd like to retrieve. */ - customer?: string; + customer?: string /** List of invoice items to add or update in the upcoming invoice preview. */ - invoice_items?: unknown[]; + invoice_items?: unknown[] /** The identifier of the unstarted schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields. */ - schedule?: string; + schedule?: string /** The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions. */ - subscription?: string; + subscription?: string /** 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`. */ - subscription_billing_cycle_anchor?: string; + subscription_billing_cycle_anchor?: string /** Timestamp indicating when the subscription should be scheduled to cancel. Will prorate if within the current period and prorations have been enabled using `proration_behavior`.` */ - subscription_cancel_at?: string; + subscription_cancel_at?: string /** Boolean indicating whether this subscription should cancel at the end of the current period. */ - subscription_cancel_at_period_end?: boolean; + subscription_cancel_at_period_end?: boolean /** This simulates the subscription being canceled or expired immediately. */ - subscription_cancel_now?: boolean; + subscription_cancel_now?: boolean /** 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. */ - subscription_default_tax_rates?: string; + subscription_default_tax_rates?: string /** List of subscription items, each with an attached plan. */ - subscription_items?: unknown[]; + subscription_items?: unknown[] /** This field has been renamed to `subscription_proration_behavior`. `subscription_prorate=true` can be replaced with `subscription_proration_behavior=create_prorations` and `subscription_prorate=false` can be replaced with `subscription_proration_behavior=none`. */ - subscription_prorate?: boolean; + subscription_prorate?: boolean /** * Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -17927,66 +17866,66 @@ export interface operations { * * Prorations can be disabled by passing `none`. */ - subscription_proration_behavior?: string; + subscription_proration_behavior?: string /** 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 cannot be before the subscription was on its current plan. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration` cannot be set to false. */ - subscription_proration_date?: number; + subscription_proration_date?: number /** Date a subscription is intended to start (can be future or past) */ - subscription_start_date?: number; + subscription_start_date?: number /** If provided, the invoice returned will preview updating or creating a subscription with that tax percent. If set, one of `subscription_items` or `subscription` is required. This field has been deprecated and will be removed in a future API version, for further information view the [migration docs](https://stripe.com/docs/billing/migration/taxes) for `tax_rates`. */ - subscription_tax_percent?: number; + subscription_tax_percent?: number /** 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. */ - subscription_trial_end?: string; + subscription_trial_end?: string /** Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `subscription_trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `subscription_trial_end` is not allowed. */ - subscription_trial_from_plan?: boolean; - }; - }; + subscription_trial_from_plan?: boolean + } + } responses: { /** Successful response. */ 200: { - schema: definitions["invoice"]; - }; + schema: definitions['invoice'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ GetInvoicesUpcomingLines: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** The code of the coupon to apply. If `subscription` or `subscription_items` is provided, the invoice returned will preview updating or creating a subscription with that coupon. Otherwise, it will preview applying that coupon to the customer for the next upcoming invoice from among the customer's subscriptions. The invoice can be previewed without a coupon by passing this value as an empty string. */ - coupon?: string; + coupon?: string /** The identifier of the customer whose upcoming invoice you'd like to retrieve. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** List of invoice items to add or update in the upcoming invoice preview. */ - invoice_items?: unknown[]; + invoice_items?: unknown[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** The identifier of the unstarted schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields. */ - schedule?: string; + schedule?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions. */ - subscription?: string; + subscription?: string /** 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`. */ - subscription_billing_cycle_anchor?: string; + subscription_billing_cycle_anchor?: string /** Timestamp indicating when the subscription should be scheduled to cancel. Will prorate if within the current period and prorations have been enabled using `proration_behavior`.` */ - subscription_cancel_at?: string; + subscription_cancel_at?: string /** Boolean indicating whether this subscription should cancel at the end of the current period. */ - subscription_cancel_at_period_end?: boolean; + subscription_cancel_at_period_end?: boolean /** This simulates the subscription being canceled or expired immediately. */ - subscription_cancel_now?: boolean; + subscription_cancel_now?: boolean /** 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. */ - subscription_default_tax_rates?: string; + subscription_default_tax_rates?: string /** List of subscription items, each with an attached plan. */ - subscription_items?: unknown[]; + subscription_items?: unknown[] /** If previewing an update to a subscription, this decides whether the preview will show the result of applying prorations or not. If set, one of `subscription_items` or `subscription`, and one of `subscription_items` or `subscription_trial_end` are required. */ - subscription_prorate?: boolean; + subscription_prorate?: boolean /** * Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -17994,64 +17933,64 @@ export interface operations { * * Prorations can be disabled by passing `none`. */ - subscription_proration_behavior?: string; + subscription_proration_behavior?: string /** 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 cannot be before the subscription was on its current plan. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration` cannot be set to false. */ - subscription_proration_date?: number; + subscription_proration_date?: number /** Date a subscription is intended to start (can be future or past) */ - subscription_start_date?: number; + subscription_start_date?: number /** If provided, the invoice returned will preview updating or creating a subscription with that tax percent. If set, one of `subscription_items` or `subscription` is required. This field has been deprecated and will be removed in a future API version, for further information view the [migration docs](https://stripe.com/docs/billing/migration/taxes) for `tax_rates`. */ - subscription_tax_percent?: number; + subscription_tax_percent?: number /** 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. */ - subscription_trial_end?: string; + subscription_trial_end?: string /** Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `subscription_trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `subscription_trial_end` is not allowed. */ - subscription_trial_from_plan?: boolean; - }; - }; + subscription_trial_from_plan?: boolean + } + } responses: { /** Successful response. */ 200: { schema: { /** @description Details about each object. */ - data: definitions["line_item"][]; + data: definitions['line_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves the invoice with the given ID.

*/ GetInvoicesInvoice: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - invoice: string; - }; - }; + invoice: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["invoice"]; - }; + schema: definitions['invoice'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

Draft invoices are fully editable. Once an invoice is finalized, * monetary values, as well as collection_method, become uneditable.

@@ -18063,210 +18002,210 @@ export interface operations { PostInvoicesInvoice: { parameters: { path: { - invoice: string; - }; + invoice: string + } body: { /** Body parameters for the request. */ payload?: { /** @description A fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#invoices). */ - application_fee_amount?: number; + application_fee_amount?: number /** @description Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice. */ - auto_advance?: boolean; + auto_advance?: boolean /** * @description Either `charge_automatically` or `send_invoice`. This field can be updated only on `draft` invoices. * @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' /** @description A list of up to 4 custom fields to be displayed on the invoice. If a value for `custom_fields` is specified, the list specified will replace the existing custom field list on this invoice. Pass an empty string to remove previously-defined fields. */ custom_fields?: { - name: string; - value: string; - }[]; + name: string + value: string + }[] /** @description The number of days from which the invoice is created until it is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices. */ - days_until_due?: number; + days_until_due?: number /** @description 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?: string; + default_payment_method?: string /** @description 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?: string; + default_source?: string /** @description The tax rates that will apply to any line item that does not have `tax_rates` set. Pass an empty string to remove previously-defined tax rates. */ - default_tax_rates?: string[]; + default_tax_rates?: string[] /** @description An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. */ - description?: string; + description?: string /** @description The date on which payment for this invoice is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices. */ - due_date?: number; + due_date?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Footer to be displayed on the invoice. */ - footer?: string; + footer?: string /** @description 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. 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?: unknown; + metadata?: unknown /** @description Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description The percent tax rate applied to the invoice, represented as a non-negative decimal number (with at most four decimal places) between 0 and 100. To unset a previously-set value, pass an empty string. This field can be updated only on `draft` invoices. This field has been deprecated and will be removed in a future API version, for further information view the [migration docs](https://stripe.com/docs/billing/migration/taxes) for `tax_rates`. */ - tax_percent?: unknown; - }; - }; - }; + tax_percent?: unknown + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["invoice"]; - }; + schema: definitions['invoice'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ DeleteInvoicesInvoice: { parameters: { path: { - invoice: string; - }; - }; + invoice: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["deleted_invoice"]; - }; + schema: definitions['deleted_invoice'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ PostInvoicesInvoiceFinalize: { parameters: { path: { - invoice: string; - }; + invoice: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice. When `false`, the invoice's state will not automatically advance without an explicit action. */ - auto_advance?: boolean; + auto_advance?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; + expand?: string[] + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["invoice"]; - }; + schema: definitions['invoice'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ GetInvoicesInvoiceLines: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - invoice: string; - }; - }; + invoice: string + } + } responses: { /** Successful response. */ 200: { schema: { /** @description Details about each object. */ - data: definitions["line_item"][]; + data: definitions['line_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ PostInvoicesInvoiceMarkUncollectible: { parameters: { path: { - invoice: string; - }; + invoice: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; + expand?: string[] + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["invoice"]; - }; + schema: definitions['invoice'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ PostInvoicesInvoicePay: { parameters: { path: { - invoice: string; - }; + invoice: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * @description In cases where the source used to pay the invoice has insufficient funds, passing `forgive=true` controls whether a charge should be attempted for the full amount available on the source, up to the amount to fully pay the invoice. This effectively forgives the difference between the amount available on the source and the amount due. * * Passing `forgive=false` will fail the charge if the source hasn't been pre-funded with the right amount. An example for this case is with ACH Credit Transfers and wires: if the amount wired is less than the amount due by a small amount, you might want to forgive the difference. */ - forgive?: boolean; + forgive?: boolean /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. */ - off_session?: boolean; + off_session?: boolean /** @description Boolean representing whether an invoice is paid outside of Stripe. This will result in no charge being made. */ - paid_out_of_band?: boolean; + paid_out_of_band?: boolean /** @description A PaymentMethod to be charged. The PaymentMethod must be the ID of a PaymentMethod belonging to the customer associated with the invoice being paid. */ - payment_method?: string; + payment_method?: string /** @description A payment source to be charged. The source must be the ID of a source belonging to the customer associated with the invoice being paid. */ - source?: string; - }; - }; - }; + source?: string + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["invoice"]; - }; + schema: definitions['invoice'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

Stripe will automatically send invoices to customers according to your subscriptions settings. However, if you’d like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.

* @@ -18275,90 +18214,90 @@ export interface operations { PostInvoicesInvoiceSend: { parameters: { path: { - invoice: string; - }; + invoice: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; + expand?: string[] + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["invoice"]; - }; + schema: definitions['invoice'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.

*/ PostInvoicesInvoiceVoid: { parameters: { path: { - invoice: string; - }; + invoice: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; + expand?: string[] + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["invoice"]; - }; + schema: definitions['invoice'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Returns a list of issuer fraud records.

*/ GetIssuerFraudRecords: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** Only return issuer fraud records for the charge specified by this charge ID. */ - charge?: string; + charge?: 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. */ - ending_before?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["issuer_fraud_record"][]; + data: definitions['issuer_fraud_record'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

Retrieves the details of an issuer fraud record that has previously been created.

* @@ -18368,218 +18307,218 @@ export interface operations { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - issuer_fraud_record: string; - }; - }; + issuer_fraud_record: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["issuer_fraud_record"]; - }; + schema: definitions['issuer_fraud_record'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ GetIssuingAuthorizations: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** Only return issuing transactions that belong to the given card. */ - card?: string; + card?: string /** Only return authorizations belonging to the given cardholder. */ - cardholder?: string; + cardholder?: string /** Only return authorizations that were created during the given date interval. */ - created?: number; + created?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return authorizations with the given status. One of `pending`, `closed`, or `reversed`. */ - status?: string; - }; - }; + status?: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["issuing.authorization"][]; + data: definitions['issuing.authorization'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves an Issuing Authorization object.

*/ GetIssuingAuthorizationsAuthorization: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - authorization: string; - }; - }; + authorization: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["issuing.authorization"]; - }; + schema: definitions['issuing.authorization'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ PostIssuingAuthorizationsAuthorization: { parameters: { path: { - authorization: string; - }; + authorization: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: unknown; - }; - }; - }; + metadata?: unknown + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["issuing.authorization"]; - }; + schema: definitions['issuing.authorization'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Approves a pending Issuing Authorization object. This request should be made within the timeout window of the real-time authorization flow.

*/ PostIssuingAuthorizationsAuthorizationApprove: { parameters: { path: { - authorization: string; - }; + authorization: string + } body: { /** Body parameters for the request. */ payload?: { /** @description If the authorization's `pending_request.is_amount_controllable` property is `true`, you may provide this value to control how much to hold for the authorization. Must be positive (use [`decline`](https://stripe.com/docs/api/issuing/authorizations/decline) to decline an authorization request). */ - amount?: number; + amount?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: unknown; - }; - }; - }; + metadata?: unknown + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["issuing.authorization"]; - }; + schema: definitions['issuing.authorization'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Declines a pending Issuing Authorization object. This request should be made within the timeout window of the real time authorization flow.

*/ PostIssuingAuthorizationsAuthorizationDecline: { parameters: { path: { - authorization: string; - }; + authorization: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: unknown; - }; - }; - }; + metadata?: unknown + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["issuing.authorization"]; - }; + schema: definitions['issuing.authorization'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ GetIssuingCardholders: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** Only return cardholders that were created during the given date interval. */ - created?: number; + created?: number /** Only return cardholders that have the given email address. */ - email?: string; + email?: 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. */ - ending_before?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return cardholders that have the given phone number. */ - phone_number?: string; + phone_number?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return cardholders that have the given status. One of `active`, `inactive`, or `blocked`. */ - status?: string; + status?: string /** Only return cardholders that have the given type. One of `individual` or `company`. */ - type?: string; - }; - }; + type?: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["issuing.cardholder"][]; + data: definitions['issuing.cardholder'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ PostIssuingCardholders: { parameters: { @@ -18593,25 +18532,25 @@ export interface operations { billing: { /** required_address */ address: { - city: string; - country: string; - line1: string; - line2?: string; - postal_code: string; - state?: string; - }; - }; + city: string + country: string + line1: string + line2?: string + postal_code: string + state?: string + } + } /** * company_param * @description Additional information about a `company` cardholder. */ company?: { - tax_id?: string; - }; + tax_id?: string + } /** @description The cardholder's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * individual_param * @description Additional information about an `individual` cardholder. @@ -18619,961 +18558,961 @@ export interface operations { individual?: { /** date_of_birth_specs */ dob?: { - day: number; - month: number; - year: number; - }; - first_name: string; - last_name: string; + day: number + month: number + year: number + } + first_name: string + last_name: string /** person_verification_param */ verification?: { /** person_verification_document_param */ document?: { - back?: string; - front?: string; - }; - }; - }; + back?: string + front?: string + } + } + } /** @description 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. 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?: { [key: string]: unknown }; + metadata?: { [key: string]: unknown } /** @description The cardholder's name. This will be printed on cards issued to them. */ - name: string; + name: string /** @description The cardholder's phone number. This will be transformed to [E.164](https://en.wikipedia.org/wiki/E.164) if it is not provided in that format already. */ - phone_number?: string; + phone_number?: string /** * authorization_controls_param_v2 * @description Spending rules that give you control over how your cardholders can make charges. Refer to our [authorizations](https://stripe.com/docs/issuing/purchases/authorizations) documentation for more details. */ spending_controls?: { allowed_categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] blocked_categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] spending_limits?: { - amount: number; + amount: number categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] /** @enum {string} */ - interval: "all_time" | "daily" | "monthly" | "per_authorization" | "weekly" | "yearly"; - }[]; - spending_limits_currency?: string; - }; + interval: 'all_time' | 'daily' | 'monthly' | 'per_authorization' | 'weekly' | 'yearly' + }[] + spending_limits_currency?: string + } /** * @description Specifies whether to permit authorizations on this cardholder's cards. Defaults to `active`. * @enum {string} */ - status?: "active" | "inactive"; + status?: 'active' | 'inactive' /** * @description One of `individual` or `company`. * @enum {string} */ - type: "company" | "individual"; - }; - }; - }; + type: 'company' | 'individual' + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["issuing.cardholder"]; - }; + schema: definitions['issuing.cardholder'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves an Issuing Cardholder object.

*/ GetIssuingCardholdersCardholder: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - cardholder: string; - }; - }; + cardholder: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["issuing.cardholder"]; - }; + schema: definitions['issuing.cardholder'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ PostIssuingCardholdersCardholder: { parameters: { path: { - cardholder: string; - }; + cardholder: string + } body: { /** Body parameters for the request. */ payload?: { @@ -19584,25 +19523,25 @@ export interface operations { billing?: { /** required_address */ address: { - city: string; - country: string; - line1: string; - line2?: string; - postal_code: string; - state?: string; - }; - }; + city: string + country: string + line1: string + line2?: string + postal_code: string + state?: string + } + } /** * company_param * @description Additional information about a `company` cardholder. */ company?: { - tax_id?: string; - }; + tax_id?: string + } /** @description The cardholder's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * individual_param * @description Additional information about an `individual` cardholder. @@ -19610,976 +19549,976 @@ export interface operations { individual?: { /** date_of_birth_specs */ dob?: { - day: number; - month: number; - year: number; - }; - first_name: string; - last_name: string; + day: number + month: number + year: number + } + first_name: string + last_name: string /** person_verification_param */ verification?: { /** person_verification_document_param */ document?: { - back?: string; - front?: string; - }; - }; - }; + back?: string + front?: string + } + } + } /** @description 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. 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?: { [key: string]: unknown }; + metadata?: { [key: string]: unknown } /** @description The cardholder's phone number. */ - phone_number?: string; + phone_number?: string /** * authorization_controls_param_v2 * @description Spending rules that give you some control over how your cards can be used. Refer to our [authorizations](https://stripe.com/docs/issuing/purchases/authorizations) documentation for more details. */ spending_controls?: { allowed_categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] blocked_categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] spending_limits?: { - amount: number; + amount: number categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] /** @enum {string} */ - interval: "all_time" | "daily" | "monthly" | "per_authorization" | "weekly" | "yearly"; - }[]; - spending_limits_currency?: string; - }; + interval: 'all_time' | 'daily' | 'monthly' | 'per_authorization' | 'weekly' | 'yearly' + }[] + spending_limits_currency?: string + } /** * @description Specifies whether to permit authorizations on this cardholder's cards. * @enum {string} */ - status?: "active" | "inactive"; - }; - }; - }; + status?: 'active' | 'inactive' + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["issuing.cardholder"]; - }; + schema: definitions['issuing.cardholder'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ GetIssuingCards: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** Only return cards belonging to the Cardholder with the provided ID. */ - cardholder?: string; + cardholder?: string /** Only return cards that were issued during the given date interval. */ - created?: number; + created?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Only return cards that have the given expiration month. */ - exp_month?: number; + exp_month?: number /** Only return cards that have the given expiration year. */ - exp_year?: number; + exp_year?: number /** Only return cards that have the given last four digits. */ - last4?: string; + last4?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return cards that have the given status. One of `active`, `inactive`, or `canceled`. */ - status?: string; + status?: string /** Only return cards that have the given type. One of `virtual` or `physical`. */ - type?: string; - }; - }; + type?: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["issuing.card"][]; + data: definitions['issuing.card'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Creates an Issuing Card object.

*/ PostIssuingCards: { parameters: { @@ -20587,20 +20526,20 @@ export interface operations { /** Body parameters for the request. */ payload: { /** @description The [Cardholder](https://stripe.com/docs/api#issuing_cardholder_object) object with which the card will be associated. */ - cardholder?: string; + cardholder?: string /** @description The currency for the card. This currently must be `usd`. */ - currency: string; + currency: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: { [key: string]: unknown }; + metadata?: { [key: string]: unknown } /** @description The card this is meant to be a replacement for (if any). */ - replacement_for?: string; + replacement_for?: string /** * @description If `replacement_for` is specified, this should indicate why that card is being replaced. * @enum {string} */ - replacement_reason?: "damaged" | "expired" | "lost" | "stolen"; + replacement_reason?: 'damaged' | 'expired' | 'lost' | 'stolen' /** * shipping_specs * @description The address where the card will be shipped. @@ -20608,952 +20547,952 @@ export interface operations { shipping?: { /** required_address */ address: { - city: string; - country: string; - line1: string; - line2?: string; - postal_code: string; - state?: string; - }; - name: string; + city: string + country: string + line1: string + line2?: string + postal_code: string + state?: string + } + name: string /** @enum {string} */ - service?: "express" | "priority" | "standard"; + service?: 'express' | 'priority' | 'standard' /** @enum {string} */ - type?: "bulk" | "individual"; - }; + type?: 'bulk' | 'individual' + } /** * authorization_controls_param * @description Spending rules that give you some control over how your cards can be used. Refer to our [authorizations](https://stripe.com/docs/issuing/purchases/authorizations) documentation for more details. */ spending_controls?: { allowed_categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] blocked_categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] spending_limits?: { - amount: number; + amount: number categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] /** @enum {string} */ - interval: "all_time" | "daily" | "monthly" | "per_authorization" | "weekly" | "yearly"; - }[]; - }; + interval: 'all_time' | 'daily' | 'monthly' | 'per_authorization' | 'weekly' | 'yearly' + }[] + } /** * @description Whether authorizations can be approved on this card. Defaults to `inactive`. * @enum {string} */ - status?: "active" | "inactive"; + status?: 'active' | 'inactive' /** * @description The type of card to issue. Possible values are `physical` or `virtual`. * @enum {string} */ - type: "physical" | "virtual"; - }; - }; - }; + type: 'physical' | 'virtual' + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["issuing.card"]; - }; + schema: definitions['issuing.card'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves an Issuing Card object.

*/ GetIssuingCardsCard: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - card: string; - }; - }; + card: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["issuing.card"]; - }; + schema: definitions['issuing.card'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ PostIssuingCardsCard: { parameters: { path: { - card: string; - }; + card: string + } body: { /** Body parameters for the request. */ payload?: { @@ -21561,947 +21500,947 @@ export interface operations { * @description Reason why the `status` of this card is `canceled`. * @enum {string} */ - cancellation_reason?: "lost" | "stolen"; + cancellation_reason?: 'lost' | 'stolen' /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: unknown; + metadata?: unknown /** * authorization_controls_param * @description Spending rules that give you some control over how your cards can be used. Refer to our [authorizations](https://stripe.com/docs/issuing/purchases/authorizations) documentation for more details. */ spending_controls?: { allowed_categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] blocked_categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] spending_limits?: { - amount: number; + amount: number categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] /** @enum {string} */ - interval: "all_time" | "daily" | "monthly" | "per_authorization" | "weekly" | "yearly"; - }[]; - }; + interval: 'all_time' | 'daily' | 'monthly' | 'per_authorization' | 'weekly' | 'yearly' + }[] + } /** * @description Dictates whether authorizations can be approved on this card. If this card is being canceled because it was lost or stolen, this information should be provided as `cancellation_reason`. * @enum {string} */ - status?: "active" | "canceled" | "inactive"; - }; - }; - }; + status?: 'active' | 'canceled' | 'inactive' + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["issuing.card"]; - }; + schema: definitions['issuing.card'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ GetIssuingDisputes: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["issuing.dispute"][]; + data: definitions['issuing.dispute'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Creates an Issuing Dispute object.

*/ PostIssuingDisputes: { parameters: { @@ -22509,382 +22448,382 @@ export interface operations { /** Body parameters for the request. */ payload?: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: { [key: string]: unknown }; - }; - }; - }; + metadata?: { [key: string]: unknown } + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["issuing.dispute"]; - }; + schema: definitions['issuing.dispute'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves an Issuing Dispute object.

*/ GetIssuingDisputesDispute: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - dispute: string; - }; - }; + dispute: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["issuing.dispute"]; - }; + schema: definitions['issuing.dispute'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ PostIssuingDisputesDispute: { parameters: { path: { - dispute: string; - }; + dispute: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: { [key: string]: unknown }; - }; - }; - }; + metadata?: { [key: string]: unknown } + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["issuing.dispute"]; - }; + schema: definitions['issuing.dispute'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ GetIssuingSettlements: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** Only return issuing settlements that were created during the given date interval. */ - created?: number; + created?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["issuing.settlement"][]; + data: definitions['issuing.settlement'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves an Issuing Settlement object.

*/ GetIssuingSettlementsSettlement: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - settlement: string; - }; - }; + settlement: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["issuing.settlement"]; - }; + schema: definitions['issuing.settlement'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ PostIssuingSettlementsSettlement: { parameters: { path: { - settlement: string; - }; + settlement: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: { [key: string]: unknown }; - }; - }; - }; + metadata?: { [key: string]: unknown } + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["issuing.settlement"]; - }; + schema: definitions['issuing.settlement'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ GetIssuingTransactions: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** Only return transactions that belong to the given card. */ - card?: string; + card?: string /** Only return transactions that belong to the given cardholder. */ - cardholder?: string; + cardholder?: string /** Only return transactions that were created during the given date interval. */ - created?: number; + created?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["issuing.transaction"][]; + data: definitions['issuing.transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves an Issuing Transaction object.

*/ GetIssuingTransactionsTransaction: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - transaction: string; - }; - }; + transaction: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["issuing.transaction"]; - }; + schema: definitions['issuing.transaction'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ PostIssuingTransactionsTransaction: { parameters: { path: { - transaction: string; - }; + transaction: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: unknown; - }; - }; - }; + metadata?: unknown + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["issuing.transaction"]; - }; + schema: definitions['issuing.transaction'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves a Mandate object.

*/ GetMandatesMandate: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - mandate: string; - }; - }; + mandate: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["mandate"]; - }; + schema: definitions['mandate'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ GetOrderReturns: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** Date this return was created. */ - created?: number; + created?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** The order to retrieve returns for. */ - order?: string; + order?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["order_return"][]; + data: definitions['order_return'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ GetOrderReturnsId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["order_return"]; - }; + schema: definitions['order_return'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ GetOrders: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** Date this order was created. */ - created?: number; + created?: number /** Only return orders for the given customer. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Only return orders with the given IDs. */ - ids?: unknown[]; + ids?: unknown[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return orders that have the given status. One of `created`, `paid`, `fulfilled`, or `refunded`. */ - status?: string; + status?: string /** Filter orders based on when they were paid, fulfilled, canceled, or returned. */ - status_transitions?: string; + status_transitions?: string /** Only return orders with the given upstream order IDs. */ - upstream_ids?: unknown[]; - }; - }; + upstream_ids?: unknown[] + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["order"][]; + data: definitions['order'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Creates a new order object.

*/ PostOrders: { parameters: { @@ -22892,27 +22831,27 @@ export interface operations { /** Body parameters for the request. */ payload: { /** @description A coupon code that represents a discount to be applied to this order. Must be one-time duration and in same currency as the order. An order can have multiple coupons. */ - coupon?: string; + coupon?: string /** @description 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: string; + currency: string /** @description The ID of an existing customer to use for this order. If provided, the customer email and shipping address will be used to create the order. Subsequently, the customer will also be charged to pay the order. If `email` or `shipping` are also provided, they will override the values retrieved from the customer object. */ - customer?: string; + customer?: string /** @description The email address of the customer placing the order. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description List of items constituting the order. An order can have up to 25 items. */ items?: { - amount?: number; - currency?: string; - description?: string; - parent?: string; - quantity?: number; + amount?: number + currency?: string + description?: string + parent?: string + quantity?: number /** @enum {string} */ - type?: "discount" | "shipping" | "sku" | "tax"; - }[]; + type?: 'discount' | 'shipping' | 'sku' | 'tax' + }[] /** @description 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. 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?: { [key: string]: unknown }; + metadata?: { [key: string]: unknown } /** * customer_shipping * @description Shipping address for the order. Required if any of the SKUs are for products that have `shippable` set to true. @@ -22920,205 +22859,205 @@ export interface operations { shipping?: { /** address */ address: { - city?: string; - country?: string; - line1: string; - line2?: string; - postal_code?: string; - state?: string; - }; - name: string; - phone?: string; - }; - }; - }; - }; - responses: { - /** Successful response. */ - 200: { - schema: definitions["order"]; - }; - /** Error response. */ - default: { - schema: definitions["error"]; - }; - }; - }; + city?: string + country?: string + line1: string + line2?: string + postal_code?: string + state?: string + } + name: string + phone?: string + } + } + } + } + responses: { + /** Successful response. */ + 200: { + schema: definitions['order'] + } + /** Error response. */ + default: { + schema: definitions['error'] + } + } + } /**

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

*/ GetOrdersId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["order"]; - }; + schema: definitions['order'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ PostOrdersId: { parameters: { path: { - id: string; - }; + id: string + } body: { /** Body parameters for the request. */ payload?: { /** @description A coupon code that represents a discount to be applied to this order. Must be one-time duration and in same currency as the order. An order can have multiple coupons. */ - coupon?: string; + coupon?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: unknown; + metadata?: unknown /** @description The shipping method to select for fulfilling this order. If specified, must be one of the `id`s of a shipping method in the `shipping_methods` array. If specified, will overwrite the existing selected shipping method, updating `items` as necessary. */ - selected_shipping_method?: string; + selected_shipping_method?: string /** * shipping_tracking_params * @description Tracking information once the order has been fulfilled. */ shipping?: { - carrier: string; - tracking_number: string; - }; + carrier: string + tracking_number: string + } /** * @description Current order status. One of `created`, `paid`, `canceled`, `fulfilled`, or `returned`. More detail in the [Orders Guide](https://stripe.com/docs/orders/guide#understanding-order-statuses). * @enum {string} */ - status?: "canceled" | "created" | "fulfilled" | "paid" | "returned"; - }; - }; - }; + status?: 'canceled' | 'created' | 'fulfilled' | 'paid' | 'returned' + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["order"]; - }; + schema: definitions['order'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Pay an order by providing a source to create a payment.

*/ PostOrdersIdPay: { parameters: { path: { - id: string; - }; + id: string + } body: { /** Body parameters for the request. */ payload?: { /** @description A fee in %s that will be applied to the order and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the `Stripe-Account` header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees). */ - application_fee?: number; + application_fee?: number /** @description The ID of an existing customer that will be charged for this order. If no customer was attached to the order at creation, either `source` or `customer` is required. Otherwise, the specified customer will be charged instead of the one attached to the order. */ - customer?: string; + customer?: string /** @description The email address of the customer placing the order. Required if not previously specified for the order. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: { [key: string]: unknown }; + metadata?: { [key: string]: unknown } /** @description A [Token](https://stripe.com/docs/api#tokens)'s or a [Source](https://stripe.com/docs/api#sources)'s ID, as returned by [Elements](https://stripe.com/docs/elements). If no customer was attached to the order at creation, either `source` or `customer` is required. Otherwise, the specified source will be charged intead of the customer attached to the order. */ - source?: string; - }; - }; - }; + source?: string + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["order"]; - }; + schema: definitions['order'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Return all or part of an order. The order must have a status of paid or fulfilled before it can be returned. Once all items have been returned, the order will become canceled or returned depending on which status the order started in.

*/ PostOrdersIdReturns: { parameters: { path: { - id: string; - }; + id: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description List of items to return. */ items?: { - amount?: number; - description?: string; - parent?: string; - quantity?: number; + amount?: number + description?: string + parent?: string + quantity?: number /** @enum {string} */ - type?: "discount" | "shipping" | "sku" | "tax"; - }[]; - }; - }; - }; + type?: 'discount' | 'shipping' | 'sku' | 'tax' + }[] + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["order_return"]; - }; + schema: definitions['order_return'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Returns a list of PaymentIntents.

*/ GetPaymentIntents: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** 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?: number; + created?: number /** Only return PaymentIntents for the customer specified by this customer ID. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["payment_intent"][]; + data: definitions['payment_intent'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

Creates a PaymentIntent object.

* @@ -23137,24 +23076,24 @@ export interface operations { /** Body parameters for the request. */ payload: { /** @description 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: number; + amount: number /** * @description The amount of the application fee (if any) that will be applied to the * payment and transferred to the application owner's Stripe account. For * more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ - application_fee_amount?: number; + application_fee_amount?: number /** * @description Controls when the funds will be captured from the customer's account. * @enum {string} */ - capture_method?: "automatic" | "manual"; + capture_method?: 'automatic' | 'manual' /** @description Set to `true` to attempt to [confirm](https://stripe.com/docs/api/payment_intents/confirm) this PaymentIntent immediately. This parameter defaults to `false`. When creating and confirming a PaymentIntent at the same time, parameters available in the [confirm](https://stripe.com/docs/api/payment_intents/confirm) API may also be provided. */ - confirm?: boolean; + confirm?: boolean /** @enum {string} */ - confirmation_method?: "automatic" | "manual"; + confirmation_method?: 'automatic' | 'manual' /** @description 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: string; + currency: string /** * @description ID of the Customer this PaymentIntent belongs to, if one exists. * @@ -23162,15 +23101,15 @@ export interface operations { * * If present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. */ - customer?: string; + customer?: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. This parameter is intended for simpler integrations that do not handle customer actions, like [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). */ - error_on_requires_action?: boolean; + error_on_requires_action?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description ID of the mandate to be used for this payment. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). */ - mandate?: string; + mandate?: string /** * secret_key_param * @description This hash contains details about the Mandate to create. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). @@ -23178,43 +23117,43 @@ export interface operations { mandate_data?: { /** customer_acceptance_param */ customer_acceptance: { - accepted_at?: number; + accepted_at?: number /** offline_param */ - offline?: { [key: string]: unknown }; + offline?: { [key: string]: unknown } /** online_param */ online?: { - ip_address: string; - user_agent: string; - }; + ip_address: string + user_agent: string + } /** @enum {string} */ - type: "offline" | "online"; - }; - }; + type: 'offline' | 'online' + } + } /** @description 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. 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?: { [key: string]: unknown }; + metadata?: { [key: string]: unknown } /** @description Set to `true` to indicate that the customer is not in your checkout flow during this payment attempt, and therefore is unable to authenticate. This parameter is intended for scenarios where you collect card details and [charge them later](https://stripe.com/docs/payments/cards/charging-saved-cards). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). */ - off_session?: unknown; + off_session?: unknown /** @description The Stripe account ID for which these funds are intended. For details, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ - on_behalf_of?: string; + on_behalf_of?: string /** * @description ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods#compatibility) object) to attach to this PaymentIntent. * * If this parameter is omitted with `confirm=true`, `customer.default_source` will be attached as this PaymentIntent's payment instrument to improve the migration experience for users of the Charges API. We recommend that you explicitly provide the `payment_method` going forward. */ - payment_method?: string; + payment_method?: string /** * payment_method_options_param * @description Payment-method-specific configuration for this PaymentIntent. */ payment_method_options?: { - card?: unknown; - }; + card?: unknown + } /** @description The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. If this is not provided, defaults to ["card"]. */ - payment_method_types?: string[]; + payment_method_types?: string[] /** @description Email address that the receipt for the resulting payment will be sent to. */ - receipt_email?: string; + receipt_email?: string /** @description The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). */ - return_url?: string; + return_url?: string /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * @@ -23223,7 +23162,7 @@ export interface operations { * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ - setup_future_usage?: "off_session" | "on_session"; + setup_future_usage?: 'off_session' | 'on_session' /** * shipping * @description Shipping information for this PaymentIntent. @@ -23231,49 +23170,49 @@ export interface operations { shipping?: { /** address */ address: { - city?: string; - country?: string; - line1: string; - line2?: string; - postal_code?: string; - state?: string; - }; - carrier?: string; - name: string; - phone?: string; - tracking_number?: string; - }; + city?: string + country?: string + line1: string + line2?: string + postal_code?: string + state?: string + } + carrier?: string + name: string + phone?: string + tracking_number?: string + } /** @description For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - statement_descriptor_suffix?: string; + statement_descriptor_suffix?: string /** * transfer_data_creation_params * @description The parameters used to automatically create a Transfer when the payment succeeds. * For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ transfer_data?: { - amount?: number; - destination: string; - }; + amount?: number + destination: string + } /** @description A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. */ - transfer_group?: string; + transfer_group?: string /** @description Set to `true` only when using manual confirmation and the iOS or Android SDKs to handle additional authentication steps. */ - use_stripe_sdk?: boolean; - }; - }; - }; + use_stripe_sdk?: boolean + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["payment_intent"]; - }; + schema: definitions['payment_intent'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

Retrieves the details of a PaymentIntent that has previously been created.

* @@ -23285,25 +23224,25 @@ export interface operations { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** The client secret of the PaymentIntent. Required if a publishable key is used to retrieve the source. */ - client_secret?: string; - }; + client_secret?: string + } path: { - intent: string; - }; - }; + intent: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["payment_intent"]; - }; + schema: definitions['payment_intent'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

Updates properties on a PaymentIntent object without confirming.

* @@ -23316,17 +23255,17 @@ export interface operations { PostPaymentIntentsIntent: { parameters: { path: { - intent: string; - }; + intent: string + } body: { /** Body parameters for the request. */ payload?: { /** @description 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?: number; + amount?: number /** @description The amount of the application fee (if any) for the resulting payment. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. */ - application_fee_amount?: unknown; + application_fee_amount?: unknown /** @description 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?: string; + currency?: string /** * @description ID of the Customer this PaymentIntent belongs to, if one exists. * @@ -23334,26 +23273,26 @@ export interface operations { * * If present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. */ - customer?: string; + customer?: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: unknown; + metadata?: unknown /** @description ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods#compatibility) object) to attach to this PaymentIntent. */ - payment_method?: string; + payment_method?: string /** * payment_method_options_param * @description Payment-method-specific configuration for this PaymentIntent. */ payment_method_options?: { - card?: unknown; - }; + card?: unknown + } /** @description The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. */ - payment_method_types?: string[]; + payment_method_types?: string[] /** @description Email address that the receipt for the resulting payment will be sent to. */ - receipt_email?: string; + receipt_email?: string /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * @@ -23364,36 +23303,36 @@ export interface operations { * If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. * @enum {string} */ - setup_future_usage?: "" | "off_session" | "on_session"; + setup_future_usage?: '' | 'off_session' | 'on_session' /** @description Shipping information for this PaymentIntent. */ - shipping?: unknown; + shipping?: unknown /** @description For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - statement_descriptor_suffix?: string; + statement_descriptor_suffix?: string /** * transfer_data_update_params * @description The parameters used to automatically create a Transfer when the payment succeeds. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ transfer_data?: { - amount?: number; - }; + amount?: number + } /** @description A string that identifies the resulting payment as part of a group. `transfer_group` may only be provided if it has not been set. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. */ - transfer_group?: string; - }; - }; - }; + transfer_group?: string + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["payment_intent"]; - }; + schema: definitions['payment_intent'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

A PaymentIntent object can be canceled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action.

* @@ -23402,8 +23341,8 @@ export interface operations { PostPaymentIntentsIntentCancel: { parameters: { path: { - intent: string; - }; + intent: string + } body: { /** Body parameters for the request. */ payload?: { @@ -23411,23 +23350,23 @@ export interface operations { * @description Reason for canceling this PaymentIntent. Possible values are `duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned` * @enum {string} */ - cancellation_reason?: "abandoned" | "duplicate" | "fraudulent" | "requested_by_customer"; + cancellation_reason?: 'abandoned' | 'duplicate' | 'fraudulent' | 'requested_by_customer' /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; + expand?: string[] + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["payment_intent"]; - }; + schema: definitions['payment_intent'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.

* @@ -23438,47 +23377,47 @@ export interface operations { PostPaymentIntentsIntentCapture: { parameters: { path: { - intent: string; - }; + intent: string + } body: { /** Body parameters for the request. */ payload?: { /** @description The amount to capture from the PaymentIntent, which must be less than or equal to the original amount. Any additional amount will be automatically refunded. Defaults to the full `amount_capturable` if not provided. */ - amount_to_capture?: number; + amount_to_capture?: number /** * @description The amount of the application fee (if any) that will be applied to the * payment and transferred to the application owner's Stripe account. For * more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ - application_fee_amount?: number; + application_fee_amount?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - statement_descriptor_suffix?: string; + statement_descriptor_suffix?: string /** * transfer_data_update_params * @description The parameters used to automatically create a Transfer when the payment * is captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ transfer_data?: { - amount?: number; - }; - }; - }; - }; + amount?: number + } + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["payment_intent"]; - }; + schema: definitions['payment_intent'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

Confirm that your customer intends to pay with current or provided * payment method. Upon confirmation, the PaymentIntent will attempt to initiate @@ -23509,19 +23448,19 @@ export interface operations { PostPaymentIntentsIntentConfirm: { parameters: { path: { - intent: string; - }; + intent: string + } body: { /** Body parameters for the request. */ payload?: { /** @description The client secret of the PaymentIntent. */ - client_secret?: string; + client_secret?: string /** @description Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. This parameter is intended for simpler integrations that do not handle customer actions, like [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication). */ - error_on_requires_action?: boolean; + error_on_requires_action?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description ID of the mandate to be used for this payment. */ - mandate?: string; + mandate?: string /** * secret_key_param * @description This hash contains details about the Mandate to create @@ -23529,39 +23468,39 @@ export interface operations { mandate_data?: { /** customer_acceptance_param */ customer_acceptance: { - accepted_at?: number; + accepted_at?: number /** offline_param */ - offline?: { [key: string]: unknown }; + offline?: { [key: string]: unknown } /** online_param */ online?: { - ip_address: string; - user_agent: string; - }; + ip_address: string + user_agent: string + } /** @enum {string} */ - type: "offline" | "online"; - }; - }; + type: 'offline' | 'online' + } + } /** @description Set to `true` to indicate that the customer is not in your checkout flow during this payment attempt, and therefore is unable to authenticate. This parameter is intended for scenarios where you collect card details and [charge them later](https://stripe.com/docs/payments/cards/charging-saved-cards). */ - off_session?: unknown; + off_session?: unknown /** @description ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods#compatibility) object) to attach to this PaymentIntent. */ - payment_method?: string; + payment_method?: string /** * payment_method_options_param * @description Payment-method-specific configuration for this PaymentIntent. */ payment_method_options?: { - card?: unknown; - }; + card?: unknown + } /** @description The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. */ - payment_method_types?: string[]; + payment_method_types?: string[] /** @description Email address that the receipt for the resulting payment will be sent to. */ - receipt_email?: string; + receipt_email?: string /** * @description The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. * If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. * This parameter is only used for cards and other redirect-based payment methods. */ - return_url?: string; + return_url?: string /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * @@ -23572,65 +23511,65 @@ export interface operations { * If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. * @enum {string} */ - setup_future_usage?: "" | "off_session" | "on_session"; + setup_future_usage?: '' | 'off_session' | 'on_session' /** @description Shipping information for this PaymentIntent. */ - shipping?: unknown; + shipping?: unknown /** @description Set to `true` only when using manual confirmation and the iOS or Android SDKs to handle additional authentication steps. */ - use_stripe_sdk?: boolean; - }; - }; - }; + use_stripe_sdk?: boolean + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["payment_intent"]; - }; + schema: definitions['payment_intent'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Returns a list of PaymentMethods for a given Customer

*/ GetPaymentMethods: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** The ID of the customer whose PaymentMethods will be retrieved. */ - customer: string; + customer: 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. */ - ending_before?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** A required filter on the list, based on the object `type` field. */ - type: string; - }; - }; + type: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["payment_method"][]; + data: definitions['payment_method'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Creates a PaymentMethod object. Read the Stripe.js reference to learn how to create PaymentMethods via Stripe.js.

*/ PostPaymentMethods: { parameters: { @@ -23642,9 +23581,9 @@ export interface operations { * @description If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account. */ au_becs_debit?: { - account_number: string; - bsb_number: string; - }; + account_number: string + bsb_number: string + } /** * billing_details_inner_params * @description Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods. @@ -23652,23 +23591,23 @@ export interface operations { billing_details?: { /** billing_details_address */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - email?: string; - name?: string; - phone?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + email?: string + name?: string + phone?: string + } /** @description If this is a `card` PaymentMethod, this hash contains the user's card details. For backwards compatibility, you can alternatively provide a Stripe token (e.g., for Apple Pay, Amex Express Checkout, or legacy Checkout) into the card hash with format `card: {token: "tok_visa"}`. When creating with a card number, you must meet the requirements for [PCI compliance](https://stripe.com/docs/security#validating-pci-compliance). We strongly recommend using Stripe.js instead of interacting with this API directly. */ - card?: { [key: string]: unknown }; + card?: { [key: string]: unknown } /** @description The `Customer` to whom the original PaymentMethod is attached. */ - customer?: string; + customer?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * param * @description If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method. @@ -23676,27 +23615,27 @@ export interface operations { fpx?: { /** @enum {string} */ bank: - | "affin_bank" - | "alliance_bank" - | "ambank" - | "bank_islam" - | "bank_muamalat" - | "bank_rakyat" - | "bsn" - | "cimb" - | "deutsche_bank" - | "hong_leong_bank" - | "hsbc" - | "kfh" - | "maybank2e" - | "maybank2u" - | "ocbc" - | "pb_enterprise" - | "public_bank" - | "rhb" - | "standard_chartered" - | "uob"; - }; + | 'affin_bank' + | 'alliance_bank' + | 'ambank' + | 'bank_islam' + | 'bank_muamalat' + | 'bank_rakyat' + | 'bsn' + | 'cimb' + | 'deutsche_bank' + | 'hong_leong_bank' + | 'hsbc' + | 'kfh' + | 'maybank2e' + | 'maybank2u' + | 'ocbc' + | 'pb_enterprise' + | 'public_bank' + | 'rhb' + | 'standard_chartered' + | 'uob' + } /** * param * @description If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method. @@ -23704,77 +23643,77 @@ export interface operations { ideal?: { /** @enum {string} */ bank?: - | "abn_amro" - | "asn_bank" - | "bunq" - | "handelsbanken" - | "ing" - | "knab" - | "moneyou" - | "rabobank" - | "regiobank" - | "sns_bank" - | "triodos_bank" - | "van_lanschot"; - }; + | 'abn_amro' + | 'asn_bank' + | 'bunq' + | 'handelsbanken' + | 'ing' + | 'knab' + | 'moneyou' + | 'rabobank' + | 'regiobank' + | 'sns_bank' + | 'triodos_bank' + | 'van_lanschot' + } /** @description 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. 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?: { [key: string]: unknown }; + metadata?: { [key: string]: unknown } /** @description The PaymentMethod to share. */ - payment_method?: string; + payment_method?: string /** * param * @description If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account. */ sepa_debit?: { - iban: string; - }; + iban: string + } /** * @description 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. Required unless `payment_method` is specified (see the [Cloning PaymentMethods](https://stripe.com/docs/payments/payment-methods/connect#cloning-payment-methods) guide) * @enum {string} */ - type?: "au_becs_debit" | "card" | "fpx" | "ideal" | "sepa_debit"; - }; - }; - }; + type?: 'au_becs_debit' | 'card' | 'fpx' | 'ideal' | 'sepa_debit' + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["payment_method"]; - }; + schema: definitions['payment_method'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves a PaymentMethod object.

*/ GetPaymentMethodsPaymentMethod: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - payment_method: string; - }; - }; + payment_method: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["payment_method"]; - }; + schema: definitions['payment_method'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ PostPaymentMethodsPaymentMethod: { parameters: { path: { - payment_method: string; - }; + payment_method: string + } body: { /** Body parameters for the request. */ payload?: { @@ -23785,48 +23724,48 @@ export interface operations { billing_details?: { /** billing_details_address */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - email?: string; - name?: string; - phone?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + email?: string + name?: string + phone?: string + } /** * update_api_param * @description If this is a `card` PaymentMethod, this hash contains the user's card details. */ card?: { - exp_month?: number; - exp_year?: number; - }; + exp_month?: number + exp_year?: number + } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: unknown; + metadata?: unknown /** * update_param * @description If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account. */ - sepa_debit?: { [key: string]: unknown }; - }; - }; - }; + sepa_debit?: { [key: string]: unknown } + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["payment_method"]; - }; + schema: definitions['payment_method'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

Attaches a PaymentMethod object to a Customer.

* @@ -23843,96 +23782,96 @@ export interface operations { PostPaymentMethodsPaymentMethodAttach: { parameters: { path: { - payment_method: string; - }; + payment_method: string + } body: { /** Body parameters for the request. */ payload: { /** @description The ID of the customer to which to attach the PaymentMethod. */ - customer: string; + customer: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; + expand?: string[] + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["payment_method"]; - }; + schema: definitions['payment_method'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Detaches a PaymentMethod object from a Customer.

*/ PostPaymentMethodsPaymentMethodDetach: { parameters: { path: { - payment_method: string; - }; + payment_method: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; + expand?: string[] + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["payment_method"]; - }; + schema: definitions['payment_method'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Returns a list of existing payouts sent to third-party bank accounts or that Stripe has sent you. The payouts are returned in sorted order, with the most recently created payouts appearing first.

*/ GetPayouts: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - arrival_date?: number; - created?: number; + expand?: unknown[] + arrival_date?: number + created?: number /** The ID of an external account - only return payouts sent to this external account. */ - destination?: string; + destination?: 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. */ - ending_before?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return payouts that have the given status: `pending`, `paid`, `failed`, or `canceled`. */ - status?: string; - }; - }; + status?: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["payout"][]; + data: definitions['payout'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

To send funds to your own bank account, you create a new payout object. Your Stripe balance must be able to cover the payout amount, or you’ll receive an “Insufficient Funds” error.

* @@ -23946,159 +23885,159 @@ export interface operations { /** Body parameters for the request. */ payload: { /** @description A positive integer in cents representing how much to payout. */ - amount: number; + amount: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description The ID of a bank account or a card to send the payout to. If no destination is supplied, the default external account for the specified currency will be used. */ - destination?: string; + destination?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: { [key: string]: unknown }; + metadata?: { [key: string]: unknown } /** * @description The method used to send this payout, which can be `standard` or `instant`. `instant` is only supported for payouts to debit cards. (See [Instant payouts for marketplaces for more information](https://stripe.com/blog/instant-payouts-for-marketplaces).) * @enum {string} */ - method?: "instant" | "standard"; + method?: 'instant' | 'standard' /** * @description The balance type of your Stripe balance to draw this payout from. Balances for different payment sources are kept separately. You can find the amounts with the balances API. One of `bank_account`, `card`, or `fpx`. * @enum {string} */ - source_type?: "bank_account" | "card" | "fpx"; + source_type?: 'bank_account' | 'card' | 'fpx' /** @description A string to be displayed on the recipient's bank or card statement. This may be at most 22 characters. Attempting to use a `statement_descriptor` longer than 22 characters will return an error. Note: Most banks will truncate this information and/or display it inconsistently. Some may not display it at all. */ - statement_descriptor?: string; - }; - }; - }; + statement_descriptor?: string + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["payout"]; - }; + schema: definitions['payout'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ GetPayoutsPayout: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - payout: string; - }; - }; + payout: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["payout"]; - }; + schema: definitions['payout'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Updates the specified payout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request accepts only the metadata as arguments.

*/ PostPayoutsPayout: { parameters: { path: { - payout: string; - }; + payout: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: unknown; - }; - }; - }; + metadata?: unknown + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["payout"]; - }; + schema: definitions['payout'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

A previously created payout can be canceled if it has not yet been paid out. Funds will be refunded to your available balance. You may not cancel automatic Stripe payouts.

*/ PostPayoutsPayoutCancel: { parameters: { path: { - payout: string; - }; + payout: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; + expand?: string[] + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["payout"]; - }; + schema: definitions['payout'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Returns a list of your plans.

*/ GetPlans: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** Only return plans that are active or inactive (e.g., pass `false` to list all inactive plans). */ - active?: boolean; + active?: boolean /** 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?: number; + created?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return plans for the given product. */ - product?: string; + product?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["plan"][]; + data: definitions['plan'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

You can create plans using the API, or in the Stripe Dashboard.

*/ PostPlans: { parameters: { @@ -24106,216 +24045,216 @@ export interface operations { /** Body parameters for the request. */ payload: { /** @description Whether the plan is currently available for new subscriptions. Defaults to `true`. */ - active?: boolean; + active?: boolean /** * @description 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`. * @enum {string} */ - aggregate_usage?: "last_during_period" | "last_ever" | "max" | "sum"; + aggregate_usage?: 'last_during_period' | 'last_ever' | 'max' | 'sum' /** @description A positive integer in %s (or 0 for a free plan) representing how much to charge on a recurring basis. */ - amount?: number; + amount?: number /** @description Same as `amount`, but accepts a decimal value with at most 12 decimal places. Only one of `amount` and `amount_decimal` can be set. */ - amount_decimal?: string; + amount_decimal?: string /** * @description 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. * @enum {string} */ - billing_scheme?: "per_unit" | "tiered"; + billing_scheme?: 'per_unit' | 'tiered' /** @description 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: string; + currency: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description An identifier randomly generated by Stripe. Used to identify this plan when subscribing a customer. You can optionally override this ID, but the ID must be unique across all plans in your Stripe account. You can, however, use the same plan ID in both live and test modes. */ - id?: string; + id?: string /** * @description Specifies billing frequency. Either `day`, `week`, `month` or `year`. * @enum {string} */ - interval: "day" | "month" | "week" | "year"; + interval: 'day' | 'month' | 'week' | 'year' /** @description The number of intervals between subscription billings. 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?: number; + interval_count?: number /** @description 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. 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?: unknown; + metadata?: unknown /** @description A brief description of the plan, hidden from customers. */ - nickname?: string; + nickname?: string /** * inline_product_params * @description The product whose pricing the created plan will represent. This can either be the ID of an existing product, or a dictionary containing fields used to create a [service product](https://stripe.com/docs/api#product_object-type). */ product?: { - active?: boolean; - id?: string; - metadata?: { [key: string]: unknown }; - name: string; - statement_descriptor?: string; - unit_label?: string; - }; + active?: boolean + id?: string + metadata?: { [key: string]: unknown } + name: string + statement_descriptor?: string + unit_label?: string + } /** @description Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. */ tiers?: { - flat_amount?: number; - flat_amount_decimal?: string; - unit_amount?: number; - unit_amount_decimal?: string; - up_to: unknown; - }[]; + flat_amount?: number + flat_amount_decimal?: string + unit_amount?: number + unit_amount_decimal?: string + up_to: unknown + }[] /** * @description 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 successively change as the quantity grows. * @enum {string} */ - tiers_mode?: "graduated" | "volume"; + tiers_mode?: 'graduated' | 'volume' /** * transform_usage_param * @description Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`. */ transform_usage?: { - divide_by: number; + divide_by: number /** @enum {string} */ - round: "down" | "up"; - }; + round: 'down' | 'up' + } /** @description 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?: number; + trial_period_days?: number /** * @description 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`. * @enum {string} */ - usage_type?: "licensed" | "metered"; - }; - }; - }; + usage_type?: 'licensed' | 'metered' + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["plan"]; - }; + schema: definitions['plan'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves the plan with the given ID.

*/ GetPlansPlan: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - plan: string; - }; - }; + plan: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["plan"]; - }; + schema: definitions['plan'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ PostPlansPlan: { parameters: { path: { - plan: string; - }; + plan: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Whether the plan is currently available for new subscriptions. */ - active?: boolean; + active?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: unknown; + metadata?: unknown /** @description A brief description of the plan, hidden from customers. */ - nickname?: string; + nickname?: string /** @description The product the plan belongs to. Note that after updating, statement descriptors and line items of the plan in active subscriptions will be affected. */ - product?: string; + product?: string /** @description 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?: number; - }; - }; - }; + trial_period_days?: number + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["plan"]; - }; + schema: definitions['plan'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ DeletePlansPlan: { parameters: { path: { - plan: string; - }; - }; + plan: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["deleted_plan"]; - }; + schema: definitions['deleted_plan'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ GetProducts: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** Only return products that are active or inactive (e.g., pass `false` to list all inactive products). */ - active?: boolean; + active?: boolean /** Only return products that were created during the given date interval. */ - created?: number; + created?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Only return products with the given IDs. */ - ids?: unknown[]; + ids?: unknown[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return products that can be shipped (i.e., physical, not digital products). */ - shippable?: boolean; + shippable?: boolean /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return products of this type. */ - type?: string; + type?: string /** Only return products with the given url. */ - url?: string; - }; - }; + url?: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["product"][]; + data: definitions['product'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Creates a new product object.

*/ PostProducts: { parameters: { @@ -24323,201 +24262,201 @@ export interface operations { /** Body parameters for the request. */ payload: { /** @description Whether the product is currently available for purchase. Defaults to `true`. */ - active?: boolean; + active?: boolean /** @description A list of up to 5 alphanumeric attributes. */ - attributes?: string[]; + attributes?: string[] /** @description A short one-line description of the product, meant to be displayable to the customer. May only be set if type=`good`. */ - caption?: string; + caption?: string /** @description An array of Connect application names or identifiers that should not be able to order the SKUs for this product. May only be set if type=`good`. */ - deactivate_on?: string[]; + deactivate_on?: string[] /** @description 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?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description An identifier will be randomly generated by Stripe. You can optionally override this ID, but the ID must be unique across all products in your Stripe account. */ - id?: string; + id?: string /** @description A list of up to 8 URLs of images for this product, meant to be displayable to the customer. */ - images?: string[]; + images?: string[] /** @description 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. 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?: { [key: string]: unknown }; + metadata?: { [key: string]: unknown } /** @description The product's name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions. */ - name: string; + name: string /** * package_dimensions_specs * @description The dimensions of this product for shipping purposes. A SKU associated with this product can override this value by having its own `package_dimensions`. May only be set if type=`good`. */ package_dimensions?: { - height: number; - length: number; - weight: number; - width: number; - }; + height: number + length: number + weight: number + width: number + } /** @description Whether this product is shipped (i.e., physical goods). Defaults to `true`. May only be set if type=`good`. */ - shippable?: boolean; + shippable?: boolean /** * @description An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all. * * This may be up to 22 characters. The statement description may not include `<`, `>`, `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. * It must contain at least one letter. */ - statement_descriptor?: string; + statement_descriptor?: string /** * @description The type of the product. Defaults to `service` if not explicitly specified, enabling use of this product with Subscriptions and Plans. Set this parameter to `good` to use this product with Orders and SKUs. On API versions before `2018-02-05`, this field defaults to `good` for compatibility reasons. * @enum {string} */ - type?: "good" | "service"; + type?: 'good' | 'service' /** @description A label that represents units of this product in Stripe and on customers’ receipts and invoices. When set, this will be included in associated invoice line item descriptions. */ - unit_label?: string; + unit_label?: string /** @description A URL of a publicly-accessible webpage for this product. May only be set if type=`good`. */ - url?: string; - }; - }; - }; + url?: string + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["product"]; - }; + schema: definitions['product'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ GetProductsId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["product"]; - }; + schema: definitions['product'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ PostProductsId: { parameters: { path: { - id: string; - }; + id: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Whether the product is available for purchase. */ - active?: boolean; + active?: boolean /** @description A list of up to 5 alphanumeric attributes that each SKU can provide values for (e.g., `["color", "size"]`). If a value for `attributes` is specified, the list specified will replace the existing attributes list on this product. Any attributes not present after the update will be deleted from the SKUs for this product. */ - attributes?: string[]; + attributes?: string[] /** @description A short one-line description of the product, meant to be displayable to the customer. May only be set if `type=good`. */ - caption?: string; + caption?: string /** @description An array of Connect application names or identifiers that should not be able to order the SKUs for this product. May only be set if `type=good`. */ - deactivate_on?: string[]; + deactivate_on?: string[] /** @description 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?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A list of up to 8 URLs of images for this product, meant to be displayable to the customer. */ - images?: string[]; + images?: string[] /** @description 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. 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?: unknown; + metadata?: unknown /** @description The product's name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions. */ - name?: string; + name?: string /** @description The dimensions of this product for shipping purposes. A SKU associated with this product can override this value by having its own `package_dimensions`. May only be set if `type=good`. */ - package_dimensions?: unknown; + package_dimensions?: unknown /** @description Whether this product is shipped (i.e., physical goods). Defaults to `true`. May only be set if `type=good`. */ - shippable?: boolean; + shippable?: boolean /** * @description An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all. * * This may be up to 22 characters. The statement description may not include `<`, `>`, `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. * It must contain at least one letter. May only be set if `type=service`. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description A label that represents units of this product in Stripe and on customers’ receipts and invoices. When set, this will be included in associated invoice line item descriptions. May only be set if `type=service`. */ - unit_label?: string; + unit_label?: string /** @description A URL of a publicly-accessible webpage for this product. May only be set if `type=good`. */ - url?: string; - }; - }; - }; + url?: string + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["product"]; - }; + schema: definitions['product'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Delete a product. Deleting a product with type=good is only possible if it has no SKUs associated with it. Deleting a product with type=service is only possible if it has no plans associated with it.

*/ DeleteProductsId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["deleted_product"]; - }; + schema: definitions['deleted_product'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Returns a list of early fraud warnings.

*/ GetRadarEarlyFraudWarnings: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** Only return early fraud warnings for the charge specified by this charge ID. */ - charge?: string; + charge?: 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. */ - ending_before?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["radar.early_fraud_warning"][]; + data: definitions['radar.early_fraud_warning'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

Retrieves the details of an early fraud warning that has previously been created.

* @@ -24527,64 +24466,64 @@ export interface operations { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - early_fraud_warning: string; - }; - }; + early_fraud_warning: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["radar.early_fraud_warning"]; - }; + schema: definitions['radar.early_fraud_warning'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ GetRadarValueListItems: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - created?: number; + expand?: unknown[] + created?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Return items belonging to the parent list whose value matches the specified value (using an "is like" match). */ - value?: string; + value?: string /** Identifier for the parent value list this item belongs to. */ - value_list: string; - }; - }; + value_list: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["radar.value_list_item"][]; + data: definitions['radar.value_list_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ PostRadarValueListItems: { parameters: { @@ -24592,106 +24531,106 @@ export interface operations { /** Body parameters for the request. */ payload: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The value of the item (whose type must match the type of the parent value list). */ - value: string; + value: string /** @description The identifier of the value list which the created item will be added to. */ - value_list: string; - }; - }; - }; + value_list: string + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["radar.value_list_item"]; - }; + schema: definitions['radar.value_list_item'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves a ValueListItem object.

*/ GetRadarValueListItemsItem: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - item: string; - }; - }; + item: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["radar.value_list_item"]; - }; + schema: definitions['radar.value_list_item'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ DeleteRadarValueListItemsItem: { parameters: { path: { - item: string; - }; - }; + item: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["deleted_radar.value_list_item"]; - }; + schema: definitions['deleted_radar.value_list_item'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ GetRadarValueLists: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** The alias used to reference the value list when writing rules. */ - alias?: string; + alias?: string /** A value contained within a value list - returns all value lists containing this value. */ - contains?: string; - created?: number; + contains?: string + created?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["radar.value_list"][]; + data: definitions['radar.value_list'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ PostRadarValueLists: { parameters: { @@ -24699,150 +24638,143 @@ export interface operations { /** Body parameters for the request. */ payload: { /** @description The name of the value list for use in rules. */ - alias: string; + alias: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * @description Type of the items in the value list. One of `card_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, or `case_sensitive_string`. Use `string` if the item type is unknown or mixed. * @enum {string} */ - item_type?: - | "card_bin" - | "card_fingerprint" - | "case_sensitive_string" - | "country" - | "email" - | "ip_address" - | "string"; + item_type?: 'card_bin' | 'card_fingerprint' | 'case_sensitive_string' | 'country' | 'email' | 'ip_address' | 'string' /** @description 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. 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?: { [key: string]: unknown }; + metadata?: { [key: string]: unknown } /** @description The human-readable name of the value list. */ - name: string; - }; - }; - }; + name: string + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["radar.value_list"]; - }; + schema: definitions['radar.value_list'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves a ValueList object.

*/ GetRadarValueListsValueList: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - value_list: string; - }; - }; + value_list: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["radar.value_list"]; - }; + schema: definitions['radar.value_list'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ PostRadarValueListsValueList: { parameters: { path: { - value_list: string; - }; + value_list: string + } body: { /** Body parameters for the request. */ payload?: { /** @description The name of the value list for use in rules. */ - alias?: string; + alias?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: { [key: string]: unknown }; + metadata?: { [key: string]: unknown } /** @description The human-readable name of the value list. */ - name?: string; - }; - }; - }; + name?: string + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["radar.value_list"]; - }; + schema: definitions['radar.value_list'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ DeleteRadarValueListsValueList: { parameters: { path: { - value_list: string; - }; - }; + value_list: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["deleted_radar.value_list"]; - }; + schema: definitions['deleted_radar.value_list'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ GetRecipients: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - created?: number; + expand?: unknown[] + created?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - type?: string; + starting_after?: string + type?: string /** Only return recipients that are verified or unverified. */ - verified?: boolean; - }; - }; + verified?: boolean + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["recipient"][]; + data: definitions['recipient'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

Creates a new Recipient object and verifies the recipient’s identity. * Also verifies the recipient’s bank account information or debit card, if either is provided.

@@ -24853,59 +24785,59 @@ export interface operations { /** Body parameters for the request. */ payload: { /** @description A bank account to attach to the recipient. You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe-js), or a dictionary containing a user's bank account details, with the options described below. */ - bank_account?: string; + bank_account?: string /** @description A U.S. Visa or MasterCard debit card (_not_ prepaid) to attach to the recipient. If the debit card is not valid, recipient creation will fail. You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe-js), or a dictionary containing a user's debit card details, with the options described below. Although not all information is required, the extra info helps prevent fraud. */ - card?: string; + card?: string /** @description An arbitrary string which you can attach to a `Recipient` object. It is displayed alongside the recipient in the web interface. */ - description?: string; + description?: string /** @description The recipient's email address. It is displayed alongside the recipient in the web interface, and can be useful for searching and tracking. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: unknown; + metadata?: unknown /** @description The recipient's full, legal name. For type `individual`, should be in the format `First Last`, `First Middle Last`, or `First M Last` (no prefixes or suffixes). For `corporation`, the full, incorporated name. */ - name: string; + name: string /** @description The recipient's tax ID, as a string. For type `individual`, the full SSN; for type `corporation`, the full EIN. */ - tax_id?: string; + tax_id?: string /** @description Type of the recipient: either `individual` or `corporation`. */ - type: string; - }; - }; - }; + type: string + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["recipient"]; - }; + schema: definitions['recipient'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves the details of an existing recipient. You need only supply the unique recipient identifier that was returned upon recipient creation.

*/ GetRecipientsId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["deleted_recipient"]; - }; + schema: definitions['deleted_recipient'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

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

@@ -24916,155 +24848,155 @@ export interface operations { PostRecipientsId: { parameters: { path: { - id: string; - }; + id: string + } body: { /** Body parameters for the request. */ payload?: { /** @description A bank account to attach to the recipient. You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe-js), or a dictionary containing a user's bank account details, with the options described below. */ - bank_account?: string; + bank_account?: string /** @description A U.S. Visa or MasterCard debit card (not prepaid) to attach to the recipient. You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe-js), or a dictionary containing a user's debit card details, with the options described below. Passing `card` will create a new card, make it the new recipient default card, and delete the old recipient default (if one exists). If you want to add additional debit cards instead of replacing the existing default, use the [card creation API](https://stripe.com/docs/api#create_card). Whenever you attach a card to a recipient, Stripe will automatically validate the debit card. */ - card?: string; + card?: string /** @description ID of the card to set as the recipient's new default for payouts. */ - default_card?: string; + default_card?: string /** @description An arbitrary string which you can attach to a `Recipient` object. It is displayed alongside the recipient in the web interface. */ - description?: string; + description?: string /** @description The recipient's email address. It is displayed alongside the recipient in the web interface, and can be useful for searching and tracking. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: unknown; + metadata?: unknown /** @description The recipient's full, legal name. For type `individual`, should be in the format `First Last`, `First Middle Last`, or `First M Last` (no prefixes or suffixes). For `corporation`, the full, incorporated name. */ - name?: string; + name?: string /** @description The recipient's tax ID, as a string. For type `individual`, the full SSN; for type `corporation`, the full EIN. */ - tax_id?: string; - }; - }; - }; + tax_id?: string + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["recipient"]; - }; + schema: definitions['recipient'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Permanently deletes a recipient. It cannot be undone.

*/ DeleteRecipientsId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["deleted_recipient"]; - }; + schema: definitions['deleted_recipient'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Returns a list of all refunds you’ve previously created. The refunds are returned in sorted order, with the most recent refunds appearing first. For convenience, the 10 most recent refunds are always available by default on the charge object.

*/ GetRefunds: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** Only return refunds for the charge specified by this charge ID. */ - charge?: string; - created?: number; + charge?: string + created?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return refunds for the PaymentIntent specified by this ID. */ - payment_intent?: string; + payment_intent?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["refund"][]; + data: definitions['refund'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Create a refund.

*/ PostRefunds: { parameters: { body: { /** Body parameters for the request. */ payload?: { - amount?: number; - charge?: string; + amount?: number + charge?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: { [key: string]: unknown }; - payment_intent?: string; + metadata?: { [key: string]: unknown } + payment_intent?: string /** @enum {string} */ - reason?: "duplicate" | "fraudulent" | "requested_by_customer"; - refund_application_fee?: boolean; - reverse_transfer?: boolean; - }; - }; - }; + reason?: 'duplicate' | 'fraudulent' | 'requested_by_customer' + refund_application_fee?: boolean + reverse_transfer?: boolean + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["refund"]; - }; + schema: definitions['refund'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves the details of an existing refund.

*/ GetRefundsRefund: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - refund: string; - }; - }; + refund: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["refund"]; - }; + schema: definitions['refund'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

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

* @@ -25073,66 +25005,66 @@ export interface operations { PostRefundsRefund: { parameters: { path: { - refund: string; - }; + refund: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: unknown; - }; - }; - }; + metadata?: unknown + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["refund"]; - }; + schema: definitions['refund'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Returns a list of Report Runs, with the most recent appearing first. (Requires a live-mode API key.)

*/ GetReportingReportRuns: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - created?: number; + expand?: unknown[] + created?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["reporting.report_run"][]; + data: definitions['reporting.report_run'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ PostReportingReportRuns: { parameters: { @@ -25140,864 +25072,864 @@ export interface operations { /** Body parameters for the request. */ payload: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * run_parameter_specs * @description Parameters specifying how the report should be run. Different Report Types have different required and optional parameters, listed in the [API Access to Reports](https://stripe.com/docs/reporting/statements/api) documentation. */ parameters?: { - columns?: string[]; - connected_account?: string; - currency?: string; - interval_end?: number; - interval_start?: number; - payout?: string; + columns?: string[] + connected_account?: string + currency?: string + interval_end?: number + interval_start?: number + payout?: string /** @enum {string} */ reporting_category?: - | "advance" - | "advance_funding" - | "charge" - | "charge_failure" - | "connect_collection_transfer" - | "connect_reserved_funds" - | "dispute" - | "dispute_reversal" - | "fee" - | "financing_paydown" - | "financing_paydown_reversal" - | "financing_payout" - | "financing_payout_reversal" - | "issuing_authorization_hold" - | "issuing_authorization_release" - | "issuing_transaction" - | "network_cost" - | "other_adjustment" - | "partial_capture_reversal" - | "payout" - | "payout_reversal" - | "platform_earning" - | "platform_earning_refund" - | "refund" - | "refund_failure" - | "risk_reserved_funds" - | "tax" - | "topup" - | "topup_reversal" - | "transfer" - | "transfer_reversal"; + | 'advance' + | 'advance_funding' + | 'charge' + | 'charge_failure' + | 'connect_collection_transfer' + | 'connect_reserved_funds' + | 'dispute' + | 'dispute_reversal' + | 'fee' + | 'financing_paydown' + | 'financing_paydown_reversal' + | 'financing_payout' + | 'financing_payout_reversal' + | 'issuing_authorization_hold' + | 'issuing_authorization_release' + | 'issuing_transaction' + | 'network_cost' + | 'other_adjustment' + | 'partial_capture_reversal' + | 'payout' + | 'payout_reversal' + | 'platform_earning' + | 'platform_earning_refund' + | 'refund' + | 'refund_failure' + | 'risk_reserved_funds' + | 'tax' + | 'topup' + | 'topup_reversal' + | 'transfer' + | 'transfer_reversal' /** @enum {string} */ timezone?: - | "Africa/Abidjan" - | "Africa/Accra" - | "Africa/Addis_Ababa" - | "Africa/Algiers" - | "Africa/Asmara" - | "Africa/Asmera" - | "Africa/Bamako" - | "Africa/Bangui" - | "Africa/Banjul" - | "Africa/Bissau" - | "Africa/Blantyre" - | "Africa/Brazzaville" - | "Africa/Bujumbura" - | "Africa/Cairo" - | "Africa/Casablanca" - | "Africa/Ceuta" - | "Africa/Conakry" - | "Africa/Dakar" - | "Africa/Dar_es_Salaam" - | "Africa/Djibouti" - | "Africa/Douala" - | "Africa/El_Aaiun" - | "Africa/Freetown" - | "Africa/Gaborone" - | "Africa/Harare" - | "Africa/Johannesburg" - | "Africa/Juba" - | "Africa/Kampala" - | "Africa/Khartoum" - | "Africa/Kigali" - | "Africa/Kinshasa" - | "Africa/Lagos" - | "Africa/Libreville" - | "Africa/Lome" - | "Africa/Luanda" - | "Africa/Lubumbashi" - | "Africa/Lusaka" - | "Africa/Malabo" - | "Africa/Maputo" - | "Africa/Maseru" - | "Africa/Mbabane" - | "Africa/Mogadishu" - | "Africa/Monrovia" - | "Africa/Nairobi" - | "Africa/Ndjamena" - | "Africa/Niamey" - | "Africa/Nouakchott" - | "Africa/Ouagadougou" - | "Africa/Porto-Novo" - | "Africa/Sao_Tome" - | "Africa/Timbuktu" - | "Africa/Tripoli" - | "Africa/Tunis" - | "Africa/Windhoek" - | "America/Adak" - | "America/Anchorage" - | "America/Anguilla" - | "America/Antigua" - | "America/Araguaina" - | "America/Argentina/Buenos_Aires" - | "America/Argentina/Catamarca" - | "America/Argentina/ComodRivadavia" - | "America/Argentina/Cordoba" - | "America/Argentina/Jujuy" - | "America/Argentina/La_Rioja" - | "America/Argentina/Mendoza" - | "America/Argentina/Rio_Gallegos" - | "America/Argentina/Salta" - | "America/Argentina/San_Juan" - | "America/Argentina/San_Luis" - | "America/Argentina/Tucuman" - | "America/Argentina/Ushuaia" - | "America/Aruba" - | "America/Asuncion" - | "America/Atikokan" - | "America/Atka" - | "America/Bahia" - | "America/Bahia_Banderas" - | "America/Barbados" - | "America/Belem" - | "America/Belize" - | "America/Blanc-Sablon" - | "America/Boa_Vista" - | "America/Bogota" - | "America/Boise" - | "America/Buenos_Aires" - | "America/Cambridge_Bay" - | "America/Campo_Grande" - | "America/Cancun" - | "America/Caracas" - | "America/Catamarca" - | "America/Cayenne" - | "America/Cayman" - | "America/Chicago" - | "America/Chihuahua" - | "America/Coral_Harbour" - | "America/Cordoba" - | "America/Costa_Rica" - | "America/Creston" - | "America/Cuiaba" - | "America/Curacao" - | "America/Danmarkshavn" - | "America/Dawson" - | "America/Dawson_Creek" - | "America/Denver" - | "America/Detroit" - | "America/Dominica" - | "America/Edmonton" - | "America/Eirunepe" - | "America/El_Salvador" - | "America/Ensenada" - | "America/Fort_Nelson" - | "America/Fort_Wayne" - | "America/Fortaleza" - | "America/Glace_Bay" - | "America/Godthab" - | "America/Goose_Bay" - | "America/Grand_Turk" - | "America/Grenada" - | "America/Guadeloupe" - | "America/Guatemala" - | "America/Guayaquil" - | "America/Guyana" - | "America/Halifax" - | "America/Havana" - | "America/Hermosillo" - | "America/Indiana/Indianapolis" - | "America/Indiana/Knox" - | "America/Indiana/Marengo" - | "America/Indiana/Petersburg" - | "America/Indiana/Tell_City" - | "America/Indiana/Vevay" - | "America/Indiana/Vincennes" - | "America/Indiana/Winamac" - | "America/Indianapolis" - | "America/Inuvik" - | "America/Iqaluit" - | "America/Jamaica" - | "America/Jujuy" - | "America/Juneau" - | "America/Kentucky/Louisville" - | "America/Kentucky/Monticello" - | "America/Knox_IN" - | "America/Kralendijk" - | "America/La_Paz" - | "America/Lima" - | "America/Los_Angeles" - | "America/Louisville" - | "America/Lower_Princes" - | "America/Maceio" - | "America/Managua" - | "America/Manaus" - | "America/Marigot" - | "America/Martinique" - | "America/Matamoros" - | "America/Mazatlan" - | "America/Mendoza" - | "America/Menominee" - | "America/Merida" - | "America/Metlakatla" - | "America/Mexico_City" - | "America/Miquelon" - | "America/Moncton" - | "America/Monterrey" - | "America/Montevideo" - | "America/Montreal" - | "America/Montserrat" - | "America/Nassau" - | "America/New_York" - | "America/Nipigon" - | "America/Nome" - | "America/Noronha" - | "America/North_Dakota/Beulah" - | "America/North_Dakota/Center" - | "America/North_Dakota/New_Salem" - | "America/Ojinaga" - | "America/Panama" - | "America/Pangnirtung" - | "America/Paramaribo" - | "America/Phoenix" - | "America/Port-au-Prince" - | "America/Port_of_Spain" - | "America/Porto_Acre" - | "America/Porto_Velho" - | "America/Puerto_Rico" - | "America/Punta_Arenas" - | "America/Rainy_River" - | "America/Rankin_Inlet" - | "America/Recife" - | "America/Regina" - | "America/Resolute" - | "America/Rio_Branco" - | "America/Rosario" - | "America/Santa_Isabel" - | "America/Santarem" - | "America/Santiago" - | "America/Santo_Domingo" - | "America/Sao_Paulo" - | "America/Scoresbysund" - | "America/Shiprock" - | "America/Sitka" - | "America/St_Barthelemy" - | "America/St_Johns" - | "America/St_Kitts" - | "America/St_Lucia" - | "America/St_Thomas" - | "America/St_Vincent" - | "America/Swift_Current" - | "America/Tegucigalpa" - | "America/Thule" - | "America/Thunder_Bay" - | "America/Tijuana" - | "America/Toronto" - | "America/Tortola" - | "America/Vancouver" - | "America/Virgin" - | "America/Whitehorse" - | "America/Winnipeg" - | "America/Yakutat" - | "America/Yellowknife" - | "Antarctica/Casey" - | "Antarctica/Davis" - | "Antarctica/DumontDUrville" - | "Antarctica/Macquarie" - | "Antarctica/Mawson" - | "Antarctica/McMurdo" - | "Antarctica/Palmer" - | "Antarctica/Rothera" - | "Antarctica/South_Pole" - | "Antarctica/Syowa" - | "Antarctica/Troll" - | "Antarctica/Vostok" - | "Arctic/Longyearbyen" - | "Asia/Aden" - | "Asia/Almaty" - | "Asia/Amman" - | "Asia/Anadyr" - | "Asia/Aqtau" - | "Asia/Aqtobe" - | "Asia/Ashgabat" - | "Asia/Ashkhabad" - | "Asia/Atyrau" - | "Asia/Baghdad" - | "Asia/Bahrain" - | "Asia/Baku" - | "Asia/Bangkok" - | "Asia/Barnaul" - | "Asia/Beirut" - | "Asia/Bishkek" - | "Asia/Brunei" - | "Asia/Calcutta" - | "Asia/Chita" - | "Asia/Choibalsan" - | "Asia/Chongqing" - | "Asia/Chungking" - | "Asia/Colombo" - | "Asia/Dacca" - | "Asia/Damascus" - | "Asia/Dhaka" - | "Asia/Dili" - | "Asia/Dubai" - | "Asia/Dushanbe" - | "Asia/Famagusta" - | "Asia/Gaza" - | "Asia/Harbin" - | "Asia/Hebron" - | "Asia/Ho_Chi_Minh" - | "Asia/Hong_Kong" - | "Asia/Hovd" - | "Asia/Irkutsk" - | "Asia/Istanbul" - | "Asia/Jakarta" - | "Asia/Jayapura" - | "Asia/Jerusalem" - | "Asia/Kabul" - | "Asia/Kamchatka" - | "Asia/Karachi" - | "Asia/Kashgar" - | "Asia/Kathmandu" - | "Asia/Katmandu" - | "Asia/Khandyga" - | "Asia/Kolkata" - | "Asia/Krasnoyarsk" - | "Asia/Kuala_Lumpur" - | "Asia/Kuching" - | "Asia/Kuwait" - | "Asia/Macao" - | "Asia/Macau" - | "Asia/Magadan" - | "Asia/Makassar" - | "Asia/Manila" - | "Asia/Muscat" - | "Asia/Nicosia" - | "Asia/Novokuznetsk" - | "Asia/Novosibirsk" - | "Asia/Omsk" - | "Asia/Oral" - | "Asia/Phnom_Penh" - | "Asia/Pontianak" - | "Asia/Pyongyang" - | "Asia/Qatar" - | "Asia/Qostanay" - | "Asia/Qyzylorda" - | "Asia/Rangoon" - | "Asia/Riyadh" - | "Asia/Saigon" - | "Asia/Sakhalin" - | "Asia/Samarkand" - | "Asia/Seoul" - | "Asia/Shanghai" - | "Asia/Singapore" - | "Asia/Srednekolymsk" - | "Asia/Taipei" - | "Asia/Tashkent" - | "Asia/Tbilisi" - | "Asia/Tehran" - | "Asia/Tel_Aviv" - | "Asia/Thimbu" - | "Asia/Thimphu" - | "Asia/Tokyo" - | "Asia/Tomsk" - | "Asia/Ujung_Pandang" - | "Asia/Ulaanbaatar" - | "Asia/Ulan_Bator" - | "Asia/Urumqi" - | "Asia/Ust-Nera" - | "Asia/Vientiane" - | "Asia/Vladivostok" - | "Asia/Yakutsk" - | "Asia/Yangon" - | "Asia/Yekaterinburg" - | "Asia/Yerevan" - | "Atlantic/Azores" - | "Atlantic/Bermuda" - | "Atlantic/Canary" - | "Atlantic/Cape_Verde" - | "Atlantic/Faeroe" - | "Atlantic/Faroe" - | "Atlantic/Jan_Mayen" - | "Atlantic/Madeira" - | "Atlantic/Reykjavik" - | "Atlantic/South_Georgia" - | "Atlantic/St_Helena" - | "Atlantic/Stanley" - | "Australia/ACT" - | "Australia/Adelaide" - | "Australia/Brisbane" - | "Australia/Broken_Hill" - | "Australia/Canberra" - | "Australia/Currie" - | "Australia/Darwin" - | "Australia/Eucla" - | "Australia/Hobart" - | "Australia/LHI" - | "Australia/Lindeman" - | "Australia/Lord_Howe" - | "Australia/Melbourne" - | "Australia/NSW" - | "Australia/North" - | "Australia/Perth" - | "Australia/Queensland" - | "Australia/South" - | "Australia/Sydney" - | "Australia/Tasmania" - | "Australia/Victoria" - | "Australia/West" - | "Australia/Yancowinna" - | "Brazil/Acre" - | "Brazil/DeNoronha" - | "Brazil/East" - | "Brazil/West" - | "CET" - | "CST6CDT" - | "Canada/Atlantic" - | "Canada/Central" - | "Canada/Eastern" - | "Canada/Mountain" - | "Canada/Newfoundland" - | "Canada/Pacific" - | "Canada/Saskatchewan" - | "Canada/Yukon" - | "Chile/Continental" - | "Chile/EasterIsland" - | "Cuba" - | "EET" - | "EST" - | "EST5EDT" - | "Egypt" - | "Eire" - | "Etc/GMT" - | "Etc/GMT+0" - | "Etc/GMT+1" - | "Etc/GMT+10" - | "Etc/GMT+11" - | "Etc/GMT+12" - | "Etc/GMT+2" - | "Etc/GMT+3" - | "Etc/GMT+4" - | "Etc/GMT+5" - | "Etc/GMT+6" - | "Etc/GMT+7" - | "Etc/GMT+8" - | "Etc/GMT+9" - | "Etc/GMT-0" - | "Etc/GMT-1" - | "Etc/GMT-10" - | "Etc/GMT-11" - | "Etc/GMT-12" - | "Etc/GMT-13" - | "Etc/GMT-14" - | "Etc/GMT-2" - | "Etc/GMT-3" - | "Etc/GMT-4" - | "Etc/GMT-5" - | "Etc/GMT-6" - | "Etc/GMT-7" - | "Etc/GMT-8" - | "Etc/GMT-9" - | "Etc/GMT0" - | "Etc/Greenwich" - | "Etc/UCT" - | "Etc/UTC" - | "Etc/Universal" - | "Etc/Zulu" - | "Europe/Amsterdam" - | "Europe/Andorra" - | "Europe/Astrakhan" - | "Europe/Athens" - | "Europe/Belfast" - | "Europe/Belgrade" - | "Europe/Berlin" - | "Europe/Bratislava" - | "Europe/Brussels" - | "Europe/Bucharest" - | "Europe/Budapest" - | "Europe/Busingen" - | "Europe/Chisinau" - | "Europe/Copenhagen" - | "Europe/Dublin" - | "Europe/Gibraltar" - | "Europe/Guernsey" - | "Europe/Helsinki" - | "Europe/Isle_of_Man" - | "Europe/Istanbul" - | "Europe/Jersey" - | "Europe/Kaliningrad" - | "Europe/Kiev" - | "Europe/Kirov" - | "Europe/Lisbon" - | "Europe/Ljubljana" - | "Europe/London" - | "Europe/Luxembourg" - | "Europe/Madrid" - | "Europe/Malta" - | "Europe/Mariehamn" - | "Europe/Minsk" - | "Europe/Monaco" - | "Europe/Moscow" - | "Europe/Nicosia" - | "Europe/Oslo" - | "Europe/Paris" - | "Europe/Podgorica" - | "Europe/Prague" - | "Europe/Riga" - | "Europe/Rome" - | "Europe/Samara" - | "Europe/San_Marino" - | "Europe/Sarajevo" - | "Europe/Saratov" - | "Europe/Simferopol" - | "Europe/Skopje" - | "Europe/Sofia" - | "Europe/Stockholm" - | "Europe/Tallinn" - | "Europe/Tirane" - | "Europe/Tiraspol" - | "Europe/Ulyanovsk" - | "Europe/Uzhgorod" - | "Europe/Vaduz" - | "Europe/Vatican" - | "Europe/Vienna" - | "Europe/Vilnius" - | "Europe/Volgograd" - | "Europe/Warsaw" - | "Europe/Zagreb" - | "Europe/Zaporozhye" - | "Europe/Zurich" - | "Factory" - | "GB" - | "GB-Eire" - | "GMT" - | "GMT+0" - | "GMT-0" - | "GMT0" - | "Greenwich" - | "HST" - | "Hongkong" - | "Iceland" - | "Indian/Antananarivo" - | "Indian/Chagos" - | "Indian/Christmas" - | "Indian/Cocos" - | "Indian/Comoro" - | "Indian/Kerguelen" - | "Indian/Mahe" - | "Indian/Maldives" - | "Indian/Mauritius" - | "Indian/Mayotte" - | "Indian/Reunion" - | "Iran" - | "Israel" - | "Jamaica" - | "Japan" - | "Kwajalein" - | "Libya" - | "MET" - | "MST" - | "MST7MDT" - | "Mexico/BajaNorte" - | "Mexico/BajaSur" - | "Mexico/General" - | "NZ" - | "NZ-CHAT" - | "Navajo" - | "PRC" - | "PST8PDT" - | "Pacific/Apia" - | "Pacific/Auckland" - | "Pacific/Bougainville" - | "Pacific/Chatham" - | "Pacific/Chuuk" - | "Pacific/Easter" - | "Pacific/Efate" - | "Pacific/Enderbury" - | "Pacific/Fakaofo" - | "Pacific/Fiji" - | "Pacific/Funafuti" - | "Pacific/Galapagos" - | "Pacific/Gambier" - | "Pacific/Guadalcanal" - | "Pacific/Guam" - | "Pacific/Honolulu" - | "Pacific/Johnston" - | "Pacific/Kiritimati" - | "Pacific/Kosrae" - | "Pacific/Kwajalein" - | "Pacific/Majuro" - | "Pacific/Marquesas" - | "Pacific/Midway" - | "Pacific/Nauru" - | "Pacific/Niue" - | "Pacific/Norfolk" - | "Pacific/Noumea" - | "Pacific/Pago_Pago" - | "Pacific/Palau" - | "Pacific/Pitcairn" - | "Pacific/Pohnpei" - | "Pacific/Ponape" - | "Pacific/Port_Moresby" - | "Pacific/Rarotonga" - | "Pacific/Saipan" - | "Pacific/Samoa" - | "Pacific/Tahiti" - | "Pacific/Tarawa" - | "Pacific/Tongatapu" - | "Pacific/Truk" - | "Pacific/Wake" - | "Pacific/Wallis" - | "Pacific/Yap" - | "Poland" - | "Portugal" - | "ROC" - | "ROK" - | "Singapore" - | "Turkey" - | "UCT" - | "US/Alaska" - | "US/Aleutian" - | "US/Arizona" - | "US/Central" - | "US/East-Indiana" - | "US/Eastern" - | "US/Hawaii" - | "US/Indiana-Starke" - | "US/Michigan" - | "US/Mountain" - | "US/Pacific" - | "US/Pacific-New" - | "US/Samoa" - | "UTC" - | "Universal" - | "W-SU" - | "WET" - | "Zulu"; - }; + | 'Africa/Abidjan' + | 'Africa/Accra' + | 'Africa/Addis_Ababa' + | 'Africa/Algiers' + | 'Africa/Asmara' + | 'Africa/Asmera' + | 'Africa/Bamako' + | 'Africa/Bangui' + | 'Africa/Banjul' + | 'Africa/Bissau' + | 'Africa/Blantyre' + | 'Africa/Brazzaville' + | 'Africa/Bujumbura' + | 'Africa/Cairo' + | 'Africa/Casablanca' + | 'Africa/Ceuta' + | 'Africa/Conakry' + | 'Africa/Dakar' + | 'Africa/Dar_es_Salaam' + | 'Africa/Djibouti' + | 'Africa/Douala' + | 'Africa/El_Aaiun' + | 'Africa/Freetown' + | 'Africa/Gaborone' + | 'Africa/Harare' + | 'Africa/Johannesburg' + | 'Africa/Juba' + | 'Africa/Kampala' + | 'Africa/Khartoum' + | 'Africa/Kigali' + | 'Africa/Kinshasa' + | 'Africa/Lagos' + | 'Africa/Libreville' + | 'Africa/Lome' + | 'Africa/Luanda' + | 'Africa/Lubumbashi' + | 'Africa/Lusaka' + | 'Africa/Malabo' + | 'Africa/Maputo' + | 'Africa/Maseru' + | 'Africa/Mbabane' + | 'Africa/Mogadishu' + | 'Africa/Monrovia' + | 'Africa/Nairobi' + | 'Africa/Ndjamena' + | 'Africa/Niamey' + | 'Africa/Nouakchott' + | 'Africa/Ouagadougou' + | 'Africa/Porto-Novo' + | 'Africa/Sao_Tome' + | 'Africa/Timbuktu' + | 'Africa/Tripoli' + | 'Africa/Tunis' + | 'Africa/Windhoek' + | 'America/Adak' + | 'America/Anchorage' + | 'America/Anguilla' + | 'America/Antigua' + | 'America/Araguaina' + | 'America/Argentina/Buenos_Aires' + | 'America/Argentina/Catamarca' + | 'America/Argentina/ComodRivadavia' + | 'America/Argentina/Cordoba' + | 'America/Argentina/Jujuy' + | 'America/Argentina/La_Rioja' + | 'America/Argentina/Mendoza' + | 'America/Argentina/Rio_Gallegos' + | 'America/Argentina/Salta' + | 'America/Argentina/San_Juan' + | 'America/Argentina/San_Luis' + | 'America/Argentina/Tucuman' + | 'America/Argentina/Ushuaia' + | 'America/Aruba' + | 'America/Asuncion' + | 'America/Atikokan' + | 'America/Atka' + | 'America/Bahia' + | 'America/Bahia_Banderas' + | 'America/Barbados' + | 'America/Belem' + | 'America/Belize' + | 'America/Blanc-Sablon' + | 'America/Boa_Vista' + | 'America/Bogota' + | 'America/Boise' + | 'America/Buenos_Aires' + | 'America/Cambridge_Bay' + | 'America/Campo_Grande' + | 'America/Cancun' + | 'America/Caracas' + | 'America/Catamarca' + | 'America/Cayenne' + | 'America/Cayman' + | 'America/Chicago' + | 'America/Chihuahua' + | 'America/Coral_Harbour' + | 'America/Cordoba' + | 'America/Costa_Rica' + | 'America/Creston' + | 'America/Cuiaba' + | 'America/Curacao' + | 'America/Danmarkshavn' + | 'America/Dawson' + | 'America/Dawson_Creek' + | 'America/Denver' + | 'America/Detroit' + | 'America/Dominica' + | 'America/Edmonton' + | 'America/Eirunepe' + | 'America/El_Salvador' + | 'America/Ensenada' + | 'America/Fort_Nelson' + | 'America/Fort_Wayne' + | 'America/Fortaleza' + | 'America/Glace_Bay' + | 'America/Godthab' + | 'America/Goose_Bay' + | 'America/Grand_Turk' + | 'America/Grenada' + | 'America/Guadeloupe' + | 'America/Guatemala' + | 'America/Guayaquil' + | 'America/Guyana' + | 'America/Halifax' + | 'America/Havana' + | 'America/Hermosillo' + | 'America/Indiana/Indianapolis' + | 'America/Indiana/Knox' + | 'America/Indiana/Marengo' + | 'America/Indiana/Petersburg' + | 'America/Indiana/Tell_City' + | 'America/Indiana/Vevay' + | 'America/Indiana/Vincennes' + | 'America/Indiana/Winamac' + | 'America/Indianapolis' + | 'America/Inuvik' + | 'America/Iqaluit' + | 'America/Jamaica' + | 'America/Jujuy' + | 'America/Juneau' + | 'America/Kentucky/Louisville' + | 'America/Kentucky/Monticello' + | 'America/Knox_IN' + | 'America/Kralendijk' + | 'America/La_Paz' + | 'America/Lima' + | 'America/Los_Angeles' + | 'America/Louisville' + | 'America/Lower_Princes' + | 'America/Maceio' + | 'America/Managua' + | 'America/Manaus' + | 'America/Marigot' + | 'America/Martinique' + | 'America/Matamoros' + | 'America/Mazatlan' + | 'America/Mendoza' + | 'America/Menominee' + | 'America/Merida' + | 'America/Metlakatla' + | 'America/Mexico_City' + | 'America/Miquelon' + | 'America/Moncton' + | 'America/Monterrey' + | 'America/Montevideo' + | 'America/Montreal' + | 'America/Montserrat' + | 'America/Nassau' + | 'America/New_York' + | 'America/Nipigon' + | 'America/Nome' + | 'America/Noronha' + | 'America/North_Dakota/Beulah' + | 'America/North_Dakota/Center' + | 'America/North_Dakota/New_Salem' + | 'America/Ojinaga' + | 'America/Panama' + | 'America/Pangnirtung' + | 'America/Paramaribo' + | 'America/Phoenix' + | 'America/Port-au-Prince' + | 'America/Port_of_Spain' + | 'America/Porto_Acre' + | 'America/Porto_Velho' + | 'America/Puerto_Rico' + | 'America/Punta_Arenas' + | 'America/Rainy_River' + | 'America/Rankin_Inlet' + | 'America/Recife' + | 'America/Regina' + | 'America/Resolute' + | 'America/Rio_Branco' + | 'America/Rosario' + | 'America/Santa_Isabel' + | 'America/Santarem' + | 'America/Santiago' + | 'America/Santo_Domingo' + | 'America/Sao_Paulo' + | 'America/Scoresbysund' + | 'America/Shiprock' + | 'America/Sitka' + | 'America/St_Barthelemy' + | 'America/St_Johns' + | 'America/St_Kitts' + | 'America/St_Lucia' + | 'America/St_Thomas' + | 'America/St_Vincent' + | 'America/Swift_Current' + | 'America/Tegucigalpa' + | 'America/Thule' + | 'America/Thunder_Bay' + | 'America/Tijuana' + | 'America/Toronto' + | 'America/Tortola' + | 'America/Vancouver' + | 'America/Virgin' + | 'America/Whitehorse' + | 'America/Winnipeg' + | 'America/Yakutat' + | 'America/Yellowknife' + | 'Antarctica/Casey' + | 'Antarctica/Davis' + | 'Antarctica/DumontDUrville' + | 'Antarctica/Macquarie' + | 'Antarctica/Mawson' + | 'Antarctica/McMurdo' + | 'Antarctica/Palmer' + | 'Antarctica/Rothera' + | 'Antarctica/South_Pole' + | 'Antarctica/Syowa' + | 'Antarctica/Troll' + | 'Antarctica/Vostok' + | 'Arctic/Longyearbyen' + | 'Asia/Aden' + | 'Asia/Almaty' + | 'Asia/Amman' + | 'Asia/Anadyr' + | 'Asia/Aqtau' + | 'Asia/Aqtobe' + | 'Asia/Ashgabat' + | 'Asia/Ashkhabad' + | 'Asia/Atyrau' + | 'Asia/Baghdad' + | 'Asia/Bahrain' + | 'Asia/Baku' + | 'Asia/Bangkok' + | 'Asia/Barnaul' + | 'Asia/Beirut' + | 'Asia/Bishkek' + | 'Asia/Brunei' + | 'Asia/Calcutta' + | 'Asia/Chita' + | 'Asia/Choibalsan' + | 'Asia/Chongqing' + | 'Asia/Chungking' + | 'Asia/Colombo' + | 'Asia/Dacca' + | 'Asia/Damascus' + | 'Asia/Dhaka' + | 'Asia/Dili' + | 'Asia/Dubai' + | 'Asia/Dushanbe' + | 'Asia/Famagusta' + | 'Asia/Gaza' + | 'Asia/Harbin' + | 'Asia/Hebron' + | 'Asia/Ho_Chi_Minh' + | 'Asia/Hong_Kong' + | 'Asia/Hovd' + | 'Asia/Irkutsk' + | 'Asia/Istanbul' + | 'Asia/Jakarta' + | 'Asia/Jayapura' + | 'Asia/Jerusalem' + | 'Asia/Kabul' + | 'Asia/Kamchatka' + | 'Asia/Karachi' + | 'Asia/Kashgar' + | 'Asia/Kathmandu' + | 'Asia/Katmandu' + | 'Asia/Khandyga' + | 'Asia/Kolkata' + | 'Asia/Krasnoyarsk' + | 'Asia/Kuala_Lumpur' + | 'Asia/Kuching' + | 'Asia/Kuwait' + | 'Asia/Macao' + | 'Asia/Macau' + | 'Asia/Magadan' + | 'Asia/Makassar' + | 'Asia/Manila' + | 'Asia/Muscat' + | 'Asia/Nicosia' + | 'Asia/Novokuznetsk' + | 'Asia/Novosibirsk' + | 'Asia/Omsk' + | 'Asia/Oral' + | 'Asia/Phnom_Penh' + | 'Asia/Pontianak' + | 'Asia/Pyongyang' + | 'Asia/Qatar' + | 'Asia/Qostanay' + | 'Asia/Qyzylorda' + | 'Asia/Rangoon' + | 'Asia/Riyadh' + | 'Asia/Saigon' + | 'Asia/Sakhalin' + | 'Asia/Samarkand' + | 'Asia/Seoul' + | 'Asia/Shanghai' + | 'Asia/Singapore' + | 'Asia/Srednekolymsk' + | 'Asia/Taipei' + | 'Asia/Tashkent' + | 'Asia/Tbilisi' + | 'Asia/Tehran' + | 'Asia/Tel_Aviv' + | 'Asia/Thimbu' + | 'Asia/Thimphu' + | 'Asia/Tokyo' + | 'Asia/Tomsk' + | 'Asia/Ujung_Pandang' + | 'Asia/Ulaanbaatar' + | 'Asia/Ulan_Bator' + | 'Asia/Urumqi' + | 'Asia/Ust-Nera' + | 'Asia/Vientiane' + | 'Asia/Vladivostok' + | 'Asia/Yakutsk' + | 'Asia/Yangon' + | 'Asia/Yekaterinburg' + | 'Asia/Yerevan' + | 'Atlantic/Azores' + | 'Atlantic/Bermuda' + | 'Atlantic/Canary' + | 'Atlantic/Cape_Verde' + | 'Atlantic/Faeroe' + | 'Atlantic/Faroe' + | 'Atlantic/Jan_Mayen' + | 'Atlantic/Madeira' + | 'Atlantic/Reykjavik' + | 'Atlantic/South_Georgia' + | 'Atlantic/St_Helena' + | 'Atlantic/Stanley' + | 'Australia/ACT' + | 'Australia/Adelaide' + | 'Australia/Brisbane' + | 'Australia/Broken_Hill' + | 'Australia/Canberra' + | 'Australia/Currie' + | 'Australia/Darwin' + | 'Australia/Eucla' + | 'Australia/Hobart' + | 'Australia/LHI' + | 'Australia/Lindeman' + | 'Australia/Lord_Howe' + | 'Australia/Melbourne' + | 'Australia/NSW' + | 'Australia/North' + | 'Australia/Perth' + | 'Australia/Queensland' + | 'Australia/South' + | 'Australia/Sydney' + | 'Australia/Tasmania' + | 'Australia/Victoria' + | 'Australia/West' + | 'Australia/Yancowinna' + | 'Brazil/Acre' + | 'Brazil/DeNoronha' + | 'Brazil/East' + | 'Brazil/West' + | 'CET' + | 'CST6CDT' + | 'Canada/Atlantic' + | 'Canada/Central' + | 'Canada/Eastern' + | 'Canada/Mountain' + | 'Canada/Newfoundland' + | 'Canada/Pacific' + | 'Canada/Saskatchewan' + | 'Canada/Yukon' + | 'Chile/Continental' + | 'Chile/EasterIsland' + | 'Cuba' + | 'EET' + | 'EST' + | 'EST5EDT' + | 'Egypt' + | 'Eire' + | 'Etc/GMT' + | 'Etc/GMT+0' + | 'Etc/GMT+1' + | 'Etc/GMT+10' + | 'Etc/GMT+11' + | 'Etc/GMT+12' + | 'Etc/GMT+2' + | 'Etc/GMT+3' + | 'Etc/GMT+4' + | 'Etc/GMT+5' + | 'Etc/GMT+6' + | 'Etc/GMT+7' + | 'Etc/GMT+8' + | 'Etc/GMT+9' + | 'Etc/GMT-0' + | 'Etc/GMT-1' + | 'Etc/GMT-10' + | 'Etc/GMT-11' + | 'Etc/GMT-12' + | 'Etc/GMT-13' + | 'Etc/GMT-14' + | 'Etc/GMT-2' + | 'Etc/GMT-3' + | 'Etc/GMT-4' + | 'Etc/GMT-5' + | 'Etc/GMT-6' + | 'Etc/GMT-7' + | 'Etc/GMT-8' + | 'Etc/GMT-9' + | 'Etc/GMT0' + | 'Etc/Greenwich' + | 'Etc/UCT' + | 'Etc/UTC' + | 'Etc/Universal' + | 'Etc/Zulu' + | 'Europe/Amsterdam' + | 'Europe/Andorra' + | 'Europe/Astrakhan' + | 'Europe/Athens' + | 'Europe/Belfast' + | 'Europe/Belgrade' + | 'Europe/Berlin' + | 'Europe/Bratislava' + | 'Europe/Brussels' + | 'Europe/Bucharest' + | 'Europe/Budapest' + | 'Europe/Busingen' + | 'Europe/Chisinau' + | 'Europe/Copenhagen' + | 'Europe/Dublin' + | 'Europe/Gibraltar' + | 'Europe/Guernsey' + | 'Europe/Helsinki' + | 'Europe/Isle_of_Man' + | 'Europe/Istanbul' + | 'Europe/Jersey' + | 'Europe/Kaliningrad' + | 'Europe/Kiev' + | 'Europe/Kirov' + | 'Europe/Lisbon' + | 'Europe/Ljubljana' + | 'Europe/London' + | 'Europe/Luxembourg' + | 'Europe/Madrid' + | 'Europe/Malta' + | 'Europe/Mariehamn' + | 'Europe/Minsk' + | 'Europe/Monaco' + | 'Europe/Moscow' + | 'Europe/Nicosia' + | 'Europe/Oslo' + | 'Europe/Paris' + | 'Europe/Podgorica' + | 'Europe/Prague' + | 'Europe/Riga' + | 'Europe/Rome' + | 'Europe/Samara' + | 'Europe/San_Marino' + | 'Europe/Sarajevo' + | 'Europe/Saratov' + | 'Europe/Simferopol' + | 'Europe/Skopje' + | 'Europe/Sofia' + | 'Europe/Stockholm' + | 'Europe/Tallinn' + | 'Europe/Tirane' + | 'Europe/Tiraspol' + | 'Europe/Ulyanovsk' + | 'Europe/Uzhgorod' + | 'Europe/Vaduz' + | 'Europe/Vatican' + | 'Europe/Vienna' + | 'Europe/Vilnius' + | 'Europe/Volgograd' + | 'Europe/Warsaw' + | 'Europe/Zagreb' + | 'Europe/Zaporozhye' + | 'Europe/Zurich' + | 'Factory' + | 'GB' + | 'GB-Eire' + | 'GMT' + | 'GMT+0' + | 'GMT-0' + | 'GMT0' + | 'Greenwich' + | 'HST' + | 'Hongkong' + | 'Iceland' + | 'Indian/Antananarivo' + | 'Indian/Chagos' + | 'Indian/Christmas' + | 'Indian/Cocos' + | 'Indian/Comoro' + | 'Indian/Kerguelen' + | 'Indian/Mahe' + | 'Indian/Maldives' + | 'Indian/Mauritius' + | 'Indian/Mayotte' + | 'Indian/Reunion' + | 'Iran' + | 'Israel' + | 'Jamaica' + | 'Japan' + | 'Kwajalein' + | 'Libya' + | 'MET' + | 'MST' + | 'MST7MDT' + | 'Mexico/BajaNorte' + | 'Mexico/BajaSur' + | 'Mexico/General' + | 'NZ' + | 'NZ-CHAT' + | 'Navajo' + | 'PRC' + | 'PST8PDT' + | 'Pacific/Apia' + | 'Pacific/Auckland' + | 'Pacific/Bougainville' + | 'Pacific/Chatham' + | 'Pacific/Chuuk' + | 'Pacific/Easter' + | 'Pacific/Efate' + | 'Pacific/Enderbury' + | 'Pacific/Fakaofo' + | 'Pacific/Fiji' + | 'Pacific/Funafuti' + | 'Pacific/Galapagos' + | 'Pacific/Gambier' + | 'Pacific/Guadalcanal' + | 'Pacific/Guam' + | 'Pacific/Honolulu' + | 'Pacific/Johnston' + | 'Pacific/Kiritimati' + | 'Pacific/Kosrae' + | 'Pacific/Kwajalein' + | 'Pacific/Majuro' + | 'Pacific/Marquesas' + | 'Pacific/Midway' + | 'Pacific/Nauru' + | 'Pacific/Niue' + | 'Pacific/Norfolk' + | 'Pacific/Noumea' + | 'Pacific/Pago_Pago' + | 'Pacific/Palau' + | 'Pacific/Pitcairn' + | 'Pacific/Pohnpei' + | 'Pacific/Ponape' + | 'Pacific/Port_Moresby' + | 'Pacific/Rarotonga' + | 'Pacific/Saipan' + | 'Pacific/Samoa' + | 'Pacific/Tahiti' + | 'Pacific/Tarawa' + | 'Pacific/Tongatapu' + | 'Pacific/Truk' + | 'Pacific/Wake' + | 'Pacific/Wallis' + | 'Pacific/Yap' + | 'Poland' + | 'Portugal' + | 'ROC' + | 'ROK' + | 'Singapore' + | 'Turkey' + | 'UCT' + | 'US/Alaska' + | 'US/Aleutian' + | 'US/Arizona' + | 'US/Central' + | 'US/East-Indiana' + | 'US/Eastern' + | 'US/Hawaii' + | 'US/Indiana-Starke' + | 'US/Michigan' + | 'US/Mountain' + | 'US/Pacific' + | 'US/Pacific-New' + | 'US/Samoa' + | 'UTC' + | 'Universal' + | 'W-SU' + | 'WET' + | 'Zulu' + } /** @description The ID of the [report type](https://stripe.com/docs/reporting/statements/api#report-types) to run, such as `"balance.summary.1"`. */ - report_type: string; - }; - }; - }; + report_type: string + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["reporting.report_run"]; - }; + schema: definitions['reporting.report_run'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves the details of an existing Report Run. (Requires a live-mode API key.)

*/ GetReportingReportRunsReportRun: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - report_run: string; - }; - }; + report_run: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["reporting.report_run"]; - }; + schema: definitions['reporting.report_run'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Returns a full list of Report Types. (Requires a live-mode API key.)

*/ GetReportingReportTypes: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; - }; + expand?: unknown[] + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["reporting.report_type"][]; + data: definitions['reporting.report_type'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves the details of a Report Type. (Requires a live-mode API key.)

*/ GetReportingReportTypesReportType: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - report_type: string; - }; - }; + report_type: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["reporting.report_type"]; - }; + schema: definitions['reporting.report_type'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ GetReviews: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - created?: number; + expand?: unknown[] + created?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["review"][]; + data: definitions['review'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves a Review object.

*/ GetReviewsReview: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - review: string; - }; - }; + review: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["review"]; - }; + schema: definitions['review'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ PostReviewsReviewApprove: { parameters: { path: { - review: string; - }; + review: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; + expand?: string[] + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["review"]; - }; + schema: definitions['review'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Returns a list of SetupIntents.

*/ GetSetupIntents: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** 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?: number; + created?: number /** Only return SetupIntents for the customer specified by this customer ID. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return SetupIntents associated with the specified payment method. */ - payment_method?: string; + payment_method?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["setup_intent"][]; + data: definitions['setup_intent'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

Creates a SetupIntent object.

* @@ -26010,17 +25942,17 @@ export interface operations { /** Body parameters for the request. */ payload?: { /** @description Set to `true` to attempt to confirm this SetupIntent immediately. This parameter defaults to `false`. If the payment method attached is a card, a return_url may be provided in case additional authentication is required. */ - confirm?: boolean; + confirm?: boolean /** * @description ID of the Customer this SetupIntent belongs to, if one exists. * * If 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. */ - customer?: string; + customer?: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * secret_key_param * @description This hash contains details about the Mandate to create. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm). @@ -26028,24 +25960,24 @@ export interface operations { mandate_data?: { /** customer_acceptance_param */ customer_acceptance: { - accepted_at?: number; + accepted_at?: number /** offline_param */ - offline?: { [key: string]: unknown }; + offline?: { [key: string]: unknown } /** online_param */ online?: { - ip_address: string; - user_agent: string; - }; + ip_address: string + user_agent: string + } /** @enum {string} */ - type: "offline" | "online"; - }; - }; + type: 'offline' | 'online' + } + } /** @description 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. 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?: { [key: string]: unknown }; + metadata?: { [key: string]: unknown } /** @description The Stripe account ID for which this SetupIntent is created. */ - on_behalf_of?: string; + on_behalf_of?: string /** @description ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. */ - payment_method?: string; + payment_method?: string /** * payment_method_options_param * @description Payment-method-specific configuration for this SetupIntent. @@ -26054,40 +25986,40 @@ export interface operations { /** setup_intent_param */ card?: { /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; - }; - }; + request_three_d_secure?: 'any' | 'automatic' + } + } /** @description The list of payment method types (e.g. card) that this SetupIntent is allowed to use. If this is not provided, defaults to ["card"]. */ - payment_method_types?: string[]; + payment_method_types?: string[] /** @description The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm). */ - return_url?: string; + return_url?: string /** * setup_intent_single_use_params * @description If this hash is populated, this SetupIntent will generate a single_use Mandate on success. */ single_use?: { - amount: number; - currency: string; - }; + amount: number + currency: string + } /** * @description Indicates how the payment method is intended to be used in the future. If not provided, this value defaults to `off_session`. * @enum {string} */ - usage?: "off_session" | "on_session"; - }; - }; - }; + usage?: 'off_session' | 'on_session' + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["setup_intent"]; - }; + schema: definitions['setup_intent'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

Retrieves the details of a SetupIntent that has previously been created.

* @@ -26099,31 +26031,31 @@ export interface operations { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** The client secret of the SetupIntent. Required if a publishable key is used to retrieve the SetupIntent. */ - client_secret?: string; - }; + client_secret?: string + } path: { - intent: string; - }; - }; + intent: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["setup_intent"]; - }; + schema: definitions['setup_intent'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Updates a SetupIntent object.

*/ PostSetupIntentsIntent: { parameters: { path: { - intent: string; - }; + intent: string + } body: { /** Body parameters for the request. */ payload?: { @@ -26132,15 +26064,15 @@ export interface operations { * * If 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. */ - customer?: string; + customer?: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: unknown; + metadata?: unknown /** @description ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. */ - payment_method?: string; + payment_method?: string /** * payment_method_options_param * @description Payment-method-specific configuration for this SetupIntent. @@ -26149,25 +26081,25 @@ export interface operations { /** setup_intent_param */ card?: { /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; - }; - }; + request_three_d_secure?: 'any' | 'automatic' + } + } /** @description The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. If this is not provided, defaults to ["card"]. */ - payment_method_types?: string[]; - }; - }; - }; + payment_method_types?: string[] + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["setup_intent"]; - }; + schema: definitions['setup_intent'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

A SetupIntent object can be canceled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action.

* @@ -26176,8 +26108,8 @@ export interface operations { PostSetupIntentsIntentCancel: { parameters: { path: { - intent: string; - }; + intent: string + } body: { /** Body parameters for the request. */ payload?: { @@ -26185,23 +26117,23 @@ export interface operations { * @description Reason for canceling this SetupIntent. Possible values are `abandoned`, `requested_by_customer`, or `duplicate` * @enum {string} */ - cancellation_reason?: "abandoned" | "duplicate" | "requested_by_customer"; + cancellation_reason?: 'abandoned' | 'duplicate' | 'requested_by_customer' /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; + expand?: string[] + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["setup_intent"]; - }; + schema: definitions['setup_intent'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

Confirm that your customer intends to set up the current or * provided payment method. For example, you would confirm a SetupIntent @@ -26220,15 +26152,15 @@ export interface operations { PostSetupIntentsIntentConfirm: { parameters: { path: { - intent: string; - }; + intent: string + } body: { /** Body parameters for the request. */ payload?: { /** @description The client secret of the SetupIntent. */ - client_secret?: string; + client_secret?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * secret_key_param * @description This hash contains details about the Mandate to create @@ -26236,20 +26168,20 @@ export interface operations { mandate_data?: { /** customer_acceptance_param */ customer_acceptance: { - accepted_at?: number; + accepted_at?: number /** offline_param */ - offline?: { [key: string]: unknown }; + offline?: { [key: string]: unknown } /** online_param */ online?: { - ip_address: string; - user_agent: string; - }; + ip_address: string + user_agent: string + } /** @enum {string} */ - type: "offline" | "online"; - }; - }; + type: 'offline' | 'online' + } + } /** @description ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. */ - payment_method?: string; + payment_method?: string /** * payment_method_options_param * @description Payment-method-specific configuration for this SetupIntent. @@ -26258,133 +26190,133 @@ export interface operations { /** setup_intent_param */ card?: { /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; - }; - }; + request_three_d_secure?: 'any' | 'automatic' + } + } /** * @description The URL to redirect your customer back to after they authenticate on the payment method's app or site. * If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. * This parameter is only used for cards and other redirect-based payment methods. */ - return_url?: string; - }; - }; - }; + return_url?: string + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["setup_intent"]; - }; + schema: definitions['setup_intent'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Returns a list of scheduled query runs.

*/ GetSigmaScheduledQueryRuns: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["scheduled_query_run"][]; + data: definitions['scheduled_query_run'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves the details of an scheduled query run.

*/ GetSigmaScheduledQueryRunsScheduledQueryRun: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - scheduled_query_run: string; - }; - }; + scheduled_query_run: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["scheduled_query_run"]; - }; + schema: definitions['scheduled_query_run'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ GetSkus: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** Only return SKUs that are active or inactive (e.g., pass `false` to list all inactive products). */ - active?: boolean; + active?: boolean /** Only return SKUs that have the specified key-value pairs in this partially constructed dictionary. Can be specified only if `product` is also supplied. For instance, if the associated product has attributes `["color", "size"]`, passing in `attributes[color]=red` returns all the SKUs for this product that have `color` set to `red`. */ - attributes?: string; + attributes?: 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. */ - ending_before?: string; + ending_before?: string /** Only return SKUs with the given IDs. */ - ids?: unknown[]; + ids?: unknown[] /** Only return SKUs that are either in stock or out of stock (e.g., pass `false` to list all SKUs that are out of stock). If no value is provided, all SKUs are returned. */ - in_stock?: boolean; + in_stock?: boolean /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** The ID of the product whose SKUs will be retrieved. Must be a product with type `good`. */ - product?: string; + product?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["sku"][]; + data: definitions['sku'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Creates a new SKU associated with a product.

*/ PostSkus: { parameters: { @@ -26392,80 +26324,80 @@ export interface operations { /** Body parameters for the request. */ payload: { /** @description Whether the SKU is available for purchase. Default to `true`. */ - active?: boolean; + active?: boolean /** @description A dictionary of attributes and values for the attributes defined by the product. If, for example, a product's attributes are `["size", "gender"]`, a valid SKU has the following dictionary of attributes: `{"size": "Medium", "gender": "Unisex"}`. */ - attributes?: { [key: string]: unknown }; + attributes?: { [key: string]: unknown } /** @description 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: string; + currency: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The identifier for the SKU. Must be unique. If not provided, an identifier will be randomly generated. */ - id?: string; + id?: string /** @description The URL of an image for this SKU, meant to be displayable to the customer. */ - image?: string; + image?: string /** * inventory_specs * @description Description of the SKU's inventory. */ inventory: { - quantity?: number; + quantity?: number /** @enum {string} */ - type?: "bucket" | "finite" | "infinite"; + type?: 'bucket' | 'finite' | 'infinite' /** @enum {string} */ - value?: "" | "in_stock" | "limited" | "out_of_stock"; - }; + value?: '' | 'in_stock' | 'limited' | 'out_of_stock' + } /** @description 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. 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?: { [key: string]: unknown }; + metadata?: { [key: string]: unknown } /** * package_dimensions_specs * @description The dimensions of this SKU for shipping purposes. */ package_dimensions?: { - height: number; - length: number; - weight: number; - width: number; - }; + height: number + length: number + weight: number + width: number + } /** @description The cost of the item as a nonnegative integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a zero-decimal currency). */ - price: number; + price: number /** @description The ID of the product this SKU is associated with. Must be a product with type `good`. */ - product: string; - }; - }; - }; + product: string + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["sku"]; - }; + schema: definitions['sku'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ GetSkusId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["deleted_sku"]; - }; + schema: definitions['deleted_sku'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

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

* @@ -26474,72 +26406,72 @@ export interface operations { PostSkusId: { parameters: { path: { - id: string; - }; + id: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Whether this SKU is available for purchase. */ - active?: boolean; + active?: boolean /** @description A dictionary of attributes and values for the attributes defined by the product. When specified, `attributes` will partially update the existing attributes dictionary on the product, with the postcondition that a value must be present for each attribute key on the product. */ - attributes?: { [key: string]: unknown }; + attributes?: { [key: string]: unknown } /** @description 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?: string; + currency?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The URL of an image for this SKU, meant to be displayable to the customer. */ - image?: string; + image?: string /** * inventory_update_specs * @description Description of the SKU's inventory. */ inventory?: { - quantity?: number; + quantity?: number /** @enum {string} */ - type?: "bucket" | "finite" | "infinite"; + type?: 'bucket' | 'finite' | 'infinite' /** @enum {string} */ - value?: "" | "in_stock" | "limited" | "out_of_stock"; - }; + value?: '' | 'in_stock' | 'limited' | 'out_of_stock' + } /** @description 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. 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?: unknown; + metadata?: unknown /** @description The dimensions of this SKU for shipping purposes. */ - package_dimensions?: unknown; + package_dimensions?: unknown /** @description The cost of the item as a positive integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a zero-decimal currency). */ - price?: number; + price?: number /** @description The ID of the product that this SKU should belong to. The product must exist, have the same set of attribute names as the SKU's current product, and be of type `good`. */ - product?: string; - }; - }; - }; + product?: string + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["sku"]; - }; + schema: definitions['sku'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Delete a SKU. Deleting a SKU is only possible until it has been used in an order.

*/ DeleteSkusId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["deleted_sku"]; - }; + schema: definitions['deleted_sku'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Creates a new source object.

*/ PostSources: { parameters: { @@ -26547,18 +26479,18 @@ export interface operations { /** Body parameters for the request. */ payload?: { /** @description Amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources. Not supported for `receiver` type sources, where charge amount may not be specified until funds land. */ - amount?: number; + amount?: number /** @description 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. */ - currency?: string; + currency?: string /** @description The `Customer` to whom the original source is attached to. Must be set when the original source is not a `Source` (e.g., `Card`). */ - customer?: string; + customer?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * @description The authentication `flow` of the source to create. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`. It is generally inferred unless a type supports multiple flows. * @enum {string} */ - flow?: "code_verification" | "none" | "receiver" | "redirect"; + flow?: 'code_verification' | 'none' | 'receiver' | 'redirect' /** * mandate_params * @description Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status. @@ -26566,35 +26498,35 @@ export interface operations { mandate?: { /** mandate_acceptance_params */ acceptance?: { - date?: number; - ip?: string; + date?: number + ip?: string /** mandate_offline_acceptance_params */ offline?: { - contact_email: string; - }; + contact_email: string + } /** mandate_online_acceptance_params */ online?: { - date?: number; - ip?: string; - user_agent?: string; - }; + date?: number + ip?: string + user_agent?: string + } /** @enum {string} */ - status: "accepted" | "pending" | "refused" | "revoked"; + status: 'accepted' | 'pending' | 'refused' | 'revoked' /** @enum {string} */ - type?: "offline" | "online"; - user_agent?: string; - }; - amount?: unknown; - currency?: string; + type?: 'offline' | 'online' + user_agent?: string + } + amount?: unknown + currency?: string /** @enum {string} */ - interval?: "one_time" | "scheduled" | "variable"; + interval?: 'one_time' | 'scheduled' | 'variable' /** @enum {string} */ - notification_method?: "deprecated_none" | "email" | "manual" | "none" | "stripe_email"; - }; + notification_method?: 'deprecated_none' | 'email' | 'manual' | 'none' | 'stripe_email' + } /** @description 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. 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?: { [key: string]: unknown }; + metadata?: { [key: string]: unknown } /** @description The source to share. */ - original_source?: string; + original_source?: string /** * owner * @description Information about the owner of the payment instrument that may be used or required by particular source types. @@ -26602,112 +26534,112 @@ export interface operations { owner?: { /** source_address */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - email?: string; - name?: string; - phone?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + email?: string + name?: string + phone?: string + } /** * receiver_params * @description Optional parameters for the receiver flow. Can be set only if the source is a receiver (`flow` is `receiver`). */ receiver?: { /** @enum {string} */ - refund_attributes_method?: "email" | "manual" | "none"; - }; + refund_attributes_method?: 'email' | 'manual' | 'none' + } /** * redirect_params * @description Parameters required for the redirect flow. Required if the source is authenticated by a redirect (`flow` is `redirect`). */ redirect?: { - return_url: string; - }; + return_url: string + } /** * shallow_order_specs * @description Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it. */ source_order?: { items?: { - amount?: number; - currency?: string; - description?: string; - parent?: string; - quantity?: number; + amount?: number + currency?: string + description?: string + parent?: string + quantity?: number /** @enum {string} */ - type?: "discount" | "shipping" | "sku" | "tax"; - }[]; + type?: 'discount' | 'shipping' | 'sku' | 'tax' + }[] /** order_shipping */ shipping?: { /** address */ address: { - city?: string; - country?: string; - line1: string; - line2?: string; - postal_code?: string; - state?: string; - }; - carrier?: string; - name?: string; - phone?: string; - tracking_number?: string; - }; - }; + city?: string + country?: string + line1: string + line2?: string + postal_code?: string + state?: string + } + carrier?: string + name?: string + phone?: string + tracking_number?: string + } + } /** @description An arbitrary string to be displayed on your customer's statement. As an example, if your website is `RunClub` and the item you're charging for is a race ticket, you may want to specify a `statement_descriptor` of `RunClub 5K race ticket.` While many payment types will display this information, some may not display it at all. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description An optional token used to create the source. When passed, token properties will override source parameters. */ - token?: string; + token?: string /** @description The `type` of the source to create. Required unless `customer` and `original_source` are specified (see the [Cloning card Sources](https://stripe.com/docs/sources/connect#cloning-card-sources) guide) */ - type?: string; + type?: string /** * @description 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. * @enum {string} */ - usage?: "reusable" | "single_use"; - }; - }; - }; + usage?: 'reusable' | 'single_use' + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["source"]; - }; + schema: definitions['source'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ GetSourcesSource: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** The client secret of the source. Required if a publishable key is used to retrieve the source. */ - client_secret?: string; - }; + client_secret?: string + } path: { - source: string; - }; - }; + source: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["source"]; - }; + schema: definitions['source'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

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

* @@ -26716,15 +26648,15 @@ export interface operations { PostSourcesSource: { parameters: { path: { - source: string; - }; + source: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Amount associated with the source. */ - amount?: number; + amount?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * mandate_params * @description Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status. @@ -26732,33 +26664,33 @@ export interface operations { mandate?: { /** mandate_acceptance_params */ acceptance?: { - date?: number; - ip?: string; + date?: number + ip?: string /** mandate_offline_acceptance_params */ offline?: { - contact_email: string; - }; + contact_email: string + } /** mandate_online_acceptance_params */ online?: { - date?: number; - ip?: string; - user_agent?: string; - }; + date?: number + ip?: string + user_agent?: string + } /** @enum {string} */ - status: "accepted" | "pending" | "refused" | "revoked"; + status: 'accepted' | 'pending' | 'refused' | 'revoked' /** @enum {string} */ - type?: "offline" | "online"; - user_agent?: string; - }; - amount?: unknown; - currency?: string; + type?: 'offline' | 'online' + user_agent?: string + } + amount?: unknown + currency?: string /** @enum {string} */ - interval?: "one_time" | "scheduled" | "variable"; + interval?: 'one_time' | 'scheduled' | 'variable' /** @enum {string} */ - notification_method?: "deprecated_none" | "email" | "manual" | "none" | "stripe_email"; - }; + notification_method?: 'deprecated_none' | 'email' | 'manual' | 'none' | 'stripe_email' + } /** @description 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. 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?: unknown; + metadata?: unknown /** * owner * @description Information about the owner of the payment instrument that may be used or required by particular source types. @@ -26766,212 +26698,212 @@ export interface operations { owner?: { /** source_address */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - email?: string; - name?: string; - phone?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + email?: string + name?: string + phone?: string + } /** * order_params * @description Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it. */ source_order?: { items?: { - amount?: number; - currency?: string; - description?: string; - parent?: string; - quantity?: number; + amount?: number + currency?: string + description?: string + parent?: string + quantity?: number /** @enum {string} */ - type?: "discount" | "shipping" | "sku" | "tax"; - }[]; + type?: 'discount' | 'shipping' | 'sku' | 'tax' + }[] /** order_shipping */ shipping?: { /** address */ address: { - city?: string; - country?: string; - line1: string; - line2?: string; - postal_code?: string; - state?: string; - }; - carrier?: string; - name?: string; - phone?: string; - tracking_number?: string; - }; - }; - }; - }; - }; - responses: { - /** Successful response. */ - 200: { - schema: definitions["source"]; - }; - /** Error response. */ - default: { - schema: definitions["error"]; - }; - }; - }; + city?: string + country?: string + line1: string + line2?: string + postal_code?: string + state?: string + } + carrier?: string + name?: string + phone?: string + tracking_number?: string + } + } + } + } + } + responses: { + /** Successful response. */ + 200: { + schema: definitions['source'] + } + /** Error response. */ + default: { + schema: definitions['error'] + } + } + } /**

Retrieves a new Source MandateNotification.

*/ GetSourcesSourceMandateNotificationsMandateNotification: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - mandate_notification: string; - source: string; - }; - }; + mandate_notification: string + source: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["source_mandate_notification"]; - }; + schema: definitions['source_mandate_notification'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

List source transactions for a given source.

*/ GetSourcesSourceSourceTransactions: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - source: string; - }; - }; + source: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["source_transaction"][]; + data: definitions['source_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ GetSourcesSourceSourceTransactionsSourceTransaction: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - source: string; - source_transaction: string; - }; - }; + source: string + source_transaction: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["source_transaction"]; - }; + schema: definitions['source_transaction'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Verify a given source.

*/ PostSourcesSourceVerify: { parameters: { path: { - source: string; - }; + source: string + } body: { /** Body parameters for the request. */ payload: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The values needed to verify the source. */ - values: string[]; - }; - }; - }; + values: string[] + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["source"]; - }; + schema: definitions['source'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Returns a list of your subscription items for a given subscription.

*/ GetSubscriptionItems: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** The ID of the subscription whose items will be retrieved. */ - subscription: string; - }; - }; + subscription: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["subscription_item"][]; + data: definitions['subscription_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Adds a new item to an existing subscription. No existing items will be changed or replaced.

*/ PostSubscriptionItems: { parameters: { @@ -26979,11 +26911,11 @@ export interface operations { /** Body parameters for the request. */ payload: { /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. */ - billing_thresholds?: unknown; + billing_thresholds?: unknown /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: { [key: string]: unknown }; + metadata?: { [key: string]: unknown } /** * @description Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * @@ -26992,11 +26924,11 @@ export interface operations { * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not create a subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. * @enum {string} */ - payment_behavior?: "allow_incomplete" | "error_if_incomplete" | "pending_if_incomplete"; + payment_behavior?: 'allow_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete' /** @description The identifier of the plan to add to the subscription. */ - plan?: string; + plan?: string /** @description This field has been renamed to `proration_behavior`. `prorate=true` can be replaced with `proration_behavior=create_prorations` and `prorate=false` can be replaced with `proration_behavior=none`. */ - prorate?: boolean; + prorate?: boolean /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -27005,68 +26937,68 @@ export interface operations { * Prorations can be disabled by passing `none`. * @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. */ - proration_date?: number; + proration_date?: number /** @description The quantity you'd like to apply to the subscription item you're creating. */ - quantity?: number; + quantity?: number /** @description The identifier of the subscription to modify. */ - subscription: string; + subscription: string /** @description A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. */ - tax_rates?: string[]; - }; - }; - }; + tax_rates?: string[] + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["subscription_item"]; - }; + schema: definitions['subscription_item'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves the invoice item with the given ID.

*/ GetSubscriptionItemsItem: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - item: string; - }; - }; + item: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["subscription_item"]; - }; + schema: definitions['subscription_item'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Updates the plan or quantity of an item on a current subscription.

*/ PostSubscriptionItemsItem: { parameters: { path: { - item: string; - }; + item: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. */ - billing_thresholds?: unknown; + billing_thresholds?: unknown /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: unknown; + metadata?: unknown /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. */ - off_session?: boolean; + off_session?: boolean /** * @description Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * @@ -27075,11 +27007,11 @@ export interface operations { * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not create a subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. * @enum {string} */ - payment_behavior?: "allow_incomplete" | "error_if_incomplete" | "pending_if_incomplete"; + payment_behavior?: 'allow_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete' /** @description The identifier of the new plan for this subscription item. */ - plan?: string; + plan?: string /** @description This field has been renamed to `proration_behavior`. `prorate=true` can be replaced with `proration_behavior=create_prorations` and `prorate=false` can be replaced with `proration_behavior=none`. */ - prorate?: boolean; + prorate?: boolean /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -27088,40 +27020,40 @@ export interface operations { * Prorations can be disabled by passing `none`. * @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. */ - proration_date?: number; + proration_date?: number /** @description The quantity you'd like to apply to the subscription item you're creating. */ - quantity?: number; + quantity?: number /** @description A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. */ - tax_rates?: string[]; - }; - }; - }; + tax_rates?: string[] + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["subscription_item"]; - }; + schema: definitions['subscription_item'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.

*/ DeleteSubscriptionItemsItem: { parameters: { path: { - item: string; - }; + item: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Delete all usage for the given subscription item. Allowed only when the current plan's `usage_type` is `metered`. */ - clear_usage?: boolean; + clear_usage?: boolean /** @description This field has been renamed to `proration_behavior`. `prorate=true` can be replaced with `proration_behavior=create_prorations` and `prorate=false` can be replaced with `proration_behavior=none`. */ - prorate?: boolean; + prorate?: boolean /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -27130,23 +27062,23 @@ export interface operations { * Prorations can be disabled by passing `none`. * @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. */ - proration_date?: number; - }; - }; - }; + proration_date?: number + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["deleted_subscription_item"]; - }; + schema: definitions['deleted_subscription_item'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

For the specified subscription item, returns a list of summary objects. Each object in the list provides usage information that’s been summarized from multiple usage records and over a subscription billing period (e.g., 15 usage records in the billing plan’s month of September).

* @@ -27156,40 +27088,40 @@ export interface operations { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - subscription_item: string; - }; - }; + subscription_item: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["usage_record_summary"][]; + data: definitions['usage_record_summary'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

Creates a usage record for a specified subscription item and date, and fills it with a quantity.

* @@ -27202,8 +27134,8 @@ export interface operations { PostSubscriptionItemsSubscriptionItemUsageRecords: { parameters: { path: { - subscription_item: string; - }; + subscription_item: string + } body: { /** Body parameters for the request. */ payload: { @@ -27211,75 +27143,75 @@ export interface operations { * @description Valid values are `increment` (default) or `set`. When using `increment` the specified `quantity` will be added to the usage at the specified timestamp. The `set` action will overwrite the usage quantity at that timestamp. If the subscription has [billing thresholds](https://stripe.com/docs/api/subscriptions/object#subscription_object-billing_thresholds), `increment` is the only allowed value. * @enum {string} */ - action?: "increment" | "set"; + action?: 'increment' | 'set' /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The usage quantity for the specified timestamp. */ - quantity: number; + quantity: number /** @description The timestamp for the usage event. This timestamp must be within the current billing period of the subscription of the provided `subscription_item`. */ - timestamp: number; - }; - }; - }; + timestamp: number + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["usage_record"]; - }; + schema: definitions['usage_record'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves the list of your subscription schedules.

*/ GetSubscriptionSchedules: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** Only return subscription schedules that were created canceled the given date interval. */ - canceled_at?: number; + canceled_at?: number /** Only return subscription schedules that completed during the given date interval. */ - completed_at?: number; + completed_at?: number /** Only return subscription schedules that were created during the given date interval. */ - created?: number; + created?: number /** Only return subscription schedules for the given customer. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return subscription schedules that were released during the given date interval. */ - released_at?: number; + released_at?: number /** Only return subscription schedules that have not started yet. */ - scheduled?: boolean; + scheduled?: boolean /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["subscription_schedule"][]; + data: definitions['subscription_schedule'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Creates a new subscription schedule object. Each customer can have up to 25 active or scheduled subscriptions.

*/ PostSubscriptionSchedules: { parameters: { @@ -27287,103 +27219,103 @@ export interface operations { /** Body parameters for the request. */ payload?: { /** @description The identifier of the customer to create the subscription schedule for. */ - customer?: string; + customer?: string /** * default_settings_params * @description Object representing the subscription schedule's default settings. */ default_settings?: { - billing_thresholds?: unknown; + billing_thresholds?: unknown /** @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; - default_payment_method?: string; + collection_method?: 'charge_automatically' | 'send_invoice' + default_payment_method?: string /** subscription_schedules_param */ invoice_settings?: { - days_until_due?: number; - }; - }; + days_until_due?: number + } + } /** * @description Configures how the subscription schedule behaves 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. * @enum {string} */ - end_behavior?: "cancel" | "none" | "release" | "renew"; + end_behavior?: 'cancel' | 'none' | 'release' | 'renew' /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's plan(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls. */ - from_subscription?: string; + from_subscription?: string /** @description 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. 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?: unknown; + metadata?: unknown /** @description List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. */ phases?: { - application_fee_percent?: number; - billing_thresholds?: unknown; + application_fee_percent?: number + billing_thresholds?: unknown /** @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; - coupon?: string; - default_payment_method?: string; - default_tax_rates?: string[]; - end_date?: number; + collection_method?: 'charge_automatically' | 'send_invoice' + coupon?: string + default_payment_method?: string + default_tax_rates?: string[] + end_date?: number /** subscription_schedules_param */ invoice_settings?: { - days_until_due?: number; - }; - iterations?: number; + days_until_due?: number + } + iterations?: number plans: { - billing_thresholds?: unknown; - plan?: string; - quantity?: number; - tax_rates?: string[]; - }[]; + billing_thresholds?: unknown + plan?: string + quantity?: number + tax_rates?: string[] + }[] /** @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; - tax_percent?: number; - trial?: boolean; - trial_end?: number; - }[]; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' + tax_percent?: number + trial?: boolean + trial_end?: number + }[] /** @description When the subscription schedule starts. We recommend using `now` so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on. */ - start_date?: unknown; - }; - }; - }; + start_date?: unknown + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["subscription_schedule"]; - }; + schema: definitions['subscription_schedule'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ GetSubscriptionSchedulesSchedule: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - schedule: string; - }; - }; + schedule: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["subscription_schedule"]; - }; + schema: definitions['subscription_schedule'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Updates an existing subscription schedule.

*/ PostSubscriptionSchedulesSchedule: { parameters: { path: { - schedule: string; - }; + schedule: string + } body: { /** Body parameters for the request. */ payload?: { @@ -27392,176 +27324,176 @@ export interface operations { * @description Object representing the subscription schedule's default settings. */ default_settings?: { - billing_thresholds?: unknown; + billing_thresholds?: unknown /** @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; - default_payment_method?: string; + collection_method?: 'charge_automatically' | 'send_invoice' + default_payment_method?: string /** subscription_schedules_param */ invoice_settings?: { - days_until_due?: number; - }; - }; + days_until_due?: number + } + } /** * @description Configures how the subscription schedule behaves 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. * @enum {string} */ - end_behavior?: "cancel" | "none" | "release" | "renew"; + end_behavior?: 'cancel' | 'none' | 'release' | 'renew' /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: unknown; + metadata?: unknown /** @description List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. Note that past phases can be omitted. */ phases?: { - application_fee_percent?: number; - billing_thresholds?: unknown; + application_fee_percent?: number + billing_thresholds?: unknown /** @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; - coupon?: string; - default_payment_method?: string; - default_tax_rates?: string[]; - end_date?: unknown; + collection_method?: 'charge_automatically' | 'send_invoice' + coupon?: string + default_payment_method?: string + default_tax_rates?: string[] + end_date?: unknown /** subscription_schedules_param */ invoice_settings?: { - days_until_due?: number; - }; - iterations?: number; + days_until_due?: number + } + iterations?: number plans: { - billing_thresholds?: unknown; - plan?: string; - quantity?: number; - tax_rates?: string[]; - }[]; + billing_thresholds?: unknown + plan?: string + quantity?: number + tax_rates?: string[] + }[] /** @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; - start_date?: unknown; - tax_percent?: number; - trial?: boolean; - trial_end?: unknown; - }[]; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' + start_date?: unknown + tax_percent?: number + trial?: boolean + trial_end?: unknown + }[] /** @description This field has been renamed to `proration_behavior`. `prorate=true` can be replaced with `proration_behavior=create_prorations` and `prorate=false` can be replaced with `proration_behavior=none`. */ - prorate?: boolean; + prorate?: boolean /** * @description If the update changes the current phase, indicates if the changes should be prorated. Valid values are `create_prorations` or `none`, and the default value is `create_prorations`. * @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; - }; - }; - }; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["subscription_schedule"]; - }; + schema: definitions['subscription_schedule'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ PostSubscriptionSchedulesScheduleCancel: { parameters: { path: { - schedule: string; - }; + schedule: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description If the subscription schedule is `active`, indicates whether or not to generate a final invoice that contains any un-invoiced metered usage and new/pending proration invoice items. Defaults to `true`. */ - invoice_now?: boolean; + invoice_now?: boolean /** @description If the subscription schedule is `active`, indicates if the cancellation should be prorated. Defaults to `true`. */ - prorate?: boolean; - }; - }; - }; + prorate?: boolean + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["subscription_schedule"]; - }; + schema: definitions['subscription_schedule'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ PostSubscriptionSchedulesScheduleRelease: { parameters: { path: { - schedule: string; - }; + schedule: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Keep any cancellation on the subscription that the schedule has set */ - preserve_cancel_date?: boolean; - }; - }; - }; + preserve_cancel_date?: boolean + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["subscription_schedule"]; - }; + schema: definitions['subscription_schedule'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.

*/ GetSubscriptions: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** The collection method of the subscriptions to retrieve. Either `charge_automatically` or `send_invoice`. */ - collection_method?: string; - created?: number; - current_period_end?: number; - current_period_start?: number; + collection_method?: string + created?: number + current_period_end?: number + current_period_start?: number /** The ID of the customer whose subscriptions will be retrieved. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** The ID of the plan whose subscriptions will be retrieved. */ - plan?: string; + plan?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** The status of the subscriptions to retrieve. One of: `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `unpaid`, `canceled`, or `all`. Passing in a value of `canceled` will return all canceled subscriptions, including those belonging to deleted customers. Passing in a value of `all` will return subscriptions of all statuses. */ - status?: string; - }; - }; + status?: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["subscription"][]; + data: definitions['subscription'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Creates a new subscription on an existing customer. Each customer can have up to 25 active or scheduled subscriptions.

*/ PostSubscriptions: { parameters: { @@ -27569,48 +27501,48 @@ export interface operations { /** Body parameters for the request. */ payload: { /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). */ - application_fee_percent?: number; + application_fee_percent?: number /** @description For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor. */ - backdate_start_date?: number; + backdate_start_date?: number /** @description 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. */ - billing_cycle_anchor?: number; + billing_cycle_anchor?: number /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. */ - billing_thresholds?: unknown; + billing_thresholds?: unknown /** @description 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. */ - cancel_at?: number; + cancel_at?: number /** @description Boolean indicating whether this subscription should cancel at the end of the current period. */ - cancel_at_period_end?: boolean; + cancel_at_period_end?: boolean /** * @description 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. Defaults to `charge_automatically`. * @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' /** @description The code of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. */ - coupon?: string; + coupon?: string /** @description The identifier of the customer to subscribe. */ - customer: string; + customer: string /** @description Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. */ - days_until_due?: number; + days_until_due?: number /** @description ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. If not set, invoices will use the default payment method in the customer's invoice settings. */ - default_payment_method?: string; + default_payment_method?: string /** @description 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 not set, defaults to the customer's default source. */ - default_source?: string; + default_source?: string /** @description 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?: string[]; + default_tax_rates?: string[] /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A list of up to 20 subscription items, each with an attached plan. */ items?: { - billing_thresholds?: unknown; - metadata?: { [key: string]: unknown }; - plan?: string; - quantity?: number; - tax_rates?: string[]; - }[]; + billing_thresholds?: unknown + metadata?: { [key: string]: unknown } + plan?: string + quantity?: number + tax_rates?: string[] + }[] /** @description 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. 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?: unknown; + metadata?: unknown /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. */ - off_session?: boolean; + off_session?: boolean /** * @description Use `allow_incomplete` to create subscriptions with `status=incomplete` if the first invoice cannot be paid. Creating subscriptions with this status allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * @@ -27619,118 +27551,118 @@ export interface operations { * `pending_if_incomplete` is only used with updates and cannot be passed when creating a subscription. * @enum {string} */ - payment_behavior?: "allow_incomplete" | "error_if_incomplete" | "pending_if_incomplete"; + payment_behavior?: 'allow_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete' /** @description 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?: unknown; + pending_invoice_item_interval?: unknown /** @description This field has been renamed to `proration_behavior`. `prorate=true` can be replaced with `proration_behavior=create_prorations` and `prorate=false` can be replaced with `proration_behavior=none`. */ - prorate?: boolean; + prorate?: boolean /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) resulting from the `billing_cycle_anchor`. Valid values are `create_prorations` or `none`. * * Passing `create_prorations` will cause proration invoice items to be created when applicable. Prorations can be disabled by passing `none`. If no value is passed, the default is `create_prorations`. * @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** @description A non-negative decimal (with at most four decimal places) between 0 and 100. This represents the percentage of the subscription invoice subtotal that will be calculated and added as tax to the final amount in each billing period. For example, a plan which charges $10/month with a `tax_percent` of `20.0` will charge $12 per invoice. To unset a previously-set value, pass an empty string. This field has been deprecated and will be removed in a future API version, for further information view the [migration docs](https://stripe.com/docs/billing/migration/taxes) for `tax_rates`. */ - tax_percent?: unknown; + tax_percent?: unknown /** @description Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. */ - trial_end?: unknown; + trial_end?: unknown /** @description 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. */ - trial_from_plan?: boolean; + trial_from_plan?: boolean /** @description Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. */ - trial_period_days?: number; - }; - }; - }; + trial_period_days?: number + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["subscription"]; - }; + schema: definitions['subscription'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves the subscription with the given ID.

*/ GetSubscriptionsSubscriptionExposedId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - subscription_exposed_id: string; - }; - }; + subscription_exposed_id: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["subscription"]; - }; + schema: definitions['subscription'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ PostSubscriptionsSubscriptionExposedId: { parameters: { path: { - subscription_exposed_id: string; - }; + subscription_exposed_id: string + } body: { /** Body parameters for the request. */ payload?: { /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). */ - application_fee_percent?: number; + application_fee_percent?: number /** * @description Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). * @enum {string} */ - billing_cycle_anchor?: "now" | "unchanged"; + billing_cycle_anchor?: 'now' | 'unchanged' /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. */ - billing_thresholds?: unknown; + billing_thresholds?: unknown /** @description 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. */ - cancel_at?: unknown; + cancel_at?: unknown /** @description Boolean indicating whether this subscription should cancel at the end of the current period. */ - cancel_at_period_end?: boolean; + cancel_at_period_end?: boolean /** * @description 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. Defaults to `charge_automatically`. * @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' /** @description The code of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. */ - coupon?: string; + coupon?: string /** @description Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. */ - days_until_due?: number; + days_until_due?: number /** @description ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. If not set, invoices will use the default payment method in the customer's invoice settings. */ - default_payment_method?: string; + default_payment_method?: string /** @description 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 not set, defaults to the customer's default source. */ - default_source?: string; + default_source?: string /** @description 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. Pass an empty string to remove previously-defined tax rates. */ - default_tax_rates?: string[]; + default_tax_rates?: string[] /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description List of subscription items, each with an attached plan. */ items?: { - billing_thresholds?: unknown; - clear_usage?: boolean; - deleted?: boolean; - id?: string; - metadata?: unknown; - plan?: string; - quantity?: number; - tax_rates?: string[]; - }[]; + billing_thresholds?: unknown + clear_usage?: boolean + deleted?: boolean + id?: string + metadata?: unknown + plan?: string + quantity?: number + tax_rates?: string[] + }[] /** @description 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. 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?: unknown; + metadata?: unknown /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. */ - off_session?: boolean; + off_session?: boolean /** @description If specified, payment collection for this subscription will be paused. */ - pause_collection?: unknown; + pause_collection?: unknown /** * @description Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * @@ -27739,11 +27671,11 @@ export interface operations { * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not create a subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. * @enum {string} */ - payment_behavior?: "allow_incomplete" | "error_if_incomplete" | "pending_if_incomplete"; + payment_behavior?: 'allow_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete' /** @description 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?: unknown; + pending_invoice_item_interval?: unknown /** @description This field has been renamed to `proration_behavior`. `prorate=true` can be replaced with `proration_behavior=create_prorations` and `prorate=false` can be replaced with `proration_behavior=none`. */ - prorate?: boolean; + prorate?: boolean /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -27752,29 +27684,29 @@ export interface operations { * Prorations can be disabled by passing `none`. * @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations. */ - proration_date?: number; + proration_date?: number /** @description A non-negative decimal (with at most four decimal places) between 0 and 100. This represents the percentage of the subscription invoice subtotal that will be calculated and added as tax to the final amount in each billing period. For example, a plan which charges $10/month with a `tax_percent` of `20.0` will charge $12 per invoice. To unset a previously-set value, pass an empty string. This field has been deprecated and will be removed in a future API version, for further information view the [migration docs](https://stripe.com/docs/billing/migration/taxes) for `tax_rates`. */ - tax_percent?: unknown; + tax_percent?: unknown /** @description Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. */ - trial_end?: unknown; + trial_end?: unknown /** @description 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. */ - trial_from_plan?: boolean; - }; - }; - }; + trial_from_plan?: boolean + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["subscription"]; - }; + schema: definitions['subscription'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

Cancels a customer’s subscription immediately. The customer will not be charged again for the subscription.

* @@ -27785,91 +27717,91 @@ export interface operations { DeleteSubscriptionsSubscriptionExposedId: { parameters: { path: { - subscription_exposed_id: string; - }; + subscription_exposed_id: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items. */ - invoice_now?: boolean; + invoice_now?: boolean /** @description Will generate a proration invoice item that credits remaining unused time until the subscription period end. */ - prorate?: boolean; - }; - }; - }; + prorate?: boolean + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["subscription"]; - }; + schema: definitions['subscription'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Removes the currently applied discount on a subscription.

*/ DeleteSubscriptionsSubscriptionExposedIdDiscount: { parameters: { path: { - subscription_exposed_id: string; - }; - }; + subscription_exposed_id: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["deleted_discount"]; - }; + schema: definitions['deleted_discount'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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

*/ GetTaxRates: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** Optional flag to filter by tax rates that are either active or not active (archived) */ - active?: boolean; + active?: boolean /** Optional range for filtering created date */ - created?: number; + created?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Optional flag to filter by tax rates that are inclusive (or those that are not inclusive) */ - inclusive?: boolean; + inclusive?: boolean /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["tax_rate"][]; + data: definitions['tax_rate'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Creates a new tax rate.

*/ PostTaxRates: { parameters: { @@ -27877,92 +27809,92 @@ export interface operations { /** Body parameters for the request. */ payload: { /** @description Flag determining whether the tax rate is active or inactive. Inactive tax rates continue to work where they are currently applied however they cannot be used for new applications. */ - active?: boolean; + active?: boolean /** @description An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. */ - description?: string; + description?: string /** @description The display name of the tax rate, which will be shown to users. */ - display_name: string; + display_name: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description This specifies if the tax rate is inclusive or exclusive. */ - inclusive: boolean; + inclusive: boolean /** @description The jurisdiction for the tax rate. */ - jurisdiction?: string; + jurisdiction?: string /** @description 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. 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?: { [key: string]: unknown }; + metadata?: { [key: string]: unknown } /** @description This represents the tax rate percent out of 100. */ - percentage: number; - }; - }; - }; + percentage: number + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["tax_rate"]; - }; + schema: definitions['tax_rate'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves a tax rate with the given ID

*/ GetTaxRatesTaxRate: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - tax_rate: string; - }; - }; + tax_rate: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["tax_rate"]; - }; + schema: definitions['tax_rate'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Updates an existing tax rate.

*/ PostTaxRatesTaxRate: { parameters: { path: { - tax_rate: string; - }; + tax_rate: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Flag determining whether the tax rate is active or inactive. Inactive tax rates continue to work where they are currently applied however they cannot be used for new applications. */ - active?: boolean; + active?: boolean /** @description An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. */ - description?: string; + description?: string /** @description The display name of the tax rate, which will be shown to users. */ - display_name?: string; + display_name?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The jurisdiction for the tax rate. */ - jurisdiction?: string; + jurisdiction?: string /** @description 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. 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?: unknown; - }; - }; - }; + metadata?: unknown + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["tax_rate"]; - }; + schema: definitions['tax_rate'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

To connect to a reader the Stripe Terminal SDK needs to retrieve a short-lived connection token from Stripe, proxied through your server. On your backend, add an endpoint that creates and returns a connection token.

*/ PostTerminalConnectionTokens: { parameters: { @@ -27970,59 +27902,59 @@ export interface operations { /** Body parameters for the request. */ payload?: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The id of the location that this connection token is scoped to. If specified the connection token will only be usable with readers assigned to that location, otherwise the connection token will be usable with all readers. */ - location?: string; - }; - }; - }; + location?: string + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["terminal.connection_token"]; - }; + schema: definitions['terminal.connection_token'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Returns a list of Location objects.

*/ GetTerminalLocations: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["terminal.location"][]; + data: definitions['terminal.location'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Creates a new Location object.

*/ PostTerminalLocations: { parameters: { @@ -28034,61 +27966,61 @@ export interface operations { * @description The full address of the location. */ address: { - city?: string; - country: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** @description A name for the location. */ - display_name: string; + display_name: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: unknown; - }; - }; - }; + metadata?: unknown + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["terminal.location"]; - }; + schema: definitions['terminal.location'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves a Location object.

*/ GetTerminalLocationsLocation: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - location: string; - }; - }; + location: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["terminal.location"]; - }; + schema: definitions['terminal.location'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Updates a Location object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ PostTerminalLocationsLocation: { parameters: { path: { - location: string; - }; + location: string + } body: { /** Body parameters for the request. */ payload?: { @@ -28097,94 +28029,94 @@ export interface operations { * @description The full address of the location. */ address?: { - city?: string; - country: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** @description A name for the location. */ - display_name?: string; + display_name?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: unknown; - }; - }; - }; + metadata?: unknown + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["terminal.location"]; - }; + schema: definitions['terminal.location'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Deletes a Location object.

*/ DeleteTerminalLocationsLocation: { parameters: { path: { - location: string; - }; - }; + location: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["deleted_terminal.location"]; - }; + schema: definitions['deleted_terminal.location'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Returns a list of Reader objects.

*/ GetTerminalReaders: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** Filters readers by device type */ - device_type?: string; + device_type?: 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. */ - ending_before?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A location ID to filter the response list to only readers at the specific location */ - location?: string; + location?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** A status filter to filter readers to only offline or online readers */ - status?: string; - }; - }; + status?: string + } + } responses: { /** Successful response. */ 200: { schema: { /** @description A list of readers */ - data: definitions["terminal.reader"][]; + data: definitions['terminal.reader'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Creates a new Reader object.

*/ PostTerminalReaders: { parameters: { @@ -28192,98 +28124,98 @@ export interface operations { /** Body parameters for the request. */ payload: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Custom label given to the reader for easier identification. If no label is specified, the registration code will be used. */ - label?: string; + label?: string /** @description The location to assign the reader to. If no location is specified, the reader will be assigned to the account's default location. */ - location?: string; + location?: string /** @description 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. 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?: unknown; + metadata?: unknown /** @description A code generated by the reader used for registering to an account. */ - registration_code: string; - }; - }; - }; + registration_code: string + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["terminal.reader"]; - }; + schema: definitions['terminal.reader'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves a Reader object.

*/ GetTerminalReadersReader: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - reader: string; - }; - }; + reader: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["terminal.reader"]; - }; + schema: definitions['terminal.reader'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ PostTerminalReadersReader: { parameters: { path: { - reader: string; - }; + reader: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The new label of the reader. */ - label?: string; + label?: string /** @description 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. 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?: unknown; - }; - }; - }; + metadata?: unknown + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["terminal.reader"]; - }; + schema: definitions['terminal.reader'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Deletes a Reader object.

*/ DeleteTerminalReadersReader: { parameters: { path: { - reader: string; - }; - }; + reader: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["deleted_terminal.reader"]; - }; + schema: definitions['deleted_terminal.reader'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

Creates a single-use token that represents a bank account’s details. * This token can be used with any API method in place of a bank account dictionary. This token can be used only once, by attaching it to a Custom account.

@@ -28299,154 +28231,154 @@ export interface operations { */ account?: { /** @enum {string} */ - business_type?: "company" | "government_entity" | "individual" | "non_profit"; + business_type?: 'company' | 'government_entity' | 'individual' | 'non_profit' /** company_specs */ company?: { /** address_specs */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** japan_address_kana_specs */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** japan_address_kanji_specs */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; - directors_provided?: boolean; - executives_provided?: boolean; - name?: string; - name_kana?: string; - name_kanji?: string; - owners_provided?: boolean; - phone?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } + directors_provided?: boolean + executives_provided?: boolean + name?: string + name_kana?: string + name_kanji?: string + owners_provided?: boolean + phone?: string /** @enum {string} */ structure?: - | "" - | "government_instrumentality" - | "governmental_unit" - | "incorporated_non_profit" - | "limited_liability_partnership" - | "multi_member_llc" - | "private_company" - | "private_corporation" - | "private_partnership" - | "public_company" - | "public_corporation" - | "public_partnership" - | "sole_proprietorship" - | "tax_exempt_government_instrumentality" - | "unincorporated_association" - | "unincorporated_non_profit"; - tax_id?: string; - tax_id_registrar?: string; - vat_id?: string; + | '' + | 'government_instrumentality' + | 'governmental_unit' + | 'incorporated_non_profit' + | 'limited_liability_partnership' + | 'multi_member_llc' + | 'private_company' + | 'private_corporation' + | 'private_partnership' + | 'public_company' + | 'public_corporation' + | 'public_partnership' + | 'sole_proprietorship' + | 'tax_exempt_government_instrumentality' + | 'unincorporated_association' + | 'unincorporated_non_profit' + tax_id?: string + tax_id_registrar?: string + vat_id?: string /** verification_specs */ verification?: { /** verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; + back?: string + front?: string + } + } + } /** individual_specs */ individual?: { /** address_specs */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** japan_address_kana_specs */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** japan_address_kanji_specs */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; - dob?: unknown; - email?: string; - first_name?: string; - first_name_kana?: string; - first_name_kanji?: string; - gender?: string; - id_number?: string; - last_name?: string; - last_name_kana?: string; - last_name_kanji?: string; - maiden_name?: string; - metadata?: unknown; - phone?: string; - ssn_last_4?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } + dob?: unknown + email?: string + first_name?: string + first_name_kana?: string + first_name_kanji?: string + gender?: string + id_number?: string + last_name?: string + last_name_kana?: string + last_name_kanji?: string + maiden_name?: string + metadata?: unknown + phone?: string + ssn_last_4?: string /** person_verification_specs */ verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; - tos_shown_and_accepted?: boolean; - }; + back?: string + front?: string + } + } + } + tos_shown_and_accepted?: boolean + } /** * token_create_bank_account * @description The bank account this token will represent. */ bank_account?: { - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; - country: string; - currency?: string; - routing_number?: string; - }; - card?: unknown; + account_holder_type?: 'company' | 'individual' + account_number: string + country: string + currency?: string + routing_number?: string + } + card?: unknown /** @description The customer (owned by the application's account) for which to create a token. This can be used only with an [OAuth access token](https://stripe.com/docs/connect/standard-accounts) or [Stripe-Account header](https://stripe.com/docs/connect/authentication). For more details, see [Cloning Saved Payment Methods](https://stripe.com/docs/connect/cloning-saved-payment-methods). */ - customer?: string; + customer?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * person_token_specs * @description Information for the person this token will represent. @@ -28454,155 +28386,155 @@ export interface operations { person?: { /** address_specs */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** japan_address_kana_specs */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** japan_address_kanji_specs */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; - dob?: unknown; - email?: string; - first_name?: string; - first_name_kana?: string; - first_name_kanji?: string; - gender?: string; - id_number?: string; - last_name?: string; - last_name_kana?: string; - last_name_kanji?: string; - maiden_name?: string; - metadata?: unknown; - phone?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } + dob?: unknown + email?: string + first_name?: string + first_name_kana?: string + first_name_kanji?: string + gender?: string + id_number?: string + last_name?: string + last_name_kana?: string + last_name_kanji?: string + maiden_name?: string + metadata?: unknown + phone?: string /** relationship_specs */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - percent_ownership?: unknown; - representative?: boolean; - title?: string; - }; - ssn_last_4?: string; + director?: boolean + executive?: boolean + owner?: boolean + percent_ownership?: unknown + representative?: boolean + title?: string + } + ssn_last_4?: string /** person_verification_specs */ verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; + back?: string + front?: string + } + } + } /** * pii_token_specs * @description The PII this token will represent. */ pii?: { - id_number?: string; - }; - }; - }; - }; + id_number?: string + } + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["token"]; - }; + schema: definitions['token'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves the token with the given ID.

*/ GetTokensToken: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - token: string; - }; - }; + token: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["token"]; - }; + schema: definitions['token'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Returns a list of top-ups.

*/ GetTopups: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** A positive integer representing how much to transfer. */ - amount?: number; + amount?: number /** 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?: number; + created?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return top-ups that have the given status. One of `canceled`, `failed`, `pending` or `succeeded`. */ - status?: string; - }; - }; + status?: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["topup"][]; + data: definitions['topup'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Top up the balance of an account

*/ PostTopups: { parameters: { @@ -28610,153 +28542,153 @@ export interface operations { /** Body parameters for the request. */ payload: { /** @description A positive integer representing how much to transfer. */ - amount: number; + amount: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: unknown; + metadata?: unknown /** @description The ID of a source to transfer funds from. For most users, this should be left unspecified which will use the bank account that was set up in the dashboard for the specified currency. In test mode, this can be a test bank token (see [Testing Top-ups](https://stripe.com/docs/connect/testing#testing-top-ups)). */ - source?: string; + source?: string /** @description Extra information about a top-up for the source's bank statement. Limited to 15 ASCII characters. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description A string that identifies this top-up as part of a group. */ - transfer_group?: string; - }; - }; - }; + transfer_group?: string + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["topup"]; - }; + schema: definitions['topup'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ GetTopupsTopup: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - topup: string; - }; - }; + topup: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["topup"]; - }; + schema: definitions['topup'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Updates the metadata of a top-up. Other top-up details are not editable by design.

*/ PostTopupsTopup: { parameters: { path: { - topup: string; - }; + topup: string + } body: { /** Body parameters for the request. */ payload?: { /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: unknown; - }; - }; - }; + metadata?: unknown + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["topup"]; - }; + schema: definitions['topup'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Cancels a top-up. Only pending top-ups can be canceled.

*/ PostTopupsTopupCancel: { parameters: { path: { - topup: string; - }; + topup: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; + expand?: string[] + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["topup"]; - }; + schema: definitions['topup'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ GetTransfers: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - created?: number; + expand?: unknown[] + created?: number /** Only return transfers for the destination specified by this account ID. */ - destination?: string; + destination?: 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. */ - ending_before?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return transfers with the specified transfer group. */ - transfer_group?: string; - }; - }; + transfer_group?: string + } + } responses: { /** Successful response. */ 200: { schema: { /** @description Details about each object. */ - data: definitions["transfer"][]; + data: definitions['transfer'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ PostTransfers: { parameters: { @@ -28764,80 +28696,80 @@ export interface operations { /** Body parameters for the request. */ payload: { /** @description A positive integer in %s representing how much to transfer. */ - amount?: number; + amount?: number /** @description 3-letter [ISO code for currency](https://stripe.com/docs/payouts). */ - currency: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description The ID of a connected Stripe account. See the Connect documentation for details. */ - destination: string; + destination: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: { [key: string]: unknown }; + metadata?: { [key: string]: unknown } /** @description You can use this parameter to transfer funds from a charge before they are added to your available balance. A pending balance will transfer immediately but the funds will not become available until the original charge becomes available. [See the Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-availability) for details. */ - source_transaction?: string; + source_transaction?: string /** * @description The source balance to use for this transfer. One of `bank_account`, `card`, or `fpx`. For most users, this will default to `card`. * @enum {string} */ - source_type?: "bank_account" | "card" | "fpx"; + source_type?: 'bank_account' | 'card' | 'fpx' /** @description A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-options) for details. */ - transfer_group?: string; - }; - }; - }; + transfer_group?: string + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["transfer"]; - }; + schema: definitions['transfer'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ GetTransfersIdReversals: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { schema: { /** @description Details about each object. */ - data: definitions["transfer_reversal"][]; + data: definitions['transfer_reversal'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

When you create a new reversal, you must specify a transfer to create it on.

* @@ -28848,57 +28780,57 @@ export interface operations { PostTransfersIdReversals: { parameters: { path: { - id: string; - }; + id: string + } body: { /** Body parameters for the request. */ payload?: { /** @description A positive integer in %s representing how much of this transfer to reverse. Can only reverse up to the unreversed amount remaining of the transfer. Partial transfer reversals are only allowed for transfers to Stripe Accounts. Defaults to the entire transfer amount. */ - amount?: number; + amount?: number /** @description An arbitrary string which you can attach to a reversal object. It is displayed alongside the reversal in the Dashboard. This will be unset if you POST an empty value. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: unknown; + metadata?: unknown /** @description Boolean indicating whether the application fee should be refunded when reversing this transfer. If a full transfer reversal is given, the full application fee will be refunded. Otherwise, the application fee will be refunded with an amount proportional to the amount of the transfer reversed. */ - refund_application_fee?: boolean; - }; - }; - }; + refund_application_fee?: boolean + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["transfer_reversal"]; - }; + schema: definitions['transfer_reversal'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ GetTransfersTransfer: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - transfer: string; - }; - }; + transfer: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["transfer"]; - }; + schema: definitions['transfer'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

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

* @@ -28907,54 +28839,54 @@ export interface operations { PostTransfersTransfer: { parameters: { path: { - transfer: string; - }; + transfer: string + } body: { /** Body parameters for the request. */ payload?: { /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: unknown; - }; - }; - }; + metadata?: unknown + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["transfer"]; - }; + schema: definitions['transfer'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ GetTransfersTransferReversalsId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - id: string; - transfer: string; - }; - }; + id: string + transfer: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["transfer_reversal"]; - }; + schema: definitions['transfer_reversal'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /** *

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

* @@ -28963,66 +28895,66 @@ export interface operations { PostTransfersTransferReversalsId: { parameters: { path: { - id: string; - transfer: string; - }; + id: string + transfer: string + } body: { /** Body parameters for the request. */ payload?: { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: unknown; - }; - }; - }; + metadata?: unknown + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["transfer_reversal"]; - }; + schema: definitions['transfer_reversal'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Returns a list of your webhook endpoints.

*/ GetWebhookEndpoints: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; + expand?: unknown[] /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { schema: { - data: definitions["webhook_endpoint"][]; + data: definitions['webhook_endpoint'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

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.

*/ PostWebhookEndpoints: { parameters: { @@ -29034,502 +28966,502 @@ export interface operations { * @enum {string} */ api_version?: - | "2011-01-01" - | "2011-06-21" - | "2011-06-28" - | "2011-08-01" - | "2011-09-15" - | "2011-11-17" - | "2012-02-23" - | "2012-03-25" - | "2012-06-18" - | "2012-06-28" - | "2012-07-09" - | "2012-09-24" - | "2012-10-26" - | "2012-11-07" - | "2013-02-11" - | "2013-02-13" - | "2013-07-05" - | "2013-08-12" - | "2013-08-13" - | "2013-10-29" - | "2013-12-03" - | "2014-01-31" - | "2014-03-13" - | "2014-03-28" - | "2014-05-19" - | "2014-06-13" - | "2014-06-17" - | "2014-07-22" - | "2014-07-26" - | "2014-08-04" - | "2014-08-20" - | "2014-09-08" - | "2014-10-07" - | "2014-11-05" - | "2014-11-20" - | "2014-12-08" - | "2014-12-17" - | "2014-12-22" - | "2015-01-11" - | "2015-01-26" - | "2015-02-10" - | "2015-02-16" - | "2015-02-18" - | "2015-03-24" - | "2015-04-07" - | "2015-06-15" - | "2015-07-07" - | "2015-07-13" - | "2015-07-28" - | "2015-08-07" - | "2015-08-19" - | "2015-09-03" - | "2015-09-08" - | "2015-09-23" - | "2015-10-01" - | "2015-10-12" - | "2015-10-16" - | "2016-02-03" - | "2016-02-19" - | "2016-02-22" - | "2016-02-23" - | "2016-02-29" - | "2016-03-07" - | "2016-06-15" - | "2016-07-06" - | "2016-10-19" - | "2017-01-27" - | "2017-02-14" - | "2017-04-06" - | "2017-05-25" - | "2017-06-05" - | "2017-08-15" - | "2017-12-14" - | "2018-01-23" - | "2018-02-05" - | "2018-02-06" - | "2018-02-28" - | "2018-05-21" - | "2018-07-27" - | "2018-08-23" - | "2018-09-06" - | "2018-09-24" - | "2018-10-31" - | "2018-11-08" - | "2019-02-11" - | "2019-02-19" - | "2019-03-14" - | "2019-05-16" - | "2019-08-14" - | "2019-09-09" - | "2019-10-08" - | "2019-10-17" - | "2019-11-05" - | "2019-12-03" - | "2020-03-02"; + | '2011-01-01' + | '2011-06-21' + | '2011-06-28' + | '2011-08-01' + | '2011-09-15' + | '2011-11-17' + | '2012-02-23' + | '2012-03-25' + | '2012-06-18' + | '2012-06-28' + | '2012-07-09' + | '2012-09-24' + | '2012-10-26' + | '2012-11-07' + | '2013-02-11' + | '2013-02-13' + | '2013-07-05' + | '2013-08-12' + | '2013-08-13' + | '2013-10-29' + | '2013-12-03' + | '2014-01-31' + | '2014-03-13' + | '2014-03-28' + | '2014-05-19' + | '2014-06-13' + | '2014-06-17' + | '2014-07-22' + | '2014-07-26' + | '2014-08-04' + | '2014-08-20' + | '2014-09-08' + | '2014-10-07' + | '2014-11-05' + | '2014-11-20' + | '2014-12-08' + | '2014-12-17' + | '2014-12-22' + | '2015-01-11' + | '2015-01-26' + | '2015-02-10' + | '2015-02-16' + | '2015-02-18' + | '2015-03-24' + | '2015-04-07' + | '2015-06-15' + | '2015-07-07' + | '2015-07-13' + | '2015-07-28' + | '2015-08-07' + | '2015-08-19' + | '2015-09-03' + | '2015-09-08' + | '2015-09-23' + | '2015-10-01' + | '2015-10-12' + | '2015-10-16' + | '2016-02-03' + | '2016-02-19' + | '2016-02-22' + | '2016-02-23' + | '2016-02-29' + | '2016-03-07' + | '2016-06-15' + | '2016-07-06' + | '2016-10-19' + | '2017-01-27' + | '2017-02-14' + | '2017-04-06' + | '2017-05-25' + | '2017-06-05' + | '2017-08-15' + | '2017-12-14' + | '2018-01-23' + | '2018-02-05' + | '2018-02-06' + | '2018-02-28' + | '2018-05-21' + | '2018-07-27' + | '2018-08-23' + | '2018-09-06' + | '2018-09-24' + | '2018-10-31' + | '2018-11-08' + | '2019-02-11' + | '2019-02-19' + | '2019-03-14' + | '2019-05-16' + | '2019-08-14' + | '2019-09-09' + | '2019-10-08' + | '2019-10-17' + | '2019-11-05' + | '2019-12-03' + | '2020-03-02' /** @description Whether this endpoint should receive events from connected accounts (`true`), or from your account (`false`). Defaults to `false`. */ - connect?: boolean; + connect?: boolean /** @description An optional description of what the wehbook is used for. */ - description?: string; + description?: string /** @description The list of events to enable for this endpoint. You may specify `['*']` to enable all events, except those that require explicit selection. */ enabled_events: ( - | "*" - | "account.application.authorized" - | "account.application.deauthorized" - | "account.external_account.created" - | "account.external_account.deleted" - | "account.external_account.updated" - | "account.updated" - | "application_fee.created" - | "application_fee.refund.updated" - | "application_fee.refunded" - | "balance.available" - | "capability.updated" - | "charge.captured" - | "charge.dispute.closed" - | "charge.dispute.created" - | "charge.dispute.funds_reinstated" - | "charge.dispute.funds_withdrawn" - | "charge.dispute.updated" - | "charge.expired" - | "charge.failed" - | "charge.pending" - | "charge.refund.updated" - | "charge.refunded" - | "charge.succeeded" - | "charge.updated" - | "checkout.session.completed" - | "coupon.created" - | "coupon.deleted" - | "coupon.updated" - | "credit_note.created" - | "credit_note.updated" - | "credit_note.voided" - | "customer.created" - | "customer.deleted" - | "customer.discount.created" - | "customer.discount.deleted" - | "customer.discount.updated" - | "customer.source.created" - | "customer.source.deleted" - | "customer.source.expiring" - | "customer.source.updated" - | "customer.subscription.created" - | "customer.subscription.deleted" - | "customer.subscription.pending_update_applied" - | "customer.subscription.pending_update_expired" - | "customer.subscription.trial_will_end" - | "customer.subscription.updated" - | "customer.tax_id.created" - | "customer.tax_id.deleted" - | "customer.tax_id.updated" - | "customer.updated" - | "file.created" - | "invoice.created" - | "invoice.deleted" - | "invoice.finalized" - | "invoice.marked_uncollectible" - | "invoice.payment_action_required" - | "invoice.payment_failed" - | "invoice.payment_succeeded" - | "invoice.sent" - | "invoice.upcoming" - | "invoice.updated" - | "invoice.voided" - | "invoiceitem.created" - | "invoiceitem.deleted" - | "invoiceitem.updated" - | "issuing_authorization.created" - | "issuing_authorization.request" - | "issuing_authorization.updated" - | "issuing_card.created" - | "issuing_card.updated" - | "issuing_cardholder.created" - | "issuing_cardholder.updated" - | "issuing_transaction.created" - | "issuing_transaction.updated" - | "mandate.updated" - | "order.created" - | "order.payment_failed" - | "order.payment_succeeded" - | "order.updated" - | "order_return.created" - | "payment_intent.amount_capturable_updated" - | "payment_intent.canceled" - | "payment_intent.created" - | "payment_intent.payment_failed" - | "payment_intent.processing" - | "payment_intent.succeeded" - | "payment_method.attached" - | "payment_method.card_automatically_updated" - | "payment_method.detached" - | "payment_method.updated" - | "payout.canceled" - | "payout.created" - | "payout.failed" - | "payout.paid" - | "payout.updated" - | "person.created" - | "person.deleted" - | "person.updated" - | "plan.created" - | "plan.deleted" - | "plan.updated" - | "product.created" - | "product.deleted" - | "product.updated" - | "radar.early_fraud_warning.created" - | "radar.early_fraud_warning.updated" - | "recipient.created" - | "recipient.deleted" - | "recipient.updated" - | "reporting.report_run.failed" - | "reporting.report_run.succeeded" - | "reporting.report_type.updated" - | "review.closed" - | "review.opened" - | "setup_intent.canceled" - | "setup_intent.created" - | "setup_intent.setup_failed" - | "setup_intent.succeeded" - | "sigma.scheduled_query_run.created" - | "sku.created" - | "sku.deleted" - | "sku.updated" - | "source.canceled" - | "source.chargeable" - | "source.failed" - | "source.mandate_notification" - | "source.refund_attributes_required" - | "source.transaction.created" - | "source.transaction.updated" - | "subscription_schedule.aborted" - | "subscription_schedule.canceled" - | "subscription_schedule.completed" - | "subscription_schedule.created" - | "subscription_schedule.expiring" - | "subscription_schedule.released" - | "subscription_schedule.updated" - | "tax_rate.created" - | "tax_rate.updated" - | "topup.canceled" - | "topup.created" - | "topup.failed" - | "topup.reversed" - | "topup.succeeded" - | "transfer.created" - | "transfer.failed" - | "transfer.paid" - | "transfer.reversed" - | "transfer.updated" - )[]; + | '*' + | 'account.application.authorized' + | 'account.application.deauthorized' + | 'account.external_account.created' + | 'account.external_account.deleted' + | 'account.external_account.updated' + | 'account.updated' + | 'application_fee.created' + | 'application_fee.refund.updated' + | 'application_fee.refunded' + | 'balance.available' + | 'capability.updated' + | 'charge.captured' + | 'charge.dispute.closed' + | 'charge.dispute.created' + | 'charge.dispute.funds_reinstated' + | 'charge.dispute.funds_withdrawn' + | 'charge.dispute.updated' + | 'charge.expired' + | 'charge.failed' + | 'charge.pending' + | 'charge.refund.updated' + | 'charge.refunded' + | 'charge.succeeded' + | 'charge.updated' + | 'checkout.session.completed' + | 'coupon.created' + | 'coupon.deleted' + | 'coupon.updated' + | 'credit_note.created' + | 'credit_note.updated' + | 'credit_note.voided' + | 'customer.created' + | 'customer.deleted' + | 'customer.discount.created' + | 'customer.discount.deleted' + | 'customer.discount.updated' + | 'customer.source.created' + | 'customer.source.deleted' + | 'customer.source.expiring' + | 'customer.source.updated' + | 'customer.subscription.created' + | 'customer.subscription.deleted' + | 'customer.subscription.pending_update_applied' + | 'customer.subscription.pending_update_expired' + | 'customer.subscription.trial_will_end' + | 'customer.subscription.updated' + | 'customer.tax_id.created' + | 'customer.tax_id.deleted' + | 'customer.tax_id.updated' + | 'customer.updated' + | 'file.created' + | 'invoice.created' + | 'invoice.deleted' + | 'invoice.finalized' + | 'invoice.marked_uncollectible' + | 'invoice.payment_action_required' + | 'invoice.payment_failed' + | 'invoice.payment_succeeded' + | 'invoice.sent' + | 'invoice.upcoming' + | 'invoice.updated' + | 'invoice.voided' + | 'invoiceitem.created' + | 'invoiceitem.deleted' + | 'invoiceitem.updated' + | 'issuing_authorization.created' + | 'issuing_authorization.request' + | 'issuing_authorization.updated' + | 'issuing_card.created' + | 'issuing_card.updated' + | 'issuing_cardholder.created' + | 'issuing_cardholder.updated' + | 'issuing_transaction.created' + | 'issuing_transaction.updated' + | 'mandate.updated' + | 'order.created' + | 'order.payment_failed' + | 'order.payment_succeeded' + | 'order.updated' + | 'order_return.created' + | 'payment_intent.amount_capturable_updated' + | 'payment_intent.canceled' + | 'payment_intent.created' + | 'payment_intent.payment_failed' + | 'payment_intent.processing' + | 'payment_intent.succeeded' + | 'payment_method.attached' + | 'payment_method.card_automatically_updated' + | 'payment_method.detached' + | 'payment_method.updated' + | 'payout.canceled' + | 'payout.created' + | 'payout.failed' + | 'payout.paid' + | 'payout.updated' + | 'person.created' + | 'person.deleted' + | 'person.updated' + | 'plan.created' + | 'plan.deleted' + | 'plan.updated' + | 'product.created' + | 'product.deleted' + | 'product.updated' + | 'radar.early_fraud_warning.created' + | 'radar.early_fraud_warning.updated' + | 'recipient.created' + | 'recipient.deleted' + | 'recipient.updated' + | 'reporting.report_run.failed' + | 'reporting.report_run.succeeded' + | 'reporting.report_type.updated' + | 'review.closed' + | 'review.opened' + | 'setup_intent.canceled' + | 'setup_intent.created' + | 'setup_intent.setup_failed' + | 'setup_intent.succeeded' + | 'sigma.scheduled_query_run.created' + | 'sku.created' + | 'sku.deleted' + | 'sku.updated' + | 'source.canceled' + | 'source.chargeable' + | 'source.failed' + | 'source.mandate_notification' + | 'source.refund_attributes_required' + | 'source.transaction.created' + | 'source.transaction.updated' + | 'subscription_schedule.aborted' + | 'subscription_schedule.canceled' + | 'subscription_schedule.completed' + | 'subscription_schedule.created' + | 'subscription_schedule.expiring' + | 'subscription_schedule.released' + | 'subscription_schedule.updated' + | 'tax_rate.created' + | 'tax_rate.updated' + | 'topup.canceled' + | 'topup.created' + | 'topup.failed' + | 'topup.reversed' + | 'topup.succeeded' + | 'transfer.created' + | 'transfer.failed' + | 'transfer.paid' + | 'transfer.reversed' + | 'transfer.updated' + )[] /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: unknown; + metadata?: unknown /** @description The URL of the webhook endpoint. */ - url: string; - }; - }; - }; + url: string + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["webhook_endpoint"]; - }; + schema: definitions['webhook_endpoint'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Retrieves the webhook endpoint with the given ID.

*/ GetWebhookEndpointsWebhookEndpoint: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: unknown[]; - }; + expand?: unknown[] + } path: { - webhook_endpoint: string; - }; - }; + webhook_endpoint: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["webhook_endpoint"]; - }; + schema: definitions['webhook_endpoint'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.

*/ PostWebhookEndpointsWebhookEndpoint: { parameters: { path: { - webhook_endpoint: string; - }; + webhook_endpoint: string + } body: { /** Body parameters for the request. */ payload?: { /** @description An optional description of what the wehbook is used for. */ - description?: string; + description?: string /** @description Disable the webhook endpoint if set to true. */ - disabled?: boolean; + disabled?: boolean /** @description The list of events to enable for this endpoint. You may specify `['*']` to enable all events, except those that require explicit selection. */ enabled_events?: ( - | "*" - | "account.application.authorized" - | "account.application.deauthorized" - | "account.external_account.created" - | "account.external_account.deleted" - | "account.external_account.updated" - | "account.updated" - | "application_fee.created" - | "application_fee.refund.updated" - | "application_fee.refunded" - | "balance.available" - | "capability.updated" - | "charge.captured" - | "charge.dispute.closed" - | "charge.dispute.created" - | "charge.dispute.funds_reinstated" - | "charge.dispute.funds_withdrawn" - | "charge.dispute.updated" - | "charge.expired" - | "charge.failed" - | "charge.pending" - | "charge.refund.updated" - | "charge.refunded" - | "charge.succeeded" - | "charge.updated" - | "checkout.session.completed" - | "coupon.created" - | "coupon.deleted" - | "coupon.updated" - | "credit_note.created" - | "credit_note.updated" - | "credit_note.voided" - | "customer.created" - | "customer.deleted" - | "customer.discount.created" - | "customer.discount.deleted" - | "customer.discount.updated" - | "customer.source.created" - | "customer.source.deleted" - | "customer.source.expiring" - | "customer.source.updated" - | "customer.subscription.created" - | "customer.subscription.deleted" - | "customer.subscription.pending_update_applied" - | "customer.subscription.pending_update_expired" - | "customer.subscription.trial_will_end" - | "customer.subscription.updated" - | "customer.tax_id.created" - | "customer.tax_id.deleted" - | "customer.tax_id.updated" - | "customer.updated" - | "file.created" - | "invoice.created" - | "invoice.deleted" - | "invoice.finalized" - | "invoice.marked_uncollectible" - | "invoice.payment_action_required" - | "invoice.payment_failed" - | "invoice.payment_succeeded" - | "invoice.sent" - | "invoice.upcoming" - | "invoice.updated" - | "invoice.voided" - | "invoiceitem.created" - | "invoiceitem.deleted" - | "invoiceitem.updated" - | "issuing_authorization.created" - | "issuing_authorization.request" - | "issuing_authorization.updated" - | "issuing_card.created" - | "issuing_card.updated" - | "issuing_cardholder.created" - | "issuing_cardholder.updated" - | "issuing_transaction.created" - | "issuing_transaction.updated" - | "mandate.updated" - | "order.created" - | "order.payment_failed" - | "order.payment_succeeded" - | "order.updated" - | "order_return.created" - | "payment_intent.amount_capturable_updated" - | "payment_intent.canceled" - | "payment_intent.created" - | "payment_intent.payment_failed" - | "payment_intent.processing" - | "payment_intent.succeeded" - | "payment_method.attached" - | "payment_method.card_automatically_updated" - | "payment_method.detached" - | "payment_method.updated" - | "payout.canceled" - | "payout.created" - | "payout.failed" - | "payout.paid" - | "payout.updated" - | "person.created" - | "person.deleted" - | "person.updated" - | "plan.created" - | "plan.deleted" - | "plan.updated" - | "product.created" - | "product.deleted" - | "product.updated" - | "radar.early_fraud_warning.created" - | "radar.early_fraud_warning.updated" - | "recipient.created" - | "recipient.deleted" - | "recipient.updated" - | "reporting.report_run.failed" - | "reporting.report_run.succeeded" - | "reporting.report_type.updated" - | "review.closed" - | "review.opened" - | "setup_intent.canceled" - | "setup_intent.created" - | "setup_intent.setup_failed" - | "setup_intent.succeeded" - | "sigma.scheduled_query_run.created" - | "sku.created" - | "sku.deleted" - | "sku.updated" - | "source.canceled" - | "source.chargeable" - | "source.failed" - | "source.mandate_notification" - | "source.refund_attributes_required" - | "source.transaction.created" - | "source.transaction.updated" - | "subscription_schedule.aborted" - | "subscription_schedule.canceled" - | "subscription_schedule.completed" - | "subscription_schedule.created" - | "subscription_schedule.expiring" - | "subscription_schedule.released" - | "subscription_schedule.updated" - | "tax_rate.created" - | "tax_rate.updated" - | "topup.canceled" - | "topup.created" - | "topup.failed" - | "topup.reversed" - | "topup.succeeded" - | "transfer.created" - | "transfer.failed" - | "transfer.paid" - | "transfer.reversed" - | "transfer.updated" - )[]; + | '*' + | 'account.application.authorized' + | 'account.application.deauthorized' + | 'account.external_account.created' + | 'account.external_account.deleted' + | 'account.external_account.updated' + | 'account.updated' + | 'application_fee.created' + | 'application_fee.refund.updated' + | 'application_fee.refunded' + | 'balance.available' + | 'capability.updated' + | 'charge.captured' + | 'charge.dispute.closed' + | 'charge.dispute.created' + | 'charge.dispute.funds_reinstated' + | 'charge.dispute.funds_withdrawn' + | 'charge.dispute.updated' + | 'charge.expired' + | 'charge.failed' + | 'charge.pending' + | 'charge.refund.updated' + | 'charge.refunded' + | 'charge.succeeded' + | 'charge.updated' + | 'checkout.session.completed' + | 'coupon.created' + | 'coupon.deleted' + | 'coupon.updated' + | 'credit_note.created' + | 'credit_note.updated' + | 'credit_note.voided' + | 'customer.created' + | 'customer.deleted' + | 'customer.discount.created' + | 'customer.discount.deleted' + | 'customer.discount.updated' + | 'customer.source.created' + | 'customer.source.deleted' + | 'customer.source.expiring' + | 'customer.source.updated' + | 'customer.subscription.created' + | 'customer.subscription.deleted' + | 'customer.subscription.pending_update_applied' + | 'customer.subscription.pending_update_expired' + | 'customer.subscription.trial_will_end' + | 'customer.subscription.updated' + | 'customer.tax_id.created' + | 'customer.tax_id.deleted' + | 'customer.tax_id.updated' + | 'customer.updated' + | 'file.created' + | 'invoice.created' + | 'invoice.deleted' + | 'invoice.finalized' + | 'invoice.marked_uncollectible' + | 'invoice.payment_action_required' + | 'invoice.payment_failed' + | 'invoice.payment_succeeded' + | 'invoice.sent' + | 'invoice.upcoming' + | 'invoice.updated' + | 'invoice.voided' + | 'invoiceitem.created' + | 'invoiceitem.deleted' + | 'invoiceitem.updated' + | 'issuing_authorization.created' + | 'issuing_authorization.request' + | 'issuing_authorization.updated' + | 'issuing_card.created' + | 'issuing_card.updated' + | 'issuing_cardholder.created' + | 'issuing_cardholder.updated' + | 'issuing_transaction.created' + | 'issuing_transaction.updated' + | 'mandate.updated' + | 'order.created' + | 'order.payment_failed' + | 'order.payment_succeeded' + | 'order.updated' + | 'order_return.created' + | 'payment_intent.amount_capturable_updated' + | 'payment_intent.canceled' + | 'payment_intent.created' + | 'payment_intent.payment_failed' + | 'payment_intent.processing' + | 'payment_intent.succeeded' + | 'payment_method.attached' + | 'payment_method.card_automatically_updated' + | 'payment_method.detached' + | 'payment_method.updated' + | 'payout.canceled' + | 'payout.created' + | 'payout.failed' + | 'payout.paid' + | 'payout.updated' + | 'person.created' + | 'person.deleted' + | 'person.updated' + | 'plan.created' + | 'plan.deleted' + | 'plan.updated' + | 'product.created' + | 'product.deleted' + | 'product.updated' + | 'radar.early_fraud_warning.created' + | 'radar.early_fraud_warning.updated' + | 'recipient.created' + | 'recipient.deleted' + | 'recipient.updated' + | 'reporting.report_run.failed' + | 'reporting.report_run.succeeded' + | 'reporting.report_type.updated' + | 'review.closed' + | 'review.opened' + | 'setup_intent.canceled' + | 'setup_intent.created' + | 'setup_intent.setup_failed' + | 'setup_intent.succeeded' + | 'sigma.scheduled_query_run.created' + | 'sku.created' + | 'sku.deleted' + | 'sku.updated' + | 'source.canceled' + | 'source.chargeable' + | 'source.failed' + | 'source.mandate_notification' + | 'source.refund_attributes_required' + | 'source.transaction.created' + | 'source.transaction.updated' + | 'subscription_schedule.aborted' + | 'subscription_schedule.canceled' + | 'subscription_schedule.completed' + | 'subscription_schedule.created' + | 'subscription_schedule.expiring' + | 'subscription_schedule.released' + | 'subscription_schedule.updated' + | 'tax_rate.created' + | 'tax_rate.updated' + | 'topup.canceled' + | 'topup.created' + | 'topup.failed' + | 'topup.reversed' + | 'topup.succeeded' + | 'transfer.created' + | 'transfer.failed' + | 'transfer.paid' + | 'transfer.reversed' + | 'transfer.updated' + )[] /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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. 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?: unknown; + metadata?: unknown /** @description The URL of the webhook endpoint. */ - url?: string; - }; - }; - }; + url?: string + } + } + } responses: { /** Successful response. */ 200: { - schema: definitions["webhook_endpoint"]; - }; + schema: definitions['webhook_endpoint'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } /**

You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.

*/ DeleteWebhookEndpointsWebhookEndpoint: { parameters: { path: { - webhook_endpoint: string; - }; - }; + webhook_endpoint: string + } + } responses: { /** Successful response. */ 200: { - schema: definitions["deleted_webhook_endpoint"]; - }; + schema: definitions['deleted_webhook_endpoint'] + } /** Error response. */ default: { - schema: definitions["error"]; - }; - }; - }; + schema: definitions['error'] + } + } + } } export interface external {} diff --git a/test/v2/fixtures/.prettierrc b/test/v2/fixtures/.prettierrc new file mode 100644 index 000000000..ebe15dc8d --- /dev/null +++ b/test/v2/fixtures/.prettierrc @@ -0,0 +1,6 @@ +{ + "printWidth": 150, + "semi": false, + "singleQuote": true, + "trailingComma": "all" +} diff --git a/test/v2/index.test.js b/test/v2/index.test.js index 2ae8cc502..fd71d095d 100644 --- a/test/v2/index.test.js +++ b/test/v2/index.test.js @@ -15,7 +15,7 @@ describe("cli", () => { const filename = schema.replace(".yaml", ".ts"); it(`reads ${schema} spec (v2) from file`, async () => { - execSync(`${cmd} specs/${schema} -o generated/${filename} --prettier-config .prettierrc`, { cwd }); + execSync(`${cmd} specs/${schema} -o generated/${filename} --prettier-config fixtures/.prettierrc`, { cwd }); const generated = fs.readFileSync(new URL(`./generated/${filename}`, cwd), "utf8"); const expected = eol.lf(fs.readFileSync(new URL(`./expected/${filename}`, cwd), "utf8")); expect(generated).to.equal(expected); @@ -24,9 +24,12 @@ describe("cli", () => { it(`reads ${schema} spec (v2) from file (immutable types)`, async () => { const filename = schema.replace(".yaml", ".immutable.ts"); - execSync(`${cmd} specs/${schema} -o generated/${filename} --prettier-config .prettierrc --immutable-types`, { - cwd, - }); + execSync( + `${cmd} specs/${schema} -o generated/${filename} --prettier-config fixtures/.prettierrc --immutable-types`, + { + cwd, + } + ); const generated = fs.readFileSync(new URL(`./generated/${filename}`, cwd), "utf8"); const expected = eol.lf(fs.readFileSync(new URL(`./expected/${filename}`, cwd), "utf8")); expect(generated).to.equal(expected); @@ -50,7 +53,7 @@ describe("json", () => { const schemaYAML = fs.readFileSync(new URL(`./specs/${schema}`, cwd), "utf8"); const expected = eol.lf(fs.readFileSync(new URL(`./expected/${schema.replace(".yaml", ".ts")}`, cwd), "utf8")); const generated = await openapiTS(yaml.load(schemaYAML), { - prettierConfig: fileURLToPath(new URL("../../.prettierrc", cwd)), + prettierConfig: fileURLToPath(new URL("fixtures/.prettierrc", cwd)), }); expect(generated).to.equal(expected); }); diff --git a/test/v3/expected/consts-enums.additional.ts b/test/v3/expected/consts-enums.additional.ts index 073786a25..7a00d2d4c 100644 --- a/test/v3/expected/consts-enums.additional.ts +++ b/test/v3/expected/consts-enums.additional.ts @@ -4,14 +4,14 @@ */ export interface paths { - "/test": { + '/test': { get: { responses: { /** A list of types. */ - 200: unknown; - }; - }; - }; + 200: unknown + } + } + } } export interface components { @@ -19,15 +19,15 @@ export interface components { /** @description Enum with null and nullable */ MyType: { /** @enum {string|null} */ - myEnumTestFieldNullable?: ("foo" | "bar" | null) | null; + myEnumTestFieldNullable?: ('foo' | 'bar' | null) | null /** @enum {string|null} */ - myEnumTestField?: ("foo" | "bar" | null) | null; + myEnumTestField?: ('foo' | 'bar' | null) | null /** @constant */ - myConstTestField?: "constant-value"; + myConstTestField?: 'constant-value' /** @constant */ - myConstTestFieldNullable?: 4 | null; - } & { [key: string]: unknown }; - }; + myConstTestFieldNullable?: 4 | null + } & { [key: string]: unknown } + } } export interface operations {} diff --git a/test/v3/expected/consts-enums.exported-type.ts b/test/v3/expected/consts-enums.exported-type.ts index 30f5d3277..5309be645 100644 --- a/test/v3/expected/consts-enums.exported-type.ts +++ b/test/v3/expected/consts-enums.exported-type.ts @@ -4,32 +4,32 @@ */ export type paths = { - "/test": { + '/test': { get: { responses: { /** A list of types. */ - 200: unknown; - }; - }; - }; -}; + 200: unknown + } + } + } +} export type components = { schemas: { /** @description Enum with null and nullable */ MyType: { /** @enum {string|null} */ - myEnumTestFieldNullable?: ("foo" | "bar" | null) | null; + myEnumTestFieldNullable?: ('foo' | 'bar' | null) | null /** @enum {string|null} */ - myEnumTestField?: ("foo" | "bar" | null) | null; + myEnumTestField?: ('foo' | 'bar' | null) | null /** @constant */ - myConstTestField?: "constant-value"; + myConstTestField?: 'constant-value' /** @constant */ - myConstTestFieldNullable?: 4 | null; - }; - }; -}; + myConstTestFieldNullable?: 4 | null + } + } +} -export type operations = {}; +export type operations = {} -export type external = {}; +export type external = {} diff --git a/test/v3/expected/consts-enums.immutable.ts b/test/v3/expected/consts-enums.immutable.ts index 9e28f4a7e..fb74450dd 100644 --- a/test/v3/expected/consts-enums.immutable.ts +++ b/test/v3/expected/consts-enums.immutable.ts @@ -4,14 +4,14 @@ */ export interface paths { - readonly "/test": { + readonly '/test': { readonly get: { readonly responses: { /** A list of types. */ - readonly 200: unknown; - }; - }; - }; + readonly 200: unknown + } + } + } } export interface components { @@ -19,15 +19,15 @@ export interface components { /** @description Enum with null and nullable */ readonly MyType: { /** @enum {string|null} */ - readonly myEnumTestFieldNullable?: ("foo" | "bar" | null) | null; + readonly myEnumTestFieldNullable?: ('foo' | 'bar' | null) | null /** @enum {string|null} */ - readonly myEnumTestField?: ("foo" | "bar" | null) | null; + readonly myEnumTestField?: ('foo' | 'bar' | null) | null /** @constant */ - readonly myConstTestField?: "constant-value"; + readonly myConstTestField?: 'constant-value' /** @constant */ - readonly myConstTestFieldNullable?: 4 | null; - }; - }; + readonly myConstTestFieldNullable?: 4 | null + } + } } export interface operations {} diff --git a/test/v3/expected/consts-enums.support-array-length.ts b/test/v3/expected/consts-enums.support-array-length.ts index 4e92ffe8c..3e101dba4 100644 --- a/test/v3/expected/consts-enums.support-array-length.ts +++ b/test/v3/expected/consts-enums.support-array-length.ts @@ -4,14 +4,14 @@ */ export interface paths { - "/test": { + '/test': { get: { responses: { /** A list of types. */ - 200: unknown; - }; - }; - }; + 200: unknown + } + } + } } export interface components { @@ -19,15 +19,15 @@ export interface components { /** @description Enum with null and nullable */ MyType: { /** @enum {string|null} */ - myEnumTestFieldNullable?: ("foo" | "bar" | null) | null; + myEnumTestFieldNullable?: ('foo' | 'bar' | null) | null /** @enum {string|null} */ - myEnumTestField?: ("foo" | "bar" | null) | null; + myEnumTestField?: ('foo' | 'bar' | null) | null /** @constant */ - myConstTestField?: "constant-value"; + myConstTestField?: 'constant-value' /** @constant */ - myConstTestFieldNullable?: 4 | null; - }; - }; + myConstTestFieldNullable?: 4 | null + } + } } export interface operations {} diff --git a/test/v3/expected/consts-enums.ts b/test/v3/expected/consts-enums.ts index 4e92ffe8c..3e101dba4 100644 --- a/test/v3/expected/consts-enums.ts +++ b/test/v3/expected/consts-enums.ts @@ -4,14 +4,14 @@ */ export interface paths { - "/test": { + '/test': { get: { responses: { /** A list of types. */ - 200: unknown; - }; - }; - }; + 200: unknown + } + } + } } export interface components { @@ -19,15 +19,15 @@ export interface components { /** @description Enum with null and nullable */ MyType: { /** @enum {string|null} */ - myEnumTestFieldNullable?: ("foo" | "bar" | null) | null; + myEnumTestFieldNullable?: ('foo' | 'bar' | null) | null /** @enum {string|null} */ - myEnumTestField?: ("foo" | "bar" | null) | null; + myEnumTestField?: ('foo' | 'bar' | null) | null /** @constant */ - myConstTestField?: "constant-value"; + myConstTestField?: 'constant-value' /** @constant */ - myConstTestFieldNullable?: 4 | null; - }; - }; + myConstTestFieldNullable?: 4 | null + } + } } export interface operations {} diff --git a/test/v3/expected/consts-object.additional.ts b/test/v3/expected/consts-object.additional.ts index e861af666..c751d605f 100644 --- a/test/v3/expected/consts-object.additional.ts +++ b/test/v3/expected/consts-object.additional.ts @@ -4,23 +4,23 @@ */ export interface paths { - "/test": { + '/test': { get: { responses: { /** A list of types. */ - 200: unknown; - }; - }; - }; + 200: unknown + } + } + } } export interface components { schemas: { /** @constant */ - TypeA: { hello: "world" }; + TypeA: { hello: 'world' } /** @constant */ - TypeB: ["content"]; - }; + TypeB: ['content'] + } } export interface operations {} diff --git a/test/v3/expected/consts-object.exported-type.ts b/test/v3/expected/consts-object.exported-type.ts index b234dfce9..34a7a6550 100644 --- a/test/v3/expected/consts-object.exported-type.ts +++ b/test/v3/expected/consts-object.exported-type.ts @@ -4,25 +4,25 @@ */ export type paths = { - "/test": { + '/test': { get: { responses: { /** A list of types. */ - 200: unknown; - }; - }; - }; -}; + 200: unknown + } + } + } +} export type components = { schemas: { /** @constant */ - TypeA: { hello: "world" }; + TypeA: { hello: 'world' } /** @constant */ - TypeB: ["content"]; - }; -}; + TypeB: ['content'] + } +} -export type operations = {}; +export type operations = {} -export type external = {}; +export type external = {} diff --git a/test/v3/expected/consts-object.immutable.ts b/test/v3/expected/consts-object.immutable.ts index 888f07960..af92e9810 100644 --- a/test/v3/expected/consts-object.immutable.ts +++ b/test/v3/expected/consts-object.immutable.ts @@ -4,23 +4,23 @@ */ export interface paths { - readonly "/test": { + readonly '/test': { readonly get: { readonly responses: { /** A list of types. */ - readonly 200: unknown; - }; - }; - }; + readonly 200: unknown + } + } + } } export interface components { readonly schemas: { /** @constant */ - readonly TypeA: { hello: "world" }; + readonly TypeA: { hello: 'world' } /** @constant */ - readonly TypeB: ["content"]; - }; + readonly TypeB: ['content'] + } } export interface operations {} diff --git a/test/v3/expected/consts-object.support-array-length.ts b/test/v3/expected/consts-object.support-array-length.ts index e861af666..c751d605f 100644 --- a/test/v3/expected/consts-object.support-array-length.ts +++ b/test/v3/expected/consts-object.support-array-length.ts @@ -4,23 +4,23 @@ */ export interface paths { - "/test": { + '/test': { get: { responses: { /** A list of types. */ - 200: unknown; - }; - }; - }; + 200: unknown + } + } + } } export interface components { schemas: { /** @constant */ - TypeA: { hello: "world" }; + TypeA: { hello: 'world' } /** @constant */ - TypeB: ["content"]; - }; + TypeB: ['content'] + } } export interface operations {} diff --git a/test/v3/expected/consts-object.ts b/test/v3/expected/consts-object.ts index e861af666..c751d605f 100644 --- a/test/v3/expected/consts-object.ts +++ b/test/v3/expected/consts-object.ts @@ -4,23 +4,23 @@ */ export interface paths { - "/test": { + '/test': { get: { responses: { /** A list of types. */ - 200: unknown; - }; - }; - }; + 200: unknown + } + } + } } export interface components { schemas: { /** @constant */ - TypeA: { hello: "world" }; + TypeA: { hello: 'world' } /** @constant */ - TypeB: ["content"]; - }; + TypeB: ['content'] + } } export interface operations {} diff --git a/test/v3/expected/github.additional.ts b/test/v3/expected/github.additional.ts index 7ba7ff53a..c327ff78a 100644 --- a/test/v3/expected/github.additional.ts +++ b/test/v3/expected/github.additional.ts @@ -4,152 +4,152 @@ */ export interface paths { - "/": { + '/': { /** Get Hypermedia links to resources accessible in GitHub's REST API */ - get: operations["meta/root"]; - }; - "/app": { + get: operations['meta/root'] + } + '/app': { /** * Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/rest/reference/apps#list-installations-for-the-authenticated-app)" endpoint. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - get: operations["apps/get-authenticated"]; - }; - "/app-manifests/{code}/conversions": { + get: operations['apps/get-authenticated'] + } + '/app-manifests/{code}/conversions': { /** Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. */ - post: operations["apps/create-from-manifest"]; - }; - "/app/hook/config": { + post: operations['apps/create-from-manifest'] + } + '/app/hook/config': { /** * Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - get: operations["apps/get-webhook-config-for-app"]; + get: operations['apps/get-webhook-config-for-app'] /** * Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - patch: operations["apps/update-webhook-config-for-app"]; - }; - "/app/hook/deliveries": { + patch: operations['apps/update-webhook-config-for-app'] + } + '/app/hook/deliveries': { /** * Returns a list of webhook deliveries for the webhook configured for a GitHub App. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - get: operations["apps/list-webhook-deliveries"]; - }; - "/app/hook/deliveries/{delivery_id}": { + get: operations['apps/list-webhook-deliveries'] + } + '/app/hook/deliveries/{delivery_id}': { /** * Returns a delivery for the webhook configured for a GitHub App. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - get: operations["apps/get-webhook-delivery"]; - }; - "/app/hook/deliveries/{delivery_id}/attempts": { + get: operations['apps/get-webhook-delivery'] + } + '/app/hook/deliveries/{delivery_id}/attempts': { /** * Redeliver a delivery for the webhook configured for a GitHub App. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - post: operations["apps/redeliver-webhook-delivery"]; - }; - "/app/installations": { + post: operations['apps/redeliver-webhook-delivery'] + } + '/app/installations': { /** * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. * * The permissions the installation has are included under the `permissions` key. */ - get: operations["apps/list-installations"]; - }; - "/app/installations/{installation_id}": { + get: operations['apps/list-installations'] + } + '/app/installations/{installation_id}': { /** * Enables an authenticated GitHub App to find an installation's information using the installation id. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - get: operations["apps/get-installation"]; + get: operations['apps/get-installation'] /** * Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/reference/apps/#suspend-an-app-installation)" endpoint. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - delete: operations["apps/delete-installation"]; - }; - "/app/installations/{installation_id}/access_tokens": { + delete: operations['apps/delete-installation'] + } + '/app/installations/{installation_id}/access_tokens': { /** * Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - post: operations["apps/create-installation-access-token"]; - }; - "/app/installations/{installation_id}/suspended": { + post: operations['apps/create-installation-access-token'] + } + '/app/installations/{installation_id}/suspended': { /** * Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - put: operations["apps/suspend-installation"]; + put: operations['apps/suspend-installation'] /** * Removes a GitHub App installation suspension. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - delete: operations["apps/unsuspend-installation"]; - }; - "/applications/grants": { + delete: operations['apps/unsuspend-installation'] + } + '/applications/grants': { /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * * You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/rest/reference/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `["repo", "user"]`. */ - get: operations["oauth-authorizations/list-grants"]; - }; - "/applications/grants/{grant_id}": { + get: operations['oauth-authorizations/list-grants'] + } + '/applications/grants/{grant_id}': { /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - get: operations["oauth-authorizations/get-grant"]; + get: operations['oauth-authorizations/get-grant'] /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ - delete: operations["oauth-authorizations/delete-grant"]; - }; - "/applications/{client_id}/grant": { + delete: operations['oauth-authorizations/delete-grant'] + } + '/applications/{client_id}/grant': { /** * OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ - delete: operations["apps/delete-authorization"]; - }; - "/applications/{client_id}/token": { + delete: operations['apps/delete-authorization'] + } + '/applications/{client_id}/token': { /** OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the OAuth application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`. */ - post: operations["apps/check-token"]; + post: operations['apps/check-token'] /** OAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. */ - delete: operations["apps/delete-token"]; + delete: operations['apps/delete-token'] /** OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. */ - patch: operations["apps/reset-token"]; - }; - "/applications/{client_id}/token/scoped": { + patch: operations['apps/reset-token'] + } + '/applications/{client_id}/token/scoped': { /** Use a non-scoped user-to-server OAuth access token to create a repository scoped and/or permission scoped user-to-server OAuth access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. */ - post: operations["apps/scope-token"]; - }; - "/apps/{app_slug}": { + post: operations['apps/scope-token'] + } + '/apps/{app_slug}': { /** * **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). * * If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ - get: operations["apps/get-by-slug"]; - }; - "/authorizations": { + get: operations['apps/get-by-slug'] + } + '/authorizations': { /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - get: operations["oauth-authorizations/list-authorizations"]; + get: operations['oauth-authorizations/list-authorizations'] /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * @@ -163,9 +163,9 @@ export interface paths { * * Organizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in [the GitHub Help documentation](https://docs.github.com/articles/about-identity-and-access-management-with-saml-single-sign-on). */ - post: operations["oauth-authorizations/create-authorization"]; - }; - "/authorizations/clients/{client_id}": { + post: operations['oauth-authorizations/create-authorization'] + } + '/authorizations/clients/{client_id}': { /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * @@ -177,9 +177,9 @@ export interface paths { * * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - put: operations["oauth-authorizations/get-or-create-authorization-for-app"]; - }; - "/authorizations/clients/{client_id}/{fingerprint}": { + put: operations['oauth-authorizations/get-or-create-authorization-for-app'] + } + '/authorizations/clients/{client_id}/{fingerprint}': { /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * @@ -189,13 +189,13 @@ export interface paths { * * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." */ - put: operations["oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint"]; - }; - "/authorizations/{authorization_id}": { + put: operations['oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint'] + } + '/authorizations/{authorization_id}': { /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - get: operations["oauth-authorizations/get-authorization"]; + get: operations['oauth-authorizations/get-authorization'] /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - delete: operations["oauth-authorizations/delete-authorization"]; + delete: operations['oauth-authorizations/delete-authorization'] /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * @@ -203,182 +203,182 @@ export interface paths { * * You can only send one of these scope keys at a time. */ - patch: operations["oauth-authorizations/update-authorization"]; - }; - "/codes_of_conduct": { - get: operations["codes-of-conduct/get-all-codes-of-conduct"]; - }; - "/codes_of_conduct/{key}": { - get: operations["codes-of-conduct/get-conduct-code"]; - }; - "/emojis": { + patch: operations['oauth-authorizations/update-authorization'] + } + '/codes_of_conduct': { + get: operations['codes-of-conduct/get-all-codes-of-conduct'] + } + '/codes_of_conduct/{key}': { + get: operations['codes-of-conduct/get-conduct-code'] + } + '/emojis': { /** Lists all the emojis available to use on GitHub. */ - get: operations["emojis/get"]; - }; - "/enterprises/{enterprise}/actions/permissions": { + get: operations['emojis/get'] + } + '/enterprises/{enterprise}/actions/permissions': { /** * Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - get: operations["enterprise-admin/get-github-actions-permissions-enterprise"]; + get: operations['enterprise-admin/get-github-actions-permissions-enterprise'] /** * Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - put: operations["enterprise-admin/set-github-actions-permissions-enterprise"]; - }; - "/enterprises/{enterprise}/actions/permissions/organizations": { + put: operations['enterprise-admin/set-github-actions-permissions-enterprise'] + } + '/enterprises/{enterprise}/actions/permissions/organizations': { /** * Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - get: operations["enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise"]; + get: operations['enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise'] /** * Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - put: operations["enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise"]; - }; - "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}": { + put: operations['enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise'] + } + '/enterprises/{enterprise}/actions/permissions/organizations/{org_id}': { /** * Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - put: operations["enterprise-admin/enable-selected-organization-github-actions-enterprise"]; + put: operations['enterprise-admin/enable-selected-organization-github-actions-enterprise'] /** * Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - delete: operations["enterprise-admin/disable-selected-organization-github-actions-enterprise"]; - }; - "/enterprises/{enterprise}/actions/permissions/selected-actions": { + delete: operations['enterprise-admin/disable-selected-organization-github-actions-enterprise'] + } + '/enterprises/{enterprise}/actions/permissions/selected-actions': { /** * Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - get: operations["enterprise-admin/get-allowed-actions-enterprise"]; + get: operations['enterprise-admin/get-allowed-actions-enterprise'] /** * Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - put: operations["enterprise-admin/set-allowed-actions-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runner-groups": { + put: operations['enterprise-admin/set-allowed-actions-enterprise'] + } + '/enterprises/{enterprise}/actions/runner-groups': { /** * Lists all self-hosted runner groups for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - get: operations["enterprise-admin/list-self-hosted-runner-groups-for-enterprise"]; + get: operations['enterprise-admin/list-self-hosted-runner-groups-for-enterprise'] /** * Creates a new self-hosted runner group for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - post: operations["enterprise-admin/create-self-hosted-runner-group-for-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}": { + post: operations['enterprise-admin/create-self-hosted-runner-group-for-enterprise'] + } + '/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}': { /** * Gets a specific self-hosted runner group for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - get: operations["enterprise-admin/get-self-hosted-runner-group-for-enterprise"]; + get: operations['enterprise-admin/get-self-hosted-runner-group-for-enterprise'] /** * Deletes a self-hosted runner group for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - delete: operations["enterprise-admin/delete-self-hosted-runner-group-from-enterprise"]; + delete: operations['enterprise-admin/delete-self-hosted-runner-group-from-enterprise'] /** * Updates the `name` and `visibility` of a self-hosted runner group in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - patch: operations["enterprise-admin/update-self-hosted-runner-group-for-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations": { + patch: operations['enterprise-admin/update-self-hosted-runner-group-for-enterprise'] + } + '/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations': { /** * Lists the organizations with access to a self-hosted runner group. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - get: operations["enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise"]; + get: operations['enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise'] /** * Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - put: operations["enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}": { + put: operations['enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise'] + } + '/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}': { /** * Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - put: operations["enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise"]; + put: operations['enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise'] /** * Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - delete: operations["enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": { + delete: operations['enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise'] + } + '/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners': { /** * Lists the self-hosted runners that are in a specific enterprise group. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - get: operations["enterprise-admin/list-self-hosted-runners-in-group-for-enterprise"]; + get: operations['enterprise-admin/list-self-hosted-runners-in-group-for-enterprise'] /** * Replaces the list of self-hosted runners that are part of an enterprise runner group. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - put: operations["enterprise-admin/set-self-hosted-runners-in-group-for-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + put: operations['enterprise-admin/set-self-hosted-runners-in-group-for-enterprise'] + } + '/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}': { /** * Adds a self-hosted runner to a runner group configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` * scope to use this endpoint. */ - put: operations["enterprise-admin/add-self-hosted-runner-to-group-for-enterprise"]; + put: operations['enterprise-admin/add-self-hosted-runner-to-group-for-enterprise'] /** * Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - delete: operations["enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runners": { + delete: operations['enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise'] + } + '/enterprises/{enterprise}/actions/runners': { /** * Lists all self-hosted runners configured for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - get: operations["enterprise-admin/list-self-hosted-runners-for-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runners/downloads": { + get: operations['enterprise-admin/list-self-hosted-runners-for-enterprise'] + } + '/enterprises/{enterprise}/actions/runners/downloads': { /** * Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - get: operations["enterprise-admin/list-runner-applications-for-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runners/registration-token": { + get: operations['enterprise-admin/list-runner-applications-for-enterprise'] + } + '/enterprises/{enterprise}/actions/runners/registration-token': { /** * Returns a token that you can pass to the `config` script. The token expires after one hour. * @@ -392,9 +392,9 @@ export interface paths { * ./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN * ``` */ - post: operations["enterprise-admin/create-registration-token-for-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runners/remove-token": { + post: operations['enterprise-admin/create-registration-token-for-enterprise'] + } + '/enterprises/{enterprise}/actions/runners/remove-token': { /** * Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour. * @@ -409,51 +409,51 @@ export interface paths { * ./config.sh remove --token TOKEN * ``` */ - post: operations["enterprise-admin/create-remove-token-for-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runners/{runner_id}": { + post: operations['enterprise-admin/create-remove-token-for-enterprise'] + } + '/enterprises/{enterprise}/actions/runners/{runner_id}': { /** * Gets a specific self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - get: operations["enterprise-admin/get-self-hosted-runner-for-enterprise"]; + get: operations['enterprise-admin/get-self-hosted-runner-for-enterprise'] /** * Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - delete: operations["enterprise-admin/delete-self-hosted-runner-from-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runners/{runner_id}/labels": { + delete: operations['enterprise-admin/delete-self-hosted-runner-from-enterprise'] + } + '/enterprises/{enterprise}/actions/runners/{runner_id}/labels': { /** * Lists all labels for a self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - get: operations["enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise"]; + get: operations['enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise'] /** * Remove all previous custom labels and set the new custom labels for a specific * self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - put: operations["enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise"]; + put: operations['enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise'] /** * Add custom labels to a self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - post: operations["enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise"]; + post: operations['enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise'] /** * Remove all custom labels from a self-hosted runner configured in an * enterprise. Returns the remaining read-only labels from the runner. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - delete: operations["enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runners/{runner_id}/labels/{name}": { + delete: operations['enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise'] + } + '/enterprises/{enterprise}/actions/runners/{runner_id}/labels/{name}': { /** * Remove a custom label from a self-hosted runner configured * in an enterprise. Returns the remaining labels from the runner. @@ -463,20 +463,20 @@ export interface paths { * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - delete: operations["enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise"]; - }; - "/enterprises/{enterprise}/audit-log": { + delete: operations['enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise'] + } + '/enterprises/{enterprise}/audit-log': { /** Gets the audit log for an enterprise. To use this endpoint, you must be an enterprise admin, and you must use an access token with the `admin:enterprise` scope. */ - get: operations["enterprise-admin/get-audit-log"]; - }; - "/enterprises/{enterprise}/secret-scanning/alerts": { + get: operations['enterprise-admin/get-audit-log'] + } + '/enterprises/{enterprise}/secret-scanning/alerts': { /** * Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. * To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). */ - get: operations["secret-scanning/list-alerts-for-enterprise"]; - }; - "/enterprises/{enterprise}/settings/billing/actions": { + get: operations['secret-scanning/list-alerts-for-enterprise'] + } + '/enterprises/{enterprise}/settings/billing/actions': { /** * Gets the summary of the free and paid GitHub Actions minutes used. * @@ -484,16 +484,16 @@ export interface paths { * * The authenticated user must be an enterprise admin. */ - get: operations["billing/get-github-actions-billing-ghe"]; - }; - "/enterprises/{enterprise}/settings/billing/advanced-security": { + get: operations['billing/get-github-actions-billing-ghe'] + } + '/enterprises/{enterprise}/settings/billing/advanced-security': { /** * Gets the GitHub Advanced Security active committers for an enterprise per repository. * Each distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of active_users for each repository. */ - get: operations["billing/get-github-advanced-security-billing-ghe"]; - }; - "/enterprises/{enterprise}/settings/billing/packages": { + get: operations['billing/get-github-advanced-security-billing-ghe'] + } + '/enterprises/{enterprise}/settings/billing/packages': { /** * Gets the free and paid storage used for GitHub Packages in gigabytes. * @@ -501,9 +501,9 @@ export interface paths { * * The authenticated user must be an enterprise admin. */ - get: operations["billing/get-github-packages-billing-ghe"]; - }; - "/enterprises/{enterprise}/settings/billing/shared-storage": { + get: operations['billing/get-github-packages-billing-ghe'] + } + '/enterprises/{enterprise}/settings/billing/shared-storage': { /** * Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. * @@ -511,13 +511,13 @@ export interface paths { * * The authenticated user must be an enterprise admin. */ - get: operations["billing/get-shared-storage-billing-ghe"]; - }; - "/events": { + get: operations['billing/get-shared-storage-billing-ghe'] + } + '/events': { /** We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. */ - get: operations["activity/list-public-events"]; - }; - "/feeds": { + get: operations['activity/list-public-events'] + } + '/feeds': { /** * GitHub provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user: * @@ -531,82 +531,82 @@ export interface paths { * * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ - get: operations["activity/get-feeds"]; - }; - "/gists": { + get: operations['activity/get-feeds'] + } + '/gists': { /** Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists: */ - get: operations["gists/list"]; + get: operations['gists/list'] /** * Allows you to add a new gist with one or more files. * * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. */ - post: operations["gists/create"]; - }; - "/gists/public": { + post: operations['gists/create'] + } + '/gists/public': { /** * List public gists sorted by most recently updated to least recently updated. * * Note: With [pagination](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. */ - get: operations["gists/list-public"]; - }; - "/gists/starred": { + get: operations['gists/list-public'] + } + '/gists/starred': { /** List the authenticated user's starred gists: */ - get: operations["gists/list-starred"]; - }; - "/gists/{gist_id}": { - get: operations["gists/get"]; - delete: operations["gists/delete"]; + get: operations['gists/list-starred'] + } + '/gists/{gist_id}': { + get: operations['gists/get'] + delete: operations['gists/delete'] /** Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged. */ - patch: operations["gists/update"]; - }; - "/gists/{gist_id}/comments": { - get: operations["gists/list-comments"]; - post: operations["gists/create-comment"]; - }; - "/gists/{gist_id}/comments/{comment_id}": { - get: operations["gists/get-comment"]; - delete: operations["gists/delete-comment"]; - patch: operations["gists/update-comment"]; - }; - "/gists/{gist_id}/commits": { - get: operations["gists/list-commits"]; - }; - "/gists/{gist_id}/forks": { - get: operations["gists/list-forks"]; + patch: operations['gists/update'] + } + '/gists/{gist_id}/comments': { + get: operations['gists/list-comments'] + post: operations['gists/create-comment'] + } + '/gists/{gist_id}/comments/{comment_id}': { + get: operations['gists/get-comment'] + delete: operations['gists/delete-comment'] + patch: operations['gists/update-comment'] + } + '/gists/{gist_id}/commits': { + get: operations['gists/list-commits'] + } + '/gists/{gist_id}/forks': { + get: operations['gists/list-forks'] /** **Note**: This was previously `/gists/:gist_id/fork`. */ - post: operations["gists/fork"]; - }; - "/gists/{gist_id}/star": { - get: operations["gists/check-is-starred"]; + post: operations['gists/fork'] + } + '/gists/{gist_id}/star': { + get: operations['gists/check-is-starred'] /** Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - put: operations["gists/star"]; - delete: operations["gists/unstar"]; - }; - "/gists/{gist_id}/{sha}": { - get: operations["gists/get-revision"]; - }; - "/gitignore/templates": { + put: operations['gists/star'] + delete: operations['gists/unstar'] + } + '/gists/{gist_id}/{sha}': { + get: operations['gists/get-revision'] + } + '/gitignore/templates': { /** List all templates available to pass as an option when [creating a repository](https://docs.github.com/rest/reference/repos#create-a-repository-for-the-authenticated-user). */ - get: operations["gitignore/get-all-templates"]; - }; - "/gitignore/templates/{name}": { + get: operations['gitignore/get-all-templates'] + } + '/gitignore/templates/{name}': { /** * The API also allows fetching the source of a single template. * Use the raw [media type](https://docs.github.com/rest/overview/media-types/) to get the raw contents. */ - get: operations["gitignore/get-template"]; - }; - "/installation/repositories": { + get: operations['gitignore/get-template'] + } + '/installation/repositories': { /** * List repositories that an app installation can access. * * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ - get: operations["apps/list-repos-accessible-to-installation"]; - }; - "/installation/token": { + get: operations['apps/list-repos-accessible-to-installation'] + } + '/installation/token': { /** * Revokes the installation token you're using to authenticate as an installation and access this endpoint. * @@ -614,9 +614,9 @@ export interface paths { * * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ - delete: operations["apps/revoke-installation-access-token"]; - }; - "/issues": { + delete: operations['apps/revoke-installation-access-token'] + } + '/issues': { /** * List issues assigned to the authenticated user across all visible repositories including owned repositories, member * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not @@ -628,97 +628,97 @@ export interface paths { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - get: operations["issues/list"]; - }; - "/licenses": { - get: operations["licenses/get-all-commonly-used"]; - }; - "/licenses/{license}": { - get: operations["licenses/get"]; - }; - "/markdown": { - post: operations["markdown/render"]; - }; - "/markdown/raw": { + get: operations['issues/list'] + } + '/licenses': { + get: operations['licenses/get-all-commonly-used'] + } + '/licenses/{license}': { + get: operations['licenses/get'] + } + '/markdown': { + post: operations['markdown/render'] + } + '/markdown/raw': { /** You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less. */ - post: operations["markdown/render-raw"]; - }; - "/marketplace_listing/accounts/{account_id}": { + post: operations['markdown/render-raw'] + } + '/marketplace_listing/accounts/{account_id}': { /** * Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - get: operations["apps/get-subscription-plan-for-account"]; - }; - "/marketplace_listing/plans": { + get: operations['apps/get-subscription-plan-for-account'] + } + '/marketplace_listing/plans': { /** * Lists all plans that are part of your GitHub Marketplace listing. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - get: operations["apps/list-plans"]; - }; - "/marketplace_listing/plans/{plan_id}/accounts": { + get: operations['apps/list-plans'] + } + '/marketplace_listing/plans/{plan_id}/accounts': { /** * Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - get: operations["apps/list-accounts-for-plan"]; - }; - "/marketplace_listing/stubbed/accounts/{account_id}": { + get: operations['apps/list-accounts-for-plan'] + } + '/marketplace_listing/stubbed/accounts/{account_id}': { /** * Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - get: operations["apps/get-subscription-plan-for-account-stubbed"]; - }; - "/marketplace_listing/stubbed/plans": { + get: operations['apps/get-subscription-plan-for-account-stubbed'] + } + '/marketplace_listing/stubbed/plans': { /** * Lists all plans that are part of your GitHub Marketplace listing. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - get: operations["apps/list-plans-stubbed"]; - }; - "/marketplace_listing/stubbed/plans/{plan_id}/accounts": { + get: operations['apps/list-plans-stubbed'] + } + '/marketplace_listing/stubbed/plans/{plan_id}/accounts': { /** * Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - get: operations["apps/list-accounts-for-plan-stubbed"]; - }; - "/meta": { + get: operations['apps/list-accounts-for-plan-stubbed'] + } + '/meta': { /** * Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://docs.github.com/articles/about-github-s-ip-addresses/)." * * **Note:** The IP addresses shown in the documentation's response are only example values. You must always query the API directly to get the latest list of IP addresses. */ - get: operations["meta/get"]; - }; - "/networks/{owner}/{repo}/events": { - get: operations["activity/list-public-events-for-repo-network"]; - }; - "/notifications": { + get: operations['meta/get'] + } + '/networks/{owner}/{repo}/events': { + get: operations['activity/list-public-events-for-repo-network'] + } + '/notifications': { /** List all notifications for the current user, sorted by most recently updated. */ - get: operations["activity/list-notifications-for-authenticated-user"]; + get: operations['activity/list-notifications-for-authenticated-user'] /** Marks all notifications as "read" removes it from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ - put: operations["activity/mark-notifications-as-read"]; - }; - "/notifications/threads/{thread_id}": { - get: operations["activity/get-thread"]; - patch: operations["activity/mark-thread-as-read"]; - }; - "/notifications/threads/{thread_id}/subscription": { + put: operations['activity/mark-notifications-as-read'] + } + '/notifications/threads/{thread_id}': { + get: operations['activity/get-thread'] + patch: operations['activity/mark-thread-as-read'] + } + '/notifications/threads/{thread_id}/subscription': { /** * This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/rest/reference/activity#get-a-repository-subscription). * * Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. */ - get: operations["activity/get-thread-subscription-for-authenticated-user"]; + get: operations['activity/get-thread-subscription-for-authenticated-user'] /** * If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**. * @@ -726,60 +726,60 @@ export interface paths { * * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/rest/reference/activity#delete-a-thread-subscription) endpoint. */ - put: operations["activity/set-thread-subscription"]; + put: operations['activity/set-thread-subscription'] /** Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/rest/reference/activity#set-a-thread-subscription) endpoint and set `ignore` to `true`. */ - delete: operations["activity/delete-thread-subscription"]; - }; - "/octocat": { + delete: operations['activity/delete-thread-subscription'] + } + '/octocat': { /** Get the octocat as ASCII art */ - get: operations["meta/get-octocat"]; - }; - "/organizations": { + get: operations['meta/get-octocat'] + } + '/organizations': { /** * Lists all organizations, in the order that they were created on GitHub. * * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of organizations. */ - get: operations["orgs/list"]; - }; - "/organizations/{organization_id}/custom_roles": { + get: operations['orgs/list'] + } + '/organizations/{organization_id}/custom_roles': { /** * List the custom repository roles available in this organization. In order to see custom * repository roles in an organization, the authenticated user must be an organization owner. * * For more information on custom repository roles, see "[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)". */ - get: operations["orgs/list-custom-roles"]; - }; - "/organizations/{org}/team/{team_slug}/external-groups": { + get: operations['orgs/list-custom-roles'] + } + '/organizations/{org}/team/{team_slug}/external-groups': { /** * Lists a connection between a team and an external group. * * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ - get: operations["teams/list-linked-external-idp-groups-to-team-for-org"]; - }; - "/orgs/{org}": { + get: operations['teams/list-linked-external-idp-groups-to-team-for-org'] + } + '/orgs/{org}': { /** * To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). * * GitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub plan. See "[Authenticating with GitHub Apps](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/)" for details. For an example response, see 'Response with GitHub plan information' below." */ - get: operations["orgs/get"]; + get: operations['orgs/get'] /** * **Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). * * Enables an authenticated organization owner with the `admin:org` scope to update the organization's profile and member privileges. */ - patch: operations["orgs/update"]; - }; - "/orgs/{org}/actions/permissions": { + patch: operations['orgs/update'] + } + '/orgs/{org}/actions/permissions': { /** * Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - get: operations["actions/get-github-actions-permissions-organization"]; + get: operations['actions/get-github-actions-permissions-organization'] /** * Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization. * @@ -787,43 +787,43 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - put: operations["actions/set-github-actions-permissions-organization"]; - }; - "/orgs/{org}/actions/permissions/repositories": { + put: operations['actions/set-github-actions-permissions-organization'] + } + '/orgs/{org}/actions/permissions/repositories': { /** * Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - get: operations["actions/list-selected-repositories-enabled-github-actions-organization"]; + get: operations['actions/list-selected-repositories-enabled-github-actions-organization'] /** * Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - put: operations["actions/set-selected-repositories-enabled-github-actions-organization"]; - }; - "/orgs/{org}/actions/permissions/repositories/{repository_id}": { + put: operations['actions/set-selected-repositories-enabled-github-actions-organization'] + } + '/orgs/{org}/actions/permissions/repositories/{repository_id}': { /** * Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - put: operations["actions/enable-selected-repository-github-actions-organization"]; + put: operations['actions/enable-selected-repository-github-actions-organization'] /** * Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - delete: operations["actions/disable-selected-repository-github-actions-organization"]; - }; - "/orgs/{org}/actions/permissions/selected-actions": { + delete: operations['actions/disable-selected-repository-github-actions-organization'] + } + '/orgs/{org}/actions/permissions/selected-actions': { /** * Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."" * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - get: operations["actions/get-allowed-actions-organization"]; + get: operations['actions/get-allowed-actions-organization'] /** * Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * @@ -833,25 +833,25 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - put: operations["actions/set-allowed-actions-organization"]; - }; - "/orgs/{org}/actions/permissions/workflow": { + put: operations['actions/set-allowed-actions-organization'] + } + '/orgs/{org}/actions/permissions/workflow': { /** * Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, * as well if GitHub Actions can submit approving pull request reviews. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - get: operations["actions/get-github-actions-default-workflow-permissions-organization"]; + get: operations['actions/get-github-actions-default-workflow-permissions-organization'] /** * Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions * can submit approving pull request reviews. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - put: operations["actions/set-github-actions-default-workflow-permissions-organization"]; - }; - "/orgs/{org}/actions/runner-groups": { + put: operations['actions/set-github-actions-default-workflow-permissions-organization'] + } + '/orgs/{org}/actions/runner-groups': { /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -859,7 +859,7 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - get: operations["actions/list-self-hosted-runner-groups-for-org"]; + get: operations['actions/list-self-hosted-runner-groups-for-org'] /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -867,9 +867,9 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - post: operations["actions/create-self-hosted-runner-group-for-org"]; - }; - "/orgs/{org}/actions/runner-groups/{runner_group_id}": { + post: operations['actions/create-self-hosted-runner-group-for-org'] + } + '/orgs/{org}/actions/runner-groups/{runner_group_id}': { /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -877,7 +877,7 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - get: operations["actions/get-self-hosted-runner-group-for-org"]; + get: operations['actions/get-self-hosted-runner-group-for-org'] /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -885,7 +885,7 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - delete: operations["actions/delete-self-hosted-runner-group-from-org"]; + delete: operations['actions/delete-self-hosted-runner-group-from-org'] /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -893,9 +893,9 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - patch: operations["actions/update-self-hosted-runner-group-for-org"]; - }; - "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": { + patch: operations['actions/update-self-hosted-runner-group-for-org'] + } + '/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories': { /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -903,7 +903,7 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - get: operations["actions/list-repo-access-to-self-hosted-runner-group-in-org"]; + get: operations['actions/list-repo-access-to-self-hosted-runner-group-in-org'] /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -911,9 +911,9 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - put: operations["actions/set-repo-access-to-self-hosted-runner-group-in-org"]; - }; - "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": { + put: operations['actions/set-repo-access-to-self-hosted-runner-group-in-org'] + } + '/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}': { /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -923,7 +923,7 @@ export interface paths { * You must authenticate using an access token with the `admin:org` * scope to use this endpoint. */ - put: operations["actions/add-repo-access-to-self-hosted-runner-group-in-org"]; + put: operations['actions/add-repo-access-to-self-hosted-runner-group-in-org'] /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -932,9 +932,9 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - delete: operations["actions/remove-repo-access-to-self-hosted-runner-group-in-org"]; - }; - "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners": { + delete: operations['actions/remove-repo-access-to-self-hosted-runner-group-in-org'] + } + '/orgs/{org}/actions/runner-groups/{runner_group_id}/runners': { /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -942,7 +942,7 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - get: operations["actions/list-self-hosted-runners-in-group-for-org"]; + get: operations['actions/list-self-hosted-runners-in-group-for-org'] /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -950,9 +950,9 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - put: operations["actions/set-self-hosted-runners-in-group-for-org"]; - }; - "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + put: operations['actions/set-self-hosted-runners-in-group-for-org'] + } + '/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}': { /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -962,7 +962,7 @@ export interface paths { * You must authenticate using an access token with the `admin:org` * scope to use this endpoint. */ - put: operations["actions/add-self-hosted-runner-to-group-for-org"]; + put: operations['actions/add-self-hosted-runner-to-group-for-org'] /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -971,25 +971,25 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - delete: operations["actions/remove-self-hosted-runner-from-group-for-org"]; - }; - "/orgs/{org}/actions/runners": { + delete: operations['actions/remove-self-hosted-runner-from-group-for-org'] + } + '/orgs/{org}/actions/runners': { /** * Lists all self-hosted runners configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - get: operations["actions/list-self-hosted-runners-for-org"]; - }; - "/orgs/{org}/actions/runners/downloads": { + get: operations['actions/list-self-hosted-runners-for-org'] + } + '/orgs/{org}/actions/runners/downloads': { /** * Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - get: operations["actions/list-runner-applications-for-org"]; - }; - "/orgs/{org}/actions/runners/registration-token": { + get: operations['actions/list-runner-applications-for-org'] + } + '/orgs/{org}/actions/runners/registration-token': { /** * Returns a token that you can pass to the `config` script. The token expires after one hour. * @@ -1003,9 +1003,9 @@ export interface paths { * ./config.sh --url https://github.com/octo-org --token TOKEN * ``` */ - post: operations["actions/create-registration-token-for-org"]; - }; - "/orgs/{org}/actions/runners/remove-token": { + post: operations['actions/create-registration-token-for-org'] + } + '/orgs/{org}/actions/runners/remove-token': { /** * Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour. * @@ -1020,51 +1020,51 @@ export interface paths { * ./config.sh remove --token TOKEN * ``` */ - post: operations["actions/create-remove-token-for-org"]; - }; - "/orgs/{org}/actions/runners/{runner_id}": { + post: operations['actions/create-remove-token-for-org'] + } + '/orgs/{org}/actions/runners/{runner_id}': { /** * Gets a specific self-hosted runner configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - get: operations["actions/get-self-hosted-runner-for-org"]; + get: operations['actions/get-self-hosted-runner-for-org'] /** * Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - delete: operations["actions/delete-self-hosted-runner-from-org"]; - }; - "/orgs/{org}/actions/runners/{runner_id}/labels": { + delete: operations['actions/delete-self-hosted-runner-from-org'] + } + '/orgs/{org}/actions/runners/{runner_id}/labels': { /** * Lists all labels for a self-hosted runner configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - get: operations["actions/list-labels-for-self-hosted-runner-for-org"]; + get: operations['actions/list-labels-for-self-hosted-runner-for-org'] /** * Remove all previous custom labels and set the new custom labels for a specific * self-hosted runner configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - put: operations["actions/set-custom-labels-for-self-hosted-runner-for-org"]; + put: operations['actions/set-custom-labels-for-self-hosted-runner-for-org'] /** * Add custom labels to a self-hosted runner configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - post: operations["actions/add-custom-labels-to-self-hosted-runner-for-org"]; + post: operations['actions/add-custom-labels-to-self-hosted-runner-for-org'] /** * Remove all custom labels from a self-hosted runner configured in an * organization. Returns the remaining read-only labels from the runner. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - delete: operations["actions/remove-all-custom-labels-from-self-hosted-runner-for-org"]; - }; - "/orgs/{org}/actions/runners/{runner_id}/labels/{name}": { + delete: operations['actions/remove-all-custom-labels-from-self-hosted-runner-for-org'] + } + '/orgs/{org}/actions/runners/{runner_id}/labels/{name}': { /** * Remove a custom label from a self-hosted runner configured * in an organization. Returns the remaining labels from the runner. @@ -1074,19 +1074,19 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - delete: operations["actions/remove-custom-label-from-self-hosted-runner-for-org"]; - }; - "/orgs/{org}/actions/secrets": { + delete: operations['actions/remove-custom-label-from-self-hosted-runner-for-org'] + } + '/orgs/{org}/actions/secrets': { /** Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - get: operations["actions/list-org-secrets"]; - }; - "/orgs/{org}/actions/secrets/public-key": { + get: operations['actions/list-org-secrets'] + } + '/orgs/{org}/actions/secrets/public-key': { /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - get: operations["actions/get-org-public-key"]; - }; - "/orgs/{org}/actions/secrets/{secret_name}": { + get: operations['actions/get-org-public-key'] + } + '/orgs/{org}/actions/secrets/{secret_name}': { /** Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - get: operations["actions/get-org-secret"]; + get: operations['actions/get-org-secret'] /** * Creates or updates an organization secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -1164,40 +1164,40 @@ export interface paths { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - put: operations["actions/create-or-update-org-secret"]; + put: operations['actions/create-or-update-org-secret'] /** Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - delete: operations["actions/delete-org-secret"]; - }; - "/orgs/{org}/actions/secrets/{secret_name}/repositories": { + delete: operations['actions/delete-org-secret'] + } + '/orgs/{org}/actions/secrets/{secret_name}/repositories': { /** Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - get: operations["actions/list-selected-repos-for-org-secret"]; + get: operations['actions/list-selected-repos-for-org-secret'] /** Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - put: operations["actions/set-selected-repos-for-org-secret"]; - }; - "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}": { + put: operations['actions/set-selected-repos-for-org-secret'] + } + '/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}': { /** Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - put: operations["actions/add-selected-repo-to-org-secret"]; + put: operations['actions/add-selected-repo-to-org-secret'] /** Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - delete: operations["actions/remove-selected-repo-from-org-secret"]; - }; - "/orgs/{org}/audit-log": { + delete: operations['actions/remove-selected-repo-from-org-secret'] + } + '/orgs/{org}/audit-log': { /** * Gets the audit log for an organization. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization)." * * This endpoint is available for organizations on GitHub Enterprise Cloud. To use this endpoint, you must be an organization owner, and you must use an access token with the `admin:org` scope. GitHub Apps must have the `organization_administration` read permission to use this endpoint. */ - get: operations["orgs/get-audit-log"]; - }; - "/orgs/{org}/blocks": { + get: operations['orgs/get-audit-log'] + } + '/orgs/{org}/blocks': { /** List the users blocked by an organization. */ - get: operations["orgs/list-blocked-users"]; - }; - "/orgs/{org}/blocks/{username}": { - get: operations["orgs/check-blocked-user"]; - put: operations["orgs/block-user"]; - delete: operations["orgs/unblock-user"]; - }; - "/orgs/{org}/code-scanning/alerts": { + get: operations['orgs/list-blocked-users'] + } + '/orgs/{org}/blocks/{username}': { + get: operations['orgs/check-blocked-user'] + put: operations['orgs/block-user'] + delete: operations['orgs/unblock-user'] + } + '/orgs/{org}/code-scanning/alerts': { /** * Lists all code scanning alerts for the default branch (usually `main` * or `master`) for all eligible repositories in an organization. @@ -1205,35 +1205,35 @@ export interface paths { * * GitHub Apps must have the `security_events` read permission to use this endpoint. */ - get: operations["code-scanning/list-alerts-for-org"]; - }; - "/orgs/{org}/credential-authorizations": { + get: operations['code-scanning/list-alerts-for-org'] + } + '/orgs/{org}/credential-authorizations': { /** * Listing and deleting credential authorizations is available to organizations with GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products). * * An authenticated organization owner with the `read:org` scope can list all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials are either personal access tokens or SSH keys that organization members have authorized for the organization. For more information, see [About authentication with SAML single sign-on](https://docs.github.com/en/articles/about-authentication-with-saml-single-sign-on). */ - get: operations["orgs/list-saml-sso-authorizations"]; - }; - "/orgs/{org}/credential-authorizations/{credential_id}": { + get: operations['orgs/list-saml-sso-authorizations'] + } + '/orgs/{org}/credential-authorizations/{credential_id}': { /** * Listing and deleting credential authorizations is available to organizations with GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products). * * An authenticated organization owner with the `admin:org` scope can remove a credential authorization for an organization that uses SAML SSO. Once you remove someone's credential authorization, they will need to create a new personal access token or SSH key and authorize it for the organization they want to access. */ - delete: operations["orgs/remove-saml-sso-authorization"]; - }; - "/orgs/{org}/dependabot/secrets": { + delete: operations['orgs/remove-saml-sso-authorization'] + } + '/orgs/{org}/dependabot/secrets': { /** Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - get: operations["dependabot/list-org-secrets"]; - }; - "/orgs/{org}/dependabot/secrets/public-key": { + get: operations['dependabot/list-org-secrets'] + } + '/orgs/{org}/dependabot/secrets/public-key': { /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - get: operations["dependabot/get-org-public-key"]; - }; - "/orgs/{org}/dependabot/secrets/{secret_name}": { + get: operations['dependabot/get-org-public-key'] + } + '/orgs/{org}/dependabot/secrets/{secret_name}': { /** Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - get: operations["dependabot/get-org-secret"]; + get: operations['dependabot/get-org-secret'] /** * Creates or updates an organization secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -1311,130 +1311,130 @@ export interface paths { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - put: operations["dependabot/create-or-update-org-secret"]; + put: operations['dependabot/create-or-update-org-secret'] /** Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - delete: operations["dependabot/delete-org-secret"]; - }; - "/orgs/{org}/dependabot/secrets/{secret_name}/repositories": { + delete: operations['dependabot/delete-org-secret'] + } + '/orgs/{org}/dependabot/secrets/{secret_name}/repositories': { /** Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - get: operations["dependabot/list-selected-repos-for-org-secret"]; + get: operations['dependabot/list-selected-repos-for-org-secret'] /** Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - put: operations["dependabot/set-selected-repos-for-org-secret"]; - }; - "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}": { + put: operations['dependabot/set-selected-repos-for-org-secret'] + } + '/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}': { /** Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - put: operations["dependabot/add-selected-repo-to-org-secret"]; + put: operations['dependabot/add-selected-repo-to-org-secret'] /** Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - delete: operations["dependabot/remove-selected-repo-from-org-secret"]; - }; - "/orgs/{org}/events": { - get: operations["activity/list-public-org-events"]; - }; - "/orgs/{org}/external-group/{group_id}": { + delete: operations['dependabot/remove-selected-repo-from-org-secret'] + } + '/orgs/{org}/events': { + get: operations['activity/list-public-org-events'] + } + '/orgs/{org}/external-group/{group_id}': { /** * Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to. * * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ - get: operations["teams/external-idp-group-info-for-org"]; - }; - "/orgs/{org}/external-groups": { + get: operations['teams/external-idp-group-info-for-org'] + } + '/orgs/{org}/external-groups': { /** * Lists external groups available in an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." * * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ - get: operations["teams/list-external-idp-groups-for-org"]; - }; - "/orgs/{org}/failed_invitations": { + get: operations['teams/list-external-idp-groups-for-org'] + } + '/orgs/{org}/failed_invitations': { /** The return hash contains `failed_at` and `failed_reason` fields which represent the time at which the invitation failed and the reason for the failure. */ - get: operations["orgs/list-failed-invitations"]; - }; - "/orgs/{org}/hooks": { - get: operations["orgs/list-webhooks"]; + get: operations['orgs/list-failed-invitations'] + } + '/orgs/{org}/hooks': { + get: operations['orgs/list-webhooks'] /** Here's how you can create a hook that posts payloads in JSON format: */ - post: operations["orgs/create-webhook"]; - }; - "/orgs/{org}/hooks/{hook_id}": { + post: operations['orgs/create-webhook'] + } + '/orgs/{org}/hooks/{hook_id}': { /** Returns a webhook configured in an organization. To get only the webhook `config` properties, see "[Get a webhook configuration for an organization](/rest/reference/orgs#get-a-webhook-configuration-for-an-organization)." */ - get: operations["orgs/get-webhook"]; - delete: operations["orgs/delete-webhook"]; + get: operations['orgs/get-webhook'] + delete: operations['orgs/delete-webhook'] /** Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for an organization](/rest/reference/orgs#update-a-webhook-configuration-for-an-organization)." */ - patch: operations["orgs/update-webhook"]; - }; - "/orgs/{org}/hooks/{hook_id}/config": { + patch: operations['orgs/update-webhook'] + } + '/orgs/{org}/hooks/{hook_id}/config': { /** * Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/reference/orgs#get-an-organization-webhook)." * * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission. */ - get: operations["orgs/get-webhook-config-for-org"]; + get: operations['orgs/get-webhook-config-for-org'] /** * Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/reference/orgs#update-an-organization-webhook)." * * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission. */ - patch: operations["orgs/update-webhook-config-for-org"]; - }; - "/orgs/{org}/hooks/{hook_id}/deliveries": { + patch: operations['orgs/update-webhook-config-for-org'] + } + '/orgs/{org}/hooks/{hook_id}/deliveries': { /** Returns a list of webhook deliveries for a webhook configured in an organization. */ - get: operations["orgs/list-webhook-deliveries"]; - }; - "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": { + get: operations['orgs/list-webhook-deliveries'] + } + '/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}': { /** Returns a delivery for a webhook configured in an organization. */ - get: operations["orgs/get-webhook-delivery"]; - }; - "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { + get: operations['orgs/get-webhook-delivery'] + } + '/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts': { /** Redeliver a delivery for a webhook configured in an organization. */ - post: operations["orgs/redeliver-webhook-delivery"]; - }; - "/orgs/{org}/hooks/{hook_id}/pings": { + post: operations['orgs/redeliver-webhook-delivery'] + } + '/orgs/{org}/hooks/{hook_id}/pings': { /** This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. */ - post: operations["orgs/ping-webhook"]; - }; - "/orgs/{org}/installation": { + post: operations['orgs/ping-webhook'] + } + '/orgs/{org}/installation': { /** * Enables an authenticated GitHub App to find the organization's installation information. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - get: operations["apps/get-org-installation"]; - }; - "/orgs/{org}/installations": { + get: operations['apps/get-org-installation'] + } + '/orgs/{org}/installations': { /** Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint. */ - get: operations["orgs/list-app-installations"]; - }; - "/orgs/{org}/interaction-limits": { + get: operations['orgs/list-app-installations'] + } + '/orgs/{org}/interaction-limits': { /** Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response. */ - get: operations["interactions/get-restrictions-for-org"]; + get: operations['interactions/get-restrictions-for-org'] /** Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization. */ - put: operations["interactions/set-restrictions-for-org"]; + put: operations['interactions/set-restrictions-for-org'] /** Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions. */ - delete: operations["interactions/remove-restrictions-for-org"]; - }; - "/orgs/{org}/invitations": { + delete: operations['interactions/remove-restrictions-for-org'] + } + '/orgs/{org}/invitations': { /** The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. */ - get: operations["orgs/list-pending-invitations"]; + get: operations['orgs/list-pending-invitations'] /** * Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - post: operations["orgs/create-invitation"]; - }; - "/orgs/{org}/invitations/{invitation_id}": { + post: operations['orgs/create-invitation'] + } + '/orgs/{org}/invitations/{invitation_id}': { /** * Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). */ - delete: operations["orgs/cancel-invitation"]; - }; - "/orgs/{org}/invitations/{invitation_id}/teams": { + delete: operations['orgs/cancel-invitation'] + } + '/orgs/{org}/invitations/{invitation_id}/teams': { /** List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner. */ - get: operations["orgs/list-invitation-teams"]; - }; - "/orgs/{org}/issues": { + get: operations['orgs/list-invitation-teams'] + } + '/orgs/{org}/issues': { /** * List issues in an organization assigned to the authenticated user. * @@ -1443,21 +1443,21 @@ export interface paths { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - get: operations["issues/list-for-org"]; - }; - "/orgs/{org}/members": { + get: operations['issues/list-for-org'] + } + '/orgs/{org}/members': { /** List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned. */ - get: operations["orgs/list-members"]; - }; - "/orgs/{org}/members/{username}": { + get: operations['orgs/list-members'] + } + '/orgs/{org}/members/{username}': { /** Check if a user is, publicly or privately, a member of the organization. */ - get: operations["orgs/check-membership-for-user"]; + get: operations['orgs/check-membership-for-user'] /** Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories. */ - delete: operations["orgs/remove-member"]; - }; - "/orgs/{org}/memberships/{username}": { + delete: operations['orgs/remove-member'] + } + '/orgs/{org}/memberships/{username}': { /** In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status. */ - get: operations["orgs/get-membership-for-user"]; + get: operations['orgs/get-membership-for-user'] /** * Only authenticated organization owners can add a member to the organization or update the member's role. * @@ -1469,21 +1469,21 @@ export interface paths { * * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. */ - put: operations["orgs/set-membership-for-user"]; + put: operations['orgs/set-membership-for-user'] /** * In order to remove a user's membership with an organization, the authenticated user must be an organization owner. * * If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases. */ - delete: operations["orgs/remove-membership-for-user"]; - }; - "/orgs/{org}/migrations": { + delete: operations['orgs/remove-membership-for-user'] + } + '/orgs/{org}/migrations': { /** Lists the most recent migrations. */ - get: operations["migrations/list-for-org"]; + get: operations['migrations/list-for-org'] /** Initiates the generation of a migration archive. */ - post: operations["migrations/start-for-org"]; - }; - "/orgs/{org}/migrations/{migration_id}": { + post: operations['migrations/start-for-org'] + } + '/orgs/{org}/migrations/{migration_id}': { /** * Fetches the status of a migration. * @@ -1494,49 +1494,49 @@ export interface paths { * * `exported`, which means the migration finished successfully. * * `failed`, which means the migration failed. */ - get: operations["migrations/get-status-for-org"]; - }; - "/orgs/{org}/migrations/{migration_id}/archive": { + get: operations['migrations/get-status-for-org'] + } + '/orgs/{org}/migrations/{migration_id}/archive': { /** Fetches the URL to a migration archive. */ - get: operations["migrations/download-archive-for-org"]; + get: operations['migrations/download-archive-for-org'] /** Deletes a previous migration archive. Migration archives are automatically deleted after seven days. */ - delete: operations["migrations/delete-archive-for-org"]; - }; - "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock": { + delete: operations['migrations/delete-archive-for-org'] + } + '/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock': { /** Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/rest/reference/repos#delete-a-repository) when the migration is complete and you no longer need the source data. */ - delete: operations["migrations/unlock-repo-for-org"]; - }; - "/orgs/{org}/migrations/{migration_id}/repositories": { + delete: operations['migrations/unlock-repo-for-org'] + } + '/orgs/{org}/migrations/{migration_id}/repositories': { /** List all the repositories for this organization migration. */ - get: operations["migrations/list-repos-for-org"]; - }; - "/orgs/{org}/outside_collaborators": { + get: operations['migrations/list-repos-for-org'] + } + '/orgs/{org}/outside_collaborators': { /** List all users who are outside collaborators of an organization. */ - get: operations["orgs/list-outside-collaborators"]; - }; - "/orgs/{org}/outside_collaborators/{username}": { + get: operations['orgs/list-outside-collaborators'] + } + '/orgs/{org}/outside_collaborators/{username}': { /** When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://docs.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)". */ - put: operations["orgs/convert-member-to-outside-collaborator"]; + put: operations['orgs/convert-member-to-outside-collaborator'] /** Removing a user from this list will remove them from all the organization's repositories. */ - delete: operations["orgs/remove-outside-collaborator"]; - }; - "/orgs/{org}/packages": { + delete: operations['orgs/remove-outside-collaborator'] + } + '/orgs/{org}/packages': { /** * Lists all packages in an organization readable by the user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/list-packages-for-organization"]; - }; - "/orgs/{org}/packages/{package_type}/{package_name}": { + get: operations['packages/list-packages-for-organization'] + } + '/orgs/{org}/packages/{package_type}/{package_name}': { /** * Gets a specific package in an organization. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/get-package-for-organization"]; + get: operations['packages/get-package-for-organization'] /** * Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * @@ -1544,9 +1544,9 @@ export interface paths { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. */ - delete: operations["packages/delete-package-for-org"]; - }; - "/orgs/{org}/packages/{package_type}/{package_name}/restore": { + delete: operations['packages/delete-package-for-org'] + } + '/orgs/{org}/packages/{package_type}/{package_name}/restore': { /** * Restores an entire package in an organization. * @@ -1558,25 +1558,25 @@ export interface paths { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. */ - post: operations["packages/restore-package-for-org"]; - }; - "/orgs/{org}/packages/{package_type}/{package_name}/versions": { + post: operations['packages/restore-package-for-org'] + } + '/orgs/{org}/packages/{package_type}/{package_name}/versions': { /** * Returns all package versions for a package owned by an organization. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/get-all-package-versions-for-package-owned-by-org"]; - }; - "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}": { + get: operations['packages/get-all-package-versions-for-package-owned-by-org'] + } + '/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}': { /** * Gets a specific package version in an organization. * * You must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/get-package-version-for-organization"]; + get: operations['packages/get-package-version-for-organization'] /** * Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * @@ -1584,9 +1584,9 @@ export interface paths { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. */ - delete: operations["packages/delete-package-version-for-org"]; - }; - "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { + delete: operations['packages/delete-package-version-for-org'] + } + '/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore': { /** * Restores a specific package version in an organization. * @@ -1598,31 +1598,31 @@ export interface paths { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. */ - post: operations["packages/restore-package-version-for-org"]; - }; - "/orgs/{org}/projects": { + post: operations['packages/restore-package-version-for-org'] + } + '/orgs/{org}/projects': { /** Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - get: operations["projects/list-for-org"]; + get: operations['projects/list-for-org'] /** Creates an organization project board. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - post: operations["projects/create-for-org"]; - }; - "/orgs/{org}/public_members": { + post: operations['projects/create-for-org'] + } + '/orgs/{org}/public_members': { /** Members of an organization can choose to have their membership publicized or not. */ - get: operations["orgs/list-public-members"]; - }; - "/orgs/{org}/public_members/{username}": { - get: operations["orgs/check-public-membership-for-user"]; + get: operations['orgs/list-public-members'] + } + '/orgs/{org}/public_members/{username}': { + get: operations['orgs/check-public-membership-for-user'] /** * The user can publicize their own membership. (A user cannot publicize the membership for another user.) * * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - put: operations["orgs/set-public-membership-for-authenticated-user"]; - delete: operations["orgs/remove-public-membership-for-authenticated-user"]; - }; - "/orgs/{org}/repos": { + put: operations['orgs/set-public-membership-for-authenticated-user'] + delete: operations['orgs/remove-public-membership-for-authenticated-user'] + } + '/orgs/{org}/repos': { /** Lists repositories for the specified organization. */ - get: operations["repos/list-for-org"]; + get: operations['repos/list-for-org'] /** * Creates a new repository in the specified organization. The authenticated user must be a member of the organization. * @@ -1633,18 +1633,18 @@ export interface paths { * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. * * `repo` scope to create a private repository */ - post: operations["repos/create-in-org"]; - }; - "/orgs/{org}/secret-scanning/alerts": { + post: operations['repos/create-in-org'] + } + '/orgs/{org}/secret-scanning/alerts': { /** * Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest. * To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. */ - get: operations["secret-scanning/list-alerts-for-org"]; - }; - "/orgs/{org}/settings/billing/actions": { + get: operations['secret-scanning/list-alerts-for-org'] + } + '/orgs/{org}/settings/billing/actions': { /** * Gets the summary of the free and paid GitHub Actions minutes used. * @@ -1652,17 +1652,17 @@ export interface paths { * * Access tokens must have the `repo` or `admin:org` scope. */ - get: operations["billing/get-github-actions-billing-org"]; - }; - "/orgs/{org}/settings/billing/advanced-security": { + get: operations['billing/get-github-actions-billing-org'] + } + '/orgs/{org}/settings/billing/advanced-security': { /** * Gets the GitHub Advanced Security active committers for an organization per repository. * Each distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of advanced_security_committers for each repository. * If this organization defers to an enterprise for billing, the total_advanced_security_committers returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level. */ - get: operations["billing/get-github-advanced-security-billing-org"]; - }; - "/orgs/{org}/settings/billing/packages": { + get: operations['billing/get-github-advanced-security-billing-org'] + } + '/orgs/{org}/settings/billing/packages': { /** * Gets the free and paid storage used for GitHub Packages in gigabytes. * @@ -1670,9 +1670,9 @@ export interface paths { * * Access tokens must have the `repo` or `admin:org` scope. */ - get: operations["billing/get-github-packages-billing-org"]; - }; - "/orgs/{org}/settings/billing/shared-storage": { + get: operations['billing/get-github-packages-billing-org'] + } + '/orgs/{org}/settings/billing/shared-storage': { /** * Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. * @@ -1680,33 +1680,33 @@ export interface paths { * * Access tokens must have the `repo` or `admin:org` scope. */ - get: operations["billing/get-shared-storage-billing-org"]; - }; - "/orgs/{org}/team-sync/groups": { + get: operations['billing/get-shared-storage-billing-org'] + } + '/orgs/{org}/team-sync/groups': { /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * List IdP groups available in an organization. You can limit your page results using the `per_page` parameter. GitHub generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." */ - get: operations["teams/list-idp-groups-for-org"]; - }; - "/orgs/{org}/teams": { + get: operations['teams/list-idp-groups-for-org'] + } + '/orgs/{org}/teams': { /** Lists all teams in an organization that are visible to the authenticated user. */ - get: operations["teams/list"]; + get: operations['teams/list'] /** * To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://docs.github.com/en/articles/setting-team-creation-permissions-in-your-organization)." * * When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)". */ - post: operations["teams/create"]; - }; - "/orgs/{org}/teams/{team_slug}": { + post: operations['teams/create'] + } + '/orgs/{org}/teams/{team_slug}': { /** * Gets a team using the team's `slug`. GitHub generates the `slug` from the team `name`. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. */ - get: operations["teams/get-by-name"]; + get: operations['teams/get-by-name'] /** * To delete a team, the authenticated user must be an organization owner or team maintainer. * @@ -1714,21 +1714,21 @@ export interface paths { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. */ - delete: operations["teams/delete-in-org"]; + delete: operations['teams/delete-in-org'] /** * To edit a team, the authenticated user must either be an organization owner or a team maintainer. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. */ - patch: operations["teams/update-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/discussions": { + patch: operations['teams/update-in-org'] + } + '/orgs/{org}/teams/{team_slug}/discussions': { /** * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. */ - get: operations["teams/list-discussions-in-org"]; + get: operations['teams/list-discussions-in-org'] /** * Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @@ -1736,35 +1736,35 @@ export interface paths { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. */ - post: operations["teams/create-discussion-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": { + post: operations['teams/create-discussion-in-org'] + } + '/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}': { /** * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. */ - get: operations["teams/get-discussion-in-org"]; + get: operations['teams/get-discussion-in-org'] /** * Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. */ - delete: operations["teams/delete-discussion-in-org"]; + delete: operations['teams/delete-discussion-in-org'] /** * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. */ - patch: operations["teams/update-discussion-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": { + patch: operations['teams/update-discussion-in-org'] + } + '/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments': { /** * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. */ - get: operations["teams/list-discussion-comments-in-org"]; + get: operations['teams/list-discussion-comments-in-org'] /** * Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @@ -1772,103 +1772,103 @@ export interface paths { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. */ - post: operations["teams/create-discussion-comment-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": { + post: operations['teams/create-discussion-comment-in-org'] + } + '/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}': { /** * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. */ - get: operations["teams/get-discussion-comment-in-org"]; + get: operations['teams/get-discussion-comment-in-org'] /** * Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. */ - delete: operations["teams/delete-discussion-comment-in-org"]; + delete: operations['teams/delete-discussion-comment-in-org'] /** * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. */ - patch: operations["teams/update-discussion-comment-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { + patch: operations['teams/update-discussion-comment-in-org'] + } + '/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions': { /** * List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments/). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. */ - get: operations["reactions/list-for-team-discussion-comment-in-org"]; + get: operations['reactions/list-for-team-discussion-comment-in-org'] /** * Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. */ - post: operations["reactions/create-for-team-discussion-comment-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { + post: operations['reactions/create-for-team-discussion-comment-in-org'] + } + '/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}': { /** * **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. * * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - delete: operations["reactions/delete-for-team-discussion-comment"]; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { + delete: operations['reactions/delete-for-team-discussion-comment'] + } + '/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions': { /** * List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. */ - get: operations["reactions/list-for-team-discussion-in-org"]; + get: operations['reactions/list-for-team-discussion-in-org'] /** * Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. */ - post: operations["reactions/create-for-team-discussion-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { + post: operations['reactions/create-for-team-discussion-in-org'] + } + '/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}': { /** * **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. * * Delete a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - delete: operations["reactions/delete-for-team-discussion"]; - }; - "/orgs/{org}/teams/{team_slug}/external-groups": { + delete: operations['reactions/delete-for-team-discussion'] + } + '/orgs/{org}/teams/{team_slug}/external-groups': { /** * Deletes a connection between a team and an external group. * * You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - delete: operations["teams/unlink-external-idp-group-from-team-for-org"]; + delete: operations['teams/unlink-external-idp-group-from-team-for-org'] /** * Creates a connection between a team and an external group. Only one external group can be linked to a team. * * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ - patch: operations["teams/link-external-idp-group-to-team-for-org"]; - }; - "/orgs/{org}/teams/{team_slug}/invitations": { + patch: operations['teams/link-external-idp-group-to-team-for-org'] + } + '/orgs/{org}/teams/{team_slug}/invitations': { /** * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. */ - get: operations["teams/list-pending-invitations-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/members": { + get: operations['teams/list-pending-invitations-in-org'] + } + '/orgs/{org}/teams/{team_slug}/members': { /** * Team members will include the members of child teams. * * To list members in a team, the team must be visible to the authenticated user. */ - get: operations["teams/list-members-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/memberships/{username}": { + get: operations['teams/list-members-in-org'] + } + '/orgs/{org}/teams/{team_slug}/memberships/{username}': { /** * Team members will include the members of child teams. * @@ -1881,7 +1881,7 @@ export interface paths { * * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team). */ - get: operations["teams/get-membership-for-user-in-org"]; + get: operations['teams/get-membership-for-user-in-org'] /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -1895,7 +1895,7 @@ export interface paths { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ - put: operations["teams/add-or-update-membership-for-user-in-org"]; + put: operations['teams/add-or-update-membership-for-user-in-org'] /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -1905,45 +1905,45 @@ export interface paths { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ - delete: operations["teams/remove-membership-for-user-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/projects": { + delete: operations['teams/remove-membership-for-user-in-org'] + } + '/orgs/{org}/teams/{team_slug}/projects': { /** * Lists the organization projects for a team. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. */ - get: operations["teams/list-projects-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { + get: operations['teams/list-projects-in-org'] + } + '/orgs/{org}/teams/{team_slug}/projects/{project_id}': { /** * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ - get: operations["teams/check-permissions-for-project-in-org"]; + get: operations['teams/check-permissions-for-project-in-org'] /** * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ - put: operations["teams/add-or-update-project-permissions-in-org"]; + put: operations['teams/add-or-update-project-permissions-in-org'] /** * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ - delete: operations["teams/remove-project-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/repos": { + delete: operations['teams/remove-project-in-org'] + } + '/orgs/{org}/teams/{team_slug}/repos': { /** * Lists a team's repositories visible to the authenticated user. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. */ - get: operations["teams/list-repos-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": { + get: operations['teams/list-repos-in-org'] + } + '/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}': { /** * Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. * @@ -1953,7 +1953,7 @@ export interface paths { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ - get: operations["teams/check-permissions-for-repo-in-org"]; + get: operations['teams/check-permissions-for-repo-in-org'] /** * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." * @@ -1961,15 +1961,15 @@ export interface paths { * * For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". */ - put: operations["teams/add-or-update-repo-permissions-in-org"]; + put: operations['teams/add-or-update-repo-permissions-in-org'] /** * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ - delete: operations["teams/remove-repo-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/team-sync/group-mappings": { + delete: operations['teams/remove-repo-in-org'] + } + '/orgs/{org}/teams/{team_slug}/team-sync/group-mappings': { /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -1977,7 +1977,7 @@ export interface paths { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`. */ - get: operations["teams/list-idp-groups-in-org"]; + get: operations['teams/list-idp-groups-in-org'] /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -1985,131 +1985,131 @@ export interface paths { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`. */ - patch: operations["teams/create-or-update-idp-group-connections-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/teams": { + patch: operations['teams/create-or-update-idp-group-connections-in-org'] + } + '/orgs/{org}/teams/{team_slug}/teams': { /** * Lists the child teams of the team specified by `{team_slug}`. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. */ - get: operations["teams/list-child-in-org"]; - }; - "/projects/columns/cards/{card_id}": { - get: operations["projects/get-card"]; - delete: operations["projects/delete-card"]; - patch: operations["projects/update-card"]; - }; - "/projects/columns/cards/{card_id}/moves": { - post: operations["projects/move-card"]; - }; - "/projects/columns/{column_id}": { - get: operations["projects/get-column"]; - delete: operations["projects/delete-column"]; - patch: operations["projects/update-column"]; - }; - "/projects/columns/{column_id}/cards": { - get: operations["projects/list-cards"]; - post: operations["projects/create-card"]; - }; - "/projects/columns/{column_id}/moves": { - post: operations["projects/move-column"]; - }; - "/projects/{project_id}": { + get: operations['teams/list-child-in-org'] + } + '/projects/columns/cards/{card_id}': { + get: operations['projects/get-card'] + delete: operations['projects/delete-card'] + patch: operations['projects/update-card'] + } + '/projects/columns/cards/{card_id}/moves': { + post: operations['projects/move-card'] + } + '/projects/columns/{column_id}': { + get: operations['projects/get-column'] + delete: operations['projects/delete-column'] + patch: operations['projects/update-column'] + } + '/projects/columns/{column_id}/cards': { + get: operations['projects/list-cards'] + post: operations['projects/create-card'] + } + '/projects/columns/{column_id}/moves': { + post: operations['projects/move-column'] + } + '/projects/{project_id}': { /** Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - get: operations["projects/get"]; + get: operations['projects/get'] /** Deletes a project board. Returns a `404 Not Found` status if projects are disabled. */ - delete: operations["projects/delete"]; + delete: operations['projects/delete'] /** Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - patch: operations["projects/update"]; - }; - "/projects/{project_id}/collaborators": { + patch: operations['projects/update'] + } + '/projects/{project_id}/collaborators': { /** Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators. */ - get: operations["projects/list-collaborators"]; - }; - "/projects/{project_id}/collaborators/{username}": { + get: operations['projects/list-collaborators'] + } + '/projects/{project_id}/collaborators/{username}': { /** Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator. */ - put: operations["projects/add-collaborator"]; + put: operations['projects/add-collaborator'] /** Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator. */ - delete: operations["projects/remove-collaborator"]; - }; - "/projects/{project_id}/collaborators/{username}/permission": { + delete: operations['projects/remove-collaborator'] + } + '/projects/{project_id}/collaborators/{username}/permission': { /** Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level. */ - get: operations["projects/get-permission-for-user"]; - }; - "/projects/{project_id}/columns": { - get: operations["projects/list-columns"]; - post: operations["projects/create-column"]; - }; - "/rate_limit": { + get: operations['projects/get-permission-for-user'] + } + '/projects/{project_id}/columns': { + get: operations['projects/list-columns'] + post: operations['projects/create-column'] + } + '/rate_limit': { /** * **Note:** Accessing this endpoint does not count against your REST API rate limit. * * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. */ - get: operations["rate-limit/get"]; - }; - "/reactions/{reaction_id}": { + get: operations['rate-limit/get'] + } + '/reactions/{reaction_id}': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Reactions API. We recommend migrating your existing code to use the new delete reactions endpoints. For more information, see this [blog post](https://developer.github.com/changes/2020-02-26-new-delete-reactions-endpoints/). * * OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), when deleting a [team discussion](https://docs.github.com/rest/reference/teams#discussions) or [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). */ - delete: operations["reactions/delete-legacy"]; - }; - "/repos/{owner}/{repo}": { + delete: operations['reactions/delete-legacy'] + } + '/repos/{owner}/{repo}': { /** The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. */ - get: operations["repos/get"]; + get: operations['repos/get'] /** * Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required. * * If an organization owner has configured the organization to prevent members from deleting organization-owned * repositories, you will get a `403 Forbidden` response. */ - delete: operations["repos/delete"]; + delete: operations['repos/delete'] /** **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/rest/reference/repos#replace-all-repository-topics) endpoint. */ - patch: operations["repos/update"]; - }; - "/repos/{owner}/{repo}/actions/artifacts": { + patch: operations['repos/update'] + } + '/repos/{owner}/{repo}/actions/artifacts': { /** Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/list-artifacts-for-repo"]; - }; - "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}": { + get: operations['actions/list-artifacts-for-repo'] + } + '/repos/{owner}/{repo}/actions/artifacts/{artifact_id}': { /** Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/get-artifact"]; + get: operations['actions/get-artifact'] /** Deletes an artifact for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - delete: operations["actions/delete-artifact"]; - }; - "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}": { + delete: operations['actions/delete-artifact'] + } + '/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}': { /** * Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in * the response header to find the URL for the download. The `:archive_format` must be `zip`. Anyone with read access to * the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/download-artifact"]; - }; - "/repos/{owner}/{repo}/actions/jobs/{job_id}": { + get: operations['actions/download-artifact'] + } + '/repos/{owner}/{repo}/actions/jobs/{job_id}': { /** Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/get-job-for-workflow-run"]; - }; - "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs": { + get: operations['actions/get-job-for-workflow-run'] + } + '/repos/{owner}/{repo}/actions/jobs/{job_id}/logs': { /** * Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look * for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can * use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must * have the `actions:read` permission to use this endpoint. */ - get: operations["actions/download-job-logs-for-workflow-run"]; - }; - "/repos/{owner}/{repo}/actions/permissions": { + get: operations['actions/download-job-logs-for-workflow-run'] + } + '/repos/{owner}/{repo}/actions/permissions': { /** * Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository. * * You must authenticate using an access token with the `repo` scope to use this * endpoint. GitHub Apps must have the `administration` repository permission to use this API. */ - get: operations["actions/get-github-actions-permissions-repository"]; + get: operations['actions/get-github-actions-permissions-repository'] /** * Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository. * @@ -2117,15 +2117,15 @@ export interface paths { * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. */ - put: operations["actions/set-github-actions-permissions-repository"]; - }; - "/repos/{owner}/{repo}/actions/permissions/selected-actions": { + put: operations['actions/set-github-actions-permissions-repository'] + } + '/repos/{owner}/{repo}/actions/permissions/selected-actions': { /** * Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. */ - get: operations["actions/get-allowed-actions-repository"]; + get: operations['actions/get-allowed-actions-repository'] /** * Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." * @@ -2135,21 +2135,21 @@ export interface paths { * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. */ - put: operations["actions/set-allowed-actions-repository"]; - }; - "/repos/{owner}/{repo}/actions/runners": { + put: operations['actions/set-allowed-actions-repository'] + } + '/repos/{owner}/{repo}/actions/runners': { /** Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. */ - get: operations["actions/list-self-hosted-runners-for-repo"]; - }; - "/repos/{owner}/{repo}/actions/runners/downloads": { + get: operations['actions/list-self-hosted-runners-for-repo'] + } + '/repos/{owner}/{repo}/actions/runners/downloads': { /** * Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `repo` scope to use this endpoint. */ - get: operations["actions/list-runner-applications-for-repo"]; - }; - "/repos/{owner}/{repo}/actions/runners/registration-token": { + get: operations['actions/list-runner-applications-for-repo'] + } + '/repos/{owner}/{repo}/actions/runners/registration-token': { /** * Returns a token that you can pass to the `config` script. The token expires after one hour. You must authenticate * using an access token with the `repo` scope to use this endpoint. @@ -2162,9 +2162,9 @@ export interface paths { * ./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN * ``` */ - post: operations["actions/create-registration-token-for-repo"]; - }; - "/repos/{owner}/{repo}/actions/runners/remove-token": { + post: operations['actions/create-registration-token-for-repo'] + } + '/repos/{owner}/{repo}/actions/runners/remove-token': { /** * Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour. * You must authenticate using an access token with the `repo` scope to use this endpoint. @@ -2177,32 +2177,32 @@ export interface paths { * ./config.sh remove --token TOKEN * ``` */ - post: operations["actions/create-remove-token-for-repo"]; - }; - "/repos/{owner}/{repo}/actions/runners/{runner_id}": { + post: operations['actions/create-remove-token-for-repo'] + } + '/repos/{owner}/{repo}/actions/runners/{runner_id}': { /** * Gets a specific self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - get: operations["actions/get-self-hosted-runner-for-repo"]; + get: operations['actions/get-self-hosted-runner-for-repo'] /** * Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * * You must authenticate using an access token with the `repo` * scope to use this endpoint. */ - delete: operations["actions/delete-self-hosted-runner-from-repo"]; - }; - "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels": { + delete: operations['actions/delete-self-hosted-runner-from-repo'] + } + '/repos/{owner}/{repo}/actions/runners/{runner_id}/labels': { /** * Lists all labels for a self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - get: operations["actions/list-labels-for-self-hosted-runner-for-repo"]; + get: operations['actions/list-labels-for-self-hosted-runner-for-repo'] /** * Remove all previous custom labels and set the new custom labels for a specific * self-hosted runner configured in a repository. @@ -2210,14 +2210,14 @@ export interface paths { * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - put: operations["actions/set-custom-labels-for-self-hosted-runner-for-repo"]; + put: operations['actions/set-custom-labels-for-self-hosted-runner-for-repo'] /** * Add custom labels to a self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - post: operations["actions/add-custom-labels-to-self-hosted-runner-for-repo"]; + post: operations['actions/add-custom-labels-to-self-hosted-runner-for-repo'] /** * Remove all custom labels from a self-hosted runner configured in a * repository. Returns the remaining read-only labels from the runner. @@ -2225,9 +2225,9 @@ export interface paths { * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - delete: operations["actions/remove-all-custom-labels-from-self-hosted-runner-for-repo"]; - }; - "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}": { + delete: operations['actions/remove-all-custom-labels-from-self-hosted-runner-for-repo'] + } + '/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}': { /** * Remove a custom label from a self-hosted runner configured * in a repository. Returns the remaining labels from the runner. @@ -2238,120 +2238,120 @@ export interface paths { * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - delete: operations["actions/remove-custom-label-from-self-hosted-runner-for-repo"]; - }; - "/repos/{owner}/{repo}/actions/runs": { + delete: operations['actions/remove-custom-label-from-self-hosted-runner-for-repo'] + } + '/repos/{owner}/{repo}/actions/runs': { /** * Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). * * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/list-workflow-runs-for-repo"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}": { + get: operations['actions/list-workflow-runs-for-repo'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}': { /** Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/get-workflow-run"]; + get: operations['actions/get-workflow-run'] /** * Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is * private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:write` permission to use * this endpoint. */ - delete: operations["actions/delete-workflow-run"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/approvals": { + delete: operations['actions/delete-workflow-run'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/approvals': { /** Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/get-reviews-for-run"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/approve": { + get: operations['actions/get-reviews-for-run'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/approve': { /** * Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)." * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - post: operations["actions/approve-workflow-run"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts": { + post: operations['actions/approve-workflow-run'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts': { /** Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/list-workflow-run-artifacts"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}": { + get: operations['actions/list-workflow-run-artifacts'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}': { /** * Gets a specific workflow run attempt. Anyone with read access to the repository * can use this endpoint. If the repository is private you must use an access token * with the `repo` scope. GitHub Apps must have the `actions:read` permission to * use this endpoint. */ - get: operations["actions/get-workflow-run-attempt"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs": { + get: operations['actions/get-workflow-run-attempt'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs': { /** Lists jobs for a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). */ - get: operations["actions/list-jobs-for-workflow-run-attempt"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs": { + get: operations['actions/list-jobs-for-workflow-run-attempt'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs': { /** * Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after * 1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to * the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/download-workflow-run-attempt-logs"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": { + get: operations['actions/download-workflow-run-attempt-logs'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/cancel': { /** Cancels a workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - post: operations["actions/cancel-workflow-run"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": { + post: operations['actions/cancel-workflow-run'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/jobs': { /** Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). */ - get: operations["actions/list-jobs-for-workflow-run"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/logs": { + get: operations['actions/list-jobs-for-workflow-run'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/logs': { /** * Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for * `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use * this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have * the `actions:read` permission to use this endpoint. */ - get: operations["actions/download-workflow-run-logs"]; + get: operations['actions/download-workflow-run-logs'] /** Deletes all logs for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - delete: operations["actions/delete-workflow-run-logs"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments": { + delete: operations['actions/delete-workflow-run-logs'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments': { /** * Get all deployment environments for a workflow run that are waiting for protection rules to pass. * * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/get-pending-deployments-for-run"]; + get: operations['actions/get-pending-deployments-for-run'] /** * Approve or reject pending deployments that are waiting on approval by a required reviewer. * * Anyone with read access to the repository contents and deployments can use this endpoint. */ - post: operations["actions/review-pending-deployments-for-run"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun": { + post: operations['actions/review-pending-deployments-for-run'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/rerun': { /** Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - post: operations["actions/re-run-workflow"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/timing": { + post: operations['actions/re-run-workflow'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/timing': { /** * Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/get-workflow-run-usage"]; - }; - "/repos/{owner}/{repo}/actions/secrets": { + get: operations['actions/get-workflow-run-usage'] + } + '/repos/{owner}/{repo}/actions/secrets': { /** Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - get: operations["actions/list-repo-secrets"]; - }; - "/repos/{owner}/{repo}/actions/secrets/public-key": { + get: operations['actions/list-repo-secrets'] + } + '/repos/{owner}/{repo}/actions/secrets/public-key': { /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - get: operations["actions/get-repo-public-key"]; - }; - "/repos/{owner}/{repo}/actions/secrets/{secret_name}": { + get: operations['actions/get-repo-public-key'] + } + '/repos/{owner}/{repo}/actions/secrets/{secret_name}': { /** Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - get: operations["actions/get-repo-secret"]; + get: operations['actions/get-repo-secret'] /** * Creates or updates a repository secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -2429,27 +2429,27 @@ export interface paths { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - put: operations["actions/create-or-update-repo-secret"]; + put: operations['actions/create-or-update-repo-secret'] /** Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - delete: operations["actions/delete-repo-secret"]; - }; - "/repos/{owner}/{repo}/actions/workflows": { + delete: operations['actions/delete-repo-secret'] + } + '/repos/{owner}/{repo}/actions/workflows': { /** Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/list-repo-workflows"]; - }; - "/repos/{owner}/{repo}/actions/workflows/{workflow_id}": { + get: operations['actions/list-repo-workflows'] + } + '/repos/{owner}/{repo}/actions/workflows/{workflow_id}': { /** Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/get-workflow"]; - }; - "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable": { + get: operations['actions/get-workflow'] + } + '/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable': { /** * Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - put: operations["actions/disable-workflow"]; - }; - "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches": { + put: operations['actions/disable-workflow'] + } + '/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches': { /** * You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * @@ -2457,37 +2457,37 @@ export interface paths { * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)." */ - post: operations["actions/create-workflow-dispatch"]; - }; - "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable": { + post: operations['actions/create-workflow-dispatch'] + } + '/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable': { /** * Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - put: operations["actions/enable-workflow"]; - }; - "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { + put: operations['actions/enable-workflow'] + } + '/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs': { /** * List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). * * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. */ - get: operations["actions/list-workflow-runs"]; - }; - "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing": { + get: operations['actions/list-workflow-runs'] + } + '/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing': { /** * Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * * You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/get-workflow-usage"]; - }; - "/repos/{owner}/{repo}/assignees": { + get: operations['actions/get-workflow-usage'] + } + '/repos/{owner}/{repo}/assignees': { /** Lists the [available assignees](https://docs.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. */ - get: operations["issues/list-assignees"]; - }; - "/repos/{owner}/{repo}/assignees/{assignee}": { + get: operations['issues/list-assignees'] + } + '/repos/{owner}/{repo}/assignees/{assignee}': { /** * Checks if a user has permission to be assigned to an issue in this repository. * @@ -2495,47 +2495,47 @@ export interface paths { * * Otherwise a `404` status code is returned. */ - get: operations["issues/check-user-can-be-assigned"]; - }; - "/repos/{owner}/{repo}/autolinks": { + get: operations['issues/check-user-can-be-assigned'] + } + '/repos/{owner}/{repo}/autolinks': { /** * This returns a list of autolinks configured for the given repository. * * Information about autolinks are only available to repository administrators. */ - get: operations["repos/list-autolinks"]; + get: operations['repos/list-autolinks'] /** Users with admin access to the repository can create an autolink. */ - post: operations["repos/create-autolink"]; - }; - "/repos/{owner}/{repo}/autolinks/{autolink_id}": { + post: operations['repos/create-autolink'] + } + '/repos/{owner}/{repo}/autolinks/{autolink_id}': { /** * This returns a single autolink reference by ID that was configured for the given repository. * * Information about autolinks are only available to repository administrators. */ - get: operations["repos/get-autolink"]; + get: operations['repos/get-autolink'] /** * This deletes a single autolink reference by ID that was configured for the given repository. * * Information about autolinks are only available to repository administrators. */ - delete: operations["repos/delete-autolink"]; - }; - "/repos/{owner}/{repo}/automated-security-fixes": { + delete: operations['repos/delete-autolink'] + } + '/repos/{owner}/{repo}/automated-security-fixes': { /** Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/en/articles/configuring-automated-security-fixes)". */ - put: operations["repos/enable-automated-security-fixes"]; + put: operations['repos/enable-automated-security-fixes'] /** Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/en/articles/configuring-automated-security-fixes)". */ - delete: operations["repos/disable-automated-security-fixes"]; - }; - "/repos/{owner}/{repo}/branches": { - get: operations["repos/list-branches"]; - }; - "/repos/{owner}/{repo}/branches/{branch}": { - get: operations["repos/get-branch"]; - }; - "/repos/{owner}/{repo}/branches/{branch}/protection": { + delete: operations['repos/disable-automated-security-fixes'] + } + '/repos/{owner}/{repo}/branches': { + get: operations['repos/list-branches'] + } + '/repos/{owner}/{repo}/branches/{branch}': { + get: operations['repos/get-branch'] + } + '/repos/{owner}/{repo}/branches/{branch}/protection': { /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - get: operations["repos/get-branch-protection"]; + get: operations['repos/get-branch-protection'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2545,31 +2545,31 @@ export interface paths { * * **Note**: The list of users, apps, and teams in total is limited to 100 items. */ - put: operations["repos/update-branch-protection"]; + put: operations['repos/update-branch-protection'] /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - delete: operations["repos/delete-branch-protection"]; - }; - "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins": { + delete: operations['repos/delete-branch-protection'] + } + '/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins': { /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - get: operations["repos/get-admin-branch-protection"]; + get: operations['repos/get-admin-branch-protection'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ - post: operations["repos/set-admin-branch-protection"]; + post: operations['repos/set-admin-branch-protection'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ - delete: operations["repos/delete-admin-branch-protection"]; - }; - "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews": { + delete: operations['repos/delete-admin-branch-protection'] + } + '/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews': { /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - get: operations["repos/get-pull-request-review-protection"]; + get: operations['repos/get-pull-request-review-protection'] /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - delete: operations["repos/delete-pull-request-review-protection"]; + delete: operations['repos/delete-pull-request-review-protection'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2577,9 +2577,9 @@ export interface paths { * * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. */ - patch: operations["repos/update-pull-request-review-protection"]; - }; - "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures": { + patch: operations['repos/update-pull-request-review-protection'] + } + '/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures': { /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2587,43 +2587,43 @@ export interface paths { * * **Note**: You must enable branch protection to require signed commits. */ - get: operations["repos/get-commit-signature-protection"]; + get: operations['repos/get-commit-signature-protection'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits. */ - post: operations["repos/create-commit-signature-protection"]; + post: operations['repos/create-commit-signature-protection'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits. */ - delete: operations["repos/delete-commit-signature-protection"]; - }; - "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks": { + delete: operations['repos/delete-commit-signature-protection'] + } + '/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks': { /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - get: operations["repos/get-status-checks-protection"]; + get: operations['repos/get-status-checks-protection'] /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - delete: operations["repos/remove-status-check-protection"]; + delete: operations['repos/remove-status-check-protection'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. */ - patch: operations["repos/update-status-check-protection"]; - }; - "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts": { + patch: operations['repos/update-status-check-protection'] + } + '/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts': { /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - get: operations["repos/get-all-status-check-contexts"]; + get: operations['repos/get-all-status-check-contexts'] /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - put: operations["repos/set-status-check-contexts"]; + put: operations['repos/set-status-check-contexts'] /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - post: operations["repos/add-status-check-contexts"]; + post: operations['repos/add-status-check-contexts'] /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - delete: operations["repos/remove-status-check-contexts"]; - }; - "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions": { + delete: operations['repos/remove-status-check-contexts'] + } + '/repos/{owner}/{repo}/branches/{branch}/protection/restrictions': { /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2631,21 +2631,21 @@ export interface paths { * * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. */ - get: operations["repos/get-access-restrictions"]; + get: operations['repos/get-access-restrictions'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Disables the ability to restrict who can push to this branch. */ - delete: operations["repos/delete-access-restrictions"]; - }; - "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps": { + delete: operations['repos/delete-access-restrictions'] + } + '/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps': { /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. */ - get: operations["repos/get-apps-with-access-to-protected-branch"]; + get: operations['repos/get-apps-with-access-to-protected-branch'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2655,7 +2655,7 @@ export interface paths { * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - put: operations["repos/set-app-access-restrictions"]; + put: operations['repos/set-app-access-restrictions'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2665,7 +2665,7 @@ export interface paths { * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - post: operations["repos/add-app-access-restrictions"]; + post: operations['repos/add-app-access-restrictions'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2675,15 +2675,15 @@ export interface paths { * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - delete: operations["repos/remove-app-access-restrictions"]; - }; - "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams": { + delete: operations['repos/remove-app-access-restrictions'] + } + '/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams': { /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the teams who have push access to this branch. The list includes child teams. */ - get: operations["repos/get-teams-with-access-to-protected-branch"]; + get: operations['repos/get-teams-with-access-to-protected-branch'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2693,7 +2693,7 @@ export interface paths { * | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ | * | `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - put: operations["repos/set-team-access-restrictions"]; + put: operations['repos/set-team-access-restrictions'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2703,7 +2703,7 @@ export interface paths { * | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ | * | `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - post: operations["repos/add-team-access-restrictions"]; + post: operations['repos/add-team-access-restrictions'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2713,15 +2713,15 @@ export interface paths { * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | Teams that should no longer have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - delete: operations["repos/remove-team-access-restrictions"]; - }; - "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users": { + delete: operations['repos/remove-team-access-restrictions'] + } + '/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users': { /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the people who have push access to this branch. */ - get: operations["repos/get-users-with-access-to-protected-branch"]; + get: operations['repos/get-users-with-access-to-protected-branch'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2731,7 +2731,7 @@ export interface paths { * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - put: operations["repos/set-user-access-restrictions"]; + put: operations['repos/set-user-access-restrictions'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2741,7 +2741,7 @@ export interface paths { * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - post: operations["repos/add-user-access-restrictions"]; + post: operations['repos/add-user-access-restrictions'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2751,9 +2751,9 @@ export interface paths { * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - delete: operations["repos/remove-user-access-restrictions"]; - }; - "/repos/{owner}/{repo}/branches/{branch}/rename": { + delete: operations['repos/remove-user-access-restrictions'] + } + '/repos/{owner}/{repo}/branches/{branch}/rename': { /** * Renames a branch in a repository. * @@ -2771,9 +2771,9 @@ export interface paths { * * Users must have admin or owner permissions. * * GitHub Apps must have the `administration:write` repository permission. */ - post: operations["repos/rename-branch"]; - }; - "/repos/{owner}/{repo}/check-runs": { + post: operations['repos/rename-branch'] + } + '/repos/{owner}/{repo}/check-runs': { /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * @@ -2781,71 +2781,71 @@ export interface paths { * * In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. */ - post: operations["checks/create"]; - }; - "/repos/{owner}/{repo}/check-runs/{check_run_id}": { + post: operations['checks/create'] + } + '/repos/{owner}/{repo}/check-runs/{check_run_id}': { /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * Gets a single check run using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. */ - get: operations["checks/get"]; + get: operations['checks/get'] /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. */ - patch: operations["checks/update"]; - }; - "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations": { + patch: operations['checks/update'] + } + '/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations': { /** Lists annotations for a check run using the annotation `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the `repo` scope to get annotations for a check run in a private repository. */ - get: operations["checks/list-annotations"]; - }; - "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest": { + get: operations['checks/list-annotations'] + } + '/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest': { /** * Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * * To rerequest a check run, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository. */ - post: operations["checks/rerequest-run"]; - }; - "/repos/{owner}/{repo}/check-suites": { + post: operations['checks/rerequest-run'] + } + '/repos/{owner}/{repo}/check-suites': { /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * * By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/reference/checks#check-runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/reference/checks#update-repository-preferences-for-check-suites)". Your GitHub App must have the `checks:write` permission to create check suites. */ - post: operations["checks/create-suite"]; - }; - "/repos/{owner}/{repo}/check-suites/preferences": { + post: operations['checks/create-suite'] + } + '/repos/{owner}/{repo}/check-suites/preferences': { /** Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/reference/checks#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites. */ - patch: operations["checks/set-suites-preferences"]; - }; - "/repos/{owner}/{repo}/check-suites/{check_suite_id}": { + patch: operations['checks/set-suites-preferences'] + } + '/repos/{owner}/{repo}/check-suites/{check_suite_id}': { /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * * Gets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository. */ - get: operations["checks/get-suite"]; - }; - "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": { + get: operations['checks/get-suite'] + } + '/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs': { /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. */ - get: operations["checks/list-for-suite"]; - }; - "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest": { + get: operations['checks/list-for-suite'] + } + '/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest': { /** * Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * * To rerequest a check suite, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository. */ - post: operations["checks/rerequest-suite"]; - }; - "/repos/{owner}/{repo}/code-scanning/alerts": { + post: operations['checks/rerequest-suite'] + } + '/repos/{owner}/{repo}/code-scanning/alerts': { /** * Lists all open code scanning alerts for the default branch (usually `main` * or `master`). You must use an access token with the `security_events` scope to use @@ -2858,29 +2858,29 @@ export interface paths { * for the default branch or for the specified Git reference * (if you used `ref` in the request). */ - get: operations["code-scanning/list-alerts-for-repo"]; - }; - "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}": { + get: operations['code-scanning/list-alerts-for-repo'] + } + '/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}': { /** * Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint. * * **Deprecation notice**: * The instances field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The same information can now be retrieved via a GET request to the URL specified by `instances_url`. */ - get: operations["code-scanning/get-alert"]; + get: operations['code-scanning/get-alert'] /** Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. */ - patch: operations["code-scanning/update-alert"]; - }; - "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances": { + patch: operations['code-scanning/update-alert'] + } + '/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances': { /** * Lists all instances of the specified code scanning alert. * You must use an access token with the `security_events` scope to use this endpoint with private repos, * the `public_repo` scope also grants permission to read security events on public repos only. * GitHub Apps must have the `security_events` read permission to use this endpoint. */ - get: operations["code-scanning/list-alert-instances"]; - }; - "/repos/{owner}/{repo}/code-scanning/analyses": { + get: operations['code-scanning/list-alert-instances'] + } + '/repos/{owner}/{repo}/code-scanning/analyses': { /** * Lists the details of all code scanning analyses for a repository, * starting with the most recent. @@ -2900,9 +2900,9 @@ export interface paths { * **Deprecation notice**: * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. */ - get: operations["code-scanning/list-recent-analyses"]; - }; - "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}": { + get: operations['code-scanning/list-recent-analyses'] + } + '/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}': { /** * Gets a specified code scanning analysis for a repository. * You must use an access token with the `security_events` scope to use this endpoint with private repos, @@ -2924,7 +2924,7 @@ export interface paths { * This is formatted as * [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). */ - get: operations["code-scanning/get-analysis"]; + get: operations['code-scanning/get-analysis'] /** * Deletes a specified code scanning analysis from a repository. For * private repositories, you must use an access token with the `repo` scope. For public repositories, @@ -2993,9 +2993,9 @@ export interface paths { * * The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely. */ - delete: operations["code-scanning/delete-analysis"]; - }; - "/repos/{owner}/{repo}/code-scanning/sarifs": { + delete: operations['code-scanning/delete-analysis'] + } + '/repos/{owner}/{repo}/code-scanning/sarifs': { /** * Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. * @@ -3015,27 +3015,27 @@ export interface paths { * You can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint. * For more information, see "[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload)." */ - post: operations["code-scanning/upload-sarif"]; - }; - "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}": { + post: operations['code-scanning/upload-sarif'] + } + '/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}': { /** Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository)." You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint. */ - get: operations["code-scanning/get-sarif"]; - }; - "/repos/{owner}/{repo}/codespaces": { + get: operations['code-scanning/get-sarif'] + } + '/repos/{owner}/{repo}/codespaces': { /** * Lists the codespaces associated to a specified repository and the authenticated user. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - get: operations["codespaces/list-in-repository-for-authenticated-user"]; + get: operations['codespaces/list-in-repository-for-authenticated-user'] /** * Creates a codespace owned by the authenticated user in the specified repository. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - post: operations["codespaces/create-with-repo-for-authenticated-user"]; - }; - "/repos/{owner}/{repo}/codespaces/machines": { + post: operations['codespaces/create-with-repo-for-authenticated-user'] + } + '/repos/{owner}/{repo}/codespaces/machines': { /** * List the machine types available for a given repository based on its configuration. * @@ -3043,9 +3043,9 @@ export interface paths { * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - get: operations["codespaces/repo-machines-for-authenticated-user"]; - }; - "/repos/{owner}/{repo}/collaborators": { + get: operations['codespaces/repo-machines-for-authenticated-user'] + } + '/repos/{owner}/{repo}/collaborators': { /** * For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. * @@ -3055,9 +3055,9 @@ export interface paths { * endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this * endpoint. */ - get: operations["repos/list-collaborators"]; - }; - "/repos/{owner}/{repo}/collaborators/{username}": { + get: operations['repos/list-collaborators'] + } + '/repos/{owner}/{repo}/collaborators/{username}': { /** * For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. * @@ -3067,7 +3067,7 @@ export interface paths { * endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this * endpoint. */ - get: operations["repos/check-collaborator"]; + get: operations['repos/check-collaborator'] /** * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. * @@ -3085,41 +3085,41 @@ export interface paths { * * You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository. */ - put: operations["repos/add-collaborator"]; - delete: operations["repos/remove-collaborator"]; - }; - "/repos/{owner}/{repo}/collaborators/{username}/permission": { + put: operations['repos/add-collaborator'] + delete: operations['repos/remove-collaborator'] + } + '/repos/{owner}/{repo}/collaborators/{username}/permission': { /** Checks the repository permission of a collaborator. The possible repository permissions are `admin`, `write`, `read`, and `none`. */ - get: operations["repos/get-collaborator-permission-level"]; - }; - "/repos/{owner}/{repo}/comments": { + get: operations['repos/get-collaborator-permission-level'] + } + '/repos/{owner}/{repo}/comments': { /** * Commit Comments use [these custom media types](https://docs.github.com/rest/reference/repos#custom-media-types). You can read more about the use of media types in the API [here](https://docs.github.com/rest/overview/media-types/). * * Comments are ordered by ascending ID. */ - get: operations["repos/list-commit-comments-for-repo"]; - }; - "/repos/{owner}/{repo}/comments/{comment_id}": { - get: operations["repos/get-commit-comment"]; - delete: operations["repos/delete-commit-comment"]; - patch: operations["repos/update-commit-comment"]; - }; - "/repos/{owner}/{repo}/comments/{comment_id}/reactions": { + get: operations['repos/list-commit-comments-for-repo'] + } + '/repos/{owner}/{repo}/comments/{comment_id}': { + get: operations['repos/get-commit-comment'] + delete: operations['repos/delete-commit-comment'] + patch: operations['repos/update-commit-comment'] + } + '/repos/{owner}/{repo}/comments/{comment_id}/reactions': { /** List the reactions to a [commit comment](https://docs.github.com/rest/reference/repos#comments). */ - get: operations["reactions/list-for-commit-comment"]; + get: operations['reactions/list-for-commit-comment'] /** Create a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. */ - post: operations["reactions/create-for-commit-comment"]; - }; - "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}": { + post: operations['reactions/create-for-commit-comment'] + } + '/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}': { /** * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. * * Delete a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). */ - delete: operations["reactions/delete-for-commit-comment"]; - }; - "/repos/{owner}/{repo}/commits": { + delete: operations['reactions/delete-for-commit-comment'] + } + '/repos/{owner}/{repo}/commits': { /** * **Signature verification object** * @@ -3150,31 +3150,31 @@ export interface paths { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - get: operations["repos/list-commits"]; - }; - "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head": { + get: operations['repos/list-commits'] + } + '/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head': { /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. */ - get: operations["repos/list-branches-for-head-commit"]; - }; - "/repos/{owner}/{repo}/commits/{commit_sha}/comments": { + get: operations['repos/list-branches-for-head-commit'] + } + '/repos/{owner}/{repo}/commits/{commit_sha}/comments': { /** Use the `:commit_sha` to specify the commit that will have its comments listed. */ - get: operations["repos/list-comments-for-commit"]; + get: operations['repos/list-comments-for-commit'] /** * Create a comment for a commit using its `:commit_sha`. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - post: operations["repos/create-commit-comment"]; - }; - "/repos/{owner}/{repo}/commits/{commit_sha}/pulls": { + post: operations['repos/create-commit-comment'] + } + '/repos/{owner}/{repo}/commits/{commit_sha}/pulls': { /** Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the [List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests) endpoint. */ - get: operations["repos/list-pull-requests-associated-with-commit"]; - }; - "/repos/{owner}/{repo}/commits/{ref}": { + get: operations['repos/list-pull-requests-associated-with-commit'] + } + '/repos/{owner}/{repo}/commits/{ref}': { /** * Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. * @@ -3213,25 +3213,25 @@ export interface paths { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - get: operations["repos/get-commit"]; - }; - "/repos/{owner}/{repo}/commits/{ref}/check-runs": { + get: operations['repos/get-commit'] + } + '/repos/{owner}/{repo}/commits/{ref}/check-runs': { /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. */ - get: operations["checks/list-for-ref"]; - }; - "/repos/{owner}/{repo}/commits/{ref}/check-suites": { + get: operations['checks/list-for-ref'] + } + '/repos/{owner}/{repo}/commits/{ref}/check-suites': { /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * * Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository. */ - get: operations["checks/list-suites-for-ref"]; - }; - "/repos/{owner}/{repo}/commits/{ref}/status": { + get: operations['checks/list-suites-for-ref'] + } + '/repos/{owner}/{repo}/commits/{ref}/status': { /** * Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. * @@ -3242,17 +3242,17 @@ export interface paths { * * **pending** if there are no statuses or a context is `pending` * * **success** if the latest status for all contexts is `success` */ - get: operations["repos/get-combined-status-for-ref"]; - }; - "/repos/{owner}/{repo}/commits/{ref}/statuses": { + get: operations['repos/get-combined-status-for-ref'] + } + '/repos/{owner}/{repo}/commits/{ref}/statuses': { /** * Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one. * * This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`. */ - get: operations["repos/list-commit-statuses-for-ref"]; - }; - "/repos/{owner}/{repo}/community/profile": { + get: operations['repos/list-commit-statuses-for-ref'] + } + '/repos/{owner}/{repo}/community/profile': { /** * This endpoint will return all community profile metrics, including an * overall health score, repository description, the presence of documentation, detected @@ -3267,9 +3267,9 @@ export interface paths { * * `content_reports_enabled` is only returned for organization-owned repositories. */ - get: operations["repos/get-community-profile-metrics"]; - }; - "/repos/{owner}/{repo}/compare/{basehead}": { + get: operations['repos/get-community-profile-metrics'] + } + '/repos/{owner}/{repo}/compare/{basehead}': { /** * The `basehead` param is comprised of two parts: `base` and `head`. Both must be branch names in `repo`. To compare branches across other repositories in the same network as `repo`, use the format `:branch`. * @@ -3312,9 +3312,9 @@ export interface paths { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - get: operations["repos/compare-commits"]; - }; - "/repos/{owner}/{repo}/contents/{path}": { + get: operations['repos/compare-commits'] + } + '/repos/{owner}/{repo}/contents/{path}': { /** * Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit * `:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. @@ -3349,9 +3349,9 @@ export interface paths { * If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the * github.com URLs (`html_url` and `_links["html"]`) will have null values. */ - get: operations["repos/get-content"]; + get: operations['repos/get-content'] /** Creates a new file or replaces an existing file in a repository. */ - put: operations["repos/create-or-update-file-contents"]; + put: operations['repos/create-or-update-file-contents'] /** * Deletes a file in a repository. * @@ -3361,27 +3361,27 @@ export interface paths { * * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. */ - delete: operations["repos/delete-file"]; - }; - "/repos/{owner}/{repo}/contributors": { + delete: operations['repos/delete-file'] + } + '/repos/{owner}/{repo}/contributors': { /** * Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance. * * GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information. */ - get: operations["repos/list-contributors"]; - }; - "/repos/{owner}/{repo}/dependabot/secrets": { + get: operations['repos/list-contributors'] + } + '/repos/{owner}/{repo}/dependabot/secrets': { /** Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */ - get: operations["dependabot/list-repo-secrets"]; - }; - "/repos/{owner}/{repo}/dependabot/secrets/public-key": { + get: operations['dependabot/list-repo-secrets'] + } + '/repos/{owner}/{repo}/dependabot/secrets/public-key': { /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */ - get: operations["dependabot/get-repo-public-key"]; - }; - "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}": { + get: operations['dependabot/get-repo-public-key'] + } + '/repos/{owner}/{repo}/dependabot/secrets/{secret_name}': { /** Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */ - get: operations["dependabot/get-repo-secret"]; + get: operations['dependabot/get-repo-secret'] /** * Creates or updates a repository secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -3459,13 +3459,13 @@ export interface paths { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - put: operations["dependabot/create-or-update-repo-secret"]; + put: operations['dependabot/create-or-update-repo-secret'] /** Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */ - delete: operations["dependabot/delete-repo-secret"]; - }; - "/repos/{owner}/{repo}/deployments": { + delete: operations['dependabot/delete-repo-secret'] + } + '/repos/{owner}/{repo}/deployments': { /** Simple filtering of deployments is available via query parameters: */ - get: operations["repos/list-deployments"]; + get: operations['repos/list-deployments'] /** * Deployments offer a few configurable parameters with certain defaults. * @@ -3513,10 +3513,10 @@ export interface paths { * This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` * status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. */ - post: operations["repos/create-deployment"]; - }; - "/repos/{owner}/{repo}/deployments/{deployment_id}": { - get: operations["repos/get-deployment"]; + post: operations['repos/create-deployment'] + } + '/repos/{owner}/{repo}/deployments/{deployment_id}': { + get: operations['repos/get-deployment'] /** * If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. Anyone with `repo` or `repo_deployment` scopes can delete a deployment. * @@ -3527,23 +3527,23 @@ export interface paths { * * For more information, see "[Create a deployment](https://docs.github.com/rest/reference/repos/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/reference/repos#create-a-deployment-status)." */ - delete: operations["repos/delete-deployment"]; - }; - "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses": { + delete: operations['repos/delete-deployment'] + } + '/repos/{owner}/{repo}/deployments/{deployment_id}/statuses': { /** Users with pull access can view deployment statuses for a deployment: */ - get: operations["repos/list-deployment-statuses"]; + get: operations['repos/list-deployment-statuses'] /** * Users with `push` access can create deployment statuses for a given deployment. * * GitHub Apps require `read & write` access to "Deployments" and `read-only` access to "Repo contents" (for private repos). OAuth Apps require the `repo_deployment` scope. */ - post: operations["repos/create-deployment-status"]; - }; - "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}": { + post: operations['repos/create-deployment-status'] + } + '/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}': { /** Users with pull access can view a deployment status for a deployment: */ - get: operations["repos/get-deployment-status"]; - }; - "/repos/{owner}/{repo}/dispatches": { + get: operations['repos/get-deployment-status'] + } + '/repos/{owner}/{repo}/dispatches': { /** * You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/webhooks/event-payloads/#repository_dispatch)." * @@ -3556,19 +3556,19 @@ export interface paths { * * This input example shows how you can use the `client_payload` as a test to debug your workflow. */ - post: operations["repos/create-dispatch-event"]; - }; - "/repos/{owner}/{repo}/environments": { + post: operations['repos/create-dispatch-event'] + } + '/repos/{owner}/{repo}/environments': { /** * Get all environments for a repository. * * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["repos/get-all-environments"]; - }; - "/repos/{owner}/{repo}/environments/{environment_name}": { + get: operations['repos/get-all-environments'] + } + '/repos/{owner}/{repo}/environments/{environment_name}': { /** Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["repos/get-environment"]; + get: operations['repos/get-environment'] /** * Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)." * @@ -3578,34 +3578,34 @@ export interface paths { * * You must authenticate using an access token with the repo scope to use this endpoint. */ - put: operations["repos/create-or-update-environment"]; + put: operations['repos/create-or-update-environment'] /** You must authenticate using an access token with the repo scope to use this endpoint. */ - delete: operations["repos/delete-an-environment"]; - }; - "/repos/{owner}/{repo}/events": { - get: operations["activity/list-repo-events"]; - }; - "/repos/{owner}/{repo}/forks": { - get: operations["repos/list-forks"]; + delete: operations['repos/delete-an-environment'] + } + '/repos/{owner}/{repo}/events': { + get: operations['activity/list-repo-events'] + } + '/repos/{owner}/{repo}/forks': { + get: operations['repos/list-forks'] /** * Create a fork for the authenticated user. * * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). */ - post: operations["repos/create-fork"]; - }; - "/repos/{owner}/{repo}/git/blobs": { - post: operations["git/create-blob"]; - }; - "/repos/{owner}/{repo}/git/blobs/{file_sha}": { + post: operations['repos/create-fork'] + } + '/repos/{owner}/{repo}/git/blobs': { + post: operations['git/create-blob'] + } + '/repos/{owner}/{repo}/git/blobs/{file_sha}': { /** * The `content` in the response will always be Base64 encoded. * * _Note_: This API supports blobs up to 100 megabytes in size. */ - get: operations["git/get-blob"]; - }; - "/repos/{owner}/{repo}/git/commits": { + get: operations['git/get-blob'] + } + '/repos/{owner}/{repo}/git/commits': { /** * Creates a new Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects). * @@ -3638,9 +3638,9 @@ export interface paths { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - post: operations["git/create-commit"]; - }; - "/repos/{owner}/{repo}/git/commits/{commit_sha}": { + post: operations['git/create-commit'] + } + '/repos/{owner}/{repo}/git/commits/{commit_sha}': { /** * Gets a Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects). * @@ -3673,9 +3673,9 @@ export interface paths { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - get: operations["git/get-commit"]; - }; - "/repos/{owner}/{repo}/git/matching-refs/{ref}": { + get: operations['git/get-commit'] + } + '/repos/{owner}/{repo}/git/matching-refs/{ref}': { /** * Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array. * @@ -3685,25 +3685,25 @@ export interface paths { * * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. */ - get: operations["git/list-matching-refs"]; - }; - "/repos/{owner}/{repo}/git/ref/{ref}": { + get: operations['git/list-matching-refs'] + } + '/repos/{owner}/{repo}/git/ref/{ref}': { /** * Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. * * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". */ - get: operations["git/get-ref"]; - }; - "/repos/{owner}/{repo}/git/refs": { + get: operations['git/get-ref'] + } + '/repos/{owner}/{repo}/git/refs': { /** Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches. */ - post: operations["git/create-ref"]; - }; - "/repos/{owner}/{repo}/git/refs/{ref}": { - delete: operations["git/delete-ref"]; - patch: operations["git/update-ref"]; - }; - "/repos/{owner}/{repo}/git/tags": { + post: operations['git/create-ref'] + } + '/repos/{owner}/{repo}/git/refs/{ref}': { + delete: operations['git/delete-ref'] + patch: operations['git/update-ref'] + } + '/repos/{owner}/{repo}/git/tags': { /** * Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/rest/reference/git#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/rest/reference/git#create-a-reference) the tag reference - this call would be unnecessary. * @@ -3736,9 +3736,9 @@ export interface paths { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - post: operations["git/create-tag"]; - }; - "/repos/{owner}/{repo}/git/tags/{tag_sha}": { + post: operations['git/create-tag'] + } + '/repos/{owner}/{repo}/git/tags/{tag_sha}': { /** * **Signature verification object** * @@ -3769,78 +3769,78 @@ export interface paths { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - get: operations["git/get-tag"]; - }; - "/repos/{owner}/{repo}/git/trees": { + get: operations['git/get-tag'] + } + '/repos/{owner}/{repo}/git/trees': { /** * The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure. * * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/rest/reference/git#create-a-commit)" and "[Update a reference](https://docs.github.com/rest/reference/git#update-a-reference)." */ - post: operations["git/create-tree"]; - }; - "/repos/{owner}/{repo}/git/trees/{tree_sha}": { + post: operations['git/create-tree'] + } + '/repos/{owner}/{repo}/git/trees/{tree_sha}': { /** * Returns a single tree using the SHA1 value for that tree. * * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. */ - get: operations["git/get-tree"]; - }; - "/repos/{owner}/{repo}/hooks": { - get: operations["repos/list-webhooks"]; + get: operations['git/get-tree'] + } + '/repos/{owner}/{repo}/hooks': { + get: operations['repos/list-webhooks'] /** * Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can * share the same `config` as long as those webhooks do not have any `events` that overlap. */ - post: operations["repos/create-webhook"]; - }; - "/repos/{owner}/{repo}/hooks/{hook_id}": { + post: operations['repos/create-webhook'] + } + '/repos/{owner}/{repo}/hooks/{hook_id}': { /** Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/reference/repos#get-a-webhook-configuration-for-a-repository)." */ - get: operations["repos/get-webhook"]; - delete: operations["repos/delete-webhook"]; + get: operations['repos/get-webhook'] + delete: operations['repos/delete-webhook'] /** Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/reference/repos#update-a-webhook-configuration-for-a-repository)." */ - patch: operations["repos/update-webhook"]; - }; - "/repos/{owner}/{repo}/hooks/{hook_id}/config": { + patch: operations['repos/update-webhook'] + } + '/repos/{owner}/{repo}/hooks/{hook_id}/config': { /** * Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/reference/orgs#get-a-repository-webhook)." * * Access tokens must have the `read:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:read` permission. */ - get: operations["repos/get-webhook-config-for-repo"]; + get: operations['repos/get-webhook-config-for-repo'] /** * Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/reference/orgs#update-a-repository-webhook)." * * Access tokens must have the `write:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:write` permission. */ - patch: operations["repos/update-webhook-config-for-repo"]; - }; - "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries": { + patch: operations['repos/update-webhook-config-for-repo'] + } + '/repos/{owner}/{repo}/hooks/{hook_id}/deliveries': { /** Returns a list of webhook deliveries for a webhook configured in a repository. */ - get: operations["repos/list-webhook-deliveries"]; - }; - "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}": { + get: operations['repos/list-webhook-deliveries'] + } + '/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}': { /** Returns a delivery for a webhook configured in a repository. */ - get: operations["repos/get-webhook-delivery"]; - }; - "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { + get: operations['repos/get-webhook-delivery'] + } + '/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts': { /** Redeliver a webhook delivery for a webhook configured in a repository. */ - post: operations["repos/redeliver-webhook-delivery"]; - }; - "/repos/{owner}/{repo}/hooks/{hook_id}/pings": { + post: operations['repos/redeliver-webhook-delivery'] + } + '/repos/{owner}/{repo}/hooks/{hook_id}/pings': { /** This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. */ - post: operations["repos/ping-webhook"]; - }; - "/repos/{owner}/{repo}/hooks/{hook_id}/tests": { + post: operations['repos/ping-webhook'] + } + '/repos/{owner}/{repo}/hooks/{hook_id}/tests': { /** * This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. * * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` */ - post: operations["repos/test-push-webhook"]; - }; - "/repos/{owner}/{repo}/import": { + post: operations['repos/test-push-webhook'] + } + '/repos/{owner}/{repo}/import': { /** * View the progress of an import. * @@ -3877,62 +3877,62 @@ export interface paths { * * `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository. * * `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a "Get Large Files" request. */ - get: operations["migrations/get-import-status"]; + get: operations['migrations/get-import-status'] /** Start a source import to a GitHub repository using GitHub Importer. */ - put: operations["migrations/start-import"]; + put: operations['migrations/start-import'] /** Stop an import for a repository. */ - delete: operations["migrations/cancel-import"]; + delete: operations['migrations/cancel-import'] /** * An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API * request. If no parameters are provided, the import will be restarted. */ - patch: operations["migrations/update-import"]; - }; - "/repos/{owner}/{repo}/import/authors": { + patch: operations['migrations/update-import'] + } + '/repos/{owner}/{repo}/import/authors': { /** * Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `. * * This endpoint and the [Map a commit author](https://docs.github.com/rest/reference/migrations#map-a-commit-author) endpoint allow you to provide correct Git author information. */ - get: operations["migrations/get-commit-authors"]; - }; - "/repos/{owner}/{repo}/import/authors/{author_id}": { + get: operations['migrations/get-commit-authors'] + } + '/repos/{owner}/{repo}/import/authors/{author_id}': { /** Update an author's identity for the import. Your application can continue updating authors any time before you push new commits to the repository. */ - patch: operations["migrations/map-commit-author"]; - }; - "/repos/{owner}/{repo}/import/large_files": { + patch: operations['migrations/map-commit-author'] + } + '/repos/{owner}/{repo}/import/large_files': { /** List files larger than 100MB found during the import */ - get: operations["migrations/get-large-files"]; - }; - "/repos/{owner}/{repo}/import/lfs": { + get: operations['migrations/get-large-files'] + } + '/repos/{owner}/{repo}/import/lfs': { /** You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability is powered by [Git LFS](https://git-lfs.github.com). You can learn more about our LFS feature and working with large files [on our help site](https://docs.github.com/articles/versioning-large-files/). */ - patch: operations["migrations/set-lfs-preference"]; - }; - "/repos/{owner}/{repo}/installation": { + patch: operations['migrations/set-lfs-preference'] + } + '/repos/{owner}/{repo}/installation': { /** * Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - get: operations["apps/get-repo-installation"]; - }; - "/repos/{owner}/{repo}/interaction-limits": { + get: operations['apps/get-repo-installation'] + } + '/repos/{owner}/{repo}/interaction-limits': { /** Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response. */ - get: operations["interactions/get-restrictions-for-repo"]; + get: operations['interactions/get-restrictions-for-repo'] /** Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. */ - put: operations["interactions/set-restrictions-for-repo"]; + put: operations['interactions/set-restrictions-for-repo'] /** Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. */ - delete: operations["interactions/remove-restrictions-for-repo"]; - }; - "/repos/{owner}/{repo}/invitations": { + delete: operations['interactions/remove-restrictions-for-repo'] + } + '/repos/{owner}/{repo}/invitations': { /** When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations. */ - get: operations["repos/list-invitations"]; - }; - "/repos/{owner}/{repo}/invitations/{invitation_id}": { - delete: operations["repos/delete-invitation"]; - patch: operations["repos/update-invitation"]; - }; - "/repos/{owner}/{repo}/issues": { + get: operations['repos/list-invitations'] + } + '/repos/{owner}/{repo}/invitations/{invitation_id}': { + delete: operations['repos/delete-invitation'] + patch: operations['repos/update-invitation'] + } + '/repos/{owner}/{repo}/issues': { /** * List issues in a repository. * @@ -3941,44 +3941,44 @@ export interface paths { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - get: operations["issues/list-for-repo"]; + get: operations['issues/list-for-repo'] /** * Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - post: operations["issues/create"]; - }; - "/repos/{owner}/{repo}/issues/comments": { + post: operations['issues/create'] + } + '/repos/{owner}/{repo}/issues/comments': { /** By default, Issue Comments are ordered by ascending ID. */ - get: operations["issues/list-comments-for-repo"]; - }; - "/repos/{owner}/{repo}/issues/comments/{comment_id}": { - get: operations["issues/get-comment"]; - delete: operations["issues/delete-comment"]; - patch: operations["issues/update-comment"]; - }; - "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": { + get: operations['issues/list-comments-for-repo'] + } + '/repos/{owner}/{repo}/issues/comments/{comment_id}': { + get: operations['issues/get-comment'] + delete: operations['issues/delete-comment'] + patch: operations['issues/update-comment'] + } + '/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions': { /** List the reactions to an [issue comment](https://docs.github.com/rest/reference/issues#comments). */ - get: operations["reactions/list-for-issue-comment"]; + get: operations['reactions/list-for-issue-comment'] /** Create a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. */ - post: operations["reactions/create-for-issue-comment"]; - }; - "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}": { + post: operations['reactions/create-for-issue-comment'] + } + '/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}': { /** * **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. * * Delete a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). */ - delete: operations["reactions/delete-for-issue-comment"]; - }; - "/repos/{owner}/{repo}/issues/events": { - get: operations["issues/list-events-for-repo"]; - }; - "/repos/{owner}/{repo}/issues/events/{event_id}": { - get: operations["issues/get-event"]; - }; - "/repos/{owner}/{repo}/issues/{issue_number}": { + delete: operations['reactions/delete-for-issue-comment'] + } + '/repos/{owner}/{repo}/issues/events': { + get: operations['issues/list-events-for-repo'] + } + '/repos/{owner}/{repo}/issues/events/{event_id}': { + get: operations['issues/get-event'] + } + '/repos/{owner}/{repo}/issues/{issue_number}': { /** * The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was * [transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If @@ -3992,147 +3992,147 @@ export interface paths { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - get: operations["issues/get"]; + get: operations['issues/get'] /** Issue owners and users with push access can edit an issue. */ - patch: operations["issues/update"]; - }; - "/repos/{owner}/{repo}/issues/{issue_number}/assignees": { + patch: operations['issues/update'] + } + '/repos/{owner}/{repo}/issues/{issue_number}/assignees': { /** Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced. */ - post: operations["issues/add-assignees"]; + post: operations['issues/add-assignees'] /** Removes one or more assignees from an issue. */ - delete: operations["issues/remove-assignees"]; - }; - "/repos/{owner}/{repo}/issues/{issue_number}/comments": { + delete: operations['issues/remove-assignees'] + } + '/repos/{owner}/{repo}/issues/{issue_number}/comments': { /** Issue Comments are ordered by ascending ID. */ - get: operations["issues/list-comments"]; + get: operations['issues/list-comments'] /** This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - post: operations["issues/create-comment"]; - }; - "/repos/{owner}/{repo}/issues/{issue_number}/events": { - get: operations["issues/list-events"]; - }; - "/repos/{owner}/{repo}/issues/{issue_number}/labels": { - get: operations["issues/list-labels-on-issue"]; + post: operations['issues/create-comment'] + } + '/repos/{owner}/{repo}/issues/{issue_number}/events': { + get: operations['issues/list-events'] + } + '/repos/{owner}/{repo}/issues/{issue_number}/labels': { + get: operations['issues/list-labels-on-issue'] /** Removes any previous labels and sets the new labels for an issue. */ - put: operations["issues/set-labels"]; - post: operations["issues/add-labels"]; - delete: operations["issues/remove-all-labels"]; - }; - "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}": { + put: operations['issues/set-labels'] + post: operations['issues/add-labels'] + delete: operations['issues/remove-all-labels'] + } + '/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}': { /** Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist. */ - delete: operations["issues/remove-label"]; - }; - "/repos/{owner}/{repo}/issues/{issue_number}/lock": { + delete: operations['issues/remove-label'] + } + '/repos/{owner}/{repo}/issues/{issue_number}/lock': { /** * Users with push access can lock an issue or pull request's conversation. * * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - put: operations["issues/lock"]; + put: operations['issues/lock'] /** Users with push access can unlock an issue's conversation. */ - delete: operations["issues/unlock"]; - }; - "/repos/{owner}/{repo}/issues/{issue_number}/reactions": { + delete: operations['issues/unlock'] + } + '/repos/{owner}/{repo}/issues/{issue_number}/reactions': { /** List the reactions to an [issue](https://docs.github.com/rest/reference/issues). */ - get: operations["reactions/list-for-issue"]; + get: operations['reactions/list-for-issue'] /** Create a reaction to an [issue](https://docs.github.com/rest/reference/issues/). A response with an HTTP `200` status means that you already added the reaction type to this issue. */ - post: operations["reactions/create-for-issue"]; - }; - "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}": { + post: operations['reactions/create-for-issue'] + } + '/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}': { /** * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. * * Delete a reaction to an [issue](https://docs.github.com/rest/reference/issues/). */ - delete: operations["reactions/delete-for-issue"]; - }; - "/repos/{owner}/{repo}/issues/{issue_number}/timeline": { - get: operations["issues/list-events-for-timeline"]; - }; - "/repos/{owner}/{repo}/keys": { - get: operations["repos/list-deploy-keys"]; + delete: operations['reactions/delete-for-issue'] + } + '/repos/{owner}/{repo}/issues/{issue_number}/timeline': { + get: operations['issues/list-events-for-timeline'] + } + '/repos/{owner}/{repo}/keys': { + get: operations['repos/list-deploy-keys'] /** You can create a read-only deploy key. */ - post: operations["repos/create-deploy-key"]; - }; - "/repos/{owner}/{repo}/keys/{key_id}": { - get: operations["repos/get-deploy-key"]; + post: operations['repos/create-deploy-key'] + } + '/repos/{owner}/{repo}/keys/{key_id}': { + get: operations['repos/get-deploy-key'] /** Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead. */ - delete: operations["repos/delete-deploy-key"]; - }; - "/repos/{owner}/{repo}/labels": { - get: operations["issues/list-labels-for-repo"]; - post: operations["issues/create-label"]; - }; - "/repos/{owner}/{repo}/labels/{name}": { - get: operations["issues/get-label"]; - delete: operations["issues/delete-label"]; - patch: operations["issues/update-label"]; - }; - "/repos/{owner}/{repo}/languages": { + delete: operations['repos/delete-deploy-key'] + } + '/repos/{owner}/{repo}/labels': { + get: operations['issues/list-labels-for-repo'] + post: operations['issues/create-label'] + } + '/repos/{owner}/{repo}/labels/{name}': { + get: operations['issues/get-label'] + delete: operations['issues/delete-label'] + patch: operations['issues/update-label'] + } + '/repos/{owner}/{repo}/languages': { /** Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language. */ - get: operations["repos/list-languages"]; - }; - "/repos/{owner}/{repo}/lfs": { - put: operations["repos/enable-lfs-for-repo"]; - delete: operations["repos/disable-lfs-for-repo"]; - }; - "/repos/{owner}/{repo}/license": { + get: operations['repos/list-languages'] + } + '/repos/{owner}/{repo}/lfs': { + put: operations['repos/enable-lfs-for-repo'] + delete: operations['repos/disable-lfs-for-repo'] + } + '/repos/{owner}/{repo}/license': { /** * This method returns the contents of the repository's license file, if one is detected. * * Similar to [Get repository content](https://docs.github.com/rest/reference/repos#get-repository-content), this method also supports [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw license content or rendered license HTML. */ - get: operations["licenses/get-for-repo"]; - }; - "/repos/{owner}/{repo}/merge-upstream": { + get: operations['licenses/get-for-repo'] + } + '/repos/{owner}/{repo}/merge-upstream': { /** Sync a branch of a forked repository to keep it up-to-date with the upstream repository. */ - post: operations["repos/merge-upstream"]; - }; - "/repos/{owner}/{repo}/merges": { - post: operations["repos/merge"]; - }; - "/repos/{owner}/{repo}/milestones": { - get: operations["issues/list-milestones"]; - post: operations["issues/create-milestone"]; - }; - "/repos/{owner}/{repo}/milestones/{milestone_number}": { - get: operations["issues/get-milestone"]; - delete: operations["issues/delete-milestone"]; - patch: operations["issues/update-milestone"]; - }; - "/repos/{owner}/{repo}/milestones/{milestone_number}/labels": { - get: operations["issues/list-labels-for-milestone"]; - }; - "/repos/{owner}/{repo}/notifications": { + post: operations['repos/merge-upstream'] + } + '/repos/{owner}/{repo}/merges': { + post: operations['repos/merge'] + } + '/repos/{owner}/{repo}/milestones': { + get: operations['issues/list-milestones'] + post: operations['issues/create-milestone'] + } + '/repos/{owner}/{repo}/milestones/{milestone_number}': { + get: operations['issues/get-milestone'] + delete: operations['issues/delete-milestone'] + patch: operations['issues/update-milestone'] + } + '/repos/{owner}/{repo}/milestones/{milestone_number}/labels': { + get: operations['issues/list-labels-for-milestone'] + } + '/repos/{owner}/{repo}/notifications': { /** List all notifications for the current user. */ - get: operations["activity/list-repo-notifications-for-authenticated-user"]; + get: operations['activity/list-repo-notifications-for-authenticated-user'] /** Marks all notifications in a repository as "read" removes them from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ - put: operations["activity/mark-repo-notifications-as-read"]; - }; - "/repos/{owner}/{repo}/pages": { - get: operations["repos/get-pages"]; + put: operations['activity/mark-repo-notifications-as-read'] + } + '/repos/{owner}/{repo}/pages': { + get: operations['repos/get-pages'] /** Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). */ - put: operations["repos/update-information-about-pages-site"]; + put: operations['repos/update-information-about-pages-site'] /** Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)." */ - post: operations["repos/create-pages-site"]; - delete: operations["repos/delete-pages-site"]; - }; - "/repos/{owner}/{repo}/pages/builds": { - get: operations["repos/list-pages-builds"]; + post: operations['repos/create-pages-site'] + delete: operations['repos/delete-pages-site'] + } + '/repos/{owner}/{repo}/pages/builds': { + get: operations['repos/list-pages-builds'] /** * You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures. * * Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes. */ - post: operations["repos/request-pages-build"]; - }; - "/repos/{owner}/{repo}/pages/builds/latest": { - get: operations["repos/get-latest-pages-build"]; - }; - "/repos/{owner}/{repo}/pages/builds/{build_id}": { - get: operations["repos/get-pages-build"]; - }; - "/repos/{owner}/{repo}/pages/health": { + post: operations['repos/request-pages-build'] + } + '/repos/{owner}/{repo}/pages/builds/latest': { + get: operations['repos/get-latest-pages-build'] + } + '/repos/{owner}/{repo}/pages/builds/{build_id}': { + get: operations['repos/get-pages-build'] + } + '/repos/{owner}/{repo}/pages/health': { /** * Gets a health check of the DNS settings for the `CNAME` record configured for a repository's GitHub Pages. * @@ -4140,17 +4140,17 @@ export interface paths { * * Users must have admin or owner permissions. GitHub Apps must have the `pages:write` and `administration:write` permission to use this endpoint. */ - get: operations["repos/get-pages-health-check"]; - }; - "/repos/{owner}/{repo}/projects": { + get: operations['repos/get-pages-health-check'] + } + '/repos/{owner}/{repo}/projects': { /** Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - get: operations["projects/list-for-repo"]; + get: operations['projects/list-for-repo'] /** Creates a repository project board. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - post: operations["projects/create-for-repo"]; - }; - "/repos/{owner}/{repo}/pulls": { + post: operations['projects/create-for-repo'] + } + '/repos/{owner}/{repo}/pulls': { /** Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - get: operations["pulls/list"]; + get: operations['pulls/list'] /** * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -4160,35 +4160,35 @@ export interface paths { * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. */ - post: operations["pulls/create"]; - }; - "/repos/{owner}/{repo}/pulls/comments": { + post: operations['pulls/create'] + } + '/repos/{owner}/{repo}/pulls/comments': { /** Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID. */ - get: operations["pulls/list-review-comments-for-repo"]; - }; - "/repos/{owner}/{repo}/pulls/comments/{comment_id}": { + get: operations['pulls/list-review-comments-for-repo'] + } + '/repos/{owner}/{repo}/pulls/comments/{comment_id}': { /** Provides details for a review comment. */ - get: operations["pulls/get-review-comment"]; + get: operations['pulls/get-review-comment'] /** Deletes a review comment. */ - delete: operations["pulls/delete-review-comment"]; + delete: operations['pulls/delete-review-comment'] /** Enables you to edit a review comment. */ - patch: operations["pulls/update-review-comment"]; - }; - "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": { + patch: operations['pulls/update-review-comment'] + } + '/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions': { /** List the reactions to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). */ - get: operations["reactions/list-for-pull-request-review-comment"]; + get: operations['reactions/list-for-pull-request-review-comment'] /** Create a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#comments). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. */ - post: operations["reactions/create-for-pull-request-review-comment"]; - }; - "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}": { + post: operations['reactions/create-for-pull-request-review-comment'] + } + '/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}': { /** * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` * * Delete a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). */ - delete: operations["reactions/delete-for-pull-request-comment"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}": { + delete: operations['reactions/delete-for-pull-request-comment'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}': { /** * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -4206,25 +4206,25 @@ export interface paths { * * Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. */ - get: operations["pulls/get"]; + get: operations['pulls/get'] /** * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. */ - patch: operations["pulls/update"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": { + patch: operations['pulls/update'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/codespaces': { /** * Creates a codespace owned by the authenticated user for the specified pull request. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - post: operations["codespaces/create-with-pr-for-authenticated-user"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/comments": { + post: operations['codespaces/create-with-pr-for-authenticated-user'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/comments': { /** Lists all review comments for a pull request. By default, review comments are in ascending order by ID. */ - get: operations["pulls/list-review-comments"]; + get: operations['pulls/list-review-comments'] /** * Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/reference/issues#create-an-issue-comment)." We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff. * @@ -4234,38 +4234,38 @@ export interface paths { * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - post: operations["pulls/create-review-comment"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies": { + post: operations['pulls/create-review-comment'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies': { /** * Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - post: operations["pulls/create-reply-for-review-comment"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/commits": { + post: operations['pulls/create-reply-for-review-comment'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/commits': { /** Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/reference/repos#list-commits) endpoint. */ - get: operations["pulls/list-commits"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/files": { + get: operations['pulls/list-commits'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/files': { /** **Note:** Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. */ - get: operations["pulls/list-files"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/merge": { - get: operations["pulls/check-if-merged"]; + get: operations['pulls/list-files'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/merge': { + get: operations['pulls/check-if-merged'] /** This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - put: operations["pulls/merge"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { - get: operations["pulls/list-requested-reviewers"]; + put: operations['pulls/merge'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers': { + get: operations['pulls/list-requested-reviewers'] /** This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - post: operations["pulls/request-reviewers"]; - delete: operations["pulls/remove-requested-reviewers"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/reviews": { + post: operations['pulls/request-reviewers'] + delete: operations['pulls/remove-requested-reviewers'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/reviews': { /** The list of reviews returns in chronological order. */ - get: operations["pulls/list-reviews"]; + get: operations['pulls/list-reviews'] /** * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. * @@ -4275,92 +4275,92 @@ export interface paths { * * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. */ - post: operations["pulls/create-review"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}": { - get: operations["pulls/get-review"]; + post: operations['pulls/create-review'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}': { + get: operations['pulls/get-review'] /** Update the review summary comment with new text. */ - put: operations["pulls/update-review"]; - delete: operations["pulls/delete-pending-review"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments": { + put: operations['pulls/update-review'] + delete: operations['pulls/delete-pending-review'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments': { /** List comments for a specific pull request review. */ - get: operations["pulls/list-comments-for-review"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals": { + get: operations['pulls/list-comments-for-review'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals': { /** **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/reference/repos#branches), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. */ - put: operations["pulls/dismiss-review"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events": { - post: operations["pulls/submit-review"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch": { + put: operations['pulls/dismiss-review'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events': { + post: operations['pulls/submit-review'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/update-branch': { /** Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. */ - put: operations["pulls/update-branch"]; - }; - "/repos/{owner}/{repo}/readme": { + put: operations['pulls/update-branch'] + } + '/repos/{owner}/{repo}/readme': { /** * Gets the preferred README for a repository. * * READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. */ - get: operations["repos/get-readme"]; - }; - "/repos/{owner}/{repo}/readme/{dir}": { + get: operations['repos/get-readme'] + } + '/repos/{owner}/{repo}/readme/{dir}': { /** * Gets the README from a repository directory. * * READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. */ - get: operations["repos/get-readme-in-directory"]; - }; - "/repos/{owner}/{repo}/releases": { + get: operations['repos/get-readme-in-directory'] + } + '/repos/{owner}/{repo}/releases': { /** * This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/rest/reference/repos#list-repository-tags). * * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. */ - get: operations["repos/list-releases"]; + get: operations['repos/list-releases'] /** * Users with push access to the repository can create a release. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - post: operations["repos/create-release"]; - }; - "/repos/{owner}/{repo}/releases/assets/{asset_id}": { + post: operations['repos/create-release'] + } + '/repos/{owner}/{repo}/releases/assets/{asset_id}': { /** To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. */ - get: operations["repos/get-release-asset"]; - delete: operations["repos/delete-release-asset"]; + get: operations['repos/get-release-asset'] + delete: operations['repos/delete-release-asset'] /** Users with push access to the repository can edit a release asset. */ - patch: operations["repos/update-release-asset"]; - }; - "/repos/{owner}/{repo}/releases/generate-notes": { + patch: operations['repos/update-release-asset'] + } + '/repos/{owner}/{repo}/releases/generate-notes': { /** Generate a name and body describing a [release](https://docs.github.com/rest/reference/repos#releases). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. */ - post: operations["repos/generate-release-notes"]; - }; - "/repos/{owner}/{repo}/releases/latest": { + post: operations['repos/generate-release-notes'] + } + '/repos/{owner}/{repo}/releases/latest': { /** * View the latest published full release for the repository. * * The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published. */ - get: operations["repos/get-latest-release"]; - }; - "/repos/{owner}/{repo}/releases/tags/{tag}": { + get: operations['repos/get-latest-release'] + } + '/repos/{owner}/{repo}/releases/tags/{tag}': { /** Get a published release with the specified tag. */ - get: operations["repos/get-release-by-tag"]; - }; - "/repos/{owner}/{repo}/releases/{release_id}": { + get: operations['repos/get-release-by-tag'] + } + '/repos/{owner}/{repo}/releases/{release_id}': { /** **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia). */ - get: operations["repos/get-release"]; + get: operations['repos/get-release'] /** Users with push access to the repository can delete a release. */ - delete: operations["repos/delete-release"]; + delete: operations['repos/delete-release'] /** Users with push access to the repository can edit a release. */ - patch: operations["repos/update-release"]; - }; - "/repos/{owner}/{repo}/releases/{release_id}/assets": { - get: operations["repos/list-release-assets"]; + patch: operations['repos/update-release'] + } + '/repos/{owner}/{repo}/releases/{release_id}/assets': { + get: operations['repos/list-release-assets'] /** * This endpoint makes use of [a Hypermedia relation](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in * the response of the [Create a release endpoint](https://docs.github.com/rest/reference/repos#create-a-release) to upload a release asset. @@ -4381,59 +4381,59 @@ export interface paths { * endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). * * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. */ - post: operations["repos/upload-release-asset"]; - }; - "/repos/{owner}/{repo}/releases/{release_id}/reactions": { + post: operations['repos/upload-release-asset'] + } + '/repos/{owner}/{repo}/releases/{release_id}/reactions': { /** Create a reaction to a [release](https://docs.github.com/rest/reference/repos#releases). A response with a `Status: 200 OK` means that you already added the reaction type to this release. */ - post: operations["reactions/create-for-release"]; - }; - "/repos/{owner}/{repo}/secret-scanning/alerts": { + post: operations['reactions/create-for-release'] + } + '/repos/{owner}/{repo}/secret-scanning/alerts': { /** * Lists secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. */ - get: operations["secret-scanning/list-alerts-for-repo"]; - }; - "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}": { + get: operations['secret-scanning/list-alerts-for-repo'] + } + '/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}': { /** * Gets a single secret scanning alert detected in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. */ - get: operations["secret-scanning/get-alert"]; + get: operations['secret-scanning/get-alert'] /** * Updates the status of a secret scanning alert in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint. */ - patch: operations["secret-scanning/update-alert"]; - }; - "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations": { + patch: operations['secret-scanning/update-alert'] + } + '/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations': { /** * Lists all locations for a given secret scanning alert for a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. */ - get: operations["secret-scanning/list-locations-for-alert"]; - }; - "/repos/{owner}/{repo}/stargazers": { + get: operations['secret-scanning/list-locations-for-alert'] + } + '/repos/{owner}/{repo}/stargazers': { /** * Lists the people that have starred the repository. * * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: */ - get: operations["activity/list-stargazers-for-repo"]; - }; - "/repos/{owner}/{repo}/stats/code_frequency": { + get: operations['activity/list-stargazers-for-repo'] + } + '/repos/{owner}/{repo}/stats/code_frequency': { /** Returns a weekly aggregate of the number of additions and deletions pushed to a repository. */ - get: operations["repos/get-code-frequency-stats"]; - }; - "/repos/{owner}/{repo}/stats/commit_activity": { + get: operations['repos/get-code-frequency-stats'] + } + '/repos/{owner}/{repo}/stats/commit_activity': { /** Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`. */ - get: operations["repos/get-commit-activity-stats"]; - }; - "/repos/{owner}/{repo}/stats/contributors": { + get: operations['repos/get-commit-activity-stats'] + } + '/repos/{owner}/{repo}/stats/contributors': { /** * Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information: * @@ -4442,17 +4442,17 @@ export interface paths { * * `d` - Number of deletions * * `c` - Number of commits */ - get: operations["repos/get-contributors-stats"]; - }; - "/repos/{owner}/{repo}/stats/participation": { + get: operations['repos/get-contributors-stats'] + } + '/repos/{owner}/{repo}/stats/participation': { /** * Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`. * * The array order is oldest week (index 0) to most recent week. */ - get: operations["repos/get-participation-stats"]; - }; - "/repos/{owner}/{repo}/stats/punch_card": { + get: operations['repos/get-participation-stats'] + } + '/repos/{owner}/{repo}/stats/punch_card': { /** * Each array contains the day number, hour number, and number of commits: * @@ -4462,84 +4462,84 @@ export interface paths { * * For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. */ - get: operations["repos/get-punch-card-stats"]; - }; - "/repos/{owner}/{repo}/statuses/{sha}": { + get: operations['repos/get-punch-card-stats'] + } + '/repos/{owner}/{repo}/statuses/{sha}': { /** * Users with push access in a repository can create commit statuses for a given SHA. * * Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error. */ - post: operations["repos/create-commit-status"]; - }; - "/repos/{owner}/{repo}/subscribers": { + post: operations['repos/create-commit-status'] + } + '/repos/{owner}/{repo}/subscribers': { /** Lists the people watching the specified repository. */ - get: operations["activity/list-watchers-for-repo"]; - }; - "/repos/{owner}/{repo}/subscription": { - get: operations["activity/get-repo-subscription"]; + get: operations['activity/list-watchers-for-repo'] + } + '/repos/{owner}/{repo}/subscription': { + get: operations['activity/get-repo-subscription'] /** If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/rest/reference/activity#delete-a-repository-subscription) completely. */ - put: operations["activity/set-repo-subscription"]; + put: operations['activity/set-repo-subscription'] /** This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/rest/reference/activity#set-a-repository-subscription). */ - delete: operations["activity/delete-repo-subscription"]; - }; - "/repos/{owner}/{repo}/tags": { - get: operations["repos/list-tags"]; - }; - "/repos/{owner}/{repo}/tarball/{ref}": { + delete: operations['activity/delete-repo-subscription'] + } + '/repos/{owner}/{repo}/tags': { + get: operations['repos/list-tags'] + } + '/repos/{owner}/{repo}/tarball/{ref}': { /** * Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually * `master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. * **Note**: For private repositories, these links are temporary and expire after five minutes. */ - get: operations["repos/download-tarball-archive"]; - }; - "/repos/{owner}/{repo}/teams": { - get: operations["repos/list-teams"]; - }; - "/repos/{owner}/{repo}/topics": { - get: operations["repos/get-all-topics"]; - put: operations["repos/replace-all-topics"]; - }; - "/repos/{owner}/{repo}/traffic/clones": { + get: operations['repos/download-tarball-archive'] + } + '/repos/{owner}/{repo}/teams': { + get: operations['repos/list-teams'] + } + '/repos/{owner}/{repo}/topics': { + get: operations['repos/get-all-topics'] + put: operations['repos/replace-all-topics'] + } + '/repos/{owner}/{repo}/traffic/clones': { /** Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. */ - get: operations["repos/get-clones"]; - }; - "/repos/{owner}/{repo}/traffic/popular/paths": { + get: operations['repos/get-clones'] + } + '/repos/{owner}/{repo}/traffic/popular/paths': { /** Get the top 10 popular contents over the last 14 days. */ - get: operations["repos/get-top-paths"]; - }; - "/repos/{owner}/{repo}/traffic/popular/referrers": { + get: operations['repos/get-top-paths'] + } + '/repos/{owner}/{repo}/traffic/popular/referrers': { /** Get the top 10 referrers over the last 14 days. */ - get: operations["repos/get-top-referrers"]; - }; - "/repos/{owner}/{repo}/traffic/views": { + get: operations['repos/get-top-referrers'] + } + '/repos/{owner}/{repo}/traffic/views': { /** Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. */ - get: operations["repos/get-views"]; - }; - "/repos/{owner}/{repo}/transfer": { + get: operations['repos/get-views'] + } + '/repos/{owner}/{repo}/transfer': { /** A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/). */ - post: operations["repos/transfer"]; - }; - "/repos/{owner}/{repo}/vulnerability-alerts": { + post: operations['repos/transfer'] + } + '/repos/{owner}/{repo}/vulnerability-alerts': { /** Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". */ - get: operations["repos/check-vulnerability-alerts"]; + get: operations['repos/check-vulnerability-alerts'] /** Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". */ - put: operations["repos/enable-vulnerability-alerts"]; + put: operations['repos/enable-vulnerability-alerts'] /** Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". */ - delete: operations["repos/disable-vulnerability-alerts"]; - }; - "/repos/{owner}/{repo}/zipball/{ref}": { + delete: operations['repos/disable-vulnerability-alerts'] + } + '/repos/{owner}/{repo}/zipball/{ref}': { /** * Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually * `master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. * **Note**: For private repositories, these links are temporary and expire after five minutes. */ - get: operations["repos/download-zipball-archive"]; - }; - "/repos/{template_owner}/{template_repo}/generate": { + get: operations['repos/download-zipball-archive'] + } + '/repos/{template_owner}/{template_repo}/generate': { /** * Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. * @@ -4550,9 +4550,9 @@ export interface paths { * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. * * `repo` scope to create a private repository */ - post: operations["repos/create-using-template"]; - }; - "/repositories": { + post: operations['repos/create-using-template'] + } + '/repositories': { /** * Lists all public repositories in the order that they were created. * @@ -4560,19 +4560,19 @@ export interface paths { * - For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories. */ - get: operations["repos/list-public"]; - }; - "/repositories/{repository_id}/environments/{environment_name}/secrets": { + get: operations['repos/list-public'] + } + '/repositories/{repository_id}/environments/{environment_name}/secrets': { /** Lists all secrets available in an environment without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - get: operations["actions/list-environment-secrets"]; - }; - "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key": { + get: operations['actions/list-environment-secrets'] + } + '/repositories/{repository_id}/environments/{environment_name}/secrets/public-key': { /** Get the public key for an environment, which you need to encrypt environment secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - get: operations["actions/get-environment-public-key"]; - }; - "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": { + get: operations['actions/get-environment-public-key'] + } + '/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}': { /** Gets a single environment secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - get: operations["actions/get-environment-secret"]; + get: operations['actions/get-environment-secret'] /** * Creates or updates an environment secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -4650,39 +4650,39 @@ export interface paths { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - put: operations["actions/create-or-update-environment-secret"]; + put: operations['actions/create-or-update-environment-secret'] /** Deletes a secret in an environment using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - delete: operations["actions/delete-environment-secret"]; - }; - "/scim/v2/enterprises/{enterprise}/Groups": { + delete: operations['actions/delete-environment-secret'] + } + '/scim/v2/enterprises/{enterprise}/Groups': { /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - get: operations["enterprise-admin/list-provisioned-groups-enterprise"]; + get: operations['enterprise-admin/list-provisioned-groups-enterprise'] /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * * Provision an enterprise group, and invite users to the group. This sends invitation emails to the email address of the invited users to join the GitHub organization that the SCIM group corresponds to. */ - post: operations["enterprise-admin/provision-and-invite-enterprise-group"]; - }; - "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": { + post: operations['enterprise-admin/provision-and-invite-enterprise-group'] + } + '/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}': { /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - get: operations["enterprise-admin/get-provisioning-information-for-enterprise-group"]; + get: operations['enterprise-admin/get-provisioning-information-for-enterprise-group'] /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * * Replaces an existing provisioned group’s information. You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead. */ - put: operations["enterprise-admin/set-information-for-provisioned-enterprise-group"]; + put: operations['enterprise-admin/set-information-for-provisioned-enterprise-group'] /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - delete: operations["enterprise-admin/delete-scim-group-from-enterprise"]; + delete: operations['enterprise-admin/delete-scim-group-from-enterprise'] /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * * Allows you to change a provisioned group’s individual attributes. To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). */ - patch: operations["enterprise-admin/update-attribute-for-enterprise-group"]; - }; - "/scim/v2/enterprises/{enterprise}/Users": { + patch: operations['enterprise-admin/update-attribute-for-enterprise-group'] + } + '/scim/v2/enterprises/{enterprise}/Users': { /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * @@ -4703,7 +4703,7 @@ export interface paths { * - If the user signs in, their GitHub account is linked to this entry. * - If the user does not sign in (or does not create a new account when prompted), they are not added to the GitHub enterprise, and the external identity `null` entry remains in place. */ - get: operations["enterprise-admin/list-provisioned-identities-enterprise"]; + get: operations['enterprise-admin/list-provisioned-identities-enterprise'] /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * @@ -4711,11 +4711,11 @@ export interface paths { * * You can optionally include the groups a user will be invited to join. If you do not provide a list of `groups`, the user is provisioned for the enterprise, but no organization invitation emails will be sent. */ - post: operations["enterprise-admin/provision-and-invite-enterprise-user"]; - }; - "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": { + post: operations['enterprise-admin/provision-and-invite-enterprise-user'] + } + '/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}': { /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - get: operations["enterprise-admin/get-provisioning-information-for-enterprise-user"]; + get: operations['enterprise-admin/get-provisioning-information-for-enterprise-user'] /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * @@ -4725,9 +4725,9 @@ export interface paths { * * **Warning:** Setting `active: false` removes the user from the enterprise, deletes the external identity, and deletes the associated `{scim_user_id}`. */ - put: operations["enterprise-admin/set-information-for-provisioned-enterprise-user"]; + put: operations['enterprise-admin/set-information-for-provisioned-enterprise-user'] /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - delete: operations["enterprise-admin/delete-user-from-enterprise"]; + delete: operations['enterprise-admin/delete-user-from-enterprise'] /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * @@ -4748,9 +4748,9 @@ export interface paths { * } * ``` */ - patch: operations["enterprise-admin/update-attribute-for-enterprise-user"]; - }; - "/scim/v2/organizations/{org}/Users": { + patch: operations['enterprise-admin/update-attribute-for-enterprise-user'] + } + '/scim/v2/organizations/{org}/Users': { /** * Retrieves a paginated list of all provisioned organization members, including pending invitations. If you provide the `filter` parameter, the resources for all matching provisions members are returned. * @@ -4769,12 +4769,12 @@ export interface paths { * - If the user signs in, their GitHub account is linked to this entry. * - If the user does not sign in (or does not create a new account when prompted), they are not added to the GitHub organization, and the external identity `null` entry remains in place. */ - get: operations["scim/list-provisioned-identities"]; + get: operations['scim/list-provisioned-identities'] /** Provision organization membership for a user, and send an activation email to the email address. */ - post: operations["scim/provision-and-invite-user"]; - }; - "/scim/v2/organizations/{org}/Users/{scim_user_id}": { - get: operations["scim/get-provisioning-information-for-user"]; + post: operations['scim/provision-and-invite-user'] + } + '/scim/v2/organizations/{org}/Users/{scim_user_id}': { + get: operations['scim/get-provisioning-information-for-user'] /** * Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](https://docs.github.com/rest/reference/scim#update-an-attribute-for-a-scim-user) endpoint instead. * @@ -4782,8 +4782,8 @@ export interface paths { * * **Warning:** Setting `active: false` removes the user from the organization, deletes the external identity, and deletes the associated `{scim_user_id}`. */ - put: operations["scim/set-information-for-provisioned-user"]; - delete: operations["scim/delete-user-from-org"]; + put: operations['scim/set-information-for-provisioned-user'] + delete: operations['scim/delete-user-from-org'] /** * Allows you to change a provisioned user's individual attributes. To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). * @@ -4802,9 +4802,9 @@ export interface paths { * } * ``` */ - patch: operations["scim/update-attribute-for-user"]; - }; - "/search/code": { + patch: operations['scim/update-attribute-for-user'] + } + '/search/code': { /** * Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -4825,9 +4825,9 @@ export interface paths { * * You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing * language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. */ - get: operations["search/code"]; - }; - "/search/commits": { + get: operations['search/code'] + } + '/search/commits': { /** * Find commits via various criteria on the default branch (usually `master`). This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -4838,9 +4838,9 @@ export interface paths { * * `q=repo:octocat/Spoon-Knife+css` */ - get: operations["search/commits"]; - }; - "/search/issues": { + get: operations['search/commits'] + } + '/search/issues': { /** * Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -4855,9 +4855,9 @@ export interface paths { * * **Note:** For [user-to-server](https://docs.github.com/developers/apps/identifying-and-authorizing-users-for-github-apps#user-to-server-requests) GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." */ - get: operations["search/issues-and-pull-requests"]; - }; - "/search/labels": { + get: operations['search/issues-and-pull-requests'] + } + '/search/labels': { /** * Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -4869,9 +4869,9 @@ export interface paths { * * The labels that best match the query appear first in the search results. */ - get: operations["search/labels"]; - }; - "/search/repositories": { + get: operations['search/labels'] + } + '/search/repositories': { /** * Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -4883,9 +4883,9 @@ export interface paths { * * This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results. */ - get: operations["search/repos"]; - }; - "/search/topics": { + get: operations['search/repos'] + } + '/search/topics': { /** * Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers. * @@ -4897,9 +4897,9 @@ export interface paths { * * This query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results. */ - get: operations["search/topics"]; - }; - "/search/users": { + get: operations['search/topics'] + } + '/search/users': { /** * Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -4911,11 +4911,11 @@ export interface paths { * * This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. */ - get: operations["search/users"]; - }; - "/teams/{team_id}": { + get: operations['search/users'] + } + '/teams/{team_id}': { /** **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/reference/teams#get-a-team-by-name) endpoint. */ - get: operations["teams/get-legacy"]; + get: operations['teams/get-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/reference/teams#delete-a-team) endpoint. * @@ -4923,7 +4923,7 @@ export interface paths { * * If you are an organization owner, deleting a parent team will delete all of its child teams as well. */ - delete: operations["teams/delete-legacy"]; + delete: operations['teams/delete-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/reference/teams#update-a-team) endpoint. * @@ -4931,15 +4931,15 @@ export interface paths { * * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. */ - patch: operations["teams/update-legacy"]; - }; - "/teams/{team_id}/discussions": { + patch: operations['teams/update-legacy'] + } + '/teams/{team_id}/discussions': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/reference/teams#list-discussions) endpoint. * * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - get: operations["teams/list-discussions-legacy"]; + get: operations['teams/list-discussions-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/reference/teams#create-a-discussion) endpoint. * @@ -4947,35 +4947,35 @@ export interface paths { * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - post: operations["teams/create-discussion-legacy"]; - }; - "/teams/{team_id}/discussions/{discussion_number}": { + post: operations['teams/create-discussion-legacy'] + } + '/teams/{team_id}/discussions/{discussion_number}': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/reference/teams#get-a-discussion) endpoint. * * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - get: operations["teams/get-discussion-legacy"]; + get: operations['teams/get-discussion-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/reference/teams#delete-a-discussion) endpoint. * * Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - delete: operations["teams/delete-discussion-legacy"]; + delete: operations['teams/delete-discussion-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/reference/teams#update-a-discussion) endpoint. * * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - patch: operations["teams/update-discussion-legacy"]; - }; - "/teams/{team_id}/discussions/{discussion_number}/comments": { + patch: operations['teams/update-discussion-legacy'] + } + '/teams/{team_id}/discussions/{discussion_number}/comments': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/reference/teams#list-discussion-comments) endpoint. * * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - get: operations["teams/list-discussion-comments-legacy"]; + get: operations['teams/list-discussion-comments-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/reference/teams#create-a-discussion-comment) endpoint. * @@ -4983,73 +4983,73 @@ export interface paths { * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - post: operations["teams/create-discussion-comment-legacy"]; - }; - "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": { + post: operations['teams/create-discussion-comment-legacy'] + } + '/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/reference/teams#get-a-discussion-comment) endpoint. * * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - get: operations["teams/get-discussion-comment-legacy"]; + get: operations['teams/get-discussion-comment-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/reference/teams#delete-a-discussion-comment) endpoint. * * Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - delete: operations["teams/delete-discussion-comment-legacy"]; + delete: operations['teams/delete-discussion-comment-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/reference/teams#update-a-discussion-comment) endpoint. * * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - patch: operations["teams/update-discussion-comment-legacy"]; - }; - "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": { + patch: operations['teams/update-discussion-comment-legacy'] + } + '/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * * List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - get: operations["reactions/list-for-team-discussion-comment-legacy"]; + get: operations['reactions/list-for-team-discussion-comment-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. * * Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. */ - post: operations["reactions/create-for-team-discussion-comment-legacy"]; - }; - "/teams/{team_id}/discussions/{discussion_number}/reactions": { + post: operations['reactions/create-for-team-discussion-comment-legacy'] + } + '/teams/{team_id}/discussions/{discussion_number}/reactions': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion) endpoint. * * List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - get: operations["reactions/list-for-team-discussion-legacy"]; + get: operations['reactions/list-for-team-discussion-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion) endpoint. * * Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. */ - post: operations["reactions/create-for-team-discussion-legacy"]; - }; - "/teams/{team_id}/invitations": { + post: operations['reactions/create-for-team-discussion-legacy'] + } + '/teams/{team_id}/invitations': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/reference/teams#list-pending-team-invitations) endpoint. * * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. */ - get: operations["teams/list-pending-invitations-legacy"]; - }; - "/teams/{team_id}/members": { + get: operations['teams/list-pending-invitations-legacy'] + } + '/teams/{team_id}/members': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/reference/teams#list-team-members) endpoint. * * Team members will include the members of child teams. */ - get: operations["teams/list-members-legacy"]; - }; - "/teams/{team_id}/members/{username}": { + get: operations['teams/list-members-legacy'] + } + '/teams/{team_id}/members/{username}': { /** * The "Get team member" endpoint (described below) is deprecated. * @@ -5057,7 +5057,7 @@ export interface paths { * * To list members in a team, the team must be visible to the authenticated user. */ - get: operations["teams/get-member-legacy"]; + get: operations['teams/get-member-legacy'] /** * The "Add team member" endpoint (described below) is deprecated. * @@ -5071,7 +5071,7 @@ export interface paths { * * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - put: operations["teams/add-member-legacy"]; + put: operations['teams/add-member-legacy'] /** * The "Remove team member" endpoint (described below) is deprecated. * @@ -5083,9 +5083,9 @@ export interface paths { * * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ - delete: operations["teams/remove-member-legacy"]; - }; - "/teams/{team_id}/memberships/{username}": { + delete: operations['teams/remove-member-legacy'] + } + '/teams/{team_id}/memberships/{username}': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/reference/teams#get-team-membership-for-a-user) endpoint. * @@ -5098,7 +5098,7 @@ export interface paths { * * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team). */ - get: operations["teams/get-membership-for-user-legacy"]; + get: operations['teams/get-membership-for-user-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint. * @@ -5112,7 +5112,7 @@ export interface paths { * * If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. */ - put: operations["teams/add-or-update-membership-for-user-legacy"]; + put: operations['teams/add-or-update-membership-for-user-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/reference/teams#remove-team-membership-for-a-user) endpoint. * @@ -5122,41 +5122,41 @@ export interface paths { * * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ - delete: operations["teams/remove-membership-for-user-legacy"]; - }; - "/teams/{team_id}/projects": { + delete: operations['teams/remove-membership-for-user-legacy'] + } + '/teams/{team_id}/projects': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/reference/teams#list-team-projects) endpoint. * * Lists the organization projects for a team. */ - get: operations["teams/list-projects-legacy"]; - }; - "/teams/{team_id}/projects/{project_id}": { + get: operations['teams/list-projects-legacy'] + } + '/teams/{team_id}/projects/{project_id}': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/reference/teams#check-team-permissions-for-a-project) endpoint. * * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. */ - get: operations["teams/check-permissions-for-project-legacy"]; + get: operations['teams/check-permissions-for-project-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/reference/teams#add-or-update-team-project-permissions) endpoint. * * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. */ - put: operations["teams/add-or-update-project-permissions-legacy"]; + put: operations['teams/add-or-update-project-permissions-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/reference/teams#remove-a-project-from-a-team) endpoint. * * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. */ - delete: operations["teams/remove-project-legacy"]; - }; - "/teams/{team_id}/repos": { + delete: operations['teams/remove-project-legacy'] + } + '/teams/{team_id}/repos': { /** **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/reference/teams#list-team-repositories) endpoint. */ - get: operations["teams/list-repos-legacy"]; - }; - "/teams/{team_id}/repos/{owner}/{repo}": { + get: operations['teams/list-repos-legacy'] + } + '/teams/{team_id}/repos/{owner}/{repo}': { /** * **Note**: Repositories inherited through a parent team will also be checked. * @@ -5164,7 +5164,7 @@ export interface paths { * * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: */ - get: operations["teams/check-permissions-for-repo-legacy"]; + get: operations['teams/check-permissions-for-repo-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/reference/teams#add-or-update-team-repository-permissions)" endpoint. * @@ -5172,15 +5172,15 @@ export interface paths { * * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - put: operations["teams/add-or-update-repo-permissions-legacy"]; + put: operations['teams/add-or-update-repo-permissions-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/reference/teams#remove-a-repository-from-a-team) endpoint. * * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. */ - delete: operations["teams/remove-repo-legacy"]; - }; - "/teams/{team_id}/team-sync/group-mappings": { + delete: operations['teams/remove-repo-legacy'] + } + '/teams/{team_id}/team-sync/group-mappings': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List IdP groups for a team`](https://docs.github.com/rest/reference/teams#list-idp-groups-for-a-team) endpoint. * @@ -5188,7 +5188,7 @@ export interface paths { * * List IdP groups connected to a team on GitHub. */ - get: operations["teams/list-idp-groups-for-legacy"]; + get: operations['teams/list-idp-groups-for-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create or update IdP group connections`](https://docs.github.com/rest/reference/teams#create-or-update-idp-group-connections) endpoint. * @@ -5196,38 +5196,38 @@ export interface paths { * * Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty `groups` array will remove all connections for a team. */ - patch: operations["teams/create-or-update-idp-group-connections-legacy"]; - }; - "/teams/{team_id}/teams": { + patch: operations['teams/create-or-update-idp-group-connections-legacy'] + } + '/teams/{team_id}/teams': { /** **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/reference/teams#list-child-teams) endpoint. */ - get: operations["teams/list-child-legacy"]; - }; - "/user": { + get: operations['teams/list-child-legacy'] + } + '/user': { /** * If the authenticated user is authenticated through basic authentication or OAuth with the `user` scope, then the response lists public and private profile information. * * If the authenticated user is authenticated through OAuth without the `user` scope, then the response lists only public profile information. */ - get: operations["users/get-authenticated"]; + get: operations['users/get-authenticated'] /** **Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API. */ - patch: operations["users/update-authenticated"]; - }; - "/user/blocks": { + patch: operations['users/update-authenticated'] + } + '/user/blocks': { /** List the users you've blocked on your personal account. */ - get: operations["users/list-blocked-by-authenticated-user"]; - }; - "/user/blocks/{username}": { - get: operations["users/check-blocked"]; - put: operations["users/block"]; - delete: operations["users/unblock"]; - }; - "/user/codespaces": { + get: operations['users/list-blocked-by-authenticated-user'] + } + '/user/blocks/{username}': { + get: operations['users/check-blocked'] + put: operations['users/block'] + delete: operations['users/unblock'] + } + '/user/codespaces': { /** * Lists the authenticated user's codespaces. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - get: operations["codespaces/list-for-authenticated-user"]; + get: operations['codespaces/list-for-authenticated-user'] /** * Creates a new codespace, owned by the authenticated user. * @@ -5235,26 +5235,26 @@ export interface paths { * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - post: operations["codespaces/create-for-authenticated-user"]; - }; - "/user/codespaces/secrets": { + post: operations['codespaces/create-for-authenticated-user'] + } + '/user/codespaces/secrets': { /** * Lists all secrets available for a user's Codespaces without revealing their * encrypted values. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - get: operations["codespaces/list-secrets-for-authenticated-user"]; - }; - "/user/codespaces/secrets/public-key": { + get: operations['codespaces/list-secrets-for-authenticated-user'] + } + '/user/codespaces/secrets/public-key': { /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with one of the 'read:user' or 'user' scopes in their personal access token. User must have Codespaces access to use this endpoint. */ - get: operations["codespaces/get-public-key-for-authenticated-user"]; - }; - "/user/codespaces/secrets/{secret_name}": { + get: operations['codespaces/get-public-key-for-authenticated-user'] + } + '/user/codespaces/secrets/{secret_name}': { /** * Gets a secret available to a user's codespaces without revealing its encrypted value. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - get: operations["codespaces/get-secret-for-authenticated-user"]; + get: operations['codespaces/get-secret-for-authenticated-user'] /** * Creates or updates a secret for a user's codespace with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access token with the `user` scope to use this endpoint. User must also have Codespaces access to use this endpoint. @@ -5330,47 +5330,47 @@ export interface paths { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - put: operations["codespaces/create-or-update-secret-for-authenticated-user"]; + put: operations['codespaces/create-or-update-secret-for-authenticated-user'] /** Deletes a secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret. You must authenticate using an access token with the `user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - delete: operations["codespaces/delete-secret-for-authenticated-user"]; - }; - "/user/codespaces/secrets/{secret_name}/repositories": { + delete: operations['codespaces/delete-secret-for-authenticated-user'] + } + '/user/codespaces/secrets/{secret_name}/repositories': { /** * List the repositories that have been granted the ability to use a user's codespace secret. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - get: operations["codespaces/list-repositories-for-secret-for-authenticated-user"]; + get: operations['codespaces/list-repositories-for-secret-for-authenticated-user'] /** * Select the repositories that will use a user's codespace secret. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - put: operations["codespaces/set-repositories-for-secret-for-authenticated-user"]; - }; - "/user/codespaces/secrets/{secret_name}/repositories/{repository_id}": { + put: operations['codespaces/set-repositories-for-secret-for-authenticated-user'] + } + '/user/codespaces/secrets/{secret_name}/repositories/{repository_id}': { /** * Adds a repository to the selected repositories for a user's codespace secret. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - put: operations["codespaces/add-repository-for-secret-for-authenticated-user"]; + put: operations['codespaces/add-repository-for-secret-for-authenticated-user'] /** * Removes a repository from the selected repositories for a user's codespace secret. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - delete: operations["codespaces/remove-repository-for-secret-for-authenticated-user"]; - }; - "/user/codespaces/{codespace_name}": { + delete: operations['codespaces/remove-repository-for-secret-for-authenticated-user'] + } + '/user/codespaces/{codespace_name}': { /** * Gets information about a user's codespace. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - get: operations["codespaces/get-for-authenticated-user"]; + get: operations['codespaces/get-for-authenticated-user'] /** * Deletes a user's codespace. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - delete: operations["codespaces/delete-for-authenticated-user"]; + delete: operations['codespaces/delete-for-authenticated-user'] /** * Updates a codespace owned by the authenticated user. Currently only the codespace's machine type and recent folders can be modified using this endpoint. * @@ -5378,92 +5378,92 @@ export interface paths { * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - patch: operations["codespaces/update-for-authenticated-user"]; - }; - "/user/codespaces/{codespace_name}/exports": { + patch: operations['codespaces/update-for-authenticated-user'] + } + '/user/codespaces/{codespace_name}/exports': { /** * Triggers an export of the specified codespace and returns a URL and ID where the status of the export can be monitored. * * You must authenticate using a personal access token with the `codespace` scope to use this endpoint. */ - post: operations["codespaces/export-for-authenticated-user"]; - }; - "/user/codespaces/{codespace_name}/exports/{export_id}": { + post: operations['codespaces/export-for-authenticated-user'] + } + '/user/codespaces/{codespace_name}/exports/{export_id}': { /** * Gets information about an export of a codespace. * * You must authenticate using a personal access token with the `codespace` scope to use this endpoint. */ - get: operations["codespaces/get-export-details-for-authenticated-user"]; - }; - "/user/codespaces/{codespace_name}/machines": { + get: operations['codespaces/get-export-details-for-authenticated-user'] + } + '/user/codespaces/{codespace_name}/machines': { /** * List the machine types a codespace can transition to use. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - get: operations["codespaces/codespace-machines-for-authenticated-user"]; - }; - "/user/codespaces/{codespace_name}/start": { + get: operations['codespaces/codespace-machines-for-authenticated-user'] + } + '/user/codespaces/{codespace_name}/start': { /** * Starts a user's codespace. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - post: operations["codespaces/start-for-authenticated-user"]; - }; - "/user/codespaces/{codespace_name}/stop": { + post: operations['codespaces/start-for-authenticated-user'] + } + '/user/codespaces/{codespace_name}/stop': { /** * Stops a user's codespace. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - post: operations["codespaces/stop-for-authenticated-user"]; - }; - "/user/email/visibility": { + post: operations['codespaces/stop-for-authenticated-user'] + } + '/user/email/visibility': { /** Sets the visibility for your primary email addresses. */ - patch: operations["users/set-primary-email-visibility-for-authenticated-user"]; - }; - "/user/emails": { + patch: operations['users/set-primary-email-visibility-for-authenticated-user'] + } + '/user/emails': { /** Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope. */ - get: operations["users/list-emails-for-authenticated-user"]; + get: operations['users/list-emails-for-authenticated-user'] /** This endpoint is accessible with the `user` scope. */ - post: operations["users/add-email-for-authenticated-user"]; + post: operations['users/add-email-for-authenticated-user'] /** This endpoint is accessible with the `user` scope. */ - delete: operations["users/delete-email-for-authenticated-user"]; - }; - "/user/followers": { + delete: operations['users/delete-email-for-authenticated-user'] + } + '/user/followers': { /** Lists the people following the authenticated user. */ - get: operations["users/list-followers-for-authenticated-user"]; - }; - "/user/following": { + get: operations['users/list-followers-for-authenticated-user'] + } + '/user/following': { /** Lists the people who the authenticated user follows. */ - get: operations["users/list-followed-by-authenticated-user"]; - }; - "/user/following/{username}": { - get: operations["users/check-person-is-followed-by-authenticated"]; + get: operations['users/list-followed-by-authenticated-user'] + } + '/user/following/{username}': { + get: operations['users/check-person-is-followed-by-authenticated'] /** * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." * * Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. */ - put: operations["users/follow"]; + put: operations['users/follow'] /** Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. */ - delete: operations["users/unfollow"]; - }; - "/user/gpg_keys": { + delete: operations['users/unfollow'] + } + '/user/gpg_keys': { /** Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - get: operations["users/list-gpg-keys-for-authenticated-user"]; + get: operations['users/list-gpg-keys-for-authenticated-user'] /** Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - post: operations["users/create-gpg-key-for-authenticated-user"]; - }; - "/user/gpg_keys/{gpg_key_id}": { + post: operations['users/create-gpg-key-for-authenticated-user'] + } + '/user/gpg_keys/{gpg_key_id}': { /** View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - get: operations["users/get-gpg-key-for-authenticated-user"]; + get: operations['users/get-gpg-key-for-authenticated-user'] /** Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - delete: operations["users/delete-gpg-key-for-authenticated-user"]; - }; - "/user/installations": { + delete: operations['users/delete-gpg-key-for-authenticated-user'] + } + '/user/installations': { /** * Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. * @@ -5473,9 +5473,9 @@ export interface paths { * * You can find the permissions for the installation under the `permissions` key. */ - get: operations["apps/list-installations-for-authenticated-user"]; - }; - "/user/installations/{installation_id}/repositories": { + get: operations['apps/list-installations-for-authenticated-user'] + } + '/user/installations/{installation_id}/repositories': { /** * List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation. * @@ -5485,31 +5485,31 @@ export interface paths { * * The access the user has to each repository is included in the hash under the `permissions` key. */ - get: operations["apps/list-installation-repos-for-authenticated-user"]; - }; - "/user/installations/{installation_id}/repositories/{repository_id}": { + get: operations['apps/list-installation-repos-for-authenticated-user'] + } + '/user/installations/{installation_id}/repositories/{repository_id}': { /** * Add a single repository to an installation. The authenticated user must have admin access to the repository. * * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. */ - put: operations["apps/add-repo-to-installation-for-authenticated-user"]; + put: operations['apps/add-repo-to-installation-for-authenticated-user'] /** * Remove a single repository from an installation. The authenticated user must have admin access to the repository. * * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. */ - delete: operations["apps/remove-repo-from-installation-for-authenticated-user"]; - }; - "/user/interaction-limits": { + delete: operations['apps/remove-repo-from-installation-for-authenticated-user'] + } + '/user/interaction-limits': { /** Shows which type of GitHub user can interact with your public repositories and when the restriction expires. */ - get: operations["interactions/get-restrictions-for-authenticated-user"]; + get: operations['interactions/get-restrictions-for-authenticated-user'] /** Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user. */ - put: operations["interactions/set-restrictions-for-authenticated-user"]; + put: operations['interactions/set-restrictions-for-authenticated-user'] /** Removes any interaction restrictions from your public repositories. */ - delete: operations["interactions/remove-restrictions-for-authenticated-user"]; - }; - "/user/issues": { + delete: operations['interactions/remove-restrictions-for-authenticated-user'] + } + '/user/issues': { /** * List issues across owned and member repositories assigned to the authenticated user. * @@ -5518,42 +5518,42 @@ export interface paths { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - get: operations["issues/list-for-authenticated-user"]; - }; - "/user/keys": { + get: operations['issues/list-for-authenticated-user'] + } + '/user/keys': { /** Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - get: operations["users/list-public-ssh-keys-for-authenticated-user"]; + get: operations['users/list-public-ssh-keys-for-authenticated-user'] /** Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - post: operations["users/create-public-ssh-key-for-authenticated-user"]; - }; - "/user/keys/{key_id}": { + post: operations['users/create-public-ssh-key-for-authenticated-user'] + } + '/user/keys/{key_id}': { /** View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - get: operations["users/get-public-ssh-key-for-authenticated-user"]; + get: operations['users/get-public-ssh-key-for-authenticated-user'] /** Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - delete: operations["users/delete-public-ssh-key-for-authenticated-user"]; - }; - "/user/marketplace_purchases": { + delete: operations['users/delete-public-ssh-key-for-authenticated-user'] + } + '/user/marketplace_purchases': { /** Lists the active subscriptions for the authenticated user. You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an [OAuth token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/). */ - get: operations["apps/list-subscriptions-for-authenticated-user"]; - }; - "/user/marketplace_purchases/stubbed": { + get: operations['apps/list-subscriptions-for-authenticated-user'] + } + '/user/marketplace_purchases/stubbed': { /** Lists the active subscriptions for the authenticated user. You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an [OAuth token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/). */ - get: operations["apps/list-subscriptions-for-authenticated-user-stubbed"]; - }; - "/user/memberships/orgs": { - get: operations["orgs/list-memberships-for-authenticated-user"]; - }; - "/user/memberships/orgs/{org}": { - get: operations["orgs/get-membership-for-authenticated-user"]; - patch: operations["orgs/update-membership-for-authenticated-user"]; - }; - "/user/migrations": { + get: operations['apps/list-subscriptions-for-authenticated-user-stubbed'] + } + '/user/memberships/orgs': { + get: operations['orgs/list-memberships-for-authenticated-user'] + } + '/user/memberships/orgs/{org}': { + get: operations['orgs/get-membership-for-authenticated-user'] + patch: operations['orgs/update-membership-for-authenticated-user'] + } + '/user/migrations': { /** Lists all migrations a user has started. */ - get: operations["migrations/list-for-authenticated-user"]; + get: operations['migrations/list-for-authenticated-user'] /** Initiates the generation of a user migration archive. */ - post: operations["migrations/start-for-authenticated-user"]; - }; - "/user/migrations/{migration_id}": { + post: operations['migrations/start-for-authenticated-user'] + } + '/user/migrations/{migration_id}': { /** * Fetches a single user migration. The response includes the `state` of the migration, which can be one of the following values: * @@ -5564,9 +5564,9 @@ export interface paths { * * Once the migration has been `exported` you can [download the migration archive](https://docs.github.com/rest/reference/migrations#download-a-user-migration-archive). */ - get: operations["migrations/get-status-for-authenticated-user"]; - }; - "/user/migrations/{migration_id}/archive": { + get: operations['migrations/get-status-for-authenticated-user'] + } + '/user/migrations/{migration_id}/archive': { /** * Fetches the URL to download the migration archive as a `tar.gz` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects: * @@ -5590,19 +5590,19 @@ export interface paths { * * The archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data. */ - get: operations["migrations/get-archive-for-authenticated-user"]; + get: operations['migrations/get-archive-for-authenticated-user'] /** Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the [List user migrations](https://docs.github.com/rest/reference/migrations#list-user-migrations) and [Get a user migration status](https://docs.github.com/rest/reference/migrations#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted. */ - delete: operations["migrations/delete-archive-for-authenticated-user"]; - }; - "/user/migrations/{migration_id}/repos/{repo_name}/lock": { + delete: operations['migrations/delete-archive-for-authenticated-user'] + } + '/user/migrations/{migration_id}/repos/{repo_name}/lock': { /** Unlocks a repository. You can lock repositories when you [start a user migration](https://docs.github.com/rest/reference/migrations#start-a-user-migration). Once the migration is complete you can unlock each repository to begin using it again or [delete the repository](https://docs.github.com/rest/reference/repos#delete-a-repository) if you no longer need the source data. Returns a status of `404 Not Found` if the repository is not locked. */ - delete: operations["migrations/unlock-repo-for-authenticated-user"]; - }; - "/user/migrations/{migration_id}/repositories": { + delete: operations['migrations/unlock-repo-for-authenticated-user'] + } + '/user/migrations/{migration_id}/repositories': { /** Lists all the repositories for this user migration. */ - get: operations["migrations/list-repos-for-authenticated-user"]; - }; - "/user/orgs": { + get: operations['migrations/list-repos-for-authenticated-user'] + } + '/user/orgs': { /** * List organizations for the authenticated user. * @@ -5610,34 +5610,34 @@ export interface paths { * * This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response. */ - get: operations["orgs/list-for-authenticated-user"]; - }; - "/user/packages": { + get: operations['orgs/list-for-authenticated-user'] + } + '/user/packages': { /** * Lists packages owned by the authenticated user within the user's namespace. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/list-packages-for-authenticated-user"]; - }; - "/user/packages/{package_type}/{package_name}": { + get: operations['packages/list-packages-for-authenticated-user'] + } + '/user/packages/{package_type}/{package_name}': { /** * Gets a specific package for a package owned by the authenticated user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/get-package-for-authenticated-user"]; + get: operations['packages/get-package-for-authenticated-user'] /** * Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:delete` scopes. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - delete: operations["packages/delete-package-for-authenticated-user"]; - }; - "/user/packages/{package_type}/{package_name}/restore": { + delete: operations['packages/delete-package-for-authenticated-user'] + } + '/user/packages/{package_type}/{package_name}/restore': { /** * Restores a package owned by the authenticated user. * @@ -5647,34 +5647,34 @@ export interface paths { * * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. If `package_type` is not `container`, your token must also include the `repo` scope. */ - post: operations["packages/restore-package-for-authenticated-user"]; - }; - "/user/packages/{package_type}/{package_name}/versions": { + post: operations['packages/restore-package-for-authenticated-user'] + } + '/user/packages/{package_type}/{package_name}/versions': { /** * Returns all package versions for a package owned by the authenticated user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/get-all-package-versions-for-package-owned-by-authenticated-user"]; - }; - "/user/packages/{package_type}/{package_name}/versions/{package_version_id}": { + get: operations['packages/get-all-package-versions-for-package-owned-by-authenticated-user'] + } + '/user/packages/{package_type}/{package_name}/versions/{package_version_id}': { /** * Gets a specific package version for a package owned by the authenticated user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/get-package-version-for-authenticated-user"]; + get: operations['packages/get-package-version-for-authenticated-user'] /** * Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:delete` scopes. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - delete: operations["packages/delete-package-version-for-authenticated-user"]; - }; - "/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { + delete: operations['packages/delete-package-version-for-authenticated-user'] + } + '/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore': { /** * Restores a package version owned by the authenticated user. * @@ -5684,22 +5684,22 @@ export interface paths { * * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. If `package_type` is not `container`, your token must also include the `repo` scope. */ - post: operations["packages/restore-package-version-for-authenticated-user"]; - }; - "/user/projects": { - post: operations["projects/create-for-authenticated-user"]; - }; - "/user/public_emails": { + post: operations['packages/restore-package-version-for-authenticated-user'] + } + '/user/projects': { + post: operations['projects/create-for-authenticated-user'] + } + '/user/public_emails': { /** Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope. */ - get: operations["users/list-public-emails-for-authenticated-user"]; - }; - "/user/repos": { + get: operations['users/list-public-emails-for-authenticated-user'] + } + '/user/repos': { /** * Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. * * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. */ - get: operations["repos/list-for-authenticated-user"]; + get: operations['repos/list-for-authenticated-user'] /** * Creates a new repository for the authenticated user. * @@ -5710,47 +5710,47 @@ export interface paths { * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. * * `repo` scope to create a private repository. */ - post: operations["repos/create-for-authenticated-user"]; - }; - "/user/repository_invitations": { + post: operations['repos/create-for-authenticated-user'] + } + '/user/repository_invitations': { /** When authenticating as a user, this endpoint will list all currently open repository invitations for that user. */ - get: operations["repos/list-invitations-for-authenticated-user"]; - }; - "/user/repository_invitations/{invitation_id}": { - delete: operations["repos/decline-invitation-for-authenticated-user"]; - patch: operations["repos/accept-invitation-for-authenticated-user"]; - }; - "/user/starred": { + get: operations['repos/list-invitations-for-authenticated-user'] + } + '/user/repository_invitations/{invitation_id}': { + delete: operations['repos/decline-invitation-for-authenticated-user'] + patch: operations['repos/accept-invitation-for-authenticated-user'] + } + '/user/starred': { /** * Lists repositories the authenticated user has starred. * * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: */ - get: operations["activity/list-repos-starred-by-authenticated-user"]; - }; - "/user/starred/{owner}/{repo}": { - get: operations["activity/check-repo-is-starred-by-authenticated-user"]; + get: operations['activity/list-repos-starred-by-authenticated-user'] + } + '/user/starred/{owner}/{repo}': { + get: operations['activity/check-repo-is-starred-by-authenticated-user'] /** Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - put: operations["activity/star-repo-for-authenticated-user"]; - delete: operations["activity/unstar-repo-for-authenticated-user"]; - }; - "/user/subscriptions": { + put: operations['activity/star-repo-for-authenticated-user'] + delete: operations['activity/unstar-repo-for-authenticated-user'] + } + '/user/subscriptions': { /** Lists repositories the authenticated user is watching. */ - get: operations["activity/list-watched-repos-for-authenticated-user"]; - }; - "/user/teams": { + get: operations['activity/list-watched-repos-for-authenticated-user'] + } + '/user/teams': { /** List all of the teams across all of the organizations to which the authenticated user belongs. This method requires `user`, `repo`, or `read:org` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://docs.github.com/apps/building-oauth-apps/). */ - get: operations["teams/list-for-authenticated-user"]; - }; - "/users": { + get: operations['teams/list-for-authenticated-user'] + } + '/users': { /** * Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts. * * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of users. */ - get: operations["users/list"]; - }; - "/users/{username}": { + get: operations['users/list'] + } + '/users/{username}': { /** * Provides publicly available information about someone with a GitHub account. * @@ -5760,39 +5760,39 @@ export interface paths { * * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/reference/users#emails)". */ - get: operations["users/get-by-username"]; - }; - "/users/{username}/events": { + get: operations['users/get-by-username'] + } + '/users/{username}/events': { /** If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. */ - get: operations["activity/list-events-for-authenticated-user"]; - }; - "/users/{username}/events/orgs/{org}": { + get: operations['activity/list-events-for-authenticated-user'] + } + '/users/{username}/events/orgs/{org}': { /** This is the user's organization dashboard. You must be authenticated as the user to view this. */ - get: operations["activity/list-org-events-for-authenticated-user"]; - }; - "/users/{username}/events/public": { - get: operations["activity/list-public-events-for-user"]; - }; - "/users/{username}/followers": { + get: operations['activity/list-org-events-for-authenticated-user'] + } + '/users/{username}/events/public': { + get: operations['activity/list-public-events-for-user'] + } + '/users/{username}/followers': { /** Lists the people following the specified user. */ - get: operations["users/list-followers-for-user"]; - }; - "/users/{username}/following": { + get: operations['users/list-followers-for-user'] + } + '/users/{username}/following': { /** Lists the people who the specified user follows. */ - get: operations["users/list-following-for-user"]; - }; - "/users/{username}/following/{target_user}": { - get: operations["users/check-following-for-user"]; - }; - "/users/{username}/gists": { + get: operations['users/list-following-for-user'] + } + '/users/{username}/following/{target_user}': { + get: operations['users/check-following-for-user'] + } + '/users/{username}/gists': { /** Lists public gists for the specified user: */ - get: operations["gists/list-for-user"]; - }; - "/users/{username}/gpg_keys": { + get: operations['gists/list-for-user'] + } + '/users/{username}/gpg_keys': { /** Lists the GPG keys for a user. This information is accessible by anyone. */ - get: operations["users/list-gpg-keys-for-user"]; - }; - "/users/{username}/hovercard": { + get: operations['users/list-gpg-keys-for-user'] + } + '/users/{username}/hovercard': { /** * Provides hovercard information when authenticated through basic auth or OAuth with the `repo` scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. * @@ -5803,45 +5803,45 @@ export interface paths { * https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 * ``` */ - get: operations["users/get-context-for-user"]; - }; - "/users/{username}/installation": { + get: operations['users/get-context-for-user'] + } + '/users/{username}/installation': { /** * Enables an authenticated GitHub App to find the user’s installation information. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - get: operations["apps/get-user-installation"]; - }; - "/users/{username}/keys": { + get: operations['apps/get-user-installation'] + } + '/users/{username}/keys': { /** Lists the _verified_ public SSH keys for a user. This is accessible by anyone. */ - get: operations["users/list-public-keys-for-user"]; - }; - "/users/{username}/orgs": { + get: operations['users/list-public-keys-for-user'] + } + '/users/{username}/orgs': { /** * List [public organization memberships](https://docs.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user. * * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/rest/reference/orgs#list-organizations-for-the-authenticated-user) API instead. */ - get: operations["orgs/list-for-user"]; - }; - "/users/{username}/packages": { + get: operations['orgs/list-for-user'] + } + '/users/{username}/packages': { /** * Lists all packages in a user's namespace for which the requesting user has access. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/list-packages-for-user"]; - }; - "/users/{username}/packages/{package_type}/{package_name}": { + get: operations['packages/list-packages-for-user'] + } + '/users/{username}/packages/{package_type}/{package_name}': { /** * Gets a specific package metadata for a public package owned by a user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/get-package-for-user"]; + get: operations['packages/get-package-for-user'] /** * Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * @@ -5849,9 +5849,9 @@ export interface paths { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. */ - delete: operations["packages/delete-package-for-user"]; - }; - "/users/{username}/packages/{package_type}/{package_name}/restore": { + delete: operations['packages/delete-package-for-user'] + } + '/users/{username}/packages/{package_type}/{package_name}/restore': { /** * Restores an entire package for a user. * @@ -5863,25 +5863,25 @@ export interface paths { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. */ - post: operations["packages/restore-package-for-user"]; - }; - "/users/{username}/packages/{package_type}/{package_name}/versions": { + post: operations['packages/restore-package-for-user'] + } + '/users/{username}/packages/{package_type}/{package_name}/versions': { /** * Returns all package versions for a public package owned by a specified user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/get-all-package-versions-for-package-owned-by-user"]; - }; - "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}": { + get: operations['packages/get-all-package-versions-for-package-owned-by-user'] + } + '/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}': { /** * Gets a specific package version for a public package owned by a specified user. * * At this time, to use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/get-package-version-for-user"]; + get: operations['packages/get-package-version-for-user'] /** * Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * @@ -5889,9 +5889,9 @@ export interface paths { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. */ - delete: operations["packages/delete-package-version-for-user"]; - }; - "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { + delete: operations['packages/delete-package-version-for-user'] + } + '/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore': { /** * Restores a specific package version for a user. * @@ -5903,23 +5903,23 @@ export interface paths { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. */ - post: operations["packages/restore-package-version-for-user"]; - }; - "/users/{username}/projects": { - get: operations["projects/list-for-user"]; - }; - "/users/{username}/received_events": { + post: operations['packages/restore-package-version-for-user'] + } + '/users/{username}/projects': { + get: operations['projects/list-for-user'] + } + '/users/{username}/received_events': { /** These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. */ - get: operations["activity/list-received-events-for-user"]; - }; - "/users/{username}/received_events/public": { - get: operations["activity/list-received-public-events-for-user"]; - }; - "/users/{username}/repos": { + get: operations['activity/list-received-events-for-user'] + } + '/users/{username}/received_events/public': { + get: operations['activity/list-received-public-events-for-user'] + } + '/users/{username}/repos': { /** Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user. */ - get: operations["repos/list-for-user"]; - }; - "/users/{username}/settings/billing/actions": { + get: operations['repos/list-for-user'] + } + '/users/{username}/settings/billing/actions': { /** * Gets the summary of the free and paid GitHub Actions minutes used. * @@ -5927,9 +5927,9 @@ export interface paths { * * Access tokens must have the `user` scope. */ - get: operations["billing/get-github-actions-billing-user"]; - }; - "/users/{username}/settings/billing/packages": { + get: operations['billing/get-github-actions-billing-user'] + } + '/users/{username}/settings/billing/packages': { /** * Gets the free and paid storage used for GitHub Packages in gigabytes. * @@ -5937,9 +5937,9 @@ export interface paths { * * Access tokens must have the `user` scope. */ - get: operations["billing/get-github-packages-billing-user"]; - }; - "/users/{username}/settings/billing/shared-storage": { + get: operations['billing/get-github-packages-billing-user'] + } + '/users/{username}/settings/billing/shared-storage': { /** * Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. * @@ -5947,24 +5947,24 @@ export interface paths { * * Access tokens must have the `user` scope. */ - get: operations["billing/get-shared-storage-billing-user"]; - }; - "/users/{username}/starred": { + get: operations['billing/get-shared-storage-billing-user'] + } + '/users/{username}/starred': { /** * Lists repositories a user has starred. * * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: */ - get: operations["activity/list-repos-starred-by-user"]; - }; - "/users/{username}/subscriptions": { + get: operations['activity/list-repos-starred-by-user'] + } + '/users/{username}/subscriptions': { /** Lists repositories a user is watching. */ - get: operations["activity/list-repos-watched-by-user"]; - }; - "/zen": { + get: operations['activity/list-repos-watched-by-user'] + } + '/zen': { /** Get a random sentence from the Zen of GitHub */ - get: operations["meta/get-zen"]; - }; + get: operations['meta/get-zen'] + } } export interface components { @@ -5973,73 +5973,73 @@ export interface components { * Simple User * @description Simple User */ - "nullable-simple-user": + 'nullable-simple-user': | ({ - name?: string | null; - email?: string | null; + name?: string | null + email?: string | null /** @example octocat */ - login: string; + login: string /** @example 1 */ - id: number; + id: number /** @example MDQ6VXNlcjE= */ - node_id: string; + node_id: string /** * Format: uri * @example https://github.com/images/error/octocat_happy.gif */ - avatar_url: string; + avatar_url: string /** @example 41d064eb2195891e12d0413f63227ea7 */ - gravatar_id: string | null; + gravatar_id: string | null /** * Format: uri * @example https://api.github.com/users/octocat */ - url: string; + url: string /** * Format: uri * @example https://github.com/octocat */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/users/octocat/followers */ - followers_url: string; + followers_url: string /** @example https://api.github.com/users/octocat/following{/other_user} */ - following_url: string; + following_url: string /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - gists_url: string; + gists_url: string /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - starred_url: string; + starred_url: string /** * Format: uri * @example https://api.github.com/users/octocat/subscriptions */ - subscriptions_url: string; + subscriptions_url: string /** * Format: uri * @example https://api.github.com/users/octocat/orgs */ - organizations_url: string; + organizations_url: string /** * Format: uri * @example https://api.github.com/users/octocat/repos */ - repos_url: string; + repos_url: string /** @example https://api.github.com/users/octocat/events{/privacy} */ - events_url: string; + events_url: string /** * Format: uri * @example https://api.github.com/users/octocat/received_events */ - received_events_url: string; + received_events_url: string /** @example User */ - type: string; - site_admin: boolean; + type: string + site_admin: boolean /** @example "2020-07-09T00:17:55Z" */ - starred_at?: string; + starred_at?: string } & { [key: string]: unknown }) - | null; + | null /** * GitHub app * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. @@ -6049,554 +6049,554 @@ export interface components { * @description Unique identifier of the GitHub app * @example 37 */ - id: number; + id: number /** * @description The slug name of the GitHub app * @example probot-owners */ - slug?: string; + slug?: string /** @example MDExOkludGVncmF0aW9uMQ== */ - node_id: string; - owner: components["schemas"]["nullable-simple-user"]; + node_id: string + owner: components['schemas']['nullable-simple-user'] /** * @description The name of the GitHub app * @example Probot Owners */ - name: string; + name: string /** @example The description of the app. */ - description: string | null; + description: string | null /** * Format: uri * @example https://example.com */ - external_url: string; + external_url: string /** * Format: uri * @example https://github.com/apps/super-ci */ - html_url: string; + html_url: string /** * Format: date-time * @example 2017-07-08T16:18:44-04:00 */ - created_at: string; + created_at: string /** * Format: date-time * @example 2017-07-08T16:18:44-04:00 */ - updated_at: string; + updated_at: string /** * @description The set of permissions for the GitHub app * @example [object Object] */ permissions: { - issues?: string; - checks?: string; - metadata?: string; - contents?: string; - deployments?: string; - } & { [key: string]: string }; + issues?: string + checks?: string + metadata?: string + contents?: string + deployments?: string + } & { [key: string]: string } /** * @description The list of events for the GitHub app * @example label,deployment */ - events: string[]; + events: string[] /** * @description The number of installations associated with the GitHub app * @example 5 */ - installations_count?: number; + installations_count?: number /** @example "Iv1.25b5d1e65ffc4022" */ - client_id?: string; + client_id?: string /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ - client_secret?: string; + client_secret?: string /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ - webhook_secret?: string | null; + webhook_secret?: string | null /** @example "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n" */ - pem?: string; - } & { [key: string]: unknown }; + pem?: string + } & { [key: string]: unknown } /** * Basic Error * @description Basic Error */ - "basic-error": { - message?: string; - documentation_url?: string; - url?: string; - status?: string; - } & { [key: string]: unknown }; + 'basic-error': { + message?: string + documentation_url?: string + url?: string + status?: string + } & { [key: string]: unknown } /** * Validation Error Simple * @description Validation Error Simple */ - "validation-error-simple": { - message: string; - documentation_url: string; - errors?: string[]; - } & { [key: string]: unknown }; + 'validation-error-simple': { + message: string + documentation_url: string + errors?: string[] + } & { [key: string]: unknown } /** * Format: uri * @description The URL to which the payloads will be delivered. * @example https://example.com/webhook */ - "webhook-config-url": string; + 'webhook-config-url': string /** * @description The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`. * @example "json" */ - "webhook-config-content-type": string; + 'webhook-config-content-type': string /** * @description If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers). * @example "********" */ - "webhook-config-secret": string; - "webhook-config-insecure-ssl": (string | number) & { [key: string]: unknown }; + 'webhook-config-secret': string + 'webhook-config-insecure-ssl': (string | number) & { [key: string]: unknown } /** * Webhook Configuration * @description Configuration object of the webhook */ - "webhook-config": { - url?: components["schemas"]["webhook-config-url"]; - content_type?: components["schemas"]["webhook-config-content-type"]; - secret?: components["schemas"]["webhook-config-secret"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - } & { [key: string]: unknown }; + 'webhook-config': { + url?: components['schemas']['webhook-config-url'] + content_type?: components['schemas']['webhook-config-content-type'] + secret?: components['schemas']['webhook-config-secret'] + insecure_ssl?: components['schemas']['webhook-config-insecure-ssl'] + } & { [key: string]: unknown } /** * Simple webhook delivery * @description Delivery made by a webhook, without request and response information. */ - "hook-delivery-item": { + 'hook-delivery-item': { /** * @description Unique identifier of the webhook delivery. * @example 42 */ - id: number; + id: number /** * @description Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event). * @example 58474f00-b361-11eb-836d-0e4f3503ccbe */ - guid: string; + guid: string /** * Format: date-time * @description Time when the webhook delivery occurred. * @example 2021-05-12T20:33:44Z */ - delivered_at: string; + delivered_at: string /** @description Whether the webhook delivery is a redelivery. */ - redelivery: boolean; + redelivery: boolean /** * @description Time spent delivering. * @example 0.03 */ - duration: number; + duration: number /** * @description Describes the response returned after attempting the delivery. * @example failed to connect */ - status: string; + status: string /** * @description Status code received when delivery was made. * @example 502 */ - status_code: number; + status_code: number /** * @description The event that triggered the delivery. * @example issues */ - event: string; + event: string /** * @description The type of activity for the event that triggered the delivery. * @example opened */ - action: string | null; + action: string | null /** * @description The id of the GitHub App installation associated with this event. * @example 123 */ - installation_id: number | null; + installation_id: number | null /** * @description The id of the repository associated with this event. * @example 123 */ - repository_id: number | null; - } & { [key: string]: unknown }; + repository_id: number | null + } & { [key: string]: unknown } /** * Scim Error * @description Scim Error */ - "scim-error": { - message?: string | null; - documentation_url?: string | null; - detail?: string | null; - status?: number; - scimType?: string | null; - schemas?: string[]; - } & { [key: string]: unknown }; + 'scim-error': { + message?: string | null + documentation_url?: string | null + detail?: string | null + status?: number + scimType?: string | null + schemas?: string[] + } & { [key: string]: unknown } /** * Validation Error * @description Validation Error */ - "validation-error": { - message: string; - documentation_url: string; + 'validation-error': { + message: string + documentation_url: string errors?: ({ - resource?: string; - field?: string; - message?: string; - code: string; - index?: number; - value?: ((string | null) | (number | null) | (string[] | null)) & { [key: string]: unknown }; - } & { [key: string]: unknown })[]; - } & { [key: string]: unknown }; + resource?: string + field?: string + message?: string + code: string + index?: number + value?: ((string | null) | (number | null) | (string[] | null)) & { [key: string]: unknown } + } & { [key: string]: unknown })[] + } & { [key: string]: unknown } /** * Webhook delivery * @description Delivery made by a webhook. */ - "hook-delivery": { + 'hook-delivery': { /** * @description Unique identifier of the delivery. * @example 42 */ - id: number; + id: number /** * @description Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event). * @example 58474f00-b361-11eb-836d-0e4f3503ccbe */ - guid: string; + guid: string /** * Format: date-time * @description Time when the delivery was delivered. * @example 2021-05-12T20:33:44Z */ - delivered_at: string; + delivered_at: string /** @description Whether the delivery is a redelivery. */ - redelivery: boolean; + redelivery: boolean /** * @description Time spent delivering. * @example 0.03 */ - duration: number; + duration: number /** * @description Description of the status of the attempted delivery * @example failed to connect */ - status: string; + status: string /** * @description Status code received when delivery was made. * @example 502 */ - status_code: number; + status_code: number /** * @description The event that triggered the delivery. * @example issues */ - event: string; + event: string /** * @description The type of activity for the event that triggered the delivery. * @example opened */ - action: string | null; + action: string | null /** * @description The id of the GitHub App installation associated with this event. * @example 123 */ - installation_id: number | null; + installation_id: number | null /** * @description The id of the repository associated with this event. * @example 123 */ - repository_id: number | null; + repository_id: number | null /** * @description The URL target of the delivery. * @example https://www.example.com */ - url?: string; + url?: string request: { /** @description The request headers sent with the webhook delivery. */ - headers: { [key: string]: unknown } | null; + headers: { [key: string]: unknown } | null /** @description The webhook payload. */ - payload: { [key: string]: unknown } | null; - } & { [key: string]: unknown }; + payload: { [key: string]: unknown } | null + } & { [key: string]: unknown } response: { /** @description The response headers received when the delivery was made. */ - headers: { [key: string]: unknown } | null; + headers: { [key: string]: unknown } | null /** @description The response payload received. */ - payload: string | null; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + payload: string | null + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** * Simple User * @description Simple User */ - "simple-user": { - name?: string | null; - email?: string | null; + 'simple-user': { + name?: string | null + email?: string | null /** @example octocat */ - login: string; + login: string /** @example 1 */ - id: number; + id: number /** @example MDQ6VXNlcjE= */ - node_id: string; + node_id: string /** * Format: uri * @example https://github.com/images/error/octocat_happy.gif */ - avatar_url: string; + avatar_url: string /** @example 41d064eb2195891e12d0413f63227ea7 */ - gravatar_id: string | null; + gravatar_id: string | null /** * Format: uri * @example https://api.github.com/users/octocat */ - url: string; + url: string /** * Format: uri * @example https://github.com/octocat */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/users/octocat/followers */ - followers_url: string; + followers_url: string /** @example https://api.github.com/users/octocat/following{/other_user} */ - following_url: string; + following_url: string /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - gists_url: string; + gists_url: string /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - starred_url: string; + starred_url: string /** * Format: uri * @example https://api.github.com/users/octocat/subscriptions */ - subscriptions_url: string; + subscriptions_url: string /** * Format: uri * @example https://api.github.com/users/octocat/orgs */ - organizations_url: string; + organizations_url: string /** * Format: uri * @example https://api.github.com/users/octocat/repos */ - repos_url: string; + repos_url: string /** @example https://api.github.com/users/octocat/events{/privacy} */ - events_url: string; + events_url: string /** * Format: uri * @example https://api.github.com/users/octocat/received_events */ - received_events_url: string; + received_events_url: string /** @example User */ - type: string; - site_admin: boolean; + type: string + site_admin: boolean /** @example "2020-07-09T00:17:55Z" */ - starred_at?: string; - } & { [key: string]: unknown }; + starred_at?: string + } & { [key: string]: unknown } /** * Enterprise * @description An enterprise account */ enterprise: { /** @description A short description of the enterprise. */ - description?: string | null; + description?: string | null /** * Format: uri * @example https://github.com/enterprises/octo-business */ - html_url: string; + html_url: string /** * Format: uri * @description The enterprise's website URL. */ - website_url?: string | null; + website_url?: string | null /** * @description Unique identifier of the enterprise * @example 42 */ - id: number; + id: number /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - node_id: string; + node_id: string /** * @description The name of the enterprise. * @example Octo Business */ - name: string; + name: string /** * @description The slug url identifier for the enterprise. * @example octo-business */ - slug: string; + slug: string /** * Format: date-time * @example 2019-01-26T19:01:12Z */ - created_at: string | null; + created_at: string | null /** * Format: date-time * @example 2019-01-26T19:14:43Z */ - updated_at: string | null; + updated_at: string | null /** Format: uri */ - avatar_url: string; - } & { [key: string]: unknown }; + avatar_url: string + } & { [key: string]: unknown } /** * App Permissions * @description The permissions granted to the user-to-server access token. * @example [object Object] */ - "app-permissions": { + 'app-permissions': { /** * @description The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts. Can be one of: `read` or `write`. * @enum {string} */ - actions?: "read" | "write"; + actions?: 'read' | 'write' /** * @description The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation. Can be one of: `read` or `write`. * @enum {string} */ - administration?: "read" | "write"; + administration?: 'read' | 'write' /** * @description The level of permission to grant the access token for checks on code. Can be one of: `read` or `write`. * @enum {string} */ - checks?: "read" | "write"; + checks?: 'read' | 'write' /** * @description The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges. Can be one of: `read` or `write`. * @enum {string} */ - contents?: "read" | "write"; + contents?: 'read' | 'write' /** * @description The level of permission to grant the access token for deployments and deployment statuses. Can be one of: `read` or `write`. * @enum {string} */ - deployments?: "read" | "write"; + deployments?: 'read' | 'write' /** * @description The level of permission to grant the access token for managing repository environments. Can be one of: `read` or `write`. * @enum {string} */ - environments?: "read" | "write"; + environments?: 'read' | 'write' /** * @description The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones. Can be one of: `read` or `write`. * @enum {string} */ - issues?: "read" | "write"; + issues?: 'read' | 'write' /** * @description The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata. Can be one of: `read` or `write`. * @enum {string} */ - metadata?: "read" | "write"; + metadata?: 'read' | 'write' /** * @description The level of permission to grant the access token for packages published to GitHub Packages. Can be one of: `read` or `write`. * @enum {string} */ - packages?: "read" | "write"; + packages?: 'read' | 'write' /** * @description The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds. Can be one of: `read` or `write`. * @enum {string} */ - pages?: "read" | "write"; + pages?: 'read' | 'write' /** * @description The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges. Can be one of: `read` or `write`. * @enum {string} */ - pull_requests?: "read" | "write"; + pull_requests?: 'read' | 'write' /** * @description The level of permission to grant the access token to manage the post-receive hooks for a repository. Can be one of: `read` or `write`. * @enum {string} */ - repository_hooks?: "read" | "write"; + repository_hooks?: 'read' | 'write' /** * @description The level of permission to grant the access token to manage repository projects, columns, and cards. Can be one of: `read`, `write`, or `admin`. * @enum {string} */ - repository_projects?: "read" | "write" | "admin"; + repository_projects?: 'read' | 'write' | 'admin' /** * @description The level of permission to grant the access token to view and manage secret scanning alerts. Can be one of: `read` or `write`. * @enum {string} */ - secret_scanning_alerts?: "read" | "write"; + secret_scanning_alerts?: 'read' | 'write' /** * @description The level of permission to grant the access token to manage repository secrets. Can be one of: `read` or `write`. * @enum {string} */ - secrets?: "read" | "write"; + secrets?: 'read' | 'write' /** * @description The level of permission to grant the access token to view and manage security events like code scanning alerts. Can be one of: `read` or `write`. * @enum {string} */ - security_events?: "read" | "write"; + security_events?: 'read' | 'write' /** * @description The level of permission to grant the access token to manage just a single file. Can be one of: `read` or `write`. * @enum {string} */ - single_file?: "read" | "write"; + single_file?: 'read' | 'write' /** * @description The level of permission to grant the access token for commit statuses. Can be one of: `read` or `write`. * @enum {string} */ - statuses?: "read" | "write"; + statuses?: 'read' | 'write' /** * @description The level of permission to grant the access token to manage Dependabot alerts. Can be one of: `read` or `write`. * @enum {string} */ - vulnerability_alerts?: "read" | "write"; + vulnerability_alerts?: 'read' | 'write' /** * @description The level of permission to grant the access token to update GitHub Actions workflow files. Can be one of: `write`. * @enum {string} */ - workflows?: "write"; + workflows?: 'write' /** * @description The level of permission to grant the access token for organization teams and members. Can be one of: `read` or `write`. * @enum {string} */ - members?: "read" | "write"; + members?: 'read' | 'write' /** * @description The level of permission to grant the access token to manage access to an organization. Can be one of: `read` or `write`. * @enum {string} */ - organization_administration?: "read" | "write"; + organization_administration?: 'read' | 'write' /** * @description The level of permission to grant the access token to manage the post-receive hooks for an organization. Can be one of: `read` or `write`. * @enum {string} */ - organization_hooks?: "read" | "write"; + organization_hooks?: 'read' | 'write' /** * @description The level of permission to grant the access token for viewing an organization's plan. Can be one of: `read`. * @enum {string} */ - organization_plan?: "read"; + organization_plan?: 'read' /** * @description The level of permission to grant the access token to manage organization projects and projects beta (where available). Can be one of: `read`, `write`, or `admin`. * @enum {string} */ - organization_projects?: "read" | "write" | "admin"; + organization_projects?: 'read' | 'write' | 'admin' /** * @description The level of permission to grant the access token for organization packages published to GitHub Packages. Can be one of: `read` or `write`. * @enum {string} */ - organization_packages?: "read" | "write"; + organization_packages?: 'read' | 'write' /** * @description The level of permission to grant the access token to manage organization secrets. Can be one of: `read` or `write`. * @enum {string} */ - organization_secrets?: "read" | "write"; + organization_secrets?: 'read' | 'write' /** * @description The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization. Can be one of: `read` or `write`. * @enum {string} */ - organization_self_hosted_runners?: "read" | "write"; + organization_self_hosted_runners?: 'read' | 'write' /** * @description The level of permission to grant the access token to view and manage users blocked by the organization. Can be one of: `read` or `write`. * @enum {string} */ - organization_user_blocking?: "read" | "write"; + organization_user_blocking?: 'read' | 'write' /** * @description The level of permission to grant the access token to manage team discussions and related comments. Can be one of: `read` or `write`. * @enum {string} */ - team_discussions?: "read" | "write"; - } & { [key: string]: unknown }; + team_discussions?: 'read' | 'write' + } & { [key: string]: unknown } /** * Installation * @description Installation @@ -6606,81 +6606,77 @@ export interface components { * @description The ID of the installation. * @example 1 */ - id: number; - account: - | ((Partial & Partial) & { - [key: string]: unknown; - }) - | null; + id: number + account: ((Partial & Partial) & { [key: string]: unknown }) | null /** * @description Describe whether all repositories have been selected or there's a selection involved * @enum {string} */ - repository_selection: "all" | "selected"; + repository_selection: 'all' | 'selected' /** * Format: uri * @example https://api.github.com/installations/1/access_tokens */ - access_tokens_url: string; + access_tokens_url: string /** * Format: uri * @example https://api.github.com/installation/repositories */ - repositories_url: string; + repositories_url: string /** * Format: uri * @example https://github.com/organizations/github/settings/installations/1 */ - html_url: string; + html_url: string /** @example 1 */ - app_id: number; + app_id: number /** @description The ID of the user or organization this token is being scoped to. */ - target_id: number; + target_id: number /** @example Organization */ - target_type: string; - permissions: components["schemas"]["app-permissions"]; - events: string[]; + target_type: string + permissions: components['schemas']['app-permissions'] + events: string[] /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; + updated_at: string /** @example config.yaml */ - single_file_name: string | null; + single_file_name: string | null /** @example true */ - has_multiple_single_files?: boolean; + has_multiple_single_files?: boolean /** @example config.yml,.github/issue_TEMPLATE.md */ - single_file_paths?: string[]; + single_file_paths?: string[] /** @example github-actions */ - app_slug: string; - suspended_by: components["schemas"]["nullable-simple-user"]; + app_slug: string + suspended_by: components['schemas']['nullable-simple-user'] /** Format: date-time */ - suspended_at: string | null; + suspended_at: string | null /** @example "test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com" */ - contact_email?: string | null; - } & { [key: string]: unknown }; + contact_email?: string | null + } & { [key: string]: unknown } /** * License Simple * @description License Simple */ - "nullable-license-simple": + 'nullable-license-simple': | ({ /** @example mit */ - key: string; + key: string /** @example MIT License */ - name: string; + name: string /** * Format: uri * @example https://api.github.com/licenses/mit */ - url: string | null; + url: string | null /** @example MIT */ - spdx_id: string | null; + spdx_id: string | null /** @example MDc6TGljZW5zZW1pdA== */ - node_id: string; + node_id: string /** Format: uri */ - html_url?: string; + html_url?: string } & { [key: string]: unknown }) - | null; + | null /** * Repository * @description A git repository @@ -6690,507 +6686,507 @@ export interface components { * @description Unique identifier of the repository * @example 42 */ - id: number; + id: number /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - node_id: string; + node_id: string /** * @description The name of the repository. * @example Team Environment */ - name: string; + name: string /** @example octocat/Hello-World */ - full_name: string; - license: components["schemas"]["nullable-license-simple"]; - organization?: components["schemas"]["nullable-simple-user"]; - forks: number; + full_name: string + license: components['schemas']['nullable-license-simple'] + organization?: components['schemas']['nullable-simple-user'] + forks: number permissions?: { - admin: boolean; - pull: boolean; - triage?: boolean; - push: boolean; - maintain?: boolean; - } & { [key: string]: unknown }; - owner: components["schemas"]["simple-user"]; + admin: boolean + pull: boolean + triage?: boolean + push: boolean + maintain?: boolean + } & { [key: string]: unknown } + owner: components['schemas']['simple-user'] /** @description Whether the repository is private or public. */ - private: boolean; + private: boolean /** * Format: uri * @example https://github.com/octocat/Hello-World */ - html_url: string; + html_url: string /** @example This your first repo! */ - description: string | null; - fork: boolean; + description: string | null + fork: boolean /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World */ - url: string; + url: string /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - archive_url: string; + archive_url: string /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - assignees_url: string; + assignees_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - blobs_url: string; + blobs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - branches_url: string; + branches_url: string /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - collaborators_url: string; + collaborators_url: string /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - comments_url: string; + comments_url: string /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - commits_url: string; + commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - compare_url: string; + compare_url: string /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - contents_url: string; + contents_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - contributors_url: string; + contributors_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - deployments_url: string; + deployments_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - downloads_url: string; + downloads_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events */ - events_url: string; + events_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ - forks_url: string; + forks_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - git_commits_url: string; + git_commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - git_refs_url: string; + git_refs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - git_tags_url: string; + git_tags_url: string /** @example git:github.com/octocat/Hello-World.git */ - git_url: string; + git_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - issue_comment_url: string; + issue_comment_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - issue_events_url: string; + issue_events_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - issues_url: string; + issues_url: string /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - keys_url: string; + keys_url: string /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - labels_url: string; + labels_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ - languages_url: string; + languages_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ - merges_url: string; + merges_url: string /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - milestones_url: string; + milestones_url: string /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - notifications_url: string; + notifications_url: string /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - pulls_url: string; + pulls_url: string /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - releases_url: string; + releases_url: string /** @example git@github.com:octocat/Hello-World.git */ - ssh_url: string; + ssh_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - stargazers_url: string; + stargazers_url: string /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - statuses_url: string; + statuses_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - subscribers_url: string; + subscribers_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - subscription_url: string; + subscription_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ - tags_url: string; + tags_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ - teams_url: string; + teams_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - trees_url: string; + trees_url: string /** @example https://github.com/octocat/Hello-World.git */ - clone_url: string; + clone_url: string /** * Format: uri * @example git:git.example.com/octocat/Hello-World */ - mirror_url: string | null; + mirror_url: string | null /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - hooks_url: string; + hooks_url: string /** * Format: uri * @example https://svn.github.com/octocat/Hello-World */ - svn_url: string; + svn_url: string /** * Format: uri * @example https://github.com */ - homepage: string | null; - language: string | null; + homepage: string | null + language: string | null /** @example 9 */ - forks_count: number; + forks_count: number /** @example 80 */ - stargazers_count: number; + stargazers_count: number /** @example 80 */ - watchers_count: number; + watchers_count: number /** @example 108 */ - size: number; + size: number /** * @description The default branch of the repository. * @example master */ - default_branch: string; - open_issues_count: number; + default_branch: string + open_issues_count: number /** * @description Whether this repository acts as a template that can be used to generate new repositories. * @example true */ - is_template?: boolean; - topics?: string[]; + is_template?: boolean + topics?: string[] /** * @description Whether issues are enabled. * @default true * @example true */ - has_issues: boolean; + has_issues: boolean /** * @description Whether projects are enabled. * @default true * @example true */ - has_projects: boolean; + has_projects: boolean /** * @description Whether the wiki is enabled. * @default true * @example true */ - has_wiki: boolean; - has_pages: boolean; + has_wiki: boolean + has_pages: boolean /** * @description Whether downloads are enabled. * @default true * @example true */ - has_downloads: boolean; + has_downloads: boolean /** @description Whether the repository is archived. */ - archived: boolean; + archived: boolean /** @description Returns whether or not this repository disabled. */ - disabled: boolean; + disabled: boolean /** * @description The repository visibility: public, private, or internal. * @default public */ - visibility?: string; + visibility?: string /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - pushed_at: string | null; + pushed_at: string | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - created_at: string | null; + created_at: string | null /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - updated_at: string | null; + updated_at: string | null /** * @description Whether to allow rebase merges for pull requests. * @default true * @example true */ - allow_rebase_merge?: boolean; + allow_rebase_merge?: boolean template_repository?: | ({ - id?: number; - node_id?: string; - name?: string; - full_name?: string; + id?: number + node_id?: string + name?: string + full_name?: string owner?: { - login?: string; - id?: number; - node_id?: string; - avatar_url?: string; - gravatar_id?: string; - url?: string; - html_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - starred_url?: string; - subscriptions_url?: string; - organizations_url?: string; - repos_url?: string; - events_url?: string; - received_events_url?: string; - type?: string; - site_admin?: boolean; - } & { [key: string]: unknown }; - private?: boolean; - html_url?: string; - description?: string; - fork?: boolean; - url?: string; - archive_url?: string; - assignees_url?: string; - blobs_url?: string; - branches_url?: string; - collaborators_url?: string; - comments_url?: string; - commits_url?: string; - compare_url?: string; - contents_url?: string; - contributors_url?: string; - deployments_url?: string; - downloads_url?: string; - events_url?: string; - forks_url?: string; - git_commits_url?: string; - git_refs_url?: string; - git_tags_url?: string; - git_url?: string; - issue_comment_url?: string; - issue_events_url?: string; - issues_url?: string; - keys_url?: string; - labels_url?: string; - languages_url?: string; - merges_url?: string; - milestones_url?: string; - notifications_url?: string; - pulls_url?: string; - releases_url?: string; - ssh_url?: string; - stargazers_url?: string; - statuses_url?: string; - subscribers_url?: string; - subscription_url?: string; - tags_url?: string; - teams_url?: string; - trees_url?: string; - clone_url?: string; - mirror_url?: string; - hooks_url?: string; - svn_url?: string; - homepage?: string; - language?: string; - forks_count?: number; - stargazers_count?: number; - watchers_count?: number; - size?: number; - default_branch?: string; - open_issues_count?: number; - is_template?: boolean; - topics?: string[]; - has_issues?: boolean; - has_projects?: boolean; - has_wiki?: boolean; - has_pages?: boolean; - has_downloads?: boolean; - archived?: boolean; - disabled?: boolean; - visibility?: string; - pushed_at?: string; - created_at?: string; - updated_at?: string; + login?: string + id?: number + node_id?: string + avatar_url?: string + gravatar_id?: string + url?: string + html_url?: string + followers_url?: string + following_url?: string + gists_url?: string + starred_url?: string + subscriptions_url?: string + organizations_url?: string + repos_url?: string + events_url?: string + received_events_url?: string + type?: string + site_admin?: boolean + } & { [key: string]: unknown } + private?: boolean + html_url?: string + description?: string + fork?: boolean + url?: string + archive_url?: string + assignees_url?: string + blobs_url?: string + branches_url?: string + collaborators_url?: string + comments_url?: string + commits_url?: string + compare_url?: string + contents_url?: string + contributors_url?: string + deployments_url?: string + downloads_url?: string + events_url?: string + forks_url?: string + git_commits_url?: string + git_refs_url?: string + git_tags_url?: string + git_url?: string + issue_comment_url?: string + issue_events_url?: string + issues_url?: string + keys_url?: string + labels_url?: string + languages_url?: string + merges_url?: string + milestones_url?: string + notifications_url?: string + pulls_url?: string + releases_url?: string + ssh_url?: string + stargazers_url?: string + statuses_url?: string + subscribers_url?: string + subscription_url?: string + tags_url?: string + teams_url?: string + trees_url?: string + clone_url?: string + mirror_url?: string + hooks_url?: string + svn_url?: string + homepage?: string + language?: string + forks_count?: number + stargazers_count?: number + watchers_count?: number + size?: number + default_branch?: string + open_issues_count?: number + is_template?: boolean + topics?: string[] + has_issues?: boolean + has_projects?: boolean + has_wiki?: boolean + has_pages?: boolean + has_downloads?: boolean + archived?: boolean + disabled?: boolean + visibility?: string + pushed_at?: string + created_at?: string + updated_at?: string permissions?: { - admin?: boolean; - maintain?: boolean; - push?: boolean; - triage?: boolean; - pull?: boolean; - } & { [key: string]: unknown }; - allow_rebase_merge?: boolean; - temp_clone_token?: string; - allow_squash_merge?: boolean; - allow_auto_merge?: boolean; - delete_branch_on_merge?: boolean; - allow_update_branch?: boolean; - allow_merge_commit?: boolean; - subscribers_count?: number; - network_count?: number; + admin?: boolean + maintain?: boolean + push?: boolean + triage?: boolean + pull?: boolean + } & { [key: string]: unknown } + allow_rebase_merge?: boolean + temp_clone_token?: string + allow_squash_merge?: boolean + allow_auto_merge?: boolean + delete_branch_on_merge?: boolean + allow_update_branch?: boolean + allow_merge_commit?: boolean + subscribers_count?: number + network_count?: number } & { [key: string]: unknown }) - | null; - temp_clone_token?: string; + | null + temp_clone_token?: string /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - allow_squash_merge?: boolean; + allow_squash_merge?: boolean /** @description Whether to allow Auto-merge to be used on pull requests. */ - allow_auto_merge?: boolean; + allow_auto_merge?: boolean /** @description Whether to delete head branches when pull requests are merged */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge?: boolean /** * @description Whether to allow merge commits for pull requests. * @default true * @example true */ - allow_merge_commit?: boolean; + allow_merge_commit?: boolean /** @description Whether to allow forking this repo */ - allow_forking?: boolean; - subscribers_count?: number; - network_count?: number; - open_issues: number; - watchers: number; - master_branch?: string; + allow_forking?: boolean + subscribers_count?: number + network_count?: number + open_issues: number + watchers: number + master_branch?: string /** @example "2020-07-09T00:17:42Z" */ - starred_at?: string; - } & { [key: string]: unknown }; + starred_at?: string + } & { [key: string]: unknown } /** * Installation Token * @description Authentication token for a GitHub App installed on a user or org. */ - "installation-token": { - token: string; - expires_at: string; - permissions?: components["schemas"]["app-permissions"]; + 'installation-token': { + token: string + expires_at: string + permissions?: components['schemas']['app-permissions'] /** @enum {string} */ - repository_selection?: "all" | "selected"; - repositories?: components["schemas"]["repository"][]; + repository_selection?: 'all' | 'selected' + repositories?: components['schemas']['repository'][] /** @example README.md */ - single_file?: string; + single_file?: string /** @example true */ - has_multiple_single_files?: boolean; + has_multiple_single_files?: boolean /** @example config.yml,.github/issue_TEMPLATE.md */ - single_file_paths?: string[]; - } & { [key: string]: unknown }; + single_file_paths?: string[] + } & { [key: string]: unknown } /** * Application Grant * @description The authorization associated with an OAuth Access. */ - "application-grant": { + 'application-grant': { /** @example 1 */ - id: number; + id: number /** * Format: uri * @example https://api.github.com/applications/grants/1 */ - url: string; + url: string app: { - client_id: string; - name: string; + client_id: string + name: string /** Format: uri */ - url: string; - } & { [key: string]: unknown }; + url: string + } & { [key: string]: unknown } /** * Format: date-time * @example 2011-09-06T17:26:27Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2011-09-06T20:39:23Z */ - updated_at: string; + updated_at: string /** @example public_repo */ - scopes: string[]; - user?: components["schemas"]["nullable-simple-user"]; - } & { [key: string]: unknown }; + scopes: string[] + user?: components['schemas']['nullable-simple-user'] + } & { [key: string]: unknown } /** Scoped Installation */ - "nullable-scoped-installation": + 'nullable-scoped-installation': | ({ - permissions: components["schemas"]["app-permissions"]; + permissions: components['schemas']['app-permissions'] /** * @description Describe whether all repositories have been selected or there's a selection involved * @enum {string} */ - repository_selection: "all" | "selected"; + repository_selection: 'all' | 'selected' /** @example config.yaml */ - single_file_name: string | null; + single_file_name: string | null /** @example true */ - has_multiple_single_files?: boolean; + has_multiple_single_files?: boolean /** @example config.yml,.github/issue_TEMPLATE.md */ - single_file_paths?: string[]; + single_file_paths?: string[] /** * Format: uri * @example https://api.github.com/users/octocat/repos */ - repositories_url: string; - account: components["schemas"]["simple-user"]; + repositories_url: string + account: components['schemas']['simple-user'] } & { [key: string]: unknown }) - | null; + | null /** * Authorization * @description The authorization for an OAuth app, GitHub App, or a Personal Access Token. */ authorization: { - id: number; + id: number /** Format: uri */ - url: string; + url: string /** @description A list of scopes that this authorization is in. */ - scopes: string[] | null; - token: string; - token_last_eight: string | null; - hashed_token: string | null; + scopes: string[] | null + token: string + token_last_eight: string | null + hashed_token: string | null app: { - client_id: string; - name: string; + client_id: string + name: string /** Format: uri */ - url: string; - } & { [key: string]: unknown }; - note: string | null; + url: string + } & { [key: string]: unknown } + note: string | null /** Format: uri */ - note_url: string | null; + note_url: string | null /** Format: date-time */ - updated_at: string; + updated_at: string /** Format: date-time */ - created_at: string; - fingerprint: string | null; - user?: components["schemas"]["nullable-simple-user"]; - installation?: components["schemas"]["nullable-scoped-installation"]; + created_at: string + fingerprint: string | null + user?: components['schemas']['nullable-simple-user'] + installation?: components['schemas']['nullable-scoped-installation'] /** Format: date-time */ - expires_at: string | null; - } & { [key: string]: unknown }; + expires_at: string | null + } & { [key: string]: unknown } /** * Code Of Conduct * @description Code Of Conduct */ - "code-of-conduct": { + 'code-of-conduct': { /** @example contributor_covenant */ - key: string; + key: string /** @example Contributor Covenant */ - name: string; + name: string /** * Format: uri * @example https://api.github.com/codes_of_conduct/contributor_covenant */ - url: string; + url: string /** * @example # Contributor Covenant Code of Conduct * @@ -7241,100 +7237,100 @@ export interface components { * [homepage]: http://contributor-covenant.org * [version]: http://contributor-covenant.org/version/1/4/ */ - body?: string; + body?: string /** Format: uri */ - html_url: string | null; - } & { [key: string]: unknown }; + html_url: string | null + } & { [key: string]: unknown } /** * @description The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`. * @enum {string} */ - "enabled-organizations": "all" | "none" | "selected"; + 'enabled-organizations': 'all' | 'none' | 'selected' /** * @description The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`. * @enum {string} */ - "allowed-actions": "all" | "local_only" | "selected"; + 'allowed-actions': 'all' | 'local_only' | 'selected' /** @description The API URL to use to get or set the actions that are allowed to run, when `allowed_actions` is set to `selected`. */ - "selected-actions-url": string; - "actions-enterprise-permissions": { - enabled_organizations: components["schemas"]["enabled-organizations"]; + 'selected-actions-url': string + 'actions-enterprise-permissions': { + enabled_organizations: components['schemas']['enabled-organizations'] /** @description The API URL to use to get or set the selected organizations that are allowed to run GitHub Actions, when `enabled_organizations` is set to `selected`. */ - selected_organizations_url?: string; - allowed_actions?: components["schemas"]["allowed-actions"]; - selected_actions_url?: components["schemas"]["selected-actions-url"]; - } & { [key: string]: unknown }; + selected_organizations_url?: string + allowed_actions?: components['schemas']['allowed-actions'] + selected_actions_url?: components['schemas']['selected-actions-url'] + } & { [key: string]: unknown } /** * Organization Simple * @description Organization Simple */ - "organization-simple": { + 'organization-simple': { /** @example github */ - login: string; + login: string /** @example 1 */ - id: number; + id: number /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ - node_id: string; + node_id: string /** * Format: uri * @example https://api.github.com/orgs/github */ - url: string; + url: string /** * Format: uri * @example https://api.github.com/orgs/github/repos */ - repos_url: string; + repos_url: string /** * Format: uri * @example https://api.github.com/orgs/github/events */ - events_url: string; + events_url: string /** @example https://api.github.com/orgs/github/hooks */ - hooks_url: string; + hooks_url: string /** @example https://api.github.com/orgs/github/issues */ - issues_url: string; + issues_url: string /** @example https://api.github.com/orgs/github/members{/member} */ - members_url: string; + members_url: string /** @example https://api.github.com/orgs/github/public_members{/member} */ - public_members_url: string; + public_members_url: string /** @example https://github.com/images/error/octocat_happy.gif */ - avatar_url: string; + avatar_url: string /** @example A great organization */ - description: string | null; - } & { [key: string]: unknown }; - "selected-actions": { + description: string | null + } & { [key: string]: unknown } + 'selected-actions': { /** @description Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization. */ - github_owned_allowed?: boolean; + github_owned_allowed?: boolean /** @description Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators. */ - verified_allowed?: boolean; + verified_allowed?: boolean /** @description Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`." */ - patterns_allowed?: string[]; - } & { [key: string]: unknown }; - "runner-groups-enterprise": { - id: number; - name: string; - visibility: string; - default: boolean; - selected_organizations_url?: string; - runners_url: string; - allows_public_repositories: boolean; - } & { [key: string]: unknown }; + patterns_allowed?: string[] + } & { [key: string]: unknown } + 'runner-groups-enterprise': { + id: number + name: string + visibility: string + default: boolean + selected_organizations_url?: string + runners_url: string + allows_public_repositories: boolean + } & { [key: string]: unknown } /** * Self hosted runner label * @description A label for a self hosted runner */ - "runner-label": { + 'runner-label': { /** @description Unique identifier of the label. */ - id?: number; + id?: number /** @description Name of the label. */ - name: string; + name: string /** * @description The type of label. Read-only labels are applied automatically when the runner is configured. * @enum {string} */ - type?: "read-only" | "custom"; - } & { [key: string]: unknown }; + type?: 'read-only' | 'custom' + } & { [key: string]: unknown } /** * Self hosted runners * @description A self hosted runner @@ -7344,1056 +7340,1048 @@ export interface components { * @description The id of the runner. * @example 5 */ - id: number; + id: number /** * @description The name of the runner. * @example iMac */ - name: string; + name: string /** * @description The Operating System of the runner. * @example macos */ - os: string; + os: string /** * @description The status of the runner. * @example online */ - status: string; - busy: boolean; - labels: components["schemas"]["runner-label"][]; - } & { [key: string]: unknown }; + status: string + busy: boolean + labels: components['schemas']['runner-label'][] + } & { [key: string]: unknown } /** * Runner Application * @description Runner Application */ - "runner-application": { - os: string; - architecture: string; - download_url: string; - filename: string; + 'runner-application': { + os: string + architecture: string + download_url: string + filename: string /** @description A short lived bearer token used to download the runner, if needed. */ - temp_download_token?: string; - sha256_checksum?: string; - } & { [key: string]: unknown }; + temp_download_token?: string + sha256_checksum?: string + } & { [key: string]: unknown } /** * Authentication Token * @description Authentication Token */ - "authentication-token": { + 'authentication-token': { /** * @description The token used for authentication * @example v1.1f699f1069f60xxx */ - token: string; + token: string /** * Format: date-time * @description The time this token expires * @example 2016-07-11T22:14:10Z */ - expires_at: string; + expires_at: string /** @example [object Object] */ - permissions?: { [key: string]: unknown }; + permissions?: { [key: string]: unknown } /** @description The repositories this token has access to */ - repositories?: components["schemas"]["repository"][]; + repositories?: components['schemas']['repository'][] /** @example config.yaml */ - single_file?: string | null; + single_file?: string | null /** * @description Describe whether all repositories have been selected or there's a selection involved * @enum {string} */ - repository_selection?: "all" | "selected"; - } & { [key: string]: unknown }; - "audit-log-event": { + repository_selection?: 'all' | 'selected' + } & { [key: string]: unknown } + 'audit-log-event': { /** @description The time the audit log event occurred, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time). */ - "@timestamp"?: number; + '@timestamp'?: number /** @description The name of the action that was performed, for example `user.login` or `repo.create`. */ - action?: string; - active?: boolean; - active_was?: boolean; + action?: string + active?: boolean + active_was?: boolean /** @description The actor who performed the action. */ - actor?: string; + actor?: string /** @description The id of the actor who performed the action. */ - actor_id?: number; + actor_id?: number actor_location?: { - country_name?: string; - } & { [key: string]: unknown }; - data?: { [key: string]: unknown }; - org_id?: number; + country_name?: string + } & { [key: string]: unknown } + data?: { [key: string]: unknown } + org_id?: number /** @description The username of the account being blocked. */ - blocked_user?: string; - business?: string; - config?: { [key: string]: unknown }[]; - config_was?: { [key: string]: unknown }[]; - content_type?: string; + blocked_user?: string + business?: string + config?: { [key: string]: unknown }[] + config_was?: { [key: string]: unknown }[] + content_type?: string /** @description The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time). */ - created_at?: number; - deploy_key_fingerprint?: string; + created_at?: number + deploy_key_fingerprint?: string /** @description A unique identifier for an audit event. */ - _document_id?: string; - emoji?: string; - events?: { [key: string]: unknown }[]; - events_were?: { [key: string]: unknown }[]; - explanation?: string; - fingerprint?: string; - hook_id?: number; - limited_availability?: boolean; - message?: string; - name?: string; - old_user?: string; - openssh_public_key?: string; - org?: string; - previous_visibility?: string; - read_only?: boolean; + _document_id?: string + emoji?: string + events?: { [key: string]: unknown }[] + events_were?: { [key: string]: unknown }[] + explanation?: string + fingerprint?: string + hook_id?: number + limited_availability?: boolean + message?: string + name?: string + old_user?: string + openssh_public_key?: string + org?: string + previous_visibility?: string + read_only?: boolean /** @description The name of the repository. */ - repo?: string; + repo?: string /** @description The name of the repository. */ - repository?: string; - repository_public?: boolean; - target_login?: string; - team?: string; + repository?: string + repository_public?: boolean + target_login?: string + team?: string /** @description The type of protocol (for example, HTTP or SSH) used to transfer Git data. */ - transport_protocol?: number; + transport_protocol?: number /** @description A human readable name for the protocol (for example, HTTP or SSH) used to transfer Git data. */ - transport_protocol_name?: string; + transport_protocol_name?: string /** @description The user that was affected by the action performed (if available). */ - user?: string; + user?: string /** @description The repository visibility, for example `public` or `private`. */ - visibility?: string; - } & { [key: string]: unknown }; + visibility?: string + } & { [key: string]: unknown } /** @description The security alert number. */ - "alert-number": number; + 'alert-number': number /** * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "alert-created-at": string; + 'alert-created-at': string /** * Format: uri * @description The REST API URL of the alert resource. */ - "alert-url": string; + 'alert-url': string /** * Format: uri * @description The GitHub URL of the alert resource. */ - "alert-html-url": string; + 'alert-html-url': string /** * @description Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`. * @enum {string} */ - "secret-scanning-alert-state": "open" | "resolved"; + 'secret-scanning-alert-state': 'open' | 'resolved' /** * @description **Required when the `state` is `resolved`.** The reason for resolving the alert. Can be one of `false_positive`, `wont_fix`, `revoked`, or `used_in_tests`. * @enum {string|null} */ - "secret-scanning-alert-resolution": (null | "false_positive" | "wont_fix" | "revoked" | "used_in_tests") | null; + 'secret-scanning-alert-resolution': (null | 'false_positive' | 'wont_fix' | 'revoked' | 'used_in_tests') | null /** * Repository * @description A git repository */ - "nullable-repository": + 'nullable-repository': | ({ /** * @description Unique identifier of the repository * @example 42 */ - id: number; + id: number /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - node_id: string; + node_id: string /** * @description The name of the repository. * @example Team Environment */ - name: string; + name: string /** @example octocat/Hello-World */ - full_name: string; - license: components["schemas"]["nullable-license-simple"]; - organization?: components["schemas"]["nullable-simple-user"]; - forks: number; + full_name: string + license: components['schemas']['nullable-license-simple'] + organization?: components['schemas']['nullable-simple-user'] + forks: number permissions?: { - admin: boolean; - pull: boolean; - triage?: boolean; - push: boolean; - maintain?: boolean; - } & { [key: string]: unknown }; - owner: components["schemas"]["simple-user"]; + admin: boolean + pull: boolean + triage?: boolean + push: boolean + maintain?: boolean + } & { [key: string]: unknown } + owner: components['schemas']['simple-user'] /** @description Whether the repository is private or public. */ - private: boolean; + private: boolean /** * Format: uri * @example https://github.com/octocat/Hello-World */ - html_url: string; + html_url: string /** @example This your first repo! */ - description: string | null; - fork: boolean; + description: string | null + fork: boolean /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World */ - url: string; + url: string /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - archive_url: string; + archive_url: string /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - assignees_url: string; + assignees_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - blobs_url: string; + blobs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - branches_url: string; + branches_url: string /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - collaborators_url: string; + collaborators_url: string /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - comments_url: string; + comments_url: string /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - commits_url: string; + commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - compare_url: string; + compare_url: string /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - contents_url: string; + contents_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - contributors_url: string; + contributors_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - deployments_url: string; + deployments_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - downloads_url: string; + downloads_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events */ - events_url: string; + events_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ - forks_url: string; + forks_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - git_commits_url: string; + git_commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - git_refs_url: string; + git_refs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - git_tags_url: string; + git_tags_url: string /** @example git:github.com/octocat/Hello-World.git */ - git_url: string; + git_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - issue_comment_url: string; + issue_comment_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - issue_events_url: string; + issue_events_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - issues_url: string; + issues_url: string /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - keys_url: string; + keys_url: string /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - labels_url: string; + labels_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ - languages_url: string; + languages_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ - merges_url: string; + merges_url: string /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - milestones_url: string; + milestones_url: string /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - notifications_url: string; + notifications_url: string /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - pulls_url: string; + pulls_url: string /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - releases_url: string; + releases_url: string /** @example git@github.com:octocat/Hello-World.git */ - ssh_url: string; + ssh_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - stargazers_url: string; + stargazers_url: string /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - statuses_url: string; + statuses_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - subscribers_url: string; + subscribers_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - subscription_url: string; + subscription_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ - tags_url: string; + tags_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ - teams_url: string; + teams_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - trees_url: string; + trees_url: string /** @example https://github.com/octocat/Hello-World.git */ - clone_url: string; + clone_url: string /** * Format: uri * @example git:git.example.com/octocat/Hello-World */ - mirror_url: string | null; + mirror_url: string | null /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - hooks_url: string; + hooks_url: string /** * Format: uri * @example https://svn.github.com/octocat/Hello-World */ - svn_url: string; + svn_url: string /** * Format: uri * @example https://github.com */ - homepage: string | null; - language: string | null; + homepage: string | null + language: string | null /** @example 9 */ - forks_count: number; + forks_count: number /** @example 80 */ - stargazers_count: number; + stargazers_count: number /** @example 80 */ - watchers_count: number; + watchers_count: number /** @example 108 */ - size: number; + size: number /** * @description The default branch of the repository. * @example master */ - default_branch: string; - open_issues_count: number; + default_branch: string + open_issues_count: number /** * @description Whether this repository acts as a template that can be used to generate new repositories. * @example true */ - is_template?: boolean; - topics?: string[]; + is_template?: boolean + topics?: string[] /** * @description Whether issues are enabled. * @default true * @example true */ - has_issues: boolean; + has_issues: boolean /** * @description Whether projects are enabled. * @default true * @example true */ - has_projects: boolean; + has_projects: boolean /** * @description Whether the wiki is enabled. * @default true * @example true */ - has_wiki: boolean; - has_pages: boolean; + has_wiki: boolean + has_pages: boolean /** * @description Whether downloads are enabled. * @default true * @example true */ - has_downloads: boolean; + has_downloads: boolean /** @description Whether the repository is archived. */ - archived: boolean; + archived: boolean /** @description Returns whether or not this repository disabled. */ - disabled: boolean; + disabled: boolean /** * @description The repository visibility: public, private, or internal. * @default public */ - visibility?: string; + visibility?: string /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - pushed_at: string | null; + pushed_at: string | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - created_at: string | null; + created_at: string | null /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - updated_at: string | null; + updated_at: string | null /** * @description Whether to allow rebase merges for pull requests. * @default true * @example true */ - allow_rebase_merge?: boolean; + allow_rebase_merge?: boolean template_repository?: | ({ - id?: number; - node_id?: string; - name?: string; - full_name?: string; + id?: number + node_id?: string + name?: string + full_name?: string owner?: { - login?: string; - id?: number; - node_id?: string; - avatar_url?: string; - gravatar_id?: string; - url?: string; - html_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - starred_url?: string; - subscriptions_url?: string; - organizations_url?: string; - repos_url?: string; - events_url?: string; - received_events_url?: string; - type?: string; - site_admin?: boolean; - } & { [key: string]: unknown }; - private?: boolean; - html_url?: string; - description?: string; - fork?: boolean; - url?: string; - archive_url?: string; - assignees_url?: string; - blobs_url?: string; - branches_url?: string; - collaborators_url?: string; - comments_url?: string; - commits_url?: string; - compare_url?: string; - contents_url?: string; - contributors_url?: string; - deployments_url?: string; - downloads_url?: string; - events_url?: string; - forks_url?: string; - git_commits_url?: string; - git_refs_url?: string; - git_tags_url?: string; - git_url?: string; - issue_comment_url?: string; - issue_events_url?: string; - issues_url?: string; - keys_url?: string; - labels_url?: string; - languages_url?: string; - merges_url?: string; - milestones_url?: string; - notifications_url?: string; - pulls_url?: string; - releases_url?: string; - ssh_url?: string; - stargazers_url?: string; - statuses_url?: string; - subscribers_url?: string; - subscription_url?: string; - tags_url?: string; - teams_url?: string; - trees_url?: string; - clone_url?: string; - mirror_url?: string; - hooks_url?: string; - svn_url?: string; - homepage?: string; - language?: string; - forks_count?: number; - stargazers_count?: number; - watchers_count?: number; - size?: number; - default_branch?: string; - open_issues_count?: number; - is_template?: boolean; - topics?: string[]; - has_issues?: boolean; - has_projects?: boolean; - has_wiki?: boolean; - has_pages?: boolean; - has_downloads?: boolean; - archived?: boolean; - disabled?: boolean; - visibility?: string; - pushed_at?: string; - created_at?: string; - updated_at?: string; + login?: string + id?: number + node_id?: string + avatar_url?: string + gravatar_id?: string + url?: string + html_url?: string + followers_url?: string + following_url?: string + gists_url?: string + starred_url?: string + subscriptions_url?: string + organizations_url?: string + repos_url?: string + events_url?: string + received_events_url?: string + type?: string + site_admin?: boolean + } & { [key: string]: unknown } + private?: boolean + html_url?: string + description?: string + fork?: boolean + url?: string + archive_url?: string + assignees_url?: string + blobs_url?: string + branches_url?: string + collaborators_url?: string + comments_url?: string + commits_url?: string + compare_url?: string + contents_url?: string + contributors_url?: string + deployments_url?: string + downloads_url?: string + events_url?: string + forks_url?: string + git_commits_url?: string + git_refs_url?: string + git_tags_url?: string + git_url?: string + issue_comment_url?: string + issue_events_url?: string + issues_url?: string + keys_url?: string + labels_url?: string + languages_url?: string + merges_url?: string + milestones_url?: string + notifications_url?: string + pulls_url?: string + releases_url?: string + ssh_url?: string + stargazers_url?: string + statuses_url?: string + subscribers_url?: string + subscription_url?: string + tags_url?: string + teams_url?: string + trees_url?: string + clone_url?: string + mirror_url?: string + hooks_url?: string + svn_url?: string + homepage?: string + language?: string + forks_count?: number + stargazers_count?: number + watchers_count?: number + size?: number + default_branch?: string + open_issues_count?: number + is_template?: boolean + topics?: string[] + has_issues?: boolean + has_projects?: boolean + has_wiki?: boolean + has_pages?: boolean + has_downloads?: boolean + archived?: boolean + disabled?: boolean + visibility?: string + pushed_at?: string + created_at?: string + updated_at?: string permissions?: { - admin?: boolean; - maintain?: boolean; - push?: boolean; - triage?: boolean; - pull?: boolean; - } & { [key: string]: unknown }; - allow_rebase_merge?: boolean; - temp_clone_token?: string; - allow_squash_merge?: boolean; - allow_auto_merge?: boolean; - delete_branch_on_merge?: boolean; - allow_update_branch?: boolean; - allow_merge_commit?: boolean; - subscribers_count?: number; - network_count?: number; + admin?: boolean + maintain?: boolean + push?: boolean + triage?: boolean + pull?: boolean + } & { [key: string]: unknown } + allow_rebase_merge?: boolean + temp_clone_token?: string + allow_squash_merge?: boolean + allow_auto_merge?: boolean + delete_branch_on_merge?: boolean + allow_update_branch?: boolean + allow_merge_commit?: boolean + subscribers_count?: number + network_count?: number } & { [key: string]: unknown }) - | null; - temp_clone_token?: string; + | null + temp_clone_token?: string /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - allow_squash_merge?: boolean; + allow_squash_merge?: boolean /** @description Whether to allow Auto-merge to be used on pull requests. */ - allow_auto_merge?: boolean; + allow_auto_merge?: boolean /** @description Whether to delete head branches when pull requests are merged */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge?: boolean /** * @description Whether to allow merge commits for pull requests. * @default true * @example true */ - allow_merge_commit?: boolean; + allow_merge_commit?: boolean /** @description Whether to allow forking this repo */ - allow_forking?: boolean; - subscribers_count?: number; - network_count?: number; - open_issues: number; - watchers: number; - master_branch?: string; + allow_forking?: boolean + subscribers_count?: number + network_count?: number + open_issues: number + watchers: number + master_branch?: string /** @example "2020-07-09T00:17:42Z" */ - starred_at?: string; + starred_at?: string } & { [key: string]: unknown }) - | null; + | null /** * Minimal Repository * @description Minimal Repository */ - "minimal-repository": { + 'minimal-repository': { /** @example 1296269 */ - id: number; + id: number /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - node_id: string; + node_id: string /** @example Hello-World */ - name: string; + name: string /** @example octocat/Hello-World */ - full_name: string; - owner: components["schemas"]["simple-user"]; - private: boolean; + full_name: string + owner: components['schemas']['simple-user'] + private: boolean /** * Format: uri * @example https://github.com/octocat/Hello-World */ - html_url: string; + html_url: string /** @example This your first repo! */ - description: string | null; - fork: boolean; + description: string | null + fork: boolean /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World */ - url: string; + url: string /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - archive_url: string; + archive_url: string /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - assignees_url: string; + assignees_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - blobs_url: string; + blobs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - branches_url: string; + branches_url: string /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - collaborators_url: string; + collaborators_url: string /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - comments_url: string; + comments_url: string /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - commits_url: string; + commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - compare_url: string; + compare_url: string /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - contents_url: string; + contents_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - contributors_url: string; + contributors_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - deployments_url: string; + deployments_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - downloads_url: string; + downloads_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events */ - events_url: string; + events_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ - forks_url: string; + forks_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - git_commits_url: string; + git_commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - git_refs_url: string; + git_refs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - git_tags_url: string; - git_url?: string; + git_tags_url: string + git_url?: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - issue_comment_url: string; + issue_comment_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - issue_events_url: string; + issue_events_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - issues_url: string; + issues_url: string /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - keys_url: string; + keys_url: string /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - labels_url: string; + labels_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ - languages_url: string; + languages_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ - merges_url: string; + merges_url: string /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - milestones_url: string; + milestones_url: string /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - notifications_url: string; + notifications_url: string /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - pulls_url: string; + pulls_url: string /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - releases_url: string; - ssh_url?: string; + releases_url: string + ssh_url?: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - stargazers_url: string; + stargazers_url: string /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - statuses_url: string; + statuses_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - subscribers_url: string; + subscribers_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - subscription_url: string; + subscription_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ - tags_url: string; + tags_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ - teams_url: string; + teams_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - trees_url: string; - clone_url?: string; - mirror_url?: string | null; + trees_url: string + clone_url?: string + mirror_url?: string | null /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - hooks_url: string; - svn_url?: string; - homepage?: string | null; - language?: string | null; - forks_count?: number; - stargazers_count?: number; - watchers_count?: number; - size?: number; - default_branch?: string; - open_issues_count?: number; - is_template?: boolean; - topics?: string[]; - has_issues?: boolean; - has_projects?: boolean; - has_wiki?: boolean; - has_pages?: boolean; - has_downloads?: boolean; - archived?: boolean; - disabled?: boolean; - visibility?: string; + hooks_url: string + svn_url?: string + homepage?: string | null + language?: string | null + forks_count?: number + stargazers_count?: number + watchers_count?: number + size?: number + default_branch?: string + open_issues_count?: number + is_template?: boolean + topics?: string[] + has_issues?: boolean + has_projects?: boolean + has_wiki?: boolean + has_pages?: boolean + has_downloads?: boolean + archived?: boolean + disabled?: boolean + visibility?: string /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - pushed_at?: string | null; + pushed_at?: string | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - created_at?: string | null; + created_at?: string | null /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - updated_at?: string | null; + updated_at?: string | null permissions?: { - admin?: boolean; - maintain?: boolean; - push?: boolean; - triage?: boolean; - pull?: boolean; - } & { [key: string]: unknown }; + admin?: boolean + maintain?: boolean + push?: boolean + triage?: boolean + pull?: boolean + } & { [key: string]: unknown } /** @example admin */ - role_name?: string; - template_repository?: components["schemas"]["nullable-repository"]; - temp_clone_token?: string; - delete_branch_on_merge?: boolean; - subscribers_count?: number; - network_count?: number; - code_of_conduct?: components["schemas"]["code-of-conduct"]; + role_name?: string + template_repository?: components['schemas']['nullable-repository'] + temp_clone_token?: string + delete_branch_on_merge?: boolean + subscribers_count?: number + network_count?: number + code_of_conduct?: components['schemas']['code-of-conduct'] license?: | ({ - key?: string; - name?: string; - spdx_id?: string; - url?: string; - node_id?: string; + key?: string + name?: string + spdx_id?: string + url?: string + node_id?: string } & { [key: string]: unknown }) - | null; - forks?: number; - open_issues?: number; - watchers?: number; - allow_forking?: boolean; - } & { [key: string]: unknown }; - "organization-secret-scanning-alert": { - number?: components["schemas"]["alert-number"]; - created_at?: components["schemas"]["alert-created-at"]; - url?: components["schemas"]["alert-url"]; - html_url?: components["schemas"]["alert-html-url"]; + | null + forks?: number + open_issues?: number + watchers?: number + allow_forking?: boolean + } & { [key: string]: unknown } + 'organization-secret-scanning-alert': { + number?: components['schemas']['alert-number'] + created_at?: components['schemas']['alert-created-at'] + url?: components['schemas']['alert-url'] + html_url?: components['schemas']['alert-html-url'] /** * Format: uri * @description The REST API URL of the code locations for this alert. */ - locations_url?: string; - state?: components["schemas"]["secret-scanning-alert-state"]; - resolution?: components["schemas"]["secret-scanning-alert-resolution"]; + locations_url?: string + state?: components['schemas']['secret-scanning-alert-state'] + resolution?: components['schemas']['secret-scanning-alert-resolution'] /** * Format: date-time * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - resolved_at?: string | null; - resolved_by?: components["schemas"]["nullable-simple-user"]; + resolved_at?: string | null + resolved_by?: components['schemas']['nullable-simple-user'] /** @description The type of secret that secret scanning detected. */ - secret_type?: string; + secret_type?: string /** @description The secret that was detected. */ - secret?: string; - repository?: components["schemas"]["minimal-repository"]; - } & { [key: string]: unknown }; - "actions-billing-usage": { + secret?: string + repository?: components['schemas']['minimal-repository'] + } & { [key: string]: unknown } + 'actions-billing-usage': { /** @description The sum of the free and paid GitHub Actions minutes used. */ - total_minutes_used: number; + total_minutes_used: number /** @description The total paid GitHub Actions minutes used. */ - total_paid_minutes_used: number; + total_paid_minutes_used: number /** @description The amount of free GitHub Actions minutes available. */ - included_minutes: number; + included_minutes: number minutes_used_breakdown: { /** @description Total minutes used on Ubuntu runner machines. */ - UBUNTU?: number; + UBUNTU?: number /** @description Total minutes used on macOS runner machines. */ - MACOS?: number; + MACOS?: number /** @description Total minutes used on Windows runner machines. */ - WINDOWS?: number; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; - "advanced-security-active-committers-user": { - user_login: string; + WINDOWS?: number + } & { [key: string]: unknown } + } & { [key: string]: unknown } + 'advanced-security-active-committers-user': { + user_login: string /** @example 2021-11-03 */ - last_pushed_date: string; - } & { [key: string]: unknown }; - "advanced-security-active-committers-repository": { + last_pushed_date: string + } & { [key: string]: unknown } + 'advanced-security-active-committers-repository': { /** @example octocat/Hello-World */ - name: string; + name: string /** @example 25 */ - advanced_security_committers: number; - advanced_security_committers_breakdown: components["schemas"]["advanced-security-active-committers-user"][]; - } & { [key: string]: unknown }; - "advanced-security-active-committers": { + advanced_security_committers: number + advanced_security_committers_breakdown: components['schemas']['advanced-security-active-committers-user'][] + } & { [key: string]: unknown } + 'advanced-security-active-committers': { /** @example 25 */ - total_advanced_security_committers?: number; - repositories: components["schemas"]["advanced-security-active-committers-repository"][]; - } & { [key: string]: unknown }; - "packages-billing-usage": { + total_advanced_security_committers?: number + repositories: components['schemas']['advanced-security-active-committers-repository'][] + } & { [key: string]: unknown } + 'packages-billing-usage': { /** @description Sum of the free and paid storage space (GB) for GitHuub Packages. */ - total_gigabytes_bandwidth_used: number; + total_gigabytes_bandwidth_used: number /** @description Total paid storage space (GB) for GitHuub Packages. */ - total_paid_gigabytes_bandwidth_used: number; + total_paid_gigabytes_bandwidth_used: number /** @description Free storage space (GB) for GitHub Packages. */ - included_gigabytes_bandwidth: number; - } & { [key: string]: unknown }; - "combined-billing-usage": { + included_gigabytes_bandwidth: number + } & { [key: string]: unknown } + 'combined-billing-usage': { /** @description Numbers of days left in billing cycle. */ - days_left_in_billing_cycle: number; + days_left_in_billing_cycle: number /** @description Estimated storage space (GB) used in billing cycle. */ - estimated_paid_storage_for_month: number; + estimated_paid_storage_for_month: number /** @description Estimated sum of free and paid storage space (GB) used in billing cycle. */ - estimated_storage_for_month: number; - } & { [key: string]: unknown }; + estimated_storage_for_month: number + } & { [key: string]: unknown } /** * Actor * @description Actor */ actor: { - id: number; - login: string; - display_login?: string; - gravatar_id: string | null; + id: number + login: string + display_login?: string + gravatar_id: string | null /** Format: uri */ - url: string; + url: string /** Format: uri */ - avatar_url: string; - } & { [key: string]: unknown }; + avatar_url: string + } & { [key: string]: unknown } /** * Milestone * @description A collection of related issues and pull requests. */ - "nullable-milestone": + 'nullable-milestone': | ({ /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1 */ - url: string; + url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/milestones/v1.0 */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1/labels */ - labels_url: string; + labels_url: string /** @example 1002604 */ - id: number; + id: number /** @example MDk6TWlsZXN0b25lMTAwMjYwNA== */ - node_id: string; + node_id: string /** * @description The number of the milestone. * @example 42 */ - number: number; + number: number /** * @description The state of the milestone. * @default open * @example open * @enum {string} */ - state: "open" | "closed"; + state: 'open' | 'closed' /** * @description The title of the milestone. * @example v1.0 */ - title: string; + title: string /** @example Tracking milestone for version 1.0 */ - description: string | null; - creator: components["schemas"]["nullable-simple-user"]; + description: string | null + creator: components['schemas']['nullable-simple-user'] /** @example 4 */ - open_issues: number; + open_issues: number /** @example 8 */ - closed_issues: number; + closed_issues: number /** * Format: date-time * @example 2011-04-10T20:09:31Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2014-03-03T18:58:10Z */ - updated_at: string; + updated_at: string /** * Format: date-time * @example 2013-02-12T13:22:01Z */ - closed_at: string | null; + closed_at: string | null /** * Format: date-time * @example 2012-10-09T23:39:01Z */ - due_on: string | null; + due_on: string | null } & { [key: string]: unknown }) - | null; + | null /** * GitHub app * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - "nullable-integration": + 'nullable-integration': | ({ /** * @description Unique identifier of the GitHub app * @example 37 */ - id: number; + id: number /** * @description The slug name of the GitHub app * @example probot-owners */ - slug?: string; + slug?: string /** @example MDExOkludGVncmF0aW9uMQ== */ - node_id: string; - owner: components["schemas"]["nullable-simple-user"]; + node_id: string + owner: components['schemas']['nullable-simple-user'] /** * @description The name of the GitHub app * @example Probot Owners */ - name: string; + name: string /** @example The description of the app. */ - description: string | null; + description: string | null /** * Format: uri * @example https://example.com */ - external_url: string; + external_url: string /** * Format: uri * @example https://github.com/apps/super-ci */ - html_url: string; + html_url: string /** * Format: date-time * @example 2017-07-08T16:18:44-04:00 */ - created_at: string; + created_at: string /** * Format: date-time * @example 2017-07-08T16:18:44-04:00 */ - updated_at: string; + updated_at: string /** * @description The set of permissions for the GitHub app * @example [object Object] */ permissions: { - issues?: string; - checks?: string; - metadata?: string; - contents?: string; - deployments?: string; - } & { [key: string]: string }; + issues?: string + checks?: string + metadata?: string + contents?: string + deployments?: string + } & { [key: string]: string } /** * @description The list of events for the GitHub app * @example label,deployment */ - events: string[]; + events: string[] /** * @description The number of installations associated with the GitHub app * @example 5 */ - installations_count?: number; + installations_count?: number /** @example "Iv1.25b5d1e65ffc4022" */ - client_id?: string; + client_id?: string /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ - client_secret?: string; + client_secret?: string /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ - webhook_secret?: string | null; + webhook_secret?: string | null /** @example "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n" */ - pem?: string; + pem?: string } & { [key: string]: unknown }) - | null; + | null /** * author_association * @description How the author is associated with the repository. * @example OWNER * @enum {string} */ - author_association: - | "COLLABORATOR" - | "CONTRIBUTOR" - | "FIRST_TIMER" - | "FIRST_TIME_CONTRIBUTOR" - | "MANNEQUIN" - | "MEMBER" - | "NONE" - | "OWNER"; + author_association: 'COLLABORATOR' | 'CONTRIBUTOR' | 'FIRST_TIMER' | 'FIRST_TIME_CONTRIBUTOR' | 'MANNEQUIN' | 'MEMBER' | 'NONE' | 'OWNER' /** Reaction Rollup */ - "reaction-rollup": { + 'reaction-rollup': { /** Format: uri */ - url: string; - total_count: number; - "+1": number; - "-1": number; - laugh: number; - confused: number; - heart: number; - hooray: number; - eyes: number; - rocket: number; - } & { [key: string]: unknown }; + url: string + total_count: number + '+1': number + '-1': number + laugh: number + confused: number + heart: number + hooray: number + eyes: number + rocket: number + } & { [key: string]: unknown } /** * Issue * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. */ issue: { - id: number; - node_id: string; + id: number + node_id: string /** * Format: uri * @description URL for the issue * @example https://api.github.com/repositories/42/issues/1 */ - url: string; + url: string /** Format: uri */ - repository_url: string; - labels_url: string; + repository_url: string + labels_url: string /** Format: uri */ - comments_url: string; + comments_url: string /** Format: uri */ - events_url: string; + events_url: string /** Format: uri */ - html_url: string; + html_url: string /** * @description Number uniquely identifying the issue within its repository * @example 42 */ - number: number; + number: number /** * @description State of the issue; either 'open' or 'closed' * @example open */ - state: string; + state: string /** * @description Title of the issue * @example Widget creation fails in Safari on OS X 10.8 */ - title: string; + title: string /** * @description Contents of the issue * @example It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug? */ - body?: string | null; - user: components["schemas"]["nullable-simple-user"]; + body?: string | null + user: components['schemas']['nullable-simple-user'] /** * @description Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository * @example bug,registration @@ -8402,313 +8390,313 @@ export interface components { | string | ({ /** Format: int64 */ - id?: number; - node_id?: string; + id?: number + node_id?: string /** Format: uri */ - url?: string; - name?: string; - description?: string | null; - color?: string | null; - default?: boolean; + url?: string + name?: string + description?: string | null + color?: string | null + default?: boolean } & { [key: string]: unknown }) - ) & { [key: string]: unknown })[]; - assignee: components["schemas"]["nullable-simple-user"]; - assignees?: components["schemas"]["simple-user"][] | null; - milestone: components["schemas"]["nullable-milestone"]; - locked: boolean; - active_lock_reason?: string | null; - comments: number; + ) & { [key: string]: unknown })[] + assignee: components['schemas']['nullable-simple-user'] + assignees?: components['schemas']['simple-user'][] | null + milestone: components['schemas']['nullable-milestone'] + locked: boolean + active_lock_reason?: string | null + comments: number pull_request?: { /** Format: date-time */ - merged_at?: string | null; + merged_at?: string | null /** Format: uri */ - diff_url: string | null; + diff_url: string | null /** Format: uri */ - html_url: string | null; + html_url: string | null /** Format: uri */ - patch_url: string | null; + patch_url: string | null /** Format: uri */ - url: string | null; - } & { [key: string]: unknown }; + url: string | null + } & { [key: string]: unknown } /** Format: date-time */ - closed_at: string | null; + closed_at: string | null /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - draft?: boolean; - closed_by?: components["schemas"]["nullable-simple-user"]; - body_html?: string; - body_text?: string; + updated_at: string + draft?: boolean + closed_by?: components['schemas']['nullable-simple-user'] + body_html?: string + body_text?: string /** Format: uri */ - timeline_url?: string; - repository?: components["schemas"]["repository"]; - performed_via_github_app?: components["schemas"]["nullable-integration"]; - author_association: components["schemas"]["author_association"]; - reactions?: components["schemas"]["reaction-rollup"]; - } & { [key: string]: unknown }; + timeline_url?: string + repository?: components['schemas']['repository'] + performed_via_github_app?: components['schemas']['nullable-integration'] + author_association: components['schemas']['author_association'] + reactions?: components['schemas']['reaction-rollup'] + } & { [key: string]: unknown } /** * Issue Comment * @description Comments provide a way for people to collaborate on an issue. */ - "issue-comment": { + 'issue-comment': { /** * @description Unique identifier of the issue comment * @example 42 */ - id: number; - node_id: string; + id: number + node_id: string /** * Format: uri * @description URL for the issue comment * @example https://api.github.com/repositories/42/issues/comments/1 */ - url: string; + url: string /** * @description Contents of the issue comment * @example What version of Safari were you using when you observed this bug? */ - body?: string; - body_text?: string; - body_html?: string; + body?: string + body_text?: string + body_html?: string /** Format: uri */ - html_url: string; - user: components["schemas"]["nullable-simple-user"]; + html_url: string + user: components['schemas']['nullable-simple-user'] /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - updated_at: string; + updated_at: string /** Format: uri */ - issue_url: string; - author_association: components["schemas"]["author_association"]; - performed_via_github_app?: components["schemas"]["nullable-integration"]; - reactions?: components["schemas"]["reaction-rollup"]; - } & { [key: string]: unknown }; + issue_url: string + author_association: components['schemas']['author_association'] + performed_via_github_app?: components['schemas']['nullable-integration'] + reactions?: components['schemas']['reaction-rollup'] + } & { [key: string]: unknown } /** * Event * @description Event */ event: { - id: string; - type: string | null; - actor: components["schemas"]["actor"]; + id: string + type: string | null + actor: components['schemas']['actor'] repo: { - id: number; - name: string; + id: number + name: string /** Format: uri */ - url: string; - } & { [key: string]: unknown }; - org?: components["schemas"]["actor"]; + url: string + } & { [key: string]: unknown } + org?: components['schemas']['actor'] payload: { - action?: string; - issue?: components["schemas"]["issue"]; - comment?: components["schemas"]["issue-comment"]; + action?: string + issue?: components['schemas']['issue'] + comment?: components['schemas']['issue-comment'] pages?: ({ - page_name?: string; - title?: string; - summary?: string | null; - action?: string; - sha?: string; - html_url?: string; - } & { [key: string]: unknown })[]; - } & { [key: string]: unknown }; - public: boolean; + page_name?: string + title?: string + summary?: string | null + action?: string + sha?: string + html_url?: string + } & { [key: string]: unknown })[] + } & { [key: string]: unknown } + public: boolean /** Format: date-time */ - created_at: string | null; - } & { [key: string]: unknown }; + created_at: string | null + } & { [key: string]: unknown } /** * Link With Type * @description Hypermedia Link with Type */ - "link-with-type": { - href: string; - type: string; - } & { [key: string]: unknown }; + 'link-with-type': { + href: string + type: string + } & { [key: string]: unknown } /** * Feed * @description Feed */ feed: { /** @example https://github.com/timeline */ - timeline_url: string; + timeline_url: string /** @example https://github.com/{user} */ - user_url: string; + user_url: string /** @example https://github.com/octocat */ - current_user_public_url?: string; + current_user_public_url?: string /** @example https://github.com/octocat.private?token=abc123 */ - current_user_url?: string; + current_user_url?: string /** @example https://github.com/octocat.private.actor?token=abc123 */ - current_user_actor_url?: string; + current_user_actor_url?: string /** @example https://github.com/octocat-org */ - current_user_organization_url?: string; + current_user_organization_url?: string /** @example https://github.com/organizations/github/octocat.private.atom?token=abc123 */ - current_user_organization_urls?: string[]; + current_user_organization_urls?: string[] /** @example https://github.com/security-advisories */ - security_advisories_url?: string; + security_advisories_url?: string _links: { - timeline: components["schemas"]["link-with-type"]; - user: components["schemas"]["link-with-type"]; - security_advisories?: components["schemas"]["link-with-type"]; - current_user?: components["schemas"]["link-with-type"]; - current_user_public?: components["schemas"]["link-with-type"]; - current_user_actor?: components["schemas"]["link-with-type"]; - current_user_organization?: components["schemas"]["link-with-type"]; - current_user_organizations?: components["schemas"]["link-with-type"][]; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + timeline: components['schemas']['link-with-type'] + user: components['schemas']['link-with-type'] + security_advisories?: components['schemas']['link-with-type'] + current_user?: components['schemas']['link-with-type'] + current_user_public?: components['schemas']['link-with-type'] + current_user_actor?: components['schemas']['link-with-type'] + current_user_organization?: components['schemas']['link-with-type'] + current_user_organizations?: components['schemas']['link-with-type'][] + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** * Base Gist * @description Base Gist */ - "base-gist": { + 'base-gist': { /** Format: uri */ - url: string; + url: string /** Format: uri */ - forks_url: string; + forks_url: string /** Format: uri */ - commits_url: string; - id: string; - node_id: string; + commits_url: string + id: string + node_id: string /** Format: uri */ - git_pull_url: string; + git_pull_url: string /** Format: uri */ - git_push_url: string; + git_push_url: string /** Format: uri */ - html_url: string; + html_url: string files: { [key: string]: { - filename?: string; - type?: string; - language?: string; - raw_url?: string; - size?: number; - } & { [key: string]: unknown }; - }; - public: boolean; + filename?: string + type?: string + language?: string + raw_url?: string + size?: number + } & { [key: string]: unknown } + } + public: boolean /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - description: string | null; - comments: number; - user: components["schemas"]["nullable-simple-user"]; + updated_at: string + description: string | null + comments: number + user: components['schemas']['nullable-simple-user'] /** Format: uri */ - comments_url: string; - owner?: components["schemas"]["simple-user"]; - truncated?: boolean; - forks?: unknown[]; - history?: unknown[]; - } & { [key: string]: unknown }; + comments_url: string + owner?: components['schemas']['simple-user'] + truncated?: boolean + forks?: unknown[] + history?: unknown[] + } & { [key: string]: unknown } /** * Public User * @description Public User */ - "public-user": { - login: string; - id: number; - node_id: string; + 'public-user': { + login: string + id: number + node_id: string /** Format: uri */ - avatar_url: string; - gravatar_id: string | null; + avatar_url: string + gravatar_id: string | null /** Format: uri */ - url: string; + url: string /** Format: uri */ - html_url: string; + html_url: string /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - starred_url: string; + followers_url: string + following_url: string + gists_url: string + starred_url: string /** Format: uri */ - subscriptions_url: string; + subscriptions_url: string /** Format: uri */ - organizations_url: string; + organizations_url: string /** Format: uri */ - repos_url: string; - events_url: string; + repos_url: string + events_url: string /** Format: uri */ - received_events_url: string; - type: string; - site_admin: boolean; - name: string | null; - company: string | null; - blog: string | null; - location: string | null; + received_events_url: string + type: string + site_admin: boolean + name: string | null + company: string | null + blog: string | null + location: string | null /** Format: email */ - email: string | null; - hireable: boolean | null; - bio: string | null; - twitter_username?: string | null; - public_repos: number; - public_gists: number; - followers: number; - following: number; + email: string | null + hireable: boolean | null + bio: string | null + twitter_username?: string | null + public_repos: number + public_gists: number + followers: number + following: number /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; + updated_at: string plan?: { - collaborators: number; - name: string; - space: number; - private_repos: number; - } & { [key: string]: unknown }; + collaborators: number + name: string + space: number + private_repos: number + } & { [key: string]: unknown } /** Format: date-time */ - suspended_at?: string | null; + suspended_at?: string | null /** @example 1 */ - private_gists?: number; + private_gists?: number /** @example 2 */ - total_private_repos?: number; + total_private_repos?: number /** @example 2 */ - owned_private_repos?: number; + owned_private_repos?: number /** @example 1 */ - disk_usage?: number; + disk_usage?: number /** @example 3 */ - collaborators?: number; - }; + collaborators?: number + } /** * Gist History * @description Gist History */ - "gist-history": { - user?: components["schemas"]["nullable-simple-user"]; - version?: string; + 'gist-history': { + user?: components['schemas']['nullable-simple-user'] + version?: string /** Format: date-time */ - committed_at?: string; + committed_at?: string change_status?: { - total?: number; - additions?: number; - deletions?: number; - } & { [key: string]: unknown }; + total?: number + additions?: number + deletions?: number + } & { [key: string]: unknown } /** Format: uri */ - url?: string; - } & { [key: string]: unknown }; + url?: string + } & { [key: string]: unknown } /** * Gist Simple * @description Gist Simple */ - "gist-simple": { + 'gist-simple': { /** @deprecated */ forks?: | ({ - id?: string; + id?: string /** Format: uri */ - url?: string; - user?: components["schemas"]["public-user"]; + url?: string + user?: components['schemas']['public-user'] /** Format: date-time */ - created_at?: string; + created_at?: string /** Format: date-time */ - updated_at?: string; + updated_at?: string } & { [key: string]: unknown })[] - | null; + | null /** @deprecated */ - history?: components["schemas"]["gist-history"][] | null; + history?: components['schemas']['gist-history'][] | null /** * Gist * @description Gist @@ -8716,138 +8704,138 @@ export interface components { fork_of?: | ({ /** Format: uri */ - url: string; + url: string /** Format: uri */ - forks_url: string; + forks_url: string /** Format: uri */ - commits_url: string; - id: string; - node_id: string; + commits_url: string + id: string + node_id: string /** Format: uri */ - git_pull_url: string; + git_pull_url: string /** Format: uri */ - git_push_url: string; + git_push_url: string /** Format: uri */ - html_url: string; + html_url: string files: { [key: string]: { - filename?: string; - type?: string; - language?: string; - raw_url?: string; - size?: number; - } & { [key: string]: unknown }; - }; - public: boolean; + filename?: string + type?: string + language?: string + raw_url?: string + size?: number + } & { [key: string]: unknown } + } + public: boolean /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - description: string | null; - comments: number; - user: components["schemas"]["nullable-simple-user"]; + updated_at: string + description: string | null + comments: number + user: components['schemas']['nullable-simple-user'] /** Format: uri */ - comments_url: string; - owner?: components["schemas"]["nullable-simple-user"]; - truncated?: boolean; - forks?: unknown[]; - history?: unknown[]; + comments_url: string + owner?: components['schemas']['nullable-simple-user'] + truncated?: boolean + forks?: unknown[] + history?: unknown[] } & { [key: string]: unknown }) - | null; - url?: string; - forks_url?: string; - commits_url?: string; - id?: string; - node_id?: string; - git_pull_url?: string; - git_push_url?: string; - html_url?: string; + | null + url?: string + forks_url?: string + commits_url?: string + id?: string + node_id?: string + git_pull_url?: string + git_push_url?: string + html_url?: string files?: { [key: string]: | ({ - filename?: string; - type?: string; - language?: string; - raw_url?: string; - size?: number; - truncated?: boolean; - content?: string; + filename?: string + type?: string + language?: string + raw_url?: string + size?: number + truncated?: boolean + content?: string } & { [key: string]: unknown }) - | null; - }; - public?: boolean; - created_at?: string; - updated_at?: string; - description?: string | null; - comments?: number; - user?: string | null; - comments_url?: string; - owner?: components["schemas"]["simple-user"]; - truncated?: boolean; - } & { [key: string]: unknown }; + | null + } + public?: boolean + created_at?: string + updated_at?: string + description?: string | null + comments?: number + user?: string | null + comments_url?: string + owner?: components['schemas']['simple-user'] + truncated?: boolean + } & { [key: string]: unknown } /** * Gist Comment * @description A comment made to a gist. */ - "gist-comment": { + 'gist-comment': { /** @example 1 */ - id: number; + id: number /** @example MDExOkdpc3RDb21tZW50MQ== */ - node_id: string; + node_id: string /** * Format: uri * @example https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 */ - url: string; + url: string /** * @description The comment text. * @example Body of the attachment */ - body: string; - user: components["schemas"]["nullable-simple-user"]; + body: string + user: components['schemas']['nullable-simple-user'] /** * Format: date-time * @example 2011-04-18T23:23:56Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2011-04-18T23:23:56Z */ - updated_at: string; - author_association: components["schemas"]["author_association"]; - } & { [key: string]: unknown }; + updated_at: string + author_association: components['schemas']['author_association'] + } & { [key: string]: unknown } /** * Gist Commit * @description Gist Commit */ - "gist-commit": { + 'gist-commit': { /** * Format: uri * @example https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f */ - url: string; + url: string /** @example 57a7f021a713b1c5a6a199b54cc514735d2d462f */ - version: string; - user: components["schemas"]["nullable-simple-user"]; + version: string + user: components['schemas']['nullable-simple-user'] change_status: { - total?: number; - additions?: number; - deletions?: number; - } & { [key: string]: unknown }; + total?: number + additions?: number + deletions?: number + } & { [key: string]: unknown } /** * Format: date-time * @example 2010-04-14T02:15:15Z */ - committed_at: string; - } & { [key: string]: unknown }; + committed_at: string + } & { [key: string]: unknown } /** * Gitignore Template * @description Gitignore Template */ - "gitignore-template": { + 'gitignore-template': { /** @example C */ - name: string; + name: string /** * @example # Object files * *.o @@ -8867,62 +8855,62 @@ export interface components { * *.out * *.app */ - source: string; - } & { [key: string]: unknown }; + source: string + } & { [key: string]: unknown } /** * License Simple * @description License Simple */ - "license-simple": { + 'license-simple': { /** @example mit */ - key: string; + key: string /** @example MIT License */ - name: string; + name: string /** * Format: uri * @example https://api.github.com/licenses/mit */ - url: string | null; + url: string | null /** @example MIT */ - spdx_id: string | null; + spdx_id: string | null /** @example MDc6TGljZW5zZW1pdA== */ - node_id: string; + node_id: string /** Format: uri */ - html_url?: string; - } & { [key: string]: unknown }; + html_url?: string + } & { [key: string]: unknown } /** * License * @description License */ license: { /** @example mit */ - key: string; + key: string /** @example MIT License */ - name: string; + name: string /** @example MIT */ - spdx_id: string | null; + spdx_id: string | null /** * Format: uri * @example https://api.github.com/licenses/mit */ - url: string | null; + url: string | null /** @example MDc6TGljZW5zZW1pdA== */ - node_id: string; + node_id: string /** * Format: uri * @example http://choosealicense.com/licenses/mit/ */ - html_url: string; + html_url: string /** @example A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty. */ - description: string; + description: string /** @example Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders. */ - implementation: string; + implementation: string /** @example commercial-use,modifications,distribution,sublicense,private-use */ - permissions: string[]; + permissions: string[] /** @example include-copyright */ - conditions: string[]; + conditions: string[] /** @example no-liability */ - limitations: string[]; + limitations: string[] /** * @example * @@ -8948,176 +8936,176 @@ export interface components { * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ - body: string; + body: string /** @example true */ - featured: boolean; - } & { [key: string]: unknown }; + featured: boolean + } & { [key: string]: unknown } /** * Marketplace Listing Plan * @description Marketplace Listing Plan */ - "marketplace-listing-plan": { + 'marketplace-listing-plan': { /** * Format: uri * @example https://api.github.com/marketplace_listing/plans/1313 */ - url: string; + url: string /** * Format: uri * @example https://api.github.com/marketplace_listing/plans/1313/accounts */ - accounts_url: string; + accounts_url: string /** @example 1313 */ - id: number; + id: number /** @example 3 */ - number: number; + number: number /** @example Pro */ - name: string; + name: string /** @example A professional-grade CI solution */ - description: string; + description: string /** @example 1099 */ - monthly_price_in_cents: number; + monthly_price_in_cents: number /** @example 11870 */ - yearly_price_in_cents: number; + yearly_price_in_cents: number /** @example flat-rate */ - price_model: string; + price_model: string /** @example true */ - has_free_trial: boolean; - unit_name: string | null; + has_free_trial: boolean + unit_name: string | null /** @example published */ - state: string; + state: string /** @example Up to 25 private repositories,11 concurrent builds */ - bullets: string[]; - } & { [key: string]: unknown }; + bullets: string[] + } & { [key: string]: unknown } /** * Marketplace Purchase * @description Marketplace Purchase */ - "marketplace-purchase": { - url: string; - type: string; - id: number; - login: string; - organization_billing_email?: string; - email?: string | null; + 'marketplace-purchase': { + url: string + type: string + id: number + login: string + organization_billing_email?: string + email?: string | null marketplace_pending_change?: | ({ - is_installed?: boolean; - effective_date?: string; - unit_count?: number | null; - id?: number; - plan?: components["schemas"]["marketplace-listing-plan"]; + is_installed?: boolean + effective_date?: string + unit_count?: number | null + id?: number + plan?: components['schemas']['marketplace-listing-plan'] } & { [key: string]: unknown }) - | null; + | null marketplace_purchase: { - billing_cycle?: string; - next_billing_date?: string | null; - is_installed?: boolean; - unit_count?: number | null; - on_free_trial?: boolean; - free_trial_ends_on?: string | null; - updated_at?: string; - plan?: components["schemas"]["marketplace-listing-plan"]; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + billing_cycle?: string + next_billing_date?: string | null + is_installed?: boolean + unit_count?: number | null + on_free_trial?: boolean + free_trial_ends_on?: string | null + updated_at?: string + plan?: components['schemas']['marketplace-listing-plan'] + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** * Api Overview * @description Api Overview */ - "api-overview": { + 'api-overview': { /** @example true */ - verifiable_password_authentication: boolean; + verifiable_password_authentication: boolean ssh_key_fingerprints?: { - SHA256_RSA?: string; - SHA256_DSA?: string; - SHA256_ECDSA?: string; - SHA256_ED25519?: string; - } & { [key: string]: unknown }; + SHA256_RSA?: string + SHA256_DSA?: string + SHA256_ECDSA?: string + SHA256_ED25519?: string + } & { [key: string]: unknown } /** @example ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIOMqqnkVzrm0SdG6UOoqKLsabgH5C9okWi0dh2l9GKJl */ - ssh_keys?: string[]; + ssh_keys?: string[] /** @example 127.0.0.1/32 */ - hooks?: string[]; + hooks?: string[] /** @example 127.0.0.1/32 */ - web?: string[]; + web?: string[] /** @example 127.0.0.1/32 */ - api?: string[]; + api?: string[] /** @example 127.0.0.1/32 */ - git?: string[]; + git?: string[] /** @example 13.65.0.0/16,157.55.204.33/32,2a01:111:f403:f90c::/62 */ - packages?: string[]; + packages?: string[] /** @example 192.30.252.153/32,192.30.252.154/32 */ - pages?: string[]; + pages?: string[] /** @example 54.158.161.132,54.226.70.38 */ - importer?: string[]; + importer?: string[] /** @example 13.64.0.0/16,13.65.0.0/16 */ - actions?: string[]; + actions?: string[] /** @example 192.168.7.15/32,192.168.7.16/32 */ - dependabot?: string[]; - } & { [key: string]: unknown }; + dependabot?: string[] + } & { [key: string]: unknown } /** * Thread * @description Thread */ thread: { - id: string; - repository: components["schemas"]["minimal-repository"]; + id: string + repository: components['schemas']['minimal-repository'] subject: { - title: string; - url: string; - latest_comment_url: string; - type: string; - } & { [key: string]: unknown }; - reason: string; - unread: boolean; - updated_at: string; - last_read_at: string | null; - url: string; + title: string + url: string + latest_comment_url: string + type: string + } & { [key: string]: unknown } + reason: string + unread: boolean + updated_at: string + last_read_at: string | null + url: string /** @example https://api.github.com/notifications/threads/2/subscription */ - subscription_url: string; - } & { [key: string]: unknown }; + subscription_url: string + } & { [key: string]: unknown } /** * Thread Subscription * @description Thread Subscription */ - "thread-subscription": { + 'thread-subscription': { /** @example true */ - subscribed: boolean; - ignored: boolean; - reason: string | null; + subscribed: boolean + ignored: boolean + reason: string | null /** * Format: date-time * @example 2012-10-06T21:34:12Z */ - created_at: string | null; + created_at: string | null /** * Format: uri * @example https://api.github.com/notifications/threads/1/subscription */ - url: string; + url: string /** * Format: uri * @example https://api.github.com/notifications/threads/1 */ - thread_url?: string; + thread_url?: string /** * Format: uri * @example https://api.github.com/repos/1 */ - repository_url?: string; - } & { [key: string]: unknown }; + repository_url?: string + } & { [key: string]: unknown } /** * Organization Custom Repository Role * @description Custom repository roles created by organization administrators */ - "organization-custom-repository-role": { - id: number; - name: string; - } & { [key: string]: unknown }; + 'organization-custom-repository-role': { + id: number + name: string + } & { [key: string]: unknown } /** * ExternalGroups * @description A list of external groups available to be connected to a team */ - "external-groups": { + 'external-groups': { /** * @description An array of external groups available to be mapped to a team * @example [object Object],[object Object] @@ -9127,488 +9115,488 @@ export interface components { * @description The internal ID of the group * @example 1 */ - group_id: number; + group_id: number /** * @description The display name of the group * @example group-azuread-test */ - group_name: string; + group_name: string /** * @description The time of the last update for this group * @example 2019-06-03 22:27:15:000 -700 */ - updated_at: string; - } & { [key: string]: unknown })[]; - } & { [key: string]: unknown }; + updated_at: string + } & { [key: string]: unknown })[] + } & { [key: string]: unknown } /** * Organization Full * @description Organization Full */ - "organization-full": { + 'organization-full': { /** @example github */ - login: string; + login: string /** @example 1 */ - id: number; + id: number /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ - node_id: string; + node_id: string /** * Format: uri * @example https://api.github.com/orgs/github */ - url: string; + url: string /** * Format: uri * @example https://api.github.com/orgs/github/repos */ - repos_url: string; + repos_url: string /** * Format: uri * @example https://api.github.com/orgs/github/events */ - events_url: string; + events_url: string /** @example https://api.github.com/orgs/github/hooks */ - hooks_url: string; + hooks_url: string /** @example https://api.github.com/orgs/github/issues */ - issues_url: string; + issues_url: string /** @example https://api.github.com/orgs/github/members{/member} */ - members_url: string; + members_url: string /** @example https://api.github.com/orgs/github/public_members{/member} */ - public_members_url: string; + public_members_url: string /** @example https://github.com/images/error/octocat_happy.gif */ - avatar_url: string; + avatar_url: string /** @example A great organization */ - description: string | null; + description: string | null /** @example github */ - name?: string; + name?: string /** @example GitHub */ - company?: string; + company?: string /** * Format: uri * @example https://github.com/blog */ - blog?: string; + blog?: string /** @example San Francisco */ - location?: string; + location?: string /** * Format: email * @example octocat@github.com */ - email?: string; + email?: string /** @example github */ - twitter_username?: string | null; + twitter_username?: string | null /** @example true */ - is_verified?: boolean; + is_verified?: boolean /** @example true */ - has_organization_projects: boolean; + has_organization_projects: boolean /** @example true */ - has_repository_projects: boolean; + has_repository_projects: boolean /** @example 2 */ - public_repos: number; + public_repos: number /** @example 1 */ - public_gists: number; + public_gists: number /** @example 20 */ - followers: number; - following: number; + followers: number + following: number /** * Format: uri * @example https://github.com/octocat */ - html_url: string; + html_url: string /** * Format: date-time * @example 2008-01-14T04:33:35Z */ - created_at: string; + created_at: string /** @example Organization */ - type: string; + type: string /** @example 100 */ - total_private_repos?: number; + total_private_repos?: number /** @example 100 */ - owned_private_repos?: number; + owned_private_repos?: number /** @example 81 */ - private_gists?: number | null; + private_gists?: number | null /** @example 10000 */ - disk_usage?: number | null; + disk_usage?: number | null /** @example 8 */ - collaborators?: number | null; + collaborators?: number | null /** * Format: email * @example org@example.com */ - billing_email?: string | null; + billing_email?: string | null plan?: { - name: string; - space: number; - private_repos: number; - filled_seats?: number; - seats?: number; - } & { [key: string]: unknown }; - default_repository_permission?: string | null; + name: string + space: number + private_repos: number + filled_seats?: number + seats?: number + } & { [key: string]: unknown } + default_repository_permission?: string | null /** @example true */ - members_can_create_repositories?: boolean | null; + members_can_create_repositories?: boolean | null /** @example true */ - two_factor_requirement_enabled?: boolean | null; + two_factor_requirement_enabled?: boolean | null /** @example all */ - members_allowed_repository_creation_type?: string; + members_allowed_repository_creation_type?: string /** @example true */ - members_can_create_public_repositories?: boolean; + members_can_create_public_repositories?: boolean /** @example true */ - members_can_create_private_repositories?: boolean; + members_can_create_private_repositories?: boolean /** @example true */ - members_can_create_internal_repositories?: boolean; + members_can_create_internal_repositories?: boolean /** @example true */ - members_can_create_pages?: boolean; + members_can_create_pages?: boolean /** @example true */ - members_can_create_public_pages?: boolean; + members_can_create_public_pages?: boolean /** @example true */ - members_can_create_private_pages?: boolean; - members_can_fork_private_repositories?: boolean | null; + members_can_create_private_pages?: boolean + members_can_fork_private_repositories?: boolean | null /** Format: date-time */ - updated_at: string; - } & { [key: string]: unknown }; + updated_at: string + } & { [key: string]: unknown } /** * @description The policy that controls the repositories in the organization that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`. * @enum {string} */ - "enabled-repositories": "all" | "none" | "selected"; - "actions-organization-permissions": { - enabled_repositories: components["schemas"]["enabled-repositories"]; + 'enabled-repositories': 'all' | 'none' | 'selected' + 'actions-organization-permissions': { + enabled_repositories: components['schemas']['enabled-repositories'] /** @description The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. */ - selected_repositories_url?: string; - allowed_actions?: components["schemas"]["allowed-actions"]; - selected_actions_url?: components["schemas"]["selected-actions-url"]; - } & { [key: string]: unknown }; + selected_repositories_url?: string + allowed_actions?: components['schemas']['allowed-actions'] + selected_actions_url?: components['schemas']['selected-actions-url'] + } & { [key: string]: unknown } /** * @description The default workflow permissions granted to the GITHUB_TOKEN when running workflows in an organization. * @enum {string} */ - "actions-default-workflow-permissions": "read" | "write"; + 'actions-default-workflow-permissions': 'read' | 'write' /** @description Whether GitHub Actions can submit approving pull request reviews. */ - "actions-can-approve-pull-request-reviews": boolean; - "actions-get-default-workflow-permissions": { - default_workflow_permissions: components["schemas"]["actions-default-workflow-permissions"]; - can_approve_pull_request_reviews: components["schemas"]["actions-can-approve-pull-request-reviews"]; - } & { [key: string]: unknown }; - "actions-set-default-workflow-permissions": { - default_workflow_permissions?: components["schemas"]["actions-default-workflow-permissions"]; - can_approve_pull_request_reviews?: components["schemas"]["actions-can-approve-pull-request-reviews"]; - } & { [key: string]: unknown }; - "runner-groups-org": { - id: number; - name: string; - visibility: string; - default: boolean; + 'actions-can-approve-pull-request-reviews': boolean + 'actions-get-default-workflow-permissions': { + default_workflow_permissions: components['schemas']['actions-default-workflow-permissions'] + can_approve_pull_request_reviews: components['schemas']['actions-can-approve-pull-request-reviews'] + } & { [key: string]: unknown } + 'actions-set-default-workflow-permissions': { + default_workflow_permissions?: components['schemas']['actions-default-workflow-permissions'] + can_approve_pull_request_reviews?: components['schemas']['actions-can-approve-pull-request-reviews'] + } & { [key: string]: unknown } + 'runner-groups-org': { + id: number + name: string + visibility: string + default: boolean /** @description Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected` */ - selected_repositories_url?: string; - runners_url: string; - inherited: boolean; - inherited_allows_public_repositories?: boolean; - allows_public_repositories: boolean; - } & { [key: string]: unknown }; + selected_repositories_url?: string + runners_url: string + inherited: boolean + inherited_allows_public_repositories?: boolean + allows_public_repositories: boolean + } & { [key: string]: unknown } /** * Actions Secret for an Organization * @description Secrets for GitHub Actions for an organization. */ - "organization-actions-secret": { + 'organization-actions-secret': { /** * @description The name of the secret. * @example SECRET_TOKEN */ - name: string; + name: string /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; + updated_at: string /** * @description Visibility of a secret * @enum {string} */ - visibility: "all" | "private" | "selected"; + visibility: 'all' | 'private' | 'selected' /** * Format: uri * @example https://api.github.com/organizations/org/secrets/my_secret/repositories */ - selected_repositories_url?: string; - } & { [key: string]: unknown }; + selected_repositories_url?: string + } & { [key: string]: unknown } /** * ActionsPublicKey * @description The public key used for setting Actions Secrets. */ - "actions-public-key": { + 'actions-public-key': { /** * @description The identifier for the key. * @example 1234567 */ - key_id: string; + key_id: string /** * @description The Base64 encoded public key. * @example hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= */ - key: string; + key: string /** @example 2 */ - id?: number; + id?: number /** @example https://api.github.com/user/keys/2 */ - url?: string; + url?: string /** @example ssh-rsa AAAAB3NzaC1yc2EAAA */ - title?: string; + title?: string /** @example 2011-01-26T19:01:12Z */ - created_at?: string; - } & { [key: string]: unknown }; + created_at?: string + } & { [key: string]: unknown } /** * Empty Object * @description An object without any properties. */ - "empty-object": { [key: string]: unknown }; + 'empty-object': { [key: string]: unknown } /** * @description State of a code scanning alert. * @enum {string} */ - "code-scanning-alert-state": "open" | "closed" | "dismissed" | "fixed"; + 'code-scanning-alert-state': 'open' | 'closed' | 'dismissed' | 'fixed' /** * Format: date-time * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "alert-updated-at": string; + 'alert-updated-at': string /** * Format: uri * @description The REST API URL for fetching the list of instances for an alert. */ - "alert-instances-url": string; + 'alert-instances-url': string /** * Format: date-time * @description The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "code-scanning-alert-fixed-at": string | null; + 'code-scanning-alert-fixed-at': string | null /** * Format: date-time * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "code-scanning-alert-dismissed-at": string | null; + 'code-scanning-alert-dismissed-at': string | null /** * @description **Required when the state is dismissed.** The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. * @enum {string|null} */ - "code-scanning-alert-dismissed-reason": (null | "false positive" | "won't fix" | "used in tests") | null; - "code-scanning-alert-rule": { + 'code-scanning-alert-dismissed-reason': (null | 'false positive' | "won't fix" | 'used in tests') | null + 'code-scanning-alert-rule': { /** @description A unique identifier for the rule used to detect the alert. */ - id?: string | null; + id?: string | null /** @description The name of the rule used to detect the alert. */ - name?: string; + name?: string /** * @description The severity of the alert. * @enum {string|null} */ - severity?: ("none" | "note" | "warning" | "error") | null; + severity?: ('none' | 'note' | 'warning' | 'error') | null /** * @description The security severity of the alert. * @enum {string|null} */ - security_severity_level?: ("low" | "medium" | "high" | "critical") | null; + security_severity_level?: ('low' | 'medium' | 'high' | 'critical') | null /** @description A short description of the rule used to detect the alert. */ - description?: string; + description?: string /** @description description of the rule used to detect the alert. */ - full_description?: string; + full_description?: string /** @description A set of tags applicable for the rule. */ - tags?: string[] | null; + tags?: string[] | null /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */ - help?: string | null; - } & { [key: string]: unknown }; + help?: string | null + } & { [key: string]: unknown } /** @description The name of the tool used to generate the code scanning analysis. */ - "code-scanning-analysis-tool-name": string; + 'code-scanning-analysis-tool-name': string /** @description The version of the tool used to generate the code scanning analysis. */ - "code-scanning-analysis-tool-version": string | null; + 'code-scanning-analysis-tool-version': string | null /** @description The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. */ - "code-scanning-analysis-tool-guid": string | null; - "code-scanning-analysis-tool": { - name?: components["schemas"]["code-scanning-analysis-tool-name"]; - version?: components["schemas"]["code-scanning-analysis-tool-version"]; - guid?: components["schemas"]["code-scanning-analysis-tool-guid"]; - } & { [key: string]: unknown }; + 'code-scanning-analysis-tool-guid': string | null + 'code-scanning-analysis-tool': { + name?: components['schemas']['code-scanning-analysis-tool-name'] + version?: components['schemas']['code-scanning-analysis-tool-version'] + guid?: components['schemas']['code-scanning-analysis-tool-guid'] + } & { [key: string]: unknown } /** * @description The full Git reference, formatted as `refs/heads/`, * `refs/pull//merge`, or `refs/pull//head`. */ - "code-scanning-ref": string; + 'code-scanning-ref': string /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - "code-scanning-analysis-analysis-key": string; + 'code-scanning-analysis-analysis-key': string /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - "code-scanning-alert-environment": string; + 'code-scanning-alert-environment': string /** @description Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code. */ - "code-scanning-analysis-category": string; + 'code-scanning-analysis-category': string /** @description Describe a region within a file for the alert. */ - "code-scanning-alert-location": { - path?: string; - start_line?: number; - end_line?: number; - start_column?: number; - end_column?: number; - } & { [key: string]: unknown }; + 'code-scanning-alert-location': { + path?: string + start_line?: number + end_line?: number + start_column?: number + end_column?: number + } & { [key: string]: unknown } /** * @description A classification of the file. For example to identify it as generated. * @enum {string|null} */ - "code-scanning-alert-classification": ("source" | "generated" | "test" | "library") | null; - "code-scanning-alert-instance": { - ref?: components["schemas"]["code-scanning-ref"]; - analysis_key?: components["schemas"]["code-scanning-analysis-analysis-key"]; - environment?: components["schemas"]["code-scanning-alert-environment"]; - category?: components["schemas"]["code-scanning-analysis-category"]; - state?: components["schemas"]["code-scanning-alert-state"]; - commit_sha?: string; + 'code-scanning-alert-classification': ('source' | 'generated' | 'test' | 'library') | null + 'code-scanning-alert-instance': { + ref?: components['schemas']['code-scanning-ref'] + analysis_key?: components['schemas']['code-scanning-analysis-analysis-key'] + environment?: components['schemas']['code-scanning-alert-environment'] + category?: components['schemas']['code-scanning-analysis-category'] + state?: components['schemas']['code-scanning-alert-state'] + commit_sha?: string message?: { - text?: string; - } & { [key: string]: unknown }; - location?: components["schemas"]["code-scanning-alert-location"]; - html_url?: string; + text?: string + } & { [key: string]: unknown } + location?: components['schemas']['code-scanning-alert-location'] + html_url?: string /** * @description Classifications that have been applied to the file that triggered the alert. * For example identifying it as documentation, or a generated file. */ - classifications?: components["schemas"]["code-scanning-alert-classification"][]; - } & { [key: string]: unknown }; - "code-scanning-organization-alert-items": { - number: components["schemas"]["alert-number"]; - created_at: components["schemas"]["alert-created-at"]; - updated_at?: components["schemas"]["alert-updated-at"]; - url: components["schemas"]["alert-url"]; - html_url: components["schemas"]["alert-html-url"]; - instances_url: components["schemas"]["alert-instances-url"]; - state: components["schemas"]["code-scanning-alert-state"]; - fixed_at?: components["schemas"]["code-scanning-alert-fixed-at"]; - dismissed_by: components["schemas"]["nullable-simple-user"]; - dismissed_at: components["schemas"]["code-scanning-alert-dismissed-at"]; - dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"]; - rule: components["schemas"]["code-scanning-alert-rule"]; - tool: components["schemas"]["code-scanning-analysis-tool"]; - most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; - repository: components["schemas"]["minimal-repository"]; - } & { [key: string]: unknown }; + classifications?: components['schemas']['code-scanning-alert-classification'][] + } & { [key: string]: unknown } + 'code-scanning-organization-alert-items': { + number: components['schemas']['alert-number'] + created_at: components['schemas']['alert-created-at'] + updated_at?: components['schemas']['alert-updated-at'] + url: components['schemas']['alert-url'] + html_url: components['schemas']['alert-html-url'] + instances_url: components['schemas']['alert-instances-url'] + state: components['schemas']['code-scanning-alert-state'] + fixed_at?: components['schemas']['code-scanning-alert-fixed-at'] + dismissed_by: components['schemas']['nullable-simple-user'] + dismissed_at: components['schemas']['code-scanning-alert-dismissed-at'] + dismissed_reason: components['schemas']['code-scanning-alert-dismissed-reason'] + rule: components['schemas']['code-scanning-alert-rule'] + tool: components['schemas']['code-scanning-analysis-tool'] + most_recent_instance: components['schemas']['code-scanning-alert-instance'] + repository: components['schemas']['minimal-repository'] + } & { [key: string]: unknown } /** * Credential Authorization * @description Credential Authorization */ - "credential-authorization": { + 'credential-authorization': { /** * @description User login that owns the underlying credential. * @example monalisa */ - login: string; + login: string /** * @description Unique identifier for the credential. * @example 1 */ - credential_id: number; + credential_id: number /** * @description Human-readable description of the credential type. * @example SSH Key */ - credential_type: string; + credential_type: string /** * @description Last eight characters of the credential. Only included in responses with credential_type of personal access token. * @example 12345678 */ - token_last_eight?: string; + token_last_eight?: string /** * Format: date-time * @description Date when the credential was authorized for use. * @example 2011-01-26T19:06:43Z */ - credential_authorized_at: string; + credential_authorized_at: string /** * @description List of oauth scopes the token has been granted. * @example user,repo */ - scopes?: string[]; + scopes?: string[] /** * @description Unique string to distinguish the credential. Only included in responses with credential_type of SSH Key. * @example jklmnop12345678 */ - fingerprint?: string; + fingerprint?: string /** * Format: date-time * @description Date when the credential was last accessed. May be null if it was never accessed * @example 2011-01-26T19:06:43Z */ - credential_accessed_at: string | null; + credential_accessed_at: string | null /** @example 12345678 */ - authorized_credential_id: number | null; + authorized_credential_id: number | null /** * @description The title given to the ssh key. This will only be present when the credential is an ssh key. * @example my ssh key */ - authorized_credential_title?: string | null; + authorized_credential_title?: string | null /** * @description The note given to the token. This will only be present when the credential is a token. * @example my token */ - authorized_credential_note?: string | null; + authorized_credential_note?: string | null /** * Format: date-time * @description The expiry for the token. This will only be present when the credential is a token. */ - authorized_credential_expires_at?: string | null; - } & { [key: string]: unknown }; + authorized_credential_expires_at?: string | null + } & { [key: string]: unknown } /** * Dependabot Secret for an Organization * @description Secrets for GitHub Dependabot for an organization. */ - "organization-dependabot-secret": { + 'organization-dependabot-secret': { /** * @description The name of the secret. * @example SECRET_TOKEN */ - name: string; + name: string /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; + updated_at: string /** * @description Visibility of a secret * @enum {string} */ - visibility: "all" | "private" | "selected"; + visibility: 'all' | 'private' | 'selected' /** * Format: uri * @example https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories */ - selected_repositories_url?: string; - } & { [key: string]: unknown }; + selected_repositories_url?: string + } & { [key: string]: unknown } /** * DependabotPublicKey * @description The public key used for setting Dependabot Secrets. */ - "dependabot-public-key": { + 'dependabot-public-key': { /** * @description The identifier for the key. * @example 1234567 */ - key_id: string; + key_id: string /** * @description The Base64 encoded public key. * @example hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= */ - key: string; - } & { [key: string]: unknown }; + key: string + } & { [key: string]: unknown } /** * ExternalGroup * @description Information about an external group's usage and its members */ - "external-group": { + 'external-group': { /** * @description The internal ID of the group * @example 1 */ - group_id: number; + group_id: number /** * @description The display name for the group * @example group-azuread-test */ - group_name: string; + group_name: string /** * @description The date when the group was last updated_at * @example 2021-01-03 22:27:15:000 -700 */ - updated_at?: string; + updated_at?: string /** * @description An array of teams linked to this group * @example [object Object],[object Object] @@ -9618,13 +9606,13 @@ export interface components { * @description The id for a team * @example 1 */ - team_id: number; + team_id: number /** * @description The name of the team * @example team-test */ - team_name: string; - } & { [key: string]: unknown })[]; + team_name: string + } & { [key: string]: unknown })[] /** * @description An array of external members linked to this group * @example [object Object],[object Object] @@ -9634,499 +9622,499 @@ export interface components { * @description The internal user ID of the identity * @example 1 */ - member_id: number; + member_id: number /** * @description The handle/login for the user * @example mona-lisa_eocsaxrs */ - member_login: string; + member_login: string /** * @description The user display name/profile name * @example Mona Lisa */ - member_name: string; + member_name: string /** * @description An email attached to a user * @example mona_lisa@github.com */ - member_email: string; - } & { [key: string]: unknown })[]; - } & { [key: string]: unknown }; + member_email: string + } & { [key: string]: unknown })[] + } & { [key: string]: unknown } /** * Organization Invitation * @description Organization Invitation */ - "organization-invitation": { - id: number; - login: string | null; - email: string | null; - role: string; - created_at: string; - failed_at?: string | null; - failed_reason?: string | null; - inviter: components["schemas"]["simple-user"]; - team_count: number; + 'organization-invitation': { + id: number + login: string | null + email: string | null + role: string + created_at: string + failed_at?: string | null + failed_reason?: string | null + inviter: components['schemas']['simple-user'] + team_count: number /** @example "MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x" */ - node_id: string; + node_id: string /** @example "https://api.github.com/organizations/16/invitations/1/teams" */ - invitation_teams_url: string; - } & { [key: string]: unknown }; + invitation_teams_url: string + } & { [key: string]: unknown } /** * Org Hook * @description Org Hook */ - "org-hook": { + 'org-hook': { /** @example 1 */ - id: number; + id: number /** * Format: uri * @example https://api.github.com/orgs/octocat/hooks/1 */ - url: string; + url: string /** * Format: uri * @example https://api.github.com/orgs/octocat/hooks/1/pings */ - ping_url: string; + ping_url: string /** * Format: uri * @example https://api.github.com/orgs/octocat/hooks/1/deliveries */ - deliveries_url?: string; + deliveries_url?: string /** @example web */ - name: string; + name: string /** @example push,pull_request */ - events: string[]; + events: string[] /** @example true */ - active: boolean; + active: boolean config: { /** @example "http://example.com/2" */ - url?: string; + url?: string /** @example "0" */ - insecure_ssl?: string; + insecure_ssl?: string /** @example "form" */ - content_type?: string; + content_type?: string /** @example "********" */ - secret?: string; - } & { [key: string]: unknown }; + secret?: string + } & { [key: string]: unknown } /** * Format: date-time * @example 2011-09-06T20:39:23Z */ - updated_at: string; + updated_at: string /** * Format: date-time * @example 2011-09-06T17:26:27Z */ - created_at: string; - type: string; - } & { [key: string]: unknown }; + created_at: string + type: string + } & { [key: string]: unknown } /** * @description The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. Can be one of: `existing_users`, `contributors_only`, `collaborators_only`. * @example collaborators_only * @enum {string} */ - "interaction-group": "existing_users" | "contributors_only" | "collaborators_only"; + 'interaction-group': 'existing_users' | 'contributors_only' | 'collaborators_only' /** * Interaction Limits * @description Interaction limit settings. */ - "interaction-limit-response": { - limit: components["schemas"]["interaction-group"]; + 'interaction-limit-response': { + limit: components['schemas']['interaction-group'] /** @example repository */ - origin: string; + origin: string /** * Format: date-time * @example 2018-08-17T04:18:39Z */ - expires_at: string; - } & { [key: string]: unknown }; + expires_at: string + } & { [key: string]: unknown } /** * @description The duration of the interaction restriction. Can be one of: `one_day`, `three_days`, `one_week`, `one_month`, `six_months`. Default: `one_day`. * @example one_month * @enum {string} */ - "interaction-expiry": "one_day" | "three_days" | "one_week" | "one_month" | "six_months"; + 'interaction-expiry': 'one_day' | 'three_days' | 'one_week' | 'one_month' | 'six_months' /** * Interaction Restrictions * @description Limit interactions to a specific type of user for a specified duration */ - "interaction-limit": { - limit: components["schemas"]["interaction-group"]; - expiry?: components["schemas"]["interaction-expiry"]; - } & { [key: string]: unknown }; + 'interaction-limit': { + limit: components['schemas']['interaction-group'] + expiry?: components['schemas']['interaction-expiry'] + } & { [key: string]: unknown } /** * Team Simple * @description Groups of organization members that gives permissions on specified repositories. */ - "nullable-team-simple": + 'nullable-team-simple': | ({ /** * @description Unique identifier of the team * @example 1 */ - id: number; + id: number /** @example MDQ6VGVhbTE= */ - node_id: string; + node_id: string /** * Format: uri * @description URL for the team * @example https://api.github.com/organizations/1/team/1 */ - url: string; + url: string /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - members_url: string; + members_url: string /** * @description Name of the team * @example Justice League */ - name: string; + name: string /** * @description Description of the team * @example A great team. */ - description: string | null; + description: string | null /** * @description Permission that the team will have for its repositories * @example admin */ - permission: string; + permission: string /** * @description The level of privacy this team should have * @example closed */ - privacy?: string; + privacy?: string /** * Format: uri * @example https://github.com/orgs/rails/teams/core */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/organizations/1/team/1/repos */ - repositories_url: string; + repositories_url: string /** @example justice-league */ - slug: string; + slug: string /** * @description Distinguished Name (DN) that team maps to within LDAP environment * @example uid=example,ou=users,dc=github,dc=com */ - ldap_dn?: string; + ldap_dn?: string } & { [key: string]: unknown }) - | null; + | null /** * Team * @description Groups of organization members that gives permissions on specified repositories. */ team: { - id: number; - node_id: string; - name: string; - slug: string; - description: string | null; - privacy?: string; - permission: string; + id: number + node_id: string + name: string + slug: string + description: string | null + privacy?: string + permission: string permissions?: { - pull: boolean; - triage: boolean; - push: boolean; - maintain: boolean; - admin: boolean; - } & { [key: string]: unknown }; + pull: boolean + triage: boolean + push: boolean + maintain: boolean + admin: boolean + } & { [key: string]: unknown } /** Format: uri */ - url: string; + url: string /** * Format: uri * @example https://github.com/orgs/rails/teams/core */ - html_url: string; - members_url: string; + html_url: string + members_url: string /** Format: uri */ - repositories_url: string; - parent: components["schemas"]["nullable-team-simple"]; - } & { [key: string]: unknown }; + repositories_url: string + parent: components['schemas']['nullable-team-simple'] + } & { [key: string]: unknown } /** * Org Membership * @description Org Membership */ - "org-membership": { + 'org-membership': { /** * Format: uri * @example https://api.github.com/orgs/octocat/memberships/defunkt */ - url: string; + url: string /** * @description The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation. * @example active * @enum {string} */ - state: "active" | "pending"; + state: 'active' | 'pending' /** * @description The user's membership type in the organization. * @example admin * @enum {string} */ - role: "admin" | "member" | "billing_manager"; + role: 'admin' | 'member' | 'billing_manager' /** * Format: uri * @example https://api.github.com/orgs/octocat */ - organization_url: string; - organization: components["schemas"]["organization-simple"]; - user: components["schemas"]["nullable-simple-user"]; + organization_url: string + organization: components['schemas']['organization-simple'] + user: components['schemas']['nullable-simple-user'] permissions?: { - can_create_repository: boolean; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + can_create_repository: boolean + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** * Migration * @description A migration. */ migration: { /** @example 79 */ - id: number; - owner: components["schemas"]["nullable-simple-user"]; + id: number + owner: components['schemas']['nullable-simple-user'] /** @example 0b989ba4-242f-11e5-81e1-c7b6966d2516 */ - guid: string; + guid: string /** @example pending */ - state: string; + state: string /** @example true */ - lock_repositories: boolean; - exclude_metadata: boolean; - exclude_git_data: boolean; - exclude_attachments: boolean; - exclude_releases: boolean; - exclude_owner_projects: boolean; - repositories: components["schemas"]["repository"][]; + lock_repositories: boolean + exclude_metadata: boolean + exclude_git_data: boolean + exclude_attachments: boolean + exclude_releases: boolean + exclude_owner_projects: boolean + repositories: components['schemas']['repository'][] /** * Format: uri * @example https://api.github.com/orgs/octo-org/migrations/79 */ - url: string; + url: string /** * Format: date-time * @example 2015-07-06T15:33:38-07:00 */ - created_at: string; + created_at: string /** * Format: date-time * @example 2015-07-06T15:33:38-07:00 */ - updated_at: string; - node_id: string; + updated_at: string + node_id: string /** Format: uri */ - archive_url?: string; - exclude?: unknown[]; - } & { [key: string]: unknown }; + archive_url?: string + exclude?: unknown[] + } & { [key: string]: unknown } /** * Minimal Repository * @description Minimal Repository */ - "nullable-minimal-repository": + 'nullable-minimal-repository': | ({ /** @example 1296269 */ - id: number; + id: number /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - node_id: string; + node_id: string /** @example Hello-World */ - name: string; + name: string /** @example octocat/Hello-World */ - full_name: string; - owner: components["schemas"]["simple-user"]; - private: boolean; + full_name: string + owner: components['schemas']['simple-user'] + private: boolean /** * Format: uri * @example https://github.com/octocat/Hello-World */ - html_url: string; + html_url: string /** @example This your first repo! */ - description: string | null; - fork: boolean; + description: string | null + fork: boolean /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World */ - url: string; + url: string /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - archive_url: string; + archive_url: string /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - assignees_url: string; + assignees_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - blobs_url: string; + blobs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - branches_url: string; + branches_url: string /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - collaborators_url: string; + collaborators_url: string /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - comments_url: string; + comments_url: string /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - commits_url: string; + commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - compare_url: string; + compare_url: string /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - contents_url: string; + contents_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - contributors_url: string; + contributors_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - deployments_url: string; + deployments_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - downloads_url: string; + downloads_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events */ - events_url: string; + events_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ - forks_url: string; + forks_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - git_commits_url: string; + git_commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - git_refs_url: string; + git_refs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - git_tags_url: string; - git_url?: string; + git_tags_url: string + git_url?: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - issue_comment_url: string; + issue_comment_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - issue_events_url: string; + issue_events_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - issues_url: string; + issues_url: string /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - keys_url: string; + keys_url: string /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - labels_url: string; + labels_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ - languages_url: string; + languages_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ - merges_url: string; + merges_url: string /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - milestones_url: string; + milestones_url: string /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - notifications_url: string; + notifications_url: string /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - pulls_url: string; + pulls_url: string /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - releases_url: string; - ssh_url?: string; + releases_url: string + ssh_url?: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - stargazers_url: string; + stargazers_url: string /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - statuses_url: string; + statuses_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - subscribers_url: string; + subscribers_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - subscription_url: string; + subscription_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ - tags_url: string; + tags_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ - teams_url: string; + teams_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - trees_url: string; - clone_url?: string; - mirror_url?: string | null; + trees_url: string + clone_url?: string + mirror_url?: string | null /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - hooks_url: string; - svn_url?: string; - homepage?: string | null; - language?: string | null; - forks_count?: number; - stargazers_count?: number; - watchers_count?: number; - size?: number; - default_branch?: string; - open_issues_count?: number; - is_template?: boolean; - topics?: string[]; - has_issues?: boolean; - has_projects?: boolean; - has_wiki?: boolean; - has_pages?: boolean; - has_downloads?: boolean; - archived?: boolean; - disabled?: boolean; - visibility?: string; + hooks_url: string + svn_url?: string + homepage?: string | null + language?: string | null + forks_count?: number + stargazers_count?: number + watchers_count?: number + size?: number + default_branch?: string + open_issues_count?: number + is_template?: boolean + topics?: string[] + has_issues?: boolean + has_projects?: boolean + has_wiki?: boolean + has_pages?: boolean + has_downloads?: boolean + archived?: boolean + disabled?: boolean + visibility?: string /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - pushed_at?: string | null; + pushed_at?: string | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - created_at?: string | null; + created_at?: string | null /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - updated_at?: string | null; + updated_at?: string | null permissions?: { - admin?: boolean; - maintain?: boolean; - push?: boolean; - triage?: boolean; - pull?: boolean; - } & { [key: string]: unknown }; + admin?: boolean + maintain?: boolean + push?: boolean + triage?: boolean + pull?: boolean + } & { [key: string]: unknown } /** @example admin */ - role_name?: string; - template_repository?: components["schemas"]["nullable-repository"]; - temp_clone_token?: string; - delete_branch_on_merge?: boolean; - subscribers_count?: number; - network_count?: number; - code_of_conduct?: components["schemas"]["code-of-conduct"]; + role_name?: string + template_repository?: components['schemas']['nullable-repository'] + temp_clone_token?: string + delete_branch_on_merge?: boolean + subscribers_count?: number + network_count?: number + code_of_conduct?: components['schemas']['code-of-conduct'] license?: | ({ - key?: string; - name?: string; - spdx_id?: string; - url?: string; - node_id?: string; + key?: string + name?: string + spdx_id?: string + url?: string + node_id?: string } & { [key: string]: unknown }) - | null; - forks?: number; - open_issues?: number; - watchers?: number; - allow_forking?: boolean; + | null + forks?: number + open_issues?: number + watchers?: number + allow_forking?: boolean } & { [key: string]: unknown }) - | null; + | null /** * Package * @description A software package @@ -10136,96 +10124,96 @@ export interface components { * @description Unique identifier of the package. * @example 1 */ - id: number; + id: number /** * @description The name of the package. * @example super-linter */ - name: string; + name: string /** * @example docker * @enum {string} */ - package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + package_type: 'npm' | 'maven' | 'rubygems' | 'docker' | 'nuget' | 'container' /** @example https://api.github.com/orgs/github/packages/container/super-linter */ - url: string; + url: string /** @example https://github.com/orgs/github/packages/container/package/super-linter */ - html_url: string; + html_url: string /** * @description The number of versions of the package. * @example 1 */ - version_count: number; + version_count: number /** * @example private * @enum {string} */ - visibility: "private" | "public"; - owner?: components["schemas"]["nullable-simple-user"]; - repository?: components["schemas"]["nullable-minimal-repository"]; + visibility: 'private' | 'public' + owner?: components['schemas']['nullable-simple-user'] + repository?: components['schemas']['nullable-minimal-repository'] /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - } & { [key: string]: unknown }; + updated_at: string + } & { [key: string]: unknown } /** * Package Version * @description A version of a software package */ - "package-version": { + 'package-version': { /** * @description Unique identifier of the package version. * @example 1 */ - id: number; + id: number /** * @description The name of the package version. * @example latest */ - name: string; + name: string /** @example https://api.github.com/orgs/github/packages/container/super-linter/versions/786068 */ - url: string; + url: string /** @example https://github.com/orgs/github/packages/container/package/super-linter */ - package_html_url: string; + package_html_url: string /** @example https://github.com/orgs/github/packages/container/super-linter/786068 */ - html_url?: string; + html_url?: string /** @example MIT */ - license?: string; - description?: string; + license?: string + description?: string /** * Format: date-time * @example 2011-04-10T20:09:31Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2014-03-03T18:58:10Z */ - updated_at: string; + updated_at: string /** * Format: date-time * @example 2014-03-03T18:58:10Z */ - deleted_at?: string; + deleted_at?: string /** Package Version Metadata */ metadata?: { /** * @example docker * @enum {string} */ - package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + package_type: 'npm' | 'maven' | 'rubygems' | 'docker' | 'nuget' | 'container' /** Container Metadata */ container?: { - tags: string[]; - } & { [key: string]: unknown }; + tags: string[] + } & { [key: string]: unknown } /** Docker Metadata */ docker?: { - tag?: string[]; + tag?: string[] } & { - tags: unknown; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + tags: unknown + } & { [key: string]: unknown } + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** * Project * @description Projects are a way to organize columns and cards of work. @@ -10235,67 +10223,67 @@ export interface components { * Format: uri * @example https://api.github.com/repos/api-playground/projects-test */ - owner_url: string; + owner_url: string /** * Format: uri * @example https://api.github.com/projects/1002604 */ - url: string; + url: string /** * Format: uri * @example https://github.com/api-playground/projects-test/projects/12 */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/projects/1002604/columns */ - columns_url: string; + columns_url: string /** @example 1002604 */ - id: number; + id: number /** @example MDc6UHJvamVjdDEwMDI2MDQ= */ - node_id: string; + node_id: string /** * @description Name of the project * @example Week One Sprint */ - name: string; + name: string /** * @description Body of the project * @example This project represents the sprint of the first week in January */ - body: string | null; + body: string | null /** @example 1 */ - number: number; + number: number /** * @description State of the project; either 'open' or 'closed' * @example open */ - state: string; - creator: components["schemas"]["nullable-simple-user"]; + state: string + creator: components['schemas']['nullable-simple-user'] /** * Format: date-time * @example 2011-04-10T20:09:31Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2014-03-03T18:58:10Z */ - updated_at: string; + updated_at: string /** * @description The baseline permission that all organization members have on this project. Only present if owner is an organization. * @enum {string} */ - organization_permission?: "read" | "write" | "admin" | "none"; + organization_permission?: 'read' | 'write' | 'admin' | 'none' /** @description Whether or not this project can be seen by everyone. Only present if owner is an organization. */ - private?: boolean; - } & { [key: string]: unknown }; + private?: boolean + } & { [key: string]: unknown } /** * GroupMapping * @description External Groups to be mapped to a team for membership */ - "group-mapping": { + 'group-mapping': { /** * @description Array of groups to be mapped to this team * @example [object Object],[object Object] @@ -10305,1014 +10293,1014 @@ export interface components { * @description The ID of the group * @example 111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa */ - group_id: string; + group_id: string /** * @description The name of the group * @example saml-azuread-test */ - group_name: string; + group_name: string /** * @description a description of the group * @example A group of Developers working on AzureAD SAML SSO */ - group_description: string; + group_description: string /** * @description synchronization status for this group mapping * @example unsynced */ - status?: string; + status?: string /** * @description the time of the last sync for this group-mapping * @example 2019-06-03 22:27:15:000 -700 */ - synced_at?: string | null; - } & { [key: string]: unknown })[]; - } & { [key: string]: unknown }; + synced_at?: string | null + } & { [key: string]: unknown })[] + } & { [key: string]: unknown } /** * Full Team * @description Groups of organization members that gives permissions on specified repositories. */ - "team-full": { + 'team-full': { /** * @description Unique identifier of the team * @example 42 */ - id: number; + id: number /** @example MDQ6VGVhbTE= */ - node_id: string; + node_id: string /** * Format: uri * @description URL for the team * @example https://api.github.com/organizations/1/team/1 */ - url: string; + url: string /** * Format: uri * @example https://github.com/orgs/rails/teams/core */ - html_url: string; + html_url: string /** * @description Name of the team * @example Developers */ - name: string; + name: string /** @example justice-league */ - slug: string; + slug: string /** @example A great team. */ - description: string | null; + description: string | null /** * @description The level of privacy this team should have * @example closed * @enum {string} */ - privacy?: "closed" | "secret"; + privacy?: 'closed' | 'secret' /** * @description Permission that the team will have for its repositories * @example push */ - permission: string; + permission: string /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - members_url: string; + members_url: string /** * Format: uri * @example https://api.github.com/organizations/1/team/1/repos */ - repositories_url: string; - parent?: components["schemas"]["nullable-team-simple"]; + repositories_url: string + parent?: components['schemas']['nullable-team-simple'] /** @example 3 */ - members_count: number; + members_count: number /** @example 10 */ - repos_count: number; + repos_count: number /** * Format: date-time * @example 2017-07-14T16:53:42Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2017-08-17T12:37:15Z */ - updated_at: string; - organization: components["schemas"]["organization-full"]; + updated_at: string + organization: components['schemas']['organization-full'] /** * @description Distinguished Name (DN) that team maps to within LDAP environment * @example uid=example,ou=users,dc=github,dc=com */ - ldap_dn?: string; - } & { [key: string]: unknown }; + ldap_dn?: string + } & { [key: string]: unknown } /** * Team Discussion * @description A team discussion is a persistent record of a free-form conversation within a team. */ - "team-discussion": { - author: components["schemas"]["nullable-simple-user"]; + 'team-discussion': { + author: components['schemas']['nullable-simple-user'] /** * @description The main text of the discussion. * @example Please suggest improvements to our workflow in comments. */ - body: string; + body: string /** @example

Hi! This is an area for us to collaborate as a team

*/ - body_html: string; + body_html: string /** * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server. * @example 0307116bbf7ced493b8d8a346c650b71 */ - body_version: string; - comments_count: number; + body_version: string + comments_count: number /** * Format: uri * @example https://api.github.com/organizations/1/team/2343027/discussions/1/comments */ - comments_url: string; + comments_url: string /** * Format: date-time * @example 2018-01-25T18:56:31Z */ - created_at: string; + created_at: string /** Format: date-time */ - last_edited_at: string | null; + last_edited_at: string | null /** * Format: uri * @example https://github.com/orgs/github/teams/justice-league/discussions/1 */ - html_url: string; + html_url: string /** @example MDE0OlRlYW1EaXNjdXNzaW9uMQ== */ - node_id: string; + node_id: string /** * @description The unique sequence number of a team discussion. * @example 42 */ - number: number; + number: number /** * @description Whether or not this discussion should be pinned for easy retrieval. * @example true */ - pinned: boolean; + pinned: boolean /** * @description Whether or not this discussion should be restricted to team members and organization administrators. * @example true */ - private: boolean; + private: boolean /** * Format: uri * @example https://api.github.com/organizations/1/team/2343027 */ - team_url: string; + team_url: string /** * @description The title of the discussion. * @example How can we improve our workflow? */ - title: string; + title: string /** * Format: date-time * @example 2018-01-25T18:56:31Z */ - updated_at: string; + updated_at: string /** * Format: uri * @example https://api.github.com/organizations/1/team/2343027/discussions/1 */ - url: string; - reactions?: components["schemas"]["reaction-rollup"]; - } & { [key: string]: unknown }; + url: string + reactions?: components['schemas']['reaction-rollup'] + } & { [key: string]: unknown } /** * Team Discussion Comment * @description A reply to a discussion within a team. */ - "team-discussion-comment": { - author: components["schemas"]["nullable-simple-user"]; + 'team-discussion-comment': { + author: components['schemas']['nullable-simple-user'] /** * @description The main text of the comment. * @example I agree with this suggestion. */ - body: string; + body: string /** @example

Do you like apples?

*/ - body_html: string; + body_html: string /** * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server. * @example 0307116bbf7ced493b8d8a346c650b71 */ - body_version: string; + body_version: string /** * Format: date-time * @example 2018-01-15T23:53:58Z */ - created_at: string; + created_at: string /** Format: date-time */ - last_edited_at: string | null; + last_edited_at: string | null /** * Format: uri * @example https://api.github.com/organizations/1/team/2403582/discussions/1 */ - discussion_url: string; + discussion_url: string /** * Format: uri * @example https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 */ - html_url: string; + html_url: string /** @example MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= */ - node_id: string; + node_id: string /** * @description The unique sequence number of a team discussion comment. * @example 42 */ - number: number; + number: number /** * Format: date-time * @example 2018-01-15T23:53:58Z */ - updated_at: string; + updated_at: string /** * Format: uri * @example https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 */ - url: string; - reactions?: components["schemas"]["reaction-rollup"]; - } & { [key: string]: unknown }; + url: string + reactions?: components['schemas']['reaction-rollup'] + } & { [key: string]: unknown } /** * Reaction * @description Reactions to conversations provide a way to help people express their feelings more simply and effectively. */ reaction: { /** @example 1 */ - id: number; + id: number /** @example MDg6UmVhY3Rpb24x */ - node_id: string; - user: components["schemas"]["nullable-simple-user"]; + node_id: string + user: components['schemas']['nullable-simple-user'] /** * @description The reaction to use * @example heart * @enum {string} */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' /** * Format: date-time * @example 2016-05-20T20:09:31Z */ - created_at: string; - } & { [key: string]: unknown }; + created_at: string + } & { [key: string]: unknown } /** * Team Membership * @description Team Membership */ - "team-membership": { + 'team-membership': { /** Format: uri */ - url: string; + url: string /** * @description The role of the user in the team. * @default member * @example member * @enum {string} */ - role: "member" | "maintainer"; + role: 'member' | 'maintainer' /** * @description The state of the user's membership in the team. * @enum {string} */ - state: "active" | "pending"; - } & { [key: string]: unknown }; + state: 'active' | 'pending' + } & { [key: string]: unknown } /** * Team Project * @description A team's access to a project. */ - "team-project": { - owner_url: string; - url: string; - html_url: string; - columns_url: string; - id: number; - node_id: string; - name: string; - body: string | null; - number: number; - state: string; - creator: components["schemas"]["simple-user"]; - created_at: string; - updated_at: string; + 'team-project': { + owner_url: string + url: string + html_url: string + columns_url: string + id: number + node_id: string + name: string + body: string | null + number: number + state: string + creator: components['schemas']['simple-user'] + created_at: string + updated_at: string /** @description The organization permission for this project. Only present when owner is an organization. */ - organization_permission?: string; + organization_permission?: string /** @description Whether the project is private or not. Only present when owner is an organization. */ - private?: boolean; + private?: boolean permissions: { - read: boolean; - write: boolean; - admin: boolean; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + read: boolean + write: boolean + admin: boolean + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** * Team Repository * @description A team's access to a repository. */ - "team-repository": { + 'team-repository': { /** * @description Unique identifier of the repository * @example 42 */ - id: number; + id: number /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - node_id: string; + node_id: string /** * @description The name of the repository. * @example Team Environment */ - name: string; + name: string /** @example octocat/Hello-World */ - full_name: string; - license: components["schemas"]["nullable-license-simple"]; - forks: number; + full_name: string + license: components['schemas']['nullable-license-simple'] + forks: number permissions?: { - admin: boolean; - pull: boolean; - triage?: boolean; - push: boolean; - maintain?: boolean; - } & { [key: string]: unknown }; + admin: boolean + pull: boolean + triage?: boolean + push: boolean + maintain?: boolean + } & { [key: string]: unknown } /** @example admin */ - role_name?: string; - owner: components["schemas"]["nullable-simple-user"]; + role_name?: string + owner: components['schemas']['nullable-simple-user'] /** @description Whether the repository is private or public. */ - private: boolean; + private: boolean /** * Format: uri * @example https://github.com/octocat/Hello-World */ - html_url: string; + html_url: string /** @example This your first repo! */ - description: string | null; - fork: boolean; + description: string | null + fork: boolean /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World */ - url: string; + url: string /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - archive_url: string; + archive_url: string /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - assignees_url: string; + assignees_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - blobs_url: string; + blobs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - branches_url: string; + branches_url: string /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - collaborators_url: string; + collaborators_url: string /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - comments_url: string; + comments_url: string /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - commits_url: string; + commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - compare_url: string; + compare_url: string /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - contents_url: string; + contents_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - contributors_url: string; + contributors_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - deployments_url: string; + deployments_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - downloads_url: string; + downloads_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events */ - events_url: string; + events_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ - forks_url: string; + forks_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - git_commits_url: string; + git_commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - git_refs_url: string; + git_refs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - git_tags_url: string; + git_tags_url: string /** @example git:github.com/octocat/Hello-World.git */ - git_url: string; + git_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - issue_comment_url: string; + issue_comment_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - issue_events_url: string; + issue_events_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - issues_url: string; + issues_url: string /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - keys_url: string; + keys_url: string /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - labels_url: string; + labels_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ - languages_url: string; + languages_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ - merges_url: string; + merges_url: string /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - milestones_url: string; + milestones_url: string /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - notifications_url: string; + notifications_url: string /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - pulls_url: string; + pulls_url: string /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - releases_url: string; + releases_url: string /** @example git@github.com:octocat/Hello-World.git */ - ssh_url: string; + ssh_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - stargazers_url: string; + stargazers_url: string /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - statuses_url: string; + statuses_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - subscribers_url: string; + subscribers_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - subscription_url: string; + subscription_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ - tags_url: string; + tags_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ - teams_url: string; + teams_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - trees_url: string; + trees_url: string /** @example https://github.com/octocat/Hello-World.git */ - clone_url: string; + clone_url: string /** * Format: uri * @example git:git.example.com/octocat/Hello-World */ - mirror_url: string | null; + mirror_url: string | null /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - hooks_url: string; + hooks_url: string /** * Format: uri * @example https://svn.github.com/octocat/Hello-World */ - svn_url: string; + svn_url: string /** * Format: uri * @example https://github.com */ - homepage: string | null; - language: string | null; + homepage: string | null + language: string | null /** @example 9 */ - forks_count: number; + forks_count: number /** @example 80 */ - stargazers_count: number; + stargazers_count: number /** @example 80 */ - watchers_count: number; + watchers_count: number /** @example 108 */ - size: number; + size: number /** * @description The default branch of the repository. * @example master */ - default_branch: string; - open_issues_count: number; + default_branch: string + open_issues_count: number /** * @description Whether this repository acts as a template that can be used to generate new repositories. * @example true */ - is_template?: boolean; - topics?: string[]; + is_template?: boolean + topics?: string[] /** * @description Whether issues are enabled. * @default true * @example true */ - has_issues: boolean; + has_issues: boolean /** * @description Whether projects are enabled. * @default true * @example true */ - has_projects: boolean; + has_projects: boolean /** * @description Whether the wiki is enabled. * @default true * @example true */ - has_wiki: boolean; - has_pages: boolean; + has_wiki: boolean + has_pages: boolean /** * @description Whether downloads are enabled. * @default true * @example true */ - has_downloads: boolean; + has_downloads: boolean /** @description Whether the repository is archived. */ - archived: boolean; + archived: boolean /** @description Returns whether or not this repository disabled. */ - disabled: boolean; + disabled: boolean /** * @description The repository visibility: public, private, or internal. * @default public */ - visibility?: string; + visibility?: string /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - pushed_at: string | null; + pushed_at: string | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - created_at: string | null; + created_at: string | null /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - updated_at: string | null; + updated_at: string | null /** * @description Whether to allow rebase merges for pull requests. * @default true * @example true */ - allow_rebase_merge?: boolean; - template_repository?: components["schemas"]["nullable-repository"]; - temp_clone_token?: string; + allow_rebase_merge?: boolean + template_repository?: components['schemas']['nullable-repository'] + temp_clone_token?: string /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - allow_squash_merge?: boolean; + allow_squash_merge?: boolean /** @description Whether to allow Auto-merge to be used on pull requests. */ - allow_auto_merge?: boolean; + allow_auto_merge?: boolean /** @description Whether to delete head branches when pull requests are merged */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge?: boolean /** * @description Whether to allow merge commits for pull requests. * @default true * @example true */ - allow_merge_commit?: boolean; + allow_merge_commit?: boolean /** @description Whether to allow forking this repo */ - allow_forking?: boolean; - subscribers_count?: number; - network_count?: number; - open_issues: number; - watchers: number; - master_branch?: string; - } & { [key: string]: unknown }; + allow_forking?: boolean + subscribers_count?: number + network_count?: number + open_issues: number + watchers: number + master_branch?: string + } & { [key: string]: unknown } /** * Project Card * @description Project cards represent a scope of work. */ - "project-card": { + 'project-card': { /** * Format: uri * @example https://api.github.com/projects/columns/cards/1478 */ - url: string; + url: string /** * @description The project card's ID * @example 42 */ - id: number; + id: number /** @example MDExOlByb2plY3RDYXJkMTQ3OA== */ - node_id: string; + node_id: string /** @example Add payload for delete Project column */ - note: string | null; - creator: components["schemas"]["nullable-simple-user"]; + note: string | null + creator: components['schemas']['nullable-simple-user'] /** * Format: date-time * @example 2016-09-05T14:21:06Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2016-09-05T14:20:22Z */ - updated_at: string; + updated_at: string /** @description Whether or not the card is archived */ - archived?: boolean; - column_name?: string; - project_id?: string; + archived?: boolean + column_name?: string + project_id?: string /** * Format: uri * @example https://api.github.com/projects/columns/367 */ - column_url: string; + column_url: string /** * Format: uri * @example https://api.github.com/repos/api-playground/projects-test/issues/3 */ - content_url?: string; + content_url?: string /** * Format: uri * @example https://api.github.com/projects/120 */ - project_url: string; - } & { [key: string]: unknown }; + project_url: string + } & { [key: string]: unknown } /** * Project Column * @description Project columns contain cards of work. */ - "project-column": { + 'project-column': { /** * Format: uri * @example https://api.github.com/projects/columns/367 */ - url: string; + url: string /** * Format: uri * @example https://api.github.com/projects/120 */ - project_url: string; + project_url: string /** * Format: uri * @example https://api.github.com/projects/columns/367/cards */ - cards_url: string; + cards_url: string /** * @description The unique identifier of the project column * @example 42 */ - id: number; + id: number /** @example MDEzOlByb2plY3RDb2x1bW4zNjc= */ - node_id: string; + node_id: string /** * @description Name of the project column * @example Remaining tasks */ - name: string; + name: string /** * Format: date-time * @example 2016-09-05T14:18:44Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2016-09-05T14:22:28Z */ - updated_at: string; - } & { [key: string]: unknown }; + updated_at: string + } & { [key: string]: unknown } /** * Project Collaborator Permission * @description Project Collaborator Permission */ - "project-collaborator-permission": { - permission: string; - user: components["schemas"]["nullable-simple-user"]; - } & { [key: string]: unknown }; + 'project-collaborator-permission': { + permission: string + user: components['schemas']['nullable-simple-user'] + } & { [key: string]: unknown } /** Rate Limit */ - "rate-limit": { - limit: number; - remaining: number; - reset: number; - used: number; - } & { [key: string]: unknown }; + 'rate-limit': { + limit: number + remaining: number + reset: number + used: number + } & { [key: string]: unknown } /** * Rate Limit Overview * @description Rate Limit Overview */ - "rate-limit-overview": { + 'rate-limit-overview': { resources: { - core: components["schemas"]["rate-limit"]; - graphql?: components["schemas"]["rate-limit"]; - search: components["schemas"]["rate-limit"]; - source_import?: components["schemas"]["rate-limit"]; - integration_manifest?: components["schemas"]["rate-limit"]; - code_scanning_upload?: components["schemas"]["rate-limit"]; - actions_runner_registration?: components["schemas"]["rate-limit"]; - scim?: components["schemas"]["rate-limit"]; - } & { [key: string]: unknown }; - rate: components["schemas"]["rate-limit"]; - } & { [key: string]: unknown }; + core: components['schemas']['rate-limit'] + graphql?: components['schemas']['rate-limit'] + search: components['schemas']['rate-limit'] + source_import?: components['schemas']['rate-limit'] + integration_manifest?: components['schemas']['rate-limit'] + code_scanning_upload?: components['schemas']['rate-limit'] + actions_runner_registration?: components['schemas']['rate-limit'] + scim?: components['schemas']['rate-limit'] + } & { [key: string]: unknown } + rate: components['schemas']['rate-limit'] + } & { [key: string]: unknown } /** * Code Of Conduct Simple * @description Code of Conduct Simple */ - "code-of-conduct-simple": { + 'code-of-conduct-simple': { /** * Format: uri * @example https://api.github.com/repos/github/docs/community/code_of_conduct */ - url: string; + url: string /** @example citizen_code_of_conduct */ - key: string; + key: string /** @example Citizen Code of Conduct */ - name: string; + name: string /** * Format: uri * @example https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md */ - html_url: string | null; - } & { [key: string]: unknown }; + html_url: string | null + } & { [key: string]: unknown } /** * Full Repository * @description Full Repository */ - "full-repository": { + 'full-repository': { /** @example 1296269 */ - id: number; + id: number /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - node_id: string; + node_id: string /** @example Hello-World */ - name: string; + name: string /** @example octocat/Hello-World */ - full_name: string; - owner: components["schemas"]["simple-user"]; - private: boolean; + full_name: string + owner: components['schemas']['simple-user'] + private: boolean /** * Format: uri * @example https://github.com/octocat/Hello-World */ - html_url: string; + html_url: string /** @example This your first repo! */ - description: string | null; - fork: boolean; + description: string | null + fork: boolean /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World */ - url: string; + url: string /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - archive_url: string; + archive_url: string /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - assignees_url: string; + assignees_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - blobs_url: string; + blobs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - branches_url: string; + branches_url: string /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - collaborators_url: string; + collaborators_url: string /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - comments_url: string; + comments_url: string /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - commits_url: string; + commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - compare_url: string; + compare_url: string /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - contents_url: string; + contents_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - contributors_url: string; + contributors_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - deployments_url: string; + deployments_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - downloads_url: string; + downloads_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events */ - events_url: string; + events_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ - forks_url: string; + forks_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - git_commits_url: string; + git_commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - git_refs_url: string; + git_refs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - git_tags_url: string; + git_tags_url: string /** @example git:github.com/octocat/Hello-World.git */ - git_url: string; + git_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - issue_comment_url: string; + issue_comment_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - issue_events_url: string; + issue_events_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - issues_url: string; + issues_url: string /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - keys_url: string; + keys_url: string /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - labels_url: string; + labels_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ - languages_url: string; + languages_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ - merges_url: string; + merges_url: string /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - milestones_url: string; + milestones_url: string /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - notifications_url: string; + notifications_url: string /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - pulls_url: string; + pulls_url: string /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - releases_url: string; + releases_url: string /** @example git@github.com:octocat/Hello-World.git */ - ssh_url: string; + ssh_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - stargazers_url: string; + stargazers_url: string /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - statuses_url: string; + statuses_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - subscribers_url: string; + subscribers_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - subscription_url: string; + subscription_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ - tags_url: string; + tags_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ - teams_url: string; + teams_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - trees_url: string; + trees_url: string /** @example https://github.com/octocat/Hello-World.git */ - clone_url: string; + clone_url: string /** * Format: uri * @example git:git.example.com/octocat/Hello-World */ - mirror_url: string | null; + mirror_url: string | null /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - hooks_url: string; + hooks_url: string /** * Format: uri * @example https://svn.github.com/octocat/Hello-World */ - svn_url: string; + svn_url: string /** * Format: uri * @example https://github.com */ - homepage: string | null; - language: string | null; + homepage: string | null + language: string | null /** @example 9 */ - forks_count: number; + forks_count: number /** @example 80 */ - stargazers_count: number; + stargazers_count: number /** @example 80 */ - watchers_count: number; + watchers_count: number /** @example 108 */ - size: number; + size: number /** @example master */ - default_branch: string; - open_issues_count: number; + default_branch: string + open_issues_count: number /** @example true */ - is_template?: boolean; + is_template?: boolean /** @example octocat,atom,electron,API */ - topics?: string[]; + topics?: string[] /** @example true */ - has_issues: boolean; + has_issues: boolean /** @example true */ - has_projects: boolean; + has_projects: boolean /** @example true */ - has_wiki: boolean; - has_pages: boolean; + has_wiki: boolean + has_pages: boolean /** @example true */ - has_downloads: boolean; - archived: boolean; + has_downloads: boolean + archived: boolean /** @description Returns whether or not this repository disabled. */ - disabled: boolean; + disabled: boolean /** * @description The repository visibility: public, private, or internal. * @example public */ - visibility?: string; + visibility?: string /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - pushed_at: string; + pushed_at: string /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - updated_at: string; + updated_at: string permissions?: { - admin: boolean; - maintain?: boolean; - push: boolean; - triage?: boolean; - pull: boolean; - } & { [key: string]: unknown }; + admin: boolean + maintain?: boolean + push: boolean + triage?: boolean + pull: boolean + } & { [key: string]: unknown } /** @example true */ - allow_rebase_merge?: boolean; - template_repository?: components["schemas"]["nullable-repository"]; - temp_clone_token?: string | null; + allow_rebase_merge?: boolean + template_repository?: components['schemas']['nullable-repository'] + temp_clone_token?: string | null /** @example true */ - allow_squash_merge?: boolean; - allow_auto_merge?: boolean; - delete_branch_on_merge?: boolean; + allow_squash_merge?: boolean + allow_auto_merge?: boolean + delete_branch_on_merge?: boolean /** @example true */ - allow_merge_commit?: boolean; + allow_merge_commit?: boolean /** @example true */ - allow_forking?: boolean; + allow_forking?: boolean /** @example 42 */ - subscribers_count: number; - network_count: number; - license: components["schemas"]["nullable-license-simple"]; - organization?: components["schemas"]["nullable-simple-user"]; - parent?: components["schemas"]["repository"]; - source?: components["schemas"]["repository"]; - forks: number; - master_branch?: string; - open_issues: number; - watchers: number; + subscribers_count: number + network_count: number + license: components['schemas']['nullable-license-simple'] + organization?: components['schemas']['nullable-simple-user'] + parent?: components['schemas']['repository'] + source?: components['schemas']['repository'] + forks: number + master_branch?: string + open_issues: number + watchers: number /** * @description Whether anonymous git access is allowed. * @default true */ - anonymous_access_enabled?: boolean; - code_of_conduct?: components["schemas"]["code-of-conduct-simple"]; + anonymous_access_enabled?: boolean + code_of_conduct?: components['schemas']['code-of-conduct-simple'] security_and_analysis?: | ({ advanced_security?: { /** @enum {string} */ - status?: "enabled" | "disabled"; - } & { [key: string]: unknown }; + status?: 'enabled' | 'disabled' + } & { [key: string]: unknown } secret_scanning?: { /** @enum {string} */ - status?: "enabled" | "disabled"; - } & { [key: string]: unknown }; + status?: 'enabled' | 'disabled' + } & { [key: string]: unknown } } & { [key: string]: unknown }) - | null; - } & { [key: string]: unknown }; + | null + } & { [key: string]: unknown } /** * Artifact * @description An artifact */ artifact: { /** @example 5 */ - id: number; + id: number /** @example MDEwOkNoZWNrU3VpdGU1 */ - node_id: string; + node_id: string /** * @description The name of the artifact. * @example AdventureWorks.Framework */ - name: string; + name: string /** * @description The size in bytes of the artifact. * @example 12345 */ - size_in_bytes: number; + size_in_bytes: number /** @example https://api.github.com/repos/github/hello-world/actions/artifacts/5 */ - url: string; + url: string /** @example https://api.github.com/repos/github/hello-world/actions/artifacts/5/zip */ - archive_download_url: string; + archive_download_url: string /** @description Whether or not the artifact has expired. */ - expired: boolean; + expired: boolean /** Format: date-time */ - created_at: string | null; + created_at: string | null /** Format: date-time */ - expires_at: string | null; + expires_at: string | null /** Format: date-time */ - updated_at: string | null; - } & { [key: string]: unknown }; + updated_at: string | null + } & { [key: string]: unknown } /** * Job * @description Information of a job execution in a workflow run @@ -11322,58 +11310,58 @@ export interface components { * @description The id of the job. * @example 21 */ - id: number; + id: number /** * @description The id of the associated workflow run. * @example 5 */ - run_id: number; + run_id: number /** @example https://api.github.com/repos/github/hello-world/actions/runs/5 */ - run_url: string; + run_url: string /** * @description Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run. * @example 1 */ - run_attempt?: number; + run_attempt?: number /** @example MDg6Q2hlY2tSdW40 */ - node_id: string; + node_id: string /** * @description The SHA of the commit that is being run. * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d */ - head_sha: string; + head_sha: string /** @example https://api.github.com/repos/github/hello-world/actions/jobs/21 */ - url: string; + url: string /** @example https://github.com/github/hello-world/runs/4 */ - html_url: string | null; + html_url: string | null /** * @description The phase of the lifecycle that the job is currently in. * @example queued * @enum {string} */ - status: "queued" | "in_progress" | "completed"; + status: 'queued' | 'in_progress' | 'completed' /** * @description The outcome of the job. * @example success */ - conclusion: string | null; + conclusion: string | null /** * Format: date-time * @description The time that the job started, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 */ - started_at: string; + started_at: string /** * Format: date-time * @description The time that the job finished, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 */ - completed_at: string | null; + completed_at: string | null /** * @description The name of the job. * @example test-coverage */ - name: string; + name: string /** @description Steps in this job. */ steps?: ({ /** @@ -11381,336 +11369,334 @@ export interface components { * @example queued * @enum {string} */ - status: "queued" | "in_progress" | "completed"; + status: 'queued' | 'in_progress' | 'completed' /** * @description The outcome of the job. * @example success */ - conclusion: string | null; + conclusion: string | null /** * @description The name of the job. * @example test-coverage */ - name: string; + name: string /** @example 1 */ - number: number; + number: number /** * Format: date-time * @description The time that the step started, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 */ - started_at?: string | null; + started_at?: string | null /** * Format: date-time * @description The time that the job finished, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 */ - completed_at?: string | null; - } & { [key: string]: unknown })[]; + completed_at?: string | null + } & { [key: string]: unknown })[] /** @example https://api.github.com/repos/github/hello-world/check-runs/4 */ - check_run_url: string; + check_run_url: string /** * @description Labels for the workflow job. Specified by the "runs_on" attribute in the action's workflow file. * @example self-hosted,foo,bar */ - labels: string[]; + labels: string[] /** * @description The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example 1 */ - runner_id: number | null; + runner_id: number | null /** * @description The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example my runner */ - runner_name: string | null; + runner_name: string | null /** * @description The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example 2 */ - runner_group_id: number | null; + runner_group_id: number | null /** * @description The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example my runner group */ - runner_group_name: string | null; - } & { [key: string]: unknown }; + runner_group_name: string | null + } & { [key: string]: unknown } /** @description Whether GitHub Actions is enabled on the repository. */ - "actions-enabled": boolean; - "actions-repository-permissions": { - enabled: components["schemas"]["actions-enabled"]; - allowed_actions?: components["schemas"]["allowed-actions"]; - selected_actions_url?: components["schemas"]["selected-actions-url"]; - } & { [key: string]: unknown }; + 'actions-enabled': boolean + 'actions-repository-permissions': { + enabled: components['schemas']['actions-enabled'] + allowed_actions?: components['schemas']['allowed-actions'] + selected_actions_url?: components['schemas']['selected-actions-url'] + } & { [key: string]: unknown } /** Pull Request Minimal */ - "pull-request-minimal": { - id: number; - number: number; - url: string; + 'pull-request-minimal': { + id: number + number: number + url: string head: { - ref: string; - sha: string; + ref: string + sha: string repo: { - id: number; - url: string; - name: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + id: number + url: string + name: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } base: { - ref: string; - sha: string; + ref: string + sha: string repo: { - id: number; - url: string; - name: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + id: number + url: string + name: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** * Simple Commit * @description Simple Commit */ - "nullable-simple-commit": + 'nullable-simple-commit': | ({ - id: string; - tree_id: string; - message: string; + id: string + tree_id: string + message: string /** Format: date-time */ - timestamp: string; + timestamp: string author: | ({ - name: string; - email: string; + name: string + email: string } & { [key: string]: unknown }) - | null; + | null committer: | ({ - name: string; - email: string; + name: string + email: string } & { [key: string]: unknown }) - | null; + | null } & { [key: string]: unknown }) - | null; + | null /** * Workflow Run * @description An invocation of a workflow */ - "workflow-run": { + 'workflow-run': { /** * @description The ID of the workflow run. * @example 5 */ - id: number; + id: number /** * @description The name of the workflow run. * @example Build */ - name?: string | null; + name?: string | null /** @example MDEwOkNoZWNrU3VpdGU1 */ - node_id: string; + node_id: string /** * @description The ID of the associated check suite. * @example 42 */ - check_suite_id?: number; + check_suite_id?: number /** * @description The node ID of the associated check suite. * @example MDEwOkNoZWNrU3VpdGU0Mg== */ - check_suite_node_id?: string; + check_suite_node_id?: string /** @example master */ - head_branch: string | null; + head_branch: string | null /** * @description The SHA of the head commit that points to the version of the worflow being run. * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d */ - head_sha: string; + head_sha: string /** * @description The auto incrementing run number for the workflow run. * @example 106 */ - run_number: number; + run_number: number /** * @description Attempt number of the run, 1 for first attempt and higher if the workflow was re-run. * @example 1 */ - run_attempt?: number; + run_attempt?: number /** @example push */ - event: string; + event: string /** @example completed */ - status: string | null; + status: string | null /** @example neutral */ - conclusion: string | null; + conclusion: string | null /** * @description The ID of the parent workflow. * @example 5 */ - workflow_id: number; + workflow_id: number /** * @description The URL to the workflow run. * @example https://api.github.com/repos/github/hello-world/actions/runs/5 */ - url: string; + url: string /** @example https://github.com/github/hello-world/suites/4 */ - html_url: string; - pull_requests: components["schemas"]["pull-request-minimal"][] | null; + html_url: string + pull_requests: components['schemas']['pull-request-minimal'][] | null /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; + updated_at: string /** * Format: date-time * @description The start time of the latest run. Resets on re-run. */ - run_started_at?: string; + run_started_at?: string /** * @description The URL to the jobs for the workflow run. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/jobs */ - jobs_url: string; + jobs_url: string /** * @description The URL to download the logs for the workflow run. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/logs */ - logs_url: string; + logs_url: string /** * @description The URL to the associated check suite. * @example https://api.github.com/repos/github/hello-world/check-suites/12 */ - check_suite_url: string; + check_suite_url: string /** * @description The URL to the artifacts for the workflow run. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts */ - artifacts_url: string; + artifacts_url: string /** * @description The URL to cancel the workflow run. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/cancel */ - cancel_url: string; + cancel_url: string /** * @description The URL to rerun the workflow run. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/rerun */ - rerun_url: string; + rerun_url: string /** * @description The URL to the previous attempted run of this workflow, if one exists. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3 */ - previous_attempt_url?: string | null; + previous_attempt_url?: string | null /** * @description The URL to the workflow. * @example https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml */ - workflow_url: string; - head_commit: components["schemas"]["nullable-simple-commit"]; - repository: components["schemas"]["minimal-repository"]; - head_repository: components["schemas"]["minimal-repository"]; + workflow_url: string + head_commit: components['schemas']['nullable-simple-commit'] + repository: components['schemas']['minimal-repository'] + head_repository: components['schemas']['minimal-repository'] /** @example 5 */ - head_repository_id?: number; - } & { [key: string]: unknown }; + head_repository_id?: number + } & { [key: string]: unknown } /** * Environment Approval * @description An entry in the reviews log for environment deployments */ - "environment-approvals": { + 'environment-approvals': { /** @description The list of environments that were approved or rejected */ environments: ({ /** * @description The id of the environment. * @example 56780428 */ - id?: number; + id?: number /** @example MDExOkVudmlyb25tZW50NTY3ODA0Mjg= */ - node_id?: string; + node_id?: string /** * @description The name of the environment. * @example staging */ - name?: string; + name?: string /** @example https://api.github.com/repos/github/hello-world/environments/staging */ - url?: string; + url?: string /** @example https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging */ - html_url?: string; + html_url?: string /** * Format: date-time * @description The time that the environment was created, in ISO 8601 format. * @example 2020-11-23T22:00:40Z */ - created_at?: string; + created_at?: string /** * Format: date-time * @description The time that the environment was last updated, in ISO 8601 format. * @example 2020-11-23T22:00:40Z */ - updated_at?: string; - } & { [key: string]: unknown })[]; + updated_at?: string + } & { [key: string]: unknown })[] /** * @description Whether deployment to the environment(s) was approved or rejected * @example approved * @enum {string} */ - state: "approved" | "rejected"; - user: components["schemas"]["simple-user"]; + state: 'approved' | 'rejected' + user: components['schemas']['simple-user'] /** * @description The comment submitted with the deployment review * @example Ship it! */ - comment: string; - } & { [key: string]: unknown }; + comment: string + } & { [key: string]: unknown } /** * @description The type of reviewer. Must be one of: `User` or `Team` * @example User * @enum {string} */ - "deployment-reviewer-type": "User" | "Team"; + 'deployment-reviewer-type': 'User' | 'Team' /** * Pending Deployment * @description Details of a deployment that is waiting for protection rules to pass */ - "pending-deployment": { + 'pending-deployment': { environment: { /** * @description The id of the environment. * @example 56780428 */ - id?: number; + id?: number /** @example MDExOkVudmlyb25tZW50NTY3ODA0Mjg= */ - node_id?: string; + node_id?: string /** * @description The name of the environment. * @example staging */ - name?: string; + name?: string /** @example https://api.github.com/repos/github/hello-world/environments/staging */ - url?: string; + url?: string /** @example https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging */ - html_url?: string; - } & { [key: string]: unknown }; + html_url?: string + } & { [key: string]: unknown } /** * @description The set duration of the wait timer * @example 30 */ - wait_timer: number; + wait_timer: number /** * Format: date-time * @description The time that the wait timer began. * @example 2020-11-23T22:00:40Z */ - wait_timer_started_at: string | null; + wait_timer_started_at: string | null /** * @description Whether the currently authenticated user can approve the deployment * @example true */ - current_user_can_approve: boolean; + current_user_can_approve: boolean /** @description The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */ reviewers: ({ - type?: components["schemas"]["deployment-reviewer-type"]; - reviewer?: (Partial & Partial) & { - [key: string]: unknown; - }; - } & { [key: string]: unknown })[]; - } & { [key: string]: unknown }; + type?: components['schemas']['deployment-reviewer-type'] + reviewer?: (Partial & Partial) & { [key: string]: unknown } + } & { [key: string]: unknown })[] + } & { [key: string]: unknown } /** * Deployment * @description A request for a specific ref(branch,sha,tag) to be deployed @@ -11720,473 +11706,473 @@ export interface components { * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1 */ - url: string; + url: string /** * @description Unique identifier of the deployment * @example 42 */ - id: number; + id: number /** @example MDEwOkRlcGxveW1lbnQx */ - node_id: string; + node_id: string /** @example a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d */ - sha: string; + sha: string /** * @description The ref to deploy. This can be a branch, tag, or sha. * @example topic-branch */ - ref: string; + ref: string /** * @description Parameter to specify a task to execute * @example deploy */ - task: string; - payload: ({ [key: string]: unknown } | string) & { [key: string]: unknown }; + task: string + payload: ({ [key: string]: unknown } | string) & { [key: string]: unknown } /** @example staging */ - original_environment?: string; + original_environment?: string /** * @description Name for the target deployment environment. * @example production */ - environment: string; + environment: string /** @example Deploy request from hubot */ - description: string | null; - creator: components["schemas"]["nullable-simple-user"]; + description: string | null + creator: components['schemas']['nullable-simple-user'] /** * Format: date-time * @example 2012-07-20T01:19:13Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2012-07-20T01:19:13Z */ - updated_at: string; + updated_at: string /** * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1/statuses */ - statuses_url: string; + statuses_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/example */ - repository_url: string; + repository_url: string /** * @description Specifies if the given environment is will no longer exist at some point in the future. Default: false. * @example true */ - transient_environment?: boolean; + transient_environment?: boolean /** * @description Specifies if the given environment is one that end-users directly interact with. Default: false. * @example true */ - production_environment?: boolean; - performed_via_github_app?: components["schemas"]["nullable-integration"]; - } & { [key: string]: unknown }; + production_environment?: boolean + performed_via_github_app?: components['schemas']['nullable-integration'] + } & { [key: string]: unknown } /** * Workflow Run Usage * @description Workflow Run Usage */ - "workflow-run-usage": { + 'workflow-run-usage': { billable: { UBUNTU?: { - total_ms: number; - jobs: number; + total_ms: number + jobs: number job_runs?: ({ - job_id: number; - duration_ms: number; - } & { [key: string]: unknown })[]; - } & { [key: string]: unknown }; + job_id: number + duration_ms: number + } & { [key: string]: unknown })[] + } & { [key: string]: unknown } MACOS?: { - total_ms: number; - jobs: number; + total_ms: number + jobs: number job_runs?: ({ - job_id: number; - duration_ms: number; - } & { [key: string]: unknown })[]; - } & { [key: string]: unknown }; + job_id: number + duration_ms: number + } & { [key: string]: unknown })[] + } & { [key: string]: unknown } WINDOWS?: { - total_ms: number; - jobs: number; + total_ms: number + jobs: number job_runs?: ({ - job_id: number; - duration_ms: number; - } & { [key: string]: unknown })[]; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; - run_duration_ms?: number; - } & { [key: string]: unknown }; + job_id: number + duration_ms: number + } & { [key: string]: unknown })[] + } & { [key: string]: unknown } + } & { [key: string]: unknown } + run_duration_ms?: number + } & { [key: string]: unknown } /** * Actions Secret * @description Set secrets for GitHub Actions. */ - "actions-secret": { + 'actions-secret': { /** * @description The name of the secret. * @example SECRET_TOKEN */ - name: string; + name: string /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - } & { [key: string]: unknown }; + updated_at: string + } & { [key: string]: unknown } /** * Workflow * @description A GitHub Actions workflow */ workflow: { /** @example 5 */ - id: number; + id: number /** @example MDg6V29ya2Zsb3cxMg== */ - node_id: string; + node_id: string /** @example CI */ - name: string; + name: string /** @example ruby.yaml */ - path: string; + path: string /** * @example active * @enum {string} */ - state: "active" | "deleted" | "disabled_fork" | "disabled_inactivity" | "disabled_manually"; + state: 'active' | 'deleted' | 'disabled_fork' | 'disabled_inactivity' | 'disabled_manually' /** * Format: date-time * @example 2019-12-06T14:20:20.000Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2019-12-06T14:20:20.000Z */ - updated_at: string; + updated_at: string /** @example https://api.github.com/repos/actions/setup-ruby/workflows/5 */ - url: string; + url: string /** @example https://github.com/actions/setup-ruby/blob/master/.github/workflows/ruby.yaml */ - html_url: string; + html_url: string /** @example https://github.com/actions/setup-ruby/workflows/CI/badge.svg */ - badge_url: string; + badge_url: string /** * Format: date-time * @example 2019-12-06T14:20:20.000Z */ - deleted_at?: string; - } & { [key: string]: unknown }; + deleted_at?: string + } & { [key: string]: unknown } /** * Workflow Usage * @description Workflow Usage */ - "workflow-usage": { + 'workflow-usage': { billable: { UBUNTU?: { - total_ms?: number; - } & { [key: string]: unknown }; + total_ms?: number + } & { [key: string]: unknown } MACOS?: { - total_ms?: number; - } & { [key: string]: unknown }; + total_ms?: number + } & { [key: string]: unknown } WINDOWS?: { - total_ms?: number; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + total_ms?: number + } & { [key: string]: unknown } + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** * Autolink reference * @description An autolink reference. */ autolink: { /** @example 3 */ - id: number; + id: number /** * @description The prefix of a key that is linkified. * @example TICKET- */ - key_prefix: string; + key_prefix: string /** * @description A template for the target URL that is generated if a key was found. * @example https://example.com/TICKET?query= */ - url_template: string; - } & { [key: string]: unknown }; + url_template: string + } & { [key: string]: unknown } /** * Protected Branch Required Status Check * @description Protected Branch Required Status Check */ - "protected-branch-required-status-check": { - url?: string; - enforcement_level?: string; - contexts: string[]; + 'protected-branch-required-status-check': { + url?: string + enforcement_level?: string + contexts: string[] checks: ({ - context: string; - app_id: number | null; - } & { [key: string]: unknown })[]; - contexts_url?: string; - strict?: boolean; - } & { [key: string]: unknown }; + context: string + app_id: number | null + } & { [key: string]: unknown })[] + contexts_url?: string + strict?: boolean + } & { [key: string]: unknown } /** * Protected Branch Admin Enforced * @description Protected Branch Admin Enforced */ - "protected-branch-admin-enforced": { + 'protected-branch-admin-enforced': { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins */ - url: string; + url: string /** @example true */ - enabled: boolean; - } & { [key: string]: unknown }; + enabled: boolean + } & { [key: string]: unknown } /** * Protected Branch Pull Request Review * @description Protected Branch Pull Request Review */ - "protected-branch-pull-request-review": { + 'protected-branch-pull-request-review': { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions */ - url?: string; + url?: string dismissal_restrictions?: { /** @description The list of users with review dismissal access. */ - users?: components["schemas"]["simple-user"][]; + users?: components['schemas']['simple-user'][] /** @description The list of teams with review dismissal access. */ - teams?: components["schemas"]["team"][]; + teams?: components['schemas']['team'][] /** @example "https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions" */ - url?: string; + url?: string /** @example "https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users" */ - users_url?: string; + users_url?: string /** @example "https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams" */ - teams_url?: string; - } & { [key: string]: unknown }; + teams_url?: string + } & { [key: string]: unknown } /** @description Allow specific users or teams to bypass pull request requirements. Set to `null` to disable. */ bypass_pull_request_allowances?: | ({ /** @description The list of users allowed to bypass pull request requirements. */ - users?: components["schemas"]["simple-user"][]; + users?: components['schemas']['simple-user'][] /** @description The list of teams allowed to bypass pull request requirements. */ - teams?: components["schemas"]["team"][]; + teams?: components['schemas']['team'][] } & { [key: string]: unknown }) - | null; + | null /** @example true */ - dismiss_stale_reviews: boolean; + dismiss_stale_reviews: boolean /** @example true */ - require_code_owner_reviews: boolean; + require_code_owner_reviews: boolean /** @example 2 */ - required_approving_review_count?: number; - } & { [key: string]: unknown }; + required_approving_review_count?: number + } & { [key: string]: unknown } /** * Branch Restriction Policy * @description Branch Restriction Policy */ - "branch-restriction-policy": { + 'branch-restriction-policy': { /** Format: uri */ - url: string; + url: string /** Format: uri */ - users_url: string; + users_url: string /** Format: uri */ - teams_url: string; + teams_url: string /** Format: uri */ - apps_url: string; + apps_url: string users: ({ - login?: string; - id?: number; - node_id?: string; - avatar_url?: string; - gravatar_id?: string; - url?: string; - html_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - starred_url?: string; - subscriptions_url?: string; - organizations_url?: string; - repos_url?: string; - events_url?: string; - received_events_url?: string; - type?: string; - site_admin?: boolean; - } & { [key: string]: unknown })[]; + login?: string + id?: number + node_id?: string + avatar_url?: string + gravatar_id?: string + url?: string + html_url?: string + followers_url?: string + following_url?: string + gists_url?: string + starred_url?: string + subscriptions_url?: string + organizations_url?: string + repos_url?: string + events_url?: string + received_events_url?: string + type?: string + site_admin?: boolean + } & { [key: string]: unknown })[] teams: ({ - id?: number; - node_id?: string; - url?: string; - html_url?: string; - name?: string; - slug?: string; - description?: string | null; - privacy?: string; - permission?: string; - members_url?: string; - repositories_url?: string; - parent?: string | null; - } & { [key: string]: unknown })[]; + id?: number + node_id?: string + url?: string + html_url?: string + name?: string + slug?: string + description?: string | null + privacy?: string + permission?: string + members_url?: string + repositories_url?: string + parent?: string | null + } & { [key: string]: unknown })[] apps: ({ - id?: number; - slug?: string; - node_id?: string; + id?: number + slug?: string + node_id?: string owner?: { - login?: string; - id?: number; - node_id?: string; - url?: string; - repos_url?: string; - events_url?: string; - hooks_url?: string; - issues_url?: string; - members_url?: string; - public_members_url?: string; - avatar_url?: string; - description?: string; + login?: string + id?: number + node_id?: string + url?: string + repos_url?: string + events_url?: string + hooks_url?: string + issues_url?: string + members_url?: string + public_members_url?: string + avatar_url?: string + description?: string /** @example "" */ - gravatar_id?: string; + gravatar_id?: string /** @example "https://github.com/testorg-ea8ec76d71c3af4b" */ - html_url?: string; + html_url?: string /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers" */ - followers_url?: string; + followers_url?: string /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}" */ - following_url?: string; + following_url?: string /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}" */ - gists_url?: string; + gists_url?: string /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}" */ - starred_url?: string; + starred_url?: string /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions" */ - subscriptions_url?: string; + subscriptions_url?: string /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs" */ - organizations_url?: string; + organizations_url?: string /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events" */ - received_events_url?: string; + received_events_url?: string /** @example "Organization" */ - type?: string; - site_admin?: boolean; - } & { [key: string]: unknown }; - name?: string; - description?: string; - external_url?: string; - html_url?: string; - created_at?: string; - updated_at?: string; + type?: string + site_admin?: boolean + } & { [key: string]: unknown } + name?: string + description?: string + external_url?: string + html_url?: string + created_at?: string + updated_at?: string permissions?: { - metadata?: string; - contents?: string; - issues?: string; - single_file?: string; - } & { [key: string]: unknown }; - events?: string[]; - } & { [key: string]: unknown })[]; - } & { [key: string]: unknown }; + metadata?: string + contents?: string + issues?: string + single_file?: string + } & { [key: string]: unknown } + events?: string[] + } & { [key: string]: unknown })[] + } & { [key: string]: unknown } /** * Branch Protection * @description Branch Protection */ - "branch-protection": { - url?: string; - enabled?: boolean; - required_status_checks?: components["schemas"]["protected-branch-required-status-check"]; - enforce_admins?: components["schemas"]["protected-branch-admin-enforced"]; - required_pull_request_reviews?: components["schemas"]["protected-branch-pull-request-review"]; - restrictions?: components["schemas"]["branch-restriction-policy"]; + 'branch-protection': { + url?: string + enabled?: boolean + required_status_checks?: components['schemas']['protected-branch-required-status-check'] + enforce_admins?: components['schemas']['protected-branch-admin-enforced'] + required_pull_request_reviews?: components['schemas']['protected-branch-pull-request-review'] + restrictions?: components['schemas']['branch-restriction-policy'] required_linear_history?: { - enabled?: boolean; - } & { [key: string]: unknown }; + enabled?: boolean + } & { [key: string]: unknown } allow_force_pushes?: { - enabled?: boolean; - } & { [key: string]: unknown }; + enabled?: boolean + } & { [key: string]: unknown } allow_deletions?: { - enabled?: boolean; - } & { [key: string]: unknown }; + enabled?: boolean + } & { [key: string]: unknown } required_conversation_resolution?: { - enabled?: boolean; - } & { [key: string]: unknown }; + enabled?: boolean + } & { [key: string]: unknown } /** @example "branch/with/protection" */ - name?: string; + name?: string /** @example "https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection" */ - protection_url?: string; + protection_url?: string required_signatures?: { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures */ - url: string; + url: string /** @example true */ - enabled: boolean; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + enabled: boolean + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** * Short Branch * @description Short Branch */ - "short-branch": { - name: string; + 'short-branch': { + name: string commit: { - sha: string; + sha: string /** Format: uri */ - url: string; - } & { [key: string]: unknown }; - protected: boolean; - protection?: components["schemas"]["branch-protection"]; + url: string + } & { [key: string]: unknown } + protected: boolean + protection?: components['schemas']['branch-protection'] /** Format: uri */ - protection_url?: string; - } & { [key: string]: unknown }; + protection_url?: string + } & { [key: string]: unknown } /** * Git User * @description Metaproperties for Git author/committer information. */ - "nullable-git-user": + 'nullable-git-user': | ({ /** @example "Chris Wanstrath" */ - name?: string; + name?: string /** @example "chris@ozmm.org" */ - email?: string; + email?: string /** @example "2007-10-29T02:42:39.000-07:00" */ - date?: string; + date?: string } & { [key: string]: unknown }) - | null; + | null /** Verification */ verification: { - verified: boolean; - reason: string; - payload: string | null; - signature: string | null; - } & { [key: string]: unknown }; + verified: boolean + reason: string + payload: string | null + signature: string | null + } & { [key: string]: unknown } /** * Diff Entry * @description Diff Entry */ - "diff-entry": { + 'diff-entry': { /** @example bbcd538c8e72b8c175046e27cc8f907076331401 */ - sha: string; + sha: string /** @example file1.txt */ - filename: string; + filename: string /** * @example added * @enum {string} */ - status: "added" | "removed" | "modified" | "renamed" | "copied" | "changed" | "unchanged"; + status: 'added' | 'removed' | 'modified' | 'renamed' | 'copied' | 'changed' | 'unchanged' /** @example 103 */ - additions: number; + additions: number /** @example 21 */ - deletions: number; + deletions: number /** @example 124 */ - changes: number; + changes: number /** * Format: uri * @example https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt */ - blob_url: string; + blob_url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt */ - raw_url: string; + raw_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e */ - contents_url: string; + contents_url: string /** @example @@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test */ - patch?: string; + patch?: string /** @example file.txt */ - previous_filename?: string; - } & { [key: string]: unknown }; + previous_filename?: string + } & { [key: string]: unknown } /** * Commit * @description Commit @@ -12196,1671 +12182,1667 @@ export interface components { * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e */ - url: string; + url: string /** @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */ - sha: string; + sha: string /** @example MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== */ - node_id: string; + node_id: string /** * Format: uri * @example https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments */ - comments_url: string; + comments_url: string commit: { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e */ - url: string; - author: components["schemas"]["nullable-git-user"]; - committer: components["schemas"]["nullable-git-user"]; + url: string + author: components['schemas']['nullable-git-user'] + committer: components['schemas']['nullable-git-user'] /** @example Fix all the bugs */ - message: string; - comment_count: number; + message: string + comment_count: number tree: { /** @example 827efc6d56897b048c772eb4087f854f46256132 */ - sha: string; + sha: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132 */ - url: string; - } & { [key: string]: unknown }; - verification?: components["schemas"]["verification"]; - } & { [key: string]: unknown }; - author: components["schemas"]["nullable-simple-user"]; - committer: components["schemas"]["nullable-simple-user"]; + url: string + } & { [key: string]: unknown } + verification?: components['schemas']['verification'] + } & { [key: string]: unknown } + author: components['schemas']['nullable-simple-user'] + committer: components['schemas']['nullable-simple-user'] parents: ({ /** @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - sha: string; + sha: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd */ - url: string; + url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd */ - html_url?: string; - } & { [key: string]: unknown })[]; + html_url?: string + } & { [key: string]: unknown })[] stats?: { - additions?: number; - deletions?: number; - total?: number; - } & { [key: string]: unknown }; - files?: components["schemas"]["diff-entry"][]; - } & { [key: string]: unknown }; + additions?: number + deletions?: number + total?: number + } & { [key: string]: unknown } + files?: components['schemas']['diff-entry'][] + } & { [key: string]: unknown } /** * Branch With Protection * @description Branch With Protection */ - "branch-with-protection": { - name: string; - commit: components["schemas"]["commit"]; + 'branch-with-protection': { + name: string + commit: components['schemas']['commit'] _links: { - html: string; + html: string /** Format: uri */ - self: string; - } & { [key: string]: unknown }; - protected: boolean; - protection: components["schemas"]["branch-protection"]; + self: string + } & { [key: string]: unknown } + protected: boolean + protection: components['schemas']['branch-protection'] /** Format: uri */ - protection_url: string; + protection_url: string /** @example "mas*" */ - pattern?: string; + pattern?: string /** @example 1 */ - required_approving_review_count?: number; - } & { [key: string]: unknown }; + required_approving_review_count?: number + } & { [key: string]: unknown } /** * Status Check Policy * @description Status Check Policy */ - "status-check-policy": { + 'status-check-policy': { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks */ - url: string; + url: string /** @example true */ - strict: boolean; + strict: boolean /** @example continuous-integration/travis-ci */ - contexts: string[]; + contexts: string[] checks: ({ /** @example continuous-integration/travis-ci */ - context: string; - app_id: number | null; - } & { [key: string]: unknown })[]; + context: string + app_id: number | null + } & { [key: string]: unknown })[] /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts */ - contexts_url: string; - } & { [key: string]: unknown }; + contexts_url: string + } & { [key: string]: unknown } /** * Protected Branch * @description Branch protections protect branches */ - "protected-branch": { + 'protected-branch': { /** Format: uri */ - url: string; - required_status_checks?: components["schemas"]["status-check-policy"]; + url: string + required_status_checks?: components['schemas']['status-check-policy'] required_pull_request_reviews?: { /** Format: uri */ - url: string; - dismiss_stale_reviews?: boolean; - require_code_owner_reviews?: boolean; - required_approving_review_count?: number; + url: string + dismiss_stale_reviews?: boolean + require_code_owner_reviews?: boolean + required_approving_review_count?: number dismissal_restrictions?: { /** Format: uri */ - url: string; + url: string /** Format: uri */ - users_url: string; + users_url: string /** Format: uri */ - teams_url: string; - users: components["schemas"]["simple-user"][]; - teams: components["schemas"]["team"][]; - } & { [key: string]: unknown }; + teams_url: string + users: components['schemas']['simple-user'][] + teams: components['schemas']['team'][] + } & { [key: string]: unknown } bypass_pull_request_allowances?: { - users: components["schemas"]["simple-user"][]; - teams: components["schemas"]["team"][]; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + users: components['schemas']['simple-user'][] + teams: components['schemas']['team'][] + } & { [key: string]: unknown } + } & { [key: string]: unknown } required_signatures?: { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures */ - url: string; + url: string /** @example true */ - enabled: boolean; - } & { [key: string]: unknown }; + enabled: boolean + } & { [key: string]: unknown } enforce_admins?: { /** Format: uri */ - url: string; - enabled: boolean; - }; + url: string + enabled: boolean + } required_linear_history?: { - enabled: boolean; - }; + enabled: boolean + } allow_force_pushes?: { - enabled: boolean; - }; + enabled: boolean + } allow_deletions?: { - enabled: boolean; - }; - restrictions?: components["schemas"]["branch-restriction-policy"]; + enabled: boolean + } + restrictions?: components['schemas']['branch-restriction-policy'] required_conversation_resolution?: { - enabled?: boolean; - }; - } & { [key: string]: unknown }; + enabled?: boolean + } + } & { [key: string]: unknown } /** * Deployment * @description A deployment created as the result of an Actions check run from a workflow that references an environment */ - "deployment-simple": { + 'deployment-simple': { /** * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1 */ - url: string; + url: string /** * @description Unique identifier of the deployment * @example 42 */ - id: number; + id: number /** @example MDEwOkRlcGxveW1lbnQx */ - node_id: string; + node_id: string /** * @description Parameter to specify a task to execute * @example deploy */ - task: string; + task: string /** @example staging */ - original_environment?: string; + original_environment?: string /** * @description Name for the target deployment environment. * @example production */ - environment: string; + environment: string /** @example Deploy request from hubot */ - description: string | null; + description: string | null /** * Format: date-time * @example 2012-07-20T01:19:13Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2012-07-20T01:19:13Z */ - updated_at: string; + updated_at: string /** * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1/statuses */ - statuses_url: string; + statuses_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/example */ - repository_url: string; + repository_url: string /** * @description Specifies if the given environment is will no longer exist at some point in the future. Default: false. * @example true */ - transient_environment?: boolean; + transient_environment?: boolean /** * @description Specifies if the given environment is one that end-users directly interact with. Default: false. * @example true */ - production_environment?: boolean; - performed_via_github_app?: components["schemas"]["nullable-integration"]; - } & { [key: string]: unknown }; + production_environment?: boolean + performed_via_github_app?: components['schemas']['nullable-integration'] + } & { [key: string]: unknown } /** * CheckRun * @description A check performed on the code of a given code change */ - "check-run": { + 'check-run': { /** * @description The id of the check. * @example 21 */ - id: number; + id: number /** * @description The SHA of the commit that is being checked. * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d */ - head_sha: string; + head_sha: string /** @example MDg6Q2hlY2tSdW40 */ - node_id: string; + node_id: string /** @example 42 */ - external_id: string | null; + external_id: string | null /** @example https://api.github.com/repos/github/hello-world/check-runs/4 */ - url: string; + url: string /** @example https://github.com/github/hello-world/runs/4 */ - html_url: string | null; + html_url: string | null /** @example https://example.com */ - details_url: string | null; + details_url: string | null /** * @description The phase of the lifecycle that the check is currently in. * @example queued * @enum {string} */ - status: "queued" | "in_progress" | "completed"; + status: 'queued' | 'in_progress' | 'completed' /** * @example neutral * @enum {string|null} */ - conclusion: - | ("success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required") - | null; + conclusion: ('success' | 'failure' | 'neutral' | 'cancelled' | 'skipped' | 'timed_out' | 'action_required') | null /** * Format: date-time * @example 2018-05-04T01:14:52Z */ - started_at: string | null; + started_at: string | null /** * Format: date-time * @example 2018-05-04T01:14:52Z */ - completed_at: string | null; + completed_at: string | null output: { - title: string | null; - summary: string | null; - text: string | null; - annotations_count: number; + title: string | null + summary: string | null + text: string | null + annotations_count: number /** Format: uri */ - annotations_url: string; - } & { [key: string]: unknown }; + annotations_url: string + } & { [key: string]: unknown } /** * @description The name of the check. * @example test-coverage */ - name: string; + name: string check_suite: | ({ - id: number; + id: number } & { [key: string]: unknown }) - | null; - app: components["schemas"]["nullable-integration"]; - pull_requests: components["schemas"]["pull-request-minimal"][]; - deployment?: components["schemas"]["deployment-simple"]; - } & { [key: string]: unknown }; + | null + app: components['schemas']['nullable-integration'] + pull_requests: components['schemas']['pull-request-minimal'][] + deployment?: components['schemas']['deployment-simple'] + } & { [key: string]: unknown } /** * Check Annotation * @description Check Annotation */ - "check-annotation": { + 'check-annotation': { /** @example README.md */ - path: string; + path: string /** @example 2 */ - start_line: number; + start_line: number /** @example 2 */ - end_line: number; + end_line: number /** @example 5 */ - start_column: number | null; + start_column: number | null /** @example 10 */ - end_column: number | null; + end_column: number | null /** @example warning */ - annotation_level: string | null; + annotation_level: string | null /** @example Spell Checker */ - title: string | null; + title: string | null /** @example Check your spelling for 'banaas'. */ - message: string | null; + message: string | null /** @example Do you mean 'bananas' or 'banana'? */ - raw_details: string | null; - blob_href: string; - } & { [key: string]: unknown }; + raw_details: string | null + blob_href: string + } & { [key: string]: unknown } /** * Simple Commit * @description Simple Commit */ - "simple-commit": { - id: string; - tree_id: string; - message: string; + 'simple-commit': { + id: string + tree_id: string + message: string /** Format: date-time */ - timestamp: string; + timestamp: string author: | ({ - name: string; - email: string; + name: string + email: string } & { [key: string]: unknown }) - | null; + | null committer: | ({ - name: string; - email: string; + name: string + email: string } & { [key: string]: unknown }) - | null; - } & { [key: string]: unknown }; + | null + } & { [key: string]: unknown } /** * CheckSuite * @description A suite of checks performed on the code of a given code change */ - "check-suite": { + 'check-suite': { /** @example 5 */ - id: number; + id: number /** @example MDEwOkNoZWNrU3VpdGU1 */ - node_id: string; + node_id: string /** @example master */ - head_branch: string | null; + head_branch: string | null /** * @description The SHA of the head commit that is being checked. * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d */ - head_sha: string; + head_sha: string /** * @example completed * @enum {string|null} */ - status: ("queued" | "in_progress" | "completed") | null; + status: ('queued' | 'in_progress' | 'completed') | null /** * @example neutral * @enum {string|null} */ - conclusion: - | ("success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required") - | null; + conclusion: ('success' | 'failure' | 'neutral' | 'cancelled' | 'skipped' | 'timed_out' | 'action_required') | null /** @example https://api.github.com/repos/github/hello-world/check-suites/5 */ - url: string | null; + url: string | null /** @example 146e867f55c26428e5f9fade55a9bbf5e95a7912 */ - before: string | null; + before: string | null /** @example d6fde92930d4715a2b49857d24b940956b26d2d3 */ - after: string | null; - pull_requests: components["schemas"]["pull-request-minimal"][] | null; - app: components["schemas"]["nullable-integration"]; - repository: components["schemas"]["minimal-repository"]; + after: string | null + pull_requests: components['schemas']['pull-request-minimal'][] | null + app: components['schemas']['nullable-integration'] + repository: components['schemas']['minimal-repository'] /** Format: date-time */ - created_at: string | null; + created_at: string | null /** Format: date-time */ - updated_at: string | null; - head_commit: components["schemas"]["simple-commit"]; - latest_check_runs_count: number; - check_runs_url: string; - rerequestable?: boolean; - runs_rerequestable?: boolean; - } & { [key: string]: unknown }; + updated_at: string | null + head_commit: components['schemas']['simple-commit'] + latest_check_runs_count: number + check_runs_url: string + rerequestable?: boolean + runs_rerequestable?: boolean + } & { [key: string]: unknown } /** * Check Suite Preference * @description Check suite configuration preferences for a repository. */ - "check-suite-preference": { + 'check-suite-preference': { preferences: { auto_trigger_checks?: ({ - app_id: number; - setting: boolean; - } & { [key: string]: unknown })[]; - } & { [key: string]: unknown }; - repository: components["schemas"]["minimal-repository"]; - } & { [key: string]: unknown }; - "code-scanning-alert-rule-summary": { + app_id: number + setting: boolean + } & { [key: string]: unknown })[] + } & { [key: string]: unknown } + repository: components['schemas']['minimal-repository'] + } & { [key: string]: unknown } + 'code-scanning-alert-rule-summary': { /** @description A unique identifier for the rule used to detect the alert. */ - id?: string | null; + id?: string | null /** @description The name of the rule used to detect the alert. */ - name?: string; + name?: string /** @description A set of tags applicable for the rule. */ - tags?: string[] | null; + tags?: string[] | null /** * @description The severity of the alert. * @enum {string|null} */ - severity?: ("none" | "note" | "warning" | "error") | null; + severity?: ('none' | 'note' | 'warning' | 'error') | null /** @description A short description of the rule used to detect the alert. */ - description?: string; - } & { [key: string]: unknown }; - "code-scanning-alert-items": { - number: components["schemas"]["alert-number"]; - created_at: components["schemas"]["alert-created-at"]; - updated_at?: components["schemas"]["alert-updated-at"]; - url: components["schemas"]["alert-url"]; - html_url: components["schemas"]["alert-html-url"]; - instances_url: components["schemas"]["alert-instances-url"]; - state: components["schemas"]["code-scanning-alert-state"]; - fixed_at?: components["schemas"]["code-scanning-alert-fixed-at"]; - dismissed_by: components["schemas"]["nullable-simple-user"]; - dismissed_at: components["schemas"]["code-scanning-alert-dismissed-at"]; - dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"]; - rule: components["schemas"]["code-scanning-alert-rule-summary"]; - tool: components["schemas"]["code-scanning-analysis-tool"]; - most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; - } & { [key: string]: unknown }; - "code-scanning-alert": { - number: components["schemas"]["alert-number"]; - created_at: components["schemas"]["alert-created-at"]; - updated_at?: components["schemas"]["alert-updated-at"]; - url: components["schemas"]["alert-url"]; - html_url: components["schemas"]["alert-html-url"]; - instances_url: components["schemas"]["alert-instances-url"]; - state: components["schemas"]["code-scanning-alert-state"]; - fixed_at?: components["schemas"]["code-scanning-alert-fixed-at"]; - dismissed_by: components["schemas"]["nullable-simple-user"]; - dismissed_at: components["schemas"]["code-scanning-alert-dismissed-at"]; - dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"]; - rule: components["schemas"]["code-scanning-alert-rule"]; - tool: components["schemas"]["code-scanning-analysis-tool"]; - most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; - } & { [key: string]: unknown }; + description?: string + } & { [key: string]: unknown } + 'code-scanning-alert-items': { + number: components['schemas']['alert-number'] + created_at: components['schemas']['alert-created-at'] + updated_at?: components['schemas']['alert-updated-at'] + url: components['schemas']['alert-url'] + html_url: components['schemas']['alert-html-url'] + instances_url: components['schemas']['alert-instances-url'] + state: components['schemas']['code-scanning-alert-state'] + fixed_at?: components['schemas']['code-scanning-alert-fixed-at'] + dismissed_by: components['schemas']['nullable-simple-user'] + dismissed_at: components['schemas']['code-scanning-alert-dismissed-at'] + dismissed_reason: components['schemas']['code-scanning-alert-dismissed-reason'] + rule: components['schemas']['code-scanning-alert-rule-summary'] + tool: components['schemas']['code-scanning-analysis-tool'] + most_recent_instance: components['schemas']['code-scanning-alert-instance'] + } & { [key: string]: unknown } + 'code-scanning-alert': { + number: components['schemas']['alert-number'] + created_at: components['schemas']['alert-created-at'] + updated_at?: components['schemas']['alert-updated-at'] + url: components['schemas']['alert-url'] + html_url: components['schemas']['alert-html-url'] + instances_url: components['schemas']['alert-instances-url'] + state: components['schemas']['code-scanning-alert-state'] + fixed_at?: components['schemas']['code-scanning-alert-fixed-at'] + dismissed_by: components['schemas']['nullable-simple-user'] + dismissed_at: components['schemas']['code-scanning-alert-dismissed-at'] + dismissed_reason: components['schemas']['code-scanning-alert-dismissed-reason'] + rule: components['schemas']['code-scanning-alert-rule'] + tool: components['schemas']['code-scanning-analysis-tool'] + most_recent_instance: components['schemas']['code-scanning-alert-instance'] + } & { [key: string]: unknown } /** * @description Sets the state of the code scanning alert. Can be one of `open` or `dismissed`. You must provide `dismissed_reason` when you set the state to `dismissed`. * @enum {string} */ - "code-scanning-alert-set-state": "open" | "dismissed"; + 'code-scanning-alert-set-state': 'open' | 'dismissed' /** * @description An identifier for the upload. * @example 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 */ - "code-scanning-analysis-sarif-id": string; + 'code-scanning-analysis-sarif-id': string /** @description The SHA of the commit to which the analysis you are uploading relates. */ - "code-scanning-analysis-commit-sha": string; + 'code-scanning-analysis-commit-sha': string /** @description Identifies the variable values associated with the environment in which this analysis was performed. */ - "code-scanning-analysis-environment": string; + 'code-scanning-analysis-environment': string /** * Format: date-time * @description The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "code-scanning-analysis-created-at": string; + 'code-scanning-analysis-created-at': string /** * Format: uri * @description The REST API URL of the analysis resource. */ - "code-scanning-analysis-url": string; - "code-scanning-analysis": { - ref: components["schemas"]["code-scanning-ref"]; - commit_sha: components["schemas"]["code-scanning-analysis-commit-sha"]; - analysis_key: components["schemas"]["code-scanning-analysis-analysis-key"]; - environment: components["schemas"]["code-scanning-analysis-environment"]; - category?: components["schemas"]["code-scanning-analysis-category"]; + 'code-scanning-analysis-url': string + 'code-scanning-analysis': { + ref: components['schemas']['code-scanning-ref'] + commit_sha: components['schemas']['code-scanning-analysis-commit-sha'] + analysis_key: components['schemas']['code-scanning-analysis-analysis-key'] + environment: components['schemas']['code-scanning-analysis-environment'] + category?: components['schemas']['code-scanning-analysis-category'] /** @example error reading field xyz */ - error: string; - created_at: components["schemas"]["code-scanning-analysis-created-at"]; + error: string + created_at: components['schemas']['code-scanning-analysis-created-at'] /** @description The total number of results in the analysis. */ - results_count: number; + results_count: number /** @description The total number of rules used in the analysis. */ - rules_count: number; + rules_count: number /** @description Unique identifier for this analysis. */ - id: number; - url: components["schemas"]["code-scanning-analysis-url"]; - sarif_id: components["schemas"]["code-scanning-analysis-sarif-id"]; - tool: components["schemas"]["code-scanning-analysis-tool"]; - deletable: boolean; + id: number + url: components['schemas']['code-scanning-analysis-url'] + sarif_id: components['schemas']['code-scanning-analysis-sarif-id'] + tool: components['schemas']['code-scanning-analysis-tool'] + deletable: boolean /** * @description Warning generated when processing the analysis * @example 123 results were ignored */ - warning: string; - } & { [key: string]: unknown }; + warning: string + } & { [key: string]: unknown } /** * Analysis deletion * @description Successful deletion of a code scanning analysis */ - "code-scanning-analysis-deletion": { + 'code-scanning-analysis-deletion': { /** * Format: uri * @description Next deletable analysis in chain, without last analysis deletion confirmation */ - next_analysis_url: string | null; + next_analysis_url: string | null /** * Format: uri * @description Next deletable analysis in chain, with last analysis deletion confirmation */ - confirm_delete_url: string | null; - } & { [key: string]: unknown }; + confirm_delete_url: string | null + } & { [key: string]: unknown } /** @description A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see "[SARIF support for code scanning](https://docs.github.com/code-security/secure-coding/sarif-support-for-code-scanning)." */ - "code-scanning-analysis-sarif-file": string; - "code-scanning-sarifs-receipt": { - id?: components["schemas"]["code-scanning-analysis-sarif-id"]; + 'code-scanning-analysis-sarif-file': string + 'code-scanning-sarifs-receipt': { + id?: components['schemas']['code-scanning-analysis-sarif-id'] /** * Format: uri * @description The REST API URL for checking the status of the upload. */ - url?: string; - } & { [key: string]: unknown }; - "code-scanning-sarifs-status": { + url?: string + } & { [key: string]: unknown } + 'code-scanning-sarifs-status': { /** * @description `pending` files have not yet been processed, while `complete` means results from the SARIF have been stored. `failed` files have either not been processed at all, or could only be partially processed. * @enum {string} */ - processing_status?: "pending" | "complete" | "failed"; + processing_status?: 'pending' | 'complete' | 'failed' /** * Format: uri * @description The REST API URL for getting the analyses associated with the upload. */ - analyses_url?: string | null; + analyses_url?: string | null /** @description Any errors that ocurred during processing of the delivery. */ - errors?: string[] | null; - } & { [key: string]: unknown }; + errors?: string[] | null + } & { [key: string]: unknown } /** * Codespace machine * @description A description of the machine powering a codespace. */ - "nullable-codespace-machine": + 'nullable-codespace-machine': | ({ /** * @description The name of the machine. * @example standardLinux */ - name: string; + name: string /** * @description The display name of the machine includes cores, memory, and storage. * @example 4 cores, 8 GB RAM, 64 GB storage */ - display_name: string; + display_name: string /** * @description The operating system of the machine. * @example linux */ - operating_system: string; + operating_system: string /** * @description How much storage is available to the codespace. * @example 68719476736 */ - storage_in_bytes: number; + storage_in_bytes: number /** * @description How much memory is available to the codespace. * @example 8589934592 */ - memory_in_bytes: number; + memory_in_bytes: number /** * @description How many cores are available to the codespace. * @example 4 */ - cpus: number; + cpus: number /** * @description Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be "null" if prebuilds are not supported or prebuild availability could not be determined. Value is the type of prebuild available, or "none" if none are available. * @example blob * @enum {string|null} */ - prebuild_availability: ("none" | "blob" | "pool") | null; + prebuild_availability: ('none' | 'blob' | 'pool') | null } & { [key: string]: unknown }) - | null; + | null /** * Codespace * @description A codespace. */ codespace: { /** @example 1 */ - id: number; + id: number /** * @description Automatically generated name of this codespace. * @example monalisa-octocat-hello-world-g4wpq6h95q */ - name: string; + name: string /** * @description UUID identifying this codespace's environment. * @example 26a7c758-7299-4a73-b978-5a92a7ae98a0 */ - environment_id: string | null; - owner: components["schemas"]["simple-user"]; - billable_owner: components["schemas"]["simple-user"]; - repository: components["schemas"]["minimal-repository"]; - machine: components["schemas"]["nullable-codespace-machine"]; + environment_id: string | null + owner: components['schemas']['simple-user'] + billable_owner: components['schemas']['simple-user'] + repository: components['schemas']['minimal-repository'] + machine: components['schemas']['nullable-codespace-machine'] /** @description Whether the codespace was created from a prebuild. */ - prebuild: boolean | null; + prebuild: boolean | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - updated_at: string; + updated_at: string /** * Format: date-time * @description Last known time this codespace was started. * @example 2011-01-26T19:01:12Z */ - last_used_at: string; + last_used_at: string /** * @description State of this codespace. * @example Available * @enum {string} */ state: - | "Unknown" - | "Created" - | "Queued" - | "Provisioning" - | "Available" - | "Awaiting" - | "Unavailable" - | "Deleted" - | "Moved" - | "Shutdown" - | "Archived" - | "Starting" - | "ShuttingDown" - | "Failed" - | "Exporting" - | "Updating" - | "Rebuilding"; + | 'Unknown' + | 'Created' + | 'Queued' + | 'Provisioning' + | 'Available' + | 'Awaiting' + | 'Unavailable' + | 'Deleted' + | 'Moved' + | 'Shutdown' + | 'Archived' + | 'Starting' + | 'ShuttingDown' + | 'Failed' + | 'Exporting' + | 'Updating' + | 'Rebuilding' /** * Format: uri * @description API URL for this codespace. */ - url: string; + url: string /** @description Details about the codespace's git repository. */ git_status: { /** @description The number of commits the local repository is ahead of the remote. */ - ahead?: number; + ahead?: number /** @description The number of commits the local repository is behind the remote. */ - behind?: number; + behind?: number /** @description Whether the local repository has unpushed changes. */ - has_unpushed_changes?: boolean; + has_unpushed_changes?: boolean /** @description Whether the local repository has uncommitted changes. */ - has_uncommitted_changes?: boolean; + has_uncommitted_changes?: boolean /** * @description The current branch (or SHA if in detached HEAD state) of the local repository. * @example main */ - ref?: string; - } & { [key: string]: unknown }; + ref?: string + } & { [key: string]: unknown } /** * @description The Azure region where this codespace is located. * @example WestUs2 * @enum {string} */ - location: "EastUs" | "SouthEastAsia" | "WestEurope" | "WestUs2"; + location: 'EastUs' | 'SouthEastAsia' | 'WestEurope' | 'WestUs2' /** * @description The number of minutes of inactivity after which this codespace will be automatically stopped. * @example 60 */ - idle_timeout_minutes: number | null; + idle_timeout_minutes: number | null /** * Format: uri * @description URL to access this codespace on the web. */ - web_url: string; + web_url: string /** * Format: uri * @description API URL to access available alternate machine types for this codespace. */ - machines_url: string; + machines_url: string /** * Format: uri * @description API URL to start this codespace. */ - start_url: string; + start_url: string /** * Format: uri * @description API URL to stop this codespace. */ - stop_url: string; + stop_url: string /** * Format: uri * @description API URL for the Pull Request associated with this codespace, if any. */ - pulls_url: string | null; - recent_folders: string[]; + pulls_url: string | null + recent_folders: string[] runtime_constraints?: { /** @description The privacy settings a user can select from when forwarding a port. */ - allowed_port_privacy_settings?: string[] | null; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + allowed_port_privacy_settings?: string[] | null + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** * Codespace machine * @description A description of the machine powering a codespace. */ - "codespace-machine": { + 'codespace-machine': { /** * @description The name of the machine. * @example standardLinux */ - name: string; + name: string /** * @description The display name of the machine includes cores, memory, and storage. * @example 4 cores, 8 GB RAM, 64 GB storage */ - display_name: string; + display_name: string /** * @description The operating system of the machine. * @example linux */ - operating_system: string; + operating_system: string /** * @description How much storage is available to the codespace. * @example 68719476736 */ - storage_in_bytes: number; + storage_in_bytes: number /** * @description How much memory is available to the codespace. * @example 8589934592 */ - memory_in_bytes: number; + memory_in_bytes: number /** * @description How many cores are available to the codespace. * @example 4 */ - cpus: number; + cpus: number /** * @description Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be "null" if prebuilds are not supported or prebuild availability could not be determined. Value is the type of prebuild available, or "none" if none are available. * @example blob * @enum {string|null} */ - prebuild_availability: ("none" | "blob" | "pool") | null; - } & { [key: string]: unknown }; + prebuild_availability: ('none' | 'blob' | 'pool') | null + } & { [key: string]: unknown } /** * Collaborator * @description Collaborator */ collaborator: { /** @example octocat */ - login: string; + login: string /** @example 1 */ - id: number; - email?: string | null; - name?: string | null; + id: number + email?: string | null + name?: string | null /** @example MDQ6VXNlcjE= */ - node_id: string; + node_id: string /** * Format: uri * @example https://github.com/images/error/octocat_happy.gif */ - avatar_url: string; + avatar_url: string /** @example 41d064eb2195891e12d0413f63227ea7 */ - gravatar_id: string | null; + gravatar_id: string | null /** * Format: uri * @example https://api.github.com/users/octocat */ - url: string; + url: string /** * Format: uri * @example https://github.com/octocat */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/users/octocat/followers */ - followers_url: string; + followers_url: string /** @example https://api.github.com/users/octocat/following{/other_user} */ - following_url: string; + following_url: string /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - gists_url: string; + gists_url: string /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - starred_url: string; + starred_url: string /** * Format: uri * @example https://api.github.com/users/octocat/subscriptions */ - subscriptions_url: string; + subscriptions_url: string /** * Format: uri * @example https://api.github.com/users/octocat/orgs */ - organizations_url: string; + organizations_url: string /** * Format: uri * @example https://api.github.com/users/octocat/repos */ - repos_url: string; + repos_url: string /** @example https://api.github.com/users/octocat/events{/privacy} */ - events_url: string; + events_url: string /** * Format: uri * @example https://api.github.com/users/octocat/received_events */ - received_events_url: string; + received_events_url: string /** @example User */ - type: string; - site_admin: boolean; + type: string + site_admin: boolean permissions?: { - pull: boolean; - triage?: boolean; - push: boolean; - maintain?: boolean; - admin: boolean; - } & { [key: string]: unknown }; + pull: boolean + triage?: boolean + push: boolean + maintain?: boolean + admin: boolean + } & { [key: string]: unknown } /** @example admin */ - role_name: string; - } & { [key: string]: unknown }; + role_name: string + } & { [key: string]: unknown } /** * Repository Invitation * @description Repository invitations let you manage who you collaborate with. */ - "repository-invitation": { + 'repository-invitation': { /** * @description Unique identifier of the repository invitation. * @example 42 */ - id: number; - repository: components["schemas"]["minimal-repository"]; - invitee: components["schemas"]["nullable-simple-user"]; - inviter: components["schemas"]["nullable-simple-user"]; + id: number + repository: components['schemas']['minimal-repository'] + invitee: components['schemas']['nullable-simple-user'] + inviter: components['schemas']['nullable-simple-user'] /** * @description The permission associated with the invitation. * @example read * @enum {string} */ - permissions: "read" | "write" | "admin" | "triage" | "maintain"; + permissions: 'read' | 'write' | 'admin' | 'triage' | 'maintain' /** * Format: date-time * @example 2016-06-13T14:52:50-05:00 */ - created_at: string; + created_at: string /** @description Whether or not the invitation has expired */ - expired?: boolean; + expired?: boolean /** * @description URL for the repository invitation * @example https://api.github.com/user/repository-invitations/1 */ - url: string; + url: string /** @example https://github.com/octocat/Hello-World/invitations */ - html_url: string; - node_id: string; - } & { [key: string]: unknown }; + html_url: string + node_id: string + } & { [key: string]: unknown } /** * Collaborator * @description Collaborator */ - "nullable-collaborator": + 'nullable-collaborator': | ({ /** @example octocat */ - login: string; + login: string /** @example 1 */ - id: number; - email?: string | null; - name?: string | null; + id: number + email?: string | null + name?: string | null /** @example MDQ6VXNlcjE= */ - node_id: string; + node_id: string /** * Format: uri * @example https://github.com/images/error/octocat_happy.gif */ - avatar_url: string; + avatar_url: string /** @example 41d064eb2195891e12d0413f63227ea7 */ - gravatar_id: string | null; + gravatar_id: string | null /** * Format: uri * @example https://api.github.com/users/octocat */ - url: string; + url: string /** * Format: uri * @example https://github.com/octocat */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/users/octocat/followers */ - followers_url: string; + followers_url: string /** @example https://api.github.com/users/octocat/following{/other_user} */ - following_url: string; + following_url: string /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - gists_url: string; + gists_url: string /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - starred_url: string; + starred_url: string /** * Format: uri * @example https://api.github.com/users/octocat/subscriptions */ - subscriptions_url: string; + subscriptions_url: string /** * Format: uri * @example https://api.github.com/users/octocat/orgs */ - organizations_url: string; + organizations_url: string /** * Format: uri * @example https://api.github.com/users/octocat/repos */ - repos_url: string; + repos_url: string /** @example https://api.github.com/users/octocat/events{/privacy} */ - events_url: string; + events_url: string /** * Format: uri * @example https://api.github.com/users/octocat/received_events */ - received_events_url: string; + received_events_url: string /** @example User */ - type: string; - site_admin: boolean; + type: string + site_admin: boolean permissions?: { - pull: boolean; - triage?: boolean; - push: boolean; - maintain?: boolean; - admin: boolean; - } & { [key: string]: unknown }; + pull: boolean + triage?: boolean + push: boolean + maintain?: boolean + admin: boolean + } & { [key: string]: unknown } /** @example admin */ - role_name: string; + role_name: string } & { [key: string]: unknown }) - | null; + | null /** * Repository Collaborator Permission * @description Repository Collaborator Permission */ - "repository-collaborator-permission": { - permission: string; + 'repository-collaborator-permission': { + permission: string /** @example admin */ - role_name: string; - user: components["schemas"]["nullable-collaborator"]; - } & { [key: string]: unknown }; + role_name: string + user: components['schemas']['nullable-collaborator'] + } & { [key: string]: unknown } /** * Commit Comment * @description Commit Comment */ - "commit-comment": { + 'commit-comment': { /** Format: uri */ - html_url: string; + html_url: string /** Format: uri */ - url: string; - id: number; - node_id: string; - body: string; - path: string | null; - position: number | null; - line: number | null; - commit_id: string; - user: components["schemas"]["nullable-simple-user"]; + url: string + id: number + node_id: string + body: string + path: string | null + position: number | null + line: number | null + commit_id: string + user: components['schemas']['nullable-simple-user'] /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - author_association: components["schemas"]["author_association"]; - reactions?: components["schemas"]["reaction-rollup"]; - } & { [key: string]: unknown }; + updated_at: string + author_association: components['schemas']['author_association'] + reactions?: components['schemas']['reaction-rollup'] + } & { [key: string]: unknown } /** * Branch Short * @description Branch Short */ - "branch-short": { - name: string; + 'branch-short': { + name: string commit: { - sha: string; - url: string; - } & { [key: string]: unknown }; - protected: boolean; - } & { [key: string]: unknown }; + sha: string + url: string + } & { [key: string]: unknown } + protected: boolean + } & { [key: string]: unknown } /** * Link * @description Hypermedia Link */ link: { - href: string; - } & { [key: string]: unknown }; + href: string + } & { [key: string]: unknown } /** * Auto merge * @description The status of auto merging a pull request. */ auto_merge: | ({ - enabled_by: components["schemas"]["simple-user"]; + enabled_by: components['schemas']['simple-user'] /** * @description The merge method to use. * @enum {string} */ - merge_method: "merge" | "squash" | "rebase"; + merge_method: 'merge' | 'squash' | 'rebase' /** @description Title for the merge commit message. */ - commit_title: string; + commit_title: string /** @description Commit message for the merge commit. */ - commit_message: string; + commit_message: string } & { [key: string]: unknown }) - | null; + | null /** * Pull Request Simple * @description Pull Request Simple */ - "pull-request-simple": { + 'pull-request-simple': { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ - url: string; + url: string /** @example 1 */ - id: number; + id: number /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ - node_id: string; + node_id: string /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347 */ - html_url: string; + html_url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.diff */ - diff_url: string; + diff_url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.patch */ - patch_url: string; + patch_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 */ - issue_url: string; + issue_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits */ - commits_url: string; + commits_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments */ - review_comments_url: string; + review_comments_url: string /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} */ - review_comment_url: string; + review_comment_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347/comments */ - comments_url: string; + comments_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e */ - statuses_url: string; + statuses_url: string /** @example 1347 */ - number: number; + number: number /** @example open */ - state: string; + state: string /** @example true */ - locked: boolean; + locked: boolean /** @example new-feature */ - title: string; - user: components["schemas"]["nullable-simple-user"]; + title: string + user: components['schemas']['nullable-simple-user'] /** @example Please pull these awesome changes */ - body: string | null; + body: string | null labels: ({ /** Format: int64 */ - id: number; - node_id: string; - url: string; - name: string; - description: string; - color: string; - default: boolean; - } & { [key: string]: unknown })[]; - milestone: components["schemas"]["nullable-milestone"]; + id: number + node_id: string + url: string + name: string + description: string + color: string + default: boolean + } & { [key: string]: unknown })[] + milestone: components['schemas']['nullable-milestone'] /** @example too heated */ - active_lock_reason?: string | null; + active_lock_reason?: string | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - updated_at: string; + updated_at: string /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - closed_at: string | null; + closed_at: string | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - merged_at: string | null; + merged_at: string | null /** @example e5bd3914e2e596debea16f433f57875b5b90bcd6 */ - merge_commit_sha: string | null; - assignee: components["schemas"]["nullable-simple-user"]; - assignees?: components["schemas"]["simple-user"][] | null; - requested_reviewers?: components["schemas"]["simple-user"][] | null; - requested_teams?: components["schemas"]["team"][] | null; + merge_commit_sha: string | null + assignee: components['schemas']['nullable-simple-user'] + assignees?: components['schemas']['simple-user'][] | null + requested_reviewers?: components['schemas']['simple-user'][] | null + requested_teams?: components['schemas']['team'][] | null head: { - label: string; - ref: string; - repo: components["schemas"]["repository"]; - sha: string; - user: components["schemas"]["nullable-simple-user"]; - } & { [key: string]: unknown }; + label: string + ref: string + repo: components['schemas']['repository'] + sha: string + user: components['schemas']['nullable-simple-user'] + } & { [key: string]: unknown } base: { - label: string; - ref: string; - repo: components["schemas"]["repository"]; - sha: string; - user: components["schemas"]["nullable-simple-user"]; - } & { [key: string]: unknown }; + label: string + ref: string + repo: components['schemas']['repository'] + sha: string + user: components['schemas']['nullable-simple-user'] + } & { [key: string]: unknown } _links: { - comments: components["schemas"]["link"]; - commits: components["schemas"]["link"]; - statuses: components["schemas"]["link"]; - html: components["schemas"]["link"]; - issue: components["schemas"]["link"]; - review_comments: components["schemas"]["link"]; - review_comment: components["schemas"]["link"]; - self: components["schemas"]["link"]; - } & { [key: string]: unknown }; - author_association: components["schemas"]["author_association"]; - auto_merge: components["schemas"]["auto_merge"]; + comments: components['schemas']['link'] + commits: components['schemas']['link'] + statuses: components['schemas']['link'] + html: components['schemas']['link'] + issue: components['schemas']['link'] + review_comments: components['schemas']['link'] + review_comment: components['schemas']['link'] + self: components['schemas']['link'] + } & { [key: string]: unknown } + author_association: components['schemas']['author_association'] + auto_merge: components['schemas']['auto_merge'] /** @description Indicates whether or not the pull request is a draft. */ - draft?: boolean; - } & { [key: string]: unknown }; + draft?: boolean + } & { [key: string]: unknown } /** Simple Commit Status */ - "simple-commit-status": { - description: string | null; - id: number; - node_id: string; - state: string; - context: string; + 'simple-commit-status': { + description: string | null + id: number + node_id: string + state: string + context: string /** Format: uri */ - target_url: string; - required?: boolean | null; + target_url: string + required?: boolean | null /** Format: uri */ - avatar_url: string | null; + avatar_url: string | null /** Format: uri */ - url: string; + url: string /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - } & { [key: string]: unknown }; + updated_at: string + } & { [key: string]: unknown } /** * Combined Commit Status * @description Combined Commit Status */ - "combined-commit-status": { - state: string; - statuses: components["schemas"]["simple-commit-status"][]; - sha: string; - total_count: number; - repository: components["schemas"]["minimal-repository"]; + 'combined-commit-status': { + state: string + statuses: components['schemas']['simple-commit-status'][] + sha: string + total_count: number + repository: components['schemas']['minimal-repository'] /** Format: uri */ - commit_url: string; + commit_url: string /** Format: uri */ - url: string; - } & { [key: string]: unknown }; + url: string + } & { [key: string]: unknown } /** * Status * @description The status of a commit. */ status: { - url: string; - avatar_url: string | null; - id: number; - node_id: string; - state: string; - description: string; - target_url: string; - context: string; - created_at: string; - updated_at: string; - creator: components["schemas"]["nullable-simple-user"]; - } & { [key: string]: unknown }; + url: string + avatar_url: string | null + id: number + node_id: string + state: string + description: string + target_url: string + context: string + created_at: string + updated_at: string + creator: components['schemas']['nullable-simple-user'] + } & { [key: string]: unknown } /** * Code Of Conduct Simple * @description Code of Conduct Simple */ - "nullable-code-of-conduct-simple": + 'nullable-code-of-conduct-simple': | ({ /** * Format: uri * @example https://api.github.com/repos/github/docs/community/code_of_conduct */ - url: string; + url: string /** @example citizen_code_of_conduct */ - key: string; + key: string /** @example Citizen Code of Conduct */ - name: string; + name: string /** * Format: uri * @example https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md */ - html_url: string | null; + html_url: string | null } & { [key: string]: unknown }) - | null; + | null /** Community Health File */ - "nullable-community-health-file": + 'nullable-community-health-file': | ({ /** Format: uri */ - url: string; + url: string /** Format: uri */ - html_url: string; + html_url: string } & { [key: string]: unknown }) - | null; + | null /** * Community Profile * @description Community Profile */ - "community-profile": { + 'community-profile': { /** @example 100 */ - health_percentage: number; + health_percentage: number /** @example My first repository on GitHub! */ - description: string | null; + description: string | null /** @example example.com */ - documentation: string | null; + documentation: string | null files: { - code_of_conduct: components["schemas"]["nullable-code-of-conduct-simple"]; - code_of_conduct_file: components["schemas"]["nullable-community-health-file"]; - license: components["schemas"]["nullable-license-simple"]; - contributing: components["schemas"]["nullable-community-health-file"]; - readme: components["schemas"]["nullable-community-health-file"]; - issue_template: components["schemas"]["nullable-community-health-file"]; - pull_request_template: components["schemas"]["nullable-community-health-file"]; - } & { [key: string]: unknown }; + code_of_conduct: components['schemas']['nullable-code-of-conduct-simple'] + code_of_conduct_file: components['schemas']['nullable-community-health-file'] + license: components['schemas']['nullable-license-simple'] + contributing: components['schemas']['nullable-community-health-file'] + readme: components['schemas']['nullable-community-health-file'] + issue_template: components['schemas']['nullable-community-health-file'] + pull_request_template: components['schemas']['nullable-community-health-file'] + } & { [key: string]: unknown } /** * Format: date-time * @example 2017-02-28T19:09:29Z */ - updated_at: string | null; + updated_at: string | null /** @example true */ - content_reports_enabled?: boolean; - } & { [key: string]: unknown }; + content_reports_enabled?: boolean + } & { [key: string]: unknown } /** * Commit Comparison * @description Commit Comparison */ - "commit-comparison": { + 'commit-comparison': { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/compare/master...topic */ - url: string; + url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/compare/master...topic */ - html_url: string; + html_url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17 */ - permalink_url: string; + permalink_url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/compare/master...topic.diff */ - diff_url: string; + diff_url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/compare/master...topic.patch */ - patch_url: string; - base_commit: components["schemas"]["commit"]; - merge_base_commit: components["schemas"]["commit"]; + patch_url: string + base_commit: components['schemas']['commit'] + merge_base_commit: components['schemas']['commit'] /** * @example ahead * @enum {string} */ - status: "diverged" | "ahead" | "behind" | "identical"; + status: 'diverged' | 'ahead' | 'behind' | 'identical' /** @example 4 */ - ahead_by: number; + ahead_by: number /** @example 5 */ - behind_by: number; + behind_by: number /** @example 6 */ - total_commits: number; - commits: components["schemas"]["commit"][]; - files?: components["schemas"]["diff-entry"][]; - } & { [key: string]: unknown }; + total_commits: number + commits: components['schemas']['commit'][] + files?: components['schemas']['diff-entry'][] + } & { [key: string]: unknown } /** * Content Tree * @description Content Tree */ - "content-tree": { - type: string; - size: number; - name: string; - path: string; - sha: string; + 'content-tree': { + type: string + size: number + name: string + path: string + sha: string /** Format: uri */ - url: string; + url: string /** Format: uri */ - git_url: string | null; + git_url: string | null /** Format: uri */ - html_url: string | null; + html_url: string | null /** Format: uri */ - download_url: string | null; + download_url: string | null entries?: ({ - type: string; - size: number; - name: string; - path: string; - content?: string; - sha: string; + type: string + size: number + name: string + path: string + content?: string + sha: string /** Format: uri */ - url: string; + url: string /** Format: uri */ - git_url: string | null; + git_url: string | null /** Format: uri */ - html_url: string | null; + html_url: string | null /** Format: uri */ - download_url: string | null; + download_url: string | null _links: { /** Format: uri */ - git: string | null; + git: string | null /** Format: uri */ - html: string | null; + html: string | null /** Format: uri */ - self: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown })[]; + self: string + } & { [key: string]: unknown } + } & { [key: string]: unknown })[] _links: { /** Format: uri */ - git: string | null; + git: string | null /** Format: uri */ - html: string | null; + html: string | null /** Format: uri */ - self: string; - } & { [key: string]: unknown }; + self: string + } & { [key: string]: unknown } } & { - content: unknown; - encoding: unknown; - } & { [key: string]: unknown }; + content: unknown + encoding: unknown + } & { [key: string]: unknown } /** * Content Directory * @description A list of directory items */ - "content-directory": ({ - type: string; - size: number; - name: string; - path: string; - content?: string; - sha: string; + 'content-directory': ({ + type: string + size: number + name: string + path: string + content?: string + sha: string /** Format: uri */ - url: string; + url: string /** Format: uri */ - git_url: string | null; + git_url: string | null /** Format: uri */ - html_url: string | null; + html_url: string | null /** Format: uri */ - download_url: string | null; + download_url: string | null _links: { /** Format: uri */ - git: string | null; + git: string | null /** Format: uri */ - html: string | null; + html: string | null /** Format: uri */ - self: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown })[]; + self: string + } & { [key: string]: unknown } + } & { [key: string]: unknown })[] /** * Content File * @description Content File */ - "content-file": { - type: string; - encoding: string; - size: number; - name: string; - path: string; - content: string; - sha: string; + 'content-file': { + type: string + encoding: string + size: number + name: string + path: string + content: string + sha: string /** Format: uri */ - url: string; + url: string /** Format: uri */ - git_url: string | null; + git_url: string | null /** Format: uri */ - html_url: string | null; + html_url: string | null /** Format: uri */ - download_url: string | null; + download_url: string | null _links: { /** Format: uri */ - git: string | null; + git: string | null /** Format: uri */ - html: string | null; + html: string | null /** Format: uri */ - self: string; - } & { [key: string]: unknown }; + self: string + } & { [key: string]: unknown } /** @example "actual/actual.md" */ - target?: string; + target?: string /** @example "git://example.com/defunkt/dotjs.git" */ - submodule_git_url?: string; - } & { [key: string]: unknown }; + submodule_git_url?: string + } & { [key: string]: unknown } /** * Symlink Content * @description An object describing a symlink */ - "content-symlink": { - type: string; - target: string; - size: number; - name: string; - path: string; - sha: string; + 'content-symlink': { + type: string + target: string + size: number + name: string + path: string + sha: string /** Format: uri */ - url: string; + url: string /** Format: uri */ - git_url: string | null; + git_url: string | null /** Format: uri */ - html_url: string | null; + html_url: string | null /** Format: uri */ - download_url: string | null; + download_url: string | null _links: { /** Format: uri */ - git: string | null; + git: string | null /** Format: uri */ - html: string | null; + html: string | null /** Format: uri */ - self: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + self: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** * Symlink Content * @description An object describing a symlink */ - "content-submodule": { - type: string; + 'content-submodule': { + type: string /** Format: uri */ - submodule_git_url: string; - size: number; - name: string; - path: string; - sha: string; + submodule_git_url: string + size: number + name: string + path: string + sha: string /** Format: uri */ - url: string; + url: string /** Format: uri */ - git_url: string | null; + git_url: string | null /** Format: uri */ - html_url: string | null; + html_url: string | null /** Format: uri */ - download_url: string | null; + download_url: string | null _links: { /** Format: uri */ - git: string | null; + git: string | null /** Format: uri */ - html: string | null; + html: string | null /** Format: uri */ - self: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + self: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** * File Commit * @description File Commit */ - "file-commit": { + 'file-commit': { content: | ({ - name?: string; - path?: string; - sha?: string; - size?: number; - url?: string; - html_url?: string; - git_url?: string; - download_url?: string; - type?: string; + name?: string + path?: string + sha?: string + size?: number + url?: string + html_url?: string + git_url?: string + download_url?: string + type?: string _links?: { - self?: string; - git?: string; - html?: string; - } & { [key: string]: unknown }; + self?: string + git?: string + html?: string + } & { [key: string]: unknown } } & { [key: string]: unknown }) - | null; + | null commit: { - sha?: string; - node_id?: string; - url?: string; - html_url?: string; + sha?: string + node_id?: string + url?: string + html_url?: string author?: { - date?: string; - name?: string; - email?: string; - } & { [key: string]: unknown }; + date?: string + name?: string + email?: string + } & { [key: string]: unknown } committer?: { - date?: string; - name?: string; - email?: string; - } & { [key: string]: unknown }; - message?: string; + date?: string + name?: string + email?: string + } & { [key: string]: unknown } + message?: string tree?: { - url?: string; - sha?: string; - } & { [key: string]: unknown }; + url?: string + sha?: string + } & { [key: string]: unknown } parents?: ({ - url?: string; - html_url?: string; - sha?: string; - } & { [key: string]: unknown })[]; + url?: string + html_url?: string + sha?: string + } & { [key: string]: unknown })[] verification?: { - verified?: boolean; - reason?: string; - signature?: string | null; - payload?: string | null; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + verified?: boolean + reason?: string + signature?: string | null + payload?: string | null + } & { [key: string]: unknown } + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** * Contributor * @description Contributor */ contributor: { - login?: string; - id?: number; - node_id?: string; + login?: string + id?: number + node_id?: string /** Format: uri */ - avatar_url?: string; - gravatar_id?: string | null; + avatar_url?: string + gravatar_id?: string | null /** Format: uri */ - url?: string; + url?: string /** Format: uri */ - html_url?: string; + html_url?: string /** Format: uri */ - followers_url?: string; - following_url?: string; - gists_url?: string; - starred_url?: string; + followers_url?: string + following_url?: string + gists_url?: string + starred_url?: string /** Format: uri */ - subscriptions_url?: string; + subscriptions_url?: string /** Format: uri */ - organizations_url?: string; + organizations_url?: string /** Format: uri */ - repos_url?: string; - events_url?: string; + repos_url?: string + events_url?: string /** Format: uri */ - received_events_url?: string; - type: string; - site_admin?: boolean; - contributions: number; - email?: string; - name?: string; - } & { [key: string]: unknown }; + received_events_url?: string + type: string + site_admin?: boolean + contributions: number + email?: string + name?: string + } & { [key: string]: unknown } /** * Dependabot Secret * @description Set secrets for Dependabot. */ - "dependabot-secret": { + 'dependabot-secret': { /** * @description The name of the secret. * @example MY_ARTIFACTORY_PASSWORD */ - name: string; + name: string /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - } & { [key: string]: unknown }; + updated_at: string + } & { [key: string]: unknown } /** * Deployment Status * @description The status of a deployment. */ - "deployment-status": { + 'deployment-status': { /** * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/42/statuses/1 */ - url: string; + url: string /** @example 1 */ - id: number; + id: number /** @example MDE2OkRlcGxveW1lbnRTdGF0dXMx */ - node_id: string; + node_id: string /** * @description The state of the status. * @example success * @enum {string} */ - state: "error" | "failure" | "inactive" | "pending" | "success" | "queued" | "in_progress"; - creator: components["schemas"]["nullable-simple-user"]; + state: 'error' | 'failure' | 'inactive' | 'pending' | 'success' | 'queued' | 'in_progress' + creator: components['schemas']['nullable-simple-user'] /** * @description A short description of the status. * @example Deployment finished successfully. */ - description: string; + description: string /** * @description The environment of the deployment that the status is for. * @example production */ - environment?: string; + environment?: string /** * Format: uri * @description Deprecated: the URL to associate with this status. * @example https://example.com/deployment/42/output */ - target_url: string; + target_url: string /** * Format: date-time * @example 2012-07-20T01:19:13Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2012-07-20T01:19:13Z */ - updated_at: string; + updated_at: string /** * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/42 */ - deployment_url: string; + deployment_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/example */ - repository_url: string; + repository_url: string /** * Format: uri * @description The URL for accessing your environment. * @example https://staging.example.com/ */ - environment_url?: string; + environment_url?: string /** * Format: uri * @description The URL to associate with this status. * @example https://example.com/deployment/42/output */ - log_url?: string; - performed_via_github_app?: components["schemas"]["nullable-integration"]; - } & { [key: string]: unknown }; + log_url?: string + performed_via_github_app?: components['schemas']['nullable-integration'] + } & { [key: string]: unknown } /** * @description The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days). * @example 30 */ - "wait-timer": number; + 'wait-timer': number /** @description The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. */ deployment_branch_policy: | ({ /** @description Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`. */ - protected_branches: boolean; + protected_branches: boolean /** @description Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`. */ - custom_branch_policies: boolean; + custom_branch_policies: boolean } & { [key: string]: unknown }) - | null; + | null /** * Environment * @description Details of a deployment environment @@ -13870,105 +13852,103 @@ export interface components { * @description The id of the environment. * @example 56780428 */ - id: number; + id: number /** @example MDExOkVudmlyb25tZW50NTY3ODA0Mjg= */ - node_id: string; + node_id: string /** * @description The name of the environment. * @example staging */ - name: string; + name: string /** @example https://api.github.com/repos/github/hello-world/environments/staging */ - url: string; + url: string /** @example https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging */ - html_url: string; + html_url: string /** * Format: date-time * @description The time that the environment was created, in ISO 8601 format. * @example 2020-11-23T22:00:40Z */ - created_at: string; + created_at: string /** * Format: date-time * @description The time that the environment was last updated, in ISO 8601 format. * @example 2020-11-23T22:00:40Z */ - updated_at: string; + updated_at: string protection_rules?: ((Partial< { /** @example 3515 */ - id: number; + id: number /** @example MDQ6R2F0ZTM1MTU= */ - node_id: string; + node_id: string /** @example wait_timer */ - type: string; - wait_timer?: components["schemas"]["wait-timer"]; + type: string + wait_timer?: components['schemas']['wait-timer'] } & { [key: string]: unknown } > & Partial< { /** @example 3755 */ - id: number; + id: number /** @example MDQ6R2F0ZTM3NTU= */ - node_id: string; + node_id: string /** @example required_reviewers */ - type: string; + type: string /** @description The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */ reviewers?: ({ - type?: components["schemas"]["deployment-reviewer-type"]; - reviewer?: (Partial & Partial) & { - [key: string]: unknown; - }; - } & { [key: string]: unknown })[]; + type?: components['schemas']['deployment-reviewer-type'] + reviewer?: (Partial & Partial) & { [key: string]: unknown } + } & { [key: string]: unknown })[] } & { [key: string]: unknown } > & Partial< { /** @example 3515 */ - id: number; + id: number /** @example MDQ6R2F0ZTM1MTU= */ - node_id: string; + node_id: string /** @example branch_policy */ - type: string; + type: string } & { [key: string]: unknown } - >) & { [key: string]: unknown })[]; - deployment_branch_policy?: components["schemas"]["deployment_branch_policy"]; - } & { [key: string]: unknown }; + >) & { [key: string]: unknown })[] + deployment_branch_policy?: components['schemas']['deployment_branch_policy'] + } & { [key: string]: unknown } /** * Short Blob * @description Short Blob */ - "short-blob": { - url: string; - sha: string; - } & { [key: string]: unknown }; + 'short-blob': { + url: string + sha: string + } & { [key: string]: unknown } /** * Blob * @description Blob */ blob: { - content: string; - encoding: string; + content: string + encoding: string /** Format: uri */ - url: string; - sha: string; - size: number | null; - node_id: string; - highlighted_content?: string; - } & { [key: string]: unknown }; + url: string + sha: string + size: number | null + node_id: string + highlighted_content?: string + } & { [key: string]: unknown } /** * Git Commit * @description Low-level Git commit operations within a repository */ - "git-commit": { + 'git-commit': { /** * @description SHA for the commit * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - sha: string; - node_id: string; + sha: string + node_id: string /** Format: uri */ - url: string; + url: string /** @description Identifying information for the git-user */ author: { /** @@ -13976,18 +13956,18 @@ export interface components { * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 */ - date: string; + date: string /** * @description Git email address of the user * @example monalisa.octocat@example.com */ - email: string; + email: string /** * @description Name of the git user * @example Monalisa Octocat */ - name: string; - } & { [key: string]: unknown }; + name: string + } & { [key: string]: unknown } /** @description Identifying information for the git-user */ committer: { /** @@ -13995,344 +13975,344 @@ export interface components { * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 */ - date: string; + date: string /** * @description Git email address of the user * @example monalisa.octocat@example.com */ - email: string; + email: string /** * @description Name of the git user * @example Monalisa Octocat */ - name: string; - } & { [key: string]: unknown }; + name: string + } & { [key: string]: unknown } /** * @description Message describing the purpose of the commit * @example Fix #42 */ - message: string; + message: string tree: { /** * @description SHA for the commit * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - sha: string; + sha: string /** Format: uri */ - url: string; - } & { [key: string]: unknown }; + url: string + } & { [key: string]: unknown } parents: ({ /** * @description SHA for the commit * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - sha: string; + sha: string /** Format: uri */ - url: string; + url: string /** Format: uri */ - html_url: string; - } & { [key: string]: unknown })[]; + html_url: string + } & { [key: string]: unknown })[] verification: { - verified: boolean; - reason: string; - signature: string | null; - payload: string | null; - } & { [key: string]: unknown }; + verified: boolean + reason: string + signature: string | null + payload: string | null + } & { [key: string]: unknown } /** Format: uri */ - html_url: string; - } & { [key: string]: unknown }; + html_url: string + } & { [key: string]: unknown } /** * Git Reference * @description Git references within a repository */ - "git-ref": { - ref: string; - node_id: string; + 'git-ref': { + ref: string + node_id: string /** Format: uri */ - url: string; + url: string object: { - type: string; + type: string /** * @description SHA for the reference * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - sha: string; + sha: string /** Format: uri */ - url: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + url: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** * Git Tag * @description Metadata for a Git tag */ - "git-tag": { + 'git-tag': { /** @example MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== */ - node_id: string; + node_id: string /** * @description Name of the tag * @example v0.0.1 */ - tag: string; + tag: string /** @example 940bd336248efae0f9ee5bc7b2d5c985887b16ac */ - sha: string; + sha: string /** * Format: uri * @description URL for the tag * @example https://api.github.com/repositories/42/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac */ - url: string; + url: string /** * @description Message describing the purpose of the tag * @example Initial public release */ - message: string; + message: string tagger: { - date: string; - email: string; - name: string; - } & { [key: string]: unknown }; + date: string + email: string + name: string + } & { [key: string]: unknown } object: { - sha: string; - type: string; + sha: string + type: string /** Format: uri */ - url: string; - } & { [key: string]: unknown }; - verification?: components["schemas"]["verification"]; - } & { [key: string]: unknown }; + url: string + } & { [key: string]: unknown } + verification?: components['schemas']['verification'] + } & { [key: string]: unknown } /** * Git Tree * @description The hierarchy between files in a Git repository. */ - "git-tree": { - sha: string; + 'git-tree': { + sha: string /** Format: uri */ - url: string; - truncated: boolean; + url: string + truncated: boolean /** * @description Objects specifying a tree structure * @example [object Object] */ tree: ({ /** @example test/file.rb */ - path?: string; + path?: string /** @example 040000 */ - mode?: string; + mode?: string /** @example tree */ - type?: string; + type?: string /** @example 23f6827669e43831def8a7ad935069c8bd418261 */ - sha?: string; + sha?: string /** @example 12 */ - size?: number; + size?: number /** @example https://api.github.com/repos/owner-482f3203ecf01f67e9deb18e/BBB_Private_Repo/git/blobs/23f6827669e43831def8a7ad935069c8bd418261 */ - url?: string; - } & { [key: string]: unknown })[]; - } & { [key: string]: unknown }; + url?: string + } & { [key: string]: unknown })[] + } & { [key: string]: unknown } /** Hook Response */ - "hook-response": { - code: number | null; - status: string | null; - message: string | null; - } & { [key: string]: unknown }; + 'hook-response': { + code: number | null + status: string | null + message: string | null + } & { [key: string]: unknown } /** * Webhook * @description Webhooks for repositories. */ hook: { - type: string; + type: string /** * @description Unique identifier of the webhook. * @example 42 */ - id: number; + id: number /** * @description The name of a valid service, use 'web' for a webhook. * @example web */ - name: string; + name: string /** * @description Determines whether the hook is actually triggered on pushes. * @example true */ - active: boolean; + active: boolean /** * @description Determines what events the hook is triggered for. Default: ['push']. * @example push,pull_request */ - events: string[]; + events: string[] config: { /** @example "foo@bar.com" */ - email?: string; + email?: string /** @example "foo" */ - password?: string; + password?: string /** @example "roomer" */ - room?: string; + room?: string /** @example "foo" */ - subdomain?: string; - url?: components["schemas"]["webhook-config-url"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - content_type?: components["schemas"]["webhook-config-content-type"]; + subdomain?: string + url?: components['schemas']['webhook-config-url'] + insecure_ssl?: components['schemas']['webhook-config-insecure-ssl'] + content_type?: components['schemas']['webhook-config-content-type'] /** @example "sha256" */ - digest?: string; - secret?: components["schemas"]["webhook-config-secret"]; + digest?: string + secret?: components['schemas']['webhook-config-secret'] /** @example "abc" */ - token?: string; - } & { [key: string]: unknown }; + token?: string + } & { [key: string]: unknown } /** * Format: date-time * @example 2011-09-06T20:39:23Z */ - updated_at: string; + updated_at: string /** * Format: date-time * @example 2011-09-06T17:26:27Z */ - created_at: string; + created_at: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1 */ - url: string; + url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/test */ - test_url: string; + test_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/pings */ - ping_url: string; + ping_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries */ - deliveries_url?: string; - last_response: components["schemas"]["hook-response"]; - } & { [key: string]: unknown }; + deliveries_url?: string + last_response: components['schemas']['hook-response'] + } & { [key: string]: unknown } /** * Import * @description A repository import from an external source. */ import: { - vcs: string | null; - use_lfs?: boolean; + vcs: string | null + use_lfs?: boolean /** @description The URL of the originating repository. */ - vcs_url: string; - svc_root?: string; - tfvc_project?: string; + vcs_url: string + svc_root?: string + tfvc_project?: string /** @enum {string} */ status: - | "auth" - | "error" - | "none" - | "detecting" - | "choose" - | "auth_failed" - | "importing" - | "mapping" - | "waiting_to_push" - | "pushing" - | "complete" - | "setup" - | "unknown" - | "detection_found_multiple" - | "detection_found_nothing" - | "detection_needs_auth"; - status_text?: string | null; - failed_step?: string | null; - error_message?: string | null; - import_percent?: number | null; - commit_count?: number | null; - push_percent?: number | null; - has_large_files?: boolean; - large_files_size?: number; - large_files_count?: number; + | 'auth' + | 'error' + | 'none' + | 'detecting' + | 'choose' + | 'auth_failed' + | 'importing' + | 'mapping' + | 'waiting_to_push' + | 'pushing' + | 'complete' + | 'setup' + | 'unknown' + | 'detection_found_multiple' + | 'detection_found_nothing' + | 'detection_needs_auth' + status_text?: string | null + failed_step?: string | null + error_message?: string | null + import_percent?: number | null + commit_count?: number | null + push_percent?: number | null + has_large_files?: boolean + large_files_size?: number + large_files_count?: number project_choices?: ({ - vcs?: string; - tfvc_project?: string; - human_name?: string; - } & { [key: string]: unknown })[]; - message?: string; - authors_count?: number | null; + vcs?: string + tfvc_project?: string + human_name?: string + } & { [key: string]: unknown })[] + message?: string + authors_count?: number | null /** Format: uri */ - url: string; + url: string /** Format: uri */ - html_url: string; + html_url: string /** Format: uri */ - authors_url: string; + authors_url: string /** Format: uri */ - repository_url: string; - svn_root?: string; - } & { [key: string]: unknown }; + repository_url: string + svn_root?: string + } & { [key: string]: unknown } /** * Porter Author * @description Porter Author */ - "porter-author": { - id: number; - remote_id: string; - remote_name: string; - email: string; - name: string; + 'porter-author': { + id: number + remote_id: string + remote_name: string + email: string + name: string /** Format: uri */ - url: string; + url: string /** Format: uri */ - import_url: string; - } & { [key: string]: unknown }; + import_url: string + } & { [key: string]: unknown } /** * Porter Large File * @description Porter Large File */ - "porter-large-file": { - ref_name: string; - path: string; - oid: string; - size: number; - } & { [key: string]: unknown }; + 'porter-large-file': { + ref_name: string + path: string + oid: string + size: number + } & { [key: string]: unknown } /** * Issue * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. */ - "nullable-issue": + 'nullable-issue': | ({ - id: number; - node_id: string; + id: number + node_id: string /** * Format: uri * @description URL for the issue * @example https://api.github.com/repositories/42/issues/1 */ - url: string; + url: string /** Format: uri */ - repository_url: string; - labels_url: string; + repository_url: string + labels_url: string /** Format: uri */ - comments_url: string; + comments_url: string /** Format: uri */ - events_url: string; + events_url: string /** Format: uri */ - html_url: string; + html_url: string /** * @description Number uniquely identifying the issue within its repository * @example 42 */ - number: number; + number: number /** * @description State of the issue; either 'open' or 'closed' * @example open */ - state: string; + state: string /** * @description Title of the issue * @example Widget creation fails in Safari on OS X 10.8 */ - title: string; + title: string /** * @description Contents of the issue * @example It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug? */ - body?: string | null; - user: components["schemas"]["nullable-simple-user"]; + body?: string | null + user: components['schemas']['nullable-simple-user'] /** * @description Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository * @example bug,registration @@ -14341,457 +14321,457 @@ export interface components { | string | ({ /** Format: int64 */ - id?: number; - node_id?: string; + id?: number + node_id?: string /** Format: uri */ - url?: string; - name?: string; - description?: string | null; - color?: string | null; - default?: boolean; + url?: string + name?: string + description?: string | null + color?: string | null + default?: boolean } & { [key: string]: unknown }) - ) & { [key: string]: unknown })[]; - assignee: components["schemas"]["nullable-simple-user"]; - assignees?: components["schemas"]["simple-user"][] | null; - milestone: components["schemas"]["nullable-milestone"]; - locked: boolean; - active_lock_reason?: string | null; - comments: number; + ) & { [key: string]: unknown })[] + assignee: components['schemas']['nullable-simple-user'] + assignees?: components['schemas']['simple-user'][] | null + milestone: components['schemas']['nullable-milestone'] + locked: boolean + active_lock_reason?: string | null + comments: number pull_request?: { /** Format: date-time */ - merged_at?: string | null; + merged_at?: string | null /** Format: uri */ - diff_url: string | null; + diff_url: string | null /** Format: uri */ - html_url: string | null; + html_url: string | null /** Format: uri */ - patch_url: string | null; + patch_url: string | null /** Format: uri */ - url: string | null; - } & { [key: string]: unknown }; + url: string | null + } & { [key: string]: unknown } /** Format: date-time */ - closed_at: string | null; + closed_at: string | null /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - draft?: boolean; - closed_by?: components["schemas"]["nullable-simple-user"]; - body_html?: string; - body_text?: string; + updated_at: string + draft?: boolean + closed_by?: components['schemas']['nullable-simple-user'] + body_html?: string + body_text?: string /** Format: uri */ - timeline_url?: string; - repository?: components["schemas"]["repository"]; - performed_via_github_app?: components["schemas"]["nullable-integration"]; - author_association: components["schemas"]["author_association"]; - reactions?: components["schemas"]["reaction-rollup"]; + timeline_url?: string + repository?: components['schemas']['repository'] + performed_via_github_app?: components['schemas']['nullable-integration'] + author_association: components['schemas']['author_association'] + reactions?: components['schemas']['reaction-rollup'] } & { [key: string]: unknown }) - | null; + | null /** * Issue Event Label * @description Issue Event Label */ - "issue-event-label": { - name: string | null; - color: string | null; - } & { [key: string]: unknown }; + 'issue-event-label': { + name: string | null + color: string | null + } & { [key: string]: unknown } /** Issue Event Dismissed Review */ - "issue-event-dismissed-review": { - state: string; - review_id: number; - dismissal_message: string | null; - dismissal_commit_id?: string | null; - } & { [key: string]: unknown }; + 'issue-event-dismissed-review': { + state: string + review_id: number + dismissal_message: string | null + dismissal_commit_id?: string | null + } & { [key: string]: unknown } /** * Issue Event Milestone * @description Issue Event Milestone */ - "issue-event-milestone": { - title: string; - } & { [key: string]: unknown }; + 'issue-event-milestone': { + title: string + } & { [key: string]: unknown } /** * Issue Event Project Card * @description Issue Event Project Card */ - "issue-event-project-card": { + 'issue-event-project-card': { /** Format: uri */ - url: string; - id: number; + url: string + id: number /** Format: uri */ - project_url: string; - project_id: number; - column_name: string; - previous_column_name?: string; - } & { [key: string]: unknown }; + project_url: string + project_id: number + column_name: string + previous_column_name?: string + } & { [key: string]: unknown } /** * Issue Event Rename * @description Issue Event Rename */ - "issue-event-rename": { - from: string; - to: string; - } & { [key: string]: unknown }; + 'issue-event-rename': { + from: string + to: string + } & { [key: string]: unknown } /** * Issue Event * @description Issue Event */ - "issue-event": { + 'issue-event': { /** @example 1 */ - id: number; + id: number /** @example MDEwOklzc3VlRXZlbnQx */ - node_id: string; + node_id: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/events/1 */ - url: string; - actor: components["schemas"]["nullable-simple-user"]; + url: string + actor: components['schemas']['nullable-simple-user'] /** @example closed */ - event: string; + event: string /** @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */ - commit_id: string | null; + commit_id: string | null /** @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e */ - commit_url: string | null; + commit_url: string | null /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - created_at: string; - issue?: components["schemas"]["nullable-issue"]; - label?: components["schemas"]["issue-event-label"]; - assignee?: components["schemas"]["nullable-simple-user"]; - assigner?: components["schemas"]["nullable-simple-user"]; - review_requester?: components["schemas"]["nullable-simple-user"]; - requested_reviewer?: components["schemas"]["nullable-simple-user"]; - requested_team?: components["schemas"]["team"]; - dismissed_review?: components["schemas"]["issue-event-dismissed-review"]; - milestone?: components["schemas"]["issue-event-milestone"]; - project_card?: components["schemas"]["issue-event-project-card"]; - rename?: components["schemas"]["issue-event-rename"]; - author_association?: components["schemas"]["author_association"]; - lock_reason?: string | null; - performed_via_github_app?: components["schemas"]["nullable-integration"]; - } & { [key: string]: unknown }; + created_at: string + issue?: components['schemas']['nullable-issue'] + label?: components['schemas']['issue-event-label'] + assignee?: components['schemas']['nullable-simple-user'] + assigner?: components['schemas']['nullable-simple-user'] + review_requester?: components['schemas']['nullable-simple-user'] + requested_reviewer?: components['schemas']['nullable-simple-user'] + requested_team?: components['schemas']['team'] + dismissed_review?: components['schemas']['issue-event-dismissed-review'] + milestone?: components['schemas']['issue-event-milestone'] + project_card?: components['schemas']['issue-event-project-card'] + rename?: components['schemas']['issue-event-rename'] + author_association?: components['schemas']['author_association'] + lock_reason?: string | null + performed_via_github_app?: components['schemas']['nullable-integration'] + } & { [key: string]: unknown } /** * Labeled Issue Event * @description Labeled Issue Event */ - "labeled-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; + 'labeled-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] label: { - name: string; - color: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + name: string + color: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** * Unlabeled Issue Event * @description Unlabeled Issue Event */ - "unlabeled-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; + 'unlabeled-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] label: { - name: string; - color: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + name: string + color: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** * Assigned Issue Event * @description Assigned Issue Event */ - "assigned-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["integration"]; - assignee: components["schemas"]["simple-user"]; - assigner: components["schemas"]["simple-user"]; - } & { [key: string]: unknown }; + 'assigned-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['integration'] + assignee: components['schemas']['simple-user'] + assigner: components['schemas']['simple-user'] + } & { [key: string]: unknown } /** * Unassigned Issue Event * @description Unassigned Issue Event */ - "unassigned-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; - assignee: components["schemas"]["simple-user"]; - assigner: components["schemas"]["simple-user"]; - } & { [key: string]: unknown }; + 'unassigned-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] + assignee: components['schemas']['simple-user'] + assigner: components['schemas']['simple-user'] + } & { [key: string]: unknown } /** * Milestoned Issue Event * @description Milestoned Issue Event */ - "milestoned-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; + 'milestoned-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] milestone: { - title: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + title: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** * Demilestoned Issue Event * @description Demilestoned Issue Event */ - "demilestoned-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; + 'demilestoned-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] milestone: { - title: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + title: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** * Renamed Issue Event * @description Renamed Issue Event */ - "renamed-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; + 'renamed-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] rename: { - from: string; - to: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + from: string + to: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** * Review Requested Issue Event * @description Review Requested Issue Event */ - "review-requested-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; - review_requester: components["schemas"]["simple-user"]; - requested_team?: components["schemas"]["team"]; - requested_reviewer?: components["schemas"]["simple-user"]; - } & { [key: string]: unknown }; + 'review-requested-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] + review_requester: components['schemas']['simple-user'] + requested_team?: components['schemas']['team'] + requested_reviewer?: components['schemas']['simple-user'] + } & { [key: string]: unknown } /** * Review Request Removed Issue Event * @description Review Request Removed Issue Event */ - "review-request-removed-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; - review_requester: components["schemas"]["simple-user"]; - requested_team?: components["schemas"]["team"]; - requested_reviewer?: components["schemas"]["simple-user"]; - } & { [key: string]: unknown }; + 'review-request-removed-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] + review_requester: components['schemas']['simple-user'] + requested_team?: components['schemas']['team'] + requested_reviewer?: components['schemas']['simple-user'] + } & { [key: string]: unknown } /** * Review Dismissed Issue Event * @description Review Dismissed Issue Event */ - "review-dismissed-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; + 'review-dismissed-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] dismissed_review: { - state: string; - review_id: number; - dismissal_message: string | null; - dismissal_commit_id?: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + state: string + review_id: number + dismissal_message: string | null + dismissal_commit_id?: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** * Locked Issue Event * @description Locked Issue Event */ - "locked-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; + 'locked-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] /** @example "off-topic" */ - lock_reason: string | null; - } & { [key: string]: unknown }; + lock_reason: string | null + } & { [key: string]: unknown } /** * Added to Project Issue Event * @description Added to Project Issue Event */ - "added-to-project-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; + 'added-to-project-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] project_card?: { - id: number; + id: number /** Format: uri */ - url: string; - project_id: number; + url: string + project_id: number /** Format: uri */ - project_url: string; - column_name: string; - previous_column_name?: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + project_url: string + column_name: string + previous_column_name?: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** * Moved Column in Project Issue Event * @description Moved Column in Project Issue Event */ - "moved-column-in-project-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; + 'moved-column-in-project-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] project_card?: { - id: number; + id: number /** Format: uri */ - url: string; - project_id: number; + url: string + project_id: number /** Format: uri */ - project_url: string; - column_name: string; - previous_column_name?: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + project_url: string + column_name: string + previous_column_name?: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** * Removed from Project Issue Event * @description Removed from Project Issue Event */ - "removed-from-project-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; + 'removed-from-project-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] project_card?: { - id: number; + id: number /** Format: uri */ - url: string; - project_id: number; + url: string + project_id: number /** Format: uri */ - project_url: string; - column_name: string; - previous_column_name?: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + project_url: string + column_name: string + previous_column_name?: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** * Converted Note to Issue Issue Event * @description Converted Note to Issue Issue Event */ - "converted-note-to-issue-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["integration"]; + 'converted-note-to-issue-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['integration'] project_card?: { - id: number; + id: number /** Format: uri */ - url: string; - project_id: number; + url: string + project_id: number /** Format: uri */ - project_url: string; - column_name: string; - previous_column_name?: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + project_url: string + column_name: string + previous_column_name?: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** * Issue Event for Issue * @description Issue Event for Issue */ - "issue-event-for-issue": (Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial) & { [key: string]: unknown }; + 'issue-event-for-issue': (Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial) & { [key: string]: unknown } /** * Label * @description Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -14801,105 +14781,105 @@ export interface components { * Format: int64 * @example 208045946 */ - id: number; + id: number /** @example MDU6TGFiZWwyMDgwNDU5NDY= */ - node_id: string; + node_id: string /** * Format: uri * @description URL for the label * @example https://api.github.com/repositories/42/labels/bug */ - url: string; + url: string /** * @description The name of the label. * @example bug */ - name: string; + name: string /** @example Something isn't working */ - description: string | null; + description: string | null /** * @description 6-character hex code, without the leading #, identifying the color * @example FFFFFF */ - color: string; + color: string /** @example true */ - default: boolean; - } & { [key: string]: unknown }; + default: boolean + } & { [key: string]: unknown } /** * Timeline Comment Event * @description Timeline Comment Event */ - "timeline-comment-event": { - event: string; - actor: components["schemas"]["simple-user"]; + 'timeline-comment-event': { + event: string + actor: components['schemas']['simple-user'] /** * @description Unique identifier of the issue comment * @example 42 */ - id: number; - node_id: string; + id: number + node_id: string /** * Format: uri * @description URL for the issue comment * @example https://api.github.com/repositories/42/issues/comments/1 */ - url: string; + url: string /** * @description Contents of the issue comment * @example What version of Safari were you using when you observed this bug? */ - body?: string; - body_text?: string; - body_html?: string; + body?: string + body_text?: string + body_html?: string /** Format: uri */ - html_url: string; - user: components["schemas"]["simple-user"]; + html_url: string + user: components['schemas']['simple-user'] /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - updated_at: string; + updated_at: string /** Format: uri */ - issue_url: string; - author_association: components["schemas"]["author_association"]; - performed_via_github_app?: components["schemas"]["nullable-integration"]; - reactions?: components["schemas"]["reaction-rollup"]; - } & { [key: string]: unknown }; + issue_url: string + author_association: components['schemas']['author_association'] + performed_via_github_app?: components['schemas']['nullable-integration'] + reactions?: components['schemas']['reaction-rollup'] + } & { [key: string]: unknown } /** * Timeline Cross Referenced Event * @description Timeline Cross Referenced Event */ - "timeline-cross-referenced-event": { - event: string; - actor?: components["schemas"]["simple-user"]; + 'timeline-cross-referenced-event': { + event: string + actor?: components['schemas']['simple-user'] /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; + updated_at: string source: { - type?: string; - issue?: components["schemas"]["issue"]; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + type?: string + issue?: components['schemas']['issue'] + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** * Timeline Committed Event * @description Timeline Committed Event */ - "timeline-committed-event": { - event?: string; + 'timeline-committed-event': { + event?: string /** * @description SHA for the commit * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - sha: string; - node_id: string; + sha: string + node_id: string /** Format: uri */ - url: string; + url: string /** @description Identifying information for the git-user */ author: { /** @@ -14907,18 +14887,18 @@ export interface components { * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 */ - date: string; + date: string /** * @description Git email address of the user * @example monalisa.octocat@example.com */ - email: string; + email: string /** * @description Name of the git user * @example Monalisa Octocat */ - name: string; - } & { [key: string]: unknown }; + name: string + } & { [key: string]: unknown } /** @description Identifying information for the git-user */ committer: { /** @@ -14926,386 +14906,386 @@ export interface components { * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 */ - date: string; + date: string /** * @description Git email address of the user * @example monalisa.octocat@example.com */ - email: string; + email: string /** * @description Name of the git user * @example Monalisa Octocat */ - name: string; - } & { [key: string]: unknown }; + name: string + } & { [key: string]: unknown } /** * @description Message describing the purpose of the commit * @example Fix #42 */ - message: string; + message: string tree: { /** * @description SHA for the commit * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - sha: string; + sha: string /** Format: uri */ - url: string; - } & { [key: string]: unknown }; + url: string + } & { [key: string]: unknown } parents: ({ /** * @description SHA for the commit * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - sha: string; + sha: string /** Format: uri */ - url: string; + url: string /** Format: uri */ - html_url: string; - } & { [key: string]: unknown })[]; + html_url: string + } & { [key: string]: unknown })[] verification: { - verified: boolean; - reason: string; - signature: string | null; - payload: string | null; - } & { [key: string]: unknown }; + verified: boolean + reason: string + signature: string | null + payload: string | null + } & { [key: string]: unknown } /** Format: uri */ - html_url: string; - } & { [key: string]: unknown }; + html_url: string + } & { [key: string]: unknown } /** * Timeline Reviewed Event * @description Timeline Reviewed Event */ - "timeline-reviewed-event": { - event: string; + 'timeline-reviewed-event': { + event: string /** * @description Unique identifier of the review * @example 42 */ - id: number; + id: number /** @example MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= */ - node_id: string; - user: components["schemas"]["simple-user"]; + node_id: string + user: components['schemas']['simple-user'] /** * @description The text of the review. * @example This looks great. */ - body: string | null; + body: string | null /** @example CHANGES_REQUESTED */ - state: string; + state: string /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/12 */ - pull_request_url: string; + pull_request_url: string _links: { html: { - href: string; - } & { [key: string]: unknown }; + href: string + } & { [key: string]: unknown } pull_request: { - href: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + href: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** Format: date-time */ - submitted_at?: string; + submitted_at?: string /** * @description A commit SHA for the review. * @example 54bb654c9e6025347f57900a4a5c2313a96b8035 */ - commit_id: string; - body_html?: string; - body_text?: string; - author_association: components["schemas"]["author_association"]; - } & { [key: string]: unknown }; + commit_id: string + body_html?: string + body_text?: string + author_association: components['schemas']['author_association'] + } & { [key: string]: unknown } /** * Pull Request Review Comment * @description Pull Request Review Comments are comments on a portion of the Pull Request's diff. */ - "pull-request-review-comment": { + 'pull-request-review-comment': { /** * @description URL for the pull request review comment * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ - url: string; + url: string /** * @description The ID of the pull request review to which the comment belongs. * @example 42 */ - pull_request_review_id: number | null; + pull_request_review_id: number | null /** * @description The ID of the pull request review comment. * @example 1 */ - id: number; + id: number /** * @description The node ID of the pull request review comment. * @example MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw */ - node_id: string; + node_id: string /** * @description The diff of the line that the comment refers to. * @example @@ -16,33 +16,40 @@ public class Connection : IConnection... */ - diff_hunk: string; + diff_hunk: string /** * @description The relative path of the file to which the comment applies. * @example config/database.yaml */ - path: string; + path: string /** * @description The line index in the diff to which the comment applies. * @example 1 */ - position: number; + position: number /** * @description The index of the original line in the diff to which the comment applies. * @example 4 */ - original_position: number; + original_position: number /** * @description The SHA of the commit to which the comment applies. * @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */ - commit_id: string; + commit_id: string /** * @description The SHA of the original commit to which the comment applies. * @example 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 */ - original_commit_id: string; + original_commit_id: string /** * @description The comment ID to reply to. * @example 8 */ - in_reply_to_id?: number; - user: components["schemas"]["simple-user"]; + in_reply_to_id?: number + user: components['schemas']['simple-user'] /** * @description The text of the comment. * @example We should probably include a check for null values here. */ - body: string; + body: string /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - updated_at: string; + updated_at: string /** * Format: uri * @description HTML URL for the pull request review comment. * @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 */ - html_url: string; + html_url: string /** * Format: uri * @description URL for the pull request that the review comment belongs to. * @example https://api.github.com/repos/octocat/Hello-World/pulls/1 */ - pull_request_url: string; - author_association: components["schemas"]["author_association"]; + pull_request_url: string + author_association: components['schemas']['author_association'] _links: { self: { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ - href: string; - } & { [key: string]: unknown }; + href: string + } & { [key: string]: unknown } html: { /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 */ - href: string; - } & { [key: string]: unknown }; + href: string + } & { [key: string]: unknown } pull_request: { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1 */ - href: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + href: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** * @description The first line of the range for a multi-line comment. * @example 2 */ - start_line?: number | null; + start_line?: number | null /** * @description The first line of the range for a multi-line comment. * @example 2 */ - original_start_line?: number | null; + original_start_line?: number | null /** * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} */ - start_side?: ("LEFT" | "RIGHT") | null; + start_side?: ('LEFT' | 'RIGHT') | null /** * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment * @example 2 */ - line?: number; + line?: number /** * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment * @example 2 */ - original_line?: number; + original_line?: number /** * @description The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment * @default RIGHT * @enum {string} */ - side?: "LEFT" | "RIGHT"; - reactions?: components["schemas"]["reaction-rollup"]; + side?: 'LEFT' | 'RIGHT' + reactions?: components['schemas']['reaction-rollup'] /** @example "

comment body

" */ - body_html?: string; + body_html?: string /** @example "comment body" */ - body_text?: string; - } & { [key: string]: unknown }; + body_text?: string + } & { [key: string]: unknown } /** * Timeline Line Commented Event * @description Timeline Line Commented Event */ - "timeline-line-commented-event": { - event?: string; - node_id?: string; - comments?: components["schemas"]["pull-request-review-comment"][]; - } & { [key: string]: unknown }; + 'timeline-line-commented-event': { + event?: string + node_id?: string + comments?: components['schemas']['pull-request-review-comment'][] + } & { [key: string]: unknown } /** * Timeline Commit Commented Event * @description Timeline Commit Commented Event */ - "timeline-commit-commented-event": { - event?: string; - node_id?: string; - commit_id?: string; - comments?: components["schemas"]["commit-comment"][]; - } & { [key: string]: unknown }; + 'timeline-commit-commented-event': { + event?: string + node_id?: string + commit_id?: string + comments?: components['schemas']['commit-comment'][] + } & { [key: string]: unknown } /** * Timeline Assigned Issue Event * @description Timeline Assigned Issue Event */ - "timeline-assigned-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; - assignee: components["schemas"]["simple-user"]; - } & { [key: string]: unknown }; + 'timeline-assigned-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] + assignee: components['schemas']['simple-user'] + } & { [key: string]: unknown } /** * Timeline Unassigned Issue Event * @description Timeline Unassigned Issue Event */ - "timeline-unassigned-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; - assignee: components["schemas"]["simple-user"]; - } & { [key: string]: unknown }; + 'timeline-unassigned-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] + assignee: components['schemas']['simple-user'] + } & { [key: string]: unknown } /** * Timeline Event * @description Timeline Event */ - "timeline-issue-events": (Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial) & { [key: string]: unknown }; + 'timeline-issue-events': (Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial) & { [key: string]: unknown } /** * Deploy Key * @description An SSH key granting access to a single repository. */ - "deploy-key": { - id: number; - key: string; - url: string; - title: string; - verified: boolean; - created_at: string; - read_only: boolean; - } & { [key: string]: unknown }; + 'deploy-key': { + id: number + key: string + url: string + title: string + verified: boolean + created_at: string + read_only: boolean + } & { [key: string]: unknown } /** * Language * @description Language */ - language: { [key: string]: number }; + language: { [key: string]: number } /** * License Content * @description License Content */ - "license-content": { - name: string; - path: string; - sha: string; - size: number; + 'license-content': { + name: string + path: string + sha: string + size: number /** Format: uri */ - url: string; + url: string /** Format: uri */ - html_url: string | null; + html_url: string | null /** Format: uri */ - git_url: string | null; + git_url: string | null /** Format: uri */ - download_url: string | null; - type: string; - content: string; - encoding: string; + download_url: string | null + type: string + content: string + encoding: string _links: { /** Format: uri */ - git: string | null; + git: string | null /** Format: uri */ - html: string | null; + html: string | null /** Format: uri */ - self: string; - } & { [key: string]: unknown }; - license: components["schemas"]["nullable-license-simple"]; - } & { [key: string]: unknown }; + self: string + } & { [key: string]: unknown } + license: components['schemas']['nullable-license-simple'] + } & { [key: string]: unknown } /** * Merged upstream * @description Results of a successful merge upstream request */ - "merged-upstream": { - message?: string; + 'merged-upstream': { + message?: string /** @enum {string} */ - merge_type?: "merge" | "fast-forward" | "none"; - base_branch?: string; - } & { [key: string]: unknown }; + merge_type?: 'merge' | 'fast-forward' | 'none' + base_branch?: string + } & { [key: string]: unknown } /** * Milestone * @description A collection of related issues and pull requests. @@ -15315,100 +15295,100 @@ export interface components { * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1 */ - url: string; + url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/milestones/v1.0 */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1/labels */ - labels_url: string; + labels_url: string /** @example 1002604 */ - id: number; + id: number /** @example MDk6TWlsZXN0b25lMTAwMjYwNA== */ - node_id: string; + node_id: string /** * @description The number of the milestone. * @example 42 */ - number: number; + number: number /** * @description The state of the milestone. * @default open * @example open * @enum {string} */ - state: "open" | "closed"; + state: 'open' | 'closed' /** * @description The title of the milestone. * @example v1.0 */ - title: string; + title: string /** @example Tracking milestone for version 1.0 */ - description: string | null; - creator: components["schemas"]["nullable-simple-user"]; + description: string | null + creator: components['schemas']['nullable-simple-user'] /** @example 4 */ - open_issues: number; + open_issues: number /** @example 8 */ - closed_issues: number; + closed_issues: number /** * Format: date-time * @example 2011-04-10T20:09:31Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2014-03-03T18:58:10Z */ - updated_at: string; + updated_at: string /** * Format: date-time * @example 2013-02-12T13:22:01Z */ - closed_at: string | null; + closed_at: string | null /** * Format: date-time * @example 2012-10-09T23:39:01Z */ - due_on: string | null; - } & { [key: string]: unknown }; + due_on: string | null + } & { [key: string]: unknown } /** Pages Source Hash */ - "pages-source-hash": { - branch: string; - path: string; - } & { [key: string]: unknown }; + 'pages-source-hash': { + branch: string + path: string + } & { [key: string]: unknown } /** Pages Https Certificate */ - "pages-https-certificate": { + 'pages-https-certificate': { /** * @example approved * @enum {string} */ state: - | "new" - | "authorization_created" - | "authorization_pending" - | "authorized" - | "authorization_revoked" - | "issued" - | "uploaded" - | "approved" - | "errored" - | "bad_authz" - | "destroy_pending" - | "dns_changed"; + | 'new' + | 'authorization_created' + | 'authorization_pending' + | 'authorized' + | 'authorization_revoked' + | 'issued' + | 'uploaded' + | 'approved' + | 'errored' + | 'bad_authz' + | 'destroy_pending' + | 'dns_changed' /** @example Certificate is approved */ - description: string; + description: string /** * @description Array of the domain set and its alternate name (if it is configured) * @example example.com,www.example.com */ - domains: string[]; + domains: string[] /** Format: date */ - expires_at?: string; - } & { [key: string]: unknown }; + expires_at?: string + } & { [key: string]: unknown } /** * GitHub Pages * @description The configuration for GitHub Pages for a repository. @@ -15419,1973 +15399,1973 @@ export interface components { * @description The API address for accessing this Page resource. * @example https://api.github.com/repos/github/hello-world/pages */ - url: string; + url: string /** * @description The status of the most recent build of the Page. * @example built * @enum {string|null} */ - status: ("built" | "building" | "errored") | null; + status: ('built' | 'building' | 'errored') | null /** * @description The Pages site's custom domain * @example example.com */ - cname: string | null; + cname: string | null /** * @description The state if the domain is verified * @example pending * @enum {string|null} */ - protected_domain_state?: ("pending" | "verified" | "unverified") | null; + protected_domain_state?: ('pending' | 'verified' | 'unverified') | null /** * Format: date-time * @description The timestamp when a pending domain becomes unverified. */ - pending_domain_unverified_at?: string | null; + pending_domain_unverified_at?: string | null /** @description Whether the Page has a custom 404 page. */ - custom_404: boolean; + custom_404: boolean /** * Format: uri * @description The web address the Page can be accessed from. * @example https://example.com */ - html_url?: string; - source?: components["schemas"]["pages-source-hash"]; + html_url?: string + source?: components['schemas']['pages-source-hash'] /** * @description Whether the GitHub Pages site is publicly visible. If set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. * @example true */ - public: boolean; - https_certificate?: components["schemas"]["pages-https-certificate"]; + public: boolean + https_certificate?: components['schemas']['pages-https-certificate'] /** * @description Whether https is enabled on the domain * @example true */ - https_enforced?: boolean; - } & { [key: string]: unknown }; + https_enforced?: boolean + } & { [key: string]: unknown } /** * Page Build * @description Page Build */ - "page-build": { + 'page-build': { /** Format: uri */ - url: string; - status: string; + url: string + status: string error: { - message: string | null; - } & { [key: string]: unknown }; - pusher: components["schemas"]["nullable-simple-user"]; - commit: string; - duration: number; + message: string | null + } & { [key: string]: unknown } + pusher: components['schemas']['nullable-simple-user'] + commit: string + duration: number /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - } & { [key: string]: unknown }; + updated_at: string + } & { [key: string]: unknown } /** * Page Build Status * @description Page Build Status */ - "page-build-status": { + 'page-build-status': { /** * Format: uri * @example https://api.github.com/repos/github/hello-world/pages/builds/latest */ - url: string; + url: string /** @example queued */ - status: string; - } & { [key: string]: unknown }; + status: string + } & { [key: string]: unknown } /** * Pages Health Check Status * @description Pages Health Check Status */ - "pages-health-check": { + 'pages-health-check': { domain?: { - host?: string; - uri?: string; - nameservers?: string; - dns_resolves?: boolean; - is_proxied?: boolean | null; - is_cloudflare_ip?: boolean | null; - is_fastly_ip?: boolean | null; - is_old_ip_address?: boolean | null; - is_a_record?: boolean | null; - has_cname_record?: boolean | null; - has_mx_records_present?: boolean | null; - is_valid_domain?: boolean; - is_apex_domain?: boolean; - should_be_a_record?: boolean | null; - is_cname_to_github_user_domain?: boolean | null; - is_cname_to_pages_dot_github_dot_com?: boolean | null; - is_cname_to_fastly?: boolean | null; - is_pointed_to_github_pages_ip?: boolean | null; - is_non_github_pages_ip_present?: boolean | null; - is_pages_domain?: boolean; - is_served_by_pages?: boolean | null; - is_valid?: boolean; - reason?: string | null; - responds_to_https?: boolean; - enforces_https?: boolean; - https_error?: string | null; - is_https_eligible?: boolean | null; - caa_error?: string | null; - } & { [key: string]: unknown }; + host?: string + uri?: string + nameservers?: string + dns_resolves?: boolean + is_proxied?: boolean | null + is_cloudflare_ip?: boolean | null + is_fastly_ip?: boolean | null + is_old_ip_address?: boolean | null + is_a_record?: boolean | null + has_cname_record?: boolean | null + has_mx_records_present?: boolean | null + is_valid_domain?: boolean + is_apex_domain?: boolean + should_be_a_record?: boolean | null + is_cname_to_github_user_domain?: boolean | null + is_cname_to_pages_dot_github_dot_com?: boolean | null + is_cname_to_fastly?: boolean | null + is_pointed_to_github_pages_ip?: boolean | null + is_non_github_pages_ip_present?: boolean | null + is_pages_domain?: boolean + is_served_by_pages?: boolean | null + is_valid?: boolean + reason?: string | null + responds_to_https?: boolean + enforces_https?: boolean + https_error?: string | null + is_https_eligible?: boolean | null + caa_error?: string | null + } & { [key: string]: unknown } alt_domain?: | ({ - host?: string; - uri?: string; - nameservers?: string; - dns_resolves?: boolean; - is_proxied?: boolean | null; - is_cloudflare_ip?: boolean | null; - is_fastly_ip?: boolean | null; - is_old_ip_address?: boolean | null; - is_a_record?: boolean | null; - has_cname_record?: boolean | null; - has_mx_records_present?: boolean | null; - is_valid_domain?: boolean; - is_apex_domain?: boolean; - should_be_a_record?: boolean | null; - is_cname_to_github_user_domain?: boolean | null; - is_cname_to_pages_dot_github_dot_com?: boolean | null; - is_cname_to_fastly?: boolean | null; - is_pointed_to_github_pages_ip?: boolean | null; - is_non_github_pages_ip_present?: boolean | null; - is_pages_domain?: boolean; - is_served_by_pages?: boolean | null; - is_valid?: boolean; - reason?: string | null; - responds_to_https?: boolean; - enforces_https?: boolean; - https_error?: string | null; - is_https_eligible?: boolean | null; - caa_error?: string | null; + host?: string + uri?: string + nameservers?: string + dns_resolves?: boolean + is_proxied?: boolean | null + is_cloudflare_ip?: boolean | null + is_fastly_ip?: boolean | null + is_old_ip_address?: boolean | null + is_a_record?: boolean | null + has_cname_record?: boolean | null + has_mx_records_present?: boolean | null + is_valid_domain?: boolean + is_apex_domain?: boolean + should_be_a_record?: boolean | null + is_cname_to_github_user_domain?: boolean | null + is_cname_to_pages_dot_github_dot_com?: boolean | null + is_cname_to_fastly?: boolean | null + is_pointed_to_github_pages_ip?: boolean | null + is_non_github_pages_ip_present?: boolean | null + is_pages_domain?: boolean + is_served_by_pages?: boolean | null + is_valid?: boolean + reason?: string | null + responds_to_https?: boolean + enforces_https?: boolean + https_error?: string | null + is_https_eligible?: boolean | null + caa_error?: string | null } & { [key: string]: unknown }) - | null; - } & { [key: string]: unknown }; + | null + } & { [key: string]: unknown } /** * Team Simple * @description Groups of organization members that gives permissions on specified repositories. */ - "team-simple": { + 'team-simple': { /** * @description Unique identifier of the team * @example 1 */ - id: number; + id: number /** @example MDQ6VGVhbTE= */ - node_id: string; + node_id: string /** * Format: uri * @description URL for the team * @example https://api.github.com/organizations/1/team/1 */ - url: string; + url: string /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - members_url: string; + members_url: string /** * @description Name of the team * @example Justice League */ - name: string; + name: string /** * @description Description of the team * @example A great team. */ - description: string | null; + description: string | null /** * @description Permission that the team will have for its repositories * @example admin */ - permission: string; + permission: string /** * @description The level of privacy this team should have * @example closed */ - privacy?: string; + privacy?: string /** * Format: uri * @example https://github.com/orgs/rails/teams/core */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/organizations/1/team/1/repos */ - repositories_url: string; + repositories_url: string /** @example justice-league */ - slug: string; + slug: string /** * @description Distinguished Name (DN) that team maps to within LDAP environment * @example uid=example,ou=users,dc=github,dc=com */ - ldap_dn?: string; - } & { [key: string]: unknown }; + ldap_dn?: string + } & { [key: string]: unknown } /** * Pull Request * @description Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary. */ - "pull-request": { + 'pull-request': { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ - url: string; + url: string /** @example 1 */ - id: number; + id: number /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ - node_id: string; + node_id: string /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347 */ - html_url: string; + html_url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.diff */ - diff_url: string; + diff_url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.patch */ - patch_url: string; + patch_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 */ - issue_url: string; + issue_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits */ - commits_url: string; + commits_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments */ - review_comments_url: string; + review_comments_url: string /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} */ - review_comment_url: string; + review_comment_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347/comments */ - comments_url: string; + comments_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e */ - statuses_url: string; + statuses_url: string /** * @description Number uniquely identifying the pull request within its repository. * @example 42 */ - number: number; + number: number /** * @description State of this Pull Request. Either `open` or `closed`. * @example open * @enum {string} */ - state: "open" | "closed"; + state: 'open' | 'closed' /** @example true */ - locked: boolean; + locked: boolean /** * @description The title of the pull request. * @example Amazing new feature */ - title: string; - user: components["schemas"]["nullable-simple-user"]; + title: string + user: components['schemas']['nullable-simple-user'] /** @example Please pull these awesome changes */ - body: string | null; + body: string | null labels: ({ /** Format: int64 */ - id: number; - node_id: string; - url: string; - name: string; - description: string | null; - color: string; - default: boolean; - } & { [key: string]: unknown })[]; - milestone: components["schemas"]["nullable-milestone"]; + id: number + node_id: string + url: string + name: string + description: string | null + color: string + default: boolean + } & { [key: string]: unknown })[] + milestone: components['schemas']['nullable-milestone'] /** @example too heated */ - active_lock_reason?: string | null; + active_lock_reason?: string | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - updated_at: string; + updated_at: string /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - closed_at: string | null; + closed_at: string | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - merged_at: string | null; + merged_at: string | null /** @example e5bd3914e2e596debea16f433f57875b5b90bcd6 */ - merge_commit_sha: string | null; - assignee: components["schemas"]["nullable-simple-user"]; - assignees?: components["schemas"]["simple-user"][] | null; - requested_reviewers?: components["schemas"]["simple-user"][] | null; - requested_teams?: components["schemas"]["team-simple"][] | null; + merge_commit_sha: string | null + assignee: components['schemas']['nullable-simple-user'] + assignees?: components['schemas']['simple-user'][] | null + requested_reviewers?: components['schemas']['simple-user'][] | null + requested_teams?: components['schemas']['team-simple'][] | null head: { - label: string; - ref: string; + label: string + ref: string repo: | ({ - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; + archive_url: string + assignees_url: string + blobs_url: string + branches_url: string + collaborators_url: string + comments_url: string + commits_url: string + compare_url: string + contents_url: string /** Format: uri */ - contributors_url: string; + contributors_url: string /** Format: uri */ - deployments_url: string; - description: string | null; + deployments_url: string + description: string | null /** Format: uri */ - downloads_url: string; + downloads_url: string /** Format: uri */ - events_url: string; - fork: boolean; + events_url: string + fork: boolean /** Format: uri */ - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; + forks_url: string + full_name: string + git_commits_url: string + git_refs_url: string + git_tags_url: string /** Format: uri */ - hooks_url: string; + hooks_url: string /** Format: uri */ - html_url: string; - id: number; - node_id: string; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; + html_url: string + id: number + node_id: string + issue_comment_url: string + issue_events_url: string + issues_url: string + keys_url: string + labels_url: string /** Format: uri */ - languages_url: string; + languages_url: string /** Format: uri */ - merges_url: string; - milestones_url: string; - name: string; - notifications_url: string; + merges_url: string + milestones_url: string + name: string + notifications_url: string owner: { /** Format: uri */ - avatar_url: string; - events_url: string; + avatar_url: string + events_url: string /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; + followers_url: string + following_url: string + gists_url: string + gravatar_id: string | null /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; + html_url: string + id: number + node_id: string + login: string /** Format: uri */ - organizations_url: string; + organizations_url: string /** Format: uri */ - received_events_url: string; + received_events_url: string /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; + repos_url: string + site_admin: boolean + starred_url: string /** Format: uri */ - subscriptions_url: string; - type: string; + subscriptions_url: string + type: string /** Format: uri */ - url: string; - } & { [key: string]: unknown }; - private: boolean; - pulls_url: string; - releases_url: string; + url: string + } & { [key: string]: unknown } + private: boolean + pulls_url: string + releases_url: string /** Format: uri */ - stargazers_url: string; - statuses_url: string; + stargazers_url: string + statuses_url: string /** Format: uri */ - subscribers_url: string; + subscribers_url: string /** Format: uri */ - subscription_url: string; + subscription_url: string /** Format: uri */ - tags_url: string; + tags_url: string /** Format: uri */ - teams_url: string; - trees_url: string; + teams_url: string + trees_url: string /** Format: uri */ - url: string; - clone_url: string; - default_branch: string; - forks: number; - forks_count: number; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_projects: boolean; - has_wiki: boolean; - has_pages: boolean; + url: string + clone_url: string + default_branch: string + forks: number + forks_count: number + git_url: string + has_downloads: boolean + has_issues: boolean + has_projects: boolean + has_wiki: boolean + has_pages: boolean /** Format: uri */ - homepage: string | null; - language: string | null; - master_branch?: string; - archived: boolean; - disabled: boolean; + homepage: string | null + language: string | null + master_branch?: string + archived: boolean + disabled: boolean /** @description The repository visibility: public, private, or internal. */ - visibility?: string; + visibility?: string /** Format: uri */ - mirror_url: string | null; - open_issues: number; - open_issues_count: number; + mirror_url: string | null + open_issues: number + open_issues_count: number permissions?: { - admin: boolean; - maintain?: boolean; - push: boolean; - triage?: boolean; - pull: boolean; - } & { [key: string]: unknown }; - temp_clone_token?: string; - allow_merge_commit?: boolean; - allow_squash_merge?: boolean; - allow_rebase_merge?: boolean; + admin: boolean + maintain?: boolean + push: boolean + triage?: boolean + pull: boolean + } & { [key: string]: unknown } + temp_clone_token?: string + allow_merge_commit?: boolean + allow_squash_merge?: boolean + allow_rebase_merge?: boolean license: | ({ - key: string; - name: string; + key: string + name: string /** Format: uri */ - url: string | null; - spdx_id: string | null; - node_id: string; + url: string | null + spdx_id: string | null + node_id: string } & { [key: string]: unknown }) - | null; + | null /** Format: date-time */ - pushed_at: string; - size: number; - ssh_url: string; - stargazers_count: number; + pushed_at: string + size: number + ssh_url: string + stargazers_count: number /** Format: uri */ - svn_url: string; - topics?: string[]; - watchers: number; - watchers_count: number; + svn_url: string + topics?: string[] + watchers: number + watchers_count: number /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - allow_forking?: boolean; - is_template?: boolean; + updated_at: string + allow_forking?: boolean + is_template?: boolean } & { [key: string]: unknown }) - | null; - sha: string; + | null + sha: string user: { /** Format: uri */ - avatar_url: string; - events_url: string; + avatar_url: string + events_url: string /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; + followers_url: string + following_url: string + gists_url: string + gravatar_id: string | null /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; + html_url: string + id: number + node_id: string + login: string /** Format: uri */ - organizations_url: string; + organizations_url: string /** Format: uri */ - received_events_url: string; + received_events_url: string /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; + repos_url: string + site_admin: boolean + starred_url: string /** Format: uri */ - subscriptions_url: string; - type: string; + subscriptions_url: string + type: string /** Format: uri */ - url: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + url: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } base: { - label: string; - ref: string; + label: string + ref: string repo: { - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; + archive_url: string + assignees_url: string + blobs_url: string + branches_url: string + collaborators_url: string + comments_url: string + commits_url: string + compare_url: string + contents_url: string /** Format: uri */ - contributors_url: string; + contributors_url: string /** Format: uri */ - deployments_url: string; - description: string | null; + deployments_url: string + description: string | null /** Format: uri */ - downloads_url: string; + downloads_url: string /** Format: uri */ - events_url: string; - fork: boolean; + events_url: string + fork: boolean /** Format: uri */ - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; + forks_url: string + full_name: string + git_commits_url: string + git_refs_url: string + git_tags_url: string /** Format: uri */ - hooks_url: string; + hooks_url: string /** Format: uri */ - html_url: string; - id: number; - is_template?: boolean; - node_id: string; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; + html_url: string + id: number + is_template?: boolean + node_id: string + issue_comment_url: string + issue_events_url: string + issues_url: string + keys_url: string + labels_url: string /** Format: uri */ - languages_url: string; + languages_url: string /** Format: uri */ - merges_url: string; - milestones_url: string; - name: string; - notifications_url: string; + merges_url: string + milestones_url: string + name: string + notifications_url: string owner: { /** Format: uri */ - avatar_url: string; - events_url: string; + avatar_url: string + events_url: string /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; + followers_url: string + following_url: string + gists_url: string + gravatar_id: string | null /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; + html_url: string + id: number + node_id: string + login: string /** Format: uri */ - organizations_url: string; + organizations_url: string /** Format: uri */ - received_events_url: string; + received_events_url: string /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; + repos_url: string + site_admin: boolean + starred_url: string /** Format: uri */ - subscriptions_url: string; - type: string; + subscriptions_url: string + type: string /** Format: uri */ - url: string; - } & { [key: string]: unknown }; - private: boolean; - pulls_url: string; - releases_url: string; + url: string + } & { [key: string]: unknown } + private: boolean + pulls_url: string + releases_url: string /** Format: uri */ - stargazers_url: string; - statuses_url: string; + stargazers_url: string + statuses_url: string /** Format: uri */ - subscribers_url: string; + subscribers_url: string /** Format: uri */ - subscription_url: string; + subscription_url: string /** Format: uri */ - tags_url: string; + tags_url: string /** Format: uri */ - teams_url: string; - trees_url: string; + teams_url: string + trees_url: string /** Format: uri */ - url: string; - clone_url: string; - default_branch: string; - forks: number; - forks_count: number; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_projects: boolean; - has_wiki: boolean; - has_pages: boolean; + url: string + clone_url: string + default_branch: string + forks: number + forks_count: number + git_url: string + has_downloads: boolean + has_issues: boolean + has_projects: boolean + has_wiki: boolean + has_pages: boolean /** Format: uri */ - homepage: string | null; - language: string | null; - master_branch?: string; - archived: boolean; - disabled: boolean; + homepage: string | null + language: string | null + master_branch?: string + archived: boolean + disabled: boolean /** @description The repository visibility: public, private, or internal. */ - visibility?: string; + visibility?: string /** Format: uri */ - mirror_url: string | null; - open_issues: number; - open_issues_count: number; + mirror_url: string | null + open_issues: number + open_issues_count: number permissions?: { - admin: boolean; - maintain?: boolean; - push: boolean; - triage?: boolean; - pull: boolean; - } & { [key: string]: unknown }; - temp_clone_token?: string; - allow_merge_commit?: boolean; - allow_squash_merge?: boolean; - allow_rebase_merge?: boolean; - license: components["schemas"]["nullable-license-simple"]; + admin: boolean + maintain?: boolean + push: boolean + triage?: boolean + pull: boolean + } & { [key: string]: unknown } + temp_clone_token?: string + allow_merge_commit?: boolean + allow_squash_merge?: boolean + allow_rebase_merge?: boolean + license: components['schemas']['nullable-license-simple'] /** Format: date-time */ - pushed_at: string; - size: number; - ssh_url: string; - stargazers_count: number; + pushed_at: string + size: number + ssh_url: string + stargazers_count: number /** Format: uri */ - svn_url: string; - topics?: string[]; - watchers: number; - watchers_count: number; + svn_url: string + topics?: string[] + watchers: number + watchers_count: number /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - allow_forking?: boolean; - } & { [key: string]: unknown }; - sha: string; + updated_at: string + allow_forking?: boolean + } & { [key: string]: unknown } + sha: string user: { /** Format: uri */ - avatar_url: string; - events_url: string; + avatar_url: string + events_url: string /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; + followers_url: string + following_url: string + gists_url: string + gravatar_id: string | null /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; + html_url: string + id: number + node_id: string + login: string /** Format: uri */ - organizations_url: string; + organizations_url: string /** Format: uri */ - received_events_url: string; + received_events_url: string /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; + repos_url: string + site_admin: boolean + starred_url: string /** Format: uri */ - subscriptions_url: string; - type: string; + subscriptions_url: string + type: string /** Format: uri */ - url: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + url: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } _links: { - comments: components["schemas"]["link"]; - commits: components["schemas"]["link"]; - statuses: components["schemas"]["link"]; - html: components["schemas"]["link"]; - issue: components["schemas"]["link"]; - review_comments: components["schemas"]["link"]; - review_comment: components["schemas"]["link"]; - self: components["schemas"]["link"]; - } & { [key: string]: unknown }; - author_association: components["schemas"]["author_association"]; - auto_merge: components["schemas"]["auto_merge"]; + comments: components['schemas']['link'] + commits: components['schemas']['link'] + statuses: components['schemas']['link'] + html: components['schemas']['link'] + issue: components['schemas']['link'] + review_comments: components['schemas']['link'] + review_comment: components['schemas']['link'] + self: components['schemas']['link'] + } & { [key: string]: unknown } + author_association: components['schemas']['author_association'] + auto_merge: components['schemas']['auto_merge'] /** @description Indicates whether or not the pull request is a draft. */ - draft?: boolean; - merged: boolean; + draft?: boolean + merged: boolean /** @example true */ - mergeable: boolean | null; + mergeable: boolean | null /** @example true */ - rebaseable?: boolean | null; + rebaseable?: boolean | null /** @example clean */ - mergeable_state: string; - merged_by: components["schemas"]["nullable-simple-user"]; + mergeable_state: string + merged_by: components['schemas']['nullable-simple-user'] /** @example 10 */ - comments: number; - review_comments: number; + comments: number + review_comments: number /** * @description Indicates whether maintainers can modify the pull request. * @example true */ - maintainer_can_modify: boolean; + maintainer_can_modify: boolean /** @example 3 */ - commits: number; + commits: number /** @example 100 */ - additions: number; + additions: number /** @example 3 */ - deletions: number; + deletions: number /** @example 5 */ - changed_files: number; - } & { [key: string]: unknown }; + changed_files: number + } & { [key: string]: unknown } /** * Pull Request Merge Result * @description Pull Request Merge Result */ - "pull-request-merge-result": { - sha: string; - merged: boolean; - message: string; - } & { [key: string]: unknown }; + 'pull-request-merge-result': { + sha: string + merged: boolean + message: string + } & { [key: string]: unknown } /** * Pull Request Review Request * @description Pull Request Review Request */ - "pull-request-review-request": { - users: components["schemas"]["simple-user"][]; - teams: components["schemas"]["team"][]; - } & { [key: string]: unknown }; + 'pull-request-review-request': { + users: components['schemas']['simple-user'][] + teams: components['schemas']['team'][] + } & { [key: string]: unknown } /** * Pull Request Review * @description Pull Request Reviews are reviews on pull requests. */ - "pull-request-review": { + 'pull-request-review': { /** * @description Unique identifier of the review * @example 42 */ - id: number; + id: number /** @example MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= */ - node_id: string; - user: components["schemas"]["nullable-simple-user"]; + node_id: string + user: components['schemas']['nullable-simple-user'] /** * @description The text of the review. * @example This looks great. */ - body: string; + body: string /** @example CHANGES_REQUESTED */ - state: string; + state: string /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/12 */ - pull_request_url: string; + pull_request_url: string _links: { html: { - href: string; - } & { [key: string]: unknown }; + href: string + } & { [key: string]: unknown } pull_request: { - href: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + href: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** Format: date-time */ - submitted_at?: string; + submitted_at?: string /** * @description A commit SHA for the review. * @example 54bb654c9e6025347f57900a4a5c2313a96b8035 */ - commit_id: string; - body_html?: string; - body_text?: string; - author_association: components["schemas"]["author_association"]; - } & { [key: string]: unknown }; + commit_id: string + body_html?: string + body_text?: string + author_association: components['schemas']['author_association'] + } & { [key: string]: unknown } /** * Legacy Review Comment * @description Legacy Review Comment */ - "review-comment": { + 'review-comment': { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ - url: string; + url: string /** @example 42 */ - pull_request_review_id: number | null; + pull_request_review_id: number | null /** @example 10 */ - id: number; + id: number /** @example MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw */ - node_id: string; + node_id: string /** @example @@ -16,33 +16,40 @@ public class Connection : IConnection... */ - diff_hunk: string; + diff_hunk: string /** @example file1.txt */ - path: string; + path: string /** @example 1 */ - position: number | null; + position: number | null /** @example 4 */ - original_position: number; + original_position: number /** @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */ - commit_id: string; + commit_id: string /** @example 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 */ - original_commit_id: string; + original_commit_id: string /** @example 8 */ - in_reply_to_id?: number; - user: components["schemas"]["nullable-simple-user"]; + in_reply_to_id?: number + user: components['schemas']['nullable-simple-user'] /** @example Great stuff */ - body: string; + body: string /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - updated_at: string; + updated_at: string /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1 */ - pull_request_url: string; - author_association: components["schemas"]["author_association"]; + pull_request_url: string + author_association: components['schemas']['author_association'] _links: { - self: components["schemas"]["link"]; - html: components["schemas"]["link"]; - pull_request: components["schemas"]["link"]; - } & { [key: string]: unknown }; - body_text?: string; - body_html?: string; - reactions?: components["schemas"]["reaction-rollup"]; + self: components['schemas']['link'] + html: components['schemas']['link'] + pull_request: components['schemas']['link'] + } & { [key: string]: unknown } + body_text?: string + body_html?: string + reactions?: components['schemas']['reaction-rollup'] /** * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string} */ - side?: "LEFT" | "RIGHT"; + side?: 'LEFT' | 'RIGHT' /** * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} */ - start_side?: ("LEFT" | "RIGHT") | null; + start_side?: ('LEFT' | 'RIGHT') | null /** * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment * @example 2 */ - line?: number; + line?: number /** * @description The original line of the blob to which the comment applies. The last line of the range for a multi-line comment * @example 2 */ - original_line?: number; + original_line?: number /** * @description The first line of the range for a multi-line comment. * @example 2 */ - start_line?: number | null; + start_line?: number | null /** * @description The original first line of the range for a multi-line comment. * @example 2 */ - original_start_line?: number | null; - } & { [key: string]: unknown }; + original_start_line?: number | null + } & { [key: string]: unknown } /** * Release Asset * @description Data related to a release. */ - "release-asset": { + 'release-asset': { /** Format: uri */ - url: string; + url: string /** Format: uri */ - browser_download_url: string; - id: number; - node_id: string; + browser_download_url: string + id: number + node_id: string /** * @description The file name of the asset. * @example Team Environment */ - name: string; - label: string | null; + name: string + label: string | null /** * @description State of the release asset. * @enum {string} */ - state: "uploaded" | "open"; - content_type: string; - size: number; - download_count: number; + state: 'uploaded' | 'open' + content_type: string + size: number + download_count: number /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - uploader: components["schemas"]["nullable-simple-user"]; - } & { [key: string]: unknown }; + updated_at: string + uploader: components['schemas']['nullable-simple-user'] + } & { [key: string]: unknown } /** * Release * @description A release. */ release: { /** Format: uri */ - url: string; + url: string /** Format: uri */ - html_url: string; + html_url: string /** Format: uri */ - assets_url: string; - upload_url: string; + assets_url: string + upload_url: string /** Format: uri */ - tarball_url: string | null; + tarball_url: string | null /** Format: uri */ - zipball_url: string | null; - id: number; - node_id: string; + zipball_url: string | null + id: number + node_id: string /** * @description The name of the tag. * @example v1.0.0 */ - tag_name: string; + tag_name: string /** * @description Specifies the commitish value that determines where the Git tag is created from. * @example master */ - target_commitish: string; - name: string | null; - body?: string | null; + target_commitish: string + name: string | null + body?: string | null /** @description true to create a draft (unpublished) release, false to create a published one. */ - draft: boolean; + draft: boolean /** @description Whether to identify the release as a prerelease or a full release. */ - prerelease: boolean; + prerelease: boolean /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - published_at: string | null; - author: components["schemas"]["simple-user"]; - assets: components["schemas"]["release-asset"][]; - body_html?: string; - body_text?: string; - mentions_count?: number; + published_at: string | null + author: components['schemas']['simple-user'] + assets: components['schemas']['release-asset'][] + body_html?: string + body_text?: string + mentions_count?: number /** * Format: uri * @description The URL of the release discussion. */ - discussion_url?: string; - reactions?: components["schemas"]["reaction-rollup"]; - } & { [key: string]: unknown }; + discussion_url?: string + reactions?: components['schemas']['reaction-rollup'] + } & { [key: string]: unknown } /** * Generated Release Notes Content * @description Generated name and body describing a release */ - "release-notes-content": { + 'release-notes-content': { /** * @description The generated name of the release * @example Release v1.0.0 is now available! */ - name: string; + name: string /** @description The generated body describing the contents of the release supporting markdown formatting */ - body: string; - } & { [key: string]: unknown }; - "secret-scanning-alert": { - number?: components["schemas"]["alert-number"]; - created_at?: components["schemas"]["alert-created-at"]; - url?: components["schemas"]["alert-url"]; - html_url?: components["schemas"]["alert-html-url"]; + body: string + } & { [key: string]: unknown } + 'secret-scanning-alert': { + number?: components['schemas']['alert-number'] + created_at?: components['schemas']['alert-created-at'] + url?: components['schemas']['alert-url'] + html_url?: components['schemas']['alert-html-url'] /** * Format: uri * @description The REST API URL of the code locations for this alert. */ - locations_url?: string; - state?: components["schemas"]["secret-scanning-alert-state"]; - resolution?: components["schemas"]["secret-scanning-alert-resolution"]; + locations_url?: string + state?: components['schemas']['secret-scanning-alert-state'] + resolution?: components['schemas']['secret-scanning-alert-resolution'] /** * Format: date-time * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - resolved_at?: string | null; - resolved_by?: components["schemas"]["nullable-simple-user"]; + resolved_at?: string | null + resolved_by?: components['schemas']['nullable-simple-user'] /** @description The type of secret that secret scanning detected. */ - secret_type?: string; + secret_type?: string /** @description The secret that was detected. */ - secret?: string; - } & { [key: string]: unknown }; + secret?: string + } & { [key: string]: unknown } /** @description Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. */ - "secret-scanning-location-commit": { + 'secret-scanning-location-commit': { /** * @description The file path in the repository * @example /example/secrets.txt */ - path: string; + path: string /** @description Line number at which the secret starts in the file */ - start_line: number; + start_line: number /** @description Line number at which the secret ends in the file */ - end_line: number; + end_line: number /** @description The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII */ - start_column: number; + start_column: number /** @description The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII */ - end_column: number; + end_column: number /** * @description SHA-1 hash ID of the associated blob * @example af5626b4a114abcb82d63db7c8082c3c4756e51b */ - blob_sha: string; + blob_sha: string /** @description The API URL to get the associated blob resource */ - blob_url: string; + blob_url: string /** * @description SHA-1 hash ID of the associated commit * @example af5626b4a114abcb82d63db7c8082c3c4756e51b */ - commit_sha: string; + commit_sha: string /** @description The API URL to get the associated commit resource */ - commit_url: string; - } & { [key: string]: unknown }; - "secret-scanning-location": { + commit_url: string + } & { [key: string]: unknown } + 'secret-scanning-location': { /** * @description The location type. Because secrets may be found in different types of resources (ie. code, comments, issues), this field identifies the type of resource where the secret was found. * @example commit * @enum {string} */ - type: "commit"; - details: components["schemas"]["secret-scanning-location-commit"] & { [key: string]: unknown }; - } & { [key: string]: unknown }; + type: 'commit' + details: components['schemas']['secret-scanning-location-commit'] & { [key: string]: unknown } + } & { [key: string]: unknown } /** * Stargazer * @description Stargazer */ stargazer: { /** Format: date-time */ - starred_at: string; - user: components["schemas"]["nullable-simple-user"]; - } & { [key: string]: unknown }; + starred_at: string + user: components['schemas']['nullable-simple-user'] + } & { [key: string]: unknown } /** * Code Frequency Stat * @description Code Frequency Stat */ - "code-frequency-stat": number[]; + 'code-frequency-stat': number[] /** * Commit Activity * @description Commit Activity */ - "commit-activity": { + 'commit-activity': { /** @example 0,3,26,20,39,1,0 */ - days: number[]; + days: number[] /** @example 89 */ - total: number; + total: number /** @example 1336280400 */ - week: number; - } & { [key: string]: unknown }; + week: number + } & { [key: string]: unknown } /** * Contributor Activity * @description Contributor Activity */ - "contributor-activity": { - author: components["schemas"]["nullable-simple-user"]; + 'contributor-activity': { + author: components['schemas']['nullable-simple-user'] /** @example 135 */ - total: number; + total: number /** @example [object Object] */ weeks: ({ - w?: number; - a?: number; - d?: number; - c?: number; - } & { [key: string]: unknown })[]; - } & { [key: string]: unknown }; + w?: number + a?: number + d?: number + c?: number + } & { [key: string]: unknown })[] + } & { [key: string]: unknown } /** Participation Stats */ - "participation-stats": { - all: number[]; - owner: number[]; - } & { [key: string]: unknown }; + 'participation-stats': { + all: number[] + owner: number[] + } & { [key: string]: unknown } /** * Repository Invitation * @description Repository invitations let you manage who you collaborate with. */ - "repository-subscription": { + 'repository-subscription': { /** * @description Determines if notifications should be received from this repository. * @example true */ - subscribed: boolean; + subscribed: boolean /** @description Determines if all notifications should be blocked from this repository. */ - ignored: boolean; - reason: string | null; + ignored: boolean + reason: string | null /** * Format: date-time * @example 2012-10-06T21:34:12Z */ - created_at: string; + created_at: string /** * Format: uri * @example https://api.github.com/repos/octocat/example/subscription */ - url: string; + url: string /** * Format: uri * @example https://api.github.com/repos/octocat/example */ - repository_url: string; - } & { [key: string]: unknown }; + repository_url: string + } & { [key: string]: unknown } /** * Tag * @description Tag */ tag: { /** @example v0.1 */ - name: string; + name: string commit: { - sha: string; + sha: string /** Format: uri */ - url: string; - } & { [key: string]: unknown }; + url: string + } & { [key: string]: unknown } /** * Format: uri * @example https://github.com/octocat/Hello-World/zipball/v0.1 */ - zipball_url: string; + zipball_url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/tarball/v0.1 */ - tarball_url: string; - node_id: string; - } & { [key: string]: unknown }; + tarball_url: string + node_id: string + } & { [key: string]: unknown } /** * Topic * @description A topic aggregates entities that are related to a subject. */ topic: { - names: string[]; - } & { [key: string]: unknown }; + names: string[] + } & { [key: string]: unknown } /** Traffic */ traffic: { /** Format: date-time */ - timestamp: string; - uniques: number; - count: number; - } & { [key: string]: unknown }; + timestamp: string + uniques: number + count: number + } & { [key: string]: unknown } /** * Clone Traffic * @description Clone Traffic */ - "clone-traffic": { + 'clone-traffic': { /** @example 173 */ - count: number; + count: number /** @example 128 */ - uniques: number; - clones: components["schemas"]["traffic"][]; - } & { [key: string]: unknown }; + uniques: number + clones: components['schemas']['traffic'][] + } & { [key: string]: unknown } /** * Content Traffic * @description Content Traffic */ - "content-traffic": { + 'content-traffic': { /** @example /github/hubot */ - path: string; + path: string /** @example github/hubot: A customizable life embetterment robot. */ - title: string; + title: string /** @example 3542 */ - count: number; + count: number /** @example 2225 */ - uniques: number; - } & { [key: string]: unknown }; + uniques: number + } & { [key: string]: unknown } /** * Referrer Traffic * @description Referrer Traffic */ - "referrer-traffic": { + 'referrer-traffic': { /** @example Google */ - referrer: string; + referrer: string /** @example 4 */ - count: number; + count: number /** @example 3 */ - uniques: number; - } & { [key: string]: unknown }; + uniques: number + } & { [key: string]: unknown } /** * View Traffic * @description View Traffic */ - "view-traffic": { + 'view-traffic': { /** @example 14850 */ - count: number; + count: number /** @example 3782 */ - uniques: number; - views: components["schemas"]["traffic"][]; - } & { [key: string]: unknown }; - "scim-group-list-enterprise": { - schemas: string[]; - totalResults: number; - itemsPerPage: number; - startIndex: number; + uniques: number + views: components['schemas']['traffic'][] + } & { [key: string]: unknown } + 'scim-group-list-enterprise': { + schemas: string[] + totalResults: number + itemsPerPage: number + startIndex: number Resources: ({ - schemas: string[]; - id: string; - externalId?: string | null; - displayName?: string; + schemas: string[] + id: string + externalId?: string | null + displayName?: string members?: ({ - value?: string; - $ref?: string; - display?: string; - } & { [key: string]: unknown })[]; + value?: string + $ref?: string + display?: string + } & { [key: string]: unknown })[] meta?: { - resourceType?: string; - created?: string; - lastModified?: string; - location?: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown })[]; - } & { [key: string]: unknown }; - "scim-enterprise-group": { - schemas: string[]; - id: string; - externalId?: string | null; - displayName?: string; + resourceType?: string + created?: string + lastModified?: string + location?: string + } & { [key: string]: unknown } + } & { [key: string]: unknown })[] + } & { [key: string]: unknown } + 'scim-enterprise-group': { + schemas: string[] + id: string + externalId?: string | null + displayName?: string members?: ({ - value?: string; - $ref?: string; - display?: string; - } & { [key: string]: unknown })[]; + value?: string + $ref?: string + display?: string + } & { [key: string]: unknown })[] meta?: { - resourceType?: string; - created?: string; - lastModified?: string; - location?: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; - "scim-user-list-enterprise": { - schemas: string[]; - totalResults: number; - itemsPerPage: number; - startIndex: number; + resourceType?: string + created?: string + lastModified?: string + location?: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } + 'scim-user-list-enterprise': { + schemas: string[] + totalResults: number + itemsPerPage: number + startIndex: number Resources: ({ - schemas: string[]; - id: string; - externalId?: string; - userName?: string; + schemas: string[] + id: string + externalId?: string + userName?: string name?: { - givenName?: string; - familyName?: string; - } & { [key: string]: unknown }; + givenName?: string + familyName?: string + } & { [key: string]: unknown } emails?: ({ - value?: string; - primary?: boolean; - type?: string; - } & { [key: string]: unknown })[]; + value?: string + primary?: boolean + type?: string + } & { [key: string]: unknown })[] groups?: ({ - value?: string; - } & { [key: string]: unknown })[]; - active?: boolean; + value?: string + } & { [key: string]: unknown })[] + active?: boolean meta?: { - resourceType?: string; - created?: string; - lastModified?: string; - location?: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown })[]; - } & { [key: string]: unknown }; - "scim-enterprise-user": { - schemas: string[]; - id: string; - externalId?: string; - userName?: string; + resourceType?: string + created?: string + lastModified?: string + location?: string + } & { [key: string]: unknown } + } & { [key: string]: unknown })[] + } & { [key: string]: unknown } + 'scim-enterprise-user': { + schemas: string[] + id: string + externalId?: string + userName?: string name?: { - givenName?: string; - familyName?: string; - } & { [key: string]: unknown }; + givenName?: string + familyName?: string + } & { [key: string]: unknown } emails?: ({ - value?: string; - type?: string; - primary?: boolean; - } & { [key: string]: unknown })[]; + value?: string + type?: string + primary?: boolean + } & { [key: string]: unknown })[] groups?: ({ - value?: string; - } & { [key: string]: unknown })[]; - active?: boolean; + value?: string + } & { [key: string]: unknown })[] + active?: boolean meta?: { - resourceType?: string; - created?: string; - lastModified?: string; - location?: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + resourceType?: string + created?: string + lastModified?: string + location?: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** * SCIM /Users * @description SCIM /Users provisioning endpoints */ - "scim-user": { + 'scim-user': { /** @description SCIM schema used. */ - schemas: string[]; + schemas: string[] /** * @description Unique identifier of an external identity * @example 1b78eada-9baa-11e6-9eb6-a431576d590e */ - id: string; + id: string /** * @description The ID of the User. * @example a7b0f98395 */ - externalId: string | null; + externalId: string | null /** * @description Configured by the admin. Could be an email, login, or username * @example someone@example.com */ - userName: string | null; + userName: string | null /** * @description The name of the user, suitable for display to end-users * @example Jon Doe */ - displayName?: string | null; + displayName?: string | null /** @example [object Object] */ name: { - givenName: string | null; - familyName: string | null; - formatted?: string | null; - } & { [key: string]: unknown }; + givenName: string | null + familyName: string | null + formatted?: string | null + } & { [key: string]: unknown } /** * @description user emails * @example [object Object],[object Object] */ emails: ({ - value: string; - primary?: boolean; - } & { [key: string]: unknown })[]; + value: string + primary?: boolean + } & { [key: string]: unknown })[] /** * @description The active status of the User. * @example true */ - active: boolean; + active: boolean meta: { /** @example User */ - resourceType?: string; + resourceType?: string /** * Format: date-time * @example 2019-01-24T22:45:36.000Z */ - created?: string; + created?: string /** * Format: date-time * @example 2019-01-24T22:45:36.000Z */ - lastModified?: string; + lastModified?: string /** * Format: uri * @example https://api.github.com/scim/v2/organizations/myorg-123abc55141bfd8f/Users/c42772b5-2029-11e9-8543-9264a97dec8d */ - location?: string; - } & { [key: string]: unknown }; + location?: string + } & { [key: string]: unknown } /** @description The ID of the organization. */ - organization_id?: number; + organization_id?: number /** * @description Set of operations to be performed * @example [object Object] */ operations?: ({ /** @enum {string} */ - op: "add" | "remove" | "replace"; - path?: string; - value?: (string | { [key: string]: unknown } | unknown[]) & { [key: string]: unknown }; - } & { [key: string]: unknown })[]; + op: 'add' | 'remove' | 'replace' + path?: string + value?: (string | { [key: string]: unknown } | unknown[]) & { [key: string]: unknown } + } & { [key: string]: unknown })[] /** @description associated groups */ groups?: ({ - value?: string; - display?: string; - } & { [key: string]: unknown })[]; - } & { [key: string]: unknown }; + value?: string + display?: string + } & { [key: string]: unknown })[] + } & { [key: string]: unknown } /** * SCIM User List * @description SCIM User List */ - "scim-user-list": { + 'scim-user-list': { /** @description SCIM schema used. */ - schemas: string[]; + schemas: string[] /** @example 3 */ - totalResults: number; + totalResults: number /** @example 10 */ - itemsPerPage: number; + itemsPerPage: number /** @example 1 */ - startIndex: number; - Resources: components["schemas"]["scim-user"][]; - } & { [key: string]: unknown }; + startIndex: number + Resources: components['schemas']['scim-user'][] + } & { [key: string]: unknown } /** Search Result Text Matches */ - "search-result-text-matches": ({ - object_url?: string; - object_type?: string | null; - property?: string; - fragment?: string; + 'search-result-text-matches': ({ + object_url?: string + object_type?: string | null + property?: string + fragment?: string matches?: ({ - text?: string; - indices?: number[]; - } & { [key: string]: unknown })[]; - } & { [key: string]: unknown })[]; + text?: string + indices?: number[] + } & { [key: string]: unknown })[] + } & { [key: string]: unknown })[] /** * Code Search Result Item * @description Code Search Result Item */ - "code-search-result-item": { - name: string; - path: string; - sha: string; + 'code-search-result-item': { + name: string + path: string + sha: string /** Format: uri */ - url: string; + url: string /** Format: uri */ - git_url: string; + git_url: string /** Format: uri */ - html_url: string; - repository: components["schemas"]["minimal-repository"]; - score: number; - file_size?: number; - language?: string | null; + html_url: string + repository: components['schemas']['minimal-repository'] + score: number + file_size?: number + language?: string | null /** Format: date-time */ - last_modified_at?: string; + last_modified_at?: string /** @example 73..77,77..78 */ - line_numbers?: string[]; - text_matches?: components["schemas"]["search-result-text-matches"]; - } & { [key: string]: unknown }; + line_numbers?: string[] + text_matches?: components['schemas']['search-result-text-matches'] + } & { [key: string]: unknown } /** * Commit Search Result Item * @description Commit Search Result Item */ - "commit-search-result-item": { + 'commit-search-result-item': { /** Format: uri */ - url: string; - sha: string; + url: string + sha: string /** Format: uri */ - html_url: string; + html_url: string /** Format: uri */ - comments_url: string; + comments_url: string commit: { author: { - name: string; - email: string; + name: string + email: string /** Format: date-time */ - date: string; - } & { [key: string]: unknown }; - committer: components["schemas"]["nullable-git-user"]; - comment_count: number; - message: string; + date: string + } & { [key: string]: unknown } + committer: components['schemas']['nullable-git-user'] + comment_count: number + message: string tree: { - sha: string; + sha: string /** Format: uri */ - url: string; - } & { [key: string]: unknown }; + url: string + } & { [key: string]: unknown } /** Format: uri */ - url: string; - verification?: components["schemas"]["verification"]; - } & { [key: string]: unknown }; - author: components["schemas"]["nullable-simple-user"]; - committer: components["schemas"]["nullable-git-user"]; + url: string + verification?: components['schemas']['verification'] + } & { [key: string]: unknown } + author: components['schemas']['nullable-simple-user'] + committer: components['schemas']['nullable-git-user'] parents: ({ - url?: string; - html_url?: string; - sha?: string; - } & { [key: string]: unknown })[]; - repository: components["schemas"]["minimal-repository"]; - score: number; - node_id: string; - text_matches?: components["schemas"]["search-result-text-matches"]; - } & { [key: string]: unknown }; + url?: string + html_url?: string + sha?: string + } & { [key: string]: unknown })[] + repository: components['schemas']['minimal-repository'] + score: number + node_id: string + text_matches?: components['schemas']['search-result-text-matches'] + } & { [key: string]: unknown } /** * Issue Search Result Item * @description Issue Search Result Item */ - "issue-search-result-item": { + 'issue-search-result-item': { /** Format: uri */ - url: string; + url: string /** Format: uri */ - repository_url: string; - labels_url: string; + repository_url: string + labels_url: string /** Format: uri */ - comments_url: string; + comments_url: string /** Format: uri */ - events_url: string; + events_url: string /** Format: uri */ - html_url: string; - id: number; - node_id: string; - number: number; - title: string; - locked: boolean; - active_lock_reason?: string | null; - assignees?: components["schemas"]["simple-user"][] | null; - user: components["schemas"]["nullable-simple-user"]; + html_url: string + id: number + node_id: string + number: number + title: string + locked: boolean + active_lock_reason?: string | null + assignees?: components['schemas']['simple-user'][] | null + user: components['schemas']['nullable-simple-user'] labels: ({ /** Format: int64 */ - id?: number; - node_id?: string; - url?: string; - name?: string; - color?: string; - default?: boolean; - description?: string | null; - } & { [key: string]: unknown })[]; - state: string; - assignee: components["schemas"]["nullable-simple-user"]; - milestone: components["schemas"]["nullable-milestone"]; - comments: number; + id?: number + node_id?: string + url?: string + name?: string + color?: string + default?: boolean + description?: string | null + } & { [key: string]: unknown })[] + state: string + assignee: components['schemas']['nullable-simple-user'] + milestone: components['schemas']['nullable-milestone'] + comments: number /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; + updated_at: string /** Format: date-time */ - closed_at: string | null; - text_matches?: components["schemas"]["search-result-text-matches"]; + closed_at: string | null + text_matches?: components['schemas']['search-result-text-matches'] pull_request?: { /** Format: date-time */ - merged_at?: string | null; + merged_at?: string | null /** Format: uri */ - diff_url: string | null; + diff_url: string | null /** Format: uri */ - html_url: string | null; + html_url: string | null /** Format: uri */ - patch_url: string | null; + patch_url: string | null /** Format: uri */ - url: string | null; - } & { [key: string]: unknown }; - body?: string; - score: number; - author_association: components["schemas"]["author_association"]; - draft?: boolean; - repository?: components["schemas"]["repository"]; - body_html?: string; - body_text?: string; + url: string | null + } & { [key: string]: unknown } + body?: string + score: number + author_association: components['schemas']['author_association'] + draft?: boolean + repository?: components['schemas']['repository'] + body_html?: string + body_text?: string /** Format: uri */ - timeline_url?: string; - performed_via_github_app?: components["schemas"]["nullable-integration"]; - reactions?: components["schemas"]["reaction-rollup"]; - } & { [key: string]: unknown }; + timeline_url?: string + performed_via_github_app?: components['schemas']['nullable-integration'] + reactions?: components['schemas']['reaction-rollup'] + } & { [key: string]: unknown } /** * Label Search Result Item * @description Label Search Result Item */ - "label-search-result-item": { - id: number; - node_id: string; + 'label-search-result-item': { + id: number + node_id: string /** Format: uri */ - url: string; - name: string; - color: string; - default: boolean; - description: string | null; - score: number; - text_matches?: components["schemas"]["search-result-text-matches"]; - } & { [key: string]: unknown }; + url: string + name: string + color: string + default: boolean + description: string | null + score: number + text_matches?: components['schemas']['search-result-text-matches'] + } & { [key: string]: unknown } /** * Repo Search Result Item * @description Repo Search Result Item */ - "repo-search-result-item": { - id: number; - node_id: string; - name: string; - full_name: string; - owner: components["schemas"]["nullable-simple-user"]; - private: boolean; + 'repo-search-result-item': { + id: number + node_id: string + name: string + full_name: string + owner: components['schemas']['nullable-simple-user'] + private: boolean /** Format: uri */ - html_url: string; - description: string | null; - fork: boolean; + html_url: string + description: string | null + fork: boolean /** Format: uri */ - url: string; + url: string /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; + updated_at: string /** Format: date-time */ - pushed_at: string; + pushed_at: string /** Format: uri */ - homepage: string | null; - size: number; - stargazers_count: number; - watchers_count: number; - language: string | null; - forks_count: number; - open_issues_count: number; - master_branch?: string; - default_branch: string; - score: number; + homepage: string | null + size: number + stargazers_count: number + watchers_count: number + language: string | null + forks_count: number + open_issues_count: number + master_branch?: string + default_branch: string + score: number /** Format: uri */ - forks_url: string; - keys_url: string; - collaborators_url: string; + forks_url: string + keys_url: string + collaborators_url: string /** Format: uri */ - teams_url: string; + teams_url: string /** Format: uri */ - hooks_url: string; - issue_events_url: string; + hooks_url: string + issue_events_url: string /** Format: uri */ - events_url: string; - assignees_url: string; - branches_url: string; + events_url: string + assignees_url: string + branches_url: string /** Format: uri */ - tags_url: string; - blobs_url: string; - git_tags_url: string; - git_refs_url: string; - trees_url: string; - statuses_url: string; + tags_url: string + blobs_url: string + git_tags_url: string + git_refs_url: string + trees_url: string + statuses_url: string /** Format: uri */ - languages_url: string; + languages_url: string /** Format: uri */ - stargazers_url: string; + stargazers_url: string /** Format: uri */ - contributors_url: string; + contributors_url: string /** Format: uri */ - subscribers_url: string; + subscribers_url: string /** Format: uri */ - subscription_url: string; - commits_url: string; - git_commits_url: string; - comments_url: string; - issue_comment_url: string; - contents_url: string; - compare_url: string; + subscription_url: string + commits_url: string + git_commits_url: string + comments_url: string + issue_comment_url: string + contents_url: string + compare_url: string /** Format: uri */ - merges_url: string; - archive_url: string; + merges_url: string + archive_url: string /** Format: uri */ - downloads_url: string; - issues_url: string; - pulls_url: string; - milestones_url: string; - notifications_url: string; - labels_url: string; - releases_url: string; + downloads_url: string + issues_url: string + pulls_url: string + milestones_url: string + notifications_url: string + labels_url: string + releases_url: string /** Format: uri */ - deployments_url: string; - git_url: string; - ssh_url: string; - clone_url: string; + deployments_url: string + git_url: string + ssh_url: string + clone_url: string /** Format: uri */ - svn_url: string; - forks: number; - open_issues: number; - watchers: number; - topics?: string[]; + svn_url: string + forks: number + open_issues: number + watchers: number + topics?: string[] /** Format: uri */ - mirror_url: string | null; - has_issues: boolean; - has_projects: boolean; - has_pages: boolean; - has_wiki: boolean; - has_downloads: boolean; - archived: boolean; + mirror_url: string | null + has_issues: boolean + has_projects: boolean + has_pages: boolean + has_wiki: boolean + has_downloads: boolean + archived: boolean /** @description Returns whether or not this repository disabled. */ - disabled: boolean; + disabled: boolean /** @description The repository visibility: public, private, or internal. */ - visibility?: string; - license: components["schemas"]["nullable-license-simple"]; + visibility?: string + license: components['schemas']['nullable-license-simple'] permissions?: { - admin: boolean; - maintain?: boolean; - push: boolean; - triage?: boolean; - pull: boolean; - } & { [key: string]: unknown }; - text_matches?: components["schemas"]["search-result-text-matches"]; - temp_clone_token?: string; - allow_merge_commit?: boolean; - allow_squash_merge?: boolean; - allow_rebase_merge?: boolean; - allow_auto_merge?: boolean; - delete_branch_on_merge?: boolean; - allow_forking?: boolean; - is_template?: boolean; - } & { [key: string]: unknown }; + admin: boolean + maintain?: boolean + push: boolean + triage?: boolean + pull: boolean + } & { [key: string]: unknown } + text_matches?: components['schemas']['search-result-text-matches'] + temp_clone_token?: string + allow_merge_commit?: boolean + allow_squash_merge?: boolean + allow_rebase_merge?: boolean + allow_auto_merge?: boolean + delete_branch_on_merge?: boolean + allow_forking?: boolean + is_template?: boolean + } & { [key: string]: unknown } /** * Topic Search Result Item * @description Topic Search Result Item */ - "topic-search-result-item": { - name: string; - display_name: string | null; - short_description: string | null; - description: string | null; - created_by: string | null; - released: string | null; + 'topic-search-result-item': { + name: string + display_name: string | null + short_description: string | null + description: string | null + created_by: string | null + released: string | null /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - featured: boolean; - curated: boolean; - score: number; - repository_count?: number | null; + updated_at: string + featured: boolean + curated: boolean + score: number + repository_count?: number | null /** Format: uri */ - logo_url?: string | null; - text_matches?: components["schemas"]["search-result-text-matches"]; + logo_url?: string | null + text_matches?: components['schemas']['search-result-text-matches'] related?: | ({ topic_relation?: { - id?: number; - name?: string; - topic_id?: number; - relation_type?: string; - } & { [key: string]: unknown }; + id?: number + name?: string + topic_id?: number + relation_type?: string + } & { [key: string]: unknown } } & { [key: string]: unknown })[] - | null; + | null aliases?: | ({ topic_relation?: { - id?: number; - name?: string; - topic_id?: number; - relation_type?: string; - } & { [key: string]: unknown }; + id?: number + name?: string + topic_id?: number + relation_type?: string + } & { [key: string]: unknown } } & { [key: string]: unknown })[] - | null; - } & { [key: string]: unknown }; + | null + } & { [key: string]: unknown } /** * User Search Result Item * @description User Search Result Item */ - "user-search-result-item": { - login: string; - id: number; - node_id: string; + 'user-search-result-item': { + login: string + id: number + node_id: string /** Format: uri */ - avatar_url: string; - gravatar_id: string | null; + avatar_url: string + gravatar_id: string | null /** Format: uri */ - url: string; + url: string /** Format: uri */ - html_url: string; + html_url: string /** Format: uri */ - followers_url: string; + followers_url: string /** Format: uri */ - subscriptions_url: string; + subscriptions_url: string /** Format: uri */ - organizations_url: string; + organizations_url: string /** Format: uri */ - repos_url: string; + repos_url: string /** Format: uri */ - received_events_url: string; - type: string; - score: number; - following_url: string; - gists_url: string; - starred_url: string; - events_url: string; - public_repos?: number; - public_gists?: number; - followers?: number; - following?: number; + received_events_url: string + type: string + score: number + following_url: string + gists_url: string + starred_url: string + events_url: string + public_repos?: number + public_gists?: number + followers?: number + following?: number /** Format: date-time */ - created_at?: string; + created_at?: string /** Format: date-time */ - updated_at?: string; - name?: string | null; - bio?: string | null; + updated_at?: string + name?: string | null + bio?: string | null /** Format: email */ - email?: string | null; - location?: string | null; - site_admin: boolean; - hireable?: boolean | null; - text_matches?: components["schemas"]["search-result-text-matches"]; - blog?: string | null; - company?: string | null; + email?: string | null + location?: string | null + site_admin: boolean + hireable?: boolean | null + text_matches?: components['schemas']['search-result-text-matches'] + blog?: string | null + company?: string | null /** Format: date-time */ - suspended_at?: string | null; - } & { [key: string]: unknown }; + suspended_at?: string | null + } & { [key: string]: unknown } /** * Private User * @description Private User */ - "private-user": { + 'private-user': { /** @example octocat */ - login: string; + login: string /** @example 1 */ - id: number; + id: number /** @example MDQ6VXNlcjE= */ - node_id: string; + node_id: string /** * Format: uri * @example https://github.com/images/error/octocat_happy.gif */ - avatar_url: string; + avatar_url: string /** @example 41d064eb2195891e12d0413f63227ea7 */ - gravatar_id: string | null; + gravatar_id: string | null /** * Format: uri * @example https://api.github.com/users/octocat */ - url: string; + url: string /** * Format: uri * @example https://github.com/octocat */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/users/octocat/followers */ - followers_url: string; + followers_url: string /** @example https://api.github.com/users/octocat/following{/other_user} */ - following_url: string; + following_url: string /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - gists_url: string; + gists_url: string /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - starred_url: string; + starred_url: string /** * Format: uri * @example https://api.github.com/users/octocat/subscriptions */ - subscriptions_url: string; + subscriptions_url: string /** * Format: uri * @example https://api.github.com/users/octocat/orgs */ - organizations_url: string; + organizations_url: string /** * Format: uri * @example https://api.github.com/users/octocat/repos */ - repos_url: string; + repos_url: string /** @example https://api.github.com/users/octocat/events{/privacy} */ - events_url: string; + events_url: string /** * Format: uri * @example https://api.github.com/users/octocat/received_events */ - received_events_url: string; + received_events_url: string /** @example User */ - type: string; - site_admin: boolean; + type: string + site_admin: boolean /** @example monalisa octocat */ - name: string | null; + name: string | null /** @example GitHub */ - company: string | null; + company: string | null /** @example https://github.com/blog */ - blog: string | null; + blog: string | null /** @example San Francisco */ - location: string | null; + location: string | null /** * Format: email * @example octocat@github.com */ - email: string | null; - hireable: boolean | null; + email: string | null + hireable: boolean | null /** @example There once was... */ - bio: string | null; + bio: string | null /** @example monalisa */ - twitter_username?: string | null; + twitter_username?: string | null /** @example 2 */ - public_repos: number; + public_repos: number /** @example 1 */ - public_gists: number; + public_gists: number /** @example 20 */ - followers: number; - following: number; + followers: number + following: number /** * Format: date-time * @example 2008-01-14T04:33:35Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2008-01-14T04:33:35Z */ - updated_at: string; + updated_at: string /** @example 81 */ - private_gists: number; + private_gists: number /** @example 100 */ - total_private_repos: number; + total_private_repos: number /** @example 100 */ - owned_private_repos: number; + owned_private_repos: number /** @example 10000 */ - disk_usage: number; + disk_usage: number /** @example 8 */ - collaborators: number; + collaborators: number /** @example true */ - two_factor_authentication: boolean; + two_factor_authentication: boolean plan?: { - collaborators: number; - name: string; - space: number; - private_repos: number; - } & { [key: string]: unknown }; + collaborators: number + name: string + space: number + private_repos: number + } & { [key: string]: unknown } /** Format: date-time */ - suspended_at?: string | null; - business_plus?: boolean; - ldap_dn?: string; - } & { [key: string]: unknown }; + suspended_at?: string | null + business_plus?: boolean + ldap_dn?: string + } & { [key: string]: unknown } /** * Codespaces Secret * @description Secrets for a GitHub Codespace. */ - "codespaces-secret": { + 'codespaces-secret': { /** * @description The name of the secret. * @example SECRET_NAME */ - name: string; + name: string /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; + updated_at: string /** * @description Visibility of a secret * @enum {string} */ - visibility: "all" | "private" | "selected"; + visibility: 'all' | 'private' | 'selected' /** * Format: uri * @example https://api.github.com/user/secrets/SECRET_NAME/repositories */ - selected_repositories_url: string; - } & { [key: string]: unknown }; + selected_repositories_url: string + } & { [key: string]: unknown } /** * CodespacesUserPublicKey * @description The public key used for setting user Codespaces' Secrets. */ - "codespaces-user-public-key": { + 'codespaces-user-public-key': { /** * @description The identifier for the key. * @example 1234567 */ - key_id: string; + key_id: string /** * @description The Base64 encoded public key. * @example hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= */ - key: string; - } & { [key: string]: unknown }; + key: string + } & { [key: string]: unknown } /** * Fetches information about an export of a codespace. * @description An export of a codespace. Also, latest export details for a codespace can be fetched with id = latest */ - "codespace-export-details": { + 'codespace-export-details': { /** * @description State of the latest export * @example succeeded | failed | in_progress */ - state?: string | null; + state?: string | null /** * Format: date-time * @description Completion time of the last export operation * @example 2021-01-01T19:01:12Z */ - completed_at?: string | null; + completed_at?: string | null /** * @description Name of the exported branch * @example codespace-monalisa-octocat-hello-world-g4wpq6h95q */ - branch?: string | null; + branch?: string | null /** * @description Git commit SHA of the exported branch * @example fd95a81ca01e48ede9f39c799ecbcef817b8a3b2 */ - sha?: string | null; + sha?: string | null /** * @description Id for the export details * @example latest */ - id?: string; + id?: string /** * @description Url for fetching export details * @example https://api.github.com/user/codespaces/:name/exports/latest */ - export_url?: string; - } & { [key: string]: unknown }; + export_url?: string + } & { [key: string]: unknown } /** * Email * @description Email @@ -17395,355 +17375,355 @@ export interface components { * Format: email * @example octocat@github.com */ - email: string; + email: string /** @example true */ - primary: boolean; + primary: boolean /** @example true */ - verified: boolean; + verified: boolean /** @example public */ - visibility: string | null; - } & { [key: string]: unknown }; + visibility: string | null + } & { [key: string]: unknown } /** * GPG Key * @description A unique encryption key */ - "gpg-key": { + 'gpg-key': { /** @example 3 */ - id: number; - primary_key_id: number | null; + id: number + primary_key_id: number | null /** @example 3262EFF25BA0D270 */ - key_id: string; + key_id: string /** @example xsBNBFayYZ... */ - public_key: string; + public_key: string /** @example [object Object] */ emails: ({ - email?: string; - verified?: boolean; - } & { [key: string]: unknown })[]; + email?: string + verified?: boolean + } & { [key: string]: unknown })[] /** @example [object Object] */ subkeys: ({ - id?: number; - primary_key_id?: number; - key_id?: string; - public_key?: string; - emails?: unknown[]; - subkeys?: unknown[]; - can_sign?: boolean; - can_encrypt_comms?: boolean; - can_encrypt_storage?: boolean; - can_certify?: boolean; - created_at?: string; - expires_at?: string | null; - raw_key?: string | null; - } & { [key: string]: unknown })[]; + id?: number + primary_key_id?: number + key_id?: string + public_key?: string + emails?: unknown[] + subkeys?: unknown[] + can_sign?: boolean + can_encrypt_comms?: boolean + can_encrypt_storage?: boolean + can_certify?: boolean + created_at?: string + expires_at?: string | null + raw_key?: string | null + } & { [key: string]: unknown })[] /** @example true */ - can_sign: boolean; - can_encrypt_comms: boolean; - can_encrypt_storage: boolean; + can_sign: boolean + can_encrypt_comms: boolean + can_encrypt_storage: boolean /** @example true */ - can_certify: boolean; + can_certify: boolean /** * Format: date-time * @example 2016-03-24T11:31:04-06:00 */ - created_at: string; + created_at: string /** Format: date-time */ - expires_at: string | null; - raw_key: string | null; - } & { [key: string]: unknown }; + expires_at: string | null + raw_key: string | null + } & { [key: string]: unknown } /** * Key * @description Key */ key: { - key: string; - id: number; - url: string; - title: string; + key: string + id: number + url: string + title: string /** Format: date-time */ - created_at: string; - verified: boolean; - read_only: boolean; - } & { [key: string]: unknown }; + created_at: string + verified: boolean + read_only: boolean + } & { [key: string]: unknown } /** Marketplace Account */ - "marketplace-account": { + 'marketplace-account': { /** Format: uri */ - url: string; - id: number; - type: string; - node_id?: string; - login: string; + url: string + id: number + type: string + node_id?: string + login: string /** Format: email */ - email?: string | null; + email?: string | null /** Format: email */ - organization_billing_email?: string | null; - } & { [key: string]: unknown }; + organization_billing_email?: string | null + } & { [key: string]: unknown } /** * User Marketplace Purchase * @description User Marketplace Purchase */ - "user-marketplace-purchase": { + 'user-marketplace-purchase': { /** @example monthly */ - billing_cycle: string; + billing_cycle: string /** * Format: date-time * @example 2017-11-11T00:00:00Z */ - next_billing_date: string | null; - unit_count: number | null; + next_billing_date: string | null + unit_count: number | null /** @example true */ - on_free_trial: boolean; + on_free_trial: boolean /** * Format: date-time * @example 2017-11-11T00:00:00Z */ - free_trial_ends_on: string | null; + free_trial_ends_on: string | null /** * Format: date-time * @example 2017-11-02T01:12:12Z */ - updated_at: string | null; - account: components["schemas"]["marketplace-account"]; - plan: components["schemas"]["marketplace-listing-plan"]; - } & { [key: string]: unknown }; + updated_at: string | null + account: components['schemas']['marketplace-account'] + plan: components['schemas']['marketplace-listing-plan'] + } & { [key: string]: unknown } /** * Starred Repository * @description Starred Repository */ - "starred-repository": { + 'starred-repository': { /** Format: date-time */ - starred_at: string; - repo: components["schemas"]["repository"]; - } & { [key: string]: unknown }; + starred_at: string + repo: components['schemas']['repository'] + } & { [key: string]: unknown } /** * Hovercard * @description Hovercard */ hovercard: { contexts: ({ - message: string; - octicon: string; - } & { [key: string]: unknown })[]; - } & { [key: string]: unknown }; + message: string + octicon: string + } & { [key: string]: unknown })[] + } & { [key: string]: unknown } /** * Key Simple * @description Key Simple */ - "key-simple": { - id: number; - key: string; - } & { [key: string]: unknown }; - }; + 'key-simple': { + id: number + key: string + } & { [key: string]: unknown } + } responses: { /** Resource not found */ not_found: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } /** Validation failed */ validation_failed_simple: { content: { - "application/json": components["schemas"]["validation-error-simple"]; - }; - }; + 'application/json': components['schemas']['validation-error-simple'] + } + } /** Bad Request */ bad_request: { content: { - "application/json": components["schemas"]["basic-error"]; - "application/scim+json": components["schemas"]["scim-error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + 'application/scim+json': components['schemas']['scim-error'] + } + } /** Validation failed */ validation_failed: { content: { - "application/json": components["schemas"]["validation-error"]; - }; - }; + 'application/json': components['schemas']['validation-error'] + } + } /** Accepted */ accepted: { content: { - "application/json": { [key: string]: unknown }; - }; - }; + 'application/json': { [key: string]: unknown } + } + } /** Preview header missing */ preview_header_missing: { content: { - "application/json": { - message: string; - documentation_url: string; - } & { [key: string]: unknown }; - }; - }; + 'application/json': { + message: string + documentation_url: string + } & { [key: string]: unknown } + } + } /** Forbidden */ forbidden: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } /** Requires authentication */ requires_authentication: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } /** Not modified */ - not_modified: unknown; + not_modified: unknown /** Gone */ gone: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } /** Response */ actions_runner_labels: { content: { - "application/json": { - total_count: number; - labels: components["schemas"]["runner-label"][]; - } & { [key: string]: unknown }; - }; - }; + 'application/json': { + total_count: number + labels: components['schemas']['runner-label'][] + } & { [key: string]: unknown } + } + } /** Response */ actions_runner_labels_readonly: { content: { - "application/json": { - total_count: number; - labels: components["schemas"]["runner-label"][]; - } & { [key: string]: unknown }; - }; - }; + 'application/json': { + total_count: number + labels: components['schemas']['runner-label'][] + } & { [key: string]: unknown } + } + } /** Service unavailable */ service_unavailable: { content: { - "application/json": { - code?: string; - message?: string; - documentation_url?: string; - } & { [key: string]: unknown }; - }; - }; + 'application/json': { + code?: string + message?: string + documentation_url?: string + } & { [key: string]: unknown } + } + } /** Response if GitHub Advanced Security is not enabled for this repository */ code_scanning_forbidden_read: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } /** Forbidden Gist */ forbidden_gist: { content: { - "application/json": { + 'application/json': { block?: { - reason?: string; - created_at?: string; - html_url?: string | null; - } & { [key: string]: unknown }; - message?: string; - documentation_url?: string; - } & { [key: string]: unknown }; - }; - }; + reason?: string + created_at?: string + html_url?: string | null + } & { [key: string]: unknown } + message?: string + documentation_url?: string + } & { [key: string]: unknown } + } + } /** Moved permanently */ moved_permanently: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } /** Conflict */ conflict: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } /** Temporary Redirect */ temporary_redirect: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } /** Internal Error */ internal_error: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } /** Response if the repository is archived or if github advanced security is not enabled for this repository */ code_scanning_forbidden_write: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } /** Found */ - found: unknown; + found: unknown /** A header with no content is returned. */ - no_content: unknown; + no_content: unknown /** Resource not found */ scim_not_found: { content: { - "application/json": components["schemas"]["scim-error"]; - "application/scim+json": components["schemas"]["scim-error"]; - }; - }; + 'application/json': components['schemas']['scim-error'] + 'application/scim+json': components['schemas']['scim-error'] + } + } /** Forbidden */ scim_forbidden: { content: { - "application/json": components["schemas"]["scim-error"]; - "application/scim+json": components["schemas"]["scim-error"]; - }; - }; + 'application/json': components['schemas']['scim-error'] + 'application/scim+json': components['schemas']['scim-error'] + } + } /** Bad Request */ scim_bad_request: { content: { - "application/json": components["schemas"]["scim-error"]; - "application/scim+json": components["schemas"]["scim-error"]; - }; - }; + 'application/json': components['schemas']['scim-error'] + 'application/scim+json': components['schemas']['scim-error'] + } + } /** Internal Error */ scim_internal_error: { content: { - "application/json": components["schemas"]["scim-error"]; - "application/scim+json": components["schemas"]["scim-error"]; - }; - }; + 'application/json': components['schemas']['scim-error'] + 'application/scim+json': components['schemas']['scim-error'] + } + } /** Conflict */ scim_conflict: { content: { - "application/json": components["schemas"]["scim-error"]; - "application/scim+json": components["schemas"]["scim-error"]; - }; - }; - }; + 'application/json': components['schemas']['scim-error'] + 'application/scim+json': components['schemas']['scim-error'] + } + } + } parameters: { /** @description Results per page (max 100) */ - "per-page": number; + 'per-page': number /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ - cursor: string; - "delivery-id": number; + cursor: string + 'delivery-id': number /** @description Page number of the results to fetch. */ - page: number; + page: number /** @description Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since: string; + since: string /** @description installation_id parameter */ - "installation-id": number; + 'installation-id': number /** @description grant_id parameter */ - "grant-id": number; + 'grant-id': number /** @description The client ID of your GitHub app. */ - "client-id": string; - "app-slug": string; + 'client-id': string + 'app-slug': string /** @description authorization_id parameter */ - "authorization-id": number; + 'authorization-id': number /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: string; + enterprise: string /** @description Unique identifier of an organization. */ - "org-id": number; + 'org-id': number /** @description Unique identifier of the self-hosted runner group. */ - "runner-group-id": number; + 'runner-group-id': number /** @description Unique identifier of the self-hosted runner. */ - "runner-id": number; + 'runner-id': number /** @description The name of a self-hosted runner's custom label. */ - "runner-label-name": string; + 'runner-label-name': string /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). */ - "audit-log-phrase": string; + 'audit-log-phrase': string /** * @description The event types to include: * @@ -17753,843 +17733,843 @@ export interface components { * * The default is `web`. */ - "audit-log-include": "web" | "git" | "all"; + 'audit-log-include': 'web' | 'git' | 'all' /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor. */ - "audit-log-after": string; + 'audit-log-after': string /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor. */ - "audit-log-before": string; + 'audit-log-before': string /** * @description The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. * * The default is `desc`. */ - "audit-log-order": "desc" | "asc"; + 'audit-log-order': 'desc' | 'asc' /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - "secret-scanning-alert-state": "open" | "resolved"; + 'secret-scanning-alert-state': 'open' | 'resolved' /** * @description A comma-separated list of secret types to return. By default all secret types are returned. * See "[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)" * for a complete list of secret types (API slug). */ - "secret-scanning-alert-secret-type": string; + 'secret-scanning-alert-secret-type': string /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - "secret-scanning-alert-resolution": string; + 'secret-scanning-alert-resolution': string /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor. */ - "pagination-before": string; + 'pagination-before': string /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor. */ - "pagination-after": string; + 'pagination-after': string /** @description gist_id parameter */ - "gist-id": string; + 'gist-id': string /** @description comment_id parameter */ - "comment-id": number; + 'comment-id': number /** @description A list of comma separated label names. Example: `bug,ui,@high` */ - labels: string; + labels: string /** @description One of `asc` (ascending) or `desc` (descending). */ - direction: "asc" | "desc"; + direction: 'asc' | 'desc' /** @description account_id parameter */ - "account-id": number; + 'account-id': number /** @description plan_id parameter */ - "plan-id": number; + 'plan-id': number /** @description One of `created` (when the repository was starred) or `updated` (when it was last pushed to). */ - sort: "created" | "updated"; - owner: string; - repo: string; + sort: 'created' | 'updated' + owner: string + repo: string /** @description If `true`, show notifications marked as read. */ - all: boolean; + all: boolean /** @description If `true`, only shows notifications in which the user is directly participating or mentioned. */ - participating: boolean; + participating: boolean /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - before: string; + before: string /** @description thread_id parameter */ - "thread-id": number; + 'thread-id': number /** @description An organization ID. Only return organizations with an ID greater than this ID. */ - "since-org": number; - org: string; + 'since-org': number + org: string /** @description team_slug parameter */ - "team-slug": string; - "repository-id": number; + 'team-slug': string + 'repository-id': number /** @description secret_name parameter */ - "secret-name": string; - username: string; + 'secret-name': string + username: string /** @description group_id parameter */ - "group-id": number; - "hook-id": number; + 'group-id': number + 'hook-id': number /** @description invitation_id parameter */ - "invitation-id": number; + 'invitation-id': number /** @description migration_id parameter */ - "migration-id": number; + 'migration-id': number /** @description repo_name parameter */ - "repo-name": string; + 'repo-name': string /** @description The selected visibility of the packages. Can be one of `public`, `private`, or `internal`. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set. */ - "package-visibility": "public" | "private" | "internal"; + 'package-visibility': 'public' | 'private' | 'internal' /** @description The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - "package-type": "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + 'package-type': 'npm' | 'maven' | 'rubygems' | 'docker' | 'nuget' | 'container' /** @description The name of the package. */ - "package-name": string; + 'package-name': string /** @description Unique identifier of the package version. */ - "package-version-id": number; - "discussion-number": number; - "comment-number": number; - "reaction-id": number; - "project-id": number; + 'package-version-id': number + 'discussion-number': number + 'comment-number': number + 'reaction-id': number + 'project-id': number /** @description card_id parameter */ - "card-id": number; + 'card-id': number /** @description column_id parameter */ - "column-id": number; + 'column-id': number /** @description artifact_id parameter */ - "artifact-id": number; + 'artifact-id': number /** @description job_id parameter */ - "job-id": number; + 'job-id': number /** @description Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ - actor: string; + actor: string /** @description Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ - "workflow-run-branch": string; + 'workflow-run-branch': string /** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ - event: string; + event: string /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. For a list of the possible `status` and `conclusion` options, see "[Create a check run](https://docs.github.com/rest/reference/checks#create-a-check-run)." */ - "workflow-run-status": - | "completed" - | "action_required" - | "cancelled" - | "failure" - | "neutral" - | "skipped" - | "stale" - | "success" - | "timed_out" - | "in_progress" - | "queued" - | "requested" - | "waiting"; + 'workflow-run-status': + | 'completed' + | 'action_required' + | 'cancelled' + | 'failure' + | 'neutral' + | 'skipped' + | 'stale' + | 'success' + | 'timed_out' + | 'in_progress' + | 'queued' + | 'requested' + | 'waiting' /** @description Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ - created: string; + created: string /** @description If `true` pull requests are omitted from the response (empty array). */ - "exclude-pull-requests": boolean; + 'exclude-pull-requests': boolean /** @description Returns workflow runs with the `check_suite_id` that you specify. */ - "workflow-run-check-suite-id": number; + 'workflow-run-check-suite-id': number /** @description The id of the workflow run. */ - "run-id": number; + 'run-id': number /** @description The attempt number of the workflow run. */ - "attempt-number": number; + 'attempt-number': number /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ - "workflow-id": (number | string) & { [key: string]: unknown }; + 'workflow-id': (number | string) & { [key: string]: unknown } /** @description autolink_id parameter */ - "autolink-id": number; + 'autolink-id': number /** @description The name of the branch. */ - branch: string; + branch: string /** @description check_run_id parameter */ - "check-run-id": number; + 'check-run-id': number /** @description check_suite_id parameter */ - "check-suite-id": number; + 'check-suite-id': number /** @description Returns check runs with the specified `name`. */ - "check-name": string; + 'check-name': string /** @description Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`. */ - status: "queued" | "in_progress" | "completed"; + status: 'queued' | 'in_progress' | 'completed' /** @description The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */ - "tool-name": components["schemas"]["code-scanning-analysis-tool-name"]; + 'tool-name': components['schemas']['code-scanning-analysis-tool-name'] /** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ - "tool-guid": components["schemas"]["code-scanning-analysis-tool-guid"]; + 'tool-guid': components['schemas']['code-scanning-analysis-tool-guid'] /** @description The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ - "git-ref": components["schemas"]["code-scanning-ref"]; + 'git-ref': components['schemas']['code-scanning-ref'] /** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ - "alert-number": components["schemas"]["alert-number"]; + 'alert-number': components['schemas']['alert-number'] /** @description commit_sha parameter */ - "commit-sha": string; + 'commit-sha': string /** @description deployment_id parameter */ - "deployment-id": number; + 'deployment-id': number /** @description The name of the environment */ - "environment-name": string; + 'environment-name': string /** @description A user ID. Only return users with an ID greater than this ID. */ - "since-user": number; + 'since-user': number /** @description issue_number parameter */ - "issue-number": number; + 'issue-number': number /** @description key_id parameter */ - "key-id": number; + 'key-id': number /** @description milestone_number parameter */ - "milestone-number": number; - "pull-number": number; + 'milestone-number': number + 'pull-number': number /** @description review_id parameter */ - "review-id": number; + 'review-id': number /** @description asset_id parameter */ - "asset-id": number; + 'asset-id': number /** @description release_id parameter */ - "release-id": number; + 'release-id': number /** @description Must be one of: `day`, `week`. */ - per: "" | "day" | "week"; + per: '' | 'day' | 'week' /** @description A repository ID. Only return repositories with an ID greater than this ID. */ - "since-repo": number; + 'since-repo': number /** @description Used for pagination: the index of the first result to return. */ - "start-index": number; + 'start-index': number /** @description Used for pagination: the number of results to return. */ - count: number; + count: number /** @description Identifier generated by the GitHub SCIM endpoint. */ - "scim-group-id": string; + 'scim-group-id': string /** @description scim_user_id parameter */ - "scim-user-id": string; + 'scim-user-id': string /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - order: "desc" | "asc"; - "team-id": number; + order: 'desc' | 'asc' + 'team-id': number /** @description ID of the Repository to filter on */ - "repository-id-in-query": number; + 'repository-id-in-query': number /** @description The name of the codespace. */ - "codespace-name": string; + 'codespace-name': string /** @description The ID of the export operation, or `latest`. Currently only `latest` is currently supported. */ - "export-id": string; + 'export-id': string /** @description gpg_key_id parameter */ - "gpg-key-id": number; - }; + 'gpg-key-id': number + } headers: { - link?: string; - "content-type"?: string; - "x-common-marker-version"?: string; - "x-rate-limit-limit"?: number; - "x-rate-limit-remaining"?: number; - "x-rate-limit-reset"?: number; - location?: string; - }; + link?: string + 'content-type'?: string + 'x-common-marker-version'?: string + 'x-rate-limit-limit'?: number + 'x-rate-limit-remaining'?: number + 'x-rate-limit-reset'?: number + location?: string + } } export interface operations { /** Get Hypermedia links to resources accessible in GitHub's REST API */ - "meta/root": { + 'meta/root': { responses: { /** Response */ 200: { content: { - "application/json": { + 'application/json': { /** Format: uri-template */ - current_user_url: string; + current_user_url: string /** Format: uri-template */ - current_user_authorizations_html_url: string; + current_user_authorizations_html_url: string /** Format: uri-template */ - authorizations_url: string; + authorizations_url: string /** Format: uri-template */ - code_search_url: string; + code_search_url: string /** Format: uri-template */ - commit_search_url: string; + commit_search_url: string /** Format: uri-template */ - emails_url: string; + emails_url: string /** Format: uri-template */ - emojis_url: string; + emojis_url: string /** Format: uri-template */ - events_url: string; + events_url: string /** Format: uri-template */ - feeds_url: string; + feeds_url: string /** Format: uri-template */ - followers_url: string; + followers_url: string /** Format: uri-template */ - following_url: string; + following_url: string /** Format: uri-template */ - gists_url: string; + gists_url: string /** Format: uri-template */ - hub_url: string; + hub_url: string /** Format: uri-template */ - issue_search_url: string; + issue_search_url: string /** Format: uri-template */ - issues_url: string; + issues_url: string /** Format: uri-template */ - keys_url: string; + keys_url: string /** Format: uri-template */ - label_search_url: string; + label_search_url: string /** Format: uri-template */ - notifications_url: string; + notifications_url: string /** Format: uri-template */ - organization_url: string; + organization_url: string /** Format: uri-template */ - organization_repositories_url: string; + organization_repositories_url: string /** Format: uri-template */ - organization_teams_url: string; + organization_teams_url: string /** Format: uri-template */ - public_gists_url: string; + public_gists_url: string /** Format: uri-template */ - rate_limit_url: string; + rate_limit_url: string /** Format: uri-template */ - repository_url: string; + repository_url: string /** Format: uri-template */ - repository_search_url: string; + repository_search_url: string /** Format: uri-template */ - current_user_repositories_url: string; + current_user_repositories_url: string /** Format: uri-template */ - starred_url: string; + starred_url: string /** Format: uri-template */ - starred_gists_url: string; + starred_gists_url: string /** Format: uri-template */ - topic_search_url?: string; + topic_search_url?: string /** Format: uri-template */ - user_url: string; + user_url: string /** Format: uri-template */ - user_organizations_url: string; + user_organizations_url: string /** Format: uri-template */ - user_repositories_url: string; + user_repositories_url: string /** Format: uri-template */ - user_search_url: string; - } & { [key: string]: unknown }; - }; - }; - }; - }; + user_search_url: string + } & { [key: string]: unknown } + } + } + } + } /** * Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/rest/reference/apps#list-installations-for-the-authenticated-app)" endpoint. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/get-authenticated": { - parameters: {}; + 'apps/get-authenticated': { + parameters: {} responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["integration"]; - }; - }; - }; - }; + 'application/json': components['schemas']['integration'] + } + } + } + } /** Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. */ - "apps/create-from-manifest": { + 'apps/create-from-manifest': { parameters: { path: { - code: string; - }; - }; + code: string + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["integration"] & + 'application/json': components['schemas']['integration'] & ({ - client_id: string; - client_secret: string; - webhook_secret: string | null; - pem: string; - } & { [key: string]: unknown }) & { [key: string]: unknown }; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + client_id: string + client_secret: string + webhook_secret: string | null + pem: string + } & { [key: string]: unknown }) & { [key: string]: unknown } + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { [key: string]: unknown }; - }; - }; - }; + 'application/json': { [key: string]: unknown } + } + } + } /** * Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/get-webhook-config-for-app": { + 'apps/get-webhook-config-for-app': { responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["webhook-config"]; - }; - }; - }; - }; + 'application/json': components['schemas']['webhook-config'] + } + } + } + } /** * Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/update-webhook-config-for-app": { + 'apps/update-webhook-config-for-app': { responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["webhook-config"]; - }; - }; - }; + 'application/json': components['schemas']['webhook-config'] + } + } + } requestBody: { content: { - "application/json": { - url?: components["schemas"]["webhook-config-url"]; - content_type?: components["schemas"]["webhook-config-content-type"]; - secret?: components["schemas"]["webhook-config-secret"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - } & { [key: string]: unknown }; - }; - }; - }; + 'application/json': { + url?: components['schemas']['webhook-config-url'] + content_type?: components['schemas']['webhook-config-content-type'] + secret?: components['schemas']['webhook-config-secret'] + insecure_ssl?: components['schemas']['webhook-config-insecure-ssl'] + } & { [key: string]: unknown } + } + } + } /** * Returns a list of webhook deliveries for the webhook configured for a GitHub App. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/list-webhook-deliveries": { + 'apps/list-webhook-deliveries': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ - cursor?: components["parameters"]["cursor"]; - }; - }; + cursor?: components['parameters']['cursor'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["hook-delivery-item"][]; - }; - }; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['hook-delivery-item'][] + } + } + 400: components['responses']['bad_request'] + 422: components['responses']['validation_failed'] + } + } /** * Returns a delivery for the webhook configured for a GitHub App. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/get-webhook-delivery": { + 'apps/get-webhook-delivery': { parameters: { path: { - delivery_id: components["parameters"]["delivery-id"]; - }; - }; + delivery_id: components['parameters']['delivery-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["hook-delivery"]; - }; - }; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['hook-delivery'] + } + } + 400: components['responses']['bad_request'] + 422: components['responses']['validation_failed'] + } + } /** * Redeliver a delivery for the webhook configured for a GitHub App. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/redeliver-webhook-delivery": { + 'apps/redeliver-webhook-delivery': { parameters: { path: { - delivery_id: components["parameters"]["delivery-id"]; - }; - }; + delivery_id: components['parameters']['delivery-id'] + } + } responses: { - 202: components["responses"]["accepted"]; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 202: components['responses']['accepted'] + 400: components['responses']['bad_request'] + 422: components['responses']['validation_failed'] + } + } /** * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. * * The permissions the installation has are included under the `permissions` key. */ - "apps/list-installations": { + 'apps/list-installations': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; - outdated?: string; - }; - }; + since?: components['parameters']['since'] + outdated?: string + } + } responses: { /** The permissions the installation has are included under the `permissions` key. */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["installation"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['installation'][] + } + } + } + } /** * Enables an authenticated GitHub App to find an installation's information using the installation id. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/get-installation": { + 'apps/get-installation': { parameters: { path: { /** installation_id parameter */ - installation_id: components["parameters"]["installation-id"]; - }; - }; + installation_id: components['parameters']['installation-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["installation"]; - }; - }; - 404: components["responses"]["not_found"]; - 415: components["responses"]["preview_header_missing"]; - }; - }; + 'application/json': components['schemas']['installation'] + } + } + 404: components['responses']['not_found'] + 415: components['responses']['preview_header_missing'] + } + } /** * Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/reference/apps/#suspend-an-app-installation)" endpoint. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/delete-installation": { + 'apps/delete-installation': { parameters: { path: { /** installation_id parameter */ - installation_id: components["parameters"]["installation-id"]; - }; - }; + installation_id: components['parameters']['installation-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** * Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/create-installation-access-token": { + 'apps/create-installation-access-token': { parameters: { path: { /** installation_id parameter */ - installation_id: components["parameters"]["installation-id"]; - }; - }; + installation_id: components['parameters']['installation-id'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["installation-token"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 415: components["responses"]["preview_header_missing"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['installation-token'] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 415: components['responses']['preview_header_missing'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description List of repository names that the token should have access to */ - repositories?: string[]; + repositories?: string[] /** * @description List of repository IDs that the token should have access to * @example 1 */ - repository_ids?: number[]; - permissions?: components["schemas"]["app-permissions"]; - } & { [key: string]: unknown }; - }; - }; - }; + repository_ids?: number[] + permissions?: components['schemas']['app-permissions'] + } & { [key: string]: unknown } + } + } + } /** * Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/suspend-installation": { + 'apps/suspend-installation': { parameters: { path: { /** installation_id parameter */ - installation_id: components["parameters"]["installation-id"]; - }; - }; + installation_id: components['parameters']['installation-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** * Removes a GitHub App installation suspension. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/unsuspend-installation": { + 'apps/unsuspend-installation': { parameters: { path: { /** installation_id parameter */ - installation_id: components["parameters"]["installation-id"]; - }; - }; + installation_id: components['parameters']['installation-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * * You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/rest/reference/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `["repo", "user"]`. */ - "oauth-authorizations/list-grants": { + 'oauth-authorizations/list-grants': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** The client ID of your GitHub app. */ - client_id?: string; - }; - }; + client_id?: string + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["application-grant"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['application-grant'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - "oauth-authorizations/get-grant": { + 'oauth-authorizations/get-grant': { parameters: { path: { /** grant_id parameter */ - grant_id: components["parameters"]["grant-id"]; - }; - }; + grant_id: components['parameters']['grant-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["application-grant"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['application-grant'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ - "oauth-authorizations/delete-grant": { + 'oauth-authorizations/delete-grant': { parameters: { path: { /** grant_id parameter */ - grant_id: components["parameters"]["grant-id"]; - }; - }; + grant_id: components['parameters']['grant-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** * OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ - "apps/delete-authorization": { + 'apps/delete-authorization': { parameters: { path: { /** The client ID of your GitHub app. */ - client_id: components["parameters"]["client-id"]; - }; - }; + client_id: components['parameters']['client-id'] + } + } responses: { /** Response */ - 204: never; - 422: components["responses"]["validation_failed"]; - }; + 204: never + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The OAuth access token used to authenticate to the GitHub API. */ - access_token: string; - } & { [key: string]: unknown }; - }; - }; - }; + access_token: string + } & { [key: string]: unknown } + } + } + } /** OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the OAuth application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`. */ - "apps/check-token": { + 'apps/check-token': { parameters: { path: { /** The client ID of your GitHub app. */ - client_id: components["parameters"]["client-id"]; - }; - }; + client_id: components['parameters']['client-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["authorization"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['authorization'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The access_token of the OAuth application. */ - access_token: string; - } & { [key: string]: unknown }; - }; - }; - }; + access_token: string + } & { [key: string]: unknown } + } + } + } /** OAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. */ - "apps/delete-token": { + 'apps/delete-token': { parameters: { path: { /** The client ID of your GitHub app. */ - client_id: components["parameters"]["client-id"]; - }; - }; + client_id: components['parameters']['client-id'] + } + } responses: { /** Response */ - 204: never; - 422: components["responses"]["validation_failed"]; - }; + 204: never + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The OAuth access token used to authenticate to the GitHub API. */ - access_token: string; - } & { [key: string]: unknown }; - }; - }; - }; + access_token: string + } & { [key: string]: unknown } + } + } + } /** OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. */ - "apps/reset-token": { + 'apps/reset-token': { parameters: { path: { /** The client ID of your GitHub app. */ - client_id: components["parameters"]["client-id"]; - }; - }; + client_id: components['parameters']['client-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["authorization"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['authorization'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The access_token of the OAuth application. */ - access_token: string; - } & { [key: string]: unknown }; - }; - }; - }; + access_token: string + } & { [key: string]: unknown } + } + } + } /** Use a non-scoped user-to-server OAuth access token to create a repository scoped and/or permission scoped user-to-server OAuth access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. */ - "apps/scope-token": { + 'apps/scope-token': { parameters: { path: { /** The client ID of your GitHub app. */ - client_id: components["parameters"]["client-id"]; - }; - }; + client_id: components['parameters']['client-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["authorization"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['authorization'] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The OAuth access token used to authenticate to the GitHub API. * @example e72e16c7e42f292c6912e7710c838347ae178b4a */ - access_token: string; + access_token: string /** * @description The name of the user or organization to scope the user-to-server access token to. **Required** unless `target_id` is specified. * @example octocat */ - target?: string; + target?: string /** * @description The ID of the user or organization to scope the user-to-server access token to. **Required** unless `target` is specified. * @example 1 */ - target_id?: number; + target_id?: number /** @description The list of repository names to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified. */ - repositories?: string[]; + repositories?: string[] /** * @description The list of repository IDs to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified. * @example 1 */ - repository_ids?: number[]; - permissions?: components["schemas"]["app-permissions"]; - } & { [key: string]: unknown }; - }; - }; - }; + repository_ids?: number[] + permissions?: components['schemas']['app-permissions'] + } & { [key: string]: unknown } + } + } + } /** * **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). * * If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ - "apps/get-by-slug": { + 'apps/get-by-slug': { parameters: { path: { - app_slug: components["parameters"]["app-slug"]; - }; - }; + app_slug: components['parameters']['app-slug'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["integration"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 415: components["responses"]["preview_header_missing"]; - }; - }; + 'application/json': components['schemas']['integration'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 415: components['responses']['preview_header_missing'] + } + } /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - "oauth-authorizations/list-authorizations": { + 'oauth-authorizations/list-authorizations': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** The client ID of your GitHub app. */ - client_id?: string; - }; - }; + client_id?: string + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["authorization"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['authorization'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * @@ -18603,49 +18583,49 @@ export interface operations { * * Organizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in [the GitHub Help documentation](https://docs.github.com/articles/about-identity-and-access-management-with-saml-single-sign-on). */ - "oauth-authorizations/create-authorization": { - parameters: {}; + 'oauth-authorizations/create-authorization': { + parameters: {} responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["authorization"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['authorization'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 410: components['responses']['gone'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description A list of scopes that this authorization is in. * @example public_repo,user */ - scopes?: string[] | null; + scopes?: string[] | null /** * @description A note to remind you what the OAuth token is for. * @example Update all gems */ - note?: string; + note?: string /** @description A URL to remind you what app the OAuth token is for. */ - note_url?: string; + note_url?: string /** @description The OAuth app client key for which to create the token. */ - client_id?: string; + client_id?: string /** @description The OAuth app client secret for which to create the token. */ - client_secret?: string; + client_secret?: string /** @description A unique string to distinguish an authorization from others created for the same client ID and user. */ - fingerprint?: string; - } & { [key: string]: unknown }; - }; - }; - }; + fingerprint?: string + } & { [key: string]: unknown } + } + } + } /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * @@ -18657,60 +18637,60 @@ export interface operations { * * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - "oauth-authorizations/get-or-create-authorization-for-app": { + 'oauth-authorizations/get-or-create-authorization-for-app': { parameters: { path: { /** The client ID of your GitHub app. */ - client_id: components["parameters"]["client-id"]; - }; - }; + client_id: components['parameters']['client-id'] + } + } responses: { /** if returning an existing token */ 200: { headers: { - Location?: string; - }; + Location?: string + } content: { - "application/json": components["schemas"]["authorization"]; - }; - }; + 'application/json': components['schemas']['authorization'] + } + } /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["authorization"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['authorization'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The OAuth app client secret for which to create the token. */ - client_secret: string; + client_secret: string /** * @description A list of scopes that this authorization is in. * @example public_repo,user */ - scopes?: string[] | null; + scopes?: string[] | null /** * @description A note to remind you what the OAuth token is for. * @example Update all gems */ - note?: string; + note?: string /** @description A URL to remind you what app the OAuth token is for. */ - note_url?: string; + note_url?: string /** @description A unique string to distinguish an authorization from others created for the same client ID and user. */ - fingerprint?: string; - } & { [key: string]: unknown }; - }; - }; - }; + fingerprint?: string + } & { [key: string]: unknown } + } + } + } /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * @@ -18720,92 +18700,92 @@ export interface operations { * * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." */ - "oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint": { + 'oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint': { parameters: { path: { /** The client ID of your GitHub app. */ - client_id: components["parameters"]["client-id"]; - fingerprint: string; - }; - }; + client_id: components['parameters']['client-id'] + fingerprint: string + } + } responses: { /** if returning an existing token */ 200: { headers: { - Location?: string; - }; + Location?: string + } content: { - "application/json": components["schemas"]["authorization"]; - }; - }; + 'application/json': components['schemas']['authorization'] + } + } /** Response if returning a new token */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["authorization"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['authorization'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The OAuth app client secret for which to create the token. */ - client_secret: string; + client_secret: string /** * @description A list of scopes that this authorization is in. * @example public_repo,user */ - scopes?: string[] | null; + scopes?: string[] | null /** * @description A note to remind you what the OAuth token is for. * @example Update all gems */ - note?: string; + note?: string /** @description A URL to remind you what app the OAuth token is for. */ - note_url?: string; - } & { [key: string]: unknown }; - }; - }; - }; + note_url?: string + } & { [key: string]: unknown } + } + } + } /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - "oauth-authorizations/get-authorization": { + 'oauth-authorizations/get-authorization': { parameters: { path: { /** authorization_id parameter */ - authorization_id: components["parameters"]["authorization-id"]; - }; - }; + authorization_id: components['parameters']['authorization-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["authorization"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['authorization'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - "oauth-authorizations/delete-authorization": { + 'oauth-authorizations/delete-authorization': { parameters: { path: { /** authorization_id parameter */ - authorization_id: components["parameters"]["authorization-id"]; - }; - }; + authorization_id: components['parameters']['authorization-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * @@ -18813,678 +18793,678 @@ export interface operations { * * You can only send one of these scope keys at a time. */ - "oauth-authorizations/update-authorization": { + 'oauth-authorizations/update-authorization': { parameters: { path: { /** authorization_id parameter */ - authorization_id: components["parameters"]["authorization-id"]; - }; - }; + authorization_id: components['parameters']['authorization-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["authorization"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['authorization'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description A list of scopes that this authorization is in. * @example public_repo,user */ - scopes?: string[] | null; + scopes?: string[] | null /** @description A list of scopes to add to this authorization. */ - add_scopes?: string[]; + add_scopes?: string[] /** @description A list of scopes to remove from this authorization. */ - remove_scopes?: string[]; + remove_scopes?: string[] /** * @description A note to remind you what the OAuth token is for. * @example Update all gems */ - note?: string; + note?: string /** @description A URL to remind you what app the OAuth token is for. */ - note_url?: string; + note_url?: string /** @description A unique string to distinguish an authorization from others created for the same client ID and user. */ - fingerprint?: string; - } & { [key: string]: unknown }; - }; - }; - }; - "codes-of-conduct/get-all-codes-of-conduct": { - parameters: {}; + fingerprint?: string + } & { [key: string]: unknown } + } + } + } + 'codes-of-conduct/get-all-codes-of-conduct': { + parameters: {} responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["code-of-conduct"][]; - }; - }; - 304: components["responses"]["not_modified"]; - }; - }; - "codes-of-conduct/get-conduct-code": { + 'application/json': components['schemas']['code-of-conduct'][] + } + } + 304: components['responses']['not_modified'] + } + } + 'codes-of-conduct/get-conduct-code': { parameters: { path: { - key: string; - }; - }; + key: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["code-of-conduct"]; - }; - }; - 304: components["responses"]["not_modified"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['code-of-conduct'] + } + } + 304: components['responses']['not_modified'] + 404: components['responses']['not_found'] + } + } /** Lists all the emojis available to use on GitHub. */ - "emojis/get": { - parameters: {}; + 'emojis/get': { + parameters: {} responses: { /** Response */ 200: { content: { - "application/json": { [key: string]: string }; - }; - }; - 304: components["responses"]["not_modified"]; - }; - }; + 'application/json': { [key: string]: string } + } + } + 304: components['responses']['not_modified'] + } + } /** * Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - "enterprise-admin/get-github-actions-permissions-enterprise": { + 'enterprise-admin/get-github-actions-permissions-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-enterprise-permissions"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-enterprise-permissions'] + } + } + } + } /** * Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - "enterprise-admin/set-github-actions-permissions-enterprise": { + 'enterprise-admin/set-github-actions-permissions-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { - enabled_organizations: components["schemas"]["enabled-organizations"]; - allowed_actions?: components["schemas"]["allowed-actions"]; - } & { [key: string]: unknown }; - }; - }; - }; + 'application/json': { + enabled_organizations: components['schemas']['enabled-organizations'] + allowed_actions?: components['schemas']['allowed-actions'] + } & { [key: string]: unknown } + } + } + } /** * Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - "enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise": { + 'enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; + enterprise: components['parameters']['enterprise'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - organizations: components["schemas"]["organization-simple"][]; - } & { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': { + total_count: number + organizations: components['schemas']['organization-simple'][] + } & { [key: string]: unknown } + } + } + } + } /** * Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - "enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise": { + 'enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description List of organization IDs to enable for GitHub Actions. */ - selected_organization_ids: number[]; - } & { [key: string]: unknown }; - }; - }; - }; + selected_organization_ids: number[] + } & { [key: string]: unknown } + } + } + } /** * Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - "enterprise-admin/enable-selected-organization-github-actions-enterprise": { + 'enterprise-admin/enable-selected-organization-github-actions-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of an organization. */ - org_id: components["parameters"]["org-id"]; - }; - }; + org_id: components['parameters']['org-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - "enterprise-admin/disable-selected-organization-github-actions-enterprise": { + 'enterprise-admin/disable-selected-organization-github-actions-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of an organization. */ - org_id: components["parameters"]["org-id"]; - }; - }; + org_id: components['parameters']['org-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - "enterprise-admin/get-allowed-actions-enterprise": { + 'enterprise-admin/get-allowed-actions-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["selected-actions"]; - }; - }; - }; - }; + 'application/json': components['schemas']['selected-actions'] + } + } + } + } /** * Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - "enterprise-admin/set-allowed-actions-enterprise": { + 'enterprise-admin/set-allowed-actions-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": components["schemas"]["selected-actions"]; - }; - }; - }; + 'application/json': components['schemas']['selected-actions'] + } + } + } /** * Lists all self-hosted runner groups for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/list-self-hosted-runner-groups-for-enterprise": { + 'enterprise-admin/list-self-hosted-runner-groups-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; + enterprise: components['parameters']['enterprise'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - runner_groups: components["schemas"]["runner-groups-enterprise"][]; - } & { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': { + total_count: number + runner_groups: components['schemas']['runner-groups-enterprise'][] + } & { [key: string]: unknown } + } + } + } + } /** * Creates a new self-hosted runner group for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/create-self-hosted-runner-group-for-enterprise": { + 'enterprise-admin/create-self-hosted-runner-group-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["runner-groups-enterprise"]; - }; - }; - }; + 'application/json': components['schemas']['runner-groups-enterprise'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Name of the runner group. */ - name: string; + name: string /** * @description Visibility of a runner group. You can select all organizations or select individual organization. Can be one of: `all` or `selected` * @enum {string} */ - visibility?: "selected" | "all"; + visibility?: 'selected' | 'all' /** @description List of organization IDs that can access the runner group. */ - selected_organization_ids?: number[]; + selected_organization_ids?: number[] /** @description List of runner IDs to add to the runner group. */ - runners?: number[]; + runners?: number[] /** @description Whether the runner group can be used by `public` repositories. */ - allows_public_repositories?: boolean; - } & { [key: string]: unknown }; - }; - }; - }; + allows_public_repositories?: boolean + } & { [key: string]: unknown } + } + } + } /** * Gets a specific self-hosted runner group for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/get-self-hosted-runner-group-for-enterprise": { + 'enterprise-admin/get-self-hosted-runner-group-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["runner-groups-enterprise"]; - }; - }; - }; - }; + 'application/json': components['schemas']['runner-groups-enterprise'] + } + } + } + } /** * Deletes a self-hosted runner group for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/delete-self-hosted-runner-group-from-enterprise": { + 'enterprise-admin/delete-self-hosted-runner-group-from-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Updates the `name` and `visibility` of a self-hosted runner group in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/update-self-hosted-runner-group-for-enterprise": { + 'enterprise-admin/update-self-hosted-runner-group-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["runner-groups-enterprise"]; - }; - }; - }; + 'application/json': components['schemas']['runner-groups-enterprise'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Name of the runner group. */ - name?: string; + name?: string /** * @description Visibility of a runner group. You can select all organizations or select individual organizations. Can be one of: `all` or `selected` * @default all * @enum {string} */ - visibility?: "selected" | "all"; + visibility?: 'selected' | 'all' /** @description Whether the runner group can be used by `public` repositories. */ - allows_public_repositories?: boolean; - } & { [key: string]: unknown }; - }; - }; - }; + allows_public_repositories?: boolean + } & { [key: string]: unknown } + } + } + } /** * Lists the organizations with access to a self-hosted runner group. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise": { + 'enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; + runner_group_id: components['parameters']['runner-group-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - organizations: components["schemas"]["organization-simple"][]; - } & { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': { + total_count: number + organizations: components['schemas']['organization-simple'][] + } & { [key: string]: unknown } + } + } + } + } /** * Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise": { + 'enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description List of organization IDs that can access the runner group. */ - selected_organization_ids: number[]; - } & { [key: string]: unknown }; - }; - }; - }; + selected_organization_ids: number[] + } & { [key: string]: unknown } + } + } + } /** * Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise": { + 'enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components['parameters']['runner-group-id'] /** Unique identifier of an organization. */ - org_id: components["parameters"]["org-id"]; - }; - }; + org_id: components['parameters']['org-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise": { + 'enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components['parameters']['runner-group-id'] /** Unique identifier of an organization. */ - org_id: components["parameters"]["org-id"]; - }; - }; + org_id: components['parameters']['org-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Lists the self-hosted runners that are in a specific enterprise group. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise": { + 'enterprise-admin/list-self-hosted-runners-in-group-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; + runner_group_id: components['parameters']['runner-group-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - runners: components["schemas"]["runner"][]; - } & { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': { + total_count: number + runners: components['schemas']['runner'][] + } & { [key: string]: unknown } + } + } + } + } /** * Replaces the list of self-hosted runners that are part of an enterprise runner group. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise": { + 'enterprise-admin/set-self-hosted-runners-in-group-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description List of runner IDs to add to the runner group. */ - runners: number[]; - } & { [key: string]: unknown }; - }; - }; - }; + runners: number[] + } & { [key: string]: unknown } + } + } + } /** * Adds a self-hosted runner to a runner group configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` * scope to use this endpoint. */ - "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise": { + 'enterprise-admin/add-self-hosted-runner-to-group-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components['parameters']['runner-group-id'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise": { + 'enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components['parameters']['runner-group-id'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Lists all self-hosted runners configured for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/list-self-hosted-runners-for-enterprise": { + 'enterprise-admin/list-self-hosted-runners-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; + enterprise: components['parameters']['enterprise'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count?: number; - runners?: components["schemas"]["runner"][]; - } & { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': { + total_count?: number + runners?: components['schemas']['runner'][] + } & { [key: string]: unknown } + } + } + } + } /** * Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/list-runner-applications-for-enterprise": { + 'enterprise-admin/list-runner-applications-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["runner-application"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['runner-application'][] + } + } + } + } /** * Returns a token that you can pass to the `config` script. The token expires after one hour. * @@ -19498,22 +19478,22 @@ export interface operations { * ./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN * ``` */ - "enterprise-admin/create-registration-token-for-enterprise": { + 'enterprise-admin/create-registration-token-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["authentication-token"]; - }; - }; - }; - }; + 'application/json': components['schemas']['authentication-token'] + } + } + } + } /** * Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour. * @@ -19528,161 +19508,161 @@ export interface operations { * ./config.sh remove --token TOKEN * ``` */ - "enterprise-admin/create-remove-token-for-enterprise": { + 'enterprise-admin/create-remove-token-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["authentication-token"]; - }; - }; - }; - }; + 'application/json': components['schemas']['authentication-token'] + } + } + } + } /** * Gets a specific self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/get-self-hosted-runner-for-enterprise": { + 'enterprise-admin/get-self-hosted-runner-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["runner"]; - }; - }; - }; - }; + 'application/json': components['schemas']['runner'] + } + } + } + } /** * Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/delete-self-hosted-runner-from-enterprise": { + 'enterprise-admin/delete-self-hosted-runner-from-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Lists all labels for a self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise": { + 'enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - }; - }; + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + } + } /** * Remove all previous custom labels and set the new custom labels for a specific * self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise": { + 'enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; - responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + runner_id: components['parameters']['runner-id'] + } + } + responses: { + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels. */ - labels: string[]; - } & { [key: string]: unknown }; - }; - }; - }; + labels: string[] + } & { [key: string]: unknown } + } + } + } /** * Add custom labels to a self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise": { + 'enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; - responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + runner_id: components['parameters']['runner-id'] + } + } + responses: { + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The names of the custom labels to add to the runner. */ - labels: string[]; - } & { [key: string]: unknown }; - }; - }; - }; + labels: string[] + } & { [key: string]: unknown } + } + } + } /** * Remove all custom labels from a self-hosted runner configured in an * enterprise. Returns the remaining read-only labels from the runner. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise": { + 'enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { - 200: components["responses"]["actions_runner_labels_readonly"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; - }; + 200: components['responses']['actions_runner_labels_readonly'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } + } /** * Remove a custom label from a self-hosted runner configured * in an enterprise. Returns the remaining labels from the runner. @@ -19692,33 +19672,33 @@ export interface operations { * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise": { + 'enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; + runner_id: components['parameters']['runner-id'] /** The name of a self-hosted runner's custom label. */ - name: components["parameters"]["runner-label-name"]; - }; - }; - responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; - }; + name: components['parameters']['runner-label-name'] + } + } + responses: { + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } + } /** Gets the audit log for an enterprise. To use this endpoint, you must be an enterprise admin, and you must use an access token with the `admin:enterprise` scope. */ - "enterprise-admin/get-audit-log": { + 'enterprise-admin/get-audit-log': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; + enterprise: components['parameters']['enterprise'] + } query: { /** A search phrase. For more information, see [Searching the audit log](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). */ - phrase?: components["parameters"]["audit-log-phrase"]; + phrase?: components['parameters']['audit-log-phrase'] /** * The event types to include: * @@ -19728,73 +19708,73 @@ export interface operations { * * The default is `web`. */ - include?: components["parameters"]["audit-log-include"]; + include?: components['parameters']['audit-log-include'] /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor. */ - after?: components["parameters"]["audit-log-after"]; + after?: components['parameters']['audit-log-after'] /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor. */ - before?: components["parameters"]["audit-log-before"]; + before?: components['parameters']['audit-log-before'] /** * The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. * * The default is `desc`. */ - order?: components["parameters"]["audit-log-order"]; + order?: components['parameters']['audit-log-order'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["audit-log-event"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['audit-log-event'][] + } + } + } + } /** * Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. * To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). */ - "secret-scanning/list-alerts-for-enterprise": { + 'secret-scanning/list-alerts-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; + enterprise: components['parameters']['enterprise'] + } query: { /** Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - state?: components["parameters"]["secret-scanning-alert-state"]; + state?: components['parameters']['secret-scanning-alert-state'] /** * A comma-separated list of secret types to return. By default all secret types are returned. * See "[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)" * for a complete list of secret types (API slug). */ - secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; + secret_type?: components['parameters']['secret-scanning-alert-secret-type'] /** A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - resolution?: components["parameters"]["secret-scanning-alert-resolution"]; + resolution?: components['parameters']['secret-scanning-alert-resolution'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor. */ - before?: components["parameters"]["pagination-before"]; + before?: components['parameters']['pagination-before'] /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor. */ - after?: components["parameters"]["pagination-after"]; - }; - }; + after?: components['parameters']['pagination-after'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["organization-secret-scanning-alert"][]; - }; - }; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': components['schemas']['organization-secret-scanning-alert'][] + } + } + 404: components['responses']['not_found'] + 503: components['responses']['service_unavailable'] + } + } /** * Gets the summary of the free and paid GitHub Actions minutes used. * @@ -19802,49 +19782,49 @@ export interface operations { * * The authenticated user must be an enterprise admin. */ - "billing/get-github-actions-billing-ghe": { + 'billing/get-github-actions-billing-ghe': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-billing-usage"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-billing-usage'] + } + } + } + } /** * Gets the GitHub Advanced Security active committers for an enterprise per repository. * Each distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of active_users for each repository. */ - "billing/get-github-advanced-security-billing-ghe": { + 'billing/get-github-advanced-security-billing-ghe': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; + enterprise: components['parameters']['enterprise'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Success */ 200: { content: { - "application/json": components["schemas"]["advanced-security-active-committers"]; - }; - }; - 403: components["responses"]["code_scanning_forbidden_read"]; - }; - }; + 'application/json': components['schemas']['advanced-security-active-committers'] + } + } + 403: components['responses']['code_scanning_forbidden_read'] + } + } /** * Gets the free and paid storage used for GitHub Packages in gigabytes. * @@ -19852,22 +19832,22 @@ export interface operations { * * The authenticated user must be an enterprise admin. */ - "billing/get-github-packages-billing-ghe": { + 'billing/get-github-packages-billing-ghe': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["packages-billing-usage"]; - }; - }; - }; - }; + 'application/json': components['schemas']['packages-billing-usage'] + } + } + } + } /** * Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. * @@ -19875,44 +19855,44 @@ export interface operations { * * The authenticated user must be an enterprise admin. */ - "billing/get-shared-storage-billing-ghe": { + 'billing/get-shared-storage-billing-ghe': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["combined-billing-usage"]; - }; - }; - }; - }; + 'application/json': components['schemas']['combined-billing-usage'] + } + } + } + } /** We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. */ - "activity/list-public-events": { + 'activity/list-public-events': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["event"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': components['schemas']['event'][] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 503: components['responses']['service_unavailable'] + } + } /** * GitHub provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user: * @@ -19926,71 +19906,71 @@ export interface operations { * * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ - "activity/get-feeds": { - parameters: {}; + 'activity/get-feeds': { + parameters: {} responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["feed"]; - }; - }; - }; - }; + 'application/json': components['schemas']['feed'] + } + } + } + } /** Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists: */ - "gists/list": { + 'gists/list': { parameters: { query: { /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["base-gist"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['base-gist'][] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + } + } /** * Allows you to add a new gist with one or more files. * * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. */ - "gists/create": { - parameters: {}; + 'gists/create': { + parameters: {} responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["gist-simple"]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['gist-simple'] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description Description of the gist * @example Example Ruby script */ - description?: string; + description?: string /** * @description Names and content for the files that make up the gist * @example [object Object] @@ -19998,480 +19978,480 @@ export interface operations { files: { [key: string]: { /** @description Content of the file */ - content: string; - } & { [key: string]: unknown }; - }; - public?: (boolean | ("true" | "false")) & { [key: string]: unknown }; - } & { [key: string]: unknown }; - }; - }; - }; + content: string + } & { [key: string]: unknown } + } + public?: (boolean | ('true' | 'false')) & { [key: string]: unknown } + } & { [key: string]: unknown } + } + } + } /** * List public gists sorted by most recently updated to least recently updated. * * Note: With [pagination](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. */ - "gists/list-public": { + 'gists/list-public': { parameters: { query: { /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["base-gist"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['base-gist'][] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } + } /** List the authenticated user's starred gists: */ - "gists/list-starred": { + 'gists/list-starred': { parameters: { query: { /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["base-gist"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; - "gists/get": { + 'application/json': components['schemas']['base-gist'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } + 'gists/get': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - }; - }; + gist_id: components['parameters']['gist-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["gist-simple"]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden_gist"]; - 404: components["responses"]["not_found"]; - }; - }; - "gists/delete": { + 'application/json': components['schemas']['gist-simple'] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden_gist'] + 404: components['responses']['not_found'] + } + } + 'gists/delete': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - }; - }; + gist_id: components['parameters']['gist-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged. */ - "gists/update": { + 'gists/update': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - }; - }; + gist_id: components['parameters']['gist-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["gist-simple"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['gist-simple'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | ({ /** * @description Description of the gist * @example Example Ruby script */ - description?: string; + description?: string /** * @description Names of files to be updated * @example [object Object] */ - files?: { [key: string]: Partial<{ [key: string]: unknown }> }; + files?: { [key: string]: Partial<{ [key: string]: unknown }> } } & { [key: string]: unknown }) - | null; - }; - }; - }; - "gists/list-comments": { + | null + } + } + } + 'gists/list-comments': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - }; + gist_id: components['parameters']['gist-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["gist-comment"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "gists/create-comment": { + 'application/json': components['schemas']['gist-comment'][] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'gists/create-comment': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - }; - }; + gist_id: components['parameters']['gist-id'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["gist-comment"]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['gist-comment'] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The comment text. * @example Body of the attachment */ - body: string; - } & { [key: string]: unknown }; - }; - }; - }; - "gists/get-comment": { + body: string + } & { [key: string]: unknown } + } + } + } + 'gists/get-comment': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; + gist_id: components['parameters']['gist-id'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["gist-comment"]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden_gist"]; - 404: components["responses"]["not_found"]; - }; - }; - "gists/delete-comment": { + 'application/json': components['schemas']['gist-comment'] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden_gist'] + 404: components['responses']['not_found'] + } + } + 'gists/delete-comment': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; + gist_id: components['parameters']['gist-id'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "gists/update-comment": { + 204: never + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'gists/update-comment': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; + gist_id: components['parameters']['gist-id'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["gist-comment"]; - }; - }; - 404: components["responses"]["not_found"]; - }; + 'application/json': components['schemas']['gist-comment'] + } + } + 404: components['responses']['not_found'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The comment text. * @example Body of the attachment */ - body: string; - } & { [key: string]: unknown }; - }; - }; - }; - "gists/list-commits": { + body: string + } & { [key: string]: unknown } + } + } + } + 'gists/list-commits': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - }; + gist_id: components['parameters']['gist-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { headers: { - Link?: string; - }; + Link?: string + } content: { - "application/json": components["schemas"]["gist-commit"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "gists/list-forks": { + 'application/json': components['schemas']['gist-commit'][] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'gists/list-forks': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - }; + gist_id: components['parameters']['gist-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["gist-simple"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['gist-simple'][] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** **Note**: This was previously `/gists/:gist_id/fork`. */ - "gists/fork": { + 'gists/fork': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - }; - }; + gist_id: components['parameters']['gist-id'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; + Location?: string + } content: { - "application/json": components["schemas"]["base-gist"]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "gists/check-is-starred": { + 'application/json': components['schemas']['base-gist'] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } + 'gists/check-is-starred': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - }; - }; + gist_id: components['parameters']['gist-id'] + } + } responses: { /** Response if gist is starred */ - 204: never; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; + 204: never + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] /** Not Found if gist is not starred */ 404: { content: { - "application/json": { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': { [key: string]: unknown } + } + } + } + } /** Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - "gists/star": { + 'gists/star': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - }; - }; + gist_id: components['parameters']['gist-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "gists/unstar": { + 204: never + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'gists/unstar': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - }; - }; + gist_id: components['parameters']['gist-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "gists/get-revision": { + 204: never + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'gists/get-revision': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - sha: string; - }; - }; + gist_id: components['parameters']['gist-id'] + sha: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["gist-simple"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['gist-simple'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** List all templates available to pass as an option when [creating a repository](https://docs.github.com/rest/reference/repos#create-a-repository-for-the-authenticated-user). */ - "gitignore/get-all-templates": { - parameters: {}; + 'gitignore/get-all-templates': { + parameters: {} responses: { /** Response */ 200: { content: { - "application/json": string[]; - }; - }; - 304: components["responses"]["not_modified"]; - }; - }; + 'application/json': string[] + } + } + 304: components['responses']['not_modified'] + } + } /** * The API also allows fetching the source of a single template. * Use the raw [media type](https://docs.github.com/rest/overview/media-types/) to get the raw contents. */ - "gitignore/get-template": { + 'gitignore/get-template': { parameters: { path: { - name: string; - }; - }; + name: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["gitignore-template"]; - }; - }; - 304: components["responses"]["not_modified"]; - }; - }; + 'application/json': components['schemas']['gitignore-template'] + } + } + 304: components['responses']['not_modified'] + } + } /** * List repositories that an app installation can access. * * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ - "apps/list-repos-accessible-to-installation": { + 'apps/list-repos-accessible-to-installation': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - repositories: components["schemas"]["repository"][]; + 'application/json': { + total_count: number + repositories: components['schemas']['repository'][] /** @example selected */ - repository_selection?: string; - } & { [key: string]: unknown }; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + repository_selection?: string + } & { [key: string]: unknown } + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** * Revokes the installation token you're using to authenticate as an installation and access this endpoint. * @@ -20479,13 +20459,13 @@ export interface operations { * * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ - "apps/revoke-installation-access-token": { - parameters: {}; + 'apps/revoke-installation-access-token': { + parameters: {} responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * List issues assigned to the authenticated user across all visible repositories including owned repositories, member * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not @@ -20497,7 +20477,7 @@ export interface operations { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - "issues/list": { + 'issues/list': { parameters: { query: { /** @@ -20508,465 +20488,465 @@ export interface operations { * \* `subscribed`: Issues you're subscribed to updates for * \* `all` or `repos`: All issues the authenticated user can see, regardless of participation or creation */ - filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all"; + filter?: 'assigned' | 'created' | 'mentioned' | 'subscribed' | 'repos' | 'all' /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ - state?: "open" | "closed" | "all"; + state?: 'open' | 'closed' | 'all' /** A list of comma separated label names. Example: `bug,ui,@high` */ - labels?: components["parameters"]["labels"]; + labels?: components['parameters']['labels'] /** What to sort results by. Can be either `created`, `updated`, `comments`. */ - sort?: "created" | "updated" | "comments"; + sort?: 'created' | 'updated' | 'comments' /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; - collab?: boolean; - orgs?: boolean; - owned?: boolean; - pulls?: boolean; + since?: components['parameters']['since'] + collab?: boolean + orgs?: boolean + owned?: boolean + pulls?: boolean /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["issue"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "licenses/get-all-commonly-used": { + 'application/json': components['schemas']['issue'][] + } + } + 304: components['responses']['not_modified'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } + 'licenses/get-all-commonly-used': { parameters: { query: { - featured?: boolean; + featured?: boolean /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["license-simple"][]; - }; - }; - 304: components["responses"]["not_modified"]; - }; - }; - "licenses/get": { + 'application/json': components['schemas']['license-simple'][] + } + } + 304: components['responses']['not_modified'] + } + } + 'licenses/get': { parameters: { path: { - license: string; - }; - }; + license: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["license"]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "markdown/render": { - parameters: {}; + 'application/json': components['schemas']['license'] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'markdown/render': { + parameters: {} responses: { /** Response */ 200: { headers: { - "Content-Length"?: string; - }; - content: { - "text/html": string; - }; - }; - 304: components["responses"]["not_modified"]; - }; + 'Content-Length'?: string + } + content: { + 'text/html': string + } + } + 304: components['responses']['not_modified'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The Markdown text to render in HTML. */ - text: string; + text: string /** * @description The rendering mode. Can be either `markdown` or `gfm`. * @default markdown * @example markdown * @enum {string} */ - mode?: "markdown" | "gfm"; + mode?: 'markdown' | 'gfm' /** @description The repository context to use when creating references in `gfm` mode. For example, setting `context` to `octo-org/octo-repo` will change the text `#42` into an HTML link to issue 42 in the `octo-org/octo-repo` repository. */ - context?: string; - } & { [key: string]: unknown }; - }; - }; - }; + context?: string + } & { [key: string]: unknown } + } + } + } /** You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less. */ - "markdown/render-raw": { - parameters: {}; + 'markdown/render-raw': { + parameters: {} responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "text/html": string; - }; - }; - 304: components["responses"]["not_modified"]; - }; + 'text/html': string + } + } + 304: components['responses']['not_modified'] + } requestBody: { content: { - "text/plain": string; - "text/x-markdown": string; - }; - }; - }; + 'text/plain': string + 'text/x-markdown': string + } + } + } /** * Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - "apps/get-subscription-plan-for-account": { + 'apps/get-subscription-plan-for-account': { parameters: { path: { /** account_id parameter */ - account_id: components["parameters"]["account-id"]; - }; - }; + account_id: components['parameters']['account-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["marketplace-purchase"]; - }; - }; - 401: components["responses"]["requires_authentication"]; + 'application/json': components['schemas']['marketplace-purchase'] + } + } + 401: components['responses']['requires_authentication'] /** Not Found when the account has not purchased the listing */ 404: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } + } + } /** * Lists all plans that are part of your GitHub Marketplace listing. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - "apps/list-plans": { + 'apps/list-plans': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["marketplace-listing-plan"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['marketplace-listing-plan'][] + } + } + 401: components['responses']['requires_authentication'] + 404: components['responses']['not_found'] + } + } /** * Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - "apps/list-accounts-for-plan": { + 'apps/list-accounts-for-plan': { parameters: { path: { /** plan_id parameter */ - plan_id: components["parameters"]["plan-id"]; - }; + plan_id: components['parameters']['plan-id'] + } query: { /** One of `created` (when the repository was starred) or `updated` (when it was last pushed to). */ - sort?: components["parameters"]["sort"]; + sort?: components['parameters']['sort'] /** To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter. */ - direction?: "asc" | "desc"; + direction?: 'asc' | 'desc' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["marketplace-purchase"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['marketplace-purchase'][] + } + } + 401: components['responses']['requires_authentication'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** * Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - "apps/get-subscription-plan-for-account-stubbed": { + 'apps/get-subscription-plan-for-account-stubbed': { parameters: { path: { /** account_id parameter */ - account_id: components["parameters"]["account-id"]; - }; - }; + account_id: components['parameters']['account-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["marketplace-purchase"]; - }; - }; - 401: components["responses"]["requires_authentication"]; + 'application/json': components['schemas']['marketplace-purchase'] + } + } + 401: components['responses']['requires_authentication'] /** Not Found when the account has not purchased the listing */ - 404: unknown; - }; - }; + 404: unknown + } + } /** * Lists all plans that are part of your GitHub Marketplace listing. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - "apps/list-plans-stubbed": { + 'apps/list-plans-stubbed': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["marketplace-listing-plan"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - }; - }; + 'application/json': components['schemas']['marketplace-listing-plan'][] + } + } + 401: components['responses']['requires_authentication'] + } + } /** * Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - "apps/list-accounts-for-plan-stubbed": { + 'apps/list-accounts-for-plan-stubbed': { parameters: { path: { /** plan_id parameter */ - plan_id: components["parameters"]["plan-id"]; - }; + plan_id: components['parameters']['plan-id'] + } query: { /** One of `created` (when the repository was starred) or `updated` (when it was last pushed to). */ - sort?: components["parameters"]["sort"]; + sort?: components['parameters']['sort'] /** To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter. */ - direction?: "asc" | "desc"; + direction?: 'asc' | 'desc' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["marketplace-purchase"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - }; - }; + 'application/json': components['schemas']['marketplace-purchase'][] + } + } + 401: components['responses']['requires_authentication'] + } + } /** * Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://docs.github.com/articles/about-github-s-ip-addresses/)." * * **Note:** The IP addresses shown in the documentation's response are only example values. You must always query the API directly to get the latest list of IP addresses. */ - "meta/get": { - parameters: {}; + 'meta/get': { + parameters: {} responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["api-overview"]; - }; - }; - 304: components["responses"]["not_modified"]; - }; - }; - "activity/list-public-events-for-repo-network": { + 'application/json': components['schemas']['api-overview'] + } + } + 304: components['responses']['not_modified'] + } + } + 'activity/list-public-events-for-repo-network': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["event"][]; - }; - }; - 301: components["responses"]["moved_permanently"]; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['event'][] + } + } + 301: components['responses']['moved_permanently'] + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** List all notifications for the current user, sorted by most recently updated. */ - "activity/list-notifications-for-authenticated-user": { + 'activity/list-notifications-for-authenticated-user': { parameters: { query: { /** If `true`, show notifications marked as read. */ - all?: components["parameters"]["all"]; + all?: components['parameters']['all'] /** If `true`, only shows notifications in which the user is directly participating or mentioned. */ - participating?: components["parameters"]["participating"]; + participating?: components['parameters']['participating'] /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - before?: components["parameters"]["before"]; + before?: components['parameters']['before'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["thread"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['thread'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } + } /** Marks all notifications as "read" removes it from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ - "activity/mark-notifications-as-read": { - parameters: {}; + 'activity/mark-notifications-as-read': { + parameters: {} responses: { /** Response */ 202: { content: { - "application/json": { - message?: string; - } & { [key: string]: unknown }; - }; - }; + 'application/json': { + message?: string + } & { [key: string]: unknown } + } + } /** Reset Content */ - 205: unknown; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; + 205: unknown + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * Format: date-time * @description Describes the last point that notifications were checked. */ - last_read_at?: string; + last_read_at?: string /** @description Whether the notification has been read. */ - read?: boolean; - } & { [key: string]: unknown }; - }; - }; - }; - "activity/get-thread": { + read?: boolean + } & { [key: string]: unknown } + } + } + } + 'activity/get-thread': { parameters: { path: { /** thread_id parameter */ - thread_id: components["parameters"]["thread-id"]; - }; - }; + thread_id: components['parameters']['thread-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["thread"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; - "activity/mark-thread-as-read": { + 'application/json': components['schemas']['thread'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } + 'activity/mark-thread-as-read': { parameters: { path: { /** thread_id parameter */ - thread_id: components["parameters"]["thread-id"]; - }; - }; + thread_id: components['parameters']['thread-id'] + } + } responses: { /** Reset Content */ - 205: unknown; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - }; - }; + 205: unknown + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + } + } /** * This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/rest/reference/activity#get-a-repository-subscription). * * Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. */ - "activity/get-thread-subscription-for-authenticated-user": { + 'activity/get-thread-subscription-for-authenticated-user': { parameters: { path: { /** thread_id parameter */ - thread_id: components["parameters"]["thread-id"]; - }; - }; + thread_id: components['parameters']['thread-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["thread-subscription"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['thread-subscription'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** * If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**. * @@ -20974,214 +20954,213 @@ export interface operations { * * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/rest/reference/activity#delete-a-thread-subscription) endpoint. */ - "activity/set-thread-subscription": { + 'activity/set-thread-subscription': { parameters: { path: { /** thread_id parameter */ - thread_id: components["parameters"]["thread-id"]; - }; - }; + thread_id: components['parameters']['thread-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["thread-subscription"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; + 'application/json': components['schemas']['thread-subscription'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Whether to block all notifications from a thread. */ - ignored?: boolean; - } & { [key: string]: unknown }; - }; - }; - }; + ignored?: boolean + } & { [key: string]: unknown } + } + } + } /** Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/rest/reference/activity#set-a-thread-subscription) endpoint and set `ignore` to `true`. */ - "activity/delete-thread-subscription": { + 'activity/delete-thread-subscription': { parameters: { path: { /** thread_id parameter */ - thread_id: components["parameters"]["thread-id"]; - }; - }; + thread_id: components['parameters']['thread-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** Get the octocat as ASCII art */ - "meta/get-octocat": { + 'meta/get-octocat': { parameters: { query: { /** The words to show in Octocat's speech bubble */ - s?: string; - }; - }; + s?: string + } + } responses: { /** Response */ 200: { content: { - "application/octocat-stream": string; - }; - }; - }; - }; + 'application/octocat-stream': string + } + } + } + } /** * Lists all organizations, in the order that they were created on GitHub. * * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of organizations. */ - "orgs/list": { + 'orgs/list': { parameters: { query: { /** An organization ID. Only return organizations with an ID greater than this ID. */ - since?: components["parameters"]["since-org"]; + since?: components['parameters']['since-org'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { headers: { - Link?: string; - }; + Link?: string + } content: { - "application/json": components["schemas"]["organization-simple"][]; - }; - }; - 304: components["responses"]["not_modified"]; - }; - }; + 'application/json': components['schemas']['organization-simple'][] + } + } + 304: components['responses']['not_modified'] + } + } /** * List the custom repository roles available in this organization. In order to see custom * repository roles in an organization, the authenticated user must be an organization owner. * * For more information on custom repository roles, see "[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)". */ - "orgs/list-custom-roles": { + 'orgs/list-custom-roles': { parameters: { path: { - organization_id: string; - }; - }; + organization_id: string + } + } responses: { /** Response - list of custom role names */ 200: { content: { - "application/json": { + 'application/json': { /** * @description The number of custom roles in this organization * @example 3 */ - total_count?: number; - custom_roles?: components["schemas"]["organization-custom-repository-role"][]; - } & { [key: string]: unknown }; - }; - }; - }; - }; + total_count?: number + custom_roles?: components['schemas']['organization-custom-repository-role'][] + } & { [key: string]: unknown } + } + } + } + } /** * Lists a connection between a team and an external group. * * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ - "teams/list-linked-external-idp-groups-to-team-for-org": { + 'teams/list-linked-external-idp-groups-to-team-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; - }; + team_slug: components['parameters']['team-slug'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["external-groups"]; - }; - }; - }; - }; + 'application/json': components['schemas']['external-groups'] + } + } + } + } /** * To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). * * GitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub plan. See "[Authenticating with GitHub Apps](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/)" for details. For an example response, see 'Response with GitHub plan information' below." */ - "orgs/get": { + 'orgs/get': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["organization-full"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['organization-full'] + } + } + 404: components['responses']['not_found'] + } + } /** * **Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). * * Enables an authenticated organization owner with the `admin:org` scope to update the organization's profile and member privileges. */ - "orgs/update": { + 'orgs/update': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["organization-full"]; - }; - }; - 409: components["responses"]["conflict"]; + 'application/json': components['schemas']['organization-full'] + } + } + 409: components['responses']['conflict'] /** Validation failed */ 422: { content: { - "application/json": ( - | components["schemas"]["validation-error"] - | components["schemas"]["validation-error-simple"] - ) & { [key: string]: unknown }; - }; - }; - }; + 'application/json': (components['schemas']['validation-error'] | components['schemas']['validation-error-simple']) & { + [key: string]: unknown + } + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Billing email address. This address is not publicized. */ - billing_email?: string; + billing_email?: string /** @description The company name. */ - company?: string; + company?: string /** @description The publicly visible email address. */ - email?: string; + email?: string /** @description The Twitter username of the company. */ - twitter_username?: string; + twitter_username?: string /** @description The location. */ - location?: string; + location?: string /** @description The shorthand name of the company. */ - name?: string; + name?: string /** @description The description of the company. */ - description?: string; + description?: string /** @description Toggles whether an organization can use organization projects. */ - has_organization_projects?: boolean; + has_organization_projects?: boolean /** @description Toggles whether repositories that belong to the organization can use repository projects. */ - has_repository_projects?: boolean; + has_repository_projects?: boolean /** * @description Default permission level members have for organization repositories: * \* `read` - can pull, but not push to or administer this repository. @@ -21191,7 +21170,7 @@ export interface operations { * @default read * @enum {string} */ - default_repository_permission?: "read" | "write" | "admin" | "none"; + default_repository_permission?: 'read' | 'write' | 'admin' | 'none' /** * @description Toggles the ability of non-admin organization members to create repositories. Can be one of: * \* `true` - all organization members can create repositories. @@ -21200,28 +21179,28 @@ export interface operations { * **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. * @default true */ - members_can_create_repositories?: boolean; + members_can_create_repositories?: boolean /** * @description Toggles whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. Can be one of: * \* `true` - all organization members can create internal repositories. * \* `false` - only organization owners can create internal repositories. * Default: `true`. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */ - members_can_create_internal_repositories?: boolean; + members_can_create_internal_repositories?: boolean /** * @description Toggles whether organization members can create private repositories, which are visible to organization members with permission. Can be one of: * \* `true` - all organization members can create private repositories. * \* `false` - only organization owners can create private repositories. * Default: `true`. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */ - members_can_create_private_repositories?: boolean; + members_can_create_private_repositories?: boolean /** * @description Toggles whether organization members can create public repositories, which are visible to anyone. Can be one of: * \* `true` - all organization members can create public repositories. * \* `false` - only organization owners can create public repositories. * Default: `true`. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */ - members_can_create_public_repositories?: boolean; + members_can_create_public_repositories?: boolean /** * @description Specifies which types of repositories non-admin organization members can create. Can be one of: * \* `all` - all organization members can create public and private repositories. @@ -21230,60 +21209,60 @@ export interface operations { * **Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details. * @enum {string} */ - members_allowed_repository_creation_type?: "all" | "private" | "none"; + members_allowed_repository_creation_type?: 'all' | 'private' | 'none' /** * @description Toggles whether organization members can create GitHub Pages sites. Can be one of: * \* `true` - all organization members can create GitHub Pages sites. * \* `false` - no organization members can create GitHub Pages sites. Existing published sites will not be impacted. * @default true */ - members_can_create_pages?: boolean; + members_can_create_pages?: boolean /** * @description Toggles whether organization members can create public GitHub Pages sites. Can be one of: * \* `true` - all organization members can create public GitHub Pages sites. * \* `false` - no organization members can create public GitHub Pages sites. Existing published sites will not be impacted. * @default true */ - members_can_create_public_pages?: boolean; + members_can_create_public_pages?: boolean /** * @description Toggles whether organization members can create private GitHub Pages sites. Can be one of: * \* `true` - all organization members can create private GitHub Pages sites. * \* `false` - no organization members can create private GitHub Pages sites. Existing published sites will not be impacted. * @default true */ - members_can_create_private_pages?: boolean; + members_can_create_private_pages?: boolean /** * @description Toggles whether organization members can fork private organization repositories. Can be one of: * \* `true` - all organization members can fork private repositories within the organization. * \* `false` - no organization members can fork private repositories within the organization. */ - members_can_fork_private_repositories?: boolean; + members_can_fork_private_repositories?: boolean /** @example "http://github.blog" */ - blog?: string; - } & { [key: string]: unknown }; - }; - }; - }; + blog?: string + } & { [key: string]: unknown } + } + } + } /** * Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - "actions/get-github-actions-permissions-organization": { + 'actions/get-github-actions-permissions-organization': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-organization-permissions"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-organization-permissions'] + } + } + } + } /** * Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization. * @@ -21291,132 +21270,132 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - "actions/set-github-actions-permissions-organization": { + 'actions/set-github-actions-permissions-organization': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { - enabled_repositories: components["schemas"]["enabled-repositories"]; - allowed_actions?: components["schemas"]["allowed-actions"]; - } & { [key: string]: unknown }; - }; - }; - }; + 'application/json': { + enabled_repositories: components['schemas']['enabled-repositories'] + allowed_actions?: components['schemas']['allowed-actions'] + } & { [key: string]: unknown } + } + } + } /** * Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - "actions/list-selected-repositories-enabled-github-actions-organization": { + 'actions/list-selected-repositories-enabled-github-actions-organization': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - repositories: components["schemas"]["repository"][]; - } & { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': { + total_count: number + repositories: components['schemas']['repository'][] + } & { [key: string]: unknown } + } + } + } + } /** * Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - "actions/set-selected-repositories-enabled-github-actions-organization": { + 'actions/set-selected-repositories-enabled-github-actions-organization': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description List of repository IDs to enable for GitHub Actions. */ - selected_repository_ids: number[]; - } & { [key: string]: unknown }; - }; - }; - }; + selected_repository_ids: number[] + } & { [key: string]: unknown } + } + } + } /** * Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - "actions/enable-selected-repository-github-actions-organization": { + 'actions/enable-selected-repository-github-actions-organization': { parameters: { path: { - org: components["parameters"]["org"]; - repository_id: components["parameters"]["repository-id"]; - }; - }; + org: components['parameters']['org'] + repository_id: components['parameters']['repository-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - "actions/disable-selected-repository-github-actions-organization": { + 'actions/disable-selected-repository-github-actions-organization': { parameters: { path: { - org: components["parameters"]["org"]; - repository_id: components["parameters"]["repository-id"]; - }; - }; + org: components['parameters']['org'] + repository_id: components['parameters']['repository-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."" * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - "actions/get-allowed-actions-organization": { + 'actions/get-allowed-actions-organization': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["selected-actions"]; - }; - }; - }; - }; + 'application/json': components['schemas']['selected-actions'] + } + } + } + } /** * Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * @@ -21426,65 +21405,65 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - "actions/set-allowed-actions-organization": { + 'actions/set-allowed-actions-organization': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": components["schemas"]["selected-actions"]; - }; - }; - }; + 'application/json': components['schemas']['selected-actions'] + } + } + } /** * Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, * as well if GitHub Actions can submit approving pull request reviews. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - "actions/get-github-actions-default-workflow-permissions-organization": { + 'actions/get-github-actions-default-workflow-permissions-organization': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-get-default-workflow-permissions"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-get-default-workflow-permissions'] + } + } + } + } /** * Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions * can submit approving pull request reviews. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - "actions/set-github-actions-default-workflow-permissions-organization": { + 'actions/set-github-actions-default-workflow-permissions-organization': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": components["schemas"]["actions-set-default-workflow-permissions"]; - }; - }; - }; + 'application/json': components['schemas']['actions-set-default-workflow-permissions'] + } + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21492,30 +21471,30 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/list-self-hosted-runner-groups-for-org": { + 'actions/list-self-hosted-runner-groups-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - runner_groups: components["schemas"]["runner-groups-org"][]; - } & { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': { + total_count: number + runner_groups: components['schemas']['runner-groups-org'][] + } & { [key: string]: unknown } + } + } + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21523,41 +21502,41 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/create-self-hosted-runner-group-for-org": { + 'actions/create-self-hosted-runner-group-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["runner-groups-org"]; - }; - }; - }; + 'application/json': components['schemas']['runner-groups-org'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Name of the runner group. */ - name: string; + name: string /** * @description Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories. Can be one of: `all`, `selected`, or `private`. * @default all * @enum {string} */ - visibility?: "selected" | "all" | "private"; + visibility?: 'selected' | 'all' | 'private' /** @description List of repository IDs that can access the runner group. */ - selected_repository_ids?: number[]; + selected_repository_ids?: number[] /** @description List of runner IDs to add to the runner group. */ - runners?: number[]; + runners?: number[] /** @description Whether the runner group can be used by `public` repositories. */ - allows_public_repositories?: boolean; - } & { [key: string]: unknown }; - }; - }; - }; + allows_public_repositories?: boolean + } & { [key: string]: unknown } + } + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21565,23 +21544,23 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/get-self-hosted-runner-group-for-org": { + 'actions/get-self-hosted-runner-group-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["runner-groups-org"]; - }; - }; - }; - }; + 'application/json': components['schemas']['runner-groups-org'] + } + } + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21589,19 +21568,19 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/delete-self-hosted-runner-group-from-org": { + 'actions/delete-self-hosted-runner-group-from-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21609,38 +21588,38 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/update-self-hosted-runner-group-for-org": { + 'actions/update-self-hosted-runner-group-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["runner-groups-org"]; - }; - }; - }; + 'application/json': components['schemas']['runner-groups-org'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Name of the runner group. */ - name: string; + name: string /** * @description Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories. Can be one of: `all`, `selected`, or `private`. * @enum {string} */ - visibility?: "selected" | "all" | "private"; + visibility?: 'selected' | 'all' | 'private' /** @description Whether the runner group can be used by `public` repositories. */ - allows_public_repositories?: boolean; - } & { [key: string]: unknown }; - }; - }; - }; + allows_public_repositories?: boolean + } & { [key: string]: unknown } + } + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21648,32 +21627,32 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/list-repo-access-to-self-hosted-runner-group-in-org": { + 'actions/list-repo-access-to-self-hosted-runner-group-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; + runner_group_id: components['parameters']['runner-group-id'] + } query: { /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - repositories: components["schemas"]["minimal-repository"][]; - } & { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': { + total_count: number + repositories: components['schemas']['minimal-repository'][] + } & { [key: string]: unknown } + } + } + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21681,27 +21660,27 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/set-repo-access-to-self-hosted-runner-group-in-org": { + 'actions/set-repo-access-to-self-hosted-runner-group-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description List of repository IDs that can access the runner group. */ - selected_repository_ids: number[]; - } & { [key: string]: unknown }; - }; - }; - }; + selected_repository_ids: number[] + } & { [key: string]: unknown } + } + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21711,20 +21690,20 @@ export interface operations { * You must authenticate using an access token with the `admin:org` * scope to use this endpoint. */ - "actions/add-repo-access-to-self-hosted-runner-group-in-org": { + 'actions/add-repo-access-to-self-hosted-runner-group-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - repository_id: components["parameters"]["repository-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + repository_id: components['parameters']['repository-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21733,20 +21712,20 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/remove-repo-access-to-self-hosted-runner-group-in-org": { + 'actions/remove-repo-access-to-self-hosted-runner-group-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - repository_id: components["parameters"]["repository-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + repository_id: components['parameters']['repository-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21754,33 +21733,33 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/list-self-hosted-runners-in-group-for-org": { + 'actions/list-self-hosted-runners-in-group-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; + runner_group_id: components['parameters']['runner-group-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - runners: components["schemas"]["runner"][]; - } & { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': { + total_count: number + runners: components['schemas']['runner'][] + } & { [key: string]: unknown } + } + } + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21788,27 +21767,27 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/set-self-hosted-runners-in-group-for-org": { + 'actions/set-self-hosted-runners-in-group-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description List of runner IDs to add to the runner group. */ - runners: number[]; - } & { [key: string]: unknown }; - }; - }; - }; + runners: number[] + } & { [key: string]: unknown } + } + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21818,21 +21797,21 @@ export interface operations { * You must authenticate using an access token with the `admin:org` * scope to use this endpoint. */ - "actions/add-self-hosted-runner-to-group-for-org": { + 'actions/add-self-hosted-runner-to-group-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components['parameters']['runner-group-id'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21841,71 +21820,71 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/remove-self-hosted-runner-from-group-for-org": { + 'actions/remove-self-hosted-runner-from-group-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components['parameters']['runner-group-id'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Lists all self-hosted runners configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/list-self-hosted-runners-for-org": { + 'actions/list-self-hosted-runners-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - runners: components["schemas"]["runner"][]; - } & { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': { + total_count: number + runners: components['schemas']['runner'][] + } & { [key: string]: unknown } + } + } + } + } /** * Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/list-runner-applications-for-org": { + 'actions/list-runner-applications-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["runner-application"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['runner-application'][] + } + } + } + } /** * Returns a token that you can pass to the `config` script. The token expires after one hour. * @@ -21919,21 +21898,21 @@ export interface operations { * ./config.sh --url https://github.com/octo-org --token TOKEN * ``` */ - "actions/create-registration-token-for-org": { + 'actions/create-registration-token-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["authentication-token"]; - }; - }; - }; - }; + 'application/json': components['schemas']['authentication-token'] + } + } + } + } /** * Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour. * @@ -21948,153 +21927,153 @@ export interface operations { * ./config.sh remove --token TOKEN * ``` */ - "actions/create-remove-token-for-org": { + 'actions/create-remove-token-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["authentication-token"]; - }; - }; - }; - }; + 'application/json': components['schemas']['authentication-token'] + } + } + } + } /** * Gets a specific self-hosted runner configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/get-self-hosted-runner-for-org": { + 'actions/get-self-hosted-runner-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["runner"]; - }; - }; - }; - }; + 'application/json': components['schemas']['runner'] + } + } + } + } /** * Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/delete-self-hosted-runner-from-org": { + 'actions/delete-self-hosted-runner-from-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Lists all labels for a self-hosted runner configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/list-labels-for-self-hosted-runner-for-org": { + 'actions/list-labels-for-self-hosted-runner-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - }; - }; + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + } + } /** * Remove all previous custom labels and set the new custom labels for a specific * self-hosted runner configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/set-custom-labels-for-self-hosted-runner-for-org": { + 'actions/set-custom-labels-for-self-hosted-runner-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; - responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + runner_id: components['parameters']['runner-id'] + } + } + responses: { + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels. */ - labels: string[]; - } & { [key: string]: unknown }; - }; - }; - }; + labels: string[] + } & { [key: string]: unknown } + } + } + } /** * Add custom labels to a self-hosted runner configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/add-custom-labels-to-self-hosted-runner-for-org": { + 'actions/add-custom-labels-to-self-hosted-runner-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; - responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + runner_id: components['parameters']['runner-id'] + } + } + responses: { + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The names of the custom labels to add to the runner. */ - labels: string[]; - } & { [key: string]: unknown }; - }; - }; - }; + labels: string[] + } & { [key: string]: unknown } + } + } + } /** * Remove all custom labels from a self-hosted runner configured in an * organization. Returns the remaining read-only labels from the runner. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/remove-all-custom-labels-from-self-hosted-runner-for-org": { + 'actions/remove-all-custom-labels-from-self-hosted-runner-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { - 200: components["responses"]["actions_runner_labels_readonly"]; - 404: components["responses"]["not_found"]; - }; - }; + 200: components['responses']['actions_runner_labels_readonly'] + 404: components['responses']['not_found'] + } + } /** * Remove a custom label from a self-hosted runner configured * in an organization. Returns the remaining labels from the runner. @@ -22104,82 +22083,82 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/remove-custom-label-from-self-hosted-runner-for-org": { + 'actions/remove-custom-label-from-self-hosted-runner-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; + runner_id: components['parameters']['runner-id'] /** The name of a self-hosted runner's custom label. */ - name: components["parameters"]["runner-label-name"]; - }; - }; - responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; - }; + name: components['parameters']['runner-label-name'] + } + } + responses: { + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } + } /** Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - "actions/list-org-secrets": { + 'actions/list-org-secrets': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - secrets: components["schemas"]["organization-actions-secret"][]; - } & { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': { + total_count: number + secrets: components['schemas']['organization-actions-secret'][] + } & { [key: string]: unknown } + } + } + } + } /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - "actions/get-org-public-key": { + 'actions/get-org-public-key': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-public-key"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-public-key'] + } + } + } + } /** Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - "actions/get-org-secret": { + 'actions/get-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["organization-actions-secret"]; - }; - }; - }; - }; + 'application/json': components['schemas']['organization-actions-secret'] + } + } + } + } /** * Creates or updates an organization secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -22257,31 +22236,31 @@ export interface operations { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - "actions/create-or-update-org-secret": { + 'actions/create-or-update-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response when creating a secret */ 201: { content: { - "application/json": components["schemas"]["empty-object"]; - }; - }; + 'application/json': components['schemas']['empty-object'] + } + } /** Response when updating a secret */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/reference/actions#get-an-organization-public-key) endpoint. */ - encrypted_value?: string; + encrypted_value?: string /** @description ID of the key you used to encrypt the secret. */ - key_id?: string; + key_id?: string /** * @description Configures the access that repositories have to the organization secret. Can be one of: * \- `all` - All repositories in an organization can access the secret. @@ -22289,123 +22268,123 @@ export interface operations { * \- `selected` - Only specific repositories can access the secret. * @enum {string} */ - visibility: "all" | "private" | "selected"; + visibility: 'all' | 'private' | 'selected' /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/reference/actions#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/actions#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints. */ - selected_repository_ids?: string[]; - } & { [key: string]: unknown }; - }; - }; - }; + selected_repository_ids?: string[] + } & { [key: string]: unknown } + } + } + } /** Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - "actions/delete-org-secret": { + 'actions/delete-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - "actions/list-selected-repos-for-org-secret": { + 'actions/list-selected-repos-for-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; + secret_name: components['parameters']['secret-name'] + } query: { /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - repositories: components["schemas"]["minimal-repository"][]; - } & { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': { + total_count: number + repositories: components['schemas']['minimal-repository'][] + } & { [key: string]: unknown } + } + } + } + } /** Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - "actions/set-selected-repos-for-org-secret": { + 'actions/set-selected-repos-for-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/actions#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints. */ - selected_repository_ids: number[]; - } & { [key: string]: unknown }; - }; - }; - }; + selected_repository_ids: number[] + } & { [key: string]: unknown } + } + } + } /** Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - "actions/add-selected-repo-to-org-secret": { + 'actions/add-selected-repo-to-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - repository_id: number; - }; - }; + secret_name: components['parameters']['secret-name'] + repository_id: number + } + } responses: { /** No Content when repository was added to the selected list */ - 204: never; + 204: never /** Conflict when visibility type is not set to selected */ - 409: unknown; - }; - }; + 409: unknown + } + } /** Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - "actions/remove-selected-repo-from-org-secret": { + 'actions/remove-selected-repo-from-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - repository_id: number; - }; - }; + secret_name: components['parameters']['secret-name'] + repository_id: number + } + } responses: { /** Response when repository was removed from the selected list */ - 204: never; + 204: never /** Conflict when visibility type not set to selected */ - 409: unknown; - }; - }; + 409: unknown + } + } /** * Gets the audit log for an organization. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization)." * * This endpoint is available for organizations on GitHub Enterprise Cloud. To use this endpoint, you must be an organization owner, and you must use an access token with the `admin:org` scope. GitHub Apps must have the `organization_administration` read permission to use this endpoint. */ - "orgs/get-audit-log": { + 'orgs/get-audit-log': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** A search phrase. For more information, see [Searching the audit log](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). */ - phrase?: components["parameters"]["audit-log-phrase"]; + phrase?: components['parameters']['audit-log-phrase'] /** * The event types to include: * @@ -22415,90 +22394,90 @@ export interface operations { * * The default is `web`. */ - include?: components["parameters"]["audit-log-include"]; + include?: components['parameters']['audit-log-include'] /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor. */ - after?: components["parameters"]["audit-log-after"]; + after?: components['parameters']['audit-log-after'] /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor. */ - before?: components["parameters"]["audit-log-before"]; + before?: components['parameters']['audit-log-before'] /** * The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. * * The default is `desc`. */ - order?: components["parameters"]["audit-log-order"]; + order?: components['parameters']['audit-log-order'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["audit-log-event"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['audit-log-event'][] + } + } + } + } /** List the users blocked by an organization. */ - "orgs/list-blocked-users": { + 'orgs/list-blocked-users': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 415: components["responses"]["preview_header_missing"]; - }; - }; - "orgs/check-blocked-user": { + 'application/json': components['schemas']['simple-user'][] + } + } + 415: components['responses']['preview_header_missing'] + } + } + 'orgs/check-blocked-user': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** If the user is blocked: */ - 204: never; + 204: never /** If the user is not blocked: */ 404: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - }; - }; - "orgs/block-user": { + 'application/json': components['schemas']['basic-error'] + } + } + } + } + 'orgs/block-user': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 422: components["responses"]["validation_failed"]; - }; - }; - "orgs/unblock-user": { + 204: never + 422: components['responses']['validation_failed'] + } + } + 'orgs/unblock-user': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Lists all code scanning alerts for the default branch (usually `main` * or `master`) for all eligible repositories in an organization. @@ -22506,147 +22485,147 @@ export interface operations { * * GitHub Apps must have the `security_events` read permission to use this endpoint. */ - "code-scanning/list-alerts-for-org": { + 'code-scanning/list-alerts-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor. */ - before?: components["parameters"]["pagination-before"]; + before?: components['parameters']['pagination-before'] /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor. */ - after?: components["parameters"]["pagination-after"]; + after?: components['parameters']['pagination-after'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Set to `open`, `closed, `fixed`, or `dismissed` to list code scanning alerts in a specific state. */ - state?: components["schemas"]["code-scanning-alert-state"]; + state?: components['schemas']['code-scanning-alert-state'] /** Can be one of `created`, `updated`. */ - sort?: "created" | "updated"; - }; - }; + sort?: 'created' | 'updated' + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["code-scanning-organization-alert-items"][]; - }; - }; - 403: components["responses"]["code_scanning_forbidden_read"]; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': components['schemas']['code-scanning-organization-alert-items'][] + } + } + 403: components['responses']['code_scanning_forbidden_read'] + 404: components['responses']['not_found'] + 503: components['responses']['service_unavailable'] + } + } /** * Listing and deleting credential authorizations is available to organizations with GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products). * * An authenticated organization owner with the `read:org` scope can list all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials are either personal access tokens or SSH keys that organization members have authorized for the organization. For more information, see [About authentication with SAML single sign-on](https://docs.github.com/en/articles/about-authentication-with-saml-single-sign-on). */ - "orgs/list-saml-sso-authorizations": { + 'orgs/list-saml-sso-authorizations': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page token */ - page?: number; + page?: number /** Limits the list of credentials authorizations for an organization to a specific login */ - login?: string; - }; - }; + login?: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["credential-authorization"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['credential-authorization'][] + } + } + } + } /** * Listing and deleting credential authorizations is available to organizations with GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products). * * An authenticated organization owner with the `admin:org` scope can remove a credential authorization for an organization that uses SAML SSO. Once you remove someone's credential authorization, they will need to create a new personal access token or SSH key and authorize it for the organization they want to access. */ - "orgs/remove-saml-sso-authorization": { + 'orgs/remove-saml-sso-authorization': { parameters: { path: { - org: components["parameters"]["org"]; - credential_id: number; - }; - }; + org: components['parameters']['org'] + credential_id: number + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - "dependabot/list-org-secrets": { + 'dependabot/list-org-secrets': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - secrets: components["schemas"]["organization-dependabot-secret"][]; - } & { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': { + total_count: number + secrets: components['schemas']['organization-dependabot-secret'][] + } & { [key: string]: unknown } + } + } + } + } /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - "dependabot/get-org-public-key": { + 'dependabot/get-org-public-key': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["dependabot-public-key"]; - }; - }; - }; - }; + 'application/json': components['schemas']['dependabot-public-key'] + } + } + } + } /** Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - "dependabot/get-org-secret": { + 'dependabot/get-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["organization-dependabot-secret"]; - }; - }; - }; - }; + 'application/json': components['schemas']['organization-dependabot-secret'] + } + } + } + } /** * Creates or updates an organization secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -22724,31 +22703,31 @@ export interface operations { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - "dependabot/create-or-update-org-secret": { + 'dependabot/create-or-update-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response when creating a secret */ 201: { content: { - "application/json": components["schemas"]["empty-object"]; - }; - }; + 'application/json': components['schemas']['empty-object'] + } + } /** Response when updating a secret */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/reference/dependabot#get-an-organization-public-key) endpoint. */ - encrypted_value?: string; + encrypted_value?: string /** @description ID of the key you used to encrypt the secret. */ - key_id?: string; + key_id?: string /** * @description Configures the access that repositories have to the organization secret. Can be one of: * \- `all` - All repositories in an organization can access the secret. @@ -22756,631 +22735,632 @@ export interface operations { * \- `selected` - Only specific repositories can access the secret. * @enum {string} */ - visibility: "all" | "private" | "selected"; + visibility: 'all' | 'private' | 'selected' /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/reference/dependabot#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/dependabot#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/dependabot#remove-selected-repository-from-an-organization-secret) endpoints. */ - selected_repository_ids?: string[]; - } & { [key: string]: unknown }; - }; - }; - }; + selected_repository_ids?: string[] + } & { [key: string]: unknown } + } + } + } /** Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - "dependabot/delete-org-secret": { + 'dependabot/delete-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - "dependabot/list-selected-repos-for-org-secret": { + 'dependabot/list-selected-repos-for-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; + secret_name: components['parameters']['secret-name'] + } query: { /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - repositories: components["schemas"]["minimal-repository"][]; - } & { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': { + total_count: number + repositories: components['schemas']['minimal-repository'][] + } & { [key: string]: unknown } + } + } + } + } /** Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - "dependabot/set-selected-repos-for-org-secret": { + 'dependabot/set-selected-repos-for-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/dependabot#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/dependabot#remove-selected-repository-from-an-organization-secret) endpoints. */ - selected_repository_ids: number[]; - } & { [key: string]: unknown }; - }; - }; - }; + selected_repository_ids: number[] + } & { [key: string]: unknown } + } + } + } /** Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - "dependabot/add-selected-repo-to-org-secret": { + 'dependabot/add-selected-repo-to-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - repository_id: number; - }; - }; + secret_name: components['parameters']['secret-name'] + repository_id: number + } + } responses: { /** No Content when repository was added to the selected list */ - 204: never; + 204: never /** Conflict when visibility type is not set to selected */ - 409: unknown; - }; - }; + 409: unknown + } + } /** Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - "dependabot/remove-selected-repo-from-org-secret": { + 'dependabot/remove-selected-repo-from-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - repository_id: number; - }; - }; + secret_name: components['parameters']['secret-name'] + repository_id: number + } + } responses: { /** Response when repository was removed from the selected list */ - 204: never; + 204: never /** Conflict when visibility type not set to selected */ - 409: unknown; - }; - }; - "activity/list-public-org-events": { + 409: unknown + } + } + 'activity/list-public-org-events': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["event"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['event'][] + } + } + } + } /** * Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to. * * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ - "teams/external-idp-group-info-for-org": { + 'teams/external-idp-group-info-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** group_id parameter */ - group_id: components["parameters"]["group-id"]; - }; - }; + group_id: components['parameters']['group-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["external-group"]; - }; - }; - }; - }; + 'application/json': components['schemas']['external-group'] + } + } + } + } /** * Lists external groups available in an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." * * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ - "teams/list-external-idp-groups-for-org": { + 'teams/list-external-idp-groups-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page token */ - page?: number; + page?: number /** Limits the list to groups containing the text in the group name */ - display_name?: string; - }; - }; + display_name?: string + } + } responses: { /** Response */ 200: { headers: { - Link?: string; - }; - content: { - "application/json": components["schemas"]["external-groups"]; - }; - }; - }; - }; + Link?: string + } + content: { + 'application/json': components['schemas']['external-groups'] + } + } + } + } /** The return hash contains `failed_at` and `failed_reason` fields which represent the time at which the invitation failed and the reason for the failure. */ - "orgs/list-failed-invitations": { + 'orgs/list-failed-invitations': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["organization-invitation"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "orgs/list-webhooks": { + 'application/json': components['schemas']['organization-invitation'][] + } + } + 404: components['responses']['not_found'] + } + } + 'orgs/list-webhooks': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["org-hook"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['org-hook'][] + } + } + 404: components['responses']['not_found'] + } + } /** Here's how you can create a hook that posts payloads in JSON format: */ - "orgs/create-webhook": { + 'orgs/create-webhook': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["org-hook"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['org-hook'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Must be passed as "web". */ - name: string; + name: string /** @description Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/orgs#create-hook-config-params). */ config: { - url: components["schemas"]["webhook-config-url"]; - content_type?: components["schemas"]["webhook-config-content-type"]; - secret?: components["schemas"]["webhook-config-secret"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + url: components['schemas']['webhook-config-url'] + content_type?: components['schemas']['webhook-config-content-type'] + secret?: components['schemas']['webhook-config-secret'] + insecure_ssl?: components['schemas']['webhook-config-insecure-ssl'] /** @example "kdaigle" */ - username?: string; + username?: string /** @example "password" */ - password?: string; - } & { [key: string]: unknown }; + password?: string + } & { [key: string]: unknown } /** * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. * @default push */ - events?: string[]; + events?: string[] /** * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. * @default true */ - active?: boolean; - } & { [key: string]: unknown }; - }; - }; - }; + active?: boolean + } & { [key: string]: unknown } + } + } + } /** Returns a webhook configured in an organization. To get only the webhook `config` properties, see "[Get a webhook configuration for an organization](/rest/reference/orgs#get-a-webhook-configuration-for-an-organization)." */ - "orgs/get-webhook": { + 'orgs/get-webhook': { parameters: { path: { - org: components["parameters"]["org"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + org: components['parameters']['org'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["org-hook"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "orgs/delete-webhook": { + 'application/json': components['schemas']['org-hook'] + } + } + 404: components['responses']['not_found'] + } + } + 'orgs/delete-webhook': { parameters: { path: { - org: components["parameters"]["org"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + org: components['parameters']['org'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for an organization](/rest/reference/orgs#update-a-webhook-configuration-for-an-organization)." */ - "orgs/update-webhook": { + 'orgs/update-webhook': { parameters: { path: { - org: components["parameters"]["org"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + org: components['parameters']['org'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["org-hook"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['org-hook'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/orgs#update-hook-config-params). */ config?: { - url: components["schemas"]["webhook-config-url"]; - content_type?: components["schemas"]["webhook-config-content-type"]; - secret?: components["schemas"]["webhook-config-secret"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - } & { [key: string]: unknown }; + url: components['schemas']['webhook-config-url'] + content_type?: components['schemas']['webhook-config-content-type'] + secret?: components['schemas']['webhook-config-secret'] + insecure_ssl?: components['schemas']['webhook-config-insecure-ssl'] + } & { [key: string]: unknown } /** * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. * @default push */ - events?: string[]; + events?: string[] /** * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. * @default true */ - active?: boolean; + active?: boolean /** @example "web" */ - name?: string; - } & { [key: string]: unknown }; - }; - }; - }; + name?: string + } & { [key: string]: unknown } + } + } + } /** * Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/reference/orgs#get-an-organization-webhook)." * * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission. */ - "orgs/get-webhook-config-for-org": { + 'orgs/get-webhook-config-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + org: components['parameters']['org'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["webhook-config"]; - }; - }; - }; - }; + 'application/json': components['schemas']['webhook-config'] + } + } + } + } /** * Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/reference/orgs#update-an-organization-webhook)." * * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission. */ - "orgs/update-webhook-config-for-org": { + 'orgs/update-webhook-config-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + org: components['parameters']['org'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["webhook-config"]; - }; - }; - }; + 'application/json': components['schemas']['webhook-config'] + } + } + } requestBody: { content: { - "application/json": { - url?: components["schemas"]["webhook-config-url"]; - content_type?: components["schemas"]["webhook-config-content-type"]; - secret?: components["schemas"]["webhook-config-secret"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - }; - }; - }; - }; + 'application/json': { + url?: components['schemas']['webhook-config-url'] + content_type?: components['schemas']['webhook-config-content-type'] + secret?: components['schemas']['webhook-config-secret'] + insecure_ssl?: components['schemas']['webhook-config-insecure-ssl'] + } + } + } + } /** Returns a list of webhook deliveries for a webhook configured in an organization. */ - "orgs/list-webhook-deliveries": { + 'orgs/list-webhook-deliveries': { parameters: { path: { - org: components["parameters"]["org"]; - hook_id: components["parameters"]["hook-id"]; - }; + org: components['parameters']['org'] + hook_id: components['parameters']['hook-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ - cursor?: components["parameters"]["cursor"]; - }; - }; + cursor?: components['parameters']['cursor'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["hook-delivery-item"][]; - }; - }; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['hook-delivery-item'][] + } + } + 400: components['responses']['bad_request'] + 422: components['responses']['validation_failed'] + } + } /** Returns a delivery for a webhook configured in an organization. */ - "orgs/get-webhook-delivery": { + 'orgs/get-webhook-delivery': { parameters: { path: { - org: components["parameters"]["org"]; - hook_id: components["parameters"]["hook-id"]; - delivery_id: components["parameters"]["delivery-id"]; - }; - }; + org: components['parameters']['org'] + hook_id: components['parameters']['hook-id'] + delivery_id: components['parameters']['delivery-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["hook-delivery"]; - }; - }; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['hook-delivery'] + } + } + 400: components['responses']['bad_request'] + 422: components['responses']['validation_failed'] + } + } /** Redeliver a delivery for a webhook configured in an organization. */ - "orgs/redeliver-webhook-delivery": { + 'orgs/redeliver-webhook-delivery': { parameters: { path: { - org: components["parameters"]["org"]; - hook_id: components["parameters"]["hook-id"]; - delivery_id: components["parameters"]["delivery-id"]; - }; - }; + org: components['parameters']['org'] + hook_id: components['parameters']['hook-id'] + delivery_id: components['parameters']['delivery-id'] + } + } responses: { - 202: components["responses"]["accepted"]; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 202: components['responses']['accepted'] + 400: components['responses']['bad_request'] + 422: components['responses']['validation_failed'] + } + } /** This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. */ - "orgs/ping-webhook": { + 'orgs/ping-webhook': { parameters: { path: { - org: components["parameters"]["org"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + org: components['parameters']['org'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** * Enables an authenticated GitHub App to find the organization's installation information. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/get-org-installation": { + 'apps/get-org-installation': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["installation"]; - }; - }; - }; - }; + 'application/json': components['schemas']['installation'] + } + } + } + } /** Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint. */ - "orgs/list-app-installations": { + 'orgs/list-app-installations': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - installations: components["schemas"]["installation"][]; - } & { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': { + total_count: number + installations: components['schemas']['installation'][] + } & { [key: string]: unknown } + } + } + } + } /** Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response. */ - "interactions/get-restrictions-for-org": { + 'interactions/get-restrictions-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": (Partial & - Partial<{ [key: string]: unknown }>) & { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': (Partial & Partial<{ [key: string]: unknown }>) & { + [key: string]: unknown + } + } + } + } + } /** Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization. */ - "interactions/set-restrictions-for-org": { + 'interactions/set-restrictions-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["interaction-limit-response"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['interaction-limit-response'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": components["schemas"]["interaction-limit"]; - }; - }; - }; + 'application/json': components['schemas']['interaction-limit'] + } + } + } /** Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions. */ - "interactions/remove-restrictions-for-org": { + 'interactions/remove-restrictions-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. */ - "orgs/list-pending-invitations": { + 'orgs/list-pending-invitations': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["organization-invitation"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['organization-invitation'][] + } + } + 404: components['responses']['not_found'] + } + } /** * Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - "orgs/create-invitation": { + 'orgs/create-invitation': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["organization-invitation"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['organization-invitation'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description **Required unless you provide `email`**. GitHub user ID for the person you are inviting. */ - invitee_id?: number; + invitee_id?: number /** @description **Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user. */ - email?: string; + email?: string /** * @description Specify role for new member. Can be one of: * \* `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. @@ -23389,59 +23369,59 @@ export interface operations { * @default direct_member * @enum {string} */ - role?: "admin" | "direct_member" | "billing_manager"; + role?: 'admin' | 'direct_member' | 'billing_manager' /** @description Specify IDs for the teams you want to invite new members to. */ - team_ids?: number[]; - } & { [key: string]: unknown }; - }; - }; - }; + team_ids?: number[] + } & { [key: string]: unknown } + } + } + } /** * Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). */ - "orgs/cancel-invitation": { + 'orgs/cancel-invitation': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** invitation_id parameter */ - invitation_id: components["parameters"]["invitation-id"]; - }; - }; + invitation_id: components['parameters']['invitation-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner. */ - "orgs/list-invitation-teams": { + 'orgs/list-invitation-teams': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** invitation_id parameter */ - invitation_id: components["parameters"]["invitation-id"]; - }; + invitation_id: components['parameters']['invitation-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['team'][] + } + } + 404: components['responses']['not_found'] + } + } /** * List issues in an organization assigned to the authenticated user. * @@ -23450,11 +23430,11 @@ export interface operations { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - "issues/list-for-org": { + 'issues/list-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** * Indicates which sorts of issues to return. Can be one of: @@ -23464,123 +23444,123 @@ export interface operations { * \* `subscribed`: Issues you're subscribed to updates for * \* `all` or `repos`: All issues the authenticated user can see, regardless of participation or creation */ - filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all"; + filter?: 'assigned' | 'created' | 'mentioned' | 'subscribed' | 'repos' | 'all' /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ - state?: "open" | "closed" | "all"; + state?: 'open' | 'closed' | 'all' /** A list of comma separated label names. Example: `bug,ui,@high` */ - labels?: components["parameters"]["labels"]; + labels?: components['parameters']['labels'] /** What to sort results by. Can be either `created`, `updated`, `comments`. */ - sort?: "created" | "updated" | "comments"; + sort?: 'created' | 'updated' | 'comments' /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["issue"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['issue'][] + } + } + 404: components['responses']['not_found'] + } + } /** List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned. */ - "orgs/list-members": { + 'orgs/list-members': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** * Filter members returned in the list. Can be one of: * \* `2fa_disabled` - Members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. Available for organization owners. * \* `all` - All members the authenticated user can see. */ - filter?: "2fa_disabled" | "all"; + filter?: '2fa_disabled' | 'all' /** * Filter members returned by their role. Can be one of: * \* `all` - All members of the organization, regardless of role. * \* `admin` - Organization owners. * \* `member` - Non-owner organization members. */ - role?: "all" | "admin" | "member"; + role?: 'all' | 'admin' | 'member' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; + 'application/json': components['schemas']['simple-user'][] + } + } /** Response if requester is not an organization member */ - 302: never; - 422: components["responses"]["validation_failed"]; - }; - }; + 302: never + 422: components['responses']['validation_failed'] + } + } /** Check if a user is, publicly or privately, a member of the organization. */ - "orgs/check-membership-for-user": { + 'orgs/check-membership-for-user': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** Response if requester is an organization member and user is a member */ - 204: never; + 204: never /** Response if requester is not an organization member */ - 302: never; + 302: never /** Not Found if requester is an organization member and user is not a member */ - 404: unknown; - }; - }; + 404: unknown + } + } /** Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories. */ - "orgs/remove-member": { + 'orgs/remove-member': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 403: components["responses"]["forbidden"]; - }; - }; + 204: never + 403: components['responses']['forbidden'] + } + } /** In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status. */ - "orgs/get-membership-for-user": { + 'orgs/get-membership-for-user': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["org-membership"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['org-membership'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Only authenticated organization owners can add a member to the organization or update the member's role. * @@ -23592,26 +23572,26 @@ export interface operations { * * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. */ - "orgs/set-membership-for-user": { + 'orgs/set-membership-for-user': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["org-membership"]; - }; - }; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['org-membership'] + } + } + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The role to give the user in the organization. Can be one of: * \* `admin` - The user will become an owner of the organization. @@ -23619,102 +23599,102 @@ export interface operations { * @default member * @enum {string} */ - role?: "admin" | "member"; - } & { [key: string]: unknown }; - }; - }; - }; + role?: 'admin' | 'member' + } & { [key: string]: unknown } + } + } + } /** * In order to remove a user's membership with an organization, the authenticated user must be an organization owner. * * If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases. */ - "orgs/remove-membership-for-user": { + 'orgs/remove-membership-for-user': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Lists the most recent migrations. */ - "migrations/list-for-org": { + 'migrations/list-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Exclude attributes from the API response to improve performance */ - exclude?: "repositories"[]; - }; - }; + exclude?: 'repositories'[] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["migration"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['migration'][] + } + } + } + } /** Initiates the generation of a migration archive. */ - "migrations/start-for-org": { + 'migrations/start-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["migration"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['migration'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description A list of arrays indicating which repositories should be migrated. */ - repositories: string[]; + repositories: string[] /** * @description Indicates whether repositories should be locked (to prevent manipulation) while migrating data. * @example true */ - lock_repositories?: boolean; + lock_repositories?: boolean /** * @description Indicates whether attachments should be excluded from the migration (to reduce migration archive file size). * @example true */ - exclude_attachments?: boolean; + exclude_attachments?: boolean /** * @description Indicates whether releases should be excluded from the migration (to reduce migration archive file size). * @example true */ - exclude_releases?: boolean; + exclude_releases?: boolean /** * @description Indicates whether projects owned by the organization or users should be excluded. from the migration. * @example true */ - exclude_owner_projects?: boolean; - exclude?: "repositories"[]; - } & { [key: string]: unknown }; - }; - }; - }; + exclude_owner_projects?: boolean + exclude?: 'repositories'[] + } & { [key: string]: unknown } + } + } + } /** * Fetches the status of a migration. * @@ -23725,18 +23705,18 @@ export interface operations { * * `exported`, which means the migration finished successfully. * * `failed`, which means the migration failed. */ - "migrations/get-status-for-org": { + 'migrations/get-status-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** migration_id parameter */ - migration_id: components["parameters"]["migration-id"]; - }; + migration_id: components['parameters']['migration-id'] + } query: { /** Exclude attributes from the API response to improve performance */ - exclude?: "repositories"[]; - }; - }; + exclude?: 'repositories'[] + } + } responses: { /** * * `pending`, which means the migration hasn't started yet. @@ -23746,212 +23726,212 @@ export interface operations { */ 200: { content: { - "application/json": components["schemas"]["migration"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['migration'] + } + } + 404: components['responses']['not_found'] + } + } /** Fetches the URL to a migration archive. */ - "migrations/download-archive-for-org": { + 'migrations/download-archive-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** migration_id parameter */ - migration_id: components["parameters"]["migration-id"]; - }; - }; + migration_id: components['parameters']['migration-id'] + } + } responses: { /** Response */ - 302: never; - 404: components["responses"]["not_found"]; - }; - }; + 302: never + 404: components['responses']['not_found'] + } + } /** Deletes a previous migration archive. Migration archives are automatically deleted after seven days. */ - "migrations/delete-archive-for-org": { + 'migrations/delete-archive-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** migration_id parameter */ - migration_id: components["parameters"]["migration-id"]; - }; - }; + migration_id: components['parameters']['migration-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/rest/reference/repos#delete-a-repository) when the migration is complete and you no longer need the source data. */ - "migrations/unlock-repo-for-org": { + 'migrations/unlock-repo-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** migration_id parameter */ - migration_id: components["parameters"]["migration-id"]; + migration_id: components['parameters']['migration-id'] /** repo_name parameter */ - repo_name: components["parameters"]["repo-name"]; - }; - }; + repo_name: components['parameters']['repo-name'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** List all the repositories for this organization migration. */ - "migrations/list-repos-for-org": { + 'migrations/list-repos-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** migration_id parameter */ - migration_id: components["parameters"]["migration-id"]; - }; + migration_id: components['parameters']['migration-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["minimal-repository"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['minimal-repository'][] + } + } + 404: components['responses']['not_found'] + } + } /** List all users who are outside collaborators of an organization. */ - "orgs/list-outside-collaborators": { + 'orgs/list-outside-collaborators': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** * Filter the list of outside collaborators. Can be one of: * \* `2fa_disabled`: Outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. * \* `all`: All outside collaborators. */ - filter?: "2fa_disabled" | "all"; + filter?: '2fa_disabled' | 'all' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + } + } /** When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://docs.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)". */ - "orgs/convert-member-to-outside-collaborator": { + 'orgs/convert-member-to-outside-collaborator': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** User is getting converted asynchronously */ 202: { content: { - "application/json": { [key: string]: unknown }; - }; - }; + 'application/json': { [key: string]: unknown } + } + } /** User was converted */ - 204: never; + 204: never /** Forbidden if user is the last owner of the organization or not a member of the organization */ - 403: unknown; - 404: components["responses"]["not_found"]; - }; - }; + 403: unknown + 404: components['responses']['not_found'] + } + } /** Removing a user from this list will remove them from all the organization's repositories. */ - "orgs/remove-outside-collaborator": { + 'orgs/remove-outside-collaborator': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; + 204: never /** Unprocessable Entity if user is a member of the organization */ 422: { content: { - "application/json": { - message?: string; - documentation_url?: string; - } & { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': { + message?: string + documentation_url?: string + } & { [key: string]: unknown } + } + } + } + } /** * Lists all packages in an organization readable by the user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/list-packages-for-organization": { + 'packages/list-packages-for-organization': { parameters: { query: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + package_type: 'npm' | 'maven' | 'rubygems' | 'docker' | 'nuget' | 'container' /** The selected visibility of the packages. Can be one of `public`, `private`, or `internal`. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set. */ - visibility?: components["parameters"]["package-visibility"]; - }; + visibility?: components['parameters']['package-visibility'] + } path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['package'][] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** * Gets a specific package in an organization. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/get-package-for-organization": { + 'packages/get-package-for-organization': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - org: components["parameters"]["org"]; - }; - }; + package_name: components['parameters']['package-name'] + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package"]; - }; - }; - }; - }; + 'application/json': components['schemas']['package'] + } + } + } + } /** * Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * @@ -23959,24 +23939,24 @@ export interface operations { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. */ - "packages/delete-package-for-org": { + 'packages/delete-package-for-org': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - org: components["parameters"]["org"]; - }; - }; + package_name: components['parameters']['package-name'] + org: components['parameters']['org'] + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Restores an entire package in an organization. * @@ -23988,91 +23968,91 @@ export interface operations { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. */ - "packages/restore-package-for-org": { + 'packages/restore-package-for-org': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - org: components["parameters"]["org"]; - }; + package_name: components['parameters']['package-name'] + org: components['parameters']['org'] + } query: { /** package token */ - token?: string; - }; - }; + token?: string + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Returns all package versions for a package owned by an organization. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/get-all-package-versions-for-package-owned-by-org": { + 'packages/get-all-package-versions-for-package-owned-by-org': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - org: components["parameters"]["org"]; - }; + package_name: components['parameters']['package-name'] + org: components['parameters']['org'] + } query: { /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** The state of the package, either active or deleted. */ - state?: "active" | "deleted"; - }; - }; + state?: 'active' | 'deleted' + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package-version"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['package-version'][] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Gets a specific package version in an organization. * * You must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/get-package-version-for-organization": { + 'packages/get-package-version-for-organization': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - org: components["parameters"]["org"]; + package_name: components['parameters']['package-name'] + org: components['parameters']['org'] /** Unique identifier of the package version. */ - package_version_id: components["parameters"]["package-version-id"]; - }; - }; + package_version_id: components['parameters']['package-version-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package-version"]; - }; - }; - }; - }; + 'application/json': components['schemas']['package-version'] + } + } + } + } /** * Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * @@ -24080,26 +24060,26 @@ export interface operations { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. */ - "packages/delete-package-version-for-org": { + 'packages/delete-package-version-for-org': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - org: components["parameters"]["org"]; + package_name: components['parameters']['package-name'] + org: components['parameters']['org'] /** Unique identifier of the package version. */ - package_version_id: components["parameters"]["package-version-id"]; - }; - }; + package_version_id: components['parameters']['package-version-id'] + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Restores a specific package version in an organization. * @@ -24111,179 +24091,179 @@ export interface operations { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. */ - "packages/restore-package-version-for-org": { + 'packages/restore-package-version-for-org': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - org: components["parameters"]["org"]; + package_name: components['parameters']['package-name'] + org: components['parameters']['org'] /** Unique identifier of the package version. */ - package_version_id: components["parameters"]["package-version-id"]; - }; - }; + package_version_id: components['parameters']['package-version-id'] + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - "projects/list-for-org": { + 'projects/list-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. */ - state?: "open" | "closed" | "all"; + state?: 'open' | 'closed' | 'all' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["project"][]; - }; - }; - 422: components["responses"]["validation_failed_simple"]; - }; - }; + 'application/json': components['schemas']['project'][] + } + } + 422: components['responses']['validation_failed_simple'] + } + } /** Creates an organization project board. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - "projects/create-for-org": { + 'projects/create-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["project"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': components['schemas']['project'] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the project. */ - name: string; + name: string /** @description The description of the project. */ - body?: string; - } & { [key: string]: unknown }; - }; - }; - }; + body?: string + } & { [key: string]: unknown } + } + } + } /** Members of an organization can choose to have their membership publicized or not. */ - "orgs/list-public-members": { + 'orgs/list-public-members': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - }; - }; - "orgs/check-public-membership-for-user": { + 'application/json': components['schemas']['simple-user'][] + } + } + } + } + 'orgs/check-public-membership-for-user': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** Response if user is a public member */ - 204: never; + 204: never /** Not Found if user is not a public member */ - 404: unknown; - }; - }; + 404: unknown + } + } /** * The user can publicize their own membership. (A user cannot publicize the membership for another user.) * * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - "orgs/set-public-membership-for-authenticated-user": { + 'orgs/set-public-membership-for-authenticated-user': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 403: components["responses"]["forbidden"]; - }; - }; - "orgs/remove-public-membership-for-authenticated-user": { + 204: never + 403: components['responses']['forbidden'] + } + } + 'orgs/remove-public-membership-for-authenticated-user': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** Lists repositories for the specified organization. */ - "repos/list-for-org": { + 'repos/list-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Note: For GitHub AE, can be one of `all`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`. However, the `internal` value is not yet supported when a GitHub App calls this API with an installation access token. */ - type?: "all" | "public" | "private" | "forks" | "sources" | "member" | "internal"; + type?: 'all' | 'public' | 'private' | 'forks' | 'sources' | 'member' | 'internal' /** Can be one of `created`, `updated`, `pushed`, `full_name`. */ - sort?: "created" | "updated" | "pushed" | "full_name"; + sort?: 'created' | 'updated' | 'pushed' | 'full_name' /** Can be one of `asc` or `desc`. Default: when using `full_name`: `asc`, otherwise `desc` */ - direction?: "asc" | "desc"; + direction?: 'asc' | 'desc' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["minimal-repository"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['minimal-repository'][] + } + } + } + } /** * Creates a new repository in the specified organization. The authenticated user must be a member of the organization. * @@ -24294,129 +24274,129 @@ export interface operations { * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. * * `repo` scope to create a private repository */ - "repos/create-in-org": { + 'repos/create-in-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["repository"]; - }; - }; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['repository'] + } + } + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the repository. */ - name: string; + name: string /** @description A short description of the repository. */ - description?: string; + description?: string /** @description A URL with more information about the repository. */ - homepage?: string; + homepage?: string /** @description Whether the repository is private. */ - private?: boolean; + private?: boolean /** * @description Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see "[Creating an internal repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)" in the GitHub Help documentation. * @enum {string} */ - visibility?: "public" | "private" | "internal"; + visibility?: 'public' | 'private' | 'internal' /** * @description Either `true` to enable issues for this repository or `false` to disable them. * @default true */ - has_issues?: boolean; + has_issues?: boolean /** * @description Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error. * @default true */ - has_projects?: boolean; + has_projects?: boolean /** * @description Either `true` to enable the wiki for this repository or `false` to disable it. * @default true */ - has_wiki?: boolean; + has_wiki?: boolean /** @description Either `true` to make this repo available as a template repository or `false` to prevent it. */ - is_template?: boolean; + is_template?: boolean /** @description The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. */ - team_id?: number; + team_id?: number /** @description Pass `true` to create an initial commit with empty README. */ - auto_init?: boolean; + auto_init?: boolean /** @description Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, "Haskell". */ - gitignore_template?: string; + gitignore_template?: string /** @description Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, "mit" or "mpl-2.0". */ - license_template?: string; + license_template?: string /** * @description Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge?: boolean /** * @description Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit?: boolean /** * @description Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge?: boolean /** @description Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. */ - allow_auto_merge?: boolean; + allow_auto_merge?: boolean /** @description Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. */ - delete_branch_on_merge?: boolean; - } & { [key: string]: unknown }; - }; - }; - }; + delete_branch_on_merge?: boolean + } & { [key: string]: unknown } + } + } + } /** * Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest. * To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. */ - "secret-scanning/list-alerts-for-org": { + 'secret-scanning/list-alerts-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - state?: components["parameters"]["secret-scanning-alert-state"]; + state?: components['parameters']['secret-scanning-alert-state'] /** * A comma-separated list of secret types to return. By default all secret types are returned. * See "[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)" * for a complete list of secret types (API slug). */ - secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; + secret_type?: components['parameters']['secret-scanning-alert-secret-type'] /** A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - resolution?: components["parameters"]["secret-scanning-alert-resolution"]; + resolution?: components['parameters']['secret-scanning-alert-resolution'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["organization-secret-scanning-alert"][]; - }; - }; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': components['schemas']['organization-secret-scanning-alert'][] + } + } + 404: components['responses']['not_found'] + 503: components['responses']['service_unavailable'] + } + } /** * Gets the summary of the free and paid GitHub Actions minutes used. * @@ -24424,48 +24404,48 @@ export interface operations { * * Access tokens must have the `repo` or `admin:org` scope. */ - "billing/get-github-actions-billing-org": { + 'billing/get-github-actions-billing-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-billing-usage"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-billing-usage'] + } + } + } + } /** * Gets the GitHub Advanced Security active committers for an organization per repository. * Each distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of advanced_security_committers for each repository. * If this organization defers to an enterprise for billing, the total_advanced_security_committers returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level. */ - "billing/get-github-advanced-security-billing-org": { + 'billing/get-github-advanced-security-billing-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Success */ 200: { content: { - "application/json": components["schemas"]["advanced-security-active-committers"]; - }; - }; - 403: components["responses"]["code_scanning_forbidden_read"]; - }; - }; + 'application/json': components['schemas']['advanced-security-active-committers'] + } + } + 403: components['responses']['code_scanning_forbidden_read'] + } + } /** * Gets the free and paid storage used for GitHub Packages in gigabytes. * @@ -24473,21 +24453,21 @@ export interface operations { * * Access tokens must have the `repo` or `admin:org` scope. */ - "billing/get-github-packages-billing-org": { + 'billing/get-github-packages-billing-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["packages-billing-usage"]; - }; - }; - }; - }; + 'application/json': components['schemas']['packages-billing-usage'] + } + } + } + } /** * Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. * @@ -24495,106 +24475,106 @@ export interface operations { * * Access tokens must have the `repo` or `admin:org` scope. */ - "billing/get-shared-storage-billing-org": { + 'billing/get-shared-storage-billing-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["combined-billing-usage"]; - }; - }; - }; - }; + 'application/json': components['schemas']['combined-billing-usage'] + } + } + } + } /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * List IdP groups available in an organization. You can limit your page results using the `per_page` parameter. GitHub generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." */ - "teams/list-idp-groups-for-org": { + 'teams/list-idp-groups-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page token */ - page?: string; - }; - }; + page?: string + } + } responses: { /** Response */ 200: { headers: { - Link?: string; - }; - content: { - "application/json": components["schemas"]["group-mapping"]; - }; - }; - }; - }; + Link?: string + } + content: { + 'application/json': components['schemas']['group-mapping'] + } + } + } + } /** Lists all teams in an organization that are visible to the authenticated user. */ - "teams/list": { + 'teams/list': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team"][]; - }; - }; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['team'][] + } + } + 403: components['responses']['forbidden'] + } + } /** * To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://docs.github.com/en/articles/setting-team-creation-permissions-in-your-organization)." * * When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)". */ - "teams/create": { + 'teams/create': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["team-full"]; - }; - }; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['team-full'] + } + } + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the team. */ - name: string; + name: string /** @description The description of the team. */ - description?: string; + description?: string /** @description List GitHub IDs for organization members who will become team maintainers. */ - maintainers?: string[]; + maintainers?: string[] /** @description The full name (e.g., "organization-name/repository-name") of repositories to add the team to. */ - repo_names?: string[]; + repo_names?: string[] /** * @description The level of privacy this team should have. The options are: * **For a non-nested team:** @@ -24606,7 +24586,7 @@ export interface operations { * Default for child team: `closed` * @enum {string} */ - privacy?: "secret" | "closed"; + privacy?: 'secret' | 'closed' /** * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: * \* `pull` - team members can pull, but not push to or administer newly-added repositories. @@ -24614,36 +24594,36 @@ export interface operations { * @default pull * @enum {string} */ - permission?: "pull" | "push"; + permission?: 'pull' | 'push' /** @description The ID of a team to set as the parent team. */ - parent_team_id?: number; - } & { [key: string]: unknown }; - }; - }; - }; + parent_team_id?: number + } & { [key: string]: unknown } + } + } + } /** * Gets a team using the team's `slug`. GitHub generates the `slug` from the team `name`. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. */ - "teams/get-by-name": { + 'teams/get-by-name': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; - }; + team_slug: components['parameters']['team-slug'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-full"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['team-full'] + } + } + 404: components['responses']['not_found'] + } + } /** * To delete a team, the authenticated user must be an organization owner or team maintainer. * @@ -24651,47 +24631,47 @@ export interface operations { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. */ - "teams/delete-in-org": { + 'teams/delete-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; - }; + team_slug: components['parameters']['team-slug'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * To edit a team, the authenticated user must either be an organization owner or a team maintainer. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. */ - "teams/update-in-org": { + 'teams/update-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; - }; + team_slug: components['parameters']['team-slug'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["team-full"]; - }; - }; - }; + 'application/json': components['schemas']['team-full'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the team. */ - name?: string; + name?: string /** @description The description of the team. */ - description?: string; + description?: string /** * @description The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: * **For a non-nested team:** @@ -24701,7 +24681,7 @@ export interface operations { * \* `closed` - visible to all members of this organization. * @enum {string} */ - privacy?: "secret" | "closed"; + privacy?: 'secret' | 'closed' /** * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: * \* `pull` - team members can pull, but not push to or administer newly-added repositories. @@ -24710,46 +24690,46 @@ export interface operations { * @default pull * @enum {string} */ - permission?: "pull" | "push" | "admin"; + permission?: 'pull' | 'push' | 'admin' /** @description The ID of a team to set as the parent team. */ - parent_team_id?: number | null; - } & { [key: string]: unknown }; - }; - }; - }; + parent_team_id?: number | null + } & { [key: string]: unknown } + } + } + } /** * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. */ - "teams/list-discussions-in-org": { + 'teams/list-discussions-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; + team_slug: components['parameters']['team-slug'] + } query: { /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Pinned discussions only filter */ - pinned?: string; - }; - }; + pinned?: string + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team-discussion"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['team-discussion'][] + } + } + } + } /** * Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @@ -24757,142 +24737,142 @@ export interface operations { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. */ - "teams/create-discussion-in-org": { + 'teams/create-discussion-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; - }; + team_slug: components['parameters']['team-slug'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; + 'application/json': components['schemas']['team-discussion'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The discussion post's title. */ - title: string; + title: string /** @description The discussion post's body text. */ - body: string; + body: string /** @description Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. */ - private?: boolean; - } & { [key: string]: unknown }; - }; - }; - }; + private?: boolean + } & { [key: string]: unknown } + } + } + } /** * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. */ - "teams/get-discussion-in-org": { + 'teams/get-discussion-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - }; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; - }; + 'application/json': components['schemas']['team-discussion'] + } + } + } + } /** * Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. */ - "teams/delete-discussion-in-org": { + 'teams/delete-discussion-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - }; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. */ - "teams/update-discussion-in-org": { + 'teams/update-discussion-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - }; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; + 'application/json': components['schemas']['team-discussion'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The discussion post's title. */ - title?: string; + title?: string /** @description The discussion post's body text. */ - body?: string; - } & { [key: string]: unknown }; - }; - }; - }; + body?: string + } & { [key: string]: unknown } + } + } + } /** * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. */ - "teams/list-discussion-comments-in-org": { + 'teams/list-discussion-comments-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + } query: { /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team-discussion-comment"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['team-discussion-comment'][] + } + } + } + } /** * Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @@ -24900,387 +24880,387 @@ export interface operations { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. */ - "teams/create-discussion-comment-in-org": { + 'teams/create-discussion-comment-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - }; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; + 'application/json': components['schemas']['team-discussion-comment'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The discussion comment's body text. */ - body: string; - } & { [key: string]: unknown }; - }; - }; - }; + body: string + } & { [key: string]: unknown } + } + } + } /** * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. */ - "teams/get-discussion-comment-in-org": { + 'teams/get-discussion-comment-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - comment_number: components["parameters"]["comment-number"]; - }; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + comment_number: components['parameters']['comment-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; - }; + 'application/json': components['schemas']['team-discussion-comment'] + } + } + } + } /** * Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. */ - "teams/delete-discussion-comment-in-org": { + 'teams/delete-discussion-comment-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - comment_number: components["parameters"]["comment-number"]; - }; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + comment_number: components['parameters']['comment-number'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. */ - "teams/update-discussion-comment-in-org": { + 'teams/update-discussion-comment-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - comment_number: components["parameters"]["comment-number"]; - }; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + comment_number: components['parameters']['comment-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; + 'application/json': components['schemas']['team-discussion-comment'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The discussion comment's body text. */ - body: string; - } & { [key: string]: unknown }; - }; - }; - }; + body: string + } & { [key: string]: unknown } + } + } + } /** * List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments/). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. */ - "reactions/list-for-team-discussion-comment-in-org": { + 'reactions/list-for-team-discussion-comment-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - comment_number: components["parameters"]["comment-number"]; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + comment_number: components['parameters']['comment-number'] + } query: { /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion comment. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content?: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["reaction"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['reaction'][] + } + } + } + } /** * Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. */ - "reactions/create-for-team-discussion-comment-in-org": { + 'reactions/create-for-team-discussion-comment-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - comment_number: components["parameters"]["comment-number"]; - }; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + comment_number: components['parameters']['comment-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; + 'application/json': components['schemas']['reaction'] + } + } /** Response */ 201: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - }; + 'application/json': components['schemas']['reaction'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion comment. * @enum {string} */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - } & { [key: string]: unknown }; - }; - }; - }; + content: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' + } & { [key: string]: unknown } + } + } + } /** * **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. * * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "reactions/delete-for-team-discussion-comment": { + 'reactions/delete-for-team-discussion-comment': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - comment_number: components["parameters"]["comment-number"]; - reaction_id: components["parameters"]["reaction-id"]; - }; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + comment_number: components['parameters']['comment-number'] + reaction_id: components['parameters']['reaction-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. */ - "reactions/list-for-team-discussion-in-org": { + 'reactions/list-for-team-discussion-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + } query: { /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content?: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["reaction"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['reaction'][] + } + } + } + } /** * Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. */ - "reactions/create-for-team-discussion-in-org": { + 'reactions/create-for-team-discussion-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - }; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; + 'application/json': components['schemas']['reaction'] + } + } /** Response */ 201: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - }; + 'application/json': components['schemas']['reaction'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion. * @enum {string} */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - } & { [key: string]: unknown }; - }; - }; - }; + content: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' + } & { [key: string]: unknown } + } + } + } /** * **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. * * Delete a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "reactions/delete-for-team-discussion": { + 'reactions/delete-for-team-discussion': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - reaction_id: components["parameters"]["reaction-id"]; - }; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + reaction_id: components['parameters']['reaction-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Deletes a connection between a team and an external group. * * You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "teams/unlink-external-idp-group-from-team-for-org": { + 'teams/unlink-external-idp-group-from-team-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; - }; + team_slug: components['parameters']['team-slug'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Creates a connection between a team and an external group. Only one external group can be linked to a team. * * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ - "teams/link-external-idp-group-to-team-for-org": { + 'teams/link-external-idp-group-to-team-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; - }; + team_slug: components['parameters']['team-slug'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["external-group"]; - }; - }; - }; + 'application/json': components['schemas']['external-group'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description External Group Id * @example 1 */ - group_id: number; - } & { [key: string]: unknown }; - }; - }; - }; + group_id: number + } & { [key: string]: unknown } + } + } + } /** * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. */ - "teams/list-pending-invitations-in-org": { + 'teams/list-pending-invitations-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; + team_slug: components['parameters']['team-slug'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["organization-invitation"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['organization-invitation'][] + } + } + } + } /** * Team members will include the members of child teams. * * To list members in a team, the team must be visible to the authenticated user. */ - "teams/list-members-in-org": { + 'teams/list-members-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; + team_slug: components['parameters']['team-slug'] + } query: { /** * Filters members returned by their role in the team. Can be one of: @@ -25288,23 +25268,23 @@ export interface operations { * \* `maintainer` - team maintainers. * \* `all` - all members of the team. */ - role?: "member" | "maintainer" | "all"; + role?: 'member' | 'maintainer' | 'all' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + } + } /** * Team members will include the members of child teams. * @@ -25317,26 +25297,26 @@ export interface operations { * * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team). */ - "teams/get-membership-for-user-in-org": { + 'teams/get-membership-for-user-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - username: components["parameters"]["username"]; - }; - }; + team_slug: components['parameters']['team-slug'] + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-membership"]; - }; - }; + 'application/json': components['schemas']['team-membership'] + } + } /** if user has no team membership */ - 404: unknown; - }; - }; + 404: unknown + } + } /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -25350,30 +25330,30 @@ export interface operations { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ - "teams/add-or-update-membership-for-user-in-org": { + 'teams/add-or-update-membership-for-user-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - username: components["parameters"]["username"]; - }; - }; + team_slug: components['parameters']['team-slug'] + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-membership"]; - }; - }; + 'application/json': components['schemas']['team-membership'] + } + } /** Forbidden if team synchronization is set up */ - 403: unknown; + 403: unknown /** Unprocessable Entity if you attempt to add an organization to a team */ - 422: unknown; - }; + 422: unknown + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The role that this user should have in the team. Can be one of: * \* `member` - a normal member of the team. @@ -25381,11 +25361,11 @@ export interface operations { * @default member * @enum {string} */ - role?: "member" | "maintainer"; - } & { [key: string]: unknown }; - }; - }; - }; + role?: 'member' | 'maintainer' + } & { [key: string]: unknown } + } + } + } /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -25395,106 +25375,106 @@ export interface operations { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ - "teams/remove-membership-for-user-in-org": { + 'teams/remove-membership-for-user-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - username: components["parameters"]["username"]; - }; - }; + team_slug: components['parameters']['team-slug'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; + 204: never /** Forbidden if team synchronization is set up */ - 403: unknown; - }; - }; + 403: unknown + } + } /** * Lists the organization projects for a team. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. */ - "teams/list-projects-in-org": { + 'teams/list-projects-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; + team_slug: components['parameters']['team-slug'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team-project"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['team-project'][] + } + } + } + } /** * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ - "teams/check-permissions-for-project-in-org": { + 'teams/check-permissions-for-project-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - project_id: components["parameters"]["project-id"]; - }; - }; + team_slug: components['parameters']['team-slug'] + project_id: components['parameters']['project-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-project"]; - }; - }; + 'application/json': components['schemas']['team-project'] + } + } /** Not Found if project is not managed by this team */ - 404: unknown; - }; - }; + 404: unknown + } + } /** * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ - "teams/add-or-update-project-permissions-in-org": { + 'teams/add-or-update-project-permissions-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - project_id: components["parameters"]["project-id"]; - }; - }; + team_slug: components['parameters']['team-slug'] + project_id: components['parameters']['project-id'] + } + } responses: { /** Response */ - 204: never; + 204: never /** Forbidden if the project is not owned by the organization */ 403: { content: { - "application/json": { - message?: string; - documentation_url?: string; - } & { [key: string]: unknown }; - }; - }; - }; + 'application/json': { + message?: string + documentation_url?: string + } & { [key: string]: unknown } + } + } + } requestBody: { content: { - "application/json": + 'application/json': | ({ /** * @description The permission to grant to the team for this project. Can be one of: @@ -25504,60 +25484,60 @@ export interface operations { * Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." * @enum {string} */ - permission?: "read" | "write" | "admin"; + permission?: 'read' | 'write' | 'admin' } & { [key: string]: unknown }) - | null; - }; - }; - }; + | null + } + } + } /** * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ - "teams/remove-project-in-org": { + 'teams/remove-project-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - project_id: components["parameters"]["project-id"]; - }; - }; + team_slug: components['parameters']['team-slug'] + project_id: components['parameters']['project-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Lists a team's repositories visible to the authenticated user. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. */ - "teams/list-repos-in-org": { + 'teams/list-repos-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; + team_slug: components['parameters']['team-slug'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["minimal-repository"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['minimal-repository'][] + } + } + } + } /** * Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. * @@ -25567,29 +25547,29 @@ export interface operations { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ - "teams/check-permissions-for-repo-in-org": { + 'teams/check-permissions-for-repo-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + team_slug: components['parameters']['team-slug'] + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Alternative response with repository permissions */ 200: { content: { - "application/json": components["schemas"]["team-repository"]; - }; - }; + 'application/json': components['schemas']['team-repository'] + } + } /** Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header. */ - 204: never; + 204: never /** Not Found if team does not have permission for the repository */ - 404: unknown; - }; - }; + 404: unknown + } + } /** * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." * @@ -25597,23 +25577,23 @@ export interface operations { * * For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". */ - "teams/add-or-update-repo-permissions-in-org": { + 'teams/add-or-update-repo-permissions-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + team_slug: components['parameters']['team-slug'] + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The permission to grant the team on this repository. Can be one of: * \* `pull` - team members can pull, but not push to or administer this repository. @@ -25627,31 +25607,31 @@ export interface operations { * @default push * @enum {string} */ - permission?: "pull" | "push" | "admin" | "maintain" | "triage"; - } & { [key: string]: unknown }; - }; - }; - }; + permission?: 'pull' | 'push' | 'admin' | 'maintain' | 'triage' + } & { [key: string]: unknown } + } + } + } /** * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ - "teams/remove-repo-in-org": { + 'teams/remove-repo-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + team_slug: components['parameters']['team-slug'] + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -25659,23 +25639,23 @@ export interface operations { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`. */ - "teams/list-idp-groups-in-org": { + 'teams/list-idp-groups-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; - }; + team_slug: components['parameters']['team-slug'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["group-mapping"]; - }; - }; - }; - }; + 'application/json': components['schemas']['group-mapping'] + } + } + } + } /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -25683,512 +25663,511 @@ export interface operations { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`. */ - "teams/create-or-update-idp-group-connections-in-org": { + 'teams/create-or-update-idp-group-connections-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; - }; + team_slug: components['parameters']['team-slug'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["group-mapping"]; - }; - }; - }; + 'application/json': components['schemas']['group-mapping'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The IdP groups you want to connect to a GitHub team. When updating, the new `groups` object will replace the original one. You must include any existing groups that you don't want to remove. */ groups?: ({ /** @description ID of the IdP group. */ - group_id: string; + group_id: string /** @description Name of the IdP group. */ - group_name: string; + group_name: string /** @description Description of the IdP group. */ - group_description: string; - } & { [key: string]: unknown })[]; - }; - }; - }; - }; + group_description: string + } & { [key: string]: unknown })[] + } + } + } + } /** * Lists the child teams of the team specified by `{team_slug}`. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. */ - "teams/list-child-in-org": { + 'teams/list-child-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; + team_slug: components['parameters']['team-slug'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** if child teams exist */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team"][]; - }; - }; - }; - }; - "projects/get-card": { + 'application/json': components['schemas']['team'][] + } + } + } + } + 'projects/get-card': { parameters: { path: { /** card_id parameter */ - card_id: components["parameters"]["card-id"]; - }; - }; + card_id: components['parameters']['card-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["project-card"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "projects/delete-card": { + 'application/json': components['schemas']['project-card'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'projects/delete-card': { parameters: { path: { /** card_id parameter */ - card_id: components["parameters"]["card-id"]; - }; - }; + card_id: components['parameters']['card-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] /** Forbidden */ 403: { content: { - "application/json": { - message?: string; - documentation_url?: string; - errors?: string[]; - } & { [key: string]: unknown }; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "projects/update-card": { + 'application/json': { + message?: string + documentation_url?: string + errors?: string[] + } & { [key: string]: unknown } + } + } + 404: components['responses']['not_found'] + } + } + 'projects/update-card': { parameters: { path: { /** card_id parameter */ - card_id: components["parameters"]["card-id"]; - }; - }; + card_id: components['parameters']['card-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["project-card"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': components['schemas']['project-card'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The project card's note * @example Update all gems */ - note?: string | null; + note?: string | null /** @description Whether or not the card is archived */ - archived?: boolean; - } & { [key: string]: unknown }; - }; - }; - }; - "projects/move-card": { + archived?: boolean + } & { [key: string]: unknown } + } + } + } + 'projects/move-card': { parameters: { path: { /** card_id parameter */ - card_id: components["parameters"]["card-id"]; - }; - }; + card_id: components['parameters']['card-id'] + } + } responses: { /** Response */ 201: { content: { - "application/json": { [key: string]: unknown }; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; + 'application/json': { [key: string]: unknown } + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] /** Forbidden */ 403: { content: { - "application/json": { - message?: string; - documentation_url?: string; + 'application/json': { + message?: string + documentation_url?: string errors?: ({ - code?: string; - message?: string; - resource?: string; - field?: string; - } & { [key: string]: unknown })[]; - } & { [key: string]: unknown }; - }; - }; - 422: components["responses"]["validation_failed"]; + code?: string + message?: string + resource?: string + field?: string + } & { [key: string]: unknown })[] + } & { [key: string]: unknown } + } + } + 422: components['responses']['validation_failed'] /** Response */ 503: { content: { - "application/json": { - code?: string; - message?: string; - documentation_url?: string; + 'application/json': { + code?: string + message?: string + documentation_url?: string errors?: ({ - code?: string; - message?: string; - } & { [key: string]: unknown })[]; - } & { [key: string]: unknown }; - }; - }; - }; + code?: string + message?: string + } & { [key: string]: unknown })[] + } & { [key: string]: unknown } + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card. * @example bottom */ - position: string; + position: string /** * @description The unique identifier of the column the card should be moved to * @example 42 */ - column_id?: number; - } & { [key: string]: unknown }; - }; - }; - }; - "projects/get-column": { + column_id?: number + } & { [key: string]: unknown } + } + } + } + 'projects/get-column': { parameters: { path: { /** column_id parameter */ - column_id: components["parameters"]["column-id"]; - }; - }; + column_id: components['parameters']['column-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["project-column"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "projects/delete-column": { + 'application/json': components['schemas']['project-column'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'projects/delete-column': { parameters: { path: { /** column_id parameter */ - column_id: components["parameters"]["column-id"]; - }; - }; + column_id: components['parameters']['column-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; - "projects/update-column": { + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } + 'projects/update-column': { parameters: { path: { /** column_id parameter */ - column_id: components["parameters"]["column-id"]; - }; - }; + column_id: components['parameters']['column-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["project-column"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; + 'application/json': components['schemas']['project-column'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description Name of the project column * @example Remaining tasks */ - name: string; - } & { [key: string]: unknown }; - }; - }; - }; - "projects/list-cards": { + name: string + } & { [key: string]: unknown } + } + } + } + 'projects/list-cards': { parameters: { path: { /** column_id parameter */ - column_id: components["parameters"]["column-id"]; - }; + column_id: components['parameters']['column-id'] + } query: { /** Filters the project cards that are returned by the card's state. Can be one of `all`,`archived`, or `not_archived`. */ - archived_state?: "all" | "archived" | "not_archived"; + archived_state?: 'all' | 'archived' | 'not_archived' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["project-card"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; - "projects/create-card": { + 'application/json': components['schemas']['project-card'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } + 'projects/create-card': { parameters: { path: { /** column_id parameter */ - column_id: components["parameters"]["column-id"]; - }; - }; + column_id: components['parameters']['column-id'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["project-card"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; + 'application/json': components['schemas']['project-card'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] /** Validation failed */ 422: { content: { - "application/json": ( - | components["schemas"]["validation-error"] - | components["schemas"]["validation-error-simple"] - ) & { [key: string]: unknown }; - }; - }; + 'application/json': (components['schemas']['validation-error'] | components['schemas']['validation-error-simple']) & { + [key: string]: unknown + } + } + } /** Response */ 503: { content: { - "application/json": { - code?: string; - message?: string; - documentation_url?: string; + 'application/json': { + code?: string + message?: string + documentation_url?: string errors?: ({ - code?: string; - message?: string; - } & { [key: string]: unknown })[]; - } & { [key: string]: unknown }; - }; - }; - }; + code?: string + message?: string + } & { [key: string]: unknown })[] + } & { [key: string]: unknown } + } + } + } requestBody: { content: { - "application/json": ( + 'application/json': ( | ({ /** * @description The project card's note * @example Update all gems */ - note: string | null; + note: string | null } & { [key: string]: unknown }) | ({ /** * @description The unique identifier of the content associated with the card * @example 42 */ - content_id: number; + content_id: number /** * @description The piece of content associated with the card * @example PullRequest */ - content_type: string; + content_type: string } & { [key: string]: unknown }) - ) & { [key: string]: unknown }; - }; - }; - }; - "projects/move-column": { + ) & { [key: string]: unknown } + } + } + } + 'projects/move-column': { parameters: { path: { /** column_id parameter */ - column_id: components["parameters"]["column-id"]; - }; - }; + column_id: components['parameters']['column-id'] + } + } responses: { /** Response */ 201: { content: { - "application/json": { [key: string]: unknown }; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': { [key: string]: unknown } + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column. * @example last */ - position: string; - } & { [key: string]: unknown }; - }; - }; - }; + position: string + } & { [key: string]: unknown } + } + } + } /** Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - "projects/get": { + 'projects/get': { parameters: { path: { - project_id: components["parameters"]["project-id"]; - }; - }; + project_id: components['parameters']['project-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["project"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['project'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** Deletes a project board. Returns a `404 Not Found` status if projects are disabled. */ - "projects/delete": { + 'projects/delete': { parameters: { path: { - project_id: components["parameters"]["project-id"]; - }; - }; + project_id: components['parameters']['project-id'] + } + } responses: { /** Delete Success */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] /** Forbidden */ 403: { content: { - "application/json": { - message?: string; - documentation_url?: string; - errors?: string[]; - } & { [key: string]: unknown }; - }; - }; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - }; - }; + 'application/json': { + message?: string + documentation_url?: string + errors?: string[] + } & { [key: string]: unknown } + } + } + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + } + } /** Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - "projects/update": { + 'projects/update': { parameters: { path: { - project_id: components["parameters"]["project-id"]; - }; - }; + project_id: components['parameters']['project-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["project"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; + 'application/json': components['schemas']['project'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] /** Forbidden */ 403: { content: { - "application/json": { - message?: string; - documentation_url?: string; - errors?: string[]; - } & { [key: string]: unknown }; - }; - }; + 'application/json': { + message?: string + documentation_url?: string + errors?: string[] + } & { [key: string]: unknown } + } + } /** Not Found if the authenticated user does not have access to the project */ - 404: unknown; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 404: unknown + 410: components['responses']['gone'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description Name of the project * @example Week One Sprint */ - name?: string; + name?: string /** * @description Body of the project * @example This project represents the sprint of the first week in January */ - body?: string | null; + body?: string | null /** * @description State of the project; either 'open' or 'closed' * @example open */ - state?: string; + state?: string /** * @description The baseline permission that all organization members have on this project * @enum {string} */ - organization_permission?: "read" | "write" | "admin" | "none"; + organization_permission?: 'read' | 'write' | 'admin' | 'none' /** @description Whether or not this project can be seen by everyone. */ - private?: boolean; - } & { [key: string]: unknown }; - }; - }; - }; + private?: boolean + } & { [key: string]: unknown } + } + } + } /** Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators. */ - "projects/list-collaborators": { + 'projects/list-collaborators': { parameters: { path: { - project_id: components["parameters"]["project-id"]; - }; + project_id: components['parameters']['project-id'] + } query: { /** * Filters the collaborators by their affiliation. Can be one of: @@ -26196,48 +26175,48 @@ export interface operations { * \* `direct`: Collaborators with permissions to a project, regardless of organization membership status. * \* `all`: All collaborators the authenticated user can see. */ - affiliation?: "outside" | "direct" | "all"; + affiliation?: 'outside' | 'direct' | 'all' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator. */ - "projects/add-collaborator": { + 'projects/add-collaborator': { parameters: { path: { - project_id: components["parameters"]["project-id"]; - username: components["parameters"]["username"]; - }; - }; + project_id: components['parameters']['project-id'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | ({ /** * @description The permission to grant the collaborator. @@ -26245,438 +26224,438 @@ export interface operations { * @example write * @enum {string} */ - permission?: "read" | "write" | "admin"; + permission?: 'read' | 'write' | 'admin' } & { [key: string]: unknown }) - | null; - }; - }; - }; + | null + } + } + } /** Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator. */ - "projects/remove-collaborator": { + 'projects/remove-collaborator': { parameters: { path: { - project_id: components["parameters"]["project-id"]; - username: components["parameters"]["username"]; - }; - }; + project_id: components['parameters']['project-id'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level. */ - "projects/get-permission-for-user": { + 'projects/get-permission-for-user': { parameters: { path: { - project_id: components["parameters"]["project-id"]; - username: components["parameters"]["username"]; - }; - }; + project_id: components['parameters']['project-id'] + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["project-collaborator-permission"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "projects/list-columns": { + 'application/json': components['schemas']['project-collaborator-permission'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } + 'projects/list-columns': { parameters: { path: { - project_id: components["parameters"]["project-id"]; - }; + project_id: components['parameters']['project-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["project-column"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; - "projects/create-column": { + 'application/json': components['schemas']['project-column'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } + 'projects/create-column': { parameters: { path: { - project_id: components["parameters"]["project-id"]; - }; - }; + project_id: components['parameters']['project-id'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["project-column"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': components['schemas']['project-column'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description Name of the project column * @example Remaining tasks */ - name: string; - } & { [key: string]: unknown }; - }; - }; - }; + name: string + } & { [key: string]: unknown } + } + } + } /** * **Note:** Accessing this endpoint does not count against your REST API rate limit. * * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. */ - "rate-limit/get": { - parameters: {}; + 'rate-limit/get': { + parameters: {} responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["rate-limit-overview"]; - }; - }; - 304: components["responses"]["not_modified"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['rate-limit-overview'] + } + } + 304: components['responses']['not_modified'] + 404: components['responses']['not_found'] + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Reactions API. We recommend migrating your existing code to use the new delete reactions endpoints. For more information, see this [blog post](https://developer.github.com/changes/2020-02-26-new-delete-reactions-endpoints/). * * OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), when deleting a [team discussion](https://docs.github.com/rest/reference/teams#discussions) or [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). */ - "reactions/delete-legacy": { + 'reactions/delete-legacy': { parameters: { path: { - reaction_id: components["parameters"]["reaction-id"]; - }; - }; + reaction_id: components['parameters']['reaction-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 410: components["responses"]["gone"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 410: components['responses']['gone'] + } + } /** The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. */ - "repos/get": { + 'repos/get': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["full-repository"]; - }; - }; - 301: components["responses"]["moved_permanently"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['full-repository'] + } + } + 301: components['responses']['moved_permanently'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required. * * If an organization owner has configured the organization to prevent members from deleting organization-owned * repositories, you will get a `403 Forbidden` response. */ - "repos/delete": { + 'repos/delete': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - 307: components["responses"]["temporary_redirect"]; + 204: never + 307: components['responses']['temporary_redirect'] /** If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response: */ 403: { content: { - "application/json": { - message?: string; - documentation_url?: string; - } & { [key: string]: unknown }; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': { + message?: string + documentation_url?: string + } & { [key: string]: unknown } + } + } + 404: components['responses']['not_found'] + } + } /** **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/rest/reference/repos#replace-all-repository-topics) endpoint. */ - "repos/update": { + 'repos/update': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["full-repository"]; - }; - }; - 307: components["responses"]["temporary_redirect"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['full-repository'] + } + } + 307: components['responses']['temporary_redirect'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the repository. */ - name?: string; + name?: string /** @description A short description of the repository. */ - description?: string; + description?: string /** @description A URL with more information about the repository. */ - homepage?: string; + homepage?: string /** * @description Either `true` to make the repository private or `false` to make it public. Default: `false`. * **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. */ - private?: boolean; + private?: boolean /** * @description Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`." * @enum {string} */ - visibility?: "public" | "private" | "internal"; + visibility?: 'public' | 'private' | 'internal' /** @description Specify which security and analysis features to enable or disable. For example, to enable GitHub Advanced Security, use this data in the body of the PATCH request: `{"security_and_analysis": {"advanced_security": {"status": "enabled"}}}`. If you have admin permissions for a private repository covered by an Advanced Security license, you can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request. */ security_and_analysis?: | ({ /** @description Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see "[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security)." */ advanced_security?: { /** @description Can be `enabled` or `disabled`. */ - status?: string; - } & { [key: string]: unknown }; + status?: string + } & { [key: string]: unknown } /** @description Use the `status` property to enable or disable secret scanning for this repository. For more information, see "[About secret scanning](/code-security/secret-security/about-secret-scanning)." */ secret_scanning?: { /** @description Can be `enabled` or `disabled`. */ - status?: string; - } & { [key: string]: unknown }; + status?: string + } & { [key: string]: unknown } } & { [key: string]: unknown }) - | null; + | null /** * @description Either `true` to enable issues for this repository or `false` to disable them. * @default true */ - has_issues?: boolean; + has_issues?: boolean /** * @description Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error. * @default true */ - has_projects?: boolean; + has_projects?: boolean /** * @description Either `true` to enable the wiki for this repository or `false` to disable it. * @default true */ - has_wiki?: boolean; + has_wiki?: boolean /** @description Either `true` to make this repo available as a template repository or `false` to prevent it. */ - is_template?: boolean; + is_template?: boolean /** @description Updates the default branch for this repository. */ - default_branch?: string; + default_branch?: string /** * @description Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge?: boolean /** * @description Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit?: boolean /** * @description Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge?: boolean /** @description Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. */ - allow_auto_merge?: boolean; + allow_auto_merge?: boolean /** @description Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge?: boolean /** @description `true` to archive this repository. **Note**: You cannot unarchive repositories through the API. */ - archived?: boolean; + archived?: boolean /** @description Either `true` to allow private forks, or `false` to prevent private forks. */ - allow_forking?: boolean; - } & { [key: string]: unknown }; - }; - }; - }; + allow_forking?: boolean + } & { [key: string]: unknown } + } + } + } /** Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/list-artifacts-for-repo": { + 'actions/list-artifacts-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - artifacts: components["schemas"]["artifact"][]; - } & { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': { + total_count: number + artifacts: components['schemas']['artifact'][] + } & { [key: string]: unknown } + } + } + } + } /** Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/get-artifact": { + 'actions/get-artifact': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** artifact_id parameter */ - artifact_id: components["parameters"]["artifact-id"]; - }; - }; + artifact_id: components['parameters']['artifact-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["artifact"]; - }; - }; - }; - }; + 'application/json': components['schemas']['artifact'] + } + } + } + } /** Deletes an artifact for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - "actions/delete-artifact": { + 'actions/delete-artifact': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** artifact_id parameter */ - artifact_id: components["parameters"]["artifact-id"]; - }; - }; + artifact_id: components['parameters']['artifact-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in * the response header to find the URL for the download. The `:archive_format` must be `zip`. Anyone with read access to * the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/download-artifact": { + 'actions/download-artifact': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** artifact_id parameter */ - artifact_id: components["parameters"]["artifact-id"]; - archive_format: string; - }; - }; + artifact_id: components['parameters']['artifact-id'] + archive_format: string + } + } responses: { /** Response */ - 302: never; - }; - }; + 302: never + } + } /** Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/get-job-for-workflow-run": { + 'actions/get-job-for-workflow-run': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** job_id parameter */ - job_id: components["parameters"]["job-id"]; - }; - }; + job_id: components['parameters']['job-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["job"]; - }; - }; - }; - }; + 'application/json': components['schemas']['job'] + } + } + } + } /** * Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look * for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can * use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must * have the `actions:read` permission to use this endpoint. */ - "actions/download-job-logs-for-workflow-run": { + 'actions/download-job-logs-for-workflow-run': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** job_id parameter */ - job_id: components["parameters"]["job-id"]; - }; - }; + job_id: components['parameters']['job-id'] + } + } responses: { /** Response */ - 302: never; - }; - }; + 302: never + } + } /** * Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository. * * You must authenticate using an access token with the `repo` scope to use this * endpoint. GitHub Apps must have the `administration` repository permission to use this API. */ - "actions/get-github-actions-permissions-repository": { + 'actions/get-github-actions-permissions-repository': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-repository-permissions"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-repository-permissions'] + } + } + } + } /** * Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository. * @@ -26684,47 +26663,47 @@ export interface operations { * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. */ - "actions/set-github-actions-permissions-repository": { + 'actions/set-github-actions-permissions-repository': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { - enabled: components["schemas"]["actions-enabled"]; - allowed_actions?: components["schemas"]["allowed-actions"]; - } & { [key: string]: unknown }; - }; - }; - }; + 'application/json': { + enabled: components['schemas']['actions-enabled'] + allowed_actions?: components['schemas']['allowed-actions'] + } & { [key: string]: unknown } + } + } + } /** * Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. */ - "actions/get-allowed-actions-repository": { + 'actions/get-allowed-actions-repository': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["selected-actions"]; - }; - }; - }; - }; + 'application/json': components['schemas']['selected-actions'] + } + } + } + } /** * Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." * @@ -26734,71 +26713,71 @@ export interface operations { * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. */ - "actions/set-allowed-actions-repository": { + 'actions/set-allowed-actions-repository': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": components["schemas"]["selected-actions"]; - }; - }; - }; + 'application/json': components['schemas']['selected-actions'] + } + } + } /** Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. */ - "actions/list-self-hosted-runners-for-repo": { + 'actions/list-self-hosted-runners-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - runners: components["schemas"]["runner"][]; - } & { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': { + total_count: number + runners: components['schemas']['runner'][] + } & { [key: string]: unknown } + } + } + } + } /** * Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `repo` scope to use this endpoint. */ - "actions/list-runner-applications-for-repo": { + 'actions/list-runner-applications-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["runner-application"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['runner-application'][] + } + } + } + } /** * Returns a token that you can pass to the `config` script. The token expires after one hour. You must authenticate * using an access token with the `repo` scope to use this endpoint. @@ -26811,22 +26790,22 @@ export interface operations { * ./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN * ``` */ - "actions/create-registration-token-for-repo": { + 'actions/create-registration-token-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["authentication-token"]; - }; - }; - }; - }; + 'application/json': components['schemas']['authentication-token'] + } + } + } + } /** * Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour. * You must authenticate using an access token with the `repo` scope to use this endpoint. @@ -26839,86 +26818,86 @@ export interface operations { * ./config.sh remove --token TOKEN * ``` */ - "actions/create-remove-token-for-repo": { + 'actions/create-remove-token-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["authentication-token"]; - }; - }; - }; - }; + 'application/json': components['schemas']['authentication-token'] + } + } + } + } /** * Gets a specific self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - "actions/get-self-hosted-runner-for-repo": { + 'actions/get-self-hosted-runner-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["runner"]; - }; - }; - }; - }; + 'application/json': components['schemas']['runner'] + } + } + } + } /** * Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * * You must authenticate using an access token with the `repo` * scope to use this endpoint. */ - "actions/delete-self-hosted-runner-from-repo": { + 'actions/delete-self-hosted-runner-from-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Lists all labels for a self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - "actions/list-labels-for-self-hosted-runner-for-repo": { + 'actions/list-labels-for-self-hosted-runner-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - }; - }; + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + } + } /** * Remove all previous custom labels and set the new custom labels for a specific * self-hosted runner configured in a repository. @@ -26926,58 +26905,58 @@ export interface operations { * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - "actions/set-custom-labels-for-self-hosted-runner-for-repo": { + 'actions/set-custom-labels-for-self-hosted-runner-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; - responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + runner_id: components['parameters']['runner-id'] + } + } + responses: { + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels. */ - labels: string[]; - } & { [key: string]: unknown }; - }; - }; - }; + labels: string[] + } & { [key: string]: unknown } + } + } + } /** * Add custom labels to a self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - "actions/add-custom-labels-to-self-hosted-runner-for-repo": { + 'actions/add-custom-labels-to-self-hosted-runner-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; - responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + runner_id: components['parameters']['runner-id'] + } + } + responses: { + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The names of the custom labels to add to the runner. */ - labels: string[]; - } & { [key: string]: unknown }; - }; - }; - }; + labels: string[] + } & { [key: string]: unknown } + } + } + } /** * Remove all custom labels from a self-hosted runner configured in a * repository. Returns the remaining read-only labels from the runner. @@ -26985,20 +26964,20 @@ export interface operations { * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - "actions/remove-all-custom-labels-from-self-hosted-runner-for-repo": { + 'actions/remove-all-custom-labels-from-self-hosted-runner-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { - 200: components["responses"]["actions_runner_labels_readonly"]; - 404: components["responses"]["not_found"]; - }; - }; + 200: components['responses']['actions_runner_labels_readonly'] + 404: components['responses']['not_found'] + } + } /** * Remove a custom label from a self-hosted runner configured * in a repository. Returns the remaining labels from the runner. @@ -27009,531 +26988,531 @@ export interface operations { * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - "actions/remove-custom-label-from-self-hosted-runner-for-repo": { + 'actions/remove-custom-label-from-self-hosted-runner-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; + runner_id: components['parameters']['runner-id'] /** The name of a self-hosted runner's custom label. */ - name: components["parameters"]["runner-label-name"]; - }; - }; + name: components['parameters']['runner-label-name'] + } + } responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; - }; + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } + } /** * Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). * * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/list-workflow-runs-for-repo": { + 'actions/list-workflow-runs-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ - actor?: components["parameters"]["actor"]; + actor?: components['parameters']['actor'] /** Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ - branch?: components["parameters"]["workflow-run-branch"]; + branch?: components['parameters']['workflow-run-branch'] /** Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ - event?: components["parameters"]["event"]; + event?: components['parameters']['event'] /** Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. For a list of the possible `status` and `conclusion` options, see "[Create a check run](https://docs.github.com/rest/reference/checks#create-a-check-run)." */ - status?: components["parameters"]["workflow-run-status"]; + status?: components['parameters']['workflow-run-status'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ - created?: components["parameters"]["created"]; + created?: components['parameters']['created'] /** If `true` pull requests are omitted from the response (empty array). */ - exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; + exclude_pull_requests?: components['parameters']['exclude-pull-requests'] /** Returns workflow runs with the `check_suite_id` that you specify. */ - check_suite_id?: components["parameters"]["workflow-run-check-suite-id"]; - }; - }; + check_suite_id?: components['parameters']['workflow-run-check-suite-id'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - workflow_runs: components["schemas"]["workflow-run"][]; - } & { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': { + total_count: number + workflow_runs: components['schemas']['workflow-run'][] + } & { [key: string]: unknown } + } + } + } + } /** Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/get-workflow-run": { + 'actions/get-workflow-run': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; + run_id: components['parameters']['run-id'] + } query: { /** If `true` pull requests are omitted from the response (empty array). */ - exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; - }; - }; + exclude_pull_requests?: components['parameters']['exclude-pull-requests'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["workflow-run"]; - }; - }; - }; - }; + 'application/json': components['schemas']['workflow-run'] + } + } + } + } /** * Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is * private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:write` permission to use * this endpoint. */ - "actions/delete-workflow-run": { + 'actions/delete-workflow-run': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; - }; + run_id: components['parameters']['run-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/get-reviews-for-run": { + 'actions/get-reviews-for-run': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; - }; + run_id: components['parameters']['run-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["environment-approvals"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['environment-approvals'][] + } + } + } + } /** * Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)." * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - "actions/approve-workflow-run": { + 'actions/approve-workflow-run': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; - }; + run_id: components['parameters']['run-id'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["empty-object"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['empty-object'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/list-workflow-run-artifacts": { + 'actions/list-workflow-run-artifacts': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; + run_id: components['parameters']['run-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - artifacts: components["schemas"]["artifact"][]; - } & { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': { + total_count: number + artifacts: components['schemas']['artifact'][] + } & { [key: string]: unknown } + } + } + } + } /** * Gets a specific workflow run attempt. Anyone with read access to the repository * can use this endpoint. If the repository is private you must use an access token * with the `repo` scope. GitHub Apps must have the `actions:read` permission to * use this endpoint. */ - "actions/get-workflow-run-attempt": { + 'actions/get-workflow-run-attempt': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; + run_id: components['parameters']['run-id'] /** The attempt number of the workflow run. */ - attempt_number: components["parameters"]["attempt-number"]; - }; + attempt_number: components['parameters']['attempt-number'] + } query: { /** If `true` pull requests are omitted from the response (empty array). */ - exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; - }; - }; + exclude_pull_requests?: components['parameters']['exclude-pull-requests'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["workflow-run"]; - }; - }; - }; - }; + 'application/json': components['schemas']['workflow-run'] + } + } + } + } /** Lists jobs for a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). */ - "actions/list-jobs-for-workflow-run-attempt": { + 'actions/list-jobs-for-workflow-run-attempt': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; + run_id: components['parameters']['run-id'] /** The attempt number of the workflow run. */ - attempt_number: components["parameters"]["attempt-number"]; - }; + attempt_number: components['parameters']['attempt-number'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - jobs: components["schemas"]["job"][]; - } & { [key: string]: unknown }; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': { + total_count: number + jobs: components['schemas']['job'][] + } & { [key: string]: unknown } + } + } + 404: components['responses']['not_found'] + } + } /** * Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after * 1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to * the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/download-workflow-run-attempt-logs": { + 'actions/download-workflow-run-attempt-logs': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; + run_id: components['parameters']['run-id'] /** The attempt number of the workflow run. */ - attempt_number: components["parameters"]["attempt-number"]; - }; - }; + attempt_number: components['parameters']['attempt-number'] + } + } responses: { /** Response */ - 302: never; - }; - }; + 302: never + } + } /** Cancels a workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - "actions/cancel-workflow-run": { + 'actions/cancel-workflow-run': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; - }; + run_id: components['parameters']['run-id'] + } + } responses: { /** Response */ 202: { content: { - "application/json": { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': { [key: string]: unknown } + } + } + } + } /** Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). */ - "actions/list-jobs-for-workflow-run": { + 'actions/list-jobs-for-workflow-run': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; + run_id: components['parameters']['run-id'] + } query: { /** * Filters jobs by their `completed_at` timestamp. Can be one of: * \* `latest`: Returns jobs from the most recent execution of the workflow run. * \* `all`: Returns all jobs for a workflow run, including from old executions of the workflow run. */ - filter?: "latest" | "all"; + filter?: 'latest' | 'all' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - jobs: components["schemas"]["job"][]; - } & { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': { + total_count: number + jobs: components['schemas']['job'][] + } & { [key: string]: unknown } + } + } + } + } /** * Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for * `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use * this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have * the `actions:read` permission to use this endpoint. */ - "actions/download-workflow-run-logs": { + 'actions/download-workflow-run-logs': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; - }; + run_id: components['parameters']['run-id'] + } + } responses: { /** Response */ - 302: never; - }; - }; + 302: never + } + } /** Deletes all logs for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - "actions/delete-workflow-run-logs": { + 'actions/delete-workflow-run-logs': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; - }; + run_id: components['parameters']['run-id'] + } + } responses: { /** Response */ - 204: never; - 403: components["responses"]["forbidden"]; - 500: components["responses"]["internal_error"]; - }; - }; + 204: never + 403: components['responses']['forbidden'] + 500: components['responses']['internal_error'] + } + } /** * Get all deployment environments for a workflow run that are waiting for protection rules to pass. * * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/get-pending-deployments-for-run": { + 'actions/get-pending-deployments-for-run': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; - }; + run_id: components['parameters']['run-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pending-deployment"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['pending-deployment'][] + } + } + } + } /** * Approve or reject pending deployments that are waiting on approval by a required reviewer. * * Anyone with read access to the repository contents and deployments can use this endpoint. */ - "actions/review-pending-deployments-for-run": { + 'actions/review-pending-deployments-for-run': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; - }; + run_id: components['parameters']['run-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["deployment"][]; - }; - }; - }; + 'application/json': components['schemas']['deployment'][] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The list of environment ids to approve or reject * @example 161171787,161171795 */ - environment_ids: number[]; + environment_ids: number[] /** * @description Whether to approve or reject deployment to the specified environments. Must be one of: `approved` or `rejected` * @example approved * @enum {string} */ - state: "approved" | "rejected"; + state: 'approved' | 'rejected' /** * @description A comment to accompany the deployment review * @example Ship it! */ - comment: string; - } & { [key: string]: unknown }; - }; - }; - }; + comment: string + } & { [key: string]: unknown } + } + } + } /** Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - "actions/re-run-workflow": { + 'actions/re-run-workflow': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; - }; + run_id: components['parameters']['run-id'] + } + } responses: { /** Response */ 201: { content: { - "application/json": { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': { [key: string]: unknown } + } + } + } + } /** * Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/get-workflow-run-usage": { + 'actions/get-workflow-run-usage': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; - }; + run_id: components['parameters']['run-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["workflow-run-usage"]; - }; - }; - }; - }; + 'application/json': components['schemas']['workflow-run-usage'] + } + } + } + } /** Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - "actions/list-repo-secrets": { + 'actions/list-repo-secrets': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - secrets: components["schemas"]["actions-secret"][]; - } & { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': { + total_count: number + secrets: components['schemas']['actions-secret'][] + } & { [key: string]: unknown } + } + } + } + } /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - "actions/get-repo-public-key": { + 'actions/get-repo-public-key': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-public-key"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-public-key'] + } + } + } + } /** Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - "actions/get-repo-secret": { + 'actions/get-repo-secret': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-secret"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-secret'] + } + } + } + } /** * Creates or updates a repository secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -27611,116 +27590,116 @@ export interface operations { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - "actions/create-or-update-repo-secret": { + 'actions/create-or-update-repo-secret': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response when creating a secret */ 201: { content: { - "application/json": { [key: string]: unknown }; - }; - }; + 'application/json': { [key: string]: unknown } + } + } /** Response when updating a secret */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/reference/actions#get-a-repository-public-key) endpoint. */ - encrypted_value?: string; + encrypted_value?: string /** @description ID of the key you used to encrypt the secret. */ - key_id?: string; - } & { [key: string]: unknown }; - }; - }; - }; + key_id?: string + } & { [key: string]: unknown } + } + } + } /** Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - "actions/delete-repo-secret": { + 'actions/delete-repo-secret': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/list-repo-workflows": { + 'actions/list-repo-workflows': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - workflows: components["schemas"]["workflow"][]; - } & { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': { + total_count: number + workflows: components['schemas']['workflow'][] + } & { [key: string]: unknown } + } + } + } + } /** Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/get-workflow": { + 'actions/get-workflow': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The ID of the workflow. You can also pass the workflow file name as a string. */ - workflow_id: components["parameters"]["workflow-id"]; - }; - }; + workflow_id: components['parameters']['workflow-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["workflow"]; - }; - }; - }; - }; + 'application/json': components['schemas']['workflow'] + } + } + } + } /** * Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - "actions/disable-workflow": { + 'actions/disable-workflow': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The ID of the workflow. You can also pass the workflow file name as a string. */ - workflow_id: components["parameters"]["workflow-id"]; - }; - }; + workflow_id: components['parameters']['workflow-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * @@ -27728,144 +27707,144 @@ export interface operations { * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)." */ - "actions/create-workflow-dispatch": { + 'actions/create-workflow-dispatch': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The ID of the workflow. You can also pass the workflow file name as a string. */ - workflow_id: components["parameters"]["workflow-id"]; - }; - }; + workflow_id: components['parameters']['workflow-id'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The git reference for the workflow. The reference can be a branch or tag name. */ - ref: string; + ref: string /** @description Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted. */ - inputs?: { [key: string]: string }; - } & { [key: string]: unknown }; - }; - }; - }; + inputs?: { [key: string]: string } + } & { [key: string]: unknown } + } + } + } /** * Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - "actions/enable-workflow": { + 'actions/enable-workflow': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The ID of the workflow. You can also pass the workflow file name as a string. */ - workflow_id: components["parameters"]["workflow-id"]; - }; - }; + workflow_id: components['parameters']['workflow-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). * * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. */ - "actions/list-workflow-runs": { + 'actions/list-workflow-runs': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The ID of the workflow. You can also pass the workflow file name as a string. */ - workflow_id: components["parameters"]["workflow-id"]; - }; + workflow_id: components['parameters']['workflow-id'] + } query: { /** Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ - actor?: components["parameters"]["actor"]; + actor?: components['parameters']['actor'] /** Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ - branch?: components["parameters"]["workflow-run-branch"]; + branch?: components['parameters']['workflow-run-branch'] /** Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ - event?: components["parameters"]["event"]; + event?: components['parameters']['event'] /** Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. For a list of the possible `status` and `conclusion` options, see "[Create a check run](https://docs.github.com/rest/reference/checks#create-a-check-run)." */ - status?: components["parameters"]["workflow-run-status"]; + status?: components['parameters']['workflow-run-status'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ - created?: components["parameters"]["created"]; + created?: components['parameters']['created'] /** If `true` pull requests are omitted from the response (empty array). */ - exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; + exclude_pull_requests?: components['parameters']['exclude-pull-requests'] /** Returns workflow runs with the `check_suite_id` that you specify. */ - check_suite_id?: components["parameters"]["workflow-run-check-suite-id"]; - }; - }; + check_suite_id?: components['parameters']['workflow-run-check-suite-id'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - workflow_runs: components["schemas"]["workflow-run"][]; - } & { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': { + total_count: number + workflow_runs: components['schemas']['workflow-run'][] + } & { [key: string]: unknown } + } + } + } + } /** * Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * * You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/get-workflow-usage": { + 'actions/get-workflow-usage': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The ID of the workflow. You can also pass the workflow file name as a string. */ - workflow_id: components["parameters"]["workflow-id"]; - }; - }; + workflow_id: components['parameters']['workflow-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["workflow-usage"]; - }; - }; - }; - }; + 'application/json': components['schemas']['workflow-usage'] + } + } + } + } /** Lists the [available assignees](https://docs.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. */ - "issues/list-assignees": { + 'issues/list-assignees': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + 404: components['responses']['not_found'] + } + } /** * Checks if a user has permission to be assigned to an issue in this repository. * @@ -27873,218 +27852,218 @@ export interface operations { * * Otherwise a `404` status code is returned. */ - "issues/check-user-can-be-assigned": { + 'issues/check-user-can-be-assigned': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - assignee: string; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + assignee: string + } + } responses: { /** If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. */ - 204: never; + 204: never /** Otherwise a `404` status code is returned. */ 404: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } + } + } /** * This returns a list of autolinks configured for the given repository. * * Information about autolinks are only available to repository administrators. */ - "repos/list-autolinks": { + 'repos/list-autolinks': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["autolink"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['autolink'][] + } + } + } + } /** Users with admin access to the repository can create an autolink. */ - "repos/create-autolink": { + 'repos/create-autolink': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["autolink"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['autolink'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit. */ - key_prefix: string; + key_prefix: string /** @description The URL must contain for the reference number. */ - url_template: string; - } & { [key: string]: unknown }; - }; - }; - }; + url_template: string + } & { [key: string]: unknown } + } + } + } /** * This returns a single autolink reference by ID that was configured for the given repository. * * Information about autolinks are only available to repository administrators. */ - "repos/get-autolink": { + 'repos/get-autolink': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** autolink_id parameter */ - autolink_id: components["parameters"]["autolink-id"]; - }; - }; + autolink_id: components['parameters']['autolink-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["autolink"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['autolink'] + } + } + 404: components['responses']['not_found'] + } + } /** * This deletes a single autolink reference by ID that was configured for the given repository. * * Information about autolinks are only available to repository administrators. */ - "repos/delete-autolink": { + 'repos/delete-autolink': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** autolink_id parameter */ - autolink_id: components["parameters"]["autolink-id"]; - }; - }; + autolink_id: components['parameters']['autolink-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/en/articles/configuring-automated-security-fixes)". */ - "repos/enable-automated-security-fixes": { + 'repos/enable-automated-security-fixes': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/en/articles/configuring-automated-security-fixes)". */ - "repos/disable-automated-security-fixes": { + 'repos/disable-automated-security-fixes': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; - }; - "repos/list-branches": { + 204: never + } + } + 'repos/list-branches': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches. */ - protected?: boolean; + protected?: boolean /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["short-branch"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "repos/get-branch": { + 'application/json': components['schemas']['short-branch'][] + } + } + 404: components['responses']['not_found'] + } + } + 'repos/get-branch': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["branch-with-protection"]; - }; - }; - 301: components["responses"]["moved_permanently"]; - 404: components["responses"]["not_found"]; - 415: components["responses"]["preview_header_missing"]; - }; - }; + 'application/json': components['schemas']['branch-with-protection'] + } + } + 301: components['responses']['moved_permanently'] + 404: components['responses']['not_found'] + 415: components['responses']['preview_header_missing'] + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "repos/get-branch-protection": { + 'repos/get-branch-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["branch-protection"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['branch-protection'] + } + } + 404: components['responses']['not_found'] + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28094,213 +28073,213 @@ export interface operations { * * **Note**: The list of users, apps, and teams in total is limited to 100 items. */ - "repos/update-branch-protection": { + 'repos/update-branch-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["protected-branch"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': components['schemas']['protected-branch'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Require status checks to pass before merging. Set to `null` to disable. */ required_status_checks: | ({ /** @description Require branches to be up to date before merging. */ - strict: boolean; + strict: boolean /** * @deprecated * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. */ - contexts: string[]; + contexts: string[] /** @description The list of status checks to require in order to merge into this branch. */ checks?: ({ /** @description The name of the required check */ - context: string; + context: string /** @description The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status. */ - app_id?: number; - } & { [key: string]: unknown })[]; + app_id?: number + } & { [key: string]: unknown })[] } & { [key: string]: unknown }) - | null; + | null /** @description Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable. */ - enforce_admins: boolean | null; + enforce_admins: boolean | null /** @description Require at least one approving review on a pull request, before merging. Set to `null` to disable. */ required_pull_request_reviews: | ({ /** @description Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories. */ dismissal_restrictions?: { /** @description The list of user `login`s with dismissal access */ - users?: string[]; + users?: string[] /** @description The list of team `slug`s with dismissal access */ - teams?: string[]; - } & { [key: string]: unknown }; + teams?: string[] + } & { [key: string]: unknown } /** @description Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit. */ - dismiss_stale_reviews?: boolean; + dismiss_stale_reviews?: boolean /** @description Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them. */ - require_code_owner_reviews?: boolean; + require_code_owner_reviews?: boolean /** @description Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers. */ - required_approving_review_count?: number; + required_approving_review_count?: number /** @description Allow specific users or teams to bypass pull request requirements. Set to `null` to disable. */ bypass_pull_request_allowances?: | ({ /** @description The list of user `login`s allowed to bypass pull request requirements. */ - users?: string[]; + users?: string[] /** @description The list of team `slug`s allowed to bypass pull request requirements. */ - teams?: string[]; + teams?: string[] } & { [key: string]: unknown }) - | null; + | null } & { [key: string]: unknown }) - | null; + | null /** @description Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable. */ restrictions: | ({ /** @description The list of user `login`s with push access */ - users: string[]; + users: string[] /** @description The list of team `slug`s with push access */ - teams: string[]; + teams: string[] /** @description The list of app `slug`s with push access */ - apps?: string[]; + apps?: string[] } & { [key: string]: unknown }) - | null; + | null /** @description Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see "[Requiring a linear commit history](https://docs.github.com/github/administering-a-repository/requiring-a-linear-commit-history)" in the GitHub Help documentation. */ - required_linear_history?: boolean; + required_linear_history?: boolean /** @description Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation." */ - allow_force_pushes?: boolean | null; + allow_force_pushes?: boolean | null /** @description Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation. */ - allow_deletions?: boolean; + allow_deletions?: boolean /** @description Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`. */ - required_conversation_resolution?: boolean; - } & { [key: string]: unknown }; - }; - }; - }; + required_conversation_resolution?: boolean + } & { [key: string]: unknown } + } + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "repos/delete-branch-protection": { + 'repos/delete-branch-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ - 204: never; - 403: components["responses"]["forbidden"]; - }; - }; + 204: never + 403: components['responses']['forbidden'] + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "repos/get-admin-branch-protection": { + 'repos/get-admin-branch-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["protected-branch-admin-enforced"]; - }; - }; - }; - }; + 'application/json': components['schemas']['protected-branch-admin-enforced'] + } + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ - "repos/set-admin-branch-protection": { + 'repos/set-admin-branch-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["protected-branch-admin-enforced"]; - }; - }; - }; - }; + 'application/json': components['schemas']['protected-branch-admin-enforced'] + } + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ - "repos/delete-admin-branch-protection": { + 'repos/delete-admin-branch-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "repos/get-pull-request-review-protection": { + 'repos/get-pull-request-review-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["protected-branch-pull-request-review"]; - }; - }; - }; - }; + 'application/json': components['schemas']['protected-branch-pull-request-review'] + } + } + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "repos/delete-pull-request-review-protection": { + 'repos/delete-pull-request-review-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28308,53 +28287,53 @@ export interface operations { * * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. */ - "repos/update-pull-request-review-protection": { + 'repos/update-pull-request-review-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["protected-branch-pull-request-review"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['protected-branch-pull-request-review'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories. */ dismissal_restrictions?: { /** @description The list of user `login`s with dismissal access */ - users?: string[]; + users?: string[] /** @description The list of team `slug`s with dismissal access */ - teams?: string[]; - } & { [key: string]: unknown }; + teams?: string[] + } & { [key: string]: unknown } /** @description Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit. */ - dismiss_stale_reviews?: boolean; + dismiss_stale_reviews?: boolean /** @description Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) have reviewed. */ - require_code_owner_reviews?: boolean; + require_code_owner_reviews?: boolean /** @description Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers. */ - required_approving_review_count?: number; + required_approving_review_count?: number /** @description Allow specific users or teams to bypass pull request requirements. Set to `null` to disable. */ bypass_pull_request_allowances?: | ({ /** @description The list of user `login`s allowed to bypass pull request requirements. */ - users?: string[]; + users?: string[] /** @description The list of team `slug`s allowed to bypass pull request requirements. */ - teams?: string[]; + teams?: string[] } & { [key: string]: unknown }) - | null; - } & { [key: string]: unknown }; - }; - }; - }; + | null + } & { [key: string]: unknown } + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28362,266 +28341,266 @@ export interface operations { * * **Note**: You must enable branch protection to require signed commits. */ - "repos/get-commit-signature-protection": { + 'repos/get-commit-signature-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["protected-branch-admin-enforced"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['protected-branch-admin-enforced'] + } + } + 404: components['responses']['not_found'] + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits. */ - "repos/create-commit-signature-protection": { + 'repos/create-commit-signature-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["protected-branch-admin-enforced"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['protected-branch-admin-enforced'] + } + } + 404: components['responses']['not_found'] + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits. */ - "repos/delete-commit-signature-protection": { + 'repos/delete-commit-signature-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "repos/get-status-checks-protection": { + 'repos/get-status-checks-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["status-check-policy"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['status-check-policy'] + } + } + 404: components['responses']['not_found'] + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "repos/remove-status-check-protection": { + 'repos/remove-status-check-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. */ - "repos/update-status-check-protection": { + 'repos/update-status-check-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["status-check-policy"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['status-check-policy'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Require branches to be up to date before merging. */ - strict?: boolean; + strict?: boolean /** * @deprecated * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. */ - contexts?: string[]; + contexts?: string[] /** @description The list of status checks to require in order to merge into this branch. */ checks?: ({ /** @description The name of the required check */ - context: string; + context: string /** @description The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status. */ - app_id?: number; - } & { [key: string]: unknown })[]; - } & { [key: string]: unknown }; - }; - }; - }; + app_id?: number + } & { [key: string]: unknown })[] + } & { [key: string]: unknown } + } + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "repos/get-all-status-check-contexts": { + 'repos/get-all-status-check-contexts': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": string[]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': string[] + } + } + 404: components['responses']['not_found'] + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "repos/set-status-check-contexts": { + 'repos/set-status-check-contexts': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": string[]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': string[] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": ( + 'application/json': ( | ({ /** @description contexts parameter */ - contexts: string[]; + contexts: string[] } & { [key: string]: unknown }) | string[] - ) & { [key: string]: unknown }; - }; - }; - }; + ) & { [key: string]: unknown } + } + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "repos/add-status-check-contexts": { + 'repos/add-status-check-contexts': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": string[]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': string[] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": ( + 'application/json': ( | ({ /** @description contexts parameter */ - contexts: string[]; + contexts: string[] } & { [key: string]: unknown }) | string[] - ) & { [key: string]: unknown }; - }; - }; - }; + ) & { [key: string]: unknown } + } + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "repos/remove-status-check-contexts": { + 'repos/remove-status-check-contexts': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": string[]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': string[] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": ( + 'application/json': ( | ({ /** @description contexts parameter */ - contexts: string[]; + contexts: string[] } & { [key: string]: unknown }) | string[] - ) & { [key: string]: unknown }; - }; - }; - }; + ) & { [key: string]: unknown } + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28629,68 +28608,68 @@ export interface operations { * * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. */ - "repos/get-access-restrictions": { + 'repos/get-access-restrictions': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["branch-restriction-policy"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['branch-restriction-policy'] + } + } + 404: components['responses']['not_found'] + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Disables the ability to restrict who can push to this branch. */ - "repos/delete-access-restrictions": { + 'repos/delete-access-restrictions': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. */ - "repos/get-apps-with-access-to-protected-branch": { + 'repos/get-apps-with-access-to-protected-branch': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["integration"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['integration'][] + } + } + 404: components['responses']['not_found'] + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28700,36 +28679,36 @@ export interface operations { * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - "repos/set-app-access-restrictions": { + 'repos/set-app-access-restrictions': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["integration"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['integration'][] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": ( + 'application/json': ( | ({ /** @description apps parameter */ - apps: string[]; + apps: string[] } & { [key: string]: unknown }) | string[] - ) & { [key: string]: unknown }; - }; - }; - }; + ) & { [key: string]: unknown } + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28739,36 +28718,36 @@ export interface operations { * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - "repos/add-app-access-restrictions": { + 'repos/add-app-access-restrictions': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["integration"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['integration'][] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": ( + 'application/json': ( | ({ /** @description apps parameter */ - apps: string[]; + apps: string[] } & { [key: string]: unknown }) | string[] - ) & { [key: string]: unknown }; - }; - }; - }; + ) & { [key: string]: unknown } + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28778,60 +28757,60 @@ export interface operations { * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - "repos/remove-app-access-restrictions": { + 'repos/remove-app-access-restrictions': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["integration"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['integration'][] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": ( + 'application/json': ( | ({ /** @description apps parameter */ - apps: string[]; + apps: string[] } & { [key: string]: unknown }) | string[] - ) & { [key: string]: unknown }; - }; - }; - }; + ) & { [key: string]: unknown } + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the teams who have push access to this branch. The list includes child teams. */ - "repos/get-teams-with-access-to-protected-branch": { + 'repos/get-teams-with-access-to-protected-branch': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['team'][] + } + } + 404: components['responses']['not_found'] + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28841,36 +28820,36 @@ export interface operations { * | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ | * | `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - "repos/set-team-access-restrictions": { + 'repos/set-team-access-restrictions': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['team'][] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": ( + 'application/json': ( | ({ /** @description teams parameter */ - teams: string[]; + teams: string[] } & { [key: string]: unknown }) | string[] - ) & { [key: string]: unknown }; - }; - }; - }; + ) & { [key: string]: unknown } + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28880,36 +28859,36 @@ export interface operations { * | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ | * | `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - "repos/add-team-access-restrictions": { + 'repos/add-team-access-restrictions': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['team'][] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": ( + 'application/json': ( | ({ /** @description teams parameter */ - teams: string[]; + teams: string[] } & { [key: string]: unknown }) | string[] - ) & { [key: string]: unknown }; - }; - }; - }; + ) & { [key: string]: unknown } + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28919,60 +28898,60 @@ export interface operations { * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | Teams that should no longer have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - "repos/remove-team-access-restrictions": { + 'repos/remove-team-access-restrictions': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['team'][] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": ( + 'application/json': ( | ({ /** @description teams parameter */ - teams: string[]; + teams: string[] } & { [key: string]: unknown }) | string[] - ) & { [key: string]: unknown }; - }; - }; - }; + ) & { [key: string]: unknown } + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the people who have push access to this branch. */ - "repos/get-users-with-access-to-protected-branch": { + 'repos/get-users-with-access-to-protected-branch': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + 404: components['responses']['not_found'] + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28982,36 +28961,36 @@ export interface operations { * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - "repos/set-user-access-restrictions": { + 'repos/set-user-access-restrictions': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": ( + 'application/json': ( | ({ /** @description users parameter */ - users: string[]; + users: string[] } & { [key: string]: unknown }) | string[] - ) & { [key: string]: unknown }; - }; - }; - }; + ) & { [key: string]: unknown } + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -29021,36 +29000,36 @@ export interface operations { * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - "repos/add-user-access-restrictions": { + 'repos/add-user-access-restrictions': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": ( + 'application/json': ( | ({ /** @description users parameter */ - users: string[]; + users: string[] } & { [key: string]: unknown }) | string[] - ) & { [key: string]: unknown }; - }; - }; - }; + ) & { [key: string]: unknown } + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -29060,36 +29039,36 @@ export interface operations { * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - "repos/remove-user-access-restrictions": { + 'repos/remove-user-access-restrictions': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": ( + 'application/json': ( | ({ /** @description users parameter */ - users: string[]; + users: string[] } & { [key: string]: unknown }) | string[] - ) & { [key: string]: unknown }; - }; - }; - }; + ) & { [key: string]: unknown } + } + } + } /** * Renames a branch in a repository. * @@ -29107,35 +29086,35 @@ export interface operations { * * Users must have admin or owner permissions. * * GitHub Apps must have the `administration:write` repository permission. */ - "repos/rename-branch": { + 'repos/rename-branch': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["branch-with-protection"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['branch-with-protection'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The new name of the branch. */ - new_name: string; - } & { [key: string]: unknown }; - }; - }; - }; + new_name: string + } & { [key: string]: unknown } + } + } + } /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * @@ -29143,494 +29122,478 @@ export interface operations { * * In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. */ - "checks/create": { + 'checks/create': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["check-run"]; - }; - }; - }; + 'application/json': components['schemas']['check-run'] + } + } + } requestBody: { content: { - "application/json": ( + 'application/json': ( | ({ /** @enum {undefined} */ - status: "completed"; + status: 'completed' } & { - conclusion: unknown; + conclusion: unknown } & { [key: string]: unknown }) | ({ /** @enum {undefined} */ - status?: "queued" | "in_progress"; + status?: 'queued' | 'in_progress' } & { [key: string]: unknown }) ) & { /** @description The name of the check. For example, "code-coverage". */ - name: string; + name: string /** @description The SHA of the commit. */ - head_sha: string; + head_sha: string /** @description The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used. */ - details_url?: string; + details_url?: string /** @description A reference for the run on the integrator's system. */ - external_id?: string; + external_id?: string /** * @description The current status. Can be one of `queued`, `in_progress`, or `completed`. * @default queued * @enum {string} */ - status?: "queued" | "in_progress" | "completed"; + status?: 'queued' | 'in_progress' | 'completed' /** * Format: date-time * @description The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - started_at?: string; + started_at?: string /** * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. * @enum {string} */ - conclusion?: - | "action_required" - | "cancelled" - | "failure" - | "neutral" - | "success" - | "skipped" - | "stale" - | "timed_out"; + conclusion?: 'action_required' | 'cancelled' | 'failure' | 'neutral' | 'success' | 'skipped' | 'stale' | 'timed_out' /** * Format: date-time * @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - completed_at?: string; + completed_at?: string /** @description Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/rest/reference/checks#output-object) description. */ output?: { /** @description The title of the check run. */ - title: string; + title: string /** @description The summary of the check run. This parameter supports Markdown. */ - summary: string; + summary: string /** @description The details of the check run. This parameter supports Markdown. */ - text?: string; + text?: string /** @description Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". See the [`annotations` object](https://docs.github.com/rest/reference/checks#annotations-object) description for details about how to use this parameter. */ annotations?: ({ /** @description The path of the file to add an annotation to. For example, `assets/css/main.css`. */ - path: string; + path: string /** @description The start line of the annotation. */ - start_line: number; + start_line: number /** @description The end line of the annotation. */ - end_line: number; + end_line: number /** @description The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */ - start_column?: number; + start_column?: number /** @description The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */ - end_column?: number; + end_column?: number /** * @description The level of the annotation. Can be one of `notice`, `warning`, or `failure`. * @enum {string} */ - annotation_level: "notice" | "warning" | "failure"; + annotation_level: 'notice' | 'warning' | 'failure' /** @description A short description of the feedback for these lines of code. The maximum size is 64 KB. */ - message: string; + message: string /** @description The title that represents the annotation. The maximum size is 255 characters. */ - title?: string; + title?: string /** @description Details about this annotation. The maximum size is 64 KB. */ - raw_details?: string; - } & { [key: string]: unknown })[]; + raw_details?: string + } & { [key: string]: unknown })[] /** @description Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/rest/reference/checks#images-object) description for details. */ images?: ({ /** @description The alternative text for the image. */ - alt: string; + alt: string /** @description The full URL of the image. */ - image_url: string; + image_url: string /** @description A short image description. */ - caption?: string; - } & { [key: string]: unknown })[]; - } & { [key: string]: unknown }; + caption?: string + } & { [key: string]: unknown })[] + } & { [key: string]: unknown } /** @description Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions)." */ actions?: ({ /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ - label: string; + label: string /** @description A short explanation of what this action would do. The maximum size is 40 characters. */ - description: string; + description: string /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ - identifier: string; - } & { [key: string]: unknown })[]; - } & { [key: string]: unknown }; - }; - }; - }; + identifier: string + } & { [key: string]: unknown })[] + } & { [key: string]: unknown } + } + } + } /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * Gets a single check run using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. */ - "checks/get": { + 'checks/get': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** check_run_id parameter */ - check_run_id: components["parameters"]["check-run-id"]; - }; - }; + check_run_id: components['parameters']['check-run-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["check-run"]; - }; - }; - }; - }; + 'application/json': components['schemas']['check-run'] + } + } + } + } /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. */ - "checks/update": { + 'checks/update': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** check_run_id parameter */ - check_run_id: components["parameters"]["check-run-id"]; - }; - }; + check_run_id: components['parameters']['check-run-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["check-run"]; - }; - }; - }; + 'application/json': components['schemas']['check-run'] + } + } + } requestBody: { content: { - "application/json": (Partial< + 'application/json': (Partial< { /** @enum {undefined} */ - status?: "completed"; + status?: 'completed' } & { - conclusion: unknown; + conclusion: unknown } & { [key: string]: unknown } > & Partial< { /** @enum {undefined} */ - status?: "queued" | "in_progress"; + status?: 'queued' | 'in_progress' } & { [key: string]: unknown } >) & { /** @description The name of the check. For example, "code-coverage". */ - name?: string; + name?: string /** @description The URL of the integrator's site that has the full details of the check. */ - details_url?: string; + details_url?: string /** @description A reference for the run on the integrator's system. */ - external_id?: string; + external_id?: string /** * Format: date-time * @description This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - started_at?: string; + started_at?: string /** * @description The current status. Can be one of `queued`, `in_progress`, or `completed`. * @enum {string} */ - status?: "queued" | "in_progress" | "completed"; + status?: 'queued' | 'in_progress' | 'completed' /** * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. * @enum {string} */ - conclusion?: - | "action_required" - | "cancelled" - | "failure" - | "neutral" - | "success" - | "skipped" - | "stale" - | "timed_out"; + conclusion?: 'action_required' | 'cancelled' | 'failure' | 'neutral' | 'success' | 'skipped' | 'stale' | 'timed_out' /** * Format: date-time * @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - completed_at?: string; + completed_at?: string /** @description Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/rest/reference/checks#output-object-1) description. */ output?: { /** @description **Required**. */ - title?: string; + title?: string /** @description Can contain Markdown. */ - summary: string; + summary: string /** @description Can contain Markdown. */ - text?: string; + text?: string /** @description Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". See the [`annotations` object](https://docs.github.com/rest/reference/checks#annotations-object-1) description for details. */ annotations?: ({ /** @description The path of the file to add an annotation to. For example, `assets/css/main.css`. */ - path: string; + path: string /** @description The start line of the annotation. */ - start_line: number; + start_line: number /** @description The end line of the annotation. */ - end_line: number; + end_line: number /** @description The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */ - start_column?: number; + start_column?: number /** @description The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */ - end_column?: number; + end_column?: number /** * @description The level of the annotation. Can be one of `notice`, `warning`, or `failure`. * @enum {string} */ - annotation_level: "notice" | "warning" | "failure"; + annotation_level: 'notice' | 'warning' | 'failure' /** @description A short description of the feedback for these lines of code. The maximum size is 64 KB. */ - message: string; + message: string /** @description The title that represents the annotation. The maximum size is 255 characters. */ - title?: string; + title?: string /** @description Details about this annotation. The maximum size is 64 KB. */ - raw_details?: string; - } & { [key: string]: unknown })[]; + raw_details?: string + } & { [key: string]: unknown })[] /** @description Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/rest/reference/checks#annotations-object-1) description for details. */ images?: ({ /** @description The alternative text for the image. */ - alt: string; + alt: string /** @description The full URL of the image. */ - image_url: string; + image_url: string /** @description A short image description. */ - caption?: string; - } & { [key: string]: unknown })[]; - } & { [key: string]: unknown }; + caption?: string + } & { [key: string]: unknown })[] + } & { [key: string]: unknown } /** @description Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions)." */ actions?: ({ /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ - label: string; + label: string /** @description A short explanation of what this action would do. The maximum size is 40 characters. */ - description: string; + description: string /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ - identifier: string; - } & { [key: string]: unknown })[]; - } & { [key: string]: unknown }; - }; - }; - }; + identifier: string + } & { [key: string]: unknown })[] + } & { [key: string]: unknown } + } + } + } /** Lists annotations for a check run using the annotation `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the `repo` scope to get annotations for a check run in a private repository. */ - "checks/list-annotations": { + 'checks/list-annotations': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** check_run_id parameter */ - check_run_id: components["parameters"]["check-run-id"]; - }; + check_run_id: components['parameters']['check-run-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["check-annotation"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['check-annotation'][] + } + } + } + } /** * Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * * To rerequest a check run, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository. */ - "checks/rerequest-run": { + 'checks/rerequest-run': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** check_run_id parameter */ - check_run_id: components["parameters"]["check-run-id"]; - }; - }; + check_run_id: components['parameters']['check-run-id'] + } + } responses: { /** Response */ 201: { content: { - "application/json": { [key: string]: unknown }; - }; - }; + 'application/json': { [key: string]: unknown } + } + } /** Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App */ 403: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - 404: components["responses"]["not_found"]; + 'application/json': components['schemas']['basic-error'] + } + } + 404: components['responses']['not_found'] /** Validation error if the check run is not rerequestable */ 422: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } + } + } /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * * By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/reference/checks#check-runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/reference/checks#update-repository-preferences-for-check-suites)". Your GitHub App must have the `checks:write` permission to create check suites. */ - "checks/create-suite": { + 'checks/create-suite': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** when the suite already existed */ 200: { content: { - "application/json": components["schemas"]["check-suite"]; - }; - }; + 'application/json': components['schemas']['check-suite'] + } + } /** Response when the suite was created */ 201: { content: { - "application/json": components["schemas"]["check-suite"]; - }; - }; - }; + 'application/json': components['schemas']['check-suite'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The sha of the head commit. */ - head_sha: string; - } & { [key: string]: unknown }; - }; - }; - }; + head_sha: string + } & { [key: string]: unknown } + } + } + } /** Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/reference/checks#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites. */ - "checks/set-suites-preferences": { + 'checks/set-suites-preferences': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["check-suite-preference"]; - }; - }; - }; + 'application/json': components['schemas']['check-suite-preference'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/rest/reference/checks#auto_trigger_checks-object) description for details. */ auto_trigger_checks?: ({ /** @description The `id` of the GitHub App. */ - app_id: number; + app_id: number /** * @description Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them. * @default true */ - setting: boolean; - } & { [key: string]: unknown })[]; - } & { [key: string]: unknown }; - }; - }; - }; + setting: boolean + } & { [key: string]: unknown })[] + } & { [key: string]: unknown } + } + } + } /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * * Gets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository. */ - "checks/get-suite": { + 'checks/get-suite': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** check_suite_id parameter */ - check_suite_id: components["parameters"]["check-suite-id"]; - }; - }; + check_suite_id: components['parameters']['check-suite-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["check-suite"]; - }; - }; - }; - }; + 'application/json': components['schemas']['check-suite'] + } + } + } + } /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. */ - "checks/list-for-suite": { + 'checks/list-for-suite': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** check_suite_id parameter */ - check_suite_id: components["parameters"]["check-suite-id"]; - }; + check_suite_id: components['parameters']['check-suite-id'] + } query: { /** Returns check runs with the specified `name`. */ - check_name?: components["parameters"]["check-name"]; + check_name?: components['parameters']['check-name'] /** Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`. */ - status?: components["parameters"]["status"]; + status?: components['parameters']['status'] /** Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`. */ - filter?: "latest" | "all"; + filter?: 'latest' | 'all' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - check_runs: components["schemas"]["check-run"][]; - } & { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': { + total_count: number + check_runs: components['schemas']['check-run'][] + } & { [key: string]: unknown } + } + } + } + } /** * Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * * To rerequest a check suite, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository. */ - "checks/rerequest-suite": { + 'checks/rerequest-suite': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** check_suite_id parameter */ - check_suite_id: components["parameters"]["check-suite-id"]; - }; - }; + check_suite_id: components['parameters']['check-suite-id'] + } + } responses: { /** Response */ 201: { content: { - "application/json": { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': { [key: string]: unknown } + } + } + } + } /** * Lists all open code scanning alerts for the default branch (usually `main` * or `master`). You must use an access token with the `security_events` scope to use @@ -29643,137 +29606,137 @@ export interface operations { * for the default branch or for the specified Git reference * (if you used `ref` in the request). */ - "code-scanning/list-alerts-for-repo": { + 'code-scanning/list-alerts-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */ - tool_name?: components["parameters"]["tool-name"]; + tool_name?: components['parameters']['tool-name'] /** The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ - tool_guid?: components["parameters"]["tool-guid"]; + tool_guid?: components['parameters']['tool-guid'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ - ref?: components["parameters"]["git-ref"]; + ref?: components['parameters']['git-ref'] /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Can be one of `created`, `updated`, `number`. */ - sort?: "created" | "updated" | "number"; + sort?: 'created' | 'updated' | 'number' /** Set to `open`, `closed, `fixed`, or `dismissed` to list code scanning alerts in a specific state. */ - state?: components["schemas"]["code-scanning-alert-state"]; - }; - }; + state?: components['schemas']['code-scanning-alert-state'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["code-scanning-alert-items"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["code_scanning_forbidden_read"]; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': components['schemas']['code-scanning-alert-items'][] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['code_scanning_forbidden_read'] + 404: components['responses']['not_found'] + 503: components['responses']['service_unavailable'] + } + } /** * Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint. * * **Deprecation notice**: * The instances field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The same information can now be retrieved via a GET request to the URL specified by `instances_url`. */ - "code-scanning/get-alert": { + 'code-scanning/get-alert': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ - alert_number: components["parameters"]["alert-number"]; - }; - }; + alert_number: components['parameters']['alert-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["code-scanning-alert"]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["code_scanning_forbidden_read"]; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': components['schemas']['code-scanning-alert'] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['code_scanning_forbidden_read'] + 404: components['responses']['not_found'] + 503: components['responses']['service_unavailable'] + } + } /** Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. */ - "code-scanning/update-alert": { + 'code-scanning/update-alert': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ - alert_number: components["parameters"]["alert-number"]; - }; - }; + alert_number: components['parameters']['alert-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["code-scanning-alert"]; - }; - }; - 403: components["responses"]["code_scanning_forbidden_write"]; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; - }; + 'application/json': components['schemas']['code-scanning-alert'] + } + } + 403: components['responses']['code_scanning_forbidden_write'] + 404: components['responses']['not_found'] + 503: components['responses']['service_unavailable'] + } requestBody: { content: { - "application/json": { - state: components["schemas"]["code-scanning-alert-set-state"]; - dismissed_reason?: components["schemas"]["code-scanning-alert-dismissed-reason"]; - } & { [key: string]: unknown }; - }; - }; - }; + 'application/json': { + state: components['schemas']['code-scanning-alert-set-state'] + dismissed_reason?: components['schemas']['code-scanning-alert-dismissed-reason'] + } & { [key: string]: unknown } + } + } + } /** * Lists all instances of the specified code scanning alert. * You must use an access token with the `security_events` scope to use this endpoint with private repos, * the `public_repo` scope also grants permission to read security events on public repos only. * GitHub Apps must have the `security_events` read permission to use this endpoint. */ - "code-scanning/list-alert-instances": { + 'code-scanning/list-alert-instances': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ - alert_number: components["parameters"]["alert-number"]; - }; + alert_number: components['parameters']['alert-number'] + } query: { /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ - ref?: components["parameters"]["git-ref"]; - }; - }; + ref?: components['parameters']['git-ref'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["code-scanning-alert-instance"][]; - }; - }; - 403: components["responses"]["code_scanning_forbidden_read"]; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': components['schemas']['code-scanning-alert-instance'][] + } + } + 403: components['responses']['code_scanning_forbidden_read'] + 404: components['responses']['not_found'] + 503: components['responses']['service_unavailable'] + } + } /** * Lists the details of all code scanning analyses for a repository, * starting with the most recent. @@ -29793,39 +29756,39 @@ export interface operations { * **Deprecation notice**: * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. */ - "code-scanning/list-recent-analyses": { + 'code-scanning/list-recent-analyses': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */ - tool_name?: components["parameters"]["tool-name"]; + tool_name?: components['parameters']['tool-name'] /** The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ - tool_guid?: components["parameters"]["tool-guid"]; + tool_guid?: components['parameters']['tool-guid'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ - ref?: components["schemas"]["code-scanning-ref"]; + ref?: components['schemas']['code-scanning-ref'] /** Filter analyses belonging to the same SARIF upload. */ - sarif_id?: components["schemas"]["code-scanning-analysis-sarif-id"]; - }; - }; + sarif_id?: components['schemas']['code-scanning-analysis-sarif-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["code-scanning-analysis"][]; - }; - }; - 403: components["responses"]["code_scanning_forbidden_read"]; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': components['schemas']['code-scanning-analysis'][] + } + } + 403: components['responses']['code_scanning_forbidden_read'] + 404: components['responses']['not_found'] + 503: components['responses']['service_unavailable'] + } + } /** * Gets a specified code scanning analysis for a repository. * You must use an access token with the `security_events` scope to use this endpoint with private repos, @@ -29847,28 +29810,28 @@ export interface operations { * This is formatted as * [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). */ - "code-scanning/get-analysis": { + 'code-scanning/get-analysis': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation. */ - analysis_id: number; - }; - }; + analysis_id: number + } + } responses: { /** Response */ 200: { content: { - "application/json+sarif": string; - "application/json": components["schemas"]["code-scanning-analysis"]; - }; - }; - 403: components["responses"]["code_scanning_forbidden_read"]; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json+sarif': string + 'application/json': components['schemas']['code-scanning-analysis'] + } + } + 403: components['responses']['code_scanning_forbidden_read'] + 404: components['responses']['not_found'] + 503: components['responses']['service_unavailable'] + } + } /** * Deletes a specified code scanning analysis from a repository. For * private repositories, you must use an access token with the `repo` scope. For public repositories, @@ -29937,32 +29900,32 @@ export interface operations { * * The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely. */ - "code-scanning/delete-analysis": { + 'code-scanning/delete-analysis': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation. */ - analysis_id: number; - }; + analysis_id: number + } query: { /** Allow deletion if the specified analysis is the last in a set. If you attempt to delete the final analysis in a set without setting this parameter to `true`, you'll get a 400 response with the message: `Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.` */ - confirm_delete?: string | null; - }; - }; + confirm_delete?: string | null + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["code-scanning-analysis-deletion"]; - }; - }; - 400: components["responses"]["bad_request"]; - 403: components["responses"]["code_scanning_forbidden_write"]; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': components['schemas']['code-scanning-analysis-deletion'] + } + } + 400: components['responses']['bad_request'] + 403: components['responses']['code_scanning_forbidden_write'] + 404: components['responses']['not_found'] + 503: components['responses']['service_unavailable'] + } + } /** * Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. * @@ -29982,155 +29945,155 @@ export interface operations { * You can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint. * For more information, see "[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload)." */ - "code-scanning/upload-sarif": { + 'code-scanning/upload-sarif': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 202: { content: { - "application/json": components["schemas"]["code-scanning-sarifs-receipt"]; - }; - }; + 'application/json': components['schemas']['code-scanning-sarifs-receipt'] + } + } /** Bad Request if the sarif field is invalid */ - 400: unknown; - 403: components["responses"]["code_scanning_forbidden_write"]; - 404: components["responses"]["not_found"]; + 400: unknown + 403: components['responses']['code_scanning_forbidden_write'] + 404: components['responses']['not_found'] /** Payload Too Large if the sarif field is too large */ - 413: unknown; - 503: components["responses"]["service_unavailable"]; - }; + 413: unknown + 503: components['responses']['service_unavailable'] + } requestBody: { content: { - "application/json": { - commit_sha: components["schemas"]["code-scanning-analysis-commit-sha"]; - ref: components["schemas"]["code-scanning-ref"]; - sarif: components["schemas"]["code-scanning-analysis-sarif-file"]; + 'application/json': { + commit_sha: components['schemas']['code-scanning-analysis-commit-sha'] + ref: components['schemas']['code-scanning-ref'] + sarif: components['schemas']['code-scanning-analysis-sarif-file'] /** * Format: uri * @description The base directory used in the analysis, as it appears in the SARIF file. * This property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository. * @example file:///github/workspace/ */ - checkout_uri?: string; + checkout_uri?: string /** * Format: date-time * @description The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - started_at?: string; + started_at?: string /** @description The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to "API". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`. */ - tool_name?: string; - } & { [key: string]: unknown }; - }; - }; - }; + tool_name?: string + } & { [key: string]: unknown } + } + } + } /** Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository)." You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint. */ - "code-scanning/get-sarif": { + 'code-scanning/get-sarif': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The SARIF ID obtained after uploading. */ - sarif_id: string; - }; - }; + sarif_id: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["code-scanning-sarifs-status"]; - }; - }; - 403: components["responses"]["code_scanning_forbidden_read"]; + 'application/json': components['schemas']['code-scanning-sarifs-status'] + } + } + 403: components['responses']['code_scanning_forbidden_read'] /** Not Found if the sarif id does not match any upload */ - 404: unknown; - 503: components["responses"]["service_unavailable"]; - }; - }; + 404: unknown + 503: components['responses']['service_unavailable'] + } + } /** * Lists the codespaces associated to a specified repository and the authenticated user. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/list-in-repository-for-authenticated-user": { + 'codespaces/list-in-repository-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; + page?: components['parameters']['page'] + } path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - codespaces: components["schemas"]["codespace"][]; - } & { [key: string]: unknown }; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': { + total_count: number + codespaces: components['schemas']['codespace'][] + } & { [key: string]: unknown } + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** * Creates a codespace owned by the authenticated user in the specified repository. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/create-with-repo-for-authenticated-user": { + 'codespaces/create-with-repo-for-authenticated-user': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response when the codespace was successfully created */ 201: { content: { - "application/json": components["schemas"]["codespace"]; - }; - }; + 'application/json': components['schemas']['codespace'] + } + } /** Response when the codespace creation partially failed but is being retried in the background */ 202: { content: { - "application/json": components["schemas"]["codespace"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; + 'application/json': components['schemas']['codespace'] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Git ref (typically a branch name) for this codespace */ - ref?: string; + ref?: string /** @description Location for this codespace */ - location: string; + location: string /** @description Machine type to use for this codespace */ - machine?: string; + machine?: string /** @description Working directory for this codespace */ - working_directory?: string; + working_directory?: string /** @description Time in minutes before codespace stops from inactivity */ - idle_timeout_minutes?: number; - } & { [key: string]: unknown }; - }; - }; - }; + idle_timeout_minutes?: number + } & { [key: string]: unknown } + } + } + } /** * List the machine types available for a given repository based on its configuration. * @@ -30138,34 +30101,34 @@ export interface operations { * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/repo-machines-for-authenticated-user": { + 'codespaces/repo-machines-for-authenticated-user': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Required. The location to check for available machines. */ - location: string; - }; - }; + location: string + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - machines: components["schemas"]["codespace-machine"][]; - } & { [key: string]: unknown }; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': { + total_count: number + machines: components['schemas']['codespace-machine'][] + } & { [key: string]: unknown } + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** * For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. * @@ -30175,12 +30138,12 @@ export interface operations { * endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this * endpoint. */ - "repos/list-collaborators": { + 'repos/list-collaborators': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** * Filter collaborators returned by their affiliation. Can be one of: @@ -30188,24 +30151,24 @@ export interface operations { * \* `direct`: All collaborators with permissions to an organization-owned repository, regardless of organization membership status. * \* `all`: All collaborators the authenticated user can see. */ - affiliation?: "outside" | "direct" | "all"; + affiliation?: 'outside' | 'direct' | 'all' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["collaborator"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['collaborator'][] + } + } + 404: components['responses']['not_found'] + } + } /** * For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. * @@ -30215,21 +30178,21 @@ export interface operations { * endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this * endpoint. */ - "repos/check-collaborator": { + 'repos/check-collaborator': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - username: components["parameters"]["username"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + username: components['parameters']['username'] + } + } responses: { /** Response if user is a collaborator */ - 204: never; + 204: never /** Not Found if user is not a collaborator */ - 404: unknown; - }; - }; + 404: unknown + } + } /** * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. * @@ -30247,29 +30210,29 @@ export interface operations { * * You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository. */ - "repos/add-collaborator": { + 'repos/add-collaborator': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - username: components["parameters"]["username"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + username: components['parameters']['username'] + } + } responses: { /** Response when a new invitation is created */ 201: { content: { - "application/json": components["schemas"]["repository-invitation"]; - }; - }; + 'application/json': components['schemas']['repository-invitation'] + } + } /** Response when person is already a collaborator */ - 204: never; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + 204: never + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: * \* `pull` - can pull, but not push to or administer this repository. @@ -30281,221 +30244,221 @@ export interface operations { * @default push * @enum {string} */ - permission?: "pull" | "push" | "admin" | "maintain" | "triage"; + permission?: 'pull' | 'push' | 'admin' | 'maintain' | 'triage' /** @example "push" */ - permissions?: string; - } & { [key: string]: unknown }; - }; - }; - }; - "repos/remove-collaborator": { + permissions?: string + } & { [key: string]: unknown } + } + } + } + 'repos/remove-collaborator': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - username: components["parameters"]["username"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** Checks the repository permission of a collaborator. The possible repository permissions are `admin`, `write`, `read`, and `none`. */ - "repos/get-collaborator-permission-level": { + 'repos/get-collaborator-permission-level': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - username: components["parameters"]["username"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + username: components['parameters']['username'] + } + } responses: { /** if user has admin permissions */ 200: { content: { - "application/json": components["schemas"]["repository-collaborator-permission"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['repository-collaborator-permission'] + } + } + 404: components['responses']['not_found'] + } + } /** * Commit Comments use [these custom media types](https://docs.github.com/rest/reference/repos#custom-media-types). You can read more about the use of media types in the API [here](https://docs.github.com/rest/overview/media-types/). * * Comments are ordered by ascending ID. */ - "repos/list-commit-comments-for-repo": { + 'repos/list-commit-comments-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["commit-comment"][]; - }; - }; - }; - }; - "repos/get-commit-comment": { + 'application/json': components['schemas']['commit-comment'][] + } + } + } + } + 'repos/get-commit-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["commit-comment"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "repos/delete-commit-comment": { + 'application/json': components['schemas']['commit-comment'] + } + } + 404: components['responses']['not_found'] + } + } + 'repos/delete-commit-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; - "repos/update-commit-comment": { + 204: never + 404: components['responses']['not_found'] + } + } + 'repos/update-commit-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["commit-comment"]; - }; - }; - 404: components["responses"]["not_found"]; - }; + 'application/json': components['schemas']['commit-comment'] + } + } + 404: components['responses']['not_found'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The contents of the comment */ - body: string; - } & { [key: string]: unknown }; - }; - }; - }; + body: string + } & { [key: string]: unknown } + } + } + } /** List the reactions to a [commit comment](https://docs.github.com/rest/reference/repos#comments). */ - "reactions/list-for-commit-comment": { + 'reactions/list-for-commit-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; + comment_id: components['parameters']['comment-id'] + } query: { /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a commit comment. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content?: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["reaction"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['reaction'][] + } + } + 404: components['responses']['not_found'] + } + } /** Create a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. */ - "reactions/create-for-commit-comment": { + 'reactions/create-for-commit-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Reaction exists */ 200: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; + 'application/json': components['schemas']['reaction'] + } + } /** Reaction created */ 201: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - 415: components["responses"]["preview_header_missing"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['reaction'] + } + } + 415: components['responses']['preview_header_missing'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the commit comment. * @enum {string} */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - } & { [key: string]: unknown }; - }; - }; - }; + content: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' + } & { [key: string]: unknown } + } + } + } /** * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. * * Delete a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). */ - "reactions/delete-for-commit-comment": { + 'reactions/delete-for-commit-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - reaction_id: components["parameters"]["reaction-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + reaction_id: components['parameters']['reaction-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * **Signature verification object** * @@ -30526,161 +30489,161 @@ export interface operations { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - "repos/list-commits": { + 'repos/list-commits': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** SHA or branch to start listing commits from. Default: the repository’s default branch (usually `master`). */ - sha?: string; + sha?: string /** Only commits containing this file path will be returned. */ - path?: string; + path?: string /** GitHub login or email address by which to filter by commit author. */ - author?: string; + author?: string /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - until?: string; + until?: string /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["commit"][]; - }; - }; - 400: components["responses"]["bad_request"]; - 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': components['schemas']['commit'][] + } + } + 400: components['responses']['bad_request'] + 404: components['responses']['not_found'] + 409: components['responses']['conflict'] + 500: components['responses']['internal_error'] + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. */ - "repos/list-branches-for-head-commit": { + 'repos/list-branches-for-head-commit': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** commit_sha parameter */ - commit_sha: components["parameters"]["commit-sha"]; - }; - }; + commit_sha: components['parameters']['commit-sha'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["branch-short"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['branch-short'][] + } + } + 422: components['responses']['validation_failed'] + } + } /** Use the `:commit_sha` to specify the commit that will have its comments listed. */ - "repos/list-comments-for-commit": { + 'repos/list-comments-for-commit': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** commit_sha parameter */ - commit_sha: components["parameters"]["commit-sha"]; - }; + commit_sha: components['parameters']['commit-sha'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["commit-comment"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['commit-comment'][] + } + } + } + } /** * Create a comment for a commit using its `:commit_sha`. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - "repos/create-commit-comment": { + 'repos/create-commit-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** commit_sha parameter */ - commit_sha: components["parameters"]["commit-sha"]; - }; - }; + commit_sha: components['parameters']['commit-sha'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["commit-comment"]; - }; - }; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['commit-comment'] + } + } + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The contents of the comment. */ - body: string; + body: string /** @description Relative path of the file to comment on. */ - path?: string; + path?: string /** @description Line index in the diff to comment on. */ - position?: number; + position?: number /** @description **Deprecated**. Use **position** parameter instead. Line number in the file to comment on. */ - line?: number; - } & { [key: string]: unknown }; - }; - }; - }; + line?: number + } & { [key: string]: unknown } + } + } + } /** Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the [List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests) endpoint. */ - "repos/list-pull-requests-associated-with-commit": { + 'repos/list-pull-requests-associated-with-commit': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** commit_sha parameter */ - commit_sha: components["parameters"]["commit-sha"]; - }; + commit_sha: components['parameters']['commit-sha'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["pull-request-simple"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['pull-request-simple'][] + } + } + } + } /** * Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. * @@ -30719,110 +30682,110 @@ export interface operations { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - "repos/get-commit": { + 'repos/get-commit': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** ref parameter */ - ref: string; - }; + ref: string + } query: { /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["commit"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': components['schemas']['commit'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + 500: components['responses']['internal_error'] + } + } /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. */ - "checks/list-for-ref": { + 'checks/list-for-ref': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** ref parameter */ - ref: string; - }; + ref: string + } query: { /** Returns check runs with the specified `name`. */ - check_name?: components["parameters"]["check-name"]; + check_name?: components['parameters']['check-name'] /** Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`. */ - status?: components["parameters"]["status"]; + status?: components['parameters']['status'] /** Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`. */ - filter?: "latest" | "all"; + filter?: 'latest' | 'all' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - app_id?: number; - }; - }; + page?: components['parameters']['page'] + app_id?: number + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - check_runs: components["schemas"]["check-run"][]; - } & { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': { + total_count: number + check_runs: components['schemas']['check-run'][] + } & { [key: string]: unknown } + } + } + } + } /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * * Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository. */ - "checks/list-suites-for-ref": { + 'checks/list-suites-for-ref': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** ref parameter */ - ref: string; - }; + ref: string + } query: { /** Filters check suites by GitHub App `id`. */ - app_id?: number; + app_id?: number /** Returns check runs with the specified `name`. */ - check_name?: components["parameters"]["check-name"]; + check_name?: components['parameters']['check-name'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - check_suites: components["schemas"]["check-suite"][]; - } & { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': { + total_count: number + check_suites: components['schemas']['check-suite'][] + } & { [key: string]: unknown } + } + } + } + } /** * Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. * @@ -30833,62 +30796,62 @@ export interface operations { * * **pending** if there are no statuses or a context is `pending` * * **success** if the latest status for all contexts is `success` */ - "repos/get-combined-status-for-ref": { + 'repos/get-combined-status-for-ref': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** ref parameter */ - ref: string; - }; + ref: string + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["combined-commit-status"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['combined-commit-status'] + } + } + 404: components['responses']['not_found'] + } + } /** * Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one. * * This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`. */ - "repos/list-commit-statuses-for-ref": { + 'repos/list-commit-statuses-for-ref': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** ref parameter */ - ref: string; - }; + ref: string + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["status"][]; - }; - }; - 301: components["responses"]["moved_permanently"]; - }; - }; + 'application/json': components['schemas']['status'][] + } + } + 301: components['responses']['moved_permanently'] + } + } /** * This endpoint will return all community profile metrics, including an * overall health score, repository description, the presence of documentation, detected @@ -30903,22 +30866,22 @@ export interface operations { * * `content_reports_enabled` is only returned for organization-owned repositories. */ - "repos/get-community-profile-metrics": { + 'repos/get-community-profile-metrics': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["community-profile"]; - }; - }; - }; - }; + 'application/json': components['schemas']['community-profile'] + } + } + } + } /** * The `basehead` param is comprised of two parts: `base` and `head`. Both must be branch names in `repo`. To compare branches across other repositories in the same network as `repo`, use the format `:branch`. * @@ -30961,32 +30924,32 @@ export interface operations { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - "repos/compare-commits": { + 'repos/compare-commits': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The base branch and head branch to compare. This parameter expects the format `{base}...{head}`. */ - basehead: string; - }; + basehead: string + } query: { /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["commit-comparison"]; - }; - }; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': components['schemas']['commit-comparison'] + } + } + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** * Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit * `:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. @@ -31021,97 +30984,97 @@ export interface operations { * If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the * github.com URLs (`html_url` and `_links["html"]`) will have null values. */ - "repos/get-content": { + 'repos/get-content': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** path parameter */ - path: string; - }; + path: string + } query: { /** The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`) */ - ref?: string; - }; - }; - responses: { - /** Response */ - 200: { - content: { - "application/vnd.github.v3.object": components["schemas"]["content-tree"]; - "application/json": ( - | components["schemas"]["content-directory"] - | components["schemas"]["content-file"] - | components["schemas"]["content-symlink"] - | components["schemas"]["content-submodule"] - ) & { [key: string]: unknown }; - }; - }; - 302: components["responses"]["found"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + ref?: string + } + } + responses: { + /** Response */ + 200: { + content: { + 'application/vnd.github.v3.object': components['schemas']['content-tree'] + 'application/json': ( + | components['schemas']['content-directory'] + | components['schemas']['content-file'] + | components['schemas']['content-symlink'] + | components['schemas']['content-submodule'] + ) & { [key: string]: unknown } + } + } + 302: components['responses']['found'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Creates a new file or replaces an existing file in a repository. */ - "repos/create-or-update-file-contents": { + 'repos/create-or-update-file-contents': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** path parameter */ - path: string; - }; - }; + path: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["file-commit"]; - }; - }; + 'application/json': components['schemas']['file-commit'] + } + } /** Response */ 201: { content: { - "application/json": components["schemas"]["file-commit"]; - }; - }; - 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['file-commit'] + } + } + 404: components['responses']['not_found'] + 409: components['responses']['conflict'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The commit message. */ - message: string; + message: string /** @description The new file content, using Base64 encoding. */ - content: string; + content: string /** @description **Required if you are updating a file**. The blob SHA of the file being replaced. */ - sha?: string; + sha?: string /** @description The branch name. Default: the repository’s default branch (usually `master`) */ - branch?: string; + branch?: string /** @description The person that committed the file. Default: the authenticated user. */ committer?: { /** @description The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted. */ - name: string; + name: string /** @description The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted. */ - email: string; + email: string /** @example "2013-01-05T13:13:22+05:00" */ - date?: string; - } & { [key: string]: unknown }; + date?: string + } & { [key: string]: unknown } /** @description The author of the file. Default: The `committer` or the authenticated user if you omit `committer`. */ author?: { /** @description The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted. */ - name: string; + name: string /** @description The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted. */ - email: string; + email: string /** @example "2013-01-15T17:13:22+05:00" */ - date?: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; - }; - }; - }; + date?: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } + } + } + } /** * Deletes a file in a repository. * @@ -31121,151 +31084,151 @@ export interface operations { * * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. */ - "repos/delete-file": { + 'repos/delete-file': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** path parameter */ - path: string; - }; - }; + path: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["file-commit"]; - }; - }; - 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; - 422: components["responses"]["validation_failed"]; - 503: components["responses"]["service_unavailable"]; - }; + 'application/json': components['schemas']['file-commit'] + } + } + 404: components['responses']['not_found'] + 409: components['responses']['conflict'] + 422: components['responses']['validation_failed'] + 503: components['responses']['service_unavailable'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The commit message. */ - message: string; + message: string /** @description The blob SHA of the file being replaced. */ - sha: string; + sha: string /** @description The branch name. Default: the repository’s default branch (usually `master`) */ - branch?: string; + branch?: string /** @description object containing information about the committer. */ committer?: { /** @description The name of the author (or committer) of the commit */ - name?: string; + name?: string /** @description The email of the author (or committer) of the commit */ - email?: string; - } & { [key: string]: unknown }; + email?: string + } & { [key: string]: unknown } /** @description object containing information about the author. */ author?: { /** @description The name of the author (or committer) of the commit */ - name?: string; + name?: string /** @description The email of the author (or committer) of the commit */ - email?: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; - }; - }; - }; + email?: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } + } + } + } /** * Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance. * * GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information. */ - "repos/list-contributors": { + 'repos/list-contributors': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Set to `1` or `true` to include anonymous contributors in results. */ - anon?: string; + anon?: string /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** if repository contains content */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["contributor"][]; - }; - }; + 'application/json': components['schemas']['contributor'][] + } + } /** Response if repository is empty */ - 204: never; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */ - "dependabot/list-repo-secrets": { + 'dependabot/list-repo-secrets': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - secrets: components["schemas"]["dependabot-secret"][]; - } & { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': { + total_count: number + secrets: components['schemas']['dependabot-secret'][] + } & { [key: string]: unknown } + } + } + } + } /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */ - "dependabot/get-repo-public-key": { + 'dependabot/get-repo-public-key': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["dependabot-public-key"]; - }; - }; - }; - }; + 'application/json': components['schemas']['dependabot-public-key'] + } + } + } + } /** Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */ - "dependabot/get-repo-secret": { + 'dependabot/get-repo-secret': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["dependabot-secret"]; - }; - }; - }; - }; + 'application/json': components['schemas']['dependabot-secret'] + } + } + } + } /** * Creates or updates a repository secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -31343,83 +31306,83 @@ export interface operations { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - "dependabot/create-or-update-repo-secret": { + 'dependabot/create-or-update-repo-secret': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response when creating a secret */ 201: { content: { - "application/json": { [key: string]: unknown }; - }; - }; + 'application/json': { [key: string]: unknown } + } + } /** Response when updating a secret */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/reference/dependabot#get-a-repository-public-key) endpoint. */ - encrypted_value?: string; + encrypted_value?: string /** @description ID of the key you used to encrypt the secret. */ - key_id?: string; - } & { [key: string]: unknown }; - }; - }; - }; + key_id?: string + } & { [key: string]: unknown } + } + } + } /** Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */ - "dependabot/delete-repo-secret": { + 'dependabot/delete-repo-secret': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** Simple filtering of deployments is available via query parameters: */ - "repos/list-deployments": { + 'repos/list-deployments': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** The SHA recorded at creation time. */ - sha?: string; + sha?: string /** The name of the ref. This can be a branch, tag, or SHA. */ - ref?: string; + ref?: string /** The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`). */ - task?: string; + task?: string /** The name of the environment that was deployed to (e.g., `staging` or `production`). */ - environment?: string | null; + environment?: string | null /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["deployment"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['deployment'][] + } + } + } + } /** * Deployments offer a few configurable parameters with certain defaults. * @@ -31467,84 +31430,84 @@ export interface operations { * This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` * status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. */ - "repos/create-deployment": { + 'repos/create-deployment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["deployment"]; - }; - }; + 'application/json': components['schemas']['deployment'] + } + } /** Merged branch response */ 202: { content: { - "application/json": { - message?: string; - } & { [key: string]: unknown }; - }; - }; + 'application/json': { + message?: string + } & { [key: string]: unknown } + } + } /** Conflict when there is a merge conflict or the commit's status checks failed */ - 409: unknown; - 422: components["responses"]["validation_failed"]; - }; + 409: unknown + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The ref to deploy. This can be a branch, tag, or SHA. */ - ref: string; + ref: string /** * @description Specifies a task to execute (e.g., `deploy` or `deploy:migrations`). * @default deploy */ - task?: string; + task?: string /** * @description Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch. * @default true */ - auto_merge?: boolean; + auto_merge?: boolean /** @description The [status](https://docs.github.com/rest/reference/commits#commit-statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts. */ - required_contexts?: string[]; - payload?: ({ [key: string]: unknown } | string) & { [key: string]: unknown }; + required_contexts?: string[] + payload?: ({ [key: string]: unknown } | string) & { [key: string]: unknown } /** * @description Name for the target deployment environment (e.g., `production`, `staging`, `qa`). * @default production */ - environment?: string; + environment?: string /** @description Short description of the deployment. */ - description?: string | null; + description?: string | null /** @description Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false` */ - transient_environment?: boolean; + transient_environment?: boolean /** @description Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise. */ - production_environment?: boolean; - } & { [key: string]: unknown }; - }; - }; - }; - "repos/get-deployment": { + production_environment?: boolean + } & { [key: string]: unknown } + } + } + } + 'repos/get-deployment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** deployment_id parameter */ - deployment_id: components["parameters"]["deployment-id"]; - }; - }; + deployment_id: components['parameters']['deployment-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["deployment"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['deployment'] + } + } + 404: components['responses']['not_found'] + } + } /** * If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. Anyone with `repo` or `repo_deployment` scopes can delete a deployment. * @@ -31555,123 +31518,123 @@ export interface operations { * * For more information, see "[Create a deployment](https://docs.github.com/rest/reference/repos/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/reference/repos#create-a-deployment-status)." */ - "repos/delete-deployment": { + 'repos/delete-deployment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** deployment_id parameter */ - deployment_id: components["parameters"]["deployment-id"]; - }; - }; + deployment_id: components['parameters']['deployment-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } + } /** Users with pull access can view deployment statuses for a deployment: */ - "repos/list-deployment-statuses": { + 'repos/list-deployment-statuses': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** deployment_id parameter */ - deployment_id: components["parameters"]["deployment-id"]; - }; + deployment_id: components['parameters']['deployment-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["deployment-status"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['deployment-status'][] + } + } + 404: components['responses']['not_found'] + } + } /** * Users with `push` access can create deployment statuses for a given deployment. * * GitHub Apps require `read & write` access to "Deployments" and `read-only` access to "Repo contents" (for private repos). OAuth Apps require the `repo_deployment` scope. */ - "repos/create-deployment-status": { + 'repos/create-deployment-status': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** deployment_id parameter */ - deployment_id: components["parameters"]["deployment-id"]; - }; - }; + deployment_id: components['parameters']['deployment-id'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["deployment-status"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['deployment-status'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued`, `pending`, or `success`. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub. * @enum {string} */ - state: "error" | "failure" | "inactive" | "in_progress" | "queued" | "pending" | "success"; + state: 'error' | 'failure' | 'inactive' | 'in_progress' | 'queued' | 'pending' | 'success' /** @description The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`. */ - target_url?: string; + target_url?: string /** @description The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `""` */ - log_url?: string; + log_url?: string /** @description A short description of the status. The maximum description length is 140 characters. */ - description?: string; + description?: string /** * @description Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. * @enum {string} */ - environment?: "production" | "staging" | "qa"; + environment?: 'production' | 'staging' | 'qa' /** @description Sets the URL for accessing your environment. Default: `""` */ - environment_url?: string; + environment_url?: string /** @description Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true` */ - auto_inactive?: boolean; - } & { [key: string]: unknown }; - }; - }; - }; + auto_inactive?: boolean + } & { [key: string]: unknown } + } + } + } /** Users with pull access can view a deployment status for a deployment: */ - "repos/get-deployment-status": { + 'repos/get-deployment-status': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** deployment_id parameter */ - deployment_id: components["parameters"]["deployment-id"]; - status_id: number; - }; - }; + deployment_id: components['parameters']['deployment-id'] + status_id: number + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["deployment-status"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['deployment-status'] + } + } + 404: components['responses']['not_found'] + } + } /** * You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/webhooks/event-payloads/#repository_dispatch)." * @@ -31684,76 +31647,76 @@ export interface operations { * * This input example shows how you can use the `client_payload` as a test to debug your workflow. */ - "repos/create-dispatch-event": { + 'repos/create-dispatch-event': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - 422: components["responses"]["validation_failed"]; - }; + 204: never + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description A custom webhook event name. */ - event_type: string; + event_type: string /** @description JSON payload with extra information about the webhook event that your action or worklow may use. */ - client_payload?: { [key: string]: unknown }; - } & { [key: string]: unknown }; - }; - }; - }; + client_payload?: { [key: string]: unknown } + } & { [key: string]: unknown } + } + } + } /** * Get all environments for a repository. * * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "repos/get-all-environments": { + 'repos/get-all-environments': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { + 'application/json': { /** * @description The number of environments in this repository * @example 5 */ - total_count?: number; - environments?: components["schemas"]["environment"][]; - } & { [key: string]: unknown }; - }; - }; - }; - }; + total_count?: number + environments?: components['schemas']['environment'][] + } & { [key: string]: unknown } + } + } + } + } /** Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "repos/get-environment": { + 'repos/get-environment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the environment */ - environment_name: components["parameters"]["environment-name"]; - }; - }; + environment_name: components['parameters']['environment-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["environment"]; - }; - }; - }; - }; + 'application/json': components['schemas']['environment'] + } + } + } + } /** * Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)." * @@ -31763,208 +31726,208 @@ export interface operations { * * You must authenticate using an access token with the repo scope to use this endpoint. */ - "repos/create-or-update-environment": { + 'repos/create-or-update-environment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the environment */ - environment_name: components["parameters"]["environment-name"]; - }; - }; + environment_name: components['parameters']['environment-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["environment"]; - }; - }; + 'application/json': components['schemas']['environment'] + } + } /** Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` are set to the same value */ 422: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } + } requestBody: { content: { - "application/json": { - wait_timer?: components["schemas"]["wait-timer"]; + 'application/json': { + wait_timer?: components['schemas']['wait-timer'] /** @description The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */ reviewers?: | ({ - type?: components["schemas"]["deployment-reviewer-type"]; + type?: components['schemas']['deployment-reviewer-type'] /** * @description The id of the user or team who can review the deployment * @example 4532992 */ - id?: number; + id?: number } & { [key: string]: unknown })[] - | null; - deployment_branch_policy?: components["schemas"]["deployment_branch_policy"]; - } | null; - }; - }; - }; + | null + deployment_branch_policy?: components['schemas']['deployment_branch_policy'] + } | null + } + } + } /** You must authenticate using an access token with the repo scope to use this endpoint. */ - "repos/delete-an-environment": { + 'repos/delete-an-environment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the environment */ - environment_name: components["parameters"]["environment-name"]; - }; - }; + environment_name: components['parameters']['environment-name'] + } + } responses: { /** Default response */ - 204: never; - }; - }; - "activity/list-repo-events": { + 204: never + } + } + 'activity/list-repo-events': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["event"][]; - }; - }; - }; - }; - "repos/list-forks": { + 'application/json': components['schemas']['event'][] + } + } + } + } + 'repos/list-forks': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** The sort order. Can be either `newest`, `oldest`, or `stargazers`. */ - sort?: "newest" | "oldest" | "stargazers" | "watchers"; + sort?: 'newest' | 'oldest' | 'stargazers' | 'watchers' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["minimal-repository"][]; - }; - }; - 400: components["responses"]["bad_request"]; - }; - }; + 'application/json': components['schemas']['minimal-repository'][] + } + } + 400: components['responses']['bad_request'] + } + } /** * Create a fork for the authenticated user. * * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). */ - "repos/create-fork": { + 'repos/create-fork': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 202: { content: { - "application/json": components["schemas"]["full-repository"]; - }; - }; - 400: components["responses"]["bad_request"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['full-repository'] + } + } + 400: components['responses']['bad_request'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | ({ /** @description Optional parameter to specify the organization name if forking into an organization. */ - organization?: string; + organization?: string } & { [key: string]: unknown }) - | null; - }; - }; - }; - "git/create-blob": { + | null + } + } + } + 'git/create-blob': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["short-blob"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['short-blob'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 409: components['responses']['conflict'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The new blob's content. */ - content: string; + content: string /** * @description The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. * @default utf-8 */ - encoding?: string; - } & { [key: string]: unknown }; - }; - }; - }; + encoding?: string + } & { [key: string]: unknown } + } + } + } /** * The `content` in the response will always be Base64 encoded. * * _Note_: This API supports blobs up to 100 megabytes in size. */ - "git/get-blob": { + 'git/get-blob': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - file_sha: string; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + file_sha: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["blob"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['blob'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** * Creates a new Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects). * @@ -31997,65 +31960,65 @@ export interface operations { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - "git/create-commit": { + 'git/create-commit': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["git-commit"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['git-commit'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The commit message */ - message: string; + message: string /** @description The SHA of the tree object this commit points to */ - tree: string; + tree: string /** @description The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. */ - parents?: string[]; + parents?: string[] /** @description Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details. */ author?: { /** @description The name of the author (or committer) of the commit */ - name: string; + name: string /** @description The email of the author (or committer) of the commit */ - email: string; + email: string /** * Format: date-time * @description Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - date?: string; - } & { [key: string]: unknown }; + date?: string + } & { [key: string]: unknown } /** @description Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details. */ committer?: { /** @description The name of the author (or committer) of the commit */ - name?: string; + name?: string /** @description The email of the author (or committer) of the commit */ - email?: string; + email?: string /** * Format: date-time * @description Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - date?: string; - } & { [key: string]: unknown }; + date?: string + } & { [key: string]: unknown } /** @description The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits. */ - signature?: string; - } & { [key: string]: unknown }; - }; - }; - }; + signature?: string + } & { [key: string]: unknown } + } + } + } /** * Gets a Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects). * @@ -32088,25 +32051,25 @@ export interface operations { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - "git/get-commit": { + 'git/get-commit': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** commit_sha parameter */ - commit_sha: components["parameters"]["commit-sha"]; - }; - }; + commit_sha: components['parameters']['commit-sha'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["git-commit"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['git-commit'] + } + } + 404: components['responses']['not_found'] + } + } /** * Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array. * @@ -32116,132 +32079,132 @@ export interface operations { * * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. */ - "git/list-matching-refs": { + 'git/list-matching-refs': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** ref parameter */ - ref: string; - }; + ref: string + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["git-ref"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['git-ref'][] + } + } + } + } /** * Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. * * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". */ - "git/get-ref": { + 'git/get-ref': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** ref parameter */ - ref: string; - }; - }; + ref: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["git-ref"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['git-ref'] + } + } + 404: components['responses']['not_found'] + } + } /** Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches. */ - "git/create-ref": { + 'git/create-ref': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["git-ref"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['git-ref'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected. */ - ref: string; + ref: string /** @description The SHA1 value for this reference. */ - sha: string; + sha: string /** @example "refs/heads/newbranch" */ - key?: string; - } & { [key: string]: unknown }; - }; - }; - }; - "git/delete-ref": { + key?: string + } & { [key: string]: unknown } + } + } + } + 'git/delete-ref': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** ref parameter */ - ref: string; - }; - }; + ref: string + } + } responses: { /** Response */ - 204: never; - 422: components["responses"]["validation_failed"]; - }; - }; - "git/update-ref": { + 204: never + 422: components['responses']['validation_failed'] + } + } + 'git/update-ref': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** ref parameter */ - ref: string; - }; - }; + ref: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["git-ref"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['git-ref'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The SHA1 value to set this reference to */ - sha: string; + sha: string /** @description Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work. */ - force?: boolean; - } & { [key: string]: unknown }; - }; - }; - }; + force?: boolean + } & { [key: string]: unknown } + } + } + } /** * Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/rest/reference/git#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/rest/reference/git#create-a-reference) the tag reference - this call would be unnecessary. * @@ -32274,55 +32237,55 @@ export interface operations { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - "git/create-tag": { + 'git/create-tag': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["git-tag"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['git-tag'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The tag's name. This is typically a version (e.g., "v0.0.1"). */ - tag: string; + tag: string /** @description The tag message. */ - message: string; + message: string /** @description The SHA of the git object this is tagging. */ - object: string; + object: string /** * @description The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`. * @enum {string} */ - type: "commit" | "tree" | "blob"; + type: 'commit' | 'tree' | 'blob' /** @description An object with information about the individual creating the tag. */ tagger?: { /** @description The name of the author of the tag */ - name: string; + name: string /** @description The email of the author of the tag */ - email: string; + email: string /** * Format: date-time * @description When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - date?: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; - }; - }; - }; + date?: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } + } + } + } /** * **Signature verification object** * @@ -32353,431 +32316,431 @@ export interface operations { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - "git/get-tag": { + 'git/get-tag': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - tag_sha: string; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + tag_sha: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["git-tag"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['git-tag'] + } + } + 404: components['responses']['not_found'] + } + } /** * The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure. * * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/rest/reference/git#create-a-commit)" and "[Update a reference](https://docs.github.com/rest/reference/git#update-a-reference)." */ - "git/create-tree": { + 'git/create-tree': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["git-tree"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['git-tree'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure. */ tree: ({ /** @description The file referenced in the tree. */ - path?: string; + path?: string /** * @description The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink. * @enum {string} */ - mode?: "100644" | "100755" | "040000" | "160000" | "120000"; + mode?: '100644' | '100755' | '040000' | '160000' | '120000' /** * @description Either `blob`, `tree`, or `commit`. * @enum {string} */ - type?: "blob" | "tree" | "commit"; + type?: 'blob' | 'tree' | 'commit' /** * @description The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. * * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. */ - sha?: string | null; + sha?: string | null /** * @description The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. * * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. */ - content?: string; - } & { [key: string]: unknown })[]; + content?: string + } & { [key: string]: unknown })[] /** * @description The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on. * If not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit. */ - base_tree?: string; - } & { [key: string]: unknown }; - }; - }; - }; + base_tree?: string + } & { [key: string]: unknown } + } + } + } /** * Returns a single tree using the SHA1 value for that tree. * * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. */ - "git/get-tree": { + 'git/get-tree': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - tree_sha: string; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + tree_sha: string + } query: { /** Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` to any of the following will enable returning objects or subtrees: `0`, `1`, `"true"`, and `"false"`. Omit this parameter to prevent recursively returning objects or subtrees. */ - recursive?: string; - }; - }; + recursive?: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["git-tree"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "repos/list-webhooks": { + 'application/json': components['schemas']['git-tree'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } + 'repos/list-webhooks': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["hook"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['hook'][] + } + } + 404: components['responses']['not_found'] + } + } /** * Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can * share the same `config` as long as those webhooks do not have any `events` that overlap. */ - "repos/create-webhook": { + 'repos/create-webhook': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["hook"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['hook'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`. */ - name?: string; + name?: string /** @description Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/repos#create-hook-config-params). */ config?: { - url?: components["schemas"]["webhook-config-url"]; - content_type?: components["schemas"]["webhook-config-content-type"]; - secret?: components["schemas"]["webhook-config-secret"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + url?: components['schemas']['webhook-config-url'] + content_type?: components['schemas']['webhook-config-content-type'] + secret?: components['schemas']['webhook-config-secret'] + insecure_ssl?: components['schemas']['webhook-config-insecure-ssl'] /** @example "abc" */ - token?: string; + token?: string /** @example "sha256" */ - digest?: string; - } & { [key: string]: unknown }; + digest?: string + } & { [key: string]: unknown } /** * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. * @default push */ - events?: string[]; + events?: string[] /** * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. * @default true */ - active?: boolean; - } | null; - }; - }; - }; + active?: boolean + } | null + } + } + } /** Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/reference/repos#get-a-webhook-configuration-for-a-repository)." */ - "repos/get-webhook": { + 'repos/get-webhook': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["hook"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "repos/delete-webhook": { + 'application/json': components['schemas']['hook'] + } + } + 404: components['responses']['not_found'] + } + } + 'repos/delete-webhook': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/reference/repos#update-a-webhook-configuration-for-a-repository)." */ - "repos/update-webhook": { + 'repos/update-webhook': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["hook"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['hook'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/repos#create-hook-config-params). */ config?: { - url: components["schemas"]["webhook-config-url"]; - content_type?: components["schemas"]["webhook-config-content-type"]; - secret?: components["schemas"]["webhook-config-secret"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + url: components['schemas']['webhook-config-url'] + content_type?: components['schemas']['webhook-config-content-type'] + secret?: components['schemas']['webhook-config-secret'] + insecure_ssl?: components['schemas']['webhook-config-insecure-ssl'] /** @example "bar@example.com" */ - address?: string; + address?: string /** @example "The Serious Room" */ - room?: string; - } & { [key: string]: unknown }; + room?: string + } & { [key: string]: unknown } /** * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events. * @default push */ - events?: string[]; + events?: string[] /** @description Determines a list of events to be added to the list of events that the Hook triggers for. */ - add_events?: string[]; + add_events?: string[] /** @description Determines a list of events to be removed from the list of events that the Hook triggers for. */ - remove_events?: string[]; + remove_events?: string[] /** * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. * @default true */ - active?: boolean; - } & { [key: string]: unknown }; - }; - }; - }; + active?: boolean + } & { [key: string]: unknown } + } + } + } /** * Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/reference/orgs#get-a-repository-webhook)." * * Access tokens must have the `read:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:read` permission. */ - "repos/get-webhook-config-for-repo": { + 'repos/get-webhook-config-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["webhook-config"]; - }; - }; - }; - }; + 'application/json': components['schemas']['webhook-config'] + } + } + } + } /** * Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/reference/orgs#update-a-repository-webhook)." * * Access tokens must have the `write:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:write` permission. */ - "repos/update-webhook-config-for-repo": { + 'repos/update-webhook-config-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["webhook-config"]; - }; - }; - }; + 'application/json': components['schemas']['webhook-config'] + } + } + } requestBody: { content: { - "application/json": { - url?: components["schemas"]["webhook-config-url"]; - content_type?: components["schemas"]["webhook-config-content-type"]; - secret?: components["schemas"]["webhook-config-secret"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - }; - }; - }; - }; + 'application/json': { + url?: components['schemas']['webhook-config-url'] + content_type?: components['schemas']['webhook-config-content-type'] + secret?: components['schemas']['webhook-config-secret'] + insecure_ssl?: components['schemas']['webhook-config-insecure-ssl'] + } + } + } + } /** Returns a list of webhook deliveries for a webhook configured in a repository. */ - "repos/list-webhook-deliveries": { + 'repos/list-webhook-deliveries': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - hook_id: components["parameters"]["hook-id"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + hook_id: components['parameters']['hook-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ - cursor?: components["parameters"]["cursor"]; - }; - }; + cursor?: components['parameters']['cursor'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["hook-delivery-item"][]; - }; - }; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['hook-delivery-item'][] + } + } + 400: components['responses']['bad_request'] + 422: components['responses']['validation_failed'] + } + } /** Returns a delivery for a webhook configured in a repository. */ - "repos/get-webhook-delivery": { + 'repos/get-webhook-delivery': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - hook_id: components["parameters"]["hook-id"]; - delivery_id: components["parameters"]["delivery-id"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + hook_id: components['parameters']['hook-id'] + delivery_id: components['parameters']['delivery-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["hook-delivery"]; - }; - }; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['hook-delivery'] + } + } + 400: components['responses']['bad_request'] + 422: components['responses']['validation_failed'] + } + } /** Redeliver a webhook delivery for a webhook configured in a repository. */ - "repos/redeliver-webhook-delivery": { + 'repos/redeliver-webhook-delivery': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - hook_id: components["parameters"]["hook-id"]; - delivery_id: components["parameters"]["delivery-id"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + hook_id: components['parameters']['hook-id'] + delivery_id: components['parameters']['delivery-id'] + } + } responses: { - 202: components["responses"]["accepted"]; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 202: components['responses']['accepted'] + 400: components['responses']['bad_request'] + 422: components['responses']['validation_failed'] + } + } /** This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. */ - "repos/ping-webhook": { + 'repos/ping-webhook': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** * This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. * * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` */ - "repos/test-push-webhook": { + 'repos/test-push-webhook': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** * View the progress of an import. * @@ -32814,362 +32777,363 @@ export interface operations { * * `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository. * * `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a "Get Large Files" request. */ - "migrations/get-import-status": { + 'migrations/get-import-status': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["import"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['import'] + } + } + 404: components['responses']['not_found'] + } + } /** Start a source import to a GitHub repository using GitHub Importer. */ - "migrations/start-import": { + 'migrations/start-import': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["import"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['import'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The URL of the originating repository. */ - vcs_url: string; + vcs_url: string /** * @description The originating VCS type. Can be one of `subversion`, `git`, `mercurial`, or `tfvc`. Please be aware that without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response. * @enum {string} */ - vcs?: "subversion" | "git" | "mercurial" | "tfvc"; + vcs?: 'subversion' | 'git' | 'mercurial' | 'tfvc' /** @description If authentication is required, the username to provide to `vcs_url`. */ - vcs_username?: string; + vcs_username?: string /** @description If authentication is required, the password to provide to `vcs_url`. */ - vcs_password?: string; + vcs_password?: string /** @description For a tfvc import, the name of the project that is being imported. */ - tfvc_project?: string; - } & { [key: string]: unknown }; - }; - }; - }; + tfvc_project?: string + } & { [key: string]: unknown } + } + } + } /** Stop an import for a repository. */ - "migrations/cancel-import": { + 'migrations/cancel-import': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API * request. If no parameters are provided, the import will be restarted. */ - "migrations/update-import": { + 'migrations/update-import': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["import"]; - }; - }; - }; + 'application/json': components['schemas']['import'] + } + } + } requestBody: { content: { - "application/json": + 'application/json': | ({ /** @description The username to provide to the originating repository. */ - vcs_username?: string; + vcs_username?: string /** @description The password to provide to the originating repository. */ - vcs_password?: string; + vcs_password?: string /** @example "git" */ - vcs?: string; + vcs?: string /** @example "project1" */ - tfvc_project?: string; + tfvc_project?: string } & { [key: string]: unknown }) - | null; - }; - }; - }; + | null + } + } + } /** * Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `. * * This endpoint and the [Map a commit author](https://docs.github.com/rest/reference/migrations#map-a-commit-author) endpoint allow you to provide correct Git author information. */ - "migrations/get-commit-authors": { + 'migrations/get-commit-authors': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** A user ID. Only return users with an ID greater than this ID. */ - since?: components["parameters"]["since-user"]; - }; - }; + since?: components['parameters']['since-user'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["porter-author"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['porter-author'][] + } + } + 404: components['responses']['not_found'] + } + } /** Update an author's identity for the import. Your application can continue updating authors any time before you push new commits to the repository. */ - "migrations/map-commit-author": { + 'migrations/map-commit-author': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - author_id: number; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + author_id: number + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["porter-author"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['porter-author'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The new Git author email. */ - email?: string; + email?: string /** @description The new Git author name. */ - name?: string; - }; - }; - }; - }; + name?: string + } + } + } + } /** List files larger than 100MB found during the import */ - "migrations/get-large-files": { + 'migrations/get-large-files': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["porter-large-file"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['porter-large-file'][] + } + } + } + } /** You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability is powered by [Git LFS](https://git-lfs.github.com). You can learn more about our LFS feature and working with large files [on our help site](https://docs.github.com/articles/versioning-large-files/). */ - "migrations/set-lfs-preference": { + 'migrations/set-lfs-preference': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["import"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['import'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description Can be one of `opt_in` (large files will be stored using Git LFS) or `opt_out` (large files will be removed during the import). * @enum {string} */ - use_lfs: "opt_in" | "opt_out"; - } & { [key: string]: unknown }; - }; - }; - }; + use_lfs: 'opt_in' | 'opt_out' + } & { [key: string]: unknown } + } + } + } /** * Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/get-repo-installation": { + 'apps/get-repo-installation': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["installation"]; - }; - }; - 301: components["responses"]["moved_permanently"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['installation'] + } + } + 301: components['responses']['moved_permanently'] + 404: components['responses']['not_found'] + } + } /** Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response. */ - "interactions/get-restrictions-for-repo": { + 'interactions/get-restrictions-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": (Partial & - Partial<{ [key: string]: unknown }>) & { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': (Partial & Partial<{ [key: string]: unknown }>) & { + [key: string]: unknown + } + } + } + } + } /** Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. */ - "interactions/set-restrictions-for-repo": { + 'interactions/set-restrictions-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["interaction-limit-response"]; - }; - }; + 'application/json': components['schemas']['interaction-limit-response'] + } + } /** Response */ - 409: unknown; - }; + 409: unknown + } requestBody: { content: { - "application/json": components["schemas"]["interaction-limit"]; - }; - }; - }; + 'application/json': components['schemas']['interaction-limit'] + } + } + } /** Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. */ - "interactions/remove-restrictions-for-repo": { + 'interactions/remove-restrictions-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; + 204: never /** Response */ - 409: unknown; - }; - }; + 409: unknown + } + } /** When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations. */ - "repos/list-invitations": { + 'repos/list-invitations': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["repository-invitation"][]; - }; - }; - }; - }; - "repos/delete-invitation": { + 'application/json': components['schemas']['repository-invitation'][] + } + } + } + } + 'repos/delete-invitation': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** invitation_id parameter */ - invitation_id: components["parameters"]["invitation-id"]; - }; - }; + invitation_id: components['parameters']['invitation-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; - "repos/update-invitation": { + 204: never + } + } + 'repos/update-invitation': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** invitation_id parameter */ - invitation_id: components["parameters"]["invitation-id"]; - }; - }; + invitation_id: components['parameters']['invitation-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["repository-invitation"]; - }; - }; - }; + 'application/json': components['schemas']['repository-invitation'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The permissions that the associated user will have on the repository. Valid values are `read`, `write`, `maintain`, `triage`, and `admin`. * @enum {string} */ - permissions?: "read" | "write" | "maintain" | "triage" | "admin"; - } & { [key: string]: unknown }; - }; - }; - }; + permissions?: 'read' | 'write' | 'maintain' | 'triage' | 'admin' + } & { [key: string]: unknown } + } + } + } /** * List issues in a repository. * @@ -33178,326 +33142,326 @@ export interface operations { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - "issues/list-for-repo": { + 'issues/list-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned. */ - milestone?: string; + milestone?: string /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ - state?: "open" | "closed" | "all"; + state?: 'open' | 'closed' | 'all' /** Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user. */ - assignee?: string; + assignee?: string /** The user that created the issue. */ - creator?: string; + creator?: string /** A user that's mentioned in the issue. */ - mentioned?: string; + mentioned?: string /** A list of comma separated label names. Example: `bug,ui,@high` */ - labels?: components["parameters"]["labels"]; + labels?: components['parameters']['labels'] /** What to sort results by. Can be either `created`, `updated`, `comments`. */ - sort?: "created" | "updated" | "comments"; + sort?: 'created' | 'updated' | 'comments' /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["issue"][]; - }; - }; - 301: components["responses"]["moved_permanently"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['issue'][] + } + } + 301: components['responses']['moved_permanently'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** * Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - "issues/create": { + 'issues/create': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["issue"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed"]; - 503: components["responses"]["service_unavailable"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['issue'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + 422: components['responses']['validation_failed'] + 503: components['responses']['service_unavailable'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The title of the issue. */ - title: (string | number) & { [key: string]: unknown }; + title: (string | number) & { [key: string]: unknown } /** @description The contents of the issue. */ - body?: string; + body?: string /** @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_ */ - assignee?: string | null; - milestone?: ((string | number) & { [key: string]: unknown }) | null; + assignee?: string | null + milestone?: ((string | number) & { [key: string]: unknown }) | null /** @description Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._ */ labels?: (( | string | ({ - id?: number; - name?: string; - description?: string | null; - color?: string | null; + id?: number + name?: string + description?: string | null + color?: string | null } & { [key: string]: unknown }) - ) & { [key: string]: unknown })[]; + ) & { [key: string]: unknown })[] /** @description Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ */ - assignees?: string[]; - } & { [key: string]: unknown }; - }; - }; - }; + assignees?: string[] + } & { [key: string]: unknown } + } + } + } /** By default, Issue Comments are ordered by ascending ID. */ - "issues/list-comments-for-repo": { + 'issues/list-comments-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** One of `created` (when the repository was starred) or `updated` (when it was last pushed to). */ - sort?: components["parameters"]["sort"]; + sort?: components['parameters']['sort'] /** Either `asc` or `desc`. Ignored without the `sort` parameter. */ - direction?: "asc" | "desc"; + direction?: 'asc' | 'desc' /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["issue-comment"][]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "issues/get-comment": { + 'application/json': components['schemas']['issue-comment'][] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } + 'issues/get-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["issue-comment"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "issues/delete-comment": { + 'application/json': components['schemas']['issue-comment'] + } + } + 404: components['responses']['not_found'] + } + } + 'issues/delete-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; - "issues/update-comment": { + 204: never + } + } + 'issues/update-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["issue-comment"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['issue-comment'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The contents of the comment. */ - body: string; - } & { [key: string]: unknown }; - }; - }; - }; + body: string + } & { [key: string]: unknown } + } + } + } /** List the reactions to an [issue comment](https://docs.github.com/rest/reference/issues#comments). */ - "reactions/list-for-issue-comment": { + 'reactions/list-for-issue-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; + comment_id: components['parameters']['comment-id'] + } query: { /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue comment. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content?: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["reaction"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['reaction'][] + } + } + 404: components['responses']['not_found'] + } + } /** Create a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. */ - "reactions/create-for-issue-comment": { + 'reactions/create-for-issue-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Reaction exists */ 200: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; + 'application/json': components['schemas']['reaction'] + } + } /** Reaction created */ 201: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['reaction'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the issue comment. * @enum {string} */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - } & { [key: string]: unknown }; - }; - }; - }; + content: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' + } & { [key: string]: unknown } + } + } + } /** * **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. * * Delete a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). */ - "reactions/delete-for-issue-comment": { + 'reactions/delete-for-issue-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - reaction_id: components["parameters"]["reaction-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + reaction_id: components['parameters']['reaction-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; - "issues/list-events-for-repo": { + 204: never + } + } + 'issues/list-events-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["issue-event"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; - }; - "issues/get-event": { + 'application/json': components['schemas']['issue-event'][] + } + } + 422: components['responses']['validation_failed'] + } + } + 'issues/get-event': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - event_id: number; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + event_id: number + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["issue-event"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - }; - }; + 'application/json': components['schemas']['issue-event'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + } + } /** * The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was * [transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If @@ -33511,396 +33475,396 @@ export interface operations { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - "issues/get": { + 'issues/get': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; - }; + issue_number: components['parameters']['issue-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["issue"]; - }; - }; - 301: components["responses"]["moved_permanently"]; - 304: components["responses"]["not_modified"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - }; - }; + 'application/json': components['schemas']['issue'] + } + } + 301: components['responses']['moved_permanently'] + 304: components['responses']['not_modified'] + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + } + } /** Issue owners and users with push access can edit an issue. */ - "issues/update": { + 'issues/update': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; - }; + issue_number: components['parameters']['issue-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["issue"]; - }; - }; - 301: components["responses"]["moved_permanently"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed"]; - 503: components["responses"]["service_unavailable"]; - }; + 'application/json': components['schemas']['issue'] + } + } + 301: components['responses']['moved_permanently'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + 422: components['responses']['validation_failed'] + 503: components['responses']['service_unavailable'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The title of the issue. */ - title?: ((string | number) & { [key: string]: unknown }) | null; + title?: ((string | number) & { [key: string]: unknown }) | null /** @description The contents of the issue. */ - body?: string | null; + body?: string | null /** @description Login for the user that this issue should be assigned to. **This field is deprecated.** */ - assignee?: string | null; + assignee?: string | null /** * @description State of the issue. Either `open` or `closed`. * @enum {string} */ - state?: "open" | "closed"; - milestone?: ((string | number) & { [key: string]: unknown }) | null; + state?: 'open' | 'closed' + milestone?: ((string | number) & { [key: string]: unknown }) | null /** @description Labels to associate with this issue. Pass one or more Labels to _replace_ the set of Labels on this Issue. Send an empty array (`[]`) to clear all Labels from the Issue. _NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise._ */ labels?: (( | string | ({ - id?: number; - name?: string; - description?: string | null; - color?: string | null; + id?: number + name?: string + description?: string | null + color?: string | null } & { [key: string]: unknown }) - ) & { [key: string]: unknown })[]; + ) & { [key: string]: unknown })[] /** @description Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ */ - assignees?: string[]; - } & { [key: string]: unknown }; - }; - }; - }; + assignees?: string[] + } & { [key: string]: unknown } + } + } + } /** Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced. */ - "issues/add-assignees": { + 'issues/add-assignees': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; - }; + issue_number: components['parameters']['issue-number'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["issue"]; - }; - }; - }; + 'application/json': components['schemas']['issue'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._ */ - assignees?: string[]; - } & { [key: string]: unknown }; - }; - }; - }; + assignees?: string[] + } & { [key: string]: unknown } + } + } + } /** Removes one or more assignees from an issue. */ - "issues/remove-assignees": { + 'issues/remove-assignees': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; - }; + issue_number: components['parameters']['issue-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["issue"]; - }; - }; - }; + 'application/json': components['schemas']['issue'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._ */ - assignees?: string[]; - } & { [key: string]: unknown }; - }; - }; - }; + assignees?: string[] + } & { [key: string]: unknown } + } + } + } /** Issue Comments are ordered by ascending ID. */ - "issues/list-comments": { + 'issues/list-comments': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; + issue_number: components['parameters']['issue-number'] + } query: { /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["issue-comment"][]; - }; - }; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - }; - }; + 'application/json': components['schemas']['issue-comment'][] + } + } + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + } + } /** This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - "issues/create-comment": { + 'issues/create-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; - }; + issue_number: components['parameters']['issue-number'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["issue-comment"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['issue-comment'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The contents of the comment. */ - body: string; - } & { [key: string]: unknown }; - }; - }; - }; - "issues/list-events": { + body: string + } & { [key: string]: unknown } + } + } + } + 'issues/list-events': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; + issue_number: components['parameters']['issue-number'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["issue-event-for-issue"][]; - }; - }; - 410: components["responses"]["gone"]; - }; - }; - "issues/list-labels-on-issue": { + 'application/json': components['schemas']['issue-event-for-issue'][] + } + } + 410: components['responses']['gone'] + } + } + 'issues/list-labels-on-issue': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; + issue_number: components['parameters']['issue-number'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["label"][]; - }; - }; - 410: components["responses"]["gone"]; - }; - }; + 'application/json': components['schemas']['label'][] + } + } + 410: components['responses']['gone'] + } + } /** Removes any previous labels and sets the new labels for an issue. */ - "issues/set-labels": { + 'issues/set-labels': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; - }; + issue_number: components['parameters']['issue-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["label"][]; - }; - }; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['label'][] + } + } + 410: components['responses']['gone'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": ( + 'application/json': ( | ({ /** @description The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see "[Add labels to an issue](https://docs.github.com/rest/reference/issues#add-labels-to-an-issue)." */ - labels?: string[]; + labels?: string[] } & { [key: string]: unknown }) | string[] | ({ labels?: ({ - name: string; - } & { [key: string]: unknown })[]; + name: string + } & { [key: string]: unknown })[] } & { [key: string]: unknown }) | ({ - name: string; + name: string } & { [key: string]: unknown })[] | string - ) & { [key: string]: unknown }; - }; - }; - }; - "issues/add-labels": { + ) & { [key: string]: unknown } + } + } + } + 'issues/add-labels': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; - }; + issue_number: components['parameters']['issue-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["label"][]; - }; - }; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['label'][] + } + } + 410: components['responses']['gone'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": ( + 'application/json': ( | ({ /** @description The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also replace all of the labels for an issue. For more information, see "[Set labels for an issue](https://docs.github.com/rest/reference/issues#set-labels-for-an-issue)." */ - labels?: string[]; + labels?: string[] } & { [key: string]: unknown }) | string[] | ({ labels?: ({ - name: string; - } & { [key: string]: unknown })[]; + name: string + } & { [key: string]: unknown })[] } & { [key: string]: unknown }) | ({ - name: string; + name: string } & { [key: string]: unknown })[] | string - ) & { [key: string]: unknown }; - }; - }; - }; - "issues/remove-all-labels": { + ) & { [key: string]: unknown } + } + } + } + 'issues/remove-all-labels': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; - }; + issue_number: components['parameters']['issue-number'] + } + } responses: { /** Response */ - 204: never; - 410: components["responses"]["gone"]; - }; - }; + 204: never + 410: components['responses']['gone'] + } + } /** Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist. */ - "issues/remove-label": { + 'issues/remove-label': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - name: string; - }; - }; + issue_number: components['parameters']['issue-number'] + name: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["label"][]; - }; - }; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - }; - }; + 'application/json': components['schemas']['label'][] + } + } + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + } + } /** * Users with push access can lock an issue or pull request's conversation. * * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - "issues/lock": { + 'issues/lock': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; - }; + issue_number: components['parameters']['issue-number'] + } + } responses: { /** Response */ - 204: never; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed"]; - }; + 204: never + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | ({ /** * @description The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: @@ -33910,380 +33874,380 @@ export interface operations { * \* `spam` * @enum {string} */ - lock_reason?: "off-topic" | "too heated" | "resolved" | "spam"; + lock_reason?: 'off-topic' | 'too heated' | 'resolved' | 'spam' } & { [key: string]: unknown }) - | null; - }; - }; - }; + | null + } + } + } /** Users with push access can unlock an issue's conversation. */ - "issues/unlock": { + 'issues/unlock': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; - }; + issue_number: components['parameters']['issue-number'] + } + } responses: { /** Response */ - 204: never; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** List the reactions to an [issue](https://docs.github.com/rest/reference/issues). */ - "reactions/list-for-issue": { + 'reactions/list-for-issue': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; + issue_number: components['parameters']['issue-number'] + } query: { /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content?: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["reaction"][]; - }; - }; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - }; - }; + 'application/json': components['schemas']['reaction'][] + } + } + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + } + } /** Create a reaction to an [issue](https://docs.github.com/rest/reference/issues/). A response with an HTTP `200` status means that you already added the reaction type to this issue. */ - "reactions/create-for-issue": { + 'reactions/create-for-issue': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; - }; + issue_number: components['parameters']['issue-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; + 'application/json': components['schemas']['reaction'] + } + } /** Response */ 201: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['reaction'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the issue. * @enum {string} */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - } & { [key: string]: unknown }; - }; - }; - }; + content: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' + } & { [key: string]: unknown } + } + } + } /** * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. * * Delete a reaction to an [issue](https://docs.github.com/rest/reference/issues/). */ - "reactions/delete-for-issue": { + 'reactions/delete-for-issue': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - reaction_id: components["parameters"]["reaction-id"]; - }; - }; + issue_number: components['parameters']['issue-number'] + reaction_id: components['parameters']['reaction-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; - "issues/list-events-for-timeline": { + 204: never + } + } + 'issues/list-events-for-timeline': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; + issue_number: components['parameters']['issue-number'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["timeline-issue-events"][]; - }; - }; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - }; - }; - "repos/list-deploy-keys": { + 'application/json': components['schemas']['timeline-issue-events'][] + } + } + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + } + } + 'repos/list-deploy-keys': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["deploy-key"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['deploy-key'][] + } + } + } + } /** You can create a read-only deploy key. */ - "repos/create-deploy-key": { + 'repos/create-deploy-key': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["deploy-key"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['deploy-key'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description A name for the key. */ - title?: string; + title?: string /** @description The contents of the key. */ - key: string; + key: string /** * @description If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. * * Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)" and "[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/)." */ - read_only?: boolean; - } & { [key: string]: unknown }; - }; - }; - }; - "repos/get-deploy-key": { + read_only?: boolean + } & { [key: string]: unknown } + } + } + } + 'repos/get-deploy-key': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** key_id parameter */ - key_id: components["parameters"]["key-id"]; - }; - }; + key_id: components['parameters']['key-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["deploy-key"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['deploy-key'] + } + } + 404: components['responses']['not_found'] + } + } /** Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead. */ - "repos/delete-deploy-key": { + 'repos/delete-deploy-key': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** key_id parameter */ - key_id: components["parameters"]["key-id"]; - }; - }; + key_id: components['parameters']['key-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; - "issues/list-labels-for-repo": { + 204: never + } + } + 'issues/list-labels-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["label"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "issues/create-label": { + 'application/json': components['schemas']['label'][] + } + } + 404: components['responses']['not_found'] + } + } + 'issues/create-label': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["label"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['label'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see "[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet)." */ - name: string; + name: string /** @description The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. */ - color?: string; + color?: string /** @description A short description of the label. Must be 100 characters or fewer. */ - description?: string; - } & { [key: string]: unknown }; - }; - }; - }; - "issues/get-label": { + description?: string + } & { [key: string]: unknown } + } + } + } + 'issues/get-label': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - name: string; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + name: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["label"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "issues/delete-label": { + 'application/json': components['schemas']['label'] + } + } + 404: components['responses']['not_found'] + } + } + 'issues/delete-label': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - name: string; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + name: string + } + } responses: { /** Response */ - 204: never; - }; - }; - "issues/update-label": { + 204: never + } + } + 'issues/update-label': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - name: string; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + name: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["label"]; - }; - }; - }; + 'application/json': components['schemas']['label'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see "[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet)." */ - new_name?: string; + new_name?: string /** @description The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. */ - color?: string; + color?: string /** @description A short description of the label. Must be 100 characters or fewer. */ - description?: string; - } & { [key: string]: unknown }; - }; - }; - }; + description?: string + } & { [key: string]: unknown } + } + } + } /** Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language. */ - "repos/list-languages": { + 'repos/list-languages': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["language"]; - }; - }; - }; - }; - "repos/enable-lfs-for-repo": { + 'application/json': components['schemas']['language'] + } + } + } + } + 'repos/enable-lfs-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { - 202: components["responses"]["accepted"]; + 202: components['responses']['accepted'] /** * We will return a 403 with one of the following messages: * @@ -34291,527 +34255,527 @@ export interface operations { * - Git LFS support not enabled because Git LFS is disabled for the root repository in the network. * - Git LFS support not enabled because Git LFS is disabled for . */ - 403: unknown; - }; - }; - "repos/disable-lfs-for-repo": { + 403: unknown + } + } + 'repos/disable-lfs-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * This method returns the contents of the repository's license file, if one is detected. * * Similar to [Get repository content](https://docs.github.com/rest/reference/repos#get-repository-content), this method also supports [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw license content or rendered license HTML. */ - "licenses/get-for-repo": { + 'licenses/get-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["license-content"]; - }; - }; - }; - }; + 'application/json': components['schemas']['license-content'] + } + } + } + } /** Sync a branch of a forked repository to keep it up-to-date with the upstream repository. */ - "repos/merge-upstream": { + 'repos/merge-upstream': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** The branch has been successfully synced with the upstream repository */ 200: { content: { - "application/json": components["schemas"]["merged-upstream"]; - }; - }; + 'application/json': components['schemas']['merged-upstream'] + } + } /** The branch could not be synced because of a merge conflict */ - 409: unknown; + 409: unknown /** The branch could not be synced for some other reason */ - 422: unknown; - }; + 422: unknown + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the branch which should be updated to match upstream. */ - branch: string; - } & { [key: string]: unknown }; - }; - }; - }; - "repos/merge": { + branch: string + } & { [key: string]: unknown } + } + } + } + 'repos/merge': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Successful Response (The resulting merge commit) */ 201: { content: { - "application/json": components["schemas"]["commit"]; - }; - }; + 'application/json': components['schemas']['commit'] + } + } /** Response when already merged */ - 204: never; - 403: components["responses"]["forbidden"]; + 204: never + 403: components['responses']['forbidden'] /** Not Found when the base or head does not exist */ - 404: unknown; + 404: unknown /** Conflict when there is a merge conflict */ - 409: unknown; - 422: components["responses"]["validation_failed"]; - }; + 409: unknown + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the base branch that the head will be merged into. */ - base: string; + base: string /** @description The head to merge. This can be a branch name or a commit SHA1. */ - head: string; + head: string /** @description Commit message to use for the merge commit. If omitted, a default message will be used. */ - commit_message?: string; - } & { [key: string]: unknown }; - }; - }; - }; - "issues/list-milestones": { + commit_message?: string + } & { [key: string]: unknown } + } + } + } + 'issues/list-milestones': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** The state of the milestone. Either `open`, `closed`, or `all`. */ - state?: "open" | "closed" | "all"; + state?: 'open' | 'closed' | 'all' /** What to sort results by. Either `due_on` or `completeness`. */ - sort?: "due_on" | "completeness"; + sort?: 'due_on' | 'completeness' /** The direction of the sort. Either `asc` or `desc`. */ - direction?: "asc" | "desc"; + direction?: 'asc' | 'desc' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["milestone"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "issues/create-milestone": { + 'application/json': components['schemas']['milestone'][] + } + } + 404: components['responses']['not_found'] + } + } + 'issues/create-milestone': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["milestone"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['milestone'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The title of the milestone. */ - title: string; + title: string /** * @description The state of the milestone. Either `open` or `closed`. * @default open * @enum {string} */ - state?: "open" | "closed"; + state?: 'open' | 'closed' /** @description A description of the milestone. */ - description?: string; + description?: string /** * Format: date-time * @description The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - due_on?: string; - } & { [key: string]: unknown }; - }; - }; - }; - "issues/get-milestone": { + due_on?: string + } & { [key: string]: unknown } + } + } + } + 'issues/get-milestone': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** milestone_number parameter */ - milestone_number: components["parameters"]["milestone-number"]; - }; - }; + milestone_number: components['parameters']['milestone-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["milestone"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "issues/delete-milestone": { + 'application/json': components['schemas']['milestone'] + } + } + 404: components['responses']['not_found'] + } + } + 'issues/delete-milestone': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** milestone_number parameter */ - milestone_number: components["parameters"]["milestone-number"]; - }; - }; + milestone_number: components['parameters']['milestone-number'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; - "issues/update-milestone": { + 204: never + 404: components['responses']['not_found'] + } + } + 'issues/update-milestone': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** milestone_number parameter */ - milestone_number: components["parameters"]["milestone-number"]; - }; - }; + milestone_number: components['parameters']['milestone-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["milestone"]; - }; - }; - }; + 'application/json': components['schemas']['milestone'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The title of the milestone. */ - title?: string; + title?: string /** * @description The state of the milestone. Either `open` or `closed`. * @default open * @enum {string} */ - state?: "open" | "closed"; + state?: 'open' | 'closed' /** @description A description of the milestone. */ - description?: string; + description?: string /** * Format: date-time * @description The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - due_on?: string; - } & { [key: string]: unknown }; - }; - }; - }; - "issues/list-labels-for-milestone": { + due_on?: string + } & { [key: string]: unknown } + } + } + } + 'issues/list-labels-for-milestone': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** milestone_number parameter */ - milestone_number: components["parameters"]["milestone-number"]; - }; + milestone_number: components['parameters']['milestone-number'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["label"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['label'][] + } + } + } + } /** List all notifications for the current user. */ - "activity/list-repo-notifications-for-authenticated-user": { + 'activity/list-repo-notifications-for-authenticated-user': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** If `true`, show notifications marked as read. */ - all?: components["parameters"]["all"]; + all?: components['parameters']['all'] /** If `true`, only shows notifications in which the user is directly participating or mentioned. */ - participating?: components["parameters"]["participating"]; + participating?: components['parameters']['participating'] /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - before?: components["parameters"]["before"]; + before?: components['parameters']['before'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["thread"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['thread'][] + } + } + } + } /** Marks all notifications in a repository as "read" removes them from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ - "activity/mark-repo-notifications-as-read": { + 'activity/mark-repo-notifications-as-read': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 202: { content: { - "application/json": { - message?: string; - url?: string; - } & { [key: string]: unknown }; - }; - }; + 'application/json': { + message?: string + url?: string + } & { [key: string]: unknown } + } + } /** Reset Content */ - 205: unknown; - }; + 205: unknown + } requestBody: { content: { - "application/json": { + 'application/json': { /** * Format: date-time * @description Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. */ - last_read_at?: string; - } & { [key: string]: unknown }; - }; - }; - }; - "repos/get-pages": { + last_read_at?: string + } & { [key: string]: unknown } + } + } + } + 'repos/get-pages': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["page"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['page'] + } + } + 404: components['responses']['not_found'] + } + } /** Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). */ - "repos/update-information-about-pages-site": { + 'repos/update-information-about-pages-site': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; - }; + 204: never + 400: components['responses']['bad_request'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/articles/using-a-custom-domain-with-github-pages/)." */ - cname?: string | null; + cname?: string | null /** @description Specify whether HTTPS should be enforced for the repository. */ - https_enforced?: boolean; + https_enforced?: boolean /** @description Configures access controls for the GitHub Pages site. If public is set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to `internal` visibility. This feature is only available to repositories in an organization on an Enterprise plan. */ - public?: boolean; - source?: (Partial<"gh-pages" | "master" | "master /docs"> & + public?: boolean + source?: (Partial<'gh-pages' | 'master' | 'master /docs'> & Partial< { /** @description The repository branch used to publish your site's source files. */ - branch: string; + branch: string /** * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. * @enum {string} */ - path: "/" | "/docs"; + path: '/' | '/docs' } & { [key: string]: unknown } - >) & { [key: string]: unknown }; - } & { [key: string]: unknown }; - }; - }; - }; + >) & { [key: string]: unknown } + } & { [key: string]: unknown } + } + } + } /** Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)." */ - "repos/create-pages-site": { + 'repos/create-pages-site': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["page"]; - }; - }; - 409: components["responses"]["conflict"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['page'] + } + } + 409: components['responses']['conflict'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | ({ /** @description The source branch and directory used to publish your Pages site. */ source: { /** @description The repository branch used to publish your site's source files. */ - branch: string; + branch: string /** * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/` * @default / * @enum {string} */ - path?: "/" | "/docs"; - } & { [key: string]: unknown }; + path?: '/' | '/docs' + } & { [key: string]: unknown } } & { [key: string]: unknown }) - | null; - }; - }; - }; - "repos/delete-pages-site": { + | null + } + } + } + 'repos/delete-pages-site': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "repos/list-pages-builds": { + 204: never + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } + 'repos/list-pages-builds': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["page-build"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['page-build'][] + } + } + } + } /** * You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures. * * Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes. */ - "repos/request-pages-build": { + 'repos/request-pages-build': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["page-build-status"]; - }; - }; - }; - }; - "repos/get-latest-pages-build": { + 'application/json': components['schemas']['page-build-status'] + } + } + } + } + 'repos/get-latest-pages-build': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["page-build"]; - }; - }; - }; - }; - "repos/get-pages-build": { + 'application/json': components['schemas']['page-build'] + } + } + } + } + 'repos/get-pages-build': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - build_id: number; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + build_id: number + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["page-build"]; - }; - }; - }; - }; + 'application/json': components['schemas']['page-build'] + } + } + } + } /** * Gets a health check of the DNS settings for the `CNAME` record configured for a repository's GitHub Pages. * @@ -34819,132 +34783,132 @@ export interface operations { * * Users must have admin or owner permissions. GitHub Apps must have the `pages:write` and `administration:write` permission to use this endpoint. */ - "repos/get-pages-health-check": { + 'repos/get-pages-health-check': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pages-health-check"]; - }; - }; + 'application/json': components['schemas']['pages-health-check'] + } + } /** Empty response */ 202: { content: { - "application/json": components["schemas"]["empty-object"]; - }; - }; + 'application/json': components['schemas']['empty-object'] + } + } /** Custom domains are not available for GitHub Pages */ - 400: unknown; - 404: components["responses"]["not_found"]; + 400: unknown + 404: components['responses']['not_found'] /** There isn't a CNAME for this page */ - 422: unknown; - }; - }; + 422: unknown + } + } /** Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - "projects/list-for-repo": { + 'projects/list-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. */ - state?: "open" | "closed" | "all"; + state?: 'open' | 'closed' | 'all' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["project"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed_simple"]; - }; - }; + 'application/json': components['schemas']['project'][] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + 422: components['responses']['validation_failed_simple'] + } + } /** Creates a repository project board. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - "projects/create-for-repo": { + 'projects/create-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["project"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': components['schemas']['project'] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the project. */ - name: string; + name: string /** @description The description of the project. */ - body?: string; - } & { [key: string]: unknown }; - }; - }; - }; + body?: string + } & { [key: string]: unknown } + } + } + } /** Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "pulls/list": { + 'pulls/list': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Either `open`, `closed`, or `all` to filter by state. */ - state?: "open" | "closed" | "all"; + state?: 'open' | 'closed' | 'all' /** Filter pulls by head user or head organization and branch name in the format of `user:ref-name` or `organization:ref-name`. For example: `github:new-script-format` or `octocat:test-branch`. */ - head?: string; + head?: string /** Filter pulls by base branch name. Example: `gh-pages`. */ - base?: string; + base?: string /** What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month). */ - sort?: "created" | "updated" | "popularity" | "long-running"; + sort?: 'created' | 'updated' | 'popularity' | 'long-running' /** The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`. */ - direction?: "asc" | "desc"; + direction?: 'asc' | 'desc' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["pull-request-simple"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['pull-request-simple'][] + } + } + 304: components['responses']['not_modified'] + 422: components['responses']['validation_failed'] + } + } /** * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -34954,225 +34918,225 @@ export interface operations { * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. */ - "pulls/create": { + 'pulls/create': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["pull-request"]; - }; - }; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['pull-request'] + } + } + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The title of the new pull request. */ - title?: string; + title?: string /** @description The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`. */ - head: string; + head: string /** @description The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository. */ - base: string; + base: string /** @description The contents of the pull request. */ - body?: string; + body?: string /** @description Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. */ - maintainer_can_modify?: boolean; + maintainer_can_modify?: boolean /** @description Indicates whether the pull request is a draft. See "[Draft Pull Requests](https://docs.github.com/en/articles/about-pull-requests#draft-pull-requests)" in the GitHub Help documentation to learn more. */ - draft?: boolean; + draft?: boolean /** @example 1 */ - issue?: number; - } & { [key: string]: unknown }; - }; - }; - }; + issue?: number + } & { [key: string]: unknown } + } + } + } /** Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID. */ - "pulls/list-review-comments-for-repo": { + 'pulls/list-review-comments-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { - sort?: "created" | "updated" | "created_at"; + sort?: 'created' | 'updated' | 'created_at' /** Can be either `asc` or `desc`. Ignored without `sort` parameter. */ - direction?: "asc" | "desc"; + direction?: 'asc' | 'desc' /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["pull-request-review-comment"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['pull-request-review-comment'][] + } + } + } + } /** Provides details for a review comment. */ - "pulls/get-review-comment": { + 'pulls/get-review-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pull-request-review-comment"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['pull-request-review-comment'] + } + } + 404: components['responses']['not_found'] + } + } /** Deletes a review comment. */ - "pulls/delete-review-comment": { + 'pulls/delete-review-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** Enables you to edit a review comment. */ - "pulls/update-review-comment": { + 'pulls/update-review-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pull-request-review-comment"]; - }; - }; - }; + 'application/json': components['schemas']['pull-request-review-comment'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The text of the reply to the review comment. */ - body: string; - } & { [key: string]: unknown }; - }; - }; - }; + body: string + } & { [key: string]: unknown } + } + } + } /** List the reactions to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). */ - "reactions/list-for-pull-request-review-comment": { + 'reactions/list-for-pull-request-review-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; + comment_id: components['parameters']['comment-id'] + } query: { /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a pull request review comment. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content?: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["reaction"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['reaction'][] + } + } + 404: components['responses']['not_found'] + } + } /** Create a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#comments). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. */ - "reactions/create-for-pull-request-review-comment": { + 'reactions/create-for-pull-request-review-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Reaction exists */ 200: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; + 'application/json': components['schemas']['reaction'] + } + } /** Reaction created */ 201: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['reaction'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the pull request review comment. * @enum {string} */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - } & { [key: string]: unknown }; - }; - }; - }; + content: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' + } & { [key: string]: unknown } + } + } + } /** * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` * * Delete a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). */ - "reactions/delete-for-pull-request-comment": { + 'reactions/delete-for-pull-request-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - reaction_id: components["parameters"]["reaction-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + reaction_id: components['parameters']['reaction-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -35190,145 +35154,145 @@ export interface operations { * * Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. */ - "pulls/get": { + 'pulls/get': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } + } responses: { /** Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. */ 200: { content: { - "application/json": components["schemas"]["pull-request"]; - }; - }; - 304: components["responses"]["not_modified"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': components['schemas']['pull-request'] + } + } + 304: components['responses']['not_modified'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. */ - "pulls/update": { + 'pulls/update': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pull-request"]; - }; - }; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['pull-request'] + } + } + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The title of the pull request. */ - title?: string; + title?: string /** @description The contents of the pull request. */ - body?: string; + body?: string /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ - state?: "open" | "closed"; + state?: 'open' | 'closed' /** @description The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository. */ - base?: string; + base?: string /** @description Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. */ - maintainer_can_modify?: boolean; - } & { [key: string]: unknown }; - }; - }; - }; + maintainer_can_modify?: boolean + } & { [key: string]: unknown } + } + } + } /** * Creates a codespace owned by the authenticated user for the specified pull request. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/create-with-pr-for-authenticated-user": { + 'codespaces/create-with-pr-for-authenticated-user': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } + } responses: { /** Response when the codespace was successfully created */ 201: { content: { - "application/json": components["schemas"]["codespace"]; - }; - }; + 'application/json': components['schemas']['codespace'] + } + } /** Response when the codespace creation partially failed but is being retried in the background */ 202: { content: { - "application/json": components["schemas"]["codespace"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; + 'application/json': components['schemas']['codespace'] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Location for this codespace */ - location: string; + location: string /** @description Machine type to use for this codespace */ - machine?: string; + machine?: string /** @description Working directory for this codespace */ - working_directory?: string; + working_directory?: string /** @description Time in minutes before codespace stops from inactivity */ - idle_timeout_minutes?: number; - } & { [key: string]: unknown }; - }; - }; - }; + idle_timeout_minutes?: number + } & { [key: string]: unknown } + } + } + } /** Lists all review comments for a pull request. By default, review comments are in ascending order by ID. */ - "pulls/list-review-comments": { + 'pulls/list-review-comments': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } query: { /** One of `created` (when the repository was starred) or `updated` (when it was last pushed to). */ - sort?: components["parameters"]["sort"]; + sort?: components['parameters']['sort'] /** Can be either `asc` or `desc`. Ignored without `sort` parameter. */ - direction?: "asc" | "desc"; + direction?: 'asc' | 'desc' /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["pull-request-review-comment"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['pull-request-review-comment'][] + } + } + } + } /** * Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/reference/issues#create-an-issue-comment)." We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff. * @@ -35338,330 +35302,330 @@ export interface operations { * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - "pulls/create-review-comment": { + 'pulls/create-review-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["pull-request-review-comment"]; - }; - }; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['pull-request-review-comment'] + } + } + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The text of the review comment. */ - body: string; + body: string /** @description The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`. */ - commit_id?: string; + commit_id?: string /** @description The relative path to the file that necessitates a comment. */ - path?: string; + path?: string /** @description **Required without `comfort-fade` preview unless using `in_reply_to`**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above. */ - position?: number; + position?: number /** * @description **Required with `comfort-fade` preview unless using `in_reply_to`**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "[Diff view options](https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation. * @enum {string} */ - side?: "LEFT" | "RIGHT"; + side?: 'LEFT' | 'RIGHT' /** @description **Required with `comfort-fade` preview unless using `in_reply_to`**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to. */ - line?: number; + line?: number /** @description **Required when using multi-line comments unless using `in_reply_to`**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. */ - start_line?: number; + start_line?: number /** * @description **Required when using multi-line comments unless using `in_reply_to`**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context. * @enum {string} */ - start_side?: "LEFT" | "RIGHT" | "side"; + start_side?: 'LEFT' | 'RIGHT' | 'side' /** * @description The ID of the review comment to reply to. To find the ID of a review comment with ["List review comments on a pull request"](#list-review-comments-on-a-pull-request). When specified, all parameters other than `body` in the request body are ignored. * @example 2 */ - in_reply_to?: number; - } & { [key: string]: unknown }; - }; - }; - }; + in_reply_to?: number + } & { [key: string]: unknown } + } + } + } /** * Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - "pulls/create-reply-for-review-comment": { + 'pulls/create-reply-for-review-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["pull-request-review-comment"]; - }; - }; - 404: components["responses"]["not_found"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['pull-request-review-comment'] + } + } + 404: components['responses']['not_found'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The text of the review comment. */ - body: string; - } & { [key: string]: unknown }; - }; - }; - }; + body: string + } & { [key: string]: unknown } + } + } + } /** Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/reference/repos#list-commits) endpoint. */ - "pulls/list-commits": { + 'pulls/list-commits': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["commit"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['commit'][] + } + } + } + } /** **Note:** Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. */ - "pulls/list-files": { + 'pulls/list-files': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["diff-entry"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - 500: components["responses"]["internal_error"]; - }; - }; - "pulls/check-if-merged": { + 'application/json': components['schemas']['diff-entry'][] + } + } + 422: components['responses']['validation_failed'] + 500: components['responses']['internal_error'] + } + } + 'pulls/check-if-merged': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } + } responses: { /** Response if pull request has been merged */ - 204: never; + 204: never /** Not Found if pull request has not been merged */ - 404: unknown; - }; - }; + 404: unknown + } + } /** This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - "pulls/merge": { + 'pulls/merge': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } + } responses: { /** if merge was successful */ 200: { content: { - "application/json": components["schemas"]["pull-request-merge-result"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; + 'application/json': components['schemas']['pull-request-merge-result'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] /** Method Not Allowed if merge cannot be performed */ 405: { content: { - "application/json": { - message?: string; - documentation_url?: string; - } & { [key: string]: unknown }; - }; - }; + 'application/json': { + message?: string + documentation_url?: string + } & { [key: string]: unknown } + } + } /** Conflict if sha was provided and pull request head did not match */ 409: { content: { - "application/json": { - message?: string; - documentation_url?: string; - } & { [key: string]: unknown }; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': { + message?: string + documentation_url?: string + } & { [key: string]: unknown } + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | ({ /** @description Title for the automatic commit message. */ - commit_title?: string; + commit_title?: string /** @description Extra detail to append to automatic commit message. */ - commit_message?: string; + commit_message?: string /** @description SHA that pull request head must match to allow merge. */ - sha?: string; + sha?: string /** * @description Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`. * @enum {string} */ - merge_method?: "merge" | "squash" | "rebase"; + merge_method?: 'merge' | 'squash' | 'rebase' } & { [key: string]: unknown }) - | null; - }; - }; - }; - "pulls/list-requested-reviewers": { + | null + } + } + } + 'pulls/list-requested-reviewers': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["pull-request-review-request"]; - }; - }; - }; - }; + 'application/json': components['schemas']['pull-request-review-request'] + } + } + } + } /** This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - "pulls/request-reviewers": { + 'pulls/request-reviewers': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["pull-request-simple"]; - }; - }; - 403: components["responses"]["forbidden"]; + 'application/json': components['schemas']['pull-request-simple'] + } + } + 403: components['responses']['forbidden'] /** Unprocessable Entity if user is not a collaborator */ - 422: unknown; - }; + 422: unknown + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description An array of user `login`s that will be requested. */ - reviewers?: string[]; + reviewers?: string[] /** @description An array of team `slug`s that will be requested. */ - team_reviewers?: string[]; - } & { [key: string]: unknown }; - }; - }; - }; - "pulls/remove-requested-reviewers": { + team_reviewers?: string[] + } & { [key: string]: unknown } + } + } + } + 'pulls/remove-requested-reviewers': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pull-request-simple"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['pull-request-simple'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description An array of user `login`s that will be removed. */ - reviewers: string[]; + reviewers: string[] /** @description An array of team `slug`s that will be removed. */ - team_reviewers?: string[]; - } & { [key: string]: unknown }; - }; - }; - }; + team_reviewers?: string[] + } & { [key: string]: unknown } + } + } + } /** The list of reviews returns in chronological order. */ - "pulls/list-reviews": { + 'pulls/list-reviews': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** The list of reviews returns in chronological order. */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["pull-request-review"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['pull-request-review'][] + } + } + } + } /** * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. * @@ -35671,638 +35635,638 @@ export interface operations { * * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. */ - "pulls/create-review": { + 'pulls/create-review': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pull-request-review"]; - }; - }; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': components['schemas']['pull-request-review'] + } + } + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value. */ - commit_id?: string; + commit_id?: string /** @description **Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review. */ - body?: string; + body?: string /** * @description The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/rest/reference/pulls#submit-a-review-for-a-pull-request) when you are ready. * @enum {string} */ - event?: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; + event?: 'APPROVE' | 'REQUEST_CHANGES' | 'COMMENT' /** @description Use the following table to specify the location, destination, and contents of the draft review comment. */ comments?: ({ /** @description The relative path to the file that necessitates a review comment. */ - path: string; + path: string /** @description The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below. */ - position?: number; + position?: number /** @description Text of the review comment. */ - body: string; + body: string /** @example 28 */ - line?: number; + line?: number /** @example RIGHT */ - side?: string; + side?: string /** @example 26 */ - start_line?: number; + start_line?: number /** @example LEFT */ - start_side?: string; - } & { [key: string]: unknown })[]; - } & { [key: string]: unknown }; - }; - }; - }; - "pulls/get-review": { - parameters: { - path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; + start_side?: string + } & { [key: string]: unknown })[] + } & { [key: string]: unknown } + } + } + } + 'pulls/get-review': { + parameters: { + path: { + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] /** review_id parameter */ - review_id: components["parameters"]["review-id"]; - }; - }; + review_id: components['parameters']['review-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pull-request-review"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['pull-request-review'] + } + } + 404: components['responses']['not_found'] + } + } /** Update the review summary comment with new text. */ - "pulls/update-review": { + 'pulls/update-review': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] /** review_id parameter */ - review_id: components["parameters"]["review-id"]; - }; - }; + review_id: components['parameters']['review-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pull-request-review"]; - }; - }; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': components['schemas']['pull-request-review'] + } + } + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The body text of the pull request review. */ - body: string; - } & { [key: string]: unknown }; - }; - }; - }; - "pulls/delete-pending-review": { + body: string + } & { [key: string]: unknown } + } + } + } + 'pulls/delete-pending-review': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] /** review_id parameter */ - review_id: components["parameters"]["review-id"]; - }; - }; + review_id: components['parameters']['review-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pull-request-review"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; - }; + 'application/json': components['schemas']['pull-request-review'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } + } /** List comments for a specific pull request review. */ - "pulls/list-comments-for-review": { + 'pulls/list-comments-for-review': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] /** review_id parameter */ - review_id: components["parameters"]["review-id"]; - }; + review_id: components['parameters']['review-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["review-comment"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['review-comment'][] + } + } + 404: components['responses']['not_found'] + } + } /** **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/reference/repos#branches), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. */ - "pulls/dismiss-review": { + 'pulls/dismiss-review': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] /** review_id parameter */ - review_id: components["parameters"]["review-id"]; - }; - }; + review_id: components['parameters']['review-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pull-request-review"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': components['schemas']['pull-request-review'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The message for the pull request review dismissal */ - message: string; + message: string /** @example "APPROVE" */ - event?: string; - } & { [key: string]: unknown }; - }; - }; - }; - "pulls/submit-review": { + event?: string + } & { [key: string]: unknown } + } + } + } + 'pulls/submit-review': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] /** review_id parameter */ - review_id: components["parameters"]["review-id"]; - }; - }; + review_id: components['parameters']['review-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pull-request-review"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': components['schemas']['pull-request-review'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The body text of the pull request review */ - body?: string; + body?: string /** * @description The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When you leave this blank, the API returns _HTTP 422 (Unrecognizable entity)_ and sets the review action state to `PENDING`, which means you will need to re-submit the pull request review using a review action. * @enum {string} */ - event: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; - } & { [key: string]: unknown }; - }; - }; - }; + event: 'APPROVE' | 'REQUEST_CHANGES' | 'COMMENT' + } & { [key: string]: unknown } + } + } + } /** Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. */ - "pulls/update-branch": { + 'pulls/update-branch': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } + } responses: { /** Response */ 202: { content: { - "application/json": { - message?: string; - url?: string; - } & { [key: string]: unknown }; - }; - }; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': { + message?: string + url?: string + } & { [key: string]: unknown } + } + } + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | ({ /** @description The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the "[List commits](https://docs.github.com/rest/reference/repos#list-commits)" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref. */ - expected_head_sha?: string; + expected_head_sha?: string } & { [key: string]: unknown }) - | null; - }; - }; - }; + | null + } + } + } /** * Gets the preferred README for a repository. * * READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. */ - "repos/get-readme": { + 'repos/get-readme': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`) */ - ref?: string; - }; - }; + ref?: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["content-file"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['content-file'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** * Gets the README from a repository directory. * * READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. */ - "repos/get-readme-in-directory": { + 'repos/get-readme-in-directory': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The alternate path to look for a README file */ - dir: string; - }; + dir: string + } query: { /** The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`) */ - ref?: string; - }; - }; + ref?: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["content-file"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['content-file'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** * This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/rest/reference/repos#list-repository-tags). * * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. */ - "repos/list-releases": { + 'repos/list-releases': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["release"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['release'][] + } + } + 404: components['responses']['not_found'] + } + } /** * Users with push access to the repository can create a release. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - "repos/create-release": { + 'repos/create-release': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; + Location?: string + } content: { - "application/json": components["schemas"]["release"]; - }; - }; + 'application/json': components['schemas']['release'] + } + } /** Not Found if the discussion category name is invalid */ 404: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['basic-error'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the tag. */ - tag_name: string; + tag_name: string /** @description Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`). */ - target_commitish?: string; + target_commitish?: string /** @description The name of the release. */ - name?: string; + name?: string /** @description Text describing the contents of the tag. */ - body?: string; + body?: string /** @description `true` to create a draft (unpublished) release, `false` to create a published one. */ - draft?: boolean; + draft?: boolean /** @description `true` to identify the release as a prerelease. `false` to identify the release as a full release. */ - prerelease?: boolean; + prerelease?: boolean /** @description If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see "[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." */ - discussion_category_name?: string; + discussion_category_name?: string /** @description Whether to automatically generate the name and body for this release. If `name` is specified, the specified name will be used; otherwise, a name will be automatically generated. If `body` is specified, the body will be pre-pended to the automatically generated notes. */ - generate_release_notes?: boolean; - } & { [key: string]: unknown }; - }; - }; - }; + generate_release_notes?: boolean + } & { [key: string]: unknown } + } + } + } /** To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. */ - "repos/get-release-asset": { + 'repos/get-release-asset': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** asset_id parameter */ - asset_id: components["parameters"]["asset-id"]; - }; - }; + asset_id: components['parameters']['asset-id'] + } + } responses: { /** To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. */ 200: { content: { - "application/json": components["schemas"]["release-asset"]; - }; - }; - 302: components["responses"]["found"]; - 404: components["responses"]["not_found"]; - 415: components["responses"]["preview_header_missing"]; - }; - }; - "repos/delete-release-asset": { + 'application/json': components['schemas']['release-asset'] + } + } + 302: components['responses']['found'] + 404: components['responses']['not_found'] + 415: components['responses']['preview_header_missing'] + } + } + 'repos/delete-release-asset': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** asset_id parameter */ - asset_id: components["parameters"]["asset-id"]; - }; - }; + asset_id: components['parameters']['asset-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** Users with push access to the repository can edit a release asset. */ - "repos/update-release-asset": { + 'repos/update-release-asset': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** asset_id parameter */ - asset_id: components["parameters"]["asset-id"]; - }; - }; + asset_id: components['parameters']['asset-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["release-asset"]; - }; - }; - }; + 'application/json': components['schemas']['release-asset'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The file name of the asset. */ - name?: string; + name?: string /** @description An alternate short description of the asset. Used in place of the filename. */ - label?: string; + label?: string /** @example "uploaded" */ - state?: string; - } & { [key: string]: unknown }; - }; - }; - }; + state?: string + } & { [key: string]: unknown } + } + } + } /** Generate a name and body describing a [release](https://docs.github.com/rest/reference/repos#releases). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. */ - "repos/generate-release-notes": { + 'repos/generate-release-notes': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Name and body of generated release notes */ 200: { content: { - "application/json": components["schemas"]["release-notes-content"]; - }; - }; - 404: components["responses"]["not_found"]; - }; + 'application/json': components['schemas']['release-notes-content'] + } + } + 404: components['responses']['not_found'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The tag name for the release. This can be an existing tag or a new one. */ - tag_name: string; + tag_name: string /** @description Specifies the commitish value that will be the target for the release's tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists. */ - target_commitish?: string; + target_commitish?: string /** @description The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release. */ - previous_tag_name?: string; + previous_tag_name?: string /** @description Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used. */ - configuration_file_path?: string; - } & { [key: string]: unknown }; - }; - }; - }; + configuration_file_path?: string + } & { [key: string]: unknown } + } + } + } /** * View the latest published full release for the repository. * * The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published. */ - "repos/get-latest-release": { + 'repos/get-latest-release': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["release"]; - }; - }; - }; - }; + 'application/json': components['schemas']['release'] + } + } + } + } /** Get a published release with the specified tag. */ - "repos/get-release-by-tag": { + 'repos/get-release-by-tag': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** tag parameter */ - tag: string; - }; - }; + tag: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["release"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['release'] + } + } + 404: components['responses']['not_found'] + } + } /** **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia). */ - "repos/get-release": { + 'repos/get-release': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** release_id parameter */ - release_id: components["parameters"]["release-id"]; - }; - }; + release_id: components['parameters']['release-id'] + } + } responses: { /** **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia). */ 200: { content: { - "application/json": components["schemas"]["release"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['release'] + } + } + 404: components['responses']['not_found'] + } + } /** Users with push access to the repository can delete a release. */ - "repos/delete-release": { + 'repos/delete-release': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** release_id parameter */ - release_id: components["parameters"]["release-id"]; - }; - }; + release_id: components['parameters']['release-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** Users with push access to the repository can edit a release. */ - "repos/update-release": { + 'repos/update-release': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** release_id parameter */ - release_id: components["parameters"]["release-id"]; - }; - }; + release_id: components['parameters']['release-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["release"]; - }; - }; + 'application/json': components['schemas']['release'] + } + } /** Not Found if the discussion category name is invalid */ 404: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the tag. */ - tag_name?: string; + tag_name?: string /** @description Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`). */ - target_commitish?: string; + target_commitish?: string /** @description The name of the release. */ - name?: string; + name?: string /** @description Text describing the contents of the tag. */ - body?: string; + body?: string /** @description `true` makes the release a draft, and `false` publishes the release. */ - draft?: boolean; + draft?: boolean /** @description `true` to identify the release as a prerelease, `false` to identify the release as a full release. */ - prerelease?: boolean; + prerelease?: boolean /** @description If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. If there is already a discussion linked to the release, this parameter is ignored. For more information, see "[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." */ - discussion_category_name?: string; - } & { [key: string]: unknown }; - }; - }; - }; - "repos/list-release-assets": { + discussion_category_name?: string + } & { [key: string]: unknown } + } + } + } + 'repos/list-release-assets': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** release_id parameter */ - release_id: components["parameters"]["release-id"]; - }; + release_id: components['parameters']['release-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["release-asset"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['release-asset'][] + } + } + } + } /** * This endpoint makes use of [a Hypermedia relation](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in * the response of the [Create a release endpoint](https://docs.github.com/rest/reference/repos#create-a-release) to upload a release asset. @@ -36323,276 +36287,277 @@ export interface operations { * endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). * * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. */ - "repos/upload-release-asset": { + 'repos/upload-release-asset': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** release_id parameter */ - release_id: components["parameters"]["release-id"]; - }; + release_id: components['parameters']['release-id'] + } query: { - name: string; - label?: string; - }; - }; + name: string + label?: string + } + } responses: { /** Response for successful upload */ 201: { content: { - "application/json": components["schemas"]["release-asset"]; - }; - }; + 'application/json': components['schemas']['release-asset'] + } + } /** Response if you upload an asset with the same filename as another uploaded asset */ - 422: unknown; - }; + 422: unknown + } requestBody: { content: { - "*/*": string; - }; - }; - }; + '*/*': string + } + } + } /** Create a reaction to a [release](https://docs.github.com/rest/reference/repos#releases). A response with a `Status: 200 OK` means that you already added the reaction type to this release. */ - "reactions/create-for-release": { + 'reactions/create-for-release': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** release_id parameter */ - release_id: components["parameters"]["release-id"]; - }; - }; + release_id: components['parameters']['release-id'] + } + } responses: { /** Reaction exists */ 200: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; + 'application/json': components['schemas']['reaction'] + } + } /** Reaction created */ 201: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['reaction'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the release. * @enum {string} */ - content: "+1" | "laugh" | "heart" | "hooray" | "rocket" | "eyes"; - } & { [key: string]: unknown }; - }; - }; - }; + content: '+1' | 'laugh' | 'heart' | 'hooray' | 'rocket' | 'eyes' + } & { [key: string]: unknown } + } + } + } /** * Lists secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. */ - "secret-scanning/list-alerts-for-repo": { + 'secret-scanning/list-alerts-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - state?: components["parameters"]["secret-scanning-alert-state"]; + state?: components['parameters']['secret-scanning-alert-state'] /** * A comma-separated list of secret types to return. By default all secret types are returned. * See "[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)" * for a complete list of secret types (API slug). */ - secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; + secret_type?: components['parameters']['secret-scanning-alert-secret-type'] /** A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - resolution?: components["parameters"]["secret-scanning-alert-resolution"]; + resolution?: components['parameters']['secret-scanning-alert-resolution'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["secret-scanning-alert"][]; - }; - }; + 'application/json': components['schemas']['secret-scanning-alert'][] + } + } /** Repository is public or secret scanning is disabled for the repository */ - 404: unknown; - 503: components["responses"]["service_unavailable"]; - }; - }; + 404: unknown + 503: components['responses']['service_unavailable'] + } + } /** * Gets a single secret scanning alert detected in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. */ - "secret-scanning/get-alert": { + 'secret-scanning/get-alert': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ - alert_number: components["parameters"]["alert-number"]; - }; - }; + alert_number: components['parameters']['alert-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["secret-scanning-alert"]; - }; - }; - 304: components["responses"]["not_modified"]; + 'application/json': components['schemas']['secret-scanning-alert'] + } + } + 304: components['responses']['not_modified'] /** Repository is public, or secret scanning is disabled for the repository, or the resource is not found */ - 404: unknown; - 503: components["responses"]["service_unavailable"]; - }; - }; + 404: unknown + 503: components['responses']['service_unavailable'] + } + } /** * Updates the status of a secret scanning alert in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint. */ - "secret-scanning/update-alert": { + 'secret-scanning/update-alert': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ - alert_number: components["parameters"]["alert-number"]; - }; - }; + alert_number: components['parameters']['alert-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["secret-scanning-alert"]; - }; - }; + 'application/json': components['schemas']['secret-scanning-alert'] + } + } /** Repository is public, or secret scanning is disabled for the repository, or the resource is not found */ - 404: unknown; + 404: unknown /** State does not match the resolution */ - 422: unknown; - 503: components["responses"]["service_unavailable"]; - }; + 422: unknown + 503: components['responses']['service_unavailable'] + } requestBody: { content: { - "application/json": { - state: components["schemas"]["secret-scanning-alert-state"]; - resolution?: components["schemas"]["secret-scanning-alert-resolution"]; - } & { [key: string]: unknown }; - }; - }; - }; + 'application/json': { + state: components['schemas']['secret-scanning-alert-state'] + resolution?: components['schemas']['secret-scanning-alert-resolution'] + } & { [key: string]: unknown } + } + } + } /** * Lists all locations for a given secret scanning alert for a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. */ - "secret-scanning/list-locations-for-alert": { + 'secret-scanning/list-locations-for-alert': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ - alert_number: components["parameters"]["alert-number"]; - }; + alert_number: components['parameters']['alert-number'] + } query: { /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["secret-scanning-location"][]; - }; - }; + 'application/json': components['schemas']['secret-scanning-location'][] + } + } /** Repository is public, or secret scanning is disabled for the repository, or the resource is not found */ - 404: unknown; - 503: components["responses"]["service_unavailable"]; - }; - }; + 404: unknown + 503: components['responses']['service_unavailable'] + } + } /** * Lists the people that have starred the repository. * * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: */ - "activity/list-stargazers-for-repo": { + 'activity/list-stargazers-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": (Partial & - Partial) & { [key: string]: unknown }; - }; - }; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': (Partial & Partial) & { + [key: string]: unknown + } + } + } + 422: components['responses']['validation_failed'] + } + } /** Returns a weekly aggregate of the number of additions and deletions pushed to a repository. */ - "repos/get-code-frequency-stats": { + 'repos/get-code-frequency-stats': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Returns a weekly aggregate of the number of additions and deletions pushed to a repository. */ 200: { content: { - "application/json": components["schemas"]["code-frequency-stat"][]; - }; - }; - 202: components["responses"]["accepted"]; - 204: components["responses"]["no_content"]; - }; - }; + 'application/json': components['schemas']['code-frequency-stat'][] + } + } + 202: components['responses']['accepted'] + 204: components['responses']['no_content'] + } + } /** Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`. */ - "repos/get-commit-activity-stats": { + 'repos/get-commit-activity-stats': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["commit-activity"][]; - }; - }; - 202: components["responses"]["accepted"]; - 204: components["responses"]["no_content"]; - }; - }; + 'application/json': components['schemas']['commit-activity'][] + } + } + 202: components['responses']['accepted'] + 204: components['responses']['no_content'] + } + } /** * Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information: * @@ -36601,13 +36566,13 @@ export interface operations { * * `d` - Number of deletions * * `c` - Number of commits */ - "repos/get-contributors-stats": { + 'repos/get-contributors-stats': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** * * `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time). @@ -36617,35 +36582,35 @@ export interface operations { */ 200: { content: { - "application/json": components["schemas"]["contributor-activity"][]; - }; - }; - 202: components["responses"]["accepted"]; - 204: components["responses"]["no_content"]; - }; - }; + 'application/json': components['schemas']['contributor-activity'][] + } + } + 202: components['responses']['accepted'] + 204: components['responses']['no_content'] + } + } /** * Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`. * * The array order is oldest week (index 0) to most recent week. */ - "repos/get-participation-stats": { + 'repos/get-participation-stats': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** The array order is oldest week (index 0) to most recent week. */ 200: { content: { - "application/json": components["schemas"]["participation-stats"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['participation-stats'] + } + } + 404: components['responses']['not_found'] + } + } /** * Each array contains the day number, hour number, and number of commits: * @@ -36655,436 +36620,436 @@ export interface operations { * * For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. */ - "repos/get-punch-card-stats": { + 'repos/get-punch-card-stats': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. */ 200: { content: { - "application/json": components["schemas"]["code-frequency-stat"][]; - }; - }; - 204: components["responses"]["no_content"]; - }; - }; + 'application/json': components['schemas']['code-frequency-stat'][] + } + } + 204: components['responses']['no_content'] + } + } /** * Users with push access in a repository can create commit statuses for a given SHA. * * Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error. */ - "repos/create-commit-status": { + 'repos/create-commit-status': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - sha: string; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + sha: string + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; + Location?: string + } content: { - "application/json": components["schemas"]["status"]; - }; - }; - }; + 'application/json': components['schemas']['status'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The state of the status. Can be one of `error`, `failure`, `pending`, or `success`. * @enum {string} */ - state: "error" | "failure" | "pending" | "success"; + state: 'error' | 'failure' | 'pending' | 'success' /** * @description The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. * For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: * `http://ci.example.com/user/repo/build/sha` */ - target_url?: string; + target_url?: string /** @description A short description of the status. */ - description?: string; + description?: string /** * @description A string label to differentiate this status from the status of other systems. This field is case-insensitive. * @default default */ - context?: string; - } & { [key: string]: unknown }; - }; - }; - }; + context?: string + } & { [key: string]: unknown } + } + } + } /** Lists the people watching the specified repository. */ - "activity/list-watchers-for-repo": { + 'activity/list-watchers-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - }; - }; - "activity/get-repo-subscription": { + 'application/json': components['schemas']['simple-user'][] + } + } + } + } + 'activity/get-repo-subscription': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** if you subscribe to the repository */ 200: { content: { - "application/json": components["schemas"]["repository-subscription"]; - }; - }; - 403: components["responses"]["forbidden"]; + 'application/json': components['schemas']['repository-subscription'] + } + } + 403: components['responses']['forbidden'] /** Not Found if you don't subscribe to the repository */ - 404: unknown; - }; - }; + 404: unknown + } + } /** If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/rest/reference/activity#delete-a-repository-subscription) completely. */ - "activity/set-repo-subscription": { + 'activity/set-repo-subscription': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["repository-subscription"]; - }; - }; - }; + 'application/json': components['schemas']['repository-subscription'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Determines if notifications should be received from this repository. */ - subscribed?: boolean; + subscribed?: boolean /** @description Determines if all notifications should be blocked from this repository. */ - ignored?: boolean; - } & { [key: string]: unknown }; - }; - }; - }; + ignored?: boolean + } & { [key: string]: unknown } + } + } + } /** This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/rest/reference/activity#set-a-repository-subscription). */ - "activity/delete-repo-subscription": { + 'activity/delete-repo-subscription': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; - }; - "repos/list-tags": { + 204: never + } + } + 'repos/list-tags': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["tag"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['tag'][] + } + } + } + } /** * Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually * `master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. * **Note**: For private repositories, these links are temporary and expire after five minutes. */ - "repos/download-tarball-archive": { + 'repos/download-tarball-archive': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - ref: string; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + ref: string + } + } responses: { /** Response */ - 302: never; - }; - }; - "repos/list-teams": { + 302: never + } + } + 'repos/list-teams': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team"][]; - }; - }; - }; - }; - "repos/get-all-topics": { + 'application/json': components['schemas']['team'][] + } + } + } + } + 'repos/get-all-topics': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["topic"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "repos/replace-all-topics": { + 'application/json': components['schemas']['topic'] + } + } + 404: components['responses']['not_found'] + } + } + 'repos/replace-all-topics': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["topic"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': components['schemas']['topic'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters. */ - names: string[]; - } & { [key: string]: unknown }; - }; - }; - }; + names: string[] + } & { [key: string]: unknown } + } + } + } /** Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. */ - "repos/get-clones": { + 'repos/get-clones': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Must be one of: `day`, `week`. */ - per?: components["parameters"]["per"]; - }; - }; + per?: components['parameters']['per'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["clone-traffic"]; - }; - }; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['clone-traffic'] + } + } + 403: components['responses']['forbidden'] + } + } /** Get the top 10 popular contents over the last 14 days. */ - "repos/get-top-paths": { + 'repos/get-top-paths': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["content-traffic"][]; - }; - }; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['content-traffic'][] + } + } + 403: components['responses']['forbidden'] + } + } /** Get the top 10 referrers over the last 14 days. */ - "repos/get-top-referrers": { + 'repos/get-top-referrers': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["referrer-traffic"][]; - }; - }; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['referrer-traffic'][] + } + } + 403: components['responses']['forbidden'] + } + } /** Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. */ - "repos/get-views": { + 'repos/get-views': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Must be one of: `day`, `week`. */ - per?: components["parameters"]["per"]; - }; - }; + per?: components['parameters']['per'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["view-traffic"]; - }; - }; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['view-traffic'] + } + } + 403: components['responses']['forbidden'] + } + } /** A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/). */ - "repos/transfer": { + 'repos/transfer': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 202: { content: { - "application/json": components["schemas"]["minimal-repository"]; - }; - }; - }; + 'application/json': components['schemas']['minimal-repository'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The username or organization name the repository will be transferred to. */ - new_owner: string; + new_owner: string /** @description ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories. */ - team_ids?: number[]; - } & { [key: string]: unknown }; - }; - }; - }; + team_ids?: number[] + } & { [key: string]: unknown } + } + } + } /** Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". */ - "repos/check-vulnerability-alerts": { + 'repos/check-vulnerability-alerts': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response if repository is enabled with vulnerability alerts */ - 204: never; + 204: never /** Not Found if repository is not enabled with vulnerability alerts */ - 404: unknown; - }; - }; + 404: unknown + } + } /** Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". */ - "repos/enable-vulnerability-alerts": { + 'repos/enable-vulnerability-alerts': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". */ - "repos/disable-vulnerability-alerts": { + 'repos/disable-vulnerability-alerts': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually * `master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. * **Note**: For private repositories, these links are temporary and expire after five minutes. */ - "repos/download-zipball-archive": { + 'repos/download-zipball-archive': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - ref: string; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + ref: string + } + } responses: { /** Response */ - 302: never; - }; - }; + 302: never + } + } /** * Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. * @@ -37095,41 +37060,41 @@ export interface operations { * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. * * `repo` scope to create a private repository */ - "repos/create-using-template": { + 'repos/create-using-template': { parameters: { path: { - template_owner: string; - template_repo: string; - }; - }; + template_owner: string + template_repo: string + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; + Location?: string + } content: { - "application/json": components["schemas"]["repository"]; - }; - }; - }; + 'application/json': components['schemas']['repository'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization. */ - owner?: string; + owner?: string /** @description The name of the new repository. */ - name: string; + name: string /** @description A short description of the new repository. */ - description?: string; + description?: string /** @description Set to `true` to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: `false`. */ - include_all_branches?: boolean; + include_all_branches?: boolean /** @description Either `true` to create a new private repository or `false` to create a new public one. */ - private?: boolean; - } & { [key: string]: unknown }; - }; - }; - }; + private?: boolean + } & { [key: string]: unknown } + } + } + } /** * Lists all public repositories in the order that they were created. * @@ -37137,93 +37102,93 @@ export interface operations { * - For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories. */ - "repos/list-public": { + 'repos/list-public': { parameters: { query: { /** A repository ID. Only return repositories with an ID greater than this ID. */ - since?: components["parameters"]["since-repo"]; - }; - }; + since?: components['parameters']['since-repo'] + } + } responses: { /** Response */ 200: { headers: { - Link?: string; - }; - content: { - "application/json": components["schemas"]["minimal-repository"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 422: components["responses"]["validation_failed"]; - }; - }; + Link?: string + } + content: { + 'application/json': components['schemas']['minimal-repository'][] + } + } + 304: components['responses']['not_modified'] + 422: components['responses']['validation_failed'] + } + } /** Lists all secrets available in an environment without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - "actions/list-environment-secrets": { + 'actions/list-environment-secrets': { parameters: { path: { - repository_id: components["parameters"]["repository-id"]; + repository_id: components['parameters']['repository-id'] /** The name of the environment */ - environment_name: components["parameters"]["environment-name"]; - }; + environment_name: components['parameters']['environment-name'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - secrets: components["schemas"]["actions-secret"][]; - } & { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': { + total_count: number + secrets: components['schemas']['actions-secret'][] + } & { [key: string]: unknown } + } + } + } + } /** Get the public key for an environment, which you need to encrypt environment secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - "actions/get-environment-public-key": { + 'actions/get-environment-public-key': { parameters: { path: { - repository_id: components["parameters"]["repository-id"]; + repository_id: components['parameters']['repository-id'] /** The name of the environment */ - environment_name: components["parameters"]["environment-name"]; - }; - }; + environment_name: components['parameters']['environment-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-public-key"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-public-key'] + } + } + } + } /** Gets a single environment secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - "actions/get-environment-secret": { + 'actions/get-environment-secret': { parameters: { path: { - repository_id: components["parameters"]["repository-id"]; + repository_id: components['parameters']['repository-id'] /** The name of the environment */ - environment_name: components["parameters"]["environment-name"]; + environment_name: components['parameters']['environment-name'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-secret"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-secret'] + } + } + } + } /** * Creates or updates an environment secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -37301,229 +37266,229 @@ export interface operations { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - "actions/create-or-update-environment-secret": { + 'actions/create-or-update-environment-secret': { parameters: { path: { - repository_id: components["parameters"]["repository-id"]; + repository_id: components['parameters']['repository-id'] /** The name of the environment */ - environment_name: components["parameters"]["environment-name"]; + environment_name: components['parameters']['environment-name'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response when creating a secret */ 201: { content: { - "application/json": components["schemas"]["empty-object"]; - }; - }; + 'application/json': components['schemas']['empty-object'] + } + } /** Response when updating a secret */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/reference/actions#get-an-environment-public-key) endpoint. */ - encrypted_value: string; + encrypted_value: string /** @description ID of the key you used to encrypt the secret. */ - key_id: string; - } & { [key: string]: unknown }; - }; - }; - }; + key_id: string + } & { [key: string]: unknown } + } + } + } /** Deletes a secret in an environment using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - "actions/delete-environment-secret": { + 'actions/delete-environment-secret': { parameters: { path: { - repository_id: components["parameters"]["repository-id"]; + repository_id: components['parameters']['repository-id'] /** The name of the environment */ - environment_name: components["parameters"]["environment-name"]; + environment_name: components['parameters']['environment-name'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Default response */ - 204: never; - }; - }; + 204: never + } + } /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - "enterprise-admin/list-provisioned-groups-enterprise": { + 'enterprise-admin/list-provisioned-groups-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; + enterprise: components['parameters']['enterprise'] + } query: { /** Used for pagination: the index of the first result to return. */ - startIndex?: components["parameters"]["start-index"]; + startIndex?: components['parameters']['start-index'] /** Used for pagination: the number of results to return. */ - count?: components["parameters"]["count"]; + count?: components['parameters']['count'] /** filter results */ - filter?: string; + filter?: string /** attributes to exclude */ - excludedAttributes?: string; - }; - }; + excludedAttributes?: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["scim-group-list-enterprise"]; - }; - }; - }; - }; + 'application/json': components['schemas']['scim-group-list-enterprise'] + } + } + } + } /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * * Provision an enterprise group, and invite users to the group. This sends invitation emails to the email address of the invited users to join the GitHub organization that the SCIM group corresponds to. */ - "enterprise-admin/provision-and-invite-enterprise-group": { + 'enterprise-admin/provision-and-invite-enterprise-group': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["scim-enterprise-group"]; - }; - }; - }; + 'application/json': components['schemas']['scim-enterprise-group'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The SCIM schema URIs. */ - schemas: string[]; + schemas: string[] /** @description The name of the SCIM group. This must match the GitHub organization that the group maps to. */ - displayName: string; + displayName: string members?: ({ /** @description The SCIM user ID for a user. */ - value: string; - } & { [key: string]: unknown })[]; - } & { [key: string]: unknown }; - }; - }; - }; + value: string + } & { [key: string]: unknown })[] + } & { [key: string]: unknown } + } + } + } /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - "enterprise-admin/get-provisioning-information-for-enterprise-group": { + 'enterprise-admin/get-provisioning-information-for-enterprise-group': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Identifier generated by the GitHub SCIM endpoint. */ - scim_group_id: components["parameters"]["scim-group-id"]; - }; + scim_group_id: components['parameters']['scim-group-id'] + } query: { /** Attributes to exclude. */ - excludedAttributes?: string; - }; - }; + excludedAttributes?: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["scim-enterprise-group"]; - }; - }; - }; - }; + 'application/json': components['schemas']['scim-enterprise-group'] + } + } + } + } /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * * Replaces an existing provisioned group’s information. You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead. */ - "enterprise-admin/set-information-for-provisioned-enterprise-group": { + 'enterprise-admin/set-information-for-provisioned-enterprise-group': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Identifier generated by the GitHub SCIM endpoint. */ - scim_group_id: components["parameters"]["scim-group-id"]; - }; - }; + scim_group_id: components['parameters']['scim-group-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["scim-enterprise-group"]; - }; - }; - }; + 'application/json': components['schemas']['scim-enterprise-group'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The SCIM schema URIs. */ - schemas: string[]; + schemas: string[] /** @description The name of the SCIM group. This must match the GitHub organization that the group maps to. */ - displayName: string; + displayName: string members?: ({ /** @description The SCIM user ID for a user. */ - value: string; - } & { [key: string]: unknown })[]; - } & { [key: string]: unknown }; - }; - }; - }; + value: string + } & { [key: string]: unknown })[] + } & { [key: string]: unknown } + } + } + } /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - "enterprise-admin/delete-scim-group-from-enterprise": { + 'enterprise-admin/delete-scim-group-from-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Identifier generated by the GitHub SCIM endpoint. */ - scim_group_id: components["parameters"]["scim-group-id"]; - }; - }; + scim_group_id: components['parameters']['scim-group-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * * Allows you to change a provisioned group’s individual attributes. To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). */ - "enterprise-admin/update-attribute-for-enterprise-group": { + 'enterprise-admin/update-attribute-for-enterprise-group': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Identifier generated by the GitHub SCIM endpoint. */ - scim_group_id: components["parameters"]["scim-group-id"]; - }; - }; + scim_group_id: components['parameters']['scim-group-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["scim-enterprise-group"]; - }; - }; - }; + 'application/json': components['schemas']['scim-enterprise-group'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The SCIM schema URIs. */ - schemas: string[]; + schemas: string[] /** @description Array of [SCIM operations](https://tools.ietf.org/html/rfc7644#section-3.5.2). */ Operations: ({ /** @enum {string} */ - op: "add" | "Add" | "remove" | "Remove" | "replace" | "Replace"; - path?: string; + op: 'add' | 'Add' | 'remove' | 'Remove' | 'replace' | 'Replace' + path?: string /** @description Can be any value - string, number, array or object. */ - value?: unknown; - } & { [key: string]: unknown })[]; - } & { [key: string]: unknown }; - }; - }; - }; + value?: unknown + } & { [key: string]: unknown })[] + } & { [key: string]: unknown } + } + } + } /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * @@ -37544,30 +37509,30 @@ export interface operations { * - If the user signs in, their GitHub account is linked to this entry. * - If the user does not sign in (or does not create a new account when prompted), they are not added to the GitHub enterprise, and the external identity `null` entry remains in place. */ - "enterprise-admin/list-provisioned-identities-enterprise": { + 'enterprise-admin/list-provisioned-identities-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; + enterprise: components['parameters']['enterprise'] + } query: { /** Used for pagination: the index of the first result to return. */ - startIndex?: components["parameters"]["start-index"]; + startIndex?: components['parameters']['start-index'] /** Used for pagination: the number of results to return. */ - count?: components["parameters"]["count"]; + count?: components['parameters']['count'] /** filter results */ - filter?: string; - }; - }; + filter?: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["scim-user-list-enterprise"]; - }; - }; - }; - }; + 'application/json': components['schemas']['scim-user-list-enterprise'] + } + } + } + } /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * @@ -37575,70 +37540,70 @@ export interface operations { * * You can optionally include the groups a user will be invited to join. If you do not provide a list of `groups`, the user is provisioned for the enterprise, but no organization invitation emails will be sent. */ - "enterprise-admin/provision-and-invite-enterprise-user": { + 'enterprise-admin/provision-and-invite-enterprise-user': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["scim-enterprise-user"]; - }; - }; - }; + 'application/json': components['schemas']['scim-enterprise-user'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The SCIM schema URIs. */ - schemas: string[]; + schemas: string[] /** @description The username for the user. */ - userName: string; + userName: string name: { /** @description The first name of the user. */ - givenName: string; + givenName: string /** @description The last name of the user. */ - familyName: string; - } & { [key: string]: unknown }; + familyName: string + } & { [key: string]: unknown } /** @description List of user emails. */ emails: ({ /** @description The email address. */ - value: string; + value: string /** @description The type of email address. */ - type: string; + type: string /** @description Whether this email address is the primary address. */ - primary: boolean; - } & { [key: string]: unknown })[]; + primary: boolean + } & { [key: string]: unknown })[] /** @description List of SCIM group IDs the user is a member of. */ groups?: ({ - value?: string; - } & { [key: string]: unknown })[]; - } & { [key: string]: unknown }; - }; - }; - }; + value?: string + } & { [key: string]: unknown })[] + } & { [key: string]: unknown } + } + } + } /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - "enterprise-admin/get-provisioning-information-for-enterprise-user": { + 'enterprise-admin/get-provisioning-information-for-enterprise-user': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** scim_user_id parameter */ - scim_user_id: components["parameters"]["scim-user-id"]; - }; - }; + scim_user_id: components['parameters']['scim-user-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["scim-enterprise-user"]; - }; - }; - }; - }; + 'application/json': components['schemas']['scim-enterprise-user'] + } + } + } + } /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * @@ -37648,68 +37613,68 @@ export interface operations { * * **Warning:** Setting `active: false` removes the user from the enterprise, deletes the external identity, and deletes the associated `{scim_user_id}`. */ - "enterprise-admin/set-information-for-provisioned-enterprise-user": { + 'enterprise-admin/set-information-for-provisioned-enterprise-user': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** scim_user_id parameter */ - scim_user_id: components["parameters"]["scim-user-id"]; - }; - }; + scim_user_id: components['parameters']['scim-user-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["scim-enterprise-user"]; - }; - }; - }; + 'application/json': components['schemas']['scim-enterprise-user'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The SCIM schema URIs. */ - schemas: string[]; + schemas: string[] /** @description The username for the user. */ - userName: string; + userName: string name: { /** @description The first name of the user. */ - givenName: string; + givenName: string /** @description The last name of the user. */ - familyName: string; - } & { [key: string]: unknown }; + familyName: string + } & { [key: string]: unknown } /** @description List of user emails. */ emails: ({ /** @description The email address. */ - value: string; + value: string /** @description The type of email address. */ - type: string; + type: string /** @description Whether this email address is the primary address. */ - primary: boolean; - } & { [key: string]: unknown })[]; + primary: boolean + } & { [key: string]: unknown })[] /** @description List of SCIM group IDs the user is a member of. */ groups?: ({ - value?: string; - } & { [key: string]: unknown })[]; - } & { [key: string]: unknown }; - }; - }; - }; + value?: string + } & { [key: string]: unknown })[] + } & { [key: string]: unknown } + } + } + } /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - "enterprise-admin/delete-user-from-enterprise": { + 'enterprise-admin/delete-user-from-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** scim_user_id parameter */ - scim_user_id: components["parameters"]["scim-user-id"]; - }; - }; + scim_user_id: components['parameters']['scim-user-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * @@ -37730,34 +37695,34 @@ export interface operations { * } * ``` */ - "enterprise-admin/update-attribute-for-enterprise-user": { + 'enterprise-admin/update-attribute-for-enterprise-user': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** scim_user_id parameter */ - scim_user_id: components["parameters"]["scim-user-id"]; - }; - }; + scim_user_id: components['parameters']['scim-user-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["scim-enterprise-user"]; - }; - }; - }; + 'application/json': components['schemas']['scim-enterprise-user'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The SCIM schema URIs. */ - schemas: string[]; + schemas: string[] /** @description Array of [SCIM operations](https://tools.ietf.org/html/rfc7644#section-3.5.2). */ - Operations: { [key: string]: unknown }[]; - } & { [key: string]: unknown }; - }; - }; - }; + Operations: { [key: string]: unknown }[] + } & { [key: string]: unknown } + } + } + } /** * Retrieves a paginated list of all provisioned organization members, including pending invitations. If you provide the `filter` parameter, the resources for all matching provisions members are returned. * @@ -37776,16 +37741,16 @@ export interface operations { * - If the user signs in, their GitHub account is linked to this entry. * - If the user does not sign in (or does not create a new account when prompted), they are not added to the GitHub organization, and the external identity `null` entry remains in place. */ - "scim/list-provisioned-identities": { + 'scim/list-provisioned-identities': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Used for pagination: the index of the first result to return. */ - startIndex?: number; + startIndex?: number /** Used for pagination: the number of results to return. */ - count?: number; + count?: number /** * Filters results using the equals query parameter operator (`eq`). You can filter results that are equal to `id`, `userName`, `emails`, and `external_id`. For example, to search for an identity with the `userName` Octocat, you would use this query: * @@ -37795,99 +37760,99 @@ export interface operations { * * `?filter=emails%20eq%20\"octocat@github.com\"`. */ - filter?: string; - }; - }; + filter?: string + } + } responses: { /** Response */ 200: { content: { - "application/scim+json": components["schemas"]["scim-user-list"]; - }; - }; - 304: components["responses"]["not_modified"]; - 400: components["responses"]["scim_bad_request"]; - 403: components["responses"]["scim_forbidden"]; - 404: components["responses"]["scim_not_found"]; - }; - }; + 'application/scim+json': components['schemas']['scim-user-list'] + } + } + 304: components['responses']['not_modified'] + 400: components['responses']['scim_bad_request'] + 403: components['responses']['scim_forbidden'] + 404: components['responses']['scim_not_found'] + } + } /** Provision organization membership for a user, and send an activation email to the email address. */ - "scim/provision-and-invite-user": { + 'scim/provision-and-invite-user': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 201: { content: { - "application/scim+json": components["schemas"]["scim-user"]; - }; - }; - 304: components["responses"]["not_modified"]; - 400: components["responses"]["scim_bad_request"]; - 403: components["responses"]["scim_forbidden"]; - 404: components["responses"]["scim_not_found"]; - 409: components["responses"]["scim_conflict"]; - 500: components["responses"]["scim_internal_error"]; - }; + 'application/scim+json': components['schemas']['scim-user'] + } + } + 304: components['responses']['not_modified'] + 400: components['responses']['scim_bad_request'] + 403: components['responses']['scim_forbidden'] + 404: components['responses']['scim_not_found'] + 409: components['responses']['scim_conflict'] + 500: components['responses']['scim_internal_error'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description Configured by the admin. Could be an email, login, or username * @example someone@example.com */ - userName: string; + userName: string /** * @description The name of the user, suitable for display to end-users * @example Jon Doe */ - displayName?: string; + displayName?: string /** @example [object Object] */ name: { - givenName: string; - familyName: string; - formatted?: string; - } & { [key: string]: unknown }; + givenName: string + familyName: string + formatted?: string + } & { [key: string]: unknown } /** * @description user emails * @example [object Object],[object Object] */ emails: ({ - value: string; - primary?: boolean; - type?: string; - } & { [key: string]: unknown })[]; - schemas?: string[]; - externalId?: string; - groups?: string[]; - active?: boolean; - } & { [key: string]: unknown }; - }; - }; - }; - "scim/get-provisioning-information-for-user": { - parameters: { - path: { - org: components["parameters"]["org"]; + value: string + primary?: boolean + type?: string + } & { [key: string]: unknown })[] + schemas?: string[] + externalId?: string + groups?: string[] + active?: boolean + } & { [key: string]: unknown } + } + } + } + 'scim/get-provisioning-information-for-user': { + parameters: { + path: { + org: components['parameters']['org'] /** scim_user_id parameter */ - scim_user_id: components["parameters"]["scim-user-id"]; - }; - }; + scim_user_id: components['parameters']['scim-user-id'] + } + } responses: { /** Response */ 200: { content: { - "application/scim+json": components["schemas"]["scim-user"]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["scim_forbidden"]; - 404: components["responses"]["scim_not_found"]; - }; - }; + 'application/scim+json': components['schemas']['scim-user'] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['scim_forbidden'] + 404: components['responses']['scim_not_found'] + } + } /** * Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](https://docs.github.com/rest/reference/scim#update-an-attribute-for-a-scim-user) endpoint instead. * @@ -37895,77 +37860,77 @@ export interface operations { * * **Warning:** Setting `active: false` removes the user from the organization, deletes the external identity, and deletes the associated `{scim_user_id}`. */ - "scim/set-information-for-provisioned-user": { + 'scim/set-information-for-provisioned-user': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** scim_user_id parameter */ - scim_user_id: components["parameters"]["scim-user-id"]; - }; - }; + scim_user_id: components['parameters']['scim-user-id'] + } + } responses: { /** Response */ 200: { content: { - "application/scim+json": components["schemas"]["scim-user"]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["scim_forbidden"]; - 404: components["responses"]["scim_not_found"]; - }; + 'application/scim+json': components['schemas']['scim-user'] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['scim_forbidden'] + 404: components['responses']['scim_not_found'] + } requestBody: { content: { - "application/json": { - schemas?: string[]; + 'application/json': { + schemas?: string[] /** * @description The name of the user, suitable for display to end-users * @example Jon Doe */ - displayName?: string; - externalId?: string; - groups?: string[]; - active?: boolean; + displayName?: string + externalId?: string + groups?: string[] + active?: boolean /** * @description Configured by the admin. Could be an email, login, or username * @example someone@example.com */ - userName: string; + userName: string /** @example [object Object] */ name: { - givenName: string; - familyName: string; - formatted?: string; - } & { [key: string]: unknown }; + givenName: string + familyName: string + formatted?: string + } & { [key: string]: unknown } /** * @description user emails * @example [object Object],[object Object] */ emails: ({ - type?: string; - value: string; - primary?: boolean; - } & { [key: string]: unknown })[]; - } & { [key: string]: unknown }; - }; - }; - }; - "scim/delete-user-from-org": { - parameters: { - path: { - org: components["parameters"]["org"]; + type?: string + value: string + primary?: boolean + } & { [key: string]: unknown })[] + } & { [key: string]: unknown } + } + } + } + 'scim/delete-user-from-org': { + parameters: { + path: { + org: components['parameters']['org'] /** scim_user_id parameter */ - scim_user_id: components["parameters"]["scim-user-id"]; - }; - }; + scim_user_id: components['parameters']['scim-user-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["scim_forbidden"]; - 404: components["responses"]["scim_not_found"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 403: components['responses']['scim_forbidden'] + 404: components['responses']['scim_not_found'] + } + } /** * Allows you to change a provisioned user's individual attributes. To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). * @@ -37984,63 +37949,63 @@ export interface operations { * } * ``` */ - "scim/update-attribute-for-user": { + 'scim/update-attribute-for-user': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** scim_user_id parameter */ - scim_user_id: components["parameters"]["scim-user-id"]; - }; - }; + scim_user_id: components['parameters']['scim-user-id'] + } + } responses: { /** Response */ 200: { content: { - "application/scim+json": components["schemas"]["scim-user"]; - }; - }; - 304: components["responses"]["not_modified"]; - 400: components["responses"]["scim_bad_request"]; - 403: components["responses"]["scim_forbidden"]; - 404: components["responses"]["scim_not_found"]; + 'application/scim+json': components['schemas']['scim-user'] + } + } + 304: components['responses']['not_modified'] + 400: components['responses']['scim_bad_request'] + 403: components['responses']['scim_forbidden'] + 404: components['responses']['scim_not_found'] /** Response */ 429: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } + } requestBody: { content: { - "application/json": { - schemas?: string[]; + 'application/json': { + schemas?: string[] /** * @description Set of operations to be performed * @example [object Object] */ Operations: ({ /** @enum {string} */ - op: "add" | "remove" | "replace"; - path?: string; + op: 'add' | 'remove' | 'replace' + path?: string value?: ( | ({ - active?: boolean | null; - userName?: string | null; - externalId?: string | null; - givenName?: string | null; - familyName?: string | null; + active?: boolean | null + userName?: string | null + externalId?: string | null + givenName?: string | null + familyName?: string | null } & { [key: string]: unknown }) | ({ - value?: string; - primary?: boolean; + value?: string + primary?: boolean } & { [key: string]: unknown })[] | string - ) & { [key: string]: unknown }; - } & { [key: string]: unknown })[]; - } & { [key: string]: unknown }; - }; - }; - }; + ) & { [key: string]: unknown } + } & { [key: string]: unknown })[] + } & { [key: string]: unknown } + } + } + } /** * Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -38061,38 +38026,38 @@ export interface operations { * * You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing * language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. */ - "search/code": { + 'search/code': { parameters: { query: { /** The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching code](https://docs.github.com/articles/searching-code/)" for a detailed list of qualifiers. */ - q: string; + q: string /** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */ - sort?: "indexed"; + sort?: 'indexed' /** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - order?: components["parameters"]["order"]; + order?: components['parameters']['order'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - incomplete_results: boolean; - items: components["schemas"]["code-search-result-item"][]; - } & { [key: string]: unknown }; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': { + total_count: number + incomplete_results: boolean + items: components['schemas']['code-search-result-item'][] + } & { [key: string]: unknown } + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + 503: components['responses']['service_unavailable'] + } + } /** * Find commits via various criteria on the default branch (usually `master`). This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -38103,35 +38068,35 @@ export interface operations { * * `q=repo:octocat/Spoon-Knife+css` */ - "search/commits": { + 'search/commits': { parameters: { query: { /** The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching commits](https://docs.github.com/articles/searching-commits/)" for a detailed list of qualifiers. */ - q: string; + q: string /** Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */ - sort?: "author-date" | "committer-date"; + sort?: 'author-date' | 'committer-date' /** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - order?: components["parameters"]["order"]; + order?: components['parameters']['order'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - incomplete_results: boolean; - items: components["schemas"]["commit-search-result-item"][]; - } & { [key: string]: unknown }; - }; - }; - 304: components["responses"]["not_modified"]; - }; - }; + 'application/json': { + total_count: number + incomplete_results: boolean + items: components['schemas']['commit-search-result-item'][] + } & { [key: string]: unknown } + } + } + 304: components['responses']['not_modified'] + } + } /** * Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -38146,49 +38111,49 @@ export interface operations { * * **Note:** For [user-to-server](https://docs.github.com/developers/apps/identifying-and-authorizing-users-for-github-apps#user-to-server-requests) GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." */ - "search/issues-and-pull-requests": { + 'search/issues-and-pull-requests': { parameters: { query: { /** The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching issues and pull requests](https://docs.github.com/articles/searching-issues-and-pull-requests/)" for a detailed list of qualifiers. */ - q: string; + q: string /** Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */ sort?: - | "comments" - | "reactions" - | "reactions-+1" - | "reactions--1" - | "reactions-smile" - | "reactions-thinking_face" - | "reactions-heart" - | "reactions-tada" - | "interactions" - | "created" - | "updated"; + | 'comments' + | 'reactions' + | 'reactions-+1' + | 'reactions--1' + | 'reactions-smile' + | 'reactions-thinking_face' + | 'reactions-heart' + | 'reactions-tada' + | 'interactions' + | 'created' + | 'updated' /** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - order?: components["parameters"]["order"]; + order?: components['parameters']['order'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - incomplete_results: boolean; - items: components["schemas"]["issue-search-result-item"][]; - } & { [key: string]: unknown }; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': { + total_count: number + incomplete_results: boolean + items: components['schemas']['issue-search-result-item'][] + } & { [key: string]: unknown } + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + 503: components['responses']['service_unavailable'] + } + } /** * Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -38200,40 +38165,40 @@ export interface operations { * * The labels that best match the query appear first in the search results. */ - "search/labels": { + 'search/labels': { parameters: { query: { /** The id of the repository. */ - repository_id: number; + repository_id: number /** The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). */ - q: string; + q: string /** Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */ - sort?: "created" | "updated"; + sort?: 'created' | 'updated' /** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - order?: components["parameters"]["order"]; + order?: components['parameters']['order'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - incomplete_results: boolean; - items: components["schemas"]["label-search-result-item"][]; - } & { [key: string]: unknown }; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': { + total_count: number + incomplete_results: boolean + items: components['schemas']['label-search-result-item'][] + } & { [key: string]: unknown } + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** * Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -38245,37 +38210,37 @@ export interface operations { * * This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results. */ - "search/repos": { + 'search/repos': { parameters: { query: { /** The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers. */ - q: string; + q: string /** Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */ - sort?: "stars" | "forks" | "help-wanted-issues" | "updated"; + sort?: 'stars' | 'forks' | 'help-wanted-issues' | 'updated' /** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - order?: components["parameters"]["order"]; + order?: components['parameters']['order'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - incomplete_results: boolean; - items: components["schemas"]["repo-search-result-item"][]; - } & { [key: string]: unknown }; - }; - }; - 304: components["responses"]["not_modified"]; - 422: components["responses"]["validation_failed"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': { + total_count: number + incomplete_results: boolean + items: components['schemas']['repo-search-result-item'][] + } & { [key: string]: unknown } + } + } + 304: components['responses']['not_modified'] + 422: components['responses']['validation_failed'] + 503: components['responses']['service_unavailable'] + } + } /** * Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers. * @@ -38287,31 +38252,31 @@ export interface operations { * * This query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results. */ - "search/topics": { + 'search/topics': { parameters: { query: { /** The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). */ - q: string; + q: string /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - incomplete_results: boolean; - items: components["schemas"]["topic-search-result-item"][]; - } & { [key: string]: unknown }; - }; - }; - 304: components["responses"]["not_modified"]; - }; - }; + 'application/json': { + total_count: number + incomplete_results: boolean + items: components['schemas']['topic-search-result-item'][] + } & { [key: string]: unknown } + } + } + 304: components['responses']['not_modified'] + } + } /** * Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -38323,54 +38288,54 @@ export interface operations { * * This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. */ - "search/users": { + 'search/users': { parameters: { query: { /** The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching users](https://docs.github.com/articles/searching-users/)" for a detailed list of qualifiers. */ - q: string; + q: string /** Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */ - sort?: "followers" | "repositories" | "joined"; + sort?: 'followers' | 'repositories' | 'joined' /** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - order?: components["parameters"]["order"]; + order?: components['parameters']['order'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - incomplete_results: boolean; - items: components["schemas"]["user-search-result-item"][]; - } & { [key: string]: unknown }; - }; - }; - 304: components["responses"]["not_modified"]; - 422: components["responses"]["validation_failed"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': { + total_count: number + incomplete_results: boolean + items: components['schemas']['user-search-result-item'][] + } & { [key: string]: unknown } + } + } + 304: components['responses']['not_modified'] + 422: components['responses']['validation_failed'] + 503: components['responses']['service_unavailable'] + } + } /** **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/reference/teams#get-a-team-by-name) endpoint. */ - "teams/get-legacy": { + 'teams/get-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; - }; + team_id: components['parameters']['team-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-full"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['team-full'] + } + } + 404: components['responses']['not_found'] + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/reference/teams#delete-a-team) endpoint. * @@ -38378,19 +38343,19 @@ export interface operations { * * If you are an organization owner, deleting a parent team will delete all of its child teams as well. */ - "teams/delete-legacy": { + 'teams/delete-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; - }; + team_id: components['parameters']['team-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/reference/teams#update-a-team) endpoint. * @@ -38398,36 +38363,36 @@ export interface operations { * * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. */ - "teams/update-legacy": { + 'teams/update-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; - }; + team_id: components['parameters']['team-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-full"]; - }; - }; + 'application/json': components['schemas']['team-full'] + } + } /** Response */ 201: { content: { - "application/json": components["schemas"]["team-full"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['team-full'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the team. */ - name: string; + name: string /** @description The description of the team. */ - description?: string; + description?: string /** * @description The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: * **For a non-nested team:** @@ -38437,7 +38402,7 @@ export interface operations { * \* `closed` - visible to all members of this organization. * @enum {string} */ - privacy?: "secret" | "closed"; + privacy?: 'secret' | 'closed' /** * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: * \* `pull` - team members can pull, but not push to or administer newly-added repositories. @@ -38446,42 +38411,42 @@ export interface operations { * @default pull * @enum {string} */ - permission?: "pull" | "push" | "admin"; + permission?: 'pull' | 'push' | 'admin' /** @description The ID of a team to set as the parent team. */ - parent_team_id?: number | null; - } & { [key: string]: unknown }; - }; - }; - }; + parent_team_id?: number | null + } & { [key: string]: unknown } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/reference/teams#list-discussions) endpoint. * * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "teams/list-discussions-legacy": { + 'teams/list-discussions-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; + team_id: components['parameters']['team-id'] + } query: { /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team-discussion"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['team-discussion'][] + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/reference/teams#create-a-discussion) endpoint. * @@ -38489,132 +38454,132 @@ export interface operations { * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - "teams/create-discussion-legacy": { + 'teams/create-discussion-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; - }; + team_id: components['parameters']['team-id'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; + 'application/json': components['schemas']['team-discussion'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The discussion post's title. */ - title: string; + title: string /** @description The discussion post's body text. */ - body: string; + body: string /** @description Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. */ - private?: boolean; - } & { [key: string]: unknown }; - }; - }; - }; + private?: boolean + } & { [key: string]: unknown } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/reference/teams#get-a-discussion) endpoint. * * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "teams/get-discussion-legacy": { + 'teams/get-discussion-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - }; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; - }; + 'application/json': components['schemas']['team-discussion'] + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/reference/teams#delete-a-discussion) endpoint. * * Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "teams/delete-discussion-legacy": { + 'teams/delete-discussion-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - }; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/reference/teams#update-a-discussion) endpoint. * * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "teams/update-discussion-legacy": { + 'teams/update-discussion-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - }; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; + 'application/json': components['schemas']['team-discussion'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The discussion post's title. */ - title?: string; + title?: string /** @description The discussion post's body text. */ - body?: string; - } & { [key: string]: unknown }; - }; - }; - }; + body?: string + } & { [key: string]: unknown } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/reference/teams#list-discussion-comments) endpoint. * * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "teams/list-discussion-comments-legacy": { + 'teams/list-discussion-comments-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + } query: { /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team-discussion-comment"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['team-discussion-comment'][] + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/reference/teams#create-a-discussion-comment) endpoint. * @@ -38622,263 +38587,263 @@ export interface operations { * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - "teams/create-discussion-comment-legacy": { + 'teams/create-discussion-comment-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - }; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; + 'application/json': components['schemas']['team-discussion-comment'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The discussion comment's body text. */ - body: string; - } & { [key: string]: unknown }; - }; - }; - }; + body: string + } & { [key: string]: unknown } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/reference/teams#get-a-discussion-comment) endpoint. * * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "teams/get-discussion-comment-legacy": { + 'teams/get-discussion-comment-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - comment_number: components["parameters"]["comment-number"]; - }; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + comment_number: components['parameters']['comment-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; - }; + 'application/json': components['schemas']['team-discussion-comment'] + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/reference/teams#delete-a-discussion-comment) endpoint. * * Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "teams/delete-discussion-comment-legacy": { + 'teams/delete-discussion-comment-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - comment_number: components["parameters"]["comment-number"]; - }; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + comment_number: components['parameters']['comment-number'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/reference/teams#update-a-discussion-comment) endpoint. * * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "teams/update-discussion-comment-legacy": { + 'teams/update-discussion-comment-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - comment_number: components["parameters"]["comment-number"]; - }; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + comment_number: components['parameters']['comment-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; + 'application/json': components['schemas']['team-discussion-comment'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The discussion comment's body text. */ - body: string; - } & { [key: string]: unknown }; - }; - }; - }; + body: string + } & { [key: string]: unknown } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * * List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "reactions/list-for-team-discussion-comment-legacy": { + 'reactions/list-for-team-discussion-comment-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - comment_number: components["parameters"]["comment-number"]; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + comment_number: components['parameters']['comment-number'] + } query: { /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion comment. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content?: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["reaction"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['reaction'][] + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. * * Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. */ - "reactions/create-for-team-discussion-comment-legacy": { + 'reactions/create-for-team-discussion-comment-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - comment_number: components["parameters"]["comment-number"]; - }; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + comment_number: components['parameters']['comment-number'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - }; + 'application/json': components['schemas']['reaction'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion comment. * @enum {string} */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - } & { [key: string]: unknown }; - }; - }; - }; + content: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' + } & { [key: string]: unknown } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion) endpoint. * * List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "reactions/list-for-team-discussion-legacy": { + 'reactions/list-for-team-discussion-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + } query: { /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content?: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["reaction"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['reaction'][] + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion) endpoint. * * Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. */ - "reactions/create-for-team-discussion-legacy": { + 'reactions/create-for-team-discussion-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - }; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - }; + 'application/json': components['schemas']['reaction'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion. * @enum {string} */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - } & { [key: string]: unknown }; - }; - }; - }; + content: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' + } & { [key: string]: unknown } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/reference/teams#list-pending-team-invitations) endpoint. * * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. */ - "teams/list-pending-invitations-legacy": { + 'teams/list-pending-invitations-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; + team_id: components['parameters']['team-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["organization-invitation"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['organization-invitation'][] + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/reference/teams#list-team-members) endpoint. * * Team members will include the members of child teams. */ - "teams/list-members-legacy": { + 'teams/list-members-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; + team_id: components['parameters']['team-id'] + } query: { /** * Filters members returned by their role in the team. Can be one of: @@ -38886,24 +38851,24 @@ export interface operations { * \* `maintainer` - team maintainers. * \* `all` - all members of the team. */ - role?: "member" | "maintainer" | "all"; + role?: 'member' | 'maintainer' | 'all' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + 404: components['responses']['not_found'] + } + } /** * The "Get team member" endpoint (described below) is deprecated. * @@ -38911,20 +38876,20 @@ export interface operations { * * To list members in a team, the team must be visible to the authenticated user. */ - "teams/get-member-legacy": { + 'teams/get-member-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - username: components["parameters"]["username"]; - }; - }; + team_id: components['parameters']['team-id'] + username: components['parameters']['username'] + } + } responses: { /** if user is a member */ - 204: never; + 204: never /** if user is not a member */ - 404: unknown; - }; - }; + 404: unknown + } + } /** * The "Add team member" endpoint (described below) is deprecated. * @@ -38938,23 +38903,23 @@ export interface operations { * * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - "teams/add-member-legacy": { + 'teams/add-member-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - username: components["parameters"]["username"]; - }; - }; + team_id: components['parameters']['team-id'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 403: components["responses"]["forbidden"]; + 204: never + 403: components['responses']['forbidden'] /** Not Found if team synchronization is set up */ - 404: unknown; + 404: unknown /** Unprocessable Entity if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization */ - 422: unknown; - }; - }; + 422: unknown + } + } /** * The "Remove team member" endpoint (described below) is deprecated. * @@ -38966,20 +38931,20 @@ export interface operations { * * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ - "teams/remove-member-legacy": { + 'teams/remove-member-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - username: components["parameters"]["username"]; - }; - }; + team_id: components['parameters']['team-id'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; + 204: never /** Not Found if team synchronization is setup */ - 404: unknown; - }; - }; + 404: unknown + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/reference/teams#get-team-membership-for-a-user) endpoint. * @@ -38992,23 +38957,23 @@ export interface operations { * * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team). */ - "teams/get-membership-for-user-legacy": { + 'teams/get-membership-for-user-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - username: components["parameters"]["username"]; - }; - }; + team_id: components['parameters']['team-id'] + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-membership"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['team-membership'] + } + } + 404: components['responses']['not_found'] + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint. * @@ -39022,29 +38987,29 @@ export interface operations { * * If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. */ - "teams/add-or-update-membership-for-user-legacy": { + 'teams/add-or-update-membership-for-user-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - username: components["parameters"]["username"]; - }; - }; + team_id: components['parameters']['team-id'] + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-membership"]; - }; - }; + 'application/json': components['schemas']['team-membership'] + } + } /** Forbidden if team synchronization is set up */ - 403: unknown; - 404: components["responses"]["not_found"]; + 403: unknown + 404: components['responses']['not_found'] /** Unprocessable Entity if you attempt to add an organization to a team */ - 422: unknown; - }; + 422: unknown + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The role that this user should have in the team. Can be one of: * \* `member` - a normal member of the team. @@ -39052,11 +39017,11 @@ export interface operations { * @default member * @enum {string} */ - role?: "member" | "maintainer"; - } & { [key: string]: unknown }; - }; - }; - }; + role?: 'member' | 'maintainer' + } & { [key: string]: unknown } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/reference/teams#remove-team-membership-for-a-user) endpoint. * @@ -39066,101 +39031,101 @@ export interface operations { * * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ - "teams/remove-membership-for-user-legacy": { + 'teams/remove-membership-for-user-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - username: components["parameters"]["username"]; - }; - }; + team_id: components['parameters']['team-id'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; + 204: never /** if team synchronization is set up */ - 403: unknown; - }; - }; + 403: unknown + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/reference/teams#list-team-projects) endpoint. * * Lists the organization projects for a team. */ - "teams/list-projects-legacy": { + 'teams/list-projects-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; + team_id: components['parameters']['team-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team-project"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['team-project'][] + } + } + 404: components['responses']['not_found'] + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/reference/teams#check-team-permissions-for-a-project) endpoint. * * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. */ - "teams/check-permissions-for-project-legacy": { + 'teams/check-permissions-for-project-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - project_id: components["parameters"]["project-id"]; - }; - }; + team_id: components['parameters']['team-id'] + project_id: components['parameters']['project-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-project"]; - }; - }; + 'application/json': components['schemas']['team-project'] + } + } /** Not Found if project is not managed by this team */ - 404: unknown; - }; - }; + 404: unknown + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/reference/teams#add-or-update-team-project-permissions) endpoint. * * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. */ - "teams/add-or-update-project-permissions-legacy": { + 'teams/add-or-update-project-permissions-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - project_id: components["parameters"]["project-id"]; - }; - }; + team_id: components['parameters']['team-id'] + project_id: components['parameters']['project-id'] + } + } responses: { /** Response */ - 204: never; + 204: never /** Forbidden if the project is not owned by the organization */ 403: { content: { - "application/json": { - message?: string; - documentation_url?: string; - } & { [key: string]: unknown }; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': { + message?: string + documentation_url?: string + } & { [key: string]: unknown } + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The permission to grant to the team for this project. Can be one of: * \* `read` - team members can read, but not write to or administer this project. @@ -39169,55 +39134,55 @@ export interface operations { * Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." * @enum {string} */ - permission?: "read" | "write" | "admin"; - } & { [key: string]: unknown }; - }; - }; - }; + permission?: 'read' | 'write' | 'admin' + } & { [key: string]: unknown } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/reference/teams#remove-a-project-from-a-team) endpoint. * * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. */ - "teams/remove-project-legacy": { + 'teams/remove-project-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - project_id: components["parameters"]["project-id"]; - }; - }; + team_id: components['parameters']['team-id'] + project_id: components['parameters']['project-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - 415: components["responses"]["preview_header_missing"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + 415: components['responses']['preview_header_missing'] + 422: components['responses']['validation_failed'] + } + } /** **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/reference/teams#list-team-repositories) endpoint. */ - "teams/list-repos-legacy": { + 'teams/list-repos-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; + team_id: components['parameters']['team-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["minimal-repository"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['minimal-repository'][] + } + } + 404: components['responses']['not_found'] + } + } /** * **Note**: Repositories inherited through a parent team will also be checked. * @@ -39225,27 +39190,27 @@ export interface operations { * * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: */ - "teams/check-permissions-for-repo-legacy": { + 'teams/check-permissions-for-repo-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + team_id: components['parameters']['team-id'] + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Alternative response with extra repository information */ 200: { content: { - "application/json": components["schemas"]["team-repository"]; - }; - }; + 'application/json': components['schemas']['team-repository'] + } + } /** Response if repository is managed by this team */ - 204: never; + 204: never /** Not Found if repository is not managed by this team */ - 404: unknown; - }; - }; + 404: unknown + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/reference/teams#add-or-update-team-repository-permissions)" endpoint. * @@ -39253,23 +39218,23 @@ export interface operations { * * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - "teams/add-or-update-repo-permissions-legacy": { + 'teams/add-or-update-repo-permissions-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + team_id: components['parameters']['team-id'] + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + 204: never + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The permission to grant the team on this repository. Can be one of: * \* `pull` - team members can pull, but not push to or administer this repository. @@ -39279,29 +39244,29 @@ export interface operations { * If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. * @enum {string} */ - permission?: "pull" | "push" | "admin"; - } & { [key: string]: unknown }; - }; - }; - }; + permission?: 'pull' | 'push' | 'admin' + } & { [key: string]: unknown } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/reference/teams#remove-a-repository-from-a-team) endpoint. * * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. */ - "teams/remove-repo-legacy": { + 'teams/remove-repo-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + team_id: components['parameters']['team-id'] + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List IdP groups for a team`](https://docs.github.com/rest/reference/teams#list-idp-groups-for-a-team) endpoint. * @@ -39309,23 +39274,23 @@ export interface operations { * * List IdP groups connected to a team on GitHub. */ - "teams/list-idp-groups-for-legacy": { + 'teams/list-idp-groups-for-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; - }; + team_id: components['parameters']['team-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["group-mapping"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['group-mapping'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create or update IdP group connections`](https://docs.github.com/rest/reference/teams#create-or-update-idp-group-connections) endpoint. * @@ -39333,251 +39298,249 @@ export interface operations { * * Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty `groups` array will remove all connections for a team. */ - "teams/create-or-update-idp-group-connections-legacy": { + 'teams/create-or-update-idp-group-connections-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; - }; + team_id: components['parameters']['team-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["group-mapping"]; - }; - }; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['group-mapping'] + } + } + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The IdP groups you want to connect to a GitHub team. When updating, the new `groups` object will replace the original one. You must include any existing groups that you don't want to remove. */ groups: ({ /** @description ID of the IdP group. */ - group_id: string; + group_id: string /** @description Name of the IdP group. */ - group_name: string; + group_name: string /** @description Description of the IdP group. */ - group_description: string; + group_description: string /** @example "caceab43fc9ffa20081c" */ - id?: string; + id?: string /** @example "external-team-6c13e7288ef7" */ - name?: string; + name?: string /** @example "moar cheese pleese" */ - description?: string; - } & { [key: string]: unknown })[]; + description?: string + } & { [key: string]: unknown })[] /** @example "I am not a timestamp" */ - synced_at?: string; - } & { [key: string]: unknown }; - }; - }; - }; + synced_at?: string + } & { [key: string]: unknown } + } + } + } /** **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/reference/teams#list-child-teams) endpoint. */ - "teams/list-child-legacy": { + 'teams/list-child-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; + team_id: components['parameters']['team-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** if child teams exist */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team"][]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['team'][] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** * If the authenticated user is authenticated through basic authentication or OAuth with the `user` scope, then the response lists public and private profile information. * * If the authenticated user is authenticated through OAuth without the `user` scope, then the response lists only public profile information. */ - "users/get-authenticated": { - parameters: {}; + 'users/get-authenticated': { + parameters: {} responses: { /** Response */ 200: { content: { - "application/json": (components["schemas"]["private-user"] | components["schemas"]["public-user"]) & { - [key: string]: unknown; - }; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': (components['schemas']['private-user'] | components['schemas']['public-user']) & { [key: string]: unknown } + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** **Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API. */ - "users/update-authenticated": { - parameters: {}; + 'users/update-authenticated': { + parameters: {} responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["private-user"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['private-user'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The new name of the user. * @example Omar Jahandar */ - name?: string; + name?: string /** * @description The publicly visible email address of the user. * @example omar@example.com */ - email?: string; + email?: string /** * @description The new blog URL of the user. * @example blog.example.com */ - blog?: string; + blog?: string /** * @description The new Twitter username of the user. * @example therealomarj */ - twitter_username?: string | null; + twitter_username?: string | null /** * @description The new company of the user. * @example Acme corporation */ - company?: string; + company?: string /** * @description The new location of the user. * @example Berlin, Germany */ - location?: string; + location?: string /** @description The new hiring availability of the user. */ - hireable?: boolean; + hireable?: boolean /** @description The new short biography of the user. */ - bio?: string; - } & { [key: string]: unknown }; - }; - }; - }; + bio?: string + } & { [key: string]: unknown } + } + } + } /** List the users you've blocked on your personal account. */ - "users/list-blocked-by-authenticated-user": { - parameters: {}; + 'users/list-blocked-by-authenticated-user': { + parameters: {} responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 415: components["responses"]["preview_header_missing"]; - }; - }; - "users/check-blocked": { + 'application/json': components['schemas']['simple-user'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 415: components['responses']['preview_header_missing'] + } + } + 'users/check-blocked': { parameters: { path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** If the user is blocked: */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] /** If the user is not blocked: */ 404: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - }; - }; - "users/block": { + 'application/json': components['schemas']['basic-error'] + } + } + } + } + 'users/block': { parameters: { path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "users/unblock": { + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } + 'users/unblock': { parameters: { path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Lists the authenticated user's codespaces. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/list-for-authenticated-user": { + 'codespaces/list-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** ID of the Repository to filter on */ - repository_id?: components["parameters"]["repository-id-in-query"]; - }; - }; + repository_id?: components['parameters']['repository-id-in-query'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - codespaces: components["schemas"]["codespace"][]; - } & { [key: string]: unknown }; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': { + total_count: number + codespaces: components['schemas']['codespace'][] + } & { [key: string]: unknown } + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** * Creates a new codespace, owned by the authenticated user. * @@ -39585,120 +39548,120 @@ export interface operations { * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/create-for-authenticated-user": { + 'codespaces/create-for-authenticated-user': { responses: { /** Response when the codespace was successfully created */ 201: { content: { - "application/json": components["schemas"]["codespace"]; - }; - }; + 'application/json': components['schemas']['codespace'] + } + } /** Response when the codespace creation partially failed but is being retried in the background */ 202: { content: { - "application/json": components["schemas"]["codespace"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; + 'application/json': components['schemas']['codespace'] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } requestBody: { content: { - "application/json": ( + 'application/json': ( | ({ /** @description Repository id for this codespace */ - repository_id: number; + repository_id: number /** @description Git ref (typically a branch name) for this codespace */ - ref?: string; + ref?: string /** @description Location for this codespace */ - location: string; + location: string /** @description Machine type to use for this codespace */ - machine?: string; + machine?: string /** @description Working directory for this codespace */ - working_directory?: string; + working_directory?: string /** @description Time in minutes before codespace stops from inactivity */ - idle_timeout_minutes?: number; + idle_timeout_minutes?: number } & { [key: string]: unknown }) | ({ /** @description Pull request number for this codespace */ pull_request: { /** @description Pull request number */ - pull_request_number: number; + pull_request_number: number /** @description Repository id for this codespace */ - repository_id: number; - } & { [key: string]: unknown }; + repository_id: number + } & { [key: string]: unknown } /** @description Location for this codespace */ - location: string; + location: string /** @description Machine type to use for this codespace */ - machine?: string; + machine?: string /** @description Working directory for this codespace */ - working_directory?: string; + working_directory?: string /** @description Time in minutes before codespace stops from inactivity */ - idle_timeout_minutes?: number; + idle_timeout_minutes?: number } & { [key: string]: unknown }) - ) & { [key: string]: unknown }; - }; - }; - }; + ) & { [key: string]: unknown } + } + } + } /** * Lists all secrets available for a user's Codespaces without revealing their * encrypted values. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - "codespaces/list-secrets-for-authenticated-user": { + 'codespaces/list-secrets-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - secrets: components["schemas"]["codespaces-secret"][]; - } & { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': { + total_count: number + secrets: components['schemas']['codespaces-secret'][] + } & { [key: string]: unknown } + } + } + } + } /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with one of the 'read:user' or 'user' scopes in their personal access token. User must have Codespaces access to use this endpoint. */ - "codespaces/get-public-key-for-authenticated-user": { + 'codespaces/get-public-key-for-authenticated-user': { responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["codespaces-user-public-key"]; - }; - }; - }; - }; + 'application/json': components['schemas']['codespaces-user-public-key'] + } + } + } + } /** * Gets a secret available to a user's codespaces without revealing its encrypted value. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - "codespaces/get-secret-for-authenticated-user": { + 'codespaces/get-secret-for-authenticated-user': { parameters: { path: { /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["codespaces-secret"]; - }; - }; - }; - }; + 'application/json': components['schemas']['codespaces-secret'] + } + } + } + } /** * Creates or updates a secret for a user's codespace with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access token with the `user` scope to use this endpoint. User must also have Codespaces access to use this endpoint. @@ -39774,195 +39737,195 @@ export interface operations { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - "codespaces/create-or-update-secret-for-authenticated-user": { + 'codespaces/create-or-update-secret-for-authenticated-user': { parameters: { path: { /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response after successfully creaing a secret */ 201: { content: { - "application/json": { [key: string]: unknown }; - }; - }; + 'application/json': { [key: string]: unknown } + } + } /** Response after successfully updating a secret */ - 204: never; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 204: never + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for the authenticated user](https://docs.github.com/rest/reference/codespaces#get-the-public-key-for-the-authenticated-user) endpoint. */ - encrypted_value: string; + encrypted_value: string /** @description ID of the key you used to encrypt the secret. */ - key_id: string; + key_id: string /** @description An array of repository ids that can access the user secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/reference/codespaces#list-selected-repositories-for-a-user-secret), [Set selected repositories for a user secret](https://docs.github.com/rest/reference/codespaces#set-selected-repositories-for-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/reference/codespaces#remove-a-selected-repository-from-a-user-secret) endpoints. */ - selected_repository_ids?: string[]; - } & { [key: string]: unknown }; - }; - }; - }; + selected_repository_ids?: string[] + } & { [key: string]: unknown } + } + } + } /** Deletes a secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret. You must authenticate using an access token with the `user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - "codespaces/delete-secret-for-authenticated-user": { + 'codespaces/delete-secret-for-authenticated-user': { parameters: { path: { /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * List the repositories that have been granted the ability to use a user's codespace secret. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - "codespaces/list-repositories-for-secret-for-authenticated-user": { + 'codespaces/list-repositories-for-secret-for-authenticated-user': { parameters: { path: { /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - repositories: components["schemas"]["minimal-repository"][]; - } & { [key: string]: unknown }; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': { + total_count: number + repositories: components['schemas']['minimal-repository'][] + } & { [key: string]: unknown } + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** * Select the repositories that will use a user's codespace secret. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - "codespaces/set-repositories-for-secret-for-authenticated-user": { + 'codespaces/set-repositories-for-secret-for-authenticated-user': { parameters: { path: { /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** No Content when repositories were added to the selected list */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description An array of repository ids for which a codespace can access the secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/reference/codespaces#list-selected-repositories-for-a-user-secret), [Add a selected repository to a user secret](https://docs.github.com/rest/reference/codespaces#add-a-selected-repository-to-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/reference/codespaces#remove-a-selected-repository-from-a-user-secret) endpoints. */ - selected_repository_ids: number[]; - } & { [key: string]: unknown }; - }; - }; - }; + selected_repository_ids: number[] + } & { [key: string]: unknown } + } + } + } /** * Adds a repository to the selected repositories for a user's codespace secret. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - "codespaces/add-repository-for-secret-for-authenticated-user": { + 'codespaces/add-repository-for-secret-for-authenticated-user': { parameters: { path: { /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - repository_id: number; - }; - }; + secret_name: components['parameters']['secret-name'] + repository_id: number + } + } responses: { /** No Content when repository was added to the selected list */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** * Removes a repository from the selected repositories for a user's codespace secret. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - "codespaces/remove-repository-for-secret-for-authenticated-user": { + 'codespaces/remove-repository-for-secret-for-authenticated-user': { parameters: { path: { /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - repository_id: number; - }; - }; + secret_name: components['parameters']['secret-name'] + repository_id: number + } + } responses: { /** No Content when repository was removed from the selected list */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** * Gets information about a user's codespace. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/get-for-authenticated-user": { + 'codespaces/get-for-authenticated-user': { parameters: { path: { /** The name of the codespace. */ - codespace_name: components["parameters"]["codespace-name"]; - }; - }; + codespace_name: components['parameters']['codespace-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["codespace"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': components['schemas']['codespace'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** * Deletes a user's codespace. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/delete-for-authenticated-user": { + 'codespaces/delete-for-authenticated-user': { parameters: { path: { /** The name of the codespace. */ - codespace_name: components["parameters"]["codespace-name"]; - }; - }; - responses: { - 202: components["responses"]["accepted"]; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + codespace_name: components['parameters']['codespace-name'] + } + } + responses: { + 202: components['responses']['accepted'] + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** * Updates a codespace owned by the authenticated user. Currently only the codespace's machine type and recent folders can be modified using this endpoint. * @@ -39970,472 +39933,472 @@ export interface operations { * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/update-for-authenticated-user": { + 'codespaces/update-for-authenticated-user': { parameters: { path: { /** The name of the codespace. */ - codespace_name: components["parameters"]["codespace-name"]; - }; - }; + codespace_name: components['parameters']['codespace-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["codespace"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; + 'application/json': components['schemas']['codespace'] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description A valid machine to transition this codespace to. */ - machine?: string; + machine?: string /** @description Recently opened folders inside the codespace. It is currently used by the clients to determine the folder path to load the codespace in. */ - recent_folders?: string[]; - } & { [key: string]: unknown }; - }; - }; - }; + recent_folders?: string[] + } & { [key: string]: unknown } + } + } + } /** * Triggers an export of the specified codespace and returns a URL and ID where the status of the export can be monitored. * * You must authenticate using a personal access token with the `codespace` scope to use this endpoint. */ - "codespaces/export-for-authenticated-user": { + 'codespaces/export-for-authenticated-user': { parameters: { path: { /** The name of the codespace. */ - codespace_name: components["parameters"]["codespace-name"]; - }; - }; + codespace_name: components['parameters']['codespace-name'] + } + } responses: { /** Response */ 202: { content: { - "application/json": components["schemas"]["codespace-export-details"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': components['schemas']['codespace-export-details'] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + 500: components['responses']['internal_error'] + } + } /** * Gets information about an export of a codespace. * * You must authenticate using a personal access token with the `codespace` scope to use this endpoint. */ - "codespaces/get-export-details-for-authenticated-user": { + 'codespaces/get-export-details-for-authenticated-user': { parameters: { path: { /** The name of the codespace. */ - codespace_name: components["parameters"]["codespace-name"]; + codespace_name: components['parameters']['codespace-name'] /** The ID of the export operation, or `latest`. Currently only `latest` is currently supported. */ - export_id: components["parameters"]["export-id"]; - }; - }; + export_id: components['parameters']['export-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["codespace-export-details"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['codespace-export-details'] + } + } + 404: components['responses']['not_found'] + } + } /** * List the machine types a codespace can transition to use. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/codespace-machines-for-authenticated-user": { + 'codespaces/codespace-machines-for-authenticated-user': { parameters: { path: { /** The name of the codespace. */ - codespace_name: components["parameters"]["codespace-name"]; - }; - }; + codespace_name: components['parameters']['codespace-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - machines: components["schemas"]["codespace-machine"][]; - } & { [key: string]: unknown }; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': { + total_count: number + machines: components['schemas']['codespace-machine'][] + } & { [key: string]: unknown } + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** * Starts a user's codespace. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/start-for-authenticated-user": { + 'codespaces/start-for-authenticated-user': { parameters: { path: { /** The name of the codespace. */ - codespace_name: components["parameters"]["codespace-name"]; - }; - }; + codespace_name: components['parameters']['codespace-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["codespace"]; - }; - }; - 304: components["responses"]["not_modified"]; - 400: components["responses"]["bad_request"]; - 401: components["responses"]["requires_authentication"]; + 'application/json': components['schemas']['codespace'] + } + } + 304: components['responses']['not_modified'] + 400: components['responses']['bad_request'] + 401: components['responses']['requires_authentication'] /** Payment required */ 402: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 409: components['responses']['conflict'] + 500: components['responses']['internal_error'] + } + } /** * Stops a user's codespace. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/stop-for-authenticated-user": { + 'codespaces/stop-for-authenticated-user': { parameters: { path: { /** The name of the codespace. */ - codespace_name: components["parameters"]["codespace-name"]; - }; - }; + codespace_name: components['parameters']['codespace-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["codespace"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': components['schemas']['codespace'] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** Sets the visibility for your primary email addresses. */ - "users/set-primary-email-visibility-for-authenticated-user": { - parameters: {}; + 'users/set-primary-email-visibility-for-authenticated-user': { + parameters: {} responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["email"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['email'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description Denotes whether an email is publicly visible. * @enum {string} */ - visibility: "public" | "private"; - } & { [key: string]: unknown }; - }; - }; - }; + visibility: 'public' | 'private' + } & { [key: string]: unknown } + } + } + } /** Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope. */ - "users/list-emails-for-authenticated-user": { + 'users/list-emails-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["email"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['email'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** This endpoint is accessible with the `user` scope. */ - "users/add-email-for-authenticated-user": { - parameters: {}; + 'users/add-email-for-authenticated-user': { + parameters: {} responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["email"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['email'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": ( + 'application/json': ( | ({ /** * @description Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key. * @example */ - emails: string[]; + emails: string[] } & { [key: string]: unknown }) | string[] | string - ) & { [key: string]: unknown }; - }; - }; - }; + ) & { [key: string]: unknown } + } + } + } /** This endpoint is accessible with the `user` scope. */ - "users/delete-email-for-authenticated-user": { - parameters: {}; + 'users/delete-email-for-authenticated-user': { + parameters: {} responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": ( + 'application/json': ( | ({ /** @description Email addresses associated with the GitHub user account. */ - emails: string[]; + emails: string[] } & { [key: string]: unknown }) | string[] | string - ) & { [key: string]: unknown }; - }; - }; - }; + ) & { [key: string]: unknown } + } + } + } /** Lists the people following the authenticated user. */ - "users/list-followers-for-authenticated-user": { + 'users/list-followers-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** Lists the people who the authenticated user follows. */ - "users/list-followed-by-authenticated-user": { + 'users/list-followed-by-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; - "users/check-person-is-followed-by-authenticated": { + 'application/json': components['schemas']['simple-user'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } + 'users/check-person-is-followed-by-authenticated': { parameters: { path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** if the person is followed by the authenticated user */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] /** if the person is not followed by the authenticated user */ 404: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } + } + } /** * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." * * Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. */ - "users/follow": { + 'users/follow': { parameters: { path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. */ - "users/unfollow": { + 'users/unfollow': { parameters: { path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "users/list-gpg-keys-for-authenticated-user": { + 'users/list-gpg-keys-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["gpg-key"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['gpg-key'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "users/create-gpg-key-for-authenticated-user": { - parameters: {}; + 'users/create-gpg-key-for-authenticated-user': { + parameters: {} responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["gpg-key"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['gpg-key'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description A GPG key in ASCII-armored format. */ - armored_public_key: string; - } & { [key: string]: unknown }; - }; - }; - }; + armored_public_key: string + } & { [key: string]: unknown } + } + } + } /** View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "users/get-gpg-key-for-authenticated-user": { + 'users/get-gpg-key-for-authenticated-user': { parameters: { path: { /** gpg_key_id parameter */ - gpg_key_id: components["parameters"]["gpg-key-id"]; - }; - }; + gpg_key_id: components['parameters']['gpg-key-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["gpg-key"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['gpg-key'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "users/delete-gpg-key-for-authenticated-user": { + 'users/delete-gpg-key-for-authenticated-user': { parameters: { path: { /** gpg_key_id parameter */ - gpg_key_id: components["parameters"]["gpg-key-id"]; - }; - }; + gpg_key_id: components['parameters']['gpg-key-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** * Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. * @@ -40445,32 +40408,32 @@ export interface operations { * * You can find the permissions for the installation under the `permissions` key. */ - "apps/list-installations-for-authenticated-user": { + 'apps/list-installations-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** You can find the permissions for the installation under the `permissions` key. */ 200: { - headers: {}; - content: { - "application/json": { - total_count: number; - installations: components["schemas"]["installation"][]; - } & { [key: string]: unknown }; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 415: components["responses"]["preview_header_missing"]; - }; - }; + headers: {} + content: { + 'application/json': { + total_count: number + installations: components['schemas']['installation'][] + } & { [key: string]: unknown } + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 415: components['responses']['preview_header_missing'] + } + } /** * List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation. * @@ -40480,116 +40443,117 @@ export interface operations { * * The access the user has to each repository is included in the hash under the `permissions` key. */ - "apps/list-installation-repos-for-authenticated-user": { + 'apps/list-installation-repos-for-authenticated-user': { parameters: { path: { /** installation_id parameter */ - installation_id: components["parameters"]["installation-id"]; - }; + installation_id: components['parameters']['installation-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** The access the user has to each repository is included in the hash under the `permissions` key. */ 200: { - headers: {}; - content: { - "application/json": { - total_count: number; - repository_selection?: string; - repositories: components["schemas"]["repository"][]; - } & { [key: string]: unknown }; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + headers: {} + content: { + 'application/json': { + total_count: number + repository_selection?: string + repositories: components['schemas']['repository'][] + } & { [key: string]: unknown } + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Add a single repository to an installation. The authenticated user must have admin access to the repository. * * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. */ - "apps/add-repo-to-installation-for-authenticated-user": { + 'apps/add-repo-to-installation-for-authenticated-user': { parameters: { path: { /** installation_id parameter */ - installation_id: components["parameters"]["installation-id"]; - repository_id: components["parameters"]["repository-id"]; - }; - }; + installation_id: components['parameters']['installation-id'] + repository_id: components['parameters']['repository-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Remove a single repository from an installation. The authenticated user must have admin access to the repository. * * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. */ - "apps/remove-repo-from-installation-for-authenticated-user": { + 'apps/remove-repo-from-installation-for-authenticated-user': { parameters: { path: { /** installation_id parameter */ - installation_id: components["parameters"]["installation-id"]; - repository_id: components["parameters"]["repository-id"]; - }; - }; - responses: { - /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + installation_id: components['parameters']['installation-id'] + repository_id: components['parameters']['repository-id'] + } + } + responses: { + /** Response */ + 204: never + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Shows which type of GitHub user can interact with your public repositories and when the restriction expires. */ - "interactions/get-restrictions-for-authenticated-user": { + 'interactions/get-restrictions-for-authenticated-user': { responses: { /** Default response */ 200: { content: { - "application/json": (Partial & - Partial<{ [key: string]: unknown }>) & { [key: string]: unknown }; - }; - }; + 'application/json': (Partial & Partial<{ [key: string]: unknown }>) & { + [key: string]: unknown + } + } + } /** Response when there are no restrictions */ - 204: never; - }; - }; + 204: never + } + } /** Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user. */ - "interactions/set-restrictions-for-authenticated-user": { + 'interactions/set-restrictions-for-authenticated-user': { responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["interaction-limit-response"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['interaction-limit-response'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": components["schemas"]["interaction-limit"]; - }; - }; - }; + 'application/json': components['schemas']['interaction-limit'] + } + } + } /** Removes any interaction restrictions from your public repositories. */ - "interactions/remove-restrictions-for-authenticated-user": { + 'interactions/remove-restrictions-for-authenticated-user': { responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * List issues across owned and member repositories assigned to the authenticated user. * @@ -40598,7 +40562,7 @@ export interface operations { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - "issues/list-for-authenticated-user": { + 'issues/list-for-authenticated-user': { parameters: { query: { /** @@ -40609,314 +40573,314 @@ export interface operations { * \* `subscribed`: Issues you're subscribed to updates for * \* `all` or `repos`: All issues the authenticated user can see, regardless of participation or creation */ - filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all"; + filter?: 'assigned' | 'created' | 'mentioned' | 'subscribed' | 'repos' | 'all' /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ - state?: "open" | "closed" | "all"; + state?: 'open' | 'closed' | 'all' /** A list of comma separated label names. Example: `bug,ui,@high` */ - labels?: components["parameters"]["labels"]; + labels?: components['parameters']['labels'] /** What to sort results by. Can be either `created`, `updated`, `comments`. */ - sort?: "created" | "updated" | "comments"; + sort?: 'created' | 'updated' | 'comments' /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["issue"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['issue'][] + } + } + 304: components['responses']['not_modified'] + 404: components['responses']['not_found'] + } + } /** Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "users/list-public-ssh-keys-for-authenticated-user": { + 'users/list-public-ssh-keys-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["key"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['key'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "users/create-public-ssh-key-for-authenticated-user": { - parameters: {}; + 'users/create-public-ssh-key-for-authenticated-user': { + parameters: {} responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["key"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['key'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description A descriptive name for the new key. * @example Personal MacBook Air */ - title?: string; + title?: string /** @description The public SSH key to add to your GitHub account. */ - key: string; - } & { [key: string]: unknown }; - }; - }; - }; + key: string + } & { [key: string]: unknown } + } + } + } /** View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "users/get-public-ssh-key-for-authenticated-user": { + 'users/get-public-ssh-key-for-authenticated-user': { parameters: { path: { /** key_id parameter */ - key_id: components["parameters"]["key-id"]; - }; - }; + key_id: components['parameters']['key-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["key"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['key'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "users/delete-public-ssh-key-for-authenticated-user": { + 'users/delete-public-ssh-key-for-authenticated-user': { parameters: { path: { /** key_id parameter */ - key_id: components["parameters"]["key-id"]; - }; - }; - responses: { - /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + key_id: components['parameters']['key-id'] + } + } + responses: { + /** Response */ + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Lists the active subscriptions for the authenticated user. You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an [OAuth token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/). */ - "apps/list-subscriptions-for-authenticated-user": { + 'apps/list-subscriptions-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["user-marketplace-purchase"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['user-marketplace-purchase'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 404: components['responses']['not_found'] + } + } /** Lists the active subscriptions for the authenticated user. You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an [OAuth token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/). */ - "apps/list-subscriptions-for-authenticated-user-stubbed": { + 'apps/list-subscriptions-for-authenticated-user-stubbed': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["user-marketplace-purchase"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - }; - }; - "orgs/list-memberships-for-authenticated-user": { + 'application/json': components['schemas']['user-marketplace-purchase'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + } + } + 'orgs/list-memberships-for-authenticated-user': { parameters: { query: { /** Indicates the state of the memberships to return. Can be either `active` or `pending`. If not specified, the API returns both active and pending memberships. */ - state?: "active" | "pending"; + state?: 'active' | 'pending' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["org-membership"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "orgs/get-membership-for-authenticated-user": { + 'application/json': components['schemas']['org-membership'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } + } + 'orgs/get-membership-for-authenticated-user': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["org-membership"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "orgs/update-membership-for-authenticated-user": { + 'application/json': components['schemas']['org-membership'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'orgs/update-membership-for-authenticated-user': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["org-membership"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['org-membership'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The state that the membership should be in. Only `"active"` will be accepted. * @enum {string} */ - state: "active"; - } & { [key: string]: unknown }; - }; - }; - }; + state: 'active' + } & { [key: string]: unknown } + } + } + } /** Lists all migrations a user has started. */ - "migrations/list-for-authenticated-user": { + 'migrations/list-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["migration"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['migration'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** Initiates the generation of a user migration archive. */ - "migrations/start-for-authenticated-user": { - parameters: {}; + 'migrations/start-for-authenticated-user': { + parameters: {} responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["migration"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['migration'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description Lock the repositories being migrated at the start of the migration * @example true */ - lock_repositories?: boolean; + lock_repositories?: boolean /** * @description Do not include attachments in the migration * @example true */ - exclude_attachments?: boolean; + exclude_attachments?: boolean /** * @description Do not include releases in the migration * @example true */ - exclude_releases?: boolean; + exclude_releases?: boolean /** * @description Indicates whether projects owned by the organization or users should be excluded. * @example true */ - exclude_owner_projects?: boolean; + exclude_owner_projects?: boolean /** * @description Exclude attributes from the API response to improve performance * @example repositories */ - exclude?: "repositories"[]; - repositories: string[]; - } & { [key: string]: unknown }; - }; - }; - }; + exclude?: 'repositories'[] + repositories: string[] + } & { [key: string]: unknown } + } + } + } /** * Fetches a single user migration. The response includes the `state` of the migration, which can be one of the following values: * @@ -40927,29 +40891,29 @@ export interface operations { * * Once the migration has been `exported` you can [download the migration archive](https://docs.github.com/rest/reference/migrations#download-a-user-migration-archive). */ - "migrations/get-status-for-authenticated-user": { + 'migrations/get-status-for-authenticated-user': { parameters: { path: { /** migration_id parameter */ - migration_id: components["parameters"]["migration-id"]; - }; + migration_id: components['parameters']['migration-id'] + } query: { - exclude?: string[]; - }; - }; + exclude?: string[] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["migration"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['migration'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Fetches the URL to download the migration archive as a `tar.gz` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects: * @@ -40973,82 +40937,82 @@ export interface operations { * * The archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data. */ - "migrations/get-archive-for-authenticated-user": { + 'migrations/get-archive-for-authenticated-user': { parameters: { path: { /** migration_id parameter */ - migration_id: components["parameters"]["migration-id"]; - }; - }; + migration_id: components['parameters']['migration-id'] + } + } responses: { /** Response */ - 302: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 302: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the [List user migrations](https://docs.github.com/rest/reference/migrations#list-user-migrations) and [Get a user migration status](https://docs.github.com/rest/reference/migrations#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted. */ - "migrations/delete-archive-for-authenticated-user": { + 'migrations/delete-archive-for-authenticated-user': { parameters: { path: { /** migration_id parameter */ - migration_id: components["parameters"]["migration-id"]; - }; - }; - responses: { - /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + migration_id: components['parameters']['migration-id'] + } + } + responses: { + /** Response */ + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Unlocks a repository. You can lock repositories when you [start a user migration](https://docs.github.com/rest/reference/migrations#start-a-user-migration). Once the migration is complete you can unlock each repository to begin using it again or [delete the repository](https://docs.github.com/rest/reference/repos#delete-a-repository) if you no longer need the source data. Returns a status of `404 Not Found` if the repository is not locked. */ - "migrations/unlock-repo-for-authenticated-user": { + 'migrations/unlock-repo-for-authenticated-user': { parameters: { path: { /** migration_id parameter */ - migration_id: components["parameters"]["migration-id"]; + migration_id: components['parameters']['migration-id'] /** repo_name parameter */ - repo_name: components["parameters"]["repo-name"]; - }; - }; - responses: { - /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + repo_name: components['parameters']['repo-name'] + } + } + responses: { + /** Response */ + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Lists all the repositories for this user migration. */ - "migrations/list-repos-for-authenticated-user": { + 'migrations/list-repos-for-authenticated-user': { parameters: { path: { /** migration_id parameter */ - migration_id: components["parameters"]["migration-id"]; - }; + migration_id: components['parameters']['migration-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["minimal-repository"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['minimal-repository'][] + } + } + 404: components['responses']['not_found'] + } + } /** * List organizations for the authenticated user. * @@ -41056,99 +41020,99 @@ export interface operations { * * This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response. */ - "orgs/list-for-authenticated-user": { + 'orgs/list-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["organization-simple"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['organization-simple'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** * Lists packages owned by the authenticated user within the user's namespace. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/list-packages-for-authenticated-user": { + 'packages/list-packages-for-authenticated-user': { parameters: { query: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + package_type: 'npm' | 'maven' | 'rubygems' | 'docker' | 'nuget' | 'container' /** The selected visibility of the packages. Can be one of `public`, `private`, or `internal`. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set. */ - visibility?: components["parameters"]["package-visibility"]; - }; - }; + visibility?: components['parameters']['package-visibility'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['package'][] + } + } + } + } /** * Gets a specific package for a package owned by the authenticated user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/get-package-for-authenticated-user": { + 'packages/get-package-for-authenticated-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - }; - }; + package_name: components['parameters']['package-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package"]; - }; - }; - }; - }; + 'application/json': components['schemas']['package'] + } + } + } + } /** * Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:delete` scopes. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/delete-package-for-authenticated-user": { + 'packages/delete-package-for-authenticated-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - }; - }; + package_name: components['parameters']['package-name'] + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Restores a package owned by the authenticated user. * @@ -41158,113 +41122,113 @@ export interface operations { * * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/restore-package-for-authenticated-user": { + 'packages/restore-package-for-authenticated-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - }; + package_name: components['parameters']['package-name'] + } query: { /** package token */ - token?: string; - }; - }; + token?: string + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Returns all package versions for a package owned by the authenticated user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/get-all-package-versions-for-package-owned-by-authenticated-user": { + 'packages/get-all-package-versions-for-package-owned-by-authenticated-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - }; + package_name: components['parameters']['package-name'] + } query: { /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** The state of the package, either active or deleted. */ - state?: "active" | "deleted"; - }; - }; + state?: 'active' | 'deleted' + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package-version"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['package-version'][] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Gets a specific package version for a package owned by the authenticated user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/get-package-version-for-authenticated-user": { + 'packages/get-package-version-for-authenticated-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; + package_name: components['parameters']['package-name'] /** Unique identifier of the package version. */ - package_version_id: components["parameters"]["package-version-id"]; - }; - }; + package_version_id: components['parameters']['package-version-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package-version"]; - }; - }; - }; - }; + 'application/json': components['schemas']['package-version'] + } + } + } + } /** * Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:delete` scopes. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/delete-package-version-for-authenticated-user": { + 'packages/delete-package-version-for-authenticated-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; + package_name: components['parameters']['package-name'] /** Unique identifier of the package version. */ - package_version_id: components["parameters"]["package-version-id"]; - }; - }; + package_version_id: components['parameters']['package-version-id'] + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Restores a package version owned by the authenticated user. * @@ -41274,131 +41238,131 @@ export interface operations { * * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/restore-package-version-for-authenticated-user": { + 'packages/restore-package-version-for-authenticated-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; + package_name: components['parameters']['package-name'] /** Unique identifier of the package version. */ - package_version_id: components["parameters"]["package-version-id"]; - }; - }; + package_version_id: components['parameters']['package-version-id'] + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "projects/create-for-authenticated-user": { - parameters: {}; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'projects/create-for-authenticated-user': { + parameters: {} responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["project"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 415: components["responses"]["preview_header_missing"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': components['schemas']['project'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 415: components['responses']['preview_header_missing'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description Name of the project * @example Week One Sprint */ - name: string; + name: string /** * @description Body of the project * @example This project represents the sprint of the first week in January */ - body?: string | null; - } & { [key: string]: unknown }; - }; - }; - }; + body?: string | null + } & { [key: string]: unknown } + } + } + } /** Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope. */ - "users/list-public-emails-for-authenticated-user": { + 'users/list-public-emails-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["email"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['email'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. * * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. */ - "repos/list-for-authenticated-user": { + 'repos/list-for-authenticated-user': { parameters: { query: { /** Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`. */ - visibility?: "all" | "public" | "private"; + visibility?: 'all' | 'public' | 'private' /** * Comma-separated list of values. Can include: * \* `owner`: Repositories that are owned by the authenticated user. * \* `collaborator`: Repositories that the user has been added to as a collaborator. * \* `organization_member`: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on. */ - affiliation?: string; + affiliation?: string /** * Can be one of `all`, `owner`, `public`, `private`, `member`. Note: For GitHub AE, can be one of `all`, `owner`, `internal`, `private`, `member`. Default: `all` * * Will cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**. */ - type?: "all" | "owner" | "public" | "private" | "member"; + type?: 'all' | 'owner' | 'public' | 'private' | 'member' /** Can be one of `created`, `updated`, `pushed`, `full_name`. */ - sort?: "created" | "updated" | "pushed" | "full_name"; + sort?: 'created' | 'updated' | 'pushed' | 'full_name' /** Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc` */ - direction?: "asc" | "desc"; + direction?: 'asc' | 'desc' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - before?: components["parameters"]["before"]; - }; - }; + before?: components['parameters']['before'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["repository"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['repository'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } + } /** * Creates a new repository for the authenticated user. * @@ -41409,323 +41373,323 @@ export interface operations { * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. * * `repo` scope to create a private repository. */ - "repos/create-for-authenticated-user": { - parameters: {}; + 'repos/create-for-authenticated-user': { + parameters: {} responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["repository"]; - }; - }; - 304: components["responses"]["not_modified"]; - 400: components["responses"]["bad_request"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['repository'] + } + } + 304: components['responses']['not_modified'] + 400: components['responses']['bad_request'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The name of the repository. * @example Team Environment */ - name: string; + name: string /** @description A short description of the repository. */ - description?: string; + description?: string /** @description A URL with more information about the repository. */ - homepage?: string; + homepage?: string /** @description Whether the repository is private. */ - private?: boolean; + private?: boolean /** * @description Whether issues are enabled. * @default true * @example true */ - has_issues?: boolean; + has_issues?: boolean /** * @description Whether projects are enabled. * @default true * @example true */ - has_projects?: boolean; + has_projects?: boolean /** * @description Whether the wiki is enabled. * @default true * @example true */ - has_wiki?: boolean; + has_wiki?: boolean /** @description The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. */ - team_id?: number; + team_id?: number /** @description Whether the repository is initialized with a minimal README. */ - auto_init?: boolean; + auto_init?: boolean /** * @description The desired language or platform to apply to the .gitignore. * @example Haskell */ - gitignore_template?: string; + gitignore_template?: string /** * @description The license keyword of the open source license for this repository. * @example mit */ - license_template?: string; + license_template?: string /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - allow_squash_merge?: boolean; + allow_squash_merge?: boolean /** * @description Whether to allow merge commits for pull requests. * @default true * @example true */ - allow_merge_commit?: boolean; + allow_merge_commit?: boolean /** * @description Whether to allow rebase merges for pull requests. * @default true * @example true */ - allow_rebase_merge?: boolean; + allow_rebase_merge?: boolean /** @description Whether to allow Auto-merge to be used on pull requests. */ - allow_auto_merge?: boolean; + allow_auto_merge?: boolean /** @description Whether to delete head branches when pull requests are merged */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge?: boolean /** * @description Whether downloads are enabled. * @default true * @example true */ - has_downloads?: boolean; + has_downloads?: boolean /** * @description Whether this repository acts as a template that can be used to generate new repositories. * @example true */ - is_template?: boolean; - } & { [key: string]: unknown }; - }; - }; - }; + is_template?: boolean + } & { [key: string]: unknown } + } + } + } /** When authenticating as a user, this endpoint will list all currently open repository invitations for that user. */ - "repos/list-invitations-for-authenticated-user": { + 'repos/list-invitations-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["repository-invitation"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "repos/decline-invitation-for-authenticated-user": { + 'application/json': components['schemas']['repository-invitation'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'repos/decline-invitation-for-authenticated-user': { parameters: { path: { /** invitation_id parameter */ - invitation_id: components["parameters"]["invitation-id"]; - }; - }; + invitation_id: components['parameters']['invitation-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; - }; - }; - "repos/accept-invitation-for-authenticated-user": { + 204: never + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 409: components['responses']['conflict'] + } + } + 'repos/accept-invitation-for-authenticated-user': { parameters: { path: { /** invitation_id parameter */ - invitation_id: components["parameters"]["invitation-id"]; - }; - }; + invitation_id: components['parameters']['invitation-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 409: components['responses']['conflict'] + } + } /** * Lists repositories the authenticated user has starred. * * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: */ - "activity/list-repos-starred-by-authenticated-user": { + 'activity/list-repos-starred-by-authenticated-user': { parameters: { query: { /** One of `created` (when the repository was starred) or `updated` (when it was last pushed to). */ - sort?: components["parameters"]["sort"]; + sort?: components['parameters']['sort'] /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["repository"][]; - "application/vnd.github.v3.star+json": components["schemas"]["starred-repository"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; - "activity/check-repo-is-starred-by-authenticated-user": { + 'application/json': components['schemas']['repository'][] + 'application/vnd.github.v3.star+json': components['schemas']['starred-repository'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } + 'activity/check-repo-is-starred-by-authenticated-user': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response if this repository is starred by you */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] /** Not Found if this repository is not starred by you */ 404: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } + } + } /** Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - "activity/star-repo-for-authenticated-user": { + 'activity/star-repo-for-authenticated-user': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "activity/unstar-repo-for-authenticated-user": { + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'activity/unstar-repo-for-authenticated-user': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Lists repositories the authenticated user is watching. */ - "activity/list-watched-repos-for-authenticated-user": { + 'activity/list-watched-repos-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["minimal-repository"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['minimal-repository'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** List all of the teams across all of the organizations to which the authenticated user belongs. This method requires `user`, `repo`, or `read:org` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://docs.github.com/apps/building-oauth-apps/). */ - "teams/list-for-authenticated-user": { + 'teams/list-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team-full"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['team-full'][] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts. * * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of users. */ - "users/list": { + 'users/list': { parameters: { query: { /** A user ID. Only return users with an ID greater than this ID. */ - since?: components["parameters"]["since-user"]; + since?: components['parameters']['since-user'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { headers: { - Link?: string; - }; + Link?: string + } content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 304: components["responses"]["not_modified"]; - }; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + 304: components['responses']['not_modified'] + } + } /** * Provides publicly available information about someone with a GitHub account. * @@ -41735,199 +41699,197 @@ export interface operations { * * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/reference/users#emails)". */ - "users/get-by-username": { + 'users/get-by-username': { parameters: { path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": (components["schemas"]["private-user"] | components["schemas"]["public-user"]) & { - [key: string]: unknown; - }; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': (components['schemas']['private-user'] | components['schemas']['public-user']) & { [key: string]: unknown } + } + } + 404: components['responses']['not_found'] + } + } /** If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. */ - "activity/list-events-for-authenticated-user": { + 'activity/list-events-for-authenticated-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["event"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['event'][] + } + } + } + } /** This is the user's organization dashboard. You must be authenticated as the user to view this. */ - "activity/list-org-events-for-authenticated-user": { + 'activity/list-org-events-for-authenticated-user': { parameters: { path: { - username: components["parameters"]["username"]; - org: components["parameters"]["org"]; - }; + username: components['parameters']['username'] + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["event"][]; - }; - }; - }; - }; - "activity/list-public-events-for-user": { + 'application/json': components['schemas']['event'][] + } + } + } + } + 'activity/list-public-events-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["event"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['event'][] + } + } + } + } /** Lists the people following the specified user. */ - "users/list-followers-for-user": { + 'users/list-followers-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + } + } /** Lists the people who the specified user follows. */ - "users/list-following-for-user": { + 'users/list-following-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - }; - }; - "users/check-following-for-user": { + 'application/json': components['schemas']['simple-user'][] + } + } + } + } + 'users/check-following-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - target_user: string; - }; - }; + username: components['parameters']['username'] + target_user: string + } + } responses: { /** if the user follows the target user */ - 204: never; + 204: never /** if the user does not follow the target user */ - 404: unknown; - }; - }; + 404: unknown + } + } /** Lists public gists for the specified user: */ - "gists/list-for-user": { + 'gists/list-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["base-gist"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['base-gist'][] + } + } + 422: components['responses']['validation_failed'] + } + } /** Lists the GPG keys for a user. This information is accessible by anyone. */ - "users/list-gpg-keys-for-user": { + 'users/list-gpg-keys-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["gpg-key"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['gpg-key'][] + } + } + } + } /** * Provides hovercard information when authenticated through basic auth or OAuth with the `repo` scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. * @@ -41938,153 +41900,153 @@ export interface operations { * https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 * ``` */ - "users/get-context-for-user": { + 'users/get-context-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, `pull_request`. **Required** when using `subject_id`. */ - subject_type?: "organization" | "repository" | "issue" | "pull_request"; + subject_type?: 'organization' | 'repository' | 'issue' | 'pull_request' /** Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`. */ - subject_id?: string; - }; - }; + subject_id?: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["hovercard"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['hovercard'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** * Enables an authenticated GitHub App to find the user’s installation information. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/get-user-installation": { + 'apps/get-user-installation': { parameters: { path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["installation"]; - }; - }; - }; - }; + 'application/json': components['schemas']['installation'] + } + } + } + } /** Lists the _verified_ public SSH keys for a user. This is accessible by anyone. */ - "users/list-public-keys-for-user": { + 'users/list-public-keys-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["key-simple"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['key-simple'][] + } + } + } + } /** * List [public organization memberships](https://docs.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user. * * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/rest/reference/orgs#list-organizations-for-the-authenticated-user) API instead. */ - "orgs/list-for-user": { + 'orgs/list-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["organization-simple"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['organization-simple'][] + } + } + } + } /** * Lists all packages in a user's namespace for which the requesting user has access. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/list-packages-for-user": { + 'packages/list-packages-for-user': { parameters: { query: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + package_type: 'npm' | 'maven' | 'rubygems' | 'docker' | 'nuget' | 'container' /** The selected visibility of the packages. Can be one of `public`, `private`, or `internal`. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set. */ - visibility?: components["parameters"]["package-visibility"]; - }; + visibility?: components['parameters']['package-visibility'] + } path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['package'][] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** * Gets a specific package metadata for a public package owned by a user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/get-package-for-user": { + 'packages/get-package-for-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - username: components["parameters"]["username"]; - }; - }; + package_name: components['parameters']['package-name'] + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package"]; - }; - }; - }; - }; + 'application/json': components['schemas']['package'] + } + } + } + } /** * Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * @@ -42092,24 +42054,24 @@ export interface operations { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. */ - "packages/delete-package-for-user": { + 'packages/delete-package-for-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - username: components["parameters"]["username"]; - }; - }; + package_name: components['parameters']['package-name'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Restores an entire package for a user. * @@ -42121,83 +42083,83 @@ export interface operations { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. */ - "packages/restore-package-for-user": { + 'packages/restore-package-for-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - username: components["parameters"]["username"]; - }; + package_name: components['parameters']['package-name'] + username: components['parameters']['username'] + } query: { /** package token */ - token?: string; - }; - }; + token?: string + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Returns all package versions for a public package owned by a specified user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/get-all-package-versions-for-package-owned-by-user": { + 'packages/get-all-package-versions-for-package-owned-by-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - username: components["parameters"]["username"]; - }; - }; + package_name: components['parameters']['package-name'] + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package-version"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['package-version'][] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Gets a specific package version for a public package owned by a specified user. * * At this time, to use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/get-package-version-for-user": { + 'packages/get-package-version-for-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; + package_name: components['parameters']['package-name'] /** Unique identifier of the package version. */ - package_version_id: components["parameters"]["package-version-id"]; - username: components["parameters"]["username"]; - }; - }; + package_version_id: components['parameters']['package-version-id'] + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package-version"]; - }; - }; - }; - }; + 'application/json': components['schemas']['package-version'] + } + } + } + } /** * Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * @@ -42205,26 +42167,26 @@ export interface operations { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. */ - "packages/delete-package-version-for-user": { + 'packages/delete-package-version-for-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - username: components["parameters"]["username"]; + package_name: components['parameters']['package-name'] + username: components['parameters']['username'] /** Unique identifier of the package version. */ - package_version_id: components["parameters"]["package-version-id"]; - }; - }; + package_version_id: components['parameters']['package-version-id'] + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Restores a specific package version for a user. * @@ -42236,123 +42198,123 @@ export interface operations { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. */ - "packages/restore-package-version-for-user": { + 'packages/restore-package-version-for-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - username: components["parameters"]["username"]; + package_name: components['parameters']['package-name'] + username: components['parameters']['username'] /** Unique identifier of the package version. */ - package_version_id: components["parameters"]["package-version-id"]; - }; - }; + package_version_id: components['parameters']['package-version-id'] + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "projects/list-for-user": { + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'projects/list-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. */ - state?: "open" | "closed" | "all"; + state?: 'open' | 'closed' | 'all' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["project"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['project'][] + } + } + 422: components['responses']['validation_failed'] + } + } /** These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. */ - "activity/list-received-events-for-user": { + 'activity/list-received-events-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["event"][]; - }; - }; - }; - }; - "activity/list-received-public-events-for-user": { + 'application/json': components['schemas']['event'][] + } + } + } + } + 'activity/list-received-public-events-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["event"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['event'][] + } + } + } + } /** Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user. */ - "repos/list-for-user": { + 'repos/list-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Can be one of `all`, `owner`, `member`. */ - type?: "all" | "owner" | "member"; + type?: 'all' | 'owner' | 'member' /** Can be one of `created`, `updated`, `pushed`, `full_name`. */ - sort?: "created" | "updated" | "pushed" | "full_name"; + sort?: 'created' | 'updated' | 'pushed' | 'full_name' /** Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc` */ - direction?: "asc" | "desc"; + direction?: 'asc' | 'desc' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["minimal-repository"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['minimal-repository'][] + } + } + } + } /** * Gets the summary of the free and paid GitHub Actions minutes used. * @@ -42360,21 +42322,21 @@ export interface operations { * * Access tokens must have the `user` scope. */ - "billing/get-github-actions-billing-user": { + 'billing/get-github-actions-billing-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-billing-usage"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-billing-usage'] + } + } + } + } /** * Gets the free and paid storage used for GitHub Packages in gigabytes. * @@ -42382,21 +42344,21 @@ export interface operations { * * Access tokens must have the `user` scope. */ - "billing/get-github-packages-billing-user": { + 'billing/get-github-packages-billing-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["packages-billing-usage"]; - }; - }; - }; - }; + 'application/json': components['schemas']['packages-billing-usage'] + } + } + } + } /** * Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. * @@ -42404,87 +42366,88 @@ export interface operations { * * Access tokens must have the `user` scope. */ - "billing/get-shared-storage-billing-user": { + 'billing/get-shared-storage-billing-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["combined-billing-usage"]; - }; - }; - }; - }; + 'application/json': components['schemas']['combined-billing-usage'] + } + } + } + } /** * Lists repositories a user has starred. * * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: */ - "activity/list-repos-starred-by-user": { + 'activity/list-repos-starred-by-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** One of `created` (when the repository was starred) or `updated` (when it was last pushed to). */ - sort?: components["parameters"]["sort"]; + sort?: components['parameters']['sort'] /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": (Partial & - Partial) & { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': (Partial & Partial) & { + [key: string]: unknown + } + } + } + } + } /** Lists repositories a user is watching. */ - "activity/list-repos-watched-by-user": { + 'activity/list-repos-watched-by-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["minimal-repository"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['minimal-repository'][] + } + } + } + } /** Get a random sentence from the Zen of GitHub */ - "meta/get-zen": { + 'meta/get-zen': { responses: { /** Response */ 200: { content: { - "text/plain": string; - }; - }; - }; - }; + 'text/plain': string + } + } + } + } } export interface external {} diff --git a/test/v3/expected/github.exported-type.ts b/test/v3/expected/github.exported-type.ts index de5d27a2b..229657c6b 100644 --- a/test/v3/expected/github.exported-type.ts +++ b/test/v3/expected/github.exported-type.ts @@ -4,152 +4,152 @@ */ export type paths = { - "/": { + '/': { /** Get Hypermedia links to resources accessible in GitHub's REST API */ - get: operations["meta/root"]; - }; - "/app": { + get: operations['meta/root'] + } + '/app': { /** * Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/rest/reference/apps#list-installations-for-the-authenticated-app)" endpoint. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - get: operations["apps/get-authenticated"]; - }; - "/app-manifests/{code}/conversions": { + get: operations['apps/get-authenticated'] + } + '/app-manifests/{code}/conversions': { /** Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. */ - post: operations["apps/create-from-manifest"]; - }; - "/app/hook/config": { + post: operations['apps/create-from-manifest'] + } + '/app/hook/config': { /** * Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - get: operations["apps/get-webhook-config-for-app"]; + get: operations['apps/get-webhook-config-for-app'] /** * Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - patch: operations["apps/update-webhook-config-for-app"]; - }; - "/app/hook/deliveries": { + patch: operations['apps/update-webhook-config-for-app'] + } + '/app/hook/deliveries': { /** * Returns a list of webhook deliveries for the webhook configured for a GitHub App. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - get: operations["apps/list-webhook-deliveries"]; - }; - "/app/hook/deliveries/{delivery_id}": { + get: operations['apps/list-webhook-deliveries'] + } + '/app/hook/deliveries/{delivery_id}': { /** * Returns a delivery for the webhook configured for a GitHub App. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - get: operations["apps/get-webhook-delivery"]; - }; - "/app/hook/deliveries/{delivery_id}/attempts": { + get: operations['apps/get-webhook-delivery'] + } + '/app/hook/deliveries/{delivery_id}/attempts': { /** * Redeliver a delivery for the webhook configured for a GitHub App. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - post: operations["apps/redeliver-webhook-delivery"]; - }; - "/app/installations": { + post: operations['apps/redeliver-webhook-delivery'] + } + '/app/installations': { /** * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. * * The permissions the installation has are included under the `permissions` key. */ - get: operations["apps/list-installations"]; - }; - "/app/installations/{installation_id}": { + get: operations['apps/list-installations'] + } + '/app/installations/{installation_id}': { /** * Enables an authenticated GitHub App to find an installation's information using the installation id. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - get: operations["apps/get-installation"]; + get: operations['apps/get-installation'] /** * Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/reference/apps/#suspend-an-app-installation)" endpoint. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - delete: operations["apps/delete-installation"]; - }; - "/app/installations/{installation_id}/access_tokens": { + delete: operations['apps/delete-installation'] + } + '/app/installations/{installation_id}/access_tokens': { /** * Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - post: operations["apps/create-installation-access-token"]; - }; - "/app/installations/{installation_id}/suspended": { + post: operations['apps/create-installation-access-token'] + } + '/app/installations/{installation_id}/suspended': { /** * Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - put: operations["apps/suspend-installation"]; + put: operations['apps/suspend-installation'] /** * Removes a GitHub App installation suspension. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - delete: operations["apps/unsuspend-installation"]; - }; - "/applications/grants": { + delete: operations['apps/unsuspend-installation'] + } + '/applications/grants': { /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * * You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/rest/reference/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `["repo", "user"]`. */ - get: operations["oauth-authorizations/list-grants"]; - }; - "/applications/grants/{grant_id}": { + get: operations['oauth-authorizations/list-grants'] + } + '/applications/grants/{grant_id}': { /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - get: operations["oauth-authorizations/get-grant"]; + get: operations['oauth-authorizations/get-grant'] /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ - delete: operations["oauth-authorizations/delete-grant"]; - }; - "/applications/{client_id}/grant": { + delete: operations['oauth-authorizations/delete-grant'] + } + '/applications/{client_id}/grant': { /** * OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ - delete: operations["apps/delete-authorization"]; - }; - "/applications/{client_id}/token": { + delete: operations['apps/delete-authorization'] + } + '/applications/{client_id}/token': { /** OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the OAuth application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`. */ - post: operations["apps/check-token"]; + post: operations['apps/check-token'] /** OAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. */ - delete: operations["apps/delete-token"]; + delete: operations['apps/delete-token'] /** OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. */ - patch: operations["apps/reset-token"]; - }; - "/applications/{client_id}/token/scoped": { + patch: operations['apps/reset-token'] + } + '/applications/{client_id}/token/scoped': { /** Use a non-scoped user-to-server OAuth access token to create a repository scoped and/or permission scoped user-to-server OAuth access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. */ - post: operations["apps/scope-token"]; - }; - "/apps/{app_slug}": { + post: operations['apps/scope-token'] + } + '/apps/{app_slug}': { /** * **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). * * If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ - get: operations["apps/get-by-slug"]; - }; - "/authorizations": { + get: operations['apps/get-by-slug'] + } + '/authorizations': { /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - get: operations["oauth-authorizations/list-authorizations"]; + get: operations['oauth-authorizations/list-authorizations'] /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * @@ -163,9 +163,9 @@ export type paths = { * * Organizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in [the GitHub Help documentation](https://docs.github.com/articles/about-identity-and-access-management-with-saml-single-sign-on). */ - post: operations["oauth-authorizations/create-authorization"]; - }; - "/authorizations/clients/{client_id}": { + post: operations['oauth-authorizations/create-authorization'] + } + '/authorizations/clients/{client_id}': { /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * @@ -177,9 +177,9 @@ export type paths = { * * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - put: operations["oauth-authorizations/get-or-create-authorization-for-app"]; - }; - "/authorizations/clients/{client_id}/{fingerprint}": { + put: operations['oauth-authorizations/get-or-create-authorization-for-app'] + } + '/authorizations/clients/{client_id}/{fingerprint}': { /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * @@ -189,13 +189,13 @@ export type paths = { * * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." */ - put: operations["oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint"]; - }; - "/authorizations/{authorization_id}": { + put: operations['oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint'] + } + '/authorizations/{authorization_id}': { /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - get: operations["oauth-authorizations/get-authorization"]; + get: operations['oauth-authorizations/get-authorization'] /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - delete: operations["oauth-authorizations/delete-authorization"]; + delete: operations['oauth-authorizations/delete-authorization'] /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * @@ -203,182 +203,182 @@ export type paths = { * * You can only send one of these scope keys at a time. */ - patch: operations["oauth-authorizations/update-authorization"]; - }; - "/codes_of_conduct": { - get: operations["codes-of-conduct/get-all-codes-of-conduct"]; - }; - "/codes_of_conduct/{key}": { - get: operations["codes-of-conduct/get-conduct-code"]; - }; - "/emojis": { + patch: operations['oauth-authorizations/update-authorization'] + } + '/codes_of_conduct': { + get: operations['codes-of-conduct/get-all-codes-of-conduct'] + } + '/codes_of_conduct/{key}': { + get: operations['codes-of-conduct/get-conduct-code'] + } + '/emojis': { /** Lists all the emojis available to use on GitHub. */ - get: operations["emojis/get"]; - }; - "/enterprises/{enterprise}/actions/permissions": { + get: operations['emojis/get'] + } + '/enterprises/{enterprise}/actions/permissions': { /** * Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - get: operations["enterprise-admin/get-github-actions-permissions-enterprise"]; + get: operations['enterprise-admin/get-github-actions-permissions-enterprise'] /** * Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - put: operations["enterprise-admin/set-github-actions-permissions-enterprise"]; - }; - "/enterprises/{enterprise}/actions/permissions/organizations": { + put: operations['enterprise-admin/set-github-actions-permissions-enterprise'] + } + '/enterprises/{enterprise}/actions/permissions/organizations': { /** * Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - get: operations["enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise"]; + get: operations['enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise'] /** * Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - put: operations["enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise"]; - }; - "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}": { + put: operations['enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise'] + } + '/enterprises/{enterprise}/actions/permissions/organizations/{org_id}': { /** * Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - put: operations["enterprise-admin/enable-selected-organization-github-actions-enterprise"]; + put: operations['enterprise-admin/enable-selected-organization-github-actions-enterprise'] /** * Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - delete: operations["enterprise-admin/disable-selected-organization-github-actions-enterprise"]; - }; - "/enterprises/{enterprise}/actions/permissions/selected-actions": { + delete: operations['enterprise-admin/disable-selected-organization-github-actions-enterprise'] + } + '/enterprises/{enterprise}/actions/permissions/selected-actions': { /** * Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - get: operations["enterprise-admin/get-allowed-actions-enterprise"]; + get: operations['enterprise-admin/get-allowed-actions-enterprise'] /** * Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - put: operations["enterprise-admin/set-allowed-actions-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runner-groups": { + put: operations['enterprise-admin/set-allowed-actions-enterprise'] + } + '/enterprises/{enterprise}/actions/runner-groups': { /** * Lists all self-hosted runner groups for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - get: operations["enterprise-admin/list-self-hosted-runner-groups-for-enterprise"]; + get: operations['enterprise-admin/list-self-hosted-runner-groups-for-enterprise'] /** * Creates a new self-hosted runner group for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - post: operations["enterprise-admin/create-self-hosted-runner-group-for-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}": { + post: operations['enterprise-admin/create-self-hosted-runner-group-for-enterprise'] + } + '/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}': { /** * Gets a specific self-hosted runner group for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - get: operations["enterprise-admin/get-self-hosted-runner-group-for-enterprise"]; + get: operations['enterprise-admin/get-self-hosted-runner-group-for-enterprise'] /** * Deletes a self-hosted runner group for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - delete: operations["enterprise-admin/delete-self-hosted-runner-group-from-enterprise"]; + delete: operations['enterprise-admin/delete-self-hosted-runner-group-from-enterprise'] /** * Updates the `name` and `visibility` of a self-hosted runner group in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - patch: operations["enterprise-admin/update-self-hosted-runner-group-for-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations": { + patch: operations['enterprise-admin/update-self-hosted-runner-group-for-enterprise'] + } + '/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations': { /** * Lists the organizations with access to a self-hosted runner group. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - get: operations["enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise"]; + get: operations['enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise'] /** * Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - put: operations["enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}": { + put: operations['enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise'] + } + '/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}': { /** * Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - put: operations["enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise"]; + put: operations['enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise'] /** * Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - delete: operations["enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": { + delete: operations['enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise'] + } + '/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners': { /** * Lists the self-hosted runners that are in a specific enterprise group. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - get: operations["enterprise-admin/list-self-hosted-runners-in-group-for-enterprise"]; + get: operations['enterprise-admin/list-self-hosted-runners-in-group-for-enterprise'] /** * Replaces the list of self-hosted runners that are part of an enterprise runner group. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - put: operations["enterprise-admin/set-self-hosted-runners-in-group-for-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + put: operations['enterprise-admin/set-self-hosted-runners-in-group-for-enterprise'] + } + '/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}': { /** * Adds a self-hosted runner to a runner group configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` * scope to use this endpoint. */ - put: operations["enterprise-admin/add-self-hosted-runner-to-group-for-enterprise"]; + put: operations['enterprise-admin/add-self-hosted-runner-to-group-for-enterprise'] /** * Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - delete: operations["enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runners": { + delete: operations['enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise'] + } + '/enterprises/{enterprise}/actions/runners': { /** * Lists all self-hosted runners configured for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - get: operations["enterprise-admin/list-self-hosted-runners-for-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runners/downloads": { + get: operations['enterprise-admin/list-self-hosted-runners-for-enterprise'] + } + '/enterprises/{enterprise}/actions/runners/downloads': { /** * Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - get: operations["enterprise-admin/list-runner-applications-for-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runners/registration-token": { + get: operations['enterprise-admin/list-runner-applications-for-enterprise'] + } + '/enterprises/{enterprise}/actions/runners/registration-token': { /** * Returns a token that you can pass to the `config` script. The token expires after one hour. * @@ -392,9 +392,9 @@ export type paths = { * ./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN * ``` */ - post: operations["enterprise-admin/create-registration-token-for-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runners/remove-token": { + post: operations['enterprise-admin/create-registration-token-for-enterprise'] + } + '/enterprises/{enterprise}/actions/runners/remove-token': { /** * Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour. * @@ -409,51 +409,51 @@ export type paths = { * ./config.sh remove --token TOKEN * ``` */ - post: operations["enterprise-admin/create-remove-token-for-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runners/{runner_id}": { + post: operations['enterprise-admin/create-remove-token-for-enterprise'] + } + '/enterprises/{enterprise}/actions/runners/{runner_id}': { /** * Gets a specific self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - get: operations["enterprise-admin/get-self-hosted-runner-for-enterprise"]; + get: operations['enterprise-admin/get-self-hosted-runner-for-enterprise'] /** * Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - delete: operations["enterprise-admin/delete-self-hosted-runner-from-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runners/{runner_id}/labels": { + delete: operations['enterprise-admin/delete-self-hosted-runner-from-enterprise'] + } + '/enterprises/{enterprise}/actions/runners/{runner_id}/labels': { /** * Lists all labels for a self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - get: operations["enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise"]; + get: operations['enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise'] /** * Remove all previous custom labels and set the new custom labels for a specific * self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - put: operations["enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise"]; + put: operations['enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise'] /** * Add custom labels to a self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - post: operations["enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise"]; + post: operations['enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise'] /** * Remove all custom labels from a self-hosted runner configured in an * enterprise. Returns the remaining read-only labels from the runner. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - delete: operations["enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runners/{runner_id}/labels/{name}": { + delete: operations['enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise'] + } + '/enterprises/{enterprise}/actions/runners/{runner_id}/labels/{name}': { /** * Remove a custom label from a self-hosted runner configured * in an enterprise. Returns the remaining labels from the runner. @@ -463,20 +463,20 @@ export type paths = { * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - delete: operations["enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise"]; - }; - "/enterprises/{enterprise}/audit-log": { + delete: operations['enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise'] + } + '/enterprises/{enterprise}/audit-log': { /** Gets the audit log for an enterprise. To use this endpoint, you must be an enterprise admin, and you must use an access token with the `admin:enterprise` scope. */ - get: operations["enterprise-admin/get-audit-log"]; - }; - "/enterprises/{enterprise}/secret-scanning/alerts": { + get: operations['enterprise-admin/get-audit-log'] + } + '/enterprises/{enterprise}/secret-scanning/alerts': { /** * Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. * To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). */ - get: operations["secret-scanning/list-alerts-for-enterprise"]; - }; - "/enterprises/{enterprise}/settings/billing/actions": { + get: operations['secret-scanning/list-alerts-for-enterprise'] + } + '/enterprises/{enterprise}/settings/billing/actions': { /** * Gets the summary of the free and paid GitHub Actions minutes used. * @@ -484,16 +484,16 @@ export type paths = { * * The authenticated user must be an enterprise admin. */ - get: operations["billing/get-github-actions-billing-ghe"]; - }; - "/enterprises/{enterprise}/settings/billing/advanced-security": { + get: operations['billing/get-github-actions-billing-ghe'] + } + '/enterprises/{enterprise}/settings/billing/advanced-security': { /** * Gets the GitHub Advanced Security active committers for an enterprise per repository. * Each distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of active_users for each repository. */ - get: operations["billing/get-github-advanced-security-billing-ghe"]; - }; - "/enterprises/{enterprise}/settings/billing/packages": { + get: operations['billing/get-github-advanced-security-billing-ghe'] + } + '/enterprises/{enterprise}/settings/billing/packages': { /** * Gets the free and paid storage used for GitHub Packages in gigabytes. * @@ -501,9 +501,9 @@ export type paths = { * * The authenticated user must be an enterprise admin. */ - get: operations["billing/get-github-packages-billing-ghe"]; - }; - "/enterprises/{enterprise}/settings/billing/shared-storage": { + get: operations['billing/get-github-packages-billing-ghe'] + } + '/enterprises/{enterprise}/settings/billing/shared-storage': { /** * Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. * @@ -511,13 +511,13 @@ export type paths = { * * The authenticated user must be an enterprise admin. */ - get: operations["billing/get-shared-storage-billing-ghe"]; - }; - "/events": { + get: operations['billing/get-shared-storage-billing-ghe'] + } + '/events': { /** We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. */ - get: operations["activity/list-public-events"]; - }; - "/feeds": { + get: operations['activity/list-public-events'] + } + '/feeds': { /** * GitHub provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user: * @@ -531,82 +531,82 @@ export type paths = { * * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ - get: operations["activity/get-feeds"]; - }; - "/gists": { + get: operations['activity/get-feeds'] + } + '/gists': { /** Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists: */ - get: operations["gists/list"]; + get: operations['gists/list'] /** * Allows you to add a new gist with one or more files. * * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. */ - post: operations["gists/create"]; - }; - "/gists/public": { + post: operations['gists/create'] + } + '/gists/public': { /** * List public gists sorted by most recently updated to least recently updated. * * Note: With [pagination](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. */ - get: operations["gists/list-public"]; - }; - "/gists/starred": { + get: operations['gists/list-public'] + } + '/gists/starred': { /** List the authenticated user's starred gists: */ - get: operations["gists/list-starred"]; - }; - "/gists/{gist_id}": { - get: operations["gists/get"]; - delete: operations["gists/delete"]; + get: operations['gists/list-starred'] + } + '/gists/{gist_id}': { + get: operations['gists/get'] + delete: operations['gists/delete'] /** Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged. */ - patch: operations["gists/update"]; - }; - "/gists/{gist_id}/comments": { - get: operations["gists/list-comments"]; - post: operations["gists/create-comment"]; - }; - "/gists/{gist_id}/comments/{comment_id}": { - get: operations["gists/get-comment"]; - delete: operations["gists/delete-comment"]; - patch: operations["gists/update-comment"]; - }; - "/gists/{gist_id}/commits": { - get: operations["gists/list-commits"]; - }; - "/gists/{gist_id}/forks": { - get: operations["gists/list-forks"]; + patch: operations['gists/update'] + } + '/gists/{gist_id}/comments': { + get: operations['gists/list-comments'] + post: operations['gists/create-comment'] + } + '/gists/{gist_id}/comments/{comment_id}': { + get: operations['gists/get-comment'] + delete: operations['gists/delete-comment'] + patch: operations['gists/update-comment'] + } + '/gists/{gist_id}/commits': { + get: operations['gists/list-commits'] + } + '/gists/{gist_id}/forks': { + get: operations['gists/list-forks'] /** **Note**: This was previously `/gists/:gist_id/fork`. */ - post: operations["gists/fork"]; - }; - "/gists/{gist_id}/star": { - get: operations["gists/check-is-starred"]; + post: operations['gists/fork'] + } + '/gists/{gist_id}/star': { + get: operations['gists/check-is-starred'] /** Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - put: operations["gists/star"]; - delete: operations["gists/unstar"]; - }; - "/gists/{gist_id}/{sha}": { - get: operations["gists/get-revision"]; - }; - "/gitignore/templates": { + put: operations['gists/star'] + delete: operations['gists/unstar'] + } + '/gists/{gist_id}/{sha}': { + get: operations['gists/get-revision'] + } + '/gitignore/templates': { /** List all templates available to pass as an option when [creating a repository](https://docs.github.com/rest/reference/repos#create-a-repository-for-the-authenticated-user). */ - get: operations["gitignore/get-all-templates"]; - }; - "/gitignore/templates/{name}": { + get: operations['gitignore/get-all-templates'] + } + '/gitignore/templates/{name}': { /** * The API also allows fetching the source of a single template. * Use the raw [media type](https://docs.github.com/rest/overview/media-types/) to get the raw contents. */ - get: operations["gitignore/get-template"]; - }; - "/installation/repositories": { + get: operations['gitignore/get-template'] + } + '/installation/repositories': { /** * List repositories that an app installation can access. * * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ - get: operations["apps/list-repos-accessible-to-installation"]; - }; - "/installation/token": { + get: operations['apps/list-repos-accessible-to-installation'] + } + '/installation/token': { /** * Revokes the installation token you're using to authenticate as an installation and access this endpoint. * @@ -614,9 +614,9 @@ export type paths = { * * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ - delete: operations["apps/revoke-installation-access-token"]; - }; - "/issues": { + delete: operations['apps/revoke-installation-access-token'] + } + '/issues': { /** * List issues assigned to the authenticated user across all visible repositories including owned repositories, member * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not @@ -628,97 +628,97 @@ export type paths = { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - get: operations["issues/list"]; - }; - "/licenses": { - get: operations["licenses/get-all-commonly-used"]; - }; - "/licenses/{license}": { - get: operations["licenses/get"]; - }; - "/markdown": { - post: operations["markdown/render"]; - }; - "/markdown/raw": { + get: operations['issues/list'] + } + '/licenses': { + get: operations['licenses/get-all-commonly-used'] + } + '/licenses/{license}': { + get: operations['licenses/get'] + } + '/markdown': { + post: operations['markdown/render'] + } + '/markdown/raw': { /** You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less. */ - post: operations["markdown/render-raw"]; - }; - "/marketplace_listing/accounts/{account_id}": { + post: operations['markdown/render-raw'] + } + '/marketplace_listing/accounts/{account_id}': { /** * Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - get: operations["apps/get-subscription-plan-for-account"]; - }; - "/marketplace_listing/plans": { + get: operations['apps/get-subscription-plan-for-account'] + } + '/marketplace_listing/plans': { /** * Lists all plans that are part of your GitHub Marketplace listing. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - get: operations["apps/list-plans"]; - }; - "/marketplace_listing/plans/{plan_id}/accounts": { + get: operations['apps/list-plans'] + } + '/marketplace_listing/plans/{plan_id}/accounts': { /** * Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - get: operations["apps/list-accounts-for-plan"]; - }; - "/marketplace_listing/stubbed/accounts/{account_id}": { + get: operations['apps/list-accounts-for-plan'] + } + '/marketplace_listing/stubbed/accounts/{account_id}': { /** * Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - get: operations["apps/get-subscription-plan-for-account-stubbed"]; - }; - "/marketplace_listing/stubbed/plans": { + get: operations['apps/get-subscription-plan-for-account-stubbed'] + } + '/marketplace_listing/stubbed/plans': { /** * Lists all plans that are part of your GitHub Marketplace listing. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - get: operations["apps/list-plans-stubbed"]; - }; - "/marketplace_listing/stubbed/plans/{plan_id}/accounts": { + get: operations['apps/list-plans-stubbed'] + } + '/marketplace_listing/stubbed/plans/{plan_id}/accounts': { /** * Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - get: operations["apps/list-accounts-for-plan-stubbed"]; - }; - "/meta": { + get: operations['apps/list-accounts-for-plan-stubbed'] + } + '/meta': { /** * Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://docs.github.com/articles/about-github-s-ip-addresses/)." * * **Note:** The IP addresses shown in the documentation's response are only example values. You must always query the API directly to get the latest list of IP addresses. */ - get: operations["meta/get"]; - }; - "/networks/{owner}/{repo}/events": { - get: operations["activity/list-public-events-for-repo-network"]; - }; - "/notifications": { + get: operations['meta/get'] + } + '/networks/{owner}/{repo}/events': { + get: operations['activity/list-public-events-for-repo-network'] + } + '/notifications': { /** List all notifications for the current user, sorted by most recently updated. */ - get: operations["activity/list-notifications-for-authenticated-user"]; + get: operations['activity/list-notifications-for-authenticated-user'] /** Marks all notifications as "read" removes it from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ - put: operations["activity/mark-notifications-as-read"]; - }; - "/notifications/threads/{thread_id}": { - get: operations["activity/get-thread"]; - patch: operations["activity/mark-thread-as-read"]; - }; - "/notifications/threads/{thread_id}/subscription": { + put: operations['activity/mark-notifications-as-read'] + } + '/notifications/threads/{thread_id}': { + get: operations['activity/get-thread'] + patch: operations['activity/mark-thread-as-read'] + } + '/notifications/threads/{thread_id}/subscription': { /** * This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/rest/reference/activity#get-a-repository-subscription). * * Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. */ - get: operations["activity/get-thread-subscription-for-authenticated-user"]; + get: operations['activity/get-thread-subscription-for-authenticated-user'] /** * If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**. * @@ -726,60 +726,60 @@ export type paths = { * * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/rest/reference/activity#delete-a-thread-subscription) endpoint. */ - put: operations["activity/set-thread-subscription"]; + put: operations['activity/set-thread-subscription'] /** Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/rest/reference/activity#set-a-thread-subscription) endpoint and set `ignore` to `true`. */ - delete: operations["activity/delete-thread-subscription"]; - }; - "/octocat": { + delete: operations['activity/delete-thread-subscription'] + } + '/octocat': { /** Get the octocat as ASCII art */ - get: operations["meta/get-octocat"]; - }; - "/organizations": { + get: operations['meta/get-octocat'] + } + '/organizations': { /** * Lists all organizations, in the order that they were created on GitHub. * * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of organizations. */ - get: operations["orgs/list"]; - }; - "/organizations/{organization_id}/custom_roles": { + get: operations['orgs/list'] + } + '/organizations/{organization_id}/custom_roles': { /** * List the custom repository roles available in this organization. In order to see custom * repository roles in an organization, the authenticated user must be an organization owner. * * For more information on custom repository roles, see "[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)". */ - get: operations["orgs/list-custom-roles"]; - }; - "/organizations/{org}/team/{team_slug}/external-groups": { + get: operations['orgs/list-custom-roles'] + } + '/organizations/{org}/team/{team_slug}/external-groups': { /** * Lists a connection between a team and an external group. * * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ - get: operations["teams/list-linked-external-idp-groups-to-team-for-org"]; - }; - "/orgs/{org}": { + get: operations['teams/list-linked-external-idp-groups-to-team-for-org'] + } + '/orgs/{org}': { /** * To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). * * GitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub plan. See "[Authenticating with GitHub Apps](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/)" for details. For an example response, see 'Response with GitHub plan information' below." */ - get: operations["orgs/get"]; + get: operations['orgs/get'] /** * **Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). * * Enables an authenticated organization owner with the `admin:org` scope to update the organization's profile and member privileges. */ - patch: operations["orgs/update"]; - }; - "/orgs/{org}/actions/permissions": { + patch: operations['orgs/update'] + } + '/orgs/{org}/actions/permissions': { /** * Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - get: operations["actions/get-github-actions-permissions-organization"]; + get: operations['actions/get-github-actions-permissions-organization'] /** * Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization. * @@ -787,43 +787,43 @@ export type paths = { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - put: operations["actions/set-github-actions-permissions-organization"]; - }; - "/orgs/{org}/actions/permissions/repositories": { + put: operations['actions/set-github-actions-permissions-organization'] + } + '/orgs/{org}/actions/permissions/repositories': { /** * Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - get: operations["actions/list-selected-repositories-enabled-github-actions-organization"]; + get: operations['actions/list-selected-repositories-enabled-github-actions-organization'] /** * Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - put: operations["actions/set-selected-repositories-enabled-github-actions-organization"]; - }; - "/orgs/{org}/actions/permissions/repositories/{repository_id}": { + put: operations['actions/set-selected-repositories-enabled-github-actions-organization'] + } + '/orgs/{org}/actions/permissions/repositories/{repository_id}': { /** * Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - put: operations["actions/enable-selected-repository-github-actions-organization"]; + put: operations['actions/enable-selected-repository-github-actions-organization'] /** * Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - delete: operations["actions/disable-selected-repository-github-actions-organization"]; - }; - "/orgs/{org}/actions/permissions/selected-actions": { + delete: operations['actions/disable-selected-repository-github-actions-organization'] + } + '/orgs/{org}/actions/permissions/selected-actions': { /** * Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."" * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - get: operations["actions/get-allowed-actions-organization"]; + get: operations['actions/get-allowed-actions-organization'] /** * Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * @@ -833,25 +833,25 @@ export type paths = { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - put: operations["actions/set-allowed-actions-organization"]; - }; - "/orgs/{org}/actions/permissions/workflow": { + put: operations['actions/set-allowed-actions-organization'] + } + '/orgs/{org}/actions/permissions/workflow': { /** * Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, * as well if GitHub Actions can submit approving pull request reviews. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - get: operations["actions/get-github-actions-default-workflow-permissions-organization"]; + get: operations['actions/get-github-actions-default-workflow-permissions-organization'] /** * Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions * can submit approving pull request reviews. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - put: operations["actions/set-github-actions-default-workflow-permissions-organization"]; - }; - "/orgs/{org}/actions/runner-groups": { + put: operations['actions/set-github-actions-default-workflow-permissions-organization'] + } + '/orgs/{org}/actions/runner-groups': { /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -859,7 +859,7 @@ export type paths = { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - get: operations["actions/list-self-hosted-runner-groups-for-org"]; + get: operations['actions/list-self-hosted-runner-groups-for-org'] /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -867,9 +867,9 @@ export type paths = { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - post: operations["actions/create-self-hosted-runner-group-for-org"]; - }; - "/orgs/{org}/actions/runner-groups/{runner_group_id}": { + post: operations['actions/create-self-hosted-runner-group-for-org'] + } + '/orgs/{org}/actions/runner-groups/{runner_group_id}': { /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -877,7 +877,7 @@ export type paths = { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - get: operations["actions/get-self-hosted-runner-group-for-org"]; + get: operations['actions/get-self-hosted-runner-group-for-org'] /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -885,7 +885,7 @@ export type paths = { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - delete: operations["actions/delete-self-hosted-runner-group-from-org"]; + delete: operations['actions/delete-self-hosted-runner-group-from-org'] /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -893,9 +893,9 @@ export type paths = { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - patch: operations["actions/update-self-hosted-runner-group-for-org"]; - }; - "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": { + patch: operations['actions/update-self-hosted-runner-group-for-org'] + } + '/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories': { /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -903,7 +903,7 @@ export type paths = { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - get: operations["actions/list-repo-access-to-self-hosted-runner-group-in-org"]; + get: operations['actions/list-repo-access-to-self-hosted-runner-group-in-org'] /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -911,9 +911,9 @@ export type paths = { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - put: operations["actions/set-repo-access-to-self-hosted-runner-group-in-org"]; - }; - "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": { + put: operations['actions/set-repo-access-to-self-hosted-runner-group-in-org'] + } + '/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}': { /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -923,7 +923,7 @@ export type paths = { * You must authenticate using an access token with the `admin:org` * scope to use this endpoint. */ - put: operations["actions/add-repo-access-to-self-hosted-runner-group-in-org"]; + put: operations['actions/add-repo-access-to-self-hosted-runner-group-in-org'] /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -932,9 +932,9 @@ export type paths = { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - delete: operations["actions/remove-repo-access-to-self-hosted-runner-group-in-org"]; - }; - "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners": { + delete: operations['actions/remove-repo-access-to-self-hosted-runner-group-in-org'] + } + '/orgs/{org}/actions/runner-groups/{runner_group_id}/runners': { /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -942,7 +942,7 @@ export type paths = { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - get: operations["actions/list-self-hosted-runners-in-group-for-org"]; + get: operations['actions/list-self-hosted-runners-in-group-for-org'] /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -950,9 +950,9 @@ export type paths = { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - put: operations["actions/set-self-hosted-runners-in-group-for-org"]; - }; - "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + put: operations['actions/set-self-hosted-runners-in-group-for-org'] + } + '/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}': { /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -962,7 +962,7 @@ export type paths = { * You must authenticate using an access token with the `admin:org` * scope to use this endpoint. */ - put: operations["actions/add-self-hosted-runner-to-group-for-org"]; + put: operations['actions/add-self-hosted-runner-to-group-for-org'] /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -971,25 +971,25 @@ export type paths = { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - delete: operations["actions/remove-self-hosted-runner-from-group-for-org"]; - }; - "/orgs/{org}/actions/runners": { + delete: operations['actions/remove-self-hosted-runner-from-group-for-org'] + } + '/orgs/{org}/actions/runners': { /** * Lists all self-hosted runners configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - get: operations["actions/list-self-hosted-runners-for-org"]; - }; - "/orgs/{org}/actions/runners/downloads": { + get: operations['actions/list-self-hosted-runners-for-org'] + } + '/orgs/{org}/actions/runners/downloads': { /** * Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - get: operations["actions/list-runner-applications-for-org"]; - }; - "/orgs/{org}/actions/runners/registration-token": { + get: operations['actions/list-runner-applications-for-org'] + } + '/orgs/{org}/actions/runners/registration-token': { /** * Returns a token that you can pass to the `config` script. The token expires after one hour. * @@ -1003,9 +1003,9 @@ export type paths = { * ./config.sh --url https://github.com/octo-org --token TOKEN * ``` */ - post: operations["actions/create-registration-token-for-org"]; - }; - "/orgs/{org}/actions/runners/remove-token": { + post: operations['actions/create-registration-token-for-org'] + } + '/orgs/{org}/actions/runners/remove-token': { /** * Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour. * @@ -1020,51 +1020,51 @@ export type paths = { * ./config.sh remove --token TOKEN * ``` */ - post: operations["actions/create-remove-token-for-org"]; - }; - "/orgs/{org}/actions/runners/{runner_id}": { + post: operations['actions/create-remove-token-for-org'] + } + '/orgs/{org}/actions/runners/{runner_id}': { /** * Gets a specific self-hosted runner configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - get: operations["actions/get-self-hosted-runner-for-org"]; + get: operations['actions/get-self-hosted-runner-for-org'] /** * Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - delete: operations["actions/delete-self-hosted-runner-from-org"]; - }; - "/orgs/{org}/actions/runners/{runner_id}/labels": { + delete: operations['actions/delete-self-hosted-runner-from-org'] + } + '/orgs/{org}/actions/runners/{runner_id}/labels': { /** * Lists all labels for a self-hosted runner configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - get: operations["actions/list-labels-for-self-hosted-runner-for-org"]; + get: operations['actions/list-labels-for-self-hosted-runner-for-org'] /** * Remove all previous custom labels and set the new custom labels for a specific * self-hosted runner configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - put: operations["actions/set-custom-labels-for-self-hosted-runner-for-org"]; + put: operations['actions/set-custom-labels-for-self-hosted-runner-for-org'] /** * Add custom labels to a self-hosted runner configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - post: operations["actions/add-custom-labels-to-self-hosted-runner-for-org"]; + post: operations['actions/add-custom-labels-to-self-hosted-runner-for-org'] /** * Remove all custom labels from a self-hosted runner configured in an * organization. Returns the remaining read-only labels from the runner. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - delete: operations["actions/remove-all-custom-labels-from-self-hosted-runner-for-org"]; - }; - "/orgs/{org}/actions/runners/{runner_id}/labels/{name}": { + delete: operations['actions/remove-all-custom-labels-from-self-hosted-runner-for-org'] + } + '/orgs/{org}/actions/runners/{runner_id}/labels/{name}': { /** * Remove a custom label from a self-hosted runner configured * in an organization. Returns the remaining labels from the runner. @@ -1074,19 +1074,19 @@ export type paths = { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - delete: operations["actions/remove-custom-label-from-self-hosted-runner-for-org"]; - }; - "/orgs/{org}/actions/secrets": { + delete: operations['actions/remove-custom-label-from-self-hosted-runner-for-org'] + } + '/orgs/{org}/actions/secrets': { /** Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - get: operations["actions/list-org-secrets"]; - }; - "/orgs/{org}/actions/secrets/public-key": { + get: operations['actions/list-org-secrets'] + } + '/orgs/{org}/actions/secrets/public-key': { /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - get: operations["actions/get-org-public-key"]; - }; - "/orgs/{org}/actions/secrets/{secret_name}": { + get: operations['actions/get-org-public-key'] + } + '/orgs/{org}/actions/secrets/{secret_name}': { /** Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - get: operations["actions/get-org-secret"]; + get: operations['actions/get-org-secret'] /** * Creates or updates an organization secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -1164,40 +1164,40 @@ export type paths = { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - put: operations["actions/create-or-update-org-secret"]; + put: operations['actions/create-or-update-org-secret'] /** Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - delete: operations["actions/delete-org-secret"]; - }; - "/orgs/{org}/actions/secrets/{secret_name}/repositories": { + delete: operations['actions/delete-org-secret'] + } + '/orgs/{org}/actions/secrets/{secret_name}/repositories': { /** Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - get: operations["actions/list-selected-repos-for-org-secret"]; + get: operations['actions/list-selected-repos-for-org-secret'] /** Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - put: operations["actions/set-selected-repos-for-org-secret"]; - }; - "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}": { + put: operations['actions/set-selected-repos-for-org-secret'] + } + '/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}': { /** Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - put: operations["actions/add-selected-repo-to-org-secret"]; + put: operations['actions/add-selected-repo-to-org-secret'] /** Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - delete: operations["actions/remove-selected-repo-from-org-secret"]; - }; - "/orgs/{org}/audit-log": { + delete: operations['actions/remove-selected-repo-from-org-secret'] + } + '/orgs/{org}/audit-log': { /** * Gets the audit log for an organization. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization)." * * This endpoint is available for organizations on GitHub Enterprise Cloud. To use this endpoint, you must be an organization owner, and you must use an access token with the `admin:org` scope. GitHub Apps must have the `organization_administration` read permission to use this endpoint. */ - get: operations["orgs/get-audit-log"]; - }; - "/orgs/{org}/blocks": { + get: operations['orgs/get-audit-log'] + } + '/orgs/{org}/blocks': { /** List the users blocked by an organization. */ - get: operations["orgs/list-blocked-users"]; - }; - "/orgs/{org}/blocks/{username}": { - get: operations["orgs/check-blocked-user"]; - put: operations["orgs/block-user"]; - delete: operations["orgs/unblock-user"]; - }; - "/orgs/{org}/code-scanning/alerts": { + get: operations['orgs/list-blocked-users'] + } + '/orgs/{org}/blocks/{username}': { + get: operations['orgs/check-blocked-user'] + put: operations['orgs/block-user'] + delete: operations['orgs/unblock-user'] + } + '/orgs/{org}/code-scanning/alerts': { /** * Lists all code scanning alerts for the default branch (usually `main` * or `master`) for all eligible repositories in an organization. @@ -1205,35 +1205,35 @@ export type paths = { * * GitHub Apps must have the `security_events` read permission to use this endpoint. */ - get: operations["code-scanning/list-alerts-for-org"]; - }; - "/orgs/{org}/credential-authorizations": { + get: operations['code-scanning/list-alerts-for-org'] + } + '/orgs/{org}/credential-authorizations': { /** * Listing and deleting credential authorizations is available to organizations with GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products). * * An authenticated organization owner with the `read:org` scope can list all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials are either personal access tokens or SSH keys that organization members have authorized for the organization. For more information, see [About authentication with SAML single sign-on](https://docs.github.com/en/articles/about-authentication-with-saml-single-sign-on). */ - get: operations["orgs/list-saml-sso-authorizations"]; - }; - "/orgs/{org}/credential-authorizations/{credential_id}": { + get: operations['orgs/list-saml-sso-authorizations'] + } + '/orgs/{org}/credential-authorizations/{credential_id}': { /** * Listing and deleting credential authorizations is available to organizations with GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products). * * An authenticated organization owner with the `admin:org` scope can remove a credential authorization for an organization that uses SAML SSO. Once you remove someone's credential authorization, they will need to create a new personal access token or SSH key and authorize it for the organization they want to access. */ - delete: operations["orgs/remove-saml-sso-authorization"]; - }; - "/orgs/{org}/dependabot/secrets": { + delete: operations['orgs/remove-saml-sso-authorization'] + } + '/orgs/{org}/dependabot/secrets': { /** Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - get: operations["dependabot/list-org-secrets"]; - }; - "/orgs/{org}/dependabot/secrets/public-key": { + get: operations['dependabot/list-org-secrets'] + } + '/orgs/{org}/dependabot/secrets/public-key': { /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - get: operations["dependabot/get-org-public-key"]; - }; - "/orgs/{org}/dependabot/secrets/{secret_name}": { + get: operations['dependabot/get-org-public-key'] + } + '/orgs/{org}/dependabot/secrets/{secret_name}': { /** Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - get: operations["dependabot/get-org-secret"]; + get: operations['dependabot/get-org-secret'] /** * Creates or updates an organization secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -1311,130 +1311,130 @@ export type paths = { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - put: operations["dependabot/create-or-update-org-secret"]; + put: operations['dependabot/create-or-update-org-secret'] /** Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - delete: operations["dependabot/delete-org-secret"]; - }; - "/orgs/{org}/dependabot/secrets/{secret_name}/repositories": { + delete: operations['dependabot/delete-org-secret'] + } + '/orgs/{org}/dependabot/secrets/{secret_name}/repositories': { /** Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - get: operations["dependabot/list-selected-repos-for-org-secret"]; + get: operations['dependabot/list-selected-repos-for-org-secret'] /** Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - put: operations["dependabot/set-selected-repos-for-org-secret"]; - }; - "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}": { + put: operations['dependabot/set-selected-repos-for-org-secret'] + } + '/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}': { /** Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - put: operations["dependabot/add-selected-repo-to-org-secret"]; + put: operations['dependabot/add-selected-repo-to-org-secret'] /** Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - delete: operations["dependabot/remove-selected-repo-from-org-secret"]; - }; - "/orgs/{org}/events": { - get: operations["activity/list-public-org-events"]; - }; - "/orgs/{org}/external-group/{group_id}": { + delete: operations['dependabot/remove-selected-repo-from-org-secret'] + } + '/orgs/{org}/events': { + get: operations['activity/list-public-org-events'] + } + '/orgs/{org}/external-group/{group_id}': { /** * Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to. * * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ - get: operations["teams/external-idp-group-info-for-org"]; - }; - "/orgs/{org}/external-groups": { + get: operations['teams/external-idp-group-info-for-org'] + } + '/orgs/{org}/external-groups': { /** * Lists external groups available in an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." * * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ - get: operations["teams/list-external-idp-groups-for-org"]; - }; - "/orgs/{org}/failed_invitations": { + get: operations['teams/list-external-idp-groups-for-org'] + } + '/orgs/{org}/failed_invitations': { /** The return hash contains `failed_at` and `failed_reason` fields which represent the time at which the invitation failed and the reason for the failure. */ - get: operations["orgs/list-failed-invitations"]; - }; - "/orgs/{org}/hooks": { - get: operations["orgs/list-webhooks"]; + get: operations['orgs/list-failed-invitations'] + } + '/orgs/{org}/hooks': { + get: operations['orgs/list-webhooks'] /** Here's how you can create a hook that posts payloads in JSON format: */ - post: operations["orgs/create-webhook"]; - }; - "/orgs/{org}/hooks/{hook_id}": { + post: operations['orgs/create-webhook'] + } + '/orgs/{org}/hooks/{hook_id}': { /** Returns a webhook configured in an organization. To get only the webhook `config` properties, see "[Get a webhook configuration for an organization](/rest/reference/orgs#get-a-webhook-configuration-for-an-organization)." */ - get: operations["orgs/get-webhook"]; - delete: operations["orgs/delete-webhook"]; + get: operations['orgs/get-webhook'] + delete: operations['orgs/delete-webhook'] /** Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for an organization](/rest/reference/orgs#update-a-webhook-configuration-for-an-organization)." */ - patch: operations["orgs/update-webhook"]; - }; - "/orgs/{org}/hooks/{hook_id}/config": { + patch: operations['orgs/update-webhook'] + } + '/orgs/{org}/hooks/{hook_id}/config': { /** * Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/reference/orgs#get-an-organization-webhook)." * * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission. */ - get: operations["orgs/get-webhook-config-for-org"]; + get: operations['orgs/get-webhook-config-for-org'] /** * Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/reference/orgs#update-an-organization-webhook)." * * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission. */ - patch: operations["orgs/update-webhook-config-for-org"]; - }; - "/orgs/{org}/hooks/{hook_id}/deliveries": { + patch: operations['orgs/update-webhook-config-for-org'] + } + '/orgs/{org}/hooks/{hook_id}/deliveries': { /** Returns a list of webhook deliveries for a webhook configured in an organization. */ - get: operations["orgs/list-webhook-deliveries"]; - }; - "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": { + get: operations['orgs/list-webhook-deliveries'] + } + '/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}': { /** Returns a delivery for a webhook configured in an organization. */ - get: operations["orgs/get-webhook-delivery"]; - }; - "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { + get: operations['orgs/get-webhook-delivery'] + } + '/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts': { /** Redeliver a delivery for a webhook configured in an organization. */ - post: operations["orgs/redeliver-webhook-delivery"]; - }; - "/orgs/{org}/hooks/{hook_id}/pings": { + post: operations['orgs/redeliver-webhook-delivery'] + } + '/orgs/{org}/hooks/{hook_id}/pings': { /** This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. */ - post: operations["orgs/ping-webhook"]; - }; - "/orgs/{org}/installation": { + post: operations['orgs/ping-webhook'] + } + '/orgs/{org}/installation': { /** * Enables an authenticated GitHub App to find the organization's installation information. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - get: operations["apps/get-org-installation"]; - }; - "/orgs/{org}/installations": { + get: operations['apps/get-org-installation'] + } + '/orgs/{org}/installations': { /** Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint. */ - get: operations["orgs/list-app-installations"]; - }; - "/orgs/{org}/interaction-limits": { + get: operations['orgs/list-app-installations'] + } + '/orgs/{org}/interaction-limits': { /** Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response. */ - get: operations["interactions/get-restrictions-for-org"]; + get: operations['interactions/get-restrictions-for-org'] /** Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization. */ - put: operations["interactions/set-restrictions-for-org"]; + put: operations['interactions/set-restrictions-for-org'] /** Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions. */ - delete: operations["interactions/remove-restrictions-for-org"]; - }; - "/orgs/{org}/invitations": { + delete: operations['interactions/remove-restrictions-for-org'] + } + '/orgs/{org}/invitations': { /** The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. */ - get: operations["orgs/list-pending-invitations"]; + get: operations['orgs/list-pending-invitations'] /** * Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - post: operations["orgs/create-invitation"]; - }; - "/orgs/{org}/invitations/{invitation_id}": { + post: operations['orgs/create-invitation'] + } + '/orgs/{org}/invitations/{invitation_id}': { /** * Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). */ - delete: operations["orgs/cancel-invitation"]; - }; - "/orgs/{org}/invitations/{invitation_id}/teams": { + delete: operations['orgs/cancel-invitation'] + } + '/orgs/{org}/invitations/{invitation_id}/teams': { /** List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner. */ - get: operations["orgs/list-invitation-teams"]; - }; - "/orgs/{org}/issues": { + get: operations['orgs/list-invitation-teams'] + } + '/orgs/{org}/issues': { /** * List issues in an organization assigned to the authenticated user. * @@ -1443,21 +1443,21 @@ export type paths = { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - get: operations["issues/list-for-org"]; - }; - "/orgs/{org}/members": { + get: operations['issues/list-for-org'] + } + '/orgs/{org}/members': { /** List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned. */ - get: operations["orgs/list-members"]; - }; - "/orgs/{org}/members/{username}": { + get: operations['orgs/list-members'] + } + '/orgs/{org}/members/{username}': { /** Check if a user is, publicly or privately, a member of the organization. */ - get: operations["orgs/check-membership-for-user"]; + get: operations['orgs/check-membership-for-user'] /** Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories. */ - delete: operations["orgs/remove-member"]; - }; - "/orgs/{org}/memberships/{username}": { + delete: operations['orgs/remove-member'] + } + '/orgs/{org}/memberships/{username}': { /** In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status. */ - get: operations["orgs/get-membership-for-user"]; + get: operations['orgs/get-membership-for-user'] /** * Only authenticated organization owners can add a member to the organization or update the member's role. * @@ -1469,21 +1469,21 @@ export type paths = { * * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. */ - put: operations["orgs/set-membership-for-user"]; + put: operations['orgs/set-membership-for-user'] /** * In order to remove a user's membership with an organization, the authenticated user must be an organization owner. * * If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases. */ - delete: operations["orgs/remove-membership-for-user"]; - }; - "/orgs/{org}/migrations": { + delete: operations['orgs/remove-membership-for-user'] + } + '/orgs/{org}/migrations': { /** Lists the most recent migrations. */ - get: operations["migrations/list-for-org"]; + get: operations['migrations/list-for-org'] /** Initiates the generation of a migration archive. */ - post: operations["migrations/start-for-org"]; - }; - "/orgs/{org}/migrations/{migration_id}": { + post: operations['migrations/start-for-org'] + } + '/orgs/{org}/migrations/{migration_id}': { /** * Fetches the status of a migration. * @@ -1494,49 +1494,49 @@ export type paths = { * * `exported`, which means the migration finished successfully. * * `failed`, which means the migration failed. */ - get: operations["migrations/get-status-for-org"]; - }; - "/orgs/{org}/migrations/{migration_id}/archive": { + get: operations['migrations/get-status-for-org'] + } + '/orgs/{org}/migrations/{migration_id}/archive': { /** Fetches the URL to a migration archive. */ - get: operations["migrations/download-archive-for-org"]; + get: operations['migrations/download-archive-for-org'] /** Deletes a previous migration archive. Migration archives are automatically deleted after seven days. */ - delete: operations["migrations/delete-archive-for-org"]; - }; - "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock": { + delete: operations['migrations/delete-archive-for-org'] + } + '/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock': { /** Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/rest/reference/repos#delete-a-repository) when the migration is complete and you no longer need the source data. */ - delete: operations["migrations/unlock-repo-for-org"]; - }; - "/orgs/{org}/migrations/{migration_id}/repositories": { + delete: operations['migrations/unlock-repo-for-org'] + } + '/orgs/{org}/migrations/{migration_id}/repositories': { /** List all the repositories for this organization migration. */ - get: operations["migrations/list-repos-for-org"]; - }; - "/orgs/{org}/outside_collaborators": { + get: operations['migrations/list-repos-for-org'] + } + '/orgs/{org}/outside_collaborators': { /** List all users who are outside collaborators of an organization. */ - get: operations["orgs/list-outside-collaborators"]; - }; - "/orgs/{org}/outside_collaborators/{username}": { + get: operations['orgs/list-outside-collaborators'] + } + '/orgs/{org}/outside_collaborators/{username}': { /** When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://docs.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)". */ - put: operations["orgs/convert-member-to-outside-collaborator"]; + put: operations['orgs/convert-member-to-outside-collaborator'] /** Removing a user from this list will remove them from all the organization's repositories. */ - delete: operations["orgs/remove-outside-collaborator"]; - }; - "/orgs/{org}/packages": { + delete: operations['orgs/remove-outside-collaborator'] + } + '/orgs/{org}/packages': { /** * Lists all packages in an organization readable by the user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/list-packages-for-organization"]; - }; - "/orgs/{org}/packages/{package_type}/{package_name}": { + get: operations['packages/list-packages-for-organization'] + } + '/orgs/{org}/packages/{package_type}/{package_name}': { /** * Gets a specific package in an organization. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/get-package-for-organization"]; + get: operations['packages/get-package-for-organization'] /** * Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * @@ -1544,9 +1544,9 @@ export type paths = { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. */ - delete: operations["packages/delete-package-for-org"]; - }; - "/orgs/{org}/packages/{package_type}/{package_name}/restore": { + delete: operations['packages/delete-package-for-org'] + } + '/orgs/{org}/packages/{package_type}/{package_name}/restore': { /** * Restores an entire package in an organization. * @@ -1558,25 +1558,25 @@ export type paths = { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. */ - post: operations["packages/restore-package-for-org"]; - }; - "/orgs/{org}/packages/{package_type}/{package_name}/versions": { + post: operations['packages/restore-package-for-org'] + } + '/orgs/{org}/packages/{package_type}/{package_name}/versions': { /** * Returns all package versions for a package owned by an organization. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/get-all-package-versions-for-package-owned-by-org"]; - }; - "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}": { + get: operations['packages/get-all-package-versions-for-package-owned-by-org'] + } + '/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}': { /** * Gets a specific package version in an organization. * * You must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/get-package-version-for-organization"]; + get: operations['packages/get-package-version-for-organization'] /** * Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * @@ -1584,9 +1584,9 @@ export type paths = { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. */ - delete: operations["packages/delete-package-version-for-org"]; - }; - "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { + delete: operations['packages/delete-package-version-for-org'] + } + '/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore': { /** * Restores a specific package version in an organization. * @@ -1598,31 +1598,31 @@ export type paths = { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. */ - post: operations["packages/restore-package-version-for-org"]; - }; - "/orgs/{org}/projects": { + post: operations['packages/restore-package-version-for-org'] + } + '/orgs/{org}/projects': { /** Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - get: operations["projects/list-for-org"]; + get: operations['projects/list-for-org'] /** Creates an organization project board. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - post: operations["projects/create-for-org"]; - }; - "/orgs/{org}/public_members": { + post: operations['projects/create-for-org'] + } + '/orgs/{org}/public_members': { /** Members of an organization can choose to have their membership publicized or not. */ - get: operations["orgs/list-public-members"]; - }; - "/orgs/{org}/public_members/{username}": { - get: operations["orgs/check-public-membership-for-user"]; + get: operations['orgs/list-public-members'] + } + '/orgs/{org}/public_members/{username}': { + get: operations['orgs/check-public-membership-for-user'] /** * The user can publicize their own membership. (A user cannot publicize the membership for another user.) * * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - put: operations["orgs/set-public-membership-for-authenticated-user"]; - delete: operations["orgs/remove-public-membership-for-authenticated-user"]; - }; - "/orgs/{org}/repos": { + put: operations['orgs/set-public-membership-for-authenticated-user'] + delete: operations['orgs/remove-public-membership-for-authenticated-user'] + } + '/orgs/{org}/repos': { /** Lists repositories for the specified organization. */ - get: operations["repos/list-for-org"]; + get: operations['repos/list-for-org'] /** * Creates a new repository in the specified organization. The authenticated user must be a member of the organization. * @@ -1633,18 +1633,18 @@ export type paths = { * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. * * `repo` scope to create a private repository */ - post: operations["repos/create-in-org"]; - }; - "/orgs/{org}/secret-scanning/alerts": { + post: operations['repos/create-in-org'] + } + '/orgs/{org}/secret-scanning/alerts': { /** * Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest. * To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. */ - get: operations["secret-scanning/list-alerts-for-org"]; - }; - "/orgs/{org}/settings/billing/actions": { + get: operations['secret-scanning/list-alerts-for-org'] + } + '/orgs/{org}/settings/billing/actions': { /** * Gets the summary of the free and paid GitHub Actions minutes used. * @@ -1652,17 +1652,17 @@ export type paths = { * * Access tokens must have the `repo` or `admin:org` scope. */ - get: operations["billing/get-github-actions-billing-org"]; - }; - "/orgs/{org}/settings/billing/advanced-security": { + get: operations['billing/get-github-actions-billing-org'] + } + '/orgs/{org}/settings/billing/advanced-security': { /** * Gets the GitHub Advanced Security active committers for an organization per repository. * Each distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of advanced_security_committers for each repository. * If this organization defers to an enterprise for billing, the total_advanced_security_committers returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level. */ - get: operations["billing/get-github-advanced-security-billing-org"]; - }; - "/orgs/{org}/settings/billing/packages": { + get: operations['billing/get-github-advanced-security-billing-org'] + } + '/orgs/{org}/settings/billing/packages': { /** * Gets the free and paid storage used for GitHub Packages in gigabytes. * @@ -1670,9 +1670,9 @@ export type paths = { * * Access tokens must have the `repo` or `admin:org` scope. */ - get: operations["billing/get-github-packages-billing-org"]; - }; - "/orgs/{org}/settings/billing/shared-storage": { + get: operations['billing/get-github-packages-billing-org'] + } + '/orgs/{org}/settings/billing/shared-storage': { /** * Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. * @@ -1680,33 +1680,33 @@ export type paths = { * * Access tokens must have the `repo` or `admin:org` scope. */ - get: operations["billing/get-shared-storage-billing-org"]; - }; - "/orgs/{org}/team-sync/groups": { + get: operations['billing/get-shared-storage-billing-org'] + } + '/orgs/{org}/team-sync/groups': { /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * List IdP groups available in an organization. You can limit your page results using the `per_page` parameter. GitHub generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." */ - get: operations["teams/list-idp-groups-for-org"]; - }; - "/orgs/{org}/teams": { + get: operations['teams/list-idp-groups-for-org'] + } + '/orgs/{org}/teams': { /** Lists all teams in an organization that are visible to the authenticated user. */ - get: operations["teams/list"]; + get: operations['teams/list'] /** * To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://docs.github.com/en/articles/setting-team-creation-permissions-in-your-organization)." * * When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)". */ - post: operations["teams/create"]; - }; - "/orgs/{org}/teams/{team_slug}": { + post: operations['teams/create'] + } + '/orgs/{org}/teams/{team_slug}': { /** * Gets a team using the team's `slug`. GitHub generates the `slug` from the team `name`. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. */ - get: operations["teams/get-by-name"]; + get: operations['teams/get-by-name'] /** * To delete a team, the authenticated user must be an organization owner or team maintainer. * @@ -1714,21 +1714,21 @@ export type paths = { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. */ - delete: operations["teams/delete-in-org"]; + delete: operations['teams/delete-in-org'] /** * To edit a team, the authenticated user must either be an organization owner or a team maintainer. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. */ - patch: operations["teams/update-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/discussions": { + patch: operations['teams/update-in-org'] + } + '/orgs/{org}/teams/{team_slug}/discussions': { /** * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. */ - get: operations["teams/list-discussions-in-org"]; + get: operations['teams/list-discussions-in-org'] /** * Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @@ -1736,35 +1736,35 @@ export type paths = { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. */ - post: operations["teams/create-discussion-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": { + post: operations['teams/create-discussion-in-org'] + } + '/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}': { /** * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. */ - get: operations["teams/get-discussion-in-org"]; + get: operations['teams/get-discussion-in-org'] /** * Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. */ - delete: operations["teams/delete-discussion-in-org"]; + delete: operations['teams/delete-discussion-in-org'] /** * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. */ - patch: operations["teams/update-discussion-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": { + patch: operations['teams/update-discussion-in-org'] + } + '/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments': { /** * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. */ - get: operations["teams/list-discussion-comments-in-org"]; + get: operations['teams/list-discussion-comments-in-org'] /** * Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @@ -1772,103 +1772,103 @@ export type paths = { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. */ - post: operations["teams/create-discussion-comment-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": { + post: operations['teams/create-discussion-comment-in-org'] + } + '/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}': { /** * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. */ - get: operations["teams/get-discussion-comment-in-org"]; + get: operations['teams/get-discussion-comment-in-org'] /** * Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. */ - delete: operations["teams/delete-discussion-comment-in-org"]; + delete: operations['teams/delete-discussion-comment-in-org'] /** * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. */ - patch: operations["teams/update-discussion-comment-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { + patch: operations['teams/update-discussion-comment-in-org'] + } + '/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions': { /** * List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments/). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. */ - get: operations["reactions/list-for-team-discussion-comment-in-org"]; + get: operations['reactions/list-for-team-discussion-comment-in-org'] /** * Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. */ - post: operations["reactions/create-for-team-discussion-comment-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { + post: operations['reactions/create-for-team-discussion-comment-in-org'] + } + '/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}': { /** * **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. * * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - delete: operations["reactions/delete-for-team-discussion-comment"]; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { + delete: operations['reactions/delete-for-team-discussion-comment'] + } + '/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions': { /** * List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. */ - get: operations["reactions/list-for-team-discussion-in-org"]; + get: operations['reactions/list-for-team-discussion-in-org'] /** * Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. */ - post: operations["reactions/create-for-team-discussion-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { + post: operations['reactions/create-for-team-discussion-in-org'] + } + '/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}': { /** * **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. * * Delete a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - delete: operations["reactions/delete-for-team-discussion"]; - }; - "/orgs/{org}/teams/{team_slug}/external-groups": { + delete: operations['reactions/delete-for-team-discussion'] + } + '/orgs/{org}/teams/{team_slug}/external-groups': { /** * Deletes a connection between a team and an external group. * * You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - delete: operations["teams/unlink-external-idp-group-from-team-for-org"]; + delete: operations['teams/unlink-external-idp-group-from-team-for-org'] /** * Creates a connection between a team and an external group. Only one external group can be linked to a team. * * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ - patch: operations["teams/link-external-idp-group-to-team-for-org"]; - }; - "/orgs/{org}/teams/{team_slug}/invitations": { + patch: operations['teams/link-external-idp-group-to-team-for-org'] + } + '/orgs/{org}/teams/{team_slug}/invitations': { /** * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. */ - get: operations["teams/list-pending-invitations-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/members": { + get: operations['teams/list-pending-invitations-in-org'] + } + '/orgs/{org}/teams/{team_slug}/members': { /** * Team members will include the members of child teams. * * To list members in a team, the team must be visible to the authenticated user. */ - get: operations["teams/list-members-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/memberships/{username}": { + get: operations['teams/list-members-in-org'] + } + '/orgs/{org}/teams/{team_slug}/memberships/{username}': { /** * Team members will include the members of child teams. * @@ -1881,7 +1881,7 @@ export type paths = { * * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team). */ - get: operations["teams/get-membership-for-user-in-org"]; + get: operations['teams/get-membership-for-user-in-org'] /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -1895,7 +1895,7 @@ export type paths = { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ - put: operations["teams/add-or-update-membership-for-user-in-org"]; + put: operations['teams/add-or-update-membership-for-user-in-org'] /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -1905,45 +1905,45 @@ export type paths = { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ - delete: operations["teams/remove-membership-for-user-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/projects": { + delete: operations['teams/remove-membership-for-user-in-org'] + } + '/orgs/{org}/teams/{team_slug}/projects': { /** * Lists the organization projects for a team. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. */ - get: operations["teams/list-projects-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { + get: operations['teams/list-projects-in-org'] + } + '/orgs/{org}/teams/{team_slug}/projects/{project_id}': { /** * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ - get: operations["teams/check-permissions-for-project-in-org"]; + get: operations['teams/check-permissions-for-project-in-org'] /** * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ - put: operations["teams/add-or-update-project-permissions-in-org"]; + put: operations['teams/add-or-update-project-permissions-in-org'] /** * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ - delete: operations["teams/remove-project-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/repos": { + delete: operations['teams/remove-project-in-org'] + } + '/orgs/{org}/teams/{team_slug}/repos': { /** * Lists a team's repositories visible to the authenticated user. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. */ - get: operations["teams/list-repos-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": { + get: operations['teams/list-repos-in-org'] + } + '/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}': { /** * Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. * @@ -1953,7 +1953,7 @@ export type paths = { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ - get: operations["teams/check-permissions-for-repo-in-org"]; + get: operations['teams/check-permissions-for-repo-in-org'] /** * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." * @@ -1961,15 +1961,15 @@ export type paths = { * * For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". */ - put: operations["teams/add-or-update-repo-permissions-in-org"]; + put: operations['teams/add-or-update-repo-permissions-in-org'] /** * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ - delete: operations["teams/remove-repo-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/team-sync/group-mappings": { + delete: operations['teams/remove-repo-in-org'] + } + '/orgs/{org}/teams/{team_slug}/team-sync/group-mappings': { /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -1977,7 +1977,7 @@ export type paths = { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`. */ - get: operations["teams/list-idp-groups-in-org"]; + get: operations['teams/list-idp-groups-in-org'] /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -1985,131 +1985,131 @@ export type paths = { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`. */ - patch: operations["teams/create-or-update-idp-group-connections-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/teams": { + patch: operations['teams/create-or-update-idp-group-connections-in-org'] + } + '/orgs/{org}/teams/{team_slug}/teams': { /** * Lists the child teams of the team specified by `{team_slug}`. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. */ - get: operations["teams/list-child-in-org"]; - }; - "/projects/columns/cards/{card_id}": { - get: operations["projects/get-card"]; - delete: operations["projects/delete-card"]; - patch: operations["projects/update-card"]; - }; - "/projects/columns/cards/{card_id}/moves": { - post: operations["projects/move-card"]; - }; - "/projects/columns/{column_id}": { - get: operations["projects/get-column"]; - delete: operations["projects/delete-column"]; - patch: operations["projects/update-column"]; - }; - "/projects/columns/{column_id}/cards": { - get: operations["projects/list-cards"]; - post: operations["projects/create-card"]; - }; - "/projects/columns/{column_id}/moves": { - post: operations["projects/move-column"]; - }; - "/projects/{project_id}": { + get: operations['teams/list-child-in-org'] + } + '/projects/columns/cards/{card_id}': { + get: operations['projects/get-card'] + delete: operations['projects/delete-card'] + patch: operations['projects/update-card'] + } + '/projects/columns/cards/{card_id}/moves': { + post: operations['projects/move-card'] + } + '/projects/columns/{column_id}': { + get: operations['projects/get-column'] + delete: operations['projects/delete-column'] + patch: operations['projects/update-column'] + } + '/projects/columns/{column_id}/cards': { + get: operations['projects/list-cards'] + post: operations['projects/create-card'] + } + '/projects/columns/{column_id}/moves': { + post: operations['projects/move-column'] + } + '/projects/{project_id}': { /** Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - get: operations["projects/get"]; + get: operations['projects/get'] /** Deletes a project board. Returns a `404 Not Found` status if projects are disabled. */ - delete: operations["projects/delete"]; + delete: operations['projects/delete'] /** Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - patch: operations["projects/update"]; - }; - "/projects/{project_id}/collaborators": { + patch: operations['projects/update'] + } + '/projects/{project_id}/collaborators': { /** Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators. */ - get: operations["projects/list-collaborators"]; - }; - "/projects/{project_id}/collaborators/{username}": { + get: operations['projects/list-collaborators'] + } + '/projects/{project_id}/collaborators/{username}': { /** Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator. */ - put: operations["projects/add-collaborator"]; + put: operations['projects/add-collaborator'] /** Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator. */ - delete: operations["projects/remove-collaborator"]; - }; - "/projects/{project_id}/collaborators/{username}/permission": { + delete: operations['projects/remove-collaborator'] + } + '/projects/{project_id}/collaborators/{username}/permission': { /** Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level. */ - get: operations["projects/get-permission-for-user"]; - }; - "/projects/{project_id}/columns": { - get: operations["projects/list-columns"]; - post: operations["projects/create-column"]; - }; - "/rate_limit": { + get: operations['projects/get-permission-for-user'] + } + '/projects/{project_id}/columns': { + get: operations['projects/list-columns'] + post: operations['projects/create-column'] + } + '/rate_limit': { /** * **Note:** Accessing this endpoint does not count against your REST API rate limit. * * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. */ - get: operations["rate-limit/get"]; - }; - "/reactions/{reaction_id}": { + get: operations['rate-limit/get'] + } + '/reactions/{reaction_id}': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Reactions API. We recommend migrating your existing code to use the new delete reactions endpoints. For more information, see this [blog post](https://developer.github.com/changes/2020-02-26-new-delete-reactions-endpoints/). * * OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), when deleting a [team discussion](https://docs.github.com/rest/reference/teams#discussions) or [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). */ - delete: operations["reactions/delete-legacy"]; - }; - "/repos/{owner}/{repo}": { + delete: operations['reactions/delete-legacy'] + } + '/repos/{owner}/{repo}': { /** The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. */ - get: operations["repos/get"]; + get: operations['repos/get'] /** * Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required. * * If an organization owner has configured the organization to prevent members from deleting organization-owned * repositories, you will get a `403 Forbidden` response. */ - delete: operations["repos/delete"]; + delete: operations['repos/delete'] /** **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/rest/reference/repos#replace-all-repository-topics) endpoint. */ - patch: operations["repos/update"]; - }; - "/repos/{owner}/{repo}/actions/artifacts": { + patch: operations['repos/update'] + } + '/repos/{owner}/{repo}/actions/artifacts': { /** Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/list-artifacts-for-repo"]; - }; - "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}": { + get: operations['actions/list-artifacts-for-repo'] + } + '/repos/{owner}/{repo}/actions/artifacts/{artifact_id}': { /** Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/get-artifact"]; + get: operations['actions/get-artifact'] /** Deletes an artifact for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - delete: operations["actions/delete-artifact"]; - }; - "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}": { + delete: operations['actions/delete-artifact'] + } + '/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}': { /** * Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in * the response header to find the URL for the download. The `:archive_format` must be `zip`. Anyone with read access to * the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/download-artifact"]; - }; - "/repos/{owner}/{repo}/actions/jobs/{job_id}": { + get: operations['actions/download-artifact'] + } + '/repos/{owner}/{repo}/actions/jobs/{job_id}': { /** Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/get-job-for-workflow-run"]; - }; - "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs": { + get: operations['actions/get-job-for-workflow-run'] + } + '/repos/{owner}/{repo}/actions/jobs/{job_id}/logs': { /** * Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look * for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can * use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must * have the `actions:read` permission to use this endpoint. */ - get: operations["actions/download-job-logs-for-workflow-run"]; - }; - "/repos/{owner}/{repo}/actions/permissions": { + get: operations['actions/download-job-logs-for-workflow-run'] + } + '/repos/{owner}/{repo}/actions/permissions': { /** * Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository. * * You must authenticate using an access token with the `repo` scope to use this * endpoint. GitHub Apps must have the `administration` repository permission to use this API. */ - get: operations["actions/get-github-actions-permissions-repository"]; + get: operations['actions/get-github-actions-permissions-repository'] /** * Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository. * @@ -2117,15 +2117,15 @@ export type paths = { * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. */ - put: operations["actions/set-github-actions-permissions-repository"]; - }; - "/repos/{owner}/{repo}/actions/permissions/selected-actions": { + put: operations['actions/set-github-actions-permissions-repository'] + } + '/repos/{owner}/{repo}/actions/permissions/selected-actions': { /** * Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. */ - get: operations["actions/get-allowed-actions-repository"]; + get: operations['actions/get-allowed-actions-repository'] /** * Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." * @@ -2135,21 +2135,21 @@ export type paths = { * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. */ - put: operations["actions/set-allowed-actions-repository"]; - }; - "/repos/{owner}/{repo}/actions/runners": { + put: operations['actions/set-allowed-actions-repository'] + } + '/repos/{owner}/{repo}/actions/runners': { /** Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. */ - get: operations["actions/list-self-hosted-runners-for-repo"]; - }; - "/repos/{owner}/{repo}/actions/runners/downloads": { + get: operations['actions/list-self-hosted-runners-for-repo'] + } + '/repos/{owner}/{repo}/actions/runners/downloads': { /** * Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `repo` scope to use this endpoint. */ - get: operations["actions/list-runner-applications-for-repo"]; - }; - "/repos/{owner}/{repo}/actions/runners/registration-token": { + get: operations['actions/list-runner-applications-for-repo'] + } + '/repos/{owner}/{repo}/actions/runners/registration-token': { /** * Returns a token that you can pass to the `config` script. The token expires after one hour. You must authenticate * using an access token with the `repo` scope to use this endpoint. @@ -2162,9 +2162,9 @@ export type paths = { * ./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN * ``` */ - post: operations["actions/create-registration-token-for-repo"]; - }; - "/repos/{owner}/{repo}/actions/runners/remove-token": { + post: operations['actions/create-registration-token-for-repo'] + } + '/repos/{owner}/{repo}/actions/runners/remove-token': { /** * Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour. * You must authenticate using an access token with the `repo` scope to use this endpoint. @@ -2177,32 +2177,32 @@ export type paths = { * ./config.sh remove --token TOKEN * ``` */ - post: operations["actions/create-remove-token-for-repo"]; - }; - "/repos/{owner}/{repo}/actions/runners/{runner_id}": { + post: operations['actions/create-remove-token-for-repo'] + } + '/repos/{owner}/{repo}/actions/runners/{runner_id}': { /** * Gets a specific self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - get: operations["actions/get-self-hosted-runner-for-repo"]; + get: operations['actions/get-self-hosted-runner-for-repo'] /** * Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * * You must authenticate using an access token with the `repo` * scope to use this endpoint. */ - delete: operations["actions/delete-self-hosted-runner-from-repo"]; - }; - "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels": { + delete: operations['actions/delete-self-hosted-runner-from-repo'] + } + '/repos/{owner}/{repo}/actions/runners/{runner_id}/labels': { /** * Lists all labels for a self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - get: operations["actions/list-labels-for-self-hosted-runner-for-repo"]; + get: operations['actions/list-labels-for-self-hosted-runner-for-repo'] /** * Remove all previous custom labels and set the new custom labels for a specific * self-hosted runner configured in a repository. @@ -2210,14 +2210,14 @@ export type paths = { * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - put: operations["actions/set-custom-labels-for-self-hosted-runner-for-repo"]; + put: operations['actions/set-custom-labels-for-self-hosted-runner-for-repo'] /** * Add custom labels to a self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - post: operations["actions/add-custom-labels-to-self-hosted-runner-for-repo"]; + post: operations['actions/add-custom-labels-to-self-hosted-runner-for-repo'] /** * Remove all custom labels from a self-hosted runner configured in a * repository. Returns the remaining read-only labels from the runner. @@ -2225,9 +2225,9 @@ export type paths = { * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - delete: operations["actions/remove-all-custom-labels-from-self-hosted-runner-for-repo"]; - }; - "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}": { + delete: operations['actions/remove-all-custom-labels-from-self-hosted-runner-for-repo'] + } + '/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}': { /** * Remove a custom label from a self-hosted runner configured * in a repository. Returns the remaining labels from the runner. @@ -2238,120 +2238,120 @@ export type paths = { * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - delete: operations["actions/remove-custom-label-from-self-hosted-runner-for-repo"]; - }; - "/repos/{owner}/{repo}/actions/runs": { + delete: operations['actions/remove-custom-label-from-self-hosted-runner-for-repo'] + } + '/repos/{owner}/{repo}/actions/runs': { /** * Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). * * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/list-workflow-runs-for-repo"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}": { + get: operations['actions/list-workflow-runs-for-repo'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}': { /** Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/get-workflow-run"]; + get: operations['actions/get-workflow-run'] /** * Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is * private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:write` permission to use * this endpoint. */ - delete: operations["actions/delete-workflow-run"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/approvals": { + delete: operations['actions/delete-workflow-run'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/approvals': { /** Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/get-reviews-for-run"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/approve": { + get: operations['actions/get-reviews-for-run'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/approve': { /** * Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)." * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - post: operations["actions/approve-workflow-run"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts": { + post: operations['actions/approve-workflow-run'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts': { /** Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/list-workflow-run-artifacts"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}": { + get: operations['actions/list-workflow-run-artifacts'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}': { /** * Gets a specific workflow run attempt. Anyone with read access to the repository * can use this endpoint. If the repository is private you must use an access token * with the `repo` scope. GitHub Apps must have the `actions:read` permission to * use this endpoint. */ - get: operations["actions/get-workflow-run-attempt"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs": { + get: operations['actions/get-workflow-run-attempt'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs': { /** Lists jobs for a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). */ - get: operations["actions/list-jobs-for-workflow-run-attempt"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs": { + get: operations['actions/list-jobs-for-workflow-run-attempt'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs': { /** * Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after * 1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to * the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/download-workflow-run-attempt-logs"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": { + get: operations['actions/download-workflow-run-attempt-logs'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/cancel': { /** Cancels a workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - post: operations["actions/cancel-workflow-run"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": { + post: operations['actions/cancel-workflow-run'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/jobs': { /** Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). */ - get: operations["actions/list-jobs-for-workflow-run"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/logs": { + get: operations['actions/list-jobs-for-workflow-run'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/logs': { /** * Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for * `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use * this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have * the `actions:read` permission to use this endpoint. */ - get: operations["actions/download-workflow-run-logs"]; + get: operations['actions/download-workflow-run-logs'] /** Deletes all logs for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - delete: operations["actions/delete-workflow-run-logs"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments": { + delete: operations['actions/delete-workflow-run-logs'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments': { /** * Get all deployment environments for a workflow run that are waiting for protection rules to pass. * * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/get-pending-deployments-for-run"]; + get: operations['actions/get-pending-deployments-for-run'] /** * Approve or reject pending deployments that are waiting on approval by a required reviewer. * * Anyone with read access to the repository contents and deployments can use this endpoint. */ - post: operations["actions/review-pending-deployments-for-run"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun": { + post: operations['actions/review-pending-deployments-for-run'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/rerun': { /** Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - post: operations["actions/re-run-workflow"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/timing": { + post: operations['actions/re-run-workflow'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/timing': { /** * Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/get-workflow-run-usage"]; - }; - "/repos/{owner}/{repo}/actions/secrets": { + get: operations['actions/get-workflow-run-usage'] + } + '/repos/{owner}/{repo}/actions/secrets': { /** Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - get: operations["actions/list-repo-secrets"]; - }; - "/repos/{owner}/{repo}/actions/secrets/public-key": { + get: operations['actions/list-repo-secrets'] + } + '/repos/{owner}/{repo}/actions/secrets/public-key': { /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - get: operations["actions/get-repo-public-key"]; - }; - "/repos/{owner}/{repo}/actions/secrets/{secret_name}": { + get: operations['actions/get-repo-public-key'] + } + '/repos/{owner}/{repo}/actions/secrets/{secret_name}': { /** Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - get: operations["actions/get-repo-secret"]; + get: operations['actions/get-repo-secret'] /** * Creates or updates a repository secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -2429,27 +2429,27 @@ export type paths = { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - put: operations["actions/create-or-update-repo-secret"]; + put: operations['actions/create-or-update-repo-secret'] /** Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - delete: operations["actions/delete-repo-secret"]; - }; - "/repos/{owner}/{repo}/actions/workflows": { + delete: operations['actions/delete-repo-secret'] + } + '/repos/{owner}/{repo}/actions/workflows': { /** Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/list-repo-workflows"]; - }; - "/repos/{owner}/{repo}/actions/workflows/{workflow_id}": { + get: operations['actions/list-repo-workflows'] + } + '/repos/{owner}/{repo}/actions/workflows/{workflow_id}': { /** Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/get-workflow"]; - }; - "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable": { + get: operations['actions/get-workflow'] + } + '/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable': { /** * Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - put: operations["actions/disable-workflow"]; - }; - "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches": { + put: operations['actions/disable-workflow'] + } + '/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches': { /** * You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * @@ -2457,37 +2457,37 @@ export type paths = { * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)." */ - post: operations["actions/create-workflow-dispatch"]; - }; - "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable": { + post: operations['actions/create-workflow-dispatch'] + } + '/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable': { /** * Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - put: operations["actions/enable-workflow"]; - }; - "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { + put: operations['actions/enable-workflow'] + } + '/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs': { /** * List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). * * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. */ - get: operations["actions/list-workflow-runs"]; - }; - "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing": { + get: operations['actions/list-workflow-runs'] + } + '/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing': { /** * Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * * You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/get-workflow-usage"]; - }; - "/repos/{owner}/{repo}/assignees": { + get: operations['actions/get-workflow-usage'] + } + '/repos/{owner}/{repo}/assignees': { /** Lists the [available assignees](https://docs.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. */ - get: operations["issues/list-assignees"]; - }; - "/repos/{owner}/{repo}/assignees/{assignee}": { + get: operations['issues/list-assignees'] + } + '/repos/{owner}/{repo}/assignees/{assignee}': { /** * Checks if a user has permission to be assigned to an issue in this repository. * @@ -2495,47 +2495,47 @@ export type paths = { * * Otherwise a `404` status code is returned. */ - get: operations["issues/check-user-can-be-assigned"]; - }; - "/repos/{owner}/{repo}/autolinks": { + get: operations['issues/check-user-can-be-assigned'] + } + '/repos/{owner}/{repo}/autolinks': { /** * This returns a list of autolinks configured for the given repository. * * Information about autolinks are only available to repository administrators. */ - get: operations["repos/list-autolinks"]; + get: operations['repos/list-autolinks'] /** Users with admin access to the repository can create an autolink. */ - post: operations["repos/create-autolink"]; - }; - "/repos/{owner}/{repo}/autolinks/{autolink_id}": { + post: operations['repos/create-autolink'] + } + '/repos/{owner}/{repo}/autolinks/{autolink_id}': { /** * This returns a single autolink reference by ID that was configured for the given repository. * * Information about autolinks are only available to repository administrators. */ - get: operations["repos/get-autolink"]; + get: operations['repos/get-autolink'] /** * This deletes a single autolink reference by ID that was configured for the given repository. * * Information about autolinks are only available to repository administrators. */ - delete: operations["repos/delete-autolink"]; - }; - "/repos/{owner}/{repo}/automated-security-fixes": { + delete: operations['repos/delete-autolink'] + } + '/repos/{owner}/{repo}/automated-security-fixes': { /** Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/en/articles/configuring-automated-security-fixes)". */ - put: operations["repos/enable-automated-security-fixes"]; + put: operations['repos/enable-automated-security-fixes'] /** Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/en/articles/configuring-automated-security-fixes)". */ - delete: operations["repos/disable-automated-security-fixes"]; - }; - "/repos/{owner}/{repo}/branches": { - get: operations["repos/list-branches"]; - }; - "/repos/{owner}/{repo}/branches/{branch}": { - get: operations["repos/get-branch"]; - }; - "/repos/{owner}/{repo}/branches/{branch}/protection": { + delete: operations['repos/disable-automated-security-fixes'] + } + '/repos/{owner}/{repo}/branches': { + get: operations['repos/list-branches'] + } + '/repos/{owner}/{repo}/branches/{branch}': { + get: operations['repos/get-branch'] + } + '/repos/{owner}/{repo}/branches/{branch}/protection': { /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - get: operations["repos/get-branch-protection"]; + get: operations['repos/get-branch-protection'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2545,31 +2545,31 @@ export type paths = { * * **Note**: The list of users, apps, and teams in total is limited to 100 items. */ - put: operations["repos/update-branch-protection"]; + put: operations['repos/update-branch-protection'] /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - delete: operations["repos/delete-branch-protection"]; - }; - "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins": { + delete: operations['repos/delete-branch-protection'] + } + '/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins': { /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - get: operations["repos/get-admin-branch-protection"]; + get: operations['repos/get-admin-branch-protection'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ - post: operations["repos/set-admin-branch-protection"]; + post: operations['repos/set-admin-branch-protection'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ - delete: operations["repos/delete-admin-branch-protection"]; - }; - "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews": { + delete: operations['repos/delete-admin-branch-protection'] + } + '/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews': { /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - get: operations["repos/get-pull-request-review-protection"]; + get: operations['repos/get-pull-request-review-protection'] /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - delete: operations["repos/delete-pull-request-review-protection"]; + delete: operations['repos/delete-pull-request-review-protection'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2577,9 +2577,9 @@ export type paths = { * * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. */ - patch: operations["repos/update-pull-request-review-protection"]; - }; - "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures": { + patch: operations['repos/update-pull-request-review-protection'] + } + '/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures': { /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2587,43 +2587,43 @@ export type paths = { * * **Note**: You must enable branch protection to require signed commits. */ - get: operations["repos/get-commit-signature-protection"]; + get: operations['repos/get-commit-signature-protection'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits. */ - post: operations["repos/create-commit-signature-protection"]; + post: operations['repos/create-commit-signature-protection'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits. */ - delete: operations["repos/delete-commit-signature-protection"]; - }; - "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks": { + delete: operations['repos/delete-commit-signature-protection'] + } + '/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks': { /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - get: operations["repos/get-status-checks-protection"]; + get: operations['repos/get-status-checks-protection'] /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - delete: operations["repos/remove-status-check-protection"]; + delete: operations['repos/remove-status-check-protection'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. */ - patch: operations["repos/update-status-check-protection"]; - }; - "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts": { + patch: operations['repos/update-status-check-protection'] + } + '/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts': { /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - get: operations["repos/get-all-status-check-contexts"]; + get: operations['repos/get-all-status-check-contexts'] /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - put: operations["repos/set-status-check-contexts"]; + put: operations['repos/set-status-check-contexts'] /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - post: operations["repos/add-status-check-contexts"]; + post: operations['repos/add-status-check-contexts'] /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - delete: operations["repos/remove-status-check-contexts"]; - }; - "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions": { + delete: operations['repos/remove-status-check-contexts'] + } + '/repos/{owner}/{repo}/branches/{branch}/protection/restrictions': { /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2631,21 +2631,21 @@ export type paths = { * * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. */ - get: operations["repos/get-access-restrictions"]; + get: operations['repos/get-access-restrictions'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Disables the ability to restrict who can push to this branch. */ - delete: operations["repos/delete-access-restrictions"]; - }; - "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps": { + delete: operations['repos/delete-access-restrictions'] + } + '/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps': { /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. */ - get: operations["repos/get-apps-with-access-to-protected-branch"]; + get: operations['repos/get-apps-with-access-to-protected-branch'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2655,7 +2655,7 @@ export type paths = { * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - put: operations["repos/set-app-access-restrictions"]; + put: operations['repos/set-app-access-restrictions'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2665,7 +2665,7 @@ export type paths = { * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - post: operations["repos/add-app-access-restrictions"]; + post: operations['repos/add-app-access-restrictions'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2675,15 +2675,15 @@ export type paths = { * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - delete: operations["repos/remove-app-access-restrictions"]; - }; - "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams": { + delete: operations['repos/remove-app-access-restrictions'] + } + '/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams': { /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the teams who have push access to this branch. The list includes child teams. */ - get: operations["repos/get-teams-with-access-to-protected-branch"]; + get: operations['repos/get-teams-with-access-to-protected-branch'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2693,7 +2693,7 @@ export type paths = { * | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ | * | `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - put: operations["repos/set-team-access-restrictions"]; + put: operations['repos/set-team-access-restrictions'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2703,7 +2703,7 @@ export type paths = { * | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ | * | `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - post: operations["repos/add-team-access-restrictions"]; + post: operations['repos/add-team-access-restrictions'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2713,15 +2713,15 @@ export type paths = { * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | Teams that should no longer have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - delete: operations["repos/remove-team-access-restrictions"]; - }; - "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users": { + delete: operations['repos/remove-team-access-restrictions'] + } + '/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users': { /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the people who have push access to this branch. */ - get: operations["repos/get-users-with-access-to-protected-branch"]; + get: operations['repos/get-users-with-access-to-protected-branch'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2731,7 +2731,7 @@ export type paths = { * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - put: operations["repos/set-user-access-restrictions"]; + put: operations['repos/set-user-access-restrictions'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2741,7 +2741,7 @@ export type paths = { * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - post: operations["repos/add-user-access-restrictions"]; + post: operations['repos/add-user-access-restrictions'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2751,9 +2751,9 @@ export type paths = { * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - delete: operations["repos/remove-user-access-restrictions"]; - }; - "/repos/{owner}/{repo}/branches/{branch}/rename": { + delete: operations['repos/remove-user-access-restrictions'] + } + '/repos/{owner}/{repo}/branches/{branch}/rename': { /** * Renames a branch in a repository. * @@ -2771,9 +2771,9 @@ export type paths = { * * Users must have admin or owner permissions. * * GitHub Apps must have the `administration:write` repository permission. */ - post: operations["repos/rename-branch"]; - }; - "/repos/{owner}/{repo}/check-runs": { + post: operations['repos/rename-branch'] + } + '/repos/{owner}/{repo}/check-runs': { /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * @@ -2781,71 +2781,71 @@ export type paths = { * * In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. */ - post: operations["checks/create"]; - }; - "/repos/{owner}/{repo}/check-runs/{check_run_id}": { + post: operations['checks/create'] + } + '/repos/{owner}/{repo}/check-runs/{check_run_id}': { /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * Gets a single check run using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. */ - get: operations["checks/get"]; + get: operations['checks/get'] /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. */ - patch: operations["checks/update"]; - }; - "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations": { + patch: operations['checks/update'] + } + '/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations': { /** Lists annotations for a check run using the annotation `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the `repo` scope to get annotations for a check run in a private repository. */ - get: operations["checks/list-annotations"]; - }; - "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest": { + get: operations['checks/list-annotations'] + } + '/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest': { /** * Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * * To rerequest a check run, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository. */ - post: operations["checks/rerequest-run"]; - }; - "/repos/{owner}/{repo}/check-suites": { + post: operations['checks/rerequest-run'] + } + '/repos/{owner}/{repo}/check-suites': { /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * * By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/reference/checks#check-runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/reference/checks#update-repository-preferences-for-check-suites)". Your GitHub App must have the `checks:write` permission to create check suites. */ - post: operations["checks/create-suite"]; - }; - "/repos/{owner}/{repo}/check-suites/preferences": { + post: operations['checks/create-suite'] + } + '/repos/{owner}/{repo}/check-suites/preferences': { /** Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/reference/checks#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites. */ - patch: operations["checks/set-suites-preferences"]; - }; - "/repos/{owner}/{repo}/check-suites/{check_suite_id}": { + patch: operations['checks/set-suites-preferences'] + } + '/repos/{owner}/{repo}/check-suites/{check_suite_id}': { /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * * Gets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository. */ - get: operations["checks/get-suite"]; - }; - "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": { + get: operations['checks/get-suite'] + } + '/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs': { /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. */ - get: operations["checks/list-for-suite"]; - }; - "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest": { + get: operations['checks/list-for-suite'] + } + '/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest': { /** * Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * * To rerequest a check suite, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository. */ - post: operations["checks/rerequest-suite"]; - }; - "/repos/{owner}/{repo}/code-scanning/alerts": { + post: operations['checks/rerequest-suite'] + } + '/repos/{owner}/{repo}/code-scanning/alerts': { /** * Lists all open code scanning alerts for the default branch (usually `main` * or `master`). You must use an access token with the `security_events` scope to use @@ -2858,29 +2858,29 @@ export type paths = { * for the default branch or for the specified Git reference * (if you used `ref` in the request). */ - get: operations["code-scanning/list-alerts-for-repo"]; - }; - "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}": { + get: operations['code-scanning/list-alerts-for-repo'] + } + '/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}': { /** * Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint. * * **Deprecation notice**: * The instances field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The same information can now be retrieved via a GET request to the URL specified by `instances_url`. */ - get: operations["code-scanning/get-alert"]; + get: operations['code-scanning/get-alert'] /** Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. */ - patch: operations["code-scanning/update-alert"]; - }; - "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances": { + patch: operations['code-scanning/update-alert'] + } + '/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances': { /** * Lists all instances of the specified code scanning alert. * You must use an access token with the `security_events` scope to use this endpoint with private repos, * the `public_repo` scope also grants permission to read security events on public repos only. * GitHub Apps must have the `security_events` read permission to use this endpoint. */ - get: operations["code-scanning/list-alert-instances"]; - }; - "/repos/{owner}/{repo}/code-scanning/analyses": { + get: operations['code-scanning/list-alert-instances'] + } + '/repos/{owner}/{repo}/code-scanning/analyses': { /** * Lists the details of all code scanning analyses for a repository, * starting with the most recent. @@ -2900,9 +2900,9 @@ export type paths = { * **Deprecation notice**: * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. */ - get: operations["code-scanning/list-recent-analyses"]; - }; - "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}": { + get: operations['code-scanning/list-recent-analyses'] + } + '/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}': { /** * Gets a specified code scanning analysis for a repository. * You must use an access token with the `security_events` scope to use this endpoint with private repos, @@ -2924,7 +2924,7 @@ export type paths = { * This is formatted as * [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). */ - get: operations["code-scanning/get-analysis"]; + get: operations['code-scanning/get-analysis'] /** * Deletes a specified code scanning analysis from a repository. For * private repositories, you must use an access token with the `repo` scope. For public repositories, @@ -2993,9 +2993,9 @@ export type paths = { * * The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely. */ - delete: operations["code-scanning/delete-analysis"]; - }; - "/repos/{owner}/{repo}/code-scanning/sarifs": { + delete: operations['code-scanning/delete-analysis'] + } + '/repos/{owner}/{repo}/code-scanning/sarifs': { /** * Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. * @@ -3015,27 +3015,27 @@ export type paths = { * You can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint. * For more information, see "[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload)." */ - post: operations["code-scanning/upload-sarif"]; - }; - "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}": { + post: operations['code-scanning/upload-sarif'] + } + '/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}': { /** Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository)." You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint. */ - get: operations["code-scanning/get-sarif"]; - }; - "/repos/{owner}/{repo}/codespaces": { + get: operations['code-scanning/get-sarif'] + } + '/repos/{owner}/{repo}/codespaces': { /** * Lists the codespaces associated to a specified repository and the authenticated user. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - get: operations["codespaces/list-in-repository-for-authenticated-user"]; + get: operations['codespaces/list-in-repository-for-authenticated-user'] /** * Creates a codespace owned by the authenticated user in the specified repository. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - post: operations["codespaces/create-with-repo-for-authenticated-user"]; - }; - "/repos/{owner}/{repo}/codespaces/machines": { + post: operations['codespaces/create-with-repo-for-authenticated-user'] + } + '/repos/{owner}/{repo}/codespaces/machines': { /** * List the machine types available for a given repository based on its configuration. * @@ -3043,9 +3043,9 @@ export type paths = { * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - get: operations["codespaces/repo-machines-for-authenticated-user"]; - }; - "/repos/{owner}/{repo}/collaborators": { + get: operations['codespaces/repo-machines-for-authenticated-user'] + } + '/repos/{owner}/{repo}/collaborators': { /** * For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. * @@ -3055,9 +3055,9 @@ export type paths = { * endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this * endpoint. */ - get: operations["repos/list-collaborators"]; - }; - "/repos/{owner}/{repo}/collaborators/{username}": { + get: operations['repos/list-collaborators'] + } + '/repos/{owner}/{repo}/collaborators/{username}': { /** * For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. * @@ -3067,7 +3067,7 @@ export type paths = { * endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this * endpoint. */ - get: operations["repos/check-collaborator"]; + get: operations['repos/check-collaborator'] /** * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. * @@ -3085,41 +3085,41 @@ export type paths = { * * You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository. */ - put: operations["repos/add-collaborator"]; - delete: operations["repos/remove-collaborator"]; - }; - "/repos/{owner}/{repo}/collaborators/{username}/permission": { + put: operations['repos/add-collaborator'] + delete: operations['repos/remove-collaborator'] + } + '/repos/{owner}/{repo}/collaborators/{username}/permission': { /** Checks the repository permission of a collaborator. The possible repository permissions are `admin`, `write`, `read`, and `none`. */ - get: operations["repos/get-collaborator-permission-level"]; - }; - "/repos/{owner}/{repo}/comments": { + get: operations['repos/get-collaborator-permission-level'] + } + '/repos/{owner}/{repo}/comments': { /** * Commit Comments use [these custom media types](https://docs.github.com/rest/reference/repos#custom-media-types). You can read more about the use of media types in the API [here](https://docs.github.com/rest/overview/media-types/). * * Comments are ordered by ascending ID. */ - get: operations["repos/list-commit-comments-for-repo"]; - }; - "/repos/{owner}/{repo}/comments/{comment_id}": { - get: operations["repos/get-commit-comment"]; - delete: operations["repos/delete-commit-comment"]; - patch: operations["repos/update-commit-comment"]; - }; - "/repos/{owner}/{repo}/comments/{comment_id}/reactions": { + get: operations['repos/list-commit-comments-for-repo'] + } + '/repos/{owner}/{repo}/comments/{comment_id}': { + get: operations['repos/get-commit-comment'] + delete: operations['repos/delete-commit-comment'] + patch: operations['repos/update-commit-comment'] + } + '/repos/{owner}/{repo}/comments/{comment_id}/reactions': { /** List the reactions to a [commit comment](https://docs.github.com/rest/reference/repos#comments). */ - get: operations["reactions/list-for-commit-comment"]; + get: operations['reactions/list-for-commit-comment'] /** Create a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. */ - post: operations["reactions/create-for-commit-comment"]; - }; - "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}": { + post: operations['reactions/create-for-commit-comment'] + } + '/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}': { /** * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. * * Delete a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). */ - delete: operations["reactions/delete-for-commit-comment"]; - }; - "/repos/{owner}/{repo}/commits": { + delete: operations['reactions/delete-for-commit-comment'] + } + '/repos/{owner}/{repo}/commits': { /** * **Signature verification object** * @@ -3150,31 +3150,31 @@ export type paths = { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - get: operations["repos/list-commits"]; - }; - "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head": { + get: operations['repos/list-commits'] + } + '/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head': { /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. */ - get: operations["repos/list-branches-for-head-commit"]; - }; - "/repos/{owner}/{repo}/commits/{commit_sha}/comments": { + get: operations['repos/list-branches-for-head-commit'] + } + '/repos/{owner}/{repo}/commits/{commit_sha}/comments': { /** Use the `:commit_sha` to specify the commit that will have its comments listed. */ - get: operations["repos/list-comments-for-commit"]; + get: operations['repos/list-comments-for-commit'] /** * Create a comment for a commit using its `:commit_sha`. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - post: operations["repos/create-commit-comment"]; - }; - "/repos/{owner}/{repo}/commits/{commit_sha}/pulls": { + post: operations['repos/create-commit-comment'] + } + '/repos/{owner}/{repo}/commits/{commit_sha}/pulls': { /** Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the [List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests) endpoint. */ - get: operations["repos/list-pull-requests-associated-with-commit"]; - }; - "/repos/{owner}/{repo}/commits/{ref}": { + get: operations['repos/list-pull-requests-associated-with-commit'] + } + '/repos/{owner}/{repo}/commits/{ref}': { /** * Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. * @@ -3213,25 +3213,25 @@ export type paths = { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - get: operations["repos/get-commit"]; - }; - "/repos/{owner}/{repo}/commits/{ref}/check-runs": { + get: operations['repos/get-commit'] + } + '/repos/{owner}/{repo}/commits/{ref}/check-runs': { /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. */ - get: operations["checks/list-for-ref"]; - }; - "/repos/{owner}/{repo}/commits/{ref}/check-suites": { + get: operations['checks/list-for-ref'] + } + '/repos/{owner}/{repo}/commits/{ref}/check-suites': { /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * * Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository. */ - get: operations["checks/list-suites-for-ref"]; - }; - "/repos/{owner}/{repo}/commits/{ref}/status": { + get: operations['checks/list-suites-for-ref'] + } + '/repos/{owner}/{repo}/commits/{ref}/status': { /** * Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. * @@ -3242,17 +3242,17 @@ export type paths = { * * **pending** if there are no statuses or a context is `pending` * * **success** if the latest status for all contexts is `success` */ - get: operations["repos/get-combined-status-for-ref"]; - }; - "/repos/{owner}/{repo}/commits/{ref}/statuses": { + get: operations['repos/get-combined-status-for-ref'] + } + '/repos/{owner}/{repo}/commits/{ref}/statuses': { /** * Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one. * * This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`. */ - get: operations["repos/list-commit-statuses-for-ref"]; - }; - "/repos/{owner}/{repo}/community/profile": { + get: operations['repos/list-commit-statuses-for-ref'] + } + '/repos/{owner}/{repo}/community/profile': { /** * This endpoint will return all community profile metrics, including an * overall health score, repository description, the presence of documentation, detected @@ -3267,9 +3267,9 @@ export type paths = { * * `content_reports_enabled` is only returned for organization-owned repositories. */ - get: operations["repos/get-community-profile-metrics"]; - }; - "/repos/{owner}/{repo}/compare/{basehead}": { + get: operations['repos/get-community-profile-metrics'] + } + '/repos/{owner}/{repo}/compare/{basehead}': { /** * The `basehead` param is comprised of two parts: `base` and `head`. Both must be branch names in `repo`. To compare branches across other repositories in the same network as `repo`, use the format `:branch`. * @@ -3312,9 +3312,9 @@ export type paths = { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - get: operations["repos/compare-commits"]; - }; - "/repos/{owner}/{repo}/contents/{path}": { + get: operations['repos/compare-commits'] + } + '/repos/{owner}/{repo}/contents/{path}': { /** * Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit * `:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. @@ -3349,9 +3349,9 @@ export type paths = { * If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the * github.com URLs (`html_url` and `_links["html"]`) will have null values. */ - get: operations["repos/get-content"]; + get: operations['repos/get-content'] /** Creates a new file or replaces an existing file in a repository. */ - put: operations["repos/create-or-update-file-contents"]; + put: operations['repos/create-or-update-file-contents'] /** * Deletes a file in a repository. * @@ -3361,27 +3361,27 @@ export type paths = { * * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. */ - delete: operations["repos/delete-file"]; - }; - "/repos/{owner}/{repo}/contributors": { + delete: operations['repos/delete-file'] + } + '/repos/{owner}/{repo}/contributors': { /** * Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance. * * GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information. */ - get: operations["repos/list-contributors"]; - }; - "/repos/{owner}/{repo}/dependabot/secrets": { + get: operations['repos/list-contributors'] + } + '/repos/{owner}/{repo}/dependabot/secrets': { /** Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */ - get: operations["dependabot/list-repo-secrets"]; - }; - "/repos/{owner}/{repo}/dependabot/secrets/public-key": { + get: operations['dependabot/list-repo-secrets'] + } + '/repos/{owner}/{repo}/dependabot/secrets/public-key': { /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */ - get: operations["dependabot/get-repo-public-key"]; - }; - "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}": { + get: operations['dependabot/get-repo-public-key'] + } + '/repos/{owner}/{repo}/dependabot/secrets/{secret_name}': { /** Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */ - get: operations["dependabot/get-repo-secret"]; + get: operations['dependabot/get-repo-secret'] /** * Creates or updates a repository secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -3459,13 +3459,13 @@ export type paths = { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - put: operations["dependabot/create-or-update-repo-secret"]; + put: operations['dependabot/create-or-update-repo-secret'] /** Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */ - delete: operations["dependabot/delete-repo-secret"]; - }; - "/repos/{owner}/{repo}/deployments": { + delete: operations['dependabot/delete-repo-secret'] + } + '/repos/{owner}/{repo}/deployments': { /** Simple filtering of deployments is available via query parameters: */ - get: operations["repos/list-deployments"]; + get: operations['repos/list-deployments'] /** * Deployments offer a few configurable parameters with certain defaults. * @@ -3513,10 +3513,10 @@ export type paths = { * This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` * status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. */ - post: operations["repos/create-deployment"]; - }; - "/repos/{owner}/{repo}/deployments/{deployment_id}": { - get: operations["repos/get-deployment"]; + post: operations['repos/create-deployment'] + } + '/repos/{owner}/{repo}/deployments/{deployment_id}': { + get: operations['repos/get-deployment'] /** * If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. Anyone with `repo` or `repo_deployment` scopes can delete a deployment. * @@ -3527,23 +3527,23 @@ export type paths = { * * For more information, see "[Create a deployment](https://docs.github.com/rest/reference/repos/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/reference/repos#create-a-deployment-status)." */ - delete: operations["repos/delete-deployment"]; - }; - "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses": { + delete: operations['repos/delete-deployment'] + } + '/repos/{owner}/{repo}/deployments/{deployment_id}/statuses': { /** Users with pull access can view deployment statuses for a deployment: */ - get: operations["repos/list-deployment-statuses"]; + get: operations['repos/list-deployment-statuses'] /** * Users with `push` access can create deployment statuses for a given deployment. * * GitHub Apps require `read & write` access to "Deployments" and `read-only` access to "Repo contents" (for private repos). OAuth Apps require the `repo_deployment` scope. */ - post: operations["repos/create-deployment-status"]; - }; - "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}": { + post: operations['repos/create-deployment-status'] + } + '/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}': { /** Users with pull access can view a deployment status for a deployment: */ - get: operations["repos/get-deployment-status"]; - }; - "/repos/{owner}/{repo}/dispatches": { + get: operations['repos/get-deployment-status'] + } + '/repos/{owner}/{repo}/dispatches': { /** * You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/webhooks/event-payloads/#repository_dispatch)." * @@ -3556,19 +3556,19 @@ export type paths = { * * This input example shows how you can use the `client_payload` as a test to debug your workflow. */ - post: operations["repos/create-dispatch-event"]; - }; - "/repos/{owner}/{repo}/environments": { + post: operations['repos/create-dispatch-event'] + } + '/repos/{owner}/{repo}/environments': { /** * Get all environments for a repository. * * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["repos/get-all-environments"]; - }; - "/repos/{owner}/{repo}/environments/{environment_name}": { + get: operations['repos/get-all-environments'] + } + '/repos/{owner}/{repo}/environments/{environment_name}': { /** Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["repos/get-environment"]; + get: operations['repos/get-environment'] /** * Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)." * @@ -3578,34 +3578,34 @@ export type paths = { * * You must authenticate using an access token with the repo scope to use this endpoint. */ - put: operations["repos/create-or-update-environment"]; + put: operations['repos/create-or-update-environment'] /** You must authenticate using an access token with the repo scope to use this endpoint. */ - delete: operations["repos/delete-an-environment"]; - }; - "/repos/{owner}/{repo}/events": { - get: operations["activity/list-repo-events"]; - }; - "/repos/{owner}/{repo}/forks": { - get: operations["repos/list-forks"]; + delete: operations['repos/delete-an-environment'] + } + '/repos/{owner}/{repo}/events': { + get: operations['activity/list-repo-events'] + } + '/repos/{owner}/{repo}/forks': { + get: operations['repos/list-forks'] /** * Create a fork for the authenticated user. * * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). */ - post: operations["repos/create-fork"]; - }; - "/repos/{owner}/{repo}/git/blobs": { - post: operations["git/create-blob"]; - }; - "/repos/{owner}/{repo}/git/blobs/{file_sha}": { + post: operations['repos/create-fork'] + } + '/repos/{owner}/{repo}/git/blobs': { + post: operations['git/create-blob'] + } + '/repos/{owner}/{repo}/git/blobs/{file_sha}': { /** * The `content` in the response will always be Base64 encoded. * * _Note_: This API supports blobs up to 100 megabytes in size. */ - get: operations["git/get-blob"]; - }; - "/repos/{owner}/{repo}/git/commits": { + get: operations['git/get-blob'] + } + '/repos/{owner}/{repo}/git/commits': { /** * Creates a new Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects). * @@ -3638,9 +3638,9 @@ export type paths = { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - post: operations["git/create-commit"]; - }; - "/repos/{owner}/{repo}/git/commits/{commit_sha}": { + post: operations['git/create-commit'] + } + '/repos/{owner}/{repo}/git/commits/{commit_sha}': { /** * Gets a Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects). * @@ -3673,9 +3673,9 @@ export type paths = { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - get: operations["git/get-commit"]; - }; - "/repos/{owner}/{repo}/git/matching-refs/{ref}": { + get: operations['git/get-commit'] + } + '/repos/{owner}/{repo}/git/matching-refs/{ref}': { /** * Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array. * @@ -3685,25 +3685,25 @@ export type paths = { * * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. */ - get: operations["git/list-matching-refs"]; - }; - "/repos/{owner}/{repo}/git/ref/{ref}": { + get: operations['git/list-matching-refs'] + } + '/repos/{owner}/{repo}/git/ref/{ref}': { /** * Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. * * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". */ - get: operations["git/get-ref"]; - }; - "/repos/{owner}/{repo}/git/refs": { + get: operations['git/get-ref'] + } + '/repos/{owner}/{repo}/git/refs': { /** Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches. */ - post: operations["git/create-ref"]; - }; - "/repos/{owner}/{repo}/git/refs/{ref}": { - delete: operations["git/delete-ref"]; - patch: operations["git/update-ref"]; - }; - "/repos/{owner}/{repo}/git/tags": { + post: operations['git/create-ref'] + } + '/repos/{owner}/{repo}/git/refs/{ref}': { + delete: operations['git/delete-ref'] + patch: operations['git/update-ref'] + } + '/repos/{owner}/{repo}/git/tags': { /** * Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/rest/reference/git#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/rest/reference/git#create-a-reference) the tag reference - this call would be unnecessary. * @@ -3736,9 +3736,9 @@ export type paths = { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - post: operations["git/create-tag"]; - }; - "/repos/{owner}/{repo}/git/tags/{tag_sha}": { + post: operations['git/create-tag'] + } + '/repos/{owner}/{repo}/git/tags/{tag_sha}': { /** * **Signature verification object** * @@ -3769,78 +3769,78 @@ export type paths = { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - get: operations["git/get-tag"]; - }; - "/repos/{owner}/{repo}/git/trees": { + get: operations['git/get-tag'] + } + '/repos/{owner}/{repo}/git/trees': { /** * The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure. * * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/rest/reference/git#create-a-commit)" and "[Update a reference](https://docs.github.com/rest/reference/git#update-a-reference)." */ - post: operations["git/create-tree"]; - }; - "/repos/{owner}/{repo}/git/trees/{tree_sha}": { + post: operations['git/create-tree'] + } + '/repos/{owner}/{repo}/git/trees/{tree_sha}': { /** * Returns a single tree using the SHA1 value for that tree. * * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. */ - get: operations["git/get-tree"]; - }; - "/repos/{owner}/{repo}/hooks": { - get: operations["repos/list-webhooks"]; + get: operations['git/get-tree'] + } + '/repos/{owner}/{repo}/hooks': { + get: operations['repos/list-webhooks'] /** * Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can * share the same `config` as long as those webhooks do not have any `events` that overlap. */ - post: operations["repos/create-webhook"]; - }; - "/repos/{owner}/{repo}/hooks/{hook_id}": { + post: operations['repos/create-webhook'] + } + '/repos/{owner}/{repo}/hooks/{hook_id}': { /** Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/reference/repos#get-a-webhook-configuration-for-a-repository)." */ - get: operations["repos/get-webhook"]; - delete: operations["repos/delete-webhook"]; + get: operations['repos/get-webhook'] + delete: operations['repos/delete-webhook'] /** Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/reference/repos#update-a-webhook-configuration-for-a-repository)." */ - patch: operations["repos/update-webhook"]; - }; - "/repos/{owner}/{repo}/hooks/{hook_id}/config": { + patch: operations['repos/update-webhook'] + } + '/repos/{owner}/{repo}/hooks/{hook_id}/config': { /** * Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/reference/orgs#get-a-repository-webhook)." * * Access tokens must have the `read:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:read` permission. */ - get: operations["repos/get-webhook-config-for-repo"]; + get: operations['repos/get-webhook-config-for-repo'] /** * Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/reference/orgs#update-a-repository-webhook)." * * Access tokens must have the `write:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:write` permission. */ - patch: operations["repos/update-webhook-config-for-repo"]; - }; - "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries": { + patch: operations['repos/update-webhook-config-for-repo'] + } + '/repos/{owner}/{repo}/hooks/{hook_id}/deliveries': { /** Returns a list of webhook deliveries for a webhook configured in a repository. */ - get: operations["repos/list-webhook-deliveries"]; - }; - "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}": { + get: operations['repos/list-webhook-deliveries'] + } + '/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}': { /** Returns a delivery for a webhook configured in a repository. */ - get: operations["repos/get-webhook-delivery"]; - }; - "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { + get: operations['repos/get-webhook-delivery'] + } + '/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts': { /** Redeliver a webhook delivery for a webhook configured in a repository. */ - post: operations["repos/redeliver-webhook-delivery"]; - }; - "/repos/{owner}/{repo}/hooks/{hook_id}/pings": { + post: operations['repos/redeliver-webhook-delivery'] + } + '/repos/{owner}/{repo}/hooks/{hook_id}/pings': { /** This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. */ - post: operations["repos/ping-webhook"]; - }; - "/repos/{owner}/{repo}/hooks/{hook_id}/tests": { + post: operations['repos/ping-webhook'] + } + '/repos/{owner}/{repo}/hooks/{hook_id}/tests': { /** * This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. * * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` */ - post: operations["repos/test-push-webhook"]; - }; - "/repos/{owner}/{repo}/import": { + post: operations['repos/test-push-webhook'] + } + '/repos/{owner}/{repo}/import': { /** * View the progress of an import. * @@ -3877,62 +3877,62 @@ export type paths = { * * `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository. * * `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a "Get Large Files" request. */ - get: operations["migrations/get-import-status"]; + get: operations['migrations/get-import-status'] /** Start a source import to a GitHub repository using GitHub Importer. */ - put: operations["migrations/start-import"]; + put: operations['migrations/start-import'] /** Stop an import for a repository. */ - delete: operations["migrations/cancel-import"]; + delete: operations['migrations/cancel-import'] /** * An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API * request. If no parameters are provided, the import will be restarted. */ - patch: operations["migrations/update-import"]; - }; - "/repos/{owner}/{repo}/import/authors": { + patch: operations['migrations/update-import'] + } + '/repos/{owner}/{repo}/import/authors': { /** * Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `. * * This endpoint and the [Map a commit author](https://docs.github.com/rest/reference/migrations#map-a-commit-author) endpoint allow you to provide correct Git author information. */ - get: operations["migrations/get-commit-authors"]; - }; - "/repos/{owner}/{repo}/import/authors/{author_id}": { + get: operations['migrations/get-commit-authors'] + } + '/repos/{owner}/{repo}/import/authors/{author_id}': { /** Update an author's identity for the import. Your application can continue updating authors any time before you push new commits to the repository. */ - patch: operations["migrations/map-commit-author"]; - }; - "/repos/{owner}/{repo}/import/large_files": { + patch: operations['migrations/map-commit-author'] + } + '/repos/{owner}/{repo}/import/large_files': { /** List files larger than 100MB found during the import */ - get: operations["migrations/get-large-files"]; - }; - "/repos/{owner}/{repo}/import/lfs": { + get: operations['migrations/get-large-files'] + } + '/repos/{owner}/{repo}/import/lfs': { /** You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability is powered by [Git LFS](https://git-lfs.github.com). You can learn more about our LFS feature and working with large files [on our help site](https://docs.github.com/articles/versioning-large-files/). */ - patch: operations["migrations/set-lfs-preference"]; - }; - "/repos/{owner}/{repo}/installation": { + patch: operations['migrations/set-lfs-preference'] + } + '/repos/{owner}/{repo}/installation': { /** * Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - get: operations["apps/get-repo-installation"]; - }; - "/repos/{owner}/{repo}/interaction-limits": { + get: operations['apps/get-repo-installation'] + } + '/repos/{owner}/{repo}/interaction-limits': { /** Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response. */ - get: operations["interactions/get-restrictions-for-repo"]; + get: operations['interactions/get-restrictions-for-repo'] /** Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. */ - put: operations["interactions/set-restrictions-for-repo"]; + put: operations['interactions/set-restrictions-for-repo'] /** Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. */ - delete: operations["interactions/remove-restrictions-for-repo"]; - }; - "/repos/{owner}/{repo}/invitations": { + delete: operations['interactions/remove-restrictions-for-repo'] + } + '/repos/{owner}/{repo}/invitations': { /** When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations. */ - get: operations["repos/list-invitations"]; - }; - "/repos/{owner}/{repo}/invitations/{invitation_id}": { - delete: operations["repos/delete-invitation"]; - patch: operations["repos/update-invitation"]; - }; - "/repos/{owner}/{repo}/issues": { + get: operations['repos/list-invitations'] + } + '/repos/{owner}/{repo}/invitations/{invitation_id}': { + delete: operations['repos/delete-invitation'] + patch: operations['repos/update-invitation'] + } + '/repos/{owner}/{repo}/issues': { /** * List issues in a repository. * @@ -3941,44 +3941,44 @@ export type paths = { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - get: operations["issues/list-for-repo"]; + get: operations['issues/list-for-repo'] /** * Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - post: operations["issues/create"]; - }; - "/repos/{owner}/{repo}/issues/comments": { + post: operations['issues/create'] + } + '/repos/{owner}/{repo}/issues/comments': { /** By default, Issue Comments are ordered by ascending ID. */ - get: operations["issues/list-comments-for-repo"]; - }; - "/repos/{owner}/{repo}/issues/comments/{comment_id}": { - get: operations["issues/get-comment"]; - delete: operations["issues/delete-comment"]; - patch: operations["issues/update-comment"]; - }; - "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": { + get: operations['issues/list-comments-for-repo'] + } + '/repos/{owner}/{repo}/issues/comments/{comment_id}': { + get: operations['issues/get-comment'] + delete: operations['issues/delete-comment'] + patch: operations['issues/update-comment'] + } + '/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions': { /** List the reactions to an [issue comment](https://docs.github.com/rest/reference/issues#comments). */ - get: operations["reactions/list-for-issue-comment"]; + get: operations['reactions/list-for-issue-comment'] /** Create a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. */ - post: operations["reactions/create-for-issue-comment"]; - }; - "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}": { + post: operations['reactions/create-for-issue-comment'] + } + '/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}': { /** * **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. * * Delete a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). */ - delete: operations["reactions/delete-for-issue-comment"]; - }; - "/repos/{owner}/{repo}/issues/events": { - get: operations["issues/list-events-for-repo"]; - }; - "/repos/{owner}/{repo}/issues/events/{event_id}": { - get: operations["issues/get-event"]; - }; - "/repos/{owner}/{repo}/issues/{issue_number}": { + delete: operations['reactions/delete-for-issue-comment'] + } + '/repos/{owner}/{repo}/issues/events': { + get: operations['issues/list-events-for-repo'] + } + '/repos/{owner}/{repo}/issues/events/{event_id}': { + get: operations['issues/get-event'] + } + '/repos/{owner}/{repo}/issues/{issue_number}': { /** * The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was * [transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If @@ -3992,147 +3992,147 @@ export type paths = { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - get: operations["issues/get"]; + get: operations['issues/get'] /** Issue owners and users with push access can edit an issue. */ - patch: operations["issues/update"]; - }; - "/repos/{owner}/{repo}/issues/{issue_number}/assignees": { + patch: operations['issues/update'] + } + '/repos/{owner}/{repo}/issues/{issue_number}/assignees': { /** Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced. */ - post: operations["issues/add-assignees"]; + post: operations['issues/add-assignees'] /** Removes one or more assignees from an issue. */ - delete: operations["issues/remove-assignees"]; - }; - "/repos/{owner}/{repo}/issues/{issue_number}/comments": { + delete: operations['issues/remove-assignees'] + } + '/repos/{owner}/{repo}/issues/{issue_number}/comments': { /** Issue Comments are ordered by ascending ID. */ - get: operations["issues/list-comments"]; + get: operations['issues/list-comments'] /** This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - post: operations["issues/create-comment"]; - }; - "/repos/{owner}/{repo}/issues/{issue_number}/events": { - get: operations["issues/list-events"]; - }; - "/repos/{owner}/{repo}/issues/{issue_number}/labels": { - get: operations["issues/list-labels-on-issue"]; + post: operations['issues/create-comment'] + } + '/repos/{owner}/{repo}/issues/{issue_number}/events': { + get: operations['issues/list-events'] + } + '/repos/{owner}/{repo}/issues/{issue_number}/labels': { + get: operations['issues/list-labels-on-issue'] /** Removes any previous labels and sets the new labels for an issue. */ - put: operations["issues/set-labels"]; - post: operations["issues/add-labels"]; - delete: operations["issues/remove-all-labels"]; - }; - "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}": { + put: operations['issues/set-labels'] + post: operations['issues/add-labels'] + delete: operations['issues/remove-all-labels'] + } + '/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}': { /** Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist. */ - delete: operations["issues/remove-label"]; - }; - "/repos/{owner}/{repo}/issues/{issue_number}/lock": { + delete: operations['issues/remove-label'] + } + '/repos/{owner}/{repo}/issues/{issue_number}/lock': { /** * Users with push access can lock an issue or pull request's conversation. * * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - put: operations["issues/lock"]; + put: operations['issues/lock'] /** Users with push access can unlock an issue's conversation. */ - delete: operations["issues/unlock"]; - }; - "/repos/{owner}/{repo}/issues/{issue_number}/reactions": { + delete: operations['issues/unlock'] + } + '/repos/{owner}/{repo}/issues/{issue_number}/reactions': { /** List the reactions to an [issue](https://docs.github.com/rest/reference/issues). */ - get: operations["reactions/list-for-issue"]; + get: operations['reactions/list-for-issue'] /** Create a reaction to an [issue](https://docs.github.com/rest/reference/issues/). A response with an HTTP `200` status means that you already added the reaction type to this issue. */ - post: operations["reactions/create-for-issue"]; - }; - "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}": { + post: operations['reactions/create-for-issue'] + } + '/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}': { /** * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. * * Delete a reaction to an [issue](https://docs.github.com/rest/reference/issues/). */ - delete: operations["reactions/delete-for-issue"]; - }; - "/repos/{owner}/{repo}/issues/{issue_number}/timeline": { - get: operations["issues/list-events-for-timeline"]; - }; - "/repos/{owner}/{repo}/keys": { - get: operations["repos/list-deploy-keys"]; + delete: operations['reactions/delete-for-issue'] + } + '/repos/{owner}/{repo}/issues/{issue_number}/timeline': { + get: operations['issues/list-events-for-timeline'] + } + '/repos/{owner}/{repo}/keys': { + get: operations['repos/list-deploy-keys'] /** You can create a read-only deploy key. */ - post: operations["repos/create-deploy-key"]; - }; - "/repos/{owner}/{repo}/keys/{key_id}": { - get: operations["repos/get-deploy-key"]; + post: operations['repos/create-deploy-key'] + } + '/repos/{owner}/{repo}/keys/{key_id}': { + get: operations['repos/get-deploy-key'] /** Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead. */ - delete: operations["repos/delete-deploy-key"]; - }; - "/repos/{owner}/{repo}/labels": { - get: operations["issues/list-labels-for-repo"]; - post: operations["issues/create-label"]; - }; - "/repos/{owner}/{repo}/labels/{name}": { - get: operations["issues/get-label"]; - delete: operations["issues/delete-label"]; - patch: operations["issues/update-label"]; - }; - "/repos/{owner}/{repo}/languages": { + delete: operations['repos/delete-deploy-key'] + } + '/repos/{owner}/{repo}/labels': { + get: operations['issues/list-labels-for-repo'] + post: operations['issues/create-label'] + } + '/repos/{owner}/{repo}/labels/{name}': { + get: operations['issues/get-label'] + delete: operations['issues/delete-label'] + patch: operations['issues/update-label'] + } + '/repos/{owner}/{repo}/languages': { /** Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language. */ - get: operations["repos/list-languages"]; - }; - "/repos/{owner}/{repo}/lfs": { - put: operations["repos/enable-lfs-for-repo"]; - delete: operations["repos/disable-lfs-for-repo"]; - }; - "/repos/{owner}/{repo}/license": { + get: operations['repos/list-languages'] + } + '/repos/{owner}/{repo}/lfs': { + put: operations['repos/enable-lfs-for-repo'] + delete: operations['repos/disable-lfs-for-repo'] + } + '/repos/{owner}/{repo}/license': { /** * This method returns the contents of the repository's license file, if one is detected. * * Similar to [Get repository content](https://docs.github.com/rest/reference/repos#get-repository-content), this method also supports [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw license content or rendered license HTML. */ - get: operations["licenses/get-for-repo"]; - }; - "/repos/{owner}/{repo}/merge-upstream": { + get: operations['licenses/get-for-repo'] + } + '/repos/{owner}/{repo}/merge-upstream': { /** Sync a branch of a forked repository to keep it up-to-date with the upstream repository. */ - post: operations["repos/merge-upstream"]; - }; - "/repos/{owner}/{repo}/merges": { - post: operations["repos/merge"]; - }; - "/repos/{owner}/{repo}/milestones": { - get: operations["issues/list-milestones"]; - post: operations["issues/create-milestone"]; - }; - "/repos/{owner}/{repo}/milestones/{milestone_number}": { - get: operations["issues/get-milestone"]; - delete: operations["issues/delete-milestone"]; - patch: operations["issues/update-milestone"]; - }; - "/repos/{owner}/{repo}/milestones/{milestone_number}/labels": { - get: operations["issues/list-labels-for-milestone"]; - }; - "/repos/{owner}/{repo}/notifications": { + post: operations['repos/merge-upstream'] + } + '/repos/{owner}/{repo}/merges': { + post: operations['repos/merge'] + } + '/repos/{owner}/{repo}/milestones': { + get: operations['issues/list-milestones'] + post: operations['issues/create-milestone'] + } + '/repos/{owner}/{repo}/milestones/{milestone_number}': { + get: operations['issues/get-milestone'] + delete: operations['issues/delete-milestone'] + patch: operations['issues/update-milestone'] + } + '/repos/{owner}/{repo}/milestones/{milestone_number}/labels': { + get: operations['issues/list-labels-for-milestone'] + } + '/repos/{owner}/{repo}/notifications': { /** List all notifications for the current user. */ - get: operations["activity/list-repo-notifications-for-authenticated-user"]; + get: operations['activity/list-repo-notifications-for-authenticated-user'] /** Marks all notifications in a repository as "read" removes them from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ - put: operations["activity/mark-repo-notifications-as-read"]; - }; - "/repos/{owner}/{repo}/pages": { - get: operations["repos/get-pages"]; + put: operations['activity/mark-repo-notifications-as-read'] + } + '/repos/{owner}/{repo}/pages': { + get: operations['repos/get-pages'] /** Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). */ - put: operations["repos/update-information-about-pages-site"]; + put: operations['repos/update-information-about-pages-site'] /** Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)." */ - post: operations["repos/create-pages-site"]; - delete: operations["repos/delete-pages-site"]; - }; - "/repos/{owner}/{repo}/pages/builds": { - get: operations["repos/list-pages-builds"]; + post: operations['repos/create-pages-site'] + delete: operations['repos/delete-pages-site'] + } + '/repos/{owner}/{repo}/pages/builds': { + get: operations['repos/list-pages-builds'] /** * You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures. * * Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes. */ - post: operations["repos/request-pages-build"]; - }; - "/repos/{owner}/{repo}/pages/builds/latest": { - get: operations["repos/get-latest-pages-build"]; - }; - "/repos/{owner}/{repo}/pages/builds/{build_id}": { - get: operations["repos/get-pages-build"]; - }; - "/repos/{owner}/{repo}/pages/health": { + post: operations['repos/request-pages-build'] + } + '/repos/{owner}/{repo}/pages/builds/latest': { + get: operations['repos/get-latest-pages-build'] + } + '/repos/{owner}/{repo}/pages/builds/{build_id}': { + get: operations['repos/get-pages-build'] + } + '/repos/{owner}/{repo}/pages/health': { /** * Gets a health check of the DNS settings for the `CNAME` record configured for a repository's GitHub Pages. * @@ -4140,17 +4140,17 @@ export type paths = { * * Users must have admin or owner permissions. GitHub Apps must have the `pages:write` and `administration:write` permission to use this endpoint. */ - get: operations["repos/get-pages-health-check"]; - }; - "/repos/{owner}/{repo}/projects": { + get: operations['repos/get-pages-health-check'] + } + '/repos/{owner}/{repo}/projects': { /** Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - get: operations["projects/list-for-repo"]; + get: operations['projects/list-for-repo'] /** Creates a repository project board. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - post: operations["projects/create-for-repo"]; - }; - "/repos/{owner}/{repo}/pulls": { + post: operations['projects/create-for-repo'] + } + '/repos/{owner}/{repo}/pulls': { /** Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - get: operations["pulls/list"]; + get: operations['pulls/list'] /** * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -4160,35 +4160,35 @@ export type paths = { * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. */ - post: operations["pulls/create"]; - }; - "/repos/{owner}/{repo}/pulls/comments": { + post: operations['pulls/create'] + } + '/repos/{owner}/{repo}/pulls/comments': { /** Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID. */ - get: operations["pulls/list-review-comments-for-repo"]; - }; - "/repos/{owner}/{repo}/pulls/comments/{comment_id}": { + get: operations['pulls/list-review-comments-for-repo'] + } + '/repos/{owner}/{repo}/pulls/comments/{comment_id}': { /** Provides details for a review comment. */ - get: operations["pulls/get-review-comment"]; + get: operations['pulls/get-review-comment'] /** Deletes a review comment. */ - delete: operations["pulls/delete-review-comment"]; + delete: operations['pulls/delete-review-comment'] /** Enables you to edit a review comment. */ - patch: operations["pulls/update-review-comment"]; - }; - "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": { + patch: operations['pulls/update-review-comment'] + } + '/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions': { /** List the reactions to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). */ - get: operations["reactions/list-for-pull-request-review-comment"]; + get: operations['reactions/list-for-pull-request-review-comment'] /** Create a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#comments). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. */ - post: operations["reactions/create-for-pull-request-review-comment"]; - }; - "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}": { + post: operations['reactions/create-for-pull-request-review-comment'] + } + '/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}': { /** * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` * * Delete a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). */ - delete: operations["reactions/delete-for-pull-request-comment"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}": { + delete: operations['reactions/delete-for-pull-request-comment'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}': { /** * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -4206,25 +4206,25 @@ export type paths = { * * Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. */ - get: operations["pulls/get"]; + get: operations['pulls/get'] /** * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. */ - patch: operations["pulls/update"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": { + patch: operations['pulls/update'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/codespaces': { /** * Creates a codespace owned by the authenticated user for the specified pull request. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - post: operations["codespaces/create-with-pr-for-authenticated-user"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/comments": { + post: operations['codespaces/create-with-pr-for-authenticated-user'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/comments': { /** Lists all review comments for a pull request. By default, review comments are in ascending order by ID. */ - get: operations["pulls/list-review-comments"]; + get: operations['pulls/list-review-comments'] /** * Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/reference/issues#create-an-issue-comment)." We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff. * @@ -4234,38 +4234,38 @@ export type paths = { * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - post: operations["pulls/create-review-comment"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies": { + post: operations['pulls/create-review-comment'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies': { /** * Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - post: operations["pulls/create-reply-for-review-comment"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/commits": { + post: operations['pulls/create-reply-for-review-comment'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/commits': { /** Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/reference/repos#list-commits) endpoint. */ - get: operations["pulls/list-commits"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/files": { + get: operations['pulls/list-commits'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/files': { /** **Note:** Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. */ - get: operations["pulls/list-files"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/merge": { - get: operations["pulls/check-if-merged"]; + get: operations['pulls/list-files'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/merge': { + get: operations['pulls/check-if-merged'] /** This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - put: operations["pulls/merge"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { - get: operations["pulls/list-requested-reviewers"]; + put: operations['pulls/merge'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers': { + get: operations['pulls/list-requested-reviewers'] /** This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - post: operations["pulls/request-reviewers"]; - delete: operations["pulls/remove-requested-reviewers"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/reviews": { + post: operations['pulls/request-reviewers'] + delete: operations['pulls/remove-requested-reviewers'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/reviews': { /** The list of reviews returns in chronological order. */ - get: operations["pulls/list-reviews"]; + get: operations['pulls/list-reviews'] /** * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. * @@ -4275,92 +4275,92 @@ export type paths = { * * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. */ - post: operations["pulls/create-review"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}": { - get: operations["pulls/get-review"]; + post: operations['pulls/create-review'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}': { + get: operations['pulls/get-review'] /** Update the review summary comment with new text. */ - put: operations["pulls/update-review"]; - delete: operations["pulls/delete-pending-review"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments": { + put: operations['pulls/update-review'] + delete: operations['pulls/delete-pending-review'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments': { /** List comments for a specific pull request review. */ - get: operations["pulls/list-comments-for-review"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals": { + get: operations['pulls/list-comments-for-review'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals': { /** **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/reference/repos#branches), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. */ - put: operations["pulls/dismiss-review"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events": { - post: operations["pulls/submit-review"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch": { + put: operations['pulls/dismiss-review'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events': { + post: operations['pulls/submit-review'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/update-branch': { /** Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. */ - put: operations["pulls/update-branch"]; - }; - "/repos/{owner}/{repo}/readme": { + put: operations['pulls/update-branch'] + } + '/repos/{owner}/{repo}/readme': { /** * Gets the preferred README for a repository. * * READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. */ - get: operations["repos/get-readme"]; - }; - "/repos/{owner}/{repo}/readme/{dir}": { + get: operations['repos/get-readme'] + } + '/repos/{owner}/{repo}/readme/{dir}': { /** * Gets the README from a repository directory. * * READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. */ - get: operations["repos/get-readme-in-directory"]; - }; - "/repos/{owner}/{repo}/releases": { + get: operations['repos/get-readme-in-directory'] + } + '/repos/{owner}/{repo}/releases': { /** * This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/rest/reference/repos#list-repository-tags). * * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. */ - get: operations["repos/list-releases"]; + get: operations['repos/list-releases'] /** * Users with push access to the repository can create a release. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - post: operations["repos/create-release"]; - }; - "/repos/{owner}/{repo}/releases/assets/{asset_id}": { + post: operations['repos/create-release'] + } + '/repos/{owner}/{repo}/releases/assets/{asset_id}': { /** To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. */ - get: operations["repos/get-release-asset"]; - delete: operations["repos/delete-release-asset"]; + get: operations['repos/get-release-asset'] + delete: operations['repos/delete-release-asset'] /** Users with push access to the repository can edit a release asset. */ - patch: operations["repos/update-release-asset"]; - }; - "/repos/{owner}/{repo}/releases/generate-notes": { + patch: operations['repos/update-release-asset'] + } + '/repos/{owner}/{repo}/releases/generate-notes': { /** Generate a name and body describing a [release](https://docs.github.com/rest/reference/repos#releases). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. */ - post: operations["repos/generate-release-notes"]; - }; - "/repos/{owner}/{repo}/releases/latest": { + post: operations['repos/generate-release-notes'] + } + '/repos/{owner}/{repo}/releases/latest': { /** * View the latest published full release for the repository. * * The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published. */ - get: operations["repos/get-latest-release"]; - }; - "/repos/{owner}/{repo}/releases/tags/{tag}": { + get: operations['repos/get-latest-release'] + } + '/repos/{owner}/{repo}/releases/tags/{tag}': { /** Get a published release with the specified tag. */ - get: operations["repos/get-release-by-tag"]; - }; - "/repos/{owner}/{repo}/releases/{release_id}": { + get: operations['repos/get-release-by-tag'] + } + '/repos/{owner}/{repo}/releases/{release_id}': { /** **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia). */ - get: operations["repos/get-release"]; + get: operations['repos/get-release'] /** Users with push access to the repository can delete a release. */ - delete: operations["repos/delete-release"]; + delete: operations['repos/delete-release'] /** Users with push access to the repository can edit a release. */ - patch: operations["repos/update-release"]; - }; - "/repos/{owner}/{repo}/releases/{release_id}/assets": { - get: operations["repos/list-release-assets"]; + patch: operations['repos/update-release'] + } + '/repos/{owner}/{repo}/releases/{release_id}/assets': { + get: operations['repos/list-release-assets'] /** * This endpoint makes use of [a Hypermedia relation](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in * the response of the [Create a release endpoint](https://docs.github.com/rest/reference/repos#create-a-release) to upload a release asset. @@ -4381,59 +4381,59 @@ export type paths = { * endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). * * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. */ - post: operations["repos/upload-release-asset"]; - }; - "/repos/{owner}/{repo}/releases/{release_id}/reactions": { + post: operations['repos/upload-release-asset'] + } + '/repos/{owner}/{repo}/releases/{release_id}/reactions': { /** Create a reaction to a [release](https://docs.github.com/rest/reference/repos#releases). A response with a `Status: 200 OK` means that you already added the reaction type to this release. */ - post: operations["reactions/create-for-release"]; - }; - "/repos/{owner}/{repo}/secret-scanning/alerts": { + post: operations['reactions/create-for-release'] + } + '/repos/{owner}/{repo}/secret-scanning/alerts': { /** * Lists secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. */ - get: operations["secret-scanning/list-alerts-for-repo"]; - }; - "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}": { + get: operations['secret-scanning/list-alerts-for-repo'] + } + '/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}': { /** * Gets a single secret scanning alert detected in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. */ - get: operations["secret-scanning/get-alert"]; + get: operations['secret-scanning/get-alert'] /** * Updates the status of a secret scanning alert in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint. */ - patch: operations["secret-scanning/update-alert"]; - }; - "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations": { + patch: operations['secret-scanning/update-alert'] + } + '/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations': { /** * Lists all locations for a given secret scanning alert for a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. */ - get: operations["secret-scanning/list-locations-for-alert"]; - }; - "/repos/{owner}/{repo}/stargazers": { + get: operations['secret-scanning/list-locations-for-alert'] + } + '/repos/{owner}/{repo}/stargazers': { /** * Lists the people that have starred the repository. * * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: */ - get: operations["activity/list-stargazers-for-repo"]; - }; - "/repos/{owner}/{repo}/stats/code_frequency": { + get: operations['activity/list-stargazers-for-repo'] + } + '/repos/{owner}/{repo}/stats/code_frequency': { /** Returns a weekly aggregate of the number of additions and deletions pushed to a repository. */ - get: operations["repos/get-code-frequency-stats"]; - }; - "/repos/{owner}/{repo}/stats/commit_activity": { + get: operations['repos/get-code-frequency-stats'] + } + '/repos/{owner}/{repo}/stats/commit_activity': { /** Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`. */ - get: operations["repos/get-commit-activity-stats"]; - }; - "/repos/{owner}/{repo}/stats/contributors": { + get: operations['repos/get-commit-activity-stats'] + } + '/repos/{owner}/{repo}/stats/contributors': { /** * Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information: * @@ -4442,17 +4442,17 @@ export type paths = { * * `d` - Number of deletions * * `c` - Number of commits */ - get: operations["repos/get-contributors-stats"]; - }; - "/repos/{owner}/{repo}/stats/participation": { + get: operations['repos/get-contributors-stats'] + } + '/repos/{owner}/{repo}/stats/participation': { /** * Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`. * * The array order is oldest week (index 0) to most recent week. */ - get: operations["repos/get-participation-stats"]; - }; - "/repos/{owner}/{repo}/stats/punch_card": { + get: operations['repos/get-participation-stats'] + } + '/repos/{owner}/{repo}/stats/punch_card': { /** * Each array contains the day number, hour number, and number of commits: * @@ -4462,84 +4462,84 @@ export type paths = { * * For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. */ - get: operations["repos/get-punch-card-stats"]; - }; - "/repos/{owner}/{repo}/statuses/{sha}": { + get: operations['repos/get-punch-card-stats'] + } + '/repos/{owner}/{repo}/statuses/{sha}': { /** * Users with push access in a repository can create commit statuses for a given SHA. * * Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error. */ - post: operations["repos/create-commit-status"]; - }; - "/repos/{owner}/{repo}/subscribers": { + post: operations['repos/create-commit-status'] + } + '/repos/{owner}/{repo}/subscribers': { /** Lists the people watching the specified repository. */ - get: operations["activity/list-watchers-for-repo"]; - }; - "/repos/{owner}/{repo}/subscription": { - get: operations["activity/get-repo-subscription"]; + get: operations['activity/list-watchers-for-repo'] + } + '/repos/{owner}/{repo}/subscription': { + get: operations['activity/get-repo-subscription'] /** If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/rest/reference/activity#delete-a-repository-subscription) completely. */ - put: operations["activity/set-repo-subscription"]; + put: operations['activity/set-repo-subscription'] /** This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/rest/reference/activity#set-a-repository-subscription). */ - delete: operations["activity/delete-repo-subscription"]; - }; - "/repos/{owner}/{repo}/tags": { - get: operations["repos/list-tags"]; - }; - "/repos/{owner}/{repo}/tarball/{ref}": { + delete: operations['activity/delete-repo-subscription'] + } + '/repos/{owner}/{repo}/tags': { + get: operations['repos/list-tags'] + } + '/repos/{owner}/{repo}/tarball/{ref}': { /** * Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually * `master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. * **Note**: For private repositories, these links are temporary and expire after five minutes. */ - get: operations["repos/download-tarball-archive"]; - }; - "/repos/{owner}/{repo}/teams": { - get: operations["repos/list-teams"]; - }; - "/repos/{owner}/{repo}/topics": { - get: operations["repos/get-all-topics"]; - put: operations["repos/replace-all-topics"]; - }; - "/repos/{owner}/{repo}/traffic/clones": { + get: operations['repos/download-tarball-archive'] + } + '/repos/{owner}/{repo}/teams': { + get: operations['repos/list-teams'] + } + '/repos/{owner}/{repo}/topics': { + get: operations['repos/get-all-topics'] + put: operations['repos/replace-all-topics'] + } + '/repos/{owner}/{repo}/traffic/clones': { /** Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. */ - get: operations["repos/get-clones"]; - }; - "/repos/{owner}/{repo}/traffic/popular/paths": { + get: operations['repos/get-clones'] + } + '/repos/{owner}/{repo}/traffic/popular/paths': { /** Get the top 10 popular contents over the last 14 days. */ - get: operations["repos/get-top-paths"]; - }; - "/repos/{owner}/{repo}/traffic/popular/referrers": { + get: operations['repos/get-top-paths'] + } + '/repos/{owner}/{repo}/traffic/popular/referrers': { /** Get the top 10 referrers over the last 14 days. */ - get: operations["repos/get-top-referrers"]; - }; - "/repos/{owner}/{repo}/traffic/views": { + get: operations['repos/get-top-referrers'] + } + '/repos/{owner}/{repo}/traffic/views': { /** Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. */ - get: operations["repos/get-views"]; - }; - "/repos/{owner}/{repo}/transfer": { + get: operations['repos/get-views'] + } + '/repos/{owner}/{repo}/transfer': { /** A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/). */ - post: operations["repos/transfer"]; - }; - "/repos/{owner}/{repo}/vulnerability-alerts": { + post: operations['repos/transfer'] + } + '/repos/{owner}/{repo}/vulnerability-alerts': { /** Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". */ - get: operations["repos/check-vulnerability-alerts"]; + get: operations['repos/check-vulnerability-alerts'] /** Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". */ - put: operations["repos/enable-vulnerability-alerts"]; + put: operations['repos/enable-vulnerability-alerts'] /** Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". */ - delete: operations["repos/disable-vulnerability-alerts"]; - }; - "/repos/{owner}/{repo}/zipball/{ref}": { + delete: operations['repos/disable-vulnerability-alerts'] + } + '/repos/{owner}/{repo}/zipball/{ref}': { /** * Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually * `master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. * **Note**: For private repositories, these links are temporary and expire after five minutes. */ - get: operations["repos/download-zipball-archive"]; - }; - "/repos/{template_owner}/{template_repo}/generate": { + get: operations['repos/download-zipball-archive'] + } + '/repos/{template_owner}/{template_repo}/generate': { /** * Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. * @@ -4550,9 +4550,9 @@ export type paths = { * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. * * `repo` scope to create a private repository */ - post: operations["repos/create-using-template"]; - }; - "/repositories": { + post: operations['repos/create-using-template'] + } + '/repositories': { /** * Lists all public repositories in the order that they were created. * @@ -4560,19 +4560,19 @@ export type paths = { * - For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories. */ - get: operations["repos/list-public"]; - }; - "/repositories/{repository_id}/environments/{environment_name}/secrets": { + get: operations['repos/list-public'] + } + '/repositories/{repository_id}/environments/{environment_name}/secrets': { /** Lists all secrets available in an environment without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - get: operations["actions/list-environment-secrets"]; - }; - "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key": { + get: operations['actions/list-environment-secrets'] + } + '/repositories/{repository_id}/environments/{environment_name}/secrets/public-key': { /** Get the public key for an environment, which you need to encrypt environment secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - get: operations["actions/get-environment-public-key"]; - }; - "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": { + get: operations['actions/get-environment-public-key'] + } + '/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}': { /** Gets a single environment secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - get: operations["actions/get-environment-secret"]; + get: operations['actions/get-environment-secret'] /** * Creates or updates an environment secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -4650,39 +4650,39 @@ export type paths = { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - put: operations["actions/create-or-update-environment-secret"]; + put: operations['actions/create-or-update-environment-secret'] /** Deletes a secret in an environment using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - delete: operations["actions/delete-environment-secret"]; - }; - "/scim/v2/enterprises/{enterprise}/Groups": { + delete: operations['actions/delete-environment-secret'] + } + '/scim/v2/enterprises/{enterprise}/Groups': { /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - get: operations["enterprise-admin/list-provisioned-groups-enterprise"]; + get: operations['enterprise-admin/list-provisioned-groups-enterprise'] /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * * Provision an enterprise group, and invite users to the group. This sends invitation emails to the email address of the invited users to join the GitHub organization that the SCIM group corresponds to. */ - post: operations["enterprise-admin/provision-and-invite-enterprise-group"]; - }; - "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": { + post: operations['enterprise-admin/provision-and-invite-enterprise-group'] + } + '/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}': { /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - get: operations["enterprise-admin/get-provisioning-information-for-enterprise-group"]; + get: operations['enterprise-admin/get-provisioning-information-for-enterprise-group'] /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * * Replaces an existing provisioned group’s information. You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead. */ - put: operations["enterprise-admin/set-information-for-provisioned-enterprise-group"]; + put: operations['enterprise-admin/set-information-for-provisioned-enterprise-group'] /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - delete: operations["enterprise-admin/delete-scim-group-from-enterprise"]; + delete: operations['enterprise-admin/delete-scim-group-from-enterprise'] /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * * Allows you to change a provisioned group’s individual attributes. To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). */ - patch: operations["enterprise-admin/update-attribute-for-enterprise-group"]; - }; - "/scim/v2/enterprises/{enterprise}/Users": { + patch: operations['enterprise-admin/update-attribute-for-enterprise-group'] + } + '/scim/v2/enterprises/{enterprise}/Users': { /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * @@ -4703,7 +4703,7 @@ export type paths = { * - If the user signs in, their GitHub account is linked to this entry. * - If the user does not sign in (or does not create a new account when prompted), they are not added to the GitHub enterprise, and the external identity `null` entry remains in place. */ - get: operations["enterprise-admin/list-provisioned-identities-enterprise"]; + get: operations['enterprise-admin/list-provisioned-identities-enterprise'] /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * @@ -4711,11 +4711,11 @@ export type paths = { * * You can optionally include the groups a user will be invited to join. If you do not provide a list of `groups`, the user is provisioned for the enterprise, but no organization invitation emails will be sent. */ - post: operations["enterprise-admin/provision-and-invite-enterprise-user"]; - }; - "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": { + post: operations['enterprise-admin/provision-and-invite-enterprise-user'] + } + '/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}': { /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - get: operations["enterprise-admin/get-provisioning-information-for-enterprise-user"]; + get: operations['enterprise-admin/get-provisioning-information-for-enterprise-user'] /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * @@ -4725,9 +4725,9 @@ export type paths = { * * **Warning:** Setting `active: false` removes the user from the enterprise, deletes the external identity, and deletes the associated `{scim_user_id}`. */ - put: operations["enterprise-admin/set-information-for-provisioned-enterprise-user"]; + put: operations['enterprise-admin/set-information-for-provisioned-enterprise-user'] /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - delete: operations["enterprise-admin/delete-user-from-enterprise"]; + delete: operations['enterprise-admin/delete-user-from-enterprise'] /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * @@ -4748,9 +4748,9 @@ export type paths = { * } * ``` */ - patch: operations["enterprise-admin/update-attribute-for-enterprise-user"]; - }; - "/scim/v2/organizations/{org}/Users": { + patch: operations['enterprise-admin/update-attribute-for-enterprise-user'] + } + '/scim/v2/organizations/{org}/Users': { /** * Retrieves a paginated list of all provisioned organization members, including pending invitations. If you provide the `filter` parameter, the resources for all matching provisions members are returned. * @@ -4769,12 +4769,12 @@ export type paths = { * - If the user signs in, their GitHub account is linked to this entry. * - If the user does not sign in (or does not create a new account when prompted), they are not added to the GitHub organization, and the external identity `null` entry remains in place. */ - get: operations["scim/list-provisioned-identities"]; + get: operations['scim/list-provisioned-identities'] /** Provision organization membership for a user, and send an activation email to the email address. */ - post: operations["scim/provision-and-invite-user"]; - }; - "/scim/v2/organizations/{org}/Users/{scim_user_id}": { - get: operations["scim/get-provisioning-information-for-user"]; + post: operations['scim/provision-and-invite-user'] + } + '/scim/v2/organizations/{org}/Users/{scim_user_id}': { + get: operations['scim/get-provisioning-information-for-user'] /** * Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](https://docs.github.com/rest/reference/scim#update-an-attribute-for-a-scim-user) endpoint instead. * @@ -4782,8 +4782,8 @@ export type paths = { * * **Warning:** Setting `active: false` removes the user from the organization, deletes the external identity, and deletes the associated `{scim_user_id}`. */ - put: operations["scim/set-information-for-provisioned-user"]; - delete: operations["scim/delete-user-from-org"]; + put: operations['scim/set-information-for-provisioned-user'] + delete: operations['scim/delete-user-from-org'] /** * Allows you to change a provisioned user's individual attributes. To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). * @@ -4802,9 +4802,9 @@ export type paths = { * } * ``` */ - patch: operations["scim/update-attribute-for-user"]; - }; - "/search/code": { + patch: operations['scim/update-attribute-for-user'] + } + '/search/code': { /** * Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -4825,9 +4825,9 @@ export type paths = { * * You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing * language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. */ - get: operations["search/code"]; - }; - "/search/commits": { + get: operations['search/code'] + } + '/search/commits': { /** * Find commits via various criteria on the default branch (usually `master`). This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -4838,9 +4838,9 @@ export type paths = { * * `q=repo:octocat/Spoon-Knife+css` */ - get: operations["search/commits"]; - }; - "/search/issues": { + get: operations['search/commits'] + } + '/search/issues': { /** * Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -4855,9 +4855,9 @@ export type paths = { * * **Note:** For [user-to-server](https://docs.github.com/developers/apps/identifying-and-authorizing-users-for-github-apps#user-to-server-requests) GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." */ - get: operations["search/issues-and-pull-requests"]; - }; - "/search/labels": { + get: operations['search/issues-and-pull-requests'] + } + '/search/labels': { /** * Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -4869,9 +4869,9 @@ export type paths = { * * The labels that best match the query appear first in the search results. */ - get: operations["search/labels"]; - }; - "/search/repositories": { + get: operations['search/labels'] + } + '/search/repositories': { /** * Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -4883,9 +4883,9 @@ export type paths = { * * This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results. */ - get: operations["search/repos"]; - }; - "/search/topics": { + get: operations['search/repos'] + } + '/search/topics': { /** * Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers. * @@ -4897,9 +4897,9 @@ export type paths = { * * This query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results. */ - get: operations["search/topics"]; - }; - "/search/users": { + get: operations['search/topics'] + } + '/search/users': { /** * Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -4911,11 +4911,11 @@ export type paths = { * * This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. */ - get: operations["search/users"]; - }; - "/teams/{team_id}": { + get: operations['search/users'] + } + '/teams/{team_id}': { /** **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/reference/teams#get-a-team-by-name) endpoint. */ - get: operations["teams/get-legacy"]; + get: operations['teams/get-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/reference/teams#delete-a-team) endpoint. * @@ -4923,7 +4923,7 @@ export type paths = { * * If you are an organization owner, deleting a parent team will delete all of its child teams as well. */ - delete: operations["teams/delete-legacy"]; + delete: operations['teams/delete-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/reference/teams#update-a-team) endpoint. * @@ -4931,15 +4931,15 @@ export type paths = { * * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. */ - patch: operations["teams/update-legacy"]; - }; - "/teams/{team_id}/discussions": { + patch: operations['teams/update-legacy'] + } + '/teams/{team_id}/discussions': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/reference/teams#list-discussions) endpoint. * * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - get: operations["teams/list-discussions-legacy"]; + get: operations['teams/list-discussions-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/reference/teams#create-a-discussion) endpoint. * @@ -4947,35 +4947,35 @@ export type paths = { * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - post: operations["teams/create-discussion-legacy"]; - }; - "/teams/{team_id}/discussions/{discussion_number}": { + post: operations['teams/create-discussion-legacy'] + } + '/teams/{team_id}/discussions/{discussion_number}': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/reference/teams#get-a-discussion) endpoint. * * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - get: operations["teams/get-discussion-legacy"]; + get: operations['teams/get-discussion-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/reference/teams#delete-a-discussion) endpoint. * * Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - delete: operations["teams/delete-discussion-legacy"]; + delete: operations['teams/delete-discussion-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/reference/teams#update-a-discussion) endpoint. * * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - patch: operations["teams/update-discussion-legacy"]; - }; - "/teams/{team_id}/discussions/{discussion_number}/comments": { + patch: operations['teams/update-discussion-legacy'] + } + '/teams/{team_id}/discussions/{discussion_number}/comments': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/reference/teams#list-discussion-comments) endpoint. * * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - get: operations["teams/list-discussion-comments-legacy"]; + get: operations['teams/list-discussion-comments-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/reference/teams#create-a-discussion-comment) endpoint. * @@ -4983,73 +4983,73 @@ export type paths = { * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - post: operations["teams/create-discussion-comment-legacy"]; - }; - "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": { + post: operations['teams/create-discussion-comment-legacy'] + } + '/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/reference/teams#get-a-discussion-comment) endpoint. * * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - get: operations["teams/get-discussion-comment-legacy"]; + get: operations['teams/get-discussion-comment-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/reference/teams#delete-a-discussion-comment) endpoint. * * Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - delete: operations["teams/delete-discussion-comment-legacy"]; + delete: operations['teams/delete-discussion-comment-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/reference/teams#update-a-discussion-comment) endpoint. * * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - patch: operations["teams/update-discussion-comment-legacy"]; - }; - "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": { + patch: operations['teams/update-discussion-comment-legacy'] + } + '/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * * List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - get: operations["reactions/list-for-team-discussion-comment-legacy"]; + get: operations['reactions/list-for-team-discussion-comment-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. * * Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. */ - post: operations["reactions/create-for-team-discussion-comment-legacy"]; - }; - "/teams/{team_id}/discussions/{discussion_number}/reactions": { + post: operations['reactions/create-for-team-discussion-comment-legacy'] + } + '/teams/{team_id}/discussions/{discussion_number}/reactions': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion) endpoint. * * List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - get: operations["reactions/list-for-team-discussion-legacy"]; + get: operations['reactions/list-for-team-discussion-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion) endpoint. * * Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. */ - post: operations["reactions/create-for-team-discussion-legacy"]; - }; - "/teams/{team_id}/invitations": { + post: operations['reactions/create-for-team-discussion-legacy'] + } + '/teams/{team_id}/invitations': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/reference/teams#list-pending-team-invitations) endpoint. * * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. */ - get: operations["teams/list-pending-invitations-legacy"]; - }; - "/teams/{team_id}/members": { + get: operations['teams/list-pending-invitations-legacy'] + } + '/teams/{team_id}/members': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/reference/teams#list-team-members) endpoint. * * Team members will include the members of child teams. */ - get: operations["teams/list-members-legacy"]; - }; - "/teams/{team_id}/members/{username}": { + get: operations['teams/list-members-legacy'] + } + '/teams/{team_id}/members/{username}': { /** * The "Get team member" endpoint (described below) is deprecated. * @@ -5057,7 +5057,7 @@ export type paths = { * * To list members in a team, the team must be visible to the authenticated user. */ - get: operations["teams/get-member-legacy"]; + get: operations['teams/get-member-legacy'] /** * The "Add team member" endpoint (described below) is deprecated. * @@ -5071,7 +5071,7 @@ export type paths = { * * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - put: operations["teams/add-member-legacy"]; + put: operations['teams/add-member-legacy'] /** * The "Remove team member" endpoint (described below) is deprecated. * @@ -5083,9 +5083,9 @@ export type paths = { * * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ - delete: operations["teams/remove-member-legacy"]; - }; - "/teams/{team_id}/memberships/{username}": { + delete: operations['teams/remove-member-legacy'] + } + '/teams/{team_id}/memberships/{username}': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/reference/teams#get-team-membership-for-a-user) endpoint. * @@ -5098,7 +5098,7 @@ export type paths = { * * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team). */ - get: operations["teams/get-membership-for-user-legacy"]; + get: operations['teams/get-membership-for-user-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint. * @@ -5112,7 +5112,7 @@ export type paths = { * * If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. */ - put: operations["teams/add-or-update-membership-for-user-legacy"]; + put: operations['teams/add-or-update-membership-for-user-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/reference/teams#remove-team-membership-for-a-user) endpoint. * @@ -5122,41 +5122,41 @@ export type paths = { * * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ - delete: operations["teams/remove-membership-for-user-legacy"]; - }; - "/teams/{team_id}/projects": { + delete: operations['teams/remove-membership-for-user-legacy'] + } + '/teams/{team_id}/projects': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/reference/teams#list-team-projects) endpoint. * * Lists the organization projects for a team. */ - get: operations["teams/list-projects-legacy"]; - }; - "/teams/{team_id}/projects/{project_id}": { + get: operations['teams/list-projects-legacy'] + } + '/teams/{team_id}/projects/{project_id}': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/reference/teams#check-team-permissions-for-a-project) endpoint. * * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. */ - get: operations["teams/check-permissions-for-project-legacy"]; + get: operations['teams/check-permissions-for-project-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/reference/teams#add-or-update-team-project-permissions) endpoint. * * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. */ - put: operations["teams/add-or-update-project-permissions-legacy"]; + put: operations['teams/add-or-update-project-permissions-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/reference/teams#remove-a-project-from-a-team) endpoint. * * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. */ - delete: operations["teams/remove-project-legacy"]; - }; - "/teams/{team_id}/repos": { + delete: operations['teams/remove-project-legacy'] + } + '/teams/{team_id}/repos': { /** **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/reference/teams#list-team-repositories) endpoint. */ - get: operations["teams/list-repos-legacy"]; - }; - "/teams/{team_id}/repos/{owner}/{repo}": { + get: operations['teams/list-repos-legacy'] + } + '/teams/{team_id}/repos/{owner}/{repo}': { /** * **Note**: Repositories inherited through a parent team will also be checked. * @@ -5164,7 +5164,7 @@ export type paths = { * * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: */ - get: operations["teams/check-permissions-for-repo-legacy"]; + get: operations['teams/check-permissions-for-repo-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/reference/teams#add-or-update-team-repository-permissions)" endpoint. * @@ -5172,15 +5172,15 @@ export type paths = { * * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - put: operations["teams/add-or-update-repo-permissions-legacy"]; + put: operations['teams/add-or-update-repo-permissions-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/reference/teams#remove-a-repository-from-a-team) endpoint. * * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. */ - delete: operations["teams/remove-repo-legacy"]; - }; - "/teams/{team_id}/team-sync/group-mappings": { + delete: operations['teams/remove-repo-legacy'] + } + '/teams/{team_id}/team-sync/group-mappings': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List IdP groups for a team`](https://docs.github.com/rest/reference/teams#list-idp-groups-for-a-team) endpoint. * @@ -5188,7 +5188,7 @@ export type paths = { * * List IdP groups connected to a team on GitHub. */ - get: operations["teams/list-idp-groups-for-legacy"]; + get: operations['teams/list-idp-groups-for-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create or update IdP group connections`](https://docs.github.com/rest/reference/teams#create-or-update-idp-group-connections) endpoint. * @@ -5196,38 +5196,38 @@ export type paths = { * * Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty `groups` array will remove all connections for a team. */ - patch: operations["teams/create-or-update-idp-group-connections-legacy"]; - }; - "/teams/{team_id}/teams": { + patch: operations['teams/create-or-update-idp-group-connections-legacy'] + } + '/teams/{team_id}/teams': { /** **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/reference/teams#list-child-teams) endpoint. */ - get: operations["teams/list-child-legacy"]; - }; - "/user": { + get: operations['teams/list-child-legacy'] + } + '/user': { /** * If the authenticated user is authenticated through basic authentication or OAuth with the `user` scope, then the response lists public and private profile information. * * If the authenticated user is authenticated through OAuth without the `user` scope, then the response lists only public profile information. */ - get: operations["users/get-authenticated"]; + get: operations['users/get-authenticated'] /** **Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API. */ - patch: operations["users/update-authenticated"]; - }; - "/user/blocks": { + patch: operations['users/update-authenticated'] + } + '/user/blocks': { /** List the users you've blocked on your personal account. */ - get: operations["users/list-blocked-by-authenticated-user"]; - }; - "/user/blocks/{username}": { - get: operations["users/check-blocked"]; - put: operations["users/block"]; - delete: operations["users/unblock"]; - }; - "/user/codespaces": { + get: operations['users/list-blocked-by-authenticated-user'] + } + '/user/blocks/{username}': { + get: operations['users/check-blocked'] + put: operations['users/block'] + delete: operations['users/unblock'] + } + '/user/codespaces': { /** * Lists the authenticated user's codespaces. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - get: operations["codespaces/list-for-authenticated-user"]; + get: operations['codespaces/list-for-authenticated-user'] /** * Creates a new codespace, owned by the authenticated user. * @@ -5235,26 +5235,26 @@ export type paths = { * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - post: operations["codespaces/create-for-authenticated-user"]; - }; - "/user/codespaces/secrets": { + post: operations['codespaces/create-for-authenticated-user'] + } + '/user/codespaces/secrets': { /** * Lists all secrets available for a user's Codespaces without revealing their * encrypted values. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - get: operations["codespaces/list-secrets-for-authenticated-user"]; - }; - "/user/codespaces/secrets/public-key": { + get: operations['codespaces/list-secrets-for-authenticated-user'] + } + '/user/codespaces/secrets/public-key': { /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with one of the 'read:user' or 'user' scopes in their personal access token. User must have Codespaces access to use this endpoint. */ - get: operations["codespaces/get-public-key-for-authenticated-user"]; - }; - "/user/codespaces/secrets/{secret_name}": { + get: operations['codespaces/get-public-key-for-authenticated-user'] + } + '/user/codespaces/secrets/{secret_name}': { /** * Gets a secret available to a user's codespaces without revealing its encrypted value. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - get: operations["codespaces/get-secret-for-authenticated-user"]; + get: operations['codespaces/get-secret-for-authenticated-user'] /** * Creates or updates a secret for a user's codespace with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access token with the `user` scope to use this endpoint. User must also have Codespaces access to use this endpoint. @@ -5330,47 +5330,47 @@ export type paths = { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - put: operations["codespaces/create-or-update-secret-for-authenticated-user"]; + put: operations['codespaces/create-or-update-secret-for-authenticated-user'] /** Deletes a secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret. You must authenticate using an access token with the `user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - delete: operations["codespaces/delete-secret-for-authenticated-user"]; - }; - "/user/codespaces/secrets/{secret_name}/repositories": { + delete: operations['codespaces/delete-secret-for-authenticated-user'] + } + '/user/codespaces/secrets/{secret_name}/repositories': { /** * List the repositories that have been granted the ability to use a user's codespace secret. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - get: operations["codespaces/list-repositories-for-secret-for-authenticated-user"]; + get: operations['codespaces/list-repositories-for-secret-for-authenticated-user'] /** * Select the repositories that will use a user's codespace secret. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - put: operations["codespaces/set-repositories-for-secret-for-authenticated-user"]; - }; - "/user/codespaces/secrets/{secret_name}/repositories/{repository_id}": { + put: operations['codespaces/set-repositories-for-secret-for-authenticated-user'] + } + '/user/codespaces/secrets/{secret_name}/repositories/{repository_id}': { /** * Adds a repository to the selected repositories for a user's codespace secret. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - put: operations["codespaces/add-repository-for-secret-for-authenticated-user"]; + put: operations['codespaces/add-repository-for-secret-for-authenticated-user'] /** * Removes a repository from the selected repositories for a user's codespace secret. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - delete: operations["codespaces/remove-repository-for-secret-for-authenticated-user"]; - }; - "/user/codespaces/{codespace_name}": { + delete: operations['codespaces/remove-repository-for-secret-for-authenticated-user'] + } + '/user/codespaces/{codespace_name}': { /** * Gets information about a user's codespace. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - get: operations["codespaces/get-for-authenticated-user"]; + get: operations['codespaces/get-for-authenticated-user'] /** * Deletes a user's codespace. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - delete: operations["codespaces/delete-for-authenticated-user"]; + delete: operations['codespaces/delete-for-authenticated-user'] /** * Updates a codespace owned by the authenticated user. Currently only the codespace's machine type and recent folders can be modified using this endpoint. * @@ -5378,92 +5378,92 @@ export type paths = { * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - patch: operations["codespaces/update-for-authenticated-user"]; - }; - "/user/codespaces/{codespace_name}/exports": { + patch: operations['codespaces/update-for-authenticated-user'] + } + '/user/codespaces/{codespace_name}/exports': { /** * Triggers an export of the specified codespace and returns a URL and ID where the status of the export can be monitored. * * You must authenticate using a personal access token with the `codespace` scope to use this endpoint. */ - post: operations["codespaces/export-for-authenticated-user"]; - }; - "/user/codespaces/{codespace_name}/exports/{export_id}": { + post: operations['codespaces/export-for-authenticated-user'] + } + '/user/codespaces/{codespace_name}/exports/{export_id}': { /** * Gets information about an export of a codespace. * * You must authenticate using a personal access token with the `codespace` scope to use this endpoint. */ - get: operations["codespaces/get-export-details-for-authenticated-user"]; - }; - "/user/codespaces/{codespace_name}/machines": { + get: operations['codespaces/get-export-details-for-authenticated-user'] + } + '/user/codespaces/{codespace_name}/machines': { /** * List the machine types a codespace can transition to use. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - get: operations["codespaces/codespace-machines-for-authenticated-user"]; - }; - "/user/codespaces/{codespace_name}/start": { + get: operations['codespaces/codespace-machines-for-authenticated-user'] + } + '/user/codespaces/{codespace_name}/start': { /** * Starts a user's codespace. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - post: operations["codespaces/start-for-authenticated-user"]; - }; - "/user/codespaces/{codespace_name}/stop": { + post: operations['codespaces/start-for-authenticated-user'] + } + '/user/codespaces/{codespace_name}/stop': { /** * Stops a user's codespace. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - post: operations["codespaces/stop-for-authenticated-user"]; - }; - "/user/email/visibility": { + post: operations['codespaces/stop-for-authenticated-user'] + } + '/user/email/visibility': { /** Sets the visibility for your primary email addresses. */ - patch: operations["users/set-primary-email-visibility-for-authenticated-user"]; - }; - "/user/emails": { + patch: operations['users/set-primary-email-visibility-for-authenticated-user'] + } + '/user/emails': { /** Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope. */ - get: operations["users/list-emails-for-authenticated-user"]; + get: operations['users/list-emails-for-authenticated-user'] /** This endpoint is accessible with the `user` scope. */ - post: operations["users/add-email-for-authenticated-user"]; + post: operations['users/add-email-for-authenticated-user'] /** This endpoint is accessible with the `user` scope. */ - delete: operations["users/delete-email-for-authenticated-user"]; - }; - "/user/followers": { + delete: operations['users/delete-email-for-authenticated-user'] + } + '/user/followers': { /** Lists the people following the authenticated user. */ - get: operations["users/list-followers-for-authenticated-user"]; - }; - "/user/following": { + get: operations['users/list-followers-for-authenticated-user'] + } + '/user/following': { /** Lists the people who the authenticated user follows. */ - get: operations["users/list-followed-by-authenticated-user"]; - }; - "/user/following/{username}": { - get: operations["users/check-person-is-followed-by-authenticated"]; + get: operations['users/list-followed-by-authenticated-user'] + } + '/user/following/{username}': { + get: operations['users/check-person-is-followed-by-authenticated'] /** * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." * * Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. */ - put: operations["users/follow"]; + put: operations['users/follow'] /** Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. */ - delete: operations["users/unfollow"]; - }; - "/user/gpg_keys": { + delete: operations['users/unfollow'] + } + '/user/gpg_keys': { /** Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - get: operations["users/list-gpg-keys-for-authenticated-user"]; + get: operations['users/list-gpg-keys-for-authenticated-user'] /** Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - post: operations["users/create-gpg-key-for-authenticated-user"]; - }; - "/user/gpg_keys/{gpg_key_id}": { + post: operations['users/create-gpg-key-for-authenticated-user'] + } + '/user/gpg_keys/{gpg_key_id}': { /** View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - get: operations["users/get-gpg-key-for-authenticated-user"]; + get: operations['users/get-gpg-key-for-authenticated-user'] /** Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - delete: operations["users/delete-gpg-key-for-authenticated-user"]; - }; - "/user/installations": { + delete: operations['users/delete-gpg-key-for-authenticated-user'] + } + '/user/installations': { /** * Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. * @@ -5473,9 +5473,9 @@ export type paths = { * * You can find the permissions for the installation under the `permissions` key. */ - get: operations["apps/list-installations-for-authenticated-user"]; - }; - "/user/installations/{installation_id}/repositories": { + get: operations['apps/list-installations-for-authenticated-user'] + } + '/user/installations/{installation_id}/repositories': { /** * List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation. * @@ -5485,31 +5485,31 @@ export type paths = { * * The access the user has to each repository is included in the hash under the `permissions` key. */ - get: operations["apps/list-installation-repos-for-authenticated-user"]; - }; - "/user/installations/{installation_id}/repositories/{repository_id}": { + get: operations['apps/list-installation-repos-for-authenticated-user'] + } + '/user/installations/{installation_id}/repositories/{repository_id}': { /** * Add a single repository to an installation. The authenticated user must have admin access to the repository. * * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. */ - put: operations["apps/add-repo-to-installation-for-authenticated-user"]; + put: operations['apps/add-repo-to-installation-for-authenticated-user'] /** * Remove a single repository from an installation. The authenticated user must have admin access to the repository. * * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. */ - delete: operations["apps/remove-repo-from-installation-for-authenticated-user"]; - }; - "/user/interaction-limits": { + delete: operations['apps/remove-repo-from-installation-for-authenticated-user'] + } + '/user/interaction-limits': { /** Shows which type of GitHub user can interact with your public repositories and when the restriction expires. */ - get: operations["interactions/get-restrictions-for-authenticated-user"]; + get: operations['interactions/get-restrictions-for-authenticated-user'] /** Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user. */ - put: operations["interactions/set-restrictions-for-authenticated-user"]; + put: operations['interactions/set-restrictions-for-authenticated-user'] /** Removes any interaction restrictions from your public repositories. */ - delete: operations["interactions/remove-restrictions-for-authenticated-user"]; - }; - "/user/issues": { + delete: operations['interactions/remove-restrictions-for-authenticated-user'] + } + '/user/issues': { /** * List issues across owned and member repositories assigned to the authenticated user. * @@ -5518,42 +5518,42 @@ export type paths = { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - get: operations["issues/list-for-authenticated-user"]; - }; - "/user/keys": { + get: operations['issues/list-for-authenticated-user'] + } + '/user/keys': { /** Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - get: operations["users/list-public-ssh-keys-for-authenticated-user"]; + get: operations['users/list-public-ssh-keys-for-authenticated-user'] /** Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - post: operations["users/create-public-ssh-key-for-authenticated-user"]; - }; - "/user/keys/{key_id}": { + post: operations['users/create-public-ssh-key-for-authenticated-user'] + } + '/user/keys/{key_id}': { /** View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - get: operations["users/get-public-ssh-key-for-authenticated-user"]; + get: operations['users/get-public-ssh-key-for-authenticated-user'] /** Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - delete: operations["users/delete-public-ssh-key-for-authenticated-user"]; - }; - "/user/marketplace_purchases": { + delete: operations['users/delete-public-ssh-key-for-authenticated-user'] + } + '/user/marketplace_purchases': { /** Lists the active subscriptions for the authenticated user. You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an [OAuth token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/). */ - get: operations["apps/list-subscriptions-for-authenticated-user"]; - }; - "/user/marketplace_purchases/stubbed": { + get: operations['apps/list-subscriptions-for-authenticated-user'] + } + '/user/marketplace_purchases/stubbed': { /** Lists the active subscriptions for the authenticated user. You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an [OAuth token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/). */ - get: operations["apps/list-subscriptions-for-authenticated-user-stubbed"]; - }; - "/user/memberships/orgs": { - get: operations["orgs/list-memberships-for-authenticated-user"]; - }; - "/user/memberships/orgs/{org}": { - get: operations["orgs/get-membership-for-authenticated-user"]; - patch: operations["orgs/update-membership-for-authenticated-user"]; - }; - "/user/migrations": { + get: operations['apps/list-subscriptions-for-authenticated-user-stubbed'] + } + '/user/memberships/orgs': { + get: operations['orgs/list-memberships-for-authenticated-user'] + } + '/user/memberships/orgs/{org}': { + get: operations['orgs/get-membership-for-authenticated-user'] + patch: operations['orgs/update-membership-for-authenticated-user'] + } + '/user/migrations': { /** Lists all migrations a user has started. */ - get: operations["migrations/list-for-authenticated-user"]; + get: operations['migrations/list-for-authenticated-user'] /** Initiates the generation of a user migration archive. */ - post: operations["migrations/start-for-authenticated-user"]; - }; - "/user/migrations/{migration_id}": { + post: operations['migrations/start-for-authenticated-user'] + } + '/user/migrations/{migration_id}': { /** * Fetches a single user migration. The response includes the `state` of the migration, which can be one of the following values: * @@ -5564,9 +5564,9 @@ export type paths = { * * Once the migration has been `exported` you can [download the migration archive](https://docs.github.com/rest/reference/migrations#download-a-user-migration-archive). */ - get: operations["migrations/get-status-for-authenticated-user"]; - }; - "/user/migrations/{migration_id}/archive": { + get: operations['migrations/get-status-for-authenticated-user'] + } + '/user/migrations/{migration_id}/archive': { /** * Fetches the URL to download the migration archive as a `tar.gz` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects: * @@ -5590,19 +5590,19 @@ export type paths = { * * The archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data. */ - get: operations["migrations/get-archive-for-authenticated-user"]; + get: operations['migrations/get-archive-for-authenticated-user'] /** Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the [List user migrations](https://docs.github.com/rest/reference/migrations#list-user-migrations) and [Get a user migration status](https://docs.github.com/rest/reference/migrations#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted. */ - delete: operations["migrations/delete-archive-for-authenticated-user"]; - }; - "/user/migrations/{migration_id}/repos/{repo_name}/lock": { + delete: operations['migrations/delete-archive-for-authenticated-user'] + } + '/user/migrations/{migration_id}/repos/{repo_name}/lock': { /** Unlocks a repository. You can lock repositories when you [start a user migration](https://docs.github.com/rest/reference/migrations#start-a-user-migration). Once the migration is complete you can unlock each repository to begin using it again or [delete the repository](https://docs.github.com/rest/reference/repos#delete-a-repository) if you no longer need the source data. Returns a status of `404 Not Found` if the repository is not locked. */ - delete: operations["migrations/unlock-repo-for-authenticated-user"]; - }; - "/user/migrations/{migration_id}/repositories": { + delete: operations['migrations/unlock-repo-for-authenticated-user'] + } + '/user/migrations/{migration_id}/repositories': { /** Lists all the repositories for this user migration. */ - get: operations["migrations/list-repos-for-authenticated-user"]; - }; - "/user/orgs": { + get: operations['migrations/list-repos-for-authenticated-user'] + } + '/user/orgs': { /** * List organizations for the authenticated user. * @@ -5610,34 +5610,34 @@ export type paths = { * * This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response. */ - get: operations["orgs/list-for-authenticated-user"]; - }; - "/user/packages": { + get: operations['orgs/list-for-authenticated-user'] + } + '/user/packages': { /** * Lists packages owned by the authenticated user within the user's namespace. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/list-packages-for-authenticated-user"]; - }; - "/user/packages/{package_type}/{package_name}": { + get: operations['packages/list-packages-for-authenticated-user'] + } + '/user/packages/{package_type}/{package_name}': { /** * Gets a specific package for a package owned by the authenticated user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/get-package-for-authenticated-user"]; + get: operations['packages/get-package-for-authenticated-user'] /** * Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:delete` scopes. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - delete: operations["packages/delete-package-for-authenticated-user"]; - }; - "/user/packages/{package_type}/{package_name}/restore": { + delete: operations['packages/delete-package-for-authenticated-user'] + } + '/user/packages/{package_type}/{package_name}/restore': { /** * Restores a package owned by the authenticated user. * @@ -5647,34 +5647,34 @@ export type paths = { * * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. If `package_type` is not `container`, your token must also include the `repo` scope. */ - post: operations["packages/restore-package-for-authenticated-user"]; - }; - "/user/packages/{package_type}/{package_name}/versions": { + post: operations['packages/restore-package-for-authenticated-user'] + } + '/user/packages/{package_type}/{package_name}/versions': { /** * Returns all package versions for a package owned by the authenticated user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/get-all-package-versions-for-package-owned-by-authenticated-user"]; - }; - "/user/packages/{package_type}/{package_name}/versions/{package_version_id}": { + get: operations['packages/get-all-package-versions-for-package-owned-by-authenticated-user'] + } + '/user/packages/{package_type}/{package_name}/versions/{package_version_id}': { /** * Gets a specific package version for a package owned by the authenticated user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/get-package-version-for-authenticated-user"]; + get: operations['packages/get-package-version-for-authenticated-user'] /** * Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:delete` scopes. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - delete: operations["packages/delete-package-version-for-authenticated-user"]; - }; - "/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { + delete: operations['packages/delete-package-version-for-authenticated-user'] + } + '/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore': { /** * Restores a package version owned by the authenticated user. * @@ -5684,22 +5684,22 @@ export type paths = { * * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. If `package_type` is not `container`, your token must also include the `repo` scope. */ - post: operations["packages/restore-package-version-for-authenticated-user"]; - }; - "/user/projects": { - post: operations["projects/create-for-authenticated-user"]; - }; - "/user/public_emails": { + post: operations['packages/restore-package-version-for-authenticated-user'] + } + '/user/projects': { + post: operations['projects/create-for-authenticated-user'] + } + '/user/public_emails': { /** Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope. */ - get: operations["users/list-public-emails-for-authenticated-user"]; - }; - "/user/repos": { + get: operations['users/list-public-emails-for-authenticated-user'] + } + '/user/repos': { /** * Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. * * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. */ - get: operations["repos/list-for-authenticated-user"]; + get: operations['repos/list-for-authenticated-user'] /** * Creates a new repository for the authenticated user. * @@ -5710,47 +5710,47 @@ export type paths = { * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. * * `repo` scope to create a private repository. */ - post: operations["repos/create-for-authenticated-user"]; - }; - "/user/repository_invitations": { + post: operations['repos/create-for-authenticated-user'] + } + '/user/repository_invitations': { /** When authenticating as a user, this endpoint will list all currently open repository invitations for that user. */ - get: operations["repos/list-invitations-for-authenticated-user"]; - }; - "/user/repository_invitations/{invitation_id}": { - delete: operations["repos/decline-invitation-for-authenticated-user"]; - patch: operations["repos/accept-invitation-for-authenticated-user"]; - }; - "/user/starred": { + get: operations['repos/list-invitations-for-authenticated-user'] + } + '/user/repository_invitations/{invitation_id}': { + delete: operations['repos/decline-invitation-for-authenticated-user'] + patch: operations['repos/accept-invitation-for-authenticated-user'] + } + '/user/starred': { /** * Lists repositories the authenticated user has starred. * * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: */ - get: operations["activity/list-repos-starred-by-authenticated-user"]; - }; - "/user/starred/{owner}/{repo}": { - get: operations["activity/check-repo-is-starred-by-authenticated-user"]; + get: operations['activity/list-repos-starred-by-authenticated-user'] + } + '/user/starred/{owner}/{repo}': { + get: operations['activity/check-repo-is-starred-by-authenticated-user'] /** Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - put: operations["activity/star-repo-for-authenticated-user"]; - delete: operations["activity/unstar-repo-for-authenticated-user"]; - }; - "/user/subscriptions": { + put: operations['activity/star-repo-for-authenticated-user'] + delete: operations['activity/unstar-repo-for-authenticated-user'] + } + '/user/subscriptions': { /** Lists repositories the authenticated user is watching. */ - get: operations["activity/list-watched-repos-for-authenticated-user"]; - }; - "/user/teams": { + get: operations['activity/list-watched-repos-for-authenticated-user'] + } + '/user/teams': { /** List all of the teams across all of the organizations to which the authenticated user belongs. This method requires `user`, `repo`, or `read:org` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://docs.github.com/apps/building-oauth-apps/). */ - get: operations["teams/list-for-authenticated-user"]; - }; - "/users": { + get: operations['teams/list-for-authenticated-user'] + } + '/users': { /** * Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts. * * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of users. */ - get: operations["users/list"]; - }; - "/users/{username}": { + get: operations['users/list'] + } + '/users/{username}': { /** * Provides publicly available information about someone with a GitHub account. * @@ -5760,39 +5760,39 @@ export type paths = { * * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/reference/users#emails)". */ - get: operations["users/get-by-username"]; - }; - "/users/{username}/events": { + get: operations['users/get-by-username'] + } + '/users/{username}/events': { /** If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. */ - get: operations["activity/list-events-for-authenticated-user"]; - }; - "/users/{username}/events/orgs/{org}": { + get: operations['activity/list-events-for-authenticated-user'] + } + '/users/{username}/events/orgs/{org}': { /** This is the user's organization dashboard. You must be authenticated as the user to view this. */ - get: operations["activity/list-org-events-for-authenticated-user"]; - }; - "/users/{username}/events/public": { - get: operations["activity/list-public-events-for-user"]; - }; - "/users/{username}/followers": { + get: operations['activity/list-org-events-for-authenticated-user'] + } + '/users/{username}/events/public': { + get: operations['activity/list-public-events-for-user'] + } + '/users/{username}/followers': { /** Lists the people following the specified user. */ - get: operations["users/list-followers-for-user"]; - }; - "/users/{username}/following": { + get: operations['users/list-followers-for-user'] + } + '/users/{username}/following': { /** Lists the people who the specified user follows. */ - get: operations["users/list-following-for-user"]; - }; - "/users/{username}/following/{target_user}": { - get: operations["users/check-following-for-user"]; - }; - "/users/{username}/gists": { + get: operations['users/list-following-for-user'] + } + '/users/{username}/following/{target_user}': { + get: operations['users/check-following-for-user'] + } + '/users/{username}/gists': { /** Lists public gists for the specified user: */ - get: operations["gists/list-for-user"]; - }; - "/users/{username}/gpg_keys": { + get: operations['gists/list-for-user'] + } + '/users/{username}/gpg_keys': { /** Lists the GPG keys for a user. This information is accessible by anyone. */ - get: operations["users/list-gpg-keys-for-user"]; - }; - "/users/{username}/hovercard": { + get: operations['users/list-gpg-keys-for-user'] + } + '/users/{username}/hovercard': { /** * Provides hovercard information when authenticated through basic auth or OAuth with the `repo` scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. * @@ -5803,45 +5803,45 @@ export type paths = { * https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 * ``` */ - get: operations["users/get-context-for-user"]; - }; - "/users/{username}/installation": { + get: operations['users/get-context-for-user'] + } + '/users/{username}/installation': { /** * Enables an authenticated GitHub App to find the user’s installation information. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - get: operations["apps/get-user-installation"]; - }; - "/users/{username}/keys": { + get: operations['apps/get-user-installation'] + } + '/users/{username}/keys': { /** Lists the _verified_ public SSH keys for a user. This is accessible by anyone. */ - get: operations["users/list-public-keys-for-user"]; - }; - "/users/{username}/orgs": { + get: operations['users/list-public-keys-for-user'] + } + '/users/{username}/orgs': { /** * List [public organization memberships](https://docs.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user. * * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/rest/reference/orgs#list-organizations-for-the-authenticated-user) API instead. */ - get: operations["orgs/list-for-user"]; - }; - "/users/{username}/packages": { + get: operations['orgs/list-for-user'] + } + '/users/{username}/packages': { /** * Lists all packages in a user's namespace for which the requesting user has access. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/list-packages-for-user"]; - }; - "/users/{username}/packages/{package_type}/{package_name}": { + get: operations['packages/list-packages-for-user'] + } + '/users/{username}/packages/{package_type}/{package_name}': { /** * Gets a specific package metadata for a public package owned by a user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/get-package-for-user"]; + get: operations['packages/get-package-for-user'] /** * Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * @@ -5849,9 +5849,9 @@ export type paths = { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. */ - delete: operations["packages/delete-package-for-user"]; - }; - "/users/{username}/packages/{package_type}/{package_name}/restore": { + delete: operations['packages/delete-package-for-user'] + } + '/users/{username}/packages/{package_type}/{package_name}/restore': { /** * Restores an entire package for a user. * @@ -5863,25 +5863,25 @@ export type paths = { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. */ - post: operations["packages/restore-package-for-user"]; - }; - "/users/{username}/packages/{package_type}/{package_name}/versions": { + post: operations['packages/restore-package-for-user'] + } + '/users/{username}/packages/{package_type}/{package_name}/versions': { /** * Returns all package versions for a public package owned by a specified user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/get-all-package-versions-for-package-owned-by-user"]; - }; - "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}": { + get: operations['packages/get-all-package-versions-for-package-owned-by-user'] + } + '/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}': { /** * Gets a specific package version for a public package owned by a specified user. * * At this time, to use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/get-package-version-for-user"]; + get: operations['packages/get-package-version-for-user'] /** * Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * @@ -5889,9 +5889,9 @@ export type paths = { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. */ - delete: operations["packages/delete-package-version-for-user"]; - }; - "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { + delete: operations['packages/delete-package-version-for-user'] + } + '/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore': { /** * Restores a specific package version for a user. * @@ -5903,23 +5903,23 @@ export type paths = { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. */ - post: operations["packages/restore-package-version-for-user"]; - }; - "/users/{username}/projects": { - get: operations["projects/list-for-user"]; - }; - "/users/{username}/received_events": { + post: operations['packages/restore-package-version-for-user'] + } + '/users/{username}/projects': { + get: operations['projects/list-for-user'] + } + '/users/{username}/received_events': { /** These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. */ - get: operations["activity/list-received-events-for-user"]; - }; - "/users/{username}/received_events/public": { - get: operations["activity/list-received-public-events-for-user"]; - }; - "/users/{username}/repos": { + get: operations['activity/list-received-events-for-user'] + } + '/users/{username}/received_events/public': { + get: operations['activity/list-received-public-events-for-user'] + } + '/users/{username}/repos': { /** Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user. */ - get: operations["repos/list-for-user"]; - }; - "/users/{username}/settings/billing/actions": { + get: operations['repos/list-for-user'] + } + '/users/{username}/settings/billing/actions': { /** * Gets the summary of the free and paid GitHub Actions minutes used. * @@ -5927,9 +5927,9 @@ export type paths = { * * Access tokens must have the `user` scope. */ - get: operations["billing/get-github-actions-billing-user"]; - }; - "/users/{username}/settings/billing/packages": { + get: operations['billing/get-github-actions-billing-user'] + } + '/users/{username}/settings/billing/packages': { /** * Gets the free and paid storage used for GitHub Packages in gigabytes. * @@ -5937,9 +5937,9 @@ export type paths = { * * Access tokens must have the `user` scope. */ - get: operations["billing/get-github-packages-billing-user"]; - }; - "/users/{username}/settings/billing/shared-storage": { + get: operations['billing/get-github-packages-billing-user'] + } + '/users/{username}/settings/billing/shared-storage': { /** * Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. * @@ -5947,25 +5947,25 @@ export type paths = { * * Access tokens must have the `user` scope. */ - get: operations["billing/get-shared-storage-billing-user"]; - }; - "/users/{username}/starred": { + get: operations['billing/get-shared-storage-billing-user'] + } + '/users/{username}/starred': { /** * Lists repositories a user has starred. * * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: */ - get: operations["activity/list-repos-starred-by-user"]; - }; - "/users/{username}/subscriptions": { + get: operations['activity/list-repos-starred-by-user'] + } + '/users/{username}/subscriptions': { /** Lists repositories a user is watching. */ - get: operations["activity/list-repos-watched-by-user"]; - }; - "/zen": { + get: operations['activity/list-repos-watched-by-user'] + } + '/zen': { /** Get a random sentence from the Zen of GitHub */ - get: operations["meta/get-zen"]; - }; -}; + get: operations['meta/get-zen'] + } +} export type components = { schemas: { @@ -5973,71 +5973,71 @@ export type components = { * Simple User * @description Simple User */ - "nullable-simple-user": { - name?: string | null; - email?: string | null; + 'nullable-simple-user': { + name?: string | null + email?: string | null /** @example octocat */ - login: string; + login: string /** @example 1 */ - id: number; + id: number /** @example MDQ6VXNlcjE= */ - node_id: string; + node_id: string /** * Format: uri * @example https://github.com/images/error/octocat_happy.gif */ - avatar_url: string; + avatar_url: string /** @example 41d064eb2195891e12d0413f63227ea7 */ - gravatar_id: string | null; + gravatar_id: string | null /** * Format: uri * @example https://api.github.com/users/octocat */ - url: string; + url: string /** * Format: uri * @example https://github.com/octocat */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/users/octocat/followers */ - followers_url: string; + followers_url: string /** @example https://api.github.com/users/octocat/following{/other_user} */ - following_url: string; + following_url: string /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - gists_url: string; + gists_url: string /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - starred_url: string; + starred_url: string /** * Format: uri * @example https://api.github.com/users/octocat/subscriptions */ - subscriptions_url: string; + subscriptions_url: string /** * Format: uri * @example https://api.github.com/users/octocat/orgs */ - organizations_url: string; + organizations_url: string /** * Format: uri * @example https://api.github.com/users/octocat/repos */ - repos_url: string; + repos_url: string /** @example https://api.github.com/users/octocat/events{/privacy} */ - events_url: string; + events_url: string /** * Format: uri * @example https://api.github.com/users/octocat/received_events */ - received_events_url: string; + received_events_url: string /** @example User */ - type: string; - site_admin: boolean; + type: string + site_admin: boolean /** @example "2020-07-09T00:17:55Z" */ - starred_at?: string; - } | null; + starred_at?: string + } | null /** * GitHub app * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. @@ -6047,554 +6047,554 @@ export type components = { * @description Unique identifier of the GitHub app * @example 37 */ - id: number; + id: number /** * @description The slug name of the GitHub app * @example probot-owners */ - slug?: string; + slug?: string /** @example MDExOkludGVncmF0aW9uMQ== */ - node_id: string; - owner: components["schemas"]["nullable-simple-user"]; + node_id: string + owner: components['schemas']['nullable-simple-user'] /** * @description The name of the GitHub app * @example Probot Owners */ - name: string; + name: string /** @example The description of the app. */ - description: string | null; + description: string | null /** * Format: uri * @example https://example.com */ - external_url: string; + external_url: string /** * Format: uri * @example https://github.com/apps/super-ci */ - html_url: string; + html_url: string /** * Format: date-time * @example 2017-07-08T16:18:44-04:00 */ - created_at: string; + created_at: string /** * Format: date-time * @example 2017-07-08T16:18:44-04:00 */ - updated_at: string; + updated_at: string /** * @description The set of permissions for the GitHub app * @example [object Object] */ permissions: { - issues?: string; - checks?: string; - metadata?: string; - contents?: string; - deployments?: string; - } & { [key: string]: string }; + issues?: string + checks?: string + metadata?: string + contents?: string + deployments?: string + } & { [key: string]: string } /** * @description The list of events for the GitHub app * @example label,deployment */ - events: string[]; + events: string[] /** * @description The number of installations associated with the GitHub app * @example 5 */ - installations_count?: number; + installations_count?: number /** @example "Iv1.25b5d1e65ffc4022" */ - client_id?: string; + client_id?: string /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ - client_secret?: string; + client_secret?: string /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ - webhook_secret?: string | null; + webhook_secret?: string | null /** @example "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n" */ - pem?: string; - }; + pem?: string + } /** * Basic Error * @description Basic Error */ - "basic-error": { - message?: string; - documentation_url?: string; - url?: string; - status?: string; - }; + 'basic-error': { + message?: string + documentation_url?: string + url?: string + status?: string + } /** * Validation Error Simple * @description Validation Error Simple */ - "validation-error-simple": { - message: string; - documentation_url: string; - errors?: string[]; - }; + 'validation-error-simple': { + message: string + documentation_url: string + errors?: string[] + } /** * Format: uri * @description The URL to which the payloads will be delivered. * @example https://example.com/webhook */ - "webhook-config-url": string; + 'webhook-config-url': string /** * @description The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`. * @example "json" */ - "webhook-config-content-type": string; + 'webhook-config-content-type': string /** * @description If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers). * @example "********" */ - "webhook-config-secret": string; - "webhook-config-insecure-ssl": string | number; + 'webhook-config-secret': string + 'webhook-config-insecure-ssl': string | number /** * Webhook Configuration * @description Configuration object of the webhook */ - "webhook-config": { - url?: components["schemas"]["webhook-config-url"]; - content_type?: components["schemas"]["webhook-config-content-type"]; - secret?: components["schemas"]["webhook-config-secret"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - }; + 'webhook-config': { + url?: components['schemas']['webhook-config-url'] + content_type?: components['schemas']['webhook-config-content-type'] + secret?: components['schemas']['webhook-config-secret'] + insecure_ssl?: components['schemas']['webhook-config-insecure-ssl'] + } /** * Simple webhook delivery * @description Delivery made by a webhook, without request and response information. */ - "hook-delivery-item": { + 'hook-delivery-item': { /** * @description Unique identifier of the webhook delivery. * @example 42 */ - id: number; + id: number /** * @description Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event). * @example 58474f00-b361-11eb-836d-0e4f3503ccbe */ - guid: string; + guid: string /** * Format: date-time * @description Time when the webhook delivery occurred. * @example 2021-05-12T20:33:44Z */ - delivered_at: string; + delivered_at: string /** @description Whether the webhook delivery is a redelivery. */ - redelivery: boolean; + redelivery: boolean /** * @description Time spent delivering. * @example 0.03 */ - duration: number; + duration: number /** * @description Describes the response returned after attempting the delivery. * @example failed to connect */ - status: string; + status: string /** * @description Status code received when delivery was made. * @example 502 */ - status_code: number; + status_code: number /** * @description The event that triggered the delivery. * @example issues */ - event: string; + event: string /** * @description The type of activity for the event that triggered the delivery. * @example opened */ - action: string | null; + action: string | null /** * @description The id of the GitHub App installation associated with this event. * @example 123 */ - installation_id: number | null; + installation_id: number | null /** * @description The id of the repository associated with this event. * @example 123 */ - repository_id: number | null; - }; + repository_id: number | null + } /** * Scim Error * @description Scim Error */ - "scim-error": { - message?: string | null; - documentation_url?: string | null; - detail?: string | null; - status?: number; - scimType?: string | null; - schemas?: string[]; - }; + 'scim-error': { + message?: string | null + documentation_url?: string | null + detail?: string | null + status?: number + scimType?: string | null + schemas?: string[] + } /** * Validation Error * @description Validation Error */ - "validation-error": { - message: string; - documentation_url: string; + 'validation-error': { + message: string + documentation_url: string errors?: { - resource?: string; - field?: string; - message?: string; - code: string; - index?: number; - value?: (string | null) | (number | null) | (string[] | null); - }[]; - }; + resource?: string + field?: string + message?: string + code: string + index?: number + value?: (string | null) | (number | null) | (string[] | null) + }[] + } /** * Webhook delivery * @description Delivery made by a webhook. */ - "hook-delivery": { + 'hook-delivery': { /** * @description Unique identifier of the delivery. * @example 42 */ - id: number; + id: number /** * @description Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event). * @example 58474f00-b361-11eb-836d-0e4f3503ccbe */ - guid: string; + guid: string /** * Format: date-time * @description Time when the delivery was delivered. * @example 2021-05-12T20:33:44Z */ - delivered_at: string; + delivered_at: string /** @description Whether the delivery is a redelivery. */ - redelivery: boolean; + redelivery: boolean /** * @description Time spent delivering. * @example 0.03 */ - duration: number; + duration: number /** * @description Description of the status of the attempted delivery * @example failed to connect */ - status: string; + status: string /** * @description Status code received when delivery was made. * @example 502 */ - status_code: number; + status_code: number /** * @description The event that triggered the delivery. * @example issues */ - event: string; + event: string /** * @description The type of activity for the event that triggered the delivery. * @example opened */ - action: string | null; + action: string | null /** * @description The id of the GitHub App installation associated with this event. * @example 123 */ - installation_id: number | null; + installation_id: number | null /** * @description The id of the repository associated with this event. * @example 123 */ - repository_id: number | null; + repository_id: number | null /** * @description The URL target of the delivery. * @example https://www.example.com */ - url?: string; + url?: string request: { /** @description The request headers sent with the webhook delivery. */ - headers: { [key: string]: unknown } | null; + headers: { [key: string]: unknown } | null /** @description The webhook payload. */ - payload: { [key: string]: unknown } | null; - }; + payload: { [key: string]: unknown } | null + } response: { /** @description The response headers received when the delivery was made. */ - headers: { [key: string]: unknown } | null; + headers: { [key: string]: unknown } | null /** @description The response payload received. */ - payload: string | null; - }; - }; + payload: string | null + } + } /** * Simple User * @description Simple User */ - "simple-user": { - name?: string | null; - email?: string | null; + 'simple-user': { + name?: string | null + email?: string | null /** @example octocat */ - login: string; + login: string /** @example 1 */ - id: number; + id: number /** @example MDQ6VXNlcjE= */ - node_id: string; + node_id: string /** * Format: uri * @example https://github.com/images/error/octocat_happy.gif */ - avatar_url: string; + avatar_url: string /** @example 41d064eb2195891e12d0413f63227ea7 */ - gravatar_id: string | null; + gravatar_id: string | null /** * Format: uri * @example https://api.github.com/users/octocat */ - url: string; + url: string /** * Format: uri * @example https://github.com/octocat */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/users/octocat/followers */ - followers_url: string; + followers_url: string /** @example https://api.github.com/users/octocat/following{/other_user} */ - following_url: string; + following_url: string /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - gists_url: string; + gists_url: string /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - starred_url: string; + starred_url: string /** * Format: uri * @example https://api.github.com/users/octocat/subscriptions */ - subscriptions_url: string; + subscriptions_url: string /** * Format: uri * @example https://api.github.com/users/octocat/orgs */ - organizations_url: string; + organizations_url: string /** * Format: uri * @example https://api.github.com/users/octocat/repos */ - repos_url: string; + repos_url: string /** @example https://api.github.com/users/octocat/events{/privacy} */ - events_url: string; + events_url: string /** * Format: uri * @example https://api.github.com/users/octocat/received_events */ - received_events_url: string; + received_events_url: string /** @example User */ - type: string; - site_admin: boolean; + type: string + site_admin: boolean /** @example "2020-07-09T00:17:55Z" */ - starred_at?: string; - }; + starred_at?: string + } /** * Enterprise * @description An enterprise account */ enterprise: { /** @description A short description of the enterprise. */ - description?: string | null; + description?: string | null /** * Format: uri * @example https://github.com/enterprises/octo-business */ - html_url: string; + html_url: string /** * Format: uri * @description The enterprise's website URL. */ - website_url?: string | null; + website_url?: string | null /** * @description Unique identifier of the enterprise * @example 42 */ - id: number; + id: number /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - node_id: string; + node_id: string /** * @description The name of the enterprise. * @example Octo Business */ - name: string; + name: string /** * @description The slug url identifier for the enterprise. * @example octo-business */ - slug: string; + slug: string /** * Format: date-time * @example 2019-01-26T19:01:12Z */ - created_at: string | null; + created_at: string | null /** * Format: date-time * @example 2019-01-26T19:14:43Z */ - updated_at: string | null; + updated_at: string | null /** Format: uri */ - avatar_url: string; - }; + avatar_url: string + } /** * App Permissions * @description The permissions granted to the user-to-server access token. * @example [object Object] */ - "app-permissions": { + 'app-permissions': { /** * @description The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts. Can be one of: `read` or `write`. * @enum {string} */ - actions?: "read" | "write"; + actions?: 'read' | 'write' /** * @description The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation. Can be one of: `read` or `write`. * @enum {string} */ - administration?: "read" | "write"; + administration?: 'read' | 'write' /** * @description The level of permission to grant the access token for checks on code. Can be one of: `read` or `write`. * @enum {string} */ - checks?: "read" | "write"; + checks?: 'read' | 'write' /** * @description The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges. Can be one of: `read` or `write`. * @enum {string} */ - contents?: "read" | "write"; + contents?: 'read' | 'write' /** * @description The level of permission to grant the access token for deployments and deployment statuses. Can be one of: `read` or `write`. * @enum {string} */ - deployments?: "read" | "write"; + deployments?: 'read' | 'write' /** * @description The level of permission to grant the access token for managing repository environments. Can be one of: `read` or `write`. * @enum {string} */ - environments?: "read" | "write"; + environments?: 'read' | 'write' /** * @description The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones. Can be one of: `read` or `write`. * @enum {string} */ - issues?: "read" | "write"; + issues?: 'read' | 'write' /** * @description The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata. Can be one of: `read` or `write`. * @enum {string} */ - metadata?: "read" | "write"; + metadata?: 'read' | 'write' /** * @description The level of permission to grant the access token for packages published to GitHub Packages. Can be one of: `read` or `write`. * @enum {string} */ - packages?: "read" | "write"; + packages?: 'read' | 'write' /** * @description The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds. Can be one of: `read` or `write`. * @enum {string} */ - pages?: "read" | "write"; + pages?: 'read' | 'write' /** * @description The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges. Can be one of: `read` or `write`. * @enum {string} */ - pull_requests?: "read" | "write"; + pull_requests?: 'read' | 'write' /** * @description The level of permission to grant the access token to manage the post-receive hooks for a repository. Can be one of: `read` or `write`. * @enum {string} */ - repository_hooks?: "read" | "write"; + repository_hooks?: 'read' | 'write' /** * @description The level of permission to grant the access token to manage repository projects, columns, and cards. Can be one of: `read`, `write`, or `admin`. * @enum {string} */ - repository_projects?: "read" | "write" | "admin"; + repository_projects?: 'read' | 'write' | 'admin' /** * @description The level of permission to grant the access token to view and manage secret scanning alerts. Can be one of: `read` or `write`. * @enum {string} */ - secret_scanning_alerts?: "read" | "write"; + secret_scanning_alerts?: 'read' | 'write' /** * @description The level of permission to grant the access token to manage repository secrets. Can be one of: `read` or `write`. * @enum {string} */ - secrets?: "read" | "write"; + secrets?: 'read' | 'write' /** * @description The level of permission to grant the access token to view and manage security events like code scanning alerts. Can be one of: `read` or `write`. * @enum {string} */ - security_events?: "read" | "write"; + security_events?: 'read' | 'write' /** * @description The level of permission to grant the access token to manage just a single file. Can be one of: `read` or `write`. * @enum {string} */ - single_file?: "read" | "write"; + single_file?: 'read' | 'write' /** * @description The level of permission to grant the access token for commit statuses. Can be one of: `read` or `write`. * @enum {string} */ - statuses?: "read" | "write"; + statuses?: 'read' | 'write' /** * @description The level of permission to grant the access token to manage Dependabot alerts. Can be one of: `read` or `write`. * @enum {string} */ - vulnerability_alerts?: "read" | "write"; + vulnerability_alerts?: 'read' | 'write' /** * @description The level of permission to grant the access token to update GitHub Actions workflow files. Can be one of: `write`. * @enum {string} */ - workflows?: "write"; + workflows?: 'write' /** * @description The level of permission to grant the access token for organization teams and members. Can be one of: `read` or `write`. * @enum {string} */ - members?: "read" | "write"; + members?: 'read' | 'write' /** * @description The level of permission to grant the access token to manage access to an organization. Can be one of: `read` or `write`. * @enum {string} */ - organization_administration?: "read" | "write"; + organization_administration?: 'read' | 'write' /** * @description The level of permission to grant the access token to manage the post-receive hooks for an organization. Can be one of: `read` or `write`. * @enum {string} */ - organization_hooks?: "read" | "write"; + organization_hooks?: 'read' | 'write' /** * @description The level of permission to grant the access token for viewing an organization's plan. Can be one of: `read`. * @enum {string} */ - organization_plan?: "read"; + organization_plan?: 'read' /** * @description The level of permission to grant the access token to manage organization projects and projects beta (where available). Can be one of: `read`, `write`, or `admin`. * @enum {string} */ - organization_projects?: "read" | "write" | "admin"; + organization_projects?: 'read' | 'write' | 'admin' /** * @description The level of permission to grant the access token for organization packages published to GitHub Packages. Can be one of: `read` or `write`. * @enum {string} */ - organization_packages?: "read" | "write"; + organization_packages?: 'read' | 'write' /** * @description The level of permission to grant the access token to manage organization secrets. Can be one of: `read` or `write`. * @enum {string} */ - organization_secrets?: "read" | "write"; + organization_secrets?: 'read' | 'write' /** * @description The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization. Can be one of: `read` or `write`. * @enum {string} */ - organization_self_hosted_runners?: "read" | "write"; + organization_self_hosted_runners?: 'read' | 'write' /** * @description The level of permission to grant the access token to view and manage users blocked by the organization. Can be one of: `read` or `write`. * @enum {string} */ - organization_user_blocking?: "read" | "write"; + organization_user_blocking?: 'read' | 'write' /** * @description The level of permission to grant the access token to manage team discussions and related comments. Can be one of: `read` or `write`. * @enum {string} */ - team_discussions?: "read" | "write"; - }; + team_discussions?: 'read' | 'write' + } /** * Installation * @description Installation @@ -6604,75 +6604,75 @@ export type components = { * @description The ID of the installation. * @example 1 */ - id: number; - account: (Partial & Partial) | null; + id: number + account: (Partial & Partial) | null /** * @description Describe whether all repositories have been selected or there's a selection involved * @enum {string} */ - repository_selection: "all" | "selected"; + repository_selection: 'all' | 'selected' /** * Format: uri * @example https://api.github.com/installations/1/access_tokens */ - access_tokens_url: string; + access_tokens_url: string /** * Format: uri * @example https://api.github.com/installation/repositories */ - repositories_url: string; + repositories_url: string /** * Format: uri * @example https://github.com/organizations/github/settings/installations/1 */ - html_url: string; + html_url: string /** @example 1 */ - app_id: number; + app_id: number /** @description The ID of the user or organization this token is being scoped to. */ - target_id: number; + target_id: number /** @example Organization */ - target_type: string; - permissions: components["schemas"]["app-permissions"]; - events: string[]; + target_type: string + permissions: components['schemas']['app-permissions'] + events: string[] /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; + updated_at: string /** @example config.yaml */ - single_file_name: string | null; + single_file_name: string | null /** @example true */ - has_multiple_single_files?: boolean; + has_multiple_single_files?: boolean /** @example config.yml,.github/issue_TEMPLATE.md */ - single_file_paths?: string[]; + single_file_paths?: string[] /** @example github-actions */ - app_slug: string; - suspended_by: components["schemas"]["nullable-simple-user"]; + app_slug: string + suspended_by: components['schemas']['nullable-simple-user'] /** Format: date-time */ - suspended_at: string | null; + suspended_at: string | null /** @example "test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com" */ - contact_email?: string | null; - }; + contact_email?: string | null + } /** * License Simple * @description License Simple */ - "nullable-license-simple": { + 'nullable-license-simple': { /** @example mit */ - key: string; + key: string /** @example MIT License */ - name: string; + name: string /** * Format: uri * @example https://api.github.com/licenses/mit */ - url: string | null; + url: string | null /** @example MIT */ - spdx_id: string | null; + spdx_id: string | null /** @example MDc6TGljZW5zZW1pdA== */ - node_id: string; + node_id: string /** Format: uri */ - html_url?: string; - } | null; + html_url?: string + } | null /** * Repository * @description A git repository @@ -6682,503 +6682,503 @@ export type components = { * @description Unique identifier of the repository * @example 42 */ - id: number; + id: number /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - node_id: string; + node_id: string /** * @description The name of the repository. * @example Team Environment */ - name: string; + name: string /** @example octocat/Hello-World */ - full_name: string; - license: components["schemas"]["nullable-license-simple"]; - organization?: components["schemas"]["nullable-simple-user"]; - forks: number; + full_name: string + license: components['schemas']['nullable-license-simple'] + organization?: components['schemas']['nullable-simple-user'] + forks: number permissions?: { - admin: boolean; - pull: boolean; - triage?: boolean; - push: boolean; - maintain?: boolean; - }; - owner: components["schemas"]["simple-user"]; + admin: boolean + pull: boolean + triage?: boolean + push: boolean + maintain?: boolean + } + owner: components['schemas']['simple-user'] /** @description Whether the repository is private or public. */ - private: boolean; + private: boolean /** * Format: uri * @example https://github.com/octocat/Hello-World */ - html_url: string; + html_url: string /** @example This your first repo! */ - description: string | null; - fork: boolean; + description: string | null + fork: boolean /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World */ - url: string; + url: string /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - archive_url: string; + archive_url: string /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - assignees_url: string; + assignees_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - blobs_url: string; + blobs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - branches_url: string; + branches_url: string /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - collaborators_url: string; + collaborators_url: string /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - comments_url: string; + comments_url: string /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - commits_url: string; + commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - compare_url: string; + compare_url: string /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - contents_url: string; + contents_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - contributors_url: string; + contributors_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - deployments_url: string; + deployments_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - downloads_url: string; + downloads_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events */ - events_url: string; + events_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ - forks_url: string; + forks_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - git_commits_url: string; + git_commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - git_refs_url: string; + git_refs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - git_tags_url: string; + git_tags_url: string /** @example git:github.com/octocat/Hello-World.git */ - git_url: string; + git_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - issue_comment_url: string; + issue_comment_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - issue_events_url: string; + issue_events_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - issues_url: string; + issues_url: string /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - keys_url: string; + keys_url: string /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - labels_url: string; + labels_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ - languages_url: string; + languages_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ - merges_url: string; + merges_url: string /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - milestones_url: string; + milestones_url: string /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - notifications_url: string; + notifications_url: string /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - pulls_url: string; + pulls_url: string /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - releases_url: string; + releases_url: string /** @example git@github.com:octocat/Hello-World.git */ - ssh_url: string; + ssh_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - stargazers_url: string; + stargazers_url: string /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - statuses_url: string; + statuses_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - subscribers_url: string; + subscribers_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - subscription_url: string; + subscription_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ - tags_url: string; + tags_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ - teams_url: string; + teams_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - trees_url: string; + trees_url: string /** @example https://github.com/octocat/Hello-World.git */ - clone_url: string; + clone_url: string /** * Format: uri * @example git:git.example.com/octocat/Hello-World */ - mirror_url: string | null; + mirror_url: string | null /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - hooks_url: string; + hooks_url: string /** * Format: uri * @example https://svn.github.com/octocat/Hello-World */ - svn_url: string; + svn_url: string /** * Format: uri * @example https://github.com */ - homepage: string | null; - language: string | null; + homepage: string | null + language: string | null /** @example 9 */ - forks_count: number; + forks_count: number /** @example 80 */ - stargazers_count: number; + stargazers_count: number /** @example 80 */ - watchers_count: number; + watchers_count: number /** @example 108 */ - size: number; + size: number /** * @description The default branch of the repository. * @example master */ - default_branch: string; - open_issues_count: number; + default_branch: string + open_issues_count: number /** * @description Whether this repository acts as a template that can be used to generate new repositories. * @example true */ - is_template?: boolean; - topics?: string[]; + is_template?: boolean + topics?: string[] /** * @description Whether issues are enabled. * @default true * @example true */ - has_issues: boolean; + has_issues: boolean /** * @description Whether projects are enabled. * @default true * @example true */ - has_projects: boolean; + has_projects: boolean /** * @description Whether the wiki is enabled. * @default true * @example true */ - has_wiki: boolean; - has_pages: boolean; + has_wiki: boolean + has_pages: boolean /** * @description Whether downloads are enabled. * @default true * @example true */ - has_downloads: boolean; + has_downloads: boolean /** @description Whether the repository is archived. */ - archived: boolean; + archived: boolean /** @description Returns whether or not this repository disabled. */ - disabled: boolean; + disabled: boolean /** * @description The repository visibility: public, private, or internal. * @default public */ - visibility?: string; + visibility?: string /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - pushed_at: string | null; + pushed_at: string | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - created_at: string | null; + created_at: string | null /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - updated_at: string | null; + updated_at: string | null /** * @description Whether to allow rebase merges for pull requests. * @default true * @example true */ - allow_rebase_merge?: boolean; + allow_rebase_merge?: boolean template_repository?: { - id?: number; - node_id?: string; - name?: string; - full_name?: string; + id?: number + node_id?: string + name?: string + full_name?: string owner?: { - login?: string; - id?: number; - node_id?: string; - avatar_url?: string; - gravatar_id?: string; - url?: string; - html_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - starred_url?: string; - subscriptions_url?: string; - organizations_url?: string; - repos_url?: string; - events_url?: string; - received_events_url?: string; - type?: string; - site_admin?: boolean; - }; - private?: boolean; - html_url?: string; - description?: string; - fork?: boolean; - url?: string; - archive_url?: string; - assignees_url?: string; - blobs_url?: string; - branches_url?: string; - collaborators_url?: string; - comments_url?: string; - commits_url?: string; - compare_url?: string; - contents_url?: string; - contributors_url?: string; - deployments_url?: string; - downloads_url?: string; - events_url?: string; - forks_url?: string; - git_commits_url?: string; - git_refs_url?: string; - git_tags_url?: string; - git_url?: string; - issue_comment_url?: string; - issue_events_url?: string; - issues_url?: string; - keys_url?: string; - labels_url?: string; - languages_url?: string; - merges_url?: string; - milestones_url?: string; - notifications_url?: string; - pulls_url?: string; - releases_url?: string; - ssh_url?: string; - stargazers_url?: string; - statuses_url?: string; - subscribers_url?: string; - subscription_url?: string; - tags_url?: string; - teams_url?: string; - trees_url?: string; - clone_url?: string; - mirror_url?: string; - hooks_url?: string; - svn_url?: string; - homepage?: string; - language?: string; - forks_count?: number; - stargazers_count?: number; - watchers_count?: number; - size?: number; - default_branch?: string; - open_issues_count?: number; - is_template?: boolean; - topics?: string[]; - has_issues?: boolean; - has_projects?: boolean; - has_wiki?: boolean; - has_pages?: boolean; - has_downloads?: boolean; - archived?: boolean; - disabled?: boolean; - visibility?: string; - pushed_at?: string; - created_at?: string; - updated_at?: string; + login?: string + id?: number + node_id?: string + avatar_url?: string + gravatar_id?: string + url?: string + html_url?: string + followers_url?: string + following_url?: string + gists_url?: string + starred_url?: string + subscriptions_url?: string + organizations_url?: string + repos_url?: string + events_url?: string + received_events_url?: string + type?: string + site_admin?: boolean + } + private?: boolean + html_url?: string + description?: string + fork?: boolean + url?: string + archive_url?: string + assignees_url?: string + blobs_url?: string + branches_url?: string + collaborators_url?: string + comments_url?: string + commits_url?: string + compare_url?: string + contents_url?: string + contributors_url?: string + deployments_url?: string + downloads_url?: string + events_url?: string + forks_url?: string + git_commits_url?: string + git_refs_url?: string + git_tags_url?: string + git_url?: string + issue_comment_url?: string + issue_events_url?: string + issues_url?: string + keys_url?: string + labels_url?: string + languages_url?: string + merges_url?: string + milestones_url?: string + notifications_url?: string + pulls_url?: string + releases_url?: string + ssh_url?: string + stargazers_url?: string + statuses_url?: string + subscribers_url?: string + subscription_url?: string + tags_url?: string + teams_url?: string + trees_url?: string + clone_url?: string + mirror_url?: string + hooks_url?: string + svn_url?: string + homepage?: string + language?: string + forks_count?: number + stargazers_count?: number + watchers_count?: number + size?: number + default_branch?: string + open_issues_count?: number + is_template?: boolean + topics?: string[] + has_issues?: boolean + has_projects?: boolean + has_wiki?: boolean + has_pages?: boolean + has_downloads?: boolean + archived?: boolean + disabled?: boolean + visibility?: string + pushed_at?: string + created_at?: string + updated_at?: string permissions?: { - admin?: boolean; - maintain?: boolean; - push?: boolean; - triage?: boolean; - pull?: boolean; - }; - allow_rebase_merge?: boolean; - temp_clone_token?: string; - allow_squash_merge?: boolean; - allow_auto_merge?: boolean; - delete_branch_on_merge?: boolean; - allow_update_branch?: boolean; - allow_merge_commit?: boolean; - subscribers_count?: number; - network_count?: number; - } | null; - temp_clone_token?: string; + admin?: boolean + maintain?: boolean + push?: boolean + triage?: boolean + pull?: boolean + } + allow_rebase_merge?: boolean + temp_clone_token?: string + allow_squash_merge?: boolean + allow_auto_merge?: boolean + delete_branch_on_merge?: boolean + allow_update_branch?: boolean + allow_merge_commit?: boolean + subscribers_count?: number + network_count?: number + } | null + temp_clone_token?: string /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - allow_squash_merge?: boolean; + allow_squash_merge?: boolean /** @description Whether to allow Auto-merge to be used on pull requests. */ - allow_auto_merge?: boolean; + allow_auto_merge?: boolean /** @description Whether to delete head branches when pull requests are merged */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge?: boolean /** * @description Whether to allow merge commits for pull requests. * @default true * @example true */ - allow_merge_commit?: boolean; + allow_merge_commit?: boolean /** @description Whether to allow forking this repo */ - allow_forking?: boolean; - subscribers_count?: number; - network_count?: number; - open_issues: number; - watchers: number; - master_branch?: string; + allow_forking?: boolean + subscribers_count?: number + network_count?: number + open_issues: number + watchers: number + master_branch?: string /** @example "2020-07-09T00:17:42Z" */ - starred_at?: string; - }; + starred_at?: string + } /** * Installation Token * @description Authentication token for a GitHub App installed on a user or org. */ - "installation-token": { - token: string; - expires_at: string; - permissions?: components["schemas"]["app-permissions"]; + 'installation-token': { + token: string + expires_at: string + permissions?: components['schemas']['app-permissions'] /** @enum {string} */ - repository_selection?: "all" | "selected"; - repositories?: components["schemas"]["repository"][]; + repository_selection?: 'all' | 'selected' + repositories?: components['schemas']['repository'][] /** @example README.md */ - single_file?: string; + single_file?: string /** @example true */ - has_multiple_single_files?: boolean; + has_multiple_single_files?: boolean /** @example config.yml,.github/issue_TEMPLATE.md */ - single_file_paths?: string[]; - }; + single_file_paths?: string[] + } /** * Application Grant * @description The authorization associated with an OAuth Access. */ - "application-grant": { + 'application-grant': { /** @example 1 */ - id: number; + id: number /** * Format: uri * @example https://api.github.com/applications/grants/1 */ - url: string; + url: string app: { - client_id: string; - name: string; + client_id: string + name: string /** Format: uri */ - url: string; - }; + url: string + } /** * Format: date-time * @example 2011-09-06T17:26:27Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2011-09-06T20:39:23Z */ - updated_at: string; + updated_at: string /** @example public_repo */ - scopes: string[]; - user?: components["schemas"]["nullable-simple-user"]; - }; + scopes: string[] + user?: components['schemas']['nullable-simple-user'] + } /** Scoped Installation */ - "nullable-scoped-installation": { - permissions: components["schemas"]["app-permissions"]; + 'nullable-scoped-installation': { + permissions: components['schemas']['app-permissions'] /** * @description Describe whether all repositories have been selected or there's a selection involved * @enum {string} */ - repository_selection: "all" | "selected"; + repository_selection: 'all' | 'selected' /** @example config.yaml */ - single_file_name: string | null; + single_file_name: string | null /** @example true */ - has_multiple_single_files?: boolean; + has_multiple_single_files?: boolean /** @example config.yml,.github/issue_TEMPLATE.md */ - single_file_paths?: string[]; + single_file_paths?: string[] /** * Format: uri * @example https://api.github.com/users/octocat/repos */ - repositories_url: string; - account: components["schemas"]["simple-user"]; - } | null; + repositories_url: string + account: components['schemas']['simple-user'] + } | null /** * Authorization * @description The authorization for an OAuth app, GitHub App, or a Personal Access Token. */ authorization: { - id: number; + id: number /** Format: uri */ - url: string; + url: string /** @description A list of scopes that this authorization is in. */ - scopes: string[] | null; - token: string; - token_last_eight: string | null; - hashed_token: string | null; + scopes: string[] | null + token: string + token_last_eight: string | null + hashed_token: string | null app: { - client_id: string; - name: string; + client_id: string + name: string /** Format: uri */ - url: string; - }; - note: string | null; + url: string + } + note: string | null /** Format: uri */ - note_url: string | null; + note_url: string | null /** Format: date-time */ - updated_at: string; + updated_at: string /** Format: date-time */ - created_at: string; - fingerprint: string | null; - user?: components["schemas"]["nullable-simple-user"]; - installation?: components["schemas"]["nullable-scoped-installation"]; + created_at: string + fingerprint: string | null + user?: components['schemas']['nullable-simple-user'] + installation?: components['schemas']['nullable-scoped-installation'] /** Format: date-time */ - expires_at: string | null; - }; + expires_at: string | null + } /** * Code Of Conduct * @description Code Of Conduct */ - "code-of-conduct": { + 'code-of-conduct': { /** @example contributor_covenant */ - key: string; + key: string /** @example Contributor Covenant */ - name: string; + name: string /** * Format: uri * @example https://api.github.com/codes_of_conduct/contributor_covenant */ - url: string; + url: string /** * @example # Contributor Covenant Code of Conduct * @@ -7229,100 +7229,100 @@ export type components = { * [homepage]: http://contributor-covenant.org * [version]: http://contributor-covenant.org/version/1/4/ */ - body?: string; + body?: string /** Format: uri */ - html_url: string | null; - }; + html_url: string | null + } /** * @description The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`. * @enum {string} */ - "enabled-organizations": "all" | "none" | "selected"; + 'enabled-organizations': 'all' | 'none' | 'selected' /** * @description The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`. * @enum {string} */ - "allowed-actions": "all" | "local_only" | "selected"; + 'allowed-actions': 'all' | 'local_only' | 'selected' /** @description The API URL to use to get or set the actions that are allowed to run, when `allowed_actions` is set to `selected`. */ - "selected-actions-url": string; - "actions-enterprise-permissions": { - enabled_organizations: components["schemas"]["enabled-organizations"]; + 'selected-actions-url': string + 'actions-enterprise-permissions': { + enabled_organizations: components['schemas']['enabled-organizations'] /** @description The API URL to use to get or set the selected organizations that are allowed to run GitHub Actions, when `enabled_organizations` is set to `selected`. */ - selected_organizations_url?: string; - allowed_actions?: components["schemas"]["allowed-actions"]; - selected_actions_url?: components["schemas"]["selected-actions-url"]; - }; + selected_organizations_url?: string + allowed_actions?: components['schemas']['allowed-actions'] + selected_actions_url?: components['schemas']['selected-actions-url'] + } /** * Organization Simple * @description Organization Simple */ - "organization-simple": { + 'organization-simple': { /** @example github */ - login: string; + login: string /** @example 1 */ - id: number; + id: number /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ - node_id: string; + node_id: string /** * Format: uri * @example https://api.github.com/orgs/github */ - url: string; + url: string /** * Format: uri * @example https://api.github.com/orgs/github/repos */ - repos_url: string; + repos_url: string /** * Format: uri * @example https://api.github.com/orgs/github/events */ - events_url: string; + events_url: string /** @example https://api.github.com/orgs/github/hooks */ - hooks_url: string; + hooks_url: string /** @example https://api.github.com/orgs/github/issues */ - issues_url: string; + issues_url: string /** @example https://api.github.com/orgs/github/members{/member} */ - members_url: string; + members_url: string /** @example https://api.github.com/orgs/github/public_members{/member} */ - public_members_url: string; + public_members_url: string /** @example https://github.com/images/error/octocat_happy.gif */ - avatar_url: string; + avatar_url: string /** @example A great organization */ - description: string | null; - }; - "selected-actions": { + description: string | null + } + 'selected-actions': { /** @description Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization. */ - github_owned_allowed?: boolean; + github_owned_allowed?: boolean /** @description Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators. */ - verified_allowed?: boolean; + verified_allowed?: boolean /** @description Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`." */ - patterns_allowed?: string[]; - }; - "runner-groups-enterprise": { - id: number; - name: string; - visibility: string; - default: boolean; - selected_organizations_url?: string; - runners_url: string; - allows_public_repositories: boolean; - }; + patterns_allowed?: string[] + } + 'runner-groups-enterprise': { + id: number + name: string + visibility: string + default: boolean + selected_organizations_url?: string + runners_url: string + allows_public_repositories: boolean + } /** * Self hosted runner label * @description A label for a self hosted runner */ - "runner-label": { + 'runner-label': { /** @description Unique identifier of the label. */ - id?: number; + id?: number /** @description Name of the label. */ - name: string; + name: string /** * @description The type of label. Read-only labels are applied automatically when the runner is configured. * @enum {string} */ - type?: "read-only" | "custom"; - }; + type?: 'read-only' | 'custom' + } /** * Self hosted runners * @description A self hosted runner @@ -7332,1046 +7332,1038 @@ export type components = { * @description The id of the runner. * @example 5 */ - id: number; + id: number /** * @description The name of the runner. * @example iMac */ - name: string; + name: string /** * @description The Operating System of the runner. * @example macos */ - os: string; + os: string /** * @description The status of the runner. * @example online */ - status: string; - busy: boolean; - labels: components["schemas"]["runner-label"][]; - }; + status: string + busy: boolean + labels: components['schemas']['runner-label'][] + } /** * Runner Application * @description Runner Application */ - "runner-application": { - os: string; - architecture: string; - download_url: string; - filename: string; + 'runner-application': { + os: string + architecture: string + download_url: string + filename: string /** @description A short lived bearer token used to download the runner, if needed. */ - temp_download_token?: string; - sha256_checksum?: string; - }; + temp_download_token?: string + sha256_checksum?: string + } /** * Authentication Token * @description Authentication Token */ - "authentication-token": { + 'authentication-token': { /** * @description The token used for authentication * @example v1.1f699f1069f60xxx */ - token: string; + token: string /** * Format: date-time * @description The time this token expires * @example 2016-07-11T22:14:10Z */ - expires_at: string; + expires_at: string /** @example [object Object] */ - permissions?: { [key: string]: unknown }; + permissions?: { [key: string]: unknown } /** @description The repositories this token has access to */ - repositories?: components["schemas"]["repository"][]; + repositories?: components['schemas']['repository'][] /** @example config.yaml */ - single_file?: string | null; + single_file?: string | null /** * @description Describe whether all repositories have been selected or there's a selection involved * @enum {string} */ - repository_selection?: "all" | "selected"; - }; - "audit-log-event": { + repository_selection?: 'all' | 'selected' + } + 'audit-log-event': { /** @description The time the audit log event occurred, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time). */ - "@timestamp"?: number; + '@timestamp'?: number /** @description The name of the action that was performed, for example `user.login` or `repo.create`. */ - action?: string; - active?: boolean; - active_was?: boolean; + action?: string + active?: boolean + active_was?: boolean /** @description The actor who performed the action. */ - actor?: string; + actor?: string /** @description The id of the actor who performed the action. */ - actor_id?: number; + actor_id?: number actor_location?: { - country_name?: string; - }; - data?: { [key: string]: unknown }; - org_id?: number; + country_name?: string + } + data?: { [key: string]: unknown } + org_id?: number /** @description The username of the account being blocked. */ - blocked_user?: string; - business?: string; - config?: { [key: string]: unknown }[]; - config_was?: { [key: string]: unknown }[]; - content_type?: string; + blocked_user?: string + business?: string + config?: { [key: string]: unknown }[] + config_was?: { [key: string]: unknown }[] + content_type?: string /** @description The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time). */ - created_at?: number; - deploy_key_fingerprint?: string; + created_at?: number + deploy_key_fingerprint?: string /** @description A unique identifier for an audit event. */ - _document_id?: string; - emoji?: string; - events?: { [key: string]: unknown }[]; - events_were?: { [key: string]: unknown }[]; - explanation?: string; - fingerprint?: string; - hook_id?: number; - limited_availability?: boolean; - message?: string; - name?: string; - old_user?: string; - openssh_public_key?: string; - org?: string; - previous_visibility?: string; - read_only?: boolean; + _document_id?: string + emoji?: string + events?: { [key: string]: unknown }[] + events_were?: { [key: string]: unknown }[] + explanation?: string + fingerprint?: string + hook_id?: number + limited_availability?: boolean + message?: string + name?: string + old_user?: string + openssh_public_key?: string + org?: string + previous_visibility?: string + read_only?: boolean /** @description The name of the repository. */ - repo?: string; + repo?: string /** @description The name of the repository. */ - repository?: string; - repository_public?: boolean; - target_login?: string; - team?: string; + repository?: string + repository_public?: boolean + target_login?: string + team?: string /** @description The type of protocol (for example, HTTP or SSH) used to transfer Git data. */ - transport_protocol?: number; + transport_protocol?: number /** @description A human readable name for the protocol (for example, HTTP or SSH) used to transfer Git data. */ - transport_protocol_name?: string; + transport_protocol_name?: string /** @description The user that was affected by the action performed (if available). */ - user?: string; + user?: string /** @description The repository visibility, for example `public` or `private`. */ - visibility?: string; - }; + visibility?: string + } /** @description The security alert number. */ - "alert-number": number; + 'alert-number': number /** * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "alert-created-at": string; + 'alert-created-at': string /** * Format: uri * @description The REST API URL of the alert resource. */ - "alert-url": string; + 'alert-url': string /** * Format: uri * @description The GitHub URL of the alert resource. */ - "alert-html-url": string; + 'alert-html-url': string /** * @description Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`. * @enum {string} */ - "secret-scanning-alert-state": "open" | "resolved"; + 'secret-scanning-alert-state': 'open' | 'resolved' /** * @description **Required when the `state` is `resolved`.** The reason for resolving the alert. Can be one of `false_positive`, `wont_fix`, `revoked`, or `used_in_tests`. * @enum {string|null} */ - "secret-scanning-alert-resolution": (null | "false_positive" | "wont_fix" | "revoked" | "used_in_tests") | null; + 'secret-scanning-alert-resolution': (null | 'false_positive' | 'wont_fix' | 'revoked' | 'used_in_tests') | null /** * Repository * @description A git repository */ - "nullable-repository": { + 'nullable-repository': { /** * @description Unique identifier of the repository * @example 42 */ - id: number; + id: number /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - node_id: string; + node_id: string /** * @description The name of the repository. * @example Team Environment */ - name: string; + name: string /** @example octocat/Hello-World */ - full_name: string; - license: components["schemas"]["nullable-license-simple"]; - organization?: components["schemas"]["nullable-simple-user"]; - forks: number; + full_name: string + license: components['schemas']['nullable-license-simple'] + organization?: components['schemas']['nullable-simple-user'] + forks: number permissions?: { - admin: boolean; - pull: boolean; - triage?: boolean; - push: boolean; - maintain?: boolean; - }; - owner: components["schemas"]["simple-user"]; + admin: boolean + pull: boolean + triage?: boolean + push: boolean + maintain?: boolean + } + owner: components['schemas']['simple-user'] /** @description Whether the repository is private or public. */ - private: boolean; + private: boolean /** * Format: uri * @example https://github.com/octocat/Hello-World */ - html_url: string; + html_url: string /** @example This your first repo! */ - description: string | null; - fork: boolean; + description: string | null + fork: boolean /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World */ - url: string; + url: string /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - archive_url: string; + archive_url: string /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - assignees_url: string; + assignees_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - blobs_url: string; + blobs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - branches_url: string; + branches_url: string /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - collaborators_url: string; + collaborators_url: string /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - comments_url: string; + comments_url: string /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - commits_url: string; + commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - compare_url: string; + compare_url: string /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - contents_url: string; + contents_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - contributors_url: string; + contributors_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - deployments_url: string; + deployments_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - downloads_url: string; + downloads_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events */ - events_url: string; + events_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ - forks_url: string; + forks_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - git_commits_url: string; + git_commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - git_refs_url: string; + git_refs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - git_tags_url: string; + git_tags_url: string /** @example git:github.com/octocat/Hello-World.git */ - git_url: string; + git_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - issue_comment_url: string; + issue_comment_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - issue_events_url: string; + issue_events_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - issues_url: string; + issues_url: string /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - keys_url: string; + keys_url: string /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - labels_url: string; + labels_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ - languages_url: string; + languages_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ - merges_url: string; + merges_url: string /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - milestones_url: string; + milestones_url: string /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - notifications_url: string; + notifications_url: string /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - pulls_url: string; + pulls_url: string /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - releases_url: string; + releases_url: string /** @example git@github.com:octocat/Hello-World.git */ - ssh_url: string; + ssh_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - stargazers_url: string; + stargazers_url: string /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - statuses_url: string; + statuses_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - subscribers_url: string; + subscribers_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - subscription_url: string; + subscription_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ - tags_url: string; + tags_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ - teams_url: string; + teams_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - trees_url: string; + trees_url: string /** @example https://github.com/octocat/Hello-World.git */ - clone_url: string; + clone_url: string /** * Format: uri * @example git:git.example.com/octocat/Hello-World */ - mirror_url: string | null; + mirror_url: string | null /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - hooks_url: string; + hooks_url: string /** * Format: uri * @example https://svn.github.com/octocat/Hello-World */ - svn_url: string; + svn_url: string /** * Format: uri * @example https://github.com */ - homepage: string | null; - language: string | null; + homepage: string | null + language: string | null /** @example 9 */ - forks_count: number; + forks_count: number /** @example 80 */ - stargazers_count: number; + stargazers_count: number /** @example 80 */ - watchers_count: number; + watchers_count: number /** @example 108 */ - size: number; + size: number /** * @description The default branch of the repository. * @example master */ - default_branch: string; - open_issues_count: number; + default_branch: string + open_issues_count: number /** * @description Whether this repository acts as a template that can be used to generate new repositories. * @example true */ - is_template?: boolean; - topics?: string[]; + is_template?: boolean + topics?: string[] /** * @description Whether issues are enabled. * @default true * @example true */ - has_issues: boolean; + has_issues: boolean /** * @description Whether projects are enabled. * @default true * @example true */ - has_projects: boolean; + has_projects: boolean /** * @description Whether the wiki is enabled. * @default true * @example true */ - has_wiki: boolean; - has_pages: boolean; + has_wiki: boolean + has_pages: boolean /** * @description Whether downloads are enabled. * @default true * @example true */ - has_downloads: boolean; + has_downloads: boolean /** @description Whether the repository is archived. */ - archived: boolean; + archived: boolean /** @description Returns whether or not this repository disabled. */ - disabled: boolean; + disabled: boolean /** * @description The repository visibility: public, private, or internal. * @default public */ - visibility?: string; + visibility?: string /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - pushed_at: string | null; + pushed_at: string | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - created_at: string | null; + created_at: string | null /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - updated_at: string | null; + updated_at: string | null /** * @description Whether to allow rebase merges for pull requests. * @default true * @example true */ - allow_rebase_merge?: boolean; + allow_rebase_merge?: boolean template_repository?: { - id?: number; - node_id?: string; - name?: string; - full_name?: string; + id?: number + node_id?: string + name?: string + full_name?: string owner?: { - login?: string; - id?: number; - node_id?: string; - avatar_url?: string; - gravatar_id?: string; - url?: string; - html_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - starred_url?: string; - subscriptions_url?: string; - organizations_url?: string; - repos_url?: string; - events_url?: string; - received_events_url?: string; - type?: string; - site_admin?: boolean; - }; - private?: boolean; - html_url?: string; - description?: string; - fork?: boolean; - url?: string; - archive_url?: string; - assignees_url?: string; - blobs_url?: string; - branches_url?: string; - collaborators_url?: string; - comments_url?: string; - commits_url?: string; - compare_url?: string; - contents_url?: string; - contributors_url?: string; - deployments_url?: string; - downloads_url?: string; - events_url?: string; - forks_url?: string; - git_commits_url?: string; - git_refs_url?: string; - git_tags_url?: string; - git_url?: string; - issue_comment_url?: string; - issue_events_url?: string; - issues_url?: string; - keys_url?: string; - labels_url?: string; - languages_url?: string; - merges_url?: string; - milestones_url?: string; - notifications_url?: string; - pulls_url?: string; - releases_url?: string; - ssh_url?: string; - stargazers_url?: string; - statuses_url?: string; - subscribers_url?: string; - subscription_url?: string; - tags_url?: string; - teams_url?: string; - trees_url?: string; - clone_url?: string; - mirror_url?: string; - hooks_url?: string; - svn_url?: string; - homepage?: string; - language?: string; - forks_count?: number; - stargazers_count?: number; - watchers_count?: number; - size?: number; - default_branch?: string; - open_issues_count?: number; - is_template?: boolean; - topics?: string[]; - has_issues?: boolean; - has_projects?: boolean; - has_wiki?: boolean; - has_pages?: boolean; - has_downloads?: boolean; - archived?: boolean; - disabled?: boolean; - visibility?: string; - pushed_at?: string; - created_at?: string; - updated_at?: string; + login?: string + id?: number + node_id?: string + avatar_url?: string + gravatar_id?: string + url?: string + html_url?: string + followers_url?: string + following_url?: string + gists_url?: string + starred_url?: string + subscriptions_url?: string + organizations_url?: string + repos_url?: string + events_url?: string + received_events_url?: string + type?: string + site_admin?: boolean + } + private?: boolean + html_url?: string + description?: string + fork?: boolean + url?: string + archive_url?: string + assignees_url?: string + blobs_url?: string + branches_url?: string + collaborators_url?: string + comments_url?: string + commits_url?: string + compare_url?: string + contents_url?: string + contributors_url?: string + deployments_url?: string + downloads_url?: string + events_url?: string + forks_url?: string + git_commits_url?: string + git_refs_url?: string + git_tags_url?: string + git_url?: string + issue_comment_url?: string + issue_events_url?: string + issues_url?: string + keys_url?: string + labels_url?: string + languages_url?: string + merges_url?: string + milestones_url?: string + notifications_url?: string + pulls_url?: string + releases_url?: string + ssh_url?: string + stargazers_url?: string + statuses_url?: string + subscribers_url?: string + subscription_url?: string + tags_url?: string + teams_url?: string + trees_url?: string + clone_url?: string + mirror_url?: string + hooks_url?: string + svn_url?: string + homepage?: string + language?: string + forks_count?: number + stargazers_count?: number + watchers_count?: number + size?: number + default_branch?: string + open_issues_count?: number + is_template?: boolean + topics?: string[] + has_issues?: boolean + has_projects?: boolean + has_wiki?: boolean + has_pages?: boolean + has_downloads?: boolean + archived?: boolean + disabled?: boolean + visibility?: string + pushed_at?: string + created_at?: string + updated_at?: string permissions?: { - admin?: boolean; - maintain?: boolean; - push?: boolean; - triage?: boolean; - pull?: boolean; - }; - allow_rebase_merge?: boolean; - temp_clone_token?: string; - allow_squash_merge?: boolean; - allow_auto_merge?: boolean; - delete_branch_on_merge?: boolean; - allow_update_branch?: boolean; - allow_merge_commit?: boolean; - subscribers_count?: number; - network_count?: number; - } | null; - temp_clone_token?: string; + admin?: boolean + maintain?: boolean + push?: boolean + triage?: boolean + pull?: boolean + } + allow_rebase_merge?: boolean + temp_clone_token?: string + allow_squash_merge?: boolean + allow_auto_merge?: boolean + delete_branch_on_merge?: boolean + allow_update_branch?: boolean + allow_merge_commit?: boolean + subscribers_count?: number + network_count?: number + } | null + temp_clone_token?: string /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - allow_squash_merge?: boolean; + allow_squash_merge?: boolean /** @description Whether to allow Auto-merge to be used on pull requests. */ - allow_auto_merge?: boolean; + allow_auto_merge?: boolean /** @description Whether to delete head branches when pull requests are merged */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge?: boolean /** * @description Whether to allow merge commits for pull requests. * @default true * @example true */ - allow_merge_commit?: boolean; + allow_merge_commit?: boolean /** @description Whether to allow forking this repo */ - allow_forking?: boolean; - subscribers_count?: number; - network_count?: number; - open_issues: number; - watchers: number; - master_branch?: string; + allow_forking?: boolean + subscribers_count?: number + network_count?: number + open_issues: number + watchers: number + master_branch?: string /** @example "2020-07-09T00:17:42Z" */ - starred_at?: string; - } | null; + starred_at?: string + } | null /** * Minimal Repository * @description Minimal Repository */ - "minimal-repository": { + 'minimal-repository': { /** @example 1296269 */ - id: number; + id: number /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - node_id: string; + node_id: string /** @example Hello-World */ - name: string; + name: string /** @example octocat/Hello-World */ - full_name: string; - owner: components["schemas"]["simple-user"]; - private: boolean; + full_name: string + owner: components['schemas']['simple-user'] + private: boolean /** * Format: uri * @example https://github.com/octocat/Hello-World */ - html_url: string; + html_url: string /** @example This your first repo! */ - description: string | null; - fork: boolean; + description: string | null + fork: boolean /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World */ - url: string; + url: string /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - archive_url: string; + archive_url: string /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - assignees_url: string; + assignees_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - blobs_url: string; + blobs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - branches_url: string; + branches_url: string /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - collaborators_url: string; + collaborators_url: string /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - comments_url: string; + comments_url: string /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - commits_url: string; + commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - compare_url: string; + compare_url: string /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - contents_url: string; + contents_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - contributors_url: string; + contributors_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - deployments_url: string; + deployments_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - downloads_url: string; + downloads_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events */ - events_url: string; + events_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ - forks_url: string; + forks_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - git_commits_url: string; + git_commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - git_refs_url: string; + git_refs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - git_tags_url: string; - git_url?: string; + git_tags_url: string + git_url?: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - issue_comment_url: string; + issue_comment_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - issue_events_url: string; + issue_events_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - issues_url: string; + issues_url: string /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - keys_url: string; + keys_url: string /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - labels_url: string; + labels_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ - languages_url: string; + languages_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ - merges_url: string; + merges_url: string /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - milestones_url: string; + milestones_url: string /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - notifications_url: string; + notifications_url: string /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - pulls_url: string; + pulls_url: string /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - releases_url: string; - ssh_url?: string; + releases_url: string + ssh_url?: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - stargazers_url: string; + stargazers_url: string /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - statuses_url: string; + statuses_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - subscribers_url: string; + subscribers_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - subscription_url: string; + subscription_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ - tags_url: string; + tags_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ - teams_url: string; + teams_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - trees_url: string; - clone_url?: string; - mirror_url?: string | null; + trees_url: string + clone_url?: string + mirror_url?: string | null /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - hooks_url: string; - svn_url?: string; - homepage?: string | null; - language?: string | null; - forks_count?: number; - stargazers_count?: number; - watchers_count?: number; - size?: number; - default_branch?: string; - open_issues_count?: number; - is_template?: boolean; - topics?: string[]; - has_issues?: boolean; - has_projects?: boolean; - has_wiki?: boolean; - has_pages?: boolean; - has_downloads?: boolean; - archived?: boolean; - disabled?: boolean; - visibility?: string; + hooks_url: string + svn_url?: string + homepage?: string | null + language?: string | null + forks_count?: number + stargazers_count?: number + watchers_count?: number + size?: number + default_branch?: string + open_issues_count?: number + is_template?: boolean + topics?: string[] + has_issues?: boolean + has_projects?: boolean + has_wiki?: boolean + has_pages?: boolean + has_downloads?: boolean + archived?: boolean + disabled?: boolean + visibility?: string /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - pushed_at?: string | null; + pushed_at?: string | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - created_at?: string | null; + created_at?: string | null /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - updated_at?: string | null; + updated_at?: string | null permissions?: { - admin?: boolean; - maintain?: boolean; - push?: boolean; - triage?: boolean; - pull?: boolean; - }; + admin?: boolean + maintain?: boolean + push?: boolean + triage?: boolean + pull?: boolean + } /** @example admin */ - role_name?: string; - template_repository?: components["schemas"]["nullable-repository"]; - temp_clone_token?: string; - delete_branch_on_merge?: boolean; - subscribers_count?: number; - network_count?: number; - code_of_conduct?: components["schemas"]["code-of-conduct"]; + role_name?: string + template_repository?: components['schemas']['nullable-repository'] + temp_clone_token?: string + delete_branch_on_merge?: boolean + subscribers_count?: number + network_count?: number + code_of_conduct?: components['schemas']['code-of-conduct'] license?: { - key?: string; - name?: string; - spdx_id?: string; - url?: string; - node_id?: string; - } | null; - forks?: number; - open_issues?: number; - watchers?: number; - allow_forking?: boolean; - }; - "organization-secret-scanning-alert": { - number?: components["schemas"]["alert-number"]; - created_at?: components["schemas"]["alert-created-at"]; - url?: components["schemas"]["alert-url"]; - html_url?: components["schemas"]["alert-html-url"]; + key?: string + name?: string + spdx_id?: string + url?: string + node_id?: string + } | null + forks?: number + open_issues?: number + watchers?: number + allow_forking?: boolean + } + 'organization-secret-scanning-alert': { + number?: components['schemas']['alert-number'] + created_at?: components['schemas']['alert-created-at'] + url?: components['schemas']['alert-url'] + html_url?: components['schemas']['alert-html-url'] /** * Format: uri * @description The REST API URL of the code locations for this alert. */ - locations_url?: string; - state?: components["schemas"]["secret-scanning-alert-state"]; - resolution?: components["schemas"]["secret-scanning-alert-resolution"]; + locations_url?: string + state?: components['schemas']['secret-scanning-alert-state'] + resolution?: components['schemas']['secret-scanning-alert-resolution'] /** * Format: date-time * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - resolved_at?: string | null; - resolved_by?: components["schemas"]["nullable-simple-user"]; + resolved_at?: string | null + resolved_by?: components['schemas']['nullable-simple-user'] /** @description The type of secret that secret scanning detected. */ - secret_type?: string; + secret_type?: string /** @description The secret that was detected. */ - secret?: string; - repository?: components["schemas"]["minimal-repository"]; - }; - "actions-billing-usage": { + secret?: string + repository?: components['schemas']['minimal-repository'] + } + 'actions-billing-usage': { /** @description The sum of the free and paid GitHub Actions minutes used. */ - total_minutes_used: number; + total_minutes_used: number /** @description The total paid GitHub Actions minutes used. */ - total_paid_minutes_used: number; + total_paid_minutes_used: number /** @description The amount of free GitHub Actions minutes available. */ - included_minutes: number; + included_minutes: number minutes_used_breakdown: { /** @description Total minutes used on Ubuntu runner machines. */ - UBUNTU?: number; + UBUNTU?: number /** @description Total minutes used on macOS runner machines. */ - MACOS?: number; + MACOS?: number /** @description Total minutes used on Windows runner machines. */ - WINDOWS?: number; - }; - }; - "advanced-security-active-committers-user": { - user_login: string; + WINDOWS?: number + } + } + 'advanced-security-active-committers-user': { + user_login: string /** @example 2021-11-03 */ - last_pushed_date: string; - }; - "advanced-security-active-committers-repository": { + last_pushed_date: string + } + 'advanced-security-active-committers-repository': { /** @example octocat/Hello-World */ - name: string; + name: string /** @example 25 */ - advanced_security_committers: number; - advanced_security_committers_breakdown: components["schemas"]["advanced-security-active-committers-user"][]; - }; - "advanced-security-active-committers": { + advanced_security_committers: number + advanced_security_committers_breakdown: components['schemas']['advanced-security-active-committers-user'][] + } + 'advanced-security-active-committers': { /** @example 25 */ - total_advanced_security_committers?: number; - repositories: components["schemas"]["advanced-security-active-committers-repository"][]; - }; - "packages-billing-usage": { + total_advanced_security_committers?: number + repositories: components['schemas']['advanced-security-active-committers-repository'][] + } + 'packages-billing-usage': { /** @description Sum of the free and paid storage space (GB) for GitHuub Packages. */ - total_gigabytes_bandwidth_used: number; + total_gigabytes_bandwidth_used: number /** @description Total paid storage space (GB) for GitHuub Packages. */ - total_paid_gigabytes_bandwidth_used: number; + total_paid_gigabytes_bandwidth_used: number /** @description Free storage space (GB) for GitHub Packages. */ - included_gigabytes_bandwidth: number; - }; - "combined-billing-usage": { + included_gigabytes_bandwidth: number + } + 'combined-billing-usage': { /** @description Numbers of days left in billing cycle. */ - days_left_in_billing_cycle: number; + days_left_in_billing_cycle: number /** @description Estimated storage space (GB) used in billing cycle. */ - estimated_paid_storage_for_month: number; + estimated_paid_storage_for_month: number /** @description Estimated sum of free and paid storage space (GB) used in billing cycle. */ - estimated_storage_for_month: number; - }; + estimated_storage_for_month: number + } /** * Actor * @description Actor */ actor: { - id: number; - login: string; - display_login?: string; - gravatar_id: string | null; + id: number + login: string + display_login?: string + gravatar_id: string | null /** Format: uri */ - url: string; + url: string /** Format: uri */ - avatar_url: string; - }; + avatar_url: string + } /** * Milestone * @description A collection of related issues and pull requests. */ - "nullable-milestone": { + 'nullable-milestone': { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1 */ - url: string; + url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/milestones/v1.0 */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1/labels */ - labels_url: string; + labels_url: string /** @example 1002604 */ - id: number; + id: number /** @example MDk6TWlsZXN0b25lMTAwMjYwNA== */ - node_id: string; + node_id: string /** * @description The number of the milestone. * @example 42 */ - number: number; + number: number /** * @description The state of the milestone. * @default open * @example open * @enum {string} */ - state: "open" | "closed"; + state: 'open' | 'closed' /** * @description The title of the milestone. * @example v1.0 */ - title: string; + title: string /** @example Tracking milestone for version 1.0 */ - description: string | null; - creator: components["schemas"]["nullable-simple-user"]; + description: string | null + creator: components['schemas']['nullable-simple-user'] /** @example 4 */ - open_issues: number; + open_issues: number /** @example 8 */ - closed_issues: number; + closed_issues: number /** * Format: date-time * @example 2011-04-10T20:09:31Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2014-03-03T18:58:10Z */ - updated_at: string; + updated_at: string /** * Format: date-time * @example 2013-02-12T13:22:01Z */ - closed_at: string | null; + closed_at: string | null /** * Format: date-time * @example 2012-10-09T23:39:01Z */ - due_on: string | null; - } | null; + due_on: string | null + } | null /** * GitHub app * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - "nullable-integration": { + 'nullable-integration': { /** * @description Unique identifier of the GitHub app * @example 37 */ - id: number; + id: number /** * @description The slug name of the GitHub app * @example probot-owners */ - slug?: string; + slug?: string /** @example MDExOkludGVncmF0aW9uMQ== */ - node_id: string; - owner: components["schemas"]["nullable-simple-user"]; + node_id: string + owner: components['schemas']['nullable-simple-user'] /** * @description The name of the GitHub app * @example Probot Owners */ - name: string; + name: string /** @example The description of the app. */ - description: string | null; + description: string | null /** * Format: uri * @example https://example.com */ - external_url: string; + external_url: string /** * Format: uri * @example https://github.com/apps/super-ci */ - html_url: string; + html_url: string /** * Format: date-time * @example 2017-07-08T16:18:44-04:00 */ - created_at: string; + created_at: string /** * Format: date-time * @example 2017-07-08T16:18:44-04:00 */ - updated_at: string; + updated_at: string /** * @description The set of permissions for the GitHub app * @example [object Object] */ permissions: { - issues?: string; - checks?: string; - metadata?: string; - contents?: string; - deployments?: string; - } & { [key: string]: string }; + issues?: string + checks?: string + metadata?: string + contents?: string + deployments?: string + } & { [key: string]: string } /** * @description The list of events for the GitHub app * @example label,deployment */ - events: string[]; + events: string[] /** * @description The number of installations associated with the GitHub app * @example 5 */ - installations_count?: number; + installations_count?: number /** @example "Iv1.25b5d1e65ffc4022" */ - client_id?: string; + client_id?: string /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ - client_secret?: string; + client_secret?: string /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ - webhook_secret?: string | null; + webhook_secret?: string | null /** @example "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n" */ - pem?: string; - } | null; + pem?: string + } | null /** * author_association * @description How the author is associated with the repository. * @example OWNER * @enum {string} */ - author_association: - | "COLLABORATOR" - | "CONTRIBUTOR" - | "FIRST_TIMER" - | "FIRST_TIME_CONTRIBUTOR" - | "MANNEQUIN" - | "MEMBER" - | "NONE" - | "OWNER"; + author_association: 'COLLABORATOR' | 'CONTRIBUTOR' | 'FIRST_TIMER' | 'FIRST_TIME_CONTRIBUTOR' | 'MANNEQUIN' | 'MEMBER' | 'NONE' | 'OWNER' /** Reaction Rollup */ - "reaction-rollup": { + 'reaction-rollup': { /** Format: uri */ - url: string; - total_count: number; - "+1": number; - "-1": number; - laugh: number; - confused: number; - heart: number; - hooray: number; - eyes: number; - rocket: number; - }; + url: string + total_count: number + '+1': number + '-1': number + laugh: number + confused: number + heart: number + hooray: number + eyes: number + rocket: number + } /** * Issue * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. */ issue: { - id: number; - node_id: string; + id: number + node_id: string /** * Format: uri * @description URL for the issue * @example https://api.github.com/repositories/42/issues/1 */ - url: string; + url: string /** Format: uri */ - repository_url: string; - labels_url: string; + repository_url: string + labels_url: string /** Format: uri */ - comments_url: string; + comments_url: string /** Format: uri */ - events_url: string; + events_url: string /** Format: uri */ - html_url: string; + html_url: string /** * @description Number uniquely identifying the issue within its repository * @example 42 */ - number: number; + number: number /** * @description State of the issue; either 'open' or 'closed' * @example open */ - state: string; + state: string /** * @description Title of the issue * @example Widget creation fails in Safari on OS X 10.8 */ - title: string; + title: string /** * @description Contents of the issue * @example It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug? */ - body?: string | null; - user: components["schemas"]["nullable-simple-user"]; + body?: string | null + user: components['schemas']['nullable-simple-user'] /** * @description Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository * @example bug,registration @@ -8380,448 +8372,448 @@ export type components = { | string | { /** Format: int64 */ - id?: number; - node_id?: string; + id?: number + node_id?: string /** Format: uri */ - url?: string; - name?: string; - description?: string | null; - color?: string | null; - default?: boolean; + url?: string + name?: string + description?: string | null + color?: string | null + default?: boolean } - )[]; - assignee: components["schemas"]["nullable-simple-user"]; - assignees?: components["schemas"]["simple-user"][] | null; - milestone: components["schemas"]["nullable-milestone"]; - locked: boolean; - active_lock_reason?: string | null; - comments: number; + )[] + assignee: components['schemas']['nullable-simple-user'] + assignees?: components['schemas']['simple-user'][] | null + milestone: components['schemas']['nullable-milestone'] + locked: boolean + active_lock_reason?: string | null + comments: number pull_request?: { /** Format: date-time */ - merged_at?: string | null; + merged_at?: string | null /** Format: uri */ - diff_url: string | null; + diff_url: string | null /** Format: uri */ - html_url: string | null; + html_url: string | null /** Format: uri */ - patch_url: string | null; + patch_url: string | null /** Format: uri */ - url: string | null; - }; + url: string | null + } /** Format: date-time */ - closed_at: string | null; + closed_at: string | null /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - draft?: boolean; - closed_by?: components["schemas"]["nullable-simple-user"]; - body_html?: string; - body_text?: string; + updated_at: string + draft?: boolean + closed_by?: components['schemas']['nullable-simple-user'] + body_html?: string + body_text?: string /** Format: uri */ - timeline_url?: string; - repository?: components["schemas"]["repository"]; - performed_via_github_app?: components["schemas"]["nullable-integration"]; - author_association: components["schemas"]["author_association"]; - reactions?: components["schemas"]["reaction-rollup"]; - }; + timeline_url?: string + repository?: components['schemas']['repository'] + performed_via_github_app?: components['schemas']['nullable-integration'] + author_association: components['schemas']['author_association'] + reactions?: components['schemas']['reaction-rollup'] + } /** * Issue Comment * @description Comments provide a way for people to collaborate on an issue. */ - "issue-comment": { + 'issue-comment': { /** * @description Unique identifier of the issue comment * @example 42 */ - id: number; - node_id: string; + id: number + node_id: string /** * Format: uri * @description URL for the issue comment * @example https://api.github.com/repositories/42/issues/comments/1 */ - url: string; + url: string /** * @description Contents of the issue comment * @example What version of Safari were you using when you observed this bug? */ - body?: string; - body_text?: string; - body_html?: string; + body?: string + body_text?: string + body_html?: string /** Format: uri */ - html_url: string; - user: components["schemas"]["nullable-simple-user"]; + html_url: string + user: components['schemas']['nullable-simple-user'] /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - updated_at: string; + updated_at: string /** Format: uri */ - issue_url: string; - author_association: components["schemas"]["author_association"]; - performed_via_github_app?: components["schemas"]["nullable-integration"]; - reactions?: components["schemas"]["reaction-rollup"]; - }; + issue_url: string + author_association: components['schemas']['author_association'] + performed_via_github_app?: components['schemas']['nullable-integration'] + reactions?: components['schemas']['reaction-rollup'] + } /** * Event * @description Event */ event: { - id: string; - type: string | null; - actor: components["schemas"]["actor"]; + id: string + type: string | null + actor: components['schemas']['actor'] repo: { - id: number; - name: string; + id: number + name: string /** Format: uri */ - url: string; - }; - org?: components["schemas"]["actor"]; + url: string + } + org?: components['schemas']['actor'] payload: { - action?: string; - issue?: components["schemas"]["issue"]; - comment?: components["schemas"]["issue-comment"]; + action?: string + issue?: components['schemas']['issue'] + comment?: components['schemas']['issue-comment'] pages?: { - page_name?: string; - title?: string; - summary?: string | null; - action?: string; - sha?: string; - html_url?: string; - }[]; - }; - public: boolean; + page_name?: string + title?: string + summary?: string | null + action?: string + sha?: string + html_url?: string + }[] + } + public: boolean /** Format: date-time */ - created_at: string | null; - }; + created_at: string | null + } /** * Link With Type * @description Hypermedia Link with Type */ - "link-with-type": { - href: string; - type: string; - }; + 'link-with-type': { + href: string + type: string + } /** * Feed * @description Feed */ feed: { /** @example https://github.com/timeline */ - timeline_url: string; + timeline_url: string /** @example https://github.com/{user} */ - user_url: string; + user_url: string /** @example https://github.com/octocat */ - current_user_public_url?: string; + current_user_public_url?: string /** @example https://github.com/octocat.private?token=abc123 */ - current_user_url?: string; + current_user_url?: string /** @example https://github.com/octocat.private.actor?token=abc123 */ - current_user_actor_url?: string; + current_user_actor_url?: string /** @example https://github.com/octocat-org */ - current_user_organization_url?: string; + current_user_organization_url?: string /** @example https://github.com/organizations/github/octocat.private.atom?token=abc123 */ - current_user_organization_urls?: string[]; + current_user_organization_urls?: string[] /** @example https://github.com/security-advisories */ - security_advisories_url?: string; + security_advisories_url?: string _links: { - timeline: components["schemas"]["link-with-type"]; - user: components["schemas"]["link-with-type"]; - security_advisories?: components["schemas"]["link-with-type"]; - current_user?: components["schemas"]["link-with-type"]; - current_user_public?: components["schemas"]["link-with-type"]; - current_user_actor?: components["schemas"]["link-with-type"]; - current_user_organization?: components["schemas"]["link-with-type"]; - current_user_organizations?: components["schemas"]["link-with-type"][]; - }; - }; + timeline: components['schemas']['link-with-type'] + user: components['schemas']['link-with-type'] + security_advisories?: components['schemas']['link-with-type'] + current_user?: components['schemas']['link-with-type'] + current_user_public?: components['schemas']['link-with-type'] + current_user_actor?: components['schemas']['link-with-type'] + current_user_organization?: components['schemas']['link-with-type'] + current_user_organizations?: components['schemas']['link-with-type'][] + } + } /** * Base Gist * @description Base Gist */ - "base-gist": { + 'base-gist': { /** Format: uri */ - url: string; + url: string /** Format: uri */ - forks_url: string; + forks_url: string /** Format: uri */ - commits_url: string; - id: string; - node_id: string; + commits_url: string + id: string + node_id: string /** Format: uri */ - git_pull_url: string; + git_pull_url: string /** Format: uri */ - git_push_url: string; + git_push_url: string /** Format: uri */ - html_url: string; + html_url: string files: { [key: string]: { - filename?: string; - type?: string; - language?: string; - raw_url?: string; - size?: number; - }; - }; - public: boolean; + filename?: string + type?: string + language?: string + raw_url?: string + size?: number + } + } + public: boolean /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - description: string | null; - comments: number; - user: components["schemas"]["nullable-simple-user"]; + updated_at: string + description: string | null + comments: number + user: components['schemas']['nullable-simple-user'] /** Format: uri */ - comments_url: string; - owner?: components["schemas"]["simple-user"]; - truncated?: boolean; - forks?: unknown[]; - history?: unknown[]; - }; + comments_url: string + owner?: components['schemas']['simple-user'] + truncated?: boolean + forks?: unknown[] + history?: unknown[] + } /** * Public User * @description Public User */ - "public-user": { - login: string; - id: number; - node_id: string; + 'public-user': { + login: string + id: number + node_id: string /** Format: uri */ - avatar_url: string; - gravatar_id: string | null; + avatar_url: string + gravatar_id: string | null /** Format: uri */ - url: string; + url: string /** Format: uri */ - html_url: string; + html_url: string /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - starred_url: string; + followers_url: string + following_url: string + gists_url: string + starred_url: string /** Format: uri */ - subscriptions_url: string; + subscriptions_url: string /** Format: uri */ - organizations_url: string; + organizations_url: string /** Format: uri */ - repos_url: string; - events_url: string; + repos_url: string + events_url: string /** Format: uri */ - received_events_url: string; - type: string; - site_admin: boolean; - name: string | null; - company: string | null; - blog: string | null; - location: string | null; + received_events_url: string + type: string + site_admin: boolean + name: string | null + company: string | null + blog: string | null + location: string | null /** Format: email */ - email: string | null; - hireable: boolean | null; - bio: string | null; - twitter_username?: string | null; - public_repos: number; - public_gists: number; - followers: number; - following: number; + email: string | null + hireable: boolean | null + bio: string | null + twitter_username?: string | null + public_repos: number + public_gists: number + followers: number + following: number /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; + updated_at: string plan?: { - collaborators: number; - name: string; - space: number; - private_repos: number; - }; + collaborators: number + name: string + space: number + private_repos: number + } /** Format: date-time */ - suspended_at?: string | null; + suspended_at?: string | null /** @example 1 */ - private_gists?: number; + private_gists?: number /** @example 2 */ - total_private_repos?: number; + total_private_repos?: number /** @example 2 */ - owned_private_repos?: number; + owned_private_repos?: number /** @example 1 */ - disk_usage?: number; + disk_usage?: number /** @example 3 */ - collaborators?: number; - }; + collaborators?: number + } /** * Gist History * @description Gist History */ - "gist-history": { - user?: components["schemas"]["nullable-simple-user"]; - version?: string; + 'gist-history': { + user?: components['schemas']['nullable-simple-user'] + version?: string /** Format: date-time */ - committed_at?: string; + committed_at?: string change_status?: { - total?: number; - additions?: number; - deletions?: number; - }; + total?: number + additions?: number + deletions?: number + } /** Format: uri */ - url?: string; - }; + url?: string + } /** * Gist Simple * @description Gist Simple */ - "gist-simple": { + 'gist-simple': { /** @deprecated */ forks?: | { - id?: string; + id?: string /** Format: uri */ - url?: string; - user?: components["schemas"]["public-user"]; + url?: string + user?: components['schemas']['public-user'] /** Format: date-time */ - created_at?: string; + created_at?: string /** Format: date-time */ - updated_at?: string; + updated_at?: string }[] - | null; + | null /** @deprecated */ - history?: components["schemas"]["gist-history"][] | null; + history?: components['schemas']['gist-history'][] | null /** * Gist * @description Gist */ fork_of?: { /** Format: uri */ - url: string; + url: string /** Format: uri */ - forks_url: string; + forks_url: string /** Format: uri */ - commits_url: string; - id: string; - node_id: string; + commits_url: string + id: string + node_id: string /** Format: uri */ - git_pull_url: string; + git_pull_url: string /** Format: uri */ - git_push_url: string; + git_push_url: string /** Format: uri */ - html_url: string; + html_url: string files: { [key: string]: { - filename?: string; - type?: string; - language?: string; - raw_url?: string; - size?: number; - }; - }; - public: boolean; + filename?: string + type?: string + language?: string + raw_url?: string + size?: number + } + } + public: boolean /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - description: string | null; - comments: number; - user: components["schemas"]["nullable-simple-user"]; + updated_at: string + description: string | null + comments: number + user: components['schemas']['nullable-simple-user'] /** Format: uri */ - comments_url: string; - owner?: components["schemas"]["nullable-simple-user"]; - truncated?: boolean; - forks?: unknown[]; - history?: unknown[]; - } | null; - url?: string; - forks_url?: string; - commits_url?: string; - id?: string; - node_id?: string; - git_pull_url?: string; - git_push_url?: string; - html_url?: string; + comments_url: string + owner?: components['schemas']['nullable-simple-user'] + truncated?: boolean + forks?: unknown[] + history?: unknown[] + } | null + url?: string + forks_url?: string + commits_url?: string + id?: string + node_id?: string + git_pull_url?: string + git_push_url?: string + html_url?: string files?: { [key: string]: { - filename?: string; - type?: string; - language?: string; - raw_url?: string; - size?: number; - truncated?: boolean; - content?: string; - } | null; - }; - public?: boolean; - created_at?: string; - updated_at?: string; - description?: string | null; - comments?: number; - user?: string | null; - comments_url?: string; - owner?: components["schemas"]["simple-user"]; - truncated?: boolean; - }; + filename?: string + type?: string + language?: string + raw_url?: string + size?: number + truncated?: boolean + content?: string + } | null + } + public?: boolean + created_at?: string + updated_at?: string + description?: string | null + comments?: number + user?: string | null + comments_url?: string + owner?: components['schemas']['simple-user'] + truncated?: boolean + } /** * Gist Comment * @description A comment made to a gist. */ - "gist-comment": { + 'gist-comment': { /** @example 1 */ - id: number; + id: number /** @example MDExOkdpc3RDb21tZW50MQ== */ - node_id: string; + node_id: string /** * Format: uri * @example https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 */ - url: string; + url: string /** * @description The comment text. * @example Body of the attachment */ - body: string; - user: components["schemas"]["nullable-simple-user"]; + body: string + user: components['schemas']['nullable-simple-user'] /** * Format: date-time * @example 2011-04-18T23:23:56Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2011-04-18T23:23:56Z */ - updated_at: string; - author_association: components["schemas"]["author_association"]; - }; + updated_at: string + author_association: components['schemas']['author_association'] + } /** * Gist Commit * @description Gist Commit */ - "gist-commit": { + 'gist-commit': { /** * Format: uri * @example https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f */ - url: string; + url: string /** @example 57a7f021a713b1c5a6a199b54cc514735d2d462f */ - version: string; - user: components["schemas"]["nullable-simple-user"]; + version: string + user: components['schemas']['nullable-simple-user'] change_status: { - total?: number; - additions?: number; - deletions?: number; - }; + total?: number + additions?: number + deletions?: number + } /** * Format: date-time * @example 2010-04-14T02:15:15Z */ - committed_at: string; - }; + committed_at: string + } /** * Gitignore Template * @description Gitignore Template */ - "gitignore-template": { + 'gitignore-template': { /** @example C */ - name: string; + name: string /** * @example # Object files * *.o @@ -8841,62 +8833,62 @@ export type components = { * *.out * *.app */ - source: string; - }; + source: string + } /** * License Simple * @description License Simple */ - "license-simple": { + 'license-simple': { /** @example mit */ - key: string; + key: string /** @example MIT License */ - name: string; + name: string /** * Format: uri * @example https://api.github.com/licenses/mit */ - url: string | null; + url: string | null /** @example MIT */ - spdx_id: string | null; + spdx_id: string | null /** @example MDc6TGljZW5zZW1pdA== */ - node_id: string; + node_id: string /** Format: uri */ - html_url?: string; - }; + html_url?: string + } /** * License * @description License */ license: { /** @example mit */ - key: string; + key: string /** @example MIT License */ - name: string; + name: string /** @example MIT */ - spdx_id: string | null; + spdx_id: string | null /** * Format: uri * @example https://api.github.com/licenses/mit */ - url: string | null; + url: string | null /** @example MDc6TGljZW5zZW1pdA== */ - node_id: string; + node_id: string /** * Format: uri * @example http://choosealicense.com/licenses/mit/ */ - html_url: string; + html_url: string /** @example A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty. */ - description: string; + description: string /** @example Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders. */ - implementation: string; + implementation: string /** @example commercial-use,modifications,distribution,sublicense,private-use */ - permissions: string[]; + permissions: string[] /** @example include-copyright */ - conditions: string[]; + conditions: string[] /** @example no-liability */ - limitations: string[]; + limitations: string[] /** * @example * @@ -8922,174 +8914,174 @@ export type components = { * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ - body: string; + body: string /** @example true */ - featured: boolean; - }; + featured: boolean + } /** * Marketplace Listing Plan * @description Marketplace Listing Plan */ - "marketplace-listing-plan": { + 'marketplace-listing-plan': { /** * Format: uri * @example https://api.github.com/marketplace_listing/plans/1313 */ - url: string; + url: string /** * Format: uri * @example https://api.github.com/marketplace_listing/plans/1313/accounts */ - accounts_url: string; + accounts_url: string /** @example 1313 */ - id: number; + id: number /** @example 3 */ - number: number; + number: number /** @example Pro */ - name: string; + name: string /** @example A professional-grade CI solution */ - description: string; + description: string /** @example 1099 */ - monthly_price_in_cents: number; + monthly_price_in_cents: number /** @example 11870 */ - yearly_price_in_cents: number; + yearly_price_in_cents: number /** @example flat-rate */ - price_model: string; + price_model: string /** @example true */ - has_free_trial: boolean; - unit_name: string | null; + has_free_trial: boolean + unit_name: string | null /** @example published */ - state: string; + state: string /** @example Up to 25 private repositories,11 concurrent builds */ - bullets: string[]; - }; + bullets: string[] + } /** * Marketplace Purchase * @description Marketplace Purchase */ - "marketplace-purchase": { - url: string; - type: string; - id: number; - login: string; - organization_billing_email?: string; - email?: string | null; + 'marketplace-purchase': { + url: string + type: string + id: number + login: string + organization_billing_email?: string + email?: string | null marketplace_pending_change?: { - is_installed?: boolean; - effective_date?: string; - unit_count?: number | null; - id?: number; - plan?: components["schemas"]["marketplace-listing-plan"]; - } | null; + is_installed?: boolean + effective_date?: string + unit_count?: number | null + id?: number + plan?: components['schemas']['marketplace-listing-plan'] + } | null marketplace_purchase: { - billing_cycle?: string; - next_billing_date?: string | null; - is_installed?: boolean; - unit_count?: number | null; - on_free_trial?: boolean; - free_trial_ends_on?: string | null; - updated_at?: string; - plan?: components["schemas"]["marketplace-listing-plan"]; - }; - }; + billing_cycle?: string + next_billing_date?: string | null + is_installed?: boolean + unit_count?: number | null + on_free_trial?: boolean + free_trial_ends_on?: string | null + updated_at?: string + plan?: components['schemas']['marketplace-listing-plan'] + } + } /** * Api Overview * @description Api Overview */ - "api-overview": { + 'api-overview': { /** @example true */ - verifiable_password_authentication: boolean; + verifiable_password_authentication: boolean ssh_key_fingerprints?: { - SHA256_RSA?: string; - SHA256_DSA?: string; - SHA256_ECDSA?: string; - SHA256_ED25519?: string; - }; + SHA256_RSA?: string + SHA256_DSA?: string + SHA256_ECDSA?: string + SHA256_ED25519?: string + } /** @example ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIOMqqnkVzrm0SdG6UOoqKLsabgH5C9okWi0dh2l9GKJl */ - ssh_keys?: string[]; + ssh_keys?: string[] /** @example 127.0.0.1/32 */ - hooks?: string[]; + hooks?: string[] /** @example 127.0.0.1/32 */ - web?: string[]; + web?: string[] /** @example 127.0.0.1/32 */ - api?: string[]; + api?: string[] /** @example 127.0.0.1/32 */ - git?: string[]; + git?: string[] /** @example 13.65.0.0/16,157.55.204.33/32,2a01:111:f403:f90c::/62 */ - packages?: string[]; + packages?: string[] /** @example 192.30.252.153/32,192.30.252.154/32 */ - pages?: string[]; + pages?: string[] /** @example 54.158.161.132,54.226.70.38 */ - importer?: string[]; + importer?: string[] /** @example 13.64.0.0/16,13.65.0.0/16 */ - actions?: string[]; + actions?: string[] /** @example 192.168.7.15/32,192.168.7.16/32 */ - dependabot?: string[]; - }; + dependabot?: string[] + } /** * Thread * @description Thread */ thread: { - id: string; - repository: components["schemas"]["minimal-repository"]; + id: string + repository: components['schemas']['minimal-repository'] subject: { - title: string; - url: string; - latest_comment_url: string; - type: string; - }; - reason: string; - unread: boolean; - updated_at: string; - last_read_at: string | null; - url: string; + title: string + url: string + latest_comment_url: string + type: string + } + reason: string + unread: boolean + updated_at: string + last_read_at: string | null + url: string /** @example https://api.github.com/notifications/threads/2/subscription */ - subscription_url: string; - }; + subscription_url: string + } /** * Thread Subscription * @description Thread Subscription */ - "thread-subscription": { + 'thread-subscription': { /** @example true */ - subscribed: boolean; - ignored: boolean; - reason: string | null; + subscribed: boolean + ignored: boolean + reason: string | null /** * Format: date-time * @example 2012-10-06T21:34:12Z */ - created_at: string | null; + created_at: string | null /** * Format: uri * @example https://api.github.com/notifications/threads/1/subscription */ - url: string; + url: string /** * Format: uri * @example https://api.github.com/notifications/threads/1 */ - thread_url?: string; + thread_url?: string /** * Format: uri * @example https://api.github.com/repos/1 */ - repository_url?: string; - }; + repository_url?: string + } /** * Organization Custom Repository Role * @description Custom repository roles created by organization administrators */ - "organization-custom-repository-role": { - id: number; - name: string; - }; + 'organization-custom-repository-role': { + id: number + name: string + } /** * ExternalGroups * @description A list of external groups available to be connected to a team */ - "external-groups": { + 'external-groups': { /** * @description An array of external groups available to be mapped to a team * @example [object Object],[object Object] @@ -9099,488 +9091,488 @@ export type components = { * @description The internal ID of the group * @example 1 */ - group_id: number; + group_id: number /** * @description The display name of the group * @example group-azuread-test */ - group_name: string; + group_name: string /** * @description The time of the last update for this group * @example 2019-06-03 22:27:15:000 -700 */ - updated_at: string; - }[]; - }; + updated_at: string + }[] + } /** * Organization Full * @description Organization Full */ - "organization-full": { + 'organization-full': { /** @example github */ - login: string; + login: string /** @example 1 */ - id: number; + id: number /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ - node_id: string; + node_id: string /** * Format: uri * @example https://api.github.com/orgs/github */ - url: string; + url: string /** * Format: uri * @example https://api.github.com/orgs/github/repos */ - repos_url: string; + repos_url: string /** * Format: uri * @example https://api.github.com/orgs/github/events */ - events_url: string; + events_url: string /** @example https://api.github.com/orgs/github/hooks */ - hooks_url: string; + hooks_url: string /** @example https://api.github.com/orgs/github/issues */ - issues_url: string; + issues_url: string /** @example https://api.github.com/orgs/github/members{/member} */ - members_url: string; + members_url: string /** @example https://api.github.com/orgs/github/public_members{/member} */ - public_members_url: string; + public_members_url: string /** @example https://github.com/images/error/octocat_happy.gif */ - avatar_url: string; + avatar_url: string /** @example A great organization */ - description: string | null; + description: string | null /** @example github */ - name?: string; + name?: string /** @example GitHub */ - company?: string; + company?: string /** * Format: uri * @example https://github.com/blog */ - blog?: string; + blog?: string /** @example San Francisco */ - location?: string; + location?: string /** * Format: email * @example octocat@github.com */ - email?: string; + email?: string /** @example github */ - twitter_username?: string | null; + twitter_username?: string | null /** @example true */ - is_verified?: boolean; + is_verified?: boolean /** @example true */ - has_organization_projects: boolean; + has_organization_projects: boolean /** @example true */ - has_repository_projects: boolean; + has_repository_projects: boolean /** @example 2 */ - public_repos: number; + public_repos: number /** @example 1 */ - public_gists: number; + public_gists: number /** @example 20 */ - followers: number; - following: number; + followers: number + following: number /** * Format: uri * @example https://github.com/octocat */ - html_url: string; + html_url: string /** * Format: date-time * @example 2008-01-14T04:33:35Z */ - created_at: string; + created_at: string /** @example Organization */ - type: string; + type: string /** @example 100 */ - total_private_repos?: number; + total_private_repos?: number /** @example 100 */ - owned_private_repos?: number; + owned_private_repos?: number /** @example 81 */ - private_gists?: number | null; + private_gists?: number | null /** @example 10000 */ - disk_usage?: number | null; + disk_usage?: number | null /** @example 8 */ - collaborators?: number | null; + collaborators?: number | null /** * Format: email * @example org@example.com */ - billing_email?: string | null; + billing_email?: string | null plan?: { - name: string; - space: number; - private_repos: number; - filled_seats?: number; - seats?: number; - }; - default_repository_permission?: string | null; + name: string + space: number + private_repos: number + filled_seats?: number + seats?: number + } + default_repository_permission?: string | null /** @example true */ - members_can_create_repositories?: boolean | null; + members_can_create_repositories?: boolean | null /** @example true */ - two_factor_requirement_enabled?: boolean | null; + two_factor_requirement_enabled?: boolean | null /** @example all */ - members_allowed_repository_creation_type?: string; + members_allowed_repository_creation_type?: string /** @example true */ - members_can_create_public_repositories?: boolean; + members_can_create_public_repositories?: boolean /** @example true */ - members_can_create_private_repositories?: boolean; + members_can_create_private_repositories?: boolean /** @example true */ - members_can_create_internal_repositories?: boolean; + members_can_create_internal_repositories?: boolean /** @example true */ - members_can_create_pages?: boolean; + members_can_create_pages?: boolean /** @example true */ - members_can_create_public_pages?: boolean; + members_can_create_public_pages?: boolean /** @example true */ - members_can_create_private_pages?: boolean; - members_can_fork_private_repositories?: boolean | null; + members_can_create_private_pages?: boolean + members_can_fork_private_repositories?: boolean | null /** Format: date-time */ - updated_at: string; - }; + updated_at: string + } /** * @description The policy that controls the repositories in the organization that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`. * @enum {string} */ - "enabled-repositories": "all" | "none" | "selected"; - "actions-organization-permissions": { - enabled_repositories: components["schemas"]["enabled-repositories"]; + 'enabled-repositories': 'all' | 'none' | 'selected' + 'actions-organization-permissions': { + enabled_repositories: components['schemas']['enabled-repositories'] /** @description The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. */ - selected_repositories_url?: string; - allowed_actions?: components["schemas"]["allowed-actions"]; - selected_actions_url?: components["schemas"]["selected-actions-url"]; - }; + selected_repositories_url?: string + allowed_actions?: components['schemas']['allowed-actions'] + selected_actions_url?: components['schemas']['selected-actions-url'] + } /** * @description The default workflow permissions granted to the GITHUB_TOKEN when running workflows in an organization. * @enum {string} */ - "actions-default-workflow-permissions": "read" | "write"; + 'actions-default-workflow-permissions': 'read' | 'write' /** @description Whether GitHub Actions can submit approving pull request reviews. */ - "actions-can-approve-pull-request-reviews": boolean; - "actions-get-default-workflow-permissions": { - default_workflow_permissions: components["schemas"]["actions-default-workflow-permissions"]; - can_approve_pull_request_reviews: components["schemas"]["actions-can-approve-pull-request-reviews"]; - }; - "actions-set-default-workflow-permissions": { - default_workflow_permissions?: components["schemas"]["actions-default-workflow-permissions"]; - can_approve_pull_request_reviews?: components["schemas"]["actions-can-approve-pull-request-reviews"]; - }; - "runner-groups-org": { - id: number; - name: string; - visibility: string; - default: boolean; + 'actions-can-approve-pull-request-reviews': boolean + 'actions-get-default-workflow-permissions': { + default_workflow_permissions: components['schemas']['actions-default-workflow-permissions'] + can_approve_pull_request_reviews: components['schemas']['actions-can-approve-pull-request-reviews'] + } + 'actions-set-default-workflow-permissions': { + default_workflow_permissions?: components['schemas']['actions-default-workflow-permissions'] + can_approve_pull_request_reviews?: components['schemas']['actions-can-approve-pull-request-reviews'] + } + 'runner-groups-org': { + id: number + name: string + visibility: string + default: boolean /** @description Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected` */ - selected_repositories_url?: string; - runners_url: string; - inherited: boolean; - inherited_allows_public_repositories?: boolean; - allows_public_repositories: boolean; - }; + selected_repositories_url?: string + runners_url: string + inherited: boolean + inherited_allows_public_repositories?: boolean + allows_public_repositories: boolean + } /** * Actions Secret for an Organization * @description Secrets for GitHub Actions for an organization. */ - "organization-actions-secret": { + 'organization-actions-secret': { /** * @description The name of the secret. * @example SECRET_TOKEN */ - name: string; + name: string /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; + updated_at: string /** * @description Visibility of a secret * @enum {string} */ - visibility: "all" | "private" | "selected"; + visibility: 'all' | 'private' | 'selected' /** * Format: uri * @example https://api.github.com/organizations/org/secrets/my_secret/repositories */ - selected_repositories_url?: string; - }; + selected_repositories_url?: string + } /** * ActionsPublicKey * @description The public key used for setting Actions Secrets. */ - "actions-public-key": { + 'actions-public-key': { /** * @description The identifier for the key. * @example 1234567 */ - key_id: string; + key_id: string /** * @description The Base64 encoded public key. * @example hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= */ - key: string; + key: string /** @example 2 */ - id?: number; + id?: number /** @example https://api.github.com/user/keys/2 */ - url?: string; + url?: string /** @example ssh-rsa AAAAB3NzaC1yc2EAAA */ - title?: string; + title?: string /** @example 2011-01-26T19:01:12Z */ - created_at?: string; - }; + created_at?: string + } /** * Empty Object * @description An object without any properties. */ - "empty-object": { [key: string]: unknown }; + 'empty-object': { [key: string]: unknown } /** * @description State of a code scanning alert. * @enum {string} */ - "code-scanning-alert-state": "open" | "closed" | "dismissed" | "fixed"; + 'code-scanning-alert-state': 'open' | 'closed' | 'dismissed' | 'fixed' /** * Format: date-time * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "alert-updated-at": string; + 'alert-updated-at': string /** * Format: uri * @description The REST API URL for fetching the list of instances for an alert. */ - "alert-instances-url": string; + 'alert-instances-url': string /** * Format: date-time * @description The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "code-scanning-alert-fixed-at": string | null; + 'code-scanning-alert-fixed-at': string | null /** * Format: date-time * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "code-scanning-alert-dismissed-at": string | null; + 'code-scanning-alert-dismissed-at': string | null /** * @description **Required when the state is dismissed.** The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. * @enum {string|null} */ - "code-scanning-alert-dismissed-reason": (null | "false positive" | "won't fix" | "used in tests") | null; - "code-scanning-alert-rule": { + 'code-scanning-alert-dismissed-reason': (null | 'false positive' | "won't fix" | 'used in tests') | null + 'code-scanning-alert-rule': { /** @description A unique identifier for the rule used to detect the alert. */ - id?: string | null; + id?: string | null /** @description The name of the rule used to detect the alert. */ - name?: string; + name?: string /** * @description The severity of the alert. * @enum {string|null} */ - severity?: ("none" | "note" | "warning" | "error") | null; + severity?: ('none' | 'note' | 'warning' | 'error') | null /** * @description The security severity of the alert. * @enum {string|null} */ - security_severity_level?: ("low" | "medium" | "high" | "critical") | null; + security_severity_level?: ('low' | 'medium' | 'high' | 'critical') | null /** @description A short description of the rule used to detect the alert. */ - description?: string; + description?: string /** @description description of the rule used to detect the alert. */ - full_description?: string; + full_description?: string /** @description A set of tags applicable for the rule. */ - tags?: string[] | null; + tags?: string[] | null /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */ - help?: string | null; - }; + help?: string | null + } /** @description The name of the tool used to generate the code scanning analysis. */ - "code-scanning-analysis-tool-name": string; + 'code-scanning-analysis-tool-name': string /** @description The version of the tool used to generate the code scanning analysis. */ - "code-scanning-analysis-tool-version": string | null; + 'code-scanning-analysis-tool-version': string | null /** @description The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. */ - "code-scanning-analysis-tool-guid": string | null; - "code-scanning-analysis-tool": { - name?: components["schemas"]["code-scanning-analysis-tool-name"]; - version?: components["schemas"]["code-scanning-analysis-tool-version"]; - guid?: components["schemas"]["code-scanning-analysis-tool-guid"]; - }; + 'code-scanning-analysis-tool-guid': string | null + 'code-scanning-analysis-tool': { + name?: components['schemas']['code-scanning-analysis-tool-name'] + version?: components['schemas']['code-scanning-analysis-tool-version'] + guid?: components['schemas']['code-scanning-analysis-tool-guid'] + } /** * @description The full Git reference, formatted as `refs/heads/`, * `refs/pull//merge`, or `refs/pull//head`. */ - "code-scanning-ref": string; + 'code-scanning-ref': string /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - "code-scanning-analysis-analysis-key": string; + 'code-scanning-analysis-analysis-key': string /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - "code-scanning-alert-environment": string; + 'code-scanning-alert-environment': string /** @description Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code. */ - "code-scanning-analysis-category": string; + 'code-scanning-analysis-category': string /** @description Describe a region within a file for the alert. */ - "code-scanning-alert-location": { - path?: string; - start_line?: number; - end_line?: number; - start_column?: number; - end_column?: number; - }; + 'code-scanning-alert-location': { + path?: string + start_line?: number + end_line?: number + start_column?: number + end_column?: number + } /** * @description A classification of the file. For example to identify it as generated. * @enum {string|null} */ - "code-scanning-alert-classification": ("source" | "generated" | "test" | "library") | null; - "code-scanning-alert-instance": { - ref?: components["schemas"]["code-scanning-ref"]; - analysis_key?: components["schemas"]["code-scanning-analysis-analysis-key"]; - environment?: components["schemas"]["code-scanning-alert-environment"]; - category?: components["schemas"]["code-scanning-analysis-category"]; - state?: components["schemas"]["code-scanning-alert-state"]; - commit_sha?: string; + 'code-scanning-alert-classification': ('source' | 'generated' | 'test' | 'library') | null + 'code-scanning-alert-instance': { + ref?: components['schemas']['code-scanning-ref'] + analysis_key?: components['schemas']['code-scanning-analysis-analysis-key'] + environment?: components['schemas']['code-scanning-alert-environment'] + category?: components['schemas']['code-scanning-analysis-category'] + state?: components['schemas']['code-scanning-alert-state'] + commit_sha?: string message?: { - text?: string; - }; - location?: components["schemas"]["code-scanning-alert-location"]; - html_url?: string; + text?: string + } + location?: components['schemas']['code-scanning-alert-location'] + html_url?: string /** * @description Classifications that have been applied to the file that triggered the alert. * For example identifying it as documentation, or a generated file. */ - classifications?: components["schemas"]["code-scanning-alert-classification"][]; - }; - "code-scanning-organization-alert-items": { - number: components["schemas"]["alert-number"]; - created_at: components["schemas"]["alert-created-at"]; - updated_at?: components["schemas"]["alert-updated-at"]; - url: components["schemas"]["alert-url"]; - html_url: components["schemas"]["alert-html-url"]; - instances_url: components["schemas"]["alert-instances-url"]; - state: components["schemas"]["code-scanning-alert-state"]; - fixed_at?: components["schemas"]["code-scanning-alert-fixed-at"]; - dismissed_by: components["schemas"]["nullable-simple-user"]; - dismissed_at: components["schemas"]["code-scanning-alert-dismissed-at"]; - dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"]; - rule: components["schemas"]["code-scanning-alert-rule"]; - tool: components["schemas"]["code-scanning-analysis-tool"]; - most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; - repository: components["schemas"]["minimal-repository"]; - }; + classifications?: components['schemas']['code-scanning-alert-classification'][] + } + 'code-scanning-organization-alert-items': { + number: components['schemas']['alert-number'] + created_at: components['schemas']['alert-created-at'] + updated_at?: components['schemas']['alert-updated-at'] + url: components['schemas']['alert-url'] + html_url: components['schemas']['alert-html-url'] + instances_url: components['schemas']['alert-instances-url'] + state: components['schemas']['code-scanning-alert-state'] + fixed_at?: components['schemas']['code-scanning-alert-fixed-at'] + dismissed_by: components['schemas']['nullable-simple-user'] + dismissed_at: components['schemas']['code-scanning-alert-dismissed-at'] + dismissed_reason: components['schemas']['code-scanning-alert-dismissed-reason'] + rule: components['schemas']['code-scanning-alert-rule'] + tool: components['schemas']['code-scanning-analysis-tool'] + most_recent_instance: components['schemas']['code-scanning-alert-instance'] + repository: components['schemas']['minimal-repository'] + } /** * Credential Authorization * @description Credential Authorization */ - "credential-authorization": { + 'credential-authorization': { /** * @description User login that owns the underlying credential. * @example monalisa */ - login: string; + login: string /** * @description Unique identifier for the credential. * @example 1 */ - credential_id: number; + credential_id: number /** * @description Human-readable description of the credential type. * @example SSH Key */ - credential_type: string; + credential_type: string /** * @description Last eight characters of the credential. Only included in responses with credential_type of personal access token. * @example 12345678 */ - token_last_eight?: string; + token_last_eight?: string /** * Format: date-time * @description Date when the credential was authorized for use. * @example 2011-01-26T19:06:43Z */ - credential_authorized_at: string; + credential_authorized_at: string /** * @description List of oauth scopes the token has been granted. * @example user,repo */ - scopes?: string[]; + scopes?: string[] /** * @description Unique string to distinguish the credential. Only included in responses with credential_type of SSH Key. * @example jklmnop12345678 */ - fingerprint?: string; + fingerprint?: string /** * Format: date-time * @description Date when the credential was last accessed. May be null if it was never accessed * @example 2011-01-26T19:06:43Z */ - credential_accessed_at: string | null; + credential_accessed_at: string | null /** @example 12345678 */ - authorized_credential_id: number | null; + authorized_credential_id: number | null /** * @description The title given to the ssh key. This will only be present when the credential is an ssh key. * @example my ssh key */ - authorized_credential_title?: string | null; + authorized_credential_title?: string | null /** * @description The note given to the token. This will only be present when the credential is a token. * @example my token */ - authorized_credential_note?: string | null; + authorized_credential_note?: string | null /** * Format: date-time * @description The expiry for the token. This will only be present when the credential is a token. */ - authorized_credential_expires_at?: string | null; - }; + authorized_credential_expires_at?: string | null + } /** * Dependabot Secret for an Organization * @description Secrets for GitHub Dependabot for an organization. */ - "organization-dependabot-secret": { + 'organization-dependabot-secret': { /** * @description The name of the secret. * @example SECRET_TOKEN */ - name: string; + name: string /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; + updated_at: string /** * @description Visibility of a secret * @enum {string} */ - visibility: "all" | "private" | "selected"; + visibility: 'all' | 'private' | 'selected' /** * Format: uri * @example https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories */ - selected_repositories_url?: string; - }; + selected_repositories_url?: string + } /** * DependabotPublicKey * @description The public key used for setting Dependabot Secrets. */ - "dependabot-public-key": { + 'dependabot-public-key': { /** * @description The identifier for the key. * @example 1234567 */ - key_id: string; + key_id: string /** * @description The Base64 encoded public key. * @example hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= */ - key: string; - }; + key: string + } /** * ExternalGroup * @description Information about an external group's usage and its members */ - "external-group": { + 'external-group': { /** * @description The internal ID of the group * @example 1 */ - group_id: number; + group_id: number /** * @description The display name for the group * @example group-azuread-test */ - group_name: string; + group_name: string /** * @description The date when the group was last updated_at * @example 2021-01-03 22:27:15:000 -700 */ - updated_at?: string; + updated_at?: string /** * @description An array of teams linked to this group * @example [object Object],[object Object] @@ -9590,13 +9582,13 @@ export type components = { * @description The id for a team * @example 1 */ - team_id: number; + team_id: number /** * @description The name of the team * @example team-test */ - team_name: string; - }[]; + team_name: string + }[] /** * @description An array of external members linked to this group * @example [object Object],[object Object] @@ -9606,493 +9598,493 @@ export type components = { * @description The internal user ID of the identity * @example 1 */ - member_id: number; + member_id: number /** * @description The handle/login for the user * @example mona-lisa_eocsaxrs */ - member_login: string; + member_login: string /** * @description The user display name/profile name * @example Mona Lisa */ - member_name: string; + member_name: string /** * @description An email attached to a user * @example mona_lisa@github.com */ - member_email: string; - }[]; - }; + member_email: string + }[] + } /** * Organization Invitation * @description Organization Invitation */ - "organization-invitation": { - id: number; - login: string | null; - email: string | null; - role: string; - created_at: string; - failed_at?: string | null; - failed_reason?: string | null; - inviter: components["schemas"]["simple-user"]; - team_count: number; + 'organization-invitation': { + id: number + login: string | null + email: string | null + role: string + created_at: string + failed_at?: string | null + failed_reason?: string | null + inviter: components['schemas']['simple-user'] + team_count: number /** @example "MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x" */ - node_id: string; + node_id: string /** @example "https://api.github.com/organizations/16/invitations/1/teams" */ - invitation_teams_url: string; - }; + invitation_teams_url: string + } /** * Org Hook * @description Org Hook */ - "org-hook": { + 'org-hook': { /** @example 1 */ - id: number; + id: number /** * Format: uri * @example https://api.github.com/orgs/octocat/hooks/1 */ - url: string; + url: string /** * Format: uri * @example https://api.github.com/orgs/octocat/hooks/1/pings */ - ping_url: string; + ping_url: string /** * Format: uri * @example https://api.github.com/orgs/octocat/hooks/1/deliveries */ - deliveries_url?: string; + deliveries_url?: string /** @example web */ - name: string; + name: string /** @example push,pull_request */ - events: string[]; + events: string[] /** @example true */ - active: boolean; + active: boolean config: { /** @example "http://example.com/2" */ - url?: string; + url?: string /** @example "0" */ - insecure_ssl?: string; + insecure_ssl?: string /** @example "form" */ - content_type?: string; + content_type?: string /** @example "********" */ - secret?: string; - }; + secret?: string + } /** * Format: date-time * @example 2011-09-06T20:39:23Z */ - updated_at: string; + updated_at: string /** * Format: date-time * @example 2011-09-06T17:26:27Z */ - created_at: string; - type: string; - }; + created_at: string + type: string + } /** * @description The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. Can be one of: `existing_users`, `contributors_only`, `collaborators_only`. * @example collaborators_only * @enum {string} */ - "interaction-group": "existing_users" | "contributors_only" | "collaborators_only"; + 'interaction-group': 'existing_users' | 'contributors_only' | 'collaborators_only' /** * Interaction Limits * @description Interaction limit settings. */ - "interaction-limit-response": { - limit: components["schemas"]["interaction-group"]; + 'interaction-limit-response': { + limit: components['schemas']['interaction-group'] /** @example repository */ - origin: string; + origin: string /** * Format: date-time * @example 2018-08-17T04:18:39Z */ - expires_at: string; - }; + expires_at: string + } /** * @description The duration of the interaction restriction. Can be one of: `one_day`, `three_days`, `one_week`, `one_month`, `six_months`. Default: `one_day`. * @example one_month * @enum {string} */ - "interaction-expiry": "one_day" | "three_days" | "one_week" | "one_month" | "six_months"; + 'interaction-expiry': 'one_day' | 'three_days' | 'one_week' | 'one_month' | 'six_months' /** * Interaction Restrictions * @description Limit interactions to a specific type of user for a specified duration */ - "interaction-limit": { - limit: components["schemas"]["interaction-group"]; - expiry?: components["schemas"]["interaction-expiry"]; - }; + 'interaction-limit': { + limit: components['schemas']['interaction-group'] + expiry?: components['schemas']['interaction-expiry'] + } /** * Team Simple * @description Groups of organization members that gives permissions on specified repositories. */ - "nullable-team-simple": { + 'nullable-team-simple': { /** * @description Unique identifier of the team * @example 1 */ - id: number; + id: number /** @example MDQ6VGVhbTE= */ - node_id: string; + node_id: string /** * Format: uri * @description URL for the team * @example https://api.github.com/organizations/1/team/1 */ - url: string; + url: string /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - members_url: string; + members_url: string /** * @description Name of the team * @example Justice League */ - name: string; + name: string /** * @description Description of the team * @example A great team. */ - description: string | null; + description: string | null /** * @description Permission that the team will have for its repositories * @example admin */ - permission: string; + permission: string /** * @description The level of privacy this team should have * @example closed */ - privacy?: string; + privacy?: string /** * Format: uri * @example https://github.com/orgs/rails/teams/core */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/organizations/1/team/1/repos */ - repositories_url: string; + repositories_url: string /** @example justice-league */ - slug: string; + slug: string /** * @description Distinguished Name (DN) that team maps to within LDAP environment * @example uid=example,ou=users,dc=github,dc=com */ - ldap_dn?: string; - } | null; + ldap_dn?: string + } | null /** * Team * @description Groups of organization members that gives permissions on specified repositories. */ team: { - id: number; - node_id: string; - name: string; - slug: string; - description: string | null; - privacy?: string; - permission: string; + id: number + node_id: string + name: string + slug: string + description: string | null + privacy?: string + permission: string permissions?: { - pull: boolean; - triage: boolean; - push: boolean; - maintain: boolean; - admin: boolean; - }; + pull: boolean + triage: boolean + push: boolean + maintain: boolean + admin: boolean + } /** Format: uri */ - url: string; + url: string /** * Format: uri * @example https://github.com/orgs/rails/teams/core */ - html_url: string; - members_url: string; + html_url: string + members_url: string /** Format: uri */ - repositories_url: string; - parent: components["schemas"]["nullable-team-simple"]; - }; + repositories_url: string + parent: components['schemas']['nullable-team-simple'] + } /** * Org Membership * @description Org Membership */ - "org-membership": { + 'org-membership': { /** * Format: uri * @example https://api.github.com/orgs/octocat/memberships/defunkt */ - url: string; + url: string /** * @description The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation. * @example active * @enum {string} */ - state: "active" | "pending"; + state: 'active' | 'pending' /** * @description The user's membership type in the organization. * @example admin * @enum {string} */ - role: "admin" | "member" | "billing_manager"; + role: 'admin' | 'member' | 'billing_manager' /** * Format: uri * @example https://api.github.com/orgs/octocat */ - organization_url: string; - organization: components["schemas"]["organization-simple"]; - user: components["schemas"]["nullable-simple-user"]; + organization_url: string + organization: components['schemas']['organization-simple'] + user: components['schemas']['nullable-simple-user'] permissions?: { - can_create_repository: boolean; - }; - }; + can_create_repository: boolean + } + } /** * Migration * @description A migration. */ migration: { /** @example 79 */ - id: number; - owner: components["schemas"]["nullable-simple-user"]; + id: number + owner: components['schemas']['nullable-simple-user'] /** @example 0b989ba4-242f-11e5-81e1-c7b6966d2516 */ - guid: string; + guid: string /** @example pending */ - state: string; + state: string /** @example true */ - lock_repositories: boolean; - exclude_metadata: boolean; - exclude_git_data: boolean; - exclude_attachments: boolean; - exclude_releases: boolean; - exclude_owner_projects: boolean; - repositories: components["schemas"]["repository"][]; + lock_repositories: boolean + exclude_metadata: boolean + exclude_git_data: boolean + exclude_attachments: boolean + exclude_releases: boolean + exclude_owner_projects: boolean + repositories: components['schemas']['repository'][] /** * Format: uri * @example https://api.github.com/orgs/octo-org/migrations/79 */ - url: string; + url: string /** * Format: date-time * @example 2015-07-06T15:33:38-07:00 */ - created_at: string; + created_at: string /** * Format: date-time * @example 2015-07-06T15:33:38-07:00 */ - updated_at: string; - node_id: string; + updated_at: string + node_id: string /** Format: uri */ - archive_url?: string; - exclude?: unknown[]; - }; + archive_url?: string + exclude?: unknown[] + } /** * Minimal Repository * @description Minimal Repository */ - "nullable-minimal-repository": { + 'nullable-minimal-repository': { /** @example 1296269 */ - id: number; + id: number /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - node_id: string; + node_id: string /** @example Hello-World */ - name: string; + name: string /** @example octocat/Hello-World */ - full_name: string; - owner: components["schemas"]["simple-user"]; - private: boolean; + full_name: string + owner: components['schemas']['simple-user'] + private: boolean /** * Format: uri * @example https://github.com/octocat/Hello-World */ - html_url: string; + html_url: string /** @example This your first repo! */ - description: string | null; - fork: boolean; + description: string | null + fork: boolean /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World */ - url: string; + url: string /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - archive_url: string; + archive_url: string /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - assignees_url: string; + assignees_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - blobs_url: string; + blobs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - branches_url: string; + branches_url: string /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - collaborators_url: string; + collaborators_url: string /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - comments_url: string; + comments_url: string /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - commits_url: string; + commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - compare_url: string; + compare_url: string /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - contents_url: string; + contents_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - contributors_url: string; + contributors_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - deployments_url: string; + deployments_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - downloads_url: string; + downloads_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events */ - events_url: string; + events_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ - forks_url: string; + forks_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - git_commits_url: string; + git_commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - git_refs_url: string; + git_refs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - git_tags_url: string; - git_url?: string; + git_tags_url: string + git_url?: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - issue_comment_url: string; + issue_comment_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - issue_events_url: string; + issue_events_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - issues_url: string; + issues_url: string /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - keys_url: string; + keys_url: string /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - labels_url: string; + labels_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ - languages_url: string; + languages_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ - merges_url: string; + merges_url: string /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - milestones_url: string; + milestones_url: string /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - notifications_url: string; + notifications_url: string /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - pulls_url: string; + pulls_url: string /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - releases_url: string; - ssh_url?: string; + releases_url: string + ssh_url?: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - stargazers_url: string; + stargazers_url: string /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - statuses_url: string; + statuses_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - subscribers_url: string; + subscribers_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - subscription_url: string; + subscription_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ - tags_url: string; + tags_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ - teams_url: string; + teams_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - trees_url: string; - clone_url?: string; - mirror_url?: string | null; + trees_url: string + clone_url?: string + mirror_url?: string | null /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - hooks_url: string; - svn_url?: string; - homepage?: string | null; - language?: string | null; - forks_count?: number; - stargazers_count?: number; - watchers_count?: number; - size?: number; - default_branch?: string; - open_issues_count?: number; - is_template?: boolean; - topics?: string[]; - has_issues?: boolean; - has_projects?: boolean; - has_wiki?: boolean; - has_pages?: boolean; - has_downloads?: boolean; - archived?: boolean; - disabled?: boolean; - visibility?: string; + hooks_url: string + svn_url?: string + homepage?: string | null + language?: string | null + forks_count?: number + stargazers_count?: number + watchers_count?: number + size?: number + default_branch?: string + open_issues_count?: number + is_template?: boolean + topics?: string[] + has_issues?: boolean + has_projects?: boolean + has_wiki?: boolean + has_pages?: boolean + has_downloads?: boolean + archived?: boolean + disabled?: boolean + visibility?: string /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - pushed_at?: string | null; + pushed_at?: string | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - created_at?: string | null; + created_at?: string | null /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - updated_at?: string | null; + updated_at?: string | null permissions?: { - admin?: boolean; - maintain?: boolean; - push?: boolean; - triage?: boolean; - pull?: boolean; - }; + admin?: boolean + maintain?: boolean + push?: boolean + triage?: boolean + pull?: boolean + } /** @example admin */ - role_name?: string; - template_repository?: components["schemas"]["nullable-repository"]; - temp_clone_token?: string; - delete_branch_on_merge?: boolean; - subscribers_count?: number; - network_count?: number; - code_of_conduct?: components["schemas"]["code-of-conduct"]; + role_name?: string + template_repository?: components['schemas']['nullable-repository'] + temp_clone_token?: string + delete_branch_on_merge?: boolean + subscribers_count?: number + network_count?: number + code_of_conduct?: components['schemas']['code-of-conduct'] license?: { - key?: string; - name?: string; - spdx_id?: string; - url?: string; - node_id?: string; - } | null; - forks?: number; - open_issues?: number; - watchers?: number; - allow_forking?: boolean; - } | null; + key?: string + name?: string + spdx_id?: string + url?: string + node_id?: string + } | null + forks?: number + open_issues?: number + watchers?: number + allow_forking?: boolean + } | null /** * Package * @description A software package @@ -10102,96 +10094,96 @@ export type components = { * @description Unique identifier of the package. * @example 1 */ - id: number; + id: number /** * @description The name of the package. * @example super-linter */ - name: string; + name: string /** * @example docker * @enum {string} */ - package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + package_type: 'npm' | 'maven' | 'rubygems' | 'docker' | 'nuget' | 'container' /** @example https://api.github.com/orgs/github/packages/container/super-linter */ - url: string; + url: string /** @example https://github.com/orgs/github/packages/container/package/super-linter */ - html_url: string; + html_url: string /** * @description The number of versions of the package. * @example 1 */ - version_count: number; + version_count: number /** * @example private * @enum {string} */ - visibility: "private" | "public"; - owner?: components["schemas"]["nullable-simple-user"]; - repository?: components["schemas"]["nullable-minimal-repository"]; + visibility: 'private' | 'public' + owner?: components['schemas']['nullable-simple-user'] + repository?: components['schemas']['nullable-minimal-repository'] /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - }; + updated_at: string + } /** * Package Version * @description A version of a software package */ - "package-version": { + 'package-version': { /** * @description Unique identifier of the package version. * @example 1 */ - id: number; + id: number /** * @description The name of the package version. * @example latest */ - name: string; + name: string /** @example https://api.github.com/orgs/github/packages/container/super-linter/versions/786068 */ - url: string; + url: string /** @example https://github.com/orgs/github/packages/container/package/super-linter */ - package_html_url: string; + package_html_url: string /** @example https://github.com/orgs/github/packages/container/super-linter/786068 */ - html_url?: string; + html_url?: string /** @example MIT */ - license?: string; - description?: string; + license?: string + description?: string /** * Format: date-time * @example 2011-04-10T20:09:31Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2014-03-03T18:58:10Z */ - updated_at: string; + updated_at: string /** * Format: date-time * @example 2014-03-03T18:58:10Z */ - deleted_at?: string; + deleted_at?: string /** Package Version Metadata */ metadata?: { /** * @example docker * @enum {string} */ - package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + package_type: 'npm' | 'maven' | 'rubygems' | 'docker' | 'nuget' | 'container' /** Container Metadata */ container?: { - tags: string[]; - }; + tags: string[] + } /** Docker Metadata */ docker?: { - tag?: string[]; + tag?: string[] } & { - tags: unknown; - }; - }; - }; + tags: unknown + } + } + } /** * Project * @description Projects are a way to organize columns and cards of work. @@ -10201,67 +10193,67 @@ export type components = { * Format: uri * @example https://api.github.com/repos/api-playground/projects-test */ - owner_url: string; + owner_url: string /** * Format: uri * @example https://api.github.com/projects/1002604 */ - url: string; + url: string /** * Format: uri * @example https://github.com/api-playground/projects-test/projects/12 */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/projects/1002604/columns */ - columns_url: string; + columns_url: string /** @example 1002604 */ - id: number; + id: number /** @example MDc6UHJvamVjdDEwMDI2MDQ= */ - node_id: string; + node_id: string /** * @description Name of the project * @example Week One Sprint */ - name: string; + name: string /** * @description Body of the project * @example This project represents the sprint of the first week in January */ - body: string | null; + body: string | null /** @example 1 */ - number: number; + number: number /** * @description State of the project; either 'open' or 'closed' * @example open */ - state: string; - creator: components["schemas"]["nullable-simple-user"]; + state: string + creator: components['schemas']['nullable-simple-user'] /** * Format: date-time * @example 2011-04-10T20:09:31Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2014-03-03T18:58:10Z */ - updated_at: string; + updated_at: string /** * @description The baseline permission that all organization members have on this project. Only present if owner is an organization. * @enum {string} */ - organization_permission?: "read" | "write" | "admin" | "none"; + organization_permission?: 'read' | 'write' | 'admin' | 'none' /** @description Whether or not this project can be seen by everyone. Only present if owner is an organization. */ - private?: boolean; - }; + private?: boolean + } /** * GroupMapping * @description External Groups to be mapped to a team for membership */ - "group-mapping": { + 'group-mapping': { /** * @description Array of groups to be mapped to this team * @example [object Object],[object Object] @@ -10271,1012 +10263,1012 @@ export type components = { * @description The ID of the group * @example 111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa */ - group_id: string; + group_id: string /** * @description The name of the group * @example saml-azuread-test */ - group_name: string; + group_name: string /** * @description a description of the group * @example A group of Developers working on AzureAD SAML SSO */ - group_description: string; + group_description: string /** * @description synchronization status for this group mapping * @example unsynced */ - status?: string; + status?: string /** * @description the time of the last sync for this group-mapping * @example 2019-06-03 22:27:15:000 -700 */ - synced_at?: string | null; - }[]; - }; + synced_at?: string | null + }[] + } /** * Full Team * @description Groups of organization members that gives permissions on specified repositories. */ - "team-full": { + 'team-full': { /** * @description Unique identifier of the team * @example 42 */ - id: number; + id: number /** @example MDQ6VGVhbTE= */ - node_id: string; + node_id: string /** * Format: uri * @description URL for the team * @example https://api.github.com/organizations/1/team/1 */ - url: string; + url: string /** * Format: uri * @example https://github.com/orgs/rails/teams/core */ - html_url: string; + html_url: string /** * @description Name of the team * @example Developers */ - name: string; + name: string /** @example justice-league */ - slug: string; + slug: string /** @example A great team. */ - description: string | null; + description: string | null /** * @description The level of privacy this team should have * @example closed * @enum {string} */ - privacy?: "closed" | "secret"; + privacy?: 'closed' | 'secret' /** * @description Permission that the team will have for its repositories * @example push */ - permission: string; + permission: string /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - members_url: string; + members_url: string /** * Format: uri * @example https://api.github.com/organizations/1/team/1/repos */ - repositories_url: string; - parent?: components["schemas"]["nullable-team-simple"]; + repositories_url: string + parent?: components['schemas']['nullable-team-simple'] /** @example 3 */ - members_count: number; + members_count: number /** @example 10 */ - repos_count: number; + repos_count: number /** * Format: date-time * @example 2017-07-14T16:53:42Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2017-08-17T12:37:15Z */ - updated_at: string; - organization: components["schemas"]["organization-full"]; + updated_at: string + organization: components['schemas']['organization-full'] /** * @description Distinguished Name (DN) that team maps to within LDAP environment * @example uid=example,ou=users,dc=github,dc=com */ - ldap_dn?: string; - }; + ldap_dn?: string + } /** * Team Discussion * @description A team discussion is a persistent record of a free-form conversation within a team. */ - "team-discussion": { - author: components["schemas"]["nullable-simple-user"]; + 'team-discussion': { + author: components['schemas']['nullable-simple-user'] /** * @description The main text of the discussion. * @example Please suggest improvements to our workflow in comments. */ - body: string; + body: string /** @example

Hi! This is an area for us to collaborate as a team

*/ - body_html: string; + body_html: string /** * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server. * @example 0307116bbf7ced493b8d8a346c650b71 */ - body_version: string; - comments_count: number; + body_version: string + comments_count: number /** * Format: uri * @example https://api.github.com/organizations/1/team/2343027/discussions/1/comments */ - comments_url: string; + comments_url: string /** * Format: date-time * @example 2018-01-25T18:56:31Z */ - created_at: string; + created_at: string /** Format: date-time */ - last_edited_at: string | null; + last_edited_at: string | null /** * Format: uri * @example https://github.com/orgs/github/teams/justice-league/discussions/1 */ - html_url: string; + html_url: string /** @example MDE0OlRlYW1EaXNjdXNzaW9uMQ== */ - node_id: string; + node_id: string /** * @description The unique sequence number of a team discussion. * @example 42 */ - number: number; + number: number /** * @description Whether or not this discussion should be pinned for easy retrieval. * @example true */ - pinned: boolean; + pinned: boolean /** * @description Whether or not this discussion should be restricted to team members and organization administrators. * @example true */ - private: boolean; + private: boolean /** * Format: uri * @example https://api.github.com/organizations/1/team/2343027 */ - team_url: string; + team_url: string /** * @description The title of the discussion. * @example How can we improve our workflow? */ - title: string; + title: string /** * Format: date-time * @example 2018-01-25T18:56:31Z */ - updated_at: string; + updated_at: string /** * Format: uri * @example https://api.github.com/organizations/1/team/2343027/discussions/1 */ - url: string; - reactions?: components["schemas"]["reaction-rollup"]; - }; + url: string + reactions?: components['schemas']['reaction-rollup'] + } /** * Team Discussion Comment * @description A reply to a discussion within a team. */ - "team-discussion-comment": { - author: components["schemas"]["nullable-simple-user"]; + 'team-discussion-comment': { + author: components['schemas']['nullable-simple-user'] /** * @description The main text of the comment. * @example I agree with this suggestion. */ - body: string; + body: string /** @example

Do you like apples?

*/ - body_html: string; + body_html: string /** * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server. * @example 0307116bbf7ced493b8d8a346c650b71 */ - body_version: string; + body_version: string /** * Format: date-time * @example 2018-01-15T23:53:58Z */ - created_at: string; + created_at: string /** Format: date-time */ - last_edited_at: string | null; + last_edited_at: string | null /** * Format: uri * @example https://api.github.com/organizations/1/team/2403582/discussions/1 */ - discussion_url: string; + discussion_url: string /** * Format: uri * @example https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 */ - html_url: string; + html_url: string /** @example MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= */ - node_id: string; + node_id: string /** * @description The unique sequence number of a team discussion comment. * @example 42 */ - number: number; + number: number /** * Format: date-time * @example 2018-01-15T23:53:58Z */ - updated_at: string; + updated_at: string /** * Format: uri * @example https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 */ - url: string; - reactions?: components["schemas"]["reaction-rollup"]; - }; + url: string + reactions?: components['schemas']['reaction-rollup'] + } /** * Reaction * @description Reactions to conversations provide a way to help people express their feelings more simply and effectively. */ reaction: { /** @example 1 */ - id: number; + id: number /** @example MDg6UmVhY3Rpb24x */ - node_id: string; - user: components["schemas"]["nullable-simple-user"]; + node_id: string + user: components['schemas']['nullable-simple-user'] /** * @description The reaction to use * @example heart * @enum {string} */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' /** * Format: date-time * @example 2016-05-20T20:09:31Z */ - created_at: string; - }; + created_at: string + } /** * Team Membership * @description Team Membership */ - "team-membership": { + 'team-membership': { /** Format: uri */ - url: string; + url: string /** * @description The role of the user in the team. * @default member * @example member * @enum {string} */ - role: "member" | "maintainer"; + role: 'member' | 'maintainer' /** * @description The state of the user's membership in the team. * @enum {string} */ - state: "active" | "pending"; - }; + state: 'active' | 'pending' + } /** * Team Project * @description A team's access to a project. */ - "team-project": { - owner_url: string; - url: string; - html_url: string; - columns_url: string; - id: number; - node_id: string; - name: string; - body: string | null; - number: number; - state: string; - creator: components["schemas"]["simple-user"]; - created_at: string; - updated_at: string; + 'team-project': { + owner_url: string + url: string + html_url: string + columns_url: string + id: number + node_id: string + name: string + body: string | null + number: number + state: string + creator: components['schemas']['simple-user'] + created_at: string + updated_at: string /** @description The organization permission for this project. Only present when owner is an organization. */ - organization_permission?: string; + organization_permission?: string /** @description Whether the project is private or not. Only present when owner is an organization. */ - private?: boolean; + private?: boolean permissions: { - read: boolean; - write: boolean; - admin: boolean; - }; - }; + read: boolean + write: boolean + admin: boolean + } + } /** * Team Repository * @description A team's access to a repository. */ - "team-repository": { + 'team-repository': { /** * @description Unique identifier of the repository * @example 42 */ - id: number; + id: number /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - node_id: string; + node_id: string /** * @description The name of the repository. * @example Team Environment */ - name: string; + name: string /** @example octocat/Hello-World */ - full_name: string; - license: components["schemas"]["nullable-license-simple"]; - forks: number; + full_name: string + license: components['schemas']['nullable-license-simple'] + forks: number permissions?: { - admin: boolean; - pull: boolean; - triage?: boolean; - push: boolean; - maintain?: boolean; - }; + admin: boolean + pull: boolean + triage?: boolean + push: boolean + maintain?: boolean + } /** @example admin */ - role_name?: string; - owner: components["schemas"]["nullable-simple-user"]; + role_name?: string + owner: components['schemas']['nullable-simple-user'] /** @description Whether the repository is private or public. */ - private: boolean; + private: boolean /** * Format: uri * @example https://github.com/octocat/Hello-World */ - html_url: string; + html_url: string /** @example This your first repo! */ - description: string | null; - fork: boolean; + description: string | null + fork: boolean /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World */ - url: string; + url: string /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - archive_url: string; + archive_url: string /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - assignees_url: string; + assignees_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - blobs_url: string; + blobs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - branches_url: string; + branches_url: string /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - collaborators_url: string; + collaborators_url: string /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - comments_url: string; + comments_url: string /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - commits_url: string; + commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - compare_url: string; + compare_url: string /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - contents_url: string; + contents_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - contributors_url: string; + contributors_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - deployments_url: string; + deployments_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - downloads_url: string; + downloads_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events */ - events_url: string; + events_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ - forks_url: string; + forks_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - git_commits_url: string; + git_commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - git_refs_url: string; + git_refs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - git_tags_url: string; + git_tags_url: string /** @example git:github.com/octocat/Hello-World.git */ - git_url: string; + git_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - issue_comment_url: string; + issue_comment_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - issue_events_url: string; + issue_events_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - issues_url: string; + issues_url: string /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - keys_url: string; + keys_url: string /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - labels_url: string; + labels_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ - languages_url: string; + languages_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ - merges_url: string; + merges_url: string /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - milestones_url: string; + milestones_url: string /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - notifications_url: string; + notifications_url: string /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - pulls_url: string; + pulls_url: string /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - releases_url: string; + releases_url: string /** @example git@github.com:octocat/Hello-World.git */ - ssh_url: string; + ssh_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - stargazers_url: string; + stargazers_url: string /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - statuses_url: string; + statuses_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - subscribers_url: string; + subscribers_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - subscription_url: string; + subscription_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ - tags_url: string; + tags_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ - teams_url: string; + teams_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - trees_url: string; + trees_url: string /** @example https://github.com/octocat/Hello-World.git */ - clone_url: string; + clone_url: string /** * Format: uri * @example git:git.example.com/octocat/Hello-World */ - mirror_url: string | null; + mirror_url: string | null /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - hooks_url: string; + hooks_url: string /** * Format: uri * @example https://svn.github.com/octocat/Hello-World */ - svn_url: string; + svn_url: string /** * Format: uri * @example https://github.com */ - homepage: string | null; - language: string | null; + homepage: string | null + language: string | null /** @example 9 */ - forks_count: number; + forks_count: number /** @example 80 */ - stargazers_count: number; + stargazers_count: number /** @example 80 */ - watchers_count: number; + watchers_count: number /** @example 108 */ - size: number; + size: number /** * @description The default branch of the repository. * @example master */ - default_branch: string; - open_issues_count: number; + default_branch: string + open_issues_count: number /** * @description Whether this repository acts as a template that can be used to generate new repositories. * @example true */ - is_template?: boolean; - topics?: string[]; + is_template?: boolean + topics?: string[] /** * @description Whether issues are enabled. * @default true * @example true */ - has_issues: boolean; + has_issues: boolean /** * @description Whether projects are enabled. * @default true * @example true */ - has_projects: boolean; + has_projects: boolean /** * @description Whether the wiki is enabled. * @default true * @example true */ - has_wiki: boolean; - has_pages: boolean; + has_wiki: boolean + has_pages: boolean /** * @description Whether downloads are enabled. * @default true * @example true */ - has_downloads: boolean; + has_downloads: boolean /** @description Whether the repository is archived. */ - archived: boolean; + archived: boolean /** @description Returns whether or not this repository disabled. */ - disabled: boolean; + disabled: boolean /** * @description The repository visibility: public, private, or internal. * @default public */ - visibility?: string; + visibility?: string /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - pushed_at: string | null; + pushed_at: string | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - created_at: string | null; + created_at: string | null /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - updated_at: string | null; + updated_at: string | null /** * @description Whether to allow rebase merges for pull requests. * @default true * @example true */ - allow_rebase_merge?: boolean; - template_repository?: components["schemas"]["nullable-repository"]; - temp_clone_token?: string; + allow_rebase_merge?: boolean + template_repository?: components['schemas']['nullable-repository'] + temp_clone_token?: string /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - allow_squash_merge?: boolean; + allow_squash_merge?: boolean /** @description Whether to allow Auto-merge to be used on pull requests. */ - allow_auto_merge?: boolean; + allow_auto_merge?: boolean /** @description Whether to delete head branches when pull requests are merged */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge?: boolean /** * @description Whether to allow merge commits for pull requests. * @default true * @example true */ - allow_merge_commit?: boolean; + allow_merge_commit?: boolean /** @description Whether to allow forking this repo */ - allow_forking?: boolean; - subscribers_count?: number; - network_count?: number; - open_issues: number; - watchers: number; - master_branch?: string; - }; + allow_forking?: boolean + subscribers_count?: number + network_count?: number + open_issues: number + watchers: number + master_branch?: string + } /** * Project Card * @description Project cards represent a scope of work. */ - "project-card": { + 'project-card': { /** * Format: uri * @example https://api.github.com/projects/columns/cards/1478 */ - url: string; + url: string /** * @description The project card's ID * @example 42 */ - id: number; + id: number /** @example MDExOlByb2plY3RDYXJkMTQ3OA== */ - node_id: string; + node_id: string /** @example Add payload for delete Project column */ - note: string | null; - creator: components["schemas"]["nullable-simple-user"]; + note: string | null + creator: components['schemas']['nullable-simple-user'] /** * Format: date-time * @example 2016-09-05T14:21:06Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2016-09-05T14:20:22Z */ - updated_at: string; + updated_at: string /** @description Whether or not the card is archived */ - archived?: boolean; - column_name?: string; - project_id?: string; + archived?: boolean + column_name?: string + project_id?: string /** * Format: uri * @example https://api.github.com/projects/columns/367 */ - column_url: string; + column_url: string /** * Format: uri * @example https://api.github.com/repos/api-playground/projects-test/issues/3 */ - content_url?: string; + content_url?: string /** * Format: uri * @example https://api.github.com/projects/120 */ - project_url: string; - }; + project_url: string + } /** * Project Column * @description Project columns contain cards of work. */ - "project-column": { + 'project-column': { /** * Format: uri * @example https://api.github.com/projects/columns/367 */ - url: string; + url: string /** * Format: uri * @example https://api.github.com/projects/120 */ - project_url: string; + project_url: string /** * Format: uri * @example https://api.github.com/projects/columns/367/cards */ - cards_url: string; + cards_url: string /** * @description The unique identifier of the project column * @example 42 */ - id: number; + id: number /** @example MDEzOlByb2plY3RDb2x1bW4zNjc= */ - node_id: string; + node_id: string /** * @description Name of the project column * @example Remaining tasks */ - name: string; + name: string /** * Format: date-time * @example 2016-09-05T14:18:44Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2016-09-05T14:22:28Z */ - updated_at: string; - }; + updated_at: string + } /** * Project Collaborator Permission * @description Project Collaborator Permission */ - "project-collaborator-permission": { - permission: string; - user: components["schemas"]["nullable-simple-user"]; - }; + 'project-collaborator-permission': { + permission: string + user: components['schemas']['nullable-simple-user'] + } /** Rate Limit */ - "rate-limit": { - limit: number; - remaining: number; - reset: number; - used: number; - }; + 'rate-limit': { + limit: number + remaining: number + reset: number + used: number + } /** * Rate Limit Overview * @description Rate Limit Overview */ - "rate-limit-overview": { + 'rate-limit-overview': { resources: { - core: components["schemas"]["rate-limit"]; - graphql?: components["schemas"]["rate-limit"]; - search: components["schemas"]["rate-limit"]; - source_import?: components["schemas"]["rate-limit"]; - integration_manifest?: components["schemas"]["rate-limit"]; - code_scanning_upload?: components["schemas"]["rate-limit"]; - actions_runner_registration?: components["schemas"]["rate-limit"]; - scim?: components["schemas"]["rate-limit"]; - }; - rate: components["schemas"]["rate-limit"]; - }; + core: components['schemas']['rate-limit'] + graphql?: components['schemas']['rate-limit'] + search: components['schemas']['rate-limit'] + source_import?: components['schemas']['rate-limit'] + integration_manifest?: components['schemas']['rate-limit'] + code_scanning_upload?: components['schemas']['rate-limit'] + actions_runner_registration?: components['schemas']['rate-limit'] + scim?: components['schemas']['rate-limit'] + } + rate: components['schemas']['rate-limit'] + } /** * Code Of Conduct Simple * @description Code of Conduct Simple */ - "code-of-conduct-simple": { + 'code-of-conduct-simple': { /** * Format: uri * @example https://api.github.com/repos/github/docs/community/code_of_conduct */ - url: string; + url: string /** @example citizen_code_of_conduct */ - key: string; + key: string /** @example Citizen Code of Conduct */ - name: string; + name: string /** * Format: uri * @example https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md */ - html_url: string | null; - }; + html_url: string | null + } /** * Full Repository * @description Full Repository */ - "full-repository": { + 'full-repository': { /** @example 1296269 */ - id: number; + id: number /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - node_id: string; + node_id: string /** @example Hello-World */ - name: string; + name: string /** @example octocat/Hello-World */ - full_name: string; - owner: components["schemas"]["simple-user"]; - private: boolean; + full_name: string + owner: components['schemas']['simple-user'] + private: boolean /** * Format: uri * @example https://github.com/octocat/Hello-World */ - html_url: string; + html_url: string /** @example This your first repo! */ - description: string | null; - fork: boolean; + description: string | null + fork: boolean /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World */ - url: string; + url: string /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - archive_url: string; + archive_url: string /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - assignees_url: string; + assignees_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - blobs_url: string; + blobs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - branches_url: string; + branches_url: string /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - collaborators_url: string; + collaborators_url: string /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - comments_url: string; + comments_url: string /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - commits_url: string; + commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - compare_url: string; + compare_url: string /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - contents_url: string; + contents_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - contributors_url: string; + contributors_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - deployments_url: string; + deployments_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - downloads_url: string; + downloads_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events */ - events_url: string; + events_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ - forks_url: string; + forks_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - git_commits_url: string; + git_commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - git_refs_url: string; + git_refs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - git_tags_url: string; + git_tags_url: string /** @example git:github.com/octocat/Hello-World.git */ - git_url: string; + git_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - issue_comment_url: string; + issue_comment_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - issue_events_url: string; + issue_events_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - issues_url: string; + issues_url: string /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - keys_url: string; + keys_url: string /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - labels_url: string; + labels_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ - languages_url: string; + languages_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ - merges_url: string; + merges_url: string /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - milestones_url: string; + milestones_url: string /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - notifications_url: string; + notifications_url: string /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - pulls_url: string; + pulls_url: string /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - releases_url: string; + releases_url: string /** @example git@github.com:octocat/Hello-World.git */ - ssh_url: string; + ssh_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - stargazers_url: string; + stargazers_url: string /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - statuses_url: string; + statuses_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - subscribers_url: string; + subscribers_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - subscription_url: string; + subscription_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ - tags_url: string; + tags_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ - teams_url: string; + teams_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - trees_url: string; + trees_url: string /** @example https://github.com/octocat/Hello-World.git */ - clone_url: string; + clone_url: string /** * Format: uri * @example git:git.example.com/octocat/Hello-World */ - mirror_url: string | null; + mirror_url: string | null /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - hooks_url: string; + hooks_url: string /** * Format: uri * @example https://svn.github.com/octocat/Hello-World */ - svn_url: string; + svn_url: string /** * Format: uri * @example https://github.com */ - homepage: string | null; - language: string | null; + homepage: string | null + language: string | null /** @example 9 */ - forks_count: number; + forks_count: number /** @example 80 */ - stargazers_count: number; + stargazers_count: number /** @example 80 */ - watchers_count: number; + watchers_count: number /** @example 108 */ - size: number; + size: number /** @example master */ - default_branch: string; - open_issues_count: number; + default_branch: string + open_issues_count: number /** @example true */ - is_template?: boolean; + is_template?: boolean /** @example octocat,atom,electron,API */ - topics?: string[]; + topics?: string[] /** @example true */ - has_issues: boolean; + has_issues: boolean /** @example true */ - has_projects: boolean; + has_projects: boolean /** @example true */ - has_wiki: boolean; - has_pages: boolean; + has_wiki: boolean + has_pages: boolean /** @example true */ - has_downloads: boolean; - archived: boolean; + has_downloads: boolean + archived: boolean /** @description Returns whether or not this repository disabled. */ - disabled: boolean; + disabled: boolean /** * @description The repository visibility: public, private, or internal. * @example public */ - visibility?: string; + visibility?: string /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - pushed_at: string; + pushed_at: string /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - updated_at: string; + updated_at: string permissions?: { - admin: boolean; - maintain?: boolean; - push: boolean; - triage?: boolean; - pull: boolean; - }; + admin: boolean + maintain?: boolean + push: boolean + triage?: boolean + pull: boolean + } /** @example true */ - allow_rebase_merge?: boolean; - template_repository?: components["schemas"]["nullable-repository"]; - temp_clone_token?: string | null; + allow_rebase_merge?: boolean + template_repository?: components['schemas']['nullable-repository'] + temp_clone_token?: string | null /** @example true */ - allow_squash_merge?: boolean; - allow_auto_merge?: boolean; - delete_branch_on_merge?: boolean; + allow_squash_merge?: boolean + allow_auto_merge?: boolean + delete_branch_on_merge?: boolean /** @example true */ - allow_merge_commit?: boolean; + allow_merge_commit?: boolean /** @example true */ - allow_forking?: boolean; + allow_forking?: boolean /** @example 42 */ - subscribers_count: number; - network_count: number; - license: components["schemas"]["nullable-license-simple"]; - organization?: components["schemas"]["nullable-simple-user"]; - parent?: components["schemas"]["repository"]; - source?: components["schemas"]["repository"]; - forks: number; - master_branch?: string; - open_issues: number; - watchers: number; + subscribers_count: number + network_count: number + license: components['schemas']['nullable-license-simple'] + organization?: components['schemas']['nullable-simple-user'] + parent?: components['schemas']['repository'] + source?: components['schemas']['repository'] + forks: number + master_branch?: string + open_issues: number + watchers: number /** * @description Whether anonymous git access is allowed. * @default true */ - anonymous_access_enabled?: boolean; - code_of_conduct?: components["schemas"]["code-of-conduct-simple"]; + anonymous_access_enabled?: boolean + code_of_conduct?: components['schemas']['code-of-conduct-simple'] security_and_analysis?: { advanced_security?: { /** @enum {string} */ - status?: "enabled" | "disabled"; - }; + status?: 'enabled' | 'disabled' + } secret_scanning?: { /** @enum {string} */ - status?: "enabled" | "disabled"; - }; - } | null; - }; + status?: 'enabled' | 'disabled' + } + } | null + } /** * Artifact * @description An artifact */ artifact: { /** @example 5 */ - id: number; + id: number /** @example MDEwOkNoZWNrU3VpdGU1 */ - node_id: string; + node_id: string /** * @description The name of the artifact. * @example AdventureWorks.Framework */ - name: string; + name: string /** * @description The size in bytes of the artifact. * @example 12345 */ - size_in_bytes: number; + size_in_bytes: number /** @example https://api.github.com/repos/github/hello-world/actions/artifacts/5 */ - url: string; + url: string /** @example https://api.github.com/repos/github/hello-world/actions/artifacts/5/zip */ - archive_download_url: string; + archive_download_url: string /** @description Whether or not the artifact has expired. */ - expired: boolean; + expired: boolean /** Format: date-time */ - created_at: string | null; + created_at: string | null /** Format: date-time */ - expires_at: string | null; + expires_at: string | null /** Format: date-time */ - updated_at: string | null; - }; + updated_at: string | null + } /** * Job * @description Information of a job execution in a workflow run @@ -11286,58 +11278,58 @@ export type components = { * @description The id of the job. * @example 21 */ - id: number; + id: number /** * @description The id of the associated workflow run. * @example 5 */ - run_id: number; + run_id: number /** @example https://api.github.com/repos/github/hello-world/actions/runs/5 */ - run_url: string; + run_url: string /** * @description Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run. * @example 1 */ - run_attempt?: number; + run_attempt?: number /** @example MDg6Q2hlY2tSdW40 */ - node_id: string; + node_id: string /** * @description The SHA of the commit that is being run. * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d */ - head_sha: string; + head_sha: string /** @example https://api.github.com/repos/github/hello-world/actions/jobs/21 */ - url: string; + url: string /** @example https://github.com/github/hello-world/runs/4 */ - html_url: string | null; + html_url: string | null /** * @description The phase of the lifecycle that the job is currently in. * @example queued * @enum {string} */ - status: "queued" | "in_progress" | "completed"; + status: 'queued' | 'in_progress' | 'completed' /** * @description The outcome of the job. * @example success */ - conclusion: string | null; + conclusion: string | null /** * Format: date-time * @description The time that the job started, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 */ - started_at: string; + started_at: string /** * Format: date-time * @description The time that the job finished, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 */ - completed_at: string | null; + completed_at: string | null /** * @description The name of the job. * @example test-coverage */ - name: string; + name: string /** @description Steps in this job. */ steps?: { /** @@ -11345,328 +11337,328 @@ export type components = { * @example queued * @enum {string} */ - status: "queued" | "in_progress" | "completed"; + status: 'queued' | 'in_progress' | 'completed' /** * @description The outcome of the job. * @example success */ - conclusion: string | null; + conclusion: string | null /** * @description The name of the job. * @example test-coverage */ - name: string; + name: string /** @example 1 */ - number: number; + number: number /** * Format: date-time * @description The time that the step started, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 */ - started_at?: string | null; + started_at?: string | null /** * Format: date-time * @description The time that the job finished, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 */ - completed_at?: string | null; - }[]; + completed_at?: string | null + }[] /** @example https://api.github.com/repos/github/hello-world/check-runs/4 */ - check_run_url: string; + check_run_url: string /** * @description Labels for the workflow job. Specified by the "runs_on" attribute in the action's workflow file. * @example self-hosted,foo,bar */ - labels: string[]; + labels: string[] /** * @description The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example 1 */ - runner_id: number | null; + runner_id: number | null /** * @description The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example my runner */ - runner_name: string | null; + runner_name: string | null /** * @description The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example 2 */ - runner_group_id: number | null; + runner_group_id: number | null /** * @description The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example my runner group */ - runner_group_name: string | null; - }; + runner_group_name: string | null + } /** @description Whether GitHub Actions is enabled on the repository. */ - "actions-enabled": boolean; - "actions-repository-permissions": { - enabled: components["schemas"]["actions-enabled"]; - allowed_actions?: components["schemas"]["allowed-actions"]; - selected_actions_url?: components["schemas"]["selected-actions-url"]; - }; + 'actions-enabled': boolean + 'actions-repository-permissions': { + enabled: components['schemas']['actions-enabled'] + allowed_actions?: components['schemas']['allowed-actions'] + selected_actions_url?: components['schemas']['selected-actions-url'] + } /** Pull Request Minimal */ - "pull-request-minimal": { - id: number; - number: number; - url: string; + 'pull-request-minimal': { + id: number + number: number + url: string head: { - ref: string; - sha: string; + ref: string + sha: string repo: { - id: number; - url: string; - name: string; - }; - }; + id: number + url: string + name: string + } + } base: { - ref: string; - sha: string; + ref: string + sha: string repo: { - id: number; - url: string; - name: string; - }; - }; - }; + id: number + url: string + name: string + } + } + } /** * Simple Commit * @description Simple Commit */ - "nullable-simple-commit": { - id: string; - tree_id: string; - message: string; + 'nullable-simple-commit': { + id: string + tree_id: string + message: string /** Format: date-time */ - timestamp: string; + timestamp: string author: { - name: string; - email: string; - } | null; + name: string + email: string + } | null committer: { - name: string; - email: string; - } | null; - } | null; + name: string + email: string + } | null + } | null /** * Workflow Run * @description An invocation of a workflow */ - "workflow-run": { + 'workflow-run': { /** * @description The ID of the workflow run. * @example 5 */ - id: number; + id: number /** * @description The name of the workflow run. * @example Build */ - name?: string | null; + name?: string | null /** @example MDEwOkNoZWNrU3VpdGU1 */ - node_id: string; + node_id: string /** * @description The ID of the associated check suite. * @example 42 */ - check_suite_id?: number; + check_suite_id?: number /** * @description The node ID of the associated check suite. * @example MDEwOkNoZWNrU3VpdGU0Mg== */ - check_suite_node_id?: string; + check_suite_node_id?: string /** @example master */ - head_branch: string | null; + head_branch: string | null /** * @description The SHA of the head commit that points to the version of the worflow being run. * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d */ - head_sha: string; + head_sha: string /** * @description The auto incrementing run number for the workflow run. * @example 106 */ - run_number: number; + run_number: number /** * @description Attempt number of the run, 1 for first attempt and higher if the workflow was re-run. * @example 1 */ - run_attempt?: number; + run_attempt?: number /** @example push */ - event: string; + event: string /** @example completed */ - status: string | null; + status: string | null /** @example neutral */ - conclusion: string | null; + conclusion: string | null /** * @description The ID of the parent workflow. * @example 5 */ - workflow_id: number; + workflow_id: number /** * @description The URL to the workflow run. * @example https://api.github.com/repos/github/hello-world/actions/runs/5 */ - url: string; + url: string /** @example https://github.com/github/hello-world/suites/4 */ - html_url: string; - pull_requests: components["schemas"]["pull-request-minimal"][] | null; + html_url: string + pull_requests: components['schemas']['pull-request-minimal'][] | null /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; + updated_at: string /** * Format: date-time * @description The start time of the latest run. Resets on re-run. */ - run_started_at?: string; + run_started_at?: string /** * @description The URL to the jobs for the workflow run. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/jobs */ - jobs_url: string; + jobs_url: string /** * @description The URL to download the logs for the workflow run. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/logs */ - logs_url: string; + logs_url: string /** * @description The URL to the associated check suite. * @example https://api.github.com/repos/github/hello-world/check-suites/12 */ - check_suite_url: string; + check_suite_url: string /** * @description The URL to the artifacts for the workflow run. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts */ - artifacts_url: string; + artifacts_url: string /** * @description The URL to cancel the workflow run. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/cancel */ - cancel_url: string; + cancel_url: string /** * @description The URL to rerun the workflow run. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/rerun */ - rerun_url: string; + rerun_url: string /** * @description The URL to the previous attempted run of this workflow, if one exists. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3 */ - previous_attempt_url?: string | null; + previous_attempt_url?: string | null /** * @description The URL to the workflow. * @example https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml */ - workflow_url: string; - head_commit: components["schemas"]["nullable-simple-commit"]; - repository: components["schemas"]["minimal-repository"]; - head_repository: components["schemas"]["minimal-repository"]; + workflow_url: string + head_commit: components['schemas']['nullable-simple-commit'] + repository: components['schemas']['minimal-repository'] + head_repository: components['schemas']['minimal-repository'] /** @example 5 */ - head_repository_id?: number; - }; + head_repository_id?: number + } /** * Environment Approval * @description An entry in the reviews log for environment deployments */ - "environment-approvals": { + 'environment-approvals': { /** @description The list of environments that were approved or rejected */ environments: { /** * @description The id of the environment. * @example 56780428 */ - id?: number; + id?: number /** @example MDExOkVudmlyb25tZW50NTY3ODA0Mjg= */ - node_id?: string; + node_id?: string /** * @description The name of the environment. * @example staging */ - name?: string; + name?: string /** @example https://api.github.com/repos/github/hello-world/environments/staging */ - url?: string; + url?: string /** @example https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging */ - html_url?: string; + html_url?: string /** * Format: date-time * @description The time that the environment was created, in ISO 8601 format. * @example 2020-11-23T22:00:40Z */ - created_at?: string; + created_at?: string /** * Format: date-time * @description The time that the environment was last updated, in ISO 8601 format. * @example 2020-11-23T22:00:40Z */ - updated_at?: string; - }[]; + updated_at?: string + }[] /** * @description Whether deployment to the environment(s) was approved or rejected * @example approved * @enum {string} */ - state: "approved" | "rejected"; - user: components["schemas"]["simple-user"]; + state: 'approved' | 'rejected' + user: components['schemas']['simple-user'] /** * @description The comment submitted with the deployment review * @example Ship it! */ - comment: string; - }; + comment: string + } /** * @description The type of reviewer. Must be one of: `User` or `Team` * @example User * @enum {string} */ - "deployment-reviewer-type": "User" | "Team"; + 'deployment-reviewer-type': 'User' | 'Team' /** * Pending Deployment * @description Details of a deployment that is waiting for protection rules to pass */ - "pending-deployment": { + 'pending-deployment': { environment: { /** * @description The id of the environment. * @example 56780428 */ - id?: number; + id?: number /** @example MDExOkVudmlyb25tZW50NTY3ODA0Mjg= */ - node_id?: string; + node_id?: string /** * @description The name of the environment. * @example staging */ - name?: string; + name?: string /** @example https://api.github.com/repos/github/hello-world/environments/staging */ - url?: string; + url?: string /** @example https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging */ - html_url?: string; - }; + html_url?: string + } /** * @description The set duration of the wait timer * @example 30 */ - wait_timer: number; + wait_timer: number /** * Format: date-time * @description The time that the wait timer began. * @example 2020-11-23T22:00:40Z */ - wait_timer_started_at: string | null; + wait_timer_started_at: string | null /** * @description Whether the currently authenticated user can approve the deployment * @example true */ - current_user_can_approve: boolean; + current_user_can_approve: boolean /** @description The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */ reviewers: { - type?: components["schemas"]["deployment-reviewer-type"]; - reviewer?: Partial & Partial; - }[]; - }; + type?: components['schemas']['deployment-reviewer-type'] + reviewer?: Partial & Partial + }[] + } /** * Deployment * @description A request for a specific ref(branch,sha,tag) to be deployed @@ -11676,469 +11668,469 @@ export type components = { * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1 */ - url: string; + url: string /** * @description Unique identifier of the deployment * @example 42 */ - id: number; + id: number /** @example MDEwOkRlcGxveW1lbnQx */ - node_id: string; + node_id: string /** @example a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d */ - sha: string; + sha: string /** * @description The ref to deploy. This can be a branch, tag, or sha. * @example topic-branch */ - ref: string; + ref: string /** * @description Parameter to specify a task to execute * @example deploy */ - task: string; - payload: { [key: string]: unknown } | string; + task: string + payload: { [key: string]: unknown } | string /** @example staging */ - original_environment?: string; + original_environment?: string /** * @description Name for the target deployment environment. * @example production */ - environment: string; + environment: string /** @example Deploy request from hubot */ - description: string | null; - creator: components["schemas"]["nullable-simple-user"]; + description: string | null + creator: components['schemas']['nullable-simple-user'] /** * Format: date-time * @example 2012-07-20T01:19:13Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2012-07-20T01:19:13Z */ - updated_at: string; + updated_at: string /** * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1/statuses */ - statuses_url: string; + statuses_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/example */ - repository_url: string; + repository_url: string /** * @description Specifies if the given environment is will no longer exist at some point in the future. Default: false. * @example true */ - transient_environment?: boolean; + transient_environment?: boolean /** * @description Specifies if the given environment is one that end-users directly interact with. Default: false. * @example true */ - production_environment?: boolean; - performed_via_github_app?: components["schemas"]["nullable-integration"]; - }; + production_environment?: boolean + performed_via_github_app?: components['schemas']['nullable-integration'] + } /** * Workflow Run Usage * @description Workflow Run Usage */ - "workflow-run-usage": { + 'workflow-run-usage': { billable: { UBUNTU?: { - total_ms: number; - jobs: number; + total_ms: number + jobs: number job_runs?: { - job_id: number; - duration_ms: number; - }[]; - }; + job_id: number + duration_ms: number + }[] + } MACOS?: { - total_ms: number; - jobs: number; + total_ms: number + jobs: number job_runs?: { - job_id: number; - duration_ms: number; - }[]; - }; + job_id: number + duration_ms: number + }[] + } WINDOWS?: { - total_ms: number; - jobs: number; + total_ms: number + jobs: number job_runs?: { - job_id: number; - duration_ms: number; - }[]; - }; - }; - run_duration_ms?: number; - }; + job_id: number + duration_ms: number + }[] + } + } + run_duration_ms?: number + } /** * Actions Secret * @description Set secrets for GitHub Actions. */ - "actions-secret": { + 'actions-secret': { /** * @description The name of the secret. * @example SECRET_TOKEN */ - name: string; + name: string /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - }; + updated_at: string + } /** * Workflow * @description A GitHub Actions workflow */ workflow: { /** @example 5 */ - id: number; + id: number /** @example MDg6V29ya2Zsb3cxMg== */ - node_id: string; + node_id: string /** @example CI */ - name: string; + name: string /** @example ruby.yaml */ - path: string; + path: string /** * @example active * @enum {string} */ - state: "active" | "deleted" | "disabled_fork" | "disabled_inactivity" | "disabled_manually"; + state: 'active' | 'deleted' | 'disabled_fork' | 'disabled_inactivity' | 'disabled_manually' /** * Format: date-time * @example 2019-12-06T14:20:20.000Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2019-12-06T14:20:20.000Z */ - updated_at: string; + updated_at: string /** @example https://api.github.com/repos/actions/setup-ruby/workflows/5 */ - url: string; + url: string /** @example https://github.com/actions/setup-ruby/blob/master/.github/workflows/ruby.yaml */ - html_url: string; + html_url: string /** @example https://github.com/actions/setup-ruby/workflows/CI/badge.svg */ - badge_url: string; + badge_url: string /** * Format: date-time * @example 2019-12-06T14:20:20.000Z */ - deleted_at?: string; - }; + deleted_at?: string + } /** * Workflow Usage * @description Workflow Usage */ - "workflow-usage": { + 'workflow-usage': { billable: { UBUNTU?: { - total_ms?: number; - }; + total_ms?: number + } MACOS?: { - total_ms?: number; - }; + total_ms?: number + } WINDOWS?: { - total_ms?: number; - }; - }; - }; + total_ms?: number + } + } + } /** * Autolink reference * @description An autolink reference. */ autolink: { /** @example 3 */ - id: number; + id: number /** * @description The prefix of a key that is linkified. * @example TICKET- */ - key_prefix: string; + key_prefix: string /** * @description A template for the target URL that is generated if a key was found. * @example https://example.com/TICKET?query= */ - url_template: string; - }; + url_template: string + } /** * Protected Branch Required Status Check * @description Protected Branch Required Status Check */ - "protected-branch-required-status-check": { - url?: string; - enforcement_level?: string; - contexts: string[]; + 'protected-branch-required-status-check': { + url?: string + enforcement_level?: string + contexts: string[] checks: { - context: string; - app_id: number | null; - }[]; - contexts_url?: string; - strict?: boolean; - }; + context: string + app_id: number | null + }[] + contexts_url?: string + strict?: boolean + } /** * Protected Branch Admin Enforced * @description Protected Branch Admin Enforced */ - "protected-branch-admin-enforced": { + 'protected-branch-admin-enforced': { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins */ - url: string; + url: string /** @example true */ - enabled: boolean; - }; + enabled: boolean + } /** * Protected Branch Pull Request Review * @description Protected Branch Pull Request Review */ - "protected-branch-pull-request-review": { + 'protected-branch-pull-request-review': { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions */ - url?: string; + url?: string dismissal_restrictions?: { /** @description The list of users with review dismissal access. */ - users?: components["schemas"]["simple-user"][]; + users?: components['schemas']['simple-user'][] /** @description The list of teams with review dismissal access. */ - teams?: components["schemas"]["team"][]; + teams?: components['schemas']['team'][] /** @example "https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions" */ - url?: string; + url?: string /** @example "https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users" */ - users_url?: string; + users_url?: string /** @example "https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams" */ - teams_url?: string; - }; + teams_url?: string + } /** @description Allow specific users or teams to bypass pull request requirements. Set to `null` to disable. */ bypass_pull_request_allowances?: { /** @description The list of users allowed to bypass pull request requirements. */ - users?: components["schemas"]["simple-user"][]; + users?: components['schemas']['simple-user'][] /** @description The list of teams allowed to bypass pull request requirements. */ - teams?: components["schemas"]["team"][]; - } | null; + teams?: components['schemas']['team'][] + } | null /** @example true */ - dismiss_stale_reviews: boolean; + dismiss_stale_reviews: boolean /** @example true */ - require_code_owner_reviews: boolean; + require_code_owner_reviews: boolean /** @example 2 */ - required_approving_review_count?: number; - }; + required_approving_review_count?: number + } /** * Branch Restriction Policy * @description Branch Restriction Policy */ - "branch-restriction-policy": { + 'branch-restriction-policy': { /** Format: uri */ - url: string; + url: string /** Format: uri */ - users_url: string; + users_url: string /** Format: uri */ - teams_url: string; + teams_url: string /** Format: uri */ - apps_url: string; + apps_url: string users: { - login?: string; - id?: number; - node_id?: string; - avatar_url?: string; - gravatar_id?: string; - url?: string; - html_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - starred_url?: string; - subscriptions_url?: string; - organizations_url?: string; - repos_url?: string; - events_url?: string; - received_events_url?: string; - type?: string; - site_admin?: boolean; - }[]; + login?: string + id?: number + node_id?: string + avatar_url?: string + gravatar_id?: string + url?: string + html_url?: string + followers_url?: string + following_url?: string + gists_url?: string + starred_url?: string + subscriptions_url?: string + organizations_url?: string + repos_url?: string + events_url?: string + received_events_url?: string + type?: string + site_admin?: boolean + }[] teams: { - id?: number; - node_id?: string; - url?: string; - html_url?: string; - name?: string; - slug?: string; - description?: string | null; - privacy?: string; - permission?: string; - members_url?: string; - repositories_url?: string; - parent?: string | null; - }[]; + id?: number + node_id?: string + url?: string + html_url?: string + name?: string + slug?: string + description?: string | null + privacy?: string + permission?: string + members_url?: string + repositories_url?: string + parent?: string | null + }[] apps: { - id?: number; - slug?: string; - node_id?: string; + id?: number + slug?: string + node_id?: string owner?: { - login?: string; - id?: number; - node_id?: string; - url?: string; - repos_url?: string; - events_url?: string; - hooks_url?: string; - issues_url?: string; - members_url?: string; - public_members_url?: string; - avatar_url?: string; - description?: string; + login?: string + id?: number + node_id?: string + url?: string + repos_url?: string + events_url?: string + hooks_url?: string + issues_url?: string + members_url?: string + public_members_url?: string + avatar_url?: string + description?: string /** @example "" */ - gravatar_id?: string; + gravatar_id?: string /** @example "https://github.com/testorg-ea8ec76d71c3af4b" */ - html_url?: string; + html_url?: string /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers" */ - followers_url?: string; + followers_url?: string /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}" */ - following_url?: string; + following_url?: string /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}" */ - gists_url?: string; + gists_url?: string /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}" */ - starred_url?: string; + starred_url?: string /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions" */ - subscriptions_url?: string; + subscriptions_url?: string /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs" */ - organizations_url?: string; + organizations_url?: string /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events" */ - received_events_url?: string; + received_events_url?: string /** @example "Organization" */ - type?: string; - site_admin?: boolean; - }; - name?: string; - description?: string; - external_url?: string; - html_url?: string; - created_at?: string; - updated_at?: string; + type?: string + site_admin?: boolean + } + name?: string + description?: string + external_url?: string + html_url?: string + created_at?: string + updated_at?: string permissions?: { - metadata?: string; - contents?: string; - issues?: string; - single_file?: string; - }; - events?: string[]; - }[]; - }; + metadata?: string + contents?: string + issues?: string + single_file?: string + } + events?: string[] + }[] + } /** * Branch Protection * @description Branch Protection */ - "branch-protection": { - url?: string; - enabled?: boolean; - required_status_checks?: components["schemas"]["protected-branch-required-status-check"]; - enforce_admins?: components["schemas"]["protected-branch-admin-enforced"]; - required_pull_request_reviews?: components["schemas"]["protected-branch-pull-request-review"]; - restrictions?: components["schemas"]["branch-restriction-policy"]; + 'branch-protection': { + url?: string + enabled?: boolean + required_status_checks?: components['schemas']['protected-branch-required-status-check'] + enforce_admins?: components['schemas']['protected-branch-admin-enforced'] + required_pull_request_reviews?: components['schemas']['protected-branch-pull-request-review'] + restrictions?: components['schemas']['branch-restriction-policy'] required_linear_history?: { - enabled?: boolean; - }; + enabled?: boolean + } allow_force_pushes?: { - enabled?: boolean; - }; + enabled?: boolean + } allow_deletions?: { - enabled?: boolean; - }; + enabled?: boolean + } required_conversation_resolution?: { - enabled?: boolean; - }; + enabled?: boolean + } /** @example "branch/with/protection" */ - name?: string; + name?: string /** @example "https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection" */ - protection_url?: string; + protection_url?: string required_signatures?: { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures */ - url: string; + url: string /** @example true */ - enabled: boolean; - }; - }; + enabled: boolean + } + } /** * Short Branch * @description Short Branch */ - "short-branch": { - name: string; + 'short-branch': { + name: string commit: { - sha: string; + sha: string /** Format: uri */ - url: string; - }; - protected: boolean; - protection?: components["schemas"]["branch-protection"]; + url: string + } + protected: boolean + protection?: components['schemas']['branch-protection'] /** Format: uri */ - protection_url?: string; - }; + protection_url?: string + } /** * Git User * @description Metaproperties for Git author/committer information. */ - "nullable-git-user": { + 'nullable-git-user': { /** @example "Chris Wanstrath" */ - name?: string; + name?: string /** @example "chris@ozmm.org" */ - email?: string; + email?: string /** @example "2007-10-29T02:42:39.000-07:00" */ - date?: string; - } | null; + date?: string + } | null /** Verification */ verification: { - verified: boolean; - reason: string; - payload: string | null; - signature: string | null; - }; + verified: boolean + reason: string + payload: string | null + signature: string | null + } /** * Diff Entry * @description Diff Entry */ - "diff-entry": { + 'diff-entry': { /** @example bbcd538c8e72b8c175046e27cc8f907076331401 */ - sha: string; + sha: string /** @example file1.txt */ - filename: string; + filename: string /** * @example added * @enum {string} */ - status: "added" | "removed" | "modified" | "renamed" | "copied" | "changed" | "unchanged"; + status: 'added' | 'removed' | 'modified' | 'renamed' | 'copied' | 'changed' | 'unchanged' /** @example 103 */ - additions: number; + additions: number /** @example 21 */ - deletions: number; + deletions: number /** @example 124 */ - changes: number; + changes: number /** * Format: uri * @example https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt */ - blob_url: string; + blob_url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt */ - raw_url: string; + raw_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e */ - contents_url: string; + contents_url: string /** @example @@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test */ - patch?: string; + patch?: string /** @example file.txt */ - previous_filename?: string; - }; + previous_filename?: string + } /** * Commit * @description Commit @@ -12148,1651 +12140,1647 @@ export type components = { * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e */ - url: string; + url: string /** @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */ - sha: string; + sha: string /** @example MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== */ - node_id: string; + node_id: string /** * Format: uri * @example https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments */ - comments_url: string; + comments_url: string commit: { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e */ - url: string; - author: components["schemas"]["nullable-git-user"]; - committer: components["schemas"]["nullable-git-user"]; + url: string + author: components['schemas']['nullable-git-user'] + committer: components['schemas']['nullable-git-user'] /** @example Fix all the bugs */ - message: string; - comment_count: number; + message: string + comment_count: number tree: { /** @example 827efc6d56897b048c772eb4087f854f46256132 */ - sha: string; + sha: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132 */ - url: string; - }; - verification?: components["schemas"]["verification"]; - }; - author: components["schemas"]["nullable-simple-user"]; - committer: components["schemas"]["nullable-simple-user"]; + url: string + } + verification?: components['schemas']['verification'] + } + author: components['schemas']['nullable-simple-user'] + committer: components['schemas']['nullable-simple-user'] parents: { /** @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - sha: string; + sha: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd */ - url: string; + url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd */ - html_url?: string; - }[]; + html_url?: string + }[] stats?: { - additions?: number; - deletions?: number; - total?: number; - }; - files?: components["schemas"]["diff-entry"][]; - }; + additions?: number + deletions?: number + total?: number + } + files?: components['schemas']['diff-entry'][] + } /** * Branch With Protection * @description Branch With Protection */ - "branch-with-protection": { - name: string; - commit: components["schemas"]["commit"]; + 'branch-with-protection': { + name: string + commit: components['schemas']['commit'] _links: { - html: string; + html: string /** Format: uri */ - self: string; - }; - protected: boolean; - protection: components["schemas"]["branch-protection"]; + self: string + } + protected: boolean + protection: components['schemas']['branch-protection'] /** Format: uri */ - protection_url: string; + protection_url: string /** @example "mas*" */ - pattern?: string; + pattern?: string /** @example 1 */ - required_approving_review_count?: number; - }; + required_approving_review_count?: number + } /** * Status Check Policy * @description Status Check Policy */ - "status-check-policy": { + 'status-check-policy': { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks */ - url: string; + url: string /** @example true */ - strict: boolean; + strict: boolean /** @example continuous-integration/travis-ci */ - contexts: string[]; + contexts: string[] checks: { /** @example continuous-integration/travis-ci */ - context: string; - app_id: number | null; - }[]; + context: string + app_id: number | null + }[] /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts */ - contexts_url: string; - }; + contexts_url: string + } /** * Protected Branch * @description Branch protections protect branches */ - "protected-branch": { + 'protected-branch': { /** Format: uri */ - url: string; - required_status_checks?: components["schemas"]["status-check-policy"]; + url: string + required_status_checks?: components['schemas']['status-check-policy'] required_pull_request_reviews?: { /** Format: uri */ - url: string; - dismiss_stale_reviews?: boolean; - require_code_owner_reviews?: boolean; - required_approving_review_count?: number; + url: string + dismiss_stale_reviews?: boolean + require_code_owner_reviews?: boolean + required_approving_review_count?: number dismissal_restrictions?: { /** Format: uri */ - url: string; + url: string /** Format: uri */ - users_url: string; + users_url: string /** Format: uri */ - teams_url: string; - users: components["schemas"]["simple-user"][]; - teams: components["schemas"]["team"][]; - }; + teams_url: string + users: components['schemas']['simple-user'][] + teams: components['schemas']['team'][] + } bypass_pull_request_allowances?: { - users: components["schemas"]["simple-user"][]; - teams: components["schemas"]["team"][]; - }; - }; + users: components['schemas']['simple-user'][] + teams: components['schemas']['team'][] + } + } required_signatures?: { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures */ - url: string; + url: string /** @example true */ - enabled: boolean; - }; + enabled: boolean + } enforce_admins?: { /** Format: uri */ - url: string; - enabled: boolean; - }; + url: string + enabled: boolean + } required_linear_history?: { - enabled: boolean; - }; + enabled: boolean + } allow_force_pushes?: { - enabled: boolean; - }; + enabled: boolean + } allow_deletions?: { - enabled: boolean; - }; - restrictions?: components["schemas"]["branch-restriction-policy"]; + enabled: boolean + } + restrictions?: components['schemas']['branch-restriction-policy'] required_conversation_resolution?: { - enabled?: boolean; - }; - }; + enabled?: boolean + } + } /** * Deployment * @description A deployment created as the result of an Actions check run from a workflow that references an environment */ - "deployment-simple": { + 'deployment-simple': { /** * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1 */ - url: string; + url: string /** * @description Unique identifier of the deployment * @example 42 */ - id: number; + id: number /** @example MDEwOkRlcGxveW1lbnQx */ - node_id: string; + node_id: string /** * @description Parameter to specify a task to execute * @example deploy */ - task: string; + task: string /** @example staging */ - original_environment?: string; + original_environment?: string /** * @description Name for the target deployment environment. * @example production */ - environment: string; + environment: string /** @example Deploy request from hubot */ - description: string | null; + description: string | null /** * Format: date-time * @example 2012-07-20T01:19:13Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2012-07-20T01:19:13Z */ - updated_at: string; + updated_at: string /** * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1/statuses */ - statuses_url: string; + statuses_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/example */ - repository_url: string; + repository_url: string /** * @description Specifies if the given environment is will no longer exist at some point in the future. Default: false. * @example true */ - transient_environment?: boolean; + transient_environment?: boolean /** * @description Specifies if the given environment is one that end-users directly interact with. Default: false. * @example true */ - production_environment?: boolean; - performed_via_github_app?: components["schemas"]["nullable-integration"]; - }; + production_environment?: boolean + performed_via_github_app?: components['schemas']['nullable-integration'] + } /** * CheckRun * @description A check performed on the code of a given code change */ - "check-run": { + 'check-run': { /** * @description The id of the check. * @example 21 */ - id: number; + id: number /** * @description The SHA of the commit that is being checked. * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d */ - head_sha: string; + head_sha: string /** @example MDg6Q2hlY2tSdW40 */ - node_id: string; + node_id: string /** @example 42 */ - external_id: string | null; + external_id: string | null /** @example https://api.github.com/repos/github/hello-world/check-runs/4 */ - url: string; + url: string /** @example https://github.com/github/hello-world/runs/4 */ - html_url: string | null; + html_url: string | null /** @example https://example.com */ - details_url: string | null; + details_url: string | null /** * @description The phase of the lifecycle that the check is currently in. * @example queued * @enum {string} */ - status: "queued" | "in_progress" | "completed"; + status: 'queued' | 'in_progress' | 'completed' /** * @example neutral * @enum {string|null} */ - conclusion: - | ("success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required") - | null; + conclusion: ('success' | 'failure' | 'neutral' | 'cancelled' | 'skipped' | 'timed_out' | 'action_required') | null /** * Format: date-time * @example 2018-05-04T01:14:52Z */ - started_at: string | null; + started_at: string | null /** * Format: date-time * @example 2018-05-04T01:14:52Z */ - completed_at: string | null; + completed_at: string | null output: { - title: string | null; - summary: string | null; - text: string | null; - annotations_count: number; + title: string | null + summary: string | null + text: string | null + annotations_count: number /** Format: uri */ - annotations_url: string; - }; + annotations_url: string + } /** * @description The name of the check. * @example test-coverage */ - name: string; + name: string check_suite: { - id: number; - } | null; - app: components["schemas"]["nullable-integration"]; - pull_requests: components["schemas"]["pull-request-minimal"][]; - deployment?: components["schemas"]["deployment-simple"]; - }; + id: number + } | null + app: components['schemas']['nullable-integration'] + pull_requests: components['schemas']['pull-request-minimal'][] + deployment?: components['schemas']['deployment-simple'] + } /** * Check Annotation * @description Check Annotation */ - "check-annotation": { + 'check-annotation': { /** @example README.md */ - path: string; + path: string /** @example 2 */ - start_line: number; + start_line: number /** @example 2 */ - end_line: number; + end_line: number /** @example 5 */ - start_column: number | null; + start_column: number | null /** @example 10 */ - end_column: number | null; + end_column: number | null /** @example warning */ - annotation_level: string | null; + annotation_level: string | null /** @example Spell Checker */ - title: string | null; + title: string | null /** @example Check your spelling for 'banaas'. */ - message: string | null; + message: string | null /** @example Do you mean 'bananas' or 'banana'? */ - raw_details: string | null; - blob_href: string; - }; + raw_details: string | null + blob_href: string + } /** * Simple Commit * @description Simple Commit */ - "simple-commit": { - id: string; - tree_id: string; - message: string; + 'simple-commit': { + id: string + tree_id: string + message: string /** Format: date-time */ - timestamp: string; + timestamp: string author: { - name: string; - email: string; - } | null; + name: string + email: string + } | null committer: { - name: string; - email: string; - } | null; - }; + name: string + email: string + } | null + } /** * CheckSuite * @description A suite of checks performed on the code of a given code change */ - "check-suite": { + 'check-suite': { /** @example 5 */ - id: number; + id: number /** @example MDEwOkNoZWNrU3VpdGU1 */ - node_id: string; + node_id: string /** @example master */ - head_branch: string | null; + head_branch: string | null /** * @description The SHA of the head commit that is being checked. * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d */ - head_sha: string; + head_sha: string /** * @example completed * @enum {string|null} */ - status: ("queued" | "in_progress" | "completed") | null; + status: ('queued' | 'in_progress' | 'completed') | null /** * @example neutral * @enum {string|null} */ - conclusion: - | ("success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required") - | null; + conclusion: ('success' | 'failure' | 'neutral' | 'cancelled' | 'skipped' | 'timed_out' | 'action_required') | null /** @example https://api.github.com/repos/github/hello-world/check-suites/5 */ - url: string | null; + url: string | null /** @example 146e867f55c26428e5f9fade55a9bbf5e95a7912 */ - before: string | null; + before: string | null /** @example d6fde92930d4715a2b49857d24b940956b26d2d3 */ - after: string | null; - pull_requests: components["schemas"]["pull-request-minimal"][] | null; - app: components["schemas"]["nullable-integration"]; - repository: components["schemas"]["minimal-repository"]; + after: string | null + pull_requests: components['schemas']['pull-request-minimal'][] | null + app: components['schemas']['nullable-integration'] + repository: components['schemas']['minimal-repository'] /** Format: date-time */ - created_at: string | null; + created_at: string | null /** Format: date-time */ - updated_at: string | null; - head_commit: components["schemas"]["simple-commit"]; - latest_check_runs_count: number; - check_runs_url: string; - rerequestable?: boolean; - runs_rerequestable?: boolean; - }; + updated_at: string | null + head_commit: components['schemas']['simple-commit'] + latest_check_runs_count: number + check_runs_url: string + rerequestable?: boolean + runs_rerequestable?: boolean + } /** * Check Suite Preference * @description Check suite configuration preferences for a repository. */ - "check-suite-preference": { + 'check-suite-preference': { preferences: { auto_trigger_checks?: { - app_id: number; - setting: boolean; - }[]; - }; - repository: components["schemas"]["minimal-repository"]; - }; - "code-scanning-alert-rule-summary": { + app_id: number + setting: boolean + }[] + } + repository: components['schemas']['minimal-repository'] + } + 'code-scanning-alert-rule-summary': { /** @description A unique identifier for the rule used to detect the alert. */ - id?: string | null; + id?: string | null /** @description The name of the rule used to detect the alert. */ - name?: string; + name?: string /** @description A set of tags applicable for the rule. */ - tags?: string[] | null; + tags?: string[] | null /** * @description The severity of the alert. * @enum {string|null} */ - severity?: ("none" | "note" | "warning" | "error") | null; + severity?: ('none' | 'note' | 'warning' | 'error') | null /** @description A short description of the rule used to detect the alert. */ - description?: string; - }; - "code-scanning-alert-items": { - number: components["schemas"]["alert-number"]; - created_at: components["schemas"]["alert-created-at"]; - updated_at?: components["schemas"]["alert-updated-at"]; - url: components["schemas"]["alert-url"]; - html_url: components["schemas"]["alert-html-url"]; - instances_url: components["schemas"]["alert-instances-url"]; - state: components["schemas"]["code-scanning-alert-state"]; - fixed_at?: components["schemas"]["code-scanning-alert-fixed-at"]; - dismissed_by: components["schemas"]["nullable-simple-user"]; - dismissed_at: components["schemas"]["code-scanning-alert-dismissed-at"]; - dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"]; - rule: components["schemas"]["code-scanning-alert-rule-summary"]; - tool: components["schemas"]["code-scanning-analysis-tool"]; - most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; - }; - "code-scanning-alert": { - number: components["schemas"]["alert-number"]; - created_at: components["schemas"]["alert-created-at"]; - updated_at?: components["schemas"]["alert-updated-at"]; - url: components["schemas"]["alert-url"]; - html_url: components["schemas"]["alert-html-url"]; - instances_url: components["schemas"]["alert-instances-url"]; - state: components["schemas"]["code-scanning-alert-state"]; - fixed_at?: components["schemas"]["code-scanning-alert-fixed-at"]; - dismissed_by: components["schemas"]["nullable-simple-user"]; - dismissed_at: components["schemas"]["code-scanning-alert-dismissed-at"]; - dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"]; - rule: components["schemas"]["code-scanning-alert-rule"]; - tool: components["schemas"]["code-scanning-analysis-tool"]; - most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; - }; + description?: string + } + 'code-scanning-alert-items': { + number: components['schemas']['alert-number'] + created_at: components['schemas']['alert-created-at'] + updated_at?: components['schemas']['alert-updated-at'] + url: components['schemas']['alert-url'] + html_url: components['schemas']['alert-html-url'] + instances_url: components['schemas']['alert-instances-url'] + state: components['schemas']['code-scanning-alert-state'] + fixed_at?: components['schemas']['code-scanning-alert-fixed-at'] + dismissed_by: components['schemas']['nullable-simple-user'] + dismissed_at: components['schemas']['code-scanning-alert-dismissed-at'] + dismissed_reason: components['schemas']['code-scanning-alert-dismissed-reason'] + rule: components['schemas']['code-scanning-alert-rule-summary'] + tool: components['schemas']['code-scanning-analysis-tool'] + most_recent_instance: components['schemas']['code-scanning-alert-instance'] + } + 'code-scanning-alert': { + number: components['schemas']['alert-number'] + created_at: components['schemas']['alert-created-at'] + updated_at?: components['schemas']['alert-updated-at'] + url: components['schemas']['alert-url'] + html_url: components['schemas']['alert-html-url'] + instances_url: components['schemas']['alert-instances-url'] + state: components['schemas']['code-scanning-alert-state'] + fixed_at?: components['schemas']['code-scanning-alert-fixed-at'] + dismissed_by: components['schemas']['nullable-simple-user'] + dismissed_at: components['schemas']['code-scanning-alert-dismissed-at'] + dismissed_reason: components['schemas']['code-scanning-alert-dismissed-reason'] + rule: components['schemas']['code-scanning-alert-rule'] + tool: components['schemas']['code-scanning-analysis-tool'] + most_recent_instance: components['schemas']['code-scanning-alert-instance'] + } /** * @description Sets the state of the code scanning alert. Can be one of `open` or `dismissed`. You must provide `dismissed_reason` when you set the state to `dismissed`. * @enum {string} */ - "code-scanning-alert-set-state": "open" | "dismissed"; + 'code-scanning-alert-set-state': 'open' | 'dismissed' /** * @description An identifier for the upload. * @example 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 */ - "code-scanning-analysis-sarif-id": string; + 'code-scanning-analysis-sarif-id': string /** @description The SHA of the commit to which the analysis you are uploading relates. */ - "code-scanning-analysis-commit-sha": string; + 'code-scanning-analysis-commit-sha': string /** @description Identifies the variable values associated with the environment in which this analysis was performed. */ - "code-scanning-analysis-environment": string; + 'code-scanning-analysis-environment': string /** * Format: date-time * @description The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "code-scanning-analysis-created-at": string; + 'code-scanning-analysis-created-at': string /** * Format: uri * @description The REST API URL of the analysis resource. */ - "code-scanning-analysis-url": string; - "code-scanning-analysis": { - ref: components["schemas"]["code-scanning-ref"]; - commit_sha: components["schemas"]["code-scanning-analysis-commit-sha"]; - analysis_key: components["schemas"]["code-scanning-analysis-analysis-key"]; - environment: components["schemas"]["code-scanning-analysis-environment"]; - category?: components["schemas"]["code-scanning-analysis-category"]; + 'code-scanning-analysis-url': string + 'code-scanning-analysis': { + ref: components['schemas']['code-scanning-ref'] + commit_sha: components['schemas']['code-scanning-analysis-commit-sha'] + analysis_key: components['schemas']['code-scanning-analysis-analysis-key'] + environment: components['schemas']['code-scanning-analysis-environment'] + category?: components['schemas']['code-scanning-analysis-category'] /** @example error reading field xyz */ - error: string; - created_at: components["schemas"]["code-scanning-analysis-created-at"]; + error: string + created_at: components['schemas']['code-scanning-analysis-created-at'] /** @description The total number of results in the analysis. */ - results_count: number; + results_count: number /** @description The total number of rules used in the analysis. */ - rules_count: number; + rules_count: number /** @description Unique identifier for this analysis. */ - id: number; - url: components["schemas"]["code-scanning-analysis-url"]; - sarif_id: components["schemas"]["code-scanning-analysis-sarif-id"]; - tool: components["schemas"]["code-scanning-analysis-tool"]; - deletable: boolean; + id: number + url: components['schemas']['code-scanning-analysis-url'] + sarif_id: components['schemas']['code-scanning-analysis-sarif-id'] + tool: components['schemas']['code-scanning-analysis-tool'] + deletable: boolean /** * @description Warning generated when processing the analysis * @example 123 results were ignored */ - warning: string; - }; + warning: string + } /** * Analysis deletion * @description Successful deletion of a code scanning analysis */ - "code-scanning-analysis-deletion": { + 'code-scanning-analysis-deletion': { /** * Format: uri * @description Next deletable analysis in chain, without last analysis deletion confirmation */ - next_analysis_url: string | null; + next_analysis_url: string | null /** * Format: uri * @description Next deletable analysis in chain, with last analysis deletion confirmation */ - confirm_delete_url: string | null; - }; + confirm_delete_url: string | null + } /** @description A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see "[SARIF support for code scanning](https://docs.github.com/code-security/secure-coding/sarif-support-for-code-scanning)." */ - "code-scanning-analysis-sarif-file": string; - "code-scanning-sarifs-receipt": { - id?: components["schemas"]["code-scanning-analysis-sarif-id"]; + 'code-scanning-analysis-sarif-file': string + 'code-scanning-sarifs-receipt': { + id?: components['schemas']['code-scanning-analysis-sarif-id'] /** * Format: uri * @description The REST API URL for checking the status of the upload. */ - url?: string; - }; - "code-scanning-sarifs-status": { + url?: string + } + 'code-scanning-sarifs-status': { /** * @description `pending` files have not yet been processed, while `complete` means results from the SARIF have been stored. `failed` files have either not been processed at all, or could only be partially processed. * @enum {string} */ - processing_status?: "pending" | "complete" | "failed"; + processing_status?: 'pending' | 'complete' | 'failed' /** * Format: uri * @description The REST API URL for getting the analyses associated with the upload. */ - analyses_url?: string | null; + analyses_url?: string | null /** @description Any errors that ocurred during processing of the delivery. */ - errors?: string[] | null; - }; + errors?: string[] | null + } /** * Codespace machine * @description A description of the machine powering a codespace. */ - "nullable-codespace-machine": { + 'nullable-codespace-machine': { /** * @description The name of the machine. * @example standardLinux */ - name: string; + name: string /** * @description The display name of the machine includes cores, memory, and storage. * @example 4 cores, 8 GB RAM, 64 GB storage */ - display_name: string; + display_name: string /** * @description The operating system of the machine. * @example linux */ - operating_system: string; + operating_system: string /** * @description How much storage is available to the codespace. * @example 68719476736 */ - storage_in_bytes: number; + storage_in_bytes: number /** * @description How much memory is available to the codespace. * @example 8589934592 */ - memory_in_bytes: number; + memory_in_bytes: number /** * @description How many cores are available to the codespace. * @example 4 */ - cpus: number; + cpus: number /** * @description Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be "null" if prebuilds are not supported or prebuild availability could not be determined. Value is the type of prebuild available, or "none" if none are available. * @example blob * @enum {string|null} */ - prebuild_availability: ("none" | "blob" | "pool") | null; - } | null; + prebuild_availability: ('none' | 'blob' | 'pool') | null + } | null /** * Codespace * @description A codespace. */ codespace: { /** @example 1 */ - id: number; + id: number /** * @description Automatically generated name of this codespace. * @example monalisa-octocat-hello-world-g4wpq6h95q */ - name: string; + name: string /** * @description UUID identifying this codespace's environment. * @example 26a7c758-7299-4a73-b978-5a92a7ae98a0 */ - environment_id: string | null; - owner: components["schemas"]["simple-user"]; - billable_owner: components["schemas"]["simple-user"]; - repository: components["schemas"]["minimal-repository"]; - machine: components["schemas"]["nullable-codespace-machine"]; + environment_id: string | null + owner: components['schemas']['simple-user'] + billable_owner: components['schemas']['simple-user'] + repository: components['schemas']['minimal-repository'] + machine: components['schemas']['nullable-codespace-machine'] /** @description Whether the codespace was created from a prebuild. */ - prebuild: boolean | null; + prebuild: boolean | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - updated_at: string; + updated_at: string /** * Format: date-time * @description Last known time this codespace was started. * @example 2011-01-26T19:01:12Z */ - last_used_at: string; + last_used_at: string /** * @description State of this codespace. * @example Available * @enum {string} */ state: - | "Unknown" - | "Created" - | "Queued" - | "Provisioning" - | "Available" - | "Awaiting" - | "Unavailable" - | "Deleted" - | "Moved" - | "Shutdown" - | "Archived" - | "Starting" - | "ShuttingDown" - | "Failed" - | "Exporting" - | "Updating" - | "Rebuilding"; + | 'Unknown' + | 'Created' + | 'Queued' + | 'Provisioning' + | 'Available' + | 'Awaiting' + | 'Unavailable' + | 'Deleted' + | 'Moved' + | 'Shutdown' + | 'Archived' + | 'Starting' + | 'ShuttingDown' + | 'Failed' + | 'Exporting' + | 'Updating' + | 'Rebuilding' /** * Format: uri * @description API URL for this codespace. */ - url: string; + url: string /** @description Details about the codespace's git repository. */ git_status: { /** @description The number of commits the local repository is ahead of the remote. */ - ahead?: number; + ahead?: number /** @description The number of commits the local repository is behind the remote. */ - behind?: number; + behind?: number /** @description Whether the local repository has unpushed changes. */ - has_unpushed_changes?: boolean; + has_unpushed_changes?: boolean /** @description Whether the local repository has uncommitted changes. */ - has_uncommitted_changes?: boolean; + has_uncommitted_changes?: boolean /** * @description The current branch (or SHA if in detached HEAD state) of the local repository. * @example main */ - ref?: string; - }; + ref?: string + } /** * @description The Azure region where this codespace is located. * @example WestUs2 * @enum {string} */ - location: "EastUs" | "SouthEastAsia" | "WestEurope" | "WestUs2"; + location: 'EastUs' | 'SouthEastAsia' | 'WestEurope' | 'WestUs2' /** * @description The number of minutes of inactivity after which this codespace will be automatically stopped. * @example 60 */ - idle_timeout_minutes: number | null; + idle_timeout_minutes: number | null /** * Format: uri * @description URL to access this codespace on the web. */ - web_url: string; + web_url: string /** * Format: uri * @description API URL to access available alternate machine types for this codespace. */ - machines_url: string; + machines_url: string /** * Format: uri * @description API URL to start this codespace. */ - start_url: string; + start_url: string /** * Format: uri * @description API URL to stop this codespace. */ - stop_url: string; + stop_url: string /** * Format: uri * @description API URL for the Pull Request associated with this codespace, if any. */ - pulls_url: string | null; - recent_folders: string[]; + pulls_url: string | null + recent_folders: string[] runtime_constraints?: { /** @description The privacy settings a user can select from when forwarding a port. */ - allowed_port_privacy_settings?: string[] | null; - }; - }; + allowed_port_privacy_settings?: string[] | null + } + } /** * Codespace machine * @description A description of the machine powering a codespace. */ - "codespace-machine": { + 'codespace-machine': { /** * @description The name of the machine. * @example standardLinux */ - name: string; + name: string /** * @description The display name of the machine includes cores, memory, and storage. * @example 4 cores, 8 GB RAM, 64 GB storage */ - display_name: string; + display_name: string /** * @description The operating system of the machine. * @example linux */ - operating_system: string; + operating_system: string /** * @description How much storage is available to the codespace. * @example 68719476736 */ - storage_in_bytes: number; + storage_in_bytes: number /** * @description How much memory is available to the codespace. * @example 8589934592 */ - memory_in_bytes: number; + memory_in_bytes: number /** * @description How many cores are available to the codespace. * @example 4 */ - cpus: number; + cpus: number /** * @description Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be "null" if prebuilds are not supported or prebuild availability could not be determined. Value is the type of prebuild available, or "none" if none are available. * @example blob * @enum {string|null} */ - prebuild_availability: ("none" | "blob" | "pool") | null; - }; + prebuild_availability: ('none' | 'blob' | 'pool') | null + } /** * Collaborator * @description Collaborator */ collaborator: { /** @example octocat */ - login: string; + login: string /** @example 1 */ - id: number; - email?: string | null; - name?: string | null; + id: number + email?: string | null + name?: string | null /** @example MDQ6VXNlcjE= */ - node_id: string; + node_id: string /** * Format: uri * @example https://github.com/images/error/octocat_happy.gif */ - avatar_url: string; + avatar_url: string /** @example 41d064eb2195891e12d0413f63227ea7 */ - gravatar_id: string | null; + gravatar_id: string | null /** * Format: uri * @example https://api.github.com/users/octocat */ - url: string; + url: string /** * Format: uri * @example https://github.com/octocat */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/users/octocat/followers */ - followers_url: string; + followers_url: string /** @example https://api.github.com/users/octocat/following{/other_user} */ - following_url: string; + following_url: string /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - gists_url: string; + gists_url: string /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - starred_url: string; + starred_url: string /** * Format: uri * @example https://api.github.com/users/octocat/subscriptions */ - subscriptions_url: string; + subscriptions_url: string /** * Format: uri * @example https://api.github.com/users/octocat/orgs */ - organizations_url: string; + organizations_url: string /** * Format: uri * @example https://api.github.com/users/octocat/repos */ - repos_url: string; + repos_url: string /** @example https://api.github.com/users/octocat/events{/privacy} */ - events_url: string; + events_url: string /** * Format: uri * @example https://api.github.com/users/octocat/received_events */ - received_events_url: string; + received_events_url: string /** @example User */ - type: string; - site_admin: boolean; + type: string + site_admin: boolean permissions?: { - pull: boolean; - triage?: boolean; - push: boolean; - maintain?: boolean; - admin: boolean; - }; + pull: boolean + triage?: boolean + push: boolean + maintain?: boolean + admin: boolean + } /** @example admin */ - role_name: string; - }; + role_name: string + } /** * Repository Invitation * @description Repository invitations let you manage who you collaborate with. */ - "repository-invitation": { + 'repository-invitation': { /** * @description Unique identifier of the repository invitation. * @example 42 */ - id: number; - repository: components["schemas"]["minimal-repository"]; - invitee: components["schemas"]["nullable-simple-user"]; - inviter: components["schemas"]["nullable-simple-user"]; + id: number + repository: components['schemas']['minimal-repository'] + invitee: components['schemas']['nullable-simple-user'] + inviter: components['schemas']['nullable-simple-user'] /** * @description The permission associated with the invitation. * @example read * @enum {string} */ - permissions: "read" | "write" | "admin" | "triage" | "maintain"; + permissions: 'read' | 'write' | 'admin' | 'triage' | 'maintain' /** * Format: date-time * @example 2016-06-13T14:52:50-05:00 */ - created_at: string; + created_at: string /** @description Whether or not the invitation has expired */ - expired?: boolean; + expired?: boolean /** * @description URL for the repository invitation * @example https://api.github.com/user/repository-invitations/1 */ - url: string; + url: string /** @example https://github.com/octocat/Hello-World/invitations */ - html_url: string; - node_id: string; - }; + html_url: string + node_id: string + } /** * Collaborator * @description Collaborator */ - "nullable-collaborator": { + 'nullable-collaborator': { /** @example octocat */ - login: string; + login: string /** @example 1 */ - id: number; - email?: string | null; - name?: string | null; + id: number + email?: string | null + name?: string | null /** @example MDQ6VXNlcjE= */ - node_id: string; + node_id: string /** * Format: uri * @example https://github.com/images/error/octocat_happy.gif */ - avatar_url: string; + avatar_url: string /** @example 41d064eb2195891e12d0413f63227ea7 */ - gravatar_id: string | null; + gravatar_id: string | null /** * Format: uri * @example https://api.github.com/users/octocat */ - url: string; + url: string /** * Format: uri * @example https://github.com/octocat */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/users/octocat/followers */ - followers_url: string; + followers_url: string /** @example https://api.github.com/users/octocat/following{/other_user} */ - following_url: string; + following_url: string /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - gists_url: string; + gists_url: string /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - starred_url: string; + starred_url: string /** * Format: uri * @example https://api.github.com/users/octocat/subscriptions */ - subscriptions_url: string; + subscriptions_url: string /** * Format: uri * @example https://api.github.com/users/octocat/orgs */ - organizations_url: string; + organizations_url: string /** * Format: uri * @example https://api.github.com/users/octocat/repos */ - repos_url: string; + repos_url: string /** @example https://api.github.com/users/octocat/events{/privacy} */ - events_url: string; + events_url: string /** * Format: uri * @example https://api.github.com/users/octocat/received_events */ - received_events_url: string; + received_events_url: string /** @example User */ - type: string; - site_admin: boolean; + type: string + site_admin: boolean permissions?: { - pull: boolean; - triage?: boolean; - push: boolean; - maintain?: boolean; - admin: boolean; - }; + pull: boolean + triage?: boolean + push: boolean + maintain?: boolean + admin: boolean + } /** @example admin */ - role_name: string; - } | null; + role_name: string + } | null /** * Repository Collaborator Permission * @description Repository Collaborator Permission */ - "repository-collaborator-permission": { - permission: string; + 'repository-collaborator-permission': { + permission: string /** @example admin */ - role_name: string; - user: components["schemas"]["nullable-collaborator"]; - }; + role_name: string + user: components['schemas']['nullable-collaborator'] + } /** * Commit Comment * @description Commit Comment */ - "commit-comment": { + 'commit-comment': { /** Format: uri */ - html_url: string; + html_url: string /** Format: uri */ - url: string; - id: number; - node_id: string; - body: string; - path: string | null; - position: number | null; - line: number | null; - commit_id: string; - user: components["schemas"]["nullable-simple-user"]; + url: string + id: number + node_id: string + body: string + path: string | null + position: number | null + line: number | null + commit_id: string + user: components['schemas']['nullable-simple-user'] /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - author_association: components["schemas"]["author_association"]; - reactions?: components["schemas"]["reaction-rollup"]; - }; + updated_at: string + author_association: components['schemas']['author_association'] + reactions?: components['schemas']['reaction-rollup'] + } /** * Branch Short * @description Branch Short */ - "branch-short": { - name: string; + 'branch-short': { + name: string commit: { - sha: string; - url: string; - }; - protected: boolean; - }; + sha: string + url: string + } + protected: boolean + } /** * Link * @description Hypermedia Link */ link: { - href: string; - }; + href: string + } /** * Auto merge * @description The status of auto merging a pull request. */ auto_merge: { - enabled_by: components["schemas"]["simple-user"]; + enabled_by: components['schemas']['simple-user'] /** * @description The merge method to use. * @enum {string} */ - merge_method: "merge" | "squash" | "rebase"; + merge_method: 'merge' | 'squash' | 'rebase' /** @description Title for the merge commit message. */ - commit_title: string; + commit_title: string /** @description Commit message for the merge commit. */ - commit_message: string; - } | null; + commit_message: string + } | null /** * Pull Request Simple * @description Pull Request Simple */ - "pull-request-simple": { + 'pull-request-simple': { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ - url: string; + url: string /** @example 1 */ - id: number; + id: number /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ - node_id: string; + node_id: string /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347 */ - html_url: string; + html_url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.diff */ - diff_url: string; + diff_url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.patch */ - patch_url: string; + patch_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 */ - issue_url: string; + issue_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits */ - commits_url: string; + commits_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments */ - review_comments_url: string; + review_comments_url: string /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} */ - review_comment_url: string; + review_comment_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347/comments */ - comments_url: string; + comments_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e */ - statuses_url: string; + statuses_url: string /** @example 1347 */ - number: number; + number: number /** @example open */ - state: string; + state: string /** @example true */ - locked: boolean; + locked: boolean /** @example new-feature */ - title: string; - user: components["schemas"]["nullable-simple-user"]; + title: string + user: components['schemas']['nullable-simple-user'] /** @example Please pull these awesome changes */ - body: string | null; + body: string | null labels: { /** Format: int64 */ - id: number; - node_id: string; - url: string; - name: string; - description: string; - color: string; - default: boolean; - }[]; - milestone: components["schemas"]["nullable-milestone"]; + id: number + node_id: string + url: string + name: string + description: string + color: string + default: boolean + }[] + milestone: components['schemas']['nullable-milestone'] /** @example too heated */ - active_lock_reason?: string | null; + active_lock_reason?: string | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - updated_at: string; + updated_at: string /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - closed_at: string | null; + closed_at: string | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - merged_at: string | null; + merged_at: string | null /** @example e5bd3914e2e596debea16f433f57875b5b90bcd6 */ - merge_commit_sha: string | null; - assignee: components["schemas"]["nullable-simple-user"]; - assignees?: components["schemas"]["simple-user"][] | null; - requested_reviewers?: components["schemas"]["simple-user"][] | null; - requested_teams?: components["schemas"]["team"][] | null; + merge_commit_sha: string | null + assignee: components['schemas']['nullable-simple-user'] + assignees?: components['schemas']['simple-user'][] | null + requested_reviewers?: components['schemas']['simple-user'][] | null + requested_teams?: components['schemas']['team'][] | null head: { - label: string; - ref: string; - repo: components["schemas"]["repository"]; - sha: string; - user: components["schemas"]["nullable-simple-user"]; - }; + label: string + ref: string + repo: components['schemas']['repository'] + sha: string + user: components['schemas']['nullable-simple-user'] + } base: { - label: string; - ref: string; - repo: components["schemas"]["repository"]; - sha: string; - user: components["schemas"]["nullable-simple-user"]; - }; + label: string + ref: string + repo: components['schemas']['repository'] + sha: string + user: components['schemas']['nullable-simple-user'] + } _links: { - comments: components["schemas"]["link"]; - commits: components["schemas"]["link"]; - statuses: components["schemas"]["link"]; - html: components["schemas"]["link"]; - issue: components["schemas"]["link"]; - review_comments: components["schemas"]["link"]; - review_comment: components["schemas"]["link"]; - self: components["schemas"]["link"]; - }; - author_association: components["schemas"]["author_association"]; - auto_merge: components["schemas"]["auto_merge"]; + comments: components['schemas']['link'] + commits: components['schemas']['link'] + statuses: components['schemas']['link'] + html: components['schemas']['link'] + issue: components['schemas']['link'] + review_comments: components['schemas']['link'] + review_comment: components['schemas']['link'] + self: components['schemas']['link'] + } + author_association: components['schemas']['author_association'] + auto_merge: components['schemas']['auto_merge'] /** @description Indicates whether or not the pull request is a draft. */ - draft?: boolean; - }; + draft?: boolean + } /** Simple Commit Status */ - "simple-commit-status": { - description: string | null; - id: number; - node_id: string; - state: string; - context: string; + 'simple-commit-status': { + description: string | null + id: number + node_id: string + state: string + context: string /** Format: uri */ - target_url: string; - required?: boolean | null; + target_url: string + required?: boolean | null /** Format: uri */ - avatar_url: string | null; + avatar_url: string | null /** Format: uri */ - url: string; + url: string /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - }; + updated_at: string + } /** * Combined Commit Status * @description Combined Commit Status */ - "combined-commit-status": { - state: string; - statuses: components["schemas"]["simple-commit-status"][]; - sha: string; - total_count: number; - repository: components["schemas"]["minimal-repository"]; + 'combined-commit-status': { + state: string + statuses: components['schemas']['simple-commit-status'][] + sha: string + total_count: number + repository: components['schemas']['minimal-repository'] /** Format: uri */ - commit_url: string; + commit_url: string /** Format: uri */ - url: string; - }; + url: string + } /** * Status * @description The status of a commit. */ status: { - url: string; - avatar_url: string | null; - id: number; - node_id: string; - state: string; - description: string; - target_url: string; - context: string; - created_at: string; - updated_at: string; - creator: components["schemas"]["nullable-simple-user"]; - }; + url: string + avatar_url: string | null + id: number + node_id: string + state: string + description: string + target_url: string + context: string + created_at: string + updated_at: string + creator: components['schemas']['nullable-simple-user'] + } /** * Code Of Conduct Simple * @description Code of Conduct Simple */ - "nullable-code-of-conduct-simple": { + 'nullable-code-of-conduct-simple': { /** * Format: uri * @example https://api.github.com/repos/github/docs/community/code_of_conduct */ - url: string; + url: string /** @example citizen_code_of_conduct */ - key: string; + key: string /** @example Citizen Code of Conduct */ - name: string; + name: string /** * Format: uri * @example https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md */ - html_url: string | null; - } | null; + html_url: string | null + } | null /** Community Health File */ - "nullable-community-health-file": { + 'nullable-community-health-file': { /** Format: uri */ - url: string; + url: string /** Format: uri */ - html_url: string; - } | null; + html_url: string + } | null /** * Community Profile * @description Community Profile */ - "community-profile": { + 'community-profile': { /** @example 100 */ - health_percentage: number; + health_percentage: number /** @example My first repository on GitHub! */ - description: string | null; + description: string | null /** @example example.com */ - documentation: string | null; + documentation: string | null files: { - code_of_conduct: components["schemas"]["nullable-code-of-conduct-simple"]; - code_of_conduct_file: components["schemas"]["nullable-community-health-file"]; - license: components["schemas"]["nullable-license-simple"]; - contributing: components["schemas"]["nullable-community-health-file"]; - readme: components["schemas"]["nullable-community-health-file"]; - issue_template: components["schemas"]["nullable-community-health-file"]; - pull_request_template: components["schemas"]["nullable-community-health-file"]; - }; + code_of_conduct: components['schemas']['nullable-code-of-conduct-simple'] + code_of_conduct_file: components['schemas']['nullable-community-health-file'] + license: components['schemas']['nullable-license-simple'] + contributing: components['schemas']['nullable-community-health-file'] + readme: components['schemas']['nullable-community-health-file'] + issue_template: components['schemas']['nullable-community-health-file'] + pull_request_template: components['schemas']['nullable-community-health-file'] + } /** * Format: date-time * @example 2017-02-28T19:09:29Z */ - updated_at: string | null; + updated_at: string | null /** @example true */ - content_reports_enabled?: boolean; - }; + content_reports_enabled?: boolean + } /** * Commit Comparison * @description Commit Comparison */ - "commit-comparison": { + 'commit-comparison': { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/compare/master...topic */ - url: string; + url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/compare/master...topic */ - html_url: string; + html_url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17 */ - permalink_url: string; + permalink_url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/compare/master...topic.diff */ - diff_url: string; + diff_url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/compare/master...topic.patch */ - patch_url: string; - base_commit: components["schemas"]["commit"]; - merge_base_commit: components["schemas"]["commit"]; + patch_url: string + base_commit: components['schemas']['commit'] + merge_base_commit: components['schemas']['commit'] /** * @example ahead * @enum {string} */ - status: "diverged" | "ahead" | "behind" | "identical"; + status: 'diverged' | 'ahead' | 'behind' | 'identical' /** @example 4 */ - ahead_by: number; + ahead_by: number /** @example 5 */ - behind_by: number; + behind_by: number /** @example 6 */ - total_commits: number; - commits: components["schemas"]["commit"][]; - files?: components["schemas"]["diff-entry"][]; - }; + total_commits: number + commits: components['schemas']['commit'][] + files?: components['schemas']['diff-entry'][] + } /** * Content Tree * @description Content Tree */ - "content-tree": { - type: string; - size: number; - name: string; - path: string; - sha: string; + 'content-tree': { + type: string + size: number + name: string + path: string + sha: string /** Format: uri */ - url: string; + url: string /** Format: uri */ - git_url: string | null; + git_url: string | null /** Format: uri */ - html_url: string | null; + html_url: string | null /** Format: uri */ - download_url: string | null; + download_url: string | null entries?: { - type: string; - size: number; - name: string; - path: string; - content?: string; - sha: string; + type: string + size: number + name: string + path: string + content?: string + sha: string /** Format: uri */ - url: string; + url: string /** Format: uri */ - git_url: string | null; + git_url: string | null /** Format: uri */ - html_url: string | null; + html_url: string | null /** Format: uri */ - download_url: string | null; + download_url: string | null _links: { /** Format: uri */ - git: string | null; + git: string | null /** Format: uri */ - html: string | null; + html: string | null /** Format: uri */ - self: string; - }; - }[]; + self: string + } + }[] _links: { /** Format: uri */ - git: string | null; + git: string | null /** Format: uri */ - html: string | null; + html: string | null /** Format: uri */ - self: string; - }; + self: string + } } & { - content: unknown; - encoding: unknown; - }; + content: unknown + encoding: unknown + } /** * Content Directory * @description A list of directory items */ - "content-directory": { - type: string; - size: number; - name: string; - path: string; - content?: string; - sha: string; + 'content-directory': { + type: string + size: number + name: string + path: string + content?: string + sha: string /** Format: uri */ - url: string; + url: string /** Format: uri */ - git_url: string | null; + git_url: string | null /** Format: uri */ - html_url: string | null; + html_url: string | null /** Format: uri */ - download_url: string | null; + download_url: string | null _links: { /** Format: uri */ - git: string | null; + git: string | null /** Format: uri */ - html: string | null; + html: string | null /** Format: uri */ - self: string; - }; - }[]; + self: string + } + }[] /** * Content File * @description Content File */ - "content-file": { - type: string; - encoding: string; - size: number; - name: string; - path: string; - content: string; - sha: string; + 'content-file': { + type: string + encoding: string + size: number + name: string + path: string + content: string + sha: string /** Format: uri */ - url: string; + url: string /** Format: uri */ - git_url: string | null; + git_url: string | null /** Format: uri */ - html_url: string | null; + html_url: string | null /** Format: uri */ - download_url: string | null; + download_url: string | null _links: { /** Format: uri */ - git: string | null; + git: string | null /** Format: uri */ - html: string | null; + html: string | null /** Format: uri */ - self: string; - }; + self: string + } /** @example "actual/actual.md" */ - target?: string; + target?: string /** @example "git://example.com/defunkt/dotjs.git" */ - submodule_git_url?: string; - }; + submodule_git_url?: string + } /** * Symlink Content * @description An object describing a symlink */ - "content-symlink": { - type: string; - target: string; - size: number; - name: string; - path: string; - sha: string; + 'content-symlink': { + type: string + target: string + size: number + name: string + path: string + sha: string /** Format: uri */ - url: string; + url: string /** Format: uri */ - git_url: string | null; + git_url: string | null /** Format: uri */ - html_url: string | null; + html_url: string | null /** Format: uri */ - download_url: string | null; + download_url: string | null _links: { /** Format: uri */ - git: string | null; + git: string | null /** Format: uri */ - html: string | null; + html: string | null /** Format: uri */ - self: string; - }; - }; + self: string + } + } /** * Symlink Content * @description An object describing a symlink */ - "content-submodule": { - type: string; + 'content-submodule': { + type: string /** Format: uri */ - submodule_git_url: string; - size: number; - name: string; - path: string; - sha: string; + submodule_git_url: string + size: number + name: string + path: string + sha: string /** Format: uri */ - url: string; + url: string /** Format: uri */ - git_url: string | null; + git_url: string | null /** Format: uri */ - html_url: string | null; + html_url: string | null /** Format: uri */ - download_url: string | null; + download_url: string | null _links: { /** Format: uri */ - git: string | null; + git: string | null /** Format: uri */ - html: string | null; + html: string | null /** Format: uri */ - self: string; - }; - }; + self: string + } + } /** * File Commit * @description File Commit */ - "file-commit": { + 'file-commit': { content: { - name?: string; - path?: string; - sha?: string; - size?: number; - url?: string; - html_url?: string; - git_url?: string; - download_url?: string; - type?: string; + name?: string + path?: string + sha?: string + size?: number + url?: string + html_url?: string + git_url?: string + download_url?: string + type?: string _links?: { - self?: string; - git?: string; - html?: string; - }; - } | null; + self?: string + git?: string + html?: string + } + } | null commit: { - sha?: string; - node_id?: string; - url?: string; - html_url?: string; + sha?: string + node_id?: string + url?: string + html_url?: string author?: { - date?: string; - name?: string; - email?: string; - }; + date?: string + name?: string + email?: string + } committer?: { - date?: string; - name?: string; - email?: string; - }; - message?: string; + date?: string + name?: string + email?: string + } + message?: string tree?: { - url?: string; - sha?: string; - }; + url?: string + sha?: string + } parents?: { - url?: string; - html_url?: string; - sha?: string; - }[]; + url?: string + html_url?: string + sha?: string + }[] verification?: { - verified?: boolean; - reason?: string; - signature?: string | null; - payload?: string | null; - }; - }; - }; + verified?: boolean + reason?: string + signature?: string | null + payload?: string | null + } + } + } /** * Contributor * @description Contributor */ contributor: { - login?: string; - id?: number; - node_id?: string; + login?: string + id?: number + node_id?: string /** Format: uri */ - avatar_url?: string; - gravatar_id?: string | null; + avatar_url?: string + gravatar_id?: string | null /** Format: uri */ - url?: string; + url?: string /** Format: uri */ - html_url?: string; + html_url?: string /** Format: uri */ - followers_url?: string; - following_url?: string; - gists_url?: string; - starred_url?: string; + followers_url?: string + following_url?: string + gists_url?: string + starred_url?: string /** Format: uri */ - subscriptions_url?: string; + subscriptions_url?: string /** Format: uri */ - organizations_url?: string; + organizations_url?: string /** Format: uri */ - repos_url?: string; - events_url?: string; + repos_url?: string + events_url?: string /** Format: uri */ - received_events_url?: string; - type: string; - site_admin?: boolean; - contributions: number; - email?: string; - name?: string; - }; + received_events_url?: string + type: string + site_admin?: boolean + contributions: number + email?: string + name?: string + } /** * Dependabot Secret * @description Set secrets for Dependabot. */ - "dependabot-secret": { + 'dependabot-secret': { /** * @description The name of the secret. * @example MY_ARTIFACTORY_PASSWORD */ - name: string; + name: string /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - }; + updated_at: string + } /** * Deployment Status * @description The status of a deployment. */ - "deployment-status": { + 'deployment-status': { /** * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/42/statuses/1 */ - url: string; + url: string /** @example 1 */ - id: number; + id: number /** @example MDE2OkRlcGxveW1lbnRTdGF0dXMx */ - node_id: string; + node_id: string /** * @description The state of the status. * @example success * @enum {string} */ - state: "error" | "failure" | "inactive" | "pending" | "success" | "queued" | "in_progress"; - creator: components["schemas"]["nullable-simple-user"]; + state: 'error' | 'failure' | 'inactive' | 'pending' | 'success' | 'queued' | 'in_progress' + creator: components['schemas']['nullable-simple-user'] /** * @description A short description of the status. * @example Deployment finished successfully. */ - description: string; + description: string /** * @description The environment of the deployment that the status is for. * @example production */ - environment?: string; + environment?: string /** * Format: uri * @description Deprecated: the URL to associate with this status. * @example https://example.com/deployment/42/output */ - target_url: string; + target_url: string /** * Format: date-time * @example 2012-07-20T01:19:13Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2012-07-20T01:19:13Z */ - updated_at: string; + updated_at: string /** * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/42 */ - deployment_url: string; + deployment_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/example */ - repository_url: string; + repository_url: string /** * Format: uri * @description The URL for accessing your environment. * @example https://staging.example.com/ */ - environment_url?: string; + environment_url?: string /** * Format: uri * @description The URL to associate with this status. * @example https://example.com/deployment/42/output */ - log_url?: string; - performed_via_github_app?: components["schemas"]["nullable-integration"]; - }; + log_url?: string + performed_via_github_app?: components['schemas']['nullable-integration'] + } /** * @description The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days). * @example 30 */ - "wait-timer": number; + 'wait-timer': number /** @description The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. */ deployment_branch_policy: { /** @description Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`. */ - protected_branches: boolean; + protected_branches: boolean /** @description Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`. */ - custom_branch_policies: boolean; - } | null; + custom_branch_policies: boolean + } | null /** * Environment * @description Details of a deployment environment @@ -13802,97 +13790,97 @@ export type components = { * @description The id of the environment. * @example 56780428 */ - id: number; + id: number /** @example MDExOkVudmlyb25tZW50NTY3ODA0Mjg= */ - node_id: string; + node_id: string /** * @description The name of the environment. * @example staging */ - name: string; + name: string /** @example https://api.github.com/repos/github/hello-world/environments/staging */ - url: string; + url: string /** @example https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging */ - html_url: string; + html_url: string /** * Format: date-time * @description The time that the environment was created, in ISO 8601 format. * @example 2020-11-23T22:00:40Z */ - created_at: string; + created_at: string /** * Format: date-time * @description The time that the environment was last updated, in ISO 8601 format. * @example 2020-11-23T22:00:40Z */ - updated_at: string; + updated_at: string protection_rules?: (Partial<{ /** @example 3515 */ - id: number; + id: number /** @example MDQ6R2F0ZTM1MTU= */ - node_id: string; + node_id: string /** @example wait_timer */ - type: string; - wait_timer?: components["schemas"]["wait-timer"]; + type: string + wait_timer?: components['schemas']['wait-timer'] }> & Partial<{ /** @example 3755 */ - id: number; + id: number /** @example MDQ6R2F0ZTM3NTU= */ - node_id: string; + node_id: string /** @example required_reviewers */ - type: string; + type: string /** @description The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */ reviewers?: { - type?: components["schemas"]["deployment-reviewer-type"]; - reviewer?: Partial & Partial; - }[]; + type?: components['schemas']['deployment-reviewer-type'] + reviewer?: Partial & Partial + }[] }> & Partial<{ /** @example 3515 */ - id: number; + id: number /** @example MDQ6R2F0ZTM1MTU= */ - node_id: string; + node_id: string /** @example branch_policy */ - type: string; - }>)[]; - deployment_branch_policy?: components["schemas"]["deployment_branch_policy"]; - }; + type: string + }>)[] + deployment_branch_policy?: components['schemas']['deployment_branch_policy'] + } /** * Short Blob * @description Short Blob */ - "short-blob": { - url: string; - sha: string; - }; + 'short-blob': { + url: string + sha: string + } /** * Blob * @description Blob */ blob: { - content: string; - encoding: string; + content: string + encoding: string /** Format: uri */ - url: string; - sha: string; - size: number | null; - node_id: string; - highlighted_content?: string; - }; + url: string + sha: string + size: number | null + node_id: string + highlighted_content?: string + } /** * Git Commit * @description Low-level Git commit operations within a repository */ - "git-commit": { + 'git-commit': { /** * @description SHA for the commit * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - sha: string; - node_id: string; + sha: string + node_id: string /** Format: uri */ - url: string; + url: string /** @description Identifying information for the git-user */ author: { /** @@ -13900,18 +13888,18 @@ export type components = { * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 */ - date: string; + date: string /** * @description Git email address of the user * @example monalisa.octocat@example.com */ - email: string; + email: string /** * @description Name of the git user * @example Monalisa Octocat */ - name: string; - }; + name: string + } /** @description Identifying information for the git-user */ committer: { /** @@ -13919,343 +13907,343 @@ export type components = { * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 */ - date: string; + date: string /** * @description Git email address of the user * @example monalisa.octocat@example.com */ - email: string; + email: string /** * @description Name of the git user * @example Monalisa Octocat */ - name: string; - }; + name: string + } /** * @description Message describing the purpose of the commit * @example Fix #42 */ - message: string; + message: string tree: { /** * @description SHA for the commit * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - sha: string; + sha: string /** Format: uri */ - url: string; - }; + url: string + } parents: { /** * @description SHA for the commit * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - sha: string; + sha: string /** Format: uri */ - url: string; + url: string /** Format: uri */ - html_url: string; - }[]; + html_url: string + }[] verification: { - verified: boolean; - reason: string; - signature: string | null; - payload: string | null; - }; + verified: boolean + reason: string + signature: string | null + payload: string | null + } /** Format: uri */ - html_url: string; - }; + html_url: string + } /** * Git Reference * @description Git references within a repository */ - "git-ref": { - ref: string; - node_id: string; + 'git-ref': { + ref: string + node_id: string /** Format: uri */ - url: string; + url: string object: { - type: string; + type: string /** * @description SHA for the reference * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - sha: string; + sha: string /** Format: uri */ - url: string; - }; - }; + url: string + } + } /** * Git Tag * @description Metadata for a Git tag */ - "git-tag": { + 'git-tag': { /** @example MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== */ - node_id: string; + node_id: string /** * @description Name of the tag * @example v0.0.1 */ - tag: string; + tag: string /** @example 940bd336248efae0f9ee5bc7b2d5c985887b16ac */ - sha: string; + sha: string /** * Format: uri * @description URL for the tag * @example https://api.github.com/repositories/42/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac */ - url: string; + url: string /** * @description Message describing the purpose of the tag * @example Initial public release */ - message: string; + message: string tagger: { - date: string; - email: string; - name: string; - }; + date: string + email: string + name: string + } object: { - sha: string; - type: string; + sha: string + type: string /** Format: uri */ - url: string; - }; - verification?: components["schemas"]["verification"]; - }; + url: string + } + verification?: components['schemas']['verification'] + } /** * Git Tree * @description The hierarchy between files in a Git repository. */ - "git-tree": { - sha: string; + 'git-tree': { + sha: string /** Format: uri */ - url: string; - truncated: boolean; + url: string + truncated: boolean /** * @description Objects specifying a tree structure * @example [object Object] */ tree: { /** @example test/file.rb */ - path?: string; + path?: string /** @example 040000 */ - mode?: string; + mode?: string /** @example tree */ - type?: string; + type?: string /** @example 23f6827669e43831def8a7ad935069c8bd418261 */ - sha?: string; + sha?: string /** @example 12 */ - size?: number; + size?: number /** @example https://api.github.com/repos/owner-482f3203ecf01f67e9deb18e/BBB_Private_Repo/git/blobs/23f6827669e43831def8a7ad935069c8bd418261 */ - url?: string; - }[]; - }; + url?: string + }[] + } /** Hook Response */ - "hook-response": { - code: number | null; - status: string | null; - message: string | null; - }; + 'hook-response': { + code: number | null + status: string | null + message: string | null + } /** * Webhook * @description Webhooks for repositories. */ hook: { - type: string; + type: string /** * @description Unique identifier of the webhook. * @example 42 */ - id: number; + id: number /** * @description The name of a valid service, use 'web' for a webhook. * @example web */ - name: string; + name: string /** * @description Determines whether the hook is actually triggered on pushes. * @example true */ - active: boolean; + active: boolean /** * @description Determines what events the hook is triggered for. Default: ['push']. * @example push,pull_request */ - events: string[]; + events: string[] config: { /** @example "foo@bar.com" */ - email?: string; + email?: string /** @example "foo" */ - password?: string; + password?: string /** @example "roomer" */ - room?: string; + room?: string /** @example "foo" */ - subdomain?: string; - url?: components["schemas"]["webhook-config-url"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - content_type?: components["schemas"]["webhook-config-content-type"]; + subdomain?: string + url?: components['schemas']['webhook-config-url'] + insecure_ssl?: components['schemas']['webhook-config-insecure-ssl'] + content_type?: components['schemas']['webhook-config-content-type'] /** @example "sha256" */ - digest?: string; - secret?: components["schemas"]["webhook-config-secret"]; + digest?: string + secret?: components['schemas']['webhook-config-secret'] /** @example "abc" */ - token?: string; - }; + token?: string + } /** * Format: date-time * @example 2011-09-06T20:39:23Z */ - updated_at: string; + updated_at: string /** * Format: date-time * @example 2011-09-06T17:26:27Z */ - created_at: string; + created_at: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1 */ - url: string; + url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/test */ - test_url: string; + test_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/pings */ - ping_url: string; + ping_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries */ - deliveries_url?: string; - last_response: components["schemas"]["hook-response"]; - }; + deliveries_url?: string + last_response: components['schemas']['hook-response'] + } /** * Import * @description A repository import from an external source. */ import: { - vcs: string | null; - use_lfs?: boolean; + vcs: string | null + use_lfs?: boolean /** @description The URL of the originating repository. */ - vcs_url: string; - svc_root?: string; - tfvc_project?: string; + vcs_url: string + svc_root?: string + tfvc_project?: string /** @enum {string} */ status: - | "auth" - | "error" - | "none" - | "detecting" - | "choose" - | "auth_failed" - | "importing" - | "mapping" - | "waiting_to_push" - | "pushing" - | "complete" - | "setup" - | "unknown" - | "detection_found_multiple" - | "detection_found_nothing" - | "detection_needs_auth"; - status_text?: string | null; - failed_step?: string | null; - error_message?: string | null; - import_percent?: number | null; - commit_count?: number | null; - push_percent?: number | null; - has_large_files?: boolean; - large_files_size?: number; - large_files_count?: number; + | 'auth' + | 'error' + | 'none' + | 'detecting' + | 'choose' + | 'auth_failed' + | 'importing' + | 'mapping' + | 'waiting_to_push' + | 'pushing' + | 'complete' + | 'setup' + | 'unknown' + | 'detection_found_multiple' + | 'detection_found_nothing' + | 'detection_needs_auth' + status_text?: string | null + failed_step?: string | null + error_message?: string | null + import_percent?: number | null + commit_count?: number | null + push_percent?: number | null + has_large_files?: boolean + large_files_size?: number + large_files_count?: number project_choices?: { - vcs?: string; - tfvc_project?: string; - human_name?: string; - }[]; - message?: string; - authors_count?: number | null; + vcs?: string + tfvc_project?: string + human_name?: string + }[] + message?: string + authors_count?: number | null /** Format: uri */ - url: string; + url: string /** Format: uri */ - html_url: string; + html_url: string /** Format: uri */ - authors_url: string; + authors_url: string /** Format: uri */ - repository_url: string; - svn_root?: string; - }; + repository_url: string + svn_root?: string + } /** * Porter Author * @description Porter Author */ - "porter-author": { - id: number; - remote_id: string; - remote_name: string; - email: string; - name: string; + 'porter-author': { + id: number + remote_id: string + remote_name: string + email: string + name: string /** Format: uri */ - url: string; + url: string /** Format: uri */ - import_url: string; - }; + import_url: string + } /** * Porter Large File * @description Porter Large File */ - "porter-large-file": { - ref_name: string; - path: string; - oid: string; - size: number; - }; + 'porter-large-file': { + ref_name: string + path: string + oid: string + size: number + } /** * Issue * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. */ - "nullable-issue": { - id: number; - node_id: string; + 'nullable-issue': { + id: number + node_id: string /** * Format: uri * @description URL for the issue * @example https://api.github.com/repositories/42/issues/1 */ - url: string; + url: string /** Format: uri */ - repository_url: string; - labels_url: string; + repository_url: string + labels_url: string /** Format: uri */ - comments_url: string; + comments_url: string /** Format: uri */ - events_url: string; + events_url: string /** Format: uri */ - html_url: string; + html_url: string /** * @description Number uniquely identifying the issue within its repository * @example 42 */ - number: number; + number: number /** * @description State of the issue; either 'open' or 'closed' * @example open */ - state: string; + state: string /** * @description Title of the issue * @example Widget creation fails in Safari on OS X 10.8 */ - title: string; + title: string /** * @description Contents of the issue * @example It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug? */ - body?: string | null; - user: components["schemas"]["nullable-simple-user"]; + body?: string | null + user: components['schemas']['nullable-simple-user'] /** * @description Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository * @example bug,registration @@ -14264,456 +14252,456 @@ export type components = { | string | { /** Format: int64 */ - id?: number; - node_id?: string; + id?: number + node_id?: string /** Format: uri */ - url?: string; - name?: string; - description?: string | null; - color?: string | null; - default?: boolean; + url?: string + name?: string + description?: string | null + color?: string | null + default?: boolean } - )[]; - assignee: components["schemas"]["nullable-simple-user"]; - assignees?: components["schemas"]["simple-user"][] | null; - milestone: components["schemas"]["nullable-milestone"]; - locked: boolean; - active_lock_reason?: string | null; - comments: number; + )[] + assignee: components['schemas']['nullable-simple-user'] + assignees?: components['schemas']['simple-user'][] | null + milestone: components['schemas']['nullable-milestone'] + locked: boolean + active_lock_reason?: string | null + comments: number pull_request?: { /** Format: date-time */ - merged_at?: string | null; + merged_at?: string | null /** Format: uri */ - diff_url: string | null; + diff_url: string | null /** Format: uri */ - html_url: string | null; + html_url: string | null /** Format: uri */ - patch_url: string | null; + patch_url: string | null /** Format: uri */ - url: string | null; - }; + url: string | null + } /** Format: date-time */ - closed_at: string | null; + closed_at: string | null /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - draft?: boolean; - closed_by?: components["schemas"]["nullable-simple-user"]; - body_html?: string; - body_text?: string; + updated_at: string + draft?: boolean + closed_by?: components['schemas']['nullable-simple-user'] + body_html?: string + body_text?: string /** Format: uri */ - timeline_url?: string; - repository?: components["schemas"]["repository"]; - performed_via_github_app?: components["schemas"]["nullable-integration"]; - author_association: components["schemas"]["author_association"]; - reactions?: components["schemas"]["reaction-rollup"]; - } | null; + timeline_url?: string + repository?: components['schemas']['repository'] + performed_via_github_app?: components['schemas']['nullable-integration'] + author_association: components['schemas']['author_association'] + reactions?: components['schemas']['reaction-rollup'] + } | null /** * Issue Event Label * @description Issue Event Label */ - "issue-event-label": { - name: string | null; - color: string | null; - }; + 'issue-event-label': { + name: string | null + color: string | null + } /** Issue Event Dismissed Review */ - "issue-event-dismissed-review": { - state: string; - review_id: number; - dismissal_message: string | null; - dismissal_commit_id?: string | null; - }; + 'issue-event-dismissed-review': { + state: string + review_id: number + dismissal_message: string | null + dismissal_commit_id?: string | null + } /** * Issue Event Milestone * @description Issue Event Milestone */ - "issue-event-milestone": { - title: string; - }; + 'issue-event-milestone': { + title: string + } /** * Issue Event Project Card * @description Issue Event Project Card */ - "issue-event-project-card": { + 'issue-event-project-card': { /** Format: uri */ - url: string; - id: number; + url: string + id: number /** Format: uri */ - project_url: string; - project_id: number; - column_name: string; - previous_column_name?: string; - }; + project_url: string + project_id: number + column_name: string + previous_column_name?: string + } /** * Issue Event Rename * @description Issue Event Rename */ - "issue-event-rename": { - from: string; - to: string; - }; + 'issue-event-rename': { + from: string + to: string + } /** * Issue Event * @description Issue Event */ - "issue-event": { + 'issue-event': { /** @example 1 */ - id: number; + id: number /** @example MDEwOklzc3VlRXZlbnQx */ - node_id: string; + node_id: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/events/1 */ - url: string; - actor: components["schemas"]["nullable-simple-user"]; + url: string + actor: components['schemas']['nullable-simple-user'] /** @example closed */ - event: string; + event: string /** @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */ - commit_id: string | null; + commit_id: string | null /** @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e */ - commit_url: string | null; + commit_url: string | null /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - created_at: string; - issue?: components["schemas"]["nullable-issue"]; - label?: components["schemas"]["issue-event-label"]; - assignee?: components["schemas"]["nullable-simple-user"]; - assigner?: components["schemas"]["nullable-simple-user"]; - review_requester?: components["schemas"]["nullable-simple-user"]; - requested_reviewer?: components["schemas"]["nullable-simple-user"]; - requested_team?: components["schemas"]["team"]; - dismissed_review?: components["schemas"]["issue-event-dismissed-review"]; - milestone?: components["schemas"]["issue-event-milestone"]; - project_card?: components["schemas"]["issue-event-project-card"]; - rename?: components["schemas"]["issue-event-rename"]; - author_association?: components["schemas"]["author_association"]; - lock_reason?: string | null; - performed_via_github_app?: components["schemas"]["nullable-integration"]; - }; + created_at: string + issue?: components['schemas']['nullable-issue'] + label?: components['schemas']['issue-event-label'] + assignee?: components['schemas']['nullable-simple-user'] + assigner?: components['schemas']['nullable-simple-user'] + review_requester?: components['schemas']['nullable-simple-user'] + requested_reviewer?: components['schemas']['nullable-simple-user'] + requested_team?: components['schemas']['team'] + dismissed_review?: components['schemas']['issue-event-dismissed-review'] + milestone?: components['schemas']['issue-event-milestone'] + project_card?: components['schemas']['issue-event-project-card'] + rename?: components['schemas']['issue-event-rename'] + author_association?: components['schemas']['author_association'] + lock_reason?: string | null + performed_via_github_app?: components['schemas']['nullable-integration'] + } /** * Labeled Issue Event * @description Labeled Issue Event */ - "labeled-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; + 'labeled-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] label: { - name: string; - color: string; - }; - }; + name: string + color: string + } + } /** * Unlabeled Issue Event * @description Unlabeled Issue Event */ - "unlabeled-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; + 'unlabeled-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] label: { - name: string; - color: string; - }; - }; + name: string + color: string + } + } /** * Assigned Issue Event * @description Assigned Issue Event */ - "assigned-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["integration"]; - assignee: components["schemas"]["simple-user"]; - assigner: components["schemas"]["simple-user"]; - }; + 'assigned-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['integration'] + assignee: components['schemas']['simple-user'] + assigner: components['schemas']['simple-user'] + } /** * Unassigned Issue Event * @description Unassigned Issue Event */ - "unassigned-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; - assignee: components["schemas"]["simple-user"]; - assigner: components["schemas"]["simple-user"]; - }; + 'unassigned-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] + assignee: components['schemas']['simple-user'] + assigner: components['schemas']['simple-user'] + } /** * Milestoned Issue Event * @description Milestoned Issue Event */ - "milestoned-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; + 'milestoned-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] milestone: { - title: string; - }; - }; + title: string + } + } /** * Demilestoned Issue Event * @description Demilestoned Issue Event */ - "demilestoned-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; + 'demilestoned-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] milestone: { - title: string; - }; - }; + title: string + } + } /** * Renamed Issue Event * @description Renamed Issue Event */ - "renamed-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; + 'renamed-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] rename: { - from: string; - to: string; - }; - }; + from: string + to: string + } + } /** * Review Requested Issue Event * @description Review Requested Issue Event */ - "review-requested-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; - review_requester: components["schemas"]["simple-user"]; - requested_team?: components["schemas"]["team"]; - requested_reviewer?: components["schemas"]["simple-user"]; - }; + 'review-requested-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] + review_requester: components['schemas']['simple-user'] + requested_team?: components['schemas']['team'] + requested_reviewer?: components['schemas']['simple-user'] + } /** * Review Request Removed Issue Event * @description Review Request Removed Issue Event */ - "review-request-removed-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; - review_requester: components["schemas"]["simple-user"]; - requested_team?: components["schemas"]["team"]; - requested_reviewer?: components["schemas"]["simple-user"]; - }; + 'review-request-removed-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] + review_requester: components['schemas']['simple-user'] + requested_team?: components['schemas']['team'] + requested_reviewer?: components['schemas']['simple-user'] + } /** * Review Dismissed Issue Event * @description Review Dismissed Issue Event */ - "review-dismissed-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; + 'review-dismissed-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] dismissed_review: { - state: string; - review_id: number; - dismissal_message: string | null; - dismissal_commit_id?: string; - }; - }; + state: string + review_id: number + dismissal_message: string | null + dismissal_commit_id?: string + } + } /** * Locked Issue Event * @description Locked Issue Event */ - "locked-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; + 'locked-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] /** @example "off-topic" */ - lock_reason: string | null; - }; + lock_reason: string | null + } /** * Added to Project Issue Event * @description Added to Project Issue Event */ - "added-to-project-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; + 'added-to-project-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] project_card?: { - id: number; + id: number /** Format: uri */ - url: string; - project_id: number; + url: string + project_id: number /** Format: uri */ - project_url: string; - column_name: string; - previous_column_name?: string; - }; - }; + project_url: string + column_name: string + previous_column_name?: string + } + } /** * Moved Column in Project Issue Event * @description Moved Column in Project Issue Event */ - "moved-column-in-project-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; + 'moved-column-in-project-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] project_card?: { - id: number; + id: number /** Format: uri */ - url: string; - project_id: number; + url: string + project_id: number /** Format: uri */ - project_url: string; - column_name: string; - previous_column_name?: string; - }; - }; + project_url: string + column_name: string + previous_column_name?: string + } + } /** * Removed from Project Issue Event * @description Removed from Project Issue Event */ - "removed-from-project-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; + 'removed-from-project-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] project_card?: { - id: number; + id: number /** Format: uri */ - url: string; - project_id: number; + url: string + project_id: number /** Format: uri */ - project_url: string; - column_name: string; - previous_column_name?: string; - }; - }; + project_url: string + column_name: string + previous_column_name?: string + } + } /** * Converted Note to Issue Issue Event * @description Converted Note to Issue Issue Event */ - "converted-note-to-issue-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["integration"]; + 'converted-note-to-issue-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['integration'] project_card?: { - id: number; + id: number /** Format: uri */ - url: string; - project_id: number; + url: string + project_id: number /** Format: uri */ - project_url: string; - column_name: string; - previous_column_name?: string; - }; - }; + project_url: string + column_name: string + previous_column_name?: string + } + } /** * Issue Event for Issue * @description Issue Event for Issue */ - "issue-event-for-issue": Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial; + 'issue-event-for-issue': Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial /** * Label * @description Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -14723,105 +14711,105 @@ export type components = { * Format: int64 * @example 208045946 */ - id: number; + id: number /** @example MDU6TGFiZWwyMDgwNDU5NDY= */ - node_id: string; + node_id: string /** * Format: uri * @description URL for the label * @example https://api.github.com/repositories/42/labels/bug */ - url: string; + url: string /** * @description The name of the label. * @example bug */ - name: string; + name: string /** @example Something isn't working */ - description: string | null; + description: string | null /** * @description 6-character hex code, without the leading #, identifying the color * @example FFFFFF */ - color: string; + color: string /** @example true */ - default: boolean; - }; + default: boolean + } /** * Timeline Comment Event * @description Timeline Comment Event */ - "timeline-comment-event": { - event: string; - actor: components["schemas"]["simple-user"]; + 'timeline-comment-event': { + event: string + actor: components['schemas']['simple-user'] /** * @description Unique identifier of the issue comment * @example 42 */ - id: number; - node_id: string; + id: number + node_id: string /** * Format: uri * @description URL for the issue comment * @example https://api.github.com/repositories/42/issues/comments/1 */ - url: string; + url: string /** * @description Contents of the issue comment * @example What version of Safari were you using when you observed this bug? */ - body?: string; - body_text?: string; - body_html?: string; + body?: string + body_text?: string + body_html?: string /** Format: uri */ - html_url: string; - user: components["schemas"]["simple-user"]; + html_url: string + user: components['schemas']['simple-user'] /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - updated_at: string; + updated_at: string /** Format: uri */ - issue_url: string; - author_association: components["schemas"]["author_association"]; - performed_via_github_app?: components["schemas"]["nullable-integration"]; - reactions?: components["schemas"]["reaction-rollup"]; - }; + issue_url: string + author_association: components['schemas']['author_association'] + performed_via_github_app?: components['schemas']['nullable-integration'] + reactions?: components['schemas']['reaction-rollup'] + } /** * Timeline Cross Referenced Event * @description Timeline Cross Referenced Event */ - "timeline-cross-referenced-event": { - event: string; - actor?: components["schemas"]["simple-user"]; + 'timeline-cross-referenced-event': { + event: string + actor?: components['schemas']['simple-user'] /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; + updated_at: string source: { - type?: string; - issue?: components["schemas"]["issue"]; - }; - }; + type?: string + issue?: components['schemas']['issue'] + } + } /** * Timeline Committed Event * @description Timeline Committed Event */ - "timeline-committed-event": { - event?: string; + 'timeline-committed-event': { + event?: string /** * @description SHA for the commit * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - sha: string; - node_id: string; + sha: string + node_id: string /** Format: uri */ - url: string; + url: string /** @description Identifying information for the git-user */ author: { /** @@ -14829,18 +14817,18 @@ export type components = { * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 */ - date: string; + date: string /** * @description Git email address of the user * @example monalisa.octocat@example.com */ - email: string; + email: string /** * @description Name of the git user * @example Monalisa Octocat */ - name: string; - }; + name: string + } /** @description Identifying information for the git-user */ committer: { /** @@ -14848,386 +14836,386 @@ export type components = { * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 */ - date: string; + date: string /** * @description Git email address of the user * @example monalisa.octocat@example.com */ - email: string; + email: string /** * @description Name of the git user * @example Monalisa Octocat */ - name: string; - }; + name: string + } /** * @description Message describing the purpose of the commit * @example Fix #42 */ - message: string; + message: string tree: { /** * @description SHA for the commit * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - sha: string; + sha: string /** Format: uri */ - url: string; - }; + url: string + } parents: { /** * @description SHA for the commit * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - sha: string; + sha: string /** Format: uri */ - url: string; + url: string /** Format: uri */ - html_url: string; - }[]; + html_url: string + }[] verification: { - verified: boolean; - reason: string; - signature: string | null; - payload: string | null; - }; + verified: boolean + reason: string + signature: string | null + payload: string | null + } /** Format: uri */ - html_url: string; - }; + html_url: string + } /** * Timeline Reviewed Event * @description Timeline Reviewed Event */ - "timeline-reviewed-event": { - event: string; + 'timeline-reviewed-event': { + event: string /** * @description Unique identifier of the review * @example 42 */ - id: number; + id: number /** @example MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= */ - node_id: string; - user: components["schemas"]["simple-user"]; + node_id: string + user: components['schemas']['simple-user'] /** * @description The text of the review. * @example This looks great. */ - body: string | null; + body: string | null /** @example CHANGES_REQUESTED */ - state: string; + state: string /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/12 */ - pull_request_url: string; + pull_request_url: string _links: { html: { - href: string; - }; + href: string + } pull_request: { - href: string; - }; - }; + href: string + } + } /** Format: date-time */ - submitted_at?: string; + submitted_at?: string /** * @description A commit SHA for the review. * @example 54bb654c9e6025347f57900a4a5c2313a96b8035 */ - commit_id: string; - body_html?: string; - body_text?: string; - author_association: components["schemas"]["author_association"]; - }; + commit_id: string + body_html?: string + body_text?: string + author_association: components['schemas']['author_association'] + } /** * Pull Request Review Comment * @description Pull Request Review Comments are comments on a portion of the Pull Request's diff. */ - "pull-request-review-comment": { + 'pull-request-review-comment': { /** * @description URL for the pull request review comment * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ - url: string; + url: string /** * @description The ID of the pull request review to which the comment belongs. * @example 42 */ - pull_request_review_id: number | null; + pull_request_review_id: number | null /** * @description The ID of the pull request review comment. * @example 1 */ - id: number; + id: number /** * @description The node ID of the pull request review comment. * @example MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw */ - node_id: string; + node_id: string /** * @description The diff of the line that the comment refers to. * @example @@ -16,33 +16,40 @@ public class Connection : IConnection... */ - diff_hunk: string; + diff_hunk: string /** * @description The relative path of the file to which the comment applies. * @example config/database.yaml */ - path: string; + path: string /** * @description The line index in the diff to which the comment applies. * @example 1 */ - position: number; + position: number /** * @description The index of the original line in the diff to which the comment applies. * @example 4 */ - original_position: number; + original_position: number /** * @description The SHA of the commit to which the comment applies. * @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */ - commit_id: string; + commit_id: string /** * @description The SHA of the original commit to which the comment applies. * @example 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 */ - original_commit_id: string; + original_commit_id: string /** * @description The comment ID to reply to. * @example 8 */ - in_reply_to_id?: number; - user: components["schemas"]["simple-user"]; + in_reply_to_id?: number + user: components['schemas']['simple-user'] /** * @description The text of the comment. * @example We should probably include a check for null values here. */ - body: string; + body: string /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - updated_at: string; + updated_at: string /** * Format: uri * @description HTML URL for the pull request review comment. * @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 */ - html_url: string; + html_url: string /** * Format: uri * @description URL for the pull request that the review comment belongs to. * @example https://api.github.com/repos/octocat/Hello-World/pulls/1 */ - pull_request_url: string; - author_association: components["schemas"]["author_association"]; + pull_request_url: string + author_association: components['schemas']['author_association'] _links: { self: { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ - href: string; - }; + href: string + } html: { /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 */ - href: string; - }; + href: string + } pull_request: { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1 */ - href: string; - }; - }; + href: string + } + } /** * @description The first line of the range for a multi-line comment. * @example 2 */ - start_line?: number | null; + start_line?: number | null /** * @description The first line of the range for a multi-line comment. * @example 2 */ - original_start_line?: number | null; + original_start_line?: number | null /** * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} */ - start_side?: ("LEFT" | "RIGHT") | null; + start_side?: ('LEFT' | 'RIGHT') | null /** * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment * @example 2 */ - line?: number; + line?: number /** * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment * @example 2 */ - original_line?: number; + original_line?: number /** * @description The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment * @default RIGHT * @enum {string} */ - side?: "LEFT" | "RIGHT"; - reactions?: components["schemas"]["reaction-rollup"]; + side?: 'LEFT' | 'RIGHT' + reactions?: components['schemas']['reaction-rollup'] /** @example "

comment body

" */ - body_html?: string; + body_html?: string /** @example "comment body" */ - body_text?: string; - }; + body_text?: string + } /** * Timeline Line Commented Event * @description Timeline Line Commented Event */ - "timeline-line-commented-event": { - event?: string; - node_id?: string; - comments?: components["schemas"]["pull-request-review-comment"][]; - }; + 'timeline-line-commented-event': { + event?: string + node_id?: string + comments?: components['schemas']['pull-request-review-comment'][] + } /** * Timeline Commit Commented Event * @description Timeline Commit Commented Event */ - "timeline-commit-commented-event": { - event?: string; - node_id?: string; - commit_id?: string; - comments?: components["schemas"]["commit-comment"][]; - }; + 'timeline-commit-commented-event': { + event?: string + node_id?: string + commit_id?: string + comments?: components['schemas']['commit-comment'][] + } /** * Timeline Assigned Issue Event * @description Timeline Assigned Issue Event */ - "timeline-assigned-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; - assignee: components["schemas"]["simple-user"]; - }; + 'timeline-assigned-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] + assignee: components['schemas']['simple-user'] + } /** * Timeline Unassigned Issue Event * @description Timeline Unassigned Issue Event */ - "timeline-unassigned-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; - assignee: components["schemas"]["simple-user"]; - }; + 'timeline-unassigned-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] + assignee: components['schemas']['simple-user'] + } /** * Timeline Event * @description Timeline Event */ - "timeline-issue-events": Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial; + 'timeline-issue-events': Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial /** * Deploy Key * @description An SSH key granting access to a single repository. */ - "deploy-key": { - id: number; - key: string; - url: string; - title: string; - verified: boolean; - created_at: string; - read_only: boolean; - }; + 'deploy-key': { + id: number + key: string + url: string + title: string + verified: boolean + created_at: string + read_only: boolean + } /** * Language * @description Language */ - language: { [key: string]: number }; + language: { [key: string]: number } /** * License Content * @description License Content */ - "license-content": { - name: string; - path: string; - sha: string; - size: number; + 'license-content': { + name: string + path: string + sha: string + size: number /** Format: uri */ - url: string; + url: string /** Format: uri */ - html_url: string | null; + html_url: string | null /** Format: uri */ - git_url: string | null; + git_url: string | null /** Format: uri */ - download_url: string | null; - type: string; - content: string; - encoding: string; + download_url: string | null + type: string + content: string + encoding: string _links: { /** Format: uri */ - git: string | null; + git: string | null /** Format: uri */ - html: string | null; + html: string | null /** Format: uri */ - self: string; - }; - license: components["schemas"]["nullable-license-simple"]; - }; + self: string + } + license: components['schemas']['nullable-license-simple'] + } /** * Merged upstream * @description Results of a successful merge upstream request */ - "merged-upstream": { - message?: string; + 'merged-upstream': { + message?: string /** @enum {string} */ - merge_type?: "merge" | "fast-forward" | "none"; - base_branch?: string; - }; + merge_type?: 'merge' | 'fast-forward' | 'none' + base_branch?: string + } /** * Milestone * @description A collection of related issues and pull requests. @@ -15237,100 +15225,100 @@ export type components = { * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1 */ - url: string; + url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/milestones/v1.0 */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1/labels */ - labels_url: string; + labels_url: string /** @example 1002604 */ - id: number; + id: number /** @example MDk6TWlsZXN0b25lMTAwMjYwNA== */ - node_id: string; + node_id: string /** * @description The number of the milestone. * @example 42 */ - number: number; + number: number /** * @description The state of the milestone. * @default open * @example open * @enum {string} */ - state: "open" | "closed"; + state: 'open' | 'closed' /** * @description The title of the milestone. * @example v1.0 */ - title: string; + title: string /** @example Tracking milestone for version 1.0 */ - description: string | null; - creator: components["schemas"]["nullable-simple-user"]; + description: string | null + creator: components['schemas']['nullable-simple-user'] /** @example 4 */ - open_issues: number; + open_issues: number /** @example 8 */ - closed_issues: number; + closed_issues: number /** * Format: date-time * @example 2011-04-10T20:09:31Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2014-03-03T18:58:10Z */ - updated_at: string; + updated_at: string /** * Format: date-time * @example 2013-02-12T13:22:01Z */ - closed_at: string | null; + closed_at: string | null /** * Format: date-time * @example 2012-10-09T23:39:01Z */ - due_on: string | null; - }; + due_on: string | null + } /** Pages Source Hash */ - "pages-source-hash": { - branch: string; - path: string; - }; + 'pages-source-hash': { + branch: string + path: string + } /** Pages Https Certificate */ - "pages-https-certificate": { + 'pages-https-certificate': { /** * @example approved * @enum {string} */ state: - | "new" - | "authorization_created" - | "authorization_pending" - | "authorized" - | "authorization_revoked" - | "issued" - | "uploaded" - | "approved" - | "errored" - | "bad_authz" - | "destroy_pending" - | "dns_changed"; + | 'new' + | 'authorization_created' + | 'authorization_pending' + | 'authorized' + | 'authorization_revoked' + | 'issued' + | 'uploaded' + | 'approved' + | 'errored' + | 'bad_authz' + | 'destroy_pending' + | 'dns_changed' /** @example Certificate is approved */ - description: string; + description: string /** * @description Array of the domain set and its alternate name (if it is configured) * @example example.com,www.example.com */ - domains: string[]; + domains: string[] /** Format: date */ - expires_at?: string; - }; + expires_at?: string + } /** * GitHub Pages * @description The configuration for GitHub Pages for a repository. @@ -15341,1967 +15329,1967 @@ export type components = { * @description The API address for accessing this Page resource. * @example https://api.github.com/repos/github/hello-world/pages */ - url: string; + url: string /** * @description The status of the most recent build of the Page. * @example built * @enum {string|null} */ - status: ("built" | "building" | "errored") | null; + status: ('built' | 'building' | 'errored') | null /** * @description The Pages site's custom domain * @example example.com */ - cname: string | null; + cname: string | null /** * @description The state if the domain is verified * @example pending * @enum {string|null} */ - protected_domain_state?: ("pending" | "verified" | "unverified") | null; + protected_domain_state?: ('pending' | 'verified' | 'unverified') | null /** * Format: date-time * @description The timestamp when a pending domain becomes unverified. */ - pending_domain_unverified_at?: string | null; + pending_domain_unverified_at?: string | null /** @description Whether the Page has a custom 404 page. */ - custom_404: boolean; + custom_404: boolean /** * Format: uri * @description The web address the Page can be accessed from. * @example https://example.com */ - html_url?: string; - source?: components["schemas"]["pages-source-hash"]; + html_url?: string + source?: components['schemas']['pages-source-hash'] /** * @description Whether the GitHub Pages site is publicly visible. If set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. * @example true */ - public: boolean; - https_certificate?: components["schemas"]["pages-https-certificate"]; + public: boolean + https_certificate?: components['schemas']['pages-https-certificate'] /** * @description Whether https is enabled on the domain * @example true */ - https_enforced?: boolean; - }; + https_enforced?: boolean + } /** * Page Build * @description Page Build */ - "page-build": { + 'page-build': { /** Format: uri */ - url: string; - status: string; + url: string + status: string error: { - message: string | null; - }; - pusher: components["schemas"]["nullable-simple-user"]; - commit: string; - duration: number; + message: string | null + } + pusher: components['schemas']['nullable-simple-user'] + commit: string + duration: number /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - }; + updated_at: string + } /** * Page Build Status * @description Page Build Status */ - "page-build-status": { + 'page-build-status': { /** * Format: uri * @example https://api.github.com/repos/github/hello-world/pages/builds/latest */ - url: string; + url: string /** @example queued */ - status: string; - }; + status: string + } /** * Pages Health Check Status * @description Pages Health Check Status */ - "pages-health-check": { + 'pages-health-check': { domain?: { - host?: string; - uri?: string; - nameservers?: string; - dns_resolves?: boolean; - is_proxied?: boolean | null; - is_cloudflare_ip?: boolean | null; - is_fastly_ip?: boolean | null; - is_old_ip_address?: boolean | null; - is_a_record?: boolean | null; - has_cname_record?: boolean | null; - has_mx_records_present?: boolean | null; - is_valid_domain?: boolean; - is_apex_domain?: boolean; - should_be_a_record?: boolean | null; - is_cname_to_github_user_domain?: boolean | null; - is_cname_to_pages_dot_github_dot_com?: boolean | null; - is_cname_to_fastly?: boolean | null; - is_pointed_to_github_pages_ip?: boolean | null; - is_non_github_pages_ip_present?: boolean | null; - is_pages_domain?: boolean; - is_served_by_pages?: boolean | null; - is_valid?: boolean; - reason?: string | null; - responds_to_https?: boolean; - enforces_https?: boolean; - https_error?: string | null; - is_https_eligible?: boolean | null; - caa_error?: string | null; - }; + host?: string + uri?: string + nameservers?: string + dns_resolves?: boolean + is_proxied?: boolean | null + is_cloudflare_ip?: boolean | null + is_fastly_ip?: boolean | null + is_old_ip_address?: boolean | null + is_a_record?: boolean | null + has_cname_record?: boolean | null + has_mx_records_present?: boolean | null + is_valid_domain?: boolean + is_apex_domain?: boolean + should_be_a_record?: boolean | null + is_cname_to_github_user_domain?: boolean | null + is_cname_to_pages_dot_github_dot_com?: boolean | null + is_cname_to_fastly?: boolean | null + is_pointed_to_github_pages_ip?: boolean | null + is_non_github_pages_ip_present?: boolean | null + is_pages_domain?: boolean + is_served_by_pages?: boolean | null + is_valid?: boolean + reason?: string | null + responds_to_https?: boolean + enforces_https?: boolean + https_error?: string | null + is_https_eligible?: boolean | null + caa_error?: string | null + } alt_domain?: { - host?: string; - uri?: string; - nameservers?: string; - dns_resolves?: boolean; - is_proxied?: boolean | null; - is_cloudflare_ip?: boolean | null; - is_fastly_ip?: boolean | null; - is_old_ip_address?: boolean | null; - is_a_record?: boolean | null; - has_cname_record?: boolean | null; - has_mx_records_present?: boolean | null; - is_valid_domain?: boolean; - is_apex_domain?: boolean; - should_be_a_record?: boolean | null; - is_cname_to_github_user_domain?: boolean | null; - is_cname_to_pages_dot_github_dot_com?: boolean | null; - is_cname_to_fastly?: boolean | null; - is_pointed_to_github_pages_ip?: boolean | null; - is_non_github_pages_ip_present?: boolean | null; - is_pages_domain?: boolean; - is_served_by_pages?: boolean | null; - is_valid?: boolean; - reason?: string | null; - responds_to_https?: boolean; - enforces_https?: boolean; - https_error?: string | null; - is_https_eligible?: boolean | null; - caa_error?: string | null; - } | null; - }; + host?: string + uri?: string + nameservers?: string + dns_resolves?: boolean + is_proxied?: boolean | null + is_cloudflare_ip?: boolean | null + is_fastly_ip?: boolean | null + is_old_ip_address?: boolean | null + is_a_record?: boolean | null + has_cname_record?: boolean | null + has_mx_records_present?: boolean | null + is_valid_domain?: boolean + is_apex_domain?: boolean + should_be_a_record?: boolean | null + is_cname_to_github_user_domain?: boolean | null + is_cname_to_pages_dot_github_dot_com?: boolean | null + is_cname_to_fastly?: boolean | null + is_pointed_to_github_pages_ip?: boolean | null + is_non_github_pages_ip_present?: boolean | null + is_pages_domain?: boolean + is_served_by_pages?: boolean | null + is_valid?: boolean + reason?: string | null + responds_to_https?: boolean + enforces_https?: boolean + https_error?: string | null + is_https_eligible?: boolean | null + caa_error?: string | null + } | null + } /** * Team Simple * @description Groups of organization members that gives permissions on specified repositories. */ - "team-simple": { + 'team-simple': { /** * @description Unique identifier of the team * @example 1 */ - id: number; + id: number /** @example MDQ6VGVhbTE= */ - node_id: string; + node_id: string /** * Format: uri * @description URL for the team * @example https://api.github.com/organizations/1/team/1 */ - url: string; + url: string /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - members_url: string; + members_url: string /** * @description Name of the team * @example Justice League */ - name: string; + name: string /** * @description Description of the team * @example A great team. */ - description: string | null; + description: string | null /** * @description Permission that the team will have for its repositories * @example admin */ - permission: string; + permission: string /** * @description The level of privacy this team should have * @example closed */ - privacy?: string; + privacy?: string /** * Format: uri * @example https://github.com/orgs/rails/teams/core */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/organizations/1/team/1/repos */ - repositories_url: string; + repositories_url: string /** @example justice-league */ - slug: string; + slug: string /** * @description Distinguished Name (DN) that team maps to within LDAP environment * @example uid=example,ou=users,dc=github,dc=com */ - ldap_dn?: string; - }; + ldap_dn?: string + } /** * Pull Request * @description Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary. */ - "pull-request": { + 'pull-request': { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ - url: string; + url: string /** @example 1 */ - id: number; + id: number /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ - node_id: string; + node_id: string /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347 */ - html_url: string; + html_url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.diff */ - diff_url: string; + diff_url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.patch */ - patch_url: string; + patch_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 */ - issue_url: string; + issue_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits */ - commits_url: string; + commits_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments */ - review_comments_url: string; + review_comments_url: string /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} */ - review_comment_url: string; + review_comment_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347/comments */ - comments_url: string; + comments_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e */ - statuses_url: string; + statuses_url: string /** * @description Number uniquely identifying the pull request within its repository. * @example 42 */ - number: number; + number: number /** * @description State of this Pull Request. Either `open` or `closed`. * @example open * @enum {string} */ - state: "open" | "closed"; + state: 'open' | 'closed' /** @example true */ - locked: boolean; + locked: boolean /** * @description The title of the pull request. * @example Amazing new feature */ - title: string; - user: components["schemas"]["nullable-simple-user"]; + title: string + user: components['schemas']['nullable-simple-user'] /** @example Please pull these awesome changes */ - body: string | null; + body: string | null labels: { /** Format: int64 */ - id: number; - node_id: string; - url: string; - name: string; - description: string | null; - color: string; - default: boolean; - }[]; - milestone: components["schemas"]["nullable-milestone"]; + id: number + node_id: string + url: string + name: string + description: string | null + color: string + default: boolean + }[] + milestone: components['schemas']['nullable-milestone'] /** @example too heated */ - active_lock_reason?: string | null; + active_lock_reason?: string | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - updated_at: string; + updated_at: string /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - closed_at: string | null; + closed_at: string | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - merged_at: string | null; + merged_at: string | null /** @example e5bd3914e2e596debea16f433f57875b5b90bcd6 */ - merge_commit_sha: string | null; - assignee: components["schemas"]["nullable-simple-user"]; - assignees?: components["schemas"]["simple-user"][] | null; - requested_reviewers?: components["schemas"]["simple-user"][] | null; - requested_teams?: components["schemas"]["team-simple"][] | null; + merge_commit_sha: string | null + assignee: components['schemas']['nullable-simple-user'] + assignees?: components['schemas']['simple-user'][] | null + requested_reviewers?: components['schemas']['simple-user'][] | null + requested_teams?: components['schemas']['team-simple'][] | null head: { - label: string; - ref: string; + label: string + ref: string repo: { - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; + archive_url: string + assignees_url: string + blobs_url: string + branches_url: string + collaborators_url: string + comments_url: string + commits_url: string + compare_url: string + contents_url: string /** Format: uri */ - contributors_url: string; + contributors_url: string /** Format: uri */ - deployments_url: string; - description: string | null; + deployments_url: string + description: string | null /** Format: uri */ - downloads_url: string; + downloads_url: string /** Format: uri */ - events_url: string; - fork: boolean; + events_url: string + fork: boolean /** Format: uri */ - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; + forks_url: string + full_name: string + git_commits_url: string + git_refs_url: string + git_tags_url: string /** Format: uri */ - hooks_url: string; + hooks_url: string /** Format: uri */ - html_url: string; - id: number; - node_id: string; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; + html_url: string + id: number + node_id: string + issue_comment_url: string + issue_events_url: string + issues_url: string + keys_url: string + labels_url: string /** Format: uri */ - languages_url: string; + languages_url: string /** Format: uri */ - merges_url: string; - milestones_url: string; - name: string; - notifications_url: string; + merges_url: string + milestones_url: string + name: string + notifications_url: string owner: { /** Format: uri */ - avatar_url: string; - events_url: string; + avatar_url: string + events_url: string /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; + followers_url: string + following_url: string + gists_url: string + gravatar_id: string | null /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; + html_url: string + id: number + node_id: string + login: string /** Format: uri */ - organizations_url: string; + organizations_url: string /** Format: uri */ - received_events_url: string; + received_events_url: string /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; + repos_url: string + site_admin: boolean + starred_url: string /** Format: uri */ - subscriptions_url: string; - type: string; + subscriptions_url: string + type: string /** Format: uri */ - url: string; - }; - private: boolean; - pulls_url: string; - releases_url: string; + url: string + } + private: boolean + pulls_url: string + releases_url: string /** Format: uri */ - stargazers_url: string; - statuses_url: string; + stargazers_url: string + statuses_url: string /** Format: uri */ - subscribers_url: string; + subscribers_url: string /** Format: uri */ - subscription_url: string; + subscription_url: string /** Format: uri */ - tags_url: string; + tags_url: string /** Format: uri */ - teams_url: string; - trees_url: string; + teams_url: string + trees_url: string /** Format: uri */ - url: string; - clone_url: string; - default_branch: string; - forks: number; - forks_count: number; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_projects: boolean; - has_wiki: boolean; - has_pages: boolean; + url: string + clone_url: string + default_branch: string + forks: number + forks_count: number + git_url: string + has_downloads: boolean + has_issues: boolean + has_projects: boolean + has_wiki: boolean + has_pages: boolean /** Format: uri */ - homepage: string | null; - language: string | null; - master_branch?: string; - archived: boolean; - disabled: boolean; + homepage: string | null + language: string | null + master_branch?: string + archived: boolean + disabled: boolean /** @description The repository visibility: public, private, or internal. */ - visibility?: string; + visibility?: string /** Format: uri */ - mirror_url: string | null; - open_issues: number; - open_issues_count: number; + mirror_url: string | null + open_issues: number + open_issues_count: number permissions?: { - admin: boolean; - maintain?: boolean; - push: boolean; - triage?: boolean; - pull: boolean; - }; - temp_clone_token?: string; - allow_merge_commit?: boolean; - allow_squash_merge?: boolean; - allow_rebase_merge?: boolean; + admin: boolean + maintain?: boolean + push: boolean + triage?: boolean + pull: boolean + } + temp_clone_token?: string + allow_merge_commit?: boolean + allow_squash_merge?: boolean + allow_rebase_merge?: boolean license: { - key: string; - name: string; + key: string + name: string /** Format: uri */ - url: string | null; - spdx_id: string | null; - node_id: string; - } | null; + url: string | null + spdx_id: string | null + node_id: string + } | null /** Format: date-time */ - pushed_at: string; - size: number; - ssh_url: string; - stargazers_count: number; + pushed_at: string + size: number + ssh_url: string + stargazers_count: number /** Format: uri */ - svn_url: string; - topics?: string[]; - watchers: number; - watchers_count: number; + svn_url: string + topics?: string[] + watchers: number + watchers_count: number /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - allow_forking?: boolean; - is_template?: boolean; - } | null; - sha: string; + updated_at: string + allow_forking?: boolean + is_template?: boolean + } | null + sha: string user: { /** Format: uri */ - avatar_url: string; - events_url: string; + avatar_url: string + events_url: string /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; + followers_url: string + following_url: string + gists_url: string + gravatar_id: string | null /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; + html_url: string + id: number + node_id: string + login: string /** Format: uri */ - organizations_url: string; + organizations_url: string /** Format: uri */ - received_events_url: string; + received_events_url: string /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; + repos_url: string + site_admin: boolean + starred_url: string /** Format: uri */ - subscriptions_url: string; - type: string; + subscriptions_url: string + type: string /** Format: uri */ - url: string; - }; - }; + url: string + } + } base: { - label: string; - ref: string; + label: string + ref: string repo: { - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; + archive_url: string + assignees_url: string + blobs_url: string + branches_url: string + collaborators_url: string + comments_url: string + commits_url: string + compare_url: string + contents_url: string /** Format: uri */ - contributors_url: string; + contributors_url: string /** Format: uri */ - deployments_url: string; - description: string | null; + deployments_url: string + description: string | null /** Format: uri */ - downloads_url: string; + downloads_url: string /** Format: uri */ - events_url: string; - fork: boolean; + events_url: string + fork: boolean /** Format: uri */ - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; + forks_url: string + full_name: string + git_commits_url: string + git_refs_url: string + git_tags_url: string /** Format: uri */ - hooks_url: string; + hooks_url: string /** Format: uri */ - html_url: string; - id: number; - is_template?: boolean; - node_id: string; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; + html_url: string + id: number + is_template?: boolean + node_id: string + issue_comment_url: string + issue_events_url: string + issues_url: string + keys_url: string + labels_url: string /** Format: uri */ - languages_url: string; + languages_url: string /** Format: uri */ - merges_url: string; - milestones_url: string; - name: string; - notifications_url: string; + merges_url: string + milestones_url: string + name: string + notifications_url: string owner: { /** Format: uri */ - avatar_url: string; - events_url: string; + avatar_url: string + events_url: string /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; + followers_url: string + following_url: string + gists_url: string + gravatar_id: string | null /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; + html_url: string + id: number + node_id: string + login: string /** Format: uri */ - organizations_url: string; + organizations_url: string /** Format: uri */ - received_events_url: string; + received_events_url: string /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; + repos_url: string + site_admin: boolean + starred_url: string /** Format: uri */ - subscriptions_url: string; - type: string; + subscriptions_url: string + type: string /** Format: uri */ - url: string; - }; - private: boolean; - pulls_url: string; - releases_url: string; + url: string + } + private: boolean + pulls_url: string + releases_url: string /** Format: uri */ - stargazers_url: string; - statuses_url: string; + stargazers_url: string + statuses_url: string /** Format: uri */ - subscribers_url: string; + subscribers_url: string /** Format: uri */ - subscription_url: string; + subscription_url: string /** Format: uri */ - tags_url: string; + tags_url: string /** Format: uri */ - teams_url: string; - trees_url: string; + teams_url: string + trees_url: string /** Format: uri */ - url: string; - clone_url: string; - default_branch: string; - forks: number; - forks_count: number; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_projects: boolean; - has_wiki: boolean; - has_pages: boolean; + url: string + clone_url: string + default_branch: string + forks: number + forks_count: number + git_url: string + has_downloads: boolean + has_issues: boolean + has_projects: boolean + has_wiki: boolean + has_pages: boolean /** Format: uri */ - homepage: string | null; - language: string | null; - master_branch?: string; - archived: boolean; - disabled: boolean; + homepage: string | null + language: string | null + master_branch?: string + archived: boolean + disabled: boolean /** @description The repository visibility: public, private, or internal. */ - visibility?: string; + visibility?: string /** Format: uri */ - mirror_url: string | null; - open_issues: number; - open_issues_count: number; + mirror_url: string | null + open_issues: number + open_issues_count: number permissions?: { - admin: boolean; - maintain?: boolean; - push: boolean; - triage?: boolean; - pull: boolean; - }; - temp_clone_token?: string; - allow_merge_commit?: boolean; - allow_squash_merge?: boolean; - allow_rebase_merge?: boolean; - license: components["schemas"]["nullable-license-simple"]; + admin: boolean + maintain?: boolean + push: boolean + triage?: boolean + pull: boolean + } + temp_clone_token?: string + allow_merge_commit?: boolean + allow_squash_merge?: boolean + allow_rebase_merge?: boolean + license: components['schemas']['nullable-license-simple'] /** Format: date-time */ - pushed_at: string; - size: number; - ssh_url: string; - stargazers_count: number; + pushed_at: string + size: number + ssh_url: string + stargazers_count: number /** Format: uri */ - svn_url: string; - topics?: string[]; - watchers: number; - watchers_count: number; + svn_url: string + topics?: string[] + watchers: number + watchers_count: number /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - allow_forking?: boolean; - }; - sha: string; + updated_at: string + allow_forking?: boolean + } + sha: string user: { /** Format: uri */ - avatar_url: string; - events_url: string; + avatar_url: string + events_url: string /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; + followers_url: string + following_url: string + gists_url: string + gravatar_id: string | null /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; + html_url: string + id: number + node_id: string + login: string /** Format: uri */ - organizations_url: string; + organizations_url: string /** Format: uri */ - received_events_url: string; + received_events_url: string /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; + repos_url: string + site_admin: boolean + starred_url: string /** Format: uri */ - subscriptions_url: string; - type: string; + subscriptions_url: string + type: string /** Format: uri */ - url: string; - }; - }; + url: string + } + } _links: { - comments: components["schemas"]["link"]; - commits: components["schemas"]["link"]; - statuses: components["schemas"]["link"]; - html: components["schemas"]["link"]; - issue: components["schemas"]["link"]; - review_comments: components["schemas"]["link"]; - review_comment: components["schemas"]["link"]; - self: components["schemas"]["link"]; - }; - author_association: components["schemas"]["author_association"]; - auto_merge: components["schemas"]["auto_merge"]; + comments: components['schemas']['link'] + commits: components['schemas']['link'] + statuses: components['schemas']['link'] + html: components['schemas']['link'] + issue: components['schemas']['link'] + review_comments: components['schemas']['link'] + review_comment: components['schemas']['link'] + self: components['schemas']['link'] + } + author_association: components['schemas']['author_association'] + auto_merge: components['schemas']['auto_merge'] /** @description Indicates whether or not the pull request is a draft. */ - draft?: boolean; - merged: boolean; + draft?: boolean + merged: boolean /** @example true */ - mergeable: boolean | null; + mergeable: boolean | null /** @example true */ - rebaseable?: boolean | null; + rebaseable?: boolean | null /** @example clean */ - mergeable_state: string; - merged_by: components["schemas"]["nullable-simple-user"]; + mergeable_state: string + merged_by: components['schemas']['nullable-simple-user'] /** @example 10 */ - comments: number; - review_comments: number; + comments: number + review_comments: number /** * @description Indicates whether maintainers can modify the pull request. * @example true */ - maintainer_can_modify: boolean; + maintainer_can_modify: boolean /** @example 3 */ - commits: number; + commits: number /** @example 100 */ - additions: number; + additions: number /** @example 3 */ - deletions: number; + deletions: number /** @example 5 */ - changed_files: number; - }; + changed_files: number + } /** * Pull Request Merge Result * @description Pull Request Merge Result */ - "pull-request-merge-result": { - sha: string; - merged: boolean; - message: string; - }; + 'pull-request-merge-result': { + sha: string + merged: boolean + message: string + } /** * Pull Request Review Request * @description Pull Request Review Request */ - "pull-request-review-request": { - users: components["schemas"]["simple-user"][]; - teams: components["schemas"]["team"][]; - }; + 'pull-request-review-request': { + users: components['schemas']['simple-user'][] + teams: components['schemas']['team'][] + } /** * Pull Request Review * @description Pull Request Reviews are reviews on pull requests. */ - "pull-request-review": { + 'pull-request-review': { /** * @description Unique identifier of the review * @example 42 */ - id: number; + id: number /** @example MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= */ - node_id: string; - user: components["schemas"]["nullable-simple-user"]; + node_id: string + user: components['schemas']['nullable-simple-user'] /** * @description The text of the review. * @example This looks great. */ - body: string; + body: string /** @example CHANGES_REQUESTED */ - state: string; + state: string /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/12 */ - pull_request_url: string; + pull_request_url: string _links: { html: { - href: string; - }; + href: string + } pull_request: { - href: string; - }; - }; + href: string + } + } /** Format: date-time */ - submitted_at?: string; + submitted_at?: string /** * @description A commit SHA for the review. * @example 54bb654c9e6025347f57900a4a5c2313a96b8035 */ - commit_id: string; - body_html?: string; - body_text?: string; - author_association: components["schemas"]["author_association"]; - }; + commit_id: string + body_html?: string + body_text?: string + author_association: components['schemas']['author_association'] + } /** * Legacy Review Comment * @description Legacy Review Comment */ - "review-comment": { + 'review-comment': { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ - url: string; + url: string /** @example 42 */ - pull_request_review_id: number | null; + pull_request_review_id: number | null /** @example 10 */ - id: number; + id: number /** @example MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw */ - node_id: string; + node_id: string /** @example @@ -16,33 +16,40 @@ public class Connection : IConnection... */ - diff_hunk: string; + diff_hunk: string /** @example file1.txt */ - path: string; + path: string /** @example 1 */ - position: number | null; + position: number | null /** @example 4 */ - original_position: number; + original_position: number /** @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */ - commit_id: string; + commit_id: string /** @example 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 */ - original_commit_id: string; + original_commit_id: string /** @example 8 */ - in_reply_to_id?: number; - user: components["schemas"]["nullable-simple-user"]; + in_reply_to_id?: number + user: components['schemas']['nullable-simple-user'] /** @example Great stuff */ - body: string; + body: string /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - updated_at: string; + updated_at: string /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1 */ - pull_request_url: string; - author_association: components["schemas"]["author_association"]; + pull_request_url: string + author_association: components['schemas']['author_association'] _links: { - self: components["schemas"]["link"]; - html: components["schemas"]["link"]; - pull_request: components["schemas"]["link"]; - }; - body_text?: string; - body_html?: string; - reactions?: components["schemas"]["reaction-rollup"]; + self: components['schemas']['link'] + html: components['schemas']['link'] + pull_request: components['schemas']['link'] + } + body_text?: string + body_html?: string + reactions?: components['schemas']['reaction-rollup'] /** * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string} */ - side?: "LEFT" | "RIGHT"; + side?: 'LEFT' | 'RIGHT' /** * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} */ - start_side?: ("LEFT" | "RIGHT") | null; + start_side?: ('LEFT' | 'RIGHT') | null /** * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment * @example 2 */ - line?: number; + line?: number /** * @description The original line of the blob to which the comment applies. The last line of the range for a multi-line comment * @example 2 */ - original_line?: number; + original_line?: number /** * @description The first line of the range for a multi-line comment. * @example 2 */ - start_line?: number | null; + start_line?: number | null /** * @description The original first line of the range for a multi-line comment. * @example 2 */ - original_start_line?: number | null; - }; + original_start_line?: number | null + } /** * Release Asset * @description Data related to a release. */ - "release-asset": { + 'release-asset': { /** Format: uri */ - url: string; + url: string /** Format: uri */ - browser_download_url: string; - id: number; - node_id: string; + browser_download_url: string + id: number + node_id: string /** * @description The file name of the asset. * @example Team Environment */ - name: string; - label: string | null; + name: string + label: string | null /** * @description State of the release asset. * @enum {string} */ - state: "uploaded" | "open"; - content_type: string; - size: number; - download_count: number; + state: 'uploaded' | 'open' + content_type: string + size: number + download_count: number /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - uploader: components["schemas"]["nullable-simple-user"]; - }; + updated_at: string + uploader: components['schemas']['nullable-simple-user'] + } /** * Release * @description A release. */ release: { /** Format: uri */ - url: string; + url: string /** Format: uri */ - html_url: string; + html_url: string /** Format: uri */ - assets_url: string; - upload_url: string; + assets_url: string + upload_url: string /** Format: uri */ - tarball_url: string | null; + tarball_url: string | null /** Format: uri */ - zipball_url: string | null; - id: number; - node_id: string; + zipball_url: string | null + id: number + node_id: string /** * @description The name of the tag. * @example v1.0.0 */ - tag_name: string; + tag_name: string /** * @description Specifies the commitish value that determines where the Git tag is created from. * @example master */ - target_commitish: string; - name: string | null; - body?: string | null; + target_commitish: string + name: string | null + body?: string | null /** @description true to create a draft (unpublished) release, false to create a published one. */ - draft: boolean; + draft: boolean /** @description Whether to identify the release as a prerelease or a full release. */ - prerelease: boolean; + prerelease: boolean /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - published_at: string | null; - author: components["schemas"]["simple-user"]; - assets: components["schemas"]["release-asset"][]; - body_html?: string; - body_text?: string; - mentions_count?: number; + published_at: string | null + author: components['schemas']['simple-user'] + assets: components['schemas']['release-asset'][] + body_html?: string + body_text?: string + mentions_count?: number /** * Format: uri * @description The URL of the release discussion. */ - discussion_url?: string; - reactions?: components["schemas"]["reaction-rollup"]; - }; + discussion_url?: string + reactions?: components['schemas']['reaction-rollup'] + } /** * Generated Release Notes Content * @description Generated name and body describing a release */ - "release-notes-content": { + 'release-notes-content': { /** * @description The generated name of the release * @example Release v1.0.0 is now available! */ - name: string; + name: string /** @description The generated body describing the contents of the release supporting markdown formatting */ - body: string; - }; - "secret-scanning-alert": { - number?: components["schemas"]["alert-number"]; - created_at?: components["schemas"]["alert-created-at"]; - url?: components["schemas"]["alert-url"]; - html_url?: components["schemas"]["alert-html-url"]; + body: string + } + 'secret-scanning-alert': { + number?: components['schemas']['alert-number'] + created_at?: components['schemas']['alert-created-at'] + url?: components['schemas']['alert-url'] + html_url?: components['schemas']['alert-html-url'] /** * Format: uri * @description The REST API URL of the code locations for this alert. */ - locations_url?: string; - state?: components["schemas"]["secret-scanning-alert-state"]; - resolution?: components["schemas"]["secret-scanning-alert-resolution"]; + locations_url?: string + state?: components['schemas']['secret-scanning-alert-state'] + resolution?: components['schemas']['secret-scanning-alert-resolution'] /** * Format: date-time * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - resolved_at?: string | null; - resolved_by?: components["schemas"]["nullable-simple-user"]; + resolved_at?: string | null + resolved_by?: components['schemas']['nullable-simple-user'] /** @description The type of secret that secret scanning detected. */ - secret_type?: string; + secret_type?: string /** @description The secret that was detected. */ - secret?: string; - }; + secret?: string + } /** @description Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. */ - "secret-scanning-location-commit": { + 'secret-scanning-location-commit': { /** * @description The file path in the repository * @example /example/secrets.txt */ - path: string; + path: string /** @description Line number at which the secret starts in the file */ - start_line: number; + start_line: number /** @description Line number at which the secret ends in the file */ - end_line: number; + end_line: number /** @description The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII */ - start_column: number; + start_column: number /** @description The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII */ - end_column: number; + end_column: number /** * @description SHA-1 hash ID of the associated blob * @example af5626b4a114abcb82d63db7c8082c3c4756e51b */ - blob_sha: string; + blob_sha: string /** @description The API URL to get the associated blob resource */ - blob_url: string; + blob_url: string /** * @description SHA-1 hash ID of the associated commit * @example af5626b4a114abcb82d63db7c8082c3c4756e51b */ - commit_sha: string; + commit_sha: string /** @description The API URL to get the associated commit resource */ - commit_url: string; - }; - "secret-scanning-location": { + commit_url: string + } + 'secret-scanning-location': { /** * @description The location type. Because secrets may be found in different types of resources (ie. code, comments, issues), this field identifies the type of resource where the secret was found. * @example commit * @enum {string} */ - type: "commit"; - details: components["schemas"]["secret-scanning-location-commit"]; - }; + type: 'commit' + details: components['schemas']['secret-scanning-location-commit'] + } /** * Stargazer * @description Stargazer */ stargazer: { /** Format: date-time */ - starred_at: string; - user: components["schemas"]["nullable-simple-user"]; - }; + starred_at: string + user: components['schemas']['nullable-simple-user'] + } /** * Code Frequency Stat * @description Code Frequency Stat */ - "code-frequency-stat": number[]; + 'code-frequency-stat': number[] /** * Commit Activity * @description Commit Activity */ - "commit-activity": { + 'commit-activity': { /** @example 0,3,26,20,39,1,0 */ - days: number[]; + days: number[] /** @example 89 */ - total: number; + total: number /** @example 1336280400 */ - week: number; - }; + week: number + } /** * Contributor Activity * @description Contributor Activity */ - "contributor-activity": { - author: components["schemas"]["nullable-simple-user"]; + 'contributor-activity': { + author: components['schemas']['nullable-simple-user'] /** @example 135 */ - total: number; + total: number /** @example [object Object] */ weeks: { - w?: number; - a?: number; - d?: number; - c?: number; - }[]; - }; + w?: number + a?: number + d?: number + c?: number + }[] + } /** Participation Stats */ - "participation-stats": { - all: number[]; - owner: number[]; - }; + 'participation-stats': { + all: number[] + owner: number[] + } /** * Repository Invitation * @description Repository invitations let you manage who you collaborate with. */ - "repository-subscription": { + 'repository-subscription': { /** * @description Determines if notifications should be received from this repository. * @example true */ - subscribed: boolean; + subscribed: boolean /** @description Determines if all notifications should be blocked from this repository. */ - ignored: boolean; - reason: string | null; + ignored: boolean + reason: string | null /** * Format: date-time * @example 2012-10-06T21:34:12Z */ - created_at: string; + created_at: string /** * Format: uri * @example https://api.github.com/repos/octocat/example/subscription */ - url: string; + url: string /** * Format: uri * @example https://api.github.com/repos/octocat/example */ - repository_url: string; - }; + repository_url: string + } /** * Tag * @description Tag */ tag: { /** @example v0.1 */ - name: string; + name: string commit: { - sha: string; + sha: string /** Format: uri */ - url: string; - }; + url: string + } /** * Format: uri * @example https://github.com/octocat/Hello-World/zipball/v0.1 */ - zipball_url: string; + zipball_url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/tarball/v0.1 */ - tarball_url: string; - node_id: string; - }; + tarball_url: string + node_id: string + } /** * Topic * @description A topic aggregates entities that are related to a subject. */ topic: { - names: string[]; - }; + names: string[] + } /** Traffic */ traffic: { /** Format: date-time */ - timestamp: string; - uniques: number; - count: number; - }; + timestamp: string + uniques: number + count: number + } /** * Clone Traffic * @description Clone Traffic */ - "clone-traffic": { + 'clone-traffic': { /** @example 173 */ - count: number; + count: number /** @example 128 */ - uniques: number; - clones: components["schemas"]["traffic"][]; - }; + uniques: number + clones: components['schemas']['traffic'][] + } /** * Content Traffic * @description Content Traffic */ - "content-traffic": { + 'content-traffic': { /** @example /github/hubot */ - path: string; + path: string /** @example github/hubot: A customizable life embetterment robot. */ - title: string; + title: string /** @example 3542 */ - count: number; + count: number /** @example 2225 */ - uniques: number; - }; + uniques: number + } /** * Referrer Traffic * @description Referrer Traffic */ - "referrer-traffic": { + 'referrer-traffic': { /** @example Google */ - referrer: string; + referrer: string /** @example 4 */ - count: number; + count: number /** @example 3 */ - uniques: number; - }; + uniques: number + } /** * View Traffic * @description View Traffic */ - "view-traffic": { + 'view-traffic': { /** @example 14850 */ - count: number; + count: number /** @example 3782 */ - uniques: number; - views: components["schemas"]["traffic"][]; - }; - "scim-group-list-enterprise": { - schemas: string[]; - totalResults: number; - itemsPerPage: number; - startIndex: number; + uniques: number + views: components['schemas']['traffic'][] + } + 'scim-group-list-enterprise': { + schemas: string[] + totalResults: number + itemsPerPage: number + startIndex: number Resources: { - schemas: string[]; - id: string; - externalId?: string | null; - displayName?: string; + schemas: string[] + id: string + externalId?: string | null + displayName?: string members?: { - value?: string; - $ref?: string; - display?: string; - }[]; + value?: string + $ref?: string + display?: string + }[] meta?: { - resourceType?: string; - created?: string; - lastModified?: string; - location?: string; - }; - }[]; - }; - "scim-enterprise-group": { - schemas: string[]; - id: string; - externalId?: string | null; - displayName?: string; + resourceType?: string + created?: string + lastModified?: string + location?: string + } + }[] + } + 'scim-enterprise-group': { + schemas: string[] + id: string + externalId?: string | null + displayName?: string members?: { - value?: string; - $ref?: string; - display?: string; - }[]; + value?: string + $ref?: string + display?: string + }[] meta?: { - resourceType?: string; - created?: string; - lastModified?: string; - location?: string; - }; - }; - "scim-user-list-enterprise": { - schemas: string[]; - totalResults: number; - itemsPerPage: number; - startIndex: number; + resourceType?: string + created?: string + lastModified?: string + location?: string + } + } + 'scim-user-list-enterprise': { + schemas: string[] + totalResults: number + itemsPerPage: number + startIndex: number Resources: { - schemas: string[]; - id: string; - externalId?: string; - userName?: string; + schemas: string[] + id: string + externalId?: string + userName?: string name?: { - givenName?: string; - familyName?: string; - }; + givenName?: string + familyName?: string + } emails?: { - value?: string; - primary?: boolean; - type?: string; - }[]; + value?: string + primary?: boolean + type?: string + }[] groups?: { - value?: string; - }[]; - active?: boolean; + value?: string + }[] + active?: boolean meta?: { - resourceType?: string; - created?: string; - lastModified?: string; - location?: string; - }; - }[]; - }; - "scim-enterprise-user": { - schemas: string[]; - id: string; - externalId?: string; - userName?: string; + resourceType?: string + created?: string + lastModified?: string + location?: string + } + }[] + } + 'scim-enterprise-user': { + schemas: string[] + id: string + externalId?: string + userName?: string name?: { - givenName?: string; - familyName?: string; - }; + givenName?: string + familyName?: string + } emails?: { - value?: string; - type?: string; - primary?: boolean; - }[]; + value?: string + type?: string + primary?: boolean + }[] groups?: { - value?: string; - }[]; - active?: boolean; + value?: string + }[] + active?: boolean meta?: { - resourceType?: string; - created?: string; - lastModified?: string; - location?: string; - }; - }; + resourceType?: string + created?: string + lastModified?: string + location?: string + } + } /** * SCIM /Users * @description SCIM /Users provisioning endpoints */ - "scim-user": { + 'scim-user': { /** @description SCIM schema used. */ - schemas: string[]; + schemas: string[] /** * @description Unique identifier of an external identity * @example 1b78eada-9baa-11e6-9eb6-a431576d590e */ - id: string; + id: string /** * @description The ID of the User. * @example a7b0f98395 */ - externalId: string | null; + externalId: string | null /** * @description Configured by the admin. Could be an email, login, or username * @example someone@example.com */ - userName: string | null; + userName: string | null /** * @description The name of the user, suitable for display to end-users * @example Jon Doe */ - displayName?: string | null; + displayName?: string | null /** @example [object Object] */ name: { - givenName: string | null; - familyName: string | null; - formatted?: string | null; - }; + givenName: string | null + familyName: string | null + formatted?: string | null + } /** * @description user emails * @example [object Object],[object Object] */ emails: { - value: string; - primary?: boolean; - }[]; + value: string + primary?: boolean + }[] /** * @description The active status of the User. * @example true */ - active: boolean; + active: boolean meta: { /** @example User */ - resourceType?: string; + resourceType?: string /** * Format: date-time * @example 2019-01-24T22:45:36.000Z */ - created?: string; + created?: string /** * Format: date-time * @example 2019-01-24T22:45:36.000Z */ - lastModified?: string; + lastModified?: string /** * Format: uri * @example https://api.github.com/scim/v2/organizations/myorg-123abc55141bfd8f/Users/c42772b5-2029-11e9-8543-9264a97dec8d */ - location?: string; - }; + location?: string + } /** @description The ID of the organization. */ - organization_id?: number; + organization_id?: number /** * @description Set of operations to be performed * @example [object Object] */ operations?: { /** @enum {string} */ - op: "add" | "remove" | "replace"; - path?: string; - value?: string | { [key: string]: unknown } | unknown[]; - }[]; + op: 'add' | 'remove' | 'replace' + path?: string + value?: string | { [key: string]: unknown } | unknown[] + }[] /** @description associated groups */ groups?: { - value?: string; - display?: string; - }[]; - }; + value?: string + display?: string + }[] + } /** * SCIM User List * @description SCIM User List */ - "scim-user-list": { + 'scim-user-list': { /** @description SCIM schema used. */ - schemas: string[]; + schemas: string[] /** @example 3 */ - totalResults: number; + totalResults: number /** @example 10 */ - itemsPerPage: number; + itemsPerPage: number /** @example 1 */ - startIndex: number; - Resources: components["schemas"]["scim-user"][]; - }; + startIndex: number + Resources: components['schemas']['scim-user'][] + } /** Search Result Text Matches */ - "search-result-text-matches": { - object_url?: string; - object_type?: string | null; - property?: string; - fragment?: string; + 'search-result-text-matches': { + object_url?: string + object_type?: string | null + property?: string + fragment?: string matches?: { - text?: string; - indices?: number[]; - }[]; - }[]; + text?: string + indices?: number[] + }[] + }[] /** * Code Search Result Item * @description Code Search Result Item */ - "code-search-result-item": { - name: string; - path: string; - sha: string; + 'code-search-result-item': { + name: string + path: string + sha: string /** Format: uri */ - url: string; + url: string /** Format: uri */ - git_url: string; + git_url: string /** Format: uri */ - html_url: string; - repository: components["schemas"]["minimal-repository"]; - score: number; - file_size?: number; - language?: string | null; + html_url: string + repository: components['schemas']['minimal-repository'] + score: number + file_size?: number + language?: string | null /** Format: date-time */ - last_modified_at?: string; + last_modified_at?: string /** @example 73..77,77..78 */ - line_numbers?: string[]; - text_matches?: components["schemas"]["search-result-text-matches"]; - }; + line_numbers?: string[] + text_matches?: components['schemas']['search-result-text-matches'] + } /** * Commit Search Result Item * @description Commit Search Result Item */ - "commit-search-result-item": { + 'commit-search-result-item': { /** Format: uri */ - url: string; - sha: string; + url: string + sha: string /** Format: uri */ - html_url: string; + html_url: string /** Format: uri */ - comments_url: string; + comments_url: string commit: { author: { - name: string; - email: string; + name: string + email: string /** Format: date-time */ - date: string; - }; - committer: components["schemas"]["nullable-git-user"]; - comment_count: number; - message: string; + date: string + } + committer: components['schemas']['nullable-git-user'] + comment_count: number + message: string tree: { - sha: string; + sha: string /** Format: uri */ - url: string; - }; + url: string + } /** Format: uri */ - url: string; - verification?: components["schemas"]["verification"]; - }; - author: components["schemas"]["nullable-simple-user"]; - committer: components["schemas"]["nullable-git-user"]; + url: string + verification?: components['schemas']['verification'] + } + author: components['schemas']['nullable-simple-user'] + committer: components['schemas']['nullable-git-user'] parents: { - url?: string; - html_url?: string; - sha?: string; - }[]; - repository: components["schemas"]["minimal-repository"]; - score: number; - node_id: string; - text_matches?: components["schemas"]["search-result-text-matches"]; - }; + url?: string + html_url?: string + sha?: string + }[] + repository: components['schemas']['minimal-repository'] + score: number + node_id: string + text_matches?: components['schemas']['search-result-text-matches'] + } /** * Issue Search Result Item * @description Issue Search Result Item */ - "issue-search-result-item": { + 'issue-search-result-item': { /** Format: uri */ - url: string; + url: string /** Format: uri */ - repository_url: string; - labels_url: string; + repository_url: string + labels_url: string /** Format: uri */ - comments_url: string; + comments_url: string /** Format: uri */ - events_url: string; + events_url: string /** Format: uri */ - html_url: string; - id: number; - node_id: string; - number: number; - title: string; - locked: boolean; - active_lock_reason?: string | null; - assignees?: components["schemas"]["simple-user"][] | null; - user: components["schemas"]["nullable-simple-user"]; + html_url: string + id: number + node_id: string + number: number + title: string + locked: boolean + active_lock_reason?: string | null + assignees?: components['schemas']['simple-user'][] | null + user: components['schemas']['nullable-simple-user'] labels: { /** Format: int64 */ - id?: number; - node_id?: string; - url?: string; - name?: string; - color?: string; - default?: boolean; - description?: string | null; - }[]; - state: string; - assignee: components["schemas"]["nullable-simple-user"]; - milestone: components["schemas"]["nullable-milestone"]; - comments: number; + id?: number + node_id?: string + url?: string + name?: string + color?: string + default?: boolean + description?: string | null + }[] + state: string + assignee: components['schemas']['nullable-simple-user'] + milestone: components['schemas']['nullable-milestone'] + comments: number /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; + updated_at: string /** Format: date-time */ - closed_at: string | null; - text_matches?: components["schemas"]["search-result-text-matches"]; + closed_at: string | null + text_matches?: components['schemas']['search-result-text-matches'] pull_request?: { /** Format: date-time */ - merged_at?: string | null; + merged_at?: string | null /** Format: uri */ - diff_url: string | null; + diff_url: string | null /** Format: uri */ - html_url: string | null; + html_url: string | null /** Format: uri */ - patch_url: string | null; + patch_url: string | null /** Format: uri */ - url: string | null; - }; - body?: string; - score: number; - author_association: components["schemas"]["author_association"]; - draft?: boolean; - repository?: components["schemas"]["repository"]; - body_html?: string; - body_text?: string; + url: string | null + } + body?: string + score: number + author_association: components['schemas']['author_association'] + draft?: boolean + repository?: components['schemas']['repository'] + body_html?: string + body_text?: string /** Format: uri */ - timeline_url?: string; - performed_via_github_app?: components["schemas"]["nullable-integration"]; - reactions?: components["schemas"]["reaction-rollup"]; - }; + timeline_url?: string + performed_via_github_app?: components['schemas']['nullable-integration'] + reactions?: components['schemas']['reaction-rollup'] + } /** * Label Search Result Item * @description Label Search Result Item */ - "label-search-result-item": { - id: number; - node_id: string; + 'label-search-result-item': { + id: number + node_id: string /** Format: uri */ - url: string; - name: string; - color: string; - default: boolean; - description: string | null; - score: number; - text_matches?: components["schemas"]["search-result-text-matches"]; - }; + url: string + name: string + color: string + default: boolean + description: string | null + score: number + text_matches?: components['schemas']['search-result-text-matches'] + } /** * Repo Search Result Item * @description Repo Search Result Item */ - "repo-search-result-item": { - id: number; - node_id: string; - name: string; - full_name: string; - owner: components["schemas"]["nullable-simple-user"]; - private: boolean; + 'repo-search-result-item': { + id: number + node_id: string + name: string + full_name: string + owner: components['schemas']['nullable-simple-user'] + private: boolean /** Format: uri */ - html_url: string; - description: string | null; - fork: boolean; + html_url: string + description: string | null + fork: boolean /** Format: uri */ - url: string; + url: string /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; + updated_at: string /** Format: date-time */ - pushed_at: string; + pushed_at: string /** Format: uri */ - homepage: string | null; - size: number; - stargazers_count: number; - watchers_count: number; - language: string | null; - forks_count: number; - open_issues_count: number; - master_branch?: string; - default_branch: string; - score: number; + homepage: string | null + size: number + stargazers_count: number + watchers_count: number + language: string | null + forks_count: number + open_issues_count: number + master_branch?: string + default_branch: string + score: number /** Format: uri */ - forks_url: string; - keys_url: string; - collaborators_url: string; + forks_url: string + keys_url: string + collaborators_url: string /** Format: uri */ - teams_url: string; + teams_url: string /** Format: uri */ - hooks_url: string; - issue_events_url: string; + hooks_url: string + issue_events_url: string /** Format: uri */ - events_url: string; - assignees_url: string; - branches_url: string; + events_url: string + assignees_url: string + branches_url: string /** Format: uri */ - tags_url: string; - blobs_url: string; - git_tags_url: string; - git_refs_url: string; - trees_url: string; - statuses_url: string; + tags_url: string + blobs_url: string + git_tags_url: string + git_refs_url: string + trees_url: string + statuses_url: string /** Format: uri */ - languages_url: string; + languages_url: string /** Format: uri */ - stargazers_url: string; + stargazers_url: string /** Format: uri */ - contributors_url: string; + contributors_url: string /** Format: uri */ - subscribers_url: string; + subscribers_url: string /** Format: uri */ - subscription_url: string; - commits_url: string; - git_commits_url: string; - comments_url: string; - issue_comment_url: string; - contents_url: string; - compare_url: string; + subscription_url: string + commits_url: string + git_commits_url: string + comments_url: string + issue_comment_url: string + contents_url: string + compare_url: string /** Format: uri */ - merges_url: string; - archive_url: string; + merges_url: string + archive_url: string /** Format: uri */ - downloads_url: string; - issues_url: string; - pulls_url: string; - milestones_url: string; - notifications_url: string; - labels_url: string; - releases_url: string; + downloads_url: string + issues_url: string + pulls_url: string + milestones_url: string + notifications_url: string + labels_url: string + releases_url: string /** Format: uri */ - deployments_url: string; - git_url: string; - ssh_url: string; - clone_url: string; + deployments_url: string + git_url: string + ssh_url: string + clone_url: string /** Format: uri */ - svn_url: string; - forks: number; - open_issues: number; - watchers: number; - topics?: string[]; + svn_url: string + forks: number + open_issues: number + watchers: number + topics?: string[] /** Format: uri */ - mirror_url: string | null; - has_issues: boolean; - has_projects: boolean; - has_pages: boolean; - has_wiki: boolean; - has_downloads: boolean; - archived: boolean; + mirror_url: string | null + has_issues: boolean + has_projects: boolean + has_pages: boolean + has_wiki: boolean + has_downloads: boolean + archived: boolean /** @description Returns whether or not this repository disabled. */ - disabled: boolean; + disabled: boolean /** @description The repository visibility: public, private, or internal. */ - visibility?: string; - license: components["schemas"]["nullable-license-simple"]; + visibility?: string + license: components['schemas']['nullable-license-simple'] permissions?: { - admin: boolean; - maintain?: boolean; - push: boolean; - triage?: boolean; - pull: boolean; - }; - text_matches?: components["schemas"]["search-result-text-matches"]; - temp_clone_token?: string; - allow_merge_commit?: boolean; - allow_squash_merge?: boolean; - allow_rebase_merge?: boolean; - allow_auto_merge?: boolean; - delete_branch_on_merge?: boolean; - allow_forking?: boolean; - is_template?: boolean; - }; + admin: boolean + maintain?: boolean + push: boolean + triage?: boolean + pull: boolean + } + text_matches?: components['schemas']['search-result-text-matches'] + temp_clone_token?: string + allow_merge_commit?: boolean + allow_squash_merge?: boolean + allow_rebase_merge?: boolean + allow_auto_merge?: boolean + delete_branch_on_merge?: boolean + allow_forking?: boolean + is_template?: boolean + } /** * Topic Search Result Item * @description Topic Search Result Item */ - "topic-search-result-item": { - name: string; - display_name: string | null; - short_description: string | null; - description: string | null; - created_by: string | null; - released: string | null; + 'topic-search-result-item': { + name: string + display_name: string | null + short_description: string | null + description: string | null + created_by: string | null + released: string | null /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - featured: boolean; - curated: boolean; - score: number; - repository_count?: number | null; + updated_at: string + featured: boolean + curated: boolean + score: number + repository_count?: number | null /** Format: uri */ - logo_url?: string | null; - text_matches?: components["schemas"]["search-result-text-matches"]; + logo_url?: string | null + text_matches?: components['schemas']['search-result-text-matches'] related?: | { topic_relation?: { - id?: number; - name?: string; - topic_id?: number; - relation_type?: string; - }; + id?: number + name?: string + topic_id?: number + relation_type?: string + } }[] - | null; + | null aliases?: | { topic_relation?: { - id?: number; - name?: string; - topic_id?: number; - relation_type?: string; - }; + id?: number + name?: string + topic_id?: number + relation_type?: string + } }[] - | null; - }; + | null + } /** * User Search Result Item * @description User Search Result Item */ - "user-search-result-item": { - login: string; - id: number; - node_id: string; + 'user-search-result-item': { + login: string + id: number + node_id: string /** Format: uri */ - avatar_url: string; - gravatar_id: string | null; + avatar_url: string + gravatar_id: string | null /** Format: uri */ - url: string; + url: string /** Format: uri */ - html_url: string; + html_url: string /** Format: uri */ - followers_url: string; + followers_url: string /** Format: uri */ - subscriptions_url: string; + subscriptions_url: string /** Format: uri */ - organizations_url: string; + organizations_url: string /** Format: uri */ - repos_url: string; + repos_url: string /** Format: uri */ - received_events_url: string; - type: string; - score: number; - following_url: string; - gists_url: string; - starred_url: string; - events_url: string; - public_repos?: number; - public_gists?: number; - followers?: number; - following?: number; + received_events_url: string + type: string + score: number + following_url: string + gists_url: string + starred_url: string + events_url: string + public_repos?: number + public_gists?: number + followers?: number + following?: number /** Format: date-time */ - created_at?: string; + created_at?: string /** Format: date-time */ - updated_at?: string; - name?: string | null; - bio?: string | null; + updated_at?: string + name?: string | null + bio?: string | null /** Format: email */ - email?: string | null; - location?: string | null; - site_admin: boolean; - hireable?: boolean | null; - text_matches?: components["schemas"]["search-result-text-matches"]; - blog?: string | null; - company?: string | null; + email?: string | null + location?: string | null + site_admin: boolean + hireable?: boolean | null + text_matches?: components['schemas']['search-result-text-matches'] + blog?: string | null + company?: string | null /** Format: date-time */ - suspended_at?: string | null; - }; + suspended_at?: string | null + } /** * Private User * @description Private User */ - "private-user": { + 'private-user': { /** @example octocat */ - login: string; + login: string /** @example 1 */ - id: number; + id: number /** @example MDQ6VXNlcjE= */ - node_id: string; + node_id: string /** * Format: uri * @example https://github.com/images/error/octocat_happy.gif */ - avatar_url: string; + avatar_url: string /** @example 41d064eb2195891e12d0413f63227ea7 */ - gravatar_id: string | null; + gravatar_id: string | null /** * Format: uri * @example https://api.github.com/users/octocat */ - url: string; + url: string /** * Format: uri * @example https://github.com/octocat */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/users/octocat/followers */ - followers_url: string; + followers_url: string /** @example https://api.github.com/users/octocat/following{/other_user} */ - following_url: string; + following_url: string /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - gists_url: string; + gists_url: string /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - starred_url: string; + starred_url: string /** * Format: uri * @example https://api.github.com/users/octocat/subscriptions */ - subscriptions_url: string; + subscriptions_url: string /** * Format: uri * @example https://api.github.com/users/octocat/orgs */ - organizations_url: string; + organizations_url: string /** * Format: uri * @example https://api.github.com/users/octocat/repos */ - repos_url: string; + repos_url: string /** @example https://api.github.com/users/octocat/events{/privacy} */ - events_url: string; + events_url: string /** * Format: uri * @example https://api.github.com/users/octocat/received_events */ - received_events_url: string; + received_events_url: string /** @example User */ - type: string; - site_admin: boolean; + type: string + site_admin: boolean /** @example monalisa octocat */ - name: string | null; + name: string | null /** @example GitHub */ - company: string | null; + company: string | null /** @example https://github.com/blog */ - blog: string | null; + blog: string | null /** @example San Francisco */ - location: string | null; + location: string | null /** * Format: email * @example octocat@github.com */ - email: string | null; - hireable: boolean | null; + email: string | null + hireable: boolean | null /** @example There once was... */ - bio: string | null; + bio: string | null /** @example monalisa */ - twitter_username?: string | null; + twitter_username?: string | null /** @example 2 */ - public_repos: number; + public_repos: number /** @example 1 */ - public_gists: number; + public_gists: number /** @example 20 */ - followers: number; - following: number; + followers: number + following: number /** * Format: date-time * @example 2008-01-14T04:33:35Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2008-01-14T04:33:35Z */ - updated_at: string; + updated_at: string /** @example 81 */ - private_gists: number; + private_gists: number /** @example 100 */ - total_private_repos: number; + total_private_repos: number /** @example 100 */ - owned_private_repos: number; + owned_private_repos: number /** @example 10000 */ - disk_usage: number; + disk_usage: number /** @example 8 */ - collaborators: number; + collaborators: number /** @example true */ - two_factor_authentication: boolean; + two_factor_authentication: boolean plan?: { - collaborators: number; - name: string; - space: number; - private_repos: number; - }; + collaborators: number + name: string + space: number + private_repos: number + } /** Format: date-time */ - suspended_at?: string | null; - business_plus?: boolean; - ldap_dn?: string; - }; + suspended_at?: string | null + business_plus?: boolean + ldap_dn?: string + } /** * Codespaces Secret * @description Secrets for a GitHub Codespace. */ - "codespaces-secret": { + 'codespaces-secret': { /** * @description The name of the secret. * @example SECRET_NAME */ - name: string; + name: string /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; + updated_at: string /** * @description Visibility of a secret * @enum {string} */ - visibility: "all" | "private" | "selected"; + visibility: 'all' | 'private' | 'selected' /** * Format: uri * @example https://api.github.com/user/secrets/SECRET_NAME/repositories */ - selected_repositories_url: string; - }; + selected_repositories_url: string + } /** * CodespacesUserPublicKey * @description The public key used for setting user Codespaces' Secrets. */ - "codespaces-user-public-key": { + 'codespaces-user-public-key': { /** * @description The identifier for the key. * @example 1234567 */ - key_id: string; + key_id: string /** * @description The Base64 encoded public key. * @example hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= */ - key: string; - }; + key: string + } /** * Fetches information about an export of a codespace. * @description An export of a codespace. Also, latest export details for a codespace can be fetched with id = latest */ - "codespace-export-details": { + 'codespace-export-details': { /** * @description State of the latest export * @example succeeded | failed | in_progress */ - state?: string | null; + state?: string | null /** * Format: date-time * @description Completion time of the last export operation * @example 2021-01-01T19:01:12Z */ - completed_at?: string | null; + completed_at?: string | null /** * @description Name of the exported branch * @example codespace-monalisa-octocat-hello-world-g4wpq6h95q */ - branch?: string | null; + branch?: string | null /** * @description Git commit SHA of the exported branch * @example fd95a81ca01e48ede9f39c799ecbcef817b8a3b2 */ - sha?: string | null; + sha?: string | null /** * @description Id for the export details * @example latest */ - id?: string; + id?: string /** * @description Url for fetching export details * @example https://api.github.com/user/codespaces/:name/exports/latest */ - export_url?: string; - }; + export_url?: string + } /** * Email * @description Email @@ -17311,355 +17299,355 @@ export type components = { * Format: email * @example octocat@github.com */ - email: string; + email: string /** @example true */ - primary: boolean; + primary: boolean /** @example true */ - verified: boolean; + verified: boolean /** @example public */ - visibility: string | null; - }; + visibility: string | null + } /** * GPG Key * @description A unique encryption key */ - "gpg-key": { + 'gpg-key': { /** @example 3 */ - id: number; - primary_key_id: number | null; + id: number + primary_key_id: number | null /** @example 3262EFF25BA0D270 */ - key_id: string; + key_id: string /** @example xsBNBFayYZ... */ - public_key: string; + public_key: string /** @example [object Object] */ emails: { - email?: string; - verified?: boolean; - }[]; + email?: string + verified?: boolean + }[] /** @example [object Object] */ subkeys: { - id?: number; - primary_key_id?: number; - key_id?: string; - public_key?: string; - emails?: unknown[]; - subkeys?: unknown[]; - can_sign?: boolean; - can_encrypt_comms?: boolean; - can_encrypt_storage?: boolean; - can_certify?: boolean; - created_at?: string; - expires_at?: string | null; - raw_key?: string | null; - }[]; + id?: number + primary_key_id?: number + key_id?: string + public_key?: string + emails?: unknown[] + subkeys?: unknown[] + can_sign?: boolean + can_encrypt_comms?: boolean + can_encrypt_storage?: boolean + can_certify?: boolean + created_at?: string + expires_at?: string | null + raw_key?: string | null + }[] /** @example true */ - can_sign: boolean; - can_encrypt_comms: boolean; - can_encrypt_storage: boolean; + can_sign: boolean + can_encrypt_comms: boolean + can_encrypt_storage: boolean /** @example true */ - can_certify: boolean; + can_certify: boolean /** * Format: date-time * @example 2016-03-24T11:31:04-06:00 */ - created_at: string; + created_at: string /** Format: date-time */ - expires_at: string | null; - raw_key: string | null; - }; + expires_at: string | null + raw_key: string | null + } /** * Key * @description Key */ key: { - key: string; - id: number; - url: string; - title: string; + key: string + id: number + url: string + title: string /** Format: date-time */ - created_at: string; - verified: boolean; - read_only: boolean; - }; + created_at: string + verified: boolean + read_only: boolean + } /** Marketplace Account */ - "marketplace-account": { + 'marketplace-account': { /** Format: uri */ - url: string; - id: number; - type: string; - node_id?: string; - login: string; + url: string + id: number + type: string + node_id?: string + login: string /** Format: email */ - email?: string | null; + email?: string | null /** Format: email */ - organization_billing_email?: string | null; - }; + organization_billing_email?: string | null + } /** * User Marketplace Purchase * @description User Marketplace Purchase */ - "user-marketplace-purchase": { + 'user-marketplace-purchase': { /** @example monthly */ - billing_cycle: string; + billing_cycle: string /** * Format: date-time * @example 2017-11-11T00:00:00Z */ - next_billing_date: string | null; - unit_count: number | null; + next_billing_date: string | null + unit_count: number | null /** @example true */ - on_free_trial: boolean; + on_free_trial: boolean /** * Format: date-time * @example 2017-11-11T00:00:00Z */ - free_trial_ends_on: string | null; + free_trial_ends_on: string | null /** * Format: date-time * @example 2017-11-02T01:12:12Z */ - updated_at: string | null; - account: components["schemas"]["marketplace-account"]; - plan: components["schemas"]["marketplace-listing-plan"]; - }; + updated_at: string | null + account: components['schemas']['marketplace-account'] + plan: components['schemas']['marketplace-listing-plan'] + } /** * Starred Repository * @description Starred Repository */ - "starred-repository": { + 'starred-repository': { /** Format: date-time */ - starred_at: string; - repo: components["schemas"]["repository"]; - }; + starred_at: string + repo: components['schemas']['repository'] + } /** * Hovercard * @description Hovercard */ hovercard: { contexts: { - message: string; - octicon: string; - }[]; - }; + message: string + octicon: string + }[] + } /** * Key Simple * @description Key Simple */ - "key-simple": { - id: number; - key: string; - }; - }; + 'key-simple': { + id: number + key: string + } + } responses: { /** Resource not found */ not_found: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } /** Validation failed */ validation_failed_simple: { content: { - "application/json": components["schemas"]["validation-error-simple"]; - }; - }; + 'application/json': components['schemas']['validation-error-simple'] + } + } /** Bad Request */ bad_request: { content: { - "application/json": components["schemas"]["basic-error"]; - "application/scim+json": components["schemas"]["scim-error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + 'application/scim+json': components['schemas']['scim-error'] + } + } /** Validation failed */ validation_failed: { content: { - "application/json": components["schemas"]["validation-error"]; - }; - }; + 'application/json': components['schemas']['validation-error'] + } + } /** Accepted */ accepted: { content: { - "application/json": { [key: string]: unknown }; - }; - }; + 'application/json': { [key: string]: unknown } + } + } /** Preview header missing */ preview_header_missing: { content: { - "application/json": { - message: string; - documentation_url: string; - }; - }; - }; + 'application/json': { + message: string + documentation_url: string + } + } + } /** Forbidden */ forbidden: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } /** Requires authentication */ requires_authentication: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } /** Not modified */ - not_modified: unknown; + not_modified: unknown /** Gone */ gone: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } /** Response */ actions_runner_labels: { content: { - "application/json": { - total_count: number; - labels: components["schemas"]["runner-label"][]; - }; - }; - }; + 'application/json': { + total_count: number + labels: components['schemas']['runner-label'][] + } + } + } /** Response */ actions_runner_labels_readonly: { content: { - "application/json": { - total_count: number; - labels: components["schemas"]["runner-label"][]; - }; - }; - }; + 'application/json': { + total_count: number + labels: components['schemas']['runner-label'][] + } + } + } /** Service unavailable */ service_unavailable: { content: { - "application/json": { - code?: string; - message?: string; - documentation_url?: string; - }; - }; - }; + 'application/json': { + code?: string + message?: string + documentation_url?: string + } + } + } /** Response if GitHub Advanced Security is not enabled for this repository */ code_scanning_forbidden_read: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } /** Forbidden Gist */ forbidden_gist: { content: { - "application/json": { + 'application/json': { block?: { - reason?: string; - created_at?: string; - html_url?: string | null; - }; - message?: string; - documentation_url?: string; - }; - }; - }; + reason?: string + created_at?: string + html_url?: string | null + } + message?: string + documentation_url?: string + } + } + } /** Moved permanently */ moved_permanently: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } /** Conflict */ conflict: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } /** Temporary Redirect */ temporary_redirect: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } /** Internal Error */ internal_error: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } /** Response if the repository is archived or if github advanced security is not enabled for this repository */ code_scanning_forbidden_write: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } /** Found */ - found: unknown; + found: unknown /** A header with no content is returned. */ - no_content: unknown; + no_content: unknown /** Resource not found */ scim_not_found: { content: { - "application/json": components["schemas"]["scim-error"]; - "application/scim+json": components["schemas"]["scim-error"]; - }; - }; + 'application/json': components['schemas']['scim-error'] + 'application/scim+json': components['schemas']['scim-error'] + } + } /** Forbidden */ scim_forbidden: { content: { - "application/json": components["schemas"]["scim-error"]; - "application/scim+json": components["schemas"]["scim-error"]; - }; - }; + 'application/json': components['schemas']['scim-error'] + 'application/scim+json': components['schemas']['scim-error'] + } + } /** Bad Request */ scim_bad_request: { content: { - "application/json": components["schemas"]["scim-error"]; - "application/scim+json": components["schemas"]["scim-error"]; - }; - }; + 'application/json': components['schemas']['scim-error'] + 'application/scim+json': components['schemas']['scim-error'] + } + } /** Internal Error */ scim_internal_error: { content: { - "application/json": components["schemas"]["scim-error"]; - "application/scim+json": components["schemas"]["scim-error"]; - }; - }; + 'application/json': components['schemas']['scim-error'] + 'application/scim+json': components['schemas']['scim-error'] + } + } /** Conflict */ scim_conflict: { content: { - "application/json": components["schemas"]["scim-error"]; - "application/scim+json": components["schemas"]["scim-error"]; - }; - }; - }; + 'application/json': components['schemas']['scim-error'] + 'application/scim+json': components['schemas']['scim-error'] + } + } + } parameters: { /** @description Results per page (max 100) */ - "per-page": number; + 'per-page': number /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ - cursor: string; - "delivery-id": number; + cursor: string + 'delivery-id': number /** @description Page number of the results to fetch. */ - page: number; + page: number /** @description Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since: string; + since: string /** @description installation_id parameter */ - "installation-id": number; + 'installation-id': number /** @description grant_id parameter */ - "grant-id": number; + 'grant-id': number /** @description The client ID of your GitHub app. */ - "client-id": string; - "app-slug": string; + 'client-id': string + 'app-slug': string /** @description authorization_id parameter */ - "authorization-id": number; + 'authorization-id': number /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: string; + enterprise: string /** @description Unique identifier of an organization. */ - "org-id": number; + 'org-id': number /** @description Unique identifier of the self-hosted runner group. */ - "runner-group-id": number; + 'runner-group-id': number /** @description Unique identifier of the self-hosted runner. */ - "runner-id": number; + 'runner-id': number /** @description The name of a self-hosted runner's custom label. */ - "runner-label-name": string; + 'runner-label-name': string /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). */ - "audit-log-phrase": string; + 'audit-log-phrase': string /** * @description The event types to include: * @@ -17669,843 +17657,843 @@ export type components = { * * The default is `web`. */ - "audit-log-include": "web" | "git" | "all"; + 'audit-log-include': 'web' | 'git' | 'all' /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor. */ - "audit-log-after": string; + 'audit-log-after': string /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor. */ - "audit-log-before": string; + 'audit-log-before': string /** * @description The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. * * The default is `desc`. */ - "audit-log-order": "desc" | "asc"; + 'audit-log-order': 'desc' | 'asc' /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - "secret-scanning-alert-state": "open" | "resolved"; + 'secret-scanning-alert-state': 'open' | 'resolved' /** * @description A comma-separated list of secret types to return. By default all secret types are returned. * See "[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)" * for a complete list of secret types (API slug). */ - "secret-scanning-alert-secret-type": string; + 'secret-scanning-alert-secret-type': string /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - "secret-scanning-alert-resolution": string; + 'secret-scanning-alert-resolution': string /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor. */ - "pagination-before": string; + 'pagination-before': string /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor. */ - "pagination-after": string; + 'pagination-after': string /** @description gist_id parameter */ - "gist-id": string; + 'gist-id': string /** @description comment_id parameter */ - "comment-id": number; + 'comment-id': number /** @description A list of comma separated label names. Example: `bug,ui,@high` */ - labels: string; + labels: string /** @description One of `asc` (ascending) or `desc` (descending). */ - direction: "asc" | "desc"; + direction: 'asc' | 'desc' /** @description account_id parameter */ - "account-id": number; + 'account-id': number /** @description plan_id parameter */ - "plan-id": number; + 'plan-id': number /** @description One of `created` (when the repository was starred) or `updated` (when it was last pushed to). */ - sort: "created" | "updated"; - owner: string; - repo: string; + sort: 'created' | 'updated' + owner: string + repo: string /** @description If `true`, show notifications marked as read. */ - all: boolean; + all: boolean /** @description If `true`, only shows notifications in which the user is directly participating or mentioned. */ - participating: boolean; + participating: boolean /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - before: string; + before: string /** @description thread_id parameter */ - "thread-id": number; + 'thread-id': number /** @description An organization ID. Only return organizations with an ID greater than this ID. */ - "since-org": number; - org: string; + 'since-org': number + org: string /** @description team_slug parameter */ - "team-slug": string; - "repository-id": number; + 'team-slug': string + 'repository-id': number /** @description secret_name parameter */ - "secret-name": string; - username: string; + 'secret-name': string + username: string /** @description group_id parameter */ - "group-id": number; - "hook-id": number; + 'group-id': number + 'hook-id': number /** @description invitation_id parameter */ - "invitation-id": number; + 'invitation-id': number /** @description migration_id parameter */ - "migration-id": number; + 'migration-id': number /** @description repo_name parameter */ - "repo-name": string; + 'repo-name': string /** @description The selected visibility of the packages. Can be one of `public`, `private`, or `internal`. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set. */ - "package-visibility": "public" | "private" | "internal"; + 'package-visibility': 'public' | 'private' | 'internal' /** @description The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - "package-type": "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + 'package-type': 'npm' | 'maven' | 'rubygems' | 'docker' | 'nuget' | 'container' /** @description The name of the package. */ - "package-name": string; + 'package-name': string /** @description Unique identifier of the package version. */ - "package-version-id": number; - "discussion-number": number; - "comment-number": number; - "reaction-id": number; - "project-id": number; + 'package-version-id': number + 'discussion-number': number + 'comment-number': number + 'reaction-id': number + 'project-id': number /** @description card_id parameter */ - "card-id": number; + 'card-id': number /** @description column_id parameter */ - "column-id": number; + 'column-id': number /** @description artifact_id parameter */ - "artifact-id": number; + 'artifact-id': number /** @description job_id parameter */ - "job-id": number; + 'job-id': number /** @description Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ - actor: string; + actor: string /** @description Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ - "workflow-run-branch": string; + 'workflow-run-branch': string /** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ - event: string; + event: string /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. For a list of the possible `status` and `conclusion` options, see "[Create a check run](https://docs.github.com/rest/reference/checks#create-a-check-run)." */ - "workflow-run-status": - | "completed" - | "action_required" - | "cancelled" - | "failure" - | "neutral" - | "skipped" - | "stale" - | "success" - | "timed_out" - | "in_progress" - | "queued" - | "requested" - | "waiting"; + 'workflow-run-status': + | 'completed' + | 'action_required' + | 'cancelled' + | 'failure' + | 'neutral' + | 'skipped' + | 'stale' + | 'success' + | 'timed_out' + | 'in_progress' + | 'queued' + | 'requested' + | 'waiting' /** @description Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ - created: string; + created: string /** @description If `true` pull requests are omitted from the response (empty array). */ - "exclude-pull-requests": boolean; + 'exclude-pull-requests': boolean /** @description Returns workflow runs with the `check_suite_id` that you specify. */ - "workflow-run-check-suite-id": number; + 'workflow-run-check-suite-id': number /** @description The id of the workflow run. */ - "run-id": number; + 'run-id': number /** @description The attempt number of the workflow run. */ - "attempt-number": number; + 'attempt-number': number /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ - "workflow-id": number | string; + 'workflow-id': number | string /** @description autolink_id parameter */ - "autolink-id": number; + 'autolink-id': number /** @description The name of the branch. */ - branch: string; + branch: string /** @description check_run_id parameter */ - "check-run-id": number; + 'check-run-id': number /** @description check_suite_id parameter */ - "check-suite-id": number; + 'check-suite-id': number /** @description Returns check runs with the specified `name`. */ - "check-name": string; + 'check-name': string /** @description Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`. */ - status: "queued" | "in_progress" | "completed"; + status: 'queued' | 'in_progress' | 'completed' /** @description The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */ - "tool-name": components["schemas"]["code-scanning-analysis-tool-name"]; + 'tool-name': components['schemas']['code-scanning-analysis-tool-name'] /** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ - "tool-guid": components["schemas"]["code-scanning-analysis-tool-guid"]; + 'tool-guid': components['schemas']['code-scanning-analysis-tool-guid'] /** @description The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ - "git-ref": components["schemas"]["code-scanning-ref"]; + 'git-ref': components['schemas']['code-scanning-ref'] /** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ - "alert-number": components["schemas"]["alert-number"]; + 'alert-number': components['schemas']['alert-number'] /** @description commit_sha parameter */ - "commit-sha": string; + 'commit-sha': string /** @description deployment_id parameter */ - "deployment-id": number; + 'deployment-id': number /** @description The name of the environment */ - "environment-name": string; + 'environment-name': string /** @description A user ID. Only return users with an ID greater than this ID. */ - "since-user": number; + 'since-user': number /** @description issue_number parameter */ - "issue-number": number; + 'issue-number': number /** @description key_id parameter */ - "key-id": number; + 'key-id': number /** @description milestone_number parameter */ - "milestone-number": number; - "pull-number": number; + 'milestone-number': number + 'pull-number': number /** @description review_id parameter */ - "review-id": number; + 'review-id': number /** @description asset_id parameter */ - "asset-id": number; + 'asset-id': number /** @description release_id parameter */ - "release-id": number; + 'release-id': number /** @description Must be one of: `day`, `week`. */ - per: "" | "day" | "week"; + per: '' | 'day' | 'week' /** @description A repository ID. Only return repositories with an ID greater than this ID. */ - "since-repo": number; + 'since-repo': number /** @description Used for pagination: the index of the first result to return. */ - "start-index": number; + 'start-index': number /** @description Used for pagination: the number of results to return. */ - count: number; + count: number /** @description Identifier generated by the GitHub SCIM endpoint. */ - "scim-group-id": string; + 'scim-group-id': string /** @description scim_user_id parameter */ - "scim-user-id": string; + 'scim-user-id': string /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - order: "desc" | "asc"; - "team-id": number; + order: 'desc' | 'asc' + 'team-id': number /** @description ID of the Repository to filter on */ - "repository-id-in-query": number; + 'repository-id-in-query': number /** @description The name of the codespace. */ - "codespace-name": string; + 'codespace-name': string /** @description The ID of the export operation, or `latest`. Currently only `latest` is currently supported. */ - "export-id": string; + 'export-id': string /** @description gpg_key_id parameter */ - "gpg-key-id": number; - }; + 'gpg-key-id': number + } headers: { - link?: string; - "content-type"?: string; - "x-common-marker-version"?: string; - "x-rate-limit-limit"?: number; - "x-rate-limit-remaining"?: number; - "x-rate-limit-reset"?: number; - location?: string; - }; -}; + link?: string + 'content-type'?: string + 'x-common-marker-version'?: string + 'x-rate-limit-limit'?: number + 'x-rate-limit-remaining'?: number + 'x-rate-limit-reset'?: number + location?: string + } +} export type operations = { /** Get Hypermedia links to resources accessible in GitHub's REST API */ - "meta/root": { + 'meta/root': { responses: { /** Response */ 200: { content: { - "application/json": { + 'application/json': { /** Format: uri-template */ - current_user_url: string; + current_user_url: string /** Format: uri-template */ - current_user_authorizations_html_url: string; + current_user_authorizations_html_url: string /** Format: uri-template */ - authorizations_url: string; + authorizations_url: string /** Format: uri-template */ - code_search_url: string; + code_search_url: string /** Format: uri-template */ - commit_search_url: string; + commit_search_url: string /** Format: uri-template */ - emails_url: string; + emails_url: string /** Format: uri-template */ - emojis_url: string; + emojis_url: string /** Format: uri-template */ - events_url: string; + events_url: string /** Format: uri-template */ - feeds_url: string; + feeds_url: string /** Format: uri-template */ - followers_url: string; + followers_url: string /** Format: uri-template */ - following_url: string; + following_url: string /** Format: uri-template */ - gists_url: string; + gists_url: string /** Format: uri-template */ - hub_url: string; + hub_url: string /** Format: uri-template */ - issue_search_url: string; + issue_search_url: string /** Format: uri-template */ - issues_url: string; + issues_url: string /** Format: uri-template */ - keys_url: string; + keys_url: string /** Format: uri-template */ - label_search_url: string; + label_search_url: string /** Format: uri-template */ - notifications_url: string; + notifications_url: string /** Format: uri-template */ - organization_url: string; + organization_url: string /** Format: uri-template */ - organization_repositories_url: string; + organization_repositories_url: string /** Format: uri-template */ - organization_teams_url: string; + organization_teams_url: string /** Format: uri-template */ - public_gists_url: string; + public_gists_url: string /** Format: uri-template */ - rate_limit_url: string; + rate_limit_url: string /** Format: uri-template */ - repository_url: string; + repository_url: string /** Format: uri-template */ - repository_search_url: string; + repository_search_url: string /** Format: uri-template */ - current_user_repositories_url: string; + current_user_repositories_url: string /** Format: uri-template */ - starred_url: string; + starred_url: string /** Format: uri-template */ - starred_gists_url: string; + starred_gists_url: string /** Format: uri-template */ - topic_search_url?: string; + topic_search_url?: string /** Format: uri-template */ - user_url: string; + user_url: string /** Format: uri-template */ - user_organizations_url: string; + user_organizations_url: string /** Format: uri-template */ - user_repositories_url: string; + user_repositories_url: string /** Format: uri-template */ - user_search_url: string; - }; - }; - }; - }; - }; + user_search_url: string + } + } + } + } + } /** * Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/rest/reference/apps#list-installations-for-the-authenticated-app)" endpoint. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/get-authenticated": { - parameters: {}; + 'apps/get-authenticated': { + parameters: {} responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["integration"]; - }; - }; - }; - }; + 'application/json': components['schemas']['integration'] + } + } + } + } /** Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. */ - "apps/create-from-manifest": { + 'apps/create-from-manifest': { parameters: { path: { - code: string; - }; - }; + code: string + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["integration"] & + 'application/json': components['schemas']['integration'] & ({ - client_id: string; - client_secret: string; - webhook_secret: string | null; - pem: string; - } & { [key: string]: unknown }); - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + client_id: string + client_secret: string + webhook_secret: string | null + pem: string + } & { [key: string]: unknown }) + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { [key: string]: unknown }; - }; - }; - }; + 'application/json': { [key: string]: unknown } + } + } + } /** * Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/get-webhook-config-for-app": { + 'apps/get-webhook-config-for-app': { responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["webhook-config"]; - }; - }; - }; - }; + 'application/json': components['schemas']['webhook-config'] + } + } + } + } /** * Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/update-webhook-config-for-app": { + 'apps/update-webhook-config-for-app': { responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["webhook-config"]; - }; - }; - }; + 'application/json': components['schemas']['webhook-config'] + } + } + } requestBody: { content: { - "application/json": { - url?: components["schemas"]["webhook-config-url"]; - content_type?: components["schemas"]["webhook-config-content-type"]; - secret?: components["schemas"]["webhook-config-secret"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - }; - }; - }; - }; + 'application/json': { + url?: components['schemas']['webhook-config-url'] + content_type?: components['schemas']['webhook-config-content-type'] + secret?: components['schemas']['webhook-config-secret'] + insecure_ssl?: components['schemas']['webhook-config-insecure-ssl'] + } + } + } + } /** * Returns a list of webhook deliveries for the webhook configured for a GitHub App. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/list-webhook-deliveries": { + 'apps/list-webhook-deliveries': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ - cursor?: components["parameters"]["cursor"]; - }; - }; + cursor?: components['parameters']['cursor'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["hook-delivery-item"][]; - }; - }; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['hook-delivery-item'][] + } + } + 400: components['responses']['bad_request'] + 422: components['responses']['validation_failed'] + } + } /** * Returns a delivery for the webhook configured for a GitHub App. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/get-webhook-delivery": { + 'apps/get-webhook-delivery': { parameters: { path: { - delivery_id: components["parameters"]["delivery-id"]; - }; - }; + delivery_id: components['parameters']['delivery-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["hook-delivery"]; - }; - }; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['hook-delivery'] + } + } + 400: components['responses']['bad_request'] + 422: components['responses']['validation_failed'] + } + } /** * Redeliver a delivery for the webhook configured for a GitHub App. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/redeliver-webhook-delivery": { + 'apps/redeliver-webhook-delivery': { parameters: { path: { - delivery_id: components["parameters"]["delivery-id"]; - }; - }; + delivery_id: components['parameters']['delivery-id'] + } + } responses: { - 202: components["responses"]["accepted"]; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 202: components['responses']['accepted'] + 400: components['responses']['bad_request'] + 422: components['responses']['validation_failed'] + } + } /** * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. * * The permissions the installation has are included under the `permissions` key. */ - "apps/list-installations": { + 'apps/list-installations': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; - outdated?: string; - }; - }; + since?: components['parameters']['since'] + outdated?: string + } + } responses: { /** The permissions the installation has are included under the `permissions` key. */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["installation"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['installation'][] + } + } + } + } /** * Enables an authenticated GitHub App to find an installation's information using the installation id. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/get-installation": { + 'apps/get-installation': { parameters: { path: { /** installation_id parameter */ - installation_id: components["parameters"]["installation-id"]; - }; - }; + installation_id: components['parameters']['installation-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["installation"]; - }; - }; - 404: components["responses"]["not_found"]; - 415: components["responses"]["preview_header_missing"]; - }; - }; + 'application/json': components['schemas']['installation'] + } + } + 404: components['responses']['not_found'] + 415: components['responses']['preview_header_missing'] + } + } /** * Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/reference/apps/#suspend-an-app-installation)" endpoint. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/delete-installation": { + 'apps/delete-installation': { parameters: { path: { /** installation_id parameter */ - installation_id: components["parameters"]["installation-id"]; - }; - }; + installation_id: components['parameters']['installation-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** * Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/create-installation-access-token": { + 'apps/create-installation-access-token': { parameters: { path: { /** installation_id parameter */ - installation_id: components["parameters"]["installation-id"]; - }; - }; + installation_id: components['parameters']['installation-id'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["installation-token"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 415: components["responses"]["preview_header_missing"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['installation-token'] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 415: components['responses']['preview_header_missing'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description List of repository names that the token should have access to */ - repositories?: string[]; + repositories?: string[] /** * @description List of repository IDs that the token should have access to * @example 1 */ - repository_ids?: number[]; - permissions?: components["schemas"]["app-permissions"]; - }; - }; - }; - }; + repository_ids?: number[] + permissions?: components['schemas']['app-permissions'] + } + } + } + } /** * Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/suspend-installation": { + 'apps/suspend-installation': { parameters: { path: { /** installation_id parameter */ - installation_id: components["parameters"]["installation-id"]; - }; - }; + installation_id: components['parameters']['installation-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** * Removes a GitHub App installation suspension. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/unsuspend-installation": { + 'apps/unsuspend-installation': { parameters: { path: { /** installation_id parameter */ - installation_id: components["parameters"]["installation-id"]; - }; - }; + installation_id: components['parameters']['installation-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * * You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/rest/reference/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `["repo", "user"]`. */ - "oauth-authorizations/list-grants": { + 'oauth-authorizations/list-grants': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** The client ID of your GitHub app. */ - client_id?: string; - }; - }; + client_id?: string + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["application-grant"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['application-grant'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - "oauth-authorizations/get-grant": { + 'oauth-authorizations/get-grant': { parameters: { path: { /** grant_id parameter */ - grant_id: components["parameters"]["grant-id"]; - }; - }; + grant_id: components['parameters']['grant-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["application-grant"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['application-grant'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ - "oauth-authorizations/delete-grant": { + 'oauth-authorizations/delete-grant': { parameters: { path: { /** grant_id parameter */ - grant_id: components["parameters"]["grant-id"]; - }; - }; + grant_id: components['parameters']['grant-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** * OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ - "apps/delete-authorization": { + 'apps/delete-authorization': { parameters: { path: { /** The client ID of your GitHub app. */ - client_id: components["parameters"]["client-id"]; - }; - }; + client_id: components['parameters']['client-id'] + } + } responses: { /** Response */ - 204: never; - 422: components["responses"]["validation_failed"]; - }; + 204: never + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The OAuth access token used to authenticate to the GitHub API. */ - access_token: string; - }; - }; - }; - }; + access_token: string + } + } + } + } /** OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the OAuth application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`. */ - "apps/check-token": { + 'apps/check-token': { parameters: { path: { /** The client ID of your GitHub app. */ - client_id: components["parameters"]["client-id"]; - }; - }; + client_id: components['parameters']['client-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["authorization"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['authorization'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The access_token of the OAuth application. */ - access_token: string; - }; - }; - }; - }; + access_token: string + } + } + } + } /** OAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. */ - "apps/delete-token": { + 'apps/delete-token': { parameters: { path: { /** The client ID of your GitHub app. */ - client_id: components["parameters"]["client-id"]; - }; - }; + client_id: components['parameters']['client-id'] + } + } responses: { /** Response */ - 204: never; - 422: components["responses"]["validation_failed"]; - }; + 204: never + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The OAuth access token used to authenticate to the GitHub API. */ - access_token: string; - }; - }; - }; - }; + access_token: string + } + } + } + } /** OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. */ - "apps/reset-token": { + 'apps/reset-token': { parameters: { path: { /** The client ID of your GitHub app. */ - client_id: components["parameters"]["client-id"]; - }; - }; + client_id: components['parameters']['client-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["authorization"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['authorization'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The access_token of the OAuth application. */ - access_token: string; - }; - }; - }; - }; + access_token: string + } + } + } + } /** Use a non-scoped user-to-server OAuth access token to create a repository scoped and/or permission scoped user-to-server OAuth access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. */ - "apps/scope-token": { + 'apps/scope-token': { parameters: { path: { /** The client ID of your GitHub app. */ - client_id: components["parameters"]["client-id"]; - }; - }; + client_id: components['parameters']['client-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["authorization"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['authorization'] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The OAuth access token used to authenticate to the GitHub API. * @example e72e16c7e42f292c6912e7710c838347ae178b4a */ - access_token: string; + access_token: string /** * @description The name of the user or organization to scope the user-to-server access token to. **Required** unless `target_id` is specified. * @example octocat */ - target?: string; + target?: string /** * @description The ID of the user or organization to scope the user-to-server access token to. **Required** unless `target` is specified. * @example 1 */ - target_id?: number; + target_id?: number /** @description The list of repository names to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified. */ - repositories?: string[]; + repositories?: string[] /** * @description The list of repository IDs to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified. * @example 1 */ - repository_ids?: number[]; - permissions?: components["schemas"]["app-permissions"]; - }; - }; - }; - }; + repository_ids?: number[] + permissions?: components['schemas']['app-permissions'] + } + } + } + } /** * **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). * * If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ - "apps/get-by-slug": { + 'apps/get-by-slug': { parameters: { path: { - app_slug: components["parameters"]["app-slug"]; - }; - }; + app_slug: components['parameters']['app-slug'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["integration"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 415: components["responses"]["preview_header_missing"]; - }; - }; + 'application/json': components['schemas']['integration'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 415: components['responses']['preview_header_missing'] + } + } /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - "oauth-authorizations/list-authorizations": { + 'oauth-authorizations/list-authorizations': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** The client ID of your GitHub app. */ - client_id?: string; - }; - }; + client_id?: string + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["authorization"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['authorization'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * @@ -18519,49 +18507,49 @@ export type operations = { * * Organizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in [the GitHub Help documentation](https://docs.github.com/articles/about-identity-and-access-management-with-saml-single-sign-on). */ - "oauth-authorizations/create-authorization": { - parameters: {}; + 'oauth-authorizations/create-authorization': { + parameters: {} responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["authorization"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['authorization'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 410: components['responses']['gone'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description A list of scopes that this authorization is in. * @example public_repo,user */ - scopes?: string[] | null; + scopes?: string[] | null /** * @description A note to remind you what the OAuth token is for. * @example Update all gems */ - note?: string; + note?: string /** @description A URL to remind you what app the OAuth token is for. */ - note_url?: string; + note_url?: string /** @description The OAuth app client key for which to create the token. */ - client_id?: string; + client_id?: string /** @description The OAuth app client secret for which to create the token. */ - client_secret?: string; + client_secret?: string /** @description A unique string to distinguish an authorization from others created for the same client ID and user. */ - fingerprint?: string; - }; - }; - }; - }; + fingerprint?: string + } + } + } + } /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * @@ -18573,60 +18561,60 @@ export type operations = { * * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - "oauth-authorizations/get-or-create-authorization-for-app": { + 'oauth-authorizations/get-or-create-authorization-for-app': { parameters: { path: { /** The client ID of your GitHub app. */ - client_id: components["parameters"]["client-id"]; - }; - }; + client_id: components['parameters']['client-id'] + } + } responses: { /** if returning an existing token */ 200: { headers: { - Location?: string; - }; + Location?: string + } content: { - "application/json": components["schemas"]["authorization"]; - }; - }; + 'application/json': components['schemas']['authorization'] + } + } /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["authorization"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['authorization'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The OAuth app client secret for which to create the token. */ - client_secret: string; + client_secret: string /** * @description A list of scopes that this authorization is in. * @example public_repo,user */ - scopes?: string[] | null; + scopes?: string[] | null /** * @description A note to remind you what the OAuth token is for. * @example Update all gems */ - note?: string; + note?: string /** @description A URL to remind you what app the OAuth token is for. */ - note_url?: string; + note_url?: string /** @description A unique string to distinguish an authorization from others created for the same client ID and user. */ - fingerprint?: string; - }; - }; - }; - }; + fingerprint?: string + } + } + } + } /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * @@ -18636,92 +18624,92 @@ export type operations = { * * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." */ - "oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint": { + 'oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint': { parameters: { path: { /** The client ID of your GitHub app. */ - client_id: components["parameters"]["client-id"]; - fingerprint: string; - }; - }; + client_id: components['parameters']['client-id'] + fingerprint: string + } + } responses: { /** if returning an existing token */ 200: { headers: { - Location?: string; - }; + Location?: string + } content: { - "application/json": components["schemas"]["authorization"]; - }; - }; + 'application/json': components['schemas']['authorization'] + } + } /** Response if returning a new token */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["authorization"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['authorization'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The OAuth app client secret for which to create the token. */ - client_secret: string; + client_secret: string /** * @description A list of scopes that this authorization is in. * @example public_repo,user */ - scopes?: string[] | null; + scopes?: string[] | null /** * @description A note to remind you what the OAuth token is for. * @example Update all gems */ - note?: string; + note?: string /** @description A URL to remind you what app the OAuth token is for. */ - note_url?: string; - }; - }; - }; - }; + note_url?: string + } + } + } + } /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - "oauth-authorizations/get-authorization": { + 'oauth-authorizations/get-authorization': { parameters: { path: { /** authorization_id parameter */ - authorization_id: components["parameters"]["authorization-id"]; - }; - }; + authorization_id: components['parameters']['authorization-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["authorization"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['authorization'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - "oauth-authorizations/delete-authorization": { + 'oauth-authorizations/delete-authorization': { parameters: { path: { /** authorization_id parameter */ - authorization_id: components["parameters"]["authorization-id"]; - }; - }; + authorization_id: components['parameters']['authorization-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * @@ -18729,678 +18717,678 @@ export type operations = { * * You can only send one of these scope keys at a time. */ - "oauth-authorizations/update-authorization": { + 'oauth-authorizations/update-authorization': { parameters: { path: { /** authorization_id parameter */ - authorization_id: components["parameters"]["authorization-id"]; - }; - }; + authorization_id: components['parameters']['authorization-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["authorization"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['authorization'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description A list of scopes that this authorization is in. * @example public_repo,user */ - scopes?: string[] | null; + scopes?: string[] | null /** @description A list of scopes to add to this authorization. */ - add_scopes?: string[]; + add_scopes?: string[] /** @description A list of scopes to remove from this authorization. */ - remove_scopes?: string[]; + remove_scopes?: string[] /** * @description A note to remind you what the OAuth token is for. * @example Update all gems */ - note?: string; + note?: string /** @description A URL to remind you what app the OAuth token is for. */ - note_url?: string; + note_url?: string /** @description A unique string to distinguish an authorization from others created for the same client ID and user. */ - fingerprint?: string; - }; - }; - }; - }; - "codes-of-conduct/get-all-codes-of-conduct": { - parameters: {}; + fingerprint?: string + } + } + } + } + 'codes-of-conduct/get-all-codes-of-conduct': { + parameters: {} responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["code-of-conduct"][]; - }; - }; - 304: components["responses"]["not_modified"]; - }; - }; - "codes-of-conduct/get-conduct-code": { + 'application/json': components['schemas']['code-of-conduct'][] + } + } + 304: components['responses']['not_modified'] + } + } + 'codes-of-conduct/get-conduct-code': { parameters: { path: { - key: string; - }; - }; + key: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["code-of-conduct"]; - }; - }; - 304: components["responses"]["not_modified"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['code-of-conduct'] + } + } + 304: components['responses']['not_modified'] + 404: components['responses']['not_found'] + } + } /** Lists all the emojis available to use on GitHub. */ - "emojis/get": { - parameters: {}; + 'emojis/get': { + parameters: {} responses: { /** Response */ 200: { content: { - "application/json": { [key: string]: string }; - }; - }; - 304: components["responses"]["not_modified"]; - }; - }; + 'application/json': { [key: string]: string } + } + } + 304: components['responses']['not_modified'] + } + } /** * Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - "enterprise-admin/get-github-actions-permissions-enterprise": { + 'enterprise-admin/get-github-actions-permissions-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-enterprise-permissions"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-enterprise-permissions'] + } + } + } + } /** * Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - "enterprise-admin/set-github-actions-permissions-enterprise": { + 'enterprise-admin/set-github-actions-permissions-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { - enabled_organizations: components["schemas"]["enabled-organizations"]; - allowed_actions?: components["schemas"]["allowed-actions"]; - }; - }; - }; - }; + 'application/json': { + enabled_organizations: components['schemas']['enabled-organizations'] + allowed_actions?: components['schemas']['allowed-actions'] + } + } + } + } /** * Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - "enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise": { + 'enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; + enterprise: components['parameters']['enterprise'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - organizations: components["schemas"]["organization-simple"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + organizations: components['schemas']['organization-simple'][] + } + } + } + } + } /** * Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - "enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise": { + 'enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description List of organization IDs to enable for GitHub Actions. */ - selected_organization_ids: number[]; - }; - }; - }; - }; + selected_organization_ids: number[] + } + } + } + } /** * Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - "enterprise-admin/enable-selected-organization-github-actions-enterprise": { + 'enterprise-admin/enable-selected-organization-github-actions-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of an organization. */ - org_id: components["parameters"]["org-id"]; - }; - }; + org_id: components['parameters']['org-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - "enterprise-admin/disable-selected-organization-github-actions-enterprise": { + 'enterprise-admin/disable-selected-organization-github-actions-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of an organization. */ - org_id: components["parameters"]["org-id"]; - }; - }; + org_id: components['parameters']['org-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - "enterprise-admin/get-allowed-actions-enterprise": { + 'enterprise-admin/get-allowed-actions-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["selected-actions"]; - }; - }; - }; - }; + 'application/json': components['schemas']['selected-actions'] + } + } + } + } /** * Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - "enterprise-admin/set-allowed-actions-enterprise": { + 'enterprise-admin/set-allowed-actions-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": components["schemas"]["selected-actions"]; - }; - }; - }; + 'application/json': components['schemas']['selected-actions'] + } + } + } /** * Lists all self-hosted runner groups for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/list-self-hosted-runner-groups-for-enterprise": { + 'enterprise-admin/list-self-hosted-runner-groups-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; + enterprise: components['parameters']['enterprise'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - runner_groups: components["schemas"]["runner-groups-enterprise"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + runner_groups: components['schemas']['runner-groups-enterprise'][] + } + } + } + } + } /** * Creates a new self-hosted runner group for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/create-self-hosted-runner-group-for-enterprise": { + 'enterprise-admin/create-self-hosted-runner-group-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["runner-groups-enterprise"]; - }; - }; - }; + 'application/json': components['schemas']['runner-groups-enterprise'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Name of the runner group. */ - name: string; + name: string /** * @description Visibility of a runner group. You can select all organizations or select individual organization. Can be one of: `all` or `selected` * @enum {string} */ - visibility?: "selected" | "all"; + visibility?: 'selected' | 'all' /** @description List of organization IDs that can access the runner group. */ - selected_organization_ids?: number[]; + selected_organization_ids?: number[] /** @description List of runner IDs to add to the runner group. */ - runners?: number[]; + runners?: number[] /** @description Whether the runner group can be used by `public` repositories. */ - allows_public_repositories?: boolean; - }; - }; - }; - }; + allows_public_repositories?: boolean + } + } + } + } /** * Gets a specific self-hosted runner group for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/get-self-hosted-runner-group-for-enterprise": { + 'enterprise-admin/get-self-hosted-runner-group-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["runner-groups-enterprise"]; - }; - }; - }; - }; + 'application/json': components['schemas']['runner-groups-enterprise'] + } + } + } + } /** * Deletes a self-hosted runner group for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/delete-self-hosted-runner-group-from-enterprise": { + 'enterprise-admin/delete-self-hosted-runner-group-from-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Updates the `name` and `visibility` of a self-hosted runner group in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/update-self-hosted-runner-group-for-enterprise": { + 'enterprise-admin/update-self-hosted-runner-group-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["runner-groups-enterprise"]; - }; - }; - }; + 'application/json': components['schemas']['runner-groups-enterprise'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Name of the runner group. */ - name?: string; + name?: string /** * @description Visibility of a runner group. You can select all organizations or select individual organizations. Can be one of: `all` or `selected` * @default all * @enum {string} */ - visibility?: "selected" | "all"; + visibility?: 'selected' | 'all' /** @description Whether the runner group can be used by `public` repositories. */ - allows_public_repositories?: boolean; - }; - }; - }; - }; + allows_public_repositories?: boolean + } + } + } + } /** * Lists the organizations with access to a self-hosted runner group. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise": { + 'enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; + runner_group_id: components['parameters']['runner-group-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - organizations: components["schemas"]["organization-simple"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + organizations: components['schemas']['organization-simple'][] + } + } + } + } + } /** * Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise": { + 'enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description List of organization IDs that can access the runner group. */ - selected_organization_ids: number[]; - }; - }; - }; - }; + selected_organization_ids: number[] + } + } + } + } /** * Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise": { + 'enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components['parameters']['runner-group-id'] /** Unique identifier of an organization. */ - org_id: components["parameters"]["org-id"]; - }; - }; + org_id: components['parameters']['org-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise": { + 'enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components['parameters']['runner-group-id'] /** Unique identifier of an organization. */ - org_id: components["parameters"]["org-id"]; - }; - }; + org_id: components['parameters']['org-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Lists the self-hosted runners that are in a specific enterprise group. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise": { + 'enterprise-admin/list-self-hosted-runners-in-group-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; + runner_group_id: components['parameters']['runner-group-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - runners: components["schemas"]["runner"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + runners: components['schemas']['runner'][] + } + } + } + } + } /** * Replaces the list of self-hosted runners that are part of an enterprise runner group. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise": { + 'enterprise-admin/set-self-hosted-runners-in-group-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description List of runner IDs to add to the runner group. */ - runners: number[]; - }; - }; - }; - }; + runners: number[] + } + } + } + } /** * Adds a self-hosted runner to a runner group configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` * scope to use this endpoint. */ - "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise": { + 'enterprise-admin/add-self-hosted-runner-to-group-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components['parameters']['runner-group-id'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise": { + 'enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components['parameters']['runner-group-id'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Lists all self-hosted runners configured for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/list-self-hosted-runners-for-enterprise": { + 'enterprise-admin/list-self-hosted-runners-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; + enterprise: components['parameters']['enterprise'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count?: number; - runners?: components["schemas"]["runner"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count?: number + runners?: components['schemas']['runner'][] + } + } + } + } + } /** * Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/list-runner-applications-for-enterprise": { + 'enterprise-admin/list-runner-applications-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["runner-application"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['runner-application'][] + } + } + } + } /** * Returns a token that you can pass to the `config` script. The token expires after one hour. * @@ -19414,22 +19402,22 @@ export type operations = { * ./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN * ``` */ - "enterprise-admin/create-registration-token-for-enterprise": { + 'enterprise-admin/create-registration-token-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["authentication-token"]; - }; - }; - }; - }; + 'application/json': components['schemas']['authentication-token'] + } + } + } + } /** * Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour. * @@ -19444,161 +19432,161 @@ export type operations = { * ./config.sh remove --token TOKEN * ``` */ - "enterprise-admin/create-remove-token-for-enterprise": { + 'enterprise-admin/create-remove-token-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["authentication-token"]; - }; - }; - }; - }; + 'application/json': components['schemas']['authentication-token'] + } + } + } + } /** * Gets a specific self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/get-self-hosted-runner-for-enterprise": { + 'enterprise-admin/get-self-hosted-runner-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["runner"]; - }; - }; - }; - }; + 'application/json': components['schemas']['runner'] + } + } + } + } /** * Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/delete-self-hosted-runner-from-enterprise": { + 'enterprise-admin/delete-self-hosted-runner-from-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Lists all labels for a self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise": { + 'enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - }; - }; + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + } + } /** * Remove all previous custom labels and set the new custom labels for a specific * self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise": { + 'enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; - responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + runner_id: components['parameters']['runner-id'] + } + } + responses: { + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels. */ - labels: string[]; - }; - }; - }; - }; + labels: string[] + } + } + } + } /** * Add custom labels to a self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise": { + 'enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; - responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + runner_id: components['parameters']['runner-id'] + } + } + responses: { + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The names of the custom labels to add to the runner. */ - labels: string[]; - }; - }; - }; - }; + labels: string[] + } + } + } + } /** * Remove all custom labels from a self-hosted runner configured in an * enterprise. Returns the remaining read-only labels from the runner. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise": { + 'enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { - 200: components["responses"]["actions_runner_labels_readonly"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; - }; + 200: components['responses']['actions_runner_labels_readonly'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } + } /** * Remove a custom label from a self-hosted runner configured * in an enterprise. Returns the remaining labels from the runner. @@ -19608,33 +19596,33 @@ export type operations = { * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise": { + 'enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; + runner_id: components['parameters']['runner-id'] /** The name of a self-hosted runner's custom label. */ - name: components["parameters"]["runner-label-name"]; - }; - }; - responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; - }; + name: components['parameters']['runner-label-name'] + } + } + responses: { + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } + } /** Gets the audit log for an enterprise. To use this endpoint, you must be an enterprise admin, and you must use an access token with the `admin:enterprise` scope. */ - "enterprise-admin/get-audit-log": { + 'enterprise-admin/get-audit-log': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; + enterprise: components['parameters']['enterprise'] + } query: { /** A search phrase. For more information, see [Searching the audit log](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). */ - phrase?: components["parameters"]["audit-log-phrase"]; + phrase?: components['parameters']['audit-log-phrase'] /** * The event types to include: * @@ -19644,73 +19632,73 @@ export type operations = { * * The default is `web`. */ - include?: components["parameters"]["audit-log-include"]; + include?: components['parameters']['audit-log-include'] /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor. */ - after?: components["parameters"]["audit-log-after"]; + after?: components['parameters']['audit-log-after'] /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor. */ - before?: components["parameters"]["audit-log-before"]; + before?: components['parameters']['audit-log-before'] /** * The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. * * The default is `desc`. */ - order?: components["parameters"]["audit-log-order"]; + order?: components['parameters']['audit-log-order'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["audit-log-event"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['audit-log-event'][] + } + } + } + } /** * Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. * To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). */ - "secret-scanning/list-alerts-for-enterprise": { + 'secret-scanning/list-alerts-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; + enterprise: components['parameters']['enterprise'] + } query: { /** Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - state?: components["parameters"]["secret-scanning-alert-state"]; + state?: components['parameters']['secret-scanning-alert-state'] /** * A comma-separated list of secret types to return. By default all secret types are returned. * See "[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)" * for a complete list of secret types (API slug). */ - secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; + secret_type?: components['parameters']['secret-scanning-alert-secret-type'] /** A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - resolution?: components["parameters"]["secret-scanning-alert-resolution"]; + resolution?: components['parameters']['secret-scanning-alert-resolution'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor. */ - before?: components["parameters"]["pagination-before"]; + before?: components['parameters']['pagination-before'] /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor. */ - after?: components["parameters"]["pagination-after"]; - }; - }; + after?: components['parameters']['pagination-after'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["organization-secret-scanning-alert"][]; - }; - }; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': components['schemas']['organization-secret-scanning-alert'][] + } + } + 404: components['responses']['not_found'] + 503: components['responses']['service_unavailable'] + } + } /** * Gets the summary of the free and paid GitHub Actions minutes used. * @@ -19718,49 +19706,49 @@ export type operations = { * * The authenticated user must be an enterprise admin. */ - "billing/get-github-actions-billing-ghe": { + 'billing/get-github-actions-billing-ghe': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-billing-usage"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-billing-usage'] + } + } + } + } /** * Gets the GitHub Advanced Security active committers for an enterprise per repository. * Each distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of active_users for each repository. */ - "billing/get-github-advanced-security-billing-ghe": { + 'billing/get-github-advanced-security-billing-ghe': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; + enterprise: components['parameters']['enterprise'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Success */ 200: { content: { - "application/json": components["schemas"]["advanced-security-active-committers"]; - }; - }; - 403: components["responses"]["code_scanning_forbidden_read"]; - }; - }; + 'application/json': components['schemas']['advanced-security-active-committers'] + } + } + 403: components['responses']['code_scanning_forbidden_read'] + } + } /** * Gets the free and paid storage used for GitHub Packages in gigabytes. * @@ -19768,22 +19756,22 @@ export type operations = { * * The authenticated user must be an enterprise admin. */ - "billing/get-github-packages-billing-ghe": { + 'billing/get-github-packages-billing-ghe': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["packages-billing-usage"]; - }; - }; - }; - }; + 'application/json': components['schemas']['packages-billing-usage'] + } + } + } + } /** * Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. * @@ -19791,44 +19779,44 @@ export type operations = { * * The authenticated user must be an enterprise admin. */ - "billing/get-shared-storage-billing-ghe": { + 'billing/get-shared-storage-billing-ghe': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["combined-billing-usage"]; - }; - }; - }; - }; + 'application/json': components['schemas']['combined-billing-usage'] + } + } + } + } /** We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. */ - "activity/list-public-events": { + 'activity/list-public-events': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["event"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': components['schemas']['event'][] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 503: components['responses']['service_unavailable'] + } + } /** * GitHub provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user: * @@ -19842,71 +19830,71 @@ export type operations = { * * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ - "activity/get-feeds": { - parameters: {}; + 'activity/get-feeds': { + parameters: {} responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["feed"]; - }; - }; - }; - }; + 'application/json': components['schemas']['feed'] + } + } + } + } /** Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists: */ - "gists/list": { + 'gists/list': { parameters: { query: { /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["base-gist"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['base-gist'][] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + } + } /** * Allows you to add a new gist with one or more files. * * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. */ - "gists/create": { - parameters: {}; + 'gists/create': { + parameters: {} responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["gist-simple"]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['gist-simple'] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description Description of the gist * @example Example Ruby script */ - description?: string; + description?: string /** * @description Names and content for the files that make up the gist * @example [object Object] @@ -19914,478 +19902,478 @@ export type operations = { files: { [key: string]: { /** @description Content of the file */ - content: string; - }; - }; - public?: boolean | ("true" | "false"); - }; - }; - }; - }; + content: string + } + } + public?: boolean | ('true' | 'false') + } + } + } + } /** * List public gists sorted by most recently updated to least recently updated. * * Note: With [pagination](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. */ - "gists/list-public": { + 'gists/list-public': { parameters: { query: { /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["base-gist"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['base-gist'][] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } + } /** List the authenticated user's starred gists: */ - "gists/list-starred": { + 'gists/list-starred': { parameters: { query: { /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["base-gist"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; - "gists/get": { + 'application/json': components['schemas']['base-gist'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } + 'gists/get': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - }; - }; + gist_id: components['parameters']['gist-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["gist-simple"]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden_gist"]; - 404: components["responses"]["not_found"]; - }; - }; - "gists/delete": { + 'application/json': components['schemas']['gist-simple'] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden_gist'] + 404: components['responses']['not_found'] + } + } + 'gists/delete': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - }; - }; + gist_id: components['parameters']['gist-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged. */ - "gists/update": { + 'gists/update': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - }; - }; + gist_id: components['parameters']['gist-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["gist-simple"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['gist-simple'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description Description of the gist * @example Example Ruby script */ - description?: string; + description?: string /** * @description Names of files to be updated * @example [object Object] */ - files?: { [key: string]: Partial<{ [key: string]: unknown }> }; - } | null; - }; - }; - }; - "gists/list-comments": { + files?: { [key: string]: Partial<{ [key: string]: unknown }> } + } | null + } + } + } + 'gists/list-comments': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - }; + gist_id: components['parameters']['gist-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["gist-comment"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "gists/create-comment": { + 'application/json': components['schemas']['gist-comment'][] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'gists/create-comment': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - }; - }; + gist_id: components['parameters']['gist-id'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["gist-comment"]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['gist-comment'] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The comment text. * @example Body of the attachment */ - body: string; - }; - }; - }; - }; - "gists/get-comment": { + body: string + } + } + } + } + 'gists/get-comment': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; + gist_id: components['parameters']['gist-id'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["gist-comment"]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden_gist"]; - 404: components["responses"]["not_found"]; - }; - }; - "gists/delete-comment": { + 'application/json': components['schemas']['gist-comment'] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden_gist'] + 404: components['responses']['not_found'] + } + } + 'gists/delete-comment': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; + gist_id: components['parameters']['gist-id'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "gists/update-comment": { + 204: never + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'gists/update-comment': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; + gist_id: components['parameters']['gist-id'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["gist-comment"]; - }; - }; - 404: components["responses"]["not_found"]; - }; + 'application/json': components['schemas']['gist-comment'] + } + } + 404: components['responses']['not_found'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The comment text. * @example Body of the attachment */ - body: string; - }; - }; - }; - }; - "gists/list-commits": { + body: string + } + } + } + } + 'gists/list-commits': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - }; + gist_id: components['parameters']['gist-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { headers: { - Link?: string; - }; + Link?: string + } content: { - "application/json": components["schemas"]["gist-commit"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "gists/list-forks": { + 'application/json': components['schemas']['gist-commit'][] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'gists/list-forks': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - }; + gist_id: components['parameters']['gist-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["gist-simple"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['gist-simple'][] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** **Note**: This was previously `/gists/:gist_id/fork`. */ - "gists/fork": { + 'gists/fork': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - }; - }; + gist_id: components['parameters']['gist-id'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; + Location?: string + } content: { - "application/json": components["schemas"]["base-gist"]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "gists/check-is-starred": { + 'application/json': components['schemas']['base-gist'] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } + 'gists/check-is-starred': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - }; - }; + gist_id: components['parameters']['gist-id'] + } + } responses: { /** Response if gist is starred */ - 204: never; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; + 204: never + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] /** Not Found if gist is not starred */ 404: { content: { - "application/json": { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': { [key: string]: unknown } + } + } + } + } /** Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - "gists/star": { + 'gists/star': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - }; - }; + gist_id: components['parameters']['gist-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "gists/unstar": { + 204: never + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'gists/unstar': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - }; - }; + gist_id: components['parameters']['gist-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "gists/get-revision": { + 204: never + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'gists/get-revision': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - sha: string; - }; - }; + gist_id: components['parameters']['gist-id'] + sha: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["gist-simple"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['gist-simple'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** List all templates available to pass as an option when [creating a repository](https://docs.github.com/rest/reference/repos#create-a-repository-for-the-authenticated-user). */ - "gitignore/get-all-templates": { - parameters: {}; + 'gitignore/get-all-templates': { + parameters: {} responses: { /** Response */ 200: { content: { - "application/json": string[]; - }; - }; - 304: components["responses"]["not_modified"]; - }; - }; + 'application/json': string[] + } + } + 304: components['responses']['not_modified'] + } + } /** * The API also allows fetching the source of a single template. * Use the raw [media type](https://docs.github.com/rest/overview/media-types/) to get the raw contents. */ - "gitignore/get-template": { + 'gitignore/get-template': { parameters: { path: { - name: string; - }; - }; + name: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["gitignore-template"]; - }; - }; - 304: components["responses"]["not_modified"]; - }; - }; + 'application/json': components['schemas']['gitignore-template'] + } + } + 304: components['responses']['not_modified'] + } + } /** * List repositories that an app installation can access. * * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ - "apps/list-repos-accessible-to-installation": { + 'apps/list-repos-accessible-to-installation': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - repositories: components["schemas"]["repository"][]; + 'application/json': { + total_count: number + repositories: components['schemas']['repository'][] /** @example selected */ - repository_selection?: string; - }; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + repository_selection?: string + } + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** * Revokes the installation token you're using to authenticate as an installation and access this endpoint. * @@ -20393,13 +20381,13 @@ export type operations = { * * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ - "apps/revoke-installation-access-token": { - parameters: {}; + 'apps/revoke-installation-access-token': { + parameters: {} responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * List issues assigned to the authenticated user across all visible repositories including owned repositories, member * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not @@ -20411,7 +20399,7 @@ export type operations = { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - "issues/list": { + 'issues/list': { parameters: { query: { /** @@ -20422,465 +20410,465 @@ export type operations = { * \* `subscribed`: Issues you're subscribed to updates for * \* `all` or `repos`: All issues the authenticated user can see, regardless of participation or creation */ - filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all"; + filter?: 'assigned' | 'created' | 'mentioned' | 'subscribed' | 'repos' | 'all' /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ - state?: "open" | "closed" | "all"; + state?: 'open' | 'closed' | 'all' /** A list of comma separated label names. Example: `bug,ui,@high` */ - labels?: components["parameters"]["labels"]; + labels?: components['parameters']['labels'] /** What to sort results by. Can be either `created`, `updated`, `comments`. */ - sort?: "created" | "updated" | "comments"; + sort?: 'created' | 'updated' | 'comments' /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; - collab?: boolean; - orgs?: boolean; - owned?: boolean; - pulls?: boolean; + since?: components['parameters']['since'] + collab?: boolean + orgs?: boolean + owned?: boolean + pulls?: boolean /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["issue"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "licenses/get-all-commonly-used": { + 'application/json': components['schemas']['issue'][] + } + } + 304: components['responses']['not_modified'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } + 'licenses/get-all-commonly-used': { parameters: { query: { - featured?: boolean; + featured?: boolean /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["license-simple"][]; - }; - }; - 304: components["responses"]["not_modified"]; - }; - }; - "licenses/get": { + 'application/json': components['schemas']['license-simple'][] + } + } + 304: components['responses']['not_modified'] + } + } + 'licenses/get': { parameters: { path: { - license: string; - }; - }; + license: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["license"]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "markdown/render": { - parameters: {}; + 'application/json': components['schemas']['license'] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'markdown/render': { + parameters: {} responses: { /** Response */ 200: { headers: { - "Content-Length"?: string; - }; - content: { - "text/html": string; - }; - }; - 304: components["responses"]["not_modified"]; - }; + 'Content-Length'?: string + } + content: { + 'text/html': string + } + } + 304: components['responses']['not_modified'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The Markdown text to render in HTML. */ - text: string; + text: string /** * @description The rendering mode. Can be either `markdown` or `gfm`. * @default markdown * @example markdown * @enum {string} */ - mode?: "markdown" | "gfm"; + mode?: 'markdown' | 'gfm' /** @description The repository context to use when creating references in `gfm` mode. For example, setting `context` to `octo-org/octo-repo` will change the text `#42` into an HTML link to issue 42 in the `octo-org/octo-repo` repository. */ - context?: string; - }; - }; - }; - }; + context?: string + } + } + } + } /** You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less. */ - "markdown/render-raw": { - parameters: {}; + 'markdown/render-raw': { + parameters: {} responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "text/html": string; - }; - }; - 304: components["responses"]["not_modified"]; - }; + 'text/html': string + } + } + 304: components['responses']['not_modified'] + } requestBody: { content: { - "text/plain": string; - "text/x-markdown": string; - }; - }; - }; + 'text/plain': string + 'text/x-markdown': string + } + } + } /** * Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - "apps/get-subscription-plan-for-account": { + 'apps/get-subscription-plan-for-account': { parameters: { path: { /** account_id parameter */ - account_id: components["parameters"]["account-id"]; - }; - }; + account_id: components['parameters']['account-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["marketplace-purchase"]; - }; - }; - 401: components["responses"]["requires_authentication"]; + 'application/json': components['schemas']['marketplace-purchase'] + } + } + 401: components['responses']['requires_authentication'] /** Not Found when the account has not purchased the listing */ 404: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } + } + } /** * Lists all plans that are part of your GitHub Marketplace listing. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - "apps/list-plans": { + 'apps/list-plans': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["marketplace-listing-plan"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['marketplace-listing-plan'][] + } + } + 401: components['responses']['requires_authentication'] + 404: components['responses']['not_found'] + } + } /** * Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - "apps/list-accounts-for-plan": { + 'apps/list-accounts-for-plan': { parameters: { path: { /** plan_id parameter */ - plan_id: components["parameters"]["plan-id"]; - }; + plan_id: components['parameters']['plan-id'] + } query: { /** One of `created` (when the repository was starred) or `updated` (when it was last pushed to). */ - sort?: components["parameters"]["sort"]; + sort?: components['parameters']['sort'] /** To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter. */ - direction?: "asc" | "desc"; + direction?: 'asc' | 'desc' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["marketplace-purchase"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['marketplace-purchase'][] + } + } + 401: components['responses']['requires_authentication'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** * Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - "apps/get-subscription-plan-for-account-stubbed": { + 'apps/get-subscription-plan-for-account-stubbed': { parameters: { path: { /** account_id parameter */ - account_id: components["parameters"]["account-id"]; - }; - }; + account_id: components['parameters']['account-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["marketplace-purchase"]; - }; - }; - 401: components["responses"]["requires_authentication"]; + 'application/json': components['schemas']['marketplace-purchase'] + } + } + 401: components['responses']['requires_authentication'] /** Not Found when the account has not purchased the listing */ - 404: unknown; - }; - }; + 404: unknown + } + } /** * Lists all plans that are part of your GitHub Marketplace listing. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - "apps/list-plans-stubbed": { + 'apps/list-plans-stubbed': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["marketplace-listing-plan"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - }; - }; + 'application/json': components['schemas']['marketplace-listing-plan'][] + } + } + 401: components['responses']['requires_authentication'] + } + } /** * Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - "apps/list-accounts-for-plan-stubbed": { + 'apps/list-accounts-for-plan-stubbed': { parameters: { path: { /** plan_id parameter */ - plan_id: components["parameters"]["plan-id"]; - }; + plan_id: components['parameters']['plan-id'] + } query: { /** One of `created` (when the repository was starred) or `updated` (when it was last pushed to). */ - sort?: components["parameters"]["sort"]; + sort?: components['parameters']['sort'] /** To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter. */ - direction?: "asc" | "desc"; + direction?: 'asc' | 'desc' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["marketplace-purchase"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - }; - }; + 'application/json': components['schemas']['marketplace-purchase'][] + } + } + 401: components['responses']['requires_authentication'] + } + } /** * Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://docs.github.com/articles/about-github-s-ip-addresses/)." * * **Note:** The IP addresses shown in the documentation's response are only example values. You must always query the API directly to get the latest list of IP addresses. */ - "meta/get": { - parameters: {}; + 'meta/get': { + parameters: {} responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["api-overview"]; - }; - }; - 304: components["responses"]["not_modified"]; - }; - }; - "activity/list-public-events-for-repo-network": { + 'application/json': components['schemas']['api-overview'] + } + } + 304: components['responses']['not_modified'] + } + } + 'activity/list-public-events-for-repo-network': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["event"][]; - }; - }; - 301: components["responses"]["moved_permanently"]; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['event'][] + } + } + 301: components['responses']['moved_permanently'] + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** List all notifications for the current user, sorted by most recently updated. */ - "activity/list-notifications-for-authenticated-user": { + 'activity/list-notifications-for-authenticated-user': { parameters: { query: { /** If `true`, show notifications marked as read. */ - all?: components["parameters"]["all"]; + all?: components['parameters']['all'] /** If `true`, only shows notifications in which the user is directly participating or mentioned. */ - participating?: components["parameters"]["participating"]; + participating?: components['parameters']['participating'] /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - before?: components["parameters"]["before"]; + before?: components['parameters']['before'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["thread"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['thread'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } + } /** Marks all notifications as "read" removes it from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ - "activity/mark-notifications-as-read": { - parameters: {}; + 'activity/mark-notifications-as-read': { + parameters: {} responses: { /** Response */ 202: { content: { - "application/json": { - message?: string; - }; - }; - }; + 'application/json': { + message?: string + } + } + } /** Reset Content */ - 205: unknown; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; + 205: unknown + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * Format: date-time * @description Describes the last point that notifications were checked. */ - last_read_at?: string; + last_read_at?: string /** @description Whether the notification has been read. */ - read?: boolean; - }; - }; - }; - }; - "activity/get-thread": { + read?: boolean + } + } + } + } + 'activity/get-thread': { parameters: { path: { /** thread_id parameter */ - thread_id: components["parameters"]["thread-id"]; - }; - }; + thread_id: components['parameters']['thread-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["thread"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; - "activity/mark-thread-as-read": { + 'application/json': components['schemas']['thread'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } + 'activity/mark-thread-as-read': { parameters: { path: { /** thread_id parameter */ - thread_id: components["parameters"]["thread-id"]; - }; - }; + thread_id: components['parameters']['thread-id'] + } + } responses: { /** Reset Content */ - 205: unknown; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - }; - }; + 205: unknown + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + } + } /** * This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/rest/reference/activity#get-a-repository-subscription). * * Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. */ - "activity/get-thread-subscription-for-authenticated-user": { + 'activity/get-thread-subscription-for-authenticated-user': { parameters: { path: { /** thread_id parameter */ - thread_id: components["parameters"]["thread-id"]; - }; - }; + thread_id: components['parameters']['thread-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["thread-subscription"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['thread-subscription'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** * If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**. * @@ -20888,213 +20876,211 @@ export type operations = { * * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/rest/reference/activity#delete-a-thread-subscription) endpoint. */ - "activity/set-thread-subscription": { + 'activity/set-thread-subscription': { parameters: { path: { /** thread_id parameter */ - thread_id: components["parameters"]["thread-id"]; - }; - }; + thread_id: components['parameters']['thread-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["thread-subscription"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; + 'application/json': components['schemas']['thread-subscription'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Whether to block all notifications from a thread. */ - ignored?: boolean; - }; - }; - }; - }; + ignored?: boolean + } + } + } + } /** Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/rest/reference/activity#set-a-thread-subscription) endpoint and set `ignore` to `true`. */ - "activity/delete-thread-subscription": { + 'activity/delete-thread-subscription': { parameters: { path: { /** thread_id parameter */ - thread_id: components["parameters"]["thread-id"]; - }; - }; + thread_id: components['parameters']['thread-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** Get the octocat as ASCII art */ - "meta/get-octocat": { + 'meta/get-octocat': { parameters: { query: { /** The words to show in Octocat's speech bubble */ - s?: string; - }; - }; + s?: string + } + } responses: { /** Response */ 200: { content: { - "application/octocat-stream": string; - }; - }; - }; - }; + 'application/octocat-stream': string + } + } + } + } /** * Lists all organizations, in the order that they were created on GitHub. * * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of organizations. */ - "orgs/list": { + 'orgs/list': { parameters: { query: { /** An organization ID. Only return organizations with an ID greater than this ID. */ - since?: components["parameters"]["since-org"]; + since?: components['parameters']['since-org'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { headers: { - Link?: string; - }; + Link?: string + } content: { - "application/json": components["schemas"]["organization-simple"][]; - }; - }; - 304: components["responses"]["not_modified"]; - }; - }; + 'application/json': components['schemas']['organization-simple'][] + } + } + 304: components['responses']['not_modified'] + } + } /** * List the custom repository roles available in this organization. In order to see custom * repository roles in an organization, the authenticated user must be an organization owner. * * For more information on custom repository roles, see "[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)". */ - "orgs/list-custom-roles": { + 'orgs/list-custom-roles': { parameters: { path: { - organization_id: string; - }; - }; + organization_id: string + } + } responses: { /** Response - list of custom role names */ 200: { content: { - "application/json": { + 'application/json': { /** * @description The number of custom roles in this organization * @example 3 */ - total_count?: number; - custom_roles?: components["schemas"]["organization-custom-repository-role"][]; - }; - }; - }; - }; - }; + total_count?: number + custom_roles?: components['schemas']['organization-custom-repository-role'][] + } + } + } + } + } /** * Lists a connection between a team and an external group. * * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ - "teams/list-linked-external-idp-groups-to-team-for-org": { + 'teams/list-linked-external-idp-groups-to-team-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; - }; + team_slug: components['parameters']['team-slug'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["external-groups"]; - }; - }; - }; - }; + 'application/json': components['schemas']['external-groups'] + } + } + } + } /** * To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). * * GitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub plan. See "[Authenticating with GitHub Apps](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/)" for details. For an example response, see 'Response with GitHub plan information' below." */ - "orgs/get": { + 'orgs/get': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["organization-full"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['organization-full'] + } + } + 404: components['responses']['not_found'] + } + } /** * **Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). * * Enables an authenticated organization owner with the `admin:org` scope to update the organization's profile and member privileges. */ - "orgs/update": { + 'orgs/update': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["organization-full"]; - }; - }; - 409: components["responses"]["conflict"]; + 'application/json': components['schemas']['organization-full'] + } + } + 409: components['responses']['conflict'] /** Validation failed */ 422: { content: { - "application/json": - | components["schemas"]["validation-error"] - | components["schemas"]["validation-error-simple"]; - }; - }; - }; + 'application/json': components['schemas']['validation-error'] | components['schemas']['validation-error-simple'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Billing email address. This address is not publicized. */ - billing_email?: string; + billing_email?: string /** @description The company name. */ - company?: string; + company?: string /** @description The publicly visible email address. */ - email?: string; + email?: string /** @description The Twitter username of the company. */ - twitter_username?: string; + twitter_username?: string /** @description The location. */ - location?: string; + location?: string /** @description The shorthand name of the company. */ - name?: string; + name?: string /** @description The description of the company. */ - description?: string; + description?: string /** @description Toggles whether an organization can use organization projects. */ - has_organization_projects?: boolean; + has_organization_projects?: boolean /** @description Toggles whether repositories that belong to the organization can use repository projects. */ - has_repository_projects?: boolean; + has_repository_projects?: boolean /** * @description Default permission level members have for organization repositories: * \* `read` - can pull, but not push to or administer this repository. @@ -21104,7 +21090,7 @@ export type operations = { * @default read * @enum {string} */ - default_repository_permission?: "read" | "write" | "admin" | "none"; + default_repository_permission?: 'read' | 'write' | 'admin' | 'none' /** * @description Toggles the ability of non-admin organization members to create repositories. Can be one of: * \* `true` - all organization members can create repositories. @@ -21113,28 +21099,28 @@ export type operations = { * **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. * @default true */ - members_can_create_repositories?: boolean; + members_can_create_repositories?: boolean /** * @description Toggles whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. Can be one of: * \* `true` - all organization members can create internal repositories. * \* `false` - only organization owners can create internal repositories. * Default: `true`. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */ - members_can_create_internal_repositories?: boolean; + members_can_create_internal_repositories?: boolean /** * @description Toggles whether organization members can create private repositories, which are visible to organization members with permission. Can be one of: * \* `true` - all organization members can create private repositories. * \* `false` - only organization owners can create private repositories. * Default: `true`. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */ - members_can_create_private_repositories?: boolean; + members_can_create_private_repositories?: boolean /** * @description Toggles whether organization members can create public repositories, which are visible to anyone. Can be one of: * \* `true` - all organization members can create public repositories. * \* `false` - only organization owners can create public repositories. * Default: `true`. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */ - members_can_create_public_repositories?: boolean; + members_can_create_public_repositories?: boolean /** * @description Specifies which types of repositories non-admin organization members can create. Can be one of: * \* `all` - all organization members can create public and private repositories. @@ -21143,60 +21129,60 @@ export type operations = { * **Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details. * @enum {string} */ - members_allowed_repository_creation_type?: "all" | "private" | "none"; + members_allowed_repository_creation_type?: 'all' | 'private' | 'none' /** * @description Toggles whether organization members can create GitHub Pages sites. Can be one of: * \* `true` - all organization members can create GitHub Pages sites. * \* `false` - no organization members can create GitHub Pages sites. Existing published sites will not be impacted. * @default true */ - members_can_create_pages?: boolean; + members_can_create_pages?: boolean /** * @description Toggles whether organization members can create public GitHub Pages sites. Can be one of: * \* `true` - all organization members can create public GitHub Pages sites. * \* `false` - no organization members can create public GitHub Pages sites. Existing published sites will not be impacted. * @default true */ - members_can_create_public_pages?: boolean; + members_can_create_public_pages?: boolean /** * @description Toggles whether organization members can create private GitHub Pages sites. Can be one of: * \* `true` - all organization members can create private GitHub Pages sites. * \* `false` - no organization members can create private GitHub Pages sites. Existing published sites will not be impacted. * @default true */ - members_can_create_private_pages?: boolean; + members_can_create_private_pages?: boolean /** * @description Toggles whether organization members can fork private organization repositories. Can be one of: * \* `true` - all organization members can fork private repositories within the organization. * \* `false` - no organization members can fork private repositories within the organization. */ - members_can_fork_private_repositories?: boolean; + members_can_fork_private_repositories?: boolean /** @example "http://github.blog" */ - blog?: string; - }; - }; - }; - }; + blog?: string + } + } + } + } /** * Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - "actions/get-github-actions-permissions-organization": { + 'actions/get-github-actions-permissions-organization': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-organization-permissions"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-organization-permissions'] + } + } + } + } /** * Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization. * @@ -21204,132 +21190,132 @@ export type operations = { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - "actions/set-github-actions-permissions-organization": { + 'actions/set-github-actions-permissions-organization': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { - enabled_repositories: components["schemas"]["enabled-repositories"]; - allowed_actions?: components["schemas"]["allowed-actions"]; - }; - }; - }; - }; + 'application/json': { + enabled_repositories: components['schemas']['enabled-repositories'] + allowed_actions?: components['schemas']['allowed-actions'] + } + } + } + } /** * Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - "actions/list-selected-repositories-enabled-github-actions-organization": { + 'actions/list-selected-repositories-enabled-github-actions-organization': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - repositories: components["schemas"]["repository"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + repositories: components['schemas']['repository'][] + } + } + } + } + } /** * Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - "actions/set-selected-repositories-enabled-github-actions-organization": { + 'actions/set-selected-repositories-enabled-github-actions-organization': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description List of repository IDs to enable for GitHub Actions. */ - selected_repository_ids: number[]; - }; - }; - }; - }; + selected_repository_ids: number[] + } + } + } + } /** * Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - "actions/enable-selected-repository-github-actions-organization": { + 'actions/enable-selected-repository-github-actions-organization': { parameters: { path: { - org: components["parameters"]["org"]; - repository_id: components["parameters"]["repository-id"]; - }; - }; + org: components['parameters']['org'] + repository_id: components['parameters']['repository-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - "actions/disable-selected-repository-github-actions-organization": { + 'actions/disable-selected-repository-github-actions-organization': { parameters: { path: { - org: components["parameters"]["org"]; - repository_id: components["parameters"]["repository-id"]; - }; - }; + org: components['parameters']['org'] + repository_id: components['parameters']['repository-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."" * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - "actions/get-allowed-actions-organization": { + 'actions/get-allowed-actions-organization': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["selected-actions"]; - }; - }; - }; - }; + 'application/json': components['schemas']['selected-actions'] + } + } + } + } /** * Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * @@ -21339,65 +21325,65 @@ export type operations = { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - "actions/set-allowed-actions-organization": { + 'actions/set-allowed-actions-organization': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": components["schemas"]["selected-actions"]; - }; - }; - }; + 'application/json': components['schemas']['selected-actions'] + } + } + } /** * Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, * as well if GitHub Actions can submit approving pull request reviews. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - "actions/get-github-actions-default-workflow-permissions-organization": { + 'actions/get-github-actions-default-workflow-permissions-organization': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-get-default-workflow-permissions"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-get-default-workflow-permissions'] + } + } + } + } /** * Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions * can submit approving pull request reviews. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - "actions/set-github-actions-default-workflow-permissions-organization": { + 'actions/set-github-actions-default-workflow-permissions-organization': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": components["schemas"]["actions-set-default-workflow-permissions"]; - }; - }; - }; + 'application/json': components['schemas']['actions-set-default-workflow-permissions'] + } + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21405,30 +21391,30 @@ export type operations = { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/list-self-hosted-runner-groups-for-org": { + 'actions/list-self-hosted-runner-groups-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - runner_groups: components["schemas"]["runner-groups-org"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + runner_groups: components['schemas']['runner-groups-org'][] + } + } + } + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21436,41 +21422,41 @@ export type operations = { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/create-self-hosted-runner-group-for-org": { + 'actions/create-self-hosted-runner-group-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["runner-groups-org"]; - }; - }; - }; + 'application/json': components['schemas']['runner-groups-org'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Name of the runner group. */ - name: string; + name: string /** * @description Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories. Can be one of: `all`, `selected`, or `private`. * @default all * @enum {string} */ - visibility?: "selected" | "all" | "private"; + visibility?: 'selected' | 'all' | 'private' /** @description List of repository IDs that can access the runner group. */ - selected_repository_ids?: number[]; + selected_repository_ids?: number[] /** @description List of runner IDs to add to the runner group. */ - runners?: number[]; + runners?: number[] /** @description Whether the runner group can be used by `public` repositories. */ - allows_public_repositories?: boolean; - }; - }; - }; - }; + allows_public_repositories?: boolean + } + } + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21478,23 +21464,23 @@ export type operations = { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/get-self-hosted-runner-group-for-org": { + 'actions/get-self-hosted-runner-group-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["runner-groups-org"]; - }; - }; - }; - }; + 'application/json': components['schemas']['runner-groups-org'] + } + } + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21502,19 +21488,19 @@ export type operations = { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/delete-self-hosted-runner-group-from-org": { + 'actions/delete-self-hosted-runner-group-from-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21522,38 +21508,38 @@ export type operations = { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/update-self-hosted-runner-group-for-org": { + 'actions/update-self-hosted-runner-group-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["runner-groups-org"]; - }; - }; - }; + 'application/json': components['schemas']['runner-groups-org'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Name of the runner group. */ - name: string; + name: string /** * @description Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories. Can be one of: `all`, `selected`, or `private`. * @enum {string} */ - visibility?: "selected" | "all" | "private"; + visibility?: 'selected' | 'all' | 'private' /** @description Whether the runner group can be used by `public` repositories. */ - allows_public_repositories?: boolean; - }; - }; - }; - }; + allows_public_repositories?: boolean + } + } + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21561,32 +21547,32 @@ export type operations = { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/list-repo-access-to-self-hosted-runner-group-in-org": { + 'actions/list-repo-access-to-self-hosted-runner-group-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; + runner_group_id: components['parameters']['runner-group-id'] + } query: { /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - repositories: components["schemas"]["minimal-repository"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + repositories: components['schemas']['minimal-repository'][] + } + } + } + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21594,27 +21580,27 @@ export type operations = { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/set-repo-access-to-self-hosted-runner-group-in-org": { + 'actions/set-repo-access-to-self-hosted-runner-group-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description List of repository IDs that can access the runner group. */ - selected_repository_ids: number[]; - }; - }; - }; - }; + selected_repository_ids: number[] + } + } + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21624,20 +21610,20 @@ export type operations = { * You must authenticate using an access token with the `admin:org` * scope to use this endpoint. */ - "actions/add-repo-access-to-self-hosted-runner-group-in-org": { + 'actions/add-repo-access-to-self-hosted-runner-group-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - repository_id: components["parameters"]["repository-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + repository_id: components['parameters']['repository-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21646,20 +21632,20 @@ export type operations = { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/remove-repo-access-to-self-hosted-runner-group-in-org": { + 'actions/remove-repo-access-to-self-hosted-runner-group-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - repository_id: components["parameters"]["repository-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + repository_id: components['parameters']['repository-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21667,33 +21653,33 @@ export type operations = { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/list-self-hosted-runners-in-group-for-org": { + 'actions/list-self-hosted-runners-in-group-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; + runner_group_id: components['parameters']['runner-group-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - runners: components["schemas"]["runner"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + runners: components['schemas']['runner'][] + } + } + } + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21701,27 +21687,27 @@ export type operations = { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/set-self-hosted-runners-in-group-for-org": { + 'actions/set-self-hosted-runners-in-group-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description List of runner IDs to add to the runner group. */ - runners: number[]; - }; - }; - }; - }; + runners: number[] + } + } + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21731,21 +21717,21 @@ export type operations = { * You must authenticate using an access token with the `admin:org` * scope to use this endpoint. */ - "actions/add-self-hosted-runner-to-group-for-org": { + 'actions/add-self-hosted-runner-to-group-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components['parameters']['runner-group-id'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21754,71 +21740,71 @@ export type operations = { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/remove-self-hosted-runner-from-group-for-org": { + 'actions/remove-self-hosted-runner-from-group-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components['parameters']['runner-group-id'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Lists all self-hosted runners configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/list-self-hosted-runners-for-org": { + 'actions/list-self-hosted-runners-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - runners: components["schemas"]["runner"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + runners: components['schemas']['runner'][] + } + } + } + } + } /** * Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/list-runner-applications-for-org": { + 'actions/list-runner-applications-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["runner-application"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['runner-application'][] + } + } + } + } /** * Returns a token that you can pass to the `config` script. The token expires after one hour. * @@ -21832,21 +21818,21 @@ export type operations = { * ./config.sh --url https://github.com/octo-org --token TOKEN * ``` */ - "actions/create-registration-token-for-org": { + 'actions/create-registration-token-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["authentication-token"]; - }; - }; - }; - }; + 'application/json': components['schemas']['authentication-token'] + } + } + } + } /** * Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour. * @@ -21861,153 +21847,153 @@ export type operations = { * ./config.sh remove --token TOKEN * ``` */ - "actions/create-remove-token-for-org": { + 'actions/create-remove-token-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["authentication-token"]; - }; - }; - }; - }; + 'application/json': components['schemas']['authentication-token'] + } + } + } + } /** * Gets a specific self-hosted runner configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/get-self-hosted-runner-for-org": { + 'actions/get-self-hosted-runner-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["runner"]; - }; - }; - }; - }; + 'application/json': components['schemas']['runner'] + } + } + } + } /** * Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/delete-self-hosted-runner-from-org": { + 'actions/delete-self-hosted-runner-from-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Lists all labels for a self-hosted runner configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/list-labels-for-self-hosted-runner-for-org": { + 'actions/list-labels-for-self-hosted-runner-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - }; - }; + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + } + } /** * Remove all previous custom labels and set the new custom labels for a specific * self-hosted runner configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/set-custom-labels-for-self-hosted-runner-for-org": { + 'actions/set-custom-labels-for-self-hosted-runner-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; - responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + runner_id: components['parameters']['runner-id'] + } + } + responses: { + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels. */ - labels: string[]; - }; - }; - }; - }; + labels: string[] + } + } + } + } /** * Add custom labels to a self-hosted runner configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/add-custom-labels-to-self-hosted-runner-for-org": { + 'actions/add-custom-labels-to-self-hosted-runner-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; - responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + runner_id: components['parameters']['runner-id'] + } + } + responses: { + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The names of the custom labels to add to the runner. */ - labels: string[]; - }; - }; - }; - }; + labels: string[] + } + } + } + } /** * Remove all custom labels from a self-hosted runner configured in an * organization. Returns the remaining read-only labels from the runner. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/remove-all-custom-labels-from-self-hosted-runner-for-org": { + 'actions/remove-all-custom-labels-from-self-hosted-runner-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { - 200: components["responses"]["actions_runner_labels_readonly"]; - 404: components["responses"]["not_found"]; - }; - }; + 200: components['responses']['actions_runner_labels_readonly'] + 404: components['responses']['not_found'] + } + } /** * Remove a custom label from a self-hosted runner configured * in an organization. Returns the remaining labels from the runner. @@ -22017,82 +22003,82 @@ export type operations = { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/remove-custom-label-from-self-hosted-runner-for-org": { + 'actions/remove-custom-label-from-self-hosted-runner-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; + runner_id: components['parameters']['runner-id'] /** The name of a self-hosted runner's custom label. */ - name: components["parameters"]["runner-label-name"]; - }; - }; - responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; - }; + name: components['parameters']['runner-label-name'] + } + } + responses: { + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } + } /** Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - "actions/list-org-secrets": { + 'actions/list-org-secrets': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - secrets: components["schemas"]["organization-actions-secret"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + secrets: components['schemas']['organization-actions-secret'][] + } + } + } + } + } /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - "actions/get-org-public-key": { + 'actions/get-org-public-key': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-public-key"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-public-key'] + } + } + } + } /** Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - "actions/get-org-secret": { + 'actions/get-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["organization-actions-secret"]; - }; - }; - }; - }; + 'application/json': components['schemas']['organization-actions-secret'] + } + } + } + } /** * Creates or updates an organization secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -22170,31 +22156,31 @@ export type operations = { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - "actions/create-or-update-org-secret": { + 'actions/create-or-update-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response when creating a secret */ 201: { content: { - "application/json": components["schemas"]["empty-object"]; - }; - }; + 'application/json': components['schemas']['empty-object'] + } + } /** Response when updating a secret */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/reference/actions#get-an-organization-public-key) endpoint. */ - encrypted_value?: string; + encrypted_value?: string /** @description ID of the key you used to encrypt the secret. */ - key_id?: string; + key_id?: string /** * @description Configures the access that repositories have to the organization secret. Can be one of: * \- `all` - All repositories in an organization can access the secret. @@ -22202,123 +22188,123 @@ export type operations = { * \- `selected` - Only specific repositories can access the secret. * @enum {string} */ - visibility: "all" | "private" | "selected"; + visibility: 'all' | 'private' | 'selected' /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/reference/actions#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/actions#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints. */ - selected_repository_ids?: string[]; - }; - }; - }; - }; + selected_repository_ids?: string[] + } + } + } + } /** Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - "actions/delete-org-secret": { + 'actions/delete-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - "actions/list-selected-repos-for-org-secret": { + 'actions/list-selected-repos-for-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; + secret_name: components['parameters']['secret-name'] + } query: { /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - repositories: components["schemas"]["minimal-repository"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + repositories: components['schemas']['minimal-repository'][] + } + } + } + } + } /** Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - "actions/set-selected-repos-for-org-secret": { + 'actions/set-selected-repos-for-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/actions#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints. */ - selected_repository_ids: number[]; - }; - }; - }; - }; + selected_repository_ids: number[] + } + } + } + } /** Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - "actions/add-selected-repo-to-org-secret": { + 'actions/add-selected-repo-to-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - repository_id: number; - }; - }; + secret_name: components['parameters']['secret-name'] + repository_id: number + } + } responses: { /** No Content when repository was added to the selected list */ - 204: never; + 204: never /** Conflict when visibility type is not set to selected */ - 409: unknown; - }; - }; + 409: unknown + } + } /** Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - "actions/remove-selected-repo-from-org-secret": { + 'actions/remove-selected-repo-from-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - repository_id: number; - }; - }; + secret_name: components['parameters']['secret-name'] + repository_id: number + } + } responses: { /** Response when repository was removed from the selected list */ - 204: never; + 204: never /** Conflict when visibility type not set to selected */ - 409: unknown; - }; - }; + 409: unknown + } + } /** * Gets the audit log for an organization. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization)." * * This endpoint is available for organizations on GitHub Enterprise Cloud. To use this endpoint, you must be an organization owner, and you must use an access token with the `admin:org` scope. GitHub Apps must have the `organization_administration` read permission to use this endpoint. */ - "orgs/get-audit-log": { + 'orgs/get-audit-log': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** A search phrase. For more information, see [Searching the audit log](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). */ - phrase?: components["parameters"]["audit-log-phrase"]; + phrase?: components['parameters']['audit-log-phrase'] /** * The event types to include: * @@ -22328,90 +22314,90 @@ export type operations = { * * The default is `web`. */ - include?: components["parameters"]["audit-log-include"]; + include?: components['parameters']['audit-log-include'] /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor. */ - after?: components["parameters"]["audit-log-after"]; + after?: components['parameters']['audit-log-after'] /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor. */ - before?: components["parameters"]["audit-log-before"]; + before?: components['parameters']['audit-log-before'] /** * The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. * * The default is `desc`. */ - order?: components["parameters"]["audit-log-order"]; + order?: components['parameters']['audit-log-order'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["audit-log-event"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['audit-log-event'][] + } + } + } + } /** List the users blocked by an organization. */ - "orgs/list-blocked-users": { + 'orgs/list-blocked-users': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 415: components["responses"]["preview_header_missing"]; - }; - }; - "orgs/check-blocked-user": { + 'application/json': components['schemas']['simple-user'][] + } + } + 415: components['responses']['preview_header_missing'] + } + } + 'orgs/check-blocked-user': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** If the user is blocked: */ - 204: never; + 204: never /** If the user is not blocked: */ 404: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - }; - }; - "orgs/block-user": { + 'application/json': components['schemas']['basic-error'] + } + } + } + } + 'orgs/block-user': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 422: components["responses"]["validation_failed"]; - }; - }; - "orgs/unblock-user": { + 204: never + 422: components['responses']['validation_failed'] + } + } + 'orgs/unblock-user': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Lists all code scanning alerts for the default branch (usually `main` * or `master`) for all eligible repositories in an organization. @@ -22419,147 +22405,147 @@ export type operations = { * * GitHub Apps must have the `security_events` read permission to use this endpoint. */ - "code-scanning/list-alerts-for-org": { + 'code-scanning/list-alerts-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor. */ - before?: components["parameters"]["pagination-before"]; + before?: components['parameters']['pagination-before'] /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor. */ - after?: components["parameters"]["pagination-after"]; + after?: components['parameters']['pagination-after'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Set to `open`, `closed, `fixed`, or `dismissed` to list code scanning alerts in a specific state. */ - state?: components["schemas"]["code-scanning-alert-state"]; + state?: components['schemas']['code-scanning-alert-state'] /** Can be one of `created`, `updated`. */ - sort?: "created" | "updated"; - }; - }; + sort?: 'created' | 'updated' + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["code-scanning-organization-alert-items"][]; - }; - }; - 403: components["responses"]["code_scanning_forbidden_read"]; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': components['schemas']['code-scanning-organization-alert-items'][] + } + } + 403: components['responses']['code_scanning_forbidden_read'] + 404: components['responses']['not_found'] + 503: components['responses']['service_unavailable'] + } + } /** * Listing and deleting credential authorizations is available to organizations with GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products). * * An authenticated organization owner with the `read:org` scope can list all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials are either personal access tokens or SSH keys that organization members have authorized for the organization. For more information, see [About authentication with SAML single sign-on](https://docs.github.com/en/articles/about-authentication-with-saml-single-sign-on). */ - "orgs/list-saml-sso-authorizations": { + 'orgs/list-saml-sso-authorizations': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page token */ - page?: number; + page?: number /** Limits the list of credentials authorizations for an organization to a specific login */ - login?: string; - }; - }; + login?: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["credential-authorization"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['credential-authorization'][] + } + } + } + } /** * Listing and deleting credential authorizations is available to organizations with GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products). * * An authenticated organization owner with the `admin:org` scope can remove a credential authorization for an organization that uses SAML SSO. Once you remove someone's credential authorization, they will need to create a new personal access token or SSH key and authorize it for the organization they want to access. */ - "orgs/remove-saml-sso-authorization": { + 'orgs/remove-saml-sso-authorization': { parameters: { path: { - org: components["parameters"]["org"]; - credential_id: number; - }; - }; + org: components['parameters']['org'] + credential_id: number + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - "dependabot/list-org-secrets": { + 'dependabot/list-org-secrets': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - secrets: components["schemas"]["organization-dependabot-secret"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + secrets: components['schemas']['organization-dependabot-secret'][] + } + } + } + } + } /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - "dependabot/get-org-public-key": { + 'dependabot/get-org-public-key': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["dependabot-public-key"]; - }; - }; - }; - }; + 'application/json': components['schemas']['dependabot-public-key'] + } + } + } + } /** Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - "dependabot/get-org-secret": { + 'dependabot/get-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["organization-dependabot-secret"]; - }; - }; - }; - }; + 'application/json': components['schemas']['organization-dependabot-secret'] + } + } + } + } /** * Creates or updates an organization secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -22637,31 +22623,31 @@ export type operations = { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - "dependabot/create-or-update-org-secret": { + 'dependabot/create-or-update-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response when creating a secret */ 201: { content: { - "application/json": components["schemas"]["empty-object"]; - }; - }; + 'application/json': components['schemas']['empty-object'] + } + } /** Response when updating a secret */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/reference/dependabot#get-an-organization-public-key) endpoint. */ - encrypted_value?: string; + encrypted_value?: string /** @description ID of the key you used to encrypt the secret. */ - key_id?: string; + key_id?: string /** * @description Configures the access that repositories have to the organization secret. Can be one of: * \- `all` - All repositories in an organization can access the secret. @@ -22669,631 +22655,630 @@ export type operations = { * \- `selected` - Only specific repositories can access the secret. * @enum {string} */ - visibility: "all" | "private" | "selected"; + visibility: 'all' | 'private' | 'selected' /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/reference/dependabot#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/dependabot#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/dependabot#remove-selected-repository-from-an-organization-secret) endpoints. */ - selected_repository_ids?: string[]; - }; - }; - }; - }; + selected_repository_ids?: string[] + } + } + } + } /** Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - "dependabot/delete-org-secret": { + 'dependabot/delete-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - "dependabot/list-selected-repos-for-org-secret": { + 'dependabot/list-selected-repos-for-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; + secret_name: components['parameters']['secret-name'] + } query: { /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - repositories: components["schemas"]["minimal-repository"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + repositories: components['schemas']['minimal-repository'][] + } + } + } + } + } /** Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - "dependabot/set-selected-repos-for-org-secret": { + 'dependabot/set-selected-repos-for-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/dependabot#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/dependabot#remove-selected-repository-from-an-organization-secret) endpoints. */ - selected_repository_ids: number[]; - }; - }; - }; - }; + selected_repository_ids: number[] + } + } + } + } /** Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - "dependabot/add-selected-repo-to-org-secret": { + 'dependabot/add-selected-repo-to-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - repository_id: number; - }; - }; + secret_name: components['parameters']['secret-name'] + repository_id: number + } + } responses: { /** No Content when repository was added to the selected list */ - 204: never; + 204: never /** Conflict when visibility type is not set to selected */ - 409: unknown; - }; - }; + 409: unknown + } + } /** Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - "dependabot/remove-selected-repo-from-org-secret": { + 'dependabot/remove-selected-repo-from-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - repository_id: number; - }; - }; + secret_name: components['parameters']['secret-name'] + repository_id: number + } + } responses: { /** Response when repository was removed from the selected list */ - 204: never; + 204: never /** Conflict when visibility type not set to selected */ - 409: unknown; - }; - }; - "activity/list-public-org-events": { + 409: unknown + } + } + 'activity/list-public-org-events': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["event"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['event'][] + } + } + } + } /** * Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to. * * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ - "teams/external-idp-group-info-for-org": { + 'teams/external-idp-group-info-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** group_id parameter */ - group_id: components["parameters"]["group-id"]; - }; - }; + group_id: components['parameters']['group-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["external-group"]; - }; - }; - }; - }; + 'application/json': components['schemas']['external-group'] + } + } + } + } /** * Lists external groups available in an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." * * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ - "teams/list-external-idp-groups-for-org": { + 'teams/list-external-idp-groups-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page token */ - page?: number; + page?: number /** Limits the list to groups containing the text in the group name */ - display_name?: string; - }; - }; + display_name?: string + } + } responses: { /** Response */ 200: { headers: { - Link?: string; - }; - content: { - "application/json": components["schemas"]["external-groups"]; - }; - }; - }; - }; + Link?: string + } + content: { + 'application/json': components['schemas']['external-groups'] + } + } + } + } /** The return hash contains `failed_at` and `failed_reason` fields which represent the time at which the invitation failed and the reason for the failure. */ - "orgs/list-failed-invitations": { + 'orgs/list-failed-invitations': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["organization-invitation"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "orgs/list-webhooks": { + 'application/json': components['schemas']['organization-invitation'][] + } + } + 404: components['responses']['not_found'] + } + } + 'orgs/list-webhooks': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["org-hook"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['org-hook'][] + } + } + 404: components['responses']['not_found'] + } + } /** Here's how you can create a hook that posts payloads in JSON format: */ - "orgs/create-webhook": { + 'orgs/create-webhook': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["org-hook"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['org-hook'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Must be passed as "web". */ - name: string; + name: string /** @description Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/orgs#create-hook-config-params). */ config: { - url: components["schemas"]["webhook-config-url"]; - content_type?: components["schemas"]["webhook-config-content-type"]; - secret?: components["schemas"]["webhook-config-secret"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + url: components['schemas']['webhook-config-url'] + content_type?: components['schemas']['webhook-config-content-type'] + secret?: components['schemas']['webhook-config-secret'] + insecure_ssl?: components['schemas']['webhook-config-insecure-ssl'] /** @example "kdaigle" */ - username?: string; + username?: string /** @example "password" */ - password?: string; - }; + password?: string + } /** * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. * @default push */ - events?: string[]; + events?: string[] /** * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. * @default true */ - active?: boolean; - }; - }; - }; - }; + active?: boolean + } + } + } + } /** Returns a webhook configured in an organization. To get only the webhook `config` properties, see "[Get a webhook configuration for an organization](/rest/reference/orgs#get-a-webhook-configuration-for-an-organization)." */ - "orgs/get-webhook": { + 'orgs/get-webhook': { parameters: { path: { - org: components["parameters"]["org"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + org: components['parameters']['org'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["org-hook"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "orgs/delete-webhook": { + 'application/json': components['schemas']['org-hook'] + } + } + 404: components['responses']['not_found'] + } + } + 'orgs/delete-webhook': { parameters: { path: { - org: components["parameters"]["org"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + org: components['parameters']['org'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for an organization](/rest/reference/orgs#update-a-webhook-configuration-for-an-organization)." */ - "orgs/update-webhook": { + 'orgs/update-webhook': { parameters: { path: { - org: components["parameters"]["org"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + org: components['parameters']['org'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["org-hook"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['org-hook'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/orgs#update-hook-config-params). */ config?: { - url: components["schemas"]["webhook-config-url"]; - content_type?: components["schemas"]["webhook-config-content-type"]; - secret?: components["schemas"]["webhook-config-secret"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - }; + url: components['schemas']['webhook-config-url'] + content_type?: components['schemas']['webhook-config-content-type'] + secret?: components['schemas']['webhook-config-secret'] + insecure_ssl?: components['schemas']['webhook-config-insecure-ssl'] + } /** * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. * @default push */ - events?: string[]; + events?: string[] /** * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. * @default true */ - active?: boolean; + active?: boolean /** @example "web" */ - name?: string; - }; - }; - }; - }; + name?: string + } + } + } + } /** * Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/reference/orgs#get-an-organization-webhook)." * * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission. */ - "orgs/get-webhook-config-for-org": { + 'orgs/get-webhook-config-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + org: components['parameters']['org'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["webhook-config"]; - }; - }; - }; - }; + 'application/json': components['schemas']['webhook-config'] + } + } + } + } /** * Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/reference/orgs#update-an-organization-webhook)." * * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission. */ - "orgs/update-webhook-config-for-org": { + 'orgs/update-webhook-config-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + org: components['parameters']['org'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["webhook-config"]; - }; - }; - }; + 'application/json': components['schemas']['webhook-config'] + } + } + } requestBody: { content: { - "application/json": { - url?: components["schemas"]["webhook-config-url"]; - content_type?: components["schemas"]["webhook-config-content-type"]; - secret?: components["schemas"]["webhook-config-secret"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - }; - }; - }; - }; + 'application/json': { + url?: components['schemas']['webhook-config-url'] + content_type?: components['schemas']['webhook-config-content-type'] + secret?: components['schemas']['webhook-config-secret'] + insecure_ssl?: components['schemas']['webhook-config-insecure-ssl'] + } + } + } + } /** Returns a list of webhook deliveries for a webhook configured in an organization. */ - "orgs/list-webhook-deliveries": { + 'orgs/list-webhook-deliveries': { parameters: { path: { - org: components["parameters"]["org"]; - hook_id: components["parameters"]["hook-id"]; - }; + org: components['parameters']['org'] + hook_id: components['parameters']['hook-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ - cursor?: components["parameters"]["cursor"]; - }; - }; + cursor?: components['parameters']['cursor'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["hook-delivery-item"][]; - }; - }; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['hook-delivery-item'][] + } + } + 400: components['responses']['bad_request'] + 422: components['responses']['validation_failed'] + } + } /** Returns a delivery for a webhook configured in an organization. */ - "orgs/get-webhook-delivery": { + 'orgs/get-webhook-delivery': { parameters: { path: { - org: components["parameters"]["org"]; - hook_id: components["parameters"]["hook-id"]; - delivery_id: components["parameters"]["delivery-id"]; - }; - }; + org: components['parameters']['org'] + hook_id: components['parameters']['hook-id'] + delivery_id: components['parameters']['delivery-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["hook-delivery"]; - }; - }; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['hook-delivery'] + } + } + 400: components['responses']['bad_request'] + 422: components['responses']['validation_failed'] + } + } /** Redeliver a delivery for a webhook configured in an organization. */ - "orgs/redeliver-webhook-delivery": { + 'orgs/redeliver-webhook-delivery': { parameters: { path: { - org: components["parameters"]["org"]; - hook_id: components["parameters"]["hook-id"]; - delivery_id: components["parameters"]["delivery-id"]; - }; - }; + org: components['parameters']['org'] + hook_id: components['parameters']['hook-id'] + delivery_id: components['parameters']['delivery-id'] + } + } responses: { - 202: components["responses"]["accepted"]; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 202: components['responses']['accepted'] + 400: components['responses']['bad_request'] + 422: components['responses']['validation_failed'] + } + } /** This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. */ - "orgs/ping-webhook": { + 'orgs/ping-webhook': { parameters: { path: { - org: components["parameters"]["org"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + org: components['parameters']['org'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** * Enables an authenticated GitHub App to find the organization's installation information. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/get-org-installation": { + 'apps/get-org-installation': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["installation"]; - }; - }; - }; - }; + 'application/json': components['schemas']['installation'] + } + } + } + } /** Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint. */ - "orgs/list-app-installations": { + 'orgs/list-app-installations': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - installations: components["schemas"]["installation"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + installations: components['schemas']['installation'][] + } + } + } + } + } /** Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response. */ - "interactions/get-restrictions-for-org": { + 'interactions/get-restrictions-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": Partial & - Partial<{ [key: string]: unknown }>; - }; - }; - }; - }; + 'application/json': Partial & Partial<{ [key: string]: unknown }> + } + } + } + } /** Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization. */ - "interactions/set-restrictions-for-org": { + 'interactions/set-restrictions-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["interaction-limit-response"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['interaction-limit-response'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": components["schemas"]["interaction-limit"]; - }; - }; - }; + 'application/json': components['schemas']['interaction-limit'] + } + } + } /** Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions. */ - "interactions/remove-restrictions-for-org": { + 'interactions/remove-restrictions-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. */ - "orgs/list-pending-invitations": { + 'orgs/list-pending-invitations': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["organization-invitation"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['organization-invitation'][] + } + } + 404: components['responses']['not_found'] + } + } /** * Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - "orgs/create-invitation": { + 'orgs/create-invitation': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["organization-invitation"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['organization-invitation'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description **Required unless you provide `email`**. GitHub user ID for the person you are inviting. */ - invitee_id?: number; + invitee_id?: number /** @description **Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user. */ - email?: string; + email?: string /** * @description Specify role for new member. Can be one of: * \* `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. @@ -23302,59 +23287,59 @@ export type operations = { * @default direct_member * @enum {string} */ - role?: "admin" | "direct_member" | "billing_manager"; + role?: 'admin' | 'direct_member' | 'billing_manager' /** @description Specify IDs for the teams you want to invite new members to. */ - team_ids?: number[]; - }; - }; - }; - }; + team_ids?: number[] + } + } + } + } /** * Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). */ - "orgs/cancel-invitation": { + 'orgs/cancel-invitation': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** invitation_id parameter */ - invitation_id: components["parameters"]["invitation-id"]; - }; - }; + invitation_id: components['parameters']['invitation-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner. */ - "orgs/list-invitation-teams": { + 'orgs/list-invitation-teams': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** invitation_id parameter */ - invitation_id: components["parameters"]["invitation-id"]; - }; + invitation_id: components['parameters']['invitation-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['team'][] + } + } + 404: components['responses']['not_found'] + } + } /** * List issues in an organization assigned to the authenticated user. * @@ -23363,11 +23348,11 @@ export type operations = { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - "issues/list-for-org": { + 'issues/list-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** * Indicates which sorts of issues to return. Can be one of: @@ -23377,123 +23362,123 @@ export type operations = { * \* `subscribed`: Issues you're subscribed to updates for * \* `all` or `repos`: All issues the authenticated user can see, regardless of participation or creation */ - filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all"; + filter?: 'assigned' | 'created' | 'mentioned' | 'subscribed' | 'repos' | 'all' /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ - state?: "open" | "closed" | "all"; + state?: 'open' | 'closed' | 'all' /** A list of comma separated label names. Example: `bug,ui,@high` */ - labels?: components["parameters"]["labels"]; + labels?: components['parameters']['labels'] /** What to sort results by. Can be either `created`, `updated`, `comments`. */ - sort?: "created" | "updated" | "comments"; + sort?: 'created' | 'updated' | 'comments' /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["issue"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['issue'][] + } + } + 404: components['responses']['not_found'] + } + } /** List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned. */ - "orgs/list-members": { + 'orgs/list-members': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** * Filter members returned in the list. Can be one of: * \* `2fa_disabled` - Members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. Available for organization owners. * \* `all` - All members the authenticated user can see. */ - filter?: "2fa_disabled" | "all"; + filter?: '2fa_disabled' | 'all' /** * Filter members returned by their role. Can be one of: * \* `all` - All members of the organization, regardless of role. * \* `admin` - Organization owners. * \* `member` - Non-owner organization members. */ - role?: "all" | "admin" | "member"; + role?: 'all' | 'admin' | 'member' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; + 'application/json': components['schemas']['simple-user'][] + } + } /** Response if requester is not an organization member */ - 302: never; - 422: components["responses"]["validation_failed"]; - }; - }; + 302: never + 422: components['responses']['validation_failed'] + } + } /** Check if a user is, publicly or privately, a member of the organization. */ - "orgs/check-membership-for-user": { + 'orgs/check-membership-for-user': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** Response if requester is an organization member and user is a member */ - 204: never; + 204: never /** Response if requester is not an organization member */ - 302: never; + 302: never /** Not Found if requester is an organization member and user is not a member */ - 404: unknown; - }; - }; + 404: unknown + } + } /** Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories. */ - "orgs/remove-member": { + 'orgs/remove-member': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 403: components["responses"]["forbidden"]; - }; - }; + 204: never + 403: components['responses']['forbidden'] + } + } /** In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status. */ - "orgs/get-membership-for-user": { + 'orgs/get-membership-for-user': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["org-membership"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['org-membership'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Only authenticated organization owners can add a member to the organization or update the member's role. * @@ -23505,26 +23490,26 @@ export type operations = { * * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. */ - "orgs/set-membership-for-user": { + 'orgs/set-membership-for-user': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["org-membership"]; - }; - }; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['org-membership'] + } + } + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The role to give the user in the organization. Can be one of: * \* `admin` - The user will become an owner of the organization. @@ -23532,102 +23517,102 @@ export type operations = { * @default member * @enum {string} */ - role?: "admin" | "member"; - }; - }; - }; - }; + role?: 'admin' | 'member' + } + } + } + } /** * In order to remove a user's membership with an organization, the authenticated user must be an organization owner. * * If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases. */ - "orgs/remove-membership-for-user": { + 'orgs/remove-membership-for-user': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Lists the most recent migrations. */ - "migrations/list-for-org": { + 'migrations/list-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Exclude attributes from the API response to improve performance */ - exclude?: "repositories"[]; - }; - }; + exclude?: 'repositories'[] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["migration"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['migration'][] + } + } + } + } /** Initiates the generation of a migration archive. */ - "migrations/start-for-org": { + 'migrations/start-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["migration"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['migration'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description A list of arrays indicating which repositories should be migrated. */ - repositories: string[]; + repositories: string[] /** * @description Indicates whether repositories should be locked (to prevent manipulation) while migrating data. * @example true */ - lock_repositories?: boolean; + lock_repositories?: boolean /** * @description Indicates whether attachments should be excluded from the migration (to reduce migration archive file size). * @example true */ - exclude_attachments?: boolean; + exclude_attachments?: boolean /** * @description Indicates whether releases should be excluded from the migration (to reduce migration archive file size). * @example true */ - exclude_releases?: boolean; + exclude_releases?: boolean /** * @description Indicates whether projects owned by the organization or users should be excluded. from the migration. * @example true */ - exclude_owner_projects?: boolean; - exclude?: "repositories"[]; - }; - }; - }; - }; + exclude_owner_projects?: boolean + exclude?: 'repositories'[] + } + } + } + } /** * Fetches the status of a migration. * @@ -23638,18 +23623,18 @@ export type operations = { * * `exported`, which means the migration finished successfully. * * `failed`, which means the migration failed. */ - "migrations/get-status-for-org": { + 'migrations/get-status-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** migration_id parameter */ - migration_id: components["parameters"]["migration-id"]; - }; + migration_id: components['parameters']['migration-id'] + } query: { /** Exclude attributes from the API response to improve performance */ - exclude?: "repositories"[]; - }; - }; + exclude?: 'repositories'[] + } + } responses: { /** * * `pending`, which means the migration hasn't started yet. @@ -23659,212 +23644,212 @@ export type operations = { */ 200: { content: { - "application/json": components["schemas"]["migration"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['migration'] + } + } + 404: components['responses']['not_found'] + } + } /** Fetches the URL to a migration archive. */ - "migrations/download-archive-for-org": { + 'migrations/download-archive-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** migration_id parameter */ - migration_id: components["parameters"]["migration-id"]; - }; - }; + migration_id: components['parameters']['migration-id'] + } + } responses: { /** Response */ - 302: never; - 404: components["responses"]["not_found"]; - }; - }; + 302: never + 404: components['responses']['not_found'] + } + } /** Deletes a previous migration archive. Migration archives are automatically deleted after seven days. */ - "migrations/delete-archive-for-org": { + 'migrations/delete-archive-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** migration_id parameter */ - migration_id: components["parameters"]["migration-id"]; - }; - }; + migration_id: components['parameters']['migration-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/rest/reference/repos#delete-a-repository) when the migration is complete and you no longer need the source data. */ - "migrations/unlock-repo-for-org": { + 'migrations/unlock-repo-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** migration_id parameter */ - migration_id: components["parameters"]["migration-id"]; + migration_id: components['parameters']['migration-id'] /** repo_name parameter */ - repo_name: components["parameters"]["repo-name"]; - }; - }; + repo_name: components['parameters']['repo-name'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** List all the repositories for this organization migration. */ - "migrations/list-repos-for-org": { + 'migrations/list-repos-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** migration_id parameter */ - migration_id: components["parameters"]["migration-id"]; - }; + migration_id: components['parameters']['migration-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["minimal-repository"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['minimal-repository'][] + } + } + 404: components['responses']['not_found'] + } + } /** List all users who are outside collaborators of an organization. */ - "orgs/list-outside-collaborators": { + 'orgs/list-outside-collaborators': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** * Filter the list of outside collaborators. Can be one of: * \* `2fa_disabled`: Outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. * \* `all`: All outside collaborators. */ - filter?: "2fa_disabled" | "all"; + filter?: '2fa_disabled' | 'all' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + } + } /** When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://docs.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)". */ - "orgs/convert-member-to-outside-collaborator": { + 'orgs/convert-member-to-outside-collaborator': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** User is getting converted asynchronously */ 202: { content: { - "application/json": { [key: string]: unknown }; - }; - }; + 'application/json': { [key: string]: unknown } + } + } /** User was converted */ - 204: never; + 204: never /** Forbidden if user is the last owner of the organization or not a member of the organization */ - 403: unknown; - 404: components["responses"]["not_found"]; - }; - }; + 403: unknown + 404: components['responses']['not_found'] + } + } /** Removing a user from this list will remove them from all the organization's repositories. */ - "orgs/remove-outside-collaborator": { + 'orgs/remove-outside-collaborator': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; + 204: never /** Unprocessable Entity if user is a member of the organization */ 422: { content: { - "application/json": { - message?: string; - documentation_url?: string; - }; - }; - }; - }; - }; + 'application/json': { + message?: string + documentation_url?: string + } + } + } + } + } /** * Lists all packages in an organization readable by the user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/list-packages-for-organization": { + 'packages/list-packages-for-organization': { parameters: { query: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + package_type: 'npm' | 'maven' | 'rubygems' | 'docker' | 'nuget' | 'container' /** The selected visibility of the packages. Can be one of `public`, `private`, or `internal`. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set. */ - visibility?: components["parameters"]["package-visibility"]; - }; + visibility?: components['parameters']['package-visibility'] + } path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['package'][] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** * Gets a specific package in an organization. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/get-package-for-organization": { + 'packages/get-package-for-organization': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - org: components["parameters"]["org"]; - }; - }; + package_name: components['parameters']['package-name'] + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package"]; - }; - }; - }; - }; + 'application/json': components['schemas']['package'] + } + } + } + } /** * Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * @@ -23872,24 +23857,24 @@ export type operations = { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. */ - "packages/delete-package-for-org": { + 'packages/delete-package-for-org': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - org: components["parameters"]["org"]; - }; - }; + package_name: components['parameters']['package-name'] + org: components['parameters']['org'] + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Restores an entire package in an organization. * @@ -23901,91 +23886,91 @@ export type operations = { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. */ - "packages/restore-package-for-org": { + 'packages/restore-package-for-org': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - org: components["parameters"]["org"]; - }; + package_name: components['parameters']['package-name'] + org: components['parameters']['org'] + } query: { /** package token */ - token?: string; - }; - }; + token?: string + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Returns all package versions for a package owned by an organization. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/get-all-package-versions-for-package-owned-by-org": { + 'packages/get-all-package-versions-for-package-owned-by-org': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - org: components["parameters"]["org"]; - }; + package_name: components['parameters']['package-name'] + org: components['parameters']['org'] + } query: { /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** The state of the package, either active or deleted. */ - state?: "active" | "deleted"; - }; - }; + state?: 'active' | 'deleted' + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package-version"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['package-version'][] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Gets a specific package version in an organization. * * You must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/get-package-version-for-organization": { + 'packages/get-package-version-for-organization': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - org: components["parameters"]["org"]; + package_name: components['parameters']['package-name'] + org: components['parameters']['org'] /** Unique identifier of the package version. */ - package_version_id: components["parameters"]["package-version-id"]; - }; - }; + package_version_id: components['parameters']['package-version-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package-version"]; - }; - }; - }; - }; + 'application/json': components['schemas']['package-version'] + } + } + } + } /** * Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * @@ -23993,26 +23978,26 @@ export type operations = { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. */ - "packages/delete-package-version-for-org": { + 'packages/delete-package-version-for-org': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - org: components["parameters"]["org"]; + package_name: components['parameters']['package-name'] + org: components['parameters']['org'] /** Unique identifier of the package version. */ - package_version_id: components["parameters"]["package-version-id"]; - }; - }; + package_version_id: components['parameters']['package-version-id'] + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Restores a specific package version in an organization. * @@ -24024,179 +24009,179 @@ export type operations = { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. */ - "packages/restore-package-version-for-org": { + 'packages/restore-package-version-for-org': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - org: components["parameters"]["org"]; + package_name: components['parameters']['package-name'] + org: components['parameters']['org'] /** Unique identifier of the package version. */ - package_version_id: components["parameters"]["package-version-id"]; - }; - }; + package_version_id: components['parameters']['package-version-id'] + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - "projects/list-for-org": { + 'projects/list-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. */ - state?: "open" | "closed" | "all"; + state?: 'open' | 'closed' | 'all' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["project"][]; - }; - }; - 422: components["responses"]["validation_failed_simple"]; - }; - }; + 'application/json': components['schemas']['project'][] + } + } + 422: components['responses']['validation_failed_simple'] + } + } /** Creates an organization project board. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - "projects/create-for-org": { + 'projects/create-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["project"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': components['schemas']['project'] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the project. */ - name: string; + name: string /** @description The description of the project. */ - body?: string; - }; - }; - }; - }; + body?: string + } + } + } + } /** Members of an organization can choose to have their membership publicized or not. */ - "orgs/list-public-members": { + 'orgs/list-public-members': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - }; - }; - "orgs/check-public-membership-for-user": { + 'application/json': components['schemas']['simple-user'][] + } + } + } + } + 'orgs/check-public-membership-for-user': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** Response if user is a public member */ - 204: never; + 204: never /** Not Found if user is not a public member */ - 404: unknown; - }; - }; + 404: unknown + } + } /** * The user can publicize their own membership. (A user cannot publicize the membership for another user.) * * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - "orgs/set-public-membership-for-authenticated-user": { + 'orgs/set-public-membership-for-authenticated-user': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 403: components["responses"]["forbidden"]; - }; - }; - "orgs/remove-public-membership-for-authenticated-user": { + 204: never + 403: components['responses']['forbidden'] + } + } + 'orgs/remove-public-membership-for-authenticated-user': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** Lists repositories for the specified organization. */ - "repos/list-for-org": { + 'repos/list-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Note: For GitHub AE, can be one of `all`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`. However, the `internal` value is not yet supported when a GitHub App calls this API with an installation access token. */ - type?: "all" | "public" | "private" | "forks" | "sources" | "member" | "internal"; + type?: 'all' | 'public' | 'private' | 'forks' | 'sources' | 'member' | 'internal' /** Can be one of `created`, `updated`, `pushed`, `full_name`. */ - sort?: "created" | "updated" | "pushed" | "full_name"; + sort?: 'created' | 'updated' | 'pushed' | 'full_name' /** Can be one of `asc` or `desc`. Default: when using `full_name`: `asc`, otherwise `desc` */ - direction?: "asc" | "desc"; + direction?: 'asc' | 'desc' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["minimal-repository"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['minimal-repository'][] + } + } + } + } /** * Creates a new repository in the specified organization. The authenticated user must be a member of the organization. * @@ -24207,129 +24192,129 @@ export type operations = { * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. * * `repo` scope to create a private repository */ - "repos/create-in-org": { + 'repos/create-in-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["repository"]; - }; - }; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['repository'] + } + } + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the repository. */ - name: string; + name: string /** @description A short description of the repository. */ - description?: string; + description?: string /** @description A URL with more information about the repository. */ - homepage?: string; + homepage?: string /** @description Whether the repository is private. */ - private?: boolean; + private?: boolean /** * @description Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see "[Creating an internal repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)" in the GitHub Help documentation. * @enum {string} */ - visibility?: "public" | "private" | "internal"; + visibility?: 'public' | 'private' | 'internal' /** * @description Either `true` to enable issues for this repository or `false` to disable them. * @default true */ - has_issues?: boolean; + has_issues?: boolean /** * @description Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error. * @default true */ - has_projects?: boolean; + has_projects?: boolean /** * @description Either `true` to enable the wiki for this repository or `false` to disable it. * @default true */ - has_wiki?: boolean; + has_wiki?: boolean /** @description Either `true` to make this repo available as a template repository or `false` to prevent it. */ - is_template?: boolean; + is_template?: boolean /** @description The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. */ - team_id?: number; + team_id?: number /** @description Pass `true` to create an initial commit with empty README. */ - auto_init?: boolean; + auto_init?: boolean /** @description Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, "Haskell". */ - gitignore_template?: string; + gitignore_template?: string /** @description Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, "mit" or "mpl-2.0". */ - license_template?: string; + license_template?: string /** * @description Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge?: boolean /** * @description Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit?: boolean /** * @description Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge?: boolean /** @description Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. */ - allow_auto_merge?: boolean; + allow_auto_merge?: boolean /** @description Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. */ - delete_branch_on_merge?: boolean; - }; - }; - }; - }; + delete_branch_on_merge?: boolean + } + } + } + } /** * Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest. * To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. */ - "secret-scanning/list-alerts-for-org": { + 'secret-scanning/list-alerts-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - state?: components["parameters"]["secret-scanning-alert-state"]; + state?: components['parameters']['secret-scanning-alert-state'] /** * A comma-separated list of secret types to return. By default all secret types are returned. * See "[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)" * for a complete list of secret types (API slug). */ - secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; + secret_type?: components['parameters']['secret-scanning-alert-secret-type'] /** A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - resolution?: components["parameters"]["secret-scanning-alert-resolution"]; + resolution?: components['parameters']['secret-scanning-alert-resolution'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["organization-secret-scanning-alert"][]; - }; - }; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': components['schemas']['organization-secret-scanning-alert'][] + } + } + 404: components['responses']['not_found'] + 503: components['responses']['service_unavailable'] + } + } /** * Gets the summary of the free and paid GitHub Actions minutes used. * @@ -24337,48 +24322,48 @@ export type operations = { * * Access tokens must have the `repo` or `admin:org` scope. */ - "billing/get-github-actions-billing-org": { + 'billing/get-github-actions-billing-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-billing-usage"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-billing-usage'] + } + } + } + } /** * Gets the GitHub Advanced Security active committers for an organization per repository. * Each distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of advanced_security_committers for each repository. * If this organization defers to an enterprise for billing, the total_advanced_security_committers returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level. */ - "billing/get-github-advanced-security-billing-org": { + 'billing/get-github-advanced-security-billing-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Success */ 200: { content: { - "application/json": components["schemas"]["advanced-security-active-committers"]; - }; - }; - 403: components["responses"]["code_scanning_forbidden_read"]; - }; - }; + 'application/json': components['schemas']['advanced-security-active-committers'] + } + } + 403: components['responses']['code_scanning_forbidden_read'] + } + } /** * Gets the free and paid storage used for GitHub Packages in gigabytes. * @@ -24386,21 +24371,21 @@ export type operations = { * * Access tokens must have the `repo` or `admin:org` scope. */ - "billing/get-github-packages-billing-org": { + 'billing/get-github-packages-billing-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["packages-billing-usage"]; - }; - }; - }; - }; + 'application/json': components['schemas']['packages-billing-usage'] + } + } + } + } /** * Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. * @@ -24408,106 +24393,106 @@ export type operations = { * * Access tokens must have the `repo` or `admin:org` scope. */ - "billing/get-shared-storage-billing-org": { + 'billing/get-shared-storage-billing-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["combined-billing-usage"]; - }; - }; - }; - }; + 'application/json': components['schemas']['combined-billing-usage'] + } + } + } + } /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * List IdP groups available in an organization. You can limit your page results using the `per_page` parameter. GitHub generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." */ - "teams/list-idp-groups-for-org": { + 'teams/list-idp-groups-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page token */ - page?: string; - }; - }; + page?: string + } + } responses: { /** Response */ 200: { headers: { - Link?: string; - }; - content: { - "application/json": components["schemas"]["group-mapping"]; - }; - }; - }; - }; + Link?: string + } + content: { + 'application/json': components['schemas']['group-mapping'] + } + } + } + } /** Lists all teams in an organization that are visible to the authenticated user. */ - "teams/list": { + 'teams/list': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team"][]; - }; - }; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['team'][] + } + } + 403: components['responses']['forbidden'] + } + } /** * To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://docs.github.com/en/articles/setting-team-creation-permissions-in-your-organization)." * * When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)". */ - "teams/create": { + 'teams/create': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["team-full"]; - }; - }; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['team-full'] + } + } + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the team. */ - name: string; + name: string /** @description The description of the team. */ - description?: string; + description?: string /** @description List GitHub IDs for organization members who will become team maintainers. */ - maintainers?: string[]; + maintainers?: string[] /** @description The full name (e.g., "organization-name/repository-name") of repositories to add the team to. */ - repo_names?: string[]; + repo_names?: string[] /** * @description The level of privacy this team should have. The options are: * **For a non-nested team:** @@ -24519,7 +24504,7 @@ export type operations = { * Default for child team: `closed` * @enum {string} */ - privacy?: "secret" | "closed"; + privacy?: 'secret' | 'closed' /** * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: * \* `pull` - team members can pull, but not push to or administer newly-added repositories. @@ -24527,36 +24512,36 @@ export type operations = { * @default pull * @enum {string} */ - permission?: "pull" | "push"; + permission?: 'pull' | 'push' /** @description The ID of a team to set as the parent team. */ - parent_team_id?: number; - }; - }; - }; - }; + parent_team_id?: number + } + } + } + } /** * Gets a team using the team's `slug`. GitHub generates the `slug` from the team `name`. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. */ - "teams/get-by-name": { + 'teams/get-by-name': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; - }; + team_slug: components['parameters']['team-slug'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-full"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['team-full'] + } + } + 404: components['responses']['not_found'] + } + } /** * To delete a team, the authenticated user must be an organization owner or team maintainer. * @@ -24564,47 +24549,47 @@ export type operations = { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. */ - "teams/delete-in-org": { + 'teams/delete-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; - }; + team_slug: components['parameters']['team-slug'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * To edit a team, the authenticated user must either be an organization owner or a team maintainer. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. */ - "teams/update-in-org": { + 'teams/update-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; - }; + team_slug: components['parameters']['team-slug'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["team-full"]; - }; - }; - }; + 'application/json': components['schemas']['team-full'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the team. */ - name?: string; + name?: string /** @description The description of the team. */ - description?: string; + description?: string /** * @description The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: * **For a non-nested team:** @@ -24614,7 +24599,7 @@ export type operations = { * \* `closed` - visible to all members of this organization. * @enum {string} */ - privacy?: "secret" | "closed"; + privacy?: 'secret' | 'closed' /** * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: * \* `pull` - team members can pull, but not push to or administer newly-added repositories. @@ -24623,46 +24608,46 @@ export type operations = { * @default pull * @enum {string} */ - permission?: "pull" | "push" | "admin"; + permission?: 'pull' | 'push' | 'admin' /** @description The ID of a team to set as the parent team. */ - parent_team_id?: number | null; - }; - }; - }; - }; + parent_team_id?: number | null + } + } + } + } /** * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. */ - "teams/list-discussions-in-org": { + 'teams/list-discussions-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; + team_slug: components['parameters']['team-slug'] + } query: { /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Pinned discussions only filter */ - pinned?: string; - }; - }; + pinned?: string + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team-discussion"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['team-discussion'][] + } + } + } + } /** * Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @@ -24670,142 +24655,142 @@ export type operations = { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. */ - "teams/create-discussion-in-org": { + 'teams/create-discussion-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; - }; + team_slug: components['parameters']['team-slug'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; + 'application/json': components['schemas']['team-discussion'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The discussion post's title. */ - title: string; + title: string /** @description The discussion post's body text. */ - body: string; + body: string /** @description Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. */ - private?: boolean; - }; - }; - }; - }; + private?: boolean + } + } + } + } /** * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. */ - "teams/get-discussion-in-org": { + 'teams/get-discussion-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - }; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; - }; + 'application/json': components['schemas']['team-discussion'] + } + } + } + } /** * Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. */ - "teams/delete-discussion-in-org": { + 'teams/delete-discussion-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - }; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. */ - "teams/update-discussion-in-org": { + 'teams/update-discussion-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - }; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; + 'application/json': components['schemas']['team-discussion'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The discussion post's title. */ - title?: string; + title?: string /** @description The discussion post's body text. */ - body?: string; - }; - }; - }; - }; + body?: string + } + } + } + } /** * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. */ - "teams/list-discussion-comments-in-org": { + 'teams/list-discussion-comments-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + } query: { /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team-discussion-comment"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['team-discussion-comment'][] + } + } + } + } /** * Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @@ -24813,387 +24798,387 @@ export type operations = { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. */ - "teams/create-discussion-comment-in-org": { + 'teams/create-discussion-comment-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - }; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; + 'application/json': components['schemas']['team-discussion-comment'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The discussion comment's body text. */ - body: string; - }; - }; - }; - }; + body: string + } + } + } + } /** * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. */ - "teams/get-discussion-comment-in-org": { + 'teams/get-discussion-comment-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - comment_number: components["parameters"]["comment-number"]; - }; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + comment_number: components['parameters']['comment-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; - }; + 'application/json': components['schemas']['team-discussion-comment'] + } + } + } + } /** * Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. */ - "teams/delete-discussion-comment-in-org": { + 'teams/delete-discussion-comment-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - comment_number: components["parameters"]["comment-number"]; - }; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + comment_number: components['parameters']['comment-number'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. */ - "teams/update-discussion-comment-in-org": { + 'teams/update-discussion-comment-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - comment_number: components["parameters"]["comment-number"]; - }; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + comment_number: components['parameters']['comment-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; + 'application/json': components['schemas']['team-discussion-comment'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The discussion comment's body text. */ - body: string; - }; - }; - }; - }; + body: string + } + } + } + } /** * List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments/). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. */ - "reactions/list-for-team-discussion-comment-in-org": { + 'reactions/list-for-team-discussion-comment-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - comment_number: components["parameters"]["comment-number"]; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + comment_number: components['parameters']['comment-number'] + } query: { /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion comment. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content?: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["reaction"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['reaction'][] + } + } + } + } /** * Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. */ - "reactions/create-for-team-discussion-comment-in-org": { + 'reactions/create-for-team-discussion-comment-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - comment_number: components["parameters"]["comment-number"]; - }; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + comment_number: components['parameters']['comment-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; + 'application/json': components['schemas']['reaction'] + } + } /** Response */ 201: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - }; + 'application/json': components['schemas']['reaction'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion comment. * @enum {string} */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - }; + content: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' + } + } + } + } /** * **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. * * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "reactions/delete-for-team-discussion-comment": { + 'reactions/delete-for-team-discussion-comment': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - comment_number: components["parameters"]["comment-number"]; - reaction_id: components["parameters"]["reaction-id"]; - }; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + comment_number: components['parameters']['comment-number'] + reaction_id: components['parameters']['reaction-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. */ - "reactions/list-for-team-discussion-in-org": { + 'reactions/list-for-team-discussion-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + } query: { /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content?: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["reaction"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['reaction'][] + } + } + } + } /** * Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. */ - "reactions/create-for-team-discussion-in-org": { + 'reactions/create-for-team-discussion-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - }; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; + 'application/json': components['schemas']['reaction'] + } + } /** Response */ 201: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - }; + 'application/json': components['schemas']['reaction'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion. * @enum {string} */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - }; + content: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' + } + } + } + } /** * **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. * * Delete a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "reactions/delete-for-team-discussion": { + 'reactions/delete-for-team-discussion': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - reaction_id: components["parameters"]["reaction-id"]; - }; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + reaction_id: components['parameters']['reaction-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Deletes a connection between a team and an external group. * * You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "teams/unlink-external-idp-group-from-team-for-org": { + 'teams/unlink-external-idp-group-from-team-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; - }; + team_slug: components['parameters']['team-slug'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Creates a connection between a team and an external group. Only one external group can be linked to a team. * * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ - "teams/link-external-idp-group-to-team-for-org": { + 'teams/link-external-idp-group-to-team-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; - }; + team_slug: components['parameters']['team-slug'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["external-group"]; - }; - }; - }; + 'application/json': components['schemas']['external-group'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description External Group Id * @example 1 */ - group_id: number; - }; - }; - }; - }; + group_id: number + } + } + } + } /** * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. */ - "teams/list-pending-invitations-in-org": { + 'teams/list-pending-invitations-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; + team_slug: components['parameters']['team-slug'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["organization-invitation"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['organization-invitation'][] + } + } + } + } /** * Team members will include the members of child teams. * * To list members in a team, the team must be visible to the authenticated user. */ - "teams/list-members-in-org": { + 'teams/list-members-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; + team_slug: components['parameters']['team-slug'] + } query: { /** * Filters members returned by their role in the team. Can be one of: @@ -25201,23 +25186,23 @@ export type operations = { * \* `maintainer` - team maintainers. * \* `all` - all members of the team. */ - role?: "member" | "maintainer" | "all"; + role?: 'member' | 'maintainer' | 'all' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + } + } /** * Team members will include the members of child teams. * @@ -25230,26 +25215,26 @@ export type operations = { * * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team). */ - "teams/get-membership-for-user-in-org": { + 'teams/get-membership-for-user-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - username: components["parameters"]["username"]; - }; - }; + team_slug: components['parameters']['team-slug'] + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-membership"]; - }; - }; + 'application/json': components['schemas']['team-membership'] + } + } /** if user has no team membership */ - 404: unknown; - }; - }; + 404: unknown + } + } /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -25263,30 +25248,30 @@ export type operations = { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ - "teams/add-or-update-membership-for-user-in-org": { + 'teams/add-or-update-membership-for-user-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - username: components["parameters"]["username"]; - }; - }; + team_slug: components['parameters']['team-slug'] + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-membership"]; - }; - }; + 'application/json': components['schemas']['team-membership'] + } + } /** Forbidden if team synchronization is set up */ - 403: unknown; + 403: unknown /** Unprocessable Entity if you attempt to add an organization to a team */ - 422: unknown; - }; + 422: unknown + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The role that this user should have in the team. Can be one of: * \* `member` - a normal member of the team. @@ -25294,11 +25279,11 @@ export type operations = { * @default member * @enum {string} */ - role?: "member" | "maintainer"; - }; - }; - }; - }; + role?: 'member' | 'maintainer' + } + } + } + } /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -25308,106 +25293,106 @@ export type operations = { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ - "teams/remove-membership-for-user-in-org": { + 'teams/remove-membership-for-user-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - username: components["parameters"]["username"]; - }; - }; + team_slug: components['parameters']['team-slug'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; + 204: never /** Forbidden if team synchronization is set up */ - 403: unknown; - }; - }; + 403: unknown + } + } /** * Lists the organization projects for a team. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. */ - "teams/list-projects-in-org": { + 'teams/list-projects-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; + team_slug: components['parameters']['team-slug'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team-project"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['team-project'][] + } + } + } + } /** * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ - "teams/check-permissions-for-project-in-org": { + 'teams/check-permissions-for-project-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - project_id: components["parameters"]["project-id"]; - }; - }; + team_slug: components['parameters']['team-slug'] + project_id: components['parameters']['project-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-project"]; - }; - }; + 'application/json': components['schemas']['team-project'] + } + } /** Not Found if project is not managed by this team */ - 404: unknown; - }; - }; + 404: unknown + } + } /** * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ - "teams/add-or-update-project-permissions-in-org": { + 'teams/add-or-update-project-permissions-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - project_id: components["parameters"]["project-id"]; - }; - }; + team_slug: components['parameters']['team-slug'] + project_id: components['parameters']['project-id'] + } + } responses: { /** Response */ - 204: never; + 204: never /** Forbidden if the project is not owned by the organization */ 403: { content: { - "application/json": { - message?: string; - documentation_url?: string; - }; - }; - }; - }; + 'application/json': { + message?: string + documentation_url?: string + } + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The permission to grant to the team for this project. Can be one of: * \* `read` - team members can read, but not write to or administer this project. @@ -25416,59 +25401,59 @@ export type operations = { * Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." * @enum {string} */ - permission?: "read" | "write" | "admin"; - } | null; - }; - }; - }; + permission?: 'read' | 'write' | 'admin' + } | null + } + } + } /** * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ - "teams/remove-project-in-org": { + 'teams/remove-project-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - project_id: components["parameters"]["project-id"]; - }; - }; + team_slug: components['parameters']['team-slug'] + project_id: components['parameters']['project-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Lists a team's repositories visible to the authenticated user. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. */ - "teams/list-repos-in-org": { + 'teams/list-repos-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; + team_slug: components['parameters']['team-slug'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["minimal-repository"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['minimal-repository'][] + } + } + } + } /** * Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. * @@ -25478,29 +25463,29 @@ export type operations = { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ - "teams/check-permissions-for-repo-in-org": { + 'teams/check-permissions-for-repo-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + team_slug: components['parameters']['team-slug'] + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Alternative response with repository permissions */ 200: { content: { - "application/json": components["schemas"]["team-repository"]; - }; - }; + 'application/json': components['schemas']['team-repository'] + } + } /** Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header. */ - 204: never; + 204: never /** Not Found if team does not have permission for the repository */ - 404: unknown; - }; - }; + 404: unknown + } + } /** * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." * @@ -25508,23 +25493,23 @@ export type operations = { * * For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". */ - "teams/add-or-update-repo-permissions-in-org": { + 'teams/add-or-update-repo-permissions-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + team_slug: components['parameters']['team-slug'] + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The permission to grant the team on this repository. Can be one of: * \* `pull` - team members can pull, but not push to or administer this repository. @@ -25538,31 +25523,31 @@ export type operations = { * @default push * @enum {string} */ - permission?: "pull" | "push" | "admin" | "maintain" | "triage"; - }; - }; - }; - }; + permission?: 'pull' | 'push' | 'admin' | 'maintain' | 'triage' + } + } + } + } /** * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ - "teams/remove-repo-in-org": { + 'teams/remove-repo-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + team_slug: components['parameters']['team-slug'] + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -25570,23 +25555,23 @@ export type operations = { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`. */ - "teams/list-idp-groups-in-org": { + 'teams/list-idp-groups-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; - }; + team_slug: components['parameters']['team-slug'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["group-mapping"]; - }; - }; - }; - }; + 'application/json': components['schemas']['group-mapping'] + } + } + } + } /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -25594,510 +25579,508 @@ export type operations = { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`. */ - "teams/create-or-update-idp-group-connections-in-org": { + 'teams/create-or-update-idp-group-connections-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; - }; + team_slug: components['parameters']['team-slug'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["group-mapping"]; - }; - }; - }; + 'application/json': components['schemas']['group-mapping'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The IdP groups you want to connect to a GitHub team. When updating, the new `groups` object will replace the original one. You must include any existing groups that you don't want to remove. */ groups?: { /** @description ID of the IdP group. */ - group_id: string; + group_id: string /** @description Name of the IdP group. */ - group_name: string; + group_name: string /** @description Description of the IdP group. */ - group_description: string; - }[]; - }; - }; - }; - }; + group_description: string + }[] + } + } + } + } /** * Lists the child teams of the team specified by `{team_slug}`. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. */ - "teams/list-child-in-org": { + 'teams/list-child-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; + team_slug: components['parameters']['team-slug'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** if child teams exist */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team"][]; - }; - }; - }; - }; - "projects/get-card": { + 'application/json': components['schemas']['team'][] + } + } + } + } + 'projects/get-card': { parameters: { path: { /** card_id parameter */ - card_id: components["parameters"]["card-id"]; - }; - }; + card_id: components['parameters']['card-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["project-card"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "projects/delete-card": { + 'application/json': components['schemas']['project-card'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'projects/delete-card': { parameters: { path: { /** card_id parameter */ - card_id: components["parameters"]["card-id"]; - }; - }; + card_id: components['parameters']['card-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] /** Forbidden */ 403: { content: { - "application/json": { - message?: string; - documentation_url?: string; - errors?: string[]; - }; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "projects/update-card": { + 'application/json': { + message?: string + documentation_url?: string + errors?: string[] + } + } + } + 404: components['responses']['not_found'] + } + } + 'projects/update-card': { parameters: { path: { /** card_id parameter */ - card_id: components["parameters"]["card-id"]; - }; - }; + card_id: components['parameters']['card-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["project-card"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': components['schemas']['project-card'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The project card's note * @example Update all gems */ - note?: string | null; + note?: string | null /** @description Whether or not the card is archived */ - archived?: boolean; - }; - }; - }; - }; - "projects/move-card": { + archived?: boolean + } + } + } + } + 'projects/move-card': { parameters: { path: { /** card_id parameter */ - card_id: components["parameters"]["card-id"]; - }; - }; + card_id: components['parameters']['card-id'] + } + } responses: { /** Response */ 201: { content: { - "application/json": { [key: string]: unknown }; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; + 'application/json': { [key: string]: unknown } + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] /** Forbidden */ 403: { content: { - "application/json": { - message?: string; - documentation_url?: string; + 'application/json': { + message?: string + documentation_url?: string errors?: { - code?: string; - message?: string; - resource?: string; - field?: string; - }[]; - }; - }; - }; - 422: components["responses"]["validation_failed"]; + code?: string + message?: string + resource?: string + field?: string + }[] + } + } + } + 422: components['responses']['validation_failed'] /** Response */ 503: { content: { - "application/json": { - code?: string; - message?: string; - documentation_url?: string; + 'application/json': { + code?: string + message?: string + documentation_url?: string errors?: { - code?: string; - message?: string; - }[]; - }; - }; - }; - }; + code?: string + message?: string + }[] + } + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card. * @example bottom */ - position: string; + position: string /** * @description The unique identifier of the column the card should be moved to * @example 42 */ - column_id?: number; - }; - }; - }; - }; - "projects/get-column": { + column_id?: number + } + } + } + } + 'projects/get-column': { parameters: { path: { /** column_id parameter */ - column_id: components["parameters"]["column-id"]; - }; - }; + column_id: components['parameters']['column-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["project-column"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "projects/delete-column": { + 'application/json': components['schemas']['project-column'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'projects/delete-column': { parameters: { path: { /** column_id parameter */ - column_id: components["parameters"]["column-id"]; - }; - }; + column_id: components['parameters']['column-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; - "projects/update-column": { + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } + 'projects/update-column': { parameters: { path: { /** column_id parameter */ - column_id: components["parameters"]["column-id"]; - }; - }; + column_id: components['parameters']['column-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["project-column"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; + 'application/json': components['schemas']['project-column'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description Name of the project column * @example Remaining tasks */ - name: string; - }; - }; - }; - }; - "projects/list-cards": { + name: string + } + } + } + } + 'projects/list-cards': { parameters: { path: { /** column_id parameter */ - column_id: components["parameters"]["column-id"]; - }; + column_id: components['parameters']['column-id'] + } query: { /** Filters the project cards that are returned by the card's state. Can be one of `all`,`archived`, or `not_archived`. */ - archived_state?: "all" | "archived" | "not_archived"; + archived_state?: 'all' | 'archived' | 'not_archived' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["project-card"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; - "projects/create-card": { + 'application/json': components['schemas']['project-card'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } + 'projects/create-card': { parameters: { path: { /** column_id parameter */ - column_id: components["parameters"]["column-id"]; - }; - }; + column_id: components['parameters']['column-id'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["project-card"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; + 'application/json': components['schemas']['project-card'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] /** Validation failed */ 422: { content: { - "application/json": - | components["schemas"]["validation-error"] - | components["schemas"]["validation-error-simple"]; - }; - }; + 'application/json': components['schemas']['validation-error'] | components['schemas']['validation-error-simple'] + } + } /** Response */ 503: { content: { - "application/json": { - code?: string; - message?: string; - documentation_url?: string; + 'application/json': { + code?: string + message?: string + documentation_url?: string errors?: { - code?: string; - message?: string; - }[]; - }; - }; - }; - }; + code?: string + message?: string + }[] + } + } + } + } requestBody: { content: { - "application/json": + 'application/json': | { /** * @description The project card's note * @example Update all gems */ - note: string | null; + note: string | null } | { /** * @description The unique identifier of the content associated with the card * @example 42 */ - content_id: number; + content_id: number /** * @description The piece of content associated with the card * @example PullRequest */ - content_type: string; - }; - }; - }; - }; - "projects/move-column": { + content_type: string + } + } + } + } + 'projects/move-column': { parameters: { path: { /** column_id parameter */ - column_id: components["parameters"]["column-id"]; - }; - }; + column_id: components['parameters']['column-id'] + } + } responses: { /** Response */ 201: { content: { - "application/json": { [key: string]: unknown }; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': { [key: string]: unknown } + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column. * @example last */ - position: string; - }; - }; - }; - }; + position: string + } + } + } + } /** Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - "projects/get": { + 'projects/get': { parameters: { path: { - project_id: components["parameters"]["project-id"]; - }; - }; + project_id: components['parameters']['project-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["project"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['project'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** Deletes a project board. Returns a `404 Not Found` status if projects are disabled. */ - "projects/delete": { + 'projects/delete': { parameters: { path: { - project_id: components["parameters"]["project-id"]; - }; - }; + project_id: components['parameters']['project-id'] + } + } responses: { /** Delete Success */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] /** Forbidden */ 403: { content: { - "application/json": { - message?: string; - documentation_url?: string; - errors?: string[]; - }; - }; - }; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - }; - }; + 'application/json': { + message?: string + documentation_url?: string + errors?: string[] + } + } + } + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + } + } /** Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - "projects/update": { + 'projects/update': { parameters: { path: { - project_id: components["parameters"]["project-id"]; - }; - }; + project_id: components['parameters']['project-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["project"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; + 'application/json': components['schemas']['project'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] /** Forbidden */ 403: { content: { - "application/json": { - message?: string; - documentation_url?: string; - errors?: string[]; - }; - }; - }; + 'application/json': { + message?: string + documentation_url?: string + errors?: string[] + } + } + } /** Not Found if the authenticated user does not have access to the project */ - 404: unknown; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 404: unknown + 410: components['responses']['gone'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description Name of the project * @example Week One Sprint */ - name?: string; + name?: string /** * @description Body of the project * @example This project represents the sprint of the first week in January */ - body?: string | null; + body?: string | null /** * @description State of the project; either 'open' or 'closed' * @example open */ - state?: string; + state?: string /** * @description The baseline permission that all organization members have on this project * @enum {string} */ - organization_permission?: "read" | "write" | "admin" | "none"; + organization_permission?: 'read' | 'write' | 'admin' | 'none' /** @description Whether or not this project can be seen by everyone. */ - private?: boolean; - }; - }; - }; - }; + private?: boolean + } + } + } + } /** Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators. */ - "projects/list-collaborators": { + 'projects/list-collaborators': { parameters: { path: { - project_id: components["parameters"]["project-id"]; - }; + project_id: components['parameters']['project-id'] + } query: { /** * Filters the collaborators by their affiliation. Can be one of: @@ -26105,483 +26088,483 @@ export type operations = { * \* `direct`: Collaborators with permissions to a project, regardless of organization membership status. * \* `all`: All collaborators the authenticated user can see. */ - affiliation?: "outside" | "direct" | "all"; + affiliation?: 'outside' | 'direct' | 'all' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator. */ - "projects/add-collaborator": { + 'projects/add-collaborator': { parameters: { path: { - project_id: components["parameters"]["project-id"]; - username: components["parameters"]["username"]; - }; - }; + project_id: components['parameters']['project-id'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The permission to grant the collaborator. * @default write * @example write * @enum {string} */ - permission?: "read" | "write" | "admin"; - } | null; - }; - }; - }; + permission?: 'read' | 'write' | 'admin' + } | null + } + } + } /** Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator. */ - "projects/remove-collaborator": { + 'projects/remove-collaborator': { parameters: { path: { - project_id: components["parameters"]["project-id"]; - username: components["parameters"]["username"]; - }; - }; + project_id: components['parameters']['project-id'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level. */ - "projects/get-permission-for-user": { + 'projects/get-permission-for-user': { parameters: { path: { - project_id: components["parameters"]["project-id"]; - username: components["parameters"]["username"]; - }; - }; + project_id: components['parameters']['project-id'] + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["project-collaborator-permission"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "projects/list-columns": { + 'application/json': components['schemas']['project-collaborator-permission'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } + 'projects/list-columns': { parameters: { path: { - project_id: components["parameters"]["project-id"]; - }; + project_id: components['parameters']['project-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["project-column"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; - "projects/create-column": { + 'application/json': components['schemas']['project-column'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } + 'projects/create-column': { parameters: { path: { - project_id: components["parameters"]["project-id"]; - }; - }; + project_id: components['parameters']['project-id'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["project-column"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': components['schemas']['project-column'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description Name of the project column * @example Remaining tasks */ - name: string; - }; - }; - }; - }; + name: string + } + } + } + } /** * **Note:** Accessing this endpoint does not count against your REST API rate limit. * * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. */ - "rate-limit/get": { - parameters: {}; + 'rate-limit/get': { + parameters: {} responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["rate-limit-overview"]; - }; - }; - 304: components["responses"]["not_modified"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['rate-limit-overview'] + } + } + 304: components['responses']['not_modified'] + 404: components['responses']['not_found'] + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Reactions API. We recommend migrating your existing code to use the new delete reactions endpoints. For more information, see this [blog post](https://developer.github.com/changes/2020-02-26-new-delete-reactions-endpoints/). * * OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), when deleting a [team discussion](https://docs.github.com/rest/reference/teams#discussions) or [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). */ - "reactions/delete-legacy": { + 'reactions/delete-legacy': { parameters: { path: { - reaction_id: components["parameters"]["reaction-id"]; - }; - }; + reaction_id: components['parameters']['reaction-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 410: components["responses"]["gone"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 410: components['responses']['gone'] + } + } /** The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. */ - "repos/get": { + 'repos/get': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["full-repository"]; - }; - }; - 301: components["responses"]["moved_permanently"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['full-repository'] + } + } + 301: components['responses']['moved_permanently'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required. * * If an organization owner has configured the organization to prevent members from deleting organization-owned * repositories, you will get a `403 Forbidden` response. */ - "repos/delete": { + 'repos/delete': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - 307: components["responses"]["temporary_redirect"]; + 204: never + 307: components['responses']['temporary_redirect'] /** If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response: */ 403: { content: { - "application/json": { - message?: string; - documentation_url?: string; - }; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': { + message?: string + documentation_url?: string + } + } + } + 404: components['responses']['not_found'] + } + } /** **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/rest/reference/repos#replace-all-repository-topics) endpoint. */ - "repos/update": { + 'repos/update': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["full-repository"]; - }; - }; - 307: components["responses"]["temporary_redirect"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['full-repository'] + } + } + 307: components['responses']['temporary_redirect'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the repository. */ - name?: string; + name?: string /** @description A short description of the repository. */ - description?: string; + description?: string /** @description A URL with more information about the repository. */ - homepage?: string; + homepage?: string /** * @description Either `true` to make the repository private or `false` to make it public. Default: `false`. * **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. */ - private?: boolean; + private?: boolean /** * @description Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`." * @enum {string} */ - visibility?: "public" | "private" | "internal"; + visibility?: 'public' | 'private' | 'internal' /** @description Specify which security and analysis features to enable or disable. For example, to enable GitHub Advanced Security, use this data in the body of the PATCH request: `{"security_and_analysis": {"advanced_security": {"status": "enabled"}}}`. If you have admin permissions for a private repository covered by an Advanced Security license, you can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request. */ security_and_analysis?: { /** @description Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see "[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security)." */ advanced_security?: { /** @description Can be `enabled` or `disabled`. */ - status?: string; - }; + status?: string + } /** @description Use the `status` property to enable or disable secret scanning for this repository. For more information, see "[About secret scanning](/code-security/secret-security/about-secret-scanning)." */ secret_scanning?: { /** @description Can be `enabled` or `disabled`. */ - status?: string; - }; - } | null; + status?: string + } + } | null /** * @description Either `true` to enable issues for this repository or `false` to disable them. * @default true */ - has_issues?: boolean; + has_issues?: boolean /** * @description Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error. * @default true */ - has_projects?: boolean; + has_projects?: boolean /** * @description Either `true` to enable the wiki for this repository or `false` to disable it. * @default true */ - has_wiki?: boolean; + has_wiki?: boolean /** @description Either `true` to make this repo available as a template repository or `false` to prevent it. */ - is_template?: boolean; + is_template?: boolean /** @description Updates the default branch for this repository. */ - default_branch?: string; + default_branch?: string /** * @description Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge?: boolean /** * @description Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit?: boolean /** * @description Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge?: boolean /** @description Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. */ - allow_auto_merge?: boolean; + allow_auto_merge?: boolean /** @description Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge?: boolean /** @description `true` to archive this repository. **Note**: You cannot unarchive repositories through the API. */ - archived?: boolean; + archived?: boolean /** @description Either `true` to allow private forks, or `false` to prevent private forks. */ - allow_forking?: boolean; - }; - }; - }; - }; + allow_forking?: boolean + } + } + } + } /** Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/list-artifacts-for-repo": { + 'actions/list-artifacts-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - artifacts: components["schemas"]["artifact"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + artifacts: components['schemas']['artifact'][] + } + } + } + } + } /** Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/get-artifact": { + 'actions/get-artifact': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** artifact_id parameter */ - artifact_id: components["parameters"]["artifact-id"]; - }; - }; + artifact_id: components['parameters']['artifact-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["artifact"]; - }; - }; - }; - }; + 'application/json': components['schemas']['artifact'] + } + } + } + } /** Deletes an artifact for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - "actions/delete-artifact": { + 'actions/delete-artifact': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** artifact_id parameter */ - artifact_id: components["parameters"]["artifact-id"]; - }; - }; + artifact_id: components['parameters']['artifact-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in * the response header to find the URL for the download. The `:archive_format` must be `zip`. Anyone with read access to * the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/download-artifact": { + 'actions/download-artifact': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** artifact_id parameter */ - artifact_id: components["parameters"]["artifact-id"]; - archive_format: string; - }; - }; + artifact_id: components['parameters']['artifact-id'] + archive_format: string + } + } responses: { /** Response */ - 302: never; - }; - }; + 302: never + } + } /** Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/get-job-for-workflow-run": { + 'actions/get-job-for-workflow-run': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** job_id parameter */ - job_id: components["parameters"]["job-id"]; - }; - }; + job_id: components['parameters']['job-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["job"]; - }; - }; - }; - }; + 'application/json': components['schemas']['job'] + } + } + } + } /** * Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look * for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can * use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must * have the `actions:read` permission to use this endpoint. */ - "actions/download-job-logs-for-workflow-run": { + 'actions/download-job-logs-for-workflow-run': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** job_id parameter */ - job_id: components["parameters"]["job-id"]; - }; - }; + job_id: components['parameters']['job-id'] + } + } responses: { /** Response */ - 302: never; - }; - }; + 302: never + } + } /** * Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository. * * You must authenticate using an access token with the `repo` scope to use this * endpoint. GitHub Apps must have the `administration` repository permission to use this API. */ - "actions/get-github-actions-permissions-repository": { + 'actions/get-github-actions-permissions-repository': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-repository-permissions"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-repository-permissions'] + } + } + } + } /** * Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository. * @@ -26589,47 +26572,47 @@ export type operations = { * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. */ - "actions/set-github-actions-permissions-repository": { + 'actions/set-github-actions-permissions-repository': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { - enabled: components["schemas"]["actions-enabled"]; - allowed_actions?: components["schemas"]["allowed-actions"]; - }; - }; - }; - }; + 'application/json': { + enabled: components['schemas']['actions-enabled'] + allowed_actions?: components['schemas']['allowed-actions'] + } + } + } + } /** * Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. */ - "actions/get-allowed-actions-repository": { + 'actions/get-allowed-actions-repository': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["selected-actions"]; - }; - }; - }; - }; + 'application/json': components['schemas']['selected-actions'] + } + } + } + } /** * Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." * @@ -26639,71 +26622,71 @@ export type operations = { * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. */ - "actions/set-allowed-actions-repository": { + 'actions/set-allowed-actions-repository': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": components["schemas"]["selected-actions"]; - }; - }; - }; + 'application/json': components['schemas']['selected-actions'] + } + } + } /** Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. */ - "actions/list-self-hosted-runners-for-repo": { + 'actions/list-self-hosted-runners-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - runners: components["schemas"]["runner"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + runners: components['schemas']['runner'][] + } + } + } + } + } /** * Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `repo` scope to use this endpoint. */ - "actions/list-runner-applications-for-repo": { + 'actions/list-runner-applications-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["runner-application"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['runner-application'][] + } + } + } + } /** * Returns a token that you can pass to the `config` script. The token expires after one hour. You must authenticate * using an access token with the `repo` scope to use this endpoint. @@ -26716,22 +26699,22 @@ export type operations = { * ./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN * ``` */ - "actions/create-registration-token-for-repo": { + 'actions/create-registration-token-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["authentication-token"]; - }; - }; - }; - }; + 'application/json': components['schemas']['authentication-token'] + } + } + } + } /** * Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour. * You must authenticate using an access token with the `repo` scope to use this endpoint. @@ -26744,86 +26727,86 @@ export type operations = { * ./config.sh remove --token TOKEN * ``` */ - "actions/create-remove-token-for-repo": { + 'actions/create-remove-token-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["authentication-token"]; - }; - }; - }; - }; + 'application/json': components['schemas']['authentication-token'] + } + } + } + } /** * Gets a specific self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - "actions/get-self-hosted-runner-for-repo": { + 'actions/get-self-hosted-runner-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["runner"]; - }; - }; - }; - }; + 'application/json': components['schemas']['runner'] + } + } + } + } /** * Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * * You must authenticate using an access token with the `repo` * scope to use this endpoint. */ - "actions/delete-self-hosted-runner-from-repo": { + 'actions/delete-self-hosted-runner-from-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Lists all labels for a self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - "actions/list-labels-for-self-hosted-runner-for-repo": { + 'actions/list-labels-for-self-hosted-runner-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - }; - }; + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + } + } /** * Remove all previous custom labels and set the new custom labels for a specific * self-hosted runner configured in a repository. @@ -26831,58 +26814,58 @@ export type operations = { * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - "actions/set-custom-labels-for-self-hosted-runner-for-repo": { + 'actions/set-custom-labels-for-self-hosted-runner-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; - responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + runner_id: components['parameters']['runner-id'] + } + } + responses: { + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels. */ - labels: string[]; - }; - }; - }; - }; + labels: string[] + } + } + } + } /** * Add custom labels to a self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - "actions/add-custom-labels-to-self-hosted-runner-for-repo": { + 'actions/add-custom-labels-to-self-hosted-runner-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; - responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + runner_id: components['parameters']['runner-id'] + } + } + responses: { + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The names of the custom labels to add to the runner. */ - labels: string[]; - }; - }; - }; - }; + labels: string[] + } + } + } + } /** * Remove all custom labels from a self-hosted runner configured in a * repository. Returns the remaining read-only labels from the runner. @@ -26890,20 +26873,20 @@ export type operations = { * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - "actions/remove-all-custom-labels-from-self-hosted-runner-for-repo": { + 'actions/remove-all-custom-labels-from-self-hosted-runner-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { - 200: components["responses"]["actions_runner_labels_readonly"]; - 404: components["responses"]["not_found"]; - }; - }; + 200: components['responses']['actions_runner_labels_readonly'] + 404: components['responses']['not_found'] + } + } /** * Remove a custom label from a self-hosted runner configured * in a repository. Returns the remaining labels from the runner. @@ -26914,531 +26897,531 @@ export type operations = { * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - "actions/remove-custom-label-from-self-hosted-runner-for-repo": { + 'actions/remove-custom-label-from-self-hosted-runner-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; + runner_id: components['parameters']['runner-id'] /** The name of a self-hosted runner's custom label. */ - name: components["parameters"]["runner-label-name"]; - }; - }; + name: components['parameters']['runner-label-name'] + } + } responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; - }; + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } + } /** * Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). * * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/list-workflow-runs-for-repo": { + 'actions/list-workflow-runs-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ - actor?: components["parameters"]["actor"]; + actor?: components['parameters']['actor'] /** Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ - branch?: components["parameters"]["workflow-run-branch"]; + branch?: components['parameters']['workflow-run-branch'] /** Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ - event?: components["parameters"]["event"]; + event?: components['parameters']['event'] /** Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. For a list of the possible `status` and `conclusion` options, see "[Create a check run](https://docs.github.com/rest/reference/checks#create-a-check-run)." */ - status?: components["parameters"]["workflow-run-status"]; + status?: components['parameters']['workflow-run-status'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ - created?: components["parameters"]["created"]; + created?: components['parameters']['created'] /** If `true` pull requests are omitted from the response (empty array). */ - exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; + exclude_pull_requests?: components['parameters']['exclude-pull-requests'] /** Returns workflow runs with the `check_suite_id` that you specify. */ - check_suite_id?: components["parameters"]["workflow-run-check-suite-id"]; - }; - }; + check_suite_id?: components['parameters']['workflow-run-check-suite-id'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - workflow_runs: components["schemas"]["workflow-run"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + workflow_runs: components['schemas']['workflow-run'][] + } + } + } + } + } /** Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/get-workflow-run": { + 'actions/get-workflow-run': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; + run_id: components['parameters']['run-id'] + } query: { /** If `true` pull requests are omitted from the response (empty array). */ - exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; - }; - }; + exclude_pull_requests?: components['parameters']['exclude-pull-requests'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["workflow-run"]; - }; - }; - }; - }; + 'application/json': components['schemas']['workflow-run'] + } + } + } + } /** * Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is * private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:write` permission to use * this endpoint. */ - "actions/delete-workflow-run": { + 'actions/delete-workflow-run': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; - }; + run_id: components['parameters']['run-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/get-reviews-for-run": { + 'actions/get-reviews-for-run': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; - }; + run_id: components['parameters']['run-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["environment-approvals"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['environment-approvals'][] + } + } + } + } /** * Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)." * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - "actions/approve-workflow-run": { + 'actions/approve-workflow-run': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; - }; + run_id: components['parameters']['run-id'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["empty-object"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['empty-object'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/list-workflow-run-artifacts": { + 'actions/list-workflow-run-artifacts': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; + run_id: components['parameters']['run-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - artifacts: components["schemas"]["artifact"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + artifacts: components['schemas']['artifact'][] + } + } + } + } + } /** * Gets a specific workflow run attempt. Anyone with read access to the repository * can use this endpoint. If the repository is private you must use an access token * with the `repo` scope. GitHub Apps must have the `actions:read` permission to * use this endpoint. */ - "actions/get-workflow-run-attempt": { + 'actions/get-workflow-run-attempt': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; + run_id: components['parameters']['run-id'] /** The attempt number of the workflow run. */ - attempt_number: components["parameters"]["attempt-number"]; - }; + attempt_number: components['parameters']['attempt-number'] + } query: { /** If `true` pull requests are omitted from the response (empty array). */ - exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; - }; - }; + exclude_pull_requests?: components['parameters']['exclude-pull-requests'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["workflow-run"]; - }; - }; - }; - }; + 'application/json': components['schemas']['workflow-run'] + } + } + } + } /** Lists jobs for a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). */ - "actions/list-jobs-for-workflow-run-attempt": { + 'actions/list-jobs-for-workflow-run-attempt': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; + run_id: components['parameters']['run-id'] /** The attempt number of the workflow run. */ - attempt_number: components["parameters"]["attempt-number"]; - }; + attempt_number: components['parameters']['attempt-number'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - jobs: components["schemas"]["job"][]; - }; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': { + total_count: number + jobs: components['schemas']['job'][] + } + } + } + 404: components['responses']['not_found'] + } + } /** * Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after * 1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to * the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/download-workflow-run-attempt-logs": { + 'actions/download-workflow-run-attempt-logs': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; + run_id: components['parameters']['run-id'] /** The attempt number of the workflow run. */ - attempt_number: components["parameters"]["attempt-number"]; - }; - }; + attempt_number: components['parameters']['attempt-number'] + } + } responses: { /** Response */ - 302: never; - }; - }; + 302: never + } + } /** Cancels a workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - "actions/cancel-workflow-run": { + 'actions/cancel-workflow-run': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; - }; + run_id: components['parameters']['run-id'] + } + } responses: { /** Response */ 202: { content: { - "application/json": { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': { [key: string]: unknown } + } + } + } + } /** Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). */ - "actions/list-jobs-for-workflow-run": { + 'actions/list-jobs-for-workflow-run': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; + run_id: components['parameters']['run-id'] + } query: { /** * Filters jobs by their `completed_at` timestamp. Can be one of: * \* `latest`: Returns jobs from the most recent execution of the workflow run. * \* `all`: Returns all jobs for a workflow run, including from old executions of the workflow run. */ - filter?: "latest" | "all"; + filter?: 'latest' | 'all' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - jobs: components["schemas"]["job"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + jobs: components['schemas']['job'][] + } + } + } + } + } /** * Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for * `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use * this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have * the `actions:read` permission to use this endpoint. */ - "actions/download-workflow-run-logs": { + 'actions/download-workflow-run-logs': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; - }; + run_id: components['parameters']['run-id'] + } + } responses: { /** Response */ - 302: never; - }; - }; + 302: never + } + } /** Deletes all logs for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - "actions/delete-workflow-run-logs": { + 'actions/delete-workflow-run-logs': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; - }; + run_id: components['parameters']['run-id'] + } + } responses: { /** Response */ - 204: never; - 403: components["responses"]["forbidden"]; - 500: components["responses"]["internal_error"]; - }; - }; + 204: never + 403: components['responses']['forbidden'] + 500: components['responses']['internal_error'] + } + } /** * Get all deployment environments for a workflow run that are waiting for protection rules to pass. * * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/get-pending-deployments-for-run": { + 'actions/get-pending-deployments-for-run': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; - }; + run_id: components['parameters']['run-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pending-deployment"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['pending-deployment'][] + } + } + } + } /** * Approve or reject pending deployments that are waiting on approval by a required reviewer. * * Anyone with read access to the repository contents and deployments can use this endpoint. */ - "actions/review-pending-deployments-for-run": { + 'actions/review-pending-deployments-for-run': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; - }; + run_id: components['parameters']['run-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["deployment"][]; - }; - }; - }; + 'application/json': components['schemas']['deployment'][] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The list of environment ids to approve or reject * @example 161171787,161171795 */ - environment_ids: number[]; + environment_ids: number[] /** * @description Whether to approve or reject deployment to the specified environments. Must be one of: `approved` or `rejected` * @example approved * @enum {string} */ - state: "approved" | "rejected"; + state: 'approved' | 'rejected' /** * @description A comment to accompany the deployment review * @example Ship it! */ - comment: string; - }; - }; - }; - }; + comment: string + } + } + } + } /** Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - "actions/re-run-workflow": { + 'actions/re-run-workflow': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; - }; + run_id: components['parameters']['run-id'] + } + } responses: { /** Response */ 201: { content: { - "application/json": { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': { [key: string]: unknown } + } + } + } + } /** * Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/get-workflow-run-usage": { + 'actions/get-workflow-run-usage': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; - }; + run_id: components['parameters']['run-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["workflow-run-usage"]; - }; - }; - }; - }; + 'application/json': components['schemas']['workflow-run-usage'] + } + } + } + } /** Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - "actions/list-repo-secrets": { + 'actions/list-repo-secrets': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - secrets: components["schemas"]["actions-secret"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + secrets: components['schemas']['actions-secret'][] + } + } + } + } + } /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - "actions/get-repo-public-key": { + 'actions/get-repo-public-key': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-public-key"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-public-key'] + } + } + } + } /** Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - "actions/get-repo-secret": { + 'actions/get-repo-secret': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-secret"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-secret'] + } + } + } + } /** * Creates or updates a repository secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -27516,116 +27499,116 @@ export type operations = { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - "actions/create-or-update-repo-secret": { + 'actions/create-or-update-repo-secret': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response when creating a secret */ 201: { content: { - "application/json": { [key: string]: unknown }; - }; - }; + 'application/json': { [key: string]: unknown } + } + } /** Response when updating a secret */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/reference/actions#get-a-repository-public-key) endpoint. */ - encrypted_value?: string; + encrypted_value?: string /** @description ID of the key you used to encrypt the secret. */ - key_id?: string; - }; - }; - }; - }; + key_id?: string + } + } + } + } /** Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - "actions/delete-repo-secret": { + 'actions/delete-repo-secret': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/list-repo-workflows": { + 'actions/list-repo-workflows': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - workflows: components["schemas"]["workflow"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + workflows: components['schemas']['workflow'][] + } + } + } + } + } /** Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/get-workflow": { + 'actions/get-workflow': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The ID of the workflow. You can also pass the workflow file name as a string. */ - workflow_id: components["parameters"]["workflow-id"]; - }; - }; + workflow_id: components['parameters']['workflow-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["workflow"]; - }; - }; - }; - }; + 'application/json': components['schemas']['workflow'] + } + } + } + } /** * Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - "actions/disable-workflow": { + 'actions/disable-workflow': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The ID of the workflow. You can also pass the workflow file name as a string. */ - workflow_id: components["parameters"]["workflow-id"]; - }; - }; + workflow_id: components['parameters']['workflow-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * @@ -27633,144 +27616,144 @@ export type operations = { * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)." */ - "actions/create-workflow-dispatch": { + 'actions/create-workflow-dispatch': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The ID of the workflow. You can also pass the workflow file name as a string. */ - workflow_id: components["parameters"]["workflow-id"]; - }; - }; + workflow_id: components['parameters']['workflow-id'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The git reference for the workflow. The reference can be a branch or tag name. */ - ref: string; + ref: string /** @description Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted. */ - inputs?: { [key: string]: string }; - }; - }; - }; - }; + inputs?: { [key: string]: string } + } + } + } + } /** * Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - "actions/enable-workflow": { + 'actions/enable-workflow': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The ID of the workflow. You can also pass the workflow file name as a string. */ - workflow_id: components["parameters"]["workflow-id"]; - }; - }; + workflow_id: components['parameters']['workflow-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). * * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. */ - "actions/list-workflow-runs": { + 'actions/list-workflow-runs': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The ID of the workflow. You can also pass the workflow file name as a string. */ - workflow_id: components["parameters"]["workflow-id"]; - }; + workflow_id: components['parameters']['workflow-id'] + } query: { /** Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ - actor?: components["parameters"]["actor"]; + actor?: components['parameters']['actor'] /** Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ - branch?: components["parameters"]["workflow-run-branch"]; + branch?: components['parameters']['workflow-run-branch'] /** Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ - event?: components["parameters"]["event"]; + event?: components['parameters']['event'] /** Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. For a list of the possible `status` and `conclusion` options, see "[Create a check run](https://docs.github.com/rest/reference/checks#create-a-check-run)." */ - status?: components["parameters"]["workflow-run-status"]; + status?: components['parameters']['workflow-run-status'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ - created?: components["parameters"]["created"]; + created?: components['parameters']['created'] /** If `true` pull requests are omitted from the response (empty array). */ - exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; + exclude_pull_requests?: components['parameters']['exclude-pull-requests'] /** Returns workflow runs with the `check_suite_id` that you specify. */ - check_suite_id?: components["parameters"]["workflow-run-check-suite-id"]; - }; - }; + check_suite_id?: components['parameters']['workflow-run-check-suite-id'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - workflow_runs: components["schemas"]["workflow-run"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + workflow_runs: components['schemas']['workflow-run'][] + } + } + } + } + } /** * Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * * You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/get-workflow-usage": { + 'actions/get-workflow-usage': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The ID of the workflow. You can also pass the workflow file name as a string. */ - workflow_id: components["parameters"]["workflow-id"]; - }; - }; + workflow_id: components['parameters']['workflow-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["workflow-usage"]; - }; - }; - }; - }; + 'application/json': components['schemas']['workflow-usage'] + } + } + } + } /** Lists the [available assignees](https://docs.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. */ - "issues/list-assignees": { + 'issues/list-assignees': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + 404: components['responses']['not_found'] + } + } /** * Checks if a user has permission to be assigned to an issue in this repository. * @@ -27778,218 +27761,218 @@ export type operations = { * * Otherwise a `404` status code is returned. */ - "issues/check-user-can-be-assigned": { + 'issues/check-user-can-be-assigned': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - assignee: string; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + assignee: string + } + } responses: { /** If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. */ - 204: never; + 204: never /** Otherwise a `404` status code is returned. */ 404: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } + } + } /** * This returns a list of autolinks configured for the given repository. * * Information about autolinks are only available to repository administrators. */ - "repos/list-autolinks": { + 'repos/list-autolinks': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["autolink"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['autolink'][] + } + } + } + } /** Users with admin access to the repository can create an autolink. */ - "repos/create-autolink": { + 'repos/create-autolink': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["autolink"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['autolink'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit. */ - key_prefix: string; + key_prefix: string /** @description The URL must contain for the reference number. */ - url_template: string; - }; - }; - }; - }; + url_template: string + } + } + } + } /** * This returns a single autolink reference by ID that was configured for the given repository. * * Information about autolinks are only available to repository administrators. */ - "repos/get-autolink": { + 'repos/get-autolink': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** autolink_id parameter */ - autolink_id: components["parameters"]["autolink-id"]; - }; - }; + autolink_id: components['parameters']['autolink-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["autolink"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['autolink'] + } + } + 404: components['responses']['not_found'] + } + } /** * This deletes a single autolink reference by ID that was configured for the given repository. * * Information about autolinks are only available to repository administrators. */ - "repos/delete-autolink": { + 'repos/delete-autolink': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** autolink_id parameter */ - autolink_id: components["parameters"]["autolink-id"]; - }; - }; + autolink_id: components['parameters']['autolink-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/en/articles/configuring-automated-security-fixes)". */ - "repos/enable-automated-security-fixes": { + 'repos/enable-automated-security-fixes': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/en/articles/configuring-automated-security-fixes)". */ - "repos/disable-automated-security-fixes": { + 'repos/disable-automated-security-fixes': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; - }; - "repos/list-branches": { + 204: never + } + } + 'repos/list-branches': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches. */ - protected?: boolean; + protected?: boolean /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["short-branch"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "repos/get-branch": { + 'application/json': components['schemas']['short-branch'][] + } + } + 404: components['responses']['not_found'] + } + } + 'repos/get-branch': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["branch-with-protection"]; - }; - }; - 301: components["responses"]["moved_permanently"]; - 404: components["responses"]["not_found"]; - 415: components["responses"]["preview_header_missing"]; - }; - }; + 'application/json': components['schemas']['branch-with-protection'] + } + } + 301: components['responses']['moved_permanently'] + 404: components['responses']['not_found'] + 415: components['responses']['preview_header_missing'] + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "repos/get-branch-protection": { + 'repos/get-branch-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["branch-protection"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['branch-protection'] + } + } + 404: components['responses']['not_found'] + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -27999,205 +27982,205 @@ export type operations = { * * **Note**: The list of users, apps, and teams in total is limited to 100 items. */ - "repos/update-branch-protection": { + 'repos/update-branch-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["protected-branch"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': components['schemas']['protected-branch'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Require status checks to pass before merging. Set to `null` to disable. */ required_status_checks: { /** @description Require branches to be up to date before merging. */ - strict: boolean; + strict: boolean /** * @deprecated * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. */ - contexts: string[]; + contexts: string[] /** @description The list of status checks to require in order to merge into this branch. */ checks?: { /** @description The name of the required check */ - context: string; + context: string /** @description The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status. */ - app_id?: number; - }[]; - } | null; + app_id?: number + }[] + } | null /** @description Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable. */ - enforce_admins: boolean | null; + enforce_admins: boolean | null /** @description Require at least one approving review on a pull request, before merging. Set to `null` to disable. */ required_pull_request_reviews: { /** @description Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories. */ dismissal_restrictions?: { /** @description The list of user `login`s with dismissal access */ - users?: string[]; + users?: string[] /** @description The list of team `slug`s with dismissal access */ - teams?: string[]; - }; + teams?: string[] + } /** @description Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit. */ - dismiss_stale_reviews?: boolean; + dismiss_stale_reviews?: boolean /** @description Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them. */ - require_code_owner_reviews?: boolean; + require_code_owner_reviews?: boolean /** @description Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers. */ - required_approving_review_count?: number; + required_approving_review_count?: number /** @description Allow specific users or teams to bypass pull request requirements. Set to `null` to disable. */ bypass_pull_request_allowances?: { /** @description The list of user `login`s allowed to bypass pull request requirements. */ - users?: string[]; + users?: string[] /** @description The list of team `slug`s allowed to bypass pull request requirements. */ - teams?: string[]; - } | null; - } | null; + teams?: string[] + } | null + } | null /** @description Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable. */ restrictions: { /** @description The list of user `login`s with push access */ - users: string[]; + users: string[] /** @description The list of team `slug`s with push access */ - teams: string[]; + teams: string[] /** @description The list of app `slug`s with push access */ - apps?: string[]; - } | null; + apps?: string[] + } | null /** @description Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see "[Requiring a linear commit history](https://docs.github.com/github/administering-a-repository/requiring-a-linear-commit-history)" in the GitHub Help documentation. */ - required_linear_history?: boolean; + required_linear_history?: boolean /** @description Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation." */ - allow_force_pushes?: boolean | null; + allow_force_pushes?: boolean | null /** @description Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation. */ - allow_deletions?: boolean; + allow_deletions?: boolean /** @description Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`. */ - required_conversation_resolution?: boolean; - }; - }; - }; - }; + required_conversation_resolution?: boolean + } + } + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "repos/delete-branch-protection": { + 'repos/delete-branch-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ - 204: never; - 403: components["responses"]["forbidden"]; - }; - }; + 204: never + 403: components['responses']['forbidden'] + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "repos/get-admin-branch-protection": { + 'repos/get-admin-branch-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["protected-branch-admin-enforced"]; - }; - }; - }; - }; + 'application/json': components['schemas']['protected-branch-admin-enforced'] + } + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ - "repos/set-admin-branch-protection": { + 'repos/set-admin-branch-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["protected-branch-admin-enforced"]; - }; - }; - }; - }; + 'application/json': components['schemas']['protected-branch-admin-enforced'] + } + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ - "repos/delete-admin-branch-protection": { + 'repos/delete-admin-branch-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "repos/get-pull-request-review-protection": { + 'repos/get-pull-request-review-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["protected-branch-pull-request-review"]; - }; - }; - }; - }; + 'application/json': components['schemas']['protected-branch-pull-request-review'] + } + } + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "repos/delete-pull-request-review-protection": { + 'repos/delete-pull-request-review-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28205,51 +28188,51 @@ export type operations = { * * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. */ - "repos/update-pull-request-review-protection": { + 'repos/update-pull-request-review-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["protected-branch-pull-request-review"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['protected-branch-pull-request-review'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories. */ dismissal_restrictions?: { /** @description The list of user `login`s with dismissal access */ - users?: string[]; + users?: string[] /** @description The list of team `slug`s with dismissal access */ - teams?: string[]; - }; + teams?: string[] + } /** @description Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit. */ - dismiss_stale_reviews?: boolean; + dismiss_stale_reviews?: boolean /** @description Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) have reviewed. */ - require_code_owner_reviews?: boolean; + require_code_owner_reviews?: boolean /** @description Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers. */ - required_approving_review_count?: number; + required_approving_review_count?: number /** @description Allow specific users or teams to bypass pull request requirements. Set to `null` to disable. */ bypass_pull_request_allowances?: { /** @description The list of user `login`s allowed to bypass pull request requirements. */ - users?: string[]; + users?: string[] /** @description The list of team `slug`s allowed to bypass pull request requirements. */ - teams?: string[]; - } | null; - }; - }; - }; - }; + teams?: string[] + } | null + } + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28257,263 +28240,263 @@ export type operations = { * * **Note**: You must enable branch protection to require signed commits. */ - "repos/get-commit-signature-protection": { + 'repos/get-commit-signature-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["protected-branch-admin-enforced"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['protected-branch-admin-enforced'] + } + } + 404: components['responses']['not_found'] + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits. */ - "repos/create-commit-signature-protection": { + 'repos/create-commit-signature-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["protected-branch-admin-enforced"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['protected-branch-admin-enforced'] + } + } + 404: components['responses']['not_found'] + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits. */ - "repos/delete-commit-signature-protection": { + 'repos/delete-commit-signature-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "repos/get-status-checks-protection": { + 'repos/get-status-checks-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["status-check-policy"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['status-check-policy'] + } + } + 404: components['responses']['not_found'] + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "repos/remove-status-check-protection": { + 'repos/remove-status-check-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. */ - "repos/update-status-check-protection": { + 'repos/update-status-check-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["status-check-policy"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['status-check-policy'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Require branches to be up to date before merging. */ - strict?: boolean; + strict?: boolean /** * @deprecated * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. */ - contexts?: string[]; + contexts?: string[] /** @description The list of status checks to require in order to merge into this branch. */ checks?: { /** @description The name of the required check */ - context: string; + context: string /** @description The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status. */ - app_id?: number; - }[]; - }; - }; - }; - }; + app_id?: number + }[] + } + } + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "repos/get-all-status-check-contexts": { + 'repos/get-all-status-check-contexts': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": string[]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': string[] + } + } + 404: components['responses']['not_found'] + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "repos/set-status-check-contexts": { + 'repos/set-status-check-contexts': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": string[]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': string[] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description contexts parameter */ - contexts: string[]; + contexts: string[] } - | string[]; - }; - }; - }; + | string[] + } + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "repos/add-status-check-contexts": { + 'repos/add-status-check-contexts': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": string[]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': string[] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description contexts parameter */ - contexts: string[]; + contexts: string[] } - | string[]; - }; - }; - }; + | string[] + } + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "repos/remove-status-check-contexts": { + 'repos/remove-status-check-contexts': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": string[]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': string[] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description contexts parameter */ - contexts: string[]; + contexts: string[] } - | string[]; - }; - }; - }; + | string[] + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28521,68 +28504,68 @@ export type operations = { * * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. */ - "repos/get-access-restrictions": { + 'repos/get-access-restrictions': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["branch-restriction-policy"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['branch-restriction-policy'] + } + } + 404: components['responses']['not_found'] + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Disables the ability to restrict who can push to this branch. */ - "repos/delete-access-restrictions": { + 'repos/delete-access-restrictions': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. */ - "repos/get-apps-with-access-to-protected-branch": { + 'repos/get-apps-with-access-to-protected-branch': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["integration"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['integration'][] + } + } + 404: components['responses']['not_found'] + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28592,35 +28575,35 @@ export type operations = { * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - "repos/set-app-access-restrictions": { + 'repos/set-app-access-restrictions': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["integration"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['integration'][] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description apps parameter */ - apps: string[]; + apps: string[] } - | string[]; - }; - }; - }; + | string[] + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28630,35 +28613,35 @@ export type operations = { * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - "repos/add-app-access-restrictions": { + 'repos/add-app-access-restrictions': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["integration"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['integration'][] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description apps parameter */ - apps: string[]; + apps: string[] } - | string[]; - }; - }; - }; + | string[] + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28668,59 +28651,59 @@ export type operations = { * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - "repos/remove-app-access-restrictions": { + 'repos/remove-app-access-restrictions': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["integration"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['integration'][] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description apps parameter */ - apps: string[]; + apps: string[] } - | string[]; - }; - }; - }; + | string[] + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the teams who have push access to this branch. The list includes child teams. */ - "repos/get-teams-with-access-to-protected-branch": { + 'repos/get-teams-with-access-to-protected-branch': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['team'][] + } + } + 404: components['responses']['not_found'] + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28730,35 +28713,35 @@ export type operations = { * | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ | * | `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - "repos/set-team-access-restrictions": { + 'repos/set-team-access-restrictions': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['team'][] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description teams parameter */ - teams: string[]; + teams: string[] } - | string[]; - }; - }; - }; + | string[] + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28768,35 +28751,35 @@ export type operations = { * | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ | * | `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - "repos/add-team-access-restrictions": { + 'repos/add-team-access-restrictions': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['team'][] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description teams parameter */ - teams: string[]; + teams: string[] } - | string[]; - }; - }; - }; + | string[] + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28806,59 +28789,59 @@ export type operations = { * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | Teams that should no longer have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - "repos/remove-team-access-restrictions": { + 'repos/remove-team-access-restrictions': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['team'][] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description teams parameter */ - teams: string[]; + teams: string[] } - | string[]; - }; - }; - }; + | string[] + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the people who have push access to this branch. */ - "repos/get-users-with-access-to-protected-branch": { + 'repos/get-users-with-access-to-protected-branch': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + 404: components['responses']['not_found'] + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28868,35 +28851,35 @@ export type operations = { * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - "repos/set-user-access-restrictions": { + 'repos/set-user-access-restrictions': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description users parameter */ - users: string[]; + users: string[] } - | string[]; - }; - }; - }; + | string[] + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28906,35 +28889,35 @@ export type operations = { * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - "repos/add-user-access-restrictions": { + 'repos/add-user-access-restrictions': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description users parameter */ - users: string[]; + users: string[] } - | string[]; - }; - }; - }; + | string[] + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28944,35 +28927,35 @@ export type operations = { * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - "repos/remove-user-access-restrictions": { + 'repos/remove-user-access-restrictions': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description users parameter */ - users: string[]; + users: string[] } - | string[]; - }; - }; - }; + | string[] + } + } + } /** * Renames a branch in a repository. * @@ -28990,35 +28973,35 @@ export type operations = { * * Users must have admin or owner permissions. * * GitHub Apps must have the `administration:write` repository permission. */ - "repos/rename-branch": { + 'repos/rename-branch': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["branch-with-protection"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['branch-with-protection'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The new name of the branch. */ - new_name: string; - }; - }; - }; - }; + new_name: string + } + } + } + } /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * @@ -29026,494 +29009,478 @@ export type operations = { * * In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. */ - "checks/create": { + 'checks/create': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["check-run"]; - }; - }; - }; + 'application/json': components['schemas']['check-run'] + } + } + } requestBody: { content: { - "application/json": ( + 'application/json': ( | ({ /** @enum {undefined} */ - status: "completed"; + status: 'completed' } & { - conclusion: unknown; + conclusion: unknown } & { [key: string]: unknown }) | ({ /** @enum {undefined} */ - status?: "queued" | "in_progress"; + status?: 'queued' | 'in_progress' } & { [key: string]: unknown }) ) & { /** @description The name of the check. For example, "code-coverage". */ - name: string; + name: string /** @description The SHA of the commit. */ - head_sha: string; + head_sha: string /** @description The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used. */ - details_url?: string; + details_url?: string /** @description A reference for the run on the integrator's system. */ - external_id?: string; + external_id?: string /** * @description The current status. Can be one of `queued`, `in_progress`, or `completed`. * @default queued * @enum {string} */ - status?: "queued" | "in_progress" | "completed"; + status?: 'queued' | 'in_progress' | 'completed' /** * Format: date-time * @description The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - started_at?: string; + started_at?: string /** * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. * @enum {string} */ - conclusion?: - | "action_required" - | "cancelled" - | "failure" - | "neutral" - | "success" - | "skipped" - | "stale" - | "timed_out"; + conclusion?: 'action_required' | 'cancelled' | 'failure' | 'neutral' | 'success' | 'skipped' | 'stale' | 'timed_out' /** * Format: date-time * @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - completed_at?: string; + completed_at?: string /** @description Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/rest/reference/checks#output-object) description. */ output?: { /** @description The title of the check run. */ - title: string; + title: string /** @description The summary of the check run. This parameter supports Markdown. */ - summary: string; + summary: string /** @description The details of the check run. This parameter supports Markdown. */ - text?: string; + text?: string /** @description Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". See the [`annotations` object](https://docs.github.com/rest/reference/checks#annotations-object) description for details about how to use this parameter. */ annotations?: { /** @description The path of the file to add an annotation to. For example, `assets/css/main.css`. */ - path: string; + path: string /** @description The start line of the annotation. */ - start_line: number; + start_line: number /** @description The end line of the annotation. */ - end_line: number; + end_line: number /** @description The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */ - start_column?: number; + start_column?: number /** @description The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */ - end_column?: number; + end_column?: number /** * @description The level of the annotation. Can be one of `notice`, `warning`, or `failure`. * @enum {string} */ - annotation_level: "notice" | "warning" | "failure"; + annotation_level: 'notice' | 'warning' | 'failure' /** @description A short description of the feedback for these lines of code. The maximum size is 64 KB. */ - message: string; + message: string /** @description The title that represents the annotation. The maximum size is 255 characters. */ - title?: string; + title?: string /** @description Details about this annotation. The maximum size is 64 KB. */ - raw_details?: string; - }[]; + raw_details?: string + }[] /** @description Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/rest/reference/checks#images-object) description for details. */ images?: { /** @description The alternative text for the image. */ - alt: string; + alt: string /** @description The full URL of the image. */ - image_url: string; + image_url: string /** @description A short image description. */ - caption?: string; - }[]; - }; + caption?: string + }[] + } /** @description Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions)." */ actions?: { /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ - label: string; + label: string /** @description A short explanation of what this action would do. The maximum size is 40 characters. */ - description: string; + description: string /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ - identifier: string; - }[]; - }; - }; - }; - }; + identifier: string + }[] + } + } + } + } /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * Gets a single check run using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. */ - "checks/get": { + 'checks/get': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** check_run_id parameter */ - check_run_id: components["parameters"]["check-run-id"]; - }; - }; + check_run_id: components['parameters']['check-run-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["check-run"]; - }; - }; - }; - }; + 'application/json': components['schemas']['check-run'] + } + } + } + } /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. */ - "checks/update": { + 'checks/update': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** check_run_id parameter */ - check_run_id: components["parameters"]["check-run-id"]; - }; - }; + check_run_id: components['parameters']['check-run-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["check-run"]; - }; - }; - }; + 'application/json': components['schemas']['check-run'] + } + } + } requestBody: { content: { - "application/json": (Partial< + 'application/json': (Partial< { /** @enum {undefined} */ - status?: "completed"; + status?: 'completed' } & { - conclusion: unknown; + conclusion: unknown } & { [key: string]: unknown } > & Partial< { /** @enum {undefined} */ - status?: "queued" | "in_progress"; + status?: 'queued' | 'in_progress' } & { [key: string]: unknown } >) & { /** @description The name of the check. For example, "code-coverage". */ - name?: string; + name?: string /** @description The URL of the integrator's site that has the full details of the check. */ - details_url?: string; + details_url?: string /** @description A reference for the run on the integrator's system. */ - external_id?: string; + external_id?: string /** * Format: date-time * @description This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - started_at?: string; + started_at?: string /** * @description The current status. Can be one of `queued`, `in_progress`, or `completed`. * @enum {string} */ - status?: "queued" | "in_progress" | "completed"; + status?: 'queued' | 'in_progress' | 'completed' /** * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. * @enum {string} */ - conclusion?: - | "action_required" - | "cancelled" - | "failure" - | "neutral" - | "success" - | "skipped" - | "stale" - | "timed_out"; + conclusion?: 'action_required' | 'cancelled' | 'failure' | 'neutral' | 'success' | 'skipped' | 'stale' | 'timed_out' /** * Format: date-time * @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - completed_at?: string; + completed_at?: string /** @description Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/rest/reference/checks#output-object-1) description. */ output?: { /** @description **Required**. */ - title?: string; + title?: string /** @description Can contain Markdown. */ - summary: string; + summary: string /** @description Can contain Markdown. */ - text?: string; + text?: string /** @description Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". See the [`annotations` object](https://docs.github.com/rest/reference/checks#annotations-object-1) description for details. */ annotations?: { /** @description The path of the file to add an annotation to. For example, `assets/css/main.css`. */ - path: string; + path: string /** @description The start line of the annotation. */ - start_line: number; + start_line: number /** @description The end line of the annotation. */ - end_line: number; + end_line: number /** @description The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */ - start_column?: number; + start_column?: number /** @description The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */ - end_column?: number; + end_column?: number /** * @description The level of the annotation. Can be one of `notice`, `warning`, or `failure`. * @enum {string} */ - annotation_level: "notice" | "warning" | "failure"; + annotation_level: 'notice' | 'warning' | 'failure' /** @description A short description of the feedback for these lines of code. The maximum size is 64 KB. */ - message: string; + message: string /** @description The title that represents the annotation. The maximum size is 255 characters. */ - title?: string; + title?: string /** @description Details about this annotation. The maximum size is 64 KB. */ - raw_details?: string; - }[]; + raw_details?: string + }[] /** @description Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/rest/reference/checks#annotations-object-1) description for details. */ images?: { /** @description The alternative text for the image. */ - alt: string; + alt: string /** @description The full URL of the image. */ - image_url: string; + image_url: string /** @description A short image description. */ - caption?: string; - }[]; - }; + caption?: string + }[] + } /** @description Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions)." */ actions?: { /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ - label: string; + label: string /** @description A short explanation of what this action would do. The maximum size is 40 characters. */ - description: string; + description: string /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ - identifier: string; - }[]; - }; - }; - }; - }; + identifier: string + }[] + } + } + } + } /** Lists annotations for a check run using the annotation `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the `repo` scope to get annotations for a check run in a private repository. */ - "checks/list-annotations": { + 'checks/list-annotations': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** check_run_id parameter */ - check_run_id: components["parameters"]["check-run-id"]; - }; + check_run_id: components['parameters']['check-run-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["check-annotation"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['check-annotation'][] + } + } + } + } /** * Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * * To rerequest a check run, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository. */ - "checks/rerequest-run": { + 'checks/rerequest-run': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** check_run_id parameter */ - check_run_id: components["parameters"]["check-run-id"]; - }; - }; + check_run_id: components['parameters']['check-run-id'] + } + } responses: { /** Response */ 201: { content: { - "application/json": { [key: string]: unknown }; - }; - }; + 'application/json': { [key: string]: unknown } + } + } /** Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App */ 403: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - 404: components["responses"]["not_found"]; + 'application/json': components['schemas']['basic-error'] + } + } + 404: components['responses']['not_found'] /** Validation error if the check run is not rerequestable */ 422: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } + } + } /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * * By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/reference/checks#check-runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/reference/checks#update-repository-preferences-for-check-suites)". Your GitHub App must have the `checks:write` permission to create check suites. */ - "checks/create-suite": { + 'checks/create-suite': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** when the suite already existed */ 200: { content: { - "application/json": components["schemas"]["check-suite"]; - }; - }; + 'application/json': components['schemas']['check-suite'] + } + } /** Response when the suite was created */ 201: { content: { - "application/json": components["schemas"]["check-suite"]; - }; - }; - }; + 'application/json': components['schemas']['check-suite'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The sha of the head commit. */ - head_sha: string; - }; - }; - }; - }; + head_sha: string + } + } + } + } /** Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/reference/checks#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites. */ - "checks/set-suites-preferences": { + 'checks/set-suites-preferences': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["check-suite-preference"]; - }; - }; - }; + 'application/json': components['schemas']['check-suite-preference'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/rest/reference/checks#auto_trigger_checks-object) description for details. */ auto_trigger_checks?: { /** @description The `id` of the GitHub App. */ - app_id: number; + app_id: number /** * @description Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them. * @default true */ - setting: boolean; - }[]; - }; - }; - }; - }; + setting: boolean + }[] + } + } + } + } /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * * Gets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository. */ - "checks/get-suite": { + 'checks/get-suite': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** check_suite_id parameter */ - check_suite_id: components["parameters"]["check-suite-id"]; - }; - }; + check_suite_id: components['parameters']['check-suite-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["check-suite"]; - }; - }; - }; - }; + 'application/json': components['schemas']['check-suite'] + } + } + } + } /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. */ - "checks/list-for-suite": { + 'checks/list-for-suite': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** check_suite_id parameter */ - check_suite_id: components["parameters"]["check-suite-id"]; - }; + check_suite_id: components['parameters']['check-suite-id'] + } query: { /** Returns check runs with the specified `name`. */ - check_name?: components["parameters"]["check-name"]; + check_name?: components['parameters']['check-name'] /** Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`. */ - status?: components["parameters"]["status"]; + status?: components['parameters']['status'] /** Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`. */ - filter?: "latest" | "all"; + filter?: 'latest' | 'all' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - check_runs: components["schemas"]["check-run"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + check_runs: components['schemas']['check-run'][] + } + } + } + } + } /** * Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * * To rerequest a check suite, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository. */ - "checks/rerequest-suite": { + 'checks/rerequest-suite': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** check_suite_id parameter */ - check_suite_id: components["parameters"]["check-suite-id"]; - }; - }; + check_suite_id: components['parameters']['check-suite-id'] + } + } responses: { /** Response */ 201: { content: { - "application/json": { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': { [key: string]: unknown } + } + } + } + } /** * Lists all open code scanning alerts for the default branch (usually `main` * or `master`). You must use an access token with the `security_events` scope to use @@ -29526,137 +29493,137 @@ export type operations = { * for the default branch or for the specified Git reference * (if you used `ref` in the request). */ - "code-scanning/list-alerts-for-repo": { + 'code-scanning/list-alerts-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */ - tool_name?: components["parameters"]["tool-name"]; + tool_name?: components['parameters']['tool-name'] /** The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ - tool_guid?: components["parameters"]["tool-guid"]; + tool_guid?: components['parameters']['tool-guid'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ - ref?: components["parameters"]["git-ref"]; + ref?: components['parameters']['git-ref'] /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Can be one of `created`, `updated`, `number`. */ - sort?: "created" | "updated" | "number"; + sort?: 'created' | 'updated' | 'number' /** Set to `open`, `closed, `fixed`, or `dismissed` to list code scanning alerts in a specific state. */ - state?: components["schemas"]["code-scanning-alert-state"]; - }; - }; + state?: components['schemas']['code-scanning-alert-state'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["code-scanning-alert-items"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["code_scanning_forbidden_read"]; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': components['schemas']['code-scanning-alert-items'][] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['code_scanning_forbidden_read'] + 404: components['responses']['not_found'] + 503: components['responses']['service_unavailable'] + } + } /** * Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint. * * **Deprecation notice**: * The instances field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The same information can now be retrieved via a GET request to the URL specified by `instances_url`. */ - "code-scanning/get-alert": { + 'code-scanning/get-alert': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ - alert_number: components["parameters"]["alert-number"]; - }; - }; + alert_number: components['parameters']['alert-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["code-scanning-alert"]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["code_scanning_forbidden_read"]; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': components['schemas']['code-scanning-alert'] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['code_scanning_forbidden_read'] + 404: components['responses']['not_found'] + 503: components['responses']['service_unavailable'] + } + } /** Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. */ - "code-scanning/update-alert": { + 'code-scanning/update-alert': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ - alert_number: components["parameters"]["alert-number"]; - }; - }; + alert_number: components['parameters']['alert-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["code-scanning-alert"]; - }; - }; - 403: components["responses"]["code_scanning_forbidden_write"]; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; - }; + 'application/json': components['schemas']['code-scanning-alert'] + } + } + 403: components['responses']['code_scanning_forbidden_write'] + 404: components['responses']['not_found'] + 503: components['responses']['service_unavailable'] + } requestBody: { content: { - "application/json": { - state: components["schemas"]["code-scanning-alert-set-state"]; - dismissed_reason?: components["schemas"]["code-scanning-alert-dismissed-reason"]; - }; - }; - }; - }; + 'application/json': { + state: components['schemas']['code-scanning-alert-set-state'] + dismissed_reason?: components['schemas']['code-scanning-alert-dismissed-reason'] + } + } + } + } /** * Lists all instances of the specified code scanning alert. * You must use an access token with the `security_events` scope to use this endpoint with private repos, * the `public_repo` scope also grants permission to read security events on public repos only. * GitHub Apps must have the `security_events` read permission to use this endpoint. */ - "code-scanning/list-alert-instances": { + 'code-scanning/list-alert-instances': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ - alert_number: components["parameters"]["alert-number"]; - }; + alert_number: components['parameters']['alert-number'] + } query: { /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ - ref?: components["parameters"]["git-ref"]; - }; - }; + ref?: components['parameters']['git-ref'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["code-scanning-alert-instance"][]; - }; - }; - 403: components["responses"]["code_scanning_forbidden_read"]; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': components['schemas']['code-scanning-alert-instance'][] + } + } + 403: components['responses']['code_scanning_forbidden_read'] + 404: components['responses']['not_found'] + 503: components['responses']['service_unavailable'] + } + } /** * Lists the details of all code scanning analyses for a repository, * starting with the most recent. @@ -29676,39 +29643,39 @@ export type operations = { * **Deprecation notice**: * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. */ - "code-scanning/list-recent-analyses": { + 'code-scanning/list-recent-analyses': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */ - tool_name?: components["parameters"]["tool-name"]; + tool_name?: components['parameters']['tool-name'] /** The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ - tool_guid?: components["parameters"]["tool-guid"]; + tool_guid?: components['parameters']['tool-guid'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ - ref?: components["schemas"]["code-scanning-ref"]; + ref?: components['schemas']['code-scanning-ref'] /** Filter analyses belonging to the same SARIF upload. */ - sarif_id?: components["schemas"]["code-scanning-analysis-sarif-id"]; - }; - }; + sarif_id?: components['schemas']['code-scanning-analysis-sarif-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["code-scanning-analysis"][]; - }; - }; - 403: components["responses"]["code_scanning_forbidden_read"]; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': components['schemas']['code-scanning-analysis'][] + } + } + 403: components['responses']['code_scanning_forbidden_read'] + 404: components['responses']['not_found'] + 503: components['responses']['service_unavailable'] + } + } /** * Gets a specified code scanning analysis for a repository. * You must use an access token with the `security_events` scope to use this endpoint with private repos, @@ -29730,28 +29697,28 @@ export type operations = { * This is formatted as * [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). */ - "code-scanning/get-analysis": { + 'code-scanning/get-analysis': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation. */ - analysis_id: number; - }; - }; + analysis_id: number + } + } responses: { /** Response */ 200: { content: { - "application/json+sarif": string; - "application/json": components["schemas"]["code-scanning-analysis"]; - }; - }; - 403: components["responses"]["code_scanning_forbidden_read"]; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json+sarif': string + 'application/json': components['schemas']['code-scanning-analysis'] + } + } + 403: components['responses']['code_scanning_forbidden_read'] + 404: components['responses']['not_found'] + 503: components['responses']['service_unavailable'] + } + } /** * Deletes a specified code scanning analysis from a repository. For * private repositories, you must use an access token with the `repo` scope. For public repositories, @@ -29820,32 +29787,32 @@ export type operations = { * * The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely. */ - "code-scanning/delete-analysis": { + 'code-scanning/delete-analysis': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation. */ - analysis_id: number; - }; + analysis_id: number + } query: { /** Allow deletion if the specified analysis is the last in a set. If you attempt to delete the final analysis in a set without setting this parameter to `true`, you'll get a 400 response with the message: `Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.` */ - confirm_delete?: string | null; - }; - }; + confirm_delete?: string | null + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["code-scanning-analysis-deletion"]; - }; - }; - 400: components["responses"]["bad_request"]; - 403: components["responses"]["code_scanning_forbidden_write"]; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': components['schemas']['code-scanning-analysis-deletion'] + } + } + 400: components['responses']['bad_request'] + 403: components['responses']['code_scanning_forbidden_write'] + 404: components['responses']['not_found'] + 503: components['responses']['service_unavailable'] + } + } /** * Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. * @@ -29865,155 +29832,155 @@ export type operations = { * You can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint. * For more information, see "[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload)." */ - "code-scanning/upload-sarif": { + 'code-scanning/upload-sarif': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 202: { content: { - "application/json": components["schemas"]["code-scanning-sarifs-receipt"]; - }; - }; + 'application/json': components['schemas']['code-scanning-sarifs-receipt'] + } + } /** Bad Request if the sarif field is invalid */ - 400: unknown; - 403: components["responses"]["code_scanning_forbidden_write"]; - 404: components["responses"]["not_found"]; + 400: unknown + 403: components['responses']['code_scanning_forbidden_write'] + 404: components['responses']['not_found'] /** Payload Too Large if the sarif field is too large */ - 413: unknown; - 503: components["responses"]["service_unavailable"]; - }; + 413: unknown + 503: components['responses']['service_unavailable'] + } requestBody: { content: { - "application/json": { - commit_sha: components["schemas"]["code-scanning-analysis-commit-sha"]; - ref: components["schemas"]["code-scanning-ref"]; - sarif: components["schemas"]["code-scanning-analysis-sarif-file"]; + 'application/json': { + commit_sha: components['schemas']['code-scanning-analysis-commit-sha'] + ref: components['schemas']['code-scanning-ref'] + sarif: components['schemas']['code-scanning-analysis-sarif-file'] /** * Format: uri * @description The base directory used in the analysis, as it appears in the SARIF file. * This property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository. * @example file:///github/workspace/ */ - checkout_uri?: string; + checkout_uri?: string /** * Format: date-time * @description The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - started_at?: string; + started_at?: string /** @description The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to "API". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`. */ - tool_name?: string; - }; - }; - }; - }; + tool_name?: string + } + } + } + } /** Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository)." You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint. */ - "code-scanning/get-sarif": { + 'code-scanning/get-sarif': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The SARIF ID obtained after uploading. */ - sarif_id: string; - }; - }; + sarif_id: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["code-scanning-sarifs-status"]; - }; - }; - 403: components["responses"]["code_scanning_forbidden_read"]; + 'application/json': components['schemas']['code-scanning-sarifs-status'] + } + } + 403: components['responses']['code_scanning_forbidden_read'] /** Not Found if the sarif id does not match any upload */ - 404: unknown; - 503: components["responses"]["service_unavailable"]; - }; - }; + 404: unknown + 503: components['responses']['service_unavailable'] + } + } /** * Lists the codespaces associated to a specified repository and the authenticated user. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/list-in-repository-for-authenticated-user": { + 'codespaces/list-in-repository-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; + page?: components['parameters']['page'] + } path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - codespaces: components["schemas"]["codespace"][]; - }; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': { + total_count: number + codespaces: components['schemas']['codespace'][] + } + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** * Creates a codespace owned by the authenticated user in the specified repository. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/create-with-repo-for-authenticated-user": { + 'codespaces/create-with-repo-for-authenticated-user': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response when the codespace was successfully created */ 201: { content: { - "application/json": components["schemas"]["codespace"]; - }; - }; + 'application/json': components['schemas']['codespace'] + } + } /** Response when the codespace creation partially failed but is being retried in the background */ 202: { content: { - "application/json": components["schemas"]["codespace"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; + 'application/json': components['schemas']['codespace'] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Git ref (typically a branch name) for this codespace */ - ref?: string; + ref?: string /** @description Location for this codespace */ - location: string; + location: string /** @description Machine type to use for this codespace */ - machine?: string; + machine?: string /** @description Working directory for this codespace */ - working_directory?: string; + working_directory?: string /** @description Time in minutes before codespace stops from inactivity */ - idle_timeout_minutes?: number; - }; - }; - }; - }; + idle_timeout_minutes?: number + } + } + } + } /** * List the machine types available for a given repository based on its configuration. * @@ -30021,34 +29988,34 @@ export type operations = { * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/repo-machines-for-authenticated-user": { + 'codespaces/repo-machines-for-authenticated-user': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Required. The location to check for available machines. */ - location: string; - }; - }; + location: string + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - machines: components["schemas"]["codespace-machine"][]; - }; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': { + total_count: number + machines: components['schemas']['codespace-machine'][] + } + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** * For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. * @@ -30058,12 +30025,12 @@ export type operations = { * endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this * endpoint. */ - "repos/list-collaborators": { + 'repos/list-collaborators': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** * Filter collaborators returned by their affiliation. Can be one of: @@ -30071,24 +30038,24 @@ export type operations = { * \* `direct`: All collaborators with permissions to an organization-owned repository, regardless of organization membership status. * \* `all`: All collaborators the authenticated user can see. */ - affiliation?: "outside" | "direct" | "all"; + affiliation?: 'outside' | 'direct' | 'all' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["collaborator"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['collaborator'][] + } + } + 404: components['responses']['not_found'] + } + } /** * For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. * @@ -30098,21 +30065,21 @@ export type operations = { * endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this * endpoint. */ - "repos/check-collaborator": { + 'repos/check-collaborator': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - username: components["parameters"]["username"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + username: components['parameters']['username'] + } + } responses: { /** Response if user is a collaborator */ - 204: never; + 204: never /** Not Found if user is not a collaborator */ - 404: unknown; - }; - }; + 404: unknown + } + } /** * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. * @@ -30130,29 +30097,29 @@ export type operations = { * * You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository. */ - "repos/add-collaborator": { + 'repos/add-collaborator': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - username: components["parameters"]["username"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + username: components['parameters']['username'] + } + } responses: { /** Response when a new invitation is created */ 201: { content: { - "application/json": components["schemas"]["repository-invitation"]; - }; - }; + 'application/json': components['schemas']['repository-invitation'] + } + } /** Response when person is already a collaborator */ - 204: never; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + 204: never + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: * \* `pull` - can pull, but not push to or administer this repository. @@ -30164,221 +30131,221 @@ export type operations = { * @default push * @enum {string} */ - permission?: "pull" | "push" | "admin" | "maintain" | "triage"; + permission?: 'pull' | 'push' | 'admin' | 'maintain' | 'triage' /** @example "push" */ - permissions?: string; - }; - }; - }; - }; - "repos/remove-collaborator": { + permissions?: string + } + } + } + } + 'repos/remove-collaborator': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - username: components["parameters"]["username"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** Checks the repository permission of a collaborator. The possible repository permissions are `admin`, `write`, `read`, and `none`. */ - "repos/get-collaborator-permission-level": { + 'repos/get-collaborator-permission-level': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - username: components["parameters"]["username"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + username: components['parameters']['username'] + } + } responses: { /** if user has admin permissions */ 200: { content: { - "application/json": components["schemas"]["repository-collaborator-permission"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['repository-collaborator-permission'] + } + } + 404: components['responses']['not_found'] + } + } /** * Commit Comments use [these custom media types](https://docs.github.com/rest/reference/repos#custom-media-types). You can read more about the use of media types in the API [here](https://docs.github.com/rest/overview/media-types/). * * Comments are ordered by ascending ID. */ - "repos/list-commit-comments-for-repo": { + 'repos/list-commit-comments-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["commit-comment"][]; - }; - }; - }; - }; - "repos/get-commit-comment": { + 'application/json': components['schemas']['commit-comment'][] + } + } + } + } + 'repos/get-commit-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["commit-comment"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "repos/delete-commit-comment": { + 'application/json': components['schemas']['commit-comment'] + } + } + 404: components['responses']['not_found'] + } + } + 'repos/delete-commit-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; - "repos/update-commit-comment": { + 204: never + 404: components['responses']['not_found'] + } + } + 'repos/update-commit-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["commit-comment"]; - }; - }; - 404: components["responses"]["not_found"]; - }; + 'application/json': components['schemas']['commit-comment'] + } + } + 404: components['responses']['not_found'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The contents of the comment */ - body: string; - }; - }; - }; - }; + body: string + } + } + } + } /** List the reactions to a [commit comment](https://docs.github.com/rest/reference/repos#comments). */ - "reactions/list-for-commit-comment": { + 'reactions/list-for-commit-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; + comment_id: components['parameters']['comment-id'] + } query: { /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a commit comment. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content?: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["reaction"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['reaction'][] + } + } + 404: components['responses']['not_found'] + } + } /** Create a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. */ - "reactions/create-for-commit-comment": { + 'reactions/create-for-commit-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Reaction exists */ 200: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; + 'application/json': components['schemas']['reaction'] + } + } /** Reaction created */ 201: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - 415: components["responses"]["preview_header_missing"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['reaction'] + } + } + 415: components['responses']['preview_header_missing'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the commit comment. * @enum {string} */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - }; + content: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' + } + } + } + } /** * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. * * Delete a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). */ - "reactions/delete-for-commit-comment": { + 'reactions/delete-for-commit-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - reaction_id: components["parameters"]["reaction-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + reaction_id: components['parameters']['reaction-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * **Signature verification object** * @@ -30409,161 +30376,161 @@ export type operations = { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - "repos/list-commits": { + 'repos/list-commits': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** SHA or branch to start listing commits from. Default: the repository’s default branch (usually `master`). */ - sha?: string; + sha?: string /** Only commits containing this file path will be returned. */ - path?: string; + path?: string /** GitHub login or email address by which to filter by commit author. */ - author?: string; + author?: string /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - until?: string; + until?: string /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["commit"][]; - }; - }; - 400: components["responses"]["bad_request"]; - 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': components['schemas']['commit'][] + } + } + 400: components['responses']['bad_request'] + 404: components['responses']['not_found'] + 409: components['responses']['conflict'] + 500: components['responses']['internal_error'] + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. */ - "repos/list-branches-for-head-commit": { + 'repos/list-branches-for-head-commit': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** commit_sha parameter */ - commit_sha: components["parameters"]["commit-sha"]; - }; - }; + commit_sha: components['parameters']['commit-sha'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["branch-short"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['branch-short'][] + } + } + 422: components['responses']['validation_failed'] + } + } /** Use the `:commit_sha` to specify the commit that will have its comments listed. */ - "repos/list-comments-for-commit": { + 'repos/list-comments-for-commit': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** commit_sha parameter */ - commit_sha: components["parameters"]["commit-sha"]; - }; + commit_sha: components['parameters']['commit-sha'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["commit-comment"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['commit-comment'][] + } + } + } + } /** * Create a comment for a commit using its `:commit_sha`. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - "repos/create-commit-comment": { + 'repos/create-commit-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** commit_sha parameter */ - commit_sha: components["parameters"]["commit-sha"]; - }; - }; + commit_sha: components['parameters']['commit-sha'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["commit-comment"]; - }; - }; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['commit-comment'] + } + } + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The contents of the comment. */ - body: string; + body: string /** @description Relative path of the file to comment on. */ - path?: string; + path?: string /** @description Line index in the diff to comment on. */ - position?: number; + position?: number /** @description **Deprecated**. Use **position** parameter instead. Line number in the file to comment on. */ - line?: number; - }; - }; - }; - }; + line?: number + } + } + } + } /** Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the [List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests) endpoint. */ - "repos/list-pull-requests-associated-with-commit": { + 'repos/list-pull-requests-associated-with-commit': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** commit_sha parameter */ - commit_sha: components["parameters"]["commit-sha"]; - }; + commit_sha: components['parameters']['commit-sha'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["pull-request-simple"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['pull-request-simple'][] + } + } + } + } /** * Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. * @@ -30602,110 +30569,110 @@ export type operations = { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - "repos/get-commit": { + 'repos/get-commit': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** ref parameter */ - ref: string; - }; + ref: string + } query: { /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["commit"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': components['schemas']['commit'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + 500: components['responses']['internal_error'] + } + } /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. */ - "checks/list-for-ref": { + 'checks/list-for-ref': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** ref parameter */ - ref: string; - }; + ref: string + } query: { /** Returns check runs with the specified `name`. */ - check_name?: components["parameters"]["check-name"]; + check_name?: components['parameters']['check-name'] /** Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`. */ - status?: components["parameters"]["status"]; + status?: components['parameters']['status'] /** Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`. */ - filter?: "latest" | "all"; + filter?: 'latest' | 'all' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - app_id?: number; - }; - }; + page?: components['parameters']['page'] + app_id?: number + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - check_runs: components["schemas"]["check-run"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + check_runs: components['schemas']['check-run'][] + } + } + } + } + } /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * * Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository. */ - "checks/list-suites-for-ref": { + 'checks/list-suites-for-ref': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** ref parameter */ - ref: string; - }; + ref: string + } query: { /** Filters check suites by GitHub App `id`. */ - app_id?: number; + app_id?: number /** Returns check runs with the specified `name`. */ - check_name?: components["parameters"]["check-name"]; + check_name?: components['parameters']['check-name'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - check_suites: components["schemas"]["check-suite"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + check_suites: components['schemas']['check-suite'][] + } + } + } + } + } /** * Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. * @@ -30716,62 +30683,62 @@ export type operations = { * * **pending** if there are no statuses or a context is `pending` * * **success** if the latest status for all contexts is `success` */ - "repos/get-combined-status-for-ref": { + 'repos/get-combined-status-for-ref': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** ref parameter */ - ref: string; - }; + ref: string + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["combined-commit-status"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['combined-commit-status'] + } + } + 404: components['responses']['not_found'] + } + } /** * Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one. * * This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`. */ - "repos/list-commit-statuses-for-ref": { + 'repos/list-commit-statuses-for-ref': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** ref parameter */ - ref: string; - }; + ref: string + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["status"][]; - }; - }; - 301: components["responses"]["moved_permanently"]; - }; - }; + 'application/json': components['schemas']['status'][] + } + } + 301: components['responses']['moved_permanently'] + } + } /** * This endpoint will return all community profile metrics, including an * overall health score, repository description, the presence of documentation, detected @@ -30786,22 +30753,22 @@ export type operations = { * * `content_reports_enabled` is only returned for organization-owned repositories. */ - "repos/get-community-profile-metrics": { + 'repos/get-community-profile-metrics': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["community-profile"]; - }; - }; - }; - }; + 'application/json': components['schemas']['community-profile'] + } + } + } + } /** * The `basehead` param is comprised of two parts: `base` and `head`. Both must be branch names in `repo`. To compare branches across other repositories in the same network as `repo`, use the format `:branch`. * @@ -30844,32 +30811,32 @@ export type operations = { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - "repos/compare-commits": { + 'repos/compare-commits': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The base branch and head branch to compare. This parameter expects the format `{base}...{head}`. */ - basehead: string; - }; + basehead: string + } query: { /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["commit-comparison"]; - }; - }; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': components['schemas']['commit-comparison'] + } + } + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** * Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit * `:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. @@ -30904,96 +30871,96 @@ export type operations = { * If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the * github.com URLs (`html_url` and `_links["html"]`) will have null values. */ - "repos/get-content": { + 'repos/get-content': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** path parameter */ - path: string; - }; + path: string + } query: { /** The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`) */ - ref?: string; - }; - }; - responses: { - /** Response */ - 200: { - content: { - "application/vnd.github.v3.object": components["schemas"]["content-tree"]; - "application/json": - | components["schemas"]["content-directory"] - | components["schemas"]["content-file"] - | components["schemas"]["content-symlink"] - | components["schemas"]["content-submodule"]; - }; - }; - 302: components["responses"]["found"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + ref?: string + } + } + responses: { + /** Response */ + 200: { + content: { + 'application/vnd.github.v3.object': components['schemas']['content-tree'] + 'application/json': + | components['schemas']['content-directory'] + | components['schemas']['content-file'] + | components['schemas']['content-symlink'] + | components['schemas']['content-submodule'] + } + } + 302: components['responses']['found'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Creates a new file or replaces an existing file in a repository. */ - "repos/create-or-update-file-contents": { + 'repos/create-or-update-file-contents': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** path parameter */ - path: string; - }; - }; + path: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["file-commit"]; - }; - }; + 'application/json': components['schemas']['file-commit'] + } + } /** Response */ 201: { content: { - "application/json": components["schemas"]["file-commit"]; - }; - }; - 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['file-commit'] + } + } + 404: components['responses']['not_found'] + 409: components['responses']['conflict'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The commit message. */ - message: string; + message: string /** @description The new file content, using Base64 encoding. */ - content: string; + content: string /** @description **Required if you are updating a file**. The blob SHA of the file being replaced. */ - sha?: string; + sha?: string /** @description The branch name. Default: the repository’s default branch (usually `master`) */ - branch?: string; + branch?: string /** @description The person that committed the file. Default: the authenticated user. */ committer?: { /** @description The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted. */ - name: string; + name: string /** @description The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted. */ - email: string; + email: string /** @example "2013-01-05T13:13:22+05:00" */ - date?: string; - }; + date?: string + } /** @description The author of the file. Default: The `committer` or the authenticated user if you omit `committer`. */ author?: { /** @description The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted. */ - name: string; + name: string /** @description The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted. */ - email: string; + email: string /** @example "2013-01-15T17:13:22+05:00" */ - date?: string; - }; - }; - }; - }; - }; + date?: string + } + } + } + } + } /** * Deletes a file in a repository. * @@ -31003,151 +30970,151 @@ export type operations = { * * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. */ - "repos/delete-file": { + 'repos/delete-file': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** path parameter */ - path: string; - }; - }; + path: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["file-commit"]; - }; - }; - 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; - 422: components["responses"]["validation_failed"]; - 503: components["responses"]["service_unavailable"]; - }; + 'application/json': components['schemas']['file-commit'] + } + } + 404: components['responses']['not_found'] + 409: components['responses']['conflict'] + 422: components['responses']['validation_failed'] + 503: components['responses']['service_unavailable'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The commit message. */ - message: string; + message: string /** @description The blob SHA of the file being replaced. */ - sha: string; + sha: string /** @description The branch name. Default: the repository’s default branch (usually `master`) */ - branch?: string; + branch?: string /** @description object containing information about the committer. */ committer?: { /** @description The name of the author (or committer) of the commit */ - name?: string; + name?: string /** @description The email of the author (or committer) of the commit */ - email?: string; - }; + email?: string + } /** @description object containing information about the author. */ author?: { /** @description The name of the author (or committer) of the commit */ - name?: string; + name?: string /** @description The email of the author (or committer) of the commit */ - email?: string; - }; - }; - }; - }; - }; + email?: string + } + } + } + } + } /** * Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance. * * GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information. */ - "repos/list-contributors": { + 'repos/list-contributors': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Set to `1` or `true` to include anonymous contributors in results. */ - anon?: string; + anon?: string /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** if repository contains content */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["contributor"][]; - }; - }; + 'application/json': components['schemas']['contributor'][] + } + } /** Response if repository is empty */ - 204: never; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */ - "dependabot/list-repo-secrets": { + 'dependabot/list-repo-secrets': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - secrets: components["schemas"]["dependabot-secret"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + secrets: components['schemas']['dependabot-secret'][] + } + } + } + } + } /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */ - "dependabot/get-repo-public-key": { + 'dependabot/get-repo-public-key': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["dependabot-public-key"]; - }; - }; - }; - }; + 'application/json': components['schemas']['dependabot-public-key'] + } + } + } + } /** Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */ - "dependabot/get-repo-secret": { + 'dependabot/get-repo-secret': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["dependabot-secret"]; - }; - }; - }; - }; + 'application/json': components['schemas']['dependabot-secret'] + } + } + } + } /** * Creates or updates a repository secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -31225,83 +31192,83 @@ export type operations = { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - "dependabot/create-or-update-repo-secret": { + 'dependabot/create-or-update-repo-secret': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response when creating a secret */ 201: { content: { - "application/json": { [key: string]: unknown }; - }; - }; + 'application/json': { [key: string]: unknown } + } + } /** Response when updating a secret */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/reference/dependabot#get-a-repository-public-key) endpoint. */ - encrypted_value?: string; + encrypted_value?: string /** @description ID of the key you used to encrypt the secret. */ - key_id?: string; - }; - }; - }; - }; + key_id?: string + } + } + } + } /** Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */ - "dependabot/delete-repo-secret": { + 'dependabot/delete-repo-secret': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** Simple filtering of deployments is available via query parameters: */ - "repos/list-deployments": { + 'repos/list-deployments': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** The SHA recorded at creation time. */ - sha?: string; + sha?: string /** The name of the ref. This can be a branch, tag, or SHA. */ - ref?: string; + ref?: string /** The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`). */ - task?: string; + task?: string /** The name of the environment that was deployed to (e.g., `staging` or `production`). */ - environment?: string | null; + environment?: string | null /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["deployment"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['deployment'][] + } + } + } + } /** * Deployments offer a few configurable parameters with certain defaults. * @@ -31349,84 +31316,84 @@ export type operations = { * This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` * status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. */ - "repos/create-deployment": { + 'repos/create-deployment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["deployment"]; - }; - }; + 'application/json': components['schemas']['deployment'] + } + } /** Merged branch response */ 202: { content: { - "application/json": { - message?: string; - }; - }; - }; + 'application/json': { + message?: string + } + } + } /** Conflict when there is a merge conflict or the commit's status checks failed */ - 409: unknown; - 422: components["responses"]["validation_failed"]; - }; + 409: unknown + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The ref to deploy. This can be a branch, tag, or SHA. */ - ref: string; + ref: string /** * @description Specifies a task to execute (e.g., `deploy` or `deploy:migrations`). * @default deploy */ - task?: string; + task?: string /** * @description Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch. * @default true */ - auto_merge?: boolean; + auto_merge?: boolean /** @description The [status](https://docs.github.com/rest/reference/commits#commit-statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts. */ - required_contexts?: string[]; - payload?: { [key: string]: unknown } | string; + required_contexts?: string[] + payload?: { [key: string]: unknown } | string /** * @description Name for the target deployment environment (e.g., `production`, `staging`, `qa`). * @default production */ - environment?: string; + environment?: string /** @description Short description of the deployment. */ - description?: string | null; + description?: string | null /** @description Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false` */ - transient_environment?: boolean; + transient_environment?: boolean /** @description Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise. */ - production_environment?: boolean; - }; - }; - }; - }; - "repos/get-deployment": { + production_environment?: boolean + } + } + } + } + 'repos/get-deployment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** deployment_id parameter */ - deployment_id: components["parameters"]["deployment-id"]; - }; - }; + deployment_id: components['parameters']['deployment-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["deployment"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['deployment'] + } + } + 404: components['responses']['not_found'] + } + } /** * If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. Anyone with `repo` or `repo_deployment` scopes can delete a deployment. * @@ -31437,123 +31404,123 @@ export type operations = { * * For more information, see "[Create a deployment](https://docs.github.com/rest/reference/repos/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/reference/repos#create-a-deployment-status)." */ - "repos/delete-deployment": { + 'repos/delete-deployment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** deployment_id parameter */ - deployment_id: components["parameters"]["deployment-id"]; - }; - }; + deployment_id: components['parameters']['deployment-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } + } /** Users with pull access can view deployment statuses for a deployment: */ - "repos/list-deployment-statuses": { + 'repos/list-deployment-statuses': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** deployment_id parameter */ - deployment_id: components["parameters"]["deployment-id"]; - }; + deployment_id: components['parameters']['deployment-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["deployment-status"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['deployment-status'][] + } + } + 404: components['responses']['not_found'] + } + } /** * Users with `push` access can create deployment statuses for a given deployment. * * GitHub Apps require `read & write` access to "Deployments" and `read-only` access to "Repo contents" (for private repos). OAuth Apps require the `repo_deployment` scope. */ - "repos/create-deployment-status": { + 'repos/create-deployment-status': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** deployment_id parameter */ - deployment_id: components["parameters"]["deployment-id"]; - }; - }; + deployment_id: components['parameters']['deployment-id'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["deployment-status"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['deployment-status'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued`, `pending`, or `success`. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub. * @enum {string} */ - state: "error" | "failure" | "inactive" | "in_progress" | "queued" | "pending" | "success"; + state: 'error' | 'failure' | 'inactive' | 'in_progress' | 'queued' | 'pending' | 'success' /** @description The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`. */ - target_url?: string; + target_url?: string /** @description The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `""` */ - log_url?: string; + log_url?: string /** @description A short description of the status. The maximum description length is 140 characters. */ - description?: string; + description?: string /** * @description Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. * @enum {string} */ - environment?: "production" | "staging" | "qa"; + environment?: 'production' | 'staging' | 'qa' /** @description Sets the URL for accessing your environment. Default: `""` */ - environment_url?: string; + environment_url?: string /** @description Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true` */ - auto_inactive?: boolean; - }; - }; - }; - }; + auto_inactive?: boolean + } + } + } + } /** Users with pull access can view a deployment status for a deployment: */ - "repos/get-deployment-status": { + 'repos/get-deployment-status': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** deployment_id parameter */ - deployment_id: components["parameters"]["deployment-id"]; - status_id: number; - }; - }; + deployment_id: components['parameters']['deployment-id'] + status_id: number + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["deployment-status"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['deployment-status'] + } + } + 404: components['responses']['not_found'] + } + } /** * You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/webhooks/event-payloads/#repository_dispatch)." * @@ -31566,76 +31533,76 @@ export type operations = { * * This input example shows how you can use the `client_payload` as a test to debug your workflow. */ - "repos/create-dispatch-event": { + 'repos/create-dispatch-event': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - 422: components["responses"]["validation_failed"]; - }; + 204: never + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description A custom webhook event name. */ - event_type: string; + event_type: string /** @description JSON payload with extra information about the webhook event that your action or worklow may use. */ - client_payload?: { [key: string]: unknown }; - }; - }; - }; - }; + client_payload?: { [key: string]: unknown } + } + } + } + } /** * Get all environments for a repository. * * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "repos/get-all-environments": { + 'repos/get-all-environments': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { + 'application/json': { /** * @description The number of environments in this repository * @example 5 */ - total_count?: number; - environments?: components["schemas"]["environment"][]; - }; - }; - }; - }; - }; + total_count?: number + environments?: components['schemas']['environment'][] + } + } + } + } + } /** Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "repos/get-environment": { + 'repos/get-environment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the environment */ - environment_name: components["parameters"]["environment-name"]; - }; - }; + environment_name: components['parameters']['environment-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["environment"]; - }; - }; - }; - }; + 'application/json': components['schemas']['environment'] + } + } + } + } /** * Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)." * @@ -31645,206 +31612,206 @@ export type operations = { * * You must authenticate using an access token with the repo scope to use this endpoint. */ - "repos/create-or-update-environment": { + 'repos/create-or-update-environment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the environment */ - environment_name: components["parameters"]["environment-name"]; - }; - }; + environment_name: components['parameters']['environment-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["environment"]; - }; - }; + 'application/json': components['schemas']['environment'] + } + } /** Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` are set to the same value */ 422: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } + } requestBody: { content: { - "application/json": { - wait_timer?: components["schemas"]["wait-timer"]; + 'application/json': { + wait_timer?: components['schemas']['wait-timer'] /** @description The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */ reviewers?: | { - type?: components["schemas"]["deployment-reviewer-type"]; + type?: components['schemas']['deployment-reviewer-type'] /** * @description The id of the user or team who can review the deployment * @example 4532992 */ - id?: number; + id?: number }[] - | null; - deployment_branch_policy?: components["schemas"]["deployment_branch_policy"]; - } | null; - }; - }; - }; + | null + deployment_branch_policy?: components['schemas']['deployment_branch_policy'] + } | null + } + } + } /** You must authenticate using an access token with the repo scope to use this endpoint. */ - "repos/delete-an-environment": { + 'repos/delete-an-environment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the environment */ - environment_name: components["parameters"]["environment-name"]; - }; - }; + environment_name: components['parameters']['environment-name'] + } + } responses: { /** Default response */ - 204: never; - }; - }; - "activity/list-repo-events": { + 204: never + } + } + 'activity/list-repo-events': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["event"][]; - }; - }; - }; - }; - "repos/list-forks": { + 'application/json': components['schemas']['event'][] + } + } + } + } + 'repos/list-forks': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** The sort order. Can be either `newest`, `oldest`, or `stargazers`. */ - sort?: "newest" | "oldest" | "stargazers" | "watchers"; + sort?: 'newest' | 'oldest' | 'stargazers' | 'watchers' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["minimal-repository"][]; - }; - }; - 400: components["responses"]["bad_request"]; - }; - }; + 'application/json': components['schemas']['minimal-repository'][] + } + } + 400: components['responses']['bad_request'] + } + } /** * Create a fork for the authenticated user. * * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). */ - "repos/create-fork": { + 'repos/create-fork': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 202: { content: { - "application/json": components["schemas"]["full-repository"]; - }; - }; - 400: components["responses"]["bad_request"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['full-repository'] + } + } + 400: components['responses']['bad_request'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Optional parameter to specify the organization name if forking into an organization. */ - organization?: string; - } | null; - }; - }; - }; - "git/create-blob": { + organization?: string + } | null + } + } + } + 'git/create-blob': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["short-blob"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['short-blob'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 409: components['responses']['conflict'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The new blob's content. */ - content: string; + content: string /** * @description The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. * @default utf-8 */ - encoding?: string; - }; - }; - }; - }; + encoding?: string + } + } + } + } /** * The `content` in the response will always be Base64 encoded. * * _Note_: This API supports blobs up to 100 megabytes in size. */ - "git/get-blob": { + 'git/get-blob': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - file_sha: string; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + file_sha: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["blob"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['blob'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** * Creates a new Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects). * @@ -31877,65 +31844,65 @@ export type operations = { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - "git/create-commit": { + 'git/create-commit': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["git-commit"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['git-commit'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The commit message */ - message: string; + message: string /** @description The SHA of the tree object this commit points to */ - tree: string; + tree: string /** @description The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. */ - parents?: string[]; + parents?: string[] /** @description Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details. */ author?: { /** @description The name of the author (or committer) of the commit */ - name: string; + name: string /** @description The email of the author (or committer) of the commit */ - email: string; + email: string /** * Format: date-time * @description Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - date?: string; - }; + date?: string + } /** @description Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details. */ committer?: { /** @description The name of the author (or committer) of the commit */ - name?: string; + name?: string /** @description The email of the author (or committer) of the commit */ - email?: string; + email?: string /** * Format: date-time * @description Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - date?: string; - }; + date?: string + } /** @description The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits. */ - signature?: string; - }; - }; - }; - }; + signature?: string + } + } + } + } /** * Gets a Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects). * @@ -31968,25 +31935,25 @@ export type operations = { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - "git/get-commit": { + 'git/get-commit': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** commit_sha parameter */ - commit_sha: components["parameters"]["commit-sha"]; - }; - }; + commit_sha: components['parameters']['commit-sha'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["git-commit"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['git-commit'] + } + } + 404: components['responses']['not_found'] + } + } /** * Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array. * @@ -31996,132 +31963,132 @@ export type operations = { * * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. */ - "git/list-matching-refs": { + 'git/list-matching-refs': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** ref parameter */ - ref: string; - }; + ref: string + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["git-ref"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['git-ref'][] + } + } + } + } /** * Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. * * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". */ - "git/get-ref": { + 'git/get-ref': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** ref parameter */ - ref: string; - }; - }; + ref: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["git-ref"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['git-ref'] + } + } + 404: components['responses']['not_found'] + } + } /** Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches. */ - "git/create-ref": { + 'git/create-ref': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["git-ref"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['git-ref'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected. */ - ref: string; + ref: string /** @description The SHA1 value for this reference. */ - sha: string; + sha: string /** @example "refs/heads/newbranch" */ - key?: string; - }; - }; - }; - }; - "git/delete-ref": { + key?: string + } + } + } + } + 'git/delete-ref': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** ref parameter */ - ref: string; - }; - }; + ref: string + } + } responses: { /** Response */ - 204: never; - 422: components["responses"]["validation_failed"]; - }; - }; - "git/update-ref": { + 204: never + 422: components['responses']['validation_failed'] + } + } + 'git/update-ref': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** ref parameter */ - ref: string; - }; - }; + ref: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["git-ref"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['git-ref'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The SHA1 value to set this reference to */ - sha: string; + sha: string /** @description Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work. */ - force?: boolean; - }; - }; - }; - }; + force?: boolean + } + } + } + } /** * Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/rest/reference/git#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/rest/reference/git#create-a-reference) the tag reference - this call would be unnecessary. * @@ -32154,55 +32121,55 @@ export type operations = { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - "git/create-tag": { + 'git/create-tag': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["git-tag"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['git-tag'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The tag's name. This is typically a version (e.g., "v0.0.1"). */ - tag: string; + tag: string /** @description The tag message. */ - message: string; + message: string /** @description The SHA of the git object this is tagging. */ - object: string; + object: string /** * @description The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`. * @enum {string} */ - type: "commit" | "tree" | "blob"; + type: 'commit' | 'tree' | 'blob' /** @description An object with information about the individual creating the tag. */ tagger?: { /** @description The name of the author of the tag */ - name: string; + name: string /** @description The email of the author of the tag */ - email: string; + email: string /** * Format: date-time * @description When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - date?: string; - }; - }; - }; - }; - }; + date?: string + } + } + } + } + } /** * **Signature verification object** * @@ -32233,431 +32200,431 @@ export type operations = { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - "git/get-tag": { + 'git/get-tag': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - tag_sha: string; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + tag_sha: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["git-tag"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['git-tag'] + } + } + 404: components['responses']['not_found'] + } + } /** * The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure. * * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/rest/reference/git#create-a-commit)" and "[Update a reference](https://docs.github.com/rest/reference/git#update-a-reference)." */ - "git/create-tree": { + 'git/create-tree': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["git-tree"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['git-tree'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure. */ tree: { /** @description The file referenced in the tree. */ - path?: string; + path?: string /** * @description The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink. * @enum {string} */ - mode?: "100644" | "100755" | "040000" | "160000" | "120000"; + mode?: '100644' | '100755' | '040000' | '160000' | '120000' /** * @description Either `blob`, `tree`, or `commit`. * @enum {string} */ - type?: "blob" | "tree" | "commit"; + type?: 'blob' | 'tree' | 'commit' /** * @description The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. * * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. */ - sha?: string | null; + sha?: string | null /** * @description The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. * * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. */ - content?: string; - }[]; + content?: string + }[] /** * @description The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on. * If not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit. */ - base_tree?: string; - }; - }; - }; - }; + base_tree?: string + } + } + } + } /** * Returns a single tree using the SHA1 value for that tree. * * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. */ - "git/get-tree": { + 'git/get-tree': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - tree_sha: string; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + tree_sha: string + } query: { /** Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` to any of the following will enable returning objects or subtrees: `0`, `1`, `"true"`, and `"false"`. Omit this parameter to prevent recursively returning objects or subtrees. */ - recursive?: string; - }; - }; + recursive?: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["git-tree"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "repos/list-webhooks": { + 'application/json': components['schemas']['git-tree'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } + 'repos/list-webhooks': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["hook"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['hook'][] + } + } + 404: components['responses']['not_found'] + } + } /** * Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can * share the same `config` as long as those webhooks do not have any `events` that overlap. */ - "repos/create-webhook": { + 'repos/create-webhook': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["hook"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['hook'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`. */ - name?: string; + name?: string /** @description Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/repos#create-hook-config-params). */ config?: { - url?: components["schemas"]["webhook-config-url"]; - content_type?: components["schemas"]["webhook-config-content-type"]; - secret?: components["schemas"]["webhook-config-secret"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + url?: components['schemas']['webhook-config-url'] + content_type?: components['schemas']['webhook-config-content-type'] + secret?: components['schemas']['webhook-config-secret'] + insecure_ssl?: components['schemas']['webhook-config-insecure-ssl'] /** @example "abc" */ - token?: string; + token?: string /** @example "sha256" */ - digest?: string; - }; + digest?: string + } /** * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. * @default push */ - events?: string[]; + events?: string[] /** * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. * @default true */ - active?: boolean; - } | null; - }; - }; - }; + active?: boolean + } | null + } + } + } /** Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/reference/repos#get-a-webhook-configuration-for-a-repository)." */ - "repos/get-webhook": { + 'repos/get-webhook': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["hook"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "repos/delete-webhook": { + 'application/json': components['schemas']['hook'] + } + } + 404: components['responses']['not_found'] + } + } + 'repos/delete-webhook': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/reference/repos#update-a-webhook-configuration-for-a-repository)." */ - "repos/update-webhook": { + 'repos/update-webhook': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["hook"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['hook'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/repos#create-hook-config-params). */ config?: { - url: components["schemas"]["webhook-config-url"]; - content_type?: components["schemas"]["webhook-config-content-type"]; - secret?: components["schemas"]["webhook-config-secret"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + url: components['schemas']['webhook-config-url'] + content_type?: components['schemas']['webhook-config-content-type'] + secret?: components['schemas']['webhook-config-secret'] + insecure_ssl?: components['schemas']['webhook-config-insecure-ssl'] /** @example "bar@example.com" */ - address?: string; + address?: string /** @example "The Serious Room" */ - room?: string; - }; + room?: string + } /** * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events. * @default push */ - events?: string[]; + events?: string[] /** @description Determines a list of events to be added to the list of events that the Hook triggers for. */ - add_events?: string[]; + add_events?: string[] /** @description Determines a list of events to be removed from the list of events that the Hook triggers for. */ - remove_events?: string[]; + remove_events?: string[] /** * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. * @default true */ - active?: boolean; - }; - }; - }; - }; + active?: boolean + } + } + } + } /** * Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/reference/orgs#get-a-repository-webhook)." * * Access tokens must have the `read:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:read` permission. */ - "repos/get-webhook-config-for-repo": { + 'repos/get-webhook-config-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["webhook-config"]; - }; - }; - }; - }; + 'application/json': components['schemas']['webhook-config'] + } + } + } + } /** * Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/reference/orgs#update-a-repository-webhook)." * * Access tokens must have the `write:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:write` permission. */ - "repos/update-webhook-config-for-repo": { + 'repos/update-webhook-config-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["webhook-config"]; - }; - }; - }; + 'application/json': components['schemas']['webhook-config'] + } + } + } requestBody: { content: { - "application/json": { - url?: components["schemas"]["webhook-config-url"]; - content_type?: components["schemas"]["webhook-config-content-type"]; - secret?: components["schemas"]["webhook-config-secret"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - }; - }; - }; - }; + 'application/json': { + url?: components['schemas']['webhook-config-url'] + content_type?: components['schemas']['webhook-config-content-type'] + secret?: components['schemas']['webhook-config-secret'] + insecure_ssl?: components['schemas']['webhook-config-insecure-ssl'] + } + } + } + } /** Returns a list of webhook deliveries for a webhook configured in a repository. */ - "repos/list-webhook-deliveries": { + 'repos/list-webhook-deliveries': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - hook_id: components["parameters"]["hook-id"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + hook_id: components['parameters']['hook-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ - cursor?: components["parameters"]["cursor"]; - }; - }; + cursor?: components['parameters']['cursor'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["hook-delivery-item"][]; - }; - }; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['hook-delivery-item'][] + } + } + 400: components['responses']['bad_request'] + 422: components['responses']['validation_failed'] + } + } /** Returns a delivery for a webhook configured in a repository. */ - "repos/get-webhook-delivery": { + 'repos/get-webhook-delivery': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - hook_id: components["parameters"]["hook-id"]; - delivery_id: components["parameters"]["delivery-id"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + hook_id: components['parameters']['hook-id'] + delivery_id: components['parameters']['delivery-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["hook-delivery"]; - }; - }; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['hook-delivery'] + } + } + 400: components['responses']['bad_request'] + 422: components['responses']['validation_failed'] + } + } /** Redeliver a webhook delivery for a webhook configured in a repository. */ - "repos/redeliver-webhook-delivery": { + 'repos/redeliver-webhook-delivery': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - hook_id: components["parameters"]["hook-id"]; - delivery_id: components["parameters"]["delivery-id"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + hook_id: components['parameters']['hook-id'] + delivery_id: components['parameters']['delivery-id'] + } + } responses: { - 202: components["responses"]["accepted"]; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 202: components['responses']['accepted'] + 400: components['responses']['bad_request'] + 422: components['responses']['validation_failed'] + } + } /** This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. */ - "repos/ping-webhook": { + 'repos/ping-webhook': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** * This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. * * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` */ - "repos/test-push-webhook": { + 'repos/test-push-webhook': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** * View the progress of an import. * @@ -32694,360 +32661,359 @@ export type operations = { * * `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository. * * `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a "Get Large Files" request. */ - "migrations/get-import-status": { + 'migrations/get-import-status': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["import"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['import'] + } + } + 404: components['responses']['not_found'] + } + } /** Start a source import to a GitHub repository using GitHub Importer. */ - "migrations/start-import": { + 'migrations/start-import': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["import"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['import'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The URL of the originating repository. */ - vcs_url: string; + vcs_url: string /** * @description The originating VCS type. Can be one of `subversion`, `git`, `mercurial`, or `tfvc`. Please be aware that without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response. * @enum {string} */ - vcs?: "subversion" | "git" | "mercurial" | "tfvc"; + vcs?: 'subversion' | 'git' | 'mercurial' | 'tfvc' /** @description If authentication is required, the username to provide to `vcs_url`. */ - vcs_username?: string; + vcs_username?: string /** @description If authentication is required, the password to provide to `vcs_url`. */ - vcs_password?: string; + vcs_password?: string /** @description For a tfvc import, the name of the project that is being imported. */ - tfvc_project?: string; - }; - }; - }; - }; + tfvc_project?: string + } + } + } + } /** Stop an import for a repository. */ - "migrations/cancel-import": { + 'migrations/cancel-import': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API * request. If no parameters are provided, the import will be restarted. */ - "migrations/update-import": { + 'migrations/update-import': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["import"]; - }; - }; - }; + 'application/json': components['schemas']['import'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The username to provide to the originating repository. */ - vcs_username?: string; + vcs_username?: string /** @description The password to provide to the originating repository. */ - vcs_password?: string; + vcs_password?: string /** @example "git" */ - vcs?: string; + vcs?: string /** @example "project1" */ - tfvc_project?: string; - } | null; - }; - }; - }; + tfvc_project?: string + } | null + } + } + } /** * Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `. * * This endpoint and the [Map a commit author](https://docs.github.com/rest/reference/migrations#map-a-commit-author) endpoint allow you to provide correct Git author information. */ - "migrations/get-commit-authors": { + 'migrations/get-commit-authors': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** A user ID. Only return users with an ID greater than this ID. */ - since?: components["parameters"]["since-user"]; - }; - }; + since?: components['parameters']['since-user'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["porter-author"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['porter-author'][] + } + } + 404: components['responses']['not_found'] + } + } /** Update an author's identity for the import. Your application can continue updating authors any time before you push new commits to the repository. */ - "migrations/map-commit-author": { + 'migrations/map-commit-author': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - author_id: number; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + author_id: number + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["porter-author"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['porter-author'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The new Git author email. */ - email?: string; + email?: string /** @description The new Git author name. */ - name?: string; - }; - }; - }; - }; + name?: string + } + } + } + } /** List files larger than 100MB found during the import */ - "migrations/get-large-files": { + 'migrations/get-large-files': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["porter-large-file"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['porter-large-file'][] + } + } + } + } /** You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability is powered by [Git LFS](https://git-lfs.github.com). You can learn more about our LFS feature and working with large files [on our help site](https://docs.github.com/articles/versioning-large-files/). */ - "migrations/set-lfs-preference": { + 'migrations/set-lfs-preference': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["import"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['import'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description Can be one of `opt_in` (large files will be stored using Git LFS) or `opt_out` (large files will be removed during the import). * @enum {string} */ - use_lfs: "opt_in" | "opt_out"; - }; - }; - }; - }; + use_lfs: 'opt_in' | 'opt_out' + } + } + } + } /** * Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/get-repo-installation": { + 'apps/get-repo-installation': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["installation"]; - }; - }; - 301: components["responses"]["moved_permanently"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['installation'] + } + } + 301: components['responses']['moved_permanently'] + 404: components['responses']['not_found'] + } + } /** Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response. */ - "interactions/get-restrictions-for-repo": { + 'interactions/get-restrictions-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": Partial & - Partial<{ [key: string]: unknown }>; - }; - }; - }; - }; + 'application/json': Partial & Partial<{ [key: string]: unknown }> + } + } + } + } /** Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. */ - "interactions/set-restrictions-for-repo": { + 'interactions/set-restrictions-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["interaction-limit-response"]; - }; - }; + 'application/json': components['schemas']['interaction-limit-response'] + } + } /** Response */ - 409: unknown; - }; + 409: unknown + } requestBody: { content: { - "application/json": components["schemas"]["interaction-limit"]; - }; - }; - }; + 'application/json': components['schemas']['interaction-limit'] + } + } + } /** Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. */ - "interactions/remove-restrictions-for-repo": { + 'interactions/remove-restrictions-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; + 204: never /** Response */ - 409: unknown; - }; - }; + 409: unknown + } + } /** When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations. */ - "repos/list-invitations": { + 'repos/list-invitations': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["repository-invitation"][]; - }; - }; - }; - }; - "repos/delete-invitation": { + 'application/json': components['schemas']['repository-invitation'][] + } + } + } + } + 'repos/delete-invitation': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** invitation_id parameter */ - invitation_id: components["parameters"]["invitation-id"]; - }; - }; + invitation_id: components['parameters']['invitation-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; - "repos/update-invitation": { + 204: never + } + } + 'repos/update-invitation': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** invitation_id parameter */ - invitation_id: components["parameters"]["invitation-id"]; - }; - }; + invitation_id: components['parameters']['invitation-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["repository-invitation"]; - }; - }; - }; + 'application/json': components['schemas']['repository-invitation'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The permissions that the associated user will have on the repository. Valid values are `read`, `write`, `maintain`, `triage`, and `admin`. * @enum {string} */ - permissions?: "read" | "write" | "maintain" | "triage" | "admin"; - }; - }; - }; - }; + permissions?: 'read' | 'write' | 'maintain' | 'triage' | 'admin' + } + } + } + } /** * List issues in a repository. * @@ -33056,326 +33022,326 @@ export type operations = { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - "issues/list-for-repo": { + 'issues/list-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned. */ - milestone?: string; + milestone?: string /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ - state?: "open" | "closed" | "all"; + state?: 'open' | 'closed' | 'all' /** Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user. */ - assignee?: string; + assignee?: string /** The user that created the issue. */ - creator?: string; + creator?: string /** A user that's mentioned in the issue. */ - mentioned?: string; + mentioned?: string /** A list of comma separated label names. Example: `bug,ui,@high` */ - labels?: components["parameters"]["labels"]; + labels?: components['parameters']['labels'] /** What to sort results by. Can be either `created`, `updated`, `comments`. */ - sort?: "created" | "updated" | "comments"; + sort?: 'created' | 'updated' | 'comments' /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["issue"][]; - }; - }; - 301: components["responses"]["moved_permanently"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['issue'][] + } + } + 301: components['responses']['moved_permanently'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** * Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - "issues/create": { + 'issues/create': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["issue"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed"]; - 503: components["responses"]["service_unavailable"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['issue'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + 422: components['responses']['validation_failed'] + 503: components['responses']['service_unavailable'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The title of the issue. */ - title: string | number; + title: string | number /** @description The contents of the issue. */ - body?: string; + body?: string /** @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_ */ - assignee?: string | null; - milestone?: (string | number) | null; + assignee?: string | null + milestone?: (string | number) | null /** @description Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._ */ labels?: ( | string | { - id?: number; - name?: string; - description?: string | null; - color?: string | null; + id?: number + name?: string + description?: string | null + color?: string | null } - )[]; + )[] /** @description Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ */ - assignees?: string[]; - }; - }; - }; - }; + assignees?: string[] + } + } + } + } /** By default, Issue Comments are ordered by ascending ID. */ - "issues/list-comments-for-repo": { + 'issues/list-comments-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** One of `created` (when the repository was starred) or `updated` (when it was last pushed to). */ - sort?: components["parameters"]["sort"]; + sort?: components['parameters']['sort'] /** Either `asc` or `desc`. Ignored without the `sort` parameter. */ - direction?: "asc" | "desc"; + direction?: 'asc' | 'desc' /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["issue-comment"][]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "issues/get-comment": { + 'application/json': components['schemas']['issue-comment'][] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } + 'issues/get-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["issue-comment"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "issues/delete-comment": { + 'application/json': components['schemas']['issue-comment'] + } + } + 404: components['responses']['not_found'] + } + } + 'issues/delete-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; - "issues/update-comment": { + 204: never + } + } + 'issues/update-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["issue-comment"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['issue-comment'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The contents of the comment. */ - body: string; - }; - }; - }; - }; + body: string + } + } + } + } /** List the reactions to an [issue comment](https://docs.github.com/rest/reference/issues#comments). */ - "reactions/list-for-issue-comment": { + 'reactions/list-for-issue-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; + comment_id: components['parameters']['comment-id'] + } query: { /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue comment. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content?: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["reaction"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['reaction'][] + } + } + 404: components['responses']['not_found'] + } + } /** Create a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. */ - "reactions/create-for-issue-comment": { + 'reactions/create-for-issue-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Reaction exists */ 200: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; + 'application/json': components['schemas']['reaction'] + } + } /** Reaction created */ 201: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['reaction'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the issue comment. * @enum {string} */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - }; + content: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' + } + } + } + } /** * **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. * * Delete a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). */ - "reactions/delete-for-issue-comment": { + 'reactions/delete-for-issue-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - reaction_id: components["parameters"]["reaction-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + reaction_id: components['parameters']['reaction-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; - "issues/list-events-for-repo": { + 204: never + } + } + 'issues/list-events-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["issue-event"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; - }; - "issues/get-event": { + 'application/json': components['schemas']['issue-event'][] + } + } + 422: components['responses']['validation_failed'] + } + } + 'issues/get-event': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - event_id: number; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + event_id: number + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["issue-event"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - }; - }; + 'application/json': components['schemas']['issue-event'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + } + } /** * The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was * [transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If @@ -33389,394 +33355,394 @@ export type operations = { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - "issues/get": { + 'issues/get': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; - }; + issue_number: components['parameters']['issue-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["issue"]; - }; - }; - 301: components["responses"]["moved_permanently"]; - 304: components["responses"]["not_modified"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - }; - }; + 'application/json': components['schemas']['issue'] + } + } + 301: components['responses']['moved_permanently'] + 304: components['responses']['not_modified'] + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + } + } /** Issue owners and users with push access can edit an issue. */ - "issues/update": { + 'issues/update': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; - }; + issue_number: components['parameters']['issue-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["issue"]; - }; - }; - 301: components["responses"]["moved_permanently"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed"]; - 503: components["responses"]["service_unavailable"]; - }; + 'application/json': components['schemas']['issue'] + } + } + 301: components['responses']['moved_permanently'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + 422: components['responses']['validation_failed'] + 503: components['responses']['service_unavailable'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The title of the issue. */ - title?: (string | number) | null; + title?: (string | number) | null /** @description The contents of the issue. */ - body?: string | null; + body?: string | null /** @description Login for the user that this issue should be assigned to. **This field is deprecated.** */ - assignee?: string | null; + assignee?: string | null /** * @description State of the issue. Either `open` or `closed`. * @enum {string} */ - state?: "open" | "closed"; - milestone?: (string | number) | null; + state?: 'open' | 'closed' + milestone?: (string | number) | null /** @description Labels to associate with this issue. Pass one or more Labels to _replace_ the set of Labels on this Issue. Send an empty array (`[]`) to clear all Labels from the Issue. _NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise._ */ labels?: ( | string | { - id?: number; - name?: string; - description?: string | null; - color?: string | null; + id?: number + name?: string + description?: string | null + color?: string | null } - )[]; + )[] /** @description Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ */ - assignees?: string[]; - }; - }; - }; - }; + assignees?: string[] + } + } + } + } /** Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced. */ - "issues/add-assignees": { + 'issues/add-assignees': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; - }; + issue_number: components['parameters']['issue-number'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["issue"]; - }; - }; - }; + 'application/json': components['schemas']['issue'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._ */ - assignees?: string[]; - }; - }; - }; - }; + assignees?: string[] + } + } + } + } /** Removes one or more assignees from an issue. */ - "issues/remove-assignees": { + 'issues/remove-assignees': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; - }; + issue_number: components['parameters']['issue-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["issue"]; - }; - }; - }; + 'application/json': components['schemas']['issue'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._ */ - assignees?: string[]; - }; - }; - }; - }; + assignees?: string[] + } + } + } + } /** Issue Comments are ordered by ascending ID. */ - "issues/list-comments": { + 'issues/list-comments': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; + issue_number: components['parameters']['issue-number'] + } query: { /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["issue-comment"][]; - }; - }; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - }; - }; + 'application/json': components['schemas']['issue-comment'][] + } + } + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + } + } /** This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - "issues/create-comment": { + 'issues/create-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; - }; + issue_number: components['parameters']['issue-number'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["issue-comment"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['issue-comment'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The contents of the comment. */ - body: string; - }; - }; - }; - }; - "issues/list-events": { + body: string + } + } + } + } + 'issues/list-events': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; + issue_number: components['parameters']['issue-number'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["issue-event-for-issue"][]; - }; - }; - 410: components["responses"]["gone"]; - }; - }; - "issues/list-labels-on-issue": { + 'application/json': components['schemas']['issue-event-for-issue'][] + } + } + 410: components['responses']['gone'] + } + } + 'issues/list-labels-on-issue': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; + issue_number: components['parameters']['issue-number'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["label"][]; - }; - }; - 410: components["responses"]["gone"]; - }; - }; + 'application/json': components['schemas']['label'][] + } + } + 410: components['responses']['gone'] + } + } /** Removes any previous labels and sets the new labels for an issue. */ - "issues/set-labels": { + 'issues/set-labels': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; - }; + issue_number: components['parameters']['issue-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["label"][]; - }; - }; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['label'][] + } + } + 410: components['responses']['gone'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see "[Add labels to an issue](https://docs.github.com/rest/reference/issues#add-labels-to-an-issue)." */ - labels?: string[]; + labels?: string[] } | string[] | { labels?: { - name: string; - }[]; + name: string + }[] } | { - name: string; + name: string }[] - | string; - }; - }; - }; - "issues/add-labels": { + | string + } + } + } + 'issues/add-labels': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; - }; + issue_number: components['parameters']['issue-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["label"][]; - }; - }; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['label'][] + } + } + 410: components['responses']['gone'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also replace all of the labels for an issue. For more information, see "[Set labels for an issue](https://docs.github.com/rest/reference/issues#set-labels-for-an-issue)." */ - labels?: string[]; + labels?: string[] } | string[] | { labels?: { - name: string; - }[]; + name: string + }[] } | { - name: string; + name: string }[] - | string; - }; - }; - }; - "issues/remove-all-labels": { + | string + } + } + } + 'issues/remove-all-labels': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; - }; + issue_number: components['parameters']['issue-number'] + } + } responses: { /** Response */ - 204: never; - 410: components["responses"]["gone"]; - }; - }; + 204: never + 410: components['responses']['gone'] + } + } /** Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist. */ - "issues/remove-label": { + 'issues/remove-label': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - name: string; - }; - }; + issue_number: components['parameters']['issue-number'] + name: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["label"][]; - }; - }; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - }; - }; + 'application/json': components['schemas']['label'][] + } + } + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + } + } /** * Users with push access can lock an issue or pull request's conversation. * * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - "issues/lock": { + 'issues/lock': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; - }; + issue_number: components['parameters']['issue-number'] + } + } responses: { /** Response */ - 204: never; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed"]; - }; + 204: never + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: * \* `off-topic` @@ -33785,379 +33751,379 @@ export type operations = { * \* `spam` * @enum {string} */ - lock_reason?: "off-topic" | "too heated" | "resolved" | "spam"; - } | null; - }; - }; - }; + lock_reason?: 'off-topic' | 'too heated' | 'resolved' | 'spam' + } | null + } + } + } /** Users with push access can unlock an issue's conversation. */ - "issues/unlock": { + 'issues/unlock': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; - }; + issue_number: components['parameters']['issue-number'] + } + } responses: { /** Response */ - 204: never; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** List the reactions to an [issue](https://docs.github.com/rest/reference/issues). */ - "reactions/list-for-issue": { + 'reactions/list-for-issue': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; + issue_number: components['parameters']['issue-number'] + } query: { /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content?: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["reaction"][]; - }; - }; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - }; - }; + 'application/json': components['schemas']['reaction'][] + } + } + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + } + } /** Create a reaction to an [issue](https://docs.github.com/rest/reference/issues/). A response with an HTTP `200` status means that you already added the reaction type to this issue. */ - "reactions/create-for-issue": { + 'reactions/create-for-issue': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; - }; + issue_number: components['parameters']['issue-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; + 'application/json': components['schemas']['reaction'] + } + } /** Response */ 201: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['reaction'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the issue. * @enum {string} */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - }; + content: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' + } + } + } + } /** * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. * * Delete a reaction to an [issue](https://docs.github.com/rest/reference/issues/). */ - "reactions/delete-for-issue": { + 'reactions/delete-for-issue': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - reaction_id: components["parameters"]["reaction-id"]; - }; - }; + issue_number: components['parameters']['issue-number'] + reaction_id: components['parameters']['reaction-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; - "issues/list-events-for-timeline": { + 204: never + } + } + 'issues/list-events-for-timeline': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; + issue_number: components['parameters']['issue-number'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["timeline-issue-events"][]; - }; - }; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - }; - }; - "repos/list-deploy-keys": { + 'application/json': components['schemas']['timeline-issue-events'][] + } + } + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + } + } + 'repos/list-deploy-keys': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["deploy-key"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['deploy-key'][] + } + } + } + } /** You can create a read-only deploy key. */ - "repos/create-deploy-key": { + 'repos/create-deploy-key': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["deploy-key"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['deploy-key'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description A name for the key. */ - title?: string; + title?: string /** @description The contents of the key. */ - key: string; + key: string /** * @description If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. * * Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)" and "[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/)." */ - read_only?: boolean; - }; - }; - }; - }; - "repos/get-deploy-key": { + read_only?: boolean + } + } + } + } + 'repos/get-deploy-key': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** key_id parameter */ - key_id: components["parameters"]["key-id"]; - }; - }; + key_id: components['parameters']['key-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["deploy-key"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['deploy-key'] + } + } + 404: components['responses']['not_found'] + } + } /** Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead. */ - "repos/delete-deploy-key": { + 'repos/delete-deploy-key': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** key_id parameter */ - key_id: components["parameters"]["key-id"]; - }; - }; + key_id: components['parameters']['key-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; - "issues/list-labels-for-repo": { + 204: never + } + } + 'issues/list-labels-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["label"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "issues/create-label": { + 'application/json': components['schemas']['label'][] + } + } + 404: components['responses']['not_found'] + } + } + 'issues/create-label': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["label"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['label'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see "[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet)." */ - name: string; + name: string /** @description The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. */ - color?: string; + color?: string /** @description A short description of the label. Must be 100 characters or fewer. */ - description?: string; - }; - }; - }; - }; - "issues/get-label": { + description?: string + } + } + } + } + 'issues/get-label': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - name: string; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + name: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["label"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "issues/delete-label": { + 'application/json': components['schemas']['label'] + } + } + 404: components['responses']['not_found'] + } + } + 'issues/delete-label': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - name: string; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + name: string + } + } responses: { /** Response */ - 204: never; - }; - }; - "issues/update-label": { + 204: never + } + } + 'issues/update-label': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - name: string; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + name: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["label"]; - }; - }; - }; + 'application/json': components['schemas']['label'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see "[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet)." */ - new_name?: string; + new_name?: string /** @description The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. */ - color?: string; + color?: string /** @description A short description of the label. Must be 100 characters or fewer. */ - description?: string; - }; - }; - }; - }; + description?: string + } + } + } + } /** Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language. */ - "repos/list-languages": { + 'repos/list-languages': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["language"]; - }; - }; - }; - }; - "repos/enable-lfs-for-repo": { + 'application/json': components['schemas']['language'] + } + } + } + } + 'repos/enable-lfs-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { - 202: components["responses"]["accepted"]; + 202: components['responses']['accepted'] /** * We will return a 403 with one of the following messages: * @@ -34165,523 +34131,523 @@ export type operations = { * - Git LFS support not enabled because Git LFS is disabled for the root repository in the network. * - Git LFS support not enabled because Git LFS is disabled for . */ - 403: unknown; - }; - }; - "repos/disable-lfs-for-repo": { + 403: unknown + } + } + 'repos/disable-lfs-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * This method returns the contents of the repository's license file, if one is detected. * * Similar to [Get repository content](https://docs.github.com/rest/reference/repos#get-repository-content), this method also supports [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw license content or rendered license HTML. */ - "licenses/get-for-repo": { + 'licenses/get-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["license-content"]; - }; - }; - }; - }; + 'application/json': components['schemas']['license-content'] + } + } + } + } /** Sync a branch of a forked repository to keep it up-to-date with the upstream repository. */ - "repos/merge-upstream": { + 'repos/merge-upstream': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** The branch has been successfully synced with the upstream repository */ 200: { content: { - "application/json": components["schemas"]["merged-upstream"]; - }; - }; + 'application/json': components['schemas']['merged-upstream'] + } + } /** The branch could not be synced because of a merge conflict */ - 409: unknown; + 409: unknown /** The branch could not be synced for some other reason */ - 422: unknown; - }; + 422: unknown + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the branch which should be updated to match upstream. */ - branch: string; - }; - }; - }; - }; - "repos/merge": { + branch: string + } + } + } + } + 'repos/merge': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Successful Response (The resulting merge commit) */ 201: { content: { - "application/json": components["schemas"]["commit"]; - }; - }; + 'application/json': components['schemas']['commit'] + } + } /** Response when already merged */ - 204: never; - 403: components["responses"]["forbidden"]; + 204: never + 403: components['responses']['forbidden'] /** Not Found when the base or head does not exist */ - 404: unknown; + 404: unknown /** Conflict when there is a merge conflict */ - 409: unknown; - 422: components["responses"]["validation_failed"]; - }; + 409: unknown + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the base branch that the head will be merged into. */ - base: string; + base: string /** @description The head to merge. This can be a branch name or a commit SHA1. */ - head: string; + head: string /** @description Commit message to use for the merge commit. If omitted, a default message will be used. */ - commit_message?: string; - }; - }; - }; - }; - "issues/list-milestones": { + commit_message?: string + } + } + } + } + 'issues/list-milestones': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** The state of the milestone. Either `open`, `closed`, or `all`. */ - state?: "open" | "closed" | "all"; + state?: 'open' | 'closed' | 'all' /** What to sort results by. Either `due_on` or `completeness`. */ - sort?: "due_on" | "completeness"; + sort?: 'due_on' | 'completeness' /** The direction of the sort. Either `asc` or `desc`. */ - direction?: "asc" | "desc"; + direction?: 'asc' | 'desc' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["milestone"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "issues/create-milestone": { + 'application/json': components['schemas']['milestone'][] + } + } + 404: components['responses']['not_found'] + } + } + 'issues/create-milestone': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["milestone"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['milestone'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The title of the milestone. */ - title: string; + title: string /** * @description The state of the milestone. Either `open` or `closed`. * @default open * @enum {string} */ - state?: "open" | "closed"; + state?: 'open' | 'closed' /** @description A description of the milestone. */ - description?: string; + description?: string /** * Format: date-time * @description The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - due_on?: string; - }; - }; - }; - }; - "issues/get-milestone": { + due_on?: string + } + } + } + } + 'issues/get-milestone': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** milestone_number parameter */ - milestone_number: components["parameters"]["milestone-number"]; - }; - }; + milestone_number: components['parameters']['milestone-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["milestone"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "issues/delete-milestone": { + 'application/json': components['schemas']['milestone'] + } + } + 404: components['responses']['not_found'] + } + } + 'issues/delete-milestone': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** milestone_number parameter */ - milestone_number: components["parameters"]["milestone-number"]; - }; - }; + milestone_number: components['parameters']['milestone-number'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; - "issues/update-milestone": { + 204: never + 404: components['responses']['not_found'] + } + } + 'issues/update-milestone': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** milestone_number parameter */ - milestone_number: components["parameters"]["milestone-number"]; - }; - }; + milestone_number: components['parameters']['milestone-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["milestone"]; - }; - }; - }; + 'application/json': components['schemas']['milestone'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The title of the milestone. */ - title?: string; + title?: string /** * @description The state of the milestone. Either `open` or `closed`. * @default open * @enum {string} */ - state?: "open" | "closed"; + state?: 'open' | 'closed' /** @description A description of the milestone. */ - description?: string; + description?: string /** * Format: date-time * @description The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - due_on?: string; - }; - }; - }; - }; - "issues/list-labels-for-milestone": { + due_on?: string + } + } + } + } + 'issues/list-labels-for-milestone': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** milestone_number parameter */ - milestone_number: components["parameters"]["milestone-number"]; - }; + milestone_number: components['parameters']['milestone-number'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["label"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['label'][] + } + } + } + } /** List all notifications for the current user. */ - "activity/list-repo-notifications-for-authenticated-user": { + 'activity/list-repo-notifications-for-authenticated-user': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** If `true`, show notifications marked as read. */ - all?: components["parameters"]["all"]; + all?: components['parameters']['all'] /** If `true`, only shows notifications in which the user is directly participating or mentioned. */ - participating?: components["parameters"]["participating"]; + participating?: components['parameters']['participating'] /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - before?: components["parameters"]["before"]; + before?: components['parameters']['before'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["thread"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['thread'][] + } + } + } + } /** Marks all notifications in a repository as "read" removes them from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ - "activity/mark-repo-notifications-as-read": { + 'activity/mark-repo-notifications-as-read': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 202: { content: { - "application/json": { - message?: string; - url?: string; - }; - }; - }; + 'application/json': { + message?: string + url?: string + } + } + } /** Reset Content */ - 205: unknown; - }; + 205: unknown + } requestBody: { content: { - "application/json": { + 'application/json': { /** * Format: date-time * @description Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. */ - last_read_at?: string; - }; - }; - }; - }; - "repos/get-pages": { + last_read_at?: string + } + } + } + } + 'repos/get-pages': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["page"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['page'] + } + } + 404: components['responses']['not_found'] + } + } /** Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). */ - "repos/update-information-about-pages-site": { + 'repos/update-information-about-pages-site': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; - }; + 204: never + 400: components['responses']['bad_request'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/articles/using-a-custom-domain-with-github-pages/)." */ - cname?: string | null; + cname?: string | null /** @description Specify whether HTTPS should be enforced for the repository. */ - https_enforced?: boolean; + https_enforced?: boolean /** @description Configures access controls for the GitHub Pages site. If public is set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to `internal` visibility. This feature is only available to repositories in an organization on an Enterprise plan. */ - public?: boolean; - source?: Partial<"gh-pages" | "master" | "master /docs"> & + public?: boolean + source?: Partial<'gh-pages' | 'master' | 'master /docs'> & Partial<{ /** @description The repository branch used to publish your site's source files. */ - branch: string; + branch: string /** * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. * @enum {string} */ - path: "/" | "/docs"; - }>; - }; - }; - }; - }; + path: '/' | '/docs' + }> + } + } + } + } /** Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)." */ - "repos/create-pages-site": { + 'repos/create-pages-site': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["page"]; - }; - }; - 409: components["responses"]["conflict"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['page'] + } + } + 409: components['responses']['conflict'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The source branch and directory used to publish your Pages site. */ source: { /** @description The repository branch used to publish your site's source files. */ - branch: string; + branch: string /** * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/` * @default / * @enum {string} */ - path?: "/" | "/docs"; - }; - } | null; - }; - }; - }; - "repos/delete-pages-site": { + path?: '/' | '/docs' + } + } | null + } + } + } + 'repos/delete-pages-site': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "repos/list-pages-builds": { + 204: never + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } + 'repos/list-pages-builds': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["page-build"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['page-build'][] + } + } + } + } /** * You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures. * * Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes. */ - "repos/request-pages-build": { + 'repos/request-pages-build': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["page-build-status"]; - }; - }; - }; - }; - "repos/get-latest-pages-build": { + 'application/json': components['schemas']['page-build-status'] + } + } + } + } + 'repos/get-latest-pages-build': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["page-build"]; - }; - }; - }; - }; - "repos/get-pages-build": { + 'application/json': components['schemas']['page-build'] + } + } + } + } + 'repos/get-pages-build': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - build_id: number; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + build_id: number + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["page-build"]; - }; - }; - }; - }; + 'application/json': components['schemas']['page-build'] + } + } + } + } /** * Gets a health check of the DNS settings for the `CNAME` record configured for a repository's GitHub Pages. * @@ -34689,132 +34655,132 @@ export type operations = { * * Users must have admin or owner permissions. GitHub Apps must have the `pages:write` and `administration:write` permission to use this endpoint. */ - "repos/get-pages-health-check": { + 'repos/get-pages-health-check': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pages-health-check"]; - }; - }; + 'application/json': components['schemas']['pages-health-check'] + } + } /** Empty response */ 202: { content: { - "application/json": components["schemas"]["empty-object"]; - }; - }; + 'application/json': components['schemas']['empty-object'] + } + } /** Custom domains are not available for GitHub Pages */ - 400: unknown; - 404: components["responses"]["not_found"]; + 400: unknown + 404: components['responses']['not_found'] /** There isn't a CNAME for this page */ - 422: unknown; - }; - }; + 422: unknown + } + } /** Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - "projects/list-for-repo": { + 'projects/list-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. */ - state?: "open" | "closed" | "all"; + state?: 'open' | 'closed' | 'all' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["project"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed_simple"]; - }; - }; + 'application/json': components['schemas']['project'][] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + 422: components['responses']['validation_failed_simple'] + } + } /** Creates a repository project board. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - "projects/create-for-repo": { + 'projects/create-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["project"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': components['schemas']['project'] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the project. */ - name: string; + name: string /** @description The description of the project. */ - body?: string; - }; - }; - }; - }; + body?: string + } + } + } + } /** Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "pulls/list": { + 'pulls/list': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Either `open`, `closed`, or `all` to filter by state. */ - state?: "open" | "closed" | "all"; + state?: 'open' | 'closed' | 'all' /** Filter pulls by head user or head organization and branch name in the format of `user:ref-name` or `organization:ref-name`. For example: `github:new-script-format` or `octocat:test-branch`. */ - head?: string; + head?: string /** Filter pulls by base branch name. Example: `gh-pages`. */ - base?: string; + base?: string /** What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month). */ - sort?: "created" | "updated" | "popularity" | "long-running"; + sort?: 'created' | 'updated' | 'popularity' | 'long-running' /** The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`. */ - direction?: "asc" | "desc"; + direction?: 'asc' | 'desc' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["pull-request-simple"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['pull-request-simple'][] + } + } + 304: components['responses']['not_modified'] + 422: components['responses']['validation_failed'] + } + } /** * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -34824,225 +34790,225 @@ export type operations = { * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. */ - "pulls/create": { + 'pulls/create': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["pull-request"]; - }; - }; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['pull-request'] + } + } + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The title of the new pull request. */ - title?: string; + title?: string /** @description The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`. */ - head: string; + head: string /** @description The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository. */ - base: string; + base: string /** @description The contents of the pull request. */ - body?: string; + body?: string /** @description Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. */ - maintainer_can_modify?: boolean; + maintainer_can_modify?: boolean /** @description Indicates whether the pull request is a draft. See "[Draft Pull Requests](https://docs.github.com/en/articles/about-pull-requests#draft-pull-requests)" in the GitHub Help documentation to learn more. */ - draft?: boolean; + draft?: boolean /** @example 1 */ - issue?: number; - }; - }; - }; - }; + issue?: number + } + } + } + } /** Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID. */ - "pulls/list-review-comments-for-repo": { + 'pulls/list-review-comments-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { - sort?: "created" | "updated" | "created_at"; + sort?: 'created' | 'updated' | 'created_at' /** Can be either `asc` or `desc`. Ignored without `sort` parameter. */ - direction?: "asc" | "desc"; + direction?: 'asc' | 'desc' /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["pull-request-review-comment"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['pull-request-review-comment'][] + } + } + } + } /** Provides details for a review comment. */ - "pulls/get-review-comment": { + 'pulls/get-review-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pull-request-review-comment"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['pull-request-review-comment'] + } + } + 404: components['responses']['not_found'] + } + } /** Deletes a review comment. */ - "pulls/delete-review-comment": { + 'pulls/delete-review-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** Enables you to edit a review comment. */ - "pulls/update-review-comment": { + 'pulls/update-review-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pull-request-review-comment"]; - }; - }; - }; + 'application/json': components['schemas']['pull-request-review-comment'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The text of the reply to the review comment. */ - body: string; - }; - }; - }; - }; + body: string + } + } + } + } /** List the reactions to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). */ - "reactions/list-for-pull-request-review-comment": { + 'reactions/list-for-pull-request-review-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; + comment_id: components['parameters']['comment-id'] + } query: { /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a pull request review comment. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content?: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["reaction"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['reaction'][] + } + } + 404: components['responses']['not_found'] + } + } /** Create a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#comments). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. */ - "reactions/create-for-pull-request-review-comment": { + 'reactions/create-for-pull-request-review-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Reaction exists */ 200: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; + 'application/json': components['schemas']['reaction'] + } + } /** Reaction created */ 201: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['reaction'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the pull request review comment. * @enum {string} */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - }; + content: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' + } + } + } + } /** * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` * * Delete a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). */ - "reactions/delete-for-pull-request-comment": { + 'reactions/delete-for-pull-request-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - reaction_id: components["parameters"]["reaction-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + reaction_id: components['parameters']['reaction-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -35060,145 +35026,145 @@ export type operations = { * * Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. */ - "pulls/get": { + 'pulls/get': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } + } responses: { /** Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. */ 200: { content: { - "application/json": components["schemas"]["pull-request"]; - }; - }; - 304: components["responses"]["not_modified"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': components['schemas']['pull-request'] + } + } + 304: components['responses']['not_modified'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. */ - "pulls/update": { + 'pulls/update': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pull-request"]; - }; - }; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['pull-request'] + } + } + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The title of the pull request. */ - title?: string; + title?: string /** @description The contents of the pull request. */ - body?: string; + body?: string /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ - state?: "open" | "closed"; + state?: 'open' | 'closed' /** @description The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository. */ - base?: string; + base?: string /** @description Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. */ - maintainer_can_modify?: boolean; - }; - }; - }; - }; + maintainer_can_modify?: boolean + } + } + } + } /** * Creates a codespace owned by the authenticated user for the specified pull request. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/create-with-pr-for-authenticated-user": { + 'codespaces/create-with-pr-for-authenticated-user': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } + } responses: { /** Response when the codespace was successfully created */ 201: { content: { - "application/json": components["schemas"]["codespace"]; - }; - }; + 'application/json': components['schemas']['codespace'] + } + } /** Response when the codespace creation partially failed but is being retried in the background */ 202: { content: { - "application/json": components["schemas"]["codespace"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; + 'application/json': components['schemas']['codespace'] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Location for this codespace */ - location: string; + location: string /** @description Machine type to use for this codespace */ - machine?: string; + machine?: string /** @description Working directory for this codespace */ - working_directory?: string; + working_directory?: string /** @description Time in minutes before codespace stops from inactivity */ - idle_timeout_minutes?: number; - }; - }; - }; - }; + idle_timeout_minutes?: number + } + } + } + } /** Lists all review comments for a pull request. By default, review comments are in ascending order by ID. */ - "pulls/list-review-comments": { + 'pulls/list-review-comments': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } query: { /** One of `created` (when the repository was starred) or `updated` (when it was last pushed to). */ - sort?: components["parameters"]["sort"]; + sort?: components['parameters']['sort'] /** Can be either `asc` or `desc`. Ignored without `sort` parameter. */ - direction?: "asc" | "desc"; + direction?: 'asc' | 'desc' /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["pull-request-review-comment"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['pull-request-review-comment'][] + } + } + } + } /** * Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/reference/issues#create-an-issue-comment)." We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff. * @@ -35208,328 +35174,328 @@ export type operations = { * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - "pulls/create-review-comment": { + 'pulls/create-review-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["pull-request-review-comment"]; - }; - }; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['pull-request-review-comment'] + } + } + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The text of the review comment. */ - body: string; + body: string /** @description The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`. */ - commit_id?: string; + commit_id?: string /** @description The relative path to the file that necessitates a comment. */ - path?: string; + path?: string /** @description **Required without `comfort-fade` preview unless using `in_reply_to`**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above. */ - position?: number; + position?: number /** * @description **Required with `comfort-fade` preview unless using `in_reply_to`**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "[Diff view options](https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation. * @enum {string} */ - side?: "LEFT" | "RIGHT"; + side?: 'LEFT' | 'RIGHT' /** @description **Required with `comfort-fade` preview unless using `in_reply_to`**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to. */ - line?: number; + line?: number /** @description **Required when using multi-line comments unless using `in_reply_to`**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. */ - start_line?: number; + start_line?: number /** * @description **Required when using multi-line comments unless using `in_reply_to`**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context. * @enum {string} */ - start_side?: "LEFT" | "RIGHT" | "side"; + start_side?: 'LEFT' | 'RIGHT' | 'side' /** * @description The ID of the review comment to reply to. To find the ID of a review comment with ["List review comments on a pull request"](#list-review-comments-on-a-pull-request). When specified, all parameters other than `body` in the request body are ignored. * @example 2 */ - in_reply_to?: number; - }; - }; - }; - }; + in_reply_to?: number + } + } + } + } /** * Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - "pulls/create-reply-for-review-comment": { + 'pulls/create-reply-for-review-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["pull-request-review-comment"]; - }; - }; - 404: components["responses"]["not_found"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['pull-request-review-comment'] + } + } + 404: components['responses']['not_found'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The text of the review comment. */ - body: string; - }; - }; - }; - }; + body: string + } + } + } + } /** Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/reference/repos#list-commits) endpoint. */ - "pulls/list-commits": { + 'pulls/list-commits': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["commit"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['commit'][] + } + } + } + } /** **Note:** Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. */ - "pulls/list-files": { + 'pulls/list-files': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["diff-entry"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - 500: components["responses"]["internal_error"]; - }; - }; - "pulls/check-if-merged": { + 'application/json': components['schemas']['diff-entry'][] + } + } + 422: components['responses']['validation_failed'] + 500: components['responses']['internal_error'] + } + } + 'pulls/check-if-merged': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } + } responses: { /** Response if pull request has been merged */ - 204: never; + 204: never /** Not Found if pull request has not been merged */ - 404: unknown; - }; - }; + 404: unknown + } + } /** This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - "pulls/merge": { + 'pulls/merge': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } + } responses: { /** if merge was successful */ 200: { content: { - "application/json": components["schemas"]["pull-request-merge-result"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; + 'application/json': components['schemas']['pull-request-merge-result'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] /** Method Not Allowed if merge cannot be performed */ 405: { content: { - "application/json": { - message?: string; - documentation_url?: string; - }; - }; - }; + 'application/json': { + message?: string + documentation_url?: string + } + } + } /** Conflict if sha was provided and pull request head did not match */ 409: { content: { - "application/json": { - message?: string; - documentation_url?: string; - }; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': { + message?: string + documentation_url?: string + } + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Title for the automatic commit message. */ - commit_title?: string; + commit_title?: string /** @description Extra detail to append to automatic commit message. */ - commit_message?: string; + commit_message?: string /** @description SHA that pull request head must match to allow merge. */ - sha?: string; + sha?: string /** * @description Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`. * @enum {string} */ - merge_method?: "merge" | "squash" | "rebase"; - } | null; - }; - }; - }; - "pulls/list-requested-reviewers": { - parameters: { - path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; + merge_method?: 'merge' | 'squash' | 'rebase' + } | null + } + } + } + 'pulls/list-requested-reviewers': { + parameters: { + path: { + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["pull-request-review-request"]; - }; - }; - }; - }; + 'application/json': components['schemas']['pull-request-review-request'] + } + } + } + } /** This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - "pulls/request-reviewers": { + 'pulls/request-reviewers': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["pull-request-simple"]; - }; - }; - 403: components["responses"]["forbidden"]; + 'application/json': components['schemas']['pull-request-simple'] + } + } + 403: components['responses']['forbidden'] /** Unprocessable Entity if user is not a collaborator */ - 422: unknown; - }; + 422: unknown + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description An array of user `login`s that will be requested. */ - reviewers?: string[]; + reviewers?: string[] /** @description An array of team `slug`s that will be requested. */ - team_reviewers?: string[]; - }; - }; - }; - }; - "pulls/remove-requested-reviewers": { + team_reviewers?: string[] + } + } + } + } + 'pulls/remove-requested-reviewers': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pull-request-simple"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['pull-request-simple'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description An array of user `login`s that will be removed. */ - reviewers: string[]; + reviewers: string[] /** @description An array of team `slug`s that will be removed. */ - team_reviewers?: string[]; - }; - }; - }; - }; + team_reviewers?: string[] + } + } + } + } /** The list of reviews returns in chronological order. */ - "pulls/list-reviews": { + 'pulls/list-reviews': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** The list of reviews returns in chronological order. */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["pull-request-review"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['pull-request-review'][] + } + } + } + } /** * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. * @@ -35539,636 +35505,636 @@ export type operations = { * * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. */ - "pulls/create-review": { + 'pulls/create-review': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pull-request-review"]; - }; - }; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': components['schemas']['pull-request-review'] + } + } + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value. */ - commit_id?: string; + commit_id?: string /** @description **Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review. */ - body?: string; + body?: string /** * @description The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/rest/reference/pulls#submit-a-review-for-a-pull-request) when you are ready. * @enum {string} */ - event?: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; + event?: 'APPROVE' | 'REQUEST_CHANGES' | 'COMMENT' /** @description Use the following table to specify the location, destination, and contents of the draft review comment. */ comments?: { /** @description The relative path to the file that necessitates a review comment. */ - path: string; + path: string /** @description The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below. */ - position?: number; + position?: number /** @description Text of the review comment. */ - body: string; + body: string /** @example 28 */ - line?: number; + line?: number /** @example RIGHT */ - side?: string; + side?: string /** @example 26 */ - start_line?: number; + start_line?: number /** @example LEFT */ - start_side?: string; - }[]; - }; - }; - }; - }; - "pulls/get-review": { - parameters: { - path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; + start_side?: string + }[] + } + } + } + } + 'pulls/get-review': { + parameters: { + path: { + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] /** review_id parameter */ - review_id: components["parameters"]["review-id"]; - }; - }; + review_id: components['parameters']['review-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pull-request-review"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['pull-request-review'] + } + } + 404: components['responses']['not_found'] + } + } /** Update the review summary comment with new text. */ - "pulls/update-review": { + 'pulls/update-review': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] /** review_id parameter */ - review_id: components["parameters"]["review-id"]; - }; - }; + review_id: components['parameters']['review-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pull-request-review"]; - }; - }; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': components['schemas']['pull-request-review'] + } + } + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The body text of the pull request review. */ - body: string; - }; - }; - }; - }; - "pulls/delete-pending-review": { + body: string + } + } + } + } + 'pulls/delete-pending-review': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] /** review_id parameter */ - review_id: components["parameters"]["review-id"]; - }; - }; + review_id: components['parameters']['review-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pull-request-review"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; - }; + 'application/json': components['schemas']['pull-request-review'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } + } /** List comments for a specific pull request review. */ - "pulls/list-comments-for-review": { + 'pulls/list-comments-for-review': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] /** review_id parameter */ - review_id: components["parameters"]["review-id"]; - }; + review_id: components['parameters']['review-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["review-comment"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['review-comment'][] + } + } + 404: components['responses']['not_found'] + } + } /** **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/reference/repos#branches), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. */ - "pulls/dismiss-review": { + 'pulls/dismiss-review': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] /** review_id parameter */ - review_id: components["parameters"]["review-id"]; - }; - }; + review_id: components['parameters']['review-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pull-request-review"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': components['schemas']['pull-request-review'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The message for the pull request review dismissal */ - message: string; + message: string /** @example "APPROVE" */ - event?: string; - }; - }; - }; - }; - "pulls/submit-review": { + event?: string + } + } + } + } + 'pulls/submit-review': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] /** review_id parameter */ - review_id: components["parameters"]["review-id"]; - }; - }; + review_id: components['parameters']['review-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pull-request-review"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': components['schemas']['pull-request-review'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The body text of the pull request review */ - body?: string; + body?: string /** * @description The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When you leave this blank, the API returns _HTTP 422 (Unrecognizable entity)_ and sets the review action state to `PENDING`, which means you will need to re-submit the pull request review using a review action. * @enum {string} */ - event: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; - }; - }; - }; - }; + event: 'APPROVE' | 'REQUEST_CHANGES' | 'COMMENT' + } + } + } + } /** Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. */ - "pulls/update-branch": { + 'pulls/update-branch': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } + } responses: { /** Response */ 202: { content: { - "application/json": { - message?: string; - url?: string; - }; - }; - }; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': { + message?: string + url?: string + } + } + } + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the "[List commits](https://docs.github.com/rest/reference/repos#list-commits)" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref. */ - expected_head_sha?: string; - } | null; - }; - }; - }; + expected_head_sha?: string + } | null + } + } + } /** * Gets the preferred README for a repository. * * READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. */ - "repos/get-readme": { + 'repos/get-readme': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`) */ - ref?: string; - }; - }; + ref?: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["content-file"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['content-file'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** * Gets the README from a repository directory. * * READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. */ - "repos/get-readme-in-directory": { + 'repos/get-readme-in-directory': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The alternate path to look for a README file */ - dir: string; - }; + dir: string + } query: { /** The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`) */ - ref?: string; - }; - }; + ref?: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["content-file"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['content-file'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** * This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/rest/reference/repos#list-repository-tags). * * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. */ - "repos/list-releases": { + 'repos/list-releases': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["release"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['release'][] + } + } + 404: components['responses']['not_found'] + } + } /** * Users with push access to the repository can create a release. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - "repos/create-release": { + 'repos/create-release': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; + Location?: string + } content: { - "application/json": components["schemas"]["release"]; - }; - }; + 'application/json': components['schemas']['release'] + } + } /** Not Found if the discussion category name is invalid */ 404: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['basic-error'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the tag. */ - tag_name: string; + tag_name: string /** @description Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`). */ - target_commitish?: string; + target_commitish?: string /** @description The name of the release. */ - name?: string; + name?: string /** @description Text describing the contents of the tag. */ - body?: string; + body?: string /** @description `true` to create a draft (unpublished) release, `false` to create a published one. */ - draft?: boolean; + draft?: boolean /** @description `true` to identify the release as a prerelease. `false` to identify the release as a full release. */ - prerelease?: boolean; + prerelease?: boolean /** @description If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see "[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." */ - discussion_category_name?: string; + discussion_category_name?: string /** @description Whether to automatically generate the name and body for this release. If `name` is specified, the specified name will be used; otherwise, a name will be automatically generated. If `body` is specified, the body will be pre-pended to the automatically generated notes. */ - generate_release_notes?: boolean; - }; - }; - }; - }; + generate_release_notes?: boolean + } + } + } + } /** To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. */ - "repos/get-release-asset": { + 'repos/get-release-asset': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** asset_id parameter */ - asset_id: components["parameters"]["asset-id"]; - }; - }; + asset_id: components['parameters']['asset-id'] + } + } responses: { /** To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. */ 200: { content: { - "application/json": components["schemas"]["release-asset"]; - }; - }; - 302: components["responses"]["found"]; - 404: components["responses"]["not_found"]; - 415: components["responses"]["preview_header_missing"]; - }; - }; - "repos/delete-release-asset": { + 'application/json': components['schemas']['release-asset'] + } + } + 302: components['responses']['found'] + 404: components['responses']['not_found'] + 415: components['responses']['preview_header_missing'] + } + } + 'repos/delete-release-asset': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** asset_id parameter */ - asset_id: components["parameters"]["asset-id"]; - }; - }; + asset_id: components['parameters']['asset-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** Users with push access to the repository can edit a release asset. */ - "repos/update-release-asset": { + 'repos/update-release-asset': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** asset_id parameter */ - asset_id: components["parameters"]["asset-id"]; - }; - }; + asset_id: components['parameters']['asset-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["release-asset"]; - }; - }; - }; + 'application/json': components['schemas']['release-asset'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The file name of the asset. */ - name?: string; + name?: string /** @description An alternate short description of the asset. Used in place of the filename. */ - label?: string; + label?: string /** @example "uploaded" */ - state?: string; - }; - }; - }; - }; + state?: string + } + } + } + } /** Generate a name and body describing a [release](https://docs.github.com/rest/reference/repos#releases). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. */ - "repos/generate-release-notes": { + 'repos/generate-release-notes': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Name and body of generated release notes */ 200: { content: { - "application/json": components["schemas"]["release-notes-content"]; - }; - }; - 404: components["responses"]["not_found"]; - }; + 'application/json': components['schemas']['release-notes-content'] + } + } + 404: components['responses']['not_found'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The tag name for the release. This can be an existing tag or a new one. */ - tag_name: string; + tag_name: string /** @description Specifies the commitish value that will be the target for the release's tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists. */ - target_commitish?: string; + target_commitish?: string /** @description The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release. */ - previous_tag_name?: string; + previous_tag_name?: string /** @description Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used. */ - configuration_file_path?: string; - }; - }; - }; - }; + configuration_file_path?: string + } + } + } + } /** * View the latest published full release for the repository. * * The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published. */ - "repos/get-latest-release": { + 'repos/get-latest-release': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["release"]; - }; - }; - }; - }; + 'application/json': components['schemas']['release'] + } + } + } + } /** Get a published release with the specified tag. */ - "repos/get-release-by-tag": { + 'repos/get-release-by-tag': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** tag parameter */ - tag: string; - }; - }; + tag: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["release"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['release'] + } + } + 404: components['responses']['not_found'] + } + } /** **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia). */ - "repos/get-release": { + 'repos/get-release': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** release_id parameter */ - release_id: components["parameters"]["release-id"]; - }; - }; + release_id: components['parameters']['release-id'] + } + } responses: { /** **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia). */ 200: { content: { - "application/json": components["schemas"]["release"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['release'] + } + } + 404: components['responses']['not_found'] + } + } /** Users with push access to the repository can delete a release. */ - "repos/delete-release": { + 'repos/delete-release': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** release_id parameter */ - release_id: components["parameters"]["release-id"]; - }; - }; + release_id: components['parameters']['release-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** Users with push access to the repository can edit a release. */ - "repos/update-release": { + 'repos/update-release': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** release_id parameter */ - release_id: components["parameters"]["release-id"]; - }; - }; + release_id: components['parameters']['release-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["release"]; - }; - }; + 'application/json': components['schemas']['release'] + } + } /** Not Found if the discussion category name is invalid */ 404: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the tag. */ - tag_name?: string; + tag_name?: string /** @description Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`). */ - target_commitish?: string; + target_commitish?: string /** @description The name of the release. */ - name?: string; + name?: string /** @description Text describing the contents of the tag. */ - body?: string; + body?: string /** @description `true` makes the release a draft, and `false` publishes the release. */ - draft?: boolean; + draft?: boolean /** @description `true` to identify the release as a prerelease, `false` to identify the release as a full release. */ - prerelease?: boolean; + prerelease?: boolean /** @description If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. If there is already a discussion linked to the release, this parameter is ignored. For more information, see "[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." */ - discussion_category_name?: string; - }; - }; - }; - }; - "repos/list-release-assets": { + discussion_category_name?: string + } + } + } + } + 'repos/list-release-assets': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** release_id parameter */ - release_id: components["parameters"]["release-id"]; - }; + release_id: components['parameters']['release-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["release-asset"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['release-asset'][] + } + } + } + } /** * This endpoint makes use of [a Hypermedia relation](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in * the response of the [Create a release endpoint](https://docs.github.com/rest/reference/repos#create-a-release) to upload a release asset. @@ -36189,276 +36155,275 @@ export type operations = { * endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). * * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. */ - "repos/upload-release-asset": { + 'repos/upload-release-asset': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** release_id parameter */ - release_id: components["parameters"]["release-id"]; - }; + release_id: components['parameters']['release-id'] + } query: { - name: string; - label?: string; - }; - }; + name: string + label?: string + } + } responses: { /** Response for successful upload */ 201: { content: { - "application/json": components["schemas"]["release-asset"]; - }; - }; + 'application/json': components['schemas']['release-asset'] + } + } /** Response if you upload an asset with the same filename as another uploaded asset */ - 422: unknown; - }; + 422: unknown + } requestBody: { content: { - "*/*": string; - }; - }; - }; + '*/*': string + } + } + } /** Create a reaction to a [release](https://docs.github.com/rest/reference/repos#releases). A response with a `Status: 200 OK` means that you already added the reaction type to this release. */ - "reactions/create-for-release": { + 'reactions/create-for-release': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** release_id parameter */ - release_id: components["parameters"]["release-id"]; - }; - }; + release_id: components['parameters']['release-id'] + } + } responses: { /** Reaction exists */ 200: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; + 'application/json': components['schemas']['reaction'] + } + } /** Reaction created */ 201: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['reaction'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the release. * @enum {string} */ - content: "+1" | "laugh" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - }; + content: '+1' | 'laugh' | 'heart' | 'hooray' | 'rocket' | 'eyes' + } + } + } + } /** * Lists secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. */ - "secret-scanning/list-alerts-for-repo": { + 'secret-scanning/list-alerts-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - state?: components["parameters"]["secret-scanning-alert-state"]; + state?: components['parameters']['secret-scanning-alert-state'] /** * A comma-separated list of secret types to return. By default all secret types are returned. * See "[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)" * for a complete list of secret types (API slug). */ - secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; + secret_type?: components['parameters']['secret-scanning-alert-secret-type'] /** A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - resolution?: components["parameters"]["secret-scanning-alert-resolution"]; + resolution?: components['parameters']['secret-scanning-alert-resolution'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["secret-scanning-alert"][]; - }; - }; + 'application/json': components['schemas']['secret-scanning-alert'][] + } + } /** Repository is public or secret scanning is disabled for the repository */ - 404: unknown; - 503: components["responses"]["service_unavailable"]; - }; - }; + 404: unknown + 503: components['responses']['service_unavailable'] + } + } /** * Gets a single secret scanning alert detected in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. */ - "secret-scanning/get-alert": { + 'secret-scanning/get-alert': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ - alert_number: components["parameters"]["alert-number"]; - }; - }; + alert_number: components['parameters']['alert-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["secret-scanning-alert"]; - }; - }; - 304: components["responses"]["not_modified"]; + 'application/json': components['schemas']['secret-scanning-alert'] + } + } + 304: components['responses']['not_modified'] /** Repository is public, or secret scanning is disabled for the repository, or the resource is not found */ - 404: unknown; - 503: components["responses"]["service_unavailable"]; - }; - }; + 404: unknown + 503: components['responses']['service_unavailable'] + } + } /** * Updates the status of a secret scanning alert in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint. */ - "secret-scanning/update-alert": { + 'secret-scanning/update-alert': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ - alert_number: components["parameters"]["alert-number"]; - }; - }; + alert_number: components['parameters']['alert-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["secret-scanning-alert"]; - }; - }; + 'application/json': components['schemas']['secret-scanning-alert'] + } + } /** Repository is public, or secret scanning is disabled for the repository, or the resource is not found */ - 404: unknown; + 404: unknown /** State does not match the resolution */ - 422: unknown; - 503: components["responses"]["service_unavailable"]; - }; + 422: unknown + 503: components['responses']['service_unavailable'] + } requestBody: { content: { - "application/json": { - state: components["schemas"]["secret-scanning-alert-state"]; - resolution?: components["schemas"]["secret-scanning-alert-resolution"]; - }; - }; - }; - }; + 'application/json': { + state: components['schemas']['secret-scanning-alert-state'] + resolution?: components['schemas']['secret-scanning-alert-resolution'] + } + } + } + } /** * Lists all locations for a given secret scanning alert for a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. */ - "secret-scanning/list-locations-for-alert": { + 'secret-scanning/list-locations-for-alert': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ - alert_number: components["parameters"]["alert-number"]; - }; + alert_number: components['parameters']['alert-number'] + } query: { /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["secret-scanning-location"][]; - }; - }; + 'application/json': components['schemas']['secret-scanning-location'][] + } + } /** Repository is public, or secret scanning is disabled for the repository, or the resource is not found */ - 404: unknown; - 503: components["responses"]["service_unavailable"]; - }; - }; + 404: unknown + 503: components['responses']['service_unavailable'] + } + } /** * Lists the people that have starred the repository. * * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: */ - "activity/list-stargazers-for-repo": { + 'activity/list-stargazers-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": Partial & - Partial; - }; - }; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': Partial & Partial + } + } + 422: components['responses']['validation_failed'] + } + } /** Returns a weekly aggregate of the number of additions and deletions pushed to a repository. */ - "repos/get-code-frequency-stats": { + 'repos/get-code-frequency-stats': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Returns a weekly aggregate of the number of additions and deletions pushed to a repository. */ 200: { content: { - "application/json": components["schemas"]["code-frequency-stat"][]; - }; - }; - 202: components["responses"]["accepted"]; - 204: components["responses"]["no_content"]; - }; - }; + 'application/json': components['schemas']['code-frequency-stat'][] + } + } + 202: components['responses']['accepted'] + 204: components['responses']['no_content'] + } + } /** Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`. */ - "repos/get-commit-activity-stats": { + 'repos/get-commit-activity-stats': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["commit-activity"][]; - }; - }; - 202: components["responses"]["accepted"]; - 204: components["responses"]["no_content"]; - }; - }; + 'application/json': components['schemas']['commit-activity'][] + } + } + 202: components['responses']['accepted'] + 204: components['responses']['no_content'] + } + } /** * Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information: * @@ -36467,13 +36432,13 @@ export type operations = { * * `d` - Number of deletions * * `c` - Number of commits */ - "repos/get-contributors-stats": { + 'repos/get-contributors-stats': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** * * `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time). @@ -36483,35 +36448,35 @@ export type operations = { */ 200: { content: { - "application/json": components["schemas"]["contributor-activity"][]; - }; - }; - 202: components["responses"]["accepted"]; - 204: components["responses"]["no_content"]; - }; - }; + 'application/json': components['schemas']['contributor-activity'][] + } + } + 202: components['responses']['accepted'] + 204: components['responses']['no_content'] + } + } /** * Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`. * * The array order is oldest week (index 0) to most recent week. */ - "repos/get-participation-stats": { + 'repos/get-participation-stats': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** The array order is oldest week (index 0) to most recent week. */ 200: { content: { - "application/json": components["schemas"]["participation-stats"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['participation-stats'] + } + } + 404: components['responses']['not_found'] + } + } /** * Each array contains the day number, hour number, and number of commits: * @@ -36521,436 +36486,436 @@ export type operations = { * * For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. */ - "repos/get-punch-card-stats": { + 'repos/get-punch-card-stats': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. */ 200: { content: { - "application/json": components["schemas"]["code-frequency-stat"][]; - }; - }; - 204: components["responses"]["no_content"]; - }; - }; + 'application/json': components['schemas']['code-frequency-stat'][] + } + } + 204: components['responses']['no_content'] + } + } /** * Users with push access in a repository can create commit statuses for a given SHA. * * Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error. */ - "repos/create-commit-status": { + 'repos/create-commit-status': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - sha: string; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + sha: string + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; + Location?: string + } content: { - "application/json": components["schemas"]["status"]; - }; - }; - }; + 'application/json': components['schemas']['status'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The state of the status. Can be one of `error`, `failure`, `pending`, or `success`. * @enum {string} */ - state: "error" | "failure" | "pending" | "success"; + state: 'error' | 'failure' | 'pending' | 'success' /** * @description The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. * For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: * `http://ci.example.com/user/repo/build/sha` */ - target_url?: string; + target_url?: string /** @description A short description of the status. */ - description?: string; + description?: string /** * @description A string label to differentiate this status from the status of other systems. This field is case-insensitive. * @default default */ - context?: string; - }; - }; - }; - }; + context?: string + } + } + } + } /** Lists the people watching the specified repository. */ - "activity/list-watchers-for-repo": { + 'activity/list-watchers-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - }; - }; - "activity/get-repo-subscription": { + 'application/json': components['schemas']['simple-user'][] + } + } + } + } + 'activity/get-repo-subscription': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** if you subscribe to the repository */ 200: { content: { - "application/json": components["schemas"]["repository-subscription"]; - }; - }; - 403: components["responses"]["forbidden"]; + 'application/json': components['schemas']['repository-subscription'] + } + } + 403: components['responses']['forbidden'] /** Not Found if you don't subscribe to the repository */ - 404: unknown; - }; - }; + 404: unknown + } + } /** If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/rest/reference/activity#delete-a-repository-subscription) completely. */ - "activity/set-repo-subscription": { + 'activity/set-repo-subscription': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["repository-subscription"]; - }; - }; - }; + 'application/json': components['schemas']['repository-subscription'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Determines if notifications should be received from this repository. */ - subscribed?: boolean; + subscribed?: boolean /** @description Determines if all notifications should be blocked from this repository. */ - ignored?: boolean; - }; - }; - }; - }; + ignored?: boolean + } + } + } + } /** This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/rest/reference/activity#set-a-repository-subscription). */ - "activity/delete-repo-subscription": { + 'activity/delete-repo-subscription': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; - }; - "repos/list-tags": { + 204: never + } + } + 'repos/list-tags': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["tag"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['tag'][] + } + } + } + } /** * Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually * `master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. * **Note**: For private repositories, these links are temporary and expire after five minutes. */ - "repos/download-tarball-archive": { + 'repos/download-tarball-archive': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - ref: string; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + ref: string + } + } responses: { /** Response */ - 302: never; - }; - }; - "repos/list-teams": { + 302: never + } + } + 'repos/list-teams': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team"][]; - }; - }; - }; - }; - "repos/get-all-topics": { + 'application/json': components['schemas']['team'][] + } + } + } + } + 'repos/get-all-topics': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["topic"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "repos/replace-all-topics": { + 'application/json': components['schemas']['topic'] + } + } + 404: components['responses']['not_found'] + } + } + 'repos/replace-all-topics': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["topic"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': components['schemas']['topic'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters. */ - names: string[]; - }; - }; - }; - }; + names: string[] + } + } + } + } /** Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. */ - "repos/get-clones": { + 'repos/get-clones': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Must be one of: `day`, `week`. */ - per?: components["parameters"]["per"]; - }; - }; + per?: components['parameters']['per'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["clone-traffic"]; - }; - }; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['clone-traffic'] + } + } + 403: components['responses']['forbidden'] + } + } /** Get the top 10 popular contents over the last 14 days. */ - "repos/get-top-paths": { + 'repos/get-top-paths': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["content-traffic"][]; - }; - }; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['content-traffic'][] + } + } + 403: components['responses']['forbidden'] + } + } /** Get the top 10 referrers over the last 14 days. */ - "repos/get-top-referrers": { + 'repos/get-top-referrers': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["referrer-traffic"][]; - }; - }; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['referrer-traffic'][] + } + } + 403: components['responses']['forbidden'] + } + } /** Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. */ - "repos/get-views": { + 'repos/get-views': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Must be one of: `day`, `week`. */ - per?: components["parameters"]["per"]; - }; - }; + per?: components['parameters']['per'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["view-traffic"]; - }; - }; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['view-traffic'] + } + } + 403: components['responses']['forbidden'] + } + } /** A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/). */ - "repos/transfer": { + 'repos/transfer': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 202: { content: { - "application/json": components["schemas"]["minimal-repository"]; - }; - }; - }; + 'application/json': components['schemas']['minimal-repository'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The username or organization name the repository will be transferred to. */ - new_owner: string; + new_owner: string /** @description ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories. */ - team_ids?: number[]; - }; - }; - }; - }; + team_ids?: number[] + } + } + } + } /** Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". */ - "repos/check-vulnerability-alerts": { + 'repos/check-vulnerability-alerts': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response if repository is enabled with vulnerability alerts */ - 204: never; + 204: never /** Not Found if repository is not enabled with vulnerability alerts */ - 404: unknown; - }; - }; + 404: unknown + } + } /** Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". */ - "repos/enable-vulnerability-alerts": { + 'repos/enable-vulnerability-alerts': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". */ - "repos/disable-vulnerability-alerts": { + 'repos/disable-vulnerability-alerts': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually * `master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. * **Note**: For private repositories, these links are temporary and expire after five minutes. */ - "repos/download-zipball-archive": { + 'repos/download-zipball-archive': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - ref: string; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + ref: string + } + } responses: { /** Response */ - 302: never; - }; - }; + 302: never + } + } /** * Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. * @@ -36961,41 +36926,41 @@ export type operations = { * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. * * `repo` scope to create a private repository */ - "repos/create-using-template": { + 'repos/create-using-template': { parameters: { path: { - template_owner: string; - template_repo: string; - }; - }; + template_owner: string + template_repo: string + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; + Location?: string + } content: { - "application/json": components["schemas"]["repository"]; - }; - }; - }; + 'application/json': components['schemas']['repository'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization. */ - owner?: string; + owner?: string /** @description The name of the new repository. */ - name: string; + name: string /** @description A short description of the new repository. */ - description?: string; + description?: string /** @description Set to `true` to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: `false`. */ - include_all_branches?: boolean; + include_all_branches?: boolean /** @description Either `true` to create a new private repository or `false` to create a new public one. */ - private?: boolean; - }; - }; - }; - }; + private?: boolean + } + } + } + } /** * Lists all public repositories in the order that they were created. * @@ -37003,93 +36968,93 @@ export type operations = { * - For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories. */ - "repos/list-public": { + 'repos/list-public': { parameters: { query: { /** A repository ID. Only return repositories with an ID greater than this ID. */ - since?: components["parameters"]["since-repo"]; - }; - }; + since?: components['parameters']['since-repo'] + } + } responses: { /** Response */ 200: { headers: { - Link?: string; - }; - content: { - "application/json": components["schemas"]["minimal-repository"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 422: components["responses"]["validation_failed"]; - }; - }; + Link?: string + } + content: { + 'application/json': components['schemas']['minimal-repository'][] + } + } + 304: components['responses']['not_modified'] + 422: components['responses']['validation_failed'] + } + } /** Lists all secrets available in an environment without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - "actions/list-environment-secrets": { + 'actions/list-environment-secrets': { parameters: { path: { - repository_id: components["parameters"]["repository-id"]; + repository_id: components['parameters']['repository-id'] /** The name of the environment */ - environment_name: components["parameters"]["environment-name"]; - }; + environment_name: components['parameters']['environment-name'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - secrets: components["schemas"]["actions-secret"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + secrets: components['schemas']['actions-secret'][] + } + } + } + } + } /** Get the public key for an environment, which you need to encrypt environment secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - "actions/get-environment-public-key": { + 'actions/get-environment-public-key': { parameters: { path: { - repository_id: components["parameters"]["repository-id"]; + repository_id: components['parameters']['repository-id'] /** The name of the environment */ - environment_name: components["parameters"]["environment-name"]; - }; - }; + environment_name: components['parameters']['environment-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-public-key"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-public-key'] + } + } + } + } /** Gets a single environment secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - "actions/get-environment-secret": { + 'actions/get-environment-secret': { parameters: { path: { - repository_id: components["parameters"]["repository-id"]; + repository_id: components['parameters']['repository-id'] /** The name of the environment */ - environment_name: components["parameters"]["environment-name"]; + environment_name: components['parameters']['environment-name'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-secret"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-secret'] + } + } + } + } /** * Creates or updates an environment secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -37167,229 +37132,229 @@ export type operations = { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - "actions/create-or-update-environment-secret": { + 'actions/create-or-update-environment-secret': { parameters: { path: { - repository_id: components["parameters"]["repository-id"]; + repository_id: components['parameters']['repository-id'] /** The name of the environment */ - environment_name: components["parameters"]["environment-name"]; + environment_name: components['parameters']['environment-name'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response when creating a secret */ 201: { content: { - "application/json": components["schemas"]["empty-object"]; - }; - }; + 'application/json': components['schemas']['empty-object'] + } + } /** Response when updating a secret */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/reference/actions#get-an-environment-public-key) endpoint. */ - encrypted_value: string; + encrypted_value: string /** @description ID of the key you used to encrypt the secret. */ - key_id: string; - }; - }; - }; - }; + key_id: string + } + } + } + } /** Deletes a secret in an environment using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - "actions/delete-environment-secret": { + 'actions/delete-environment-secret': { parameters: { path: { - repository_id: components["parameters"]["repository-id"]; + repository_id: components['parameters']['repository-id'] /** The name of the environment */ - environment_name: components["parameters"]["environment-name"]; + environment_name: components['parameters']['environment-name'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Default response */ - 204: never; - }; - }; + 204: never + } + } /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - "enterprise-admin/list-provisioned-groups-enterprise": { + 'enterprise-admin/list-provisioned-groups-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; + enterprise: components['parameters']['enterprise'] + } query: { /** Used for pagination: the index of the first result to return. */ - startIndex?: components["parameters"]["start-index"]; + startIndex?: components['parameters']['start-index'] /** Used for pagination: the number of results to return. */ - count?: components["parameters"]["count"]; + count?: components['parameters']['count'] /** filter results */ - filter?: string; + filter?: string /** attributes to exclude */ - excludedAttributes?: string; - }; - }; + excludedAttributes?: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["scim-group-list-enterprise"]; - }; - }; - }; - }; + 'application/json': components['schemas']['scim-group-list-enterprise'] + } + } + } + } /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * * Provision an enterprise group, and invite users to the group. This sends invitation emails to the email address of the invited users to join the GitHub organization that the SCIM group corresponds to. */ - "enterprise-admin/provision-and-invite-enterprise-group": { + 'enterprise-admin/provision-and-invite-enterprise-group': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["scim-enterprise-group"]; - }; - }; - }; + 'application/json': components['schemas']['scim-enterprise-group'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The SCIM schema URIs. */ - schemas: string[]; + schemas: string[] /** @description The name of the SCIM group. This must match the GitHub organization that the group maps to. */ - displayName: string; + displayName: string members?: { /** @description The SCIM user ID for a user. */ - value: string; - }[]; - }; - }; - }; - }; + value: string + }[] + } + } + } + } /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - "enterprise-admin/get-provisioning-information-for-enterprise-group": { + 'enterprise-admin/get-provisioning-information-for-enterprise-group': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Identifier generated by the GitHub SCIM endpoint. */ - scim_group_id: components["parameters"]["scim-group-id"]; - }; + scim_group_id: components['parameters']['scim-group-id'] + } query: { /** Attributes to exclude. */ - excludedAttributes?: string; - }; - }; + excludedAttributes?: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["scim-enterprise-group"]; - }; - }; - }; - }; + 'application/json': components['schemas']['scim-enterprise-group'] + } + } + } + } /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * * Replaces an existing provisioned group’s information. You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead. */ - "enterprise-admin/set-information-for-provisioned-enterprise-group": { + 'enterprise-admin/set-information-for-provisioned-enterprise-group': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Identifier generated by the GitHub SCIM endpoint. */ - scim_group_id: components["parameters"]["scim-group-id"]; - }; - }; + scim_group_id: components['parameters']['scim-group-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["scim-enterprise-group"]; - }; - }; - }; + 'application/json': components['schemas']['scim-enterprise-group'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The SCIM schema URIs. */ - schemas: string[]; + schemas: string[] /** @description The name of the SCIM group. This must match the GitHub organization that the group maps to. */ - displayName: string; + displayName: string members?: { /** @description The SCIM user ID for a user. */ - value: string; - }[]; - }; - }; - }; - }; + value: string + }[] + } + } + } + } /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - "enterprise-admin/delete-scim-group-from-enterprise": { + 'enterprise-admin/delete-scim-group-from-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Identifier generated by the GitHub SCIM endpoint. */ - scim_group_id: components["parameters"]["scim-group-id"]; - }; - }; + scim_group_id: components['parameters']['scim-group-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * * Allows you to change a provisioned group’s individual attributes. To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). */ - "enterprise-admin/update-attribute-for-enterprise-group": { + 'enterprise-admin/update-attribute-for-enterprise-group': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Identifier generated by the GitHub SCIM endpoint. */ - scim_group_id: components["parameters"]["scim-group-id"]; - }; - }; + scim_group_id: components['parameters']['scim-group-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["scim-enterprise-group"]; - }; - }; - }; + 'application/json': components['schemas']['scim-enterprise-group'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The SCIM schema URIs. */ - schemas: string[]; + schemas: string[] /** @description Array of [SCIM operations](https://tools.ietf.org/html/rfc7644#section-3.5.2). */ Operations: { /** @enum {string} */ - op: "add" | "Add" | "remove" | "Remove" | "replace" | "Replace"; - path?: string; + op: 'add' | 'Add' | 'remove' | 'Remove' | 'replace' | 'Replace' + path?: string /** @description Can be any value - string, number, array or object. */ - value?: unknown; - }[]; - }; - }; - }; - }; + value?: unknown + }[] + } + } + } + } /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * @@ -37410,30 +37375,30 @@ export type operations = { * - If the user signs in, their GitHub account is linked to this entry. * - If the user does not sign in (or does not create a new account when prompted), they are not added to the GitHub enterprise, and the external identity `null` entry remains in place. */ - "enterprise-admin/list-provisioned-identities-enterprise": { + 'enterprise-admin/list-provisioned-identities-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; + enterprise: components['parameters']['enterprise'] + } query: { /** Used for pagination: the index of the first result to return. */ - startIndex?: components["parameters"]["start-index"]; + startIndex?: components['parameters']['start-index'] /** Used for pagination: the number of results to return. */ - count?: components["parameters"]["count"]; + count?: components['parameters']['count'] /** filter results */ - filter?: string; - }; - }; + filter?: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["scim-user-list-enterprise"]; - }; - }; - }; - }; + 'application/json': components['schemas']['scim-user-list-enterprise'] + } + } + } + } /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * @@ -37441,70 +37406,70 @@ export type operations = { * * You can optionally include the groups a user will be invited to join. If you do not provide a list of `groups`, the user is provisioned for the enterprise, but no organization invitation emails will be sent. */ - "enterprise-admin/provision-and-invite-enterprise-user": { + 'enterprise-admin/provision-and-invite-enterprise-user': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["scim-enterprise-user"]; - }; - }; - }; + 'application/json': components['schemas']['scim-enterprise-user'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The SCIM schema URIs. */ - schemas: string[]; + schemas: string[] /** @description The username for the user. */ - userName: string; + userName: string name: { /** @description The first name of the user. */ - givenName: string; + givenName: string /** @description The last name of the user. */ - familyName: string; - }; + familyName: string + } /** @description List of user emails. */ emails: { /** @description The email address. */ - value: string; + value: string /** @description The type of email address. */ - type: string; + type: string /** @description Whether this email address is the primary address. */ - primary: boolean; - }[]; + primary: boolean + }[] /** @description List of SCIM group IDs the user is a member of. */ groups?: { - value?: string; - }[]; - }; - }; - }; - }; + value?: string + }[] + } + } + } + } /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - "enterprise-admin/get-provisioning-information-for-enterprise-user": { + 'enterprise-admin/get-provisioning-information-for-enterprise-user': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** scim_user_id parameter */ - scim_user_id: components["parameters"]["scim-user-id"]; - }; - }; + scim_user_id: components['parameters']['scim-user-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["scim-enterprise-user"]; - }; - }; - }; - }; + 'application/json': components['schemas']['scim-enterprise-user'] + } + } + } + } /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * @@ -37514,68 +37479,68 @@ export type operations = { * * **Warning:** Setting `active: false` removes the user from the enterprise, deletes the external identity, and deletes the associated `{scim_user_id}`. */ - "enterprise-admin/set-information-for-provisioned-enterprise-user": { + 'enterprise-admin/set-information-for-provisioned-enterprise-user': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** scim_user_id parameter */ - scim_user_id: components["parameters"]["scim-user-id"]; - }; - }; + scim_user_id: components['parameters']['scim-user-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["scim-enterprise-user"]; - }; - }; - }; + 'application/json': components['schemas']['scim-enterprise-user'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The SCIM schema URIs. */ - schemas: string[]; + schemas: string[] /** @description The username for the user. */ - userName: string; + userName: string name: { /** @description The first name of the user. */ - givenName: string; + givenName: string /** @description The last name of the user. */ - familyName: string; - }; + familyName: string + } /** @description List of user emails. */ emails: { /** @description The email address. */ - value: string; + value: string /** @description The type of email address. */ - type: string; + type: string /** @description Whether this email address is the primary address. */ - primary: boolean; - }[]; + primary: boolean + }[] /** @description List of SCIM group IDs the user is a member of. */ groups?: { - value?: string; - }[]; - }; - }; - }; - }; + value?: string + }[] + } + } + } + } /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - "enterprise-admin/delete-user-from-enterprise": { + 'enterprise-admin/delete-user-from-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** scim_user_id parameter */ - scim_user_id: components["parameters"]["scim-user-id"]; - }; - }; + scim_user_id: components['parameters']['scim-user-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * @@ -37596,34 +37561,34 @@ export type operations = { * } * ``` */ - "enterprise-admin/update-attribute-for-enterprise-user": { + 'enterprise-admin/update-attribute-for-enterprise-user': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** scim_user_id parameter */ - scim_user_id: components["parameters"]["scim-user-id"]; - }; - }; + scim_user_id: components['parameters']['scim-user-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["scim-enterprise-user"]; - }; - }; - }; + 'application/json': components['schemas']['scim-enterprise-user'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The SCIM schema URIs. */ - schemas: string[]; + schemas: string[] /** @description Array of [SCIM operations](https://tools.ietf.org/html/rfc7644#section-3.5.2). */ - Operations: { [key: string]: unknown }[]; - }; - }; - }; - }; + Operations: { [key: string]: unknown }[] + } + } + } + } /** * Retrieves a paginated list of all provisioned organization members, including pending invitations. If you provide the `filter` parameter, the resources for all matching provisions members are returned. * @@ -37642,16 +37607,16 @@ export type operations = { * - If the user signs in, their GitHub account is linked to this entry. * - If the user does not sign in (or does not create a new account when prompted), they are not added to the GitHub organization, and the external identity `null` entry remains in place. */ - "scim/list-provisioned-identities": { + 'scim/list-provisioned-identities': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Used for pagination: the index of the first result to return. */ - startIndex?: number; + startIndex?: number /** Used for pagination: the number of results to return. */ - count?: number; + count?: number /** * Filters results using the equals query parameter operator (`eq`). You can filter results that are equal to `id`, `userName`, `emails`, and `external_id`. For example, to search for an identity with the `userName` Octocat, you would use this query: * @@ -37661,99 +37626,99 @@ export type operations = { * * `?filter=emails%20eq%20\"octocat@github.com\"`. */ - filter?: string; - }; - }; + filter?: string + } + } responses: { /** Response */ 200: { content: { - "application/scim+json": components["schemas"]["scim-user-list"]; - }; - }; - 304: components["responses"]["not_modified"]; - 400: components["responses"]["scim_bad_request"]; - 403: components["responses"]["scim_forbidden"]; - 404: components["responses"]["scim_not_found"]; - }; - }; + 'application/scim+json': components['schemas']['scim-user-list'] + } + } + 304: components['responses']['not_modified'] + 400: components['responses']['scim_bad_request'] + 403: components['responses']['scim_forbidden'] + 404: components['responses']['scim_not_found'] + } + } /** Provision organization membership for a user, and send an activation email to the email address. */ - "scim/provision-and-invite-user": { + 'scim/provision-and-invite-user': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 201: { content: { - "application/scim+json": components["schemas"]["scim-user"]; - }; - }; - 304: components["responses"]["not_modified"]; - 400: components["responses"]["scim_bad_request"]; - 403: components["responses"]["scim_forbidden"]; - 404: components["responses"]["scim_not_found"]; - 409: components["responses"]["scim_conflict"]; - 500: components["responses"]["scim_internal_error"]; - }; + 'application/scim+json': components['schemas']['scim-user'] + } + } + 304: components['responses']['not_modified'] + 400: components['responses']['scim_bad_request'] + 403: components['responses']['scim_forbidden'] + 404: components['responses']['scim_not_found'] + 409: components['responses']['scim_conflict'] + 500: components['responses']['scim_internal_error'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description Configured by the admin. Could be an email, login, or username * @example someone@example.com */ - userName: string; + userName: string /** * @description The name of the user, suitable for display to end-users * @example Jon Doe */ - displayName?: string; + displayName?: string /** @example [object Object] */ name: { - givenName: string; - familyName: string; - formatted?: string; - }; + givenName: string + familyName: string + formatted?: string + } /** * @description user emails * @example [object Object],[object Object] */ emails: { - value: string; - primary?: boolean; - type?: string; - }[]; - schemas?: string[]; - externalId?: string; - groups?: string[]; - active?: boolean; - }; - }; - }; - }; - "scim/get-provisioning-information-for-user": { - parameters: { - path: { - org: components["parameters"]["org"]; + value: string + primary?: boolean + type?: string + }[] + schemas?: string[] + externalId?: string + groups?: string[] + active?: boolean + } + } + } + } + 'scim/get-provisioning-information-for-user': { + parameters: { + path: { + org: components['parameters']['org'] /** scim_user_id parameter */ - scim_user_id: components["parameters"]["scim-user-id"]; - }; - }; + scim_user_id: components['parameters']['scim-user-id'] + } + } responses: { /** Response */ 200: { content: { - "application/scim+json": components["schemas"]["scim-user"]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["scim_forbidden"]; - 404: components["responses"]["scim_not_found"]; - }; - }; + 'application/scim+json': components['schemas']['scim-user'] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['scim_forbidden'] + 404: components['responses']['scim_not_found'] + } + } /** * Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](https://docs.github.com/rest/reference/scim#update-an-attribute-for-a-scim-user) endpoint instead. * @@ -37761,77 +37726,77 @@ export type operations = { * * **Warning:** Setting `active: false` removes the user from the organization, deletes the external identity, and deletes the associated `{scim_user_id}`. */ - "scim/set-information-for-provisioned-user": { + 'scim/set-information-for-provisioned-user': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** scim_user_id parameter */ - scim_user_id: components["parameters"]["scim-user-id"]; - }; - }; + scim_user_id: components['parameters']['scim-user-id'] + } + } responses: { /** Response */ 200: { content: { - "application/scim+json": components["schemas"]["scim-user"]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["scim_forbidden"]; - 404: components["responses"]["scim_not_found"]; - }; + 'application/scim+json': components['schemas']['scim-user'] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['scim_forbidden'] + 404: components['responses']['scim_not_found'] + } requestBody: { content: { - "application/json": { - schemas?: string[]; + 'application/json': { + schemas?: string[] /** * @description The name of the user, suitable for display to end-users * @example Jon Doe */ - displayName?: string; - externalId?: string; - groups?: string[]; - active?: boolean; + displayName?: string + externalId?: string + groups?: string[] + active?: boolean /** * @description Configured by the admin. Could be an email, login, or username * @example someone@example.com */ - userName: string; + userName: string /** @example [object Object] */ name: { - givenName: string; - familyName: string; - formatted?: string; - }; + givenName: string + familyName: string + formatted?: string + } /** * @description user emails * @example [object Object],[object Object] */ emails: { - type?: string; - value: string; - primary?: boolean; - }[]; - }; - }; - }; - }; - "scim/delete-user-from-org": { - parameters: { - path: { - org: components["parameters"]["org"]; + type?: string + value: string + primary?: boolean + }[] + } + } + } + } + 'scim/delete-user-from-org': { + parameters: { + path: { + org: components['parameters']['org'] /** scim_user_id parameter */ - scim_user_id: components["parameters"]["scim-user-id"]; - }; - }; + scim_user_id: components['parameters']['scim-user-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["scim_forbidden"]; - 404: components["responses"]["scim_not_found"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 403: components['responses']['scim_forbidden'] + 404: components['responses']['scim_not_found'] + } + } /** * Allows you to change a provisioned user's individual attributes. To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). * @@ -37850,62 +37815,62 @@ export type operations = { * } * ``` */ - "scim/update-attribute-for-user": { + 'scim/update-attribute-for-user': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** scim_user_id parameter */ - scim_user_id: components["parameters"]["scim-user-id"]; - }; - }; + scim_user_id: components['parameters']['scim-user-id'] + } + } responses: { /** Response */ 200: { content: { - "application/scim+json": components["schemas"]["scim-user"]; - }; - }; - 304: components["responses"]["not_modified"]; - 400: components["responses"]["scim_bad_request"]; - 403: components["responses"]["scim_forbidden"]; - 404: components["responses"]["scim_not_found"]; + 'application/scim+json': components['schemas']['scim-user'] + } + } + 304: components['responses']['not_modified'] + 400: components['responses']['scim_bad_request'] + 403: components['responses']['scim_forbidden'] + 404: components['responses']['scim_not_found'] /** Response */ 429: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } + } requestBody: { content: { - "application/json": { - schemas?: string[]; + 'application/json': { + schemas?: string[] /** * @description Set of operations to be performed * @example [object Object] */ Operations: { /** @enum {string} */ - op: "add" | "remove" | "replace"; - path?: string; + op: 'add' | 'remove' | 'replace' + path?: string value?: | { - active?: boolean | null; - userName?: string | null; - externalId?: string | null; - givenName?: string | null; - familyName?: string | null; + active?: boolean | null + userName?: string | null + externalId?: string | null + givenName?: string | null + familyName?: string | null } | { - value?: string; - primary?: boolean; + value?: string + primary?: boolean }[] - | string; - }[]; - }; - }; - }; - }; + | string + }[] + } + } + } + } /** * Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -37926,38 +37891,38 @@ export type operations = { * * You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing * language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. */ - "search/code": { + 'search/code': { parameters: { query: { /** The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching code](https://docs.github.com/articles/searching-code/)" for a detailed list of qualifiers. */ - q: string; + q: string /** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */ - sort?: "indexed"; + sort?: 'indexed' /** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - order?: components["parameters"]["order"]; + order?: components['parameters']['order'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - incomplete_results: boolean; - items: components["schemas"]["code-search-result-item"][]; - }; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': { + total_count: number + incomplete_results: boolean + items: components['schemas']['code-search-result-item'][] + } + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + 503: components['responses']['service_unavailable'] + } + } /** * Find commits via various criteria on the default branch (usually `master`). This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -37968,35 +37933,35 @@ export type operations = { * * `q=repo:octocat/Spoon-Knife+css` */ - "search/commits": { + 'search/commits': { parameters: { query: { /** The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching commits](https://docs.github.com/articles/searching-commits/)" for a detailed list of qualifiers. */ - q: string; + q: string /** Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */ - sort?: "author-date" | "committer-date"; + sort?: 'author-date' | 'committer-date' /** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - order?: components["parameters"]["order"]; + order?: components['parameters']['order'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - incomplete_results: boolean; - items: components["schemas"]["commit-search-result-item"][]; - }; - }; - }; - 304: components["responses"]["not_modified"]; - }; - }; + 'application/json': { + total_count: number + incomplete_results: boolean + items: components['schemas']['commit-search-result-item'][] + } + } + } + 304: components['responses']['not_modified'] + } + } /** * Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -38011,49 +37976,49 @@ export type operations = { * * **Note:** For [user-to-server](https://docs.github.com/developers/apps/identifying-and-authorizing-users-for-github-apps#user-to-server-requests) GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." */ - "search/issues-and-pull-requests": { + 'search/issues-and-pull-requests': { parameters: { query: { /** The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching issues and pull requests](https://docs.github.com/articles/searching-issues-and-pull-requests/)" for a detailed list of qualifiers. */ - q: string; + q: string /** Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */ sort?: - | "comments" - | "reactions" - | "reactions-+1" - | "reactions--1" - | "reactions-smile" - | "reactions-thinking_face" - | "reactions-heart" - | "reactions-tada" - | "interactions" - | "created" - | "updated"; + | 'comments' + | 'reactions' + | 'reactions-+1' + | 'reactions--1' + | 'reactions-smile' + | 'reactions-thinking_face' + | 'reactions-heart' + | 'reactions-tada' + | 'interactions' + | 'created' + | 'updated' /** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - order?: components["parameters"]["order"]; + order?: components['parameters']['order'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - incomplete_results: boolean; - items: components["schemas"]["issue-search-result-item"][]; - }; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': { + total_count: number + incomplete_results: boolean + items: components['schemas']['issue-search-result-item'][] + } + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + 503: components['responses']['service_unavailable'] + } + } /** * Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -38065,40 +38030,40 @@ export type operations = { * * The labels that best match the query appear first in the search results. */ - "search/labels": { + 'search/labels': { parameters: { query: { /** The id of the repository. */ - repository_id: number; + repository_id: number /** The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). */ - q: string; + q: string /** Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */ - sort?: "created" | "updated"; + sort?: 'created' | 'updated' /** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - order?: components["parameters"]["order"]; + order?: components['parameters']['order'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - incomplete_results: boolean; - items: components["schemas"]["label-search-result-item"][]; - }; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': { + total_count: number + incomplete_results: boolean + items: components['schemas']['label-search-result-item'][] + } + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** * Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -38110,37 +38075,37 @@ export type operations = { * * This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results. */ - "search/repos": { + 'search/repos': { parameters: { query: { /** The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers. */ - q: string; + q: string /** Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */ - sort?: "stars" | "forks" | "help-wanted-issues" | "updated"; + sort?: 'stars' | 'forks' | 'help-wanted-issues' | 'updated' /** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - order?: components["parameters"]["order"]; + order?: components['parameters']['order'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - incomplete_results: boolean; - items: components["schemas"]["repo-search-result-item"][]; - }; - }; - }; - 304: components["responses"]["not_modified"]; - 422: components["responses"]["validation_failed"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': { + total_count: number + incomplete_results: boolean + items: components['schemas']['repo-search-result-item'][] + } + } + } + 304: components['responses']['not_modified'] + 422: components['responses']['validation_failed'] + 503: components['responses']['service_unavailable'] + } + } /** * Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers. * @@ -38152,31 +38117,31 @@ export type operations = { * * This query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results. */ - "search/topics": { + 'search/topics': { parameters: { query: { /** The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). */ - q: string; + q: string /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - incomplete_results: boolean; - items: components["schemas"]["topic-search-result-item"][]; - }; - }; - }; - 304: components["responses"]["not_modified"]; - }; - }; + 'application/json': { + total_count: number + incomplete_results: boolean + items: components['schemas']['topic-search-result-item'][] + } + } + } + 304: components['responses']['not_modified'] + } + } /** * Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -38188,54 +38153,54 @@ export type operations = { * * This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. */ - "search/users": { + 'search/users': { parameters: { query: { /** The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching users](https://docs.github.com/articles/searching-users/)" for a detailed list of qualifiers. */ - q: string; + q: string /** Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */ - sort?: "followers" | "repositories" | "joined"; + sort?: 'followers' | 'repositories' | 'joined' /** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - order?: components["parameters"]["order"]; + order?: components['parameters']['order'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - incomplete_results: boolean; - items: components["schemas"]["user-search-result-item"][]; - }; - }; - }; - 304: components["responses"]["not_modified"]; - 422: components["responses"]["validation_failed"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': { + total_count: number + incomplete_results: boolean + items: components['schemas']['user-search-result-item'][] + } + } + } + 304: components['responses']['not_modified'] + 422: components['responses']['validation_failed'] + 503: components['responses']['service_unavailable'] + } + } /** **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/reference/teams#get-a-team-by-name) endpoint. */ - "teams/get-legacy": { + 'teams/get-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; - }; + team_id: components['parameters']['team-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-full"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['team-full'] + } + } + 404: components['responses']['not_found'] + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/reference/teams#delete-a-team) endpoint. * @@ -38243,19 +38208,19 @@ export type operations = { * * If you are an organization owner, deleting a parent team will delete all of its child teams as well. */ - "teams/delete-legacy": { + 'teams/delete-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; - }; + team_id: components['parameters']['team-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/reference/teams#update-a-team) endpoint. * @@ -38263,36 +38228,36 @@ export type operations = { * * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. */ - "teams/update-legacy": { + 'teams/update-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; - }; + team_id: components['parameters']['team-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-full"]; - }; - }; + 'application/json': components['schemas']['team-full'] + } + } /** Response */ 201: { content: { - "application/json": components["schemas"]["team-full"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['team-full'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the team. */ - name: string; + name: string /** @description The description of the team. */ - description?: string; + description?: string /** * @description The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: * **For a non-nested team:** @@ -38302,7 +38267,7 @@ export type operations = { * \* `closed` - visible to all members of this organization. * @enum {string} */ - privacy?: "secret" | "closed"; + privacy?: 'secret' | 'closed' /** * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: * \* `pull` - team members can pull, but not push to or administer newly-added repositories. @@ -38311,42 +38276,42 @@ export type operations = { * @default pull * @enum {string} */ - permission?: "pull" | "push" | "admin"; + permission?: 'pull' | 'push' | 'admin' /** @description The ID of a team to set as the parent team. */ - parent_team_id?: number | null; - }; - }; - }; - }; + parent_team_id?: number | null + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/reference/teams#list-discussions) endpoint. * * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "teams/list-discussions-legacy": { + 'teams/list-discussions-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; + team_id: components['parameters']['team-id'] + } query: { /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team-discussion"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['team-discussion'][] + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/reference/teams#create-a-discussion) endpoint. * @@ -38354,132 +38319,132 @@ export type operations = { * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - "teams/create-discussion-legacy": { + 'teams/create-discussion-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; - }; + team_id: components['parameters']['team-id'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; + 'application/json': components['schemas']['team-discussion'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The discussion post's title. */ - title: string; + title: string /** @description The discussion post's body text. */ - body: string; + body: string /** @description Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. */ - private?: boolean; - }; - }; - }; - }; + private?: boolean + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/reference/teams#get-a-discussion) endpoint. * * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "teams/get-discussion-legacy": { + 'teams/get-discussion-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - }; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; - }; + 'application/json': components['schemas']['team-discussion'] + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/reference/teams#delete-a-discussion) endpoint. * * Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "teams/delete-discussion-legacy": { + 'teams/delete-discussion-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - }; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/reference/teams#update-a-discussion) endpoint. * * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "teams/update-discussion-legacy": { + 'teams/update-discussion-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - }; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; + 'application/json': components['schemas']['team-discussion'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The discussion post's title. */ - title?: string; + title?: string /** @description The discussion post's body text. */ - body?: string; - }; - }; - }; - }; + body?: string + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/reference/teams#list-discussion-comments) endpoint. * * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "teams/list-discussion-comments-legacy": { + 'teams/list-discussion-comments-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + } query: { /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team-discussion-comment"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['team-discussion-comment'][] + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/reference/teams#create-a-discussion-comment) endpoint. * @@ -38487,263 +38452,263 @@ export type operations = { * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - "teams/create-discussion-comment-legacy": { + 'teams/create-discussion-comment-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - }; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; + 'application/json': components['schemas']['team-discussion-comment'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The discussion comment's body text. */ - body: string; - }; - }; - }; - }; + body: string + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/reference/teams#get-a-discussion-comment) endpoint. * * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "teams/get-discussion-comment-legacy": { + 'teams/get-discussion-comment-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - comment_number: components["parameters"]["comment-number"]; - }; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + comment_number: components['parameters']['comment-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; - }; + 'application/json': components['schemas']['team-discussion-comment'] + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/reference/teams#delete-a-discussion-comment) endpoint. * * Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "teams/delete-discussion-comment-legacy": { + 'teams/delete-discussion-comment-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - comment_number: components["parameters"]["comment-number"]; - }; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + comment_number: components['parameters']['comment-number'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/reference/teams#update-a-discussion-comment) endpoint. * * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "teams/update-discussion-comment-legacy": { + 'teams/update-discussion-comment-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - comment_number: components["parameters"]["comment-number"]; - }; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + comment_number: components['parameters']['comment-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; + 'application/json': components['schemas']['team-discussion-comment'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The discussion comment's body text. */ - body: string; - }; - }; - }; - }; + body: string + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * * List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "reactions/list-for-team-discussion-comment-legacy": { + 'reactions/list-for-team-discussion-comment-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - comment_number: components["parameters"]["comment-number"]; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + comment_number: components['parameters']['comment-number'] + } query: { /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion comment. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content?: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["reaction"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['reaction'][] + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. * * Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. */ - "reactions/create-for-team-discussion-comment-legacy": { + 'reactions/create-for-team-discussion-comment-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - comment_number: components["parameters"]["comment-number"]; - }; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + comment_number: components['parameters']['comment-number'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - }; + 'application/json': components['schemas']['reaction'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion comment. * @enum {string} */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - }; + content: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion) endpoint. * * List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "reactions/list-for-team-discussion-legacy": { + 'reactions/list-for-team-discussion-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + } query: { /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content?: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["reaction"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['reaction'][] + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion) endpoint. * * Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. */ - "reactions/create-for-team-discussion-legacy": { + 'reactions/create-for-team-discussion-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - }; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - }; + 'application/json': components['schemas']['reaction'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion. * @enum {string} */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - }; + content: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/reference/teams#list-pending-team-invitations) endpoint. * * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. */ - "teams/list-pending-invitations-legacy": { + 'teams/list-pending-invitations-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; + team_id: components['parameters']['team-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["organization-invitation"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['organization-invitation'][] + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/reference/teams#list-team-members) endpoint. * * Team members will include the members of child teams. */ - "teams/list-members-legacy": { + 'teams/list-members-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; + team_id: components['parameters']['team-id'] + } query: { /** * Filters members returned by their role in the team. Can be one of: @@ -38751,24 +38716,24 @@ export type operations = { * \* `maintainer` - team maintainers. * \* `all` - all members of the team. */ - role?: "member" | "maintainer" | "all"; + role?: 'member' | 'maintainer' | 'all' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + 404: components['responses']['not_found'] + } + } /** * The "Get team member" endpoint (described below) is deprecated. * @@ -38776,20 +38741,20 @@ export type operations = { * * To list members in a team, the team must be visible to the authenticated user. */ - "teams/get-member-legacy": { + 'teams/get-member-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - username: components["parameters"]["username"]; - }; - }; + team_id: components['parameters']['team-id'] + username: components['parameters']['username'] + } + } responses: { /** if user is a member */ - 204: never; + 204: never /** if user is not a member */ - 404: unknown; - }; - }; + 404: unknown + } + } /** * The "Add team member" endpoint (described below) is deprecated. * @@ -38803,23 +38768,23 @@ export type operations = { * * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - "teams/add-member-legacy": { + 'teams/add-member-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - username: components["parameters"]["username"]; - }; - }; + team_id: components['parameters']['team-id'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 403: components["responses"]["forbidden"]; + 204: never + 403: components['responses']['forbidden'] /** Not Found if team synchronization is set up */ - 404: unknown; + 404: unknown /** Unprocessable Entity if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization */ - 422: unknown; - }; - }; + 422: unknown + } + } /** * The "Remove team member" endpoint (described below) is deprecated. * @@ -38831,20 +38796,20 @@ export type operations = { * * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ - "teams/remove-member-legacy": { + 'teams/remove-member-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - username: components["parameters"]["username"]; - }; - }; + team_id: components['parameters']['team-id'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; + 204: never /** Not Found if team synchronization is setup */ - 404: unknown; - }; - }; + 404: unknown + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/reference/teams#get-team-membership-for-a-user) endpoint. * @@ -38857,23 +38822,23 @@ export type operations = { * * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team). */ - "teams/get-membership-for-user-legacy": { + 'teams/get-membership-for-user-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - username: components["parameters"]["username"]; - }; - }; + team_id: components['parameters']['team-id'] + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-membership"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['team-membership'] + } + } + 404: components['responses']['not_found'] + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint. * @@ -38887,29 +38852,29 @@ export type operations = { * * If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. */ - "teams/add-or-update-membership-for-user-legacy": { + 'teams/add-or-update-membership-for-user-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - username: components["parameters"]["username"]; - }; - }; + team_id: components['parameters']['team-id'] + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-membership"]; - }; - }; + 'application/json': components['schemas']['team-membership'] + } + } /** Forbidden if team synchronization is set up */ - 403: unknown; - 404: components["responses"]["not_found"]; + 403: unknown + 404: components['responses']['not_found'] /** Unprocessable Entity if you attempt to add an organization to a team */ - 422: unknown; - }; + 422: unknown + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The role that this user should have in the team. Can be one of: * \* `member` - a normal member of the team. @@ -38917,11 +38882,11 @@ export type operations = { * @default member * @enum {string} */ - role?: "member" | "maintainer"; - }; - }; - }; - }; + role?: 'member' | 'maintainer' + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/reference/teams#remove-team-membership-for-a-user) endpoint. * @@ -38931,101 +38896,101 @@ export type operations = { * * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ - "teams/remove-membership-for-user-legacy": { + 'teams/remove-membership-for-user-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - username: components["parameters"]["username"]; - }; - }; + team_id: components['parameters']['team-id'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; + 204: never /** if team synchronization is set up */ - 403: unknown; - }; - }; + 403: unknown + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/reference/teams#list-team-projects) endpoint. * * Lists the organization projects for a team. */ - "teams/list-projects-legacy": { + 'teams/list-projects-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; + team_id: components['parameters']['team-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team-project"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['team-project'][] + } + } + 404: components['responses']['not_found'] + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/reference/teams#check-team-permissions-for-a-project) endpoint. * * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. */ - "teams/check-permissions-for-project-legacy": { + 'teams/check-permissions-for-project-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - project_id: components["parameters"]["project-id"]; - }; - }; + team_id: components['parameters']['team-id'] + project_id: components['parameters']['project-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-project"]; - }; - }; + 'application/json': components['schemas']['team-project'] + } + } /** Not Found if project is not managed by this team */ - 404: unknown; - }; - }; + 404: unknown + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/reference/teams#add-or-update-team-project-permissions) endpoint. * * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. */ - "teams/add-or-update-project-permissions-legacy": { + 'teams/add-or-update-project-permissions-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - project_id: components["parameters"]["project-id"]; - }; - }; + team_id: components['parameters']['team-id'] + project_id: components['parameters']['project-id'] + } + } responses: { /** Response */ - 204: never; + 204: never /** Forbidden if the project is not owned by the organization */ 403: { content: { - "application/json": { - message?: string; - documentation_url?: string; - }; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': { + message?: string + documentation_url?: string + } + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The permission to grant to the team for this project. Can be one of: * \* `read` - team members can read, but not write to or administer this project. @@ -39034,55 +38999,55 @@ export type operations = { * Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." * @enum {string} */ - permission?: "read" | "write" | "admin"; - }; - }; - }; - }; + permission?: 'read' | 'write' | 'admin' + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/reference/teams#remove-a-project-from-a-team) endpoint. * * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. */ - "teams/remove-project-legacy": { + 'teams/remove-project-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - project_id: components["parameters"]["project-id"]; - }; - }; + team_id: components['parameters']['team-id'] + project_id: components['parameters']['project-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - 415: components["responses"]["preview_header_missing"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + 415: components['responses']['preview_header_missing'] + 422: components['responses']['validation_failed'] + } + } /** **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/reference/teams#list-team-repositories) endpoint. */ - "teams/list-repos-legacy": { + 'teams/list-repos-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; + team_id: components['parameters']['team-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["minimal-repository"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['minimal-repository'][] + } + } + 404: components['responses']['not_found'] + } + } /** * **Note**: Repositories inherited through a parent team will also be checked. * @@ -39090,27 +39055,27 @@ export type operations = { * * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: */ - "teams/check-permissions-for-repo-legacy": { + 'teams/check-permissions-for-repo-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + team_id: components['parameters']['team-id'] + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Alternative response with extra repository information */ 200: { content: { - "application/json": components["schemas"]["team-repository"]; - }; - }; + 'application/json': components['schemas']['team-repository'] + } + } /** Response if repository is managed by this team */ - 204: never; + 204: never /** Not Found if repository is not managed by this team */ - 404: unknown; - }; - }; + 404: unknown + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/reference/teams#add-or-update-team-repository-permissions)" endpoint. * @@ -39118,23 +39083,23 @@ export type operations = { * * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - "teams/add-or-update-repo-permissions-legacy": { + 'teams/add-or-update-repo-permissions-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + team_id: components['parameters']['team-id'] + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + 204: never + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The permission to grant the team on this repository. Can be one of: * \* `pull` - team members can pull, but not push to or administer this repository. @@ -39144,29 +39109,29 @@ export type operations = { * If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. * @enum {string} */ - permission?: "pull" | "push" | "admin"; - }; - }; - }; - }; + permission?: 'pull' | 'push' | 'admin' + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/reference/teams#remove-a-repository-from-a-team) endpoint. * * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. */ - "teams/remove-repo-legacy": { + 'teams/remove-repo-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + team_id: components['parameters']['team-id'] + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List IdP groups for a team`](https://docs.github.com/rest/reference/teams#list-idp-groups-for-a-team) endpoint. * @@ -39174,23 +39139,23 @@ export type operations = { * * List IdP groups connected to a team on GitHub. */ - "teams/list-idp-groups-for-legacy": { + 'teams/list-idp-groups-for-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; - }; + team_id: components['parameters']['team-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["group-mapping"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['group-mapping'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create or update IdP group connections`](https://docs.github.com/rest/reference/teams#create-or-update-idp-group-connections) endpoint. * @@ -39198,249 +39163,249 @@ export type operations = { * * Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty `groups` array will remove all connections for a team. */ - "teams/create-or-update-idp-group-connections-legacy": { + 'teams/create-or-update-idp-group-connections-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; - }; + team_id: components['parameters']['team-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["group-mapping"]; - }; - }; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['group-mapping'] + } + } + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The IdP groups you want to connect to a GitHub team. When updating, the new `groups` object will replace the original one. You must include any existing groups that you don't want to remove. */ groups: { /** @description ID of the IdP group. */ - group_id: string; + group_id: string /** @description Name of the IdP group. */ - group_name: string; + group_name: string /** @description Description of the IdP group. */ - group_description: string; + group_description: string /** @example "caceab43fc9ffa20081c" */ - id?: string; + id?: string /** @example "external-team-6c13e7288ef7" */ - name?: string; + name?: string /** @example "moar cheese pleese" */ - description?: string; - }[]; + description?: string + }[] /** @example "I am not a timestamp" */ - synced_at?: string; - }; - }; - }; - }; + synced_at?: string + } + } + } + } /** **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/reference/teams#list-child-teams) endpoint. */ - "teams/list-child-legacy": { + 'teams/list-child-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; + team_id: components['parameters']['team-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** if child teams exist */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team"][]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['team'][] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** * If the authenticated user is authenticated through basic authentication or OAuth with the `user` scope, then the response lists public and private profile information. * * If the authenticated user is authenticated through OAuth without the `user` scope, then the response lists only public profile information. */ - "users/get-authenticated": { - parameters: {}; + 'users/get-authenticated': { + parameters: {} responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["private-user"] | components["schemas"]["public-user"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['private-user'] | components['schemas']['public-user'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** **Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API. */ - "users/update-authenticated": { - parameters: {}; + 'users/update-authenticated': { + parameters: {} responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["private-user"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['private-user'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The new name of the user. * @example Omar Jahandar */ - name?: string; + name?: string /** * @description The publicly visible email address of the user. * @example omar@example.com */ - email?: string; + email?: string /** * @description The new blog URL of the user. * @example blog.example.com */ - blog?: string; + blog?: string /** * @description The new Twitter username of the user. * @example therealomarj */ - twitter_username?: string | null; + twitter_username?: string | null /** * @description The new company of the user. * @example Acme corporation */ - company?: string; + company?: string /** * @description The new location of the user. * @example Berlin, Germany */ - location?: string; + location?: string /** @description The new hiring availability of the user. */ - hireable?: boolean; + hireable?: boolean /** @description The new short biography of the user. */ - bio?: string; - }; - }; - }; - }; + bio?: string + } + } + } + } /** List the users you've blocked on your personal account. */ - "users/list-blocked-by-authenticated-user": { - parameters: {}; + 'users/list-blocked-by-authenticated-user': { + parameters: {} responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 415: components["responses"]["preview_header_missing"]; - }; - }; - "users/check-blocked": { + 'application/json': components['schemas']['simple-user'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 415: components['responses']['preview_header_missing'] + } + } + 'users/check-blocked': { parameters: { path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** If the user is blocked: */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] /** If the user is not blocked: */ 404: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - }; - }; - "users/block": { + 'application/json': components['schemas']['basic-error'] + } + } + } + } + 'users/block': { parameters: { path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "users/unblock": { + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } + 'users/unblock': { parameters: { path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Lists the authenticated user's codespaces. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/list-for-authenticated-user": { + 'codespaces/list-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** ID of the Repository to filter on */ - repository_id?: components["parameters"]["repository-id-in-query"]; - }; - }; + repository_id?: components['parameters']['repository-id-in-query'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - codespaces: components["schemas"]["codespace"][]; - }; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': { + total_count: number + codespaces: components['schemas']['codespace'][] + } + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** * Creates a new codespace, owned by the authenticated user. * @@ -39448,119 +39413,119 @@ export type operations = { * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/create-for-authenticated-user": { + 'codespaces/create-for-authenticated-user': { responses: { /** Response when the codespace was successfully created */ 201: { content: { - "application/json": components["schemas"]["codespace"]; - }; - }; + 'application/json': components['schemas']['codespace'] + } + } /** Response when the codespace creation partially failed but is being retried in the background */ 202: { content: { - "application/json": components["schemas"]["codespace"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; + 'application/json': components['schemas']['codespace'] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description Repository id for this codespace */ - repository_id: number; + repository_id: number /** @description Git ref (typically a branch name) for this codespace */ - ref?: string; + ref?: string /** @description Location for this codespace */ - location: string; + location: string /** @description Machine type to use for this codespace */ - machine?: string; + machine?: string /** @description Working directory for this codespace */ - working_directory?: string; + working_directory?: string /** @description Time in minutes before codespace stops from inactivity */ - idle_timeout_minutes?: number; + idle_timeout_minutes?: number } | { /** @description Pull request number for this codespace */ pull_request: { /** @description Pull request number */ - pull_request_number: number; + pull_request_number: number /** @description Repository id for this codespace */ - repository_id: number; - }; + repository_id: number + } /** @description Location for this codespace */ - location: string; + location: string /** @description Machine type to use for this codespace */ - machine?: string; + machine?: string /** @description Working directory for this codespace */ - working_directory?: string; + working_directory?: string /** @description Time in minutes before codespace stops from inactivity */ - idle_timeout_minutes?: number; - }; - }; - }; - }; + idle_timeout_minutes?: number + } + } + } + } /** * Lists all secrets available for a user's Codespaces without revealing their * encrypted values. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - "codespaces/list-secrets-for-authenticated-user": { + 'codespaces/list-secrets-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - secrets: components["schemas"]["codespaces-secret"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + secrets: components['schemas']['codespaces-secret'][] + } + } + } + } + } /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with one of the 'read:user' or 'user' scopes in their personal access token. User must have Codespaces access to use this endpoint. */ - "codespaces/get-public-key-for-authenticated-user": { + 'codespaces/get-public-key-for-authenticated-user': { responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["codespaces-user-public-key"]; - }; - }; - }; - }; + 'application/json': components['schemas']['codespaces-user-public-key'] + } + } + } + } /** * Gets a secret available to a user's codespaces without revealing its encrypted value. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - "codespaces/get-secret-for-authenticated-user": { + 'codespaces/get-secret-for-authenticated-user': { parameters: { path: { /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["codespaces-secret"]; - }; - }; - }; - }; + 'application/json': components['schemas']['codespaces-secret'] + } + } + } + } /** * Creates or updates a secret for a user's codespace with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access token with the `user` scope to use this endpoint. User must also have Codespaces access to use this endpoint. @@ -39636,195 +39601,195 @@ export type operations = { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - "codespaces/create-or-update-secret-for-authenticated-user": { + 'codespaces/create-or-update-secret-for-authenticated-user': { parameters: { path: { /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response after successfully creaing a secret */ 201: { content: { - "application/json": { [key: string]: unknown }; - }; - }; + 'application/json': { [key: string]: unknown } + } + } /** Response after successfully updating a secret */ - 204: never; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 204: never + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for the authenticated user](https://docs.github.com/rest/reference/codespaces#get-the-public-key-for-the-authenticated-user) endpoint. */ - encrypted_value: string; + encrypted_value: string /** @description ID of the key you used to encrypt the secret. */ - key_id: string; + key_id: string /** @description An array of repository ids that can access the user secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/reference/codespaces#list-selected-repositories-for-a-user-secret), [Set selected repositories for a user secret](https://docs.github.com/rest/reference/codespaces#set-selected-repositories-for-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/reference/codespaces#remove-a-selected-repository-from-a-user-secret) endpoints. */ - selected_repository_ids?: string[]; - }; - }; - }; - }; + selected_repository_ids?: string[] + } + } + } + } /** Deletes a secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret. You must authenticate using an access token with the `user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - "codespaces/delete-secret-for-authenticated-user": { + 'codespaces/delete-secret-for-authenticated-user': { parameters: { path: { /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * List the repositories that have been granted the ability to use a user's codespace secret. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - "codespaces/list-repositories-for-secret-for-authenticated-user": { + 'codespaces/list-repositories-for-secret-for-authenticated-user': { parameters: { path: { /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - repositories: components["schemas"]["minimal-repository"][]; - }; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': { + total_count: number + repositories: components['schemas']['minimal-repository'][] + } + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** * Select the repositories that will use a user's codespace secret. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - "codespaces/set-repositories-for-secret-for-authenticated-user": { + 'codespaces/set-repositories-for-secret-for-authenticated-user': { parameters: { path: { /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** No Content when repositories were added to the selected list */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description An array of repository ids for which a codespace can access the secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/reference/codespaces#list-selected-repositories-for-a-user-secret), [Add a selected repository to a user secret](https://docs.github.com/rest/reference/codespaces#add-a-selected-repository-to-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/reference/codespaces#remove-a-selected-repository-from-a-user-secret) endpoints. */ - selected_repository_ids: number[]; - }; - }; - }; - }; + selected_repository_ids: number[] + } + } + } + } /** * Adds a repository to the selected repositories for a user's codespace secret. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - "codespaces/add-repository-for-secret-for-authenticated-user": { + 'codespaces/add-repository-for-secret-for-authenticated-user': { parameters: { path: { /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - repository_id: number; - }; - }; + secret_name: components['parameters']['secret-name'] + repository_id: number + } + } responses: { /** No Content when repository was added to the selected list */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** * Removes a repository from the selected repositories for a user's codespace secret. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - "codespaces/remove-repository-for-secret-for-authenticated-user": { + 'codespaces/remove-repository-for-secret-for-authenticated-user': { parameters: { path: { /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - repository_id: number; - }; - }; + secret_name: components['parameters']['secret-name'] + repository_id: number + } + } responses: { /** No Content when repository was removed from the selected list */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** * Gets information about a user's codespace. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/get-for-authenticated-user": { + 'codespaces/get-for-authenticated-user': { parameters: { path: { /** The name of the codespace. */ - codespace_name: components["parameters"]["codespace-name"]; - }; - }; + codespace_name: components['parameters']['codespace-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["codespace"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': components['schemas']['codespace'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** * Deletes a user's codespace. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/delete-for-authenticated-user": { + 'codespaces/delete-for-authenticated-user': { parameters: { path: { /** The name of the codespace. */ - codespace_name: components["parameters"]["codespace-name"]; - }; - }; - responses: { - 202: components["responses"]["accepted"]; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + codespace_name: components['parameters']['codespace-name'] + } + } + responses: { + 202: components['responses']['accepted'] + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** * Updates a codespace owned by the authenticated user. Currently only the codespace's machine type and recent folders can be modified using this endpoint. * @@ -39832,470 +39797,470 @@ export type operations = { * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/update-for-authenticated-user": { + 'codespaces/update-for-authenticated-user': { parameters: { path: { /** The name of the codespace. */ - codespace_name: components["parameters"]["codespace-name"]; - }; - }; + codespace_name: components['parameters']['codespace-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["codespace"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; + 'application/json': components['schemas']['codespace'] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description A valid machine to transition this codespace to. */ - machine?: string; + machine?: string /** @description Recently opened folders inside the codespace. It is currently used by the clients to determine the folder path to load the codespace in. */ - recent_folders?: string[]; - }; - }; - }; - }; + recent_folders?: string[] + } + } + } + } /** * Triggers an export of the specified codespace and returns a URL and ID where the status of the export can be monitored. * * You must authenticate using a personal access token with the `codespace` scope to use this endpoint. */ - "codespaces/export-for-authenticated-user": { + 'codespaces/export-for-authenticated-user': { parameters: { path: { /** The name of the codespace. */ - codespace_name: components["parameters"]["codespace-name"]; - }; - }; + codespace_name: components['parameters']['codespace-name'] + } + } responses: { /** Response */ 202: { content: { - "application/json": components["schemas"]["codespace-export-details"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': components['schemas']['codespace-export-details'] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + 500: components['responses']['internal_error'] + } + } /** * Gets information about an export of a codespace. * * You must authenticate using a personal access token with the `codespace` scope to use this endpoint. */ - "codespaces/get-export-details-for-authenticated-user": { + 'codespaces/get-export-details-for-authenticated-user': { parameters: { path: { /** The name of the codespace. */ - codespace_name: components["parameters"]["codespace-name"]; + codespace_name: components['parameters']['codespace-name'] /** The ID of the export operation, or `latest`. Currently only `latest` is currently supported. */ - export_id: components["parameters"]["export-id"]; - }; - }; + export_id: components['parameters']['export-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["codespace-export-details"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['codespace-export-details'] + } + } + 404: components['responses']['not_found'] + } + } /** * List the machine types a codespace can transition to use. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/codespace-machines-for-authenticated-user": { + 'codespaces/codespace-machines-for-authenticated-user': { parameters: { path: { /** The name of the codespace. */ - codespace_name: components["parameters"]["codespace-name"]; - }; - }; + codespace_name: components['parameters']['codespace-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - machines: components["schemas"]["codespace-machine"][]; - }; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': { + total_count: number + machines: components['schemas']['codespace-machine'][] + } + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** * Starts a user's codespace. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/start-for-authenticated-user": { + 'codespaces/start-for-authenticated-user': { parameters: { path: { /** The name of the codespace. */ - codespace_name: components["parameters"]["codespace-name"]; - }; - }; + codespace_name: components['parameters']['codespace-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["codespace"]; - }; - }; - 304: components["responses"]["not_modified"]; - 400: components["responses"]["bad_request"]; - 401: components["responses"]["requires_authentication"]; + 'application/json': components['schemas']['codespace'] + } + } + 304: components['responses']['not_modified'] + 400: components['responses']['bad_request'] + 401: components['responses']['requires_authentication'] /** Payment required */ 402: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 409: components['responses']['conflict'] + 500: components['responses']['internal_error'] + } + } /** * Stops a user's codespace. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/stop-for-authenticated-user": { + 'codespaces/stop-for-authenticated-user': { parameters: { path: { /** The name of the codespace. */ - codespace_name: components["parameters"]["codespace-name"]; - }; - }; + codespace_name: components['parameters']['codespace-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["codespace"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': components['schemas']['codespace'] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** Sets the visibility for your primary email addresses. */ - "users/set-primary-email-visibility-for-authenticated-user": { - parameters: {}; + 'users/set-primary-email-visibility-for-authenticated-user': { + parameters: {} responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["email"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['email'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description Denotes whether an email is publicly visible. * @enum {string} */ - visibility: "public" | "private"; - }; - }; - }; - }; + visibility: 'public' | 'private' + } + } + } + } /** Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope. */ - "users/list-emails-for-authenticated-user": { + 'users/list-emails-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["email"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['email'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** This endpoint is accessible with the `user` scope. */ - "users/add-email-for-authenticated-user": { - parameters: {}; + 'users/add-email-for-authenticated-user': { + parameters: {} responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["email"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['email'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** * @description Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key. * @example */ - emails: string[]; + emails: string[] } | string[] - | string; - }; - }; - }; + | string + } + } + } /** This endpoint is accessible with the `user` scope. */ - "users/delete-email-for-authenticated-user": { - parameters: {}; + 'users/delete-email-for-authenticated-user': { + parameters: {} responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description Email addresses associated with the GitHub user account. */ - emails: string[]; + emails: string[] } | string[] - | string; - }; - }; - }; + | string + } + } + } /** Lists the people following the authenticated user. */ - "users/list-followers-for-authenticated-user": { + 'users/list-followers-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** Lists the people who the authenticated user follows. */ - "users/list-followed-by-authenticated-user": { + 'users/list-followed-by-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; - "users/check-person-is-followed-by-authenticated": { + 'application/json': components['schemas']['simple-user'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } + 'users/check-person-is-followed-by-authenticated': { parameters: { path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** if the person is followed by the authenticated user */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] /** if the person is not followed by the authenticated user */ 404: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } + } + } /** * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." * * Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. */ - "users/follow": { + 'users/follow': { parameters: { path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. */ - "users/unfollow": { + 'users/unfollow': { parameters: { path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "users/list-gpg-keys-for-authenticated-user": { + 'users/list-gpg-keys-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["gpg-key"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['gpg-key'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "users/create-gpg-key-for-authenticated-user": { - parameters: {}; + 'users/create-gpg-key-for-authenticated-user': { + parameters: {} responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["gpg-key"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['gpg-key'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description A GPG key in ASCII-armored format. */ - armored_public_key: string; - }; - }; - }; - }; + armored_public_key: string + } + } + } + } /** View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "users/get-gpg-key-for-authenticated-user": { + 'users/get-gpg-key-for-authenticated-user': { parameters: { path: { /** gpg_key_id parameter */ - gpg_key_id: components["parameters"]["gpg-key-id"]; - }; - }; + gpg_key_id: components['parameters']['gpg-key-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["gpg-key"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['gpg-key'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "users/delete-gpg-key-for-authenticated-user": { + 'users/delete-gpg-key-for-authenticated-user': { parameters: { path: { /** gpg_key_id parameter */ - gpg_key_id: components["parameters"]["gpg-key-id"]; - }; - }; + gpg_key_id: components['parameters']['gpg-key-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** * Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. * @@ -40305,32 +40270,32 @@ export type operations = { * * You can find the permissions for the installation under the `permissions` key. */ - "apps/list-installations-for-authenticated-user": { + 'apps/list-installations-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** You can find the permissions for the installation under the `permissions` key. */ 200: { - headers: {}; - content: { - "application/json": { - total_count: number; - installations: components["schemas"]["installation"][]; - }; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 415: components["responses"]["preview_header_missing"]; - }; - }; + headers: {} + content: { + 'application/json': { + total_count: number + installations: components['schemas']['installation'][] + } + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 415: components['responses']['preview_header_missing'] + } + } /** * List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation. * @@ -40340,116 +40305,115 @@ export type operations = { * * The access the user has to each repository is included in the hash under the `permissions` key. */ - "apps/list-installation-repos-for-authenticated-user": { + 'apps/list-installation-repos-for-authenticated-user': { parameters: { path: { /** installation_id parameter */ - installation_id: components["parameters"]["installation-id"]; - }; + installation_id: components['parameters']['installation-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** The access the user has to each repository is included in the hash under the `permissions` key. */ 200: { - headers: {}; - content: { - "application/json": { - total_count: number; - repository_selection?: string; - repositories: components["schemas"]["repository"][]; - }; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + headers: {} + content: { + 'application/json': { + total_count: number + repository_selection?: string + repositories: components['schemas']['repository'][] + } + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Add a single repository to an installation. The authenticated user must have admin access to the repository. * * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. */ - "apps/add-repo-to-installation-for-authenticated-user": { + 'apps/add-repo-to-installation-for-authenticated-user': { parameters: { path: { /** installation_id parameter */ - installation_id: components["parameters"]["installation-id"]; - repository_id: components["parameters"]["repository-id"]; - }; - }; + installation_id: components['parameters']['installation-id'] + repository_id: components['parameters']['repository-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Remove a single repository from an installation. The authenticated user must have admin access to the repository. * * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. */ - "apps/remove-repo-from-installation-for-authenticated-user": { + 'apps/remove-repo-from-installation-for-authenticated-user': { parameters: { path: { /** installation_id parameter */ - installation_id: components["parameters"]["installation-id"]; - repository_id: components["parameters"]["repository-id"]; - }; - }; - responses: { - /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + installation_id: components['parameters']['installation-id'] + repository_id: components['parameters']['repository-id'] + } + } + responses: { + /** Response */ + 204: never + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Shows which type of GitHub user can interact with your public repositories and when the restriction expires. */ - "interactions/get-restrictions-for-authenticated-user": { + 'interactions/get-restrictions-for-authenticated-user': { responses: { /** Default response */ 200: { content: { - "application/json": Partial & - Partial<{ [key: string]: unknown }>; - }; - }; + 'application/json': Partial & Partial<{ [key: string]: unknown }> + } + } /** Response when there are no restrictions */ - 204: never; - }; - }; + 204: never + } + } /** Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user. */ - "interactions/set-restrictions-for-authenticated-user": { + 'interactions/set-restrictions-for-authenticated-user': { responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["interaction-limit-response"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['interaction-limit-response'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": components["schemas"]["interaction-limit"]; - }; - }; - }; + 'application/json': components['schemas']['interaction-limit'] + } + } + } /** Removes any interaction restrictions from your public repositories. */ - "interactions/remove-restrictions-for-authenticated-user": { + 'interactions/remove-restrictions-for-authenticated-user': { responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * List issues across owned and member repositories assigned to the authenticated user. * @@ -40458,7 +40422,7 @@ export type operations = { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - "issues/list-for-authenticated-user": { + 'issues/list-for-authenticated-user': { parameters: { query: { /** @@ -40469,314 +40433,314 @@ export type operations = { * \* `subscribed`: Issues you're subscribed to updates for * \* `all` or `repos`: All issues the authenticated user can see, regardless of participation or creation */ - filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all"; + filter?: 'assigned' | 'created' | 'mentioned' | 'subscribed' | 'repos' | 'all' /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ - state?: "open" | "closed" | "all"; + state?: 'open' | 'closed' | 'all' /** A list of comma separated label names. Example: `bug,ui,@high` */ - labels?: components["parameters"]["labels"]; + labels?: components['parameters']['labels'] /** What to sort results by. Can be either `created`, `updated`, `comments`. */ - sort?: "created" | "updated" | "comments"; + sort?: 'created' | 'updated' | 'comments' /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["issue"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['issue'][] + } + } + 304: components['responses']['not_modified'] + 404: components['responses']['not_found'] + } + } /** Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "users/list-public-ssh-keys-for-authenticated-user": { + 'users/list-public-ssh-keys-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["key"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['key'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "users/create-public-ssh-key-for-authenticated-user": { - parameters: {}; + 'users/create-public-ssh-key-for-authenticated-user': { + parameters: {} responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["key"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['key'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description A descriptive name for the new key. * @example Personal MacBook Air */ - title?: string; + title?: string /** @description The public SSH key to add to your GitHub account. */ - key: string; - }; - }; - }; - }; + key: string + } + } + } + } /** View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "users/get-public-ssh-key-for-authenticated-user": { + 'users/get-public-ssh-key-for-authenticated-user': { parameters: { path: { /** key_id parameter */ - key_id: components["parameters"]["key-id"]; - }; - }; + key_id: components['parameters']['key-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["key"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['key'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "users/delete-public-ssh-key-for-authenticated-user": { + 'users/delete-public-ssh-key-for-authenticated-user': { parameters: { path: { /** key_id parameter */ - key_id: components["parameters"]["key-id"]; - }; - }; - responses: { - /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + key_id: components['parameters']['key-id'] + } + } + responses: { + /** Response */ + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Lists the active subscriptions for the authenticated user. You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an [OAuth token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/). */ - "apps/list-subscriptions-for-authenticated-user": { + 'apps/list-subscriptions-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["user-marketplace-purchase"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['user-marketplace-purchase'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 404: components['responses']['not_found'] + } + } /** Lists the active subscriptions for the authenticated user. You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an [OAuth token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/). */ - "apps/list-subscriptions-for-authenticated-user-stubbed": { + 'apps/list-subscriptions-for-authenticated-user-stubbed': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["user-marketplace-purchase"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - }; - }; - "orgs/list-memberships-for-authenticated-user": { + 'application/json': components['schemas']['user-marketplace-purchase'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + } + } + 'orgs/list-memberships-for-authenticated-user': { parameters: { query: { /** Indicates the state of the memberships to return. Can be either `active` or `pending`. If not specified, the API returns both active and pending memberships. */ - state?: "active" | "pending"; + state?: 'active' | 'pending' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["org-membership"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "orgs/get-membership-for-authenticated-user": { + 'application/json': components['schemas']['org-membership'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } + } + 'orgs/get-membership-for-authenticated-user': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["org-membership"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "orgs/update-membership-for-authenticated-user": { + 'application/json': components['schemas']['org-membership'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'orgs/update-membership-for-authenticated-user': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["org-membership"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['org-membership'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The state that the membership should be in. Only `"active"` will be accepted. * @enum {string} */ - state: "active"; - }; - }; - }; - }; + state: 'active' + } + } + } + } /** Lists all migrations a user has started. */ - "migrations/list-for-authenticated-user": { + 'migrations/list-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["migration"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['migration'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** Initiates the generation of a user migration archive. */ - "migrations/start-for-authenticated-user": { - parameters: {}; + 'migrations/start-for-authenticated-user': { + parameters: {} responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["migration"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['migration'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description Lock the repositories being migrated at the start of the migration * @example true */ - lock_repositories?: boolean; + lock_repositories?: boolean /** * @description Do not include attachments in the migration * @example true */ - exclude_attachments?: boolean; + exclude_attachments?: boolean /** * @description Do not include releases in the migration * @example true */ - exclude_releases?: boolean; + exclude_releases?: boolean /** * @description Indicates whether projects owned by the organization or users should be excluded. * @example true */ - exclude_owner_projects?: boolean; + exclude_owner_projects?: boolean /** * @description Exclude attributes from the API response to improve performance * @example repositories */ - exclude?: "repositories"[]; - repositories: string[]; - }; - }; - }; - }; + exclude?: 'repositories'[] + repositories: string[] + } + } + } + } /** * Fetches a single user migration. The response includes the `state` of the migration, which can be one of the following values: * @@ -40787,29 +40751,29 @@ export type operations = { * * Once the migration has been `exported` you can [download the migration archive](https://docs.github.com/rest/reference/migrations#download-a-user-migration-archive). */ - "migrations/get-status-for-authenticated-user": { + 'migrations/get-status-for-authenticated-user': { parameters: { path: { /** migration_id parameter */ - migration_id: components["parameters"]["migration-id"]; - }; + migration_id: components['parameters']['migration-id'] + } query: { - exclude?: string[]; - }; - }; + exclude?: string[] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["migration"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['migration'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Fetches the URL to download the migration archive as a `tar.gz` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects: * @@ -40833,82 +40797,82 @@ export type operations = { * * The archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data. */ - "migrations/get-archive-for-authenticated-user": { + 'migrations/get-archive-for-authenticated-user': { parameters: { path: { /** migration_id parameter */ - migration_id: components["parameters"]["migration-id"]; - }; - }; + migration_id: components['parameters']['migration-id'] + } + } responses: { /** Response */ - 302: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 302: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the [List user migrations](https://docs.github.com/rest/reference/migrations#list-user-migrations) and [Get a user migration status](https://docs.github.com/rest/reference/migrations#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted. */ - "migrations/delete-archive-for-authenticated-user": { + 'migrations/delete-archive-for-authenticated-user': { parameters: { path: { /** migration_id parameter */ - migration_id: components["parameters"]["migration-id"]; - }; - }; - responses: { - /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + migration_id: components['parameters']['migration-id'] + } + } + responses: { + /** Response */ + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Unlocks a repository. You can lock repositories when you [start a user migration](https://docs.github.com/rest/reference/migrations#start-a-user-migration). Once the migration is complete you can unlock each repository to begin using it again or [delete the repository](https://docs.github.com/rest/reference/repos#delete-a-repository) if you no longer need the source data. Returns a status of `404 Not Found` if the repository is not locked. */ - "migrations/unlock-repo-for-authenticated-user": { + 'migrations/unlock-repo-for-authenticated-user': { parameters: { path: { /** migration_id parameter */ - migration_id: components["parameters"]["migration-id"]; + migration_id: components['parameters']['migration-id'] /** repo_name parameter */ - repo_name: components["parameters"]["repo-name"]; - }; - }; - responses: { - /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + repo_name: components['parameters']['repo-name'] + } + } + responses: { + /** Response */ + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Lists all the repositories for this user migration. */ - "migrations/list-repos-for-authenticated-user": { + 'migrations/list-repos-for-authenticated-user': { parameters: { path: { /** migration_id parameter */ - migration_id: components["parameters"]["migration-id"]; - }; + migration_id: components['parameters']['migration-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["minimal-repository"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['minimal-repository'][] + } + } + 404: components['responses']['not_found'] + } + } /** * List organizations for the authenticated user. * @@ -40916,99 +40880,99 @@ export type operations = { * * This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response. */ - "orgs/list-for-authenticated-user": { + 'orgs/list-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["organization-simple"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['organization-simple'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** * Lists packages owned by the authenticated user within the user's namespace. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/list-packages-for-authenticated-user": { + 'packages/list-packages-for-authenticated-user': { parameters: { query: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + package_type: 'npm' | 'maven' | 'rubygems' | 'docker' | 'nuget' | 'container' /** The selected visibility of the packages. Can be one of `public`, `private`, or `internal`. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set. */ - visibility?: components["parameters"]["package-visibility"]; - }; - }; + visibility?: components['parameters']['package-visibility'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['package'][] + } + } + } + } /** * Gets a specific package for a package owned by the authenticated user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/get-package-for-authenticated-user": { + 'packages/get-package-for-authenticated-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - }; - }; + package_name: components['parameters']['package-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package"]; - }; - }; - }; - }; + 'application/json': components['schemas']['package'] + } + } + } + } /** * Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:delete` scopes. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/delete-package-for-authenticated-user": { + 'packages/delete-package-for-authenticated-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - }; - }; + package_name: components['parameters']['package-name'] + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Restores a package owned by the authenticated user. * @@ -41018,113 +40982,113 @@ export type operations = { * * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/restore-package-for-authenticated-user": { + 'packages/restore-package-for-authenticated-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - }; + package_name: components['parameters']['package-name'] + } query: { /** package token */ - token?: string; - }; - }; + token?: string + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Returns all package versions for a package owned by the authenticated user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/get-all-package-versions-for-package-owned-by-authenticated-user": { + 'packages/get-all-package-versions-for-package-owned-by-authenticated-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - }; + package_name: components['parameters']['package-name'] + } query: { /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** The state of the package, either active or deleted. */ - state?: "active" | "deleted"; - }; - }; + state?: 'active' | 'deleted' + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package-version"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['package-version'][] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Gets a specific package version for a package owned by the authenticated user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/get-package-version-for-authenticated-user": { + 'packages/get-package-version-for-authenticated-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; + package_name: components['parameters']['package-name'] /** Unique identifier of the package version. */ - package_version_id: components["parameters"]["package-version-id"]; - }; - }; + package_version_id: components['parameters']['package-version-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package-version"]; - }; - }; - }; - }; + 'application/json': components['schemas']['package-version'] + } + } + } + } /** * Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:delete` scopes. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/delete-package-version-for-authenticated-user": { + 'packages/delete-package-version-for-authenticated-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; + package_name: components['parameters']['package-name'] /** Unique identifier of the package version. */ - package_version_id: components["parameters"]["package-version-id"]; - }; - }; + package_version_id: components['parameters']['package-version-id'] + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Restores a package version owned by the authenticated user. * @@ -41134,131 +41098,131 @@ export type operations = { * * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/restore-package-version-for-authenticated-user": { + 'packages/restore-package-version-for-authenticated-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; + package_name: components['parameters']['package-name'] /** Unique identifier of the package version. */ - package_version_id: components["parameters"]["package-version-id"]; - }; - }; + package_version_id: components['parameters']['package-version-id'] + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "projects/create-for-authenticated-user": { - parameters: {}; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'projects/create-for-authenticated-user': { + parameters: {} responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["project"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 415: components["responses"]["preview_header_missing"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': components['schemas']['project'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 415: components['responses']['preview_header_missing'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description Name of the project * @example Week One Sprint */ - name: string; + name: string /** * @description Body of the project * @example This project represents the sprint of the first week in January */ - body?: string | null; - }; - }; - }; - }; + body?: string | null + } + } + } + } /** Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope. */ - "users/list-public-emails-for-authenticated-user": { + 'users/list-public-emails-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["email"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['email'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. * * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. */ - "repos/list-for-authenticated-user": { + 'repos/list-for-authenticated-user': { parameters: { query: { /** Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`. */ - visibility?: "all" | "public" | "private"; + visibility?: 'all' | 'public' | 'private' /** * Comma-separated list of values. Can include: * \* `owner`: Repositories that are owned by the authenticated user. * \* `collaborator`: Repositories that the user has been added to as a collaborator. * \* `organization_member`: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on. */ - affiliation?: string; + affiliation?: string /** * Can be one of `all`, `owner`, `public`, `private`, `member`. Note: For GitHub AE, can be one of `all`, `owner`, `internal`, `private`, `member`. Default: `all` * * Will cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**. */ - type?: "all" | "owner" | "public" | "private" | "member"; + type?: 'all' | 'owner' | 'public' | 'private' | 'member' /** Can be one of `created`, `updated`, `pushed`, `full_name`. */ - sort?: "created" | "updated" | "pushed" | "full_name"; + sort?: 'created' | 'updated' | 'pushed' | 'full_name' /** Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc` */ - direction?: "asc" | "desc"; + direction?: 'asc' | 'desc' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - before?: components["parameters"]["before"]; - }; - }; + before?: components['parameters']['before'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["repository"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['repository'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } + } /** * Creates a new repository for the authenticated user. * @@ -41269,323 +41233,323 @@ export type operations = { * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. * * `repo` scope to create a private repository. */ - "repos/create-for-authenticated-user": { - parameters: {}; + 'repos/create-for-authenticated-user': { + parameters: {} responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["repository"]; - }; - }; - 304: components["responses"]["not_modified"]; - 400: components["responses"]["bad_request"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['repository'] + } + } + 304: components['responses']['not_modified'] + 400: components['responses']['bad_request'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The name of the repository. * @example Team Environment */ - name: string; + name: string /** @description A short description of the repository. */ - description?: string; + description?: string /** @description A URL with more information about the repository. */ - homepage?: string; + homepage?: string /** @description Whether the repository is private. */ - private?: boolean; + private?: boolean /** * @description Whether issues are enabled. * @default true * @example true */ - has_issues?: boolean; + has_issues?: boolean /** * @description Whether projects are enabled. * @default true * @example true */ - has_projects?: boolean; + has_projects?: boolean /** * @description Whether the wiki is enabled. * @default true * @example true */ - has_wiki?: boolean; + has_wiki?: boolean /** @description The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. */ - team_id?: number; + team_id?: number /** @description Whether the repository is initialized with a minimal README. */ - auto_init?: boolean; + auto_init?: boolean /** * @description The desired language or platform to apply to the .gitignore. * @example Haskell */ - gitignore_template?: string; + gitignore_template?: string /** * @description The license keyword of the open source license for this repository. * @example mit */ - license_template?: string; + license_template?: string /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - allow_squash_merge?: boolean; + allow_squash_merge?: boolean /** * @description Whether to allow merge commits for pull requests. * @default true * @example true */ - allow_merge_commit?: boolean; + allow_merge_commit?: boolean /** * @description Whether to allow rebase merges for pull requests. * @default true * @example true */ - allow_rebase_merge?: boolean; + allow_rebase_merge?: boolean /** @description Whether to allow Auto-merge to be used on pull requests. */ - allow_auto_merge?: boolean; + allow_auto_merge?: boolean /** @description Whether to delete head branches when pull requests are merged */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge?: boolean /** * @description Whether downloads are enabled. * @default true * @example true */ - has_downloads?: boolean; + has_downloads?: boolean /** * @description Whether this repository acts as a template that can be used to generate new repositories. * @example true */ - is_template?: boolean; - }; - }; - }; - }; + is_template?: boolean + } + } + } + } /** When authenticating as a user, this endpoint will list all currently open repository invitations for that user. */ - "repos/list-invitations-for-authenticated-user": { + 'repos/list-invitations-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["repository-invitation"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "repos/decline-invitation-for-authenticated-user": { + 'application/json': components['schemas']['repository-invitation'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'repos/decline-invitation-for-authenticated-user': { parameters: { path: { /** invitation_id parameter */ - invitation_id: components["parameters"]["invitation-id"]; - }; - }; + invitation_id: components['parameters']['invitation-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; - }; - }; - "repos/accept-invitation-for-authenticated-user": { + 204: never + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 409: components['responses']['conflict'] + } + } + 'repos/accept-invitation-for-authenticated-user': { parameters: { path: { /** invitation_id parameter */ - invitation_id: components["parameters"]["invitation-id"]; - }; - }; + invitation_id: components['parameters']['invitation-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 409: components['responses']['conflict'] + } + } /** * Lists repositories the authenticated user has starred. * * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: */ - "activity/list-repos-starred-by-authenticated-user": { + 'activity/list-repos-starred-by-authenticated-user': { parameters: { query: { /** One of `created` (when the repository was starred) or `updated` (when it was last pushed to). */ - sort?: components["parameters"]["sort"]; + sort?: components['parameters']['sort'] /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["repository"][]; - "application/vnd.github.v3.star+json": components["schemas"]["starred-repository"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; - "activity/check-repo-is-starred-by-authenticated-user": { + 'application/json': components['schemas']['repository'][] + 'application/vnd.github.v3.star+json': components['schemas']['starred-repository'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } + 'activity/check-repo-is-starred-by-authenticated-user': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response if this repository is starred by you */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] /** Not Found if this repository is not starred by you */ 404: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } + } + } /** Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - "activity/star-repo-for-authenticated-user": { + 'activity/star-repo-for-authenticated-user': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "activity/unstar-repo-for-authenticated-user": { + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'activity/unstar-repo-for-authenticated-user': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Lists repositories the authenticated user is watching. */ - "activity/list-watched-repos-for-authenticated-user": { + 'activity/list-watched-repos-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["minimal-repository"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['minimal-repository'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** List all of the teams across all of the organizations to which the authenticated user belongs. This method requires `user`, `repo`, or `read:org` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://docs.github.com/apps/building-oauth-apps/). */ - "teams/list-for-authenticated-user": { + 'teams/list-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team-full"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['team-full'][] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts. * * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of users. */ - "users/list": { + 'users/list': { parameters: { query: { /** A user ID. Only return users with an ID greater than this ID. */ - since?: components["parameters"]["since-user"]; + since?: components['parameters']['since-user'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { headers: { - Link?: string; - }; + Link?: string + } content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 304: components["responses"]["not_modified"]; - }; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + 304: components['responses']['not_modified'] + } + } /** * Provides publicly available information about someone with a GitHub account. * @@ -41595,197 +41559,197 @@ export type operations = { * * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/reference/users#emails)". */ - "users/get-by-username": { + 'users/get-by-username': { parameters: { path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["private-user"] | components["schemas"]["public-user"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['private-user'] | components['schemas']['public-user'] + } + } + 404: components['responses']['not_found'] + } + } /** If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. */ - "activity/list-events-for-authenticated-user": { + 'activity/list-events-for-authenticated-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["event"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['event'][] + } + } + } + } /** This is the user's organization dashboard. You must be authenticated as the user to view this. */ - "activity/list-org-events-for-authenticated-user": { + 'activity/list-org-events-for-authenticated-user': { parameters: { path: { - username: components["parameters"]["username"]; - org: components["parameters"]["org"]; - }; + username: components['parameters']['username'] + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["event"][]; - }; - }; - }; - }; - "activity/list-public-events-for-user": { + 'application/json': components['schemas']['event'][] + } + } + } + } + 'activity/list-public-events-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["event"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['event'][] + } + } + } + } /** Lists the people following the specified user. */ - "users/list-followers-for-user": { + 'users/list-followers-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + } + } /** Lists the people who the specified user follows. */ - "users/list-following-for-user": { + 'users/list-following-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - }; - }; - "users/check-following-for-user": { + 'application/json': components['schemas']['simple-user'][] + } + } + } + } + 'users/check-following-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - target_user: string; - }; - }; + username: components['parameters']['username'] + target_user: string + } + } responses: { /** if the user follows the target user */ - 204: never; + 204: never /** if the user does not follow the target user */ - 404: unknown; - }; - }; + 404: unknown + } + } /** Lists public gists for the specified user: */ - "gists/list-for-user": { + 'gists/list-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["base-gist"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['base-gist'][] + } + } + 422: components['responses']['validation_failed'] + } + } /** Lists the GPG keys for a user. This information is accessible by anyone. */ - "users/list-gpg-keys-for-user": { + 'users/list-gpg-keys-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["gpg-key"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['gpg-key'][] + } + } + } + } /** * Provides hovercard information when authenticated through basic auth or OAuth with the `repo` scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. * @@ -41796,153 +41760,153 @@ export type operations = { * https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 * ``` */ - "users/get-context-for-user": { + 'users/get-context-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, `pull_request`. **Required** when using `subject_id`. */ - subject_type?: "organization" | "repository" | "issue" | "pull_request"; + subject_type?: 'organization' | 'repository' | 'issue' | 'pull_request' /** Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`. */ - subject_id?: string; - }; - }; + subject_id?: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["hovercard"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['hovercard'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** * Enables an authenticated GitHub App to find the user’s installation information. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/get-user-installation": { + 'apps/get-user-installation': { parameters: { path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["installation"]; - }; - }; - }; - }; + 'application/json': components['schemas']['installation'] + } + } + } + } /** Lists the _verified_ public SSH keys for a user. This is accessible by anyone. */ - "users/list-public-keys-for-user": { + 'users/list-public-keys-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["key-simple"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['key-simple'][] + } + } + } + } /** * List [public organization memberships](https://docs.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user. * * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/rest/reference/orgs#list-organizations-for-the-authenticated-user) API instead. */ - "orgs/list-for-user": { + 'orgs/list-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["organization-simple"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['organization-simple'][] + } + } + } + } /** * Lists all packages in a user's namespace for which the requesting user has access. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/list-packages-for-user": { + 'packages/list-packages-for-user': { parameters: { query: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + package_type: 'npm' | 'maven' | 'rubygems' | 'docker' | 'nuget' | 'container' /** The selected visibility of the packages. Can be one of `public`, `private`, or `internal`. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set. */ - visibility?: components["parameters"]["package-visibility"]; - }; + visibility?: components['parameters']['package-visibility'] + } path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['package'][] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** * Gets a specific package metadata for a public package owned by a user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/get-package-for-user": { + 'packages/get-package-for-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - username: components["parameters"]["username"]; - }; - }; + package_name: components['parameters']['package-name'] + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package"]; - }; - }; - }; - }; + 'application/json': components['schemas']['package'] + } + } + } + } /** * Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * @@ -41950,24 +41914,24 @@ export type operations = { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. */ - "packages/delete-package-for-user": { + 'packages/delete-package-for-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - username: components["parameters"]["username"]; - }; - }; + package_name: components['parameters']['package-name'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Restores an entire package for a user. * @@ -41979,83 +41943,83 @@ export type operations = { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. */ - "packages/restore-package-for-user": { + 'packages/restore-package-for-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - username: components["parameters"]["username"]; - }; + package_name: components['parameters']['package-name'] + username: components['parameters']['username'] + } query: { /** package token */ - token?: string; - }; - }; + token?: string + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Returns all package versions for a public package owned by a specified user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/get-all-package-versions-for-package-owned-by-user": { + 'packages/get-all-package-versions-for-package-owned-by-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - username: components["parameters"]["username"]; - }; - }; + package_name: components['parameters']['package-name'] + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package-version"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['package-version'][] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Gets a specific package version for a public package owned by a specified user. * * At this time, to use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/get-package-version-for-user": { + 'packages/get-package-version-for-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; + package_name: components['parameters']['package-name'] /** Unique identifier of the package version. */ - package_version_id: components["parameters"]["package-version-id"]; - username: components["parameters"]["username"]; - }; - }; + package_version_id: components['parameters']['package-version-id'] + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package-version"]; - }; - }; - }; - }; + 'application/json': components['schemas']['package-version'] + } + } + } + } /** * Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * @@ -42063,26 +42027,26 @@ export type operations = { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. */ - "packages/delete-package-version-for-user": { + 'packages/delete-package-version-for-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - username: components["parameters"]["username"]; + package_name: components['parameters']['package-name'] + username: components['parameters']['username'] /** Unique identifier of the package version. */ - package_version_id: components["parameters"]["package-version-id"]; - }; - }; + package_version_id: components['parameters']['package-version-id'] + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Restores a specific package version for a user. * @@ -42094,123 +42058,123 @@ export type operations = { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. */ - "packages/restore-package-version-for-user": { + 'packages/restore-package-version-for-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - username: components["parameters"]["username"]; + package_name: components['parameters']['package-name'] + username: components['parameters']['username'] /** Unique identifier of the package version. */ - package_version_id: components["parameters"]["package-version-id"]; - }; - }; + package_version_id: components['parameters']['package-version-id'] + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "projects/list-for-user": { + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'projects/list-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. */ - state?: "open" | "closed" | "all"; + state?: 'open' | 'closed' | 'all' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["project"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['project'][] + } + } + 422: components['responses']['validation_failed'] + } + } /** These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. */ - "activity/list-received-events-for-user": { + 'activity/list-received-events-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["event"][]; - }; - }; - }; - }; - "activity/list-received-public-events-for-user": { + 'application/json': components['schemas']['event'][] + } + } + } + } + 'activity/list-received-public-events-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["event"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['event'][] + } + } + } + } /** Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user. */ - "repos/list-for-user": { + 'repos/list-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Can be one of `all`, `owner`, `member`. */ - type?: "all" | "owner" | "member"; + type?: 'all' | 'owner' | 'member' /** Can be one of `created`, `updated`, `pushed`, `full_name`. */ - sort?: "created" | "updated" | "pushed" | "full_name"; + sort?: 'created' | 'updated' | 'pushed' | 'full_name' /** Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc` */ - direction?: "asc" | "desc"; + direction?: 'asc' | 'desc' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["minimal-repository"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['minimal-repository'][] + } + } + } + } /** * Gets the summary of the free and paid GitHub Actions minutes used. * @@ -42218,21 +42182,21 @@ export type operations = { * * Access tokens must have the `user` scope. */ - "billing/get-github-actions-billing-user": { + 'billing/get-github-actions-billing-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-billing-usage"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-billing-usage'] + } + } + } + } /** * Gets the free and paid storage used for GitHub Packages in gigabytes. * @@ -42240,21 +42204,21 @@ export type operations = { * * Access tokens must have the `user` scope. */ - "billing/get-github-packages-billing-user": { + 'billing/get-github-packages-billing-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["packages-billing-usage"]; - }; - }; - }; - }; + 'application/json': components['schemas']['packages-billing-usage'] + } + } + } + } /** * Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. * @@ -42262,87 +42226,86 @@ export type operations = { * * Access tokens must have the `user` scope. */ - "billing/get-shared-storage-billing-user": { + 'billing/get-shared-storage-billing-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["combined-billing-usage"]; - }; - }; - }; - }; + 'application/json': components['schemas']['combined-billing-usage'] + } + } + } + } /** * Lists repositories a user has starred. * * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: */ - "activity/list-repos-starred-by-user": { + 'activity/list-repos-starred-by-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** One of `created` (when the repository was starred) or `updated` (when it was last pushed to). */ - sort?: components["parameters"]["sort"]; + sort?: components['parameters']['sort'] /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": Partial & - Partial; - }; - }; - }; - }; + 'application/json': Partial & Partial + } + } + } + } /** Lists repositories a user is watching. */ - "activity/list-repos-watched-by-user": { + 'activity/list-repos-watched-by-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["minimal-repository"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['minimal-repository'][] + } + } + } + } /** Get a random sentence from the Zen of GitHub */ - "meta/get-zen": { + 'meta/get-zen': { responses: { /** Response */ 200: { content: { - "text/plain": string; - }; - }; - }; - }; -}; + 'text/plain': string + } + } + } + } +} -export type external = {}; +export type external = {} diff --git a/test/v3/expected/github.immutable.ts b/test/v3/expected/github.immutable.ts index c2d9a24fb..044fbd1b0 100644 --- a/test/v3/expected/github.immutable.ts +++ b/test/v3/expected/github.immutable.ts @@ -4,152 +4,152 @@ */ export interface paths { - readonly "/": { + readonly '/': { /** Get Hypermedia links to resources accessible in GitHub's REST API */ - readonly get: operations["meta/root"]; - }; - readonly "/app": { + readonly get: operations['meta/root'] + } + readonly '/app': { /** * Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/rest/reference/apps#list-installations-for-the-authenticated-app)" endpoint. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly get: operations["apps/get-authenticated"]; - }; - readonly "/app-manifests/{code}/conversions": { + readonly get: operations['apps/get-authenticated'] + } + readonly '/app-manifests/{code}/conversions': { /** Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. */ - readonly post: operations["apps/create-from-manifest"]; - }; - readonly "/app/hook/config": { + readonly post: operations['apps/create-from-manifest'] + } + readonly '/app/hook/config': { /** * Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly get: operations["apps/get-webhook-config-for-app"]; + readonly get: operations['apps/get-webhook-config-for-app'] /** * Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly patch: operations["apps/update-webhook-config-for-app"]; - }; - readonly "/app/hook/deliveries": { + readonly patch: operations['apps/update-webhook-config-for-app'] + } + readonly '/app/hook/deliveries': { /** * Returns a list of webhook deliveries for the webhook configured for a GitHub App. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly get: operations["apps/list-webhook-deliveries"]; - }; - readonly "/app/hook/deliveries/{delivery_id}": { + readonly get: operations['apps/list-webhook-deliveries'] + } + readonly '/app/hook/deliveries/{delivery_id}': { /** * Returns a delivery for the webhook configured for a GitHub App. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly get: operations["apps/get-webhook-delivery"]; - }; - readonly "/app/hook/deliveries/{delivery_id}/attempts": { + readonly get: operations['apps/get-webhook-delivery'] + } + readonly '/app/hook/deliveries/{delivery_id}/attempts': { /** * Redeliver a delivery for the webhook configured for a GitHub App. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly post: operations["apps/redeliver-webhook-delivery"]; - }; - readonly "/app/installations": { + readonly post: operations['apps/redeliver-webhook-delivery'] + } + readonly '/app/installations': { /** * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. * * The permissions the installation has are included under the `permissions` key. */ - readonly get: operations["apps/list-installations"]; - }; - readonly "/app/installations/{installation_id}": { + readonly get: operations['apps/list-installations'] + } + readonly '/app/installations/{installation_id}': { /** * Enables an authenticated GitHub App to find an installation's information using the installation id. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly get: operations["apps/get-installation"]; + readonly get: operations['apps/get-installation'] /** * Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/reference/apps/#suspend-an-app-installation)" endpoint. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly delete: operations["apps/delete-installation"]; - }; - readonly "/app/installations/{installation_id}/access_tokens": { + readonly delete: operations['apps/delete-installation'] + } + readonly '/app/installations/{installation_id}/access_tokens': { /** * Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly post: operations["apps/create-installation-access-token"]; - }; - readonly "/app/installations/{installation_id}/suspended": { + readonly post: operations['apps/create-installation-access-token'] + } + readonly '/app/installations/{installation_id}/suspended': { /** * Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly put: operations["apps/suspend-installation"]; + readonly put: operations['apps/suspend-installation'] /** * Removes a GitHub App installation suspension. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly delete: operations["apps/unsuspend-installation"]; - }; - readonly "/applications/grants": { + readonly delete: operations['apps/unsuspend-installation'] + } + readonly '/applications/grants': { /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * * You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/rest/reference/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `["repo", "user"]`. */ - readonly get: operations["oauth-authorizations/list-grants"]; - }; - readonly "/applications/grants/{grant_id}": { + readonly get: operations['oauth-authorizations/list-grants'] + } + readonly '/applications/grants/{grant_id}': { /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - readonly get: operations["oauth-authorizations/get-grant"]; + readonly get: operations['oauth-authorizations/get-grant'] /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ - readonly delete: operations["oauth-authorizations/delete-grant"]; - }; - readonly "/applications/{client_id}/grant": { + readonly delete: operations['oauth-authorizations/delete-grant'] + } + readonly '/applications/{client_id}/grant': { /** * OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ - readonly delete: operations["apps/delete-authorization"]; - }; - readonly "/applications/{client_id}/token": { + readonly delete: operations['apps/delete-authorization'] + } + readonly '/applications/{client_id}/token': { /** OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the OAuth application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`. */ - readonly post: operations["apps/check-token"]; + readonly post: operations['apps/check-token'] /** OAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. */ - readonly delete: operations["apps/delete-token"]; + readonly delete: operations['apps/delete-token'] /** OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. */ - readonly patch: operations["apps/reset-token"]; - }; - readonly "/applications/{client_id}/token/scoped": { + readonly patch: operations['apps/reset-token'] + } + readonly '/applications/{client_id}/token/scoped': { /** Use a non-scoped user-to-server OAuth access token to create a repository scoped and/or permission scoped user-to-server OAuth access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. */ - readonly post: operations["apps/scope-token"]; - }; - readonly "/apps/{app_slug}": { + readonly post: operations['apps/scope-token'] + } + readonly '/apps/{app_slug}': { /** * **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). * * If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ - readonly get: operations["apps/get-by-slug"]; - }; - readonly "/authorizations": { + readonly get: operations['apps/get-by-slug'] + } + readonly '/authorizations': { /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - readonly get: operations["oauth-authorizations/list-authorizations"]; + readonly get: operations['oauth-authorizations/list-authorizations'] /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * @@ -163,9 +163,9 @@ export interface paths { * * Organizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in [the GitHub Help documentation](https://docs.github.com/articles/about-identity-and-access-management-with-saml-single-sign-on). */ - readonly post: operations["oauth-authorizations/create-authorization"]; - }; - readonly "/authorizations/clients/{client_id}": { + readonly post: operations['oauth-authorizations/create-authorization'] + } + readonly '/authorizations/clients/{client_id}': { /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * @@ -177,9 +177,9 @@ export interface paths { * * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - readonly put: operations["oauth-authorizations/get-or-create-authorization-for-app"]; - }; - readonly "/authorizations/clients/{client_id}/{fingerprint}": { + readonly put: operations['oauth-authorizations/get-or-create-authorization-for-app'] + } + readonly '/authorizations/clients/{client_id}/{fingerprint}': { /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * @@ -189,13 +189,13 @@ export interface paths { * * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." */ - readonly put: operations["oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint"]; - }; - readonly "/authorizations/{authorization_id}": { + readonly put: operations['oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint'] + } + readonly '/authorizations/{authorization_id}': { /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - readonly get: operations["oauth-authorizations/get-authorization"]; + readonly get: operations['oauth-authorizations/get-authorization'] /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - readonly delete: operations["oauth-authorizations/delete-authorization"]; + readonly delete: operations['oauth-authorizations/delete-authorization'] /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * @@ -203,182 +203,182 @@ export interface paths { * * You can only send one of these scope keys at a time. */ - readonly patch: operations["oauth-authorizations/update-authorization"]; - }; - readonly "/codes_of_conduct": { - readonly get: operations["codes-of-conduct/get-all-codes-of-conduct"]; - }; - readonly "/codes_of_conduct/{key}": { - readonly get: operations["codes-of-conduct/get-conduct-code"]; - }; - readonly "/emojis": { + readonly patch: operations['oauth-authorizations/update-authorization'] + } + readonly '/codes_of_conduct': { + readonly get: operations['codes-of-conduct/get-all-codes-of-conduct'] + } + readonly '/codes_of_conduct/{key}': { + readonly get: operations['codes-of-conduct/get-conduct-code'] + } + readonly '/emojis': { /** Lists all the emojis available to use on GitHub. */ - readonly get: operations["emojis/get"]; - }; - readonly "/enterprises/{enterprise}/actions/permissions": { + readonly get: operations['emojis/get'] + } + readonly '/enterprises/{enterprise}/actions/permissions': { /** * Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - readonly get: operations["enterprise-admin/get-github-actions-permissions-enterprise"]; + readonly get: operations['enterprise-admin/get-github-actions-permissions-enterprise'] /** * Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - readonly put: operations["enterprise-admin/set-github-actions-permissions-enterprise"]; - }; - readonly "/enterprises/{enterprise}/actions/permissions/organizations": { + readonly put: operations['enterprise-admin/set-github-actions-permissions-enterprise'] + } + readonly '/enterprises/{enterprise}/actions/permissions/organizations': { /** * Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - readonly get: operations["enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise"]; + readonly get: operations['enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise'] /** * Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - readonly put: operations["enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise"]; - }; - readonly "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}": { + readonly put: operations['enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise'] + } + readonly '/enterprises/{enterprise}/actions/permissions/organizations/{org_id}': { /** * Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - readonly put: operations["enterprise-admin/enable-selected-organization-github-actions-enterprise"]; + readonly put: operations['enterprise-admin/enable-selected-organization-github-actions-enterprise'] /** * Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - readonly delete: operations["enterprise-admin/disable-selected-organization-github-actions-enterprise"]; - }; - readonly "/enterprises/{enterprise}/actions/permissions/selected-actions": { + readonly delete: operations['enterprise-admin/disable-selected-organization-github-actions-enterprise'] + } + readonly '/enterprises/{enterprise}/actions/permissions/selected-actions': { /** * Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - readonly get: operations["enterprise-admin/get-allowed-actions-enterprise"]; + readonly get: operations['enterprise-admin/get-allowed-actions-enterprise'] /** * Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - readonly put: operations["enterprise-admin/set-allowed-actions-enterprise"]; - }; - readonly "/enterprises/{enterprise}/actions/runner-groups": { + readonly put: operations['enterprise-admin/set-allowed-actions-enterprise'] + } + readonly '/enterprises/{enterprise}/actions/runner-groups': { /** * Lists all self-hosted runner groups for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - readonly get: operations["enterprise-admin/list-self-hosted-runner-groups-for-enterprise"]; + readonly get: operations['enterprise-admin/list-self-hosted-runner-groups-for-enterprise'] /** * Creates a new self-hosted runner group for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - readonly post: operations["enterprise-admin/create-self-hosted-runner-group-for-enterprise"]; - }; - readonly "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}": { + readonly post: operations['enterprise-admin/create-self-hosted-runner-group-for-enterprise'] + } + readonly '/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}': { /** * Gets a specific self-hosted runner group for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - readonly get: operations["enterprise-admin/get-self-hosted-runner-group-for-enterprise"]; + readonly get: operations['enterprise-admin/get-self-hosted-runner-group-for-enterprise'] /** * Deletes a self-hosted runner group for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - readonly delete: operations["enterprise-admin/delete-self-hosted-runner-group-from-enterprise"]; + readonly delete: operations['enterprise-admin/delete-self-hosted-runner-group-from-enterprise'] /** * Updates the `name` and `visibility` of a self-hosted runner group in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - readonly patch: operations["enterprise-admin/update-self-hosted-runner-group-for-enterprise"]; - }; - readonly "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations": { + readonly patch: operations['enterprise-admin/update-self-hosted-runner-group-for-enterprise'] + } + readonly '/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations': { /** * Lists the organizations with access to a self-hosted runner group. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - readonly get: operations["enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise"]; + readonly get: operations['enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise'] /** * Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - readonly put: operations["enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise"]; - }; - readonly "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}": { + readonly put: operations['enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise'] + } + readonly '/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}': { /** * Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - readonly put: operations["enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise"]; + readonly put: operations['enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise'] /** * Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - readonly delete: operations["enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise"]; - }; - readonly "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": { + readonly delete: operations['enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise'] + } + readonly '/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners': { /** * Lists the self-hosted runners that are in a specific enterprise group. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - readonly get: operations["enterprise-admin/list-self-hosted-runners-in-group-for-enterprise"]; + readonly get: operations['enterprise-admin/list-self-hosted-runners-in-group-for-enterprise'] /** * Replaces the list of self-hosted runners that are part of an enterprise runner group. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - readonly put: operations["enterprise-admin/set-self-hosted-runners-in-group-for-enterprise"]; - }; - readonly "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + readonly put: operations['enterprise-admin/set-self-hosted-runners-in-group-for-enterprise'] + } + readonly '/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}': { /** * Adds a self-hosted runner to a runner group configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` * scope to use this endpoint. */ - readonly put: operations["enterprise-admin/add-self-hosted-runner-to-group-for-enterprise"]; + readonly put: operations['enterprise-admin/add-self-hosted-runner-to-group-for-enterprise'] /** * Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - readonly delete: operations["enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise"]; - }; - readonly "/enterprises/{enterprise}/actions/runners": { + readonly delete: operations['enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise'] + } + readonly '/enterprises/{enterprise}/actions/runners': { /** * Lists all self-hosted runners configured for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - readonly get: operations["enterprise-admin/list-self-hosted-runners-for-enterprise"]; - }; - readonly "/enterprises/{enterprise}/actions/runners/downloads": { + readonly get: operations['enterprise-admin/list-self-hosted-runners-for-enterprise'] + } + readonly '/enterprises/{enterprise}/actions/runners/downloads': { /** * Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - readonly get: operations["enterprise-admin/list-runner-applications-for-enterprise"]; - }; - readonly "/enterprises/{enterprise}/actions/runners/registration-token": { + readonly get: operations['enterprise-admin/list-runner-applications-for-enterprise'] + } + readonly '/enterprises/{enterprise}/actions/runners/registration-token': { /** * Returns a token that you can pass to the `config` script. The token expires after one hour. * @@ -392,9 +392,9 @@ export interface paths { * ./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN * ``` */ - readonly post: operations["enterprise-admin/create-registration-token-for-enterprise"]; - }; - readonly "/enterprises/{enterprise}/actions/runners/remove-token": { + readonly post: operations['enterprise-admin/create-registration-token-for-enterprise'] + } + readonly '/enterprises/{enterprise}/actions/runners/remove-token': { /** * Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour. * @@ -409,51 +409,51 @@ export interface paths { * ./config.sh remove --token TOKEN * ``` */ - readonly post: operations["enterprise-admin/create-remove-token-for-enterprise"]; - }; - readonly "/enterprises/{enterprise}/actions/runners/{runner_id}": { + readonly post: operations['enterprise-admin/create-remove-token-for-enterprise'] + } + readonly '/enterprises/{enterprise}/actions/runners/{runner_id}': { /** * Gets a specific self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - readonly get: operations["enterprise-admin/get-self-hosted-runner-for-enterprise"]; + readonly get: operations['enterprise-admin/get-self-hosted-runner-for-enterprise'] /** * Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - readonly delete: operations["enterprise-admin/delete-self-hosted-runner-from-enterprise"]; - }; - readonly "/enterprises/{enterprise}/actions/runners/{runner_id}/labels": { + readonly delete: operations['enterprise-admin/delete-self-hosted-runner-from-enterprise'] + } + readonly '/enterprises/{enterprise}/actions/runners/{runner_id}/labels': { /** * Lists all labels for a self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - readonly get: operations["enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise"]; + readonly get: operations['enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise'] /** * Remove all previous custom labels and set the new custom labels for a specific * self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - readonly put: operations["enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise"]; + readonly put: operations['enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise'] /** * Add custom labels to a self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - readonly post: operations["enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise"]; + readonly post: operations['enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise'] /** * Remove all custom labels from a self-hosted runner configured in an * enterprise. Returns the remaining read-only labels from the runner. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - readonly delete: operations["enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise"]; - }; - readonly "/enterprises/{enterprise}/actions/runners/{runner_id}/labels/{name}": { + readonly delete: operations['enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise'] + } + readonly '/enterprises/{enterprise}/actions/runners/{runner_id}/labels/{name}': { /** * Remove a custom label from a self-hosted runner configured * in an enterprise. Returns the remaining labels from the runner. @@ -463,20 +463,20 @@ export interface paths { * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - readonly delete: operations["enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise"]; - }; - readonly "/enterprises/{enterprise}/audit-log": { + readonly delete: operations['enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise'] + } + readonly '/enterprises/{enterprise}/audit-log': { /** Gets the audit log for an enterprise. To use this endpoint, you must be an enterprise admin, and you must use an access token with the `admin:enterprise` scope. */ - readonly get: operations["enterprise-admin/get-audit-log"]; - }; - readonly "/enterprises/{enterprise}/secret-scanning/alerts": { + readonly get: operations['enterprise-admin/get-audit-log'] + } + readonly '/enterprises/{enterprise}/secret-scanning/alerts': { /** * Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. * To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). */ - readonly get: operations["secret-scanning/list-alerts-for-enterprise"]; - }; - readonly "/enterprises/{enterprise}/settings/billing/actions": { + readonly get: operations['secret-scanning/list-alerts-for-enterprise'] + } + readonly '/enterprises/{enterprise}/settings/billing/actions': { /** * Gets the summary of the free and paid GitHub Actions minutes used. * @@ -484,16 +484,16 @@ export interface paths { * * The authenticated user must be an enterprise admin. */ - readonly get: operations["billing/get-github-actions-billing-ghe"]; - }; - readonly "/enterprises/{enterprise}/settings/billing/advanced-security": { + readonly get: operations['billing/get-github-actions-billing-ghe'] + } + readonly '/enterprises/{enterprise}/settings/billing/advanced-security': { /** * Gets the GitHub Advanced Security active committers for an enterprise per repository. * Each distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of active_users for each repository. */ - readonly get: operations["billing/get-github-advanced-security-billing-ghe"]; - }; - readonly "/enterprises/{enterprise}/settings/billing/packages": { + readonly get: operations['billing/get-github-advanced-security-billing-ghe'] + } + readonly '/enterprises/{enterprise}/settings/billing/packages': { /** * Gets the free and paid storage used for GitHub Packages in gigabytes. * @@ -501,9 +501,9 @@ export interface paths { * * The authenticated user must be an enterprise admin. */ - readonly get: operations["billing/get-github-packages-billing-ghe"]; - }; - readonly "/enterprises/{enterprise}/settings/billing/shared-storage": { + readonly get: operations['billing/get-github-packages-billing-ghe'] + } + readonly '/enterprises/{enterprise}/settings/billing/shared-storage': { /** * Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. * @@ -511,13 +511,13 @@ export interface paths { * * The authenticated user must be an enterprise admin. */ - readonly get: operations["billing/get-shared-storage-billing-ghe"]; - }; - readonly "/events": { + readonly get: operations['billing/get-shared-storage-billing-ghe'] + } + readonly '/events': { /** We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. */ - readonly get: operations["activity/list-public-events"]; - }; - readonly "/feeds": { + readonly get: operations['activity/list-public-events'] + } + readonly '/feeds': { /** * GitHub provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user: * @@ -531,82 +531,82 @@ export interface paths { * * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ - readonly get: operations["activity/get-feeds"]; - }; - readonly "/gists": { + readonly get: operations['activity/get-feeds'] + } + readonly '/gists': { /** Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists: */ - readonly get: operations["gists/list"]; + readonly get: operations['gists/list'] /** * Allows you to add a new gist with one or more files. * * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. */ - readonly post: operations["gists/create"]; - }; - readonly "/gists/public": { + readonly post: operations['gists/create'] + } + readonly '/gists/public': { /** * List public gists sorted by most recently updated to least recently updated. * * Note: With [pagination](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. */ - readonly get: operations["gists/list-public"]; - }; - readonly "/gists/starred": { + readonly get: operations['gists/list-public'] + } + readonly '/gists/starred': { /** List the authenticated user's starred gists: */ - readonly get: operations["gists/list-starred"]; - }; - readonly "/gists/{gist_id}": { - readonly get: operations["gists/get"]; - readonly delete: operations["gists/delete"]; + readonly get: operations['gists/list-starred'] + } + readonly '/gists/{gist_id}': { + readonly get: operations['gists/get'] + readonly delete: operations['gists/delete'] /** Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged. */ - readonly patch: operations["gists/update"]; - }; - readonly "/gists/{gist_id}/comments": { - readonly get: operations["gists/list-comments"]; - readonly post: operations["gists/create-comment"]; - }; - readonly "/gists/{gist_id}/comments/{comment_id}": { - readonly get: operations["gists/get-comment"]; - readonly delete: operations["gists/delete-comment"]; - readonly patch: operations["gists/update-comment"]; - }; - readonly "/gists/{gist_id}/commits": { - readonly get: operations["gists/list-commits"]; - }; - readonly "/gists/{gist_id}/forks": { - readonly get: operations["gists/list-forks"]; + readonly patch: operations['gists/update'] + } + readonly '/gists/{gist_id}/comments': { + readonly get: operations['gists/list-comments'] + readonly post: operations['gists/create-comment'] + } + readonly '/gists/{gist_id}/comments/{comment_id}': { + readonly get: operations['gists/get-comment'] + readonly delete: operations['gists/delete-comment'] + readonly patch: operations['gists/update-comment'] + } + readonly '/gists/{gist_id}/commits': { + readonly get: operations['gists/list-commits'] + } + readonly '/gists/{gist_id}/forks': { + readonly get: operations['gists/list-forks'] /** **Note**: This was previously `/gists/:gist_id/fork`. */ - readonly post: operations["gists/fork"]; - }; - readonly "/gists/{gist_id}/star": { - readonly get: operations["gists/check-is-starred"]; + readonly post: operations['gists/fork'] + } + readonly '/gists/{gist_id}/star': { + readonly get: operations['gists/check-is-starred'] /** Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - readonly put: operations["gists/star"]; - readonly delete: operations["gists/unstar"]; - }; - readonly "/gists/{gist_id}/{sha}": { - readonly get: operations["gists/get-revision"]; - }; - readonly "/gitignore/templates": { + readonly put: operations['gists/star'] + readonly delete: operations['gists/unstar'] + } + readonly '/gists/{gist_id}/{sha}': { + readonly get: operations['gists/get-revision'] + } + readonly '/gitignore/templates': { /** List all templates available to pass as an option when [creating a repository](https://docs.github.com/rest/reference/repos#create-a-repository-for-the-authenticated-user). */ - readonly get: operations["gitignore/get-all-templates"]; - }; - readonly "/gitignore/templates/{name}": { + readonly get: operations['gitignore/get-all-templates'] + } + readonly '/gitignore/templates/{name}': { /** * The API also allows fetching the source of a single template. * Use the raw [media type](https://docs.github.com/rest/overview/media-types/) to get the raw contents. */ - readonly get: operations["gitignore/get-template"]; - }; - readonly "/installation/repositories": { + readonly get: operations['gitignore/get-template'] + } + readonly '/installation/repositories': { /** * List repositories that an app installation can access. * * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ - readonly get: operations["apps/list-repos-accessible-to-installation"]; - }; - readonly "/installation/token": { + readonly get: operations['apps/list-repos-accessible-to-installation'] + } + readonly '/installation/token': { /** * Revokes the installation token you're using to authenticate as an installation and access this endpoint. * @@ -614,9 +614,9 @@ export interface paths { * * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ - readonly delete: operations["apps/revoke-installation-access-token"]; - }; - readonly "/issues": { + readonly delete: operations['apps/revoke-installation-access-token'] + } + readonly '/issues': { /** * List issues assigned to the authenticated user across all visible repositories including owned repositories, member * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not @@ -628,97 +628,97 @@ export interface paths { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - readonly get: operations["issues/list"]; - }; - readonly "/licenses": { - readonly get: operations["licenses/get-all-commonly-used"]; - }; - readonly "/licenses/{license}": { - readonly get: operations["licenses/get"]; - }; - readonly "/markdown": { - readonly post: operations["markdown/render"]; - }; - readonly "/markdown/raw": { + readonly get: operations['issues/list'] + } + readonly '/licenses': { + readonly get: operations['licenses/get-all-commonly-used'] + } + readonly '/licenses/{license}': { + readonly get: operations['licenses/get'] + } + readonly '/markdown': { + readonly post: operations['markdown/render'] + } + readonly '/markdown/raw': { /** You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less. */ - readonly post: operations["markdown/render-raw"]; - }; - readonly "/marketplace_listing/accounts/{account_id}": { + readonly post: operations['markdown/render-raw'] + } + readonly '/marketplace_listing/accounts/{account_id}': { /** * Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - readonly get: operations["apps/get-subscription-plan-for-account"]; - }; - readonly "/marketplace_listing/plans": { + readonly get: operations['apps/get-subscription-plan-for-account'] + } + readonly '/marketplace_listing/plans': { /** * Lists all plans that are part of your GitHub Marketplace listing. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - readonly get: operations["apps/list-plans"]; - }; - readonly "/marketplace_listing/plans/{plan_id}/accounts": { + readonly get: operations['apps/list-plans'] + } + readonly '/marketplace_listing/plans/{plan_id}/accounts': { /** * Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - readonly get: operations["apps/list-accounts-for-plan"]; - }; - readonly "/marketplace_listing/stubbed/accounts/{account_id}": { + readonly get: operations['apps/list-accounts-for-plan'] + } + readonly '/marketplace_listing/stubbed/accounts/{account_id}': { /** * Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - readonly get: operations["apps/get-subscription-plan-for-account-stubbed"]; - }; - readonly "/marketplace_listing/stubbed/plans": { + readonly get: operations['apps/get-subscription-plan-for-account-stubbed'] + } + readonly '/marketplace_listing/stubbed/plans': { /** * Lists all plans that are part of your GitHub Marketplace listing. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - readonly get: operations["apps/list-plans-stubbed"]; - }; - readonly "/marketplace_listing/stubbed/plans/{plan_id}/accounts": { + readonly get: operations['apps/list-plans-stubbed'] + } + readonly '/marketplace_listing/stubbed/plans/{plan_id}/accounts': { /** * Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - readonly get: operations["apps/list-accounts-for-plan-stubbed"]; - }; - readonly "/meta": { + readonly get: operations['apps/list-accounts-for-plan-stubbed'] + } + readonly '/meta': { /** * Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://docs.github.com/articles/about-github-s-ip-addresses/)." * * **Note:** The IP addresses shown in the documentation's response are only example values. You must always query the API directly to get the latest list of IP addresses. */ - readonly get: operations["meta/get"]; - }; - readonly "/networks/{owner}/{repo}/events": { - readonly get: operations["activity/list-public-events-for-repo-network"]; - }; - readonly "/notifications": { + readonly get: operations['meta/get'] + } + readonly '/networks/{owner}/{repo}/events': { + readonly get: operations['activity/list-public-events-for-repo-network'] + } + readonly '/notifications': { /** List all notifications for the current user, sorted by most recently updated. */ - readonly get: operations["activity/list-notifications-for-authenticated-user"]; + readonly get: operations['activity/list-notifications-for-authenticated-user'] /** Marks all notifications as "read" removes it from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ - readonly put: operations["activity/mark-notifications-as-read"]; - }; - readonly "/notifications/threads/{thread_id}": { - readonly get: operations["activity/get-thread"]; - readonly patch: operations["activity/mark-thread-as-read"]; - }; - readonly "/notifications/threads/{thread_id}/subscription": { + readonly put: operations['activity/mark-notifications-as-read'] + } + readonly '/notifications/threads/{thread_id}': { + readonly get: operations['activity/get-thread'] + readonly patch: operations['activity/mark-thread-as-read'] + } + readonly '/notifications/threads/{thread_id}/subscription': { /** * This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/rest/reference/activity#get-a-repository-subscription). * * Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. */ - readonly get: operations["activity/get-thread-subscription-for-authenticated-user"]; + readonly get: operations['activity/get-thread-subscription-for-authenticated-user'] /** * If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**. * @@ -726,60 +726,60 @@ export interface paths { * * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/rest/reference/activity#delete-a-thread-subscription) endpoint. */ - readonly put: operations["activity/set-thread-subscription"]; + readonly put: operations['activity/set-thread-subscription'] /** Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/rest/reference/activity#set-a-thread-subscription) endpoint and set `ignore` to `true`. */ - readonly delete: operations["activity/delete-thread-subscription"]; - }; - readonly "/octocat": { + readonly delete: operations['activity/delete-thread-subscription'] + } + readonly '/octocat': { /** Get the octocat as ASCII art */ - readonly get: operations["meta/get-octocat"]; - }; - readonly "/organizations": { + readonly get: operations['meta/get-octocat'] + } + readonly '/organizations': { /** * Lists all organizations, in the order that they were created on GitHub. * * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of organizations. */ - readonly get: operations["orgs/list"]; - }; - readonly "/organizations/{organization_id}/custom_roles": { + readonly get: operations['orgs/list'] + } + readonly '/organizations/{organization_id}/custom_roles': { /** * List the custom repository roles available in this organization. In order to see custom * repository roles in an organization, the authenticated user must be an organization owner. * * For more information on custom repository roles, see "[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)". */ - readonly get: operations["orgs/list-custom-roles"]; - }; - readonly "/organizations/{org}/team/{team_slug}/external-groups": { + readonly get: operations['orgs/list-custom-roles'] + } + readonly '/organizations/{org}/team/{team_slug}/external-groups': { /** * Lists a connection between a team and an external group. * * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ - readonly get: operations["teams/list-linked-external-idp-groups-to-team-for-org"]; - }; - readonly "/orgs/{org}": { + readonly get: operations['teams/list-linked-external-idp-groups-to-team-for-org'] + } + readonly '/orgs/{org}': { /** * To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). * * GitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub plan. See "[Authenticating with GitHub Apps](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/)" for details. For an example response, see 'Response with GitHub plan information' below." */ - readonly get: operations["orgs/get"]; + readonly get: operations['orgs/get'] /** * **Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). * * Enables an authenticated organization owner with the `admin:org` scope to update the organization's profile and member privileges. */ - readonly patch: operations["orgs/update"]; - }; - readonly "/orgs/{org}/actions/permissions": { + readonly patch: operations['orgs/update'] + } + readonly '/orgs/{org}/actions/permissions': { /** * Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - readonly get: operations["actions/get-github-actions-permissions-organization"]; + readonly get: operations['actions/get-github-actions-permissions-organization'] /** * Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization. * @@ -787,43 +787,43 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - readonly put: operations["actions/set-github-actions-permissions-organization"]; - }; - readonly "/orgs/{org}/actions/permissions/repositories": { + readonly put: operations['actions/set-github-actions-permissions-organization'] + } + readonly '/orgs/{org}/actions/permissions/repositories': { /** * Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - readonly get: operations["actions/list-selected-repositories-enabled-github-actions-organization"]; + readonly get: operations['actions/list-selected-repositories-enabled-github-actions-organization'] /** * Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - readonly put: operations["actions/set-selected-repositories-enabled-github-actions-organization"]; - }; - readonly "/orgs/{org}/actions/permissions/repositories/{repository_id}": { + readonly put: operations['actions/set-selected-repositories-enabled-github-actions-organization'] + } + readonly '/orgs/{org}/actions/permissions/repositories/{repository_id}': { /** * Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - readonly put: operations["actions/enable-selected-repository-github-actions-organization"]; + readonly put: operations['actions/enable-selected-repository-github-actions-organization'] /** * Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - readonly delete: operations["actions/disable-selected-repository-github-actions-organization"]; - }; - readonly "/orgs/{org}/actions/permissions/selected-actions": { + readonly delete: operations['actions/disable-selected-repository-github-actions-organization'] + } + readonly '/orgs/{org}/actions/permissions/selected-actions': { /** * Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."" * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - readonly get: operations["actions/get-allowed-actions-organization"]; + readonly get: operations['actions/get-allowed-actions-organization'] /** * Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * @@ -833,25 +833,25 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - readonly put: operations["actions/set-allowed-actions-organization"]; - }; - readonly "/orgs/{org}/actions/permissions/workflow": { + readonly put: operations['actions/set-allowed-actions-organization'] + } + readonly '/orgs/{org}/actions/permissions/workflow': { /** * Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, * as well if GitHub Actions can submit approving pull request reviews. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - readonly get: operations["actions/get-github-actions-default-workflow-permissions-organization"]; + readonly get: operations['actions/get-github-actions-default-workflow-permissions-organization'] /** * Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions * can submit approving pull request reviews. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - readonly put: operations["actions/set-github-actions-default-workflow-permissions-organization"]; - }; - readonly "/orgs/{org}/actions/runner-groups": { + readonly put: operations['actions/set-github-actions-default-workflow-permissions-organization'] + } + readonly '/orgs/{org}/actions/runner-groups': { /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -859,7 +859,7 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - readonly get: operations["actions/list-self-hosted-runner-groups-for-org"]; + readonly get: operations['actions/list-self-hosted-runner-groups-for-org'] /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -867,9 +867,9 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - readonly post: operations["actions/create-self-hosted-runner-group-for-org"]; - }; - readonly "/orgs/{org}/actions/runner-groups/{runner_group_id}": { + readonly post: operations['actions/create-self-hosted-runner-group-for-org'] + } + readonly '/orgs/{org}/actions/runner-groups/{runner_group_id}': { /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -877,7 +877,7 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - readonly get: operations["actions/get-self-hosted-runner-group-for-org"]; + readonly get: operations['actions/get-self-hosted-runner-group-for-org'] /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -885,7 +885,7 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - readonly delete: operations["actions/delete-self-hosted-runner-group-from-org"]; + readonly delete: operations['actions/delete-self-hosted-runner-group-from-org'] /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -893,9 +893,9 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - readonly patch: operations["actions/update-self-hosted-runner-group-for-org"]; - }; - readonly "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": { + readonly patch: operations['actions/update-self-hosted-runner-group-for-org'] + } + readonly '/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories': { /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -903,7 +903,7 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - readonly get: operations["actions/list-repo-access-to-self-hosted-runner-group-in-org"]; + readonly get: operations['actions/list-repo-access-to-self-hosted-runner-group-in-org'] /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -911,9 +911,9 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - readonly put: operations["actions/set-repo-access-to-self-hosted-runner-group-in-org"]; - }; - readonly "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": { + readonly put: operations['actions/set-repo-access-to-self-hosted-runner-group-in-org'] + } + readonly '/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}': { /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -923,7 +923,7 @@ export interface paths { * You must authenticate using an access token with the `admin:org` * scope to use this endpoint. */ - readonly put: operations["actions/add-repo-access-to-self-hosted-runner-group-in-org"]; + readonly put: operations['actions/add-repo-access-to-self-hosted-runner-group-in-org'] /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -932,9 +932,9 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - readonly delete: operations["actions/remove-repo-access-to-self-hosted-runner-group-in-org"]; - }; - readonly "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners": { + readonly delete: operations['actions/remove-repo-access-to-self-hosted-runner-group-in-org'] + } + readonly '/orgs/{org}/actions/runner-groups/{runner_group_id}/runners': { /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -942,7 +942,7 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - readonly get: operations["actions/list-self-hosted-runners-in-group-for-org"]; + readonly get: operations['actions/list-self-hosted-runners-in-group-for-org'] /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -950,9 +950,9 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - readonly put: operations["actions/set-self-hosted-runners-in-group-for-org"]; - }; - readonly "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + readonly put: operations['actions/set-self-hosted-runners-in-group-for-org'] + } + readonly '/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}': { /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -962,7 +962,7 @@ export interface paths { * You must authenticate using an access token with the `admin:org` * scope to use this endpoint. */ - readonly put: operations["actions/add-self-hosted-runner-to-group-for-org"]; + readonly put: operations['actions/add-self-hosted-runner-to-group-for-org'] /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -971,25 +971,25 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - readonly delete: operations["actions/remove-self-hosted-runner-from-group-for-org"]; - }; - readonly "/orgs/{org}/actions/runners": { + readonly delete: operations['actions/remove-self-hosted-runner-from-group-for-org'] + } + readonly '/orgs/{org}/actions/runners': { /** * Lists all self-hosted runners configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - readonly get: operations["actions/list-self-hosted-runners-for-org"]; - }; - readonly "/orgs/{org}/actions/runners/downloads": { + readonly get: operations['actions/list-self-hosted-runners-for-org'] + } + readonly '/orgs/{org}/actions/runners/downloads': { /** * Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - readonly get: operations["actions/list-runner-applications-for-org"]; - }; - readonly "/orgs/{org}/actions/runners/registration-token": { + readonly get: operations['actions/list-runner-applications-for-org'] + } + readonly '/orgs/{org}/actions/runners/registration-token': { /** * Returns a token that you can pass to the `config` script. The token expires after one hour. * @@ -1003,9 +1003,9 @@ export interface paths { * ./config.sh --url https://github.com/octo-org --token TOKEN * ``` */ - readonly post: operations["actions/create-registration-token-for-org"]; - }; - readonly "/orgs/{org}/actions/runners/remove-token": { + readonly post: operations['actions/create-registration-token-for-org'] + } + readonly '/orgs/{org}/actions/runners/remove-token': { /** * Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour. * @@ -1020,51 +1020,51 @@ export interface paths { * ./config.sh remove --token TOKEN * ``` */ - readonly post: operations["actions/create-remove-token-for-org"]; - }; - readonly "/orgs/{org}/actions/runners/{runner_id}": { + readonly post: operations['actions/create-remove-token-for-org'] + } + readonly '/orgs/{org}/actions/runners/{runner_id}': { /** * Gets a specific self-hosted runner configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - readonly get: operations["actions/get-self-hosted-runner-for-org"]; + readonly get: operations['actions/get-self-hosted-runner-for-org'] /** * Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - readonly delete: operations["actions/delete-self-hosted-runner-from-org"]; - }; - readonly "/orgs/{org}/actions/runners/{runner_id}/labels": { + readonly delete: operations['actions/delete-self-hosted-runner-from-org'] + } + readonly '/orgs/{org}/actions/runners/{runner_id}/labels': { /** * Lists all labels for a self-hosted runner configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - readonly get: operations["actions/list-labels-for-self-hosted-runner-for-org"]; + readonly get: operations['actions/list-labels-for-self-hosted-runner-for-org'] /** * Remove all previous custom labels and set the new custom labels for a specific * self-hosted runner configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - readonly put: operations["actions/set-custom-labels-for-self-hosted-runner-for-org"]; + readonly put: operations['actions/set-custom-labels-for-self-hosted-runner-for-org'] /** * Add custom labels to a self-hosted runner configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - readonly post: operations["actions/add-custom-labels-to-self-hosted-runner-for-org"]; + readonly post: operations['actions/add-custom-labels-to-self-hosted-runner-for-org'] /** * Remove all custom labels from a self-hosted runner configured in an * organization. Returns the remaining read-only labels from the runner. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - readonly delete: operations["actions/remove-all-custom-labels-from-self-hosted-runner-for-org"]; - }; - readonly "/orgs/{org}/actions/runners/{runner_id}/labels/{name}": { + readonly delete: operations['actions/remove-all-custom-labels-from-self-hosted-runner-for-org'] + } + readonly '/orgs/{org}/actions/runners/{runner_id}/labels/{name}': { /** * Remove a custom label from a self-hosted runner configured * in an organization. Returns the remaining labels from the runner. @@ -1074,19 +1074,19 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - readonly delete: operations["actions/remove-custom-label-from-self-hosted-runner-for-org"]; - }; - readonly "/orgs/{org}/actions/secrets": { + readonly delete: operations['actions/remove-custom-label-from-self-hosted-runner-for-org'] + } + readonly '/orgs/{org}/actions/secrets': { /** Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - readonly get: operations["actions/list-org-secrets"]; - }; - readonly "/orgs/{org}/actions/secrets/public-key": { + readonly get: operations['actions/list-org-secrets'] + } + readonly '/orgs/{org}/actions/secrets/public-key': { /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - readonly get: operations["actions/get-org-public-key"]; - }; - readonly "/orgs/{org}/actions/secrets/{secret_name}": { + readonly get: operations['actions/get-org-public-key'] + } + readonly '/orgs/{org}/actions/secrets/{secret_name}': { /** Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - readonly get: operations["actions/get-org-secret"]; + readonly get: operations['actions/get-org-secret'] /** * Creates or updates an organization secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -1164,40 +1164,40 @@ export interface paths { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - readonly put: operations["actions/create-or-update-org-secret"]; + readonly put: operations['actions/create-or-update-org-secret'] /** Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - readonly delete: operations["actions/delete-org-secret"]; - }; - readonly "/orgs/{org}/actions/secrets/{secret_name}/repositories": { + readonly delete: operations['actions/delete-org-secret'] + } + readonly '/orgs/{org}/actions/secrets/{secret_name}/repositories': { /** Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - readonly get: operations["actions/list-selected-repos-for-org-secret"]; + readonly get: operations['actions/list-selected-repos-for-org-secret'] /** Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - readonly put: operations["actions/set-selected-repos-for-org-secret"]; - }; - readonly "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}": { + readonly put: operations['actions/set-selected-repos-for-org-secret'] + } + readonly '/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}': { /** Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - readonly put: operations["actions/add-selected-repo-to-org-secret"]; + readonly put: operations['actions/add-selected-repo-to-org-secret'] /** Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - readonly delete: operations["actions/remove-selected-repo-from-org-secret"]; - }; - readonly "/orgs/{org}/audit-log": { + readonly delete: operations['actions/remove-selected-repo-from-org-secret'] + } + readonly '/orgs/{org}/audit-log': { /** * Gets the audit log for an organization. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization)." * * This endpoint is available for organizations on GitHub Enterprise Cloud. To use this endpoint, you must be an organization owner, and you must use an access token with the `admin:org` scope. GitHub Apps must have the `organization_administration` read permission to use this endpoint. */ - readonly get: operations["orgs/get-audit-log"]; - }; - readonly "/orgs/{org}/blocks": { + readonly get: operations['orgs/get-audit-log'] + } + readonly '/orgs/{org}/blocks': { /** List the users blocked by an organization. */ - readonly get: operations["orgs/list-blocked-users"]; - }; - readonly "/orgs/{org}/blocks/{username}": { - readonly get: operations["orgs/check-blocked-user"]; - readonly put: operations["orgs/block-user"]; - readonly delete: operations["orgs/unblock-user"]; - }; - readonly "/orgs/{org}/code-scanning/alerts": { + readonly get: operations['orgs/list-blocked-users'] + } + readonly '/orgs/{org}/blocks/{username}': { + readonly get: operations['orgs/check-blocked-user'] + readonly put: operations['orgs/block-user'] + readonly delete: operations['orgs/unblock-user'] + } + readonly '/orgs/{org}/code-scanning/alerts': { /** * Lists all code scanning alerts for the default branch (usually `main` * or `master`) for all eligible repositories in an organization. @@ -1205,35 +1205,35 @@ export interface paths { * * GitHub Apps must have the `security_events` read permission to use this endpoint. */ - readonly get: operations["code-scanning/list-alerts-for-org"]; - }; - readonly "/orgs/{org}/credential-authorizations": { + readonly get: operations['code-scanning/list-alerts-for-org'] + } + readonly '/orgs/{org}/credential-authorizations': { /** * Listing and deleting credential authorizations is available to organizations with GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products). * * An authenticated organization owner with the `read:org` scope can list all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials are either personal access tokens or SSH keys that organization members have authorized for the organization. For more information, see [About authentication with SAML single sign-on](https://docs.github.com/en/articles/about-authentication-with-saml-single-sign-on). */ - readonly get: operations["orgs/list-saml-sso-authorizations"]; - }; - readonly "/orgs/{org}/credential-authorizations/{credential_id}": { + readonly get: operations['orgs/list-saml-sso-authorizations'] + } + readonly '/orgs/{org}/credential-authorizations/{credential_id}': { /** * Listing and deleting credential authorizations is available to organizations with GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products). * * An authenticated organization owner with the `admin:org` scope can remove a credential authorization for an organization that uses SAML SSO. Once you remove someone's credential authorization, they will need to create a new personal access token or SSH key and authorize it for the organization they want to access. */ - readonly delete: operations["orgs/remove-saml-sso-authorization"]; - }; - readonly "/orgs/{org}/dependabot/secrets": { + readonly delete: operations['orgs/remove-saml-sso-authorization'] + } + readonly '/orgs/{org}/dependabot/secrets': { /** Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - readonly get: operations["dependabot/list-org-secrets"]; - }; - readonly "/orgs/{org}/dependabot/secrets/public-key": { + readonly get: operations['dependabot/list-org-secrets'] + } + readonly '/orgs/{org}/dependabot/secrets/public-key': { /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - readonly get: operations["dependabot/get-org-public-key"]; - }; - readonly "/orgs/{org}/dependabot/secrets/{secret_name}": { + readonly get: operations['dependabot/get-org-public-key'] + } + readonly '/orgs/{org}/dependabot/secrets/{secret_name}': { /** Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - readonly get: operations["dependabot/get-org-secret"]; + readonly get: operations['dependabot/get-org-secret'] /** * Creates or updates an organization secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -1311,130 +1311,130 @@ export interface paths { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - readonly put: operations["dependabot/create-or-update-org-secret"]; + readonly put: operations['dependabot/create-or-update-org-secret'] /** Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - readonly delete: operations["dependabot/delete-org-secret"]; - }; - readonly "/orgs/{org}/dependabot/secrets/{secret_name}/repositories": { + readonly delete: operations['dependabot/delete-org-secret'] + } + readonly '/orgs/{org}/dependabot/secrets/{secret_name}/repositories': { /** Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - readonly get: operations["dependabot/list-selected-repos-for-org-secret"]; + readonly get: operations['dependabot/list-selected-repos-for-org-secret'] /** Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - readonly put: operations["dependabot/set-selected-repos-for-org-secret"]; - }; - readonly "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}": { + readonly put: operations['dependabot/set-selected-repos-for-org-secret'] + } + readonly '/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}': { /** Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - readonly put: operations["dependabot/add-selected-repo-to-org-secret"]; + readonly put: operations['dependabot/add-selected-repo-to-org-secret'] /** Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - readonly delete: operations["dependabot/remove-selected-repo-from-org-secret"]; - }; - readonly "/orgs/{org}/events": { - readonly get: operations["activity/list-public-org-events"]; - }; - readonly "/orgs/{org}/external-group/{group_id}": { + readonly delete: operations['dependabot/remove-selected-repo-from-org-secret'] + } + readonly '/orgs/{org}/events': { + readonly get: operations['activity/list-public-org-events'] + } + readonly '/orgs/{org}/external-group/{group_id}': { /** * Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to. * * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ - readonly get: operations["teams/external-idp-group-info-for-org"]; - }; - readonly "/orgs/{org}/external-groups": { + readonly get: operations['teams/external-idp-group-info-for-org'] + } + readonly '/orgs/{org}/external-groups': { /** * Lists external groups available in an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." * * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ - readonly get: operations["teams/list-external-idp-groups-for-org"]; - }; - readonly "/orgs/{org}/failed_invitations": { + readonly get: operations['teams/list-external-idp-groups-for-org'] + } + readonly '/orgs/{org}/failed_invitations': { /** The return hash contains `failed_at` and `failed_reason` fields which represent the time at which the invitation failed and the reason for the failure. */ - readonly get: operations["orgs/list-failed-invitations"]; - }; - readonly "/orgs/{org}/hooks": { - readonly get: operations["orgs/list-webhooks"]; + readonly get: operations['orgs/list-failed-invitations'] + } + readonly '/orgs/{org}/hooks': { + readonly get: operations['orgs/list-webhooks'] /** Here's how you can create a hook that posts payloads in JSON format: */ - readonly post: operations["orgs/create-webhook"]; - }; - readonly "/orgs/{org}/hooks/{hook_id}": { + readonly post: operations['orgs/create-webhook'] + } + readonly '/orgs/{org}/hooks/{hook_id}': { /** Returns a webhook configured in an organization. To get only the webhook `config` properties, see "[Get a webhook configuration for an organization](/rest/reference/orgs#get-a-webhook-configuration-for-an-organization)." */ - readonly get: operations["orgs/get-webhook"]; - readonly delete: operations["orgs/delete-webhook"]; + readonly get: operations['orgs/get-webhook'] + readonly delete: operations['orgs/delete-webhook'] /** Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for an organization](/rest/reference/orgs#update-a-webhook-configuration-for-an-organization)." */ - readonly patch: operations["orgs/update-webhook"]; - }; - readonly "/orgs/{org}/hooks/{hook_id}/config": { + readonly patch: operations['orgs/update-webhook'] + } + readonly '/orgs/{org}/hooks/{hook_id}/config': { /** * Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/reference/orgs#get-an-organization-webhook)." * * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission. */ - readonly get: operations["orgs/get-webhook-config-for-org"]; + readonly get: operations['orgs/get-webhook-config-for-org'] /** * Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/reference/orgs#update-an-organization-webhook)." * * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission. */ - readonly patch: operations["orgs/update-webhook-config-for-org"]; - }; - readonly "/orgs/{org}/hooks/{hook_id}/deliveries": { + readonly patch: operations['orgs/update-webhook-config-for-org'] + } + readonly '/orgs/{org}/hooks/{hook_id}/deliveries': { /** Returns a list of webhook deliveries for a webhook configured in an organization. */ - readonly get: operations["orgs/list-webhook-deliveries"]; - }; - readonly "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": { + readonly get: operations['orgs/list-webhook-deliveries'] + } + readonly '/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}': { /** Returns a delivery for a webhook configured in an organization. */ - readonly get: operations["orgs/get-webhook-delivery"]; - }; - readonly "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { + readonly get: operations['orgs/get-webhook-delivery'] + } + readonly '/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts': { /** Redeliver a delivery for a webhook configured in an organization. */ - readonly post: operations["orgs/redeliver-webhook-delivery"]; - }; - readonly "/orgs/{org}/hooks/{hook_id}/pings": { + readonly post: operations['orgs/redeliver-webhook-delivery'] + } + readonly '/orgs/{org}/hooks/{hook_id}/pings': { /** This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. */ - readonly post: operations["orgs/ping-webhook"]; - }; - readonly "/orgs/{org}/installation": { + readonly post: operations['orgs/ping-webhook'] + } + readonly '/orgs/{org}/installation': { /** * Enables an authenticated GitHub App to find the organization's installation information. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly get: operations["apps/get-org-installation"]; - }; - readonly "/orgs/{org}/installations": { + readonly get: operations['apps/get-org-installation'] + } + readonly '/orgs/{org}/installations': { /** Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint. */ - readonly get: operations["orgs/list-app-installations"]; - }; - readonly "/orgs/{org}/interaction-limits": { + readonly get: operations['orgs/list-app-installations'] + } + readonly '/orgs/{org}/interaction-limits': { /** Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response. */ - readonly get: operations["interactions/get-restrictions-for-org"]; + readonly get: operations['interactions/get-restrictions-for-org'] /** Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization. */ - readonly put: operations["interactions/set-restrictions-for-org"]; + readonly put: operations['interactions/set-restrictions-for-org'] /** Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions. */ - readonly delete: operations["interactions/remove-restrictions-for-org"]; - }; - readonly "/orgs/{org}/invitations": { + readonly delete: operations['interactions/remove-restrictions-for-org'] + } + readonly '/orgs/{org}/invitations': { /** The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. */ - readonly get: operations["orgs/list-pending-invitations"]; + readonly get: operations['orgs/list-pending-invitations'] /** * Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - readonly post: operations["orgs/create-invitation"]; - }; - readonly "/orgs/{org}/invitations/{invitation_id}": { + readonly post: operations['orgs/create-invitation'] + } + readonly '/orgs/{org}/invitations/{invitation_id}': { /** * Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). */ - readonly delete: operations["orgs/cancel-invitation"]; - }; - readonly "/orgs/{org}/invitations/{invitation_id}/teams": { + readonly delete: operations['orgs/cancel-invitation'] + } + readonly '/orgs/{org}/invitations/{invitation_id}/teams': { /** List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner. */ - readonly get: operations["orgs/list-invitation-teams"]; - }; - readonly "/orgs/{org}/issues": { + readonly get: operations['orgs/list-invitation-teams'] + } + readonly '/orgs/{org}/issues': { /** * List issues in an organization assigned to the authenticated user. * @@ -1443,21 +1443,21 @@ export interface paths { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - readonly get: operations["issues/list-for-org"]; - }; - readonly "/orgs/{org}/members": { + readonly get: operations['issues/list-for-org'] + } + readonly '/orgs/{org}/members': { /** List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned. */ - readonly get: operations["orgs/list-members"]; - }; - readonly "/orgs/{org}/members/{username}": { + readonly get: operations['orgs/list-members'] + } + readonly '/orgs/{org}/members/{username}': { /** Check if a user is, publicly or privately, a member of the organization. */ - readonly get: operations["orgs/check-membership-for-user"]; + readonly get: operations['orgs/check-membership-for-user'] /** Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories. */ - readonly delete: operations["orgs/remove-member"]; - }; - readonly "/orgs/{org}/memberships/{username}": { + readonly delete: operations['orgs/remove-member'] + } + readonly '/orgs/{org}/memberships/{username}': { /** In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status. */ - readonly get: operations["orgs/get-membership-for-user"]; + readonly get: operations['orgs/get-membership-for-user'] /** * Only authenticated organization owners can add a member to the organization or update the member's role. * @@ -1469,21 +1469,21 @@ export interface paths { * * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. */ - readonly put: operations["orgs/set-membership-for-user"]; + readonly put: operations['orgs/set-membership-for-user'] /** * In order to remove a user's membership with an organization, the authenticated user must be an organization owner. * * If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases. */ - readonly delete: operations["orgs/remove-membership-for-user"]; - }; - readonly "/orgs/{org}/migrations": { + readonly delete: operations['orgs/remove-membership-for-user'] + } + readonly '/orgs/{org}/migrations': { /** Lists the most recent migrations. */ - readonly get: operations["migrations/list-for-org"]; + readonly get: operations['migrations/list-for-org'] /** Initiates the generation of a migration archive. */ - readonly post: operations["migrations/start-for-org"]; - }; - readonly "/orgs/{org}/migrations/{migration_id}": { + readonly post: operations['migrations/start-for-org'] + } + readonly '/orgs/{org}/migrations/{migration_id}': { /** * Fetches the status of a migration. * @@ -1494,49 +1494,49 @@ export interface paths { * * `exported`, which means the migration finished successfully. * * `failed`, which means the migration failed. */ - readonly get: operations["migrations/get-status-for-org"]; - }; - readonly "/orgs/{org}/migrations/{migration_id}/archive": { + readonly get: operations['migrations/get-status-for-org'] + } + readonly '/orgs/{org}/migrations/{migration_id}/archive': { /** Fetches the URL to a migration archive. */ - readonly get: operations["migrations/download-archive-for-org"]; + readonly get: operations['migrations/download-archive-for-org'] /** Deletes a previous migration archive. Migration archives are automatically deleted after seven days. */ - readonly delete: operations["migrations/delete-archive-for-org"]; - }; - readonly "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock": { + readonly delete: operations['migrations/delete-archive-for-org'] + } + readonly '/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock': { /** Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/rest/reference/repos#delete-a-repository) when the migration is complete and you no longer need the source data. */ - readonly delete: operations["migrations/unlock-repo-for-org"]; - }; - readonly "/orgs/{org}/migrations/{migration_id}/repositories": { + readonly delete: operations['migrations/unlock-repo-for-org'] + } + readonly '/orgs/{org}/migrations/{migration_id}/repositories': { /** List all the repositories for this organization migration. */ - readonly get: operations["migrations/list-repos-for-org"]; - }; - readonly "/orgs/{org}/outside_collaborators": { + readonly get: operations['migrations/list-repos-for-org'] + } + readonly '/orgs/{org}/outside_collaborators': { /** List all users who are outside collaborators of an organization. */ - readonly get: operations["orgs/list-outside-collaborators"]; - }; - readonly "/orgs/{org}/outside_collaborators/{username}": { + readonly get: operations['orgs/list-outside-collaborators'] + } + readonly '/orgs/{org}/outside_collaborators/{username}': { /** When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://docs.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)". */ - readonly put: operations["orgs/convert-member-to-outside-collaborator"]; + readonly put: operations['orgs/convert-member-to-outside-collaborator'] /** Removing a user from this list will remove them from all the organization's repositories. */ - readonly delete: operations["orgs/remove-outside-collaborator"]; - }; - readonly "/orgs/{org}/packages": { + readonly delete: operations['orgs/remove-outside-collaborator'] + } + readonly '/orgs/{org}/packages': { /** * Lists all packages in an organization readable by the user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - readonly get: operations["packages/list-packages-for-organization"]; - }; - readonly "/orgs/{org}/packages/{package_type}/{package_name}": { + readonly get: operations['packages/list-packages-for-organization'] + } + readonly '/orgs/{org}/packages/{package_type}/{package_name}': { /** * Gets a specific package in an organization. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - readonly get: operations["packages/get-package-for-organization"]; + readonly get: operations['packages/get-package-for-organization'] /** * Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * @@ -1544,9 +1544,9 @@ export interface paths { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. */ - readonly delete: operations["packages/delete-package-for-org"]; - }; - readonly "/orgs/{org}/packages/{package_type}/{package_name}/restore": { + readonly delete: operations['packages/delete-package-for-org'] + } + readonly '/orgs/{org}/packages/{package_type}/{package_name}/restore': { /** * Restores an entire package in an organization. * @@ -1558,25 +1558,25 @@ export interface paths { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. */ - readonly post: operations["packages/restore-package-for-org"]; - }; - readonly "/orgs/{org}/packages/{package_type}/{package_name}/versions": { + readonly post: operations['packages/restore-package-for-org'] + } + readonly '/orgs/{org}/packages/{package_type}/{package_name}/versions': { /** * Returns all package versions for a package owned by an organization. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - readonly get: operations["packages/get-all-package-versions-for-package-owned-by-org"]; - }; - readonly "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}": { + readonly get: operations['packages/get-all-package-versions-for-package-owned-by-org'] + } + readonly '/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}': { /** * Gets a specific package version in an organization. * * You must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - readonly get: operations["packages/get-package-version-for-organization"]; + readonly get: operations['packages/get-package-version-for-organization'] /** * Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * @@ -1584,9 +1584,9 @@ export interface paths { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. */ - readonly delete: operations["packages/delete-package-version-for-org"]; - }; - readonly "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { + readonly delete: operations['packages/delete-package-version-for-org'] + } + readonly '/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore': { /** * Restores a specific package version in an organization. * @@ -1598,31 +1598,31 @@ export interface paths { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. */ - readonly post: operations["packages/restore-package-version-for-org"]; - }; - readonly "/orgs/{org}/projects": { + readonly post: operations['packages/restore-package-version-for-org'] + } + readonly '/orgs/{org}/projects': { /** Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - readonly get: operations["projects/list-for-org"]; + readonly get: operations['projects/list-for-org'] /** Creates an organization project board. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - readonly post: operations["projects/create-for-org"]; - }; - readonly "/orgs/{org}/public_members": { + readonly post: operations['projects/create-for-org'] + } + readonly '/orgs/{org}/public_members': { /** Members of an organization can choose to have their membership publicized or not. */ - readonly get: operations["orgs/list-public-members"]; - }; - readonly "/orgs/{org}/public_members/{username}": { - readonly get: operations["orgs/check-public-membership-for-user"]; + readonly get: operations['orgs/list-public-members'] + } + readonly '/orgs/{org}/public_members/{username}': { + readonly get: operations['orgs/check-public-membership-for-user'] /** * The user can publicize their own membership. (A user cannot publicize the membership for another user.) * * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - readonly put: operations["orgs/set-public-membership-for-authenticated-user"]; - readonly delete: operations["orgs/remove-public-membership-for-authenticated-user"]; - }; - readonly "/orgs/{org}/repos": { + readonly put: operations['orgs/set-public-membership-for-authenticated-user'] + readonly delete: operations['orgs/remove-public-membership-for-authenticated-user'] + } + readonly '/orgs/{org}/repos': { /** Lists repositories for the specified organization. */ - readonly get: operations["repos/list-for-org"]; + readonly get: operations['repos/list-for-org'] /** * Creates a new repository in the specified organization. The authenticated user must be a member of the organization. * @@ -1633,18 +1633,18 @@ export interface paths { * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. * * `repo` scope to create a private repository */ - readonly post: operations["repos/create-in-org"]; - }; - readonly "/orgs/{org}/secret-scanning/alerts": { + readonly post: operations['repos/create-in-org'] + } + readonly '/orgs/{org}/secret-scanning/alerts': { /** * Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest. * To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. */ - readonly get: operations["secret-scanning/list-alerts-for-org"]; - }; - readonly "/orgs/{org}/settings/billing/actions": { + readonly get: operations['secret-scanning/list-alerts-for-org'] + } + readonly '/orgs/{org}/settings/billing/actions': { /** * Gets the summary of the free and paid GitHub Actions minutes used. * @@ -1652,17 +1652,17 @@ export interface paths { * * Access tokens must have the `repo` or `admin:org` scope. */ - readonly get: operations["billing/get-github-actions-billing-org"]; - }; - readonly "/orgs/{org}/settings/billing/advanced-security": { + readonly get: operations['billing/get-github-actions-billing-org'] + } + readonly '/orgs/{org}/settings/billing/advanced-security': { /** * Gets the GitHub Advanced Security active committers for an organization per repository. * Each distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of advanced_security_committers for each repository. * If this organization defers to an enterprise for billing, the total_advanced_security_committers returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level. */ - readonly get: operations["billing/get-github-advanced-security-billing-org"]; - }; - readonly "/orgs/{org}/settings/billing/packages": { + readonly get: operations['billing/get-github-advanced-security-billing-org'] + } + readonly '/orgs/{org}/settings/billing/packages': { /** * Gets the free and paid storage used for GitHub Packages in gigabytes. * @@ -1670,9 +1670,9 @@ export interface paths { * * Access tokens must have the `repo` or `admin:org` scope. */ - readonly get: operations["billing/get-github-packages-billing-org"]; - }; - readonly "/orgs/{org}/settings/billing/shared-storage": { + readonly get: operations['billing/get-github-packages-billing-org'] + } + readonly '/orgs/{org}/settings/billing/shared-storage': { /** * Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. * @@ -1680,33 +1680,33 @@ export interface paths { * * Access tokens must have the `repo` or `admin:org` scope. */ - readonly get: operations["billing/get-shared-storage-billing-org"]; - }; - readonly "/orgs/{org}/team-sync/groups": { + readonly get: operations['billing/get-shared-storage-billing-org'] + } + readonly '/orgs/{org}/team-sync/groups': { /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * List IdP groups available in an organization. You can limit your page results using the `per_page` parameter. GitHub generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." */ - readonly get: operations["teams/list-idp-groups-for-org"]; - }; - readonly "/orgs/{org}/teams": { + readonly get: operations['teams/list-idp-groups-for-org'] + } + readonly '/orgs/{org}/teams': { /** Lists all teams in an organization that are visible to the authenticated user. */ - readonly get: operations["teams/list"]; + readonly get: operations['teams/list'] /** * To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://docs.github.com/en/articles/setting-team-creation-permissions-in-your-organization)." * * When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)". */ - readonly post: operations["teams/create"]; - }; - readonly "/orgs/{org}/teams/{team_slug}": { + readonly post: operations['teams/create'] + } + readonly '/orgs/{org}/teams/{team_slug}': { /** * Gets a team using the team's `slug`. GitHub generates the `slug` from the team `name`. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. */ - readonly get: operations["teams/get-by-name"]; + readonly get: operations['teams/get-by-name'] /** * To delete a team, the authenticated user must be an organization owner or team maintainer. * @@ -1714,21 +1714,21 @@ export interface paths { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. */ - readonly delete: operations["teams/delete-in-org"]; + readonly delete: operations['teams/delete-in-org'] /** * To edit a team, the authenticated user must either be an organization owner or a team maintainer. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. */ - readonly patch: operations["teams/update-in-org"]; - }; - readonly "/orgs/{org}/teams/{team_slug}/discussions": { + readonly patch: operations['teams/update-in-org'] + } + readonly '/orgs/{org}/teams/{team_slug}/discussions': { /** * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. */ - readonly get: operations["teams/list-discussions-in-org"]; + readonly get: operations['teams/list-discussions-in-org'] /** * Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @@ -1736,35 +1736,35 @@ export interface paths { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. */ - readonly post: operations["teams/create-discussion-in-org"]; - }; - readonly "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": { + readonly post: operations['teams/create-discussion-in-org'] + } + readonly '/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}': { /** * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. */ - readonly get: operations["teams/get-discussion-in-org"]; + readonly get: operations['teams/get-discussion-in-org'] /** * Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. */ - readonly delete: operations["teams/delete-discussion-in-org"]; + readonly delete: operations['teams/delete-discussion-in-org'] /** * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. */ - readonly patch: operations["teams/update-discussion-in-org"]; - }; - readonly "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": { + readonly patch: operations['teams/update-discussion-in-org'] + } + readonly '/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments': { /** * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. */ - readonly get: operations["teams/list-discussion-comments-in-org"]; + readonly get: operations['teams/list-discussion-comments-in-org'] /** * Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @@ -1772,103 +1772,103 @@ export interface paths { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. */ - readonly post: operations["teams/create-discussion-comment-in-org"]; - }; - readonly "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": { + readonly post: operations['teams/create-discussion-comment-in-org'] + } + readonly '/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}': { /** * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. */ - readonly get: operations["teams/get-discussion-comment-in-org"]; + readonly get: operations['teams/get-discussion-comment-in-org'] /** * Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. */ - readonly delete: operations["teams/delete-discussion-comment-in-org"]; + readonly delete: operations['teams/delete-discussion-comment-in-org'] /** * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. */ - readonly patch: operations["teams/update-discussion-comment-in-org"]; - }; - readonly "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { + readonly patch: operations['teams/update-discussion-comment-in-org'] + } + readonly '/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions': { /** * List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments/). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. */ - readonly get: operations["reactions/list-for-team-discussion-comment-in-org"]; + readonly get: operations['reactions/list-for-team-discussion-comment-in-org'] /** * Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. */ - readonly post: operations["reactions/create-for-team-discussion-comment-in-org"]; - }; - readonly "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { + readonly post: operations['reactions/create-for-team-discussion-comment-in-org'] + } + readonly '/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}': { /** * **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. * * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - readonly delete: operations["reactions/delete-for-team-discussion-comment"]; - }; - readonly "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { + readonly delete: operations['reactions/delete-for-team-discussion-comment'] + } + readonly '/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions': { /** * List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. */ - readonly get: operations["reactions/list-for-team-discussion-in-org"]; + readonly get: operations['reactions/list-for-team-discussion-in-org'] /** * Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. */ - readonly post: operations["reactions/create-for-team-discussion-in-org"]; - }; - readonly "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { + readonly post: operations['reactions/create-for-team-discussion-in-org'] + } + readonly '/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}': { /** * **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. * * Delete a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - readonly delete: operations["reactions/delete-for-team-discussion"]; - }; - readonly "/orgs/{org}/teams/{team_slug}/external-groups": { + readonly delete: operations['reactions/delete-for-team-discussion'] + } + readonly '/orgs/{org}/teams/{team_slug}/external-groups': { /** * Deletes a connection between a team and an external group. * * You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly delete: operations["teams/unlink-external-idp-group-from-team-for-org"]; + readonly delete: operations['teams/unlink-external-idp-group-from-team-for-org'] /** * Creates a connection between a team and an external group. Only one external group can be linked to a team. * * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ - readonly patch: operations["teams/link-external-idp-group-to-team-for-org"]; - }; - readonly "/orgs/{org}/teams/{team_slug}/invitations": { + readonly patch: operations['teams/link-external-idp-group-to-team-for-org'] + } + readonly '/orgs/{org}/teams/{team_slug}/invitations': { /** * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. */ - readonly get: operations["teams/list-pending-invitations-in-org"]; - }; - readonly "/orgs/{org}/teams/{team_slug}/members": { + readonly get: operations['teams/list-pending-invitations-in-org'] + } + readonly '/orgs/{org}/teams/{team_slug}/members': { /** * Team members will include the members of child teams. * * To list members in a team, the team must be visible to the authenticated user. */ - readonly get: operations["teams/list-members-in-org"]; - }; - readonly "/orgs/{org}/teams/{team_slug}/memberships/{username}": { + readonly get: operations['teams/list-members-in-org'] + } + readonly '/orgs/{org}/teams/{team_slug}/memberships/{username}': { /** * Team members will include the members of child teams. * @@ -1881,7 +1881,7 @@ export interface paths { * * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team). */ - readonly get: operations["teams/get-membership-for-user-in-org"]; + readonly get: operations['teams/get-membership-for-user-in-org'] /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -1895,7 +1895,7 @@ export interface paths { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ - readonly put: operations["teams/add-or-update-membership-for-user-in-org"]; + readonly put: operations['teams/add-or-update-membership-for-user-in-org'] /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -1905,45 +1905,45 @@ export interface paths { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ - readonly delete: operations["teams/remove-membership-for-user-in-org"]; - }; - readonly "/orgs/{org}/teams/{team_slug}/projects": { + readonly delete: operations['teams/remove-membership-for-user-in-org'] + } + readonly '/orgs/{org}/teams/{team_slug}/projects': { /** * Lists the organization projects for a team. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. */ - readonly get: operations["teams/list-projects-in-org"]; - }; - readonly "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { + readonly get: operations['teams/list-projects-in-org'] + } + readonly '/orgs/{org}/teams/{team_slug}/projects/{project_id}': { /** * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ - readonly get: operations["teams/check-permissions-for-project-in-org"]; + readonly get: operations['teams/check-permissions-for-project-in-org'] /** * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ - readonly put: operations["teams/add-or-update-project-permissions-in-org"]; + readonly put: operations['teams/add-or-update-project-permissions-in-org'] /** * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ - readonly delete: operations["teams/remove-project-in-org"]; - }; - readonly "/orgs/{org}/teams/{team_slug}/repos": { + readonly delete: operations['teams/remove-project-in-org'] + } + readonly '/orgs/{org}/teams/{team_slug}/repos': { /** * Lists a team's repositories visible to the authenticated user. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. */ - readonly get: operations["teams/list-repos-in-org"]; - }; - readonly "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": { + readonly get: operations['teams/list-repos-in-org'] + } + readonly '/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}': { /** * Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. * @@ -1953,7 +1953,7 @@ export interface paths { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ - readonly get: operations["teams/check-permissions-for-repo-in-org"]; + readonly get: operations['teams/check-permissions-for-repo-in-org'] /** * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." * @@ -1961,15 +1961,15 @@ export interface paths { * * For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". */ - readonly put: operations["teams/add-or-update-repo-permissions-in-org"]; + readonly put: operations['teams/add-or-update-repo-permissions-in-org'] /** * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ - readonly delete: operations["teams/remove-repo-in-org"]; - }; - readonly "/orgs/{org}/teams/{team_slug}/team-sync/group-mappings": { + readonly delete: operations['teams/remove-repo-in-org'] + } + readonly '/orgs/{org}/teams/{team_slug}/team-sync/group-mappings': { /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -1977,7 +1977,7 @@ export interface paths { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`. */ - readonly get: operations["teams/list-idp-groups-in-org"]; + readonly get: operations['teams/list-idp-groups-in-org'] /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -1985,131 +1985,131 @@ export interface paths { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`. */ - readonly patch: operations["teams/create-or-update-idp-group-connections-in-org"]; - }; - readonly "/orgs/{org}/teams/{team_slug}/teams": { + readonly patch: operations['teams/create-or-update-idp-group-connections-in-org'] + } + readonly '/orgs/{org}/teams/{team_slug}/teams': { /** * Lists the child teams of the team specified by `{team_slug}`. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. */ - readonly get: operations["teams/list-child-in-org"]; - }; - readonly "/projects/columns/cards/{card_id}": { - readonly get: operations["projects/get-card"]; - readonly delete: operations["projects/delete-card"]; - readonly patch: operations["projects/update-card"]; - }; - readonly "/projects/columns/cards/{card_id}/moves": { - readonly post: operations["projects/move-card"]; - }; - readonly "/projects/columns/{column_id}": { - readonly get: operations["projects/get-column"]; - readonly delete: operations["projects/delete-column"]; - readonly patch: operations["projects/update-column"]; - }; - readonly "/projects/columns/{column_id}/cards": { - readonly get: operations["projects/list-cards"]; - readonly post: operations["projects/create-card"]; - }; - readonly "/projects/columns/{column_id}/moves": { - readonly post: operations["projects/move-column"]; - }; - readonly "/projects/{project_id}": { + readonly get: operations['teams/list-child-in-org'] + } + readonly '/projects/columns/cards/{card_id}': { + readonly get: operations['projects/get-card'] + readonly delete: operations['projects/delete-card'] + readonly patch: operations['projects/update-card'] + } + readonly '/projects/columns/cards/{card_id}/moves': { + readonly post: operations['projects/move-card'] + } + readonly '/projects/columns/{column_id}': { + readonly get: operations['projects/get-column'] + readonly delete: operations['projects/delete-column'] + readonly patch: operations['projects/update-column'] + } + readonly '/projects/columns/{column_id}/cards': { + readonly get: operations['projects/list-cards'] + readonly post: operations['projects/create-card'] + } + readonly '/projects/columns/{column_id}/moves': { + readonly post: operations['projects/move-column'] + } + readonly '/projects/{project_id}': { /** Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - readonly get: operations["projects/get"]; + readonly get: operations['projects/get'] /** Deletes a project board. Returns a `404 Not Found` status if projects are disabled. */ - readonly delete: operations["projects/delete"]; + readonly delete: operations['projects/delete'] /** Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - readonly patch: operations["projects/update"]; - }; - readonly "/projects/{project_id}/collaborators": { + readonly patch: operations['projects/update'] + } + readonly '/projects/{project_id}/collaborators': { /** Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators. */ - readonly get: operations["projects/list-collaborators"]; - }; - readonly "/projects/{project_id}/collaborators/{username}": { + readonly get: operations['projects/list-collaborators'] + } + readonly '/projects/{project_id}/collaborators/{username}': { /** Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator. */ - readonly put: operations["projects/add-collaborator"]; + readonly put: operations['projects/add-collaborator'] /** Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator. */ - readonly delete: operations["projects/remove-collaborator"]; - }; - readonly "/projects/{project_id}/collaborators/{username}/permission": { + readonly delete: operations['projects/remove-collaborator'] + } + readonly '/projects/{project_id}/collaborators/{username}/permission': { /** Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level. */ - readonly get: operations["projects/get-permission-for-user"]; - }; - readonly "/projects/{project_id}/columns": { - readonly get: operations["projects/list-columns"]; - readonly post: operations["projects/create-column"]; - }; - readonly "/rate_limit": { + readonly get: operations['projects/get-permission-for-user'] + } + readonly '/projects/{project_id}/columns': { + readonly get: operations['projects/list-columns'] + readonly post: operations['projects/create-column'] + } + readonly '/rate_limit': { /** * **Note:** Accessing this endpoint does not count against your REST API rate limit. * * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. */ - readonly get: operations["rate-limit/get"]; - }; - readonly "/reactions/{reaction_id}": { + readonly get: operations['rate-limit/get'] + } + readonly '/reactions/{reaction_id}': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Reactions API. We recommend migrating your existing code to use the new delete reactions endpoints. For more information, see this [blog post](https://developer.github.com/changes/2020-02-26-new-delete-reactions-endpoints/). * * OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), when deleting a [team discussion](https://docs.github.com/rest/reference/teams#discussions) or [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). */ - readonly delete: operations["reactions/delete-legacy"]; - }; - readonly "/repos/{owner}/{repo}": { + readonly delete: operations['reactions/delete-legacy'] + } + readonly '/repos/{owner}/{repo}': { /** The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. */ - readonly get: operations["repos/get"]; + readonly get: operations['repos/get'] /** * Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required. * * If an organization owner has configured the organization to prevent members from deleting organization-owned * repositories, you will get a `403 Forbidden` response. */ - readonly delete: operations["repos/delete"]; + readonly delete: operations['repos/delete'] /** **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/rest/reference/repos#replace-all-repository-topics) endpoint. */ - readonly patch: operations["repos/update"]; - }; - readonly "/repos/{owner}/{repo}/actions/artifacts": { + readonly patch: operations['repos/update'] + } + readonly '/repos/{owner}/{repo}/actions/artifacts': { /** Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - readonly get: operations["actions/list-artifacts-for-repo"]; - }; - readonly "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}": { + readonly get: operations['actions/list-artifacts-for-repo'] + } + readonly '/repos/{owner}/{repo}/actions/artifacts/{artifact_id}': { /** Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - readonly get: operations["actions/get-artifact"]; + readonly get: operations['actions/get-artifact'] /** Deletes an artifact for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - readonly delete: operations["actions/delete-artifact"]; - }; - readonly "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}": { + readonly delete: operations['actions/delete-artifact'] + } + readonly '/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}': { /** * Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in * the response header to find the URL for the download. The `:archive_format` must be `zip`. Anyone with read access to * the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:read` permission to use this endpoint. */ - readonly get: operations["actions/download-artifact"]; - }; - readonly "/repos/{owner}/{repo}/actions/jobs/{job_id}": { + readonly get: operations['actions/download-artifact'] + } + readonly '/repos/{owner}/{repo}/actions/jobs/{job_id}': { /** Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - readonly get: operations["actions/get-job-for-workflow-run"]; - }; - readonly "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs": { + readonly get: operations['actions/get-job-for-workflow-run'] + } + readonly '/repos/{owner}/{repo}/actions/jobs/{job_id}/logs': { /** * Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look * for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can * use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must * have the `actions:read` permission to use this endpoint. */ - readonly get: operations["actions/download-job-logs-for-workflow-run"]; - }; - readonly "/repos/{owner}/{repo}/actions/permissions": { + readonly get: operations['actions/download-job-logs-for-workflow-run'] + } + readonly '/repos/{owner}/{repo}/actions/permissions': { /** * Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository. * * You must authenticate using an access token with the `repo` scope to use this * endpoint. GitHub Apps must have the `administration` repository permission to use this API. */ - readonly get: operations["actions/get-github-actions-permissions-repository"]; + readonly get: operations['actions/get-github-actions-permissions-repository'] /** * Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository. * @@ -2117,15 +2117,15 @@ export interface paths { * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. */ - readonly put: operations["actions/set-github-actions-permissions-repository"]; - }; - readonly "/repos/{owner}/{repo}/actions/permissions/selected-actions": { + readonly put: operations['actions/set-github-actions-permissions-repository'] + } + readonly '/repos/{owner}/{repo}/actions/permissions/selected-actions': { /** * Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. */ - readonly get: operations["actions/get-allowed-actions-repository"]; + readonly get: operations['actions/get-allowed-actions-repository'] /** * Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." * @@ -2135,21 +2135,21 @@ export interface paths { * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. */ - readonly put: operations["actions/set-allowed-actions-repository"]; - }; - readonly "/repos/{owner}/{repo}/actions/runners": { + readonly put: operations['actions/set-allowed-actions-repository'] + } + readonly '/repos/{owner}/{repo}/actions/runners': { /** Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. */ - readonly get: operations["actions/list-self-hosted-runners-for-repo"]; - }; - readonly "/repos/{owner}/{repo}/actions/runners/downloads": { + readonly get: operations['actions/list-self-hosted-runners-for-repo'] + } + readonly '/repos/{owner}/{repo}/actions/runners/downloads': { /** * Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `repo` scope to use this endpoint. */ - readonly get: operations["actions/list-runner-applications-for-repo"]; - }; - readonly "/repos/{owner}/{repo}/actions/runners/registration-token": { + readonly get: operations['actions/list-runner-applications-for-repo'] + } + readonly '/repos/{owner}/{repo}/actions/runners/registration-token': { /** * Returns a token that you can pass to the `config` script. The token expires after one hour. You must authenticate * using an access token with the `repo` scope to use this endpoint. @@ -2162,9 +2162,9 @@ export interface paths { * ./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN * ``` */ - readonly post: operations["actions/create-registration-token-for-repo"]; - }; - readonly "/repos/{owner}/{repo}/actions/runners/remove-token": { + readonly post: operations['actions/create-registration-token-for-repo'] + } + readonly '/repos/{owner}/{repo}/actions/runners/remove-token': { /** * Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour. * You must authenticate using an access token with the `repo` scope to use this endpoint. @@ -2177,32 +2177,32 @@ export interface paths { * ./config.sh remove --token TOKEN * ``` */ - readonly post: operations["actions/create-remove-token-for-repo"]; - }; - readonly "/repos/{owner}/{repo}/actions/runners/{runner_id}": { + readonly post: operations['actions/create-remove-token-for-repo'] + } + readonly '/repos/{owner}/{repo}/actions/runners/{runner_id}': { /** * Gets a specific self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - readonly get: operations["actions/get-self-hosted-runner-for-repo"]; + readonly get: operations['actions/get-self-hosted-runner-for-repo'] /** * Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * * You must authenticate using an access token with the `repo` * scope to use this endpoint. */ - readonly delete: operations["actions/delete-self-hosted-runner-from-repo"]; - }; - readonly "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels": { + readonly delete: operations['actions/delete-self-hosted-runner-from-repo'] + } + readonly '/repos/{owner}/{repo}/actions/runners/{runner_id}/labels': { /** * Lists all labels for a self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - readonly get: operations["actions/list-labels-for-self-hosted-runner-for-repo"]; + readonly get: operations['actions/list-labels-for-self-hosted-runner-for-repo'] /** * Remove all previous custom labels and set the new custom labels for a specific * self-hosted runner configured in a repository. @@ -2210,14 +2210,14 @@ export interface paths { * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - readonly put: operations["actions/set-custom-labels-for-self-hosted-runner-for-repo"]; + readonly put: operations['actions/set-custom-labels-for-self-hosted-runner-for-repo'] /** * Add custom labels to a self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - readonly post: operations["actions/add-custom-labels-to-self-hosted-runner-for-repo"]; + readonly post: operations['actions/add-custom-labels-to-self-hosted-runner-for-repo'] /** * Remove all custom labels from a self-hosted runner configured in a * repository. Returns the remaining read-only labels from the runner. @@ -2225,9 +2225,9 @@ export interface paths { * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - readonly delete: operations["actions/remove-all-custom-labels-from-self-hosted-runner-for-repo"]; - }; - readonly "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}": { + readonly delete: operations['actions/remove-all-custom-labels-from-self-hosted-runner-for-repo'] + } + readonly '/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}': { /** * Remove a custom label from a self-hosted runner configured * in a repository. Returns the remaining labels from the runner. @@ -2238,120 +2238,120 @@ export interface paths { * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - readonly delete: operations["actions/remove-custom-label-from-self-hosted-runner-for-repo"]; - }; - readonly "/repos/{owner}/{repo}/actions/runs": { + readonly delete: operations['actions/remove-custom-label-from-self-hosted-runner-for-repo'] + } + readonly '/repos/{owner}/{repo}/actions/runs': { /** * Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). * * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - readonly get: operations["actions/list-workflow-runs-for-repo"]; - }; - readonly "/repos/{owner}/{repo}/actions/runs/{run_id}": { + readonly get: operations['actions/list-workflow-runs-for-repo'] + } + readonly '/repos/{owner}/{repo}/actions/runs/{run_id}': { /** Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - readonly get: operations["actions/get-workflow-run"]; + readonly get: operations['actions/get-workflow-run'] /** * Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is * private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:write` permission to use * this endpoint. */ - readonly delete: operations["actions/delete-workflow-run"]; - }; - readonly "/repos/{owner}/{repo}/actions/runs/{run_id}/approvals": { + readonly delete: operations['actions/delete-workflow-run'] + } + readonly '/repos/{owner}/{repo}/actions/runs/{run_id}/approvals': { /** Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - readonly get: operations["actions/get-reviews-for-run"]; - }; - readonly "/repos/{owner}/{repo}/actions/runs/{run_id}/approve": { + readonly get: operations['actions/get-reviews-for-run'] + } + readonly '/repos/{owner}/{repo}/actions/runs/{run_id}/approve': { /** * Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)." * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - readonly post: operations["actions/approve-workflow-run"]; - }; - readonly "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts": { + readonly post: operations['actions/approve-workflow-run'] + } + readonly '/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts': { /** Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - readonly get: operations["actions/list-workflow-run-artifacts"]; - }; - readonly "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}": { + readonly get: operations['actions/list-workflow-run-artifacts'] + } + readonly '/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}': { /** * Gets a specific workflow run attempt. Anyone with read access to the repository * can use this endpoint. If the repository is private you must use an access token * with the `repo` scope. GitHub Apps must have the `actions:read` permission to * use this endpoint. */ - readonly get: operations["actions/get-workflow-run-attempt"]; - }; - readonly "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs": { + readonly get: operations['actions/get-workflow-run-attempt'] + } + readonly '/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs': { /** Lists jobs for a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). */ - readonly get: operations["actions/list-jobs-for-workflow-run-attempt"]; - }; - readonly "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs": { + readonly get: operations['actions/list-jobs-for-workflow-run-attempt'] + } + readonly '/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs': { /** * Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after * 1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to * the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:read` permission to use this endpoint. */ - readonly get: operations["actions/download-workflow-run-attempt-logs"]; - }; - readonly "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": { + readonly get: operations['actions/download-workflow-run-attempt-logs'] + } + readonly '/repos/{owner}/{repo}/actions/runs/{run_id}/cancel': { /** Cancels a workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - readonly post: operations["actions/cancel-workflow-run"]; - }; - readonly "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": { + readonly post: operations['actions/cancel-workflow-run'] + } + readonly '/repos/{owner}/{repo}/actions/runs/{run_id}/jobs': { /** Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). */ - readonly get: operations["actions/list-jobs-for-workflow-run"]; - }; - readonly "/repos/{owner}/{repo}/actions/runs/{run_id}/logs": { + readonly get: operations['actions/list-jobs-for-workflow-run'] + } + readonly '/repos/{owner}/{repo}/actions/runs/{run_id}/logs': { /** * Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for * `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use * this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have * the `actions:read` permission to use this endpoint. */ - readonly get: operations["actions/download-workflow-run-logs"]; + readonly get: operations['actions/download-workflow-run-logs'] /** Deletes all logs for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - readonly delete: operations["actions/delete-workflow-run-logs"]; - }; - readonly "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments": { + readonly delete: operations['actions/delete-workflow-run-logs'] + } + readonly '/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments': { /** * Get all deployment environments for a workflow run that are waiting for protection rules to pass. * * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - readonly get: operations["actions/get-pending-deployments-for-run"]; + readonly get: operations['actions/get-pending-deployments-for-run'] /** * Approve or reject pending deployments that are waiting on approval by a required reviewer. * * Anyone with read access to the repository contents and deployments can use this endpoint. */ - readonly post: operations["actions/review-pending-deployments-for-run"]; - }; - readonly "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun": { + readonly post: operations['actions/review-pending-deployments-for-run'] + } + readonly '/repos/{owner}/{repo}/actions/runs/{run_id}/rerun': { /** Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - readonly post: operations["actions/re-run-workflow"]; - }; - readonly "/repos/{owner}/{repo}/actions/runs/{run_id}/timing": { + readonly post: operations['actions/re-run-workflow'] + } + readonly '/repos/{owner}/{repo}/actions/runs/{run_id}/timing': { /** * Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - readonly get: operations["actions/get-workflow-run-usage"]; - }; - readonly "/repos/{owner}/{repo}/actions/secrets": { + readonly get: operations['actions/get-workflow-run-usage'] + } + readonly '/repos/{owner}/{repo}/actions/secrets': { /** Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - readonly get: operations["actions/list-repo-secrets"]; - }; - readonly "/repos/{owner}/{repo}/actions/secrets/public-key": { + readonly get: operations['actions/list-repo-secrets'] + } + readonly '/repos/{owner}/{repo}/actions/secrets/public-key': { /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - readonly get: operations["actions/get-repo-public-key"]; - }; - readonly "/repos/{owner}/{repo}/actions/secrets/{secret_name}": { + readonly get: operations['actions/get-repo-public-key'] + } + readonly '/repos/{owner}/{repo}/actions/secrets/{secret_name}': { /** Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - readonly get: operations["actions/get-repo-secret"]; + readonly get: operations['actions/get-repo-secret'] /** * Creates or updates a repository secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -2429,27 +2429,27 @@ export interface paths { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - readonly put: operations["actions/create-or-update-repo-secret"]; + readonly put: operations['actions/create-or-update-repo-secret'] /** Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - readonly delete: operations["actions/delete-repo-secret"]; - }; - readonly "/repos/{owner}/{repo}/actions/workflows": { + readonly delete: operations['actions/delete-repo-secret'] + } + readonly '/repos/{owner}/{repo}/actions/workflows': { /** Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - readonly get: operations["actions/list-repo-workflows"]; - }; - readonly "/repos/{owner}/{repo}/actions/workflows/{workflow_id}": { + readonly get: operations['actions/list-repo-workflows'] + } + readonly '/repos/{owner}/{repo}/actions/workflows/{workflow_id}': { /** Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - readonly get: operations["actions/get-workflow"]; - }; - readonly "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable": { + readonly get: operations['actions/get-workflow'] + } + readonly '/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable': { /** * Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - readonly put: operations["actions/disable-workflow"]; - }; - readonly "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches": { + readonly put: operations['actions/disable-workflow'] + } + readonly '/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches': { /** * You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * @@ -2457,37 +2457,37 @@ export interface paths { * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)." */ - readonly post: operations["actions/create-workflow-dispatch"]; - }; - readonly "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable": { + readonly post: operations['actions/create-workflow-dispatch'] + } + readonly '/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable': { /** * Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - readonly put: operations["actions/enable-workflow"]; - }; - readonly "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { + readonly put: operations['actions/enable-workflow'] + } + readonly '/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs': { /** * List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). * * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. */ - readonly get: operations["actions/list-workflow-runs"]; - }; - readonly "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing": { + readonly get: operations['actions/list-workflow-runs'] + } + readonly '/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing': { /** * Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * * You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - readonly get: operations["actions/get-workflow-usage"]; - }; - readonly "/repos/{owner}/{repo}/assignees": { + readonly get: operations['actions/get-workflow-usage'] + } + readonly '/repos/{owner}/{repo}/assignees': { /** Lists the [available assignees](https://docs.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. */ - readonly get: operations["issues/list-assignees"]; - }; - readonly "/repos/{owner}/{repo}/assignees/{assignee}": { + readonly get: operations['issues/list-assignees'] + } + readonly '/repos/{owner}/{repo}/assignees/{assignee}': { /** * Checks if a user has permission to be assigned to an issue in this repository. * @@ -2495,47 +2495,47 @@ export interface paths { * * Otherwise a `404` status code is returned. */ - readonly get: operations["issues/check-user-can-be-assigned"]; - }; - readonly "/repos/{owner}/{repo}/autolinks": { + readonly get: operations['issues/check-user-can-be-assigned'] + } + readonly '/repos/{owner}/{repo}/autolinks': { /** * This returns a list of autolinks configured for the given repository. * * Information about autolinks are only available to repository administrators. */ - readonly get: operations["repos/list-autolinks"]; + readonly get: operations['repos/list-autolinks'] /** Users with admin access to the repository can create an autolink. */ - readonly post: operations["repos/create-autolink"]; - }; - readonly "/repos/{owner}/{repo}/autolinks/{autolink_id}": { + readonly post: operations['repos/create-autolink'] + } + readonly '/repos/{owner}/{repo}/autolinks/{autolink_id}': { /** * This returns a single autolink reference by ID that was configured for the given repository. * * Information about autolinks are only available to repository administrators. */ - readonly get: operations["repos/get-autolink"]; + readonly get: operations['repos/get-autolink'] /** * This deletes a single autolink reference by ID that was configured for the given repository. * * Information about autolinks are only available to repository administrators. */ - readonly delete: operations["repos/delete-autolink"]; - }; - readonly "/repos/{owner}/{repo}/automated-security-fixes": { + readonly delete: operations['repos/delete-autolink'] + } + readonly '/repos/{owner}/{repo}/automated-security-fixes': { /** Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/en/articles/configuring-automated-security-fixes)". */ - readonly put: operations["repos/enable-automated-security-fixes"]; + readonly put: operations['repos/enable-automated-security-fixes'] /** Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/en/articles/configuring-automated-security-fixes)". */ - readonly delete: operations["repos/disable-automated-security-fixes"]; - }; - readonly "/repos/{owner}/{repo}/branches": { - readonly get: operations["repos/list-branches"]; - }; - readonly "/repos/{owner}/{repo}/branches/{branch}": { - readonly get: operations["repos/get-branch"]; - }; - readonly "/repos/{owner}/{repo}/branches/{branch}/protection": { + readonly delete: operations['repos/disable-automated-security-fixes'] + } + readonly '/repos/{owner}/{repo}/branches': { + readonly get: operations['repos/list-branches'] + } + readonly '/repos/{owner}/{repo}/branches/{branch}': { + readonly get: operations['repos/get-branch'] + } + readonly '/repos/{owner}/{repo}/branches/{branch}/protection': { /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly get: operations["repos/get-branch-protection"]; + readonly get: operations['repos/get-branch-protection'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2545,31 +2545,31 @@ export interface paths { * * **Note**: The list of users, apps, and teams in total is limited to 100 items. */ - readonly put: operations["repos/update-branch-protection"]; + readonly put: operations['repos/update-branch-protection'] /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly delete: operations["repos/delete-branch-protection"]; - }; - readonly "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins": { + readonly delete: operations['repos/delete-branch-protection'] + } + readonly '/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins': { /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly get: operations["repos/get-admin-branch-protection"]; + readonly get: operations['repos/get-admin-branch-protection'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ - readonly post: operations["repos/set-admin-branch-protection"]; + readonly post: operations['repos/set-admin-branch-protection'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ - readonly delete: operations["repos/delete-admin-branch-protection"]; - }; - readonly "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews": { + readonly delete: operations['repos/delete-admin-branch-protection'] + } + readonly '/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews': { /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly get: operations["repos/get-pull-request-review-protection"]; + readonly get: operations['repos/get-pull-request-review-protection'] /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly delete: operations["repos/delete-pull-request-review-protection"]; + readonly delete: operations['repos/delete-pull-request-review-protection'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2577,9 +2577,9 @@ export interface paths { * * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. */ - readonly patch: operations["repos/update-pull-request-review-protection"]; - }; - readonly "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures": { + readonly patch: operations['repos/update-pull-request-review-protection'] + } + readonly '/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures': { /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2587,43 +2587,43 @@ export interface paths { * * **Note**: You must enable branch protection to require signed commits. */ - readonly get: operations["repos/get-commit-signature-protection"]; + readonly get: operations['repos/get-commit-signature-protection'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits. */ - readonly post: operations["repos/create-commit-signature-protection"]; + readonly post: operations['repos/create-commit-signature-protection'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits. */ - readonly delete: operations["repos/delete-commit-signature-protection"]; - }; - readonly "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks": { + readonly delete: operations['repos/delete-commit-signature-protection'] + } + readonly '/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks': { /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly get: operations["repos/get-status-checks-protection"]; + readonly get: operations['repos/get-status-checks-protection'] /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly delete: operations["repos/remove-status-check-protection"]; + readonly delete: operations['repos/remove-status-check-protection'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. */ - readonly patch: operations["repos/update-status-check-protection"]; - }; - readonly "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts": { + readonly patch: operations['repos/update-status-check-protection'] + } + readonly '/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts': { /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly get: operations["repos/get-all-status-check-contexts"]; + readonly get: operations['repos/get-all-status-check-contexts'] /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly put: operations["repos/set-status-check-contexts"]; + readonly put: operations['repos/set-status-check-contexts'] /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly post: operations["repos/add-status-check-contexts"]; + readonly post: operations['repos/add-status-check-contexts'] /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly delete: operations["repos/remove-status-check-contexts"]; - }; - readonly "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions": { + readonly delete: operations['repos/remove-status-check-contexts'] + } + readonly '/repos/{owner}/{repo}/branches/{branch}/protection/restrictions': { /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2631,21 +2631,21 @@ export interface paths { * * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. */ - readonly get: operations["repos/get-access-restrictions"]; + readonly get: operations['repos/get-access-restrictions'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Disables the ability to restrict who can push to this branch. */ - readonly delete: operations["repos/delete-access-restrictions"]; - }; - readonly "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps": { + readonly delete: operations['repos/delete-access-restrictions'] + } + readonly '/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps': { /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. */ - readonly get: operations["repos/get-apps-with-access-to-protected-branch"]; + readonly get: operations['repos/get-apps-with-access-to-protected-branch'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2655,7 +2655,7 @@ export interface paths { * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - readonly put: operations["repos/set-app-access-restrictions"]; + readonly put: operations['repos/set-app-access-restrictions'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2665,7 +2665,7 @@ export interface paths { * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - readonly post: operations["repos/add-app-access-restrictions"]; + readonly post: operations['repos/add-app-access-restrictions'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2675,15 +2675,15 @@ export interface paths { * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - readonly delete: operations["repos/remove-app-access-restrictions"]; - }; - readonly "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams": { + readonly delete: operations['repos/remove-app-access-restrictions'] + } + readonly '/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams': { /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the teams who have push access to this branch. The list includes child teams. */ - readonly get: operations["repos/get-teams-with-access-to-protected-branch"]; + readonly get: operations['repos/get-teams-with-access-to-protected-branch'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2693,7 +2693,7 @@ export interface paths { * | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ | * | `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - readonly put: operations["repos/set-team-access-restrictions"]; + readonly put: operations['repos/set-team-access-restrictions'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2703,7 +2703,7 @@ export interface paths { * | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ | * | `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - readonly post: operations["repos/add-team-access-restrictions"]; + readonly post: operations['repos/add-team-access-restrictions'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2713,15 +2713,15 @@ export interface paths { * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | Teams that should no longer have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - readonly delete: operations["repos/remove-team-access-restrictions"]; - }; - readonly "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users": { + readonly delete: operations['repos/remove-team-access-restrictions'] + } + readonly '/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users': { /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the people who have push access to this branch. */ - readonly get: operations["repos/get-users-with-access-to-protected-branch"]; + readonly get: operations['repos/get-users-with-access-to-protected-branch'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2731,7 +2731,7 @@ export interface paths { * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - readonly put: operations["repos/set-user-access-restrictions"]; + readonly put: operations['repos/set-user-access-restrictions'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2741,7 +2741,7 @@ export interface paths { * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - readonly post: operations["repos/add-user-access-restrictions"]; + readonly post: operations['repos/add-user-access-restrictions'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2751,9 +2751,9 @@ export interface paths { * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - readonly delete: operations["repos/remove-user-access-restrictions"]; - }; - readonly "/repos/{owner}/{repo}/branches/{branch}/rename": { + readonly delete: operations['repos/remove-user-access-restrictions'] + } + readonly '/repos/{owner}/{repo}/branches/{branch}/rename': { /** * Renames a branch in a repository. * @@ -2771,9 +2771,9 @@ export interface paths { * * Users must have admin or owner permissions. * * GitHub Apps must have the `administration:write` repository permission. */ - readonly post: operations["repos/rename-branch"]; - }; - readonly "/repos/{owner}/{repo}/check-runs": { + readonly post: operations['repos/rename-branch'] + } + readonly '/repos/{owner}/{repo}/check-runs': { /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * @@ -2781,71 +2781,71 @@ export interface paths { * * In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. */ - readonly post: operations["checks/create"]; - }; - readonly "/repos/{owner}/{repo}/check-runs/{check_run_id}": { + readonly post: operations['checks/create'] + } + readonly '/repos/{owner}/{repo}/check-runs/{check_run_id}': { /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * Gets a single check run using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. */ - readonly get: operations["checks/get"]; + readonly get: operations['checks/get'] /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. */ - readonly patch: operations["checks/update"]; - }; - readonly "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations": { + readonly patch: operations['checks/update'] + } + readonly '/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations': { /** Lists annotations for a check run using the annotation `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the `repo` scope to get annotations for a check run in a private repository. */ - readonly get: operations["checks/list-annotations"]; - }; - readonly "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest": { + readonly get: operations['checks/list-annotations'] + } + readonly '/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest': { /** * Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * * To rerequest a check run, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository. */ - readonly post: operations["checks/rerequest-run"]; - }; - readonly "/repos/{owner}/{repo}/check-suites": { + readonly post: operations['checks/rerequest-run'] + } + readonly '/repos/{owner}/{repo}/check-suites': { /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * * By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/reference/checks#check-runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/reference/checks#update-repository-preferences-for-check-suites)". Your GitHub App must have the `checks:write` permission to create check suites. */ - readonly post: operations["checks/create-suite"]; - }; - readonly "/repos/{owner}/{repo}/check-suites/preferences": { + readonly post: operations['checks/create-suite'] + } + readonly '/repos/{owner}/{repo}/check-suites/preferences': { /** Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/reference/checks#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites. */ - readonly patch: operations["checks/set-suites-preferences"]; - }; - readonly "/repos/{owner}/{repo}/check-suites/{check_suite_id}": { + readonly patch: operations['checks/set-suites-preferences'] + } + readonly '/repos/{owner}/{repo}/check-suites/{check_suite_id}': { /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * * Gets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository. */ - readonly get: operations["checks/get-suite"]; - }; - readonly "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": { + readonly get: operations['checks/get-suite'] + } + readonly '/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs': { /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. */ - readonly get: operations["checks/list-for-suite"]; - }; - readonly "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest": { + readonly get: operations['checks/list-for-suite'] + } + readonly '/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest': { /** * Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * * To rerequest a check suite, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository. */ - readonly post: operations["checks/rerequest-suite"]; - }; - readonly "/repos/{owner}/{repo}/code-scanning/alerts": { + readonly post: operations['checks/rerequest-suite'] + } + readonly '/repos/{owner}/{repo}/code-scanning/alerts': { /** * Lists all open code scanning alerts for the default branch (usually `main` * or `master`). You must use an access token with the `security_events` scope to use @@ -2858,29 +2858,29 @@ export interface paths { * for the default branch or for the specified Git reference * (if you used `ref` in the request). */ - readonly get: operations["code-scanning/list-alerts-for-repo"]; - }; - readonly "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}": { + readonly get: operations['code-scanning/list-alerts-for-repo'] + } + readonly '/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}': { /** * Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint. * * **Deprecation notice**: * The instances field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The same information can now be retrieved via a GET request to the URL specified by `instances_url`. */ - readonly get: operations["code-scanning/get-alert"]; + readonly get: operations['code-scanning/get-alert'] /** Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. */ - readonly patch: operations["code-scanning/update-alert"]; - }; - readonly "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances": { + readonly patch: operations['code-scanning/update-alert'] + } + readonly '/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances': { /** * Lists all instances of the specified code scanning alert. * You must use an access token with the `security_events` scope to use this endpoint with private repos, * the `public_repo` scope also grants permission to read security events on public repos only. * GitHub Apps must have the `security_events` read permission to use this endpoint. */ - readonly get: operations["code-scanning/list-alert-instances"]; - }; - readonly "/repos/{owner}/{repo}/code-scanning/analyses": { + readonly get: operations['code-scanning/list-alert-instances'] + } + readonly '/repos/{owner}/{repo}/code-scanning/analyses': { /** * Lists the details of all code scanning analyses for a repository, * starting with the most recent. @@ -2900,9 +2900,9 @@ export interface paths { * **Deprecation notice**: * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. */ - readonly get: operations["code-scanning/list-recent-analyses"]; - }; - readonly "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}": { + readonly get: operations['code-scanning/list-recent-analyses'] + } + readonly '/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}': { /** * Gets a specified code scanning analysis for a repository. * You must use an access token with the `security_events` scope to use this endpoint with private repos, @@ -2924,7 +2924,7 @@ export interface paths { * This is formatted as * [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). */ - readonly get: operations["code-scanning/get-analysis"]; + readonly get: operations['code-scanning/get-analysis'] /** * Deletes a specified code scanning analysis from a repository. For * private repositories, you must use an access token with the `repo` scope. For public repositories, @@ -2993,9 +2993,9 @@ export interface paths { * * The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely. */ - readonly delete: operations["code-scanning/delete-analysis"]; - }; - readonly "/repos/{owner}/{repo}/code-scanning/sarifs": { + readonly delete: operations['code-scanning/delete-analysis'] + } + readonly '/repos/{owner}/{repo}/code-scanning/sarifs': { /** * Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. * @@ -3015,27 +3015,27 @@ export interface paths { * You can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint. * For more information, see "[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload)." */ - readonly post: operations["code-scanning/upload-sarif"]; - }; - readonly "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}": { + readonly post: operations['code-scanning/upload-sarif'] + } + readonly '/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}': { /** Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository)." You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint. */ - readonly get: operations["code-scanning/get-sarif"]; - }; - readonly "/repos/{owner}/{repo}/codespaces": { + readonly get: operations['code-scanning/get-sarif'] + } + readonly '/repos/{owner}/{repo}/codespaces': { /** * Lists the codespaces associated to a specified repository and the authenticated user. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - readonly get: operations["codespaces/list-in-repository-for-authenticated-user"]; + readonly get: operations['codespaces/list-in-repository-for-authenticated-user'] /** * Creates a codespace owned by the authenticated user in the specified repository. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - readonly post: operations["codespaces/create-with-repo-for-authenticated-user"]; - }; - readonly "/repos/{owner}/{repo}/codespaces/machines": { + readonly post: operations['codespaces/create-with-repo-for-authenticated-user'] + } + readonly '/repos/{owner}/{repo}/codespaces/machines': { /** * List the machine types available for a given repository based on its configuration. * @@ -3043,9 +3043,9 @@ export interface paths { * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - readonly get: operations["codespaces/repo-machines-for-authenticated-user"]; - }; - readonly "/repos/{owner}/{repo}/collaborators": { + readonly get: operations['codespaces/repo-machines-for-authenticated-user'] + } + readonly '/repos/{owner}/{repo}/collaborators': { /** * For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. * @@ -3055,9 +3055,9 @@ export interface paths { * endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this * endpoint. */ - readonly get: operations["repos/list-collaborators"]; - }; - readonly "/repos/{owner}/{repo}/collaborators/{username}": { + readonly get: operations['repos/list-collaborators'] + } + readonly '/repos/{owner}/{repo}/collaborators/{username}': { /** * For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. * @@ -3067,7 +3067,7 @@ export interface paths { * endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this * endpoint. */ - readonly get: operations["repos/check-collaborator"]; + readonly get: operations['repos/check-collaborator'] /** * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. * @@ -3085,41 +3085,41 @@ export interface paths { * * You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository. */ - readonly put: operations["repos/add-collaborator"]; - readonly delete: operations["repos/remove-collaborator"]; - }; - readonly "/repos/{owner}/{repo}/collaborators/{username}/permission": { + readonly put: operations['repos/add-collaborator'] + readonly delete: operations['repos/remove-collaborator'] + } + readonly '/repos/{owner}/{repo}/collaborators/{username}/permission': { /** Checks the repository permission of a collaborator. The possible repository permissions are `admin`, `write`, `read`, and `none`. */ - readonly get: operations["repos/get-collaborator-permission-level"]; - }; - readonly "/repos/{owner}/{repo}/comments": { + readonly get: operations['repos/get-collaborator-permission-level'] + } + readonly '/repos/{owner}/{repo}/comments': { /** * Commit Comments use [these custom media types](https://docs.github.com/rest/reference/repos#custom-media-types). You can read more about the use of media types in the API [here](https://docs.github.com/rest/overview/media-types/). * * Comments are ordered by ascending ID. */ - readonly get: operations["repos/list-commit-comments-for-repo"]; - }; - readonly "/repos/{owner}/{repo}/comments/{comment_id}": { - readonly get: operations["repos/get-commit-comment"]; - readonly delete: operations["repos/delete-commit-comment"]; - readonly patch: operations["repos/update-commit-comment"]; - }; - readonly "/repos/{owner}/{repo}/comments/{comment_id}/reactions": { + readonly get: operations['repos/list-commit-comments-for-repo'] + } + readonly '/repos/{owner}/{repo}/comments/{comment_id}': { + readonly get: operations['repos/get-commit-comment'] + readonly delete: operations['repos/delete-commit-comment'] + readonly patch: operations['repos/update-commit-comment'] + } + readonly '/repos/{owner}/{repo}/comments/{comment_id}/reactions': { /** List the reactions to a [commit comment](https://docs.github.com/rest/reference/repos#comments). */ - readonly get: operations["reactions/list-for-commit-comment"]; + readonly get: operations['reactions/list-for-commit-comment'] /** Create a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. */ - readonly post: operations["reactions/create-for-commit-comment"]; - }; - readonly "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}": { + readonly post: operations['reactions/create-for-commit-comment'] + } + readonly '/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}': { /** * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. * * Delete a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). */ - readonly delete: operations["reactions/delete-for-commit-comment"]; - }; - readonly "/repos/{owner}/{repo}/commits": { + readonly delete: operations['reactions/delete-for-commit-comment'] + } + readonly '/repos/{owner}/{repo}/commits': { /** * **Signature verification object** * @@ -3150,31 +3150,31 @@ export interface paths { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - readonly get: operations["repos/list-commits"]; - }; - readonly "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head": { + readonly get: operations['repos/list-commits'] + } + readonly '/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head': { /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. */ - readonly get: operations["repos/list-branches-for-head-commit"]; - }; - readonly "/repos/{owner}/{repo}/commits/{commit_sha}/comments": { + readonly get: operations['repos/list-branches-for-head-commit'] + } + readonly '/repos/{owner}/{repo}/commits/{commit_sha}/comments': { /** Use the `:commit_sha` to specify the commit that will have its comments listed. */ - readonly get: operations["repos/list-comments-for-commit"]; + readonly get: operations['repos/list-comments-for-commit'] /** * Create a comment for a commit using its `:commit_sha`. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - readonly post: operations["repos/create-commit-comment"]; - }; - readonly "/repos/{owner}/{repo}/commits/{commit_sha}/pulls": { + readonly post: operations['repos/create-commit-comment'] + } + readonly '/repos/{owner}/{repo}/commits/{commit_sha}/pulls': { /** Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the [List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests) endpoint. */ - readonly get: operations["repos/list-pull-requests-associated-with-commit"]; - }; - readonly "/repos/{owner}/{repo}/commits/{ref}": { + readonly get: operations['repos/list-pull-requests-associated-with-commit'] + } + readonly '/repos/{owner}/{repo}/commits/{ref}': { /** * Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. * @@ -3213,25 +3213,25 @@ export interface paths { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - readonly get: operations["repos/get-commit"]; - }; - readonly "/repos/{owner}/{repo}/commits/{ref}/check-runs": { + readonly get: operations['repos/get-commit'] + } + readonly '/repos/{owner}/{repo}/commits/{ref}/check-runs': { /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. */ - readonly get: operations["checks/list-for-ref"]; - }; - readonly "/repos/{owner}/{repo}/commits/{ref}/check-suites": { + readonly get: operations['checks/list-for-ref'] + } + readonly '/repos/{owner}/{repo}/commits/{ref}/check-suites': { /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * * Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository. */ - readonly get: operations["checks/list-suites-for-ref"]; - }; - readonly "/repos/{owner}/{repo}/commits/{ref}/status": { + readonly get: operations['checks/list-suites-for-ref'] + } + readonly '/repos/{owner}/{repo}/commits/{ref}/status': { /** * Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. * @@ -3242,17 +3242,17 @@ export interface paths { * * **pending** if there are no statuses or a context is `pending` * * **success** if the latest status for all contexts is `success` */ - readonly get: operations["repos/get-combined-status-for-ref"]; - }; - readonly "/repos/{owner}/{repo}/commits/{ref}/statuses": { + readonly get: operations['repos/get-combined-status-for-ref'] + } + readonly '/repos/{owner}/{repo}/commits/{ref}/statuses': { /** * Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one. * * This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`. */ - readonly get: operations["repos/list-commit-statuses-for-ref"]; - }; - readonly "/repos/{owner}/{repo}/community/profile": { + readonly get: operations['repos/list-commit-statuses-for-ref'] + } + readonly '/repos/{owner}/{repo}/community/profile': { /** * This endpoint will return all community profile metrics, including an * overall health score, repository description, the presence of documentation, detected @@ -3267,9 +3267,9 @@ export interface paths { * * `content_reports_enabled` is only returned for organization-owned repositories. */ - readonly get: operations["repos/get-community-profile-metrics"]; - }; - readonly "/repos/{owner}/{repo}/compare/{basehead}": { + readonly get: operations['repos/get-community-profile-metrics'] + } + readonly '/repos/{owner}/{repo}/compare/{basehead}': { /** * The `basehead` param is comprised of two parts: `base` and `head`. Both must be branch names in `repo`. To compare branches across other repositories in the same network as `repo`, use the format `:branch`. * @@ -3312,9 +3312,9 @@ export interface paths { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - readonly get: operations["repos/compare-commits"]; - }; - readonly "/repos/{owner}/{repo}/contents/{path}": { + readonly get: operations['repos/compare-commits'] + } + readonly '/repos/{owner}/{repo}/contents/{path}': { /** * Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit * `:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. @@ -3349,9 +3349,9 @@ export interface paths { * If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the * github.com URLs (`html_url` and `_links["html"]`) will have null values. */ - readonly get: operations["repos/get-content"]; + readonly get: operations['repos/get-content'] /** Creates a new file or replaces an existing file in a repository. */ - readonly put: operations["repos/create-or-update-file-contents"]; + readonly put: operations['repos/create-or-update-file-contents'] /** * Deletes a file in a repository. * @@ -3361,27 +3361,27 @@ export interface paths { * * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. */ - readonly delete: operations["repos/delete-file"]; - }; - readonly "/repos/{owner}/{repo}/contributors": { + readonly delete: operations['repos/delete-file'] + } + readonly '/repos/{owner}/{repo}/contributors': { /** * Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance. * * GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information. */ - readonly get: operations["repos/list-contributors"]; - }; - readonly "/repos/{owner}/{repo}/dependabot/secrets": { + readonly get: operations['repos/list-contributors'] + } + readonly '/repos/{owner}/{repo}/dependabot/secrets': { /** Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */ - readonly get: operations["dependabot/list-repo-secrets"]; - }; - readonly "/repos/{owner}/{repo}/dependabot/secrets/public-key": { + readonly get: operations['dependabot/list-repo-secrets'] + } + readonly '/repos/{owner}/{repo}/dependabot/secrets/public-key': { /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */ - readonly get: operations["dependabot/get-repo-public-key"]; - }; - readonly "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}": { + readonly get: operations['dependabot/get-repo-public-key'] + } + readonly '/repos/{owner}/{repo}/dependabot/secrets/{secret_name}': { /** Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */ - readonly get: operations["dependabot/get-repo-secret"]; + readonly get: operations['dependabot/get-repo-secret'] /** * Creates or updates a repository secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -3459,13 +3459,13 @@ export interface paths { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - readonly put: operations["dependabot/create-or-update-repo-secret"]; + readonly put: operations['dependabot/create-or-update-repo-secret'] /** Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */ - readonly delete: operations["dependabot/delete-repo-secret"]; - }; - readonly "/repos/{owner}/{repo}/deployments": { + readonly delete: operations['dependabot/delete-repo-secret'] + } + readonly '/repos/{owner}/{repo}/deployments': { /** Simple filtering of deployments is available via query parameters: */ - readonly get: operations["repos/list-deployments"]; + readonly get: operations['repos/list-deployments'] /** * Deployments offer a few configurable parameters with certain defaults. * @@ -3513,10 +3513,10 @@ export interface paths { * This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` * status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. */ - readonly post: operations["repos/create-deployment"]; - }; - readonly "/repos/{owner}/{repo}/deployments/{deployment_id}": { - readonly get: operations["repos/get-deployment"]; + readonly post: operations['repos/create-deployment'] + } + readonly '/repos/{owner}/{repo}/deployments/{deployment_id}': { + readonly get: operations['repos/get-deployment'] /** * If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. Anyone with `repo` or `repo_deployment` scopes can delete a deployment. * @@ -3527,23 +3527,23 @@ export interface paths { * * For more information, see "[Create a deployment](https://docs.github.com/rest/reference/repos/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/reference/repos#create-a-deployment-status)." */ - readonly delete: operations["repos/delete-deployment"]; - }; - readonly "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses": { + readonly delete: operations['repos/delete-deployment'] + } + readonly '/repos/{owner}/{repo}/deployments/{deployment_id}/statuses': { /** Users with pull access can view deployment statuses for a deployment: */ - readonly get: operations["repos/list-deployment-statuses"]; + readonly get: operations['repos/list-deployment-statuses'] /** * Users with `push` access can create deployment statuses for a given deployment. * * GitHub Apps require `read & write` access to "Deployments" and `read-only` access to "Repo contents" (for private repos). OAuth Apps require the `repo_deployment` scope. */ - readonly post: operations["repos/create-deployment-status"]; - }; - readonly "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}": { + readonly post: operations['repos/create-deployment-status'] + } + readonly '/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}': { /** Users with pull access can view a deployment status for a deployment: */ - readonly get: operations["repos/get-deployment-status"]; - }; - readonly "/repos/{owner}/{repo}/dispatches": { + readonly get: operations['repos/get-deployment-status'] + } + readonly '/repos/{owner}/{repo}/dispatches': { /** * You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/webhooks/event-payloads/#repository_dispatch)." * @@ -3556,19 +3556,19 @@ export interface paths { * * This input example shows how you can use the `client_payload` as a test to debug your workflow. */ - readonly post: operations["repos/create-dispatch-event"]; - }; - readonly "/repos/{owner}/{repo}/environments": { + readonly post: operations['repos/create-dispatch-event'] + } + readonly '/repos/{owner}/{repo}/environments': { /** * Get all environments for a repository. * * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - readonly get: operations["repos/get-all-environments"]; - }; - readonly "/repos/{owner}/{repo}/environments/{environment_name}": { + readonly get: operations['repos/get-all-environments'] + } + readonly '/repos/{owner}/{repo}/environments/{environment_name}': { /** Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - readonly get: operations["repos/get-environment"]; + readonly get: operations['repos/get-environment'] /** * Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)." * @@ -3578,34 +3578,34 @@ export interface paths { * * You must authenticate using an access token with the repo scope to use this endpoint. */ - readonly put: operations["repos/create-or-update-environment"]; + readonly put: operations['repos/create-or-update-environment'] /** You must authenticate using an access token with the repo scope to use this endpoint. */ - readonly delete: operations["repos/delete-an-environment"]; - }; - readonly "/repos/{owner}/{repo}/events": { - readonly get: operations["activity/list-repo-events"]; - }; - readonly "/repos/{owner}/{repo}/forks": { - readonly get: operations["repos/list-forks"]; + readonly delete: operations['repos/delete-an-environment'] + } + readonly '/repos/{owner}/{repo}/events': { + readonly get: operations['activity/list-repo-events'] + } + readonly '/repos/{owner}/{repo}/forks': { + readonly get: operations['repos/list-forks'] /** * Create a fork for the authenticated user. * * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). */ - readonly post: operations["repos/create-fork"]; - }; - readonly "/repos/{owner}/{repo}/git/blobs": { - readonly post: operations["git/create-blob"]; - }; - readonly "/repos/{owner}/{repo}/git/blobs/{file_sha}": { + readonly post: operations['repos/create-fork'] + } + readonly '/repos/{owner}/{repo}/git/blobs': { + readonly post: operations['git/create-blob'] + } + readonly '/repos/{owner}/{repo}/git/blobs/{file_sha}': { /** * The `content` in the response will always be Base64 encoded. * * _Note_: This API supports blobs up to 100 megabytes in size. */ - readonly get: operations["git/get-blob"]; - }; - readonly "/repos/{owner}/{repo}/git/commits": { + readonly get: operations['git/get-blob'] + } + readonly '/repos/{owner}/{repo}/git/commits': { /** * Creates a new Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects). * @@ -3638,9 +3638,9 @@ export interface paths { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - readonly post: operations["git/create-commit"]; - }; - readonly "/repos/{owner}/{repo}/git/commits/{commit_sha}": { + readonly post: operations['git/create-commit'] + } + readonly '/repos/{owner}/{repo}/git/commits/{commit_sha}': { /** * Gets a Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects). * @@ -3673,9 +3673,9 @@ export interface paths { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - readonly get: operations["git/get-commit"]; - }; - readonly "/repos/{owner}/{repo}/git/matching-refs/{ref}": { + readonly get: operations['git/get-commit'] + } + readonly '/repos/{owner}/{repo}/git/matching-refs/{ref}': { /** * Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array. * @@ -3685,25 +3685,25 @@ export interface paths { * * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. */ - readonly get: operations["git/list-matching-refs"]; - }; - readonly "/repos/{owner}/{repo}/git/ref/{ref}": { + readonly get: operations['git/list-matching-refs'] + } + readonly '/repos/{owner}/{repo}/git/ref/{ref}': { /** * Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. * * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". */ - readonly get: operations["git/get-ref"]; - }; - readonly "/repos/{owner}/{repo}/git/refs": { + readonly get: operations['git/get-ref'] + } + readonly '/repos/{owner}/{repo}/git/refs': { /** Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches. */ - readonly post: operations["git/create-ref"]; - }; - readonly "/repos/{owner}/{repo}/git/refs/{ref}": { - readonly delete: operations["git/delete-ref"]; - readonly patch: operations["git/update-ref"]; - }; - readonly "/repos/{owner}/{repo}/git/tags": { + readonly post: operations['git/create-ref'] + } + readonly '/repos/{owner}/{repo}/git/refs/{ref}': { + readonly delete: operations['git/delete-ref'] + readonly patch: operations['git/update-ref'] + } + readonly '/repos/{owner}/{repo}/git/tags': { /** * Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/rest/reference/git#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/rest/reference/git#create-a-reference) the tag reference - this call would be unnecessary. * @@ -3736,9 +3736,9 @@ export interface paths { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - readonly post: operations["git/create-tag"]; - }; - readonly "/repos/{owner}/{repo}/git/tags/{tag_sha}": { + readonly post: operations['git/create-tag'] + } + readonly '/repos/{owner}/{repo}/git/tags/{tag_sha}': { /** * **Signature verification object** * @@ -3769,78 +3769,78 @@ export interface paths { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - readonly get: operations["git/get-tag"]; - }; - readonly "/repos/{owner}/{repo}/git/trees": { + readonly get: operations['git/get-tag'] + } + readonly '/repos/{owner}/{repo}/git/trees': { /** * The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure. * * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/rest/reference/git#create-a-commit)" and "[Update a reference](https://docs.github.com/rest/reference/git#update-a-reference)." */ - readonly post: operations["git/create-tree"]; - }; - readonly "/repos/{owner}/{repo}/git/trees/{tree_sha}": { + readonly post: operations['git/create-tree'] + } + readonly '/repos/{owner}/{repo}/git/trees/{tree_sha}': { /** * Returns a single tree using the SHA1 value for that tree. * * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. */ - readonly get: operations["git/get-tree"]; - }; - readonly "/repos/{owner}/{repo}/hooks": { - readonly get: operations["repos/list-webhooks"]; + readonly get: operations['git/get-tree'] + } + readonly '/repos/{owner}/{repo}/hooks': { + readonly get: operations['repos/list-webhooks'] /** * Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can * share the same `config` as long as those webhooks do not have any `events` that overlap. */ - readonly post: operations["repos/create-webhook"]; - }; - readonly "/repos/{owner}/{repo}/hooks/{hook_id}": { + readonly post: operations['repos/create-webhook'] + } + readonly '/repos/{owner}/{repo}/hooks/{hook_id}': { /** Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/reference/repos#get-a-webhook-configuration-for-a-repository)." */ - readonly get: operations["repos/get-webhook"]; - readonly delete: operations["repos/delete-webhook"]; + readonly get: operations['repos/get-webhook'] + readonly delete: operations['repos/delete-webhook'] /** Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/reference/repos#update-a-webhook-configuration-for-a-repository)." */ - readonly patch: operations["repos/update-webhook"]; - }; - readonly "/repos/{owner}/{repo}/hooks/{hook_id}/config": { + readonly patch: operations['repos/update-webhook'] + } + readonly '/repos/{owner}/{repo}/hooks/{hook_id}/config': { /** * Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/reference/orgs#get-a-repository-webhook)." * * Access tokens must have the `read:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:read` permission. */ - readonly get: operations["repos/get-webhook-config-for-repo"]; + readonly get: operations['repos/get-webhook-config-for-repo'] /** * Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/reference/orgs#update-a-repository-webhook)." * * Access tokens must have the `write:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:write` permission. */ - readonly patch: operations["repos/update-webhook-config-for-repo"]; - }; - readonly "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries": { + readonly patch: operations['repos/update-webhook-config-for-repo'] + } + readonly '/repos/{owner}/{repo}/hooks/{hook_id}/deliveries': { /** Returns a list of webhook deliveries for a webhook configured in a repository. */ - readonly get: operations["repos/list-webhook-deliveries"]; - }; - readonly "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}": { + readonly get: operations['repos/list-webhook-deliveries'] + } + readonly '/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}': { /** Returns a delivery for a webhook configured in a repository. */ - readonly get: operations["repos/get-webhook-delivery"]; - }; - readonly "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { + readonly get: operations['repos/get-webhook-delivery'] + } + readonly '/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts': { /** Redeliver a webhook delivery for a webhook configured in a repository. */ - readonly post: operations["repos/redeliver-webhook-delivery"]; - }; - readonly "/repos/{owner}/{repo}/hooks/{hook_id}/pings": { + readonly post: operations['repos/redeliver-webhook-delivery'] + } + readonly '/repos/{owner}/{repo}/hooks/{hook_id}/pings': { /** This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. */ - readonly post: operations["repos/ping-webhook"]; - }; - readonly "/repos/{owner}/{repo}/hooks/{hook_id}/tests": { + readonly post: operations['repos/ping-webhook'] + } + readonly '/repos/{owner}/{repo}/hooks/{hook_id}/tests': { /** * This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. * * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` */ - readonly post: operations["repos/test-push-webhook"]; - }; - readonly "/repos/{owner}/{repo}/import": { + readonly post: operations['repos/test-push-webhook'] + } + readonly '/repos/{owner}/{repo}/import': { /** * View the progress of an import. * @@ -3877,62 +3877,62 @@ export interface paths { * * `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository. * * `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a "Get Large Files" request. */ - readonly get: operations["migrations/get-import-status"]; + readonly get: operations['migrations/get-import-status'] /** Start a source import to a GitHub repository using GitHub Importer. */ - readonly put: operations["migrations/start-import"]; + readonly put: operations['migrations/start-import'] /** Stop an import for a repository. */ - readonly delete: operations["migrations/cancel-import"]; + readonly delete: operations['migrations/cancel-import'] /** * An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API * request. If no parameters are provided, the import will be restarted. */ - readonly patch: operations["migrations/update-import"]; - }; - readonly "/repos/{owner}/{repo}/import/authors": { + readonly patch: operations['migrations/update-import'] + } + readonly '/repos/{owner}/{repo}/import/authors': { /** * Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `. * * This endpoint and the [Map a commit author](https://docs.github.com/rest/reference/migrations#map-a-commit-author) endpoint allow you to provide correct Git author information. */ - readonly get: operations["migrations/get-commit-authors"]; - }; - readonly "/repos/{owner}/{repo}/import/authors/{author_id}": { + readonly get: operations['migrations/get-commit-authors'] + } + readonly '/repos/{owner}/{repo}/import/authors/{author_id}': { /** Update an author's identity for the import. Your application can continue updating authors any time before you push new commits to the repository. */ - readonly patch: operations["migrations/map-commit-author"]; - }; - readonly "/repos/{owner}/{repo}/import/large_files": { + readonly patch: operations['migrations/map-commit-author'] + } + readonly '/repos/{owner}/{repo}/import/large_files': { /** List files larger than 100MB found during the import */ - readonly get: operations["migrations/get-large-files"]; - }; - readonly "/repos/{owner}/{repo}/import/lfs": { + readonly get: operations['migrations/get-large-files'] + } + readonly '/repos/{owner}/{repo}/import/lfs': { /** You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability is powered by [Git LFS](https://git-lfs.github.com). You can learn more about our LFS feature and working with large files [on our help site](https://docs.github.com/articles/versioning-large-files/). */ - readonly patch: operations["migrations/set-lfs-preference"]; - }; - readonly "/repos/{owner}/{repo}/installation": { + readonly patch: operations['migrations/set-lfs-preference'] + } + readonly '/repos/{owner}/{repo}/installation': { /** * Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly get: operations["apps/get-repo-installation"]; - }; - readonly "/repos/{owner}/{repo}/interaction-limits": { + readonly get: operations['apps/get-repo-installation'] + } + readonly '/repos/{owner}/{repo}/interaction-limits': { /** Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response. */ - readonly get: operations["interactions/get-restrictions-for-repo"]; + readonly get: operations['interactions/get-restrictions-for-repo'] /** Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. */ - readonly put: operations["interactions/set-restrictions-for-repo"]; + readonly put: operations['interactions/set-restrictions-for-repo'] /** Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. */ - readonly delete: operations["interactions/remove-restrictions-for-repo"]; - }; - readonly "/repos/{owner}/{repo}/invitations": { + readonly delete: operations['interactions/remove-restrictions-for-repo'] + } + readonly '/repos/{owner}/{repo}/invitations': { /** When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations. */ - readonly get: operations["repos/list-invitations"]; - }; - readonly "/repos/{owner}/{repo}/invitations/{invitation_id}": { - readonly delete: operations["repos/delete-invitation"]; - readonly patch: operations["repos/update-invitation"]; - }; - readonly "/repos/{owner}/{repo}/issues": { + readonly get: operations['repos/list-invitations'] + } + readonly '/repos/{owner}/{repo}/invitations/{invitation_id}': { + readonly delete: operations['repos/delete-invitation'] + readonly patch: operations['repos/update-invitation'] + } + readonly '/repos/{owner}/{repo}/issues': { /** * List issues in a repository. * @@ -3941,44 +3941,44 @@ export interface paths { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - readonly get: operations["issues/list-for-repo"]; + readonly get: operations['issues/list-for-repo'] /** * Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - readonly post: operations["issues/create"]; - }; - readonly "/repos/{owner}/{repo}/issues/comments": { + readonly post: operations['issues/create'] + } + readonly '/repos/{owner}/{repo}/issues/comments': { /** By default, Issue Comments are ordered by ascending ID. */ - readonly get: operations["issues/list-comments-for-repo"]; - }; - readonly "/repos/{owner}/{repo}/issues/comments/{comment_id}": { - readonly get: operations["issues/get-comment"]; - readonly delete: operations["issues/delete-comment"]; - readonly patch: operations["issues/update-comment"]; - }; - readonly "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": { + readonly get: operations['issues/list-comments-for-repo'] + } + readonly '/repos/{owner}/{repo}/issues/comments/{comment_id}': { + readonly get: operations['issues/get-comment'] + readonly delete: operations['issues/delete-comment'] + readonly patch: operations['issues/update-comment'] + } + readonly '/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions': { /** List the reactions to an [issue comment](https://docs.github.com/rest/reference/issues#comments). */ - readonly get: operations["reactions/list-for-issue-comment"]; + readonly get: operations['reactions/list-for-issue-comment'] /** Create a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. */ - readonly post: operations["reactions/create-for-issue-comment"]; - }; - readonly "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}": { + readonly post: operations['reactions/create-for-issue-comment'] + } + readonly '/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}': { /** * **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. * * Delete a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). */ - readonly delete: operations["reactions/delete-for-issue-comment"]; - }; - readonly "/repos/{owner}/{repo}/issues/events": { - readonly get: operations["issues/list-events-for-repo"]; - }; - readonly "/repos/{owner}/{repo}/issues/events/{event_id}": { - readonly get: operations["issues/get-event"]; - }; - readonly "/repos/{owner}/{repo}/issues/{issue_number}": { + readonly delete: operations['reactions/delete-for-issue-comment'] + } + readonly '/repos/{owner}/{repo}/issues/events': { + readonly get: operations['issues/list-events-for-repo'] + } + readonly '/repos/{owner}/{repo}/issues/events/{event_id}': { + readonly get: operations['issues/get-event'] + } + readonly '/repos/{owner}/{repo}/issues/{issue_number}': { /** * The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was * [transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If @@ -3992,147 +3992,147 @@ export interface paths { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - readonly get: operations["issues/get"]; + readonly get: operations['issues/get'] /** Issue owners and users with push access can edit an issue. */ - readonly patch: operations["issues/update"]; - }; - readonly "/repos/{owner}/{repo}/issues/{issue_number}/assignees": { + readonly patch: operations['issues/update'] + } + readonly '/repos/{owner}/{repo}/issues/{issue_number}/assignees': { /** Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced. */ - readonly post: operations["issues/add-assignees"]; + readonly post: operations['issues/add-assignees'] /** Removes one or more assignees from an issue. */ - readonly delete: operations["issues/remove-assignees"]; - }; - readonly "/repos/{owner}/{repo}/issues/{issue_number}/comments": { + readonly delete: operations['issues/remove-assignees'] + } + readonly '/repos/{owner}/{repo}/issues/{issue_number}/comments': { /** Issue Comments are ordered by ascending ID. */ - readonly get: operations["issues/list-comments"]; + readonly get: operations['issues/list-comments'] /** This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - readonly post: operations["issues/create-comment"]; - }; - readonly "/repos/{owner}/{repo}/issues/{issue_number}/events": { - readonly get: operations["issues/list-events"]; - }; - readonly "/repos/{owner}/{repo}/issues/{issue_number}/labels": { - readonly get: operations["issues/list-labels-on-issue"]; + readonly post: operations['issues/create-comment'] + } + readonly '/repos/{owner}/{repo}/issues/{issue_number}/events': { + readonly get: operations['issues/list-events'] + } + readonly '/repos/{owner}/{repo}/issues/{issue_number}/labels': { + readonly get: operations['issues/list-labels-on-issue'] /** Removes any previous labels and sets the new labels for an issue. */ - readonly put: operations["issues/set-labels"]; - readonly post: operations["issues/add-labels"]; - readonly delete: operations["issues/remove-all-labels"]; - }; - readonly "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}": { + readonly put: operations['issues/set-labels'] + readonly post: operations['issues/add-labels'] + readonly delete: operations['issues/remove-all-labels'] + } + readonly '/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}': { /** Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist. */ - readonly delete: operations["issues/remove-label"]; - }; - readonly "/repos/{owner}/{repo}/issues/{issue_number}/lock": { + readonly delete: operations['issues/remove-label'] + } + readonly '/repos/{owner}/{repo}/issues/{issue_number}/lock': { /** * Users with push access can lock an issue or pull request's conversation. * * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - readonly put: operations["issues/lock"]; + readonly put: operations['issues/lock'] /** Users with push access can unlock an issue's conversation. */ - readonly delete: operations["issues/unlock"]; - }; - readonly "/repos/{owner}/{repo}/issues/{issue_number}/reactions": { + readonly delete: operations['issues/unlock'] + } + readonly '/repos/{owner}/{repo}/issues/{issue_number}/reactions': { /** List the reactions to an [issue](https://docs.github.com/rest/reference/issues). */ - readonly get: operations["reactions/list-for-issue"]; + readonly get: operations['reactions/list-for-issue'] /** Create a reaction to an [issue](https://docs.github.com/rest/reference/issues/). A response with an HTTP `200` status means that you already added the reaction type to this issue. */ - readonly post: operations["reactions/create-for-issue"]; - }; - readonly "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}": { + readonly post: operations['reactions/create-for-issue'] + } + readonly '/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}': { /** * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. * * Delete a reaction to an [issue](https://docs.github.com/rest/reference/issues/). */ - readonly delete: operations["reactions/delete-for-issue"]; - }; - readonly "/repos/{owner}/{repo}/issues/{issue_number}/timeline": { - readonly get: operations["issues/list-events-for-timeline"]; - }; - readonly "/repos/{owner}/{repo}/keys": { - readonly get: operations["repos/list-deploy-keys"]; + readonly delete: operations['reactions/delete-for-issue'] + } + readonly '/repos/{owner}/{repo}/issues/{issue_number}/timeline': { + readonly get: operations['issues/list-events-for-timeline'] + } + readonly '/repos/{owner}/{repo}/keys': { + readonly get: operations['repos/list-deploy-keys'] /** You can create a read-only deploy key. */ - readonly post: operations["repos/create-deploy-key"]; - }; - readonly "/repos/{owner}/{repo}/keys/{key_id}": { - readonly get: operations["repos/get-deploy-key"]; + readonly post: operations['repos/create-deploy-key'] + } + readonly '/repos/{owner}/{repo}/keys/{key_id}': { + readonly get: operations['repos/get-deploy-key'] /** Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead. */ - readonly delete: operations["repos/delete-deploy-key"]; - }; - readonly "/repos/{owner}/{repo}/labels": { - readonly get: operations["issues/list-labels-for-repo"]; - readonly post: operations["issues/create-label"]; - }; - readonly "/repos/{owner}/{repo}/labels/{name}": { - readonly get: operations["issues/get-label"]; - readonly delete: operations["issues/delete-label"]; - readonly patch: operations["issues/update-label"]; - }; - readonly "/repos/{owner}/{repo}/languages": { + readonly delete: operations['repos/delete-deploy-key'] + } + readonly '/repos/{owner}/{repo}/labels': { + readonly get: operations['issues/list-labels-for-repo'] + readonly post: operations['issues/create-label'] + } + readonly '/repos/{owner}/{repo}/labels/{name}': { + readonly get: operations['issues/get-label'] + readonly delete: operations['issues/delete-label'] + readonly patch: operations['issues/update-label'] + } + readonly '/repos/{owner}/{repo}/languages': { /** Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language. */ - readonly get: operations["repos/list-languages"]; - }; - readonly "/repos/{owner}/{repo}/lfs": { - readonly put: operations["repos/enable-lfs-for-repo"]; - readonly delete: operations["repos/disable-lfs-for-repo"]; - }; - readonly "/repos/{owner}/{repo}/license": { + readonly get: operations['repos/list-languages'] + } + readonly '/repos/{owner}/{repo}/lfs': { + readonly put: operations['repos/enable-lfs-for-repo'] + readonly delete: operations['repos/disable-lfs-for-repo'] + } + readonly '/repos/{owner}/{repo}/license': { /** * This method returns the contents of the repository's license file, if one is detected. * * Similar to [Get repository content](https://docs.github.com/rest/reference/repos#get-repository-content), this method also supports [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw license content or rendered license HTML. */ - readonly get: operations["licenses/get-for-repo"]; - }; - readonly "/repos/{owner}/{repo}/merge-upstream": { + readonly get: operations['licenses/get-for-repo'] + } + readonly '/repos/{owner}/{repo}/merge-upstream': { /** Sync a branch of a forked repository to keep it up-to-date with the upstream repository. */ - readonly post: operations["repos/merge-upstream"]; - }; - readonly "/repos/{owner}/{repo}/merges": { - readonly post: operations["repos/merge"]; - }; - readonly "/repos/{owner}/{repo}/milestones": { - readonly get: operations["issues/list-milestones"]; - readonly post: operations["issues/create-milestone"]; - }; - readonly "/repos/{owner}/{repo}/milestones/{milestone_number}": { - readonly get: operations["issues/get-milestone"]; - readonly delete: operations["issues/delete-milestone"]; - readonly patch: operations["issues/update-milestone"]; - }; - readonly "/repos/{owner}/{repo}/milestones/{milestone_number}/labels": { - readonly get: operations["issues/list-labels-for-milestone"]; - }; - readonly "/repos/{owner}/{repo}/notifications": { + readonly post: operations['repos/merge-upstream'] + } + readonly '/repos/{owner}/{repo}/merges': { + readonly post: operations['repos/merge'] + } + readonly '/repos/{owner}/{repo}/milestones': { + readonly get: operations['issues/list-milestones'] + readonly post: operations['issues/create-milestone'] + } + readonly '/repos/{owner}/{repo}/milestones/{milestone_number}': { + readonly get: operations['issues/get-milestone'] + readonly delete: operations['issues/delete-milestone'] + readonly patch: operations['issues/update-milestone'] + } + readonly '/repos/{owner}/{repo}/milestones/{milestone_number}/labels': { + readonly get: operations['issues/list-labels-for-milestone'] + } + readonly '/repos/{owner}/{repo}/notifications': { /** List all notifications for the current user. */ - readonly get: operations["activity/list-repo-notifications-for-authenticated-user"]; + readonly get: operations['activity/list-repo-notifications-for-authenticated-user'] /** Marks all notifications in a repository as "read" removes them from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ - readonly put: operations["activity/mark-repo-notifications-as-read"]; - }; - readonly "/repos/{owner}/{repo}/pages": { - readonly get: operations["repos/get-pages"]; + readonly put: operations['activity/mark-repo-notifications-as-read'] + } + readonly '/repos/{owner}/{repo}/pages': { + readonly get: operations['repos/get-pages'] /** Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). */ - readonly put: operations["repos/update-information-about-pages-site"]; + readonly put: operations['repos/update-information-about-pages-site'] /** Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)." */ - readonly post: operations["repos/create-pages-site"]; - readonly delete: operations["repos/delete-pages-site"]; - }; - readonly "/repos/{owner}/{repo}/pages/builds": { - readonly get: operations["repos/list-pages-builds"]; + readonly post: operations['repos/create-pages-site'] + readonly delete: operations['repos/delete-pages-site'] + } + readonly '/repos/{owner}/{repo}/pages/builds': { + readonly get: operations['repos/list-pages-builds'] /** * You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures. * * Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes. */ - readonly post: operations["repos/request-pages-build"]; - }; - readonly "/repos/{owner}/{repo}/pages/builds/latest": { - readonly get: operations["repos/get-latest-pages-build"]; - }; - readonly "/repos/{owner}/{repo}/pages/builds/{build_id}": { - readonly get: operations["repos/get-pages-build"]; - }; - readonly "/repos/{owner}/{repo}/pages/health": { + readonly post: operations['repos/request-pages-build'] + } + readonly '/repos/{owner}/{repo}/pages/builds/latest': { + readonly get: operations['repos/get-latest-pages-build'] + } + readonly '/repos/{owner}/{repo}/pages/builds/{build_id}': { + readonly get: operations['repos/get-pages-build'] + } + readonly '/repos/{owner}/{repo}/pages/health': { /** * Gets a health check of the DNS settings for the `CNAME` record configured for a repository's GitHub Pages. * @@ -4140,17 +4140,17 @@ export interface paths { * * Users must have admin or owner permissions. GitHub Apps must have the `pages:write` and `administration:write` permission to use this endpoint. */ - readonly get: operations["repos/get-pages-health-check"]; - }; - readonly "/repos/{owner}/{repo}/projects": { + readonly get: operations['repos/get-pages-health-check'] + } + readonly '/repos/{owner}/{repo}/projects': { /** Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - readonly get: operations["projects/list-for-repo"]; + readonly get: operations['projects/list-for-repo'] /** Creates a repository project board. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - readonly post: operations["projects/create-for-repo"]; - }; - readonly "/repos/{owner}/{repo}/pulls": { + readonly post: operations['projects/create-for-repo'] + } + readonly '/repos/{owner}/{repo}/pulls': { /** Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly get: operations["pulls/list"]; + readonly get: operations['pulls/list'] /** * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -4160,35 +4160,35 @@ export interface paths { * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. */ - readonly post: operations["pulls/create"]; - }; - readonly "/repos/{owner}/{repo}/pulls/comments": { + readonly post: operations['pulls/create'] + } + readonly '/repos/{owner}/{repo}/pulls/comments': { /** Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID. */ - readonly get: operations["pulls/list-review-comments-for-repo"]; - }; - readonly "/repos/{owner}/{repo}/pulls/comments/{comment_id}": { + readonly get: operations['pulls/list-review-comments-for-repo'] + } + readonly '/repos/{owner}/{repo}/pulls/comments/{comment_id}': { /** Provides details for a review comment. */ - readonly get: operations["pulls/get-review-comment"]; + readonly get: operations['pulls/get-review-comment'] /** Deletes a review comment. */ - readonly delete: operations["pulls/delete-review-comment"]; + readonly delete: operations['pulls/delete-review-comment'] /** Enables you to edit a review comment. */ - readonly patch: operations["pulls/update-review-comment"]; - }; - readonly "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": { + readonly patch: operations['pulls/update-review-comment'] + } + readonly '/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions': { /** List the reactions to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). */ - readonly get: operations["reactions/list-for-pull-request-review-comment"]; + readonly get: operations['reactions/list-for-pull-request-review-comment'] /** Create a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#comments). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. */ - readonly post: operations["reactions/create-for-pull-request-review-comment"]; - }; - readonly "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}": { + readonly post: operations['reactions/create-for-pull-request-review-comment'] + } + readonly '/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}': { /** * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` * * Delete a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). */ - readonly delete: operations["reactions/delete-for-pull-request-comment"]; - }; - readonly "/repos/{owner}/{repo}/pulls/{pull_number}": { + readonly delete: operations['reactions/delete-for-pull-request-comment'] + } + readonly '/repos/{owner}/{repo}/pulls/{pull_number}': { /** * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -4206,25 +4206,25 @@ export interface paths { * * Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. */ - readonly get: operations["pulls/get"]; + readonly get: operations['pulls/get'] /** * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. */ - readonly patch: operations["pulls/update"]; - }; - readonly "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": { + readonly patch: operations['pulls/update'] + } + readonly '/repos/{owner}/{repo}/pulls/{pull_number}/codespaces': { /** * Creates a codespace owned by the authenticated user for the specified pull request. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - readonly post: operations["codespaces/create-with-pr-for-authenticated-user"]; - }; - readonly "/repos/{owner}/{repo}/pulls/{pull_number}/comments": { + readonly post: operations['codespaces/create-with-pr-for-authenticated-user'] + } + readonly '/repos/{owner}/{repo}/pulls/{pull_number}/comments': { /** Lists all review comments for a pull request. By default, review comments are in ascending order by ID. */ - readonly get: operations["pulls/list-review-comments"]; + readonly get: operations['pulls/list-review-comments'] /** * Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/reference/issues#create-an-issue-comment)." We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff. * @@ -4234,38 +4234,38 @@ export interface paths { * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - readonly post: operations["pulls/create-review-comment"]; - }; - readonly "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies": { + readonly post: operations['pulls/create-review-comment'] + } + readonly '/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies': { /** * Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - readonly post: operations["pulls/create-reply-for-review-comment"]; - }; - readonly "/repos/{owner}/{repo}/pulls/{pull_number}/commits": { + readonly post: operations['pulls/create-reply-for-review-comment'] + } + readonly '/repos/{owner}/{repo}/pulls/{pull_number}/commits': { /** Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/reference/repos#list-commits) endpoint. */ - readonly get: operations["pulls/list-commits"]; - }; - readonly "/repos/{owner}/{repo}/pulls/{pull_number}/files": { + readonly get: operations['pulls/list-commits'] + } + readonly '/repos/{owner}/{repo}/pulls/{pull_number}/files': { /** **Note:** Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. */ - readonly get: operations["pulls/list-files"]; - }; - readonly "/repos/{owner}/{repo}/pulls/{pull_number}/merge": { - readonly get: operations["pulls/check-if-merged"]; + readonly get: operations['pulls/list-files'] + } + readonly '/repos/{owner}/{repo}/pulls/{pull_number}/merge': { + readonly get: operations['pulls/check-if-merged'] /** This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - readonly put: operations["pulls/merge"]; - }; - readonly "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { - readonly get: operations["pulls/list-requested-reviewers"]; + readonly put: operations['pulls/merge'] + } + readonly '/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers': { + readonly get: operations['pulls/list-requested-reviewers'] /** This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - readonly post: operations["pulls/request-reviewers"]; - readonly delete: operations["pulls/remove-requested-reviewers"]; - }; - readonly "/repos/{owner}/{repo}/pulls/{pull_number}/reviews": { + readonly post: operations['pulls/request-reviewers'] + readonly delete: operations['pulls/remove-requested-reviewers'] + } + readonly '/repos/{owner}/{repo}/pulls/{pull_number}/reviews': { /** The list of reviews returns in chronological order. */ - readonly get: operations["pulls/list-reviews"]; + readonly get: operations['pulls/list-reviews'] /** * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. * @@ -4275,92 +4275,92 @@ export interface paths { * * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. */ - readonly post: operations["pulls/create-review"]; - }; - readonly "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}": { - readonly get: operations["pulls/get-review"]; + readonly post: operations['pulls/create-review'] + } + readonly '/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}': { + readonly get: operations['pulls/get-review'] /** Update the review summary comment with new text. */ - readonly put: operations["pulls/update-review"]; - readonly delete: operations["pulls/delete-pending-review"]; - }; - readonly "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments": { + readonly put: operations['pulls/update-review'] + readonly delete: operations['pulls/delete-pending-review'] + } + readonly '/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments': { /** List comments for a specific pull request review. */ - readonly get: operations["pulls/list-comments-for-review"]; - }; - readonly "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals": { + readonly get: operations['pulls/list-comments-for-review'] + } + readonly '/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals': { /** **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/reference/repos#branches), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. */ - readonly put: operations["pulls/dismiss-review"]; - }; - readonly "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events": { - readonly post: operations["pulls/submit-review"]; - }; - readonly "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch": { + readonly put: operations['pulls/dismiss-review'] + } + readonly '/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events': { + readonly post: operations['pulls/submit-review'] + } + readonly '/repos/{owner}/{repo}/pulls/{pull_number}/update-branch': { /** Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. */ - readonly put: operations["pulls/update-branch"]; - }; - readonly "/repos/{owner}/{repo}/readme": { + readonly put: operations['pulls/update-branch'] + } + readonly '/repos/{owner}/{repo}/readme': { /** * Gets the preferred README for a repository. * * READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. */ - readonly get: operations["repos/get-readme"]; - }; - readonly "/repos/{owner}/{repo}/readme/{dir}": { + readonly get: operations['repos/get-readme'] + } + readonly '/repos/{owner}/{repo}/readme/{dir}': { /** * Gets the README from a repository directory. * * READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. */ - readonly get: operations["repos/get-readme-in-directory"]; - }; - readonly "/repos/{owner}/{repo}/releases": { + readonly get: operations['repos/get-readme-in-directory'] + } + readonly '/repos/{owner}/{repo}/releases': { /** * This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/rest/reference/repos#list-repository-tags). * * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. */ - readonly get: operations["repos/list-releases"]; + readonly get: operations['repos/list-releases'] /** * Users with push access to the repository can create a release. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - readonly post: operations["repos/create-release"]; - }; - readonly "/repos/{owner}/{repo}/releases/assets/{asset_id}": { + readonly post: operations['repos/create-release'] + } + readonly '/repos/{owner}/{repo}/releases/assets/{asset_id}': { /** To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. */ - readonly get: operations["repos/get-release-asset"]; - readonly delete: operations["repos/delete-release-asset"]; + readonly get: operations['repos/get-release-asset'] + readonly delete: operations['repos/delete-release-asset'] /** Users with push access to the repository can edit a release asset. */ - readonly patch: operations["repos/update-release-asset"]; - }; - readonly "/repos/{owner}/{repo}/releases/generate-notes": { + readonly patch: operations['repos/update-release-asset'] + } + readonly '/repos/{owner}/{repo}/releases/generate-notes': { /** Generate a name and body describing a [release](https://docs.github.com/rest/reference/repos#releases). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. */ - readonly post: operations["repos/generate-release-notes"]; - }; - readonly "/repos/{owner}/{repo}/releases/latest": { + readonly post: operations['repos/generate-release-notes'] + } + readonly '/repos/{owner}/{repo}/releases/latest': { /** * View the latest published full release for the repository. * * The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published. */ - readonly get: operations["repos/get-latest-release"]; - }; - readonly "/repos/{owner}/{repo}/releases/tags/{tag}": { + readonly get: operations['repos/get-latest-release'] + } + readonly '/repos/{owner}/{repo}/releases/tags/{tag}': { /** Get a published release with the specified tag. */ - readonly get: operations["repos/get-release-by-tag"]; - }; - readonly "/repos/{owner}/{repo}/releases/{release_id}": { + readonly get: operations['repos/get-release-by-tag'] + } + readonly '/repos/{owner}/{repo}/releases/{release_id}': { /** **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia). */ - readonly get: operations["repos/get-release"]; + readonly get: operations['repos/get-release'] /** Users with push access to the repository can delete a release. */ - readonly delete: operations["repos/delete-release"]; + readonly delete: operations['repos/delete-release'] /** Users with push access to the repository can edit a release. */ - readonly patch: operations["repos/update-release"]; - }; - readonly "/repos/{owner}/{repo}/releases/{release_id}/assets": { - readonly get: operations["repos/list-release-assets"]; + readonly patch: operations['repos/update-release'] + } + readonly '/repos/{owner}/{repo}/releases/{release_id}/assets': { + readonly get: operations['repos/list-release-assets'] /** * This endpoint makes use of [a Hypermedia relation](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in * the response of the [Create a release endpoint](https://docs.github.com/rest/reference/repos#create-a-release) to upload a release asset. @@ -4381,59 +4381,59 @@ export interface paths { * endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). * * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. */ - readonly post: operations["repos/upload-release-asset"]; - }; - readonly "/repos/{owner}/{repo}/releases/{release_id}/reactions": { + readonly post: operations['repos/upload-release-asset'] + } + readonly '/repos/{owner}/{repo}/releases/{release_id}/reactions': { /** Create a reaction to a [release](https://docs.github.com/rest/reference/repos#releases). A response with a `Status: 200 OK` means that you already added the reaction type to this release. */ - readonly post: operations["reactions/create-for-release"]; - }; - readonly "/repos/{owner}/{repo}/secret-scanning/alerts": { + readonly post: operations['reactions/create-for-release'] + } + readonly '/repos/{owner}/{repo}/secret-scanning/alerts': { /** * Lists secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. */ - readonly get: operations["secret-scanning/list-alerts-for-repo"]; - }; - readonly "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}": { + readonly get: operations['secret-scanning/list-alerts-for-repo'] + } + readonly '/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}': { /** * Gets a single secret scanning alert detected in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. */ - readonly get: operations["secret-scanning/get-alert"]; + readonly get: operations['secret-scanning/get-alert'] /** * Updates the status of a secret scanning alert in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint. */ - readonly patch: operations["secret-scanning/update-alert"]; - }; - readonly "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations": { + readonly patch: operations['secret-scanning/update-alert'] + } + readonly '/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations': { /** * Lists all locations for a given secret scanning alert for a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. */ - readonly get: operations["secret-scanning/list-locations-for-alert"]; - }; - readonly "/repos/{owner}/{repo}/stargazers": { + readonly get: operations['secret-scanning/list-locations-for-alert'] + } + readonly '/repos/{owner}/{repo}/stargazers': { /** * Lists the people that have starred the repository. * * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: */ - readonly get: operations["activity/list-stargazers-for-repo"]; - }; - readonly "/repos/{owner}/{repo}/stats/code_frequency": { + readonly get: operations['activity/list-stargazers-for-repo'] + } + readonly '/repos/{owner}/{repo}/stats/code_frequency': { /** Returns a weekly aggregate of the number of additions and deletions pushed to a repository. */ - readonly get: operations["repos/get-code-frequency-stats"]; - }; - readonly "/repos/{owner}/{repo}/stats/commit_activity": { + readonly get: operations['repos/get-code-frequency-stats'] + } + readonly '/repos/{owner}/{repo}/stats/commit_activity': { /** Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`. */ - readonly get: operations["repos/get-commit-activity-stats"]; - }; - readonly "/repos/{owner}/{repo}/stats/contributors": { + readonly get: operations['repos/get-commit-activity-stats'] + } + readonly '/repos/{owner}/{repo}/stats/contributors': { /** * Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information: * @@ -4442,17 +4442,17 @@ export interface paths { * * `d` - Number of deletions * * `c` - Number of commits */ - readonly get: operations["repos/get-contributors-stats"]; - }; - readonly "/repos/{owner}/{repo}/stats/participation": { + readonly get: operations['repos/get-contributors-stats'] + } + readonly '/repos/{owner}/{repo}/stats/participation': { /** * Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`. * * The array order is oldest week (index 0) to most recent week. */ - readonly get: operations["repos/get-participation-stats"]; - }; - readonly "/repos/{owner}/{repo}/stats/punch_card": { + readonly get: operations['repos/get-participation-stats'] + } + readonly '/repos/{owner}/{repo}/stats/punch_card': { /** * Each array contains the day number, hour number, and number of commits: * @@ -4462,84 +4462,84 @@ export interface paths { * * For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. */ - readonly get: operations["repos/get-punch-card-stats"]; - }; - readonly "/repos/{owner}/{repo}/statuses/{sha}": { + readonly get: operations['repos/get-punch-card-stats'] + } + readonly '/repos/{owner}/{repo}/statuses/{sha}': { /** * Users with push access in a repository can create commit statuses for a given SHA. * * Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error. */ - readonly post: operations["repos/create-commit-status"]; - }; - readonly "/repos/{owner}/{repo}/subscribers": { + readonly post: operations['repos/create-commit-status'] + } + readonly '/repos/{owner}/{repo}/subscribers': { /** Lists the people watching the specified repository. */ - readonly get: operations["activity/list-watchers-for-repo"]; - }; - readonly "/repos/{owner}/{repo}/subscription": { - readonly get: operations["activity/get-repo-subscription"]; + readonly get: operations['activity/list-watchers-for-repo'] + } + readonly '/repos/{owner}/{repo}/subscription': { + readonly get: operations['activity/get-repo-subscription'] /** If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/rest/reference/activity#delete-a-repository-subscription) completely. */ - readonly put: operations["activity/set-repo-subscription"]; + readonly put: operations['activity/set-repo-subscription'] /** This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/rest/reference/activity#set-a-repository-subscription). */ - readonly delete: operations["activity/delete-repo-subscription"]; - }; - readonly "/repos/{owner}/{repo}/tags": { - readonly get: operations["repos/list-tags"]; - }; - readonly "/repos/{owner}/{repo}/tarball/{ref}": { + readonly delete: operations['activity/delete-repo-subscription'] + } + readonly '/repos/{owner}/{repo}/tags': { + readonly get: operations['repos/list-tags'] + } + readonly '/repos/{owner}/{repo}/tarball/{ref}': { /** * Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually * `master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. * **Note**: For private repositories, these links are temporary and expire after five minutes. */ - readonly get: operations["repos/download-tarball-archive"]; - }; - readonly "/repos/{owner}/{repo}/teams": { - readonly get: operations["repos/list-teams"]; - }; - readonly "/repos/{owner}/{repo}/topics": { - readonly get: operations["repos/get-all-topics"]; - readonly put: operations["repos/replace-all-topics"]; - }; - readonly "/repos/{owner}/{repo}/traffic/clones": { + readonly get: operations['repos/download-tarball-archive'] + } + readonly '/repos/{owner}/{repo}/teams': { + readonly get: operations['repos/list-teams'] + } + readonly '/repos/{owner}/{repo}/topics': { + readonly get: operations['repos/get-all-topics'] + readonly put: operations['repos/replace-all-topics'] + } + readonly '/repos/{owner}/{repo}/traffic/clones': { /** Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. */ - readonly get: operations["repos/get-clones"]; - }; - readonly "/repos/{owner}/{repo}/traffic/popular/paths": { + readonly get: operations['repos/get-clones'] + } + readonly '/repos/{owner}/{repo}/traffic/popular/paths': { /** Get the top 10 popular contents over the last 14 days. */ - readonly get: operations["repos/get-top-paths"]; - }; - readonly "/repos/{owner}/{repo}/traffic/popular/referrers": { + readonly get: operations['repos/get-top-paths'] + } + readonly '/repos/{owner}/{repo}/traffic/popular/referrers': { /** Get the top 10 referrers over the last 14 days. */ - readonly get: operations["repos/get-top-referrers"]; - }; - readonly "/repos/{owner}/{repo}/traffic/views": { + readonly get: operations['repos/get-top-referrers'] + } + readonly '/repos/{owner}/{repo}/traffic/views': { /** Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. */ - readonly get: operations["repos/get-views"]; - }; - readonly "/repos/{owner}/{repo}/transfer": { + readonly get: operations['repos/get-views'] + } + readonly '/repos/{owner}/{repo}/transfer': { /** A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/). */ - readonly post: operations["repos/transfer"]; - }; - readonly "/repos/{owner}/{repo}/vulnerability-alerts": { + readonly post: operations['repos/transfer'] + } + readonly '/repos/{owner}/{repo}/vulnerability-alerts': { /** Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". */ - readonly get: operations["repos/check-vulnerability-alerts"]; + readonly get: operations['repos/check-vulnerability-alerts'] /** Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". */ - readonly put: operations["repos/enable-vulnerability-alerts"]; + readonly put: operations['repos/enable-vulnerability-alerts'] /** Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". */ - readonly delete: operations["repos/disable-vulnerability-alerts"]; - }; - readonly "/repos/{owner}/{repo}/zipball/{ref}": { + readonly delete: operations['repos/disable-vulnerability-alerts'] + } + readonly '/repos/{owner}/{repo}/zipball/{ref}': { /** * Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually * `master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. * **Note**: For private repositories, these links are temporary and expire after five minutes. */ - readonly get: operations["repos/download-zipball-archive"]; - }; - readonly "/repos/{template_owner}/{template_repo}/generate": { + readonly get: operations['repos/download-zipball-archive'] + } + readonly '/repos/{template_owner}/{template_repo}/generate': { /** * Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. * @@ -4550,9 +4550,9 @@ export interface paths { * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. * * `repo` scope to create a private repository */ - readonly post: operations["repos/create-using-template"]; - }; - readonly "/repositories": { + readonly post: operations['repos/create-using-template'] + } + readonly '/repositories': { /** * Lists all public repositories in the order that they were created. * @@ -4560,19 +4560,19 @@ export interface paths { * - For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories. */ - readonly get: operations["repos/list-public"]; - }; - readonly "/repositories/{repository_id}/environments/{environment_name}/secrets": { + readonly get: operations['repos/list-public'] + } + readonly '/repositories/{repository_id}/environments/{environment_name}/secrets': { /** Lists all secrets available in an environment without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - readonly get: operations["actions/list-environment-secrets"]; - }; - readonly "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key": { + readonly get: operations['actions/list-environment-secrets'] + } + readonly '/repositories/{repository_id}/environments/{environment_name}/secrets/public-key': { /** Get the public key for an environment, which you need to encrypt environment secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - readonly get: operations["actions/get-environment-public-key"]; - }; - readonly "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": { + readonly get: operations['actions/get-environment-public-key'] + } + readonly '/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}': { /** Gets a single environment secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - readonly get: operations["actions/get-environment-secret"]; + readonly get: operations['actions/get-environment-secret'] /** * Creates or updates an environment secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -4650,39 +4650,39 @@ export interface paths { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - readonly put: operations["actions/create-or-update-environment-secret"]; + readonly put: operations['actions/create-or-update-environment-secret'] /** Deletes a secret in an environment using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - readonly delete: operations["actions/delete-environment-secret"]; - }; - readonly "/scim/v2/enterprises/{enterprise}/Groups": { + readonly delete: operations['actions/delete-environment-secret'] + } + readonly '/scim/v2/enterprises/{enterprise}/Groups': { /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - readonly get: operations["enterprise-admin/list-provisioned-groups-enterprise"]; + readonly get: operations['enterprise-admin/list-provisioned-groups-enterprise'] /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * * Provision an enterprise group, and invite users to the group. This sends invitation emails to the email address of the invited users to join the GitHub organization that the SCIM group corresponds to. */ - readonly post: operations["enterprise-admin/provision-and-invite-enterprise-group"]; - }; - readonly "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": { + readonly post: operations['enterprise-admin/provision-and-invite-enterprise-group'] + } + readonly '/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}': { /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - readonly get: operations["enterprise-admin/get-provisioning-information-for-enterprise-group"]; + readonly get: operations['enterprise-admin/get-provisioning-information-for-enterprise-group'] /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * * Replaces an existing provisioned group’s information. You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead. */ - readonly put: operations["enterprise-admin/set-information-for-provisioned-enterprise-group"]; + readonly put: operations['enterprise-admin/set-information-for-provisioned-enterprise-group'] /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - readonly delete: operations["enterprise-admin/delete-scim-group-from-enterprise"]; + readonly delete: operations['enterprise-admin/delete-scim-group-from-enterprise'] /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * * Allows you to change a provisioned group’s individual attributes. To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). */ - readonly patch: operations["enterprise-admin/update-attribute-for-enterprise-group"]; - }; - readonly "/scim/v2/enterprises/{enterprise}/Users": { + readonly patch: operations['enterprise-admin/update-attribute-for-enterprise-group'] + } + readonly '/scim/v2/enterprises/{enterprise}/Users': { /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * @@ -4703,7 +4703,7 @@ export interface paths { * - If the user signs in, their GitHub account is linked to this entry. * - If the user does not sign in (or does not create a new account when prompted), they are not added to the GitHub enterprise, and the external identity `null` entry remains in place. */ - readonly get: operations["enterprise-admin/list-provisioned-identities-enterprise"]; + readonly get: operations['enterprise-admin/list-provisioned-identities-enterprise'] /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * @@ -4711,11 +4711,11 @@ export interface paths { * * You can optionally include the groups a user will be invited to join. If you do not provide a list of `groups`, the user is provisioned for the enterprise, but no organization invitation emails will be sent. */ - readonly post: operations["enterprise-admin/provision-and-invite-enterprise-user"]; - }; - readonly "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": { + readonly post: operations['enterprise-admin/provision-and-invite-enterprise-user'] + } + readonly '/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}': { /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - readonly get: operations["enterprise-admin/get-provisioning-information-for-enterprise-user"]; + readonly get: operations['enterprise-admin/get-provisioning-information-for-enterprise-user'] /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * @@ -4725,9 +4725,9 @@ export interface paths { * * **Warning:** Setting `active: false` removes the user from the enterprise, deletes the external identity, and deletes the associated `{scim_user_id}`. */ - readonly put: operations["enterprise-admin/set-information-for-provisioned-enterprise-user"]; + readonly put: operations['enterprise-admin/set-information-for-provisioned-enterprise-user'] /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - readonly delete: operations["enterprise-admin/delete-user-from-enterprise"]; + readonly delete: operations['enterprise-admin/delete-user-from-enterprise'] /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * @@ -4748,9 +4748,9 @@ export interface paths { * } * ``` */ - readonly patch: operations["enterprise-admin/update-attribute-for-enterprise-user"]; - }; - readonly "/scim/v2/organizations/{org}/Users": { + readonly patch: operations['enterprise-admin/update-attribute-for-enterprise-user'] + } + readonly '/scim/v2/organizations/{org}/Users': { /** * Retrieves a paginated list of all provisioned organization members, including pending invitations. If you provide the `filter` parameter, the resources for all matching provisions members are returned. * @@ -4769,12 +4769,12 @@ export interface paths { * - If the user signs in, their GitHub account is linked to this entry. * - If the user does not sign in (or does not create a new account when prompted), they are not added to the GitHub organization, and the external identity `null` entry remains in place. */ - readonly get: operations["scim/list-provisioned-identities"]; + readonly get: operations['scim/list-provisioned-identities'] /** Provision organization membership for a user, and send an activation email to the email address. */ - readonly post: operations["scim/provision-and-invite-user"]; - }; - readonly "/scim/v2/organizations/{org}/Users/{scim_user_id}": { - readonly get: operations["scim/get-provisioning-information-for-user"]; + readonly post: operations['scim/provision-and-invite-user'] + } + readonly '/scim/v2/organizations/{org}/Users/{scim_user_id}': { + readonly get: operations['scim/get-provisioning-information-for-user'] /** * Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](https://docs.github.com/rest/reference/scim#update-an-attribute-for-a-scim-user) endpoint instead. * @@ -4782,8 +4782,8 @@ export interface paths { * * **Warning:** Setting `active: false` removes the user from the organization, deletes the external identity, and deletes the associated `{scim_user_id}`. */ - readonly put: operations["scim/set-information-for-provisioned-user"]; - readonly delete: operations["scim/delete-user-from-org"]; + readonly put: operations['scim/set-information-for-provisioned-user'] + readonly delete: operations['scim/delete-user-from-org'] /** * Allows you to change a provisioned user's individual attributes. To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). * @@ -4802,9 +4802,9 @@ export interface paths { * } * ``` */ - readonly patch: operations["scim/update-attribute-for-user"]; - }; - readonly "/search/code": { + readonly patch: operations['scim/update-attribute-for-user'] + } + readonly '/search/code': { /** * Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -4825,9 +4825,9 @@ export interface paths { * * You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing * language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. */ - readonly get: operations["search/code"]; - }; - readonly "/search/commits": { + readonly get: operations['search/code'] + } + readonly '/search/commits': { /** * Find commits via various criteria on the default branch (usually `master`). This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -4838,9 +4838,9 @@ export interface paths { * * `q=repo:octocat/Spoon-Knife+css` */ - readonly get: operations["search/commits"]; - }; - readonly "/search/issues": { + readonly get: operations['search/commits'] + } + readonly '/search/issues': { /** * Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -4855,9 +4855,9 @@ export interface paths { * * **Note:** For [user-to-server](https://docs.github.com/developers/apps/identifying-and-authorizing-users-for-github-apps#user-to-server-requests) GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." */ - readonly get: operations["search/issues-and-pull-requests"]; - }; - readonly "/search/labels": { + readonly get: operations['search/issues-and-pull-requests'] + } + readonly '/search/labels': { /** * Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -4869,9 +4869,9 @@ export interface paths { * * The labels that best match the query appear first in the search results. */ - readonly get: operations["search/labels"]; - }; - readonly "/search/repositories": { + readonly get: operations['search/labels'] + } + readonly '/search/repositories': { /** * Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -4883,9 +4883,9 @@ export interface paths { * * This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results. */ - readonly get: operations["search/repos"]; - }; - readonly "/search/topics": { + readonly get: operations['search/repos'] + } + readonly '/search/topics': { /** * Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers. * @@ -4897,9 +4897,9 @@ export interface paths { * * This query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results. */ - readonly get: operations["search/topics"]; - }; - readonly "/search/users": { + readonly get: operations['search/topics'] + } + readonly '/search/users': { /** * Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -4911,11 +4911,11 @@ export interface paths { * * This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. */ - readonly get: operations["search/users"]; - }; - readonly "/teams/{team_id}": { + readonly get: operations['search/users'] + } + readonly '/teams/{team_id}': { /** **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/reference/teams#get-a-team-by-name) endpoint. */ - readonly get: operations["teams/get-legacy"]; + readonly get: operations['teams/get-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/reference/teams#delete-a-team) endpoint. * @@ -4923,7 +4923,7 @@ export interface paths { * * If you are an organization owner, deleting a parent team will delete all of its child teams as well. */ - readonly delete: operations["teams/delete-legacy"]; + readonly delete: operations['teams/delete-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/reference/teams#update-a-team) endpoint. * @@ -4931,15 +4931,15 @@ export interface paths { * * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. */ - readonly patch: operations["teams/update-legacy"]; - }; - readonly "/teams/{team_id}/discussions": { + readonly patch: operations['teams/update-legacy'] + } + readonly '/teams/{team_id}/discussions': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/reference/teams#list-discussions) endpoint. * * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - readonly get: operations["teams/list-discussions-legacy"]; + readonly get: operations['teams/list-discussions-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/reference/teams#create-a-discussion) endpoint. * @@ -4947,35 +4947,35 @@ export interface paths { * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - readonly post: operations["teams/create-discussion-legacy"]; - }; - readonly "/teams/{team_id}/discussions/{discussion_number}": { + readonly post: operations['teams/create-discussion-legacy'] + } + readonly '/teams/{team_id}/discussions/{discussion_number}': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/reference/teams#get-a-discussion) endpoint. * * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - readonly get: operations["teams/get-discussion-legacy"]; + readonly get: operations['teams/get-discussion-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/reference/teams#delete-a-discussion) endpoint. * * Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - readonly delete: operations["teams/delete-discussion-legacy"]; + readonly delete: operations['teams/delete-discussion-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/reference/teams#update-a-discussion) endpoint. * * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - readonly patch: operations["teams/update-discussion-legacy"]; - }; - readonly "/teams/{team_id}/discussions/{discussion_number}/comments": { + readonly patch: operations['teams/update-discussion-legacy'] + } + readonly '/teams/{team_id}/discussions/{discussion_number}/comments': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/reference/teams#list-discussion-comments) endpoint. * * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - readonly get: operations["teams/list-discussion-comments-legacy"]; + readonly get: operations['teams/list-discussion-comments-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/reference/teams#create-a-discussion-comment) endpoint. * @@ -4983,73 +4983,73 @@ export interface paths { * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - readonly post: operations["teams/create-discussion-comment-legacy"]; - }; - readonly "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": { + readonly post: operations['teams/create-discussion-comment-legacy'] + } + readonly '/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/reference/teams#get-a-discussion-comment) endpoint. * * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - readonly get: operations["teams/get-discussion-comment-legacy"]; + readonly get: operations['teams/get-discussion-comment-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/reference/teams#delete-a-discussion-comment) endpoint. * * Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - readonly delete: operations["teams/delete-discussion-comment-legacy"]; + readonly delete: operations['teams/delete-discussion-comment-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/reference/teams#update-a-discussion-comment) endpoint. * * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - readonly patch: operations["teams/update-discussion-comment-legacy"]; - }; - readonly "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": { + readonly patch: operations['teams/update-discussion-comment-legacy'] + } + readonly '/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * * List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - readonly get: operations["reactions/list-for-team-discussion-comment-legacy"]; + readonly get: operations['reactions/list-for-team-discussion-comment-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. * * Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. */ - readonly post: operations["reactions/create-for-team-discussion-comment-legacy"]; - }; - readonly "/teams/{team_id}/discussions/{discussion_number}/reactions": { + readonly post: operations['reactions/create-for-team-discussion-comment-legacy'] + } + readonly '/teams/{team_id}/discussions/{discussion_number}/reactions': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion) endpoint. * * List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - readonly get: operations["reactions/list-for-team-discussion-legacy"]; + readonly get: operations['reactions/list-for-team-discussion-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion) endpoint. * * Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. */ - readonly post: operations["reactions/create-for-team-discussion-legacy"]; - }; - readonly "/teams/{team_id}/invitations": { + readonly post: operations['reactions/create-for-team-discussion-legacy'] + } + readonly '/teams/{team_id}/invitations': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/reference/teams#list-pending-team-invitations) endpoint. * * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. */ - readonly get: operations["teams/list-pending-invitations-legacy"]; - }; - readonly "/teams/{team_id}/members": { + readonly get: operations['teams/list-pending-invitations-legacy'] + } + readonly '/teams/{team_id}/members': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/reference/teams#list-team-members) endpoint. * * Team members will include the members of child teams. */ - readonly get: operations["teams/list-members-legacy"]; - }; - readonly "/teams/{team_id}/members/{username}": { + readonly get: operations['teams/list-members-legacy'] + } + readonly '/teams/{team_id}/members/{username}': { /** * The "Get team member" endpoint (described below) is deprecated. * @@ -5057,7 +5057,7 @@ export interface paths { * * To list members in a team, the team must be visible to the authenticated user. */ - readonly get: operations["teams/get-member-legacy"]; + readonly get: operations['teams/get-member-legacy'] /** * The "Add team member" endpoint (described below) is deprecated. * @@ -5071,7 +5071,7 @@ export interface paths { * * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - readonly put: operations["teams/add-member-legacy"]; + readonly put: operations['teams/add-member-legacy'] /** * The "Remove team member" endpoint (described below) is deprecated. * @@ -5083,9 +5083,9 @@ export interface paths { * * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ - readonly delete: operations["teams/remove-member-legacy"]; - }; - readonly "/teams/{team_id}/memberships/{username}": { + readonly delete: operations['teams/remove-member-legacy'] + } + readonly '/teams/{team_id}/memberships/{username}': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/reference/teams#get-team-membership-for-a-user) endpoint. * @@ -5098,7 +5098,7 @@ export interface paths { * * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team). */ - readonly get: operations["teams/get-membership-for-user-legacy"]; + readonly get: operations['teams/get-membership-for-user-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint. * @@ -5112,7 +5112,7 @@ export interface paths { * * If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. */ - readonly put: operations["teams/add-or-update-membership-for-user-legacy"]; + readonly put: operations['teams/add-or-update-membership-for-user-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/reference/teams#remove-team-membership-for-a-user) endpoint. * @@ -5122,41 +5122,41 @@ export interface paths { * * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ - readonly delete: operations["teams/remove-membership-for-user-legacy"]; - }; - readonly "/teams/{team_id}/projects": { + readonly delete: operations['teams/remove-membership-for-user-legacy'] + } + readonly '/teams/{team_id}/projects': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/reference/teams#list-team-projects) endpoint. * * Lists the organization projects for a team. */ - readonly get: operations["teams/list-projects-legacy"]; - }; - readonly "/teams/{team_id}/projects/{project_id}": { + readonly get: operations['teams/list-projects-legacy'] + } + readonly '/teams/{team_id}/projects/{project_id}': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/reference/teams#check-team-permissions-for-a-project) endpoint. * * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. */ - readonly get: operations["teams/check-permissions-for-project-legacy"]; + readonly get: operations['teams/check-permissions-for-project-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/reference/teams#add-or-update-team-project-permissions) endpoint. * * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. */ - readonly put: operations["teams/add-or-update-project-permissions-legacy"]; + readonly put: operations['teams/add-or-update-project-permissions-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/reference/teams#remove-a-project-from-a-team) endpoint. * * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. */ - readonly delete: operations["teams/remove-project-legacy"]; - }; - readonly "/teams/{team_id}/repos": { + readonly delete: operations['teams/remove-project-legacy'] + } + readonly '/teams/{team_id}/repos': { /** **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/reference/teams#list-team-repositories) endpoint. */ - readonly get: operations["teams/list-repos-legacy"]; - }; - readonly "/teams/{team_id}/repos/{owner}/{repo}": { + readonly get: operations['teams/list-repos-legacy'] + } + readonly '/teams/{team_id}/repos/{owner}/{repo}': { /** * **Note**: Repositories inherited through a parent team will also be checked. * @@ -5164,7 +5164,7 @@ export interface paths { * * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: */ - readonly get: operations["teams/check-permissions-for-repo-legacy"]; + readonly get: operations['teams/check-permissions-for-repo-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/reference/teams#add-or-update-team-repository-permissions)" endpoint. * @@ -5172,15 +5172,15 @@ export interface paths { * * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - readonly put: operations["teams/add-or-update-repo-permissions-legacy"]; + readonly put: operations['teams/add-or-update-repo-permissions-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/reference/teams#remove-a-repository-from-a-team) endpoint. * * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. */ - readonly delete: operations["teams/remove-repo-legacy"]; - }; - readonly "/teams/{team_id}/team-sync/group-mappings": { + readonly delete: operations['teams/remove-repo-legacy'] + } + readonly '/teams/{team_id}/team-sync/group-mappings': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List IdP groups for a team`](https://docs.github.com/rest/reference/teams#list-idp-groups-for-a-team) endpoint. * @@ -5188,7 +5188,7 @@ export interface paths { * * List IdP groups connected to a team on GitHub. */ - readonly get: operations["teams/list-idp-groups-for-legacy"]; + readonly get: operations['teams/list-idp-groups-for-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create or update IdP group connections`](https://docs.github.com/rest/reference/teams#create-or-update-idp-group-connections) endpoint. * @@ -5196,38 +5196,38 @@ export interface paths { * * Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty `groups` array will remove all connections for a team. */ - readonly patch: operations["teams/create-or-update-idp-group-connections-legacy"]; - }; - readonly "/teams/{team_id}/teams": { + readonly patch: operations['teams/create-or-update-idp-group-connections-legacy'] + } + readonly '/teams/{team_id}/teams': { /** **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/reference/teams#list-child-teams) endpoint. */ - readonly get: operations["teams/list-child-legacy"]; - }; - readonly "/user": { + readonly get: operations['teams/list-child-legacy'] + } + readonly '/user': { /** * If the authenticated user is authenticated through basic authentication or OAuth with the `user` scope, then the response lists public and private profile information. * * If the authenticated user is authenticated through OAuth without the `user` scope, then the response lists only public profile information. */ - readonly get: operations["users/get-authenticated"]; + readonly get: operations['users/get-authenticated'] /** **Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API. */ - readonly patch: operations["users/update-authenticated"]; - }; - readonly "/user/blocks": { + readonly patch: operations['users/update-authenticated'] + } + readonly '/user/blocks': { /** List the users you've blocked on your personal account. */ - readonly get: operations["users/list-blocked-by-authenticated-user"]; - }; - readonly "/user/blocks/{username}": { - readonly get: operations["users/check-blocked"]; - readonly put: operations["users/block"]; - readonly delete: operations["users/unblock"]; - }; - readonly "/user/codespaces": { + readonly get: operations['users/list-blocked-by-authenticated-user'] + } + readonly '/user/blocks/{username}': { + readonly get: operations['users/check-blocked'] + readonly put: operations['users/block'] + readonly delete: operations['users/unblock'] + } + readonly '/user/codespaces': { /** * Lists the authenticated user's codespaces. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - readonly get: operations["codespaces/list-for-authenticated-user"]; + readonly get: operations['codespaces/list-for-authenticated-user'] /** * Creates a new codespace, owned by the authenticated user. * @@ -5235,26 +5235,26 @@ export interface paths { * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - readonly post: operations["codespaces/create-for-authenticated-user"]; - }; - readonly "/user/codespaces/secrets": { + readonly post: operations['codespaces/create-for-authenticated-user'] + } + readonly '/user/codespaces/secrets': { /** * Lists all secrets available for a user's Codespaces without revealing their * encrypted values. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - readonly get: operations["codespaces/list-secrets-for-authenticated-user"]; - }; - readonly "/user/codespaces/secrets/public-key": { + readonly get: operations['codespaces/list-secrets-for-authenticated-user'] + } + readonly '/user/codespaces/secrets/public-key': { /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with one of the 'read:user' or 'user' scopes in their personal access token. User must have Codespaces access to use this endpoint. */ - readonly get: operations["codespaces/get-public-key-for-authenticated-user"]; - }; - readonly "/user/codespaces/secrets/{secret_name}": { + readonly get: operations['codespaces/get-public-key-for-authenticated-user'] + } + readonly '/user/codespaces/secrets/{secret_name}': { /** * Gets a secret available to a user's codespaces without revealing its encrypted value. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - readonly get: operations["codespaces/get-secret-for-authenticated-user"]; + readonly get: operations['codespaces/get-secret-for-authenticated-user'] /** * Creates or updates a secret for a user's codespace with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access token with the `user` scope to use this endpoint. User must also have Codespaces access to use this endpoint. @@ -5330,47 +5330,47 @@ export interface paths { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - readonly put: operations["codespaces/create-or-update-secret-for-authenticated-user"]; + readonly put: operations['codespaces/create-or-update-secret-for-authenticated-user'] /** Deletes a secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret. You must authenticate using an access token with the `user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - readonly delete: operations["codespaces/delete-secret-for-authenticated-user"]; - }; - readonly "/user/codespaces/secrets/{secret_name}/repositories": { + readonly delete: operations['codespaces/delete-secret-for-authenticated-user'] + } + readonly '/user/codespaces/secrets/{secret_name}/repositories': { /** * List the repositories that have been granted the ability to use a user's codespace secret. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - readonly get: operations["codespaces/list-repositories-for-secret-for-authenticated-user"]; + readonly get: operations['codespaces/list-repositories-for-secret-for-authenticated-user'] /** * Select the repositories that will use a user's codespace secret. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - readonly put: operations["codespaces/set-repositories-for-secret-for-authenticated-user"]; - }; - readonly "/user/codespaces/secrets/{secret_name}/repositories/{repository_id}": { + readonly put: operations['codespaces/set-repositories-for-secret-for-authenticated-user'] + } + readonly '/user/codespaces/secrets/{secret_name}/repositories/{repository_id}': { /** * Adds a repository to the selected repositories for a user's codespace secret. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - readonly put: operations["codespaces/add-repository-for-secret-for-authenticated-user"]; + readonly put: operations['codespaces/add-repository-for-secret-for-authenticated-user'] /** * Removes a repository from the selected repositories for a user's codespace secret. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - readonly delete: operations["codespaces/remove-repository-for-secret-for-authenticated-user"]; - }; - readonly "/user/codespaces/{codespace_name}": { + readonly delete: operations['codespaces/remove-repository-for-secret-for-authenticated-user'] + } + readonly '/user/codespaces/{codespace_name}': { /** * Gets information about a user's codespace. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - readonly get: operations["codespaces/get-for-authenticated-user"]; + readonly get: operations['codespaces/get-for-authenticated-user'] /** * Deletes a user's codespace. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - readonly delete: operations["codespaces/delete-for-authenticated-user"]; + readonly delete: operations['codespaces/delete-for-authenticated-user'] /** * Updates a codespace owned by the authenticated user. Currently only the codespace's machine type and recent folders can be modified using this endpoint. * @@ -5378,92 +5378,92 @@ export interface paths { * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - readonly patch: operations["codespaces/update-for-authenticated-user"]; - }; - readonly "/user/codespaces/{codespace_name}/exports": { + readonly patch: operations['codespaces/update-for-authenticated-user'] + } + readonly '/user/codespaces/{codespace_name}/exports': { /** * Triggers an export of the specified codespace and returns a URL and ID where the status of the export can be monitored. * * You must authenticate using a personal access token with the `codespace` scope to use this endpoint. */ - readonly post: operations["codespaces/export-for-authenticated-user"]; - }; - readonly "/user/codespaces/{codespace_name}/exports/{export_id}": { + readonly post: operations['codespaces/export-for-authenticated-user'] + } + readonly '/user/codespaces/{codespace_name}/exports/{export_id}': { /** * Gets information about an export of a codespace. * * You must authenticate using a personal access token with the `codespace` scope to use this endpoint. */ - readonly get: operations["codespaces/get-export-details-for-authenticated-user"]; - }; - readonly "/user/codespaces/{codespace_name}/machines": { + readonly get: operations['codespaces/get-export-details-for-authenticated-user'] + } + readonly '/user/codespaces/{codespace_name}/machines': { /** * List the machine types a codespace can transition to use. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - readonly get: operations["codespaces/codespace-machines-for-authenticated-user"]; - }; - readonly "/user/codespaces/{codespace_name}/start": { + readonly get: operations['codespaces/codespace-machines-for-authenticated-user'] + } + readonly '/user/codespaces/{codespace_name}/start': { /** * Starts a user's codespace. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - readonly post: operations["codespaces/start-for-authenticated-user"]; - }; - readonly "/user/codespaces/{codespace_name}/stop": { + readonly post: operations['codespaces/start-for-authenticated-user'] + } + readonly '/user/codespaces/{codespace_name}/stop': { /** * Stops a user's codespace. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - readonly post: operations["codespaces/stop-for-authenticated-user"]; - }; - readonly "/user/email/visibility": { + readonly post: operations['codespaces/stop-for-authenticated-user'] + } + readonly '/user/email/visibility': { /** Sets the visibility for your primary email addresses. */ - readonly patch: operations["users/set-primary-email-visibility-for-authenticated-user"]; - }; - readonly "/user/emails": { + readonly patch: operations['users/set-primary-email-visibility-for-authenticated-user'] + } + readonly '/user/emails': { /** Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope. */ - readonly get: operations["users/list-emails-for-authenticated-user"]; + readonly get: operations['users/list-emails-for-authenticated-user'] /** This endpoint is accessible with the `user` scope. */ - readonly post: operations["users/add-email-for-authenticated-user"]; + readonly post: operations['users/add-email-for-authenticated-user'] /** This endpoint is accessible with the `user` scope. */ - readonly delete: operations["users/delete-email-for-authenticated-user"]; - }; - readonly "/user/followers": { + readonly delete: operations['users/delete-email-for-authenticated-user'] + } + readonly '/user/followers': { /** Lists the people following the authenticated user. */ - readonly get: operations["users/list-followers-for-authenticated-user"]; - }; - readonly "/user/following": { + readonly get: operations['users/list-followers-for-authenticated-user'] + } + readonly '/user/following': { /** Lists the people who the authenticated user follows. */ - readonly get: operations["users/list-followed-by-authenticated-user"]; - }; - readonly "/user/following/{username}": { - readonly get: operations["users/check-person-is-followed-by-authenticated"]; + readonly get: operations['users/list-followed-by-authenticated-user'] + } + readonly '/user/following/{username}': { + readonly get: operations['users/check-person-is-followed-by-authenticated'] /** * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." * * Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. */ - readonly put: operations["users/follow"]; + readonly put: operations['users/follow'] /** Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. */ - readonly delete: operations["users/unfollow"]; - }; - readonly "/user/gpg_keys": { + readonly delete: operations['users/unfollow'] + } + readonly '/user/gpg_keys': { /** Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - readonly get: operations["users/list-gpg-keys-for-authenticated-user"]; + readonly get: operations['users/list-gpg-keys-for-authenticated-user'] /** Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - readonly post: operations["users/create-gpg-key-for-authenticated-user"]; - }; - readonly "/user/gpg_keys/{gpg_key_id}": { + readonly post: operations['users/create-gpg-key-for-authenticated-user'] + } + readonly '/user/gpg_keys/{gpg_key_id}': { /** View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - readonly get: operations["users/get-gpg-key-for-authenticated-user"]; + readonly get: operations['users/get-gpg-key-for-authenticated-user'] /** Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - readonly delete: operations["users/delete-gpg-key-for-authenticated-user"]; - }; - readonly "/user/installations": { + readonly delete: operations['users/delete-gpg-key-for-authenticated-user'] + } + readonly '/user/installations': { /** * Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. * @@ -5473,9 +5473,9 @@ export interface paths { * * You can find the permissions for the installation under the `permissions` key. */ - readonly get: operations["apps/list-installations-for-authenticated-user"]; - }; - readonly "/user/installations/{installation_id}/repositories": { + readonly get: operations['apps/list-installations-for-authenticated-user'] + } + readonly '/user/installations/{installation_id}/repositories': { /** * List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation. * @@ -5485,31 +5485,31 @@ export interface paths { * * The access the user has to each repository is included in the hash under the `permissions` key. */ - readonly get: operations["apps/list-installation-repos-for-authenticated-user"]; - }; - readonly "/user/installations/{installation_id}/repositories/{repository_id}": { + readonly get: operations['apps/list-installation-repos-for-authenticated-user'] + } + readonly '/user/installations/{installation_id}/repositories/{repository_id}': { /** * Add a single repository to an installation. The authenticated user must have admin access to the repository. * * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. */ - readonly put: operations["apps/add-repo-to-installation-for-authenticated-user"]; + readonly put: operations['apps/add-repo-to-installation-for-authenticated-user'] /** * Remove a single repository from an installation. The authenticated user must have admin access to the repository. * * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. */ - readonly delete: operations["apps/remove-repo-from-installation-for-authenticated-user"]; - }; - readonly "/user/interaction-limits": { + readonly delete: operations['apps/remove-repo-from-installation-for-authenticated-user'] + } + readonly '/user/interaction-limits': { /** Shows which type of GitHub user can interact with your public repositories and when the restriction expires. */ - readonly get: operations["interactions/get-restrictions-for-authenticated-user"]; + readonly get: operations['interactions/get-restrictions-for-authenticated-user'] /** Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user. */ - readonly put: operations["interactions/set-restrictions-for-authenticated-user"]; + readonly put: operations['interactions/set-restrictions-for-authenticated-user'] /** Removes any interaction restrictions from your public repositories. */ - readonly delete: operations["interactions/remove-restrictions-for-authenticated-user"]; - }; - readonly "/user/issues": { + readonly delete: operations['interactions/remove-restrictions-for-authenticated-user'] + } + readonly '/user/issues': { /** * List issues across owned and member repositories assigned to the authenticated user. * @@ -5518,42 +5518,42 @@ export interface paths { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - readonly get: operations["issues/list-for-authenticated-user"]; - }; - readonly "/user/keys": { + readonly get: operations['issues/list-for-authenticated-user'] + } + readonly '/user/keys': { /** Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - readonly get: operations["users/list-public-ssh-keys-for-authenticated-user"]; + readonly get: operations['users/list-public-ssh-keys-for-authenticated-user'] /** Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - readonly post: operations["users/create-public-ssh-key-for-authenticated-user"]; - }; - readonly "/user/keys/{key_id}": { + readonly post: operations['users/create-public-ssh-key-for-authenticated-user'] + } + readonly '/user/keys/{key_id}': { /** View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - readonly get: operations["users/get-public-ssh-key-for-authenticated-user"]; + readonly get: operations['users/get-public-ssh-key-for-authenticated-user'] /** Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - readonly delete: operations["users/delete-public-ssh-key-for-authenticated-user"]; - }; - readonly "/user/marketplace_purchases": { + readonly delete: operations['users/delete-public-ssh-key-for-authenticated-user'] + } + readonly '/user/marketplace_purchases': { /** Lists the active subscriptions for the authenticated user. You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an [OAuth token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/). */ - readonly get: operations["apps/list-subscriptions-for-authenticated-user"]; - }; - readonly "/user/marketplace_purchases/stubbed": { + readonly get: operations['apps/list-subscriptions-for-authenticated-user'] + } + readonly '/user/marketplace_purchases/stubbed': { /** Lists the active subscriptions for the authenticated user. You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an [OAuth token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/). */ - readonly get: operations["apps/list-subscriptions-for-authenticated-user-stubbed"]; - }; - readonly "/user/memberships/orgs": { - readonly get: operations["orgs/list-memberships-for-authenticated-user"]; - }; - readonly "/user/memberships/orgs/{org}": { - readonly get: operations["orgs/get-membership-for-authenticated-user"]; - readonly patch: operations["orgs/update-membership-for-authenticated-user"]; - }; - readonly "/user/migrations": { + readonly get: operations['apps/list-subscriptions-for-authenticated-user-stubbed'] + } + readonly '/user/memberships/orgs': { + readonly get: operations['orgs/list-memberships-for-authenticated-user'] + } + readonly '/user/memberships/orgs/{org}': { + readonly get: operations['orgs/get-membership-for-authenticated-user'] + readonly patch: operations['orgs/update-membership-for-authenticated-user'] + } + readonly '/user/migrations': { /** Lists all migrations a user has started. */ - readonly get: operations["migrations/list-for-authenticated-user"]; + readonly get: operations['migrations/list-for-authenticated-user'] /** Initiates the generation of a user migration archive. */ - readonly post: operations["migrations/start-for-authenticated-user"]; - }; - readonly "/user/migrations/{migration_id}": { + readonly post: operations['migrations/start-for-authenticated-user'] + } + readonly '/user/migrations/{migration_id}': { /** * Fetches a single user migration. The response includes the `state` of the migration, which can be one of the following values: * @@ -5564,9 +5564,9 @@ export interface paths { * * Once the migration has been `exported` you can [download the migration archive](https://docs.github.com/rest/reference/migrations#download-a-user-migration-archive). */ - readonly get: operations["migrations/get-status-for-authenticated-user"]; - }; - readonly "/user/migrations/{migration_id}/archive": { + readonly get: operations['migrations/get-status-for-authenticated-user'] + } + readonly '/user/migrations/{migration_id}/archive': { /** * Fetches the URL to download the migration archive as a `tar.gz` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects: * @@ -5590,19 +5590,19 @@ export interface paths { * * The archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data. */ - readonly get: operations["migrations/get-archive-for-authenticated-user"]; + readonly get: operations['migrations/get-archive-for-authenticated-user'] /** Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the [List user migrations](https://docs.github.com/rest/reference/migrations#list-user-migrations) and [Get a user migration status](https://docs.github.com/rest/reference/migrations#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted. */ - readonly delete: operations["migrations/delete-archive-for-authenticated-user"]; - }; - readonly "/user/migrations/{migration_id}/repos/{repo_name}/lock": { + readonly delete: operations['migrations/delete-archive-for-authenticated-user'] + } + readonly '/user/migrations/{migration_id}/repos/{repo_name}/lock': { /** Unlocks a repository. You can lock repositories when you [start a user migration](https://docs.github.com/rest/reference/migrations#start-a-user-migration). Once the migration is complete you can unlock each repository to begin using it again or [delete the repository](https://docs.github.com/rest/reference/repos#delete-a-repository) if you no longer need the source data. Returns a status of `404 Not Found` if the repository is not locked. */ - readonly delete: operations["migrations/unlock-repo-for-authenticated-user"]; - }; - readonly "/user/migrations/{migration_id}/repositories": { + readonly delete: operations['migrations/unlock-repo-for-authenticated-user'] + } + readonly '/user/migrations/{migration_id}/repositories': { /** Lists all the repositories for this user migration. */ - readonly get: operations["migrations/list-repos-for-authenticated-user"]; - }; - readonly "/user/orgs": { + readonly get: operations['migrations/list-repos-for-authenticated-user'] + } + readonly '/user/orgs': { /** * List organizations for the authenticated user. * @@ -5610,34 +5610,34 @@ export interface paths { * * This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response. */ - readonly get: operations["orgs/list-for-authenticated-user"]; - }; - readonly "/user/packages": { + readonly get: operations['orgs/list-for-authenticated-user'] + } + readonly '/user/packages': { /** * Lists packages owned by the authenticated user within the user's namespace. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - readonly get: operations["packages/list-packages-for-authenticated-user"]; - }; - readonly "/user/packages/{package_type}/{package_name}": { + readonly get: operations['packages/list-packages-for-authenticated-user'] + } + readonly '/user/packages/{package_type}/{package_name}': { /** * Gets a specific package for a package owned by the authenticated user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - readonly get: operations["packages/get-package-for-authenticated-user"]; + readonly get: operations['packages/get-package-for-authenticated-user'] /** * Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:delete` scopes. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - readonly delete: operations["packages/delete-package-for-authenticated-user"]; - }; - readonly "/user/packages/{package_type}/{package_name}/restore": { + readonly delete: operations['packages/delete-package-for-authenticated-user'] + } + readonly '/user/packages/{package_type}/{package_name}/restore': { /** * Restores a package owned by the authenticated user. * @@ -5647,34 +5647,34 @@ export interface paths { * * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. If `package_type` is not `container`, your token must also include the `repo` scope. */ - readonly post: operations["packages/restore-package-for-authenticated-user"]; - }; - readonly "/user/packages/{package_type}/{package_name}/versions": { + readonly post: operations['packages/restore-package-for-authenticated-user'] + } + readonly '/user/packages/{package_type}/{package_name}/versions': { /** * Returns all package versions for a package owned by the authenticated user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - readonly get: operations["packages/get-all-package-versions-for-package-owned-by-authenticated-user"]; - }; - readonly "/user/packages/{package_type}/{package_name}/versions/{package_version_id}": { + readonly get: operations['packages/get-all-package-versions-for-package-owned-by-authenticated-user'] + } + readonly '/user/packages/{package_type}/{package_name}/versions/{package_version_id}': { /** * Gets a specific package version for a package owned by the authenticated user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - readonly get: operations["packages/get-package-version-for-authenticated-user"]; + readonly get: operations['packages/get-package-version-for-authenticated-user'] /** * Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:delete` scopes. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - readonly delete: operations["packages/delete-package-version-for-authenticated-user"]; - }; - readonly "/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { + readonly delete: operations['packages/delete-package-version-for-authenticated-user'] + } + readonly '/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore': { /** * Restores a package version owned by the authenticated user. * @@ -5684,22 +5684,22 @@ export interface paths { * * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. If `package_type` is not `container`, your token must also include the `repo` scope. */ - readonly post: operations["packages/restore-package-version-for-authenticated-user"]; - }; - readonly "/user/projects": { - readonly post: operations["projects/create-for-authenticated-user"]; - }; - readonly "/user/public_emails": { + readonly post: operations['packages/restore-package-version-for-authenticated-user'] + } + readonly '/user/projects': { + readonly post: operations['projects/create-for-authenticated-user'] + } + readonly '/user/public_emails': { /** Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope. */ - readonly get: operations["users/list-public-emails-for-authenticated-user"]; - }; - readonly "/user/repos": { + readonly get: operations['users/list-public-emails-for-authenticated-user'] + } + readonly '/user/repos': { /** * Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. * * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. */ - readonly get: operations["repos/list-for-authenticated-user"]; + readonly get: operations['repos/list-for-authenticated-user'] /** * Creates a new repository for the authenticated user. * @@ -5710,47 +5710,47 @@ export interface paths { * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. * * `repo` scope to create a private repository. */ - readonly post: operations["repos/create-for-authenticated-user"]; - }; - readonly "/user/repository_invitations": { + readonly post: operations['repos/create-for-authenticated-user'] + } + readonly '/user/repository_invitations': { /** When authenticating as a user, this endpoint will list all currently open repository invitations for that user. */ - readonly get: operations["repos/list-invitations-for-authenticated-user"]; - }; - readonly "/user/repository_invitations/{invitation_id}": { - readonly delete: operations["repos/decline-invitation-for-authenticated-user"]; - readonly patch: operations["repos/accept-invitation-for-authenticated-user"]; - }; - readonly "/user/starred": { + readonly get: operations['repos/list-invitations-for-authenticated-user'] + } + readonly '/user/repository_invitations/{invitation_id}': { + readonly delete: operations['repos/decline-invitation-for-authenticated-user'] + readonly patch: operations['repos/accept-invitation-for-authenticated-user'] + } + readonly '/user/starred': { /** * Lists repositories the authenticated user has starred. * * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: */ - readonly get: operations["activity/list-repos-starred-by-authenticated-user"]; - }; - readonly "/user/starred/{owner}/{repo}": { - readonly get: operations["activity/check-repo-is-starred-by-authenticated-user"]; + readonly get: operations['activity/list-repos-starred-by-authenticated-user'] + } + readonly '/user/starred/{owner}/{repo}': { + readonly get: operations['activity/check-repo-is-starred-by-authenticated-user'] /** Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - readonly put: operations["activity/star-repo-for-authenticated-user"]; - readonly delete: operations["activity/unstar-repo-for-authenticated-user"]; - }; - readonly "/user/subscriptions": { + readonly put: operations['activity/star-repo-for-authenticated-user'] + readonly delete: operations['activity/unstar-repo-for-authenticated-user'] + } + readonly '/user/subscriptions': { /** Lists repositories the authenticated user is watching. */ - readonly get: operations["activity/list-watched-repos-for-authenticated-user"]; - }; - readonly "/user/teams": { + readonly get: operations['activity/list-watched-repos-for-authenticated-user'] + } + readonly '/user/teams': { /** List all of the teams across all of the organizations to which the authenticated user belongs. This method requires `user`, `repo`, or `read:org` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://docs.github.com/apps/building-oauth-apps/). */ - readonly get: operations["teams/list-for-authenticated-user"]; - }; - readonly "/users": { + readonly get: operations['teams/list-for-authenticated-user'] + } + readonly '/users': { /** * Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts. * * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of users. */ - readonly get: operations["users/list"]; - }; - readonly "/users/{username}": { + readonly get: operations['users/list'] + } + readonly '/users/{username}': { /** * Provides publicly available information about someone with a GitHub account. * @@ -5760,39 +5760,39 @@ export interface paths { * * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/reference/users#emails)". */ - readonly get: operations["users/get-by-username"]; - }; - readonly "/users/{username}/events": { + readonly get: operations['users/get-by-username'] + } + readonly '/users/{username}/events': { /** If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. */ - readonly get: operations["activity/list-events-for-authenticated-user"]; - }; - readonly "/users/{username}/events/orgs/{org}": { + readonly get: operations['activity/list-events-for-authenticated-user'] + } + readonly '/users/{username}/events/orgs/{org}': { /** This is the user's organization dashboard. You must be authenticated as the user to view this. */ - readonly get: operations["activity/list-org-events-for-authenticated-user"]; - }; - readonly "/users/{username}/events/public": { - readonly get: operations["activity/list-public-events-for-user"]; - }; - readonly "/users/{username}/followers": { + readonly get: operations['activity/list-org-events-for-authenticated-user'] + } + readonly '/users/{username}/events/public': { + readonly get: operations['activity/list-public-events-for-user'] + } + readonly '/users/{username}/followers': { /** Lists the people following the specified user. */ - readonly get: operations["users/list-followers-for-user"]; - }; - readonly "/users/{username}/following": { + readonly get: operations['users/list-followers-for-user'] + } + readonly '/users/{username}/following': { /** Lists the people who the specified user follows. */ - readonly get: operations["users/list-following-for-user"]; - }; - readonly "/users/{username}/following/{target_user}": { - readonly get: operations["users/check-following-for-user"]; - }; - readonly "/users/{username}/gists": { + readonly get: operations['users/list-following-for-user'] + } + readonly '/users/{username}/following/{target_user}': { + readonly get: operations['users/check-following-for-user'] + } + readonly '/users/{username}/gists': { /** Lists public gists for the specified user: */ - readonly get: operations["gists/list-for-user"]; - }; - readonly "/users/{username}/gpg_keys": { + readonly get: operations['gists/list-for-user'] + } + readonly '/users/{username}/gpg_keys': { /** Lists the GPG keys for a user. This information is accessible by anyone. */ - readonly get: operations["users/list-gpg-keys-for-user"]; - }; - readonly "/users/{username}/hovercard": { + readonly get: operations['users/list-gpg-keys-for-user'] + } + readonly '/users/{username}/hovercard': { /** * Provides hovercard information when authenticated through basic auth or OAuth with the `repo` scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. * @@ -5803,45 +5803,45 @@ export interface paths { * https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 * ``` */ - readonly get: operations["users/get-context-for-user"]; - }; - readonly "/users/{username}/installation": { + readonly get: operations['users/get-context-for-user'] + } + readonly '/users/{username}/installation': { /** * Enables an authenticated GitHub App to find the user’s installation information. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly get: operations["apps/get-user-installation"]; - }; - readonly "/users/{username}/keys": { + readonly get: operations['apps/get-user-installation'] + } + readonly '/users/{username}/keys': { /** Lists the _verified_ public SSH keys for a user. This is accessible by anyone. */ - readonly get: operations["users/list-public-keys-for-user"]; - }; - readonly "/users/{username}/orgs": { + readonly get: operations['users/list-public-keys-for-user'] + } + readonly '/users/{username}/orgs': { /** * List [public organization memberships](https://docs.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user. * * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/rest/reference/orgs#list-organizations-for-the-authenticated-user) API instead. */ - readonly get: operations["orgs/list-for-user"]; - }; - readonly "/users/{username}/packages": { + readonly get: operations['orgs/list-for-user'] + } + readonly '/users/{username}/packages': { /** * Lists all packages in a user's namespace for which the requesting user has access. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - readonly get: operations["packages/list-packages-for-user"]; - }; - readonly "/users/{username}/packages/{package_type}/{package_name}": { + readonly get: operations['packages/list-packages-for-user'] + } + readonly '/users/{username}/packages/{package_type}/{package_name}': { /** * Gets a specific package metadata for a public package owned by a user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - readonly get: operations["packages/get-package-for-user"]; + readonly get: operations['packages/get-package-for-user'] /** * Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * @@ -5849,9 +5849,9 @@ export interface paths { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. */ - readonly delete: operations["packages/delete-package-for-user"]; - }; - readonly "/users/{username}/packages/{package_type}/{package_name}/restore": { + readonly delete: operations['packages/delete-package-for-user'] + } + readonly '/users/{username}/packages/{package_type}/{package_name}/restore': { /** * Restores an entire package for a user. * @@ -5863,25 +5863,25 @@ export interface paths { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. */ - readonly post: operations["packages/restore-package-for-user"]; - }; - readonly "/users/{username}/packages/{package_type}/{package_name}/versions": { + readonly post: operations['packages/restore-package-for-user'] + } + readonly '/users/{username}/packages/{package_type}/{package_name}/versions': { /** * Returns all package versions for a public package owned by a specified user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - readonly get: operations["packages/get-all-package-versions-for-package-owned-by-user"]; - }; - readonly "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}": { + readonly get: operations['packages/get-all-package-versions-for-package-owned-by-user'] + } + readonly '/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}': { /** * Gets a specific package version for a public package owned by a specified user. * * At this time, to use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - readonly get: operations["packages/get-package-version-for-user"]; + readonly get: operations['packages/get-package-version-for-user'] /** * Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * @@ -5889,9 +5889,9 @@ export interface paths { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. */ - readonly delete: operations["packages/delete-package-version-for-user"]; - }; - readonly "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { + readonly delete: operations['packages/delete-package-version-for-user'] + } + readonly '/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore': { /** * Restores a specific package version for a user. * @@ -5903,23 +5903,23 @@ export interface paths { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. */ - readonly post: operations["packages/restore-package-version-for-user"]; - }; - readonly "/users/{username}/projects": { - readonly get: operations["projects/list-for-user"]; - }; - readonly "/users/{username}/received_events": { + readonly post: operations['packages/restore-package-version-for-user'] + } + readonly '/users/{username}/projects': { + readonly get: operations['projects/list-for-user'] + } + readonly '/users/{username}/received_events': { /** These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. */ - readonly get: operations["activity/list-received-events-for-user"]; - }; - readonly "/users/{username}/received_events/public": { - readonly get: operations["activity/list-received-public-events-for-user"]; - }; - readonly "/users/{username}/repos": { + readonly get: operations['activity/list-received-events-for-user'] + } + readonly '/users/{username}/received_events/public': { + readonly get: operations['activity/list-received-public-events-for-user'] + } + readonly '/users/{username}/repos': { /** Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user. */ - readonly get: operations["repos/list-for-user"]; - }; - readonly "/users/{username}/settings/billing/actions": { + readonly get: operations['repos/list-for-user'] + } + readonly '/users/{username}/settings/billing/actions': { /** * Gets the summary of the free and paid GitHub Actions minutes used. * @@ -5927,9 +5927,9 @@ export interface paths { * * Access tokens must have the `user` scope. */ - readonly get: operations["billing/get-github-actions-billing-user"]; - }; - readonly "/users/{username}/settings/billing/packages": { + readonly get: operations['billing/get-github-actions-billing-user'] + } + readonly '/users/{username}/settings/billing/packages': { /** * Gets the free and paid storage used for GitHub Packages in gigabytes. * @@ -5937,9 +5937,9 @@ export interface paths { * * Access tokens must have the `user` scope. */ - readonly get: operations["billing/get-github-packages-billing-user"]; - }; - readonly "/users/{username}/settings/billing/shared-storage": { + readonly get: operations['billing/get-github-packages-billing-user'] + } + readonly '/users/{username}/settings/billing/shared-storage': { /** * Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. * @@ -5947,24 +5947,24 @@ export interface paths { * * Access tokens must have the `user` scope. */ - readonly get: operations["billing/get-shared-storage-billing-user"]; - }; - readonly "/users/{username}/starred": { + readonly get: operations['billing/get-shared-storage-billing-user'] + } + readonly '/users/{username}/starred': { /** * Lists repositories a user has starred. * * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: */ - readonly get: operations["activity/list-repos-starred-by-user"]; - }; - readonly "/users/{username}/subscriptions": { + readonly get: operations['activity/list-repos-starred-by-user'] + } + readonly '/users/{username}/subscriptions': { /** Lists repositories a user is watching. */ - readonly get: operations["activity/list-repos-watched-by-user"]; - }; - readonly "/zen": { + readonly get: operations['activity/list-repos-watched-by-user'] + } + readonly '/zen': { /** Get a random sentence from the Zen of GitHub */ - readonly get: operations["meta/get-zen"]; - }; + readonly get: operations['meta/get-zen'] + } } export interface components { @@ -5973,71 +5973,71 @@ export interface components { * Simple User * @description Simple User */ - readonly "nullable-simple-user": { - readonly name?: string | null; - readonly email?: string | null; + readonly 'nullable-simple-user': { + readonly name?: string | null + readonly email?: string | null /** @example octocat */ - readonly login: string; + readonly login: string /** @example 1 */ - readonly id: number; + readonly id: number /** @example MDQ6VXNlcjE= */ - readonly node_id: string; + readonly node_id: string /** * Format: uri * @example https://github.com/images/error/octocat_happy.gif */ - readonly avatar_url: string; + readonly avatar_url: string /** @example 41d064eb2195891e12d0413f63227ea7 */ - readonly gravatar_id: string | null; + readonly gravatar_id: string | null /** * Format: uri * @example https://api.github.com/users/octocat */ - readonly url: string; + readonly url: string /** * Format: uri * @example https://github.com/octocat */ - readonly html_url: string; + readonly html_url: string /** * Format: uri * @example https://api.github.com/users/octocat/followers */ - readonly followers_url: string; + readonly followers_url: string /** @example https://api.github.com/users/octocat/following{/other_user} */ - readonly following_url: string; + readonly following_url: string /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - readonly gists_url: string; + readonly gists_url: string /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - readonly starred_url: string; + readonly starred_url: string /** * Format: uri * @example https://api.github.com/users/octocat/subscriptions */ - readonly subscriptions_url: string; + readonly subscriptions_url: string /** * Format: uri * @example https://api.github.com/users/octocat/orgs */ - readonly organizations_url: string; + readonly organizations_url: string /** * Format: uri * @example https://api.github.com/users/octocat/repos */ - readonly repos_url: string; + readonly repos_url: string /** @example https://api.github.com/users/octocat/events{/privacy} */ - readonly events_url: string; + readonly events_url: string /** * Format: uri * @example https://api.github.com/users/octocat/received_events */ - readonly received_events_url: string; + readonly received_events_url: string /** @example User */ - readonly type: string; - readonly site_admin: boolean; + readonly type: string + readonly site_admin: boolean /** @example "2020-07-09T00:17:55Z" */ - readonly starred_at?: string; - } | null; + readonly starred_at?: string + } | null /** * GitHub app * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. @@ -6047,554 +6047,554 @@ export interface components { * @description Unique identifier of the GitHub app * @example 37 */ - readonly id: number; + readonly id: number /** * @description The slug name of the GitHub app * @example probot-owners */ - readonly slug?: string; + readonly slug?: string /** @example MDExOkludGVncmF0aW9uMQ== */ - readonly node_id: string; - readonly owner: components["schemas"]["nullable-simple-user"]; + readonly node_id: string + readonly owner: components['schemas']['nullable-simple-user'] /** * @description The name of the GitHub app * @example Probot Owners */ - readonly name: string; + readonly name: string /** @example The description of the app. */ - readonly description: string | null; + readonly description: string | null /** * Format: uri * @example https://example.com */ - readonly external_url: string; + readonly external_url: string /** * Format: uri * @example https://github.com/apps/super-ci */ - readonly html_url: string; + readonly html_url: string /** * Format: date-time * @example 2017-07-08T16:18:44-04:00 */ - readonly created_at: string; + readonly created_at: string /** * Format: date-time * @example 2017-07-08T16:18:44-04:00 */ - readonly updated_at: string; + readonly updated_at: string /** * @description The set of permissions for the GitHub app * @example [object Object] */ readonly permissions: { - readonly issues?: string; - readonly checks?: string; - readonly metadata?: string; - readonly contents?: string; - readonly deployments?: string; - } & { readonly [key: string]: string }; + readonly issues?: string + readonly checks?: string + readonly metadata?: string + readonly contents?: string + readonly deployments?: string + } & { readonly [key: string]: string } /** * @description The list of events for the GitHub app * @example label,deployment */ - readonly events: readonly string[]; + readonly events: readonly string[] /** * @description The number of installations associated with the GitHub app * @example 5 */ - readonly installations_count?: number; + readonly installations_count?: number /** @example "Iv1.25b5d1e65ffc4022" */ - readonly client_id?: string; + readonly client_id?: string /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ - readonly client_secret?: string; + readonly client_secret?: string /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ - readonly webhook_secret?: string | null; + readonly webhook_secret?: string | null /** @example "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n" */ - readonly pem?: string; - }; + readonly pem?: string + } /** * Basic Error * @description Basic Error */ - readonly "basic-error": { - readonly message?: string; - readonly documentation_url?: string; - readonly url?: string; - readonly status?: string; - }; + readonly 'basic-error': { + readonly message?: string + readonly documentation_url?: string + readonly url?: string + readonly status?: string + } /** * Validation Error Simple * @description Validation Error Simple */ - readonly "validation-error-simple": { - readonly message: string; - readonly documentation_url: string; - readonly errors?: readonly string[]; - }; + readonly 'validation-error-simple': { + readonly message: string + readonly documentation_url: string + readonly errors?: readonly string[] + } /** * Format: uri * @description The URL to which the payloads will be delivered. * @example https://example.com/webhook */ - readonly "webhook-config-url": string; + readonly 'webhook-config-url': string /** * @description The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`. * @example "json" */ - readonly "webhook-config-content-type": string; + readonly 'webhook-config-content-type': string /** * @description If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers). * @example "********" */ - readonly "webhook-config-secret": string; - readonly "webhook-config-insecure-ssl": string | number; + readonly 'webhook-config-secret': string + readonly 'webhook-config-insecure-ssl': string | number /** * Webhook Configuration * @description Configuration object of the webhook */ - readonly "webhook-config": { - readonly url?: components["schemas"]["webhook-config-url"]; - readonly content_type?: components["schemas"]["webhook-config-content-type"]; - readonly secret?: components["schemas"]["webhook-config-secret"]; - readonly insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - }; + readonly 'webhook-config': { + readonly url?: components['schemas']['webhook-config-url'] + readonly content_type?: components['schemas']['webhook-config-content-type'] + readonly secret?: components['schemas']['webhook-config-secret'] + readonly insecure_ssl?: components['schemas']['webhook-config-insecure-ssl'] + } /** * Simple webhook delivery * @description Delivery made by a webhook, without request and response information. */ - readonly "hook-delivery-item": { + readonly 'hook-delivery-item': { /** * @description Unique identifier of the webhook delivery. * @example 42 */ - readonly id: number; + readonly id: number /** * @description Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event). * @example 58474f00-b361-11eb-836d-0e4f3503ccbe */ - readonly guid: string; + readonly guid: string /** * Format: date-time * @description Time when the webhook delivery occurred. * @example 2021-05-12T20:33:44Z */ - readonly delivered_at: string; + readonly delivered_at: string /** @description Whether the webhook delivery is a redelivery. */ - readonly redelivery: boolean; + readonly redelivery: boolean /** * @description Time spent delivering. * @example 0.03 */ - readonly duration: number; + readonly duration: number /** * @description Describes the response returned after attempting the delivery. * @example failed to connect */ - readonly status: string; + readonly status: string /** * @description Status code received when delivery was made. * @example 502 */ - readonly status_code: number; + readonly status_code: number /** * @description The event that triggered the delivery. * @example issues */ - readonly event: string; + readonly event: string /** * @description The type of activity for the event that triggered the delivery. * @example opened */ - readonly action: string | null; + readonly action: string | null /** * @description The id of the GitHub App installation associated with this event. * @example 123 */ - readonly installation_id: number | null; + readonly installation_id: number | null /** * @description The id of the repository associated with this event. * @example 123 */ - readonly repository_id: number | null; - }; + readonly repository_id: number | null + } /** * Scim Error * @description Scim Error */ - readonly "scim-error": { - readonly message?: string | null; - readonly documentation_url?: string | null; - readonly detail?: string | null; - readonly status?: number; - readonly scimType?: string | null; - readonly schemas?: readonly string[]; - }; + readonly 'scim-error': { + readonly message?: string | null + readonly documentation_url?: string | null + readonly detail?: string | null + readonly status?: number + readonly scimType?: string | null + readonly schemas?: readonly string[] + } /** * Validation Error * @description Validation Error */ - readonly "validation-error": { - readonly message: string; - readonly documentation_url: string; + readonly 'validation-error': { + readonly message: string + readonly documentation_url: string readonly errors?: readonly { - readonly resource?: string; - readonly field?: string; - readonly message?: string; - readonly code: string; - readonly index?: number; - readonly value?: (string | null) | (number | null) | (readonly string[] | null); - }[]; - }; + readonly resource?: string + readonly field?: string + readonly message?: string + readonly code: string + readonly index?: number + readonly value?: (string | null) | (number | null) | (readonly string[] | null) + }[] + } /** * Webhook delivery * @description Delivery made by a webhook. */ - readonly "hook-delivery": { + readonly 'hook-delivery': { /** * @description Unique identifier of the delivery. * @example 42 */ - readonly id: number; + readonly id: number /** * @description Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event). * @example 58474f00-b361-11eb-836d-0e4f3503ccbe */ - readonly guid: string; + readonly guid: string /** * Format: date-time * @description Time when the delivery was delivered. * @example 2021-05-12T20:33:44Z */ - readonly delivered_at: string; + readonly delivered_at: string /** @description Whether the delivery is a redelivery. */ - readonly redelivery: boolean; + readonly redelivery: boolean /** * @description Time spent delivering. * @example 0.03 */ - readonly duration: number; + readonly duration: number /** * @description Description of the status of the attempted delivery * @example failed to connect */ - readonly status: string; + readonly status: string /** * @description Status code received when delivery was made. * @example 502 */ - readonly status_code: number; + readonly status_code: number /** * @description The event that triggered the delivery. * @example issues */ - readonly event: string; + readonly event: string /** * @description The type of activity for the event that triggered the delivery. * @example opened */ - readonly action: string | null; + readonly action: string | null /** * @description The id of the GitHub App installation associated with this event. * @example 123 */ - readonly installation_id: number | null; + readonly installation_id: number | null /** * @description The id of the repository associated with this event. * @example 123 */ - readonly repository_id: number | null; + readonly repository_id: number | null /** * @description The URL target of the delivery. * @example https://www.example.com */ - readonly url?: string; + readonly url?: string readonly request: { /** @description The request headers sent with the webhook delivery. */ - readonly headers: { readonly [key: string]: unknown } | null; + readonly headers: { readonly [key: string]: unknown } | null /** @description The webhook payload. */ - readonly payload: { readonly [key: string]: unknown } | null; - }; + readonly payload: { readonly [key: string]: unknown } | null + } readonly response: { /** @description The response headers received when the delivery was made. */ - readonly headers: { readonly [key: string]: unknown } | null; + readonly headers: { readonly [key: string]: unknown } | null /** @description The response payload received. */ - readonly payload: string | null; - }; - }; + readonly payload: string | null + } + } /** * Simple User * @description Simple User */ - readonly "simple-user": { - readonly name?: string | null; - readonly email?: string | null; + readonly 'simple-user': { + readonly name?: string | null + readonly email?: string | null /** @example octocat */ - readonly login: string; + readonly login: string /** @example 1 */ - readonly id: number; + readonly id: number /** @example MDQ6VXNlcjE= */ - readonly node_id: string; + readonly node_id: string /** * Format: uri * @example https://github.com/images/error/octocat_happy.gif */ - readonly avatar_url: string; + readonly avatar_url: string /** @example 41d064eb2195891e12d0413f63227ea7 */ - readonly gravatar_id: string | null; + readonly gravatar_id: string | null /** * Format: uri * @example https://api.github.com/users/octocat */ - readonly url: string; + readonly url: string /** * Format: uri * @example https://github.com/octocat */ - readonly html_url: string; + readonly html_url: string /** * Format: uri * @example https://api.github.com/users/octocat/followers */ - readonly followers_url: string; + readonly followers_url: string /** @example https://api.github.com/users/octocat/following{/other_user} */ - readonly following_url: string; + readonly following_url: string /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - readonly gists_url: string; + readonly gists_url: string /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - readonly starred_url: string; + readonly starred_url: string /** * Format: uri * @example https://api.github.com/users/octocat/subscriptions */ - readonly subscriptions_url: string; + readonly subscriptions_url: string /** * Format: uri * @example https://api.github.com/users/octocat/orgs */ - readonly organizations_url: string; + readonly organizations_url: string /** * Format: uri * @example https://api.github.com/users/octocat/repos */ - readonly repos_url: string; + readonly repos_url: string /** @example https://api.github.com/users/octocat/events{/privacy} */ - readonly events_url: string; + readonly events_url: string /** * Format: uri * @example https://api.github.com/users/octocat/received_events */ - readonly received_events_url: string; + readonly received_events_url: string /** @example User */ - readonly type: string; - readonly site_admin: boolean; + readonly type: string + readonly site_admin: boolean /** @example "2020-07-09T00:17:55Z" */ - readonly starred_at?: string; - }; + readonly starred_at?: string + } /** * Enterprise * @description An enterprise account */ readonly enterprise: { /** @description A short description of the enterprise. */ - readonly description?: string | null; + readonly description?: string | null /** * Format: uri * @example https://github.com/enterprises/octo-business */ - readonly html_url: string; + readonly html_url: string /** * Format: uri * @description The enterprise's website URL. */ - readonly website_url?: string | null; + readonly website_url?: string | null /** * @description Unique identifier of the enterprise * @example 42 */ - readonly id: number; + readonly id: number /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - readonly node_id: string; + readonly node_id: string /** * @description The name of the enterprise. * @example Octo Business */ - readonly name: string; + readonly name: string /** * @description The slug url identifier for the enterprise. * @example octo-business */ - readonly slug: string; + readonly slug: string /** * Format: date-time * @example 2019-01-26T19:01:12Z */ - readonly created_at: string | null; + readonly created_at: string | null /** * Format: date-time * @example 2019-01-26T19:14:43Z */ - readonly updated_at: string | null; + readonly updated_at: string | null /** Format: uri */ - readonly avatar_url: string; - }; + readonly avatar_url: string + } /** * App Permissions * @description The permissions granted to the user-to-server access token. * @example [object Object] */ - readonly "app-permissions": { + readonly 'app-permissions': { /** * @description The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts. Can be one of: `read` or `write`. * @enum {string} */ - readonly actions?: "read" | "write"; + readonly actions?: 'read' | 'write' /** * @description The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation. Can be one of: `read` or `write`. * @enum {string} */ - readonly administration?: "read" | "write"; + readonly administration?: 'read' | 'write' /** * @description The level of permission to grant the access token for checks on code. Can be one of: `read` or `write`. * @enum {string} */ - readonly checks?: "read" | "write"; + readonly checks?: 'read' | 'write' /** * @description The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges. Can be one of: `read` or `write`. * @enum {string} */ - readonly contents?: "read" | "write"; + readonly contents?: 'read' | 'write' /** * @description The level of permission to grant the access token for deployments and deployment statuses. Can be one of: `read` or `write`. * @enum {string} */ - readonly deployments?: "read" | "write"; + readonly deployments?: 'read' | 'write' /** * @description The level of permission to grant the access token for managing repository environments. Can be one of: `read` or `write`. * @enum {string} */ - readonly environments?: "read" | "write"; + readonly environments?: 'read' | 'write' /** * @description The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones. Can be one of: `read` or `write`. * @enum {string} */ - readonly issues?: "read" | "write"; + readonly issues?: 'read' | 'write' /** * @description The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata. Can be one of: `read` or `write`. * @enum {string} */ - readonly metadata?: "read" | "write"; + readonly metadata?: 'read' | 'write' /** * @description The level of permission to grant the access token for packages published to GitHub Packages. Can be one of: `read` or `write`. * @enum {string} */ - readonly packages?: "read" | "write"; + readonly packages?: 'read' | 'write' /** * @description The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds. Can be one of: `read` or `write`. * @enum {string} */ - readonly pages?: "read" | "write"; + readonly pages?: 'read' | 'write' /** * @description The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges. Can be one of: `read` or `write`. * @enum {string} */ - readonly pull_requests?: "read" | "write"; + readonly pull_requests?: 'read' | 'write' /** * @description The level of permission to grant the access token to manage the post-receive hooks for a repository. Can be one of: `read` or `write`. * @enum {string} */ - readonly repository_hooks?: "read" | "write"; + readonly repository_hooks?: 'read' | 'write' /** * @description The level of permission to grant the access token to manage repository projects, columns, and cards. Can be one of: `read`, `write`, or `admin`. * @enum {string} */ - readonly repository_projects?: "read" | "write" | "admin"; + readonly repository_projects?: 'read' | 'write' | 'admin' /** * @description The level of permission to grant the access token to view and manage secret scanning alerts. Can be one of: `read` or `write`. * @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + readonly secret_scanning_alerts?: 'read' | 'write' /** * @description The level of permission to grant the access token to manage repository secrets. Can be one of: `read` or `write`. * @enum {string} */ - readonly secrets?: "read" | "write"; + readonly secrets?: 'read' | 'write' /** * @description The level of permission to grant the access token to view and manage security events like code scanning alerts. Can be one of: `read` or `write`. * @enum {string} */ - readonly security_events?: "read" | "write"; + readonly security_events?: 'read' | 'write' /** * @description The level of permission to grant the access token to manage just a single file. Can be one of: `read` or `write`. * @enum {string} */ - readonly single_file?: "read" | "write"; + readonly single_file?: 'read' | 'write' /** * @description The level of permission to grant the access token for commit statuses. Can be one of: `read` or `write`. * @enum {string} */ - readonly statuses?: "read" | "write"; + readonly statuses?: 'read' | 'write' /** * @description The level of permission to grant the access token to manage Dependabot alerts. Can be one of: `read` or `write`. * @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; + readonly vulnerability_alerts?: 'read' | 'write' /** * @description The level of permission to grant the access token to update GitHub Actions workflow files. Can be one of: `write`. * @enum {string} */ - readonly workflows?: "write"; + readonly workflows?: 'write' /** * @description The level of permission to grant the access token for organization teams and members. Can be one of: `read` or `write`. * @enum {string} */ - readonly members?: "read" | "write"; + readonly members?: 'read' | 'write' /** * @description The level of permission to grant the access token to manage access to an organization. Can be one of: `read` or `write`. * @enum {string} */ - readonly organization_administration?: "read" | "write"; + readonly organization_administration?: 'read' | 'write' /** * @description The level of permission to grant the access token to manage the post-receive hooks for an organization. Can be one of: `read` or `write`. * @enum {string} */ - readonly organization_hooks?: "read" | "write"; + readonly organization_hooks?: 'read' | 'write' /** * @description The level of permission to grant the access token for viewing an organization's plan. Can be one of: `read`. * @enum {string} */ - readonly organization_plan?: "read"; + readonly organization_plan?: 'read' /** * @description The level of permission to grant the access token to manage organization projects and projects beta (where available). Can be one of: `read`, `write`, or `admin`. * @enum {string} */ - readonly organization_projects?: "read" | "write" | "admin"; + readonly organization_projects?: 'read' | 'write' | 'admin' /** * @description The level of permission to grant the access token for organization packages published to GitHub Packages. Can be one of: `read` or `write`. * @enum {string} */ - readonly organization_packages?: "read" | "write"; + readonly organization_packages?: 'read' | 'write' /** * @description The level of permission to grant the access token to manage organization secrets. Can be one of: `read` or `write`. * @enum {string} */ - readonly organization_secrets?: "read" | "write"; + readonly organization_secrets?: 'read' | 'write' /** * @description The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization. Can be one of: `read` or `write`. * @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + readonly organization_self_hosted_runners?: 'read' | 'write' /** * @description The level of permission to grant the access token to view and manage users blocked by the organization. Can be one of: `read` or `write`. * @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + readonly organization_user_blocking?: 'read' | 'write' /** * @description The level of permission to grant the access token to manage team discussions and related comments. Can be one of: `read` or `write`. * @enum {string} */ - readonly team_discussions?: "read" | "write"; - }; + readonly team_discussions?: 'read' | 'write' + } /** * Installation * @description Installation @@ -6604,77 +6604,75 @@ export interface components { * @description The ID of the installation. * @example 1 */ - readonly id: number; - readonly account: - | (Partial & Partial) - | null; + readonly id: number + readonly account: (Partial & Partial) | null /** * @description Describe whether all repositories have been selected or there's a selection involved * @enum {string} */ - readonly repository_selection: "all" | "selected"; + readonly repository_selection: 'all' | 'selected' /** * Format: uri * @example https://api.github.com/installations/1/access_tokens */ - readonly access_tokens_url: string; + readonly access_tokens_url: string /** * Format: uri * @example https://api.github.com/installation/repositories */ - readonly repositories_url: string; + readonly repositories_url: string /** * Format: uri * @example https://github.com/organizations/github/settings/installations/1 */ - readonly html_url: string; + readonly html_url: string /** @example 1 */ - readonly app_id: number; + readonly app_id: number /** @description The ID of the user or organization this token is being scoped to. */ - readonly target_id: number; + readonly target_id: number /** @example Organization */ - readonly target_type: string; - readonly permissions: components["schemas"]["app-permissions"]; - readonly events: readonly string[]; + readonly target_type: string + readonly permissions: components['schemas']['app-permissions'] + readonly events: readonly string[] /** Format: date-time */ - readonly created_at: string; + readonly created_at: string /** Format: date-time */ - readonly updated_at: string; + readonly updated_at: string /** @example config.yaml */ - readonly single_file_name: string | null; + readonly single_file_name: string | null /** @example true */ - readonly has_multiple_single_files?: boolean; + readonly has_multiple_single_files?: boolean /** @example config.yml,.github/issue_TEMPLATE.md */ - readonly single_file_paths?: readonly string[]; + readonly single_file_paths?: readonly string[] /** @example github-actions */ - readonly app_slug: string; - readonly suspended_by: components["schemas"]["nullable-simple-user"]; + readonly app_slug: string + readonly suspended_by: components['schemas']['nullable-simple-user'] /** Format: date-time */ - readonly suspended_at: string | null; + readonly suspended_at: string | null /** @example "test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com" */ - readonly contact_email?: string | null; - }; + readonly contact_email?: string | null + } /** * License Simple * @description License Simple */ - readonly "nullable-license-simple": { + readonly 'nullable-license-simple': { /** @example mit */ - readonly key: string; + readonly key: string /** @example MIT License */ - readonly name: string; + readonly name: string /** * Format: uri * @example https://api.github.com/licenses/mit */ - readonly url: string | null; + readonly url: string | null /** @example MIT */ - readonly spdx_id: string | null; + readonly spdx_id: string | null /** @example MDc6TGljZW5zZW1pdA== */ - readonly node_id: string; + readonly node_id: string /** Format: uri */ - readonly html_url?: string; - } | null; + readonly html_url?: string + } | null /** * Repository * @description A git repository @@ -6684,503 +6682,503 @@ export interface components { * @description Unique identifier of the repository * @example 42 */ - readonly id: number; + readonly id: number /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - readonly node_id: string; + readonly node_id: string /** * @description The name of the repository. * @example Team Environment */ - readonly name: string; + readonly name: string /** @example octocat/Hello-World */ - readonly full_name: string; - readonly license: components["schemas"]["nullable-license-simple"]; - readonly organization?: components["schemas"]["nullable-simple-user"]; - readonly forks: number; + readonly full_name: string + readonly license: components['schemas']['nullable-license-simple'] + readonly organization?: components['schemas']['nullable-simple-user'] + readonly forks: number readonly permissions?: { - readonly admin: boolean; - readonly pull: boolean; - readonly triage?: boolean; - readonly push: boolean; - readonly maintain?: boolean; - }; - readonly owner: components["schemas"]["simple-user"]; + readonly admin: boolean + readonly pull: boolean + readonly triage?: boolean + readonly push: boolean + readonly maintain?: boolean + } + readonly owner: components['schemas']['simple-user'] /** @description Whether the repository is private or public. */ - readonly private: boolean; + readonly private: boolean /** * Format: uri * @example https://github.com/octocat/Hello-World */ - readonly html_url: string; + readonly html_url: string /** @example This your first repo! */ - readonly description: string | null; - readonly fork: boolean; + readonly description: string | null + readonly fork: boolean /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World */ - readonly url: string; + readonly url: string /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - readonly archive_url: string; + readonly archive_url: string /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - readonly assignees_url: string; + readonly assignees_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - readonly blobs_url: string; + readonly blobs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - readonly branches_url: string; + readonly branches_url: string /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - readonly collaborators_url: string; + readonly collaborators_url: string /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - readonly comments_url: string; + readonly comments_url: string /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - readonly commits_url: string; + readonly commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - readonly compare_url: string; + readonly compare_url: string /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - readonly contents_url: string; + readonly contents_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - readonly contributors_url: string; + readonly contributors_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - readonly deployments_url: string; + readonly deployments_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - readonly downloads_url: string; + readonly downloads_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events */ - readonly events_url: string; + readonly events_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ - readonly forks_url: string; + readonly forks_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - readonly git_commits_url: string; + readonly git_commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - readonly git_refs_url: string; + readonly git_refs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - readonly git_tags_url: string; + readonly git_tags_url: string /** @example git:github.com/octocat/Hello-World.git */ - readonly git_url: string; + readonly git_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - readonly issue_comment_url: string; + readonly issue_comment_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - readonly issue_events_url: string; + readonly issue_events_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - readonly issues_url: string; + readonly issues_url: string /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - readonly keys_url: string; + readonly keys_url: string /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - readonly labels_url: string; + readonly labels_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ - readonly languages_url: string; + readonly languages_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ - readonly merges_url: string; + readonly merges_url: string /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - readonly milestones_url: string; + readonly milestones_url: string /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - readonly notifications_url: string; + readonly notifications_url: string /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - readonly pulls_url: string; + readonly pulls_url: string /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - readonly releases_url: string; + readonly releases_url: string /** @example git@github.com:octocat/Hello-World.git */ - readonly ssh_url: string; + readonly ssh_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - readonly stargazers_url: string; + readonly stargazers_url: string /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - readonly statuses_url: string; + readonly statuses_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - readonly subscribers_url: string; + readonly subscribers_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - readonly subscription_url: string; + readonly subscription_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ - readonly tags_url: string; + readonly tags_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ - readonly teams_url: string; + readonly teams_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - readonly trees_url: string; + readonly trees_url: string /** @example https://github.com/octocat/Hello-World.git */ - readonly clone_url: string; + readonly clone_url: string /** * Format: uri * @example git:git.example.com/octocat/Hello-World */ - readonly mirror_url: string | null; + readonly mirror_url: string | null /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - readonly hooks_url: string; + readonly hooks_url: string /** * Format: uri * @example https://svn.github.com/octocat/Hello-World */ - readonly svn_url: string; + readonly svn_url: string /** * Format: uri * @example https://github.com */ - readonly homepage: string | null; - readonly language: string | null; + readonly homepage: string | null + readonly language: string | null /** @example 9 */ - readonly forks_count: number; + readonly forks_count: number /** @example 80 */ - readonly stargazers_count: number; + readonly stargazers_count: number /** @example 80 */ - readonly watchers_count: number; + readonly watchers_count: number /** @example 108 */ - readonly size: number; + readonly size: number /** * @description The default branch of the repository. * @example master */ - readonly default_branch: string; - readonly open_issues_count: number; + readonly default_branch: string + readonly open_issues_count: number /** * @description Whether this repository acts as a template that can be used to generate new repositories. * @example true */ - readonly is_template?: boolean; - readonly topics?: readonly string[]; + readonly is_template?: boolean + readonly topics?: readonly string[] /** * @description Whether issues are enabled. * @default true * @example true */ - readonly has_issues: boolean; + readonly has_issues: boolean /** * @description Whether projects are enabled. * @default true * @example true */ - readonly has_projects: boolean; + readonly has_projects: boolean /** * @description Whether the wiki is enabled. * @default true * @example true */ - readonly has_wiki: boolean; - readonly has_pages: boolean; + readonly has_wiki: boolean + readonly has_pages: boolean /** * @description Whether downloads are enabled. * @default true * @example true */ - readonly has_downloads: boolean; + readonly has_downloads: boolean /** @description Whether the repository is archived. */ - readonly archived: boolean; + readonly archived: boolean /** @description Returns whether or not this repository disabled. */ - readonly disabled: boolean; + readonly disabled: boolean /** * @description The repository visibility: public, private, or internal. * @default public */ - readonly visibility?: string; + readonly visibility?: string /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - readonly pushed_at: string | null; + readonly pushed_at: string | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly created_at: string | null; + readonly created_at: string | null /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - readonly updated_at: string | null; + readonly updated_at: string | null /** * @description Whether to allow rebase merges for pull requests. * @default true * @example true */ - readonly allow_rebase_merge?: boolean; + readonly allow_rebase_merge?: boolean readonly template_repository?: { - readonly id?: number; - readonly node_id?: string; - readonly name?: string; - readonly full_name?: string; + readonly id?: number + readonly node_id?: string + readonly name?: string + readonly full_name?: string readonly owner?: { - readonly login?: string; - readonly id?: number; - readonly node_id?: string; - readonly avatar_url?: string; - readonly gravatar_id?: string; - readonly url?: string; - readonly html_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly organizations_url?: string; - readonly repos_url?: string; - readonly events_url?: string; - readonly received_events_url?: string; - readonly type?: string; - readonly site_admin?: boolean; - }; - readonly private?: boolean; - readonly html_url?: string; - readonly description?: string; - readonly fork?: boolean; - readonly url?: string; - readonly archive_url?: string; - readonly assignees_url?: string; - readonly blobs_url?: string; - readonly branches_url?: string; - readonly collaborators_url?: string; - readonly comments_url?: string; - readonly commits_url?: string; - readonly compare_url?: string; - readonly contents_url?: string; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly downloads_url?: string; - readonly events_url?: string; - readonly forks_url?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly git_url?: string; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly notifications_url?: string; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly ssh_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly clone_url?: string; - readonly mirror_url?: string; - readonly hooks_url?: string; - readonly svn_url?: string; - readonly homepage?: string; - readonly language?: string; - readonly forks_count?: number; - readonly stargazers_count?: number; - readonly watchers_count?: number; - readonly size?: number; - readonly default_branch?: string; - readonly open_issues_count?: number; - readonly is_template?: boolean; - readonly topics?: readonly string[]; - readonly has_issues?: boolean; - readonly has_projects?: boolean; - readonly has_wiki?: boolean; - readonly has_pages?: boolean; - readonly has_downloads?: boolean; - readonly archived?: boolean; - readonly disabled?: boolean; - readonly visibility?: string; - readonly pushed_at?: string; - readonly created_at?: string; - readonly updated_at?: string; + readonly login?: string + readonly id?: number + readonly node_id?: string + readonly avatar_url?: string + readonly gravatar_id?: string + readonly url?: string + readonly html_url?: string + readonly followers_url?: string + readonly following_url?: string + readonly gists_url?: string + readonly starred_url?: string + readonly subscriptions_url?: string + readonly organizations_url?: string + readonly repos_url?: string + readonly events_url?: string + readonly received_events_url?: string + readonly type?: string + readonly site_admin?: boolean + } + readonly private?: boolean + readonly html_url?: string + readonly description?: string + readonly fork?: boolean + readonly url?: string + readonly archive_url?: string + readonly assignees_url?: string + readonly blobs_url?: string + readonly branches_url?: string + readonly collaborators_url?: string + readonly comments_url?: string + readonly commits_url?: string + readonly compare_url?: string + readonly contents_url?: string + readonly contributors_url?: string + readonly deployments_url?: string + readonly downloads_url?: string + readonly events_url?: string + readonly forks_url?: string + readonly git_commits_url?: string + readonly git_refs_url?: string + readonly git_tags_url?: string + readonly git_url?: string + readonly issue_comment_url?: string + readonly issue_events_url?: string + readonly issues_url?: string + readonly keys_url?: string + readonly labels_url?: string + readonly languages_url?: string + readonly merges_url?: string + readonly milestones_url?: string + readonly notifications_url?: string + readonly pulls_url?: string + readonly releases_url?: string + readonly ssh_url?: string + readonly stargazers_url?: string + readonly statuses_url?: string + readonly subscribers_url?: string + readonly subscription_url?: string + readonly tags_url?: string + readonly teams_url?: string + readonly trees_url?: string + readonly clone_url?: string + readonly mirror_url?: string + readonly hooks_url?: string + readonly svn_url?: string + readonly homepage?: string + readonly language?: string + readonly forks_count?: number + readonly stargazers_count?: number + readonly watchers_count?: number + readonly size?: number + readonly default_branch?: string + readonly open_issues_count?: number + readonly is_template?: boolean + readonly topics?: readonly string[] + readonly has_issues?: boolean + readonly has_projects?: boolean + readonly has_wiki?: boolean + readonly has_pages?: boolean + readonly has_downloads?: boolean + readonly archived?: boolean + readonly disabled?: boolean + readonly visibility?: string + readonly pushed_at?: string + readonly created_at?: string + readonly updated_at?: string readonly permissions?: { - readonly admin?: boolean; - readonly maintain?: boolean; - readonly push?: boolean; - readonly triage?: boolean; - readonly pull?: boolean; - }; - readonly allow_rebase_merge?: boolean; - readonly temp_clone_token?: string; - readonly allow_squash_merge?: boolean; - readonly allow_auto_merge?: boolean; - readonly delete_branch_on_merge?: boolean; - readonly allow_update_branch?: boolean; - readonly allow_merge_commit?: boolean; - readonly subscribers_count?: number; - readonly network_count?: number; - } | null; - readonly temp_clone_token?: string; + readonly admin?: boolean + readonly maintain?: boolean + readonly push?: boolean + readonly triage?: boolean + readonly pull?: boolean + } + readonly allow_rebase_merge?: boolean + readonly temp_clone_token?: string + readonly allow_squash_merge?: boolean + readonly allow_auto_merge?: boolean + readonly delete_branch_on_merge?: boolean + readonly allow_update_branch?: boolean + readonly allow_merge_commit?: boolean + readonly subscribers_count?: number + readonly network_count?: number + } | null + readonly temp_clone_token?: string /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - readonly allow_squash_merge?: boolean; + readonly allow_squash_merge?: boolean /** @description Whether to allow Auto-merge to be used on pull requests. */ - readonly allow_auto_merge?: boolean; + readonly allow_auto_merge?: boolean /** @description Whether to delete head branches when pull requests are merged */ - readonly delete_branch_on_merge?: boolean; + readonly delete_branch_on_merge?: boolean /** * @description Whether to allow merge commits for pull requests. * @default true * @example true */ - readonly allow_merge_commit?: boolean; + readonly allow_merge_commit?: boolean /** @description Whether to allow forking this repo */ - readonly allow_forking?: boolean; - readonly subscribers_count?: number; - readonly network_count?: number; - readonly open_issues: number; - readonly watchers: number; - readonly master_branch?: string; + readonly allow_forking?: boolean + readonly subscribers_count?: number + readonly network_count?: number + readonly open_issues: number + readonly watchers: number + readonly master_branch?: string /** @example "2020-07-09T00:17:42Z" */ - readonly starred_at?: string; - }; + readonly starred_at?: string + } /** * Installation Token * @description Authentication token for a GitHub App installed on a user or org. */ - readonly "installation-token": { - readonly token: string; - readonly expires_at: string; - readonly permissions?: components["schemas"]["app-permissions"]; + readonly 'installation-token': { + readonly token: string + readonly expires_at: string + readonly permissions?: components['schemas']['app-permissions'] /** @enum {string} */ - readonly repository_selection?: "all" | "selected"; - readonly repositories?: readonly components["schemas"]["repository"][]; + readonly repository_selection?: 'all' | 'selected' + readonly repositories?: readonly components['schemas']['repository'][] /** @example README.md */ - readonly single_file?: string; + readonly single_file?: string /** @example true */ - readonly has_multiple_single_files?: boolean; + readonly has_multiple_single_files?: boolean /** @example config.yml,.github/issue_TEMPLATE.md */ - readonly single_file_paths?: readonly string[]; - }; + readonly single_file_paths?: readonly string[] + } /** * Application Grant * @description The authorization associated with an OAuth Access. */ - readonly "application-grant": { + readonly 'application-grant': { /** @example 1 */ - readonly id: number; + readonly id: number /** * Format: uri * @example https://api.github.com/applications/grants/1 */ - readonly url: string; + readonly url: string readonly app: { - readonly client_id: string; - readonly name: string; + readonly client_id: string + readonly name: string /** Format: uri */ - readonly url: string; - }; + readonly url: string + } /** * Format: date-time * @example 2011-09-06T17:26:27Z */ - readonly created_at: string; + readonly created_at: string /** * Format: date-time * @example 2011-09-06T20:39:23Z */ - readonly updated_at: string; + readonly updated_at: string /** @example public_repo */ - readonly scopes: readonly string[]; - readonly user?: components["schemas"]["nullable-simple-user"]; - }; + readonly scopes: readonly string[] + readonly user?: components['schemas']['nullable-simple-user'] + } /** Scoped Installation */ - readonly "nullable-scoped-installation": { - readonly permissions: components["schemas"]["app-permissions"]; + readonly 'nullable-scoped-installation': { + readonly permissions: components['schemas']['app-permissions'] /** * @description Describe whether all repositories have been selected or there's a selection involved * @enum {string} */ - readonly repository_selection: "all" | "selected"; + readonly repository_selection: 'all' | 'selected' /** @example config.yaml */ - readonly single_file_name: string | null; + readonly single_file_name: string | null /** @example true */ - readonly has_multiple_single_files?: boolean; + readonly has_multiple_single_files?: boolean /** @example config.yml,.github/issue_TEMPLATE.md */ - readonly single_file_paths?: readonly string[]; + readonly single_file_paths?: readonly string[] /** * Format: uri * @example https://api.github.com/users/octocat/repos */ - readonly repositories_url: string; - readonly account: components["schemas"]["simple-user"]; - } | null; + readonly repositories_url: string + readonly account: components['schemas']['simple-user'] + } | null /** * Authorization * @description The authorization for an OAuth app, GitHub App, or a Personal Access Token. */ readonly authorization: { - readonly id: number; + readonly id: number /** Format: uri */ - readonly url: string; + readonly url: string /** @description A list of scopes that this authorization is in. */ - readonly scopes: readonly string[] | null; - readonly token: string; - readonly token_last_eight: string | null; - readonly hashed_token: string | null; + readonly scopes: readonly string[] | null + readonly token: string + readonly token_last_eight: string | null + readonly hashed_token: string | null readonly app: { - readonly client_id: string; - readonly name: string; + readonly client_id: string + readonly name: string /** Format: uri */ - readonly url: string; - }; - readonly note: string | null; + readonly url: string + } + readonly note: string | null /** Format: uri */ - readonly note_url: string | null; + readonly note_url: string | null /** Format: date-time */ - readonly updated_at: string; + readonly updated_at: string /** Format: date-time */ - readonly created_at: string; - readonly fingerprint: string | null; - readonly user?: components["schemas"]["nullable-simple-user"]; - readonly installation?: components["schemas"]["nullable-scoped-installation"]; + readonly created_at: string + readonly fingerprint: string | null + readonly user?: components['schemas']['nullable-simple-user'] + readonly installation?: components['schemas']['nullable-scoped-installation'] /** Format: date-time */ - readonly expires_at: string | null; - }; + readonly expires_at: string | null + } /** * Code Of Conduct * @description Code Of Conduct */ - readonly "code-of-conduct": { + readonly 'code-of-conduct': { /** @example contributor_covenant */ - readonly key: string; + readonly key: string /** @example Contributor Covenant */ - readonly name: string; + readonly name: string /** * Format: uri * @example https://api.github.com/codes_of_conduct/contributor_covenant */ - readonly url: string; + readonly url: string /** * @example # Contributor Covenant Code of Conduct * @@ -7231,100 +7229,100 @@ export interface components { * [homepage]: http://contributor-covenant.org * [version]: http://contributor-covenant.org/version/1/4/ */ - readonly body?: string; + readonly body?: string /** Format: uri */ - readonly html_url: string | null; - }; + readonly html_url: string | null + } /** * @description The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`. * @enum {string} */ - readonly "enabled-organizations": "all" | "none" | "selected"; + readonly 'enabled-organizations': 'all' | 'none' | 'selected' /** * @description The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`. * @enum {string} */ - readonly "allowed-actions": "all" | "local_only" | "selected"; + readonly 'allowed-actions': 'all' | 'local_only' | 'selected' /** @description The API URL to use to get or set the actions that are allowed to run, when `allowed_actions` is set to `selected`. */ - readonly "selected-actions-url": string; - readonly "actions-enterprise-permissions": { - readonly enabled_organizations: components["schemas"]["enabled-organizations"]; + readonly 'selected-actions-url': string + readonly 'actions-enterprise-permissions': { + readonly enabled_organizations: components['schemas']['enabled-organizations'] /** @description The API URL to use to get or set the selected organizations that are allowed to run GitHub Actions, when `enabled_organizations` is set to `selected`. */ - readonly selected_organizations_url?: string; - readonly allowed_actions?: components["schemas"]["allowed-actions"]; - readonly selected_actions_url?: components["schemas"]["selected-actions-url"]; - }; + readonly selected_organizations_url?: string + readonly allowed_actions?: components['schemas']['allowed-actions'] + readonly selected_actions_url?: components['schemas']['selected-actions-url'] + } /** * Organization Simple * @description Organization Simple */ - readonly "organization-simple": { + readonly 'organization-simple': { /** @example github */ - readonly login: string; + readonly login: string /** @example 1 */ - readonly id: number; + readonly id: number /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ - readonly node_id: string; + readonly node_id: string /** * Format: uri * @example https://api.github.com/orgs/github */ - readonly url: string; + readonly url: string /** * Format: uri * @example https://api.github.com/orgs/github/repos */ - readonly repos_url: string; + readonly repos_url: string /** * Format: uri * @example https://api.github.com/orgs/github/events */ - readonly events_url: string; + readonly events_url: string /** @example https://api.github.com/orgs/github/hooks */ - readonly hooks_url: string; + readonly hooks_url: string /** @example https://api.github.com/orgs/github/issues */ - readonly issues_url: string; + readonly issues_url: string /** @example https://api.github.com/orgs/github/members{/member} */ - readonly members_url: string; + readonly members_url: string /** @example https://api.github.com/orgs/github/public_members{/member} */ - readonly public_members_url: string; + readonly public_members_url: string /** @example https://github.com/images/error/octocat_happy.gif */ - readonly avatar_url: string; + readonly avatar_url: string /** @example A great organization */ - readonly description: string | null; - }; - readonly "selected-actions": { + readonly description: string | null + } + readonly 'selected-actions': { /** @description Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization. */ - readonly github_owned_allowed?: boolean; + readonly github_owned_allowed?: boolean /** @description Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators. */ - readonly verified_allowed?: boolean; + readonly verified_allowed?: boolean /** @description Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`." */ - readonly patterns_allowed?: readonly string[]; - }; - readonly "runner-groups-enterprise": { - readonly id: number; - readonly name: string; - readonly visibility: string; - readonly default: boolean; - readonly selected_organizations_url?: string; - readonly runners_url: string; - readonly allows_public_repositories: boolean; - }; + readonly patterns_allowed?: readonly string[] + } + readonly 'runner-groups-enterprise': { + readonly id: number + readonly name: string + readonly visibility: string + readonly default: boolean + readonly selected_organizations_url?: string + readonly runners_url: string + readonly allows_public_repositories: boolean + } /** * Self hosted runner label * @description A label for a self hosted runner */ - readonly "runner-label": { + readonly 'runner-label': { /** @description Unique identifier of the label. */ - readonly id?: number; + readonly id?: number /** @description Name of the label. */ - readonly name: string; + readonly name: string /** * @description The type of label. Read-only labels are applied automatically when the runner is configured. * @enum {string} */ - readonly type?: "read-only" | "custom"; - }; + readonly type?: 'read-only' | 'custom' + } /** * Self hosted runners * @description A self hosted runner @@ -7334,1048 +7332,1038 @@ export interface components { * @description The id of the runner. * @example 5 */ - readonly id: number; + readonly id: number /** * @description The name of the runner. * @example iMac */ - readonly name: string; + readonly name: string /** * @description The Operating System of the runner. * @example macos */ - readonly os: string; + readonly os: string /** * @description The status of the runner. * @example online */ - readonly status: string; - readonly busy: boolean; - readonly labels: readonly components["schemas"]["runner-label"][]; - }; + readonly status: string + readonly busy: boolean + readonly labels: readonly components['schemas']['runner-label'][] + } /** * Runner Application * @description Runner Application */ - readonly "runner-application": { - readonly os: string; - readonly architecture: string; - readonly download_url: string; - readonly filename: string; + readonly 'runner-application': { + readonly os: string + readonly architecture: string + readonly download_url: string + readonly filename: string /** @description A short lived bearer token used to download the runner, if needed. */ - readonly temp_download_token?: string; - readonly sha256_checksum?: string; - }; + readonly temp_download_token?: string + readonly sha256_checksum?: string + } /** * Authentication Token * @description Authentication Token */ - readonly "authentication-token": { + readonly 'authentication-token': { /** * @description The token used for authentication * @example v1.1f699f1069f60xxx */ - readonly token: string; + readonly token: string /** * Format: date-time * @description The time this token expires * @example 2016-07-11T22:14:10Z */ - readonly expires_at: string; + readonly expires_at: string /** @example [object Object] */ - readonly permissions?: { readonly [key: string]: unknown }; + readonly permissions?: { readonly [key: string]: unknown } /** @description The repositories this token has access to */ - readonly repositories?: readonly components["schemas"]["repository"][]; + readonly repositories?: readonly components['schemas']['repository'][] /** @example config.yaml */ - readonly single_file?: string | null; + readonly single_file?: string | null /** * @description Describe whether all repositories have been selected or there's a selection involved * @enum {string} */ - readonly repository_selection?: "all" | "selected"; - }; - readonly "audit-log-event": { + readonly repository_selection?: 'all' | 'selected' + } + readonly 'audit-log-event': { /** @description The time the audit log event occurred, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time). */ - readonly "@timestamp"?: number; + readonly '@timestamp'?: number /** @description The name of the action that was performed, for example `user.login` or `repo.create`. */ - readonly action?: string; - readonly active?: boolean; - readonly active_was?: boolean; + readonly action?: string + readonly active?: boolean + readonly active_was?: boolean /** @description The actor who performed the action. */ - readonly actor?: string; + readonly actor?: string /** @description The id of the actor who performed the action. */ - readonly actor_id?: number; + readonly actor_id?: number readonly actor_location?: { - readonly country_name?: string; - }; - readonly data?: { readonly [key: string]: unknown }; - readonly org_id?: number; + readonly country_name?: string + } + readonly data?: { readonly [key: string]: unknown } + readonly org_id?: number /** @description The username of the account being blocked. */ - readonly blocked_user?: string; - readonly business?: string; - readonly config?: readonly { readonly [key: string]: unknown }[]; - readonly config_was?: readonly { readonly [key: string]: unknown }[]; - readonly content_type?: string; + readonly blocked_user?: string + readonly business?: string + readonly config?: readonly { readonly [key: string]: unknown }[] + readonly config_was?: readonly { readonly [key: string]: unknown }[] + readonly content_type?: string /** @description The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time). */ - readonly created_at?: number; - readonly deploy_key_fingerprint?: string; + readonly created_at?: number + readonly deploy_key_fingerprint?: string /** @description A unique identifier for an audit event. */ - readonly _document_id?: string; - readonly emoji?: string; - readonly events?: readonly { readonly [key: string]: unknown }[]; - readonly events_were?: readonly { readonly [key: string]: unknown }[]; - readonly explanation?: string; - readonly fingerprint?: string; - readonly hook_id?: number; - readonly limited_availability?: boolean; - readonly message?: string; - readonly name?: string; - readonly old_user?: string; - readonly openssh_public_key?: string; - readonly org?: string; - readonly previous_visibility?: string; - readonly read_only?: boolean; + readonly _document_id?: string + readonly emoji?: string + readonly events?: readonly { readonly [key: string]: unknown }[] + readonly events_were?: readonly { readonly [key: string]: unknown }[] + readonly explanation?: string + readonly fingerprint?: string + readonly hook_id?: number + readonly limited_availability?: boolean + readonly message?: string + readonly name?: string + readonly old_user?: string + readonly openssh_public_key?: string + readonly org?: string + readonly previous_visibility?: string + readonly read_only?: boolean /** @description The name of the repository. */ - readonly repo?: string; + readonly repo?: string /** @description The name of the repository. */ - readonly repository?: string; - readonly repository_public?: boolean; - readonly target_login?: string; - readonly team?: string; + readonly repository?: string + readonly repository_public?: boolean + readonly target_login?: string + readonly team?: string /** @description The type of protocol (for example, HTTP or SSH) used to transfer Git data. */ - readonly transport_protocol?: number; + readonly transport_protocol?: number /** @description A human readable name for the protocol (for example, HTTP or SSH) used to transfer Git data. */ - readonly transport_protocol_name?: string; + readonly transport_protocol_name?: string /** @description The user that was affected by the action performed (if available). */ - readonly user?: string; + readonly user?: string /** @description The repository visibility, for example `public` or `private`. */ - readonly visibility?: string; - }; + readonly visibility?: string + } /** @description The security alert number. */ - readonly "alert-number": number; + readonly 'alert-number': number /** * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "alert-created-at": string; + readonly 'alert-created-at': string /** * Format: uri * @description The REST API URL of the alert resource. */ - readonly "alert-url": string; + readonly 'alert-url': string /** * Format: uri * @description The GitHub URL of the alert resource. */ - readonly "alert-html-url": string; + readonly 'alert-html-url': string /** * @description Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`. * @enum {string} */ - readonly "secret-scanning-alert-state": "open" | "resolved"; + readonly 'secret-scanning-alert-state': 'open' | 'resolved' /** * @description **Required when the `state` is `resolved`.** The reason for resolving the alert. Can be one of `false_positive`, `wont_fix`, `revoked`, or `used_in_tests`. * @enum {string|null} */ - readonly "secret-scanning-alert-resolution": - | (null | "false_positive" | "wont_fix" | "revoked" | "used_in_tests") - | null; + readonly 'secret-scanning-alert-resolution': (null | 'false_positive' | 'wont_fix' | 'revoked' | 'used_in_tests') | null /** * Repository * @description A git repository */ - readonly "nullable-repository": { + readonly 'nullable-repository': { /** * @description Unique identifier of the repository * @example 42 */ - readonly id: number; + readonly id: number /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - readonly node_id: string; + readonly node_id: string /** * @description The name of the repository. * @example Team Environment */ - readonly name: string; + readonly name: string /** @example octocat/Hello-World */ - readonly full_name: string; - readonly license: components["schemas"]["nullable-license-simple"]; - readonly organization?: components["schemas"]["nullable-simple-user"]; - readonly forks: number; + readonly full_name: string + readonly license: components['schemas']['nullable-license-simple'] + readonly organization?: components['schemas']['nullable-simple-user'] + readonly forks: number readonly permissions?: { - readonly admin: boolean; - readonly pull: boolean; - readonly triage?: boolean; - readonly push: boolean; - readonly maintain?: boolean; - }; - readonly owner: components["schemas"]["simple-user"]; + readonly admin: boolean + readonly pull: boolean + readonly triage?: boolean + readonly push: boolean + readonly maintain?: boolean + } + readonly owner: components['schemas']['simple-user'] /** @description Whether the repository is private or public. */ - readonly private: boolean; + readonly private: boolean /** * Format: uri * @example https://github.com/octocat/Hello-World */ - readonly html_url: string; + readonly html_url: string /** @example This your first repo! */ - readonly description: string | null; - readonly fork: boolean; + readonly description: string | null + readonly fork: boolean /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World */ - readonly url: string; + readonly url: string /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - readonly archive_url: string; + readonly archive_url: string /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - readonly assignees_url: string; + readonly assignees_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - readonly blobs_url: string; + readonly blobs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - readonly branches_url: string; + readonly branches_url: string /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - readonly collaborators_url: string; + readonly collaborators_url: string /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - readonly comments_url: string; + readonly comments_url: string /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - readonly commits_url: string; + readonly commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - readonly compare_url: string; + readonly compare_url: string /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - readonly contents_url: string; + readonly contents_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - readonly contributors_url: string; + readonly contributors_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - readonly deployments_url: string; + readonly deployments_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - readonly downloads_url: string; + readonly downloads_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events */ - readonly events_url: string; + readonly events_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ - readonly forks_url: string; + readonly forks_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - readonly git_commits_url: string; + readonly git_commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - readonly git_refs_url: string; + readonly git_refs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - readonly git_tags_url: string; + readonly git_tags_url: string /** @example git:github.com/octocat/Hello-World.git */ - readonly git_url: string; + readonly git_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - readonly issue_comment_url: string; + readonly issue_comment_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - readonly issue_events_url: string; + readonly issue_events_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - readonly issues_url: string; + readonly issues_url: string /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - readonly keys_url: string; + readonly keys_url: string /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - readonly labels_url: string; + readonly labels_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ - readonly languages_url: string; + readonly languages_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ - readonly merges_url: string; + readonly merges_url: string /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - readonly milestones_url: string; + readonly milestones_url: string /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - readonly notifications_url: string; + readonly notifications_url: string /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - readonly pulls_url: string; + readonly pulls_url: string /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - readonly releases_url: string; + readonly releases_url: string /** @example git@github.com:octocat/Hello-World.git */ - readonly ssh_url: string; + readonly ssh_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - readonly stargazers_url: string; + readonly stargazers_url: string /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - readonly statuses_url: string; + readonly statuses_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - readonly subscribers_url: string; + readonly subscribers_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - readonly subscription_url: string; + readonly subscription_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ - readonly tags_url: string; + readonly tags_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ - readonly teams_url: string; + readonly teams_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - readonly trees_url: string; + readonly trees_url: string /** @example https://github.com/octocat/Hello-World.git */ - readonly clone_url: string; + readonly clone_url: string /** * Format: uri * @example git:git.example.com/octocat/Hello-World */ - readonly mirror_url: string | null; + readonly mirror_url: string | null /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - readonly hooks_url: string; + readonly hooks_url: string /** * Format: uri * @example https://svn.github.com/octocat/Hello-World */ - readonly svn_url: string; + readonly svn_url: string /** * Format: uri * @example https://github.com */ - readonly homepage: string | null; - readonly language: string | null; + readonly homepage: string | null + readonly language: string | null /** @example 9 */ - readonly forks_count: number; + readonly forks_count: number /** @example 80 */ - readonly stargazers_count: number; + readonly stargazers_count: number /** @example 80 */ - readonly watchers_count: number; + readonly watchers_count: number /** @example 108 */ - readonly size: number; + readonly size: number /** * @description The default branch of the repository. * @example master */ - readonly default_branch: string; - readonly open_issues_count: number; + readonly default_branch: string + readonly open_issues_count: number /** * @description Whether this repository acts as a template that can be used to generate new repositories. * @example true */ - readonly is_template?: boolean; - readonly topics?: readonly string[]; + readonly is_template?: boolean + readonly topics?: readonly string[] /** * @description Whether issues are enabled. * @default true * @example true */ - readonly has_issues: boolean; + readonly has_issues: boolean /** * @description Whether projects are enabled. * @default true * @example true */ - readonly has_projects: boolean; + readonly has_projects: boolean /** * @description Whether the wiki is enabled. * @default true * @example true */ - readonly has_wiki: boolean; - readonly has_pages: boolean; + readonly has_wiki: boolean + readonly has_pages: boolean /** * @description Whether downloads are enabled. * @default true * @example true */ - readonly has_downloads: boolean; + readonly has_downloads: boolean /** @description Whether the repository is archived. */ - readonly archived: boolean; + readonly archived: boolean /** @description Returns whether or not this repository disabled. */ - readonly disabled: boolean; + readonly disabled: boolean /** * @description The repository visibility: public, private, or internal. * @default public */ - readonly visibility?: string; + readonly visibility?: string /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - readonly pushed_at: string | null; + readonly pushed_at: string | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly created_at: string | null; + readonly created_at: string | null /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - readonly updated_at: string | null; + readonly updated_at: string | null /** * @description Whether to allow rebase merges for pull requests. * @default true * @example true */ - readonly allow_rebase_merge?: boolean; + readonly allow_rebase_merge?: boolean readonly template_repository?: { - readonly id?: number; - readonly node_id?: string; - readonly name?: string; - readonly full_name?: string; + readonly id?: number + readonly node_id?: string + readonly name?: string + readonly full_name?: string readonly owner?: { - readonly login?: string; - readonly id?: number; - readonly node_id?: string; - readonly avatar_url?: string; - readonly gravatar_id?: string; - readonly url?: string; - readonly html_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly organizations_url?: string; - readonly repos_url?: string; - readonly events_url?: string; - readonly received_events_url?: string; - readonly type?: string; - readonly site_admin?: boolean; - }; - readonly private?: boolean; - readonly html_url?: string; - readonly description?: string; - readonly fork?: boolean; - readonly url?: string; - readonly archive_url?: string; - readonly assignees_url?: string; - readonly blobs_url?: string; - readonly branches_url?: string; - readonly collaborators_url?: string; - readonly comments_url?: string; - readonly commits_url?: string; - readonly compare_url?: string; - readonly contents_url?: string; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly downloads_url?: string; - readonly events_url?: string; - readonly forks_url?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly git_url?: string; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly notifications_url?: string; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly ssh_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly clone_url?: string; - readonly mirror_url?: string; - readonly hooks_url?: string; - readonly svn_url?: string; - readonly homepage?: string; - readonly language?: string; - readonly forks_count?: number; - readonly stargazers_count?: number; - readonly watchers_count?: number; - readonly size?: number; - readonly default_branch?: string; - readonly open_issues_count?: number; - readonly is_template?: boolean; - readonly topics?: readonly string[]; - readonly has_issues?: boolean; - readonly has_projects?: boolean; - readonly has_wiki?: boolean; - readonly has_pages?: boolean; - readonly has_downloads?: boolean; - readonly archived?: boolean; - readonly disabled?: boolean; - readonly visibility?: string; - readonly pushed_at?: string; - readonly created_at?: string; - readonly updated_at?: string; + readonly login?: string + readonly id?: number + readonly node_id?: string + readonly avatar_url?: string + readonly gravatar_id?: string + readonly url?: string + readonly html_url?: string + readonly followers_url?: string + readonly following_url?: string + readonly gists_url?: string + readonly starred_url?: string + readonly subscriptions_url?: string + readonly organizations_url?: string + readonly repos_url?: string + readonly events_url?: string + readonly received_events_url?: string + readonly type?: string + readonly site_admin?: boolean + } + readonly private?: boolean + readonly html_url?: string + readonly description?: string + readonly fork?: boolean + readonly url?: string + readonly archive_url?: string + readonly assignees_url?: string + readonly blobs_url?: string + readonly branches_url?: string + readonly collaborators_url?: string + readonly comments_url?: string + readonly commits_url?: string + readonly compare_url?: string + readonly contents_url?: string + readonly contributors_url?: string + readonly deployments_url?: string + readonly downloads_url?: string + readonly events_url?: string + readonly forks_url?: string + readonly git_commits_url?: string + readonly git_refs_url?: string + readonly git_tags_url?: string + readonly git_url?: string + readonly issue_comment_url?: string + readonly issue_events_url?: string + readonly issues_url?: string + readonly keys_url?: string + readonly labels_url?: string + readonly languages_url?: string + readonly merges_url?: string + readonly milestones_url?: string + readonly notifications_url?: string + readonly pulls_url?: string + readonly releases_url?: string + readonly ssh_url?: string + readonly stargazers_url?: string + readonly statuses_url?: string + readonly subscribers_url?: string + readonly subscription_url?: string + readonly tags_url?: string + readonly teams_url?: string + readonly trees_url?: string + readonly clone_url?: string + readonly mirror_url?: string + readonly hooks_url?: string + readonly svn_url?: string + readonly homepage?: string + readonly language?: string + readonly forks_count?: number + readonly stargazers_count?: number + readonly watchers_count?: number + readonly size?: number + readonly default_branch?: string + readonly open_issues_count?: number + readonly is_template?: boolean + readonly topics?: readonly string[] + readonly has_issues?: boolean + readonly has_projects?: boolean + readonly has_wiki?: boolean + readonly has_pages?: boolean + readonly has_downloads?: boolean + readonly archived?: boolean + readonly disabled?: boolean + readonly visibility?: string + readonly pushed_at?: string + readonly created_at?: string + readonly updated_at?: string readonly permissions?: { - readonly admin?: boolean; - readonly maintain?: boolean; - readonly push?: boolean; - readonly triage?: boolean; - readonly pull?: boolean; - }; - readonly allow_rebase_merge?: boolean; - readonly temp_clone_token?: string; - readonly allow_squash_merge?: boolean; - readonly allow_auto_merge?: boolean; - readonly delete_branch_on_merge?: boolean; - readonly allow_update_branch?: boolean; - readonly allow_merge_commit?: boolean; - readonly subscribers_count?: number; - readonly network_count?: number; - } | null; - readonly temp_clone_token?: string; + readonly admin?: boolean + readonly maintain?: boolean + readonly push?: boolean + readonly triage?: boolean + readonly pull?: boolean + } + readonly allow_rebase_merge?: boolean + readonly temp_clone_token?: string + readonly allow_squash_merge?: boolean + readonly allow_auto_merge?: boolean + readonly delete_branch_on_merge?: boolean + readonly allow_update_branch?: boolean + readonly allow_merge_commit?: boolean + readonly subscribers_count?: number + readonly network_count?: number + } | null + readonly temp_clone_token?: string /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - readonly allow_squash_merge?: boolean; + readonly allow_squash_merge?: boolean /** @description Whether to allow Auto-merge to be used on pull requests. */ - readonly allow_auto_merge?: boolean; + readonly allow_auto_merge?: boolean /** @description Whether to delete head branches when pull requests are merged */ - readonly delete_branch_on_merge?: boolean; + readonly delete_branch_on_merge?: boolean /** * @description Whether to allow merge commits for pull requests. * @default true * @example true */ - readonly allow_merge_commit?: boolean; + readonly allow_merge_commit?: boolean /** @description Whether to allow forking this repo */ - readonly allow_forking?: boolean; - readonly subscribers_count?: number; - readonly network_count?: number; - readonly open_issues: number; - readonly watchers: number; - readonly master_branch?: string; + readonly allow_forking?: boolean + readonly subscribers_count?: number + readonly network_count?: number + readonly open_issues: number + readonly watchers: number + readonly master_branch?: string /** @example "2020-07-09T00:17:42Z" */ - readonly starred_at?: string; - } | null; + readonly starred_at?: string + } | null /** * Minimal Repository * @description Minimal Repository */ - readonly "minimal-repository": { + readonly 'minimal-repository': { /** @example 1296269 */ - readonly id: number; + readonly id: number /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - readonly node_id: string; + readonly node_id: string /** @example Hello-World */ - readonly name: string; + readonly name: string /** @example octocat/Hello-World */ - readonly full_name: string; - readonly owner: components["schemas"]["simple-user"]; - readonly private: boolean; + readonly full_name: string + readonly owner: components['schemas']['simple-user'] + readonly private: boolean /** * Format: uri * @example https://github.com/octocat/Hello-World */ - readonly html_url: string; + readonly html_url: string /** @example This your first repo! */ - readonly description: string | null; - readonly fork: boolean; + readonly description: string | null + readonly fork: boolean /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World */ - readonly url: string; + readonly url: string /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - readonly archive_url: string; + readonly archive_url: string /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - readonly assignees_url: string; + readonly assignees_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - readonly blobs_url: string; + readonly blobs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - readonly branches_url: string; + readonly branches_url: string /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - readonly collaborators_url: string; + readonly collaborators_url: string /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - readonly comments_url: string; + readonly comments_url: string /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - readonly commits_url: string; + readonly commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - readonly compare_url: string; + readonly compare_url: string /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - readonly contents_url: string; + readonly contents_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - readonly contributors_url: string; + readonly contributors_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - readonly deployments_url: string; + readonly deployments_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - readonly downloads_url: string; + readonly downloads_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events */ - readonly events_url: string; + readonly events_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ - readonly forks_url: string; + readonly forks_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - readonly git_commits_url: string; + readonly git_commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - readonly git_refs_url: string; + readonly git_refs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - readonly git_tags_url: string; - readonly git_url?: string; + readonly git_tags_url: string + readonly git_url?: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - readonly issue_comment_url: string; + readonly issue_comment_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - readonly issue_events_url: string; + readonly issue_events_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - readonly issues_url: string; + readonly issues_url: string /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - readonly keys_url: string; + readonly keys_url: string /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - readonly labels_url: string; + readonly labels_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ - readonly languages_url: string; + readonly languages_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ - readonly merges_url: string; + readonly merges_url: string /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - readonly milestones_url: string; + readonly milestones_url: string /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - readonly notifications_url: string; + readonly notifications_url: string /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - readonly pulls_url: string; + readonly pulls_url: string /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - readonly releases_url: string; - readonly ssh_url?: string; + readonly releases_url: string + readonly ssh_url?: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - readonly stargazers_url: string; + readonly stargazers_url: string /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - readonly statuses_url: string; + readonly statuses_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - readonly subscribers_url: string; + readonly subscribers_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - readonly subscription_url: string; + readonly subscription_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ - readonly tags_url: string; + readonly tags_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ - readonly teams_url: string; + readonly teams_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - readonly trees_url: string; - readonly clone_url?: string; - readonly mirror_url?: string | null; + readonly trees_url: string + readonly clone_url?: string + readonly mirror_url?: string | null /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - readonly hooks_url: string; - readonly svn_url?: string; - readonly homepage?: string | null; - readonly language?: string | null; - readonly forks_count?: number; - readonly stargazers_count?: number; - readonly watchers_count?: number; - readonly size?: number; - readonly default_branch?: string; - readonly open_issues_count?: number; - readonly is_template?: boolean; - readonly topics?: readonly string[]; - readonly has_issues?: boolean; - readonly has_projects?: boolean; - readonly has_wiki?: boolean; - readonly has_pages?: boolean; - readonly has_downloads?: boolean; - readonly archived?: boolean; - readonly disabled?: boolean; - readonly visibility?: string; + readonly hooks_url: string + readonly svn_url?: string + readonly homepage?: string | null + readonly language?: string | null + readonly forks_count?: number + readonly stargazers_count?: number + readonly watchers_count?: number + readonly size?: number + readonly default_branch?: string + readonly open_issues_count?: number + readonly is_template?: boolean + readonly topics?: readonly string[] + readonly has_issues?: boolean + readonly has_projects?: boolean + readonly has_wiki?: boolean + readonly has_pages?: boolean + readonly has_downloads?: boolean + readonly archived?: boolean + readonly disabled?: boolean + readonly visibility?: string /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - readonly pushed_at?: string | null; + readonly pushed_at?: string | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly created_at?: string | null; + readonly created_at?: string | null /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - readonly updated_at?: string | null; + readonly updated_at?: string | null readonly permissions?: { - readonly admin?: boolean; - readonly maintain?: boolean; - readonly push?: boolean; - readonly triage?: boolean; - readonly pull?: boolean; - }; + readonly admin?: boolean + readonly maintain?: boolean + readonly push?: boolean + readonly triage?: boolean + readonly pull?: boolean + } /** @example admin */ - readonly role_name?: string; - readonly template_repository?: components["schemas"]["nullable-repository"]; - readonly temp_clone_token?: string; - readonly delete_branch_on_merge?: boolean; - readonly subscribers_count?: number; - readonly network_count?: number; - readonly code_of_conduct?: components["schemas"]["code-of-conduct"]; + readonly role_name?: string + readonly template_repository?: components['schemas']['nullable-repository'] + readonly temp_clone_token?: string + readonly delete_branch_on_merge?: boolean + readonly subscribers_count?: number + readonly network_count?: number + readonly code_of_conduct?: components['schemas']['code-of-conduct'] readonly license?: { - readonly key?: string; - readonly name?: string; - readonly spdx_id?: string; - readonly url?: string; - readonly node_id?: string; - } | null; - readonly forks?: number; - readonly open_issues?: number; - readonly watchers?: number; - readonly allow_forking?: boolean; - }; - readonly "organization-secret-scanning-alert": { - readonly number?: components["schemas"]["alert-number"]; - readonly created_at?: components["schemas"]["alert-created-at"]; - readonly url?: components["schemas"]["alert-url"]; - readonly html_url?: components["schemas"]["alert-html-url"]; + readonly key?: string + readonly name?: string + readonly spdx_id?: string + readonly url?: string + readonly node_id?: string + } | null + readonly forks?: number + readonly open_issues?: number + readonly watchers?: number + readonly allow_forking?: boolean + } + readonly 'organization-secret-scanning-alert': { + readonly number?: components['schemas']['alert-number'] + readonly created_at?: components['schemas']['alert-created-at'] + readonly url?: components['schemas']['alert-url'] + readonly html_url?: components['schemas']['alert-html-url'] /** * Format: uri * @description The REST API URL of the code locations for this alert. */ - readonly locations_url?: string; - readonly state?: components["schemas"]["secret-scanning-alert-state"]; - readonly resolution?: components["schemas"]["secret-scanning-alert-resolution"]; + readonly locations_url?: string + readonly state?: components['schemas']['secret-scanning-alert-state'] + readonly resolution?: components['schemas']['secret-scanning-alert-resolution'] /** * Format: date-time * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly resolved_at?: string | null; - readonly resolved_by?: components["schemas"]["nullable-simple-user"]; + readonly resolved_at?: string | null + readonly resolved_by?: components['schemas']['nullable-simple-user'] /** @description The type of secret that secret scanning detected. */ - readonly secret_type?: string; + readonly secret_type?: string /** @description The secret that was detected. */ - readonly secret?: string; - readonly repository?: components["schemas"]["minimal-repository"]; - }; - readonly "actions-billing-usage": { + readonly secret?: string + readonly repository?: components['schemas']['minimal-repository'] + } + readonly 'actions-billing-usage': { /** @description The sum of the free and paid GitHub Actions minutes used. */ - readonly total_minutes_used: number; + readonly total_minutes_used: number /** @description The total paid GitHub Actions minutes used. */ - readonly total_paid_minutes_used: number; + readonly total_paid_minutes_used: number /** @description The amount of free GitHub Actions minutes available. */ - readonly included_minutes: number; + readonly included_minutes: number readonly minutes_used_breakdown: { /** @description Total minutes used on Ubuntu runner machines. */ - readonly UBUNTU?: number; + readonly UBUNTU?: number /** @description Total minutes used on macOS runner machines. */ - readonly MACOS?: number; + readonly MACOS?: number /** @description Total minutes used on Windows runner machines. */ - readonly WINDOWS?: number; - }; - }; - readonly "advanced-security-active-committers-user": { - readonly user_login: string; + readonly WINDOWS?: number + } + } + readonly 'advanced-security-active-committers-user': { + readonly user_login: string /** @example 2021-11-03 */ - readonly last_pushed_date: string; - }; - readonly "advanced-security-active-committers-repository": { + readonly last_pushed_date: string + } + readonly 'advanced-security-active-committers-repository': { /** @example octocat/Hello-World */ - readonly name: string; + readonly name: string /** @example 25 */ - readonly advanced_security_committers: number; - readonly advanced_security_committers_breakdown: readonly components["schemas"]["advanced-security-active-committers-user"][]; - }; - readonly "advanced-security-active-committers": { + readonly advanced_security_committers: number + readonly advanced_security_committers_breakdown: readonly components['schemas']['advanced-security-active-committers-user'][] + } + readonly 'advanced-security-active-committers': { /** @example 25 */ - readonly total_advanced_security_committers?: number; - readonly repositories: readonly components["schemas"]["advanced-security-active-committers-repository"][]; - }; - readonly "packages-billing-usage": { + readonly total_advanced_security_committers?: number + readonly repositories: readonly components['schemas']['advanced-security-active-committers-repository'][] + } + readonly 'packages-billing-usage': { /** @description Sum of the free and paid storage space (GB) for GitHuub Packages. */ - readonly total_gigabytes_bandwidth_used: number; + readonly total_gigabytes_bandwidth_used: number /** @description Total paid storage space (GB) for GitHuub Packages. */ - readonly total_paid_gigabytes_bandwidth_used: number; + readonly total_paid_gigabytes_bandwidth_used: number /** @description Free storage space (GB) for GitHub Packages. */ - readonly included_gigabytes_bandwidth: number; - }; - readonly "combined-billing-usage": { + readonly included_gigabytes_bandwidth: number + } + readonly 'combined-billing-usage': { /** @description Numbers of days left in billing cycle. */ - readonly days_left_in_billing_cycle: number; + readonly days_left_in_billing_cycle: number /** @description Estimated storage space (GB) used in billing cycle. */ - readonly estimated_paid_storage_for_month: number; + readonly estimated_paid_storage_for_month: number /** @description Estimated sum of free and paid storage space (GB) used in billing cycle. */ - readonly estimated_storage_for_month: number; - }; + readonly estimated_storage_for_month: number + } /** * Actor * @description Actor */ readonly actor: { - readonly id: number; - readonly login: string; - readonly display_login?: string; - readonly gravatar_id: string | null; + readonly id: number + readonly login: string + readonly display_login?: string + readonly gravatar_id: string | null /** Format: uri */ - readonly url: string; + readonly url: string /** Format: uri */ - readonly avatar_url: string; - }; + readonly avatar_url: string + } /** * Milestone * @description A collection of related issues and pull requests. */ - readonly "nullable-milestone": { + readonly 'nullable-milestone': { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1 */ - readonly url: string; + readonly url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/milestones/v1.0 */ - readonly html_url: string; + readonly html_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1/labels */ - readonly labels_url: string; + readonly labels_url: string /** @example 1002604 */ - readonly id: number; + readonly id: number /** @example MDk6TWlsZXN0b25lMTAwMjYwNA== */ - readonly node_id: string; + readonly node_id: string /** * @description The number of the milestone. * @example 42 */ - readonly number: number; + readonly number: number /** * @description The state of the milestone. * @default open * @example open * @enum {string} */ - readonly state: "open" | "closed"; + readonly state: 'open' | 'closed' /** * @description The title of the milestone. * @example v1.0 */ - readonly title: string; + readonly title: string /** @example Tracking milestone for version 1.0 */ - readonly description: string | null; - readonly creator: components["schemas"]["nullable-simple-user"]; + readonly description: string | null + readonly creator: components['schemas']['nullable-simple-user'] /** @example 4 */ - readonly open_issues: number; + readonly open_issues: number /** @example 8 */ - readonly closed_issues: number; + readonly closed_issues: number /** * Format: date-time * @example 2011-04-10T20:09:31Z */ - readonly created_at: string; + readonly created_at: string /** * Format: date-time * @example 2014-03-03T18:58:10Z */ - readonly updated_at: string; + readonly updated_at: string /** * Format: date-time * @example 2013-02-12T13:22:01Z */ - readonly closed_at: string | null; + readonly closed_at: string | null /** * Format: date-time * @example 2012-10-09T23:39:01Z */ - readonly due_on: string | null; - } | null; + readonly due_on: string | null + } | null /** * GitHub app * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly "nullable-integration": { + readonly 'nullable-integration': { /** * @description Unique identifier of the GitHub app * @example 37 */ - readonly id: number; + readonly id: number /** * @description The slug name of the GitHub app * @example probot-owners */ - readonly slug?: string; + readonly slug?: string /** @example MDExOkludGVncmF0aW9uMQ== */ - readonly node_id: string; - readonly owner: components["schemas"]["nullable-simple-user"]; + readonly node_id: string + readonly owner: components['schemas']['nullable-simple-user'] /** * @description The name of the GitHub app * @example Probot Owners */ - readonly name: string; + readonly name: string /** @example The description of the app. */ - readonly description: string | null; + readonly description: string | null /** * Format: uri * @example https://example.com */ - readonly external_url: string; + readonly external_url: string /** * Format: uri * @example https://github.com/apps/super-ci */ - readonly html_url: string; + readonly html_url: string /** * Format: date-time * @example 2017-07-08T16:18:44-04:00 */ - readonly created_at: string; + readonly created_at: string /** * Format: date-time * @example 2017-07-08T16:18:44-04:00 */ - readonly updated_at: string; + readonly updated_at: string /** * @description The set of permissions for the GitHub app * @example [object Object] */ readonly permissions: { - readonly issues?: string; - readonly checks?: string; - readonly metadata?: string; - readonly contents?: string; - readonly deployments?: string; - } & { readonly [key: string]: string }; + readonly issues?: string + readonly checks?: string + readonly metadata?: string + readonly contents?: string + readonly deployments?: string + } & { readonly [key: string]: string } /** * @description The list of events for the GitHub app * @example label,deployment */ - readonly events: readonly string[]; + readonly events: readonly string[] /** * @description The number of installations associated with the GitHub app * @example 5 */ - readonly installations_count?: number; + readonly installations_count?: number /** @example "Iv1.25b5d1e65ffc4022" */ - readonly client_id?: string; + readonly client_id?: string /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ - readonly client_secret?: string; + readonly client_secret?: string /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ - readonly webhook_secret?: string | null; + readonly webhook_secret?: string | null /** @example "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n" */ - readonly pem?: string; - } | null; + readonly pem?: string + } | null /** * author_association * @description How the author is associated with the repository. * @example OWNER * @enum {string} */ - readonly author_association: - | "COLLABORATOR" - | "CONTRIBUTOR" - | "FIRST_TIMER" - | "FIRST_TIME_CONTRIBUTOR" - | "MANNEQUIN" - | "MEMBER" - | "NONE" - | "OWNER"; + readonly author_association: 'COLLABORATOR' | 'CONTRIBUTOR' | 'FIRST_TIMER' | 'FIRST_TIME_CONTRIBUTOR' | 'MANNEQUIN' | 'MEMBER' | 'NONE' | 'OWNER' /** Reaction Rollup */ - readonly "reaction-rollup": { + readonly 'reaction-rollup': { /** Format: uri */ - readonly url: string; - readonly total_count: number; - readonly "+1": number; - readonly "-1": number; - readonly laugh: number; - readonly confused: number; - readonly heart: number; - readonly hooray: number; - readonly eyes: number; - readonly rocket: number; - }; + readonly url: string + readonly total_count: number + readonly '+1': number + readonly '-1': number + readonly laugh: number + readonly confused: number + readonly heart: number + readonly hooray: number + readonly eyes: number + readonly rocket: number + } /** * Issue * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. */ readonly issue: { - readonly id: number; - readonly node_id: string; + readonly id: number + readonly node_id: string /** * Format: uri * @description URL for the issue * @example https://api.github.com/repositories/42/issues/1 */ - readonly url: string; + readonly url: string /** Format: uri */ - readonly repository_url: string; - readonly labels_url: string; + readonly repository_url: string + readonly labels_url: string /** Format: uri */ - readonly comments_url: string; + readonly comments_url: string /** Format: uri */ - readonly events_url: string; + readonly events_url: string /** Format: uri */ - readonly html_url: string; + readonly html_url: string /** * @description Number uniquely identifying the issue within its repository * @example 42 */ - readonly number: number; + readonly number: number /** * @description State of the issue; either 'open' or 'closed' * @example open */ - readonly state: string; + readonly state: string /** * @description Title of the issue * @example Widget creation fails in Safari on OS X 10.8 */ - readonly title: string; + readonly title: string /** * @description Contents of the issue * @example It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug? */ - readonly body?: string | null; - readonly user: components["schemas"]["nullable-simple-user"]; + readonly body?: string | null + readonly user: components['schemas']['nullable-simple-user'] /** * @description Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository * @example bug,registration @@ -8384,448 +8372,448 @@ export interface components { | string | { /** Format: int64 */ - readonly id?: number; - readonly node_id?: string; + readonly id?: number + readonly node_id?: string /** Format: uri */ - readonly url?: string; - readonly name?: string; - readonly description?: string | null; - readonly color?: string | null; - readonly default?: boolean; + readonly url?: string + readonly name?: string + readonly description?: string | null + readonly color?: string | null + readonly default?: boolean } - )[]; - readonly assignee: components["schemas"]["nullable-simple-user"]; - readonly assignees?: readonly components["schemas"]["simple-user"][] | null; - readonly milestone: components["schemas"]["nullable-milestone"]; - readonly locked: boolean; - readonly active_lock_reason?: string | null; - readonly comments: number; + )[] + readonly assignee: components['schemas']['nullable-simple-user'] + readonly assignees?: readonly components['schemas']['simple-user'][] | null + readonly milestone: components['schemas']['nullable-milestone'] + readonly locked: boolean + readonly active_lock_reason?: string | null + readonly comments: number readonly pull_request?: { /** Format: date-time */ - readonly merged_at?: string | null; + readonly merged_at?: string | null /** Format: uri */ - readonly diff_url: string | null; + readonly diff_url: string | null /** Format: uri */ - readonly html_url: string | null; + readonly html_url: string | null /** Format: uri */ - readonly patch_url: string | null; + readonly patch_url: string | null /** Format: uri */ - readonly url: string | null; - }; + readonly url: string | null + } /** Format: date-time */ - readonly closed_at: string | null; + readonly closed_at: string | null /** Format: date-time */ - readonly created_at: string; + readonly created_at: string /** Format: date-time */ - readonly updated_at: string; - readonly draft?: boolean; - readonly closed_by?: components["schemas"]["nullable-simple-user"]; - readonly body_html?: string; - readonly body_text?: string; + readonly updated_at: string + readonly draft?: boolean + readonly closed_by?: components['schemas']['nullable-simple-user'] + readonly body_html?: string + readonly body_text?: string /** Format: uri */ - readonly timeline_url?: string; - readonly repository?: components["schemas"]["repository"]; - readonly performed_via_github_app?: components["schemas"]["nullable-integration"]; - readonly author_association: components["schemas"]["author_association"]; - readonly reactions?: components["schemas"]["reaction-rollup"]; - }; + readonly timeline_url?: string + readonly repository?: components['schemas']['repository'] + readonly performed_via_github_app?: components['schemas']['nullable-integration'] + readonly author_association: components['schemas']['author_association'] + readonly reactions?: components['schemas']['reaction-rollup'] + } /** * Issue Comment * @description Comments provide a way for people to collaborate on an issue. */ - readonly "issue-comment": { + readonly 'issue-comment': { /** * @description Unique identifier of the issue comment * @example 42 */ - readonly id: number; - readonly node_id: string; + readonly id: number + readonly node_id: string /** * Format: uri * @description URL for the issue comment * @example https://api.github.com/repositories/42/issues/comments/1 */ - readonly url: string; + readonly url: string /** * @description Contents of the issue comment * @example What version of Safari were you using when you observed this bug? */ - readonly body?: string; - readonly body_text?: string; - readonly body_html?: string; + readonly body?: string + readonly body_text?: string + readonly body_html?: string /** Format: uri */ - readonly html_url: string; - readonly user: components["schemas"]["nullable-simple-user"]; + readonly html_url: string + readonly user: components['schemas']['nullable-simple-user'] /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - readonly created_at: string; + readonly created_at: string /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - readonly updated_at: string; + readonly updated_at: string /** Format: uri */ - readonly issue_url: string; - readonly author_association: components["schemas"]["author_association"]; - readonly performed_via_github_app?: components["schemas"]["nullable-integration"]; - readonly reactions?: components["schemas"]["reaction-rollup"]; - }; + readonly issue_url: string + readonly author_association: components['schemas']['author_association'] + readonly performed_via_github_app?: components['schemas']['nullable-integration'] + readonly reactions?: components['schemas']['reaction-rollup'] + } /** * Event * @description Event */ readonly event: { - readonly id: string; - readonly type: string | null; - readonly actor: components["schemas"]["actor"]; + readonly id: string + readonly type: string | null + readonly actor: components['schemas']['actor'] readonly repo: { - readonly id: number; - readonly name: string; + readonly id: number + readonly name: string /** Format: uri */ - readonly url: string; - }; - readonly org?: components["schemas"]["actor"]; + readonly url: string + } + readonly org?: components['schemas']['actor'] readonly payload: { - readonly action?: string; - readonly issue?: components["schemas"]["issue"]; - readonly comment?: components["schemas"]["issue-comment"]; + readonly action?: string + readonly issue?: components['schemas']['issue'] + readonly comment?: components['schemas']['issue-comment'] readonly pages?: readonly { - readonly page_name?: string; - readonly title?: string; - readonly summary?: string | null; - readonly action?: string; - readonly sha?: string; - readonly html_url?: string; - }[]; - }; - readonly public: boolean; + readonly page_name?: string + readonly title?: string + readonly summary?: string | null + readonly action?: string + readonly sha?: string + readonly html_url?: string + }[] + } + readonly public: boolean /** Format: date-time */ - readonly created_at: string | null; - }; + readonly created_at: string | null + } /** * Link With Type * @description Hypermedia Link with Type */ - readonly "link-with-type": { - readonly href: string; - readonly type: string; - }; + readonly 'link-with-type': { + readonly href: string + readonly type: string + } /** * Feed * @description Feed */ readonly feed: { /** @example https://github.com/timeline */ - readonly timeline_url: string; + readonly timeline_url: string /** @example https://github.com/{user} */ - readonly user_url: string; + readonly user_url: string /** @example https://github.com/octocat */ - readonly current_user_public_url?: string; + readonly current_user_public_url?: string /** @example https://github.com/octocat.private?token=abc123 */ - readonly current_user_url?: string; + readonly current_user_url?: string /** @example https://github.com/octocat.private.actor?token=abc123 */ - readonly current_user_actor_url?: string; + readonly current_user_actor_url?: string /** @example https://github.com/octocat-org */ - readonly current_user_organization_url?: string; + readonly current_user_organization_url?: string /** @example https://github.com/organizations/github/octocat.private.atom?token=abc123 */ - readonly current_user_organization_urls?: readonly string[]; + readonly current_user_organization_urls?: readonly string[] /** @example https://github.com/security-advisories */ - readonly security_advisories_url?: string; + readonly security_advisories_url?: string readonly _links: { - readonly timeline: components["schemas"]["link-with-type"]; - readonly user: components["schemas"]["link-with-type"]; - readonly security_advisories?: components["schemas"]["link-with-type"]; - readonly current_user?: components["schemas"]["link-with-type"]; - readonly current_user_public?: components["schemas"]["link-with-type"]; - readonly current_user_actor?: components["schemas"]["link-with-type"]; - readonly current_user_organization?: components["schemas"]["link-with-type"]; - readonly current_user_organizations?: readonly components["schemas"]["link-with-type"][]; - }; - }; + readonly timeline: components['schemas']['link-with-type'] + readonly user: components['schemas']['link-with-type'] + readonly security_advisories?: components['schemas']['link-with-type'] + readonly current_user?: components['schemas']['link-with-type'] + readonly current_user_public?: components['schemas']['link-with-type'] + readonly current_user_actor?: components['schemas']['link-with-type'] + readonly current_user_organization?: components['schemas']['link-with-type'] + readonly current_user_organizations?: readonly components['schemas']['link-with-type'][] + } + } /** * Base Gist * @description Base Gist */ - readonly "base-gist": { + readonly 'base-gist': { /** Format: uri */ - readonly url: string; + readonly url: string /** Format: uri */ - readonly forks_url: string; + readonly forks_url: string /** Format: uri */ - readonly commits_url: string; - readonly id: string; - readonly node_id: string; + readonly commits_url: string + readonly id: string + readonly node_id: string /** Format: uri */ - readonly git_pull_url: string; + readonly git_pull_url: string /** Format: uri */ - readonly git_push_url: string; + readonly git_push_url: string /** Format: uri */ - readonly html_url: string; + readonly html_url: string readonly files: { readonly [key: string]: { - readonly filename?: string; - readonly type?: string; - readonly language?: string; - readonly raw_url?: string; - readonly size?: number; - }; - }; - readonly public: boolean; + readonly filename?: string + readonly type?: string + readonly language?: string + readonly raw_url?: string + readonly size?: number + } + } + readonly public: boolean /** Format: date-time */ - readonly created_at: string; + readonly created_at: string /** Format: date-time */ - readonly updated_at: string; - readonly description: string | null; - readonly comments: number; - readonly user: components["schemas"]["nullable-simple-user"]; + readonly updated_at: string + readonly description: string | null + readonly comments: number + readonly user: components['schemas']['nullable-simple-user'] /** Format: uri */ - readonly comments_url: string; - readonly owner?: components["schemas"]["simple-user"]; - readonly truncated?: boolean; - readonly forks?: readonly unknown[]; - readonly history?: readonly unknown[]; - }; + readonly comments_url: string + readonly owner?: components['schemas']['simple-user'] + readonly truncated?: boolean + readonly forks?: readonly unknown[] + readonly history?: readonly unknown[] + } /** * Public User * @description Public User */ - readonly "public-user": { - readonly login: string; - readonly id: number; - readonly node_id: string; + readonly 'public-user': { + readonly login: string + readonly id: number + readonly node_id: string /** Format: uri */ - readonly avatar_url: string; - readonly gravatar_id: string | null; + readonly avatar_url: string + readonly gravatar_id: string | null /** Format: uri */ - readonly url: string; + readonly url: string /** Format: uri */ - readonly html_url: string; + readonly html_url: string /** Format: uri */ - readonly followers_url: string; - readonly following_url: string; - readonly gists_url: string; - readonly starred_url: string; + readonly followers_url: string + readonly following_url: string + readonly gists_url: string + readonly starred_url: string /** Format: uri */ - readonly subscriptions_url: string; + readonly subscriptions_url: string /** Format: uri */ - readonly organizations_url: string; + readonly organizations_url: string /** Format: uri */ - readonly repos_url: string; - readonly events_url: string; + readonly repos_url: string + readonly events_url: string /** Format: uri */ - readonly received_events_url: string; - readonly type: string; - readonly site_admin: boolean; - readonly name: string | null; - readonly company: string | null; - readonly blog: string | null; - readonly location: string | null; + readonly received_events_url: string + readonly type: string + readonly site_admin: boolean + readonly name: string | null + readonly company: string | null + readonly blog: string | null + readonly location: string | null /** Format: email */ - readonly email: string | null; - readonly hireable: boolean | null; - readonly bio: string | null; - readonly twitter_username?: string | null; - readonly public_repos: number; - readonly public_gists: number; - readonly followers: number; - readonly following: number; + readonly email: string | null + readonly hireable: boolean | null + readonly bio: string | null + readonly twitter_username?: string | null + readonly public_repos: number + readonly public_gists: number + readonly followers: number + readonly following: number /** Format: date-time */ - readonly created_at: string; + readonly created_at: string /** Format: date-time */ - readonly updated_at: string; + readonly updated_at: string readonly plan?: { - readonly collaborators: number; - readonly name: string; - readonly space: number; - readonly private_repos: number; - }; + readonly collaborators: number + readonly name: string + readonly space: number + readonly private_repos: number + } /** Format: date-time */ - readonly suspended_at?: string | null; + readonly suspended_at?: string | null /** @example 1 */ - readonly private_gists?: number; + readonly private_gists?: number /** @example 2 */ - readonly total_private_repos?: number; + readonly total_private_repos?: number /** @example 2 */ - readonly owned_private_repos?: number; + readonly owned_private_repos?: number /** @example 1 */ - readonly disk_usage?: number; + readonly disk_usage?: number /** @example 3 */ - readonly collaborators?: number; - }; + readonly collaborators?: number + } /** * Gist History * @description Gist History */ - readonly "gist-history": { - readonly user?: components["schemas"]["nullable-simple-user"]; - readonly version?: string; + readonly 'gist-history': { + readonly user?: components['schemas']['nullable-simple-user'] + readonly version?: string /** Format: date-time */ - readonly committed_at?: string; + readonly committed_at?: string readonly change_status?: { - readonly total?: number; - readonly additions?: number; - readonly deletions?: number; - }; + readonly total?: number + readonly additions?: number + readonly deletions?: number + } /** Format: uri */ - readonly url?: string; - }; + readonly url?: string + } /** * Gist Simple * @description Gist Simple */ - readonly "gist-simple": { + readonly 'gist-simple': { /** @deprecated */ readonly forks?: | readonly { - readonly id?: string; + readonly id?: string /** Format: uri */ - readonly url?: string; - readonly user?: components["schemas"]["public-user"]; + readonly url?: string + readonly user?: components['schemas']['public-user'] /** Format: date-time */ - readonly created_at?: string; + readonly created_at?: string /** Format: date-time */ - readonly updated_at?: string; + readonly updated_at?: string }[] - | null; + | null /** @deprecated */ - readonly history?: readonly components["schemas"]["gist-history"][] | null; + readonly history?: readonly components['schemas']['gist-history'][] | null /** * Gist * @description Gist */ readonly fork_of?: { /** Format: uri */ - readonly url: string; + readonly url: string /** Format: uri */ - readonly forks_url: string; + readonly forks_url: string /** Format: uri */ - readonly commits_url: string; - readonly id: string; - readonly node_id: string; + readonly commits_url: string + readonly id: string + readonly node_id: string /** Format: uri */ - readonly git_pull_url: string; + readonly git_pull_url: string /** Format: uri */ - readonly git_push_url: string; + readonly git_push_url: string /** Format: uri */ - readonly html_url: string; + readonly html_url: string readonly files: { readonly [key: string]: { - readonly filename?: string; - readonly type?: string; - readonly language?: string; - readonly raw_url?: string; - readonly size?: number; - }; - }; - readonly public: boolean; + readonly filename?: string + readonly type?: string + readonly language?: string + readonly raw_url?: string + readonly size?: number + } + } + readonly public: boolean /** Format: date-time */ - readonly created_at: string; + readonly created_at: string /** Format: date-time */ - readonly updated_at: string; - readonly description: string | null; - readonly comments: number; - readonly user: components["schemas"]["nullable-simple-user"]; + readonly updated_at: string + readonly description: string | null + readonly comments: number + readonly user: components['schemas']['nullable-simple-user'] /** Format: uri */ - readonly comments_url: string; - readonly owner?: components["schemas"]["nullable-simple-user"]; - readonly truncated?: boolean; - readonly forks?: readonly unknown[]; - readonly history?: readonly unknown[]; - } | null; - readonly url?: string; - readonly forks_url?: string; - readonly commits_url?: string; - readonly id?: string; - readonly node_id?: string; - readonly git_pull_url?: string; - readonly git_push_url?: string; - readonly html_url?: string; + readonly comments_url: string + readonly owner?: components['schemas']['nullable-simple-user'] + readonly truncated?: boolean + readonly forks?: readonly unknown[] + readonly history?: readonly unknown[] + } | null + readonly url?: string + readonly forks_url?: string + readonly commits_url?: string + readonly id?: string + readonly node_id?: string + readonly git_pull_url?: string + readonly git_push_url?: string + readonly html_url?: string readonly files?: { readonly [key: string]: { - readonly filename?: string; - readonly type?: string; - readonly language?: string; - readonly raw_url?: string; - readonly size?: number; - readonly truncated?: boolean; - readonly content?: string; - } | null; - }; - readonly public?: boolean; - readonly created_at?: string; - readonly updated_at?: string; - readonly description?: string | null; - readonly comments?: number; - readonly user?: string | null; - readonly comments_url?: string; - readonly owner?: components["schemas"]["simple-user"]; - readonly truncated?: boolean; - }; + readonly filename?: string + readonly type?: string + readonly language?: string + readonly raw_url?: string + readonly size?: number + readonly truncated?: boolean + readonly content?: string + } | null + } + readonly public?: boolean + readonly created_at?: string + readonly updated_at?: string + readonly description?: string | null + readonly comments?: number + readonly user?: string | null + readonly comments_url?: string + readonly owner?: components['schemas']['simple-user'] + readonly truncated?: boolean + } /** * Gist Comment * @description A comment made to a gist. */ - readonly "gist-comment": { + readonly 'gist-comment': { /** @example 1 */ - readonly id: number; + readonly id: number /** @example MDExOkdpc3RDb21tZW50MQ== */ - readonly node_id: string; + readonly node_id: string /** * Format: uri * @example https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 */ - readonly url: string; + readonly url: string /** * @description The comment text. * @example Body of the attachment */ - readonly body: string; - readonly user: components["schemas"]["nullable-simple-user"]; + readonly body: string + readonly user: components['schemas']['nullable-simple-user'] /** * Format: date-time * @example 2011-04-18T23:23:56Z */ - readonly created_at: string; + readonly created_at: string /** * Format: date-time * @example 2011-04-18T23:23:56Z */ - readonly updated_at: string; - readonly author_association: components["schemas"]["author_association"]; - }; + readonly updated_at: string + readonly author_association: components['schemas']['author_association'] + } /** * Gist Commit * @description Gist Commit */ - readonly "gist-commit": { + readonly 'gist-commit': { /** * Format: uri * @example https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f */ - readonly url: string; + readonly url: string /** @example 57a7f021a713b1c5a6a199b54cc514735d2d462f */ - readonly version: string; - readonly user: components["schemas"]["nullable-simple-user"]; + readonly version: string + readonly user: components['schemas']['nullable-simple-user'] readonly change_status: { - readonly total?: number; - readonly additions?: number; - readonly deletions?: number; - }; + readonly total?: number + readonly additions?: number + readonly deletions?: number + } /** * Format: date-time * @example 2010-04-14T02:15:15Z */ - readonly committed_at: string; - }; + readonly committed_at: string + } /** * Gitignore Template * @description Gitignore Template */ - readonly "gitignore-template": { + readonly 'gitignore-template': { /** @example C */ - readonly name: string; + readonly name: string /** * @example # Object files * *.o @@ -8845,62 +8833,62 @@ export interface components { * *.out * *.app */ - readonly source: string; - }; + readonly source: string + } /** * License Simple * @description License Simple */ - readonly "license-simple": { + readonly 'license-simple': { /** @example mit */ - readonly key: string; + readonly key: string /** @example MIT License */ - readonly name: string; + readonly name: string /** * Format: uri * @example https://api.github.com/licenses/mit */ - readonly url: string | null; + readonly url: string | null /** @example MIT */ - readonly spdx_id: string | null; + readonly spdx_id: string | null /** @example MDc6TGljZW5zZW1pdA== */ - readonly node_id: string; + readonly node_id: string /** Format: uri */ - readonly html_url?: string; - }; + readonly html_url?: string + } /** * License * @description License */ readonly license: { /** @example mit */ - readonly key: string; + readonly key: string /** @example MIT License */ - readonly name: string; + readonly name: string /** @example MIT */ - readonly spdx_id: string | null; + readonly spdx_id: string | null /** * Format: uri * @example https://api.github.com/licenses/mit */ - readonly url: string | null; + readonly url: string | null /** @example MDc6TGljZW5zZW1pdA== */ - readonly node_id: string; + readonly node_id: string /** * Format: uri * @example http://choosealicense.com/licenses/mit/ */ - readonly html_url: string; + readonly html_url: string /** @example A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty. */ - readonly description: string; + readonly description: string /** @example Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders. */ - readonly implementation: string; + readonly implementation: string /** @example commercial-use,modifications,distribution,sublicense,private-use */ - readonly permissions: readonly string[]; + readonly permissions: readonly string[] /** @example include-copyright */ - readonly conditions: readonly string[]; + readonly conditions: readonly string[] /** @example no-liability */ - readonly limitations: readonly string[]; + readonly limitations: readonly string[] /** * @example * @@ -8926,174 +8914,174 @@ export interface components { * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ - readonly body: string; + readonly body: string /** @example true */ - readonly featured: boolean; - }; + readonly featured: boolean + } /** * Marketplace Listing Plan * @description Marketplace Listing Plan */ - readonly "marketplace-listing-plan": { + readonly 'marketplace-listing-plan': { /** * Format: uri * @example https://api.github.com/marketplace_listing/plans/1313 */ - readonly url: string; + readonly url: string /** * Format: uri * @example https://api.github.com/marketplace_listing/plans/1313/accounts */ - readonly accounts_url: string; + readonly accounts_url: string /** @example 1313 */ - readonly id: number; + readonly id: number /** @example 3 */ - readonly number: number; + readonly number: number /** @example Pro */ - readonly name: string; + readonly name: string /** @example A professional-grade CI solution */ - readonly description: string; + readonly description: string /** @example 1099 */ - readonly monthly_price_in_cents: number; + readonly monthly_price_in_cents: number /** @example 11870 */ - readonly yearly_price_in_cents: number; + readonly yearly_price_in_cents: number /** @example flat-rate */ - readonly price_model: string; + readonly price_model: string /** @example true */ - readonly has_free_trial: boolean; - readonly unit_name: string | null; + readonly has_free_trial: boolean + readonly unit_name: string | null /** @example published */ - readonly state: string; + readonly state: string /** @example Up to 25 private repositories,11 concurrent builds */ - readonly bullets: readonly string[]; - }; + readonly bullets: readonly string[] + } /** * Marketplace Purchase * @description Marketplace Purchase */ - readonly "marketplace-purchase": { - readonly url: string; - readonly type: string; - readonly id: number; - readonly login: string; - readonly organization_billing_email?: string; - readonly email?: string | null; + readonly 'marketplace-purchase': { + readonly url: string + readonly type: string + readonly id: number + readonly login: string + readonly organization_billing_email?: string + readonly email?: string | null readonly marketplace_pending_change?: { - readonly is_installed?: boolean; - readonly effective_date?: string; - readonly unit_count?: number | null; - readonly id?: number; - readonly plan?: components["schemas"]["marketplace-listing-plan"]; - } | null; + readonly is_installed?: boolean + readonly effective_date?: string + readonly unit_count?: number | null + readonly id?: number + readonly plan?: components['schemas']['marketplace-listing-plan'] + } | null readonly marketplace_purchase: { - readonly billing_cycle?: string; - readonly next_billing_date?: string | null; - readonly is_installed?: boolean; - readonly unit_count?: number | null; - readonly on_free_trial?: boolean; - readonly free_trial_ends_on?: string | null; - readonly updated_at?: string; - readonly plan?: components["schemas"]["marketplace-listing-plan"]; - }; - }; + readonly billing_cycle?: string + readonly next_billing_date?: string | null + readonly is_installed?: boolean + readonly unit_count?: number | null + readonly on_free_trial?: boolean + readonly free_trial_ends_on?: string | null + readonly updated_at?: string + readonly plan?: components['schemas']['marketplace-listing-plan'] + } + } /** * Api Overview * @description Api Overview */ - readonly "api-overview": { + readonly 'api-overview': { /** @example true */ - readonly verifiable_password_authentication: boolean; + readonly verifiable_password_authentication: boolean readonly ssh_key_fingerprints?: { - readonly SHA256_RSA?: string; - readonly SHA256_DSA?: string; - readonly SHA256_ECDSA?: string; - readonly SHA256_ED25519?: string; - }; + readonly SHA256_RSA?: string + readonly SHA256_DSA?: string + readonly SHA256_ECDSA?: string + readonly SHA256_ED25519?: string + } /** @example ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIOMqqnkVzrm0SdG6UOoqKLsabgH5C9okWi0dh2l9GKJl */ - readonly ssh_keys?: readonly string[]; + readonly ssh_keys?: readonly string[] /** @example 127.0.0.1/32 */ - readonly hooks?: readonly string[]; + readonly hooks?: readonly string[] /** @example 127.0.0.1/32 */ - readonly web?: readonly string[]; + readonly web?: readonly string[] /** @example 127.0.0.1/32 */ - readonly api?: readonly string[]; + readonly api?: readonly string[] /** @example 127.0.0.1/32 */ - readonly git?: readonly string[]; + readonly git?: readonly string[] /** @example 13.65.0.0/16,157.55.204.33/32,2a01:111:f403:f90c::/62 */ - readonly packages?: readonly string[]; + readonly packages?: readonly string[] /** @example 192.30.252.153/32,192.30.252.154/32 */ - readonly pages?: readonly string[]; + readonly pages?: readonly string[] /** @example 54.158.161.132,54.226.70.38 */ - readonly importer?: readonly string[]; + readonly importer?: readonly string[] /** @example 13.64.0.0/16,13.65.0.0/16 */ - readonly actions?: readonly string[]; + readonly actions?: readonly string[] /** @example 192.168.7.15/32,192.168.7.16/32 */ - readonly dependabot?: readonly string[]; - }; + readonly dependabot?: readonly string[] + } /** * Thread * @description Thread */ readonly thread: { - readonly id: string; - readonly repository: components["schemas"]["minimal-repository"]; + readonly id: string + readonly repository: components['schemas']['minimal-repository'] readonly subject: { - readonly title: string; - readonly url: string; - readonly latest_comment_url: string; - readonly type: string; - }; - readonly reason: string; - readonly unread: boolean; - readonly updated_at: string; - readonly last_read_at: string | null; - readonly url: string; + readonly title: string + readonly url: string + readonly latest_comment_url: string + readonly type: string + } + readonly reason: string + readonly unread: boolean + readonly updated_at: string + readonly last_read_at: string | null + readonly url: string /** @example https://api.github.com/notifications/threads/2/subscription */ - readonly subscription_url: string; - }; + readonly subscription_url: string + } /** * Thread Subscription * @description Thread Subscription */ - readonly "thread-subscription": { + readonly 'thread-subscription': { /** @example true */ - readonly subscribed: boolean; - readonly ignored: boolean; - readonly reason: string | null; + readonly subscribed: boolean + readonly ignored: boolean + readonly reason: string | null /** * Format: date-time * @example 2012-10-06T21:34:12Z */ - readonly created_at: string | null; + readonly created_at: string | null /** * Format: uri * @example https://api.github.com/notifications/threads/1/subscription */ - readonly url: string; + readonly url: string /** * Format: uri * @example https://api.github.com/notifications/threads/1 */ - readonly thread_url?: string; + readonly thread_url?: string /** * Format: uri * @example https://api.github.com/repos/1 */ - readonly repository_url?: string; - }; + readonly repository_url?: string + } /** * Organization Custom Repository Role * @description Custom repository roles created by organization administrators */ - readonly "organization-custom-repository-role": { - readonly id: number; - readonly name: string; - }; + readonly 'organization-custom-repository-role': { + readonly id: number + readonly name: string + } /** * ExternalGroups * @description A list of external groups available to be connected to a team */ - readonly "external-groups": { + readonly 'external-groups': { /** * @description An array of external groups available to be mapped to a team * @example [object Object],[object Object] @@ -9103,488 +9091,488 @@ export interface components { * @description The internal ID of the group * @example 1 */ - readonly group_id: number; + readonly group_id: number /** * @description The display name of the group * @example group-azuread-test */ - readonly group_name: string; + readonly group_name: string /** * @description The time of the last update for this group * @example 2019-06-03 22:27:15:000 -700 */ - readonly updated_at: string; - }[]; - }; + readonly updated_at: string + }[] + } /** * Organization Full * @description Organization Full */ - readonly "organization-full": { + readonly 'organization-full': { /** @example github */ - readonly login: string; + readonly login: string /** @example 1 */ - readonly id: number; + readonly id: number /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ - readonly node_id: string; + readonly node_id: string /** * Format: uri * @example https://api.github.com/orgs/github */ - readonly url: string; + readonly url: string /** * Format: uri * @example https://api.github.com/orgs/github/repos */ - readonly repos_url: string; + readonly repos_url: string /** * Format: uri * @example https://api.github.com/orgs/github/events */ - readonly events_url: string; + readonly events_url: string /** @example https://api.github.com/orgs/github/hooks */ - readonly hooks_url: string; + readonly hooks_url: string /** @example https://api.github.com/orgs/github/issues */ - readonly issues_url: string; + readonly issues_url: string /** @example https://api.github.com/orgs/github/members{/member} */ - readonly members_url: string; + readonly members_url: string /** @example https://api.github.com/orgs/github/public_members{/member} */ - readonly public_members_url: string; + readonly public_members_url: string /** @example https://github.com/images/error/octocat_happy.gif */ - readonly avatar_url: string; + readonly avatar_url: string /** @example A great organization */ - readonly description: string | null; + readonly description: string | null /** @example github */ - readonly name?: string; + readonly name?: string /** @example GitHub */ - readonly company?: string; + readonly company?: string /** * Format: uri * @example https://github.com/blog */ - readonly blog?: string; + readonly blog?: string /** @example San Francisco */ - readonly location?: string; + readonly location?: string /** * Format: email * @example octocat@github.com */ - readonly email?: string; + readonly email?: string /** @example github */ - readonly twitter_username?: string | null; + readonly twitter_username?: string | null /** @example true */ - readonly is_verified?: boolean; + readonly is_verified?: boolean /** @example true */ - readonly has_organization_projects: boolean; + readonly has_organization_projects: boolean /** @example true */ - readonly has_repository_projects: boolean; + readonly has_repository_projects: boolean /** @example 2 */ - readonly public_repos: number; + readonly public_repos: number /** @example 1 */ - readonly public_gists: number; + readonly public_gists: number /** @example 20 */ - readonly followers: number; - readonly following: number; + readonly followers: number + readonly following: number /** * Format: uri * @example https://github.com/octocat */ - readonly html_url: string; + readonly html_url: string /** * Format: date-time * @example 2008-01-14T04:33:35Z */ - readonly created_at: string; + readonly created_at: string /** @example Organization */ - readonly type: string; + readonly type: string /** @example 100 */ - readonly total_private_repos?: number; + readonly total_private_repos?: number /** @example 100 */ - readonly owned_private_repos?: number; + readonly owned_private_repos?: number /** @example 81 */ - readonly private_gists?: number | null; + readonly private_gists?: number | null /** @example 10000 */ - readonly disk_usage?: number | null; + readonly disk_usage?: number | null /** @example 8 */ - readonly collaborators?: number | null; + readonly collaborators?: number | null /** * Format: email * @example org@example.com */ - readonly billing_email?: string | null; + readonly billing_email?: string | null readonly plan?: { - readonly name: string; - readonly space: number; - readonly private_repos: number; - readonly filled_seats?: number; - readonly seats?: number; - }; - readonly default_repository_permission?: string | null; + readonly name: string + readonly space: number + readonly private_repos: number + readonly filled_seats?: number + readonly seats?: number + } + readonly default_repository_permission?: string | null /** @example true */ - readonly members_can_create_repositories?: boolean | null; + readonly members_can_create_repositories?: boolean | null /** @example true */ - readonly two_factor_requirement_enabled?: boolean | null; + readonly two_factor_requirement_enabled?: boolean | null /** @example all */ - readonly members_allowed_repository_creation_type?: string; + readonly members_allowed_repository_creation_type?: string /** @example true */ - readonly members_can_create_public_repositories?: boolean; + readonly members_can_create_public_repositories?: boolean /** @example true */ - readonly members_can_create_private_repositories?: boolean; + readonly members_can_create_private_repositories?: boolean /** @example true */ - readonly members_can_create_internal_repositories?: boolean; + readonly members_can_create_internal_repositories?: boolean /** @example true */ - readonly members_can_create_pages?: boolean; + readonly members_can_create_pages?: boolean /** @example true */ - readonly members_can_create_public_pages?: boolean; + readonly members_can_create_public_pages?: boolean /** @example true */ - readonly members_can_create_private_pages?: boolean; - readonly members_can_fork_private_repositories?: boolean | null; + readonly members_can_create_private_pages?: boolean + readonly members_can_fork_private_repositories?: boolean | null /** Format: date-time */ - readonly updated_at: string; - }; + readonly updated_at: string + } /** * @description The policy that controls the repositories in the organization that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`. * @enum {string} */ - readonly "enabled-repositories": "all" | "none" | "selected"; - readonly "actions-organization-permissions": { - readonly enabled_repositories: components["schemas"]["enabled-repositories"]; + readonly 'enabled-repositories': 'all' | 'none' | 'selected' + readonly 'actions-organization-permissions': { + readonly enabled_repositories: components['schemas']['enabled-repositories'] /** @description The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. */ - readonly selected_repositories_url?: string; - readonly allowed_actions?: components["schemas"]["allowed-actions"]; - readonly selected_actions_url?: components["schemas"]["selected-actions-url"]; - }; + readonly selected_repositories_url?: string + readonly allowed_actions?: components['schemas']['allowed-actions'] + readonly selected_actions_url?: components['schemas']['selected-actions-url'] + } /** * @description The default workflow permissions granted to the GITHUB_TOKEN when running workflows in an organization. * @enum {string} */ - readonly "actions-default-workflow-permissions": "read" | "write"; + readonly 'actions-default-workflow-permissions': 'read' | 'write' /** @description Whether GitHub Actions can submit approving pull request reviews. */ - readonly "actions-can-approve-pull-request-reviews": boolean; - readonly "actions-get-default-workflow-permissions": { - readonly default_workflow_permissions: components["schemas"]["actions-default-workflow-permissions"]; - readonly can_approve_pull_request_reviews: components["schemas"]["actions-can-approve-pull-request-reviews"]; - }; - readonly "actions-set-default-workflow-permissions": { - readonly default_workflow_permissions?: components["schemas"]["actions-default-workflow-permissions"]; - readonly can_approve_pull_request_reviews?: components["schemas"]["actions-can-approve-pull-request-reviews"]; - }; - readonly "runner-groups-org": { - readonly id: number; - readonly name: string; - readonly visibility: string; - readonly default: boolean; + readonly 'actions-can-approve-pull-request-reviews': boolean + readonly 'actions-get-default-workflow-permissions': { + readonly default_workflow_permissions: components['schemas']['actions-default-workflow-permissions'] + readonly can_approve_pull_request_reviews: components['schemas']['actions-can-approve-pull-request-reviews'] + } + readonly 'actions-set-default-workflow-permissions': { + readonly default_workflow_permissions?: components['schemas']['actions-default-workflow-permissions'] + readonly can_approve_pull_request_reviews?: components['schemas']['actions-can-approve-pull-request-reviews'] + } + readonly 'runner-groups-org': { + readonly id: number + readonly name: string + readonly visibility: string + readonly default: boolean /** @description Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected` */ - readonly selected_repositories_url?: string; - readonly runners_url: string; - readonly inherited: boolean; - readonly inherited_allows_public_repositories?: boolean; - readonly allows_public_repositories: boolean; - }; + readonly selected_repositories_url?: string + readonly runners_url: string + readonly inherited: boolean + readonly inherited_allows_public_repositories?: boolean + readonly allows_public_repositories: boolean + } /** * Actions Secret for an Organization * @description Secrets for GitHub Actions for an organization. */ - readonly "organization-actions-secret": { + readonly 'organization-actions-secret': { /** * @description The name of the secret. * @example SECRET_TOKEN */ - readonly name: string; + readonly name: string /** Format: date-time */ - readonly created_at: string; + readonly created_at: string /** Format: date-time */ - readonly updated_at: string; + readonly updated_at: string /** * @description Visibility of a secret * @enum {string} */ - readonly visibility: "all" | "private" | "selected"; + readonly visibility: 'all' | 'private' | 'selected' /** * Format: uri * @example https://api.github.com/organizations/org/secrets/my_secret/repositories */ - readonly selected_repositories_url?: string; - }; + readonly selected_repositories_url?: string + } /** * ActionsPublicKey * @description The public key used for setting Actions Secrets. */ - readonly "actions-public-key": { + readonly 'actions-public-key': { /** * @description The identifier for the key. * @example 1234567 */ - readonly key_id: string; + readonly key_id: string /** * @description The Base64 encoded public key. * @example hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= */ - readonly key: string; + readonly key: string /** @example 2 */ - readonly id?: number; + readonly id?: number /** @example https://api.github.com/user/keys/2 */ - readonly url?: string; + readonly url?: string /** @example ssh-rsa AAAAB3NzaC1yc2EAAA */ - readonly title?: string; + readonly title?: string /** @example 2011-01-26T19:01:12Z */ - readonly created_at?: string; - }; + readonly created_at?: string + } /** * Empty Object * @description An object without any properties. */ - readonly "empty-object": { readonly [key: string]: unknown }; + readonly 'empty-object': { readonly [key: string]: unknown } /** * @description State of a code scanning alert. * @enum {string} */ - readonly "code-scanning-alert-state": "open" | "closed" | "dismissed" | "fixed"; + readonly 'code-scanning-alert-state': 'open' | 'closed' | 'dismissed' | 'fixed' /** * Format: date-time * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "alert-updated-at": string; + readonly 'alert-updated-at': string /** * Format: uri * @description The REST API URL for fetching the list of instances for an alert. */ - readonly "alert-instances-url": string; + readonly 'alert-instances-url': string /** * Format: date-time * @description The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "code-scanning-alert-fixed-at": string | null; + readonly 'code-scanning-alert-fixed-at': string | null /** * Format: date-time * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "code-scanning-alert-dismissed-at": string | null; + readonly 'code-scanning-alert-dismissed-at': string | null /** * @description **Required when the state is dismissed.** The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. * @enum {string|null} */ - readonly "code-scanning-alert-dismissed-reason": (null | "false positive" | "won't fix" | "used in tests") | null; - readonly "code-scanning-alert-rule": { + readonly 'code-scanning-alert-dismissed-reason': (null | 'false positive' | "won't fix" | 'used in tests') | null + readonly 'code-scanning-alert-rule': { /** @description A unique identifier for the rule used to detect the alert. */ - readonly id?: string | null; + readonly id?: string | null /** @description The name of the rule used to detect the alert. */ - readonly name?: string; + readonly name?: string /** * @description The severity of the alert. * @enum {string|null} */ - readonly severity?: ("none" | "note" | "warning" | "error") | null; + readonly severity?: ('none' | 'note' | 'warning' | 'error') | null /** * @description The security severity of the alert. * @enum {string|null} */ - readonly security_severity_level?: ("low" | "medium" | "high" | "critical") | null; + readonly security_severity_level?: ('low' | 'medium' | 'high' | 'critical') | null /** @description A short description of the rule used to detect the alert. */ - readonly description?: string; + readonly description?: string /** @description description of the rule used to detect the alert. */ - readonly full_description?: string; + readonly full_description?: string /** @description A set of tags applicable for the rule. */ - readonly tags?: readonly string[] | null; + readonly tags?: readonly string[] | null /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */ - readonly help?: string | null; - }; + readonly help?: string | null + } /** @description The name of the tool used to generate the code scanning analysis. */ - readonly "code-scanning-analysis-tool-name": string; + readonly 'code-scanning-analysis-tool-name': string /** @description The version of the tool used to generate the code scanning analysis. */ - readonly "code-scanning-analysis-tool-version": string | null; + readonly 'code-scanning-analysis-tool-version': string | null /** @description The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. */ - readonly "code-scanning-analysis-tool-guid": string | null; - readonly "code-scanning-analysis-tool": { - readonly name?: components["schemas"]["code-scanning-analysis-tool-name"]; - readonly version?: components["schemas"]["code-scanning-analysis-tool-version"]; - readonly guid?: components["schemas"]["code-scanning-analysis-tool-guid"]; - }; + readonly 'code-scanning-analysis-tool-guid': string | null + readonly 'code-scanning-analysis-tool': { + readonly name?: components['schemas']['code-scanning-analysis-tool-name'] + readonly version?: components['schemas']['code-scanning-analysis-tool-version'] + readonly guid?: components['schemas']['code-scanning-analysis-tool-guid'] + } /** * @description The full Git reference, formatted as `refs/heads/`, * `refs/pull//merge`, or `refs/pull//head`. */ - readonly "code-scanning-ref": string; + readonly 'code-scanning-ref': string /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - readonly "code-scanning-analysis-analysis-key": string; + readonly 'code-scanning-analysis-analysis-key': string /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - readonly "code-scanning-alert-environment": string; + readonly 'code-scanning-alert-environment': string /** @description Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code. */ - readonly "code-scanning-analysis-category": string; + readonly 'code-scanning-analysis-category': string /** @description Describe a region within a file for the alert. */ - readonly "code-scanning-alert-location": { - readonly path?: string; - readonly start_line?: number; - readonly end_line?: number; - readonly start_column?: number; - readonly end_column?: number; - }; + readonly 'code-scanning-alert-location': { + readonly path?: string + readonly start_line?: number + readonly end_line?: number + readonly start_column?: number + readonly end_column?: number + } /** * @description A classification of the file. For example to identify it as generated. * @enum {string|null} */ - readonly "code-scanning-alert-classification": ("source" | "generated" | "test" | "library") | null; - readonly "code-scanning-alert-instance": { - readonly ref?: components["schemas"]["code-scanning-ref"]; - readonly analysis_key?: components["schemas"]["code-scanning-analysis-analysis-key"]; - readonly environment?: components["schemas"]["code-scanning-alert-environment"]; - readonly category?: components["schemas"]["code-scanning-analysis-category"]; - readonly state?: components["schemas"]["code-scanning-alert-state"]; - readonly commit_sha?: string; + readonly 'code-scanning-alert-classification': ('source' | 'generated' | 'test' | 'library') | null + readonly 'code-scanning-alert-instance': { + readonly ref?: components['schemas']['code-scanning-ref'] + readonly analysis_key?: components['schemas']['code-scanning-analysis-analysis-key'] + readonly environment?: components['schemas']['code-scanning-alert-environment'] + readonly category?: components['schemas']['code-scanning-analysis-category'] + readonly state?: components['schemas']['code-scanning-alert-state'] + readonly commit_sha?: string readonly message?: { - readonly text?: string; - }; - readonly location?: components["schemas"]["code-scanning-alert-location"]; - readonly html_url?: string; + readonly text?: string + } + readonly location?: components['schemas']['code-scanning-alert-location'] + readonly html_url?: string /** * @description Classifications that have been applied to the file that triggered the alert. * For example identifying it as documentation, or a generated file. */ - readonly classifications?: readonly components["schemas"]["code-scanning-alert-classification"][]; - }; - readonly "code-scanning-organization-alert-items": { - readonly number: components["schemas"]["alert-number"]; - readonly created_at: components["schemas"]["alert-created-at"]; - readonly updated_at?: components["schemas"]["alert-updated-at"]; - readonly url: components["schemas"]["alert-url"]; - readonly html_url: components["schemas"]["alert-html-url"]; - readonly instances_url: components["schemas"]["alert-instances-url"]; - readonly state: components["schemas"]["code-scanning-alert-state"]; - readonly fixed_at?: components["schemas"]["code-scanning-alert-fixed-at"]; - readonly dismissed_by: components["schemas"]["nullable-simple-user"]; - readonly dismissed_at: components["schemas"]["code-scanning-alert-dismissed-at"]; - readonly dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"]; - readonly rule: components["schemas"]["code-scanning-alert-rule"]; - readonly tool: components["schemas"]["code-scanning-analysis-tool"]; - readonly most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; - readonly repository: components["schemas"]["minimal-repository"]; - }; + readonly classifications?: readonly components['schemas']['code-scanning-alert-classification'][] + } + readonly 'code-scanning-organization-alert-items': { + readonly number: components['schemas']['alert-number'] + readonly created_at: components['schemas']['alert-created-at'] + readonly updated_at?: components['schemas']['alert-updated-at'] + readonly url: components['schemas']['alert-url'] + readonly html_url: components['schemas']['alert-html-url'] + readonly instances_url: components['schemas']['alert-instances-url'] + readonly state: components['schemas']['code-scanning-alert-state'] + readonly fixed_at?: components['schemas']['code-scanning-alert-fixed-at'] + readonly dismissed_by: components['schemas']['nullable-simple-user'] + readonly dismissed_at: components['schemas']['code-scanning-alert-dismissed-at'] + readonly dismissed_reason: components['schemas']['code-scanning-alert-dismissed-reason'] + readonly rule: components['schemas']['code-scanning-alert-rule'] + readonly tool: components['schemas']['code-scanning-analysis-tool'] + readonly most_recent_instance: components['schemas']['code-scanning-alert-instance'] + readonly repository: components['schemas']['minimal-repository'] + } /** * Credential Authorization * @description Credential Authorization */ - readonly "credential-authorization": { + readonly 'credential-authorization': { /** * @description User login that owns the underlying credential. * @example monalisa */ - readonly login: string; + readonly login: string /** * @description Unique identifier for the credential. * @example 1 */ - readonly credential_id: number; + readonly credential_id: number /** * @description Human-readable description of the credential type. * @example SSH Key */ - readonly credential_type: string; + readonly credential_type: string /** * @description Last eight characters of the credential. Only included in responses with credential_type of personal access token. * @example 12345678 */ - readonly token_last_eight?: string; + readonly token_last_eight?: string /** * Format: date-time * @description Date when the credential was authorized for use. * @example 2011-01-26T19:06:43Z */ - readonly credential_authorized_at: string; + readonly credential_authorized_at: string /** * @description List of oauth scopes the token has been granted. * @example user,repo */ - readonly scopes?: readonly string[]; + readonly scopes?: readonly string[] /** * @description Unique string to distinguish the credential. Only included in responses with credential_type of SSH Key. * @example jklmnop12345678 */ - readonly fingerprint?: string; + readonly fingerprint?: string /** * Format: date-time * @description Date when the credential was last accessed. May be null if it was never accessed * @example 2011-01-26T19:06:43Z */ - readonly credential_accessed_at: string | null; + readonly credential_accessed_at: string | null /** @example 12345678 */ - readonly authorized_credential_id: number | null; + readonly authorized_credential_id: number | null /** * @description The title given to the ssh key. This will only be present when the credential is an ssh key. * @example my ssh key */ - readonly authorized_credential_title?: string | null; + readonly authorized_credential_title?: string | null /** * @description The note given to the token. This will only be present when the credential is a token. * @example my token */ - readonly authorized_credential_note?: string | null; + readonly authorized_credential_note?: string | null /** * Format: date-time * @description The expiry for the token. This will only be present when the credential is a token. */ - readonly authorized_credential_expires_at?: string | null; - }; + readonly authorized_credential_expires_at?: string | null + } /** * Dependabot Secret for an Organization * @description Secrets for GitHub Dependabot for an organization. */ - readonly "organization-dependabot-secret": { + readonly 'organization-dependabot-secret': { /** * @description The name of the secret. * @example SECRET_TOKEN */ - readonly name: string; + readonly name: string /** Format: date-time */ - readonly created_at: string; + readonly created_at: string /** Format: date-time */ - readonly updated_at: string; + readonly updated_at: string /** * @description Visibility of a secret * @enum {string} */ - readonly visibility: "all" | "private" | "selected"; + readonly visibility: 'all' | 'private' | 'selected' /** * Format: uri * @example https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories */ - readonly selected_repositories_url?: string; - }; + readonly selected_repositories_url?: string + } /** * DependabotPublicKey * @description The public key used for setting Dependabot Secrets. */ - readonly "dependabot-public-key": { + readonly 'dependabot-public-key': { /** * @description The identifier for the key. * @example 1234567 */ - readonly key_id: string; + readonly key_id: string /** * @description The Base64 encoded public key. * @example hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= */ - readonly key: string; - }; + readonly key: string + } /** * ExternalGroup * @description Information about an external group's usage and its members */ - readonly "external-group": { + readonly 'external-group': { /** * @description The internal ID of the group * @example 1 */ - readonly group_id: number; + readonly group_id: number /** * @description The display name for the group * @example group-azuread-test */ - readonly group_name: string; + readonly group_name: string /** * @description The date when the group was last updated_at * @example 2021-01-03 22:27:15:000 -700 */ - readonly updated_at?: string; + readonly updated_at?: string /** * @description An array of teams linked to this group * @example [object Object],[object Object] @@ -9594,13 +9582,13 @@ export interface components { * @description The id for a team * @example 1 */ - readonly team_id: number; + readonly team_id: number /** * @description The name of the team * @example team-test */ - readonly team_name: string; - }[]; + readonly team_name: string + }[] /** * @description An array of external members linked to this group * @example [object Object],[object Object] @@ -9610,493 +9598,493 @@ export interface components { * @description The internal user ID of the identity * @example 1 */ - readonly member_id: number; + readonly member_id: number /** * @description The handle/login for the user * @example mona-lisa_eocsaxrs */ - readonly member_login: string; + readonly member_login: string /** * @description The user display name/profile name * @example Mona Lisa */ - readonly member_name: string; + readonly member_name: string /** * @description An email attached to a user * @example mona_lisa@github.com */ - readonly member_email: string; - }[]; - }; + readonly member_email: string + }[] + } /** * Organization Invitation * @description Organization Invitation */ - readonly "organization-invitation": { - readonly id: number; - readonly login: string | null; - readonly email: string | null; - readonly role: string; - readonly created_at: string; - readonly failed_at?: string | null; - readonly failed_reason?: string | null; - readonly inviter: components["schemas"]["simple-user"]; - readonly team_count: number; + readonly 'organization-invitation': { + readonly id: number + readonly login: string | null + readonly email: string | null + readonly role: string + readonly created_at: string + readonly failed_at?: string | null + readonly failed_reason?: string | null + readonly inviter: components['schemas']['simple-user'] + readonly team_count: number /** @example "MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x" */ - readonly node_id: string; + readonly node_id: string /** @example "https://api.github.com/organizations/16/invitations/1/teams" */ - readonly invitation_teams_url: string; - }; + readonly invitation_teams_url: string + } /** * Org Hook * @description Org Hook */ - readonly "org-hook": { + readonly 'org-hook': { /** @example 1 */ - readonly id: number; + readonly id: number /** * Format: uri * @example https://api.github.com/orgs/octocat/hooks/1 */ - readonly url: string; + readonly url: string /** * Format: uri * @example https://api.github.com/orgs/octocat/hooks/1/pings */ - readonly ping_url: string; + readonly ping_url: string /** * Format: uri * @example https://api.github.com/orgs/octocat/hooks/1/deliveries */ - readonly deliveries_url?: string; + readonly deliveries_url?: string /** @example web */ - readonly name: string; + readonly name: string /** @example push,pull_request */ - readonly events: readonly string[]; + readonly events: readonly string[] /** @example true */ - readonly active: boolean; + readonly active: boolean readonly config: { /** @example "http://example.com/2" */ - readonly url?: string; + readonly url?: string /** @example "0" */ - readonly insecure_ssl?: string; + readonly insecure_ssl?: string /** @example "form" */ - readonly content_type?: string; + readonly content_type?: string /** @example "********" */ - readonly secret?: string; - }; + readonly secret?: string + } /** * Format: date-time * @example 2011-09-06T20:39:23Z */ - readonly updated_at: string; + readonly updated_at: string /** * Format: date-time * @example 2011-09-06T17:26:27Z */ - readonly created_at: string; - readonly type: string; - }; + readonly created_at: string + readonly type: string + } /** * @description The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. Can be one of: `existing_users`, `contributors_only`, `collaborators_only`. * @example collaborators_only * @enum {string} */ - readonly "interaction-group": "existing_users" | "contributors_only" | "collaborators_only"; + readonly 'interaction-group': 'existing_users' | 'contributors_only' | 'collaborators_only' /** * Interaction Limits * @description Interaction limit settings. */ - readonly "interaction-limit-response": { - readonly limit: components["schemas"]["interaction-group"]; + readonly 'interaction-limit-response': { + readonly limit: components['schemas']['interaction-group'] /** @example repository */ - readonly origin: string; + readonly origin: string /** * Format: date-time * @example 2018-08-17T04:18:39Z */ - readonly expires_at: string; - }; + readonly expires_at: string + } /** * @description The duration of the interaction restriction. Can be one of: `one_day`, `three_days`, `one_week`, `one_month`, `six_months`. Default: `one_day`. * @example one_month * @enum {string} */ - readonly "interaction-expiry": "one_day" | "three_days" | "one_week" | "one_month" | "six_months"; + readonly 'interaction-expiry': 'one_day' | 'three_days' | 'one_week' | 'one_month' | 'six_months' /** * Interaction Restrictions * @description Limit interactions to a specific type of user for a specified duration */ - readonly "interaction-limit": { - readonly limit: components["schemas"]["interaction-group"]; - readonly expiry?: components["schemas"]["interaction-expiry"]; - }; + readonly 'interaction-limit': { + readonly limit: components['schemas']['interaction-group'] + readonly expiry?: components['schemas']['interaction-expiry'] + } /** * Team Simple * @description Groups of organization members that gives permissions on specified repositories. */ - readonly "nullable-team-simple": { + readonly 'nullable-team-simple': { /** * @description Unique identifier of the team * @example 1 */ - readonly id: number; + readonly id: number /** @example MDQ6VGVhbTE= */ - readonly node_id: string; + readonly node_id: string /** * Format: uri * @description URL for the team * @example https://api.github.com/organizations/1/team/1 */ - readonly url: string; + readonly url: string /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - readonly members_url: string; + readonly members_url: string /** * @description Name of the team * @example Justice League */ - readonly name: string; + readonly name: string /** * @description Description of the team * @example A great team. */ - readonly description: string | null; + readonly description: string | null /** * @description Permission that the team will have for its repositories * @example admin */ - readonly permission: string; + readonly permission: string /** * @description The level of privacy this team should have * @example closed */ - readonly privacy?: string; + readonly privacy?: string /** * Format: uri * @example https://github.com/orgs/rails/teams/core */ - readonly html_url: string; + readonly html_url: string /** * Format: uri * @example https://api.github.com/organizations/1/team/1/repos */ - readonly repositories_url: string; + readonly repositories_url: string /** @example justice-league */ - readonly slug: string; + readonly slug: string /** * @description Distinguished Name (DN) that team maps to within LDAP environment * @example uid=example,ou=users,dc=github,dc=com */ - readonly ldap_dn?: string; - } | null; + readonly ldap_dn?: string + } | null /** * Team * @description Groups of organization members that gives permissions on specified repositories. */ readonly team: { - readonly id: number; - readonly node_id: string; - readonly name: string; - readonly slug: string; - readonly description: string | null; - readonly privacy?: string; - readonly permission: string; + readonly id: number + readonly node_id: string + readonly name: string + readonly slug: string + readonly description: string | null + readonly privacy?: string + readonly permission: string readonly permissions?: { - readonly pull: boolean; - readonly triage: boolean; - readonly push: boolean; - readonly maintain: boolean; - readonly admin: boolean; - }; + readonly pull: boolean + readonly triage: boolean + readonly push: boolean + readonly maintain: boolean + readonly admin: boolean + } /** Format: uri */ - readonly url: string; + readonly url: string /** * Format: uri * @example https://github.com/orgs/rails/teams/core */ - readonly html_url: string; - readonly members_url: string; + readonly html_url: string + readonly members_url: string /** Format: uri */ - readonly repositories_url: string; - readonly parent: components["schemas"]["nullable-team-simple"]; - }; + readonly repositories_url: string + readonly parent: components['schemas']['nullable-team-simple'] + } /** * Org Membership * @description Org Membership */ - readonly "org-membership": { + readonly 'org-membership': { /** * Format: uri * @example https://api.github.com/orgs/octocat/memberships/defunkt */ - readonly url: string; + readonly url: string /** * @description The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation. * @example active * @enum {string} */ - readonly state: "active" | "pending"; + readonly state: 'active' | 'pending' /** * @description The user's membership type in the organization. * @example admin * @enum {string} */ - readonly role: "admin" | "member" | "billing_manager"; + readonly role: 'admin' | 'member' | 'billing_manager' /** * Format: uri * @example https://api.github.com/orgs/octocat */ - readonly organization_url: string; - readonly organization: components["schemas"]["organization-simple"]; - readonly user: components["schemas"]["nullable-simple-user"]; + readonly organization_url: string + readonly organization: components['schemas']['organization-simple'] + readonly user: components['schemas']['nullable-simple-user'] readonly permissions?: { - readonly can_create_repository: boolean; - }; - }; + readonly can_create_repository: boolean + } + } /** * Migration * @description A migration. */ readonly migration: { /** @example 79 */ - readonly id: number; - readonly owner: components["schemas"]["nullable-simple-user"]; + readonly id: number + readonly owner: components['schemas']['nullable-simple-user'] /** @example 0b989ba4-242f-11e5-81e1-c7b6966d2516 */ - readonly guid: string; + readonly guid: string /** @example pending */ - readonly state: string; + readonly state: string /** @example true */ - readonly lock_repositories: boolean; - readonly exclude_metadata: boolean; - readonly exclude_git_data: boolean; - readonly exclude_attachments: boolean; - readonly exclude_releases: boolean; - readonly exclude_owner_projects: boolean; - readonly repositories: readonly components["schemas"]["repository"][]; + readonly lock_repositories: boolean + readonly exclude_metadata: boolean + readonly exclude_git_data: boolean + readonly exclude_attachments: boolean + readonly exclude_releases: boolean + readonly exclude_owner_projects: boolean + readonly repositories: readonly components['schemas']['repository'][] /** * Format: uri * @example https://api.github.com/orgs/octo-org/migrations/79 */ - readonly url: string; + readonly url: string /** * Format: date-time * @example 2015-07-06T15:33:38-07:00 */ - readonly created_at: string; + readonly created_at: string /** * Format: date-time * @example 2015-07-06T15:33:38-07:00 */ - readonly updated_at: string; - readonly node_id: string; + readonly updated_at: string + readonly node_id: string /** Format: uri */ - readonly archive_url?: string; - readonly exclude?: readonly unknown[]; - }; + readonly archive_url?: string + readonly exclude?: readonly unknown[] + } /** * Minimal Repository * @description Minimal Repository */ - readonly "nullable-minimal-repository": { + readonly 'nullable-minimal-repository': { /** @example 1296269 */ - readonly id: number; + readonly id: number /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - readonly node_id: string; + readonly node_id: string /** @example Hello-World */ - readonly name: string; + readonly name: string /** @example octocat/Hello-World */ - readonly full_name: string; - readonly owner: components["schemas"]["simple-user"]; - readonly private: boolean; + readonly full_name: string + readonly owner: components['schemas']['simple-user'] + readonly private: boolean /** * Format: uri * @example https://github.com/octocat/Hello-World */ - readonly html_url: string; + readonly html_url: string /** @example This your first repo! */ - readonly description: string | null; - readonly fork: boolean; + readonly description: string | null + readonly fork: boolean /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World */ - readonly url: string; + readonly url: string /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - readonly archive_url: string; + readonly archive_url: string /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - readonly assignees_url: string; + readonly assignees_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - readonly blobs_url: string; + readonly blobs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - readonly branches_url: string; + readonly branches_url: string /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - readonly collaborators_url: string; + readonly collaborators_url: string /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - readonly comments_url: string; + readonly comments_url: string /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - readonly commits_url: string; + readonly commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - readonly compare_url: string; + readonly compare_url: string /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - readonly contents_url: string; + readonly contents_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - readonly contributors_url: string; + readonly contributors_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - readonly deployments_url: string; + readonly deployments_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - readonly downloads_url: string; + readonly downloads_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events */ - readonly events_url: string; + readonly events_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ - readonly forks_url: string; + readonly forks_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - readonly git_commits_url: string; + readonly git_commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - readonly git_refs_url: string; + readonly git_refs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - readonly git_tags_url: string; - readonly git_url?: string; + readonly git_tags_url: string + readonly git_url?: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - readonly issue_comment_url: string; + readonly issue_comment_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - readonly issue_events_url: string; + readonly issue_events_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - readonly issues_url: string; + readonly issues_url: string /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - readonly keys_url: string; + readonly keys_url: string /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - readonly labels_url: string; + readonly labels_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ - readonly languages_url: string; + readonly languages_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ - readonly merges_url: string; + readonly merges_url: string /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - readonly milestones_url: string; + readonly milestones_url: string /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - readonly notifications_url: string; + readonly notifications_url: string /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - readonly pulls_url: string; + readonly pulls_url: string /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - readonly releases_url: string; - readonly ssh_url?: string; + readonly releases_url: string + readonly ssh_url?: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - readonly stargazers_url: string; + readonly stargazers_url: string /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - readonly statuses_url: string; + readonly statuses_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - readonly subscribers_url: string; + readonly subscribers_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - readonly subscription_url: string; + readonly subscription_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ - readonly tags_url: string; + readonly tags_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ - readonly teams_url: string; + readonly teams_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - readonly trees_url: string; - readonly clone_url?: string; - readonly mirror_url?: string | null; + readonly trees_url: string + readonly clone_url?: string + readonly mirror_url?: string | null /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - readonly hooks_url: string; - readonly svn_url?: string; - readonly homepage?: string | null; - readonly language?: string | null; - readonly forks_count?: number; - readonly stargazers_count?: number; - readonly watchers_count?: number; - readonly size?: number; - readonly default_branch?: string; - readonly open_issues_count?: number; - readonly is_template?: boolean; - readonly topics?: readonly string[]; - readonly has_issues?: boolean; - readonly has_projects?: boolean; - readonly has_wiki?: boolean; - readonly has_pages?: boolean; - readonly has_downloads?: boolean; - readonly archived?: boolean; - readonly disabled?: boolean; - readonly visibility?: string; + readonly hooks_url: string + readonly svn_url?: string + readonly homepage?: string | null + readonly language?: string | null + readonly forks_count?: number + readonly stargazers_count?: number + readonly watchers_count?: number + readonly size?: number + readonly default_branch?: string + readonly open_issues_count?: number + readonly is_template?: boolean + readonly topics?: readonly string[] + readonly has_issues?: boolean + readonly has_projects?: boolean + readonly has_wiki?: boolean + readonly has_pages?: boolean + readonly has_downloads?: boolean + readonly archived?: boolean + readonly disabled?: boolean + readonly visibility?: string /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - readonly pushed_at?: string | null; + readonly pushed_at?: string | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly created_at?: string | null; + readonly created_at?: string | null /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - readonly updated_at?: string | null; + readonly updated_at?: string | null readonly permissions?: { - readonly admin?: boolean; - readonly maintain?: boolean; - readonly push?: boolean; - readonly triage?: boolean; - readonly pull?: boolean; - }; + readonly admin?: boolean + readonly maintain?: boolean + readonly push?: boolean + readonly triage?: boolean + readonly pull?: boolean + } /** @example admin */ - readonly role_name?: string; - readonly template_repository?: components["schemas"]["nullable-repository"]; - readonly temp_clone_token?: string; - readonly delete_branch_on_merge?: boolean; - readonly subscribers_count?: number; - readonly network_count?: number; - readonly code_of_conduct?: components["schemas"]["code-of-conduct"]; + readonly role_name?: string + readonly template_repository?: components['schemas']['nullable-repository'] + readonly temp_clone_token?: string + readonly delete_branch_on_merge?: boolean + readonly subscribers_count?: number + readonly network_count?: number + readonly code_of_conduct?: components['schemas']['code-of-conduct'] readonly license?: { - readonly key?: string; - readonly name?: string; - readonly spdx_id?: string; - readonly url?: string; - readonly node_id?: string; - } | null; - readonly forks?: number; - readonly open_issues?: number; - readonly watchers?: number; - readonly allow_forking?: boolean; - } | null; + readonly key?: string + readonly name?: string + readonly spdx_id?: string + readonly url?: string + readonly node_id?: string + } | null + readonly forks?: number + readonly open_issues?: number + readonly watchers?: number + readonly allow_forking?: boolean + } | null /** * Package * @description A software package @@ -10106,96 +10094,96 @@ export interface components { * @description Unique identifier of the package. * @example 1 */ - readonly id: number; + readonly id: number /** * @description The name of the package. * @example super-linter */ - readonly name: string; + readonly name: string /** * @example docker * @enum {string} */ - readonly package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + readonly package_type: 'npm' | 'maven' | 'rubygems' | 'docker' | 'nuget' | 'container' /** @example https://api.github.com/orgs/github/packages/container/super-linter */ - readonly url: string; + readonly url: string /** @example https://github.com/orgs/github/packages/container/package/super-linter */ - readonly html_url: string; + readonly html_url: string /** * @description The number of versions of the package. * @example 1 */ - readonly version_count: number; + readonly version_count: number /** * @example private * @enum {string} */ - readonly visibility: "private" | "public"; - readonly owner?: components["schemas"]["nullable-simple-user"]; - readonly repository?: components["schemas"]["nullable-minimal-repository"]; + readonly visibility: 'private' | 'public' + readonly owner?: components['schemas']['nullable-simple-user'] + readonly repository?: components['schemas']['nullable-minimal-repository'] /** Format: date-time */ - readonly created_at: string; + readonly created_at: string /** Format: date-time */ - readonly updated_at: string; - }; + readonly updated_at: string + } /** * Package Version * @description A version of a software package */ - readonly "package-version": { + readonly 'package-version': { /** * @description Unique identifier of the package version. * @example 1 */ - readonly id: number; + readonly id: number /** * @description The name of the package version. * @example latest */ - readonly name: string; + readonly name: string /** @example https://api.github.com/orgs/github/packages/container/super-linter/versions/786068 */ - readonly url: string; + readonly url: string /** @example https://github.com/orgs/github/packages/container/package/super-linter */ - readonly package_html_url: string; + readonly package_html_url: string /** @example https://github.com/orgs/github/packages/container/super-linter/786068 */ - readonly html_url?: string; + readonly html_url?: string /** @example MIT */ - readonly license?: string; - readonly description?: string; + readonly license?: string + readonly description?: string /** * Format: date-time * @example 2011-04-10T20:09:31Z */ - readonly created_at: string; + readonly created_at: string /** * Format: date-time * @example 2014-03-03T18:58:10Z */ - readonly updated_at: string; + readonly updated_at: string /** * Format: date-time * @example 2014-03-03T18:58:10Z */ - readonly deleted_at?: string; + readonly deleted_at?: string /** Package Version Metadata */ readonly metadata?: { /** * @example docker * @enum {string} */ - readonly package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + readonly package_type: 'npm' | 'maven' | 'rubygems' | 'docker' | 'nuget' | 'container' /** Container Metadata */ readonly container?: { - readonly tags: readonly string[]; - }; + readonly tags: readonly string[] + } /** Docker Metadata */ readonly docker?: { - readonly tag?: readonly string[]; + readonly tag?: readonly string[] } & { - tags: unknown; - }; - }; - }; + tags: unknown + } + } + } /** * Project * @description Projects are a way to organize columns and cards of work. @@ -10205,67 +10193,67 @@ export interface components { * Format: uri * @example https://api.github.com/repos/api-playground/projects-test */ - readonly owner_url: string; + readonly owner_url: string /** * Format: uri * @example https://api.github.com/projects/1002604 */ - readonly url: string; + readonly url: string /** * Format: uri * @example https://github.com/api-playground/projects-test/projects/12 */ - readonly html_url: string; + readonly html_url: string /** * Format: uri * @example https://api.github.com/projects/1002604/columns */ - readonly columns_url: string; + readonly columns_url: string /** @example 1002604 */ - readonly id: number; + readonly id: number /** @example MDc6UHJvamVjdDEwMDI2MDQ= */ - readonly node_id: string; + readonly node_id: string /** * @description Name of the project * @example Week One Sprint */ - readonly name: string; + readonly name: string /** * @description Body of the project * @example This project represents the sprint of the first week in January */ - readonly body: string | null; + readonly body: string | null /** @example 1 */ - readonly number: number; + readonly number: number /** * @description State of the project; either 'open' or 'closed' * @example open */ - readonly state: string; - readonly creator: components["schemas"]["nullable-simple-user"]; + readonly state: string + readonly creator: components['schemas']['nullable-simple-user'] /** * Format: date-time * @example 2011-04-10T20:09:31Z */ - readonly created_at: string; + readonly created_at: string /** * Format: date-time * @example 2014-03-03T18:58:10Z */ - readonly updated_at: string; + readonly updated_at: string /** * @description The baseline permission that all organization members have on this project. Only present if owner is an organization. * @enum {string} */ - readonly organization_permission?: "read" | "write" | "admin" | "none"; + readonly organization_permission?: 'read' | 'write' | 'admin' | 'none' /** @description Whether or not this project can be seen by everyone. Only present if owner is an organization. */ - readonly private?: boolean; - }; + readonly private?: boolean + } /** * GroupMapping * @description External Groups to be mapped to a team for membership */ - readonly "group-mapping": { + readonly 'group-mapping': { /** * @description Array of groups to be mapped to this team * @example [object Object],[object Object] @@ -10275,1012 +10263,1012 @@ export interface components { * @description The ID of the group * @example 111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa */ - readonly group_id: string; + readonly group_id: string /** * @description The name of the group * @example saml-azuread-test */ - readonly group_name: string; + readonly group_name: string /** * @description a description of the group * @example A group of Developers working on AzureAD SAML SSO */ - readonly group_description: string; + readonly group_description: string /** * @description synchronization status for this group mapping * @example unsynced */ - readonly status?: string; + readonly status?: string /** * @description the time of the last sync for this group-mapping * @example 2019-06-03 22:27:15:000 -700 */ - readonly synced_at?: string | null; - }[]; - }; + readonly synced_at?: string | null + }[] + } /** * Full Team * @description Groups of organization members that gives permissions on specified repositories. */ - readonly "team-full": { + readonly 'team-full': { /** * @description Unique identifier of the team * @example 42 */ - readonly id: number; + readonly id: number /** @example MDQ6VGVhbTE= */ - readonly node_id: string; + readonly node_id: string /** * Format: uri * @description URL for the team * @example https://api.github.com/organizations/1/team/1 */ - readonly url: string; + readonly url: string /** * Format: uri * @example https://github.com/orgs/rails/teams/core */ - readonly html_url: string; + readonly html_url: string /** * @description Name of the team * @example Developers */ - readonly name: string; + readonly name: string /** @example justice-league */ - readonly slug: string; + readonly slug: string /** @example A great team. */ - readonly description: string | null; + readonly description: string | null /** * @description The level of privacy this team should have * @example closed * @enum {string} */ - readonly privacy?: "closed" | "secret"; + readonly privacy?: 'closed' | 'secret' /** * @description Permission that the team will have for its repositories * @example push */ - readonly permission: string; + readonly permission: string /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - readonly members_url: string; + readonly members_url: string /** * Format: uri * @example https://api.github.com/organizations/1/team/1/repos */ - readonly repositories_url: string; - readonly parent?: components["schemas"]["nullable-team-simple"]; + readonly repositories_url: string + readonly parent?: components['schemas']['nullable-team-simple'] /** @example 3 */ - readonly members_count: number; + readonly members_count: number /** @example 10 */ - readonly repos_count: number; + readonly repos_count: number /** * Format: date-time * @example 2017-07-14T16:53:42Z */ - readonly created_at: string; + readonly created_at: string /** * Format: date-time * @example 2017-08-17T12:37:15Z */ - readonly updated_at: string; - readonly organization: components["schemas"]["organization-full"]; + readonly updated_at: string + readonly organization: components['schemas']['organization-full'] /** * @description Distinguished Name (DN) that team maps to within LDAP environment * @example uid=example,ou=users,dc=github,dc=com */ - readonly ldap_dn?: string; - }; + readonly ldap_dn?: string + } /** * Team Discussion * @description A team discussion is a persistent record of a free-form conversation within a team. */ - readonly "team-discussion": { - readonly author: components["schemas"]["nullable-simple-user"]; + readonly 'team-discussion': { + readonly author: components['schemas']['nullable-simple-user'] /** * @description The main text of the discussion. * @example Please suggest improvements to our workflow in comments. */ - readonly body: string; + readonly body: string /** @example

Hi! This is an area for us to collaborate as a team

*/ - readonly body_html: string; + readonly body_html: string /** * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server. * @example 0307116bbf7ced493b8d8a346c650b71 */ - readonly body_version: string; - readonly comments_count: number; + readonly body_version: string + readonly comments_count: number /** * Format: uri * @example https://api.github.com/organizations/1/team/2343027/discussions/1/comments */ - readonly comments_url: string; + readonly comments_url: string /** * Format: date-time * @example 2018-01-25T18:56:31Z */ - readonly created_at: string; + readonly created_at: string /** Format: date-time */ - readonly last_edited_at: string | null; + readonly last_edited_at: string | null /** * Format: uri * @example https://github.com/orgs/github/teams/justice-league/discussions/1 */ - readonly html_url: string; + readonly html_url: string /** @example MDE0OlRlYW1EaXNjdXNzaW9uMQ== */ - readonly node_id: string; + readonly node_id: string /** * @description The unique sequence number of a team discussion. * @example 42 */ - readonly number: number; + readonly number: number /** * @description Whether or not this discussion should be pinned for easy retrieval. * @example true */ - readonly pinned: boolean; + readonly pinned: boolean /** * @description Whether or not this discussion should be restricted to team members and organization administrators. * @example true */ - readonly private: boolean; + readonly private: boolean /** * Format: uri * @example https://api.github.com/organizations/1/team/2343027 */ - readonly team_url: string; + readonly team_url: string /** * @description The title of the discussion. * @example How can we improve our workflow? */ - readonly title: string; + readonly title: string /** * Format: date-time * @example 2018-01-25T18:56:31Z */ - readonly updated_at: string; + readonly updated_at: string /** * Format: uri * @example https://api.github.com/organizations/1/team/2343027/discussions/1 */ - readonly url: string; - readonly reactions?: components["schemas"]["reaction-rollup"]; - }; + readonly url: string + readonly reactions?: components['schemas']['reaction-rollup'] + } /** * Team Discussion Comment * @description A reply to a discussion within a team. */ - readonly "team-discussion-comment": { - readonly author: components["schemas"]["nullable-simple-user"]; + readonly 'team-discussion-comment': { + readonly author: components['schemas']['nullable-simple-user'] /** * @description The main text of the comment. * @example I agree with this suggestion. */ - readonly body: string; + readonly body: string /** @example

Do you like apples?

*/ - readonly body_html: string; + readonly body_html: string /** * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server. * @example 0307116bbf7ced493b8d8a346c650b71 */ - readonly body_version: string; + readonly body_version: string /** * Format: date-time * @example 2018-01-15T23:53:58Z */ - readonly created_at: string; + readonly created_at: string /** Format: date-time */ - readonly last_edited_at: string | null; + readonly last_edited_at: string | null /** * Format: uri * @example https://api.github.com/organizations/1/team/2403582/discussions/1 */ - readonly discussion_url: string; + readonly discussion_url: string /** * Format: uri * @example https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 */ - readonly html_url: string; + readonly html_url: string /** @example MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= */ - readonly node_id: string; + readonly node_id: string /** * @description The unique sequence number of a team discussion comment. * @example 42 */ - readonly number: number; + readonly number: number /** * Format: date-time * @example 2018-01-15T23:53:58Z */ - readonly updated_at: string; + readonly updated_at: string /** * Format: uri * @example https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 */ - readonly url: string; - readonly reactions?: components["schemas"]["reaction-rollup"]; - }; + readonly url: string + readonly reactions?: components['schemas']['reaction-rollup'] + } /** * Reaction * @description Reactions to conversations provide a way to help people express their feelings more simply and effectively. */ readonly reaction: { /** @example 1 */ - readonly id: number; + readonly id: number /** @example MDg6UmVhY3Rpb24x */ - readonly node_id: string; - readonly user: components["schemas"]["nullable-simple-user"]; + readonly node_id: string + readonly user: components['schemas']['nullable-simple-user'] /** * @description The reaction to use * @example heart * @enum {string} */ - readonly content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + readonly content: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' /** * Format: date-time * @example 2016-05-20T20:09:31Z */ - readonly created_at: string; - }; + readonly created_at: string + } /** * Team Membership * @description Team Membership */ - readonly "team-membership": { + readonly 'team-membership': { /** Format: uri */ - readonly url: string; + readonly url: string /** * @description The role of the user in the team. * @default member * @example member * @enum {string} */ - readonly role: "member" | "maintainer"; + readonly role: 'member' | 'maintainer' /** * @description The state of the user's membership in the team. * @enum {string} */ - readonly state: "active" | "pending"; - }; + readonly state: 'active' | 'pending' + } /** * Team Project * @description A team's access to a project. */ - readonly "team-project": { - readonly owner_url: string; - readonly url: string; - readonly html_url: string; - readonly columns_url: string; - readonly id: number; - readonly node_id: string; - readonly name: string; - readonly body: string | null; - readonly number: number; - readonly state: string; - readonly creator: components["schemas"]["simple-user"]; - readonly created_at: string; - readonly updated_at: string; + readonly 'team-project': { + readonly owner_url: string + readonly url: string + readonly html_url: string + readonly columns_url: string + readonly id: number + readonly node_id: string + readonly name: string + readonly body: string | null + readonly number: number + readonly state: string + readonly creator: components['schemas']['simple-user'] + readonly created_at: string + readonly updated_at: string /** @description The organization permission for this project. Only present when owner is an organization. */ - readonly organization_permission?: string; + readonly organization_permission?: string /** @description Whether the project is private or not. Only present when owner is an organization. */ - readonly private?: boolean; + readonly private?: boolean readonly permissions: { - readonly read: boolean; - readonly write: boolean; - readonly admin: boolean; - }; - }; + readonly read: boolean + readonly write: boolean + readonly admin: boolean + } + } /** * Team Repository * @description A team's access to a repository. */ - readonly "team-repository": { + readonly 'team-repository': { /** * @description Unique identifier of the repository * @example 42 */ - readonly id: number; + readonly id: number /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - readonly node_id: string; + readonly node_id: string /** * @description The name of the repository. * @example Team Environment */ - readonly name: string; + readonly name: string /** @example octocat/Hello-World */ - readonly full_name: string; - readonly license: components["schemas"]["nullable-license-simple"]; - readonly forks: number; + readonly full_name: string + readonly license: components['schemas']['nullable-license-simple'] + readonly forks: number readonly permissions?: { - readonly admin: boolean; - readonly pull: boolean; - readonly triage?: boolean; - readonly push: boolean; - readonly maintain?: boolean; - }; + readonly admin: boolean + readonly pull: boolean + readonly triage?: boolean + readonly push: boolean + readonly maintain?: boolean + } /** @example admin */ - readonly role_name?: string; - readonly owner: components["schemas"]["nullable-simple-user"]; + readonly role_name?: string + readonly owner: components['schemas']['nullable-simple-user'] /** @description Whether the repository is private or public. */ - readonly private: boolean; + readonly private: boolean /** * Format: uri * @example https://github.com/octocat/Hello-World */ - readonly html_url: string; + readonly html_url: string /** @example This your first repo! */ - readonly description: string | null; - readonly fork: boolean; + readonly description: string | null + readonly fork: boolean /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World */ - readonly url: string; + readonly url: string /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - readonly archive_url: string; + readonly archive_url: string /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - readonly assignees_url: string; + readonly assignees_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - readonly blobs_url: string; + readonly blobs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - readonly branches_url: string; + readonly branches_url: string /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - readonly collaborators_url: string; + readonly collaborators_url: string /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - readonly comments_url: string; + readonly comments_url: string /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - readonly commits_url: string; + readonly commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - readonly compare_url: string; + readonly compare_url: string /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - readonly contents_url: string; + readonly contents_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - readonly contributors_url: string; + readonly contributors_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - readonly deployments_url: string; + readonly deployments_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - readonly downloads_url: string; + readonly downloads_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events */ - readonly events_url: string; + readonly events_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ - readonly forks_url: string; + readonly forks_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - readonly git_commits_url: string; + readonly git_commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - readonly git_refs_url: string; + readonly git_refs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - readonly git_tags_url: string; + readonly git_tags_url: string /** @example git:github.com/octocat/Hello-World.git */ - readonly git_url: string; + readonly git_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - readonly issue_comment_url: string; + readonly issue_comment_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - readonly issue_events_url: string; + readonly issue_events_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - readonly issues_url: string; + readonly issues_url: string /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - readonly keys_url: string; + readonly keys_url: string /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - readonly labels_url: string; + readonly labels_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ - readonly languages_url: string; + readonly languages_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ - readonly merges_url: string; + readonly merges_url: string /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - readonly milestones_url: string; + readonly milestones_url: string /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - readonly notifications_url: string; + readonly notifications_url: string /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - readonly pulls_url: string; + readonly pulls_url: string /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - readonly releases_url: string; + readonly releases_url: string /** @example git@github.com:octocat/Hello-World.git */ - readonly ssh_url: string; + readonly ssh_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - readonly stargazers_url: string; + readonly stargazers_url: string /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - readonly statuses_url: string; + readonly statuses_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - readonly subscribers_url: string; + readonly subscribers_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - readonly subscription_url: string; + readonly subscription_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ - readonly tags_url: string; + readonly tags_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ - readonly teams_url: string; + readonly teams_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - readonly trees_url: string; + readonly trees_url: string /** @example https://github.com/octocat/Hello-World.git */ - readonly clone_url: string; + readonly clone_url: string /** * Format: uri * @example git:git.example.com/octocat/Hello-World */ - readonly mirror_url: string | null; + readonly mirror_url: string | null /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - readonly hooks_url: string; + readonly hooks_url: string /** * Format: uri * @example https://svn.github.com/octocat/Hello-World */ - readonly svn_url: string; + readonly svn_url: string /** * Format: uri * @example https://github.com */ - readonly homepage: string | null; - readonly language: string | null; + readonly homepage: string | null + readonly language: string | null /** @example 9 */ - readonly forks_count: number; + readonly forks_count: number /** @example 80 */ - readonly stargazers_count: number; + readonly stargazers_count: number /** @example 80 */ - readonly watchers_count: number; + readonly watchers_count: number /** @example 108 */ - readonly size: number; + readonly size: number /** * @description The default branch of the repository. * @example master */ - readonly default_branch: string; - readonly open_issues_count: number; + readonly default_branch: string + readonly open_issues_count: number /** * @description Whether this repository acts as a template that can be used to generate new repositories. * @example true */ - readonly is_template?: boolean; - readonly topics?: readonly string[]; + readonly is_template?: boolean + readonly topics?: readonly string[] /** * @description Whether issues are enabled. * @default true * @example true */ - readonly has_issues: boolean; + readonly has_issues: boolean /** * @description Whether projects are enabled. * @default true * @example true */ - readonly has_projects: boolean; + readonly has_projects: boolean /** * @description Whether the wiki is enabled. * @default true * @example true */ - readonly has_wiki: boolean; - readonly has_pages: boolean; + readonly has_wiki: boolean + readonly has_pages: boolean /** * @description Whether downloads are enabled. * @default true * @example true */ - readonly has_downloads: boolean; + readonly has_downloads: boolean /** @description Whether the repository is archived. */ - readonly archived: boolean; + readonly archived: boolean /** @description Returns whether or not this repository disabled. */ - readonly disabled: boolean; + readonly disabled: boolean /** * @description The repository visibility: public, private, or internal. * @default public */ - readonly visibility?: string; + readonly visibility?: string /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - readonly pushed_at: string | null; + readonly pushed_at: string | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly created_at: string | null; + readonly created_at: string | null /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - readonly updated_at: string | null; + readonly updated_at: string | null /** * @description Whether to allow rebase merges for pull requests. * @default true * @example true */ - readonly allow_rebase_merge?: boolean; - readonly template_repository?: components["schemas"]["nullable-repository"]; - readonly temp_clone_token?: string; + readonly allow_rebase_merge?: boolean + readonly template_repository?: components['schemas']['nullable-repository'] + readonly temp_clone_token?: string /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - readonly allow_squash_merge?: boolean; + readonly allow_squash_merge?: boolean /** @description Whether to allow Auto-merge to be used on pull requests. */ - readonly allow_auto_merge?: boolean; + readonly allow_auto_merge?: boolean /** @description Whether to delete head branches when pull requests are merged */ - readonly delete_branch_on_merge?: boolean; + readonly delete_branch_on_merge?: boolean /** * @description Whether to allow merge commits for pull requests. * @default true * @example true */ - readonly allow_merge_commit?: boolean; + readonly allow_merge_commit?: boolean /** @description Whether to allow forking this repo */ - readonly allow_forking?: boolean; - readonly subscribers_count?: number; - readonly network_count?: number; - readonly open_issues: number; - readonly watchers: number; - readonly master_branch?: string; - }; + readonly allow_forking?: boolean + readonly subscribers_count?: number + readonly network_count?: number + readonly open_issues: number + readonly watchers: number + readonly master_branch?: string + } /** * Project Card * @description Project cards represent a scope of work. */ - readonly "project-card": { + readonly 'project-card': { /** * Format: uri * @example https://api.github.com/projects/columns/cards/1478 */ - readonly url: string; + readonly url: string /** * @description The project card's ID * @example 42 */ - readonly id: number; + readonly id: number /** @example MDExOlByb2plY3RDYXJkMTQ3OA== */ - readonly node_id: string; + readonly node_id: string /** @example Add payload for delete Project column */ - readonly note: string | null; - readonly creator: components["schemas"]["nullable-simple-user"]; + readonly note: string | null + readonly creator: components['schemas']['nullable-simple-user'] /** * Format: date-time * @example 2016-09-05T14:21:06Z */ - readonly created_at: string; + readonly created_at: string /** * Format: date-time * @example 2016-09-05T14:20:22Z */ - readonly updated_at: string; + readonly updated_at: string /** @description Whether or not the card is archived */ - readonly archived?: boolean; - readonly column_name?: string; - readonly project_id?: string; + readonly archived?: boolean + readonly column_name?: string + readonly project_id?: string /** * Format: uri * @example https://api.github.com/projects/columns/367 */ - readonly column_url: string; + readonly column_url: string /** * Format: uri * @example https://api.github.com/repos/api-playground/projects-test/issues/3 */ - readonly content_url?: string; + readonly content_url?: string /** * Format: uri * @example https://api.github.com/projects/120 */ - readonly project_url: string; - }; + readonly project_url: string + } /** * Project Column * @description Project columns contain cards of work. */ - readonly "project-column": { + readonly 'project-column': { /** * Format: uri * @example https://api.github.com/projects/columns/367 */ - readonly url: string; + readonly url: string /** * Format: uri * @example https://api.github.com/projects/120 */ - readonly project_url: string; + readonly project_url: string /** * Format: uri * @example https://api.github.com/projects/columns/367/cards */ - readonly cards_url: string; + readonly cards_url: string /** * @description The unique identifier of the project column * @example 42 */ - readonly id: number; + readonly id: number /** @example MDEzOlByb2plY3RDb2x1bW4zNjc= */ - readonly node_id: string; + readonly node_id: string /** * @description Name of the project column * @example Remaining tasks */ - readonly name: string; + readonly name: string /** * Format: date-time * @example 2016-09-05T14:18:44Z */ - readonly created_at: string; + readonly created_at: string /** * Format: date-time * @example 2016-09-05T14:22:28Z */ - readonly updated_at: string; - }; + readonly updated_at: string + } /** * Project Collaborator Permission * @description Project Collaborator Permission */ - readonly "project-collaborator-permission": { - readonly permission: string; - readonly user: components["schemas"]["nullable-simple-user"]; - }; + readonly 'project-collaborator-permission': { + readonly permission: string + readonly user: components['schemas']['nullable-simple-user'] + } /** Rate Limit */ - readonly "rate-limit": { - readonly limit: number; - readonly remaining: number; - readonly reset: number; - readonly used: number; - }; + readonly 'rate-limit': { + readonly limit: number + readonly remaining: number + readonly reset: number + readonly used: number + } /** * Rate Limit Overview * @description Rate Limit Overview */ - readonly "rate-limit-overview": { + readonly 'rate-limit-overview': { readonly resources: { - readonly core: components["schemas"]["rate-limit"]; - readonly graphql?: components["schemas"]["rate-limit"]; - readonly search: components["schemas"]["rate-limit"]; - readonly source_import?: components["schemas"]["rate-limit"]; - readonly integration_manifest?: components["schemas"]["rate-limit"]; - readonly code_scanning_upload?: components["schemas"]["rate-limit"]; - readonly actions_runner_registration?: components["schemas"]["rate-limit"]; - readonly scim?: components["schemas"]["rate-limit"]; - }; - readonly rate: components["schemas"]["rate-limit"]; - }; + readonly core: components['schemas']['rate-limit'] + readonly graphql?: components['schemas']['rate-limit'] + readonly search: components['schemas']['rate-limit'] + readonly source_import?: components['schemas']['rate-limit'] + readonly integration_manifest?: components['schemas']['rate-limit'] + readonly code_scanning_upload?: components['schemas']['rate-limit'] + readonly actions_runner_registration?: components['schemas']['rate-limit'] + readonly scim?: components['schemas']['rate-limit'] + } + readonly rate: components['schemas']['rate-limit'] + } /** * Code Of Conduct Simple * @description Code of Conduct Simple */ - readonly "code-of-conduct-simple": { + readonly 'code-of-conduct-simple': { /** * Format: uri * @example https://api.github.com/repos/github/docs/community/code_of_conduct */ - readonly url: string; + readonly url: string /** @example citizen_code_of_conduct */ - readonly key: string; + readonly key: string /** @example Citizen Code of Conduct */ - readonly name: string; + readonly name: string /** * Format: uri * @example https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md */ - readonly html_url: string | null; - }; + readonly html_url: string | null + } /** * Full Repository * @description Full Repository */ - readonly "full-repository": { + readonly 'full-repository': { /** @example 1296269 */ - readonly id: number; + readonly id: number /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - readonly node_id: string; + readonly node_id: string /** @example Hello-World */ - readonly name: string; + readonly name: string /** @example octocat/Hello-World */ - readonly full_name: string; - readonly owner: components["schemas"]["simple-user"]; - readonly private: boolean; + readonly full_name: string + readonly owner: components['schemas']['simple-user'] + readonly private: boolean /** * Format: uri * @example https://github.com/octocat/Hello-World */ - readonly html_url: string; + readonly html_url: string /** @example This your first repo! */ - readonly description: string | null; - readonly fork: boolean; + readonly description: string | null + readonly fork: boolean /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World */ - readonly url: string; + readonly url: string /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - readonly archive_url: string; + readonly archive_url: string /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - readonly assignees_url: string; + readonly assignees_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - readonly blobs_url: string; + readonly blobs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - readonly branches_url: string; + readonly branches_url: string /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - readonly collaborators_url: string; + readonly collaborators_url: string /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - readonly comments_url: string; + readonly comments_url: string /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - readonly commits_url: string; + readonly commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - readonly compare_url: string; + readonly compare_url: string /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - readonly contents_url: string; + readonly contents_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - readonly contributors_url: string; + readonly contributors_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - readonly deployments_url: string; + readonly deployments_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - readonly downloads_url: string; + readonly downloads_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events */ - readonly events_url: string; + readonly events_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ - readonly forks_url: string; + readonly forks_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - readonly git_commits_url: string; + readonly git_commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - readonly git_refs_url: string; + readonly git_refs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - readonly git_tags_url: string; + readonly git_tags_url: string /** @example git:github.com/octocat/Hello-World.git */ - readonly git_url: string; + readonly git_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - readonly issue_comment_url: string; + readonly issue_comment_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - readonly issue_events_url: string; + readonly issue_events_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - readonly issues_url: string; + readonly issues_url: string /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - readonly keys_url: string; + readonly keys_url: string /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - readonly labels_url: string; + readonly labels_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ - readonly languages_url: string; + readonly languages_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ - readonly merges_url: string; + readonly merges_url: string /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - readonly milestones_url: string; + readonly milestones_url: string /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - readonly notifications_url: string; + readonly notifications_url: string /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - readonly pulls_url: string; + readonly pulls_url: string /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - readonly releases_url: string; + readonly releases_url: string /** @example git@github.com:octocat/Hello-World.git */ - readonly ssh_url: string; + readonly ssh_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - readonly stargazers_url: string; + readonly stargazers_url: string /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - readonly statuses_url: string; + readonly statuses_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - readonly subscribers_url: string; + readonly subscribers_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - readonly subscription_url: string; + readonly subscription_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ - readonly tags_url: string; + readonly tags_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ - readonly teams_url: string; + readonly teams_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - readonly trees_url: string; + readonly trees_url: string /** @example https://github.com/octocat/Hello-World.git */ - readonly clone_url: string; + readonly clone_url: string /** * Format: uri * @example git:git.example.com/octocat/Hello-World */ - readonly mirror_url: string | null; + readonly mirror_url: string | null /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - readonly hooks_url: string; + readonly hooks_url: string /** * Format: uri * @example https://svn.github.com/octocat/Hello-World */ - readonly svn_url: string; + readonly svn_url: string /** * Format: uri * @example https://github.com */ - readonly homepage: string | null; - readonly language: string | null; + readonly homepage: string | null + readonly language: string | null /** @example 9 */ - readonly forks_count: number; + readonly forks_count: number /** @example 80 */ - readonly stargazers_count: number; + readonly stargazers_count: number /** @example 80 */ - readonly watchers_count: number; + readonly watchers_count: number /** @example 108 */ - readonly size: number; + readonly size: number /** @example master */ - readonly default_branch: string; - readonly open_issues_count: number; + readonly default_branch: string + readonly open_issues_count: number /** @example true */ - readonly is_template?: boolean; + readonly is_template?: boolean /** @example octocat,atom,electron,API */ - readonly topics?: readonly string[]; + readonly topics?: readonly string[] /** @example true */ - readonly has_issues: boolean; + readonly has_issues: boolean /** @example true */ - readonly has_projects: boolean; + readonly has_projects: boolean /** @example true */ - readonly has_wiki: boolean; - readonly has_pages: boolean; + readonly has_wiki: boolean + readonly has_pages: boolean /** @example true */ - readonly has_downloads: boolean; - readonly archived: boolean; + readonly has_downloads: boolean + readonly archived: boolean /** @description Returns whether or not this repository disabled. */ - readonly disabled: boolean; + readonly disabled: boolean /** * @description The repository visibility: public, private, or internal. * @example public */ - readonly visibility?: string; + readonly visibility?: string /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - readonly pushed_at: string; + readonly pushed_at: string /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly created_at: string; + readonly created_at: string /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - readonly updated_at: string; + readonly updated_at: string readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly push: boolean; - readonly triage?: boolean; - readonly pull: boolean; - }; + readonly admin: boolean + readonly maintain?: boolean + readonly push: boolean + readonly triage?: boolean + readonly pull: boolean + } /** @example true */ - readonly allow_rebase_merge?: boolean; - readonly template_repository?: components["schemas"]["nullable-repository"]; - readonly temp_clone_token?: string | null; + readonly allow_rebase_merge?: boolean + readonly template_repository?: components['schemas']['nullable-repository'] + readonly temp_clone_token?: string | null /** @example true */ - readonly allow_squash_merge?: boolean; - readonly allow_auto_merge?: boolean; - readonly delete_branch_on_merge?: boolean; + readonly allow_squash_merge?: boolean + readonly allow_auto_merge?: boolean + readonly delete_branch_on_merge?: boolean /** @example true */ - readonly allow_merge_commit?: boolean; + readonly allow_merge_commit?: boolean /** @example true */ - readonly allow_forking?: boolean; + readonly allow_forking?: boolean /** @example 42 */ - readonly subscribers_count: number; - readonly network_count: number; - readonly license: components["schemas"]["nullable-license-simple"]; - readonly organization?: components["schemas"]["nullable-simple-user"]; - readonly parent?: components["schemas"]["repository"]; - readonly source?: components["schemas"]["repository"]; - readonly forks: number; - readonly master_branch?: string; - readonly open_issues: number; - readonly watchers: number; + readonly subscribers_count: number + readonly network_count: number + readonly license: components['schemas']['nullable-license-simple'] + readonly organization?: components['schemas']['nullable-simple-user'] + readonly parent?: components['schemas']['repository'] + readonly source?: components['schemas']['repository'] + readonly forks: number + readonly master_branch?: string + readonly open_issues: number + readonly watchers: number /** * @description Whether anonymous git access is allowed. * @default true */ - readonly anonymous_access_enabled?: boolean; - readonly code_of_conduct?: components["schemas"]["code-of-conduct-simple"]; + readonly anonymous_access_enabled?: boolean + readonly code_of_conduct?: components['schemas']['code-of-conduct-simple'] readonly security_and_analysis?: { readonly advanced_security?: { /** @enum {string} */ - readonly status?: "enabled" | "disabled"; - }; + readonly status?: 'enabled' | 'disabled' + } readonly secret_scanning?: { /** @enum {string} */ - readonly status?: "enabled" | "disabled"; - }; - } | null; - }; + readonly status?: 'enabled' | 'disabled' + } + } | null + } /** * Artifact * @description An artifact */ readonly artifact: { /** @example 5 */ - readonly id: number; + readonly id: number /** @example MDEwOkNoZWNrU3VpdGU1 */ - readonly node_id: string; + readonly node_id: string /** * @description The name of the artifact. * @example AdventureWorks.Framework */ - readonly name: string; + readonly name: string /** * @description The size in bytes of the artifact. * @example 12345 */ - readonly size_in_bytes: number; + readonly size_in_bytes: number /** @example https://api.github.com/repos/github/hello-world/actions/artifacts/5 */ - readonly url: string; + readonly url: string /** @example https://api.github.com/repos/github/hello-world/actions/artifacts/5/zip */ - readonly archive_download_url: string; + readonly archive_download_url: string /** @description Whether or not the artifact has expired. */ - readonly expired: boolean; + readonly expired: boolean /** Format: date-time */ - readonly created_at: string | null; + readonly created_at: string | null /** Format: date-time */ - readonly expires_at: string | null; + readonly expires_at: string | null /** Format: date-time */ - readonly updated_at: string | null; - }; + readonly updated_at: string | null + } /** * Job * @description Information of a job execution in a workflow run @@ -11290,58 +11278,58 @@ export interface components { * @description The id of the job. * @example 21 */ - readonly id: number; + readonly id: number /** * @description The id of the associated workflow run. * @example 5 */ - readonly run_id: number; + readonly run_id: number /** @example https://api.github.com/repos/github/hello-world/actions/runs/5 */ - readonly run_url: string; + readonly run_url: string /** * @description Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run. * @example 1 */ - readonly run_attempt?: number; + readonly run_attempt?: number /** @example MDg6Q2hlY2tSdW40 */ - readonly node_id: string; + readonly node_id: string /** * @description The SHA of the commit that is being run. * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d */ - readonly head_sha: string; + readonly head_sha: string /** @example https://api.github.com/repos/github/hello-world/actions/jobs/21 */ - readonly url: string; + readonly url: string /** @example https://github.com/github/hello-world/runs/4 */ - readonly html_url: string | null; + readonly html_url: string | null /** * @description The phase of the lifecycle that the job is currently in. * @example queued * @enum {string} */ - readonly status: "queued" | "in_progress" | "completed"; + readonly status: 'queued' | 'in_progress' | 'completed' /** * @description The outcome of the job. * @example success */ - readonly conclusion: string | null; + readonly conclusion: string | null /** * Format: date-time * @description The time that the job started, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 */ - readonly started_at: string; + readonly started_at: string /** * Format: date-time * @description The time that the job finished, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 */ - readonly completed_at: string | null; + readonly completed_at: string | null /** * @description The name of the job. * @example test-coverage */ - readonly name: string; + readonly name: string /** @description Steps in this job. */ readonly steps?: readonly { /** @@ -11349,328 +11337,328 @@ export interface components { * @example queued * @enum {string} */ - readonly status: "queued" | "in_progress" | "completed"; + readonly status: 'queued' | 'in_progress' | 'completed' /** * @description The outcome of the job. * @example success */ - readonly conclusion: string | null; + readonly conclusion: string | null /** * @description The name of the job. * @example test-coverage */ - readonly name: string; + readonly name: string /** @example 1 */ - readonly number: number; + readonly number: number /** * Format: date-time * @description The time that the step started, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 */ - readonly started_at?: string | null; + readonly started_at?: string | null /** * Format: date-time * @description The time that the job finished, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 */ - readonly completed_at?: string | null; - }[]; + readonly completed_at?: string | null + }[] /** @example https://api.github.com/repos/github/hello-world/check-runs/4 */ - readonly check_run_url: string; + readonly check_run_url: string /** * @description Labels for the workflow job. Specified by the "runs_on" attribute in the action's workflow file. * @example self-hosted,foo,bar */ - readonly labels: readonly string[]; + readonly labels: readonly string[] /** * @description The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example 1 */ - readonly runner_id: number | null; + readonly runner_id: number | null /** * @description The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example my runner */ - readonly runner_name: string | null; + readonly runner_name: string | null /** * @description The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example 2 */ - readonly runner_group_id: number | null; + readonly runner_group_id: number | null /** * @description The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example my runner group */ - readonly runner_group_name: string | null; - }; + readonly runner_group_name: string | null + } /** @description Whether GitHub Actions is enabled on the repository. */ - readonly "actions-enabled": boolean; - readonly "actions-repository-permissions": { - readonly enabled: components["schemas"]["actions-enabled"]; - readonly allowed_actions?: components["schemas"]["allowed-actions"]; - readonly selected_actions_url?: components["schemas"]["selected-actions-url"]; - }; + readonly 'actions-enabled': boolean + readonly 'actions-repository-permissions': { + readonly enabled: components['schemas']['actions-enabled'] + readonly allowed_actions?: components['schemas']['allowed-actions'] + readonly selected_actions_url?: components['schemas']['selected-actions-url'] + } /** Pull Request Minimal */ - readonly "pull-request-minimal": { - readonly id: number; - readonly number: number; - readonly url: string; + readonly 'pull-request-minimal': { + readonly id: number + readonly number: number + readonly url: string readonly head: { - readonly ref: string; - readonly sha: string; + readonly ref: string + readonly sha: string readonly repo: { - readonly id: number; - readonly url: string; - readonly name: string; - }; - }; + readonly id: number + readonly url: string + readonly name: string + } + } readonly base: { - readonly ref: string; - readonly sha: string; + readonly ref: string + readonly sha: string readonly repo: { - readonly id: number; - readonly url: string; - readonly name: string; - }; - }; - }; + readonly id: number + readonly url: string + readonly name: string + } + } + } /** * Simple Commit * @description Simple Commit */ - readonly "nullable-simple-commit": { - readonly id: string; - readonly tree_id: string; - readonly message: string; + readonly 'nullable-simple-commit': { + readonly id: string + readonly tree_id: string + readonly message: string /** Format: date-time */ - readonly timestamp: string; + readonly timestamp: string readonly author: { - readonly name: string; - readonly email: string; - } | null; + readonly name: string + readonly email: string + } | null readonly committer: { - readonly name: string; - readonly email: string; - } | null; - } | null; + readonly name: string + readonly email: string + } | null + } | null /** * Workflow Run * @description An invocation of a workflow */ - readonly "workflow-run": { + readonly 'workflow-run': { /** * @description The ID of the workflow run. * @example 5 */ - readonly id: number; + readonly id: number /** * @description The name of the workflow run. * @example Build */ - readonly name?: string | null; + readonly name?: string | null /** @example MDEwOkNoZWNrU3VpdGU1 */ - readonly node_id: string; + readonly node_id: string /** * @description The ID of the associated check suite. * @example 42 */ - readonly check_suite_id?: number; + readonly check_suite_id?: number /** * @description The node ID of the associated check suite. * @example MDEwOkNoZWNrU3VpdGU0Mg== */ - readonly check_suite_node_id?: string; + readonly check_suite_node_id?: string /** @example master */ - readonly head_branch: string | null; + readonly head_branch: string | null /** * @description The SHA of the head commit that points to the version of the worflow being run. * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d */ - readonly head_sha: string; + readonly head_sha: string /** * @description The auto incrementing run number for the workflow run. * @example 106 */ - readonly run_number: number; + readonly run_number: number /** * @description Attempt number of the run, 1 for first attempt and higher if the workflow was re-run. * @example 1 */ - readonly run_attempt?: number; + readonly run_attempt?: number /** @example push */ - readonly event: string; + readonly event: string /** @example completed */ - readonly status: string | null; + readonly status: string | null /** @example neutral */ - readonly conclusion: string | null; + readonly conclusion: string | null /** * @description The ID of the parent workflow. * @example 5 */ - readonly workflow_id: number; + readonly workflow_id: number /** * @description The URL to the workflow run. * @example https://api.github.com/repos/github/hello-world/actions/runs/5 */ - readonly url: string; + readonly url: string /** @example https://github.com/github/hello-world/suites/4 */ - readonly html_url: string; - readonly pull_requests: readonly components["schemas"]["pull-request-minimal"][] | null; + readonly html_url: string + readonly pull_requests: readonly components['schemas']['pull-request-minimal'][] | null /** Format: date-time */ - readonly created_at: string; + readonly created_at: string /** Format: date-time */ - readonly updated_at: string; + readonly updated_at: string /** * Format: date-time * @description The start time of the latest run. Resets on re-run. */ - readonly run_started_at?: string; + readonly run_started_at?: string /** * @description The URL to the jobs for the workflow run. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/jobs */ - readonly jobs_url: string; + readonly jobs_url: string /** * @description The URL to download the logs for the workflow run. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/logs */ - readonly logs_url: string; + readonly logs_url: string /** * @description The URL to the associated check suite. * @example https://api.github.com/repos/github/hello-world/check-suites/12 */ - readonly check_suite_url: string; + readonly check_suite_url: string /** * @description The URL to the artifacts for the workflow run. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts */ - readonly artifacts_url: string; + readonly artifacts_url: string /** * @description The URL to cancel the workflow run. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/cancel */ - readonly cancel_url: string; + readonly cancel_url: string /** * @description The URL to rerun the workflow run. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/rerun */ - readonly rerun_url: string; + readonly rerun_url: string /** * @description The URL to the previous attempted run of this workflow, if one exists. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3 */ - readonly previous_attempt_url?: string | null; + readonly previous_attempt_url?: string | null /** * @description The URL to the workflow. * @example https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml */ - readonly workflow_url: string; - readonly head_commit: components["schemas"]["nullable-simple-commit"]; - readonly repository: components["schemas"]["minimal-repository"]; - readonly head_repository: components["schemas"]["minimal-repository"]; + readonly workflow_url: string + readonly head_commit: components['schemas']['nullable-simple-commit'] + readonly repository: components['schemas']['minimal-repository'] + readonly head_repository: components['schemas']['minimal-repository'] /** @example 5 */ - readonly head_repository_id?: number; - }; + readonly head_repository_id?: number + } /** * Environment Approval * @description An entry in the reviews log for environment deployments */ - readonly "environment-approvals": { + readonly 'environment-approvals': { /** @description The list of environments that were approved or rejected */ readonly environments: readonly { /** * @description The id of the environment. * @example 56780428 */ - readonly id?: number; + readonly id?: number /** @example MDExOkVudmlyb25tZW50NTY3ODA0Mjg= */ - readonly node_id?: string; + readonly node_id?: string /** * @description The name of the environment. * @example staging */ - readonly name?: string; + readonly name?: string /** @example https://api.github.com/repos/github/hello-world/environments/staging */ - readonly url?: string; + readonly url?: string /** @example https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging */ - readonly html_url?: string; + readonly html_url?: string /** * Format: date-time * @description The time that the environment was created, in ISO 8601 format. * @example 2020-11-23T22:00:40Z */ - readonly created_at?: string; + readonly created_at?: string /** * Format: date-time * @description The time that the environment was last updated, in ISO 8601 format. * @example 2020-11-23T22:00:40Z */ - readonly updated_at?: string; - }[]; + readonly updated_at?: string + }[] /** * @description Whether deployment to the environment(s) was approved or rejected * @example approved * @enum {string} */ - readonly state: "approved" | "rejected"; - readonly user: components["schemas"]["simple-user"]; + readonly state: 'approved' | 'rejected' + readonly user: components['schemas']['simple-user'] /** * @description The comment submitted with the deployment review * @example Ship it! */ - readonly comment: string; - }; + readonly comment: string + } /** * @description The type of reviewer. Must be one of: `User` or `Team` * @example User * @enum {string} */ - readonly "deployment-reviewer-type": "User" | "Team"; + readonly 'deployment-reviewer-type': 'User' | 'Team' /** * Pending Deployment * @description Details of a deployment that is waiting for protection rules to pass */ - readonly "pending-deployment": { + readonly 'pending-deployment': { readonly environment: { /** * @description The id of the environment. * @example 56780428 */ - readonly id?: number; + readonly id?: number /** @example MDExOkVudmlyb25tZW50NTY3ODA0Mjg= */ - readonly node_id?: string; + readonly node_id?: string /** * @description The name of the environment. * @example staging */ - readonly name?: string; + readonly name?: string /** @example https://api.github.com/repos/github/hello-world/environments/staging */ - readonly url?: string; + readonly url?: string /** @example https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging */ - readonly html_url?: string; - }; + readonly html_url?: string + } /** * @description The set duration of the wait timer * @example 30 */ - readonly wait_timer: number; + readonly wait_timer: number /** * Format: date-time * @description The time that the wait timer began. * @example 2020-11-23T22:00:40Z */ - readonly wait_timer_started_at: string | null; + readonly wait_timer_started_at: string | null /** * @description Whether the currently authenticated user can approve the deployment * @example true */ - readonly current_user_can_approve: boolean; + readonly current_user_can_approve: boolean /** @description The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */ readonly reviewers: readonly { - readonly type?: components["schemas"]["deployment-reviewer-type"]; - readonly reviewer?: Partial & Partial; - }[]; - }; + readonly type?: components['schemas']['deployment-reviewer-type'] + readonly reviewer?: Partial & Partial + }[] + } /** * Deployment * @description A request for a specific ref(branch,sha,tag) to be deployed @@ -11680,469 +11668,469 @@ export interface components { * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1 */ - readonly url: string; + readonly url: string /** * @description Unique identifier of the deployment * @example 42 */ - readonly id: number; + readonly id: number /** @example MDEwOkRlcGxveW1lbnQx */ - readonly node_id: string; + readonly node_id: string /** @example a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d */ - readonly sha: string; + readonly sha: string /** * @description The ref to deploy. This can be a branch, tag, or sha. * @example topic-branch */ - readonly ref: string; + readonly ref: string /** * @description Parameter to specify a task to execute * @example deploy */ - readonly task: string; - readonly payload: { readonly [key: string]: unknown } | string; + readonly task: string + readonly payload: { readonly [key: string]: unknown } | string /** @example staging */ - readonly original_environment?: string; + readonly original_environment?: string /** * @description Name for the target deployment environment. * @example production */ - readonly environment: string; + readonly environment: string /** @example Deploy request from hubot */ - readonly description: string | null; - readonly creator: components["schemas"]["nullable-simple-user"]; + readonly description: string | null + readonly creator: components['schemas']['nullable-simple-user'] /** * Format: date-time * @example 2012-07-20T01:19:13Z */ - readonly created_at: string; + readonly created_at: string /** * Format: date-time * @example 2012-07-20T01:19:13Z */ - readonly updated_at: string; + readonly updated_at: string /** * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1/statuses */ - readonly statuses_url: string; + readonly statuses_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/example */ - readonly repository_url: string; + readonly repository_url: string /** * @description Specifies if the given environment is will no longer exist at some point in the future. Default: false. * @example true */ - readonly transient_environment?: boolean; + readonly transient_environment?: boolean /** * @description Specifies if the given environment is one that end-users directly interact with. Default: false. * @example true */ - readonly production_environment?: boolean; - readonly performed_via_github_app?: components["schemas"]["nullable-integration"]; - }; + readonly production_environment?: boolean + readonly performed_via_github_app?: components['schemas']['nullable-integration'] + } /** * Workflow Run Usage * @description Workflow Run Usage */ - readonly "workflow-run-usage": { + readonly 'workflow-run-usage': { readonly billable: { readonly UBUNTU?: { - readonly total_ms: number; - readonly jobs: number; + readonly total_ms: number + readonly jobs: number readonly job_runs?: readonly { - readonly job_id: number; - readonly duration_ms: number; - }[]; - }; + readonly job_id: number + readonly duration_ms: number + }[] + } readonly MACOS?: { - readonly total_ms: number; - readonly jobs: number; + readonly total_ms: number + readonly jobs: number readonly job_runs?: readonly { - readonly job_id: number; - readonly duration_ms: number; - }[]; - }; + readonly job_id: number + readonly duration_ms: number + }[] + } readonly WINDOWS?: { - readonly total_ms: number; - readonly jobs: number; + readonly total_ms: number + readonly jobs: number readonly job_runs?: readonly { - readonly job_id: number; - readonly duration_ms: number; - }[]; - }; - }; - readonly run_duration_ms?: number; - }; + readonly job_id: number + readonly duration_ms: number + }[] + } + } + readonly run_duration_ms?: number + } /** * Actions Secret * @description Set secrets for GitHub Actions. */ - readonly "actions-secret": { + readonly 'actions-secret': { /** * @description The name of the secret. * @example SECRET_TOKEN */ - readonly name: string; + readonly name: string /** Format: date-time */ - readonly created_at: string; + readonly created_at: string /** Format: date-time */ - readonly updated_at: string; - }; + readonly updated_at: string + } /** * Workflow * @description A GitHub Actions workflow */ readonly workflow: { /** @example 5 */ - readonly id: number; + readonly id: number /** @example MDg6V29ya2Zsb3cxMg== */ - readonly node_id: string; + readonly node_id: string /** @example CI */ - readonly name: string; + readonly name: string /** @example ruby.yaml */ - readonly path: string; + readonly path: string /** * @example active * @enum {string} */ - readonly state: "active" | "deleted" | "disabled_fork" | "disabled_inactivity" | "disabled_manually"; + readonly state: 'active' | 'deleted' | 'disabled_fork' | 'disabled_inactivity' | 'disabled_manually' /** * Format: date-time * @example 2019-12-06T14:20:20.000Z */ - readonly created_at: string; + readonly created_at: string /** * Format: date-time * @example 2019-12-06T14:20:20.000Z */ - readonly updated_at: string; + readonly updated_at: string /** @example https://api.github.com/repos/actions/setup-ruby/workflows/5 */ - readonly url: string; + readonly url: string /** @example https://github.com/actions/setup-ruby/blob/master/.github/workflows/ruby.yaml */ - readonly html_url: string; + readonly html_url: string /** @example https://github.com/actions/setup-ruby/workflows/CI/badge.svg */ - readonly badge_url: string; + readonly badge_url: string /** * Format: date-time * @example 2019-12-06T14:20:20.000Z */ - readonly deleted_at?: string; - }; + readonly deleted_at?: string + } /** * Workflow Usage * @description Workflow Usage */ - readonly "workflow-usage": { + readonly 'workflow-usage': { readonly billable: { readonly UBUNTU?: { - readonly total_ms?: number; - }; + readonly total_ms?: number + } readonly MACOS?: { - readonly total_ms?: number; - }; + readonly total_ms?: number + } readonly WINDOWS?: { - readonly total_ms?: number; - }; - }; - }; + readonly total_ms?: number + } + } + } /** * Autolink reference * @description An autolink reference. */ readonly autolink: { /** @example 3 */ - readonly id: number; + readonly id: number /** * @description The prefix of a key that is linkified. * @example TICKET- */ - readonly key_prefix: string; + readonly key_prefix: string /** * @description A template for the target URL that is generated if a key was found. * @example https://example.com/TICKET?query= */ - readonly url_template: string; - }; + readonly url_template: string + } /** * Protected Branch Required Status Check * @description Protected Branch Required Status Check */ - readonly "protected-branch-required-status-check": { - readonly url?: string; - readonly enforcement_level?: string; - readonly contexts: readonly string[]; + readonly 'protected-branch-required-status-check': { + readonly url?: string + readonly enforcement_level?: string + readonly contexts: readonly string[] readonly checks: readonly { - readonly context: string; - readonly app_id: number | null; - }[]; - readonly contexts_url?: string; - readonly strict?: boolean; - }; + readonly context: string + readonly app_id: number | null + }[] + readonly contexts_url?: string + readonly strict?: boolean + } /** * Protected Branch Admin Enforced * @description Protected Branch Admin Enforced */ - readonly "protected-branch-admin-enforced": { + readonly 'protected-branch-admin-enforced': { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins */ - readonly url: string; + readonly url: string /** @example true */ - readonly enabled: boolean; - }; + readonly enabled: boolean + } /** * Protected Branch Pull Request Review * @description Protected Branch Pull Request Review */ - readonly "protected-branch-pull-request-review": { + readonly 'protected-branch-pull-request-review': { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions */ - readonly url?: string; + readonly url?: string readonly dismissal_restrictions?: { /** @description The list of users with review dismissal access. */ - readonly users?: readonly components["schemas"]["simple-user"][]; + readonly users?: readonly components['schemas']['simple-user'][] /** @description The list of teams with review dismissal access. */ - readonly teams?: readonly components["schemas"]["team"][]; + readonly teams?: readonly components['schemas']['team'][] /** @example "https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions" */ - readonly url?: string; + readonly url?: string /** @example "https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users" */ - readonly users_url?: string; + readonly users_url?: string /** @example "https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams" */ - readonly teams_url?: string; - }; + readonly teams_url?: string + } /** @description Allow specific users or teams to bypass pull request requirements. Set to `null` to disable. */ readonly bypass_pull_request_allowances?: { /** @description The list of users allowed to bypass pull request requirements. */ - readonly users?: readonly components["schemas"]["simple-user"][]; + readonly users?: readonly components['schemas']['simple-user'][] /** @description The list of teams allowed to bypass pull request requirements. */ - readonly teams?: readonly components["schemas"]["team"][]; - } | null; + readonly teams?: readonly components['schemas']['team'][] + } | null /** @example true */ - readonly dismiss_stale_reviews: boolean; + readonly dismiss_stale_reviews: boolean /** @example true */ - readonly require_code_owner_reviews: boolean; + readonly require_code_owner_reviews: boolean /** @example 2 */ - readonly required_approving_review_count?: number; - }; + readonly required_approving_review_count?: number + } /** * Branch Restriction Policy * @description Branch Restriction Policy */ - readonly "branch-restriction-policy": { + readonly 'branch-restriction-policy': { /** Format: uri */ - readonly url: string; + readonly url: string /** Format: uri */ - readonly users_url: string; + readonly users_url: string /** Format: uri */ - readonly teams_url: string; + readonly teams_url: string /** Format: uri */ - readonly apps_url: string; + readonly apps_url: string readonly users: readonly { - readonly login?: string; - readonly id?: number; - readonly node_id?: string; - readonly avatar_url?: string; - readonly gravatar_id?: string; - readonly url?: string; - readonly html_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly organizations_url?: string; - readonly repos_url?: string; - readonly events_url?: string; - readonly received_events_url?: string; - readonly type?: string; - readonly site_admin?: boolean; - }[]; + readonly login?: string + readonly id?: number + readonly node_id?: string + readonly avatar_url?: string + readonly gravatar_id?: string + readonly url?: string + readonly html_url?: string + readonly followers_url?: string + readonly following_url?: string + readonly gists_url?: string + readonly starred_url?: string + readonly subscriptions_url?: string + readonly organizations_url?: string + readonly repos_url?: string + readonly events_url?: string + readonly received_events_url?: string + readonly type?: string + readonly site_admin?: boolean + }[] readonly teams: readonly { - readonly id?: number; - readonly node_id?: string; - readonly url?: string; - readonly html_url?: string; - readonly name?: string; - readonly slug?: string; - readonly description?: string | null; - readonly privacy?: string; - readonly permission?: string; - readonly members_url?: string; - readonly repositories_url?: string; - readonly parent?: string | null; - }[]; + readonly id?: number + readonly node_id?: string + readonly url?: string + readonly html_url?: string + readonly name?: string + readonly slug?: string + readonly description?: string | null + readonly privacy?: string + readonly permission?: string + readonly members_url?: string + readonly repositories_url?: string + readonly parent?: string | null + }[] readonly apps: readonly { - readonly id?: number; - readonly slug?: string; - readonly node_id?: string; + readonly id?: number + readonly slug?: string + readonly node_id?: string readonly owner?: { - readonly login?: string; - readonly id?: number; - readonly node_id?: string; - readonly url?: string; - readonly repos_url?: string; - readonly events_url?: string; - readonly hooks_url?: string; - readonly issues_url?: string; - readonly members_url?: string; - readonly public_members_url?: string; - readonly avatar_url?: string; - readonly description?: string; + readonly login?: string + readonly id?: number + readonly node_id?: string + readonly url?: string + readonly repos_url?: string + readonly events_url?: string + readonly hooks_url?: string + readonly issues_url?: string + readonly members_url?: string + readonly public_members_url?: string + readonly avatar_url?: string + readonly description?: string /** @example "" */ - readonly gravatar_id?: string; + readonly gravatar_id?: string /** @example "https://github.com/testorg-ea8ec76d71c3af4b" */ - readonly html_url?: string; + readonly html_url?: string /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers" */ - readonly followers_url?: string; + readonly followers_url?: string /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}" */ - readonly following_url?: string; + readonly following_url?: string /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}" */ - readonly gists_url?: string; + readonly gists_url?: string /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}" */ - readonly starred_url?: string; + readonly starred_url?: string /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions" */ - readonly subscriptions_url?: string; + readonly subscriptions_url?: string /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs" */ - readonly organizations_url?: string; + readonly organizations_url?: string /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events" */ - readonly received_events_url?: string; + readonly received_events_url?: string /** @example "Organization" */ - readonly type?: string; - readonly site_admin?: boolean; - }; - readonly name?: string; - readonly description?: string; - readonly external_url?: string; - readonly html_url?: string; - readonly created_at?: string; - readonly updated_at?: string; + readonly type?: string + readonly site_admin?: boolean + } + readonly name?: string + readonly description?: string + readonly external_url?: string + readonly html_url?: string + readonly created_at?: string + readonly updated_at?: string readonly permissions?: { - readonly metadata?: string; - readonly contents?: string; - readonly issues?: string; - readonly single_file?: string; - }; - readonly events?: readonly string[]; - }[]; - }; + readonly metadata?: string + readonly contents?: string + readonly issues?: string + readonly single_file?: string + } + readonly events?: readonly string[] + }[] + } /** * Branch Protection * @description Branch Protection */ - readonly "branch-protection": { - readonly url?: string; - readonly enabled?: boolean; - readonly required_status_checks?: components["schemas"]["protected-branch-required-status-check"]; - readonly enforce_admins?: components["schemas"]["protected-branch-admin-enforced"]; - readonly required_pull_request_reviews?: components["schemas"]["protected-branch-pull-request-review"]; - readonly restrictions?: components["schemas"]["branch-restriction-policy"]; + readonly 'branch-protection': { + readonly url?: string + readonly enabled?: boolean + readonly required_status_checks?: components['schemas']['protected-branch-required-status-check'] + readonly enforce_admins?: components['schemas']['protected-branch-admin-enforced'] + readonly required_pull_request_reviews?: components['schemas']['protected-branch-pull-request-review'] + readonly restrictions?: components['schemas']['branch-restriction-policy'] readonly required_linear_history?: { - readonly enabled?: boolean; - }; + readonly enabled?: boolean + } readonly allow_force_pushes?: { - readonly enabled?: boolean; - }; + readonly enabled?: boolean + } readonly allow_deletions?: { - readonly enabled?: boolean; - }; + readonly enabled?: boolean + } readonly required_conversation_resolution?: { - readonly enabled?: boolean; - }; + readonly enabled?: boolean + } /** @example "branch/with/protection" */ - readonly name?: string; + readonly name?: string /** @example "https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection" */ - readonly protection_url?: string; + readonly protection_url?: string readonly required_signatures?: { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures */ - readonly url: string; + readonly url: string /** @example true */ - readonly enabled: boolean; - }; - }; + readonly enabled: boolean + } + } /** * Short Branch * @description Short Branch */ - readonly "short-branch": { - readonly name: string; + readonly 'short-branch': { + readonly name: string readonly commit: { - readonly sha: string; + readonly sha: string /** Format: uri */ - readonly url: string; - }; - readonly protected: boolean; - readonly protection?: components["schemas"]["branch-protection"]; + readonly url: string + } + readonly protected: boolean + readonly protection?: components['schemas']['branch-protection'] /** Format: uri */ - readonly protection_url?: string; - }; + readonly protection_url?: string + } /** * Git User * @description Metaproperties for Git author/committer information. */ - readonly "nullable-git-user": { + readonly 'nullable-git-user': { /** @example "Chris Wanstrath" */ - readonly name?: string; + readonly name?: string /** @example "chris@ozmm.org" */ - readonly email?: string; + readonly email?: string /** @example "2007-10-29T02:42:39.000-07:00" */ - readonly date?: string; - } | null; + readonly date?: string + } | null /** Verification */ readonly verification: { - readonly verified: boolean; - readonly reason: string; - readonly payload: string | null; - readonly signature: string | null; - }; + readonly verified: boolean + readonly reason: string + readonly payload: string | null + readonly signature: string | null + } /** * Diff Entry * @description Diff Entry */ - readonly "diff-entry": { + readonly 'diff-entry': { /** @example bbcd538c8e72b8c175046e27cc8f907076331401 */ - readonly sha: string; + readonly sha: string /** @example file1.txt */ - readonly filename: string; + readonly filename: string /** * @example added * @enum {string} */ - readonly status: "added" | "removed" | "modified" | "renamed" | "copied" | "changed" | "unchanged"; + readonly status: 'added' | 'removed' | 'modified' | 'renamed' | 'copied' | 'changed' | 'unchanged' /** @example 103 */ - readonly additions: number; + readonly additions: number /** @example 21 */ - readonly deletions: number; + readonly deletions: number /** @example 124 */ - readonly changes: number; + readonly changes: number /** * Format: uri * @example https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt */ - readonly blob_url: string; + readonly blob_url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt */ - readonly raw_url: string; + readonly raw_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e */ - readonly contents_url: string; + readonly contents_url: string /** @example @@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test */ - readonly patch?: string; + readonly patch?: string /** @example file.txt */ - readonly previous_filename?: string; - }; + readonly previous_filename?: string + } /** * Commit * @description Commit @@ -12152,1651 +12140,1647 @@ export interface components { * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e */ - readonly url: string; + readonly url: string /** @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */ - readonly sha: string; + readonly sha: string /** @example MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== */ - readonly node_id: string; + readonly node_id: string /** * Format: uri * @example https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e */ - readonly html_url: string; + readonly html_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments */ - readonly comments_url: string; + readonly comments_url: string readonly commit: { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e */ - readonly url: string; - readonly author: components["schemas"]["nullable-git-user"]; - readonly committer: components["schemas"]["nullable-git-user"]; + readonly url: string + readonly author: components['schemas']['nullable-git-user'] + readonly committer: components['schemas']['nullable-git-user'] /** @example Fix all the bugs */ - readonly message: string; - readonly comment_count: number; + readonly message: string + readonly comment_count: number readonly tree: { /** @example 827efc6d56897b048c772eb4087f854f46256132 */ - readonly sha: string; + readonly sha: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132 */ - readonly url: string; - }; - readonly verification?: components["schemas"]["verification"]; - }; - readonly author: components["schemas"]["nullable-simple-user"]; - readonly committer: components["schemas"]["nullable-simple-user"]; + readonly url: string + } + readonly verification?: components['schemas']['verification'] + } + readonly author: components['schemas']['nullable-simple-user'] + readonly committer: components['schemas']['nullable-simple-user'] readonly parents: readonly { /** @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - readonly sha: string; + readonly sha: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd */ - readonly url: string; + readonly url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd */ - readonly html_url?: string; - }[]; + readonly html_url?: string + }[] readonly stats?: { - readonly additions?: number; - readonly deletions?: number; - readonly total?: number; - }; - readonly files?: readonly components["schemas"]["diff-entry"][]; - }; + readonly additions?: number + readonly deletions?: number + readonly total?: number + } + readonly files?: readonly components['schemas']['diff-entry'][] + } /** * Branch With Protection * @description Branch With Protection */ - readonly "branch-with-protection": { - readonly name: string; - readonly commit: components["schemas"]["commit"]; + readonly 'branch-with-protection': { + readonly name: string + readonly commit: components['schemas']['commit'] readonly _links: { - readonly html: string; + readonly html: string /** Format: uri */ - readonly self: string; - }; - readonly protected: boolean; - readonly protection: components["schemas"]["branch-protection"]; + readonly self: string + } + readonly protected: boolean + readonly protection: components['schemas']['branch-protection'] /** Format: uri */ - readonly protection_url: string; + readonly protection_url: string /** @example "mas*" */ - readonly pattern?: string; + readonly pattern?: string /** @example 1 */ - readonly required_approving_review_count?: number; - }; + readonly required_approving_review_count?: number + } /** * Status Check Policy * @description Status Check Policy */ - readonly "status-check-policy": { + readonly 'status-check-policy': { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks */ - readonly url: string; + readonly url: string /** @example true */ - readonly strict: boolean; + readonly strict: boolean /** @example continuous-integration/travis-ci */ - readonly contexts: readonly string[]; + readonly contexts: readonly string[] readonly checks: readonly { /** @example continuous-integration/travis-ci */ - readonly context: string; - readonly app_id: number | null; - }[]; + readonly context: string + readonly app_id: number | null + }[] /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts */ - readonly contexts_url: string; - }; + readonly contexts_url: string + } /** * Protected Branch * @description Branch protections protect branches */ - readonly "protected-branch": { + readonly 'protected-branch': { /** Format: uri */ - readonly url: string; - readonly required_status_checks?: components["schemas"]["status-check-policy"]; + readonly url: string + readonly required_status_checks?: components['schemas']['status-check-policy'] readonly required_pull_request_reviews?: { /** Format: uri */ - readonly url: string; - readonly dismiss_stale_reviews?: boolean; - readonly require_code_owner_reviews?: boolean; - readonly required_approving_review_count?: number; + readonly url: string + readonly dismiss_stale_reviews?: boolean + readonly require_code_owner_reviews?: boolean + readonly required_approving_review_count?: number readonly dismissal_restrictions?: { /** Format: uri */ - readonly url: string; + readonly url: string /** Format: uri */ - readonly users_url: string; + readonly users_url: string /** Format: uri */ - readonly teams_url: string; - readonly users: readonly components["schemas"]["simple-user"][]; - readonly teams: readonly components["schemas"]["team"][]; - }; + readonly teams_url: string + readonly users: readonly components['schemas']['simple-user'][] + readonly teams: readonly components['schemas']['team'][] + } readonly bypass_pull_request_allowances?: { - readonly users: readonly components["schemas"]["simple-user"][]; - readonly teams: readonly components["schemas"]["team"][]; - }; - }; + readonly users: readonly components['schemas']['simple-user'][] + readonly teams: readonly components['schemas']['team'][] + } + } readonly required_signatures?: { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures */ - readonly url: string; + readonly url: string /** @example true */ - readonly enabled: boolean; - }; + readonly enabled: boolean + } readonly enforce_admins?: { /** Format: uri */ - readonly url: string; - readonly enabled: boolean; - }; + readonly url: string + readonly enabled: boolean + } readonly required_linear_history?: { - readonly enabled: boolean; - }; + readonly enabled: boolean + } readonly allow_force_pushes?: { - readonly enabled: boolean; - }; + readonly enabled: boolean + } readonly allow_deletions?: { - readonly enabled: boolean; - }; - readonly restrictions?: components["schemas"]["branch-restriction-policy"]; + readonly enabled: boolean + } + readonly restrictions?: components['schemas']['branch-restriction-policy'] readonly required_conversation_resolution?: { - readonly enabled?: boolean; - }; - }; + readonly enabled?: boolean + } + } /** * Deployment * @description A deployment created as the result of an Actions check run from a workflow that references an environment */ - readonly "deployment-simple": { + readonly 'deployment-simple': { /** * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1 */ - readonly url: string; + readonly url: string /** * @description Unique identifier of the deployment * @example 42 */ - readonly id: number; + readonly id: number /** @example MDEwOkRlcGxveW1lbnQx */ - readonly node_id: string; + readonly node_id: string /** * @description Parameter to specify a task to execute * @example deploy */ - readonly task: string; + readonly task: string /** @example staging */ - readonly original_environment?: string; + readonly original_environment?: string /** * @description Name for the target deployment environment. * @example production */ - readonly environment: string; + readonly environment: string /** @example Deploy request from hubot */ - readonly description: string | null; + readonly description: string | null /** * Format: date-time * @example 2012-07-20T01:19:13Z */ - readonly created_at: string; + readonly created_at: string /** * Format: date-time * @example 2012-07-20T01:19:13Z */ - readonly updated_at: string; + readonly updated_at: string /** * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1/statuses */ - readonly statuses_url: string; + readonly statuses_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/example */ - readonly repository_url: string; + readonly repository_url: string /** * @description Specifies if the given environment is will no longer exist at some point in the future. Default: false. * @example true */ - readonly transient_environment?: boolean; + readonly transient_environment?: boolean /** * @description Specifies if the given environment is one that end-users directly interact with. Default: false. * @example true */ - readonly production_environment?: boolean; - readonly performed_via_github_app?: components["schemas"]["nullable-integration"]; - }; + readonly production_environment?: boolean + readonly performed_via_github_app?: components['schemas']['nullable-integration'] + } /** * CheckRun * @description A check performed on the code of a given code change */ - readonly "check-run": { + readonly 'check-run': { /** * @description The id of the check. * @example 21 */ - readonly id: number; + readonly id: number /** * @description The SHA of the commit that is being checked. * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d */ - readonly head_sha: string; + readonly head_sha: string /** @example MDg6Q2hlY2tSdW40 */ - readonly node_id: string; + readonly node_id: string /** @example 42 */ - readonly external_id: string | null; + readonly external_id: string | null /** @example https://api.github.com/repos/github/hello-world/check-runs/4 */ - readonly url: string; + readonly url: string /** @example https://github.com/github/hello-world/runs/4 */ - readonly html_url: string | null; + readonly html_url: string | null /** @example https://example.com */ - readonly details_url: string | null; + readonly details_url: string | null /** * @description The phase of the lifecycle that the check is currently in. * @example queued * @enum {string} */ - readonly status: "queued" | "in_progress" | "completed"; + readonly status: 'queued' | 'in_progress' | 'completed' /** * @example neutral * @enum {string|null} */ - readonly conclusion: - | ("success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required") - | null; + readonly conclusion: ('success' | 'failure' | 'neutral' | 'cancelled' | 'skipped' | 'timed_out' | 'action_required') | null /** * Format: date-time * @example 2018-05-04T01:14:52Z */ - readonly started_at: string | null; + readonly started_at: string | null /** * Format: date-time * @example 2018-05-04T01:14:52Z */ - readonly completed_at: string | null; + readonly completed_at: string | null readonly output: { - readonly title: string | null; - readonly summary: string | null; - readonly text: string | null; - readonly annotations_count: number; + readonly title: string | null + readonly summary: string | null + readonly text: string | null + readonly annotations_count: number /** Format: uri */ - readonly annotations_url: string; - }; + readonly annotations_url: string + } /** * @description The name of the check. * @example test-coverage */ - readonly name: string; + readonly name: string readonly check_suite: { - readonly id: number; - } | null; - readonly app: components["schemas"]["nullable-integration"]; - readonly pull_requests: readonly components["schemas"]["pull-request-minimal"][]; - readonly deployment?: components["schemas"]["deployment-simple"]; - }; + readonly id: number + } | null + readonly app: components['schemas']['nullable-integration'] + readonly pull_requests: readonly components['schemas']['pull-request-minimal'][] + readonly deployment?: components['schemas']['deployment-simple'] + } /** * Check Annotation * @description Check Annotation */ - readonly "check-annotation": { + readonly 'check-annotation': { /** @example README.md */ - readonly path: string; + readonly path: string /** @example 2 */ - readonly start_line: number; + readonly start_line: number /** @example 2 */ - readonly end_line: number; + readonly end_line: number /** @example 5 */ - readonly start_column: number | null; + readonly start_column: number | null /** @example 10 */ - readonly end_column: number | null; + readonly end_column: number | null /** @example warning */ - readonly annotation_level: string | null; + readonly annotation_level: string | null /** @example Spell Checker */ - readonly title: string | null; + readonly title: string | null /** @example Check your spelling for 'banaas'. */ - readonly message: string | null; + readonly message: string | null /** @example Do you mean 'bananas' or 'banana'? */ - readonly raw_details: string | null; - readonly blob_href: string; - }; + readonly raw_details: string | null + readonly blob_href: string + } /** * Simple Commit * @description Simple Commit */ - readonly "simple-commit": { - readonly id: string; - readonly tree_id: string; - readonly message: string; + readonly 'simple-commit': { + readonly id: string + readonly tree_id: string + readonly message: string /** Format: date-time */ - readonly timestamp: string; + readonly timestamp: string readonly author: { - readonly name: string; - readonly email: string; - } | null; + readonly name: string + readonly email: string + } | null readonly committer: { - readonly name: string; - readonly email: string; - } | null; - }; + readonly name: string + readonly email: string + } | null + } /** * CheckSuite * @description A suite of checks performed on the code of a given code change */ - readonly "check-suite": { + readonly 'check-suite': { /** @example 5 */ - readonly id: number; + readonly id: number /** @example MDEwOkNoZWNrU3VpdGU1 */ - readonly node_id: string; + readonly node_id: string /** @example master */ - readonly head_branch: string | null; + readonly head_branch: string | null /** * @description The SHA of the head commit that is being checked. * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d */ - readonly head_sha: string; + readonly head_sha: string /** * @example completed * @enum {string|null} */ - readonly status: ("queued" | "in_progress" | "completed") | null; + readonly status: ('queued' | 'in_progress' | 'completed') | null /** * @example neutral * @enum {string|null} */ - readonly conclusion: - | ("success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required") - | null; + readonly conclusion: ('success' | 'failure' | 'neutral' | 'cancelled' | 'skipped' | 'timed_out' | 'action_required') | null /** @example https://api.github.com/repos/github/hello-world/check-suites/5 */ - readonly url: string | null; + readonly url: string | null /** @example 146e867f55c26428e5f9fade55a9bbf5e95a7912 */ - readonly before: string | null; + readonly before: string | null /** @example d6fde92930d4715a2b49857d24b940956b26d2d3 */ - readonly after: string | null; - readonly pull_requests: readonly components["schemas"]["pull-request-minimal"][] | null; - readonly app: components["schemas"]["nullable-integration"]; - readonly repository: components["schemas"]["minimal-repository"]; + readonly after: string | null + readonly pull_requests: readonly components['schemas']['pull-request-minimal'][] | null + readonly app: components['schemas']['nullable-integration'] + readonly repository: components['schemas']['minimal-repository'] /** Format: date-time */ - readonly created_at: string | null; + readonly created_at: string | null /** Format: date-time */ - readonly updated_at: string | null; - readonly head_commit: components["schemas"]["simple-commit"]; - readonly latest_check_runs_count: number; - readonly check_runs_url: string; - readonly rerequestable?: boolean; - readonly runs_rerequestable?: boolean; - }; + readonly updated_at: string | null + readonly head_commit: components['schemas']['simple-commit'] + readonly latest_check_runs_count: number + readonly check_runs_url: string + readonly rerequestable?: boolean + readonly runs_rerequestable?: boolean + } /** * Check Suite Preference * @description Check suite configuration preferences for a repository. */ - readonly "check-suite-preference": { + readonly 'check-suite-preference': { readonly preferences: { readonly auto_trigger_checks?: readonly { - readonly app_id: number; - readonly setting: boolean; - }[]; - }; - readonly repository: components["schemas"]["minimal-repository"]; - }; - readonly "code-scanning-alert-rule-summary": { + readonly app_id: number + readonly setting: boolean + }[] + } + readonly repository: components['schemas']['minimal-repository'] + } + readonly 'code-scanning-alert-rule-summary': { /** @description A unique identifier for the rule used to detect the alert. */ - readonly id?: string | null; + readonly id?: string | null /** @description The name of the rule used to detect the alert. */ - readonly name?: string; + readonly name?: string /** @description A set of tags applicable for the rule. */ - readonly tags?: readonly string[] | null; + readonly tags?: readonly string[] | null /** * @description The severity of the alert. * @enum {string|null} */ - readonly severity?: ("none" | "note" | "warning" | "error") | null; + readonly severity?: ('none' | 'note' | 'warning' | 'error') | null /** @description A short description of the rule used to detect the alert. */ - readonly description?: string; - }; - readonly "code-scanning-alert-items": { - readonly number: components["schemas"]["alert-number"]; - readonly created_at: components["schemas"]["alert-created-at"]; - readonly updated_at?: components["schemas"]["alert-updated-at"]; - readonly url: components["schemas"]["alert-url"]; - readonly html_url: components["schemas"]["alert-html-url"]; - readonly instances_url: components["schemas"]["alert-instances-url"]; - readonly state: components["schemas"]["code-scanning-alert-state"]; - readonly fixed_at?: components["schemas"]["code-scanning-alert-fixed-at"]; - readonly dismissed_by: components["schemas"]["nullable-simple-user"]; - readonly dismissed_at: components["schemas"]["code-scanning-alert-dismissed-at"]; - readonly dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"]; - readonly rule: components["schemas"]["code-scanning-alert-rule-summary"]; - readonly tool: components["schemas"]["code-scanning-analysis-tool"]; - readonly most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; - }; - readonly "code-scanning-alert": { - readonly number: components["schemas"]["alert-number"]; - readonly created_at: components["schemas"]["alert-created-at"]; - readonly updated_at?: components["schemas"]["alert-updated-at"]; - readonly url: components["schemas"]["alert-url"]; - readonly html_url: components["schemas"]["alert-html-url"]; - readonly instances_url: components["schemas"]["alert-instances-url"]; - readonly state: components["schemas"]["code-scanning-alert-state"]; - readonly fixed_at?: components["schemas"]["code-scanning-alert-fixed-at"]; - readonly dismissed_by: components["schemas"]["nullable-simple-user"]; - readonly dismissed_at: components["schemas"]["code-scanning-alert-dismissed-at"]; - readonly dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"]; - readonly rule: components["schemas"]["code-scanning-alert-rule"]; - readonly tool: components["schemas"]["code-scanning-analysis-tool"]; - readonly most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; - }; + readonly description?: string + } + readonly 'code-scanning-alert-items': { + readonly number: components['schemas']['alert-number'] + readonly created_at: components['schemas']['alert-created-at'] + readonly updated_at?: components['schemas']['alert-updated-at'] + readonly url: components['schemas']['alert-url'] + readonly html_url: components['schemas']['alert-html-url'] + readonly instances_url: components['schemas']['alert-instances-url'] + readonly state: components['schemas']['code-scanning-alert-state'] + readonly fixed_at?: components['schemas']['code-scanning-alert-fixed-at'] + readonly dismissed_by: components['schemas']['nullable-simple-user'] + readonly dismissed_at: components['schemas']['code-scanning-alert-dismissed-at'] + readonly dismissed_reason: components['schemas']['code-scanning-alert-dismissed-reason'] + readonly rule: components['schemas']['code-scanning-alert-rule-summary'] + readonly tool: components['schemas']['code-scanning-analysis-tool'] + readonly most_recent_instance: components['schemas']['code-scanning-alert-instance'] + } + readonly 'code-scanning-alert': { + readonly number: components['schemas']['alert-number'] + readonly created_at: components['schemas']['alert-created-at'] + readonly updated_at?: components['schemas']['alert-updated-at'] + readonly url: components['schemas']['alert-url'] + readonly html_url: components['schemas']['alert-html-url'] + readonly instances_url: components['schemas']['alert-instances-url'] + readonly state: components['schemas']['code-scanning-alert-state'] + readonly fixed_at?: components['schemas']['code-scanning-alert-fixed-at'] + readonly dismissed_by: components['schemas']['nullable-simple-user'] + readonly dismissed_at: components['schemas']['code-scanning-alert-dismissed-at'] + readonly dismissed_reason: components['schemas']['code-scanning-alert-dismissed-reason'] + readonly rule: components['schemas']['code-scanning-alert-rule'] + readonly tool: components['schemas']['code-scanning-analysis-tool'] + readonly most_recent_instance: components['schemas']['code-scanning-alert-instance'] + } /** * @description Sets the state of the code scanning alert. Can be one of `open` or `dismissed`. You must provide `dismissed_reason` when you set the state to `dismissed`. * @enum {string} */ - readonly "code-scanning-alert-set-state": "open" | "dismissed"; + readonly 'code-scanning-alert-set-state': 'open' | 'dismissed' /** * @description An identifier for the upload. * @example 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 */ - readonly "code-scanning-analysis-sarif-id": string; + readonly 'code-scanning-analysis-sarif-id': string /** @description The SHA of the commit to which the analysis you are uploading relates. */ - readonly "code-scanning-analysis-commit-sha": string; + readonly 'code-scanning-analysis-commit-sha': string /** @description Identifies the variable values associated with the environment in which this analysis was performed. */ - readonly "code-scanning-analysis-environment": string; + readonly 'code-scanning-analysis-environment': string /** * Format: date-time * @description The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "code-scanning-analysis-created-at": string; + readonly 'code-scanning-analysis-created-at': string /** * Format: uri * @description The REST API URL of the analysis resource. */ - readonly "code-scanning-analysis-url": string; - readonly "code-scanning-analysis": { - readonly ref: components["schemas"]["code-scanning-ref"]; - readonly commit_sha: components["schemas"]["code-scanning-analysis-commit-sha"]; - readonly analysis_key: components["schemas"]["code-scanning-analysis-analysis-key"]; - readonly environment: components["schemas"]["code-scanning-analysis-environment"]; - readonly category?: components["schemas"]["code-scanning-analysis-category"]; + readonly 'code-scanning-analysis-url': string + readonly 'code-scanning-analysis': { + readonly ref: components['schemas']['code-scanning-ref'] + readonly commit_sha: components['schemas']['code-scanning-analysis-commit-sha'] + readonly analysis_key: components['schemas']['code-scanning-analysis-analysis-key'] + readonly environment: components['schemas']['code-scanning-analysis-environment'] + readonly category?: components['schemas']['code-scanning-analysis-category'] /** @example error reading field xyz */ - readonly error: string; - readonly created_at: components["schemas"]["code-scanning-analysis-created-at"]; + readonly error: string + readonly created_at: components['schemas']['code-scanning-analysis-created-at'] /** @description The total number of results in the analysis. */ - readonly results_count: number; + readonly results_count: number /** @description The total number of rules used in the analysis. */ - readonly rules_count: number; + readonly rules_count: number /** @description Unique identifier for this analysis. */ - readonly id: number; - readonly url: components["schemas"]["code-scanning-analysis-url"]; - readonly sarif_id: components["schemas"]["code-scanning-analysis-sarif-id"]; - readonly tool: components["schemas"]["code-scanning-analysis-tool"]; - readonly deletable: boolean; + readonly id: number + readonly url: components['schemas']['code-scanning-analysis-url'] + readonly sarif_id: components['schemas']['code-scanning-analysis-sarif-id'] + readonly tool: components['schemas']['code-scanning-analysis-tool'] + readonly deletable: boolean /** * @description Warning generated when processing the analysis * @example 123 results were ignored */ - readonly warning: string; - }; + readonly warning: string + } /** * Analysis deletion * @description Successful deletion of a code scanning analysis */ - readonly "code-scanning-analysis-deletion": { + readonly 'code-scanning-analysis-deletion': { /** * Format: uri * @description Next deletable analysis in chain, without last analysis deletion confirmation */ - readonly next_analysis_url: string | null; + readonly next_analysis_url: string | null /** * Format: uri * @description Next deletable analysis in chain, with last analysis deletion confirmation */ - readonly confirm_delete_url: string | null; - }; + readonly confirm_delete_url: string | null + } /** @description A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see "[SARIF support for code scanning](https://docs.github.com/code-security/secure-coding/sarif-support-for-code-scanning)." */ - readonly "code-scanning-analysis-sarif-file": string; - readonly "code-scanning-sarifs-receipt": { - readonly id?: components["schemas"]["code-scanning-analysis-sarif-id"]; + readonly 'code-scanning-analysis-sarif-file': string + readonly 'code-scanning-sarifs-receipt': { + readonly id?: components['schemas']['code-scanning-analysis-sarif-id'] /** * Format: uri * @description The REST API URL for checking the status of the upload. */ - readonly url?: string; - }; - readonly "code-scanning-sarifs-status": { + readonly url?: string + } + readonly 'code-scanning-sarifs-status': { /** * @description `pending` files have not yet been processed, while `complete` means results from the SARIF have been stored. `failed` files have either not been processed at all, or could only be partially processed. * @enum {string} */ - readonly processing_status?: "pending" | "complete" | "failed"; + readonly processing_status?: 'pending' | 'complete' | 'failed' /** * Format: uri * @description The REST API URL for getting the analyses associated with the upload. */ - readonly analyses_url?: string | null; + readonly analyses_url?: string | null /** @description Any errors that ocurred during processing of the delivery. */ - readonly errors?: readonly string[] | null; - }; + readonly errors?: readonly string[] | null + } /** * Codespace machine * @description A description of the machine powering a codespace. */ - readonly "nullable-codespace-machine": { + readonly 'nullable-codespace-machine': { /** * @description The name of the machine. * @example standardLinux */ - readonly name: string; + readonly name: string /** * @description The display name of the machine includes cores, memory, and storage. * @example 4 cores, 8 GB RAM, 64 GB storage */ - readonly display_name: string; + readonly display_name: string /** * @description The operating system of the machine. * @example linux */ - readonly operating_system: string; + readonly operating_system: string /** * @description How much storage is available to the codespace. * @example 68719476736 */ - readonly storage_in_bytes: number; + readonly storage_in_bytes: number /** * @description How much memory is available to the codespace. * @example 8589934592 */ - readonly memory_in_bytes: number; + readonly memory_in_bytes: number /** * @description How many cores are available to the codespace. * @example 4 */ - readonly cpus: number; + readonly cpus: number /** * @description Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be "null" if prebuilds are not supported or prebuild availability could not be determined. Value is the type of prebuild available, or "none" if none are available. * @example blob * @enum {string|null} */ - readonly prebuild_availability: ("none" | "blob" | "pool") | null; - } | null; + readonly prebuild_availability: ('none' | 'blob' | 'pool') | null + } | null /** * Codespace * @description A codespace. */ readonly codespace: { /** @example 1 */ - readonly id: number; + readonly id: number /** * @description Automatically generated name of this codespace. * @example monalisa-octocat-hello-world-g4wpq6h95q */ - readonly name: string; + readonly name: string /** * @description UUID identifying this codespace's environment. * @example 26a7c758-7299-4a73-b978-5a92a7ae98a0 */ - readonly environment_id: string | null; - readonly owner: components["schemas"]["simple-user"]; - readonly billable_owner: components["schemas"]["simple-user"]; - readonly repository: components["schemas"]["minimal-repository"]; - readonly machine: components["schemas"]["nullable-codespace-machine"]; + readonly environment_id: string | null + readonly owner: components['schemas']['simple-user'] + readonly billable_owner: components['schemas']['simple-user'] + readonly repository: components['schemas']['minimal-repository'] + readonly machine: components['schemas']['nullable-codespace-machine'] /** @description Whether the codespace was created from a prebuild. */ - readonly prebuild: boolean | null; + readonly prebuild: boolean | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly created_at: string; + readonly created_at: string /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly updated_at: string; + readonly updated_at: string /** * Format: date-time * @description Last known time this codespace was started. * @example 2011-01-26T19:01:12Z */ - readonly last_used_at: string; + readonly last_used_at: string /** * @description State of this codespace. * @example Available * @enum {string} */ readonly state: - | "Unknown" - | "Created" - | "Queued" - | "Provisioning" - | "Available" - | "Awaiting" - | "Unavailable" - | "Deleted" - | "Moved" - | "Shutdown" - | "Archived" - | "Starting" - | "ShuttingDown" - | "Failed" - | "Exporting" - | "Updating" - | "Rebuilding"; + | 'Unknown' + | 'Created' + | 'Queued' + | 'Provisioning' + | 'Available' + | 'Awaiting' + | 'Unavailable' + | 'Deleted' + | 'Moved' + | 'Shutdown' + | 'Archived' + | 'Starting' + | 'ShuttingDown' + | 'Failed' + | 'Exporting' + | 'Updating' + | 'Rebuilding' /** * Format: uri * @description API URL for this codespace. */ - readonly url: string; + readonly url: string /** @description Details about the codespace's git repository. */ readonly git_status: { /** @description The number of commits the local repository is ahead of the remote. */ - readonly ahead?: number; + readonly ahead?: number /** @description The number of commits the local repository is behind the remote. */ - readonly behind?: number; + readonly behind?: number /** @description Whether the local repository has unpushed changes. */ - readonly has_unpushed_changes?: boolean; + readonly has_unpushed_changes?: boolean /** @description Whether the local repository has uncommitted changes. */ - readonly has_uncommitted_changes?: boolean; + readonly has_uncommitted_changes?: boolean /** * @description The current branch (or SHA if in detached HEAD state) of the local repository. * @example main */ - readonly ref?: string; - }; + readonly ref?: string + } /** * @description The Azure region where this codespace is located. * @example WestUs2 * @enum {string} */ - readonly location: "EastUs" | "SouthEastAsia" | "WestEurope" | "WestUs2"; + readonly location: 'EastUs' | 'SouthEastAsia' | 'WestEurope' | 'WestUs2' /** * @description The number of minutes of inactivity after which this codespace will be automatically stopped. * @example 60 */ - readonly idle_timeout_minutes: number | null; + readonly idle_timeout_minutes: number | null /** * Format: uri * @description URL to access this codespace on the web. */ - readonly web_url: string; + readonly web_url: string /** * Format: uri * @description API URL to access available alternate machine types for this codespace. */ - readonly machines_url: string; + readonly machines_url: string /** * Format: uri * @description API URL to start this codespace. */ - readonly start_url: string; + readonly start_url: string /** * Format: uri * @description API URL to stop this codespace. */ - readonly stop_url: string; + readonly stop_url: string /** * Format: uri * @description API URL for the Pull Request associated with this codespace, if any. */ - readonly pulls_url: string | null; - readonly recent_folders: readonly string[]; + readonly pulls_url: string | null + readonly recent_folders: readonly string[] readonly runtime_constraints?: { /** @description The privacy settings a user can select from when forwarding a port. */ - readonly allowed_port_privacy_settings?: readonly string[] | null; - }; - }; + readonly allowed_port_privacy_settings?: readonly string[] | null + } + } /** * Codespace machine * @description A description of the machine powering a codespace. */ - readonly "codespace-machine": { + readonly 'codespace-machine': { /** * @description The name of the machine. * @example standardLinux */ - readonly name: string; + readonly name: string /** * @description The display name of the machine includes cores, memory, and storage. * @example 4 cores, 8 GB RAM, 64 GB storage */ - readonly display_name: string; + readonly display_name: string /** * @description The operating system of the machine. * @example linux */ - readonly operating_system: string; + readonly operating_system: string /** * @description How much storage is available to the codespace. * @example 68719476736 */ - readonly storage_in_bytes: number; + readonly storage_in_bytes: number /** * @description How much memory is available to the codespace. * @example 8589934592 */ - readonly memory_in_bytes: number; + readonly memory_in_bytes: number /** * @description How many cores are available to the codespace. * @example 4 */ - readonly cpus: number; + readonly cpus: number /** * @description Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be "null" if prebuilds are not supported or prebuild availability could not be determined. Value is the type of prebuild available, or "none" if none are available. * @example blob * @enum {string|null} */ - readonly prebuild_availability: ("none" | "blob" | "pool") | null; - }; + readonly prebuild_availability: ('none' | 'blob' | 'pool') | null + } /** * Collaborator * @description Collaborator */ readonly collaborator: { /** @example octocat */ - readonly login: string; + readonly login: string /** @example 1 */ - readonly id: number; - readonly email?: string | null; - readonly name?: string | null; + readonly id: number + readonly email?: string | null + readonly name?: string | null /** @example MDQ6VXNlcjE= */ - readonly node_id: string; + readonly node_id: string /** * Format: uri * @example https://github.com/images/error/octocat_happy.gif */ - readonly avatar_url: string; + readonly avatar_url: string /** @example 41d064eb2195891e12d0413f63227ea7 */ - readonly gravatar_id: string | null; + readonly gravatar_id: string | null /** * Format: uri * @example https://api.github.com/users/octocat */ - readonly url: string; + readonly url: string /** * Format: uri * @example https://github.com/octocat */ - readonly html_url: string; + readonly html_url: string /** * Format: uri * @example https://api.github.com/users/octocat/followers */ - readonly followers_url: string; + readonly followers_url: string /** @example https://api.github.com/users/octocat/following{/other_user} */ - readonly following_url: string; + readonly following_url: string /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - readonly gists_url: string; + readonly gists_url: string /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - readonly starred_url: string; + readonly starred_url: string /** * Format: uri * @example https://api.github.com/users/octocat/subscriptions */ - readonly subscriptions_url: string; + readonly subscriptions_url: string /** * Format: uri * @example https://api.github.com/users/octocat/orgs */ - readonly organizations_url: string; + readonly organizations_url: string /** * Format: uri * @example https://api.github.com/users/octocat/repos */ - readonly repos_url: string; + readonly repos_url: string /** @example https://api.github.com/users/octocat/events{/privacy} */ - readonly events_url: string; + readonly events_url: string /** * Format: uri * @example https://api.github.com/users/octocat/received_events */ - readonly received_events_url: string; + readonly received_events_url: string /** @example User */ - readonly type: string; - readonly site_admin: boolean; + readonly type: string + readonly site_admin: boolean readonly permissions?: { - readonly pull: boolean; - readonly triage?: boolean; - readonly push: boolean; - readonly maintain?: boolean; - readonly admin: boolean; - }; + readonly pull: boolean + readonly triage?: boolean + readonly push: boolean + readonly maintain?: boolean + readonly admin: boolean + } /** @example admin */ - readonly role_name: string; - }; + readonly role_name: string + } /** * Repository Invitation * @description Repository invitations let you manage who you collaborate with. */ - readonly "repository-invitation": { + readonly 'repository-invitation': { /** * @description Unique identifier of the repository invitation. * @example 42 */ - readonly id: number; - readonly repository: components["schemas"]["minimal-repository"]; - readonly invitee: components["schemas"]["nullable-simple-user"]; - readonly inviter: components["schemas"]["nullable-simple-user"]; + readonly id: number + readonly repository: components['schemas']['minimal-repository'] + readonly invitee: components['schemas']['nullable-simple-user'] + readonly inviter: components['schemas']['nullable-simple-user'] /** * @description The permission associated with the invitation. * @example read * @enum {string} */ - readonly permissions: "read" | "write" | "admin" | "triage" | "maintain"; + readonly permissions: 'read' | 'write' | 'admin' | 'triage' | 'maintain' /** * Format: date-time * @example 2016-06-13T14:52:50-05:00 */ - readonly created_at: string; + readonly created_at: string /** @description Whether or not the invitation has expired */ - readonly expired?: boolean; + readonly expired?: boolean /** * @description URL for the repository invitation * @example https://api.github.com/user/repository-invitations/1 */ - readonly url: string; + readonly url: string /** @example https://github.com/octocat/Hello-World/invitations */ - readonly html_url: string; - readonly node_id: string; - }; + readonly html_url: string + readonly node_id: string + } /** * Collaborator * @description Collaborator */ - readonly "nullable-collaborator": { + readonly 'nullable-collaborator': { /** @example octocat */ - readonly login: string; + readonly login: string /** @example 1 */ - readonly id: number; - readonly email?: string | null; - readonly name?: string | null; + readonly id: number + readonly email?: string | null + readonly name?: string | null /** @example MDQ6VXNlcjE= */ - readonly node_id: string; + readonly node_id: string /** * Format: uri * @example https://github.com/images/error/octocat_happy.gif */ - readonly avatar_url: string; + readonly avatar_url: string /** @example 41d064eb2195891e12d0413f63227ea7 */ - readonly gravatar_id: string | null; + readonly gravatar_id: string | null /** * Format: uri * @example https://api.github.com/users/octocat */ - readonly url: string; + readonly url: string /** * Format: uri * @example https://github.com/octocat */ - readonly html_url: string; + readonly html_url: string /** * Format: uri * @example https://api.github.com/users/octocat/followers */ - readonly followers_url: string; + readonly followers_url: string /** @example https://api.github.com/users/octocat/following{/other_user} */ - readonly following_url: string; + readonly following_url: string /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - readonly gists_url: string; + readonly gists_url: string /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - readonly starred_url: string; + readonly starred_url: string /** * Format: uri * @example https://api.github.com/users/octocat/subscriptions */ - readonly subscriptions_url: string; + readonly subscriptions_url: string /** * Format: uri * @example https://api.github.com/users/octocat/orgs */ - readonly organizations_url: string; + readonly organizations_url: string /** * Format: uri * @example https://api.github.com/users/octocat/repos */ - readonly repos_url: string; + readonly repos_url: string /** @example https://api.github.com/users/octocat/events{/privacy} */ - readonly events_url: string; + readonly events_url: string /** * Format: uri * @example https://api.github.com/users/octocat/received_events */ - readonly received_events_url: string; + readonly received_events_url: string /** @example User */ - readonly type: string; - readonly site_admin: boolean; + readonly type: string + readonly site_admin: boolean readonly permissions?: { - readonly pull: boolean; - readonly triage?: boolean; - readonly push: boolean; - readonly maintain?: boolean; - readonly admin: boolean; - }; + readonly pull: boolean + readonly triage?: boolean + readonly push: boolean + readonly maintain?: boolean + readonly admin: boolean + } /** @example admin */ - readonly role_name: string; - } | null; + readonly role_name: string + } | null /** * Repository Collaborator Permission * @description Repository Collaborator Permission */ - readonly "repository-collaborator-permission": { - readonly permission: string; + readonly 'repository-collaborator-permission': { + readonly permission: string /** @example admin */ - readonly role_name: string; - readonly user: components["schemas"]["nullable-collaborator"]; - }; + readonly role_name: string + readonly user: components['schemas']['nullable-collaborator'] + } /** * Commit Comment * @description Commit Comment */ - readonly "commit-comment": { + readonly 'commit-comment': { /** Format: uri */ - readonly html_url: string; + readonly html_url: string /** Format: uri */ - readonly url: string; - readonly id: number; - readonly node_id: string; - readonly body: string; - readonly path: string | null; - readonly position: number | null; - readonly line: number | null; - readonly commit_id: string; - readonly user: components["schemas"]["nullable-simple-user"]; + readonly url: string + readonly id: number + readonly node_id: string + readonly body: string + readonly path: string | null + readonly position: number | null + readonly line: number | null + readonly commit_id: string + readonly user: components['schemas']['nullable-simple-user'] /** Format: date-time */ - readonly created_at: string; + readonly created_at: string /** Format: date-time */ - readonly updated_at: string; - readonly author_association: components["schemas"]["author_association"]; - readonly reactions?: components["schemas"]["reaction-rollup"]; - }; + readonly updated_at: string + readonly author_association: components['schemas']['author_association'] + readonly reactions?: components['schemas']['reaction-rollup'] + } /** * Branch Short * @description Branch Short */ - readonly "branch-short": { - readonly name: string; + readonly 'branch-short': { + readonly name: string readonly commit: { - readonly sha: string; - readonly url: string; - }; - readonly protected: boolean; - }; + readonly sha: string + readonly url: string + } + readonly protected: boolean + } /** * Link * @description Hypermedia Link */ readonly link: { - readonly href: string; - }; + readonly href: string + } /** * Auto merge * @description The status of auto merging a pull request. */ readonly auto_merge: { - readonly enabled_by: components["schemas"]["simple-user"]; + readonly enabled_by: components['schemas']['simple-user'] /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + readonly merge_method: 'merge' | 'squash' | 'rebase' /** @description Title for the merge commit message. */ - readonly commit_title: string; + readonly commit_title: string /** @description Commit message for the merge commit. */ - readonly commit_message: string; - } | null; + readonly commit_message: string + } | null /** * Pull Request Simple * @description Pull Request Simple */ - readonly "pull-request-simple": { + readonly 'pull-request-simple': { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ - readonly url: string; + readonly url: string /** @example 1 */ - readonly id: number; + readonly id: number /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ - readonly node_id: string; + readonly node_id: string /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347 */ - readonly html_url: string; + readonly html_url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.diff */ - readonly diff_url: string; + readonly diff_url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.patch */ - readonly patch_url: string; + readonly patch_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 */ - readonly issue_url: string; + readonly issue_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits */ - readonly commits_url: string; + readonly commits_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments */ - readonly review_comments_url: string; + readonly review_comments_url: string /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} */ - readonly review_comment_url: string; + readonly review_comment_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347/comments */ - readonly comments_url: string; + readonly comments_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e */ - readonly statuses_url: string; + readonly statuses_url: string /** @example 1347 */ - readonly number: number; + readonly number: number /** @example open */ - readonly state: string; + readonly state: string /** @example true */ - readonly locked: boolean; + readonly locked: boolean /** @example new-feature */ - readonly title: string; - readonly user: components["schemas"]["nullable-simple-user"]; + readonly title: string + readonly user: components['schemas']['nullable-simple-user'] /** @example Please pull these awesome changes */ - readonly body: string | null; + readonly body: string | null readonly labels: readonly { /** Format: int64 */ - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly name: string; - readonly description: string; - readonly color: string; - readonly default: boolean; - }[]; - readonly milestone: components["schemas"]["nullable-milestone"]; + readonly id: number + readonly node_id: string + readonly url: string + readonly name: string + readonly description: string + readonly color: string + readonly default: boolean + }[] + readonly milestone: components['schemas']['nullable-milestone'] /** @example too heated */ - readonly active_lock_reason?: string | null; + readonly active_lock_reason?: string | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly created_at: string; + readonly created_at: string /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly updated_at: string; + readonly updated_at: string /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly closed_at: string | null; + readonly closed_at: string | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly merged_at: string | null; + readonly merged_at: string | null /** @example e5bd3914e2e596debea16f433f57875b5b90bcd6 */ - readonly merge_commit_sha: string | null; - readonly assignee: components["schemas"]["nullable-simple-user"]; - readonly assignees?: readonly components["schemas"]["simple-user"][] | null; - readonly requested_reviewers?: readonly components["schemas"]["simple-user"][] | null; - readonly requested_teams?: readonly components["schemas"]["team"][] | null; + readonly merge_commit_sha: string | null + readonly assignee: components['schemas']['nullable-simple-user'] + readonly assignees?: readonly components['schemas']['simple-user'][] | null + readonly requested_reviewers?: readonly components['schemas']['simple-user'][] | null + readonly requested_teams?: readonly components['schemas']['team'][] | null readonly head: { - readonly label: string; - readonly ref: string; - readonly repo: components["schemas"]["repository"]; - readonly sha: string; - readonly user: components["schemas"]["nullable-simple-user"]; - }; + readonly label: string + readonly ref: string + readonly repo: components['schemas']['repository'] + readonly sha: string + readonly user: components['schemas']['nullable-simple-user'] + } readonly base: { - readonly label: string; - readonly ref: string; - readonly repo: components["schemas"]["repository"]; - readonly sha: string; - readonly user: components["schemas"]["nullable-simple-user"]; - }; + readonly label: string + readonly ref: string + readonly repo: components['schemas']['repository'] + readonly sha: string + readonly user: components['schemas']['nullable-simple-user'] + } readonly _links: { - readonly comments: components["schemas"]["link"]; - readonly commits: components["schemas"]["link"]; - readonly statuses: components["schemas"]["link"]; - readonly html: components["schemas"]["link"]; - readonly issue: components["schemas"]["link"]; - readonly review_comments: components["schemas"]["link"]; - readonly review_comment: components["schemas"]["link"]; - readonly self: components["schemas"]["link"]; - }; - readonly author_association: components["schemas"]["author_association"]; - readonly auto_merge: components["schemas"]["auto_merge"]; + readonly comments: components['schemas']['link'] + readonly commits: components['schemas']['link'] + readonly statuses: components['schemas']['link'] + readonly html: components['schemas']['link'] + readonly issue: components['schemas']['link'] + readonly review_comments: components['schemas']['link'] + readonly review_comment: components['schemas']['link'] + readonly self: components['schemas']['link'] + } + readonly author_association: components['schemas']['author_association'] + readonly auto_merge: components['schemas']['auto_merge'] /** @description Indicates whether or not the pull request is a draft. */ - readonly draft?: boolean; - }; + readonly draft?: boolean + } /** Simple Commit Status */ - readonly "simple-commit-status": { - readonly description: string | null; - readonly id: number; - readonly node_id: string; - readonly state: string; - readonly context: string; + readonly 'simple-commit-status': { + readonly description: string | null + readonly id: number + readonly node_id: string + readonly state: string + readonly context: string /** Format: uri */ - readonly target_url: string; - readonly required?: boolean | null; + readonly target_url: string + readonly required?: boolean | null /** Format: uri */ - readonly avatar_url: string | null; + readonly avatar_url: string | null /** Format: uri */ - readonly url: string; + readonly url: string /** Format: date-time */ - readonly created_at: string; + readonly created_at: string /** Format: date-time */ - readonly updated_at: string; - }; + readonly updated_at: string + } /** * Combined Commit Status * @description Combined Commit Status */ - readonly "combined-commit-status": { - readonly state: string; - readonly statuses: readonly components["schemas"]["simple-commit-status"][]; - readonly sha: string; - readonly total_count: number; - readonly repository: components["schemas"]["minimal-repository"]; + readonly 'combined-commit-status': { + readonly state: string + readonly statuses: readonly components['schemas']['simple-commit-status'][] + readonly sha: string + readonly total_count: number + readonly repository: components['schemas']['minimal-repository'] /** Format: uri */ - readonly commit_url: string; + readonly commit_url: string /** Format: uri */ - readonly url: string; - }; + readonly url: string + } /** * Status * @description The status of a commit. */ readonly status: { - readonly url: string; - readonly avatar_url: string | null; - readonly id: number; - readonly node_id: string; - readonly state: string; - readonly description: string; - readonly target_url: string; - readonly context: string; - readonly created_at: string; - readonly updated_at: string; - readonly creator: components["schemas"]["nullable-simple-user"]; - }; + readonly url: string + readonly avatar_url: string | null + readonly id: number + readonly node_id: string + readonly state: string + readonly description: string + readonly target_url: string + readonly context: string + readonly created_at: string + readonly updated_at: string + readonly creator: components['schemas']['nullable-simple-user'] + } /** * Code Of Conduct Simple * @description Code of Conduct Simple */ - readonly "nullable-code-of-conduct-simple": { + readonly 'nullable-code-of-conduct-simple': { /** * Format: uri * @example https://api.github.com/repos/github/docs/community/code_of_conduct */ - readonly url: string; + readonly url: string /** @example citizen_code_of_conduct */ - readonly key: string; + readonly key: string /** @example Citizen Code of Conduct */ - readonly name: string; + readonly name: string /** * Format: uri * @example https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md */ - readonly html_url: string | null; - } | null; + readonly html_url: string | null + } | null /** Community Health File */ - readonly "nullable-community-health-file": { + readonly 'nullable-community-health-file': { /** Format: uri */ - readonly url: string; + readonly url: string /** Format: uri */ - readonly html_url: string; - } | null; + readonly html_url: string + } | null /** * Community Profile * @description Community Profile */ - readonly "community-profile": { + readonly 'community-profile': { /** @example 100 */ - readonly health_percentage: number; + readonly health_percentage: number /** @example My first repository on GitHub! */ - readonly description: string | null; + readonly description: string | null /** @example example.com */ - readonly documentation: string | null; + readonly documentation: string | null readonly files: { - readonly code_of_conduct: components["schemas"]["nullable-code-of-conduct-simple"]; - readonly code_of_conduct_file: components["schemas"]["nullable-community-health-file"]; - readonly license: components["schemas"]["nullable-license-simple"]; - readonly contributing: components["schemas"]["nullable-community-health-file"]; - readonly readme: components["schemas"]["nullable-community-health-file"]; - readonly issue_template: components["schemas"]["nullable-community-health-file"]; - readonly pull_request_template: components["schemas"]["nullable-community-health-file"]; - }; + readonly code_of_conduct: components['schemas']['nullable-code-of-conduct-simple'] + readonly code_of_conduct_file: components['schemas']['nullable-community-health-file'] + readonly license: components['schemas']['nullable-license-simple'] + readonly contributing: components['schemas']['nullable-community-health-file'] + readonly readme: components['schemas']['nullable-community-health-file'] + readonly issue_template: components['schemas']['nullable-community-health-file'] + readonly pull_request_template: components['schemas']['nullable-community-health-file'] + } /** * Format: date-time * @example 2017-02-28T19:09:29Z */ - readonly updated_at: string | null; + readonly updated_at: string | null /** @example true */ - readonly content_reports_enabled?: boolean; - }; + readonly content_reports_enabled?: boolean + } /** * Commit Comparison * @description Commit Comparison */ - readonly "commit-comparison": { + readonly 'commit-comparison': { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/compare/master...topic */ - readonly url: string; + readonly url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/compare/master...topic */ - readonly html_url: string; + readonly html_url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17 */ - readonly permalink_url: string; + readonly permalink_url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/compare/master...topic.diff */ - readonly diff_url: string; + readonly diff_url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/compare/master...topic.patch */ - readonly patch_url: string; - readonly base_commit: components["schemas"]["commit"]; - readonly merge_base_commit: components["schemas"]["commit"]; + readonly patch_url: string + readonly base_commit: components['schemas']['commit'] + readonly merge_base_commit: components['schemas']['commit'] /** * @example ahead * @enum {string} */ - readonly status: "diverged" | "ahead" | "behind" | "identical"; + readonly status: 'diverged' | 'ahead' | 'behind' | 'identical' /** @example 4 */ - readonly ahead_by: number; + readonly ahead_by: number /** @example 5 */ - readonly behind_by: number; + readonly behind_by: number /** @example 6 */ - readonly total_commits: number; - readonly commits: readonly components["schemas"]["commit"][]; - readonly files?: readonly components["schemas"]["diff-entry"][]; - }; + readonly total_commits: number + readonly commits: readonly components['schemas']['commit'][] + readonly files?: readonly components['schemas']['diff-entry'][] + } /** * Content Tree * @description Content Tree */ - readonly "content-tree": { - readonly type: string; - readonly size: number; - readonly name: string; - readonly path: string; - readonly sha: string; + readonly 'content-tree': { + readonly type: string + readonly size: number + readonly name: string + readonly path: string + readonly sha: string /** Format: uri */ - readonly url: string; + readonly url: string /** Format: uri */ - readonly git_url: string | null; + readonly git_url: string | null /** Format: uri */ - readonly html_url: string | null; + readonly html_url: string | null /** Format: uri */ - readonly download_url: string | null; + readonly download_url: string | null readonly entries?: readonly { - readonly type: string; - readonly size: number; - readonly name: string; - readonly path: string; - readonly content?: string; - readonly sha: string; + readonly type: string + readonly size: number + readonly name: string + readonly path: string + readonly content?: string + readonly sha: string /** Format: uri */ - readonly url: string; + readonly url: string /** Format: uri */ - readonly git_url: string | null; + readonly git_url: string | null /** Format: uri */ - readonly html_url: string | null; + readonly html_url: string | null /** Format: uri */ - readonly download_url: string | null; + readonly download_url: string | null readonly _links: { /** Format: uri */ - readonly git: string | null; + readonly git: string | null /** Format: uri */ - readonly html: string | null; + readonly html: string | null /** Format: uri */ - readonly self: string; - }; - }[]; + readonly self: string + } + }[] readonly _links: { /** Format: uri */ - readonly git: string | null; + readonly git: string | null /** Format: uri */ - readonly html: string | null; + readonly html: string | null /** Format: uri */ - readonly self: string; - }; + readonly self: string + } } & { - content: unknown; - encoding: unknown; - }; + content: unknown + encoding: unknown + } /** * Content Directory * @description A list of directory items */ - readonly "content-directory": readonly { - readonly type: string; - readonly size: number; - readonly name: string; - readonly path: string; - readonly content?: string; - readonly sha: string; + readonly 'content-directory': readonly { + readonly type: string + readonly size: number + readonly name: string + readonly path: string + readonly content?: string + readonly sha: string /** Format: uri */ - readonly url: string; + readonly url: string /** Format: uri */ - readonly git_url: string | null; + readonly git_url: string | null /** Format: uri */ - readonly html_url: string | null; + readonly html_url: string | null /** Format: uri */ - readonly download_url: string | null; + readonly download_url: string | null readonly _links: { /** Format: uri */ - readonly git: string | null; + readonly git: string | null /** Format: uri */ - readonly html: string | null; + readonly html: string | null /** Format: uri */ - readonly self: string; - }; - }[]; + readonly self: string + } + }[] /** * Content File * @description Content File */ - readonly "content-file": { - readonly type: string; - readonly encoding: string; - readonly size: number; - readonly name: string; - readonly path: string; - readonly content: string; - readonly sha: string; + readonly 'content-file': { + readonly type: string + readonly encoding: string + readonly size: number + readonly name: string + readonly path: string + readonly content: string + readonly sha: string /** Format: uri */ - readonly url: string; + readonly url: string /** Format: uri */ - readonly git_url: string | null; + readonly git_url: string | null /** Format: uri */ - readonly html_url: string | null; + readonly html_url: string | null /** Format: uri */ - readonly download_url: string | null; + readonly download_url: string | null readonly _links: { /** Format: uri */ - readonly git: string | null; + readonly git: string | null /** Format: uri */ - readonly html: string | null; + readonly html: string | null /** Format: uri */ - readonly self: string; - }; + readonly self: string + } /** @example "actual/actual.md" */ - readonly target?: string; + readonly target?: string /** @example "git://example.com/defunkt/dotjs.git" */ - readonly submodule_git_url?: string; - }; + readonly submodule_git_url?: string + } /** * Symlink Content * @description An object describing a symlink */ - readonly "content-symlink": { - readonly type: string; - readonly target: string; - readonly size: number; - readonly name: string; - readonly path: string; - readonly sha: string; + readonly 'content-symlink': { + readonly type: string + readonly target: string + readonly size: number + readonly name: string + readonly path: string + readonly sha: string /** Format: uri */ - readonly url: string; + readonly url: string /** Format: uri */ - readonly git_url: string | null; + readonly git_url: string | null /** Format: uri */ - readonly html_url: string | null; + readonly html_url: string | null /** Format: uri */ - readonly download_url: string | null; + readonly download_url: string | null readonly _links: { /** Format: uri */ - readonly git: string | null; + readonly git: string | null /** Format: uri */ - readonly html: string | null; + readonly html: string | null /** Format: uri */ - readonly self: string; - }; - }; + readonly self: string + } + } /** * Symlink Content * @description An object describing a symlink */ - readonly "content-submodule": { - readonly type: string; + readonly 'content-submodule': { + readonly type: string /** Format: uri */ - readonly submodule_git_url: string; - readonly size: number; - readonly name: string; - readonly path: string; - readonly sha: string; + readonly submodule_git_url: string + readonly size: number + readonly name: string + readonly path: string + readonly sha: string /** Format: uri */ - readonly url: string; + readonly url: string /** Format: uri */ - readonly git_url: string | null; + readonly git_url: string | null /** Format: uri */ - readonly html_url: string | null; + readonly html_url: string | null /** Format: uri */ - readonly download_url: string | null; + readonly download_url: string | null readonly _links: { /** Format: uri */ - readonly git: string | null; + readonly git: string | null /** Format: uri */ - readonly html: string | null; + readonly html: string | null /** Format: uri */ - readonly self: string; - }; - }; + readonly self: string + } + } /** * File Commit * @description File Commit */ - readonly "file-commit": { + readonly 'file-commit': { readonly content: { - readonly name?: string; - readonly path?: string; - readonly sha?: string; - readonly size?: number; - readonly url?: string; - readonly html_url?: string; - readonly git_url?: string; - readonly download_url?: string; - readonly type?: string; + readonly name?: string + readonly path?: string + readonly sha?: string + readonly size?: number + readonly url?: string + readonly html_url?: string + readonly git_url?: string + readonly download_url?: string + readonly type?: string readonly _links?: { - readonly self?: string; - readonly git?: string; - readonly html?: string; - }; - } | null; + readonly self?: string + readonly git?: string + readonly html?: string + } + } | null readonly commit: { - readonly sha?: string; - readonly node_id?: string; - readonly url?: string; - readonly html_url?: string; + readonly sha?: string + readonly node_id?: string + readonly url?: string + readonly html_url?: string readonly author?: { - readonly date?: string; - readonly name?: string; - readonly email?: string; - }; + readonly date?: string + readonly name?: string + readonly email?: string + } readonly committer?: { - readonly date?: string; - readonly name?: string; - readonly email?: string; - }; - readonly message?: string; + readonly date?: string + readonly name?: string + readonly email?: string + } + readonly message?: string readonly tree?: { - readonly url?: string; - readonly sha?: string; - }; + readonly url?: string + readonly sha?: string + } readonly parents?: readonly { - readonly url?: string; - readonly html_url?: string; - readonly sha?: string; - }[]; + readonly url?: string + readonly html_url?: string + readonly sha?: string + }[] readonly verification?: { - readonly verified?: boolean; - readonly reason?: string; - readonly signature?: string | null; - readonly payload?: string | null; - }; - }; - }; + readonly verified?: boolean + readonly reason?: string + readonly signature?: string | null + readonly payload?: string | null + } + } + } /** * Contributor * @description Contributor */ readonly contributor: { - readonly login?: string; - readonly id?: number; - readonly node_id?: string; + readonly login?: string + readonly id?: number + readonly node_id?: string /** Format: uri */ - readonly avatar_url?: string; - readonly gravatar_id?: string | null; + readonly avatar_url?: string + readonly gravatar_id?: string | null /** Format: uri */ - readonly url?: string; + readonly url?: string /** Format: uri */ - readonly html_url?: string; + readonly html_url?: string /** Format: uri */ - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly starred_url?: string; + readonly followers_url?: string + readonly following_url?: string + readonly gists_url?: string + readonly starred_url?: string /** Format: uri */ - readonly subscriptions_url?: string; + readonly subscriptions_url?: string /** Format: uri */ - readonly organizations_url?: string; + readonly organizations_url?: string /** Format: uri */ - readonly repos_url?: string; - readonly events_url?: string; + readonly repos_url?: string + readonly events_url?: string /** Format: uri */ - readonly received_events_url?: string; - readonly type: string; - readonly site_admin?: boolean; - readonly contributions: number; - readonly email?: string; - readonly name?: string; - }; + readonly received_events_url?: string + readonly type: string + readonly site_admin?: boolean + readonly contributions: number + readonly email?: string + readonly name?: string + } /** * Dependabot Secret * @description Set secrets for Dependabot. */ - readonly "dependabot-secret": { + readonly 'dependabot-secret': { /** * @description The name of the secret. * @example MY_ARTIFACTORY_PASSWORD */ - readonly name: string; + readonly name: string /** Format: date-time */ - readonly created_at: string; + readonly created_at: string /** Format: date-time */ - readonly updated_at: string; - }; + readonly updated_at: string + } /** * Deployment Status * @description The status of a deployment. */ - readonly "deployment-status": { + readonly 'deployment-status': { /** * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/42/statuses/1 */ - readonly url: string; + readonly url: string /** @example 1 */ - readonly id: number; + readonly id: number /** @example MDE2OkRlcGxveW1lbnRTdGF0dXMx */ - readonly node_id: string; + readonly node_id: string /** * @description The state of the status. * @example success * @enum {string} */ - readonly state: "error" | "failure" | "inactive" | "pending" | "success" | "queued" | "in_progress"; - readonly creator: components["schemas"]["nullable-simple-user"]; + readonly state: 'error' | 'failure' | 'inactive' | 'pending' | 'success' | 'queued' | 'in_progress' + readonly creator: components['schemas']['nullable-simple-user'] /** * @description A short description of the status. * @example Deployment finished successfully. */ - readonly description: string; + readonly description: string /** * @description The environment of the deployment that the status is for. * @example production */ - readonly environment?: string; + readonly environment?: string /** * Format: uri * @description Deprecated: the URL to associate with this status. * @example https://example.com/deployment/42/output */ - readonly target_url: string; + readonly target_url: string /** * Format: date-time * @example 2012-07-20T01:19:13Z */ - readonly created_at: string; + readonly created_at: string /** * Format: date-time * @example 2012-07-20T01:19:13Z */ - readonly updated_at: string; + readonly updated_at: string /** * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/42 */ - readonly deployment_url: string; + readonly deployment_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/example */ - readonly repository_url: string; + readonly repository_url: string /** * Format: uri * @description The URL for accessing your environment. * @example https://staging.example.com/ */ - readonly environment_url?: string; + readonly environment_url?: string /** * Format: uri * @description The URL to associate with this status. * @example https://example.com/deployment/42/output */ - readonly log_url?: string; - readonly performed_via_github_app?: components["schemas"]["nullable-integration"]; - }; + readonly log_url?: string + readonly performed_via_github_app?: components['schemas']['nullable-integration'] + } /** * @description The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days). * @example 30 */ - readonly "wait-timer": number; + readonly 'wait-timer': number /** @description The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. */ readonly deployment_branch_policy: { /** @description Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`. */ - readonly protected_branches: boolean; + readonly protected_branches: boolean /** @description Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`. */ - readonly custom_branch_policies: boolean; - } | null; + readonly custom_branch_policies: boolean + } | null /** * Environment * @description Details of a deployment environment @@ -13806,97 +13790,97 @@ export interface components { * @description The id of the environment. * @example 56780428 */ - readonly id: number; + readonly id: number /** @example MDExOkVudmlyb25tZW50NTY3ODA0Mjg= */ - readonly node_id: string; + readonly node_id: string /** * @description The name of the environment. * @example staging */ - readonly name: string; + readonly name: string /** @example https://api.github.com/repos/github/hello-world/environments/staging */ - readonly url: string; + readonly url: string /** @example https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging */ - readonly html_url: string; + readonly html_url: string /** * Format: date-time * @description The time that the environment was created, in ISO 8601 format. * @example 2020-11-23T22:00:40Z */ - readonly created_at: string; + readonly created_at: string /** * Format: date-time * @description The time that the environment was last updated, in ISO 8601 format. * @example 2020-11-23T22:00:40Z */ - readonly updated_at: string; + readonly updated_at: string readonly protection_rules?: readonly (Partial<{ /** @example 3515 */ - readonly id: number; + readonly id: number /** @example MDQ6R2F0ZTM1MTU= */ - readonly node_id: string; + readonly node_id: string /** @example wait_timer */ - readonly type: string; - readonly wait_timer?: components["schemas"]["wait-timer"]; + readonly type: string + readonly wait_timer?: components['schemas']['wait-timer'] }> & Partial<{ /** @example 3755 */ - readonly id: number; + readonly id: number /** @example MDQ6R2F0ZTM3NTU= */ - readonly node_id: string; + readonly node_id: string /** @example required_reviewers */ - readonly type: string; + readonly type: string /** @description The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */ readonly reviewers?: readonly { - readonly type?: components["schemas"]["deployment-reviewer-type"]; - readonly reviewer?: Partial & Partial; - }[]; + readonly type?: components['schemas']['deployment-reviewer-type'] + readonly reviewer?: Partial & Partial + }[] }> & Partial<{ /** @example 3515 */ - readonly id: number; + readonly id: number /** @example MDQ6R2F0ZTM1MTU= */ - readonly node_id: string; + readonly node_id: string /** @example branch_policy */ - readonly type: string; - }>)[]; - readonly deployment_branch_policy?: components["schemas"]["deployment_branch_policy"]; - }; + readonly type: string + }>)[] + readonly deployment_branch_policy?: components['schemas']['deployment_branch_policy'] + } /** * Short Blob * @description Short Blob */ - readonly "short-blob": { - readonly url: string; - readonly sha: string; - }; + readonly 'short-blob': { + readonly url: string + readonly sha: string + } /** * Blob * @description Blob */ readonly blob: { - readonly content: string; - readonly encoding: string; + readonly content: string + readonly encoding: string /** Format: uri */ - readonly url: string; - readonly sha: string; - readonly size: number | null; - readonly node_id: string; - readonly highlighted_content?: string; - }; + readonly url: string + readonly sha: string + readonly size: number | null + readonly node_id: string + readonly highlighted_content?: string + } /** * Git Commit * @description Low-level Git commit operations within a repository */ - readonly "git-commit": { + readonly 'git-commit': { /** * @description SHA for the commit * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - readonly sha: string; - readonly node_id: string; + readonly sha: string + readonly node_id: string /** Format: uri */ - readonly url: string; + readonly url: string /** @description Identifying information for the git-user */ readonly author: { /** @@ -13904,18 +13888,18 @@ export interface components { * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 */ - readonly date: string; + readonly date: string /** * @description Git email address of the user * @example monalisa.octocat@example.com */ - readonly email: string; + readonly email: string /** * @description Name of the git user * @example Monalisa Octocat */ - readonly name: string; - }; + readonly name: string + } /** @description Identifying information for the git-user */ readonly committer: { /** @@ -13923,343 +13907,343 @@ export interface components { * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 */ - readonly date: string; + readonly date: string /** * @description Git email address of the user * @example monalisa.octocat@example.com */ - readonly email: string; + readonly email: string /** * @description Name of the git user * @example Monalisa Octocat */ - readonly name: string; - }; + readonly name: string + } /** * @description Message describing the purpose of the commit * @example Fix #42 */ - readonly message: string; + readonly message: string readonly tree: { /** * @description SHA for the commit * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - readonly sha: string; + readonly sha: string /** Format: uri */ - readonly url: string; - }; + readonly url: string + } readonly parents: readonly { /** * @description SHA for the commit * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - readonly sha: string; + readonly sha: string /** Format: uri */ - readonly url: string; + readonly url: string /** Format: uri */ - readonly html_url: string; - }[]; + readonly html_url: string + }[] readonly verification: { - readonly verified: boolean; - readonly reason: string; - readonly signature: string | null; - readonly payload: string | null; - }; + readonly verified: boolean + readonly reason: string + readonly signature: string | null + readonly payload: string | null + } /** Format: uri */ - readonly html_url: string; - }; + readonly html_url: string + } /** * Git Reference * @description Git references within a repository */ - readonly "git-ref": { - readonly ref: string; - readonly node_id: string; + readonly 'git-ref': { + readonly ref: string + readonly node_id: string /** Format: uri */ - readonly url: string; + readonly url: string readonly object: { - readonly type: string; + readonly type: string /** * @description SHA for the reference * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - readonly sha: string; + readonly sha: string /** Format: uri */ - readonly url: string; - }; - }; + readonly url: string + } + } /** * Git Tag * @description Metadata for a Git tag */ - readonly "git-tag": { + readonly 'git-tag': { /** @example MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== */ - readonly node_id: string; + readonly node_id: string /** * @description Name of the tag * @example v0.0.1 */ - readonly tag: string; + readonly tag: string /** @example 940bd336248efae0f9ee5bc7b2d5c985887b16ac */ - readonly sha: string; + readonly sha: string /** * Format: uri * @description URL for the tag * @example https://api.github.com/repositories/42/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac */ - readonly url: string; + readonly url: string /** * @description Message describing the purpose of the tag * @example Initial public release */ - readonly message: string; + readonly message: string readonly tagger: { - readonly date: string; - readonly email: string; - readonly name: string; - }; + readonly date: string + readonly email: string + readonly name: string + } readonly object: { - readonly sha: string; - readonly type: string; + readonly sha: string + readonly type: string /** Format: uri */ - readonly url: string; - }; - readonly verification?: components["schemas"]["verification"]; - }; + readonly url: string + } + readonly verification?: components['schemas']['verification'] + } /** * Git Tree * @description The hierarchy between files in a Git repository. */ - readonly "git-tree": { - readonly sha: string; + readonly 'git-tree': { + readonly sha: string /** Format: uri */ - readonly url: string; - readonly truncated: boolean; + readonly url: string + readonly truncated: boolean /** * @description Objects specifying a tree structure * @example [object Object] */ readonly tree: readonly { /** @example test/file.rb */ - readonly path?: string; + readonly path?: string /** @example 040000 */ - readonly mode?: string; + readonly mode?: string /** @example tree */ - readonly type?: string; + readonly type?: string /** @example 23f6827669e43831def8a7ad935069c8bd418261 */ - readonly sha?: string; + readonly sha?: string /** @example 12 */ - readonly size?: number; + readonly size?: number /** @example https://api.github.com/repos/owner-482f3203ecf01f67e9deb18e/BBB_Private_Repo/git/blobs/23f6827669e43831def8a7ad935069c8bd418261 */ - readonly url?: string; - }[]; - }; + readonly url?: string + }[] + } /** Hook Response */ - readonly "hook-response": { - readonly code: number | null; - readonly status: string | null; - readonly message: string | null; - }; + readonly 'hook-response': { + readonly code: number | null + readonly status: string | null + readonly message: string | null + } /** * Webhook * @description Webhooks for repositories. */ readonly hook: { - readonly type: string; + readonly type: string /** * @description Unique identifier of the webhook. * @example 42 */ - readonly id: number; + readonly id: number /** * @description The name of a valid service, use 'web' for a webhook. * @example web */ - readonly name: string; + readonly name: string /** * @description Determines whether the hook is actually triggered on pushes. * @example true */ - readonly active: boolean; + readonly active: boolean /** * @description Determines what events the hook is triggered for. Default: ['push']. * @example push,pull_request */ - readonly events: readonly string[]; + readonly events: readonly string[] readonly config: { /** @example "foo@bar.com" */ - readonly email?: string; + readonly email?: string /** @example "foo" */ - readonly password?: string; + readonly password?: string /** @example "roomer" */ - readonly room?: string; + readonly room?: string /** @example "foo" */ - readonly subdomain?: string; - readonly url?: components["schemas"]["webhook-config-url"]; - readonly insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - readonly content_type?: components["schemas"]["webhook-config-content-type"]; + readonly subdomain?: string + readonly url?: components['schemas']['webhook-config-url'] + readonly insecure_ssl?: components['schemas']['webhook-config-insecure-ssl'] + readonly content_type?: components['schemas']['webhook-config-content-type'] /** @example "sha256" */ - readonly digest?: string; - readonly secret?: components["schemas"]["webhook-config-secret"]; + readonly digest?: string + readonly secret?: components['schemas']['webhook-config-secret'] /** @example "abc" */ - readonly token?: string; - }; + readonly token?: string + } /** * Format: date-time * @example 2011-09-06T20:39:23Z */ - readonly updated_at: string; + readonly updated_at: string /** * Format: date-time * @example 2011-09-06T17:26:27Z */ - readonly created_at: string; + readonly created_at: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1 */ - readonly url: string; + readonly url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/test */ - readonly test_url: string; + readonly test_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/pings */ - readonly ping_url: string; + readonly ping_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries */ - readonly deliveries_url?: string; - readonly last_response: components["schemas"]["hook-response"]; - }; + readonly deliveries_url?: string + readonly last_response: components['schemas']['hook-response'] + } /** * Import * @description A repository import from an external source. */ readonly import: { - readonly vcs: string | null; - readonly use_lfs?: boolean; + readonly vcs: string | null + readonly use_lfs?: boolean /** @description The URL of the originating repository. */ - readonly vcs_url: string; - readonly svc_root?: string; - readonly tfvc_project?: string; + readonly vcs_url: string + readonly svc_root?: string + readonly tfvc_project?: string /** @enum {string} */ readonly status: - | "auth" - | "error" - | "none" - | "detecting" - | "choose" - | "auth_failed" - | "importing" - | "mapping" - | "waiting_to_push" - | "pushing" - | "complete" - | "setup" - | "unknown" - | "detection_found_multiple" - | "detection_found_nothing" - | "detection_needs_auth"; - readonly status_text?: string | null; - readonly failed_step?: string | null; - readonly error_message?: string | null; - readonly import_percent?: number | null; - readonly commit_count?: number | null; - readonly push_percent?: number | null; - readonly has_large_files?: boolean; - readonly large_files_size?: number; - readonly large_files_count?: number; + | 'auth' + | 'error' + | 'none' + | 'detecting' + | 'choose' + | 'auth_failed' + | 'importing' + | 'mapping' + | 'waiting_to_push' + | 'pushing' + | 'complete' + | 'setup' + | 'unknown' + | 'detection_found_multiple' + | 'detection_found_nothing' + | 'detection_needs_auth' + readonly status_text?: string | null + readonly failed_step?: string | null + readonly error_message?: string | null + readonly import_percent?: number | null + readonly commit_count?: number | null + readonly push_percent?: number | null + readonly has_large_files?: boolean + readonly large_files_size?: number + readonly large_files_count?: number readonly project_choices?: readonly { - readonly vcs?: string; - readonly tfvc_project?: string; - readonly human_name?: string; - }[]; - readonly message?: string; - readonly authors_count?: number | null; + readonly vcs?: string + readonly tfvc_project?: string + readonly human_name?: string + }[] + readonly message?: string + readonly authors_count?: number | null /** Format: uri */ - readonly url: string; + readonly url: string /** Format: uri */ - readonly html_url: string; + readonly html_url: string /** Format: uri */ - readonly authors_url: string; + readonly authors_url: string /** Format: uri */ - readonly repository_url: string; - readonly svn_root?: string; - }; + readonly repository_url: string + readonly svn_root?: string + } /** * Porter Author * @description Porter Author */ - readonly "porter-author": { - readonly id: number; - readonly remote_id: string; - readonly remote_name: string; - readonly email: string; - readonly name: string; + readonly 'porter-author': { + readonly id: number + readonly remote_id: string + readonly remote_name: string + readonly email: string + readonly name: string /** Format: uri */ - readonly url: string; + readonly url: string /** Format: uri */ - readonly import_url: string; - }; + readonly import_url: string + } /** * Porter Large File * @description Porter Large File */ - readonly "porter-large-file": { - readonly ref_name: string; - readonly path: string; - readonly oid: string; - readonly size: number; - }; + readonly 'porter-large-file': { + readonly ref_name: string + readonly path: string + readonly oid: string + readonly size: number + } /** * Issue * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. */ - readonly "nullable-issue": { - readonly id: number; - readonly node_id: string; + readonly 'nullable-issue': { + readonly id: number + readonly node_id: string /** * Format: uri * @description URL for the issue * @example https://api.github.com/repositories/42/issues/1 */ - readonly url: string; + readonly url: string /** Format: uri */ - readonly repository_url: string; - readonly labels_url: string; + readonly repository_url: string + readonly labels_url: string /** Format: uri */ - readonly comments_url: string; + readonly comments_url: string /** Format: uri */ - readonly events_url: string; + readonly events_url: string /** Format: uri */ - readonly html_url: string; + readonly html_url: string /** * @description Number uniquely identifying the issue within its repository * @example 42 */ - readonly number: number; + readonly number: number /** * @description State of the issue; either 'open' or 'closed' * @example open */ - readonly state: string; + readonly state: string /** * @description Title of the issue * @example Widget creation fails in Safari on OS X 10.8 */ - readonly title: string; + readonly title: string /** * @description Contents of the issue * @example It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug? */ - readonly body?: string | null; - readonly user: components["schemas"]["nullable-simple-user"]; + readonly body?: string | null + readonly user: components['schemas']['nullable-simple-user'] /** * @description Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository * @example bug,registration @@ -14268,456 +14252,456 @@ export interface components { | string | { /** Format: int64 */ - readonly id?: number; - readonly node_id?: string; + readonly id?: number + readonly node_id?: string /** Format: uri */ - readonly url?: string; - readonly name?: string; - readonly description?: string | null; - readonly color?: string | null; - readonly default?: boolean; + readonly url?: string + readonly name?: string + readonly description?: string | null + readonly color?: string | null + readonly default?: boolean } - )[]; - readonly assignee: components["schemas"]["nullable-simple-user"]; - readonly assignees?: readonly components["schemas"]["simple-user"][] | null; - readonly milestone: components["schemas"]["nullable-milestone"]; - readonly locked: boolean; - readonly active_lock_reason?: string | null; - readonly comments: number; + )[] + readonly assignee: components['schemas']['nullable-simple-user'] + readonly assignees?: readonly components['schemas']['simple-user'][] | null + readonly milestone: components['schemas']['nullable-milestone'] + readonly locked: boolean + readonly active_lock_reason?: string | null + readonly comments: number readonly pull_request?: { /** Format: date-time */ - readonly merged_at?: string | null; + readonly merged_at?: string | null /** Format: uri */ - readonly diff_url: string | null; + readonly diff_url: string | null /** Format: uri */ - readonly html_url: string | null; + readonly html_url: string | null /** Format: uri */ - readonly patch_url: string | null; + readonly patch_url: string | null /** Format: uri */ - readonly url: string | null; - }; + readonly url: string | null + } /** Format: date-time */ - readonly closed_at: string | null; + readonly closed_at: string | null /** Format: date-time */ - readonly created_at: string; + readonly created_at: string /** Format: date-time */ - readonly updated_at: string; - readonly draft?: boolean; - readonly closed_by?: components["schemas"]["nullable-simple-user"]; - readonly body_html?: string; - readonly body_text?: string; + readonly updated_at: string + readonly draft?: boolean + readonly closed_by?: components['schemas']['nullable-simple-user'] + readonly body_html?: string + readonly body_text?: string /** Format: uri */ - readonly timeline_url?: string; - readonly repository?: components["schemas"]["repository"]; - readonly performed_via_github_app?: components["schemas"]["nullable-integration"]; - readonly author_association: components["schemas"]["author_association"]; - readonly reactions?: components["schemas"]["reaction-rollup"]; - } | null; + readonly timeline_url?: string + readonly repository?: components['schemas']['repository'] + readonly performed_via_github_app?: components['schemas']['nullable-integration'] + readonly author_association: components['schemas']['author_association'] + readonly reactions?: components['schemas']['reaction-rollup'] + } | null /** * Issue Event Label * @description Issue Event Label */ - readonly "issue-event-label": { - readonly name: string | null; - readonly color: string | null; - }; + readonly 'issue-event-label': { + readonly name: string | null + readonly color: string | null + } /** Issue Event Dismissed Review */ - readonly "issue-event-dismissed-review": { - readonly state: string; - readonly review_id: number; - readonly dismissal_message: string | null; - readonly dismissal_commit_id?: string | null; - }; + readonly 'issue-event-dismissed-review': { + readonly state: string + readonly review_id: number + readonly dismissal_message: string | null + readonly dismissal_commit_id?: string | null + } /** * Issue Event Milestone * @description Issue Event Milestone */ - readonly "issue-event-milestone": { - readonly title: string; - }; + readonly 'issue-event-milestone': { + readonly title: string + } /** * Issue Event Project Card * @description Issue Event Project Card */ - readonly "issue-event-project-card": { + readonly 'issue-event-project-card': { /** Format: uri */ - readonly url: string; - readonly id: number; + readonly url: string + readonly id: number /** Format: uri */ - readonly project_url: string; - readonly project_id: number; - readonly column_name: string; - readonly previous_column_name?: string; - }; + readonly project_url: string + readonly project_id: number + readonly column_name: string + readonly previous_column_name?: string + } /** * Issue Event Rename * @description Issue Event Rename */ - readonly "issue-event-rename": { - readonly from: string; - readonly to: string; - }; + readonly 'issue-event-rename': { + readonly from: string + readonly to: string + } /** * Issue Event * @description Issue Event */ - readonly "issue-event": { + readonly 'issue-event': { /** @example 1 */ - readonly id: number; + readonly id: number /** @example MDEwOklzc3VlRXZlbnQx */ - readonly node_id: string; + readonly node_id: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/events/1 */ - readonly url: string; - readonly actor: components["schemas"]["nullable-simple-user"]; + readonly url: string + readonly actor: components['schemas']['nullable-simple-user'] /** @example closed */ - readonly event: string; + readonly event: string /** @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */ - readonly commit_id: string | null; + readonly commit_id: string | null /** @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e */ - readonly commit_url: string | null; + readonly commit_url: string | null /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - readonly created_at: string; - readonly issue?: components["schemas"]["nullable-issue"]; - readonly label?: components["schemas"]["issue-event-label"]; - readonly assignee?: components["schemas"]["nullable-simple-user"]; - readonly assigner?: components["schemas"]["nullable-simple-user"]; - readonly review_requester?: components["schemas"]["nullable-simple-user"]; - readonly requested_reviewer?: components["schemas"]["nullable-simple-user"]; - readonly requested_team?: components["schemas"]["team"]; - readonly dismissed_review?: components["schemas"]["issue-event-dismissed-review"]; - readonly milestone?: components["schemas"]["issue-event-milestone"]; - readonly project_card?: components["schemas"]["issue-event-project-card"]; - readonly rename?: components["schemas"]["issue-event-rename"]; - readonly author_association?: components["schemas"]["author_association"]; - readonly lock_reason?: string | null; - readonly performed_via_github_app?: components["schemas"]["nullable-integration"]; - }; + readonly created_at: string + readonly issue?: components['schemas']['nullable-issue'] + readonly label?: components['schemas']['issue-event-label'] + readonly assignee?: components['schemas']['nullable-simple-user'] + readonly assigner?: components['schemas']['nullable-simple-user'] + readonly review_requester?: components['schemas']['nullable-simple-user'] + readonly requested_reviewer?: components['schemas']['nullable-simple-user'] + readonly requested_team?: components['schemas']['team'] + readonly dismissed_review?: components['schemas']['issue-event-dismissed-review'] + readonly milestone?: components['schemas']['issue-event-milestone'] + readonly project_card?: components['schemas']['issue-event-project-card'] + readonly rename?: components['schemas']['issue-event-rename'] + readonly author_association?: components['schemas']['author_association'] + readonly lock_reason?: string | null + readonly performed_via_github_app?: components['schemas']['nullable-integration'] + } /** * Labeled Issue Event * @description Labeled Issue Event */ - readonly "labeled-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; + readonly 'labeled-issue-event': { + readonly id: number + readonly node_id: string + readonly url: string + readonly actor: components['schemas']['simple-user'] + readonly event: string + readonly commit_id: string | null + readonly commit_url: string | null + readonly created_at: string + readonly performed_via_github_app: components['schemas']['nullable-integration'] readonly label: { - readonly name: string; - readonly color: string; - }; - }; + readonly name: string + readonly color: string + } + } /** * Unlabeled Issue Event * @description Unlabeled Issue Event */ - readonly "unlabeled-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; + readonly 'unlabeled-issue-event': { + readonly id: number + readonly node_id: string + readonly url: string + readonly actor: components['schemas']['simple-user'] + readonly event: string + readonly commit_id: string | null + readonly commit_url: string | null + readonly created_at: string + readonly performed_via_github_app: components['schemas']['nullable-integration'] readonly label: { - readonly name: string; - readonly color: string; - }; - }; + readonly name: string + readonly color: string + } + } /** * Assigned Issue Event * @description Assigned Issue Event */ - readonly "assigned-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["integration"]; - readonly assignee: components["schemas"]["simple-user"]; - readonly assigner: components["schemas"]["simple-user"]; - }; + readonly 'assigned-issue-event': { + readonly id: number + readonly node_id: string + readonly url: string + readonly actor: components['schemas']['simple-user'] + readonly event: string + readonly commit_id: string | null + readonly commit_url: string | null + readonly created_at: string + readonly performed_via_github_app: components['schemas']['integration'] + readonly assignee: components['schemas']['simple-user'] + readonly assigner: components['schemas']['simple-user'] + } /** * Unassigned Issue Event * @description Unassigned Issue Event */ - readonly "unassigned-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; - readonly assignee: components["schemas"]["simple-user"]; - readonly assigner: components["schemas"]["simple-user"]; - }; + readonly 'unassigned-issue-event': { + readonly id: number + readonly node_id: string + readonly url: string + readonly actor: components['schemas']['simple-user'] + readonly event: string + readonly commit_id: string | null + readonly commit_url: string | null + readonly created_at: string + readonly performed_via_github_app: components['schemas']['nullable-integration'] + readonly assignee: components['schemas']['simple-user'] + readonly assigner: components['schemas']['simple-user'] + } /** * Milestoned Issue Event * @description Milestoned Issue Event */ - readonly "milestoned-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; + readonly 'milestoned-issue-event': { + readonly id: number + readonly node_id: string + readonly url: string + readonly actor: components['schemas']['simple-user'] + readonly event: string + readonly commit_id: string | null + readonly commit_url: string | null + readonly created_at: string + readonly performed_via_github_app: components['schemas']['nullable-integration'] readonly milestone: { - readonly title: string; - }; - }; + readonly title: string + } + } /** * Demilestoned Issue Event * @description Demilestoned Issue Event */ - readonly "demilestoned-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; + readonly 'demilestoned-issue-event': { + readonly id: number + readonly node_id: string + readonly url: string + readonly actor: components['schemas']['simple-user'] + readonly event: string + readonly commit_id: string | null + readonly commit_url: string | null + readonly created_at: string + readonly performed_via_github_app: components['schemas']['nullable-integration'] readonly milestone: { - readonly title: string; - }; - }; + readonly title: string + } + } /** * Renamed Issue Event * @description Renamed Issue Event */ - readonly "renamed-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; + readonly 'renamed-issue-event': { + readonly id: number + readonly node_id: string + readonly url: string + readonly actor: components['schemas']['simple-user'] + readonly event: string + readonly commit_id: string | null + readonly commit_url: string | null + readonly created_at: string + readonly performed_via_github_app: components['schemas']['nullable-integration'] readonly rename: { - readonly from: string; - readonly to: string; - }; - }; + readonly from: string + readonly to: string + } + } /** * Review Requested Issue Event * @description Review Requested Issue Event */ - readonly "review-requested-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; - readonly review_requester: components["schemas"]["simple-user"]; - readonly requested_team?: components["schemas"]["team"]; - readonly requested_reviewer?: components["schemas"]["simple-user"]; - }; + readonly 'review-requested-issue-event': { + readonly id: number + readonly node_id: string + readonly url: string + readonly actor: components['schemas']['simple-user'] + readonly event: string + readonly commit_id: string | null + readonly commit_url: string | null + readonly created_at: string + readonly performed_via_github_app: components['schemas']['nullable-integration'] + readonly review_requester: components['schemas']['simple-user'] + readonly requested_team?: components['schemas']['team'] + readonly requested_reviewer?: components['schemas']['simple-user'] + } /** * Review Request Removed Issue Event * @description Review Request Removed Issue Event */ - readonly "review-request-removed-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; - readonly review_requester: components["schemas"]["simple-user"]; - readonly requested_team?: components["schemas"]["team"]; - readonly requested_reviewer?: components["schemas"]["simple-user"]; - }; + readonly 'review-request-removed-issue-event': { + readonly id: number + readonly node_id: string + readonly url: string + readonly actor: components['schemas']['simple-user'] + readonly event: string + readonly commit_id: string | null + readonly commit_url: string | null + readonly created_at: string + readonly performed_via_github_app: components['schemas']['nullable-integration'] + readonly review_requester: components['schemas']['simple-user'] + readonly requested_team?: components['schemas']['team'] + readonly requested_reviewer?: components['schemas']['simple-user'] + } /** * Review Dismissed Issue Event * @description Review Dismissed Issue Event */ - readonly "review-dismissed-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; + readonly 'review-dismissed-issue-event': { + readonly id: number + readonly node_id: string + readonly url: string + readonly actor: components['schemas']['simple-user'] + readonly event: string + readonly commit_id: string | null + readonly commit_url: string | null + readonly created_at: string + readonly performed_via_github_app: components['schemas']['nullable-integration'] readonly dismissed_review: { - readonly state: string; - readonly review_id: number; - readonly dismissal_message: string | null; - readonly dismissal_commit_id?: string; - }; - }; + readonly state: string + readonly review_id: number + readonly dismissal_message: string | null + readonly dismissal_commit_id?: string + } + } /** * Locked Issue Event * @description Locked Issue Event */ - readonly "locked-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; + readonly 'locked-issue-event': { + readonly id: number + readonly node_id: string + readonly url: string + readonly actor: components['schemas']['simple-user'] + readonly event: string + readonly commit_id: string | null + readonly commit_url: string | null + readonly created_at: string + readonly performed_via_github_app: components['schemas']['nullable-integration'] /** @example "off-topic" */ - readonly lock_reason: string | null; - }; + readonly lock_reason: string | null + } /** * Added to Project Issue Event * @description Added to Project Issue Event */ - readonly "added-to-project-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; + readonly 'added-to-project-issue-event': { + readonly id: number + readonly node_id: string + readonly url: string + readonly actor: components['schemas']['simple-user'] + readonly event: string + readonly commit_id: string | null + readonly commit_url: string | null + readonly created_at: string + readonly performed_via_github_app: components['schemas']['nullable-integration'] readonly project_card?: { - readonly id: number; + readonly id: number /** Format: uri */ - readonly url: string; - readonly project_id: number; + readonly url: string + readonly project_id: number /** Format: uri */ - readonly project_url: string; - readonly column_name: string; - readonly previous_column_name?: string; - }; - }; + readonly project_url: string + readonly column_name: string + readonly previous_column_name?: string + } + } /** * Moved Column in Project Issue Event * @description Moved Column in Project Issue Event */ - readonly "moved-column-in-project-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; + readonly 'moved-column-in-project-issue-event': { + readonly id: number + readonly node_id: string + readonly url: string + readonly actor: components['schemas']['simple-user'] + readonly event: string + readonly commit_id: string | null + readonly commit_url: string | null + readonly created_at: string + readonly performed_via_github_app: components['schemas']['nullable-integration'] readonly project_card?: { - readonly id: number; + readonly id: number /** Format: uri */ - readonly url: string; - readonly project_id: number; + readonly url: string + readonly project_id: number /** Format: uri */ - readonly project_url: string; - readonly column_name: string; - readonly previous_column_name?: string; - }; - }; + readonly project_url: string + readonly column_name: string + readonly previous_column_name?: string + } + } /** * Removed from Project Issue Event * @description Removed from Project Issue Event */ - readonly "removed-from-project-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; + readonly 'removed-from-project-issue-event': { + readonly id: number + readonly node_id: string + readonly url: string + readonly actor: components['schemas']['simple-user'] + readonly event: string + readonly commit_id: string | null + readonly commit_url: string | null + readonly created_at: string + readonly performed_via_github_app: components['schemas']['nullable-integration'] readonly project_card?: { - readonly id: number; + readonly id: number /** Format: uri */ - readonly url: string; - readonly project_id: number; + readonly url: string + readonly project_id: number /** Format: uri */ - readonly project_url: string; - readonly column_name: string; - readonly previous_column_name?: string; - }; - }; + readonly project_url: string + readonly column_name: string + readonly previous_column_name?: string + } + } /** * Converted Note to Issue Issue Event * @description Converted Note to Issue Issue Event */ - readonly "converted-note-to-issue-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["integration"]; + readonly 'converted-note-to-issue-issue-event': { + readonly id: number + readonly node_id: string + readonly url: string + readonly actor: components['schemas']['simple-user'] + readonly event: string + readonly commit_id: string | null + readonly commit_url: string | null + readonly created_at: string + readonly performed_via_github_app: components['schemas']['integration'] readonly project_card?: { - readonly id: number; + readonly id: number /** Format: uri */ - readonly url: string; - readonly project_id: number; + readonly url: string + readonly project_id: number /** Format: uri */ - readonly project_url: string; - readonly column_name: string; - readonly previous_column_name?: string; - }; - }; + readonly project_url: string + readonly column_name: string + readonly previous_column_name?: string + } + } /** * Issue Event for Issue * @description Issue Event for Issue */ - readonly "issue-event-for-issue": Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial; + readonly 'issue-event-for-issue': Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial /** * Label * @description Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -14727,105 +14711,105 @@ export interface components { * Format: int64 * @example 208045946 */ - readonly id: number; + readonly id: number /** @example MDU6TGFiZWwyMDgwNDU5NDY= */ - readonly node_id: string; + readonly node_id: string /** * Format: uri * @description URL for the label * @example https://api.github.com/repositories/42/labels/bug */ - readonly url: string; + readonly url: string /** * @description The name of the label. * @example bug */ - readonly name: string; + readonly name: string /** @example Something isn't working */ - readonly description: string | null; + readonly description: string | null /** * @description 6-character hex code, without the leading #, identifying the color * @example FFFFFF */ - readonly color: string; + readonly color: string /** @example true */ - readonly default: boolean; - }; + readonly default: boolean + } /** * Timeline Comment Event * @description Timeline Comment Event */ - readonly "timeline-comment-event": { - readonly event: string; - readonly actor: components["schemas"]["simple-user"]; + readonly 'timeline-comment-event': { + readonly event: string + readonly actor: components['schemas']['simple-user'] /** * @description Unique identifier of the issue comment * @example 42 */ - readonly id: number; - readonly node_id: string; + readonly id: number + readonly node_id: string /** * Format: uri * @description URL for the issue comment * @example https://api.github.com/repositories/42/issues/comments/1 */ - readonly url: string; + readonly url: string /** * @description Contents of the issue comment * @example What version of Safari were you using when you observed this bug? */ - readonly body?: string; - readonly body_text?: string; - readonly body_html?: string; + readonly body?: string + readonly body_text?: string + readonly body_html?: string /** Format: uri */ - readonly html_url: string; - readonly user: components["schemas"]["simple-user"]; + readonly html_url: string + readonly user: components['schemas']['simple-user'] /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - readonly created_at: string; + readonly created_at: string /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - readonly updated_at: string; + readonly updated_at: string /** Format: uri */ - readonly issue_url: string; - readonly author_association: components["schemas"]["author_association"]; - readonly performed_via_github_app?: components["schemas"]["nullable-integration"]; - readonly reactions?: components["schemas"]["reaction-rollup"]; - }; + readonly issue_url: string + readonly author_association: components['schemas']['author_association'] + readonly performed_via_github_app?: components['schemas']['nullable-integration'] + readonly reactions?: components['schemas']['reaction-rollup'] + } /** * Timeline Cross Referenced Event * @description Timeline Cross Referenced Event */ - readonly "timeline-cross-referenced-event": { - readonly event: string; - readonly actor?: components["schemas"]["simple-user"]; + readonly 'timeline-cross-referenced-event': { + readonly event: string + readonly actor?: components['schemas']['simple-user'] /** Format: date-time */ - readonly created_at: string; + readonly created_at: string /** Format: date-time */ - readonly updated_at: string; + readonly updated_at: string readonly source: { - readonly type?: string; - readonly issue?: components["schemas"]["issue"]; - }; - }; + readonly type?: string + readonly issue?: components['schemas']['issue'] + } + } /** * Timeline Committed Event * @description Timeline Committed Event */ - readonly "timeline-committed-event": { - readonly event?: string; + readonly 'timeline-committed-event': { + readonly event?: string /** * @description SHA for the commit * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - readonly sha: string; - readonly node_id: string; + readonly sha: string + readonly node_id: string /** Format: uri */ - readonly url: string; + readonly url: string /** @description Identifying information for the git-user */ readonly author: { /** @@ -14833,18 +14817,18 @@ export interface components { * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 */ - readonly date: string; + readonly date: string /** * @description Git email address of the user * @example monalisa.octocat@example.com */ - readonly email: string; + readonly email: string /** * @description Name of the git user * @example Monalisa Octocat */ - readonly name: string; - }; + readonly name: string + } /** @description Identifying information for the git-user */ readonly committer: { /** @@ -14852,386 +14836,386 @@ export interface components { * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 */ - readonly date: string; + readonly date: string /** * @description Git email address of the user * @example monalisa.octocat@example.com */ - readonly email: string; + readonly email: string /** * @description Name of the git user * @example Monalisa Octocat */ - readonly name: string; - }; + readonly name: string + } /** * @description Message describing the purpose of the commit * @example Fix #42 */ - readonly message: string; + readonly message: string readonly tree: { /** * @description SHA for the commit * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - readonly sha: string; + readonly sha: string /** Format: uri */ - readonly url: string; - }; + readonly url: string + } readonly parents: readonly { /** * @description SHA for the commit * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - readonly sha: string; + readonly sha: string /** Format: uri */ - readonly url: string; + readonly url: string /** Format: uri */ - readonly html_url: string; - }[]; + readonly html_url: string + }[] readonly verification: { - readonly verified: boolean; - readonly reason: string; - readonly signature: string | null; - readonly payload: string | null; - }; + readonly verified: boolean + readonly reason: string + readonly signature: string | null + readonly payload: string | null + } /** Format: uri */ - readonly html_url: string; - }; + readonly html_url: string + } /** * Timeline Reviewed Event * @description Timeline Reviewed Event */ - readonly "timeline-reviewed-event": { - readonly event: string; + readonly 'timeline-reviewed-event': { + readonly event: string /** * @description Unique identifier of the review * @example 42 */ - readonly id: number; + readonly id: number /** @example MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= */ - readonly node_id: string; - readonly user: components["schemas"]["simple-user"]; + readonly node_id: string + readonly user: components['schemas']['simple-user'] /** * @description The text of the review. * @example This looks great. */ - readonly body: string | null; + readonly body: string | null /** @example CHANGES_REQUESTED */ - readonly state: string; + readonly state: string /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 */ - readonly html_url: string; + readonly html_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/12 */ - readonly pull_request_url: string; + readonly pull_request_url: string readonly _links: { readonly html: { - readonly href: string; - }; + readonly href: string + } readonly pull_request: { - readonly href: string; - }; - }; + readonly href: string + } + } /** Format: date-time */ - readonly submitted_at?: string; + readonly submitted_at?: string /** * @description A commit SHA for the review. * @example 54bb654c9e6025347f57900a4a5c2313a96b8035 */ - readonly commit_id: string; - readonly body_html?: string; - readonly body_text?: string; - readonly author_association: components["schemas"]["author_association"]; - }; + readonly commit_id: string + readonly body_html?: string + readonly body_text?: string + readonly author_association: components['schemas']['author_association'] + } /** * Pull Request Review Comment * @description Pull Request Review Comments are comments on a portion of the Pull Request's diff. */ - readonly "pull-request-review-comment": { + readonly 'pull-request-review-comment': { /** * @description URL for the pull request review comment * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ - readonly url: string; + readonly url: string /** * @description The ID of the pull request review to which the comment belongs. * @example 42 */ - readonly pull_request_review_id: number | null; + readonly pull_request_review_id: number | null /** * @description The ID of the pull request review comment. * @example 1 */ - readonly id: number; + readonly id: number /** * @description The node ID of the pull request review comment. * @example MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw */ - readonly node_id: string; + readonly node_id: string /** * @description The diff of the line that the comment refers to. * @example @@ -16,33 +16,40 @@ public class Connection : IConnection... */ - readonly diff_hunk: string; + readonly diff_hunk: string /** * @description The relative path of the file to which the comment applies. * @example config/database.yaml */ - readonly path: string; + readonly path: string /** * @description The line index in the diff to which the comment applies. * @example 1 */ - readonly position: number; + readonly position: number /** * @description The index of the original line in the diff to which the comment applies. * @example 4 */ - readonly original_position: number; + readonly original_position: number /** * @description The SHA of the commit to which the comment applies. * @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */ - readonly commit_id: string; + readonly commit_id: string /** * @description The SHA of the original commit to which the comment applies. * @example 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 */ - readonly original_commit_id: string; + readonly original_commit_id: string /** * @description The comment ID to reply to. * @example 8 */ - readonly in_reply_to_id?: number; - readonly user: components["schemas"]["simple-user"]; + readonly in_reply_to_id?: number + readonly user: components['schemas']['simple-user'] /** * @description The text of the comment. * @example We should probably include a check for null values here. */ - readonly body: string; + readonly body: string /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - readonly created_at: string; + readonly created_at: string /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - readonly updated_at: string; + readonly updated_at: string /** * Format: uri * @description HTML URL for the pull request review comment. * @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 */ - readonly html_url: string; + readonly html_url: string /** * Format: uri * @description URL for the pull request that the review comment belongs to. * @example https://api.github.com/repos/octocat/Hello-World/pulls/1 */ - readonly pull_request_url: string; - readonly author_association: components["schemas"]["author_association"]; + readonly pull_request_url: string + readonly author_association: components['schemas']['author_association'] readonly _links: { readonly self: { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ - readonly href: string; - }; + readonly href: string + } readonly html: { /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 */ - readonly href: string; - }; + readonly href: string + } readonly pull_request: { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1 */ - readonly href: string; - }; - }; + readonly href: string + } + } /** * @description The first line of the range for a multi-line comment. * @example 2 */ - readonly start_line?: number | null; + readonly start_line?: number | null /** * @description The first line of the range for a multi-line comment. * @example 2 */ - readonly original_start_line?: number | null; + readonly original_start_line?: number | null /** * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} */ - readonly start_side?: ("LEFT" | "RIGHT") | null; + readonly start_side?: ('LEFT' | 'RIGHT') | null /** * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment * @example 2 */ - readonly line?: number; + readonly line?: number /** * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment * @example 2 */ - readonly original_line?: number; + readonly original_line?: number /** * @description The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment * @default RIGHT * @enum {string} */ - readonly side?: "LEFT" | "RIGHT"; - readonly reactions?: components["schemas"]["reaction-rollup"]; + readonly side?: 'LEFT' | 'RIGHT' + readonly reactions?: components['schemas']['reaction-rollup'] /** @example "

comment body

" */ - readonly body_html?: string; + readonly body_html?: string /** @example "comment body" */ - readonly body_text?: string; - }; + readonly body_text?: string + } /** * Timeline Line Commented Event * @description Timeline Line Commented Event */ - readonly "timeline-line-commented-event": { - readonly event?: string; - readonly node_id?: string; - readonly comments?: readonly components["schemas"]["pull-request-review-comment"][]; - }; + readonly 'timeline-line-commented-event': { + readonly event?: string + readonly node_id?: string + readonly comments?: readonly components['schemas']['pull-request-review-comment'][] + } /** * Timeline Commit Commented Event * @description Timeline Commit Commented Event */ - readonly "timeline-commit-commented-event": { - readonly event?: string; - readonly node_id?: string; - readonly commit_id?: string; - readonly comments?: readonly components["schemas"]["commit-comment"][]; - }; + readonly 'timeline-commit-commented-event': { + readonly event?: string + readonly node_id?: string + readonly commit_id?: string + readonly comments?: readonly components['schemas']['commit-comment'][] + } /** * Timeline Assigned Issue Event * @description Timeline Assigned Issue Event */ - readonly "timeline-assigned-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; - readonly assignee: components["schemas"]["simple-user"]; - }; + readonly 'timeline-assigned-issue-event': { + readonly id: number + readonly node_id: string + readonly url: string + readonly actor: components['schemas']['simple-user'] + readonly event: string + readonly commit_id: string | null + readonly commit_url: string | null + readonly created_at: string + readonly performed_via_github_app: components['schemas']['nullable-integration'] + readonly assignee: components['schemas']['simple-user'] + } /** * Timeline Unassigned Issue Event * @description Timeline Unassigned Issue Event */ - readonly "timeline-unassigned-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; - readonly assignee: components["schemas"]["simple-user"]; - }; + readonly 'timeline-unassigned-issue-event': { + readonly id: number + readonly node_id: string + readonly url: string + readonly actor: components['schemas']['simple-user'] + readonly event: string + readonly commit_id: string | null + readonly commit_url: string | null + readonly created_at: string + readonly performed_via_github_app: components['schemas']['nullable-integration'] + readonly assignee: components['schemas']['simple-user'] + } /** * Timeline Event * @description Timeline Event */ - readonly "timeline-issue-events": Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial; + readonly 'timeline-issue-events': Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial /** * Deploy Key * @description An SSH key granting access to a single repository. */ - readonly "deploy-key": { - readonly id: number; - readonly key: string; - readonly url: string; - readonly title: string; - readonly verified: boolean; - readonly created_at: string; - readonly read_only: boolean; - }; + readonly 'deploy-key': { + readonly id: number + readonly key: string + readonly url: string + readonly title: string + readonly verified: boolean + readonly created_at: string + readonly read_only: boolean + } /** * Language * @description Language */ - readonly language: { readonly [key: string]: number }; + readonly language: { readonly [key: string]: number } /** * License Content * @description License Content */ - readonly "license-content": { - readonly name: string; - readonly path: string; - readonly sha: string; - readonly size: number; + readonly 'license-content': { + readonly name: string + readonly path: string + readonly sha: string + readonly size: number /** Format: uri */ - readonly url: string; + readonly url: string /** Format: uri */ - readonly html_url: string | null; + readonly html_url: string | null /** Format: uri */ - readonly git_url: string | null; + readonly git_url: string | null /** Format: uri */ - readonly download_url: string | null; - readonly type: string; - readonly content: string; - readonly encoding: string; + readonly download_url: string | null + readonly type: string + readonly content: string + readonly encoding: string readonly _links: { /** Format: uri */ - readonly git: string | null; + readonly git: string | null /** Format: uri */ - readonly html: string | null; + readonly html: string | null /** Format: uri */ - readonly self: string; - }; - readonly license: components["schemas"]["nullable-license-simple"]; - }; + readonly self: string + } + readonly license: components['schemas']['nullable-license-simple'] + } /** * Merged upstream * @description Results of a successful merge upstream request */ - readonly "merged-upstream": { - readonly message?: string; + readonly 'merged-upstream': { + readonly message?: string /** @enum {string} */ - readonly merge_type?: "merge" | "fast-forward" | "none"; - readonly base_branch?: string; - }; + readonly merge_type?: 'merge' | 'fast-forward' | 'none' + readonly base_branch?: string + } /** * Milestone * @description A collection of related issues and pull requests. @@ -15241,100 +15225,100 @@ export interface components { * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1 */ - readonly url: string; + readonly url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/milestones/v1.0 */ - readonly html_url: string; + readonly html_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1/labels */ - readonly labels_url: string; + readonly labels_url: string /** @example 1002604 */ - readonly id: number; + readonly id: number /** @example MDk6TWlsZXN0b25lMTAwMjYwNA== */ - readonly node_id: string; + readonly node_id: string /** * @description The number of the milestone. * @example 42 */ - readonly number: number; + readonly number: number /** * @description The state of the milestone. * @default open * @example open * @enum {string} */ - readonly state: "open" | "closed"; + readonly state: 'open' | 'closed' /** * @description The title of the milestone. * @example v1.0 */ - readonly title: string; + readonly title: string /** @example Tracking milestone for version 1.0 */ - readonly description: string | null; - readonly creator: components["schemas"]["nullable-simple-user"]; + readonly description: string | null + readonly creator: components['schemas']['nullable-simple-user'] /** @example 4 */ - readonly open_issues: number; + readonly open_issues: number /** @example 8 */ - readonly closed_issues: number; + readonly closed_issues: number /** * Format: date-time * @example 2011-04-10T20:09:31Z */ - readonly created_at: string; + readonly created_at: string /** * Format: date-time * @example 2014-03-03T18:58:10Z */ - readonly updated_at: string; + readonly updated_at: string /** * Format: date-time * @example 2013-02-12T13:22:01Z */ - readonly closed_at: string | null; + readonly closed_at: string | null /** * Format: date-time * @example 2012-10-09T23:39:01Z */ - readonly due_on: string | null; - }; + readonly due_on: string | null + } /** Pages Source Hash */ - readonly "pages-source-hash": { - readonly branch: string; - readonly path: string; - }; + readonly 'pages-source-hash': { + readonly branch: string + readonly path: string + } /** Pages Https Certificate */ - readonly "pages-https-certificate": { + readonly 'pages-https-certificate': { /** * @example approved * @enum {string} */ readonly state: - | "new" - | "authorization_created" - | "authorization_pending" - | "authorized" - | "authorization_revoked" - | "issued" - | "uploaded" - | "approved" - | "errored" - | "bad_authz" - | "destroy_pending" - | "dns_changed"; + | 'new' + | 'authorization_created' + | 'authorization_pending' + | 'authorized' + | 'authorization_revoked' + | 'issued' + | 'uploaded' + | 'approved' + | 'errored' + | 'bad_authz' + | 'destroy_pending' + | 'dns_changed' /** @example Certificate is approved */ - readonly description: string; + readonly description: string /** * @description Array of the domain set and its alternate name (if it is configured) * @example example.com,www.example.com */ - readonly domains: readonly string[]; + readonly domains: readonly string[] /** Format: date */ - readonly expires_at?: string; - }; + readonly expires_at?: string + } /** * GitHub Pages * @description The configuration for GitHub Pages for a repository. @@ -15345,1967 +15329,1967 @@ export interface components { * @description The API address for accessing this Page resource. * @example https://api.github.com/repos/github/hello-world/pages */ - readonly url: string; + readonly url: string /** * @description The status of the most recent build of the Page. * @example built * @enum {string|null} */ - readonly status: ("built" | "building" | "errored") | null; + readonly status: ('built' | 'building' | 'errored') | null /** * @description The Pages site's custom domain * @example example.com */ - readonly cname: string | null; + readonly cname: string | null /** * @description The state if the domain is verified * @example pending * @enum {string|null} */ - readonly protected_domain_state?: ("pending" | "verified" | "unverified") | null; + readonly protected_domain_state?: ('pending' | 'verified' | 'unverified') | null /** * Format: date-time * @description The timestamp when a pending domain becomes unverified. */ - readonly pending_domain_unverified_at?: string | null; + readonly pending_domain_unverified_at?: string | null /** @description Whether the Page has a custom 404 page. */ - readonly custom_404: boolean; + readonly custom_404: boolean /** * Format: uri * @description The web address the Page can be accessed from. * @example https://example.com */ - readonly html_url?: string; - readonly source?: components["schemas"]["pages-source-hash"]; + readonly html_url?: string + readonly source?: components['schemas']['pages-source-hash'] /** * @description Whether the GitHub Pages site is publicly visible. If set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. * @example true */ - readonly public: boolean; - readonly https_certificate?: components["schemas"]["pages-https-certificate"]; + readonly public: boolean + readonly https_certificate?: components['schemas']['pages-https-certificate'] /** * @description Whether https is enabled on the domain * @example true */ - readonly https_enforced?: boolean; - }; + readonly https_enforced?: boolean + } /** * Page Build * @description Page Build */ - readonly "page-build": { + readonly 'page-build': { /** Format: uri */ - readonly url: string; - readonly status: string; + readonly url: string + readonly status: string readonly error: { - readonly message: string | null; - }; - readonly pusher: components["schemas"]["nullable-simple-user"]; - readonly commit: string; - readonly duration: number; + readonly message: string | null + } + readonly pusher: components['schemas']['nullable-simple-user'] + readonly commit: string + readonly duration: number /** Format: date-time */ - readonly created_at: string; + readonly created_at: string /** Format: date-time */ - readonly updated_at: string; - }; + readonly updated_at: string + } /** * Page Build Status * @description Page Build Status */ - readonly "page-build-status": { + readonly 'page-build-status': { /** * Format: uri * @example https://api.github.com/repos/github/hello-world/pages/builds/latest */ - readonly url: string; + readonly url: string /** @example queued */ - readonly status: string; - }; + readonly status: string + } /** * Pages Health Check Status * @description Pages Health Check Status */ - readonly "pages-health-check": { + readonly 'pages-health-check': { readonly domain?: { - readonly host?: string; - readonly uri?: string; - readonly nameservers?: string; - readonly dns_resolves?: boolean; - readonly is_proxied?: boolean | null; - readonly is_cloudflare_ip?: boolean | null; - readonly is_fastly_ip?: boolean | null; - readonly is_old_ip_address?: boolean | null; - readonly is_a_record?: boolean | null; - readonly has_cname_record?: boolean | null; - readonly has_mx_records_present?: boolean | null; - readonly is_valid_domain?: boolean; - readonly is_apex_domain?: boolean; - readonly should_be_a_record?: boolean | null; - readonly is_cname_to_github_user_domain?: boolean | null; - readonly is_cname_to_pages_dot_github_dot_com?: boolean | null; - readonly is_cname_to_fastly?: boolean | null; - readonly is_pointed_to_github_pages_ip?: boolean | null; - readonly is_non_github_pages_ip_present?: boolean | null; - readonly is_pages_domain?: boolean; - readonly is_served_by_pages?: boolean | null; - readonly is_valid?: boolean; - readonly reason?: string | null; - readonly responds_to_https?: boolean; - readonly enforces_https?: boolean; - readonly https_error?: string | null; - readonly is_https_eligible?: boolean | null; - readonly caa_error?: string | null; - }; + readonly host?: string + readonly uri?: string + readonly nameservers?: string + readonly dns_resolves?: boolean + readonly is_proxied?: boolean | null + readonly is_cloudflare_ip?: boolean | null + readonly is_fastly_ip?: boolean | null + readonly is_old_ip_address?: boolean | null + readonly is_a_record?: boolean | null + readonly has_cname_record?: boolean | null + readonly has_mx_records_present?: boolean | null + readonly is_valid_domain?: boolean + readonly is_apex_domain?: boolean + readonly should_be_a_record?: boolean | null + readonly is_cname_to_github_user_domain?: boolean | null + readonly is_cname_to_pages_dot_github_dot_com?: boolean | null + readonly is_cname_to_fastly?: boolean | null + readonly is_pointed_to_github_pages_ip?: boolean | null + readonly is_non_github_pages_ip_present?: boolean | null + readonly is_pages_domain?: boolean + readonly is_served_by_pages?: boolean | null + readonly is_valid?: boolean + readonly reason?: string | null + readonly responds_to_https?: boolean + readonly enforces_https?: boolean + readonly https_error?: string | null + readonly is_https_eligible?: boolean | null + readonly caa_error?: string | null + } readonly alt_domain?: { - readonly host?: string; - readonly uri?: string; - readonly nameservers?: string; - readonly dns_resolves?: boolean; - readonly is_proxied?: boolean | null; - readonly is_cloudflare_ip?: boolean | null; - readonly is_fastly_ip?: boolean | null; - readonly is_old_ip_address?: boolean | null; - readonly is_a_record?: boolean | null; - readonly has_cname_record?: boolean | null; - readonly has_mx_records_present?: boolean | null; - readonly is_valid_domain?: boolean; - readonly is_apex_domain?: boolean; - readonly should_be_a_record?: boolean | null; - readonly is_cname_to_github_user_domain?: boolean | null; - readonly is_cname_to_pages_dot_github_dot_com?: boolean | null; - readonly is_cname_to_fastly?: boolean | null; - readonly is_pointed_to_github_pages_ip?: boolean | null; - readonly is_non_github_pages_ip_present?: boolean | null; - readonly is_pages_domain?: boolean; - readonly is_served_by_pages?: boolean | null; - readonly is_valid?: boolean; - readonly reason?: string | null; - readonly responds_to_https?: boolean; - readonly enforces_https?: boolean; - readonly https_error?: string | null; - readonly is_https_eligible?: boolean | null; - readonly caa_error?: string | null; - } | null; - }; + readonly host?: string + readonly uri?: string + readonly nameservers?: string + readonly dns_resolves?: boolean + readonly is_proxied?: boolean | null + readonly is_cloudflare_ip?: boolean | null + readonly is_fastly_ip?: boolean | null + readonly is_old_ip_address?: boolean | null + readonly is_a_record?: boolean | null + readonly has_cname_record?: boolean | null + readonly has_mx_records_present?: boolean | null + readonly is_valid_domain?: boolean + readonly is_apex_domain?: boolean + readonly should_be_a_record?: boolean | null + readonly is_cname_to_github_user_domain?: boolean | null + readonly is_cname_to_pages_dot_github_dot_com?: boolean | null + readonly is_cname_to_fastly?: boolean | null + readonly is_pointed_to_github_pages_ip?: boolean | null + readonly is_non_github_pages_ip_present?: boolean | null + readonly is_pages_domain?: boolean + readonly is_served_by_pages?: boolean | null + readonly is_valid?: boolean + readonly reason?: string | null + readonly responds_to_https?: boolean + readonly enforces_https?: boolean + readonly https_error?: string | null + readonly is_https_eligible?: boolean | null + readonly caa_error?: string | null + } | null + } /** * Team Simple * @description Groups of organization members that gives permissions on specified repositories. */ - readonly "team-simple": { + readonly 'team-simple': { /** * @description Unique identifier of the team * @example 1 */ - readonly id: number; + readonly id: number /** @example MDQ6VGVhbTE= */ - readonly node_id: string; + readonly node_id: string /** * Format: uri * @description URL for the team * @example https://api.github.com/organizations/1/team/1 */ - readonly url: string; + readonly url: string /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - readonly members_url: string; + readonly members_url: string /** * @description Name of the team * @example Justice League */ - readonly name: string; + readonly name: string /** * @description Description of the team * @example A great team. */ - readonly description: string | null; + readonly description: string | null /** * @description Permission that the team will have for its repositories * @example admin */ - readonly permission: string; + readonly permission: string /** * @description The level of privacy this team should have * @example closed */ - readonly privacy?: string; + readonly privacy?: string /** * Format: uri * @example https://github.com/orgs/rails/teams/core */ - readonly html_url: string; + readonly html_url: string /** * Format: uri * @example https://api.github.com/organizations/1/team/1/repos */ - readonly repositories_url: string; + readonly repositories_url: string /** @example justice-league */ - readonly slug: string; + readonly slug: string /** * @description Distinguished Name (DN) that team maps to within LDAP environment * @example uid=example,ou=users,dc=github,dc=com */ - readonly ldap_dn?: string; - }; + readonly ldap_dn?: string + } /** * Pull Request * @description Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary. */ - readonly "pull-request": { + readonly 'pull-request': { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ - readonly url: string; + readonly url: string /** @example 1 */ - readonly id: number; + readonly id: number /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ - readonly node_id: string; + readonly node_id: string /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347 */ - readonly html_url: string; + readonly html_url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.diff */ - readonly diff_url: string; + readonly diff_url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.patch */ - readonly patch_url: string; + readonly patch_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 */ - readonly issue_url: string; + readonly issue_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits */ - readonly commits_url: string; + readonly commits_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments */ - readonly review_comments_url: string; + readonly review_comments_url: string /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} */ - readonly review_comment_url: string; + readonly review_comment_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347/comments */ - readonly comments_url: string; + readonly comments_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e */ - readonly statuses_url: string; + readonly statuses_url: string /** * @description Number uniquely identifying the pull request within its repository. * @example 42 */ - readonly number: number; + readonly number: number /** * @description State of this Pull Request. Either `open` or `closed`. * @example open * @enum {string} */ - readonly state: "open" | "closed"; + readonly state: 'open' | 'closed' /** @example true */ - readonly locked: boolean; + readonly locked: boolean /** * @description The title of the pull request. * @example Amazing new feature */ - readonly title: string; - readonly user: components["schemas"]["nullable-simple-user"]; + readonly title: string + readonly user: components['schemas']['nullable-simple-user'] /** @example Please pull these awesome changes */ - readonly body: string | null; + readonly body: string | null readonly labels: readonly { /** Format: int64 */ - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly name: string; - readonly description: string | null; - readonly color: string; - readonly default: boolean; - }[]; - readonly milestone: components["schemas"]["nullable-milestone"]; + readonly id: number + readonly node_id: string + readonly url: string + readonly name: string + readonly description: string | null + readonly color: string + readonly default: boolean + }[] + readonly milestone: components['schemas']['nullable-milestone'] /** @example too heated */ - readonly active_lock_reason?: string | null; + readonly active_lock_reason?: string | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly created_at: string; + readonly created_at: string /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly updated_at: string; + readonly updated_at: string /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly closed_at: string | null; + readonly closed_at: string | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly merged_at: string | null; + readonly merged_at: string | null /** @example e5bd3914e2e596debea16f433f57875b5b90bcd6 */ - readonly merge_commit_sha: string | null; - readonly assignee: components["schemas"]["nullable-simple-user"]; - readonly assignees?: readonly components["schemas"]["simple-user"][] | null; - readonly requested_reviewers?: readonly components["schemas"]["simple-user"][] | null; - readonly requested_teams?: readonly components["schemas"]["team-simple"][] | null; + readonly merge_commit_sha: string | null + readonly assignee: components['schemas']['nullable-simple-user'] + readonly assignees?: readonly components['schemas']['simple-user'][] | null + readonly requested_reviewers?: readonly components['schemas']['simple-user'][] | null + readonly requested_teams?: readonly components['schemas']['team-simple'][] | null readonly head: { - readonly label: string; - readonly ref: string; + readonly label: string + readonly ref: string readonly repo: { - readonly archive_url: string; - readonly assignees_url: string; - readonly blobs_url: string; - readonly branches_url: string; - readonly collaborators_url: string; - readonly comments_url: string; - readonly commits_url: string; - readonly compare_url: string; - readonly contents_url: string; + readonly archive_url: string + readonly assignees_url: string + readonly blobs_url: string + readonly branches_url: string + readonly collaborators_url: string + readonly comments_url: string + readonly commits_url: string + readonly compare_url: string + readonly contents_url: string /** Format: uri */ - readonly contributors_url: string; + readonly contributors_url: string /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + readonly deployments_url: string + readonly description: string | null /** Format: uri */ - readonly downloads_url: string; + readonly downloads_url: string /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; + readonly events_url: string + readonly fork: boolean /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; - readonly git_commits_url: string; - readonly git_refs_url: string; - readonly git_tags_url: string; + readonly forks_url: string + readonly full_name: string + readonly git_commits_url: string + readonly git_refs_url: string + readonly git_tags_url: string /** Format: uri */ - readonly hooks_url: string; + readonly hooks_url: string /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly node_id: string; - readonly issue_comment_url: string; - readonly issue_events_url: string; - readonly issues_url: string; - readonly keys_url: string; - readonly labels_url: string; + readonly html_url: string + readonly id: number + readonly node_id: string + readonly issue_comment_url: string + readonly issue_events_url: string + readonly issues_url: string + readonly keys_url: string + readonly labels_url: string /** Format: uri */ - readonly languages_url: string; + readonly languages_url: string /** Format: uri */ - readonly merges_url: string; - readonly milestones_url: string; - readonly name: string; - readonly notifications_url: string; + readonly merges_url: string + readonly milestones_url: string + readonly name: string + readonly notifications_url: string readonly owner: { /** Format: uri */ - readonly avatar_url: string; - readonly events_url: string; + readonly avatar_url: string + readonly events_url: string /** Format: uri */ - readonly followers_url: string; - readonly following_url: string; - readonly gists_url: string; - readonly gravatar_id: string | null; + readonly followers_url: string + readonly following_url: string + readonly gists_url: string + readonly gravatar_id: string | null /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly node_id: string; - readonly login: string; + readonly html_url: string + readonly id: number + readonly node_id: string + readonly login: string /** Format: uri */ - readonly organizations_url: string; + readonly organizations_url: string /** Format: uri */ - readonly received_events_url: string; + readonly received_events_url: string /** Format: uri */ - readonly repos_url: string; - readonly site_admin: boolean; - readonly starred_url: string; + readonly repos_url: string + readonly site_admin: boolean + readonly starred_url: string /** Format: uri */ - readonly subscriptions_url: string; - readonly type: string; + readonly subscriptions_url: string + readonly type: string /** Format: uri */ - readonly url: string; - }; - readonly private: boolean; - readonly pulls_url: string; - readonly releases_url: string; + readonly url: string + } + readonly private: boolean + readonly pulls_url: string + readonly releases_url: string /** Format: uri */ - readonly stargazers_url: string; - readonly statuses_url: string; + readonly stargazers_url: string + readonly statuses_url: string /** Format: uri */ - readonly subscribers_url: string; + readonly subscribers_url: string /** Format: uri */ - readonly subscription_url: string; + readonly subscription_url: string /** Format: uri */ - readonly tags_url: string; + readonly tags_url: string /** Format: uri */ - readonly teams_url: string; - readonly trees_url: string; + readonly teams_url: string + readonly trees_url: string /** Format: uri */ - readonly url: string; - readonly clone_url: string; - readonly default_branch: string; - readonly forks: number; - readonly forks_count: number; - readonly git_url: string; - readonly has_downloads: boolean; - readonly has_issues: boolean; - readonly has_projects: boolean; - readonly has_wiki: boolean; - readonly has_pages: boolean; + readonly url: string + readonly clone_url: string + readonly default_branch: string + readonly forks: number + readonly forks_count: number + readonly git_url: string + readonly has_downloads: boolean + readonly has_issues: boolean + readonly has_projects: boolean + readonly has_wiki: boolean + readonly has_pages: boolean /** Format: uri */ - readonly homepage: string | null; - readonly language: string | null; - readonly master_branch?: string; - readonly archived: boolean; - readonly disabled: boolean; + readonly homepage: string | null + readonly language: string | null + readonly master_branch?: string + readonly archived: boolean + readonly disabled: boolean /** @description The repository visibility: public, private, or internal. */ - readonly visibility?: string; + readonly visibility?: string /** Format: uri */ - readonly mirror_url: string | null; - readonly open_issues: number; - readonly open_issues_count: number; + readonly mirror_url: string | null + readonly open_issues: number + readonly open_issues_count: number readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly push: boolean; - readonly triage?: boolean; - readonly pull: boolean; - }; - readonly temp_clone_token?: string; - readonly allow_merge_commit?: boolean; - readonly allow_squash_merge?: boolean; - readonly allow_rebase_merge?: boolean; + readonly admin: boolean + readonly maintain?: boolean + readonly push: boolean + readonly triage?: boolean + readonly pull: boolean + } + readonly temp_clone_token?: string + readonly allow_merge_commit?: boolean + readonly allow_squash_merge?: boolean + readonly allow_rebase_merge?: boolean readonly license: { - readonly key: string; - readonly name: string; + readonly key: string + readonly name: string /** Format: uri */ - readonly url: string | null; - readonly spdx_id: string | null; - readonly node_id: string; - } | null; + readonly url: string | null + readonly spdx_id: string | null + readonly node_id: string + } | null /** Format: date-time */ - readonly pushed_at: string; - readonly size: number; - readonly ssh_url: string; - readonly stargazers_count: number; + readonly pushed_at: string + readonly size: number + readonly ssh_url: string + readonly stargazers_count: number /** Format: uri */ - readonly svn_url: string; - readonly topics?: readonly string[]; - readonly watchers: number; - readonly watchers_count: number; + readonly svn_url: string + readonly topics?: readonly string[] + readonly watchers: number + readonly watchers_count: number /** Format: date-time */ - readonly created_at: string; + readonly created_at: string /** Format: date-time */ - readonly updated_at: string; - readonly allow_forking?: boolean; - readonly is_template?: boolean; - } | null; - readonly sha: string; + readonly updated_at: string + readonly allow_forking?: boolean + readonly is_template?: boolean + } | null + readonly sha: string readonly user: { /** Format: uri */ - readonly avatar_url: string; - readonly events_url: string; + readonly avatar_url: string + readonly events_url: string /** Format: uri */ - readonly followers_url: string; - readonly following_url: string; - readonly gists_url: string; - readonly gravatar_id: string | null; + readonly followers_url: string + readonly following_url: string + readonly gists_url: string + readonly gravatar_id: string | null /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly node_id: string; - readonly login: string; + readonly html_url: string + readonly id: number + readonly node_id: string + readonly login: string /** Format: uri */ - readonly organizations_url: string; + readonly organizations_url: string /** Format: uri */ - readonly received_events_url: string; + readonly received_events_url: string /** Format: uri */ - readonly repos_url: string; - readonly site_admin: boolean; - readonly starred_url: string; + readonly repos_url: string + readonly site_admin: boolean + readonly starred_url: string /** Format: uri */ - readonly subscriptions_url: string; - readonly type: string; + readonly subscriptions_url: string + readonly type: string /** Format: uri */ - readonly url: string; - }; - }; + readonly url: string + } + } readonly base: { - readonly label: string; - readonly ref: string; + readonly label: string + readonly ref: string readonly repo: { - readonly archive_url: string; - readonly assignees_url: string; - readonly blobs_url: string; - readonly branches_url: string; - readonly collaborators_url: string; - readonly comments_url: string; - readonly commits_url: string; - readonly compare_url: string; - readonly contents_url: string; + readonly archive_url: string + readonly assignees_url: string + readonly blobs_url: string + readonly branches_url: string + readonly collaborators_url: string + readonly comments_url: string + readonly commits_url: string + readonly compare_url: string + readonly contents_url: string /** Format: uri */ - readonly contributors_url: string; + readonly contributors_url: string /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + readonly deployments_url: string + readonly description: string | null /** Format: uri */ - readonly downloads_url: string; + readonly downloads_url: string /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; + readonly events_url: string + readonly fork: boolean /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; - readonly git_commits_url: string; - readonly git_refs_url: string; - readonly git_tags_url: string; + readonly forks_url: string + readonly full_name: string + readonly git_commits_url: string + readonly git_refs_url: string + readonly git_tags_url: string /** Format: uri */ - readonly hooks_url: string; + readonly hooks_url: string /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly is_template?: boolean; - readonly node_id: string; - readonly issue_comment_url: string; - readonly issue_events_url: string; - readonly issues_url: string; - readonly keys_url: string; - readonly labels_url: string; + readonly html_url: string + readonly id: number + readonly is_template?: boolean + readonly node_id: string + readonly issue_comment_url: string + readonly issue_events_url: string + readonly issues_url: string + readonly keys_url: string + readonly labels_url: string /** Format: uri */ - readonly languages_url: string; + readonly languages_url: string /** Format: uri */ - readonly merges_url: string; - readonly milestones_url: string; - readonly name: string; - readonly notifications_url: string; + readonly merges_url: string + readonly milestones_url: string + readonly name: string + readonly notifications_url: string readonly owner: { /** Format: uri */ - readonly avatar_url: string; - readonly events_url: string; + readonly avatar_url: string + readonly events_url: string /** Format: uri */ - readonly followers_url: string; - readonly following_url: string; - readonly gists_url: string; - readonly gravatar_id: string | null; + readonly followers_url: string + readonly following_url: string + readonly gists_url: string + readonly gravatar_id: string | null /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly node_id: string; - readonly login: string; + readonly html_url: string + readonly id: number + readonly node_id: string + readonly login: string /** Format: uri */ - readonly organizations_url: string; + readonly organizations_url: string /** Format: uri */ - readonly received_events_url: string; + readonly received_events_url: string /** Format: uri */ - readonly repos_url: string; - readonly site_admin: boolean; - readonly starred_url: string; + readonly repos_url: string + readonly site_admin: boolean + readonly starred_url: string /** Format: uri */ - readonly subscriptions_url: string; - readonly type: string; + readonly subscriptions_url: string + readonly type: string /** Format: uri */ - readonly url: string; - }; - readonly private: boolean; - readonly pulls_url: string; - readonly releases_url: string; + readonly url: string + } + readonly private: boolean + readonly pulls_url: string + readonly releases_url: string /** Format: uri */ - readonly stargazers_url: string; - readonly statuses_url: string; + readonly stargazers_url: string + readonly statuses_url: string /** Format: uri */ - readonly subscribers_url: string; + readonly subscribers_url: string /** Format: uri */ - readonly subscription_url: string; + readonly subscription_url: string /** Format: uri */ - readonly tags_url: string; + readonly tags_url: string /** Format: uri */ - readonly teams_url: string; - readonly trees_url: string; + readonly teams_url: string + readonly trees_url: string /** Format: uri */ - readonly url: string; - readonly clone_url: string; - readonly default_branch: string; - readonly forks: number; - readonly forks_count: number; - readonly git_url: string; - readonly has_downloads: boolean; - readonly has_issues: boolean; - readonly has_projects: boolean; - readonly has_wiki: boolean; - readonly has_pages: boolean; + readonly url: string + readonly clone_url: string + readonly default_branch: string + readonly forks: number + readonly forks_count: number + readonly git_url: string + readonly has_downloads: boolean + readonly has_issues: boolean + readonly has_projects: boolean + readonly has_wiki: boolean + readonly has_pages: boolean /** Format: uri */ - readonly homepage: string | null; - readonly language: string | null; - readonly master_branch?: string; - readonly archived: boolean; - readonly disabled: boolean; + readonly homepage: string | null + readonly language: string | null + readonly master_branch?: string + readonly archived: boolean + readonly disabled: boolean /** @description The repository visibility: public, private, or internal. */ - readonly visibility?: string; + readonly visibility?: string /** Format: uri */ - readonly mirror_url: string | null; - readonly open_issues: number; - readonly open_issues_count: number; + readonly mirror_url: string | null + readonly open_issues: number + readonly open_issues_count: number readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly push: boolean; - readonly triage?: boolean; - readonly pull: boolean; - }; - readonly temp_clone_token?: string; - readonly allow_merge_commit?: boolean; - readonly allow_squash_merge?: boolean; - readonly allow_rebase_merge?: boolean; - readonly license: components["schemas"]["nullable-license-simple"]; + readonly admin: boolean + readonly maintain?: boolean + readonly push: boolean + readonly triage?: boolean + readonly pull: boolean + } + readonly temp_clone_token?: string + readonly allow_merge_commit?: boolean + readonly allow_squash_merge?: boolean + readonly allow_rebase_merge?: boolean + readonly license: components['schemas']['nullable-license-simple'] /** Format: date-time */ - readonly pushed_at: string; - readonly size: number; - readonly ssh_url: string; - readonly stargazers_count: number; + readonly pushed_at: string + readonly size: number + readonly ssh_url: string + readonly stargazers_count: number /** Format: uri */ - readonly svn_url: string; - readonly topics?: readonly string[]; - readonly watchers: number; - readonly watchers_count: number; + readonly svn_url: string + readonly topics?: readonly string[] + readonly watchers: number + readonly watchers_count: number /** Format: date-time */ - readonly created_at: string; + readonly created_at: string /** Format: date-time */ - readonly updated_at: string; - readonly allow_forking?: boolean; - }; - readonly sha: string; + readonly updated_at: string + readonly allow_forking?: boolean + } + readonly sha: string readonly user: { /** Format: uri */ - readonly avatar_url: string; - readonly events_url: string; + readonly avatar_url: string + readonly events_url: string /** Format: uri */ - readonly followers_url: string; - readonly following_url: string; - readonly gists_url: string; - readonly gravatar_id: string | null; + readonly followers_url: string + readonly following_url: string + readonly gists_url: string + readonly gravatar_id: string | null /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly node_id: string; - readonly login: string; + readonly html_url: string + readonly id: number + readonly node_id: string + readonly login: string /** Format: uri */ - readonly organizations_url: string; + readonly organizations_url: string /** Format: uri */ - readonly received_events_url: string; + readonly received_events_url: string /** Format: uri */ - readonly repos_url: string; - readonly site_admin: boolean; - readonly starred_url: string; + readonly repos_url: string + readonly site_admin: boolean + readonly starred_url: string /** Format: uri */ - readonly subscriptions_url: string; - readonly type: string; + readonly subscriptions_url: string + readonly type: string /** Format: uri */ - readonly url: string; - }; - }; + readonly url: string + } + } readonly _links: { - readonly comments: components["schemas"]["link"]; - readonly commits: components["schemas"]["link"]; - readonly statuses: components["schemas"]["link"]; - readonly html: components["schemas"]["link"]; - readonly issue: components["schemas"]["link"]; - readonly review_comments: components["schemas"]["link"]; - readonly review_comment: components["schemas"]["link"]; - readonly self: components["schemas"]["link"]; - }; - readonly author_association: components["schemas"]["author_association"]; - readonly auto_merge: components["schemas"]["auto_merge"]; + readonly comments: components['schemas']['link'] + readonly commits: components['schemas']['link'] + readonly statuses: components['schemas']['link'] + readonly html: components['schemas']['link'] + readonly issue: components['schemas']['link'] + readonly review_comments: components['schemas']['link'] + readonly review_comment: components['schemas']['link'] + readonly self: components['schemas']['link'] + } + readonly author_association: components['schemas']['author_association'] + readonly auto_merge: components['schemas']['auto_merge'] /** @description Indicates whether or not the pull request is a draft. */ - readonly draft?: boolean; - readonly merged: boolean; + readonly draft?: boolean + readonly merged: boolean /** @example true */ - readonly mergeable: boolean | null; + readonly mergeable: boolean | null /** @example true */ - readonly rebaseable?: boolean | null; + readonly rebaseable?: boolean | null /** @example clean */ - readonly mergeable_state: string; - readonly merged_by: components["schemas"]["nullable-simple-user"]; + readonly mergeable_state: string + readonly merged_by: components['schemas']['nullable-simple-user'] /** @example 10 */ - readonly comments: number; - readonly review_comments: number; + readonly comments: number + readonly review_comments: number /** * @description Indicates whether maintainers can modify the pull request. * @example true */ - readonly maintainer_can_modify: boolean; + readonly maintainer_can_modify: boolean /** @example 3 */ - readonly commits: number; + readonly commits: number /** @example 100 */ - readonly additions: number; + readonly additions: number /** @example 3 */ - readonly deletions: number; + readonly deletions: number /** @example 5 */ - readonly changed_files: number; - }; + readonly changed_files: number + } /** * Pull Request Merge Result * @description Pull Request Merge Result */ - readonly "pull-request-merge-result": { - readonly sha: string; - readonly merged: boolean; - readonly message: string; - }; + readonly 'pull-request-merge-result': { + readonly sha: string + readonly merged: boolean + readonly message: string + } /** * Pull Request Review Request * @description Pull Request Review Request */ - readonly "pull-request-review-request": { - readonly users: readonly components["schemas"]["simple-user"][]; - readonly teams: readonly components["schemas"]["team"][]; - }; + readonly 'pull-request-review-request': { + readonly users: readonly components['schemas']['simple-user'][] + readonly teams: readonly components['schemas']['team'][] + } /** * Pull Request Review * @description Pull Request Reviews are reviews on pull requests. */ - readonly "pull-request-review": { + readonly 'pull-request-review': { /** * @description Unique identifier of the review * @example 42 */ - readonly id: number; + readonly id: number /** @example MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= */ - readonly node_id: string; - readonly user: components["schemas"]["nullable-simple-user"]; + readonly node_id: string + readonly user: components['schemas']['nullable-simple-user'] /** * @description The text of the review. * @example This looks great. */ - readonly body: string; + readonly body: string /** @example CHANGES_REQUESTED */ - readonly state: string; + readonly state: string /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 */ - readonly html_url: string; + readonly html_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/12 */ - readonly pull_request_url: string; + readonly pull_request_url: string readonly _links: { readonly html: { - readonly href: string; - }; + readonly href: string + } readonly pull_request: { - readonly href: string; - }; - }; + readonly href: string + } + } /** Format: date-time */ - readonly submitted_at?: string; + readonly submitted_at?: string /** * @description A commit SHA for the review. * @example 54bb654c9e6025347f57900a4a5c2313a96b8035 */ - readonly commit_id: string; - readonly body_html?: string; - readonly body_text?: string; - readonly author_association: components["schemas"]["author_association"]; - }; + readonly commit_id: string + readonly body_html?: string + readonly body_text?: string + readonly author_association: components['schemas']['author_association'] + } /** * Legacy Review Comment * @description Legacy Review Comment */ - readonly "review-comment": { + readonly 'review-comment': { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ - readonly url: string; + readonly url: string /** @example 42 */ - readonly pull_request_review_id: number | null; + readonly pull_request_review_id: number | null /** @example 10 */ - readonly id: number; + readonly id: number /** @example MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw */ - readonly node_id: string; + readonly node_id: string /** @example @@ -16,33 +16,40 @@ public class Connection : IConnection... */ - readonly diff_hunk: string; + readonly diff_hunk: string /** @example file1.txt */ - readonly path: string; + readonly path: string /** @example 1 */ - readonly position: number | null; + readonly position: number | null /** @example 4 */ - readonly original_position: number; + readonly original_position: number /** @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */ - readonly commit_id: string; + readonly commit_id: string /** @example 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 */ - readonly original_commit_id: string; + readonly original_commit_id: string /** @example 8 */ - readonly in_reply_to_id?: number; - readonly user: components["schemas"]["nullable-simple-user"]; + readonly in_reply_to_id?: number + readonly user: components['schemas']['nullable-simple-user'] /** @example Great stuff */ - readonly body: string; + readonly body: string /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - readonly created_at: string; + readonly created_at: string /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - readonly updated_at: string; + readonly updated_at: string /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 */ - readonly html_url: string; + readonly html_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1 */ - readonly pull_request_url: string; - readonly author_association: components["schemas"]["author_association"]; + readonly pull_request_url: string + readonly author_association: components['schemas']['author_association'] readonly _links: { - readonly self: components["schemas"]["link"]; - readonly html: components["schemas"]["link"]; - readonly pull_request: components["schemas"]["link"]; - }; - readonly body_text?: string; - readonly body_html?: string; - readonly reactions?: components["schemas"]["reaction-rollup"]; + readonly self: components['schemas']['link'] + readonly html: components['schemas']['link'] + readonly pull_request: components['schemas']['link'] + } + readonly body_text?: string + readonly body_html?: string + readonly reactions?: components['schemas']['reaction-rollup'] /** * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string} */ - readonly side?: "LEFT" | "RIGHT"; + readonly side?: 'LEFT' | 'RIGHT' /** * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} */ - readonly start_side?: ("LEFT" | "RIGHT") | null; + readonly start_side?: ('LEFT' | 'RIGHT') | null /** * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment * @example 2 */ - readonly line?: number; + readonly line?: number /** * @description The original line of the blob to which the comment applies. The last line of the range for a multi-line comment * @example 2 */ - readonly original_line?: number; + readonly original_line?: number /** * @description The first line of the range for a multi-line comment. * @example 2 */ - readonly start_line?: number | null; + readonly start_line?: number | null /** * @description The original first line of the range for a multi-line comment. * @example 2 */ - readonly original_start_line?: number | null; - }; + readonly original_start_line?: number | null + } /** * Release Asset * @description Data related to a release. */ - readonly "release-asset": { + readonly 'release-asset': { /** Format: uri */ - readonly url: string; + readonly url: string /** Format: uri */ - readonly browser_download_url: string; - readonly id: number; - readonly node_id: string; + readonly browser_download_url: string + readonly id: number + readonly node_id: string /** * @description The file name of the asset. * @example Team Environment */ - readonly name: string; - readonly label: string | null; + readonly name: string + readonly label: string | null /** * @description State of the release asset. * @enum {string} */ - readonly state: "uploaded" | "open"; - readonly content_type: string; - readonly size: number; - readonly download_count: number; + readonly state: 'uploaded' | 'open' + readonly content_type: string + readonly size: number + readonly download_count: number /** Format: date-time */ - readonly created_at: string; + readonly created_at: string /** Format: date-time */ - readonly updated_at: string; - readonly uploader: components["schemas"]["nullable-simple-user"]; - }; + readonly updated_at: string + readonly uploader: components['schemas']['nullable-simple-user'] + } /** * Release * @description A release. */ readonly release: { /** Format: uri */ - readonly url: string; + readonly url: string /** Format: uri */ - readonly html_url: string; + readonly html_url: string /** Format: uri */ - readonly assets_url: string; - readonly upload_url: string; + readonly assets_url: string + readonly upload_url: string /** Format: uri */ - readonly tarball_url: string | null; + readonly tarball_url: string | null /** Format: uri */ - readonly zipball_url: string | null; - readonly id: number; - readonly node_id: string; + readonly zipball_url: string | null + readonly id: number + readonly node_id: string /** * @description The name of the tag. * @example v1.0.0 */ - readonly tag_name: string; + readonly tag_name: string /** * @description Specifies the commitish value that determines where the Git tag is created from. * @example master */ - readonly target_commitish: string; - readonly name: string | null; - readonly body?: string | null; + readonly target_commitish: string + readonly name: string | null + readonly body?: string | null /** @description true to create a draft (unpublished) release, false to create a published one. */ - readonly draft: boolean; + readonly draft: boolean /** @description Whether to identify the release as a prerelease or a full release. */ - readonly prerelease: boolean; + readonly prerelease: boolean /** Format: date-time */ - readonly created_at: string; + readonly created_at: string /** Format: date-time */ - readonly published_at: string | null; - readonly author: components["schemas"]["simple-user"]; - readonly assets: readonly components["schemas"]["release-asset"][]; - readonly body_html?: string; - readonly body_text?: string; - readonly mentions_count?: number; + readonly published_at: string | null + readonly author: components['schemas']['simple-user'] + readonly assets: readonly components['schemas']['release-asset'][] + readonly body_html?: string + readonly body_text?: string + readonly mentions_count?: number /** * Format: uri * @description The URL of the release discussion. */ - readonly discussion_url?: string; - readonly reactions?: components["schemas"]["reaction-rollup"]; - }; + readonly discussion_url?: string + readonly reactions?: components['schemas']['reaction-rollup'] + } /** * Generated Release Notes Content * @description Generated name and body describing a release */ - readonly "release-notes-content": { + readonly 'release-notes-content': { /** * @description The generated name of the release * @example Release v1.0.0 is now available! */ - readonly name: string; + readonly name: string /** @description The generated body describing the contents of the release supporting markdown formatting */ - readonly body: string; - }; - readonly "secret-scanning-alert": { - readonly number?: components["schemas"]["alert-number"]; - readonly created_at?: components["schemas"]["alert-created-at"]; - readonly url?: components["schemas"]["alert-url"]; - readonly html_url?: components["schemas"]["alert-html-url"]; + readonly body: string + } + readonly 'secret-scanning-alert': { + readonly number?: components['schemas']['alert-number'] + readonly created_at?: components['schemas']['alert-created-at'] + readonly url?: components['schemas']['alert-url'] + readonly html_url?: components['schemas']['alert-html-url'] /** * Format: uri * @description The REST API URL of the code locations for this alert. */ - readonly locations_url?: string; - readonly state?: components["schemas"]["secret-scanning-alert-state"]; - readonly resolution?: components["schemas"]["secret-scanning-alert-resolution"]; + readonly locations_url?: string + readonly state?: components['schemas']['secret-scanning-alert-state'] + readonly resolution?: components['schemas']['secret-scanning-alert-resolution'] /** * Format: date-time * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly resolved_at?: string | null; - readonly resolved_by?: components["schemas"]["nullable-simple-user"]; + readonly resolved_at?: string | null + readonly resolved_by?: components['schemas']['nullable-simple-user'] /** @description The type of secret that secret scanning detected. */ - readonly secret_type?: string; + readonly secret_type?: string /** @description The secret that was detected. */ - readonly secret?: string; - }; + readonly secret?: string + } /** @description Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. */ - readonly "secret-scanning-location-commit": { + readonly 'secret-scanning-location-commit': { /** * @description The file path in the repository * @example /example/secrets.txt */ - readonly path: string; + readonly path: string /** @description Line number at which the secret starts in the file */ - readonly start_line: number; + readonly start_line: number /** @description Line number at which the secret ends in the file */ - readonly end_line: number; + readonly end_line: number /** @description The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII */ - readonly start_column: number; + readonly start_column: number /** @description The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII */ - readonly end_column: number; + readonly end_column: number /** * @description SHA-1 hash ID of the associated blob * @example af5626b4a114abcb82d63db7c8082c3c4756e51b */ - readonly blob_sha: string; + readonly blob_sha: string /** @description The API URL to get the associated blob resource */ - readonly blob_url: string; + readonly blob_url: string /** * @description SHA-1 hash ID of the associated commit * @example af5626b4a114abcb82d63db7c8082c3c4756e51b */ - readonly commit_sha: string; + readonly commit_sha: string /** @description The API URL to get the associated commit resource */ - readonly commit_url: string; - }; - readonly "secret-scanning-location": { + readonly commit_url: string + } + readonly 'secret-scanning-location': { /** * @description The location type. Because secrets may be found in different types of resources (ie. code, comments, issues), this field identifies the type of resource where the secret was found. * @example commit * @enum {string} */ - readonly type: "commit"; - readonly details: components["schemas"]["secret-scanning-location-commit"]; - }; + readonly type: 'commit' + readonly details: components['schemas']['secret-scanning-location-commit'] + } /** * Stargazer * @description Stargazer */ readonly stargazer: { /** Format: date-time */ - readonly starred_at: string; - readonly user: components["schemas"]["nullable-simple-user"]; - }; + readonly starred_at: string + readonly user: components['schemas']['nullable-simple-user'] + } /** * Code Frequency Stat * @description Code Frequency Stat */ - readonly "code-frequency-stat": readonly number[]; + readonly 'code-frequency-stat': readonly number[] /** * Commit Activity * @description Commit Activity */ - readonly "commit-activity": { + readonly 'commit-activity': { /** @example 0,3,26,20,39,1,0 */ - readonly days: readonly number[]; + readonly days: readonly number[] /** @example 89 */ - readonly total: number; + readonly total: number /** @example 1336280400 */ - readonly week: number; - }; + readonly week: number + } /** * Contributor Activity * @description Contributor Activity */ - readonly "contributor-activity": { - readonly author: components["schemas"]["nullable-simple-user"]; + readonly 'contributor-activity': { + readonly author: components['schemas']['nullable-simple-user'] /** @example 135 */ - readonly total: number; + readonly total: number /** @example [object Object] */ readonly weeks: readonly { - readonly w?: number; - readonly a?: number; - readonly d?: number; - readonly c?: number; - }[]; - }; + readonly w?: number + readonly a?: number + readonly d?: number + readonly c?: number + }[] + } /** Participation Stats */ - readonly "participation-stats": { - readonly all: readonly number[]; - readonly owner: readonly number[]; - }; + readonly 'participation-stats': { + readonly all: readonly number[] + readonly owner: readonly number[] + } /** * Repository Invitation * @description Repository invitations let you manage who you collaborate with. */ - readonly "repository-subscription": { + readonly 'repository-subscription': { /** * @description Determines if notifications should be received from this repository. * @example true */ - readonly subscribed: boolean; + readonly subscribed: boolean /** @description Determines if all notifications should be blocked from this repository. */ - readonly ignored: boolean; - readonly reason: string | null; + readonly ignored: boolean + readonly reason: string | null /** * Format: date-time * @example 2012-10-06T21:34:12Z */ - readonly created_at: string; + readonly created_at: string /** * Format: uri * @example https://api.github.com/repos/octocat/example/subscription */ - readonly url: string; + readonly url: string /** * Format: uri * @example https://api.github.com/repos/octocat/example */ - readonly repository_url: string; - }; + readonly repository_url: string + } /** * Tag * @description Tag */ readonly tag: { /** @example v0.1 */ - readonly name: string; + readonly name: string readonly commit: { - readonly sha: string; + readonly sha: string /** Format: uri */ - readonly url: string; - }; + readonly url: string + } /** * Format: uri * @example https://github.com/octocat/Hello-World/zipball/v0.1 */ - readonly zipball_url: string; + readonly zipball_url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/tarball/v0.1 */ - readonly tarball_url: string; - readonly node_id: string; - }; + readonly tarball_url: string + readonly node_id: string + } /** * Topic * @description A topic aggregates entities that are related to a subject. */ readonly topic: { - readonly names: readonly string[]; - }; + readonly names: readonly string[] + } /** Traffic */ readonly traffic: { /** Format: date-time */ - readonly timestamp: string; - readonly uniques: number; - readonly count: number; - }; + readonly timestamp: string + readonly uniques: number + readonly count: number + } /** * Clone Traffic * @description Clone Traffic */ - readonly "clone-traffic": { + readonly 'clone-traffic': { /** @example 173 */ - readonly count: number; + readonly count: number /** @example 128 */ - readonly uniques: number; - readonly clones: readonly components["schemas"]["traffic"][]; - }; + readonly uniques: number + readonly clones: readonly components['schemas']['traffic'][] + } /** * Content Traffic * @description Content Traffic */ - readonly "content-traffic": { + readonly 'content-traffic': { /** @example /github/hubot */ - readonly path: string; + readonly path: string /** @example github/hubot: A customizable life embetterment robot. */ - readonly title: string; + readonly title: string /** @example 3542 */ - readonly count: number; + readonly count: number /** @example 2225 */ - readonly uniques: number; - }; + readonly uniques: number + } /** * Referrer Traffic * @description Referrer Traffic */ - readonly "referrer-traffic": { + readonly 'referrer-traffic': { /** @example Google */ - readonly referrer: string; + readonly referrer: string /** @example 4 */ - readonly count: number; + readonly count: number /** @example 3 */ - readonly uniques: number; - }; + readonly uniques: number + } /** * View Traffic * @description View Traffic */ - readonly "view-traffic": { + readonly 'view-traffic': { /** @example 14850 */ - readonly count: number; + readonly count: number /** @example 3782 */ - readonly uniques: number; - readonly views: readonly components["schemas"]["traffic"][]; - }; - readonly "scim-group-list-enterprise": { - readonly schemas: readonly string[]; - readonly totalResults: number; - readonly itemsPerPage: number; - readonly startIndex: number; + readonly uniques: number + readonly views: readonly components['schemas']['traffic'][] + } + readonly 'scim-group-list-enterprise': { + readonly schemas: readonly string[] + readonly totalResults: number + readonly itemsPerPage: number + readonly startIndex: number readonly Resources: readonly { - readonly schemas: readonly string[]; - readonly id: string; - readonly externalId?: string | null; - readonly displayName?: string; + readonly schemas: readonly string[] + readonly id: string + readonly externalId?: string | null + readonly displayName?: string readonly members?: readonly { - readonly value?: string; - readonly $ref?: string; - readonly display?: string; - }[]; + readonly value?: string + readonly $ref?: string + readonly display?: string + }[] readonly meta?: { - readonly resourceType?: string; - readonly created?: string; - readonly lastModified?: string; - readonly location?: string; - }; - }[]; - }; - readonly "scim-enterprise-group": { - readonly schemas: readonly string[]; - readonly id: string; - readonly externalId?: string | null; - readonly displayName?: string; + readonly resourceType?: string + readonly created?: string + readonly lastModified?: string + readonly location?: string + } + }[] + } + readonly 'scim-enterprise-group': { + readonly schemas: readonly string[] + readonly id: string + readonly externalId?: string | null + readonly displayName?: string readonly members?: readonly { - readonly value?: string; - readonly $ref?: string; - readonly display?: string; - }[]; + readonly value?: string + readonly $ref?: string + readonly display?: string + }[] readonly meta?: { - readonly resourceType?: string; - readonly created?: string; - readonly lastModified?: string; - readonly location?: string; - }; - }; - readonly "scim-user-list-enterprise": { - readonly schemas: readonly string[]; - readonly totalResults: number; - readonly itemsPerPage: number; - readonly startIndex: number; + readonly resourceType?: string + readonly created?: string + readonly lastModified?: string + readonly location?: string + } + } + readonly 'scim-user-list-enterprise': { + readonly schemas: readonly string[] + readonly totalResults: number + readonly itemsPerPage: number + readonly startIndex: number readonly Resources: readonly { - readonly schemas: readonly string[]; - readonly id: string; - readonly externalId?: string; - readonly userName?: string; + readonly schemas: readonly string[] + readonly id: string + readonly externalId?: string + readonly userName?: string readonly name?: { - readonly givenName?: string; - readonly familyName?: string; - }; + readonly givenName?: string + readonly familyName?: string + } readonly emails?: readonly { - readonly value?: string; - readonly primary?: boolean; - readonly type?: string; - }[]; + readonly value?: string + readonly primary?: boolean + readonly type?: string + }[] readonly groups?: readonly { - readonly value?: string; - }[]; - readonly active?: boolean; + readonly value?: string + }[] + readonly active?: boolean readonly meta?: { - readonly resourceType?: string; - readonly created?: string; - readonly lastModified?: string; - readonly location?: string; - }; - }[]; - }; - readonly "scim-enterprise-user": { - readonly schemas: readonly string[]; - readonly id: string; - readonly externalId?: string; - readonly userName?: string; + readonly resourceType?: string + readonly created?: string + readonly lastModified?: string + readonly location?: string + } + }[] + } + readonly 'scim-enterprise-user': { + readonly schemas: readonly string[] + readonly id: string + readonly externalId?: string + readonly userName?: string readonly name?: { - readonly givenName?: string; - readonly familyName?: string; - }; + readonly givenName?: string + readonly familyName?: string + } readonly emails?: readonly { - readonly value?: string; - readonly type?: string; - readonly primary?: boolean; - }[]; + readonly value?: string + readonly type?: string + readonly primary?: boolean + }[] readonly groups?: readonly { - readonly value?: string; - }[]; - readonly active?: boolean; + readonly value?: string + }[] + readonly active?: boolean readonly meta?: { - readonly resourceType?: string; - readonly created?: string; - readonly lastModified?: string; - readonly location?: string; - }; - }; + readonly resourceType?: string + readonly created?: string + readonly lastModified?: string + readonly location?: string + } + } /** * SCIM /Users * @description SCIM /Users provisioning endpoints */ - readonly "scim-user": { + readonly 'scim-user': { /** @description SCIM schema used. */ - readonly schemas: readonly string[]; + readonly schemas: readonly string[] /** * @description Unique identifier of an external identity * @example 1b78eada-9baa-11e6-9eb6-a431576d590e */ - readonly id: string; + readonly id: string /** * @description The ID of the User. * @example a7b0f98395 */ - readonly externalId: string | null; + readonly externalId: string | null /** * @description Configured by the admin. Could be an email, login, or username * @example someone@example.com */ - readonly userName: string | null; + readonly userName: string | null /** * @description The name of the user, suitable for display to end-users * @example Jon Doe */ - readonly displayName?: string | null; + readonly displayName?: string | null /** @example [object Object] */ readonly name: { - readonly givenName: string | null; - readonly familyName: string | null; - readonly formatted?: string | null; - }; + readonly givenName: string | null + readonly familyName: string | null + readonly formatted?: string | null + } /** * @description user emails * @example [object Object],[object Object] */ readonly emails: readonly { - readonly value: string; - readonly primary?: boolean; - }[]; + readonly value: string + readonly primary?: boolean + }[] /** * @description The active status of the User. * @example true */ - readonly active: boolean; + readonly active: boolean readonly meta: { /** @example User */ - readonly resourceType?: string; + readonly resourceType?: string /** * Format: date-time * @example 2019-01-24T22:45:36.000Z */ - readonly created?: string; + readonly created?: string /** * Format: date-time * @example 2019-01-24T22:45:36.000Z */ - readonly lastModified?: string; + readonly lastModified?: string /** * Format: uri * @example https://api.github.com/scim/v2/organizations/myorg-123abc55141bfd8f/Users/c42772b5-2029-11e9-8543-9264a97dec8d */ - readonly location?: string; - }; + readonly location?: string + } /** @description The ID of the organization. */ - readonly organization_id?: number; + readonly organization_id?: number /** * @description Set of operations to be performed * @example [object Object] */ readonly operations?: readonly { /** @enum {string} */ - readonly op: "add" | "remove" | "replace"; - readonly path?: string; - readonly value?: string | { readonly [key: string]: unknown } | readonly unknown[]; - }[]; + readonly op: 'add' | 'remove' | 'replace' + readonly path?: string + readonly value?: string | { readonly [key: string]: unknown } | readonly unknown[] + }[] /** @description associated groups */ readonly groups?: readonly { - readonly value?: string; - readonly display?: string; - }[]; - }; + readonly value?: string + readonly display?: string + }[] + } /** * SCIM User List * @description SCIM User List */ - readonly "scim-user-list": { + readonly 'scim-user-list': { /** @description SCIM schema used. */ - readonly schemas: readonly string[]; + readonly schemas: readonly string[] /** @example 3 */ - readonly totalResults: number; + readonly totalResults: number /** @example 10 */ - readonly itemsPerPage: number; + readonly itemsPerPage: number /** @example 1 */ - readonly startIndex: number; - readonly Resources: readonly components["schemas"]["scim-user"][]; - }; + readonly startIndex: number + readonly Resources: readonly components['schemas']['scim-user'][] + } /** Search Result Text Matches */ - readonly "search-result-text-matches": readonly { - readonly object_url?: string; - readonly object_type?: string | null; - readonly property?: string; - readonly fragment?: string; + readonly 'search-result-text-matches': readonly { + readonly object_url?: string + readonly object_type?: string | null + readonly property?: string + readonly fragment?: string readonly matches?: readonly { - readonly text?: string; - readonly indices?: readonly number[]; - }[]; - }[]; + readonly text?: string + readonly indices?: readonly number[] + }[] + }[] /** * Code Search Result Item * @description Code Search Result Item */ - readonly "code-search-result-item": { - readonly name: string; - readonly path: string; - readonly sha: string; + readonly 'code-search-result-item': { + readonly name: string + readonly path: string + readonly sha: string /** Format: uri */ - readonly url: string; + readonly url: string /** Format: uri */ - readonly git_url: string; + readonly git_url: string /** Format: uri */ - readonly html_url: string; - readonly repository: components["schemas"]["minimal-repository"]; - readonly score: number; - readonly file_size?: number; - readonly language?: string | null; + readonly html_url: string + readonly repository: components['schemas']['minimal-repository'] + readonly score: number + readonly file_size?: number + readonly language?: string | null /** Format: date-time */ - readonly last_modified_at?: string; + readonly last_modified_at?: string /** @example 73..77,77..78 */ - readonly line_numbers?: readonly string[]; - readonly text_matches?: components["schemas"]["search-result-text-matches"]; - }; + readonly line_numbers?: readonly string[] + readonly text_matches?: components['schemas']['search-result-text-matches'] + } /** * Commit Search Result Item * @description Commit Search Result Item */ - readonly "commit-search-result-item": { + readonly 'commit-search-result-item': { /** Format: uri */ - readonly url: string; - readonly sha: string; + readonly url: string + readonly sha: string /** Format: uri */ - readonly html_url: string; + readonly html_url: string /** Format: uri */ - readonly comments_url: string; + readonly comments_url: string readonly commit: { readonly author: { - readonly name: string; - readonly email: string; + readonly name: string + readonly email: string /** Format: date-time */ - readonly date: string; - }; - readonly committer: components["schemas"]["nullable-git-user"]; - readonly comment_count: number; - readonly message: string; + readonly date: string + } + readonly committer: components['schemas']['nullable-git-user'] + readonly comment_count: number + readonly message: string readonly tree: { - readonly sha: string; + readonly sha: string /** Format: uri */ - readonly url: string; - }; + readonly url: string + } /** Format: uri */ - readonly url: string; - readonly verification?: components["schemas"]["verification"]; - }; - readonly author: components["schemas"]["nullable-simple-user"]; - readonly committer: components["schemas"]["nullable-git-user"]; + readonly url: string + readonly verification?: components['schemas']['verification'] + } + readonly author: components['schemas']['nullable-simple-user'] + readonly committer: components['schemas']['nullable-git-user'] readonly parents: readonly { - readonly url?: string; - readonly html_url?: string; - readonly sha?: string; - }[]; - readonly repository: components["schemas"]["minimal-repository"]; - readonly score: number; - readonly node_id: string; - readonly text_matches?: components["schemas"]["search-result-text-matches"]; - }; + readonly url?: string + readonly html_url?: string + readonly sha?: string + }[] + readonly repository: components['schemas']['minimal-repository'] + readonly score: number + readonly node_id: string + readonly text_matches?: components['schemas']['search-result-text-matches'] + } /** * Issue Search Result Item * @description Issue Search Result Item */ - readonly "issue-search-result-item": { + readonly 'issue-search-result-item': { /** Format: uri */ - readonly url: string; + readonly url: string /** Format: uri */ - readonly repository_url: string; - readonly labels_url: string; + readonly repository_url: string + readonly labels_url: string /** Format: uri */ - readonly comments_url: string; + readonly comments_url: string /** Format: uri */ - readonly events_url: string; + readonly events_url: string /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly node_id: string; - readonly number: number; - readonly title: string; - readonly locked: boolean; - readonly active_lock_reason?: string | null; - readonly assignees?: readonly components["schemas"]["simple-user"][] | null; - readonly user: components["schemas"]["nullable-simple-user"]; + readonly html_url: string + readonly id: number + readonly node_id: string + readonly number: number + readonly title: string + readonly locked: boolean + readonly active_lock_reason?: string | null + readonly assignees?: readonly components['schemas']['simple-user'][] | null + readonly user: components['schemas']['nullable-simple-user'] readonly labels: readonly { /** Format: int64 */ - readonly id?: number; - readonly node_id?: string; - readonly url?: string; - readonly name?: string; - readonly color?: string; - readonly default?: boolean; - readonly description?: string | null; - }[]; - readonly state: string; - readonly assignee: components["schemas"]["nullable-simple-user"]; - readonly milestone: components["schemas"]["nullable-milestone"]; - readonly comments: number; + readonly id?: number + readonly node_id?: string + readonly url?: string + readonly name?: string + readonly color?: string + readonly default?: boolean + readonly description?: string | null + }[] + readonly state: string + readonly assignee: components['schemas']['nullable-simple-user'] + readonly milestone: components['schemas']['nullable-milestone'] + readonly comments: number /** Format: date-time */ - readonly created_at: string; + readonly created_at: string /** Format: date-time */ - readonly updated_at: string; + readonly updated_at: string /** Format: date-time */ - readonly closed_at: string | null; - readonly text_matches?: components["schemas"]["search-result-text-matches"]; + readonly closed_at: string | null + readonly text_matches?: components['schemas']['search-result-text-matches'] readonly pull_request?: { /** Format: date-time */ - readonly merged_at?: string | null; + readonly merged_at?: string | null /** Format: uri */ - readonly diff_url: string | null; + readonly diff_url: string | null /** Format: uri */ - readonly html_url: string | null; + readonly html_url: string | null /** Format: uri */ - readonly patch_url: string | null; + readonly patch_url: string | null /** Format: uri */ - readonly url: string | null; - }; - readonly body?: string; - readonly score: number; - readonly author_association: components["schemas"]["author_association"]; - readonly draft?: boolean; - readonly repository?: components["schemas"]["repository"]; - readonly body_html?: string; - readonly body_text?: string; + readonly url: string | null + } + readonly body?: string + readonly score: number + readonly author_association: components['schemas']['author_association'] + readonly draft?: boolean + readonly repository?: components['schemas']['repository'] + readonly body_html?: string + readonly body_text?: string /** Format: uri */ - readonly timeline_url?: string; - readonly performed_via_github_app?: components["schemas"]["nullable-integration"]; - readonly reactions?: components["schemas"]["reaction-rollup"]; - }; + readonly timeline_url?: string + readonly performed_via_github_app?: components['schemas']['nullable-integration'] + readonly reactions?: components['schemas']['reaction-rollup'] + } /** * Label Search Result Item * @description Label Search Result Item */ - readonly "label-search-result-item": { - readonly id: number; - readonly node_id: string; + readonly 'label-search-result-item': { + readonly id: number + readonly node_id: string /** Format: uri */ - readonly url: string; - readonly name: string; - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly score: number; - readonly text_matches?: components["schemas"]["search-result-text-matches"]; - }; + readonly url: string + readonly name: string + readonly color: string + readonly default: boolean + readonly description: string | null + readonly score: number + readonly text_matches?: components['schemas']['search-result-text-matches'] + } /** * Repo Search Result Item * @description Repo Search Result Item */ - readonly "repo-search-result-item": { - readonly id: number; - readonly node_id: string; - readonly name: string; - readonly full_name: string; - readonly owner: components["schemas"]["nullable-simple-user"]; - readonly private: boolean; + readonly 'repo-search-result-item': { + readonly id: number + readonly node_id: string + readonly name: string + readonly full_name: string + readonly owner: components['schemas']['nullable-simple-user'] + readonly private: boolean /** Format: uri */ - readonly html_url: string; - readonly description: string | null; - readonly fork: boolean; + readonly html_url: string + readonly description: string | null + readonly fork: boolean /** Format: uri */ - readonly url: string; + readonly url: string /** Format: date-time */ - readonly created_at: string; + readonly created_at: string /** Format: date-time */ - readonly updated_at: string; + readonly updated_at: string /** Format: date-time */ - readonly pushed_at: string; + readonly pushed_at: string /** Format: uri */ - readonly homepage: string | null; - readonly size: number; - readonly stargazers_count: number; - readonly watchers_count: number; - readonly language: string | null; - readonly forks_count: number; - readonly open_issues_count: number; - readonly master_branch?: string; - readonly default_branch: string; - readonly score: number; + readonly homepage: string | null + readonly size: number + readonly stargazers_count: number + readonly watchers_count: number + readonly language: string | null + readonly forks_count: number + readonly open_issues_count: number + readonly master_branch?: string + readonly default_branch: string + readonly score: number /** Format: uri */ - readonly forks_url: string; - readonly keys_url: string; - readonly collaborators_url: string; + readonly forks_url: string + readonly keys_url: string + readonly collaborators_url: string /** Format: uri */ - readonly teams_url: string; + readonly teams_url: string /** Format: uri */ - readonly hooks_url: string; - readonly issue_events_url: string; + readonly hooks_url: string + readonly issue_events_url: string /** Format: uri */ - readonly events_url: string; - readonly assignees_url: string; - readonly branches_url: string; + readonly events_url: string + readonly assignees_url: string + readonly branches_url: string /** Format: uri */ - readonly tags_url: string; - readonly blobs_url: string; - readonly git_tags_url: string; - readonly git_refs_url: string; - readonly trees_url: string; - readonly statuses_url: string; + readonly tags_url: string + readonly blobs_url: string + readonly git_tags_url: string + readonly git_refs_url: string + readonly trees_url: string + readonly statuses_url: string /** Format: uri */ - readonly languages_url: string; + readonly languages_url: string /** Format: uri */ - readonly stargazers_url: string; + readonly stargazers_url: string /** Format: uri */ - readonly contributors_url: string; + readonly contributors_url: string /** Format: uri */ - readonly subscribers_url: string; + readonly subscribers_url: string /** Format: uri */ - readonly subscription_url: string; - readonly commits_url: string; - readonly git_commits_url: string; - readonly comments_url: string; - readonly issue_comment_url: string; - readonly contents_url: string; - readonly compare_url: string; + readonly subscription_url: string + readonly commits_url: string + readonly git_commits_url: string + readonly comments_url: string + readonly issue_comment_url: string + readonly contents_url: string + readonly compare_url: string /** Format: uri */ - readonly merges_url: string; - readonly archive_url: string; + readonly merges_url: string + readonly archive_url: string /** Format: uri */ - readonly downloads_url: string; - readonly issues_url: string; - readonly pulls_url: string; - readonly milestones_url: string; - readonly notifications_url: string; - readonly labels_url: string; - readonly releases_url: string; + readonly downloads_url: string + readonly issues_url: string + readonly pulls_url: string + readonly milestones_url: string + readonly notifications_url: string + readonly labels_url: string + readonly releases_url: string /** Format: uri */ - readonly deployments_url: string; - readonly git_url: string; - readonly ssh_url: string; - readonly clone_url: string; + readonly deployments_url: string + readonly git_url: string + readonly ssh_url: string + readonly clone_url: string /** Format: uri */ - readonly svn_url: string; - readonly forks: number; - readonly open_issues: number; - readonly watchers: number; - readonly topics?: readonly string[]; + readonly svn_url: string + readonly forks: number + readonly open_issues: number + readonly watchers: number + readonly topics?: readonly string[] /** Format: uri */ - readonly mirror_url: string | null; - readonly has_issues: boolean; - readonly has_projects: boolean; - readonly has_pages: boolean; - readonly has_wiki: boolean; - readonly has_downloads: boolean; - readonly archived: boolean; + readonly mirror_url: string | null + readonly has_issues: boolean + readonly has_projects: boolean + readonly has_pages: boolean + readonly has_wiki: boolean + readonly has_downloads: boolean + readonly archived: boolean /** @description Returns whether or not this repository disabled. */ - readonly disabled: boolean; + readonly disabled: boolean /** @description The repository visibility: public, private, or internal. */ - readonly visibility?: string; - readonly license: components["schemas"]["nullable-license-simple"]; + readonly visibility?: string + readonly license: components['schemas']['nullable-license-simple'] readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly push: boolean; - readonly triage?: boolean; - readonly pull: boolean; - }; - readonly text_matches?: components["schemas"]["search-result-text-matches"]; - readonly temp_clone_token?: string; - readonly allow_merge_commit?: boolean; - readonly allow_squash_merge?: boolean; - readonly allow_rebase_merge?: boolean; - readonly allow_auto_merge?: boolean; - readonly delete_branch_on_merge?: boolean; - readonly allow_forking?: boolean; - readonly is_template?: boolean; - }; + readonly admin: boolean + readonly maintain?: boolean + readonly push: boolean + readonly triage?: boolean + readonly pull: boolean + } + readonly text_matches?: components['schemas']['search-result-text-matches'] + readonly temp_clone_token?: string + readonly allow_merge_commit?: boolean + readonly allow_squash_merge?: boolean + readonly allow_rebase_merge?: boolean + readonly allow_auto_merge?: boolean + readonly delete_branch_on_merge?: boolean + readonly allow_forking?: boolean + readonly is_template?: boolean + } /** * Topic Search Result Item * @description Topic Search Result Item */ - readonly "topic-search-result-item": { - readonly name: string; - readonly display_name: string | null; - readonly short_description: string | null; - readonly description: string | null; - readonly created_by: string | null; - readonly released: string | null; + readonly 'topic-search-result-item': { + readonly name: string + readonly display_name: string | null + readonly short_description: string | null + readonly description: string | null + readonly created_by: string | null + readonly released: string | null /** Format: date-time */ - readonly created_at: string; + readonly created_at: string /** Format: date-time */ - readonly updated_at: string; - readonly featured: boolean; - readonly curated: boolean; - readonly score: number; - readonly repository_count?: number | null; + readonly updated_at: string + readonly featured: boolean + readonly curated: boolean + readonly score: number + readonly repository_count?: number | null /** Format: uri */ - readonly logo_url?: string | null; - readonly text_matches?: components["schemas"]["search-result-text-matches"]; + readonly logo_url?: string | null + readonly text_matches?: components['schemas']['search-result-text-matches'] readonly related?: | readonly { readonly topic_relation?: { - readonly id?: number; - readonly name?: string; - readonly topic_id?: number; - readonly relation_type?: string; - }; + readonly id?: number + readonly name?: string + readonly topic_id?: number + readonly relation_type?: string + } }[] - | null; + | null readonly aliases?: | readonly { readonly topic_relation?: { - readonly id?: number; - readonly name?: string; - readonly topic_id?: number; - readonly relation_type?: string; - }; + readonly id?: number + readonly name?: string + readonly topic_id?: number + readonly relation_type?: string + } }[] - | null; - }; + | null + } /** * User Search Result Item * @description User Search Result Item */ - readonly "user-search-result-item": { - readonly login: string; - readonly id: number; - readonly node_id: string; + readonly 'user-search-result-item': { + readonly login: string + readonly id: number + readonly node_id: string /** Format: uri */ - readonly avatar_url: string; - readonly gravatar_id: string | null; + readonly avatar_url: string + readonly gravatar_id: string | null /** Format: uri */ - readonly url: string; + readonly url: string /** Format: uri */ - readonly html_url: string; + readonly html_url: string /** Format: uri */ - readonly followers_url: string; + readonly followers_url: string /** Format: uri */ - readonly subscriptions_url: string; + readonly subscriptions_url: string /** Format: uri */ - readonly organizations_url: string; + readonly organizations_url: string /** Format: uri */ - readonly repos_url: string; + readonly repos_url: string /** Format: uri */ - readonly received_events_url: string; - readonly type: string; - readonly score: number; - readonly following_url: string; - readonly gists_url: string; - readonly starred_url: string; - readonly events_url: string; - readonly public_repos?: number; - readonly public_gists?: number; - readonly followers?: number; - readonly following?: number; + readonly received_events_url: string + readonly type: string + readonly score: number + readonly following_url: string + readonly gists_url: string + readonly starred_url: string + readonly events_url: string + readonly public_repos?: number + readonly public_gists?: number + readonly followers?: number + readonly following?: number /** Format: date-time */ - readonly created_at?: string; + readonly created_at?: string /** Format: date-time */ - readonly updated_at?: string; - readonly name?: string | null; - readonly bio?: string | null; + readonly updated_at?: string + readonly name?: string | null + readonly bio?: string | null /** Format: email */ - readonly email?: string | null; - readonly location?: string | null; - readonly site_admin: boolean; - readonly hireable?: boolean | null; - readonly text_matches?: components["schemas"]["search-result-text-matches"]; - readonly blog?: string | null; - readonly company?: string | null; + readonly email?: string | null + readonly location?: string | null + readonly site_admin: boolean + readonly hireable?: boolean | null + readonly text_matches?: components['schemas']['search-result-text-matches'] + readonly blog?: string | null + readonly company?: string | null /** Format: date-time */ - readonly suspended_at?: string | null; - }; + readonly suspended_at?: string | null + } /** * Private User * @description Private User */ - readonly "private-user": { + readonly 'private-user': { /** @example octocat */ - readonly login: string; + readonly login: string /** @example 1 */ - readonly id: number; + readonly id: number /** @example MDQ6VXNlcjE= */ - readonly node_id: string; + readonly node_id: string /** * Format: uri * @example https://github.com/images/error/octocat_happy.gif */ - readonly avatar_url: string; + readonly avatar_url: string /** @example 41d064eb2195891e12d0413f63227ea7 */ - readonly gravatar_id: string | null; + readonly gravatar_id: string | null /** * Format: uri * @example https://api.github.com/users/octocat */ - readonly url: string; + readonly url: string /** * Format: uri * @example https://github.com/octocat */ - readonly html_url: string; + readonly html_url: string /** * Format: uri * @example https://api.github.com/users/octocat/followers */ - readonly followers_url: string; + readonly followers_url: string /** @example https://api.github.com/users/octocat/following{/other_user} */ - readonly following_url: string; + readonly following_url: string /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - readonly gists_url: string; + readonly gists_url: string /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - readonly starred_url: string; + readonly starred_url: string /** * Format: uri * @example https://api.github.com/users/octocat/subscriptions */ - readonly subscriptions_url: string; + readonly subscriptions_url: string /** * Format: uri * @example https://api.github.com/users/octocat/orgs */ - readonly organizations_url: string; + readonly organizations_url: string /** * Format: uri * @example https://api.github.com/users/octocat/repos */ - readonly repos_url: string; + readonly repos_url: string /** @example https://api.github.com/users/octocat/events{/privacy} */ - readonly events_url: string; + readonly events_url: string /** * Format: uri * @example https://api.github.com/users/octocat/received_events */ - readonly received_events_url: string; + readonly received_events_url: string /** @example User */ - readonly type: string; - readonly site_admin: boolean; + readonly type: string + readonly site_admin: boolean /** @example monalisa octocat */ - readonly name: string | null; + readonly name: string | null /** @example GitHub */ - readonly company: string | null; + readonly company: string | null /** @example https://github.com/blog */ - readonly blog: string | null; + readonly blog: string | null /** @example San Francisco */ - readonly location: string | null; + readonly location: string | null /** * Format: email * @example octocat@github.com */ - readonly email: string | null; - readonly hireable: boolean | null; + readonly email: string | null + readonly hireable: boolean | null /** @example There once was... */ - readonly bio: string | null; + readonly bio: string | null /** @example monalisa */ - readonly twitter_username?: string | null; + readonly twitter_username?: string | null /** @example 2 */ - readonly public_repos: number; + readonly public_repos: number /** @example 1 */ - readonly public_gists: number; + readonly public_gists: number /** @example 20 */ - readonly followers: number; - readonly following: number; + readonly followers: number + readonly following: number /** * Format: date-time * @example 2008-01-14T04:33:35Z */ - readonly created_at: string; + readonly created_at: string /** * Format: date-time * @example 2008-01-14T04:33:35Z */ - readonly updated_at: string; + readonly updated_at: string /** @example 81 */ - readonly private_gists: number; + readonly private_gists: number /** @example 100 */ - readonly total_private_repos: number; + readonly total_private_repos: number /** @example 100 */ - readonly owned_private_repos: number; + readonly owned_private_repos: number /** @example 10000 */ - readonly disk_usage: number; + readonly disk_usage: number /** @example 8 */ - readonly collaborators: number; + readonly collaborators: number /** @example true */ - readonly two_factor_authentication: boolean; + readonly two_factor_authentication: boolean readonly plan?: { - readonly collaborators: number; - readonly name: string; - readonly space: number; - readonly private_repos: number; - }; + readonly collaborators: number + readonly name: string + readonly space: number + readonly private_repos: number + } /** Format: date-time */ - readonly suspended_at?: string | null; - readonly business_plus?: boolean; - readonly ldap_dn?: string; - }; + readonly suspended_at?: string | null + readonly business_plus?: boolean + readonly ldap_dn?: string + } /** * Codespaces Secret * @description Secrets for a GitHub Codespace. */ - readonly "codespaces-secret": { + readonly 'codespaces-secret': { /** * @description The name of the secret. * @example SECRET_NAME */ - readonly name: string; + readonly name: string /** Format: date-time */ - readonly created_at: string; + readonly created_at: string /** Format: date-time */ - readonly updated_at: string; + readonly updated_at: string /** * @description Visibility of a secret * @enum {string} */ - readonly visibility: "all" | "private" | "selected"; + readonly visibility: 'all' | 'private' | 'selected' /** * Format: uri * @example https://api.github.com/user/secrets/SECRET_NAME/repositories */ - readonly selected_repositories_url: string; - }; + readonly selected_repositories_url: string + } /** * CodespacesUserPublicKey * @description The public key used for setting user Codespaces' Secrets. */ - readonly "codespaces-user-public-key": { + readonly 'codespaces-user-public-key': { /** * @description The identifier for the key. * @example 1234567 */ - readonly key_id: string; + readonly key_id: string /** * @description The Base64 encoded public key. * @example hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= */ - readonly key: string; - }; + readonly key: string + } /** * Fetches information about an export of a codespace. * @description An export of a codespace. Also, latest export details for a codespace can be fetched with id = latest */ - readonly "codespace-export-details": { + readonly 'codespace-export-details': { /** * @description State of the latest export * @example succeeded | failed | in_progress */ - readonly state?: string | null; + readonly state?: string | null /** * Format: date-time * @description Completion time of the last export operation * @example 2021-01-01T19:01:12Z */ - readonly completed_at?: string | null; + readonly completed_at?: string | null /** * @description Name of the exported branch * @example codespace-monalisa-octocat-hello-world-g4wpq6h95q */ - readonly branch?: string | null; + readonly branch?: string | null /** * @description Git commit SHA of the exported branch * @example fd95a81ca01e48ede9f39c799ecbcef817b8a3b2 */ - readonly sha?: string | null; + readonly sha?: string | null /** * @description Id for the export details * @example latest */ - readonly id?: string; + readonly id?: string /** * @description Url for fetching export details * @example https://api.github.com/user/codespaces/:name/exports/latest */ - readonly export_url?: string; - }; + readonly export_url?: string + } /** * Email * @description Email @@ -17315,355 +17299,355 @@ export interface components { * Format: email * @example octocat@github.com */ - readonly email: string; + readonly email: string /** @example true */ - readonly primary: boolean; + readonly primary: boolean /** @example true */ - readonly verified: boolean; + readonly verified: boolean /** @example public */ - readonly visibility: string | null; - }; + readonly visibility: string | null + } /** * GPG Key * @description A unique encryption key */ - readonly "gpg-key": { + readonly 'gpg-key': { /** @example 3 */ - readonly id: number; - readonly primary_key_id: number | null; + readonly id: number + readonly primary_key_id: number | null /** @example 3262EFF25BA0D270 */ - readonly key_id: string; + readonly key_id: string /** @example xsBNBFayYZ... */ - readonly public_key: string; + readonly public_key: string /** @example [object Object] */ readonly emails: readonly { - readonly email?: string; - readonly verified?: boolean; - }[]; + readonly email?: string + readonly verified?: boolean + }[] /** @example [object Object] */ readonly subkeys: readonly { - readonly id?: number; - readonly primary_key_id?: number; - readonly key_id?: string; - readonly public_key?: string; - readonly emails?: readonly unknown[]; - readonly subkeys?: readonly unknown[]; - readonly can_sign?: boolean; - readonly can_encrypt_comms?: boolean; - readonly can_encrypt_storage?: boolean; - readonly can_certify?: boolean; - readonly created_at?: string; - readonly expires_at?: string | null; - readonly raw_key?: string | null; - }[]; + readonly id?: number + readonly primary_key_id?: number + readonly key_id?: string + readonly public_key?: string + readonly emails?: readonly unknown[] + readonly subkeys?: readonly unknown[] + readonly can_sign?: boolean + readonly can_encrypt_comms?: boolean + readonly can_encrypt_storage?: boolean + readonly can_certify?: boolean + readonly created_at?: string + readonly expires_at?: string | null + readonly raw_key?: string | null + }[] /** @example true */ - readonly can_sign: boolean; - readonly can_encrypt_comms: boolean; - readonly can_encrypt_storage: boolean; + readonly can_sign: boolean + readonly can_encrypt_comms: boolean + readonly can_encrypt_storage: boolean /** @example true */ - readonly can_certify: boolean; + readonly can_certify: boolean /** * Format: date-time * @example 2016-03-24T11:31:04-06:00 */ - readonly created_at: string; + readonly created_at: string /** Format: date-time */ - readonly expires_at: string | null; - readonly raw_key: string | null; - }; + readonly expires_at: string | null + readonly raw_key: string | null + } /** * Key * @description Key */ readonly key: { - readonly key: string; - readonly id: number; - readonly url: string; - readonly title: string; + readonly key: string + readonly id: number + readonly url: string + readonly title: string /** Format: date-time */ - readonly created_at: string; - readonly verified: boolean; - readonly read_only: boolean; - }; + readonly created_at: string + readonly verified: boolean + readonly read_only: boolean + } /** Marketplace Account */ - readonly "marketplace-account": { + readonly 'marketplace-account': { /** Format: uri */ - readonly url: string; - readonly id: number; - readonly type: string; - readonly node_id?: string; - readonly login: string; + readonly url: string + readonly id: number + readonly type: string + readonly node_id?: string + readonly login: string /** Format: email */ - readonly email?: string | null; + readonly email?: string | null /** Format: email */ - readonly organization_billing_email?: string | null; - }; + readonly organization_billing_email?: string | null + } /** * User Marketplace Purchase * @description User Marketplace Purchase */ - readonly "user-marketplace-purchase": { + readonly 'user-marketplace-purchase': { /** @example monthly */ - readonly billing_cycle: string; + readonly billing_cycle: string /** * Format: date-time * @example 2017-11-11T00:00:00Z */ - readonly next_billing_date: string | null; - readonly unit_count: number | null; + readonly next_billing_date: string | null + readonly unit_count: number | null /** @example true */ - readonly on_free_trial: boolean; + readonly on_free_trial: boolean /** * Format: date-time * @example 2017-11-11T00:00:00Z */ - readonly free_trial_ends_on: string | null; + readonly free_trial_ends_on: string | null /** * Format: date-time * @example 2017-11-02T01:12:12Z */ - readonly updated_at: string | null; - readonly account: components["schemas"]["marketplace-account"]; - readonly plan: components["schemas"]["marketplace-listing-plan"]; - }; + readonly updated_at: string | null + readonly account: components['schemas']['marketplace-account'] + readonly plan: components['schemas']['marketplace-listing-plan'] + } /** * Starred Repository * @description Starred Repository */ - readonly "starred-repository": { + readonly 'starred-repository': { /** Format: date-time */ - readonly starred_at: string; - readonly repo: components["schemas"]["repository"]; - }; + readonly starred_at: string + readonly repo: components['schemas']['repository'] + } /** * Hovercard * @description Hovercard */ readonly hovercard: { readonly contexts: readonly { - readonly message: string; - readonly octicon: string; - }[]; - }; + readonly message: string + readonly octicon: string + }[] + } /** * Key Simple * @description Key Simple */ - readonly "key-simple": { - readonly id: number; - readonly key: string; - }; - }; + readonly 'key-simple': { + readonly id: number + readonly key: string + } + } readonly responses: { /** Resource not found */ readonly not_found: { readonly content: { - readonly "application/json": components["schemas"]["basic-error"]; - }; - }; + readonly 'application/json': components['schemas']['basic-error'] + } + } /** Validation failed */ readonly validation_failed_simple: { readonly content: { - readonly "application/json": components["schemas"]["validation-error-simple"]; - }; - }; + readonly 'application/json': components['schemas']['validation-error-simple'] + } + } /** Bad Request */ readonly bad_request: { readonly content: { - readonly "application/json": components["schemas"]["basic-error"]; - readonly "application/scim+json": components["schemas"]["scim-error"]; - }; - }; + readonly 'application/json': components['schemas']['basic-error'] + readonly 'application/scim+json': components['schemas']['scim-error'] + } + } /** Validation failed */ readonly validation_failed: { readonly content: { - readonly "application/json": components["schemas"]["validation-error"]; - }; - }; + readonly 'application/json': components['schemas']['validation-error'] + } + } /** Accepted */ readonly accepted: { readonly content: { - readonly "application/json": { readonly [key: string]: unknown }; - }; - }; + readonly 'application/json': { readonly [key: string]: unknown } + } + } /** Preview header missing */ readonly preview_header_missing: { readonly content: { - readonly "application/json": { - readonly message: string; - readonly documentation_url: string; - }; - }; - }; + readonly 'application/json': { + readonly message: string + readonly documentation_url: string + } + } + } /** Forbidden */ readonly forbidden: { readonly content: { - readonly "application/json": components["schemas"]["basic-error"]; - }; - }; + readonly 'application/json': components['schemas']['basic-error'] + } + } /** Requires authentication */ readonly requires_authentication: { readonly content: { - readonly "application/json": components["schemas"]["basic-error"]; - }; - }; + readonly 'application/json': components['schemas']['basic-error'] + } + } /** Not modified */ - readonly not_modified: unknown; + readonly not_modified: unknown /** Gone */ readonly gone: { readonly content: { - readonly "application/json": components["schemas"]["basic-error"]; - }; - }; + readonly 'application/json': components['schemas']['basic-error'] + } + } /** Response */ readonly actions_runner_labels: { readonly content: { - readonly "application/json": { - readonly total_count: number; - readonly labels: readonly components["schemas"]["runner-label"][]; - }; - }; - }; + readonly 'application/json': { + readonly total_count: number + readonly labels: readonly components['schemas']['runner-label'][] + } + } + } /** Response */ readonly actions_runner_labels_readonly: { readonly content: { - readonly "application/json": { - readonly total_count: number; - readonly labels: readonly components["schemas"]["runner-label"][]; - }; - }; - }; + readonly 'application/json': { + readonly total_count: number + readonly labels: readonly components['schemas']['runner-label'][] + } + } + } /** Service unavailable */ readonly service_unavailable: { readonly content: { - readonly "application/json": { - readonly code?: string; - readonly message?: string; - readonly documentation_url?: string; - }; - }; - }; + readonly 'application/json': { + readonly code?: string + readonly message?: string + readonly documentation_url?: string + } + } + } /** Response if GitHub Advanced Security is not enabled for this repository */ readonly code_scanning_forbidden_read: { readonly content: { - readonly "application/json": components["schemas"]["basic-error"]; - }; - }; + readonly 'application/json': components['schemas']['basic-error'] + } + } /** Forbidden Gist */ readonly forbidden_gist: { readonly content: { - readonly "application/json": { + readonly 'application/json': { readonly block?: { - readonly reason?: string; - readonly created_at?: string; - readonly html_url?: string | null; - }; - readonly message?: string; - readonly documentation_url?: string; - }; - }; - }; + readonly reason?: string + readonly created_at?: string + readonly html_url?: string | null + } + readonly message?: string + readonly documentation_url?: string + } + } + } /** Moved permanently */ readonly moved_permanently: { readonly content: { - readonly "application/json": components["schemas"]["basic-error"]; - }; - }; + readonly 'application/json': components['schemas']['basic-error'] + } + } /** Conflict */ readonly conflict: { readonly content: { - readonly "application/json": components["schemas"]["basic-error"]; - }; - }; + readonly 'application/json': components['schemas']['basic-error'] + } + } /** Temporary Redirect */ readonly temporary_redirect: { readonly content: { - readonly "application/json": components["schemas"]["basic-error"]; - }; - }; + readonly 'application/json': components['schemas']['basic-error'] + } + } /** Internal Error */ readonly internal_error: { readonly content: { - readonly "application/json": components["schemas"]["basic-error"]; - }; - }; + readonly 'application/json': components['schemas']['basic-error'] + } + } /** Response if the repository is archived or if github advanced security is not enabled for this repository */ readonly code_scanning_forbidden_write: { readonly content: { - readonly "application/json": components["schemas"]["basic-error"]; - }; - }; + readonly 'application/json': components['schemas']['basic-error'] + } + } /** Found */ - readonly found: unknown; + readonly found: unknown /** A header with no content is returned. */ - readonly no_content: unknown; + readonly no_content: unknown /** Resource not found */ readonly scim_not_found: { readonly content: { - readonly "application/json": components["schemas"]["scim-error"]; - readonly "application/scim+json": components["schemas"]["scim-error"]; - }; - }; + readonly 'application/json': components['schemas']['scim-error'] + readonly 'application/scim+json': components['schemas']['scim-error'] + } + } /** Forbidden */ readonly scim_forbidden: { readonly content: { - readonly "application/json": components["schemas"]["scim-error"]; - readonly "application/scim+json": components["schemas"]["scim-error"]; - }; - }; + readonly 'application/json': components['schemas']['scim-error'] + readonly 'application/scim+json': components['schemas']['scim-error'] + } + } /** Bad Request */ readonly scim_bad_request: { readonly content: { - readonly "application/json": components["schemas"]["scim-error"]; - readonly "application/scim+json": components["schemas"]["scim-error"]; - }; - }; + readonly 'application/json': components['schemas']['scim-error'] + readonly 'application/scim+json': components['schemas']['scim-error'] + } + } /** Internal Error */ readonly scim_internal_error: { readonly content: { - readonly "application/json": components["schemas"]["scim-error"]; - readonly "application/scim+json": components["schemas"]["scim-error"]; - }; - }; + readonly 'application/json': components['schemas']['scim-error'] + readonly 'application/scim+json': components['schemas']['scim-error'] + } + } /** Conflict */ readonly scim_conflict: { readonly content: { - readonly "application/json": components["schemas"]["scim-error"]; - readonly "application/scim+json": components["schemas"]["scim-error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['scim-error'] + readonly 'application/scim+json': components['schemas']['scim-error'] + } + } + } readonly parameters: { /** @description Results per page (max 100) */ - readonly "per-page": number; + readonly 'per-page': number /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ - readonly cursor: string; - readonly "delivery-id": number; + readonly cursor: string + readonly 'delivery-id': number /** @description Page number of the results to fetch. */ - readonly page: number; + readonly page: number /** @description Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since: string; + readonly since: string /** @description installation_id parameter */ - readonly "installation-id": number; + readonly 'installation-id': number /** @description grant_id parameter */ - readonly "grant-id": number; + readonly 'grant-id': number /** @description The client ID of your GitHub app. */ - readonly "client-id": string; - readonly "app-slug": string; + readonly 'client-id': string + readonly 'app-slug': string /** @description authorization_id parameter */ - readonly "authorization-id": number; + readonly 'authorization-id': number /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: string; + readonly enterprise: string /** @description Unique identifier of an organization. */ - readonly "org-id": number; + readonly 'org-id': number /** @description Unique identifier of the self-hosted runner group. */ - readonly "runner-group-id": number; + readonly 'runner-group-id': number /** @description Unique identifier of the self-hosted runner. */ - readonly "runner-id": number; + readonly 'runner-id': number /** @description The name of a self-hosted runner's custom label. */ - readonly "runner-label-name": string; + readonly 'runner-label-name': string /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). */ - readonly "audit-log-phrase": string; + readonly 'audit-log-phrase': string /** * @description The event types to include: * @@ -17673,843 +17657,843 @@ export interface components { * * The default is `web`. */ - readonly "audit-log-include": "web" | "git" | "all"; + readonly 'audit-log-include': 'web' | 'git' | 'all' /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor. */ - readonly "audit-log-after": string; + readonly 'audit-log-after': string /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor. */ - readonly "audit-log-before": string; + readonly 'audit-log-before': string /** * @description The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. * * The default is `desc`. */ - readonly "audit-log-order": "desc" | "asc"; + readonly 'audit-log-order': 'desc' | 'asc' /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - readonly "secret-scanning-alert-state": "open" | "resolved"; + readonly 'secret-scanning-alert-state': 'open' | 'resolved' /** * @description A comma-separated list of secret types to return. By default all secret types are returned. * See "[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)" * for a complete list of secret types (API slug). */ - readonly "secret-scanning-alert-secret-type": string; + readonly 'secret-scanning-alert-secret-type': string /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - readonly "secret-scanning-alert-resolution": string; + readonly 'secret-scanning-alert-resolution': string /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor. */ - readonly "pagination-before": string; + readonly 'pagination-before': string /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor. */ - readonly "pagination-after": string; + readonly 'pagination-after': string /** @description gist_id parameter */ - readonly "gist-id": string; + readonly 'gist-id': string /** @description comment_id parameter */ - readonly "comment-id": number; + readonly 'comment-id': number /** @description A list of comma separated label names. Example: `bug,ui,@high` */ - readonly labels: string; + readonly labels: string /** @description One of `asc` (ascending) or `desc` (descending). */ - readonly direction: "asc" | "desc"; + readonly direction: 'asc' | 'desc' /** @description account_id parameter */ - readonly "account-id": number; + readonly 'account-id': number /** @description plan_id parameter */ - readonly "plan-id": number; + readonly 'plan-id': number /** @description One of `created` (when the repository was starred) or `updated` (when it was last pushed to). */ - readonly sort: "created" | "updated"; - readonly owner: string; - readonly repo: string; + readonly sort: 'created' | 'updated' + readonly owner: string + readonly repo: string /** @description If `true`, show notifications marked as read. */ - readonly all: boolean; + readonly all: boolean /** @description If `true`, only shows notifications in which the user is directly participating or mentioned. */ - readonly participating: boolean; + readonly participating: boolean /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly before: string; + readonly before: string /** @description thread_id parameter */ - readonly "thread-id": number; + readonly 'thread-id': number /** @description An organization ID. Only return organizations with an ID greater than this ID. */ - readonly "since-org": number; - readonly org: string; + readonly 'since-org': number + readonly org: string /** @description team_slug parameter */ - readonly "team-slug": string; - readonly "repository-id": number; + readonly 'team-slug': string + readonly 'repository-id': number /** @description secret_name parameter */ - readonly "secret-name": string; - readonly username: string; + readonly 'secret-name': string + readonly username: string /** @description group_id parameter */ - readonly "group-id": number; - readonly "hook-id": number; + readonly 'group-id': number + readonly 'hook-id': number /** @description invitation_id parameter */ - readonly "invitation-id": number; + readonly 'invitation-id': number /** @description migration_id parameter */ - readonly "migration-id": number; + readonly 'migration-id': number /** @description repo_name parameter */ - readonly "repo-name": string; + readonly 'repo-name': string /** @description The selected visibility of the packages. Can be one of `public`, `private`, or `internal`. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set. */ - readonly "package-visibility": "public" | "private" | "internal"; + readonly 'package-visibility': 'public' | 'private' | 'internal' /** @description The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly "package-type": "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + readonly 'package-type': 'npm' | 'maven' | 'rubygems' | 'docker' | 'nuget' | 'container' /** @description The name of the package. */ - readonly "package-name": string; + readonly 'package-name': string /** @description Unique identifier of the package version. */ - readonly "package-version-id": number; - readonly "discussion-number": number; - readonly "comment-number": number; - readonly "reaction-id": number; - readonly "project-id": number; + readonly 'package-version-id': number + readonly 'discussion-number': number + readonly 'comment-number': number + readonly 'reaction-id': number + readonly 'project-id': number /** @description card_id parameter */ - readonly "card-id": number; + readonly 'card-id': number /** @description column_id parameter */ - readonly "column-id": number; + readonly 'column-id': number /** @description artifact_id parameter */ - readonly "artifact-id": number; + readonly 'artifact-id': number /** @description job_id parameter */ - readonly "job-id": number; + readonly 'job-id': number /** @description Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ - readonly actor: string; + readonly actor: string /** @description Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ - readonly "workflow-run-branch": string; + readonly 'workflow-run-branch': string /** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ - readonly event: string; + readonly event: string /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. For a list of the possible `status` and `conclusion` options, see "[Create a check run](https://docs.github.com/rest/reference/checks#create-a-check-run)." */ - readonly "workflow-run-status": - | "completed" - | "action_required" - | "cancelled" - | "failure" - | "neutral" - | "skipped" - | "stale" - | "success" - | "timed_out" - | "in_progress" - | "queued" - | "requested" - | "waiting"; + readonly 'workflow-run-status': + | 'completed' + | 'action_required' + | 'cancelled' + | 'failure' + | 'neutral' + | 'skipped' + | 'stale' + | 'success' + | 'timed_out' + | 'in_progress' + | 'queued' + | 'requested' + | 'waiting' /** @description Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ - readonly created: string; + readonly created: string /** @description If `true` pull requests are omitted from the response (empty array). */ - readonly "exclude-pull-requests": boolean; + readonly 'exclude-pull-requests': boolean /** @description Returns workflow runs with the `check_suite_id` that you specify. */ - readonly "workflow-run-check-suite-id": number; + readonly 'workflow-run-check-suite-id': number /** @description The id of the workflow run. */ - readonly "run-id": number; + readonly 'run-id': number /** @description The attempt number of the workflow run. */ - readonly "attempt-number": number; + readonly 'attempt-number': number /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ - readonly "workflow-id": number | string; + readonly 'workflow-id': number | string /** @description autolink_id parameter */ - readonly "autolink-id": number; + readonly 'autolink-id': number /** @description The name of the branch. */ - readonly branch: string; + readonly branch: string /** @description check_run_id parameter */ - readonly "check-run-id": number; + readonly 'check-run-id': number /** @description check_suite_id parameter */ - readonly "check-suite-id": number; + readonly 'check-suite-id': number /** @description Returns check runs with the specified `name`. */ - readonly "check-name": string; + readonly 'check-name': string /** @description Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`. */ - readonly status: "queued" | "in_progress" | "completed"; + readonly status: 'queued' | 'in_progress' | 'completed' /** @description The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */ - readonly "tool-name": components["schemas"]["code-scanning-analysis-tool-name"]; + readonly 'tool-name': components['schemas']['code-scanning-analysis-tool-name'] /** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ - readonly "tool-guid": components["schemas"]["code-scanning-analysis-tool-guid"]; + readonly 'tool-guid': components['schemas']['code-scanning-analysis-tool-guid'] /** @description The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ - readonly "git-ref": components["schemas"]["code-scanning-ref"]; + readonly 'git-ref': components['schemas']['code-scanning-ref'] /** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ - readonly "alert-number": components["schemas"]["alert-number"]; + readonly 'alert-number': components['schemas']['alert-number'] /** @description commit_sha parameter */ - readonly "commit-sha": string; + readonly 'commit-sha': string /** @description deployment_id parameter */ - readonly "deployment-id": number; + readonly 'deployment-id': number /** @description The name of the environment */ - readonly "environment-name": string; + readonly 'environment-name': string /** @description A user ID. Only return users with an ID greater than this ID. */ - readonly "since-user": number; + readonly 'since-user': number /** @description issue_number parameter */ - readonly "issue-number": number; + readonly 'issue-number': number /** @description key_id parameter */ - readonly "key-id": number; + readonly 'key-id': number /** @description milestone_number parameter */ - readonly "milestone-number": number; - readonly "pull-number": number; + readonly 'milestone-number': number + readonly 'pull-number': number /** @description review_id parameter */ - readonly "review-id": number; + readonly 'review-id': number /** @description asset_id parameter */ - readonly "asset-id": number; + readonly 'asset-id': number /** @description release_id parameter */ - readonly "release-id": number; + readonly 'release-id': number /** @description Must be one of: `day`, `week`. */ - readonly per: "" | "day" | "week"; + readonly per: '' | 'day' | 'week' /** @description A repository ID. Only return repositories with an ID greater than this ID. */ - readonly "since-repo": number; + readonly 'since-repo': number /** @description Used for pagination: the index of the first result to return. */ - readonly "start-index": number; + readonly 'start-index': number /** @description Used for pagination: the number of results to return. */ - readonly count: number; + readonly count: number /** @description Identifier generated by the GitHub SCIM endpoint. */ - readonly "scim-group-id": string; + readonly 'scim-group-id': string /** @description scim_user_id parameter */ - readonly "scim-user-id": string; + readonly 'scim-user-id': string /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - readonly order: "desc" | "asc"; - readonly "team-id": number; + readonly order: 'desc' | 'asc' + readonly 'team-id': number /** @description ID of the Repository to filter on */ - readonly "repository-id-in-query": number; + readonly 'repository-id-in-query': number /** @description The name of the codespace. */ - readonly "codespace-name": string; + readonly 'codespace-name': string /** @description The ID of the export operation, or `latest`. Currently only `latest` is currently supported. */ - readonly "export-id": string; + readonly 'export-id': string /** @description gpg_key_id parameter */ - readonly "gpg-key-id": number; - }; + readonly 'gpg-key-id': number + } readonly headers: { - readonly link?: string; - readonly "content-type"?: string; - readonly "x-common-marker-version"?: string; - readonly "x-rate-limit-limit"?: number; - readonly "x-rate-limit-remaining"?: number; - readonly "x-rate-limit-reset"?: number; - readonly location?: string; - }; + readonly link?: string + readonly 'content-type'?: string + readonly 'x-common-marker-version'?: string + readonly 'x-rate-limit-limit'?: number + readonly 'x-rate-limit-remaining'?: number + readonly 'x-rate-limit-reset'?: number + readonly location?: string + } } export interface operations { /** Get Hypermedia links to resources accessible in GitHub's REST API */ - readonly "meta/root": { + readonly 'meta/root': { readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** Format: uri-template */ - readonly current_user_url: string; + readonly current_user_url: string /** Format: uri-template */ - readonly current_user_authorizations_html_url: string; + readonly current_user_authorizations_html_url: string /** Format: uri-template */ - readonly authorizations_url: string; + readonly authorizations_url: string /** Format: uri-template */ - readonly code_search_url: string; + readonly code_search_url: string /** Format: uri-template */ - readonly commit_search_url: string; + readonly commit_search_url: string /** Format: uri-template */ - readonly emails_url: string; + readonly emails_url: string /** Format: uri-template */ - readonly emojis_url: string; + readonly emojis_url: string /** Format: uri-template */ - readonly events_url: string; + readonly events_url: string /** Format: uri-template */ - readonly feeds_url: string; + readonly feeds_url: string /** Format: uri-template */ - readonly followers_url: string; + readonly followers_url: string /** Format: uri-template */ - readonly following_url: string; + readonly following_url: string /** Format: uri-template */ - readonly gists_url: string; + readonly gists_url: string /** Format: uri-template */ - readonly hub_url: string; + readonly hub_url: string /** Format: uri-template */ - readonly issue_search_url: string; + readonly issue_search_url: string /** Format: uri-template */ - readonly issues_url: string; + readonly issues_url: string /** Format: uri-template */ - readonly keys_url: string; + readonly keys_url: string /** Format: uri-template */ - readonly label_search_url: string; + readonly label_search_url: string /** Format: uri-template */ - readonly notifications_url: string; + readonly notifications_url: string /** Format: uri-template */ - readonly organization_url: string; + readonly organization_url: string /** Format: uri-template */ - readonly organization_repositories_url: string; + readonly organization_repositories_url: string /** Format: uri-template */ - readonly organization_teams_url: string; + readonly organization_teams_url: string /** Format: uri-template */ - readonly public_gists_url: string; + readonly public_gists_url: string /** Format: uri-template */ - readonly rate_limit_url: string; + readonly rate_limit_url: string /** Format: uri-template */ - readonly repository_url: string; + readonly repository_url: string /** Format: uri-template */ - readonly repository_search_url: string; + readonly repository_search_url: string /** Format: uri-template */ - readonly current_user_repositories_url: string; + readonly current_user_repositories_url: string /** Format: uri-template */ - readonly starred_url: string; + readonly starred_url: string /** Format: uri-template */ - readonly starred_gists_url: string; + readonly starred_gists_url: string /** Format: uri-template */ - readonly topic_search_url?: string; + readonly topic_search_url?: string /** Format: uri-template */ - readonly user_url: string; + readonly user_url: string /** Format: uri-template */ - readonly user_organizations_url: string; + readonly user_organizations_url: string /** Format: uri-template */ - readonly user_repositories_url: string; + readonly user_repositories_url: string /** Format: uri-template */ - readonly user_search_url: string; - }; - }; - }; - }; - }; + readonly user_search_url: string + } + } + } + } + } /** * Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/rest/reference/apps#list-installations-for-the-authenticated-app)" endpoint. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly "apps/get-authenticated": { - readonly parameters: {}; + readonly 'apps/get-authenticated': { + readonly parameters: {} readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["integration"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['integration'] + } + } + } + } /** Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. */ - readonly "apps/create-from-manifest": { + readonly 'apps/create-from-manifest': { readonly parameters: { readonly path: { - readonly code: string; - }; - }; + readonly code: string + } + } readonly responses: { /** Response */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["integration"] & + readonly 'application/json': components['schemas']['integration'] & ({ - readonly client_id: string; - readonly client_secret: string; - readonly webhook_secret: string | null; - readonly pem: string; - } & { readonly [key: string]: unknown }); - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; - }; + readonly client_id: string + readonly client_secret: string + readonly webhook_secret: string | null + readonly pem: string + } & { readonly [key: string]: unknown }) + } + } + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed_simple'] + } readonly requestBody: { readonly content: { - readonly "application/json": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/json': { readonly [key: string]: unknown } + } + } + } /** * Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly "apps/get-webhook-config-for-app": { + readonly 'apps/get-webhook-config-for-app': { readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["webhook-config"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['webhook-config'] + } + } + } + } /** * Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly "apps/update-webhook-config-for-app": { + readonly 'apps/update-webhook-config-for-app': { readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["webhook-config"]; - }; - }; - }; + readonly 'application/json': components['schemas']['webhook-config'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { - readonly url?: components["schemas"]["webhook-config-url"]; - readonly content_type?: components["schemas"]["webhook-config-content-type"]; - readonly secret?: components["schemas"]["webhook-config-secret"]; - readonly insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - }; - }; - }; - }; + readonly 'application/json': { + readonly url?: components['schemas']['webhook-config-url'] + readonly content_type?: components['schemas']['webhook-config-content-type'] + readonly secret?: components['schemas']['webhook-config-secret'] + readonly insecure_ssl?: components['schemas']['webhook-config-insecure-ssl'] + } + } + } + } /** * Returns a list of webhook deliveries for the webhook configured for a GitHub App. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly "apps/list-webhook-deliveries": { + readonly 'apps/list-webhook-deliveries': { readonly parameters: { readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ - readonly cursor?: components["parameters"]["cursor"]; - }; - }; + readonly cursor?: components['parameters']['cursor'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["hook-delivery-item"][]; - }; - }; - readonly 400: components["responses"]["bad_request"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; + readonly 'application/json': readonly components['schemas']['hook-delivery-item'][] + } + } + readonly 400: components['responses']['bad_request'] + readonly 422: components['responses']['validation_failed'] + } + } /** * Returns a delivery for the webhook configured for a GitHub App. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly "apps/get-webhook-delivery": { + readonly 'apps/get-webhook-delivery': { readonly parameters: { readonly path: { - readonly delivery_id: components["parameters"]["delivery-id"]; - }; - }; + readonly delivery_id: components['parameters']['delivery-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["hook-delivery"]; - }; - }; - readonly 400: components["responses"]["bad_request"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; + readonly 'application/json': components['schemas']['hook-delivery'] + } + } + readonly 400: components['responses']['bad_request'] + readonly 422: components['responses']['validation_failed'] + } + } /** * Redeliver a delivery for the webhook configured for a GitHub App. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly "apps/redeliver-webhook-delivery": { + readonly 'apps/redeliver-webhook-delivery': { readonly parameters: { readonly path: { - readonly delivery_id: components["parameters"]["delivery-id"]; - }; - }; + readonly delivery_id: components['parameters']['delivery-id'] + } + } readonly responses: { - readonly 202: components["responses"]["accepted"]; - readonly 400: components["responses"]["bad_request"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; + readonly 202: components['responses']['accepted'] + readonly 400: components['responses']['bad_request'] + readonly 422: components['responses']['validation_failed'] + } + } /** * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. * * The permissions the installation has are included under the `permissions` key. */ - readonly "apps/list-installations": { + readonly 'apps/list-installations': { readonly parameters: { readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; + readonly page?: components['parameters']['page'] /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; - readonly outdated?: string; - }; - }; + readonly since?: components['parameters']['since'] + readonly outdated?: string + } + } readonly responses: { /** The permissions the installation has are included under the `permissions` key. */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["installation"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['installation'][] + } + } + } + } /** * Enables an authenticated GitHub App to find an installation's information using the installation id. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly "apps/get-installation": { + readonly 'apps/get-installation': { readonly parameters: { readonly path: { /** installation_id parameter */ - readonly installation_id: components["parameters"]["installation-id"]; - }; - }; + readonly installation_id: components['parameters']['installation-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["installation"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 415: components["responses"]["preview_header_missing"]; - }; - }; + readonly 'application/json': components['schemas']['installation'] + } + } + readonly 404: components['responses']['not_found'] + readonly 415: components['responses']['preview_header_missing'] + } + } /** * Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/reference/apps/#suspend-an-app-installation)" endpoint. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly "apps/delete-installation": { + readonly 'apps/delete-installation': { readonly parameters: { readonly path: { /** installation_id parameter */ - readonly installation_id: components["parameters"]["installation-id"]; - }; - }; + readonly installation_id: components['parameters']['installation-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 204: never + readonly 404: components['responses']['not_found'] + } + } /** * Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly "apps/create-installation-access-token": { + readonly 'apps/create-installation-access-token': { readonly parameters: { readonly path: { /** installation_id parameter */ - readonly installation_id: components["parameters"]["installation-id"]; - }; - }; + readonly installation_id: components['parameters']['installation-id'] + } + } readonly responses: { /** Response */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["installation-token"]; - }; - }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 415: components["responses"]["preview_header_missing"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': components['schemas']['installation-token'] + } + } + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 415: components['responses']['preview_header_missing'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description List of repository names that the token should have access to */ - readonly repositories?: readonly string[]; + readonly repositories?: readonly string[] /** * @description List of repository IDs that the token should have access to * @example 1 */ - readonly repository_ids?: readonly number[]; - readonly permissions?: components["schemas"]["app-permissions"]; - }; - }; - }; - }; + readonly repository_ids?: readonly number[] + readonly permissions?: components['schemas']['app-permissions'] + } + } + } + } /** * Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly "apps/suspend-installation": { + readonly 'apps/suspend-installation': { readonly parameters: { readonly path: { /** installation_id parameter */ - readonly installation_id: components["parameters"]["installation-id"]; - }; - }; + readonly installation_id: components['parameters']['installation-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 204: never + readonly 404: components['responses']['not_found'] + } + } /** * Removes a GitHub App installation suspension. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly "apps/unsuspend-installation": { + readonly 'apps/unsuspend-installation': { readonly parameters: { readonly path: { /** installation_id parameter */ - readonly installation_id: components["parameters"]["installation-id"]; - }; - }; + readonly installation_id: components['parameters']['installation-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 204: never + readonly 404: components['responses']['not_found'] + } + } /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * * You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/rest/reference/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `["repo", "user"]`. */ - readonly "oauth-authorizations/list-grants": { + readonly 'oauth-authorizations/list-grants': { readonly parameters: { readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; + readonly page?: components['parameters']['page'] /** The client ID of your GitHub app. */ - readonly client_id?: string; - }; - }; + readonly client_id?: string + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["application-grant"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': readonly components['schemas']['application-grant'][] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - readonly "oauth-authorizations/get-grant": { + readonly 'oauth-authorizations/get-grant': { readonly parameters: { readonly path: { /** grant_id parameter */ - readonly grant_id: components["parameters"]["grant-id"]; - }; - }; + readonly grant_id: components['parameters']['grant-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["application-grant"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - }; - }; + readonly 'application/json': components['schemas']['application-grant'] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + } + } /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ - readonly "oauth-authorizations/delete-grant": { + readonly 'oauth-authorizations/delete-grant': { readonly parameters: { readonly path: { /** grant_id parameter */ - readonly grant_id: components["parameters"]["grant-id"]; - }; - }; + readonly grant_id: components['parameters']['grant-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - }; - }; + readonly 204: never + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + } + } /** * OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ - readonly "apps/delete-authorization": { + readonly 'apps/delete-authorization': { readonly parameters: { readonly path: { /** The client ID of your GitHub app. */ - readonly client_id: components["parameters"]["client-id"]; - }; - }; + readonly client_id: components['parameters']['client-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 204: never + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The OAuth access token used to authenticate to the GitHub API. */ - readonly access_token: string; - }; - }; - }; - }; + readonly access_token: string + } + } + } + } /** OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the OAuth application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`. */ - readonly "apps/check-token": { + readonly 'apps/check-token': { readonly parameters: { readonly path: { /** The client ID of your GitHub app. */ - readonly client_id: components["parameters"]["client-id"]; - }; - }; + readonly client_id: components['parameters']['client-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["authorization"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': components['schemas']['authorization'] + } + } + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The access_token of the OAuth application. */ - readonly access_token: string; - }; - }; - }; - }; + readonly access_token: string + } + } + } + } /** OAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. */ - readonly "apps/delete-token": { + readonly 'apps/delete-token': { readonly parameters: { readonly path: { /** The client ID of your GitHub app. */ - readonly client_id: components["parameters"]["client-id"]; - }; - }; + readonly client_id: components['parameters']['client-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 204: never + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The OAuth access token used to authenticate to the GitHub API. */ - readonly access_token: string; - }; - }; - }; - }; + readonly access_token: string + } + } + } + } /** OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. */ - readonly "apps/reset-token": { + readonly 'apps/reset-token': { readonly parameters: { readonly path: { /** The client ID of your GitHub app. */ - readonly client_id: components["parameters"]["client-id"]; - }; - }; + readonly client_id: components['parameters']['client-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["authorization"]; - }; - }; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': components['schemas']['authorization'] + } + } + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The access_token of the OAuth application. */ - readonly access_token: string; - }; - }; - }; - }; + readonly access_token: string + } + } + } + } /** Use a non-scoped user-to-server OAuth access token to create a repository scoped and/or permission scoped user-to-server OAuth access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. */ - readonly "apps/scope-token": { + readonly 'apps/scope-token': { readonly parameters: { readonly path: { /** The client ID of your GitHub app. */ - readonly client_id: components["parameters"]["client-id"]; - }; - }; + readonly client_id: components['parameters']['client-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["authorization"]; - }; - }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': components['schemas']['authorization'] + } + } + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description The OAuth access token used to authenticate to the GitHub API. * @example e72e16c7e42f292c6912e7710c838347ae178b4a */ - readonly access_token: string; + readonly access_token: string /** * @description The name of the user or organization to scope the user-to-server access token to. **Required** unless `target_id` is specified. * @example octocat */ - readonly target?: string; + readonly target?: string /** * @description The ID of the user or organization to scope the user-to-server access token to. **Required** unless `target` is specified. * @example 1 */ - readonly target_id?: number; + readonly target_id?: number /** @description The list of repository names to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified. */ - readonly repositories?: readonly string[]; + readonly repositories?: readonly string[] /** * @description The list of repository IDs to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified. * @example 1 */ - readonly repository_ids?: readonly number[]; - readonly permissions?: components["schemas"]["app-permissions"]; - }; - }; - }; - }; + readonly repository_ids?: readonly number[] + readonly permissions?: components['schemas']['app-permissions'] + } + } + } + } /** * **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). * * If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ - readonly "apps/get-by-slug": { + readonly 'apps/get-by-slug': { readonly parameters: { readonly path: { - readonly app_slug: components["parameters"]["app-slug"]; - }; - }; + readonly app_slug: components['parameters']['app-slug'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["integration"]; - }; - }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 415: components["responses"]["preview_header_missing"]; - }; - }; + readonly 'application/json': components['schemas']['integration'] + } + } + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 415: components['responses']['preview_header_missing'] + } + } /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - readonly "oauth-authorizations/list-authorizations": { + readonly 'oauth-authorizations/list-authorizations': { readonly parameters: { readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; + readonly page?: components['parameters']['page'] /** The client ID of your GitHub app. */ - readonly client_id?: string; - }; - }; + readonly client_id?: string + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["authorization"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': readonly components['schemas']['authorization'][] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * @@ -18523,49 +18507,49 @@ export interface operations { * * Organizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in [the GitHub Help documentation](https://docs.github.com/articles/about-identity-and-access-management-with-saml-single-sign-on). */ - readonly "oauth-authorizations/create-authorization": { - readonly parameters: {}; + readonly 'oauth-authorizations/create-authorization': { + readonly parameters: {} readonly responses: { /** Response */ readonly 201: { readonly headers: { - readonly Location?: string; - }; - readonly content: { - readonly "application/json": components["schemas"]["authorization"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 410: components["responses"]["gone"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly Location?: string + } + readonly content: { + readonly 'application/json': components['schemas']['authorization'] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 410: components['responses']['gone'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description A list of scopes that this authorization is in. * @example public_repo,user */ - readonly scopes?: readonly string[] | null; + readonly scopes?: readonly string[] | null /** * @description A note to remind you what the OAuth token is for. * @example Update all gems */ - readonly note?: string; + readonly note?: string /** @description A URL to remind you what app the OAuth token is for. */ - readonly note_url?: string; + readonly note_url?: string /** @description The OAuth app client key for which to create the token. */ - readonly client_id?: string; + readonly client_id?: string /** @description The OAuth app client secret for which to create the token. */ - readonly client_secret?: string; + readonly client_secret?: string /** @description A unique string to distinguish an authorization from others created for the same client ID and user. */ - readonly fingerprint?: string; - }; - }; - }; - }; + readonly fingerprint?: string + } + } + } + } /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * @@ -18577,60 +18561,60 @@ export interface operations { * * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - readonly "oauth-authorizations/get-or-create-authorization-for-app": { + readonly 'oauth-authorizations/get-or-create-authorization-for-app': { readonly parameters: { readonly path: { /** The client ID of your GitHub app. */ - readonly client_id: components["parameters"]["client-id"]; - }; - }; + readonly client_id: components['parameters']['client-id'] + } + } readonly responses: { /** if returning an existing token */ readonly 200: { readonly headers: { - readonly Location?: string; - }; + readonly Location?: string + } readonly content: { - readonly "application/json": components["schemas"]["authorization"]; - }; - }; + readonly 'application/json': components['schemas']['authorization'] + } + } /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ readonly 201: { readonly headers: { - readonly Location?: string; - }; - readonly content: { - readonly "application/json": components["schemas"]["authorization"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly Location?: string + } + readonly content: { + readonly 'application/json': components['schemas']['authorization'] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The OAuth app client secret for which to create the token. */ - readonly client_secret: string; + readonly client_secret: string /** * @description A list of scopes that this authorization is in. * @example public_repo,user */ - readonly scopes?: readonly string[] | null; + readonly scopes?: readonly string[] | null /** * @description A note to remind you what the OAuth token is for. * @example Update all gems */ - readonly note?: string; + readonly note?: string /** @description A URL to remind you what app the OAuth token is for. */ - readonly note_url?: string; + readonly note_url?: string /** @description A unique string to distinguish an authorization from others created for the same client ID and user. */ - readonly fingerprint?: string; - }; - }; - }; - }; + readonly fingerprint?: string + } + } + } + } /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * @@ -18640,92 +18624,92 @@ export interface operations { * * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." */ - readonly "oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint": { + readonly 'oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint': { readonly parameters: { readonly path: { /** The client ID of your GitHub app. */ - readonly client_id: components["parameters"]["client-id"]; - readonly fingerprint: string; - }; - }; + readonly client_id: components['parameters']['client-id'] + readonly fingerprint: string + } + } readonly responses: { /** if returning an existing token */ readonly 200: { readonly headers: { - readonly Location?: string; - }; + readonly Location?: string + } readonly content: { - readonly "application/json": components["schemas"]["authorization"]; - }; - }; + readonly 'application/json': components['schemas']['authorization'] + } + } /** Response if returning a new token */ readonly 201: { readonly headers: { - readonly Location?: string; - }; - readonly content: { - readonly "application/json": components["schemas"]["authorization"]; - }; - }; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly Location?: string + } + readonly content: { + readonly 'application/json': components['schemas']['authorization'] + } + } + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The OAuth app client secret for which to create the token. */ - readonly client_secret: string; + readonly client_secret: string /** * @description A list of scopes that this authorization is in. * @example public_repo,user */ - readonly scopes?: readonly string[] | null; + readonly scopes?: readonly string[] | null /** * @description A note to remind you what the OAuth token is for. * @example Update all gems */ - readonly note?: string; + readonly note?: string /** @description A URL to remind you what app the OAuth token is for. */ - readonly note_url?: string; - }; - }; - }; - }; + readonly note_url?: string + } + } + } + } /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - readonly "oauth-authorizations/get-authorization": { + readonly 'oauth-authorizations/get-authorization': { readonly parameters: { readonly path: { /** authorization_id parameter */ - readonly authorization_id: components["parameters"]["authorization-id"]; - }; - }; + readonly authorization_id: components['parameters']['authorization-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["authorization"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - }; - }; + readonly 'application/json': components['schemas']['authorization'] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + } + } /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - readonly "oauth-authorizations/delete-authorization": { + readonly 'oauth-authorizations/delete-authorization': { readonly parameters: { readonly path: { /** authorization_id parameter */ - readonly authorization_id: components["parameters"]["authorization-id"]; - }; - }; + readonly authorization_id: components['parameters']['authorization-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - }; - }; + readonly 204: never + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + } + } /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * @@ -18733,678 +18717,678 @@ export interface operations { * * You can only send one of these scope keys at a time. */ - readonly "oauth-authorizations/update-authorization": { + readonly 'oauth-authorizations/update-authorization': { readonly parameters: { readonly path: { /** authorization_id parameter */ - readonly authorization_id: components["parameters"]["authorization-id"]; - }; - }; + readonly authorization_id: components['parameters']['authorization-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["authorization"]; - }; - }; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': components['schemas']['authorization'] + } + } + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description A list of scopes that this authorization is in. * @example public_repo,user */ - readonly scopes?: readonly string[] | null; + readonly scopes?: readonly string[] | null /** @description A list of scopes to add to this authorization. */ - readonly add_scopes?: readonly string[]; + readonly add_scopes?: readonly string[] /** @description A list of scopes to remove from this authorization. */ - readonly remove_scopes?: readonly string[]; + readonly remove_scopes?: readonly string[] /** * @description A note to remind you what the OAuth token is for. * @example Update all gems */ - readonly note?: string; + readonly note?: string /** @description A URL to remind you what app the OAuth token is for. */ - readonly note_url?: string; + readonly note_url?: string /** @description A unique string to distinguish an authorization from others created for the same client ID and user. */ - readonly fingerprint?: string; - }; - }; - }; - }; - readonly "codes-of-conduct/get-all-codes-of-conduct": { - readonly parameters: {}; + readonly fingerprint?: string + } + } + } + } + readonly 'codes-of-conduct/get-all-codes-of-conduct': { + readonly parameters: {} readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["code-of-conduct"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - }; - }; - readonly "codes-of-conduct/get-conduct-code": { + readonly 'application/json': readonly components['schemas']['code-of-conduct'][] + } + } + readonly 304: components['responses']['not_modified'] + } + } + readonly 'codes-of-conduct/get-conduct-code': { readonly parameters: { readonly path: { - readonly key: string; - }; - }; + readonly key: string + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["code-of-conduct"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': components['schemas']['code-of-conduct'] + } + } + readonly 304: components['responses']['not_modified'] + readonly 404: components['responses']['not_found'] + } + } /** Lists all the emojis available to use on GitHub. */ - readonly "emojis/get": { - readonly parameters: {}; + readonly 'emojis/get': { + readonly parameters: {} readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": { readonly [key: string]: string }; - }; - }; - readonly 304: components["responses"]["not_modified"]; - }; - }; + readonly 'application/json': { readonly [key: string]: string } + } + } + readonly 304: components['responses']['not_modified'] + } + } /** * Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - readonly "enterprise-admin/get-github-actions-permissions-enterprise": { + readonly 'enterprise-admin/get-github-actions-permissions-enterprise': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; - }; - }; + readonly enterprise: components['parameters']['enterprise'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["actions-enterprise-permissions"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['actions-enterprise-permissions'] + } + } + } + } /** * Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - readonly "enterprise-admin/set-github-actions-permissions-enterprise": { + readonly 'enterprise-admin/set-github-actions-permissions-enterprise': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; - }; - }; + readonly enterprise: components['parameters']['enterprise'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; + readonly 204: never + } readonly requestBody: { readonly content: { - readonly "application/json": { - readonly enabled_organizations: components["schemas"]["enabled-organizations"]; - readonly allowed_actions?: components["schemas"]["allowed-actions"]; - }; - }; - }; - }; + readonly 'application/json': { + readonly enabled_organizations: components['schemas']['enabled-organizations'] + readonly allowed_actions?: components['schemas']['allowed-actions'] + } + } + } + } /** * Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - readonly "enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise": { + readonly 'enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; - }; + readonly enterprise: components['parameters']['enterprise'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": { - readonly total_count: number; - readonly organizations: readonly components["schemas"]["organization-simple"][]; - }; - }; - }; - }; - }; + readonly 'application/json': { + readonly total_count: number + readonly organizations: readonly components['schemas']['organization-simple'][] + } + } + } + } + } /** * Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - readonly "enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise": { + readonly 'enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; - }; - }; + readonly enterprise: components['parameters']['enterprise'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; + readonly 204: never + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description List of organization IDs to enable for GitHub Actions. */ - readonly selected_organization_ids: readonly number[]; - }; - }; - }; - }; + readonly selected_organization_ids: readonly number[] + } + } + } + } /** * Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - readonly "enterprise-admin/enable-selected-organization-github-actions-enterprise": { + readonly 'enterprise-admin/enable-selected-organization-github-actions-enterprise': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; + readonly enterprise: components['parameters']['enterprise'] /** Unique identifier of an organization. */ - readonly org_id: components["parameters"]["org-id"]; - }; - }; + readonly org_id: components['parameters']['org-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** * Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - readonly "enterprise-admin/disable-selected-organization-github-actions-enterprise": { + readonly 'enterprise-admin/disable-selected-organization-github-actions-enterprise': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; + readonly enterprise: components['parameters']['enterprise'] /** Unique identifier of an organization. */ - readonly org_id: components["parameters"]["org-id"]; - }; - }; + readonly org_id: components['parameters']['org-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** * Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - readonly "enterprise-admin/get-allowed-actions-enterprise": { + readonly 'enterprise-admin/get-allowed-actions-enterprise': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; - }; - }; + readonly enterprise: components['parameters']['enterprise'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["selected-actions"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['selected-actions'] + } + } + } + } /** * Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - readonly "enterprise-admin/set-allowed-actions-enterprise": { + readonly 'enterprise-admin/set-allowed-actions-enterprise': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; - }; - }; + readonly enterprise: components['parameters']['enterprise'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; + readonly 204: never + } readonly requestBody: { readonly content: { - readonly "application/json": components["schemas"]["selected-actions"]; - }; - }; - }; + readonly 'application/json': components['schemas']['selected-actions'] + } + } + } /** * Lists all self-hosted runner groups for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - readonly "enterprise-admin/list-self-hosted-runner-groups-for-enterprise": { + readonly 'enterprise-admin/list-self-hosted-runner-groups-for-enterprise': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; - }; + readonly enterprise: components['parameters']['enterprise'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": { - readonly total_count: number; - readonly runner_groups: readonly components["schemas"]["runner-groups-enterprise"][]; - }; - }; - }; - }; - }; + readonly 'application/json': { + readonly total_count: number + readonly runner_groups: readonly components['schemas']['runner-groups-enterprise'][] + } + } + } + } + } /** * Creates a new self-hosted runner group for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - readonly "enterprise-admin/create-self-hosted-runner-group-for-enterprise": { + readonly 'enterprise-admin/create-self-hosted-runner-group-for-enterprise': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; - }; - }; + readonly enterprise: components['parameters']['enterprise'] + } + } readonly responses: { /** Response */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["runner-groups-enterprise"]; - }; - }; - }; + readonly 'application/json': components['schemas']['runner-groups-enterprise'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Name of the runner group. */ - readonly name: string; + readonly name: string /** * @description Visibility of a runner group. You can select all organizations or select individual organization. Can be one of: `all` or `selected` * @enum {string} */ - readonly visibility?: "selected" | "all"; + readonly visibility?: 'selected' | 'all' /** @description List of organization IDs that can access the runner group. */ - readonly selected_organization_ids?: readonly number[]; + readonly selected_organization_ids?: readonly number[] /** @description List of runner IDs to add to the runner group. */ - readonly runners?: readonly number[]; + readonly runners?: readonly number[] /** @description Whether the runner group can be used by `public` repositories. */ - readonly allows_public_repositories?: boolean; - }; - }; - }; - }; + readonly allows_public_repositories?: boolean + } + } + } + } /** * Gets a specific self-hosted runner group for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - readonly "enterprise-admin/get-self-hosted-runner-group-for-enterprise": { + readonly 'enterprise-admin/get-self-hosted-runner-group-for-enterprise': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; + readonly enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - readonly runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + readonly runner_group_id: components['parameters']['runner-group-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["runner-groups-enterprise"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['runner-groups-enterprise'] + } + } + } + } /** * Deletes a self-hosted runner group for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - readonly "enterprise-admin/delete-self-hosted-runner-group-from-enterprise": { + readonly 'enterprise-admin/delete-self-hosted-runner-group-from-enterprise': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; + readonly enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - readonly runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + readonly runner_group_id: components['parameters']['runner-group-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** * Updates the `name` and `visibility` of a self-hosted runner group in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - readonly "enterprise-admin/update-self-hosted-runner-group-for-enterprise": { + readonly 'enterprise-admin/update-self-hosted-runner-group-for-enterprise': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; + readonly enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - readonly runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + readonly runner_group_id: components['parameters']['runner-group-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["runner-groups-enterprise"]; - }; - }; - }; + readonly 'application/json': components['schemas']['runner-groups-enterprise'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Name of the runner group. */ - readonly name?: string; + readonly name?: string /** * @description Visibility of a runner group. You can select all organizations or select individual organizations. Can be one of: `all` or `selected` * @default all * @enum {string} */ - readonly visibility?: "selected" | "all"; + readonly visibility?: 'selected' | 'all' /** @description Whether the runner group can be used by `public` repositories. */ - readonly allows_public_repositories?: boolean; - }; - }; - }; - }; + readonly allows_public_repositories?: boolean + } + } + } + } /** * Lists the organizations with access to a self-hosted runner group. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - readonly "enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise": { + readonly 'enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; + readonly enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - readonly runner_group_id: components["parameters"]["runner-group-id"]; - }; + readonly runner_group_id: components['parameters']['runner-group-id'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": { - readonly total_count: number; - readonly organizations: readonly components["schemas"]["organization-simple"][]; - }; - }; - }; - }; - }; + readonly 'application/json': { + readonly total_count: number + readonly organizations: readonly components['schemas']['organization-simple'][] + } + } + } + } + } /** * Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - readonly "enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise": { + readonly 'enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; + readonly enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - readonly runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + readonly runner_group_id: components['parameters']['runner-group-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; + readonly 204: never + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description List of organization IDs that can access the runner group. */ - readonly selected_organization_ids: readonly number[]; - }; - }; - }; - }; + readonly selected_organization_ids: readonly number[] + } + } + } + } /** * Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - readonly "enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise": { + readonly 'enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; + readonly enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - readonly runner_group_id: components["parameters"]["runner-group-id"]; + readonly runner_group_id: components['parameters']['runner-group-id'] /** Unique identifier of an organization. */ - readonly org_id: components["parameters"]["org-id"]; - }; - }; + readonly org_id: components['parameters']['org-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** * Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - readonly "enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise": { + readonly 'enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; + readonly enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - readonly runner_group_id: components["parameters"]["runner-group-id"]; + readonly runner_group_id: components['parameters']['runner-group-id'] /** Unique identifier of an organization. */ - readonly org_id: components["parameters"]["org-id"]; - }; - }; + readonly org_id: components['parameters']['org-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** * Lists the self-hosted runners that are in a specific enterprise group. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - readonly "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise": { + readonly 'enterprise-admin/list-self-hosted-runners-in-group-for-enterprise': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; + readonly enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - readonly runner_group_id: components["parameters"]["runner-group-id"]; - }; + readonly runner_group_id: components['parameters']['runner-group-id'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": { - readonly total_count: number; - readonly runners: readonly components["schemas"]["runner"][]; - }; - }; - }; - }; - }; + readonly 'application/json': { + readonly total_count: number + readonly runners: readonly components['schemas']['runner'][] + } + } + } + } + } /** * Replaces the list of self-hosted runners that are part of an enterprise runner group. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - readonly "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise": { + readonly 'enterprise-admin/set-self-hosted-runners-in-group-for-enterprise': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; + readonly enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - readonly runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + readonly runner_group_id: components['parameters']['runner-group-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; + readonly 204: never + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description List of runner IDs to add to the runner group. */ - readonly runners: readonly number[]; - }; - }; - }; - }; + readonly runners: readonly number[] + } + } + } + } /** * Adds a self-hosted runner to a runner group configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` * scope to use this endpoint. */ - readonly "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise": { + readonly 'enterprise-admin/add-self-hosted-runner-to-group-for-enterprise': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; + readonly enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - readonly runner_group_id: components["parameters"]["runner-group-id"]; + readonly runner_group_id: components['parameters']['runner-group-id'] /** Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; - }; - }; + readonly runner_id: components['parameters']['runner-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** * Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - readonly "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise": { + readonly 'enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; + readonly enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - readonly runner_group_id: components["parameters"]["runner-group-id"]; + readonly runner_group_id: components['parameters']['runner-group-id'] /** Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; - }; - }; + readonly runner_id: components['parameters']['runner-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** * Lists all self-hosted runners configured for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - readonly "enterprise-admin/list-self-hosted-runners-for-enterprise": { + readonly 'enterprise-admin/list-self-hosted-runners-for-enterprise': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; - }; + readonly enterprise: components['parameters']['enterprise'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": { - readonly total_count?: number; - readonly runners?: readonly components["schemas"]["runner"][]; - }; - }; - }; - }; - }; + readonly 'application/json': { + readonly total_count?: number + readonly runners?: readonly components['schemas']['runner'][] + } + } + } + } + } /** * Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - readonly "enterprise-admin/list-runner-applications-for-enterprise": { + readonly 'enterprise-admin/list-runner-applications-for-enterprise': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; - }; - }; + readonly enterprise: components['parameters']['enterprise'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["runner-application"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['runner-application'][] + } + } + } + } /** * Returns a token that you can pass to the `config` script. The token expires after one hour. * @@ -19418,22 +19402,22 @@ export interface operations { * ./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN * ``` */ - readonly "enterprise-admin/create-registration-token-for-enterprise": { + readonly 'enterprise-admin/create-registration-token-for-enterprise': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; - }; - }; + readonly enterprise: components['parameters']['enterprise'] + } + } readonly responses: { /** Response */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["authentication-token"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['authentication-token'] + } + } + } + } /** * Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour. * @@ -19448,161 +19432,161 @@ export interface operations { * ./config.sh remove --token TOKEN * ``` */ - readonly "enterprise-admin/create-remove-token-for-enterprise": { + readonly 'enterprise-admin/create-remove-token-for-enterprise': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; - }; - }; + readonly enterprise: components['parameters']['enterprise'] + } + } readonly responses: { /** Response */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["authentication-token"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['authentication-token'] + } + } + } + } /** * Gets a specific self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - readonly "enterprise-admin/get-self-hosted-runner-for-enterprise": { + readonly 'enterprise-admin/get-self-hosted-runner-for-enterprise': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; + readonly enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; - }; - }; + readonly runner_id: components['parameters']['runner-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["runner"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['runner'] + } + } + } + } /** * Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - readonly "enterprise-admin/delete-self-hosted-runner-from-enterprise": { + readonly 'enterprise-admin/delete-self-hosted-runner-from-enterprise': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; + readonly enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; - }; - }; + readonly runner_id: components['parameters']['runner-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** * Lists all labels for a self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - readonly "enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise": { + readonly 'enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; + readonly enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; - }; - }; + readonly runner_id: components['parameters']['runner-id'] + } + } readonly responses: { - readonly 200: components["responses"]["actions_runner_labels"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 200: components['responses']['actions_runner_labels'] + readonly 404: components['responses']['not_found'] + } + } /** * Remove all previous custom labels and set the new custom labels for a specific * self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - readonly "enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise": { + readonly 'enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; + readonly enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; - }; - }; - readonly responses: { - readonly 200: components["responses"]["actions_runner_labels"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; - }; + readonly runner_id: components['parameters']['runner-id'] + } + } + readonly responses: { + readonly 200: components['responses']['actions_runner_labels'] + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed_simple'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels. */ - readonly labels: readonly string[]; - }; - }; - }; - }; + readonly labels: readonly string[] + } + } + } + } /** * Add custom labels to a self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - readonly "enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise": { + readonly 'enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; + readonly enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; - }; - }; - readonly responses: { - readonly 200: components["responses"]["actions_runner_labels"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; - }; + readonly runner_id: components['parameters']['runner-id'] + } + } + readonly responses: { + readonly 200: components['responses']['actions_runner_labels'] + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed_simple'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The names of the custom labels to add to the runner. */ - readonly labels: readonly string[]; - }; - }; - }; - }; + readonly labels: readonly string[] + } + } + } + } /** * Remove all custom labels from a self-hosted runner configured in an * enterprise. Returns the remaining read-only labels from the runner. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - readonly "enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise": { + readonly 'enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; + readonly enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; - }; - }; + readonly runner_id: components['parameters']['runner-id'] + } + } readonly responses: { - readonly 200: components["responses"]["actions_runner_labels_readonly"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; - }; - }; + readonly 200: components['responses']['actions_runner_labels_readonly'] + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed_simple'] + } + } /** * Remove a custom label from a self-hosted runner configured * in an enterprise. Returns the remaining labels from the runner. @@ -19612,33 +19596,33 @@ export interface operations { * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - readonly "enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise": { + readonly 'enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; + readonly enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; + readonly runner_id: components['parameters']['runner-id'] /** The name of a self-hosted runner's custom label. */ - readonly name: components["parameters"]["runner-label-name"]; - }; - }; - readonly responses: { - readonly 200: components["responses"]["actions_runner_labels"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; - }; - }; + readonly name: components['parameters']['runner-label-name'] + } + } + readonly responses: { + readonly 200: components['responses']['actions_runner_labels'] + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed_simple'] + } + } /** Gets the audit log for an enterprise. To use this endpoint, you must be an enterprise admin, and you must use an access token with the `admin:enterprise` scope. */ - readonly "enterprise-admin/get-audit-log": { + readonly 'enterprise-admin/get-audit-log': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; - }; + readonly enterprise: components['parameters']['enterprise'] + } readonly query: { /** A search phrase. For more information, see [Searching the audit log](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). */ - readonly phrase?: components["parameters"]["audit-log-phrase"]; + readonly phrase?: components['parameters']['audit-log-phrase'] /** * The event types to include: * @@ -19648,73 +19632,73 @@ export interface operations { * * The default is `web`. */ - readonly include?: components["parameters"]["audit-log-include"]; + readonly include?: components['parameters']['audit-log-include'] /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor. */ - readonly after?: components["parameters"]["audit-log-after"]; + readonly after?: components['parameters']['audit-log-after'] /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor. */ - readonly before?: components["parameters"]["audit-log-before"]; + readonly before?: components['parameters']['audit-log-before'] /** * The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. * * The default is `desc`. */ - readonly order?: components["parameters"]["audit-log-order"]; + readonly order?: components['parameters']['audit-log-order'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; + readonly page?: components['parameters']['page'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; - }; - }; + readonly per_page?: components['parameters']['per-page'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["audit-log-event"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['audit-log-event'][] + } + } + } + } /** * Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. * To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). */ - readonly "secret-scanning/list-alerts-for-enterprise": { + readonly 'secret-scanning/list-alerts-for-enterprise': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; - }; + readonly enterprise: components['parameters']['enterprise'] + } readonly query: { /** Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - readonly state?: components["parameters"]["secret-scanning-alert-state"]; + readonly state?: components['parameters']['secret-scanning-alert-state'] /** * A comma-separated list of secret types to return. By default all secret types are returned. * See "[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)" * for a complete list of secret types (API slug). */ - readonly secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; + readonly secret_type?: components['parameters']['secret-scanning-alert-secret-type'] /** A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - readonly resolution?: components["parameters"]["secret-scanning-alert-resolution"]; + readonly resolution?: components['parameters']['secret-scanning-alert-resolution'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor. */ - readonly before?: components["parameters"]["pagination-before"]; + readonly before?: components['parameters']['pagination-before'] /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor. */ - readonly after?: components["parameters"]["pagination-after"]; - }; - }; + readonly after?: components['parameters']['pagination-after'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["organization-secret-scanning-alert"][]; - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; - }; - }; + readonly 'application/json': readonly components['schemas']['organization-secret-scanning-alert'][] + } + } + readonly 404: components['responses']['not_found'] + readonly 503: components['responses']['service_unavailable'] + } + } /** * Gets the summary of the free and paid GitHub Actions minutes used. * @@ -19722,49 +19706,49 @@ export interface operations { * * The authenticated user must be an enterprise admin. */ - readonly "billing/get-github-actions-billing-ghe": { + readonly 'billing/get-github-actions-billing-ghe': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; - }; - }; + readonly enterprise: components['parameters']['enterprise'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["actions-billing-usage"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['actions-billing-usage'] + } + } + } + } /** * Gets the GitHub Advanced Security active committers for an enterprise per repository. * Each distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of active_users for each repository. */ - readonly "billing/get-github-advanced-security-billing-ghe": { + readonly 'billing/get-github-advanced-security-billing-ghe': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; - }; + readonly enterprise: components['parameters']['enterprise'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Success */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["advanced-security-active-committers"]; - }; - }; - readonly 403: components["responses"]["code_scanning_forbidden_read"]; - }; - }; + readonly 'application/json': components['schemas']['advanced-security-active-committers'] + } + } + readonly 403: components['responses']['code_scanning_forbidden_read'] + } + } /** * Gets the free and paid storage used for GitHub Packages in gigabytes. * @@ -19772,22 +19756,22 @@ export interface operations { * * The authenticated user must be an enterprise admin. */ - readonly "billing/get-github-packages-billing-ghe": { + readonly 'billing/get-github-packages-billing-ghe': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; - }; - }; + readonly enterprise: components['parameters']['enterprise'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["packages-billing-usage"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['packages-billing-usage'] + } + } + } + } /** * Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. * @@ -19795,44 +19779,44 @@ export interface operations { * * The authenticated user must be an enterprise admin. */ - readonly "billing/get-shared-storage-billing-ghe": { + readonly 'billing/get-shared-storage-billing-ghe': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; - }; - }; + readonly enterprise: components['parameters']['enterprise'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["combined-billing-usage"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['combined-billing-usage'] + } + } + } + } /** We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. */ - readonly "activity/list-public-events": { + readonly 'activity/list-public-events': { readonly parameters: { readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["event"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 503: components["responses"]["service_unavailable"]; - }; - }; + readonly 'application/json': readonly components['schemas']['event'][] + } + } + readonly 304: components['responses']['not_modified'] + readonly 403: components['responses']['forbidden'] + readonly 503: components['responses']['service_unavailable'] + } + } /** * GitHub provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user: * @@ -19846,71 +19830,71 @@ export interface operations { * * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ - readonly "activity/get-feeds": { - readonly parameters: {}; + readonly 'activity/get-feeds': { + readonly parameters: {} readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["feed"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['feed'] + } + } + } + } /** Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists: */ - readonly "gists/list": { + readonly 'gists/list': { readonly parameters: { readonly query: { /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; + readonly since?: components['parameters']['since'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["base-gist"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - }; - }; + readonly 'application/json': readonly components['schemas']['base-gist'][] + } + } + readonly 304: components['responses']['not_modified'] + readonly 403: components['responses']['forbidden'] + } + } /** * Allows you to add a new gist with one or more files. * * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. */ - readonly "gists/create": { - readonly parameters: {}; + readonly 'gists/create': { + readonly parameters: {} readonly responses: { /** Response */ readonly 201: { readonly headers: { - readonly Location?: string; - }; - readonly content: { - readonly "application/json": components["schemas"]["gist-simple"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly Location?: string + } + readonly content: { + readonly 'application/json': components['schemas']['gist-simple'] + } + } + readonly 304: components['responses']['not_modified'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description Description of the gist * @example Example Ruby script */ - readonly description?: string; + readonly description?: string /** * @description Names and content for the files that make up the gist * @example [object Object] @@ -19918,478 +19902,478 @@ export interface operations { readonly files: { readonly [key: string]: { /** @description Content of the file */ - readonly content: string; - }; - }; - readonly public?: boolean | ("true" | "false"); - }; - }; - }; - }; + readonly content: string + } + } + readonly public?: boolean | ('true' | 'false') + } + } + } + } /** * List public gists sorted by most recently updated to least recently updated. * * Note: With [pagination](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. */ - readonly "gists/list-public": { + readonly 'gists/list-public': { readonly parameters: { readonly query: { /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; + readonly since?: components['parameters']['since'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["base-gist"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; + readonly 'application/json': readonly components['schemas']['base-gist'][] + } + } + readonly 304: components['responses']['not_modified'] + readonly 403: components['responses']['forbidden'] + readonly 422: components['responses']['validation_failed'] + } + } /** List the authenticated user's starred gists: */ - readonly "gists/list-starred": { + readonly 'gists/list-starred': { readonly parameters: { readonly query: { /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; + readonly since?: components['parameters']['since'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["base-gist"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - }; - }; - readonly "gists/get": { + readonly 'application/json': readonly components['schemas']['base-gist'][] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + } + } + readonly 'gists/get': { readonly parameters: { readonly path: { /** gist_id parameter */ - readonly gist_id: components["parameters"]["gist-id"]; - }; - }; + readonly gist_id: components['parameters']['gist-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["gist-simple"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden_gist"]; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "gists/delete": { + readonly 'application/json': components['schemas']['gist-simple'] + } + } + readonly 304: components['responses']['not_modified'] + readonly 403: components['responses']['forbidden_gist'] + readonly 404: components['responses']['not_found'] + } + } + readonly 'gists/delete': { readonly parameters: { readonly path: { /** gist_id parameter */ - readonly gist_id: components["parameters"]["gist-id"]; - }; - }; + readonly gist_id: components['parameters']['gist-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 204: never + readonly 304: components['responses']['not_modified'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } /** Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged. */ - readonly "gists/update": { + readonly 'gists/update': { readonly parameters: { readonly path: { /** gist_id parameter */ - readonly gist_id: components["parameters"]["gist-id"]; - }; - }; + readonly gist_id: components['parameters']['gist-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["gist-simple"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': components['schemas']['gist-simple'] + } + } + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description Description of the gist * @example Example Ruby script */ - readonly description?: string; + readonly description?: string /** * @description Names of files to be updated * @example [object Object] */ - readonly files?: { readonly [key: string]: Partial<{ readonly [key: string]: unknown }> }; - } | null; - }; - }; - }; - readonly "gists/list-comments": { + readonly files?: { readonly [key: string]: Partial<{ readonly [key: string]: unknown }> } + } | null + } + } + } + readonly 'gists/list-comments': { readonly parameters: { readonly path: { /** gist_id parameter */ - readonly gist_id: components["parameters"]["gist-id"]; - }; + readonly gist_id: components['parameters']['gist-id'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["gist-comment"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "gists/create-comment": { + readonly 'application/json': readonly components['schemas']['gist-comment'][] + } + } + readonly 304: components['responses']['not_modified'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } + readonly 'gists/create-comment': { readonly parameters: { readonly path: { /** gist_id parameter */ - readonly gist_id: components["parameters"]["gist-id"]; - }; - }; + readonly gist_id: components['parameters']['gist-id'] + } + } readonly responses: { /** Response */ readonly 201: { readonly headers: { - readonly Location?: string; - }; - readonly content: { - readonly "application/json": components["schemas"]["gist-comment"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; + readonly Location?: string + } + readonly content: { + readonly 'application/json': components['schemas']['gist-comment'] + } + } + readonly 304: components['responses']['not_modified'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description The comment text. * @example Body of the attachment */ - readonly body: string; - }; - }; - }; - }; - readonly "gists/get-comment": { + readonly body: string + } + } + } + } + readonly 'gists/get-comment': { readonly parameters: { readonly path: { /** gist_id parameter */ - readonly gist_id: components["parameters"]["gist-id"]; + readonly gist_id: components['parameters']['gist-id'] /** comment_id parameter */ - readonly comment_id: components["parameters"]["comment-id"]; - }; - }; + readonly comment_id: components['parameters']['comment-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["gist-comment"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden_gist"]; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "gists/delete-comment": { + readonly 'application/json': components['schemas']['gist-comment'] + } + } + readonly 304: components['responses']['not_modified'] + readonly 403: components['responses']['forbidden_gist'] + readonly 404: components['responses']['not_found'] + } + } + readonly 'gists/delete-comment': { readonly parameters: { readonly path: { /** gist_id parameter */ - readonly gist_id: components["parameters"]["gist-id"]; + readonly gist_id: components['parameters']['gist-id'] /** comment_id parameter */ - readonly comment_id: components["parameters"]["comment-id"]; - }; - }; + readonly comment_id: components['parameters']['comment-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "gists/update-comment": { + readonly 204: never + readonly 304: components['responses']['not_modified'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } + readonly 'gists/update-comment': { readonly parameters: { readonly path: { /** gist_id parameter */ - readonly gist_id: components["parameters"]["gist-id"]; + readonly gist_id: components['parameters']['gist-id'] /** comment_id parameter */ - readonly comment_id: components["parameters"]["comment-id"]; - }; - }; + readonly comment_id: components['parameters']['comment-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["gist-comment"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; + readonly 'application/json': components['schemas']['gist-comment'] + } + } + readonly 404: components['responses']['not_found'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description The comment text. * @example Body of the attachment */ - readonly body: string; - }; - }; - }; - }; - readonly "gists/list-commits": { + readonly body: string + } + } + } + } + readonly 'gists/list-commits': { readonly parameters: { readonly path: { /** gist_id parameter */ - readonly gist_id: components["parameters"]["gist-id"]; - }; + readonly gist_id: components['parameters']['gist-id'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { readonly headers: { - readonly Link?: string; - }; + readonly Link?: string + } readonly content: { - readonly "application/json": readonly components["schemas"]["gist-commit"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "gists/list-forks": { + readonly 'application/json': readonly components['schemas']['gist-commit'][] + } + } + readonly 304: components['responses']['not_modified'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } + readonly 'gists/list-forks': { readonly parameters: { readonly path: { /** gist_id parameter */ - readonly gist_id: components["parameters"]["gist-id"]; - }; + readonly gist_id: components['parameters']['gist-id'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["gist-simple"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': readonly components['schemas']['gist-simple'][] + } + } + readonly 304: components['responses']['not_modified'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } /** **Note**: This was previously `/gists/:gist_id/fork`. */ - readonly "gists/fork": { + readonly 'gists/fork': { readonly parameters: { readonly path: { /** gist_id parameter */ - readonly gist_id: components["parameters"]["gist-id"]; - }; - }; + readonly gist_id: components['parameters']['gist-id'] + } + } readonly responses: { /** Response */ readonly 201: { readonly headers: { - readonly Location?: string; - }; + readonly Location?: string + } readonly content: { - readonly "application/json": components["schemas"]["base-gist"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; - readonly "gists/check-is-starred": { + readonly 'application/json': components['schemas']['base-gist'] + } + } + readonly 304: components['responses']['not_modified'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } + } + readonly 'gists/check-is-starred': { readonly parameters: { readonly path: { /** gist_id parameter */ - readonly gist_id: components["parameters"]["gist-id"]; - }; - }; + readonly gist_id: components['parameters']['gist-id'] + } + } readonly responses: { /** Response if gist is starred */ - readonly 204: never; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; + readonly 204: never + readonly 304: components['responses']['not_modified'] + readonly 403: components['responses']['forbidden'] /** Not Found if gist is not starred */ readonly 404: { readonly content: { - readonly "application/json": { readonly [key: string]: unknown }; - }; - }; - }; - }; + readonly 'application/json': { readonly [key: string]: unknown } + } + } + } + } /** Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - readonly "gists/star": { + readonly 'gists/star': { readonly parameters: { readonly path: { /** gist_id parameter */ - readonly gist_id: components["parameters"]["gist-id"]; - }; - }; + readonly gist_id: components['parameters']['gist-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "gists/unstar": { + readonly 204: never + readonly 304: components['responses']['not_modified'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } + readonly 'gists/unstar': { readonly parameters: { readonly path: { /** gist_id parameter */ - readonly gist_id: components["parameters"]["gist-id"]; - }; - }; + readonly gist_id: components['parameters']['gist-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "gists/get-revision": { + readonly 204: never + readonly 304: components['responses']['not_modified'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } + readonly 'gists/get-revision': { readonly parameters: { readonly path: { /** gist_id parameter */ - readonly gist_id: components["parameters"]["gist-id"]; - readonly sha: string; - }; - }; + readonly gist_id: components['parameters']['gist-id'] + readonly sha: string + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["gist-simple"]; - }; - }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; + readonly 'application/json': components['schemas']['gist-simple'] + } + } + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } + } /** List all templates available to pass as an option when [creating a repository](https://docs.github.com/rest/reference/repos#create-a-repository-for-the-authenticated-user). */ - readonly "gitignore/get-all-templates": { - readonly parameters: {}; + readonly 'gitignore/get-all-templates': { + readonly parameters: {} readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly string[]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - }; - }; + readonly 'application/json': readonly string[] + } + } + readonly 304: components['responses']['not_modified'] + } + } /** * The API also allows fetching the source of a single template. * Use the raw [media type](https://docs.github.com/rest/overview/media-types/) to get the raw contents. */ - readonly "gitignore/get-template": { + readonly 'gitignore/get-template': { readonly parameters: { readonly path: { - readonly name: string; - }; - }; + readonly name: string + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["gitignore-template"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - }; - }; + readonly 'application/json': components['schemas']['gitignore-template'] + } + } + readonly 304: components['responses']['not_modified'] + } + } /** * List repositories that an app installation can access. * * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ - readonly "apps/list-repos-accessible-to-installation": { + readonly 'apps/list-repos-accessible-to-installation': { readonly parameters: { readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": { - readonly total_count: number; - readonly repositories: readonly components["schemas"]["repository"][]; + readonly 'application/json': { + readonly total_count: number + readonly repositories: readonly components['schemas']['repository'][] /** @example selected */ - readonly repository_selection?: string; - }; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - }; - }; + readonly repository_selection?: string + } + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + } + } /** * Revokes the installation token you're using to authenticate as an installation and access this endpoint. * @@ -20397,13 +20381,13 @@ export interface operations { * * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ - readonly "apps/revoke-installation-access-token": { - readonly parameters: {}; + readonly 'apps/revoke-installation-access-token': { + readonly parameters: {} readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** * List issues assigned to the authenticated user across all visible repositories including owned repositories, member * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not @@ -20415,7 +20399,7 @@ export interface operations { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - readonly "issues/list": { + readonly 'issues/list': { readonly parameters: { readonly query: { /** @@ -20426,465 +20410,465 @@ export interface operations { * \* `subscribed`: Issues you're subscribed to updates for * \* `all` or `repos`: All issues the authenticated user can see, regardless of participation or creation */ - readonly filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all"; + readonly filter?: 'assigned' | 'created' | 'mentioned' | 'subscribed' | 'repos' | 'all' /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ - readonly state?: "open" | "closed" | "all"; + readonly state?: 'open' | 'closed' | 'all' /** A list of comma separated label names. Example: `bug,ui,@high` */ - readonly labels?: components["parameters"]["labels"]; + readonly labels?: components['parameters']['labels'] /** What to sort results by. Can be either `created`, `updated`, `comments`. */ - readonly sort?: "created" | "updated" | "comments"; + readonly sort?: 'created' | 'updated' | 'comments' /** One of `asc` (ascending) or `desc` (descending). */ - readonly direction?: components["parameters"]["direction"]; + readonly direction?: components['parameters']['direction'] /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; - readonly collab?: boolean; - readonly orgs?: boolean; - readonly owned?: boolean; - readonly pulls?: boolean; + readonly since?: components['parameters']['since'] + readonly collab?: boolean + readonly orgs?: boolean + readonly owned?: boolean + readonly pulls?: boolean /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["issue"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; - readonly "licenses/get-all-commonly-used": { + readonly 'application/json': readonly components['schemas']['issue'][] + } + } + readonly 304: components['responses']['not_modified'] + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } + } + readonly 'licenses/get-all-commonly-used': { readonly parameters: { readonly query: { - readonly featured?: boolean; + readonly featured?: boolean /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["license-simple"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - }; - }; - readonly "licenses/get": { + readonly 'application/json': readonly components['schemas']['license-simple'][] + } + } + readonly 304: components['responses']['not_modified'] + } + } + readonly 'licenses/get': { readonly parameters: { readonly path: { - readonly license: string; - }; - }; + readonly license: string + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["license"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "markdown/render": { - readonly parameters: {}; + readonly 'application/json': components['schemas']['license'] + } + } + readonly 304: components['responses']['not_modified'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } + readonly 'markdown/render': { + readonly parameters: {} readonly responses: { /** Response */ readonly 200: { readonly headers: { - readonly "Content-Length"?: string; - }; - readonly content: { - readonly "text/html": string; - }; - }; - readonly 304: components["responses"]["not_modified"]; - }; + readonly 'Content-Length'?: string + } + readonly content: { + readonly 'text/html': string + } + } + readonly 304: components['responses']['not_modified'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The Markdown text to render in HTML. */ - readonly text: string; + readonly text: string /** * @description The rendering mode. Can be either `markdown` or `gfm`. * @default markdown * @example markdown * @enum {string} */ - readonly mode?: "markdown" | "gfm"; + readonly mode?: 'markdown' | 'gfm' /** @description The repository context to use when creating references in `gfm` mode. For example, setting `context` to `octo-org/octo-repo` will change the text `#42` into an HTML link to issue 42 in the `octo-org/octo-repo` repository. */ - readonly context?: string; - }; - }; - }; - }; + readonly context?: string + } + } + } + } /** You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less. */ - readonly "markdown/render-raw": { - readonly parameters: {}; + readonly 'markdown/render-raw': { + readonly parameters: {} readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "text/html": string; - }; - }; - readonly 304: components["responses"]["not_modified"]; - }; + readonly 'text/html': string + } + } + readonly 304: components['responses']['not_modified'] + } readonly requestBody: { readonly content: { - readonly "text/plain": string; - readonly "text/x-markdown": string; - }; - }; - }; + readonly 'text/plain': string + readonly 'text/x-markdown': string + } + } + } /** * Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - readonly "apps/get-subscription-plan-for-account": { + readonly 'apps/get-subscription-plan-for-account': { readonly parameters: { readonly path: { /** account_id parameter */ - readonly account_id: components["parameters"]["account-id"]; - }; - }; + readonly account_id: components['parameters']['account-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["marketplace-purchase"]; - }; - }; - readonly 401: components["responses"]["requires_authentication"]; + readonly 'application/json': components['schemas']['marketplace-purchase'] + } + } + readonly 401: components['responses']['requires_authentication'] /** Not Found when the account has not purchased the listing */ readonly 404: { readonly content: { - readonly "application/json": components["schemas"]["basic-error"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['basic-error'] + } + } + } + } /** * Lists all plans that are part of your GitHub Marketplace listing. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - readonly "apps/list-plans": { + readonly 'apps/list-plans': { readonly parameters: { readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["marketplace-listing-plan"][]; - }; - }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': readonly components['schemas']['marketplace-listing-plan'][] + } + } + readonly 401: components['responses']['requires_authentication'] + readonly 404: components['responses']['not_found'] + } + } /** * Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - readonly "apps/list-accounts-for-plan": { + readonly 'apps/list-accounts-for-plan': { readonly parameters: { readonly path: { /** plan_id parameter */ - readonly plan_id: components["parameters"]["plan-id"]; - }; + readonly plan_id: components['parameters']['plan-id'] + } readonly query: { /** One of `created` (when the repository was starred) or `updated` (when it was last pushed to). */ - readonly sort?: components["parameters"]["sort"]; + readonly sort?: components['parameters']['sort'] /** To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter. */ - readonly direction?: "asc" | "desc"; + readonly direction?: 'asc' | 'desc' /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["marketplace-purchase"][]; - }; - }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; + readonly 'application/json': readonly components['schemas']['marketplace-purchase'][] + } + } + readonly 401: components['responses']['requires_authentication'] + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } + } /** * Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - readonly "apps/get-subscription-plan-for-account-stubbed": { + readonly 'apps/get-subscription-plan-for-account-stubbed': { readonly parameters: { readonly path: { /** account_id parameter */ - readonly account_id: components["parameters"]["account-id"]; - }; - }; + readonly account_id: components['parameters']['account-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["marketplace-purchase"]; - }; - }; - readonly 401: components["responses"]["requires_authentication"]; + readonly 'application/json': components['schemas']['marketplace-purchase'] + } + } + readonly 401: components['responses']['requires_authentication'] /** Not Found when the account has not purchased the listing */ - readonly 404: unknown; - }; - }; + readonly 404: unknown + } + } /** * Lists all plans that are part of your GitHub Marketplace listing. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - readonly "apps/list-plans-stubbed": { + readonly 'apps/list-plans-stubbed': { readonly parameters: { readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["marketplace-listing-plan"][]; - }; - }; - readonly 401: components["responses"]["requires_authentication"]; - }; - }; + readonly 'application/json': readonly components['schemas']['marketplace-listing-plan'][] + } + } + readonly 401: components['responses']['requires_authentication'] + } + } /** * Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - readonly "apps/list-accounts-for-plan-stubbed": { + readonly 'apps/list-accounts-for-plan-stubbed': { readonly parameters: { readonly path: { /** plan_id parameter */ - readonly plan_id: components["parameters"]["plan-id"]; - }; + readonly plan_id: components['parameters']['plan-id'] + } readonly query: { /** One of `created` (when the repository was starred) or `updated` (when it was last pushed to). */ - readonly sort?: components["parameters"]["sort"]; + readonly sort?: components['parameters']['sort'] /** To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter. */ - readonly direction?: "asc" | "desc"; + readonly direction?: 'asc' | 'desc' /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["marketplace-purchase"][]; - }; - }; - readonly 401: components["responses"]["requires_authentication"]; - }; - }; + readonly 'application/json': readonly components['schemas']['marketplace-purchase'][] + } + } + readonly 401: components['responses']['requires_authentication'] + } + } /** * Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://docs.github.com/articles/about-github-s-ip-addresses/)." * * **Note:** The IP addresses shown in the documentation's response are only example values. You must always query the API directly to get the latest list of IP addresses. */ - readonly "meta/get": { - readonly parameters: {}; + readonly 'meta/get': { + readonly parameters: {} readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["api-overview"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - }; - }; - readonly "activity/list-public-events-for-repo-network": { + readonly 'application/json': components['schemas']['api-overview'] + } + } + readonly 304: components['responses']['not_modified'] + } + } + readonly 'activity/list-public-events-for-repo-network': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["event"][]; - }; - }; - readonly 301: components["responses"]["moved_permanently"]; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': readonly components['schemas']['event'][] + } + } + readonly 301: components['responses']['moved_permanently'] + readonly 304: components['responses']['not_modified'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } /** List all notifications for the current user, sorted by most recently updated. */ - readonly "activity/list-notifications-for-authenticated-user": { + readonly 'activity/list-notifications-for-authenticated-user': { readonly parameters: { readonly query: { /** If `true`, show notifications marked as read. */ - readonly all?: components["parameters"]["all"]; + readonly all?: components['parameters']['all'] /** If `true`, only shows notifications in which the user is directly participating or mentioned. */ - readonly participating?: components["parameters"]["participating"]; + readonly participating?: components['parameters']['participating'] /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; + readonly since?: components['parameters']['since'] /** Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly before?: components["parameters"]["before"]; + readonly before?: components['parameters']['before'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["thread"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; + readonly 'application/json': readonly components['schemas']['thread'][] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 422: components['responses']['validation_failed'] + } + } /** Marks all notifications as "read" removes it from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ - readonly "activity/mark-notifications-as-read": { - readonly parameters: {}; + readonly 'activity/mark-notifications-as-read': { + readonly parameters: {} readonly responses: { /** Response */ readonly 202: { readonly content: { - readonly "application/json": { - readonly message?: string; - }; - }; - }; + readonly 'application/json': { + readonly message?: string + } + } + } /** Reset Content */ - readonly 205: unknown; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - }; + readonly 205: unknown + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * Format: date-time * @description Describes the last point that notifications were checked. */ - readonly last_read_at?: string; + readonly last_read_at?: string /** @description Whether the notification has been read. */ - readonly read?: boolean; - }; - }; - }; - }; - readonly "activity/get-thread": { + readonly read?: boolean + } + } + } + } + readonly 'activity/get-thread': { readonly parameters: { readonly path: { /** thread_id parameter */ - readonly thread_id: components["parameters"]["thread-id"]; - }; - }; + readonly thread_id: components['parameters']['thread-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["thread"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - }; - }; - readonly "activity/mark-thread-as-read": { + readonly 'application/json': components['schemas']['thread'] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + } + } + readonly 'activity/mark-thread-as-read': { readonly parameters: { readonly path: { /** thread_id parameter */ - readonly thread_id: components["parameters"]["thread-id"]; - }; - }; + readonly thread_id: components['parameters']['thread-id'] + } + } readonly responses: { /** Reset Content */ - readonly 205: unknown; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - }; - }; + readonly 205: unknown + readonly 304: components['responses']['not_modified'] + readonly 403: components['responses']['forbidden'] + } + } /** * This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/rest/reference/activity#get-a-repository-subscription). * * Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. */ - readonly "activity/get-thread-subscription-for-authenticated-user": { + readonly 'activity/get-thread-subscription-for-authenticated-user': { readonly parameters: { readonly path: { /** thread_id parameter */ - readonly thread_id: components["parameters"]["thread-id"]; - }; - }; + readonly thread_id: components['parameters']['thread-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["thread-subscription"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - }; - }; + readonly 'application/json': components['schemas']['thread-subscription'] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + } + } /** * If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**. * @@ -20892,213 +20876,211 @@ export interface operations { * * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/rest/reference/activity#delete-a-thread-subscription) endpoint. */ - readonly "activity/set-thread-subscription": { + readonly 'activity/set-thread-subscription': { readonly parameters: { readonly path: { /** thread_id parameter */ - readonly thread_id: components["parameters"]["thread-id"]; - }; - }; + readonly thread_id: components['parameters']['thread-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["thread-subscription"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - }; + readonly 'application/json': components['schemas']['thread-subscription'] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Whether to block all notifications from a thread. */ - readonly ignored?: boolean; - }; - }; - }; - }; + readonly ignored?: boolean + } + } + } + } /** Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/rest/reference/activity#set-a-thread-subscription) endpoint and set `ignore` to `true`. */ - readonly "activity/delete-thread-subscription": { + readonly 'activity/delete-thread-subscription': { readonly parameters: { readonly path: { /** thread_id parameter */ - readonly thread_id: components["parameters"]["thread-id"]; - }; - }; + readonly thread_id: components['parameters']['thread-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - }; - }; + readonly 204: never + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + } + } /** Get the octocat as ASCII art */ - readonly "meta/get-octocat": { + readonly 'meta/get-octocat': { readonly parameters: { readonly query: { /** The words to show in Octocat's speech bubble */ - readonly s?: string; - }; - }; + readonly s?: string + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/octocat-stream": string; - }; - }; - }; - }; + readonly 'application/octocat-stream': string + } + } + } + } /** * Lists all organizations, in the order that they were created on GitHub. * * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of organizations. */ - readonly "orgs/list": { + readonly 'orgs/list': { readonly parameters: { readonly query: { /** An organization ID. Only return organizations with an ID greater than this ID. */ - readonly since?: components["parameters"]["since-org"]; + readonly since?: components['parameters']['since-org'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; - }; - }; + readonly per_page?: components['parameters']['per-page'] + } + } readonly responses: { /** Response */ readonly 200: { readonly headers: { - readonly Link?: string; - }; + readonly Link?: string + } readonly content: { - readonly "application/json": readonly components["schemas"]["organization-simple"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - }; - }; + readonly 'application/json': readonly components['schemas']['organization-simple'][] + } + } + readonly 304: components['responses']['not_modified'] + } + } /** * List the custom repository roles available in this organization. In order to see custom * repository roles in an organization, the authenticated user must be an organization owner. * * For more information on custom repository roles, see "[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)". */ - readonly "orgs/list-custom-roles": { + readonly 'orgs/list-custom-roles': { readonly parameters: { readonly path: { - readonly organization_id: string; - }; - }; + readonly organization_id: string + } + } readonly responses: { /** Response - list of custom role names */ readonly 200: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description The number of custom roles in this organization * @example 3 */ - readonly total_count?: number; - readonly custom_roles?: readonly components["schemas"]["organization-custom-repository-role"][]; - }; - }; - }; - }; - }; + readonly total_count?: number + readonly custom_roles?: readonly components['schemas']['organization-custom-repository-role'][] + } + } + } + } + } /** * Lists a connection between a team and an external group. * * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ - readonly "teams/list-linked-external-idp-groups-to-team-for-org": { + readonly 'teams/list-linked-external-idp-groups-to-team-for-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** team_slug parameter */ - readonly team_slug: components["parameters"]["team-slug"]; - }; - }; + readonly team_slug: components['parameters']['team-slug'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["external-groups"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['external-groups'] + } + } + } + } /** * To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). * * GitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub plan. See "[Authenticating with GitHub Apps](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/)" for details. For an example response, see 'Response with GitHub plan information' below." */ - readonly "orgs/get": { + readonly 'orgs/get': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; - }; + readonly org: components['parameters']['org'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["organization-full"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': components['schemas']['organization-full'] + } + } + readonly 404: components['responses']['not_found'] + } + } /** * **Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). * * Enables an authenticated organization owner with the `admin:org` scope to update the organization's profile and member privileges. */ - readonly "orgs/update": { + readonly 'orgs/update': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; - }; + readonly org: components['parameters']['org'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["organization-full"]; - }; - }; - readonly 409: components["responses"]["conflict"]; + readonly 'application/json': components['schemas']['organization-full'] + } + } + readonly 409: components['responses']['conflict'] /** Validation failed */ readonly 422: { readonly content: { - readonly "application/json": - | components["schemas"]["validation-error"] - | components["schemas"]["validation-error-simple"]; - }; - }; - }; + readonly 'application/json': components['schemas']['validation-error'] | components['schemas']['validation-error-simple'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Billing email address. This address is not publicized. */ - readonly billing_email?: string; + readonly billing_email?: string /** @description The company name. */ - readonly company?: string; + readonly company?: string /** @description The publicly visible email address. */ - readonly email?: string; + readonly email?: string /** @description The Twitter username of the company. */ - readonly twitter_username?: string; + readonly twitter_username?: string /** @description The location. */ - readonly location?: string; + readonly location?: string /** @description The shorthand name of the company. */ - readonly name?: string; + readonly name?: string /** @description The description of the company. */ - readonly description?: string; + readonly description?: string /** @description Toggles whether an organization can use organization projects. */ - readonly has_organization_projects?: boolean; + readonly has_organization_projects?: boolean /** @description Toggles whether repositories that belong to the organization can use repository projects. */ - readonly has_repository_projects?: boolean; + readonly has_repository_projects?: boolean /** * @description Default permission level members have for organization repositories: * \* `read` - can pull, but not push to or administer this repository. @@ -21108,7 +21090,7 @@ export interface operations { * @default read * @enum {string} */ - readonly default_repository_permission?: "read" | "write" | "admin" | "none"; + readonly default_repository_permission?: 'read' | 'write' | 'admin' | 'none' /** * @description Toggles the ability of non-admin organization members to create repositories. Can be one of: * \* `true` - all organization members can create repositories. @@ -21117,28 +21099,28 @@ export interface operations { * **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. * @default true */ - readonly members_can_create_repositories?: boolean; + readonly members_can_create_repositories?: boolean /** * @description Toggles whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. Can be one of: * \* `true` - all organization members can create internal repositories. * \* `false` - only organization owners can create internal repositories. * Default: `true`. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */ - readonly members_can_create_internal_repositories?: boolean; + readonly members_can_create_internal_repositories?: boolean /** * @description Toggles whether organization members can create private repositories, which are visible to organization members with permission. Can be one of: * \* `true` - all organization members can create private repositories. * \* `false` - only organization owners can create private repositories. * Default: `true`. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */ - readonly members_can_create_private_repositories?: boolean; + readonly members_can_create_private_repositories?: boolean /** * @description Toggles whether organization members can create public repositories, which are visible to anyone. Can be one of: * \* `true` - all organization members can create public repositories. * \* `false` - only organization owners can create public repositories. * Default: `true`. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */ - readonly members_can_create_public_repositories?: boolean; + readonly members_can_create_public_repositories?: boolean /** * @description Specifies which types of repositories non-admin organization members can create. Can be one of: * \* `all` - all organization members can create public and private repositories. @@ -21147,60 +21129,60 @@ export interface operations { * **Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details. * @enum {string} */ - readonly members_allowed_repository_creation_type?: "all" | "private" | "none"; + readonly members_allowed_repository_creation_type?: 'all' | 'private' | 'none' /** * @description Toggles whether organization members can create GitHub Pages sites. Can be one of: * \* `true` - all organization members can create GitHub Pages sites. * \* `false` - no organization members can create GitHub Pages sites. Existing published sites will not be impacted. * @default true */ - readonly members_can_create_pages?: boolean; + readonly members_can_create_pages?: boolean /** * @description Toggles whether organization members can create public GitHub Pages sites. Can be one of: * \* `true` - all organization members can create public GitHub Pages sites. * \* `false` - no organization members can create public GitHub Pages sites. Existing published sites will not be impacted. * @default true */ - readonly members_can_create_public_pages?: boolean; + readonly members_can_create_public_pages?: boolean /** * @description Toggles whether organization members can create private GitHub Pages sites. Can be one of: * \* `true` - all organization members can create private GitHub Pages sites. * \* `false` - no organization members can create private GitHub Pages sites. Existing published sites will not be impacted. * @default true */ - readonly members_can_create_private_pages?: boolean; + readonly members_can_create_private_pages?: boolean /** * @description Toggles whether organization members can fork private organization repositories. Can be one of: * \* `true` - all organization members can fork private repositories within the organization. * \* `false` - no organization members can fork private repositories within the organization. */ - readonly members_can_fork_private_repositories?: boolean; + readonly members_can_fork_private_repositories?: boolean /** @example "http://github.blog" */ - readonly blog?: string; - }; - }; - }; - }; + readonly blog?: string + } + } + } + } /** * Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - readonly "actions/get-github-actions-permissions-organization": { + readonly 'actions/get-github-actions-permissions-organization': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; - }; + readonly org: components['parameters']['org'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["actions-organization-permissions"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['actions-organization-permissions'] + } + } + } + } /** * Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization. * @@ -21208,132 +21190,132 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - readonly "actions/set-github-actions-permissions-organization": { + readonly 'actions/set-github-actions-permissions-organization': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; - }; + readonly org: components['parameters']['org'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; + readonly 204: never + } readonly requestBody: { readonly content: { - readonly "application/json": { - readonly enabled_repositories: components["schemas"]["enabled-repositories"]; - readonly allowed_actions?: components["schemas"]["allowed-actions"]; - }; - }; - }; - }; + readonly 'application/json': { + readonly enabled_repositories: components['schemas']['enabled-repositories'] + readonly allowed_actions?: components['schemas']['allowed-actions'] + } + } + } + } /** * Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - readonly "actions/list-selected-repositories-enabled-github-actions-organization": { + readonly 'actions/list-selected-repositories-enabled-github-actions-organization': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; + readonly org: components['parameters']['org'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": { - readonly total_count: number; - readonly repositories: readonly components["schemas"]["repository"][]; - }; - }; - }; - }; - }; + readonly 'application/json': { + readonly total_count: number + readonly repositories: readonly components['schemas']['repository'][] + } + } + } + } + } /** * Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - readonly "actions/set-selected-repositories-enabled-github-actions-organization": { + readonly 'actions/set-selected-repositories-enabled-github-actions-organization': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; - }; + readonly org: components['parameters']['org'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; + readonly 204: never + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description List of repository IDs to enable for GitHub Actions. */ - readonly selected_repository_ids: readonly number[]; - }; - }; - }; - }; + readonly selected_repository_ids: readonly number[] + } + } + } + } /** * Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - readonly "actions/enable-selected-repository-github-actions-organization": { + readonly 'actions/enable-selected-repository-github-actions-organization': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - readonly repository_id: components["parameters"]["repository-id"]; - }; - }; + readonly org: components['parameters']['org'] + readonly repository_id: components['parameters']['repository-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** * Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - readonly "actions/disable-selected-repository-github-actions-organization": { + readonly 'actions/disable-selected-repository-github-actions-organization': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - readonly repository_id: components["parameters"]["repository-id"]; - }; - }; + readonly org: components['parameters']['org'] + readonly repository_id: components['parameters']['repository-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** * Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."" * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - readonly "actions/get-allowed-actions-organization": { + readonly 'actions/get-allowed-actions-organization': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; - }; + readonly org: components['parameters']['org'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["selected-actions"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['selected-actions'] + } + } + } + } /** * Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * @@ -21343,65 +21325,65 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - readonly "actions/set-allowed-actions-organization": { + readonly 'actions/set-allowed-actions-organization': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; - }; + readonly org: components['parameters']['org'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; + readonly 204: never + } readonly requestBody: { readonly content: { - readonly "application/json": components["schemas"]["selected-actions"]; - }; - }; - }; + readonly 'application/json': components['schemas']['selected-actions'] + } + } + } /** * Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, * as well if GitHub Actions can submit approving pull request reviews. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - readonly "actions/get-github-actions-default-workflow-permissions-organization": { + readonly 'actions/get-github-actions-default-workflow-permissions-organization': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; - }; + readonly org: components['parameters']['org'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["actions-get-default-workflow-permissions"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['actions-get-default-workflow-permissions'] + } + } + } + } /** * Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions * can submit approving pull request reviews. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - readonly "actions/set-github-actions-default-workflow-permissions-organization": { + readonly 'actions/set-github-actions-default-workflow-permissions-organization': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; - }; + readonly org: components['parameters']['org'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; + readonly 204: never + } readonly requestBody: { readonly content: { - readonly "application/json": components["schemas"]["actions-set-default-workflow-permissions"]; - }; - }; - }; + readonly 'application/json': components['schemas']['actions-set-default-workflow-permissions'] + } + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21409,30 +21391,30 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - readonly "actions/list-self-hosted-runner-groups-for-org": { + readonly 'actions/list-self-hosted-runner-groups-for-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; + readonly org: components['parameters']['org'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": { - readonly total_count: number; - readonly runner_groups: readonly components["schemas"]["runner-groups-org"][]; - }; - }; - }; - }; - }; + readonly 'application/json': { + readonly total_count: number + readonly runner_groups: readonly components['schemas']['runner-groups-org'][] + } + } + } + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21440,41 +21422,41 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - readonly "actions/create-self-hosted-runner-group-for-org": { + readonly 'actions/create-self-hosted-runner-group-for-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; - }; + readonly org: components['parameters']['org'] + } + } readonly responses: { /** Response */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["runner-groups-org"]; - }; - }; - }; + readonly 'application/json': components['schemas']['runner-groups-org'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Name of the runner group. */ - readonly name: string; + readonly name: string /** * @description Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories. Can be one of: `all`, `selected`, or `private`. * @default all * @enum {string} */ - readonly visibility?: "selected" | "all" | "private"; + readonly visibility?: 'selected' | 'all' | 'private' /** @description List of repository IDs that can access the runner group. */ - readonly selected_repository_ids?: readonly number[]; + readonly selected_repository_ids?: readonly number[] /** @description List of runner IDs to add to the runner group. */ - readonly runners?: readonly number[]; + readonly runners?: readonly number[] /** @description Whether the runner group can be used by `public` repositories. */ - readonly allows_public_repositories?: boolean; - }; - }; - }; - }; + readonly allows_public_repositories?: boolean + } + } + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21482,23 +21464,23 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - readonly "actions/get-self-hosted-runner-group-for-org": { + readonly 'actions/get-self-hosted-runner-group-for-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - readonly runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + readonly runner_group_id: components['parameters']['runner-group-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["runner-groups-org"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['runner-groups-org'] + } + } + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21506,19 +21488,19 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - readonly "actions/delete-self-hosted-runner-group-from-org": { + readonly 'actions/delete-self-hosted-runner-group-from-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - readonly runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + readonly runner_group_id: components['parameters']['runner-group-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21526,38 +21508,38 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - readonly "actions/update-self-hosted-runner-group-for-org": { + readonly 'actions/update-self-hosted-runner-group-for-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - readonly runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + readonly runner_group_id: components['parameters']['runner-group-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["runner-groups-org"]; - }; - }; - }; + readonly 'application/json': components['schemas']['runner-groups-org'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Name of the runner group. */ - readonly name: string; + readonly name: string /** * @description Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories. Can be one of: `all`, `selected`, or `private`. * @enum {string} */ - readonly visibility?: "selected" | "all" | "private"; + readonly visibility?: 'selected' | 'all' | 'private' /** @description Whether the runner group can be used by `public` repositories. */ - readonly allows_public_repositories?: boolean; - }; - }; - }; - }; + readonly allows_public_repositories?: boolean + } + } + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21565,32 +21547,32 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - readonly "actions/list-repo-access-to-self-hosted-runner-group-in-org": { + readonly 'actions/list-repo-access-to-self-hosted-runner-group-in-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - readonly runner_group_id: components["parameters"]["runner-group-id"]; - }; + readonly runner_group_id: components['parameters']['runner-group-id'] + } readonly query: { /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; + readonly page?: components['parameters']['page'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; - }; - }; + readonly per_page?: components['parameters']['per-page'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": { - readonly total_count: number; - readonly repositories: readonly components["schemas"]["minimal-repository"][]; - }; - }; - }; - }; - }; + readonly 'application/json': { + readonly total_count: number + readonly repositories: readonly components['schemas']['minimal-repository'][] + } + } + } + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21598,27 +21580,27 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - readonly "actions/set-repo-access-to-self-hosted-runner-group-in-org": { + readonly 'actions/set-repo-access-to-self-hosted-runner-group-in-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - readonly runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + readonly runner_group_id: components['parameters']['runner-group-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; + readonly 204: never + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description List of repository IDs that can access the runner group. */ - readonly selected_repository_ids: readonly number[]; - }; - }; - }; - }; + readonly selected_repository_ids: readonly number[] + } + } + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21628,20 +21610,20 @@ export interface operations { * You must authenticate using an access token with the `admin:org` * scope to use this endpoint. */ - readonly "actions/add-repo-access-to-self-hosted-runner-group-in-org": { + readonly 'actions/add-repo-access-to-self-hosted-runner-group-in-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - readonly runner_group_id: components["parameters"]["runner-group-id"]; - readonly repository_id: components["parameters"]["repository-id"]; - }; - }; + readonly runner_group_id: components['parameters']['runner-group-id'] + readonly repository_id: components['parameters']['repository-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21650,20 +21632,20 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - readonly "actions/remove-repo-access-to-self-hosted-runner-group-in-org": { + readonly 'actions/remove-repo-access-to-self-hosted-runner-group-in-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - readonly runner_group_id: components["parameters"]["runner-group-id"]; - readonly repository_id: components["parameters"]["repository-id"]; - }; - }; + readonly runner_group_id: components['parameters']['runner-group-id'] + readonly repository_id: components['parameters']['repository-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21671,33 +21653,33 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - readonly "actions/list-self-hosted-runners-in-group-for-org": { + readonly 'actions/list-self-hosted-runners-in-group-for-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - readonly runner_group_id: components["parameters"]["runner-group-id"]; - }; + readonly runner_group_id: components['parameters']['runner-group-id'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": { - readonly total_count: number; - readonly runners: readonly components["schemas"]["runner"][]; - }; - }; - }; - }; - }; + readonly 'application/json': { + readonly total_count: number + readonly runners: readonly components['schemas']['runner'][] + } + } + } + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21705,27 +21687,27 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - readonly "actions/set-self-hosted-runners-in-group-for-org": { + readonly 'actions/set-self-hosted-runners-in-group-for-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - readonly runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + readonly runner_group_id: components['parameters']['runner-group-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; + readonly 204: never + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description List of runner IDs to add to the runner group. */ - readonly runners: readonly number[]; - }; - }; - }; - }; + readonly runners: readonly number[] + } + } + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21735,21 +21717,21 @@ export interface operations { * You must authenticate using an access token with the `admin:org` * scope to use this endpoint. */ - readonly "actions/add-self-hosted-runner-to-group-for-org": { + readonly 'actions/add-self-hosted-runner-to-group-for-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - readonly runner_group_id: components["parameters"]["runner-group-id"]; + readonly runner_group_id: components['parameters']['runner-group-id'] /** Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; - }; - }; + readonly runner_id: components['parameters']['runner-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21758,71 +21740,71 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - readonly "actions/remove-self-hosted-runner-from-group-for-org": { + readonly 'actions/remove-self-hosted-runner-from-group-for-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - readonly runner_group_id: components["parameters"]["runner-group-id"]; + readonly runner_group_id: components['parameters']['runner-group-id'] /** Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; - }; - }; + readonly runner_id: components['parameters']['runner-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** * Lists all self-hosted runners configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - readonly "actions/list-self-hosted-runners-for-org": { + readonly 'actions/list-self-hosted-runners-for-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; + readonly org: components['parameters']['org'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": { - readonly total_count: number; - readonly runners: readonly components["schemas"]["runner"][]; - }; - }; - }; - }; - }; + readonly 'application/json': { + readonly total_count: number + readonly runners: readonly components['schemas']['runner'][] + } + } + } + } + } /** * Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - readonly "actions/list-runner-applications-for-org": { + readonly 'actions/list-runner-applications-for-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; - }; + readonly org: components['parameters']['org'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["runner-application"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['runner-application'][] + } + } + } + } /** * Returns a token that you can pass to the `config` script. The token expires after one hour. * @@ -21836,21 +21818,21 @@ export interface operations { * ./config.sh --url https://github.com/octo-org --token TOKEN * ``` */ - readonly "actions/create-registration-token-for-org": { + readonly 'actions/create-registration-token-for-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; - }; + readonly org: components['parameters']['org'] + } + } readonly responses: { /** Response */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["authentication-token"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['authentication-token'] + } + } + } + } /** * Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour. * @@ -21865,153 +21847,153 @@ export interface operations { * ./config.sh remove --token TOKEN * ``` */ - readonly "actions/create-remove-token-for-org": { + readonly 'actions/create-remove-token-for-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; - }; + readonly org: components['parameters']['org'] + } + } readonly responses: { /** Response */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["authentication-token"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['authentication-token'] + } + } + } + } /** * Gets a specific self-hosted runner configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - readonly "actions/get-self-hosted-runner-for-org": { + readonly 'actions/get-self-hosted-runner-for-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; - }; - }; + readonly runner_id: components['parameters']['runner-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["runner"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['runner'] + } + } + } + } /** * Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - readonly "actions/delete-self-hosted-runner-from-org": { + readonly 'actions/delete-self-hosted-runner-from-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; - }; - }; + readonly runner_id: components['parameters']['runner-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** * Lists all labels for a self-hosted runner configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - readonly "actions/list-labels-for-self-hosted-runner-for-org": { + readonly 'actions/list-labels-for-self-hosted-runner-for-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; - }; - }; + readonly runner_id: components['parameters']['runner-id'] + } + } readonly responses: { - readonly 200: components["responses"]["actions_runner_labels"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 200: components['responses']['actions_runner_labels'] + readonly 404: components['responses']['not_found'] + } + } /** * Remove all previous custom labels and set the new custom labels for a specific * self-hosted runner configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - readonly "actions/set-custom-labels-for-self-hosted-runner-for-org": { + readonly 'actions/set-custom-labels-for-self-hosted-runner-for-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; - }; - }; - readonly responses: { - readonly 200: components["responses"]["actions_runner_labels"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; - }; + readonly runner_id: components['parameters']['runner-id'] + } + } + readonly responses: { + readonly 200: components['responses']['actions_runner_labels'] + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed_simple'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels. */ - readonly labels: readonly string[]; - }; - }; - }; - }; + readonly labels: readonly string[] + } + } + } + } /** * Add custom labels to a self-hosted runner configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - readonly "actions/add-custom-labels-to-self-hosted-runner-for-org": { + readonly 'actions/add-custom-labels-to-self-hosted-runner-for-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; - }; - }; - readonly responses: { - readonly 200: components["responses"]["actions_runner_labels"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; - }; + readonly runner_id: components['parameters']['runner-id'] + } + } + readonly responses: { + readonly 200: components['responses']['actions_runner_labels'] + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed_simple'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The names of the custom labels to add to the runner. */ - readonly labels: readonly string[]; - }; - }; - }; - }; + readonly labels: readonly string[] + } + } + } + } /** * Remove all custom labels from a self-hosted runner configured in an * organization. Returns the remaining read-only labels from the runner. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - readonly "actions/remove-all-custom-labels-from-self-hosted-runner-for-org": { + readonly 'actions/remove-all-custom-labels-from-self-hosted-runner-for-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; - }; - }; + readonly runner_id: components['parameters']['runner-id'] + } + } readonly responses: { - readonly 200: components["responses"]["actions_runner_labels_readonly"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 200: components['responses']['actions_runner_labels_readonly'] + readonly 404: components['responses']['not_found'] + } + } /** * Remove a custom label from a self-hosted runner configured * in an organization. Returns the remaining labels from the runner. @@ -22021,82 +22003,82 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - readonly "actions/remove-custom-label-from-self-hosted-runner-for-org": { + readonly 'actions/remove-custom-label-from-self-hosted-runner-for-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; + readonly runner_id: components['parameters']['runner-id'] /** The name of a self-hosted runner's custom label. */ - readonly name: components["parameters"]["runner-label-name"]; - }; - }; - readonly responses: { - readonly 200: components["responses"]["actions_runner_labels"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; - }; - }; + readonly name: components['parameters']['runner-label-name'] + } + } + readonly responses: { + readonly 200: components['responses']['actions_runner_labels'] + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed_simple'] + } + } /** Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - readonly "actions/list-org-secrets": { + readonly 'actions/list-org-secrets': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; + readonly org: components['parameters']['org'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": { - readonly total_count: number; - readonly secrets: readonly components["schemas"]["organization-actions-secret"][]; - }; - }; - }; - }; - }; + readonly 'application/json': { + readonly total_count: number + readonly secrets: readonly components['schemas']['organization-actions-secret'][] + } + } + } + } + } /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - readonly "actions/get-org-public-key": { + readonly 'actions/get-org-public-key': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; - }; + readonly org: components['parameters']['org'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["actions-public-key"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['actions-public-key'] + } + } + } + } /** Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - readonly "actions/get-org-secret": { + readonly 'actions/get-org-secret': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** secret_name parameter */ - readonly secret_name: components["parameters"]["secret-name"]; - }; - }; + readonly secret_name: components['parameters']['secret-name'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["organization-actions-secret"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['organization-actions-secret'] + } + } + } + } /** * Creates or updates an organization secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -22174,31 +22156,31 @@ export interface operations { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - readonly "actions/create-or-update-org-secret": { + readonly 'actions/create-or-update-org-secret': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** secret_name parameter */ - readonly secret_name: components["parameters"]["secret-name"]; - }; - }; + readonly secret_name: components['parameters']['secret-name'] + } + } readonly responses: { /** Response when creating a secret */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["empty-object"]; - }; - }; + readonly 'application/json': components['schemas']['empty-object'] + } + } /** Response when updating a secret */ - readonly 204: never; - }; + readonly 204: never + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/reference/actions#get-an-organization-public-key) endpoint. */ - readonly encrypted_value?: string; + readonly encrypted_value?: string /** @description ID of the key you used to encrypt the secret. */ - readonly key_id?: string; + readonly key_id?: string /** * @description Configures the access that repositories have to the organization secret. Can be one of: * \- `all` - All repositories in an organization can access the secret. @@ -22206,123 +22188,123 @@ export interface operations { * \- `selected` - Only specific repositories can access the secret. * @enum {string} */ - readonly visibility: "all" | "private" | "selected"; + readonly visibility: 'all' | 'private' | 'selected' /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/reference/actions#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/actions#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints. */ - readonly selected_repository_ids?: readonly string[]; - }; - }; - }; - }; + readonly selected_repository_ids?: readonly string[] + } + } + } + } /** Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - readonly "actions/delete-org-secret": { + readonly 'actions/delete-org-secret': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** secret_name parameter */ - readonly secret_name: components["parameters"]["secret-name"]; - }; - }; + readonly secret_name: components['parameters']['secret-name'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - readonly "actions/list-selected-repos-for-org-secret": { + readonly 'actions/list-selected-repos-for-org-secret': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** secret_name parameter */ - readonly secret_name: components["parameters"]["secret-name"]; - }; + readonly secret_name: components['parameters']['secret-name'] + } readonly query: { /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; + readonly page?: components['parameters']['page'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; - }; - }; + readonly per_page?: components['parameters']['per-page'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": { - readonly total_count: number; - readonly repositories: readonly components["schemas"]["minimal-repository"][]; - }; - }; - }; - }; - }; + readonly 'application/json': { + readonly total_count: number + readonly repositories: readonly components['schemas']['minimal-repository'][] + } + } + } + } + } /** Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - readonly "actions/set-selected-repos-for-org-secret": { + readonly 'actions/set-selected-repos-for-org-secret': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** secret_name parameter */ - readonly secret_name: components["parameters"]["secret-name"]; - }; - }; + readonly secret_name: components['parameters']['secret-name'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; + readonly 204: never + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/actions#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints. */ - readonly selected_repository_ids: readonly number[]; - }; - }; - }; - }; + readonly selected_repository_ids: readonly number[] + } + } + } + } /** Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - readonly "actions/add-selected-repo-to-org-secret": { + readonly 'actions/add-selected-repo-to-org-secret': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** secret_name parameter */ - readonly secret_name: components["parameters"]["secret-name"]; - readonly repository_id: number; - }; - }; + readonly secret_name: components['parameters']['secret-name'] + readonly repository_id: number + } + } readonly responses: { /** No Content when repository was added to the selected list */ - readonly 204: never; + readonly 204: never /** Conflict when visibility type is not set to selected */ - readonly 409: unknown; - }; - }; + readonly 409: unknown + } + } /** Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - readonly "actions/remove-selected-repo-from-org-secret": { + readonly 'actions/remove-selected-repo-from-org-secret': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** secret_name parameter */ - readonly secret_name: components["parameters"]["secret-name"]; - readonly repository_id: number; - }; - }; + readonly secret_name: components['parameters']['secret-name'] + readonly repository_id: number + } + } readonly responses: { /** Response when repository was removed from the selected list */ - readonly 204: never; + readonly 204: never /** Conflict when visibility type not set to selected */ - readonly 409: unknown; - }; - }; + readonly 409: unknown + } + } /** * Gets the audit log for an organization. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization)." * * This endpoint is available for organizations on GitHub Enterprise Cloud. To use this endpoint, you must be an organization owner, and you must use an access token with the `admin:org` scope. GitHub Apps must have the `organization_administration` read permission to use this endpoint. */ - readonly "orgs/get-audit-log": { + readonly 'orgs/get-audit-log': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; + readonly org: components['parameters']['org'] + } readonly query: { /** A search phrase. For more information, see [Searching the audit log](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). */ - readonly phrase?: components["parameters"]["audit-log-phrase"]; + readonly phrase?: components['parameters']['audit-log-phrase'] /** * The event types to include: * @@ -22332,90 +22314,90 @@ export interface operations { * * The default is `web`. */ - readonly include?: components["parameters"]["audit-log-include"]; + readonly include?: components['parameters']['audit-log-include'] /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor. */ - readonly after?: components["parameters"]["audit-log-after"]; + readonly after?: components['parameters']['audit-log-after'] /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor. */ - readonly before?: components["parameters"]["audit-log-before"]; + readonly before?: components['parameters']['audit-log-before'] /** * The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. * * The default is `desc`. */ - readonly order?: components["parameters"]["audit-log-order"]; + readonly order?: components['parameters']['audit-log-order'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; - }; - }; + readonly per_page?: components['parameters']['per-page'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["audit-log-event"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['audit-log-event'][] + } + } + } + } /** List the users blocked by an organization. */ - readonly "orgs/list-blocked-users": { + readonly 'orgs/list-blocked-users': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; - }; + readonly org: components['parameters']['org'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; - }; - }; - readonly 415: components["responses"]["preview_header_missing"]; - }; - }; - readonly "orgs/check-blocked-user": { + readonly 'application/json': readonly components['schemas']['simple-user'][] + } + } + readonly 415: components['responses']['preview_header_missing'] + } + } + readonly 'orgs/check-blocked-user': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - readonly username: components["parameters"]["username"]; - }; - }; + readonly org: components['parameters']['org'] + readonly username: components['parameters']['username'] + } + } readonly responses: { /** If the user is blocked: */ - readonly 204: never; + readonly 204: never /** If the user is not blocked: */ readonly 404: { readonly content: { - readonly "application/json": components["schemas"]["basic-error"]; - }; - }; - }; - }; - readonly "orgs/block-user": { + readonly 'application/json': components['schemas']['basic-error'] + } + } + } + } + readonly 'orgs/block-user': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - readonly username: components["parameters"]["username"]; - }; - }; + readonly org: components['parameters']['org'] + readonly username: components['parameters']['username'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 422: components["responses"]["validation_failed"]; - }; - }; - readonly "orgs/unblock-user": { + readonly 204: never + readonly 422: components['responses']['validation_failed'] + } + } + readonly 'orgs/unblock-user': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - readonly username: components["parameters"]["username"]; - }; - }; + readonly org: components['parameters']['org'] + readonly username: components['parameters']['username'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** * Lists all code scanning alerts for the default branch (usually `main` * or `master`) for all eligible repositories in an organization. @@ -22423,147 +22405,147 @@ export interface operations { * * GitHub Apps must have the `security_events` read permission to use this endpoint. */ - readonly "code-scanning/list-alerts-for-org": { + readonly 'code-scanning/list-alerts-for-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; + readonly org: components['parameters']['org'] + } readonly query: { /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor. */ - readonly before?: components["parameters"]["pagination-before"]; + readonly before?: components['parameters']['pagination-before'] /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor. */ - readonly after?: components["parameters"]["pagination-after"]; + readonly after?: components['parameters']['pagination-after'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; + readonly page?: components['parameters']['page'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** One of `asc` (ascending) or `desc` (descending). */ - readonly direction?: components["parameters"]["direction"]; + readonly direction?: components['parameters']['direction'] /** Set to `open`, `closed, `fixed`, or `dismissed` to list code scanning alerts in a specific state. */ - readonly state?: components["schemas"]["code-scanning-alert-state"]; + readonly state?: components['schemas']['code-scanning-alert-state'] /** Can be one of `created`, `updated`. */ - readonly sort?: "created" | "updated"; - }; - }; + readonly sort?: 'created' | 'updated' + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["code-scanning-organization-alert-items"][]; - }; - }; - readonly 403: components["responses"]["code_scanning_forbidden_read"]; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; - }; - }; + readonly 'application/json': readonly components['schemas']['code-scanning-organization-alert-items'][] + } + } + readonly 403: components['responses']['code_scanning_forbidden_read'] + readonly 404: components['responses']['not_found'] + readonly 503: components['responses']['service_unavailable'] + } + } /** * Listing and deleting credential authorizations is available to organizations with GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products). * * An authenticated organization owner with the `read:org` scope can list all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials are either personal access tokens or SSH keys that organization members have authorized for the organization. For more information, see [About authentication with SAML single sign-on](https://docs.github.com/en/articles/about-authentication-with-saml-single-sign-on). */ - readonly "orgs/list-saml-sso-authorizations": { + readonly 'orgs/list-saml-sso-authorizations': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; + readonly org: components['parameters']['org'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page token */ - readonly page?: number; + readonly page?: number /** Limits the list of credentials authorizations for an organization to a specific login */ - readonly login?: string; - }; - }; + readonly login?: string + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["credential-authorization"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['credential-authorization'][] + } + } + } + } /** * Listing and deleting credential authorizations is available to organizations with GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products). * * An authenticated organization owner with the `admin:org` scope can remove a credential authorization for an organization that uses SAML SSO. Once you remove someone's credential authorization, they will need to create a new personal access token or SSH key and authorize it for the organization they want to access. */ - readonly "orgs/remove-saml-sso-authorization": { + readonly 'orgs/remove-saml-sso-authorization': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - readonly credential_id: number; - }; - }; + readonly org: components['parameters']['org'] + readonly credential_id: number + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 204: never + readonly 404: components['responses']['not_found'] + } + } /** Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - readonly "dependabot/list-org-secrets": { + readonly 'dependabot/list-org-secrets': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; + readonly org: components['parameters']['org'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": { - readonly total_count: number; - readonly secrets: readonly components["schemas"]["organization-dependabot-secret"][]; - }; - }; - }; - }; - }; + readonly 'application/json': { + readonly total_count: number + readonly secrets: readonly components['schemas']['organization-dependabot-secret'][] + } + } + } + } + } /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - readonly "dependabot/get-org-public-key": { + readonly 'dependabot/get-org-public-key': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; - }; + readonly org: components['parameters']['org'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["dependabot-public-key"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['dependabot-public-key'] + } + } + } + } /** Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - readonly "dependabot/get-org-secret": { + readonly 'dependabot/get-org-secret': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** secret_name parameter */ - readonly secret_name: components["parameters"]["secret-name"]; - }; - }; + readonly secret_name: components['parameters']['secret-name'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["organization-dependabot-secret"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['organization-dependabot-secret'] + } + } + } + } /** * Creates or updates an organization secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -22641,31 +22623,31 @@ export interface operations { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - readonly "dependabot/create-or-update-org-secret": { + readonly 'dependabot/create-or-update-org-secret': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** secret_name parameter */ - readonly secret_name: components["parameters"]["secret-name"]; - }; - }; + readonly secret_name: components['parameters']['secret-name'] + } + } readonly responses: { /** Response when creating a secret */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["empty-object"]; - }; - }; + readonly 'application/json': components['schemas']['empty-object'] + } + } /** Response when updating a secret */ - readonly 204: never; - }; + readonly 204: never + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/reference/dependabot#get-an-organization-public-key) endpoint. */ - readonly encrypted_value?: string; + readonly encrypted_value?: string /** @description ID of the key you used to encrypt the secret. */ - readonly key_id?: string; + readonly key_id?: string /** * @description Configures the access that repositories have to the organization secret. Can be one of: * \- `all` - All repositories in an organization can access the secret. @@ -22673,631 +22655,630 @@ export interface operations { * \- `selected` - Only specific repositories can access the secret. * @enum {string} */ - readonly visibility: "all" | "private" | "selected"; + readonly visibility: 'all' | 'private' | 'selected' /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/reference/dependabot#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/dependabot#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/dependabot#remove-selected-repository-from-an-organization-secret) endpoints. */ - readonly selected_repository_ids?: readonly string[]; - }; - }; - }; - }; + readonly selected_repository_ids?: readonly string[] + } + } + } + } /** Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - readonly "dependabot/delete-org-secret": { + readonly 'dependabot/delete-org-secret': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** secret_name parameter */ - readonly secret_name: components["parameters"]["secret-name"]; - }; - }; + readonly secret_name: components['parameters']['secret-name'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - readonly "dependabot/list-selected-repos-for-org-secret": { + readonly 'dependabot/list-selected-repos-for-org-secret': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** secret_name parameter */ - readonly secret_name: components["parameters"]["secret-name"]; - }; + readonly secret_name: components['parameters']['secret-name'] + } readonly query: { /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; + readonly page?: components['parameters']['page'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; - }; - }; + readonly per_page?: components['parameters']['per-page'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": { - readonly total_count: number; - readonly repositories: readonly components["schemas"]["minimal-repository"][]; - }; - }; - }; - }; - }; + readonly 'application/json': { + readonly total_count: number + readonly repositories: readonly components['schemas']['minimal-repository'][] + } + } + } + } + } /** Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - readonly "dependabot/set-selected-repos-for-org-secret": { + readonly 'dependabot/set-selected-repos-for-org-secret': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** secret_name parameter */ - readonly secret_name: components["parameters"]["secret-name"]; - }; - }; + readonly secret_name: components['parameters']['secret-name'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; + readonly 204: never + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/dependabot#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/dependabot#remove-selected-repository-from-an-organization-secret) endpoints. */ - readonly selected_repository_ids: readonly number[]; - }; - }; - }; - }; + readonly selected_repository_ids: readonly number[] + } + } + } + } /** Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - readonly "dependabot/add-selected-repo-to-org-secret": { + readonly 'dependabot/add-selected-repo-to-org-secret': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** secret_name parameter */ - readonly secret_name: components["parameters"]["secret-name"]; - readonly repository_id: number; - }; - }; + readonly secret_name: components['parameters']['secret-name'] + readonly repository_id: number + } + } readonly responses: { /** No Content when repository was added to the selected list */ - readonly 204: never; + readonly 204: never /** Conflict when visibility type is not set to selected */ - readonly 409: unknown; - }; - }; + readonly 409: unknown + } + } /** Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - readonly "dependabot/remove-selected-repo-from-org-secret": { + readonly 'dependabot/remove-selected-repo-from-org-secret': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** secret_name parameter */ - readonly secret_name: components["parameters"]["secret-name"]; - readonly repository_id: number; - }; - }; + readonly secret_name: components['parameters']['secret-name'] + readonly repository_id: number + } + } readonly responses: { /** Response when repository was removed from the selected list */ - readonly 204: never; + readonly 204: never /** Conflict when visibility type not set to selected */ - readonly 409: unknown; - }; - }; - readonly "activity/list-public-org-events": { + readonly 409: unknown + } + } + readonly 'activity/list-public-org-events': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; + readonly org: components['parameters']['org'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["event"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['event'][] + } + } + } + } /** * Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to. * * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ - readonly "teams/external-idp-group-info-for-org": { + readonly 'teams/external-idp-group-info-for-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** group_id parameter */ - readonly group_id: components["parameters"]["group-id"]; - }; - }; + readonly group_id: components['parameters']['group-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["external-group"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['external-group'] + } + } + } + } /** * Lists external groups available in an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." * * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ - readonly "teams/list-external-idp-groups-for-org": { + readonly 'teams/list-external-idp-groups-for-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; + readonly org: components['parameters']['org'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page token */ - readonly page?: number; + readonly page?: number /** Limits the list to groups containing the text in the group name */ - readonly display_name?: string; - }; - }; + readonly display_name?: string + } + } readonly responses: { /** Response */ readonly 200: { readonly headers: { - readonly Link?: string; - }; - readonly content: { - readonly "application/json": components["schemas"]["external-groups"]; - }; - }; - }; - }; + readonly Link?: string + } + readonly content: { + readonly 'application/json': components['schemas']['external-groups'] + } + } + } + } /** The return hash contains `failed_at` and `failed_reason` fields which represent the time at which the invitation failed and the reason for the failure. */ - readonly "orgs/list-failed-invitations": { + readonly 'orgs/list-failed-invitations': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; + readonly org: components['parameters']['org'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["organization-invitation"][]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "orgs/list-webhooks": { + readonly 'application/json': readonly components['schemas']['organization-invitation'][] + } + } + readonly 404: components['responses']['not_found'] + } + } + readonly 'orgs/list-webhooks': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; + readonly org: components['parameters']['org'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["org-hook"][]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': readonly components['schemas']['org-hook'][] + } + } + readonly 404: components['responses']['not_found'] + } + } /** Here's how you can create a hook that posts payloads in JSON format: */ - readonly "orgs/create-webhook": { + readonly 'orgs/create-webhook': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; - }; + readonly org: components['parameters']['org'] + } + } readonly responses: { /** Response */ readonly 201: { readonly headers: { - readonly Location?: string; - }; - readonly content: { - readonly "application/json": components["schemas"]["org-hook"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly Location?: string + } + readonly content: { + readonly 'application/json': components['schemas']['org-hook'] + } + } + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Must be passed as "web". */ - readonly name: string; + readonly name: string /** @description Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/orgs#create-hook-config-params). */ readonly config: { - readonly url: components["schemas"]["webhook-config-url"]; - readonly content_type?: components["schemas"]["webhook-config-content-type"]; - readonly secret?: components["schemas"]["webhook-config-secret"]; - readonly insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + readonly url: components['schemas']['webhook-config-url'] + readonly content_type?: components['schemas']['webhook-config-content-type'] + readonly secret?: components['schemas']['webhook-config-secret'] + readonly insecure_ssl?: components['schemas']['webhook-config-insecure-ssl'] /** @example "kdaigle" */ - readonly username?: string; + readonly username?: string /** @example "password" */ - readonly password?: string; - }; + readonly password?: string + } /** * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. * @default push */ - readonly events?: readonly string[]; + readonly events?: readonly string[] /** * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. * @default true */ - readonly active?: boolean; - }; - }; - }; - }; + readonly active?: boolean + } + } + } + } /** Returns a webhook configured in an organization. To get only the webhook `config` properties, see "[Get a webhook configuration for an organization](/rest/reference/orgs#get-a-webhook-configuration-for-an-organization)." */ - readonly "orgs/get-webhook": { + readonly 'orgs/get-webhook': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - readonly hook_id: components["parameters"]["hook-id"]; - }; - }; + readonly org: components['parameters']['org'] + readonly hook_id: components['parameters']['hook-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["org-hook"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "orgs/delete-webhook": { + readonly 'application/json': components['schemas']['org-hook'] + } + } + readonly 404: components['responses']['not_found'] + } + } + readonly 'orgs/delete-webhook': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - readonly hook_id: components["parameters"]["hook-id"]; - }; - }; + readonly org: components['parameters']['org'] + readonly hook_id: components['parameters']['hook-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 204: never + readonly 404: components['responses']['not_found'] + } + } /** Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for an organization](/rest/reference/orgs#update-a-webhook-configuration-for-an-organization)." */ - readonly "orgs/update-webhook": { + readonly 'orgs/update-webhook': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - readonly hook_id: components["parameters"]["hook-id"]; - }; - }; + readonly org: components['parameters']['org'] + readonly hook_id: components['parameters']['hook-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["org-hook"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': components['schemas']['org-hook'] + } + } + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/orgs#update-hook-config-params). */ readonly config?: { - readonly url: components["schemas"]["webhook-config-url"]; - readonly content_type?: components["schemas"]["webhook-config-content-type"]; - readonly secret?: components["schemas"]["webhook-config-secret"]; - readonly insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - }; + readonly url: components['schemas']['webhook-config-url'] + readonly content_type?: components['schemas']['webhook-config-content-type'] + readonly secret?: components['schemas']['webhook-config-secret'] + readonly insecure_ssl?: components['schemas']['webhook-config-insecure-ssl'] + } /** * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. * @default push */ - readonly events?: readonly string[]; + readonly events?: readonly string[] /** * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. * @default true */ - readonly active?: boolean; + readonly active?: boolean /** @example "web" */ - readonly name?: string; - }; - }; - }; - }; + readonly name?: string + } + } + } + } /** * Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/reference/orgs#get-an-organization-webhook)." * * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission. */ - readonly "orgs/get-webhook-config-for-org": { + readonly 'orgs/get-webhook-config-for-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - readonly hook_id: components["parameters"]["hook-id"]; - }; - }; + readonly org: components['parameters']['org'] + readonly hook_id: components['parameters']['hook-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["webhook-config"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['webhook-config'] + } + } + } + } /** * Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/reference/orgs#update-an-organization-webhook)." * * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission. */ - readonly "orgs/update-webhook-config-for-org": { + readonly 'orgs/update-webhook-config-for-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - readonly hook_id: components["parameters"]["hook-id"]; - }; - }; + readonly org: components['parameters']['org'] + readonly hook_id: components['parameters']['hook-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["webhook-config"]; - }; - }; - }; + readonly 'application/json': components['schemas']['webhook-config'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { - readonly url?: components["schemas"]["webhook-config-url"]; - readonly content_type?: components["schemas"]["webhook-config-content-type"]; - readonly secret?: components["schemas"]["webhook-config-secret"]; - readonly insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - }; - }; - }; - }; + readonly 'application/json': { + readonly url?: components['schemas']['webhook-config-url'] + readonly content_type?: components['schemas']['webhook-config-content-type'] + readonly secret?: components['schemas']['webhook-config-secret'] + readonly insecure_ssl?: components['schemas']['webhook-config-insecure-ssl'] + } + } + } + } /** Returns a list of webhook deliveries for a webhook configured in an organization. */ - readonly "orgs/list-webhook-deliveries": { + readonly 'orgs/list-webhook-deliveries': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - readonly hook_id: components["parameters"]["hook-id"]; - }; + readonly org: components['parameters']['org'] + readonly hook_id: components['parameters']['hook-id'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ - readonly cursor?: components["parameters"]["cursor"]; - }; - }; + readonly cursor?: components['parameters']['cursor'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["hook-delivery-item"][]; - }; - }; - readonly 400: components["responses"]["bad_request"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; + readonly 'application/json': readonly components['schemas']['hook-delivery-item'][] + } + } + readonly 400: components['responses']['bad_request'] + readonly 422: components['responses']['validation_failed'] + } + } /** Returns a delivery for a webhook configured in an organization. */ - readonly "orgs/get-webhook-delivery": { + readonly 'orgs/get-webhook-delivery': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - readonly hook_id: components["parameters"]["hook-id"]; - readonly delivery_id: components["parameters"]["delivery-id"]; - }; - }; + readonly org: components['parameters']['org'] + readonly hook_id: components['parameters']['hook-id'] + readonly delivery_id: components['parameters']['delivery-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["hook-delivery"]; - }; - }; - readonly 400: components["responses"]["bad_request"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; + readonly 'application/json': components['schemas']['hook-delivery'] + } + } + readonly 400: components['responses']['bad_request'] + readonly 422: components['responses']['validation_failed'] + } + } /** Redeliver a delivery for a webhook configured in an organization. */ - readonly "orgs/redeliver-webhook-delivery": { + readonly 'orgs/redeliver-webhook-delivery': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - readonly hook_id: components["parameters"]["hook-id"]; - readonly delivery_id: components["parameters"]["delivery-id"]; - }; - }; + readonly org: components['parameters']['org'] + readonly hook_id: components['parameters']['hook-id'] + readonly delivery_id: components['parameters']['delivery-id'] + } + } readonly responses: { - readonly 202: components["responses"]["accepted"]; - readonly 400: components["responses"]["bad_request"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; + readonly 202: components['responses']['accepted'] + readonly 400: components['responses']['bad_request'] + readonly 422: components['responses']['validation_failed'] + } + } /** This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. */ - readonly "orgs/ping-webhook": { + readonly 'orgs/ping-webhook': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - readonly hook_id: components["parameters"]["hook-id"]; - }; - }; + readonly org: components['parameters']['org'] + readonly hook_id: components['parameters']['hook-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 204: never + readonly 404: components['responses']['not_found'] + } + } /** * Enables an authenticated GitHub App to find the organization's installation information. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly "apps/get-org-installation": { + readonly 'apps/get-org-installation': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; - }; + readonly org: components['parameters']['org'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["installation"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['installation'] + } + } + } + } /** Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint. */ - readonly "orgs/list-app-installations": { + readonly 'orgs/list-app-installations': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; + readonly org: components['parameters']['org'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": { - readonly total_count: number; - readonly installations: readonly components["schemas"]["installation"][]; - }; - }; - }; - }; - }; + readonly 'application/json': { + readonly total_count: number + readonly installations: readonly components['schemas']['installation'][] + } + } + } + } + } /** Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response. */ - readonly "interactions/get-restrictions-for-org": { + readonly 'interactions/get-restrictions-for-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; - }; + readonly org: components['parameters']['org'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": Partial & - Partial<{ readonly [key: string]: unknown }>; - }; - }; - }; - }; + readonly 'application/json': Partial & Partial<{ readonly [key: string]: unknown }> + } + } + } + } /** Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization. */ - readonly "interactions/set-restrictions-for-org": { + readonly 'interactions/set-restrictions-for-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; - }; + readonly org: components['parameters']['org'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["interaction-limit-response"]; - }; - }; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': components['schemas']['interaction-limit-response'] + } + } + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": components["schemas"]["interaction-limit"]; - }; - }; - }; + readonly 'application/json': components['schemas']['interaction-limit'] + } + } + } /** Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions. */ - readonly "interactions/remove-restrictions-for-org": { + readonly 'interactions/remove-restrictions-for-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; - }; + readonly org: components['parameters']['org'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. */ - readonly "orgs/list-pending-invitations": { + readonly 'orgs/list-pending-invitations': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; + readonly org: components['parameters']['org'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["organization-invitation"][]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': readonly components['schemas']['organization-invitation'][] + } + } + readonly 404: components['responses']['not_found'] + } + } /** * Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - readonly "orgs/create-invitation": { + readonly 'orgs/create-invitation': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; - }; + readonly org: components['parameters']['org'] + } + } readonly responses: { /** Response */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["organization-invitation"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': components['schemas']['organization-invitation'] + } + } + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description **Required unless you provide `email`**. GitHub user ID for the person you are inviting. */ - readonly invitee_id?: number; + readonly invitee_id?: number /** @description **Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user. */ - readonly email?: string; + readonly email?: string /** * @description Specify role for new member. Can be one of: * \* `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. @@ -23306,59 +23287,59 @@ export interface operations { * @default direct_member * @enum {string} */ - readonly role?: "admin" | "direct_member" | "billing_manager"; + readonly role?: 'admin' | 'direct_member' | 'billing_manager' /** @description Specify IDs for the teams you want to invite new members to. */ - readonly team_ids?: readonly number[]; - }; - }; - }; - }; + readonly team_ids?: readonly number[] + } + } + } + } /** * Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). */ - readonly "orgs/cancel-invitation": { + readonly 'orgs/cancel-invitation': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** invitation_id parameter */ - readonly invitation_id: components["parameters"]["invitation-id"]; - }; - }; + readonly invitation_id: components['parameters']['invitation-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; + readonly 204: never + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } + } /** List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner. */ - readonly "orgs/list-invitation-teams": { + readonly 'orgs/list-invitation-teams': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** invitation_id parameter */ - readonly invitation_id: components["parameters"]["invitation-id"]; - }; + readonly invitation_id: components['parameters']['invitation-id'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["team"][]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': readonly components['schemas']['team'][] + } + } + readonly 404: components['responses']['not_found'] + } + } /** * List issues in an organization assigned to the authenticated user. * @@ -23367,11 +23348,11 @@ export interface operations { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - readonly "issues/list-for-org": { + readonly 'issues/list-for-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; + readonly org: components['parameters']['org'] + } readonly query: { /** * Indicates which sorts of issues to return. Can be one of: @@ -23381,123 +23362,123 @@ export interface operations { * \* `subscribed`: Issues you're subscribed to updates for * \* `all` or `repos`: All issues the authenticated user can see, regardless of participation or creation */ - readonly filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all"; + readonly filter?: 'assigned' | 'created' | 'mentioned' | 'subscribed' | 'repos' | 'all' /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ - readonly state?: "open" | "closed" | "all"; + readonly state?: 'open' | 'closed' | 'all' /** A list of comma separated label names. Example: `bug,ui,@high` */ - readonly labels?: components["parameters"]["labels"]; + readonly labels?: components['parameters']['labels'] /** What to sort results by. Can be either `created`, `updated`, `comments`. */ - readonly sort?: "created" | "updated" | "comments"; + readonly sort?: 'created' | 'updated' | 'comments' /** One of `asc` (ascending) or `desc` (descending). */ - readonly direction?: components["parameters"]["direction"]; + readonly direction?: components['parameters']['direction'] /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; + readonly since?: components['parameters']['since'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["issue"][]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': readonly components['schemas']['issue'][] + } + } + readonly 404: components['responses']['not_found'] + } + } /** List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned. */ - readonly "orgs/list-members": { + readonly 'orgs/list-members': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; + readonly org: components['parameters']['org'] + } readonly query: { /** * Filter members returned in the list. Can be one of: * \* `2fa_disabled` - Members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. Available for organization owners. * \* `all` - All members the authenticated user can see. */ - readonly filter?: "2fa_disabled" | "all"; + readonly filter?: '2fa_disabled' | 'all' /** * Filter members returned by their role. Can be one of: * \* `all` - All members of the organization, regardless of role. * \* `admin` - Organization owners. * \* `member` - Non-owner organization members. */ - readonly role?: "all" | "admin" | "member"; + readonly role?: 'all' | 'admin' | 'member' /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; - }; - }; + readonly 'application/json': readonly components['schemas']['simple-user'][] + } + } /** Response if requester is not an organization member */ - readonly 302: never; - readonly 422: components["responses"]["validation_failed"]; - }; - }; + readonly 302: never + readonly 422: components['responses']['validation_failed'] + } + } /** Check if a user is, publicly or privately, a member of the organization. */ - readonly "orgs/check-membership-for-user": { + readonly 'orgs/check-membership-for-user': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - readonly username: components["parameters"]["username"]; - }; - }; + readonly org: components['parameters']['org'] + readonly username: components['parameters']['username'] + } + } readonly responses: { /** Response if requester is an organization member and user is a member */ - readonly 204: never; + readonly 204: never /** Response if requester is not an organization member */ - readonly 302: never; + readonly 302: never /** Not Found if requester is an organization member and user is not a member */ - readonly 404: unknown; - }; - }; + readonly 404: unknown + } + } /** Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories. */ - readonly "orgs/remove-member": { + readonly 'orgs/remove-member': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - readonly username: components["parameters"]["username"]; - }; - }; + readonly org: components['parameters']['org'] + readonly username: components['parameters']['username'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 403: components["responses"]["forbidden"]; - }; - }; + readonly 204: never + readonly 403: components['responses']['forbidden'] + } + } /** In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status. */ - readonly "orgs/get-membership-for-user": { + readonly 'orgs/get-membership-for-user': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - readonly username: components["parameters"]["username"]; - }; - }; + readonly org: components['parameters']['org'] + readonly username: components['parameters']['username'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["org-membership"]; - }; - }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': components['schemas']['org-membership'] + } + } + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } /** * Only authenticated organization owners can add a member to the organization or update the member's role. * @@ -23509,26 +23490,26 @@ export interface operations { * * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. */ - readonly "orgs/set-membership-for-user": { + readonly 'orgs/set-membership-for-user': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - readonly username: components["parameters"]["username"]; - }; - }; + readonly org: components['parameters']['org'] + readonly username: components['parameters']['username'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["org-membership"]; - }; - }; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': components['schemas']['org-membership'] + } + } + readonly 403: components['responses']['forbidden'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description The role to give the user in the organization. Can be one of: * \* `admin` - The user will become an owner of the organization. @@ -23536,102 +23517,102 @@ export interface operations { * @default member * @enum {string} */ - readonly role?: "admin" | "member"; - }; - }; - }; - }; + readonly role?: 'admin' | 'member' + } + } + } + } /** * In order to remove a user's membership with an organization, the authenticated user must be an organization owner. * * If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases. */ - readonly "orgs/remove-membership-for-user": { + readonly 'orgs/remove-membership-for-user': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - readonly username: components["parameters"]["username"]; - }; - }; + readonly org: components['parameters']['org'] + readonly username: components['parameters']['username'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 204: never + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } /** Lists the most recent migrations. */ - readonly "migrations/list-for-org": { + readonly 'migrations/list-for-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; + readonly org: components['parameters']['org'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; + readonly page?: components['parameters']['page'] /** Exclude attributes from the API response to improve performance */ - readonly exclude?: readonly "repositories"[]; - }; - }; + readonly exclude?: readonly 'repositories'[] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["migration"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['migration'][] + } + } + } + } /** Initiates the generation of a migration archive. */ - readonly "migrations/start-for-org": { + readonly 'migrations/start-for-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; - }; + readonly org: components['parameters']['org'] + } + } readonly responses: { /** Response */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["migration"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': components['schemas']['migration'] + } + } + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description A list of arrays indicating which repositories should be migrated. */ - readonly repositories: readonly string[]; + readonly repositories: readonly string[] /** * @description Indicates whether repositories should be locked (to prevent manipulation) while migrating data. * @example true */ - readonly lock_repositories?: boolean; + readonly lock_repositories?: boolean /** * @description Indicates whether attachments should be excluded from the migration (to reduce migration archive file size). * @example true */ - readonly exclude_attachments?: boolean; + readonly exclude_attachments?: boolean /** * @description Indicates whether releases should be excluded from the migration (to reduce migration archive file size). * @example true */ - readonly exclude_releases?: boolean; + readonly exclude_releases?: boolean /** * @description Indicates whether projects owned by the organization or users should be excluded. from the migration. * @example true */ - readonly exclude_owner_projects?: boolean; - readonly exclude?: readonly "repositories"[]; - }; - }; - }; - }; + readonly exclude_owner_projects?: boolean + readonly exclude?: readonly 'repositories'[] + } + } + } + } /** * Fetches the status of a migration. * @@ -23642,18 +23623,18 @@ export interface operations { * * `exported`, which means the migration finished successfully. * * `failed`, which means the migration failed. */ - readonly "migrations/get-status-for-org": { + readonly 'migrations/get-status-for-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** migration_id parameter */ - readonly migration_id: components["parameters"]["migration-id"]; - }; + readonly migration_id: components['parameters']['migration-id'] + } readonly query: { /** Exclude attributes from the API response to improve performance */ - readonly exclude?: readonly "repositories"[]; - }; - }; + readonly exclude?: readonly 'repositories'[] + } + } readonly responses: { /** * * `pending`, which means the migration hasn't started yet. @@ -23663,212 +23644,212 @@ export interface operations { */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["migration"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': components['schemas']['migration'] + } + } + readonly 404: components['responses']['not_found'] + } + } /** Fetches the URL to a migration archive. */ - readonly "migrations/download-archive-for-org": { + readonly 'migrations/download-archive-for-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** migration_id parameter */ - readonly migration_id: components["parameters"]["migration-id"]; - }; - }; + readonly migration_id: components['parameters']['migration-id'] + } + } readonly responses: { /** Response */ - readonly 302: never; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 302: never + readonly 404: components['responses']['not_found'] + } + } /** Deletes a previous migration archive. Migration archives are automatically deleted after seven days. */ - readonly "migrations/delete-archive-for-org": { + readonly 'migrations/delete-archive-for-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** migration_id parameter */ - readonly migration_id: components["parameters"]["migration-id"]; - }; - }; + readonly migration_id: components['parameters']['migration-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 204: never + readonly 404: components['responses']['not_found'] + } + } /** Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/rest/reference/repos#delete-a-repository) when the migration is complete and you no longer need the source data. */ - readonly "migrations/unlock-repo-for-org": { + readonly 'migrations/unlock-repo-for-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** migration_id parameter */ - readonly migration_id: components["parameters"]["migration-id"]; + readonly migration_id: components['parameters']['migration-id'] /** repo_name parameter */ - readonly repo_name: components["parameters"]["repo-name"]; - }; - }; + readonly repo_name: components['parameters']['repo-name'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 204: never + readonly 404: components['responses']['not_found'] + } + } /** List all the repositories for this organization migration. */ - readonly "migrations/list-repos-for-org": { + readonly 'migrations/list-repos-for-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** migration_id parameter */ - readonly migration_id: components["parameters"]["migration-id"]; - }; + readonly migration_id: components['parameters']['migration-id'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["minimal-repository"][]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': readonly components['schemas']['minimal-repository'][] + } + } + readonly 404: components['responses']['not_found'] + } + } /** List all users who are outside collaborators of an organization. */ - readonly "orgs/list-outside-collaborators": { + readonly 'orgs/list-outside-collaborators': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; + readonly org: components['parameters']['org'] + } readonly query: { /** * Filter the list of outside collaborators. Can be one of: * \* `2fa_disabled`: Outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. * \* `all`: All outside collaborators. */ - readonly filter?: "2fa_disabled" | "all"; + readonly filter?: '2fa_disabled' | 'all' /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['simple-user'][] + } + } + } + } /** When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://docs.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)". */ - readonly "orgs/convert-member-to-outside-collaborator": { + readonly 'orgs/convert-member-to-outside-collaborator': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - readonly username: components["parameters"]["username"]; - }; - }; + readonly org: components['parameters']['org'] + readonly username: components['parameters']['username'] + } + } readonly responses: { /** User is getting converted asynchronously */ readonly 202: { readonly content: { - readonly "application/json": { readonly [key: string]: unknown }; - }; - }; + readonly 'application/json': { readonly [key: string]: unknown } + } + } /** User was converted */ - readonly 204: never; + readonly 204: never /** Forbidden if user is the last owner of the organization or not a member of the organization */ - readonly 403: unknown; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 403: unknown + readonly 404: components['responses']['not_found'] + } + } /** Removing a user from this list will remove them from all the organization's repositories. */ - readonly "orgs/remove-outside-collaborator": { + readonly 'orgs/remove-outside-collaborator': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - readonly username: components["parameters"]["username"]; - }; - }; + readonly org: components['parameters']['org'] + readonly username: components['parameters']['username'] + } + } readonly responses: { /** Response */ - readonly 204: never; + readonly 204: never /** Unprocessable Entity if user is a member of the organization */ readonly 422: { readonly content: { - readonly "application/json": { - readonly message?: string; - readonly documentation_url?: string; - }; - }; - }; - }; - }; + readonly 'application/json': { + readonly message?: string + readonly documentation_url?: string + } + } + } + } + } /** * Lists all packages in an organization readable by the user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - readonly "packages/list-packages-for-organization": { + readonly 'packages/list-packages-for-organization': { readonly parameters: { readonly query: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + readonly package_type: 'npm' | 'maven' | 'rubygems' | 'docker' | 'nuget' | 'container' /** The selected visibility of the packages. Can be one of `public`, `private`, or `internal`. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set. */ - readonly visibility?: components["parameters"]["package-visibility"]; - }; + readonly visibility?: components['parameters']['package-visibility'] + } readonly path: { - readonly org: components["parameters"]["org"]; - }; - }; + readonly org: components['parameters']['org'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["package"][]; - }; - }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - }; - }; + readonly 'application/json': readonly components['schemas']['package'][] + } + } + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + } + } /** * Gets a specific package in an organization. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - readonly "packages/get-package-for-organization": { + readonly 'packages/get-package-for-organization': { readonly parameters: { readonly path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + readonly package_type: components['parameters']['package-type'] /** The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; - readonly org: components["parameters"]["org"]; - }; - }; + readonly package_name: components['parameters']['package-name'] + readonly org: components['parameters']['org'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["package"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['package'] + } + } + } + } /** * Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * @@ -23876,24 +23857,24 @@ export interface operations { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. */ - readonly "packages/delete-package-for-org": { + readonly 'packages/delete-package-for-org': { readonly parameters: { readonly path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + readonly package_type: components['parameters']['package-type'] /** The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; - readonly org: components["parameters"]["org"]; - }; - }; + readonly package_name: components['parameters']['package-name'] + readonly org: components['parameters']['org'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 204: never + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } /** * Restores an entire package in an organization. * @@ -23905,91 +23886,91 @@ export interface operations { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. */ - readonly "packages/restore-package-for-org": { + readonly 'packages/restore-package-for-org': { readonly parameters: { readonly path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + readonly package_type: components['parameters']['package-type'] /** The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; - readonly org: components["parameters"]["org"]; - }; + readonly package_name: components['parameters']['package-name'] + readonly org: components['parameters']['org'] + } readonly query: { /** package token */ - readonly token?: string; - }; - }; + readonly token?: string + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 204: never + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } /** * Returns all package versions for a package owned by an organization. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - readonly "packages/get-all-package-versions-for-package-owned-by-org": { + readonly 'packages/get-all-package-versions-for-package-owned-by-org': { readonly parameters: { readonly path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + readonly package_type: components['parameters']['package-type'] /** The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; - readonly org: components["parameters"]["org"]; - }; + readonly package_name: components['parameters']['package-name'] + readonly org: components['parameters']['org'] + } readonly query: { /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; + readonly page?: components['parameters']['page'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** The state of the package, either active or deleted. */ - readonly state?: "active" | "deleted"; - }; - }; + readonly state?: 'active' | 'deleted' + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["package-version"][]; - }; - }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': readonly components['schemas']['package-version'][] + } + } + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } /** * Gets a specific package version in an organization. * * You must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - readonly "packages/get-package-version-for-organization": { + readonly 'packages/get-package-version-for-organization': { readonly parameters: { readonly path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + readonly package_type: components['parameters']['package-type'] /** The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; - readonly org: components["parameters"]["org"]; + readonly package_name: components['parameters']['package-name'] + readonly org: components['parameters']['org'] /** Unique identifier of the package version. */ - readonly package_version_id: components["parameters"]["package-version-id"]; - }; - }; + readonly package_version_id: components['parameters']['package-version-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["package-version"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['package-version'] + } + } + } + } /** * Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * @@ -23997,26 +23978,26 @@ export interface operations { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. */ - readonly "packages/delete-package-version-for-org": { + readonly 'packages/delete-package-version-for-org': { readonly parameters: { readonly path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + readonly package_type: components['parameters']['package-type'] /** The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; - readonly org: components["parameters"]["org"]; + readonly package_name: components['parameters']['package-name'] + readonly org: components['parameters']['org'] /** Unique identifier of the package version. */ - readonly package_version_id: components["parameters"]["package-version-id"]; - }; - }; + readonly package_version_id: components['parameters']['package-version-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 204: never + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } /** * Restores a specific package version in an organization. * @@ -24028,179 +24009,179 @@ export interface operations { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. */ - readonly "packages/restore-package-version-for-org": { + readonly 'packages/restore-package-version-for-org': { readonly parameters: { readonly path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + readonly package_type: components['parameters']['package-type'] /** The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; - readonly org: components["parameters"]["org"]; + readonly package_name: components['parameters']['package-name'] + readonly org: components['parameters']['org'] /** Unique identifier of the package version. */ - readonly package_version_id: components["parameters"]["package-version-id"]; - }; - }; + readonly package_version_id: components['parameters']['package-version-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 204: never + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } /** Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - readonly "projects/list-for-org": { + readonly 'projects/list-for-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; + readonly org: components['parameters']['org'] + } readonly query: { /** Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. */ - readonly state?: "open" | "closed" | "all"; + readonly state?: 'open' | 'closed' | 'all' /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["project"][]; - }; - }; - readonly 422: components["responses"]["validation_failed_simple"]; - }; - }; + readonly 'application/json': readonly components['schemas']['project'][] + } + } + readonly 422: components['responses']['validation_failed_simple'] + } + } /** Creates an organization project board. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - readonly "projects/create-for-org": { + readonly 'projects/create-for-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; - }; + readonly org: components['parameters']['org'] + } + } readonly responses: { /** Response */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["project"]; - }; - }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; - readonly 422: components["responses"]["validation_failed_simple"]; - }; + readonly 'application/json': components['schemas']['project'] + } + } + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 410: components['responses']['gone'] + readonly 422: components['responses']['validation_failed_simple'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The name of the project. */ - readonly name: string; + readonly name: string /** @description The description of the project. */ - readonly body?: string; - }; - }; - }; - }; + readonly body?: string + } + } + } + } /** Members of an organization can choose to have their membership publicized or not. */ - readonly "orgs/list-public-members": { + readonly 'orgs/list-public-members': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; + readonly org: components['parameters']['org'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; - }; - }; - }; - }; - readonly "orgs/check-public-membership-for-user": { + readonly 'application/json': readonly components['schemas']['simple-user'][] + } + } + } + } + readonly 'orgs/check-public-membership-for-user': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - readonly username: components["parameters"]["username"]; - }; - }; + readonly org: components['parameters']['org'] + readonly username: components['parameters']['username'] + } + } readonly responses: { /** Response if user is a public member */ - readonly 204: never; + readonly 204: never /** Not Found if user is not a public member */ - readonly 404: unknown; - }; - }; + readonly 404: unknown + } + } /** * The user can publicize their own membership. (A user cannot publicize the membership for another user.) * * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - readonly "orgs/set-public-membership-for-authenticated-user": { + readonly 'orgs/set-public-membership-for-authenticated-user': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - readonly username: components["parameters"]["username"]; - }; - }; + readonly org: components['parameters']['org'] + readonly username: components['parameters']['username'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 403: components["responses"]["forbidden"]; - }; - }; - readonly "orgs/remove-public-membership-for-authenticated-user": { + readonly 204: never + readonly 403: components['responses']['forbidden'] + } + } + readonly 'orgs/remove-public-membership-for-authenticated-user': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - readonly username: components["parameters"]["username"]; - }; - }; + readonly org: components['parameters']['org'] + readonly username: components['parameters']['username'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** Lists repositories for the specified organization. */ - readonly "repos/list-for-org": { + readonly 'repos/list-for-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; + readonly org: components['parameters']['org'] + } readonly query: { /** Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Note: For GitHub AE, can be one of `all`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`. However, the `internal` value is not yet supported when a GitHub App calls this API with an installation access token. */ - readonly type?: "all" | "public" | "private" | "forks" | "sources" | "member" | "internal"; + readonly type?: 'all' | 'public' | 'private' | 'forks' | 'sources' | 'member' | 'internal' /** Can be one of `created`, `updated`, `pushed`, `full_name`. */ - readonly sort?: "created" | "updated" | "pushed" | "full_name"; + readonly sort?: 'created' | 'updated' | 'pushed' | 'full_name' /** Can be one of `asc` or `desc`. Default: when using `full_name`: `asc`, otherwise `desc` */ - readonly direction?: "asc" | "desc"; + readonly direction?: 'asc' | 'desc' /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["minimal-repository"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['minimal-repository'][] + } + } + } + } /** * Creates a new repository in the specified organization. The authenticated user must be a member of the organization. * @@ -24211,129 +24192,129 @@ export interface operations { * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. * * `repo` scope to create a private repository */ - readonly "repos/create-in-org": { + readonly 'repos/create-in-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; - }; + readonly org: components['parameters']['org'] + } + } readonly responses: { /** Response */ readonly 201: { readonly headers: { - readonly Location?: string; - }; - readonly content: { - readonly "application/json": components["schemas"]["repository"]; - }; - }; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly Location?: string + } + readonly content: { + readonly 'application/json': components['schemas']['repository'] + } + } + readonly 403: components['responses']['forbidden'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The name of the repository. */ - readonly name: string; + readonly name: string /** @description A short description of the repository. */ - readonly description?: string; + readonly description?: string /** @description A URL with more information about the repository. */ - readonly homepage?: string; + readonly homepage?: string /** @description Whether the repository is private. */ - readonly private?: boolean; + readonly private?: boolean /** * @description Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see "[Creating an internal repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)" in the GitHub Help documentation. * @enum {string} */ - readonly visibility?: "public" | "private" | "internal"; + readonly visibility?: 'public' | 'private' | 'internal' /** * @description Either `true` to enable issues for this repository or `false` to disable them. * @default true */ - readonly has_issues?: boolean; + readonly has_issues?: boolean /** * @description Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error. * @default true */ - readonly has_projects?: boolean; + readonly has_projects?: boolean /** * @description Either `true` to enable the wiki for this repository or `false` to disable it. * @default true */ - readonly has_wiki?: boolean; + readonly has_wiki?: boolean /** @description Either `true` to make this repo available as a template repository or `false` to prevent it. */ - readonly is_template?: boolean; + readonly is_template?: boolean /** @description The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. */ - readonly team_id?: number; + readonly team_id?: number /** @description Pass `true` to create an initial commit with empty README. */ - readonly auto_init?: boolean; + readonly auto_init?: boolean /** @description Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, "Haskell". */ - readonly gitignore_template?: string; + readonly gitignore_template?: string /** @description Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, "mit" or "mpl-2.0". */ - readonly license_template?: string; + readonly license_template?: string /** * @description Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. * @default true */ - readonly allow_squash_merge?: boolean; + readonly allow_squash_merge?: boolean /** * @description Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. * @default true */ - readonly allow_merge_commit?: boolean; + readonly allow_merge_commit?: boolean /** * @description Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. * @default true */ - readonly allow_rebase_merge?: boolean; + readonly allow_rebase_merge?: boolean /** @description Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. */ - readonly allow_auto_merge?: boolean; + readonly allow_auto_merge?: boolean /** @description Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. */ - readonly delete_branch_on_merge?: boolean; - }; - }; - }; - }; + readonly delete_branch_on_merge?: boolean + } + } + } + } /** * Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest. * To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. */ - readonly "secret-scanning/list-alerts-for-org": { + readonly 'secret-scanning/list-alerts-for-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; + readonly org: components['parameters']['org'] + } readonly query: { /** Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - readonly state?: components["parameters"]["secret-scanning-alert-state"]; + readonly state?: components['parameters']['secret-scanning-alert-state'] /** * A comma-separated list of secret types to return. By default all secret types are returned. * See "[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)" * for a complete list of secret types (API slug). */ - readonly secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; + readonly secret_type?: components['parameters']['secret-scanning-alert-secret-type'] /** A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - readonly resolution?: components["parameters"]["secret-scanning-alert-resolution"]; + readonly resolution?: components['parameters']['secret-scanning-alert-resolution'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; + readonly page?: components['parameters']['page'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; - }; - }; + readonly per_page?: components['parameters']['per-page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["organization-secret-scanning-alert"][]; - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; - }; - }; + readonly 'application/json': readonly components['schemas']['organization-secret-scanning-alert'][] + } + } + readonly 404: components['responses']['not_found'] + readonly 503: components['responses']['service_unavailable'] + } + } /** * Gets the summary of the free and paid GitHub Actions minutes used. * @@ -24341,48 +24322,48 @@ export interface operations { * * Access tokens must have the `repo` or `admin:org` scope. */ - readonly "billing/get-github-actions-billing-org": { + readonly 'billing/get-github-actions-billing-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; - }; + readonly org: components['parameters']['org'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["actions-billing-usage"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['actions-billing-usage'] + } + } + } + } /** * Gets the GitHub Advanced Security active committers for an organization per repository. * Each distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of advanced_security_committers for each repository. * If this organization defers to an enterprise for billing, the total_advanced_security_committers returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level. */ - readonly "billing/get-github-advanced-security-billing-org": { + readonly 'billing/get-github-advanced-security-billing-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; + readonly org: components['parameters']['org'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Success */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["advanced-security-active-committers"]; - }; - }; - readonly 403: components["responses"]["code_scanning_forbidden_read"]; - }; - }; + readonly 'application/json': components['schemas']['advanced-security-active-committers'] + } + } + readonly 403: components['responses']['code_scanning_forbidden_read'] + } + } /** * Gets the free and paid storage used for GitHub Packages in gigabytes. * @@ -24390,21 +24371,21 @@ export interface operations { * * Access tokens must have the `repo` or `admin:org` scope. */ - readonly "billing/get-github-packages-billing-org": { + readonly 'billing/get-github-packages-billing-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; - }; + readonly org: components['parameters']['org'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["packages-billing-usage"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['packages-billing-usage'] + } + } + } + } /** * Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. * @@ -24412,106 +24393,106 @@ export interface operations { * * Access tokens must have the `repo` or `admin:org` scope. */ - readonly "billing/get-shared-storage-billing-org": { + readonly 'billing/get-shared-storage-billing-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; - }; + readonly org: components['parameters']['org'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["combined-billing-usage"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['combined-billing-usage'] + } + } + } + } /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * List IdP groups available in an organization. You can limit your page results using the `per_page` parameter. GitHub generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." */ - readonly "teams/list-idp-groups-for-org": { + readonly 'teams/list-idp-groups-for-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; + readonly org: components['parameters']['org'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page token */ - readonly page?: string; - }; - }; + readonly page?: string + } + } readonly responses: { /** Response */ readonly 200: { readonly headers: { - readonly Link?: string; - }; - readonly content: { - readonly "application/json": components["schemas"]["group-mapping"]; - }; - }; - }; - }; + readonly Link?: string + } + readonly content: { + readonly 'application/json': components['schemas']['group-mapping'] + } + } + } + } /** Lists all teams in an organization that are visible to the authenticated user. */ - readonly "teams/list": { + readonly 'teams/list': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; + readonly org: components['parameters']['org'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["team"][]; - }; - }; - readonly 403: components["responses"]["forbidden"]; - }; - }; + readonly 'application/json': readonly components['schemas']['team'][] + } + } + readonly 403: components['responses']['forbidden'] + } + } /** * To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://docs.github.com/en/articles/setting-team-creation-permissions-in-your-organization)." * * When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)". */ - readonly "teams/create": { + readonly 'teams/create': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; - }; + readonly org: components['parameters']['org'] + } + } readonly responses: { /** Response */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["team-full"]; - }; - }; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': components['schemas']['team-full'] + } + } + readonly 403: components['responses']['forbidden'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The name of the team. */ - readonly name: string; + readonly name: string /** @description The description of the team. */ - readonly description?: string; + readonly description?: string /** @description List GitHub IDs for organization members who will become team maintainers. */ - readonly maintainers?: readonly string[]; + readonly maintainers?: readonly string[] /** @description The full name (e.g., "organization-name/repository-name") of repositories to add the team to. */ - readonly repo_names?: readonly string[]; + readonly repo_names?: readonly string[] /** * @description The level of privacy this team should have. The options are: * **For a non-nested team:** @@ -24523,7 +24504,7 @@ export interface operations { * Default for child team: `closed` * @enum {string} */ - readonly privacy?: "secret" | "closed"; + readonly privacy?: 'secret' | 'closed' /** * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: * \* `pull` - team members can pull, but not push to or administer newly-added repositories. @@ -24531,36 +24512,36 @@ export interface operations { * @default pull * @enum {string} */ - readonly permission?: "pull" | "push"; + readonly permission?: 'pull' | 'push' /** @description The ID of a team to set as the parent team. */ - readonly parent_team_id?: number; - }; - }; - }; - }; + readonly parent_team_id?: number + } + } + } + } /** * Gets a team using the team's `slug`. GitHub generates the `slug` from the team `name`. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. */ - readonly "teams/get-by-name": { + readonly 'teams/get-by-name': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** team_slug parameter */ - readonly team_slug: components["parameters"]["team-slug"]; - }; - }; + readonly team_slug: components['parameters']['team-slug'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["team-full"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': components['schemas']['team-full'] + } + } + readonly 404: components['responses']['not_found'] + } + } /** * To delete a team, the authenticated user must be an organization owner or team maintainer. * @@ -24568,47 +24549,47 @@ export interface operations { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. */ - readonly "teams/delete-in-org": { + readonly 'teams/delete-in-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** team_slug parameter */ - readonly team_slug: components["parameters"]["team-slug"]; - }; - }; + readonly team_slug: components['parameters']['team-slug'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** * To edit a team, the authenticated user must either be an organization owner or a team maintainer. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. */ - readonly "teams/update-in-org": { + readonly 'teams/update-in-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** team_slug parameter */ - readonly team_slug: components["parameters"]["team-slug"]; - }; - }; + readonly team_slug: components['parameters']['team-slug'] + } + } readonly responses: { /** Response */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["team-full"]; - }; - }; - }; + readonly 'application/json': components['schemas']['team-full'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The name of the team. */ - readonly name?: string; + readonly name?: string /** @description The description of the team. */ - readonly description?: string; + readonly description?: string /** * @description The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: * **For a non-nested team:** @@ -24618,7 +24599,7 @@ export interface operations { * \* `closed` - visible to all members of this organization. * @enum {string} */ - readonly privacy?: "secret" | "closed"; + readonly privacy?: 'secret' | 'closed' /** * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: * \* `pull` - team members can pull, but not push to or administer newly-added repositories. @@ -24627,46 +24608,46 @@ export interface operations { * @default pull * @enum {string} */ - readonly permission?: "pull" | "push" | "admin"; + readonly permission?: 'pull' | 'push' | 'admin' /** @description The ID of a team to set as the parent team. */ - readonly parent_team_id?: number | null; - }; - }; - }; - }; + readonly parent_team_id?: number | null + } + } + } + } /** * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. */ - readonly "teams/list-discussions-in-org": { + readonly 'teams/list-discussions-in-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** team_slug parameter */ - readonly team_slug: components["parameters"]["team-slug"]; - }; + readonly team_slug: components['parameters']['team-slug'] + } readonly query: { /** One of `asc` (ascending) or `desc` (descending). */ - readonly direction?: components["parameters"]["direction"]; + readonly direction?: components['parameters']['direction'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; + readonly page?: components['parameters']['page'] /** Pinned discussions only filter */ - readonly pinned?: string; - }; - }; + readonly pinned?: string + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["team-discussion"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['team-discussion'][] + } + } + } + } /** * Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @@ -24674,142 +24655,142 @@ export interface operations { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. */ - readonly "teams/create-discussion-in-org": { + readonly 'teams/create-discussion-in-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** team_slug parameter */ - readonly team_slug: components["parameters"]["team-slug"]; - }; - }; + readonly team_slug: components['parameters']['team-slug'] + } + } readonly responses: { /** Response */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; + readonly 'application/json': components['schemas']['team-discussion'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The discussion post's title. */ - readonly title: string; + readonly title: string /** @description The discussion post's body text. */ - readonly body: string; + readonly body: string /** @description Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. */ - readonly private?: boolean; - }; - }; - }; - }; + readonly private?: boolean + } + } + } + } /** * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. */ - readonly "teams/get-discussion-in-org": { + readonly 'teams/get-discussion-in-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** team_slug parameter */ - readonly team_slug: components["parameters"]["team-slug"]; - readonly discussion_number: components["parameters"]["discussion-number"]; - }; - }; + readonly team_slug: components['parameters']['team-slug'] + readonly discussion_number: components['parameters']['discussion-number'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['team-discussion'] + } + } + } + } /** * Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. */ - readonly "teams/delete-discussion-in-org": { + readonly 'teams/delete-discussion-in-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** team_slug parameter */ - readonly team_slug: components["parameters"]["team-slug"]; - readonly discussion_number: components["parameters"]["discussion-number"]; - }; - }; + readonly team_slug: components['parameters']['team-slug'] + readonly discussion_number: components['parameters']['discussion-number'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. */ - readonly "teams/update-discussion-in-org": { + readonly 'teams/update-discussion-in-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** team_slug parameter */ - readonly team_slug: components["parameters"]["team-slug"]; - readonly discussion_number: components["parameters"]["discussion-number"]; - }; - }; + readonly team_slug: components['parameters']['team-slug'] + readonly discussion_number: components['parameters']['discussion-number'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; + readonly 'application/json': components['schemas']['team-discussion'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The discussion post's title. */ - readonly title?: string; + readonly title?: string /** @description The discussion post's body text. */ - readonly body?: string; - }; - }; - }; - }; + readonly body?: string + } + } + } + } /** * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. */ - readonly "teams/list-discussion-comments-in-org": { + readonly 'teams/list-discussion-comments-in-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** team_slug parameter */ - readonly team_slug: components["parameters"]["team-slug"]; - readonly discussion_number: components["parameters"]["discussion-number"]; - }; + readonly team_slug: components['parameters']['team-slug'] + readonly discussion_number: components['parameters']['discussion-number'] + } readonly query: { /** One of `asc` (ascending) or `desc` (descending). */ - readonly direction?: components["parameters"]["direction"]; + readonly direction?: components['parameters']['direction'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["team-discussion-comment"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['team-discussion-comment'][] + } + } + } + } /** * Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @@ -24817,387 +24798,387 @@ export interface operations { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. */ - readonly "teams/create-discussion-comment-in-org": { + readonly 'teams/create-discussion-comment-in-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** team_slug parameter */ - readonly team_slug: components["parameters"]["team-slug"]; - readonly discussion_number: components["parameters"]["discussion-number"]; - }; - }; + readonly team_slug: components['parameters']['team-slug'] + readonly discussion_number: components['parameters']['discussion-number'] + } + } readonly responses: { /** Response */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; + readonly 'application/json': components['schemas']['team-discussion-comment'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The discussion comment's body text. */ - readonly body: string; - }; - }; - }; - }; + readonly body: string + } + } + } + } /** * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. */ - readonly "teams/get-discussion-comment-in-org": { + readonly 'teams/get-discussion-comment-in-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** team_slug parameter */ - readonly team_slug: components["parameters"]["team-slug"]; - readonly discussion_number: components["parameters"]["discussion-number"]; - readonly comment_number: components["parameters"]["comment-number"]; - }; - }; + readonly team_slug: components['parameters']['team-slug'] + readonly discussion_number: components['parameters']['discussion-number'] + readonly comment_number: components['parameters']['comment-number'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['team-discussion-comment'] + } + } + } + } /** * Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. */ - readonly "teams/delete-discussion-comment-in-org": { + readonly 'teams/delete-discussion-comment-in-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** team_slug parameter */ - readonly team_slug: components["parameters"]["team-slug"]; - readonly discussion_number: components["parameters"]["discussion-number"]; - readonly comment_number: components["parameters"]["comment-number"]; - }; - }; + readonly team_slug: components['parameters']['team-slug'] + readonly discussion_number: components['parameters']['discussion-number'] + readonly comment_number: components['parameters']['comment-number'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. */ - readonly "teams/update-discussion-comment-in-org": { + readonly 'teams/update-discussion-comment-in-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** team_slug parameter */ - readonly team_slug: components["parameters"]["team-slug"]; - readonly discussion_number: components["parameters"]["discussion-number"]; - readonly comment_number: components["parameters"]["comment-number"]; - }; - }; + readonly team_slug: components['parameters']['team-slug'] + readonly discussion_number: components['parameters']['discussion-number'] + readonly comment_number: components['parameters']['comment-number'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; + readonly 'application/json': components['schemas']['team-discussion-comment'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The discussion comment's body text. */ - readonly body: string; - }; - }; - }; - }; + readonly body: string + } + } + } + } /** * List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments/). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. */ - readonly "reactions/list-for-team-discussion-comment-in-org": { + readonly 'reactions/list-for-team-discussion-comment-in-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** team_slug parameter */ - readonly team_slug: components["parameters"]["team-slug"]; - readonly discussion_number: components["parameters"]["discussion-number"]; - readonly comment_number: components["parameters"]["comment-number"]; - }; + readonly team_slug: components['parameters']['team-slug'] + readonly discussion_number: components['parameters']['discussion-number'] + readonly comment_number: components['parameters']['comment-number'] + } readonly query: { /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion comment. */ - readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + readonly content?: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["reaction"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['reaction'][] + } + } + } + } /** * Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. */ - readonly "reactions/create-for-team-discussion-comment-in-org": { + readonly 'reactions/create-for-team-discussion-comment-in-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** team_slug parameter */ - readonly team_slug: components["parameters"]["team-slug"]; - readonly discussion_number: components["parameters"]["discussion-number"]; - readonly comment_number: components["parameters"]["comment-number"]; - }; - }; + readonly team_slug: components['parameters']['team-slug'] + readonly discussion_number: components['parameters']['discussion-number'] + readonly comment_number: components['parameters']['comment-number'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["reaction"]; - }; - }; + readonly 'application/json': components['schemas']['reaction'] + } + } /** Response */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["reaction"]; - }; - }; - }; + readonly 'application/json': components['schemas']['reaction'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion comment. * @enum {string} */ - readonly content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - }; + readonly content: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' + } + } + } + } /** * **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. * * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - readonly "reactions/delete-for-team-discussion-comment": { + readonly 'reactions/delete-for-team-discussion-comment': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** team_slug parameter */ - readonly team_slug: components["parameters"]["team-slug"]; - readonly discussion_number: components["parameters"]["discussion-number"]; - readonly comment_number: components["parameters"]["comment-number"]; - readonly reaction_id: components["parameters"]["reaction-id"]; - }; - }; + readonly team_slug: components['parameters']['team-slug'] + readonly discussion_number: components['parameters']['discussion-number'] + readonly comment_number: components['parameters']['comment-number'] + readonly reaction_id: components['parameters']['reaction-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** * List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. */ - readonly "reactions/list-for-team-discussion-in-org": { + readonly 'reactions/list-for-team-discussion-in-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** team_slug parameter */ - readonly team_slug: components["parameters"]["team-slug"]; - readonly discussion_number: components["parameters"]["discussion-number"]; - }; + readonly team_slug: components['parameters']['team-slug'] + readonly discussion_number: components['parameters']['discussion-number'] + } readonly query: { /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion. */ - readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + readonly content?: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["reaction"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['reaction'][] + } + } + } + } /** * Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. */ - readonly "reactions/create-for-team-discussion-in-org": { + readonly 'reactions/create-for-team-discussion-in-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** team_slug parameter */ - readonly team_slug: components["parameters"]["team-slug"]; - readonly discussion_number: components["parameters"]["discussion-number"]; - }; - }; + readonly team_slug: components['parameters']['team-slug'] + readonly discussion_number: components['parameters']['discussion-number'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["reaction"]; - }; - }; + readonly 'application/json': components['schemas']['reaction'] + } + } /** Response */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["reaction"]; - }; - }; - }; + readonly 'application/json': components['schemas']['reaction'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion. * @enum {string} */ - readonly content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - }; + readonly content: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' + } + } + } + } /** * **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. * * Delete a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - readonly "reactions/delete-for-team-discussion": { + readonly 'reactions/delete-for-team-discussion': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** team_slug parameter */ - readonly team_slug: components["parameters"]["team-slug"]; - readonly discussion_number: components["parameters"]["discussion-number"]; - readonly reaction_id: components["parameters"]["reaction-id"]; - }; - }; + readonly team_slug: components['parameters']['team-slug'] + readonly discussion_number: components['parameters']['discussion-number'] + readonly reaction_id: components['parameters']['reaction-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** * Deletes a connection between a team and an external group. * * You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly "teams/unlink-external-idp-group-from-team-for-org": { + readonly 'teams/unlink-external-idp-group-from-team-for-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** team_slug parameter */ - readonly team_slug: components["parameters"]["team-slug"]; - }; - }; + readonly team_slug: components['parameters']['team-slug'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** * Creates a connection between a team and an external group. Only one external group can be linked to a team. * * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ - readonly "teams/link-external-idp-group-to-team-for-org": { + readonly 'teams/link-external-idp-group-to-team-for-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** team_slug parameter */ - readonly team_slug: components["parameters"]["team-slug"]; - }; - }; + readonly team_slug: components['parameters']['team-slug'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["external-group"]; - }; - }; - }; + readonly 'application/json': components['schemas']['external-group'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description External Group Id * @example 1 */ - readonly group_id: number; - }; - }; - }; - }; + readonly group_id: number + } + } + } + } /** * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. */ - readonly "teams/list-pending-invitations-in-org": { + readonly 'teams/list-pending-invitations-in-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** team_slug parameter */ - readonly team_slug: components["parameters"]["team-slug"]; - }; + readonly team_slug: components['parameters']['team-slug'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["organization-invitation"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['organization-invitation'][] + } + } + } + } /** * Team members will include the members of child teams. * * To list members in a team, the team must be visible to the authenticated user. */ - readonly "teams/list-members-in-org": { + readonly 'teams/list-members-in-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** team_slug parameter */ - readonly team_slug: components["parameters"]["team-slug"]; - }; + readonly team_slug: components['parameters']['team-slug'] + } readonly query: { /** * Filters members returned by their role in the team. Can be one of: @@ -25205,23 +25186,23 @@ export interface operations { * \* `maintainer` - team maintainers. * \* `all` - all members of the team. */ - readonly role?: "member" | "maintainer" | "all"; + readonly role?: 'member' | 'maintainer' | 'all' /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['simple-user'][] + } + } + } + } /** * Team members will include the members of child teams. * @@ -25234,26 +25215,26 @@ export interface operations { * * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team). */ - readonly "teams/get-membership-for-user-in-org": { + readonly 'teams/get-membership-for-user-in-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** team_slug parameter */ - readonly team_slug: components["parameters"]["team-slug"]; - readonly username: components["parameters"]["username"]; - }; - }; + readonly team_slug: components['parameters']['team-slug'] + readonly username: components['parameters']['username'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["team-membership"]; - }; - }; + readonly 'application/json': components['schemas']['team-membership'] + } + } /** if user has no team membership */ - readonly 404: unknown; - }; - }; + readonly 404: unknown + } + } /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -25267,30 +25248,30 @@ export interface operations { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ - readonly "teams/add-or-update-membership-for-user-in-org": { + readonly 'teams/add-or-update-membership-for-user-in-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** team_slug parameter */ - readonly team_slug: components["parameters"]["team-slug"]; - readonly username: components["parameters"]["username"]; - }; - }; + readonly team_slug: components['parameters']['team-slug'] + readonly username: components['parameters']['username'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["team-membership"]; - }; - }; + readonly 'application/json': components['schemas']['team-membership'] + } + } /** Forbidden if team synchronization is set up */ - readonly 403: unknown; + readonly 403: unknown /** Unprocessable Entity if you attempt to add an organization to a team */ - readonly 422: unknown; - }; + readonly 422: unknown + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description The role that this user should have in the team. Can be one of: * \* `member` - a normal member of the team. @@ -25298,11 +25279,11 @@ export interface operations { * @default member * @enum {string} */ - readonly role?: "member" | "maintainer"; - }; - }; - }; - }; + readonly role?: 'member' | 'maintainer' + } + } + } + } /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -25312,106 +25293,106 @@ export interface operations { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ - readonly "teams/remove-membership-for-user-in-org": { + readonly 'teams/remove-membership-for-user-in-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** team_slug parameter */ - readonly team_slug: components["parameters"]["team-slug"]; - readonly username: components["parameters"]["username"]; - }; - }; + readonly team_slug: components['parameters']['team-slug'] + readonly username: components['parameters']['username'] + } + } readonly responses: { /** Response */ - readonly 204: never; + readonly 204: never /** Forbidden if team synchronization is set up */ - readonly 403: unknown; - }; - }; + readonly 403: unknown + } + } /** * Lists the organization projects for a team. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. */ - readonly "teams/list-projects-in-org": { + readonly 'teams/list-projects-in-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** team_slug parameter */ - readonly team_slug: components["parameters"]["team-slug"]; - }; + readonly team_slug: components['parameters']['team-slug'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["team-project"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['team-project'][] + } + } + } + } /** * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ - readonly "teams/check-permissions-for-project-in-org": { + readonly 'teams/check-permissions-for-project-in-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** team_slug parameter */ - readonly team_slug: components["parameters"]["team-slug"]; - readonly project_id: components["parameters"]["project-id"]; - }; - }; + readonly team_slug: components['parameters']['team-slug'] + readonly project_id: components['parameters']['project-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["team-project"]; - }; - }; + readonly 'application/json': components['schemas']['team-project'] + } + } /** Not Found if project is not managed by this team */ - readonly 404: unknown; - }; - }; + readonly 404: unknown + } + } /** * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ - readonly "teams/add-or-update-project-permissions-in-org": { + readonly 'teams/add-or-update-project-permissions-in-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** team_slug parameter */ - readonly team_slug: components["parameters"]["team-slug"]; - readonly project_id: components["parameters"]["project-id"]; - }; - }; + readonly team_slug: components['parameters']['team-slug'] + readonly project_id: components['parameters']['project-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; + readonly 204: never /** Forbidden if the project is not owned by the organization */ readonly 403: { readonly content: { - readonly "application/json": { - readonly message?: string; - readonly documentation_url?: string; - }; - }; - }; - }; + readonly 'application/json': { + readonly message?: string + readonly documentation_url?: string + } + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description The permission to grant to the team for this project. Can be one of: * \* `read` - team members can read, but not write to or administer this project. @@ -25420,59 +25401,59 @@ export interface operations { * Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." * @enum {string} */ - readonly permission?: "read" | "write" | "admin"; - } | null; - }; - }; - }; + readonly permission?: 'read' | 'write' | 'admin' + } | null + } + } + } /** * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ - readonly "teams/remove-project-in-org": { + readonly 'teams/remove-project-in-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** team_slug parameter */ - readonly team_slug: components["parameters"]["team-slug"]; - readonly project_id: components["parameters"]["project-id"]; - }; - }; + readonly team_slug: components['parameters']['team-slug'] + readonly project_id: components['parameters']['project-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** * Lists a team's repositories visible to the authenticated user. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. */ - readonly "teams/list-repos-in-org": { + readonly 'teams/list-repos-in-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** team_slug parameter */ - readonly team_slug: components["parameters"]["team-slug"]; - }; + readonly team_slug: components['parameters']['team-slug'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["minimal-repository"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['minimal-repository'][] + } + } + } + } /** * Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. * @@ -25482,29 +25463,29 @@ export interface operations { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ - readonly "teams/check-permissions-for-repo-in-org": { + readonly 'teams/check-permissions-for-repo-in-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** team_slug parameter */ - readonly team_slug: components["parameters"]["team-slug"]; - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly team_slug: components['parameters']['team-slug'] + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Alternative response with repository permissions */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["team-repository"]; - }; - }; + readonly 'application/json': components['schemas']['team-repository'] + } + } /** Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header. */ - readonly 204: never; + readonly 204: never /** Not Found if team does not have permission for the repository */ - readonly 404: unknown; - }; - }; + readonly 404: unknown + } + } /** * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." * @@ -25512,23 +25493,23 @@ export interface operations { * * For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". */ - readonly "teams/add-or-update-repo-permissions-in-org": { + readonly 'teams/add-or-update-repo-permissions-in-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** team_slug parameter */ - readonly team_slug: components["parameters"]["team-slug"]; - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly team_slug: components['parameters']['team-slug'] + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; + readonly 204: never + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description The permission to grant the team on this repository. Can be one of: * \* `pull` - team members can pull, but not push to or administer this repository. @@ -25542,31 +25523,31 @@ export interface operations { * @default push * @enum {string} */ - readonly permission?: "pull" | "push" | "admin" | "maintain" | "triage"; - }; - }; - }; - }; + readonly permission?: 'pull' | 'push' | 'admin' | 'maintain' | 'triage' + } + } + } + } /** * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ - readonly "teams/remove-repo-in-org": { + readonly 'teams/remove-repo-in-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** team_slug parameter */ - readonly team_slug: components["parameters"]["team-slug"]; - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly team_slug: components['parameters']['team-slug'] + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -25574,23 +25555,23 @@ export interface operations { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`. */ - readonly "teams/list-idp-groups-in-org": { + readonly 'teams/list-idp-groups-in-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** team_slug parameter */ - readonly team_slug: components["parameters"]["team-slug"]; - }; - }; + readonly team_slug: components['parameters']['team-slug'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["group-mapping"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['group-mapping'] + } + } + } + } /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -25598,510 +25579,508 @@ export interface operations { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`. */ - readonly "teams/create-or-update-idp-group-connections-in-org": { + readonly 'teams/create-or-update-idp-group-connections-in-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** team_slug parameter */ - readonly team_slug: components["parameters"]["team-slug"]; - }; - }; + readonly team_slug: components['parameters']['team-slug'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["group-mapping"]; - }; - }; - }; + readonly 'application/json': components['schemas']['group-mapping'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The IdP groups you want to connect to a GitHub team. When updating, the new `groups` object will replace the original one. You must include any existing groups that you don't want to remove. */ readonly groups?: readonly { /** @description ID of the IdP group. */ - readonly group_id: string; + readonly group_id: string /** @description Name of the IdP group. */ - readonly group_name: string; + readonly group_name: string /** @description Description of the IdP group. */ - readonly group_description: string; - }[]; - }; - }; - }; - }; + readonly group_description: string + }[] + } + } + } + } /** * Lists the child teams of the team specified by `{team_slug}`. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. */ - readonly "teams/list-child-in-org": { + readonly 'teams/list-child-in-org': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** team_slug parameter */ - readonly team_slug: components["parameters"]["team-slug"]; - }; + readonly team_slug: components['parameters']['team-slug'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** if child teams exist */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["team"][]; - }; - }; - }; - }; - readonly "projects/get-card": { + readonly 'application/json': readonly components['schemas']['team'][] + } + } + } + } + readonly 'projects/get-card': { readonly parameters: { readonly path: { /** card_id parameter */ - readonly card_id: components["parameters"]["card-id"]; - }; - }; + readonly card_id: components['parameters']['card-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["project-card"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "projects/delete-card": { + readonly 'application/json': components['schemas']['project-card'] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } + readonly 'projects/delete-card': { readonly parameters: { readonly path: { /** card_id parameter */ - readonly card_id: components["parameters"]["card-id"]; - }; - }; + readonly card_id: components['parameters']['card-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; + readonly 204: never + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] /** Forbidden */ readonly 403: { readonly content: { - readonly "application/json": { - readonly message?: string; - readonly documentation_url?: string; - readonly errors?: readonly string[]; - }; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "projects/update-card": { + readonly 'application/json': { + readonly message?: string + readonly documentation_url?: string + readonly errors?: readonly string[] + } + } + } + readonly 404: components['responses']['not_found'] + } + } + readonly 'projects/update-card': { readonly parameters: { readonly path: { /** card_id parameter */ - readonly card_id: components["parameters"]["card-id"]; - }; - }; + readonly card_id: components['parameters']['card-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["project-card"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; - }; + readonly 'application/json': components['schemas']['project-card'] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed_simple'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description The project card's note * @example Update all gems */ - readonly note?: string | null; + readonly note?: string | null /** @description Whether or not the card is archived */ - readonly archived?: boolean; - }; - }; - }; - }; - readonly "projects/move-card": { + readonly archived?: boolean + } + } + } + } + readonly 'projects/move-card': { readonly parameters: { readonly path: { /** card_id parameter */ - readonly card_id: components["parameters"]["card-id"]; - }; - }; + readonly card_id: components['parameters']['card-id'] + } + } readonly responses: { /** Response */ readonly 201: { readonly content: { - readonly "application/json": { readonly [key: string]: unknown }; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; + readonly 'application/json': { readonly [key: string]: unknown } + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] /** Forbidden */ readonly 403: { readonly content: { - readonly "application/json": { - readonly message?: string; - readonly documentation_url?: string; + readonly 'application/json': { + readonly message?: string + readonly documentation_url?: string readonly errors?: readonly { - readonly code?: string; - readonly message?: string; - readonly resource?: string; - readonly field?: string; - }[]; - }; - }; - }; - readonly 422: components["responses"]["validation_failed"]; + readonly code?: string + readonly message?: string + readonly resource?: string + readonly field?: string + }[] + } + } + } + readonly 422: components['responses']['validation_failed'] /** Response */ readonly 503: { readonly content: { - readonly "application/json": { - readonly code?: string; - readonly message?: string; - readonly documentation_url?: string; + readonly 'application/json': { + readonly code?: string + readonly message?: string + readonly documentation_url?: string readonly errors?: readonly { - readonly code?: string; - readonly message?: string; - }[]; - }; - }; - }; - }; + readonly code?: string + readonly message?: string + }[] + } + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card. * @example bottom */ - readonly position: string; + readonly position: string /** * @description The unique identifier of the column the card should be moved to * @example 42 */ - readonly column_id?: number; - }; - }; - }; - }; - readonly "projects/get-column": { + readonly column_id?: number + } + } + } + } + readonly 'projects/get-column': { readonly parameters: { readonly path: { /** column_id parameter */ - readonly column_id: components["parameters"]["column-id"]; - }; - }; + readonly column_id: components['parameters']['column-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["project-column"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "projects/delete-column": { + readonly 'application/json': components['schemas']['project-column'] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } + readonly 'projects/delete-column': { readonly parameters: { readonly path: { /** column_id parameter */ - readonly column_id: components["parameters"]["column-id"]; - }; - }; + readonly column_id: components['parameters']['column-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - }; - }; - readonly "projects/update-column": { + readonly 204: never + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + } + } + readonly 'projects/update-column': { readonly parameters: { readonly path: { /** column_id parameter */ - readonly column_id: components["parameters"]["column-id"]; - }; - }; + readonly column_id: components['parameters']['column-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["project-column"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - }; + readonly 'application/json': components['schemas']['project-column'] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description Name of the project column * @example Remaining tasks */ - readonly name: string; - }; - }; - }; - }; - readonly "projects/list-cards": { + readonly name: string + } + } + } + } + readonly 'projects/list-cards': { readonly parameters: { readonly path: { /** column_id parameter */ - readonly column_id: components["parameters"]["column-id"]; - }; + readonly column_id: components['parameters']['column-id'] + } readonly query: { /** Filters the project cards that are returned by the card's state. Can be one of `all`,`archived`, or `not_archived`. */ - readonly archived_state?: "all" | "archived" | "not_archived"; + readonly archived_state?: 'all' | 'archived' | 'not_archived' /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["project-card"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - }; - }; - readonly "projects/create-card": { + readonly 'application/json': readonly components['schemas']['project-card'][] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + } + } + readonly 'projects/create-card': { readonly parameters: { readonly path: { /** column_id parameter */ - readonly column_id: components["parameters"]["column-id"]; - }; - }; + readonly column_id: components['parameters']['column-id'] + } + } readonly responses: { /** Response */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["project-card"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + readonly 'application/json': components['schemas']['project-card'] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] /** Validation failed */ readonly 422: { readonly content: { - readonly "application/json": - | components["schemas"]["validation-error"] - | components["schemas"]["validation-error-simple"]; - }; - }; + readonly 'application/json': components['schemas']['validation-error'] | components['schemas']['validation-error-simple'] + } + } /** Response */ readonly 503: { readonly content: { - readonly "application/json": { - readonly code?: string; - readonly message?: string; - readonly documentation_url?: string; + readonly 'application/json': { + readonly code?: string + readonly message?: string + readonly documentation_url?: string readonly errors?: readonly { - readonly code?: string; - readonly message?: string; - }[]; - }; - }; - }; - }; + readonly code?: string + readonly message?: string + }[] + } + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": + readonly 'application/json': | { /** * @description The project card's note * @example Update all gems */ - readonly note: string | null; + readonly note: string | null } | { /** * @description The unique identifier of the content associated with the card * @example 42 */ - readonly content_id: number; + readonly content_id: number /** * @description The piece of content associated with the card * @example PullRequest */ - readonly content_type: string; - }; - }; - }; - }; - readonly "projects/move-column": { + readonly content_type: string + } + } + } + } + readonly 'projects/move-column': { readonly parameters: { readonly path: { /** column_id parameter */ - readonly column_id: components["parameters"]["column-id"]; - }; - }; + readonly column_id: components['parameters']['column-id'] + } + } readonly responses: { /** Response */ readonly 201: { readonly content: { - readonly "application/json": { readonly [key: string]: unknown }; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed_simple"]; - }; + readonly 'application/json': { readonly [key: string]: unknown } + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 422: components['responses']['validation_failed_simple'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column. * @example last */ - readonly position: string; - }; - }; - }; - }; + readonly position: string + } + } + } + } /** Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - readonly "projects/get": { + readonly 'projects/get': { readonly parameters: { readonly path: { - readonly project_id: components["parameters"]["project-id"]; - }; - }; + readonly project_id: components['parameters']['project-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["project"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - }; - }; + readonly 'application/json': components['schemas']['project'] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + } + } /** Deletes a project board. Returns a `404 Not Found` status if projects are disabled. */ - readonly "projects/delete": { + readonly 'projects/delete': { readonly parameters: { readonly path: { - readonly project_id: components["parameters"]["project-id"]; - }; - }; + readonly project_id: components['parameters']['project-id'] + } + } readonly responses: { /** Delete Success */ - readonly 204: never; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; + readonly 204: never + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] /** Forbidden */ readonly 403: { readonly content: { - readonly "application/json": { - readonly message?: string; - readonly documentation_url?: string; - readonly errors?: readonly string[]; - }; - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; - }; - }; + readonly 'application/json': { + readonly message?: string + readonly documentation_url?: string + readonly errors?: readonly string[] + } + } + } + readonly 404: components['responses']['not_found'] + readonly 410: components['responses']['gone'] + } + } /** Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - readonly "projects/update": { + readonly 'projects/update': { readonly parameters: { readonly path: { - readonly project_id: components["parameters"]["project-id"]; - }; - }; + readonly project_id: components['parameters']['project-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["project"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; + readonly 'application/json': components['schemas']['project'] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] /** Forbidden */ readonly 403: { readonly content: { - readonly "application/json": { - readonly message?: string; - readonly documentation_url?: string; - readonly errors?: readonly string[]; - }; - }; - }; + readonly 'application/json': { + readonly message?: string + readonly documentation_url?: string + readonly errors?: readonly string[] + } + } + } /** Not Found if the authenticated user does not have access to the project */ - readonly 404: unknown; - readonly 410: components["responses"]["gone"]; - readonly 422: components["responses"]["validation_failed_simple"]; - }; + readonly 404: unknown + readonly 410: components['responses']['gone'] + readonly 422: components['responses']['validation_failed_simple'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description Name of the project * @example Week One Sprint */ - readonly name?: string; + readonly name?: string /** * @description Body of the project * @example This project represents the sprint of the first week in January */ - readonly body?: string | null; + readonly body?: string | null /** * @description State of the project; either 'open' or 'closed' * @example open */ - readonly state?: string; + readonly state?: string /** * @description The baseline permission that all organization members have on this project * @enum {string} */ - readonly organization_permission?: "read" | "write" | "admin" | "none"; + readonly organization_permission?: 'read' | 'write' | 'admin' | 'none' /** @description Whether or not this project can be seen by everyone. */ - readonly private?: boolean; - }; - }; - }; - }; + readonly private?: boolean + } + } + } + } /** Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators. */ - readonly "projects/list-collaborators": { + readonly 'projects/list-collaborators': { readonly parameters: { readonly path: { - readonly project_id: components["parameters"]["project-id"]; - }; + readonly project_id: components['parameters']['project-id'] + } readonly query: { /** * Filters the collaborators by their affiliation. Can be one of: @@ -26109,483 +26088,483 @@ export interface operations { * \* `direct`: Collaborators with permissions to a project, regardless of organization membership status. * \* `all`: All collaborators the authenticated user can see. */ - readonly affiliation?: "outside" | "direct" | "all"; + readonly affiliation?: 'outside' | 'direct' | 'all' /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; + readonly 'application/json': readonly components['schemas']['simple-user'][] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } + } /** Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator. */ - readonly "projects/add-collaborator": { + readonly 'projects/add-collaborator': { readonly parameters: { readonly path: { - readonly project_id: components["parameters"]["project-id"]; - readonly username: components["parameters"]["username"]; - }; - }; + readonly project_id: components['parameters']['project-id'] + readonly username: components['parameters']['username'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 204: never + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description The permission to grant the collaborator. * @default write * @example write * @enum {string} */ - readonly permission?: "read" | "write" | "admin"; - } | null; - }; - }; - }; + readonly permission?: 'read' | 'write' | 'admin' + } | null + } + } + } /** Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator. */ - readonly "projects/remove-collaborator": { + readonly 'projects/remove-collaborator': { readonly parameters: { readonly path: { - readonly project_id: components["parameters"]["project-id"]; - readonly username: components["parameters"]["username"]; - }; - }; + readonly project_id: components['parameters']['project-id'] + readonly username: components['parameters']['username'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; + readonly 204: never + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } + } /** Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level. */ - readonly "projects/get-permission-for-user": { + readonly 'projects/get-permission-for-user': { readonly parameters: { readonly path: { - readonly project_id: components["parameters"]["project-id"]; - readonly username: components["parameters"]["username"]; - }; - }; + readonly project_id: components['parameters']['project-id'] + readonly username: components['parameters']['username'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["project-collaborator-permission"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; - readonly "projects/list-columns": { + readonly 'application/json': components['schemas']['project-collaborator-permission'] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } + } + readonly 'projects/list-columns': { readonly parameters: { readonly path: { - readonly project_id: components["parameters"]["project-id"]; - }; + readonly project_id: components['parameters']['project-id'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["project-column"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - }; - }; - readonly "projects/create-column": { + readonly 'application/json': readonly components['schemas']['project-column'][] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + } + } + readonly 'projects/create-column': { readonly parameters: { readonly path: { - readonly project_id: components["parameters"]["project-id"]; - }; - }; + readonly project_id: components['parameters']['project-id'] + } + } readonly responses: { /** Response */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["project-column"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed_simple"]; - }; + readonly 'application/json': components['schemas']['project-column'] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 422: components['responses']['validation_failed_simple'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description Name of the project column * @example Remaining tasks */ - readonly name: string; - }; - }; - }; - }; + readonly name: string + } + } + } + } /** * **Note:** Accessing this endpoint does not count against your REST API rate limit. * * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. */ - readonly "rate-limit/get": { - readonly parameters: {}; + readonly 'rate-limit/get': { + readonly parameters: {} readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": components["schemas"]["rate-limit-overview"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': components['schemas']['rate-limit-overview'] + } + } + readonly 304: components['responses']['not_modified'] + readonly 404: components['responses']['not_found'] + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Reactions API. We recommend migrating your existing code to use the new delete reactions endpoints. For more information, see this [blog post](https://developer.github.com/changes/2020-02-26-new-delete-reactions-endpoints/). * * OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), when deleting a [team discussion](https://docs.github.com/rest/reference/teams#discussions) or [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). */ - readonly "reactions/delete-legacy": { + readonly 'reactions/delete-legacy': { readonly parameters: { readonly path: { - readonly reaction_id: components["parameters"]["reaction-id"]; - }; - }; + readonly reaction_id: components['parameters']['reaction-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 410: components["responses"]["gone"]; - }; - }; + readonly 204: never + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 410: components['responses']['gone'] + } + } /** The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. */ - readonly "repos/get": { + readonly 'repos/get': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["full-repository"]; - }; - }; - readonly 301: components["responses"]["moved_permanently"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': components['schemas']['full-repository'] + } + } + readonly 301: components['responses']['moved_permanently'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } /** * Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required. * * If an organization owner has configured the organization to prevent members from deleting organization-owned * repositories, you will get a `403 Forbidden` response. */ - readonly "repos/delete": { + readonly 'repos/delete': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 307: components["responses"]["temporary_redirect"]; + readonly 204: never + readonly 307: components['responses']['temporary_redirect'] /** If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response: */ readonly 403: { readonly content: { - readonly "application/json": { - readonly message?: string; - readonly documentation_url?: string; - }; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': { + readonly message?: string + readonly documentation_url?: string + } + } + } + readonly 404: components['responses']['not_found'] + } + } /** **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/rest/reference/repos#replace-all-repository-topics) endpoint. */ - readonly "repos/update": { + readonly 'repos/update': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["full-repository"]; - }; - }; - readonly 307: components["responses"]["temporary_redirect"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': components['schemas']['full-repository'] + } + } + readonly 307: components['responses']['temporary_redirect'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The name of the repository. */ - readonly name?: string; + readonly name?: string /** @description A short description of the repository. */ - readonly description?: string; + readonly description?: string /** @description A URL with more information about the repository. */ - readonly homepage?: string; + readonly homepage?: string /** * @description Either `true` to make the repository private or `false` to make it public. Default: `false`. * **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. */ - readonly private?: boolean; + readonly private?: boolean /** * @description Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`." * @enum {string} */ - readonly visibility?: "public" | "private" | "internal"; + readonly visibility?: 'public' | 'private' | 'internal' /** @description Specify which security and analysis features to enable or disable. For example, to enable GitHub Advanced Security, use this data in the body of the PATCH request: `{"security_and_analysis": {"advanced_security": {"status": "enabled"}}}`. If you have admin permissions for a private repository covered by an Advanced Security license, you can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request. */ readonly security_and_analysis?: { /** @description Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see "[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security)." */ readonly advanced_security?: { /** @description Can be `enabled` or `disabled`. */ - readonly status?: string; - }; + readonly status?: string + } /** @description Use the `status` property to enable or disable secret scanning for this repository. For more information, see "[About secret scanning](/code-security/secret-security/about-secret-scanning)." */ readonly secret_scanning?: { /** @description Can be `enabled` or `disabled`. */ - readonly status?: string; - }; - } | null; + readonly status?: string + } + } | null /** * @description Either `true` to enable issues for this repository or `false` to disable them. * @default true */ - readonly has_issues?: boolean; + readonly has_issues?: boolean /** * @description Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error. * @default true */ - readonly has_projects?: boolean; + readonly has_projects?: boolean /** * @description Either `true` to enable the wiki for this repository or `false` to disable it. * @default true */ - readonly has_wiki?: boolean; + readonly has_wiki?: boolean /** @description Either `true` to make this repo available as a template repository or `false` to prevent it. */ - readonly is_template?: boolean; + readonly is_template?: boolean /** @description Updates the default branch for this repository. */ - readonly default_branch?: string; + readonly default_branch?: string /** * @description Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. * @default true */ - readonly allow_squash_merge?: boolean; + readonly allow_squash_merge?: boolean /** * @description Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. * @default true */ - readonly allow_merge_commit?: boolean; + readonly allow_merge_commit?: boolean /** * @description Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. * @default true */ - readonly allow_rebase_merge?: boolean; + readonly allow_rebase_merge?: boolean /** @description Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. */ - readonly allow_auto_merge?: boolean; + readonly allow_auto_merge?: boolean /** @description Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. */ - readonly delete_branch_on_merge?: boolean; + readonly delete_branch_on_merge?: boolean /** @description `true` to archive this repository. **Note**: You cannot unarchive repositories through the API. */ - readonly archived?: boolean; + readonly archived?: boolean /** @description Either `true` to allow private forks, or `false` to prevent private forks. */ - readonly allow_forking?: boolean; - }; - }; - }; - }; + readonly allow_forking?: boolean + } + } + } + } /** Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - readonly "actions/list-artifacts-for-repo": { + readonly 'actions/list-artifacts-for-repo': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": { - readonly total_count: number; - readonly artifacts: readonly components["schemas"]["artifact"][]; - }; - }; - }; - }; - }; + readonly 'application/json': { + readonly total_count: number + readonly artifacts: readonly components['schemas']['artifact'][] + } + } + } + } + } /** Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - readonly "actions/get-artifact": { + readonly 'actions/get-artifact': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** artifact_id parameter */ - readonly artifact_id: components["parameters"]["artifact-id"]; - }; - }; + readonly artifact_id: components['parameters']['artifact-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["artifact"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['artifact'] + } + } + } + } /** Deletes an artifact for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - readonly "actions/delete-artifact": { + readonly 'actions/delete-artifact': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** artifact_id parameter */ - readonly artifact_id: components["parameters"]["artifact-id"]; - }; - }; + readonly artifact_id: components['parameters']['artifact-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** * Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in * the response header to find the URL for the download. The `:archive_format` must be `zip`. Anyone with read access to * the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:read` permission to use this endpoint. */ - readonly "actions/download-artifact": { + readonly 'actions/download-artifact': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** artifact_id parameter */ - readonly artifact_id: components["parameters"]["artifact-id"]; - readonly archive_format: string; - }; - }; + readonly artifact_id: components['parameters']['artifact-id'] + readonly archive_format: string + } + } readonly responses: { /** Response */ - readonly 302: never; - }; - }; + readonly 302: never + } + } /** Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - readonly "actions/get-job-for-workflow-run": { + readonly 'actions/get-job-for-workflow-run': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** job_id parameter */ - readonly job_id: components["parameters"]["job-id"]; - }; - }; + readonly job_id: components['parameters']['job-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["job"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['job'] + } + } + } + } /** * Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look * for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can * use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must * have the `actions:read` permission to use this endpoint. */ - readonly "actions/download-job-logs-for-workflow-run": { + readonly 'actions/download-job-logs-for-workflow-run': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** job_id parameter */ - readonly job_id: components["parameters"]["job-id"]; - }; - }; + readonly job_id: components['parameters']['job-id'] + } + } readonly responses: { /** Response */ - readonly 302: never; - }; - }; + readonly 302: never + } + } /** * Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository. * * You must authenticate using an access token with the `repo` scope to use this * endpoint. GitHub Apps must have the `administration` repository permission to use this API. */ - readonly "actions/get-github-actions-permissions-repository": { + readonly 'actions/get-github-actions-permissions-repository': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["actions-repository-permissions"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['actions-repository-permissions'] + } + } + } + } /** * Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository. * @@ -26593,47 +26572,47 @@ export interface operations { * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. */ - readonly "actions/set-github-actions-permissions-repository": { + readonly 'actions/set-github-actions-permissions-repository': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; + readonly 204: never + } readonly requestBody: { readonly content: { - readonly "application/json": { - readonly enabled: components["schemas"]["actions-enabled"]; - readonly allowed_actions?: components["schemas"]["allowed-actions"]; - }; - }; - }; - }; + readonly 'application/json': { + readonly enabled: components['schemas']['actions-enabled'] + readonly allowed_actions?: components['schemas']['allowed-actions'] + } + } + } + } /** * Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. */ - readonly "actions/get-allowed-actions-repository": { + readonly 'actions/get-allowed-actions-repository': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["selected-actions"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['selected-actions'] + } + } + } + } /** * Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." * @@ -26643,71 +26622,71 @@ export interface operations { * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. */ - readonly "actions/set-allowed-actions-repository": { + readonly 'actions/set-allowed-actions-repository': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; + readonly 204: never + } readonly requestBody: { readonly content: { - readonly "application/json": components["schemas"]["selected-actions"]; - }; - }; - }; + readonly 'application/json': components['schemas']['selected-actions'] + } + } + } /** Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. */ - readonly "actions/list-self-hosted-runners-for-repo": { + readonly 'actions/list-self-hosted-runners-for-repo': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": { - readonly total_count: number; - readonly runners: readonly components["schemas"]["runner"][]; - }; - }; - }; - }; - }; + readonly 'application/json': { + readonly total_count: number + readonly runners: readonly components['schemas']['runner'][] + } + } + } + } + } /** * Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `repo` scope to use this endpoint. */ - readonly "actions/list-runner-applications-for-repo": { + readonly 'actions/list-runner-applications-for-repo': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["runner-application"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['runner-application'][] + } + } + } + } /** * Returns a token that you can pass to the `config` script. The token expires after one hour. You must authenticate * using an access token with the `repo` scope to use this endpoint. @@ -26720,22 +26699,22 @@ export interface operations { * ./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN * ``` */ - readonly "actions/create-registration-token-for-repo": { + readonly 'actions/create-registration-token-for-repo': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["authentication-token"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['authentication-token'] + } + } + } + } /** * Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour. * You must authenticate using an access token with the `repo` scope to use this endpoint. @@ -26748,86 +26727,86 @@ export interface operations { * ./config.sh remove --token TOKEN * ``` */ - readonly "actions/create-remove-token-for-repo": { + readonly 'actions/create-remove-token-for-repo': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["authentication-token"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['authentication-token'] + } + } + } + } /** * Gets a specific self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - readonly "actions/get-self-hosted-runner-for-repo": { + readonly 'actions/get-self-hosted-runner-for-repo': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; - }; - }; + readonly runner_id: components['parameters']['runner-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["runner"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['runner'] + } + } + } + } /** * Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * * You must authenticate using an access token with the `repo` * scope to use this endpoint. */ - readonly "actions/delete-self-hosted-runner-from-repo": { + readonly 'actions/delete-self-hosted-runner-from-repo': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; - }; - }; + readonly runner_id: components['parameters']['runner-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** * Lists all labels for a self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - readonly "actions/list-labels-for-self-hosted-runner-for-repo": { + readonly 'actions/list-labels-for-self-hosted-runner-for-repo': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; - }; - }; + readonly runner_id: components['parameters']['runner-id'] + } + } readonly responses: { - readonly 200: components["responses"]["actions_runner_labels"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 200: components['responses']['actions_runner_labels'] + readonly 404: components['responses']['not_found'] + } + } /** * Remove all previous custom labels and set the new custom labels for a specific * self-hosted runner configured in a repository. @@ -26835,58 +26814,58 @@ export interface operations { * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - readonly "actions/set-custom-labels-for-self-hosted-runner-for-repo": { + readonly 'actions/set-custom-labels-for-self-hosted-runner-for-repo': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; - }; - }; - readonly responses: { - readonly 200: components["responses"]["actions_runner_labels"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; - }; + readonly runner_id: components['parameters']['runner-id'] + } + } + readonly responses: { + readonly 200: components['responses']['actions_runner_labels'] + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed_simple'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels. */ - readonly labels: readonly string[]; - }; - }; - }; - }; + readonly labels: readonly string[] + } + } + } + } /** * Add custom labels to a self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - readonly "actions/add-custom-labels-to-self-hosted-runner-for-repo": { + readonly 'actions/add-custom-labels-to-self-hosted-runner-for-repo': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; - }; - }; - readonly responses: { - readonly 200: components["responses"]["actions_runner_labels"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; - }; + readonly runner_id: components['parameters']['runner-id'] + } + } + readonly responses: { + readonly 200: components['responses']['actions_runner_labels'] + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed_simple'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The names of the custom labels to add to the runner. */ - readonly labels: readonly string[]; - }; - }; - }; - }; + readonly labels: readonly string[] + } + } + } + } /** * Remove all custom labels from a self-hosted runner configured in a * repository. Returns the remaining read-only labels from the runner. @@ -26894,20 +26873,20 @@ export interface operations { * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - readonly "actions/remove-all-custom-labels-from-self-hosted-runner-for-repo": { + readonly 'actions/remove-all-custom-labels-from-self-hosted-runner-for-repo': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; - }; - }; + readonly runner_id: components['parameters']['runner-id'] + } + } readonly responses: { - readonly 200: components["responses"]["actions_runner_labels_readonly"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 200: components['responses']['actions_runner_labels_readonly'] + readonly 404: components['responses']['not_found'] + } + } /** * Remove a custom label from a self-hosted runner configured * in a repository. Returns the remaining labels from the runner. @@ -26918,531 +26897,531 @@ export interface operations { * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - readonly "actions/remove-custom-label-from-self-hosted-runner-for-repo": { + readonly 'actions/remove-custom-label-from-self-hosted-runner-for-repo': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; + readonly runner_id: components['parameters']['runner-id'] /** The name of a self-hosted runner's custom label. */ - readonly name: components["parameters"]["runner-label-name"]; - }; - }; + readonly name: components['parameters']['runner-label-name'] + } + } readonly responses: { - readonly 200: components["responses"]["actions_runner_labels"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; - }; - }; + readonly 200: components['responses']['actions_runner_labels'] + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed_simple'] + } + } /** * Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). * * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - readonly "actions/list-workflow-runs-for-repo": { + readonly 'actions/list-workflow-runs-for-repo': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } readonly query: { /** Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ - readonly actor?: components["parameters"]["actor"]; + readonly actor?: components['parameters']['actor'] /** Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ - readonly branch?: components["parameters"]["workflow-run-branch"]; + readonly branch?: components['parameters']['workflow-run-branch'] /** Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ - readonly event?: components["parameters"]["event"]; + readonly event?: components['parameters']['event'] /** Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. For a list of the possible `status` and `conclusion` options, see "[Create a check run](https://docs.github.com/rest/reference/checks#create-a-check-run)." */ - readonly status?: components["parameters"]["workflow-run-status"]; + readonly status?: components['parameters']['workflow-run-status'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; + readonly page?: components['parameters']['page'] /** Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ - readonly created?: components["parameters"]["created"]; + readonly created?: components['parameters']['created'] /** If `true` pull requests are omitted from the response (empty array). */ - readonly exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; + readonly exclude_pull_requests?: components['parameters']['exclude-pull-requests'] /** Returns workflow runs with the `check_suite_id` that you specify. */ - readonly check_suite_id?: components["parameters"]["workflow-run-check-suite-id"]; - }; - }; + readonly check_suite_id?: components['parameters']['workflow-run-check-suite-id'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": { - readonly total_count: number; - readonly workflow_runs: readonly components["schemas"]["workflow-run"][]; - }; - }; - }; - }; - }; + readonly 'application/json': { + readonly total_count: number + readonly workflow_runs: readonly components['schemas']['workflow-run'][] + } + } + } + } + } /** Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - readonly "actions/get-workflow-run": { + readonly 'actions/get-workflow-run': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The id of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; - }; + readonly run_id: components['parameters']['run-id'] + } readonly query: { /** If `true` pull requests are omitted from the response (empty array). */ - readonly exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; - }; - }; + readonly exclude_pull_requests?: components['parameters']['exclude-pull-requests'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["workflow-run"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['workflow-run'] + } + } + } + } /** * Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is * private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:write` permission to use * this endpoint. */ - readonly "actions/delete-workflow-run": { + readonly 'actions/delete-workflow-run': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The id of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; - }; - }; + readonly run_id: components['parameters']['run-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - readonly "actions/get-reviews-for-run": { + readonly 'actions/get-reviews-for-run': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The id of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; - }; - }; + readonly run_id: components['parameters']['run-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["environment-approvals"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['environment-approvals'][] + } + } + } + } /** * Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)." * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - readonly "actions/approve-workflow-run": { + readonly 'actions/approve-workflow-run': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The id of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; - }; - }; + readonly run_id: components['parameters']['run-id'] + } + } readonly responses: { /** Response */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["empty-object"]; - }; - }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': components['schemas']['empty-object'] + } + } + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } /** Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - readonly "actions/list-workflow-run-artifacts": { + readonly 'actions/list-workflow-run-artifacts': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The id of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; - }; + readonly run_id: components['parameters']['run-id'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": { - readonly total_count: number; - readonly artifacts: readonly components["schemas"]["artifact"][]; - }; - }; - }; - }; - }; + readonly 'application/json': { + readonly total_count: number + readonly artifacts: readonly components['schemas']['artifact'][] + } + } + } + } + } /** * Gets a specific workflow run attempt. Anyone with read access to the repository * can use this endpoint. If the repository is private you must use an access token * with the `repo` scope. GitHub Apps must have the `actions:read` permission to * use this endpoint. */ - readonly "actions/get-workflow-run-attempt": { + readonly 'actions/get-workflow-run-attempt': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The id of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; + readonly run_id: components['parameters']['run-id'] /** The attempt number of the workflow run. */ - readonly attempt_number: components["parameters"]["attempt-number"]; - }; + readonly attempt_number: components['parameters']['attempt-number'] + } readonly query: { /** If `true` pull requests are omitted from the response (empty array). */ - readonly exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; - }; - }; + readonly exclude_pull_requests?: components['parameters']['exclude-pull-requests'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["workflow-run"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['workflow-run'] + } + } + } + } /** Lists jobs for a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). */ - readonly "actions/list-jobs-for-workflow-run-attempt": { + readonly 'actions/list-jobs-for-workflow-run-attempt': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The id of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; + readonly run_id: components['parameters']['run-id'] /** The attempt number of the workflow run. */ - readonly attempt_number: components["parameters"]["attempt-number"]; - }; + readonly attempt_number: components['parameters']['attempt-number'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": { - readonly total_count: number; - readonly jobs: readonly components["schemas"]["job"][]; - }; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': { + readonly total_count: number + readonly jobs: readonly components['schemas']['job'][] + } + } + } + readonly 404: components['responses']['not_found'] + } + } /** * Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after * 1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to * the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:read` permission to use this endpoint. */ - readonly "actions/download-workflow-run-attempt-logs": { + readonly 'actions/download-workflow-run-attempt-logs': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The id of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; + readonly run_id: components['parameters']['run-id'] /** The attempt number of the workflow run. */ - readonly attempt_number: components["parameters"]["attempt-number"]; - }; - }; + readonly attempt_number: components['parameters']['attempt-number'] + } + } readonly responses: { /** Response */ - readonly 302: never; - }; - }; + readonly 302: never + } + } /** Cancels a workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - readonly "actions/cancel-workflow-run": { + readonly 'actions/cancel-workflow-run': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The id of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; - }; - }; + readonly run_id: components['parameters']['run-id'] + } + } readonly responses: { /** Response */ readonly 202: { readonly content: { - readonly "application/json": { readonly [key: string]: unknown }; - }; - }; - }; - }; + readonly 'application/json': { readonly [key: string]: unknown } + } + } + } + } /** Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). */ - readonly "actions/list-jobs-for-workflow-run": { + readonly 'actions/list-jobs-for-workflow-run': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The id of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; - }; + readonly run_id: components['parameters']['run-id'] + } readonly query: { /** * Filters jobs by their `completed_at` timestamp. Can be one of: * \* `latest`: Returns jobs from the most recent execution of the workflow run. * \* `all`: Returns all jobs for a workflow run, including from old executions of the workflow run. */ - readonly filter?: "latest" | "all"; + readonly filter?: 'latest' | 'all' /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": { - readonly total_count: number; - readonly jobs: readonly components["schemas"]["job"][]; - }; - }; - }; - }; - }; + readonly 'application/json': { + readonly total_count: number + readonly jobs: readonly components['schemas']['job'][] + } + } + } + } + } /** * Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for * `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use * this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have * the `actions:read` permission to use this endpoint. */ - readonly "actions/download-workflow-run-logs": { + readonly 'actions/download-workflow-run-logs': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The id of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; - }; - }; + readonly run_id: components['parameters']['run-id'] + } + } readonly responses: { /** Response */ - readonly 302: never; - }; - }; + readonly 302: never + } + } /** Deletes all logs for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - readonly "actions/delete-workflow-run-logs": { + readonly 'actions/delete-workflow-run-logs': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The id of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; - }; - }; + readonly run_id: components['parameters']['run-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 403: components["responses"]["forbidden"]; - readonly 500: components["responses"]["internal_error"]; - }; - }; + readonly 204: never + readonly 403: components['responses']['forbidden'] + readonly 500: components['responses']['internal_error'] + } + } /** * Get all deployment environments for a workflow run that are waiting for protection rules to pass. * * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - readonly "actions/get-pending-deployments-for-run": { + readonly 'actions/get-pending-deployments-for-run': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The id of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; - }; - }; + readonly run_id: components['parameters']['run-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["pending-deployment"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['pending-deployment'][] + } + } + } + } /** * Approve or reject pending deployments that are waiting on approval by a required reviewer. * * Anyone with read access to the repository contents and deployments can use this endpoint. */ - readonly "actions/review-pending-deployments-for-run": { + readonly 'actions/review-pending-deployments-for-run': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The id of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; - }; - }; + readonly run_id: components['parameters']['run-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["deployment"][]; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['deployment'][] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description The list of environment ids to approve or reject * @example 161171787,161171795 */ - readonly environment_ids: readonly number[]; + readonly environment_ids: readonly number[] /** * @description Whether to approve or reject deployment to the specified environments. Must be one of: `approved` or `rejected` * @example approved * @enum {string} */ - readonly state: "approved" | "rejected"; + readonly state: 'approved' | 'rejected' /** * @description A comment to accompany the deployment review * @example Ship it! */ - readonly comment: string; - }; - }; - }; - }; + readonly comment: string + } + } + } + } /** Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - readonly "actions/re-run-workflow": { + readonly 'actions/re-run-workflow': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The id of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; - }; - }; + readonly run_id: components['parameters']['run-id'] + } + } readonly responses: { /** Response */ readonly 201: { readonly content: { - readonly "application/json": { readonly [key: string]: unknown }; - }; - }; - }; - }; + readonly 'application/json': { readonly [key: string]: unknown } + } + } + } + } /** * Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - readonly "actions/get-workflow-run-usage": { + readonly 'actions/get-workflow-run-usage': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The id of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; - }; - }; + readonly run_id: components['parameters']['run-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["workflow-run-usage"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['workflow-run-usage'] + } + } + } + } /** Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - readonly "actions/list-repo-secrets": { + readonly 'actions/list-repo-secrets': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": { - readonly total_count: number; - readonly secrets: readonly components["schemas"]["actions-secret"][]; - }; - }; - }; - }; - }; + readonly 'application/json': { + readonly total_count: number + readonly secrets: readonly components['schemas']['actions-secret'][] + } + } + } + } + } /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - readonly "actions/get-repo-public-key": { + readonly 'actions/get-repo-public-key': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["actions-public-key"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['actions-public-key'] + } + } + } + } /** Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - readonly "actions/get-repo-secret": { + readonly 'actions/get-repo-secret': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** secret_name parameter */ - readonly secret_name: components["parameters"]["secret-name"]; - }; - }; + readonly secret_name: components['parameters']['secret-name'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["actions-secret"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['actions-secret'] + } + } + } + } /** * Creates or updates a repository secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -27520,116 +27499,116 @@ export interface operations { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - readonly "actions/create-or-update-repo-secret": { + readonly 'actions/create-or-update-repo-secret': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** secret_name parameter */ - readonly secret_name: components["parameters"]["secret-name"]; - }; - }; + readonly secret_name: components['parameters']['secret-name'] + } + } readonly responses: { /** Response when creating a secret */ readonly 201: { readonly content: { - readonly "application/json": { readonly [key: string]: unknown }; - }; - }; + readonly 'application/json': { readonly [key: string]: unknown } + } + } /** Response when updating a secret */ - readonly 204: never; - }; + readonly 204: never + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/reference/actions#get-a-repository-public-key) endpoint. */ - readonly encrypted_value?: string; + readonly encrypted_value?: string /** @description ID of the key you used to encrypt the secret. */ - readonly key_id?: string; - }; - }; - }; - }; + readonly key_id?: string + } + } + } + } /** Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - readonly "actions/delete-repo-secret": { + readonly 'actions/delete-repo-secret': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** secret_name parameter */ - readonly secret_name: components["parameters"]["secret-name"]; - }; - }; + readonly secret_name: components['parameters']['secret-name'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - readonly "actions/list-repo-workflows": { + readonly 'actions/list-repo-workflows': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": { - readonly total_count: number; - readonly workflows: readonly components["schemas"]["workflow"][]; - }; - }; - }; - }; - }; + readonly 'application/json': { + readonly total_count: number + readonly workflows: readonly components['schemas']['workflow'][] + } + } + } + } + } /** Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - readonly "actions/get-workflow": { + readonly 'actions/get-workflow': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The ID of the workflow. You can also pass the workflow file name as a string. */ - readonly workflow_id: components["parameters"]["workflow-id"]; - }; - }; + readonly workflow_id: components['parameters']['workflow-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["workflow"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['workflow'] + } + } + } + } /** * Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - readonly "actions/disable-workflow": { + readonly 'actions/disable-workflow': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The ID of the workflow. You can also pass the workflow file name as a string. */ - readonly workflow_id: components["parameters"]["workflow-id"]; - }; - }; + readonly workflow_id: components['parameters']['workflow-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** * You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * @@ -27637,144 +27616,144 @@ export interface operations { * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)." */ - readonly "actions/create-workflow-dispatch": { + readonly 'actions/create-workflow-dispatch': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The ID of the workflow. You can also pass the workflow file name as a string. */ - readonly workflow_id: components["parameters"]["workflow-id"]; - }; - }; + readonly workflow_id: components['parameters']['workflow-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; + readonly 204: never + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The git reference for the workflow. The reference can be a branch or tag name. */ - readonly ref: string; + readonly ref: string /** @description Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted. */ - readonly inputs?: { readonly [key: string]: string }; - }; - }; - }; - }; + readonly inputs?: { readonly [key: string]: string } + } + } + } + } /** * Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - readonly "actions/enable-workflow": { + readonly 'actions/enable-workflow': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The ID of the workflow. You can also pass the workflow file name as a string. */ - readonly workflow_id: components["parameters"]["workflow-id"]; - }; - }; + readonly workflow_id: components['parameters']['workflow-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** * List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). * * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. */ - readonly "actions/list-workflow-runs": { + readonly 'actions/list-workflow-runs': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The ID of the workflow. You can also pass the workflow file name as a string. */ - readonly workflow_id: components["parameters"]["workflow-id"]; - }; + readonly workflow_id: components['parameters']['workflow-id'] + } readonly query: { /** Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ - readonly actor?: components["parameters"]["actor"]; + readonly actor?: components['parameters']['actor'] /** Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ - readonly branch?: components["parameters"]["workflow-run-branch"]; + readonly branch?: components['parameters']['workflow-run-branch'] /** Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ - readonly event?: components["parameters"]["event"]; + readonly event?: components['parameters']['event'] /** Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. For a list of the possible `status` and `conclusion` options, see "[Create a check run](https://docs.github.com/rest/reference/checks#create-a-check-run)." */ - readonly status?: components["parameters"]["workflow-run-status"]; + readonly status?: components['parameters']['workflow-run-status'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; + readonly page?: components['parameters']['page'] /** Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ - readonly created?: components["parameters"]["created"]; + readonly created?: components['parameters']['created'] /** If `true` pull requests are omitted from the response (empty array). */ - readonly exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; + readonly exclude_pull_requests?: components['parameters']['exclude-pull-requests'] /** Returns workflow runs with the `check_suite_id` that you specify. */ - readonly check_suite_id?: components["parameters"]["workflow-run-check-suite-id"]; - }; - }; + readonly check_suite_id?: components['parameters']['workflow-run-check-suite-id'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": { - readonly total_count: number; - readonly workflow_runs: readonly components["schemas"]["workflow-run"][]; - }; - }; - }; - }; - }; + readonly 'application/json': { + readonly total_count: number + readonly workflow_runs: readonly components['schemas']['workflow-run'][] + } + } + } + } + } /** * Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * * You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - readonly "actions/get-workflow-usage": { + readonly 'actions/get-workflow-usage': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The ID of the workflow. You can also pass the workflow file name as a string. */ - readonly workflow_id: components["parameters"]["workflow-id"]; - }; - }; + readonly workflow_id: components['parameters']['workflow-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["workflow-usage"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['workflow-usage'] + } + } + } + } /** Lists the [available assignees](https://docs.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. */ - readonly "issues/list-assignees": { + readonly 'issues/list-assignees': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': readonly components['schemas']['simple-user'][] + } + } + readonly 404: components['responses']['not_found'] + } + } /** * Checks if a user has permission to be assigned to an issue in this repository. * @@ -27782,218 +27761,218 @@ export interface operations { * * Otherwise a `404` status code is returned. */ - readonly "issues/check-user-can-be-assigned": { + readonly 'issues/check-user-can-be-assigned': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly assignee: string; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly assignee: string + } + } readonly responses: { /** If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. */ - readonly 204: never; + readonly 204: never /** Otherwise a `404` status code is returned. */ readonly 404: { readonly content: { - readonly "application/json": components["schemas"]["basic-error"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['basic-error'] + } + } + } + } /** * This returns a list of autolinks configured for the given repository. * * Information about autolinks are only available to repository administrators. */ - readonly "repos/list-autolinks": { + readonly 'repos/list-autolinks': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } readonly query: { /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["autolink"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['autolink'][] + } + } + } + } /** Users with admin access to the repository can create an autolink. */ - readonly "repos/create-autolink": { + readonly 'repos/create-autolink': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** response */ readonly 201: { readonly headers: { - readonly Location?: string; - }; - readonly content: { - readonly "application/json": components["schemas"]["autolink"]; - }; - }; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly Location?: string + } + readonly content: { + readonly 'application/json': components['schemas']['autolink'] + } + } + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit. */ - readonly key_prefix: string; + readonly key_prefix: string /** @description The URL must contain for the reference number. */ - readonly url_template: string; - }; - }; - }; - }; + readonly url_template: string + } + } + } + } /** * This returns a single autolink reference by ID that was configured for the given repository. * * Information about autolinks are only available to repository administrators. */ - readonly "repos/get-autolink": { + readonly 'repos/get-autolink': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** autolink_id parameter */ - readonly autolink_id: components["parameters"]["autolink-id"]; - }; - }; + readonly autolink_id: components['parameters']['autolink-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["autolink"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': components['schemas']['autolink'] + } + } + readonly 404: components['responses']['not_found'] + } + } /** * This deletes a single autolink reference by ID that was configured for the given repository. * * Information about autolinks are only available to repository administrators. */ - readonly "repos/delete-autolink": { + readonly 'repos/delete-autolink': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** autolink_id parameter */ - readonly autolink_id: components["parameters"]["autolink-id"]; - }; - }; + readonly autolink_id: components['parameters']['autolink-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 204: never + readonly 404: components['responses']['not_found'] + } + } /** Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/en/articles/configuring-automated-security-fixes)". */ - readonly "repos/enable-automated-security-fixes": { + readonly 'repos/enable-automated-security-fixes': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/en/articles/configuring-automated-security-fixes)". */ - readonly "repos/disable-automated-security-fixes": { + readonly 'repos/disable-automated-security-fixes': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; - readonly "repos/list-branches": { + readonly 204: never + } + } + readonly 'repos/list-branches': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } readonly query: { /** Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches. */ - readonly protected?: boolean; + readonly protected?: boolean /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["short-branch"][]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "repos/get-branch": { + readonly 'application/json': readonly components['schemas']['short-branch'][] + } + } + readonly 404: components['responses']['not_found'] + } + } + readonly 'repos/get-branch': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The name of the branch. */ - readonly branch: components["parameters"]["branch"]; - }; - }; + readonly branch: components['parameters']['branch'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["branch-with-protection"]; - }; - }; - readonly 301: components["responses"]["moved_permanently"]; - readonly 404: components["responses"]["not_found"]; - readonly 415: components["responses"]["preview_header_missing"]; - }; - }; + readonly 'application/json': components['schemas']['branch-with-protection'] + } + } + readonly 301: components['responses']['moved_permanently'] + readonly 404: components['responses']['not_found'] + readonly 415: components['responses']['preview_header_missing'] + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly "repos/get-branch-protection": { + readonly 'repos/get-branch-protection': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The name of the branch. */ - readonly branch: components["parameters"]["branch"]; - }; - }; + readonly branch: components['parameters']['branch'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["branch-protection"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': components['schemas']['branch-protection'] + } + } + readonly 404: components['responses']['not_found'] + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28003,205 +27982,205 @@ export interface operations { * * **Note**: The list of users, apps, and teams in total is limited to 100 items. */ - readonly "repos/update-branch-protection": { + readonly 'repos/update-branch-protection': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The name of the branch. */ - readonly branch: components["parameters"]["branch"]; - }; - }; + readonly branch: components['parameters']['branch'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["protected-branch"]; - }; - }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; - }; + readonly 'application/json': components['schemas']['protected-branch'] + } + } + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed_simple'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Require status checks to pass before merging. Set to `null` to disable. */ readonly required_status_checks: { /** @description Require branches to be up to date before merging. */ - readonly strict: boolean; + readonly strict: boolean /** * @deprecated * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. */ - readonly contexts: readonly string[]; + readonly contexts: readonly string[] /** @description The list of status checks to require in order to merge into this branch. */ readonly checks?: readonly { /** @description The name of the required check */ - readonly context: string; + readonly context: string /** @description The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status. */ - readonly app_id?: number; - }[]; - } | null; + readonly app_id?: number + }[] + } | null /** @description Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable. */ - readonly enforce_admins: boolean | null; + readonly enforce_admins: boolean | null /** @description Require at least one approving review on a pull request, before merging. Set to `null` to disable. */ readonly required_pull_request_reviews: { /** @description Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories. */ readonly dismissal_restrictions?: { /** @description The list of user `login`s with dismissal access */ - readonly users?: readonly string[]; + readonly users?: readonly string[] /** @description The list of team `slug`s with dismissal access */ - readonly teams?: readonly string[]; - }; + readonly teams?: readonly string[] + } /** @description Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit. */ - readonly dismiss_stale_reviews?: boolean; + readonly dismiss_stale_reviews?: boolean /** @description Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them. */ - readonly require_code_owner_reviews?: boolean; + readonly require_code_owner_reviews?: boolean /** @description Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers. */ - readonly required_approving_review_count?: number; + readonly required_approving_review_count?: number /** @description Allow specific users or teams to bypass pull request requirements. Set to `null` to disable. */ readonly bypass_pull_request_allowances?: { /** @description The list of user `login`s allowed to bypass pull request requirements. */ - readonly users?: readonly string[]; + readonly users?: readonly string[] /** @description The list of team `slug`s allowed to bypass pull request requirements. */ - readonly teams?: readonly string[]; - } | null; - } | null; + readonly teams?: readonly string[] + } | null + } | null /** @description Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable. */ readonly restrictions: { /** @description The list of user `login`s with push access */ - readonly users: readonly string[]; + readonly users: readonly string[] /** @description The list of team `slug`s with push access */ - readonly teams: readonly string[]; + readonly teams: readonly string[] /** @description The list of app `slug`s with push access */ - readonly apps?: readonly string[]; - } | null; + readonly apps?: readonly string[] + } | null /** @description Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see "[Requiring a linear commit history](https://docs.github.com/github/administering-a-repository/requiring-a-linear-commit-history)" in the GitHub Help documentation. */ - readonly required_linear_history?: boolean; + readonly required_linear_history?: boolean /** @description Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation." */ - readonly allow_force_pushes?: boolean | null; + readonly allow_force_pushes?: boolean | null /** @description Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation. */ - readonly allow_deletions?: boolean; + readonly allow_deletions?: boolean /** @description Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`. */ - readonly required_conversation_resolution?: boolean; - }; - }; - }; - }; + readonly required_conversation_resolution?: boolean + } + } + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly "repos/delete-branch-protection": { + readonly 'repos/delete-branch-protection': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The name of the branch. */ - readonly branch: components["parameters"]["branch"]; - }; - }; + readonly branch: components['parameters']['branch'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 403: components["responses"]["forbidden"]; - }; - }; + readonly 204: never + readonly 403: components['responses']['forbidden'] + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly "repos/get-admin-branch-protection": { + readonly 'repos/get-admin-branch-protection': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The name of the branch. */ - readonly branch: components["parameters"]["branch"]; - }; - }; + readonly branch: components['parameters']['branch'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["protected-branch-admin-enforced"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['protected-branch-admin-enforced'] + } + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ - readonly "repos/set-admin-branch-protection": { + readonly 'repos/set-admin-branch-protection': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The name of the branch. */ - readonly branch: components["parameters"]["branch"]; - }; - }; + readonly branch: components['parameters']['branch'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["protected-branch-admin-enforced"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['protected-branch-admin-enforced'] + } + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ - readonly "repos/delete-admin-branch-protection": { + readonly 'repos/delete-admin-branch-protection': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The name of the branch. */ - readonly branch: components["parameters"]["branch"]; - }; - }; + readonly branch: components['parameters']['branch'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 204: never + readonly 404: components['responses']['not_found'] + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly "repos/get-pull-request-review-protection": { + readonly 'repos/get-pull-request-review-protection': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The name of the branch. */ - readonly branch: components["parameters"]["branch"]; - }; - }; + readonly branch: components['parameters']['branch'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["protected-branch-pull-request-review"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['protected-branch-pull-request-review'] + } + } + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly "repos/delete-pull-request-review-protection": { + readonly 'repos/delete-pull-request-review-protection': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The name of the branch. */ - readonly branch: components["parameters"]["branch"]; - }; - }; + readonly branch: components['parameters']['branch'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 204: never + readonly 404: components['responses']['not_found'] + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28209,51 +28188,51 @@ export interface operations { * * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. */ - readonly "repos/update-pull-request-review-protection": { + readonly 'repos/update-pull-request-review-protection': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The name of the branch. */ - readonly branch: components["parameters"]["branch"]; - }; - }; + readonly branch: components['parameters']['branch'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["protected-branch-pull-request-review"]; - }; - }; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': components['schemas']['protected-branch-pull-request-review'] + } + } + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories. */ readonly dismissal_restrictions?: { /** @description The list of user `login`s with dismissal access */ - readonly users?: readonly string[]; + readonly users?: readonly string[] /** @description The list of team `slug`s with dismissal access */ - readonly teams?: readonly string[]; - }; + readonly teams?: readonly string[] + } /** @description Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit. */ - readonly dismiss_stale_reviews?: boolean; + readonly dismiss_stale_reviews?: boolean /** @description Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) have reviewed. */ - readonly require_code_owner_reviews?: boolean; + readonly require_code_owner_reviews?: boolean /** @description Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers. */ - readonly required_approving_review_count?: number; + readonly required_approving_review_count?: number /** @description Allow specific users or teams to bypass pull request requirements. Set to `null` to disable. */ readonly bypass_pull_request_allowances?: { /** @description The list of user `login`s allowed to bypass pull request requirements. */ - readonly users?: readonly string[]; + readonly users?: readonly string[] /** @description The list of team `slug`s allowed to bypass pull request requirements. */ - readonly teams?: readonly string[]; - } | null; - }; - }; - }; - }; + readonly teams?: readonly string[] + } | null + } + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28261,263 +28240,263 @@ export interface operations { * * **Note**: You must enable branch protection to require signed commits. */ - readonly "repos/get-commit-signature-protection": { + readonly 'repos/get-commit-signature-protection': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The name of the branch. */ - readonly branch: components["parameters"]["branch"]; - }; - }; + readonly branch: components['parameters']['branch'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["protected-branch-admin-enforced"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': components['schemas']['protected-branch-admin-enforced'] + } + } + readonly 404: components['responses']['not_found'] + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits. */ - readonly "repos/create-commit-signature-protection": { + readonly 'repos/create-commit-signature-protection': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The name of the branch. */ - readonly branch: components["parameters"]["branch"]; - }; - }; + readonly branch: components['parameters']['branch'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["protected-branch-admin-enforced"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': components['schemas']['protected-branch-admin-enforced'] + } + } + readonly 404: components['responses']['not_found'] + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits. */ - readonly "repos/delete-commit-signature-protection": { + readonly 'repos/delete-commit-signature-protection': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The name of the branch. */ - readonly branch: components["parameters"]["branch"]; - }; - }; + readonly branch: components['parameters']['branch'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 204: never + readonly 404: components['responses']['not_found'] + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly "repos/get-status-checks-protection": { + readonly 'repos/get-status-checks-protection': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The name of the branch. */ - readonly branch: components["parameters"]["branch"]; - }; - }; + readonly branch: components['parameters']['branch'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["status-check-policy"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': components['schemas']['status-check-policy'] + } + } + readonly 404: components['responses']['not_found'] + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly "repos/remove-status-check-protection": { + readonly 'repos/remove-status-check-protection': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The name of the branch. */ - readonly branch: components["parameters"]["branch"]; - }; - }; + readonly branch: components['parameters']['branch'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. */ - readonly "repos/update-status-check-protection": { + readonly 'repos/update-status-check-protection': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The name of the branch. */ - readonly branch: components["parameters"]["branch"]; - }; - }; + readonly branch: components['parameters']['branch'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["status-check-policy"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': components['schemas']['status-check-policy'] + } + } + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Require branches to be up to date before merging. */ - readonly strict?: boolean; + readonly strict?: boolean /** * @deprecated * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. */ - readonly contexts?: readonly string[]; + readonly contexts?: readonly string[] /** @description The list of status checks to require in order to merge into this branch. */ readonly checks?: readonly { /** @description The name of the required check */ - readonly context: string; + readonly context: string /** @description The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status. */ - readonly app_id?: number; - }[]; - }; - }; - }; - }; + readonly app_id?: number + }[] + } + } + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly "repos/get-all-status-check-contexts": { + readonly 'repos/get-all-status-check-contexts': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The name of the branch. */ - readonly branch: components["parameters"]["branch"]; - }; - }; + readonly branch: components['parameters']['branch'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly string[]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': readonly string[] + } + } + readonly 404: components['responses']['not_found'] + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly "repos/set-status-check-contexts": { + readonly 'repos/set-status-check-contexts': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The name of the branch. */ - readonly branch: components["parameters"]["branch"]; - }; - }; + readonly branch: components['parameters']['branch'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly string[]; - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': readonly string[] + } + } + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": + readonly 'application/json': | { /** @description contexts parameter */ - readonly contexts: readonly string[]; + readonly contexts: readonly string[] } - | readonly string[]; - }; - }; - }; + | readonly string[] + } + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly "repos/add-status-check-contexts": { + readonly 'repos/add-status-check-contexts': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The name of the branch. */ - readonly branch: components["parameters"]["branch"]; - }; - }; + readonly branch: components['parameters']['branch'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly string[]; - }; - }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': readonly string[] + } + } + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": + readonly 'application/json': | { /** @description contexts parameter */ - readonly contexts: readonly string[]; + readonly contexts: readonly string[] } - | readonly string[]; - }; - }; - }; + | readonly string[] + } + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly "repos/remove-status-check-contexts": { + readonly 'repos/remove-status-check-contexts': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The name of the branch. */ - readonly branch: components["parameters"]["branch"]; - }; - }; + readonly branch: components['parameters']['branch'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly string[]; - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': readonly string[] + } + } + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": + readonly 'application/json': | { /** @description contexts parameter */ - readonly contexts: readonly string[]; + readonly contexts: readonly string[] } - | readonly string[]; - }; - }; - }; + | readonly string[] + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28525,68 +28504,68 @@ export interface operations { * * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. */ - readonly "repos/get-access-restrictions": { + readonly 'repos/get-access-restrictions': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The name of the branch. */ - readonly branch: components["parameters"]["branch"]; - }; - }; + readonly branch: components['parameters']['branch'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["branch-restriction-policy"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': components['schemas']['branch-restriction-policy'] + } + } + readonly 404: components['responses']['not_found'] + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Disables the ability to restrict who can push to this branch. */ - readonly "repos/delete-access-restrictions": { + readonly 'repos/delete-access-restrictions': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The name of the branch. */ - readonly branch: components["parameters"]["branch"]; - }; - }; + readonly branch: components['parameters']['branch'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. */ - readonly "repos/get-apps-with-access-to-protected-branch": { + readonly 'repos/get-apps-with-access-to-protected-branch': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The name of the branch. */ - readonly branch: components["parameters"]["branch"]; - }; - }; + readonly branch: components['parameters']['branch'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["integration"][]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': readonly components['schemas']['integration'][] + } + } + readonly 404: components['responses']['not_found'] + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28596,35 +28575,35 @@ export interface operations { * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - readonly "repos/set-app-access-restrictions": { + readonly 'repos/set-app-access-restrictions': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The name of the branch. */ - readonly branch: components["parameters"]["branch"]; - }; - }; + readonly branch: components['parameters']['branch'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["integration"][]; - }; - }; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': readonly components['schemas']['integration'][] + } + } + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": + readonly 'application/json': | { /** @description apps parameter */ - readonly apps: readonly string[]; + readonly apps: readonly string[] } - | readonly string[]; - }; - }; - }; + | readonly string[] + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28634,35 +28613,35 @@ export interface operations { * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - readonly "repos/add-app-access-restrictions": { + readonly 'repos/add-app-access-restrictions': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The name of the branch. */ - readonly branch: components["parameters"]["branch"]; - }; - }; + readonly branch: components['parameters']['branch'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["integration"][]; - }; - }; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': readonly components['schemas']['integration'][] + } + } + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": + readonly 'application/json': | { /** @description apps parameter */ - readonly apps: readonly string[]; + readonly apps: readonly string[] } - | readonly string[]; - }; - }; - }; + | readonly string[] + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28672,59 +28651,59 @@ export interface operations { * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - readonly "repos/remove-app-access-restrictions": { + readonly 'repos/remove-app-access-restrictions': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The name of the branch. */ - readonly branch: components["parameters"]["branch"]; - }; - }; + readonly branch: components['parameters']['branch'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["integration"][]; - }; - }; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': readonly components['schemas']['integration'][] + } + } + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": + readonly 'application/json': | { /** @description apps parameter */ - readonly apps: readonly string[]; + readonly apps: readonly string[] } - | readonly string[]; - }; - }; - }; + | readonly string[] + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the teams who have push access to this branch. The list includes child teams. */ - readonly "repos/get-teams-with-access-to-protected-branch": { + readonly 'repos/get-teams-with-access-to-protected-branch': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The name of the branch. */ - readonly branch: components["parameters"]["branch"]; - }; - }; + readonly branch: components['parameters']['branch'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["team"][]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': readonly components['schemas']['team'][] + } + } + readonly 404: components['responses']['not_found'] + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28734,35 +28713,35 @@ export interface operations { * | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ | * | `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - readonly "repos/set-team-access-restrictions": { + readonly 'repos/set-team-access-restrictions': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The name of the branch. */ - readonly branch: components["parameters"]["branch"]; - }; - }; + readonly branch: components['parameters']['branch'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["team"][]; - }; - }; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': readonly components['schemas']['team'][] + } + } + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": + readonly 'application/json': | { /** @description teams parameter */ - readonly teams: readonly string[]; + readonly teams: readonly string[] } - | readonly string[]; - }; - }; - }; + | readonly string[] + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28772,35 +28751,35 @@ export interface operations { * | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ | * | `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - readonly "repos/add-team-access-restrictions": { + readonly 'repos/add-team-access-restrictions': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The name of the branch. */ - readonly branch: components["parameters"]["branch"]; - }; - }; + readonly branch: components['parameters']['branch'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["team"][]; - }; - }; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': readonly components['schemas']['team'][] + } + } + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": + readonly 'application/json': | { /** @description teams parameter */ - readonly teams: readonly string[]; + readonly teams: readonly string[] } - | readonly string[]; - }; - }; - }; + | readonly string[] + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28810,59 +28789,59 @@ export interface operations { * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | Teams that should no longer have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - readonly "repos/remove-team-access-restrictions": { + readonly 'repos/remove-team-access-restrictions': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The name of the branch. */ - readonly branch: components["parameters"]["branch"]; - }; - }; + readonly branch: components['parameters']['branch'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["team"][]; - }; - }; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': readonly components['schemas']['team'][] + } + } + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": + readonly 'application/json': | { /** @description teams parameter */ - readonly teams: readonly string[]; + readonly teams: readonly string[] } - | readonly string[]; - }; - }; - }; + | readonly string[] + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the people who have push access to this branch. */ - readonly "repos/get-users-with-access-to-protected-branch": { + readonly 'repos/get-users-with-access-to-protected-branch': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The name of the branch. */ - readonly branch: components["parameters"]["branch"]; - }; - }; + readonly branch: components['parameters']['branch'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': readonly components['schemas']['simple-user'][] + } + } + readonly 404: components['responses']['not_found'] + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28872,35 +28851,35 @@ export interface operations { * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - readonly "repos/set-user-access-restrictions": { + readonly 'repos/set-user-access-restrictions': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The name of the branch. */ - readonly branch: components["parameters"]["branch"]; - }; - }; + readonly branch: components['parameters']['branch'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; - }; - }; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': readonly components['schemas']['simple-user'][] + } + } + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": + readonly 'application/json': | { /** @description users parameter */ - readonly users: readonly string[]; + readonly users: readonly string[] } - | readonly string[]; - }; - }; - }; + | readonly string[] + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28910,35 +28889,35 @@ export interface operations { * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - readonly "repos/add-user-access-restrictions": { + readonly 'repos/add-user-access-restrictions': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The name of the branch. */ - readonly branch: components["parameters"]["branch"]; - }; - }; + readonly branch: components['parameters']['branch'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; - }; - }; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': readonly components['schemas']['simple-user'][] + } + } + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": + readonly 'application/json': | { /** @description users parameter */ - readonly users: readonly string[]; + readonly users: readonly string[] } - | readonly string[]; - }; - }; - }; + | readonly string[] + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28948,35 +28927,35 @@ export interface operations { * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - readonly "repos/remove-user-access-restrictions": { + readonly 'repos/remove-user-access-restrictions': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The name of the branch. */ - readonly branch: components["parameters"]["branch"]; - }; - }; + readonly branch: components['parameters']['branch'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; - }; - }; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': readonly components['schemas']['simple-user'][] + } + } + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": + readonly 'application/json': | { /** @description users parameter */ - readonly users: readonly string[]; + readonly users: readonly string[] } - | readonly string[]; - }; - }; - }; + | readonly string[] + } + } + } /** * Renames a branch in a repository. * @@ -28994,35 +28973,35 @@ export interface operations { * * Users must have admin or owner permissions. * * GitHub Apps must have the `administration:write` repository permission. */ - readonly "repos/rename-branch": { + readonly 'repos/rename-branch': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The name of the branch. */ - readonly branch: components["parameters"]["branch"]; - }; - }; + readonly branch: components['parameters']['branch'] + } + } readonly responses: { /** Response */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["branch-with-protection"]; - }; - }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': components['schemas']['branch-with-protection'] + } + } + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The new name of the branch. */ - readonly new_name: string; - }; - }; - }; - }; + readonly new_name: string + } + } + } + } /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * @@ -29030,494 +29009,478 @@ export interface operations { * * In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. */ - readonly "checks/create": { + readonly 'checks/create': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["check-run"]; - }; - }; - }; + readonly 'application/json': components['schemas']['check-run'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": ( + readonly 'application/json': ( | ({ /** @enum {undefined} */ - readonly status: "completed"; + readonly status: 'completed' } & { - conclusion: unknown; + conclusion: unknown } & { readonly [key: string]: unknown }) | ({ /** @enum {undefined} */ - readonly status?: "queued" | "in_progress"; + readonly status?: 'queued' | 'in_progress' } & { readonly [key: string]: unknown }) ) & { /** @description The name of the check. For example, "code-coverage". */ - readonly name: string; + readonly name: string /** @description The SHA of the commit. */ - readonly head_sha: string; + readonly head_sha: string /** @description The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used. */ - readonly details_url?: string; + readonly details_url?: string /** @description A reference for the run on the integrator's system. */ - readonly external_id?: string; + readonly external_id?: string /** * @description The current status. Can be one of `queued`, `in_progress`, or `completed`. * @default queued * @enum {string} */ - readonly status?: "queued" | "in_progress" | "completed"; + readonly status?: 'queued' | 'in_progress' | 'completed' /** * Format: date-time * @description The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly started_at?: string; + readonly started_at?: string /** * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. * @enum {string} */ - readonly conclusion?: - | "action_required" - | "cancelled" - | "failure" - | "neutral" - | "success" - | "skipped" - | "stale" - | "timed_out"; + readonly conclusion?: 'action_required' | 'cancelled' | 'failure' | 'neutral' | 'success' | 'skipped' | 'stale' | 'timed_out' /** * Format: date-time * @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly completed_at?: string; + readonly completed_at?: string /** @description Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/rest/reference/checks#output-object) description. */ readonly output?: { /** @description The title of the check run. */ - readonly title: string; + readonly title: string /** @description The summary of the check run. This parameter supports Markdown. */ - readonly summary: string; + readonly summary: string /** @description The details of the check run. This parameter supports Markdown. */ - readonly text?: string; + readonly text?: string /** @description Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". See the [`annotations` object](https://docs.github.com/rest/reference/checks#annotations-object) description for details about how to use this parameter. */ readonly annotations?: readonly { /** @description The path of the file to add an annotation to. For example, `assets/css/main.css`. */ - readonly path: string; + readonly path: string /** @description The start line of the annotation. */ - readonly start_line: number; + readonly start_line: number /** @description The end line of the annotation. */ - readonly end_line: number; + readonly end_line: number /** @description The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */ - readonly start_column?: number; + readonly start_column?: number /** @description The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */ - readonly end_column?: number; + readonly end_column?: number /** * @description The level of the annotation. Can be one of `notice`, `warning`, or `failure`. * @enum {string} */ - readonly annotation_level: "notice" | "warning" | "failure"; + readonly annotation_level: 'notice' | 'warning' | 'failure' /** @description A short description of the feedback for these lines of code. The maximum size is 64 KB. */ - readonly message: string; + readonly message: string /** @description The title that represents the annotation. The maximum size is 255 characters. */ - readonly title?: string; + readonly title?: string /** @description Details about this annotation. The maximum size is 64 KB. */ - readonly raw_details?: string; - }[]; + readonly raw_details?: string + }[] /** @description Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/rest/reference/checks#images-object) description for details. */ readonly images?: readonly { /** @description The alternative text for the image. */ - readonly alt: string; + readonly alt: string /** @description The full URL of the image. */ - readonly image_url: string; + readonly image_url: string /** @description A short image description. */ - readonly caption?: string; - }[]; - }; + readonly caption?: string + }[] + } /** @description Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions)." */ readonly actions?: readonly { /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ - readonly label: string; + readonly label: string /** @description A short explanation of what this action would do. The maximum size is 40 characters. */ - readonly description: string; + readonly description: string /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ - readonly identifier: string; - }[]; - }; - }; - }; - }; + readonly identifier: string + }[] + } + } + } + } /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * Gets a single check run using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. */ - readonly "checks/get": { + readonly 'checks/get': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** check_run_id parameter */ - readonly check_run_id: components["parameters"]["check-run-id"]; - }; - }; + readonly check_run_id: components['parameters']['check-run-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["check-run"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['check-run'] + } + } + } + } /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. */ - readonly "checks/update": { + readonly 'checks/update': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** check_run_id parameter */ - readonly check_run_id: components["parameters"]["check-run-id"]; - }; - }; + readonly check_run_id: components['parameters']['check-run-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["check-run"]; - }; - }; - }; + readonly 'application/json': components['schemas']['check-run'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": (Partial< + readonly 'application/json': (Partial< { /** @enum {undefined} */ - readonly status?: "completed"; + readonly status?: 'completed' } & { - conclusion: unknown; + conclusion: unknown } & { readonly [key: string]: unknown } > & Partial< { /** @enum {undefined} */ - readonly status?: "queued" | "in_progress"; + readonly status?: 'queued' | 'in_progress' } & { readonly [key: string]: unknown } >) & { /** @description The name of the check. For example, "code-coverage". */ - readonly name?: string; + readonly name?: string /** @description The URL of the integrator's site that has the full details of the check. */ - readonly details_url?: string; + readonly details_url?: string /** @description A reference for the run on the integrator's system. */ - readonly external_id?: string; + readonly external_id?: string /** * Format: date-time * @description This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly started_at?: string; + readonly started_at?: string /** * @description The current status. Can be one of `queued`, `in_progress`, or `completed`. * @enum {string} */ - readonly status?: "queued" | "in_progress" | "completed"; + readonly status?: 'queued' | 'in_progress' | 'completed' /** * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. * @enum {string} */ - readonly conclusion?: - | "action_required" - | "cancelled" - | "failure" - | "neutral" - | "success" - | "skipped" - | "stale" - | "timed_out"; + readonly conclusion?: 'action_required' | 'cancelled' | 'failure' | 'neutral' | 'success' | 'skipped' | 'stale' | 'timed_out' /** * Format: date-time * @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly completed_at?: string; + readonly completed_at?: string /** @description Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/rest/reference/checks#output-object-1) description. */ readonly output?: { /** @description **Required**. */ - readonly title?: string; + readonly title?: string /** @description Can contain Markdown. */ - readonly summary: string; + readonly summary: string /** @description Can contain Markdown. */ - readonly text?: string; + readonly text?: string /** @description Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". See the [`annotations` object](https://docs.github.com/rest/reference/checks#annotations-object-1) description for details. */ readonly annotations?: readonly { /** @description The path of the file to add an annotation to. For example, `assets/css/main.css`. */ - readonly path: string; + readonly path: string /** @description The start line of the annotation. */ - readonly start_line: number; + readonly start_line: number /** @description The end line of the annotation. */ - readonly end_line: number; + readonly end_line: number /** @description The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */ - readonly start_column?: number; + readonly start_column?: number /** @description The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */ - readonly end_column?: number; + readonly end_column?: number /** * @description The level of the annotation. Can be one of `notice`, `warning`, or `failure`. * @enum {string} */ - readonly annotation_level: "notice" | "warning" | "failure"; + readonly annotation_level: 'notice' | 'warning' | 'failure' /** @description A short description of the feedback for these lines of code. The maximum size is 64 KB. */ - readonly message: string; + readonly message: string /** @description The title that represents the annotation. The maximum size is 255 characters. */ - readonly title?: string; + readonly title?: string /** @description Details about this annotation. The maximum size is 64 KB. */ - readonly raw_details?: string; - }[]; + readonly raw_details?: string + }[] /** @description Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/rest/reference/checks#annotations-object-1) description for details. */ readonly images?: readonly { /** @description The alternative text for the image. */ - readonly alt: string; + readonly alt: string /** @description The full URL of the image. */ - readonly image_url: string; + readonly image_url: string /** @description A short image description. */ - readonly caption?: string; - }[]; - }; + readonly caption?: string + }[] + } /** @description Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions)." */ readonly actions?: readonly { /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ - readonly label: string; + readonly label: string /** @description A short explanation of what this action would do. The maximum size is 40 characters. */ - readonly description: string; + readonly description: string /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ - readonly identifier: string; - }[]; - }; - }; - }; - }; + readonly identifier: string + }[] + } + } + } + } /** Lists annotations for a check run using the annotation `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the `repo` scope to get annotations for a check run in a private repository. */ - readonly "checks/list-annotations": { + readonly 'checks/list-annotations': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** check_run_id parameter */ - readonly check_run_id: components["parameters"]["check-run-id"]; - }; + readonly check_run_id: components['parameters']['check-run-id'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["check-annotation"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['check-annotation'][] + } + } + } + } /** * Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * * To rerequest a check run, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository. */ - readonly "checks/rerequest-run": { + readonly 'checks/rerequest-run': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** check_run_id parameter */ - readonly check_run_id: components["parameters"]["check-run-id"]; - }; - }; + readonly check_run_id: components['parameters']['check-run-id'] + } + } readonly responses: { /** Response */ readonly 201: { readonly content: { - readonly "application/json": { readonly [key: string]: unknown }; - }; - }; + readonly 'application/json': { readonly [key: string]: unknown } + } + } /** Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App */ readonly 403: { readonly content: { - readonly "application/json": components["schemas"]["basic-error"]; - }; - }; - readonly 404: components["responses"]["not_found"]; + readonly 'application/json': components['schemas']['basic-error'] + } + } + readonly 404: components['responses']['not_found'] /** Validation error if the check run is not rerequestable */ readonly 422: { readonly content: { - readonly "application/json": components["schemas"]["basic-error"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['basic-error'] + } + } + } + } /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * * By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/reference/checks#check-runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/reference/checks#update-repository-preferences-for-check-suites)". Your GitHub App must have the `checks:write` permission to create check suites. */ - readonly "checks/create-suite": { + readonly 'checks/create-suite': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** when the suite already existed */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["check-suite"]; - }; - }; + readonly 'application/json': components['schemas']['check-suite'] + } + } /** Response when the suite was created */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["check-suite"]; - }; - }; - }; + readonly 'application/json': components['schemas']['check-suite'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The sha of the head commit. */ - readonly head_sha: string; - }; - }; - }; - }; + readonly head_sha: string + } + } + } + } /** Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/reference/checks#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites. */ - readonly "checks/set-suites-preferences": { + readonly 'checks/set-suites-preferences': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["check-suite-preference"]; - }; - }; - }; + readonly 'application/json': components['schemas']['check-suite-preference'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/rest/reference/checks#auto_trigger_checks-object) description for details. */ readonly auto_trigger_checks?: readonly { /** @description The `id` of the GitHub App. */ - readonly app_id: number; + readonly app_id: number /** * @description Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them. * @default true */ - readonly setting: boolean; - }[]; - }; - }; - }; - }; + readonly setting: boolean + }[] + } + } + } + } /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * * Gets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository. */ - readonly "checks/get-suite": { + readonly 'checks/get-suite': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** check_suite_id parameter */ - readonly check_suite_id: components["parameters"]["check-suite-id"]; - }; - }; + readonly check_suite_id: components['parameters']['check-suite-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["check-suite"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['check-suite'] + } + } + } + } /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. */ - readonly "checks/list-for-suite": { + readonly 'checks/list-for-suite': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** check_suite_id parameter */ - readonly check_suite_id: components["parameters"]["check-suite-id"]; - }; + readonly check_suite_id: components['parameters']['check-suite-id'] + } readonly query: { /** Returns check runs with the specified `name`. */ - readonly check_name?: components["parameters"]["check-name"]; + readonly check_name?: components['parameters']['check-name'] /** Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`. */ - readonly status?: components["parameters"]["status"]; + readonly status?: components['parameters']['status'] /** Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`. */ - readonly filter?: "latest" | "all"; + readonly filter?: 'latest' | 'all' /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": { - readonly total_count: number; - readonly check_runs: readonly components["schemas"]["check-run"][]; - }; - }; - }; - }; - }; + readonly 'application/json': { + readonly total_count: number + readonly check_runs: readonly components['schemas']['check-run'][] + } + } + } + } + } /** * Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * * To rerequest a check suite, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository. */ - readonly "checks/rerequest-suite": { + readonly 'checks/rerequest-suite': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** check_suite_id parameter */ - readonly check_suite_id: components["parameters"]["check-suite-id"]; - }; - }; + readonly check_suite_id: components['parameters']['check-suite-id'] + } + } readonly responses: { /** Response */ readonly 201: { readonly content: { - readonly "application/json": { readonly [key: string]: unknown }; - }; - }; - }; - }; + readonly 'application/json': { readonly [key: string]: unknown } + } + } + } + } /** * Lists all open code scanning alerts for the default branch (usually `main` * or `master`). You must use an access token with the `security_events` scope to use @@ -29530,137 +29493,137 @@ export interface operations { * for the default branch or for the specified Git reference * (if you used `ref` in the request). */ - readonly "code-scanning/list-alerts-for-repo": { + readonly 'code-scanning/list-alerts-for-repo': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } readonly query: { /** The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */ - readonly tool_name?: components["parameters"]["tool-name"]; + readonly tool_name?: components['parameters']['tool-name'] /** The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ - readonly tool_guid?: components["parameters"]["tool-guid"]; + readonly tool_guid?: components['parameters']['tool-guid'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; + readonly page?: components['parameters']['page'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ - readonly ref?: components["parameters"]["git-ref"]; + readonly ref?: components['parameters']['git-ref'] /** One of `asc` (ascending) or `desc` (descending). */ - readonly direction?: components["parameters"]["direction"]; + readonly direction?: components['parameters']['direction'] /** Can be one of `created`, `updated`, `number`. */ - readonly sort?: "created" | "updated" | "number"; + readonly sort?: 'created' | 'updated' | 'number' /** Set to `open`, `closed, `fixed`, or `dismissed` to list code scanning alerts in a specific state. */ - readonly state?: components["schemas"]["code-scanning-alert-state"]; - }; - }; + readonly state?: components['schemas']['code-scanning-alert-state'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["code-scanning-alert-items"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["code_scanning_forbidden_read"]; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; - }; - }; + readonly 'application/json': readonly components['schemas']['code-scanning-alert-items'][] + } + } + readonly 304: components['responses']['not_modified'] + readonly 403: components['responses']['code_scanning_forbidden_read'] + readonly 404: components['responses']['not_found'] + readonly 503: components['responses']['service_unavailable'] + } + } /** * Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint. * * **Deprecation notice**: * The instances field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The same information can now be retrieved via a GET request to the URL specified by `instances_url`. */ - readonly "code-scanning/get-alert": { + readonly 'code-scanning/get-alert': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ - readonly alert_number: components["parameters"]["alert-number"]; - }; - }; + readonly alert_number: components['parameters']['alert-number'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["code-scanning-alert"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["code_scanning_forbidden_read"]; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; - }; - }; + readonly 'application/json': components['schemas']['code-scanning-alert'] + } + } + readonly 304: components['responses']['not_modified'] + readonly 403: components['responses']['code_scanning_forbidden_read'] + readonly 404: components['responses']['not_found'] + readonly 503: components['responses']['service_unavailable'] + } + } /** Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. */ - readonly "code-scanning/update-alert": { + readonly 'code-scanning/update-alert': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ - readonly alert_number: components["parameters"]["alert-number"]; - }; - }; + readonly alert_number: components['parameters']['alert-number'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["code-scanning-alert"]; - }; - }; - readonly 403: components["responses"]["code_scanning_forbidden_write"]; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; - }; + readonly 'application/json': components['schemas']['code-scanning-alert'] + } + } + readonly 403: components['responses']['code_scanning_forbidden_write'] + readonly 404: components['responses']['not_found'] + readonly 503: components['responses']['service_unavailable'] + } readonly requestBody: { readonly content: { - readonly "application/json": { - readonly state: components["schemas"]["code-scanning-alert-set-state"]; - readonly dismissed_reason?: components["schemas"]["code-scanning-alert-dismissed-reason"]; - }; - }; - }; - }; + readonly 'application/json': { + readonly state: components['schemas']['code-scanning-alert-set-state'] + readonly dismissed_reason?: components['schemas']['code-scanning-alert-dismissed-reason'] + } + } + } + } /** * Lists all instances of the specified code scanning alert. * You must use an access token with the `security_events` scope to use this endpoint with private repos, * the `public_repo` scope also grants permission to read security events on public repos only. * GitHub Apps must have the `security_events` read permission to use this endpoint. */ - readonly "code-scanning/list-alert-instances": { + readonly 'code-scanning/list-alert-instances': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ - readonly alert_number: components["parameters"]["alert-number"]; - }; + readonly alert_number: components['parameters']['alert-number'] + } readonly query: { /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; + readonly page?: components['parameters']['page'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ - readonly ref?: components["parameters"]["git-ref"]; - }; - }; + readonly ref?: components['parameters']['git-ref'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["code-scanning-alert-instance"][]; - }; - }; - readonly 403: components["responses"]["code_scanning_forbidden_read"]; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; - }; - }; + readonly 'application/json': readonly components['schemas']['code-scanning-alert-instance'][] + } + } + readonly 403: components['responses']['code_scanning_forbidden_read'] + readonly 404: components['responses']['not_found'] + readonly 503: components['responses']['service_unavailable'] + } + } /** * Lists the details of all code scanning analyses for a repository, * starting with the most recent. @@ -29680,39 +29643,39 @@ export interface operations { * **Deprecation notice**: * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. */ - readonly "code-scanning/list-recent-analyses": { + readonly 'code-scanning/list-recent-analyses': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } readonly query: { /** The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */ - readonly tool_name?: components["parameters"]["tool-name"]; + readonly tool_name?: components['parameters']['tool-name'] /** The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ - readonly tool_guid?: components["parameters"]["tool-guid"]; + readonly tool_guid?: components['parameters']['tool-guid'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; + readonly page?: components['parameters']['page'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ - readonly ref?: components["schemas"]["code-scanning-ref"]; + readonly ref?: components['schemas']['code-scanning-ref'] /** Filter analyses belonging to the same SARIF upload. */ - readonly sarif_id?: components["schemas"]["code-scanning-analysis-sarif-id"]; - }; - }; + readonly sarif_id?: components['schemas']['code-scanning-analysis-sarif-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["code-scanning-analysis"][]; - }; - }; - readonly 403: components["responses"]["code_scanning_forbidden_read"]; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; - }; - }; + readonly 'application/json': readonly components['schemas']['code-scanning-analysis'][] + } + } + readonly 403: components['responses']['code_scanning_forbidden_read'] + readonly 404: components['responses']['not_found'] + readonly 503: components['responses']['service_unavailable'] + } + } /** * Gets a specified code scanning analysis for a repository. * You must use an access token with the `security_events` scope to use this endpoint with private repos, @@ -29734,28 +29697,28 @@ export interface operations { * This is formatted as * [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). */ - readonly "code-scanning/get-analysis": { + readonly 'code-scanning/get-analysis': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation. */ - readonly analysis_id: number; - }; - }; + readonly analysis_id: number + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json+sarif": string; - readonly "application/json": components["schemas"]["code-scanning-analysis"]; - }; - }; - readonly 403: components["responses"]["code_scanning_forbidden_read"]; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; - }; - }; + readonly 'application/json+sarif': string + readonly 'application/json': components['schemas']['code-scanning-analysis'] + } + } + readonly 403: components['responses']['code_scanning_forbidden_read'] + readonly 404: components['responses']['not_found'] + readonly 503: components['responses']['service_unavailable'] + } + } /** * Deletes a specified code scanning analysis from a repository. For * private repositories, you must use an access token with the `repo` scope. For public repositories, @@ -29824,32 +29787,32 @@ export interface operations { * * The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely. */ - readonly "code-scanning/delete-analysis": { + readonly 'code-scanning/delete-analysis': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation. */ - readonly analysis_id: number; - }; + readonly analysis_id: number + } readonly query: { /** Allow deletion if the specified analysis is the last in a set. If you attempt to delete the final analysis in a set without setting this parameter to `true`, you'll get a 400 response with the message: `Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.` */ - readonly confirm_delete?: string | null; - }; - }; + readonly confirm_delete?: string | null + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["code-scanning-analysis-deletion"]; - }; - }; - readonly 400: components["responses"]["bad_request"]; - readonly 403: components["responses"]["code_scanning_forbidden_write"]; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; - }; - }; + readonly 'application/json': components['schemas']['code-scanning-analysis-deletion'] + } + } + readonly 400: components['responses']['bad_request'] + readonly 403: components['responses']['code_scanning_forbidden_write'] + readonly 404: components['responses']['not_found'] + readonly 503: components['responses']['service_unavailable'] + } + } /** * Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. * @@ -29869,155 +29832,155 @@ export interface operations { * You can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint. * For more information, see "[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload)." */ - readonly "code-scanning/upload-sarif": { + readonly 'code-scanning/upload-sarif': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 202: { readonly content: { - readonly "application/json": components["schemas"]["code-scanning-sarifs-receipt"]; - }; - }; + readonly 'application/json': components['schemas']['code-scanning-sarifs-receipt'] + } + } /** Bad Request if the sarif field is invalid */ - readonly 400: unknown; - readonly 403: components["responses"]["code_scanning_forbidden_write"]; - readonly 404: components["responses"]["not_found"]; + readonly 400: unknown + readonly 403: components['responses']['code_scanning_forbidden_write'] + readonly 404: components['responses']['not_found'] /** Payload Too Large if the sarif field is too large */ - readonly 413: unknown; - readonly 503: components["responses"]["service_unavailable"]; - }; + readonly 413: unknown + readonly 503: components['responses']['service_unavailable'] + } readonly requestBody: { readonly content: { - readonly "application/json": { - readonly commit_sha: components["schemas"]["code-scanning-analysis-commit-sha"]; - readonly ref: components["schemas"]["code-scanning-ref"]; - readonly sarif: components["schemas"]["code-scanning-analysis-sarif-file"]; + readonly 'application/json': { + readonly commit_sha: components['schemas']['code-scanning-analysis-commit-sha'] + readonly ref: components['schemas']['code-scanning-ref'] + readonly sarif: components['schemas']['code-scanning-analysis-sarif-file'] /** * Format: uri * @description The base directory used in the analysis, as it appears in the SARIF file. * This property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository. * @example file:///github/workspace/ */ - readonly checkout_uri?: string; + readonly checkout_uri?: string /** * Format: date-time * @description The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly started_at?: string; + readonly started_at?: string /** @description The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to "API". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`. */ - readonly tool_name?: string; - }; - }; - }; - }; + readonly tool_name?: string + } + } + } + } /** Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository)." You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint. */ - readonly "code-scanning/get-sarif": { + readonly 'code-scanning/get-sarif': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The SARIF ID obtained after uploading. */ - readonly sarif_id: string; - }; - }; + readonly sarif_id: string + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["code-scanning-sarifs-status"]; - }; - }; - readonly 403: components["responses"]["code_scanning_forbidden_read"]; + readonly 'application/json': components['schemas']['code-scanning-sarifs-status'] + } + } + readonly 403: components['responses']['code_scanning_forbidden_read'] /** Not Found if the sarif id does not match any upload */ - readonly 404: unknown; - readonly 503: components["responses"]["service_unavailable"]; - }; - }; + readonly 404: unknown + readonly 503: components['responses']['service_unavailable'] + } + } /** * Lists the codespaces associated to a specified repository and the authenticated user. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - readonly "codespaces/list-in-repository-for-authenticated-user": { + readonly 'codespaces/list-in-repository-for-authenticated-user': { readonly parameters: { readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; + readonly page?: components['parameters']['page'] + } readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": { - readonly total_count: number; - readonly codespaces: readonly components["schemas"]["codespace"][]; - }; - }; - }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; - }; - }; + readonly 'application/json': { + readonly total_count: number + readonly codespaces: readonly components['schemas']['codespace'][] + } + } + } + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 500: components['responses']['internal_error'] + } + } /** * Creates a codespace owned by the authenticated user in the specified repository. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - readonly "codespaces/create-with-repo-for-authenticated-user": { + readonly 'codespaces/create-with-repo-for-authenticated-user': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response when the codespace was successfully created */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["codespace"]; - }; - }; + readonly 'application/json': components['schemas']['codespace'] + } + } /** Response when the codespace creation partially failed but is being retried in the background */ readonly 202: { readonly content: { - readonly "application/json": components["schemas"]["codespace"]; - }; - }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; + readonly 'application/json': components['schemas']['codespace'] + } + } + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Git ref (typically a branch name) for this codespace */ - readonly ref?: string; + readonly ref?: string /** @description Location for this codespace */ - readonly location: string; + readonly location: string /** @description Machine type to use for this codespace */ - readonly machine?: string; + readonly machine?: string /** @description Working directory for this codespace */ - readonly working_directory?: string; + readonly working_directory?: string /** @description Time in minutes before codespace stops from inactivity */ - readonly idle_timeout_minutes?: number; - }; - }; - }; - }; + readonly idle_timeout_minutes?: number + } + } + } + } /** * List the machine types available for a given repository based on its configuration. * @@ -30025,34 +29988,34 @@ export interface operations { * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - readonly "codespaces/repo-machines-for-authenticated-user": { + readonly 'codespaces/repo-machines-for-authenticated-user': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } readonly query: { /** Required. The location to check for available machines. */ - readonly location: string; - }; - }; + readonly location: string + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": { - readonly total_count: number; - readonly machines: readonly components["schemas"]["codespace-machine"][]; - }; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; - }; - }; + readonly 'application/json': { + readonly total_count: number + readonly machines: readonly components['schemas']['codespace-machine'][] + } + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 500: components['responses']['internal_error'] + } + } /** * For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. * @@ -30062,12 +30025,12 @@ export interface operations { * endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this * endpoint. */ - readonly "repos/list-collaborators": { + readonly 'repos/list-collaborators': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } readonly query: { /** * Filter collaborators returned by their affiliation. Can be one of: @@ -30075,24 +30038,24 @@ export interface operations { * \* `direct`: All collaborators with permissions to an organization-owned repository, regardless of organization membership status. * \* `all`: All collaborators the authenticated user can see. */ - readonly affiliation?: "outside" | "direct" | "all"; + readonly affiliation?: 'outside' | 'direct' | 'all' /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["collaborator"][]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': readonly components['schemas']['collaborator'][] + } + } + readonly 404: components['responses']['not_found'] + } + } /** * For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. * @@ -30102,21 +30065,21 @@ export interface operations { * endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this * endpoint. */ - readonly "repos/check-collaborator": { + readonly 'repos/check-collaborator': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly username: components["parameters"]["username"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly username: components['parameters']['username'] + } + } readonly responses: { /** Response if user is a collaborator */ - readonly 204: never; + readonly 204: never /** Not Found if user is not a collaborator */ - readonly 404: unknown; - }; - }; + readonly 404: unknown + } + } /** * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. * @@ -30134,29 +30097,29 @@ export interface operations { * * You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository. */ - readonly "repos/add-collaborator": { + readonly 'repos/add-collaborator': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly username: components["parameters"]["username"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly username: components['parameters']['username'] + } + } readonly responses: { /** Response when a new invitation is created */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["repository-invitation"]; - }; - }; + readonly 'application/json': components['schemas']['repository-invitation'] + } + } /** Response when person is already a collaborator */ - readonly 204: never; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 204: never + readonly 403: components['responses']['forbidden'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: * \* `pull` - can pull, but not push to or administer this repository. @@ -30168,221 +30131,221 @@ export interface operations { * @default push * @enum {string} */ - readonly permission?: "pull" | "push" | "admin" | "maintain" | "triage"; + readonly permission?: 'pull' | 'push' | 'admin' | 'maintain' | 'triage' /** @example "push" */ - readonly permissions?: string; - }; - }; - }; - }; - readonly "repos/remove-collaborator": { + readonly permissions?: string + } + } + } + } + readonly 'repos/remove-collaborator': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly username: components["parameters"]["username"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly username: components['parameters']['username'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** Checks the repository permission of a collaborator. The possible repository permissions are `admin`, `write`, `read`, and `none`. */ - readonly "repos/get-collaborator-permission-level": { + readonly 'repos/get-collaborator-permission-level': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly username: components["parameters"]["username"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly username: components['parameters']['username'] + } + } readonly responses: { /** if user has admin permissions */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["repository-collaborator-permission"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': components['schemas']['repository-collaborator-permission'] + } + } + readonly 404: components['responses']['not_found'] + } + } /** * Commit Comments use [these custom media types](https://docs.github.com/rest/reference/repos#custom-media-types). You can read more about the use of media types in the API [here](https://docs.github.com/rest/overview/media-types/). * * Comments are ordered by ascending ID. */ - readonly "repos/list-commit-comments-for-repo": { + readonly 'repos/list-commit-comments-for-repo': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["commit-comment"][]; - }; - }; - }; - }; - readonly "repos/get-commit-comment": { + readonly 'application/json': readonly components['schemas']['commit-comment'][] + } + } + } + } + readonly 'repos/get-commit-comment': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** comment_id parameter */ - readonly comment_id: components["parameters"]["comment-id"]; - }; - }; + readonly comment_id: components['parameters']['comment-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["commit-comment"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "repos/delete-commit-comment": { + readonly 'application/json': components['schemas']['commit-comment'] + } + } + readonly 404: components['responses']['not_found'] + } + } + readonly 'repos/delete-commit-comment': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** comment_id parameter */ - readonly comment_id: components["parameters"]["comment-id"]; - }; - }; + readonly comment_id: components['parameters']['comment-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "repos/update-commit-comment": { + readonly 204: never + readonly 404: components['responses']['not_found'] + } + } + readonly 'repos/update-commit-comment': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** comment_id parameter */ - readonly comment_id: components["parameters"]["comment-id"]; - }; - }; + readonly comment_id: components['parameters']['comment-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["commit-comment"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; + readonly 'application/json': components['schemas']['commit-comment'] + } + } + readonly 404: components['responses']['not_found'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The contents of the comment */ - readonly body: string; - }; - }; - }; - }; + readonly body: string + } + } + } + } /** List the reactions to a [commit comment](https://docs.github.com/rest/reference/repos#comments). */ - readonly "reactions/list-for-commit-comment": { + readonly 'reactions/list-for-commit-comment': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** comment_id parameter */ - readonly comment_id: components["parameters"]["comment-id"]; - }; + readonly comment_id: components['parameters']['comment-id'] + } readonly query: { /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a commit comment. */ - readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + readonly content?: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["reaction"][]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': readonly components['schemas']['reaction'][] + } + } + readonly 404: components['responses']['not_found'] + } + } /** Create a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. */ - readonly "reactions/create-for-commit-comment": { + readonly 'reactions/create-for-commit-comment': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** comment_id parameter */ - readonly comment_id: components["parameters"]["comment-id"]; - }; - }; + readonly comment_id: components['parameters']['comment-id'] + } + } readonly responses: { /** Reaction exists */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["reaction"]; - }; - }; + readonly 'application/json': components['schemas']['reaction'] + } + } /** Reaction created */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["reaction"]; - }; - }; - readonly 415: components["responses"]["preview_header_missing"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': components['schemas']['reaction'] + } + } + readonly 415: components['responses']['preview_header_missing'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the commit comment. * @enum {string} */ - readonly content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - }; + readonly content: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' + } + } + } + } /** * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. * * Delete a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). */ - readonly "reactions/delete-for-commit-comment": { + readonly 'reactions/delete-for-commit-comment': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** comment_id parameter */ - readonly comment_id: components["parameters"]["comment-id"]; - readonly reaction_id: components["parameters"]["reaction-id"]; - }; - }; + readonly comment_id: components['parameters']['comment-id'] + readonly reaction_id: components['parameters']['reaction-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** * **Signature verification object** * @@ -30413,161 +30376,161 @@ export interface operations { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - readonly "repos/list-commits": { + readonly 'repos/list-commits': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } readonly query: { /** SHA or branch to start listing commits from. Default: the repository’s default branch (usually `master`). */ - readonly sha?: string; + readonly sha?: string /** Only commits containing this file path will be returned. */ - readonly path?: string; + readonly path?: string /** GitHub login or email address by which to filter by commit author. */ - readonly author?: string; + readonly author?: string /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; + readonly since?: components['parameters']['since'] /** Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly until?: string; + readonly until?: string /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["commit"][]; - }; - }; - readonly 400: components["responses"]["bad_request"]; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; - readonly 500: components["responses"]["internal_error"]; - }; - }; + readonly 'application/json': readonly components['schemas']['commit'][] + } + } + readonly 400: components['responses']['bad_request'] + readonly 404: components['responses']['not_found'] + readonly 409: components['responses']['conflict'] + readonly 500: components['responses']['internal_error'] + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. */ - readonly "repos/list-branches-for-head-commit": { + readonly 'repos/list-branches-for-head-commit': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** commit_sha parameter */ - readonly commit_sha: components["parameters"]["commit-sha"]; - }; - }; + readonly commit_sha: components['parameters']['commit-sha'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["branch-short"][]; - }; - }; - readonly 422: components["responses"]["validation_failed"]; - }; - }; + readonly 'application/json': readonly components['schemas']['branch-short'][] + } + } + readonly 422: components['responses']['validation_failed'] + } + } /** Use the `:commit_sha` to specify the commit that will have its comments listed. */ - readonly "repos/list-comments-for-commit": { + readonly 'repos/list-comments-for-commit': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** commit_sha parameter */ - readonly commit_sha: components["parameters"]["commit-sha"]; - }; + readonly commit_sha: components['parameters']['commit-sha'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["commit-comment"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['commit-comment'][] + } + } + } + } /** * Create a comment for a commit using its `:commit_sha`. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - readonly "repos/create-commit-comment": { + readonly 'repos/create-commit-comment': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** commit_sha parameter */ - readonly commit_sha: components["parameters"]["commit-sha"]; - }; - }; + readonly commit_sha: components['parameters']['commit-sha'] + } + } readonly responses: { /** Response */ readonly 201: { readonly headers: { - readonly Location?: string; - }; - readonly content: { - readonly "application/json": components["schemas"]["commit-comment"]; - }; - }; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly Location?: string + } + readonly content: { + readonly 'application/json': components['schemas']['commit-comment'] + } + } + readonly 403: components['responses']['forbidden'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The contents of the comment. */ - readonly body: string; + readonly body: string /** @description Relative path of the file to comment on. */ - readonly path?: string; + readonly path?: string /** @description Line index in the diff to comment on. */ - readonly position?: number; + readonly position?: number /** @description **Deprecated**. Use **position** parameter instead. Line number in the file to comment on. */ - readonly line?: number; - }; - }; - }; - }; + readonly line?: number + } + } + } + } /** Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the [List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests) endpoint. */ - readonly "repos/list-pull-requests-associated-with-commit": { + readonly 'repos/list-pull-requests-associated-with-commit': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** commit_sha parameter */ - readonly commit_sha: components["parameters"]["commit-sha"]; - }; + readonly commit_sha: components['parameters']['commit-sha'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["pull-request-simple"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['pull-request-simple'][] + } + } + } + } /** * Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. * @@ -30606,110 +30569,110 @@ export interface operations { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - readonly "repos/get-commit": { + readonly 'repos/get-commit': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** ref parameter */ - readonly ref: string; - }; + readonly ref: string + } readonly query: { /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; + readonly page?: components['parameters']['page'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; - }; - }; + readonly per_page?: components['parameters']['per-page'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["commit"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 500: components["responses"]["internal_error"]; - }; - }; + readonly 'application/json': components['schemas']['commit'] + } + } + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + readonly 500: components['responses']['internal_error'] + } + } /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. */ - readonly "checks/list-for-ref": { + readonly 'checks/list-for-ref': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** ref parameter */ - readonly ref: string; - }; + readonly ref: string + } readonly query: { /** Returns check runs with the specified `name`. */ - readonly check_name?: components["parameters"]["check-name"]; + readonly check_name?: components['parameters']['check-name'] /** Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`. */ - readonly status?: components["parameters"]["status"]; + readonly status?: components['parameters']['status'] /** Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`. */ - readonly filter?: "latest" | "all"; + readonly filter?: 'latest' | 'all' /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - readonly app_id?: number; - }; - }; + readonly page?: components['parameters']['page'] + readonly app_id?: number + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": { - readonly total_count: number; - readonly check_runs: readonly components["schemas"]["check-run"][]; - }; - }; - }; - }; - }; + readonly 'application/json': { + readonly total_count: number + readonly check_runs: readonly components['schemas']['check-run'][] + } + } + } + } + } /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * * Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository. */ - readonly "checks/list-suites-for-ref": { + readonly 'checks/list-suites-for-ref': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** ref parameter */ - readonly ref: string; - }; + readonly ref: string + } readonly query: { /** Filters check suites by GitHub App `id`. */ - readonly app_id?: number; + readonly app_id?: number /** Returns check runs with the specified `name`. */ - readonly check_name?: components["parameters"]["check-name"]; + readonly check_name?: components['parameters']['check-name'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": { - readonly total_count: number; - readonly check_suites: readonly components["schemas"]["check-suite"][]; - }; - }; - }; - }; - }; + readonly 'application/json': { + readonly total_count: number + readonly check_suites: readonly components['schemas']['check-suite'][] + } + } + } + } + } /** * Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. * @@ -30720,62 +30683,62 @@ export interface operations { * * **pending** if there are no statuses or a context is `pending` * * **success** if the latest status for all contexts is `success` */ - readonly "repos/get-combined-status-for-ref": { + readonly 'repos/get-combined-status-for-ref': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** ref parameter */ - readonly ref: string; - }; + readonly ref: string + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["combined-commit-status"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': components['schemas']['combined-commit-status'] + } + } + readonly 404: components['responses']['not_found'] + } + } /** * Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one. * * This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`. */ - readonly "repos/list-commit-statuses-for-ref": { + readonly 'repos/list-commit-statuses-for-ref': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** ref parameter */ - readonly ref: string; - }; + readonly ref: string + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["status"][]; - }; - }; - readonly 301: components["responses"]["moved_permanently"]; - }; - }; + readonly 'application/json': readonly components['schemas']['status'][] + } + } + readonly 301: components['responses']['moved_permanently'] + } + } /** * This endpoint will return all community profile metrics, including an * overall health score, repository description, the presence of documentation, detected @@ -30790,22 +30753,22 @@ export interface operations { * * `content_reports_enabled` is only returned for organization-owned repositories. */ - readonly "repos/get-community-profile-metrics": { + readonly 'repos/get-community-profile-metrics': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["community-profile"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['community-profile'] + } + } + } + } /** * The `basehead` param is comprised of two parts: `base` and `head`. Both must be branch names in `repo`. To compare branches across other repositories in the same network as `repo`, use the format `:branch`. * @@ -30848,32 +30811,32 @@ export interface operations { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - readonly "repos/compare-commits": { + readonly 'repos/compare-commits': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The base branch and head branch to compare. This parameter expects the format `{base}...{head}`. */ - readonly basehead: string; - }; + readonly basehead: string + } readonly query: { /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; + readonly page?: components['parameters']['page'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; - }; - }; + readonly per_page?: components['parameters']['per-page'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["commit-comparison"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; - }; - }; + readonly 'application/json': components['schemas']['commit-comparison'] + } + } + readonly 404: components['responses']['not_found'] + readonly 500: components['responses']['internal_error'] + } + } /** * Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit * `:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. @@ -30908,96 +30871,96 @@ export interface operations { * If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the * github.com URLs (`html_url` and `_links["html"]`) will have null values. */ - readonly "repos/get-content": { + readonly 'repos/get-content': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** path parameter */ - readonly path: string; - }; + readonly path: string + } readonly query: { /** The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`) */ - readonly ref?: string; - }; - }; - readonly responses: { - /** Response */ - readonly 200: { - readonly content: { - readonly "application/vnd.github.v3.object": components["schemas"]["content-tree"]; - readonly "application/json": - | components["schemas"]["content-directory"] - | components["schemas"]["content-file"] - | components["schemas"]["content-symlink"] - | components["schemas"]["content-submodule"]; - }; - }; - readonly 302: components["responses"]["found"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly ref?: string + } + } + readonly responses: { + /** Response */ + readonly 200: { + readonly content: { + readonly 'application/vnd.github.v3.object': components['schemas']['content-tree'] + readonly 'application/json': + | components['schemas']['content-directory'] + | components['schemas']['content-file'] + | components['schemas']['content-symlink'] + | components['schemas']['content-submodule'] + } + } + readonly 302: components['responses']['found'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } /** Creates a new file or replaces an existing file in a repository. */ - readonly "repos/create-or-update-file-contents": { + readonly 'repos/create-or-update-file-contents': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** path parameter */ - readonly path: string; - }; - }; + readonly path: string + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["file-commit"]; - }; - }; + readonly 'application/json': components['schemas']['file-commit'] + } + } /** Response */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["file-commit"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': components['schemas']['file-commit'] + } + } + readonly 404: components['responses']['not_found'] + readonly 409: components['responses']['conflict'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The commit message. */ - readonly message: string; + readonly message: string /** @description The new file content, using Base64 encoding. */ - readonly content: string; + readonly content: string /** @description **Required if you are updating a file**. The blob SHA of the file being replaced. */ - readonly sha?: string; + readonly sha?: string /** @description The branch name. Default: the repository’s default branch (usually `master`) */ - readonly branch?: string; + readonly branch?: string /** @description The person that committed the file. Default: the authenticated user. */ readonly committer?: { /** @description The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted. */ - readonly name: string; + readonly name: string /** @description The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted. */ - readonly email: string; + readonly email: string /** @example "2013-01-05T13:13:22+05:00" */ - readonly date?: string; - }; + readonly date?: string + } /** @description The author of the file. Default: The `committer` or the authenticated user if you omit `committer`. */ readonly author?: { /** @description The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted. */ - readonly name: string; + readonly name: string /** @description The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted. */ - readonly email: string; + readonly email: string /** @example "2013-01-15T17:13:22+05:00" */ - readonly date?: string; - }; - }; - }; - }; - }; + readonly date?: string + } + } + } + } + } /** * Deletes a file in a repository. * @@ -31007,151 +30970,151 @@ export interface operations { * * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. */ - readonly "repos/delete-file": { + readonly 'repos/delete-file': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** path parameter */ - readonly path: string; - }; - }; + readonly path: string + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["file-commit"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 503: components["responses"]["service_unavailable"]; - }; + readonly 'application/json': components['schemas']['file-commit'] + } + } + readonly 404: components['responses']['not_found'] + readonly 409: components['responses']['conflict'] + readonly 422: components['responses']['validation_failed'] + readonly 503: components['responses']['service_unavailable'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The commit message. */ - readonly message: string; + readonly message: string /** @description The blob SHA of the file being replaced. */ - readonly sha: string; + readonly sha: string /** @description The branch name. Default: the repository’s default branch (usually `master`) */ - readonly branch?: string; + readonly branch?: string /** @description object containing information about the committer. */ readonly committer?: { /** @description The name of the author (or committer) of the commit */ - readonly name?: string; + readonly name?: string /** @description The email of the author (or committer) of the commit */ - readonly email?: string; - }; + readonly email?: string + } /** @description object containing information about the author. */ readonly author?: { /** @description The name of the author (or committer) of the commit */ - readonly name?: string; + readonly name?: string /** @description The email of the author (or committer) of the commit */ - readonly email?: string; - }; - }; - }; - }; - }; + readonly email?: string + } + } + } + } + } /** * Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance. * * GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information. */ - readonly "repos/list-contributors": { + readonly 'repos/list-contributors': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } readonly query: { /** Set to `1` or `true` to include anonymous contributors in results. */ - readonly anon?: string; + readonly anon?: string /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** if repository contains content */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["contributor"][]; - }; - }; + readonly 'application/json': readonly components['schemas']['contributor'][] + } + } /** Response if repository is empty */ - readonly 204: never; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 204: never + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } /** Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */ - readonly "dependabot/list-repo-secrets": { + readonly 'dependabot/list-repo-secrets': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": { - readonly total_count: number; - readonly secrets: readonly components["schemas"]["dependabot-secret"][]; - }; - }; - }; - }; - }; + readonly 'application/json': { + readonly total_count: number + readonly secrets: readonly components['schemas']['dependabot-secret'][] + } + } + } + } + } /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */ - readonly "dependabot/get-repo-public-key": { + readonly 'dependabot/get-repo-public-key': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["dependabot-public-key"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['dependabot-public-key'] + } + } + } + } /** Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */ - readonly "dependabot/get-repo-secret": { + readonly 'dependabot/get-repo-secret': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** secret_name parameter */ - readonly secret_name: components["parameters"]["secret-name"]; - }; - }; + readonly secret_name: components['parameters']['secret-name'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["dependabot-secret"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['dependabot-secret'] + } + } + } + } /** * Creates or updates a repository secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -31229,83 +31192,83 @@ export interface operations { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - readonly "dependabot/create-or-update-repo-secret": { + readonly 'dependabot/create-or-update-repo-secret': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** secret_name parameter */ - readonly secret_name: components["parameters"]["secret-name"]; - }; - }; + readonly secret_name: components['parameters']['secret-name'] + } + } readonly responses: { /** Response when creating a secret */ readonly 201: { readonly content: { - readonly "application/json": { readonly [key: string]: unknown }; - }; - }; + readonly 'application/json': { readonly [key: string]: unknown } + } + } /** Response when updating a secret */ - readonly 204: never; - }; + readonly 204: never + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/reference/dependabot#get-a-repository-public-key) endpoint. */ - readonly encrypted_value?: string; + readonly encrypted_value?: string /** @description ID of the key you used to encrypt the secret. */ - readonly key_id?: string; - }; - }; - }; - }; + readonly key_id?: string + } + } + } + } /** Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */ - readonly "dependabot/delete-repo-secret": { + readonly 'dependabot/delete-repo-secret': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** secret_name parameter */ - readonly secret_name: components["parameters"]["secret-name"]; - }; - }; + readonly secret_name: components['parameters']['secret-name'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** Simple filtering of deployments is available via query parameters: */ - readonly "repos/list-deployments": { + readonly 'repos/list-deployments': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } readonly query: { /** The SHA recorded at creation time. */ - readonly sha?: string; + readonly sha?: string /** The name of the ref. This can be a branch, tag, or SHA. */ - readonly ref?: string; + readonly ref?: string /** The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`). */ - readonly task?: string; + readonly task?: string /** The name of the environment that was deployed to (e.g., `staging` or `production`). */ - readonly environment?: string | null; + readonly environment?: string | null /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["deployment"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['deployment'][] + } + } + } + } /** * Deployments offer a few configurable parameters with certain defaults. * @@ -31353,84 +31316,84 @@ export interface operations { * This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` * status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. */ - readonly "repos/create-deployment": { + readonly 'repos/create-deployment': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["deployment"]; - }; - }; + readonly 'application/json': components['schemas']['deployment'] + } + } /** Merged branch response */ readonly 202: { readonly content: { - readonly "application/json": { - readonly message?: string; - }; - }; - }; + readonly 'application/json': { + readonly message?: string + } + } + } /** Conflict when there is a merge conflict or the commit's status checks failed */ - readonly 409: unknown; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 409: unknown + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The ref to deploy. This can be a branch, tag, or SHA. */ - readonly ref: string; + readonly ref: string /** * @description Specifies a task to execute (e.g., `deploy` or `deploy:migrations`). * @default deploy */ - readonly task?: string; + readonly task?: string /** * @description Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch. * @default true */ - readonly auto_merge?: boolean; + readonly auto_merge?: boolean /** @description The [status](https://docs.github.com/rest/reference/commits#commit-statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts. */ - readonly required_contexts?: readonly string[]; - readonly payload?: { readonly [key: string]: unknown } | string; + readonly required_contexts?: readonly string[] + readonly payload?: { readonly [key: string]: unknown } | string /** * @description Name for the target deployment environment (e.g., `production`, `staging`, `qa`). * @default production */ - readonly environment?: string; + readonly environment?: string /** @description Short description of the deployment. */ - readonly description?: string | null; + readonly description?: string | null /** @description Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false` */ - readonly transient_environment?: boolean; + readonly transient_environment?: boolean /** @description Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise. */ - readonly production_environment?: boolean; - }; - }; - }; - }; - readonly "repos/get-deployment": { + readonly production_environment?: boolean + } + } + } + } + readonly 'repos/get-deployment': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** deployment_id parameter */ - readonly deployment_id: components["parameters"]["deployment-id"]; - }; - }; + readonly deployment_id: components['parameters']['deployment-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["deployment"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': components['schemas']['deployment'] + } + } + readonly 404: components['responses']['not_found'] + } + } /** * If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. Anyone with `repo` or `repo_deployment` scopes can delete a deployment. * @@ -31441,123 +31404,123 @@ export interface operations { * * For more information, see "[Create a deployment](https://docs.github.com/rest/reference/repos/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/reference/repos#create-a-deployment-status)." */ - readonly "repos/delete-deployment": { + readonly 'repos/delete-deployment': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** deployment_id parameter */ - readonly deployment_id: components["parameters"]["deployment-id"]; - }; - }; + readonly deployment_id: components['parameters']['deployment-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; - }; - }; + readonly 204: never + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed_simple'] + } + } /** Users with pull access can view deployment statuses for a deployment: */ - readonly "repos/list-deployment-statuses": { + readonly 'repos/list-deployment-statuses': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** deployment_id parameter */ - readonly deployment_id: components["parameters"]["deployment-id"]; - }; + readonly deployment_id: components['parameters']['deployment-id'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["deployment-status"][]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': readonly components['schemas']['deployment-status'][] + } + } + readonly 404: components['responses']['not_found'] + } + } /** * Users with `push` access can create deployment statuses for a given deployment. * * GitHub Apps require `read & write` access to "Deployments" and `read-only` access to "Repo contents" (for private repos). OAuth Apps require the `repo_deployment` scope. */ - readonly "repos/create-deployment-status": { + readonly 'repos/create-deployment-status': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** deployment_id parameter */ - readonly deployment_id: components["parameters"]["deployment-id"]; - }; - }; + readonly deployment_id: components['parameters']['deployment-id'] + } + } readonly responses: { /** Response */ readonly 201: { readonly headers: { - readonly Location?: string; - }; - readonly content: { - readonly "application/json": components["schemas"]["deployment-status"]; - }; - }; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly Location?: string + } + readonly content: { + readonly 'application/json': components['schemas']['deployment-status'] + } + } + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued`, `pending`, or `success`. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub. * @enum {string} */ - readonly state: "error" | "failure" | "inactive" | "in_progress" | "queued" | "pending" | "success"; + readonly state: 'error' | 'failure' | 'inactive' | 'in_progress' | 'queued' | 'pending' | 'success' /** @description The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`. */ - readonly target_url?: string; + readonly target_url?: string /** @description The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `""` */ - readonly log_url?: string; + readonly log_url?: string /** @description A short description of the status. The maximum description length is 140 characters. */ - readonly description?: string; + readonly description?: string /** * @description Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. * @enum {string} */ - readonly environment?: "production" | "staging" | "qa"; + readonly environment?: 'production' | 'staging' | 'qa' /** @description Sets the URL for accessing your environment. Default: `""` */ - readonly environment_url?: string; + readonly environment_url?: string /** @description Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true` */ - readonly auto_inactive?: boolean; - }; - }; - }; - }; + readonly auto_inactive?: boolean + } + } + } + } /** Users with pull access can view a deployment status for a deployment: */ - readonly "repos/get-deployment-status": { + readonly 'repos/get-deployment-status': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** deployment_id parameter */ - readonly deployment_id: components["parameters"]["deployment-id"]; - readonly status_id: number; - }; - }; + readonly deployment_id: components['parameters']['deployment-id'] + readonly status_id: number + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["deployment-status"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': components['schemas']['deployment-status'] + } + } + readonly 404: components['responses']['not_found'] + } + } /** * You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/webhooks/event-payloads/#repository_dispatch)." * @@ -31570,76 +31533,76 @@ export interface operations { * * This input example shows how you can use the `client_payload` as a test to debug your workflow. */ - readonly "repos/create-dispatch-event": { + readonly 'repos/create-dispatch-event': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 204: never + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description A custom webhook event name. */ - readonly event_type: string; + readonly event_type: string /** @description JSON payload with extra information about the webhook event that your action or worklow may use. */ - readonly client_payload?: { readonly [key: string]: unknown }; - }; - }; - }; - }; + readonly client_payload?: { readonly [key: string]: unknown } + } + } + } + } /** * Get all environments for a repository. * * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - readonly "repos/get-all-environments": { + readonly 'repos/get-all-environments': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description The number of environments in this repository * @example 5 */ - readonly total_count?: number; - readonly environments?: readonly components["schemas"]["environment"][]; - }; - }; - }; - }; - }; + readonly total_count?: number + readonly environments?: readonly components['schemas']['environment'][] + } + } + } + } + } /** Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - readonly "repos/get-environment": { + readonly 'repos/get-environment': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The name of the environment */ - readonly environment_name: components["parameters"]["environment-name"]; - }; - }; + readonly environment_name: components['parameters']['environment-name'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["environment"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['environment'] + } + } + } + } /** * Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)." * @@ -31649,206 +31612,206 @@ export interface operations { * * You must authenticate using an access token with the repo scope to use this endpoint. */ - readonly "repos/create-or-update-environment": { + readonly 'repos/create-or-update-environment': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The name of the environment */ - readonly environment_name: components["parameters"]["environment-name"]; - }; - }; + readonly environment_name: components['parameters']['environment-name'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["environment"]; - }; - }; + readonly 'application/json': components['schemas']['environment'] + } + } /** Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` are set to the same value */ readonly 422: { readonly content: { - readonly "application/json": components["schemas"]["basic-error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['basic-error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { - readonly wait_timer?: components["schemas"]["wait-timer"]; + readonly 'application/json': { + readonly wait_timer?: components['schemas']['wait-timer'] /** @description The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */ readonly reviewers?: | readonly { - readonly type?: components["schemas"]["deployment-reviewer-type"]; + readonly type?: components['schemas']['deployment-reviewer-type'] /** * @description The id of the user or team who can review the deployment * @example 4532992 */ - readonly id?: number; + readonly id?: number }[] - | null; - readonly deployment_branch_policy?: components["schemas"]["deployment_branch_policy"]; - } | null; - }; - }; - }; + | null + readonly deployment_branch_policy?: components['schemas']['deployment_branch_policy'] + } | null + } + } + } /** You must authenticate using an access token with the repo scope to use this endpoint. */ - readonly "repos/delete-an-environment": { + readonly 'repos/delete-an-environment': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The name of the environment */ - readonly environment_name: components["parameters"]["environment-name"]; - }; - }; + readonly environment_name: components['parameters']['environment-name'] + } + } readonly responses: { /** Default response */ - readonly 204: never; - }; - }; - readonly "activity/list-repo-events": { + readonly 204: never + } + } + readonly 'activity/list-repo-events': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["event"][]; - }; - }; - }; - }; - readonly "repos/list-forks": { + readonly 'application/json': readonly components['schemas']['event'][] + } + } + } + } + readonly 'repos/list-forks': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } readonly query: { /** The sort order. Can be either `newest`, `oldest`, or `stargazers`. */ - readonly sort?: "newest" | "oldest" | "stargazers" | "watchers"; + readonly sort?: 'newest' | 'oldest' | 'stargazers' | 'watchers' /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["minimal-repository"][]; - }; - }; - readonly 400: components["responses"]["bad_request"]; - }; - }; + readonly 'application/json': readonly components['schemas']['minimal-repository'][] + } + } + readonly 400: components['responses']['bad_request'] + } + } /** * Create a fork for the authenticated user. * * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). */ - readonly "repos/create-fork": { + readonly 'repos/create-fork': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 202: { readonly content: { - readonly "application/json": components["schemas"]["full-repository"]; - }; - }; - readonly 400: components["responses"]["bad_request"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': components['schemas']['full-repository'] + } + } + readonly 400: components['responses']['bad_request'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Optional parameter to specify the organization name if forking into an organization. */ - readonly organization?: string; - } | null; - }; - }; - }; - readonly "git/create-blob": { + readonly organization?: string + } | null + } + } + } + readonly 'git/create-blob': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 201: { readonly headers: { - readonly Location?: string; - }; - readonly content: { - readonly "application/json": components["schemas"]["short-blob"]; - }; - }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly Location?: string + } + readonly content: { + readonly 'application/json': components['schemas']['short-blob'] + } + } + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 409: components['responses']['conflict'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The new blob's content. */ - readonly content: string; + readonly content: string /** * @description The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. * @default utf-8 */ - readonly encoding?: string; - }; - }; - }; - }; + readonly encoding?: string + } + } + } + } /** * The `content` in the response will always be Base64 encoded. * * _Note_: This API supports blobs up to 100 megabytes in size. */ - readonly "git/get-blob": { + readonly 'git/get-blob': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly file_sha: string; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly file_sha: string + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["blob"]; - }; - }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; + readonly 'application/json': components['schemas']['blob'] + } + } + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } + } /** * Creates a new Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects). * @@ -31881,65 +31844,65 @@ export interface operations { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - readonly "git/create-commit": { + readonly 'git/create-commit': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 201: { readonly headers: { - readonly Location?: string; - }; - readonly content: { - readonly "application/json": components["schemas"]["git-commit"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly Location?: string + } + readonly content: { + readonly 'application/json': components['schemas']['git-commit'] + } + } + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The commit message */ - readonly message: string; + readonly message: string /** @description The SHA of the tree object this commit points to */ - readonly tree: string; + readonly tree: string /** @description The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. */ - readonly parents?: readonly string[]; + readonly parents?: readonly string[] /** @description Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details. */ readonly author?: { /** @description The name of the author (or committer) of the commit */ - readonly name: string; + readonly name: string /** @description The email of the author (or committer) of the commit */ - readonly email: string; + readonly email: string /** * Format: date-time * @description Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly date?: string; - }; + readonly date?: string + } /** @description Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details. */ readonly committer?: { /** @description The name of the author (or committer) of the commit */ - readonly name?: string; + readonly name?: string /** @description The email of the author (or committer) of the commit */ - readonly email?: string; + readonly email?: string /** * Format: date-time * @description Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly date?: string; - }; + readonly date?: string + } /** @description The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits. */ - readonly signature?: string; - }; - }; - }; - }; + readonly signature?: string + } + } + } + } /** * Gets a Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects). * @@ -31972,25 +31935,25 @@ export interface operations { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - readonly "git/get-commit": { + readonly 'git/get-commit': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** commit_sha parameter */ - readonly commit_sha: components["parameters"]["commit-sha"]; - }; - }; + readonly commit_sha: components['parameters']['commit-sha'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["git-commit"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': components['schemas']['git-commit'] + } + } + readonly 404: components['responses']['not_found'] + } + } /** * Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array. * @@ -32000,132 +31963,132 @@ export interface operations { * * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. */ - readonly "git/list-matching-refs": { + readonly 'git/list-matching-refs': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** ref parameter */ - readonly ref: string; - }; + readonly ref: string + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["git-ref"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['git-ref'][] + } + } + } + } /** * Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. * * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". */ - readonly "git/get-ref": { + readonly 'git/get-ref': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** ref parameter */ - readonly ref: string; - }; - }; + readonly ref: string + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["git-ref"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': components['schemas']['git-ref'] + } + } + readonly 404: components['responses']['not_found'] + } + } /** Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches. */ - readonly "git/create-ref": { + readonly 'git/create-ref': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 201: { readonly headers: { - readonly Location?: string; - }; - readonly content: { - readonly "application/json": components["schemas"]["git-ref"]; - }; - }; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly Location?: string + } + readonly content: { + readonly 'application/json': components['schemas']['git-ref'] + } + } + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected. */ - readonly ref: string; + readonly ref: string /** @description The SHA1 value for this reference. */ - readonly sha: string; + readonly sha: string /** @example "refs/heads/newbranch" */ - readonly key?: string; - }; - }; - }; - }; - readonly "git/delete-ref": { + readonly key?: string + } + } + } + } + readonly 'git/delete-ref': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** ref parameter */ - readonly ref: string; - }; - }; + readonly ref: string + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 422: components["responses"]["validation_failed"]; - }; - }; - readonly "git/update-ref": { + readonly 204: never + readonly 422: components['responses']['validation_failed'] + } + } + readonly 'git/update-ref': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** ref parameter */ - readonly ref: string; - }; - }; + readonly ref: string + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["git-ref"]; - }; - }; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': components['schemas']['git-ref'] + } + } + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The SHA1 value to set this reference to */ - readonly sha: string; + readonly sha: string /** @description Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work. */ - readonly force?: boolean; - }; - }; - }; - }; + readonly force?: boolean + } + } + } + } /** * Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/rest/reference/git#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/rest/reference/git#create-a-reference) the tag reference - this call would be unnecessary. * @@ -32158,55 +32121,55 @@ export interface operations { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - readonly "git/create-tag": { + readonly 'git/create-tag': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 201: { readonly headers: { - readonly Location?: string; - }; - readonly content: { - readonly "application/json": components["schemas"]["git-tag"]; - }; - }; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly Location?: string + } + readonly content: { + readonly 'application/json': components['schemas']['git-tag'] + } + } + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The tag's name. This is typically a version (e.g., "v0.0.1"). */ - readonly tag: string; + readonly tag: string /** @description The tag message. */ - readonly message: string; + readonly message: string /** @description The SHA of the git object this is tagging. */ - readonly object: string; + readonly object: string /** * @description The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`. * @enum {string} */ - readonly type: "commit" | "tree" | "blob"; + readonly type: 'commit' | 'tree' | 'blob' /** @description An object with information about the individual creating the tag. */ readonly tagger?: { /** @description The name of the author of the tag */ - readonly name: string; + readonly name: string /** @description The email of the author of the tag */ - readonly email: string; + readonly email: string /** * Format: date-time * @description When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly date?: string; - }; - }; - }; - }; - }; + readonly date?: string + } + } + } + } + } /** * **Signature verification object** * @@ -32237,431 +32200,431 @@ export interface operations { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - readonly "git/get-tag": { + readonly 'git/get-tag': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly tag_sha: string; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly tag_sha: string + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["git-tag"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': components['schemas']['git-tag'] + } + } + readonly 404: components['responses']['not_found'] + } + } /** * The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure. * * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/rest/reference/git#create-a-commit)" and "[Update a reference](https://docs.github.com/rest/reference/git#update-a-reference)." */ - readonly "git/create-tree": { + readonly 'git/create-tree': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 201: { readonly headers: { - readonly Location?: string; - }; - readonly content: { - readonly "application/json": components["schemas"]["git-tree"]; - }; - }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly Location?: string + } + readonly content: { + readonly 'application/json': components['schemas']['git-tree'] + } + } + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure. */ readonly tree: readonly { /** @description The file referenced in the tree. */ - readonly path?: string; + readonly path?: string /** * @description The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink. * @enum {string} */ - readonly mode?: "100644" | "100755" | "040000" | "160000" | "120000"; + readonly mode?: '100644' | '100755' | '040000' | '160000' | '120000' /** * @description Either `blob`, `tree`, or `commit`. * @enum {string} */ - readonly type?: "blob" | "tree" | "commit"; + readonly type?: 'blob' | 'tree' | 'commit' /** * @description The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. * * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. */ - readonly sha?: string | null; + readonly sha?: string | null /** * @description The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. * * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. */ - readonly content?: string; - }[]; + readonly content?: string + }[] /** * @description The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on. * If not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit. */ - readonly base_tree?: string; - }; - }; - }; - }; + readonly base_tree?: string + } + } + } + } /** * Returns a single tree using the SHA1 value for that tree. * * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. */ - readonly "git/get-tree": { + readonly 'git/get-tree': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly tree_sha: string; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly tree_sha: string + } readonly query: { /** Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` to any of the following will enable returning objects or subtrees: `0`, `1`, `"true"`, and `"false"`. Omit this parameter to prevent recursively returning objects or subtrees. */ - readonly recursive?: string; - }; - }; + readonly recursive?: string + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["git-tree"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; - readonly "repos/list-webhooks": { + readonly 'application/json': components['schemas']['git-tree'] + } + } + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } + } + readonly 'repos/list-webhooks': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["hook"][]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': readonly components['schemas']['hook'][] + } + } + readonly 404: components['responses']['not_found'] + } + } /** * Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can * share the same `config` as long as those webhooks do not have any `events` that overlap. */ - readonly "repos/create-webhook": { + readonly 'repos/create-webhook': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 201: { readonly headers: { - readonly Location?: string; - }; - readonly content: { - readonly "application/json": components["schemas"]["hook"]; - }; - }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly Location?: string + } + readonly content: { + readonly 'application/json': components['schemas']['hook'] + } + } + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`. */ - readonly name?: string; + readonly name?: string /** @description Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/repos#create-hook-config-params). */ readonly config?: { - readonly url?: components["schemas"]["webhook-config-url"]; - readonly content_type?: components["schemas"]["webhook-config-content-type"]; - readonly secret?: components["schemas"]["webhook-config-secret"]; - readonly insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + readonly url?: components['schemas']['webhook-config-url'] + readonly content_type?: components['schemas']['webhook-config-content-type'] + readonly secret?: components['schemas']['webhook-config-secret'] + readonly insecure_ssl?: components['schemas']['webhook-config-insecure-ssl'] /** @example "abc" */ - readonly token?: string; + readonly token?: string /** @example "sha256" */ - readonly digest?: string; - }; + readonly digest?: string + } /** * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. * @default push */ - readonly events?: readonly string[]; + readonly events?: readonly string[] /** * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. * @default true */ - readonly active?: boolean; - } | null; - }; - }; - }; + readonly active?: boolean + } | null + } + } + } /** Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/reference/repos#get-a-webhook-configuration-for-a-repository)." */ - readonly "repos/get-webhook": { + readonly 'repos/get-webhook': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly hook_id: components["parameters"]["hook-id"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly hook_id: components['parameters']['hook-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["hook"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "repos/delete-webhook": { + readonly 'application/json': components['schemas']['hook'] + } + } + readonly 404: components['responses']['not_found'] + } + } + readonly 'repos/delete-webhook': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly hook_id: components["parameters"]["hook-id"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly hook_id: components['parameters']['hook-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 204: never + readonly 404: components['responses']['not_found'] + } + } /** Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/reference/repos#update-a-webhook-configuration-for-a-repository)." */ - readonly "repos/update-webhook": { + readonly 'repos/update-webhook': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly hook_id: components["parameters"]["hook-id"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly hook_id: components['parameters']['hook-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["hook"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': components['schemas']['hook'] + } + } + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/repos#create-hook-config-params). */ readonly config?: { - readonly url: components["schemas"]["webhook-config-url"]; - readonly content_type?: components["schemas"]["webhook-config-content-type"]; - readonly secret?: components["schemas"]["webhook-config-secret"]; - readonly insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + readonly url: components['schemas']['webhook-config-url'] + readonly content_type?: components['schemas']['webhook-config-content-type'] + readonly secret?: components['schemas']['webhook-config-secret'] + readonly insecure_ssl?: components['schemas']['webhook-config-insecure-ssl'] /** @example "bar@example.com" */ - readonly address?: string; + readonly address?: string /** @example "The Serious Room" */ - readonly room?: string; - }; + readonly room?: string + } /** * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events. * @default push */ - readonly events?: readonly string[]; + readonly events?: readonly string[] /** @description Determines a list of events to be added to the list of events that the Hook triggers for. */ - readonly add_events?: readonly string[]; + readonly add_events?: readonly string[] /** @description Determines a list of events to be removed from the list of events that the Hook triggers for. */ - readonly remove_events?: readonly string[]; + readonly remove_events?: readonly string[] /** * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. * @default true */ - readonly active?: boolean; - }; - }; - }; - }; + readonly active?: boolean + } + } + } + } /** * Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/reference/orgs#get-a-repository-webhook)." * * Access tokens must have the `read:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:read` permission. */ - readonly "repos/get-webhook-config-for-repo": { + readonly 'repos/get-webhook-config-for-repo': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly hook_id: components["parameters"]["hook-id"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly hook_id: components['parameters']['hook-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["webhook-config"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['webhook-config'] + } + } + } + } /** * Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/reference/orgs#update-a-repository-webhook)." * * Access tokens must have the `write:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:write` permission. */ - readonly "repos/update-webhook-config-for-repo": { + readonly 'repos/update-webhook-config-for-repo': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly hook_id: components["parameters"]["hook-id"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly hook_id: components['parameters']['hook-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["webhook-config"]; - }; - }; - }; + readonly 'application/json': components['schemas']['webhook-config'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { - readonly url?: components["schemas"]["webhook-config-url"]; - readonly content_type?: components["schemas"]["webhook-config-content-type"]; - readonly secret?: components["schemas"]["webhook-config-secret"]; - readonly insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - }; - }; - }; - }; + readonly 'application/json': { + readonly url?: components['schemas']['webhook-config-url'] + readonly content_type?: components['schemas']['webhook-config-content-type'] + readonly secret?: components['schemas']['webhook-config-secret'] + readonly insecure_ssl?: components['schemas']['webhook-config-insecure-ssl'] + } + } + } + } /** Returns a list of webhook deliveries for a webhook configured in a repository. */ - readonly "repos/list-webhook-deliveries": { + readonly 'repos/list-webhook-deliveries': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly hook_id: components["parameters"]["hook-id"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly hook_id: components['parameters']['hook-id'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ - readonly cursor?: components["parameters"]["cursor"]; - }; - }; + readonly cursor?: components['parameters']['cursor'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["hook-delivery-item"][]; - }; - }; - readonly 400: components["responses"]["bad_request"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; + readonly 'application/json': readonly components['schemas']['hook-delivery-item'][] + } + } + readonly 400: components['responses']['bad_request'] + readonly 422: components['responses']['validation_failed'] + } + } /** Returns a delivery for a webhook configured in a repository. */ - readonly "repos/get-webhook-delivery": { + readonly 'repos/get-webhook-delivery': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly hook_id: components["parameters"]["hook-id"]; - readonly delivery_id: components["parameters"]["delivery-id"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly hook_id: components['parameters']['hook-id'] + readonly delivery_id: components['parameters']['delivery-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["hook-delivery"]; - }; - }; - readonly 400: components["responses"]["bad_request"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; + readonly 'application/json': components['schemas']['hook-delivery'] + } + } + readonly 400: components['responses']['bad_request'] + readonly 422: components['responses']['validation_failed'] + } + } /** Redeliver a webhook delivery for a webhook configured in a repository. */ - readonly "repos/redeliver-webhook-delivery": { + readonly 'repos/redeliver-webhook-delivery': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly hook_id: components["parameters"]["hook-id"]; - readonly delivery_id: components["parameters"]["delivery-id"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly hook_id: components['parameters']['hook-id'] + readonly delivery_id: components['parameters']['delivery-id'] + } + } readonly responses: { - readonly 202: components["responses"]["accepted"]; - readonly 400: components["responses"]["bad_request"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; + readonly 202: components['responses']['accepted'] + readonly 400: components['responses']['bad_request'] + readonly 422: components['responses']['validation_failed'] + } + } /** This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. */ - readonly "repos/ping-webhook": { + readonly 'repos/ping-webhook': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly hook_id: components["parameters"]["hook-id"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly hook_id: components['parameters']['hook-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 204: never + readonly 404: components['responses']['not_found'] + } + } /** * This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. * * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` */ - readonly "repos/test-push-webhook": { + readonly 'repos/test-push-webhook': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly hook_id: components["parameters"]["hook-id"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly hook_id: components['parameters']['hook-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 204: never + readonly 404: components['responses']['not_found'] + } + } /** * View the progress of an import. * @@ -32698,360 +32661,359 @@ export interface operations { * * `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository. * * `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a "Get Large Files" request. */ - readonly "migrations/get-import-status": { + readonly 'migrations/get-import-status': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["import"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': components['schemas']['import'] + } + } + readonly 404: components['responses']['not_found'] + } + } /** Start a source import to a GitHub repository using GitHub Importer. */ - readonly "migrations/start-import": { + readonly 'migrations/start-import': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 201: { readonly headers: { - readonly Location?: string; - }; - readonly content: { - readonly "application/json": components["schemas"]["import"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly Location?: string + } + readonly content: { + readonly 'application/json': components['schemas']['import'] + } + } + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The URL of the originating repository. */ - readonly vcs_url: string; + readonly vcs_url: string /** * @description The originating VCS type. Can be one of `subversion`, `git`, `mercurial`, or `tfvc`. Please be aware that without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response. * @enum {string} */ - readonly vcs?: "subversion" | "git" | "mercurial" | "tfvc"; + readonly vcs?: 'subversion' | 'git' | 'mercurial' | 'tfvc' /** @description If authentication is required, the username to provide to `vcs_url`. */ - readonly vcs_username?: string; + readonly vcs_username?: string /** @description If authentication is required, the password to provide to `vcs_url`. */ - readonly vcs_password?: string; + readonly vcs_password?: string /** @description For a tfvc import, the name of the project that is being imported. */ - readonly tfvc_project?: string; - }; - }; - }; - }; + readonly tfvc_project?: string + } + } + } + } /** Stop an import for a repository. */ - readonly "migrations/cancel-import": { + readonly 'migrations/cancel-import': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** * An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API * request. If no parameters are provided, the import will be restarted. */ - readonly "migrations/update-import": { + readonly 'migrations/update-import': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["import"]; - }; - }; - }; + readonly 'application/json': components['schemas']['import'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The username to provide to the originating repository. */ - readonly vcs_username?: string; + readonly vcs_username?: string /** @description The password to provide to the originating repository. */ - readonly vcs_password?: string; + readonly vcs_password?: string /** @example "git" */ - readonly vcs?: string; + readonly vcs?: string /** @example "project1" */ - readonly tfvc_project?: string; - } | null; - }; - }; - }; + readonly tfvc_project?: string + } | null + } + } + } /** * Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `. * * This endpoint and the [Map a commit author](https://docs.github.com/rest/reference/migrations#map-a-commit-author) endpoint allow you to provide correct Git author information. */ - readonly "migrations/get-commit-authors": { + readonly 'migrations/get-commit-authors': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } readonly query: { /** A user ID. Only return users with an ID greater than this ID. */ - readonly since?: components["parameters"]["since-user"]; - }; - }; + readonly since?: components['parameters']['since-user'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["porter-author"][]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': readonly components['schemas']['porter-author'][] + } + } + readonly 404: components['responses']['not_found'] + } + } /** Update an author's identity for the import. Your application can continue updating authors any time before you push new commits to the repository. */ - readonly "migrations/map-commit-author": { + readonly 'migrations/map-commit-author': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly author_id: number; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly author_id: number + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["porter-author"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': components['schemas']['porter-author'] + } + } + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The new Git author email. */ - readonly email?: string; + readonly email?: string /** @description The new Git author name. */ - readonly name?: string; - }; - }; - }; - }; + readonly name?: string + } + } + } + } /** List files larger than 100MB found during the import */ - readonly "migrations/get-large-files": { + readonly 'migrations/get-large-files': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["porter-large-file"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['porter-large-file'][] + } + } + } + } /** You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability is powered by [Git LFS](https://git-lfs.github.com). You can learn more about our LFS feature and working with large files [on our help site](https://docs.github.com/articles/versioning-large-files/). */ - readonly "migrations/set-lfs-preference": { + readonly 'migrations/set-lfs-preference': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["import"]; - }; - }; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': components['schemas']['import'] + } + } + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description Can be one of `opt_in` (large files will be stored using Git LFS) or `opt_out` (large files will be removed during the import). * @enum {string} */ - readonly use_lfs: "opt_in" | "opt_out"; - }; - }; - }; - }; + readonly use_lfs: 'opt_in' | 'opt_out' + } + } + } + } /** * Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly "apps/get-repo-installation": { + readonly 'apps/get-repo-installation': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["installation"]; - }; - }; - readonly 301: components["responses"]["moved_permanently"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': components['schemas']['installation'] + } + } + readonly 301: components['responses']['moved_permanently'] + readonly 404: components['responses']['not_found'] + } + } /** Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response. */ - readonly "interactions/get-restrictions-for-repo": { + readonly 'interactions/get-restrictions-for-repo': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": Partial & - Partial<{ readonly [key: string]: unknown }>; - }; - }; - }; - }; + readonly 'application/json': Partial & Partial<{ readonly [key: string]: unknown }> + } + } + } + } /** Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. */ - readonly "interactions/set-restrictions-for-repo": { + readonly 'interactions/set-restrictions-for-repo': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["interaction-limit-response"]; - }; - }; + readonly 'application/json': components['schemas']['interaction-limit-response'] + } + } /** Response */ - readonly 409: unknown; - }; + readonly 409: unknown + } readonly requestBody: { readonly content: { - readonly "application/json": components["schemas"]["interaction-limit"]; - }; - }; - }; + readonly 'application/json': components['schemas']['interaction-limit'] + } + } + } /** Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. */ - readonly "interactions/remove-restrictions-for-repo": { + readonly 'interactions/remove-restrictions-for-repo': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ - readonly 204: never; + readonly 204: never /** Response */ - readonly 409: unknown; - }; - }; + readonly 409: unknown + } + } /** When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations. */ - readonly "repos/list-invitations": { + readonly 'repos/list-invitations': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["repository-invitation"][]; - }; - }; - }; - }; - readonly "repos/delete-invitation": { + readonly 'application/json': readonly components['schemas']['repository-invitation'][] + } + } + } + } + readonly 'repos/delete-invitation': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** invitation_id parameter */ - readonly invitation_id: components["parameters"]["invitation-id"]; - }; - }; + readonly invitation_id: components['parameters']['invitation-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; - readonly "repos/update-invitation": { + readonly 204: never + } + } + readonly 'repos/update-invitation': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** invitation_id parameter */ - readonly invitation_id: components["parameters"]["invitation-id"]; - }; - }; + readonly invitation_id: components['parameters']['invitation-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["repository-invitation"]; - }; - }; - }; + readonly 'application/json': components['schemas']['repository-invitation'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description The permissions that the associated user will have on the repository. Valid values are `read`, `write`, `maintain`, `triage`, and `admin`. * @enum {string} */ - readonly permissions?: "read" | "write" | "maintain" | "triage" | "admin"; - }; - }; - }; - }; + readonly permissions?: 'read' | 'write' | 'maintain' | 'triage' | 'admin' + } + } + } + } /** * List issues in a repository. * @@ -33060,326 +33022,326 @@ export interface operations { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - readonly "issues/list-for-repo": { + readonly 'issues/list-for-repo': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } readonly query: { /** If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned. */ - readonly milestone?: string; + readonly milestone?: string /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ - readonly state?: "open" | "closed" | "all"; + readonly state?: 'open' | 'closed' | 'all' /** Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user. */ - readonly assignee?: string; + readonly assignee?: string /** The user that created the issue. */ - readonly creator?: string; + readonly creator?: string /** A user that's mentioned in the issue. */ - readonly mentioned?: string; + readonly mentioned?: string /** A list of comma separated label names. Example: `bug,ui,@high` */ - readonly labels?: components["parameters"]["labels"]; + readonly labels?: components['parameters']['labels'] /** What to sort results by. Can be either `created`, `updated`, `comments`. */ - readonly sort?: "created" | "updated" | "comments"; + readonly sort?: 'created' | 'updated' | 'comments' /** One of `asc` (ascending) or `desc` (descending). */ - readonly direction?: components["parameters"]["direction"]; + readonly direction?: components['parameters']['direction'] /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; + readonly since?: components['parameters']['since'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["issue"][]; - }; - }; - readonly 301: components["responses"]["moved_permanently"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; + readonly 'application/json': readonly components['schemas']['issue'][] + } + } + readonly 301: components['responses']['moved_permanently'] + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } + } /** * Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - readonly "issues/create": { + readonly 'issues/create': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 201: { readonly headers: { - readonly Location?: string; - }; - readonly content: { - readonly "application/json": components["schemas"]["issue"]; - }; - }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 503: components["responses"]["service_unavailable"]; - }; + readonly Location?: string + } + readonly content: { + readonly 'application/json': components['schemas']['issue'] + } + } + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 410: components['responses']['gone'] + readonly 422: components['responses']['validation_failed'] + readonly 503: components['responses']['service_unavailable'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The title of the issue. */ - readonly title: string | number; + readonly title: string | number /** @description The contents of the issue. */ - readonly body?: string; + readonly body?: string /** @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_ */ - readonly assignee?: string | null; - readonly milestone?: (string | number) | null; + readonly assignee?: string | null + readonly milestone?: (string | number) | null /** @description Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._ */ readonly labels?: readonly ( | string | { - readonly id?: number; - readonly name?: string; - readonly description?: string | null; - readonly color?: string | null; + readonly id?: number + readonly name?: string + readonly description?: string | null + readonly color?: string | null } - )[]; + )[] /** @description Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ */ - readonly assignees?: readonly string[]; - }; - }; - }; - }; + readonly assignees?: readonly string[] + } + } + } + } /** By default, Issue Comments are ordered by ascending ID. */ - readonly "issues/list-comments-for-repo": { + readonly 'issues/list-comments-for-repo': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } readonly query: { /** One of `created` (when the repository was starred) or `updated` (when it was last pushed to). */ - readonly sort?: components["parameters"]["sort"]; + readonly sort?: components['parameters']['sort'] /** Either `asc` or `desc`. Ignored without the `sort` parameter. */ - readonly direction?: "asc" | "desc"; + readonly direction?: 'asc' | 'desc' /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; + readonly since?: components['parameters']['since'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["issue-comment"][]; - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; - readonly "issues/get-comment": { + readonly 'application/json': readonly components['schemas']['issue-comment'][] + } + } + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } + } + readonly 'issues/get-comment': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** comment_id parameter */ - readonly comment_id: components["parameters"]["comment-id"]; - }; - }; + readonly comment_id: components['parameters']['comment-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["issue-comment"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "issues/delete-comment": { + readonly 'application/json': components['schemas']['issue-comment'] + } + } + readonly 404: components['responses']['not_found'] + } + } + readonly 'issues/delete-comment': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** comment_id parameter */ - readonly comment_id: components["parameters"]["comment-id"]; - }; - }; + readonly comment_id: components['parameters']['comment-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; - readonly "issues/update-comment": { + readonly 204: never + } + } + readonly 'issues/update-comment': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** comment_id parameter */ - readonly comment_id: components["parameters"]["comment-id"]; - }; - }; + readonly comment_id: components['parameters']['comment-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["issue-comment"]; - }; - }; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': components['schemas']['issue-comment'] + } + } + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The contents of the comment. */ - readonly body: string; - }; - }; - }; - }; + readonly body: string + } + } + } + } /** List the reactions to an [issue comment](https://docs.github.com/rest/reference/issues#comments). */ - readonly "reactions/list-for-issue-comment": { + readonly 'reactions/list-for-issue-comment': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** comment_id parameter */ - readonly comment_id: components["parameters"]["comment-id"]; - }; + readonly comment_id: components['parameters']['comment-id'] + } readonly query: { /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue comment. */ - readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + readonly content?: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["reaction"][]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': readonly components['schemas']['reaction'][] + } + } + readonly 404: components['responses']['not_found'] + } + } /** Create a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. */ - readonly "reactions/create-for-issue-comment": { + readonly 'reactions/create-for-issue-comment': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** comment_id parameter */ - readonly comment_id: components["parameters"]["comment-id"]; - }; - }; + readonly comment_id: components['parameters']['comment-id'] + } + } readonly responses: { /** Reaction exists */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["reaction"]; - }; - }; + readonly 'application/json': components['schemas']['reaction'] + } + } /** Reaction created */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["reaction"]; - }; - }; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': components['schemas']['reaction'] + } + } + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the issue comment. * @enum {string} */ - readonly content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - }; + readonly content: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' + } + } + } + } /** * **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. * * Delete a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). */ - readonly "reactions/delete-for-issue-comment": { + readonly 'reactions/delete-for-issue-comment': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** comment_id parameter */ - readonly comment_id: components["parameters"]["comment-id"]; - readonly reaction_id: components["parameters"]["reaction-id"]; - }; - }; + readonly comment_id: components['parameters']['comment-id'] + readonly reaction_id: components['parameters']['reaction-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; - readonly "issues/list-events-for-repo": { + readonly 204: never + } + } + readonly 'issues/list-events-for-repo': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["issue-event"][]; - }; - }; - readonly 422: components["responses"]["validation_failed"]; - }; - }; - readonly "issues/get-event": { + readonly 'application/json': readonly components['schemas']['issue-event'][] + } + } + readonly 422: components['responses']['validation_failed'] + } + } + readonly 'issues/get-event': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly event_id: number; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly event_id: number + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["issue-event"]; - }; - }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; - }; - }; + readonly 'application/json': components['schemas']['issue-event'] + } + } + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 410: components['responses']['gone'] + } + } /** * The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was * [transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If @@ -33393,394 +33355,394 @@ export interface operations { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - readonly "issues/get": { + readonly 'issues/get': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** issue_number parameter */ - readonly issue_number: components["parameters"]["issue-number"]; - }; - }; + readonly issue_number: components['parameters']['issue-number'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["issue"]; - }; - }; - readonly 301: components["responses"]["moved_permanently"]; - readonly 304: components["responses"]["not_modified"]; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; - }; - }; + readonly 'application/json': components['schemas']['issue'] + } + } + readonly 301: components['responses']['moved_permanently'] + readonly 304: components['responses']['not_modified'] + readonly 404: components['responses']['not_found'] + readonly 410: components['responses']['gone'] + } + } /** Issue owners and users with push access can edit an issue. */ - readonly "issues/update": { + readonly 'issues/update': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** issue_number parameter */ - readonly issue_number: components["parameters"]["issue-number"]; - }; - }; + readonly issue_number: components['parameters']['issue-number'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["issue"]; - }; - }; - readonly 301: components["responses"]["moved_permanently"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 503: components["responses"]["service_unavailable"]; - }; + readonly 'application/json': components['schemas']['issue'] + } + } + readonly 301: components['responses']['moved_permanently'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 410: components['responses']['gone'] + readonly 422: components['responses']['validation_failed'] + readonly 503: components['responses']['service_unavailable'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The title of the issue. */ - readonly title?: (string | number) | null; + readonly title?: (string | number) | null /** @description The contents of the issue. */ - readonly body?: string | null; + readonly body?: string | null /** @description Login for the user that this issue should be assigned to. **This field is deprecated.** */ - readonly assignee?: string | null; + readonly assignee?: string | null /** * @description State of the issue. Either `open` or `closed`. * @enum {string} */ - readonly state?: "open" | "closed"; - readonly milestone?: (string | number) | null; + readonly state?: 'open' | 'closed' + readonly milestone?: (string | number) | null /** @description Labels to associate with this issue. Pass one or more Labels to _replace_ the set of Labels on this Issue. Send an empty array (`[]`) to clear all Labels from the Issue. _NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise._ */ readonly labels?: readonly ( | string | { - readonly id?: number; - readonly name?: string; - readonly description?: string | null; - readonly color?: string | null; + readonly id?: number + readonly name?: string + readonly description?: string | null + readonly color?: string | null } - )[]; + )[] /** @description Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ */ - readonly assignees?: readonly string[]; - }; - }; - }; - }; + readonly assignees?: readonly string[] + } + } + } + } /** Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced. */ - readonly "issues/add-assignees": { + readonly 'issues/add-assignees': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** issue_number parameter */ - readonly issue_number: components["parameters"]["issue-number"]; - }; - }; + readonly issue_number: components['parameters']['issue-number'] + } + } readonly responses: { /** Response */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["issue"]; - }; - }; - }; + readonly 'application/json': components['schemas']['issue'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._ */ - readonly assignees?: readonly string[]; - }; - }; - }; - }; + readonly assignees?: readonly string[] + } + } + } + } /** Removes one or more assignees from an issue. */ - readonly "issues/remove-assignees": { + readonly 'issues/remove-assignees': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** issue_number parameter */ - readonly issue_number: components["parameters"]["issue-number"]; - }; - }; + readonly issue_number: components['parameters']['issue-number'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["issue"]; - }; - }; - }; + readonly 'application/json': components['schemas']['issue'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._ */ - readonly assignees?: readonly string[]; - }; - }; - }; - }; + readonly assignees?: readonly string[] + } + } + } + } /** Issue Comments are ordered by ascending ID. */ - readonly "issues/list-comments": { + readonly 'issues/list-comments': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** issue_number parameter */ - readonly issue_number: components["parameters"]["issue-number"]; - }; + readonly issue_number: components['parameters']['issue-number'] + } readonly query: { /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; + readonly since?: components['parameters']['since'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["issue-comment"][]; - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; - }; - }; + readonly 'application/json': readonly components['schemas']['issue-comment'][] + } + } + readonly 404: components['responses']['not_found'] + readonly 410: components['responses']['gone'] + } + } /** This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - readonly "issues/create-comment": { + readonly 'issues/create-comment': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** issue_number parameter */ - readonly issue_number: components["parameters"]["issue-number"]; - }; - }; + readonly issue_number: components['parameters']['issue-number'] + } + } readonly responses: { /** Response */ readonly 201: { readonly headers: { - readonly Location?: string; - }; - readonly content: { - readonly "application/json": components["schemas"]["issue-comment"]; - }; - }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly Location?: string + } + readonly content: { + readonly 'application/json': components['schemas']['issue-comment'] + } + } + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 410: components['responses']['gone'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The contents of the comment. */ - readonly body: string; - }; - }; - }; - }; - readonly "issues/list-events": { + readonly body: string + } + } + } + } + readonly 'issues/list-events': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** issue_number parameter */ - readonly issue_number: components["parameters"]["issue-number"]; - }; + readonly issue_number: components['parameters']['issue-number'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["issue-event-for-issue"][]; - }; - }; - readonly 410: components["responses"]["gone"]; - }; - }; - readonly "issues/list-labels-on-issue": { + readonly 'application/json': readonly components['schemas']['issue-event-for-issue'][] + } + } + readonly 410: components['responses']['gone'] + } + } + readonly 'issues/list-labels-on-issue': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** issue_number parameter */ - readonly issue_number: components["parameters"]["issue-number"]; - }; + readonly issue_number: components['parameters']['issue-number'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["label"][]; - }; - }; - readonly 410: components["responses"]["gone"]; - }; - }; + readonly 'application/json': readonly components['schemas']['label'][] + } + } + readonly 410: components['responses']['gone'] + } + } /** Removes any previous labels and sets the new labels for an issue. */ - readonly "issues/set-labels": { + readonly 'issues/set-labels': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** issue_number parameter */ - readonly issue_number: components["parameters"]["issue-number"]; - }; - }; + readonly issue_number: components['parameters']['issue-number'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["label"][]; - }; - }; - readonly 410: components["responses"]["gone"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': readonly components['schemas']['label'][] + } + } + readonly 410: components['responses']['gone'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": + readonly 'application/json': | { /** @description The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see "[Add labels to an issue](https://docs.github.com/rest/reference/issues#add-labels-to-an-issue)." */ - readonly labels?: readonly string[]; + readonly labels?: readonly string[] } | readonly string[] | { readonly labels?: readonly { - readonly name: string; - }[]; + readonly name: string + }[] } | readonly { - readonly name: string; + readonly name: string }[] - | string; - }; - }; - }; - readonly "issues/add-labels": { + | string + } + } + } + readonly 'issues/add-labels': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** issue_number parameter */ - readonly issue_number: components["parameters"]["issue-number"]; - }; - }; + readonly issue_number: components['parameters']['issue-number'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["label"][]; - }; - }; - readonly 410: components["responses"]["gone"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': readonly components['schemas']['label'][] + } + } + readonly 410: components['responses']['gone'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": + readonly 'application/json': | { /** @description The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also replace all of the labels for an issue. For more information, see "[Set labels for an issue](https://docs.github.com/rest/reference/issues#set-labels-for-an-issue)." */ - readonly labels?: readonly string[]; + readonly labels?: readonly string[] } | readonly string[] | { readonly labels?: readonly { - readonly name: string; - }[]; + readonly name: string + }[] } | readonly { - readonly name: string; + readonly name: string }[] - | string; - }; - }; - }; - readonly "issues/remove-all-labels": { + | string + } + } + } + readonly 'issues/remove-all-labels': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** issue_number parameter */ - readonly issue_number: components["parameters"]["issue-number"]; - }; - }; + readonly issue_number: components['parameters']['issue-number'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 410: components["responses"]["gone"]; - }; - }; + readonly 204: never + readonly 410: components['responses']['gone'] + } + } /** Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist. */ - readonly "issues/remove-label": { + readonly 'issues/remove-label': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** issue_number parameter */ - readonly issue_number: components["parameters"]["issue-number"]; - readonly name: string; - }; - }; + readonly issue_number: components['parameters']['issue-number'] + readonly name: string + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["label"][]; - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; - }; - }; + readonly 'application/json': readonly components['schemas']['label'][] + } + } + readonly 404: components['responses']['not_found'] + readonly 410: components['responses']['gone'] + } + } /** * Users with push access can lock an issue or pull request's conversation. * * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - readonly "issues/lock": { + readonly 'issues/lock': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** issue_number parameter */ - readonly issue_number: components["parameters"]["issue-number"]; - }; - }; + readonly issue_number: components['parameters']['issue-number'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 204: never + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 410: components['responses']['gone'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: * \* `off-topic` @@ -33789,379 +33751,379 @@ export interface operations { * \* `spam` * @enum {string} */ - readonly lock_reason?: "off-topic" | "too heated" | "resolved" | "spam"; - } | null; - }; - }; - }; + readonly lock_reason?: 'off-topic' | 'too heated' | 'resolved' | 'spam' + } | null + } + } + } /** Users with push access can unlock an issue's conversation. */ - readonly "issues/unlock": { + readonly 'issues/unlock': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** issue_number parameter */ - readonly issue_number: components["parameters"]["issue-number"]; - }; - }; + readonly issue_number: components['parameters']['issue-number'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 204: never + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } /** List the reactions to an [issue](https://docs.github.com/rest/reference/issues). */ - readonly "reactions/list-for-issue": { + readonly 'reactions/list-for-issue': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** issue_number parameter */ - readonly issue_number: components["parameters"]["issue-number"]; - }; + readonly issue_number: components['parameters']['issue-number'] + } readonly query: { /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue. */ - readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + readonly content?: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["reaction"][]; - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; - }; - }; + readonly 'application/json': readonly components['schemas']['reaction'][] + } + } + readonly 404: components['responses']['not_found'] + readonly 410: components['responses']['gone'] + } + } /** Create a reaction to an [issue](https://docs.github.com/rest/reference/issues/). A response with an HTTP `200` status means that you already added the reaction type to this issue. */ - readonly "reactions/create-for-issue": { + readonly 'reactions/create-for-issue': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** issue_number parameter */ - readonly issue_number: components["parameters"]["issue-number"]; - }; - }; + readonly issue_number: components['parameters']['issue-number'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["reaction"]; - }; - }; + readonly 'application/json': components['schemas']['reaction'] + } + } /** Response */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["reaction"]; - }; - }; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': components['schemas']['reaction'] + } + } + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the issue. * @enum {string} */ - readonly content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - }; + readonly content: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' + } + } + } + } /** * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. * * Delete a reaction to an [issue](https://docs.github.com/rest/reference/issues/). */ - readonly "reactions/delete-for-issue": { + readonly 'reactions/delete-for-issue': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** issue_number parameter */ - readonly issue_number: components["parameters"]["issue-number"]; - readonly reaction_id: components["parameters"]["reaction-id"]; - }; - }; + readonly issue_number: components['parameters']['issue-number'] + readonly reaction_id: components['parameters']['reaction-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; - readonly "issues/list-events-for-timeline": { + readonly 204: never + } + } + readonly 'issues/list-events-for-timeline': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** issue_number parameter */ - readonly issue_number: components["parameters"]["issue-number"]; - }; + readonly issue_number: components['parameters']['issue-number'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["timeline-issue-events"][]; - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; - }; - }; - readonly "repos/list-deploy-keys": { + readonly 'application/json': readonly components['schemas']['timeline-issue-events'][] + } + } + readonly 404: components['responses']['not_found'] + readonly 410: components['responses']['gone'] + } + } + readonly 'repos/list-deploy-keys': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["deploy-key"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['deploy-key'][] + } + } + } + } /** You can create a read-only deploy key. */ - readonly "repos/create-deploy-key": { + readonly 'repos/create-deploy-key': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 201: { readonly headers: { - readonly Location?: string; - }; - readonly content: { - readonly "application/json": components["schemas"]["deploy-key"]; - }; - }; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly Location?: string + } + readonly content: { + readonly 'application/json': components['schemas']['deploy-key'] + } + } + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description A name for the key. */ - readonly title?: string; + readonly title?: string /** @description The contents of the key. */ - readonly key: string; + readonly key: string /** * @description If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. * * Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)" and "[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/)." */ - readonly read_only?: boolean; - }; - }; - }; - }; - readonly "repos/get-deploy-key": { + readonly read_only?: boolean + } + } + } + } + readonly 'repos/get-deploy-key': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** key_id parameter */ - readonly key_id: components["parameters"]["key-id"]; - }; - }; + readonly key_id: components['parameters']['key-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["deploy-key"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': components['schemas']['deploy-key'] + } + } + readonly 404: components['responses']['not_found'] + } + } /** Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead. */ - readonly "repos/delete-deploy-key": { + readonly 'repos/delete-deploy-key': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** key_id parameter */ - readonly key_id: components["parameters"]["key-id"]; - }; - }; + readonly key_id: components['parameters']['key-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; - readonly "issues/list-labels-for-repo": { + readonly 204: never + } + } + readonly 'issues/list-labels-for-repo': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["label"][]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "issues/create-label": { + readonly 'application/json': readonly components['schemas']['label'][] + } + } + readonly 404: components['responses']['not_found'] + } + } + readonly 'issues/create-label': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 201: { readonly headers: { - readonly Location?: string; - }; - readonly content: { - readonly "application/json": components["schemas"]["label"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly Location?: string + } + readonly content: { + readonly 'application/json': components['schemas']['label'] + } + } + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see "[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet)." */ - readonly name: string; + readonly name: string /** @description The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. */ - readonly color?: string; + readonly color?: string /** @description A short description of the label. Must be 100 characters or fewer. */ - readonly description?: string; - }; - }; - }; - }; - readonly "issues/get-label": { + readonly description?: string + } + } + } + } + readonly 'issues/get-label': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly name: string; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly name: string + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["label"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "issues/delete-label": { + readonly 'application/json': components['schemas']['label'] + } + } + readonly 404: components['responses']['not_found'] + } + } + readonly 'issues/delete-label': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly name: string; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly name: string + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; - readonly "issues/update-label": { + readonly 204: never + } + } + readonly 'issues/update-label': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly name: string; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly name: string + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["label"]; - }; - }; - }; + readonly 'application/json': components['schemas']['label'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see "[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet)." */ - readonly new_name?: string; + readonly new_name?: string /** @description The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. */ - readonly color?: string; + readonly color?: string /** @description A short description of the label. Must be 100 characters or fewer. */ - readonly description?: string; - }; - }; - }; - }; + readonly description?: string + } + } + } + } /** Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language. */ - readonly "repos/list-languages": { + readonly 'repos/list-languages': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["language"]; - }; - }; - }; - }; - readonly "repos/enable-lfs-for-repo": { + readonly 'application/json': components['schemas']['language'] + } + } + } + } + readonly 'repos/enable-lfs-for-repo': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { - readonly 202: components["responses"]["accepted"]; + readonly 202: components['responses']['accepted'] /** * We will return a 403 with one of the following messages: * @@ -34169,523 +34131,523 @@ export interface operations { * - Git LFS support not enabled because Git LFS is disabled for the root repository in the network. * - Git LFS support not enabled because Git LFS is disabled for . */ - readonly 403: unknown; - }; - }; - readonly "repos/disable-lfs-for-repo": { + readonly 403: unknown + } + } + readonly 'repos/disable-lfs-for-repo': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** * This method returns the contents of the repository's license file, if one is detected. * * Similar to [Get repository content](https://docs.github.com/rest/reference/repos#get-repository-content), this method also supports [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw license content or rendered license HTML. */ - readonly "licenses/get-for-repo": { + readonly 'licenses/get-for-repo': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["license-content"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['license-content'] + } + } + } + } /** Sync a branch of a forked repository to keep it up-to-date with the upstream repository. */ - readonly "repos/merge-upstream": { + readonly 'repos/merge-upstream': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** The branch has been successfully synced with the upstream repository */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["merged-upstream"]; - }; - }; + readonly 'application/json': components['schemas']['merged-upstream'] + } + } /** The branch could not be synced because of a merge conflict */ - readonly 409: unknown; + readonly 409: unknown /** The branch could not be synced for some other reason */ - readonly 422: unknown; - }; + readonly 422: unknown + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The name of the branch which should be updated to match upstream. */ - readonly branch: string; - }; - }; - }; - }; - readonly "repos/merge": { + readonly branch: string + } + } + } + } + readonly 'repos/merge': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Successful Response (The resulting merge commit) */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["commit"]; - }; - }; + readonly 'application/json': components['schemas']['commit'] + } + } /** Response when already merged */ - readonly 204: never; - readonly 403: components["responses"]["forbidden"]; + readonly 204: never + readonly 403: components['responses']['forbidden'] /** Not Found when the base or head does not exist */ - readonly 404: unknown; + readonly 404: unknown /** Conflict when there is a merge conflict */ - readonly 409: unknown; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 409: unknown + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The name of the base branch that the head will be merged into. */ - readonly base: string; + readonly base: string /** @description The head to merge. This can be a branch name or a commit SHA1. */ - readonly head: string; + readonly head: string /** @description Commit message to use for the merge commit. If omitted, a default message will be used. */ - readonly commit_message?: string; - }; - }; - }; - }; - readonly "issues/list-milestones": { + readonly commit_message?: string + } + } + } + } + readonly 'issues/list-milestones': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } readonly query: { /** The state of the milestone. Either `open`, `closed`, or `all`. */ - readonly state?: "open" | "closed" | "all"; + readonly state?: 'open' | 'closed' | 'all' /** What to sort results by. Either `due_on` or `completeness`. */ - readonly sort?: "due_on" | "completeness"; + readonly sort?: 'due_on' | 'completeness' /** The direction of the sort. Either `asc` or `desc`. */ - readonly direction?: "asc" | "desc"; + readonly direction?: 'asc' | 'desc' /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["milestone"][]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "issues/create-milestone": { + readonly 'application/json': readonly components['schemas']['milestone'][] + } + } + readonly 404: components['responses']['not_found'] + } + } + readonly 'issues/create-milestone': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 201: { readonly headers: { - readonly Location?: string; - }; - readonly content: { - readonly "application/json": components["schemas"]["milestone"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly Location?: string + } + readonly content: { + readonly 'application/json': components['schemas']['milestone'] + } + } + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The title of the milestone. */ - readonly title: string; + readonly title: string /** * @description The state of the milestone. Either `open` or `closed`. * @default open * @enum {string} */ - readonly state?: "open" | "closed"; + readonly state?: 'open' | 'closed' /** @description A description of the milestone. */ - readonly description?: string; + readonly description?: string /** * Format: date-time * @description The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly due_on?: string; - }; - }; - }; - }; - readonly "issues/get-milestone": { + readonly due_on?: string + } + } + } + } + readonly 'issues/get-milestone': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** milestone_number parameter */ - readonly milestone_number: components["parameters"]["milestone-number"]; - }; - }; + readonly milestone_number: components['parameters']['milestone-number'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["milestone"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "issues/delete-milestone": { + readonly 'application/json': components['schemas']['milestone'] + } + } + readonly 404: components['responses']['not_found'] + } + } + readonly 'issues/delete-milestone': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** milestone_number parameter */ - readonly milestone_number: components["parameters"]["milestone-number"]; - }; - }; + readonly milestone_number: components['parameters']['milestone-number'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "issues/update-milestone": { + readonly 204: never + readonly 404: components['responses']['not_found'] + } + } + readonly 'issues/update-milestone': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** milestone_number parameter */ - readonly milestone_number: components["parameters"]["milestone-number"]; - }; - }; + readonly milestone_number: components['parameters']['milestone-number'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["milestone"]; - }; - }; - }; + readonly 'application/json': components['schemas']['milestone'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The title of the milestone. */ - readonly title?: string; + readonly title?: string /** * @description The state of the milestone. Either `open` or `closed`. * @default open * @enum {string} */ - readonly state?: "open" | "closed"; + readonly state?: 'open' | 'closed' /** @description A description of the milestone. */ - readonly description?: string; + readonly description?: string /** * Format: date-time * @description The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly due_on?: string; - }; - }; - }; - }; - readonly "issues/list-labels-for-milestone": { + readonly due_on?: string + } + } + } + } + readonly 'issues/list-labels-for-milestone': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** milestone_number parameter */ - readonly milestone_number: components["parameters"]["milestone-number"]; - }; + readonly milestone_number: components['parameters']['milestone-number'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["label"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['label'][] + } + } + } + } /** List all notifications for the current user. */ - readonly "activity/list-repo-notifications-for-authenticated-user": { + readonly 'activity/list-repo-notifications-for-authenticated-user': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } readonly query: { /** If `true`, show notifications marked as read. */ - readonly all?: components["parameters"]["all"]; + readonly all?: components['parameters']['all'] /** If `true`, only shows notifications in which the user is directly participating or mentioned. */ - readonly participating?: components["parameters"]["participating"]; + readonly participating?: components['parameters']['participating'] /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; + readonly since?: components['parameters']['since'] /** Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly before?: components["parameters"]["before"]; + readonly before?: components['parameters']['before'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["thread"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['thread'][] + } + } + } + } /** Marks all notifications in a repository as "read" removes them from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ - readonly "activity/mark-repo-notifications-as-read": { + readonly 'activity/mark-repo-notifications-as-read': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 202: { readonly content: { - readonly "application/json": { - readonly message?: string; - readonly url?: string; - }; - }; - }; + readonly 'application/json': { + readonly message?: string + readonly url?: string + } + } + } /** Reset Content */ - readonly 205: unknown; - }; + readonly 205: unknown + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * Format: date-time * @description Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. */ - readonly last_read_at?: string; - }; - }; - }; - }; - readonly "repos/get-pages": { + readonly last_read_at?: string + } + } + } + } + readonly 'repos/get-pages': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["page"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': components['schemas']['page'] + } + } + readonly 404: components['responses']['not_found'] + } + } /** Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). */ - readonly "repos/update-information-about-pages-site": { + readonly 'repos/update-information-about-pages-site': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 400: components["responses"]["bad_request"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 204: never + readonly 400: components['responses']['bad_request'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/articles/using-a-custom-domain-with-github-pages/)." */ - readonly cname?: string | null; + readonly cname?: string | null /** @description Specify whether HTTPS should be enforced for the repository. */ - readonly https_enforced?: boolean; + readonly https_enforced?: boolean /** @description Configures access controls for the GitHub Pages site. If public is set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to `internal` visibility. This feature is only available to repositories in an organization on an Enterprise plan. */ - readonly public?: boolean; - readonly source?: Partial<"gh-pages" | "master" | "master /docs"> & + readonly public?: boolean + readonly source?: Partial<'gh-pages' | 'master' | 'master /docs'> & Partial<{ /** @description The repository branch used to publish your site's source files. */ - readonly branch: string; + readonly branch: string /** * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. * @enum {string} */ - readonly path: "/" | "/docs"; - }>; - }; - }; - }; - }; + readonly path: '/' | '/docs' + }> + } + } + } + } /** Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)." */ - readonly "repos/create-pages-site": { + readonly 'repos/create-pages-site': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["page"]; - }; - }; - readonly 409: components["responses"]["conflict"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': components['schemas']['page'] + } + } + readonly 409: components['responses']['conflict'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The source branch and directory used to publish your Pages site. */ readonly source: { /** @description The repository branch used to publish your site's source files. */ - readonly branch: string; + readonly branch: string /** * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/` * @default / * @enum {string} */ - readonly path?: "/" | "/docs"; - }; - } | null; - }; - }; - }; - readonly "repos/delete-pages-site": { + readonly path?: '/' | '/docs' + } + } | null + } + } + } + readonly 'repos/delete-pages-site': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; - readonly "repos/list-pages-builds": { + readonly 204: never + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } + } + readonly 'repos/list-pages-builds': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["page-build"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['page-build'][] + } + } + } + } /** * You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures. * * Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes. */ - readonly "repos/request-pages-build": { + readonly 'repos/request-pages-build': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["page-build-status"]; - }; - }; - }; - }; - readonly "repos/get-latest-pages-build": { + readonly 'application/json': components['schemas']['page-build-status'] + } + } + } + } + readonly 'repos/get-latest-pages-build': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["page-build"]; - }; - }; - }; - }; - readonly "repos/get-pages-build": { + readonly 'application/json': components['schemas']['page-build'] + } + } + } + } + readonly 'repos/get-pages-build': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly build_id: number; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly build_id: number + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["page-build"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['page-build'] + } + } + } + } /** * Gets a health check of the DNS settings for the `CNAME` record configured for a repository's GitHub Pages. * @@ -34693,132 +34655,132 @@ export interface operations { * * Users must have admin or owner permissions. GitHub Apps must have the `pages:write` and `administration:write` permission to use this endpoint. */ - readonly "repos/get-pages-health-check": { + readonly 'repos/get-pages-health-check': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["pages-health-check"]; - }; - }; + readonly 'application/json': components['schemas']['pages-health-check'] + } + } /** Empty response */ readonly 202: { readonly content: { - readonly "application/json": components["schemas"]["empty-object"]; - }; - }; + readonly 'application/json': components['schemas']['empty-object'] + } + } /** Custom domains are not available for GitHub Pages */ - readonly 400: unknown; - readonly 404: components["responses"]["not_found"]; + readonly 400: unknown + readonly 404: components['responses']['not_found'] /** There isn't a CNAME for this page */ - readonly 422: unknown; - }; - }; + readonly 422: unknown + } + } /** Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - readonly "projects/list-for-repo": { + readonly 'projects/list-for-repo': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } readonly query: { /** Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. */ - readonly state?: "open" | "closed" | "all"; + readonly state?: 'open' | 'closed' | 'all' /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["project"][]; - }; - }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; - readonly 422: components["responses"]["validation_failed_simple"]; - }; - }; + readonly 'application/json': readonly components['schemas']['project'][] + } + } + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 410: components['responses']['gone'] + readonly 422: components['responses']['validation_failed_simple'] + } + } /** Creates a repository project board. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - readonly "projects/create-for-repo": { + readonly 'projects/create-for-repo': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["project"]; - }; - }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; - readonly 422: components["responses"]["validation_failed_simple"]; - }; + readonly 'application/json': components['schemas']['project'] + } + } + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 410: components['responses']['gone'] + readonly 422: components['responses']['validation_failed_simple'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The name of the project. */ - readonly name: string; + readonly name: string /** @description The description of the project. */ - readonly body?: string; - }; - }; - }; - }; + readonly body?: string + } + } + } + } /** Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly "pulls/list": { + readonly 'pulls/list': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } readonly query: { /** Either `open`, `closed`, or `all` to filter by state. */ - readonly state?: "open" | "closed" | "all"; + readonly state?: 'open' | 'closed' | 'all' /** Filter pulls by head user or head organization and branch name in the format of `user:ref-name` or `organization:ref-name`. For example: `github:new-script-format` or `octocat:test-branch`. */ - readonly head?: string; + readonly head?: string /** Filter pulls by base branch name. Example: `gh-pages`. */ - readonly base?: string; + readonly base?: string /** What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month). */ - readonly sort?: "created" | "updated" | "popularity" | "long-running"; + readonly sort?: 'created' | 'updated' | 'popularity' | 'long-running' /** The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`. */ - readonly direction?: "asc" | "desc"; + readonly direction?: 'asc' | 'desc' /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["pull-request-simple"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; + readonly 'application/json': readonly components['schemas']['pull-request-simple'][] + } + } + readonly 304: components['responses']['not_modified'] + readonly 422: components['responses']['validation_failed'] + } + } /** * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -34828,225 +34790,225 @@ export interface operations { * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. */ - readonly "pulls/create": { + readonly 'pulls/create': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 201: { readonly headers: { - readonly Location?: string; - }; - readonly content: { - readonly "application/json": components["schemas"]["pull-request"]; - }; - }; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly Location?: string + } + readonly content: { + readonly 'application/json': components['schemas']['pull-request'] + } + } + readonly 403: components['responses']['forbidden'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The title of the new pull request. */ - readonly title?: string; + readonly title?: string /** @description The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`. */ - readonly head: string; + readonly head: string /** @description The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository. */ - readonly base: string; + readonly base: string /** @description The contents of the pull request. */ - readonly body?: string; + readonly body?: string /** @description Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. */ - readonly maintainer_can_modify?: boolean; + readonly maintainer_can_modify?: boolean /** @description Indicates whether the pull request is a draft. See "[Draft Pull Requests](https://docs.github.com/en/articles/about-pull-requests#draft-pull-requests)" in the GitHub Help documentation to learn more. */ - readonly draft?: boolean; + readonly draft?: boolean /** @example 1 */ - readonly issue?: number; - }; - }; - }; - }; + readonly issue?: number + } + } + } + } /** Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID. */ - readonly "pulls/list-review-comments-for-repo": { + readonly 'pulls/list-review-comments-for-repo': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } readonly query: { - readonly sort?: "created" | "updated" | "created_at"; + readonly sort?: 'created' | 'updated' | 'created_at' /** Can be either `asc` or `desc`. Ignored without `sort` parameter. */ - readonly direction?: "asc" | "desc"; + readonly direction?: 'asc' | 'desc' /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; + readonly since?: components['parameters']['since'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["pull-request-review-comment"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['pull-request-review-comment'][] + } + } + } + } /** Provides details for a review comment. */ - readonly "pulls/get-review-comment": { + readonly 'pulls/get-review-comment': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** comment_id parameter */ - readonly comment_id: components["parameters"]["comment-id"]; - }; - }; + readonly comment_id: components['parameters']['comment-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["pull-request-review-comment"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': components['schemas']['pull-request-review-comment'] + } + } + readonly 404: components['responses']['not_found'] + } + } /** Deletes a review comment. */ - readonly "pulls/delete-review-comment": { + readonly 'pulls/delete-review-comment': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** comment_id parameter */ - readonly comment_id: components["parameters"]["comment-id"]; - }; - }; + readonly comment_id: components['parameters']['comment-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 204: never + readonly 404: components['responses']['not_found'] + } + } /** Enables you to edit a review comment. */ - readonly "pulls/update-review-comment": { + readonly 'pulls/update-review-comment': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** comment_id parameter */ - readonly comment_id: components["parameters"]["comment-id"]; - }; - }; + readonly comment_id: components['parameters']['comment-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["pull-request-review-comment"]; - }; - }; - }; + readonly 'application/json': components['schemas']['pull-request-review-comment'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The text of the reply to the review comment. */ - readonly body: string; - }; - }; - }; - }; + readonly body: string + } + } + } + } /** List the reactions to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). */ - readonly "reactions/list-for-pull-request-review-comment": { + readonly 'reactions/list-for-pull-request-review-comment': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** comment_id parameter */ - readonly comment_id: components["parameters"]["comment-id"]; - }; + readonly comment_id: components['parameters']['comment-id'] + } readonly query: { /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a pull request review comment. */ - readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + readonly content?: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["reaction"][]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': readonly components['schemas']['reaction'][] + } + } + readonly 404: components['responses']['not_found'] + } + } /** Create a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#comments). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. */ - readonly "reactions/create-for-pull-request-review-comment": { + readonly 'reactions/create-for-pull-request-review-comment': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** comment_id parameter */ - readonly comment_id: components["parameters"]["comment-id"]; - }; - }; + readonly comment_id: components['parameters']['comment-id'] + } + } readonly responses: { /** Reaction exists */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["reaction"]; - }; - }; + readonly 'application/json': components['schemas']['reaction'] + } + } /** Reaction created */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["reaction"]; - }; - }; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': components['schemas']['reaction'] + } + } + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the pull request review comment. * @enum {string} */ - readonly content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - }; + readonly content: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' + } + } + } + } /** * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` * * Delete a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). */ - readonly "reactions/delete-for-pull-request-comment": { + readonly 'reactions/delete-for-pull-request-comment': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** comment_id parameter */ - readonly comment_id: components["parameters"]["comment-id"]; - readonly reaction_id: components["parameters"]["reaction-id"]; - }; - }; + readonly comment_id: components['parameters']['comment-id'] + readonly reaction_id: components['parameters']['reaction-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -35064,145 +35026,145 @@ export interface operations { * * Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. */ - readonly "pulls/get": { + readonly 'pulls/get': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly pull_number: components["parameters"]["pull-number"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly pull_number: components['parameters']['pull-number'] + } + } readonly responses: { /** Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["pull-request"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; - }; - }; + readonly 'application/json': components['schemas']['pull-request'] + } + } + readonly 304: components['responses']['not_modified'] + readonly 404: components['responses']['not_found'] + readonly 500: components['responses']['internal_error'] + } + } /** * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. */ - readonly "pulls/update": { + readonly 'pulls/update': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly pull_number: components["parameters"]["pull-number"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly pull_number: components['parameters']['pull-number'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["pull-request"]; - }; - }; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': components['schemas']['pull-request'] + } + } + readonly 403: components['responses']['forbidden'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The title of the pull request. */ - readonly title?: string; + readonly title?: string /** @description The contents of the pull request. */ - readonly body?: string; + readonly body?: string /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ - readonly state?: "open" | "closed"; + readonly state?: 'open' | 'closed' /** @description The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository. */ - readonly base?: string; + readonly base?: string /** @description Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. */ - readonly maintainer_can_modify?: boolean; - }; - }; - }; - }; + readonly maintainer_can_modify?: boolean + } + } + } + } /** * Creates a codespace owned by the authenticated user for the specified pull request. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - readonly "codespaces/create-with-pr-for-authenticated-user": { + readonly 'codespaces/create-with-pr-for-authenticated-user': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly pull_number: components["parameters"]["pull-number"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly pull_number: components['parameters']['pull-number'] + } + } readonly responses: { /** Response when the codespace was successfully created */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["codespace"]; - }; - }; + readonly 'application/json': components['schemas']['codespace'] + } + } /** Response when the codespace creation partially failed but is being retried in the background */ readonly 202: { readonly content: { - readonly "application/json": components["schemas"]["codespace"]; - }; - }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; + readonly 'application/json': components['schemas']['codespace'] + } + } + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Location for this codespace */ - readonly location: string; + readonly location: string /** @description Machine type to use for this codespace */ - readonly machine?: string; + readonly machine?: string /** @description Working directory for this codespace */ - readonly working_directory?: string; + readonly working_directory?: string /** @description Time in minutes before codespace stops from inactivity */ - readonly idle_timeout_minutes?: number; - }; - }; - }; - }; + readonly idle_timeout_minutes?: number + } + } + } + } /** Lists all review comments for a pull request. By default, review comments are in ascending order by ID. */ - readonly "pulls/list-review-comments": { + readonly 'pulls/list-review-comments': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly pull_number: components["parameters"]["pull-number"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly pull_number: components['parameters']['pull-number'] + } readonly query: { /** One of `created` (when the repository was starred) or `updated` (when it was last pushed to). */ - readonly sort?: components["parameters"]["sort"]; + readonly sort?: components['parameters']['sort'] /** Can be either `asc` or `desc`. Ignored without `sort` parameter. */ - readonly direction?: "asc" | "desc"; + readonly direction?: 'asc' | 'desc' /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; + readonly since?: components['parameters']['since'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["pull-request-review-comment"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['pull-request-review-comment'][] + } + } + } + } /** * Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/reference/issues#create-an-issue-comment)." We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff. * @@ -35212,328 +35174,328 @@ export interface operations { * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - readonly "pulls/create-review-comment": { + readonly 'pulls/create-review-comment': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly pull_number: components["parameters"]["pull-number"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly pull_number: components['parameters']['pull-number'] + } + } readonly responses: { /** Response */ readonly 201: { readonly headers: { - readonly Location?: string; - }; - readonly content: { - readonly "application/json": components["schemas"]["pull-request-review-comment"]; - }; - }; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly Location?: string + } + readonly content: { + readonly 'application/json': components['schemas']['pull-request-review-comment'] + } + } + readonly 403: components['responses']['forbidden'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The text of the review comment. */ - readonly body: string; + readonly body: string /** @description The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`. */ - readonly commit_id?: string; + readonly commit_id?: string /** @description The relative path to the file that necessitates a comment. */ - readonly path?: string; + readonly path?: string /** @description **Required without `comfort-fade` preview unless using `in_reply_to`**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above. */ - readonly position?: number; + readonly position?: number /** * @description **Required with `comfort-fade` preview unless using `in_reply_to`**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "[Diff view options](https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation. * @enum {string} */ - readonly side?: "LEFT" | "RIGHT"; + readonly side?: 'LEFT' | 'RIGHT' /** @description **Required with `comfort-fade` preview unless using `in_reply_to`**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to. */ - readonly line?: number; + readonly line?: number /** @description **Required when using multi-line comments unless using `in_reply_to`**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. */ - readonly start_line?: number; + readonly start_line?: number /** * @description **Required when using multi-line comments unless using `in_reply_to`**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context. * @enum {string} */ - readonly start_side?: "LEFT" | "RIGHT" | "side"; + readonly start_side?: 'LEFT' | 'RIGHT' | 'side' /** * @description The ID of the review comment to reply to. To find the ID of a review comment with ["List review comments on a pull request"](#list-review-comments-on-a-pull-request). When specified, all parameters other than `body` in the request body are ignored. * @example 2 */ - readonly in_reply_to?: number; - }; - }; - }; - }; + readonly in_reply_to?: number + } + } + } + } /** * Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - readonly "pulls/create-reply-for-review-comment": { + readonly 'pulls/create-reply-for-review-comment': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly pull_number: components["parameters"]["pull-number"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly pull_number: components['parameters']['pull-number'] /** comment_id parameter */ - readonly comment_id: components["parameters"]["comment-id"]; - }; - }; + readonly comment_id: components['parameters']['comment-id'] + } + } readonly responses: { /** Response */ readonly 201: { readonly headers: { - readonly Location?: string; - }; - readonly content: { - readonly "application/json": components["schemas"]["pull-request-review-comment"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; + readonly Location?: string + } + readonly content: { + readonly 'application/json': components['schemas']['pull-request-review-comment'] + } + } + readonly 404: components['responses']['not_found'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The text of the review comment. */ - readonly body: string; - }; - }; - }; - }; + readonly body: string + } + } + } + } /** Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/reference/repos#list-commits) endpoint. */ - readonly "pulls/list-commits": { + readonly 'pulls/list-commits': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly pull_number: components["parameters"]["pull-number"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly pull_number: components['parameters']['pull-number'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["commit"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['commit'][] + } + } + } + } /** **Note:** Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. */ - readonly "pulls/list-files": { + readonly 'pulls/list-files': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly pull_number: components["parameters"]["pull-number"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly pull_number: components['parameters']['pull-number'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["diff-entry"][]; - }; - }; - readonly 422: components["responses"]["validation_failed"]; - readonly 500: components["responses"]["internal_error"]; - }; - }; - readonly "pulls/check-if-merged": { + readonly 'application/json': readonly components['schemas']['diff-entry'][] + } + } + readonly 422: components['responses']['validation_failed'] + readonly 500: components['responses']['internal_error'] + } + } + readonly 'pulls/check-if-merged': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly pull_number: components["parameters"]["pull-number"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly pull_number: components['parameters']['pull-number'] + } + } readonly responses: { /** Response if pull request has been merged */ - readonly 204: never; + readonly 204: never /** Not Found if pull request has not been merged */ - readonly 404: unknown; - }; - }; + readonly 404: unknown + } + } /** This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - readonly "pulls/merge": { + readonly 'pulls/merge': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly pull_number: components["parameters"]["pull-number"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly pull_number: components['parameters']['pull-number'] + } + } readonly responses: { /** if merge was successful */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["pull-request-merge-result"]; - }; - }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + readonly 'application/json': components['schemas']['pull-request-merge-result'] + } + } + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] /** Method Not Allowed if merge cannot be performed */ readonly 405: { readonly content: { - readonly "application/json": { - readonly message?: string; - readonly documentation_url?: string; - }; - }; - }; + readonly 'application/json': { + readonly message?: string + readonly documentation_url?: string + } + } + } /** Conflict if sha was provided and pull request head did not match */ readonly 409: { readonly content: { - readonly "application/json": { - readonly message?: string; - readonly documentation_url?: string; - }; - }; - }; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': { + readonly message?: string + readonly documentation_url?: string + } + } + } + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Title for the automatic commit message. */ - readonly commit_title?: string; + readonly commit_title?: string /** @description Extra detail to append to automatic commit message. */ - readonly commit_message?: string; + readonly commit_message?: string /** @description SHA that pull request head must match to allow merge. */ - readonly sha?: string; + readonly sha?: string /** * @description Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`. * @enum {string} */ - readonly merge_method?: "merge" | "squash" | "rebase"; - } | null; - }; - }; - }; - readonly "pulls/list-requested-reviewers": { - readonly parameters: { - readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly pull_number: components["parameters"]["pull-number"]; - }; + readonly merge_method?: 'merge' | 'squash' | 'rebase' + } | null + } + } + } + readonly 'pulls/list-requested-reviewers': { + readonly parameters: { + readonly path: { + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly pull_number: components['parameters']['pull-number'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": components["schemas"]["pull-request-review-request"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['pull-request-review-request'] + } + } + } + } /** This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - readonly "pulls/request-reviewers": { + readonly 'pulls/request-reviewers': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly pull_number: components["parameters"]["pull-number"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly pull_number: components['parameters']['pull-number'] + } + } readonly responses: { /** Response */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["pull-request-simple"]; - }; - }; - readonly 403: components["responses"]["forbidden"]; + readonly 'application/json': components['schemas']['pull-request-simple'] + } + } + readonly 403: components['responses']['forbidden'] /** Unprocessable Entity if user is not a collaborator */ - readonly 422: unknown; - }; + readonly 422: unknown + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description An array of user `login`s that will be requested. */ - readonly reviewers?: readonly string[]; + readonly reviewers?: readonly string[] /** @description An array of team `slug`s that will be requested. */ - readonly team_reviewers?: readonly string[]; - }; - }; - }; - }; - readonly "pulls/remove-requested-reviewers": { + readonly team_reviewers?: readonly string[] + } + } + } + } + readonly 'pulls/remove-requested-reviewers': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly pull_number: components["parameters"]["pull-number"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly pull_number: components['parameters']['pull-number'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["pull-request-simple"]; - }; - }; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': components['schemas']['pull-request-simple'] + } + } + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description An array of user `login`s that will be removed. */ - readonly reviewers: readonly string[]; + readonly reviewers: readonly string[] /** @description An array of team `slug`s that will be removed. */ - readonly team_reviewers?: readonly string[]; - }; - }; - }; - }; + readonly team_reviewers?: readonly string[] + } + } + } + } /** The list of reviews returns in chronological order. */ - readonly "pulls/list-reviews": { + readonly 'pulls/list-reviews': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly pull_number: components["parameters"]["pull-number"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly pull_number: components['parameters']['pull-number'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** The list of reviews returns in chronological order. */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["pull-request-review"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['pull-request-review'][] + } + } + } + } /** * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. * @@ -35543,636 +35505,636 @@ export interface operations { * * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. */ - readonly "pulls/create-review": { + readonly 'pulls/create-review': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly pull_number: components["parameters"]["pull-number"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly pull_number: components['parameters']['pull-number'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["pull-request-review"]; - }; - }; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed_simple"]; - }; + readonly 'application/json': components['schemas']['pull-request-review'] + } + } + readonly 403: components['responses']['forbidden'] + readonly 422: components['responses']['validation_failed_simple'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value. */ - readonly commit_id?: string; + readonly commit_id?: string /** @description **Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review. */ - readonly body?: string; + readonly body?: string /** * @description The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/rest/reference/pulls#submit-a-review-for-a-pull-request) when you are ready. * @enum {string} */ - readonly event?: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; + readonly event?: 'APPROVE' | 'REQUEST_CHANGES' | 'COMMENT' /** @description Use the following table to specify the location, destination, and contents of the draft review comment. */ readonly comments?: readonly { /** @description The relative path to the file that necessitates a review comment. */ - readonly path: string; + readonly path: string /** @description The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below. */ - readonly position?: number; + readonly position?: number /** @description Text of the review comment. */ - readonly body: string; + readonly body: string /** @example 28 */ - readonly line?: number; + readonly line?: number /** @example RIGHT */ - readonly side?: string; + readonly side?: string /** @example 26 */ - readonly start_line?: number; + readonly start_line?: number /** @example LEFT */ - readonly start_side?: string; - }[]; - }; - }; - }; - }; - readonly "pulls/get-review": { - readonly parameters: { - readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly pull_number: components["parameters"]["pull-number"]; + readonly start_side?: string + }[] + } + } + } + } + readonly 'pulls/get-review': { + readonly parameters: { + readonly path: { + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly pull_number: components['parameters']['pull-number'] /** review_id parameter */ - readonly review_id: components["parameters"]["review-id"]; - }; - }; + readonly review_id: components['parameters']['review-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["pull-request-review"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': components['schemas']['pull-request-review'] + } + } + readonly 404: components['responses']['not_found'] + } + } /** Update the review summary comment with new text. */ - readonly "pulls/update-review": { + readonly 'pulls/update-review': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly pull_number: components["parameters"]["pull-number"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly pull_number: components['parameters']['pull-number'] /** review_id parameter */ - readonly review_id: components["parameters"]["review-id"]; - }; - }; + readonly review_id: components['parameters']['review-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["pull-request-review"]; - }; - }; - readonly 422: components["responses"]["validation_failed_simple"]; - }; + readonly 'application/json': components['schemas']['pull-request-review'] + } + } + readonly 422: components['responses']['validation_failed_simple'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The body text of the pull request review. */ - readonly body: string; - }; - }; - }; - }; - readonly "pulls/delete-pending-review": { + readonly body: string + } + } + } + } + readonly 'pulls/delete-pending-review': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly pull_number: components["parameters"]["pull-number"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly pull_number: components['parameters']['pull-number'] /** review_id parameter */ - readonly review_id: components["parameters"]["review-id"]; - }; - }; + readonly review_id: components['parameters']['review-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["pull-request-review"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; - }; - }; + readonly 'application/json': components['schemas']['pull-request-review'] + } + } + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed_simple'] + } + } /** List comments for a specific pull request review. */ - readonly "pulls/list-comments-for-review": { + readonly 'pulls/list-comments-for-review': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly pull_number: components["parameters"]["pull-number"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly pull_number: components['parameters']['pull-number'] /** review_id parameter */ - readonly review_id: components["parameters"]["review-id"]; - }; + readonly review_id: components['parameters']['review-id'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["review-comment"][]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': readonly components['schemas']['review-comment'][] + } + } + readonly 404: components['responses']['not_found'] + } + } /** **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/reference/repos#branches), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. */ - readonly "pulls/dismiss-review": { + readonly 'pulls/dismiss-review': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly pull_number: components["parameters"]["pull-number"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly pull_number: components['parameters']['pull-number'] /** review_id parameter */ - readonly review_id: components["parameters"]["review-id"]; - }; - }; + readonly review_id: components['parameters']['review-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["pull-request-review"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; - }; + readonly 'application/json': components['schemas']['pull-request-review'] + } + } + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed_simple'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The message for the pull request review dismissal */ - readonly message: string; + readonly message: string /** @example "APPROVE" */ - readonly event?: string; - }; - }; - }; - }; - readonly "pulls/submit-review": { + readonly event?: string + } + } + } + } + readonly 'pulls/submit-review': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly pull_number: components["parameters"]["pull-number"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly pull_number: components['parameters']['pull-number'] /** review_id parameter */ - readonly review_id: components["parameters"]["review-id"]; - }; - }; + readonly review_id: components['parameters']['review-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["pull-request-review"]; - }; - }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; - }; + readonly 'application/json': components['schemas']['pull-request-review'] + } + } + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed_simple'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The body text of the pull request review */ - readonly body?: string; + readonly body?: string /** * @description The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When you leave this blank, the API returns _HTTP 422 (Unrecognizable entity)_ and sets the review action state to `PENDING`, which means you will need to re-submit the pull request review using a review action. * @enum {string} */ - readonly event: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; - }; - }; - }; - }; + readonly event: 'APPROVE' | 'REQUEST_CHANGES' | 'COMMENT' + } + } + } + } /** Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. */ - readonly "pulls/update-branch": { + readonly 'pulls/update-branch': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly pull_number: components["parameters"]["pull-number"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly pull_number: components['parameters']['pull-number'] + } + } readonly responses: { /** Response */ readonly 202: { readonly content: { - readonly "application/json": { - readonly message?: string; - readonly url?: string; - }; - }; - }; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': { + readonly message?: string + readonly url?: string + } + } + } + readonly 403: components['responses']['forbidden'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the "[List commits](https://docs.github.com/rest/reference/repos#list-commits)" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref. */ - readonly expected_head_sha?: string; - } | null; - }; - }; - }; + readonly expected_head_sha?: string + } | null + } + } + } /** * Gets the preferred README for a repository. * * READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. */ - readonly "repos/get-readme": { + readonly 'repos/get-readme': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } readonly query: { /** The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`) */ - readonly ref?: string; - }; - }; + readonly ref?: string + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["content-file"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; + readonly 'application/json': components['schemas']['content-file'] + } + } + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } + } /** * Gets the README from a repository directory. * * READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. */ - readonly "repos/get-readme-in-directory": { + readonly 'repos/get-readme-in-directory': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The alternate path to look for a README file */ - readonly dir: string; - }; + readonly dir: string + } readonly query: { /** The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`) */ - readonly ref?: string; - }; - }; + readonly ref?: string + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["content-file"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; + readonly 'application/json': components['schemas']['content-file'] + } + } + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } + } /** * This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/rest/reference/repos#list-repository-tags). * * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. */ - readonly "repos/list-releases": { + readonly 'repos/list-releases': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["release"][]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': readonly components['schemas']['release'][] + } + } + readonly 404: components['responses']['not_found'] + } + } /** * Users with push access to the repository can create a release. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - readonly "repos/create-release": { + readonly 'repos/create-release': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 201: { readonly headers: { - readonly Location?: string; - }; + readonly Location?: string + } readonly content: { - readonly "application/json": components["schemas"]["release"]; - }; - }; + readonly 'application/json': components['schemas']['release'] + } + } /** Not Found if the discussion category name is invalid */ readonly 404: { readonly content: { - readonly "application/json": components["schemas"]["basic-error"]; - }; - }; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': components['schemas']['basic-error'] + } + } + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The name of the tag. */ - readonly tag_name: string; + readonly tag_name: string /** @description Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`). */ - readonly target_commitish?: string; + readonly target_commitish?: string /** @description The name of the release. */ - readonly name?: string; + readonly name?: string /** @description Text describing the contents of the tag. */ - readonly body?: string; + readonly body?: string /** @description `true` to create a draft (unpublished) release, `false` to create a published one. */ - readonly draft?: boolean; + readonly draft?: boolean /** @description `true` to identify the release as a prerelease. `false` to identify the release as a full release. */ - readonly prerelease?: boolean; + readonly prerelease?: boolean /** @description If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see "[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." */ - readonly discussion_category_name?: string; + readonly discussion_category_name?: string /** @description Whether to automatically generate the name and body for this release. If `name` is specified, the specified name will be used; otherwise, a name will be automatically generated. If `body` is specified, the body will be pre-pended to the automatically generated notes. */ - readonly generate_release_notes?: boolean; - }; - }; - }; - }; + readonly generate_release_notes?: boolean + } + } + } + } /** To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. */ - readonly "repos/get-release-asset": { + readonly 'repos/get-release-asset': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** asset_id parameter */ - readonly asset_id: components["parameters"]["asset-id"]; - }; - }; + readonly asset_id: components['parameters']['asset-id'] + } + } readonly responses: { /** To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["release-asset"]; - }; - }; - readonly 302: components["responses"]["found"]; - readonly 404: components["responses"]["not_found"]; - readonly 415: components["responses"]["preview_header_missing"]; - }; - }; - readonly "repos/delete-release-asset": { + readonly 'application/json': components['schemas']['release-asset'] + } + } + readonly 302: components['responses']['found'] + readonly 404: components['responses']['not_found'] + readonly 415: components['responses']['preview_header_missing'] + } + } + readonly 'repos/delete-release-asset': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** asset_id parameter */ - readonly asset_id: components["parameters"]["asset-id"]; - }; - }; + readonly asset_id: components['parameters']['asset-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** Users with push access to the repository can edit a release asset. */ - readonly "repos/update-release-asset": { + readonly 'repos/update-release-asset': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** asset_id parameter */ - readonly asset_id: components["parameters"]["asset-id"]; - }; - }; + readonly asset_id: components['parameters']['asset-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["release-asset"]; - }; - }; - }; + readonly 'application/json': components['schemas']['release-asset'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The file name of the asset. */ - readonly name?: string; + readonly name?: string /** @description An alternate short description of the asset. Used in place of the filename. */ - readonly label?: string; + readonly label?: string /** @example "uploaded" */ - readonly state?: string; - }; - }; - }; - }; + readonly state?: string + } + } + } + } /** Generate a name and body describing a [release](https://docs.github.com/rest/reference/repos#releases). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. */ - readonly "repos/generate-release-notes": { + readonly 'repos/generate-release-notes': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Name and body of generated release notes */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["release-notes-content"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; + readonly 'application/json': components['schemas']['release-notes-content'] + } + } + readonly 404: components['responses']['not_found'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The tag name for the release. This can be an existing tag or a new one. */ - readonly tag_name: string; + readonly tag_name: string /** @description Specifies the commitish value that will be the target for the release's tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists. */ - readonly target_commitish?: string; + readonly target_commitish?: string /** @description The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release. */ - readonly previous_tag_name?: string; + readonly previous_tag_name?: string /** @description Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used. */ - readonly configuration_file_path?: string; - }; - }; - }; - }; + readonly configuration_file_path?: string + } + } + } + } /** * View the latest published full release for the repository. * * The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published. */ - readonly "repos/get-latest-release": { + readonly 'repos/get-latest-release': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["release"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['release'] + } + } + } + } /** Get a published release with the specified tag. */ - readonly "repos/get-release-by-tag": { + readonly 'repos/get-release-by-tag': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** tag parameter */ - readonly tag: string; - }; - }; + readonly tag: string + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["release"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': components['schemas']['release'] + } + } + readonly 404: components['responses']['not_found'] + } + } /** **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia). */ - readonly "repos/get-release": { + readonly 'repos/get-release': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** release_id parameter */ - readonly release_id: components["parameters"]["release-id"]; - }; - }; + readonly release_id: components['parameters']['release-id'] + } + } readonly responses: { /** **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia). */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["release"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': components['schemas']['release'] + } + } + readonly 404: components['responses']['not_found'] + } + } /** Users with push access to the repository can delete a release. */ - readonly "repos/delete-release": { + readonly 'repos/delete-release': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** release_id parameter */ - readonly release_id: components["parameters"]["release-id"]; - }; - }; + readonly release_id: components['parameters']['release-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** Users with push access to the repository can edit a release. */ - readonly "repos/update-release": { + readonly 'repos/update-release': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** release_id parameter */ - readonly release_id: components["parameters"]["release-id"]; - }; - }; + readonly release_id: components['parameters']['release-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["release"]; - }; - }; + readonly 'application/json': components['schemas']['release'] + } + } /** Not Found if the discussion category name is invalid */ readonly 404: { readonly content: { - readonly "application/json": components["schemas"]["basic-error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['basic-error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The name of the tag. */ - readonly tag_name?: string; + readonly tag_name?: string /** @description Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`). */ - readonly target_commitish?: string; + readonly target_commitish?: string /** @description The name of the release. */ - readonly name?: string; + readonly name?: string /** @description Text describing the contents of the tag. */ - readonly body?: string; + readonly body?: string /** @description `true` makes the release a draft, and `false` publishes the release. */ - readonly draft?: boolean; + readonly draft?: boolean /** @description `true` to identify the release as a prerelease, `false` to identify the release as a full release. */ - readonly prerelease?: boolean; + readonly prerelease?: boolean /** @description If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. If there is already a discussion linked to the release, this parameter is ignored. For more information, see "[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." */ - readonly discussion_category_name?: string; - }; - }; - }; - }; - readonly "repos/list-release-assets": { + readonly discussion_category_name?: string + } + } + } + } + readonly 'repos/list-release-assets': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** release_id parameter */ - readonly release_id: components["parameters"]["release-id"]; - }; + readonly release_id: components['parameters']['release-id'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["release-asset"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['release-asset'][] + } + } + } + } /** * This endpoint makes use of [a Hypermedia relation](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in * the response of the [Create a release endpoint](https://docs.github.com/rest/reference/repos#create-a-release) to upload a release asset. @@ -36193,276 +36155,276 @@ export interface operations { * endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). * * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. */ - readonly "repos/upload-release-asset": { + readonly 'repos/upload-release-asset': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** release_id parameter */ - readonly release_id: components["parameters"]["release-id"]; - }; + readonly release_id: components['parameters']['release-id'] + } readonly query: { - readonly name: string; - readonly label?: string; - }; - }; + readonly name: string + readonly label?: string + } + } readonly responses: { /** Response for successful upload */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["release-asset"]; - }; - }; + readonly 'application/json': components['schemas']['release-asset'] + } + } /** Response if you upload an asset with the same filename as another uploaded asset */ - readonly 422: unknown; - }; + readonly 422: unknown + } readonly requestBody: { readonly content: { - readonly "*/*": string; - }; - }; - }; + readonly '*/*': string + } + } + } /** Create a reaction to a [release](https://docs.github.com/rest/reference/repos#releases). A response with a `Status: 200 OK` means that you already added the reaction type to this release. */ - readonly "reactions/create-for-release": { + readonly 'reactions/create-for-release': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** release_id parameter */ - readonly release_id: components["parameters"]["release-id"]; - }; - }; + readonly release_id: components['parameters']['release-id'] + } + } readonly responses: { /** Reaction exists */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["reaction"]; - }; - }; + readonly 'application/json': components['schemas']['reaction'] + } + } /** Reaction created */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["reaction"]; - }; - }; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': components['schemas']['reaction'] + } + } + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the release. * @enum {string} */ - readonly content: "+1" | "laugh" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - }; + readonly content: '+1' | 'laugh' | 'heart' | 'hooray' | 'rocket' | 'eyes' + } + } + } + } /** * Lists secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. */ - readonly "secret-scanning/list-alerts-for-repo": { + readonly 'secret-scanning/list-alerts-for-repo': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } readonly query: { /** Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - readonly state?: components["parameters"]["secret-scanning-alert-state"]; + readonly state?: components['parameters']['secret-scanning-alert-state'] /** * A comma-separated list of secret types to return. By default all secret types are returned. * See "[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)" * for a complete list of secret types (API slug). */ - readonly secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; + readonly secret_type?: components['parameters']['secret-scanning-alert-secret-type'] /** A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - readonly resolution?: components["parameters"]["secret-scanning-alert-resolution"]; + readonly resolution?: components['parameters']['secret-scanning-alert-resolution'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; + readonly page?: components['parameters']['page'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; - }; - }; + readonly per_page?: components['parameters']['per-page'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["secret-scanning-alert"][]; - }; - }; + readonly 'application/json': readonly components['schemas']['secret-scanning-alert'][] + } + } /** Repository is public or secret scanning is disabled for the repository */ - readonly 404: unknown; - readonly 503: components["responses"]["service_unavailable"]; - }; - }; + readonly 404: unknown + readonly 503: components['responses']['service_unavailable'] + } + } /** * Gets a single secret scanning alert detected in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. */ - readonly "secret-scanning/get-alert": { + readonly 'secret-scanning/get-alert': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ - readonly alert_number: components["parameters"]["alert-number"]; - }; - }; + readonly alert_number: components['parameters']['alert-number'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["secret-scanning-alert"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; + readonly 'application/json': components['schemas']['secret-scanning-alert'] + } + } + readonly 304: components['responses']['not_modified'] /** Repository is public, or secret scanning is disabled for the repository, or the resource is not found */ - readonly 404: unknown; - readonly 503: components["responses"]["service_unavailable"]; - }; - }; + readonly 404: unknown + readonly 503: components['responses']['service_unavailable'] + } + } /** * Updates the status of a secret scanning alert in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint. */ - readonly "secret-scanning/update-alert": { + readonly 'secret-scanning/update-alert': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ - readonly alert_number: components["parameters"]["alert-number"]; - }; - }; + readonly alert_number: components['parameters']['alert-number'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["secret-scanning-alert"]; - }; - }; + readonly 'application/json': components['schemas']['secret-scanning-alert'] + } + } /** Repository is public, or secret scanning is disabled for the repository, or the resource is not found */ - readonly 404: unknown; + readonly 404: unknown /** State does not match the resolution */ - readonly 422: unknown; - readonly 503: components["responses"]["service_unavailable"]; - }; + readonly 422: unknown + readonly 503: components['responses']['service_unavailable'] + } readonly requestBody: { readonly content: { - readonly "application/json": { - readonly state: components["schemas"]["secret-scanning-alert-state"]; - readonly resolution?: components["schemas"]["secret-scanning-alert-resolution"]; - }; - }; - }; - }; + readonly 'application/json': { + readonly state: components['schemas']['secret-scanning-alert-state'] + readonly resolution?: components['schemas']['secret-scanning-alert-resolution'] + } + } + } + } /** * Lists all locations for a given secret scanning alert for a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. */ - readonly "secret-scanning/list-locations-for-alert": { + readonly 'secret-scanning/list-locations-for-alert': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] /** The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ - readonly alert_number: components["parameters"]["alert-number"]; - }; + readonly alert_number: components['parameters']['alert-number'] + } readonly query: { /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; + readonly page?: components['parameters']['page'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; - }; - }; + readonly per_page?: components['parameters']['per-page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["secret-scanning-location"][]; - }; - }; + readonly 'application/json': readonly components['schemas']['secret-scanning-location'][] + } + } /** Repository is public, or secret scanning is disabled for the repository, or the resource is not found */ - readonly 404: unknown; - readonly 503: components["responses"]["service_unavailable"]; - }; - }; + readonly 404: unknown + readonly 503: components['responses']['service_unavailable'] + } + } /** * Lists the people that have starred the repository. * * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: */ - readonly "activity/list-stargazers-for-repo": { + readonly 'activity/list-stargazers-for-repo': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": Partial & - Partial; - }; - }; - readonly 422: components["responses"]["validation_failed"]; - }; - }; + readonly 'application/json': Partial & + Partial + } + } + readonly 422: components['responses']['validation_failed'] + } + } /** Returns a weekly aggregate of the number of additions and deletions pushed to a repository. */ - readonly "repos/get-code-frequency-stats": { + readonly 'repos/get-code-frequency-stats': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Returns a weekly aggregate of the number of additions and deletions pushed to a repository. */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["code-frequency-stat"][]; - }; - }; - readonly 202: components["responses"]["accepted"]; - readonly 204: components["responses"]["no_content"]; - }; - }; + readonly 'application/json': readonly components['schemas']['code-frequency-stat'][] + } + } + readonly 202: components['responses']['accepted'] + readonly 204: components['responses']['no_content'] + } + } /** Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`. */ - readonly "repos/get-commit-activity-stats": { + readonly 'repos/get-commit-activity-stats': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["commit-activity"][]; - }; - }; - readonly 202: components["responses"]["accepted"]; - readonly 204: components["responses"]["no_content"]; - }; - }; + readonly 'application/json': readonly components['schemas']['commit-activity'][] + } + } + readonly 202: components['responses']['accepted'] + readonly 204: components['responses']['no_content'] + } + } /** * Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information: * @@ -36471,13 +36433,13 @@ export interface operations { * * `d` - Number of deletions * * `c` - Number of commits */ - readonly "repos/get-contributors-stats": { + readonly 'repos/get-contributors-stats': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** * * `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time). @@ -36487,35 +36449,35 @@ export interface operations { */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["contributor-activity"][]; - }; - }; - readonly 202: components["responses"]["accepted"]; - readonly 204: components["responses"]["no_content"]; - }; - }; + readonly 'application/json': readonly components['schemas']['contributor-activity'][] + } + } + readonly 202: components['responses']['accepted'] + readonly 204: components['responses']['no_content'] + } + } /** * Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`. * * The array order is oldest week (index 0) to most recent week. */ - readonly "repos/get-participation-stats": { + readonly 'repos/get-participation-stats': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** The array order is oldest week (index 0) to most recent week. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["participation-stats"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': components['schemas']['participation-stats'] + } + } + readonly 404: components['responses']['not_found'] + } + } /** * Each array contains the day number, hour number, and number of commits: * @@ -36525,436 +36487,436 @@ export interface operations { * * For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. */ - readonly "repos/get-punch-card-stats": { + readonly 'repos/get-punch-card-stats': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["code-frequency-stat"][]; - }; - }; - readonly 204: components["responses"]["no_content"]; - }; - }; + readonly 'application/json': readonly components['schemas']['code-frequency-stat'][] + } + } + readonly 204: components['responses']['no_content'] + } + } /** * Users with push access in a repository can create commit statuses for a given SHA. * * Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error. */ - readonly "repos/create-commit-status": { + readonly 'repos/create-commit-status': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly sha: string; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly sha: string + } + } readonly responses: { /** Response */ readonly 201: { readonly headers: { - readonly Location?: string; - }; + readonly Location?: string + } readonly content: { - readonly "application/json": components["schemas"]["status"]; - }; - }; - }; + readonly 'application/json': components['schemas']['status'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description The state of the status. Can be one of `error`, `failure`, `pending`, or `success`. * @enum {string} */ - readonly state: "error" | "failure" | "pending" | "success"; + readonly state: 'error' | 'failure' | 'pending' | 'success' /** * @description The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. * For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: * `http://ci.example.com/user/repo/build/sha` */ - readonly target_url?: string; + readonly target_url?: string /** @description A short description of the status. */ - readonly description?: string; + readonly description?: string /** * @description A string label to differentiate this status from the status of other systems. This field is case-insensitive. * @default default */ - readonly context?: string; - }; - }; - }; - }; + readonly context?: string + } + } + } + } /** Lists the people watching the specified repository. */ - readonly "activity/list-watchers-for-repo": { + readonly 'activity/list-watchers-for-repo': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; - }; - }; - }; - }; - readonly "activity/get-repo-subscription": { + readonly 'application/json': readonly components['schemas']['simple-user'][] + } + } + } + } + readonly 'activity/get-repo-subscription': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** if you subscribe to the repository */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["repository-subscription"]; - }; - }; - readonly 403: components["responses"]["forbidden"]; + readonly 'application/json': components['schemas']['repository-subscription'] + } + } + readonly 403: components['responses']['forbidden'] /** Not Found if you don't subscribe to the repository */ - readonly 404: unknown; - }; - }; + readonly 404: unknown + } + } /** If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/rest/reference/activity#delete-a-repository-subscription) completely. */ - readonly "activity/set-repo-subscription": { + readonly 'activity/set-repo-subscription': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["repository-subscription"]; - }; - }; - }; + readonly 'application/json': components['schemas']['repository-subscription'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Determines if notifications should be received from this repository. */ - readonly subscribed?: boolean; + readonly subscribed?: boolean /** @description Determines if all notifications should be blocked from this repository. */ - readonly ignored?: boolean; - }; - }; - }; - }; + readonly ignored?: boolean + } + } + } + } /** This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/rest/reference/activity#set-a-repository-subscription). */ - readonly "activity/delete-repo-subscription": { + readonly 'activity/delete-repo-subscription': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; - readonly "repos/list-tags": { + readonly 204: never + } + } + readonly 'repos/list-tags': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["tag"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['tag'][] + } + } + } + } /** * Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually * `master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. * **Note**: For private repositories, these links are temporary and expire after five minutes. */ - readonly "repos/download-tarball-archive": { + readonly 'repos/download-tarball-archive': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly ref: string; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly ref: string + } + } readonly responses: { /** Response */ - readonly 302: never; - }; - }; - readonly "repos/list-teams": { + readonly 302: never + } + } + readonly 'repos/list-teams': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["team"][]; - }; - }; - }; - }; - readonly "repos/get-all-topics": { + readonly 'application/json': readonly components['schemas']['team'][] + } + } + } + } + readonly 'repos/get-all-topics': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } readonly query: { /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; + readonly page?: components['parameters']['page'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; - }; - }; + readonly per_page?: components['parameters']['per-page'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["topic"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "repos/replace-all-topics": { + readonly 'application/json': components['schemas']['topic'] + } + } + readonly 404: components['responses']['not_found'] + } + } + readonly 'repos/replace-all-topics': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["topic"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; - }; + readonly 'application/json': components['schemas']['topic'] + } + } + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed_simple'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters. */ - readonly names: readonly string[]; - }; - }; - }; - }; + readonly names: readonly string[] + } + } + } + } /** Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. */ - readonly "repos/get-clones": { + readonly 'repos/get-clones': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } readonly query: { /** Must be one of: `day`, `week`. */ - readonly per?: components["parameters"]["per"]; - }; - }; + readonly per?: components['parameters']['per'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["clone-traffic"]; - }; - }; - readonly 403: components["responses"]["forbidden"]; - }; - }; + readonly 'application/json': components['schemas']['clone-traffic'] + } + } + readonly 403: components['responses']['forbidden'] + } + } /** Get the top 10 popular contents over the last 14 days. */ - readonly "repos/get-top-paths": { + readonly 'repos/get-top-paths': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["content-traffic"][]; - }; - }; - readonly 403: components["responses"]["forbidden"]; - }; - }; + readonly 'application/json': readonly components['schemas']['content-traffic'][] + } + } + readonly 403: components['responses']['forbidden'] + } + } /** Get the top 10 referrers over the last 14 days. */ - readonly "repos/get-top-referrers": { + readonly 'repos/get-top-referrers': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["referrer-traffic"][]; - }; - }; - readonly 403: components["responses"]["forbidden"]; - }; - }; + readonly 'application/json': readonly components['schemas']['referrer-traffic'][] + } + } + readonly 403: components['responses']['forbidden'] + } + } /** Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. */ - readonly "repos/get-views": { + readonly 'repos/get-views': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } readonly query: { /** Must be one of: `day`, `week`. */ - readonly per?: components["parameters"]["per"]; - }; - }; + readonly per?: components['parameters']['per'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["view-traffic"]; - }; - }; - readonly 403: components["responses"]["forbidden"]; - }; - }; + readonly 'application/json': components['schemas']['view-traffic'] + } + } + readonly 403: components['responses']['forbidden'] + } + } /** A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/). */ - readonly "repos/transfer": { + readonly 'repos/transfer': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ readonly 202: { readonly content: { - readonly "application/json": components["schemas"]["minimal-repository"]; - }; - }; - }; + readonly 'application/json': components['schemas']['minimal-repository'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The username or organization name the repository will be transferred to. */ - readonly new_owner: string; + readonly new_owner: string /** @description ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories. */ - readonly team_ids?: readonly number[]; - }; - }; - }; - }; + readonly team_ids?: readonly number[] + } + } + } + } /** Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". */ - readonly "repos/check-vulnerability-alerts": { + readonly 'repos/check-vulnerability-alerts': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response if repository is enabled with vulnerability alerts */ - readonly 204: never; + readonly 204: never /** Not Found if repository is not enabled with vulnerability alerts */ - readonly 404: unknown; - }; - }; + readonly 404: unknown + } + } /** Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". */ - readonly "repos/enable-vulnerability-alerts": { + readonly 'repos/enable-vulnerability-alerts': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". */ - readonly "repos/disable-vulnerability-alerts": { + readonly 'repos/disable-vulnerability-alerts': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** * Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually * `master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. * **Note**: For private repositories, these links are temporary and expire after five minutes. */ - readonly "repos/download-zipball-archive": { + readonly 'repos/download-zipball-archive': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - readonly ref: string; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + readonly ref: string + } + } readonly responses: { /** Response */ - readonly 302: never; - }; - }; + readonly 302: never + } + } /** * Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. * @@ -36965,41 +36927,41 @@ export interface operations { * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. * * `repo` scope to create a private repository */ - readonly "repos/create-using-template": { + readonly 'repos/create-using-template': { readonly parameters: { readonly path: { - readonly template_owner: string; - readonly template_repo: string; - }; - }; + readonly template_owner: string + readonly template_repo: string + } + } readonly responses: { /** Response */ readonly 201: { readonly headers: { - readonly Location?: string; - }; + readonly Location?: string + } readonly content: { - readonly "application/json": components["schemas"]["repository"]; - }; - }; - }; + readonly 'application/json': components['schemas']['repository'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization. */ - readonly owner?: string; + readonly owner?: string /** @description The name of the new repository. */ - readonly name: string; + readonly name: string /** @description A short description of the new repository. */ - readonly description?: string; + readonly description?: string /** @description Set to `true` to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: `false`. */ - readonly include_all_branches?: boolean; + readonly include_all_branches?: boolean /** @description Either `true` to create a new private repository or `false` to create a new public one. */ - readonly private?: boolean; - }; - }; - }; - }; + readonly private?: boolean + } + } + } + } /** * Lists all public repositories in the order that they were created. * @@ -37007,93 +36969,93 @@ export interface operations { * - For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories. */ - readonly "repos/list-public": { + readonly 'repos/list-public': { readonly parameters: { readonly query: { /** A repository ID. Only return repositories with an ID greater than this ID. */ - readonly since?: components["parameters"]["since-repo"]; - }; - }; + readonly since?: components['parameters']['since-repo'] + } + } readonly responses: { /** Response */ readonly 200: { readonly headers: { - readonly Link?: string; - }; - readonly content: { - readonly "application/json": readonly components["schemas"]["minimal-repository"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; + readonly Link?: string + } + readonly content: { + readonly 'application/json': readonly components['schemas']['minimal-repository'][] + } + } + readonly 304: components['responses']['not_modified'] + readonly 422: components['responses']['validation_failed'] + } + } /** Lists all secrets available in an environment without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - readonly "actions/list-environment-secrets": { + readonly 'actions/list-environment-secrets': { readonly parameters: { readonly path: { - readonly repository_id: components["parameters"]["repository-id"]; + readonly repository_id: components['parameters']['repository-id'] /** The name of the environment */ - readonly environment_name: components["parameters"]["environment-name"]; - }; + readonly environment_name: components['parameters']['environment-name'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": { - readonly total_count: number; - readonly secrets: readonly components["schemas"]["actions-secret"][]; - }; - }; - }; - }; - }; + readonly 'application/json': { + readonly total_count: number + readonly secrets: readonly components['schemas']['actions-secret'][] + } + } + } + } + } /** Get the public key for an environment, which you need to encrypt environment secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - readonly "actions/get-environment-public-key": { + readonly 'actions/get-environment-public-key': { readonly parameters: { readonly path: { - readonly repository_id: components["parameters"]["repository-id"]; + readonly repository_id: components['parameters']['repository-id'] /** The name of the environment */ - readonly environment_name: components["parameters"]["environment-name"]; - }; - }; + readonly environment_name: components['parameters']['environment-name'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["actions-public-key"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['actions-public-key'] + } + } + } + } /** Gets a single environment secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - readonly "actions/get-environment-secret": { + readonly 'actions/get-environment-secret': { readonly parameters: { readonly path: { - readonly repository_id: components["parameters"]["repository-id"]; + readonly repository_id: components['parameters']['repository-id'] /** The name of the environment */ - readonly environment_name: components["parameters"]["environment-name"]; + readonly environment_name: components['parameters']['environment-name'] /** secret_name parameter */ - readonly secret_name: components["parameters"]["secret-name"]; - }; - }; + readonly secret_name: components['parameters']['secret-name'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["actions-secret"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['actions-secret'] + } + } + } + } /** * Creates or updates an environment secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -37171,229 +37133,229 @@ export interface operations { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - readonly "actions/create-or-update-environment-secret": { + readonly 'actions/create-or-update-environment-secret': { readonly parameters: { readonly path: { - readonly repository_id: components["parameters"]["repository-id"]; + readonly repository_id: components['parameters']['repository-id'] /** The name of the environment */ - readonly environment_name: components["parameters"]["environment-name"]; + readonly environment_name: components['parameters']['environment-name'] /** secret_name parameter */ - readonly secret_name: components["parameters"]["secret-name"]; - }; - }; + readonly secret_name: components['parameters']['secret-name'] + } + } readonly responses: { /** Response when creating a secret */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["empty-object"]; - }; - }; + readonly 'application/json': components['schemas']['empty-object'] + } + } /** Response when updating a secret */ - readonly 204: never; - }; + readonly 204: never + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/reference/actions#get-an-environment-public-key) endpoint. */ - readonly encrypted_value: string; + readonly encrypted_value: string /** @description ID of the key you used to encrypt the secret. */ - readonly key_id: string; - }; - }; - }; - }; + readonly key_id: string + } + } + } + } /** Deletes a secret in an environment using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - readonly "actions/delete-environment-secret": { + readonly 'actions/delete-environment-secret': { readonly parameters: { readonly path: { - readonly repository_id: components["parameters"]["repository-id"]; + readonly repository_id: components['parameters']['repository-id'] /** The name of the environment */ - readonly environment_name: components["parameters"]["environment-name"]; + readonly environment_name: components['parameters']['environment-name'] /** secret_name parameter */ - readonly secret_name: components["parameters"]["secret-name"]; - }; - }; + readonly secret_name: components['parameters']['secret-name'] + } + } readonly responses: { /** Default response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - readonly "enterprise-admin/list-provisioned-groups-enterprise": { + readonly 'enterprise-admin/list-provisioned-groups-enterprise': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; - }; + readonly enterprise: components['parameters']['enterprise'] + } readonly query: { /** Used for pagination: the index of the first result to return. */ - readonly startIndex?: components["parameters"]["start-index"]; + readonly startIndex?: components['parameters']['start-index'] /** Used for pagination: the number of results to return. */ - readonly count?: components["parameters"]["count"]; + readonly count?: components['parameters']['count'] /** filter results */ - readonly filter?: string; + readonly filter?: string /** attributes to exclude */ - readonly excludedAttributes?: string; - }; - }; + readonly excludedAttributes?: string + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["scim-group-list-enterprise"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['scim-group-list-enterprise'] + } + } + } + } /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * * Provision an enterprise group, and invite users to the group. This sends invitation emails to the email address of the invited users to join the GitHub organization that the SCIM group corresponds to. */ - readonly "enterprise-admin/provision-and-invite-enterprise-group": { + readonly 'enterprise-admin/provision-and-invite-enterprise-group': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; - }; - }; + readonly enterprise: components['parameters']['enterprise'] + } + } readonly responses: { /** Response */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["scim-enterprise-group"]; - }; - }; - }; + readonly 'application/json': components['schemas']['scim-enterprise-group'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The SCIM schema URIs. */ - readonly schemas: readonly string[]; + readonly schemas: readonly string[] /** @description The name of the SCIM group. This must match the GitHub organization that the group maps to. */ - readonly displayName: string; + readonly displayName: string readonly members?: readonly { /** @description The SCIM user ID for a user. */ - readonly value: string; - }[]; - }; - }; - }; - }; + readonly value: string + }[] + } + } + } + } /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - readonly "enterprise-admin/get-provisioning-information-for-enterprise-group": { + readonly 'enterprise-admin/get-provisioning-information-for-enterprise-group': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; + readonly enterprise: components['parameters']['enterprise'] /** Identifier generated by the GitHub SCIM endpoint. */ - readonly scim_group_id: components["parameters"]["scim-group-id"]; - }; + readonly scim_group_id: components['parameters']['scim-group-id'] + } readonly query: { /** Attributes to exclude. */ - readonly excludedAttributes?: string; - }; - }; + readonly excludedAttributes?: string + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["scim-enterprise-group"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['scim-enterprise-group'] + } + } + } + } /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * * Replaces an existing provisioned group’s information. You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead. */ - readonly "enterprise-admin/set-information-for-provisioned-enterprise-group": { + readonly 'enterprise-admin/set-information-for-provisioned-enterprise-group': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; + readonly enterprise: components['parameters']['enterprise'] /** Identifier generated by the GitHub SCIM endpoint. */ - readonly scim_group_id: components["parameters"]["scim-group-id"]; - }; - }; + readonly scim_group_id: components['parameters']['scim-group-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["scim-enterprise-group"]; - }; - }; - }; + readonly 'application/json': components['schemas']['scim-enterprise-group'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The SCIM schema URIs. */ - readonly schemas: readonly string[]; + readonly schemas: readonly string[] /** @description The name of the SCIM group. This must match the GitHub organization that the group maps to. */ - readonly displayName: string; + readonly displayName: string readonly members?: readonly { /** @description The SCIM user ID for a user. */ - readonly value: string; - }[]; - }; - }; - }; - }; + readonly value: string + }[] + } + } + } + } /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - readonly "enterprise-admin/delete-scim-group-from-enterprise": { + readonly 'enterprise-admin/delete-scim-group-from-enterprise': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; + readonly enterprise: components['parameters']['enterprise'] /** Identifier generated by the GitHub SCIM endpoint. */ - readonly scim_group_id: components["parameters"]["scim-group-id"]; - }; - }; + readonly scim_group_id: components['parameters']['scim-group-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * * Allows you to change a provisioned group’s individual attributes. To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). */ - readonly "enterprise-admin/update-attribute-for-enterprise-group": { + readonly 'enterprise-admin/update-attribute-for-enterprise-group': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; + readonly enterprise: components['parameters']['enterprise'] /** Identifier generated by the GitHub SCIM endpoint. */ - readonly scim_group_id: components["parameters"]["scim-group-id"]; - }; - }; + readonly scim_group_id: components['parameters']['scim-group-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["scim-enterprise-group"]; - }; - }; - }; + readonly 'application/json': components['schemas']['scim-enterprise-group'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The SCIM schema URIs. */ - readonly schemas: readonly string[]; + readonly schemas: readonly string[] /** @description Array of [SCIM operations](https://tools.ietf.org/html/rfc7644#section-3.5.2). */ readonly Operations: readonly { /** @enum {string} */ - readonly op: "add" | "Add" | "remove" | "Remove" | "replace" | "Replace"; - readonly path?: string; + readonly op: 'add' | 'Add' | 'remove' | 'Remove' | 'replace' | 'Replace' + readonly path?: string /** @description Can be any value - string, number, array or object. */ - readonly value?: unknown; - }[]; - }; - }; - }; - }; + readonly value?: unknown + }[] + } + } + } + } /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * @@ -37414,30 +37376,30 @@ export interface operations { * - If the user signs in, their GitHub account is linked to this entry. * - If the user does not sign in (or does not create a new account when prompted), they are not added to the GitHub enterprise, and the external identity `null` entry remains in place. */ - readonly "enterprise-admin/list-provisioned-identities-enterprise": { + readonly 'enterprise-admin/list-provisioned-identities-enterprise': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; - }; + readonly enterprise: components['parameters']['enterprise'] + } readonly query: { /** Used for pagination: the index of the first result to return. */ - readonly startIndex?: components["parameters"]["start-index"]; + readonly startIndex?: components['parameters']['start-index'] /** Used for pagination: the number of results to return. */ - readonly count?: components["parameters"]["count"]; + readonly count?: components['parameters']['count'] /** filter results */ - readonly filter?: string; - }; - }; + readonly filter?: string + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["scim-user-list-enterprise"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['scim-user-list-enterprise'] + } + } + } + } /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * @@ -37445,70 +37407,70 @@ export interface operations { * * You can optionally include the groups a user will be invited to join. If you do not provide a list of `groups`, the user is provisioned for the enterprise, but no organization invitation emails will be sent. */ - readonly "enterprise-admin/provision-and-invite-enterprise-user": { + readonly 'enterprise-admin/provision-and-invite-enterprise-user': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; - }; - }; + readonly enterprise: components['parameters']['enterprise'] + } + } readonly responses: { /** Response */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["scim-enterprise-user"]; - }; - }; - }; + readonly 'application/json': components['schemas']['scim-enterprise-user'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The SCIM schema URIs. */ - readonly schemas: readonly string[]; + readonly schemas: readonly string[] /** @description The username for the user. */ - readonly userName: string; + readonly userName: string readonly name: { /** @description The first name of the user. */ - readonly givenName: string; + readonly givenName: string /** @description The last name of the user. */ - readonly familyName: string; - }; + readonly familyName: string + } /** @description List of user emails. */ readonly emails: readonly { /** @description The email address. */ - readonly value: string; + readonly value: string /** @description The type of email address. */ - readonly type: string; + readonly type: string /** @description Whether this email address is the primary address. */ - readonly primary: boolean; - }[]; + readonly primary: boolean + }[] /** @description List of SCIM group IDs the user is a member of. */ readonly groups?: readonly { - readonly value?: string; - }[]; - }; - }; - }; - }; + readonly value?: string + }[] + } + } + } + } /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - readonly "enterprise-admin/get-provisioning-information-for-enterprise-user": { + readonly 'enterprise-admin/get-provisioning-information-for-enterprise-user': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; + readonly enterprise: components['parameters']['enterprise'] /** scim_user_id parameter */ - readonly scim_user_id: components["parameters"]["scim-user-id"]; - }; - }; + readonly scim_user_id: components['parameters']['scim-user-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["scim-enterprise-user"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['scim-enterprise-user'] + } + } + } + } /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * @@ -37518,68 +37480,68 @@ export interface operations { * * **Warning:** Setting `active: false` removes the user from the enterprise, deletes the external identity, and deletes the associated `{scim_user_id}`. */ - readonly "enterprise-admin/set-information-for-provisioned-enterprise-user": { + readonly 'enterprise-admin/set-information-for-provisioned-enterprise-user': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; + readonly enterprise: components['parameters']['enterprise'] /** scim_user_id parameter */ - readonly scim_user_id: components["parameters"]["scim-user-id"]; - }; - }; + readonly scim_user_id: components['parameters']['scim-user-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["scim-enterprise-user"]; - }; - }; - }; + readonly 'application/json': components['schemas']['scim-enterprise-user'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The SCIM schema URIs. */ - readonly schemas: readonly string[]; + readonly schemas: readonly string[] /** @description The username for the user. */ - readonly userName: string; + readonly userName: string readonly name: { /** @description The first name of the user. */ - readonly givenName: string; + readonly givenName: string /** @description The last name of the user. */ - readonly familyName: string; - }; + readonly familyName: string + } /** @description List of user emails. */ readonly emails: readonly { /** @description The email address. */ - readonly value: string; + readonly value: string /** @description The type of email address. */ - readonly type: string; + readonly type: string /** @description Whether this email address is the primary address. */ - readonly primary: boolean; - }[]; + readonly primary: boolean + }[] /** @description List of SCIM group IDs the user is a member of. */ readonly groups?: readonly { - readonly value?: string; - }[]; - }; - }; - }; - }; + readonly value?: string + }[] + } + } + } + } /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - readonly "enterprise-admin/delete-user-from-enterprise": { + readonly 'enterprise-admin/delete-user-from-enterprise': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; + readonly enterprise: components['parameters']['enterprise'] /** scim_user_id parameter */ - readonly scim_user_id: components["parameters"]["scim-user-id"]; - }; - }; + readonly scim_user_id: components['parameters']['scim-user-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * @@ -37600,34 +37562,34 @@ export interface operations { * } * ``` */ - readonly "enterprise-admin/update-attribute-for-enterprise-user": { + readonly 'enterprise-admin/update-attribute-for-enterprise-user': { readonly parameters: { readonly path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; + readonly enterprise: components['parameters']['enterprise'] /** scim_user_id parameter */ - readonly scim_user_id: components["parameters"]["scim-user-id"]; - }; - }; + readonly scim_user_id: components['parameters']['scim-user-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["scim-enterprise-user"]; - }; - }; - }; + readonly 'application/json': components['schemas']['scim-enterprise-user'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The SCIM schema URIs. */ - readonly schemas: readonly string[]; + readonly schemas: readonly string[] /** @description Array of [SCIM operations](https://tools.ietf.org/html/rfc7644#section-3.5.2). */ - readonly Operations: readonly { readonly [key: string]: unknown }[]; - }; - }; - }; - }; + readonly Operations: readonly { readonly [key: string]: unknown }[] + } + } + } + } /** * Retrieves a paginated list of all provisioned organization members, including pending invitations. If you provide the `filter` parameter, the resources for all matching provisions members are returned. * @@ -37646,16 +37608,16 @@ export interface operations { * - If the user signs in, their GitHub account is linked to this entry. * - If the user does not sign in (or does not create a new account when prompted), they are not added to the GitHub organization, and the external identity `null` entry remains in place. */ - readonly "scim/list-provisioned-identities": { + readonly 'scim/list-provisioned-identities': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; + readonly org: components['parameters']['org'] + } readonly query: { /** Used for pagination: the index of the first result to return. */ - readonly startIndex?: number; + readonly startIndex?: number /** Used for pagination: the number of results to return. */ - readonly count?: number; + readonly count?: number /** * Filters results using the equals query parameter operator (`eq`). You can filter results that are equal to `id`, `userName`, `emails`, and `external_id`. For example, to search for an identity with the `userName` Octocat, you would use this query: * @@ -37665,99 +37627,99 @@ export interface operations { * * `?filter=emails%20eq%20\"octocat@github.com\"`. */ - readonly filter?: string; - }; - }; + readonly filter?: string + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/scim+json": components["schemas"]["scim-user-list"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 400: components["responses"]["scim_bad_request"]; - readonly 403: components["responses"]["scim_forbidden"]; - readonly 404: components["responses"]["scim_not_found"]; - }; - }; + readonly 'application/scim+json': components['schemas']['scim-user-list'] + } + } + readonly 304: components['responses']['not_modified'] + readonly 400: components['responses']['scim_bad_request'] + readonly 403: components['responses']['scim_forbidden'] + readonly 404: components['responses']['scim_not_found'] + } + } /** Provision organization membership for a user, and send an activation email to the email address. */ - readonly "scim/provision-and-invite-user": { + readonly 'scim/provision-and-invite-user': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; - }; + readonly org: components['parameters']['org'] + } + } readonly responses: { /** Response */ readonly 201: { readonly content: { - readonly "application/scim+json": components["schemas"]["scim-user"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 400: components["responses"]["scim_bad_request"]; - readonly 403: components["responses"]["scim_forbidden"]; - readonly 404: components["responses"]["scim_not_found"]; - readonly 409: components["responses"]["scim_conflict"]; - readonly 500: components["responses"]["scim_internal_error"]; - }; + readonly 'application/scim+json': components['schemas']['scim-user'] + } + } + readonly 304: components['responses']['not_modified'] + readonly 400: components['responses']['scim_bad_request'] + readonly 403: components['responses']['scim_forbidden'] + readonly 404: components['responses']['scim_not_found'] + readonly 409: components['responses']['scim_conflict'] + readonly 500: components['responses']['scim_internal_error'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description Configured by the admin. Could be an email, login, or username * @example someone@example.com */ - readonly userName: string; + readonly userName: string /** * @description The name of the user, suitable for display to end-users * @example Jon Doe */ - readonly displayName?: string; + readonly displayName?: string /** @example [object Object] */ readonly name: { - readonly givenName: string; - readonly familyName: string; - readonly formatted?: string; - }; + readonly givenName: string + readonly familyName: string + readonly formatted?: string + } /** * @description user emails * @example [object Object],[object Object] */ readonly emails: readonly { - readonly value: string; - readonly primary?: boolean; - readonly type?: string; - }[]; - readonly schemas?: readonly string[]; - readonly externalId?: string; - readonly groups?: readonly string[]; - readonly active?: boolean; - }; - }; - }; - }; - readonly "scim/get-provisioning-information-for-user": { - readonly parameters: { - readonly path: { - readonly org: components["parameters"]["org"]; + readonly value: string + readonly primary?: boolean + readonly type?: string + }[] + readonly schemas?: readonly string[] + readonly externalId?: string + readonly groups?: readonly string[] + readonly active?: boolean + } + } + } + } + readonly 'scim/get-provisioning-information-for-user': { + readonly parameters: { + readonly path: { + readonly org: components['parameters']['org'] /** scim_user_id parameter */ - readonly scim_user_id: components["parameters"]["scim-user-id"]; - }; - }; + readonly scim_user_id: components['parameters']['scim-user-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/scim+json": components["schemas"]["scim-user"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["scim_forbidden"]; - readonly 404: components["responses"]["scim_not_found"]; - }; - }; + readonly 'application/scim+json': components['schemas']['scim-user'] + } + } + readonly 304: components['responses']['not_modified'] + readonly 403: components['responses']['scim_forbidden'] + readonly 404: components['responses']['scim_not_found'] + } + } /** * Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](https://docs.github.com/rest/reference/scim#update-an-attribute-for-a-scim-user) endpoint instead. * @@ -37765,77 +37727,77 @@ export interface operations { * * **Warning:** Setting `active: false` removes the user from the organization, deletes the external identity, and deletes the associated `{scim_user_id}`. */ - readonly "scim/set-information-for-provisioned-user": { + readonly 'scim/set-information-for-provisioned-user': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** scim_user_id parameter */ - readonly scim_user_id: components["parameters"]["scim-user-id"]; - }; - }; + readonly scim_user_id: components['parameters']['scim-user-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/scim+json": components["schemas"]["scim-user"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["scim_forbidden"]; - readonly 404: components["responses"]["scim_not_found"]; - }; + readonly 'application/scim+json': components['schemas']['scim-user'] + } + } + readonly 304: components['responses']['not_modified'] + readonly 403: components['responses']['scim_forbidden'] + readonly 404: components['responses']['scim_not_found'] + } readonly requestBody: { readonly content: { - readonly "application/json": { - readonly schemas?: readonly string[]; + readonly 'application/json': { + readonly schemas?: readonly string[] /** * @description The name of the user, suitable for display to end-users * @example Jon Doe */ - readonly displayName?: string; - readonly externalId?: string; - readonly groups?: readonly string[]; - readonly active?: boolean; + readonly displayName?: string + readonly externalId?: string + readonly groups?: readonly string[] + readonly active?: boolean /** * @description Configured by the admin. Could be an email, login, or username * @example someone@example.com */ - readonly userName: string; + readonly userName: string /** @example [object Object] */ readonly name: { - readonly givenName: string; - readonly familyName: string; - readonly formatted?: string; - }; + readonly givenName: string + readonly familyName: string + readonly formatted?: string + } /** * @description user emails * @example [object Object],[object Object] */ readonly emails: readonly { - readonly type?: string; - readonly value: string; - readonly primary?: boolean; - }[]; - }; - }; - }; - }; - readonly "scim/delete-user-from-org": { - readonly parameters: { - readonly path: { - readonly org: components["parameters"]["org"]; + readonly type?: string + readonly value: string + readonly primary?: boolean + }[] + } + } + } + } + readonly 'scim/delete-user-from-org': { + readonly parameters: { + readonly path: { + readonly org: components['parameters']['org'] /** scim_user_id parameter */ - readonly scim_user_id: components["parameters"]["scim-user-id"]; - }; - }; + readonly scim_user_id: components['parameters']['scim-user-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["scim_forbidden"]; - readonly 404: components["responses"]["scim_not_found"]; - }; - }; + readonly 204: never + readonly 304: components['responses']['not_modified'] + readonly 403: components['responses']['scim_forbidden'] + readonly 404: components['responses']['scim_not_found'] + } + } /** * Allows you to change a provisioned user's individual attributes. To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). * @@ -37854,62 +37816,62 @@ export interface operations { * } * ``` */ - readonly "scim/update-attribute-for-user": { + readonly 'scim/update-attribute-for-user': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; + readonly org: components['parameters']['org'] /** scim_user_id parameter */ - readonly scim_user_id: components["parameters"]["scim-user-id"]; - }; - }; + readonly scim_user_id: components['parameters']['scim-user-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/scim+json": components["schemas"]["scim-user"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 400: components["responses"]["scim_bad_request"]; - readonly 403: components["responses"]["scim_forbidden"]; - readonly 404: components["responses"]["scim_not_found"]; + readonly 'application/scim+json': components['schemas']['scim-user'] + } + } + readonly 304: components['responses']['not_modified'] + readonly 400: components['responses']['scim_bad_request'] + readonly 403: components['responses']['scim_forbidden'] + readonly 404: components['responses']['scim_not_found'] /** Response */ readonly 429: { readonly content: { - readonly "application/json": components["schemas"]["basic-error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['basic-error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { - readonly schemas?: readonly string[]; + readonly 'application/json': { + readonly schemas?: readonly string[] /** * @description Set of operations to be performed * @example [object Object] */ readonly Operations: readonly { /** @enum {string} */ - readonly op: "add" | "remove" | "replace"; - readonly path?: string; + readonly op: 'add' | 'remove' | 'replace' + readonly path?: string readonly value?: | { - readonly active?: boolean | null; - readonly userName?: string | null; - readonly externalId?: string | null; - readonly givenName?: string | null; - readonly familyName?: string | null; + readonly active?: boolean | null + readonly userName?: string | null + readonly externalId?: string | null + readonly givenName?: string | null + readonly familyName?: string | null } | readonly { - readonly value?: string; - readonly primary?: boolean; + readonly value?: string + readonly primary?: boolean }[] - | string; - }[]; - }; - }; - }; - }; + | string + }[] + } + } + } + } /** * Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -37930,38 +37892,38 @@ export interface operations { * * You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing * language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. */ - readonly "search/code": { + readonly 'search/code': { readonly parameters: { readonly query: { /** The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching code](https://docs.github.com/articles/searching-code/)" for a detailed list of qualifiers. */ - readonly q: string; + readonly q: string /** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */ - readonly sort?: "indexed"; + readonly sort?: 'indexed' /** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - readonly order?: components["parameters"]["order"]; + readonly order?: components['parameters']['order'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": { - readonly total_count: number; - readonly incomplete_results: boolean; - readonly items: readonly components["schemas"]["code-search-result-item"][]; - }; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 503: components["responses"]["service_unavailable"]; - }; - }; + readonly 'application/json': { + readonly total_count: number + readonly incomplete_results: boolean + readonly items: readonly components['schemas']['code-search-result-item'][] + } + } + } + readonly 304: components['responses']['not_modified'] + readonly 403: components['responses']['forbidden'] + readonly 422: components['responses']['validation_failed'] + readonly 503: components['responses']['service_unavailable'] + } + } /** * Find commits via various criteria on the default branch (usually `master`). This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -37972,35 +37934,35 @@ export interface operations { * * `q=repo:octocat/Spoon-Knife+css` */ - readonly "search/commits": { + readonly 'search/commits': { readonly parameters: { readonly query: { /** The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching commits](https://docs.github.com/articles/searching-commits/)" for a detailed list of qualifiers. */ - readonly q: string; + readonly q: string /** Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */ - readonly sort?: "author-date" | "committer-date"; + readonly sort?: 'author-date' | 'committer-date' /** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - readonly order?: components["parameters"]["order"]; + readonly order?: components['parameters']['order'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": { - readonly total_count: number; - readonly incomplete_results: boolean; - readonly items: readonly components["schemas"]["commit-search-result-item"][]; - }; - }; - }; - readonly 304: components["responses"]["not_modified"]; - }; - }; + readonly 'application/json': { + readonly total_count: number + readonly incomplete_results: boolean + readonly items: readonly components['schemas']['commit-search-result-item'][] + } + } + } + readonly 304: components['responses']['not_modified'] + } + } /** * Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -38015,49 +37977,49 @@ export interface operations { * * **Note:** For [user-to-server](https://docs.github.com/developers/apps/identifying-and-authorizing-users-for-github-apps#user-to-server-requests) GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." */ - readonly "search/issues-and-pull-requests": { + readonly 'search/issues-and-pull-requests': { readonly parameters: { readonly query: { /** The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching issues and pull requests](https://docs.github.com/articles/searching-issues-and-pull-requests/)" for a detailed list of qualifiers. */ - readonly q: string; + readonly q: string /** Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */ readonly sort?: - | "comments" - | "reactions" - | "reactions-+1" - | "reactions--1" - | "reactions-smile" - | "reactions-thinking_face" - | "reactions-heart" - | "reactions-tada" - | "interactions" - | "created" - | "updated"; + | 'comments' + | 'reactions' + | 'reactions-+1' + | 'reactions--1' + | 'reactions-smile' + | 'reactions-thinking_face' + | 'reactions-heart' + | 'reactions-tada' + | 'interactions' + | 'created' + | 'updated' /** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - readonly order?: components["parameters"]["order"]; + readonly order?: components['parameters']['order'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": { - readonly total_count: number; - readonly incomplete_results: boolean; - readonly items: readonly components["schemas"]["issue-search-result-item"][]; - }; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 503: components["responses"]["service_unavailable"]; - }; - }; + readonly 'application/json': { + readonly total_count: number + readonly incomplete_results: boolean + readonly items: readonly components['schemas']['issue-search-result-item'][] + } + } + } + readonly 304: components['responses']['not_modified'] + readonly 403: components['responses']['forbidden'] + readonly 422: components['responses']['validation_failed'] + readonly 503: components['responses']['service_unavailable'] + } + } /** * Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -38069,40 +38031,40 @@ export interface operations { * * The labels that best match the query appear first in the search results. */ - readonly "search/labels": { + readonly 'search/labels': { readonly parameters: { readonly query: { /** The id of the repository. */ - readonly repository_id: number; + readonly repository_id: number /** The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). */ - readonly q: string; + readonly q: string /** Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */ - readonly sort?: "created" | "updated"; + readonly sort?: 'created' | 'updated' /** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - readonly order?: components["parameters"]["order"]; + readonly order?: components['parameters']['order'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": { - readonly total_count: number; - readonly incomplete_results: boolean; - readonly items: readonly components["schemas"]["label-search-result-item"][]; - }; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; + readonly 'application/json': { + readonly total_count: number + readonly incomplete_results: boolean + readonly items: readonly components['schemas']['label-search-result-item'][] + } + } + } + readonly 304: components['responses']['not_modified'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } + } /** * Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -38114,37 +38076,37 @@ export interface operations { * * This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results. */ - readonly "search/repos": { + readonly 'search/repos': { readonly parameters: { readonly query: { /** The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers. */ - readonly q: string; + readonly q: string /** Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */ - readonly sort?: "stars" | "forks" | "help-wanted-issues" | "updated"; + readonly sort?: 'stars' | 'forks' | 'help-wanted-issues' | 'updated' /** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - readonly order?: components["parameters"]["order"]; + readonly order?: components['parameters']['order'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": { - readonly total_count: number; - readonly incomplete_results: boolean; - readonly items: readonly components["schemas"]["repo-search-result-item"][]; - }; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 503: components["responses"]["service_unavailable"]; - }; - }; + readonly 'application/json': { + readonly total_count: number + readonly incomplete_results: boolean + readonly items: readonly components['schemas']['repo-search-result-item'][] + } + } + } + readonly 304: components['responses']['not_modified'] + readonly 422: components['responses']['validation_failed'] + readonly 503: components['responses']['service_unavailable'] + } + } /** * Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers. * @@ -38156,31 +38118,31 @@ export interface operations { * * This query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results. */ - readonly "search/topics": { + readonly 'search/topics': { readonly parameters: { readonly query: { /** The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). */ - readonly q: string; + readonly q: string /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": { - readonly total_count: number; - readonly incomplete_results: boolean; - readonly items: readonly components["schemas"]["topic-search-result-item"][]; - }; - }; - }; - readonly 304: components["responses"]["not_modified"]; - }; - }; + readonly 'application/json': { + readonly total_count: number + readonly incomplete_results: boolean + readonly items: readonly components['schemas']['topic-search-result-item'][] + } + } + } + readonly 304: components['responses']['not_modified'] + } + } /** * Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -38192,54 +38154,54 @@ export interface operations { * * This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. */ - readonly "search/users": { + readonly 'search/users': { readonly parameters: { readonly query: { /** The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching users](https://docs.github.com/articles/searching-users/)" for a detailed list of qualifiers. */ - readonly q: string; + readonly q: string /** Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */ - readonly sort?: "followers" | "repositories" | "joined"; + readonly sort?: 'followers' | 'repositories' | 'joined' /** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - readonly order?: components["parameters"]["order"]; + readonly order?: components['parameters']['order'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": { - readonly total_count: number; - readonly incomplete_results: boolean; - readonly items: readonly components["schemas"]["user-search-result-item"][]; - }; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 503: components["responses"]["service_unavailable"]; - }; - }; + readonly 'application/json': { + readonly total_count: number + readonly incomplete_results: boolean + readonly items: readonly components['schemas']['user-search-result-item'][] + } + } + } + readonly 304: components['responses']['not_modified'] + readonly 422: components['responses']['validation_failed'] + readonly 503: components['responses']['service_unavailable'] + } + } /** **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/reference/teams#get-a-team-by-name) endpoint. */ - readonly "teams/get-legacy": { + readonly 'teams/get-legacy': { readonly parameters: { readonly path: { - readonly team_id: components["parameters"]["team-id"]; - }; - }; + readonly team_id: components['parameters']['team-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["team-full"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': components['schemas']['team-full'] + } + } + readonly 404: components['responses']['not_found'] + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/reference/teams#delete-a-team) endpoint. * @@ -38247,19 +38209,19 @@ export interface operations { * * If you are an organization owner, deleting a parent team will delete all of its child teams as well. */ - readonly "teams/delete-legacy": { + readonly 'teams/delete-legacy': { readonly parameters: { readonly path: { - readonly team_id: components["parameters"]["team-id"]; - }; - }; + readonly team_id: components['parameters']['team-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; + readonly 204: never + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/reference/teams#update-a-team) endpoint. * @@ -38267,36 +38229,36 @@ export interface operations { * * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. */ - readonly "teams/update-legacy": { + readonly 'teams/update-legacy': { readonly parameters: { readonly path: { - readonly team_id: components["parameters"]["team-id"]; - }; - }; + readonly team_id: components['parameters']['team-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["team-full"]; - }; - }; + readonly 'application/json': components['schemas']['team-full'] + } + } /** Response */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["team-full"]; - }; - }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': components['schemas']['team-full'] + } + } + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The name of the team. */ - readonly name: string; + readonly name: string /** @description The description of the team. */ - readonly description?: string; + readonly description?: string /** * @description The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: * **For a non-nested team:** @@ -38306,7 +38268,7 @@ export interface operations { * \* `closed` - visible to all members of this organization. * @enum {string} */ - readonly privacy?: "secret" | "closed"; + readonly privacy?: 'secret' | 'closed' /** * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: * \* `pull` - team members can pull, but not push to or administer newly-added repositories. @@ -38315,42 +38277,42 @@ export interface operations { * @default pull * @enum {string} */ - readonly permission?: "pull" | "push" | "admin"; + readonly permission?: 'pull' | 'push' | 'admin' /** @description The ID of a team to set as the parent team. */ - readonly parent_team_id?: number | null; - }; - }; - }; - }; + readonly parent_team_id?: number | null + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/reference/teams#list-discussions) endpoint. * * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - readonly "teams/list-discussions-legacy": { + readonly 'teams/list-discussions-legacy': { readonly parameters: { readonly path: { - readonly team_id: components["parameters"]["team-id"]; - }; + readonly team_id: components['parameters']['team-id'] + } readonly query: { /** One of `asc` (ascending) or `desc` (descending). */ - readonly direction?: components["parameters"]["direction"]; + readonly direction?: components['parameters']['direction'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["team-discussion"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['team-discussion'][] + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/reference/teams#create-a-discussion) endpoint. * @@ -38358,132 +38320,132 @@ export interface operations { * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - readonly "teams/create-discussion-legacy": { + readonly 'teams/create-discussion-legacy': { readonly parameters: { readonly path: { - readonly team_id: components["parameters"]["team-id"]; - }; - }; + readonly team_id: components['parameters']['team-id'] + } + } readonly responses: { /** Response */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; + readonly 'application/json': components['schemas']['team-discussion'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The discussion post's title. */ - readonly title: string; + readonly title: string /** @description The discussion post's body text. */ - readonly body: string; + readonly body: string /** @description Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. */ - readonly private?: boolean; - }; - }; - }; - }; + readonly private?: boolean + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/reference/teams#get-a-discussion) endpoint. * * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - readonly "teams/get-discussion-legacy": { + readonly 'teams/get-discussion-legacy': { readonly parameters: { readonly path: { - readonly team_id: components["parameters"]["team-id"]; - readonly discussion_number: components["parameters"]["discussion-number"]; - }; - }; + readonly team_id: components['parameters']['team-id'] + readonly discussion_number: components['parameters']['discussion-number'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['team-discussion'] + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/reference/teams#delete-a-discussion) endpoint. * * Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - readonly "teams/delete-discussion-legacy": { + readonly 'teams/delete-discussion-legacy': { readonly parameters: { readonly path: { - readonly team_id: components["parameters"]["team-id"]; - readonly discussion_number: components["parameters"]["discussion-number"]; - }; - }; + readonly team_id: components['parameters']['team-id'] + readonly discussion_number: components['parameters']['discussion-number'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/reference/teams#update-a-discussion) endpoint. * * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - readonly "teams/update-discussion-legacy": { + readonly 'teams/update-discussion-legacy': { readonly parameters: { readonly path: { - readonly team_id: components["parameters"]["team-id"]; - readonly discussion_number: components["parameters"]["discussion-number"]; - }; - }; + readonly team_id: components['parameters']['team-id'] + readonly discussion_number: components['parameters']['discussion-number'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; + readonly 'application/json': components['schemas']['team-discussion'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The discussion post's title. */ - readonly title?: string; + readonly title?: string /** @description The discussion post's body text. */ - readonly body?: string; - }; - }; - }; - }; + readonly body?: string + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/reference/teams#list-discussion-comments) endpoint. * * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - readonly "teams/list-discussion-comments-legacy": { + readonly 'teams/list-discussion-comments-legacy': { readonly parameters: { readonly path: { - readonly team_id: components["parameters"]["team-id"]; - readonly discussion_number: components["parameters"]["discussion-number"]; - }; + readonly team_id: components['parameters']['team-id'] + readonly discussion_number: components['parameters']['discussion-number'] + } readonly query: { /** One of `asc` (ascending) or `desc` (descending). */ - readonly direction?: components["parameters"]["direction"]; + readonly direction?: components['parameters']['direction'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["team-discussion-comment"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['team-discussion-comment'][] + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/reference/teams#create-a-discussion-comment) endpoint. * @@ -38491,263 +38453,263 @@ export interface operations { * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - readonly "teams/create-discussion-comment-legacy": { + readonly 'teams/create-discussion-comment-legacy': { readonly parameters: { readonly path: { - readonly team_id: components["parameters"]["team-id"]; - readonly discussion_number: components["parameters"]["discussion-number"]; - }; - }; + readonly team_id: components['parameters']['team-id'] + readonly discussion_number: components['parameters']['discussion-number'] + } + } readonly responses: { /** Response */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; + readonly 'application/json': components['schemas']['team-discussion-comment'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The discussion comment's body text. */ - readonly body: string; - }; - }; - }; - }; + readonly body: string + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/reference/teams#get-a-discussion-comment) endpoint. * * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - readonly "teams/get-discussion-comment-legacy": { + readonly 'teams/get-discussion-comment-legacy': { readonly parameters: { readonly path: { - readonly team_id: components["parameters"]["team-id"]; - readonly discussion_number: components["parameters"]["discussion-number"]; - readonly comment_number: components["parameters"]["comment-number"]; - }; - }; + readonly team_id: components['parameters']['team-id'] + readonly discussion_number: components['parameters']['discussion-number'] + readonly comment_number: components['parameters']['comment-number'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['team-discussion-comment'] + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/reference/teams#delete-a-discussion-comment) endpoint. * * Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - readonly "teams/delete-discussion-comment-legacy": { + readonly 'teams/delete-discussion-comment-legacy': { readonly parameters: { readonly path: { - readonly team_id: components["parameters"]["team-id"]; - readonly discussion_number: components["parameters"]["discussion-number"]; - readonly comment_number: components["parameters"]["comment-number"]; - }; - }; + readonly team_id: components['parameters']['team-id'] + readonly discussion_number: components['parameters']['discussion-number'] + readonly comment_number: components['parameters']['comment-number'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/reference/teams#update-a-discussion-comment) endpoint. * * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - readonly "teams/update-discussion-comment-legacy": { + readonly 'teams/update-discussion-comment-legacy': { readonly parameters: { readonly path: { - readonly team_id: components["parameters"]["team-id"]; - readonly discussion_number: components["parameters"]["discussion-number"]; - readonly comment_number: components["parameters"]["comment-number"]; - }; - }; + readonly team_id: components['parameters']['team-id'] + readonly discussion_number: components['parameters']['discussion-number'] + readonly comment_number: components['parameters']['comment-number'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; + readonly 'application/json': components['schemas']['team-discussion-comment'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The discussion comment's body text. */ - readonly body: string; - }; - }; - }; - }; + readonly body: string + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * * List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - readonly "reactions/list-for-team-discussion-comment-legacy": { + readonly 'reactions/list-for-team-discussion-comment-legacy': { readonly parameters: { readonly path: { - readonly team_id: components["parameters"]["team-id"]; - readonly discussion_number: components["parameters"]["discussion-number"]; - readonly comment_number: components["parameters"]["comment-number"]; - }; + readonly team_id: components['parameters']['team-id'] + readonly discussion_number: components['parameters']['discussion-number'] + readonly comment_number: components['parameters']['comment-number'] + } readonly query: { /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion comment. */ - readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + readonly content?: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["reaction"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['reaction'][] + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. * * Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. */ - readonly "reactions/create-for-team-discussion-comment-legacy": { + readonly 'reactions/create-for-team-discussion-comment-legacy': { readonly parameters: { readonly path: { - readonly team_id: components["parameters"]["team-id"]; - readonly discussion_number: components["parameters"]["discussion-number"]; - readonly comment_number: components["parameters"]["comment-number"]; - }; - }; + readonly team_id: components['parameters']['team-id'] + readonly discussion_number: components['parameters']['discussion-number'] + readonly comment_number: components['parameters']['comment-number'] + } + } readonly responses: { /** Response */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["reaction"]; - }; - }; - }; + readonly 'application/json': components['schemas']['reaction'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion comment. * @enum {string} */ - readonly content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - }; + readonly content: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion) endpoint. * * List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - readonly "reactions/list-for-team-discussion-legacy": { + readonly 'reactions/list-for-team-discussion-legacy': { readonly parameters: { readonly path: { - readonly team_id: components["parameters"]["team-id"]; - readonly discussion_number: components["parameters"]["discussion-number"]; - }; + readonly team_id: components['parameters']['team-id'] + readonly discussion_number: components['parameters']['discussion-number'] + } readonly query: { /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion. */ - readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + readonly content?: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["reaction"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['reaction'][] + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion) endpoint. * * Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. */ - readonly "reactions/create-for-team-discussion-legacy": { + readonly 'reactions/create-for-team-discussion-legacy': { readonly parameters: { readonly path: { - readonly team_id: components["parameters"]["team-id"]; - readonly discussion_number: components["parameters"]["discussion-number"]; - }; - }; + readonly team_id: components['parameters']['team-id'] + readonly discussion_number: components['parameters']['discussion-number'] + } + } readonly responses: { /** Response */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["reaction"]; - }; - }; - }; + readonly 'application/json': components['schemas']['reaction'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion. * @enum {string} */ - readonly content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - }; + readonly content: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/reference/teams#list-pending-team-invitations) endpoint. * * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. */ - readonly "teams/list-pending-invitations-legacy": { + readonly 'teams/list-pending-invitations-legacy': { readonly parameters: { readonly path: { - readonly team_id: components["parameters"]["team-id"]; - }; + readonly team_id: components['parameters']['team-id'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["organization-invitation"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['organization-invitation'][] + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/reference/teams#list-team-members) endpoint. * * Team members will include the members of child teams. */ - readonly "teams/list-members-legacy": { + readonly 'teams/list-members-legacy': { readonly parameters: { readonly path: { - readonly team_id: components["parameters"]["team-id"]; - }; + readonly team_id: components['parameters']['team-id'] + } readonly query: { /** * Filters members returned by their role in the team. Can be one of: @@ -38755,24 +38717,24 @@ export interface operations { * \* `maintainer` - team maintainers. * \* `all` - all members of the team. */ - readonly role?: "member" | "maintainer" | "all"; + readonly role?: 'member' | 'maintainer' | 'all' /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': readonly components['schemas']['simple-user'][] + } + } + readonly 404: components['responses']['not_found'] + } + } /** * The "Get team member" endpoint (described below) is deprecated. * @@ -38780,20 +38742,20 @@ export interface operations { * * To list members in a team, the team must be visible to the authenticated user. */ - readonly "teams/get-member-legacy": { + readonly 'teams/get-member-legacy': { readonly parameters: { readonly path: { - readonly team_id: components["parameters"]["team-id"]; - readonly username: components["parameters"]["username"]; - }; - }; + readonly team_id: components['parameters']['team-id'] + readonly username: components['parameters']['username'] + } + } readonly responses: { /** if user is a member */ - readonly 204: never; + readonly 204: never /** if user is not a member */ - readonly 404: unknown; - }; - }; + readonly 404: unknown + } + } /** * The "Add team member" endpoint (described below) is deprecated. * @@ -38807,23 +38769,23 @@ export interface operations { * * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - readonly "teams/add-member-legacy": { + readonly 'teams/add-member-legacy': { readonly parameters: { readonly path: { - readonly team_id: components["parameters"]["team-id"]; - readonly username: components["parameters"]["username"]; - }; - }; + readonly team_id: components['parameters']['team-id'] + readonly username: components['parameters']['username'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 403: components["responses"]["forbidden"]; + readonly 204: never + readonly 403: components['responses']['forbidden'] /** Not Found if team synchronization is set up */ - readonly 404: unknown; + readonly 404: unknown /** Unprocessable Entity if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization */ - readonly 422: unknown; - }; - }; + readonly 422: unknown + } + } /** * The "Remove team member" endpoint (described below) is deprecated. * @@ -38835,20 +38797,20 @@ export interface operations { * * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ - readonly "teams/remove-member-legacy": { + readonly 'teams/remove-member-legacy': { readonly parameters: { readonly path: { - readonly team_id: components["parameters"]["team-id"]; - readonly username: components["parameters"]["username"]; - }; - }; + readonly team_id: components['parameters']['team-id'] + readonly username: components['parameters']['username'] + } + } readonly responses: { /** Response */ - readonly 204: never; + readonly 204: never /** Not Found if team synchronization is setup */ - readonly 404: unknown; - }; - }; + readonly 404: unknown + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/reference/teams#get-team-membership-for-a-user) endpoint. * @@ -38861,23 +38823,23 @@ export interface operations { * * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team). */ - readonly "teams/get-membership-for-user-legacy": { + readonly 'teams/get-membership-for-user-legacy': { readonly parameters: { readonly path: { - readonly team_id: components["parameters"]["team-id"]; - readonly username: components["parameters"]["username"]; - }; - }; + readonly team_id: components['parameters']['team-id'] + readonly username: components['parameters']['username'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["team-membership"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': components['schemas']['team-membership'] + } + } + readonly 404: components['responses']['not_found'] + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint. * @@ -38891,29 +38853,29 @@ export interface operations { * * If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. */ - readonly "teams/add-or-update-membership-for-user-legacy": { + readonly 'teams/add-or-update-membership-for-user-legacy': { readonly parameters: { readonly path: { - readonly team_id: components["parameters"]["team-id"]; - readonly username: components["parameters"]["username"]; - }; - }; + readonly team_id: components['parameters']['team-id'] + readonly username: components['parameters']['username'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["team-membership"]; - }; - }; + readonly 'application/json': components['schemas']['team-membership'] + } + } /** Forbidden if team synchronization is set up */ - readonly 403: unknown; - readonly 404: components["responses"]["not_found"]; + readonly 403: unknown + readonly 404: components['responses']['not_found'] /** Unprocessable Entity if you attempt to add an organization to a team */ - readonly 422: unknown; - }; + readonly 422: unknown + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description The role that this user should have in the team. Can be one of: * \* `member` - a normal member of the team. @@ -38921,11 +38883,11 @@ export interface operations { * @default member * @enum {string} */ - readonly role?: "member" | "maintainer"; - }; - }; - }; - }; + readonly role?: 'member' | 'maintainer' + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/reference/teams#remove-team-membership-for-a-user) endpoint. * @@ -38935,101 +38897,101 @@ export interface operations { * * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ - readonly "teams/remove-membership-for-user-legacy": { + readonly 'teams/remove-membership-for-user-legacy': { readonly parameters: { readonly path: { - readonly team_id: components["parameters"]["team-id"]; - readonly username: components["parameters"]["username"]; - }; - }; + readonly team_id: components['parameters']['team-id'] + readonly username: components['parameters']['username'] + } + } readonly responses: { /** Response */ - readonly 204: never; + readonly 204: never /** if team synchronization is set up */ - readonly 403: unknown; - }; - }; + readonly 403: unknown + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/reference/teams#list-team-projects) endpoint. * * Lists the organization projects for a team. */ - readonly "teams/list-projects-legacy": { + readonly 'teams/list-projects-legacy': { readonly parameters: { readonly path: { - readonly team_id: components["parameters"]["team-id"]; - }; + readonly team_id: components['parameters']['team-id'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["team-project"][]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': readonly components['schemas']['team-project'][] + } + } + readonly 404: components['responses']['not_found'] + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/reference/teams#check-team-permissions-for-a-project) endpoint. * * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. */ - readonly "teams/check-permissions-for-project-legacy": { + readonly 'teams/check-permissions-for-project-legacy': { readonly parameters: { readonly path: { - readonly team_id: components["parameters"]["team-id"]; - readonly project_id: components["parameters"]["project-id"]; - }; - }; + readonly team_id: components['parameters']['team-id'] + readonly project_id: components['parameters']['project-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["team-project"]; - }; - }; + readonly 'application/json': components['schemas']['team-project'] + } + } /** Not Found if project is not managed by this team */ - readonly 404: unknown; - }; - }; + readonly 404: unknown + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/reference/teams#add-or-update-team-project-permissions) endpoint. * * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. */ - readonly "teams/add-or-update-project-permissions-legacy": { + readonly 'teams/add-or-update-project-permissions-legacy': { readonly parameters: { readonly path: { - readonly team_id: components["parameters"]["team-id"]; - readonly project_id: components["parameters"]["project-id"]; - }; - }; + readonly team_id: components['parameters']['team-id'] + readonly project_id: components['parameters']['project-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; + readonly 204: never /** Forbidden if the project is not owned by the organization */ readonly 403: { readonly content: { - readonly "application/json": { - readonly message?: string; - readonly documentation_url?: string; - }; - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': { + readonly message?: string + readonly documentation_url?: string + } + } + } + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description The permission to grant to the team for this project. Can be one of: * \* `read` - team members can read, but not write to or administer this project. @@ -39038,55 +39000,55 @@ export interface operations { * Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." * @enum {string} */ - readonly permission?: "read" | "write" | "admin"; - }; - }; - }; - }; + readonly permission?: 'read' | 'write' | 'admin' + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/reference/teams#remove-a-project-from-a-team) endpoint. * * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. */ - readonly "teams/remove-project-legacy": { + readonly 'teams/remove-project-legacy': { readonly parameters: { readonly path: { - readonly team_id: components["parameters"]["team-id"]; - readonly project_id: components["parameters"]["project-id"]; - }; - }; + readonly team_id: components['parameters']['team-id'] + readonly project_id: components['parameters']['project-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 404: components["responses"]["not_found"]; - readonly 415: components["responses"]["preview_header_missing"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; + readonly 204: never + readonly 404: components['responses']['not_found'] + readonly 415: components['responses']['preview_header_missing'] + readonly 422: components['responses']['validation_failed'] + } + } /** **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/reference/teams#list-team-repositories) endpoint. */ - readonly "teams/list-repos-legacy": { + readonly 'teams/list-repos-legacy': { readonly parameters: { readonly path: { - readonly team_id: components["parameters"]["team-id"]; - }; + readonly team_id: components['parameters']['team-id'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["minimal-repository"][]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': readonly components['schemas']['minimal-repository'][] + } + } + readonly 404: components['responses']['not_found'] + } + } /** * **Note**: Repositories inherited through a parent team will also be checked. * @@ -39094,27 +39056,27 @@ export interface operations { * * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: */ - readonly "teams/check-permissions-for-repo-legacy": { + readonly 'teams/check-permissions-for-repo-legacy': { readonly parameters: { readonly path: { - readonly team_id: components["parameters"]["team-id"]; - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly team_id: components['parameters']['team-id'] + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Alternative response with extra repository information */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["team-repository"]; - }; - }; + readonly 'application/json': components['schemas']['team-repository'] + } + } /** Response if repository is managed by this team */ - readonly 204: never; + readonly 204: never /** Not Found if repository is not managed by this team */ - readonly 404: unknown; - }; - }; + readonly 404: unknown + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/reference/teams#add-or-update-team-repository-permissions)" endpoint. * @@ -39122,23 +39084,23 @@ export interface operations { * * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - readonly "teams/add-or-update-repo-permissions-legacy": { + readonly 'teams/add-or-update-repo-permissions-legacy': { readonly parameters: { readonly path: { - readonly team_id: components["parameters"]["team-id"]; - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly team_id: components['parameters']['team-id'] + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 204: never + readonly 403: components['responses']['forbidden'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description The permission to grant the team on this repository. Can be one of: * \* `pull` - team members can pull, but not push to or administer this repository. @@ -39148,29 +39110,29 @@ export interface operations { * If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. * @enum {string} */ - readonly permission?: "pull" | "push" | "admin"; - }; - }; - }; - }; + readonly permission?: 'pull' | 'push' | 'admin' + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/reference/teams#remove-a-repository-from-a-team) endpoint. * * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. */ - readonly "teams/remove-repo-legacy": { + readonly 'teams/remove-repo-legacy': { readonly parameters: { readonly path: { - readonly team_id: components["parameters"]["team-id"]; - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly team_id: components['parameters']['team-id'] + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List IdP groups for a team`](https://docs.github.com/rest/reference/teams#list-idp-groups-for-a-team) endpoint. * @@ -39178,23 +39140,23 @@ export interface operations { * * List IdP groups connected to a team on GitHub. */ - readonly "teams/list-idp-groups-for-legacy": { + readonly 'teams/list-idp-groups-for-legacy': { readonly parameters: { readonly path: { - readonly team_id: components["parameters"]["team-id"]; - }; - }; + readonly team_id: components['parameters']['team-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["group-mapping"]; - }; - }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': components['schemas']['group-mapping'] + } + } + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create or update IdP group connections`](https://docs.github.com/rest/reference/teams#create-or-update-idp-group-connections) endpoint. * @@ -39202,249 +39164,249 @@ export interface operations { * * Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty `groups` array will remove all connections for a team. */ - readonly "teams/create-or-update-idp-group-connections-legacy": { + readonly 'teams/create-or-update-idp-group-connections-legacy': { readonly parameters: { readonly path: { - readonly team_id: components["parameters"]["team-id"]; - }; - }; + readonly team_id: components['parameters']['team-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["group-mapping"]; - }; - }; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': components['schemas']['group-mapping'] + } + } + readonly 403: components['responses']['forbidden'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The IdP groups you want to connect to a GitHub team. When updating, the new `groups` object will replace the original one. You must include any existing groups that you don't want to remove. */ readonly groups: readonly { /** @description ID of the IdP group. */ - readonly group_id: string; + readonly group_id: string /** @description Name of the IdP group. */ - readonly group_name: string; + readonly group_name: string /** @description Description of the IdP group. */ - readonly group_description: string; + readonly group_description: string /** @example "caceab43fc9ffa20081c" */ - readonly id?: string; + readonly id?: string /** @example "external-team-6c13e7288ef7" */ - readonly name?: string; + readonly name?: string /** @example "moar cheese pleese" */ - readonly description?: string; - }[]; + readonly description?: string + }[] /** @example "I am not a timestamp" */ - readonly synced_at?: string; - }; - }; - }; - }; + readonly synced_at?: string + } + } + } + } /** **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/reference/teams#list-child-teams) endpoint. */ - readonly "teams/list-child-legacy": { + readonly 'teams/list-child-legacy': { readonly parameters: { readonly path: { - readonly team_id: components["parameters"]["team-id"]; - }; + readonly team_id: components['parameters']['team-id'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** if child teams exist */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["team"][]; - }; - }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; + readonly 'application/json': readonly components['schemas']['team'][] + } + } + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } + } /** * If the authenticated user is authenticated through basic authentication or OAuth with the `user` scope, then the response lists public and private profile information. * * If the authenticated user is authenticated through OAuth without the `user` scope, then the response lists only public profile information. */ - readonly "users/get-authenticated": { - readonly parameters: {}; + readonly 'users/get-authenticated': { + readonly parameters: {} readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["private-user"] | components["schemas"]["public-user"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - }; - }; + readonly 'application/json': components['schemas']['private-user'] | components['schemas']['public-user'] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + } + } /** **Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API. */ - readonly "users/update-authenticated": { - readonly parameters: {}; + readonly 'users/update-authenticated': { + readonly parameters: {} readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["private-user"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': components['schemas']['private-user'] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description The new name of the user. * @example Omar Jahandar */ - readonly name?: string; + readonly name?: string /** * @description The publicly visible email address of the user. * @example omar@example.com */ - readonly email?: string; + readonly email?: string /** * @description The new blog URL of the user. * @example blog.example.com */ - readonly blog?: string; + readonly blog?: string /** * @description The new Twitter username of the user. * @example therealomarj */ - readonly twitter_username?: string | null; + readonly twitter_username?: string | null /** * @description The new company of the user. * @example Acme corporation */ - readonly company?: string; + readonly company?: string /** * @description The new location of the user. * @example Berlin, Germany */ - readonly location?: string; + readonly location?: string /** @description The new hiring availability of the user. */ - readonly hireable?: boolean; + readonly hireable?: boolean /** @description The new short biography of the user. */ - readonly bio?: string; - }; - }; - }; - }; + readonly bio?: string + } + } + } + } /** List the users you've blocked on your personal account. */ - readonly "users/list-blocked-by-authenticated-user": { - readonly parameters: {}; + readonly 'users/list-blocked-by-authenticated-user': { + readonly parameters: {} readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 415: components["responses"]["preview_header_missing"]; - }; - }; - readonly "users/check-blocked": { + readonly 'application/json': readonly components['schemas']['simple-user'][] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 415: components['responses']['preview_header_missing'] + } + } + readonly 'users/check-blocked': { readonly parameters: { readonly path: { - readonly username: components["parameters"]["username"]; - }; - }; + readonly username: components['parameters']['username'] + } + } readonly responses: { /** If the user is blocked: */ - readonly 204: never; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + readonly 204: never + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] /** If the user is not blocked: */ readonly 404: { readonly content: { - readonly "application/json": components["schemas"]["basic-error"]; - }; - }; - }; - }; - readonly "users/block": { + readonly 'application/json': components['schemas']['basic-error'] + } + } + } + } + readonly 'users/block': { readonly parameters: { readonly path: { - readonly username: components["parameters"]["username"]; - }; - }; + readonly username: components['parameters']['username'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; - readonly "users/unblock": { + readonly 204: never + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } + } + readonly 'users/unblock': { readonly parameters: { readonly path: { - readonly username: components["parameters"]["username"]; - }; - }; + readonly username: components['parameters']['username'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 204: never + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } /** * Lists the authenticated user's codespaces. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - readonly "codespaces/list-for-authenticated-user": { + readonly 'codespaces/list-for-authenticated-user': { readonly parameters: { readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; + readonly page?: components['parameters']['page'] /** ID of the Repository to filter on */ - readonly repository_id?: components["parameters"]["repository-id-in-query"]; - }; - }; + readonly repository_id?: components['parameters']['repository-id-in-query'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": { - readonly total_count: number; - readonly codespaces: readonly components["schemas"]["codespace"][]; - }; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; - }; - }; + readonly 'application/json': { + readonly total_count: number + readonly codespaces: readonly components['schemas']['codespace'][] + } + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 500: components['responses']['internal_error'] + } + } /** * Creates a new codespace, owned by the authenticated user. * @@ -39452,119 +39414,119 @@ export interface operations { * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - readonly "codespaces/create-for-authenticated-user": { + readonly 'codespaces/create-for-authenticated-user': { readonly responses: { /** Response when the codespace was successfully created */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["codespace"]; - }; - }; + readonly 'application/json': components['schemas']['codespace'] + } + } /** Response when the codespace creation partially failed but is being retried in the background */ readonly 202: { readonly content: { - readonly "application/json": components["schemas"]["codespace"]; - }; - }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; + readonly 'application/json': components['schemas']['codespace'] + } + } + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } readonly requestBody: { readonly content: { - readonly "application/json": + readonly 'application/json': | { /** @description Repository id for this codespace */ - readonly repository_id: number; + readonly repository_id: number /** @description Git ref (typically a branch name) for this codespace */ - readonly ref?: string; + readonly ref?: string /** @description Location for this codespace */ - readonly location: string; + readonly location: string /** @description Machine type to use for this codespace */ - readonly machine?: string; + readonly machine?: string /** @description Working directory for this codespace */ - readonly working_directory?: string; + readonly working_directory?: string /** @description Time in minutes before codespace stops from inactivity */ - readonly idle_timeout_minutes?: number; + readonly idle_timeout_minutes?: number } | { /** @description Pull request number for this codespace */ readonly pull_request: { /** @description Pull request number */ - readonly pull_request_number: number; + readonly pull_request_number: number /** @description Repository id for this codespace */ - readonly repository_id: number; - }; + readonly repository_id: number + } /** @description Location for this codespace */ - readonly location: string; + readonly location: string /** @description Machine type to use for this codespace */ - readonly machine?: string; + readonly machine?: string /** @description Working directory for this codespace */ - readonly working_directory?: string; + readonly working_directory?: string /** @description Time in minutes before codespace stops from inactivity */ - readonly idle_timeout_minutes?: number; - }; - }; - }; - }; + readonly idle_timeout_minutes?: number + } + } + } + } /** * Lists all secrets available for a user's Codespaces without revealing their * encrypted values. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - readonly "codespaces/list-secrets-for-authenticated-user": { + readonly 'codespaces/list-secrets-for-authenticated-user': { readonly parameters: { readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": { - readonly total_count: number; - readonly secrets: readonly components["schemas"]["codespaces-secret"][]; - }; - }; - }; - }; - }; + readonly 'application/json': { + readonly total_count: number + readonly secrets: readonly components['schemas']['codespaces-secret'][] + } + } + } + } + } /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with one of the 'read:user' or 'user' scopes in their personal access token. User must have Codespaces access to use this endpoint. */ - readonly "codespaces/get-public-key-for-authenticated-user": { + readonly 'codespaces/get-public-key-for-authenticated-user': { readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["codespaces-user-public-key"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['codespaces-user-public-key'] + } + } + } + } /** * Gets a secret available to a user's codespaces without revealing its encrypted value. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - readonly "codespaces/get-secret-for-authenticated-user": { + readonly 'codespaces/get-secret-for-authenticated-user': { readonly parameters: { readonly path: { /** secret_name parameter */ - readonly secret_name: components["parameters"]["secret-name"]; - }; - }; + readonly secret_name: components['parameters']['secret-name'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["codespaces-secret"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['codespaces-secret'] + } + } + } + } /** * Creates or updates a secret for a user's codespace with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access token with the `user` scope to use this endpoint. User must also have Codespaces access to use this endpoint. @@ -39640,195 +39602,195 @@ export interface operations { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - readonly "codespaces/create-or-update-secret-for-authenticated-user": { + readonly 'codespaces/create-or-update-secret-for-authenticated-user': { readonly parameters: { readonly path: { /** secret_name parameter */ - readonly secret_name: components["parameters"]["secret-name"]; - }; - }; + readonly secret_name: components['parameters']['secret-name'] + } + } readonly responses: { /** Response after successfully creaing a secret */ readonly 201: { readonly content: { - readonly "application/json": { readonly [key: string]: unknown }; - }; - }; + readonly 'application/json': { readonly [key: string]: unknown } + } + } /** Response after successfully updating a secret */ - readonly 204: never; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 204: never + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for the authenticated user](https://docs.github.com/rest/reference/codespaces#get-the-public-key-for-the-authenticated-user) endpoint. */ - readonly encrypted_value: string; + readonly encrypted_value: string /** @description ID of the key you used to encrypt the secret. */ - readonly key_id: string; + readonly key_id: string /** @description An array of repository ids that can access the user secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/reference/codespaces#list-selected-repositories-for-a-user-secret), [Set selected repositories for a user secret](https://docs.github.com/rest/reference/codespaces#set-selected-repositories-for-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/reference/codespaces#remove-a-selected-repository-from-a-user-secret) endpoints. */ - readonly selected_repository_ids?: readonly string[]; - }; - }; - }; - }; + readonly selected_repository_ids?: readonly string[] + } + } + } + } /** Deletes a secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret. You must authenticate using an access token with the `user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - readonly "codespaces/delete-secret-for-authenticated-user": { + readonly 'codespaces/delete-secret-for-authenticated-user': { readonly parameters: { readonly path: { /** secret_name parameter */ - readonly secret_name: components["parameters"]["secret-name"]; - }; - }; + readonly secret_name: components['parameters']['secret-name'] + } + } readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** * List the repositories that have been granted the ability to use a user's codespace secret. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - readonly "codespaces/list-repositories-for-secret-for-authenticated-user": { + readonly 'codespaces/list-repositories-for-secret-for-authenticated-user': { readonly parameters: { readonly path: { /** secret_name parameter */ - readonly secret_name: components["parameters"]["secret-name"]; - }; - }; + readonly secret_name: components['parameters']['secret-name'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": { - readonly total_count: number; - readonly repositories: readonly components["schemas"]["minimal-repository"][]; - }; - }; - }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; - }; - }; + readonly 'application/json': { + readonly total_count: number + readonly repositories: readonly components['schemas']['minimal-repository'][] + } + } + } + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 500: components['responses']['internal_error'] + } + } /** * Select the repositories that will use a user's codespace secret. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - readonly "codespaces/set-repositories-for-secret-for-authenticated-user": { + readonly 'codespaces/set-repositories-for-secret-for-authenticated-user': { readonly parameters: { readonly path: { /** secret_name parameter */ - readonly secret_name: components["parameters"]["secret-name"]; - }; - }; + readonly secret_name: components['parameters']['secret-name'] + } + } readonly responses: { /** No Content when repositories were added to the selected list */ - readonly 204: never; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; - }; + readonly 204: never + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 500: components['responses']['internal_error'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description An array of repository ids for which a codespace can access the secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/reference/codespaces#list-selected-repositories-for-a-user-secret), [Add a selected repository to a user secret](https://docs.github.com/rest/reference/codespaces#add-a-selected-repository-to-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/reference/codespaces#remove-a-selected-repository-from-a-user-secret) endpoints. */ - readonly selected_repository_ids: readonly number[]; - }; - }; - }; - }; + readonly selected_repository_ids: readonly number[] + } + } + } + } /** * Adds a repository to the selected repositories for a user's codespace secret. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - readonly "codespaces/add-repository-for-secret-for-authenticated-user": { + readonly 'codespaces/add-repository-for-secret-for-authenticated-user': { readonly parameters: { readonly path: { /** secret_name parameter */ - readonly secret_name: components["parameters"]["secret-name"]; - readonly repository_id: number; - }; - }; + readonly secret_name: components['parameters']['secret-name'] + readonly repository_id: number + } + } readonly responses: { /** No Content when repository was added to the selected list */ - readonly 204: never; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; - }; - }; + readonly 204: never + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 500: components['responses']['internal_error'] + } + } /** * Removes a repository from the selected repositories for a user's codespace secret. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - readonly "codespaces/remove-repository-for-secret-for-authenticated-user": { + readonly 'codespaces/remove-repository-for-secret-for-authenticated-user': { readonly parameters: { readonly path: { /** secret_name parameter */ - readonly secret_name: components["parameters"]["secret-name"]; - readonly repository_id: number; - }; - }; + readonly secret_name: components['parameters']['secret-name'] + readonly repository_id: number + } + } readonly responses: { /** No Content when repository was removed from the selected list */ - readonly 204: never; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; - }; - }; + readonly 204: never + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 500: components['responses']['internal_error'] + } + } /** * Gets information about a user's codespace. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - readonly "codespaces/get-for-authenticated-user": { + readonly 'codespaces/get-for-authenticated-user': { readonly parameters: { readonly path: { /** The name of the codespace. */ - readonly codespace_name: components["parameters"]["codespace-name"]; - }; - }; + readonly codespace_name: components['parameters']['codespace-name'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["codespace"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; - }; - }; + readonly 'application/json': components['schemas']['codespace'] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 500: components['responses']['internal_error'] + } + } /** * Deletes a user's codespace. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - readonly "codespaces/delete-for-authenticated-user": { + readonly 'codespaces/delete-for-authenticated-user': { readonly parameters: { readonly path: { /** The name of the codespace. */ - readonly codespace_name: components["parameters"]["codespace-name"]; - }; - }; - readonly responses: { - readonly 202: components["responses"]["accepted"]; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; - }; - }; + readonly codespace_name: components['parameters']['codespace-name'] + } + } + readonly responses: { + readonly 202: components['responses']['accepted'] + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 500: components['responses']['internal_error'] + } + } /** * Updates a codespace owned by the authenticated user. Currently only the codespace's machine type and recent folders can be modified using this endpoint. * @@ -39836,470 +39798,470 @@ export interface operations { * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - readonly "codespaces/update-for-authenticated-user": { + readonly 'codespaces/update-for-authenticated-user': { readonly parameters: { readonly path: { /** The name of the codespace. */ - readonly codespace_name: components["parameters"]["codespace-name"]; - }; - }; + readonly codespace_name: components['parameters']['codespace-name'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["codespace"]; - }; - }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; + readonly 'application/json': components['schemas']['codespace'] + } + } + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description A valid machine to transition this codespace to. */ - readonly machine?: string; + readonly machine?: string /** @description Recently opened folders inside the codespace. It is currently used by the clients to determine the folder path to load the codespace in. */ - readonly recent_folders?: readonly string[]; - }; - }; - }; - }; + readonly recent_folders?: readonly string[] + } + } + } + } /** * Triggers an export of the specified codespace and returns a URL and ID where the status of the export can be monitored. * * You must authenticate using a personal access token with the `codespace` scope to use this endpoint. */ - readonly "codespaces/export-for-authenticated-user": { + readonly 'codespaces/export-for-authenticated-user': { readonly parameters: { readonly path: { /** The name of the codespace. */ - readonly codespace_name: components["parameters"]["codespace-name"]; - }; - }; + readonly codespace_name: components['parameters']['codespace-name'] + } + } readonly responses: { /** Response */ readonly 202: { readonly content: { - readonly "application/json": components["schemas"]["codespace-export-details"]; - }; - }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 500: components["responses"]["internal_error"]; - }; - }; + readonly 'application/json': components['schemas']['codespace-export-details'] + } + } + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + readonly 500: components['responses']['internal_error'] + } + } /** * Gets information about an export of a codespace. * * You must authenticate using a personal access token with the `codespace` scope to use this endpoint. */ - readonly "codespaces/get-export-details-for-authenticated-user": { + readonly 'codespaces/get-export-details-for-authenticated-user': { readonly parameters: { readonly path: { /** The name of the codespace. */ - readonly codespace_name: components["parameters"]["codespace-name"]; + readonly codespace_name: components['parameters']['codespace-name'] /** The ID of the export operation, or `latest`. Currently only `latest` is currently supported. */ - readonly export_id: components["parameters"]["export-id"]; - }; - }; + readonly export_id: components['parameters']['export-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["codespace-export-details"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': components['schemas']['codespace-export-details'] + } + } + readonly 404: components['responses']['not_found'] + } + } /** * List the machine types a codespace can transition to use. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - readonly "codespaces/codespace-machines-for-authenticated-user": { + readonly 'codespaces/codespace-machines-for-authenticated-user': { readonly parameters: { readonly path: { /** The name of the codespace. */ - readonly codespace_name: components["parameters"]["codespace-name"]; - }; - }; + readonly codespace_name: components['parameters']['codespace-name'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": { - readonly total_count: number; - readonly machines: readonly components["schemas"]["codespace-machine"][]; - }; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; - }; - }; + readonly 'application/json': { + readonly total_count: number + readonly machines: readonly components['schemas']['codespace-machine'][] + } + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 500: components['responses']['internal_error'] + } + } /** * Starts a user's codespace. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - readonly "codespaces/start-for-authenticated-user": { + readonly 'codespaces/start-for-authenticated-user': { readonly parameters: { readonly path: { /** The name of the codespace. */ - readonly codespace_name: components["parameters"]["codespace-name"]; - }; - }; + readonly codespace_name: components['parameters']['codespace-name'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["codespace"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 400: components["responses"]["bad_request"]; - readonly 401: components["responses"]["requires_authentication"]; + readonly 'application/json': components['schemas']['codespace'] + } + } + readonly 304: components['responses']['not_modified'] + readonly 400: components['responses']['bad_request'] + readonly 401: components['responses']['requires_authentication'] /** Payment required */ readonly 402: { readonly content: { - readonly "application/json": components["schemas"]["basic-error"]; - }; - }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; - readonly 500: components["responses"]["internal_error"]; - }; - }; + readonly 'application/json': components['schemas']['basic-error'] + } + } + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 409: components['responses']['conflict'] + readonly 500: components['responses']['internal_error'] + } + } /** * Stops a user's codespace. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - readonly "codespaces/stop-for-authenticated-user": { + readonly 'codespaces/stop-for-authenticated-user': { readonly parameters: { readonly path: { /** The name of the codespace. */ - readonly codespace_name: components["parameters"]["codespace-name"]; - }; - }; + readonly codespace_name: components['parameters']['codespace-name'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["codespace"]; - }; - }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; - }; - }; + readonly 'application/json': components['schemas']['codespace'] + } + } + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 500: components['responses']['internal_error'] + } + } /** Sets the visibility for your primary email addresses. */ - readonly "users/set-primary-email-visibility-for-authenticated-user": { - readonly parameters: {}; + readonly 'users/set-primary-email-visibility-for-authenticated-user': { + readonly parameters: {} readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["email"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': readonly components['schemas']['email'][] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description Denotes whether an email is publicly visible. * @enum {string} */ - readonly visibility: "public" | "private"; - }; - }; - }; - }; + readonly visibility: 'public' | 'private' + } + } + } + } /** Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope. */ - readonly "users/list-emails-for-authenticated-user": { + readonly 'users/list-emails-for-authenticated-user': { readonly parameters: { readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["email"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': readonly components['schemas']['email'][] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } /** This endpoint is accessible with the `user` scope. */ - readonly "users/add-email-for-authenticated-user": { - readonly parameters: {}; + readonly 'users/add-email-for-authenticated-user': { + readonly parameters: {} readonly responses: { /** Response */ readonly 201: { readonly content: { - readonly "application/json": readonly components["schemas"]["email"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': readonly components['schemas']['email'][] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": + readonly 'application/json': | { /** * @description Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key. * @example */ - readonly emails: readonly string[]; + readonly emails: readonly string[] } | readonly string[] - | string; - }; - }; - }; + | string + } + } + } /** This endpoint is accessible with the `user` scope. */ - readonly "users/delete-email-for-authenticated-user": { - readonly parameters: {}; + readonly 'users/delete-email-for-authenticated-user': { + readonly parameters: {} readonly responses: { /** Response */ - readonly 204: never; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 204: never + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": + readonly 'application/json': | { /** @description Email addresses associated with the GitHub user account. */ - readonly emails: readonly string[]; + readonly emails: readonly string[] } | readonly string[] - | string; - }; - }; - }; + | string + } + } + } /** Lists the people following the authenticated user. */ - readonly "users/list-followers-for-authenticated-user": { + readonly 'users/list-followers-for-authenticated-user': { readonly parameters: { readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - }; - }; + readonly 'application/json': readonly components['schemas']['simple-user'][] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + } + } /** Lists the people who the authenticated user follows. */ - readonly "users/list-followed-by-authenticated-user": { + readonly 'users/list-followed-by-authenticated-user': { readonly parameters: { readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - }; - }; - readonly "users/check-person-is-followed-by-authenticated": { + readonly 'application/json': readonly components['schemas']['simple-user'][] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + } + } + readonly 'users/check-person-is-followed-by-authenticated': { readonly parameters: { readonly path: { - readonly username: components["parameters"]["username"]; - }; - }; + readonly username: components['parameters']['username'] + } + } readonly responses: { /** if the person is followed by the authenticated user */ - readonly 204: never; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + readonly 204: never + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] /** if the person is not followed by the authenticated user */ readonly 404: { readonly content: { - readonly "application/json": components["schemas"]["basic-error"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['basic-error'] + } + } + } + } /** * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." * * Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. */ - readonly "users/follow": { + readonly 'users/follow': { readonly parameters: { readonly path: { - readonly username: components["parameters"]["username"]; - }; - }; + readonly username: components['parameters']['username'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 204: never + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } /** Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. */ - readonly "users/unfollow": { + readonly 'users/unfollow': { readonly parameters: { readonly path: { - readonly username: components["parameters"]["username"]; - }; - }; + readonly username: components['parameters']['username'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 204: never + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } /** Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - readonly "users/list-gpg-keys-for-authenticated-user": { + readonly 'users/list-gpg-keys-for-authenticated-user': { readonly parameters: { readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["gpg-key"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': readonly components['schemas']['gpg-key'][] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } /** Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - readonly "users/create-gpg-key-for-authenticated-user": { - readonly parameters: {}; + readonly 'users/create-gpg-key-for-authenticated-user': { + readonly parameters: {} readonly responses: { /** Response */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["gpg-key"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': components['schemas']['gpg-key'] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description A GPG key in ASCII-armored format. */ - readonly armored_public_key: string; - }; - }; - }; - }; + readonly armored_public_key: string + } + } + } + } /** View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - readonly "users/get-gpg-key-for-authenticated-user": { + readonly 'users/get-gpg-key-for-authenticated-user': { readonly parameters: { readonly path: { /** gpg_key_id parameter */ - readonly gpg_key_id: components["parameters"]["gpg-key-id"]; - }; - }; + readonly gpg_key_id: components['parameters']['gpg-key-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["gpg-key"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': components['schemas']['gpg-key'] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } /** Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - readonly "users/delete-gpg-key-for-authenticated-user": { + readonly 'users/delete-gpg-key-for-authenticated-user': { readonly parameters: { readonly path: { /** gpg_key_id parameter */ - readonly gpg_key_id: components["parameters"]["gpg-key-id"]; - }; - }; + readonly gpg_key_id: components['parameters']['gpg-key-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; + readonly 204: never + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } + } /** * Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. * @@ -40309,32 +40271,32 @@ export interface operations { * * You can find the permissions for the installation under the `permissions` key. */ - readonly "apps/list-installations-for-authenticated-user": { + readonly 'apps/list-installations-for-authenticated-user': { readonly parameters: { readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** You can find the permissions for the installation under the `permissions` key. */ readonly 200: { - readonly headers: {}; - readonly content: { - readonly "application/json": { - readonly total_count: number; - readonly installations: readonly components["schemas"]["installation"][]; - }; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 415: components["responses"]["preview_header_missing"]; - }; - }; + readonly headers: {} + readonly content: { + readonly 'application/json': { + readonly total_count: number + readonly installations: readonly components['schemas']['installation'][] + } + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 415: components['responses']['preview_header_missing'] + } + } /** * List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation. * @@ -40344,116 +40306,115 @@ export interface operations { * * The access the user has to each repository is included in the hash under the `permissions` key. */ - readonly "apps/list-installation-repos-for-authenticated-user": { + readonly 'apps/list-installation-repos-for-authenticated-user': { readonly parameters: { readonly path: { /** installation_id parameter */ - readonly installation_id: components["parameters"]["installation-id"]; - }; + readonly installation_id: components['parameters']['installation-id'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** The access the user has to each repository is included in the hash under the `permissions` key. */ readonly 200: { - readonly headers: {}; - readonly content: { - readonly "application/json": { - readonly total_count: number; - readonly repository_selection?: string; - readonly repositories: readonly components["schemas"]["repository"][]; - }; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly headers: {} + readonly content: { + readonly 'application/json': { + readonly total_count: number + readonly repository_selection?: string + readonly repositories: readonly components['schemas']['repository'][] + } + } + } + readonly 304: components['responses']['not_modified'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } /** * Add a single repository to an installation. The authenticated user must have admin access to the repository. * * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. */ - readonly "apps/add-repo-to-installation-for-authenticated-user": { + readonly 'apps/add-repo-to-installation-for-authenticated-user': { readonly parameters: { readonly path: { /** installation_id parameter */ - readonly installation_id: components["parameters"]["installation-id"]; - readonly repository_id: components["parameters"]["repository-id"]; - }; - }; + readonly installation_id: components['parameters']['installation-id'] + readonly repository_id: components['parameters']['repository-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 204: never + readonly 304: components['responses']['not_modified'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } /** * Remove a single repository from an installation. The authenticated user must have admin access to the repository. * * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. */ - readonly "apps/remove-repo-from-installation-for-authenticated-user": { + readonly 'apps/remove-repo-from-installation-for-authenticated-user': { readonly parameters: { readonly path: { /** installation_id parameter */ - readonly installation_id: components["parameters"]["installation-id"]; - readonly repository_id: components["parameters"]["repository-id"]; - }; - }; - readonly responses: { - /** Response */ - readonly 204: never; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly installation_id: components['parameters']['installation-id'] + readonly repository_id: components['parameters']['repository-id'] + } + } + readonly responses: { + /** Response */ + readonly 204: never + readonly 304: components['responses']['not_modified'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } /** Shows which type of GitHub user can interact with your public repositories and when the restriction expires. */ - readonly "interactions/get-restrictions-for-authenticated-user": { + readonly 'interactions/get-restrictions-for-authenticated-user': { readonly responses: { /** Default response */ readonly 200: { readonly content: { - readonly "application/json": Partial & - Partial<{ readonly [key: string]: unknown }>; - }; - }; + readonly 'application/json': Partial & Partial<{ readonly [key: string]: unknown }> + } + } /** Response when there are no restrictions */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user. */ - readonly "interactions/set-restrictions-for-authenticated-user": { + readonly 'interactions/set-restrictions-for-authenticated-user': { readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["interaction-limit-response"]; - }; - }; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': components['schemas']['interaction-limit-response'] + } + } + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": components["schemas"]["interaction-limit"]; - }; - }; - }; + readonly 'application/json': components['schemas']['interaction-limit'] + } + } + } /** Removes any interaction restrictions from your public repositories. */ - readonly "interactions/remove-restrictions-for-authenticated-user": { + readonly 'interactions/remove-restrictions-for-authenticated-user': { readonly responses: { /** Response */ - readonly 204: never; - }; - }; + readonly 204: never + } + } /** * List issues across owned and member repositories assigned to the authenticated user. * @@ -40462,7 +40423,7 @@ export interface operations { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - readonly "issues/list-for-authenticated-user": { + readonly 'issues/list-for-authenticated-user': { readonly parameters: { readonly query: { /** @@ -40473,314 +40434,314 @@ export interface operations { * \* `subscribed`: Issues you're subscribed to updates for * \* `all` or `repos`: All issues the authenticated user can see, regardless of participation or creation */ - readonly filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all"; + readonly filter?: 'assigned' | 'created' | 'mentioned' | 'subscribed' | 'repos' | 'all' /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ - readonly state?: "open" | "closed" | "all"; + readonly state?: 'open' | 'closed' | 'all' /** A list of comma separated label names. Example: `bug,ui,@high` */ - readonly labels?: components["parameters"]["labels"]; + readonly labels?: components['parameters']['labels'] /** What to sort results by. Can be either `created`, `updated`, `comments`. */ - readonly sort?: "created" | "updated" | "comments"; + readonly sort?: 'created' | 'updated' | 'comments' /** One of `asc` (ascending) or `desc` (descending). */ - readonly direction?: components["parameters"]["direction"]; + readonly direction?: components['parameters']['direction'] /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; + readonly since?: components['parameters']['since'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["issue"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': readonly components['schemas']['issue'][] + } + } + readonly 304: components['responses']['not_modified'] + readonly 404: components['responses']['not_found'] + } + } /** Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - readonly "users/list-public-ssh-keys-for-authenticated-user": { + readonly 'users/list-public-ssh-keys-for-authenticated-user': { readonly parameters: { readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["key"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': readonly components['schemas']['key'][] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } /** Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - readonly "users/create-public-ssh-key-for-authenticated-user": { - readonly parameters: {}; + readonly 'users/create-public-ssh-key-for-authenticated-user': { + readonly parameters: {} readonly responses: { /** Response */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["key"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': components['schemas']['key'] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description A descriptive name for the new key. * @example Personal MacBook Air */ - readonly title?: string; + readonly title?: string /** @description The public SSH key to add to your GitHub account. */ - readonly key: string; - }; - }; - }; - }; + readonly key: string + } + } + } + } /** View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - readonly "users/get-public-ssh-key-for-authenticated-user": { + readonly 'users/get-public-ssh-key-for-authenticated-user': { readonly parameters: { readonly path: { /** key_id parameter */ - readonly key_id: components["parameters"]["key-id"]; - }; - }; + readonly key_id: components['parameters']['key-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["key"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': components['schemas']['key'] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } /** Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - readonly "users/delete-public-ssh-key-for-authenticated-user": { + readonly 'users/delete-public-ssh-key-for-authenticated-user': { readonly parameters: { readonly path: { /** key_id parameter */ - readonly key_id: components["parameters"]["key-id"]; - }; - }; - readonly responses: { - /** Response */ - readonly 204: never; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly key_id: components['parameters']['key-id'] + } + } + readonly responses: { + /** Response */ + readonly 204: never + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } /** Lists the active subscriptions for the authenticated user. You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an [OAuth token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/). */ - readonly "apps/list-subscriptions-for-authenticated-user": { + readonly 'apps/list-subscriptions-for-authenticated-user': { readonly parameters: { readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["user-marketplace-purchase"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': readonly components['schemas']['user-marketplace-purchase'][] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 404: components['responses']['not_found'] + } + } /** Lists the active subscriptions for the authenticated user. You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an [OAuth token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/). */ - readonly "apps/list-subscriptions-for-authenticated-user-stubbed": { + readonly 'apps/list-subscriptions-for-authenticated-user-stubbed': { readonly parameters: { readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["user-marketplace-purchase"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - }; - }; - readonly "orgs/list-memberships-for-authenticated-user": { + readonly 'application/json': readonly components['schemas']['user-marketplace-purchase'][] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + } + } + readonly 'orgs/list-memberships-for-authenticated-user': { readonly parameters: { readonly query: { /** Indicates the state of the memberships to return. Can be either `active` or `pending`. If not specified, the API returns both active and pending memberships. */ - readonly state?: "active" | "pending"; + readonly state?: 'active' | 'pending' /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["org-membership"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; - readonly "orgs/get-membership-for-authenticated-user": { + readonly 'application/json': readonly components['schemas']['org-membership'][] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 422: components['responses']['validation_failed'] + } + } + readonly 'orgs/get-membership-for-authenticated-user': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; - }; + readonly org: components['parameters']['org'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["org-membership"]; - }; - }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "orgs/update-membership-for-authenticated-user": { + readonly 'application/json': components['schemas']['org-membership'] + } + } + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } + readonly 'orgs/update-membership-for-authenticated-user': { readonly parameters: { readonly path: { - readonly org: components["parameters"]["org"]; - }; - }; + readonly org: components['parameters']['org'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["org-membership"]; - }; - }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': components['schemas']['org-membership'] + } + } + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description The state that the membership should be in. Only `"active"` will be accepted. * @enum {string} */ - readonly state: "active"; - }; - }; - }; - }; + readonly state: 'active' + } + } + } + } /** Lists all migrations a user has started. */ - readonly "migrations/list-for-authenticated-user": { + readonly 'migrations/list-for-authenticated-user': { readonly parameters: { readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["migration"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - }; - }; + readonly 'application/json': readonly components['schemas']['migration'][] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + } + } /** Initiates the generation of a user migration archive. */ - readonly "migrations/start-for-authenticated-user": { - readonly parameters: {}; + readonly 'migrations/start-for-authenticated-user': { + readonly parameters: {} readonly responses: { /** Response */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["migration"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly 'application/json': components['schemas']['migration'] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description Lock the repositories being migrated at the start of the migration * @example true */ - readonly lock_repositories?: boolean; + readonly lock_repositories?: boolean /** * @description Do not include attachments in the migration * @example true */ - readonly exclude_attachments?: boolean; + readonly exclude_attachments?: boolean /** * @description Do not include releases in the migration * @example true */ - readonly exclude_releases?: boolean; + readonly exclude_releases?: boolean /** * @description Indicates whether projects owned by the organization or users should be excluded. * @example true */ - readonly exclude_owner_projects?: boolean; + readonly exclude_owner_projects?: boolean /** * @description Exclude attributes from the API response to improve performance * @example repositories */ - readonly exclude?: readonly "repositories"[]; - readonly repositories: readonly string[]; - }; - }; - }; - }; + readonly exclude?: readonly 'repositories'[] + readonly repositories: readonly string[] + } + } + } + } /** * Fetches a single user migration. The response includes the `state` of the migration, which can be one of the following values: * @@ -40791,29 +40752,29 @@ export interface operations { * * Once the migration has been `exported` you can [download the migration archive](https://docs.github.com/rest/reference/migrations#download-a-user-migration-archive). */ - readonly "migrations/get-status-for-authenticated-user": { + readonly 'migrations/get-status-for-authenticated-user': { readonly parameters: { readonly path: { /** migration_id parameter */ - readonly migration_id: components["parameters"]["migration-id"]; - }; + readonly migration_id: components['parameters']['migration-id'] + } readonly query: { - readonly exclude?: readonly string[]; - }; - }; + readonly exclude?: readonly string[] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["migration"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': components['schemas']['migration'] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } /** * Fetches the URL to download the migration archive as a `tar.gz` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects: * @@ -40837,82 +40798,82 @@ export interface operations { * * The archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data. */ - readonly "migrations/get-archive-for-authenticated-user": { + readonly 'migrations/get-archive-for-authenticated-user': { readonly parameters: { readonly path: { /** migration_id parameter */ - readonly migration_id: components["parameters"]["migration-id"]; - }; - }; + readonly migration_id: components['parameters']['migration-id'] + } + } readonly responses: { /** Response */ - readonly 302: never; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - }; - }; + readonly 302: never + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + } + } /** Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the [List user migrations](https://docs.github.com/rest/reference/migrations#list-user-migrations) and [Get a user migration status](https://docs.github.com/rest/reference/migrations#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted. */ - readonly "migrations/delete-archive-for-authenticated-user": { + readonly 'migrations/delete-archive-for-authenticated-user': { readonly parameters: { readonly path: { /** migration_id parameter */ - readonly migration_id: components["parameters"]["migration-id"]; - }; - }; - readonly responses: { - /** Response */ - readonly 204: never; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly migration_id: components['parameters']['migration-id'] + } + } + readonly responses: { + /** Response */ + readonly 204: never + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } /** Unlocks a repository. You can lock repositories when you [start a user migration](https://docs.github.com/rest/reference/migrations#start-a-user-migration). Once the migration is complete you can unlock each repository to begin using it again or [delete the repository](https://docs.github.com/rest/reference/repos#delete-a-repository) if you no longer need the source data. Returns a status of `404 Not Found` if the repository is not locked. */ - readonly "migrations/unlock-repo-for-authenticated-user": { + readonly 'migrations/unlock-repo-for-authenticated-user': { readonly parameters: { readonly path: { /** migration_id parameter */ - readonly migration_id: components["parameters"]["migration-id"]; + readonly migration_id: components['parameters']['migration-id'] /** repo_name parameter */ - readonly repo_name: components["parameters"]["repo-name"]; - }; - }; - readonly responses: { - /** Response */ - readonly 204: never; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly repo_name: components['parameters']['repo-name'] + } + } + readonly responses: { + /** Response */ + readonly 204: never + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } /** Lists all the repositories for this user migration. */ - readonly "migrations/list-repos-for-authenticated-user": { + readonly 'migrations/list-repos-for-authenticated-user': { readonly parameters: { readonly path: { /** migration_id parameter */ - readonly migration_id: components["parameters"]["migration-id"]; - }; + readonly migration_id: components['parameters']['migration-id'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["minimal-repository"][]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': readonly components['schemas']['minimal-repository'][] + } + } + readonly 404: components['responses']['not_found'] + } + } /** * List organizations for the authenticated user. * @@ -40920,99 +40881,99 @@ export interface operations { * * This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response. */ - readonly "orgs/list-for-authenticated-user": { + readonly 'orgs/list-for-authenticated-user': { readonly parameters: { readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["organization-simple"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - }; - }; + readonly 'application/json': readonly components['schemas']['organization-simple'][] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + } + } /** * Lists packages owned by the authenticated user within the user's namespace. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - readonly "packages/list-packages-for-authenticated-user": { + readonly 'packages/list-packages-for-authenticated-user': { readonly parameters: { readonly query: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + readonly package_type: 'npm' | 'maven' | 'rubygems' | 'docker' | 'nuget' | 'container' /** The selected visibility of the packages. Can be one of `public`, `private`, or `internal`. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set. */ - readonly visibility?: components["parameters"]["package-visibility"]; - }; - }; + readonly visibility?: components['parameters']['package-visibility'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["package"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['package'][] + } + } + } + } /** * Gets a specific package for a package owned by the authenticated user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - readonly "packages/get-package-for-authenticated-user": { + readonly 'packages/get-package-for-authenticated-user': { readonly parameters: { readonly path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + readonly package_type: components['parameters']['package-type'] /** The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; - }; - }; + readonly package_name: components['parameters']['package-name'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["package"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['package'] + } + } + } + } /** * Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:delete` scopes. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - readonly "packages/delete-package-for-authenticated-user": { + readonly 'packages/delete-package-for-authenticated-user': { readonly parameters: { readonly path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + readonly package_type: components['parameters']['package-type'] /** The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; - }; - }; + readonly package_name: components['parameters']['package-name'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 204: never + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } /** * Restores a package owned by the authenticated user. * @@ -41022,113 +40983,113 @@ export interface operations { * * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. If `package_type` is not `container`, your token must also include the `repo` scope. */ - readonly "packages/restore-package-for-authenticated-user": { + readonly 'packages/restore-package-for-authenticated-user': { readonly parameters: { readonly path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + readonly package_type: components['parameters']['package-type'] /** The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; - }; + readonly package_name: components['parameters']['package-name'] + } readonly query: { /** package token */ - readonly token?: string; - }; - }; + readonly token?: string + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 204: never + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } /** * Returns all package versions for a package owned by the authenticated user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - readonly "packages/get-all-package-versions-for-package-owned-by-authenticated-user": { + readonly 'packages/get-all-package-versions-for-package-owned-by-authenticated-user': { readonly parameters: { readonly path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + readonly package_type: components['parameters']['package-type'] /** The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; - }; + readonly package_name: components['parameters']['package-name'] + } readonly query: { /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; + readonly page?: components['parameters']['page'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** The state of the package, either active or deleted. */ - readonly state?: "active" | "deleted"; - }; - }; + readonly state?: 'active' | 'deleted' + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["package-version"][]; - }; - }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': readonly components['schemas']['package-version'][] + } + } + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } /** * Gets a specific package version for a package owned by the authenticated user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - readonly "packages/get-package-version-for-authenticated-user": { + readonly 'packages/get-package-version-for-authenticated-user': { readonly parameters: { readonly path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + readonly package_type: components['parameters']['package-type'] /** The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; + readonly package_name: components['parameters']['package-name'] /** Unique identifier of the package version. */ - readonly package_version_id: components["parameters"]["package-version-id"]; - }; - }; + readonly package_version_id: components['parameters']['package-version-id'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["package-version"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['package-version'] + } + } + } + } /** * Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:delete` scopes. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - readonly "packages/delete-package-version-for-authenticated-user": { + readonly 'packages/delete-package-version-for-authenticated-user': { readonly parameters: { readonly path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + readonly package_type: components['parameters']['package-type'] /** The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; + readonly package_name: components['parameters']['package-name'] /** Unique identifier of the package version. */ - readonly package_version_id: components["parameters"]["package-version-id"]; - }; - }; + readonly package_version_id: components['parameters']['package-version-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 204: never + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } /** * Restores a package version owned by the authenticated user. * @@ -41138,131 +41099,131 @@ export interface operations { * * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. If `package_type` is not `container`, your token must also include the `repo` scope. */ - readonly "packages/restore-package-version-for-authenticated-user": { + readonly 'packages/restore-package-version-for-authenticated-user': { readonly parameters: { readonly path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + readonly package_type: components['parameters']['package-type'] /** The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; + readonly package_name: components['parameters']['package-name'] /** Unique identifier of the package version. */ - readonly package_version_id: components["parameters"]["package-version-id"]; - }; - }; + readonly package_version_id: components['parameters']['package-version-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "projects/create-for-authenticated-user": { - readonly parameters: {}; + readonly 204: never + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } + readonly 'projects/create-for-authenticated-user': { + readonly parameters: {} readonly responses: { /** Response */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["project"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 415: components["responses"]["preview_header_missing"]; - readonly 422: components["responses"]["validation_failed_simple"]; - }; + readonly 'application/json': components['schemas']['project'] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 415: components['responses']['preview_header_missing'] + readonly 422: components['responses']['validation_failed_simple'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description Name of the project * @example Week One Sprint */ - readonly name: string; + readonly name: string /** * @description Body of the project * @example This project represents the sprint of the first week in January */ - readonly body?: string | null; - }; - }; - }; - }; + readonly body?: string | null + } + } + } + } /** Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope. */ - readonly "users/list-public-emails-for-authenticated-user": { + readonly 'users/list-public-emails-for-authenticated-user': { readonly parameters: { readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["email"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': readonly components['schemas']['email'][] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } /** * Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. * * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. */ - readonly "repos/list-for-authenticated-user": { + readonly 'repos/list-for-authenticated-user': { readonly parameters: { readonly query: { /** Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`. */ - readonly visibility?: "all" | "public" | "private"; + readonly visibility?: 'all' | 'public' | 'private' /** * Comma-separated list of values. Can include: * \* `owner`: Repositories that are owned by the authenticated user. * \* `collaborator`: Repositories that the user has been added to as a collaborator. * \* `organization_member`: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on. */ - readonly affiliation?: string; + readonly affiliation?: string /** * Can be one of `all`, `owner`, `public`, `private`, `member`. Note: For GitHub AE, can be one of `all`, `owner`, `internal`, `private`, `member`. Default: `all` * * Will cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**. */ - readonly type?: "all" | "owner" | "public" | "private" | "member"; + readonly type?: 'all' | 'owner' | 'public' | 'private' | 'member' /** Can be one of `created`, `updated`, `pushed`, `full_name`. */ - readonly sort?: "created" | "updated" | "pushed" | "full_name"; + readonly sort?: 'created' | 'updated' | 'pushed' | 'full_name' /** Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc` */ - readonly direction?: "asc" | "desc"; + readonly direction?: 'asc' | 'desc' /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; + readonly page?: components['parameters']['page'] /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; + readonly since?: components['parameters']['since'] /** Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly before?: components["parameters"]["before"]; - }; - }; + readonly before?: components['parameters']['before'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["repository"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; + readonly 'application/json': readonly components['schemas']['repository'][] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 422: components['responses']['validation_failed'] + } + } /** * Creates a new repository for the authenticated user. * @@ -41273,323 +41234,323 @@ export interface operations { * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. * * `repo` scope to create a private repository. */ - readonly "repos/create-for-authenticated-user": { - readonly parameters: {}; + readonly 'repos/create-for-authenticated-user': { + readonly parameters: {} readonly responses: { /** Response */ readonly 201: { readonly headers: { - readonly Location?: string; - }; - readonly content: { - readonly "application/json": components["schemas"]["repository"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 400: components["responses"]["bad_request"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; + readonly Location?: string + } + readonly content: { + readonly 'application/json': components['schemas']['repository'] + } + } + readonly 304: components['responses']['not_modified'] + readonly 400: components['responses']['bad_request'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } readonly requestBody: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** * @description The name of the repository. * @example Team Environment */ - readonly name: string; + readonly name: string /** @description A short description of the repository. */ - readonly description?: string; + readonly description?: string /** @description A URL with more information about the repository. */ - readonly homepage?: string; + readonly homepage?: string /** @description Whether the repository is private. */ - readonly private?: boolean; + readonly private?: boolean /** * @description Whether issues are enabled. * @default true * @example true */ - readonly has_issues?: boolean; + readonly has_issues?: boolean /** * @description Whether projects are enabled. * @default true * @example true */ - readonly has_projects?: boolean; + readonly has_projects?: boolean /** * @description Whether the wiki is enabled. * @default true * @example true */ - readonly has_wiki?: boolean; + readonly has_wiki?: boolean /** @description The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. */ - readonly team_id?: number; + readonly team_id?: number /** @description Whether the repository is initialized with a minimal README. */ - readonly auto_init?: boolean; + readonly auto_init?: boolean /** * @description The desired language or platform to apply to the .gitignore. * @example Haskell */ - readonly gitignore_template?: string; + readonly gitignore_template?: string /** * @description The license keyword of the open source license for this repository. * @example mit */ - readonly license_template?: string; + readonly license_template?: string /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - readonly allow_squash_merge?: boolean; + readonly allow_squash_merge?: boolean /** * @description Whether to allow merge commits for pull requests. * @default true * @example true */ - readonly allow_merge_commit?: boolean; + readonly allow_merge_commit?: boolean /** * @description Whether to allow rebase merges for pull requests. * @default true * @example true */ - readonly allow_rebase_merge?: boolean; + readonly allow_rebase_merge?: boolean /** @description Whether to allow Auto-merge to be used on pull requests. */ - readonly allow_auto_merge?: boolean; + readonly allow_auto_merge?: boolean /** @description Whether to delete head branches when pull requests are merged */ - readonly delete_branch_on_merge?: boolean; + readonly delete_branch_on_merge?: boolean /** * @description Whether downloads are enabled. * @default true * @example true */ - readonly has_downloads?: boolean; + readonly has_downloads?: boolean /** * @description Whether this repository acts as a template that can be used to generate new repositories. * @example true */ - readonly is_template?: boolean; - }; - }; - }; - }; + readonly is_template?: boolean + } + } + } + } /** When authenticating as a user, this endpoint will list all currently open repository invitations for that user. */ - readonly "repos/list-invitations-for-authenticated-user": { + readonly 'repos/list-invitations-for-authenticated-user': { readonly parameters: { readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["repository-invitation"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "repos/decline-invitation-for-authenticated-user": { + readonly 'application/json': readonly components['schemas']['repository-invitation'][] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } + readonly 'repos/decline-invitation-for-authenticated-user': { readonly parameters: { readonly path: { /** invitation_id parameter */ - readonly invitation_id: components["parameters"]["invitation-id"]; - }; - }; + readonly invitation_id: components['parameters']['invitation-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; - }; - }; - readonly "repos/accept-invitation-for-authenticated-user": { + readonly 204: never + readonly 304: components['responses']['not_modified'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 409: components['responses']['conflict'] + } + } + readonly 'repos/accept-invitation-for-authenticated-user': { readonly parameters: { readonly path: { /** invitation_id parameter */ - readonly invitation_id: components["parameters"]["invitation-id"]; - }; - }; + readonly invitation_id: components['parameters']['invitation-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; - }; - }; + readonly 204: never + readonly 304: components['responses']['not_modified'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + readonly 409: components['responses']['conflict'] + } + } /** * Lists repositories the authenticated user has starred. * * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: */ - readonly "activity/list-repos-starred-by-authenticated-user": { + readonly 'activity/list-repos-starred-by-authenticated-user': { readonly parameters: { readonly query: { /** One of `created` (when the repository was starred) or `updated` (when it was last pushed to). */ - readonly sort?: components["parameters"]["sort"]; + readonly sort?: components['parameters']['sort'] /** One of `asc` (ascending) or `desc` (descending). */ - readonly direction?: components["parameters"]["direction"]; + readonly direction?: components['parameters']['direction'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["repository"][]; - readonly "application/vnd.github.v3.star+json": readonly components["schemas"]["starred-repository"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - }; - }; - readonly "activity/check-repo-is-starred-by-authenticated-user": { + readonly 'application/json': readonly components['schemas']['repository'][] + readonly 'application/vnd.github.v3.star+json': readonly components['schemas']['starred-repository'][] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + } + } + readonly 'activity/check-repo-is-starred-by-authenticated-user': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response if this repository is starred by you */ - readonly 204: never; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + readonly 204: never + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] /** Not Found if this repository is not starred by you */ readonly 404: { readonly content: { - readonly "application/json": components["schemas"]["basic-error"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['basic-error'] + } + } + } + } /** Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - readonly "activity/star-repo-for-authenticated-user": { + readonly 'activity/star-repo-for-authenticated-user': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "activity/unstar-repo-for-authenticated-user": { + readonly 204: never + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } + readonly 'activity/unstar-repo-for-authenticated-user': { readonly parameters: { readonly path: { - readonly owner: components["parameters"]["owner"]; - readonly repo: components["parameters"]["repo"]; - }; - }; + readonly owner: components['parameters']['owner'] + readonly repo: components['parameters']['repo'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 204: never + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } /** Lists repositories the authenticated user is watching. */ - readonly "activity/list-watched-repos-for-authenticated-user": { + readonly 'activity/list-watched-repos-for-authenticated-user': { readonly parameters: { readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["minimal-repository"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - }; - }; + readonly 'application/json': readonly components['schemas']['minimal-repository'][] + } + } + readonly 304: components['responses']['not_modified'] + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + } + } /** List all of the teams across all of the organizations to which the authenticated user belongs. This method requires `user`, `repo`, or `read:org` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://docs.github.com/apps/building-oauth-apps/). */ - readonly "teams/list-for-authenticated-user": { + readonly 'teams/list-for-authenticated-user': { readonly parameters: { readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["team-full"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': readonly components['schemas']['team-full'][] + } + } + readonly 304: components['responses']['not_modified'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } /** * Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts. * * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of users. */ - readonly "users/list": { + readonly 'users/list': { readonly parameters: { readonly query: { /** A user ID. Only return users with an ID greater than this ID. */ - readonly since?: components["parameters"]["since-user"]; + readonly since?: components['parameters']['since-user'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; - }; - }; + readonly per_page?: components['parameters']['per-page'] + } + } readonly responses: { /** Response */ readonly 200: { readonly headers: { - readonly Link?: string; - }; + readonly Link?: string + } readonly content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - }; - }; + readonly 'application/json': readonly components['schemas']['simple-user'][] + } + } + readonly 304: components['responses']['not_modified'] + } + } /** * Provides publicly available information about someone with a GitHub account. * @@ -41599,197 +41560,197 @@ export interface operations { * * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/reference/users#emails)". */ - readonly "users/get-by-username": { + readonly 'users/get-by-username': { readonly parameters: { readonly path: { - readonly username: components["parameters"]["username"]; - }; - }; + readonly username: components['parameters']['username'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["private-user"] | components["schemas"]["public-user"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': components['schemas']['private-user'] | components['schemas']['public-user'] + } + } + readonly 404: components['responses']['not_found'] + } + } /** If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. */ - readonly "activity/list-events-for-authenticated-user": { + readonly 'activity/list-events-for-authenticated-user': { readonly parameters: { readonly path: { - readonly username: components["parameters"]["username"]; - }; + readonly username: components['parameters']['username'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["event"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['event'][] + } + } + } + } /** This is the user's organization dashboard. You must be authenticated as the user to view this. */ - readonly "activity/list-org-events-for-authenticated-user": { + readonly 'activity/list-org-events-for-authenticated-user': { readonly parameters: { readonly path: { - readonly username: components["parameters"]["username"]; - readonly org: components["parameters"]["org"]; - }; + readonly username: components['parameters']['username'] + readonly org: components['parameters']['org'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["event"][]; - }; - }; - }; - }; - readonly "activity/list-public-events-for-user": { + readonly 'application/json': readonly components['schemas']['event'][] + } + } + } + } + readonly 'activity/list-public-events-for-user': { readonly parameters: { readonly path: { - readonly username: components["parameters"]["username"]; - }; + readonly username: components['parameters']['username'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["event"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['event'][] + } + } + } + } /** Lists the people following the specified user. */ - readonly "users/list-followers-for-user": { + readonly 'users/list-followers-for-user': { readonly parameters: { readonly path: { - readonly username: components["parameters"]["username"]; - }; + readonly username: components['parameters']['username'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['simple-user'][] + } + } + } + } /** Lists the people who the specified user follows. */ - readonly "users/list-following-for-user": { + readonly 'users/list-following-for-user': { readonly parameters: { readonly path: { - readonly username: components["parameters"]["username"]; - }; + readonly username: components['parameters']['username'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; - }; - }; - }; - }; - readonly "users/check-following-for-user": { + readonly 'application/json': readonly components['schemas']['simple-user'][] + } + } + } + } + readonly 'users/check-following-for-user': { readonly parameters: { readonly path: { - readonly username: components["parameters"]["username"]; - readonly target_user: string; - }; - }; + readonly username: components['parameters']['username'] + readonly target_user: string + } + } readonly responses: { /** if the user follows the target user */ - readonly 204: never; + readonly 204: never /** if the user does not follow the target user */ - readonly 404: unknown; - }; - }; + readonly 404: unknown + } + } /** Lists public gists for the specified user: */ - readonly "gists/list-for-user": { + readonly 'gists/list-for-user': { readonly parameters: { readonly path: { - readonly username: components["parameters"]["username"]; - }; + readonly username: components['parameters']['username'] + } readonly query: { /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; + readonly since?: components['parameters']['since'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["base-gist"][]; - }; - }; - readonly 422: components["responses"]["validation_failed"]; - }; - }; + readonly 'application/json': readonly components['schemas']['base-gist'][] + } + } + readonly 422: components['responses']['validation_failed'] + } + } /** Lists the GPG keys for a user. This information is accessible by anyone. */ - readonly "users/list-gpg-keys-for-user": { + readonly 'users/list-gpg-keys-for-user': { readonly parameters: { readonly path: { - readonly username: components["parameters"]["username"]; - }; + readonly username: components['parameters']['username'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["gpg-key"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['gpg-key'][] + } + } + } + } /** * Provides hovercard information when authenticated through basic auth or OAuth with the `repo` scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. * @@ -41800,153 +41761,153 @@ export interface operations { * https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 * ``` */ - readonly "users/get-context-for-user": { + readonly 'users/get-context-for-user': { readonly parameters: { readonly path: { - readonly username: components["parameters"]["username"]; - }; + readonly username: components['parameters']['username'] + } readonly query: { /** Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, `pull_request`. **Required** when using `subject_id`. */ - readonly subject_type?: "organization" | "repository" | "issue" | "pull_request"; + readonly subject_type?: 'organization' | 'repository' | 'issue' | 'pull_request' /** Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`. */ - readonly subject_id?: string; - }; - }; + readonly subject_id?: string + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["hovercard"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; + readonly 'application/json': components['schemas']['hovercard'] + } + } + readonly 404: components['responses']['not_found'] + readonly 422: components['responses']['validation_failed'] + } + } /** * Enables an authenticated GitHub App to find the user’s installation information. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly "apps/get-user-installation": { + readonly 'apps/get-user-installation': { readonly parameters: { readonly path: { - readonly username: components["parameters"]["username"]; - }; - }; + readonly username: components['parameters']['username'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["installation"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['installation'] + } + } + } + } /** Lists the _verified_ public SSH keys for a user. This is accessible by anyone. */ - readonly "users/list-public-keys-for-user": { + readonly 'users/list-public-keys-for-user': { readonly parameters: { readonly path: { - readonly username: components["parameters"]["username"]; - }; + readonly username: components['parameters']['username'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["key-simple"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['key-simple'][] + } + } + } + } /** * List [public organization memberships](https://docs.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user. * * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/rest/reference/orgs#list-organizations-for-the-authenticated-user) API instead. */ - readonly "orgs/list-for-user": { + readonly 'orgs/list-for-user': { readonly parameters: { readonly path: { - readonly username: components["parameters"]["username"]; - }; + readonly username: components['parameters']['username'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["organization-simple"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['organization-simple'][] + } + } + } + } /** * Lists all packages in a user's namespace for which the requesting user has access. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - readonly "packages/list-packages-for-user": { + readonly 'packages/list-packages-for-user': { readonly parameters: { readonly query: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + readonly package_type: 'npm' | 'maven' | 'rubygems' | 'docker' | 'nuget' | 'container' /** The selected visibility of the packages. Can be one of `public`, `private`, or `internal`. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set. */ - readonly visibility?: components["parameters"]["package-visibility"]; - }; + readonly visibility?: components['parameters']['package-visibility'] + } readonly path: { - readonly username: components["parameters"]["username"]; - }; - }; + readonly username: components['parameters']['username'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["package"][]; - }; - }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - }; - }; + readonly 'application/json': readonly components['schemas']['package'][] + } + } + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + } + } /** * Gets a specific package metadata for a public package owned by a user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - readonly "packages/get-package-for-user": { + readonly 'packages/get-package-for-user': { readonly parameters: { readonly path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + readonly package_type: components['parameters']['package-type'] /** The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; - readonly username: components["parameters"]["username"]; - }; - }; + readonly package_name: components['parameters']['package-name'] + readonly username: components['parameters']['username'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["package"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['package'] + } + } + } + } /** * Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * @@ -41954,24 +41915,24 @@ export interface operations { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. */ - readonly "packages/delete-package-for-user": { + readonly 'packages/delete-package-for-user': { readonly parameters: { readonly path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + readonly package_type: components['parameters']['package-type'] /** The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; - readonly username: components["parameters"]["username"]; - }; - }; + readonly package_name: components['parameters']['package-name'] + readonly username: components['parameters']['username'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 204: never + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } /** * Restores an entire package for a user. * @@ -41983,83 +41944,83 @@ export interface operations { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. */ - readonly "packages/restore-package-for-user": { + readonly 'packages/restore-package-for-user': { readonly parameters: { readonly path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + readonly package_type: components['parameters']['package-type'] /** The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; - readonly username: components["parameters"]["username"]; - }; + readonly package_name: components['parameters']['package-name'] + readonly username: components['parameters']['username'] + } readonly query: { /** package token */ - readonly token?: string; - }; - }; + readonly token?: string + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 204: never + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } /** * Returns all package versions for a public package owned by a specified user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - readonly "packages/get-all-package-versions-for-package-owned-by-user": { + readonly 'packages/get-all-package-versions-for-package-owned-by-user': { readonly parameters: { readonly path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + readonly package_type: components['parameters']['package-type'] /** The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; - readonly username: components["parameters"]["username"]; - }; - }; + readonly package_name: components['parameters']['package-name'] + readonly username: components['parameters']['username'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["package-version"][]; - }; - }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 'application/json': readonly components['schemas']['package-version'][] + } + } + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } /** * Gets a specific package version for a public package owned by a specified user. * * At this time, to use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - readonly "packages/get-package-version-for-user": { + readonly 'packages/get-package-version-for-user': { readonly parameters: { readonly path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + readonly package_type: components['parameters']['package-type'] /** The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; + readonly package_name: components['parameters']['package-name'] /** Unique identifier of the package version. */ - readonly package_version_id: components["parameters"]["package-version-id"]; - readonly username: components["parameters"]["username"]; - }; - }; + readonly package_version_id: components['parameters']['package-version-id'] + readonly username: components['parameters']['username'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["package-version"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['package-version'] + } + } + } + } /** * Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * @@ -42067,26 +42028,26 @@ export interface operations { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. */ - readonly "packages/delete-package-version-for-user": { + readonly 'packages/delete-package-version-for-user': { readonly parameters: { readonly path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + readonly package_type: components['parameters']['package-type'] /** The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; - readonly username: components["parameters"]["username"]; + readonly package_name: components['parameters']['package-name'] + readonly username: components['parameters']['username'] /** Unique identifier of the package version. */ - readonly package_version_id: components["parameters"]["package-version-id"]; - }; - }; + readonly package_version_id: components['parameters']['package-version-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; + readonly 204: never + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } /** * Restores a specific package version for a user. * @@ -42098,123 +42059,123 @@ export interface operations { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. */ - readonly "packages/restore-package-version-for-user": { + readonly 'packages/restore-package-version-for-user': { readonly parameters: { readonly path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + readonly package_type: components['parameters']['package-type'] /** The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; - readonly username: components["parameters"]["username"]; + readonly package_name: components['parameters']['package-name'] + readonly username: components['parameters']['username'] /** Unique identifier of the package version. */ - readonly package_version_id: components["parameters"]["package-version-id"]; - }; - }; + readonly package_version_id: components['parameters']['package-version-id'] + } + } readonly responses: { /** Response */ - readonly 204: never; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "projects/list-for-user": { + readonly 204: never + readonly 401: components['responses']['requires_authentication'] + readonly 403: components['responses']['forbidden'] + readonly 404: components['responses']['not_found'] + } + } + readonly 'projects/list-for-user': { readonly parameters: { readonly path: { - readonly username: components["parameters"]["username"]; - }; + readonly username: components['parameters']['username'] + } readonly query: { /** Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. */ - readonly state?: "open" | "closed" | "all"; + readonly state?: 'open' | 'closed' | 'all' /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["project"][]; - }; - }; - readonly 422: components["responses"]["validation_failed"]; - }; - }; + readonly 'application/json': readonly components['schemas']['project'][] + } + } + readonly 422: components['responses']['validation_failed'] + } + } /** These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. */ - readonly "activity/list-received-events-for-user": { + readonly 'activity/list-received-events-for-user': { readonly parameters: { readonly path: { - readonly username: components["parameters"]["username"]; - }; + readonly username: components['parameters']['username'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["event"][]; - }; - }; - }; - }; - readonly "activity/list-received-public-events-for-user": { + readonly 'application/json': readonly components['schemas']['event'][] + } + } + } + } + readonly 'activity/list-received-public-events-for-user': { readonly parameters: { readonly path: { - readonly username: components["parameters"]["username"]; - }; + readonly username: components['parameters']['username'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["event"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['event'][] + } + } + } + } /** Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user. */ - readonly "repos/list-for-user": { + readonly 'repos/list-for-user': { readonly parameters: { readonly path: { - readonly username: components["parameters"]["username"]; - }; + readonly username: components['parameters']['username'] + } readonly query: { /** Can be one of `all`, `owner`, `member`. */ - readonly type?: "all" | "owner" | "member"; + readonly type?: 'all' | 'owner' | 'member' /** Can be one of `created`, `updated`, `pushed`, `full_name`. */ - readonly sort?: "created" | "updated" | "pushed" | "full_name"; + readonly sort?: 'created' | 'updated' | 'pushed' | 'full_name' /** Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc` */ - readonly direction?: "asc" | "desc"; + readonly direction?: 'asc' | 'desc' /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["minimal-repository"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['minimal-repository'][] + } + } + } + } /** * Gets the summary of the free and paid GitHub Actions minutes used. * @@ -42222,21 +42183,21 @@ export interface operations { * * Access tokens must have the `user` scope. */ - readonly "billing/get-github-actions-billing-user": { + readonly 'billing/get-github-actions-billing-user': { readonly parameters: { readonly path: { - readonly username: components["parameters"]["username"]; - }; - }; + readonly username: components['parameters']['username'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["actions-billing-usage"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['actions-billing-usage'] + } + } + } + } /** * Gets the free and paid storage used for GitHub Packages in gigabytes. * @@ -42244,21 +42205,21 @@ export interface operations { * * Access tokens must have the `user` scope. */ - readonly "billing/get-github-packages-billing-user": { + readonly 'billing/get-github-packages-billing-user': { readonly parameters: { readonly path: { - readonly username: components["parameters"]["username"]; - }; - }; + readonly username: components['parameters']['username'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["packages-billing-usage"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['packages-billing-usage'] + } + } + } + } /** * Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. * @@ -42266,87 +42227,87 @@ export interface operations { * * Access tokens must have the `user` scope. */ - readonly "billing/get-shared-storage-billing-user": { + readonly 'billing/get-shared-storage-billing-user': { readonly parameters: { readonly path: { - readonly username: components["parameters"]["username"]; - }; - }; + readonly username: components['parameters']['username'] + } + } readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["combined-billing-usage"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['combined-billing-usage'] + } + } + } + } /** * Lists repositories a user has starred. * * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: */ - readonly "activity/list-repos-starred-by-user": { + readonly 'activity/list-repos-starred-by-user': { readonly parameters: { readonly path: { - readonly username: components["parameters"]["username"]; - }; + readonly username: components['parameters']['username'] + } readonly query: { /** One of `created` (when the repository was starred) or `updated` (when it was last pushed to). */ - readonly sort?: components["parameters"]["sort"]; + readonly sort?: components['parameters']['sort'] /** One of `asc` (ascending) or `desc` (descending). */ - readonly direction?: components["parameters"]["direction"]; + readonly direction?: components['parameters']['direction'] /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": Partial & - Partial; - }; - }; - }; - }; + readonly 'application/json': Partial & + Partial + } + } + } + } /** Lists repositories a user is watching. */ - readonly "activity/list-repos-watched-by-user": { + readonly 'activity/list-repos-watched-by-user': { readonly parameters: { readonly path: { - readonly username: components["parameters"]["username"]; - }; + readonly username: components['parameters']['username'] + } readonly query: { /** Results per page (max 100) */ - readonly per_page?: components["parameters"]["per-page"]; + readonly per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - }; + readonly page?: components['parameters']['page'] + } + } readonly responses: { /** Response */ readonly 200: { - readonly headers: {}; + readonly headers: {} readonly content: { - readonly "application/json": readonly components["schemas"]["minimal-repository"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['minimal-repository'][] + } + } + } + } /** Get a random sentence from the Zen of GitHub */ - readonly "meta/get-zen": { + readonly 'meta/get-zen': { readonly responses: { /** Response */ readonly 200: { readonly content: { - readonly "text/plain": string; - }; - }; - }; - }; + readonly 'text/plain': string + } + } + } + } } export interface external {} diff --git a/test/v3/expected/github.support-array-length.ts b/test/v3/expected/github.support-array-length.ts index 5940587ad..61cc1f438 100644 --- a/test/v3/expected/github.support-array-length.ts +++ b/test/v3/expected/github.support-array-length.ts @@ -4,152 +4,152 @@ */ export interface paths { - "/": { + '/': { /** Get Hypermedia links to resources accessible in GitHub's REST API */ - get: operations["meta/root"]; - }; - "/app": { + get: operations['meta/root'] + } + '/app': { /** * Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/rest/reference/apps#list-installations-for-the-authenticated-app)" endpoint. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - get: operations["apps/get-authenticated"]; - }; - "/app-manifests/{code}/conversions": { + get: operations['apps/get-authenticated'] + } + '/app-manifests/{code}/conversions': { /** Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. */ - post: operations["apps/create-from-manifest"]; - }; - "/app/hook/config": { + post: operations['apps/create-from-manifest'] + } + '/app/hook/config': { /** * Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - get: operations["apps/get-webhook-config-for-app"]; + get: operations['apps/get-webhook-config-for-app'] /** * Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - patch: operations["apps/update-webhook-config-for-app"]; - }; - "/app/hook/deliveries": { + patch: operations['apps/update-webhook-config-for-app'] + } + '/app/hook/deliveries': { /** * Returns a list of webhook deliveries for the webhook configured for a GitHub App. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - get: operations["apps/list-webhook-deliveries"]; - }; - "/app/hook/deliveries/{delivery_id}": { + get: operations['apps/list-webhook-deliveries'] + } + '/app/hook/deliveries/{delivery_id}': { /** * Returns a delivery for the webhook configured for a GitHub App. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - get: operations["apps/get-webhook-delivery"]; - }; - "/app/hook/deliveries/{delivery_id}/attempts": { + get: operations['apps/get-webhook-delivery'] + } + '/app/hook/deliveries/{delivery_id}/attempts': { /** * Redeliver a delivery for the webhook configured for a GitHub App. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - post: operations["apps/redeliver-webhook-delivery"]; - }; - "/app/installations": { + post: operations['apps/redeliver-webhook-delivery'] + } + '/app/installations': { /** * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. * * The permissions the installation has are included under the `permissions` key. */ - get: operations["apps/list-installations"]; - }; - "/app/installations/{installation_id}": { + get: operations['apps/list-installations'] + } + '/app/installations/{installation_id}': { /** * Enables an authenticated GitHub App to find an installation's information using the installation id. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - get: operations["apps/get-installation"]; + get: operations['apps/get-installation'] /** * Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/reference/apps/#suspend-an-app-installation)" endpoint. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - delete: operations["apps/delete-installation"]; - }; - "/app/installations/{installation_id}/access_tokens": { + delete: operations['apps/delete-installation'] + } + '/app/installations/{installation_id}/access_tokens': { /** * Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - post: operations["apps/create-installation-access-token"]; - }; - "/app/installations/{installation_id}/suspended": { + post: operations['apps/create-installation-access-token'] + } + '/app/installations/{installation_id}/suspended': { /** * Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - put: operations["apps/suspend-installation"]; + put: operations['apps/suspend-installation'] /** * Removes a GitHub App installation suspension. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - delete: operations["apps/unsuspend-installation"]; - }; - "/applications/grants": { + delete: operations['apps/unsuspend-installation'] + } + '/applications/grants': { /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * * You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/rest/reference/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `["repo", "user"]`. */ - get: operations["oauth-authorizations/list-grants"]; - }; - "/applications/grants/{grant_id}": { + get: operations['oauth-authorizations/list-grants'] + } + '/applications/grants/{grant_id}': { /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - get: operations["oauth-authorizations/get-grant"]; + get: operations['oauth-authorizations/get-grant'] /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ - delete: operations["oauth-authorizations/delete-grant"]; - }; - "/applications/{client_id}/grant": { + delete: operations['oauth-authorizations/delete-grant'] + } + '/applications/{client_id}/grant': { /** * OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ - delete: operations["apps/delete-authorization"]; - }; - "/applications/{client_id}/token": { + delete: operations['apps/delete-authorization'] + } + '/applications/{client_id}/token': { /** OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the OAuth application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`. */ - post: operations["apps/check-token"]; + post: operations['apps/check-token'] /** OAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. */ - delete: operations["apps/delete-token"]; + delete: operations['apps/delete-token'] /** OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. */ - patch: operations["apps/reset-token"]; - }; - "/applications/{client_id}/token/scoped": { + patch: operations['apps/reset-token'] + } + '/applications/{client_id}/token/scoped': { /** Use a non-scoped user-to-server OAuth access token to create a repository scoped and/or permission scoped user-to-server OAuth access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. */ - post: operations["apps/scope-token"]; - }; - "/apps/{app_slug}": { + post: operations['apps/scope-token'] + } + '/apps/{app_slug}': { /** * **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). * * If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ - get: operations["apps/get-by-slug"]; - }; - "/authorizations": { + get: operations['apps/get-by-slug'] + } + '/authorizations': { /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - get: operations["oauth-authorizations/list-authorizations"]; + get: operations['oauth-authorizations/list-authorizations'] /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * @@ -163,9 +163,9 @@ export interface paths { * * Organizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in [the GitHub Help documentation](https://docs.github.com/articles/about-identity-and-access-management-with-saml-single-sign-on). */ - post: operations["oauth-authorizations/create-authorization"]; - }; - "/authorizations/clients/{client_id}": { + post: operations['oauth-authorizations/create-authorization'] + } + '/authorizations/clients/{client_id}': { /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * @@ -177,9 +177,9 @@ export interface paths { * * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - put: operations["oauth-authorizations/get-or-create-authorization-for-app"]; - }; - "/authorizations/clients/{client_id}/{fingerprint}": { + put: operations['oauth-authorizations/get-or-create-authorization-for-app'] + } + '/authorizations/clients/{client_id}/{fingerprint}': { /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * @@ -189,13 +189,13 @@ export interface paths { * * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." */ - put: operations["oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint"]; - }; - "/authorizations/{authorization_id}": { + put: operations['oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint'] + } + '/authorizations/{authorization_id}': { /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - get: operations["oauth-authorizations/get-authorization"]; + get: operations['oauth-authorizations/get-authorization'] /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - delete: operations["oauth-authorizations/delete-authorization"]; + delete: operations['oauth-authorizations/delete-authorization'] /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * @@ -203,182 +203,182 @@ export interface paths { * * You can only send one of these scope keys at a time. */ - patch: operations["oauth-authorizations/update-authorization"]; - }; - "/codes_of_conduct": { - get: operations["codes-of-conduct/get-all-codes-of-conduct"]; - }; - "/codes_of_conduct/{key}": { - get: operations["codes-of-conduct/get-conduct-code"]; - }; - "/emojis": { + patch: operations['oauth-authorizations/update-authorization'] + } + '/codes_of_conduct': { + get: operations['codes-of-conduct/get-all-codes-of-conduct'] + } + '/codes_of_conduct/{key}': { + get: operations['codes-of-conduct/get-conduct-code'] + } + '/emojis': { /** Lists all the emojis available to use on GitHub. */ - get: operations["emojis/get"]; - }; - "/enterprises/{enterprise}/actions/permissions": { + get: operations['emojis/get'] + } + '/enterprises/{enterprise}/actions/permissions': { /** * Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - get: operations["enterprise-admin/get-github-actions-permissions-enterprise"]; + get: operations['enterprise-admin/get-github-actions-permissions-enterprise'] /** * Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - put: operations["enterprise-admin/set-github-actions-permissions-enterprise"]; - }; - "/enterprises/{enterprise}/actions/permissions/organizations": { + put: operations['enterprise-admin/set-github-actions-permissions-enterprise'] + } + '/enterprises/{enterprise}/actions/permissions/organizations': { /** * Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - get: operations["enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise"]; + get: operations['enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise'] /** * Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - put: operations["enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise"]; - }; - "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}": { + put: operations['enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise'] + } + '/enterprises/{enterprise}/actions/permissions/organizations/{org_id}': { /** * Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - put: operations["enterprise-admin/enable-selected-organization-github-actions-enterprise"]; + put: operations['enterprise-admin/enable-selected-organization-github-actions-enterprise'] /** * Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - delete: operations["enterprise-admin/disable-selected-organization-github-actions-enterprise"]; - }; - "/enterprises/{enterprise}/actions/permissions/selected-actions": { + delete: operations['enterprise-admin/disable-selected-organization-github-actions-enterprise'] + } + '/enterprises/{enterprise}/actions/permissions/selected-actions': { /** * Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - get: operations["enterprise-admin/get-allowed-actions-enterprise"]; + get: operations['enterprise-admin/get-allowed-actions-enterprise'] /** * Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - put: operations["enterprise-admin/set-allowed-actions-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runner-groups": { + put: operations['enterprise-admin/set-allowed-actions-enterprise'] + } + '/enterprises/{enterprise}/actions/runner-groups': { /** * Lists all self-hosted runner groups for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - get: operations["enterprise-admin/list-self-hosted-runner-groups-for-enterprise"]; + get: operations['enterprise-admin/list-self-hosted-runner-groups-for-enterprise'] /** * Creates a new self-hosted runner group for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - post: operations["enterprise-admin/create-self-hosted-runner-group-for-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}": { + post: operations['enterprise-admin/create-self-hosted-runner-group-for-enterprise'] + } + '/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}': { /** * Gets a specific self-hosted runner group for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - get: operations["enterprise-admin/get-self-hosted-runner-group-for-enterprise"]; + get: operations['enterprise-admin/get-self-hosted-runner-group-for-enterprise'] /** * Deletes a self-hosted runner group for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - delete: operations["enterprise-admin/delete-self-hosted-runner-group-from-enterprise"]; + delete: operations['enterprise-admin/delete-self-hosted-runner-group-from-enterprise'] /** * Updates the `name` and `visibility` of a self-hosted runner group in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - patch: operations["enterprise-admin/update-self-hosted-runner-group-for-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations": { + patch: operations['enterprise-admin/update-self-hosted-runner-group-for-enterprise'] + } + '/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations': { /** * Lists the organizations with access to a self-hosted runner group. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - get: operations["enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise"]; + get: operations['enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise'] /** * Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - put: operations["enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}": { + put: operations['enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise'] + } + '/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}': { /** * Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - put: operations["enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise"]; + put: operations['enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise'] /** * Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - delete: operations["enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": { + delete: operations['enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise'] + } + '/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners': { /** * Lists the self-hosted runners that are in a specific enterprise group. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - get: operations["enterprise-admin/list-self-hosted-runners-in-group-for-enterprise"]; + get: operations['enterprise-admin/list-self-hosted-runners-in-group-for-enterprise'] /** * Replaces the list of self-hosted runners that are part of an enterprise runner group. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - put: operations["enterprise-admin/set-self-hosted-runners-in-group-for-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + put: operations['enterprise-admin/set-self-hosted-runners-in-group-for-enterprise'] + } + '/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}': { /** * Adds a self-hosted runner to a runner group configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` * scope to use this endpoint. */ - put: operations["enterprise-admin/add-self-hosted-runner-to-group-for-enterprise"]; + put: operations['enterprise-admin/add-self-hosted-runner-to-group-for-enterprise'] /** * Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - delete: operations["enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runners": { + delete: operations['enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise'] + } + '/enterprises/{enterprise}/actions/runners': { /** * Lists all self-hosted runners configured for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - get: operations["enterprise-admin/list-self-hosted-runners-for-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runners/downloads": { + get: operations['enterprise-admin/list-self-hosted-runners-for-enterprise'] + } + '/enterprises/{enterprise}/actions/runners/downloads': { /** * Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - get: operations["enterprise-admin/list-runner-applications-for-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runners/registration-token": { + get: operations['enterprise-admin/list-runner-applications-for-enterprise'] + } + '/enterprises/{enterprise}/actions/runners/registration-token': { /** * Returns a token that you can pass to the `config` script. The token expires after one hour. * @@ -392,9 +392,9 @@ export interface paths { * ./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN * ``` */ - post: operations["enterprise-admin/create-registration-token-for-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runners/remove-token": { + post: operations['enterprise-admin/create-registration-token-for-enterprise'] + } + '/enterprises/{enterprise}/actions/runners/remove-token': { /** * Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour. * @@ -409,51 +409,51 @@ export interface paths { * ./config.sh remove --token TOKEN * ``` */ - post: operations["enterprise-admin/create-remove-token-for-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runners/{runner_id}": { + post: operations['enterprise-admin/create-remove-token-for-enterprise'] + } + '/enterprises/{enterprise}/actions/runners/{runner_id}': { /** * Gets a specific self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - get: operations["enterprise-admin/get-self-hosted-runner-for-enterprise"]; + get: operations['enterprise-admin/get-self-hosted-runner-for-enterprise'] /** * Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - delete: operations["enterprise-admin/delete-self-hosted-runner-from-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runners/{runner_id}/labels": { + delete: operations['enterprise-admin/delete-self-hosted-runner-from-enterprise'] + } + '/enterprises/{enterprise}/actions/runners/{runner_id}/labels': { /** * Lists all labels for a self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - get: operations["enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise"]; + get: operations['enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise'] /** * Remove all previous custom labels and set the new custom labels for a specific * self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - put: operations["enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise"]; + put: operations['enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise'] /** * Add custom labels to a self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - post: operations["enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise"]; + post: operations['enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise'] /** * Remove all custom labels from a self-hosted runner configured in an * enterprise. Returns the remaining read-only labels from the runner. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - delete: operations["enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runners/{runner_id}/labels/{name}": { + delete: operations['enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise'] + } + '/enterprises/{enterprise}/actions/runners/{runner_id}/labels/{name}': { /** * Remove a custom label from a self-hosted runner configured * in an enterprise. Returns the remaining labels from the runner. @@ -463,20 +463,20 @@ export interface paths { * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - delete: operations["enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise"]; - }; - "/enterprises/{enterprise}/audit-log": { + delete: operations['enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise'] + } + '/enterprises/{enterprise}/audit-log': { /** Gets the audit log for an enterprise. To use this endpoint, you must be an enterprise admin, and you must use an access token with the `admin:enterprise` scope. */ - get: operations["enterprise-admin/get-audit-log"]; - }; - "/enterprises/{enterprise}/secret-scanning/alerts": { + get: operations['enterprise-admin/get-audit-log'] + } + '/enterprises/{enterprise}/secret-scanning/alerts': { /** * Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. * To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). */ - get: operations["secret-scanning/list-alerts-for-enterprise"]; - }; - "/enterprises/{enterprise}/settings/billing/actions": { + get: operations['secret-scanning/list-alerts-for-enterprise'] + } + '/enterprises/{enterprise}/settings/billing/actions': { /** * Gets the summary of the free and paid GitHub Actions minutes used. * @@ -484,16 +484,16 @@ export interface paths { * * The authenticated user must be an enterprise admin. */ - get: operations["billing/get-github-actions-billing-ghe"]; - }; - "/enterprises/{enterprise}/settings/billing/advanced-security": { + get: operations['billing/get-github-actions-billing-ghe'] + } + '/enterprises/{enterprise}/settings/billing/advanced-security': { /** * Gets the GitHub Advanced Security active committers for an enterprise per repository. * Each distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of active_users for each repository. */ - get: operations["billing/get-github-advanced-security-billing-ghe"]; - }; - "/enterprises/{enterprise}/settings/billing/packages": { + get: operations['billing/get-github-advanced-security-billing-ghe'] + } + '/enterprises/{enterprise}/settings/billing/packages': { /** * Gets the free and paid storage used for GitHub Packages in gigabytes. * @@ -501,9 +501,9 @@ export interface paths { * * The authenticated user must be an enterprise admin. */ - get: operations["billing/get-github-packages-billing-ghe"]; - }; - "/enterprises/{enterprise}/settings/billing/shared-storage": { + get: operations['billing/get-github-packages-billing-ghe'] + } + '/enterprises/{enterprise}/settings/billing/shared-storage': { /** * Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. * @@ -511,13 +511,13 @@ export interface paths { * * The authenticated user must be an enterprise admin. */ - get: operations["billing/get-shared-storage-billing-ghe"]; - }; - "/events": { + get: operations['billing/get-shared-storage-billing-ghe'] + } + '/events': { /** We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. */ - get: operations["activity/list-public-events"]; - }; - "/feeds": { + get: operations['activity/list-public-events'] + } + '/feeds': { /** * GitHub provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user: * @@ -531,82 +531,82 @@ export interface paths { * * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ - get: operations["activity/get-feeds"]; - }; - "/gists": { + get: operations['activity/get-feeds'] + } + '/gists': { /** Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists: */ - get: operations["gists/list"]; + get: operations['gists/list'] /** * Allows you to add a new gist with one or more files. * * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. */ - post: operations["gists/create"]; - }; - "/gists/public": { + post: operations['gists/create'] + } + '/gists/public': { /** * List public gists sorted by most recently updated to least recently updated. * * Note: With [pagination](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. */ - get: operations["gists/list-public"]; - }; - "/gists/starred": { + get: operations['gists/list-public'] + } + '/gists/starred': { /** List the authenticated user's starred gists: */ - get: operations["gists/list-starred"]; - }; - "/gists/{gist_id}": { - get: operations["gists/get"]; - delete: operations["gists/delete"]; + get: operations['gists/list-starred'] + } + '/gists/{gist_id}': { + get: operations['gists/get'] + delete: operations['gists/delete'] /** Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged. */ - patch: operations["gists/update"]; - }; - "/gists/{gist_id}/comments": { - get: operations["gists/list-comments"]; - post: operations["gists/create-comment"]; - }; - "/gists/{gist_id}/comments/{comment_id}": { - get: operations["gists/get-comment"]; - delete: operations["gists/delete-comment"]; - patch: operations["gists/update-comment"]; - }; - "/gists/{gist_id}/commits": { - get: operations["gists/list-commits"]; - }; - "/gists/{gist_id}/forks": { - get: operations["gists/list-forks"]; + patch: operations['gists/update'] + } + '/gists/{gist_id}/comments': { + get: operations['gists/list-comments'] + post: operations['gists/create-comment'] + } + '/gists/{gist_id}/comments/{comment_id}': { + get: operations['gists/get-comment'] + delete: operations['gists/delete-comment'] + patch: operations['gists/update-comment'] + } + '/gists/{gist_id}/commits': { + get: operations['gists/list-commits'] + } + '/gists/{gist_id}/forks': { + get: operations['gists/list-forks'] /** **Note**: This was previously `/gists/:gist_id/fork`. */ - post: operations["gists/fork"]; - }; - "/gists/{gist_id}/star": { - get: operations["gists/check-is-starred"]; + post: operations['gists/fork'] + } + '/gists/{gist_id}/star': { + get: operations['gists/check-is-starred'] /** Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - put: operations["gists/star"]; - delete: operations["gists/unstar"]; - }; - "/gists/{gist_id}/{sha}": { - get: operations["gists/get-revision"]; - }; - "/gitignore/templates": { + put: operations['gists/star'] + delete: operations['gists/unstar'] + } + '/gists/{gist_id}/{sha}': { + get: operations['gists/get-revision'] + } + '/gitignore/templates': { /** List all templates available to pass as an option when [creating a repository](https://docs.github.com/rest/reference/repos#create-a-repository-for-the-authenticated-user). */ - get: operations["gitignore/get-all-templates"]; - }; - "/gitignore/templates/{name}": { + get: operations['gitignore/get-all-templates'] + } + '/gitignore/templates/{name}': { /** * The API also allows fetching the source of a single template. * Use the raw [media type](https://docs.github.com/rest/overview/media-types/) to get the raw contents. */ - get: operations["gitignore/get-template"]; - }; - "/installation/repositories": { + get: operations['gitignore/get-template'] + } + '/installation/repositories': { /** * List repositories that an app installation can access. * * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ - get: operations["apps/list-repos-accessible-to-installation"]; - }; - "/installation/token": { + get: operations['apps/list-repos-accessible-to-installation'] + } + '/installation/token': { /** * Revokes the installation token you're using to authenticate as an installation and access this endpoint. * @@ -614,9 +614,9 @@ export interface paths { * * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ - delete: operations["apps/revoke-installation-access-token"]; - }; - "/issues": { + delete: operations['apps/revoke-installation-access-token'] + } + '/issues': { /** * List issues assigned to the authenticated user across all visible repositories including owned repositories, member * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not @@ -628,97 +628,97 @@ export interface paths { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - get: operations["issues/list"]; - }; - "/licenses": { - get: operations["licenses/get-all-commonly-used"]; - }; - "/licenses/{license}": { - get: operations["licenses/get"]; - }; - "/markdown": { - post: operations["markdown/render"]; - }; - "/markdown/raw": { + get: operations['issues/list'] + } + '/licenses': { + get: operations['licenses/get-all-commonly-used'] + } + '/licenses/{license}': { + get: operations['licenses/get'] + } + '/markdown': { + post: operations['markdown/render'] + } + '/markdown/raw': { /** You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less. */ - post: operations["markdown/render-raw"]; - }; - "/marketplace_listing/accounts/{account_id}": { + post: operations['markdown/render-raw'] + } + '/marketplace_listing/accounts/{account_id}': { /** * Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - get: operations["apps/get-subscription-plan-for-account"]; - }; - "/marketplace_listing/plans": { + get: operations['apps/get-subscription-plan-for-account'] + } + '/marketplace_listing/plans': { /** * Lists all plans that are part of your GitHub Marketplace listing. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - get: operations["apps/list-plans"]; - }; - "/marketplace_listing/plans/{plan_id}/accounts": { + get: operations['apps/list-plans'] + } + '/marketplace_listing/plans/{plan_id}/accounts': { /** * Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - get: operations["apps/list-accounts-for-plan"]; - }; - "/marketplace_listing/stubbed/accounts/{account_id}": { + get: operations['apps/list-accounts-for-plan'] + } + '/marketplace_listing/stubbed/accounts/{account_id}': { /** * Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - get: operations["apps/get-subscription-plan-for-account-stubbed"]; - }; - "/marketplace_listing/stubbed/plans": { + get: operations['apps/get-subscription-plan-for-account-stubbed'] + } + '/marketplace_listing/stubbed/plans': { /** * Lists all plans that are part of your GitHub Marketplace listing. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - get: operations["apps/list-plans-stubbed"]; - }; - "/marketplace_listing/stubbed/plans/{plan_id}/accounts": { + get: operations['apps/list-plans-stubbed'] + } + '/marketplace_listing/stubbed/plans/{plan_id}/accounts': { /** * Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - get: operations["apps/list-accounts-for-plan-stubbed"]; - }; - "/meta": { + get: operations['apps/list-accounts-for-plan-stubbed'] + } + '/meta': { /** * Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://docs.github.com/articles/about-github-s-ip-addresses/)." * * **Note:** The IP addresses shown in the documentation's response are only example values. You must always query the API directly to get the latest list of IP addresses. */ - get: operations["meta/get"]; - }; - "/networks/{owner}/{repo}/events": { - get: operations["activity/list-public-events-for-repo-network"]; - }; - "/notifications": { + get: operations['meta/get'] + } + '/networks/{owner}/{repo}/events': { + get: operations['activity/list-public-events-for-repo-network'] + } + '/notifications': { /** List all notifications for the current user, sorted by most recently updated. */ - get: operations["activity/list-notifications-for-authenticated-user"]; + get: operations['activity/list-notifications-for-authenticated-user'] /** Marks all notifications as "read" removes it from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ - put: operations["activity/mark-notifications-as-read"]; - }; - "/notifications/threads/{thread_id}": { - get: operations["activity/get-thread"]; - patch: operations["activity/mark-thread-as-read"]; - }; - "/notifications/threads/{thread_id}/subscription": { + put: operations['activity/mark-notifications-as-read'] + } + '/notifications/threads/{thread_id}': { + get: operations['activity/get-thread'] + patch: operations['activity/mark-thread-as-read'] + } + '/notifications/threads/{thread_id}/subscription': { /** * This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/rest/reference/activity#get-a-repository-subscription). * * Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. */ - get: operations["activity/get-thread-subscription-for-authenticated-user"]; + get: operations['activity/get-thread-subscription-for-authenticated-user'] /** * If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**. * @@ -726,60 +726,60 @@ export interface paths { * * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/rest/reference/activity#delete-a-thread-subscription) endpoint. */ - put: operations["activity/set-thread-subscription"]; + put: operations['activity/set-thread-subscription'] /** Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/rest/reference/activity#set-a-thread-subscription) endpoint and set `ignore` to `true`. */ - delete: operations["activity/delete-thread-subscription"]; - }; - "/octocat": { + delete: operations['activity/delete-thread-subscription'] + } + '/octocat': { /** Get the octocat as ASCII art */ - get: operations["meta/get-octocat"]; - }; - "/organizations": { + get: operations['meta/get-octocat'] + } + '/organizations': { /** * Lists all organizations, in the order that they were created on GitHub. * * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of organizations. */ - get: operations["orgs/list"]; - }; - "/organizations/{organization_id}/custom_roles": { + get: operations['orgs/list'] + } + '/organizations/{organization_id}/custom_roles': { /** * List the custom repository roles available in this organization. In order to see custom * repository roles in an organization, the authenticated user must be an organization owner. * * For more information on custom repository roles, see "[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)". */ - get: operations["orgs/list-custom-roles"]; - }; - "/organizations/{org}/team/{team_slug}/external-groups": { + get: operations['orgs/list-custom-roles'] + } + '/organizations/{org}/team/{team_slug}/external-groups': { /** * Lists a connection between a team and an external group. * * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ - get: operations["teams/list-linked-external-idp-groups-to-team-for-org"]; - }; - "/orgs/{org}": { + get: operations['teams/list-linked-external-idp-groups-to-team-for-org'] + } + '/orgs/{org}': { /** * To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). * * GitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub plan. See "[Authenticating with GitHub Apps](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/)" for details. For an example response, see 'Response with GitHub plan information' below." */ - get: operations["orgs/get"]; + get: operations['orgs/get'] /** * **Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). * * Enables an authenticated organization owner with the `admin:org` scope to update the organization's profile and member privileges. */ - patch: operations["orgs/update"]; - }; - "/orgs/{org}/actions/permissions": { + patch: operations['orgs/update'] + } + '/orgs/{org}/actions/permissions': { /** * Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - get: operations["actions/get-github-actions-permissions-organization"]; + get: operations['actions/get-github-actions-permissions-organization'] /** * Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization. * @@ -787,43 +787,43 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - put: operations["actions/set-github-actions-permissions-organization"]; - }; - "/orgs/{org}/actions/permissions/repositories": { + put: operations['actions/set-github-actions-permissions-organization'] + } + '/orgs/{org}/actions/permissions/repositories': { /** * Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - get: operations["actions/list-selected-repositories-enabled-github-actions-organization"]; + get: operations['actions/list-selected-repositories-enabled-github-actions-organization'] /** * Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - put: operations["actions/set-selected-repositories-enabled-github-actions-organization"]; - }; - "/orgs/{org}/actions/permissions/repositories/{repository_id}": { + put: operations['actions/set-selected-repositories-enabled-github-actions-organization'] + } + '/orgs/{org}/actions/permissions/repositories/{repository_id}': { /** * Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - put: operations["actions/enable-selected-repository-github-actions-organization"]; + put: operations['actions/enable-selected-repository-github-actions-organization'] /** * Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - delete: operations["actions/disable-selected-repository-github-actions-organization"]; - }; - "/orgs/{org}/actions/permissions/selected-actions": { + delete: operations['actions/disable-selected-repository-github-actions-organization'] + } + '/orgs/{org}/actions/permissions/selected-actions': { /** * Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."" * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - get: operations["actions/get-allowed-actions-organization"]; + get: operations['actions/get-allowed-actions-organization'] /** * Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * @@ -833,25 +833,25 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - put: operations["actions/set-allowed-actions-organization"]; - }; - "/orgs/{org}/actions/permissions/workflow": { + put: operations['actions/set-allowed-actions-organization'] + } + '/orgs/{org}/actions/permissions/workflow': { /** * Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, * as well if GitHub Actions can submit approving pull request reviews. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - get: operations["actions/get-github-actions-default-workflow-permissions-organization"]; + get: operations['actions/get-github-actions-default-workflow-permissions-organization'] /** * Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions * can submit approving pull request reviews. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - put: operations["actions/set-github-actions-default-workflow-permissions-organization"]; - }; - "/orgs/{org}/actions/runner-groups": { + put: operations['actions/set-github-actions-default-workflow-permissions-organization'] + } + '/orgs/{org}/actions/runner-groups': { /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -859,7 +859,7 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - get: operations["actions/list-self-hosted-runner-groups-for-org"]; + get: operations['actions/list-self-hosted-runner-groups-for-org'] /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -867,9 +867,9 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - post: operations["actions/create-self-hosted-runner-group-for-org"]; - }; - "/orgs/{org}/actions/runner-groups/{runner_group_id}": { + post: operations['actions/create-self-hosted-runner-group-for-org'] + } + '/orgs/{org}/actions/runner-groups/{runner_group_id}': { /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -877,7 +877,7 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - get: operations["actions/get-self-hosted-runner-group-for-org"]; + get: operations['actions/get-self-hosted-runner-group-for-org'] /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -885,7 +885,7 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - delete: operations["actions/delete-self-hosted-runner-group-from-org"]; + delete: operations['actions/delete-self-hosted-runner-group-from-org'] /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -893,9 +893,9 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - patch: operations["actions/update-self-hosted-runner-group-for-org"]; - }; - "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": { + patch: operations['actions/update-self-hosted-runner-group-for-org'] + } + '/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories': { /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -903,7 +903,7 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - get: operations["actions/list-repo-access-to-self-hosted-runner-group-in-org"]; + get: operations['actions/list-repo-access-to-self-hosted-runner-group-in-org'] /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -911,9 +911,9 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - put: operations["actions/set-repo-access-to-self-hosted-runner-group-in-org"]; - }; - "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": { + put: operations['actions/set-repo-access-to-self-hosted-runner-group-in-org'] + } + '/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}': { /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -923,7 +923,7 @@ export interface paths { * You must authenticate using an access token with the `admin:org` * scope to use this endpoint. */ - put: operations["actions/add-repo-access-to-self-hosted-runner-group-in-org"]; + put: operations['actions/add-repo-access-to-self-hosted-runner-group-in-org'] /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -932,9 +932,9 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - delete: operations["actions/remove-repo-access-to-self-hosted-runner-group-in-org"]; - }; - "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners": { + delete: operations['actions/remove-repo-access-to-self-hosted-runner-group-in-org'] + } + '/orgs/{org}/actions/runner-groups/{runner_group_id}/runners': { /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -942,7 +942,7 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - get: operations["actions/list-self-hosted-runners-in-group-for-org"]; + get: operations['actions/list-self-hosted-runners-in-group-for-org'] /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -950,9 +950,9 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - put: operations["actions/set-self-hosted-runners-in-group-for-org"]; - }; - "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + put: operations['actions/set-self-hosted-runners-in-group-for-org'] + } + '/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}': { /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -962,7 +962,7 @@ export interface paths { * You must authenticate using an access token with the `admin:org` * scope to use this endpoint. */ - put: operations["actions/add-self-hosted-runner-to-group-for-org"]; + put: operations['actions/add-self-hosted-runner-to-group-for-org'] /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -971,25 +971,25 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - delete: operations["actions/remove-self-hosted-runner-from-group-for-org"]; - }; - "/orgs/{org}/actions/runners": { + delete: operations['actions/remove-self-hosted-runner-from-group-for-org'] + } + '/orgs/{org}/actions/runners': { /** * Lists all self-hosted runners configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - get: operations["actions/list-self-hosted-runners-for-org"]; - }; - "/orgs/{org}/actions/runners/downloads": { + get: operations['actions/list-self-hosted-runners-for-org'] + } + '/orgs/{org}/actions/runners/downloads': { /** * Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - get: operations["actions/list-runner-applications-for-org"]; - }; - "/orgs/{org}/actions/runners/registration-token": { + get: operations['actions/list-runner-applications-for-org'] + } + '/orgs/{org}/actions/runners/registration-token': { /** * Returns a token that you can pass to the `config` script. The token expires after one hour. * @@ -1003,9 +1003,9 @@ export interface paths { * ./config.sh --url https://github.com/octo-org --token TOKEN * ``` */ - post: operations["actions/create-registration-token-for-org"]; - }; - "/orgs/{org}/actions/runners/remove-token": { + post: operations['actions/create-registration-token-for-org'] + } + '/orgs/{org}/actions/runners/remove-token': { /** * Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour. * @@ -1020,51 +1020,51 @@ export interface paths { * ./config.sh remove --token TOKEN * ``` */ - post: operations["actions/create-remove-token-for-org"]; - }; - "/orgs/{org}/actions/runners/{runner_id}": { + post: operations['actions/create-remove-token-for-org'] + } + '/orgs/{org}/actions/runners/{runner_id}': { /** * Gets a specific self-hosted runner configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - get: operations["actions/get-self-hosted-runner-for-org"]; + get: operations['actions/get-self-hosted-runner-for-org'] /** * Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - delete: operations["actions/delete-self-hosted-runner-from-org"]; - }; - "/orgs/{org}/actions/runners/{runner_id}/labels": { + delete: operations['actions/delete-self-hosted-runner-from-org'] + } + '/orgs/{org}/actions/runners/{runner_id}/labels': { /** * Lists all labels for a self-hosted runner configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - get: operations["actions/list-labels-for-self-hosted-runner-for-org"]; + get: operations['actions/list-labels-for-self-hosted-runner-for-org'] /** * Remove all previous custom labels and set the new custom labels for a specific * self-hosted runner configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - put: operations["actions/set-custom-labels-for-self-hosted-runner-for-org"]; + put: operations['actions/set-custom-labels-for-self-hosted-runner-for-org'] /** * Add custom labels to a self-hosted runner configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - post: operations["actions/add-custom-labels-to-self-hosted-runner-for-org"]; + post: operations['actions/add-custom-labels-to-self-hosted-runner-for-org'] /** * Remove all custom labels from a self-hosted runner configured in an * organization. Returns the remaining read-only labels from the runner. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - delete: operations["actions/remove-all-custom-labels-from-self-hosted-runner-for-org"]; - }; - "/orgs/{org}/actions/runners/{runner_id}/labels/{name}": { + delete: operations['actions/remove-all-custom-labels-from-self-hosted-runner-for-org'] + } + '/orgs/{org}/actions/runners/{runner_id}/labels/{name}': { /** * Remove a custom label from a self-hosted runner configured * in an organization. Returns the remaining labels from the runner. @@ -1074,19 +1074,19 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - delete: operations["actions/remove-custom-label-from-self-hosted-runner-for-org"]; - }; - "/orgs/{org}/actions/secrets": { + delete: operations['actions/remove-custom-label-from-self-hosted-runner-for-org'] + } + '/orgs/{org}/actions/secrets': { /** Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - get: operations["actions/list-org-secrets"]; - }; - "/orgs/{org}/actions/secrets/public-key": { + get: operations['actions/list-org-secrets'] + } + '/orgs/{org}/actions/secrets/public-key': { /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - get: operations["actions/get-org-public-key"]; - }; - "/orgs/{org}/actions/secrets/{secret_name}": { + get: operations['actions/get-org-public-key'] + } + '/orgs/{org}/actions/secrets/{secret_name}': { /** Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - get: operations["actions/get-org-secret"]; + get: operations['actions/get-org-secret'] /** * Creates or updates an organization secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -1164,40 +1164,40 @@ export interface paths { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - put: operations["actions/create-or-update-org-secret"]; + put: operations['actions/create-or-update-org-secret'] /** Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - delete: operations["actions/delete-org-secret"]; - }; - "/orgs/{org}/actions/secrets/{secret_name}/repositories": { + delete: operations['actions/delete-org-secret'] + } + '/orgs/{org}/actions/secrets/{secret_name}/repositories': { /** Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - get: operations["actions/list-selected-repos-for-org-secret"]; + get: operations['actions/list-selected-repos-for-org-secret'] /** Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - put: operations["actions/set-selected-repos-for-org-secret"]; - }; - "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}": { + put: operations['actions/set-selected-repos-for-org-secret'] + } + '/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}': { /** Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - put: operations["actions/add-selected-repo-to-org-secret"]; + put: operations['actions/add-selected-repo-to-org-secret'] /** Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - delete: operations["actions/remove-selected-repo-from-org-secret"]; - }; - "/orgs/{org}/audit-log": { + delete: operations['actions/remove-selected-repo-from-org-secret'] + } + '/orgs/{org}/audit-log': { /** * Gets the audit log for an organization. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization)." * * This endpoint is available for organizations on GitHub Enterprise Cloud. To use this endpoint, you must be an organization owner, and you must use an access token with the `admin:org` scope. GitHub Apps must have the `organization_administration` read permission to use this endpoint. */ - get: operations["orgs/get-audit-log"]; - }; - "/orgs/{org}/blocks": { + get: operations['orgs/get-audit-log'] + } + '/orgs/{org}/blocks': { /** List the users blocked by an organization. */ - get: operations["orgs/list-blocked-users"]; - }; - "/orgs/{org}/blocks/{username}": { - get: operations["orgs/check-blocked-user"]; - put: operations["orgs/block-user"]; - delete: operations["orgs/unblock-user"]; - }; - "/orgs/{org}/code-scanning/alerts": { + get: operations['orgs/list-blocked-users'] + } + '/orgs/{org}/blocks/{username}': { + get: operations['orgs/check-blocked-user'] + put: operations['orgs/block-user'] + delete: operations['orgs/unblock-user'] + } + '/orgs/{org}/code-scanning/alerts': { /** * Lists all code scanning alerts for the default branch (usually `main` * or `master`) for all eligible repositories in an organization. @@ -1205,35 +1205,35 @@ export interface paths { * * GitHub Apps must have the `security_events` read permission to use this endpoint. */ - get: operations["code-scanning/list-alerts-for-org"]; - }; - "/orgs/{org}/credential-authorizations": { + get: operations['code-scanning/list-alerts-for-org'] + } + '/orgs/{org}/credential-authorizations': { /** * Listing and deleting credential authorizations is available to organizations with GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products). * * An authenticated organization owner with the `read:org` scope can list all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials are either personal access tokens or SSH keys that organization members have authorized for the organization. For more information, see [About authentication with SAML single sign-on](https://docs.github.com/en/articles/about-authentication-with-saml-single-sign-on). */ - get: operations["orgs/list-saml-sso-authorizations"]; - }; - "/orgs/{org}/credential-authorizations/{credential_id}": { + get: operations['orgs/list-saml-sso-authorizations'] + } + '/orgs/{org}/credential-authorizations/{credential_id}': { /** * Listing and deleting credential authorizations is available to organizations with GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products). * * An authenticated organization owner with the `admin:org` scope can remove a credential authorization for an organization that uses SAML SSO. Once you remove someone's credential authorization, they will need to create a new personal access token or SSH key and authorize it for the organization they want to access. */ - delete: operations["orgs/remove-saml-sso-authorization"]; - }; - "/orgs/{org}/dependabot/secrets": { + delete: operations['orgs/remove-saml-sso-authorization'] + } + '/orgs/{org}/dependabot/secrets': { /** Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - get: operations["dependabot/list-org-secrets"]; - }; - "/orgs/{org}/dependabot/secrets/public-key": { + get: operations['dependabot/list-org-secrets'] + } + '/orgs/{org}/dependabot/secrets/public-key': { /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - get: operations["dependabot/get-org-public-key"]; - }; - "/orgs/{org}/dependabot/secrets/{secret_name}": { + get: operations['dependabot/get-org-public-key'] + } + '/orgs/{org}/dependabot/secrets/{secret_name}': { /** Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - get: operations["dependabot/get-org-secret"]; + get: operations['dependabot/get-org-secret'] /** * Creates or updates an organization secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -1311,130 +1311,130 @@ export interface paths { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - put: operations["dependabot/create-or-update-org-secret"]; + put: operations['dependabot/create-or-update-org-secret'] /** Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - delete: operations["dependabot/delete-org-secret"]; - }; - "/orgs/{org}/dependabot/secrets/{secret_name}/repositories": { + delete: operations['dependabot/delete-org-secret'] + } + '/orgs/{org}/dependabot/secrets/{secret_name}/repositories': { /** Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - get: operations["dependabot/list-selected-repos-for-org-secret"]; + get: operations['dependabot/list-selected-repos-for-org-secret'] /** Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - put: operations["dependabot/set-selected-repos-for-org-secret"]; - }; - "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}": { + put: operations['dependabot/set-selected-repos-for-org-secret'] + } + '/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}': { /** Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - put: operations["dependabot/add-selected-repo-to-org-secret"]; + put: operations['dependabot/add-selected-repo-to-org-secret'] /** Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - delete: operations["dependabot/remove-selected-repo-from-org-secret"]; - }; - "/orgs/{org}/events": { - get: operations["activity/list-public-org-events"]; - }; - "/orgs/{org}/external-group/{group_id}": { + delete: operations['dependabot/remove-selected-repo-from-org-secret'] + } + '/orgs/{org}/events': { + get: operations['activity/list-public-org-events'] + } + '/orgs/{org}/external-group/{group_id}': { /** * Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to. * * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ - get: operations["teams/external-idp-group-info-for-org"]; - }; - "/orgs/{org}/external-groups": { + get: operations['teams/external-idp-group-info-for-org'] + } + '/orgs/{org}/external-groups': { /** * Lists external groups available in an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." * * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ - get: operations["teams/list-external-idp-groups-for-org"]; - }; - "/orgs/{org}/failed_invitations": { + get: operations['teams/list-external-idp-groups-for-org'] + } + '/orgs/{org}/failed_invitations': { /** The return hash contains `failed_at` and `failed_reason` fields which represent the time at which the invitation failed and the reason for the failure. */ - get: operations["orgs/list-failed-invitations"]; - }; - "/orgs/{org}/hooks": { - get: operations["orgs/list-webhooks"]; + get: operations['orgs/list-failed-invitations'] + } + '/orgs/{org}/hooks': { + get: operations['orgs/list-webhooks'] /** Here's how you can create a hook that posts payloads in JSON format: */ - post: operations["orgs/create-webhook"]; - }; - "/orgs/{org}/hooks/{hook_id}": { + post: operations['orgs/create-webhook'] + } + '/orgs/{org}/hooks/{hook_id}': { /** Returns a webhook configured in an organization. To get only the webhook `config` properties, see "[Get a webhook configuration for an organization](/rest/reference/orgs#get-a-webhook-configuration-for-an-organization)." */ - get: operations["orgs/get-webhook"]; - delete: operations["orgs/delete-webhook"]; + get: operations['orgs/get-webhook'] + delete: operations['orgs/delete-webhook'] /** Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for an organization](/rest/reference/orgs#update-a-webhook-configuration-for-an-organization)." */ - patch: operations["orgs/update-webhook"]; - }; - "/orgs/{org}/hooks/{hook_id}/config": { + patch: operations['orgs/update-webhook'] + } + '/orgs/{org}/hooks/{hook_id}/config': { /** * Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/reference/orgs#get-an-organization-webhook)." * * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission. */ - get: operations["orgs/get-webhook-config-for-org"]; + get: operations['orgs/get-webhook-config-for-org'] /** * Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/reference/orgs#update-an-organization-webhook)." * * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission. */ - patch: operations["orgs/update-webhook-config-for-org"]; - }; - "/orgs/{org}/hooks/{hook_id}/deliveries": { + patch: operations['orgs/update-webhook-config-for-org'] + } + '/orgs/{org}/hooks/{hook_id}/deliveries': { /** Returns a list of webhook deliveries for a webhook configured in an organization. */ - get: operations["orgs/list-webhook-deliveries"]; - }; - "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": { + get: operations['orgs/list-webhook-deliveries'] + } + '/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}': { /** Returns a delivery for a webhook configured in an organization. */ - get: operations["orgs/get-webhook-delivery"]; - }; - "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { + get: operations['orgs/get-webhook-delivery'] + } + '/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts': { /** Redeliver a delivery for a webhook configured in an organization. */ - post: operations["orgs/redeliver-webhook-delivery"]; - }; - "/orgs/{org}/hooks/{hook_id}/pings": { + post: operations['orgs/redeliver-webhook-delivery'] + } + '/orgs/{org}/hooks/{hook_id}/pings': { /** This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. */ - post: operations["orgs/ping-webhook"]; - }; - "/orgs/{org}/installation": { + post: operations['orgs/ping-webhook'] + } + '/orgs/{org}/installation': { /** * Enables an authenticated GitHub App to find the organization's installation information. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - get: operations["apps/get-org-installation"]; - }; - "/orgs/{org}/installations": { + get: operations['apps/get-org-installation'] + } + '/orgs/{org}/installations': { /** Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint. */ - get: operations["orgs/list-app-installations"]; - }; - "/orgs/{org}/interaction-limits": { + get: operations['orgs/list-app-installations'] + } + '/orgs/{org}/interaction-limits': { /** Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response. */ - get: operations["interactions/get-restrictions-for-org"]; + get: operations['interactions/get-restrictions-for-org'] /** Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization. */ - put: operations["interactions/set-restrictions-for-org"]; + put: operations['interactions/set-restrictions-for-org'] /** Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions. */ - delete: operations["interactions/remove-restrictions-for-org"]; - }; - "/orgs/{org}/invitations": { + delete: operations['interactions/remove-restrictions-for-org'] + } + '/orgs/{org}/invitations': { /** The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. */ - get: operations["orgs/list-pending-invitations"]; + get: operations['orgs/list-pending-invitations'] /** * Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - post: operations["orgs/create-invitation"]; - }; - "/orgs/{org}/invitations/{invitation_id}": { + post: operations['orgs/create-invitation'] + } + '/orgs/{org}/invitations/{invitation_id}': { /** * Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). */ - delete: operations["orgs/cancel-invitation"]; - }; - "/orgs/{org}/invitations/{invitation_id}/teams": { + delete: operations['orgs/cancel-invitation'] + } + '/orgs/{org}/invitations/{invitation_id}/teams': { /** List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner. */ - get: operations["orgs/list-invitation-teams"]; - }; - "/orgs/{org}/issues": { + get: operations['orgs/list-invitation-teams'] + } + '/orgs/{org}/issues': { /** * List issues in an organization assigned to the authenticated user. * @@ -1443,21 +1443,21 @@ export interface paths { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - get: operations["issues/list-for-org"]; - }; - "/orgs/{org}/members": { + get: operations['issues/list-for-org'] + } + '/orgs/{org}/members': { /** List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned. */ - get: operations["orgs/list-members"]; - }; - "/orgs/{org}/members/{username}": { + get: operations['orgs/list-members'] + } + '/orgs/{org}/members/{username}': { /** Check if a user is, publicly or privately, a member of the organization. */ - get: operations["orgs/check-membership-for-user"]; + get: operations['orgs/check-membership-for-user'] /** Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories. */ - delete: operations["orgs/remove-member"]; - }; - "/orgs/{org}/memberships/{username}": { + delete: operations['orgs/remove-member'] + } + '/orgs/{org}/memberships/{username}': { /** In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status. */ - get: operations["orgs/get-membership-for-user"]; + get: operations['orgs/get-membership-for-user'] /** * Only authenticated organization owners can add a member to the organization or update the member's role. * @@ -1469,21 +1469,21 @@ export interface paths { * * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. */ - put: operations["orgs/set-membership-for-user"]; + put: operations['orgs/set-membership-for-user'] /** * In order to remove a user's membership with an organization, the authenticated user must be an organization owner. * * If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases. */ - delete: operations["orgs/remove-membership-for-user"]; - }; - "/orgs/{org}/migrations": { + delete: operations['orgs/remove-membership-for-user'] + } + '/orgs/{org}/migrations': { /** Lists the most recent migrations. */ - get: operations["migrations/list-for-org"]; + get: operations['migrations/list-for-org'] /** Initiates the generation of a migration archive. */ - post: operations["migrations/start-for-org"]; - }; - "/orgs/{org}/migrations/{migration_id}": { + post: operations['migrations/start-for-org'] + } + '/orgs/{org}/migrations/{migration_id}': { /** * Fetches the status of a migration. * @@ -1494,49 +1494,49 @@ export interface paths { * * `exported`, which means the migration finished successfully. * * `failed`, which means the migration failed. */ - get: operations["migrations/get-status-for-org"]; - }; - "/orgs/{org}/migrations/{migration_id}/archive": { + get: operations['migrations/get-status-for-org'] + } + '/orgs/{org}/migrations/{migration_id}/archive': { /** Fetches the URL to a migration archive. */ - get: operations["migrations/download-archive-for-org"]; + get: operations['migrations/download-archive-for-org'] /** Deletes a previous migration archive. Migration archives are automatically deleted after seven days. */ - delete: operations["migrations/delete-archive-for-org"]; - }; - "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock": { + delete: operations['migrations/delete-archive-for-org'] + } + '/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock': { /** Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/rest/reference/repos#delete-a-repository) when the migration is complete and you no longer need the source data. */ - delete: operations["migrations/unlock-repo-for-org"]; - }; - "/orgs/{org}/migrations/{migration_id}/repositories": { + delete: operations['migrations/unlock-repo-for-org'] + } + '/orgs/{org}/migrations/{migration_id}/repositories': { /** List all the repositories for this organization migration. */ - get: operations["migrations/list-repos-for-org"]; - }; - "/orgs/{org}/outside_collaborators": { + get: operations['migrations/list-repos-for-org'] + } + '/orgs/{org}/outside_collaborators': { /** List all users who are outside collaborators of an organization. */ - get: operations["orgs/list-outside-collaborators"]; - }; - "/orgs/{org}/outside_collaborators/{username}": { + get: operations['orgs/list-outside-collaborators'] + } + '/orgs/{org}/outside_collaborators/{username}': { /** When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://docs.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)". */ - put: operations["orgs/convert-member-to-outside-collaborator"]; + put: operations['orgs/convert-member-to-outside-collaborator'] /** Removing a user from this list will remove them from all the organization's repositories. */ - delete: operations["orgs/remove-outside-collaborator"]; - }; - "/orgs/{org}/packages": { + delete: operations['orgs/remove-outside-collaborator'] + } + '/orgs/{org}/packages': { /** * Lists all packages in an organization readable by the user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/list-packages-for-organization"]; - }; - "/orgs/{org}/packages/{package_type}/{package_name}": { + get: operations['packages/list-packages-for-organization'] + } + '/orgs/{org}/packages/{package_type}/{package_name}': { /** * Gets a specific package in an organization. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/get-package-for-organization"]; + get: operations['packages/get-package-for-organization'] /** * Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * @@ -1544,9 +1544,9 @@ export interface paths { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. */ - delete: operations["packages/delete-package-for-org"]; - }; - "/orgs/{org}/packages/{package_type}/{package_name}/restore": { + delete: operations['packages/delete-package-for-org'] + } + '/orgs/{org}/packages/{package_type}/{package_name}/restore': { /** * Restores an entire package in an organization. * @@ -1558,25 +1558,25 @@ export interface paths { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. */ - post: operations["packages/restore-package-for-org"]; - }; - "/orgs/{org}/packages/{package_type}/{package_name}/versions": { + post: operations['packages/restore-package-for-org'] + } + '/orgs/{org}/packages/{package_type}/{package_name}/versions': { /** * Returns all package versions for a package owned by an organization. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/get-all-package-versions-for-package-owned-by-org"]; - }; - "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}": { + get: operations['packages/get-all-package-versions-for-package-owned-by-org'] + } + '/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}': { /** * Gets a specific package version in an organization. * * You must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/get-package-version-for-organization"]; + get: operations['packages/get-package-version-for-organization'] /** * Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * @@ -1584,9 +1584,9 @@ export interface paths { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. */ - delete: operations["packages/delete-package-version-for-org"]; - }; - "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { + delete: operations['packages/delete-package-version-for-org'] + } + '/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore': { /** * Restores a specific package version in an organization. * @@ -1598,31 +1598,31 @@ export interface paths { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. */ - post: operations["packages/restore-package-version-for-org"]; - }; - "/orgs/{org}/projects": { + post: operations['packages/restore-package-version-for-org'] + } + '/orgs/{org}/projects': { /** Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - get: operations["projects/list-for-org"]; + get: operations['projects/list-for-org'] /** Creates an organization project board. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - post: operations["projects/create-for-org"]; - }; - "/orgs/{org}/public_members": { + post: operations['projects/create-for-org'] + } + '/orgs/{org}/public_members': { /** Members of an organization can choose to have their membership publicized or not. */ - get: operations["orgs/list-public-members"]; - }; - "/orgs/{org}/public_members/{username}": { - get: operations["orgs/check-public-membership-for-user"]; + get: operations['orgs/list-public-members'] + } + '/orgs/{org}/public_members/{username}': { + get: operations['orgs/check-public-membership-for-user'] /** * The user can publicize their own membership. (A user cannot publicize the membership for another user.) * * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - put: operations["orgs/set-public-membership-for-authenticated-user"]; - delete: operations["orgs/remove-public-membership-for-authenticated-user"]; - }; - "/orgs/{org}/repos": { + put: operations['orgs/set-public-membership-for-authenticated-user'] + delete: operations['orgs/remove-public-membership-for-authenticated-user'] + } + '/orgs/{org}/repos': { /** Lists repositories for the specified organization. */ - get: operations["repos/list-for-org"]; + get: operations['repos/list-for-org'] /** * Creates a new repository in the specified organization. The authenticated user must be a member of the organization. * @@ -1633,18 +1633,18 @@ export interface paths { * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. * * `repo` scope to create a private repository */ - post: operations["repos/create-in-org"]; - }; - "/orgs/{org}/secret-scanning/alerts": { + post: operations['repos/create-in-org'] + } + '/orgs/{org}/secret-scanning/alerts': { /** * Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest. * To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. */ - get: operations["secret-scanning/list-alerts-for-org"]; - }; - "/orgs/{org}/settings/billing/actions": { + get: operations['secret-scanning/list-alerts-for-org'] + } + '/orgs/{org}/settings/billing/actions': { /** * Gets the summary of the free and paid GitHub Actions minutes used. * @@ -1652,17 +1652,17 @@ export interface paths { * * Access tokens must have the `repo` or `admin:org` scope. */ - get: operations["billing/get-github-actions-billing-org"]; - }; - "/orgs/{org}/settings/billing/advanced-security": { + get: operations['billing/get-github-actions-billing-org'] + } + '/orgs/{org}/settings/billing/advanced-security': { /** * Gets the GitHub Advanced Security active committers for an organization per repository. * Each distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of advanced_security_committers for each repository. * If this organization defers to an enterprise for billing, the total_advanced_security_committers returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level. */ - get: operations["billing/get-github-advanced-security-billing-org"]; - }; - "/orgs/{org}/settings/billing/packages": { + get: operations['billing/get-github-advanced-security-billing-org'] + } + '/orgs/{org}/settings/billing/packages': { /** * Gets the free and paid storage used for GitHub Packages in gigabytes. * @@ -1670,9 +1670,9 @@ export interface paths { * * Access tokens must have the `repo` or `admin:org` scope. */ - get: operations["billing/get-github-packages-billing-org"]; - }; - "/orgs/{org}/settings/billing/shared-storage": { + get: operations['billing/get-github-packages-billing-org'] + } + '/orgs/{org}/settings/billing/shared-storage': { /** * Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. * @@ -1680,33 +1680,33 @@ export interface paths { * * Access tokens must have the `repo` or `admin:org` scope. */ - get: operations["billing/get-shared-storage-billing-org"]; - }; - "/orgs/{org}/team-sync/groups": { + get: operations['billing/get-shared-storage-billing-org'] + } + '/orgs/{org}/team-sync/groups': { /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * List IdP groups available in an organization. You can limit your page results using the `per_page` parameter. GitHub generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." */ - get: operations["teams/list-idp-groups-for-org"]; - }; - "/orgs/{org}/teams": { + get: operations['teams/list-idp-groups-for-org'] + } + '/orgs/{org}/teams': { /** Lists all teams in an organization that are visible to the authenticated user. */ - get: operations["teams/list"]; + get: operations['teams/list'] /** * To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://docs.github.com/en/articles/setting-team-creation-permissions-in-your-organization)." * * When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)". */ - post: operations["teams/create"]; - }; - "/orgs/{org}/teams/{team_slug}": { + post: operations['teams/create'] + } + '/orgs/{org}/teams/{team_slug}': { /** * Gets a team using the team's `slug`. GitHub generates the `slug` from the team `name`. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. */ - get: operations["teams/get-by-name"]; + get: operations['teams/get-by-name'] /** * To delete a team, the authenticated user must be an organization owner or team maintainer. * @@ -1714,21 +1714,21 @@ export interface paths { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. */ - delete: operations["teams/delete-in-org"]; + delete: operations['teams/delete-in-org'] /** * To edit a team, the authenticated user must either be an organization owner or a team maintainer. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. */ - patch: operations["teams/update-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/discussions": { + patch: operations['teams/update-in-org'] + } + '/orgs/{org}/teams/{team_slug}/discussions': { /** * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. */ - get: operations["teams/list-discussions-in-org"]; + get: operations['teams/list-discussions-in-org'] /** * Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @@ -1736,35 +1736,35 @@ export interface paths { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. */ - post: operations["teams/create-discussion-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": { + post: operations['teams/create-discussion-in-org'] + } + '/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}': { /** * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. */ - get: operations["teams/get-discussion-in-org"]; + get: operations['teams/get-discussion-in-org'] /** * Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. */ - delete: operations["teams/delete-discussion-in-org"]; + delete: operations['teams/delete-discussion-in-org'] /** * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. */ - patch: operations["teams/update-discussion-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": { + patch: operations['teams/update-discussion-in-org'] + } + '/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments': { /** * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. */ - get: operations["teams/list-discussion-comments-in-org"]; + get: operations['teams/list-discussion-comments-in-org'] /** * Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @@ -1772,103 +1772,103 @@ export interface paths { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. */ - post: operations["teams/create-discussion-comment-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": { + post: operations['teams/create-discussion-comment-in-org'] + } + '/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}': { /** * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. */ - get: operations["teams/get-discussion-comment-in-org"]; + get: operations['teams/get-discussion-comment-in-org'] /** * Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. */ - delete: operations["teams/delete-discussion-comment-in-org"]; + delete: operations['teams/delete-discussion-comment-in-org'] /** * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. */ - patch: operations["teams/update-discussion-comment-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { + patch: operations['teams/update-discussion-comment-in-org'] + } + '/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions': { /** * List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments/). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. */ - get: operations["reactions/list-for-team-discussion-comment-in-org"]; + get: operations['reactions/list-for-team-discussion-comment-in-org'] /** * Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. */ - post: operations["reactions/create-for-team-discussion-comment-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { + post: operations['reactions/create-for-team-discussion-comment-in-org'] + } + '/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}': { /** * **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. * * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - delete: operations["reactions/delete-for-team-discussion-comment"]; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { + delete: operations['reactions/delete-for-team-discussion-comment'] + } + '/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions': { /** * List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. */ - get: operations["reactions/list-for-team-discussion-in-org"]; + get: operations['reactions/list-for-team-discussion-in-org'] /** * Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. */ - post: operations["reactions/create-for-team-discussion-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { + post: operations['reactions/create-for-team-discussion-in-org'] + } + '/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}': { /** * **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. * * Delete a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - delete: operations["reactions/delete-for-team-discussion"]; - }; - "/orgs/{org}/teams/{team_slug}/external-groups": { + delete: operations['reactions/delete-for-team-discussion'] + } + '/orgs/{org}/teams/{team_slug}/external-groups': { /** * Deletes a connection between a team and an external group. * * You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - delete: operations["teams/unlink-external-idp-group-from-team-for-org"]; + delete: operations['teams/unlink-external-idp-group-from-team-for-org'] /** * Creates a connection between a team and an external group. Only one external group can be linked to a team. * * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ - patch: operations["teams/link-external-idp-group-to-team-for-org"]; - }; - "/orgs/{org}/teams/{team_slug}/invitations": { + patch: operations['teams/link-external-idp-group-to-team-for-org'] + } + '/orgs/{org}/teams/{team_slug}/invitations': { /** * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. */ - get: operations["teams/list-pending-invitations-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/members": { + get: operations['teams/list-pending-invitations-in-org'] + } + '/orgs/{org}/teams/{team_slug}/members': { /** * Team members will include the members of child teams. * * To list members in a team, the team must be visible to the authenticated user. */ - get: operations["teams/list-members-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/memberships/{username}": { + get: operations['teams/list-members-in-org'] + } + '/orgs/{org}/teams/{team_slug}/memberships/{username}': { /** * Team members will include the members of child teams. * @@ -1881,7 +1881,7 @@ export interface paths { * * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team). */ - get: operations["teams/get-membership-for-user-in-org"]; + get: operations['teams/get-membership-for-user-in-org'] /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -1895,7 +1895,7 @@ export interface paths { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ - put: operations["teams/add-or-update-membership-for-user-in-org"]; + put: operations['teams/add-or-update-membership-for-user-in-org'] /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -1905,45 +1905,45 @@ export interface paths { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ - delete: operations["teams/remove-membership-for-user-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/projects": { + delete: operations['teams/remove-membership-for-user-in-org'] + } + '/orgs/{org}/teams/{team_slug}/projects': { /** * Lists the organization projects for a team. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. */ - get: operations["teams/list-projects-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { + get: operations['teams/list-projects-in-org'] + } + '/orgs/{org}/teams/{team_slug}/projects/{project_id}': { /** * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ - get: operations["teams/check-permissions-for-project-in-org"]; + get: operations['teams/check-permissions-for-project-in-org'] /** * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ - put: operations["teams/add-or-update-project-permissions-in-org"]; + put: operations['teams/add-or-update-project-permissions-in-org'] /** * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ - delete: operations["teams/remove-project-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/repos": { + delete: operations['teams/remove-project-in-org'] + } + '/orgs/{org}/teams/{team_slug}/repos': { /** * Lists a team's repositories visible to the authenticated user. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. */ - get: operations["teams/list-repos-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": { + get: operations['teams/list-repos-in-org'] + } + '/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}': { /** * Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. * @@ -1953,7 +1953,7 @@ export interface paths { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ - get: operations["teams/check-permissions-for-repo-in-org"]; + get: operations['teams/check-permissions-for-repo-in-org'] /** * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." * @@ -1961,15 +1961,15 @@ export interface paths { * * For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". */ - put: operations["teams/add-or-update-repo-permissions-in-org"]; + put: operations['teams/add-or-update-repo-permissions-in-org'] /** * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ - delete: operations["teams/remove-repo-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/team-sync/group-mappings": { + delete: operations['teams/remove-repo-in-org'] + } + '/orgs/{org}/teams/{team_slug}/team-sync/group-mappings': { /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -1977,7 +1977,7 @@ export interface paths { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`. */ - get: operations["teams/list-idp-groups-in-org"]; + get: operations['teams/list-idp-groups-in-org'] /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -1985,131 +1985,131 @@ export interface paths { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`. */ - patch: operations["teams/create-or-update-idp-group-connections-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/teams": { + patch: operations['teams/create-or-update-idp-group-connections-in-org'] + } + '/orgs/{org}/teams/{team_slug}/teams': { /** * Lists the child teams of the team specified by `{team_slug}`. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. */ - get: operations["teams/list-child-in-org"]; - }; - "/projects/columns/cards/{card_id}": { - get: operations["projects/get-card"]; - delete: operations["projects/delete-card"]; - patch: operations["projects/update-card"]; - }; - "/projects/columns/cards/{card_id}/moves": { - post: operations["projects/move-card"]; - }; - "/projects/columns/{column_id}": { - get: operations["projects/get-column"]; - delete: operations["projects/delete-column"]; - patch: operations["projects/update-column"]; - }; - "/projects/columns/{column_id}/cards": { - get: operations["projects/list-cards"]; - post: operations["projects/create-card"]; - }; - "/projects/columns/{column_id}/moves": { - post: operations["projects/move-column"]; - }; - "/projects/{project_id}": { + get: operations['teams/list-child-in-org'] + } + '/projects/columns/cards/{card_id}': { + get: operations['projects/get-card'] + delete: operations['projects/delete-card'] + patch: operations['projects/update-card'] + } + '/projects/columns/cards/{card_id}/moves': { + post: operations['projects/move-card'] + } + '/projects/columns/{column_id}': { + get: operations['projects/get-column'] + delete: operations['projects/delete-column'] + patch: operations['projects/update-column'] + } + '/projects/columns/{column_id}/cards': { + get: operations['projects/list-cards'] + post: operations['projects/create-card'] + } + '/projects/columns/{column_id}/moves': { + post: operations['projects/move-column'] + } + '/projects/{project_id}': { /** Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - get: operations["projects/get"]; + get: operations['projects/get'] /** Deletes a project board. Returns a `404 Not Found` status if projects are disabled. */ - delete: operations["projects/delete"]; + delete: operations['projects/delete'] /** Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - patch: operations["projects/update"]; - }; - "/projects/{project_id}/collaborators": { + patch: operations['projects/update'] + } + '/projects/{project_id}/collaborators': { /** Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators. */ - get: operations["projects/list-collaborators"]; - }; - "/projects/{project_id}/collaborators/{username}": { + get: operations['projects/list-collaborators'] + } + '/projects/{project_id}/collaborators/{username}': { /** Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator. */ - put: operations["projects/add-collaborator"]; + put: operations['projects/add-collaborator'] /** Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator. */ - delete: operations["projects/remove-collaborator"]; - }; - "/projects/{project_id}/collaborators/{username}/permission": { + delete: operations['projects/remove-collaborator'] + } + '/projects/{project_id}/collaborators/{username}/permission': { /** Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level. */ - get: operations["projects/get-permission-for-user"]; - }; - "/projects/{project_id}/columns": { - get: operations["projects/list-columns"]; - post: operations["projects/create-column"]; - }; - "/rate_limit": { + get: operations['projects/get-permission-for-user'] + } + '/projects/{project_id}/columns': { + get: operations['projects/list-columns'] + post: operations['projects/create-column'] + } + '/rate_limit': { /** * **Note:** Accessing this endpoint does not count against your REST API rate limit. * * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. */ - get: operations["rate-limit/get"]; - }; - "/reactions/{reaction_id}": { + get: operations['rate-limit/get'] + } + '/reactions/{reaction_id}': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Reactions API. We recommend migrating your existing code to use the new delete reactions endpoints. For more information, see this [blog post](https://developer.github.com/changes/2020-02-26-new-delete-reactions-endpoints/). * * OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), when deleting a [team discussion](https://docs.github.com/rest/reference/teams#discussions) or [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). */ - delete: operations["reactions/delete-legacy"]; - }; - "/repos/{owner}/{repo}": { + delete: operations['reactions/delete-legacy'] + } + '/repos/{owner}/{repo}': { /** The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. */ - get: operations["repos/get"]; + get: operations['repos/get'] /** * Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required. * * If an organization owner has configured the organization to prevent members from deleting organization-owned * repositories, you will get a `403 Forbidden` response. */ - delete: operations["repos/delete"]; + delete: operations['repos/delete'] /** **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/rest/reference/repos#replace-all-repository-topics) endpoint. */ - patch: operations["repos/update"]; - }; - "/repos/{owner}/{repo}/actions/artifacts": { + patch: operations['repos/update'] + } + '/repos/{owner}/{repo}/actions/artifacts': { /** Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/list-artifacts-for-repo"]; - }; - "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}": { + get: operations['actions/list-artifacts-for-repo'] + } + '/repos/{owner}/{repo}/actions/artifacts/{artifact_id}': { /** Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/get-artifact"]; + get: operations['actions/get-artifact'] /** Deletes an artifact for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - delete: operations["actions/delete-artifact"]; - }; - "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}": { + delete: operations['actions/delete-artifact'] + } + '/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}': { /** * Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in * the response header to find the URL for the download. The `:archive_format` must be `zip`. Anyone with read access to * the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/download-artifact"]; - }; - "/repos/{owner}/{repo}/actions/jobs/{job_id}": { + get: operations['actions/download-artifact'] + } + '/repos/{owner}/{repo}/actions/jobs/{job_id}': { /** Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/get-job-for-workflow-run"]; - }; - "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs": { + get: operations['actions/get-job-for-workflow-run'] + } + '/repos/{owner}/{repo}/actions/jobs/{job_id}/logs': { /** * Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look * for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can * use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must * have the `actions:read` permission to use this endpoint. */ - get: operations["actions/download-job-logs-for-workflow-run"]; - }; - "/repos/{owner}/{repo}/actions/permissions": { + get: operations['actions/download-job-logs-for-workflow-run'] + } + '/repos/{owner}/{repo}/actions/permissions': { /** * Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository. * * You must authenticate using an access token with the `repo` scope to use this * endpoint. GitHub Apps must have the `administration` repository permission to use this API. */ - get: operations["actions/get-github-actions-permissions-repository"]; + get: operations['actions/get-github-actions-permissions-repository'] /** * Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository. * @@ -2117,15 +2117,15 @@ export interface paths { * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. */ - put: operations["actions/set-github-actions-permissions-repository"]; - }; - "/repos/{owner}/{repo}/actions/permissions/selected-actions": { + put: operations['actions/set-github-actions-permissions-repository'] + } + '/repos/{owner}/{repo}/actions/permissions/selected-actions': { /** * Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. */ - get: operations["actions/get-allowed-actions-repository"]; + get: operations['actions/get-allowed-actions-repository'] /** * Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." * @@ -2135,21 +2135,21 @@ export interface paths { * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. */ - put: operations["actions/set-allowed-actions-repository"]; - }; - "/repos/{owner}/{repo}/actions/runners": { + put: operations['actions/set-allowed-actions-repository'] + } + '/repos/{owner}/{repo}/actions/runners': { /** Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. */ - get: operations["actions/list-self-hosted-runners-for-repo"]; - }; - "/repos/{owner}/{repo}/actions/runners/downloads": { + get: operations['actions/list-self-hosted-runners-for-repo'] + } + '/repos/{owner}/{repo}/actions/runners/downloads': { /** * Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `repo` scope to use this endpoint. */ - get: operations["actions/list-runner-applications-for-repo"]; - }; - "/repos/{owner}/{repo}/actions/runners/registration-token": { + get: operations['actions/list-runner-applications-for-repo'] + } + '/repos/{owner}/{repo}/actions/runners/registration-token': { /** * Returns a token that you can pass to the `config` script. The token expires after one hour. You must authenticate * using an access token with the `repo` scope to use this endpoint. @@ -2162,9 +2162,9 @@ export interface paths { * ./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN * ``` */ - post: operations["actions/create-registration-token-for-repo"]; - }; - "/repos/{owner}/{repo}/actions/runners/remove-token": { + post: operations['actions/create-registration-token-for-repo'] + } + '/repos/{owner}/{repo}/actions/runners/remove-token': { /** * Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour. * You must authenticate using an access token with the `repo` scope to use this endpoint. @@ -2177,32 +2177,32 @@ export interface paths { * ./config.sh remove --token TOKEN * ``` */ - post: operations["actions/create-remove-token-for-repo"]; - }; - "/repos/{owner}/{repo}/actions/runners/{runner_id}": { + post: operations['actions/create-remove-token-for-repo'] + } + '/repos/{owner}/{repo}/actions/runners/{runner_id}': { /** * Gets a specific self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - get: operations["actions/get-self-hosted-runner-for-repo"]; + get: operations['actions/get-self-hosted-runner-for-repo'] /** * Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * * You must authenticate using an access token with the `repo` * scope to use this endpoint. */ - delete: operations["actions/delete-self-hosted-runner-from-repo"]; - }; - "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels": { + delete: operations['actions/delete-self-hosted-runner-from-repo'] + } + '/repos/{owner}/{repo}/actions/runners/{runner_id}/labels': { /** * Lists all labels for a self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - get: operations["actions/list-labels-for-self-hosted-runner-for-repo"]; + get: operations['actions/list-labels-for-self-hosted-runner-for-repo'] /** * Remove all previous custom labels and set the new custom labels for a specific * self-hosted runner configured in a repository. @@ -2210,14 +2210,14 @@ export interface paths { * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - put: operations["actions/set-custom-labels-for-self-hosted-runner-for-repo"]; + put: operations['actions/set-custom-labels-for-self-hosted-runner-for-repo'] /** * Add custom labels to a self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - post: operations["actions/add-custom-labels-to-self-hosted-runner-for-repo"]; + post: operations['actions/add-custom-labels-to-self-hosted-runner-for-repo'] /** * Remove all custom labels from a self-hosted runner configured in a * repository. Returns the remaining read-only labels from the runner. @@ -2225,9 +2225,9 @@ export interface paths { * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - delete: operations["actions/remove-all-custom-labels-from-self-hosted-runner-for-repo"]; - }; - "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}": { + delete: operations['actions/remove-all-custom-labels-from-self-hosted-runner-for-repo'] + } + '/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}': { /** * Remove a custom label from a self-hosted runner configured * in a repository. Returns the remaining labels from the runner. @@ -2238,120 +2238,120 @@ export interface paths { * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - delete: operations["actions/remove-custom-label-from-self-hosted-runner-for-repo"]; - }; - "/repos/{owner}/{repo}/actions/runs": { + delete: operations['actions/remove-custom-label-from-self-hosted-runner-for-repo'] + } + '/repos/{owner}/{repo}/actions/runs': { /** * Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). * * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/list-workflow-runs-for-repo"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}": { + get: operations['actions/list-workflow-runs-for-repo'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}': { /** Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/get-workflow-run"]; + get: operations['actions/get-workflow-run'] /** * Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is * private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:write` permission to use * this endpoint. */ - delete: operations["actions/delete-workflow-run"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/approvals": { + delete: operations['actions/delete-workflow-run'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/approvals': { /** Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/get-reviews-for-run"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/approve": { + get: operations['actions/get-reviews-for-run'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/approve': { /** * Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)." * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - post: operations["actions/approve-workflow-run"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts": { + post: operations['actions/approve-workflow-run'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts': { /** Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/list-workflow-run-artifacts"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}": { + get: operations['actions/list-workflow-run-artifacts'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}': { /** * Gets a specific workflow run attempt. Anyone with read access to the repository * can use this endpoint. If the repository is private you must use an access token * with the `repo` scope. GitHub Apps must have the `actions:read` permission to * use this endpoint. */ - get: operations["actions/get-workflow-run-attempt"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs": { + get: operations['actions/get-workflow-run-attempt'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs': { /** Lists jobs for a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). */ - get: operations["actions/list-jobs-for-workflow-run-attempt"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs": { + get: operations['actions/list-jobs-for-workflow-run-attempt'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs': { /** * Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after * 1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to * the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/download-workflow-run-attempt-logs"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": { + get: operations['actions/download-workflow-run-attempt-logs'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/cancel': { /** Cancels a workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - post: operations["actions/cancel-workflow-run"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": { + post: operations['actions/cancel-workflow-run'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/jobs': { /** Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). */ - get: operations["actions/list-jobs-for-workflow-run"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/logs": { + get: operations['actions/list-jobs-for-workflow-run'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/logs': { /** * Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for * `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use * this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have * the `actions:read` permission to use this endpoint. */ - get: operations["actions/download-workflow-run-logs"]; + get: operations['actions/download-workflow-run-logs'] /** Deletes all logs for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - delete: operations["actions/delete-workflow-run-logs"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments": { + delete: operations['actions/delete-workflow-run-logs'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments': { /** * Get all deployment environments for a workflow run that are waiting for protection rules to pass. * * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/get-pending-deployments-for-run"]; + get: operations['actions/get-pending-deployments-for-run'] /** * Approve or reject pending deployments that are waiting on approval by a required reviewer. * * Anyone with read access to the repository contents and deployments can use this endpoint. */ - post: operations["actions/review-pending-deployments-for-run"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun": { + post: operations['actions/review-pending-deployments-for-run'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/rerun': { /** Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - post: operations["actions/re-run-workflow"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/timing": { + post: operations['actions/re-run-workflow'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/timing': { /** * Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/get-workflow-run-usage"]; - }; - "/repos/{owner}/{repo}/actions/secrets": { + get: operations['actions/get-workflow-run-usage'] + } + '/repos/{owner}/{repo}/actions/secrets': { /** Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - get: operations["actions/list-repo-secrets"]; - }; - "/repos/{owner}/{repo}/actions/secrets/public-key": { + get: operations['actions/list-repo-secrets'] + } + '/repos/{owner}/{repo}/actions/secrets/public-key': { /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - get: operations["actions/get-repo-public-key"]; - }; - "/repos/{owner}/{repo}/actions/secrets/{secret_name}": { + get: operations['actions/get-repo-public-key'] + } + '/repos/{owner}/{repo}/actions/secrets/{secret_name}': { /** Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - get: operations["actions/get-repo-secret"]; + get: operations['actions/get-repo-secret'] /** * Creates or updates a repository secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -2429,27 +2429,27 @@ export interface paths { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - put: operations["actions/create-or-update-repo-secret"]; + put: operations['actions/create-or-update-repo-secret'] /** Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - delete: operations["actions/delete-repo-secret"]; - }; - "/repos/{owner}/{repo}/actions/workflows": { + delete: operations['actions/delete-repo-secret'] + } + '/repos/{owner}/{repo}/actions/workflows': { /** Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/list-repo-workflows"]; - }; - "/repos/{owner}/{repo}/actions/workflows/{workflow_id}": { + get: operations['actions/list-repo-workflows'] + } + '/repos/{owner}/{repo}/actions/workflows/{workflow_id}': { /** Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/get-workflow"]; - }; - "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable": { + get: operations['actions/get-workflow'] + } + '/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable': { /** * Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - put: operations["actions/disable-workflow"]; - }; - "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches": { + put: operations['actions/disable-workflow'] + } + '/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches': { /** * You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * @@ -2457,37 +2457,37 @@ export interface paths { * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)." */ - post: operations["actions/create-workflow-dispatch"]; - }; - "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable": { + post: operations['actions/create-workflow-dispatch'] + } + '/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable': { /** * Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - put: operations["actions/enable-workflow"]; - }; - "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { + put: operations['actions/enable-workflow'] + } + '/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs': { /** * List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). * * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. */ - get: operations["actions/list-workflow-runs"]; - }; - "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing": { + get: operations['actions/list-workflow-runs'] + } + '/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing': { /** * Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * * You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/get-workflow-usage"]; - }; - "/repos/{owner}/{repo}/assignees": { + get: operations['actions/get-workflow-usage'] + } + '/repos/{owner}/{repo}/assignees': { /** Lists the [available assignees](https://docs.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. */ - get: operations["issues/list-assignees"]; - }; - "/repos/{owner}/{repo}/assignees/{assignee}": { + get: operations['issues/list-assignees'] + } + '/repos/{owner}/{repo}/assignees/{assignee}': { /** * Checks if a user has permission to be assigned to an issue in this repository. * @@ -2495,47 +2495,47 @@ export interface paths { * * Otherwise a `404` status code is returned. */ - get: operations["issues/check-user-can-be-assigned"]; - }; - "/repos/{owner}/{repo}/autolinks": { + get: operations['issues/check-user-can-be-assigned'] + } + '/repos/{owner}/{repo}/autolinks': { /** * This returns a list of autolinks configured for the given repository. * * Information about autolinks are only available to repository administrators. */ - get: operations["repos/list-autolinks"]; + get: operations['repos/list-autolinks'] /** Users with admin access to the repository can create an autolink. */ - post: operations["repos/create-autolink"]; - }; - "/repos/{owner}/{repo}/autolinks/{autolink_id}": { + post: operations['repos/create-autolink'] + } + '/repos/{owner}/{repo}/autolinks/{autolink_id}': { /** * This returns a single autolink reference by ID that was configured for the given repository. * * Information about autolinks are only available to repository administrators. */ - get: operations["repos/get-autolink"]; + get: operations['repos/get-autolink'] /** * This deletes a single autolink reference by ID that was configured for the given repository. * * Information about autolinks are only available to repository administrators. */ - delete: operations["repos/delete-autolink"]; - }; - "/repos/{owner}/{repo}/automated-security-fixes": { + delete: operations['repos/delete-autolink'] + } + '/repos/{owner}/{repo}/automated-security-fixes': { /** Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/en/articles/configuring-automated-security-fixes)". */ - put: operations["repos/enable-automated-security-fixes"]; + put: operations['repos/enable-automated-security-fixes'] /** Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/en/articles/configuring-automated-security-fixes)". */ - delete: operations["repos/disable-automated-security-fixes"]; - }; - "/repos/{owner}/{repo}/branches": { - get: operations["repos/list-branches"]; - }; - "/repos/{owner}/{repo}/branches/{branch}": { - get: operations["repos/get-branch"]; - }; - "/repos/{owner}/{repo}/branches/{branch}/protection": { + delete: operations['repos/disable-automated-security-fixes'] + } + '/repos/{owner}/{repo}/branches': { + get: operations['repos/list-branches'] + } + '/repos/{owner}/{repo}/branches/{branch}': { + get: operations['repos/get-branch'] + } + '/repos/{owner}/{repo}/branches/{branch}/protection': { /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - get: operations["repos/get-branch-protection"]; + get: operations['repos/get-branch-protection'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2545,31 +2545,31 @@ export interface paths { * * **Note**: The list of users, apps, and teams in total is limited to 100 items. */ - put: operations["repos/update-branch-protection"]; + put: operations['repos/update-branch-protection'] /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - delete: operations["repos/delete-branch-protection"]; - }; - "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins": { + delete: operations['repos/delete-branch-protection'] + } + '/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins': { /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - get: operations["repos/get-admin-branch-protection"]; + get: operations['repos/get-admin-branch-protection'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ - post: operations["repos/set-admin-branch-protection"]; + post: operations['repos/set-admin-branch-protection'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ - delete: operations["repos/delete-admin-branch-protection"]; - }; - "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews": { + delete: operations['repos/delete-admin-branch-protection'] + } + '/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews': { /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - get: operations["repos/get-pull-request-review-protection"]; + get: operations['repos/get-pull-request-review-protection'] /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - delete: operations["repos/delete-pull-request-review-protection"]; + delete: operations['repos/delete-pull-request-review-protection'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2577,9 +2577,9 @@ export interface paths { * * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. */ - patch: operations["repos/update-pull-request-review-protection"]; - }; - "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures": { + patch: operations['repos/update-pull-request-review-protection'] + } + '/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures': { /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2587,43 +2587,43 @@ export interface paths { * * **Note**: You must enable branch protection to require signed commits. */ - get: operations["repos/get-commit-signature-protection"]; + get: operations['repos/get-commit-signature-protection'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits. */ - post: operations["repos/create-commit-signature-protection"]; + post: operations['repos/create-commit-signature-protection'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits. */ - delete: operations["repos/delete-commit-signature-protection"]; - }; - "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks": { + delete: operations['repos/delete-commit-signature-protection'] + } + '/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks': { /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - get: operations["repos/get-status-checks-protection"]; + get: operations['repos/get-status-checks-protection'] /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - delete: operations["repos/remove-status-check-protection"]; + delete: operations['repos/remove-status-check-protection'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. */ - patch: operations["repos/update-status-check-protection"]; - }; - "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts": { + patch: operations['repos/update-status-check-protection'] + } + '/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts': { /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - get: operations["repos/get-all-status-check-contexts"]; + get: operations['repos/get-all-status-check-contexts'] /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - put: operations["repos/set-status-check-contexts"]; + put: operations['repos/set-status-check-contexts'] /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - post: operations["repos/add-status-check-contexts"]; + post: operations['repos/add-status-check-contexts'] /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - delete: operations["repos/remove-status-check-contexts"]; - }; - "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions": { + delete: operations['repos/remove-status-check-contexts'] + } + '/repos/{owner}/{repo}/branches/{branch}/protection/restrictions': { /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2631,21 +2631,21 @@ export interface paths { * * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. */ - get: operations["repos/get-access-restrictions"]; + get: operations['repos/get-access-restrictions'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Disables the ability to restrict who can push to this branch. */ - delete: operations["repos/delete-access-restrictions"]; - }; - "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps": { + delete: operations['repos/delete-access-restrictions'] + } + '/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps': { /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. */ - get: operations["repos/get-apps-with-access-to-protected-branch"]; + get: operations['repos/get-apps-with-access-to-protected-branch'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2655,7 +2655,7 @@ export interface paths { * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - put: operations["repos/set-app-access-restrictions"]; + put: operations['repos/set-app-access-restrictions'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2665,7 +2665,7 @@ export interface paths { * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - post: operations["repos/add-app-access-restrictions"]; + post: operations['repos/add-app-access-restrictions'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2675,15 +2675,15 @@ export interface paths { * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - delete: operations["repos/remove-app-access-restrictions"]; - }; - "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams": { + delete: operations['repos/remove-app-access-restrictions'] + } + '/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams': { /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the teams who have push access to this branch. The list includes child teams. */ - get: operations["repos/get-teams-with-access-to-protected-branch"]; + get: operations['repos/get-teams-with-access-to-protected-branch'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2693,7 +2693,7 @@ export interface paths { * | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ | * | `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - put: operations["repos/set-team-access-restrictions"]; + put: operations['repos/set-team-access-restrictions'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2703,7 +2703,7 @@ export interface paths { * | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ | * | `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - post: operations["repos/add-team-access-restrictions"]; + post: operations['repos/add-team-access-restrictions'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2713,15 +2713,15 @@ export interface paths { * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | Teams that should no longer have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - delete: operations["repos/remove-team-access-restrictions"]; - }; - "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users": { + delete: operations['repos/remove-team-access-restrictions'] + } + '/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users': { /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the people who have push access to this branch. */ - get: operations["repos/get-users-with-access-to-protected-branch"]; + get: operations['repos/get-users-with-access-to-protected-branch'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2731,7 +2731,7 @@ export interface paths { * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - put: operations["repos/set-user-access-restrictions"]; + put: operations['repos/set-user-access-restrictions'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2741,7 +2741,7 @@ export interface paths { * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - post: operations["repos/add-user-access-restrictions"]; + post: operations['repos/add-user-access-restrictions'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2751,9 +2751,9 @@ export interface paths { * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - delete: operations["repos/remove-user-access-restrictions"]; - }; - "/repos/{owner}/{repo}/branches/{branch}/rename": { + delete: operations['repos/remove-user-access-restrictions'] + } + '/repos/{owner}/{repo}/branches/{branch}/rename': { /** * Renames a branch in a repository. * @@ -2771,9 +2771,9 @@ export interface paths { * * Users must have admin or owner permissions. * * GitHub Apps must have the `administration:write` repository permission. */ - post: operations["repos/rename-branch"]; - }; - "/repos/{owner}/{repo}/check-runs": { + post: operations['repos/rename-branch'] + } + '/repos/{owner}/{repo}/check-runs': { /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * @@ -2781,71 +2781,71 @@ export interface paths { * * In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. */ - post: operations["checks/create"]; - }; - "/repos/{owner}/{repo}/check-runs/{check_run_id}": { + post: operations['checks/create'] + } + '/repos/{owner}/{repo}/check-runs/{check_run_id}': { /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * Gets a single check run using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. */ - get: operations["checks/get"]; + get: operations['checks/get'] /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. */ - patch: operations["checks/update"]; - }; - "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations": { + patch: operations['checks/update'] + } + '/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations': { /** Lists annotations for a check run using the annotation `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the `repo` scope to get annotations for a check run in a private repository. */ - get: operations["checks/list-annotations"]; - }; - "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest": { + get: operations['checks/list-annotations'] + } + '/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest': { /** * Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * * To rerequest a check run, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository. */ - post: operations["checks/rerequest-run"]; - }; - "/repos/{owner}/{repo}/check-suites": { + post: operations['checks/rerequest-run'] + } + '/repos/{owner}/{repo}/check-suites': { /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * * By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/reference/checks#check-runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/reference/checks#update-repository-preferences-for-check-suites)". Your GitHub App must have the `checks:write` permission to create check suites. */ - post: operations["checks/create-suite"]; - }; - "/repos/{owner}/{repo}/check-suites/preferences": { + post: operations['checks/create-suite'] + } + '/repos/{owner}/{repo}/check-suites/preferences': { /** Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/reference/checks#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites. */ - patch: operations["checks/set-suites-preferences"]; - }; - "/repos/{owner}/{repo}/check-suites/{check_suite_id}": { + patch: operations['checks/set-suites-preferences'] + } + '/repos/{owner}/{repo}/check-suites/{check_suite_id}': { /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * * Gets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository. */ - get: operations["checks/get-suite"]; - }; - "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": { + get: operations['checks/get-suite'] + } + '/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs': { /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. */ - get: operations["checks/list-for-suite"]; - }; - "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest": { + get: operations['checks/list-for-suite'] + } + '/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest': { /** * Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * * To rerequest a check suite, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository. */ - post: operations["checks/rerequest-suite"]; - }; - "/repos/{owner}/{repo}/code-scanning/alerts": { + post: operations['checks/rerequest-suite'] + } + '/repos/{owner}/{repo}/code-scanning/alerts': { /** * Lists all open code scanning alerts for the default branch (usually `main` * or `master`). You must use an access token with the `security_events` scope to use @@ -2858,29 +2858,29 @@ export interface paths { * for the default branch or for the specified Git reference * (if you used `ref` in the request). */ - get: operations["code-scanning/list-alerts-for-repo"]; - }; - "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}": { + get: operations['code-scanning/list-alerts-for-repo'] + } + '/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}': { /** * Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint. * * **Deprecation notice**: * The instances field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The same information can now be retrieved via a GET request to the URL specified by `instances_url`. */ - get: operations["code-scanning/get-alert"]; + get: operations['code-scanning/get-alert'] /** Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. */ - patch: operations["code-scanning/update-alert"]; - }; - "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances": { + patch: operations['code-scanning/update-alert'] + } + '/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances': { /** * Lists all instances of the specified code scanning alert. * You must use an access token with the `security_events` scope to use this endpoint with private repos, * the `public_repo` scope also grants permission to read security events on public repos only. * GitHub Apps must have the `security_events` read permission to use this endpoint. */ - get: operations["code-scanning/list-alert-instances"]; - }; - "/repos/{owner}/{repo}/code-scanning/analyses": { + get: operations['code-scanning/list-alert-instances'] + } + '/repos/{owner}/{repo}/code-scanning/analyses': { /** * Lists the details of all code scanning analyses for a repository, * starting with the most recent. @@ -2900,9 +2900,9 @@ export interface paths { * **Deprecation notice**: * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. */ - get: operations["code-scanning/list-recent-analyses"]; - }; - "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}": { + get: operations['code-scanning/list-recent-analyses'] + } + '/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}': { /** * Gets a specified code scanning analysis for a repository. * You must use an access token with the `security_events` scope to use this endpoint with private repos, @@ -2924,7 +2924,7 @@ export interface paths { * This is formatted as * [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). */ - get: operations["code-scanning/get-analysis"]; + get: operations['code-scanning/get-analysis'] /** * Deletes a specified code scanning analysis from a repository. For * private repositories, you must use an access token with the `repo` scope. For public repositories, @@ -2993,9 +2993,9 @@ export interface paths { * * The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely. */ - delete: operations["code-scanning/delete-analysis"]; - }; - "/repos/{owner}/{repo}/code-scanning/sarifs": { + delete: operations['code-scanning/delete-analysis'] + } + '/repos/{owner}/{repo}/code-scanning/sarifs': { /** * Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. * @@ -3015,27 +3015,27 @@ export interface paths { * You can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint. * For more information, see "[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload)." */ - post: operations["code-scanning/upload-sarif"]; - }; - "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}": { + post: operations['code-scanning/upload-sarif'] + } + '/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}': { /** Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository)." You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint. */ - get: operations["code-scanning/get-sarif"]; - }; - "/repos/{owner}/{repo}/codespaces": { + get: operations['code-scanning/get-sarif'] + } + '/repos/{owner}/{repo}/codespaces': { /** * Lists the codespaces associated to a specified repository and the authenticated user. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - get: operations["codespaces/list-in-repository-for-authenticated-user"]; + get: operations['codespaces/list-in-repository-for-authenticated-user'] /** * Creates a codespace owned by the authenticated user in the specified repository. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - post: operations["codespaces/create-with-repo-for-authenticated-user"]; - }; - "/repos/{owner}/{repo}/codespaces/machines": { + post: operations['codespaces/create-with-repo-for-authenticated-user'] + } + '/repos/{owner}/{repo}/codespaces/machines': { /** * List the machine types available for a given repository based on its configuration. * @@ -3043,9 +3043,9 @@ export interface paths { * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - get: operations["codespaces/repo-machines-for-authenticated-user"]; - }; - "/repos/{owner}/{repo}/collaborators": { + get: operations['codespaces/repo-machines-for-authenticated-user'] + } + '/repos/{owner}/{repo}/collaborators': { /** * For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. * @@ -3055,9 +3055,9 @@ export interface paths { * endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this * endpoint. */ - get: operations["repos/list-collaborators"]; - }; - "/repos/{owner}/{repo}/collaborators/{username}": { + get: operations['repos/list-collaborators'] + } + '/repos/{owner}/{repo}/collaborators/{username}': { /** * For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. * @@ -3067,7 +3067,7 @@ export interface paths { * endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this * endpoint. */ - get: operations["repos/check-collaborator"]; + get: operations['repos/check-collaborator'] /** * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. * @@ -3085,41 +3085,41 @@ export interface paths { * * You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository. */ - put: operations["repos/add-collaborator"]; - delete: operations["repos/remove-collaborator"]; - }; - "/repos/{owner}/{repo}/collaborators/{username}/permission": { + put: operations['repos/add-collaborator'] + delete: operations['repos/remove-collaborator'] + } + '/repos/{owner}/{repo}/collaborators/{username}/permission': { /** Checks the repository permission of a collaborator. The possible repository permissions are `admin`, `write`, `read`, and `none`. */ - get: operations["repos/get-collaborator-permission-level"]; - }; - "/repos/{owner}/{repo}/comments": { + get: operations['repos/get-collaborator-permission-level'] + } + '/repos/{owner}/{repo}/comments': { /** * Commit Comments use [these custom media types](https://docs.github.com/rest/reference/repos#custom-media-types). You can read more about the use of media types in the API [here](https://docs.github.com/rest/overview/media-types/). * * Comments are ordered by ascending ID. */ - get: operations["repos/list-commit-comments-for-repo"]; - }; - "/repos/{owner}/{repo}/comments/{comment_id}": { - get: operations["repos/get-commit-comment"]; - delete: operations["repos/delete-commit-comment"]; - patch: operations["repos/update-commit-comment"]; - }; - "/repos/{owner}/{repo}/comments/{comment_id}/reactions": { + get: operations['repos/list-commit-comments-for-repo'] + } + '/repos/{owner}/{repo}/comments/{comment_id}': { + get: operations['repos/get-commit-comment'] + delete: operations['repos/delete-commit-comment'] + patch: operations['repos/update-commit-comment'] + } + '/repos/{owner}/{repo}/comments/{comment_id}/reactions': { /** List the reactions to a [commit comment](https://docs.github.com/rest/reference/repos#comments). */ - get: operations["reactions/list-for-commit-comment"]; + get: operations['reactions/list-for-commit-comment'] /** Create a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. */ - post: operations["reactions/create-for-commit-comment"]; - }; - "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}": { + post: operations['reactions/create-for-commit-comment'] + } + '/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}': { /** * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. * * Delete a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). */ - delete: operations["reactions/delete-for-commit-comment"]; - }; - "/repos/{owner}/{repo}/commits": { + delete: operations['reactions/delete-for-commit-comment'] + } + '/repos/{owner}/{repo}/commits': { /** * **Signature verification object** * @@ -3150,31 +3150,31 @@ export interface paths { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - get: operations["repos/list-commits"]; - }; - "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head": { + get: operations['repos/list-commits'] + } + '/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head': { /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. */ - get: operations["repos/list-branches-for-head-commit"]; - }; - "/repos/{owner}/{repo}/commits/{commit_sha}/comments": { + get: operations['repos/list-branches-for-head-commit'] + } + '/repos/{owner}/{repo}/commits/{commit_sha}/comments': { /** Use the `:commit_sha` to specify the commit that will have its comments listed. */ - get: operations["repos/list-comments-for-commit"]; + get: operations['repos/list-comments-for-commit'] /** * Create a comment for a commit using its `:commit_sha`. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - post: operations["repos/create-commit-comment"]; - }; - "/repos/{owner}/{repo}/commits/{commit_sha}/pulls": { + post: operations['repos/create-commit-comment'] + } + '/repos/{owner}/{repo}/commits/{commit_sha}/pulls': { /** Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the [List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests) endpoint. */ - get: operations["repos/list-pull-requests-associated-with-commit"]; - }; - "/repos/{owner}/{repo}/commits/{ref}": { + get: operations['repos/list-pull-requests-associated-with-commit'] + } + '/repos/{owner}/{repo}/commits/{ref}': { /** * Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. * @@ -3213,25 +3213,25 @@ export interface paths { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - get: operations["repos/get-commit"]; - }; - "/repos/{owner}/{repo}/commits/{ref}/check-runs": { + get: operations['repos/get-commit'] + } + '/repos/{owner}/{repo}/commits/{ref}/check-runs': { /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. */ - get: operations["checks/list-for-ref"]; - }; - "/repos/{owner}/{repo}/commits/{ref}/check-suites": { + get: operations['checks/list-for-ref'] + } + '/repos/{owner}/{repo}/commits/{ref}/check-suites': { /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * * Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository. */ - get: operations["checks/list-suites-for-ref"]; - }; - "/repos/{owner}/{repo}/commits/{ref}/status": { + get: operations['checks/list-suites-for-ref'] + } + '/repos/{owner}/{repo}/commits/{ref}/status': { /** * Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. * @@ -3242,17 +3242,17 @@ export interface paths { * * **pending** if there are no statuses or a context is `pending` * * **success** if the latest status for all contexts is `success` */ - get: operations["repos/get-combined-status-for-ref"]; - }; - "/repos/{owner}/{repo}/commits/{ref}/statuses": { + get: operations['repos/get-combined-status-for-ref'] + } + '/repos/{owner}/{repo}/commits/{ref}/statuses': { /** * Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one. * * This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`. */ - get: operations["repos/list-commit-statuses-for-ref"]; - }; - "/repos/{owner}/{repo}/community/profile": { + get: operations['repos/list-commit-statuses-for-ref'] + } + '/repos/{owner}/{repo}/community/profile': { /** * This endpoint will return all community profile metrics, including an * overall health score, repository description, the presence of documentation, detected @@ -3267,9 +3267,9 @@ export interface paths { * * `content_reports_enabled` is only returned for organization-owned repositories. */ - get: operations["repos/get-community-profile-metrics"]; - }; - "/repos/{owner}/{repo}/compare/{basehead}": { + get: operations['repos/get-community-profile-metrics'] + } + '/repos/{owner}/{repo}/compare/{basehead}': { /** * The `basehead` param is comprised of two parts: `base` and `head`. Both must be branch names in `repo`. To compare branches across other repositories in the same network as `repo`, use the format `:branch`. * @@ -3312,9 +3312,9 @@ export interface paths { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - get: operations["repos/compare-commits"]; - }; - "/repos/{owner}/{repo}/contents/{path}": { + get: operations['repos/compare-commits'] + } + '/repos/{owner}/{repo}/contents/{path}': { /** * Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit * `:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. @@ -3349,9 +3349,9 @@ export interface paths { * If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the * github.com URLs (`html_url` and `_links["html"]`) will have null values. */ - get: operations["repos/get-content"]; + get: operations['repos/get-content'] /** Creates a new file or replaces an existing file in a repository. */ - put: operations["repos/create-or-update-file-contents"]; + put: operations['repos/create-or-update-file-contents'] /** * Deletes a file in a repository. * @@ -3361,27 +3361,27 @@ export interface paths { * * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. */ - delete: operations["repos/delete-file"]; - }; - "/repos/{owner}/{repo}/contributors": { + delete: operations['repos/delete-file'] + } + '/repos/{owner}/{repo}/contributors': { /** * Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance. * * GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information. */ - get: operations["repos/list-contributors"]; - }; - "/repos/{owner}/{repo}/dependabot/secrets": { + get: operations['repos/list-contributors'] + } + '/repos/{owner}/{repo}/dependabot/secrets': { /** Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */ - get: operations["dependabot/list-repo-secrets"]; - }; - "/repos/{owner}/{repo}/dependabot/secrets/public-key": { + get: operations['dependabot/list-repo-secrets'] + } + '/repos/{owner}/{repo}/dependabot/secrets/public-key': { /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */ - get: operations["dependabot/get-repo-public-key"]; - }; - "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}": { + get: operations['dependabot/get-repo-public-key'] + } + '/repos/{owner}/{repo}/dependabot/secrets/{secret_name}': { /** Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */ - get: operations["dependabot/get-repo-secret"]; + get: operations['dependabot/get-repo-secret'] /** * Creates or updates a repository secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -3459,13 +3459,13 @@ export interface paths { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - put: operations["dependabot/create-or-update-repo-secret"]; + put: operations['dependabot/create-or-update-repo-secret'] /** Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */ - delete: operations["dependabot/delete-repo-secret"]; - }; - "/repos/{owner}/{repo}/deployments": { + delete: operations['dependabot/delete-repo-secret'] + } + '/repos/{owner}/{repo}/deployments': { /** Simple filtering of deployments is available via query parameters: */ - get: operations["repos/list-deployments"]; + get: operations['repos/list-deployments'] /** * Deployments offer a few configurable parameters with certain defaults. * @@ -3513,10 +3513,10 @@ export interface paths { * This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` * status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. */ - post: operations["repos/create-deployment"]; - }; - "/repos/{owner}/{repo}/deployments/{deployment_id}": { - get: operations["repos/get-deployment"]; + post: operations['repos/create-deployment'] + } + '/repos/{owner}/{repo}/deployments/{deployment_id}': { + get: operations['repos/get-deployment'] /** * If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. Anyone with `repo` or `repo_deployment` scopes can delete a deployment. * @@ -3527,23 +3527,23 @@ export interface paths { * * For more information, see "[Create a deployment](https://docs.github.com/rest/reference/repos/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/reference/repos#create-a-deployment-status)." */ - delete: operations["repos/delete-deployment"]; - }; - "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses": { + delete: operations['repos/delete-deployment'] + } + '/repos/{owner}/{repo}/deployments/{deployment_id}/statuses': { /** Users with pull access can view deployment statuses for a deployment: */ - get: operations["repos/list-deployment-statuses"]; + get: operations['repos/list-deployment-statuses'] /** * Users with `push` access can create deployment statuses for a given deployment. * * GitHub Apps require `read & write` access to "Deployments" and `read-only` access to "Repo contents" (for private repos). OAuth Apps require the `repo_deployment` scope. */ - post: operations["repos/create-deployment-status"]; - }; - "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}": { + post: operations['repos/create-deployment-status'] + } + '/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}': { /** Users with pull access can view a deployment status for a deployment: */ - get: operations["repos/get-deployment-status"]; - }; - "/repos/{owner}/{repo}/dispatches": { + get: operations['repos/get-deployment-status'] + } + '/repos/{owner}/{repo}/dispatches': { /** * You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/webhooks/event-payloads/#repository_dispatch)." * @@ -3556,19 +3556,19 @@ export interface paths { * * This input example shows how you can use the `client_payload` as a test to debug your workflow. */ - post: operations["repos/create-dispatch-event"]; - }; - "/repos/{owner}/{repo}/environments": { + post: operations['repos/create-dispatch-event'] + } + '/repos/{owner}/{repo}/environments': { /** * Get all environments for a repository. * * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["repos/get-all-environments"]; - }; - "/repos/{owner}/{repo}/environments/{environment_name}": { + get: operations['repos/get-all-environments'] + } + '/repos/{owner}/{repo}/environments/{environment_name}': { /** Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["repos/get-environment"]; + get: operations['repos/get-environment'] /** * Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)." * @@ -3578,34 +3578,34 @@ export interface paths { * * You must authenticate using an access token with the repo scope to use this endpoint. */ - put: operations["repos/create-or-update-environment"]; + put: operations['repos/create-or-update-environment'] /** You must authenticate using an access token with the repo scope to use this endpoint. */ - delete: operations["repos/delete-an-environment"]; - }; - "/repos/{owner}/{repo}/events": { - get: operations["activity/list-repo-events"]; - }; - "/repos/{owner}/{repo}/forks": { - get: operations["repos/list-forks"]; + delete: operations['repos/delete-an-environment'] + } + '/repos/{owner}/{repo}/events': { + get: operations['activity/list-repo-events'] + } + '/repos/{owner}/{repo}/forks': { + get: operations['repos/list-forks'] /** * Create a fork for the authenticated user. * * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). */ - post: operations["repos/create-fork"]; - }; - "/repos/{owner}/{repo}/git/blobs": { - post: operations["git/create-blob"]; - }; - "/repos/{owner}/{repo}/git/blobs/{file_sha}": { + post: operations['repos/create-fork'] + } + '/repos/{owner}/{repo}/git/blobs': { + post: operations['git/create-blob'] + } + '/repos/{owner}/{repo}/git/blobs/{file_sha}': { /** * The `content` in the response will always be Base64 encoded. * * _Note_: This API supports blobs up to 100 megabytes in size. */ - get: operations["git/get-blob"]; - }; - "/repos/{owner}/{repo}/git/commits": { + get: operations['git/get-blob'] + } + '/repos/{owner}/{repo}/git/commits': { /** * Creates a new Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects). * @@ -3638,9 +3638,9 @@ export interface paths { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - post: operations["git/create-commit"]; - }; - "/repos/{owner}/{repo}/git/commits/{commit_sha}": { + post: operations['git/create-commit'] + } + '/repos/{owner}/{repo}/git/commits/{commit_sha}': { /** * Gets a Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects). * @@ -3673,9 +3673,9 @@ export interface paths { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - get: operations["git/get-commit"]; - }; - "/repos/{owner}/{repo}/git/matching-refs/{ref}": { + get: operations['git/get-commit'] + } + '/repos/{owner}/{repo}/git/matching-refs/{ref}': { /** * Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array. * @@ -3685,25 +3685,25 @@ export interface paths { * * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. */ - get: operations["git/list-matching-refs"]; - }; - "/repos/{owner}/{repo}/git/ref/{ref}": { + get: operations['git/list-matching-refs'] + } + '/repos/{owner}/{repo}/git/ref/{ref}': { /** * Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. * * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". */ - get: operations["git/get-ref"]; - }; - "/repos/{owner}/{repo}/git/refs": { + get: operations['git/get-ref'] + } + '/repos/{owner}/{repo}/git/refs': { /** Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches. */ - post: operations["git/create-ref"]; - }; - "/repos/{owner}/{repo}/git/refs/{ref}": { - delete: operations["git/delete-ref"]; - patch: operations["git/update-ref"]; - }; - "/repos/{owner}/{repo}/git/tags": { + post: operations['git/create-ref'] + } + '/repos/{owner}/{repo}/git/refs/{ref}': { + delete: operations['git/delete-ref'] + patch: operations['git/update-ref'] + } + '/repos/{owner}/{repo}/git/tags': { /** * Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/rest/reference/git#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/rest/reference/git#create-a-reference) the tag reference - this call would be unnecessary. * @@ -3736,9 +3736,9 @@ export interface paths { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - post: operations["git/create-tag"]; - }; - "/repos/{owner}/{repo}/git/tags/{tag_sha}": { + post: operations['git/create-tag'] + } + '/repos/{owner}/{repo}/git/tags/{tag_sha}': { /** * **Signature verification object** * @@ -3769,78 +3769,78 @@ export interface paths { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - get: operations["git/get-tag"]; - }; - "/repos/{owner}/{repo}/git/trees": { + get: operations['git/get-tag'] + } + '/repos/{owner}/{repo}/git/trees': { /** * The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure. * * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/rest/reference/git#create-a-commit)" and "[Update a reference](https://docs.github.com/rest/reference/git#update-a-reference)." */ - post: operations["git/create-tree"]; - }; - "/repos/{owner}/{repo}/git/trees/{tree_sha}": { + post: operations['git/create-tree'] + } + '/repos/{owner}/{repo}/git/trees/{tree_sha}': { /** * Returns a single tree using the SHA1 value for that tree. * * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. */ - get: operations["git/get-tree"]; - }; - "/repos/{owner}/{repo}/hooks": { - get: operations["repos/list-webhooks"]; + get: operations['git/get-tree'] + } + '/repos/{owner}/{repo}/hooks': { + get: operations['repos/list-webhooks'] /** * Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can * share the same `config` as long as those webhooks do not have any `events` that overlap. */ - post: operations["repos/create-webhook"]; - }; - "/repos/{owner}/{repo}/hooks/{hook_id}": { + post: operations['repos/create-webhook'] + } + '/repos/{owner}/{repo}/hooks/{hook_id}': { /** Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/reference/repos#get-a-webhook-configuration-for-a-repository)." */ - get: operations["repos/get-webhook"]; - delete: operations["repos/delete-webhook"]; + get: operations['repos/get-webhook'] + delete: operations['repos/delete-webhook'] /** Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/reference/repos#update-a-webhook-configuration-for-a-repository)." */ - patch: operations["repos/update-webhook"]; - }; - "/repos/{owner}/{repo}/hooks/{hook_id}/config": { + patch: operations['repos/update-webhook'] + } + '/repos/{owner}/{repo}/hooks/{hook_id}/config': { /** * Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/reference/orgs#get-a-repository-webhook)." * * Access tokens must have the `read:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:read` permission. */ - get: operations["repos/get-webhook-config-for-repo"]; + get: operations['repos/get-webhook-config-for-repo'] /** * Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/reference/orgs#update-a-repository-webhook)." * * Access tokens must have the `write:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:write` permission. */ - patch: operations["repos/update-webhook-config-for-repo"]; - }; - "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries": { + patch: operations['repos/update-webhook-config-for-repo'] + } + '/repos/{owner}/{repo}/hooks/{hook_id}/deliveries': { /** Returns a list of webhook deliveries for a webhook configured in a repository. */ - get: operations["repos/list-webhook-deliveries"]; - }; - "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}": { + get: operations['repos/list-webhook-deliveries'] + } + '/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}': { /** Returns a delivery for a webhook configured in a repository. */ - get: operations["repos/get-webhook-delivery"]; - }; - "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { + get: operations['repos/get-webhook-delivery'] + } + '/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts': { /** Redeliver a webhook delivery for a webhook configured in a repository. */ - post: operations["repos/redeliver-webhook-delivery"]; - }; - "/repos/{owner}/{repo}/hooks/{hook_id}/pings": { + post: operations['repos/redeliver-webhook-delivery'] + } + '/repos/{owner}/{repo}/hooks/{hook_id}/pings': { /** This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. */ - post: operations["repos/ping-webhook"]; - }; - "/repos/{owner}/{repo}/hooks/{hook_id}/tests": { + post: operations['repos/ping-webhook'] + } + '/repos/{owner}/{repo}/hooks/{hook_id}/tests': { /** * This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. * * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` */ - post: operations["repos/test-push-webhook"]; - }; - "/repos/{owner}/{repo}/import": { + post: operations['repos/test-push-webhook'] + } + '/repos/{owner}/{repo}/import': { /** * View the progress of an import. * @@ -3877,62 +3877,62 @@ export interface paths { * * `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository. * * `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a "Get Large Files" request. */ - get: operations["migrations/get-import-status"]; + get: operations['migrations/get-import-status'] /** Start a source import to a GitHub repository using GitHub Importer. */ - put: operations["migrations/start-import"]; + put: operations['migrations/start-import'] /** Stop an import for a repository. */ - delete: operations["migrations/cancel-import"]; + delete: operations['migrations/cancel-import'] /** * An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API * request. If no parameters are provided, the import will be restarted. */ - patch: operations["migrations/update-import"]; - }; - "/repos/{owner}/{repo}/import/authors": { + patch: operations['migrations/update-import'] + } + '/repos/{owner}/{repo}/import/authors': { /** * Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `. * * This endpoint and the [Map a commit author](https://docs.github.com/rest/reference/migrations#map-a-commit-author) endpoint allow you to provide correct Git author information. */ - get: operations["migrations/get-commit-authors"]; - }; - "/repos/{owner}/{repo}/import/authors/{author_id}": { + get: operations['migrations/get-commit-authors'] + } + '/repos/{owner}/{repo}/import/authors/{author_id}': { /** Update an author's identity for the import. Your application can continue updating authors any time before you push new commits to the repository. */ - patch: operations["migrations/map-commit-author"]; - }; - "/repos/{owner}/{repo}/import/large_files": { + patch: operations['migrations/map-commit-author'] + } + '/repos/{owner}/{repo}/import/large_files': { /** List files larger than 100MB found during the import */ - get: operations["migrations/get-large-files"]; - }; - "/repos/{owner}/{repo}/import/lfs": { + get: operations['migrations/get-large-files'] + } + '/repos/{owner}/{repo}/import/lfs': { /** You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability is powered by [Git LFS](https://git-lfs.github.com). You can learn more about our LFS feature and working with large files [on our help site](https://docs.github.com/articles/versioning-large-files/). */ - patch: operations["migrations/set-lfs-preference"]; - }; - "/repos/{owner}/{repo}/installation": { + patch: operations['migrations/set-lfs-preference'] + } + '/repos/{owner}/{repo}/installation': { /** * Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - get: operations["apps/get-repo-installation"]; - }; - "/repos/{owner}/{repo}/interaction-limits": { + get: operations['apps/get-repo-installation'] + } + '/repos/{owner}/{repo}/interaction-limits': { /** Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response. */ - get: operations["interactions/get-restrictions-for-repo"]; + get: operations['interactions/get-restrictions-for-repo'] /** Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. */ - put: operations["interactions/set-restrictions-for-repo"]; + put: operations['interactions/set-restrictions-for-repo'] /** Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. */ - delete: operations["interactions/remove-restrictions-for-repo"]; - }; - "/repos/{owner}/{repo}/invitations": { + delete: operations['interactions/remove-restrictions-for-repo'] + } + '/repos/{owner}/{repo}/invitations': { /** When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations. */ - get: operations["repos/list-invitations"]; - }; - "/repos/{owner}/{repo}/invitations/{invitation_id}": { - delete: operations["repos/delete-invitation"]; - patch: operations["repos/update-invitation"]; - }; - "/repos/{owner}/{repo}/issues": { + get: operations['repos/list-invitations'] + } + '/repos/{owner}/{repo}/invitations/{invitation_id}': { + delete: operations['repos/delete-invitation'] + patch: operations['repos/update-invitation'] + } + '/repos/{owner}/{repo}/issues': { /** * List issues in a repository. * @@ -3941,44 +3941,44 @@ export interface paths { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - get: operations["issues/list-for-repo"]; + get: operations['issues/list-for-repo'] /** * Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - post: operations["issues/create"]; - }; - "/repos/{owner}/{repo}/issues/comments": { + post: operations['issues/create'] + } + '/repos/{owner}/{repo}/issues/comments': { /** By default, Issue Comments are ordered by ascending ID. */ - get: operations["issues/list-comments-for-repo"]; - }; - "/repos/{owner}/{repo}/issues/comments/{comment_id}": { - get: operations["issues/get-comment"]; - delete: operations["issues/delete-comment"]; - patch: operations["issues/update-comment"]; - }; - "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": { + get: operations['issues/list-comments-for-repo'] + } + '/repos/{owner}/{repo}/issues/comments/{comment_id}': { + get: operations['issues/get-comment'] + delete: operations['issues/delete-comment'] + patch: operations['issues/update-comment'] + } + '/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions': { /** List the reactions to an [issue comment](https://docs.github.com/rest/reference/issues#comments). */ - get: operations["reactions/list-for-issue-comment"]; + get: operations['reactions/list-for-issue-comment'] /** Create a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. */ - post: operations["reactions/create-for-issue-comment"]; - }; - "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}": { + post: operations['reactions/create-for-issue-comment'] + } + '/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}': { /** * **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. * * Delete a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). */ - delete: operations["reactions/delete-for-issue-comment"]; - }; - "/repos/{owner}/{repo}/issues/events": { - get: operations["issues/list-events-for-repo"]; - }; - "/repos/{owner}/{repo}/issues/events/{event_id}": { - get: operations["issues/get-event"]; - }; - "/repos/{owner}/{repo}/issues/{issue_number}": { + delete: operations['reactions/delete-for-issue-comment'] + } + '/repos/{owner}/{repo}/issues/events': { + get: operations['issues/list-events-for-repo'] + } + '/repos/{owner}/{repo}/issues/events/{event_id}': { + get: operations['issues/get-event'] + } + '/repos/{owner}/{repo}/issues/{issue_number}': { /** * The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was * [transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If @@ -3992,147 +3992,147 @@ export interface paths { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - get: operations["issues/get"]; + get: operations['issues/get'] /** Issue owners and users with push access can edit an issue. */ - patch: operations["issues/update"]; - }; - "/repos/{owner}/{repo}/issues/{issue_number}/assignees": { + patch: operations['issues/update'] + } + '/repos/{owner}/{repo}/issues/{issue_number}/assignees': { /** Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced. */ - post: operations["issues/add-assignees"]; + post: operations['issues/add-assignees'] /** Removes one or more assignees from an issue. */ - delete: operations["issues/remove-assignees"]; - }; - "/repos/{owner}/{repo}/issues/{issue_number}/comments": { + delete: operations['issues/remove-assignees'] + } + '/repos/{owner}/{repo}/issues/{issue_number}/comments': { /** Issue Comments are ordered by ascending ID. */ - get: operations["issues/list-comments"]; + get: operations['issues/list-comments'] /** This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - post: operations["issues/create-comment"]; - }; - "/repos/{owner}/{repo}/issues/{issue_number}/events": { - get: operations["issues/list-events"]; - }; - "/repos/{owner}/{repo}/issues/{issue_number}/labels": { - get: operations["issues/list-labels-on-issue"]; + post: operations['issues/create-comment'] + } + '/repos/{owner}/{repo}/issues/{issue_number}/events': { + get: operations['issues/list-events'] + } + '/repos/{owner}/{repo}/issues/{issue_number}/labels': { + get: operations['issues/list-labels-on-issue'] /** Removes any previous labels and sets the new labels for an issue. */ - put: operations["issues/set-labels"]; - post: operations["issues/add-labels"]; - delete: operations["issues/remove-all-labels"]; - }; - "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}": { + put: operations['issues/set-labels'] + post: operations['issues/add-labels'] + delete: operations['issues/remove-all-labels'] + } + '/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}': { /** Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist. */ - delete: operations["issues/remove-label"]; - }; - "/repos/{owner}/{repo}/issues/{issue_number}/lock": { + delete: operations['issues/remove-label'] + } + '/repos/{owner}/{repo}/issues/{issue_number}/lock': { /** * Users with push access can lock an issue or pull request's conversation. * * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - put: operations["issues/lock"]; + put: operations['issues/lock'] /** Users with push access can unlock an issue's conversation. */ - delete: operations["issues/unlock"]; - }; - "/repos/{owner}/{repo}/issues/{issue_number}/reactions": { + delete: operations['issues/unlock'] + } + '/repos/{owner}/{repo}/issues/{issue_number}/reactions': { /** List the reactions to an [issue](https://docs.github.com/rest/reference/issues). */ - get: operations["reactions/list-for-issue"]; + get: operations['reactions/list-for-issue'] /** Create a reaction to an [issue](https://docs.github.com/rest/reference/issues/). A response with an HTTP `200` status means that you already added the reaction type to this issue. */ - post: operations["reactions/create-for-issue"]; - }; - "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}": { + post: operations['reactions/create-for-issue'] + } + '/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}': { /** * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. * * Delete a reaction to an [issue](https://docs.github.com/rest/reference/issues/). */ - delete: operations["reactions/delete-for-issue"]; - }; - "/repos/{owner}/{repo}/issues/{issue_number}/timeline": { - get: operations["issues/list-events-for-timeline"]; - }; - "/repos/{owner}/{repo}/keys": { - get: operations["repos/list-deploy-keys"]; + delete: operations['reactions/delete-for-issue'] + } + '/repos/{owner}/{repo}/issues/{issue_number}/timeline': { + get: operations['issues/list-events-for-timeline'] + } + '/repos/{owner}/{repo}/keys': { + get: operations['repos/list-deploy-keys'] /** You can create a read-only deploy key. */ - post: operations["repos/create-deploy-key"]; - }; - "/repos/{owner}/{repo}/keys/{key_id}": { - get: operations["repos/get-deploy-key"]; + post: operations['repos/create-deploy-key'] + } + '/repos/{owner}/{repo}/keys/{key_id}': { + get: operations['repos/get-deploy-key'] /** Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead. */ - delete: operations["repos/delete-deploy-key"]; - }; - "/repos/{owner}/{repo}/labels": { - get: operations["issues/list-labels-for-repo"]; - post: operations["issues/create-label"]; - }; - "/repos/{owner}/{repo}/labels/{name}": { - get: operations["issues/get-label"]; - delete: operations["issues/delete-label"]; - patch: operations["issues/update-label"]; - }; - "/repos/{owner}/{repo}/languages": { + delete: operations['repos/delete-deploy-key'] + } + '/repos/{owner}/{repo}/labels': { + get: operations['issues/list-labels-for-repo'] + post: operations['issues/create-label'] + } + '/repos/{owner}/{repo}/labels/{name}': { + get: operations['issues/get-label'] + delete: operations['issues/delete-label'] + patch: operations['issues/update-label'] + } + '/repos/{owner}/{repo}/languages': { /** Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language. */ - get: operations["repos/list-languages"]; - }; - "/repos/{owner}/{repo}/lfs": { - put: operations["repos/enable-lfs-for-repo"]; - delete: operations["repos/disable-lfs-for-repo"]; - }; - "/repos/{owner}/{repo}/license": { + get: operations['repos/list-languages'] + } + '/repos/{owner}/{repo}/lfs': { + put: operations['repos/enable-lfs-for-repo'] + delete: operations['repos/disable-lfs-for-repo'] + } + '/repos/{owner}/{repo}/license': { /** * This method returns the contents of the repository's license file, if one is detected. * * Similar to [Get repository content](https://docs.github.com/rest/reference/repos#get-repository-content), this method also supports [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw license content or rendered license HTML. */ - get: operations["licenses/get-for-repo"]; - }; - "/repos/{owner}/{repo}/merge-upstream": { + get: operations['licenses/get-for-repo'] + } + '/repos/{owner}/{repo}/merge-upstream': { /** Sync a branch of a forked repository to keep it up-to-date with the upstream repository. */ - post: operations["repos/merge-upstream"]; - }; - "/repos/{owner}/{repo}/merges": { - post: operations["repos/merge"]; - }; - "/repos/{owner}/{repo}/milestones": { - get: operations["issues/list-milestones"]; - post: operations["issues/create-milestone"]; - }; - "/repos/{owner}/{repo}/milestones/{milestone_number}": { - get: operations["issues/get-milestone"]; - delete: operations["issues/delete-milestone"]; - patch: operations["issues/update-milestone"]; - }; - "/repos/{owner}/{repo}/milestones/{milestone_number}/labels": { - get: operations["issues/list-labels-for-milestone"]; - }; - "/repos/{owner}/{repo}/notifications": { + post: operations['repos/merge-upstream'] + } + '/repos/{owner}/{repo}/merges': { + post: operations['repos/merge'] + } + '/repos/{owner}/{repo}/milestones': { + get: operations['issues/list-milestones'] + post: operations['issues/create-milestone'] + } + '/repos/{owner}/{repo}/milestones/{milestone_number}': { + get: operations['issues/get-milestone'] + delete: operations['issues/delete-milestone'] + patch: operations['issues/update-milestone'] + } + '/repos/{owner}/{repo}/milestones/{milestone_number}/labels': { + get: operations['issues/list-labels-for-milestone'] + } + '/repos/{owner}/{repo}/notifications': { /** List all notifications for the current user. */ - get: operations["activity/list-repo-notifications-for-authenticated-user"]; + get: operations['activity/list-repo-notifications-for-authenticated-user'] /** Marks all notifications in a repository as "read" removes them from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ - put: operations["activity/mark-repo-notifications-as-read"]; - }; - "/repos/{owner}/{repo}/pages": { - get: operations["repos/get-pages"]; + put: operations['activity/mark-repo-notifications-as-read'] + } + '/repos/{owner}/{repo}/pages': { + get: operations['repos/get-pages'] /** Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). */ - put: operations["repos/update-information-about-pages-site"]; + put: operations['repos/update-information-about-pages-site'] /** Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)." */ - post: operations["repos/create-pages-site"]; - delete: operations["repos/delete-pages-site"]; - }; - "/repos/{owner}/{repo}/pages/builds": { - get: operations["repos/list-pages-builds"]; + post: operations['repos/create-pages-site'] + delete: operations['repos/delete-pages-site'] + } + '/repos/{owner}/{repo}/pages/builds': { + get: operations['repos/list-pages-builds'] /** * You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures. * * Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes. */ - post: operations["repos/request-pages-build"]; - }; - "/repos/{owner}/{repo}/pages/builds/latest": { - get: operations["repos/get-latest-pages-build"]; - }; - "/repos/{owner}/{repo}/pages/builds/{build_id}": { - get: operations["repos/get-pages-build"]; - }; - "/repos/{owner}/{repo}/pages/health": { + post: operations['repos/request-pages-build'] + } + '/repos/{owner}/{repo}/pages/builds/latest': { + get: operations['repos/get-latest-pages-build'] + } + '/repos/{owner}/{repo}/pages/builds/{build_id}': { + get: operations['repos/get-pages-build'] + } + '/repos/{owner}/{repo}/pages/health': { /** * Gets a health check of the DNS settings for the `CNAME` record configured for a repository's GitHub Pages. * @@ -4140,17 +4140,17 @@ export interface paths { * * Users must have admin or owner permissions. GitHub Apps must have the `pages:write` and `administration:write` permission to use this endpoint. */ - get: operations["repos/get-pages-health-check"]; - }; - "/repos/{owner}/{repo}/projects": { + get: operations['repos/get-pages-health-check'] + } + '/repos/{owner}/{repo}/projects': { /** Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - get: operations["projects/list-for-repo"]; + get: operations['projects/list-for-repo'] /** Creates a repository project board. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - post: operations["projects/create-for-repo"]; - }; - "/repos/{owner}/{repo}/pulls": { + post: operations['projects/create-for-repo'] + } + '/repos/{owner}/{repo}/pulls': { /** Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - get: operations["pulls/list"]; + get: operations['pulls/list'] /** * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -4160,35 +4160,35 @@ export interface paths { * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. */ - post: operations["pulls/create"]; - }; - "/repos/{owner}/{repo}/pulls/comments": { + post: operations['pulls/create'] + } + '/repos/{owner}/{repo}/pulls/comments': { /** Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID. */ - get: operations["pulls/list-review-comments-for-repo"]; - }; - "/repos/{owner}/{repo}/pulls/comments/{comment_id}": { + get: operations['pulls/list-review-comments-for-repo'] + } + '/repos/{owner}/{repo}/pulls/comments/{comment_id}': { /** Provides details for a review comment. */ - get: operations["pulls/get-review-comment"]; + get: operations['pulls/get-review-comment'] /** Deletes a review comment. */ - delete: operations["pulls/delete-review-comment"]; + delete: operations['pulls/delete-review-comment'] /** Enables you to edit a review comment. */ - patch: operations["pulls/update-review-comment"]; - }; - "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": { + patch: operations['pulls/update-review-comment'] + } + '/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions': { /** List the reactions to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). */ - get: operations["reactions/list-for-pull-request-review-comment"]; + get: operations['reactions/list-for-pull-request-review-comment'] /** Create a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#comments). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. */ - post: operations["reactions/create-for-pull-request-review-comment"]; - }; - "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}": { + post: operations['reactions/create-for-pull-request-review-comment'] + } + '/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}': { /** * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` * * Delete a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). */ - delete: operations["reactions/delete-for-pull-request-comment"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}": { + delete: operations['reactions/delete-for-pull-request-comment'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}': { /** * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -4206,25 +4206,25 @@ export interface paths { * * Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. */ - get: operations["pulls/get"]; + get: operations['pulls/get'] /** * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. */ - patch: operations["pulls/update"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": { + patch: operations['pulls/update'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/codespaces': { /** * Creates a codespace owned by the authenticated user for the specified pull request. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - post: operations["codespaces/create-with-pr-for-authenticated-user"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/comments": { + post: operations['codespaces/create-with-pr-for-authenticated-user'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/comments': { /** Lists all review comments for a pull request. By default, review comments are in ascending order by ID. */ - get: operations["pulls/list-review-comments"]; + get: operations['pulls/list-review-comments'] /** * Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/reference/issues#create-an-issue-comment)." We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff. * @@ -4234,38 +4234,38 @@ export interface paths { * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - post: operations["pulls/create-review-comment"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies": { + post: operations['pulls/create-review-comment'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies': { /** * Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - post: operations["pulls/create-reply-for-review-comment"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/commits": { + post: operations['pulls/create-reply-for-review-comment'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/commits': { /** Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/reference/repos#list-commits) endpoint. */ - get: operations["pulls/list-commits"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/files": { + get: operations['pulls/list-commits'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/files': { /** **Note:** Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. */ - get: operations["pulls/list-files"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/merge": { - get: operations["pulls/check-if-merged"]; + get: operations['pulls/list-files'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/merge': { + get: operations['pulls/check-if-merged'] /** This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - put: operations["pulls/merge"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { - get: operations["pulls/list-requested-reviewers"]; + put: operations['pulls/merge'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers': { + get: operations['pulls/list-requested-reviewers'] /** This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - post: operations["pulls/request-reviewers"]; - delete: operations["pulls/remove-requested-reviewers"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/reviews": { + post: operations['pulls/request-reviewers'] + delete: operations['pulls/remove-requested-reviewers'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/reviews': { /** The list of reviews returns in chronological order. */ - get: operations["pulls/list-reviews"]; + get: operations['pulls/list-reviews'] /** * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. * @@ -4275,92 +4275,92 @@ export interface paths { * * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. */ - post: operations["pulls/create-review"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}": { - get: operations["pulls/get-review"]; + post: operations['pulls/create-review'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}': { + get: operations['pulls/get-review'] /** Update the review summary comment with new text. */ - put: operations["pulls/update-review"]; - delete: operations["pulls/delete-pending-review"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments": { + put: operations['pulls/update-review'] + delete: operations['pulls/delete-pending-review'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments': { /** List comments for a specific pull request review. */ - get: operations["pulls/list-comments-for-review"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals": { + get: operations['pulls/list-comments-for-review'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals': { /** **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/reference/repos#branches), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. */ - put: operations["pulls/dismiss-review"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events": { - post: operations["pulls/submit-review"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch": { + put: operations['pulls/dismiss-review'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events': { + post: operations['pulls/submit-review'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/update-branch': { /** Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. */ - put: operations["pulls/update-branch"]; - }; - "/repos/{owner}/{repo}/readme": { + put: operations['pulls/update-branch'] + } + '/repos/{owner}/{repo}/readme': { /** * Gets the preferred README for a repository. * * READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. */ - get: operations["repos/get-readme"]; - }; - "/repos/{owner}/{repo}/readme/{dir}": { + get: operations['repos/get-readme'] + } + '/repos/{owner}/{repo}/readme/{dir}': { /** * Gets the README from a repository directory. * * READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. */ - get: operations["repos/get-readme-in-directory"]; - }; - "/repos/{owner}/{repo}/releases": { + get: operations['repos/get-readme-in-directory'] + } + '/repos/{owner}/{repo}/releases': { /** * This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/rest/reference/repos#list-repository-tags). * * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. */ - get: operations["repos/list-releases"]; + get: operations['repos/list-releases'] /** * Users with push access to the repository can create a release. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - post: operations["repos/create-release"]; - }; - "/repos/{owner}/{repo}/releases/assets/{asset_id}": { + post: operations['repos/create-release'] + } + '/repos/{owner}/{repo}/releases/assets/{asset_id}': { /** To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. */ - get: operations["repos/get-release-asset"]; - delete: operations["repos/delete-release-asset"]; + get: operations['repos/get-release-asset'] + delete: operations['repos/delete-release-asset'] /** Users with push access to the repository can edit a release asset. */ - patch: operations["repos/update-release-asset"]; - }; - "/repos/{owner}/{repo}/releases/generate-notes": { + patch: operations['repos/update-release-asset'] + } + '/repos/{owner}/{repo}/releases/generate-notes': { /** Generate a name and body describing a [release](https://docs.github.com/rest/reference/repos#releases). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. */ - post: operations["repos/generate-release-notes"]; - }; - "/repos/{owner}/{repo}/releases/latest": { + post: operations['repos/generate-release-notes'] + } + '/repos/{owner}/{repo}/releases/latest': { /** * View the latest published full release for the repository. * * The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published. */ - get: operations["repos/get-latest-release"]; - }; - "/repos/{owner}/{repo}/releases/tags/{tag}": { + get: operations['repos/get-latest-release'] + } + '/repos/{owner}/{repo}/releases/tags/{tag}': { /** Get a published release with the specified tag. */ - get: operations["repos/get-release-by-tag"]; - }; - "/repos/{owner}/{repo}/releases/{release_id}": { + get: operations['repos/get-release-by-tag'] + } + '/repos/{owner}/{repo}/releases/{release_id}': { /** **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia). */ - get: operations["repos/get-release"]; + get: operations['repos/get-release'] /** Users with push access to the repository can delete a release. */ - delete: operations["repos/delete-release"]; + delete: operations['repos/delete-release'] /** Users with push access to the repository can edit a release. */ - patch: operations["repos/update-release"]; - }; - "/repos/{owner}/{repo}/releases/{release_id}/assets": { - get: operations["repos/list-release-assets"]; + patch: operations['repos/update-release'] + } + '/repos/{owner}/{repo}/releases/{release_id}/assets': { + get: operations['repos/list-release-assets'] /** * This endpoint makes use of [a Hypermedia relation](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in * the response of the [Create a release endpoint](https://docs.github.com/rest/reference/repos#create-a-release) to upload a release asset. @@ -4381,59 +4381,59 @@ export interface paths { * endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). * * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. */ - post: operations["repos/upload-release-asset"]; - }; - "/repos/{owner}/{repo}/releases/{release_id}/reactions": { + post: operations['repos/upload-release-asset'] + } + '/repos/{owner}/{repo}/releases/{release_id}/reactions': { /** Create a reaction to a [release](https://docs.github.com/rest/reference/repos#releases). A response with a `Status: 200 OK` means that you already added the reaction type to this release. */ - post: operations["reactions/create-for-release"]; - }; - "/repos/{owner}/{repo}/secret-scanning/alerts": { + post: operations['reactions/create-for-release'] + } + '/repos/{owner}/{repo}/secret-scanning/alerts': { /** * Lists secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. */ - get: operations["secret-scanning/list-alerts-for-repo"]; - }; - "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}": { + get: operations['secret-scanning/list-alerts-for-repo'] + } + '/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}': { /** * Gets a single secret scanning alert detected in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. */ - get: operations["secret-scanning/get-alert"]; + get: operations['secret-scanning/get-alert'] /** * Updates the status of a secret scanning alert in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint. */ - patch: operations["secret-scanning/update-alert"]; - }; - "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations": { + patch: operations['secret-scanning/update-alert'] + } + '/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations': { /** * Lists all locations for a given secret scanning alert for a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. */ - get: operations["secret-scanning/list-locations-for-alert"]; - }; - "/repos/{owner}/{repo}/stargazers": { + get: operations['secret-scanning/list-locations-for-alert'] + } + '/repos/{owner}/{repo}/stargazers': { /** * Lists the people that have starred the repository. * * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: */ - get: operations["activity/list-stargazers-for-repo"]; - }; - "/repos/{owner}/{repo}/stats/code_frequency": { + get: operations['activity/list-stargazers-for-repo'] + } + '/repos/{owner}/{repo}/stats/code_frequency': { /** Returns a weekly aggregate of the number of additions and deletions pushed to a repository. */ - get: operations["repos/get-code-frequency-stats"]; - }; - "/repos/{owner}/{repo}/stats/commit_activity": { + get: operations['repos/get-code-frequency-stats'] + } + '/repos/{owner}/{repo}/stats/commit_activity': { /** Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`. */ - get: operations["repos/get-commit-activity-stats"]; - }; - "/repos/{owner}/{repo}/stats/contributors": { + get: operations['repos/get-commit-activity-stats'] + } + '/repos/{owner}/{repo}/stats/contributors': { /** * Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information: * @@ -4442,17 +4442,17 @@ export interface paths { * * `d` - Number of deletions * * `c` - Number of commits */ - get: operations["repos/get-contributors-stats"]; - }; - "/repos/{owner}/{repo}/stats/participation": { + get: operations['repos/get-contributors-stats'] + } + '/repos/{owner}/{repo}/stats/participation': { /** * Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`. * * The array order is oldest week (index 0) to most recent week. */ - get: operations["repos/get-participation-stats"]; - }; - "/repos/{owner}/{repo}/stats/punch_card": { + get: operations['repos/get-participation-stats'] + } + '/repos/{owner}/{repo}/stats/punch_card': { /** * Each array contains the day number, hour number, and number of commits: * @@ -4462,84 +4462,84 @@ export interface paths { * * For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. */ - get: operations["repos/get-punch-card-stats"]; - }; - "/repos/{owner}/{repo}/statuses/{sha}": { + get: operations['repos/get-punch-card-stats'] + } + '/repos/{owner}/{repo}/statuses/{sha}': { /** * Users with push access in a repository can create commit statuses for a given SHA. * * Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error. */ - post: operations["repos/create-commit-status"]; - }; - "/repos/{owner}/{repo}/subscribers": { + post: operations['repos/create-commit-status'] + } + '/repos/{owner}/{repo}/subscribers': { /** Lists the people watching the specified repository. */ - get: operations["activity/list-watchers-for-repo"]; - }; - "/repos/{owner}/{repo}/subscription": { - get: operations["activity/get-repo-subscription"]; + get: operations['activity/list-watchers-for-repo'] + } + '/repos/{owner}/{repo}/subscription': { + get: operations['activity/get-repo-subscription'] /** If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/rest/reference/activity#delete-a-repository-subscription) completely. */ - put: operations["activity/set-repo-subscription"]; + put: operations['activity/set-repo-subscription'] /** This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/rest/reference/activity#set-a-repository-subscription). */ - delete: operations["activity/delete-repo-subscription"]; - }; - "/repos/{owner}/{repo}/tags": { - get: operations["repos/list-tags"]; - }; - "/repos/{owner}/{repo}/tarball/{ref}": { + delete: operations['activity/delete-repo-subscription'] + } + '/repos/{owner}/{repo}/tags': { + get: operations['repos/list-tags'] + } + '/repos/{owner}/{repo}/tarball/{ref}': { /** * Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually * `master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. * **Note**: For private repositories, these links are temporary and expire after five minutes. */ - get: operations["repos/download-tarball-archive"]; - }; - "/repos/{owner}/{repo}/teams": { - get: operations["repos/list-teams"]; - }; - "/repos/{owner}/{repo}/topics": { - get: operations["repos/get-all-topics"]; - put: operations["repos/replace-all-topics"]; - }; - "/repos/{owner}/{repo}/traffic/clones": { + get: operations['repos/download-tarball-archive'] + } + '/repos/{owner}/{repo}/teams': { + get: operations['repos/list-teams'] + } + '/repos/{owner}/{repo}/topics': { + get: operations['repos/get-all-topics'] + put: operations['repos/replace-all-topics'] + } + '/repos/{owner}/{repo}/traffic/clones': { /** Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. */ - get: operations["repos/get-clones"]; - }; - "/repos/{owner}/{repo}/traffic/popular/paths": { + get: operations['repos/get-clones'] + } + '/repos/{owner}/{repo}/traffic/popular/paths': { /** Get the top 10 popular contents over the last 14 days. */ - get: operations["repos/get-top-paths"]; - }; - "/repos/{owner}/{repo}/traffic/popular/referrers": { + get: operations['repos/get-top-paths'] + } + '/repos/{owner}/{repo}/traffic/popular/referrers': { /** Get the top 10 referrers over the last 14 days. */ - get: operations["repos/get-top-referrers"]; - }; - "/repos/{owner}/{repo}/traffic/views": { + get: operations['repos/get-top-referrers'] + } + '/repos/{owner}/{repo}/traffic/views': { /** Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. */ - get: operations["repos/get-views"]; - }; - "/repos/{owner}/{repo}/transfer": { + get: operations['repos/get-views'] + } + '/repos/{owner}/{repo}/transfer': { /** A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/). */ - post: operations["repos/transfer"]; - }; - "/repos/{owner}/{repo}/vulnerability-alerts": { + post: operations['repos/transfer'] + } + '/repos/{owner}/{repo}/vulnerability-alerts': { /** Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". */ - get: operations["repos/check-vulnerability-alerts"]; + get: operations['repos/check-vulnerability-alerts'] /** Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". */ - put: operations["repos/enable-vulnerability-alerts"]; + put: operations['repos/enable-vulnerability-alerts'] /** Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". */ - delete: operations["repos/disable-vulnerability-alerts"]; - }; - "/repos/{owner}/{repo}/zipball/{ref}": { + delete: operations['repos/disable-vulnerability-alerts'] + } + '/repos/{owner}/{repo}/zipball/{ref}': { /** * Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually * `master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. * **Note**: For private repositories, these links are temporary and expire after five minutes. */ - get: operations["repos/download-zipball-archive"]; - }; - "/repos/{template_owner}/{template_repo}/generate": { + get: operations['repos/download-zipball-archive'] + } + '/repos/{template_owner}/{template_repo}/generate': { /** * Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. * @@ -4550,9 +4550,9 @@ export interface paths { * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. * * `repo` scope to create a private repository */ - post: operations["repos/create-using-template"]; - }; - "/repositories": { + post: operations['repos/create-using-template'] + } + '/repositories': { /** * Lists all public repositories in the order that they were created. * @@ -4560,19 +4560,19 @@ export interface paths { * - For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories. */ - get: operations["repos/list-public"]; - }; - "/repositories/{repository_id}/environments/{environment_name}/secrets": { + get: operations['repos/list-public'] + } + '/repositories/{repository_id}/environments/{environment_name}/secrets': { /** Lists all secrets available in an environment without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - get: operations["actions/list-environment-secrets"]; - }; - "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key": { + get: operations['actions/list-environment-secrets'] + } + '/repositories/{repository_id}/environments/{environment_name}/secrets/public-key': { /** Get the public key for an environment, which you need to encrypt environment secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - get: operations["actions/get-environment-public-key"]; - }; - "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": { + get: operations['actions/get-environment-public-key'] + } + '/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}': { /** Gets a single environment secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - get: operations["actions/get-environment-secret"]; + get: operations['actions/get-environment-secret'] /** * Creates or updates an environment secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -4650,39 +4650,39 @@ export interface paths { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - put: operations["actions/create-or-update-environment-secret"]; + put: operations['actions/create-or-update-environment-secret'] /** Deletes a secret in an environment using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - delete: operations["actions/delete-environment-secret"]; - }; - "/scim/v2/enterprises/{enterprise}/Groups": { + delete: operations['actions/delete-environment-secret'] + } + '/scim/v2/enterprises/{enterprise}/Groups': { /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - get: operations["enterprise-admin/list-provisioned-groups-enterprise"]; + get: operations['enterprise-admin/list-provisioned-groups-enterprise'] /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * * Provision an enterprise group, and invite users to the group. This sends invitation emails to the email address of the invited users to join the GitHub organization that the SCIM group corresponds to. */ - post: operations["enterprise-admin/provision-and-invite-enterprise-group"]; - }; - "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": { + post: operations['enterprise-admin/provision-and-invite-enterprise-group'] + } + '/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}': { /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - get: operations["enterprise-admin/get-provisioning-information-for-enterprise-group"]; + get: operations['enterprise-admin/get-provisioning-information-for-enterprise-group'] /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * * Replaces an existing provisioned group’s information. You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead. */ - put: operations["enterprise-admin/set-information-for-provisioned-enterprise-group"]; + put: operations['enterprise-admin/set-information-for-provisioned-enterprise-group'] /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - delete: operations["enterprise-admin/delete-scim-group-from-enterprise"]; + delete: operations['enterprise-admin/delete-scim-group-from-enterprise'] /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * * Allows you to change a provisioned group’s individual attributes. To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). */ - patch: operations["enterprise-admin/update-attribute-for-enterprise-group"]; - }; - "/scim/v2/enterprises/{enterprise}/Users": { + patch: operations['enterprise-admin/update-attribute-for-enterprise-group'] + } + '/scim/v2/enterprises/{enterprise}/Users': { /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * @@ -4703,7 +4703,7 @@ export interface paths { * - If the user signs in, their GitHub account is linked to this entry. * - If the user does not sign in (or does not create a new account when prompted), they are not added to the GitHub enterprise, and the external identity `null` entry remains in place. */ - get: operations["enterprise-admin/list-provisioned-identities-enterprise"]; + get: operations['enterprise-admin/list-provisioned-identities-enterprise'] /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * @@ -4711,11 +4711,11 @@ export interface paths { * * You can optionally include the groups a user will be invited to join. If you do not provide a list of `groups`, the user is provisioned for the enterprise, but no organization invitation emails will be sent. */ - post: operations["enterprise-admin/provision-and-invite-enterprise-user"]; - }; - "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": { + post: operations['enterprise-admin/provision-and-invite-enterprise-user'] + } + '/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}': { /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - get: operations["enterprise-admin/get-provisioning-information-for-enterprise-user"]; + get: operations['enterprise-admin/get-provisioning-information-for-enterprise-user'] /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * @@ -4725,9 +4725,9 @@ export interface paths { * * **Warning:** Setting `active: false` removes the user from the enterprise, deletes the external identity, and deletes the associated `{scim_user_id}`. */ - put: operations["enterprise-admin/set-information-for-provisioned-enterprise-user"]; + put: operations['enterprise-admin/set-information-for-provisioned-enterprise-user'] /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - delete: operations["enterprise-admin/delete-user-from-enterprise"]; + delete: operations['enterprise-admin/delete-user-from-enterprise'] /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * @@ -4748,9 +4748,9 @@ export interface paths { * } * ``` */ - patch: operations["enterprise-admin/update-attribute-for-enterprise-user"]; - }; - "/scim/v2/organizations/{org}/Users": { + patch: operations['enterprise-admin/update-attribute-for-enterprise-user'] + } + '/scim/v2/organizations/{org}/Users': { /** * Retrieves a paginated list of all provisioned organization members, including pending invitations. If you provide the `filter` parameter, the resources for all matching provisions members are returned. * @@ -4769,12 +4769,12 @@ export interface paths { * - If the user signs in, their GitHub account is linked to this entry. * - If the user does not sign in (or does not create a new account when prompted), they are not added to the GitHub organization, and the external identity `null` entry remains in place. */ - get: operations["scim/list-provisioned-identities"]; + get: operations['scim/list-provisioned-identities'] /** Provision organization membership for a user, and send an activation email to the email address. */ - post: operations["scim/provision-and-invite-user"]; - }; - "/scim/v2/organizations/{org}/Users/{scim_user_id}": { - get: operations["scim/get-provisioning-information-for-user"]; + post: operations['scim/provision-and-invite-user'] + } + '/scim/v2/organizations/{org}/Users/{scim_user_id}': { + get: operations['scim/get-provisioning-information-for-user'] /** * Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](https://docs.github.com/rest/reference/scim#update-an-attribute-for-a-scim-user) endpoint instead. * @@ -4782,8 +4782,8 @@ export interface paths { * * **Warning:** Setting `active: false` removes the user from the organization, deletes the external identity, and deletes the associated `{scim_user_id}`. */ - put: operations["scim/set-information-for-provisioned-user"]; - delete: operations["scim/delete-user-from-org"]; + put: operations['scim/set-information-for-provisioned-user'] + delete: operations['scim/delete-user-from-org'] /** * Allows you to change a provisioned user's individual attributes. To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). * @@ -4802,9 +4802,9 @@ export interface paths { * } * ``` */ - patch: operations["scim/update-attribute-for-user"]; - }; - "/search/code": { + patch: operations['scim/update-attribute-for-user'] + } + '/search/code': { /** * Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -4825,9 +4825,9 @@ export interface paths { * * You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing * language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. */ - get: operations["search/code"]; - }; - "/search/commits": { + get: operations['search/code'] + } + '/search/commits': { /** * Find commits via various criteria on the default branch (usually `master`). This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -4838,9 +4838,9 @@ export interface paths { * * `q=repo:octocat/Spoon-Knife+css` */ - get: operations["search/commits"]; - }; - "/search/issues": { + get: operations['search/commits'] + } + '/search/issues': { /** * Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -4855,9 +4855,9 @@ export interface paths { * * **Note:** For [user-to-server](https://docs.github.com/developers/apps/identifying-and-authorizing-users-for-github-apps#user-to-server-requests) GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." */ - get: operations["search/issues-and-pull-requests"]; - }; - "/search/labels": { + get: operations['search/issues-and-pull-requests'] + } + '/search/labels': { /** * Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -4869,9 +4869,9 @@ export interface paths { * * The labels that best match the query appear first in the search results. */ - get: operations["search/labels"]; - }; - "/search/repositories": { + get: operations['search/labels'] + } + '/search/repositories': { /** * Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -4883,9 +4883,9 @@ export interface paths { * * This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results. */ - get: operations["search/repos"]; - }; - "/search/topics": { + get: operations['search/repos'] + } + '/search/topics': { /** * Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers. * @@ -4897,9 +4897,9 @@ export interface paths { * * This query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results. */ - get: operations["search/topics"]; - }; - "/search/users": { + get: operations['search/topics'] + } + '/search/users': { /** * Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -4911,11 +4911,11 @@ export interface paths { * * This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. */ - get: operations["search/users"]; - }; - "/teams/{team_id}": { + get: operations['search/users'] + } + '/teams/{team_id}': { /** **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/reference/teams#get-a-team-by-name) endpoint. */ - get: operations["teams/get-legacy"]; + get: operations['teams/get-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/reference/teams#delete-a-team) endpoint. * @@ -4923,7 +4923,7 @@ export interface paths { * * If you are an organization owner, deleting a parent team will delete all of its child teams as well. */ - delete: operations["teams/delete-legacy"]; + delete: operations['teams/delete-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/reference/teams#update-a-team) endpoint. * @@ -4931,15 +4931,15 @@ export interface paths { * * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. */ - patch: operations["teams/update-legacy"]; - }; - "/teams/{team_id}/discussions": { + patch: operations['teams/update-legacy'] + } + '/teams/{team_id}/discussions': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/reference/teams#list-discussions) endpoint. * * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - get: operations["teams/list-discussions-legacy"]; + get: operations['teams/list-discussions-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/reference/teams#create-a-discussion) endpoint. * @@ -4947,35 +4947,35 @@ export interface paths { * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - post: operations["teams/create-discussion-legacy"]; - }; - "/teams/{team_id}/discussions/{discussion_number}": { + post: operations['teams/create-discussion-legacy'] + } + '/teams/{team_id}/discussions/{discussion_number}': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/reference/teams#get-a-discussion) endpoint. * * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - get: operations["teams/get-discussion-legacy"]; + get: operations['teams/get-discussion-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/reference/teams#delete-a-discussion) endpoint. * * Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - delete: operations["teams/delete-discussion-legacy"]; + delete: operations['teams/delete-discussion-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/reference/teams#update-a-discussion) endpoint. * * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - patch: operations["teams/update-discussion-legacy"]; - }; - "/teams/{team_id}/discussions/{discussion_number}/comments": { + patch: operations['teams/update-discussion-legacy'] + } + '/teams/{team_id}/discussions/{discussion_number}/comments': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/reference/teams#list-discussion-comments) endpoint. * * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - get: operations["teams/list-discussion-comments-legacy"]; + get: operations['teams/list-discussion-comments-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/reference/teams#create-a-discussion-comment) endpoint. * @@ -4983,73 +4983,73 @@ export interface paths { * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - post: operations["teams/create-discussion-comment-legacy"]; - }; - "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": { + post: operations['teams/create-discussion-comment-legacy'] + } + '/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/reference/teams#get-a-discussion-comment) endpoint. * * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - get: operations["teams/get-discussion-comment-legacy"]; + get: operations['teams/get-discussion-comment-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/reference/teams#delete-a-discussion-comment) endpoint. * * Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - delete: operations["teams/delete-discussion-comment-legacy"]; + delete: operations['teams/delete-discussion-comment-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/reference/teams#update-a-discussion-comment) endpoint. * * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - patch: operations["teams/update-discussion-comment-legacy"]; - }; - "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": { + patch: operations['teams/update-discussion-comment-legacy'] + } + '/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * * List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - get: operations["reactions/list-for-team-discussion-comment-legacy"]; + get: operations['reactions/list-for-team-discussion-comment-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. * * Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. */ - post: operations["reactions/create-for-team-discussion-comment-legacy"]; - }; - "/teams/{team_id}/discussions/{discussion_number}/reactions": { + post: operations['reactions/create-for-team-discussion-comment-legacy'] + } + '/teams/{team_id}/discussions/{discussion_number}/reactions': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion) endpoint. * * List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - get: operations["reactions/list-for-team-discussion-legacy"]; + get: operations['reactions/list-for-team-discussion-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion) endpoint. * * Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. */ - post: operations["reactions/create-for-team-discussion-legacy"]; - }; - "/teams/{team_id}/invitations": { + post: operations['reactions/create-for-team-discussion-legacy'] + } + '/teams/{team_id}/invitations': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/reference/teams#list-pending-team-invitations) endpoint. * * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. */ - get: operations["teams/list-pending-invitations-legacy"]; - }; - "/teams/{team_id}/members": { + get: operations['teams/list-pending-invitations-legacy'] + } + '/teams/{team_id}/members': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/reference/teams#list-team-members) endpoint. * * Team members will include the members of child teams. */ - get: operations["teams/list-members-legacy"]; - }; - "/teams/{team_id}/members/{username}": { + get: operations['teams/list-members-legacy'] + } + '/teams/{team_id}/members/{username}': { /** * The "Get team member" endpoint (described below) is deprecated. * @@ -5057,7 +5057,7 @@ export interface paths { * * To list members in a team, the team must be visible to the authenticated user. */ - get: operations["teams/get-member-legacy"]; + get: operations['teams/get-member-legacy'] /** * The "Add team member" endpoint (described below) is deprecated. * @@ -5071,7 +5071,7 @@ export interface paths { * * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - put: operations["teams/add-member-legacy"]; + put: operations['teams/add-member-legacy'] /** * The "Remove team member" endpoint (described below) is deprecated. * @@ -5083,9 +5083,9 @@ export interface paths { * * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ - delete: operations["teams/remove-member-legacy"]; - }; - "/teams/{team_id}/memberships/{username}": { + delete: operations['teams/remove-member-legacy'] + } + '/teams/{team_id}/memberships/{username}': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/reference/teams#get-team-membership-for-a-user) endpoint. * @@ -5098,7 +5098,7 @@ export interface paths { * * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team). */ - get: operations["teams/get-membership-for-user-legacy"]; + get: operations['teams/get-membership-for-user-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint. * @@ -5112,7 +5112,7 @@ export interface paths { * * If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. */ - put: operations["teams/add-or-update-membership-for-user-legacy"]; + put: operations['teams/add-or-update-membership-for-user-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/reference/teams#remove-team-membership-for-a-user) endpoint. * @@ -5122,41 +5122,41 @@ export interface paths { * * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ - delete: operations["teams/remove-membership-for-user-legacy"]; - }; - "/teams/{team_id}/projects": { + delete: operations['teams/remove-membership-for-user-legacy'] + } + '/teams/{team_id}/projects': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/reference/teams#list-team-projects) endpoint. * * Lists the organization projects for a team. */ - get: operations["teams/list-projects-legacy"]; - }; - "/teams/{team_id}/projects/{project_id}": { + get: operations['teams/list-projects-legacy'] + } + '/teams/{team_id}/projects/{project_id}': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/reference/teams#check-team-permissions-for-a-project) endpoint. * * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. */ - get: operations["teams/check-permissions-for-project-legacy"]; + get: operations['teams/check-permissions-for-project-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/reference/teams#add-or-update-team-project-permissions) endpoint. * * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. */ - put: operations["teams/add-or-update-project-permissions-legacy"]; + put: operations['teams/add-or-update-project-permissions-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/reference/teams#remove-a-project-from-a-team) endpoint. * * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. */ - delete: operations["teams/remove-project-legacy"]; - }; - "/teams/{team_id}/repos": { + delete: operations['teams/remove-project-legacy'] + } + '/teams/{team_id}/repos': { /** **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/reference/teams#list-team-repositories) endpoint. */ - get: operations["teams/list-repos-legacy"]; - }; - "/teams/{team_id}/repos/{owner}/{repo}": { + get: operations['teams/list-repos-legacy'] + } + '/teams/{team_id}/repos/{owner}/{repo}': { /** * **Note**: Repositories inherited through a parent team will also be checked. * @@ -5164,7 +5164,7 @@ export interface paths { * * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: */ - get: operations["teams/check-permissions-for-repo-legacy"]; + get: operations['teams/check-permissions-for-repo-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/reference/teams#add-or-update-team-repository-permissions)" endpoint. * @@ -5172,15 +5172,15 @@ export interface paths { * * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - put: operations["teams/add-or-update-repo-permissions-legacy"]; + put: operations['teams/add-or-update-repo-permissions-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/reference/teams#remove-a-repository-from-a-team) endpoint. * * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. */ - delete: operations["teams/remove-repo-legacy"]; - }; - "/teams/{team_id}/team-sync/group-mappings": { + delete: operations['teams/remove-repo-legacy'] + } + '/teams/{team_id}/team-sync/group-mappings': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List IdP groups for a team`](https://docs.github.com/rest/reference/teams#list-idp-groups-for-a-team) endpoint. * @@ -5188,7 +5188,7 @@ export interface paths { * * List IdP groups connected to a team on GitHub. */ - get: operations["teams/list-idp-groups-for-legacy"]; + get: operations['teams/list-idp-groups-for-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create or update IdP group connections`](https://docs.github.com/rest/reference/teams#create-or-update-idp-group-connections) endpoint. * @@ -5196,38 +5196,38 @@ export interface paths { * * Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty `groups` array will remove all connections for a team. */ - patch: operations["teams/create-or-update-idp-group-connections-legacy"]; - }; - "/teams/{team_id}/teams": { + patch: operations['teams/create-or-update-idp-group-connections-legacy'] + } + '/teams/{team_id}/teams': { /** **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/reference/teams#list-child-teams) endpoint. */ - get: operations["teams/list-child-legacy"]; - }; - "/user": { + get: operations['teams/list-child-legacy'] + } + '/user': { /** * If the authenticated user is authenticated through basic authentication or OAuth with the `user` scope, then the response lists public and private profile information. * * If the authenticated user is authenticated through OAuth without the `user` scope, then the response lists only public profile information. */ - get: operations["users/get-authenticated"]; + get: operations['users/get-authenticated'] /** **Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API. */ - patch: operations["users/update-authenticated"]; - }; - "/user/blocks": { + patch: operations['users/update-authenticated'] + } + '/user/blocks': { /** List the users you've blocked on your personal account. */ - get: operations["users/list-blocked-by-authenticated-user"]; - }; - "/user/blocks/{username}": { - get: operations["users/check-blocked"]; - put: operations["users/block"]; - delete: operations["users/unblock"]; - }; - "/user/codespaces": { + get: operations['users/list-blocked-by-authenticated-user'] + } + '/user/blocks/{username}': { + get: operations['users/check-blocked'] + put: operations['users/block'] + delete: operations['users/unblock'] + } + '/user/codespaces': { /** * Lists the authenticated user's codespaces. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - get: operations["codespaces/list-for-authenticated-user"]; + get: operations['codespaces/list-for-authenticated-user'] /** * Creates a new codespace, owned by the authenticated user. * @@ -5235,26 +5235,26 @@ export interface paths { * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - post: operations["codespaces/create-for-authenticated-user"]; - }; - "/user/codespaces/secrets": { + post: operations['codespaces/create-for-authenticated-user'] + } + '/user/codespaces/secrets': { /** * Lists all secrets available for a user's Codespaces without revealing their * encrypted values. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - get: operations["codespaces/list-secrets-for-authenticated-user"]; - }; - "/user/codespaces/secrets/public-key": { + get: operations['codespaces/list-secrets-for-authenticated-user'] + } + '/user/codespaces/secrets/public-key': { /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with one of the 'read:user' or 'user' scopes in their personal access token. User must have Codespaces access to use this endpoint. */ - get: operations["codespaces/get-public-key-for-authenticated-user"]; - }; - "/user/codespaces/secrets/{secret_name}": { + get: operations['codespaces/get-public-key-for-authenticated-user'] + } + '/user/codespaces/secrets/{secret_name}': { /** * Gets a secret available to a user's codespaces without revealing its encrypted value. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - get: operations["codespaces/get-secret-for-authenticated-user"]; + get: operations['codespaces/get-secret-for-authenticated-user'] /** * Creates or updates a secret for a user's codespace with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access token with the `user` scope to use this endpoint. User must also have Codespaces access to use this endpoint. @@ -5330,47 +5330,47 @@ export interface paths { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - put: operations["codespaces/create-or-update-secret-for-authenticated-user"]; + put: operations['codespaces/create-or-update-secret-for-authenticated-user'] /** Deletes a secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret. You must authenticate using an access token with the `user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - delete: operations["codespaces/delete-secret-for-authenticated-user"]; - }; - "/user/codespaces/secrets/{secret_name}/repositories": { + delete: operations['codespaces/delete-secret-for-authenticated-user'] + } + '/user/codespaces/secrets/{secret_name}/repositories': { /** * List the repositories that have been granted the ability to use a user's codespace secret. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - get: operations["codespaces/list-repositories-for-secret-for-authenticated-user"]; + get: operations['codespaces/list-repositories-for-secret-for-authenticated-user'] /** * Select the repositories that will use a user's codespace secret. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - put: operations["codespaces/set-repositories-for-secret-for-authenticated-user"]; - }; - "/user/codespaces/secrets/{secret_name}/repositories/{repository_id}": { + put: operations['codespaces/set-repositories-for-secret-for-authenticated-user'] + } + '/user/codespaces/secrets/{secret_name}/repositories/{repository_id}': { /** * Adds a repository to the selected repositories for a user's codespace secret. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - put: operations["codespaces/add-repository-for-secret-for-authenticated-user"]; + put: operations['codespaces/add-repository-for-secret-for-authenticated-user'] /** * Removes a repository from the selected repositories for a user's codespace secret. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - delete: operations["codespaces/remove-repository-for-secret-for-authenticated-user"]; - }; - "/user/codespaces/{codespace_name}": { + delete: operations['codespaces/remove-repository-for-secret-for-authenticated-user'] + } + '/user/codespaces/{codespace_name}': { /** * Gets information about a user's codespace. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - get: operations["codespaces/get-for-authenticated-user"]; + get: operations['codespaces/get-for-authenticated-user'] /** * Deletes a user's codespace. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - delete: operations["codespaces/delete-for-authenticated-user"]; + delete: operations['codespaces/delete-for-authenticated-user'] /** * Updates a codespace owned by the authenticated user. Currently only the codespace's machine type and recent folders can be modified using this endpoint. * @@ -5378,92 +5378,92 @@ export interface paths { * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - patch: operations["codespaces/update-for-authenticated-user"]; - }; - "/user/codespaces/{codespace_name}/exports": { + patch: operations['codespaces/update-for-authenticated-user'] + } + '/user/codespaces/{codespace_name}/exports': { /** * Triggers an export of the specified codespace and returns a URL and ID where the status of the export can be monitored. * * You must authenticate using a personal access token with the `codespace` scope to use this endpoint. */ - post: operations["codespaces/export-for-authenticated-user"]; - }; - "/user/codespaces/{codespace_name}/exports/{export_id}": { + post: operations['codespaces/export-for-authenticated-user'] + } + '/user/codespaces/{codespace_name}/exports/{export_id}': { /** * Gets information about an export of a codespace. * * You must authenticate using a personal access token with the `codespace` scope to use this endpoint. */ - get: operations["codespaces/get-export-details-for-authenticated-user"]; - }; - "/user/codespaces/{codespace_name}/machines": { + get: operations['codespaces/get-export-details-for-authenticated-user'] + } + '/user/codespaces/{codespace_name}/machines': { /** * List the machine types a codespace can transition to use. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - get: operations["codespaces/codespace-machines-for-authenticated-user"]; - }; - "/user/codespaces/{codespace_name}/start": { + get: operations['codespaces/codespace-machines-for-authenticated-user'] + } + '/user/codespaces/{codespace_name}/start': { /** * Starts a user's codespace. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - post: operations["codespaces/start-for-authenticated-user"]; - }; - "/user/codespaces/{codespace_name}/stop": { + post: operations['codespaces/start-for-authenticated-user'] + } + '/user/codespaces/{codespace_name}/stop': { /** * Stops a user's codespace. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - post: operations["codespaces/stop-for-authenticated-user"]; - }; - "/user/email/visibility": { + post: operations['codespaces/stop-for-authenticated-user'] + } + '/user/email/visibility': { /** Sets the visibility for your primary email addresses. */ - patch: operations["users/set-primary-email-visibility-for-authenticated-user"]; - }; - "/user/emails": { + patch: operations['users/set-primary-email-visibility-for-authenticated-user'] + } + '/user/emails': { /** Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope. */ - get: operations["users/list-emails-for-authenticated-user"]; + get: operations['users/list-emails-for-authenticated-user'] /** This endpoint is accessible with the `user` scope. */ - post: operations["users/add-email-for-authenticated-user"]; + post: operations['users/add-email-for-authenticated-user'] /** This endpoint is accessible with the `user` scope. */ - delete: operations["users/delete-email-for-authenticated-user"]; - }; - "/user/followers": { + delete: operations['users/delete-email-for-authenticated-user'] + } + '/user/followers': { /** Lists the people following the authenticated user. */ - get: operations["users/list-followers-for-authenticated-user"]; - }; - "/user/following": { + get: operations['users/list-followers-for-authenticated-user'] + } + '/user/following': { /** Lists the people who the authenticated user follows. */ - get: operations["users/list-followed-by-authenticated-user"]; - }; - "/user/following/{username}": { - get: operations["users/check-person-is-followed-by-authenticated"]; + get: operations['users/list-followed-by-authenticated-user'] + } + '/user/following/{username}': { + get: operations['users/check-person-is-followed-by-authenticated'] /** * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." * * Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. */ - put: operations["users/follow"]; + put: operations['users/follow'] /** Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. */ - delete: operations["users/unfollow"]; - }; - "/user/gpg_keys": { + delete: operations['users/unfollow'] + } + '/user/gpg_keys': { /** Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - get: operations["users/list-gpg-keys-for-authenticated-user"]; + get: operations['users/list-gpg-keys-for-authenticated-user'] /** Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - post: operations["users/create-gpg-key-for-authenticated-user"]; - }; - "/user/gpg_keys/{gpg_key_id}": { + post: operations['users/create-gpg-key-for-authenticated-user'] + } + '/user/gpg_keys/{gpg_key_id}': { /** View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - get: operations["users/get-gpg-key-for-authenticated-user"]; + get: operations['users/get-gpg-key-for-authenticated-user'] /** Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - delete: operations["users/delete-gpg-key-for-authenticated-user"]; - }; - "/user/installations": { + delete: operations['users/delete-gpg-key-for-authenticated-user'] + } + '/user/installations': { /** * Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. * @@ -5473,9 +5473,9 @@ export interface paths { * * You can find the permissions for the installation under the `permissions` key. */ - get: operations["apps/list-installations-for-authenticated-user"]; - }; - "/user/installations/{installation_id}/repositories": { + get: operations['apps/list-installations-for-authenticated-user'] + } + '/user/installations/{installation_id}/repositories': { /** * List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation. * @@ -5485,31 +5485,31 @@ export interface paths { * * The access the user has to each repository is included in the hash under the `permissions` key. */ - get: operations["apps/list-installation-repos-for-authenticated-user"]; - }; - "/user/installations/{installation_id}/repositories/{repository_id}": { + get: operations['apps/list-installation-repos-for-authenticated-user'] + } + '/user/installations/{installation_id}/repositories/{repository_id}': { /** * Add a single repository to an installation. The authenticated user must have admin access to the repository. * * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. */ - put: operations["apps/add-repo-to-installation-for-authenticated-user"]; + put: operations['apps/add-repo-to-installation-for-authenticated-user'] /** * Remove a single repository from an installation. The authenticated user must have admin access to the repository. * * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. */ - delete: operations["apps/remove-repo-from-installation-for-authenticated-user"]; - }; - "/user/interaction-limits": { + delete: operations['apps/remove-repo-from-installation-for-authenticated-user'] + } + '/user/interaction-limits': { /** Shows which type of GitHub user can interact with your public repositories and when the restriction expires. */ - get: operations["interactions/get-restrictions-for-authenticated-user"]; + get: operations['interactions/get-restrictions-for-authenticated-user'] /** Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user. */ - put: operations["interactions/set-restrictions-for-authenticated-user"]; + put: operations['interactions/set-restrictions-for-authenticated-user'] /** Removes any interaction restrictions from your public repositories. */ - delete: operations["interactions/remove-restrictions-for-authenticated-user"]; - }; - "/user/issues": { + delete: operations['interactions/remove-restrictions-for-authenticated-user'] + } + '/user/issues': { /** * List issues across owned and member repositories assigned to the authenticated user. * @@ -5518,42 +5518,42 @@ export interface paths { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - get: operations["issues/list-for-authenticated-user"]; - }; - "/user/keys": { + get: operations['issues/list-for-authenticated-user'] + } + '/user/keys': { /** Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - get: operations["users/list-public-ssh-keys-for-authenticated-user"]; + get: operations['users/list-public-ssh-keys-for-authenticated-user'] /** Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - post: operations["users/create-public-ssh-key-for-authenticated-user"]; - }; - "/user/keys/{key_id}": { + post: operations['users/create-public-ssh-key-for-authenticated-user'] + } + '/user/keys/{key_id}': { /** View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - get: operations["users/get-public-ssh-key-for-authenticated-user"]; + get: operations['users/get-public-ssh-key-for-authenticated-user'] /** Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - delete: operations["users/delete-public-ssh-key-for-authenticated-user"]; - }; - "/user/marketplace_purchases": { + delete: operations['users/delete-public-ssh-key-for-authenticated-user'] + } + '/user/marketplace_purchases': { /** Lists the active subscriptions for the authenticated user. You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an [OAuth token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/). */ - get: operations["apps/list-subscriptions-for-authenticated-user"]; - }; - "/user/marketplace_purchases/stubbed": { + get: operations['apps/list-subscriptions-for-authenticated-user'] + } + '/user/marketplace_purchases/stubbed': { /** Lists the active subscriptions for the authenticated user. You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an [OAuth token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/). */ - get: operations["apps/list-subscriptions-for-authenticated-user-stubbed"]; - }; - "/user/memberships/orgs": { - get: operations["orgs/list-memberships-for-authenticated-user"]; - }; - "/user/memberships/orgs/{org}": { - get: operations["orgs/get-membership-for-authenticated-user"]; - patch: operations["orgs/update-membership-for-authenticated-user"]; - }; - "/user/migrations": { + get: operations['apps/list-subscriptions-for-authenticated-user-stubbed'] + } + '/user/memberships/orgs': { + get: operations['orgs/list-memberships-for-authenticated-user'] + } + '/user/memberships/orgs/{org}': { + get: operations['orgs/get-membership-for-authenticated-user'] + patch: operations['orgs/update-membership-for-authenticated-user'] + } + '/user/migrations': { /** Lists all migrations a user has started. */ - get: operations["migrations/list-for-authenticated-user"]; + get: operations['migrations/list-for-authenticated-user'] /** Initiates the generation of a user migration archive. */ - post: operations["migrations/start-for-authenticated-user"]; - }; - "/user/migrations/{migration_id}": { + post: operations['migrations/start-for-authenticated-user'] + } + '/user/migrations/{migration_id}': { /** * Fetches a single user migration. The response includes the `state` of the migration, which can be one of the following values: * @@ -5564,9 +5564,9 @@ export interface paths { * * Once the migration has been `exported` you can [download the migration archive](https://docs.github.com/rest/reference/migrations#download-a-user-migration-archive). */ - get: operations["migrations/get-status-for-authenticated-user"]; - }; - "/user/migrations/{migration_id}/archive": { + get: operations['migrations/get-status-for-authenticated-user'] + } + '/user/migrations/{migration_id}/archive': { /** * Fetches the URL to download the migration archive as a `tar.gz` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects: * @@ -5590,19 +5590,19 @@ export interface paths { * * The archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data. */ - get: operations["migrations/get-archive-for-authenticated-user"]; + get: operations['migrations/get-archive-for-authenticated-user'] /** Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the [List user migrations](https://docs.github.com/rest/reference/migrations#list-user-migrations) and [Get a user migration status](https://docs.github.com/rest/reference/migrations#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted. */ - delete: operations["migrations/delete-archive-for-authenticated-user"]; - }; - "/user/migrations/{migration_id}/repos/{repo_name}/lock": { + delete: operations['migrations/delete-archive-for-authenticated-user'] + } + '/user/migrations/{migration_id}/repos/{repo_name}/lock': { /** Unlocks a repository. You can lock repositories when you [start a user migration](https://docs.github.com/rest/reference/migrations#start-a-user-migration). Once the migration is complete you can unlock each repository to begin using it again or [delete the repository](https://docs.github.com/rest/reference/repos#delete-a-repository) if you no longer need the source data. Returns a status of `404 Not Found` if the repository is not locked. */ - delete: operations["migrations/unlock-repo-for-authenticated-user"]; - }; - "/user/migrations/{migration_id}/repositories": { + delete: operations['migrations/unlock-repo-for-authenticated-user'] + } + '/user/migrations/{migration_id}/repositories': { /** Lists all the repositories for this user migration. */ - get: operations["migrations/list-repos-for-authenticated-user"]; - }; - "/user/orgs": { + get: operations['migrations/list-repos-for-authenticated-user'] + } + '/user/orgs': { /** * List organizations for the authenticated user. * @@ -5610,34 +5610,34 @@ export interface paths { * * This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response. */ - get: operations["orgs/list-for-authenticated-user"]; - }; - "/user/packages": { + get: operations['orgs/list-for-authenticated-user'] + } + '/user/packages': { /** * Lists packages owned by the authenticated user within the user's namespace. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/list-packages-for-authenticated-user"]; - }; - "/user/packages/{package_type}/{package_name}": { + get: operations['packages/list-packages-for-authenticated-user'] + } + '/user/packages/{package_type}/{package_name}': { /** * Gets a specific package for a package owned by the authenticated user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/get-package-for-authenticated-user"]; + get: operations['packages/get-package-for-authenticated-user'] /** * Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:delete` scopes. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - delete: operations["packages/delete-package-for-authenticated-user"]; - }; - "/user/packages/{package_type}/{package_name}/restore": { + delete: operations['packages/delete-package-for-authenticated-user'] + } + '/user/packages/{package_type}/{package_name}/restore': { /** * Restores a package owned by the authenticated user. * @@ -5647,34 +5647,34 @@ export interface paths { * * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. If `package_type` is not `container`, your token must also include the `repo` scope. */ - post: operations["packages/restore-package-for-authenticated-user"]; - }; - "/user/packages/{package_type}/{package_name}/versions": { + post: operations['packages/restore-package-for-authenticated-user'] + } + '/user/packages/{package_type}/{package_name}/versions': { /** * Returns all package versions for a package owned by the authenticated user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/get-all-package-versions-for-package-owned-by-authenticated-user"]; - }; - "/user/packages/{package_type}/{package_name}/versions/{package_version_id}": { + get: operations['packages/get-all-package-versions-for-package-owned-by-authenticated-user'] + } + '/user/packages/{package_type}/{package_name}/versions/{package_version_id}': { /** * Gets a specific package version for a package owned by the authenticated user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/get-package-version-for-authenticated-user"]; + get: operations['packages/get-package-version-for-authenticated-user'] /** * Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:delete` scopes. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - delete: operations["packages/delete-package-version-for-authenticated-user"]; - }; - "/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { + delete: operations['packages/delete-package-version-for-authenticated-user'] + } + '/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore': { /** * Restores a package version owned by the authenticated user. * @@ -5684,22 +5684,22 @@ export interface paths { * * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. If `package_type` is not `container`, your token must also include the `repo` scope. */ - post: operations["packages/restore-package-version-for-authenticated-user"]; - }; - "/user/projects": { - post: operations["projects/create-for-authenticated-user"]; - }; - "/user/public_emails": { + post: operations['packages/restore-package-version-for-authenticated-user'] + } + '/user/projects': { + post: operations['projects/create-for-authenticated-user'] + } + '/user/public_emails': { /** Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope. */ - get: operations["users/list-public-emails-for-authenticated-user"]; - }; - "/user/repos": { + get: operations['users/list-public-emails-for-authenticated-user'] + } + '/user/repos': { /** * Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. * * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. */ - get: operations["repos/list-for-authenticated-user"]; + get: operations['repos/list-for-authenticated-user'] /** * Creates a new repository for the authenticated user. * @@ -5710,47 +5710,47 @@ export interface paths { * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. * * `repo` scope to create a private repository. */ - post: operations["repos/create-for-authenticated-user"]; - }; - "/user/repository_invitations": { + post: operations['repos/create-for-authenticated-user'] + } + '/user/repository_invitations': { /** When authenticating as a user, this endpoint will list all currently open repository invitations for that user. */ - get: operations["repos/list-invitations-for-authenticated-user"]; - }; - "/user/repository_invitations/{invitation_id}": { - delete: operations["repos/decline-invitation-for-authenticated-user"]; - patch: operations["repos/accept-invitation-for-authenticated-user"]; - }; - "/user/starred": { + get: operations['repos/list-invitations-for-authenticated-user'] + } + '/user/repository_invitations/{invitation_id}': { + delete: operations['repos/decline-invitation-for-authenticated-user'] + patch: operations['repos/accept-invitation-for-authenticated-user'] + } + '/user/starred': { /** * Lists repositories the authenticated user has starred. * * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: */ - get: operations["activity/list-repos-starred-by-authenticated-user"]; - }; - "/user/starred/{owner}/{repo}": { - get: operations["activity/check-repo-is-starred-by-authenticated-user"]; + get: operations['activity/list-repos-starred-by-authenticated-user'] + } + '/user/starred/{owner}/{repo}': { + get: operations['activity/check-repo-is-starred-by-authenticated-user'] /** Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - put: operations["activity/star-repo-for-authenticated-user"]; - delete: operations["activity/unstar-repo-for-authenticated-user"]; - }; - "/user/subscriptions": { + put: operations['activity/star-repo-for-authenticated-user'] + delete: operations['activity/unstar-repo-for-authenticated-user'] + } + '/user/subscriptions': { /** Lists repositories the authenticated user is watching. */ - get: operations["activity/list-watched-repos-for-authenticated-user"]; - }; - "/user/teams": { + get: operations['activity/list-watched-repos-for-authenticated-user'] + } + '/user/teams': { /** List all of the teams across all of the organizations to which the authenticated user belongs. This method requires `user`, `repo`, or `read:org` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://docs.github.com/apps/building-oauth-apps/). */ - get: operations["teams/list-for-authenticated-user"]; - }; - "/users": { + get: operations['teams/list-for-authenticated-user'] + } + '/users': { /** * Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts. * * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of users. */ - get: operations["users/list"]; - }; - "/users/{username}": { + get: operations['users/list'] + } + '/users/{username}': { /** * Provides publicly available information about someone with a GitHub account. * @@ -5760,39 +5760,39 @@ export interface paths { * * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/reference/users#emails)". */ - get: operations["users/get-by-username"]; - }; - "/users/{username}/events": { + get: operations['users/get-by-username'] + } + '/users/{username}/events': { /** If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. */ - get: operations["activity/list-events-for-authenticated-user"]; - }; - "/users/{username}/events/orgs/{org}": { + get: operations['activity/list-events-for-authenticated-user'] + } + '/users/{username}/events/orgs/{org}': { /** This is the user's organization dashboard. You must be authenticated as the user to view this. */ - get: operations["activity/list-org-events-for-authenticated-user"]; - }; - "/users/{username}/events/public": { - get: operations["activity/list-public-events-for-user"]; - }; - "/users/{username}/followers": { + get: operations['activity/list-org-events-for-authenticated-user'] + } + '/users/{username}/events/public': { + get: operations['activity/list-public-events-for-user'] + } + '/users/{username}/followers': { /** Lists the people following the specified user. */ - get: operations["users/list-followers-for-user"]; - }; - "/users/{username}/following": { + get: operations['users/list-followers-for-user'] + } + '/users/{username}/following': { /** Lists the people who the specified user follows. */ - get: operations["users/list-following-for-user"]; - }; - "/users/{username}/following/{target_user}": { - get: operations["users/check-following-for-user"]; - }; - "/users/{username}/gists": { + get: operations['users/list-following-for-user'] + } + '/users/{username}/following/{target_user}': { + get: operations['users/check-following-for-user'] + } + '/users/{username}/gists': { /** Lists public gists for the specified user: */ - get: operations["gists/list-for-user"]; - }; - "/users/{username}/gpg_keys": { + get: operations['gists/list-for-user'] + } + '/users/{username}/gpg_keys': { /** Lists the GPG keys for a user. This information is accessible by anyone. */ - get: operations["users/list-gpg-keys-for-user"]; - }; - "/users/{username}/hovercard": { + get: operations['users/list-gpg-keys-for-user'] + } + '/users/{username}/hovercard': { /** * Provides hovercard information when authenticated through basic auth or OAuth with the `repo` scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. * @@ -5803,45 +5803,45 @@ export interface paths { * https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 * ``` */ - get: operations["users/get-context-for-user"]; - }; - "/users/{username}/installation": { + get: operations['users/get-context-for-user'] + } + '/users/{username}/installation': { /** * Enables an authenticated GitHub App to find the user’s installation information. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - get: operations["apps/get-user-installation"]; - }; - "/users/{username}/keys": { + get: operations['apps/get-user-installation'] + } + '/users/{username}/keys': { /** Lists the _verified_ public SSH keys for a user. This is accessible by anyone. */ - get: operations["users/list-public-keys-for-user"]; - }; - "/users/{username}/orgs": { + get: operations['users/list-public-keys-for-user'] + } + '/users/{username}/orgs': { /** * List [public organization memberships](https://docs.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user. * * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/rest/reference/orgs#list-organizations-for-the-authenticated-user) API instead. */ - get: operations["orgs/list-for-user"]; - }; - "/users/{username}/packages": { + get: operations['orgs/list-for-user'] + } + '/users/{username}/packages': { /** * Lists all packages in a user's namespace for which the requesting user has access. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/list-packages-for-user"]; - }; - "/users/{username}/packages/{package_type}/{package_name}": { + get: operations['packages/list-packages-for-user'] + } + '/users/{username}/packages/{package_type}/{package_name}': { /** * Gets a specific package metadata for a public package owned by a user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/get-package-for-user"]; + get: operations['packages/get-package-for-user'] /** * Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * @@ -5849,9 +5849,9 @@ export interface paths { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. */ - delete: operations["packages/delete-package-for-user"]; - }; - "/users/{username}/packages/{package_type}/{package_name}/restore": { + delete: operations['packages/delete-package-for-user'] + } + '/users/{username}/packages/{package_type}/{package_name}/restore': { /** * Restores an entire package for a user. * @@ -5863,25 +5863,25 @@ export interface paths { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. */ - post: operations["packages/restore-package-for-user"]; - }; - "/users/{username}/packages/{package_type}/{package_name}/versions": { + post: operations['packages/restore-package-for-user'] + } + '/users/{username}/packages/{package_type}/{package_name}/versions': { /** * Returns all package versions for a public package owned by a specified user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/get-all-package-versions-for-package-owned-by-user"]; - }; - "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}": { + get: operations['packages/get-all-package-versions-for-package-owned-by-user'] + } + '/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}': { /** * Gets a specific package version for a public package owned by a specified user. * * At this time, to use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/get-package-version-for-user"]; + get: operations['packages/get-package-version-for-user'] /** * Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * @@ -5889,9 +5889,9 @@ export interface paths { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. */ - delete: operations["packages/delete-package-version-for-user"]; - }; - "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { + delete: operations['packages/delete-package-version-for-user'] + } + '/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore': { /** * Restores a specific package version for a user. * @@ -5903,23 +5903,23 @@ export interface paths { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. */ - post: operations["packages/restore-package-version-for-user"]; - }; - "/users/{username}/projects": { - get: operations["projects/list-for-user"]; - }; - "/users/{username}/received_events": { + post: operations['packages/restore-package-version-for-user'] + } + '/users/{username}/projects': { + get: operations['projects/list-for-user'] + } + '/users/{username}/received_events': { /** These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. */ - get: operations["activity/list-received-events-for-user"]; - }; - "/users/{username}/received_events/public": { - get: operations["activity/list-received-public-events-for-user"]; - }; - "/users/{username}/repos": { + get: operations['activity/list-received-events-for-user'] + } + '/users/{username}/received_events/public': { + get: operations['activity/list-received-public-events-for-user'] + } + '/users/{username}/repos': { /** Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user. */ - get: operations["repos/list-for-user"]; - }; - "/users/{username}/settings/billing/actions": { + get: operations['repos/list-for-user'] + } + '/users/{username}/settings/billing/actions': { /** * Gets the summary of the free and paid GitHub Actions minutes used. * @@ -5927,9 +5927,9 @@ export interface paths { * * Access tokens must have the `user` scope. */ - get: operations["billing/get-github-actions-billing-user"]; - }; - "/users/{username}/settings/billing/packages": { + get: operations['billing/get-github-actions-billing-user'] + } + '/users/{username}/settings/billing/packages': { /** * Gets the free and paid storage used for GitHub Packages in gigabytes. * @@ -5937,9 +5937,9 @@ export interface paths { * * Access tokens must have the `user` scope. */ - get: operations["billing/get-github-packages-billing-user"]; - }; - "/users/{username}/settings/billing/shared-storage": { + get: operations['billing/get-github-packages-billing-user'] + } + '/users/{username}/settings/billing/shared-storage': { /** * Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. * @@ -5947,24 +5947,24 @@ export interface paths { * * Access tokens must have the `user` scope. */ - get: operations["billing/get-shared-storage-billing-user"]; - }; - "/users/{username}/starred": { + get: operations['billing/get-shared-storage-billing-user'] + } + '/users/{username}/starred': { /** * Lists repositories a user has starred. * * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: */ - get: operations["activity/list-repos-starred-by-user"]; - }; - "/users/{username}/subscriptions": { + get: operations['activity/list-repos-starred-by-user'] + } + '/users/{username}/subscriptions': { /** Lists repositories a user is watching. */ - get: operations["activity/list-repos-watched-by-user"]; - }; - "/zen": { + get: operations['activity/list-repos-watched-by-user'] + } + '/zen': { /** Get a random sentence from the Zen of GitHub */ - get: operations["meta/get-zen"]; - }; + get: operations['meta/get-zen'] + } } export interface components { @@ -5973,71 +5973,71 @@ export interface components { * Simple User * @description Simple User */ - "nullable-simple-user": { - name?: string | null; - email?: string | null; + 'nullable-simple-user': { + name?: string | null + email?: string | null /** @example octocat */ - login: string; + login: string /** @example 1 */ - id: number; + id: number /** @example MDQ6VXNlcjE= */ - node_id: string; + node_id: string /** * Format: uri * @example https://github.com/images/error/octocat_happy.gif */ - avatar_url: string; + avatar_url: string /** @example 41d064eb2195891e12d0413f63227ea7 */ - gravatar_id: string | null; + gravatar_id: string | null /** * Format: uri * @example https://api.github.com/users/octocat */ - url: string; + url: string /** * Format: uri * @example https://github.com/octocat */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/users/octocat/followers */ - followers_url: string; + followers_url: string /** @example https://api.github.com/users/octocat/following{/other_user} */ - following_url: string; + following_url: string /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - gists_url: string; + gists_url: string /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - starred_url: string; + starred_url: string /** * Format: uri * @example https://api.github.com/users/octocat/subscriptions */ - subscriptions_url: string; + subscriptions_url: string /** * Format: uri * @example https://api.github.com/users/octocat/orgs */ - organizations_url: string; + organizations_url: string /** * Format: uri * @example https://api.github.com/users/octocat/repos */ - repos_url: string; + repos_url: string /** @example https://api.github.com/users/octocat/events{/privacy} */ - events_url: string; + events_url: string /** * Format: uri * @example https://api.github.com/users/octocat/received_events */ - received_events_url: string; + received_events_url: string /** @example User */ - type: string; - site_admin: boolean; + type: string + site_admin: boolean /** @example "2020-07-09T00:17:55Z" */ - starred_at?: string; - } | null; + starred_at?: string + } | null /** * GitHub app * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. @@ -6047,554 +6047,554 @@ export interface components { * @description Unique identifier of the GitHub app * @example 37 */ - id: number; + id: number /** * @description The slug name of the GitHub app * @example probot-owners */ - slug?: string; + slug?: string /** @example MDExOkludGVncmF0aW9uMQ== */ - node_id: string; - owner: components["schemas"]["nullable-simple-user"]; + node_id: string + owner: components['schemas']['nullable-simple-user'] /** * @description The name of the GitHub app * @example Probot Owners */ - name: string; + name: string /** @example The description of the app. */ - description: string | null; + description: string | null /** * Format: uri * @example https://example.com */ - external_url: string; + external_url: string /** * Format: uri * @example https://github.com/apps/super-ci */ - html_url: string; + html_url: string /** * Format: date-time * @example 2017-07-08T16:18:44-04:00 */ - created_at: string; + created_at: string /** * Format: date-time * @example 2017-07-08T16:18:44-04:00 */ - updated_at: string; + updated_at: string /** * @description The set of permissions for the GitHub app * @example [object Object] */ permissions: { - issues?: string; - checks?: string; - metadata?: string; - contents?: string; - deployments?: string; - } & { [key: string]: string }; + issues?: string + checks?: string + metadata?: string + contents?: string + deployments?: string + } & { [key: string]: string } /** * @description The list of events for the GitHub app * @example label,deployment */ - events: string[]; + events: string[] /** * @description The number of installations associated with the GitHub app * @example 5 */ - installations_count?: number; + installations_count?: number /** @example "Iv1.25b5d1e65ffc4022" */ - client_id?: string; + client_id?: string /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ - client_secret?: string; + client_secret?: string /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ - webhook_secret?: string | null; + webhook_secret?: string | null /** @example "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n" */ - pem?: string; - }; + pem?: string + } /** * Basic Error * @description Basic Error */ - "basic-error": { - message?: string; - documentation_url?: string; - url?: string; - status?: string; - }; + 'basic-error': { + message?: string + documentation_url?: string + url?: string + status?: string + } /** * Validation Error Simple * @description Validation Error Simple */ - "validation-error-simple": { - message: string; - documentation_url: string; - errors?: string[]; - }; + 'validation-error-simple': { + message: string + documentation_url: string + errors?: string[] + } /** * Format: uri * @description The URL to which the payloads will be delivered. * @example https://example.com/webhook */ - "webhook-config-url": string; + 'webhook-config-url': string /** * @description The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`. * @example "json" */ - "webhook-config-content-type": string; + 'webhook-config-content-type': string /** * @description If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers). * @example "********" */ - "webhook-config-secret": string; - "webhook-config-insecure-ssl": string | number; + 'webhook-config-secret': string + 'webhook-config-insecure-ssl': string | number /** * Webhook Configuration * @description Configuration object of the webhook */ - "webhook-config": { - url?: components["schemas"]["webhook-config-url"]; - content_type?: components["schemas"]["webhook-config-content-type"]; - secret?: components["schemas"]["webhook-config-secret"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - }; + 'webhook-config': { + url?: components['schemas']['webhook-config-url'] + content_type?: components['schemas']['webhook-config-content-type'] + secret?: components['schemas']['webhook-config-secret'] + insecure_ssl?: components['schemas']['webhook-config-insecure-ssl'] + } /** * Simple webhook delivery * @description Delivery made by a webhook, without request and response information. */ - "hook-delivery-item": { + 'hook-delivery-item': { /** * @description Unique identifier of the webhook delivery. * @example 42 */ - id: number; + id: number /** * @description Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event). * @example 58474f00-b361-11eb-836d-0e4f3503ccbe */ - guid: string; + guid: string /** * Format: date-time * @description Time when the webhook delivery occurred. * @example 2021-05-12T20:33:44Z */ - delivered_at: string; + delivered_at: string /** @description Whether the webhook delivery is a redelivery. */ - redelivery: boolean; + redelivery: boolean /** * @description Time spent delivering. * @example 0.03 */ - duration: number; + duration: number /** * @description Describes the response returned after attempting the delivery. * @example failed to connect */ - status: string; + status: string /** * @description Status code received when delivery was made. * @example 502 */ - status_code: number; + status_code: number /** * @description The event that triggered the delivery. * @example issues */ - event: string; + event: string /** * @description The type of activity for the event that triggered the delivery. * @example opened */ - action: string | null; + action: string | null /** * @description The id of the GitHub App installation associated with this event. * @example 123 */ - installation_id: number | null; + installation_id: number | null /** * @description The id of the repository associated with this event. * @example 123 */ - repository_id: number | null; - }; + repository_id: number | null + } /** * Scim Error * @description Scim Error */ - "scim-error": { - message?: string | null; - documentation_url?: string | null; - detail?: string | null; - status?: number; - scimType?: string | null; - schemas?: string[]; - }; + 'scim-error': { + message?: string | null + documentation_url?: string | null + detail?: string | null + status?: number + scimType?: string | null + schemas?: string[] + } /** * Validation Error * @description Validation Error */ - "validation-error": { - message: string; - documentation_url: string; + 'validation-error': { + message: string + documentation_url: string errors?: { - resource?: string; - field?: string; - message?: string; - code: string; - index?: number; - value?: (string | null) | (number | null) | (string[] | null); - }[]; - }; + resource?: string + field?: string + message?: string + code: string + index?: number + value?: (string | null) | (number | null) | (string[] | null) + }[] + } /** * Webhook delivery * @description Delivery made by a webhook. */ - "hook-delivery": { + 'hook-delivery': { /** * @description Unique identifier of the delivery. * @example 42 */ - id: number; + id: number /** * @description Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event). * @example 58474f00-b361-11eb-836d-0e4f3503ccbe */ - guid: string; + guid: string /** * Format: date-time * @description Time when the delivery was delivered. * @example 2021-05-12T20:33:44Z */ - delivered_at: string; + delivered_at: string /** @description Whether the delivery is a redelivery. */ - redelivery: boolean; + redelivery: boolean /** * @description Time spent delivering. * @example 0.03 */ - duration: number; + duration: number /** * @description Description of the status of the attempted delivery * @example failed to connect */ - status: string; + status: string /** * @description Status code received when delivery was made. * @example 502 */ - status_code: number; + status_code: number /** * @description The event that triggered the delivery. * @example issues */ - event: string; + event: string /** * @description The type of activity for the event that triggered the delivery. * @example opened */ - action: string | null; + action: string | null /** * @description The id of the GitHub App installation associated with this event. * @example 123 */ - installation_id: number | null; + installation_id: number | null /** * @description The id of the repository associated with this event. * @example 123 */ - repository_id: number | null; + repository_id: number | null /** * @description The URL target of the delivery. * @example https://www.example.com */ - url?: string; + url?: string request: { /** @description The request headers sent with the webhook delivery. */ - headers: { [key: string]: unknown } | null; + headers: { [key: string]: unknown } | null /** @description The webhook payload. */ - payload: { [key: string]: unknown } | null; - }; + payload: { [key: string]: unknown } | null + } response: { /** @description The response headers received when the delivery was made. */ - headers: { [key: string]: unknown } | null; + headers: { [key: string]: unknown } | null /** @description The response payload received. */ - payload: string | null; - }; - }; + payload: string | null + } + } /** * Simple User * @description Simple User */ - "simple-user": { - name?: string | null; - email?: string | null; + 'simple-user': { + name?: string | null + email?: string | null /** @example octocat */ - login: string; + login: string /** @example 1 */ - id: number; + id: number /** @example MDQ6VXNlcjE= */ - node_id: string; + node_id: string /** * Format: uri * @example https://github.com/images/error/octocat_happy.gif */ - avatar_url: string; + avatar_url: string /** @example 41d064eb2195891e12d0413f63227ea7 */ - gravatar_id: string | null; + gravatar_id: string | null /** * Format: uri * @example https://api.github.com/users/octocat */ - url: string; + url: string /** * Format: uri * @example https://github.com/octocat */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/users/octocat/followers */ - followers_url: string; + followers_url: string /** @example https://api.github.com/users/octocat/following{/other_user} */ - following_url: string; + following_url: string /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - gists_url: string; + gists_url: string /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - starred_url: string; + starred_url: string /** * Format: uri * @example https://api.github.com/users/octocat/subscriptions */ - subscriptions_url: string; + subscriptions_url: string /** * Format: uri * @example https://api.github.com/users/octocat/orgs */ - organizations_url: string; + organizations_url: string /** * Format: uri * @example https://api.github.com/users/octocat/repos */ - repos_url: string; + repos_url: string /** @example https://api.github.com/users/octocat/events{/privacy} */ - events_url: string; + events_url: string /** * Format: uri * @example https://api.github.com/users/octocat/received_events */ - received_events_url: string; + received_events_url: string /** @example User */ - type: string; - site_admin: boolean; + type: string + site_admin: boolean /** @example "2020-07-09T00:17:55Z" */ - starred_at?: string; - }; + starred_at?: string + } /** * Enterprise * @description An enterprise account */ enterprise: { /** @description A short description of the enterprise. */ - description?: string | null; + description?: string | null /** * Format: uri * @example https://github.com/enterprises/octo-business */ - html_url: string; + html_url: string /** * Format: uri * @description The enterprise's website URL. */ - website_url?: string | null; + website_url?: string | null /** * @description Unique identifier of the enterprise * @example 42 */ - id: number; + id: number /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - node_id: string; + node_id: string /** * @description The name of the enterprise. * @example Octo Business */ - name: string; + name: string /** * @description The slug url identifier for the enterprise. * @example octo-business */ - slug: string; + slug: string /** * Format: date-time * @example 2019-01-26T19:01:12Z */ - created_at: string | null; + created_at: string | null /** * Format: date-time * @example 2019-01-26T19:14:43Z */ - updated_at: string | null; + updated_at: string | null /** Format: uri */ - avatar_url: string; - }; + avatar_url: string + } /** * App Permissions * @description The permissions granted to the user-to-server access token. * @example [object Object] */ - "app-permissions": { + 'app-permissions': { /** * @description The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts. Can be one of: `read` or `write`. * @enum {string} */ - actions?: "read" | "write"; + actions?: 'read' | 'write' /** * @description The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation. Can be one of: `read` or `write`. * @enum {string} */ - administration?: "read" | "write"; + administration?: 'read' | 'write' /** * @description The level of permission to grant the access token for checks on code. Can be one of: `read` or `write`. * @enum {string} */ - checks?: "read" | "write"; + checks?: 'read' | 'write' /** * @description The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges. Can be one of: `read` or `write`. * @enum {string} */ - contents?: "read" | "write"; + contents?: 'read' | 'write' /** * @description The level of permission to grant the access token for deployments and deployment statuses. Can be one of: `read` or `write`. * @enum {string} */ - deployments?: "read" | "write"; + deployments?: 'read' | 'write' /** * @description The level of permission to grant the access token for managing repository environments. Can be one of: `read` or `write`. * @enum {string} */ - environments?: "read" | "write"; + environments?: 'read' | 'write' /** * @description The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones. Can be one of: `read` or `write`. * @enum {string} */ - issues?: "read" | "write"; + issues?: 'read' | 'write' /** * @description The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata. Can be one of: `read` or `write`. * @enum {string} */ - metadata?: "read" | "write"; + metadata?: 'read' | 'write' /** * @description The level of permission to grant the access token for packages published to GitHub Packages. Can be one of: `read` or `write`. * @enum {string} */ - packages?: "read" | "write"; + packages?: 'read' | 'write' /** * @description The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds. Can be one of: `read` or `write`. * @enum {string} */ - pages?: "read" | "write"; + pages?: 'read' | 'write' /** * @description The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges. Can be one of: `read` or `write`. * @enum {string} */ - pull_requests?: "read" | "write"; + pull_requests?: 'read' | 'write' /** * @description The level of permission to grant the access token to manage the post-receive hooks for a repository. Can be one of: `read` or `write`. * @enum {string} */ - repository_hooks?: "read" | "write"; + repository_hooks?: 'read' | 'write' /** * @description The level of permission to grant the access token to manage repository projects, columns, and cards. Can be one of: `read`, `write`, or `admin`. * @enum {string} */ - repository_projects?: "read" | "write" | "admin"; + repository_projects?: 'read' | 'write' | 'admin' /** * @description The level of permission to grant the access token to view and manage secret scanning alerts. Can be one of: `read` or `write`. * @enum {string} */ - secret_scanning_alerts?: "read" | "write"; + secret_scanning_alerts?: 'read' | 'write' /** * @description The level of permission to grant the access token to manage repository secrets. Can be one of: `read` or `write`. * @enum {string} */ - secrets?: "read" | "write"; + secrets?: 'read' | 'write' /** * @description The level of permission to grant the access token to view and manage security events like code scanning alerts. Can be one of: `read` or `write`. * @enum {string} */ - security_events?: "read" | "write"; + security_events?: 'read' | 'write' /** * @description The level of permission to grant the access token to manage just a single file. Can be one of: `read` or `write`. * @enum {string} */ - single_file?: "read" | "write"; + single_file?: 'read' | 'write' /** * @description The level of permission to grant the access token for commit statuses. Can be one of: `read` or `write`. * @enum {string} */ - statuses?: "read" | "write"; + statuses?: 'read' | 'write' /** * @description The level of permission to grant the access token to manage Dependabot alerts. Can be one of: `read` or `write`. * @enum {string} */ - vulnerability_alerts?: "read" | "write"; + vulnerability_alerts?: 'read' | 'write' /** * @description The level of permission to grant the access token to update GitHub Actions workflow files. Can be one of: `write`. * @enum {string} */ - workflows?: "write"; + workflows?: 'write' /** * @description The level of permission to grant the access token for organization teams and members. Can be one of: `read` or `write`. * @enum {string} */ - members?: "read" | "write"; + members?: 'read' | 'write' /** * @description The level of permission to grant the access token to manage access to an organization. Can be one of: `read` or `write`. * @enum {string} */ - organization_administration?: "read" | "write"; + organization_administration?: 'read' | 'write' /** * @description The level of permission to grant the access token to manage the post-receive hooks for an organization. Can be one of: `read` or `write`. * @enum {string} */ - organization_hooks?: "read" | "write"; + organization_hooks?: 'read' | 'write' /** * @description The level of permission to grant the access token for viewing an organization's plan. Can be one of: `read`. * @enum {string} */ - organization_plan?: "read"; + organization_plan?: 'read' /** * @description The level of permission to grant the access token to manage organization projects and projects beta (where available). Can be one of: `read`, `write`, or `admin`. * @enum {string} */ - organization_projects?: "read" | "write" | "admin"; + organization_projects?: 'read' | 'write' | 'admin' /** * @description The level of permission to grant the access token for organization packages published to GitHub Packages. Can be one of: `read` or `write`. * @enum {string} */ - organization_packages?: "read" | "write"; + organization_packages?: 'read' | 'write' /** * @description The level of permission to grant the access token to manage organization secrets. Can be one of: `read` or `write`. * @enum {string} */ - organization_secrets?: "read" | "write"; + organization_secrets?: 'read' | 'write' /** * @description The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization. Can be one of: `read` or `write`. * @enum {string} */ - organization_self_hosted_runners?: "read" | "write"; + organization_self_hosted_runners?: 'read' | 'write' /** * @description The level of permission to grant the access token to view and manage users blocked by the organization. Can be one of: `read` or `write`. * @enum {string} */ - organization_user_blocking?: "read" | "write"; + organization_user_blocking?: 'read' | 'write' /** * @description The level of permission to grant the access token to manage team discussions and related comments. Can be one of: `read` or `write`. * @enum {string} */ - team_discussions?: "read" | "write"; - }; + team_discussions?: 'read' | 'write' + } /** * Installation * @description Installation @@ -6604,75 +6604,75 @@ export interface components { * @description The ID of the installation. * @example 1 */ - id: number; - account: (Partial & Partial) | null; + id: number + account: (Partial & Partial) | null /** * @description Describe whether all repositories have been selected or there's a selection involved * @enum {string} */ - repository_selection: "all" | "selected"; + repository_selection: 'all' | 'selected' /** * Format: uri * @example https://api.github.com/installations/1/access_tokens */ - access_tokens_url: string; + access_tokens_url: string /** * Format: uri * @example https://api.github.com/installation/repositories */ - repositories_url: string; + repositories_url: string /** * Format: uri * @example https://github.com/organizations/github/settings/installations/1 */ - html_url: string; + html_url: string /** @example 1 */ - app_id: number; + app_id: number /** @description The ID of the user or organization this token is being scoped to. */ - target_id: number; + target_id: number /** @example Organization */ - target_type: string; - permissions: components["schemas"]["app-permissions"]; - events: string[]; + target_type: string + permissions: components['schemas']['app-permissions'] + events: string[] /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; + updated_at: string /** @example config.yaml */ - single_file_name: string | null; + single_file_name: string | null /** @example true */ - has_multiple_single_files?: boolean; + has_multiple_single_files?: boolean /** @example config.yml,.github/issue_TEMPLATE.md */ - single_file_paths?: string[]; + single_file_paths?: string[] /** @example github-actions */ - app_slug: string; - suspended_by: components["schemas"]["nullable-simple-user"]; + app_slug: string + suspended_by: components['schemas']['nullable-simple-user'] /** Format: date-time */ - suspended_at: string | null; + suspended_at: string | null /** @example "test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com" */ - contact_email?: string | null; - }; + contact_email?: string | null + } /** * License Simple * @description License Simple */ - "nullable-license-simple": { + 'nullable-license-simple': { /** @example mit */ - key: string; + key: string /** @example MIT License */ - name: string; + name: string /** * Format: uri * @example https://api.github.com/licenses/mit */ - url: string | null; + url: string | null /** @example MIT */ - spdx_id: string | null; + spdx_id: string | null /** @example MDc6TGljZW5zZW1pdA== */ - node_id: string; + node_id: string /** Format: uri */ - html_url?: string; - } | null; + html_url?: string + } | null /** * Repository * @description A git repository @@ -6682,503 +6682,503 @@ export interface components { * @description Unique identifier of the repository * @example 42 */ - id: number; + id: number /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - node_id: string; + node_id: string /** * @description The name of the repository. * @example Team Environment */ - name: string; + name: string /** @example octocat/Hello-World */ - full_name: string; - license: components["schemas"]["nullable-license-simple"]; - organization?: components["schemas"]["nullable-simple-user"]; - forks: number; + full_name: string + license: components['schemas']['nullable-license-simple'] + organization?: components['schemas']['nullable-simple-user'] + forks: number permissions?: { - admin: boolean; - pull: boolean; - triage?: boolean; - push: boolean; - maintain?: boolean; - }; - owner: components["schemas"]["simple-user"]; + admin: boolean + pull: boolean + triage?: boolean + push: boolean + maintain?: boolean + } + owner: components['schemas']['simple-user'] /** @description Whether the repository is private or public. */ - private: boolean; + private: boolean /** * Format: uri * @example https://github.com/octocat/Hello-World */ - html_url: string; + html_url: string /** @example This your first repo! */ - description: string | null; - fork: boolean; + description: string | null + fork: boolean /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World */ - url: string; + url: string /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - archive_url: string; + archive_url: string /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - assignees_url: string; + assignees_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - blobs_url: string; + blobs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - branches_url: string; + branches_url: string /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - collaborators_url: string; + collaborators_url: string /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - comments_url: string; + comments_url: string /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - commits_url: string; + commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - compare_url: string; + compare_url: string /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - contents_url: string; + contents_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - contributors_url: string; + contributors_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - deployments_url: string; + deployments_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - downloads_url: string; + downloads_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events */ - events_url: string; + events_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ - forks_url: string; + forks_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - git_commits_url: string; + git_commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - git_refs_url: string; + git_refs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - git_tags_url: string; + git_tags_url: string /** @example git:github.com/octocat/Hello-World.git */ - git_url: string; + git_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - issue_comment_url: string; + issue_comment_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - issue_events_url: string; + issue_events_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - issues_url: string; + issues_url: string /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - keys_url: string; + keys_url: string /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - labels_url: string; + labels_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ - languages_url: string; + languages_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ - merges_url: string; + merges_url: string /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - milestones_url: string; + milestones_url: string /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - notifications_url: string; + notifications_url: string /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - pulls_url: string; + pulls_url: string /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - releases_url: string; + releases_url: string /** @example git@github.com:octocat/Hello-World.git */ - ssh_url: string; + ssh_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - stargazers_url: string; + stargazers_url: string /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - statuses_url: string; + statuses_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - subscribers_url: string; + subscribers_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - subscription_url: string; + subscription_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ - tags_url: string; + tags_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ - teams_url: string; + teams_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - trees_url: string; + trees_url: string /** @example https://github.com/octocat/Hello-World.git */ - clone_url: string; + clone_url: string /** * Format: uri * @example git:git.example.com/octocat/Hello-World */ - mirror_url: string | null; + mirror_url: string | null /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - hooks_url: string; + hooks_url: string /** * Format: uri * @example https://svn.github.com/octocat/Hello-World */ - svn_url: string; + svn_url: string /** * Format: uri * @example https://github.com */ - homepage: string | null; - language: string | null; + homepage: string | null + language: string | null /** @example 9 */ - forks_count: number; + forks_count: number /** @example 80 */ - stargazers_count: number; + stargazers_count: number /** @example 80 */ - watchers_count: number; + watchers_count: number /** @example 108 */ - size: number; + size: number /** * @description The default branch of the repository. * @example master */ - default_branch: string; - open_issues_count: number; + default_branch: string + open_issues_count: number /** * @description Whether this repository acts as a template that can be used to generate new repositories. * @example true */ - is_template?: boolean; - topics?: string[]; + is_template?: boolean + topics?: string[] /** * @description Whether issues are enabled. * @default true * @example true */ - has_issues: boolean; + has_issues: boolean /** * @description Whether projects are enabled. * @default true * @example true */ - has_projects: boolean; + has_projects: boolean /** * @description Whether the wiki is enabled. * @default true * @example true */ - has_wiki: boolean; - has_pages: boolean; + has_wiki: boolean + has_pages: boolean /** * @description Whether downloads are enabled. * @default true * @example true */ - has_downloads: boolean; + has_downloads: boolean /** @description Whether the repository is archived. */ - archived: boolean; + archived: boolean /** @description Returns whether or not this repository disabled. */ - disabled: boolean; + disabled: boolean /** * @description The repository visibility: public, private, or internal. * @default public */ - visibility?: string; + visibility?: string /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - pushed_at: string | null; + pushed_at: string | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - created_at: string | null; + created_at: string | null /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - updated_at: string | null; + updated_at: string | null /** * @description Whether to allow rebase merges for pull requests. * @default true * @example true */ - allow_rebase_merge?: boolean; + allow_rebase_merge?: boolean template_repository?: { - id?: number; - node_id?: string; - name?: string; - full_name?: string; + id?: number + node_id?: string + name?: string + full_name?: string owner?: { - login?: string; - id?: number; - node_id?: string; - avatar_url?: string; - gravatar_id?: string; - url?: string; - html_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - starred_url?: string; - subscriptions_url?: string; - organizations_url?: string; - repos_url?: string; - events_url?: string; - received_events_url?: string; - type?: string; - site_admin?: boolean; - }; - private?: boolean; - html_url?: string; - description?: string; - fork?: boolean; - url?: string; - archive_url?: string; - assignees_url?: string; - blobs_url?: string; - branches_url?: string; - collaborators_url?: string; - comments_url?: string; - commits_url?: string; - compare_url?: string; - contents_url?: string; - contributors_url?: string; - deployments_url?: string; - downloads_url?: string; - events_url?: string; - forks_url?: string; - git_commits_url?: string; - git_refs_url?: string; - git_tags_url?: string; - git_url?: string; - issue_comment_url?: string; - issue_events_url?: string; - issues_url?: string; - keys_url?: string; - labels_url?: string; - languages_url?: string; - merges_url?: string; - milestones_url?: string; - notifications_url?: string; - pulls_url?: string; - releases_url?: string; - ssh_url?: string; - stargazers_url?: string; - statuses_url?: string; - subscribers_url?: string; - subscription_url?: string; - tags_url?: string; - teams_url?: string; - trees_url?: string; - clone_url?: string; - mirror_url?: string; - hooks_url?: string; - svn_url?: string; - homepage?: string; - language?: string; - forks_count?: number; - stargazers_count?: number; - watchers_count?: number; - size?: number; - default_branch?: string; - open_issues_count?: number; - is_template?: boolean; - topics?: string[]; - has_issues?: boolean; - has_projects?: boolean; - has_wiki?: boolean; - has_pages?: boolean; - has_downloads?: boolean; - archived?: boolean; - disabled?: boolean; - visibility?: string; - pushed_at?: string; - created_at?: string; - updated_at?: string; + login?: string + id?: number + node_id?: string + avatar_url?: string + gravatar_id?: string + url?: string + html_url?: string + followers_url?: string + following_url?: string + gists_url?: string + starred_url?: string + subscriptions_url?: string + organizations_url?: string + repos_url?: string + events_url?: string + received_events_url?: string + type?: string + site_admin?: boolean + } + private?: boolean + html_url?: string + description?: string + fork?: boolean + url?: string + archive_url?: string + assignees_url?: string + blobs_url?: string + branches_url?: string + collaborators_url?: string + comments_url?: string + commits_url?: string + compare_url?: string + contents_url?: string + contributors_url?: string + deployments_url?: string + downloads_url?: string + events_url?: string + forks_url?: string + git_commits_url?: string + git_refs_url?: string + git_tags_url?: string + git_url?: string + issue_comment_url?: string + issue_events_url?: string + issues_url?: string + keys_url?: string + labels_url?: string + languages_url?: string + merges_url?: string + milestones_url?: string + notifications_url?: string + pulls_url?: string + releases_url?: string + ssh_url?: string + stargazers_url?: string + statuses_url?: string + subscribers_url?: string + subscription_url?: string + tags_url?: string + teams_url?: string + trees_url?: string + clone_url?: string + mirror_url?: string + hooks_url?: string + svn_url?: string + homepage?: string + language?: string + forks_count?: number + stargazers_count?: number + watchers_count?: number + size?: number + default_branch?: string + open_issues_count?: number + is_template?: boolean + topics?: string[] + has_issues?: boolean + has_projects?: boolean + has_wiki?: boolean + has_pages?: boolean + has_downloads?: boolean + archived?: boolean + disabled?: boolean + visibility?: string + pushed_at?: string + created_at?: string + updated_at?: string permissions?: { - admin?: boolean; - maintain?: boolean; - push?: boolean; - triage?: boolean; - pull?: boolean; - }; - allow_rebase_merge?: boolean; - temp_clone_token?: string; - allow_squash_merge?: boolean; - allow_auto_merge?: boolean; - delete_branch_on_merge?: boolean; - allow_update_branch?: boolean; - allow_merge_commit?: boolean; - subscribers_count?: number; - network_count?: number; - } | null; - temp_clone_token?: string; + admin?: boolean + maintain?: boolean + push?: boolean + triage?: boolean + pull?: boolean + } + allow_rebase_merge?: boolean + temp_clone_token?: string + allow_squash_merge?: boolean + allow_auto_merge?: boolean + delete_branch_on_merge?: boolean + allow_update_branch?: boolean + allow_merge_commit?: boolean + subscribers_count?: number + network_count?: number + } | null + temp_clone_token?: string /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - allow_squash_merge?: boolean; + allow_squash_merge?: boolean /** @description Whether to allow Auto-merge to be used on pull requests. */ - allow_auto_merge?: boolean; + allow_auto_merge?: boolean /** @description Whether to delete head branches when pull requests are merged */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge?: boolean /** * @description Whether to allow merge commits for pull requests. * @default true * @example true */ - allow_merge_commit?: boolean; + allow_merge_commit?: boolean /** @description Whether to allow forking this repo */ - allow_forking?: boolean; - subscribers_count?: number; - network_count?: number; - open_issues: number; - watchers: number; - master_branch?: string; + allow_forking?: boolean + subscribers_count?: number + network_count?: number + open_issues: number + watchers: number + master_branch?: string /** @example "2020-07-09T00:17:42Z" */ - starred_at?: string; - }; + starred_at?: string + } /** * Installation Token * @description Authentication token for a GitHub App installed on a user or org. */ - "installation-token": { - token: string; - expires_at: string; - permissions?: components["schemas"]["app-permissions"]; + 'installation-token': { + token: string + expires_at: string + permissions?: components['schemas']['app-permissions'] /** @enum {string} */ - repository_selection?: "all" | "selected"; - repositories?: components["schemas"]["repository"][]; + repository_selection?: 'all' | 'selected' + repositories?: components['schemas']['repository'][] /** @example README.md */ - single_file?: string; + single_file?: string /** @example true */ - has_multiple_single_files?: boolean; + has_multiple_single_files?: boolean /** @example config.yml,.github/issue_TEMPLATE.md */ - single_file_paths?: string[]; - }; + single_file_paths?: string[] + } /** * Application Grant * @description The authorization associated with an OAuth Access. */ - "application-grant": { + 'application-grant': { /** @example 1 */ - id: number; + id: number /** * Format: uri * @example https://api.github.com/applications/grants/1 */ - url: string; + url: string app: { - client_id: string; - name: string; + client_id: string + name: string /** Format: uri */ - url: string; - }; + url: string + } /** * Format: date-time * @example 2011-09-06T17:26:27Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2011-09-06T20:39:23Z */ - updated_at: string; + updated_at: string /** @example public_repo */ - scopes: string[]; - user?: components["schemas"]["nullable-simple-user"]; - }; + scopes: string[] + user?: components['schemas']['nullable-simple-user'] + } /** Scoped Installation */ - "nullable-scoped-installation": { - permissions: components["schemas"]["app-permissions"]; + 'nullable-scoped-installation': { + permissions: components['schemas']['app-permissions'] /** * @description Describe whether all repositories have been selected or there's a selection involved * @enum {string} */ - repository_selection: "all" | "selected"; + repository_selection: 'all' | 'selected' /** @example config.yaml */ - single_file_name: string | null; + single_file_name: string | null /** @example true */ - has_multiple_single_files?: boolean; + has_multiple_single_files?: boolean /** @example config.yml,.github/issue_TEMPLATE.md */ - single_file_paths?: string[]; + single_file_paths?: string[] /** * Format: uri * @example https://api.github.com/users/octocat/repos */ - repositories_url: string; - account: components["schemas"]["simple-user"]; - } | null; + repositories_url: string + account: components['schemas']['simple-user'] + } | null /** * Authorization * @description The authorization for an OAuth app, GitHub App, or a Personal Access Token. */ authorization: { - id: number; + id: number /** Format: uri */ - url: string; + url: string /** @description A list of scopes that this authorization is in. */ - scopes: string[] | null; - token: string; - token_last_eight: string | null; - hashed_token: string | null; + scopes: string[] | null + token: string + token_last_eight: string | null + hashed_token: string | null app: { - client_id: string; - name: string; + client_id: string + name: string /** Format: uri */ - url: string; - }; - note: string | null; + url: string + } + note: string | null /** Format: uri */ - note_url: string | null; + note_url: string | null /** Format: date-time */ - updated_at: string; + updated_at: string /** Format: date-time */ - created_at: string; - fingerprint: string | null; - user?: components["schemas"]["nullable-simple-user"]; - installation?: components["schemas"]["nullable-scoped-installation"]; + created_at: string + fingerprint: string | null + user?: components['schemas']['nullable-simple-user'] + installation?: components['schemas']['nullable-scoped-installation'] /** Format: date-time */ - expires_at: string | null; - }; + expires_at: string | null + } /** * Code Of Conduct * @description Code Of Conduct */ - "code-of-conduct": { + 'code-of-conduct': { /** @example contributor_covenant */ - key: string; + key: string /** @example Contributor Covenant */ - name: string; + name: string /** * Format: uri * @example https://api.github.com/codes_of_conduct/contributor_covenant */ - url: string; + url: string /** * @example # Contributor Covenant Code of Conduct * @@ -7229,100 +7229,100 @@ export interface components { * [homepage]: http://contributor-covenant.org * [version]: http://contributor-covenant.org/version/1/4/ */ - body?: string; + body?: string /** Format: uri */ - html_url: string | null; - }; + html_url: string | null + } /** * @description The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`. * @enum {string} */ - "enabled-organizations": "all" | "none" | "selected"; + 'enabled-organizations': 'all' | 'none' | 'selected' /** * @description The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`. * @enum {string} */ - "allowed-actions": "all" | "local_only" | "selected"; + 'allowed-actions': 'all' | 'local_only' | 'selected' /** @description The API URL to use to get or set the actions that are allowed to run, when `allowed_actions` is set to `selected`. */ - "selected-actions-url": string; - "actions-enterprise-permissions": { - enabled_organizations: components["schemas"]["enabled-organizations"]; + 'selected-actions-url': string + 'actions-enterprise-permissions': { + enabled_organizations: components['schemas']['enabled-organizations'] /** @description The API URL to use to get or set the selected organizations that are allowed to run GitHub Actions, when `enabled_organizations` is set to `selected`. */ - selected_organizations_url?: string; - allowed_actions?: components["schemas"]["allowed-actions"]; - selected_actions_url?: components["schemas"]["selected-actions-url"]; - }; + selected_organizations_url?: string + allowed_actions?: components['schemas']['allowed-actions'] + selected_actions_url?: components['schemas']['selected-actions-url'] + } /** * Organization Simple * @description Organization Simple */ - "organization-simple": { + 'organization-simple': { /** @example github */ - login: string; + login: string /** @example 1 */ - id: number; + id: number /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ - node_id: string; + node_id: string /** * Format: uri * @example https://api.github.com/orgs/github */ - url: string; + url: string /** * Format: uri * @example https://api.github.com/orgs/github/repos */ - repos_url: string; + repos_url: string /** * Format: uri * @example https://api.github.com/orgs/github/events */ - events_url: string; + events_url: string /** @example https://api.github.com/orgs/github/hooks */ - hooks_url: string; + hooks_url: string /** @example https://api.github.com/orgs/github/issues */ - issues_url: string; + issues_url: string /** @example https://api.github.com/orgs/github/members{/member} */ - members_url: string; + members_url: string /** @example https://api.github.com/orgs/github/public_members{/member} */ - public_members_url: string; + public_members_url: string /** @example https://github.com/images/error/octocat_happy.gif */ - avatar_url: string; + avatar_url: string /** @example A great organization */ - description: string | null; - }; - "selected-actions": { + description: string | null + } + 'selected-actions': { /** @description Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization. */ - github_owned_allowed?: boolean; + github_owned_allowed?: boolean /** @description Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators. */ - verified_allowed?: boolean; + verified_allowed?: boolean /** @description Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`." */ - patterns_allowed?: string[]; - }; - "runner-groups-enterprise": { - id: number; - name: string; - visibility: string; - default: boolean; - selected_organizations_url?: string; - runners_url: string; - allows_public_repositories: boolean; - }; + patterns_allowed?: string[] + } + 'runner-groups-enterprise': { + id: number + name: string + visibility: string + default: boolean + selected_organizations_url?: string + runners_url: string + allows_public_repositories: boolean + } /** * Self hosted runner label * @description A label for a self hosted runner */ - "runner-label": { + 'runner-label': { /** @description Unique identifier of the label. */ - id?: number; + id?: number /** @description Name of the label. */ - name: string; + name: string /** * @description The type of label. Read-only labels are applied automatically when the runner is configured. * @enum {string} */ - type?: "read-only" | "custom"; - }; + type?: 'read-only' | 'custom' + } /** * Self hosted runners * @description A self hosted runner @@ -7332,1046 +7332,1038 @@ export interface components { * @description The id of the runner. * @example 5 */ - id: number; + id: number /** * @description The name of the runner. * @example iMac */ - name: string; + name: string /** * @description The Operating System of the runner. * @example macos */ - os: string; + os: string /** * @description The status of the runner. * @example online */ - status: string; - busy: boolean; - labels: components["schemas"]["runner-label"][]; - }; + status: string + busy: boolean + labels: components['schemas']['runner-label'][] + } /** * Runner Application * @description Runner Application */ - "runner-application": { - os: string; - architecture: string; - download_url: string; - filename: string; + 'runner-application': { + os: string + architecture: string + download_url: string + filename: string /** @description A short lived bearer token used to download the runner, if needed. */ - temp_download_token?: string; - sha256_checksum?: string; - }; + temp_download_token?: string + sha256_checksum?: string + } /** * Authentication Token * @description Authentication Token */ - "authentication-token": { + 'authentication-token': { /** * @description The token used for authentication * @example v1.1f699f1069f60xxx */ - token: string; + token: string /** * Format: date-time * @description The time this token expires * @example 2016-07-11T22:14:10Z */ - expires_at: string; + expires_at: string /** @example [object Object] */ - permissions?: { [key: string]: unknown }; + permissions?: { [key: string]: unknown } /** @description The repositories this token has access to */ - repositories?: components["schemas"]["repository"][]; + repositories?: components['schemas']['repository'][] /** @example config.yaml */ - single_file?: string | null; + single_file?: string | null /** * @description Describe whether all repositories have been selected or there's a selection involved * @enum {string} */ - repository_selection?: "all" | "selected"; - }; - "audit-log-event": { + repository_selection?: 'all' | 'selected' + } + 'audit-log-event': { /** @description The time the audit log event occurred, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time). */ - "@timestamp"?: number; + '@timestamp'?: number /** @description The name of the action that was performed, for example `user.login` or `repo.create`. */ - action?: string; - active?: boolean; - active_was?: boolean; + action?: string + active?: boolean + active_was?: boolean /** @description The actor who performed the action. */ - actor?: string; + actor?: string /** @description The id of the actor who performed the action. */ - actor_id?: number; + actor_id?: number actor_location?: { - country_name?: string; - }; - data?: { [key: string]: unknown }; - org_id?: number; + country_name?: string + } + data?: { [key: string]: unknown } + org_id?: number /** @description The username of the account being blocked. */ - blocked_user?: string; - business?: string; - config?: { [key: string]: unknown }[]; - config_was?: { [key: string]: unknown }[]; - content_type?: string; + blocked_user?: string + business?: string + config?: { [key: string]: unknown }[] + config_was?: { [key: string]: unknown }[] + content_type?: string /** @description The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time). */ - created_at?: number; - deploy_key_fingerprint?: string; + created_at?: number + deploy_key_fingerprint?: string /** @description A unique identifier for an audit event. */ - _document_id?: string; - emoji?: string; - events?: { [key: string]: unknown }[]; - events_were?: { [key: string]: unknown }[]; - explanation?: string; - fingerprint?: string; - hook_id?: number; - limited_availability?: boolean; - message?: string; - name?: string; - old_user?: string; - openssh_public_key?: string; - org?: string; - previous_visibility?: string; - read_only?: boolean; + _document_id?: string + emoji?: string + events?: { [key: string]: unknown }[] + events_were?: { [key: string]: unknown }[] + explanation?: string + fingerprint?: string + hook_id?: number + limited_availability?: boolean + message?: string + name?: string + old_user?: string + openssh_public_key?: string + org?: string + previous_visibility?: string + read_only?: boolean /** @description The name of the repository. */ - repo?: string; + repo?: string /** @description The name of the repository. */ - repository?: string; - repository_public?: boolean; - target_login?: string; - team?: string; + repository?: string + repository_public?: boolean + target_login?: string + team?: string /** @description The type of protocol (for example, HTTP or SSH) used to transfer Git data. */ - transport_protocol?: number; + transport_protocol?: number /** @description A human readable name for the protocol (for example, HTTP or SSH) used to transfer Git data. */ - transport_protocol_name?: string; + transport_protocol_name?: string /** @description The user that was affected by the action performed (if available). */ - user?: string; + user?: string /** @description The repository visibility, for example `public` or `private`. */ - visibility?: string; - }; + visibility?: string + } /** @description The security alert number. */ - "alert-number": number; + 'alert-number': number /** * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "alert-created-at": string; + 'alert-created-at': string /** * Format: uri * @description The REST API URL of the alert resource. */ - "alert-url": string; + 'alert-url': string /** * Format: uri * @description The GitHub URL of the alert resource. */ - "alert-html-url": string; + 'alert-html-url': string /** * @description Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`. * @enum {string} */ - "secret-scanning-alert-state": "open" | "resolved"; + 'secret-scanning-alert-state': 'open' | 'resolved' /** * @description **Required when the `state` is `resolved`.** The reason for resolving the alert. Can be one of `false_positive`, `wont_fix`, `revoked`, or `used_in_tests`. * @enum {string|null} */ - "secret-scanning-alert-resolution": (null | "false_positive" | "wont_fix" | "revoked" | "used_in_tests") | null; + 'secret-scanning-alert-resolution': (null | 'false_positive' | 'wont_fix' | 'revoked' | 'used_in_tests') | null /** * Repository * @description A git repository */ - "nullable-repository": { + 'nullable-repository': { /** * @description Unique identifier of the repository * @example 42 */ - id: number; + id: number /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - node_id: string; + node_id: string /** * @description The name of the repository. * @example Team Environment */ - name: string; + name: string /** @example octocat/Hello-World */ - full_name: string; - license: components["schemas"]["nullable-license-simple"]; - organization?: components["schemas"]["nullable-simple-user"]; - forks: number; + full_name: string + license: components['schemas']['nullable-license-simple'] + organization?: components['schemas']['nullable-simple-user'] + forks: number permissions?: { - admin: boolean; - pull: boolean; - triage?: boolean; - push: boolean; - maintain?: boolean; - }; - owner: components["schemas"]["simple-user"]; + admin: boolean + pull: boolean + triage?: boolean + push: boolean + maintain?: boolean + } + owner: components['schemas']['simple-user'] /** @description Whether the repository is private or public. */ - private: boolean; + private: boolean /** * Format: uri * @example https://github.com/octocat/Hello-World */ - html_url: string; + html_url: string /** @example This your first repo! */ - description: string | null; - fork: boolean; + description: string | null + fork: boolean /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World */ - url: string; + url: string /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - archive_url: string; + archive_url: string /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - assignees_url: string; + assignees_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - blobs_url: string; + blobs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - branches_url: string; + branches_url: string /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - collaborators_url: string; + collaborators_url: string /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - comments_url: string; + comments_url: string /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - commits_url: string; + commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - compare_url: string; + compare_url: string /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - contents_url: string; + contents_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - contributors_url: string; + contributors_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - deployments_url: string; + deployments_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - downloads_url: string; + downloads_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events */ - events_url: string; + events_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ - forks_url: string; + forks_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - git_commits_url: string; + git_commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - git_refs_url: string; + git_refs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - git_tags_url: string; + git_tags_url: string /** @example git:github.com/octocat/Hello-World.git */ - git_url: string; + git_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - issue_comment_url: string; + issue_comment_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - issue_events_url: string; + issue_events_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - issues_url: string; + issues_url: string /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - keys_url: string; + keys_url: string /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - labels_url: string; + labels_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ - languages_url: string; + languages_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ - merges_url: string; + merges_url: string /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - milestones_url: string; + milestones_url: string /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - notifications_url: string; + notifications_url: string /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - pulls_url: string; + pulls_url: string /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - releases_url: string; + releases_url: string /** @example git@github.com:octocat/Hello-World.git */ - ssh_url: string; + ssh_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - stargazers_url: string; + stargazers_url: string /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - statuses_url: string; + statuses_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - subscribers_url: string; + subscribers_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - subscription_url: string; + subscription_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ - tags_url: string; + tags_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ - teams_url: string; + teams_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - trees_url: string; + trees_url: string /** @example https://github.com/octocat/Hello-World.git */ - clone_url: string; + clone_url: string /** * Format: uri * @example git:git.example.com/octocat/Hello-World */ - mirror_url: string | null; + mirror_url: string | null /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - hooks_url: string; + hooks_url: string /** * Format: uri * @example https://svn.github.com/octocat/Hello-World */ - svn_url: string; + svn_url: string /** * Format: uri * @example https://github.com */ - homepage: string | null; - language: string | null; + homepage: string | null + language: string | null /** @example 9 */ - forks_count: number; + forks_count: number /** @example 80 */ - stargazers_count: number; + stargazers_count: number /** @example 80 */ - watchers_count: number; + watchers_count: number /** @example 108 */ - size: number; + size: number /** * @description The default branch of the repository. * @example master */ - default_branch: string; - open_issues_count: number; + default_branch: string + open_issues_count: number /** * @description Whether this repository acts as a template that can be used to generate new repositories. * @example true */ - is_template?: boolean; - topics?: string[]; + is_template?: boolean + topics?: string[] /** * @description Whether issues are enabled. * @default true * @example true */ - has_issues: boolean; + has_issues: boolean /** * @description Whether projects are enabled. * @default true * @example true */ - has_projects: boolean; + has_projects: boolean /** * @description Whether the wiki is enabled. * @default true * @example true */ - has_wiki: boolean; - has_pages: boolean; + has_wiki: boolean + has_pages: boolean /** * @description Whether downloads are enabled. * @default true * @example true */ - has_downloads: boolean; + has_downloads: boolean /** @description Whether the repository is archived. */ - archived: boolean; + archived: boolean /** @description Returns whether or not this repository disabled. */ - disabled: boolean; + disabled: boolean /** * @description The repository visibility: public, private, or internal. * @default public */ - visibility?: string; + visibility?: string /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - pushed_at: string | null; + pushed_at: string | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - created_at: string | null; + created_at: string | null /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - updated_at: string | null; + updated_at: string | null /** * @description Whether to allow rebase merges for pull requests. * @default true * @example true */ - allow_rebase_merge?: boolean; + allow_rebase_merge?: boolean template_repository?: { - id?: number; - node_id?: string; - name?: string; - full_name?: string; + id?: number + node_id?: string + name?: string + full_name?: string owner?: { - login?: string; - id?: number; - node_id?: string; - avatar_url?: string; - gravatar_id?: string; - url?: string; - html_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - starred_url?: string; - subscriptions_url?: string; - organizations_url?: string; - repos_url?: string; - events_url?: string; - received_events_url?: string; - type?: string; - site_admin?: boolean; - }; - private?: boolean; - html_url?: string; - description?: string; - fork?: boolean; - url?: string; - archive_url?: string; - assignees_url?: string; - blobs_url?: string; - branches_url?: string; - collaborators_url?: string; - comments_url?: string; - commits_url?: string; - compare_url?: string; - contents_url?: string; - contributors_url?: string; - deployments_url?: string; - downloads_url?: string; - events_url?: string; - forks_url?: string; - git_commits_url?: string; - git_refs_url?: string; - git_tags_url?: string; - git_url?: string; - issue_comment_url?: string; - issue_events_url?: string; - issues_url?: string; - keys_url?: string; - labels_url?: string; - languages_url?: string; - merges_url?: string; - milestones_url?: string; - notifications_url?: string; - pulls_url?: string; - releases_url?: string; - ssh_url?: string; - stargazers_url?: string; - statuses_url?: string; - subscribers_url?: string; - subscription_url?: string; - tags_url?: string; - teams_url?: string; - trees_url?: string; - clone_url?: string; - mirror_url?: string; - hooks_url?: string; - svn_url?: string; - homepage?: string; - language?: string; - forks_count?: number; - stargazers_count?: number; - watchers_count?: number; - size?: number; - default_branch?: string; - open_issues_count?: number; - is_template?: boolean; - topics?: string[]; - has_issues?: boolean; - has_projects?: boolean; - has_wiki?: boolean; - has_pages?: boolean; - has_downloads?: boolean; - archived?: boolean; - disabled?: boolean; - visibility?: string; - pushed_at?: string; - created_at?: string; - updated_at?: string; + login?: string + id?: number + node_id?: string + avatar_url?: string + gravatar_id?: string + url?: string + html_url?: string + followers_url?: string + following_url?: string + gists_url?: string + starred_url?: string + subscriptions_url?: string + organizations_url?: string + repos_url?: string + events_url?: string + received_events_url?: string + type?: string + site_admin?: boolean + } + private?: boolean + html_url?: string + description?: string + fork?: boolean + url?: string + archive_url?: string + assignees_url?: string + blobs_url?: string + branches_url?: string + collaborators_url?: string + comments_url?: string + commits_url?: string + compare_url?: string + contents_url?: string + contributors_url?: string + deployments_url?: string + downloads_url?: string + events_url?: string + forks_url?: string + git_commits_url?: string + git_refs_url?: string + git_tags_url?: string + git_url?: string + issue_comment_url?: string + issue_events_url?: string + issues_url?: string + keys_url?: string + labels_url?: string + languages_url?: string + merges_url?: string + milestones_url?: string + notifications_url?: string + pulls_url?: string + releases_url?: string + ssh_url?: string + stargazers_url?: string + statuses_url?: string + subscribers_url?: string + subscription_url?: string + tags_url?: string + teams_url?: string + trees_url?: string + clone_url?: string + mirror_url?: string + hooks_url?: string + svn_url?: string + homepage?: string + language?: string + forks_count?: number + stargazers_count?: number + watchers_count?: number + size?: number + default_branch?: string + open_issues_count?: number + is_template?: boolean + topics?: string[] + has_issues?: boolean + has_projects?: boolean + has_wiki?: boolean + has_pages?: boolean + has_downloads?: boolean + archived?: boolean + disabled?: boolean + visibility?: string + pushed_at?: string + created_at?: string + updated_at?: string permissions?: { - admin?: boolean; - maintain?: boolean; - push?: boolean; - triage?: boolean; - pull?: boolean; - }; - allow_rebase_merge?: boolean; - temp_clone_token?: string; - allow_squash_merge?: boolean; - allow_auto_merge?: boolean; - delete_branch_on_merge?: boolean; - allow_update_branch?: boolean; - allow_merge_commit?: boolean; - subscribers_count?: number; - network_count?: number; - } | null; - temp_clone_token?: string; + admin?: boolean + maintain?: boolean + push?: boolean + triage?: boolean + pull?: boolean + } + allow_rebase_merge?: boolean + temp_clone_token?: string + allow_squash_merge?: boolean + allow_auto_merge?: boolean + delete_branch_on_merge?: boolean + allow_update_branch?: boolean + allow_merge_commit?: boolean + subscribers_count?: number + network_count?: number + } | null + temp_clone_token?: string /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - allow_squash_merge?: boolean; + allow_squash_merge?: boolean /** @description Whether to allow Auto-merge to be used on pull requests. */ - allow_auto_merge?: boolean; + allow_auto_merge?: boolean /** @description Whether to delete head branches when pull requests are merged */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge?: boolean /** * @description Whether to allow merge commits for pull requests. * @default true * @example true */ - allow_merge_commit?: boolean; + allow_merge_commit?: boolean /** @description Whether to allow forking this repo */ - allow_forking?: boolean; - subscribers_count?: number; - network_count?: number; - open_issues: number; - watchers: number; - master_branch?: string; + allow_forking?: boolean + subscribers_count?: number + network_count?: number + open_issues: number + watchers: number + master_branch?: string /** @example "2020-07-09T00:17:42Z" */ - starred_at?: string; - } | null; + starred_at?: string + } | null /** * Minimal Repository * @description Minimal Repository */ - "minimal-repository": { + 'minimal-repository': { /** @example 1296269 */ - id: number; + id: number /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - node_id: string; + node_id: string /** @example Hello-World */ - name: string; + name: string /** @example octocat/Hello-World */ - full_name: string; - owner: components["schemas"]["simple-user"]; - private: boolean; + full_name: string + owner: components['schemas']['simple-user'] + private: boolean /** * Format: uri * @example https://github.com/octocat/Hello-World */ - html_url: string; + html_url: string /** @example This your first repo! */ - description: string | null; - fork: boolean; + description: string | null + fork: boolean /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World */ - url: string; + url: string /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - archive_url: string; + archive_url: string /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - assignees_url: string; + assignees_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - blobs_url: string; + blobs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - branches_url: string; + branches_url: string /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - collaborators_url: string; + collaborators_url: string /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - comments_url: string; + comments_url: string /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - commits_url: string; + commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - compare_url: string; + compare_url: string /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - contents_url: string; + contents_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - contributors_url: string; + contributors_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - deployments_url: string; + deployments_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - downloads_url: string; + downloads_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events */ - events_url: string; + events_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ - forks_url: string; + forks_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - git_commits_url: string; + git_commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - git_refs_url: string; + git_refs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - git_tags_url: string; - git_url?: string; + git_tags_url: string + git_url?: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - issue_comment_url: string; + issue_comment_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - issue_events_url: string; + issue_events_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - issues_url: string; + issues_url: string /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - keys_url: string; + keys_url: string /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - labels_url: string; + labels_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ - languages_url: string; + languages_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ - merges_url: string; + merges_url: string /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - milestones_url: string; + milestones_url: string /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - notifications_url: string; + notifications_url: string /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - pulls_url: string; + pulls_url: string /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - releases_url: string; - ssh_url?: string; + releases_url: string + ssh_url?: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - stargazers_url: string; + stargazers_url: string /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - statuses_url: string; + statuses_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - subscribers_url: string; + subscribers_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - subscription_url: string; + subscription_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ - tags_url: string; + tags_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ - teams_url: string; + teams_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - trees_url: string; - clone_url?: string; - mirror_url?: string | null; + trees_url: string + clone_url?: string + mirror_url?: string | null /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - hooks_url: string; - svn_url?: string; - homepage?: string | null; - language?: string | null; - forks_count?: number; - stargazers_count?: number; - watchers_count?: number; - size?: number; - default_branch?: string; - open_issues_count?: number; - is_template?: boolean; - topics?: string[]; - has_issues?: boolean; - has_projects?: boolean; - has_wiki?: boolean; - has_pages?: boolean; - has_downloads?: boolean; - archived?: boolean; - disabled?: boolean; - visibility?: string; + hooks_url: string + svn_url?: string + homepage?: string | null + language?: string | null + forks_count?: number + stargazers_count?: number + watchers_count?: number + size?: number + default_branch?: string + open_issues_count?: number + is_template?: boolean + topics?: string[] + has_issues?: boolean + has_projects?: boolean + has_wiki?: boolean + has_pages?: boolean + has_downloads?: boolean + archived?: boolean + disabled?: boolean + visibility?: string /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - pushed_at?: string | null; + pushed_at?: string | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - created_at?: string | null; + created_at?: string | null /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - updated_at?: string | null; + updated_at?: string | null permissions?: { - admin?: boolean; - maintain?: boolean; - push?: boolean; - triage?: boolean; - pull?: boolean; - }; + admin?: boolean + maintain?: boolean + push?: boolean + triage?: boolean + pull?: boolean + } /** @example admin */ - role_name?: string; - template_repository?: components["schemas"]["nullable-repository"]; - temp_clone_token?: string; - delete_branch_on_merge?: boolean; - subscribers_count?: number; - network_count?: number; - code_of_conduct?: components["schemas"]["code-of-conduct"]; + role_name?: string + template_repository?: components['schemas']['nullable-repository'] + temp_clone_token?: string + delete_branch_on_merge?: boolean + subscribers_count?: number + network_count?: number + code_of_conduct?: components['schemas']['code-of-conduct'] license?: { - key?: string; - name?: string; - spdx_id?: string; - url?: string; - node_id?: string; - } | null; - forks?: number; - open_issues?: number; - watchers?: number; - allow_forking?: boolean; - }; - "organization-secret-scanning-alert": { - number?: components["schemas"]["alert-number"]; - created_at?: components["schemas"]["alert-created-at"]; - url?: components["schemas"]["alert-url"]; - html_url?: components["schemas"]["alert-html-url"]; + key?: string + name?: string + spdx_id?: string + url?: string + node_id?: string + } | null + forks?: number + open_issues?: number + watchers?: number + allow_forking?: boolean + } + 'organization-secret-scanning-alert': { + number?: components['schemas']['alert-number'] + created_at?: components['schemas']['alert-created-at'] + url?: components['schemas']['alert-url'] + html_url?: components['schemas']['alert-html-url'] /** * Format: uri * @description The REST API URL of the code locations for this alert. */ - locations_url?: string; - state?: components["schemas"]["secret-scanning-alert-state"]; - resolution?: components["schemas"]["secret-scanning-alert-resolution"]; + locations_url?: string + state?: components['schemas']['secret-scanning-alert-state'] + resolution?: components['schemas']['secret-scanning-alert-resolution'] /** * Format: date-time * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - resolved_at?: string | null; - resolved_by?: components["schemas"]["nullable-simple-user"]; + resolved_at?: string | null + resolved_by?: components['schemas']['nullable-simple-user'] /** @description The type of secret that secret scanning detected. */ - secret_type?: string; + secret_type?: string /** @description The secret that was detected. */ - secret?: string; - repository?: components["schemas"]["minimal-repository"]; - }; - "actions-billing-usage": { + secret?: string + repository?: components['schemas']['minimal-repository'] + } + 'actions-billing-usage': { /** @description The sum of the free and paid GitHub Actions minutes used. */ - total_minutes_used: number; + total_minutes_used: number /** @description The total paid GitHub Actions minutes used. */ - total_paid_minutes_used: number; + total_paid_minutes_used: number /** @description The amount of free GitHub Actions minutes available. */ - included_minutes: number; + included_minutes: number minutes_used_breakdown: { /** @description Total minutes used on Ubuntu runner machines. */ - UBUNTU?: number; + UBUNTU?: number /** @description Total minutes used on macOS runner machines. */ - MACOS?: number; + MACOS?: number /** @description Total minutes used on Windows runner machines. */ - WINDOWS?: number; - }; - }; - "advanced-security-active-committers-user": { - user_login: string; + WINDOWS?: number + } + } + 'advanced-security-active-committers-user': { + user_login: string /** @example 2021-11-03 */ - last_pushed_date: string; - }; - "advanced-security-active-committers-repository": { + last_pushed_date: string + } + 'advanced-security-active-committers-repository': { /** @example octocat/Hello-World */ - name: string; + name: string /** @example 25 */ - advanced_security_committers: number; - advanced_security_committers_breakdown: components["schemas"]["advanced-security-active-committers-user"][]; - }; - "advanced-security-active-committers": { + advanced_security_committers: number + advanced_security_committers_breakdown: components['schemas']['advanced-security-active-committers-user'][] + } + 'advanced-security-active-committers': { /** @example 25 */ - total_advanced_security_committers?: number; - repositories: components["schemas"]["advanced-security-active-committers-repository"][]; - }; - "packages-billing-usage": { + total_advanced_security_committers?: number + repositories: components['schemas']['advanced-security-active-committers-repository'][] + } + 'packages-billing-usage': { /** @description Sum of the free and paid storage space (GB) for GitHuub Packages. */ - total_gigabytes_bandwidth_used: number; + total_gigabytes_bandwidth_used: number /** @description Total paid storage space (GB) for GitHuub Packages. */ - total_paid_gigabytes_bandwidth_used: number; + total_paid_gigabytes_bandwidth_used: number /** @description Free storage space (GB) for GitHub Packages. */ - included_gigabytes_bandwidth: number; - }; - "combined-billing-usage": { + included_gigabytes_bandwidth: number + } + 'combined-billing-usage': { /** @description Numbers of days left in billing cycle. */ - days_left_in_billing_cycle: number; + days_left_in_billing_cycle: number /** @description Estimated storage space (GB) used in billing cycle. */ - estimated_paid_storage_for_month: number; + estimated_paid_storage_for_month: number /** @description Estimated sum of free and paid storage space (GB) used in billing cycle. */ - estimated_storage_for_month: number; - }; + estimated_storage_for_month: number + } /** * Actor * @description Actor */ actor: { - id: number; - login: string; - display_login?: string; - gravatar_id: string | null; + id: number + login: string + display_login?: string + gravatar_id: string | null /** Format: uri */ - url: string; + url: string /** Format: uri */ - avatar_url: string; - }; + avatar_url: string + } /** * Milestone * @description A collection of related issues and pull requests. */ - "nullable-milestone": { + 'nullable-milestone': { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1 */ - url: string; + url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/milestones/v1.0 */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1/labels */ - labels_url: string; + labels_url: string /** @example 1002604 */ - id: number; + id: number /** @example MDk6TWlsZXN0b25lMTAwMjYwNA== */ - node_id: string; + node_id: string /** * @description The number of the milestone. * @example 42 */ - number: number; + number: number /** * @description The state of the milestone. * @default open * @example open * @enum {string} */ - state: "open" | "closed"; + state: 'open' | 'closed' /** * @description The title of the milestone. * @example v1.0 */ - title: string; + title: string /** @example Tracking milestone for version 1.0 */ - description: string | null; - creator: components["schemas"]["nullable-simple-user"]; + description: string | null + creator: components['schemas']['nullable-simple-user'] /** @example 4 */ - open_issues: number; + open_issues: number /** @example 8 */ - closed_issues: number; + closed_issues: number /** * Format: date-time * @example 2011-04-10T20:09:31Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2014-03-03T18:58:10Z */ - updated_at: string; + updated_at: string /** * Format: date-time * @example 2013-02-12T13:22:01Z */ - closed_at: string | null; + closed_at: string | null /** * Format: date-time * @example 2012-10-09T23:39:01Z */ - due_on: string | null; - } | null; + due_on: string | null + } | null /** * GitHub app * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - "nullable-integration": { + 'nullable-integration': { /** * @description Unique identifier of the GitHub app * @example 37 */ - id: number; + id: number /** * @description The slug name of the GitHub app * @example probot-owners */ - slug?: string; + slug?: string /** @example MDExOkludGVncmF0aW9uMQ== */ - node_id: string; - owner: components["schemas"]["nullable-simple-user"]; + node_id: string + owner: components['schemas']['nullable-simple-user'] /** * @description The name of the GitHub app * @example Probot Owners */ - name: string; + name: string /** @example The description of the app. */ - description: string | null; + description: string | null /** * Format: uri * @example https://example.com */ - external_url: string; + external_url: string /** * Format: uri * @example https://github.com/apps/super-ci */ - html_url: string; + html_url: string /** * Format: date-time * @example 2017-07-08T16:18:44-04:00 */ - created_at: string; + created_at: string /** * Format: date-time * @example 2017-07-08T16:18:44-04:00 */ - updated_at: string; + updated_at: string /** * @description The set of permissions for the GitHub app * @example [object Object] */ permissions: { - issues?: string; - checks?: string; - metadata?: string; - contents?: string; - deployments?: string; - } & { [key: string]: string }; + issues?: string + checks?: string + metadata?: string + contents?: string + deployments?: string + } & { [key: string]: string } /** * @description The list of events for the GitHub app * @example label,deployment */ - events: string[]; + events: string[] /** * @description The number of installations associated with the GitHub app * @example 5 */ - installations_count?: number; + installations_count?: number /** @example "Iv1.25b5d1e65ffc4022" */ - client_id?: string; + client_id?: string /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ - client_secret?: string; + client_secret?: string /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ - webhook_secret?: string | null; + webhook_secret?: string | null /** @example "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n" */ - pem?: string; - } | null; + pem?: string + } | null /** * author_association * @description How the author is associated with the repository. * @example OWNER * @enum {string} */ - author_association: - | "COLLABORATOR" - | "CONTRIBUTOR" - | "FIRST_TIMER" - | "FIRST_TIME_CONTRIBUTOR" - | "MANNEQUIN" - | "MEMBER" - | "NONE" - | "OWNER"; + author_association: 'COLLABORATOR' | 'CONTRIBUTOR' | 'FIRST_TIMER' | 'FIRST_TIME_CONTRIBUTOR' | 'MANNEQUIN' | 'MEMBER' | 'NONE' | 'OWNER' /** Reaction Rollup */ - "reaction-rollup": { + 'reaction-rollup': { /** Format: uri */ - url: string; - total_count: number; - "+1": number; - "-1": number; - laugh: number; - confused: number; - heart: number; - hooray: number; - eyes: number; - rocket: number; - }; + url: string + total_count: number + '+1': number + '-1': number + laugh: number + confused: number + heart: number + hooray: number + eyes: number + rocket: number + } /** * Issue * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. */ issue: { - id: number; - node_id: string; + id: number + node_id: string /** * Format: uri * @description URL for the issue * @example https://api.github.com/repositories/42/issues/1 */ - url: string; + url: string /** Format: uri */ - repository_url: string; - labels_url: string; + repository_url: string + labels_url: string /** Format: uri */ - comments_url: string; + comments_url: string /** Format: uri */ - events_url: string; + events_url: string /** Format: uri */ - html_url: string; + html_url: string /** * @description Number uniquely identifying the issue within its repository * @example 42 */ - number: number; + number: number /** * @description State of the issue; either 'open' or 'closed' * @example open */ - state: string; + state: string /** * @description Title of the issue * @example Widget creation fails in Safari on OS X 10.8 */ - title: string; + title: string /** * @description Contents of the issue * @example It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug? */ - body?: string | null; - user: components["schemas"]["nullable-simple-user"]; + body?: string | null + user: components['schemas']['nullable-simple-user'] /** * @description Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository * @example bug,registration @@ -8380,448 +8372,448 @@ export interface components { | string | { /** Format: int64 */ - id?: number; - node_id?: string; + id?: number + node_id?: string /** Format: uri */ - url?: string; - name?: string; - description?: string | null; - color?: string | null; - default?: boolean; + url?: string + name?: string + description?: string | null + color?: string | null + default?: boolean } - )[]; - assignee: components["schemas"]["nullable-simple-user"]; - assignees?: components["schemas"]["simple-user"][] | null; - milestone: components["schemas"]["nullable-milestone"]; - locked: boolean; - active_lock_reason?: string | null; - comments: number; + )[] + assignee: components['schemas']['nullable-simple-user'] + assignees?: components['schemas']['simple-user'][] | null + milestone: components['schemas']['nullable-milestone'] + locked: boolean + active_lock_reason?: string | null + comments: number pull_request?: { /** Format: date-time */ - merged_at?: string | null; + merged_at?: string | null /** Format: uri */ - diff_url: string | null; + diff_url: string | null /** Format: uri */ - html_url: string | null; + html_url: string | null /** Format: uri */ - patch_url: string | null; + patch_url: string | null /** Format: uri */ - url: string | null; - }; + url: string | null + } /** Format: date-time */ - closed_at: string | null; + closed_at: string | null /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - draft?: boolean; - closed_by?: components["schemas"]["nullable-simple-user"]; - body_html?: string; - body_text?: string; + updated_at: string + draft?: boolean + closed_by?: components['schemas']['nullable-simple-user'] + body_html?: string + body_text?: string /** Format: uri */ - timeline_url?: string; - repository?: components["schemas"]["repository"]; - performed_via_github_app?: components["schemas"]["nullable-integration"]; - author_association: components["schemas"]["author_association"]; - reactions?: components["schemas"]["reaction-rollup"]; - }; + timeline_url?: string + repository?: components['schemas']['repository'] + performed_via_github_app?: components['schemas']['nullable-integration'] + author_association: components['schemas']['author_association'] + reactions?: components['schemas']['reaction-rollup'] + } /** * Issue Comment * @description Comments provide a way for people to collaborate on an issue. */ - "issue-comment": { + 'issue-comment': { /** * @description Unique identifier of the issue comment * @example 42 */ - id: number; - node_id: string; + id: number + node_id: string /** * Format: uri * @description URL for the issue comment * @example https://api.github.com/repositories/42/issues/comments/1 */ - url: string; + url: string /** * @description Contents of the issue comment * @example What version of Safari were you using when you observed this bug? */ - body?: string; - body_text?: string; - body_html?: string; + body?: string + body_text?: string + body_html?: string /** Format: uri */ - html_url: string; - user: components["schemas"]["nullable-simple-user"]; + html_url: string + user: components['schemas']['nullable-simple-user'] /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - updated_at: string; + updated_at: string /** Format: uri */ - issue_url: string; - author_association: components["schemas"]["author_association"]; - performed_via_github_app?: components["schemas"]["nullable-integration"]; - reactions?: components["schemas"]["reaction-rollup"]; - }; + issue_url: string + author_association: components['schemas']['author_association'] + performed_via_github_app?: components['schemas']['nullable-integration'] + reactions?: components['schemas']['reaction-rollup'] + } /** * Event * @description Event */ event: { - id: string; - type: string | null; - actor: components["schemas"]["actor"]; + id: string + type: string | null + actor: components['schemas']['actor'] repo: { - id: number; - name: string; + id: number + name: string /** Format: uri */ - url: string; - }; - org?: components["schemas"]["actor"]; + url: string + } + org?: components['schemas']['actor'] payload: { - action?: string; - issue?: components["schemas"]["issue"]; - comment?: components["schemas"]["issue-comment"]; + action?: string + issue?: components['schemas']['issue'] + comment?: components['schemas']['issue-comment'] pages?: { - page_name?: string; - title?: string; - summary?: string | null; - action?: string; - sha?: string; - html_url?: string; - }[]; - }; - public: boolean; + page_name?: string + title?: string + summary?: string | null + action?: string + sha?: string + html_url?: string + }[] + } + public: boolean /** Format: date-time */ - created_at: string | null; - }; + created_at: string | null + } /** * Link With Type * @description Hypermedia Link with Type */ - "link-with-type": { - href: string; - type: string; - }; + 'link-with-type': { + href: string + type: string + } /** * Feed * @description Feed */ feed: { /** @example https://github.com/timeline */ - timeline_url: string; + timeline_url: string /** @example https://github.com/{user} */ - user_url: string; + user_url: string /** @example https://github.com/octocat */ - current_user_public_url?: string; + current_user_public_url?: string /** @example https://github.com/octocat.private?token=abc123 */ - current_user_url?: string; + current_user_url?: string /** @example https://github.com/octocat.private.actor?token=abc123 */ - current_user_actor_url?: string; + current_user_actor_url?: string /** @example https://github.com/octocat-org */ - current_user_organization_url?: string; + current_user_organization_url?: string /** @example https://github.com/organizations/github/octocat.private.atom?token=abc123 */ - current_user_organization_urls?: string[]; + current_user_organization_urls?: string[] /** @example https://github.com/security-advisories */ - security_advisories_url?: string; + security_advisories_url?: string _links: { - timeline: components["schemas"]["link-with-type"]; - user: components["schemas"]["link-with-type"]; - security_advisories?: components["schemas"]["link-with-type"]; - current_user?: components["schemas"]["link-with-type"]; - current_user_public?: components["schemas"]["link-with-type"]; - current_user_actor?: components["schemas"]["link-with-type"]; - current_user_organization?: components["schemas"]["link-with-type"]; - current_user_organizations?: components["schemas"]["link-with-type"][]; - }; - }; + timeline: components['schemas']['link-with-type'] + user: components['schemas']['link-with-type'] + security_advisories?: components['schemas']['link-with-type'] + current_user?: components['schemas']['link-with-type'] + current_user_public?: components['schemas']['link-with-type'] + current_user_actor?: components['schemas']['link-with-type'] + current_user_organization?: components['schemas']['link-with-type'] + current_user_organizations?: components['schemas']['link-with-type'][] + } + } /** * Base Gist * @description Base Gist */ - "base-gist": { + 'base-gist': { /** Format: uri */ - url: string; + url: string /** Format: uri */ - forks_url: string; + forks_url: string /** Format: uri */ - commits_url: string; - id: string; - node_id: string; + commits_url: string + id: string + node_id: string /** Format: uri */ - git_pull_url: string; + git_pull_url: string /** Format: uri */ - git_push_url: string; + git_push_url: string /** Format: uri */ - html_url: string; + html_url: string files: { [key: string]: { - filename?: string; - type?: string; - language?: string; - raw_url?: string; - size?: number; - }; - }; - public: boolean; + filename?: string + type?: string + language?: string + raw_url?: string + size?: number + } + } + public: boolean /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - description: string | null; - comments: number; - user: components["schemas"]["nullable-simple-user"]; + updated_at: string + description: string | null + comments: number + user: components['schemas']['nullable-simple-user'] /** Format: uri */ - comments_url: string; - owner?: components["schemas"]["simple-user"]; - truncated?: boolean; - forks?: unknown[]; - history?: unknown[]; - }; + comments_url: string + owner?: components['schemas']['simple-user'] + truncated?: boolean + forks?: unknown[] + history?: unknown[] + } /** * Public User * @description Public User */ - "public-user": { - login: string; - id: number; - node_id: string; + 'public-user': { + login: string + id: number + node_id: string /** Format: uri */ - avatar_url: string; - gravatar_id: string | null; + avatar_url: string + gravatar_id: string | null /** Format: uri */ - url: string; + url: string /** Format: uri */ - html_url: string; + html_url: string /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - starred_url: string; + followers_url: string + following_url: string + gists_url: string + starred_url: string /** Format: uri */ - subscriptions_url: string; + subscriptions_url: string /** Format: uri */ - organizations_url: string; + organizations_url: string /** Format: uri */ - repos_url: string; - events_url: string; + repos_url: string + events_url: string /** Format: uri */ - received_events_url: string; - type: string; - site_admin: boolean; - name: string | null; - company: string | null; - blog: string | null; - location: string | null; + received_events_url: string + type: string + site_admin: boolean + name: string | null + company: string | null + blog: string | null + location: string | null /** Format: email */ - email: string | null; - hireable: boolean | null; - bio: string | null; - twitter_username?: string | null; - public_repos: number; - public_gists: number; - followers: number; - following: number; + email: string | null + hireable: boolean | null + bio: string | null + twitter_username?: string | null + public_repos: number + public_gists: number + followers: number + following: number /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; + updated_at: string plan?: { - collaborators: number; - name: string; - space: number; - private_repos: number; - }; + collaborators: number + name: string + space: number + private_repos: number + } /** Format: date-time */ - suspended_at?: string | null; + suspended_at?: string | null /** @example 1 */ - private_gists?: number; + private_gists?: number /** @example 2 */ - total_private_repos?: number; + total_private_repos?: number /** @example 2 */ - owned_private_repos?: number; + owned_private_repos?: number /** @example 1 */ - disk_usage?: number; + disk_usage?: number /** @example 3 */ - collaborators?: number; - }; + collaborators?: number + } /** * Gist History * @description Gist History */ - "gist-history": { - user?: components["schemas"]["nullable-simple-user"]; - version?: string; + 'gist-history': { + user?: components['schemas']['nullable-simple-user'] + version?: string /** Format: date-time */ - committed_at?: string; + committed_at?: string change_status?: { - total?: number; - additions?: number; - deletions?: number; - }; + total?: number + additions?: number + deletions?: number + } /** Format: uri */ - url?: string; - }; + url?: string + } /** * Gist Simple * @description Gist Simple */ - "gist-simple": { + 'gist-simple': { /** @deprecated */ forks?: | { - id?: string; + id?: string /** Format: uri */ - url?: string; - user?: components["schemas"]["public-user"]; + url?: string + user?: components['schemas']['public-user'] /** Format: date-time */ - created_at?: string; + created_at?: string /** Format: date-time */ - updated_at?: string; + updated_at?: string }[] - | null; + | null /** @deprecated */ - history?: components["schemas"]["gist-history"][] | null; + history?: components['schemas']['gist-history'][] | null /** * Gist * @description Gist */ fork_of?: { /** Format: uri */ - url: string; + url: string /** Format: uri */ - forks_url: string; + forks_url: string /** Format: uri */ - commits_url: string; - id: string; - node_id: string; + commits_url: string + id: string + node_id: string /** Format: uri */ - git_pull_url: string; + git_pull_url: string /** Format: uri */ - git_push_url: string; + git_push_url: string /** Format: uri */ - html_url: string; + html_url: string files: { [key: string]: { - filename?: string; - type?: string; - language?: string; - raw_url?: string; - size?: number; - }; - }; - public: boolean; + filename?: string + type?: string + language?: string + raw_url?: string + size?: number + } + } + public: boolean /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - description: string | null; - comments: number; - user: components["schemas"]["nullable-simple-user"]; + updated_at: string + description: string | null + comments: number + user: components['schemas']['nullable-simple-user'] /** Format: uri */ - comments_url: string; - owner?: components["schemas"]["nullable-simple-user"]; - truncated?: boolean; - forks?: unknown[]; - history?: unknown[]; - } | null; - url?: string; - forks_url?: string; - commits_url?: string; - id?: string; - node_id?: string; - git_pull_url?: string; - git_push_url?: string; - html_url?: string; + comments_url: string + owner?: components['schemas']['nullable-simple-user'] + truncated?: boolean + forks?: unknown[] + history?: unknown[] + } | null + url?: string + forks_url?: string + commits_url?: string + id?: string + node_id?: string + git_pull_url?: string + git_push_url?: string + html_url?: string files?: { [key: string]: { - filename?: string; - type?: string; - language?: string; - raw_url?: string; - size?: number; - truncated?: boolean; - content?: string; - } | null; - }; - public?: boolean; - created_at?: string; - updated_at?: string; - description?: string | null; - comments?: number; - user?: string | null; - comments_url?: string; - owner?: components["schemas"]["simple-user"]; - truncated?: boolean; - }; + filename?: string + type?: string + language?: string + raw_url?: string + size?: number + truncated?: boolean + content?: string + } | null + } + public?: boolean + created_at?: string + updated_at?: string + description?: string | null + comments?: number + user?: string | null + comments_url?: string + owner?: components['schemas']['simple-user'] + truncated?: boolean + } /** * Gist Comment * @description A comment made to a gist. */ - "gist-comment": { + 'gist-comment': { /** @example 1 */ - id: number; + id: number /** @example MDExOkdpc3RDb21tZW50MQ== */ - node_id: string; + node_id: string /** * Format: uri * @example https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 */ - url: string; + url: string /** * @description The comment text. * @example Body of the attachment */ - body: string; - user: components["schemas"]["nullable-simple-user"]; + body: string + user: components['schemas']['nullable-simple-user'] /** * Format: date-time * @example 2011-04-18T23:23:56Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2011-04-18T23:23:56Z */ - updated_at: string; - author_association: components["schemas"]["author_association"]; - }; + updated_at: string + author_association: components['schemas']['author_association'] + } /** * Gist Commit * @description Gist Commit */ - "gist-commit": { + 'gist-commit': { /** * Format: uri * @example https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f */ - url: string; + url: string /** @example 57a7f021a713b1c5a6a199b54cc514735d2d462f */ - version: string; - user: components["schemas"]["nullable-simple-user"]; + version: string + user: components['schemas']['nullable-simple-user'] change_status: { - total?: number; - additions?: number; - deletions?: number; - }; + total?: number + additions?: number + deletions?: number + } /** * Format: date-time * @example 2010-04-14T02:15:15Z */ - committed_at: string; - }; + committed_at: string + } /** * Gitignore Template * @description Gitignore Template */ - "gitignore-template": { + 'gitignore-template': { /** @example C */ - name: string; + name: string /** * @example # Object files * *.o @@ -8841,62 +8833,62 @@ export interface components { * *.out * *.app */ - source: string; - }; + source: string + } /** * License Simple * @description License Simple */ - "license-simple": { + 'license-simple': { /** @example mit */ - key: string; + key: string /** @example MIT License */ - name: string; + name: string /** * Format: uri * @example https://api.github.com/licenses/mit */ - url: string | null; + url: string | null /** @example MIT */ - spdx_id: string | null; + spdx_id: string | null /** @example MDc6TGljZW5zZW1pdA== */ - node_id: string; + node_id: string /** Format: uri */ - html_url?: string; - }; + html_url?: string + } /** * License * @description License */ license: { /** @example mit */ - key: string; + key: string /** @example MIT License */ - name: string; + name: string /** @example MIT */ - spdx_id: string | null; + spdx_id: string | null /** * Format: uri * @example https://api.github.com/licenses/mit */ - url: string | null; + url: string | null /** @example MDc6TGljZW5zZW1pdA== */ - node_id: string; + node_id: string /** * Format: uri * @example http://choosealicense.com/licenses/mit/ */ - html_url: string; + html_url: string /** @example A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty. */ - description: string; + description: string /** @example Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders. */ - implementation: string; + implementation: string /** @example commercial-use,modifications,distribution,sublicense,private-use */ - permissions: string[]; + permissions: string[] /** @example include-copyright */ - conditions: string[]; + conditions: string[] /** @example no-liability */ - limitations: string[]; + limitations: string[] /** * @example * @@ -8922,174 +8914,174 @@ export interface components { * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ - body: string; + body: string /** @example true */ - featured: boolean; - }; + featured: boolean + } /** * Marketplace Listing Plan * @description Marketplace Listing Plan */ - "marketplace-listing-plan": { + 'marketplace-listing-plan': { /** * Format: uri * @example https://api.github.com/marketplace_listing/plans/1313 */ - url: string; + url: string /** * Format: uri * @example https://api.github.com/marketplace_listing/plans/1313/accounts */ - accounts_url: string; + accounts_url: string /** @example 1313 */ - id: number; + id: number /** @example 3 */ - number: number; + number: number /** @example Pro */ - name: string; + name: string /** @example A professional-grade CI solution */ - description: string; + description: string /** @example 1099 */ - monthly_price_in_cents: number; + monthly_price_in_cents: number /** @example 11870 */ - yearly_price_in_cents: number; + yearly_price_in_cents: number /** @example flat-rate */ - price_model: string; + price_model: string /** @example true */ - has_free_trial: boolean; - unit_name: string | null; + has_free_trial: boolean + unit_name: string | null /** @example published */ - state: string; + state: string /** @example Up to 25 private repositories,11 concurrent builds */ - bullets: string[]; - }; + bullets: string[] + } /** * Marketplace Purchase * @description Marketplace Purchase */ - "marketplace-purchase": { - url: string; - type: string; - id: number; - login: string; - organization_billing_email?: string; - email?: string | null; + 'marketplace-purchase': { + url: string + type: string + id: number + login: string + organization_billing_email?: string + email?: string | null marketplace_pending_change?: { - is_installed?: boolean; - effective_date?: string; - unit_count?: number | null; - id?: number; - plan?: components["schemas"]["marketplace-listing-plan"]; - } | null; + is_installed?: boolean + effective_date?: string + unit_count?: number | null + id?: number + plan?: components['schemas']['marketplace-listing-plan'] + } | null marketplace_purchase: { - billing_cycle?: string; - next_billing_date?: string | null; - is_installed?: boolean; - unit_count?: number | null; - on_free_trial?: boolean; - free_trial_ends_on?: string | null; - updated_at?: string; - plan?: components["schemas"]["marketplace-listing-plan"]; - }; - }; + billing_cycle?: string + next_billing_date?: string | null + is_installed?: boolean + unit_count?: number | null + on_free_trial?: boolean + free_trial_ends_on?: string | null + updated_at?: string + plan?: components['schemas']['marketplace-listing-plan'] + } + } /** * Api Overview * @description Api Overview */ - "api-overview": { + 'api-overview': { /** @example true */ - verifiable_password_authentication: boolean; + verifiable_password_authentication: boolean ssh_key_fingerprints?: { - SHA256_RSA?: string; - SHA256_DSA?: string; - SHA256_ECDSA?: string; - SHA256_ED25519?: string; - }; + SHA256_RSA?: string + SHA256_DSA?: string + SHA256_ECDSA?: string + SHA256_ED25519?: string + } /** @example ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIOMqqnkVzrm0SdG6UOoqKLsabgH5C9okWi0dh2l9GKJl */ - ssh_keys?: string[]; + ssh_keys?: string[] /** @example 127.0.0.1/32 */ - hooks?: string[]; + hooks?: string[] /** @example 127.0.0.1/32 */ - web?: string[]; + web?: string[] /** @example 127.0.0.1/32 */ - api?: string[]; + api?: string[] /** @example 127.0.0.1/32 */ - git?: string[]; + git?: string[] /** @example 13.65.0.0/16,157.55.204.33/32,2a01:111:f403:f90c::/62 */ - packages?: string[]; + packages?: string[] /** @example 192.30.252.153/32,192.30.252.154/32 */ - pages?: string[]; + pages?: string[] /** @example 54.158.161.132,54.226.70.38 */ - importer?: string[]; + importer?: string[] /** @example 13.64.0.0/16,13.65.0.0/16 */ - actions?: string[]; + actions?: string[] /** @example 192.168.7.15/32,192.168.7.16/32 */ - dependabot?: string[]; - }; + dependabot?: string[] + } /** * Thread * @description Thread */ thread: { - id: string; - repository: components["schemas"]["minimal-repository"]; + id: string + repository: components['schemas']['minimal-repository'] subject: { - title: string; - url: string; - latest_comment_url: string; - type: string; - }; - reason: string; - unread: boolean; - updated_at: string; - last_read_at: string | null; - url: string; + title: string + url: string + latest_comment_url: string + type: string + } + reason: string + unread: boolean + updated_at: string + last_read_at: string | null + url: string /** @example https://api.github.com/notifications/threads/2/subscription */ - subscription_url: string; - }; + subscription_url: string + } /** * Thread Subscription * @description Thread Subscription */ - "thread-subscription": { + 'thread-subscription': { /** @example true */ - subscribed: boolean; - ignored: boolean; - reason: string | null; + subscribed: boolean + ignored: boolean + reason: string | null /** * Format: date-time * @example 2012-10-06T21:34:12Z */ - created_at: string | null; + created_at: string | null /** * Format: uri * @example https://api.github.com/notifications/threads/1/subscription */ - url: string; + url: string /** * Format: uri * @example https://api.github.com/notifications/threads/1 */ - thread_url?: string; + thread_url?: string /** * Format: uri * @example https://api.github.com/repos/1 */ - repository_url?: string; - }; + repository_url?: string + } /** * Organization Custom Repository Role * @description Custom repository roles created by organization administrators */ - "organization-custom-repository-role": { - id: number; - name: string; - }; + 'organization-custom-repository-role': { + id: number + name: string + } /** * ExternalGroups * @description A list of external groups available to be connected to a team */ - "external-groups": { + 'external-groups': { /** * @description An array of external groups available to be mapped to a team * @example [object Object],[object Object] @@ -9099,488 +9091,488 @@ export interface components { * @description The internal ID of the group * @example 1 */ - group_id: number; + group_id: number /** * @description The display name of the group * @example group-azuread-test */ - group_name: string; + group_name: string /** * @description The time of the last update for this group * @example 2019-06-03 22:27:15:000 -700 */ - updated_at: string; - }[]; - }; + updated_at: string + }[] + } /** * Organization Full * @description Organization Full */ - "organization-full": { + 'organization-full': { /** @example github */ - login: string; + login: string /** @example 1 */ - id: number; + id: number /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ - node_id: string; + node_id: string /** * Format: uri * @example https://api.github.com/orgs/github */ - url: string; + url: string /** * Format: uri * @example https://api.github.com/orgs/github/repos */ - repos_url: string; + repos_url: string /** * Format: uri * @example https://api.github.com/orgs/github/events */ - events_url: string; + events_url: string /** @example https://api.github.com/orgs/github/hooks */ - hooks_url: string; + hooks_url: string /** @example https://api.github.com/orgs/github/issues */ - issues_url: string; + issues_url: string /** @example https://api.github.com/orgs/github/members{/member} */ - members_url: string; + members_url: string /** @example https://api.github.com/orgs/github/public_members{/member} */ - public_members_url: string; + public_members_url: string /** @example https://github.com/images/error/octocat_happy.gif */ - avatar_url: string; + avatar_url: string /** @example A great organization */ - description: string | null; + description: string | null /** @example github */ - name?: string; + name?: string /** @example GitHub */ - company?: string; + company?: string /** * Format: uri * @example https://github.com/blog */ - blog?: string; + blog?: string /** @example San Francisco */ - location?: string; + location?: string /** * Format: email * @example octocat@github.com */ - email?: string; + email?: string /** @example github */ - twitter_username?: string | null; + twitter_username?: string | null /** @example true */ - is_verified?: boolean; + is_verified?: boolean /** @example true */ - has_organization_projects: boolean; + has_organization_projects: boolean /** @example true */ - has_repository_projects: boolean; + has_repository_projects: boolean /** @example 2 */ - public_repos: number; + public_repos: number /** @example 1 */ - public_gists: number; + public_gists: number /** @example 20 */ - followers: number; - following: number; + followers: number + following: number /** * Format: uri * @example https://github.com/octocat */ - html_url: string; + html_url: string /** * Format: date-time * @example 2008-01-14T04:33:35Z */ - created_at: string; + created_at: string /** @example Organization */ - type: string; + type: string /** @example 100 */ - total_private_repos?: number; + total_private_repos?: number /** @example 100 */ - owned_private_repos?: number; + owned_private_repos?: number /** @example 81 */ - private_gists?: number | null; + private_gists?: number | null /** @example 10000 */ - disk_usage?: number | null; + disk_usage?: number | null /** @example 8 */ - collaborators?: number | null; + collaborators?: number | null /** * Format: email * @example org@example.com */ - billing_email?: string | null; + billing_email?: string | null plan?: { - name: string; - space: number; - private_repos: number; - filled_seats?: number; - seats?: number; - }; - default_repository_permission?: string | null; + name: string + space: number + private_repos: number + filled_seats?: number + seats?: number + } + default_repository_permission?: string | null /** @example true */ - members_can_create_repositories?: boolean | null; + members_can_create_repositories?: boolean | null /** @example true */ - two_factor_requirement_enabled?: boolean | null; + two_factor_requirement_enabled?: boolean | null /** @example all */ - members_allowed_repository_creation_type?: string; + members_allowed_repository_creation_type?: string /** @example true */ - members_can_create_public_repositories?: boolean; + members_can_create_public_repositories?: boolean /** @example true */ - members_can_create_private_repositories?: boolean; + members_can_create_private_repositories?: boolean /** @example true */ - members_can_create_internal_repositories?: boolean; + members_can_create_internal_repositories?: boolean /** @example true */ - members_can_create_pages?: boolean; + members_can_create_pages?: boolean /** @example true */ - members_can_create_public_pages?: boolean; + members_can_create_public_pages?: boolean /** @example true */ - members_can_create_private_pages?: boolean; - members_can_fork_private_repositories?: boolean | null; + members_can_create_private_pages?: boolean + members_can_fork_private_repositories?: boolean | null /** Format: date-time */ - updated_at: string; - }; + updated_at: string + } /** * @description The policy that controls the repositories in the organization that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`. * @enum {string} */ - "enabled-repositories": "all" | "none" | "selected"; - "actions-organization-permissions": { - enabled_repositories: components["schemas"]["enabled-repositories"]; + 'enabled-repositories': 'all' | 'none' | 'selected' + 'actions-organization-permissions': { + enabled_repositories: components['schemas']['enabled-repositories'] /** @description The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. */ - selected_repositories_url?: string; - allowed_actions?: components["schemas"]["allowed-actions"]; - selected_actions_url?: components["schemas"]["selected-actions-url"]; - }; + selected_repositories_url?: string + allowed_actions?: components['schemas']['allowed-actions'] + selected_actions_url?: components['schemas']['selected-actions-url'] + } /** * @description The default workflow permissions granted to the GITHUB_TOKEN when running workflows in an organization. * @enum {string} */ - "actions-default-workflow-permissions": "read" | "write"; + 'actions-default-workflow-permissions': 'read' | 'write' /** @description Whether GitHub Actions can submit approving pull request reviews. */ - "actions-can-approve-pull-request-reviews": boolean; - "actions-get-default-workflow-permissions": { - default_workflow_permissions: components["schemas"]["actions-default-workflow-permissions"]; - can_approve_pull_request_reviews: components["schemas"]["actions-can-approve-pull-request-reviews"]; - }; - "actions-set-default-workflow-permissions": { - default_workflow_permissions?: components["schemas"]["actions-default-workflow-permissions"]; - can_approve_pull_request_reviews?: components["schemas"]["actions-can-approve-pull-request-reviews"]; - }; - "runner-groups-org": { - id: number; - name: string; - visibility: string; - default: boolean; + 'actions-can-approve-pull-request-reviews': boolean + 'actions-get-default-workflow-permissions': { + default_workflow_permissions: components['schemas']['actions-default-workflow-permissions'] + can_approve_pull_request_reviews: components['schemas']['actions-can-approve-pull-request-reviews'] + } + 'actions-set-default-workflow-permissions': { + default_workflow_permissions?: components['schemas']['actions-default-workflow-permissions'] + can_approve_pull_request_reviews?: components['schemas']['actions-can-approve-pull-request-reviews'] + } + 'runner-groups-org': { + id: number + name: string + visibility: string + default: boolean /** @description Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected` */ - selected_repositories_url?: string; - runners_url: string; - inherited: boolean; - inherited_allows_public_repositories?: boolean; - allows_public_repositories: boolean; - }; + selected_repositories_url?: string + runners_url: string + inherited: boolean + inherited_allows_public_repositories?: boolean + allows_public_repositories: boolean + } /** * Actions Secret for an Organization * @description Secrets for GitHub Actions for an organization. */ - "organization-actions-secret": { + 'organization-actions-secret': { /** * @description The name of the secret. * @example SECRET_TOKEN */ - name: string; + name: string /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; + updated_at: string /** * @description Visibility of a secret * @enum {string} */ - visibility: "all" | "private" | "selected"; + visibility: 'all' | 'private' | 'selected' /** * Format: uri * @example https://api.github.com/organizations/org/secrets/my_secret/repositories */ - selected_repositories_url?: string; - }; + selected_repositories_url?: string + } /** * ActionsPublicKey * @description The public key used for setting Actions Secrets. */ - "actions-public-key": { + 'actions-public-key': { /** * @description The identifier for the key. * @example 1234567 */ - key_id: string; + key_id: string /** * @description The Base64 encoded public key. * @example hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= */ - key: string; + key: string /** @example 2 */ - id?: number; + id?: number /** @example https://api.github.com/user/keys/2 */ - url?: string; + url?: string /** @example ssh-rsa AAAAB3NzaC1yc2EAAA */ - title?: string; + title?: string /** @example 2011-01-26T19:01:12Z */ - created_at?: string; - }; + created_at?: string + } /** * Empty Object * @description An object without any properties. */ - "empty-object": { [key: string]: unknown }; + 'empty-object': { [key: string]: unknown } /** * @description State of a code scanning alert. * @enum {string} */ - "code-scanning-alert-state": "open" | "closed" | "dismissed" | "fixed"; + 'code-scanning-alert-state': 'open' | 'closed' | 'dismissed' | 'fixed' /** * Format: date-time * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "alert-updated-at": string; + 'alert-updated-at': string /** * Format: uri * @description The REST API URL for fetching the list of instances for an alert. */ - "alert-instances-url": string; + 'alert-instances-url': string /** * Format: date-time * @description The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "code-scanning-alert-fixed-at": string | null; + 'code-scanning-alert-fixed-at': string | null /** * Format: date-time * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "code-scanning-alert-dismissed-at": string | null; + 'code-scanning-alert-dismissed-at': string | null /** * @description **Required when the state is dismissed.** The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. * @enum {string|null} */ - "code-scanning-alert-dismissed-reason": (null | "false positive" | "won't fix" | "used in tests") | null; - "code-scanning-alert-rule": { + 'code-scanning-alert-dismissed-reason': (null | 'false positive' | "won't fix" | 'used in tests') | null + 'code-scanning-alert-rule': { /** @description A unique identifier for the rule used to detect the alert. */ - id?: string | null; + id?: string | null /** @description The name of the rule used to detect the alert. */ - name?: string; + name?: string /** * @description The severity of the alert. * @enum {string|null} */ - severity?: ("none" | "note" | "warning" | "error") | null; + severity?: ('none' | 'note' | 'warning' | 'error') | null /** * @description The security severity of the alert. * @enum {string|null} */ - security_severity_level?: ("low" | "medium" | "high" | "critical") | null; + security_severity_level?: ('low' | 'medium' | 'high' | 'critical') | null /** @description A short description of the rule used to detect the alert. */ - description?: string; + description?: string /** @description description of the rule used to detect the alert. */ - full_description?: string; + full_description?: string /** @description A set of tags applicable for the rule. */ - tags?: string[] | null; + tags?: string[] | null /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */ - help?: string | null; - }; + help?: string | null + } /** @description The name of the tool used to generate the code scanning analysis. */ - "code-scanning-analysis-tool-name": string; + 'code-scanning-analysis-tool-name': string /** @description The version of the tool used to generate the code scanning analysis. */ - "code-scanning-analysis-tool-version": string | null; + 'code-scanning-analysis-tool-version': string | null /** @description The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. */ - "code-scanning-analysis-tool-guid": string | null; - "code-scanning-analysis-tool": { - name?: components["schemas"]["code-scanning-analysis-tool-name"]; - version?: components["schemas"]["code-scanning-analysis-tool-version"]; - guid?: components["schemas"]["code-scanning-analysis-tool-guid"]; - }; + 'code-scanning-analysis-tool-guid': string | null + 'code-scanning-analysis-tool': { + name?: components['schemas']['code-scanning-analysis-tool-name'] + version?: components['schemas']['code-scanning-analysis-tool-version'] + guid?: components['schemas']['code-scanning-analysis-tool-guid'] + } /** * @description The full Git reference, formatted as `refs/heads/`, * `refs/pull//merge`, or `refs/pull//head`. */ - "code-scanning-ref": string; + 'code-scanning-ref': string /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - "code-scanning-analysis-analysis-key": string; + 'code-scanning-analysis-analysis-key': string /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - "code-scanning-alert-environment": string; + 'code-scanning-alert-environment': string /** @description Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code. */ - "code-scanning-analysis-category": string; + 'code-scanning-analysis-category': string /** @description Describe a region within a file for the alert. */ - "code-scanning-alert-location": { - path?: string; - start_line?: number; - end_line?: number; - start_column?: number; - end_column?: number; - }; + 'code-scanning-alert-location': { + path?: string + start_line?: number + end_line?: number + start_column?: number + end_column?: number + } /** * @description A classification of the file. For example to identify it as generated. * @enum {string|null} */ - "code-scanning-alert-classification": ("source" | "generated" | "test" | "library") | null; - "code-scanning-alert-instance": { - ref?: components["schemas"]["code-scanning-ref"]; - analysis_key?: components["schemas"]["code-scanning-analysis-analysis-key"]; - environment?: components["schemas"]["code-scanning-alert-environment"]; - category?: components["schemas"]["code-scanning-analysis-category"]; - state?: components["schemas"]["code-scanning-alert-state"]; - commit_sha?: string; + 'code-scanning-alert-classification': ('source' | 'generated' | 'test' | 'library') | null + 'code-scanning-alert-instance': { + ref?: components['schemas']['code-scanning-ref'] + analysis_key?: components['schemas']['code-scanning-analysis-analysis-key'] + environment?: components['schemas']['code-scanning-alert-environment'] + category?: components['schemas']['code-scanning-analysis-category'] + state?: components['schemas']['code-scanning-alert-state'] + commit_sha?: string message?: { - text?: string; - }; - location?: components["schemas"]["code-scanning-alert-location"]; - html_url?: string; + text?: string + } + location?: components['schemas']['code-scanning-alert-location'] + html_url?: string /** * @description Classifications that have been applied to the file that triggered the alert. * For example identifying it as documentation, or a generated file. */ - classifications?: components["schemas"]["code-scanning-alert-classification"][]; - }; - "code-scanning-organization-alert-items": { - number: components["schemas"]["alert-number"]; - created_at: components["schemas"]["alert-created-at"]; - updated_at?: components["schemas"]["alert-updated-at"]; - url: components["schemas"]["alert-url"]; - html_url: components["schemas"]["alert-html-url"]; - instances_url: components["schemas"]["alert-instances-url"]; - state: components["schemas"]["code-scanning-alert-state"]; - fixed_at?: components["schemas"]["code-scanning-alert-fixed-at"]; - dismissed_by: components["schemas"]["nullable-simple-user"]; - dismissed_at: components["schemas"]["code-scanning-alert-dismissed-at"]; - dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"]; - rule: components["schemas"]["code-scanning-alert-rule"]; - tool: components["schemas"]["code-scanning-analysis-tool"]; - most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; - repository: components["schemas"]["minimal-repository"]; - }; + classifications?: components['schemas']['code-scanning-alert-classification'][] + } + 'code-scanning-organization-alert-items': { + number: components['schemas']['alert-number'] + created_at: components['schemas']['alert-created-at'] + updated_at?: components['schemas']['alert-updated-at'] + url: components['schemas']['alert-url'] + html_url: components['schemas']['alert-html-url'] + instances_url: components['schemas']['alert-instances-url'] + state: components['schemas']['code-scanning-alert-state'] + fixed_at?: components['schemas']['code-scanning-alert-fixed-at'] + dismissed_by: components['schemas']['nullable-simple-user'] + dismissed_at: components['schemas']['code-scanning-alert-dismissed-at'] + dismissed_reason: components['schemas']['code-scanning-alert-dismissed-reason'] + rule: components['schemas']['code-scanning-alert-rule'] + tool: components['schemas']['code-scanning-analysis-tool'] + most_recent_instance: components['schemas']['code-scanning-alert-instance'] + repository: components['schemas']['minimal-repository'] + } /** * Credential Authorization * @description Credential Authorization */ - "credential-authorization": { + 'credential-authorization': { /** * @description User login that owns the underlying credential. * @example monalisa */ - login: string; + login: string /** * @description Unique identifier for the credential. * @example 1 */ - credential_id: number; + credential_id: number /** * @description Human-readable description of the credential type. * @example SSH Key */ - credential_type: string; + credential_type: string /** * @description Last eight characters of the credential. Only included in responses with credential_type of personal access token. * @example 12345678 */ - token_last_eight?: string; + token_last_eight?: string /** * Format: date-time * @description Date when the credential was authorized for use. * @example 2011-01-26T19:06:43Z */ - credential_authorized_at: string; + credential_authorized_at: string /** * @description List of oauth scopes the token has been granted. * @example user,repo */ - scopes?: string[]; + scopes?: string[] /** * @description Unique string to distinguish the credential. Only included in responses with credential_type of SSH Key. * @example jklmnop12345678 */ - fingerprint?: string; + fingerprint?: string /** * Format: date-time * @description Date when the credential was last accessed. May be null if it was never accessed * @example 2011-01-26T19:06:43Z */ - credential_accessed_at: string | null; + credential_accessed_at: string | null /** @example 12345678 */ - authorized_credential_id: number | null; + authorized_credential_id: number | null /** * @description The title given to the ssh key. This will only be present when the credential is an ssh key. * @example my ssh key */ - authorized_credential_title?: string | null; + authorized_credential_title?: string | null /** * @description The note given to the token. This will only be present when the credential is a token. * @example my token */ - authorized_credential_note?: string | null; + authorized_credential_note?: string | null /** * Format: date-time * @description The expiry for the token. This will only be present when the credential is a token. */ - authorized_credential_expires_at?: string | null; - }; + authorized_credential_expires_at?: string | null + } /** * Dependabot Secret for an Organization * @description Secrets for GitHub Dependabot for an organization. */ - "organization-dependabot-secret": { + 'organization-dependabot-secret': { /** * @description The name of the secret. * @example SECRET_TOKEN */ - name: string; + name: string /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; + updated_at: string /** * @description Visibility of a secret * @enum {string} */ - visibility: "all" | "private" | "selected"; + visibility: 'all' | 'private' | 'selected' /** * Format: uri * @example https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories */ - selected_repositories_url?: string; - }; + selected_repositories_url?: string + } /** * DependabotPublicKey * @description The public key used for setting Dependabot Secrets. */ - "dependabot-public-key": { + 'dependabot-public-key': { /** * @description The identifier for the key. * @example 1234567 */ - key_id: string; + key_id: string /** * @description The Base64 encoded public key. * @example hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= */ - key: string; - }; + key: string + } /** * ExternalGroup * @description Information about an external group's usage and its members */ - "external-group": { + 'external-group': { /** * @description The internal ID of the group * @example 1 */ - group_id: number; + group_id: number /** * @description The display name for the group * @example group-azuread-test */ - group_name: string; + group_name: string /** * @description The date when the group was last updated_at * @example 2021-01-03 22:27:15:000 -700 */ - updated_at?: string; + updated_at?: string /** * @description An array of teams linked to this group * @example [object Object],[object Object] @@ -9590,13 +9582,13 @@ export interface components { * @description The id for a team * @example 1 */ - team_id: number; + team_id: number /** * @description The name of the team * @example team-test */ - team_name: string; - }[]; + team_name: string + }[] /** * @description An array of external members linked to this group * @example [object Object],[object Object] @@ -9606,493 +9598,493 @@ export interface components { * @description The internal user ID of the identity * @example 1 */ - member_id: number; + member_id: number /** * @description The handle/login for the user * @example mona-lisa_eocsaxrs */ - member_login: string; + member_login: string /** * @description The user display name/profile name * @example Mona Lisa */ - member_name: string; + member_name: string /** * @description An email attached to a user * @example mona_lisa@github.com */ - member_email: string; - }[]; - }; + member_email: string + }[] + } /** * Organization Invitation * @description Organization Invitation */ - "organization-invitation": { - id: number; - login: string | null; - email: string | null; - role: string; - created_at: string; - failed_at?: string | null; - failed_reason?: string | null; - inviter: components["schemas"]["simple-user"]; - team_count: number; + 'organization-invitation': { + id: number + login: string | null + email: string | null + role: string + created_at: string + failed_at?: string | null + failed_reason?: string | null + inviter: components['schemas']['simple-user'] + team_count: number /** @example "MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x" */ - node_id: string; + node_id: string /** @example "https://api.github.com/organizations/16/invitations/1/teams" */ - invitation_teams_url: string; - }; + invitation_teams_url: string + } /** * Org Hook * @description Org Hook */ - "org-hook": { + 'org-hook': { /** @example 1 */ - id: number; + id: number /** * Format: uri * @example https://api.github.com/orgs/octocat/hooks/1 */ - url: string; + url: string /** * Format: uri * @example https://api.github.com/orgs/octocat/hooks/1/pings */ - ping_url: string; + ping_url: string /** * Format: uri * @example https://api.github.com/orgs/octocat/hooks/1/deliveries */ - deliveries_url?: string; + deliveries_url?: string /** @example web */ - name: string; + name: string /** @example push,pull_request */ - events: string[]; + events: string[] /** @example true */ - active: boolean; + active: boolean config: { /** @example "http://example.com/2" */ - url?: string; + url?: string /** @example "0" */ - insecure_ssl?: string; + insecure_ssl?: string /** @example "form" */ - content_type?: string; + content_type?: string /** @example "********" */ - secret?: string; - }; + secret?: string + } /** * Format: date-time * @example 2011-09-06T20:39:23Z */ - updated_at: string; + updated_at: string /** * Format: date-time * @example 2011-09-06T17:26:27Z */ - created_at: string; - type: string; - }; + created_at: string + type: string + } /** * @description The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. Can be one of: `existing_users`, `contributors_only`, `collaborators_only`. * @example collaborators_only * @enum {string} */ - "interaction-group": "existing_users" | "contributors_only" | "collaborators_only"; + 'interaction-group': 'existing_users' | 'contributors_only' | 'collaborators_only' /** * Interaction Limits * @description Interaction limit settings. */ - "interaction-limit-response": { - limit: components["schemas"]["interaction-group"]; + 'interaction-limit-response': { + limit: components['schemas']['interaction-group'] /** @example repository */ - origin: string; + origin: string /** * Format: date-time * @example 2018-08-17T04:18:39Z */ - expires_at: string; - }; + expires_at: string + } /** * @description The duration of the interaction restriction. Can be one of: `one_day`, `three_days`, `one_week`, `one_month`, `six_months`. Default: `one_day`. * @example one_month * @enum {string} */ - "interaction-expiry": "one_day" | "three_days" | "one_week" | "one_month" | "six_months"; + 'interaction-expiry': 'one_day' | 'three_days' | 'one_week' | 'one_month' | 'six_months' /** * Interaction Restrictions * @description Limit interactions to a specific type of user for a specified duration */ - "interaction-limit": { - limit: components["schemas"]["interaction-group"]; - expiry?: components["schemas"]["interaction-expiry"]; - }; + 'interaction-limit': { + limit: components['schemas']['interaction-group'] + expiry?: components['schemas']['interaction-expiry'] + } /** * Team Simple * @description Groups of organization members that gives permissions on specified repositories. */ - "nullable-team-simple": { + 'nullable-team-simple': { /** * @description Unique identifier of the team * @example 1 */ - id: number; + id: number /** @example MDQ6VGVhbTE= */ - node_id: string; + node_id: string /** * Format: uri * @description URL for the team * @example https://api.github.com/organizations/1/team/1 */ - url: string; + url: string /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - members_url: string; + members_url: string /** * @description Name of the team * @example Justice League */ - name: string; + name: string /** * @description Description of the team * @example A great team. */ - description: string | null; + description: string | null /** * @description Permission that the team will have for its repositories * @example admin */ - permission: string; + permission: string /** * @description The level of privacy this team should have * @example closed */ - privacy?: string; + privacy?: string /** * Format: uri * @example https://github.com/orgs/rails/teams/core */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/organizations/1/team/1/repos */ - repositories_url: string; + repositories_url: string /** @example justice-league */ - slug: string; + slug: string /** * @description Distinguished Name (DN) that team maps to within LDAP environment * @example uid=example,ou=users,dc=github,dc=com */ - ldap_dn?: string; - } | null; + ldap_dn?: string + } | null /** * Team * @description Groups of organization members that gives permissions on specified repositories. */ team: { - id: number; - node_id: string; - name: string; - slug: string; - description: string | null; - privacy?: string; - permission: string; + id: number + node_id: string + name: string + slug: string + description: string | null + privacy?: string + permission: string permissions?: { - pull: boolean; - triage: boolean; - push: boolean; - maintain: boolean; - admin: boolean; - }; + pull: boolean + triage: boolean + push: boolean + maintain: boolean + admin: boolean + } /** Format: uri */ - url: string; + url: string /** * Format: uri * @example https://github.com/orgs/rails/teams/core */ - html_url: string; - members_url: string; + html_url: string + members_url: string /** Format: uri */ - repositories_url: string; - parent: components["schemas"]["nullable-team-simple"]; - }; + repositories_url: string + parent: components['schemas']['nullable-team-simple'] + } /** * Org Membership * @description Org Membership */ - "org-membership": { + 'org-membership': { /** * Format: uri * @example https://api.github.com/orgs/octocat/memberships/defunkt */ - url: string; + url: string /** * @description The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation. * @example active * @enum {string} */ - state: "active" | "pending"; + state: 'active' | 'pending' /** * @description The user's membership type in the organization. * @example admin * @enum {string} */ - role: "admin" | "member" | "billing_manager"; + role: 'admin' | 'member' | 'billing_manager' /** * Format: uri * @example https://api.github.com/orgs/octocat */ - organization_url: string; - organization: components["schemas"]["organization-simple"]; - user: components["schemas"]["nullable-simple-user"]; + organization_url: string + organization: components['schemas']['organization-simple'] + user: components['schemas']['nullable-simple-user'] permissions?: { - can_create_repository: boolean; - }; - }; + can_create_repository: boolean + } + } /** * Migration * @description A migration. */ migration: { /** @example 79 */ - id: number; - owner: components["schemas"]["nullable-simple-user"]; + id: number + owner: components['schemas']['nullable-simple-user'] /** @example 0b989ba4-242f-11e5-81e1-c7b6966d2516 */ - guid: string; + guid: string /** @example pending */ - state: string; + state: string /** @example true */ - lock_repositories: boolean; - exclude_metadata: boolean; - exclude_git_data: boolean; - exclude_attachments: boolean; - exclude_releases: boolean; - exclude_owner_projects: boolean; - repositories: components["schemas"]["repository"][]; + lock_repositories: boolean + exclude_metadata: boolean + exclude_git_data: boolean + exclude_attachments: boolean + exclude_releases: boolean + exclude_owner_projects: boolean + repositories: components['schemas']['repository'][] /** * Format: uri * @example https://api.github.com/orgs/octo-org/migrations/79 */ - url: string; + url: string /** * Format: date-time * @example 2015-07-06T15:33:38-07:00 */ - created_at: string; + created_at: string /** * Format: date-time * @example 2015-07-06T15:33:38-07:00 */ - updated_at: string; - node_id: string; + updated_at: string + node_id: string /** Format: uri */ - archive_url?: string; - exclude?: unknown[]; - }; + archive_url?: string + exclude?: unknown[] + } /** * Minimal Repository * @description Minimal Repository */ - "nullable-minimal-repository": { + 'nullable-minimal-repository': { /** @example 1296269 */ - id: number; + id: number /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - node_id: string; + node_id: string /** @example Hello-World */ - name: string; + name: string /** @example octocat/Hello-World */ - full_name: string; - owner: components["schemas"]["simple-user"]; - private: boolean; + full_name: string + owner: components['schemas']['simple-user'] + private: boolean /** * Format: uri * @example https://github.com/octocat/Hello-World */ - html_url: string; + html_url: string /** @example This your first repo! */ - description: string | null; - fork: boolean; + description: string | null + fork: boolean /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World */ - url: string; + url: string /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - archive_url: string; + archive_url: string /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - assignees_url: string; + assignees_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - blobs_url: string; + blobs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - branches_url: string; + branches_url: string /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - collaborators_url: string; + collaborators_url: string /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - comments_url: string; + comments_url: string /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - commits_url: string; + commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - compare_url: string; + compare_url: string /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - contents_url: string; + contents_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - contributors_url: string; + contributors_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - deployments_url: string; + deployments_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - downloads_url: string; + downloads_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events */ - events_url: string; + events_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ - forks_url: string; + forks_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - git_commits_url: string; + git_commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - git_refs_url: string; + git_refs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - git_tags_url: string; - git_url?: string; + git_tags_url: string + git_url?: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - issue_comment_url: string; + issue_comment_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - issue_events_url: string; + issue_events_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - issues_url: string; + issues_url: string /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - keys_url: string; + keys_url: string /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - labels_url: string; + labels_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ - languages_url: string; + languages_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ - merges_url: string; + merges_url: string /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - milestones_url: string; + milestones_url: string /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - notifications_url: string; + notifications_url: string /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - pulls_url: string; + pulls_url: string /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - releases_url: string; - ssh_url?: string; + releases_url: string + ssh_url?: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - stargazers_url: string; + stargazers_url: string /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - statuses_url: string; + statuses_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - subscribers_url: string; + subscribers_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - subscription_url: string; + subscription_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ - tags_url: string; + tags_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ - teams_url: string; + teams_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - trees_url: string; - clone_url?: string; - mirror_url?: string | null; + trees_url: string + clone_url?: string + mirror_url?: string | null /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - hooks_url: string; - svn_url?: string; - homepage?: string | null; - language?: string | null; - forks_count?: number; - stargazers_count?: number; - watchers_count?: number; - size?: number; - default_branch?: string; - open_issues_count?: number; - is_template?: boolean; - topics?: string[]; - has_issues?: boolean; - has_projects?: boolean; - has_wiki?: boolean; - has_pages?: boolean; - has_downloads?: boolean; - archived?: boolean; - disabled?: boolean; - visibility?: string; + hooks_url: string + svn_url?: string + homepage?: string | null + language?: string | null + forks_count?: number + stargazers_count?: number + watchers_count?: number + size?: number + default_branch?: string + open_issues_count?: number + is_template?: boolean + topics?: string[] + has_issues?: boolean + has_projects?: boolean + has_wiki?: boolean + has_pages?: boolean + has_downloads?: boolean + archived?: boolean + disabled?: boolean + visibility?: string /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - pushed_at?: string | null; + pushed_at?: string | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - created_at?: string | null; + created_at?: string | null /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - updated_at?: string | null; + updated_at?: string | null permissions?: { - admin?: boolean; - maintain?: boolean; - push?: boolean; - triage?: boolean; - pull?: boolean; - }; + admin?: boolean + maintain?: boolean + push?: boolean + triage?: boolean + pull?: boolean + } /** @example admin */ - role_name?: string; - template_repository?: components["schemas"]["nullable-repository"]; - temp_clone_token?: string; - delete_branch_on_merge?: boolean; - subscribers_count?: number; - network_count?: number; - code_of_conduct?: components["schemas"]["code-of-conduct"]; + role_name?: string + template_repository?: components['schemas']['nullable-repository'] + temp_clone_token?: string + delete_branch_on_merge?: boolean + subscribers_count?: number + network_count?: number + code_of_conduct?: components['schemas']['code-of-conduct'] license?: { - key?: string; - name?: string; - spdx_id?: string; - url?: string; - node_id?: string; - } | null; - forks?: number; - open_issues?: number; - watchers?: number; - allow_forking?: boolean; - } | null; + key?: string + name?: string + spdx_id?: string + url?: string + node_id?: string + } | null + forks?: number + open_issues?: number + watchers?: number + allow_forking?: boolean + } | null /** * Package * @description A software package @@ -10102,96 +10094,96 @@ export interface components { * @description Unique identifier of the package. * @example 1 */ - id: number; + id: number /** * @description The name of the package. * @example super-linter */ - name: string; + name: string /** * @example docker * @enum {string} */ - package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + package_type: 'npm' | 'maven' | 'rubygems' | 'docker' | 'nuget' | 'container' /** @example https://api.github.com/orgs/github/packages/container/super-linter */ - url: string; + url: string /** @example https://github.com/orgs/github/packages/container/package/super-linter */ - html_url: string; + html_url: string /** * @description The number of versions of the package. * @example 1 */ - version_count: number; + version_count: number /** * @example private * @enum {string} */ - visibility: "private" | "public"; - owner?: components["schemas"]["nullable-simple-user"]; - repository?: components["schemas"]["nullable-minimal-repository"]; + visibility: 'private' | 'public' + owner?: components['schemas']['nullable-simple-user'] + repository?: components['schemas']['nullable-minimal-repository'] /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - }; + updated_at: string + } /** * Package Version * @description A version of a software package */ - "package-version": { + 'package-version': { /** * @description Unique identifier of the package version. * @example 1 */ - id: number; + id: number /** * @description The name of the package version. * @example latest */ - name: string; + name: string /** @example https://api.github.com/orgs/github/packages/container/super-linter/versions/786068 */ - url: string; + url: string /** @example https://github.com/orgs/github/packages/container/package/super-linter */ - package_html_url: string; + package_html_url: string /** @example https://github.com/orgs/github/packages/container/super-linter/786068 */ - html_url?: string; + html_url?: string /** @example MIT */ - license?: string; - description?: string; + license?: string + description?: string /** * Format: date-time * @example 2011-04-10T20:09:31Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2014-03-03T18:58:10Z */ - updated_at: string; + updated_at: string /** * Format: date-time * @example 2014-03-03T18:58:10Z */ - deleted_at?: string; + deleted_at?: string /** Package Version Metadata */ metadata?: { /** * @example docker * @enum {string} */ - package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + package_type: 'npm' | 'maven' | 'rubygems' | 'docker' | 'nuget' | 'container' /** Container Metadata */ container?: { - tags: string[]; - }; + tags: string[] + } /** Docker Metadata */ docker?: { - tag?: string[]; + tag?: string[] } & { - tags: unknown; - }; - }; - }; + tags: unknown + } + } + } /** * Project * @description Projects are a way to organize columns and cards of work. @@ -10201,67 +10193,67 @@ export interface components { * Format: uri * @example https://api.github.com/repos/api-playground/projects-test */ - owner_url: string; + owner_url: string /** * Format: uri * @example https://api.github.com/projects/1002604 */ - url: string; + url: string /** * Format: uri * @example https://github.com/api-playground/projects-test/projects/12 */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/projects/1002604/columns */ - columns_url: string; + columns_url: string /** @example 1002604 */ - id: number; + id: number /** @example MDc6UHJvamVjdDEwMDI2MDQ= */ - node_id: string; + node_id: string /** * @description Name of the project * @example Week One Sprint */ - name: string; + name: string /** * @description Body of the project * @example This project represents the sprint of the first week in January */ - body: string | null; + body: string | null /** @example 1 */ - number: number; + number: number /** * @description State of the project; either 'open' or 'closed' * @example open */ - state: string; - creator: components["schemas"]["nullable-simple-user"]; + state: string + creator: components['schemas']['nullable-simple-user'] /** * Format: date-time * @example 2011-04-10T20:09:31Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2014-03-03T18:58:10Z */ - updated_at: string; + updated_at: string /** * @description The baseline permission that all organization members have on this project. Only present if owner is an organization. * @enum {string} */ - organization_permission?: "read" | "write" | "admin" | "none"; + organization_permission?: 'read' | 'write' | 'admin' | 'none' /** @description Whether or not this project can be seen by everyone. Only present if owner is an organization. */ - private?: boolean; - }; + private?: boolean + } /** * GroupMapping * @description External Groups to be mapped to a team for membership */ - "group-mapping": { + 'group-mapping': { /** * @description Array of groups to be mapped to this team * @example [object Object],[object Object] @@ -10271,1012 +10263,1012 @@ export interface components { * @description The ID of the group * @example 111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa */ - group_id: string; + group_id: string /** * @description The name of the group * @example saml-azuread-test */ - group_name: string; + group_name: string /** * @description a description of the group * @example A group of Developers working on AzureAD SAML SSO */ - group_description: string; + group_description: string /** * @description synchronization status for this group mapping * @example unsynced */ - status?: string; + status?: string /** * @description the time of the last sync for this group-mapping * @example 2019-06-03 22:27:15:000 -700 */ - synced_at?: string | null; - }[]; - }; + synced_at?: string | null + }[] + } /** * Full Team * @description Groups of organization members that gives permissions on specified repositories. */ - "team-full": { + 'team-full': { /** * @description Unique identifier of the team * @example 42 */ - id: number; + id: number /** @example MDQ6VGVhbTE= */ - node_id: string; + node_id: string /** * Format: uri * @description URL for the team * @example https://api.github.com/organizations/1/team/1 */ - url: string; + url: string /** * Format: uri * @example https://github.com/orgs/rails/teams/core */ - html_url: string; + html_url: string /** * @description Name of the team * @example Developers */ - name: string; + name: string /** @example justice-league */ - slug: string; + slug: string /** @example A great team. */ - description: string | null; + description: string | null /** * @description The level of privacy this team should have * @example closed * @enum {string} */ - privacy?: "closed" | "secret"; + privacy?: 'closed' | 'secret' /** * @description Permission that the team will have for its repositories * @example push */ - permission: string; + permission: string /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - members_url: string; + members_url: string /** * Format: uri * @example https://api.github.com/organizations/1/team/1/repos */ - repositories_url: string; - parent?: components["schemas"]["nullable-team-simple"]; + repositories_url: string + parent?: components['schemas']['nullable-team-simple'] /** @example 3 */ - members_count: number; + members_count: number /** @example 10 */ - repos_count: number; + repos_count: number /** * Format: date-time * @example 2017-07-14T16:53:42Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2017-08-17T12:37:15Z */ - updated_at: string; - organization: components["schemas"]["organization-full"]; + updated_at: string + organization: components['schemas']['organization-full'] /** * @description Distinguished Name (DN) that team maps to within LDAP environment * @example uid=example,ou=users,dc=github,dc=com */ - ldap_dn?: string; - }; + ldap_dn?: string + } /** * Team Discussion * @description A team discussion is a persistent record of a free-form conversation within a team. */ - "team-discussion": { - author: components["schemas"]["nullable-simple-user"]; + 'team-discussion': { + author: components['schemas']['nullable-simple-user'] /** * @description The main text of the discussion. * @example Please suggest improvements to our workflow in comments. */ - body: string; + body: string /** @example

Hi! This is an area for us to collaborate as a team

*/ - body_html: string; + body_html: string /** * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server. * @example 0307116bbf7ced493b8d8a346c650b71 */ - body_version: string; - comments_count: number; + body_version: string + comments_count: number /** * Format: uri * @example https://api.github.com/organizations/1/team/2343027/discussions/1/comments */ - comments_url: string; + comments_url: string /** * Format: date-time * @example 2018-01-25T18:56:31Z */ - created_at: string; + created_at: string /** Format: date-time */ - last_edited_at: string | null; + last_edited_at: string | null /** * Format: uri * @example https://github.com/orgs/github/teams/justice-league/discussions/1 */ - html_url: string; + html_url: string /** @example MDE0OlRlYW1EaXNjdXNzaW9uMQ== */ - node_id: string; + node_id: string /** * @description The unique sequence number of a team discussion. * @example 42 */ - number: number; + number: number /** * @description Whether or not this discussion should be pinned for easy retrieval. * @example true */ - pinned: boolean; + pinned: boolean /** * @description Whether or not this discussion should be restricted to team members and organization administrators. * @example true */ - private: boolean; + private: boolean /** * Format: uri * @example https://api.github.com/organizations/1/team/2343027 */ - team_url: string; + team_url: string /** * @description The title of the discussion. * @example How can we improve our workflow? */ - title: string; + title: string /** * Format: date-time * @example 2018-01-25T18:56:31Z */ - updated_at: string; + updated_at: string /** * Format: uri * @example https://api.github.com/organizations/1/team/2343027/discussions/1 */ - url: string; - reactions?: components["schemas"]["reaction-rollup"]; - }; + url: string + reactions?: components['schemas']['reaction-rollup'] + } /** * Team Discussion Comment * @description A reply to a discussion within a team. */ - "team-discussion-comment": { - author: components["schemas"]["nullable-simple-user"]; + 'team-discussion-comment': { + author: components['schemas']['nullable-simple-user'] /** * @description The main text of the comment. * @example I agree with this suggestion. */ - body: string; + body: string /** @example

Do you like apples?

*/ - body_html: string; + body_html: string /** * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server. * @example 0307116bbf7ced493b8d8a346c650b71 */ - body_version: string; + body_version: string /** * Format: date-time * @example 2018-01-15T23:53:58Z */ - created_at: string; + created_at: string /** Format: date-time */ - last_edited_at: string | null; + last_edited_at: string | null /** * Format: uri * @example https://api.github.com/organizations/1/team/2403582/discussions/1 */ - discussion_url: string; + discussion_url: string /** * Format: uri * @example https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 */ - html_url: string; + html_url: string /** @example MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= */ - node_id: string; + node_id: string /** * @description The unique sequence number of a team discussion comment. * @example 42 */ - number: number; + number: number /** * Format: date-time * @example 2018-01-15T23:53:58Z */ - updated_at: string; + updated_at: string /** * Format: uri * @example https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 */ - url: string; - reactions?: components["schemas"]["reaction-rollup"]; - }; + url: string + reactions?: components['schemas']['reaction-rollup'] + } /** * Reaction * @description Reactions to conversations provide a way to help people express their feelings more simply and effectively. */ reaction: { /** @example 1 */ - id: number; + id: number /** @example MDg6UmVhY3Rpb24x */ - node_id: string; - user: components["schemas"]["nullable-simple-user"]; + node_id: string + user: components['schemas']['nullable-simple-user'] /** * @description The reaction to use * @example heart * @enum {string} */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' /** * Format: date-time * @example 2016-05-20T20:09:31Z */ - created_at: string; - }; + created_at: string + } /** * Team Membership * @description Team Membership */ - "team-membership": { + 'team-membership': { /** Format: uri */ - url: string; + url: string /** * @description The role of the user in the team. * @default member * @example member * @enum {string} */ - role: "member" | "maintainer"; + role: 'member' | 'maintainer' /** * @description The state of the user's membership in the team. * @enum {string} */ - state: "active" | "pending"; - }; + state: 'active' | 'pending' + } /** * Team Project * @description A team's access to a project. */ - "team-project": { - owner_url: string; - url: string; - html_url: string; - columns_url: string; - id: number; - node_id: string; - name: string; - body: string | null; - number: number; - state: string; - creator: components["schemas"]["simple-user"]; - created_at: string; - updated_at: string; + 'team-project': { + owner_url: string + url: string + html_url: string + columns_url: string + id: number + node_id: string + name: string + body: string | null + number: number + state: string + creator: components['schemas']['simple-user'] + created_at: string + updated_at: string /** @description The organization permission for this project. Only present when owner is an organization. */ - organization_permission?: string; + organization_permission?: string /** @description Whether the project is private or not. Only present when owner is an organization. */ - private?: boolean; + private?: boolean permissions: { - read: boolean; - write: boolean; - admin: boolean; - }; - }; + read: boolean + write: boolean + admin: boolean + } + } /** * Team Repository * @description A team's access to a repository. */ - "team-repository": { + 'team-repository': { /** * @description Unique identifier of the repository * @example 42 */ - id: number; + id: number /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - node_id: string; + node_id: string /** * @description The name of the repository. * @example Team Environment */ - name: string; + name: string /** @example octocat/Hello-World */ - full_name: string; - license: components["schemas"]["nullable-license-simple"]; - forks: number; + full_name: string + license: components['schemas']['nullable-license-simple'] + forks: number permissions?: { - admin: boolean; - pull: boolean; - triage?: boolean; - push: boolean; - maintain?: boolean; - }; + admin: boolean + pull: boolean + triage?: boolean + push: boolean + maintain?: boolean + } /** @example admin */ - role_name?: string; - owner: components["schemas"]["nullable-simple-user"]; + role_name?: string + owner: components['schemas']['nullable-simple-user'] /** @description Whether the repository is private or public. */ - private: boolean; + private: boolean /** * Format: uri * @example https://github.com/octocat/Hello-World */ - html_url: string; + html_url: string /** @example This your first repo! */ - description: string | null; - fork: boolean; + description: string | null + fork: boolean /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World */ - url: string; + url: string /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - archive_url: string; + archive_url: string /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - assignees_url: string; + assignees_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - blobs_url: string; + blobs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - branches_url: string; + branches_url: string /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - collaborators_url: string; + collaborators_url: string /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - comments_url: string; + comments_url: string /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - commits_url: string; + commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - compare_url: string; + compare_url: string /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - contents_url: string; + contents_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - contributors_url: string; + contributors_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - deployments_url: string; + deployments_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - downloads_url: string; + downloads_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events */ - events_url: string; + events_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ - forks_url: string; + forks_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - git_commits_url: string; + git_commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - git_refs_url: string; + git_refs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - git_tags_url: string; + git_tags_url: string /** @example git:github.com/octocat/Hello-World.git */ - git_url: string; + git_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - issue_comment_url: string; + issue_comment_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - issue_events_url: string; + issue_events_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - issues_url: string; + issues_url: string /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - keys_url: string; + keys_url: string /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - labels_url: string; + labels_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ - languages_url: string; + languages_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ - merges_url: string; + merges_url: string /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - milestones_url: string; + milestones_url: string /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - notifications_url: string; + notifications_url: string /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - pulls_url: string; + pulls_url: string /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - releases_url: string; + releases_url: string /** @example git@github.com:octocat/Hello-World.git */ - ssh_url: string; + ssh_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - stargazers_url: string; + stargazers_url: string /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - statuses_url: string; + statuses_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - subscribers_url: string; + subscribers_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - subscription_url: string; + subscription_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ - tags_url: string; + tags_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ - teams_url: string; + teams_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - trees_url: string; + trees_url: string /** @example https://github.com/octocat/Hello-World.git */ - clone_url: string; + clone_url: string /** * Format: uri * @example git:git.example.com/octocat/Hello-World */ - mirror_url: string | null; + mirror_url: string | null /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - hooks_url: string; + hooks_url: string /** * Format: uri * @example https://svn.github.com/octocat/Hello-World */ - svn_url: string; + svn_url: string /** * Format: uri * @example https://github.com */ - homepage: string | null; - language: string | null; + homepage: string | null + language: string | null /** @example 9 */ - forks_count: number; + forks_count: number /** @example 80 */ - stargazers_count: number; + stargazers_count: number /** @example 80 */ - watchers_count: number; + watchers_count: number /** @example 108 */ - size: number; + size: number /** * @description The default branch of the repository. * @example master */ - default_branch: string; - open_issues_count: number; + default_branch: string + open_issues_count: number /** * @description Whether this repository acts as a template that can be used to generate new repositories. * @example true */ - is_template?: boolean; - topics?: string[]; + is_template?: boolean + topics?: string[] /** * @description Whether issues are enabled. * @default true * @example true */ - has_issues: boolean; + has_issues: boolean /** * @description Whether projects are enabled. * @default true * @example true */ - has_projects: boolean; + has_projects: boolean /** * @description Whether the wiki is enabled. * @default true * @example true */ - has_wiki: boolean; - has_pages: boolean; + has_wiki: boolean + has_pages: boolean /** * @description Whether downloads are enabled. * @default true * @example true */ - has_downloads: boolean; + has_downloads: boolean /** @description Whether the repository is archived. */ - archived: boolean; + archived: boolean /** @description Returns whether or not this repository disabled. */ - disabled: boolean; + disabled: boolean /** * @description The repository visibility: public, private, or internal. * @default public */ - visibility?: string; + visibility?: string /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - pushed_at: string | null; + pushed_at: string | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - created_at: string | null; + created_at: string | null /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - updated_at: string | null; + updated_at: string | null /** * @description Whether to allow rebase merges for pull requests. * @default true * @example true */ - allow_rebase_merge?: boolean; - template_repository?: components["schemas"]["nullable-repository"]; - temp_clone_token?: string; + allow_rebase_merge?: boolean + template_repository?: components['schemas']['nullable-repository'] + temp_clone_token?: string /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - allow_squash_merge?: boolean; + allow_squash_merge?: boolean /** @description Whether to allow Auto-merge to be used on pull requests. */ - allow_auto_merge?: boolean; + allow_auto_merge?: boolean /** @description Whether to delete head branches when pull requests are merged */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge?: boolean /** * @description Whether to allow merge commits for pull requests. * @default true * @example true */ - allow_merge_commit?: boolean; + allow_merge_commit?: boolean /** @description Whether to allow forking this repo */ - allow_forking?: boolean; - subscribers_count?: number; - network_count?: number; - open_issues: number; - watchers: number; - master_branch?: string; - }; + allow_forking?: boolean + subscribers_count?: number + network_count?: number + open_issues: number + watchers: number + master_branch?: string + } /** * Project Card * @description Project cards represent a scope of work. */ - "project-card": { + 'project-card': { /** * Format: uri * @example https://api.github.com/projects/columns/cards/1478 */ - url: string; + url: string /** * @description The project card's ID * @example 42 */ - id: number; + id: number /** @example MDExOlByb2plY3RDYXJkMTQ3OA== */ - node_id: string; + node_id: string /** @example Add payload for delete Project column */ - note: string | null; - creator: components["schemas"]["nullable-simple-user"]; + note: string | null + creator: components['schemas']['nullable-simple-user'] /** * Format: date-time * @example 2016-09-05T14:21:06Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2016-09-05T14:20:22Z */ - updated_at: string; + updated_at: string /** @description Whether or not the card is archived */ - archived?: boolean; - column_name?: string; - project_id?: string; + archived?: boolean + column_name?: string + project_id?: string /** * Format: uri * @example https://api.github.com/projects/columns/367 */ - column_url: string; + column_url: string /** * Format: uri * @example https://api.github.com/repos/api-playground/projects-test/issues/3 */ - content_url?: string; + content_url?: string /** * Format: uri * @example https://api.github.com/projects/120 */ - project_url: string; - }; + project_url: string + } /** * Project Column * @description Project columns contain cards of work. */ - "project-column": { + 'project-column': { /** * Format: uri * @example https://api.github.com/projects/columns/367 */ - url: string; + url: string /** * Format: uri * @example https://api.github.com/projects/120 */ - project_url: string; + project_url: string /** * Format: uri * @example https://api.github.com/projects/columns/367/cards */ - cards_url: string; + cards_url: string /** * @description The unique identifier of the project column * @example 42 */ - id: number; + id: number /** @example MDEzOlByb2plY3RDb2x1bW4zNjc= */ - node_id: string; + node_id: string /** * @description Name of the project column * @example Remaining tasks */ - name: string; + name: string /** * Format: date-time * @example 2016-09-05T14:18:44Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2016-09-05T14:22:28Z */ - updated_at: string; - }; + updated_at: string + } /** * Project Collaborator Permission * @description Project Collaborator Permission */ - "project-collaborator-permission": { - permission: string; - user: components["schemas"]["nullable-simple-user"]; - }; + 'project-collaborator-permission': { + permission: string + user: components['schemas']['nullable-simple-user'] + } /** Rate Limit */ - "rate-limit": { - limit: number; - remaining: number; - reset: number; - used: number; - }; + 'rate-limit': { + limit: number + remaining: number + reset: number + used: number + } /** * Rate Limit Overview * @description Rate Limit Overview */ - "rate-limit-overview": { + 'rate-limit-overview': { resources: { - core: components["schemas"]["rate-limit"]; - graphql?: components["schemas"]["rate-limit"]; - search: components["schemas"]["rate-limit"]; - source_import?: components["schemas"]["rate-limit"]; - integration_manifest?: components["schemas"]["rate-limit"]; - code_scanning_upload?: components["schemas"]["rate-limit"]; - actions_runner_registration?: components["schemas"]["rate-limit"]; - scim?: components["schemas"]["rate-limit"]; - }; - rate: components["schemas"]["rate-limit"]; - }; + core: components['schemas']['rate-limit'] + graphql?: components['schemas']['rate-limit'] + search: components['schemas']['rate-limit'] + source_import?: components['schemas']['rate-limit'] + integration_manifest?: components['schemas']['rate-limit'] + code_scanning_upload?: components['schemas']['rate-limit'] + actions_runner_registration?: components['schemas']['rate-limit'] + scim?: components['schemas']['rate-limit'] + } + rate: components['schemas']['rate-limit'] + } /** * Code Of Conduct Simple * @description Code of Conduct Simple */ - "code-of-conduct-simple": { + 'code-of-conduct-simple': { /** * Format: uri * @example https://api.github.com/repos/github/docs/community/code_of_conduct */ - url: string; + url: string /** @example citizen_code_of_conduct */ - key: string; + key: string /** @example Citizen Code of Conduct */ - name: string; + name: string /** * Format: uri * @example https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md */ - html_url: string | null; - }; + html_url: string | null + } /** * Full Repository * @description Full Repository */ - "full-repository": { + 'full-repository': { /** @example 1296269 */ - id: number; + id: number /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - node_id: string; + node_id: string /** @example Hello-World */ - name: string; + name: string /** @example octocat/Hello-World */ - full_name: string; - owner: components["schemas"]["simple-user"]; - private: boolean; + full_name: string + owner: components['schemas']['simple-user'] + private: boolean /** * Format: uri * @example https://github.com/octocat/Hello-World */ - html_url: string; + html_url: string /** @example This your first repo! */ - description: string | null; - fork: boolean; + description: string | null + fork: boolean /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World */ - url: string; + url: string /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - archive_url: string; + archive_url: string /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - assignees_url: string; + assignees_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - blobs_url: string; + blobs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - branches_url: string; + branches_url: string /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - collaborators_url: string; + collaborators_url: string /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - comments_url: string; + comments_url: string /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - commits_url: string; + commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - compare_url: string; + compare_url: string /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - contents_url: string; + contents_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - contributors_url: string; + contributors_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - deployments_url: string; + deployments_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - downloads_url: string; + downloads_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events */ - events_url: string; + events_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ - forks_url: string; + forks_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - git_commits_url: string; + git_commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - git_refs_url: string; + git_refs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - git_tags_url: string; + git_tags_url: string /** @example git:github.com/octocat/Hello-World.git */ - git_url: string; + git_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - issue_comment_url: string; + issue_comment_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - issue_events_url: string; + issue_events_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - issues_url: string; + issues_url: string /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - keys_url: string; + keys_url: string /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - labels_url: string; + labels_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ - languages_url: string; + languages_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ - merges_url: string; + merges_url: string /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - milestones_url: string; + milestones_url: string /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - notifications_url: string; + notifications_url: string /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - pulls_url: string; + pulls_url: string /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - releases_url: string; + releases_url: string /** @example git@github.com:octocat/Hello-World.git */ - ssh_url: string; + ssh_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - stargazers_url: string; + stargazers_url: string /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - statuses_url: string; + statuses_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - subscribers_url: string; + subscribers_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - subscription_url: string; + subscription_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ - tags_url: string; + tags_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ - teams_url: string; + teams_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - trees_url: string; + trees_url: string /** @example https://github.com/octocat/Hello-World.git */ - clone_url: string; + clone_url: string /** * Format: uri * @example git:git.example.com/octocat/Hello-World */ - mirror_url: string | null; + mirror_url: string | null /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - hooks_url: string; + hooks_url: string /** * Format: uri * @example https://svn.github.com/octocat/Hello-World */ - svn_url: string; + svn_url: string /** * Format: uri * @example https://github.com */ - homepage: string | null; - language: string | null; + homepage: string | null + language: string | null /** @example 9 */ - forks_count: number; + forks_count: number /** @example 80 */ - stargazers_count: number; + stargazers_count: number /** @example 80 */ - watchers_count: number; + watchers_count: number /** @example 108 */ - size: number; + size: number /** @example master */ - default_branch: string; - open_issues_count: number; + default_branch: string + open_issues_count: number /** @example true */ - is_template?: boolean; + is_template?: boolean /** @example octocat,atom,electron,API */ - topics?: string[]; + topics?: string[] /** @example true */ - has_issues: boolean; + has_issues: boolean /** @example true */ - has_projects: boolean; + has_projects: boolean /** @example true */ - has_wiki: boolean; - has_pages: boolean; + has_wiki: boolean + has_pages: boolean /** @example true */ - has_downloads: boolean; - archived: boolean; + has_downloads: boolean + archived: boolean /** @description Returns whether or not this repository disabled. */ - disabled: boolean; + disabled: boolean /** * @description The repository visibility: public, private, or internal. * @example public */ - visibility?: string; + visibility?: string /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - pushed_at: string; + pushed_at: string /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - updated_at: string; + updated_at: string permissions?: { - admin: boolean; - maintain?: boolean; - push: boolean; - triage?: boolean; - pull: boolean; - }; + admin: boolean + maintain?: boolean + push: boolean + triage?: boolean + pull: boolean + } /** @example true */ - allow_rebase_merge?: boolean; - template_repository?: components["schemas"]["nullable-repository"]; - temp_clone_token?: string | null; + allow_rebase_merge?: boolean + template_repository?: components['schemas']['nullable-repository'] + temp_clone_token?: string | null /** @example true */ - allow_squash_merge?: boolean; - allow_auto_merge?: boolean; - delete_branch_on_merge?: boolean; + allow_squash_merge?: boolean + allow_auto_merge?: boolean + delete_branch_on_merge?: boolean /** @example true */ - allow_merge_commit?: boolean; + allow_merge_commit?: boolean /** @example true */ - allow_forking?: boolean; + allow_forking?: boolean /** @example 42 */ - subscribers_count: number; - network_count: number; - license: components["schemas"]["nullable-license-simple"]; - organization?: components["schemas"]["nullable-simple-user"]; - parent?: components["schemas"]["repository"]; - source?: components["schemas"]["repository"]; - forks: number; - master_branch?: string; - open_issues: number; - watchers: number; + subscribers_count: number + network_count: number + license: components['schemas']['nullable-license-simple'] + organization?: components['schemas']['nullable-simple-user'] + parent?: components['schemas']['repository'] + source?: components['schemas']['repository'] + forks: number + master_branch?: string + open_issues: number + watchers: number /** * @description Whether anonymous git access is allowed. * @default true */ - anonymous_access_enabled?: boolean; - code_of_conduct?: components["schemas"]["code-of-conduct-simple"]; + anonymous_access_enabled?: boolean + code_of_conduct?: components['schemas']['code-of-conduct-simple'] security_and_analysis?: { advanced_security?: { /** @enum {string} */ - status?: "enabled" | "disabled"; - }; + status?: 'enabled' | 'disabled' + } secret_scanning?: { /** @enum {string} */ - status?: "enabled" | "disabled"; - }; - } | null; - }; + status?: 'enabled' | 'disabled' + } + } | null + } /** * Artifact * @description An artifact */ artifact: { /** @example 5 */ - id: number; + id: number /** @example MDEwOkNoZWNrU3VpdGU1 */ - node_id: string; + node_id: string /** * @description The name of the artifact. * @example AdventureWorks.Framework */ - name: string; + name: string /** * @description The size in bytes of the artifact. * @example 12345 */ - size_in_bytes: number; + size_in_bytes: number /** @example https://api.github.com/repos/github/hello-world/actions/artifacts/5 */ - url: string; + url: string /** @example https://api.github.com/repos/github/hello-world/actions/artifacts/5/zip */ - archive_download_url: string; + archive_download_url: string /** @description Whether or not the artifact has expired. */ - expired: boolean; + expired: boolean /** Format: date-time */ - created_at: string | null; + created_at: string | null /** Format: date-time */ - expires_at: string | null; + expires_at: string | null /** Format: date-time */ - updated_at: string | null; - }; + updated_at: string | null + } /** * Job * @description Information of a job execution in a workflow run @@ -11286,58 +11278,58 @@ export interface components { * @description The id of the job. * @example 21 */ - id: number; + id: number /** * @description The id of the associated workflow run. * @example 5 */ - run_id: number; + run_id: number /** @example https://api.github.com/repos/github/hello-world/actions/runs/5 */ - run_url: string; + run_url: string /** * @description Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run. * @example 1 */ - run_attempt?: number; + run_attempt?: number /** @example MDg6Q2hlY2tSdW40 */ - node_id: string; + node_id: string /** * @description The SHA of the commit that is being run. * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d */ - head_sha: string; + head_sha: string /** @example https://api.github.com/repos/github/hello-world/actions/jobs/21 */ - url: string; + url: string /** @example https://github.com/github/hello-world/runs/4 */ - html_url: string | null; + html_url: string | null /** * @description The phase of the lifecycle that the job is currently in. * @example queued * @enum {string} */ - status: "queued" | "in_progress" | "completed"; + status: 'queued' | 'in_progress' | 'completed' /** * @description The outcome of the job. * @example success */ - conclusion: string | null; + conclusion: string | null /** * Format: date-time * @description The time that the job started, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 */ - started_at: string; + started_at: string /** * Format: date-time * @description The time that the job finished, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 */ - completed_at: string | null; + completed_at: string | null /** * @description The name of the job. * @example test-coverage */ - name: string; + name: string /** @description Steps in this job. */ steps?: { /** @@ -11345,328 +11337,328 @@ export interface components { * @example queued * @enum {string} */ - status: "queued" | "in_progress" | "completed"; + status: 'queued' | 'in_progress' | 'completed' /** * @description The outcome of the job. * @example success */ - conclusion: string | null; + conclusion: string | null /** * @description The name of the job. * @example test-coverage */ - name: string; + name: string /** @example 1 */ - number: number; + number: number /** * Format: date-time * @description The time that the step started, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 */ - started_at?: string | null; + started_at?: string | null /** * Format: date-time * @description The time that the job finished, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 */ - completed_at?: string | null; - }[]; + completed_at?: string | null + }[] /** @example https://api.github.com/repos/github/hello-world/check-runs/4 */ - check_run_url: string; + check_run_url: string /** * @description Labels for the workflow job. Specified by the "runs_on" attribute in the action's workflow file. * @example self-hosted,foo,bar */ - labels: string[]; + labels: string[] /** * @description The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example 1 */ - runner_id: number | null; + runner_id: number | null /** * @description The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example my runner */ - runner_name: string | null; + runner_name: string | null /** * @description The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example 2 */ - runner_group_id: number | null; + runner_group_id: number | null /** * @description The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example my runner group */ - runner_group_name: string | null; - }; + runner_group_name: string | null + } /** @description Whether GitHub Actions is enabled on the repository. */ - "actions-enabled": boolean; - "actions-repository-permissions": { - enabled: components["schemas"]["actions-enabled"]; - allowed_actions?: components["schemas"]["allowed-actions"]; - selected_actions_url?: components["schemas"]["selected-actions-url"]; - }; + 'actions-enabled': boolean + 'actions-repository-permissions': { + enabled: components['schemas']['actions-enabled'] + allowed_actions?: components['schemas']['allowed-actions'] + selected_actions_url?: components['schemas']['selected-actions-url'] + } /** Pull Request Minimal */ - "pull-request-minimal": { - id: number; - number: number; - url: string; + 'pull-request-minimal': { + id: number + number: number + url: string head: { - ref: string; - sha: string; + ref: string + sha: string repo: { - id: number; - url: string; - name: string; - }; - }; + id: number + url: string + name: string + } + } base: { - ref: string; - sha: string; + ref: string + sha: string repo: { - id: number; - url: string; - name: string; - }; - }; - }; + id: number + url: string + name: string + } + } + } /** * Simple Commit * @description Simple Commit */ - "nullable-simple-commit": { - id: string; - tree_id: string; - message: string; + 'nullable-simple-commit': { + id: string + tree_id: string + message: string /** Format: date-time */ - timestamp: string; + timestamp: string author: { - name: string; - email: string; - } | null; + name: string + email: string + } | null committer: { - name: string; - email: string; - } | null; - } | null; + name: string + email: string + } | null + } | null /** * Workflow Run * @description An invocation of a workflow */ - "workflow-run": { + 'workflow-run': { /** * @description The ID of the workflow run. * @example 5 */ - id: number; + id: number /** * @description The name of the workflow run. * @example Build */ - name?: string | null; + name?: string | null /** @example MDEwOkNoZWNrU3VpdGU1 */ - node_id: string; + node_id: string /** * @description The ID of the associated check suite. * @example 42 */ - check_suite_id?: number; + check_suite_id?: number /** * @description The node ID of the associated check suite. * @example MDEwOkNoZWNrU3VpdGU0Mg== */ - check_suite_node_id?: string; + check_suite_node_id?: string /** @example master */ - head_branch: string | null; + head_branch: string | null /** * @description The SHA of the head commit that points to the version of the worflow being run. * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d */ - head_sha: string; + head_sha: string /** * @description The auto incrementing run number for the workflow run. * @example 106 */ - run_number: number; + run_number: number /** * @description Attempt number of the run, 1 for first attempt and higher if the workflow was re-run. * @example 1 */ - run_attempt?: number; + run_attempt?: number /** @example push */ - event: string; + event: string /** @example completed */ - status: string | null; + status: string | null /** @example neutral */ - conclusion: string | null; + conclusion: string | null /** * @description The ID of the parent workflow. * @example 5 */ - workflow_id: number; + workflow_id: number /** * @description The URL to the workflow run. * @example https://api.github.com/repos/github/hello-world/actions/runs/5 */ - url: string; + url: string /** @example https://github.com/github/hello-world/suites/4 */ - html_url: string; - pull_requests: components["schemas"]["pull-request-minimal"][] | null; + html_url: string + pull_requests: components['schemas']['pull-request-minimal'][] | null /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; + updated_at: string /** * Format: date-time * @description The start time of the latest run. Resets on re-run. */ - run_started_at?: string; + run_started_at?: string /** * @description The URL to the jobs for the workflow run. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/jobs */ - jobs_url: string; + jobs_url: string /** * @description The URL to download the logs for the workflow run. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/logs */ - logs_url: string; + logs_url: string /** * @description The URL to the associated check suite. * @example https://api.github.com/repos/github/hello-world/check-suites/12 */ - check_suite_url: string; + check_suite_url: string /** * @description The URL to the artifacts for the workflow run. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts */ - artifacts_url: string; + artifacts_url: string /** * @description The URL to cancel the workflow run. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/cancel */ - cancel_url: string; + cancel_url: string /** * @description The URL to rerun the workflow run. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/rerun */ - rerun_url: string; + rerun_url: string /** * @description The URL to the previous attempted run of this workflow, if one exists. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3 */ - previous_attempt_url?: string | null; + previous_attempt_url?: string | null /** * @description The URL to the workflow. * @example https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml */ - workflow_url: string; - head_commit: components["schemas"]["nullable-simple-commit"]; - repository: components["schemas"]["minimal-repository"]; - head_repository: components["schemas"]["minimal-repository"]; + workflow_url: string + head_commit: components['schemas']['nullable-simple-commit'] + repository: components['schemas']['minimal-repository'] + head_repository: components['schemas']['minimal-repository'] /** @example 5 */ - head_repository_id?: number; - }; + head_repository_id?: number + } /** * Environment Approval * @description An entry in the reviews log for environment deployments */ - "environment-approvals": { + 'environment-approvals': { /** @description The list of environments that were approved or rejected */ environments: { /** * @description The id of the environment. * @example 56780428 */ - id?: number; + id?: number /** @example MDExOkVudmlyb25tZW50NTY3ODA0Mjg= */ - node_id?: string; + node_id?: string /** * @description The name of the environment. * @example staging */ - name?: string; + name?: string /** @example https://api.github.com/repos/github/hello-world/environments/staging */ - url?: string; + url?: string /** @example https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging */ - html_url?: string; + html_url?: string /** * Format: date-time * @description The time that the environment was created, in ISO 8601 format. * @example 2020-11-23T22:00:40Z */ - created_at?: string; + created_at?: string /** * Format: date-time * @description The time that the environment was last updated, in ISO 8601 format. * @example 2020-11-23T22:00:40Z */ - updated_at?: string; - }[]; + updated_at?: string + }[] /** * @description Whether deployment to the environment(s) was approved or rejected * @example approved * @enum {string} */ - state: "approved" | "rejected"; - user: components["schemas"]["simple-user"]; + state: 'approved' | 'rejected' + user: components['schemas']['simple-user'] /** * @description The comment submitted with the deployment review * @example Ship it! */ - comment: string; - }; + comment: string + } /** * @description The type of reviewer. Must be one of: `User` or `Team` * @example User * @enum {string} */ - "deployment-reviewer-type": "User" | "Team"; + 'deployment-reviewer-type': 'User' | 'Team' /** * Pending Deployment * @description Details of a deployment that is waiting for protection rules to pass */ - "pending-deployment": { + 'pending-deployment': { environment: { /** * @description The id of the environment. * @example 56780428 */ - id?: number; + id?: number /** @example MDExOkVudmlyb25tZW50NTY3ODA0Mjg= */ - node_id?: string; + node_id?: string /** * @description The name of the environment. * @example staging */ - name?: string; + name?: string /** @example https://api.github.com/repos/github/hello-world/environments/staging */ - url?: string; + url?: string /** @example https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging */ - html_url?: string; - }; + html_url?: string + } /** * @description The set duration of the wait timer * @example 30 */ - wait_timer: number; + wait_timer: number /** * Format: date-time * @description The time that the wait timer began. * @example 2020-11-23T22:00:40Z */ - wait_timer_started_at: string | null; + wait_timer_started_at: string | null /** * @description Whether the currently authenticated user can approve the deployment * @example true */ - current_user_can_approve: boolean; + current_user_can_approve: boolean /** @description The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */ reviewers: { - type?: components["schemas"]["deployment-reviewer-type"]; - reviewer?: Partial & Partial; - }[]; - }; + type?: components['schemas']['deployment-reviewer-type'] + reviewer?: Partial & Partial + }[] + } /** * Deployment * @description A request for a specific ref(branch,sha,tag) to be deployed @@ -11676,469 +11668,469 @@ export interface components { * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1 */ - url: string; + url: string /** * @description Unique identifier of the deployment * @example 42 */ - id: number; + id: number /** @example MDEwOkRlcGxveW1lbnQx */ - node_id: string; + node_id: string /** @example a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d */ - sha: string; + sha: string /** * @description The ref to deploy. This can be a branch, tag, or sha. * @example topic-branch */ - ref: string; + ref: string /** * @description Parameter to specify a task to execute * @example deploy */ - task: string; - payload: { [key: string]: unknown } | string; + task: string + payload: { [key: string]: unknown } | string /** @example staging */ - original_environment?: string; + original_environment?: string /** * @description Name for the target deployment environment. * @example production */ - environment: string; + environment: string /** @example Deploy request from hubot */ - description: string | null; - creator: components["schemas"]["nullable-simple-user"]; + description: string | null + creator: components['schemas']['nullable-simple-user'] /** * Format: date-time * @example 2012-07-20T01:19:13Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2012-07-20T01:19:13Z */ - updated_at: string; + updated_at: string /** * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1/statuses */ - statuses_url: string; + statuses_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/example */ - repository_url: string; + repository_url: string /** * @description Specifies if the given environment is will no longer exist at some point in the future. Default: false. * @example true */ - transient_environment?: boolean; + transient_environment?: boolean /** * @description Specifies if the given environment is one that end-users directly interact with. Default: false. * @example true */ - production_environment?: boolean; - performed_via_github_app?: components["schemas"]["nullable-integration"]; - }; + production_environment?: boolean + performed_via_github_app?: components['schemas']['nullable-integration'] + } /** * Workflow Run Usage * @description Workflow Run Usage */ - "workflow-run-usage": { + 'workflow-run-usage': { billable: { UBUNTU?: { - total_ms: number; - jobs: number; + total_ms: number + jobs: number job_runs?: { - job_id: number; - duration_ms: number; - }[]; - }; + job_id: number + duration_ms: number + }[] + } MACOS?: { - total_ms: number; - jobs: number; + total_ms: number + jobs: number job_runs?: { - job_id: number; - duration_ms: number; - }[]; - }; + job_id: number + duration_ms: number + }[] + } WINDOWS?: { - total_ms: number; - jobs: number; + total_ms: number + jobs: number job_runs?: { - job_id: number; - duration_ms: number; - }[]; - }; - }; - run_duration_ms?: number; - }; + job_id: number + duration_ms: number + }[] + } + } + run_duration_ms?: number + } /** * Actions Secret * @description Set secrets for GitHub Actions. */ - "actions-secret": { + 'actions-secret': { /** * @description The name of the secret. * @example SECRET_TOKEN */ - name: string; + name: string /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - }; + updated_at: string + } /** * Workflow * @description A GitHub Actions workflow */ workflow: { /** @example 5 */ - id: number; + id: number /** @example MDg6V29ya2Zsb3cxMg== */ - node_id: string; + node_id: string /** @example CI */ - name: string; + name: string /** @example ruby.yaml */ - path: string; + path: string /** * @example active * @enum {string} */ - state: "active" | "deleted" | "disabled_fork" | "disabled_inactivity" | "disabled_manually"; + state: 'active' | 'deleted' | 'disabled_fork' | 'disabled_inactivity' | 'disabled_manually' /** * Format: date-time * @example 2019-12-06T14:20:20.000Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2019-12-06T14:20:20.000Z */ - updated_at: string; + updated_at: string /** @example https://api.github.com/repos/actions/setup-ruby/workflows/5 */ - url: string; + url: string /** @example https://github.com/actions/setup-ruby/blob/master/.github/workflows/ruby.yaml */ - html_url: string; + html_url: string /** @example https://github.com/actions/setup-ruby/workflows/CI/badge.svg */ - badge_url: string; + badge_url: string /** * Format: date-time * @example 2019-12-06T14:20:20.000Z */ - deleted_at?: string; - }; + deleted_at?: string + } /** * Workflow Usage * @description Workflow Usage */ - "workflow-usage": { + 'workflow-usage': { billable: { UBUNTU?: { - total_ms?: number; - }; + total_ms?: number + } MACOS?: { - total_ms?: number; - }; + total_ms?: number + } WINDOWS?: { - total_ms?: number; - }; - }; - }; + total_ms?: number + } + } + } /** * Autolink reference * @description An autolink reference. */ autolink: { /** @example 3 */ - id: number; + id: number /** * @description The prefix of a key that is linkified. * @example TICKET- */ - key_prefix: string; + key_prefix: string /** * @description A template for the target URL that is generated if a key was found. * @example https://example.com/TICKET?query= */ - url_template: string; - }; + url_template: string + } /** * Protected Branch Required Status Check * @description Protected Branch Required Status Check */ - "protected-branch-required-status-check": { - url?: string; - enforcement_level?: string; - contexts: string[]; + 'protected-branch-required-status-check': { + url?: string + enforcement_level?: string + contexts: string[] checks: { - context: string; - app_id: number | null; - }[]; - contexts_url?: string; - strict?: boolean; - }; + context: string + app_id: number | null + }[] + contexts_url?: string + strict?: boolean + } /** * Protected Branch Admin Enforced * @description Protected Branch Admin Enforced */ - "protected-branch-admin-enforced": { + 'protected-branch-admin-enforced': { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins */ - url: string; + url: string /** @example true */ - enabled: boolean; - }; + enabled: boolean + } /** * Protected Branch Pull Request Review * @description Protected Branch Pull Request Review */ - "protected-branch-pull-request-review": { + 'protected-branch-pull-request-review': { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions */ - url?: string; + url?: string dismissal_restrictions?: { /** @description The list of users with review dismissal access. */ - users?: components["schemas"]["simple-user"][]; + users?: components['schemas']['simple-user'][] /** @description The list of teams with review dismissal access. */ - teams?: components["schemas"]["team"][]; + teams?: components['schemas']['team'][] /** @example "https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions" */ - url?: string; + url?: string /** @example "https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users" */ - users_url?: string; + users_url?: string /** @example "https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams" */ - teams_url?: string; - }; + teams_url?: string + } /** @description Allow specific users or teams to bypass pull request requirements. Set to `null` to disable. */ bypass_pull_request_allowances?: { /** @description The list of users allowed to bypass pull request requirements. */ - users?: components["schemas"]["simple-user"][]; + users?: components['schemas']['simple-user'][] /** @description The list of teams allowed to bypass pull request requirements. */ - teams?: components["schemas"]["team"][]; - } | null; + teams?: components['schemas']['team'][] + } | null /** @example true */ - dismiss_stale_reviews: boolean; + dismiss_stale_reviews: boolean /** @example true */ - require_code_owner_reviews: boolean; + require_code_owner_reviews: boolean /** @example 2 */ - required_approving_review_count?: number; - }; + required_approving_review_count?: number + } /** * Branch Restriction Policy * @description Branch Restriction Policy */ - "branch-restriction-policy": { + 'branch-restriction-policy': { /** Format: uri */ - url: string; + url: string /** Format: uri */ - users_url: string; + users_url: string /** Format: uri */ - teams_url: string; + teams_url: string /** Format: uri */ - apps_url: string; + apps_url: string users: { - login?: string; - id?: number; - node_id?: string; - avatar_url?: string; - gravatar_id?: string; - url?: string; - html_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - starred_url?: string; - subscriptions_url?: string; - organizations_url?: string; - repos_url?: string; - events_url?: string; - received_events_url?: string; - type?: string; - site_admin?: boolean; - }[]; + login?: string + id?: number + node_id?: string + avatar_url?: string + gravatar_id?: string + url?: string + html_url?: string + followers_url?: string + following_url?: string + gists_url?: string + starred_url?: string + subscriptions_url?: string + organizations_url?: string + repos_url?: string + events_url?: string + received_events_url?: string + type?: string + site_admin?: boolean + }[] teams: { - id?: number; - node_id?: string; - url?: string; - html_url?: string; - name?: string; - slug?: string; - description?: string | null; - privacy?: string; - permission?: string; - members_url?: string; - repositories_url?: string; - parent?: string | null; - }[]; + id?: number + node_id?: string + url?: string + html_url?: string + name?: string + slug?: string + description?: string | null + privacy?: string + permission?: string + members_url?: string + repositories_url?: string + parent?: string | null + }[] apps: { - id?: number; - slug?: string; - node_id?: string; + id?: number + slug?: string + node_id?: string owner?: { - login?: string; - id?: number; - node_id?: string; - url?: string; - repos_url?: string; - events_url?: string; - hooks_url?: string; - issues_url?: string; - members_url?: string; - public_members_url?: string; - avatar_url?: string; - description?: string; + login?: string + id?: number + node_id?: string + url?: string + repos_url?: string + events_url?: string + hooks_url?: string + issues_url?: string + members_url?: string + public_members_url?: string + avatar_url?: string + description?: string /** @example "" */ - gravatar_id?: string; + gravatar_id?: string /** @example "https://github.com/testorg-ea8ec76d71c3af4b" */ - html_url?: string; + html_url?: string /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers" */ - followers_url?: string; + followers_url?: string /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}" */ - following_url?: string; + following_url?: string /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}" */ - gists_url?: string; + gists_url?: string /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}" */ - starred_url?: string; + starred_url?: string /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions" */ - subscriptions_url?: string; + subscriptions_url?: string /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs" */ - organizations_url?: string; + organizations_url?: string /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events" */ - received_events_url?: string; + received_events_url?: string /** @example "Organization" */ - type?: string; - site_admin?: boolean; - }; - name?: string; - description?: string; - external_url?: string; - html_url?: string; - created_at?: string; - updated_at?: string; + type?: string + site_admin?: boolean + } + name?: string + description?: string + external_url?: string + html_url?: string + created_at?: string + updated_at?: string permissions?: { - metadata?: string; - contents?: string; - issues?: string; - single_file?: string; - }; - events?: string[]; - }[]; - }; + metadata?: string + contents?: string + issues?: string + single_file?: string + } + events?: string[] + }[] + } /** * Branch Protection * @description Branch Protection */ - "branch-protection": { - url?: string; - enabled?: boolean; - required_status_checks?: components["schemas"]["protected-branch-required-status-check"]; - enforce_admins?: components["schemas"]["protected-branch-admin-enforced"]; - required_pull_request_reviews?: components["schemas"]["protected-branch-pull-request-review"]; - restrictions?: components["schemas"]["branch-restriction-policy"]; + 'branch-protection': { + url?: string + enabled?: boolean + required_status_checks?: components['schemas']['protected-branch-required-status-check'] + enforce_admins?: components['schemas']['protected-branch-admin-enforced'] + required_pull_request_reviews?: components['schemas']['protected-branch-pull-request-review'] + restrictions?: components['schemas']['branch-restriction-policy'] required_linear_history?: { - enabled?: boolean; - }; + enabled?: boolean + } allow_force_pushes?: { - enabled?: boolean; - }; + enabled?: boolean + } allow_deletions?: { - enabled?: boolean; - }; + enabled?: boolean + } required_conversation_resolution?: { - enabled?: boolean; - }; + enabled?: boolean + } /** @example "branch/with/protection" */ - name?: string; + name?: string /** @example "https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection" */ - protection_url?: string; + protection_url?: string required_signatures?: { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures */ - url: string; + url: string /** @example true */ - enabled: boolean; - }; - }; + enabled: boolean + } + } /** * Short Branch * @description Short Branch */ - "short-branch": { - name: string; + 'short-branch': { + name: string commit: { - sha: string; + sha: string /** Format: uri */ - url: string; - }; - protected: boolean; - protection?: components["schemas"]["branch-protection"]; + url: string + } + protected: boolean + protection?: components['schemas']['branch-protection'] /** Format: uri */ - protection_url?: string; - }; + protection_url?: string + } /** * Git User * @description Metaproperties for Git author/committer information. */ - "nullable-git-user": { + 'nullable-git-user': { /** @example "Chris Wanstrath" */ - name?: string; + name?: string /** @example "chris@ozmm.org" */ - email?: string; + email?: string /** @example "2007-10-29T02:42:39.000-07:00" */ - date?: string; - } | null; + date?: string + } | null /** Verification */ verification: { - verified: boolean; - reason: string; - payload: string | null; - signature: string | null; - }; + verified: boolean + reason: string + payload: string | null + signature: string | null + } /** * Diff Entry * @description Diff Entry */ - "diff-entry": { + 'diff-entry': { /** @example bbcd538c8e72b8c175046e27cc8f907076331401 */ - sha: string; + sha: string /** @example file1.txt */ - filename: string; + filename: string /** * @example added * @enum {string} */ - status: "added" | "removed" | "modified" | "renamed" | "copied" | "changed" | "unchanged"; + status: 'added' | 'removed' | 'modified' | 'renamed' | 'copied' | 'changed' | 'unchanged' /** @example 103 */ - additions: number; + additions: number /** @example 21 */ - deletions: number; + deletions: number /** @example 124 */ - changes: number; + changes: number /** * Format: uri * @example https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt */ - blob_url: string; + blob_url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt */ - raw_url: string; + raw_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e */ - contents_url: string; + contents_url: string /** @example @@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test */ - patch?: string; + patch?: string /** @example file.txt */ - previous_filename?: string; - }; + previous_filename?: string + } /** * Commit * @description Commit @@ -12148,1651 +12140,1647 @@ export interface components { * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e */ - url: string; + url: string /** @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */ - sha: string; + sha: string /** @example MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== */ - node_id: string; + node_id: string /** * Format: uri * @example https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments */ - comments_url: string; + comments_url: string commit: { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e */ - url: string; - author: components["schemas"]["nullable-git-user"]; - committer: components["schemas"]["nullable-git-user"]; + url: string + author: components['schemas']['nullable-git-user'] + committer: components['schemas']['nullable-git-user'] /** @example Fix all the bugs */ - message: string; - comment_count: number; + message: string + comment_count: number tree: { /** @example 827efc6d56897b048c772eb4087f854f46256132 */ - sha: string; + sha: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132 */ - url: string; - }; - verification?: components["schemas"]["verification"]; - }; - author: components["schemas"]["nullable-simple-user"]; - committer: components["schemas"]["nullable-simple-user"]; + url: string + } + verification?: components['schemas']['verification'] + } + author: components['schemas']['nullable-simple-user'] + committer: components['schemas']['nullable-simple-user'] parents: { /** @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - sha: string; + sha: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd */ - url: string; + url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd */ - html_url?: string; - }[]; + html_url?: string + }[] stats?: { - additions?: number; - deletions?: number; - total?: number; - }; - files?: components["schemas"]["diff-entry"][]; - }; + additions?: number + deletions?: number + total?: number + } + files?: components['schemas']['diff-entry'][] + } /** * Branch With Protection * @description Branch With Protection */ - "branch-with-protection": { - name: string; - commit: components["schemas"]["commit"]; + 'branch-with-protection': { + name: string + commit: components['schemas']['commit'] _links: { - html: string; + html: string /** Format: uri */ - self: string; - }; - protected: boolean; - protection: components["schemas"]["branch-protection"]; + self: string + } + protected: boolean + protection: components['schemas']['branch-protection'] /** Format: uri */ - protection_url: string; + protection_url: string /** @example "mas*" */ - pattern?: string; + pattern?: string /** @example 1 */ - required_approving_review_count?: number; - }; + required_approving_review_count?: number + } /** * Status Check Policy * @description Status Check Policy */ - "status-check-policy": { + 'status-check-policy': { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks */ - url: string; + url: string /** @example true */ - strict: boolean; + strict: boolean /** @example continuous-integration/travis-ci */ - contexts: string[]; + contexts: string[] checks: { /** @example continuous-integration/travis-ci */ - context: string; - app_id: number | null; - }[]; + context: string + app_id: number | null + }[] /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts */ - contexts_url: string; - }; + contexts_url: string + } /** * Protected Branch * @description Branch protections protect branches */ - "protected-branch": { + 'protected-branch': { /** Format: uri */ - url: string; - required_status_checks?: components["schemas"]["status-check-policy"]; + url: string + required_status_checks?: components['schemas']['status-check-policy'] required_pull_request_reviews?: { /** Format: uri */ - url: string; - dismiss_stale_reviews?: boolean; - require_code_owner_reviews?: boolean; - required_approving_review_count?: number; + url: string + dismiss_stale_reviews?: boolean + require_code_owner_reviews?: boolean + required_approving_review_count?: number dismissal_restrictions?: { /** Format: uri */ - url: string; + url: string /** Format: uri */ - users_url: string; + users_url: string /** Format: uri */ - teams_url: string; - users: components["schemas"]["simple-user"][]; - teams: components["schemas"]["team"][]; - }; + teams_url: string + users: components['schemas']['simple-user'][] + teams: components['schemas']['team'][] + } bypass_pull_request_allowances?: { - users: components["schemas"]["simple-user"][]; - teams: components["schemas"]["team"][]; - }; - }; + users: components['schemas']['simple-user'][] + teams: components['schemas']['team'][] + } + } required_signatures?: { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures */ - url: string; + url: string /** @example true */ - enabled: boolean; - }; + enabled: boolean + } enforce_admins?: { /** Format: uri */ - url: string; - enabled: boolean; - }; + url: string + enabled: boolean + } required_linear_history?: { - enabled: boolean; - }; + enabled: boolean + } allow_force_pushes?: { - enabled: boolean; - }; + enabled: boolean + } allow_deletions?: { - enabled: boolean; - }; - restrictions?: components["schemas"]["branch-restriction-policy"]; + enabled: boolean + } + restrictions?: components['schemas']['branch-restriction-policy'] required_conversation_resolution?: { - enabled?: boolean; - }; - }; + enabled?: boolean + } + } /** * Deployment * @description A deployment created as the result of an Actions check run from a workflow that references an environment */ - "deployment-simple": { + 'deployment-simple': { /** * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1 */ - url: string; + url: string /** * @description Unique identifier of the deployment * @example 42 */ - id: number; + id: number /** @example MDEwOkRlcGxveW1lbnQx */ - node_id: string; + node_id: string /** * @description Parameter to specify a task to execute * @example deploy */ - task: string; + task: string /** @example staging */ - original_environment?: string; + original_environment?: string /** * @description Name for the target deployment environment. * @example production */ - environment: string; + environment: string /** @example Deploy request from hubot */ - description: string | null; + description: string | null /** * Format: date-time * @example 2012-07-20T01:19:13Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2012-07-20T01:19:13Z */ - updated_at: string; + updated_at: string /** * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1/statuses */ - statuses_url: string; + statuses_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/example */ - repository_url: string; + repository_url: string /** * @description Specifies if the given environment is will no longer exist at some point in the future. Default: false. * @example true */ - transient_environment?: boolean; + transient_environment?: boolean /** * @description Specifies if the given environment is one that end-users directly interact with. Default: false. * @example true */ - production_environment?: boolean; - performed_via_github_app?: components["schemas"]["nullable-integration"]; - }; + production_environment?: boolean + performed_via_github_app?: components['schemas']['nullable-integration'] + } /** * CheckRun * @description A check performed on the code of a given code change */ - "check-run": { + 'check-run': { /** * @description The id of the check. * @example 21 */ - id: number; + id: number /** * @description The SHA of the commit that is being checked. * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d */ - head_sha: string; + head_sha: string /** @example MDg6Q2hlY2tSdW40 */ - node_id: string; + node_id: string /** @example 42 */ - external_id: string | null; + external_id: string | null /** @example https://api.github.com/repos/github/hello-world/check-runs/4 */ - url: string; + url: string /** @example https://github.com/github/hello-world/runs/4 */ - html_url: string | null; + html_url: string | null /** @example https://example.com */ - details_url: string | null; + details_url: string | null /** * @description The phase of the lifecycle that the check is currently in. * @example queued * @enum {string} */ - status: "queued" | "in_progress" | "completed"; + status: 'queued' | 'in_progress' | 'completed' /** * @example neutral * @enum {string|null} */ - conclusion: - | ("success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required") - | null; + conclusion: ('success' | 'failure' | 'neutral' | 'cancelled' | 'skipped' | 'timed_out' | 'action_required') | null /** * Format: date-time * @example 2018-05-04T01:14:52Z */ - started_at: string | null; + started_at: string | null /** * Format: date-time * @example 2018-05-04T01:14:52Z */ - completed_at: string | null; + completed_at: string | null output: { - title: string | null; - summary: string | null; - text: string | null; - annotations_count: number; + title: string | null + summary: string | null + text: string | null + annotations_count: number /** Format: uri */ - annotations_url: string; - }; + annotations_url: string + } /** * @description The name of the check. * @example test-coverage */ - name: string; + name: string check_suite: { - id: number; - } | null; - app: components["schemas"]["nullable-integration"]; - pull_requests: components["schemas"]["pull-request-minimal"][]; - deployment?: components["schemas"]["deployment-simple"]; - }; + id: number + } | null + app: components['schemas']['nullable-integration'] + pull_requests: components['schemas']['pull-request-minimal'][] + deployment?: components['schemas']['deployment-simple'] + } /** * Check Annotation * @description Check Annotation */ - "check-annotation": { + 'check-annotation': { /** @example README.md */ - path: string; + path: string /** @example 2 */ - start_line: number; + start_line: number /** @example 2 */ - end_line: number; + end_line: number /** @example 5 */ - start_column: number | null; + start_column: number | null /** @example 10 */ - end_column: number | null; + end_column: number | null /** @example warning */ - annotation_level: string | null; + annotation_level: string | null /** @example Spell Checker */ - title: string | null; + title: string | null /** @example Check your spelling for 'banaas'. */ - message: string | null; + message: string | null /** @example Do you mean 'bananas' or 'banana'? */ - raw_details: string | null; - blob_href: string; - }; + raw_details: string | null + blob_href: string + } /** * Simple Commit * @description Simple Commit */ - "simple-commit": { - id: string; - tree_id: string; - message: string; + 'simple-commit': { + id: string + tree_id: string + message: string /** Format: date-time */ - timestamp: string; + timestamp: string author: { - name: string; - email: string; - } | null; + name: string + email: string + } | null committer: { - name: string; - email: string; - } | null; - }; + name: string + email: string + } | null + } /** * CheckSuite * @description A suite of checks performed on the code of a given code change */ - "check-suite": { + 'check-suite': { /** @example 5 */ - id: number; + id: number /** @example MDEwOkNoZWNrU3VpdGU1 */ - node_id: string; + node_id: string /** @example master */ - head_branch: string | null; + head_branch: string | null /** * @description The SHA of the head commit that is being checked. * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d */ - head_sha: string; + head_sha: string /** * @example completed * @enum {string|null} */ - status: ("queued" | "in_progress" | "completed") | null; + status: ('queued' | 'in_progress' | 'completed') | null /** * @example neutral * @enum {string|null} */ - conclusion: - | ("success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required") - | null; + conclusion: ('success' | 'failure' | 'neutral' | 'cancelled' | 'skipped' | 'timed_out' | 'action_required') | null /** @example https://api.github.com/repos/github/hello-world/check-suites/5 */ - url: string | null; + url: string | null /** @example 146e867f55c26428e5f9fade55a9bbf5e95a7912 */ - before: string | null; + before: string | null /** @example d6fde92930d4715a2b49857d24b940956b26d2d3 */ - after: string | null; - pull_requests: components["schemas"]["pull-request-minimal"][] | null; - app: components["schemas"]["nullable-integration"]; - repository: components["schemas"]["minimal-repository"]; + after: string | null + pull_requests: components['schemas']['pull-request-minimal'][] | null + app: components['schemas']['nullable-integration'] + repository: components['schemas']['minimal-repository'] /** Format: date-time */ - created_at: string | null; + created_at: string | null /** Format: date-time */ - updated_at: string | null; - head_commit: components["schemas"]["simple-commit"]; - latest_check_runs_count: number; - check_runs_url: string; - rerequestable?: boolean; - runs_rerequestable?: boolean; - }; + updated_at: string | null + head_commit: components['schemas']['simple-commit'] + latest_check_runs_count: number + check_runs_url: string + rerequestable?: boolean + runs_rerequestable?: boolean + } /** * Check Suite Preference * @description Check suite configuration preferences for a repository. */ - "check-suite-preference": { + 'check-suite-preference': { preferences: { auto_trigger_checks?: { - app_id: number; - setting: boolean; - }[]; - }; - repository: components["schemas"]["minimal-repository"]; - }; - "code-scanning-alert-rule-summary": { + app_id: number + setting: boolean + }[] + } + repository: components['schemas']['minimal-repository'] + } + 'code-scanning-alert-rule-summary': { /** @description A unique identifier for the rule used to detect the alert. */ - id?: string | null; + id?: string | null /** @description The name of the rule used to detect the alert. */ - name?: string; + name?: string /** @description A set of tags applicable for the rule. */ - tags?: string[] | null; + tags?: string[] | null /** * @description The severity of the alert. * @enum {string|null} */ - severity?: ("none" | "note" | "warning" | "error") | null; + severity?: ('none' | 'note' | 'warning' | 'error') | null /** @description A short description of the rule used to detect the alert. */ - description?: string; - }; - "code-scanning-alert-items": { - number: components["schemas"]["alert-number"]; - created_at: components["schemas"]["alert-created-at"]; - updated_at?: components["schemas"]["alert-updated-at"]; - url: components["schemas"]["alert-url"]; - html_url: components["schemas"]["alert-html-url"]; - instances_url: components["schemas"]["alert-instances-url"]; - state: components["schemas"]["code-scanning-alert-state"]; - fixed_at?: components["schemas"]["code-scanning-alert-fixed-at"]; - dismissed_by: components["schemas"]["nullable-simple-user"]; - dismissed_at: components["schemas"]["code-scanning-alert-dismissed-at"]; - dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"]; - rule: components["schemas"]["code-scanning-alert-rule-summary"]; - tool: components["schemas"]["code-scanning-analysis-tool"]; - most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; - }; - "code-scanning-alert": { - number: components["schemas"]["alert-number"]; - created_at: components["schemas"]["alert-created-at"]; - updated_at?: components["schemas"]["alert-updated-at"]; - url: components["schemas"]["alert-url"]; - html_url: components["schemas"]["alert-html-url"]; - instances_url: components["schemas"]["alert-instances-url"]; - state: components["schemas"]["code-scanning-alert-state"]; - fixed_at?: components["schemas"]["code-scanning-alert-fixed-at"]; - dismissed_by: components["schemas"]["nullable-simple-user"]; - dismissed_at: components["schemas"]["code-scanning-alert-dismissed-at"]; - dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"]; - rule: components["schemas"]["code-scanning-alert-rule"]; - tool: components["schemas"]["code-scanning-analysis-tool"]; - most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; - }; + description?: string + } + 'code-scanning-alert-items': { + number: components['schemas']['alert-number'] + created_at: components['schemas']['alert-created-at'] + updated_at?: components['schemas']['alert-updated-at'] + url: components['schemas']['alert-url'] + html_url: components['schemas']['alert-html-url'] + instances_url: components['schemas']['alert-instances-url'] + state: components['schemas']['code-scanning-alert-state'] + fixed_at?: components['schemas']['code-scanning-alert-fixed-at'] + dismissed_by: components['schemas']['nullable-simple-user'] + dismissed_at: components['schemas']['code-scanning-alert-dismissed-at'] + dismissed_reason: components['schemas']['code-scanning-alert-dismissed-reason'] + rule: components['schemas']['code-scanning-alert-rule-summary'] + tool: components['schemas']['code-scanning-analysis-tool'] + most_recent_instance: components['schemas']['code-scanning-alert-instance'] + } + 'code-scanning-alert': { + number: components['schemas']['alert-number'] + created_at: components['schemas']['alert-created-at'] + updated_at?: components['schemas']['alert-updated-at'] + url: components['schemas']['alert-url'] + html_url: components['schemas']['alert-html-url'] + instances_url: components['schemas']['alert-instances-url'] + state: components['schemas']['code-scanning-alert-state'] + fixed_at?: components['schemas']['code-scanning-alert-fixed-at'] + dismissed_by: components['schemas']['nullable-simple-user'] + dismissed_at: components['schemas']['code-scanning-alert-dismissed-at'] + dismissed_reason: components['schemas']['code-scanning-alert-dismissed-reason'] + rule: components['schemas']['code-scanning-alert-rule'] + tool: components['schemas']['code-scanning-analysis-tool'] + most_recent_instance: components['schemas']['code-scanning-alert-instance'] + } /** * @description Sets the state of the code scanning alert. Can be one of `open` or `dismissed`. You must provide `dismissed_reason` when you set the state to `dismissed`. * @enum {string} */ - "code-scanning-alert-set-state": "open" | "dismissed"; + 'code-scanning-alert-set-state': 'open' | 'dismissed' /** * @description An identifier for the upload. * @example 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 */ - "code-scanning-analysis-sarif-id": string; + 'code-scanning-analysis-sarif-id': string /** @description The SHA of the commit to which the analysis you are uploading relates. */ - "code-scanning-analysis-commit-sha": string; + 'code-scanning-analysis-commit-sha': string /** @description Identifies the variable values associated with the environment in which this analysis was performed. */ - "code-scanning-analysis-environment": string; + 'code-scanning-analysis-environment': string /** * Format: date-time * @description The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "code-scanning-analysis-created-at": string; + 'code-scanning-analysis-created-at': string /** * Format: uri * @description The REST API URL of the analysis resource. */ - "code-scanning-analysis-url": string; - "code-scanning-analysis": { - ref: components["schemas"]["code-scanning-ref"]; - commit_sha: components["schemas"]["code-scanning-analysis-commit-sha"]; - analysis_key: components["schemas"]["code-scanning-analysis-analysis-key"]; - environment: components["schemas"]["code-scanning-analysis-environment"]; - category?: components["schemas"]["code-scanning-analysis-category"]; + 'code-scanning-analysis-url': string + 'code-scanning-analysis': { + ref: components['schemas']['code-scanning-ref'] + commit_sha: components['schemas']['code-scanning-analysis-commit-sha'] + analysis_key: components['schemas']['code-scanning-analysis-analysis-key'] + environment: components['schemas']['code-scanning-analysis-environment'] + category?: components['schemas']['code-scanning-analysis-category'] /** @example error reading field xyz */ - error: string; - created_at: components["schemas"]["code-scanning-analysis-created-at"]; + error: string + created_at: components['schemas']['code-scanning-analysis-created-at'] /** @description The total number of results in the analysis. */ - results_count: number; + results_count: number /** @description The total number of rules used in the analysis. */ - rules_count: number; + rules_count: number /** @description Unique identifier for this analysis. */ - id: number; - url: components["schemas"]["code-scanning-analysis-url"]; - sarif_id: components["schemas"]["code-scanning-analysis-sarif-id"]; - tool: components["schemas"]["code-scanning-analysis-tool"]; - deletable: boolean; + id: number + url: components['schemas']['code-scanning-analysis-url'] + sarif_id: components['schemas']['code-scanning-analysis-sarif-id'] + tool: components['schemas']['code-scanning-analysis-tool'] + deletable: boolean /** * @description Warning generated when processing the analysis * @example 123 results were ignored */ - warning: string; - }; + warning: string + } /** * Analysis deletion * @description Successful deletion of a code scanning analysis */ - "code-scanning-analysis-deletion": { + 'code-scanning-analysis-deletion': { /** * Format: uri * @description Next deletable analysis in chain, without last analysis deletion confirmation */ - next_analysis_url: string | null; + next_analysis_url: string | null /** * Format: uri * @description Next deletable analysis in chain, with last analysis deletion confirmation */ - confirm_delete_url: string | null; - }; + confirm_delete_url: string | null + } /** @description A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see "[SARIF support for code scanning](https://docs.github.com/code-security/secure-coding/sarif-support-for-code-scanning)." */ - "code-scanning-analysis-sarif-file": string; - "code-scanning-sarifs-receipt": { - id?: components["schemas"]["code-scanning-analysis-sarif-id"]; + 'code-scanning-analysis-sarif-file': string + 'code-scanning-sarifs-receipt': { + id?: components['schemas']['code-scanning-analysis-sarif-id'] /** * Format: uri * @description The REST API URL for checking the status of the upload. */ - url?: string; - }; - "code-scanning-sarifs-status": { + url?: string + } + 'code-scanning-sarifs-status': { /** * @description `pending` files have not yet been processed, while `complete` means results from the SARIF have been stored. `failed` files have either not been processed at all, or could only be partially processed. * @enum {string} */ - processing_status?: "pending" | "complete" | "failed"; + processing_status?: 'pending' | 'complete' | 'failed' /** * Format: uri * @description The REST API URL for getting the analyses associated with the upload. */ - analyses_url?: string | null; + analyses_url?: string | null /** @description Any errors that ocurred during processing of the delivery. */ - errors?: string[] | null; - }; + errors?: string[] | null + } /** * Codespace machine * @description A description of the machine powering a codespace. */ - "nullable-codespace-machine": { + 'nullable-codespace-machine': { /** * @description The name of the machine. * @example standardLinux */ - name: string; + name: string /** * @description The display name of the machine includes cores, memory, and storage. * @example 4 cores, 8 GB RAM, 64 GB storage */ - display_name: string; + display_name: string /** * @description The operating system of the machine. * @example linux */ - operating_system: string; + operating_system: string /** * @description How much storage is available to the codespace. * @example 68719476736 */ - storage_in_bytes: number; + storage_in_bytes: number /** * @description How much memory is available to the codespace. * @example 8589934592 */ - memory_in_bytes: number; + memory_in_bytes: number /** * @description How many cores are available to the codespace. * @example 4 */ - cpus: number; + cpus: number /** * @description Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be "null" if prebuilds are not supported or prebuild availability could not be determined. Value is the type of prebuild available, or "none" if none are available. * @example blob * @enum {string|null} */ - prebuild_availability: ("none" | "blob" | "pool") | null; - } | null; + prebuild_availability: ('none' | 'blob' | 'pool') | null + } | null /** * Codespace * @description A codespace. */ codespace: { /** @example 1 */ - id: number; + id: number /** * @description Automatically generated name of this codespace. * @example monalisa-octocat-hello-world-g4wpq6h95q */ - name: string; + name: string /** * @description UUID identifying this codespace's environment. * @example 26a7c758-7299-4a73-b978-5a92a7ae98a0 */ - environment_id: string | null; - owner: components["schemas"]["simple-user"]; - billable_owner: components["schemas"]["simple-user"]; - repository: components["schemas"]["minimal-repository"]; - machine: components["schemas"]["nullable-codespace-machine"]; + environment_id: string | null + owner: components['schemas']['simple-user'] + billable_owner: components['schemas']['simple-user'] + repository: components['schemas']['minimal-repository'] + machine: components['schemas']['nullable-codespace-machine'] /** @description Whether the codespace was created from a prebuild. */ - prebuild: boolean | null; + prebuild: boolean | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - updated_at: string; + updated_at: string /** * Format: date-time * @description Last known time this codespace was started. * @example 2011-01-26T19:01:12Z */ - last_used_at: string; + last_used_at: string /** * @description State of this codespace. * @example Available * @enum {string} */ state: - | "Unknown" - | "Created" - | "Queued" - | "Provisioning" - | "Available" - | "Awaiting" - | "Unavailable" - | "Deleted" - | "Moved" - | "Shutdown" - | "Archived" - | "Starting" - | "ShuttingDown" - | "Failed" - | "Exporting" - | "Updating" - | "Rebuilding"; + | 'Unknown' + | 'Created' + | 'Queued' + | 'Provisioning' + | 'Available' + | 'Awaiting' + | 'Unavailable' + | 'Deleted' + | 'Moved' + | 'Shutdown' + | 'Archived' + | 'Starting' + | 'ShuttingDown' + | 'Failed' + | 'Exporting' + | 'Updating' + | 'Rebuilding' /** * Format: uri * @description API URL for this codespace. */ - url: string; + url: string /** @description Details about the codespace's git repository. */ git_status: { /** @description The number of commits the local repository is ahead of the remote. */ - ahead?: number; + ahead?: number /** @description The number of commits the local repository is behind the remote. */ - behind?: number; + behind?: number /** @description Whether the local repository has unpushed changes. */ - has_unpushed_changes?: boolean; + has_unpushed_changes?: boolean /** @description Whether the local repository has uncommitted changes. */ - has_uncommitted_changes?: boolean; + has_uncommitted_changes?: boolean /** * @description The current branch (or SHA if in detached HEAD state) of the local repository. * @example main */ - ref?: string; - }; + ref?: string + } /** * @description The Azure region where this codespace is located. * @example WestUs2 * @enum {string} */ - location: "EastUs" | "SouthEastAsia" | "WestEurope" | "WestUs2"; + location: 'EastUs' | 'SouthEastAsia' | 'WestEurope' | 'WestUs2' /** * @description The number of minutes of inactivity after which this codespace will be automatically stopped. * @example 60 */ - idle_timeout_minutes: number | null; + idle_timeout_minutes: number | null /** * Format: uri * @description URL to access this codespace on the web. */ - web_url: string; + web_url: string /** * Format: uri * @description API URL to access available alternate machine types for this codespace. */ - machines_url: string; + machines_url: string /** * Format: uri * @description API URL to start this codespace. */ - start_url: string; + start_url: string /** * Format: uri * @description API URL to stop this codespace. */ - stop_url: string; + stop_url: string /** * Format: uri * @description API URL for the Pull Request associated with this codespace, if any. */ - pulls_url: string | null; - recent_folders: string[]; + pulls_url: string | null + recent_folders: string[] runtime_constraints?: { /** @description The privacy settings a user can select from when forwarding a port. */ - allowed_port_privacy_settings?: string[] | null; - }; - }; + allowed_port_privacy_settings?: string[] | null + } + } /** * Codespace machine * @description A description of the machine powering a codespace. */ - "codespace-machine": { + 'codespace-machine': { /** * @description The name of the machine. * @example standardLinux */ - name: string; + name: string /** * @description The display name of the machine includes cores, memory, and storage. * @example 4 cores, 8 GB RAM, 64 GB storage */ - display_name: string; + display_name: string /** * @description The operating system of the machine. * @example linux */ - operating_system: string; + operating_system: string /** * @description How much storage is available to the codespace. * @example 68719476736 */ - storage_in_bytes: number; + storage_in_bytes: number /** * @description How much memory is available to the codespace. * @example 8589934592 */ - memory_in_bytes: number; + memory_in_bytes: number /** * @description How many cores are available to the codespace. * @example 4 */ - cpus: number; + cpus: number /** * @description Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be "null" if prebuilds are not supported or prebuild availability could not be determined. Value is the type of prebuild available, or "none" if none are available. * @example blob * @enum {string|null} */ - prebuild_availability: ("none" | "blob" | "pool") | null; - }; + prebuild_availability: ('none' | 'blob' | 'pool') | null + } /** * Collaborator * @description Collaborator */ collaborator: { /** @example octocat */ - login: string; + login: string /** @example 1 */ - id: number; - email?: string | null; - name?: string | null; + id: number + email?: string | null + name?: string | null /** @example MDQ6VXNlcjE= */ - node_id: string; + node_id: string /** * Format: uri * @example https://github.com/images/error/octocat_happy.gif */ - avatar_url: string; + avatar_url: string /** @example 41d064eb2195891e12d0413f63227ea7 */ - gravatar_id: string | null; + gravatar_id: string | null /** * Format: uri * @example https://api.github.com/users/octocat */ - url: string; + url: string /** * Format: uri * @example https://github.com/octocat */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/users/octocat/followers */ - followers_url: string; + followers_url: string /** @example https://api.github.com/users/octocat/following{/other_user} */ - following_url: string; + following_url: string /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - gists_url: string; + gists_url: string /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - starred_url: string; + starred_url: string /** * Format: uri * @example https://api.github.com/users/octocat/subscriptions */ - subscriptions_url: string; + subscriptions_url: string /** * Format: uri * @example https://api.github.com/users/octocat/orgs */ - organizations_url: string; + organizations_url: string /** * Format: uri * @example https://api.github.com/users/octocat/repos */ - repos_url: string; + repos_url: string /** @example https://api.github.com/users/octocat/events{/privacy} */ - events_url: string; + events_url: string /** * Format: uri * @example https://api.github.com/users/octocat/received_events */ - received_events_url: string; + received_events_url: string /** @example User */ - type: string; - site_admin: boolean; + type: string + site_admin: boolean permissions?: { - pull: boolean; - triage?: boolean; - push: boolean; - maintain?: boolean; - admin: boolean; - }; + pull: boolean + triage?: boolean + push: boolean + maintain?: boolean + admin: boolean + } /** @example admin */ - role_name: string; - }; + role_name: string + } /** * Repository Invitation * @description Repository invitations let you manage who you collaborate with. */ - "repository-invitation": { + 'repository-invitation': { /** * @description Unique identifier of the repository invitation. * @example 42 */ - id: number; - repository: components["schemas"]["minimal-repository"]; - invitee: components["schemas"]["nullable-simple-user"]; - inviter: components["schemas"]["nullable-simple-user"]; + id: number + repository: components['schemas']['minimal-repository'] + invitee: components['schemas']['nullable-simple-user'] + inviter: components['schemas']['nullable-simple-user'] /** * @description The permission associated with the invitation. * @example read * @enum {string} */ - permissions: "read" | "write" | "admin" | "triage" | "maintain"; + permissions: 'read' | 'write' | 'admin' | 'triage' | 'maintain' /** * Format: date-time * @example 2016-06-13T14:52:50-05:00 */ - created_at: string; + created_at: string /** @description Whether or not the invitation has expired */ - expired?: boolean; + expired?: boolean /** * @description URL for the repository invitation * @example https://api.github.com/user/repository-invitations/1 */ - url: string; + url: string /** @example https://github.com/octocat/Hello-World/invitations */ - html_url: string; - node_id: string; - }; + html_url: string + node_id: string + } /** * Collaborator * @description Collaborator */ - "nullable-collaborator": { + 'nullable-collaborator': { /** @example octocat */ - login: string; + login: string /** @example 1 */ - id: number; - email?: string | null; - name?: string | null; + id: number + email?: string | null + name?: string | null /** @example MDQ6VXNlcjE= */ - node_id: string; + node_id: string /** * Format: uri * @example https://github.com/images/error/octocat_happy.gif */ - avatar_url: string; + avatar_url: string /** @example 41d064eb2195891e12d0413f63227ea7 */ - gravatar_id: string | null; + gravatar_id: string | null /** * Format: uri * @example https://api.github.com/users/octocat */ - url: string; + url: string /** * Format: uri * @example https://github.com/octocat */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/users/octocat/followers */ - followers_url: string; + followers_url: string /** @example https://api.github.com/users/octocat/following{/other_user} */ - following_url: string; + following_url: string /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - gists_url: string; + gists_url: string /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - starred_url: string; + starred_url: string /** * Format: uri * @example https://api.github.com/users/octocat/subscriptions */ - subscriptions_url: string; + subscriptions_url: string /** * Format: uri * @example https://api.github.com/users/octocat/orgs */ - organizations_url: string; + organizations_url: string /** * Format: uri * @example https://api.github.com/users/octocat/repos */ - repos_url: string; + repos_url: string /** @example https://api.github.com/users/octocat/events{/privacy} */ - events_url: string; + events_url: string /** * Format: uri * @example https://api.github.com/users/octocat/received_events */ - received_events_url: string; + received_events_url: string /** @example User */ - type: string; - site_admin: boolean; + type: string + site_admin: boolean permissions?: { - pull: boolean; - triage?: boolean; - push: boolean; - maintain?: boolean; - admin: boolean; - }; + pull: boolean + triage?: boolean + push: boolean + maintain?: boolean + admin: boolean + } /** @example admin */ - role_name: string; - } | null; + role_name: string + } | null /** * Repository Collaborator Permission * @description Repository Collaborator Permission */ - "repository-collaborator-permission": { - permission: string; + 'repository-collaborator-permission': { + permission: string /** @example admin */ - role_name: string; - user: components["schemas"]["nullable-collaborator"]; - }; + role_name: string + user: components['schemas']['nullable-collaborator'] + } /** * Commit Comment * @description Commit Comment */ - "commit-comment": { + 'commit-comment': { /** Format: uri */ - html_url: string; + html_url: string /** Format: uri */ - url: string; - id: number; - node_id: string; - body: string; - path: string | null; - position: number | null; - line: number | null; - commit_id: string; - user: components["schemas"]["nullable-simple-user"]; + url: string + id: number + node_id: string + body: string + path: string | null + position: number | null + line: number | null + commit_id: string + user: components['schemas']['nullable-simple-user'] /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - author_association: components["schemas"]["author_association"]; - reactions?: components["schemas"]["reaction-rollup"]; - }; + updated_at: string + author_association: components['schemas']['author_association'] + reactions?: components['schemas']['reaction-rollup'] + } /** * Branch Short * @description Branch Short */ - "branch-short": { - name: string; + 'branch-short': { + name: string commit: { - sha: string; - url: string; - }; - protected: boolean; - }; + sha: string + url: string + } + protected: boolean + } /** * Link * @description Hypermedia Link */ link: { - href: string; - }; + href: string + } /** * Auto merge * @description The status of auto merging a pull request. */ auto_merge: { - enabled_by: components["schemas"]["simple-user"]; + enabled_by: components['schemas']['simple-user'] /** * @description The merge method to use. * @enum {string} */ - merge_method: "merge" | "squash" | "rebase"; + merge_method: 'merge' | 'squash' | 'rebase' /** @description Title for the merge commit message. */ - commit_title: string; + commit_title: string /** @description Commit message for the merge commit. */ - commit_message: string; - } | null; + commit_message: string + } | null /** * Pull Request Simple * @description Pull Request Simple */ - "pull-request-simple": { + 'pull-request-simple': { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ - url: string; + url: string /** @example 1 */ - id: number; + id: number /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ - node_id: string; + node_id: string /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347 */ - html_url: string; + html_url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.diff */ - diff_url: string; + diff_url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.patch */ - patch_url: string; + patch_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 */ - issue_url: string; + issue_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits */ - commits_url: string; + commits_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments */ - review_comments_url: string; + review_comments_url: string /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} */ - review_comment_url: string; + review_comment_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347/comments */ - comments_url: string; + comments_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e */ - statuses_url: string; + statuses_url: string /** @example 1347 */ - number: number; + number: number /** @example open */ - state: string; + state: string /** @example true */ - locked: boolean; + locked: boolean /** @example new-feature */ - title: string; - user: components["schemas"]["nullable-simple-user"]; + title: string + user: components['schemas']['nullable-simple-user'] /** @example Please pull these awesome changes */ - body: string | null; + body: string | null labels: { /** Format: int64 */ - id: number; - node_id: string; - url: string; - name: string; - description: string; - color: string; - default: boolean; - }[]; - milestone: components["schemas"]["nullable-milestone"]; + id: number + node_id: string + url: string + name: string + description: string + color: string + default: boolean + }[] + milestone: components['schemas']['nullable-milestone'] /** @example too heated */ - active_lock_reason?: string | null; + active_lock_reason?: string | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - updated_at: string; + updated_at: string /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - closed_at: string | null; + closed_at: string | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - merged_at: string | null; + merged_at: string | null /** @example e5bd3914e2e596debea16f433f57875b5b90bcd6 */ - merge_commit_sha: string | null; - assignee: components["schemas"]["nullable-simple-user"]; - assignees?: components["schemas"]["simple-user"][] | null; - requested_reviewers?: components["schemas"]["simple-user"][] | null; - requested_teams?: components["schemas"]["team"][] | null; + merge_commit_sha: string | null + assignee: components['schemas']['nullable-simple-user'] + assignees?: components['schemas']['simple-user'][] | null + requested_reviewers?: components['schemas']['simple-user'][] | null + requested_teams?: components['schemas']['team'][] | null head: { - label: string; - ref: string; - repo: components["schemas"]["repository"]; - sha: string; - user: components["schemas"]["nullable-simple-user"]; - }; + label: string + ref: string + repo: components['schemas']['repository'] + sha: string + user: components['schemas']['nullable-simple-user'] + } base: { - label: string; - ref: string; - repo: components["schemas"]["repository"]; - sha: string; - user: components["schemas"]["nullable-simple-user"]; - }; + label: string + ref: string + repo: components['schemas']['repository'] + sha: string + user: components['schemas']['nullable-simple-user'] + } _links: { - comments: components["schemas"]["link"]; - commits: components["schemas"]["link"]; - statuses: components["schemas"]["link"]; - html: components["schemas"]["link"]; - issue: components["schemas"]["link"]; - review_comments: components["schemas"]["link"]; - review_comment: components["schemas"]["link"]; - self: components["schemas"]["link"]; - }; - author_association: components["schemas"]["author_association"]; - auto_merge: components["schemas"]["auto_merge"]; + comments: components['schemas']['link'] + commits: components['schemas']['link'] + statuses: components['schemas']['link'] + html: components['schemas']['link'] + issue: components['schemas']['link'] + review_comments: components['schemas']['link'] + review_comment: components['schemas']['link'] + self: components['schemas']['link'] + } + author_association: components['schemas']['author_association'] + auto_merge: components['schemas']['auto_merge'] /** @description Indicates whether or not the pull request is a draft. */ - draft?: boolean; - }; + draft?: boolean + } /** Simple Commit Status */ - "simple-commit-status": { - description: string | null; - id: number; - node_id: string; - state: string; - context: string; + 'simple-commit-status': { + description: string | null + id: number + node_id: string + state: string + context: string /** Format: uri */ - target_url: string; - required?: boolean | null; + target_url: string + required?: boolean | null /** Format: uri */ - avatar_url: string | null; + avatar_url: string | null /** Format: uri */ - url: string; + url: string /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - }; + updated_at: string + } /** * Combined Commit Status * @description Combined Commit Status */ - "combined-commit-status": { - state: string; - statuses: components["schemas"]["simple-commit-status"][]; - sha: string; - total_count: number; - repository: components["schemas"]["minimal-repository"]; + 'combined-commit-status': { + state: string + statuses: components['schemas']['simple-commit-status'][] + sha: string + total_count: number + repository: components['schemas']['minimal-repository'] /** Format: uri */ - commit_url: string; + commit_url: string /** Format: uri */ - url: string; - }; + url: string + } /** * Status * @description The status of a commit. */ status: { - url: string; - avatar_url: string | null; - id: number; - node_id: string; - state: string; - description: string; - target_url: string; - context: string; - created_at: string; - updated_at: string; - creator: components["schemas"]["nullable-simple-user"]; - }; + url: string + avatar_url: string | null + id: number + node_id: string + state: string + description: string + target_url: string + context: string + created_at: string + updated_at: string + creator: components['schemas']['nullable-simple-user'] + } /** * Code Of Conduct Simple * @description Code of Conduct Simple */ - "nullable-code-of-conduct-simple": { + 'nullable-code-of-conduct-simple': { /** * Format: uri * @example https://api.github.com/repos/github/docs/community/code_of_conduct */ - url: string; + url: string /** @example citizen_code_of_conduct */ - key: string; + key: string /** @example Citizen Code of Conduct */ - name: string; + name: string /** * Format: uri * @example https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md */ - html_url: string | null; - } | null; + html_url: string | null + } | null /** Community Health File */ - "nullable-community-health-file": { + 'nullable-community-health-file': { /** Format: uri */ - url: string; + url: string /** Format: uri */ - html_url: string; - } | null; + html_url: string + } | null /** * Community Profile * @description Community Profile */ - "community-profile": { + 'community-profile': { /** @example 100 */ - health_percentage: number; + health_percentage: number /** @example My first repository on GitHub! */ - description: string | null; + description: string | null /** @example example.com */ - documentation: string | null; + documentation: string | null files: { - code_of_conduct: components["schemas"]["nullable-code-of-conduct-simple"]; - code_of_conduct_file: components["schemas"]["nullable-community-health-file"]; - license: components["schemas"]["nullable-license-simple"]; - contributing: components["schemas"]["nullable-community-health-file"]; - readme: components["schemas"]["nullable-community-health-file"]; - issue_template: components["schemas"]["nullable-community-health-file"]; - pull_request_template: components["schemas"]["nullable-community-health-file"]; - }; + code_of_conduct: components['schemas']['nullable-code-of-conduct-simple'] + code_of_conduct_file: components['schemas']['nullable-community-health-file'] + license: components['schemas']['nullable-license-simple'] + contributing: components['schemas']['nullable-community-health-file'] + readme: components['schemas']['nullable-community-health-file'] + issue_template: components['schemas']['nullable-community-health-file'] + pull_request_template: components['schemas']['nullable-community-health-file'] + } /** * Format: date-time * @example 2017-02-28T19:09:29Z */ - updated_at: string | null; + updated_at: string | null /** @example true */ - content_reports_enabled?: boolean; - }; + content_reports_enabled?: boolean + } /** * Commit Comparison * @description Commit Comparison */ - "commit-comparison": { + 'commit-comparison': { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/compare/master...topic */ - url: string; + url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/compare/master...topic */ - html_url: string; + html_url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17 */ - permalink_url: string; + permalink_url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/compare/master...topic.diff */ - diff_url: string; + diff_url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/compare/master...topic.patch */ - patch_url: string; - base_commit: components["schemas"]["commit"]; - merge_base_commit: components["schemas"]["commit"]; + patch_url: string + base_commit: components['schemas']['commit'] + merge_base_commit: components['schemas']['commit'] /** * @example ahead * @enum {string} */ - status: "diverged" | "ahead" | "behind" | "identical"; + status: 'diverged' | 'ahead' | 'behind' | 'identical' /** @example 4 */ - ahead_by: number; + ahead_by: number /** @example 5 */ - behind_by: number; + behind_by: number /** @example 6 */ - total_commits: number; - commits: components["schemas"]["commit"][]; - files?: components["schemas"]["diff-entry"][]; - }; + total_commits: number + commits: components['schemas']['commit'][] + files?: components['schemas']['diff-entry'][] + } /** * Content Tree * @description Content Tree */ - "content-tree": { - type: string; - size: number; - name: string; - path: string; - sha: string; + 'content-tree': { + type: string + size: number + name: string + path: string + sha: string /** Format: uri */ - url: string; + url: string /** Format: uri */ - git_url: string | null; + git_url: string | null /** Format: uri */ - html_url: string | null; + html_url: string | null /** Format: uri */ - download_url: string | null; + download_url: string | null entries?: { - type: string; - size: number; - name: string; - path: string; - content?: string; - sha: string; + type: string + size: number + name: string + path: string + content?: string + sha: string /** Format: uri */ - url: string; + url: string /** Format: uri */ - git_url: string | null; + git_url: string | null /** Format: uri */ - html_url: string | null; + html_url: string | null /** Format: uri */ - download_url: string | null; + download_url: string | null _links: { /** Format: uri */ - git: string | null; + git: string | null /** Format: uri */ - html: string | null; + html: string | null /** Format: uri */ - self: string; - }; - }[]; + self: string + } + }[] _links: { /** Format: uri */ - git: string | null; + git: string | null /** Format: uri */ - html: string | null; + html: string | null /** Format: uri */ - self: string; - }; + self: string + } } & { - content: unknown; - encoding: unknown; - }; + content: unknown + encoding: unknown + } /** * Content Directory * @description A list of directory items */ - "content-directory": { - type: string; - size: number; - name: string; - path: string; - content?: string; - sha: string; + 'content-directory': { + type: string + size: number + name: string + path: string + content?: string + sha: string /** Format: uri */ - url: string; + url: string /** Format: uri */ - git_url: string | null; + git_url: string | null /** Format: uri */ - html_url: string | null; + html_url: string | null /** Format: uri */ - download_url: string | null; + download_url: string | null _links: { /** Format: uri */ - git: string | null; + git: string | null /** Format: uri */ - html: string | null; + html: string | null /** Format: uri */ - self: string; - }; - }[]; + self: string + } + }[] /** * Content File * @description Content File */ - "content-file": { - type: string; - encoding: string; - size: number; - name: string; - path: string; - content: string; - sha: string; + 'content-file': { + type: string + encoding: string + size: number + name: string + path: string + content: string + sha: string /** Format: uri */ - url: string; + url: string /** Format: uri */ - git_url: string | null; + git_url: string | null /** Format: uri */ - html_url: string | null; + html_url: string | null /** Format: uri */ - download_url: string | null; + download_url: string | null _links: { /** Format: uri */ - git: string | null; + git: string | null /** Format: uri */ - html: string | null; + html: string | null /** Format: uri */ - self: string; - }; + self: string + } /** @example "actual/actual.md" */ - target?: string; + target?: string /** @example "git://example.com/defunkt/dotjs.git" */ - submodule_git_url?: string; - }; + submodule_git_url?: string + } /** * Symlink Content * @description An object describing a symlink */ - "content-symlink": { - type: string; - target: string; - size: number; - name: string; - path: string; - sha: string; + 'content-symlink': { + type: string + target: string + size: number + name: string + path: string + sha: string /** Format: uri */ - url: string; + url: string /** Format: uri */ - git_url: string | null; + git_url: string | null /** Format: uri */ - html_url: string | null; + html_url: string | null /** Format: uri */ - download_url: string | null; + download_url: string | null _links: { /** Format: uri */ - git: string | null; + git: string | null /** Format: uri */ - html: string | null; + html: string | null /** Format: uri */ - self: string; - }; - }; + self: string + } + } /** * Symlink Content * @description An object describing a symlink */ - "content-submodule": { - type: string; + 'content-submodule': { + type: string /** Format: uri */ - submodule_git_url: string; - size: number; - name: string; - path: string; - sha: string; + submodule_git_url: string + size: number + name: string + path: string + sha: string /** Format: uri */ - url: string; + url: string /** Format: uri */ - git_url: string | null; + git_url: string | null /** Format: uri */ - html_url: string | null; + html_url: string | null /** Format: uri */ - download_url: string | null; + download_url: string | null _links: { /** Format: uri */ - git: string | null; + git: string | null /** Format: uri */ - html: string | null; + html: string | null /** Format: uri */ - self: string; - }; - }; + self: string + } + } /** * File Commit * @description File Commit */ - "file-commit": { + 'file-commit': { content: { - name?: string; - path?: string; - sha?: string; - size?: number; - url?: string; - html_url?: string; - git_url?: string; - download_url?: string; - type?: string; + name?: string + path?: string + sha?: string + size?: number + url?: string + html_url?: string + git_url?: string + download_url?: string + type?: string _links?: { - self?: string; - git?: string; - html?: string; - }; - } | null; + self?: string + git?: string + html?: string + } + } | null commit: { - sha?: string; - node_id?: string; - url?: string; - html_url?: string; + sha?: string + node_id?: string + url?: string + html_url?: string author?: { - date?: string; - name?: string; - email?: string; - }; + date?: string + name?: string + email?: string + } committer?: { - date?: string; - name?: string; - email?: string; - }; - message?: string; + date?: string + name?: string + email?: string + } + message?: string tree?: { - url?: string; - sha?: string; - }; + url?: string + sha?: string + } parents?: { - url?: string; - html_url?: string; - sha?: string; - }[]; + url?: string + html_url?: string + sha?: string + }[] verification?: { - verified?: boolean; - reason?: string; - signature?: string | null; - payload?: string | null; - }; - }; - }; + verified?: boolean + reason?: string + signature?: string | null + payload?: string | null + } + } + } /** * Contributor * @description Contributor */ contributor: { - login?: string; - id?: number; - node_id?: string; + login?: string + id?: number + node_id?: string /** Format: uri */ - avatar_url?: string; - gravatar_id?: string | null; + avatar_url?: string + gravatar_id?: string | null /** Format: uri */ - url?: string; + url?: string /** Format: uri */ - html_url?: string; + html_url?: string /** Format: uri */ - followers_url?: string; - following_url?: string; - gists_url?: string; - starred_url?: string; + followers_url?: string + following_url?: string + gists_url?: string + starred_url?: string /** Format: uri */ - subscriptions_url?: string; + subscriptions_url?: string /** Format: uri */ - organizations_url?: string; + organizations_url?: string /** Format: uri */ - repos_url?: string; - events_url?: string; + repos_url?: string + events_url?: string /** Format: uri */ - received_events_url?: string; - type: string; - site_admin?: boolean; - contributions: number; - email?: string; - name?: string; - }; + received_events_url?: string + type: string + site_admin?: boolean + contributions: number + email?: string + name?: string + } /** * Dependabot Secret * @description Set secrets for Dependabot. */ - "dependabot-secret": { + 'dependabot-secret': { /** * @description The name of the secret. * @example MY_ARTIFACTORY_PASSWORD */ - name: string; + name: string /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - }; + updated_at: string + } /** * Deployment Status * @description The status of a deployment. */ - "deployment-status": { + 'deployment-status': { /** * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/42/statuses/1 */ - url: string; + url: string /** @example 1 */ - id: number; + id: number /** @example MDE2OkRlcGxveW1lbnRTdGF0dXMx */ - node_id: string; + node_id: string /** * @description The state of the status. * @example success * @enum {string} */ - state: "error" | "failure" | "inactive" | "pending" | "success" | "queued" | "in_progress"; - creator: components["schemas"]["nullable-simple-user"]; + state: 'error' | 'failure' | 'inactive' | 'pending' | 'success' | 'queued' | 'in_progress' + creator: components['schemas']['nullable-simple-user'] /** * @description A short description of the status. * @example Deployment finished successfully. */ - description: string; + description: string /** * @description The environment of the deployment that the status is for. * @example production */ - environment?: string; + environment?: string /** * Format: uri * @description Deprecated: the URL to associate with this status. * @example https://example.com/deployment/42/output */ - target_url: string; + target_url: string /** * Format: date-time * @example 2012-07-20T01:19:13Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2012-07-20T01:19:13Z */ - updated_at: string; + updated_at: string /** * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/42 */ - deployment_url: string; + deployment_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/example */ - repository_url: string; + repository_url: string /** * Format: uri * @description The URL for accessing your environment. * @example https://staging.example.com/ */ - environment_url?: string; + environment_url?: string /** * Format: uri * @description The URL to associate with this status. * @example https://example.com/deployment/42/output */ - log_url?: string; - performed_via_github_app?: components["schemas"]["nullable-integration"]; - }; + log_url?: string + performed_via_github_app?: components['schemas']['nullable-integration'] + } /** * @description The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days). * @example 30 */ - "wait-timer": number; + 'wait-timer': number /** @description The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. */ deployment_branch_policy: { /** @description Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`. */ - protected_branches: boolean; + protected_branches: boolean /** @description Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`. */ - custom_branch_policies: boolean; - } | null; + custom_branch_policies: boolean + } | null /** * Environment * @description Details of a deployment environment @@ -13802,97 +13790,97 @@ export interface components { * @description The id of the environment. * @example 56780428 */ - id: number; + id: number /** @example MDExOkVudmlyb25tZW50NTY3ODA0Mjg= */ - node_id: string; + node_id: string /** * @description The name of the environment. * @example staging */ - name: string; + name: string /** @example https://api.github.com/repos/github/hello-world/environments/staging */ - url: string; + url: string /** @example https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging */ - html_url: string; + html_url: string /** * Format: date-time * @description The time that the environment was created, in ISO 8601 format. * @example 2020-11-23T22:00:40Z */ - created_at: string; + created_at: string /** * Format: date-time * @description The time that the environment was last updated, in ISO 8601 format. * @example 2020-11-23T22:00:40Z */ - updated_at: string; + updated_at: string protection_rules?: (Partial<{ /** @example 3515 */ - id: number; + id: number /** @example MDQ6R2F0ZTM1MTU= */ - node_id: string; + node_id: string /** @example wait_timer */ - type: string; - wait_timer?: components["schemas"]["wait-timer"]; + type: string + wait_timer?: components['schemas']['wait-timer'] }> & Partial<{ /** @example 3755 */ - id: number; + id: number /** @example MDQ6R2F0ZTM3NTU= */ - node_id: string; + node_id: string /** @example required_reviewers */ - type: string; + type: string /** @description The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */ reviewers?: { - type?: components["schemas"]["deployment-reviewer-type"]; - reviewer?: Partial & Partial; - }[]; + type?: components['schemas']['deployment-reviewer-type'] + reviewer?: Partial & Partial + }[] }> & Partial<{ /** @example 3515 */ - id: number; + id: number /** @example MDQ6R2F0ZTM1MTU= */ - node_id: string; + node_id: string /** @example branch_policy */ - type: string; - }>)[]; - deployment_branch_policy?: components["schemas"]["deployment_branch_policy"]; - }; + type: string + }>)[] + deployment_branch_policy?: components['schemas']['deployment_branch_policy'] + } /** * Short Blob * @description Short Blob */ - "short-blob": { - url: string; - sha: string; - }; + 'short-blob': { + url: string + sha: string + } /** * Blob * @description Blob */ blob: { - content: string; - encoding: string; + content: string + encoding: string /** Format: uri */ - url: string; - sha: string; - size: number | null; - node_id: string; - highlighted_content?: string; - }; + url: string + sha: string + size: number | null + node_id: string + highlighted_content?: string + } /** * Git Commit * @description Low-level Git commit operations within a repository */ - "git-commit": { + 'git-commit': { /** * @description SHA for the commit * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - sha: string; - node_id: string; + sha: string + node_id: string /** Format: uri */ - url: string; + url: string /** @description Identifying information for the git-user */ author: { /** @@ -13900,18 +13888,18 @@ export interface components { * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 */ - date: string; + date: string /** * @description Git email address of the user * @example monalisa.octocat@example.com */ - email: string; + email: string /** * @description Name of the git user * @example Monalisa Octocat */ - name: string; - }; + name: string + } /** @description Identifying information for the git-user */ committer: { /** @@ -13919,343 +13907,343 @@ export interface components { * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 */ - date: string; + date: string /** * @description Git email address of the user * @example monalisa.octocat@example.com */ - email: string; + email: string /** * @description Name of the git user * @example Monalisa Octocat */ - name: string; - }; + name: string + } /** * @description Message describing the purpose of the commit * @example Fix #42 */ - message: string; + message: string tree: { /** * @description SHA for the commit * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - sha: string; + sha: string /** Format: uri */ - url: string; - }; + url: string + } parents: { /** * @description SHA for the commit * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - sha: string; + sha: string /** Format: uri */ - url: string; + url: string /** Format: uri */ - html_url: string; - }[]; + html_url: string + }[] verification: { - verified: boolean; - reason: string; - signature: string | null; - payload: string | null; - }; + verified: boolean + reason: string + signature: string | null + payload: string | null + } /** Format: uri */ - html_url: string; - }; + html_url: string + } /** * Git Reference * @description Git references within a repository */ - "git-ref": { - ref: string; - node_id: string; + 'git-ref': { + ref: string + node_id: string /** Format: uri */ - url: string; + url: string object: { - type: string; + type: string /** * @description SHA for the reference * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - sha: string; + sha: string /** Format: uri */ - url: string; - }; - }; + url: string + } + } /** * Git Tag * @description Metadata for a Git tag */ - "git-tag": { + 'git-tag': { /** @example MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== */ - node_id: string; + node_id: string /** * @description Name of the tag * @example v0.0.1 */ - tag: string; + tag: string /** @example 940bd336248efae0f9ee5bc7b2d5c985887b16ac */ - sha: string; + sha: string /** * Format: uri * @description URL for the tag * @example https://api.github.com/repositories/42/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac */ - url: string; + url: string /** * @description Message describing the purpose of the tag * @example Initial public release */ - message: string; + message: string tagger: { - date: string; - email: string; - name: string; - }; + date: string + email: string + name: string + } object: { - sha: string; - type: string; + sha: string + type: string /** Format: uri */ - url: string; - }; - verification?: components["schemas"]["verification"]; - }; + url: string + } + verification?: components['schemas']['verification'] + } /** * Git Tree * @description The hierarchy between files in a Git repository. */ - "git-tree": { - sha: string; + 'git-tree': { + sha: string /** Format: uri */ - url: string; - truncated: boolean; + url: string + truncated: boolean /** * @description Objects specifying a tree structure * @example [object Object] */ tree: { /** @example test/file.rb */ - path?: string; + path?: string /** @example 040000 */ - mode?: string; + mode?: string /** @example tree */ - type?: string; + type?: string /** @example 23f6827669e43831def8a7ad935069c8bd418261 */ - sha?: string; + sha?: string /** @example 12 */ - size?: number; + size?: number /** @example https://api.github.com/repos/owner-482f3203ecf01f67e9deb18e/BBB_Private_Repo/git/blobs/23f6827669e43831def8a7ad935069c8bd418261 */ - url?: string; - }[]; - }; + url?: string + }[] + } /** Hook Response */ - "hook-response": { - code: number | null; - status: string | null; - message: string | null; - }; + 'hook-response': { + code: number | null + status: string | null + message: string | null + } /** * Webhook * @description Webhooks for repositories. */ hook: { - type: string; + type: string /** * @description Unique identifier of the webhook. * @example 42 */ - id: number; + id: number /** * @description The name of a valid service, use 'web' for a webhook. * @example web */ - name: string; + name: string /** * @description Determines whether the hook is actually triggered on pushes. * @example true */ - active: boolean; + active: boolean /** * @description Determines what events the hook is triggered for. Default: ['push']. * @example push,pull_request */ - events: string[]; + events: string[] config: { /** @example "foo@bar.com" */ - email?: string; + email?: string /** @example "foo" */ - password?: string; + password?: string /** @example "roomer" */ - room?: string; + room?: string /** @example "foo" */ - subdomain?: string; - url?: components["schemas"]["webhook-config-url"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - content_type?: components["schemas"]["webhook-config-content-type"]; + subdomain?: string + url?: components['schemas']['webhook-config-url'] + insecure_ssl?: components['schemas']['webhook-config-insecure-ssl'] + content_type?: components['schemas']['webhook-config-content-type'] /** @example "sha256" */ - digest?: string; - secret?: components["schemas"]["webhook-config-secret"]; + digest?: string + secret?: components['schemas']['webhook-config-secret'] /** @example "abc" */ - token?: string; - }; + token?: string + } /** * Format: date-time * @example 2011-09-06T20:39:23Z */ - updated_at: string; + updated_at: string /** * Format: date-time * @example 2011-09-06T17:26:27Z */ - created_at: string; + created_at: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1 */ - url: string; + url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/test */ - test_url: string; + test_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/pings */ - ping_url: string; + ping_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries */ - deliveries_url?: string; - last_response: components["schemas"]["hook-response"]; - }; + deliveries_url?: string + last_response: components['schemas']['hook-response'] + } /** * Import * @description A repository import from an external source. */ import: { - vcs: string | null; - use_lfs?: boolean; + vcs: string | null + use_lfs?: boolean /** @description The URL of the originating repository. */ - vcs_url: string; - svc_root?: string; - tfvc_project?: string; + vcs_url: string + svc_root?: string + tfvc_project?: string /** @enum {string} */ status: - | "auth" - | "error" - | "none" - | "detecting" - | "choose" - | "auth_failed" - | "importing" - | "mapping" - | "waiting_to_push" - | "pushing" - | "complete" - | "setup" - | "unknown" - | "detection_found_multiple" - | "detection_found_nothing" - | "detection_needs_auth"; - status_text?: string | null; - failed_step?: string | null; - error_message?: string | null; - import_percent?: number | null; - commit_count?: number | null; - push_percent?: number | null; - has_large_files?: boolean; - large_files_size?: number; - large_files_count?: number; + | 'auth' + | 'error' + | 'none' + | 'detecting' + | 'choose' + | 'auth_failed' + | 'importing' + | 'mapping' + | 'waiting_to_push' + | 'pushing' + | 'complete' + | 'setup' + | 'unknown' + | 'detection_found_multiple' + | 'detection_found_nothing' + | 'detection_needs_auth' + status_text?: string | null + failed_step?: string | null + error_message?: string | null + import_percent?: number | null + commit_count?: number | null + push_percent?: number | null + has_large_files?: boolean + large_files_size?: number + large_files_count?: number project_choices?: { - vcs?: string; - tfvc_project?: string; - human_name?: string; - }[]; - message?: string; - authors_count?: number | null; + vcs?: string + tfvc_project?: string + human_name?: string + }[] + message?: string + authors_count?: number | null /** Format: uri */ - url: string; + url: string /** Format: uri */ - html_url: string; + html_url: string /** Format: uri */ - authors_url: string; + authors_url: string /** Format: uri */ - repository_url: string; - svn_root?: string; - }; + repository_url: string + svn_root?: string + } /** * Porter Author * @description Porter Author */ - "porter-author": { - id: number; - remote_id: string; - remote_name: string; - email: string; - name: string; + 'porter-author': { + id: number + remote_id: string + remote_name: string + email: string + name: string /** Format: uri */ - url: string; + url: string /** Format: uri */ - import_url: string; - }; + import_url: string + } /** * Porter Large File * @description Porter Large File */ - "porter-large-file": { - ref_name: string; - path: string; - oid: string; - size: number; - }; + 'porter-large-file': { + ref_name: string + path: string + oid: string + size: number + } /** * Issue * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. */ - "nullable-issue": { - id: number; - node_id: string; + 'nullable-issue': { + id: number + node_id: string /** * Format: uri * @description URL for the issue * @example https://api.github.com/repositories/42/issues/1 */ - url: string; + url: string /** Format: uri */ - repository_url: string; - labels_url: string; + repository_url: string + labels_url: string /** Format: uri */ - comments_url: string; + comments_url: string /** Format: uri */ - events_url: string; + events_url: string /** Format: uri */ - html_url: string; + html_url: string /** * @description Number uniquely identifying the issue within its repository * @example 42 */ - number: number; + number: number /** * @description State of the issue; either 'open' or 'closed' * @example open */ - state: string; + state: string /** * @description Title of the issue * @example Widget creation fails in Safari on OS X 10.8 */ - title: string; + title: string /** * @description Contents of the issue * @example It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug? */ - body?: string | null; - user: components["schemas"]["nullable-simple-user"]; + body?: string | null + user: components['schemas']['nullable-simple-user'] /** * @description Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository * @example bug,registration @@ -14264,456 +14252,456 @@ export interface components { | string | { /** Format: int64 */ - id?: number; - node_id?: string; + id?: number + node_id?: string /** Format: uri */ - url?: string; - name?: string; - description?: string | null; - color?: string | null; - default?: boolean; + url?: string + name?: string + description?: string | null + color?: string | null + default?: boolean } - )[]; - assignee: components["schemas"]["nullable-simple-user"]; - assignees?: components["schemas"]["simple-user"][] | null; - milestone: components["schemas"]["nullable-milestone"]; - locked: boolean; - active_lock_reason?: string | null; - comments: number; + )[] + assignee: components['schemas']['nullable-simple-user'] + assignees?: components['schemas']['simple-user'][] | null + milestone: components['schemas']['nullable-milestone'] + locked: boolean + active_lock_reason?: string | null + comments: number pull_request?: { /** Format: date-time */ - merged_at?: string | null; + merged_at?: string | null /** Format: uri */ - diff_url: string | null; + diff_url: string | null /** Format: uri */ - html_url: string | null; + html_url: string | null /** Format: uri */ - patch_url: string | null; + patch_url: string | null /** Format: uri */ - url: string | null; - }; + url: string | null + } /** Format: date-time */ - closed_at: string | null; + closed_at: string | null /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - draft?: boolean; - closed_by?: components["schemas"]["nullable-simple-user"]; - body_html?: string; - body_text?: string; + updated_at: string + draft?: boolean + closed_by?: components['schemas']['nullable-simple-user'] + body_html?: string + body_text?: string /** Format: uri */ - timeline_url?: string; - repository?: components["schemas"]["repository"]; - performed_via_github_app?: components["schemas"]["nullable-integration"]; - author_association: components["schemas"]["author_association"]; - reactions?: components["schemas"]["reaction-rollup"]; - } | null; + timeline_url?: string + repository?: components['schemas']['repository'] + performed_via_github_app?: components['schemas']['nullable-integration'] + author_association: components['schemas']['author_association'] + reactions?: components['schemas']['reaction-rollup'] + } | null /** * Issue Event Label * @description Issue Event Label */ - "issue-event-label": { - name: string | null; - color: string | null; - }; + 'issue-event-label': { + name: string | null + color: string | null + } /** Issue Event Dismissed Review */ - "issue-event-dismissed-review": { - state: string; - review_id: number; - dismissal_message: string | null; - dismissal_commit_id?: string | null; - }; + 'issue-event-dismissed-review': { + state: string + review_id: number + dismissal_message: string | null + dismissal_commit_id?: string | null + } /** * Issue Event Milestone * @description Issue Event Milestone */ - "issue-event-milestone": { - title: string; - }; + 'issue-event-milestone': { + title: string + } /** * Issue Event Project Card * @description Issue Event Project Card */ - "issue-event-project-card": { + 'issue-event-project-card': { /** Format: uri */ - url: string; - id: number; + url: string + id: number /** Format: uri */ - project_url: string; - project_id: number; - column_name: string; - previous_column_name?: string; - }; + project_url: string + project_id: number + column_name: string + previous_column_name?: string + } /** * Issue Event Rename * @description Issue Event Rename */ - "issue-event-rename": { - from: string; - to: string; - }; + 'issue-event-rename': { + from: string + to: string + } /** * Issue Event * @description Issue Event */ - "issue-event": { + 'issue-event': { /** @example 1 */ - id: number; + id: number /** @example MDEwOklzc3VlRXZlbnQx */ - node_id: string; + node_id: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/events/1 */ - url: string; - actor: components["schemas"]["nullable-simple-user"]; + url: string + actor: components['schemas']['nullable-simple-user'] /** @example closed */ - event: string; + event: string /** @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */ - commit_id: string | null; + commit_id: string | null /** @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e */ - commit_url: string | null; + commit_url: string | null /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - created_at: string; - issue?: components["schemas"]["nullable-issue"]; - label?: components["schemas"]["issue-event-label"]; - assignee?: components["schemas"]["nullable-simple-user"]; - assigner?: components["schemas"]["nullable-simple-user"]; - review_requester?: components["schemas"]["nullable-simple-user"]; - requested_reviewer?: components["schemas"]["nullable-simple-user"]; - requested_team?: components["schemas"]["team"]; - dismissed_review?: components["schemas"]["issue-event-dismissed-review"]; - milestone?: components["schemas"]["issue-event-milestone"]; - project_card?: components["schemas"]["issue-event-project-card"]; - rename?: components["schemas"]["issue-event-rename"]; - author_association?: components["schemas"]["author_association"]; - lock_reason?: string | null; - performed_via_github_app?: components["schemas"]["nullable-integration"]; - }; + created_at: string + issue?: components['schemas']['nullable-issue'] + label?: components['schemas']['issue-event-label'] + assignee?: components['schemas']['nullable-simple-user'] + assigner?: components['schemas']['nullable-simple-user'] + review_requester?: components['schemas']['nullable-simple-user'] + requested_reviewer?: components['schemas']['nullable-simple-user'] + requested_team?: components['schemas']['team'] + dismissed_review?: components['schemas']['issue-event-dismissed-review'] + milestone?: components['schemas']['issue-event-milestone'] + project_card?: components['schemas']['issue-event-project-card'] + rename?: components['schemas']['issue-event-rename'] + author_association?: components['schemas']['author_association'] + lock_reason?: string | null + performed_via_github_app?: components['schemas']['nullable-integration'] + } /** * Labeled Issue Event * @description Labeled Issue Event */ - "labeled-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; + 'labeled-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] label: { - name: string; - color: string; - }; - }; + name: string + color: string + } + } /** * Unlabeled Issue Event * @description Unlabeled Issue Event */ - "unlabeled-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; + 'unlabeled-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] label: { - name: string; - color: string; - }; - }; + name: string + color: string + } + } /** * Assigned Issue Event * @description Assigned Issue Event */ - "assigned-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["integration"]; - assignee: components["schemas"]["simple-user"]; - assigner: components["schemas"]["simple-user"]; - }; + 'assigned-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['integration'] + assignee: components['schemas']['simple-user'] + assigner: components['schemas']['simple-user'] + } /** * Unassigned Issue Event * @description Unassigned Issue Event */ - "unassigned-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; - assignee: components["schemas"]["simple-user"]; - assigner: components["schemas"]["simple-user"]; - }; + 'unassigned-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] + assignee: components['schemas']['simple-user'] + assigner: components['schemas']['simple-user'] + } /** * Milestoned Issue Event * @description Milestoned Issue Event */ - "milestoned-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; + 'milestoned-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] milestone: { - title: string; - }; - }; + title: string + } + } /** * Demilestoned Issue Event * @description Demilestoned Issue Event */ - "demilestoned-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; + 'demilestoned-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] milestone: { - title: string; - }; - }; + title: string + } + } /** * Renamed Issue Event * @description Renamed Issue Event */ - "renamed-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; + 'renamed-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] rename: { - from: string; - to: string; - }; - }; + from: string + to: string + } + } /** * Review Requested Issue Event * @description Review Requested Issue Event */ - "review-requested-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; - review_requester: components["schemas"]["simple-user"]; - requested_team?: components["schemas"]["team"]; - requested_reviewer?: components["schemas"]["simple-user"]; - }; + 'review-requested-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] + review_requester: components['schemas']['simple-user'] + requested_team?: components['schemas']['team'] + requested_reviewer?: components['schemas']['simple-user'] + } /** * Review Request Removed Issue Event * @description Review Request Removed Issue Event */ - "review-request-removed-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; - review_requester: components["schemas"]["simple-user"]; - requested_team?: components["schemas"]["team"]; - requested_reviewer?: components["schemas"]["simple-user"]; - }; + 'review-request-removed-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] + review_requester: components['schemas']['simple-user'] + requested_team?: components['schemas']['team'] + requested_reviewer?: components['schemas']['simple-user'] + } /** * Review Dismissed Issue Event * @description Review Dismissed Issue Event */ - "review-dismissed-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; + 'review-dismissed-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] dismissed_review: { - state: string; - review_id: number; - dismissal_message: string | null; - dismissal_commit_id?: string; - }; - }; + state: string + review_id: number + dismissal_message: string | null + dismissal_commit_id?: string + } + } /** * Locked Issue Event * @description Locked Issue Event */ - "locked-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; + 'locked-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] /** @example "off-topic" */ - lock_reason: string | null; - }; + lock_reason: string | null + } /** * Added to Project Issue Event * @description Added to Project Issue Event */ - "added-to-project-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; + 'added-to-project-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] project_card?: { - id: number; + id: number /** Format: uri */ - url: string; - project_id: number; + url: string + project_id: number /** Format: uri */ - project_url: string; - column_name: string; - previous_column_name?: string; - }; - }; + project_url: string + column_name: string + previous_column_name?: string + } + } /** * Moved Column in Project Issue Event * @description Moved Column in Project Issue Event */ - "moved-column-in-project-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; + 'moved-column-in-project-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] project_card?: { - id: number; + id: number /** Format: uri */ - url: string; - project_id: number; + url: string + project_id: number /** Format: uri */ - project_url: string; - column_name: string; - previous_column_name?: string; - }; - }; + project_url: string + column_name: string + previous_column_name?: string + } + } /** * Removed from Project Issue Event * @description Removed from Project Issue Event */ - "removed-from-project-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; + 'removed-from-project-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] project_card?: { - id: number; + id: number /** Format: uri */ - url: string; - project_id: number; + url: string + project_id: number /** Format: uri */ - project_url: string; - column_name: string; - previous_column_name?: string; - }; - }; + project_url: string + column_name: string + previous_column_name?: string + } + } /** * Converted Note to Issue Issue Event * @description Converted Note to Issue Issue Event */ - "converted-note-to-issue-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["integration"]; + 'converted-note-to-issue-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['integration'] project_card?: { - id: number; + id: number /** Format: uri */ - url: string; - project_id: number; + url: string + project_id: number /** Format: uri */ - project_url: string; - column_name: string; - previous_column_name?: string; - }; - }; + project_url: string + column_name: string + previous_column_name?: string + } + } /** * Issue Event for Issue * @description Issue Event for Issue */ - "issue-event-for-issue": Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial; + 'issue-event-for-issue': Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial /** * Label * @description Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -14723,105 +14711,105 @@ export interface components { * Format: int64 * @example 208045946 */ - id: number; + id: number /** @example MDU6TGFiZWwyMDgwNDU5NDY= */ - node_id: string; + node_id: string /** * Format: uri * @description URL for the label * @example https://api.github.com/repositories/42/labels/bug */ - url: string; + url: string /** * @description The name of the label. * @example bug */ - name: string; + name: string /** @example Something isn't working */ - description: string | null; + description: string | null /** * @description 6-character hex code, without the leading #, identifying the color * @example FFFFFF */ - color: string; + color: string /** @example true */ - default: boolean; - }; + default: boolean + } /** * Timeline Comment Event * @description Timeline Comment Event */ - "timeline-comment-event": { - event: string; - actor: components["schemas"]["simple-user"]; + 'timeline-comment-event': { + event: string + actor: components['schemas']['simple-user'] /** * @description Unique identifier of the issue comment * @example 42 */ - id: number; - node_id: string; + id: number + node_id: string /** * Format: uri * @description URL for the issue comment * @example https://api.github.com/repositories/42/issues/comments/1 */ - url: string; + url: string /** * @description Contents of the issue comment * @example What version of Safari were you using when you observed this bug? */ - body?: string; - body_text?: string; - body_html?: string; + body?: string + body_text?: string + body_html?: string /** Format: uri */ - html_url: string; - user: components["schemas"]["simple-user"]; + html_url: string + user: components['schemas']['simple-user'] /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - updated_at: string; + updated_at: string /** Format: uri */ - issue_url: string; - author_association: components["schemas"]["author_association"]; - performed_via_github_app?: components["schemas"]["nullable-integration"]; - reactions?: components["schemas"]["reaction-rollup"]; - }; + issue_url: string + author_association: components['schemas']['author_association'] + performed_via_github_app?: components['schemas']['nullable-integration'] + reactions?: components['schemas']['reaction-rollup'] + } /** * Timeline Cross Referenced Event * @description Timeline Cross Referenced Event */ - "timeline-cross-referenced-event": { - event: string; - actor?: components["schemas"]["simple-user"]; + 'timeline-cross-referenced-event': { + event: string + actor?: components['schemas']['simple-user'] /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; + updated_at: string source: { - type?: string; - issue?: components["schemas"]["issue"]; - }; - }; + type?: string + issue?: components['schemas']['issue'] + } + } /** * Timeline Committed Event * @description Timeline Committed Event */ - "timeline-committed-event": { - event?: string; + 'timeline-committed-event': { + event?: string /** * @description SHA for the commit * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - sha: string; - node_id: string; + sha: string + node_id: string /** Format: uri */ - url: string; + url: string /** @description Identifying information for the git-user */ author: { /** @@ -14829,18 +14817,18 @@ export interface components { * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 */ - date: string; + date: string /** * @description Git email address of the user * @example monalisa.octocat@example.com */ - email: string; + email: string /** * @description Name of the git user * @example Monalisa Octocat */ - name: string; - }; + name: string + } /** @description Identifying information for the git-user */ committer: { /** @@ -14848,386 +14836,386 @@ export interface components { * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 */ - date: string; + date: string /** * @description Git email address of the user * @example monalisa.octocat@example.com */ - email: string; + email: string /** * @description Name of the git user * @example Monalisa Octocat */ - name: string; - }; + name: string + } /** * @description Message describing the purpose of the commit * @example Fix #42 */ - message: string; + message: string tree: { /** * @description SHA for the commit * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - sha: string; + sha: string /** Format: uri */ - url: string; - }; + url: string + } parents: { /** * @description SHA for the commit * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - sha: string; + sha: string /** Format: uri */ - url: string; + url: string /** Format: uri */ - html_url: string; - }[]; + html_url: string + }[] verification: { - verified: boolean; - reason: string; - signature: string | null; - payload: string | null; - }; + verified: boolean + reason: string + signature: string | null + payload: string | null + } /** Format: uri */ - html_url: string; - }; + html_url: string + } /** * Timeline Reviewed Event * @description Timeline Reviewed Event */ - "timeline-reviewed-event": { - event: string; + 'timeline-reviewed-event': { + event: string /** * @description Unique identifier of the review * @example 42 */ - id: number; + id: number /** @example MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= */ - node_id: string; - user: components["schemas"]["simple-user"]; + node_id: string + user: components['schemas']['simple-user'] /** * @description The text of the review. * @example This looks great. */ - body: string | null; + body: string | null /** @example CHANGES_REQUESTED */ - state: string; + state: string /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/12 */ - pull_request_url: string; + pull_request_url: string _links: { html: { - href: string; - }; + href: string + } pull_request: { - href: string; - }; - }; + href: string + } + } /** Format: date-time */ - submitted_at?: string; + submitted_at?: string /** * @description A commit SHA for the review. * @example 54bb654c9e6025347f57900a4a5c2313a96b8035 */ - commit_id: string; - body_html?: string; - body_text?: string; - author_association: components["schemas"]["author_association"]; - }; + commit_id: string + body_html?: string + body_text?: string + author_association: components['schemas']['author_association'] + } /** * Pull Request Review Comment * @description Pull Request Review Comments are comments on a portion of the Pull Request's diff. */ - "pull-request-review-comment": { + 'pull-request-review-comment': { /** * @description URL for the pull request review comment * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ - url: string; + url: string /** * @description The ID of the pull request review to which the comment belongs. * @example 42 */ - pull_request_review_id: number | null; + pull_request_review_id: number | null /** * @description The ID of the pull request review comment. * @example 1 */ - id: number; + id: number /** * @description The node ID of the pull request review comment. * @example MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw */ - node_id: string; + node_id: string /** * @description The diff of the line that the comment refers to. * @example @@ -16,33 +16,40 @@ public class Connection : IConnection... */ - diff_hunk: string; + diff_hunk: string /** * @description The relative path of the file to which the comment applies. * @example config/database.yaml */ - path: string; + path: string /** * @description The line index in the diff to which the comment applies. * @example 1 */ - position: number; + position: number /** * @description The index of the original line in the diff to which the comment applies. * @example 4 */ - original_position: number; + original_position: number /** * @description The SHA of the commit to which the comment applies. * @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */ - commit_id: string; + commit_id: string /** * @description The SHA of the original commit to which the comment applies. * @example 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 */ - original_commit_id: string; + original_commit_id: string /** * @description The comment ID to reply to. * @example 8 */ - in_reply_to_id?: number; - user: components["schemas"]["simple-user"]; + in_reply_to_id?: number + user: components['schemas']['simple-user'] /** * @description The text of the comment. * @example We should probably include a check for null values here. */ - body: string; + body: string /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - updated_at: string; + updated_at: string /** * Format: uri * @description HTML URL for the pull request review comment. * @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 */ - html_url: string; + html_url: string /** * Format: uri * @description URL for the pull request that the review comment belongs to. * @example https://api.github.com/repos/octocat/Hello-World/pulls/1 */ - pull_request_url: string; - author_association: components["schemas"]["author_association"]; + pull_request_url: string + author_association: components['schemas']['author_association'] _links: { self: { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ - href: string; - }; + href: string + } html: { /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 */ - href: string; - }; + href: string + } pull_request: { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1 */ - href: string; - }; - }; + href: string + } + } /** * @description The first line of the range for a multi-line comment. * @example 2 */ - start_line?: number | null; + start_line?: number | null /** * @description The first line of the range for a multi-line comment. * @example 2 */ - original_start_line?: number | null; + original_start_line?: number | null /** * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} */ - start_side?: ("LEFT" | "RIGHT") | null; + start_side?: ('LEFT' | 'RIGHT') | null /** * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment * @example 2 */ - line?: number; + line?: number /** * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment * @example 2 */ - original_line?: number; + original_line?: number /** * @description The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment * @default RIGHT * @enum {string} */ - side?: "LEFT" | "RIGHT"; - reactions?: components["schemas"]["reaction-rollup"]; + side?: 'LEFT' | 'RIGHT' + reactions?: components['schemas']['reaction-rollup'] /** @example "

comment body

" */ - body_html?: string; + body_html?: string /** @example "comment body" */ - body_text?: string; - }; + body_text?: string + } /** * Timeline Line Commented Event * @description Timeline Line Commented Event */ - "timeline-line-commented-event": { - event?: string; - node_id?: string; - comments?: components["schemas"]["pull-request-review-comment"][]; - }; + 'timeline-line-commented-event': { + event?: string + node_id?: string + comments?: components['schemas']['pull-request-review-comment'][] + } /** * Timeline Commit Commented Event * @description Timeline Commit Commented Event */ - "timeline-commit-commented-event": { - event?: string; - node_id?: string; - commit_id?: string; - comments?: components["schemas"]["commit-comment"][]; - }; + 'timeline-commit-commented-event': { + event?: string + node_id?: string + commit_id?: string + comments?: components['schemas']['commit-comment'][] + } /** * Timeline Assigned Issue Event * @description Timeline Assigned Issue Event */ - "timeline-assigned-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; - assignee: components["schemas"]["simple-user"]; - }; + 'timeline-assigned-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] + assignee: components['schemas']['simple-user'] + } /** * Timeline Unassigned Issue Event * @description Timeline Unassigned Issue Event */ - "timeline-unassigned-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; - assignee: components["schemas"]["simple-user"]; - }; + 'timeline-unassigned-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] + assignee: components['schemas']['simple-user'] + } /** * Timeline Event * @description Timeline Event */ - "timeline-issue-events": Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial; + 'timeline-issue-events': Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial /** * Deploy Key * @description An SSH key granting access to a single repository. */ - "deploy-key": { - id: number; - key: string; - url: string; - title: string; - verified: boolean; - created_at: string; - read_only: boolean; - }; + 'deploy-key': { + id: number + key: string + url: string + title: string + verified: boolean + created_at: string + read_only: boolean + } /** * Language * @description Language */ - language: { [key: string]: number }; + language: { [key: string]: number } /** * License Content * @description License Content */ - "license-content": { - name: string; - path: string; - sha: string; - size: number; + 'license-content': { + name: string + path: string + sha: string + size: number /** Format: uri */ - url: string; + url: string /** Format: uri */ - html_url: string | null; + html_url: string | null /** Format: uri */ - git_url: string | null; + git_url: string | null /** Format: uri */ - download_url: string | null; - type: string; - content: string; - encoding: string; + download_url: string | null + type: string + content: string + encoding: string _links: { /** Format: uri */ - git: string | null; + git: string | null /** Format: uri */ - html: string | null; + html: string | null /** Format: uri */ - self: string; - }; - license: components["schemas"]["nullable-license-simple"]; - }; + self: string + } + license: components['schemas']['nullable-license-simple'] + } /** * Merged upstream * @description Results of a successful merge upstream request */ - "merged-upstream": { - message?: string; + 'merged-upstream': { + message?: string /** @enum {string} */ - merge_type?: "merge" | "fast-forward" | "none"; - base_branch?: string; - }; + merge_type?: 'merge' | 'fast-forward' | 'none' + base_branch?: string + } /** * Milestone * @description A collection of related issues and pull requests. @@ -15237,100 +15225,100 @@ export interface components { * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1 */ - url: string; + url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/milestones/v1.0 */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1/labels */ - labels_url: string; + labels_url: string /** @example 1002604 */ - id: number; + id: number /** @example MDk6TWlsZXN0b25lMTAwMjYwNA== */ - node_id: string; + node_id: string /** * @description The number of the milestone. * @example 42 */ - number: number; + number: number /** * @description The state of the milestone. * @default open * @example open * @enum {string} */ - state: "open" | "closed"; + state: 'open' | 'closed' /** * @description The title of the milestone. * @example v1.0 */ - title: string; + title: string /** @example Tracking milestone for version 1.0 */ - description: string | null; - creator: components["schemas"]["nullable-simple-user"]; + description: string | null + creator: components['schemas']['nullable-simple-user'] /** @example 4 */ - open_issues: number; + open_issues: number /** @example 8 */ - closed_issues: number; + closed_issues: number /** * Format: date-time * @example 2011-04-10T20:09:31Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2014-03-03T18:58:10Z */ - updated_at: string; + updated_at: string /** * Format: date-time * @example 2013-02-12T13:22:01Z */ - closed_at: string | null; + closed_at: string | null /** * Format: date-time * @example 2012-10-09T23:39:01Z */ - due_on: string | null; - }; + due_on: string | null + } /** Pages Source Hash */ - "pages-source-hash": { - branch: string; - path: string; - }; + 'pages-source-hash': { + branch: string + path: string + } /** Pages Https Certificate */ - "pages-https-certificate": { + 'pages-https-certificate': { /** * @example approved * @enum {string} */ state: - | "new" - | "authorization_created" - | "authorization_pending" - | "authorized" - | "authorization_revoked" - | "issued" - | "uploaded" - | "approved" - | "errored" - | "bad_authz" - | "destroy_pending" - | "dns_changed"; + | 'new' + | 'authorization_created' + | 'authorization_pending' + | 'authorized' + | 'authorization_revoked' + | 'issued' + | 'uploaded' + | 'approved' + | 'errored' + | 'bad_authz' + | 'destroy_pending' + | 'dns_changed' /** @example Certificate is approved */ - description: string; + description: string /** * @description Array of the domain set and its alternate name (if it is configured) * @example example.com,www.example.com */ - domains: string[]; + domains: string[] /** Format: date */ - expires_at?: string; - }; + expires_at?: string + } /** * GitHub Pages * @description The configuration for GitHub Pages for a repository. @@ -15341,1362 +15329,1362 @@ export interface components { * @description The API address for accessing this Page resource. * @example https://api.github.com/repos/github/hello-world/pages */ - url: string; + url: string /** * @description The status of the most recent build of the Page. * @example built * @enum {string|null} */ - status: ("built" | "building" | "errored") | null; + status: ('built' | 'building' | 'errored') | null /** * @description The Pages site's custom domain * @example example.com */ - cname: string | null; + cname: string | null /** * @description The state if the domain is verified * @example pending * @enum {string|null} */ - protected_domain_state?: ("pending" | "verified" | "unverified") | null; + protected_domain_state?: ('pending' | 'verified' | 'unverified') | null /** * Format: date-time * @description The timestamp when a pending domain becomes unverified. */ - pending_domain_unverified_at?: string | null; + pending_domain_unverified_at?: string | null /** @description Whether the Page has a custom 404 page. */ - custom_404: boolean; + custom_404: boolean /** * Format: uri * @description The web address the Page can be accessed from. * @example https://example.com */ - html_url?: string; - source?: components["schemas"]["pages-source-hash"]; + html_url?: string + source?: components['schemas']['pages-source-hash'] /** * @description Whether the GitHub Pages site is publicly visible. If set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. * @example true */ - public: boolean; - https_certificate?: components["schemas"]["pages-https-certificate"]; + public: boolean + https_certificate?: components['schemas']['pages-https-certificate'] /** * @description Whether https is enabled on the domain * @example true */ - https_enforced?: boolean; - }; + https_enforced?: boolean + } /** * Page Build * @description Page Build */ - "page-build": { + 'page-build': { /** Format: uri */ - url: string; - status: string; + url: string + status: string error: { - message: string | null; - }; - pusher: components["schemas"]["nullable-simple-user"]; - commit: string; - duration: number; + message: string | null + } + pusher: components['schemas']['nullable-simple-user'] + commit: string + duration: number /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - }; + updated_at: string + } /** * Page Build Status * @description Page Build Status */ - "page-build-status": { + 'page-build-status': { /** * Format: uri * @example https://api.github.com/repos/github/hello-world/pages/builds/latest */ - url: string; + url: string /** @example queued */ - status: string; - }; + status: string + } /** * Pages Health Check Status * @description Pages Health Check Status */ - "pages-health-check": { + 'pages-health-check': { domain?: { - host?: string; - uri?: string; - nameservers?: string; - dns_resolves?: boolean; - is_proxied?: boolean | null; - is_cloudflare_ip?: boolean | null; - is_fastly_ip?: boolean | null; - is_old_ip_address?: boolean | null; - is_a_record?: boolean | null; - has_cname_record?: boolean | null; - has_mx_records_present?: boolean | null; - is_valid_domain?: boolean; - is_apex_domain?: boolean; - should_be_a_record?: boolean | null; - is_cname_to_github_user_domain?: boolean | null; - is_cname_to_pages_dot_github_dot_com?: boolean | null; - is_cname_to_fastly?: boolean | null; - is_pointed_to_github_pages_ip?: boolean | null; - is_non_github_pages_ip_present?: boolean | null; - is_pages_domain?: boolean; - is_served_by_pages?: boolean | null; - is_valid?: boolean; - reason?: string | null; - responds_to_https?: boolean; - enforces_https?: boolean; - https_error?: string | null; - is_https_eligible?: boolean | null; - caa_error?: string | null; - }; + host?: string + uri?: string + nameservers?: string + dns_resolves?: boolean + is_proxied?: boolean | null + is_cloudflare_ip?: boolean | null + is_fastly_ip?: boolean | null + is_old_ip_address?: boolean | null + is_a_record?: boolean | null + has_cname_record?: boolean | null + has_mx_records_present?: boolean | null + is_valid_domain?: boolean + is_apex_domain?: boolean + should_be_a_record?: boolean | null + is_cname_to_github_user_domain?: boolean | null + is_cname_to_pages_dot_github_dot_com?: boolean | null + is_cname_to_fastly?: boolean | null + is_pointed_to_github_pages_ip?: boolean | null + is_non_github_pages_ip_present?: boolean | null + is_pages_domain?: boolean + is_served_by_pages?: boolean | null + is_valid?: boolean + reason?: string | null + responds_to_https?: boolean + enforces_https?: boolean + https_error?: string | null + is_https_eligible?: boolean | null + caa_error?: string | null + } alt_domain?: { - host?: string; - uri?: string; - nameservers?: string; - dns_resolves?: boolean; - is_proxied?: boolean | null; - is_cloudflare_ip?: boolean | null; - is_fastly_ip?: boolean | null; - is_old_ip_address?: boolean | null; - is_a_record?: boolean | null; - has_cname_record?: boolean | null; - has_mx_records_present?: boolean | null; - is_valid_domain?: boolean; - is_apex_domain?: boolean; - should_be_a_record?: boolean | null; - is_cname_to_github_user_domain?: boolean | null; - is_cname_to_pages_dot_github_dot_com?: boolean | null; - is_cname_to_fastly?: boolean | null; - is_pointed_to_github_pages_ip?: boolean | null; - is_non_github_pages_ip_present?: boolean | null; - is_pages_domain?: boolean; - is_served_by_pages?: boolean | null; - is_valid?: boolean; - reason?: string | null; - responds_to_https?: boolean; - enforces_https?: boolean; - https_error?: string | null; - is_https_eligible?: boolean | null; - caa_error?: string | null; - } | null; - }; + host?: string + uri?: string + nameservers?: string + dns_resolves?: boolean + is_proxied?: boolean | null + is_cloudflare_ip?: boolean | null + is_fastly_ip?: boolean | null + is_old_ip_address?: boolean | null + is_a_record?: boolean | null + has_cname_record?: boolean | null + has_mx_records_present?: boolean | null + is_valid_domain?: boolean + is_apex_domain?: boolean + should_be_a_record?: boolean | null + is_cname_to_github_user_domain?: boolean | null + is_cname_to_pages_dot_github_dot_com?: boolean | null + is_cname_to_fastly?: boolean | null + is_pointed_to_github_pages_ip?: boolean | null + is_non_github_pages_ip_present?: boolean | null + is_pages_domain?: boolean + is_served_by_pages?: boolean | null + is_valid?: boolean + reason?: string | null + responds_to_https?: boolean + enforces_https?: boolean + https_error?: string | null + is_https_eligible?: boolean | null + caa_error?: string | null + } | null + } /** * Team Simple * @description Groups of organization members that gives permissions on specified repositories. */ - "team-simple": { + 'team-simple': { /** * @description Unique identifier of the team * @example 1 */ - id: number; + id: number /** @example MDQ6VGVhbTE= */ - node_id: string; + node_id: string /** * Format: uri * @description URL for the team * @example https://api.github.com/organizations/1/team/1 */ - url: string; + url: string /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - members_url: string; + members_url: string /** * @description Name of the team * @example Justice League */ - name: string; + name: string /** * @description Description of the team * @example A great team. */ - description: string | null; + description: string | null /** * @description Permission that the team will have for its repositories * @example admin */ - permission: string; + permission: string /** * @description The level of privacy this team should have * @example closed */ - privacy?: string; + privacy?: string /** * Format: uri * @example https://github.com/orgs/rails/teams/core */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/organizations/1/team/1/repos */ - repositories_url: string; + repositories_url: string /** @example justice-league */ - slug: string; + slug: string /** * @description Distinguished Name (DN) that team maps to within LDAP environment * @example uid=example,ou=users,dc=github,dc=com */ - ldap_dn?: string; - }; + ldap_dn?: string + } /** * Pull Request * @description Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary. */ - "pull-request": { + 'pull-request': { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ - url: string; + url: string /** @example 1 */ - id: number; + id: number /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ - node_id: string; + node_id: string /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347 */ - html_url: string; + html_url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.diff */ - diff_url: string; + diff_url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.patch */ - patch_url: string; + patch_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 */ - issue_url: string; + issue_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits */ - commits_url: string; + commits_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments */ - review_comments_url: string; + review_comments_url: string /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} */ - review_comment_url: string; + review_comment_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347/comments */ - comments_url: string; + comments_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e */ - statuses_url: string; + statuses_url: string /** * @description Number uniquely identifying the pull request within its repository. * @example 42 */ - number: number; + number: number /** * @description State of this Pull Request. Either `open` or `closed`. * @example open * @enum {string} */ - state: "open" | "closed"; + state: 'open' | 'closed' /** @example true */ - locked: boolean; + locked: boolean /** * @description The title of the pull request. * @example Amazing new feature */ - title: string; - user: components["schemas"]["nullable-simple-user"]; + title: string + user: components['schemas']['nullable-simple-user'] /** @example Please pull these awesome changes */ - body: string | null; + body: string | null labels: { /** Format: int64 */ - id: number; - node_id: string; - url: string; - name: string; - description: string | null; - color: string; - default: boolean; - }[]; - milestone: components["schemas"]["nullable-milestone"]; + id: number + node_id: string + url: string + name: string + description: string | null + color: string + default: boolean + }[] + milestone: components['schemas']['nullable-milestone'] /** @example too heated */ - active_lock_reason?: string | null; + active_lock_reason?: string | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - updated_at: string; + updated_at: string /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - closed_at: string | null; + closed_at: string | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - merged_at: string | null; + merged_at: string | null /** @example e5bd3914e2e596debea16f433f57875b5b90bcd6 */ - merge_commit_sha: string | null; - assignee: components["schemas"]["nullable-simple-user"]; - assignees?: components["schemas"]["simple-user"][] | null; - requested_reviewers?: components["schemas"]["simple-user"][] | null; - requested_teams?: components["schemas"]["team-simple"][] | null; + merge_commit_sha: string | null + assignee: components['schemas']['nullable-simple-user'] + assignees?: components['schemas']['simple-user'][] | null + requested_reviewers?: components['schemas']['simple-user'][] | null + requested_teams?: components['schemas']['team-simple'][] | null head: { - label: string; - ref: string; + label: string + ref: string repo: { - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; + archive_url: string + assignees_url: string + blobs_url: string + branches_url: string + collaborators_url: string + comments_url: string + commits_url: string + compare_url: string + contents_url: string /** Format: uri */ - contributors_url: string; + contributors_url: string /** Format: uri */ - deployments_url: string; - description: string | null; + deployments_url: string + description: string | null /** Format: uri */ - downloads_url: string; + downloads_url: string /** Format: uri */ - events_url: string; - fork: boolean; + events_url: string + fork: boolean /** Format: uri */ - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; + forks_url: string + full_name: string + git_commits_url: string + git_refs_url: string + git_tags_url: string /** Format: uri */ - hooks_url: string; + hooks_url: string /** Format: uri */ - html_url: string; - id: number; - node_id: string; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; + html_url: string + id: number + node_id: string + issue_comment_url: string + issue_events_url: string + issues_url: string + keys_url: string + labels_url: string /** Format: uri */ - languages_url: string; + languages_url: string /** Format: uri */ - merges_url: string; - milestones_url: string; - name: string; - notifications_url: string; + merges_url: string + milestones_url: string + name: string + notifications_url: string owner: { /** Format: uri */ - avatar_url: string; - events_url: string; + avatar_url: string + events_url: string /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; + followers_url: string + following_url: string + gists_url: string + gravatar_id: string | null /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; + html_url: string + id: number + node_id: string + login: string /** Format: uri */ - organizations_url: string; + organizations_url: string /** Format: uri */ - received_events_url: string; + received_events_url: string /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; + repos_url: string + site_admin: boolean + starred_url: string /** Format: uri */ - subscriptions_url: string; - type: string; + subscriptions_url: string + type: string /** Format: uri */ - url: string; - }; - private: boolean; - pulls_url: string; - releases_url: string; + url: string + } + private: boolean + pulls_url: string + releases_url: string /** Format: uri */ - stargazers_url: string; - statuses_url: string; + stargazers_url: string + statuses_url: string /** Format: uri */ - subscribers_url: string; + subscribers_url: string /** Format: uri */ - subscription_url: string; + subscription_url: string /** Format: uri */ - tags_url: string; + tags_url: string /** Format: uri */ - teams_url: string; - trees_url: string; + teams_url: string + trees_url: string /** Format: uri */ - url: string; - clone_url: string; - default_branch: string; - forks: number; - forks_count: number; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_projects: boolean; - has_wiki: boolean; - has_pages: boolean; + url: string + clone_url: string + default_branch: string + forks: number + forks_count: number + git_url: string + has_downloads: boolean + has_issues: boolean + has_projects: boolean + has_wiki: boolean + has_pages: boolean /** Format: uri */ - homepage: string | null; - language: string | null; - master_branch?: string; - archived: boolean; - disabled: boolean; + homepage: string | null + language: string | null + master_branch?: string + archived: boolean + disabled: boolean /** @description The repository visibility: public, private, or internal. */ - visibility?: string; + visibility?: string /** Format: uri */ - mirror_url: string | null; - open_issues: number; - open_issues_count: number; + mirror_url: string | null + open_issues: number + open_issues_count: number permissions?: { - admin: boolean; - maintain?: boolean; - push: boolean; - triage?: boolean; - pull: boolean; - }; - temp_clone_token?: string; - allow_merge_commit?: boolean; - allow_squash_merge?: boolean; - allow_rebase_merge?: boolean; + admin: boolean + maintain?: boolean + push: boolean + triage?: boolean + pull: boolean + } + temp_clone_token?: string + allow_merge_commit?: boolean + allow_squash_merge?: boolean + allow_rebase_merge?: boolean license: { - key: string; - name: string; + key: string + name: string /** Format: uri */ - url: string | null; - spdx_id: string | null; - node_id: string; - } | null; + url: string | null + spdx_id: string | null + node_id: string + } | null /** Format: date-time */ - pushed_at: string; - size: number; - ssh_url: string; - stargazers_count: number; + pushed_at: string + size: number + ssh_url: string + stargazers_count: number /** Format: uri */ - svn_url: string; - topics?: string[]; - watchers: number; - watchers_count: number; + svn_url: string + topics?: string[] + watchers: number + watchers_count: number /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - allow_forking?: boolean; - is_template?: boolean; - } | null; - sha: string; + updated_at: string + allow_forking?: boolean + is_template?: boolean + } | null + sha: string user: { /** Format: uri */ - avatar_url: string; - events_url: string; + avatar_url: string + events_url: string /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; + followers_url: string + following_url: string + gists_url: string + gravatar_id: string | null /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; + html_url: string + id: number + node_id: string + login: string /** Format: uri */ - organizations_url: string; + organizations_url: string /** Format: uri */ - received_events_url: string; + received_events_url: string /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; + repos_url: string + site_admin: boolean + starred_url: string /** Format: uri */ - subscriptions_url: string; - type: string; + subscriptions_url: string + type: string /** Format: uri */ - url: string; - }; - }; + url: string + } + } base: { - label: string; - ref: string; + label: string + ref: string repo: { - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; + archive_url: string + assignees_url: string + blobs_url: string + branches_url: string + collaborators_url: string + comments_url: string + commits_url: string + compare_url: string + contents_url: string /** Format: uri */ - contributors_url: string; + contributors_url: string /** Format: uri */ - deployments_url: string; - description: string | null; + deployments_url: string + description: string | null /** Format: uri */ - downloads_url: string; + downloads_url: string /** Format: uri */ - events_url: string; - fork: boolean; + events_url: string + fork: boolean /** Format: uri */ - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; + forks_url: string + full_name: string + git_commits_url: string + git_refs_url: string + git_tags_url: string /** Format: uri */ - hooks_url: string; + hooks_url: string /** Format: uri */ - html_url: string; - id: number; - is_template?: boolean; - node_id: string; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; + html_url: string + id: number + is_template?: boolean + node_id: string + issue_comment_url: string + issue_events_url: string + issues_url: string + keys_url: string + labels_url: string /** Format: uri */ - languages_url: string; + languages_url: string /** Format: uri */ - merges_url: string; - milestones_url: string; - name: string; - notifications_url: string; + merges_url: string + milestones_url: string + name: string + notifications_url: string owner: { /** Format: uri */ - avatar_url: string; - events_url: string; + avatar_url: string + events_url: string /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; + followers_url: string + following_url: string + gists_url: string + gravatar_id: string | null /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; + html_url: string + id: number + node_id: string + login: string /** Format: uri */ - organizations_url: string; + organizations_url: string /** Format: uri */ - received_events_url: string; + received_events_url: string /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; + repos_url: string + site_admin: boolean + starred_url: string /** Format: uri */ - subscriptions_url: string; - type: string; + subscriptions_url: string + type: string /** Format: uri */ - url: string; - }; - private: boolean; - pulls_url: string; - releases_url: string; + url: string + } + private: boolean + pulls_url: string + releases_url: string /** Format: uri */ - stargazers_url: string; - statuses_url: string; + stargazers_url: string + statuses_url: string /** Format: uri */ - subscribers_url: string; + subscribers_url: string /** Format: uri */ - subscription_url: string; + subscription_url: string /** Format: uri */ - tags_url: string; + tags_url: string /** Format: uri */ - teams_url: string; - trees_url: string; + teams_url: string + trees_url: string /** Format: uri */ - url: string; - clone_url: string; - default_branch: string; - forks: number; - forks_count: number; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_projects: boolean; - has_wiki: boolean; - has_pages: boolean; + url: string + clone_url: string + default_branch: string + forks: number + forks_count: number + git_url: string + has_downloads: boolean + has_issues: boolean + has_projects: boolean + has_wiki: boolean + has_pages: boolean /** Format: uri */ - homepage: string | null; - language: string | null; - master_branch?: string; - archived: boolean; - disabled: boolean; + homepage: string | null + language: string | null + master_branch?: string + archived: boolean + disabled: boolean /** @description The repository visibility: public, private, or internal. */ - visibility?: string; + visibility?: string /** Format: uri */ - mirror_url: string | null; - open_issues: number; - open_issues_count: number; + mirror_url: string | null + open_issues: number + open_issues_count: number permissions?: { - admin: boolean; - maintain?: boolean; - push: boolean; - triage?: boolean; - pull: boolean; - }; - temp_clone_token?: string; - allow_merge_commit?: boolean; - allow_squash_merge?: boolean; - allow_rebase_merge?: boolean; - license: components["schemas"]["nullable-license-simple"]; + admin: boolean + maintain?: boolean + push: boolean + triage?: boolean + pull: boolean + } + temp_clone_token?: string + allow_merge_commit?: boolean + allow_squash_merge?: boolean + allow_rebase_merge?: boolean + license: components['schemas']['nullable-license-simple'] /** Format: date-time */ - pushed_at: string; - size: number; - ssh_url: string; - stargazers_count: number; + pushed_at: string + size: number + ssh_url: string + stargazers_count: number /** Format: uri */ - svn_url: string; - topics?: string[]; - watchers: number; - watchers_count: number; + svn_url: string + topics?: string[] + watchers: number + watchers_count: number /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - allow_forking?: boolean; - }; - sha: string; + updated_at: string + allow_forking?: boolean + } + sha: string user: { /** Format: uri */ - avatar_url: string; - events_url: string; + avatar_url: string + events_url: string /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; + followers_url: string + following_url: string + gists_url: string + gravatar_id: string | null /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; + html_url: string + id: number + node_id: string + login: string /** Format: uri */ - organizations_url: string; + organizations_url: string /** Format: uri */ - received_events_url: string; + received_events_url: string /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; + repos_url: string + site_admin: boolean + starred_url: string /** Format: uri */ - subscriptions_url: string; - type: string; + subscriptions_url: string + type: string /** Format: uri */ - url: string; - }; - }; + url: string + } + } _links: { - comments: components["schemas"]["link"]; - commits: components["schemas"]["link"]; - statuses: components["schemas"]["link"]; - html: components["schemas"]["link"]; - issue: components["schemas"]["link"]; - review_comments: components["schemas"]["link"]; - review_comment: components["schemas"]["link"]; - self: components["schemas"]["link"]; - }; - author_association: components["schemas"]["author_association"]; - auto_merge: components["schemas"]["auto_merge"]; + comments: components['schemas']['link'] + commits: components['schemas']['link'] + statuses: components['schemas']['link'] + html: components['schemas']['link'] + issue: components['schemas']['link'] + review_comments: components['schemas']['link'] + review_comment: components['schemas']['link'] + self: components['schemas']['link'] + } + author_association: components['schemas']['author_association'] + auto_merge: components['schemas']['auto_merge'] /** @description Indicates whether or not the pull request is a draft. */ - draft?: boolean; - merged: boolean; + draft?: boolean + merged: boolean /** @example true */ - mergeable: boolean | null; + mergeable: boolean | null /** @example true */ - rebaseable?: boolean | null; + rebaseable?: boolean | null /** @example clean */ - mergeable_state: string; - merged_by: components["schemas"]["nullable-simple-user"]; + mergeable_state: string + merged_by: components['schemas']['nullable-simple-user'] /** @example 10 */ - comments: number; - review_comments: number; + comments: number + review_comments: number /** * @description Indicates whether maintainers can modify the pull request. * @example true */ - maintainer_can_modify: boolean; + maintainer_can_modify: boolean /** @example 3 */ - commits: number; + commits: number /** @example 100 */ - additions: number; + additions: number /** @example 3 */ - deletions: number; + deletions: number /** @example 5 */ - changed_files: number; - }; + changed_files: number + } /** * Pull Request Merge Result * @description Pull Request Merge Result */ - "pull-request-merge-result": { - sha: string; - merged: boolean; - message: string; - }; + 'pull-request-merge-result': { + sha: string + merged: boolean + message: string + } /** * Pull Request Review Request * @description Pull Request Review Request */ - "pull-request-review-request": { - users: components["schemas"]["simple-user"][]; - teams: components["schemas"]["team"][]; - }; + 'pull-request-review-request': { + users: components['schemas']['simple-user'][] + teams: components['schemas']['team'][] + } /** * Pull Request Review * @description Pull Request Reviews are reviews on pull requests. */ - "pull-request-review": { + 'pull-request-review': { /** * @description Unique identifier of the review * @example 42 */ - id: number; + id: number /** @example MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= */ - node_id: string; - user: components["schemas"]["nullable-simple-user"]; + node_id: string + user: components['schemas']['nullable-simple-user'] /** * @description The text of the review. * @example This looks great. */ - body: string; + body: string /** @example CHANGES_REQUESTED */ - state: string; + state: string /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/12 */ - pull_request_url: string; + pull_request_url: string _links: { html: { - href: string; - }; + href: string + } pull_request: { - href: string; - }; - }; + href: string + } + } /** Format: date-time */ - submitted_at?: string; + submitted_at?: string /** * @description A commit SHA for the review. * @example 54bb654c9e6025347f57900a4a5c2313a96b8035 */ - commit_id: string; - body_html?: string; - body_text?: string; - author_association: components["schemas"]["author_association"]; - }; + commit_id: string + body_html?: string + body_text?: string + author_association: components['schemas']['author_association'] + } /** * Legacy Review Comment * @description Legacy Review Comment */ - "review-comment": { + 'review-comment': { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ - url: string; + url: string /** @example 42 */ - pull_request_review_id: number | null; + pull_request_review_id: number | null /** @example 10 */ - id: number; + id: number /** @example MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw */ - node_id: string; + node_id: string /** @example @@ -16,33 +16,40 @@ public class Connection : IConnection... */ - diff_hunk: string; + diff_hunk: string /** @example file1.txt */ - path: string; + path: string /** @example 1 */ - position: number | null; + position: number | null /** @example 4 */ - original_position: number; + original_position: number /** @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */ - commit_id: string; + commit_id: string /** @example 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 */ - original_commit_id: string; + original_commit_id: string /** @example 8 */ - in_reply_to_id?: number; - user: components["schemas"]["nullable-simple-user"]; + in_reply_to_id?: number + user: components['schemas']['nullable-simple-user'] /** @example Great stuff */ - body: string; + body: string /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - updated_at: string; + updated_at: string /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1 */ - pull_request_url: string; - author_association: components["schemas"]["author_association"]; + pull_request_url: string + author_association: components['schemas']['author_association'] _links: { - self: components["schemas"]["link"]; - html: components["schemas"]["link"]; - pull_request: components["schemas"]["link"]; - }; - body_text?: string; - body_html?: string; - reactions?: components["schemas"]["reaction-rollup"]; + self: components['schemas']['link'] + html: components['schemas']['link'] + pull_request: components['schemas']['link'] + } + body_text?: string + body_html?: string + reactions?: components['schemas']['reaction-rollup'] /** * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string} */ - side?: "LEFT" | "RIGHT"; + side?: 'LEFT' | 'RIGHT' /** * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} */ - start_side?: ("LEFT" | "RIGHT") | null; + start_side?: ('LEFT' | 'RIGHT') | null /** * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment * @example 2 */ - line?: number; + line?: number /** * @description The original line of the blob to which the comment applies. The last line of the range for a multi-line comment * @example 2 */ - original_line?: number; + original_line?: number /** * @description The first line of the range for a multi-line comment. * @example 2 */ - start_line?: number | null; + start_line?: number | null /** * @description The original first line of the range for a multi-line comment. * @example 2 */ - original_start_line?: number | null; - }; + original_start_line?: number | null + } /** * Release Asset * @description Data related to a release. */ - "release-asset": { + 'release-asset': { /** Format: uri */ - url: string; + url: string /** Format: uri */ - browser_download_url: string; - id: number; - node_id: string; + browser_download_url: string + id: number + node_id: string /** * @description The file name of the asset. * @example Team Environment */ - name: string; - label: string | null; + name: string + label: string | null /** * @description State of the release asset. * @enum {string} */ - state: "uploaded" | "open"; - content_type: string; - size: number; - download_count: number; + state: 'uploaded' | 'open' + content_type: string + size: number + download_count: number /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - uploader: components["schemas"]["nullable-simple-user"]; - }; + updated_at: string + uploader: components['schemas']['nullable-simple-user'] + } /** * Release * @description A release. */ release: { /** Format: uri */ - url: string; + url: string /** Format: uri */ - html_url: string; + html_url: string /** Format: uri */ - assets_url: string; - upload_url: string; + assets_url: string + upload_url: string /** Format: uri */ - tarball_url: string | null; + tarball_url: string | null /** Format: uri */ - zipball_url: string | null; - id: number; - node_id: string; + zipball_url: string | null + id: number + node_id: string /** * @description The name of the tag. * @example v1.0.0 */ - tag_name: string; + tag_name: string /** * @description Specifies the commitish value that determines where the Git tag is created from. * @example master */ - target_commitish: string; - name: string | null; - body?: string | null; + target_commitish: string + name: string | null + body?: string | null /** @description true to create a draft (unpublished) release, false to create a published one. */ - draft: boolean; + draft: boolean /** @description Whether to identify the release as a prerelease or a full release. */ - prerelease: boolean; + prerelease: boolean /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - published_at: string | null; - author: components["schemas"]["simple-user"]; - assets: components["schemas"]["release-asset"][]; - body_html?: string; - body_text?: string; - mentions_count?: number; + published_at: string | null + author: components['schemas']['simple-user'] + assets: components['schemas']['release-asset'][] + body_html?: string + body_text?: string + mentions_count?: number /** * Format: uri * @description The URL of the release discussion. */ - discussion_url?: string; - reactions?: components["schemas"]["reaction-rollup"]; - }; + discussion_url?: string + reactions?: components['schemas']['reaction-rollup'] + } /** * Generated Release Notes Content * @description Generated name and body describing a release */ - "release-notes-content": { + 'release-notes-content': { /** * @description The generated name of the release * @example Release v1.0.0 is now available! */ - name: string; + name: string /** @description The generated body describing the contents of the release supporting markdown formatting */ - body: string; - }; - "secret-scanning-alert": { - number?: components["schemas"]["alert-number"]; - created_at?: components["schemas"]["alert-created-at"]; - url?: components["schemas"]["alert-url"]; - html_url?: components["schemas"]["alert-html-url"]; + body: string + } + 'secret-scanning-alert': { + number?: components['schemas']['alert-number'] + created_at?: components['schemas']['alert-created-at'] + url?: components['schemas']['alert-url'] + html_url?: components['schemas']['alert-html-url'] /** * Format: uri * @description The REST API URL of the code locations for this alert. */ - locations_url?: string; - state?: components["schemas"]["secret-scanning-alert-state"]; - resolution?: components["schemas"]["secret-scanning-alert-resolution"]; + locations_url?: string + state?: components['schemas']['secret-scanning-alert-state'] + resolution?: components['schemas']['secret-scanning-alert-resolution'] /** * Format: date-time * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - resolved_at?: string | null; - resolved_by?: components["schemas"]["nullable-simple-user"]; + resolved_at?: string | null + resolved_by?: components['schemas']['nullable-simple-user'] /** @description The type of secret that secret scanning detected. */ - secret_type?: string; + secret_type?: string /** @description The secret that was detected. */ - secret?: string; - }; + secret?: string + } /** @description Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. */ - "secret-scanning-location-commit": { + 'secret-scanning-location-commit': { /** * @description The file path in the repository * @example /example/secrets.txt */ - path: string; + path: string /** @description Line number at which the secret starts in the file */ - start_line: number; + start_line: number /** @description Line number at which the secret ends in the file */ - end_line: number; + end_line: number /** @description The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII */ - start_column: number; + start_column: number /** @description The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII */ - end_column: number; + end_column: number /** * @description SHA-1 hash ID of the associated blob * @example af5626b4a114abcb82d63db7c8082c3c4756e51b */ - blob_sha: string; + blob_sha: string /** @description The API URL to get the associated blob resource */ - blob_url: string; + blob_url: string /** * @description SHA-1 hash ID of the associated commit * @example af5626b4a114abcb82d63db7c8082c3c4756e51b */ - commit_sha: string; + commit_sha: string /** @description The API URL to get the associated commit resource */ - commit_url: string; - }; - "secret-scanning-location": { + commit_url: string + } + 'secret-scanning-location': { /** * @description The location type. Because secrets may be found in different types of resources (ie. code, comments, issues), this field identifies the type of resource where the secret was found. * @example commit * @enum {string} */ - type: "commit"; - details: components["schemas"]["secret-scanning-location-commit"]; - }; + type: 'commit' + details: components['schemas']['secret-scanning-location-commit'] + } /** * Stargazer * @description Stargazer */ stargazer: { /** Format: date-time */ - starred_at: string; - user: components["schemas"]["nullable-simple-user"]; - }; + starred_at: string + user: components['schemas']['nullable-simple-user'] + } /** * Code Frequency Stat * @description Code Frequency Stat */ - "code-frequency-stat": number[]; + 'code-frequency-stat': number[] /** * Commit Activity * @description Commit Activity */ - "commit-activity": { + 'commit-activity': { /** @example 0,3,26,20,39,1,0 */ - days: number[]; + days: number[] /** @example 89 */ - total: number; + total: number /** @example 1336280400 */ - week: number; - }; + week: number + } /** * Contributor Activity * @description Contributor Activity */ - "contributor-activity": { - author: components["schemas"]["nullable-simple-user"]; + 'contributor-activity': { + author: components['schemas']['nullable-simple-user'] /** @example 135 */ - total: number; + total: number /** @example [object Object] */ weeks: { - w?: number; - a?: number; - d?: number; - c?: number; - }[]; - }; + w?: number + a?: number + d?: number + c?: number + }[] + } /** Participation Stats */ - "participation-stats": { - all: number[]; - owner: number[]; - }; + 'participation-stats': { + all: number[] + owner: number[] + } /** * Repository Invitation * @description Repository invitations let you manage who you collaborate with. */ - "repository-subscription": { + 'repository-subscription': { /** * @description Determines if notifications should be received from this repository. * @example true */ - subscribed: boolean; + subscribed: boolean /** @description Determines if all notifications should be blocked from this repository. */ - ignored: boolean; - reason: string | null; + ignored: boolean + reason: string | null /** * Format: date-time * @example 2012-10-06T21:34:12Z */ - created_at: string; + created_at: string /** * Format: uri * @example https://api.github.com/repos/octocat/example/subscription */ - url: string; + url: string /** * Format: uri * @example https://api.github.com/repos/octocat/example */ - repository_url: string; - }; + repository_url: string + } /** * Tag * @description Tag */ tag: { /** @example v0.1 */ - name: string; + name: string commit: { - sha: string; + sha: string /** Format: uri */ - url: string; - }; + url: string + } /** * Format: uri * @example https://github.com/octocat/Hello-World/zipball/v0.1 */ - zipball_url: string; + zipball_url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/tarball/v0.1 */ - tarball_url: string; - node_id: string; - }; + tarball_url: string + node_id: string + } /** * Topic * @description A topic aggregates entities that are related to a subject. */ topic: { - names: string[]; - }; + names: string[] + } /** Traffic */ traffic: { /** Format: date-time */ - timestamp: string; - uniques: number; - count: number; - }; + timestamp: string + uniques: number + count: number + } /** * Clone Traffic * @description Clone Traffic */ - "clone-traffic": { + 'clone-traffic': { /** @example 173 */ - count: number; + count: number /** @example 128 */ - uniques: number; - clones: components["schemas"]["traffic"][]; - }; + uniques: number + clones: components['schemas']['traffic'][] + } /** * Content Traffic * @description Content Traffic */ - "content-traffic": { + 'content-traffic': { /** @example /github/hubot */ - path: string; + path: string /** @example github/hubot: A customizable life embetterment robot. */ - title: string; + title: string /** @example 3542 */ - count: number; + count: number /** @example 2225 */ - uniques: number; - }; + uniques: number + } /** * Referrer Traffic * @description Referrer Traffic */ - "referrer-traffic": { + 'referrer-traffic': { /** @example Google */ - referrer: string; + referrer: string /** @example 4 */ - count: number; + count: number /** @example 3 */ - uniques: number; - }; + uniques: number + } /** * View Traffic * @description View Traffic */ - "view-traffic": { + 'view-traffic': { /** @example 14850 */ - count: number; + count: number /** @example 3782 */ - uniques: number; - views: components["schemas"]["traffic"][]; - }; - "scim-group-list-enterprise": { - schemas: string[]; - totalResults: number; - itemsPerPage: number; - startIndex: number; + uniques: number + views: components['schemas']['traffic'][] + } + 'scim-group-list-enterprise': { + schemas: string[] + totalResults: number + itemsPerPage: number + startIndex: number Resources: { - schemas: string[]; - id: string; - externalId?: string | null; - displayName?: string; + schemas: string[] + id: string + externalId?: string | null + displayName?: string members?: { - value?: string; - $ref?: string; - display?: string; - }[]; + value?: string + $ref?: string + display?: string + }[] meta?: { - resourceType?: string; - created?: string; - lastModified?: string; - location?: string; - }; - }[]; - }; - "scim-enterprise-group": { - schemas: string[]; - id: string; - externalId?: string | null; - displayName?: string; + resourceType?: string + created?: string + lastModified?: string + location?: string + } + }[] + } + 'scim-enterprise-group': { + schemas: string[] + id: string + externalId?: string | null + displayName?: string members?: { - value?: string; - $ref?: string; - display?: string; - }[]; + value?: string + $ref?: string + display?: string + }[] meta?: { - resourceType?: string; - created?: string; - lastModified?: string; - location?: string; - }; - }; - "scim-user-list-enterprise": { - schemas: string[]; - totalResults: number; - itemsPerPage: number; - startIndex: number; + resourceType?: string + created?: string + lastModified?: string + location?: string + } + } + 'scim-user-list-enterprise': { + schemas: string[] + totalResults: number + itemsPerPage: number + startIndex: number Resources: { - schemas: string[]; - id: string; - externalId?: string; - userName?: string; + schemas: string[] + id: string + externalId?: string + userName?: string name?: { - givenName?: string; - familyName?: string; - }; + givenName?: string + familyName?: string + } emails?: { - value?: string; - primary?: boolean; - type?: string; - }[]; + value?: string + primary?: boolean + type?: string + }[] groups?: { - value?: string; - }[]; - active?: boolean; + value?: string + }[] + active?: boolean meta?: { - resourceType?: string; - created?: string; - lastModified?: string; - location?: string; - }; - }[]; - }; - "scim-enterprise-user": { - schemas: string[]; - id: string; - externalId?: string; - userName?: string; + resourceType?: string + created?: string + lastModified?: string + location?: string + } + }[] + } + 'scim-enterprise-user': { + schemas: string[] + id: string + externalId?: string + userName?: string name?: { - givenName?: string; - familyName?: string; - }; + givenName?: string + familyName?: string + } emails?: { - value?: string; - type?: string; - primary?: boolean; - }[]; + value?: string + type?: string + primary?: boolean + }[] groups?: { - value?: string; - }[]; - active?: boolean; + value?: string + }[] + active?: boolean meta?: { - resourceType?: string; - created?: string; - lastModified?: string; - location?: string; - }; - }; + resourceType?: string + created?: string + lastModified?: string + location?: string + } + } /** * SCIM /Users * @description SCIM /Users provisioning endpoints */ - "scim-user": { + 'scim-user': { /** @description SCIM schema used. */ - schemas: [string, ...string[]]; + schemas: [string, ...string[]] /** * @description Unique identifier of an external identity * @example 1b78eada-9baa-11e6-9eb6-a431576d590e */ - id: string; + id: string /** * @description The ID of the User. * @example a7b0f98395 */ - externalId: string | null; + externalId: string | null /** * @description Configured by the admin. Could be an email, login, or username * @example someone@example.com */ - userName: string | null; + userName: string | null /** * @description The name of the user, suitable for display to end-users * @example Jon Doe */ - displayName?: string | null; + displayName?: string | null /** @example [object Object] */ name: { - givenName: string | null; - familyName: string | null; - formatted?: string | null; - }; + givenName: string | null + familyName: string | null + formatted?: string | null + } /** * @description user emails * @example [object Object],[object Object] */ emails: [ { - value: string; - primary?: boolean; + value: string + primary?: boolean }, ...{ - value: string; - primary?: boolean; - }[] - ]; + value: string + primary?: boolean + }[], + ] /** * @description The active status of the User. * @example true */ - active: boolean; + active: boolean meta: { /** @example User */ - resourceType?: string; + resourceType?: string /** * Format: date-time * @example 2019-01-24T22:45:36.000Z */ - created?: string; + created?: string /** * Format: date-time * @example 2019-01-24T22:45:36.000Z */ - lastModified?: string; + lastModified?: string /** * Format: uri * @example https://api.github.com/scim/v2/organizations/myorg-123abc55141bfd8f/Users/c42772b5-2029-11e9-8543-9264a97dec8d */ - location?: string; - }; + location?: string + } /** @description The ID of the organization. */ - organization_id?: number; + organization_id?: number /** * @description Set of operations to be performed * @example [object Object] @@ -16704,618 +16692,618 @@ export interface components { operations?: [ { /** @enum {string} */ - op: "add" | "remove" | "replace"; - path?: string; - value?: string | { [key: string]: unknown } | unknown[]; + op: 'add' | 'remove' | 'replace' + path?: string + value?: string | { [key: string]: unknown } | unknown[] }, ...{ /** @enum {string} */ - op: "add" | "remove" | "replace"; - path?: string; - value?: string | { [key: string]: unknown } | unknown[]; - }[] - ]; + op: 'add' | 'remove' | 'replace' + path?: string + value?: string | { [key: string]: unknown } | unknown[] + }[], + ] /** @description associated groups */ groups?: { - value?: string; - display?: string; - }[]; - }; + value?: string + display?: string + }[] + } /** * SCIM User List * @description SCIM User List */ - "scim-user-list": { + 'scim-user-list': { /** @description SCIM schema used. */ - schemas: [string, ...string[]]; + schemas: [string, ...string[]] /** @example 3 */ - totalResults: number; + totalResults: number /** @example 10 */ - itemsPerPage: number; + itemsPerPage: number /** @example 1 */ - startIndex: number; - Resources: components["schemas"]["scim-user"][]; - }; + startIndex: number + Resources: components['schemas']['scim-user'][] + } /** Search Result Text Matches */ - "search-result-text-matches": { - object_url?: string; - object_type?: string | null; - property?: string; - fragment?: string; + 'search-result-text-matches': { + object_url?: string + object_type?: string | null + property?: string + fragment?: string matches?: { - text?: string; - indices?: number[]; - }[]; - }[]; + text?: string + indices?: number[] + }[] + }[] /** * Code Search Result Item * @description Code Search Result Item */ - "code-search-result-item": { - name: string; - path: string; - sha: string; + 'code-search-result-item': { + name: string + path: string + sha: string /** Format: uri */ - url: string; + url: string /** Format: uri */ - git_url: string; + git_url: string /** Format: uri */ - html_url: string; - repository: components["schemas"]["minimal-repository"]; - score: number; - file_size?: number; - language?: string | null; + html_url: string + repository: components['schemas']['minimal-repository'] + score: number + file_size?: number + language?: string | null /** Format: date-time */ - last_modified_at?: string; + last_modified_at?: string /** @example 73..77,77..78 */ - line_numbers?: string[]; - text_matches?: components["schemas"]["search-result-text-matches"]; - }; + line_numbers?: string[] + text_matches?: components['schemas']['search-result-text-matches'] + } /** * Commit Search Result Item * @description Commit Search Result Item */ - "commit-search-result-item": { + 'commit-search-result-item': { /** Format: uri */ - url: string; - sha: string; + url: string + sha: string /** Format: uri */ - html_url: string; + html_url: string /** Format: uri */ - comments_url: string; + comments_url: string commit: { author: { - name: string; - email: string; + name: string + email: string /** Format: date-time */ - date: string; - }; - committer: components["schemas"]["nullable-git-user"]; - comment_count: number; - message: string; + date: string + } + committer: components['schemas']['nullable-git-user'] + comment_count: number + message: string tree: { - sha: string; + sha: string /** Format: uri */ - url: string; - }; + url: string + } /** Format: uri */ - url: string; - verification?: components["schemas"]["verification"]; - }; - author: components["schemas"]["nullable-simple-user"]; - committer: components["schemas"]["nullable-git-user"]; + url: string + verification?: components['schemas']['verification'] + } + author: components['schemas']['nullable-simple-user'] + committer: components['schemas']['nullable-git-user'] parents: { - url?: string; - html_url?: string; - sha?: string; - }[]; - repository: components["schemas"]["minimal-repository"]; - score: number; - node_id: string; - text_matches?: components["schemas"]["search-result-text-matches"]; - }; + url?: string + html_url?: string + sha?: string + }[] + repository: components['schemas']['minimal-repository'] + score: number + node_id: string + text_matches?: components['schemas']['search-result-text-matches'] + } /** * Issue Search Result Item * @description Issue Search Result Item */ - "issue-search-result-item": { + 'issue-search-result-item': { /** Format: uri */ - url: string; + url: string /** Format: uri */ - repository_url: string; - labels_url: string; + repository_url: string + labels_url: string /** Format: uri */ - comments_url: string; + comments_url: string /** Format: uri */ - events_url: string; + events_url: string /** Format: uri */ - html_url: string; - id: number; - node_id: string; - number: number; - title: string; - locked: boolean; - active_lock_reason?: string | null; - assignees?: components["schemas"]["simple-user"][] | null; - user: components["schemas"]["nullable-simple-user"]; + html_url: string + id: number + node_id: string + number: number + title: string + locked: boolean + active_lock_reason?: string | null + assignees?: components['schemas']['simple-user'][] | null + user: components['schemas']['nullable-simple-user'] labels: { /** Format: int64 */ - id?: number; - node_id?: string; - url?: string; - name?: string; - color?: string; - default?: boolean; - description?: string | null; - }[]; - state: string; - assignee: components["schemas"]["nullable-simple-user"]; - milestone: components["schemas"]["nullable-milestone"]; - comments: number; + id?: number + node_id?: string + url?: string + name?: string + color?: string + default?: boolean + description?: string | null + }[] + state: string + assignee: components['schemas']['nullable-simple-user'] + milestone: components['schemas']['nullable-milestone'] + comments: number /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; + updated_at: string /** Format: date-time */ - closed_at: string | null; - text_matches?: components["schemas"]["search-result-text-matches"]; + closed_at: string | null + text_matches?: components['schemas']['search-result-text-matches'] pull_request?: { /** Format: date-time */ - merged_at?: string | null; + merged_at?: string | null /** Format: uri */ - diff_url: string | null; + diff_url: string | null /** Format: uri */ - html_url: string | null; + html_url: string | null /** Format: uri */ - patch_url: string | null; + patch_url: string | null /** Format: uri */ - url: string | null; - }; - body?: string; - score: number; - author_association: components["schemas"]["author_association"]; - draft?: boolean; - repository?: components["schemas"]["repository"]; - body_html?: string; - body_text?: string; + url: string | null + } + body?: string + score: number + author_association: components['schemas']['author_association'] + draft?: boolean + repository?: components['schemas']['repository'] + body_html?: string + body_text?: string /** Format: uri */ - timeline_url?: string; - performed_via_github_app?: components["schemas"]["nullable-integration"]; - reactions?: components["schemas"]["reaction-rollup"]; - }; + timeline_url?: string + performed_via_github_app?: components['schemas']['nullable-integration'] + reactions?: components['schemas']['reaction-rollup'] + } /** * Label Search Result Item * @description Label Search Result Item */ - "label-search-result-item": { - id: number; - node_id: string; + 'label-search-result-item': { + id: number + node_id: string /** Format: uri */ - url: string; - name: string; - color: string; - default: boolean; - description: string | null; - score: number; - text_matches?: components["schemas"]["search-result-text-matches"]; - }; + url: string + name: string + color: string + default: boolean + description: string | null + score: number + text_matches?: components['schemas']['search-result-text-matches'] + } /** * Repo Search Result Item * @description Repo Search Result Item */ - "repo-search-result-item": { - id: number; - node_id: string; - name: string; - full_name: string; - owner: components["schemas"]["nullable-simple-user"]; - private: boolean; + 'repo-search-result-item': { + id: number + node_id: string + name: string + full_name: string + owner: components['schemas']['nullable-simple-user'] + private: boolean /** Format: uri */ - html_url: string; - description: string | null; - fork: boolean; + html_url: string + description: string | null + fork: boolean /** Format: uri */ - url: string; + url: string /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; + updated_at: string /** Format: date-time */ - pushed_at: string; + pushed_at: string /** Format: uri */ - homepage: string | null; - size: number; - stargazers_count: number; - watchers_count: number; - language: string | null; - forks_count: number; - open_issues_count: number; - master_branch?: string; - default_branch: string; - score: number; + homepage: string | null + size: number + stargazers_count: number + watchers_count: number + language: string | null + forks_count: number + open_issues_count: number + master_branch?: string + default_branch: string + score: number /** Format: uri */ - forks_url: string; - keys_url: string; - collaborators_url: string; + forks_url: string + keys_url: string + collaborators_url: string /** Format: uri */ - teams_url: string; + teams_url: string /** Format: uri */ - hooks_url: string; - issue_events_url: string; + hooks_url: string + issue_events_url: string /** Format: uri */ - events_url: string; - assignees_url: string; - branches_url: string; + events_url: string + assignees_url: string + branches_url: string /** Format: uri */ - tags_url: string; - blobs_url: string; - git_tags_url: string; - git_refs_url: string; - trees_url: string; - statuses_url: string; + tags_url: string + blobs_url: string + git_tags_url: string + git_refs_url: string + trees_url: string + statuses_url: string /** Format: uri */ - languages_url: string; + languages_url: string /** Format: uri */ - stargazers_url: string; + stargazers_url: string /** Format: uri */ - contributors_url: string; + contributors_url: string /** Format: uri */ - subscribers_url: string; + subscribers_url: string /** Format: uri */ - subscription_url: string; - commits_url: string; - git_commits_url: string; - comments_url: string; - issue_comment_url: string; - contents_url: string; - compare_url: string; + subscription_url: string + commits_url: string + git_commits_url: string + comments_url: string + issue_comment_url: string + contents_url: string + compare_url: string /** Format: uri */ - merges_url: string; - archive_url: string; + merges_url: string + archive_url: string /** Format: uri */ - downloads_url: string; - issues_url: string; - pulls_url: string; - milestones_url: string; - notifications_url: string; - labels_url: string; - releases_url: string; + downloads_url: string + issues_url: string + pulls_url: string + milestones_url: string + notifications_url: string + labels_url: string + releases_url: string /** Format: uri */ - deployments_url: string; - git_url: string; - ssh_url: string; - clone_url: string; + deployments_url: string + git_url: string + ssh_url: string + clone_url: string /** Format: uri */ - svn_url: string; - forks: number; - open_issues: number; - watchers: number; - topics?: string[]; + svn_url: string + forks: number + open_issues: number + watchers: number + topics?: string[] /** Format: uri */ - mirror_url: string | null; - has_issues: boolean; - has_projects: boolean; - has_pages: boolean; - has_wiki: boolean; - has_downloads: boolean; - archived: boolean; + mirror_url: string | null + has_issues: boolean + has_projects: boolean + has_pages: boolean + has_wiki: boolean + has_downloads: boolean + archived: boolean /** @description Returns whether or not this repository disabled. */ - disabled: boolean; + disabled: boolean /** @description The repository visibility: public, private, or internal. */ - visibility?: string; - license: components["schemas"]["nullable-license-simple"]; + visibility?: string + license: components['schemas']['nullable-license-simple'] permissions?: { - admin: boolean; - maintain?: boolean; - push: boolean; - triage?: boolean; - pull: boolean; - }; - text_matches?: components["schemas"]["search-result-text-matches"]; - temp_clone_token?: string; - allow_merge_commit?: boolean; - allow_squash_merge?: boolean; - allow_rebase_merge?: boolean; - allow_auto_merge?: boolean; - delete_branch_on_merge?: boolean; - allow_forking?: boolean; - is_template?: boolean; - }; + admin: boolean + maintain?: boolean + push: boolean + triage?: boolean + pull: boolean + } + text_matches?: components['schemas']['search-result-text-matches'] + temp_clone_token?: string + allow_merge_commit?: boolean + allow_squash_merge?: boolean + allow_rebase_merge?: boolean + allow_auto_merge?: boolean + delete_branch_on_merge?: boolean + allow_forking?: boolean + is_template?: boolean + } /** * Topic Search Result Item * @description Topic Search Result Item */ - "topic-search-result-item": { - name: string; - display_name: string | null; - short_description: string | null; - description: string | null; - created_by: string | null; - released: string | null; + 'topic-search-result-item': { + name: string + display_name: string | null + short_description: string | null + description: string | null + created_by: string | null + released: string | null /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - featured: boolean; - curated: boolean; - score: number; - repository_count?: number | null; + updated_at: string + featured: boolean + curated: boolean + score: number + repository_count?: number | null /** Format: uri */ - logo_url?: string | null; - text_matches?: components["schemas"]["search-result-text-matches"]; + logo_url?: string | null + text_matches?: components['schemas']['search-result-text-matches'] related?: | { topic_relation?: { - id?: number; - name?: string; - topic_id?: number; - relation_type?: string; - }; + id?: number + name?: string + topic_id?: number + relation_type?: string + } }[] - | null; + | null aliases?: | { topic_relation?: { - id?: number; - name?: string; - topic_id?: number; - relation_type?: string; - }; + id?: number + name?: string + topic_id?: number + relation_type?: string + } }[] - | null; - }; + | null + } /** * User Search Result Item * @description User Search Result Item */ - "user-search-result-item": { - login: string; - id: number; - node_id: string; + 'user-search-result-item': { + login: string + id: number + node_id: string /** Format: uri */ - avatar_url: string; - gravatar_id: string | null; + avatar_url: string + gravatar_id: string | null /** Format: uri */ - url: string; + url: string /** Format: uri */ - html_url: string; + html_url: string /** Format: uri */ - followers_url: string; + followers_url: string /** Format: uri */ - subscriptions_url: string; + subscriptions_url: string /** Format: uri */ - organizations_url: string; + organizations_url: string /** Format: uri */ - repos_url: string; + repos_url: string /** Format: uri */ - received_events_url: string; - type: string; - score: number; - following_url: string; - gists_url: string; - starred_url: string; - events_url: string; - public_repos?: number; - public_gists?: number; - followers?: number; - following?: number; + received_events_url: string + type: string + score: number + following_url: string + gists_url: string + starred_url: string + events_url: string + public_repos?: number + public_gists?: number + followers?: number + following?: number /** Format: date-time */ - created_at?: string; + created_at?: string /** Format: date-time */ - updated_at?: string; - name?: string | null; - bio?: string | null; + updated_at?: string + name?: string | null + bio?: string | null /** Format: email */ - email?: string | null; - location?: string | null; - site_admin: boolean; - hireable?: boolean | null; - text_matches?: components["schemas"]["search-result-text-matches"]; - blog?: string | null; - company?: string | null; + email?: string | null + location?: string | null + site_admin: boolean + hireable?: boolean | null + text_matches?: components['schemas']['search-result-text-matches'] + blog?: string | null + company?: string | null /** Format: date-time */ - suspended_at?: string | null; - }; + suspended_at?: string | null + } /** * Private User * @description Private User */ - "private-user": { + 'private-user': { /** @example octocat */ - login: string; + login: string /** @example 1 */ - id: number; + id: number /** @example MDQ6VXNlcjE= */ - node_id: string; + node_id: string /** * Format: uri * @example https://github.com/images/error/octocat_happy.gif */ - avatar_url: string; + avatar_url: string /** @example 41d064eb2195891e12d0413f63227ea7 */ - gravatar_id: string | null; + gravatar_id: string | null /** * Format: uri * @example https://api.github.com/users/octocat */ - url: string; + url: string /** * Format: uri * @example https://github.com/octocat */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/users/octocat/followers */ - followers_url: string; + followers_url: string /** @example https://api.github.com/users/octocat/following{/other_user} */ - following_url: string; + following_url: string /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - gists_url: string; + gists_url: string /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - starred_url: string; + starred_url: string /** * Format: uri * @example https://api.github.com/users/octocat/subscriptions */ - subscriptions_url: string; + subscriptions_url: string /** * Format: uri * @example https://api.github.com/users/octocat/orgs */ - organizations_url: string; + organizations_url: string /** * Format: uri * @example https://api.github.com/users/octocat/repos */ - repos_url: string; + repos_url: string /** @example https://api.github.com/users/octocat/events{/privacy} */ - events_url: string; + events_url: string /** * Format: uri * @example https://api.github.com/users/octocat/received_events */ - received_events_url: string; + received_events_url: string /** @example User */ - type: string; - site_admin: boolean; + type: string + site_admin: boolean /** @example monalisa octocat */ - name: string | null; + name: string | null /** @example GitHub */ - company: string | null; + company: string | null /** @example https://github.com/blog */ - blog: string | null; + blog: string | null /** @example San Francisco */ - location: string | null; + location: string | null /** * Format: email * @example octocat@github.com */ - email: string | null; - hireable: boolean | null; + email: string | null + hireable: boolean | null /** @example There once was... */ - bio: string | null; + bio: string | null /** @example monalisa */ - twitter_username?: string | null; + twitter_username?: string | null /** @example 2 */ - public_repos: number; + public_repos: number /** @example 1 */ - public_gists: number; + public_gists: number /** @example 20 */ - followers: number; - following: number; + followers: number + following: number /** * Format: date-time * @example 2008-01-14T04:33:35Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2008-01-14T04:33:35Z */ - updated_at: string; + updated_at: string /** @example 81 */ - private_gists: number; + private_gists: number /** @example 100 */ - total_private_repos: number; + total_private_repos: number /** @example 100 */ - owned_private_repos: number; + owned_private_repos: number /** @example 10000 */ - disk_usage: number; + disk_usage: number /** @example 8 */ - collaborators: number; + collaborators: number /** @example true */ - two_factor_authentication: boolean; + two_factor_authentication: boolean plan?: { - collaborators: number; - name: string; - space: number; - private_repos: number; - }; + collaborators: number + name: string + space: number + private_repos: number + } /** Format: date-time */ - suspended_at?: string | null; - business_plus?: boolean; - ldap_dn?: string; - }; + suspended_at?: string | null + business_plus?: boolean + ldap_dn?: string + } /** * Codespaces Secret * @description Secrets for a GitHub Codespace. */ - "codespaces-secret": { + 'codespaces-secret': { /** * @description The name of the secret. * @example SECRET_NAME */ - name: string; + name: string /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; + updated_at: string /** * @description Visibility of a secret * @enum {string} */ - visibility: "all" | "private" | "selected"; + visibility: 'all' | 'private' | 'selected' /** * Format: uri * @example https://api.github.com/user/secrets/SECRET_NAME/repositories */ - selected_repositories_url: string; - }; + selected_repositories_url: string + } /** * CodespacesUserPublicKey * @description The public key used for setting user Codespaces' Secrets. */ - "codespaces-user-public-key": { + 'codespaces-user-public-key': { /** * @description The identifier for the key. * @example 1234567 */ - key_id: string; + key_id: string /** * @description The Base64 encoded public key. * @example hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= */ - key: string; - }; + key: string + } /** * Fetches information about an export of a codespace. * @description An export of a codespace. Also, latest export details for a codespace can be fetched with id = latest */ - "codespace-export-details": { + 'codespace-export-details': { /** * @description State of the latest export * @example succeeded | failed | in_progress */ - state?: string | null; + state?: string | null /** * Format: date-time * @description Completion time of the last export operation * @example 2021-01-01T19:01:12Z */ - completed_at?: string | null; + completed_at?: string | null /** * @description Name of the exported branch * @example codespace-monalisa-octocat-hello-world-g4wpq6h95q */ - branch?: string | null; + branch?: string | null /** * @description Git commit SHA of the exported branch * @example fd95a81ca01e48ede9f39c799ecbcef817b8a3b2 */ - sha?: string | null; + sha?: string | null /** * @description Id for the export details * @example latest */ - id?: string; + id?: string /** * @description Url for fetching export details * @example https://api.github.com/user/codespaces/:name/exports/latest */ - export_url?: string; - }; + export_url?: string + } /** * Email * @description Email @@ -17325,355 +17313,355 @@ export interface components { * Format: email * @example octocat@github.com */ - email: string; + email: string /** @example true */ - primary: boolean; + primary: boolean /** @example true */ - verified: boolean; + verified: boolean /** @example public */ - visibility: string | null; - }; + visibility: string | null + } /** * GPG Key * @description A unique encryption key */ - "gpg-key": { + 'gpg-key': { /** @example 3 */ - id: number; - primary_key_id: number | null; + id: number + primary_key_id: number | null /** @example 3262EFF25BA0D270 */ - key_id: string; + key_id: string /** @example xsBNBFayYZ... */ - public_key: string; + public_key: string /** @example [object Object] */ emails: { - email?: string; - verified?: boolean; - }[]; + email?: string + verified?: boolean + }[] /** @example [object Object] */ subkeys: { - id?: number; - primary_key_id?: number; - key_id?: string; - public_key?: string; - emails?: unknown[]; - subkeys?: unknown[]; - can_sign?: boolean; - can_encrypt_comms?: boolean; - can_encrypt_storage?: boolean; - can_certify?: boolean; - created_at?: string; - expires_at?: string | null; - raw_key?: string | null; - }[]; + id?: number + primary_key_id?: number + key_id?: string + public_key?: string + emails?: unknown[] + subkeys?: unknown[] + can_sign?: boolean + can_encrypt_comms?: boolean + can_encrypt_storage?: boolean + can_certify?: boolean + created_at?: string + expires_at?: string | null + raw_key?: string | null + }[] /** @example true */ - can_sign: boolean; - can_encrypt_comms: boolean; - can_encrypt_storage: boolean; + can_sign: boolean + can_encrypt_comms: boolean + can_encrypt_storage: boolean /** @example true */ - can_certify: boolean; + can_certify: boolean /** * Format: date-time * @example 2016-03-24T11:31:04-06:00 */ - created_at: string; + created_at: string /** Format: date-time */ - expires_at: string | null; - raw_key: string | null; - }; + expires_at: string | null + raw_key: string | null + } /** * Key * @description Key */ key: { - key: string; - id: number; - url: string; - title: string; + key: string + id: number + url: string + title: string /** Format: date-time */ - created_at: string; - verified: boolean; - read_only: boolean; - }; + created_at: string + verified: boolean + read_only: boolean + } /** Marketplace Account */ - "marketplace-account": { + 'marketplace-account': { /** Format: uri */ - url: string; - id: number; - type: string; - node_id?: string; - login: string; + url: string + id: number + type: string + node_id?: string + login: string /** Format: email */ - email?: string | null; + email?: string | null /** Format: email */ - organization_billing_email?: string | null; - }; + organization_billing_email?: string | null + } /** * User Marketplace Purchase * @description User Marketplace Purchase */ - "user-marketplace-purchase": { + 'user-marketplace-purchase': { /** @example monthly */ - billing_cycle: string; + billing_cycle: string /** * Format: date-time * @example 2017-11-11T00:00:00Z */ - next_billing_date: string | null; - unit_count: number | null; + next_billing_date: string | null + unit_count: number | null /** @example true */ - on_free_trial: boolean; + on_free_trial: boolean /** * Format: date-time * @example 2017-11-11T00:00:00Z */ - free_trial_ends_on: string | null; + free_trial_ends_on: string | null /** * Format: date-time * @example 2017-11-02T01:12:12Z */ - updated_at: string | null; - account: components["schemas"]["marketplace-account"]; - plan: components["schemas"]["marketplace-listing-plan"]; - }; + updated_at: string | null + account: components['schemas']['marketplace-account'] + plan: components['schemas']['marketplace-listing-plan'] + } /** * Starred Repository * @description Starred Repository */ - "starred-repository": { + 'starred-repository': { /** Format: date-time */ - starred_at: string; - repo: components["schemas"]["repository"]; - }; + starred_at: string + repo: components['schemas']['repository'] + } /** * Hovercard * @description Hovercard */ hovercard: { contexts: { - message: string; - octicon: string; - }[]; - }; + message: string + octicon: string + }[] + } /** * Key Simple * @description Key Simple */ - "key-simple": { - id: number; - key: string; - }; - }; + 'key-simple': { + id: number + key: string + } + } responses: { /** Resource not found */ not_found: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } /** Validation failed */ validation_failed_simple: { content: { - "application/json": components["schemas"]["validation-error-simple"]; - }; - }; + 'application/json': components['schemas']['validation-error-simple'] + } + } /** Bad Request */ bad_request: { content: { - "application/json": components["schemas"]["basic-error"]; - "application/scim+json": components["schemas"]["scim-error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + 'application/scim+json': components['schemas']['scim-error'] + } + } /** Validation failed */ validation_failed: { content: { - "application/json": components["schemas"]["validation-error"]; - }; - }; + 'application/json': components['schemas']['validation-error'] + } + } /** Accepted */ accepted: { content: { - "application/json": { [key: string]: unknown }; - }; - }; + 'application/json': { [key: string]: unknown } + } + } /** Preview header missing */ preview_header_missing: { content: { - "application/json": { - message: string; - documentation_url: string; - }; - }; - }; + 'application/json': { + message: string + documentation_url: string + } + } + } /** Forbidden */ forbidden: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } /** Requires authentication */ requires_authentication: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } /** Not modified */ - not_modified: unknown; + not_modified: unknown /** Gone */ gone: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } /** Response */ actions_runner_labels: { content: { - "application/json": { - total_count: number; - labels: components["schemas"]["runner-label"][]; - }; - }; - }; + 'application/json': { + total_count: number + labels: components['schemas']['runner-label'][] + } + } + } /** Response */ actions_runner_labels_readonly: { content: { - "application/json": { - total_count: number; - labels: components["schemas"]["runner-label"][]; - }; - }; - }; + 'application/json': { + total_count: number + labels: components['schemas']['runner-label'][] + } + } + } /** Service unavailable */ service_unavailable: { content: { - "application/json": { - code?: string; - message?: string; - documentation_url?: string; - }; - }; - }; + 'application/json': { + code?: string + message?: string + documentation_url?: string + } + } + } /** Response if GitHub Advanced Security is not enabled for this repository */ code_scanning_forbidden_read: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } /** Forbidden Gist */ forbidden_gist: { content: { - "application/json": { + 'application/json': { block?: { - reason?: string; - created_at?: string; - html_url?: string | null; - }; - message?: string; - documentation_url?: string; - }; - }; - }; + reason?: string + created_at?: string + html_url?: string | null + } + message?: string + documentation_url?: string + } + } + } /** Moved permanently */ moved_permanently: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } /** Conflict */ conflict: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } /** Temporary Redirect */ temporary_redirect: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } /** Internal Error */ internal_error: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } /** Response if the repository is archived or if github advanced security is not enabled for this repository */ code_scanning_forbidden_write: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } /** Found */ - found: unknown; + found: unknown /** A header with no content is returned. */ - no_content: unknown; + no_content: unknown /** Resource not found */ scim_not_found: { content: { - "application/json": components["schemas"]["scim-error"]; - "application/scim+json": components["schemas"]["scim-error"]; - }; - }; + 'application/json': components['schemas']['scim-error'] + 'application/scim+json': components['schemas']['scim-error'] + } + } /** Forbidden */ scim_forbidden: { content: { - "application/json": components["schemas"]["scim-error"]; - "application/scim+json": components["schemas"]["scim-error"]; - }; - }; + 'application/json': components['schemas']['scim-error'] + 'application/scim+json': components['schemas']['scim-error'] + } + } /** Bad Request */ scim_bad_request: { content: { - "application/json": components["schemas"]["scim-error"]; - "application/scim+json": components["schemas"]["scim-error"]; - }; - }; + 'application/json': components['schemas']['scim-error'] + 'application/scim+json': components['schemas']['scim-error'] + } + } /** Internal Error */ scim_internal_error: { content: { - "application/json": components["schemas"]["scim-error"]; - "application/scim+json": components["schemas"]["scim-error"]; - }; - }; + 'application/json': components['schemas']['scim-error'] + 'application/scim+json': components['schemas']['scim-error'] + } + } /** Conflict */ scim_conflict: { content: { - "application/json": components["schemas"]["scim-error"]; - "application/scim+json": components["schemas"]["scim-error"]; - }; - }; - }; + 'application/json': components['schemas']['scim-error'] + 'application/scim+json': components['schemas']['scim-error'] + } + } + } parameters: { /** @description Results per page (max 100) */ - "per-page": number; + 'per-page': number /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ - cursor: string; - "delivery-id": number; + cursor: string + 'delivery-id': number /** @description Page number of the results to fetch. */ - page: number; + page: number /** @description Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since: string; + since: string /** @description installation_id parameter */ - "installation-id": number; + 'installation-id': number /** @description grant_id parameter */ - "grant-id": number; + 'grant-id': number /** @description The client ID of your GitHub app. */ - "client-id": string; - "app-slug": string; + 'client-id': string + 'app-slug': string /** @description authorization_id parameter */ - "authorization-id": number; + 'authorization-id': number /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: string; + enterprise: string /** @description Unique identifier of an organization. */ - "org-id": number; + 'org-id': number /** @description Unique identifier of the self-hosted runner group. */ - "runner-group-id": number; + 'runner-group-id': number /** @description Unique identifier of the self-hosted runner. */ - "runner-id": number; + 'runner-id': number /** @description The name of a self-hosted runner's custom label. */ - "runner-label-name": string; + 'runner-label-name': string /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). */ - "audit-log-phrase": string; + 'audit-log-phrase': string /** * @description The event types to include: * @@ -17683,843 +17671,843 @@ export interface components { * * The default is `web`. */ - "audit-log-include": "web" | "git" | "all"; + 'audit-log-include': 'web' | 'git' | 'all' /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor. */ - "audit-log-after": string; + 'audit-log-after': string /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor. */ - "audit-log-before": string; + 'audit-log-before': string /** * @description The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. * * The default is `desc`. */ - "audit-log-order": "desc" | "asc"; + 'audit-log-order': 'desc' | 'asc' /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - "secret-scanning-alert-state": "open" | "resolved"; + 'secret-scanning-alert-state': 'open' | 'resolved' /** * @description A comma-separated list of secret types to return. By default all secret types are returned. * See "[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)" * for a complete list of secret types (API slug). */ - "secret-scanning-alert-secret-type": string; + 'secret-scanning-alert-secret-type': string /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - "secret-scanning-alert-resolution": string; + 'secret-scanning-alert-resolution': string /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor. */ - "pagination-before": string; + 'pagination-before': string /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor. */ - "pagination-after": string; + 'pagination-after': string /** @description gist_id parameter */ - "gist-id": string; + 'gist-id': string /** @description comment_id parameter */ - "comment-id": number; + 'comment-id': number /** @description A list of comma separated label names. Example: `bug,ui,@high` */ - labels: string; + labels: string /** @description One of `asc` (ascending) or `desc` (descending). */ - direction: "asc" | "desc"; + direction: 'asc' | 'desc' /** @description account_id parameter */ - "account-id": number; + 'account-id': number /** @description plan_id parameter */ - "plan-id": number; + 'plan-id': number /** @description One of `created` (when the repository was starred) or `updated` (when it was last pushed to). */ - sort: "created" | "updated"; - owner: string; - repo: string; + sort: 'created' | 'updated' + owner: string + repo: string /** @description If `true`, show notifications marked as read. */ - all: boolean; + all: boolean /** @description If `true`, only shows notifications in which the user is directly participating or mentioned. */ - participating: boolean; + participating: boolean /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - before: string; + before: string /** @description thread_id parameter */ - "thread-id": number; + 'thread-id': number /** @description An organization ID. Only return organizations with an ID greater than this ID. */ - "since-org": number; - org: string; + 'since-org': number + org: string /** @description team_slug parameter */ - "team-slug": string; - "repository-id": number; + 'team-slug': string + 'repository-id': number /** @description secret_name parameter */ - "secret-name": string; - username: string; + 'secret-name': string + username: string /** @description group_id parameter */ - "group-id": number; - "hook-id": number; + 'group-id': number + 'hook-id': number /** @description invitation_id parameter */ - "invitation-id": number; + 'invitation-id': number /** @description migration_id parameter */ - "migration-id": number; + 'migration-id': number /** @description repo_name parameter */ - "repo-name": string; + 'repo-name': string /** @description The selected visibility of the packages. Can be one of `public`, `private`, or `internal`. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set. */ - "package-visibility": "public" | "private" | "internal"; + 'package-visibility': 'public' | 'private' | 'internal' /** @description The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - "package-type": "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + 'package-type': 'npm' | 'maven' | 'rubygems' | 'docker' | 'nuget' | 'container' /** @description The name of the package. */ - "package-name": string; + 'package-name': string /** @description Unique identifier of the package version. */ - "package-version-id": number; - "discussion-number": number; - "comment-number": number; - "reaction-id": number; - "project-id": number; + 'package-version-id': number + 'discussion-number': number + 'comment-number': number + 'reaction-id': number + 'project-id': number /** @description card_id parameter */ - "card-id": number; + 'card-id': number /** @description column_id parameter */ - "column-id": number; + 'column-id': number /** @description artifact_id parameter */ - "artifact-id": number; + 'artifact-id': number /** @description job_id parameter */ - "job-id": number; + 'job-id': number /** @description Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ - actor: string; + actor: string /** @description Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ - "workflow-run-branch": string; + 'workflow-run-branch': string /** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ - event: string; + event: string /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. For a list of the possible `status` and `conclusion` options, see "[Create a check run](https://docs.github.com/rest/reference/checks#create-a-check-run)." */ - "workflow-run-status": - | "completed" - | "action_required" - | "cancelled" - | "failure" - | "neutral" - | "skipped" - | "stale" - | "success" - | "timed_out" - | "in_progress" - | "queued" - | "requested" - | "waiting"; + 'workflow-run-status': + | 'completed' + | 'action_required' + | 'cancelled' + | 'failure' + | 'neutral' + | 'skipped' + | 'stale' + | 'success' + | 'timed_out' + | 'in_progress' + | 'queued' + | 'requested' + | 'waiting' /** @description Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ - created: string; + created: string /** @description If `true` pull requests are omitted from the response (empty array). */ - "exclude-pull-requests": boolean; + 'exclude-pull-requests': boolean /** @description Returns workflow runs with the `check_suite_id` that you specify. */ - "workflow-run-check-suite-id": number; + 'workflow-run-check-suite-id': number /** @description The id of the workflow run. */ - "run-id": number; + 'run-id': number /** @description The attempt number of the workflow run. */ - "attempt-number": number; + 'attempt-number': number /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ - "workflow-id": number | string; + 'workflow-id': number | string /** @description autolink_id parameter */ - "autolink-id": number; + 'autolink-id': number /** @description The name of the branch. */ - branch: string; + branch: string /** @description check_run_id parameter */ - "check-run-id": number; + 'check-run-id': number /** @description check_suite_id parameter */ - "check-suite-id": number; + 'check-suite-id': number /** @description Returns check runs with the specified `name`. */ - "check-name": string; + 'check-name': string /** @description Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`. */ - status: "queued" | "in_progress" | "completed"; + status: 'queued' | 'in_progress' | 'completed' /** @description The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */ - "tool-name": components["schemas"]["code-scanning-analysis-tool-name"]; + 'tool-name': components['schemas']['code-scanning-analysis-tool-name'] /** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ - "tool-guid": components["schemas"]["code-scanning-analysis-tool-guid"]; + 'tool-guid': components['schemas']['code-scanning-analysis-tool-guid'] /** @description The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ - "git-ref": components["schemas"]["code-scanning-ref"]; + 'git-ref': components['schemas']['code-scanning-ref'] /** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ - "alert-number": components["schemas"]["alert-number"]; + 'alert-number': components['schemas']['alert-number'] /** @description commit_sha parameter */ - "commit-sha": string; + 'commit-sha': string /** @description deployment_id parameter */ - "deployment-id": number; + 'deployment-id': number /** @description The name of the environment */ - "environment-name": string; + 'environment-name': string /** @description A user ID. Only return users with an ID greater than this ID. */ - "since-user": number; + 'since-user': number /** @description issue_number parameter */ - "issue-number": number; + 'issue-number': number /** @description key_id parameter */ - "key-id": number; + 'key-id': number /** @description milestone_number parameter */ - "milestone-number": number; - "pull-number": number; + 'milestone-number': number + 'pull-number': number /** @description review_id parameter */ - "review-id": number; + 'review-id': number /** @description asset_id parameter */ - "asset-id": number; + 'asset-id': number /** @description release_id parameter */ - "release-id": number; + 'release-id': number /** @description Must be one of: `day`, `week`. */ - per: "" | "day" | "week"; + per: '' | 'day' | 'week' /** @description A repository ID. Only return repositories with an ID greater than this ID. */ - "since-repo": number; + 'since-repo': number /** @description Used for pagination: the index of the first result to return. */ - "start-index": number; + 'start-index': number /** @description Used for pagination: the number of results to return. */ - count: number; + count: number /** @description Identifier generated by the GitHub SCIM endpoint. */ - "scim-group-id": string; + 'scim-group-id': string /** @description scim_user_id parameter */ - "scim-user-id": string; + 'scim-user-id': string /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - order: "desc" | "asc"; - "team-id": number; + order: 'desc' | 'asc' + 'team-id': number /** @description ID of the Repository to filter on */ - "repository-id-in-query": number; + 'repository-id-in-query': number /** @description The name of the codespace. */ - "codespace-name": string; + 'codespace-name': string /** @description The ID of the export operation, or `latest`. Currently only `latest` is currently supported. */ - "export-id": string; + 'export-id': string /** @description gpg_key_id parameter */ - "gpg-key-id": number; - }; + 'gpg-key-id': number + } headers: { - link?: string; - "content-type"?: string; - "x-common-marker-version"?: string; - "x-rate-limit-limit"?: number; - "x-rate-limit-remaining"?: number; - "x-rate-limit-reset"?: number; - location?: string; - }; + link?: string + 'content-type'?: string + 'x-common-marker-version'?: string + 'x-rate-limit-limit'?: number + 'x-rate-limit-remaining'?: number + 'x-rate-limit-reset'?: number + location?: string + } } export interface operations { /** Get Hypermedia links to resources accessible in GitHub's REST API */ - "meta/root": { + 'meta/root': { responses: { /** Response */ 200: { content: { - "application/json": { + 'application/json': { /** Format: uri-template */ - current_user_url: string; + current_user_url: string /** Format: uri-template */ - current_user_authorizations_html_url: string; + current_user_authorizations_html_url: string /** Format: uri-template */ - authorizations_url: string; + authorizations_url: string /** Format: uri-template */ - code_search_url: string; + code_search_url: string /** Format: uri-template */ - commit_search_url: string; + commit_search_url: string /** Format: uri-template */ - emails_url: string; + emails_url: string /** Format: uri-template */ - emojis_url: string; + emojis_url: string /** Format: uri-template */ - events_url: string; + events_url: string /** Format: uri-template */ - feeds_url: string; + feeds_url: string /** Format: uri-template */ - followers_url: string; + followers_url: string /** Format: uri-template */ - following_url: string; + following_url: string /** Format: uri-template */ - gists_url: string; + gists_url: string /** Format: uri-template */ - hub_url: string; + hub_url: string /** Format: uri-template */ - issue_search_url: string; + issue_search_url: string /** Format: uri-template */ - issues_url: string; + issues_url: string /** Format: uri-template */ - keys_url: string; + keys_url: string /** Format: uri-template */ - label_search_url: string; + label_search_url: string /** Format: uri-template */ - notifications_url: string; + notifications_url: string /** Format: uri-template */ - organization_url: string; + organization_url: string /** Format: uri-template */ - organization_repositories_url: string; + organization_repositories_url: string /** Format: uri-template */ - organization_teams_url: string; + organization_teams_url: string /** Format: uri-template */ - public_gists_url: string; + public_gists_url: string /** Format: uri-template */ - rate_limit_url: string; + rate_limit_url: string /** Format: uri-template */ - repository_url: string; + repository_url: string /** Format: uri-template */ - repository_search_url: string; + repository_search_url: string /** Format: uri-template */ - current_user_repositories_url: string; + current_user_repositories_url: string /** Format: uri-template */ - starred_url: string; + starred_url: string /** Format: uri-template */ - starred_gists_url: string; + starred_gists_url: string /** Format: uri-template */ - topic_search_url?: string; + topic_search_url?: string /** Format: uri-template */ - user_url: string; + user_url: string /** Format: uri-template */ - user_organizations_url: string; + user_organizations_url: string /** Format: uri-template */ - user_repositories_url: string; + user_repositories_url: string /** Format: uri-template */ - user_search_url: string; - }; - }; - }; - }; - }; + user_search_url: string + } + } + } + } + } /** * Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/rest/reference/apps#list-installations-for-the-authenticated-app)" endpoint. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/get-authenticated": { - parameters: {}; + 'apps/get-authenticated': { + parameters: {} responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["integration"]; - }; - }; - }; - }; + 'application/json': components['schemas']['integration'] + } + } + } + } /** Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. */ - "apps/create-from-manifest": { + 'apps/create-from-manifest': { parameters: { path: { - code: string; - }; - }; + code: string + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["integration"] & + 'application/json': components['schemas']['integration'] & ({ - client_id: string; - client_secret: string; - webhook_secret: string | null; - pem: string; - } & { [key: string]: unknown }); - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + client_id: string + client_secret: string + webhook_secret: string | null + pem: string + } & { [key: string]: unknown }) + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { [key: string]: unknown }; - }; - }; - }; + 'application/json': { [key: string]: unknown } + } + } + } /** * Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/get-webhook-config-for-app": { + 'apps/get-webhook-config-for-app': { responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["webhook-config"]; - }; - }; - }; - }; + 'application/json': components['schemas']['webhook-config'] + } + } + } + } /** * Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/update-webhook-config-for-app": { + 'apps/update-webhook-config-for-app': { responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["webhook-config"]; - }; - }; - }; + 'application/json': components['schemas']['webhook-config'] + } + } + } requestBody: { content: { - "application/json": { - url?: components["schemas"]["webhook-config-url"]; - content_type?: components["schemas"]["webhook-config-content-type"]; - secret?: components["schemas"]["webhook-config-secret"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - }; - }; - }; - }; + 'application/json': { + url?: components['schemas']['webhook-config-url'] + content_type?: components['schemas']['webhook-config-content-type'] + secret?: components['schemas']['webhook-config-secret'] + insecure_ssl?: components['schemas']['webhook-config-insecure-ssl'] + } + } + } + } /** * Returns a list of webhook deliveries for the webhook configured for a GitHub App. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/list-webhook-deliveries": { + 'apps/list-webhook-deliveries': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ - cursor?: components["parameters"]["cursor"]; - }; - }; + cursor?: components['parameters']['cursor'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["hook-delivery-item"][]; - }; - }; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['hook-delivery-item'][] + } + } + 400: components['responses']['bad_request'] + 422: components['responses']['validation_failed'] + } + } /** * Returns a delivery for the webhook configured for a GitHub App. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/get-webhook-delivery": { + 'apps/get-webhook-delivery': { parameters: { path: { - delivery_id: components["parameters"]["delivery-id"]; - }; - }; + delivery_id: components['parameters']['delivery-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["hook-delivery"]; - }; - }; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['hook-delivery'] + } + } + 400: components['responses']['bad_request'] + 422: components['responses']['validation_failed'] + } + } /** * Redeliver a delivery for the webhook configured for a GitHub App. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/redeliver-webhook-delivery": { + 'apps/redeliver-webhook-delivery': { parameters: { path: { - delivery_id: components["parameters"]["delivery-id"]; - }; - }; + delivery_id: components['parameters']['delivery-id'] + } + } responses: { - 202: components["responses"]["accepted"]; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 202: components['responses']['accepted'] + 400: components['responses']['bad_request'] + 422: components['responses']['validation_failed'] + } + } /** * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. * * The permissions the installation has are included under the `permissions` key. */ - "apps/list-installations": { + 'apps/list-installations': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; - outdated?: string; - }; - }; + since?: components['parameters']['since'] + outdated?: string + } + } responses: { /** The permissions the installation has are included under the `permissions` key. */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["installation"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['installation'][] + } + } + } + } /** * Enables an authenticated GitHub App to find an installation's information using the installation id. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/get-installation": { + 'apps/get-installation': { parameters: { path: { /** installation_id parameter */ - installation_id: components["parameters"]["installation-id"]; - }; - }; + installation_id: components['parameters']['installation-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["installation"]; - }; - }; - 404: components["responses"]["not_found"]; - 415: components["responses"]["preview_header_missing"]; - }; - }; + 'application/json': components['schemas']['installation'] + } + } + 404: components['responses']['not_found'] + 415: components['responses']['preview_header_missing'] + } + } /** * Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/reference/apps/#suspend-an-app-installation)" endpoint. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/delete-installation": { + 'apps/delete-installation': { parameters: { path: { /** installation_id parameter */ - installation_id: components["parameters"]["installation-id"]; - }; - }; + installation_id: components['parameters']['installation-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** * Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/create-installation-access-token": { + 'apps/create-installation-access-token': { parameters: { path: { /** installation_id parameter */ - installation_id: components["parameters"]["installation-id"]; - }; - }; + installation_id: components['parameters']['installation-id'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["installation-token"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 415: components["responses"]["preview_header_missing"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['installation-token'] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 415: components['responses']['preview_header_missing'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description List of repository names that the token should have access to */ - repositories?: string[]; + repositories?: string[] /** * @description List of repository IDs that the token should have access to * @example 1 */ - repository_ids?: number[]; - permissions?: components["schemas"]["app-permissions"]; - }; - }; - }; - }; + repository_ids?: number[] + permissions?: components['schemas']['app-permissions'] + } + } + } + } /** * Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/suspend-installation": { + 'apps/suspend-installation': { parameters: { path: { /** installation_id parameter */ - installation_id: components["parameters"]["installation-id"]; - }; - }; + installation_id: components['parameters']['installation-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** * Removes a GitHub App installation suspension. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/unsuspend-installation": { + 'apps/unsuspend-installation': { parameters: { path: { /** installation_id parameter */ - installation_id: components["parameters"]["installation-id"]; - }; - }; + installation_id: components['parameters']['installation-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * * You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/rest/reference/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `["repo", "user"]`. */ - "oauth-authorizations/list-grants": { + 'oauth-authorizations/list-grants': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** The client ID of your GitHub app. */ - client_id?: string; - }; - }; + client_id?: string + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["application-grant"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['application-grant'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - "oauth-authorizations/get-grant": { + 'oauth-authorizations/get-grant': { parameters: { path: { /** grant_id parameter */ - grant_id: components["parameters"]["grant-id"]; - }; - }; + grant_id: components['parameters']['grant-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["application-grant"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['application-grant'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ - "oauth-authorizations/delete-grant": { + 'oauth-authorizations/delete-grant': { parameters: { path: { /** grant_id parameter */ - grant_id: components["parameters"]["grant-id"]; - }; - }; + grant_id: components['parameters']['grant-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** * OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ - "apps/delete-authorization": { + 'apps/delete-authorization': { parameters: { path: { /** The client ID of your GitHub app. */ - client_id: components["parameters"]["client-id"]; - }; - }; + client_id: components['parameters']['client-id'] + } + } responses: { /** Response */ - 204: never; - 422: components["responses"]["validation_failed"]; - }; + 204: never + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The OAuth access token used to authenticate to the GitHub API. */ - access_token: string; - }; - }; - }; - }; + access_token: string + } + } + } + } /** OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the OAuth application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`. */ - "apps/check-token": { + 'apps/check-token': { parameters: { path: { /** The client ID of your GitHub app. */ - client_id: components["parameters"]["client-id"]; - }; - }; + client_id: components['parameters']['client-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["authorization"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['authorization'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The access_token of the OAuth application. */ - access_token: string; - }; - }; - }; - }; + access_token: string + } + } + } + } /** OAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. */ - "apps/delete-token": { + 'apps/delete-token': { parameters: { path: { /** The client ID of your GitHub app. */ - client_id: components["parameters"]["client-id"]; - }; - }; + client_id: components['parameters']['client-id'] + } + } responses: { /** Response */ - 204: never; - 422: components["responses"]["validation_failed"]; - }; + 204: never + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The OAuth access token used to authenticate to the GitHub API. */ - access_token: string; - }; - }; - }; - }; + access_token: string + } + } + } + } /** OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. */ - "apps/reset-token": { + 'apps/reset-token': { parameters: { path: { /** The client ID of your GitHub app. */ - client_id: components["parameters"]["client-id"]; - }; - }; + client_id: components['parameters']['client-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["authorization"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['authorization'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The access_token of the OAuth application. */ - access_token: string; - }; - }; - }; - }; + access_token: string + } + } + } + } /** Use a non-scoped user-to-server OAuth access token to create a repository scoped and/or permission scoped user-to-server OAuth access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. */ - "apps/scope-token": { + 'apps/scope-token': { parameters: { path: { /** The client ID of your GitHub app. */ - client_id: components["parameters"]["client-id"]; - }; - }; + client_id: components['parameters']['client-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["authorization"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['authorization'] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The OAuth access token used to authenticate to the GitHub API. * @example e72e16c7e42f292c6912e7710c838347ae178b4a */ - access_token: string; + access_token: string /** * @description The name of the user or organization to scope the user-to-server access token to. **Required** unless `target_id` is specified. * @example octocat */ - target?: string; + target?: string /** * @description The ID of the user or organization to scope the user-to-server access token to. **Required** unless `target` is specified. * @example 1 */ - target_id?: number; + target_id?: number /** @description The list of repository names to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified. */ - repositories?: string[]; + repositories?: string[] /** * @description The list of repository IDs to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified. * @example 1 */ - repository_ids?: number[]; - permissions?: components["schemas"]["app-permissions"]; - }; - }; - }; - }; + repository_ids?: number[] + permissions?: components['schemas']['app-permissions'] + } + } + } + } /** * **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). * * If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ - "apps/get-by-slug": { + 'apps/get-by-slug': { parameters: { path: { - app_slug: components["parameters"]["app-slug"]; - }; - }; + app_slug: components['parameters']['app-slug'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["integration"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 415: components["responses"]["preview_header_missing"]; - }; - }; + 'application/json': components['schemas']['integration'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 415: components['responses']['preview_header_missing'] + } + } /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - "oauth-authorizations/list-authorizations": { + 'oauth-authorizations/list-authorizations': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** The client ID of your GitHub app. */ - client_id?: string; - }; - }; + client_id?: string + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["authorization"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['authorization'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * @@ -18533,49 +18521,49 @@ export interface operations { * * Organizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in [the GitHub Help documentation](https://docs.github.com/articles/about-identity-and-access-management-with-saml-single-sign-on). */ - "oauth-authorizations/create-authorization": { - parameters: {}; + 'oauth-authorizations/create-authorization': { + parameters: {} responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["authorization"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['authorization'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 410: components['responses']['gone'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description A list of scopes that this authorization is in. * @example public_repo,user */ - scopes?: string[] | null; + scopes?: string[] | null /** * @description A note to remind you what the OAuth token is for. * @example Update all gems */ - note?: string; + note?: string /** @description A URL to remind you what app the OAuth token is for. */ - note_url?: string; + note_url?: string /** @description The OAuth app client key for which to create the token. */ - client_id?: string; + client_id?: string /** @description The OAuth app client secret for which to create the token. */ - client_secret?: string; + client_secret?: string /** @description A unique string to distinguish an authorization from others created for the same client ID and user. */ - fingerprint?: string; - }; - }; - }; - }; + fingerprint?: string + } + } + } + } /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * @@ -18587,60 +18575,60 @@ export interface operations { * * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - "oauth-authorizations/get-or-create-authorization-for-app": { + 'oauth-authorizations/get-or-create-authorization-for-app': { parameters: { path: { /** The client ID of your GitHub app. */ - client_id: components["parameters"]["client-id"]; - }; - }; + client_id: components['parameters']['client-id'] + } + } responses: { /** if returning an existing token */ 200: { headers: { - Location?: string; - }; + Location?: string + } content: { - "application/json": components["schemas"]["authorization"]; - }; - }; + 'application/json': components['schemas']['authorization'] + } + } /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["authorization"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['authorization'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The OAuth app client secret for which to create the token. */ - client_secret: string; + client_secret: string /** * @description A list of scopes that this authorization is in. * @example public_repo,user */ - scopes?: string[] | null; + scopes?: string[] | null /** * @description A note to remind you what the OAuth token is for. * @example Update all gems */ - note?: string; + note?: string /** @description A URL to remind you what app the OAuth token is for. */ - note_url?: string; + note_url?: string /** @description A unique string to distinguish an authorization from others created for the same client ID and user. */ - fingerprint?: string; - }; - }; - }; - }; + fingerprint?: string + } + } + } + } /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * @@ -18650,92 +18638,92 @@ export interface operations { * * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." */ - "oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint": { + 'oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint': { parameters: { path: { /** The client ID of your GitHub app. */ - client_id: components["parameters"]["client-id"]; - fingerprint: string; - }; - }; + client_id: components['parameters']['client-id'] + fingerprint: string + } + } responses: { /** if returning an existing token */ 200: { headers: { - Location?: string; - }; + Location?: string + } content: { - "application/json": components["schemas"]["authorization"]; - }; - }; + 'application/json': components['schemas']['authorization'] + } + } /** Response if returning a new token */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["authorization"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['authorization'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The OAuth app client secret for which to create the token. */ - client_secret: string; + client_secret: string /** * @description A list of scopes that this authorization is in. * @example public_repo,user */ - scopes?: string[] | null; + scopes?: string[] | null /** * @description A note to remind you what the OAuth token is for. * @example Update all gems */ - note?: string; + note?: string /** @description A URL to remind you what app the OAuth token is for. */ - note_url?: string; - }; - }; - }; - }; + note_url?: string + } + } + } + } /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - "oauth-authorizations/get-authorization": { + 'oauth-authorizations/get-authorization': { parameters: { path: { /** authorization_id parameter */ - authorization_id: components["parameters"]["authorization-id"]; - }; - }; + authorization_id: components['parameters']['authorization-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["authorization"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['authorization'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - "oauth-authorizations/delete-authorization": { + 'oauth-authorizations/delete-authorization': { parameters: { path: { /** authorization_id parameter */ - authorization_id: components["parameters"]["authorization-id"]; - }; - }; + authorization_id: components['parameters']['authorization-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * @@ -18743,678 +18731,678 @@ export interface operations { * * You can only send one of these scope keys at a time. */ - "oauth-authorizations/update-authorization": { + 'oauth-authorizations/update-authorization': { parameters: { path: { /** authorization_id parameter */ - authorization_id: components["parameters"]["authorization-id"]; - }; - }; + authorization_id: components['parameters']['authorization-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["authorization"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['authorization'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description A list of scopes that this authorization is in. * @example public_repo,user */ - scopes?: string[] | null; + scopes?: string[] | null /** @description A list of scopes to add to this authorization. */ - add_scopes?: string[]; + add_scopes?: string[] /** @description A list of scopes to remove from this authorization. */ - remove_scopes?: string[]; + remove_scopes?: string[] /** * @description A note to remind you what the OAuth token is for. * @example Update all gems */ - note?: string; + note?: string /** @description A URL to remind you what app the OAuth token is for. */ - note_url?: string; + note_url?: string /** @description A unique string to distinguish an authorization from others created for the same client ID and user. */ - fingerprint?: string; - }; - }; - }; - }; - "codes-of-conduct/get-all-codes-of-conduct": { - parameters: {}; + fingerprint?: string + } + } + } + } + 'codes-of-conduct/get-all-codes-of-conduct': { + parameters: {} responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["code-of-conduct"][]; - }; - }; - 304: components["responses"]["not_modified"]; - }; - }; - "codes-of-conduct/get-conduct-code": { + 'application/json': components['schemas']['code-of-conduct'][] + } + } + 304: components['responses']['not_modified'] + } + } + 'codes-of-conduct/get-conduct-code': { parameters: { path: { - key: string; - }; - }; + key: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["code-of-conduct"]; - }; - }; - 304: components["responses"]["not_modified"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['code-of-conduct'] + } + } + 304: components['responses']['not_modified'] + 404: components['responses']['not_found'] + } + } /** Lists all the emojis available to use on GitHub. */ - "emojis/get": { - parameters: {}; + 'emojis/get': { + parameters: {} responses: { /** Response */ 200: { content: { - "application/json": { [key: string]: string }; - }; - }; - 304: components["responses"]["not_modified"]; - }; - }; + 'application/json': { [key: string]: string } + } + } + 304: components['responses']['not_modified'] + } + } /** * Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - "enterprise-admin/get-github-actions-permissions-enterprise": { + 'enterprise-admin/get-github-actions-permissions-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-enterprise-permissions"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-enterprise-permissions'] + } + } + } + } /** * Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - "enterprise-admin/set-github-actions-permissions-enterprise": { + 'enterprise-admin/set-github-actions-permissions-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { - enabled_organizations: components["schemas"]["enabled-organizations"]; - allowed_actions?: components["schemas"]["allowed-actions"]; - }; - }; - }; - }; + 'application/json': { + enabled_organizations: components['schemas']['enabled-organizations'] + allowed_actions?: components['schemas']['allowed-actions'] + } + } + } + } /** * Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - "enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise": { + 'enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; + enterprise: components['parameters']['enterprise'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - organizations: components["schemas"]["organization-simple"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + organizations: components['schemas']['organization-simple'][] + } + } + } + } + } /** * Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - "enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise": { + 'enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description List of organization IDs to enable for GitHub Actions. */ - selected_organization_ids: number[]; - }; - }; - }; - }; + selected_organization_ids: number[] + } + } + } + } /** * Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - "enterprise-admin/enable-selected-organization-github-actions-enterprise": { + 'enterprise-admin/enable-selected-organization-github-actions-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of an organization. */ - org_id: components["parameters"]["org-id"]; - }; - }; + org_id: components['parameters']['org-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - "enterprise-admin/disable-selected-organization-github-actions-enterprise": { + 'enterprise-admin/disable-selected-organization-github-actions-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of an organization. */ - org_id: components["parameters"]["org-id"]; - }; - }; + org_id: components['parameters']['org-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - "enterprise-admin/get-allowed-actions-enterprise": { + 'enterprise-admin/get-allowed-actions-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["selected-actions"]; - }; - }; - }; - }; + 'application/json': components['schemas']['selected-actions'] + } + } + } + } /** * Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - "enterprise-admin/set-allowed-actions-enterprise": { + 'enterprise-admin/set-allowed-actions-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": components["schemas"]["selected-actions"]; - }; - }; - }; + 'application/json': components['schemas']['selected-actions'] + } + } + } /** * Lists all self-hosted runner groups for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/list-self-hosted-runner-groups-for-enterprise": { + 'enterprise-admin/list-self-hosted-runner-groups-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; + enterprise: components['parameters']['enterprise'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - runner_groups: components["schemas"]["runner-groups-enterprise"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + runner_groups: components['schemas']['runner-groups-enterprise'][] + } + } + } + } + } /** * Creates a new self-hosted runner group for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/create-self-hosted-runner-group-for-enterprise": { + 'enterprise-admin/create-self-hosted-runner-group-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["runner-groups-enterprise"]; - }; - }; - }; + 'application/json': components['schemas']['runner-groups-enterprise'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Name of the runner group. */ - name: string; + name: string /** * @description Visibility of a runner group. You can select all organizations or select individual organization. Can be one of: `all` or `selected` * @enum {string} */ - visibility?: "selected" | "all"; + visibility?: 'selected' | 'all' /** @description List of organization IDs that can access the runner group. */ - selected_organization_ids?: number[]; + selected_organization_ids?: number[] /** @description List of runner IDs to add to the runner group. */ - runners?: number[]; + runners?: number[] /** @description Whether the runner group can be used by `public` repositories. */ - allows_public_repositories?: boolean; - }; - }; - }; - }; + allows_public_repositories?: boolean + } + } + } + } /** * Gets a specific self-hosted runner group for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/get-self-hosted-runner-group-for-enterprise": { + 'enterprise-admin/get-self-hosted-runner-group-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["runner-groups-enterprise"]; - }; - }; - }; - }; + 'application/json': components['schemas']['runner-groups-enterprise'] + } + } + } + } /** * Deletes a self-hosted runner group for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/delete-self-hosted-runner-group-from-enterprise": { + 'enterprise-admin/delete-self-hosted-runner-group-from-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Updates the `name` and `visibility` of a self-hosted runner group in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/update-self-hosted-runner-group-for-enterprise": { + 'enterprise-admin/update-self-hosted-runner-group-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["runner-groups-enterprise"]; - }; - }; - }; + 'application/json': components['schemas']['runner-groups-enterprise'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Name of the runner group. */ - name?: string; + name?: string /** * @description Visibility of a runner group. You can select all organizations or select individual organizations. Can be one of: `all` or `selected` * @default all * @enum {string} */ - visibility?: "selected" | "all"; + visibility?: 'selected' | 'all' /** @description Whether the runner group can be used by `public` repositories. */ - allows_public_repositories?: boolean; - }; - }; - }; - }; + allows_public_repositories?: boolean + } + } + } + } /** * Lists the organizations with access to a self-hosted runner group. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise": { + 'enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; + runner_group_id: components['parameters']['runner-group-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - organizations: components["schemas"]["organization-simple"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + organizations: components['schemas']['organization-simple'][] + } + } + } + } + } /** * Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise": { + 'enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description List of organization IDs that can access the runner group. */ - selected_organization_ids: number[]; - }; - }; - }; - }; + selected_organization_ids: number[] + } + } + } + } /** * Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise": { + 'enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components['parameters']['runner-group-id'] /** Unique identifier of an organization. */ - org_id: components["parameters"]["org-id"]; - }; - }; + org_id: components['parameters']['org-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise": { + 'enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components['parameters']['runner-group-id'] /** Unique identifier of an organization. */ - org_id: components["parameters"]["org-id"]; - }; - }; + org_id: components['parameters']['org-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Lists the self-hosted runners that are in a specific enterprise group. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise": { + 'enterprise-admin/list-self-hosted-runners-in-group-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; + runner_group_id: components['parameters']['runner-group-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - runners: components["schemas"]["runner"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + runners: components['schemas']['runner'][] + } + } + } + } + } /** * Replaces the list of self-hosted runners that are part of an enterprise runner group. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise": { + 'enterprise-admin/set-self-hosted-runners-in-group-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description List of runner IDs to add to the runner group. */ - runners: number[]; - }; - }; - }; - }; + runners: number[] + } + } + } + } /** * Adds a self-hosted runner to a runner group configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` * scope to use this endpoint. */ - "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise": { + 'enterprise-admin/add-self-hosted-runner-to-group-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components['parameters']['runner-group-id'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise": { + 'enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components['parameters']['runner-group-id'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Lists all self-hosted runners configured for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/list-self-hosted-runners-for-enterprise": { + 'enterprise-admin/list-self-hosted-runners-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; + enterprise: components['parameters']['enterprise'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count?: number; - runners?: components["schemas"]["runner"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count?: number + runners?: components['schemas']['runner'][] + } + } + } + } + } /** * Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/list-runner-applications-for-enterprise": { + 'enterprise-admin/list-runner-applications-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["runner-application"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['runner-application'][] + } + } + } + } /** * Returns a token that you can pass to the `config` script. The token expires after one hour. * @@ -19428,22 +19416,22 @@ export interface operations { * ./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN * ``` */ - "enterprise-admin/create-registration-token-for-enterprise": { + 'enterprise-admin/create-registration-token-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["authentication-token"]; - }; - }; - }; - }; + 'application/json': components['schemas']['authentication-token'] + } + } + } + } /** * Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour. * @@ -19458,161 +19446,161 @@ export interface operations { * ./config.sh remove --token TOKEN * ``` */ - "enterprise-admin/create-remove-token-for-enterprise": { + 'enterprise-admin/create-remove-token-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["authentication-token"]; - }; - }; - }; - }; + 'application/json': components['schemas']['authentication-token'] + } + } + } + } /** * Gets a specific self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/get-self-hosted-runner-for-enterprise": { + 'enterprise-admin/get-self-hosted-runner-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["runner"]; - }; - }; - }; - }; + 'application/json': components['schemas']['runner'] + } + } + } + } /** * Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/delete-self-hosted-runner-from-enterprise": { + 'enterprise-admin/delete-self-hosted-runner-from-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Lists all labels for a self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise": { + 'enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - }; - }; + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + } + } /** * Remove all previous custom labels and set the new custom labels for a specific * self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise": { + 'enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; - responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + runner_id: components['parameters']['runner-id'] + } + } + responses: { + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels. */ - labels: string[]; - }; - }; - }; - }; + labels: string[] + } + } + } + } /** * Add custom labels to a self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise": { + 'enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; - responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + runner_id: components['parameters']['runner-id'] + } + } + responses: { + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The names of the custom labels to add to the runner. */ - labels: string[]; - }; - }; - }; - }; + labels: string[] + } + } + } + } /** * Remove all custom labels from a self-hosted runner configured in an * enterprise. Returns the remaining read-only labels from the runner. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise": { + 'enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { - 200: components["responses"]["actions_runner_labels_readonly"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; - }; + 200: components['responses']['actions_runner_labels_readonly'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } + } /** * Remove a custom label from a self-hosted runner configured * in an enterprise. Returns the remaining labels from the runner. @@ -19622,33 +19610,33 @@ export interface operations { * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise": { + 'enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; + runner_id: components['parameters']['runner-id'] /** The name of a self-hosted runner's custom label. */ - name: components["parameters"]["runner-label-name"]; - }; - }; - responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; - }; + name: components['parameters']['runner-label-name'] + } + } + responses: { + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } + } /** Gets the audit log for an enterprise. To use this endpoint, you must be an enterprise admin, and you must use an access token with the `admin:enterprise` scope. */ - "enterprise-admin/get-audit-log": { + 'enterprise-admin/get-audit-log': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; + enterprise: components['parameters']['enterprise'] + } query: { /** A search phrase. For more information, see [Searching the audit log](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). */ - phrase?: components["parameters"]["audit-log-phrase"]; + phrase?: components['parameters']['audit-log-phrase'] /** * The event types to include: * @@ -19658,73 +19646,73 @@ export interface operations { * * The default is `web`. */ - include?: components["parameters"]["audit-log-include"]; + include?: components['parameters']['audit-log-include'] /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor. */ - after?: components["parameters"]["audit-log-after"]; + after?: components['parameters']['audit-log-after'] /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor. */ - before?: components["parameters"]["audit-log-before"]; + before?: components['parameters']['audit-log-before'] /** * The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. * * The default is `desc`. */ - order?: components["parameters"]["audit-log-order"]; + order?: components['parameters']['audit-log-order'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["audit-log-event"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['audit-log-event'][] + } + } + } + } /** * Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. * To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). */ - "secret-scanning/list-alerts-for-enterprise": { + 'secret-scanning/list-alerts-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; + enterprise: components['parameters']['enterprise'] + } query: { /** Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - state?: components["parameters"]["secret-scanning-alert-state"]; + state?: components['parameters']['secret-scanning-alert-state'] /** * A comma-separated list of secret types to return. By default all secret types are returned. * See "[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)" * for a complete list of secret types (API slug). */ - secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; + secret_type?: components['parameters']['secret-scanning-alert-secret-type'] /** A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - resolution?: components["parameters"]["secret-scanning-alert-resolution"]; + resolution?: components['parameters']['secret-scanning-alert-resolution'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor. */ - before?: components["parameters"]["pagination-before"]; + before?: components['parameters']['pagination-before'] /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor. */ - after?: components["parameters"]["pagination-after"]; - }; - }; + after?: components['parameters']['pagination-after'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["organization-secret-scanning-alert"][]; - }; - }; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': components['schemas']['organization-secret-scanning-alert'][] + } + } + 404: components['responses']['not_found'] + 503: components['responses']['service_unavailable'] + } + } /** * Gets the summary of the free and paid GitHub Actions minutes used. * @@ -19732,49 +19720,49 @@ export interface operations { * * The authenticated user must be an enterprise admin. */ - "billing/get-github-actions-billing-ghe": { + 'billing/get-github-actions-billing-ghe': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-billing-usage"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-billing-usage'] + } + } + } + } /** * Gets the GitHub Advanced Security active committers for an enterprise per repository. * Each distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of active_users for each repository. */ - "billing/get-github-advanced-security-billing-ghe": { + 'billing/get-github-advanced-security-billing-ghe': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; + enterprise: components['parameters']['enterprise'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Success */ 200: { content: { - "application/json": components["schemas"]["advanced-security-active-committers"]; - }; - }; - 403: components["responses"]["code_scanning_forbidden_read"]; - }; - }; + 'application/json': components['schemas']['advanced-security-active-committers'] + } + } + 403: components['responses']['code_scanning_forbidden_read'] + } + } /** * Gets the free and paid storage used for GitHub Packages in gigabytes. * @@ -19782,22 +19770,22 @@ export interface operations { * * The authenticated user must be an enterprise admin. */ - "billing/get-github-packages-billing-ghe": { + 'billing/get-github-packages-billing-ghe': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["packages-billing-usage"]; - }; - }; - }; - }; + 'application/json': components['schemas']['packages-billing-usage'] + } + } + } + } /** * Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. * @@ -19805,44 +19793,44 @@ export interface operations { * * The authenticated user must be an enterprise admin. */ - "billing/get-shared-storage-billing-ghe": { + 'billing/get-shared-storage-billing-ghe': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["combined-billing-usage"]; - }; - }; - }; - }; + 'application/json': components['schemas']['combined-billing-usage'] + } + } + } + } /** We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. */ - "activity/list-public-events": { + 'activity/list-public-events': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["event"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': components['schemas']['event'][] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 503: components['responses']['service_unavailable'] + } + } /** * GitHub provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user: * @@ -19856,71 +19844,71 @@ export interface operations { * * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ - "activity/get-feeds": { - parameters: {}; + 'activity/get-feeds': { + parameters: {} responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["feed"]; - }; - }; - }; - }; + 'application/json': components['schemas']['feed'] + } + } + } + } /** Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists: */ - "gists/list": { + 'gists/list': { parameters: { query: { /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["base-gist"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['base-gist'][] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + } + } /** * Allows you to add a new gist with one or more files. * * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. */ - "gists/create": { - parameters: {}; + 'gists/create': { + parameters: {} responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["gist-simple"]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['gist-simple'] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description Description of the gist * @example Example Ruby script */ - description?: string; + description?: string /** * @description Names and content for the files that make up the gist * @example [object Object] @@ -19928,478 +19916,478 @@ export interface operations { files: { [key: string]: { /** @description Content of the file */ - content: string; - }; - }; - public?: boolean | ("true" | "false"); - }; - }; - }; - }; + content: string + } + } + public?: boolean | ('true' | 'false') + } + } + } + } /** * List public gists sorted by most recently updated to least recently updated. * * Note: With [pagination](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. */ - "gists/list-public": { + 'gists/list-public': { parameters: { query: { /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["base-gist"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['base-gist'][] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } + } /** List the authenticated user's starred gists: */ - "gists/list-starred": { + 'gists/list-starred': { parameters: { query: { /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["base-gist"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; - "gists/get": { + 'application/json': components['schemas']['base-gist'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } + 'gists/get': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - }; - }; + gist_id: components['parameters']['gist-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["gist-simple"]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden_gist"]; - 404: components["responses"]["not_found"]; - }; - }; - "gists/delete": { + 'application/json': components['schemas']['gist-simple'] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden_gist'] + 404: components['responses']['not_found'] + } + } + 'gists/delete': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - }; - }; + gist_id: components['parameters']['gist-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged. */ - "gists/update": { + 'gists/update': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - }; - }; + gist_id: components['parameters']['gist-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["gist-simple"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['gist-simple'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description Description of the gist * @example Example Ruby script */ - description?: string; + description?: string /** * @description Names of files to be updated * @example [object Object] */ - files?: { [key: string]: Partial<{ [key: string]: unknown }> }; - } | null; - }; - }; - }; - "gists/list-comments": { + files?: { [key: string]: Partial<{ [key: string]: unknown }> } + } | null + } + } + } + 'gists/list-comments': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - }; + gist_id: components['parameters']['gist-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["gist-comment"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "gists/create-comment": { + 'application/json': components['schemas']['gist-comment'][] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'gists/create-comment': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - }; - }; + gist_id: components['parameters']['gist-id'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["gist-comment"]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['gist-comment'] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The comment text. * @example Body of the attachment */ - body: string; - }; - }; - }; - }; - "gists/get-comment": { + body: string + } + } + } + } + 'gists/get-comment': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; + gist_id: components['parameters']['gist-id'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["gist-comment"]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden_gist"]; - 404: components["responses"]["not_found"]; - }; - }; - "gists/delete-comment": { + 'application/json': components['schemas']['gist-comment'] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden_gist'] + 404: components['responses']['not_found'] + } + } + 'gists/delete-comment': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; + gist_id: components['parameters']['gist-id'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "gists/update-comment": { + 204: never + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'gists/update-comment': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; + gist_id: components['parameters']['gist-id'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["gist-comment"]; - }; - }; - 404: components["responses"]["not_found"]; - }; + 'application/json': components['schemas']['gist-comment'] + } + } + 404: components['responses']['not_found'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The comment text. * @example Body of the attachment */ - body: string; - }; - }; - }; - }; - "gists/list-commits": { + body: string + } + } + } + } + 'gists/list-commits': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - }; + gist_id: components['parameters']['gist-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { headers: { - Link?: string; - }; + Link?: string + } content: { - "application/json": components["schemas"]["gist-commit"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "gists/list-forks": { + 'application/json': components['schemas']['gist-commit'][] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'gists/list-forks': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - }; + gist_id: components['parameters']['gist-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["gist-simple"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['gist-simple'][] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** **Note**: This was previously `/gists/:gist_id/fork`. */ - "gists/fork": { + 'gists/fork': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - }; - }; + gist_id: components['parameters']['gist-id'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; + Location?: string + } content: { - "application/json": components["schemas"]["base-gist"]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "gists/check-is-starred": { + 'application/json': components['schemas']['base-gist'] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } + 'gists/check-is-starred': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - }; - }; + gist_id: components['parameters']['gist-id'] + } + } responses: { /** Response if gist is starred */ - 204: never; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; + 204: never + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] /** Not Found if gist is not starred */ 404: { content: { - "application/json": { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': { [key: string]: unknown } + } + } + } + } /** Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - "gists/star": { + 'gists/star': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - }; - }; + gist_id: components['parameters']['gist-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "gists/unstar": { + 204: never + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'gists/unstar': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - }; - }; + gist_id: components['parameters']['gist-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "gists/get-revision": { + 204: never + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'gists/get-revision': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - sha: string; - }; - }; + gist_id: components['parameters']['gist-id'] + sha: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["gist-simple"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['gist-simple'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** List all templates available to pass as an option when [creating a repository](https://docs.github.com/rest/reference/repos#create-a-repository-for-the-authenticated-user). */ - "gitignore/get-all-templates": { - parameters: {}; + 'gitignore/get-all-templates': { + parameters: {} responses: { /** Response */ 200: { content: { - "application/json": string[]; - }; - }; - 304: components["responses"]["not_modified"]; - }; - }; + 'application/json': string[] + } + } + 304: components['responses']['not_modified'] + } + } /** * The API also allows fetching the source of a single template. * Use the raw [media type](https://docs.github.com/rest/overview/media-types/) to get the raw contents. */ - "gitignore/get-template": { + 'gitignore/get-template': { parameters: { path: { - name: string; - }; - }; + name: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["gitignore-template"]; - }; - }; - 304: components["responses"]["not_modified"]; - }; - }; + 'application/json': components['schemas']['gitignore-template'] + } + } + 304: components['responses']['not_modified'] + } + } /** * List repositories that an app installation can access. * * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ - "apps/list-repos-accessible-to-installation": { + 'apps/list-repos-accessible-to-installation': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - repositories: components["schemas"]["repository"][]; + 'application/json': { + total_count: number + repositories: components['schemas']['repository'][] /** @example selected */ - repository_selection?: string; - }; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + repository_selection?: string + } + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** * Revokes the installation token you're using to authenticate as an installation and access this endpoint. * @@ -20407,13 +20395,13 @@ export interface operations { * * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ - "apps/revoke-installation-access-token": { - parameters: {}; + 'apps/revoke-installation-access-token': { + parameters: {} responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * List issues assigned to the authenticated user across all visible repositories including owned repositories, member * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not @@ -20425,7 +20413,7 @@ export interface operations { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - "issues/list": { + 'issues/list': { parameters: { query: { /** @@ -20436,465 +20424,465 @@ export interface operations { * \* `subscribed`: Issues you're subscribed to updates for * \* `all` or `repos`: All issues the authenticated user can see, regardless of participation or creation */ - filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all"; + filter?: 'assigned' | 'created' | 'mentioned' | 'subscribed' | 'repos' | 'all' /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ - state?: "open" | "closed" | "all"; + state?: 'open' | 'closed' | 'all' /** A list of comma separated label names. Example: `bug,ui,@high` */ - labels?: components["parameters"]["labels"]; + labels?: components['parameters']['labels'] /** What to sort results by. Can be either `created`, `updated`, `comments`. */ - sort?: "created" | "updated" | "comments"; + sort?: 'created' | 'updated' | 'comments' /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; - collab?: boolean; - orgs?: boolean; - owned?: boolean; - pulls?: boolean; + since?: components['parameters']['since'] + collab?: boolean + orgs?: boolean + owned?: boolean + pulls?: boolean /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["issue"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "licenses/get-all-commonly-used": { + 'application/json': components['schemas']['issue'][] + } + } + 304: components['responses']['not_modified'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } + 'licenses/get-all-commonly-used': { parameters: { query: { - featured?: boolean; + featured?: boolean /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["license-simple"][]; - }; - }; - 304: components["responses"]["not_modified"]; - }; - }; - "licenses/get": { + 'application/json': components['schemas']['license-simple'][] + } + } + 304: components['responses']['not_modified'] + } + } + 'licenses/get': { parameters: { path: { - license: string; - }; - }; + license: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["license"]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "markdown/render": { - parameters: {}; + 'application/json': components['schemas']['license'] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'markdown/render': { + parameters: {} responses: { /** Response */ 200: { headers: { - "Content-Length"?: string; - }; - content: { - "text/html": string; - }; - }; - 304: components["responses"]["not_modified"]; - }; + 'Content-Length'?: string + } + content: { + 'text/html': string + } + } + 304: components['responses']['not_modified'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The Markdown text to render in HTML. */ - text: string; + text: string /** * @description The rendering mode. Can be either `markdown` or `gfm`. * @default markdown * @example markdown * @enum {string} */ - mode?: "markdown" | "gfm"; + mode?: 'markdown' | 'gfm' /** @description The repository context to use when creating references in `gfm` mode. For example, setting `context` to `octo-org/octo-repo` will change the text `#42` into an HTML link to issue 42 in the `octo-org/octo-repo` repository. */ - context?: string; - }; - }; - }; - }; + context?: string + } + } + } + } /** You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less. */ - "markdown/render-raw": { - parameters: {}; + 'markdown/render-raw': { + parameters: {} responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "text/html": string; - }; - }; - 304: components["responses"]["not_modified"]; - }; + 'text/html': string + } + } + 304: components['responses']['not_modified'] + } requestBody: { content: { - "text/plain": string; - "text/x-markdown": string; - }; - }; - }; + 'text/plain': string + 'text/x-markdown': string + } + } + } /** * Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - "apps/get-subscription-plan-for-account": { + 'apps/get-subscription-plan-for-account': { parameters: { path: { /** account_id parameter */ - account_id: components["parameters"]["account-id"]; - }; - }; + account_id: components['parameters']['account-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["marketplace-purchase"]; - }; - }; - 401: components["responses"]["requires_authentication"]; + 'application/json': components['schemas']['marketplace-purchase'] + } + } + 401: components['responses']['requires_authentication'] /** Not Found when the account has not purchased the listing */ 404: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } + } + } /** * Lists all plans that are part of your GitHub Marketplace listing. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - "apps/list-plans": { + 'apps/list-plans': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["marketplace-listing-plan"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['marketplace-listing-plan'][] + } + } + 401: components['responses']['requires_authentication'] + 404: components['responses']['not_found'] + } + } /** * Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - "apps/list-accounts-for-plan": { + 'apps/list-accounts-for-plan': { parameters: { path: { /** plan_id parameter */ - plan_id: components["parameters"]["plan-id"]; - }; + plan_id: components['parameters']['plan-id'] + } query: { /** One of `created` (when the repository was starred) or `updated` (when it was last pushed to). */ - sort?: components["parameters"]["sort"]; + sort?: components['parameters']['sort'] /** To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter. */ - direction?: "asc" | "desc"; + direction?: 'asc' | 'desc' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["marketplace-purchase"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['marketplace-purchase'][] + } + } + 401: components['responses']['requires_authentication'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** * Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - "apps/get-subscription-plan-for-account-stubbed": { + 'apps/get-subscription-plan-for-account-stubbed': { parameters: { path: { /** account_id parameter */ - account_id: components["parameters"]["account-id"]; - }; - }; + account_id: components['parameters']['account-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["marketplace-purchase"]; - }; - }; - 401: components["responses"]["requires_authentication"]; + 'application/json': components['schemas']['marketplace-purchase'] + } + } + 401: components['responses']['requires_authentication'] /** Not Found when the account has not purchased the listing */ - 404: unknown; - }; - }; + 404: unknown + } + } /** * Lists all plans that are part of your GitHub Marketplace listing. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - "apps/list-plans-stubbed": { + 'apps/list-plans-stubbed': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["marketplace-listing-plan"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - }; - }; + 'application/json': components['schemas']['marketplace-listing-plan'][] + } + } + 401: components['responses']['requires_authentication'] + } + } /** * Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - "apps/list-accounts-for-plan-stubbed": { + 'apps/list-accounts-for-plan-stubbed': { parameters: { path: { /** plan_id parameter */ - plan_id: components["parameters"]["plan-id"]; - }; + plan_id: components['parameters']['plan-id'] + } query: { /** One of `created` (when the repository was starred) or `updated` (when it was last pushed to). */ - sort?: components["parameters"]["sort"]; + sort?: components['parameters']['sort'] /** To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter. */ - direction?: "asc" | "desc"; + direction?: 'asc' | 'desc' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["marketplace-purchase"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - }; - }; + 'application/json': components['schemas']['marketplace-purchase'][] + } + } + 401: components['responses']['requires_authentication'] + } + } /** * Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://docs.github.com/articles/about-github-s-ip-addresses/)." * * **Note:** The IP addresses shown in the documentation's response are only example values. You must always query the API directly to get the latest list of IP addresses. */ - "meta/get": { - parameters: {}; + 'meta/get': { + parameters: {} responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["api-overview"]; - }; - }; - 304: components["responses"]["not_modified"]; - }; - }; - "activity/list-public-events-for-repo-network": { + 'application/json': components['schemas']['api-overview'] + } + } + 304: components['responses']['not_modified'] + } + } + 'activity/list-public-events-for-repo-network': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["event"][]; - }; - }; - 301: components["responses"]["moved_permanently"]; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['event'][] + } + } + 301: components['responses']['moved_permanently'] + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** List all notifications for the current user, sorted by most recently updated. */ - "activity/list-notifications-for-authenticated-user": { + 'activity/list-notifications-for-authenticated-user': { parameters: { query: { /** If `true`, show notifications marked as read. */ - all?: components["parameters"]["all"]; + all?: components['parameters']['all'] /** If `true`, only shows notifications in which the user is directly participating or mentioned. */ - participating?: components["parameters"]["participating"]; + participating?: components['parameters']['participating'] /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - before?: components["parameters"]["before"]; + before?: components['parameters']['before'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["thread"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['thread'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } + } /** Marks all notifications as "read" removes it from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ - "activity/mark-notifications-as-read": { - parameters: {}; + 'activity/mark-notifications-as-read': { + parameters: {} responses: { /** Response */ 202: { content: { - "application/json": { - message?: string; - }; - }; - }; + 'application/json': { + message?: string + } + } + } /** Reset Content */ - 205: unknown; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; + 205: unknown + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * Format: date-time * @description Describes the last point that notifications were checked. */ - last_read_at?: string; + last_read_at?: string /** @description Whether the notification has been read. */ - read?: boolean; - }; - }; - }; - }; - "activity/get-thread": { + read?: boolean + } + } + } + } + 'activity/get-thread': { parameters: { path: { /** thread_id parameter */ - thread_id: components["parameters"]["thread-id"]; - }; - }; + thread_id: components['parameters']['thread-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["thread"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; - "activity/mark-thread-as-read": { + 'application/json': components['schemas']['thread'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } + 'activity/mark-thread-as-read': { parameters: { path: { /** thread_id parameter */ - thread_id: components["parameters"]["thread-id"]; - }; - }; + thread_id: components['parameters']['thread-id'] + } + } responses: { /** Reset Content */ - 205: unknown; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - }; - }; + 205: unknown + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + } + } /** * This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/rest/reference/activity#get-a-repository-subscription). * * Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. */ - "activity/get-thread-subscription-for-authenticated-user": { + 'activity/get-thread-subscription-for-authenticated-user': { parameters: { path: { /** thread_id parameter */ - thread_id: components["parameters"]["thread-id"]; - }; - }; + thread_id: components['parameters']['thread-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["thread-subscription"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['thread-subscription'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** * If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**. * @@ -20902,213 +20890,211 @@ export interface operations { * * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/rest/reference/activity#delete-a-thread-subscription) endpoint. */ - "activity/set-thread-subscription": { + 'activity/set-thread-subscription': { parameters: { path: { /** thread_id parameter */ - thread_id: components["parameters"]["thread-id"]; - }; - }; + thread_id: components['parameters']['thread-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["thread-subscription"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; + 'application/json': components['schemas']['thread-subscription'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Whether to block all notifications from a thread. */ - ignored?: boolean; - }; - }; - }; - }; + ignored?: boolean + } + } + } + } /** Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/rest/reference/activity#set-a-thread-subscription) endpoint and set `ignore` to `true`. */ - "activity/delete-thread-subscription": { + 'activity/delete-thread-subscription': { parameters: { path: { /** thread_id parameter */ - thread_id: components["parameters"]["thread-id"]; - }; - }; + thread_id: components['parameters']['thread-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** Get the octocat as ASCII art */ - "meta/get-octocat": { + 'meta/get-octocat': { parameters: { query: { /** The words to show in Octocat's speech bubble */ - s?: string; - }; - }; + s?: string + } + } responses: { /** Response */ 200: { content: { - "application/octocat-stream": string; - }; - }; - }; - }; + 'application/octocat-stream': string + } + } + } + } /** * Lists all organizations, in the order that they were created on GitHub. * * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of organizations. */ - "orgs/list": { + 'orgs/list': { parameters: { query: { /** An organization ID. Only return organizations with an ID greater than this ID. */ - since?: components["parameters"]["since-org"]; + since?: components['parameters']['since-org'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { headers: { - Link?: string; - }; + Link?: string + } content: { - "application/json": components["schemas"]["organization-simple"][]; - }; - }; - 304: components["responses"]["not_modified"]; - }; - }; + 'application/json': components['schemas']['organization-simple'][] + } + } + 304: components['responses']['not_modified'] + } + } /** * List the custom repository roles available in this organization. In order to see custom * repository roles in an organization, the authenticated user must be an organization owner. * * For more information on custom repository roles, see "[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)". */ - "orgs/list-custom-roles": { + 'orgs/list-custom-roles': { parameters: { path: { - organization_id: string; - }; - }; + organization_id: string + } + } responses: { /** Response - list of custom role names */ 200: { content: { - "application/json": { + 'application/json': { /** * @description The number of custom roles in this organization * @example 3 */ - total_count?: number; - custom_roles?: components["schemas"]["organization-custom-repository-role"][]; - }; - }; - }; - }; - }; + total_count?: number + custom_roles?: components['schemas']['organization-custom-repository-role'][] + } + } + } + } + } /** * Lists a connection between a team and an external group. * * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ - "teams/list-linked-external-idp-groups-to-team-for-org": { + 'teams/list-linked-external-idp-groups-to-team-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; - }; + team_slug: components['parameters']['team-slug'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["external-groups"]; - }; - }; - }; - }; + 'application/json': components['schemas']['external-groups'] + } + } + } + } /** * To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). * * GitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub plan. See "[Authenticating with GitHub Apps](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/)" for details. For an example response, see 'Response with GitHub plan information' below." */ - "orgs/get": { + 'orgs/get': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["organization-full"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['organization-full'] + } + } + 404: components['responses']['not_found'] + } + } /** * **Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). * * Enables an authenticated organization owner with the `admin:org` scope to update the organization's profile and member privileges. */ - "orgs/update": { + 'orgs/update': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["organization-full"]; - }; - }; - 409: components["responses"]["conflict"]; + 'application/json': components['schemas']['organization-full'] + } + } + 409: components['responses']['conflict'] /** Validation failed */ 422: { content: { - "application/json": - | components["schemas"]["validation-error"] - | components["schemas"]["validation-error-simple"]; - }; - }; - }; + 'application/json': components['schemas']['validation-error'] | components['schemas']['validation-error-simple'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Billing email address. This address is not publicized. */ - billing_email?: string; + billing_email?: string /** @description The company name. */ - company?: string; + company?: string /** @description The publicly visible email address. */ - email?: string; + email?: string /** @description The Twitter username of the company. */ - twitter_username?: string; + twitter_username?: string /** @description The location. */ - location?: string; + location?: string /** @description The shorthand name of the company. */ - name?: string; + name?: string /** @description The description of the company. */ - description?: string; + description?: string /** @description Toggles whether an organization can use organization projects. */ - has_organization_projects?: boolean; + has_organization_projects?: boolean /** @description Toggles whether repositories that belong to the organization can use repository projects. */ - has_repository_projects?: boolean; + has_repository_projects?: boolean /** * @description Default permission level members have for organization repositories: * \* `read` - can pull, but not push to or administer this repository. @@ -21118,7 +21104,7 @@ export interface operations { * @default read * @enum {string} */ - default_repository_permission?: "read" | "write" | "admin" | "none"; + default_repository_permission?: 'read' | 'write' | 'admin' | 'none' /** * @description Toggles the ability of non-admin organization members to create repositories. Can be one of: * \* `true` - all organization members can create repositories. @@ -21127,28 +21113,28 @@ export interface operations { * **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. * @default true */ - members_can_create_repositories?: boolean; + members_can_create_repositories?: boolean /** * @description Toggles whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. Can be one of: * \* `true` - all organization members can create internal repositories. * \* `false` - only organization owners can create internal repositories. * Default: `true`. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */ - members_can_create_internal_repositories?: boolean; + members_can_create_internal_repositories?: boolean /** * @description Toggles whether organization members can create private repositories, which are visible to organization members with permission. Can be one of: * \* `true` - all organization members can create private repositories. * \* `false` - only organization owners can create private repositories. * Default: `true`. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */ - members_can_create_private_repositories?: boolean; + members_can_create_private_repositories?: boolean /** * @description Toggles whether organization members can create public repositories, which are visible to anyone. Can be one of: * \* `true` - all organization members can create public repositories. * \* `false` - only organization owners can create public repositories. * Default: `true`. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */ - members_can_create_public_repositories?: boolean; + members_can_create_public_repositories?: boolean /** * @description Specifies which types of repositories non-admin organization members can create. Can be one of: * \* `all` - all organization members can create public and private repositories. @@ -21157,60 +21143,60 @@ export interface operations { * **Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details. * @enum {string} */ - members_allowed_repository_creation_type?: "all" | "private" | "none"; + members_allowed_repository_creation_type?: 'all' | 'private' | 'none' /** * @description Toggles whether organization members can create GitHub Pages sites. Can be one of: * \* `true` - all organization members can create GitHub Pages sites. * \* `false` - no organization members can create GitHub Pages sites. Existing published sites will not be impacted. * @default true */ - members_can_create_pages?: boolean; + members_can_create_pages?: boolean /** * @description Toggles whether organization members can create public GitHub Pages sites. Can be one of: * \* `true` - all organization members can create public GitHub Pages sites. * \* `false` - no organization members can create public GitHub Pages sites. Existing published sites will not be impacted. * @default true */ - members_can_create_public_pages?: boolean; + members_can_create_public_pages?: boolean /** * @description Toggles whether organization members can create private GitHub Pages sites. Can be one of: * \* `true` - all organization members can create private GitHub Pages sites. * \* `false` - no organization members can create private GitHub Pages sites. Existing published sites will not be impacted. * @default true */ - members_can_create_private_pages?: boolean; + members_can_create_private_pages?: boolean /** * @description Toggles whether organization members can fork private organization repositories. Can be one of: * \* `true` - all organization members can fork private repositories within the organization. * \* `false` - no organization members can fork private repositories within the organization. */ - members_can_fork_private_repositories?: boolean; + members_can_fork_private_repositories?: boolean /** @example "http://github.blog" */ - blog?: string; - }; - }; - }; - }; + blog?: string + } + } + } + } /** * Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - "actions/get-github-actions-permissions-organization": { + 'actions/get-github-actions-permissions-organization': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-organization-permissions"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-organization-permissions'] + } + } + } + } /** * Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization. * @@ -21218,132 +21204,132 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - "actions/set-github-actions-permissions-organization": { + 'actions/set-github-actions-permissions-organization': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { - enabled_repositories: components["schemas"]["enabled-repositories"]; - allowed_actions?: components["schemas"]["allowed-actions"]; - }; - }; - }; - }; + 'application/json': { + enabled_repositories: components['schemas']['enabled-repositories'] + allowed_actions?: components['schemas']['allowed-actions'] + } + } + } + } /** * Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - "actions/list-selected-repositories-enabled-github-actions-organization": { + 'actions/list-selected-repositories-enabled-github-actions-organization': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - repositories: components["schemas"]["repository"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + repositories: components['schemas']['repository'][] + } + } + } + } + } /** * Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - "actions/set-selected-repositories-enabled-github-actions-organization": { + 'actions/set-selected-repositories-enabled-github-actions-organization': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description List of repository IDs to enable for GitHub Actions. */ - selected_repository_ids: number[]; - }; - }; - }; - }; + selected_repository_ids: number[] + } + } + } + } /** * Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - "actions/enable-selected-repository-github-actions-organization": { + 'actions/enable-selected-repository-github-actions-organization': { parameters: { path: { - org: components["parameters"]["org"]; - repository_id: components["parameters"]["repository-id"]; - }; - }; + org: components['parameters']['org'] + repository_id: components['parameters']['repository-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - "actions/disable-selected-repository-github-actions-organization": { + 'actions/disable-selected-repository-github-actions-organization': { parameters: { path: { - org: components["parameters"]["org"]; - repository_id: components["parameters"]["repository-id"]; - }; - }; + org: components['parameters']['org'] + repository_id: components['parameters']['repository-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."" * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - "actions/get-allowed-actions-organization": { + 'actions/get-allowed-actions-organization': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["selected-actions"]; - }; - }; - }; - }; + 'application/json': components['schemas']['selected-actions'] + } + } + } + } /** * Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * @@ -21353,65 +21339,65 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - "actions/set-allowed-actions-organization": { + 'actions/set-allowed-actions-organization': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": components["schemas"]["selected-actions"]; - }; - }; - }; + 'application/json': components['schemas']['selected-actions'] + } + } + } /** * Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, * as well if GitHub Actions can submit approving pull request reviews. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - "actions/get-github-actions-default-workflow-permissions-organization": { + 'actions/get-github-actions-default-workflow-permissions-organization': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-get-default-workflow-permissions"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-get-default-workflow-permissions'] + } + } + } + } /** * Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions * can submit approving pull request reviews. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - "actions/set-github-actions-default-workflow-permissions-organization": { + 'actions/set-github-actions-default-workflow-permissions-organization': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": components["schemas"]["actions-set-default-workflow-permissions"]; - }; - }; - }; + 'application/json': components['schemas']['actions-set-default-workflow-permissions'] + } + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21419,30 +21405,30 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/list-self-hosted-runner-groups-for-org": { + 'actions/list-self-hosted-runner-groups-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - runner_groups: components["schemas"]["runner-groups-org"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + runner_groups: components['schemas']['runner-groups-org'][] + } + } + } + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21450,41 +21436,41 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/create-self-hosted-runner-group-for-org": { + 'actions/create-self-hosted-runner-group-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["runner-groups-org"]; - }; - }; - }; + 'application/json': components['schemas']['runner-groups-org'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Name of the runner group. */ - name: string; + name: string /** * @description Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories. Can be one of: `all`, `selected`, or `private`. * @default all * @enum {string} */ - visibility?: "selected" | "all" | "private"; + visibility?: 'selected' | 'all' | 'private' /** @description List of repository IDs that can access the runner group. */ - selected_repository_ids?: number[]; + selected_repository_ids?: number[] /** @description List of runner IDs to add to the runner group. */ - runners?: number[]; + runners?: number[] /** @description Whether the runner group can be used by `public` repositories. */ - allows_public_repositories?: boolean; - }; - }; - }; - }; + allows_public_repositories?: boolean + } + } + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21492,23 +21478,23 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/get-self-hosted-runner-group-for-org": { + 'actions/get-self-hosted-runner-group-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["runner-groups-org"]; - }; - }; - }; - }; + 'application/json': components['schemas']['runner-groups-org'] + } + } + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21516,19 +21502,19 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/delete-self-hosted-runner-group-from-org": { + 'actions/delete-self-hosted-runner-group-from-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21536,38 +21522,38 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/update-self-hosted-runner-group-for-org": { + 'actions/update-self-hosted-runner-group-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["runner-groups-org"]; - }; - }; - }; + 'application/json': components['schemas']['runner-groups-org'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Name of the runner group. */ - name: string; + name: string /** * @description Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories. Can be one of: `all`, `selected`, or `private`. * @enum {string} */ - visibility?: "selected" | "all" | "private"; + visibility?: 'selected' | 'all' | 'private' /** @description Whether the runner group can be used by `public` repositories. */ - allows_public_repositories?: boolean; - }; - }; - }; - }; + allows_public_repositories?: boolean + } + } + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21575,32 +21561,32 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/list-repo-access-to-self-hosted-runner-group-in-org": { + 'actions/list-repo-access-to-self-hosted-runner-group-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; + runner_group_id: components['parameters']['runner-group-id'] + } query: { /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - repositories: components["schemas"]["minimal-repository"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + repositories: components['schemas']['minimal-repository'][] + } + } + } + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21608,27 +21594,27 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/set-repo-access-to-self-hosted-runner-group-in-org": { + 'actions/set-repo-access-to-self-hosted-runner-group-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description List of repository IDs that can access the runner group. */ - selected_repository_ids: number[]; - }; - }; - }; - }; + selected_repository_ids: number[] + } + } + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21638,20 +21624,20 @@ export interface operations { * You must authenticate using an access token with the `admin:org` * scope to use this endpoint. */ - "actions/add-repo-access-to-self-hosted-runner-group-in-org": { + 'actions/add-repo-access-to-self-hosted-runner-group-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - repository_id: components["parameters"]["repository-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + repository_id: components['parameters']['repository-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21660,20 +21646,20 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/remove-repo-access-to-self-hosted-runner-group-in-org": { + 'actions/remove-repo-access-to-self-hosted-runner-group-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - repository_id: components["parameters"]["repository-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + repository_id: components['parameters']['repository-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21681,33 +21667,33 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/list-self-hosted-runners-in-group-for-org": { + 'actions/list-self-hosted-runners-in-group-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; + runner_group_id: components['parameters']['runner-group-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - runners: components["schemas"]["runner"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + runners: components['schemas']['runner'][] + } + } + } + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21715,27 +21701,27 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/set-self-hosted-runners-in-group-for-org": { + 'actions/set-self-hosted-runners-in-group-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description List of runner IDs to add to the runner group. */ - runners: number[]; - }; - }; - }; - }; + runners: number[] + } + } + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21745,21 +21731,21 @@ export interface operations { * You must authenticate using an access token with the `admin:org` * scope to use this endpoint. */ - "actions/add-self-hosted-runner-to-group-for-org": { + 'actions/add-self-hosted-runner-to-group-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components['parameters']['runner-group-id'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21768,71 +21754,71 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/remove-self-hosted-runner-from-group-for-org": { + 'actions/remove-self-hosted-runner-from-group-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components['parameters']['runner-group-id'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Lists all self-hosted runners configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/list-self-hosted-runners-for-org": { + 'actions/list-self-hosted-runners-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - runners: components["schemas"]["runner"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + runners: components['schemas']['runner'][] + } + } + } + } + } /** * Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/list-runner-applications-for-org": { + 'actions/list-runner-applications-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["runner-application"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['runner-application'][] + } + } + } + } /** * Returns a token that you can pass to the `config` script. The token expires after one hour. * @@ -21846,21 +21832,21 @@ export interface operations { * ./config.sh --url https://github.com/octo-org --token TOKEN * ``` */ - "actions/create-registration-token-for-org": { + 'actions/create-registration-token-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["authentication-token"]; - }; - }; - }; - }; + 'application/json': components['schemas']['authentication-token'] + } + } + } + } /** * Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour. * @@ -21875,153 +21861,153 @@ export interface operations { * ./config.sh remove --token TOKEN * ``` */ - "actions/create-remove-token-for-org": { + 'actions/create-remove-token-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["authentication-token"]; - }; - }; - }; - }; + 'application/json': components['schemas']['authentication-token'] + } + } + } + } /** * Gets a specific self-hosted runner configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/get-self-hosted-runner-for-org": { + 'actions/get-self-hosted-runner-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["runner"]; - }; - }; - }; - }; + 'application/json': components['schemas']['runner'] + } + } + } + } /** * Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/delete-self-hosted-runner-from-org": { + 'actions/delete-self-hosted-runner-from-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Lists all labels for a self-hosted runner configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/list-labels-for-self-hosted-runner-for-org": { + 'actions/list-labels-for-self-hosted-runner-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - }; - }; + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + } + } /** * Remove all previous custom labels and set the new custom labels for a specific * self-hosted runner configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/set-custom-labels-for-self-hosted-runner-for-org": { + 'actions/set-custom-labels-for-self-hosted-runner-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; - responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + runner_id: components['parameters']['runner-id'] + } + } + responses: { + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels. */ - labels: string[]; - }; - }; - }; - }; + labels: string[] + } + } + } + } /** * Add custom labels to a self-hosted runner configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/add-custom-labels-to-self-hosted-runner-for-org": { + 'actions/add-custom-labels-to-self-hosted-runner-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; - responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + runner_id: components['parameters']['runner-id'] + } + } + responses: { + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The names of the custom labels to add to the runner. */ - labels: string[]; - }; - }; - }; - }; + labels: string[] + } + } + } + } /** * Remove all custom labels from a self-hosted runner configured in an * organization. Returns the remaining read-only labels from the runner. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/remove-all-custom-labels-from-self-hosted-runner-for-org": { + 'actions/remove-all-custom-labels-from-self-hosted-runner-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { - 200: components["responses"]["actions_runner_labels_readonly"]; - 404: components["responses"]["not_found"]; - }; - }; + 200: components['responses']['actions_runner_labels_readonly'] + 404: components['responses']['not_found'] + } + } /** * Remove a custom label from a self-hosted runner configured * in an organization. Returns the remaining labels from the runner. @@ -22031,82 +22017,82 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/remove-custom-label-from-self-hosted-runner-for-org": { + 'actions/remove-custom-label-from-self-hosted-runner-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; + runner_id: components['parameters']['runner-id'] /** The name of a self-hosted runner's custom label. */ - name: components["parameters"]["runner-label-name"]; - }; - }; - responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; - }; + name: components['parameters']['runner-label-name'] + } + } + responses: { + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } + } /** Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - "actions/list-org-secrets": { + 'actions/list-org-secrets': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - secrets: components["schemas"]["organization-actions-secret"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + secrets: components['schemas']['organization-actions-secret'][] + } + } + } + } + } /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - "actions/get-org-public-key": { + 'actions/get-org-public-key': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-public-key"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-public-key'] + } + } + } + } /** Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - "actions/get-org-secret": { + 'actions/get-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["organization-actions-secret"]; - }; - }; - }; - }; + 'application/json': components['schemas']['organization-actions-secret'] + } + } + } + } /** * Creates or updates an organization secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -22184,31 +22170,31 @@ export interface operations { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - "actions/create-or-update-org-secret": { + 'actions/create-or-update-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response when creating a secret */ 201: { content: { - "application/json": components["schemas"]["empty-object"]; - }; - }; + 'application/json': components['schemas']['empty-object'] + } + } /** Response when updating a secret */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/reference/actions#get-an-organization-public-key) endpoint. */ - encrypted_value?: string; + encrypted_value?: string /** @description ID of the key you used to encrypt the secret. */ - key_id?: string; + key_id?: string /** * @description Configures the access that repositories have to the organization secret. Can be one of: * \- `all` - All repositories in an organization can access the secret. @@ -22216,123 +22202,123 @@ export interface operations { * \- `selected` - Only specific repositories can access the secret. * @enum {string} */ - visibility: "all" | "private" | "selected"; + visibility: 'all' | 'private' | 'selected' /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/reference/actions#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/actions#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints. */ - selected_repository_ids?: string[]; - }; - }; - }; - }; + selected_repository_ids?: string[] + } + } + } + } /** Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - "actions/delete-org-secret": { + 'actions/delete-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - "actions/list-selected-repos-for-org-secret": { + 'actions/list-selected-repos-for-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; + secret_name: components['parameters']['secret-name'] + } query: { /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - repositories: components["schemas"]["minimal-repository"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + repositories: components['schemas']['minimal-repository'][] + } + } + } + } + } /** Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - "actions/set-selected-repos-for-org-secret": { + 'actions/set-selected-repos-for-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/actions#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints. */ - selected_repository_ids: number[]; - }; - }; - }; - }; + selected_repository_ids: number[] + } + } + } + } /** Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - "actions/add-selected-repo-to-org-secret": { + 'actions/add-selected-repo-to-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - repository_id: number; - }; - }; + secret_name: components['parameters']['secret-name'] + repository_id: number + } + } responses: { /** No Content when repository was added to the selected list */ - 204: never; + 204: never /** Conflict when visibility type is not set to selected */ - 409: unknown; - }; - }; + 409: unknown + } + } /** Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - "actions/remove-selected-repo-from-org-secret": { + 'actions/remove-selected-repo-from-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - repository_id: number; - }; - }; + secret_name: components['parameters']['secret-name'] + repository_id: number + } + } responses: { /** Response when repository was removed from the selected list */ - 204: never; + 204: never /** Conflict when visibility type not set to selected */ - 409: unknown; - }; - }; + 409: unknown + } + } /** * Gets the audit log for an organization. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization)." * * This endpoint is available for organizations on GitHub Enterprise Cloud. To use this endpoint, you must be an organization owner, and you must use an access token with the `admin:org` scope. GitHub Apps must have the `organization_administration` read permission to use this endpoint. */ - "orgs/get-audit-log": { + 'orgs/get-audit-log': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** A search phrase. For more information, see [Searching the audit log](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). */ - phrase?: components["parameters"]["audit-log-phrase"]; + phrase?: components['parameters']['audit-log-phrase'] /** * The event types to include: * @@ -22342,90 +22328,90 @@ export interface operations { * * The default is `web`. */ - include?: components["parameters"]["audit-log-include"]; + include?: components['parameters']['audit-log-include'] /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor. */ - after?: components["parameters"]["audit-log-after"]; + after?: components['parameters']['audit-log-after'] /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor. */ - before?: components["parameters"]["audit-log-before"]; + before?: components['parameters']['audit-log-before'] /** * The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. * * The default is `desc`. */ - order?: components["parameters"]["audit-log-order"]; + order?: components['parameters']['audit-log-order'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["audit-log-event"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['audit-log-event'][] + } + } + } + } /** List the users blocked by an organization. */ - "orgs/list-blocked-users": { + 'orgs/list-blocked-users': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 415: components["responses"]["preview_header_missing"]; - }; - }; - "orgs/check-blocked-user": { + 'application/json': components['schemas']['simple-user'][] + } + } + 415: components['responses']['preview_header_missing'] + } + } + 'orgs/check-blocked-user': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** If the user is blocked: */ - 204: never; + 204: never /** If the user is not blocked: */ 404: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - }; - }; - "orgs/block-user": { + 'application/json': components['schemas']['basic-error'] + } + } + } + } + 'orgs/block-user': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 422: components["responses"]["validation_failed"]; - }; - }; - "orgs/unblock-user": { + 204: never + 422: components['responses']['validation_failed'] + } + } + 'orgs/unblock-user': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Lists all code scanning alerts for the default branch (usually `main` * or `master`) for all eligible repositories in an organization. @@ -22433,147 +22419,147 @@ export interface operations { * * GitHub Apps must have the `security_events` read permission to use this endpoint. */ - "code-scanning/list-alerts-for-org": { + 'code-scanning/list-alerts-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor. */ - before?: components["parameters"]["pagination-before"]; + before?: components['parameters']['pagination-before'] /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor. */ - after?: components["parameters"]["pagination-after"]; + after?: components['parameters']['pagination-after'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Set to `open`, `closed, `fixed`, or `dismissed` to list code scanning alerts in a specific state. */ - state?: components["schemas"]["code-scanning-alert-state"]; + state?: components['schemas']['code-scanning-alert-state'] /** Can be one of `created`, `updated`. */ - sort?: "created" | "updated"; - }; - }; + sort?: 'created' | 'updated' + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["code-scanning-organization-alert-items"][]; - }; - }; - 403: components["responses"]["code_scanning_forbidden_read"]; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': components['schemas']['code-scanning-organization-alert-items'][] + } + } + 403: components['responses']['code_scanning_forbidden_read'] + 404: components['responses']['not_found'] + 503: components['responses']['service_unavailable'] + } + } /** * Listing and deleting credential authorizations is available to organizations with GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products). * * An authenticated organization owner with the `read:org` scope can list all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials are either personal access tokens or SSH keys that organization members have authorized for the organization. For more information, see [About authentication with SAML single sign-on](https://docs.github.com/en/articles/about-authentication-with-saml-single-sign-on). */ - "orgs/list-saml-sso-authorizations": { + 'orgs/list-saml-sso-authorizations': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page token */ - page?: number; + page?: number /** Limits the list of credentials authorizations for an organization to a specific login */ - login?: string; - }; - }; + login?: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["credential-authorization"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['credential-authorization'][] + } + } + } + } /** * Listing and deleting credential authorizations is available to organizations with GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products). * * An authenticated organization owner with the `admin:org` scope can remove a credential authorization for an organization that uses SAML SSO. Once you remove someone's credential authorization, they will need to create a new personal access token or SSH key and authorize it for the organization they want to access. */ - "orgs/remove-saml-sso-authorization": { + 'orgs/remove-saml-sso-authorization': { parameters: { path: { - org: components["parameters"]["org"]; - credential_id: number; - }; - }; + org: components['parameters']['org'] + credential_id: number + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - "dependabot/list-org-secrets": { + 'dependabot/list-org-secrets': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - secrets: components["schemas"]["organization-dependabot-secret"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + secrets: components['schemas']['organization-dependabot-secret'][] + } + } + } + } + } /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - "dependabot/get-org-public-key": { + 'dependabot/get-org-public-key': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["dependabot-public-key"]; - }; - }; - }; - }; + 'application/json': components['schemas']['dependabot-public-key'] + } + } + } + } /** Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - "dependabot/get-org-secret": { + 'dependabot/get-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["organization-dependabot-secret"]; - }; - }; - }; - }; + 'application/json': components['schemas']['organization-dependabot-secret'] + } + } + } + } /** * Creates or updates an organization secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -22651,31 +22637,31 @@ export interface operations { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - "dependabot/create-or-update-org-secret": { + 'dependabot/create-or-update-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response when creating a secret */ 201: { content: { - "application/json": components["schemas"]["empty-object"]; - }; - }; + 'application/json': components['schemas']['empty-object'] + } + } /** Response when updating a secret */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/reference/dependabot#get-an-organization-public-key) endpoint. */ - encrypted_value?: string; + encrypted_value?: string /** @description ID of the key you used to encrypt the secret. */ - key_id?: string; + key_id?: string /** * @description Configures the access that repositories have to the organization secret. Can be one of: * \- `all` - All repositories in an organization can access the secret. @@ -22683,631 +22669,630 @@ export interface operations { * \- `selected` - Only specific repositories can access the secret. * @enum {string} */ - visibility: "all" | "private" | "selected"; + visibility: 'all' | 'private' | 'selected' /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/reference/dependabot#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/dependabot#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/dependabot#remove-selected-repository-from-an-organization-secret) endpoints. */ - selected_repository_ids?: string[]; - }; - }; - }; - }; + selected_repository_ids?: string[] + } + } + } + } /** Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - "dependabot/delete-org-secret": { + 'dependabot/delete-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - "dependabot/list-selected-repos-for-org-secret": { + 'dependabot/list-selected-repos-for-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; + secret_name: components['parameters']['secret-name'] + } query: { /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - repositories: components["schemas"]["minimal-repository"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + repositories: components['schemas']['minimal-repository'][] + } + } + } + } + } /** Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - "dependabot/set-selected-repos-for-org-secret": { + 'dependabot/set-selected-repos-for-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/dependabot#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/dependabot#remove-selected-repository-from-an-organization-secret) endpoints. */ - selected_repository_ids: number[]; - }; - }; - }; - }; + selected_repository_ids: number[] + } + } + } + } /** Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - "dependabot/add-selected-repo-to-org-secret": { + 'dependabot/add-selected-repo-to-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - repository_id: number; - }; - }; + secret_name: components['parameters']['secret-name'] + repository_id: number + } + } responses: { /** No Content when repository was added to the selected list */ - 204: never; + 204: never /** Conflict when visibility type is not set to selected */ - 409: unknown; - }; - }; + 409: unknown + } + } /** Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - "dependabot/remove-selected-repo-from-org-secret": { + 'dependabot/remove-selected-repo-from-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - repository_id: number; - }; - }; + secret_name: components['parameters']['secret-name'] + repository_id: number + } + } responses: { /** Response when repository was removed from the selected list */ - 204: never; + 204: never /** Conflict when visibility type not set to selected */ - 409: unknown; - }; - }; - "activity/list-public-org-events": { + 409: unknown + } + } + 'activity/list-public-org-events': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["event"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['event'][] + } + } + } + } /** * Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to. * * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ - "teams/external-idp-group-info-for-org": { + 'teams/external-idp-group-info-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** group_id parameter */ - group_id: components["parameters"]["group-id"]; - }; - }; + group_id: components['parameters']['group-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["external-group"]; - }; - }; - }; - }; + 'application/json': components['schemas']['external-group'] + } + } + } + } /** * Lists external groups available in an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." * * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ - "teams/list-external-idp-groups-for-org": { + 'teams/list-external-idp-groups-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page token */ - page?: number; + page?: number /** Limits the list to groups containing the text in the group name */ - display_name?: string; - }; - }; + display_name?: string + } + } responses: { /** Response */ 200: { headers: { - Link?: string; - }; - content: { - "application/json": components["schemas"]["external-groups"]; - }; - }; - }; - }; + Link?: string + } + content: { + 'application/json': components['schemas']['external-groups'] + } + } + } + } /** The return hash contains `failed_at` and `failed_reason` fields which represent the time at which the invitation failed and the reason for the failure. */ - "orgs/list-failed-invitations": { + 'orgs/list-failed-invitations': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["organization-invitation"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "orgs/list-webhooks": { + 'application/json': components['schemas']['organization-invitation'][] + } + } + 404: components['responses']['not_found'] + } + } + 'orgs/list-webhooks': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["org-hook"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['org-hook'][] + } + } + 404: components['responses']['not_found'] + } + } /** Here's how you can create a hook that posts payloads in JSON format: */ - "orgs/create-webhook": { + 'orgs/create-webhook': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["org-hook"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['org-hook'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Must be passed as "web". */ - name: string; + name: string /** @description Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/orgs#create-hook-config-params). */ config: { - url: components["schemas"]["webhook-config-url"]; - content_type?: components["schemas"]["webhook-config-content-type"]; - secret?: components["schemas"]["webhook-config-secret"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + url: components['schemas']['webhook-config-url'] + content_type?: components['schemas']['webhook-config-content-type'] + secret?: components['schemas']['webhook-config-secret'] + insecure_ssl?: components['schemas']['webhook-config-insecure-ssl'] /** @example "kdaigle" */ - username?: string; + username?: string /** @example "password" */ - password?: string; - }; + password?: string + } /** * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. * @default push */ - events?: string[]; + events?: string[] /** * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. * @default true */ - active?: boolean; - }; - }; - }; - }; + active?: boolean + } + } + } + } /** Returns a webhook configured in an organization. To get only the webhook `config` properties, see "[Get a webhook configuration for an organization](/rest/reference/orgs#get-a-webhook-configuration-for-an-organization)." */ - "orgs/get-webhook": { + 'orgs/get-webhook': { parameters: { path: { - org: components["parameters"]["org"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + org: components['parameters']['org'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["org-hook"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "orgs/delete-webhook": { + 'application/json': components['schemas']['org-hook'] + } + } + 404: components['responses']['not_found'] + } + } + 'orgs/delete-webhook': { parameters: { path: { - org: components["parameters"]["org"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + org: components['parameters']['org'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for an organization](/rest/reference/orgs#update-a-webhook-configuration-for-an-organization)." */ - "orgs/update-webhook": { + 'orgs/update-webhook': { parameters: { path: { - org: components["parameters"]["org"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + org: components['parameters']['org'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["org-hook"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['org-hook'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/orgs#update-hook-config-params). */ config?: { - url: components["schemas"]["webhook-config-url"]; - content_type?: components["schemas"]["webhook-config-content-type"]; - secret?: components["schemas"]["webhook-config-secret"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - }; + url: components['schemas']['webhook-config-url'] + content_type?: components['schemas']['webhook-config-content-type'] + secret?: components['schemas']['webhook-config-secret'] + insecure_ssl?: components['schemas']['webhook-config-insecure-ssl'] + } /** * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. * @default push */ - events?: string[]; + events?: string[] /** * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. * @default true */ - active?: boolean; + active?: boolean /** @example "web" */ - name?: string; - }; - }; - }; - }; + name?: string + } + } + } + } /** * Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/reference/orgs#get-an-organization-webhook)." * * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission. */ - "orgs/get-webhook-config-for-org": { + 'orgs/get-webhook-config-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + org: components['parameters']['org'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["webhook-config"]; - }; - }; - }; - }; + 'application/json': components['schemas']['webhook-config'] + } + } + } + } /** * Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/reference/orgs#update-an-organization-webhook)." * * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission. */ - "orgs/update-webhook-config-for-org": { + 'orgs/update-webhook-config-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + org: components['parameters']['org'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["webhook-config"]; - }; - }; - }; + 'application/json': components['schemas']['webhook-config'] + } + } + } requestBody: { content: { - "application/json": { - url?: components["schemas"]["webhook-config-url"]; - content_type?: components["schemas"]["webhook-config-content-type"]; - secret?: components["schemas"]["webhook-config-secret"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - }; - }; - }; - }; + 'application/json': { + url?: components['schemas']['webhook-config-url'] + content_type?: components['schemas']['webhook-config-content-type'] + secret?: components['schemas']['webhook-config-secret'] + insecure_ssl?: components['schemas']['webhook-config-insecure-ssl'] + } + } + } + } /** Returns a list of webhook deliveries for a webhook configured in an organization. */ - "orgs/list-webhook-deliveries": { + 'orgs/list-webhook-deliveries': { parameters: { path: { - org: components["parameters"]["org"]; - hook_id: components["parameters"]["hook-id"]; - }; + org: components['parameters']['org'] + hook_id: components['parameters']['hook-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ - cursor?: components["parameters"]["cursor"]; - }; - }; + cursor?: components['parameters']['cursor'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["hook-delivery-item"][]; - }; - }; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['hook-delivery-item'][] + } + } + 400: components['responses']['bad_request'] + 422: components['responses']['validation_failed'] + } + } /** Returns a delivery for a webhook configured in an organization. */ - "orgs/get-webhook-delivery": { + 'orgs/get-webhook-delivery': { parameters: { path: { - org: components["parameters"]["org"]; - hook_id: components["parameters"]["hook-id"]; - delivery_id: components["parameters"]["delivery-id"]; - }; - }; + org: components['parameters']['org'] + hook_id: components['parameters']['hook-id'] + delivery_id: components['parameters']['delivery-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["hook-delivery"]; - }; - }; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['hook-delivery'] + } + } + 400: components['responses']['bad_request'] + 422: components['responses']['validation_failed'] + } + } /** Redeliver a delivery for a webhook configured in an organization. */ - "orgs/redeliver-webhook-delivery": { + 'orgs/redeliver-webhook-delivery': { parameters: { path: { - org: components["parameters"]["org"]; - hook_id: components["parameters"]["hook-id"]; - delivery_id: components["parameters"]["delivery-id"]; - }; - }; + org: components['parameters']['org'] + hook_id: components['parameters']['hook-id'] + delivery_id: components['parameters']['delivery-id'] + } + } responses: { - 202: components["responses"]["accepted"]; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 202: components['responses']['accepted'] + 400: components['responses']['bad_request'] + 422: components['responses']['validation_failed'] + } + } /** This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. */ - "orgs/ping-webhook": { + 'orgs/ping-webhook': { parameters: { path: { - org: components["parameters"]["org"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + org: components['parameters']['org'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** * Enables an authenticated GitHub App to find the organization's installation information. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/get-org-installation": { + 'apps/get-org-installation': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["installation"]; - }; - }; - }; - }; + 'application/json': components['schemas']['installation'] + } + } + } + } /** Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint. */ - "orgs/list-app-installations": { + 'orgs/list-app-installations': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - installations: components["schemas"]["installation"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + installations: components['schemas']['installation'][] + } + } + } + } + } /** Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response. */ - "interactions/get-restrictions-for-org": { + 'interactions/get-restrictions-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": Partial & - Partial<{ [key: string]: unknown }>; - }; - }; - }; - }; + 'application/json': Partial & Partial<{ [key: string]: unknown }> + } + } + } + } /** Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization. */ - "interactions/set-restrictions-for-org": { + 'interactions/set-restrictions-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["interaction-limit-response"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['interaction-limit-response'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": components["schemas"]["interaction-limit"]; - }; - }; - }; + 'application/json': components['schemas']['interaction-limit'] + } + } + } /** Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions. */ - "interactions/remove-restrictions-for-org": { + 'interactions/remove-restrictions-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. */ - "orgs/list-pending-invitations": { + 'orgs/list-pending-invitations': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["organization-invitation"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['organization-invitation'][] + } + } + 404: components['responses']['not_found'] + } + } /** * Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - "orgs/create-invitation": { + 'orgs/create-invitation': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["organization-invitation"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['organization-invitation'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description **Required unless you provide `email`**. GitHub user ID for the person you are inviting. */ - invitee_id?: number; + invitee_id?: number /** @description **Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user. */ - email?: string; + email?: string /** * @description Specify role for new member. Can be one of: * \* `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. @@ -23316,59 +23301,59 @@ export interface operations { * @default direct_member * @enum {string} */ - role?: "admin" | "direct_member" | "billing_manager"; + role?: 'admin' | 'direct_member' | 'billing_manager' /** @description Specify IDs for the teams you want to invite new members to. */ - team_ids?: number[]; - }; - }; - }; - }; + team_ids?: number[] + } + } + } + } /** * Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). */ - "orgs/cancel-invitation": { + 'orgs/cancel-invitation': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** invitation_id parameter */ - invitation_id: components["parameters"]["invitation-id"]; - }; - }; + invitation_id: components['parameters']['invitation-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner. */ - "orgs/list-invitation-teams": { + 'orgs/list-invitation-teams': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** invitation_id parameter */ - invitation_id: components["parameters"]["invitation-id"]; - }; + invitation_id: components['parameters']['invitation-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['team'][] + } + } + 404: components['responses']['not_found'] + } + } /** * List issues in an organization assigned to the authenticated user. * @@ -23377,11 +23362,11 @@ export interface operations { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - "issues/list-for-org": { + 'issues/list-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** * Indicates which sorts of issues to return. Can be one of: @@ -23391,123 +23376,123 @@ export interface operations { * \* `subscribed`: Issues you're subscribed to updates for * \* `all` or `repos`: All issues the authenticated user can see, regardless of participation or creation */ - filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all"; + filter?: 'assigned' | 'created' | 'mentioned' | 'subscribed' | 'repos' | 'all' /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ - state?: "open" | "closed" | "all"; + state?: 'open' | 'closed' | 'all' /** A list of comma separated label names. Example: `bug,ui,@high` */ - labels?: components["parameters"]["labels"]; + labels?: components['parameters']['labels'] /** What to sort results by. Can be either `created`, `updated`, `comments`. */ - sort?: "created" | "updated" | "comments"; + sort?: 'created' | 'updated' | 'comments' /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["issue"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['issue'][] + } + } + 404: components['responses']['not_found'] + } + } /** List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned. */ - "orgs/list-members": { + 'orgs/list-members': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** * Filter members returned in the list. Can be one of: * \* `2fa_disabled` - Members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. Available for organization owners. * \* `all` - All members the authenticated user can see. */ - filter?: "2fa_disabled" | "all"; + filter?: '2fa_disabled' | 'all' /** * Filter members returned by their role. Can be one of: * \* `all` - All members of the organization, regardless of role. * \* `admin` - Organization owners. * \* `member` - Non-owner organization members. */ - role?: "all" | "admin" | "member"; + role?: 'all' | 'admin' | 'member' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; + 'application/json': components['schemas']['simple-user'][] + } + } /** Response if requester is not an organization member */ - 302: never; - 422: components["responses"]["validation_failed"]; - }; - }; + 302: never + 422: components['responses']['validation_failed'] + } + } /** Check if a user is, publicly or privately, a member of the organization. */ - "orgs/check-membership-for-user": { + 'orgs/check-membership-for-user': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** Response if requester is an organization member and user is a member */ - 204: never; + 204: never /** Response if requester is not an organization member */ - 302: never; + 302: never /** Not Found if requester is an organization member and user is not a member */ - 404: unknown; - }; - }; + 404: unknown + } + } /** Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories. */ - "orgs/remove-member": { + 'orgs/remove-member': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 403: components["responses"]["forbidden"]; - }; - }; + 204: never + 403: components['responses']['forbidden'] + } + } /** In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status. */ - "orgs/get-membership-for-user": { + 'orgs/get-membership-for-user': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["org-membership"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['org-membership'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Only authenticated organization owners can add a member to the organization or update the member's role. * @@ -23519,26 +23504,26 @@ export interface operations { * * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. */ - "orgs/set-membership-for-user": { + 'orgs/set-membership-for-user': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["org-membership"]; - }; - }; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['org-membership'] + } + } + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The role to give the user in the organization. Can be one of: * \* `admin` - The user will become an owner of the organization. @@ -23546,102 +23531,102 @@ export interface operations { * @default member * @enum {string} */ - role?: "admin" | "member"; - }; - }; - }; - }; + role?: 'admin' | 'member' + } + } + } + } /** * In order to remove a user's membership with an organization, the authenticated user must be an organization owner. * * If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases. */ - "orgs/remove-membership-for-user": { + 'orgs/remove-membership-for-user': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Lists the most recent migrations. */ - "migrations/list-for-org": { + 'migrations/list-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Exclude attributes from the API response to improve performance */ - exclude?: "repositories"[]; - }; - }; + exclude?: 'repositories'[] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["migration"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['migration'][] + } + } + } + } /** Initiates the generation of a migration archive. */ - "migrations/start-for-org": { + 'migrations/start-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["migration"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['migration'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description A list of arrays indicating which repositories should be migrated. */ - repositories: string[]; + repositories: string[] /** * @description Indicates whether repositories should be locked (to prevent manipulation) while migrating data. * @example true */ - lock_repositories?: boolean; + lock_repositories?: boolean /** * @description Indicates whether attachments should be excluded from the migration (to reduce migration archive file size). * @example true */ - exclude_attachments?: boolean; + exclude_attachments?: boolean /** * @description Indicates whether releases should be excluded from the migration (to reduce migration archive file size). * @example true */ - exclude_releases?: boolean; + exclude_releases?: boolean /** * @description Indicates whether projects owned by the organization or users should be excluded. from the migration. * @example true */ - exclude_owner_projects?: boolean; - exclude?: "repositories"[]; - }; - }; - }; - }; + exclude_owner_projects?: boolean + exclude?: 'repositories'[] + } + } + } + } /** * Fetches the status of a migration. * @@ -23652,18 +23637,18 @@ export interface operations { * * `exported`, which means the migration finished successfully. * * `failed`, which means the migration failed. */ - "migrations/get-status-for-org": { + 'migrations/get-status-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** migration_id parameter */ - migration_id: components["parameters"]["migration-id"]; - }; + migration_id: components['parameters']['migration-id'] + } query: { /** Exclude attributes from the API response to improve performance */ - exclude?: "repositories"[]; - }; - }; + exclude?: 'repositories'[] + } + } responses: { /** * * `pending`, which means the migration hasn't started yet. @@ -23673,212 +23658,212 @@ export interface operations { */ 200: { content: { - "application/json": components["schemas"]["migration"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['migration'] + } + } + 404: components['responses']['not_found'] + } + } /** Fetches the URL to a migration archive. */ - "migrations/download-archive-for-org": { + 'migrations/download-archive-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** migration_id parameter */ - migration_id: components["parameters"]["migration-id"]; - }; - }; + migration_id: components['parameters']['migration-id'] + } + } responses: { /** Response */ - 302: never; - 404: components["responses"]["not_found"]; - }; - }; + 302: never + 404: components['responses']['not_found'] + } + } /** Deletes a previous migration archive. Migration archives are automatically deleted after seven days. */ - "migrations/delete-archive-for-org": { + 'migrations/delete-archive-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** migration_id parameter */ - migration_id: components["parameters"]["migration-id"]; - }; - }; + migration_id: components['parameters']['migration-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/rest/reference/repos#delete-a-repository) when the migration is complete and you no longer need the source data. */ - "migrations/unlock-repo-for-org": { + 'migrations/unlock-repo-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** migration_id parameter */ - migration_id: components["parameters"]["migration-id"]; + migration_id: components['parameters']['migration-id'] /** repo_name parameter */ - repo_name: components["parameters"]["repo-name"]; - }; - }; + repo_name: components['parameters']['repo-name'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** List all the repositories for this organization migration. */ - "migrations/list-repos-for-org": { + 'migrations/list-repos-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** migration_id parameter */ - migration_id: components["parameters"]["migration-id"]; - }; + migration_id: components['parameters']['migration-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["minimal-repository"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['minimal-repository'][] + } + } + 404: components['responses']['not_found'] + } + } /** List all users who are outside collaborators of an organization. */ - "orgs/list-outside-collaborators": { + 'orgs/list-outside-collaborators': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** * Filter the list of outside collaborators. Can be one of: * \* `2fa_disabled`: Outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. * \* `all`: All outside collaborators. */ - filter?: "2fa_disabled" | "all"; + filter?: '2fa_disabled' | 'all' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + } + } /** When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://docs.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)". */ - "orgs/convert-member-to-outside-collaborator": { + 'orgs/convert-member-to-outside-collaborator': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** User is getting converted asynchronously */ 202: { content: { - "application/json": { [key: string]: unknown }; - }; - }; + 'application/json': { [key: string]: unknown } + } + } /** User was converted */ - 204: never; + 204: never /** Forbidden if user is the last owner of the organization or not a member of the organization */ - 403: unknown; - 404: components["responses"]["not_found"]; - }; - }; + 403: unknown + 404: components['responses']['not_found'] + } + } /** Removing a user from this list will remove them from all the organization's repositories. */ - "orgs/remove-outside-collaborator": { + 'orgs/remove-outside-collaborator': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; + 204: never /** Unprocessable Entity if user is a member of the organization */ 422: { content: { - "application/json": { - message?: string; - documentation_url?: string; - }; - }; - }; - }; - }; + 'application/json': { + message?: string + documentation_url?: string + } + } + } + } + } /** * Lists all packages in an organization readable by the user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/list-packages-for-organization": { + 'packages/list-packages-for-organization': { parameters: { query: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + package_type: 'npm' | 'maven' | 'rubygems' | 'docker' | 'nuget' | 'container' /** The selected visibility of the packages. Can be one of `public`, `private`, or `internal`. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set. */ - visibility?: components["parameters"]["package-visibility"]; - }; + visibility?: components['parameters']['package-visibility'] + } path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['package'][] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** * Gets a specific package in an organization. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/get-package-for-organization": { + 'packages/get-package-for-organization': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - org: components["parameters"]["org"]; - }; - }; + package_name: components['parameters']['package-name'] + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package"]; - }; - }; - }; - }; + 'application/json': components['schemas']['package'] + } + } + } + } /** * Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * @@ -23886,24 +23871,24 @@ export interface operations { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. */ - "packages/delete-package-for-org": { + 'packages/delete-package-for-org': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - org: components["parameters"]["org"]; - }; - }; + package_name: components['parameters']['package-name'] + org: components['parameters']['org'] + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Restores an entire package in an organization. * @@ -23915,91 +23900,91 @@ export interface operations { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. */ - "packages/restore-package-for-org": { + 'packages/restore-package-for-org': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - org: components["parameters"]["org"]; - }; + package_name: components['parameters']['package-name'] + org: components['parameters']['org'] + } query: { /** package token */ - token?: string; - }; - }; + token?: string + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Returns all package versions for a package owned by an organization. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/get-all-package-versions-for-package-owned-by-org": { + 'packages/get-all-package-versions-for-package-owned-by-org': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - org: components["parameters"]["org"]; - }; + package_name: components['parameters']['package-name'] + org: components['parameters']['org'] + } query: { /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** The state of the package, either active or deleted. */ - state?: "active" | "deleted"; - }; - }; + state?: 'active' | 'deleted' + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package-version"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['package-version'][] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Gets a specific package version in an organization. * * You must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/get-package-version-for-organization": { + 'packages/get-package-version-for-organization': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - org: components["parameters"]["org"]; + package_name: components['parameters']['package-name'] + org: components['parameters']['org'] /** Unique identifier of the package version. */ - package_version_id: components["parameters"]["package-version-id"]; - }; - }; + package_version_id: components['parameters']['package-version-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package-version"]; - }; - }; - }; - }; + 'application/json': components['schemas']['package-version'] + } + } + } + } /** * Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * @@ -24007,26 +23992,26 @@ export interface operations { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. */ - "packages/delete-package-version-for-org": { + 'packages/delete-package-version-for-org': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - org: components["parameters"]["org"]; + package_name: components['parameters']['package-name'] + org: components['parameters']['org'] /** Unique identifier of the package version. */ - package_version_id: components["parameters"]["package-version-id"]; - }; - }; + package_version_id: components['parameters']['package-version-id'] + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Restores a specific package version in an organization. * @@ -24038,179 +24023,179 @@ export interface operations { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. */ - "packages/restore-package-version-for-org": { + 'packages/restore-package-version-for-org': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - org: components["parameters"]["org"]; + package_name: components['parameters']['package-name'] + org: components['parameters']['org'] /** Unique identifier of the package version. */ - package_version_id: components["parameters"]["package-version-id"]; - }; - }; + package_version_id: components['parameters']['package-version-id'] + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - "projects/list-for-org": { + 'projects/list-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. */ - state?: "open" | "closed" | "all"; + state?: 'open' | 'closed' | 'all' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["project"][]; - }; - }; - 422: components["responses"]["validation_failed_simple"]; - }; - }; + 'application/json': components['schemas']['project'][] + } + } + 422: components['responses']['validation_failed_simple'] + } + } /** Creates an organization project board. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - "projects/create-for-org": { + 'projects/create-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["project"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': components['schemas']['project'] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the project. */ - name: string; + name: string /** @description The description of the project. */ - body?: string; - }; - }; - }; - }; + body?: string + } + } + } + } /** Members of an organization can choose to have their membership publicized or not. */ - "orgs/list-public-members": { + 'orgs/list-public-members': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - }; - }; - "orgs/check-public-membership-for-user": { + 'application/json': components['schemas']['simple-user'][] + } + } + } + } + 'orgs/check-public-membership-for-user': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** Response if user is a public member */ - 204: never; + 204: never /** Not Found if user is not a public member */ - 404: unknown; - }; - }; + 404: unknown + } + } /** * The user can publicize their own membership. (A user cannot publicize the membership for another user.) * * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - "orgs/set-public-membership-for-authenticated-user": { + 'orgs/set-public-membership-for-authenticated-user': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 403: components["responses"]["forbidden"]; - }; - }; - "orgs/remove-public-membership-for-authenticated-user": { + 204: never + 403: components['responses']['forbidden'] + } + } + 'orgs/remove-public-membership-for-authenticated-user': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** Lists repositories for the specified organization. */ - "repos/list-for-org": { + 'repos/list-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Note: For GitHub AE, can be one of `all`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`. However, the `internal` value is not yet supported when a GitHub App calls this API with an installation access token. */ - type?: "all" | "public" | "private" | "forks" | "sources" | "member" | "internal"; + type?: 'all' | 'public' | 'private' | 'forks' | 'sources' | 'member' | 'internal' /** Can be one of `created`, `updated`, `pushed`, `full_name`. */ - sort?: "created" | "updated" | "pushed" | "full_name"; + sort?: 'created' | 'updated' | 'pushed' | 'full_name' /** Can be one of `asc` or `desc`. Default: when using `full_name`: `asc`, otherwise `desc` */ - direction?: "asc" | "desc"; + direction?: 'asc' | 'desc' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["minimal-repository"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['minimal-repository'][] + } + } + } + } /** * Creates a new repository in the specified organization. The authenticated user must be a member of the organization. * @@ -24221,129 +24206,129 @@ export interface operations { * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. * * `repo` scope to create a private repository */ - "repos/create-in-org": { + 'repos/create-in-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["repository"]; - }; - }; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['repository'] + } + } + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the repository. */ - name: string; + name: string /** @description A short description of the repository. */ - description?: string; + description?: string /** @description A URL with more information about the repository. */ - homepage?: string; + homepage?: string /** @description Whether the repository is private. */ - private?: boolean; + private?: boolean /** * @description Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see "[Creating an internal repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)" in the GitHub Help documentation. * @enum {string} */ - visibility?: "public" | "private" | "internal"; + visibility?: 'public' | 'private' | 'internal' /** * @description Either `true` to enable issues for this repository or `false` to disable them. * @default true */ - has_issues?: boolean; + has_issues?: boolean /** * @description Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error. * @default true */ - has_projects?: boolean; + has_projects?: boolean /** * @description Either `true` to enable the wiki for this repository or `false` to disable it. * @default true */ - has_wiki?: boolean; + has_wiki?: boolean /** @description Either `true` to make this repo available as a template repository or `false` to prevent it. */ - is_template?: boolean; + is_template?: boolean /** @description The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. */ - team_id?: number; + team_id?: number /** @description Pass `true` to create an initial commit with empty README. */ - auto_init?: boolean; + auto_init?: boolean /** @description Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, "Haskell". */ - gitignore_template?: string; + gitignore_template?: string /** @description Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, "mit" or "mpl-2.0". */ - license_template?: string; + license_template?: string /** * @description Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge?: boolean /** * @description Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit?: boolean /** * @description Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge?: boolean /** @description Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. */ - allow_auto_merge?: boolean; + allow_auto_merge?: boolean /** @description Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. */ - delete_branch_on_merge?: boolean; - }; - }; - }; - }; + delete_branch_on_merge?: boolean + } + } + } + } /** * Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest. * To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. */ - "secret-scanning/list-alerts-for-org": { + 'secret-scanning/list-alerts-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - state?: components["parameters"]["secret-scanning-alert-state"]; + state?: components['parameters']['secret-scanning-alert-state'] /** * A comma-separated list of secret types to return. By default all secret types are returned. * See "[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)" * for a complete list of secret types (API slug). */ - secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; + secret_type?: components['parameters']['secret-scanning-alert-secret-type'] /** A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - resolution?: components["parameters"]["secret-scanning-alert-resolution"]; + resolution?: components['parameters']['secret-scanning-alert-resolution'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["organization-secret-scanning-alert"][]; - }; - }; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': components['schemas']['organization-secret-scanning-alert'][] + } + } + 404: components['responses']['not_found'] + 503: components['responses']['service_unavailable'] + } + } /** * Gets the summary of the free and paid GitHub Actions minutes used. * @@ -24351,48 +24336,48 @@ export interface operations { * * Access tokens must have the `repo` or `admin:org` scope. */ - "billing/get-github-actions-billing-org": { + 'billing/get-github-actions-billing-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-billing-usage"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-billing-usage'] + } + } + } + } /** * Gets the GitHub Advanced Security active committers for an organization per repository. * Each distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of advanced_security_committers for each repository. * If this organization defers to an enterprise for billing, the total_advanced_security_committers returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level. */ - "billing/get-github-advanced-security-billing-org": { + 'billing/get-github-advanced-security-billing-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Success */ 200: { content: { - "application/json": components["schemas"]["advanced-security-active-committers"]; - }; - }; - 403: components["responses"]["code_scanning_forbidden_read"]; - }; - }; + 'application/json': components['schemas']['advanced-security-active-committers'] + } + } + 403: components['responses']['code_scanning_forbidden_read'] + } + } /** * Gets the free and paid storage used for GitHub Packages in gigabytes. * @@ -24400,21 +24385,21 @@ export interface operations { * * Access tokens must have the `repo` or `admin:org` scope. */ - "billing/get-github-packages-billing-org": { + 'billing/get-github-packages-billing-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["packages-billing-usage"]; - }; - }; - }; - }; + 'application/json': components['schemas']['packages-billing-usage'] + } + } + } + } /** * Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. * @@ -24422,106 +24407,106 @@ export interface operations { * * Access tokens must have the `repo` or `admin:org` scope. */ - "billing/get-shared-storage-billing-org": { + 'billing/get-shared-storage-billing-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["combined-billing-usage"]; - }; - }; - }; - }; + 'application/json': components['schemas']['combined-billing-usage'] + } + } + } + } /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * List IdP groups available in an organization. You can limit your page results using the `per_page` parameter. GitHub generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." */ - "teams/list-idp-groups-for-org": { + 'teams/list-idp-groups-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page token */ - page?: string; - }; - }; + page?: string + } + } responses: { /** Response */ 200: { headers: { - Link?: string; - }; - content: { - "application/json": components["schemas"]["group-mapping"]; - }; - }; - }; - }; + Link?: string + } + content: { + 'application/json': components['schemas']['group-mapping'] + } + } + } + } /** Lists all teams in an organization that are visible to the authenticated user. */ - "teams/list": { + 'teams/list': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team"][]; - }; - }; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['team'][] + } + } + 403: components['responses']['forbidden'] + } + } /** * To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://docs.github.com/en/articles/setting-team-creation-permissions-in-your-organization)." * * When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)". */ - "teams/create": { + 'teams/create': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["team-full"]; - }; - }; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['team-full'] + } + } + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the team. */ - name: string; + name: string /** @description The description of the team. */ - description?: string; + description?: string /** @description List GitHub IDs for organization members who will become team maintainers. */ - maintainers?: string[]; + maintainers?: string[] /** @description The full name (e.g., "organization-name/repository-name") of repositories to add the team to. */ - repo_names?: string[]; + repo_names?: string[] /** * @description The level of privacy this team should have. The options are: * **For a non-nested team:** @@ -24533,7 +24518,7 @@ export interface operations { * Default for child team: `closed` * @enum {string} */ - privacy?: "secret" | "closed"; + privacy?: 'secret' | 'closed' /** * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: * \* `pull` - team members can pull, but not push to or administer newly-added repositories. @@ -24541,36 +24526,36 @@ export interface operations { * @default pull * @enum {string} */ - permission?: "pull" | "push"; + permission?: 'pull' | 'push' /** @description The ID of a team to set as the parent team. */ - parent_team_id?: number; - }; - }; - }; - }; + parent_team_id?: number + } + } + } + } /** * Gets a team using the team's `slug`. GitHub generates the `slug` from the team `name`. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. */ - "teams/get-by-name": { + 'teams/get-by-name': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; - }; + team_slug: components['parameters']['team-slug'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-full"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['team-full'] + } + } + 404: components['responses']['not_found'] + } + } /** * To delete a team, the authenticated user must be an organization owner or team maintainer. * @@ -24578,47 +24563,47 @@ export interface operations { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. */ - "teams/delete-in-org": { + 'teams/delete-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; - }; + team_slug: components['parameters']['team-slug'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * To edit a team, the authenticated user must either be an organization owner or a team maintainer. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. */ - "teams/update-in-org": { + 'teams/update-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; - }; + team_slug: components['parameters']['team-slug'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["team-full"]; - }; - }; - }; + 'application/json': components['schemas']['team-full'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the team. */ - name?: string; + name?: string /** @description The description of the team. */ - description?: string; + description?: string /** * @description The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: * **For a non-nested team:** @@ -24628,7 +24613,7 @@ export interface operations { * \* `closed` - visible to all members of this organization. * @enum {string} */ - privacy?: "secret" | "closed"; + privacy?: 'secret' | 'closed' /** * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: * \* `pull` - team members can pull, but not push to or administer newly-added repositories. @@ -24637,46 +24622,46 @@ export interface operations { * @default pull * @enum {string} */ - permission?: "pull" | "push" | "admin"; + permission?: 'pull' | 'push' | 'admin' /** @description The ID of a team to set as the parent team. */ - parent_team_id?: number | null; - }; - }; - }; - }; + parent_team_id?: number | null + } + } + } + } /** * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. */ - "teams/list-discussions-in-org": { + 'teams/list-discussions-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; + team_slug: components['parameters']['team-slug'] + } query: { /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Pinned discussions only filter */ - pinned?: string; - }; - }; + pinned?: string + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team-discussion"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['team-discussion'][] + } + } + } + } /** * Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @@ -24684,142 +24669,142 @@ export interface operations { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. */ - "teams/create-discussion-in-org": { + 'teams/create-discussion-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; - }; + team_slug: components['parameters']['team-slug'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; + 'application/json': components['schemas']['team-discussion'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The discussion post's title. */ - title: string; + title: string /** @description The discussion post's body text. */ - body: string; + body: string /** @description Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. */ - private?: boolean; - }; - }; - }; - }; + private?: boolean + } + } + } + } /** * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. */ - "teams/get-discussion-in-org": { + 'teams/get-discussion-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - }; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; - }; + 'application/json': components['schemas']['team-discussion'] + } + } + } + } /** * Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. */ - "teams/delete-discussion-in-org": { + 'teams/delete-discussion-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - }; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. */ - "teams/update-discussion-in-org": { + 'teams/update-discussion-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - }; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; + 'application/json': components['schemas']['team-discussion'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The discussion post's title. */ - title?: string; + title?: string /** @description The discussion post's body text. */ - body?: string; - }; - }; - }; - }; + body?: string + } + } + } + } /** * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. */ - "teams/list-discussion-comments-in-org": { + 'teams/list-discussion-comments-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + } query: { /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team-discussion-comment"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['team-discussion-comment'][] + } + } + } + } /** * Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @@ -24827,387 +24812,387 @@ export interface operations { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. */ - "teams/create-discussion-comment-in-org": { + 'teams/create-discussion-comment-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - }; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; + 'application/json': components['schemas']['team-discussion-comment'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The discussion comment's body text. */ - body: string; - }; - }; - }; - }; + body: string + } + } + } + } /** * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. */ - "teams/get-discussion-comment-in-org": { + 'teams/get-discussion-comment-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - comment_number: components["parameters"]["comment-number"]; - }; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + comment_number: components['parameters']['comment-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; - }; + 'application/json': components['schemas']['team-discussion-comment'] + } + } + } + } /** * Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. */ - "teams/delete-discussion-comment-in-org": { + 'teams/delete-discussion-comment-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - comment_number: components["parameters"]["comment-number"]; - }; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + comment_number: components['parameters']['comment-number'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. */ - "teams/update-discussion-comment-in-org": { + 'teams/update-discussion-comment-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - comment_number: components["parameters"]["comment-number"]; - }; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + comment_number: components['parameters']['comment-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; + 'application/json': components['schemas']['team-discussion-comment'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The discussion comment's body text. */ - body: string; - }; - }; - }; - }; + body: string + } + } + } + } /** * List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments/). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. */ - "reactions/list-for-team-discussion-comment-in-org": { + 'reactions/list-for-team-discussion-comment-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - comment_number: components["parameters"]["comment-number"]; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + comment_number: components['parameters']['comment-number'] + } query: { /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion comment. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content?: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["reaction"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['reaction'][] + } + } + } + } /** * Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. */ - "reactions/create-for-team-discussion-comment-in-org": { + 'reactions/create-for-team-discussion-comment-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - comment_number: components["parameters"]["comment-number"]; - }; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + comment_number: components['parameters']['comment-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; + 'application/json': components['schemas']['reaction'] + } + } /** Response */ 201: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - }; + 'application/json': components['schemas']['reaction'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion comment. * @enum {string} */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - }; + content: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' + } + } + } + } /** * **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. * * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "reactions/delete-for-team-discussion-comment": { + 'reactions/delete-for-team-discussion-comment': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - comment_number: components["parameters"]["comment-number"]; - reaction_id: components["parameters"]["reaction-id"]; - }; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + comment_number: components['parameters']['comment-number'] + reaction_id: components['parameters']['reaction-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. */ - "reactions/list-for-team-discussion-in-org": { + 'reactions/list-for-team-discussion-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + } query: { /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content?: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["reaction"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['reaction'][] + } + } + } + } /** * Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. */ - "reactions/create-for-team-discussion-in-org": { + 'reactions/create-for-team-discussion-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - }; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; + 'application/json': components['schemas']['reaction'] + } + } /** Response */ 201: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - }; + 'application/json': components['schemas']['reaction'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion. * @enum {string} */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - }; + content: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' + } + } + } + } /** * **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. * * Delete a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "reactions/delete-for-team-discussion": { + 'reactions/delete-for-team-discussion': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - reaction_id: components["parameters"]["reaction-id"]; - }; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + reaction_id: components['parameters']['reaction-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Deletes a connection between a team and an external group. * * You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "teams/unlink-external-idp-group-from-team-for-org": { + 'teams/unlink-external-idp-group-from-team-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; - }; + team_slug: components['parameters']['team-slug'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Creates a connection between a team and an external group. Only one external group can be linked to a team. * * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ - "teams/link-external-idp-group-to-team-for-org": { + 'teams/link-external-idp-group-to-team-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; - }; + team_slug: components['parameters']['team-slug'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["external-group"]; - }; - }; - }; + 'application/json': components['schemas']['external-group'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description External Group Id * @example 1 */ - group_id: number; - }; - }; - }; - }; + group_id: number + } + } + } + } /** * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. */ - "teams/list-pending-invitations-in-org": { + 'teams/list-pending-invitations-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; + team_slug: components['parameters']['team-slug'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["organization-invitation"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['organization-invitation'][] + } + } + } + } /** * Team members will include the members of child teams. * * To list members in a team, the team must be visible to the authenticated user. */ - "teams/list-members-in-org": { + 'teams/list-members-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; + team_slug: components['parameters']['team-slug'] + } query: { /** * Filters members returned by their role in the team. Can be one of: @@ -25215,23 +25200,23 @@ export interface operations { * \* `maintainer` - team maintainers. * \* `all` - all members of the team. */ - role?: "member" | "maintainer" | "all"; + role?: 'member' | 'maintainer' | 'all' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + } + } /** * Team members will include the members of child teams. * @@ -25244,26 +25229,26 @@ export interface operations { * * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team). */ - "teams/get-membership-for-user-in-org": { + 'teams/get-membership-for-user-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - username: components["parameters"]["username"]; - }; - }; + team_slug: components['parameters']['team-slug'] + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-membership"]; - }; - }; + 'application/json': components['schemas']['team-membership'] + } + } /** if user has no team membership */ - 404: unknown; - }; - }; + 404: unknown + } + } /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -25277,30 +25262,30 @@ export interface operations { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ - "teams/add-or-update-membership-for-user-in-org": { + 'teams/add-or-update-membership-for-user-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - username: components["parameters"]["username"]; - }; - }; + team_slug: components['parameters']['team-slug'] + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-membership"]; - }; - }; + 'application/json': components['schemas']['team-membership'] + } + } /** Forbidden if team synchronization is set up */ - 403: unknown; + 403: unknown /** Unprocessable Entity if you attempt to add an organization to a team */ - 422: unknown; - }; + 422: unknown + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The role that this user should have in the team. Can be one of: * \* `member` - a normal member of the team. @@ -25308,11 +25293,11 @@ export interface operations { * @default member * @enum {string} */ - role?: "member" | "maintainer"; - }; - }; - }; - }; + role?: 'member' | 'maintainer' + } + } + } + } /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -25322,106 +25307,106 @@ export interface operations { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ - "teams/remove-membership-for-user-in-org": { + 'teams/remove-membership-for-user-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - username: components["parameters"]["username"]; - }; - }; + team_slug: components['parameters']['team-slug'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; + 204: never /** Forbidden if team synchronization is set up */ - 403: unknown; - }; - }; + 403: unknown + } + } /** * Lists the organization projects for a team. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. */ - "teams/list-projects-in-org": { + 'teams/list-projects-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; + team_slug: components['parameters']['team-slug'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team-project"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['team-project'][] + } + } + } + } /** * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ - "teams/check-permissions-for-project-in-org": { + 'teams/check-permissions-for-project-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - project_id: components["parameters"]["project-id"]; - }; - }; + team_slug: components['parameters']['team-slug'] + project_id: components['parameters']['project-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-project"]; - }; - }; + 'application/json': components['schemas']['team-project'] + } + } /** Not Found if project is not managed by this team */ - 404: unknown; - }; - }; + 404: unknown + } + } /** * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ - "teams/add-or-update-project-permissions-in-org": { + 'teams/add-or-update-project-permissions-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - project_id: components["parameters"]["project-id"]; - }; - }; + team_slug: components['parameters']['team-slug'] + project_id: components['parameters']['project-id'] + } + } responses: { /** Response */ - 204: never; + 204: never /** Forbidden if the project is not owned by the organization */ 403: { content: { - "application/json": { - message?: string; - documentation_url?: string; - }; - }; - }; - }; + 'application/json': { + message?: string + documentation_url?: string + } + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The permission to grant to the team for this project. Can be one of: * \* `read` - team members can read, but not write to or administer this project. @@ -25430,59 +25415,59 @@ export interface operations { * Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." * @enum {string} */ - permission?: "read" | "write" | "admin"; - } | null; - }; - }; - }; + permission?: 'read' | 'write' | 'admin' + } | null + } + } + } /** * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ - "teams/remove-project-in-org": { + 'teams/remove-project-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - project_id: components["parameters"]["project-id"]; - }; - }; + team_slug: components['parameters']['team-slug'] + project_id: components['parameters']['project-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Lists a team's repositories visible to the authenticated user. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. */ - "teams/list-repos-in-org": { + 'teams/list-repos-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; + team_slug: components['parameters']['team-slug'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["minimal-repository"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['minimal-repository'][] + } + } + } + } /** * Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. * @@ -25492,29 +25477,29 @@ export interface operations { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ - "teams/check-permissions-for-repo-in-org": { + 'teams/check-permissions-for-repo-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + team_slug: components['parameters']['team-slug'] + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Alternative response with repository permissions */ 200: { content: { - "application/json": components["schemas"]["team-repository"]; - }; - }; + 'application/json': components['schemas']['team-repository'] + } + } /** Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header. */ - 204: never; + 204: never /** Not Found if team does not have permission for the repository */ - 404: unknown; - }; - }; + 404: unknown + } + } /** * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." * @@ -25522,23 +25507,23 @@ export interface operations { * * For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". */ - "teams/add-or-update-repo-permissions-in-org": { + 'teams/add-or-update-repo-permissions-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + team_slug: components['parameters']['team-slug'] + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The permission to grant the team on this repository. Can be one of: * \* `pull` - team members can pull, but not push to or administer this repository. @@ -25552,31 +25537,31 @@ export interface operations { * @default push * @enum {string} */ - permission?: "pull" | "push" | "admin" | "maintain" | "triage"; - }; - }; - }; - }; + permission?: 'pull' | 'push' | 'admin' | 'maintain' | 'triage' + } + } + } + } /** * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ - "teams/remove-repo-in-org": { + 'teams/remove-repo-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + team_slug: components['parameters']['team-slug'] + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -25584,23 +25569,23 @@ export interface operations { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`. */ - "teams/list-idp-groups-in-org": { + 'teams/list-idp-groups-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; - }; + team_slug: components['parameters']['team-slug'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["group-mapping"]; - }; - }; - }; - }; + 'application/json': components['schemas']['group-mapping'] + } + } + } + } /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -25608,510 +25593,508 @@ export interface operations { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`. */ - "teams/create-or-update-idp-group-connections-in-org": { + 'teams/create-or-update-idp-group-connections-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; - }; + team_slug: components['parameters']['team-slug'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["group-mapping"]; - }; - }; - }; + 'application/json': components['schemas']['group-mapping'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The IdP groups you want to connect to a GitHub team. When updating, the new `groups` object will replace the original one. You must include any existing groups that you don't want to remove. */ groups?: { /** @description ID of the IdP group. */ - group_id: string; + group_id: string /** @description Name of the IdP group. */ - group_name: string; + group_name: string /** @description Description of the IdP group. */ - group_description: string; - }[]; - }; - }; - }; - }; + group_description: string + }[] + } + } + } + } /** * Lists the child teams of the team specified by `{team_slug}`. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. */ - "teams/list-child-in-org": { + 'teams/list-child-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; + team_slug: components['parameters']['team-slug'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** if child teams exist */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team"][]; - }; - }; - }; - }; - "projects/get-card": { + 'application/json': components['schemas']['team'][] + } + } + } + } + 'projects/get-card': { parameters: { path: { /** card_id parameter */ - card_id: components["parameters"]["card-id"]; - }; - }; + card_id: components['parameters']['card-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["project-card"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "projects/delete-card": { + 'application/json': components['schemas']['project-card'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'projects/delete-card': { parameters: { path: { /** card_id parameter */ - card_id: components["parameters"]["card-id"]; - }; - }; + card_id: components['parameters']['card-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] /** Forbidden */ 403: { content: { - "application/json": { - message?: string; - documentation_url?: string; - errors?: string[]; - }; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "projects/update-card": { + 'application/json': { + message?: string + documentation_url?: string + errors?: string[] + } + } + } + 404: components['responses']['not_found'] + } + } + 'projects/update-card': { parameters: { path: { /** card_id parameter */ - card_id: components["parameters"]["card-id"]; - }; - }; + card_id: components['parameters']['card-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["project-card"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': components['schemas']['project-card'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The project card's note * @example Update all gems */ - note?: string | null; + note?: string | null /** @description Whether or not the card is archived */ - archived?: boolean; - }; - }; - }; - }; - "projects/move-card": { + archived?: boolean + } + } + } + } + 'projects/move-card': { parameters: { path: { /** card_id parameter */ - card_id: components["parameters"]["card-id"]; - }; - }; + card_id: components['parameters']['card-id'] + } + } responses: { /** Response */ 201: { content: { - "application/json": { [key: string]: unknown }; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; + 'application/json': { [key: string]: unknown } + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] /** Forbidden */ 403: { content: { - "application/json": { - message?: string; - documentation_url?: string; + 'application/json': { + message?: string + documentation_url?: string errors?: { - code?: string; - message?: string; - resource?: string; - field?: string; - }[]; - }; - }; - }; - 422: components["responses"]["validation_failed"]; + code?: string + message?: string + resource?: string + field?: string + }[] + } + } + } + 422: components['responses']['validation_failed'] /** Response */ 503: { content: { - "application/json": { - code?: string; - message?: string; - documentation_url?: string; + 'application/json': { + code?: string + message?: string + documentation_url?: string errors?: { - code?: string; - message?: string; - }[]; - }; - }; - }; - }; + code?: string + message?: string + }[] + } + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card. * @example bottom */ - position: string; + position: string /** * @description The unique identifier of the column the card should be moved to * @example 42 */ - column_id?: number; - }; - }; - }; - }; - "projects/get-column": { + column_id?: number + } + } + } + } + 'projects/get-column': { parameters: { path: { /** column_id parameter */ - column_id: components["parameters"]["column-id"]; - }; - }; + column_id: components['parameters']['column-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["project-column"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "projects/delete-column": { + 'application/json': components['schemas']['project-column'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'projects/delete-column': { parameters: { path: { /** column_id parameter */ - column_id: components["parameters"]["column-id"]; - }; - }; + column_id: components['parameters']['column-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; - "projects/update-column": { + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } + 'projects/update-column': { parameters: { path: { /** column_id parameter */ - column_id: components["parameters"]["column-id"]; - }; - }; + column_id: components['parameters']['column-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["project-column"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; + 'application/json': components['schemas']['project-column'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description Name of the project column * @example Remaining tasks */ - name: string; - }; - }; - }; - }; - "projects/list-cards": { + name: string + } + } + } + } + 'projects/list-cards': { parameters: { path: { /** column_id parameter */ - column_id: components["parameters"]["column-id"]; - }; + column_id: components['parameters']['column-id'] + } query: { /** Filters the project cards that are returned by the card's state. Can be one of `all`,`archived`, or `not_archived`. */ - archived_state?: "all" | "archived" | "not_archived"; + archived_state?: 'all' | 'archived' | 'not_archived' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["project-card"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; - "projects/create-card": { + 'application/json': components['schemas']['project-card'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } + 'projects/create-card': { parameters: { path: { /** column_id parameter */ - column_id: components["parameters"]["column-id"]; - }; - }; + column_id: components['parameters']['column-id'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["project-card"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; + 'application/json': components['schemas']['project-card'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] /** Validation failed */ 422: { content: { - "application/json": - | components["schemas"]["validation-error"] - | components["schemas"]["validation-error-simple"]; - }; - }; + 'application/json': components['schemas']['validation-error'] | components['schemas']['validation-error-simple'] + } + } /** Response */ 503: { content: { - "application/json": { - code?: string; - message?: string; - documentation_url?: string; + 'application/json': { + code?: string + message?: string + documentation_url?: string errors?: { - code?: string; - message?: string; - }[]; - }; - }; - }; - }; + code?: string + message?: string + }[] + } + } + } + } requestBody: { content: { - "application/json": + 'application/json': | { /** * @description The project card's note * @example Update all gems */ - note: string | null; + note: string | null } | { /** * @description The unique identifier of the content associated with the card * @example 42 */ - content_id: number; + content_id: number /** * @description The piece of content associated with the card * @example PullRequest */ - content_type: string; - }; - }; - }; - }; - "projects/move-column": { + content_type: string + } + } + } + } + 'projects/move-column': { parameters: { path: { /** column_id parameter */ - column_id: components["parameters"]["column-id"]; - }; - }; + column_id: components['parameters']['column-id'] + } + } responses: { /** Response */ 201: { content: { - "application/json": { [key: string]: unknown }; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': { [key: string]: unknown } + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column. * @example last */ - position: string; - }; - }; - }; - }; + position: string + } + } + } + } /** Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - "projects/get": { + 'projects/get': { parameters: { path: { - project_id: components["parameters"]["project-id"]; - }; - }; + project_id: components['parameters']['project-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["project"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['project'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** Deletes a project board. Returns a `404 Not Found` status if projects are disabled. */ - "projects/delete": { + 'projects/delete': { parameters: { path: { - project_id: components["parameters"]["project-id"]; - }; - }; + project_id: components['parameters']['project-id'] + } + } responses: { /** Delete Success */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] /** Forbidden */ 403: { content: { - "application/json": { - message?: string; - documentation_url?: string; - errors?: string[]; - }; - }; - }; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - }; - }; + 'application/json': { + message?: string + documentation_url?: string + errors?: string[] + } + } + } + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + } + } /** Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - "projects/update": { + 'projects/update': { parameters: { path: { - project_id: components["parameters"]["project-id"]; - }; - }; + project_id: components['parameters']['project-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["project"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; + 'application/json': components['schemas']['project'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] /** Forbidden */ 403: { content: { - "application/json": { - message?: string; - documentation_url?: string; - errors?: string[]; - }; - }; - }; + 'application/json': { + message?: string + documentation_url?: string + errors?: string[] + } + } + } /** Not Found if the authenticated user does not have access to the project */ - 404: unknown; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 404: unknown + 410: components['responses']['gone'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description Name of the project * @example Week One Sprint */ - name?: string; + name?: string /** * @description Body of the project * @example This project represents the sprint of the first week in January */ - body?: string | null; + body?: string | null /** * @description State of the project; either 'open' or 'closed' * @example open */ - state?: string; + state?: string /** * @description The baseline permission that all organization members have on this project * @enum {string} */ - organization_permission?: "read" | "write" | "admin" | "none"; + organization_permission?: 'read' | 'write' | 'admin' | 'none' /** @description Whether or not this project can be seen by everyone. */ - private?: boolean; - }; - }; - }; - }; + private?: boolean + } + } + } + } /** Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators. */ - "projects/list-collaborators": { + 'projects/list-collaborators': { parameters: { path: { - project_id: components["parameters"]["project-id"]; - }; + project_id: components['parameters']['project-id'] + } query: { /** * Filters the collaborators by their affiliation. Can be one of: @@ -26119,483 +26102,483 @@ export interface operations { * \* `direct`: Collaborators with permissions to a project, regardless of organization membership status. * \* `all`: All collaborators the authenticated user can see. */ - affiliation?: "outside" | "direct" | "all"; + affiliation?: 'outside' | 'direct' | 'all' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator. */ - "projects/add-collaborator": { + 'projects/add-collaborator': { parameters: { path: { - project_id: components["parameters"]["project-id"]; - username: components["parameters"]["username"]; - }; - }; + project_id: components['parameters']['project-id'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The permission to grant the collaborator. * @default write * @example write * @enum {string} */ - permission?: "read" | "write" | "admin"; - } | null; - }; - }; - }; + permission?: 'read' | 'write' | 'admin' + } | null + } + } + } /** Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator. */ - "projects/remove-collaborator": { + 'projects/remove-collaborator': { parameters: { path: { - project_id: components["parameters"]["project-id"]; - username: components["parameters"]["username"]; - }; - }; + project_id: components['parameters']['project-id'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level. */ - "projects/get-permission-for-user": { + 'projects/get-permission-for-user': { parameters: { path: { - project_id: components["parameters"]["project-id"]; - username: components["parameters"]["username"]; - }; - }; + project_id: components['parameters']['project-id'] + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["project-collaborator-permission"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "projects/list-columns": { + 'application/json': components['schemas']['project-collaborator-permission'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } + 'projects/list-columns': { parameters: { path: { - project_id: components["parameters"]["project-id"]; - }; + project_id: components['parameters']['project-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["project-column"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; - "projects/create-column": { + 'application/json': components['schemas']['project-column'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } + 'projects/create-column': { parameters: { path: { - project_id: components["parameters"]["project-id"]; - }; - }; + project_id: components['parameters']['project-id'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["project-column"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': components['schemas']['project-column'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description Name of the project column * @example Remaining tasks */ - name: string; - }; - }; - }; - }; + name: string + } + } + } + } /** * **Note:** Accessing this endpoint does not count against your REST API rate limit. * * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. */ - "rate-limit/get": { - parameters: {}; + 'rate-limit/get': { + parameters: {} responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["rate-limit-overview"]; - }; - }; - 304: components["responses"]["not_modified"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['rate-limit-overview'] + } + } + 304: components['responses']['not_modified'] + 404: components['responses']['not_found'] + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Reactions API. We recommend migrating your existing code to use the new delete reactions endpoints. For more information, see this [blog post](https://developer.github.com/changes/2020-02-26-new-delete-reactions-endpoints/). * * OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), when deleting a [team discussion](https://docs.github.com/rest/reference/teams#discussions) or [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). */ - "reactions/delete-legacy": { + 'reactions/delete-legacy': { parameters: { path: { - reaction_id: components["parameters"]["reaction-id"]; - }; - }; + reaction_id: components['parameters']['reaction-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 410: components["responses"]["gone"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 410: components['responses']['gone'] + } + } /** The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. */ - "repos/get": { + 'repos/get': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["full-repository"]; - }; - }; - 301: components["responses"]["moved_permanently"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['full-repository'] + } + } + 301: components['responses']['moved_permanently'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required. * * If an organization owner has configured the organization to prevent members from deleting organization-owned * repositories, you will get a `403 Forbidden` response. */ - "repos/delete": { + 'repos/delete': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - 307: components["responses"]["temporary_redirect"]; + 204: never + 307: components['responses']['temporary_redirect'] /** If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response: */ 403: { content: { - "application/json": { - message?: string; - documentation_url?: string; - }; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': { + message?: string + documentation_url?: string + } + } + } + 404: components['responses']['not_found'] + } + } /** **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/rest/reference/repos#replace-all-repository-topics) endpoint. */ - "repos/update": { + 'repos/update': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["full-repository"]; - }; - }; - 307: components["responses"]["temporary_redirect"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['full-repository'] + } + } + 307: components['responses']['temporary_redirect'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the repository. */ - name?: string; + name?: string /** @description A short description of the repository. */ - description?: string; + description?: string /** @description A URL with more information about the repository. */ - homepage?: string; + homepage?: string /** * @description Either `true` to make the repository private or `false` to make it public. Default: `false`. * **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. */ - private?: boolean; + private?: boolean /** * @description Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`." * @enum {string} */ - visibility?: "public" | "private" | "internal"; + visibility?: 'public' | 'private' | 'internal' /** @description Specify which security and analysis features to enable or disable. For example, to enable GitHub Advanced Security, use this data in the body of the PATCH request: `{"security_and_analysis": {"advanced_security": {"status": "enabled"}}}`. If you have admin permissions for a private repository covered by an Advanced Security license, you can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request. */ security_and_analysis?: { /** @description Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see "[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security)." */ advanced_security?: { /** @description Can be `enabled` or `disabled`. */ - status?: string; - }; + status?: string + } /** @description Use the `status` property to enable or disable secret scanning for this repository. For more information, see "[About secret scanning](/code-security/secret-security/about-secret-scanning)." */ secret_scanning?: { /** @description Can be `enabled` or `disabled`. */ - status?: string; - }; - } | null; + status?: string + } + } | null /** * @description Either `true` to enable issues for this repository or `false` to disable them. * @default true */ - has_issues?: boolean; + has_issues?: boolean /** * @description Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error. * @default true */ - has_projects?: boolean; + has_projects?: boolean /** * @description Either `true` to enable the wiki for this repository or `false` to disable it. * @default true */ - has_wiki?: boolean; + has_wiki?: boolean /** @description Either `true` to make this repo available as a template repository or `false` to prevent it. */ - is_template?: boolean; + is_template?: boolean /** @description Updates the default branch for this repository. */ - default_branch?: string; + default_branch?: string /** * @description Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge?: boolean /** * @description Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit?: boolean /** * @description Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge?: boolean /** @description Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. */ - allow_auto_merge?: boolean; + allow_auto_merge?: boolean /** @description Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge?: boolean /** @description `true` to archive this repository. **Note**: You cannot unarchive repositories through the API. */ - archived?: boolean; + archived?: boolean /** @description Either `true` to allow private forks, or `false` to prevent private forks. */ - allow_forking?: boolean; - }; - }; - }; - }; + allow_forking?: boolean + } + } + } + } /** Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/list-artifacts-for-repo": { + 'actions/list-artifacts-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - artifacts: components["schemas"]["artifact"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + artifacts: components['schemas']['artifact'][] + } + } + } + } + } /** Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/get-artifact": { + 'actions/get-artifact': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** artifact_id parameter */ - artifact_id: components["parameters"]["artifact-id"]; - }; - }; + artifact_id: components['parameters']['artifact-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["artifact"]; - }; - }; - }; - }; + 'application/json': components['schemas']['artifact'] + } + } + } + } /** Deletes an artifact for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - "actions/delete-artifact": { + 'actions/delete-artifact': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** artifact_id parameter */ - artifact_id: components["parameters"]["artifact-id"]; - }; - }; + artifact_id: components['parameters']['artifact-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in * the response header to find the URL for the download. The `:archive_format` must be `zip`. Anyone with read access to * the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/download-artifact": { + 'actions/download-artifact': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** artifact_id parameter */ - artifact_id: components["parameters"]["artifact-id"]; - archive_format: string; - }; - }; + artifact_id: components['parameters']['artifact-id'] + archive_format: string + } + } responses: { /** Response */ - 302: never; - }; - }; + 302: never + } + } /** Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/get-job-for-workflow-run": { + 'actions/get-job-for-workflow-run': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** job_id parameter */ - job_id: components["parameters"]["job-id"]; - }; - }; + job_id: components['parameters']['job-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["job"]; - }; - }; - }; - }; + 'application/json': components['schemas']['job'] + } + } + } + } /** * Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look * for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can * use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must * have the `actions:read` permission to use this endpoint. */ - "actions/download-job-logs-for-workflow-run": { + 'actions/download-job-logs-for-workflow-run': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** job_id parameter */ - job_id: components["parameters"]["job-id"]; - }; - }; + job_id: components['parameters']['job-id'] + } + } responses: { /** Response */ - 302: never; - }; - }; + 302: never + } + } /** * Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository. * * You must authenticate using an access token with the `repo` scope to use this * endpoint. GitHub Apps must have the `administration` repository permission to use this API. */ - "actions/get-github-actions-permissions-repository": { + 'actions/get-github-actions-permissions-repository': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-repository-permissions"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-repository-permissions'] + } + } + } + } /** * Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository. * @@ -26603,47 +26586,47 @@ export interface operations { * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. */ - "actions/set-github-actions-permissions-repository": { + 'actions/set-github-actions-permissions-repository': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { - enabled: components["schemas"]["actions-enabled"]; - allowed_actions?: components["schemas"]["allowed-actions"]; - }; - }; - }; - }; + 'application/json': { + enabled: components['schemas']['actions-enabled'] + allowed_actions?: components['schemas']['allowed-actions'] + } + } + } + } /** * Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. */ - "actions/get-allowed-actions-repository": { + 'actions/get-allowed-actions-repository': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["selected-actions"]; - }; - }; - }; - }; + 'application/json': components['schemas']['selected-actions'] + } + } + } + } /** * Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." * @@ -26653,71 +26636,71 @@ export interface operations { * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. */ - "actions/set-allowed-actions-repository": { + 'actions/set-allowed-actions-repository': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": components["schemas"]["selected-actions"]; - }; - }; - }; + 'application/json': components['schemas']['selected-actions'] + } + } + } /** Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. */ - "actions/list-self-hosted-runners-for-repo": { + 'actions/list-self-hosted-runners-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - runners: components["schemas"]["runner"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + runners: components['schemas']['runner'][] + } + } + } + } + } /** * Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `repo` scope to use this endpoint. */ - "actions/list-runner-applications-for-repo": { + 'actions/list-runner-applications-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["runner-application"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['runner-application'][] + } + } + } + } /** * Returns a token that you can pass to the `config` script. The token expires after one hour. You must authenticate * using an access token with the `repo` scope to use this endpoint. @@ -26730,22 +26713,22 @@ export interface operations { * ./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN * ``` */ - "actions/create-registration-token-for-repo": { + 'actions/create-registration-token-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["authentication-token"]; - }; - }; - }; - }; + 'application/json': components['schemas']['authentication-token'] + } + } + } + } /** * Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour. * You must authenticate using an access token with the `repo` scope to use this endpoint. @@ -26758,86 +26741,86 @@ export interface operations { * ./config.sh remove --token TOKEN * ``` */ - "actions/create-remove-token-for-repo": { + 'actions/create-remove-token-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["authentication-token"]; - }; - }; - }; - }; + 'application/json': components['schemas']['authentication-token'] + } + } + } + } /** * Gets a specific self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - "actions/get-self-hosted-runner-for-repo": { + 'actions/get-self-hosted-runner-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["runner"]; - }; - }; - }; - }; + 'application/json': components['schemas']['runner'] + } + } + } + } /** * Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * * You must authenticate using an access token with the `repo` * scope to use this endpoint. */ - "actions/delete-self-hosted-runner-from-repo": { + 'actions/delete-self-hosted-runner-from-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Lists all labels for a self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - "actions/list-labels-for-self-hosted-runner-for-repo": { + 'actions/list-labels-for-self-hosted-runner-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - }; - }; + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + } + } /** * Remove all previous custom labels and set the new custom labels for a specific * self-hosted runner configured in a repository. @@ -26845,58 +26828,58 @@ export interface operations { * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - "actions/set-custom-labels-for-self-hosted-runner-for-repo": { + 'actions/set-custom-labels-for-self-hosted-runner-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; - responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + runner_id: components['parameters']['runner-id'] + } + } + responses: { + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels. */ - labels: string[]; - }; - }; - }; - }; + labels: string[] + } + } + } + } /** * Add custom labels to a self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - "actions/add-custom-labels-to-self-hosted-runner-for-repo": { + 'actions/add-custom-labels-to-self-hosted-runner-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; - responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + runner_id: components['parameters']['runner-id'] + } + } + responses: { + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The names of the custom labels to add to the runner. */ - labels: string[]; - }; - }; - }; - }; + labels: string[] + } + } + } + } /** * Remove all custom labels from a self-hosted runner configured in a * repository. Returns the remaining read-only labels from the runner. @@ -26904,20 +26887,20 @@ export interface operations { * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - "actions/remove-all-custom-labels-from-self-hosted-runner-for-repo": { + 'actions/remove-all-custom-labels-from-self-hosted-runner-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { - 200: components["responses"]["actions_runner_labels_readonly"]; - 404: components["responses"]["not_found"]; - }; - }; + 200: components['responses']['actions_runner_labels_readonly'] + 404: components['responses']['not_found'] + } + } /** * Remove a custom label from a self-hosted runner configured * in a repository. Returns the remaining labels from the runner. @@ -26928,531 +26911,531 @@ export interface operations { * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - "actions/remove-custom-label-from-self-hosted-runner-for-repo": { + 'actions/remove-custom-label-from-self-hosted-runner-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; + runner_id: components['parameters']['runner-id'] /** The name of a self-hosted runner's custom label. */ - name: components["parameters"]["runner-label-name"]; - }; - }; + name: components['parameters']['runner-label-name'] + } + } responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; - }; + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } + } /** * Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). * * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/list-workflow-runs-for-repo": { + 'actions/list-workflow-runs-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ - actor?: components["parameters"]["actor"]; + actor?: components['parameters']['actor'] /** Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ - branch?: components["parameters"]["workflow-run-branch"]; + branch?: components['parameters']['workflow-run-branch'] /** Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ - event?: components["parameters"]["event"]; + event?: components['parameters']['event'] /** Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. For a list of the possible `status` and `conclusion` options, see "[Create a check run](https://docs.github.com/rest/reference/checks#create-a-check-run)." */ - status?: components["parameters"]["workflow-run-status"]; + status?: components['parameters']['workflow-run-status'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ - created?: components["parameters"]["created"]; + created?: components['parameters']['created'] /** If `true` pull requests are omitted from the response (empty array). */ - exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; + exclude_pull_requests?: components['parameters']['exclude-pull-requests'] /** Returns workflow runs with the `check_suite_id` that you specify. */ - check_suite_id?: components["parameters"]["workflow-run-check-suite-id"]; - }; - }; + check_suite_id?: components['parameters']['workflow-run-check-suite-id'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - workflow_runs: components["schemas"]["workflow-run"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + workflow_runs: components['schemas']['workflow-run'][] + } + } + } + } + } /** Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/get-workflow-run": { + 'actions/get-workflow-run': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; + run_id: components['parameters']['run-id'] + } query: { /** If `true` pull requests are omitted from the response (empty array). */ - exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; - }; - }; + exclude_pull_requests?: components['parameters']['exclude-pull-requests'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["workflow-run"]; - }; - }; - }; - }; + 'application/json': components['schemas']['workflow-run'] + } + } + } + } /** * Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is * private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:write` permission to use * this endpoint. */ - "actions/delete-workflow-run": { + 'actions/delete-workflow-run': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; - }; + run_id: components['parameters']['run-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/get-reviews-for-run": { + 'actions/get-reviews-for-run': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; - }; + run_id: components['parameters']['run-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["environment-approvals"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['environment-approvals'][] + } + } + } + } /** * Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)." * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - "actions/approve-workflow-run": { + 'actions/approve-workflow-run': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; - }; + run_id: components['parameters']['run-id'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["empty-object"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['empty-object'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/list-workflow-run-artifacts": { + 'actions/list-workflow-run-artifacts': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; + run_id: components['parameters']['run-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - artifacts: components["schemas"]["artifact"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + artifacts: components['schemas']['artifact'][] + } + } + } + } + } /** * Gets a specific workflow run attempt. Anyone with read access to the repository * can use this endpoint. If the repository is private you must use an access token * with the `repo` scope. GitHub Apps must have the `actions:read` permission to * use this endpoint. */ - "actions/get-workflow-run-attempt": { + 'actions/get-workflow-run-attempt': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; + run_id: components['parameters']['run-id'] /** The attempt number of the workflow run. */ - attempt_number: components["parameters"]["attempt-number"]; - }; + attempt_number: components['parameters']['attempt-number'] + } query: { /** If `true` pull requests are omitted from the response (empty array). */ - exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; - }; - }; + exclude_pull_requests?: components['parameters']['exclude-pull-requests'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["workflow-run"]; - }; - }; - }; - }; + 'application/json': components['schemas']['workflow-run'] + } + } + } + } /** Lists jobs for a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). */ - "actions/list-jobs-for-workflow-run-attempt": { + 'actions/list-jobs-for-workflow-run-attempt': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; + run_id: components['parameters']['run-id'] /** The attempt number of the workflow run. */ - attempt_number: components["parameters"]["attempt-number"]; - }; + attempt_number: components['parameters']['attempt-number'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - jobs: components["schemas"]["job"][]; - }; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': { + total_count: number + jobs: components['schemas']['job'][] + } + } + } + 404: components['responses']['not_found'] + } + } /** * Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after * 1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to * the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/download-workflow-run-attempt-logs": { + 'actions/download-workflow-run-attempt-logs': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; + run_id: components['parameters']['run-id'] /** The attempt number of the workflow run. */ - attempt_number: components["parameters"]["attempt-number"]; - }; - }; + attempt_number: components['parameters']['attempt-number'] + } + } responses: { /** Response */ - 302: never; - }; - }; + 302: never + } + } /** Cancels a workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - "actions/cancel-workflow-run": { + 'actions/cancel-workflow-run': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; - }; + run_id: components['parameters']['run-id'] + } + } responses: { /** Response */ 202: { content: { - "application/json": { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': { [key: string]: unknown } + } + } + } + } /** Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). */ - "actions/list-jobs-for-workflow-run": { + 'actions/list-jobs-for-workflow-run': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; + run_id: components['parameters']['run-id'] + } query: { /** * Filters jobs by their `completed_at` timestamp. Can be one of: * \* `latest`: Returns jobs from the most recent execution of the workflow run. * \* `all`: Returns all jobs for a workflow run, including from old executions of the workflow run. */ - filter?: "latest" | "all"; + filter?: 'latest' | 'all' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - jobs: components["schemas"]["job"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + jobs: components['schemas']['job'][] + } + } + } + } + } /** * Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for * `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use * this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have * the `actions:read` permission to use this endpoint. */ - "actions/download-workflow-run-logs": { + 'actions/download-workflow-run-logs': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; - }; + run_id: components['parameters']['run-id'] + } + } responses: { /** Response */ - 302: never; - }; - }; + 302: never + } + } /** Deletes all logs for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - "actions/delete-workflow-run-logs": { + 'actions/delete-workflow-run-logs': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; - }; + run_id: components['parameters']['run-id'] + } + } responses: { /** Response */ - 204: never; - 403: components["responses"]["forbidden"]; - 500: components["responses"]["internal_error"]; - }; - }; + 204: never + 403: components['responses']['forbidden'] + 500: components['responses']['internal_error'] + } + } /** * Get all deployment environments for a workflow run that are waiting for protection rules to pass. * * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/get-pending-deployments-for-run": { + 'actions/get-pending-deployments-for-run': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; - }; + run_id: components['parameters']['run-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pending-deployment"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['pending-deployment'][] + } + } + } + } /** * Approve or reject pending deployments that are waiting on approval by a required reviewer. * * Anyone with read access to the repository contents and deployments can use this endpoint. */ - "actions/review-pending-deployments-for-run": { + 'actions/review-pending-deployments-for-run': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; - }; + run_id: components['parameters']['run-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["deployment"][]; - }; - }; - }; + 'application/json': components['schemas']['deployment'][] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The list of environment ids to approve or reject * @example 161171787,161171795 */ - environment_ids: number[]; + environment_ids: number[] /** * @description Whether to approve or reject deployment to the specified environments. Must be one of: `approved` or `rejected` * @example approved * @enum {string} */ - state: "approved" | "rejected"; + state: 'approved' | 'rejected' /** * @description A comment to accompany the deployment review * @example Ship it! */ - comment: string; - }; - }; - }; - }; + comment: string + } + } + } + } /** Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - "actions/re-run-workflow": { + 'actions/re-run-workflow': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; - }; + run_id: components['parameters']['run-id'] + } + } responses: { /** Response */ 201: { content: { - "application/json": { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': { [key: string]: unknown } + } + } + } + } /** * Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/get-workflow-run-usage": { + 'actions/get-workflow-run-usage': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; - }; + run_id: components['parameters']['run-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["workflow-run-usage"]; - }; - }; - }; - }; + 'application/json': components['schemas']['workflow-run-usage'] + } + } + } + } /** Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - "actions/list-repo-secrets": { + 'actions/list-repo-secrets': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - secrets: components["schemas"]["actions-secret"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + secrets: components['schemas']['actions-secret'][] + } + } + } + } + } /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - "actions/get-repo-public-key": { + 'actions/get-repo-public-key': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-public-key"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-public-key'] + } + } + } + } /** Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - "actions/get-repo-secret": { + 'actions/get-repo-secret': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-secret"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-secret'] + } + } + } + } /** * Creates or updates a repository secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -27530,116 +27513,116 @@ export interface operations { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - "actions/create-or-update-repo-secret": { + 'actions/create-or-update-repo-secret': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response when creating a secret */ 201: { content: { - "application/json": { [key: string]: unknown }; - }; - }; + 'application/json': { [key: string]: unknown } + } + } /** Response when updating a secret */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/reference/actions#get-a-repository-public-key) endpoint. */ - encrypted_value?: string; + encrypted_value?: string /** @description ID of the key you used to encrypt the secret. */ - key_id?: string; - }; - }; - }; - }; + key_id?: string + } + } + } + } /** Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - "actions/delete-repo-secret": { + 'actions/delete-repo-secret': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/list-repo-workflows": { + 'actions/list-repo-workflows': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - workflows: components["schemas"]["workflow"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + workflows: components['schemas']['workflow'][] + } + } + } + } + } /** Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/get-workflow": { + 'actions/get-workflow': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The ID of the workflow. You can also pass the workflow file name as a string. */ - workflow_id: components["parameters"]["workflow-id"]; - }; - }; + workflow_id: components['parameters']['workflow-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["workflow"]; - }; - }; - }; - }; + 'application/json': components['schemas']['workflow'] + } + } + } + } /** * Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - "actions/disable-workflow": { + 'actions/disable-workflow': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The ID of the workflow. You can also pass the workflow file name as a string. */ - workflow_id: components["parameters"]["workflow-id"]; - }; - }; + workflow_id: components['parameters']['workflow-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * @@ -27647,144 +27630,144 @@ export interface operations { * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)." */ - "actions/create-workflow-dispatch": { + 'actions/create-workflow-dispatch': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The ID of the workflow. You can also pass the workflow file name as a string. */ - workflow_id: components["parameters"]["workflow-id"]; - }; - }; + workflow_id: components['parameters']['workflow-id'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The git reference for the workflow. The reference can be a branch or tag name. */ - ref: string; + ref: string /** @description Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted. */ - inputs?: { [key: string]: string }; - }; - }; - }; - }; + inputs?: { [key: string]: string } + } + } + } + } /** * Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - "actions/enable-workflow": { + 'actions/enable-workflow': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The ID of the workflow. You can also pass the workflow file name as a string. */ - workflow_id: components["parameters"]["workflow-id"]; - }; - }; + workflow_id: components['parameters']['workflow-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). * * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. */ - "actions/list-workflow-runs": { + 'actions/list-workflow-runs': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The ID of the workflow. You can also pass the workflow file name as a string. */ - workflow_id: components["parameters"]["workflow-id"]; - }; + workflow_id: components['parameters']['workflow-id'] + } query: { /** Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ - actor?: components["parameters"]["actor"]; + actor?: components['parameters']['actor'] /** Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ - branch?: components["parameters"]["workflow-run-branch"]; + branch?: components['parameters']['workflow-run-branch'] /** Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ - event?: components["parameters"]["event"]; + event?: components['parameters']['event'] /** Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. For a list of the possible `status` and `conclusion` options, see "[Create a check run](https://docs.github.com/rest/reference/checks#create-a-check-run)." */ - status?: components["parameters"]["workflow-run-status"]; + status?: components['parameters']['workflow-run-status'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ - created?: components["parameters"]["created"]; + created?: components['parameters']['created'] /** If `true` pull requests are omitted from the response (empty array). */ - exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; + exclude_pull_requests?: components['parameters']['exclude-pull-requests'] /** Returns workflow runs with the `check_suite_id` that you specify. */ - check_suite_id?: components["parameters"]["workflow-run-check-suite-id"]; - }; - }; + check_suite_id?: components['parameters']['workflow-run-check-suite-id'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - workflow_runs: components["schemas"]["workflow-run"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + workflow_runs: components['schemas']['workflow-run'][] + } + } + } + } + } /** * Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * * You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/get-workflow-usage": { + 'actions/get-workflow-usage': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The ID of the workflow. You can also pass the workflow file name as a string. */ - workflow_id: components["parameters"]["workflow-id"]; - }; - }; + workflow_id: components['parameters']['workflow-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["workflow-usage"]; - }; - }; - }; - }; + 'application/json': components['schemas']['workflow-usage'] + } + } + } + } /** Lists the [available assignees](https://docs.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. */ - "issues/list-assignees": { + 'issues/list-assignees': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + 404: components['responses']['not_found'] + } + } /** * Checks if a user has permission to be assigned to an issue in this repository. * @@ -27792,218 +27775,218 @@ export interface operations { * * Otherwise a `404` status code is returned. */ - "issues/check-user-can-be-assigned": { + 'issues/check-user-can-be-assigned': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - assignee: string; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + assignee: string + } + } responses: { /** If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. */ - 204: never; + 204: never /** Otherwise a `404` status code is returned. */ 404: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } + } + } /** * This returns a list of autolinks configured for the given repository. * * Information about autolinks are only available to repository administrators. */ - "repos/list-autolinks": { + 'repos/list-autolinks': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["autolink"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['autolink'][] + } + } + } + } /** Users with admin access to the repository can create an autolink. */ - "repos/create-autolink": { + 'repos/create-autolink': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["autolink"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['autolink'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit. */ - key_prefix: string; + key_prefix: string /** @description The URL must contain for the reference number. */ - url_template: string; - }; - }; - }; - }; + url_template: string + } + } + } + } /** * This returns a single autolink reference by ID that was configured for the given repository. * * Information about autolinks are only available to repository administrators. */ - "repos/get-autolink": { + 'repos/get-autolink': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** autolink_id parameter */ - autolink_id: components["parameters"]["autolink-id"]; - }; - }; + autolink_id: components['parameters']['autolink-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["autolink"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['autolink'] + } + } + 404: components['responses']['not_found'] + } + } /** * This deletes a single autolink reference by ID that was configured for the given repository. * * Information about autolinks are only available to repository administrators. */ - "repos/delete-autolink": { + 'repos/delete-autolink': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** autolink_id parameter */ - autolink_id: components["parameters"]["autolink-id"]; - }; - }; + autolink_id: components['parameters']['autolink-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/en/articles/configuring-automated-security-fixes)". */ - "repos/enable-automated-security-fixes": { + 'repos/enable-automated-security-fixes': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/en/articles/configuring-automated-security-fixes)". */ - "repos/disable-automated-security-fixes": { + 'repos/disable-automated-security-fixes': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; - }; - "repos/list-branches": { + 204: never + } + } + 'repos/list-branches': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches. */ - protected?: boolean; + protected?: boolean /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["short-branch"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "repos/get-branch": { + 'application/json': components['schemas']['short-branch'][] + } + } + 404: components['responses']['not_found'] + } + } + 'repos/get-branch': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["branch-with-protection"]; - }; - }; - 301: components["responses"]["moved_permanently"]; - 404: components["responses"]["not_found"]; - 415: components["responses"]["preview_header_missing"]; - }; - }; + 'application/json': components['schemas']['branch-with-protection'] + } + } + 301: components['responses']['moved_permanently'] + 404: components['responses']['not_found'] + 415: components['responses']['preview_header_missing'] + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "repos/get-branch-protection": { + 'repos/get-branch-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["branch-protection"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['branch-protection'] + } + } + 404: components['responses']['not_found'] + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28013,205 +27996,205 @@ export interface operations { * * **Note**: The list of users, apps, and teams in total is limited to 100 items. */ - "repos/update-branch-protection": { + 'repos/update-branch-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["protected-branch"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': components['schemas']['protected-branch'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Require status checks to pass before merging. Set to `null` to disable. */ required_status_checks: { /** @description Require branches to be up to date before merging. */ - strict: boolean; + strict: boolean /** * @deprecated * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. */ - contexts: string[]; + contexts: string[] /** @description The list of status checks to require in order to merge into this branch. */ checks?: { /** @description The name of the required check */ - context: string; + context: string /** @description The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status. */ - app_id?: number; - }[]; - } | null; + app_id?: number + }[] + } | null /** @description Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable. */ - enforce_admins: boolean | null; + enforce_admins: boolean | null /** @description Require at least one approving review on a pull request, before merging. Set to `null` to disable. */ required_pull_request_reviews: { /** @description Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories. */ dismissal_restrictions?: { /** @description The list of user `login`s with dismissal access */ - users?: string[]; + users?: string[] /** @description The list of team `slug`s with dismissal access */ - teams?: string[]; - }; + teams?: string[] + } /** @description Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit. */ - dismiss_stale_reviews?: boolean; + dismiss_stale_reviews?: boolean /** @description Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them. */ - require_code_owner_reviews?: boolean; + require_code_owner_reviews?: boolean /** @description Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers. */ - required_approving_review_count?: number; + required_approving_review_count?: number /** @description Allow specific users or teams to bypass pull request requirements. Set to `null` to disable. */ bypass_pull_request_allowances?: { /** @description The list of user `login`s allowed to bypass pull request requirements. */ - users?: string[]; + users?: string[] /** @description The list of team `slug`s allowed to bypass pull request requirements. */ - teams?: string[]; - } | null; - } | null; + teams?: string[] + } | null + } | null /** @description Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable. */ restrictions: { /** @description The list of user `login`s with push access */ - users: string[]; + users: string[] /** @description The list of team `slug`s with push access */ - teams: string[]; + teams: string[] /** @description The list of app `slug`s with push access */ - apps?: string[]; - } | null; + apps?: string[] + } | null /** @description Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see "[Requiring a linear commit history](https://docs.github.com/github/administering-a-repository/requiring-a-linear-commit-history)" in the GitHub Help documentation. */ - required_linear_history?: boolean; + required_linear_history?: boolean /** @description Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation." */ - allow_force_pushes?: boolean | null; + allow_force_pushes?: boolean | null /** @description Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation. */ - allow_deletions?: boolean; + allow_deletions?: boolean /** @description Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`. */ - required_conversation_resolution?: boolean; - }; - }; - }; - }; + required_conversation_resolution?: boolean + } + } + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "repos/delete-branch-protection": { + 'repos/delete-branch-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ - 204: never; - 403: components["responses"]["forbidden"]; - }; - }; + 204: never + 403: components['responses']['forbidden'] + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "repos/get-admin-branch-protection": { + 'repos/get-admin-branch-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["protected-branch-admin-enforced"]; - }; - }; - }; - }; + 'application/json': components['schemas']['protected-branch-admin-enforced'] + } + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ - "repos/set-admin-branch-protection": { + 'repos/set-admin-branch-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["protected-branch-admin-enforced"]; - }; - }; - }; - }; + 'application/json': components['schemas']['protected-branch-admin-enforced'] + } + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ - "repos/delete-admin-branch-protection": { + 'repos/delete-admin-branch-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "repos/get-pull-request-review-protection": { + 'repos/get-pull-request-review-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["protected-branch-pull-request-review"]; - }; - }; - }; - }; + 'application/json': components['schemas']['protected-branch-pull-request-review'] + } + } + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "repos/delete-pull-request-review-protection": { + 'repos/delete-pull-request-review-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28219,51 +28202,51 @@ export interface operations { * * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. */ - "repos/update-pull-request-review-protection": { + 'repos/update-pull-request-review-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["protected-branch-pull-request-review"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['protected-branch-pull-request-review'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories. */ dismissal_restrictions?: { /** @description The list of user `login`s with dismissal access */ - users?: string[]; + users?: string[] /** @description The list of team `slug`s with dismissal access */ - teams?: string[]; - }; + teams?: string[] + } /** @description Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit. */ - dismiss_stale_reviews?: boolean; + dismiss_stale_reviews?: boolean /** @description Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) have reviewed. */ - require_code_owner_reviews?: boolean; + require_code_owner_reviews?: boolean /** @description Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers. */ - required_approving_review_count?: number; + required_approving_review_count?: number /** @description Allow specific users or teams to bypass pull request requirements. Set to `null` to disable. */ bypass_pull_request_allowances?: { /** @description The list of user `login`s allowed to bypass pull request requirements. */ - users?: string[]; + users?: string[] /** @description The list of team `slug`s allowed to bypass pull request requirements. */ - teams?: string[]; - } | null; - }; - }; - }; - }; + teams?: string[] + } | null + } + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28271,263 +28254,263 @@ export interface operations { * * **Note**: You must enable branch protection to require signed commits. */ - "repos/get-commit-signature-protection": { + 'repos/get-commit-signature-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["protected-branch-admin-enforced"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['protected-branch-admin-enforced'] + } + } + 404: components['responses']['not_found'] + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits. */ - "repos/create-commit-signature-protection": { + 'repos/create-commit-signature-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["protected-branch-admin-enforced"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['protected-branch-admin-enforced'] + } + } + 404: components['responses']['not_found'] + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits. */ - "repos/delete-commit-signature-protection": { + 'repos/delete-commit-signature-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "repos/get-status-checks-protection": { + 'repos/get-status-checks-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["status-check-policy"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['status-check-policy'] + } + } + 404: components['responses']['not_found'] + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "repos/remove-status-check-protection": { + 'repos/remove-status-check-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. */ - "repos/update-status-check-protection": { + 'repos/update-status-check-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["status-check-policy"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['status-check-policy'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Require branches to be up to date before merging. */ - strict?: boolean; + strict?: boolean /** * @deprecated * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. */ - contexts?: string[]; + contexts?: string[] /** @description The list of status checks to require in order to merge into this branch. */ checks?: { /** @description The name of the required check */ - context: string; + context: string /** @description The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status. */ - app_id?: number; - }[]; - }; - }; - }; - }; + app_id?: number + }[] + } + } + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "repos/get-all-status-check-contexts": { + 'repos/get-all-status-check-contexts': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": string[]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': string[] + } + } + 404: components['responses']['not_found'] + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "repos/set-status-check-contexts": { + 'repos/set-status-check-contexts': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": string[]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': string[] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description contexts parameter */ - contexts: string[]; + contexts: string[] } - | string[]; - }; - }; - }; + | string[] + } + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "repos/add-status-check-contexts": { + 'repos/add-status-check-contexts': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": string[]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': string[] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description contexts parameter */ - contexts: string[]; + contexts: string[] } - | string[]; - }; - }; - }; + | string[] + } + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "repos/remove-status-check-contexts": { + 'repos/remove-status-check-contexts': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": string[]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': string[] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description contexts parameter */ - contexts: string[]; + contexts: string[] } - | string[]; - }; - }; - }; + | string[] + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28535,68 +28518,68 @@ export interface operations { * * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. */ - "repos/get-access-restrictions": { + 'repos/get-access-restrictions': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["branch-restriction-policy"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['branch-restriction-policy'] + } + } + 404: components['responses']['not_found'] + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Disables the ability to restrict who can push to this branch. */ - "repos/delete-access-restrictions": { + 'repos/delete-access-restrictions': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. */ - "repos/get-apps-with-access-to-protected-branch": { + 'repos/get-apps-with-access-to-protected-branch': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["integration"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['integration'][] + } + } + 404: components['responses']['not_found'] + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28606,35 +28589,35 @@ export interface operations { * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - "repos/set-app-access-restrictions": { + 'repos/set-app-access-restrictions': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["integration"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['integration'][] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description apps parameter */ - apps: string[]; + apps: string[] } - | string[]; - }; - }; - }; + | string[] + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28644,35 +28627,35 @@ export interface operations { * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - "repos/add-app-access-restrictions": { + 'repos/add-app-access-restrictions': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["integration"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['integration'][] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description apps parameter */ - apps: string[]; + apps: string[] } - | string[]; - }; - }; - }; + | string[] + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28682,59 +28665,59 @@ export interface operations { * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - "repos/remove-app-access-restrictions": { + 'repos/remove-app-access-restrictions': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["integration"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['integration'][] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description apps parameter */ - apps: string[]; + apps: string[] } - | string[]; - }; - }; - }; + | string[] + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the teams who have push access to this branch. The list includes child teams. */ - "repos/get-teams-with-access-to-protected-branch": { + 'repos/get-teams-with-access-to-protected-branch': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['team'][] + } + } + 404: components['responses']['not_found'] + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28744,35 +28727,35 @@ export interface operations { * | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ | * | `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - "repos/set-team-access-restrictions": { + 'repos/set-team-access-restrictions': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['team'][] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description teams parameter */ - teams: string[]; + teams: string[] } - | string[]; - }; - }; - }; + | string[] + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28782,35 +28765,35 @@ export interface operations { * | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ | * | `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - "repos/add-team-access-restrictions": { + 'repos/add-team-access-restrictions': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['team'][] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description teams parameter */ - teams: string[]; + teams: string[] } - | string[]; - }; - }; - }; + | string[] + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28820,59 +28803,59 @@ export interface operations { * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | Teams that should no longer have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - "repos/remove-team-access-restrictions": { + 'repos/remove-team-access-restrictions': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['team'][] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description teams parameter */ - teams: string[]; + teams: string[] } - | string[]; - }; - }; - }; + | string[] + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the people who have push access to this branch. */ - "repos/get-users-with-access-to-protected-branch": { + 'repos/get-users-with-access-to-protected-branch': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + 404: components['responses']['not_found'] + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28882,35 +28865,35 @@ export interface operations { * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - "repos/set-user-access-restrictions": { + 'repos/set-user-access-restrictions': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description users parameter */ - users: string[]; + users: string[] } - | string[]; - }; - }; - }; + | string[] + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28920,35 +28903,35 @@ export interface operations { * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - "repos/add-user-access-restrictions": { + 'repos/add-user-access-restrictions': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description users parameter */ - users: string[]; + users: string[] } - | string[]; - }; - }; - }; + | string[] + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28958,35 +28941,35 @@ export interface operations { * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - "repos/remove-user-access-restrictions": { + 'repos/remove-user-access-restrictions': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description users parameter */ - users: string[]; + users: string[] } - | string[]; - }; - }; - }; + | string[] + } + } + } /** * Renames a branch in a repository. * @@ -29004,35 +28987,35 @@ export interface operations { * * Users must have admin or owner permissions. * * GitHub Apps must have the `administration:write` repository permission. */ - "repos/rename-branch": { + 'repos/rename-branch': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["branch-with-protection"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['branch-with-protection'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The new name of the branch. */ - new_name: string; - }; - }; - }; - }; + new_name: string + } + } + } + } /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * @@ -29040,590 +29023,574 @@ export interface operations { * * In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. */ - "checks/create": { + 'checks/create': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["check-run"]; - }; - }; - }; + 'application/json': components['schemas']['check-run'] + } + } + } requestBody: { content: { - "application/json": ( + 'application/json': ( | ({ /** @enum {undefined} */ - status: "completed"; + status: 'completed' } & { - conclusion: unknown; + conclusion: unknown } & { [key: string]: unknown }) | ({ /** @enum {undefined} */ - status?: "queued" | "in_progress"; + status?: 'queued' | 'in_progress' } & { [key: string]: unknown }) ) & { /** @description The name of the check. For example, "code-coverage". */ - name: string; + name: string /** @description The SHA of the commit. */ - head_sha: string; + head_sha: string /** @description The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used. */ - details_url?: string; + details_url?: string /** @description A reference for the run on the integrator's system. */ - external_id?: string; + external_id?: string /** * @description The current status. Can be one of `queued`, `in_progress`, or `completed`. * @default queued * @enum {string} */ - status?: "queued" | "in_progress" | "completed"; + status?: 'queued' | 'in_progress' | 'completed' /** * Format: date-time * @description The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - started_at?: string; + started_at?: string /** * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. * @enum {string} */ - conclusion?: - | "action_required" - | "cancelled" - | "failure" - | "neutral" - | "success" - | "skipped" - | "stale" - | "timed_out"; + conclusion?: 'action_required' | 'cancelled' | 'failure' | 'neutral' | 'success' | 'skipped' | 'stale' | 'timed_out' /** * Format: date-time * @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - completed_at?: string; + completed_at?: string /** @description Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/rest/reference/checks#output-object) description. */ output?: { /** @description The title of the check run. */ - title: string; + title: string /** @description The summary of the check run. This parameter supports Markdown. */ - summary: string; + summary: string /** @description The details of the check run. This parameter supports Markdown. */ - text?: string; + text?: string /** @description Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". See the [`annotations` object](https://docs.github.com/rest/reference/checks#annotations-object) description for details about how to use this parameter. */ annotations?: { /** @description The path of the file to add an annotation to. For example, `assets/css/main.css`. */ - path: string; + path: string /** @description The start line of the annotation. */ - start_line: number; + start_line: number /** @description The end line of the annotation. */ - end_line: number; + end_line: number /** @description The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */ - start_column?: number; + start_column?: number /** @description The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */ - end_column?: number; + end_column?: number /** * @description The level of the annotation. Can be one of `notice`, `warning`, or `failure`. * @enum {string} */ - annotation_level: "notice" | "warning" | "failure"; + annotation_level: 'notice' | 'warning' | 'failure' /** @description A short description of the feedback for these lines of code. The maximum size is 64 KB. */ - message: string; + message: string /** @description The title that represents the annotation. The maximum size is 255 characters. */ - title?: string; + title?: string /** @description Details about this annotation. The maximum size is 64 KB. */ - raw_details?: string; - }[]; + raw_details?: string + }[] /** @description Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/rest/reference/checks#images-object) description for details. */ images?: { /** @description The alternative text for the image. */ - alt: string; + alt: string /** @description The full URL of the image. */ - image_url: string; + image_url: string /** @description A short image description. */ - caption?: string; - }[]; - }; + caption?: string + }[] + } /** @description Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions)." */ actions?: | [] | [ { /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ - label: string; + label: string /** @description A short explanation of what this action would do. The maximum size is 40 characters. */ - description: string; + description: string /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ - identifier: string; - } + identifier: string + }, ] | [ { /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ - label: string; + label: string /** @description A short explanation of what this action would do. The maximum size is 40 characters. */ - description: string; + description: string /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ - identifier: string; + identifier: string }, { /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ - label: string; + label: string /** @description A short explanation of what this action would do. The maximum size is 40 characters. */ - description: string; + description: string /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ - identifier: string; - } + identifier: string + }, ] | [ { /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ - label: string; + label: string /** @description A short explanation of what this action would do. The maximum size is 40 characters. */ - description: string; + description: string /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ - identifier: string; + identifier: string }, { /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ - label: string; + label: string /** @description A short explanation of what this action would do. The maximum size is 40 characters. */ - description: string; + description: string /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ - identifier: string; + identifier: string }, { /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ - label: string; + label: string /** @description A short explanation of what this action would do. The maximum size is 40 characters. */ - description: string; + description: string /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ - identifier: string; - } - ]; - }; - }; - }; - }; + identifier: string + }, + ] + } + } + } + } /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * Gets a single check run using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. */ - "checks/get": { + 'checks/get': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** check_run_id parameter */ - check_run_id: components["parameters"]["check-run-id"]; - }; - }; + check_run_id: components['parameters']['check-run-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["check-run"]; - }; - }; - }; - }; + 'application/json': components['schemas']['check-run'] + } + } + } + } /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. */ - "checks/update": { + 'checks/update': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** check_run_id parameter */ - check_run_id: components["parameters"]["check-run-id"]; - }; - }; + check_run_id: components['parameters']['check-run-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["check-run"]; - }; - }; - }; + 'application/json': components['schemas']['check-run'] + } + } + } requestBody: { content: { - "application/json": (Partial< + 'application/json': (Partial< { /** @enum {undefined} */ - status?: "completed"; + status?: 'completed' } & { - conclusion: unknown; + conclusion: unknown } & { [key: string]: unknown } > & Partial< { /** @enum {undefined} */ - status?: "queued" | "in_progress"; + status?: 'queued' | 'in_progress' } & { [key: string]: unknown } >) & { /** @description The name of the check. For example, "code-coverage". */ - name?: string; + name?: string /** @description The URL of the integrator's site that has the full details of the check. */ - details_url?: string; + details_url?: string /** @description A reference for the run on the integrator's system. */ - external_id?: string; + external_id?: string /** * Format: date-time * @description This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - started_at?: string; + started_at?: string /** * @description The current status. Can be one of `queued`, `in_progress`, or `completed`. * @enum {string} */ - status?: "queued" | "in_progress" | "completed"; + status?: 'queued' | 'in_progress' | 'completed' /** * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. * @enum {string} */ - conclusion?: - | "action_required" - | "cancelled" - | "failure" - | "neutral" - | "success" - | "skipped" - | "stale" - | "timed_out"; + conclusion?: 'action_required' | 'cancelled' | 'failure' | 'neutral' | 'success' | 'skipped' | 'stale' | 'timed_out' /** * Format: date-time * @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - completed_at?: string; + completed_at?: string /** @description Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/rest/reference/checks#output-object-1) description. */ output?: { /** @description **Required**. */ - title?: string; + title?: string /** @description Can contain Markdown. */ - summary: string; + summary: string /** @description Can contain Markdown. */ - text?: string; + text?: string /** @description Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". See the [`annotations` object](https://docs.github.com/rest/reference/checks#annotations-object-1) description for details. */ annotations?: { /** @description The path of the file to add an annotation to. For example, `assets/css/main.css`. */ - path: string; + path: string /** @description The start line of the annotation. */ - start_line: number; + start_line: number /** @description The end line of the annotation. */ - end_line: number; + end_line: number /** @description The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */ - start_column?: number; + start_column?: number /** @description The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */ - end_column?: number; + end_column?: number /** * @description The level of the annotation. Can be one of `notice`, `warning`, or `failure`. * @enum {string} */ - annotation_level: "notice" | "warning" | "failure"; + annotation_level: 'notice' | 'warning' | 'failure' /** @description A short description of the feedback for these lines of code. The maximum size is 64 KB. */ - message: string; + message: string /** @description The title that represents the annotation. The maximum size is 255 characters. */ - title?: string; + title?: string /** @description Details about this annotation. The maximum size is 64 KB. */ - raw_details?: string; - }[]; + raw_details?: string + }[] /** @description Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/rest/reference/checks#annotations-object-1) description for details. */ images?: { /** @description The alternative text for the image. */ - alt: string; + alt: string /** @description The full URL of the image. */ - image_url: string; + image_url: string /** @description A short image description. */ - caption?: string; - }[]; - }; + caption?: string + }[] + } /** @description Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions)." */ actions?: | [] | [ { /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ - label: string; + label: string /** @description A short explanation of what this action would do. The maximum size is 40 characters. */ - description: string; + description: string /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ - identifier: string; - } + identifier: string + }, ] | [ { /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ - label: string; + label: string /** @description A short explanation of what this action would do. The maximum size is 40 characters. */ - description: string; + description: string /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ - identifier: string; + identifier: string }, { /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ - label: string; + label: string /** @description A short explanation of what this action would do. The maximum size is 40 characters. */ - description: string; + description: string /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ - identifier: string; - } + identifier: string + }, ] | [ { /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ - label: string; + label: string /** @description A short explanation of what this action would do. The maximum size is 40 characters. */ - description: string; + description: string /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ - identifier: string; + identifier: string }, { /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ - label: string; + label: string /** @description A short explanation of what this action would do. The maximum size is 40 characters. */ - description: string; + description: string /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ - identifier: string; + identifier: string }, { /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ - label: string; + label: string /** @description A short explanation of what this action would do. The maximum size is 40 characters. */ - description: string; + description: string /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ - identifier: string; - } - ]; - }; - }; - }; - }; + identifier: string + }, + ] + } + } + } + } /** Lists annotations for a check run using the annotation `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the `repo` scope to get annotations for a check run in a private repository. */ - "checks/list-annotations": { + 'checks/list-annotations': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** check_run_id parameter */ - check_run_id: components["parameters"]["check-run-id"]; - }; + check_run_id: components['parameters']['check-run-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["check-annotation"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['check-annotation'][] + } + } + } + } /** * Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * * To rerequest a check run, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository. */ - "checks/rerequest-run": { + 'checks/rerequest-run': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** check_run_id parameter */ - check_run_id: components["parameters"]["check-run-id"]; - }; - }; + check_run_id: components['parameters']['check-run-id'] + } + } responses: { /** Response */ 201: { content: { - "application/json": { [key: string]: unknown }; - }; - }; + 'application/json': { [key: string]: unknown } + } + } /** Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App */ 403: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - 404: components["responses"]["not_found"]; + 'application/json': components['schemas']['basic-error'] + } + } + 404: components['responses']['not_found'] /** Validation error if the check run is not rerequestable */ 422: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } + } + } /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * * By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/reference/checks#check-runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/reference/checks#update-repository-preferences-for-check-suites)". Your GitHub App must have the `checks:write` permission to create check suites. */ - "checks/create-suite": { + 'checks/create-suite': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** when the suite already existed */ 200: { content: { - "application/json": components["schemas"]["check-suite"]; - }; - }; + 'application/json': components['schemas']['check-suite'] + } + } /** Response when the suite was created */ 201: { content: { - "application/json": components["schemas"]["check-suite"]; - }; - }; - }; + 'application/json': components['schemas']['check-suite'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The sha of the head commit. */ - head_sha: string; - }; - }; - }; - }; + head_sha: string + } + } + } + } /** Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/reference/checks#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites. */ - "checks/set-suites-preferences": { + 'checks/set-suites-preferences': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["check-suite-preference"]; - }; - }; - }; + 'application/json': components['schemas']['check-suite-preference'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/rest/reference/checks#auto_trigger_checks-object) description for details. */ auto_trigger_checks?: { /** @description The `id` of the GitHub App. */ - app_id: number; + app_id: number /** * @description Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them. * @default true */ - setting: boolean; - }[]; - }; - }; - }; - }; + setting: boolean + }[] + } + } + } + } /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * * Gets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository. */ - "checks/get-suite": { + 'checks/get-suite': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** check_suite_id parameter */ - check_suite_id: components["parameters"]["check-suite-id"]; - }; - }; + check_suite_id: components['parameters']['check-suite-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["check-suite"]; - }; - }; - }; - }; + 'application/json': components['schemas']['check-suite'] + } + } + } + } /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. */ - "checks/list-for-suite": { + 'checks/list-for-suite': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** check_suite_id parameter */ - check_suite_id: components["parameters"]["check-suite-id"]; - }; + check_suite_id: components['parameters']['check-suite-id'] + } query: { /** Returns check runs with the specified `name`. */ - check_name?: components["parameters"]["check-name"]; + check_name?: components['parameters']['check-name'] /** Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`. */ - status?: components["parameters"]["status"]; + status?: components['parameters']['status'] /** Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`. */ - filter?: "latest" | "all"; + filter?: 'latest' | 'all' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - check_runs: components["schemas"]["check-run"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + check_runs: components['schemas']['check-run'][] + } + } + } + } + } /** * Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * * To rerequest a check suite, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository. */ - "checks/rerequest-suite": { + 'checks/rerequest-suite': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** check_suite_id parameter */ - check_suite_id: components["parameters"]["check-suite-id"]; - }; - }; + check_suite_id: components['parameters']['check-suite-id'] + } + } responses: { /** Response */ 201: { content: { - "application/json": { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': { [key: string]: unknown } + } + } + } + } /** * Lists all open code scanning alerts for the default branch (usually `main` * or `master`). You must use an access token with the `security_events` scope to use @@ -29636,137 +29603,137 @@ export interface operations { * for the default branch or for the specified Git reference * (if you used `ref` in the request). */ - "code-scanning/list-alerts-for-repo": { + 'code-scanning/list-alerts-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */ - tool_name?: components["parameters"]["tool-name"]; + tool_name?: components['parameters']['tool-name'] /** The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ - tool_guid?: components["parameters"]["tool-guid"]; + tool_guid?: components['parameters']['tool-guid'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ - ref?: components["parameters"]["git-ref"]; + ref?: components['parameters']['git-ref'] /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Can be one of `created`, `updated`, `number`. */ - sort?: "created" | "updated" | "number"; + sort?: 'created' | 'updated' | 'number' /** Set to `open`, `closed, `fixed`, or `dismissed` to list code scanning alerts in a specific state. */ - state?: components["schemas"]["code-scanning-alert-state"]; - }; - }; + state?: components['schemas']['code-scanning-alert-state'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["code-scanning-alert-items"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["code_scanning_forbidden_read"]; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': components['schemas']['code-scanning-alert-items'][] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['code_scanning_forbidden_read'] + 404: components['responses']['not_found'] + 503: components['responses']['service_unavailable'] + } + } /** * Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint. * * **Deprecation notice**: * The instances field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The same information can now be retrieved via a GET request to the URL specified by `instances_url`. */ - "code-scanning/get-alert": { + 'code-scanning/get-alert': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ - alert_number: components["parameters"]["alert-number"]; - }; - }; + alert_number: components['parameters']['alert-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["code-scanning-alert"]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["code_scanning_forbidden_read"]; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': components['schemas']['code-scanning-alert'] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['code_scanning_forbidden_read'] + 404: components['responses']['not_found'] + 503: components['responses']['service_unavailable'] + } + } /** Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. */ - "code-scanning/update-alert": { + 'code-scanning/update-alert': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ - alert_number: components["parameters"]["alert-number"]; - }; - }; + alert_number: components['parameters']['alert-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["code-scanning-alert"]; - }; - }; - 403: components["responses"]["code_scanning_forbidden_write"]; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; - }; + 'application/json': components['schemas']['code-scanning-alert'] + } + } + 403: components['responses']['code_scanning_forbidden_write'] + 404: components['responses']['not_found'] + 503: components['responses']['service_unavailable'] + } requestBody: { content: { - "application/json": { - state: components["schemas"]["code-scanning-alert-set-state"]; - dismissed_reason?: components["schemas"]["code-scanning-alert-dismissed-reason"]; - }; - }; - }; - }; + 'application/json': { + state: components['schemas']['code-scanning-alert-set-state'] + dismissed_reason?: components['schemas']['code-scanning-alert-dismissed-reason'] + } + } + } + } /** * Lists all instances of the specified code scanning alert. * You must use an access token with the `security_events` scope to use this endpoint with private repos, * the `public_repo` scope also grants permission to read security events on public repos only. * GitHub Apps must have the `security_events` read permission to use this endpoint. */ - "code-scanning/list-alert-instances": { + 'code-scanning/list-alert-instances': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ - alert_number: components["parameters"]["alert-number"]; - }; + alert_number: components['parameters']['alert-number'] + } query: { /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ - ref?: components["parameters"]["git-ref"]; - }; - }; + ref?: components['parameters']['git-ref'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["code-scanning-alert-instance"][]; - }; - }; - 403: components["responses"]["code_scanning_forbidden_read"]; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': components['schemas']['code-scanning-alert-instance'][] + } + } + 403: components['responses']['code_scanning_forbidden_read'] + 404: components['responses']['not_found'] + 503: components['responses']['service_unavailable'] + } + } /** * Lists the details of all code scanning analyses for a repository, * starting with the most recent. @@ -29786,39 +29753,39 @@ export interface operations { * **Deprecation notice**: * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. */ - "code-scanning/list-recent-analyses": { + 'code-scanning/list-recent-analyses': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */ - tool_name?: components["parameters"]["tool-name"]; + tool_name?: components['parameters']['tool-name'] /** The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ - tool_guid?: components["parameters"]["tool-guid"]; + tool_guid?: components['parameters']['tool-guid'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ - ref?: components["schemas"]["code-scanning-ref"]; + ref?: components['schemas']['code-scanning-ref'] /** Filter analyses belonging to the same SARIF upload. */ - sarif_id?: components["schemas"]["code-scanning-analysis-sarif-id"]; - }; - }; + sarif_id?: components['schemas']['code-scanning-analysis-sarif-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["code-scanning-analysis"][]; - }; - }; - 403: components["responses"]["code_scanning_forbidden_read"]; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': components['schemas']['code-scanning-analysis'][] + } + } + 403: components['responses']['code_scanning_forbidden_read'] + 404: components['responses']['not_found'] + 503: components['responses']['service_unavailable'] + } + } /** * Gets a specified code scanning analysis for a repository. * You must use an access token with the `security_events` scope to use this endpoint with private repos, @@ -29840,28 +29807,28 @@ export interface operations { * This is formatted as * [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). */ - "code-scanning/get-analysis": { + 'code-scanning/get-analysis': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation. */ - analysis_id: number; - }; - }; + analysis_id: number + } + } responses: { /** Response */ 200: { content: { - "application/json+sarif": string; - "application/json": components["schemas"]["code-scanning-analysis"]; - }; - }; - 403: components["responses"]["code_scanning_forbidden_read"]; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json+sarif': string + 'application/json': components['schemas']['code-scanning-analysis'] + } + } + 403: components['responses']['code_scanning_forbidden_read'] + 404: components['responses']['not_found'] + 503: components['responses']['service_unavailable'] + } + } /** * Deletes a specified code scanning analysis from a repository. For * private repositories, you must use an access token with the `repo` scope. For public repositories, @@ -29930,32 +29897,32 @@ export interface operations { * * The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely. */ - "code-scanning/delete-analysis": { + 'code-scanning/delete-analysis': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation. */ - analysis_id: number; - }; + analysis_id: number + } query: { /** Allow deletion if the specified analysis is the last in a set. If you attempt to delete the final analysis in a set without setting this parameter to `true`, you'll get a 400 response with the message: `Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.` */ - confirm_delete?: string | null; - }; - }; + confirm_delete?: string | null + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["code-scanning-analysis-deletion"]; - }; - }; - 400: components["responses"]["bad_request"]; - 403: components["responses"]["code_scanning_forbidden_write"]; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': components['schemas']['code-scanning-analysis-deletion'] + } + } + 400: components['responses']['bad_request'] + 403: components['responses']['code_scanning_forbidden_write'] + 404: components['responses']['not_found'] + 503: components['responses']['service_unavailable'] + } + } /** * Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. * @@ -29975,155 +29942,155 @@ export interface operations { * You can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint. * For more information, see "[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload)." */ - "code-scanning/upload-sarif": { + 'code-scanning/upload-sarif': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 202: { content: { - "application/json": components["schemas"]["code-scanning-sarifs-receipt"]; - }; - }; + 'application/json': components['schemas']['code-scanning-sarifs-receipt'] + } + } /** Bad Request if the sarif field is invalid */ - 400: unknown; - 403: components["responses"]["code_scanning_forbidden_write"]; - 404: components["responses"]["not_found"]; + 400: unknown + 403: components['responses']['code_scanning_forbidden_write'] + 404: components['responses']['not_found'] /** Payload Too Large if the sarif field is too large */ - 413: unknown; - 503: components["responses"]["service_unavailable"]; - }; + 413: unknown + 503: components['responses']['service_unavailable'] + } requestBody: { content: { - "application/json": { - commit_sha: components["schemas"]["code-scanning-analysis-commit-sha"]; - ref: components["schemas"]["code-scanning-ref"]; - sarif: components["schemas"]["code-scanning-analysis-sarif-file"]; + 'application/json': { + commit_sha: components['schemas']['code-scanning-analysis-commit-sha'] + ref: components['schemas']['code-scanning-ref'] + sarif: components['schemas']['code-scanning-analysis-sarif-file'] /** * Format: uri * @description The base directory used in the analysis, as it appears in the SARIF file. * This property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository. * @example file:///github/workspace/ */ - checkout_uri?: string; + checkout_uri?: string /** * Format: date-time * @description The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - started_at?: string; + started_at?: string /** @description The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to "API". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`. */ - tool_name?: string; - }; - }; - }; - }; + tool_name?: string + } + } + } + } /** Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository)." You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint. */ - "code-scanning/get-sarif": { + 'code-scanning/get-sarif': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The SARIF ID obtained after uploading. */ - sarif_id: string; - }; - }; + sarif_id: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["code-scanning-sarifs-status"]; - }; - }; - 403: components["responses"]["code_scanning_forbidden_read"]; + 'application/json': components['schemas']['code-scanning-sarifs-status'] + } + } + 403: components['responses']['code_scanning_forbidden_read'] /** Not Found if the sarif id does not match any upload */ - 404: unknown; - 503: components["responses"]["service_unavailable"]; - }; - }; + 404: unknown + 503: components['responses']['service_unavailable'] + } + } /** * Lists the codespaces associated to a specified repository and the authenticated user. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/list-in-repository-for-authenticated-user": { + 'codespaces/list-in-repository-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; + page?: components['parameters']['page'] + } path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - codespaces: components["schemas"]["codespace"][]; - }; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': { + total_count: number + codespaces: components['schemas']['codespace'][] + } + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** * Creates a codespace owned by the authenticated user in the specified repository. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/create-with-repo-for-authenticated-user": { + 'codespaces/create-with-repo-for-authenticated-user': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response when the codespace was successfully created */ 201: { content: { - "application/json": components["schemas"]["codespace"]; - }; - }; + 'application/json': components['schemas']['codespace'] + } + } /** Response when the codespace creation partially failed but is being retried in the background */ 202: { content: { - "application/json": components["schemas"]["codespace"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; + 'application/json': components['schemas']['codespace'] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Git ref (typically a branch name) for this codespace */ - ref?: string; + ref?: string /** @description Location for this codespace */ - location: string; + location: string /** @description Machine type to use for this codespace */ - machine?: string; + machine?: string /** @description Working directory for this codespace */ - working_directory?: string; + working_directory?: string /** @description Time in minutes before codespace stops from inactivity */ - idle_timeout_minutes?: number; - }; - }; - }; - }; + idle_timeout_minutes?: number + } + } + } + } /** * List the machine types available for a given repository based on its configuration. * @@ -30131,34 +30098,34 @@ export interface operations { * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/repo-machines-for-authenticated-user": { + 'codespaces/repo-machines-for-authenticated-user': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Required. The location to check for available machines. */ - location: string; - }; - }; + location: string + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - machines: components["schemas"]["codespace-machine"][]; - }; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': { + total_count: number + machines: components['schemas']['codespace-machine'][] + } + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** * For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. * @@ -30168,12 +30135,12 @@ export interface operations { * endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this * endpoint. */ - "repos/list-collaborators": { + 'repos/list-collaborators': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** * Filter collaborators returned by their affiliation. Can be one of: @@ -30181,24 +30148,24 @@ export interface operations { * \* `direct`: All collaborators with permissions to an organization-owned repository, regardless of organization membership status. * \* `all`: All collaborators the authenticated user can see. */ - affiliation?: "outside" | "direct" | "all"; + affiliation?: 'outside' | 'direct' | 'all' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["collaborator"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['collaborator'][] + } + } + 404: components['responses']['not_found'] + } + } /** * For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. * @@ -30208,21 +30175,21 @@ export interface operations { * endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this * endpoint. */ - "repos/check-collaborator": { + 'repos/check-collaborator': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - username: components["parameters"]["username"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + username: components['parameters']['username'] + } + } responses: { /** Response if user is a collaborator */ - 204: never; + 204: never /** Not Found if user is not a collaborator */ - 404: unknown; - }; - }; + 404: unknown + } + } /** * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. * @@ -30240,29 +30207,29 @@ export interface operations { * * You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository. */ - "repos/add-collaborator": { + 'repos/add-collaborator': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - username: components["parameters"]["username"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + username: components['parameters']['username'] + } + } responses: { /** Response when a new invitation is created */ 201: { content: { - "application/json": components["schemas"]["repository-invitation"]; - }; - }; + 'application/json': components['schemas']['repository-invitation'] + } + } /** Response when person is already a collaborator */ - 204: never; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + 204: never + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: * \* `pull` - can pull, but not push to or administer this repository. @@ -30274,221 +30241,221 @@ export interface operations { * @default push * @enum {string} */ - permission?: "pull" | "push" | "admin" | "maintain" | "triage"; + permission?: 'pull' | 'push' | 'admin' | 'maintain' | 'triage' /** @example "push" */ - permissions?: string; - }; - }; - }; - }; - "repos/remove-collaborator": { + permissions?: string + } + } + } + } + 'repos/remove-collaborator': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - username: components["parameters"]["username"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** Checks the repository permission of a collaborator. The possible repository permissions are `admin`, `write`, `read`, and `none`. */ - "repos/get-collaborator-permission-level": { + 'repos/get-collaborator-permission-level': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - username: components["parameters"]["username"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + username: components['parameters']['username'] + } + } responses: { /** if user has admin permissions */ 200: { content: { - "application/json": components["schemas"]["repository-collaborator-permission"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['repository-collaborator-permission'] + } + } + 404: components['responses']['not_found'] + } + } /** * Commit Comments use [these custom media types](https://docs.github.com/rest/reference/repos#custom-media-types). You can read more about the use of media types in the API [here](https://docs.github.com/rest/overview/media-types/). * * Comments are ordered by ascending ID. */ - "repos/list-commit-comments-for-repo": { + 'repos/list-commit-comments-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["commit-comment"][]; - }; - }; - }; - }; - "repos/get-commit-comment": { + 'application/json': components['schemas']['commit-comment'][] + } + } + } + } + 'repos/get-commit-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["commit-comment"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "repos/delete-commit-comment": { + 'application/json': components['schemas']['commit-comment'] + } + } + 404: components['responses']['not_found'] + } + } + 'repos/delete-commit-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; - "repos/update-commit-comment": { + 204: never + 404: components['responses']['not_found'] + } + } + 'repos/update-commit-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["commit-comment"]; - }; - }; - 404: components["responses"]["not_found"]; - }; + 'application/json': components['schemas']['commit-comment'] + } + } + 404: components['responses']['not_found'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The contents of the comment */ - body: string; - }; - }; - }; - }; + body: string + } + } + } + } /** List the reactions to a [commit comment](https://docs.github.com/rest/reference/repos#comments). */ - "reactions/list-for-commit-comment": { + 'reactions/list-for-commit-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; + comment_id: components['parameters']['comment-id'] + } query: { /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a commit comment. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content?: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["reaction"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['reaction'][] + } + } + 404: components['responses']['not_found'] + } + } /** Create a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. */ - "reactions/create-for-commit-comment": { + 'reactions/create-for-commit-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Reaction exists */ 200: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; + 'application/json': components['schemas']['reaction'] + } + } /** Reaction created */ 201: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - 415: components["responses"]["preview_header_missing"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['reaction'] + } + } + 415: components['responses']['preview_header_missing'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the commit comment. * @enum {string} */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - }; + content: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' + } + } + } + } /** * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. * * Delete a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). */ - "reactions/delete-for-commit-comment": { + 'reactions/delete-for-commit-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - reaction_id: components["parameters"]["reaction-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + reaction_id: components['parameters']['reaction-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * **Signature verification object** * @@ -30519,161 +30486,161 @@ export interface operations { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - "repos/list-commits": { + 'repos/list-commits': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** SHA or branch to start listing commits from. Default: the repository’s default branch (usually `master`). */ - sha?: string; + sha?: string /** Only commits containing this file path will be returned. */ - path?: string; + path?: string /** GitHub login or email address by which to filter by commit author. */ - author?: string; + author?: string /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - until?: string; + until?: string /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["commit"][]; - }; - }; - 400: components["responses"]["bad_request"]; - 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': components['schemas']['commit'][] + } + } + 400: components['responses']['bad_request'] + 404: components['responses']['not_found'] + 409: components['responses']['conflict'] + 500: components['responses']['internal_error'] + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. */ - "repos/list-branches-for-head-commit": { + 'repos/list-branches-for-head-commit': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** commit_sha parameter */ - commit_sha: components["parameters"]["commit-sha"]; - }; - }; + commit_sha: components['parameters']['commit-sha'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["branch-short"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['branch-short'][] + } + } + 422: components['responses']['validation_failed'] + } + } /** Use the `:commit_sha` to specify the commit that will have its comments listed. */ - "repos/list-comments-for-commit": { + 'repos/list-comments-for-commit': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** commit_sha parameter */ - commit_sha: components["parameters"]["commit-sha"]; - }; + commit_sha: components['parameters']['commit-sha'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["commit-comment"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['commit-comment'][] + } + } + } + } /** * Create a comment for a commit using its `:commit_sha`. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - "repos/create-commit-comment": { + 'repos/create-commit-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** commit_sha parameter */ - commit_sha: components["parameters"]["commit-sha"]; - }; - }; + commit_sha: components['parameters']['commit-sha'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["commit-comment"]; - }; - }; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['commit-comment'] + } + } + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The contents of the comment. */ - body: string; + body: string /** @description Relative path of the file to comment on. */ - path?: string; + path?: string /** @description Line index in the diff to comment on. */ - position?: number; + position?: number /** @description **Deprecated**. Use **position** parameter instead. Line number in the file to comment on. */ - line?: number; - }; - }; - }; - }; + line?: number + } + } + } + } /** Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the [List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests) endpoint. */ - "repos/list-pull-requests-associated-with-commit": { + 'repos/list-pull-requests-associated-with-commit': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** commit_sha parameter */ - commit_sha: components["parameters"]["commit-sha"]; - }; + commit_sha: components['parameters']['commit-sha'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["pull-request-simple"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['pull-request-simple'][] + } + } + } + } /** * Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. * @@ -30712,110 +30679,110 @@ export interface operations { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - "repos/get-commit": { + 'repos/get-commit': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** ref parameter */ - ref: string; - }; + ref: string + } query: { /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["commit"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': components['schemas']['commit'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + 500: components['responses']['internal_error'] + } + } /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. */ - "checks/list-for-ref": { + 'checks/list-for-ref': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** ref parameter */ - ref: string; - }; + ref: string + } query: { /** Returns check runs with the specified `name`. */ - check_name?: components["parameters"]["check-name"]; + check_name?: components['parameters']['check-name'] /** Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`. */ - status?: components["parameters"]["status"]; + status?: components['parameters']['status'] /** Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`. */ - filter?: "latest" | "all"; + filter?: 'latest' | 'all' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - app_id?: number; - }; - }; + page?: components['parameters']['page'] + app_id?: number + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - check_runs: components["schemas"]["check-run"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + check_runs: components['schemas']['check-run'][] + } + } + } + } + } /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * * Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository. */ - "checks/list-suites-for-ref": { + 'checks/list-suites-for-ref': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** ref parameter */ - ref: string; - }; + ref: string + } query: { /** Filters check suites by GitHub App `id`. */ - app_id?: number; + app_id?: number /** Returns check runs with the specified `name`. */ - check_name?: components["parameters"]["check-name"]; + check_name?: components['parameters']['check-name'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - check_suites: components["schemas"]["check-suite"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + check_suites: components['schemas']['check-suite'][] + } + } + } + } + } /** * Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. * @@ -30826,62 +30793,62 @@ export interface operations { * * **pending** if there are no statuses or a context is `pending` * * **success** if the latest status for all contexts is `success` */ - "repos/get-combined-status-for-ref": { + 'repos/get-combined-status-for-ref': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** ref parameter */ - ref: string; - }; + ref: string + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["combined-commit-status"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['combined-commit-status'] + } + } + 404: components['responses']['not_found'] + } + } /** * Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one. * * This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`. */ - "repos/list-commit-statuses-for-ref": { + 'repos/list-commit-statuses-for-ref': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** ref parameter */ - ref: string; - }; + ref: string + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["status"][]; - }; - }; - 301: components["responses"]["moved_permanently"]; - }; - }; + 'application/json': components['schemas']['status'][] + } + } + 301: components['responses']['moved_permanently'] + } + } /** * This endpoint will return all community profile metrics, including an * overall health score, repository description, the presence of documentation, detected @@ -30896,22 +30863,22 @@ export interface operations { * * `content_reports_enabled` is only returned for organization-owned repositories. */ - "repos/get-community-profile-metrics": { + 'repos/get-community-profile-metrics': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["community-profile"]; - }; - }; - }; - }; + 'application/json': components['schemas']['community-profile'] + } + } + } + } /** * The `basehead` param is comprised of two parts: `base` and `head`. Both must be branch names in `repo`. To compare branches across other repositories in the same network as `repo`, use the format `:branch`. * @@ -30954,32 +30921,32 @@ export interface operations { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - "repos/compare-commits": { + 'repos/compare-commits': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The base branch and head branch to compare. This parameter expects the format `{base}...{head}`. */ - basehead: string; - }; + basehead: string + } query: { /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["commit-comparison"]; - }; - }; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': components['schemas']['commit-comparison'] + } + } + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** * Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit * `:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. @@ -31014,96 +30981,96 @@ export interface operations { * If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the * github.com URLs (`html_url` and `_links["html"]`) will have null values. */ - "repos/get-content": { + 'repos/get-content': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** path parameter */ - path: string; - }; + path: string + } query: { /** The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`) */ - ref?: string; - }; - }; - responses: { - /** Response */ - 200: { - content: { - "application/vnd.github.v3.object": components["schemas"]["content-tree"]; - "application/json": - | components["schemas"]["content-directory"] - | components["schemas"]["content-file"] - | components["schemas"]["content-symlink"] - | components["schemas"]["content-submodule"]; - }; - }; - 302: components["responses"]["found"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + ref?: string + } + } + responses: { + /** Response */ + 200: { + content: { + 'application/vnd.github.v3.object': components['schemas']['content-tree'] + 'application/json': + | components['schemas']['content-directory'] + | components['schemas']['content-file'] + | components['schemas']['content-symlink'] + | components['schemas']['content-submodule'] + } + } + 302: components['responses']['found'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Creates a new file or replaces an existing file in a repository. */ - "repos/create-or-update-file-contents": { + 'repos/create-or-update-file-contents': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** path parameter */ - path: string; - }; - }; + path: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["file-commit"]; - }; - }; + 'application/json': components['schemas']['file-commit'] + } + } /** Response */ 201: { content: { - "application/json": components["schemas"]["file-commit"]; - }; - }; - 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['file-commit'] + } + } + 404: components['responses']['not_found'] + 409: components['responses']['conflict'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The commit message. */ - message: string; + message: string /** @description The new file content, using Base64 encoding. */ - content: string; + content: string /** @description **Required if you are updating a file**. The blob SHA of the file being replaced. */ - sha?: string; + sha?: string /** @description The branch name. Default: the repository’s default branch (usually `master`) */ - branch?: string; + branch?: string /** @description The person that committed the file. Default: the authenticated user. */ committer?: { /** @description The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted. */ - name: string; + name: string /** @description The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted. */ - email: string; + email: string /** @example "2013-01-05T13:13:22+05:00" */ - date?: string; - }; + date?: string + } /** @description The author of the file. Default: The `committer` or the authenticated user if you omit `committer`. */ author?: { /** @description The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted. */ - name: string; + name: string /** @description The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted. */ - email: string; + email: string /** @example "2013-01-15T17:13:22+05:00" */ - date?: string; - }; - }; - }; - }; - }; + date?: string + } + } + } + } + } /** * Deletes a file in a repository. * @@ -31113,151 +31080,151 @@ export interface operations { * * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. */ - "repos/delete-file": { + 'repos/delete-file': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** path parameter */ - path: string; - }; - }; + path: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["file-commit"]; - }; - }; - 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; - 422: components["responses"]["validation_failed"]; - 503: components["responses"]["service_unavailable"]; - }; + 'application/json': components['schemas']['file-commit'] + } + } + 404: components['responses']['not_found'] + 409: components['responses']['conflict'] + 422: components['responses']['validation_failed'] + 503: components['responses']['service_unavailable'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The commit message. */ - message: string; + message: string /** @description The blob SHA of the file being replaced. */ - sha: string; + sha: string /** @description The branch name. Default: the repository’s default branch (usually `master`) */ - branch?: string; + branch?: string /** @description object containing information about the committer. */ committer?: { /** @description The name of the author (or committer) of the commit */ - name?: string; + name?: string /** @description The email of the author (or committer) of the commit */ - email?: string; - }; + email?: string + } /** @description object containing information about the author. */ author?: { /** @description The name of the author (or committer) of the commit */ - name?: string; + name?: string /** @description The email of the author (or committer) of the commit */ - email?: string; - }; - }; - }; - }; - }; + email?: string + } + } + } + } + } /** * Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance. * * GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information. */ - "repos/list-contributors": { + 'repos/list-contributors': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Set to `1` or `true` to include anonymous contributors in results. */ - anon?: string; + anon?: string /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** if repository contains content */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["contributor"][]; - }; - }; + 'application/json': components['schemas']['contributor'][] + } + } /** Response if repository is empty */ - 204: never; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */ - "dependabot/list-repo-secrets": { + 'dependabot/list-repo-secrets': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - secrets: components["schemas"]["dependabot-secret"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + secrets: components['schemas']['dependabot-secret'][] + } + } + } + } + } /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */ - "dependabot/get-repo-public-key": { + 'dependabot/get-repo-public-key': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["dependabot-public-key"]; - }; - }; - }; - }; + 'application/json': components['schemas']['dependabot-public-key'] + } + } + } + } /** Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */ - "dependabot/get-repo-secret": { + 'dependabot/get-repo-secret': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["dependabot-secret"]; - }; - }; - }; - }; + 'application/json': components['schemas']['dependabot-secret'] + } + } + } + } /** * Creates or updates a repository secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -31335,83 +31302,83 @@ export interface operations { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - "dependabot/create-or-update-repo-secret": { + 'dependabot/create-or-update-repo-secret': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response when creating a secret */ 201: { content: { - "application/json": { [key: string]: unknown }; - }; - }; + 'application/json': { [key: string]: unknown } + } + } /** Response when updating a secret */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/reference/dependabot#get-a-repository-public-key) endpoint. */ - encrypted_value?: string; + encrypted_value?: string /** @description ID of the key you used to encrypt the secret. */ - key_id?: string; - }; - }; - }; - }; + key_id?: string + } + } + } + } /** Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */ - "dependabot/delete-repo-secret": { + 'dependabot/delete-repo-secret': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** Simple filtering of deployments is available via query parameters: */ - "repos/list-deployments": { + 'repos/list-deployments': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** The SHA recorded at creation time. */ - sha?: string; + sha?: string /** The name of the ref. This can be a branch, tag, or SHA. */ - ref?: string; + ref?: string /** The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`). */ - task?: string; + task?: string /** The name of the environment that was deployed to (e.g., `staging` or `production`). */ - environment?: string | null; + environment?: string | null /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["deployment"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['deployment'][] + } + } + } + } /** * Deployments offer a few configurable parameters with certain defaults. * @@ -31459,84 +31426,84 @@ export interface operations { * This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` * status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. */ - "repos/create-deployment": { + 'repos/create-deployment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["deployment"]; - }; - }; + 'application/json': components['schemas']['deployment'] + } + } /** Merged branch response */ 202: { content: { - "application/json": { - message?: string; - }; - }; - }; + 'application/json': { + message?: string + } + } + } /** Conflict when there is a merge conflict or the commit's status checks failed */ - 409: unknown; - 422: components["responses"]["validation_failed"]; - }; + 409: unknown + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The ref to deploy. This can be a branch, tag, or SHA. */ - ref: string; + ref: string /** * @description Specifies a task to execute (e.g., `deploy` or `deploy:migrations`). * @default deploy */ - task?: string; + task?: string /** * @description Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch. * @default true */ - auto_merge?: boolean; + auto_merge?: boolean /** @description The [status](https://docs.github.com/rest/reference/commits#commit-statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts. */ - required_contexts?: string[]; - payload?: { [key: string]: unknown } | string; + required_contexts?: string[] + payload?: { [key: string]: unknown } | string /** * @description Name for the target deployment environment (e.g., `production`, `staging`, `qa`). * @default production */ - environment?: string; + environment?: string /** @description Short description of the deployment. */ - description?: string | null; + description?: string | null /** @description Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false` */ - transient_environment?: boolean; + transient_environment?: boolean /** @description Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise. */ - production_environment?: boolean; - }; - }; - }; - }; - "repos/get-deployment": { + production_environment?: boolean + } + } + } + } + 'repos/get-deployment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** deployment_id parameter */ - deployment_id: components["parameters"]["deployment-id"]; - }; - }; + deployment_id: components['parameters']['deployment-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["deployment"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['deployment'] + } + } + 404: components['responses']['not_found'] + } + } /** * If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. Anyone with `repo` or `repo_deployment` scopes can delete a deployment. * @@ -31547,123 +31514,123 @@ export interface operations { * * For more information, see "[Create a deployment](https://docs.github.com/rest/reference/repos/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/reference/repos#create-a-deployment-status)." */ - "repos/delete-deployment": { + 'repos/delete-deployment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** deployment_id parameter */ - deployment_id: components["parameters"]["deployment-id"]; - }; - }; + deployment_id: components['parameters']['deployment-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } + } /** Users with pull access can view deployment statuses for a deployment: */ - "repos/list-deployment-statuses": { + 'repos/list-deployment-statuses': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** deployment_id parameter */ - deployment_id: components["parameters"]["deployment-id"]; - }; + deployment_id: components['parameters']['deployment-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["deployment-status"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['deployment-status'][] + } + } + 404: components['responses']['not_found'] + } + } /** * Users with `push` access can create deployment statuses for a given deployment. * * GitHub Apps require `read & write` access to "Deployments" and `read-only` access to "Repo contents" (for private repos). OAuth Apps require the `repo_deployment` scope. */ - "repos/create-deployment-status": { + 'repos/create-deployment-status': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** deployment_id parameter */ - deployment_id: components["parameters"]["deployment-id"]; - }; - }; + deployment_id: components['parameters']['deployment-id'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["deployment-status"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['deployment-status'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued`, `pending`, or `success`. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub. * @enum {string} */ - state: "error" | "failure" | "inactive" | "in_progress" | "queued" | "pending" | "success"; + state: 'error' | 'failure' | 'inactive' | 'in_progress' | 'queued' | 'pending' | 'success' /** @description The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`. */ - target_url?: string; + target_url?: string /** @description The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `""` */ - log_url?: string; + log_url?: string /** @description A short description of the status. The maximum description length is 140 characters. */ - description?: string; + description?: string /** * @description Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. * @enum {string} */ - environment?: "production" | "staging" | "qa"; + environment?: 'production' | 'staging' | 'qa' /** @description Sets the URL for accessing your environment. Default: `""` */ - environment_url?: string; + environment_url?: string /** @description Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true` */ - auto_inactive?: boolean; - }; - }; - }; - }; + auto_inactive?: boolean + } + } + } + } /** Users with pull access can view a deployment status for a deployment: */ - "repos/get-deployment-status": { + 'repos/get-deployment-status': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** deployment_id parameter */ - deployment_id: components["parameters"]["deployment-id"]; - status_id: number; - }; - }; + deployment_id: components['parameters']['deployment-id'] + status_id: number + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["deployment-status"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['deployment-status'] + } + } + 404: components['responses']['not_found'] + } + } /** * You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/webhooks/event-payloads/#repository_dispatch)." * @@ -31676,76 +31643,76 @@ export interface operations { * * This input example shows how you can use the `client_payload` as a test to debug your workflow. */ - "repos/create-dispatch-event": { + 'repos/create-dispatch-event': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - 422: components["responses"]["validation_failed"]; - }; + 204: never + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description A custom webhook event name. */ - event_type: string; + event_type: string /** @description JSON payload with extra information about the webhook event that your action or worklow may use. */ - client_payload?: { [key: string]: unknown }; - }; - }; - }; - }; + client_payload?: { [key: string]: unknown } + } + } + } + } /** * Get all environments for a repository. * * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "repos/get-all-environments": { + 'repos/get-all-environments': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { + 'application/json': { /** * @description The number of environments in this repository * @example 5 */ - total_count?: number; - environments?: components["schemas"]["environment"][]; - }; - }; - }; - }; - }; + total_count?: number + environments?: components['schemas']['environment'][] + } + } + } + } + } /** Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "repos/get-environment": { + 'repos/get-environment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the environment */ - environment_name: components["parameters"]["environment-name"]; - }; - }; + environment_name: components['parameters']['environment-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["environment"]; - }; - }; - }; - }; + 'application/json': components['schemas']['environment'] + } + } + } + } /** * Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)." * @@ -31755,206 +31722,206 @@ export interface operations { * * You must authenticate using an access token with the repo scope to use this endpoint. */ - "repos/create-or-update-environment": { + 'repos/create-or-update-environment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the environment */ - environment_name: components["parameters"]["environment-name"]; - }; - }; + environment_name: components['parameters']['environment-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["environment"]; - }; - }; + 'application/json': components['schemas']['environment'] + } + } /** Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` are set to the same value */ 422: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } + } requestBody: { content: { - "application/json": { - wait_timer?: components["schemas"]["wait-timer"]; + 'application/json': { + wait_timer?: components['schemas']['wait-timer'] /** @description The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */ reviewers?: | { - type?: components["schemas"]["deployment-reviewer-type"]; + type?: components['schemas']['deployment-reviewer-type'] /** * @description The id of the user or team who can review the deployment * @example 4532992 */ - id?: number; + id?: number }[] - | null; - deployment_branch_policy?: components["schemas"]["deployment_branch_policy"]; - } | null; - }; - }; - }; + | null + deployment_branch_policy?: components['schemas']['deployment_branch_policy'] + } | null + } + } + } /** You must authenticate using an access token with the repo scope to use this endpoint. */ - "repos/delete-an-environment": { + 'repos/delete-an-environment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the environment */ - environment_name: components["parameters"]["environment-name"]; - }; - }; + environment_name: components['parameters']['environment-name'] + } + } responses: { /** Default response */ - 204: never; - }; - }; - "activity/list-repo-events": { + 204: never + } + } + 'activity/list-repo-events': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["event"][]; - }; - }; - }; - }; - "repos/list-forks": { + 'application/json': components['schemas']['event'][] + } + } + } + } + 'repos/list-forks': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** The sort order. Can be either `newest`, `oldest`, or `stargazers`. */ - sort?: "newest" | "oldest" | "stargazers" | "watchers"; + sort?: 'newest' | 'oldest' | 'stargazers' | 'watchers' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["minimal-repository"][]; - }; - }; - 400: components["responses"]["bad_request"]; - }; - }; + 'application/json': components['schemas']['minimal-repository'][] + } + } + 400: components['responses']['bad_request'] + } + } /** * Create a fork for the authenticated user. * * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). */ - "repos/create-fork": { + 'repos/create-fork': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 202: { content: { - "application/json": components["schemas"]["full-repository"]; - }; - }; - 400: components["responses"]["bad_request"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['full-repository'] + } + } + 400: components['responses']['bad_request'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Optional parameter to specify the organization name if forking into an organization. */ - organization?: string; - } | null; - }; - }; - }; - "git/create-blob": { + organization?: string + } | null + } + } + } + 'git/create-blob': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["short-blob"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['short-blob'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 409: components['responses']['conflict'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The new blob's content. */ - content: string; + content: string /** * @description The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. * @default utf-8 */ - encoding?: string; - }; - }; - }; - }; + encoding?: string + } + } + } + } /** * The `content` in the response will always be Base64 encoded. * * _Note_: This API supports blobs up to 100 megabytes in size. */ - "git/get-blob": { + 'git/get-blob': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - file_sha: string; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + file_sha: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["blob"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['blob'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** * Creates a new Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects). * @@ -31987,65 +31954,65 @@ export interface operations { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - "git/create-commit": { + 'git/create-commit': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["git-commit"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['git-commit'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The commit message */ - message: string; + message: string /** @description The SHA of the tree object this commit points to */ - tree: string; + tree: string /** @description The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. */ - parents?: string[]; + parents?: string[] /** @description Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details. */ author?: { /** @description The name of the author (or committer) of the commit */ - name: string; + name: string /** @description The email of the author (or committer) of the commit */ - email: string; + email: string /** * Format: date-time * @description Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - date?: string; - }; + date?: string + } /** @description Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details. */ committer?: { /** @description The name of the author (or committer) of the commit */ - name?: string; + name?: string /** @description The email of the author (or committer) of the commit */ - email?: string; + email?: string /** * Format: date-time * @description Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - date?: string; - }; + date?: string + } /** @description The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits. */ - signature?: string; - }; - }; - }; - }; + signature?: string + } + } + } + } /** * Gets a Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects). * @@ -32078,25 +32045,25 @@ export interface operations { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - "git/get-commit": { + 'git/get-commit': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** commit_sha parameter */ - commit_sha: components["parameters"]["commit-sha"]; - }; - }; + commit_sha: components['parameters']['commit-sha'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["git-commit"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['git-commit'] + } + } + 404: components['responses']['not_found'] + } + } /** * Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array. * @@ -32106,132 +32073,132 @@ export interface operations { * * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. */ - "git/list-matching-refs": { + 'git/list-matching-refs': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** ref parameter */ - ref: string; - }; + ref: string + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["git-ref"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['git-ref'][] + } + } + } + } /** * Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. * * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". */ - "git/get-ref": { + 'git/get-ref': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** ref parameter */ - ref: string; - }; - }; + ref: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["git-ref"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['git-ref'] + } + } + 404: components['responses']['not_found'] + } + } /** Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches. */ - "git/create-ref": { + 'git/create-ref': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["git-ref"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['git-ref'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected. */ - ref: string; + ref: string /** @description The SHA1 value for this reference. */ - sha: string; + sha: string /** @example "refs/heads/newbranch" */ - key?: string; - }; - }; - }; - }; - "git/delete-ref": { + key?: string + } + } + } + } + 'git/delete-ref': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** ref parameter */ - ref: string; - }; - }; + ref: string + } + } responses: { /** Response */ - 204: never; - 422: components["responses"]["validation_failed"]; - }; - }; - "git/update-ref": { + 204: never + 422: components['responses']['validation_failed'] + } + } + 'git/update-ref': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** ref parameter */ - ref: string; - }; - }; + ref: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["git-ref"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['git-ref'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The SHA1 value to set this reference to */ - sha: string; + sha: string /** @description Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work. */ - force?: boolean; - }; - }; - }; - }; + force?: boolean + } + } + } + } /** * Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/rest/reference/git#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/rest/reference/git#create-a-reference) the tag reference - this call would be unnecessary. * @@ -32264,55 +32231,55 @@ export interface operations { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - "git/create-tag": { + 'git/create-tag': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["git-tag"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['git-tag'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The tag's name. This is typically a version (e.g., "v0.0.1"). */ - tag: string; + tag: string /** @description The tag message. */ - message: string; + message: string /** @description The SHA of the git object this is tagging. */ - object: string; + object: string /** * @description The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`. * @enum {string} */ - type: "commit" | "tree" | "blob"; + type: 'commit' | 'tree' | 'blob' /** @description An object with information about the individual creating the tag. */ tagger?: { /** @description The name of the author of the tag */ - name: string; + name: string /** @description The email of the author of the tag */ - email: string; + email: string /** * Format: date-time * @description When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - date?: string; - }; - }; - }; - }; - }; + date?: string + } + } + } + } + } /** * **Signature verification object** * @@ -32343,431 +32310,431 @@ export interface operations { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - "git/get-tag": { + 'git/get-tag': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - tag_sha: string; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + tag_sha: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["git-tag"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['git-tag'] + } + } + 404: components['responses']['not_found'] + } + } /** * The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure. * * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/rest/reference/git#create-a-commit)" and "[Update a reference](https://docs.github.com/rest/reference/git#update-a-reference)." */ - "git/create-tree": { + 'git/create-tree': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["git-tree"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['git-tree'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure. */ tree: { /** @description The file referenced in the tree. */ - path?: string; + path?: string /** * @description The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink. * @enum {string} */ - mode?: "100644" | "100755" | "040000" | "160000" | "120000"; + mode?: '100644' | '100755' | '040000' | '160000' | '120000' /** * @description Either `blob`, `tree`, or `commit`. * @enum {string} */ - type?: "blob" | "tree" | "commit"; + type?: 'blob' | 'tree' | 'commit' /** * @description The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. * * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. */ - sha?: string | null; + sha?: string | null /** * @description The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. * * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. */ - content?: string; - }[]; + content?: string + }[] /** * @description The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on. * If not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit. */ - base_tree?: string; - }; - }; - }; - }; + base_tree?: string + } + } + } + } /** * Returns a single tree using the SHA1 value for that tree. * * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. */ - "git/get-tree": { + 'git/get-tree': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - tree_sha: string; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + tree_sha: string + } query: { /** Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` to any of the following will enable returning objects or subtrees: `0`, `1`, `"true"`, and `"false"`. Omit this parameter to prevent recursively returning objects or subtrees. */ - recursive?: string; - }; - }; + recursive?: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["git-tree"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "repos/list-webhooks": { + 'application/json': components['schemas']['git-tree'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } + 'repos/list-webhooks': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["hook"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['hook'][] + } + } + 404: components['responses']['not_found'] + } + } /** * Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can * share the same `config` as long as those webhooks do not have any `events` that overlap. */ - "repos/create-webhook": { + 'repos/create-webhook': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["hook"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['hook'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`. */ - name?: string; + name?: string /** @description Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/repos#create-hook-config-params). */ config?: { - url?: components["schemas"]["webhook-config-url"]; - content_type?: components["schemas"]["webhook-config-content-type"]; - secret?: components["schemas"]["webhook-config-secret"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + url?: components['schemas']['webhook-config-url'] + content_type?: components['schemas']['webhook-config-content-type'] + secret?: components['schemas']['webhook-config-secret'] + insecure_ssl?: components['schemas']['webhook-config-insecure-ssl'] /** @example "abc" */ - token?: string; + token?: string /** @example "sha256" */ - digest?: string; - }; + digest?: string + } /** * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. * @default push */ - events?: string[]; + events?: string[] /** * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. * @default true */ - active?: boolean; - } | null; - }; - }; - }; + active?: boolean + } | null + } + } + } /** Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/reference/repos#get-a-webhook-configuration-for-a-repository)." */ - "repos/get-webhook": { + 'repos/get-webhook': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["hook"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "repos/delete-webhook": { + 'application/json': components['schemas']['hook'] + } + } + 404: components['responses']['not_found'] + } + } + 'repos/delete-webhook': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/reference/repos#update-a-webhook-configuration-for-a-repository)." */ - "repos/update-webhook": { + 'repos/update-webhook': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["hook"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['hook'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/repos#create-hook-config-params). */ config?: { - url: components["schemas"]["webhook-config-url"]; - content_type?: components["schemas"]["webhook-config-content-type"]; - secret?: components["schemas"]["webhook-config-secret"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + url: components['schemas']['webhook-config-url'] + content_type?: components['schemas']['webhook-config-content-type'] + secret?: components['schemas']['webhook-config-secret'] + insecure_ssl?: components['schemas']['webhook-config-insecure-ssl'] /** @example "bar@example.com" */ - address?: string; + address?: string /** @example "The Serious Room" */ - room?: string; - }; + room?: string + } /** * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events. * @default push */ - events?: string[]; + events?: string[] /** @description Determines a list of events to be added to the list of events that the Hook triggers for. */ - add_events?: string[]; + add_events?: string[] /** @description Determines a list of events to be removed from the list of events that the Hook triggers for. */ - remove_events?: string[]; + remove_events?: string[] /** * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. * @default true */ - active?: boolean; - }; - }; - }; - }; + active?: boolean + } + } + } + } /** * Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/reference/orgs#get-a-repository-webhook)." * * Access tokens must have the `read:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:read` permission. */ - "repos/get-webhook-config-for-repo": { + 'repos/get-webhook-config-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["webhook-config"]; - }; - }; - }; - }; + 'application/json': components['schemas']['webhook-config'] + } + } + } + } /** * Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/reference/orgs#update-a-repository-webhook)." * * Access tokens must have the `write:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:write` permission. */ - "repos/update-webhook-config-for-repo": { + 'repos/update-webhook-config-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["webhook-config"]; - }; - }; - }; + 'application/json': components['schemas']['webhook-config'] + } + } + } requestBody: { content: { - "application/json": { - url?: components["schemas"]["webhook-config-url"]; - content_type?: components["schemas"]["webhook-config-content-type"]; - secret?: components["schemas"]["webhook-config-secret"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - }; - }; - }; - }; + 'application/json': { + url?: components['schemas']['webhook-config-url'] + content_type?: components['schemas']['webhook-config-content-type'] + secret?: components['schemas']['webhook-config-secret'] + insecure_ssl?: components['schemas']['webhook-config-insecure-ssl'] + } + } + } + } /** Returns a list of webhook deliveries for a webhook configured in a repository. */ - "repos/list-webhook-deliveries": { + 'repos/list-webhook-deliveries': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - hook_id: components["parameters"]["hook-id"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + hook_id: components['parameters']['hook-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ - cursor?: components["parameters"]["cursor"]; - }; - }; + cursor?: components['parameters']['cursor'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["hook-delivery-item"][]; - }; - }; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['hook-delivery-item'][] + } + } + 400: components['responses']['bad_request'] + 422: components['responses']['validation_failed'] + } + } /** Returns a delivery for a webhook configured in a repository. */ - "repos/get-webhook-delivery": { + 'repos/get-webhook-delivery': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - hook_id: components["parameters"]["hook-id"]; - delivery_id: components["parameters"]["delivery-id"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + hook_id: components['parameters']['hook-id'] + delivery_id: components['parameters']['delivery-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["hook-delivery"]; - }; - }; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['hook-delivery'] + } + } + 400: components['responses']['bad_request'] + 422: components['responses']['validation_failed'] + } + } /** Redeliver a webhook delivery for a webhook configured in a repository. */ - "repos/redeliver-webhook-delivery": { + 'repos/redeliver-webhook-delivery': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - hook_id: components["parameters"]["hook-id"]; - delivery_id: components["parameters"]["delivery-id"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + hook_id: components['parameters']['hook-id'] + delivery_id: components['parameters']['delivery-id'] + } + } responses: { - 202: components["responses"]["accepted"]; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 202: components['responses']['accepted'] + 400: components['responses']['bad_request'] + 422: components['responses']['validation_failed'] + } + } /** This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. */ - "repos/ping-webhook": { + 'repos/ping-webhook': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** * This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. * * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` */ - "repos/test-push-webhook": { + 'repos/test-push-webhook': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** * View the progress of an import. * @@ -32804,360 +32771,359 @@ export interface operations { * * `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository. * * `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a "Get Large Files" request. */ - "migrations/get-import-status": { + 'migrations/get-import-status': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["import"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['import'] + } + } + 404: components['responses']['not_found'] + } + } /** Start a source import to a GitHub repository using GitHub Importer. */ - "migrations/start-import": { + 'migrations/start-import': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["import"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['import'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The URL of the originating repository. */ - vcs_url: string; + vcs_url: string /** * @description The originating VCS type. Can be one of `subversion`, `git`, `mercurial`, or `tfvc`. Please be aware that without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response. * @enum {string} */ - vcs?: "subversion" | "git" | "mercurial" | "tfvc"; + vcs?: 'subversion' | 'git' | 'mercurial' | 'tfvc' /** @description If authentication is required, the username to provide to `vcs_url`. */ - vcs_username?: string; + vcs_username?: string /** @description If authentication is required, the password to provide to `vcs_url`. */ - vcs_password?: string; + vcs_password?: string /** @description For a tfvc import, the name of the project that is being imported. */ - tfvc_project?: string; - }; - }; - }; - }; + tfvc_project?: string + } + } + } + } /** Stop an import for a repository. */ - "migrations/cancel-import": { + 'migrations/cancel-import': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API * request. If no parameters are provided, the import will be restarted. */ - "migrations/update-import": { + 'migrations/update-import': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["import"]; - }; - }; - }; + 'application/json': components['schemas']['import'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The username to provide to the originating repository. */ - vcs_username?: string; + vcs_username?: string /** @description The password to provide to the originating repository. */ - vcs_password?: string; + vcs_password?: string /** @example "git" */ - vcs?: string; + vcs?: string /** @example "project1" */ - tfvc_project?: string; - } | null; - }; - }; - }; + tfvc_project?: string + } | null + } + } + } /** * Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `. * * This endpoint and the [Map a commit author](https://docs.github.com/rest/reference/migrations#map-a-commit-author) endpoint allow you to provide correct Git author information. */ - "migrations/get-commit-authors": { + 'migrations/get-commit-authors': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** A user ID. Only return users with an ID greater than this ID. */ - since?: components["parameters"]["since-user"]; - }; - }; + since?: components['parameters']['since-user'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["porter-author"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['porter-author'][] + } + } + 404: components['responses']['not_found'] + } + } /** Update an author's identity for the import. Your application can continue updating authors any time before you push new commits to the repository. */ - "migrations/map-commit-author": { + 'migrations/map-commit-author': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - author_id: number; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + author_id: number + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["porter-author"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['porter-author'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The new Git author email. */ - email?: string; + email?: string /** @description The new Git author name. */ - name?: string; - }; - }; - }; - }; + name?: string + } + } + } + } /** List files larger than 100MB found during the import */ - "migrations/get-large-files": { + 'migrations/get-large-files': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["porter-large-file"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['porter-large-file'][] + } + } + } + } /** You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability is powered by [Git LFS](https://git-lfs.github.com). You can learn more about our LFS feature and working with large files [on our help site](https://docs.github.com/articles/versioning-large-files/). */ - "migrations/set-lfs-preference": { + 'migrations/set-lfs-preference': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["import"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['import'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description Can be one of `opt_in` (large files will be stored using Git LFS) or `opt_out` (large files will be removed during the import). * @enum {string} */ - use_lfs: "opt_in" | "opt_out"; - }; - }; - }; - }; + use_lfs: 'opt_in' | 'opt_out' + } + } + } + } /** * Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/get-repo-installation": { + 'apps/get-repo-installation': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["installation"]; - }; - }; - 301: components["responses"]["moved_permanently"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['installation'] + } + } + 301: components['responses']['moved_permanently'] + 404: components['responses']['not_found'] + } + } /** Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response. */ - "interactions/get-restrictions-for-repo": { + 'interactions/get-restrictions-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": Partial & - Partial<{ [key: string]: unknown }>; - }; - }; - }; - }; + 'application/json': Partial & Partial<{ [key: string]: unknown }> + } + } + } + } /** Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. */ - "interactions/set-restrictions-for-repo": { + 'interactions/set-restrictions-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["interaction-limit-response"]; - }; - }; + 'application/json': components['schemas']['interaction-limit-response'] + } + } /** Response */ - 409: unknown; - }; + 409: unknown + } requestBody: { content: { - "application/json": components["schemas"]["interaction-limit"]; - }; - }; - }; + 'application/json': components['schemas']['interaction-limit'] + } + } + } /** Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. */ - "interactions/remove-restrictions-for-repo": { + 'interactions/remove-restrictions-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; + 204: never /** Response */ - 409: unknown; - }; - }; + 409: unknown + } + } /** When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations. */ - "repos/list-invitations": { + 'repos/list-invitations': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["repository-invitation"][]; - }; - }; - }; - }; - "repos/delete-invitation": { + 'application/json': components['schemas']['repository-invitation'][] + } + } + } + } + 'repos/delete-invitation': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** invitation_id parameter */ - invitation_id: components["parameters"]["invitation-id"]; - }; - }; + invitation_id: components['parameters']['invitation-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; - "repos/update-invitation": { + 204: never + } + } + 'repos/update-invitation': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** invitation_id parameter */ - invitation_id: components["parameters"]["invitation-id"]; - }; - }; + invitation_id: components['parameters']['invitation-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["repository-invitation"]; - }; - }; - }; + 'application/json': components['schemas']['repository-invitation'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The permissions that the associated user will have on the repository. Valid values are `read`, `write`, `maintain`, `triage`, and `admin`. * @enum {string} */ - permissions?: "read" | "write" | "maintain" | "triage" | "admin"; - }; - }; - }; - }; + permissions?: 'read' | 'write' | 'maintain' | 'triage' | 'admin' + } + } + } + } /** * List issues in a repository. * @@ -33166,326 +33132,326 @@ export interface operations { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - "issues/list-for-repo": { + 'issues/list-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned. */ - milestone?: string; + milestone?: string /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ - state?: "open" | "closed" | "all"; + state?: 'open' | 'closed' | 'all' /** Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user. */ - assignee?: string; + assignee?: string /** The user that created the issue. */ - creator?: string; + creator?: string /** A user that's mentioned in the issue. */ - mentioned?: string; + mentioned?: string /** A list of comma separated label names. Example: `bug,ui,@high` */ - labels?: components["parameters"]["labels"]; + labels?: components['parameters']['labels'] /** What to sort results by. Can be either `created`, `updated`, `comments`. */ - sort?: "created" | "updated" | "comments"; + sort?: 'created' | 'updated' | 'comments' /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["issue"][]; - }; - }; - 301: components["responses"]["moved_permanently"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['issue'][] + } + } + 301: components['responses']['moved_permanently'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** * Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - "issues/create": { + 'issues/create': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["issue"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed"]; - 503: components["responses"]["service_unavailable"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['issue'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + 422: components['responses']['validation_failed'] + 503: components['responses']['service_unavailable'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The title of the issue. */ - title: string | number; + title: string | number /** @description The contents of the issue. */ - body?: string; + body?: string /** @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_ */ - assignee?: string | null; - milestone?: (string | number) | null; + assignee?: string | null + milestone?: (string | number) | null /** @description Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._ */ labels?: ( | string | { - id?: number; - name?: string; - description?: string | null; - color?: string | null; + id?: number + name?: string + description?: string | null + color?: string | null } - )[]; + )[] /** @description Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ */ - assignees?: string[]; - }; - }; - }; - }; + assignees?: string[] + } + } + } + } /** By default, Issue Comments are ordered by ascending ID. */ - "issues/list-comments-for-repo": { + 'issues/list-comments-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** One of `created` (when the repository was starred) or `updated` (when it was last pushed to). */ - sort?: components["parameters"]["sort"]; + sort?: components['parameters']['sort'] /** Either `asc` or `desc`. Ignored without the `sort` parameter. */ - direction?: "asc" | "desc"; + direction?: 'asc' | 'desc' /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["issue-comment"][]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "issues/get-comment": { + 'application/json': components['schemas']['issue-comment'][] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } + 'issues/get-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["issue-comment"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "issues/delete-comment": { + 'application/json': components['schemas']['issue-comment'] + } + } + 404: components['responses']['not_found'] + } + } + 'issues/delete-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; - "issues/update-comment": { + 204: never + } + } + 'issues/update-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["issue-comment"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['issue-comment'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The contents of the comment. */ - body: string; - }; - }; - }; - }; + body: string + } + } + } + } /** List the reactions to an [issue comment](https://docs.github.com/rest/reference/issues#comments). */ - "reactions/list-for-issue-comment": { + 'reactions/list-for-issue-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; + comment_id: components['parameters']['comment-id'] + } query: { /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue comment. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content?: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["reaction"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['reaction'][] + } + } + 404: components['responses']['not_found'] + } + } /** Create a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. */ - "reactions/create-for-issue-comment": { + 'reactions/create-for-issue-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Reaction exists */ 200: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; + 'application/json': components['schemas']['reaction'] + } + } /** Reaction created */ 201: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['reaction'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the issue comment. * @enum {string} */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - }; + content: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' + } + } + } + } /** * **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. * * Delete a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). */ - "reactions/delete-for-issue-comment": { + 'reactions/delete-for-issue-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - reaction_id: components["parameters"]["reaction-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + reaction_id: components['parameters']['reaction-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; - "issues/list-events-for-repo": { + 204: never + } + } + 'issues/list-events-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["issue-event"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; - }; - "issues/get-event": { + 'application/json': components['schemas']['issue-event'][] + } + } + 422: components['responses']['validation_failed'] + } + } + 'issues/get-event': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - event_id: number; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + event_id: number + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["issue-event"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - }; - }; + 'application/json': components['schemas']['issue-event'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + } + } /** * The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was * [transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If @@ -33499,414 +33465,414 @@ export interface operations { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - "issues/get": { + 'issues/get': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; - }; + issue_number: components['parameters']['issue-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["issue"]; - }; - }; - 301: components["responses"]["moved_permanently"]; - 304: components["responses"]["not_modified"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - }; - }; + 'application/json': components['schemas']['issue'] + } + } + 301: components['responses']['moved_permanently'] + 304: components['responses']['not_modified'] + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + } + } /** Issue owners and users with push access can edit an issue. */ - "issues/update": { + 'issues/update': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; - }; + issue_number: components['parameters']['issue-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["issue"]; - }; - }; - 301: components["responses"]["moved_permanently"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed"]; - 503: components["responses"]["service_unavailable"]; - }; + 'application/json': components['schemas']['issue'] + } + } + 301: components['responses']['moved_permanently'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + 422: components['responses']['validation_failed'] + 503: components['responses']['service_unavailable'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The title of the issue. */ - title?: (string | number) | null; + title?: (string | number) | null /** @description The contents of the issue. */ - body?: string | null; + body?: string | null /** @description Login for the user that this issue should be assigned to. **This field is deprecated.** */ - assignee?: string | null; + assignee?: string | null /** * @description State of the issue. Either `open` or `closed`. * @enum {string} */ - state?: "open" | "closed"; - milestone?: (string | number) | null; + state?: 'open' | 'closed' + milestone?: (string | number) | null /** @description Labels to associate with this issue. Pass one or more Labels to _replace_ the set of Labels on this Issue. Send an empty array (`[]`) to clear all Labels from the Issue. _NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise._ */ labels?: ( | string | { - id?: number; - name?: string; - description?: string | null; - color?: string | null; + id?: number + name?: string + description?: string | null + color?: string | null } - )[]; + )[] /** @description Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ */ - assignees?: string[]; - }; - }; - }; - }; + assignees?: string[] + } + } + } + } /** Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced. */ - "issues/add-assignees": { + 'issues/add-assignees': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; - }; + issue_number: components['parameters']['issue-number'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["issue"]; - }; - }; - }; + 'application/json': components['schemas']['issue'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._ */ - assignees?: string[]; - }; - }; - }; - }; + assignees?: string[] + } + } + } + } /** Removes one or more assignees from an issue. */ - "issues/remove-assignees": { + 'issues/remove-assignees': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; - }; + issue_number: components['parameters']['issue-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["issue"]; - }; - }; - }; + 'application/json': components['schemas']['issue'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._ */ - assignees?: string[]; - }; - }; - }; - }; + assignees?: string[] + } + } + } + } /** Issue Comments are ordered by ascending ID. */ - "issues/list-comments": { + 'issues/list-comments': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; + issue_number: components['parameters']['issue-number'] + } query: { /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["issue-comment"][]; - }; - }; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - }; - }; + 'application/json': components['schemas']['issue-comment'][] + } + } + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + } + } /** This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - "issues/create-comment": { + 'issues/create-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; - }; + issue_number: components['parameters']['issue-number'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["issue-comment"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['issue-comment'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The contents of the comment. */ - body: string; - }; - }; - }; - }; - "issues/list-events": { + body: string + } + } + } + } + 'issues/list-events': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; + issue_number: components['parameters']['issue-number'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["issue-event-for-issue"][]; - }; - }; - 410: components["responses"]["gone"]; - }; - }; - "issues/list-labels-on-issue": { + 'application/json': components['schemas']['issue-event-for-issue'][] + } + } + 410: components['responses']['gone'] + } + } + 'issues/list-labels-on-issue': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; + issue_number: components['parameters']['issue-number'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["label"][]; - }; - }; - 410: components["responses"]["gone"]; - }; - }; + 'application/json': components['schemas']['label'][] + } + } + 410: components['responses']['gone'] + } + } /** Removes any previous labels and sets the new labels for an issue. */ - "issues/set-labels": { + 'issues/set-labels': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; - }; + issue_number: components['parameters']['issue-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["label"][]; - }; - }; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['label'][] + } + } + 410: components['responses']['gone'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see "[Add labels to an issue](https://docs.github.com/rest/reference/issues#add-labels-to-an-issue)." */ - labels?: [string, ...string[]]; + labels?: [string, ...string[]] } | [string, ...string[]] | { labels?: [ { - name: string; + name: string }, ...{ - name: string; - }[] - ]; + name: string + }[], + ] } | [ { - name: string; + name: string }, ...{ - name: string; - }[] + name: string + }[], ] - | string; - }; - }; - }; - "issues/add-labels": { + | string + } + } + } + 'issues/add-labels': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; - }; + issue_number: components['parameters']['issue-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["label"][]; - }; - }; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['label'][] + } + } + 410: components['responses']['gone'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also replace all of the labels for an issue. For more information, see "[Set labels for an issue](https://docs.github.com/rest/reference/issues#set-labels-for-an-issue)." */ - labels?: [string, ...string[]]; + labels?: [string, ...string[]] } | [string, ...string[]] | { labels?: [ { - name: string; + name: string }, ...{ - name: string; - }[] - ]; + name: string + }[], + ] } | [ { - name: string; + name: string }, ...{ - name: string; - }[] + name: string + }[], ] - | string; - }; - }; - }; - "issues/remove-all-labels": { + | string + } + } + } + 'issues/remove-all-labels': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; - }; + issue_number: components['parameters']['issue-number'] + } + } responses: { /** Response */ - 204: never; - 410: components["responses"]["gone"]; - }; - }; + 204: never + 410: components['responses']['gone'] + } + } /** Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist. */ - "issues/remove-label": { + 'issues/remove-label': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - name: string; - }; - }; + issue_number: components['parameters']['issue-number'] + name: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["label"][]; - }; - }; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - }; - }; + 'application/json': components['schemas']['label'][] + } + } + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + } + } /** * Users with push access can lock an issue or pull request's conversation. * * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - "issues/lock": { + 'issues/lock': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; - }; + issue_number: components['parameters']['issue-number'] + } + } responses: { /** Response */ - 204: never; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed"]; - }; + 204: never + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: * \* `off-topic` @@ -33915,379 +33881,379 @@ export interface operations { * \* `spam` * @enum {string} */ - lock_reason?: "off-topic" | "too heated" | "resolved" | "spam"; - } | null; - }; - }; - }; + lock_reason?: 'off-topic' | 'too heated' | 'resolved' | 'spam' + } | null + } + } + } /** Users with push access can unlock an issue's conversation. */ - "issues/unlock": { + 'issues/unlock': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; - }; + issue_number: components['parameters']['issue-number'] + } + } responses: { /** Response */ - 204: never; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** List the reactions to an [issue](https://docs.github.com/rest/reference/issues). */ - "reactions/list-for-issue": { + 'reactions/list-for-issue': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; + issue_number: components['parameters']['issue-number'] + } query: { /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content?: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["reaction"][]; - }; - }; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - }; - }; + 'application/json': components['schemas']['reaction'][] + } + } + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + } + } /** Create a reaction to an [issue](https://docs.github.com/rest/reference/issues/). A response with an HTTP `200` status means that you already added the reaction type to this issue. */ - "reactions/create-for-issue": { + 'reactions/create-for-issue': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; - }; + issue_number: components['parameters']['issue-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; + 'application/json': components['schemas']['reaction'] + } + } /** Response */ 201: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['reaction'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the issue. * @enum {string} */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - }; + content: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' + } + } + } + } /** * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. * * Delete a reaction to an [issue](https://docs.github.com/rest/reference/issues/). */ - "reactions/delete-for-issue": { + 'reactions/delete-for-issue': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - reaction_id: components["parameters"]["reaction-id"]; - }; - }; + issue_number: components['parameters']['issue-number'] + reaction_id: components['parameters']['reaction-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; - "issues/list-events-for-timeline": { + 204: never + } + } + 'issues/list-events-for-timeline': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; + issue_number: components['parameters']['issue-number'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["timeline-issue-events"][]; - }; - }; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - }; - }; - "repos/list-deploy-keys": { + 'application/json': components['schemas']['timeline-issue-events'][] + } + } + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + } + } + 'repos/list-deploy-keys': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["deploy-key"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['deploy-key'][] + } + } + } + } /** You can create a read-only deploy key. */ - "repos/create-deploy-key": { + 'repos/create-deploy-key': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["deploy-key"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['deploy-key'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description A name for the key. */ - title?: string; + title?: string /** @description The contents of the key. */ - key: string; + key: string /** * @description If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. * * Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)" and "[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/)." */ - read_only?: boolean; - }; - }; - }; - }; - "repos/get-deploy-key": { + read_only?: boolean + } + } + } + } + 'repos/get-deploy-key': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** key_id parameter */ - key_id: components["parameters"]["key-id"]; - }; - }; + key_id: components['parameters']['key-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["deploy-key"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['deploy-key'] + } + } + 404: components['responses']['not_found'] + } + } /** Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead. */ - "repos/delete-deploy-key": { + 'repos/delete-deploy-key': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** key_id parameter */ - key_id: components["parameters"]["key-id"]; - }; - }; + key_id: components['parameters']['key-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; - "issues/list-labels-for-repo": { + 204: never + } + } + 'issues/list-labels-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["label"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "issues/create-label": { + 'application/json': components['schemas']['label'][] + } + } + 404: components['responses']['not_found'] + } + } + 'issues/create-label': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["label"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['label'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see "[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet)." */ - name: string; + name: string /** @description The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. */ - color?: string; + color?: string /** @description A short description of the label. Must be 100 characters or fewer. */ - description?: string; - }; - }; - }; - }; - "issues/get-label": { + description?: string + } + } + } + } + 'issues/get-label': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - name: string; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + name: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["label"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "issues/delete-label": { + 'application/json': components['schemas']['label'] + } + } + 404: components['responses']['not_found'] + } + } + 'issues/delete-label': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - name: string; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + name: string + } + } responses: { /** Response */ - 204: never; - }; - }; - "issues/update-label": { + 204: never + } + } + 'issues/update-label': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - name: string; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + name: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["label"]; - }; - }; - }; + 'application/json': components['schemas']['label'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see "[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet)." */ - new_name?: string; + new_name?: string /** @description The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. */ - color?: string; + color?: string /** @description A short description of the label. Must be 100 characters or fewer. */ - description?: string; - }; - }; - }; - }; + description?: string + } + } + } + } /** Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language. */ - "repos/list-languages": { + 'repos/list-languages': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["language"]; - }; - }; - }; - }; - "repos/enable-lfs-for-repo": { + 'application/json': components['schemas']['language'] + } + } + } + } + 'repos/enable-lfs-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { - 202: components["responses"]["accepted"]; + 202: components['responses']['accepted'] /** * We will return a 403 with one of the following messages: * @@ -34295,523 +34261,523 @@ export interface operations { * - Git LFS support not enabled because Git LFS is disabled for the root repository in the network. * - Git LFS support not enabled because Git LFS is disabled for . */ - 403: unknown; - }; - }; - "repos/disable-lfs-for-repo": { + 403: unknown + } + } + 'repos/disable-lfs-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * This method returns the contents of the repository's license file, if one is detected. * * Similar to [Get repository content](https://docs.github.com/rest/reference/repos#get-repository-content), this method also supports [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw license content or rendered license HTML. */ - "licenses/get-for-repo": { + 'licenses/get-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["license-content"]; - }; - }; - }; - }; + 'application/json': components['schemas']['license-content'] + } + } + } + } /** Sync a branch of a forked repository to keep it up-to-date with the upstream repository. */ - "repos/merge-upstream": { + 'repos/merge-upstream': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** The branch has been successfully synced with the upstream repository */ 200: { content: { - "application/json": components["schemas"]["merged-upstream"]; - }; - }; + 'application/json': components['schemas']['merged-upstream'] + } + } /** The branch could not be synced because of a merge conflict */ - 409: unknown; + 409: unknown /** The branch could not be synced for some other reason */ - 422: unknown; - }; + 422: unknown + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the branch which should be updated to match upstream. */ - branch: string; - }; - }; - }; - }; - "repos/merge": { + branch: string + } + } + } + } + 'repos/merge': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Successful Response (The resulting merge commit) */ 201: { content: { - "application/json": components["schemas"]["commit"]; - }; - }; + 'application/json': components['schemas']['commit'] + } + } /** Response when already merged */ - 204: never; - 403: components["responses"]["forbidden"]; + 204: never + 403: components['responses']['forbidden'] /** Not Found when the base or head does not exist */ - 404: unknown; + 404: unknown /** Conflict when there is a merge conflict */ - 409: unknown; - 422: components["responses"]["validation_failed"]; - }; + 409: unknown + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the base branch that the head will be merged into. */ - base: string; + base: string /** @description The head to merge. This can be a branch name or a commit SHA1. */ - head: string; + head: string /** @description Commit message to use for the merge commit. If omitted, a default message will be used. */ - commit_message?: string; - }; - }; - }; - }; - "issues/list-milestones": { + commit_message?: string + } + } + } + } + 'issues/list-milestones': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** The state of the milestone. Either `open`, `closed`, or `all`. */ - state?: "open" | "closed" | "all"; + state?: 'open' | 'closed' | 'all' /** What to sort results by. Either `due_on` or `completeness`. */ - sort?: "due_on" | "completeness"; + sort?: 'due_on' | 'completeness' /** The direction of the sort. Either `asc` or `desc`. */ - direction?: "asc" | "desc"; + direction?: 'asc' | 'desc' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["milestone"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "issues/create-milestone": { + 'application/json': components['schemas']['milestone'][] + } + } + 404: components['responses']['not_found'] + } + } + 'issues/create-milestone': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["milestone"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['milestone'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The title of the milestone. */ - title: string; + title: string /** * @description The state of the milestone. Either `open` or `closed`. * @default open * @enum {string} */ - state?: "open" | "closed"; + state?: 'open' | 'closed' /** @description A description of the milestone. */ - description?: string; + description?: string /** * Format: date-time * @description The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - due_on?: string; - }; - }; - }; - }; - "issues/get-milestone": { + due_on?: string + } + } + } + } + 'issues/get-milestone': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** milestone_number parameter */ - milestone_number: components["parameters"]["milestone-number"]; - }; - }; + milestone_number: components['parameters']['milestone-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["milestone"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "issues/delete-milestone": { + 'application/json': components['schemas']['milestone'] + } + } + 404: components['responses']['not_found'] + } + } + 'issues/delete-milestone': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** milestone_number parameter */ - milestone_number: components["parameters"]["milestone-number"]; - }; - }; + milestone_number: components['parameters']['milestone-number'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; - "issues/update-milestone": { + 204: never + 404: components['responses']['not_found'] + } + } + 'issues/update-milestone': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** milestone_number parameter */ - milestone_number: components["parameters"]["milestone-number"]; - }; - }; + milestone_number: components['parameters']['milestone-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["milestone"]; - }; - }; - }; + 'application/json': components['schemas']['milestone'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The title of the milestone. */ - title?: string; + title?: string /** * @description The state of the milestone. Either `open` or `closed`. * @default open * @enum {string} */ - state?: "open" | "closed"; + state?: 'open' | 'closed' /** @description A description of the milestone. */ - description?: string; + description?: string /** * Format: date-time * @description The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - due_on?: string; - }; - }; - }; - }; - "issues/list-labels-for-milestone": { + due_on?: string + } + } + } + } + 'issues/list-labels-for-milestone': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** milestone_number parameter */ - milestone_number: components["parameters"]["milestone-number"]; - }; + milestone_number: components['parameters']['milestone-number'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["label"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['label'][] + } + } + } + } /** List all notifications for the current user. */ - "activity/list-repo-notifications-for-authenticated-user": { + 'activity/list-repo-notifications-for-authenticated-user': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** If `true`, show notifications marked as read. */ - all?: components["parameters"]["all"]; + all?: components['parameters']['all'] /** If `true`, only shows notifications in which the user is directly participating or mentioned. */ - participating?: components["parameters"]["participating"]; + participating?: components['parameters']['participating'] /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - before?: components["parameters"]["before"]; + before?: components['parameters']['before'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["thread"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['thread'][] + } + } + } + } /** Marks all notifications in a repository as "read" removes them from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ - "activity/mark-repo-notifications-as-read": { + 'activity/mark-repo-notifications-as-read': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 202: { content: { - "application/json": { - message?: string; - url?: string; - }; - }; - }; + 'application/json': { + message?: string + url?: string + } + } + } /** Reset Content */ - 205: unknown; - }; + 205: unknown + } requestBody: { content: { - "application/json": { + 'application/json': { /** * Format: date-time * @description Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. */ - last_read_at?: string; - }; - }; - }; - }; - "repos/get-pages": { + last_read_at?: string + } + } + } + } + 'repos/get-pages': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["page"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['page'] + } + } + 404: components['responses']['not_found'] + } + } /** Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). */ - "repos/update-information-about-pages-site": { + 'repos/update-information-about-pages-site': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; - }; + 204: never + 400: components['responses']['bad_request'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/articles/using-a-custom-domain-with-github-pages/)." */ - cname?: string | null; + cname?: string | null /** @description Specify whether HTTPS should be enforced for the repository. */ - https_enforced?: boolean; + https_enforced?: boolean /** @description Configures access controls for the GitHub Pages site. If public is set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to `internal` visibility. This feature is only available to repositories in an organization on an Enterprise plan. */ - public?: boolean; - source?: Partial<"gh-pages" | "master" | "master /docs"> & + public?: boolean + source?: Partial<'gh-pages' | 'master' | 'master /docs'> & Partial<{ /** @description The repository branch used to publish your site's source files. */ - branch: string; + branch: string /** * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. * @enum {string} */ - path: "/" | "/docs"; - }>; - }; - }; - }; - }; + path: '/' | '/docs' + }> + } + } + } + } /** Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)." */ - "repos/create-pages-site": { + 'repos/create-pages-site': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["page"]; - }; - }; - 409: components["responses"]["conflict"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['page'] + } + } + 409: components['responses']['conflict'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The source branch and directory used to publish your Pages site. */ source: { /** @description The repository branch used to publish your site's source files. */ - branch: string; + branch: string /** * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/` * @default / * @enum {string} */ - path?: "/" | "/docs"; - }; - } | null; - }; - }; - }; - "repos/delete-pages-site": { + path?: '/' | '/docs' + } + } | null + } + } + } + 'repos/delete-pages-site': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "repos/list-pages-builds": { + 204: never + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } + 'repos/list-pages-builds': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["page-build"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['page-build'][] + } + } + } + } /** * You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures. * * Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes. */ - "repos/request-pages-build": { + 'repos/request-pages-build': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["page-build-status"]; - }; - }; - }; - }; - "repos/get-latest-pages-build": { + 'application/json': components['schemas']['page-build-status'] + } + } + } + } + 'repos/get-latest-pages-build': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["page-build"]; - }; - }; - }; - }; - "repos/get-pages-build": { + 'application/json': components['schemas']['page-build'] + } + } + } + } + 'repos/get-pages-build': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - build_id: number; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + build_id: number + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["page-build"]; - }; - }; - }; - }; + 'application/json': components['schemas']['page-build'] + } + } + } + } /** * Gets a health check of the DNS settings for the `CNAME` record configured for a repository's GitHub Pages. * @@ -34819,132 +34785,132 @@ export interface operations { * * Users must have admin or owner permissions. GitHub Apps must have the `pages:write` and `administration:write` permission to use this endpoint. */ - "repos/get-pages-health-check": { + 'repos/get-pages-health-check': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pages-health-check"]; - }; - }; + 'application/json': components['schemas']['pages-health-check'] + } + } /** Empty response */ 202: { content: { - "application/json": components["schemas"]["empty-object"]; - }; - }; + 'application/json': components['schemas']['empty-object'] + } + } /** Custom domains are not available for GitHub Pages */ - 400: unknown; - 404: components["responses"]["not_found"]; + 400: unknown + 404: components['responses']['not_found'] /** There isn't a CNAME for this page */ - 422: unknown; - }; - }; + 422: unknown + } + } /** Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - "projects/list-for-repo": { + 'projects/list-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. */ - state?: "open" | "closed" | "all"; + state?: 'open' | 'closed' | 'all' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["project"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed_simple"]; - }; - }; + 'application/json': components['schemas']['project'][] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + 422: components['responses']['validation_failed_simple'] + } + } /** Creates a repository project board. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - "projects/create-for-repo": { + 'projects/create-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["project"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': components['schemas']['project'] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the project. */ - name: string; + name: string /** @description The description of the project. */ - body?: string; - }; - }; - }; - }; + body?: string + } + } + } + } /** Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "pulls/list": { + 'pulls/list': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Either `open`, `closed`, or `all` to filter by state. */ - state?: "open" | "closed" | "all"; + state?: 'open' | 'closed' | 'all' /** Filter pulls by head user or head organization and branch name in the format of `user:ref-name` or `organization:ref-name`. For example: `github:new-script-format` or `octocat:test-branch`. */ - head?: string; + head?: string /** Filter pulls by base branch name. Example: `gh-pages`. */ - base?: string; + base?: string /** What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month). */ - sort?: "created" | "updated" | "popularity" | "long-running"; + sort?: 'created' | 'updated' | 'popularity' | 'long-running' /** The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`. */ - direction?: "asc" | "desc"; + direction?: 'asc' | 'desc' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["pull-request-simple"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['pull-request-simple'][] + } + } + 304: components['responses']['not_modified'] + 422: components['responses']['validation_failed'] + } + } /** * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -34954,225 +34920,225 @@ export interface operations { * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. */ - "pulls/create": { + 'pulls/create': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["pull-request"]; - }; - }; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['pull-request'] + } + } + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The title of the new pull request. */ - title?: string; + title?: string /** @description The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`. */ - head: string; + head: string /** @description The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository. */ - base: string; + base: string /** @description The contents of the pull request. */ - body?: string; + body?: string /** @description Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. */ - maintainer_can_modify?: boolean; + maintainer_can_modify?: boolean /** @description Indicates whether the pull request is a draft. See "[Draft Pull Requests](https://docs.github.com/en/articles/about-pull-requests#draft-pull-requests)" in the GitHub Help documentation to learn more. */ - draft?: boolean; + draft?: boolean /** @example 1 */ - issue?: number; - }; - }; - }; - }; + issue?: number + } + } + } + } /** Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID. */ - "pulls/list-review-comments-for-repo": { + 'pulls/list-review-comments-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { - sort?: "created" | "updated" | "created_at"; + sort?: 'created' | 'updated' | 'created_at' /** Can be either `asc` or `desc`. Ignored without `sort` parameter. */ - direction?: "asc" | "desc"; + direction?: 'asc' | 'desc' /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["pull-request-review-comment"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['pull-request-review-comment'][] + } + } + } + } /** Provides details for a review comment. */ - "pulls/get-review-comment": { + 'pulls/get-review-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pull-request-review-comment"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['pull-request-review-comment'] + } + } + 404: components['responses']['not_found'] + } + } /** Deletes a review comment. */ - "pulls/delete-review-comment": { + 'pulls/delete-review-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** Enables you to edit a review comment. */ - "pulls/update-review-comment": { + 'pulls/update-review-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pull-request-review-comment"]; - }; - }; - }; + 'application/json': components['schemas']['pull-request-review-comment'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The text of the reply to the review comment. */ - body: string; - }; - }; - }; - }; + body: string + } + } + } + } /** List the reactions to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). */ - "reactions/list-for-pull-request-review-comment": { + 'reactions/list-for-pull-request-review-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; + comment_id: components['parameters']['comment-id'] + } query: { /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a pull request review comment. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content?: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["reaction"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['reaction'][] + } + } + 404: components['responses']['not_found'] + } + } /** Create a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#comments). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. */ - "reactions/create-for-pull-request-review-comment": { + 'reactions/create-for-pull-request-review-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Reaction exists */ 200: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; + 'application/json': components['schemas']['reaction'] + } + } /** Reaction created */ 201: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['reaction'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the pull request review comment. * @enum {string} */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - }; + content: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' + } + } + } + } /** * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` * * Delete a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). */ - "reactions/delete-for-pull-request-comment": { + 'reactions/delete-for-pull-request-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - reaction_id: components["parameters"]["reaction-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + reaction_id: components['parameters']['reaction-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -35190,145 +35156,145 @@ export interface operations { * * Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. */ - "pulls/get": { + 'pulls/get': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } + } responses: { /** Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. */ 200: { content: { - "application/json": components["schemas"]["pull-request"]; - }; - }; - 304: components["responses"]["not_modified"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': components['schemas']['pull-request'] + } + } + 304: components['responses']['not_modified'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. */ - "pulls/update": { + 'pulls/update': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pull-request"]; - }; - }; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['pull-request'] + } + } + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The title of the pull request. */ - title?: string; + title?: string /** @description The contents of the pull request. */ - body?: string; + body?: string /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ - state?: "open" | "closed"; + state?: 'open' | 'closed' /** @description The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository. */ - base?: string; + base?: string /** @description Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. */ - maintainer_can_modify?: boolean; - }; - }; - }; - }; + maintainer_can_modify?: boolean + } + } + } + } /** * Creates a codespace owned by the authenticated user for the specified pull request. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/create-with-pr-for-authenticated-user": { + 'codespaces/create-with-pr-for-authenticated-user': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } + } responses: { /** Response when the codespace was successfully created */ 201: { content: { - "application/json": components["schemas"]["codespace"]; - }; - }; + 'application/json': components['schemas']['codespace'] + } + } /** Response when the codespace creation partially failed but is being retried in the background */ 202: { content: { - "application/json": components["schemas"]["codespace"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; + 'application/json': components['schemas']['codespace'] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Location for this codespace */ - location: string; + location: string /** @description Machine type to use for this codespace */ - machine?: string; + machine?: string /** @description Working directory for this codespace */ - working_directory?: string; + working_directory?: string /** @description Time in minutes before codespace stops from inactivity */ - idle_timeout_minutes?: number; - }; - }; - }; - }; + idle_timeout_minutes?: number + } + } + } + } /** Lists all review comments for a pull request. By default, review comments are in ascending order by ID. */ - "pulls/list-review-comments": { + 'pulls/list-review-comments': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } query: { /** One of `created` (when the repository was starred) or `updated` (when it was last pushed to). */ - sort?: components["parameters"]["sort"]; + sort?: components['parameters']['sort'] /** Can be either `asc` or `desc`. Ignored without `sort` parameter. */ - direction?: "asc" | "desc"; + direction?: 'asc' | 'desc' /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["pull-request-review-comment"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['pull-request-review-comment'][] + } + } + } + } /** * Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/reference/issues#create-an-issue-comment)." We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff. * @@ -35338,328 +35304,328 @@ export interface operations { * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - "pulls/create-review-comment": { + 'pulls/create-review-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["pull-request-review-comment"]; - }; - }; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['pull-request-review-comment'] + } + } + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The text of the review comment. */ - body: string; + body: string /** @description The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`. */ - commit_id?: string; + commit_id?: string /** @description The relative path to the file that necessitates a comment. */ - path?: string; + path?: string /** @description **Required without `comfort-fade` preview unless using `in_reply_to`**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above. */ - position?: number; + position?: number /** * @description **Required with `comfort-fade` preview unless using `in_reply_to`**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "[Diff view options](https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation. * @enum {string} */ - side?: "LEFT" | "RIGHT"; + side?: 'LEFT' | 'RIGHT' /** @description **Required with `comfort-fade` preview unless using `in_reply_to`**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to. */ - line?: number; + line?: number /** @description **Required when using multi-line comments unless using `in_reply_to`**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. */ - start_line?: number; + start_line?: number /** * @description **Required when using multi-line comments unless using `in_reply_to`**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context. * @enum {string} */ - start_side?: "LEFT" | "RIGHT" | "side"; + start_side?: 'LEFT' | 'RIGHT' | 'side' /** * @description The ID of the review comment to reply to. To find the ID of a review comment with ["List review comments on a pull request"](#list-review-comments-on-a-pull-request). When specified, all parameters other than `body` in the request body are ignored. * @example 2 */ - in_reply_to?: number; - }; - }; - }; - }; + in_reply_to?: number + } + } + } + } /** * Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - "pulls/create-reply-for-review-comment": { + 'pulls/create-reply-for-review-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["pull-request-review-comment"]; - }; - }; - 404: components["responses"]["not_found"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['pull-request-review-comment'] + } + } + 404: components['responses']['not_found'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The text of the review comment. */ - body: string; - }; - }; - }; - }; + body: string + } + } + } + } /** Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/reference/repos#list-commits) endpoint. */ - "pulls/list-commits": { + 'pulls/list-commits': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["commit"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['commit'][] + } + } + } + } /** **Note:** Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. */ - "pulls/list-files": { + 'pulls/list-files': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["diff-entry"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - 500: components["responses"]["internal_error"]; - }; - }; - "pulls/check-if-merged": { + 'application/json': components['schemas']['diff-entry'][] + } + } + 422: components['responses']['validation_failed'] + 500: components['responses']['internal_error'] + } + } + 'pulls/check-if-merged': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } + } responses: { /** Response if pull request has been merged */ - 204: never; + 204: never /** Not Found if pull request has not been merged */ - 404: unknown; - }; - }; + 404: unknown + } + } /** This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - "pulls/merge": { + 'pulls/merge': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } + } responses: { /** if merge was successful */ 200: { content: { - "application/json": components["schemas"]["pull-request-merge-result"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; + 'application/json': components['schemas']['pull-request-merge-result'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] /** Method Not Allowed if merge cannot be performed */ 405: { content: { - "application/json": { - message?: string; - documentation_url?: string; - }; - }; - }; + 'application/json': { + message?: string + documentation_url?: string + } + } + } /** Conflict if sha was provided and pull request head did not match */ 409: { content: { - "application/json": { - message?: string; - documentation_url?: string; - }; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': { + message?: string + documentation_url?: string + } + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Title for the automatic commit message. */ - commit_title?: string; + commit_title?: string /** @description Extra detail to append to automatic commit message. */ - commit_message?: string; + commit_message?: string /** @description SHA that pull request head must match to allow merge. */ - sha?: string; + sha?: string /** * @description Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`. * @enum {string} */ - merge_method?: "merge" | "squash" | "rebase"; - } | null; - }; - }; - }; - "pulls/list-requested-reviewers": { - parameters: { - path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; + merge_method?: 'merge' | 'squash' | 'rebase' + } | null + } + } + } + 'pulls/list-requested-reviewers': { + parameters: { + path: { + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["pull-request-review-request"]; - }; - }; - }; - }; + 'application/json': components['schemas']['pull-request-review-request'] + } + } + } + } /** This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - "pulls/request-reviewers": { + 'pulls/request-reviewers': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["pull-request-simple"]; - }; - }; - 403: components["responses"]["forbidden"]; + 'application/json': components['schemas']['pull-request-simple'] + } + } + 403: components['responses']['forbidden'] /** Unprocessable Entity if user is not a collaborator */ - 422: unknown; - }; + 422: unknown + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description An array of user `login`s that will be requested. */ - reviewers?: string[]; + reviewers?: string[] /** @description An array of team `slug`s that will be requested. */ - team_reviewers?: string[]; - }; - }; - }; - }; - "pulls/remove-requested-reviewers": { + team_reviewers?: string[] + } + } + } + } + 'pulls/remove-requested-reviewers': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pull-request-simple"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['pull-request-simple'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description An array of user `login`s that will be removed. */ - reviewers: string[]; + reviewers: string[] /** @description An array of team `slug`s that will be removed. */ - team_reviewers?: string[]; - }; - }; - }; - }; + team_reviewers?: string[] + } + } + } + } /** The list of reviews returns in chronological order. */ - "pulls/list-reviews": { + 'pulls/list-reviews': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** The list of reviews returns in chronological order. */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["pull-request-review"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['pull-request-review'][] + } + } + } + } /** * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. * @@ -35669,636 +35635,636 @@ export interface operations { * * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. */ - "pulls/create-review": { + 'pulls/create-review': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pull-request-review"]; - }; - }; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': components['schemas']['pull-request-review'] + } + } + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value. */ - commit_id?: string; + commit_id?: string /** @description **Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review. */ - body?: string; + body?: string /** * @description The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/rest/reference/pulls#submit-a-review-for-a-pull-request) when you are ready. * @enum {string} */ - event?: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; + event?: 'APPROVE' | 'REQUEST_CHANGES' | 'COMMENT' /** @description Use the following table to specify the location, destination, and contents of the draft review comment. */ comments?: { /** @description The relative path to the file that necessitates a review comment. */ - path: string; + path: string /** @description The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below. */ - position?: number; + position?: number /** @description Text of the review comment. */ - body: string; + body: string /** @example 28 */ - line?: number; + line?: number /** @example RIGHT */ - side?: string; + side?: string /** @example 26 */ - start_line?: number; + start_line?: number /** @example LEFT */ - start_side?: string; - }[]; - }; - }; - }; - }; - "pulls/get-review": { - parameters: { - path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; + start_side?: string + }[] + } + } + } + } + 'pulls/get-review': { + parameters: { + path: { + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] /** review_id parameter */ - review_id: components["parameters"]["review-id"]; - }; - }; + review_id: components['parameters']['review-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pull-request-review"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['pull-request-review'] + } + } + 404: components['responses']['not_found'] + } + } /** Update the review summary comment with new text. */ - "pulls/update-review": { + 'pulls/update-review': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] /** review_id parameter */ - review_id: components["parameters"]["review-id"]; - }; - }; + review_id: components['parameters']['review-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pull-request-review"]; - }; - }; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': components['schemas']['pull-request-review'] + } + } + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The body text of the pull request review. */ - body: string; - }; - }; - }; - }; - "pulls/delete-pending-review": { + body: string + } + } + } + } + 'pulls/delete-pending-review': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] /** review_id parameter */ - review_id: components["parameters"]["review-id"]; - }; - }; + review_id: components['parameters']['review-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pull-request-review"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; - }; + 'application/json': components['schemas']['pull-request-review'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } + } /** List comments for a specific pull request review. */ - "pulls/list-comments-for-review": { + 'pulls/list-comments-for-review': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] /** review_id parameter */ - review_id: components["parameters"]["review-id"]; - }; + review_id: components['parameters']['review-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["review-comment"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['review-comment'][] + } + } + 404: components['responses']['not_found'] + } + } /** **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/reference/repos#branches), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. */ - "pulls/dismiss-review": { + 'pulls/dismiss-review': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] /** review_id parameter */ - review_id: components["parameters"]["review-id"]; - }; - }; + review_id: components['parameters']['review-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pull-request-review"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': components['schemas']['pull-request-review'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The message for the pull request review dismissal */ - message: string; + message: string /** @example "APPROVE" */ - event?: string; - }; - }; - }; - }; - "pulls/submit-review": { + event?: string + } + } + } + } + 'pulls/submit-review': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] /** review_id parameter */ - review_id: components["parameters"]["review-id"]; - }; - }; + review_id: components['parameters']['review-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pull-request-review"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': components['schemas']['pull-request-review'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The body text of the pull request review */ - body?: string; + body?: string /** * @description The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When you leave this blank, the API returns _HTTP 422 (Unrecognizable entity)_ and sets the review action state to `PENDING`, which means you will need to re-submit the pull request review using a review action. * @enum {string} */ - event: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; - }; - }; - }; - }; + event: 'APPROVE' | 'REQUEST_CHANGES' | 'COMMENT' + } + } + } + } /** Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. */ - "pulls/update-branch": { + 'pulls/update-branch': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } + } responses: { /** Response */ 202: { content: { - "application/json": { - message?: string; - url?: string; - }; - }; - }; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': { + message?: string + url?: string + } + } + } + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the "[List commits](https://docs.github.com/rest/reference/repos#list-commits)" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref. */ - expected_head_sha?: string; - } | null; - }; - }; - }; + expected_head_sha?: string + } | null + } + } + } /** * Gets the preferred README for a repository. * * READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. */ - "repos/get-readme": { + 'repos/get-readme': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`) */ - ref?: string; - }; - }; + ref?: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["content-file"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['content-file'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** * Gets the README from a repository directory. * * READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. */ - "repos/get-readme-in-directory": { + 'repos/get-readme-in-directory': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The alternate path to look for a README file */ - dir: string; - }; + dir: string + } query: { /** The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`) */ - ref?: string; - }; - }; + ref?: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["content-file"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['content-file'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** * This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/rest/reference/repos#list-repository-tags). * * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. */ - "repos/list-releases": { + 'repos/list-releases': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["release"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['release'][] + } + } + 404: components['responses']['not_found'] + } + } /** * Users with push access to the repository can create a release. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - "repos/create-release": { + 'repos/create-release': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; + Location?: string + } content: { - "application/json": components["schemas"]["release"]; - }; - }; + 'application/json': components['schemas']['release'] + } + } /** Not Found if the discussion category name is invalid */ 404: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['basic-error'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the tag. */ - tag_name: string; + tag_name: string /** @description Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`). */ - target_commitish?: string; + target_commitish?: string /** @description The name of the release. */ - name?: string; + name?: string /** @description Text describing the contents of the tag. */ - body?: string; + body?: string /** @description `true` to create a draft (unpublished) release, `false` to create a published one. */ - draft?: boolean; + draft?: boolean /** @description `true` to identify the release as a prerelease. `false` to identify the release as a full release. */ - prerelease?: boolean; + prerelease?: boolean /** @description If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see "[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." */ - discussion_category_name?: string; + discussion_category_name?: string /** @description Whether to automatically generate the name and body for this release. If `name` is specified, the specified name will be used; otherwise, a name will be automatically generated. If `body` is specified, the body will be pre-pended to the automatically generated notes. */ - generate_release_notes?: boolean; - }; - }; - }; - }; + generate_release_notes?: boolean + } + } + } + } /** To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. */ - "repos/get-release-asset": { + 'repos/get-release-asset': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** asset_id parameter */ - asset_id: components["parameters"]["asset-id"]; - }; - }; + asset_id: components['parameters']['asset-id'] + } + } responses: { /** To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. */ 200: { content: { - "application/json": components["schemas"]["release-asset"]; - }; - }; - 302: components["responses"]["found"]; - 404: components["responses"]["not_found"]; - 415: components["responses"]["preview_header_missing"]; - }; - }; - "repos/delete-release-asset": { + 'application/json': components['schemas']['release-asset'] + } + } + 302: components['responses']['found'] + 404: components['responses']['not_found'] + 415: components['responses']['preview_header_missing'] + } + } + 'repos/delete-release-asset': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** asset_id parameter */ - asset_id: components["parameters"]["asset-id"]; - }; - }; + asset_id: components['parameters']['asset-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** Users with push access to the repository can edit a release asset. */ - "repos/update-release-asset": { + 'repos/update-release-asset': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** asset_id parameter */ - asset_id: components["parameters"]["asset-id"]; - }; - }; + asset_id: components['parameters']['asset-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["release-asset"]; - }; - }; - }; + 'application/json': components['schemas']['release-asset'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The file name of the asset. */ - name?: string; + name?: string /** @description An alternate short description of the asset. Used in place of the filename. */ - label?: string; + label?: string /** @example "uploaded" */ - state?: string; - }; - }; - }; - }; + state?: string + } + } + } + } /** Generate a name and body describing a [release](https://docs.github.com/rest/reference/repos#releases). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. */ - "repos/generate-release-notes": { + 'repos/generate-release-notes': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Name and body of generated release notes */ 200: { content: { - "application/json": components["schemas"]["release-notes-content"]; - }; - }; - 404: components["responses"]["not_found"]; - }; + 'application/json': components['schemas']['release-notes-content'] + } + } + 404: components['responses']['not_found'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The tag name for the release. This can be an existing tag or a new one. */ - tag_name: string; + tag_name: string /** @description Specifies the commitish value that will be the target for the release's tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists. */ - target_commitish?: string; + target_commitish?: string /** @description The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release. */ - previous_tag_name?: string; + previous_tag_name?: string /** @description Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used. */ - configuration_file_path?: string; - }; - }; - }; - }; + configuration_file_path?: string + } + } + } + } /** * View the latest published full release for the repository. * * The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published. */ - "repos/get-latest-release": { + 'repos/get-latest-release': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["release"]; - }; - }; - }; - }; + 'application/json': components['schemas']['release'] + } + } + } + } /** Get a published release with the specified tag. */ - "repos/get-release-by-tag": { + 'repos/get-release-by-tag': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** tag parameter */ - tag: string; - }; - }; + tag: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["release"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['release'] + } + } + 404: components['responses']['not_found'] + } + } /** **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia). */ - "repos/get-release": { + 'repos/get-release': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** release_id parameter */ - release_id: components["parameters"]["release-id"]; - }; - }; + release_id: components['parameters']['release-id'] + } + } responses: { /** **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia). */ 200: { content: { - "application/json": components["schemas"]["release"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['release'] + } + } + 404: components['responses']['not_found'] + } + } /** Users with push access to the repository can delete a release. */ - "repos/delete-release": { + 'repos/delete-release': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** release_id parameter */ - release_id: components["parameters"]["release-id"]; - }; - }; + release_id: components['parameters']['release-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** Users with push access to the repository can edit a release. */ - "repos/update-release": { + 'repos/update-release': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** release_id parameter */ - release_id: components["parameters"]["release-id"]; - }; - }; + release_id: components['parameters']['release-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["release"]; - }; - }; + 'application/json': components['schemas']['release'] + } + } /** Not Found if the discussion category name is invalid */ 404: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the tag. */ - tag_name?: string; + tag_name?: string /** @description Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`). */ - target_commitish?: string; + target_commitish?: string /** @description The name of the release. */ - name?: string; + name?: string /** @description Text describing the contents of the tag. */ - body?: string; + body?: string /** @description `true` makes the release a draft, and `false` publishes the release. */ - draft?: boolean; + draft?: boolean /** @description `true` to identify the release as a prerelease, `false` to identify the release as a full release. */ - prerelease?: boolean; + prerelease?: boolean /** @description If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. If there is already a discussion linked to the release, this parameter is ignored. For more information, see "[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." */ - discussion_category_name?: string; - }; - }; - }; - }; - "repos/list-release-assets": { + discussion_category_name?: string + } + } + } + } + 'repos/list-release-assets': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** release_id parameter */ - release_id: components["parameters"]["release-id"]; - }; + release_id: components['parameters']['release-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["release-asset"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['release-asset'][] + } + } + } + } /** * This endpoint makes use of [a Hypermedia relation](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in * the response of the [Create a release endpoint](https://docs.github.com/rest/reference/repos#create-a-release) to upload a release asset. @@ -36319,276 +36285,275 @@ export interface operations { * endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). * * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. */ - "repos/upload-release-asset": { + 'repos/upload-release-asset': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** release_id parameter */ - release_id: components["parameters"]["release-id"]; - }; + release_id: components['parameters']['release-id'] + } query: { - name: string; - label?: string; - }; - }; + name: string + label?: string + } + } responses: { /** Response for successful upload */ 201: { content: { - "application/json": components["schemas"]["release-asset"]; - }; - }; + 'application/json': components['schemas']['release-asset'] + } + } /** Response if you upload an asset with the same filename as another uploaded asset */ - 422: unknown; - }; + 422: unknown + } requestBody: { content: { - "*/*": string; - }; - }; - }; + '*/*': string + } + } + } /** Create a reaction to a [release](https://docs.github.com/rest/reference/repos#releases). A response with a `Status: 200 OK` means that you already added the reaction type to this release. */ - "reactions/create-for-release": { + 'reactions/create-for-release': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** release_id parameter */ - release_id: components["parameters"]["release-id"]; - }; - }; + release_id: components['parameters']['release-id'] + } + } responses: { /** Reaction exists */ 200: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; + 'application/json': components['schemas']['reaction'] + } + } /** Reaction created */ 201: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['reaction'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the release. * @enum {string} */ - content: "+1" | "laugh" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - }; + content: '+1' | 'laugh' | 'heart' | 'hooray' | 'rocket' | 'eyes' + } + } + } + } /** * Lists secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. */ - "secret-scanning/list-alerts-for-repo": { + 'secret-scanning/list-alerts-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - state?: components["parameters"]["secret-scanning-alert-state"]; + state?: components['parameters']['secret-scanning-alert-state'] /** * A comma-separated list of secret types to return. By default all secret types are returned. * See "[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)" * for a complete list of secret types (API slug). */ - secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; + secret_type?: components['parameters']['secret-scanning-alert-secret-type'] /** A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - resolution?: components["parameters"]["secret-scanning-alert-resolution"]; + resolution?: components['parameters']['secret-scanning-alert-resolution'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["secret-scanning-alert"][]; - }; - }; + 'application/json': components['schemas']['secret-scanning-alert'][] + } + } /** Repository is public or secret scanning is disabled for the repository */ - 404: unknown; - 503: components["responses"]["service_unavailable"]; - }; - }; + 404: unknown + 503: components['responses']['service_unavailable'] + } + } /** * Gets a single secret scanning alert detected in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. */ - "secret-scanning/get-alert": { + 'secret-scanning/get-alert': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ - alert_number: components["parameters"]["alert-number"]; - }; - }; + alert_number: components['parameters']['alert-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["secret-scanning-alert"]; - }; - }; - 304: components["responses"]["not_modified"]; + 'application/json': components['schemas']['secret-scanning-alert'] + } + } + 304: components['responses']['not_modified'] /** Repository is public, or secret scanning is disabled for the repository, or the resource is not found */ - 404: unknown; - 503: components["responses"]["service_unavailable"]; - }; - }; + 404: unknown + 503: components['responses']['service_unavailable'] + } + } /** * Updates the status of a secret scanning alert in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint. */ - "secret-scanning/update-alert": { + 'secret-scanning/update-alert': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ - alert_number: components["parameters"]["alert-number"]; - }; - }; + alert_number: components['parameters']['alert-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["secret-scanning-alert"]; - }; - }; + 'application/json': components['schemas']['secret-scanning-alert'] + } + } /** Repository is public, or secret scanning is disabled for the repository, or the resource is not found */ - 404: unknown; + 404: unknown /** State does not match the resolution */ - 422: unknown; - 503: components["responses"]["service_unavailable"]; - }; + 422: unknown + 503: components['responses']['service_unavailable'] + } requestBody: { content: { - "application/json": { - state: components["schemas"]["secret-scanning-alert-state"]; - resolution?: components["schemas"]["secret-scanning-alert-resolution"]; - }; - }; - }; - }; + 'application/json': { + state: components['schemas']['secret-scanning-alert-state'] + resolution?: components['schemas']['secret-scanning-alert-resolution'] + } + } + } + } /** * Lists all locations for a given secret scanning alert for a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. */ - "secret-scanning/list-locations-for-alert": { + 'secret-scanning/list-locations-for-alert': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ - alert_number: components["parameters"]["alert-number"]; - }; + alert_number: components['parameters']['alert-number'] + } query: { /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["secret-scanning-location"][]; - }; - }; + 'application/json': components['schemas']['secret-scanning-location'][] + } + } /** Repository is public, or secret scanning is disabled for the repository, or the resource is not found */ - 404: unknown; - 503: components["responses"]["service_unavailable"]; - }; - }; + 404: unknown + 503: components['responses']['service_unavailable'] + } + } /** * Lists the people that have starred the repository. * * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: */ - "activity/list-stargazers-for-repo": { + 'activity/list-stargazers-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": Partial & - Partial; - }; - }; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': Partial & Partial + } + } + 422: components['responses']['validation_failed'] + } + } /** Returns a weekly aggregate of the number of additions and deletions pushed to a repository. */ - "repos/get-code-frequency-stats": { + 'repos/get-code-frequency-stats': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Returns a weekly aggregate of the number of additions and deletions pushed to a repository. */ 200: { content: { - "application/json": components["schemas"]["code-frequency-stat"][]; - }; - }; - 202: components["responses"]["accepted"]; - 204: components["responses"]["no_content"]; - }; - }; + 'application/json': components['schemas']['code-frequency-stat'][] + } + } + 202: components['responses']['accepted'] + 204: components['responses']['no_content'] + } + } /** Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`. */ - "repos/get-commit-activity-stats": { + 'repos/get-commit-activity-stats': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["commit-activity"][]; - }; - }; - 202: components["responses"]["accepted"]; - 204: components["responses"]["no_content"]; - }; - }; + 'application/json': components['schemas']['commit-activity'][] + } + } + 202: components['responses']['accepted'] + 204: components['responses']['no_content'] + } + } /** * Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information: * @@ -36597,13 +36562,13 @@ export interface operations { * * `d` - Number of deletions * * `c` - Number of commits */ - "repos/get-contributors-stats": { + 'repos/get-contributors-stats': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** * * `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time). @@ -36613,35 +36578,35 @@ export interface operations { */ 200: { content: { - "application/json": components["schemas"]["contributor-activity"][]; - }; - }; - 202: components["responses"]["accepted"]; - 204: components["responses"]["no_content"]; - }; - }; + 'application/json': components['schemas']['contributor-activity'][] + } + } + 202: components['responses']['accepted'] + 204: components['responses']['no_content'] + } + } /** * Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`. * * The array order is oldest week (index 0) to most recent week. */ - "repos/get-participation-stats": { + 'repos/get-participation-stats': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** The array order is oldest week (index 0) to most recent week. */ 200: { content: { - "application/json": components["schemas"]["participation-stats"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['participation-stats'] + } + } + 404: components['responses']['not_found'] + } + } /** * Each array contains the day number, hour number, and number of commits: * @@ -36651,436 +36616,436 @@ export interface operations { * * For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. */ - "repos/get-punch-card-stats": { + 'repos/get-punch-card-stats': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. */ 200: { content: { - "application/json": components["schemas"]["code-frequency-stat"][]; - }; - }; - 204: components["responses"]["no_content"]; - }; - }; + 'application/json': components['schemas']['code-frequency-stat'][] + } + } + 204: components['responses']['no_content'] + } + } /** * Users with push access in a repository can create commit statuses for a given SHA. * * Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error. */ - "repos/create-commit-status": { + 'repos/create-commit-status': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - sha: string; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + sha: string + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; + Location?: string + } content: { - "application/json": components["schemas"]["status"]; - }; - }; - }; + 'application/json': components['schemas']['status'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The state of the status. Can be one of `error`, `failure`, `pending`, or `success`. * @enum {string} */ - state: "error" | "failure" | "pending" | "success"; + state: 'error' | 'failure' | 'pending' | 'success' /** * @description The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. * For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: * `http://ci.example.com/user/repo/build/sha` */ - target_url?: string; + target_url?: string /** @description A short description of the status. */ - description?: string; + description?: string /** * @description A string label to differentiate this status from the status of other systems. This field is case-insensitive. * @default default */ - context?: string; - }; - }; - }; - }; + context?: string + } + } + } + } /** Lists the people watching the specified repository. */ - "activity/list-watchers-for-repo": { + 'activity/list-watchers-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - }; - }; - "activity/get-repo-subscription": { + 'application/json': components['schemas']['simple-user'][] + } + } + } + } + 'activity/get-repo-subscription': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** if you subscribe to the repository */ 200: { content: { - "application/json": components["schemas"]["repository-subscription"]; - }; - }; - 403: components["responses"]["forbidden"]; + 'application/json': components['schemas']['repository-subscription'] + } + } + 403: components['responses']['forbidden'] /** Not Found if you don't subscribe to the repository */ - 404: unknown; - }; - }; + 404: unknown + } + } /** If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/rest/reference/activity#delete-a-repository-subscription) completely. */ - "activity/set-repo-subscription": { + 'activity/set-repo-subscription': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["repository-subscription"]; - }; - }; - }; + 'application/json': components['schemas']['repository-subscription'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Determines if notifications should be received from this repository. */ - subscribed?: boolean; + subscribed?: boolean /** @description Determines if all notifications should be blocked from this repository. */ - ignored?: boolean; - }; - }; - }; - }; + ignored?: boolean + } + } + } + } /** This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/rest/reference/activity#set-a-repository-subscription). */ - "activity/delete-repo-subscription": { + 'activity/delete-repo-subscription': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; - }; - "repos/list-tags": { + 204: never + } + } + 'repos/list-tags': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["tag"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['tag'][] + } + } + } + } /** * Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually * `master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. * **Note**: For private repositories, these links are temporary and expire after five minutes. */ - "repos/download-tarball-archive": { + 'repos/download-tarball-archive': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - ref: string; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + ref: string + } + } responses: { /** Response */ - 302: never; - }; - }; - "repos/list-teams": { + 302: never + } + } + 'repos/list-teams': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team"][]; - }; - }; - }; - }; - "repos/get-all-topics": { + 'application/json': components['schemas']['team'][] + } + } + } + } + 'repos/get-all-topics': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["topic"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "repos/replace-all-topics": { + 'application/json': components['schemas']['topic'] + } + } + 404: components['responses']['not_found'] + } + } + 'repos/replace-all-topics': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["topic"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': components['schemas']['topic'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters. */ - names: string[]; - }; - }; - }; - }; + names: string[] + } + } + } + } /** Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. */ - "repos/get-clones": { + 'repos/get-clones': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Must be one of: `day`, `week`. */ - per?: components["parameters"]["per"]; - }; - }; + per?: components['parameters']['per'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["clone-traffic"]; - }; - }; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['clone-traffic'] + } + } + 403: components['responses']['forbidden'] + } + } /** Get the top 10 popular contents over the last 14 days. */ - "repos/get-top-paths": { + 'repos/get-top-paths': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["content-traffic"][]; - }; - }; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['content-traffic'][] + } + } + 403: components['responses']['forbidden'] + } + } /** Get the top 10 referrers over the last 14 days. */ - "repos/get-top-referrers": { + 'repos/get-top-referrers': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["referrer-traffic"][]; - }; - }; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['referrer-traffic'][] + } + } + 403: components['responses']['forbidden'] + } + } /** Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. */ - "repos/get-views": { + 'repos/get-views': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Must be one of: `day`, `week`. */ - per?: components["parameters"]["per"]; - }; - }; + per?: components['parameters']['per'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["view-traffic"]; - }; - }; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['view-traffic'] + } + } + 403: components['responses']['forbidden'] + } + } /** A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/). */ - "repos/transfer": { + 'repos/transfer': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 202: { content: { - "application/json": components["schemas"]["minimal-repository"]; - }; - }; - }; + 'application/json': components['schemas']['minimal-repository'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The username or organization name the repository will be transferred to. */ - new_owner: string; + new_owner: string /** @description ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories. */ - team_ids?: number[]; - }; - }; - }; - }; + team_ids?: number[] + } + } + } + } /** Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". */ - "repos/check-vulnerability-alerts": { + 'repos/check-vulnerability-alerts': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response if repository is enabled with vulnerability alerts */ - 204: never; + 204: never /** Not Found if repository is not enabled with vulnerability alerts */ - 404: unknown; - }; - }; + 404: unknown + } + } /** Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". */ - "repos/enable-vulnerability-alerts": { + 'repos/enable-vulnerability-alerts': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". */ - "repos/disable-vulnerability-alerts": { + 'repos/disable-vulnerability-alerts': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually * `master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. * **Note**: For private repositories, these links are temporary and expire after five minutes. */ - "repos/download-zipball-archive": { + 'repos/download-zipball-archive': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - ref: string; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + ref: string + } + } responses: { /** Response */ - 302: never; - }; - }; + 302: never + } + } /** * Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. * @@ -37091,41 +37056,41 @@ export interface operations { * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. * * `repo` scope to create a private repository */ - "repos/create-using-template": { + 'repos/create-using-template': { parameters: { path: { - template_owner: string; - template_repo: string; - }; - }; + template_owner: string + template_repo: string + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; + Location?: string + } content: { - "application/json": components["schemas"]["repository"]; - }; - }; - }; + 'application/json': components['schemas']['repository'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization. */ - owner?: string; + owner?: string /** @description The name of the new repository. */ - name: string; + name: string /** @description A short description of the new repository. */ - description?: string; + description?: string /** @description Set to `true` to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: `false`. */ - include_all_branches?: boolean; + include_all_branches?: boolean /** @description Either `true` to create a new private repository or `false` to create a new public one. */ - private?: boolean; - }; - }; - }; - }; + private?: boolean + } + } + } + } /** * Lists all public repositories in the order that they were created. * @@ -37133,93 +37098,93 @@ export interface operations { * - For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories. */ - "repos/list-public": { + 'repos/list-public': { parameters: { query: { /** A repository ID. Only return repositories with an ID greater than this ID. */ - since?: components["parameters"]["since-repo"]; - }; - }; + since?: components['parameters']['since-repo'] + } + } responses: { /** Response */ 200: { headers: { - Link?: string; - }; - content: { - "application/json": components["schemas"]["minimal-repository"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 422: components["responses"]["validation_failed"]; - }; - }; + Link?: string + } + content: { + 'application/json': components['schemas']['minimal-repository'][] + } + } + 304: components['responses']['not_modified'] + 422: components['responses']['validation_failed'] + } + } /** Lists all secrets available in an environment without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - "actions/list-environment-secrets": { + 'actions/list-environment-secrets': { parameters: { path: { - repository_id: components["parameters"]["repository-id"]; + repository_id: components['parameters']['repository-id'] /** The name of the environment */ - environment_name: components["parameters"]["environment-name"]; - }; + environment_name: components['parameters']['environment-name'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - secrets: components["schemas"]["actions-secret"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + secrets: components['schemas']['actions-secret'][] + } + } + } + } + } /** Get the public key for an environment, which you need to encrypt environment secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - "actions/get-environment-public-key": { + 'actions/get-environment-public-key': { parameters: { path: { - repository_id: components["parameters"]["repository-id"]; + repository_id: components['parameters']['repository-id'] /** The name of the environment */ - environment_name: components["parameters"]["environment-name"]; - }; - }; + environment_name: components['parameters']['environment-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-public-key"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-public-key'] + } + } + } + } /** Gets a single environment secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - "actions/get-environment-secret": { + 'actions/get-environment-secret': { parameters: { path: { - repository_id: components["parameters"]["repository-id"]; + repository_id: components['parameters']['repository-id'] /** The name of the environment */ - environment_name: components["parameters"]["environment-name"]; + environment_name: components['parameters']['environment-name'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-secret"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-secret'] + } + } + } + } /** * Creates or updates an environment secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -37297,238 +37262,238 @@ export interface operations { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - "actions/create-or-update-environment-secret": { + 'actions/create-or-update-environment-secret': { parameters: { path: { - repository_id: components["parameters"]["repository-id"]; + repository_id: components['parameters']['repository-id'] /** The name of the environment */ - environment_name: components["parameters"]["environment-name"]; + environment_name: components['parameters']['environment-name'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response when creating a secret */ 201: { content: { - "application/json": components["schemas"]["empty-object"]; - }; - }; + 'application/json': components['schemas']['empty-object'] + } + } /** Response when updating a secret */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/reference/actions#get-an-environment-public-key) endpoint. */ - encrypted_value: string; + encrypted_value: string /** @description ID of the key you used to encrypt the secret. */ - key_id: string; - }; - }; - }; - }; + key_id: string + } + } + } + } /** Deletes a secret in an environment using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - "actions/delete-environment-secret": { + 'actions/delete-environment-secret': { parameters: { path: { - repository_id: components["parameters"]["repository-id"]; + repository_id: components['parameters']['repository-id'] /** The name of the environment */ - environment_name: components["parameters"]["environment-name"]; + environment_name: components['parameters']['environment-name'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Default response */ - 204: never; - }; - }; + 204: never + } + } /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - "enterprise-admin/list-provisioned-groups-enterprise": { + 'enterprise-admin/list-provisioned-groups-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; + enterprise: components['parameters']['enterprise'] + } query: { /** Used for pagination: the index of the first result to return. */ - startIndex?: components["parameters"]["start-index"]; + startIndex?: components['parameters']['start-index'] /** Used for pagination: the number of results to return. */ - count?: components["parameters"]["count"]; + count?: components['parameters']['count'] /** filter results */ - filter?: string; + filter?: string /** attributes to exclude */ - excludedAttributes?: string; - }; - }; + excludedAttributes?: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["scim-group-list-enterprise"]; - }; - }; - }; - }; + 'application/json': components['schemas']['scim-group-list-enterprise'] + } + } + } + } /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * * Provision an enterprise group, and invite users to the group. This sends invitation emails to the email address of the invited users to join the GitHub organization that the SCIM group corresponds to. */ - "enterprise-admin/provision-and-invite-enterprise-group": { + 'enterprise-admin/provision-and-invite-enterprise-group': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["scim-enterprise-group"]; - }; - }; - }; + 'application/json': components['schemas']['scim-enterprise-group'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The SCIM schema URIs. */ - schemas: string[]; + schemas: string[] /** @description The name of the SCIM group. This must match the GitHub organization that the group maps to. */ - displayName: string; + displayName: string members?: { /** @description The SCIM user ID for a user. */ - value: string; - }[]; - }; - }; - }; - }; + value: string + }[] + } + } + } + } /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - "enterprise-admin/get-provisioning-information-for-enterprise-group": { + 'enterprise-admin/get-provisioning-information-for-enterprise-group': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Identifier generated by the GitHub SCIM endpoint. */ - scim_group_id: components["parameters"]["scim-group-id"]; - }; + scim_group_id: components['parameters']['scim-group-id'] + } query: { /** Attributes to exclude. */ - excludedAttributes?: string; - }; - }; + excludedAttributes?: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["scim-enterprise-group"]; - }; - }; - }; - }; + 'application/json': components['schemas']['scim-enterprise-group'] + } + } + } + } /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * * Replaces an existing provisioned group’s information. You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead. */ - "enterprise-admin/set-information-for-provisioned-enterprise-group": { + 'enterprise-admin/set-information-for-provisioned-enterprise-group': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Identifier generated by the GitHub SCIM endpoint. */ - scim_group_id: components["parameters"]["scim-group-id"]; - }; - }; + scim_group_id: components['parameters']['scim-group-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["scim-enterprise-group"]; - }; - }; - }; + 'application/json': components['schemas']['scim-enterprise-group'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The SCIM schema URIs. */ - schemas: string[]; + schemas: string[] /** @description The name of the SCIM group. This must match the GitHub organization that the group maps to. */ - displayName: string; + displayName: string members?: { /** @description The SCIM user ID for a user. */ - value: string; - }[]; - }; - }; - }; - }; + value: string + }[] + } + } + } + } /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - "enterprise-admin/delete-scim-group-from-enterprise": { + 'enterprise-admin/delete-scim-group-from-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Identifier generated by the GitHub SCIM endpoint. */ - scim_group_id: components["parameters"]["scim-group-id"]; - }; - }; + scim_group_id: components['parameters']['scim-group-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * * Allows you to change a provisioned group’s individual attributes. To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). */ - "enterprise-admin/update-attribute-for-enterprise-group": { + 'enterprise-admin/update-attribute-for-enterprise-group': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Identifier generated by the GitHub SCIM endpoint. */ - scim_group_id: components["parameters"]["scim-group-id"]; - }; - }; + scim_group_id: components['parameters']['scim-group-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["scim-enterprise-group"]; - }; - }; - }; + 'application/json': components['schemas']['scim-enterprise-group'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The SCIM schema URIs. */ - schemas: string[]; + schemas: string[] /** @description Array of [SCIM operations](https://tools.ietf.org/html/rfc7644#section-3.5.2). */ Operations: [ { /** @enum {string} */ - op: "add" | "Add" | "remove" | "Remove" | "replace" | "Replace"; - path?: string; + op: 'add' | 'Add' | 'remove' | 'Remove' | 'replace' | 'Replace' + path?: string /** @description Can be any value - string, number, array or object. */ - value?: unknown; + value?: unknown }, ...{ /** @enum {string} */ - op: "add" | "Add" | "remove" | "Remove" | "replace" | "Replace"; - path?: string; + op: 'add' | 'Add' | 'remove' | 'Remove' | 'replace' | 'Replace' + path?: string /** @description Can be any value - string, number, array or object. */ - value?: unknown; - }[] - ]; - }; - }; - }; - }; + value?: unknown + }[], + ] + } + } + } + } /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * @@ -37549,30 +37514,30 @@ export interface operations { * - If the user signs in, their GitHub account is linked to this entry. * - If the user does not sign in (or does not create a new account when prompted), they are not added to the GitHub enterprise, and the external identity `null` entry remains in place. */ - "enterprise-admin/list-provisioned-identities-enterprise": { + 'enterprise-admin/list-provisioned-identities-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; + enterprise: components['parameters']['enterprise'] + } query: { /** Used for pagination: the index of the first result to return. */ - startIndex?: components["parameters"]["start-index"]; + startIndex?: components['parameters']['start-index'] /** Used for pagination: the number of results to return. */ - count?: components["parameters"]["count"]; + count?: components['parameters']['count'] /** filter results */ - filter?: string; - }; - }; + filter?: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["scim-user-list-enterprise"]; - }; - }; - }; - }; + 'application/json': components['schemas']['scim-user-list-enterprise'] + } + } + } + } /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * @@ -37580,70 +37545,70 @@ export interface operations { * * You can optionally include the groups a user will be invited to join. If you do not provide a list of `groups`, the user is provisioned for the enterprise, but no organization invitation emails will be sent. */ - "enterprise-admin/provision-and-invite-enterprise-user": { + 'enterprise-admin/provision-and-invite-enterprise-user': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["scim-enterprise-user"]; - }; - }; - }; + 'application/json': components['schemas']['scim-enterprise-user'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The SCIM schema URIs. */ - schemas: string[]; + schemas: string[] /** @description The username for the user. */ - userName: string; + userName: string name: { /** @description The first name of the user. */ - givenName: string; + givenName: string /** @description The last name of the user. */ - familyName: string; - }; + familyName: string + } /** @description List of user emails. */ emails: { /** @description The email address. */ - value: string; + value: string /** @description The type of email address. */ - type: string; + type: string /** @description Whether this email address is the primary address. */ - primary: boolean; - }[]; + primary: boolean + }[] /** @description List of SCIM group IDs the user is a member of. */ groups?: { - value?: string; - }[]; - }; - }; - }; - }; + value?: string + }[] + } + } + } + } /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - "enterprise-admin/get-provisioning-information-for-enterprise-user": { + 'enterprise-admin/get-provisioning-information-for-enterprise-user': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** scim_user_id parameter */ - scim_user_id: components["parameters"]["scim-user-id"]; - }; - }; + scim_user_id: components['parameters']['scim-user-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["scim-enterprise-user"]; - }; - }; - }; - }; + 'application/json': components['schemas']['scim-enterprise-user'] + } + } + } + } /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * @@ -37653,68 +37618,68 @@ export interface operations { * * **Warning:** Setting `active: false` removes the user from the enterprise, deletes the external identity, and deletes the associated `{scim_user_id}`. */ - "enterprise-admin/set-information-for-provisioned-enterprise-user": { + 'enterprise-admin/set-information-for-provisioned-enterprise-user': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** scim_user_id parameter */ - scim_user_id: components["parameters"]["scim-user-id"]; - }; - }; + scim_user_id: components['parameters']['scim-user-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["scim-enterprise-user"]; - }; - }; - }; + 'application/json': components['schemas']['scim-enterprise-user'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The SCIM schema URIs. */ - schemas: string[]; + schemas: string[] /** @description The username for the user. */ - userName: string; + userName: string name: { /** @description The first name of the user. */ - givenName: string; + givenName: string /** @description The last name of the user. */ - familyName: string; - }; + familyName: string + } /** @description List of user emails. */ emails: { /** @description The email address. */ - value: string; + value: string /** @description The type of email address. */ - type: string; + type: string /** @description Whether this email address is the primary address. */ - primary: boolean; - }[]; + primary: boolean + }[] /** @description List of SCIM group IDs the user is a member of. */ groups?: { - value?: string; - }[]; - }; - }; - }; - }; + value?: string + }[] + } + } + } + } /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - "enterprise-admin/delete-user-from-enterprise": { + 'enterprise-admin/delete-user-from-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** scim_user_id parameter */ - scim_user_id: components["parameters"]["scim-user-id"]; - }; - }; + scim_user_id: components['parameters']['scim-user-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * @@ -37735,34 +37700,34 @@ export interface operations { * } * ``` */ - "enterprise-admin/update-attribute-for-enterprise-user": { + 'enterprise-admin/update-attribute-for-enterprise-user': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** scim_user_id parameter */ - scim_user_id: components["parameters"]["scim-user-id"]; - }; - }; + scim_user_id: components['parameters']['scim-user-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["scim-enterprise-user"]; - }; - }; - }; + 'application/json': components['schemas']['scim-enterprise-user'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The SCIM schema URIs. */ - schemas: string[]; + schemas: string[] /** @description Array of [SCIM operations](https://tools.ietf.org/html/rfc7644#section-3.5.2). */ - Operations: { [key: string]: unknown }[]; - }; - }; - }; - }; + Operations: { [key: string]: unknown }[] + } + } + } + } /** * Retrieves a paginated list of all provisioned organization members, including pending invitations. If you provide the `filter` parameter, the resources for all matching provisions members are returned. * @@ -37781,16 +37746,16 @@ export interface operations { * - If the user signs in, their GitHub account is linked to this entry. * - If the user does not sign in (or does not create a new account when prompted), they are not added to the GitHub organization, and the external identity `null` entry remains in place. */ - "scim/list-provisioned-identities": { + 'scim/list-provisioned-identities': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Used for pagination: the index of the first result to return. */ - startIndex?: number; + startIndex?: number /** Used for pagination: the number of results to return. */ - count?: number; + count?: number /** * Filters results using the equals query parameter operator (`eq`). You can filter results that are equal to `id`, `userName`, `emails`, and `external_id`. For example, to search for an identity with the `userName` Octocat, you would use this query: * @@ -37800,106 +37765,106 @@ export interface operations { * * `?filter=emails%20eq%20\"octocat@github.com\"`. */ - filter?: string; - }; - }; + filter?: string + } + } responses: { /** Response */ 200: { content: { - "application/scim+json": components["schemas"]["scim-user-list"]; - }; - }; - 304: components["responses"]["not_modified"]; - 400: components["responses"]["scim_bad_request"]; - 403: components["responses"]["scim_forbidden"]; - 404: components["responses"]["scim_not_found"]; - }; - }; + 'application/scim+json': components['schemas']['scim-user-list'] + } + } + 304: components['responses']['not_modified'] + 400: components['responses']['scim_bad_request'] + 403: components['responses']['scim_forbidden'] + 404: components['responses']['scim_not_found'] + } + } /** Provision organization membership for a user, and send an activation email to the email address. */ - "scim/provision-and-invite-user": { + 'scim/provision-and-invite-user': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 201: { content: { - "application/scim+json": components["schemas"]["scim-user"]; - }; - }; - 304: components["responses"]["not_modified"]; - 400: components["responses"]["scim_bad_request"]; - 403: components["responses"]["scim_forbidden"]; - 404: components["responses"]["scim_not_found"]; - 409: components["responses"]["scim_conflict"]; - 500: components["responses"]["scim_internal_error"]; - }; + 'application/scim+json': components['schemas']['scim-user'] + } + } + 304: components['responses']['not_modified'] + 400: components['responses']['scim_bad_request'] + 403: components['responses']['scim_forbidden'] + 404: components['responses']['scim_not_found'] + 409: components['responses']['scim_conflict'] + 500: components['responses']['scim_internal_error'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description Configured by the admin. Could be an email, login, or username * @example someone@example.com */ - userName: string; + userName: string /** * @description The name of the user, suitable for display to end-users * @example Jon Doe */ - displayName?: string; + displayName?: string /** @example [object Object] */ name: { - givenName: string; - familyName: string; - formatted?: string; - }; + givenName: string + familyName: string + formatted?: string + } /** * @description user emails * @example [object Object],[object Object] */ emails: [ { - value: string; - primary?: boolean; - type?: string; + value: string + primary?: boolean + type?: string }, ...{ - value: string; - primary?: boolean; - type?: string; - }[] - ]; - schemas?: string[]; - externalId?: string; - groups?: string[]; - active?: boolean; - }; - }; - }; - }; - "scim/get-provisioning-information-for-user": { - parameters: { - path: { - org: components["parameters"]["org"]; + value: string + primary?: boolean + type?: string + }[], + ] + schemas?: string[] + externalId?: string + groups?: string[] + active?: boolean + } + } + } + } + 'scim/get-provisioning-information-for-user': { + parameters: { + path: { + org: components['parameters']['org'] /** scim_user_id parameter */ - scim_user_id: components["parameters"]["scim-user-id"]; - }; - }; + scim_user_id: components['parameters']['scim-user-id'] + } + } responses: { /** Response */ 200: { content: { - "application/scim+json": components["schemas"]["scim-user"]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["scim_forbidden"]; - 404: components["responses"]["scim_not_found"]; - }; - }; + 'application/scim+json': components['schemas']['scim-user'] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['scim_forbidden'] + 404: components['responses']['scim_not_found'] + } + } /** * Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](https://docs.github.com/rest/reference/scim#update-an-attribute-for-a-scim-user) endpoint instead. * @@ -37907,84 +37872,84 @@ export interface operations { * * **Warning:** Setting `active: false` removes the user from the organization, deletes the external identity, and deletes the associated `{scim_user_id}`. */ - "scim/set-information-for-provisioned-user": { + 'scim/set-information-for-provisioned-user': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** scim_user_id parameter */ - scim_user_id: components["parameters"]["scim-user-id"]; - }; - }; + scim_user_id: components['parameters']['scim-user-id'] + } + } responses: { /** Response */ 200: { content: { - "application/scim+json": components["schemas"]["scim-user"]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["scim_forbidden"]; - 404: components["responses"]["scim_not_found"]; - }; + 'application/scim+json': components['schemas']['scim-user'] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['scim_forbidden'] + 404: components['responses']['scim_not_found'] + } requestBody: { content: { - "application/json": { - schemas?: string[]; + 'application/json': { + schemas?: string[] /** * @description The name of the user, suitable for display to end-users * @example Jon Doe */ - displayName?: string; - externalId?: string; - groups?: string[]; - active?: boolean; + displayName?: string + externalId?: string + groups?: string[] + active?: boolean /** * @description Configured by the admin. Could be an email, login, or username * @example someone@example.com */ - userName: string; + userName: string /** @example [object Object] */ name: { - givenName: string; - familyName: string; - formatted?: string; - }; + givenName: string + familyName: string + formatted?: string + } /** * @description user emails * @example [object Object],[object Object] */ emails: [ { - type?: string; - value: string; - primary?: boolean; + type?: string + value: string + primary?: boolean }, ...{ - type?: string; - value: string; - primary?: boolean; - }[] - ]; - }; - }; - }; - }; - "scim/delete-user-from-org": { - parameters: { - path: { - org: components["parameters"]["org"]; + type?: string + value: string + primary?: boolean + }[], + ] + } + } + } + } + 'scim/delete-user-from-org': { + parameters: { + path: { + org: components['parameters']['org'] /** scim_user_id parameter */ - scim_user_id: components["parameters"]["scim-user-id"]; - }; - }; + scim_user_id: components['parameters']['scim-user-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["scim_forbidden"]; - 404: components["responses"]["scim_not_found"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 403: components['responses']['scim_forbidden'] + 404: components['responses']['scim_not_found'] + } + } /** * Allows you to change a provisioned user's individual attributes. To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). * @@ -38003,36 +37968,36 @@ export interface operations { * } * ``` */ - "scim/update-attribute-for-user": { + 'scim/update-attribute-for-user': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** scim_user_id parameter */ - scim_user_id: components["parameters"]["scim-user-id"]; - }; - }; + scim_user_id: components['parameters']['scim-user-id'] + } + } responses: { /** Response */ 200: { content: { - "application/scim+json": components["schemas"]["scim-user"]; - }; - }; - 304: components["responses"]["not_modified"]; - 400: components["responses"]["scim_bad_request"]; - 403: components["responses"]["scim_forbidden"]; - 404: components["responses"]["scim_not_found"]; + 'application/scim+json': components['schemas']['scim-user'] + } + } + 304: components['responses']['not_modified'] + 400: components['responses']['scim_bad_request'] + 403: components['responses']['scim_forbidden'] + 404: components['responses']['scim_not_found'] /** Response */ 429: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } + } requestBody: { content: { - "application/json": { - schemas?: string[]; + 'application/json': { + schemas?: string[] /** * @description Set of operations to be performed * @example [object Object] @@ -38040,45 +38005,45 @@ export interface operations { Operations: [ { /** @enum {string} */ - op: "add" | "remove" | "replace"; - path?: string; + op: 'add' | 'remove' | 'replace' + path?: string value?: | { - active?: boolean | null; - userName?: string | null; - externalId?: string | null; - givenName?: string | null; - familyName?: string | null; + active?: boolean | null + userName?: string | null + externalId?: string | null + givenName?: string | null + familyName?: string | null } | { - value?: string; - primary?: boolean; + value?: string + primary?: boolean }[] - | string; + | string }, ...{ /** @enum {string} */ - op: "add" | "remove" | "replace"; - path?: string; + op: 'add' | 'remove' | 'replace' + path?: string value?: | { - active?: boolean | null; - userName?: string | null; - externalId?: string | null; - givenName?: string | null; - familyName?: string | null; + active?: boolean | null + userName?: string | null + externalId?: string | null + givenName?: string | null + familyName?: string | null } | { - value?: string; - primary?: boolean; + value?: string + primary?: boolean }[] - | string; - }[] - ]; - }; - }; - }; - }; + | string + }[], + ] + } + } + } + } /** * Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -38099,38 +38064,38 @@ export interface operations { * * You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing * language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. */ - "search/code": { + 'search/code': { parameters: { query: { /** The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching code](https://docs.github.com/articles/searching-code/)" for a detailed list of qualifiers. */ - q: string; + q: string /** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */ - sort?: "indexed"; + sort?: 'indexed' /** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - order?: components["parameters"]["order"]; + order?: components['parameters']['order'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - incomplete_results: boolean; - items: components["schemas"]["code-search-result-item"][]; - }; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': { + total_count: number + incomplete_results: boolean + items: components['schemas']['code-search-result-item'][] + } + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + 503: components['responses']['service_unavailable'] + } + } /** * Find commits via various criteria on the default branch (usually `master`). This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -38141,35 +38106,35 @@ export interface operations { * * `q=repo:octocat/Spoon-Knife+css` */ - "search/commits": { + 'search/commits': { parameters: { query: { /** The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching commits](https://docs.github.com/articles/searching-commits/)" for a detailed list of qualifiers. */ - q: string; + q: string /** Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */ - sort?: "author-date" | "committer-date"; + sort?: 'author-date' | 'committer-date' /** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - order?: components["parameters"]["order"]; + order?: components['parameters']['order'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - incomplete_results: boolean; - items: components["schemas"]["commit-search-result-item"][]; - }; - }; - }; - 304: components["responses"]["not_modified"]; - }; - }; + 'application/json': { + total_count: number + incomplete_results: boolean + items: components['schemas']['commit-search-result-item'][] + } + } + } + 304: components['responses']['not_modified'] + } + } /** * Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -38184,49 +38149,49 @@ export interface operations { * * **Note:** For [user-to-server](https://docs.github.com/developers/apps/identifying-and-authorizing-users-for-github-apps#user-to-server-requests) GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." */ - "search/issues-and-pull-requests": { + 'search/issues-and-pull-requests': { parameters: { query: { /** The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching issues and pull requests](https://docs.github.com/articles/searching-issues-and-pull-requests/)" for a detailed list of qualifiers. */ - q: string; + q: string /** Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */ sort?: - | "comments" - | "reactions" - | "reactions-+1" - | "reactions--1" - | "reactions-smile" - | "reactions-thinking_face" - | "reactions-heart" - | "reactions-tada" - | "interactions" - | "created" - | "updated"; + | 'comments' + | 'reactions' + | 'reactions-+1' + | 'reactions--1' + | 'reactions-smile' + | 'reactions-thinking_face' + | 'reactions-heart' + | 'reactions-tada' + | 'interactions' + | 'created' + | 'updated' /** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - order?: components["parameters"]["order"]; + order?: components['parameters']['order'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - incomplete_results: boolean; - items: components["schemas"]["issue-search-result-item"][]; - }; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': { + total_count: number + incomplete_results: boolean + items: components['schemas']['issue-search-result-item'][] + } + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + 503: components['responses']['service_unavailable'] + } + } /** * Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -38238,40 +38203,40 @@ export interface operations { * * The labels that best match the query appear first in the search results. */ - "search/labels": { + 'search/labels': { parameters: { query: { /** The id of the repository. */ - repository_id: number; + repository_id: number /** The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). */ - q: string; + q: string /** Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */ - sort?: "created" | "updated"; + sort?: 'created' | 'updated' /** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - order?: components["parameters"]["order"]; + order?: components['parameters']['order'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - incomplete_results: boolean; - items: components["schemas"]["label-search-result-item"][]; - }; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': { + total_count: number + incomplete_results: boolean + items: components['schemas']['label-search-result-item'][] + } + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** * Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -38283,37 +38248,37 @@ export interface operations { * * This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results. */ - "search/repos": { + 'search/repos': { parameters: { query: { /** The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers. */ - q: string; + q: string /** Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */ - sort?: "stars" | "forks" | "help-wanted-issues" | "updated"; + sort?: 'stars' | 'forks' | 'help-wanted-issues' | 'updated' /** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - order?: components["parameters"]["order"]; + order?: components['parameters']['order'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - incomplete_results: boolean; - items: components["schemas"]["repo-search-result-item"][]; - }; - }; - }; - 304: components["responses"]["not_modified"]; - 422: components["responses"]["validation_failed"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': { + total_count: number + incomplete_results: boolean + items: components['schemas']['repo-search-result-item'][] + } + } + } + 304: components['responses']['not_modified'] + 422: components['responses']['validation_failed'] + 503: components['responses']['service_unavailable'] + } + } /** * Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers. * @@ -38325,31 +38290,31 @@ export interface operations { * * This query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results. */ - "search/topics": { + 'search/topics': { parameters: { query: { /** The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). */ - q: string; + q: string /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - incomplete_results: boolean; - items: components["schemas"]["topic-search-result-item"][]; - }; - }; - }; - 304: components["responses"]["not_modified"]; - }; - }; + 'application/json': { + total_count: number + incomplete_results: boolean + items: components['schemas']['topic-search-result-item'][] + } + } + } + 304: components['responses']['not_modified'] + } + } /** * Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -38361,54 +38326,54 @@ export interface operations { * * This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. */ - "search/users": { + 'search/users': { parameters: { query: { /** The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching users](https://docs.github.com/articles/searching-users/)" for a detailed list of qualifiers. */ - q: string; + q: string /** Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */ - sort?: "followers" | "repositories" | "joined"; + sort?: 'followers' | 'repositories' | 'joined' /** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - order?: components["parameters"]["order"]; + order?: components['parameters']['order'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - incomplete_results: boolean; - items: components["schemas"]["user-search-result-item"][]; - }; - }; - }; - 304: components["responses"]["not_modified"]; - 422: components["responses"]["validation_failed"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': { + total_count: number + incomplete_results: boolean + items: components['schemas']['user-search-result-item'][] + } + } + } + 304: components['responses']['not_modified'] + 422: components['responses']['validation_failed'] + 503: components['responses']['service_unavailable'] + } + } /** **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/reference/teams#get-a-team-by-name) endpoint. */ - "teams/get-legacy": { + 'teams/get-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; - }; + team_id: components['parameters']['team-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-full"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['team-full'] + } + } + 404: components['responses']['not_found'] + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/reference/teams#delete-a-team) endpoint. * @@ -38416,19 +38381,19 @@ export interface operations { * * If you are an organization owner, deleting a parent team will delete all of its child teams as well. */ - "teams/delete-legacy": { + 'teams/delete-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; - }; + team_id: components['parameters']['team-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/reference/teams#update-a-team) endpoint. * @@ -38436,36 +38401,36 @@ export interface operations { * * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. */ - "teams/update-legacy": { + 'teams/update-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; - }; + team_id: components['parameters']['team-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-full"]; - }; - }; + 'application/json': components['schemas']['team-full'] + } + } /** Response */ 201: { content: { - "application/json": components["schemas"]["team-full"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['team-full'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the team. */ - name: string; + name: string /** @description The description of the team. */ - description?: string; + description?: string /** * @description The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: * **For a non-nested team:** @@ -38475,7 +38440,7 @@ export interface operations { * \* `closed` - visible to all members of this organization. * @enum {string} */ - privacy?: "secret" | "closed"; + privacy?: 'secret' | 'closed' /** * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: * \* `pull` - team members can pull, but not push to or administer newly-added repositories. @@ -38484,42 +38449,42 @@ export interface operations { * @default pull * @enum {string} */ - permission?: "pull" | "push" | "admin"; + permission?: 'pull' | 'push' | 'admin' /** @description The ID of a team to set as the parent team. */ - parent_team_id?: number | null; - }; - }; - }; - }; + parent_team_id?: number | null + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/reference/teams#list-discussions) endpoint. * * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "teams/list-discussions-legacy": { + 'teams/list-discussions-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; + team_id: components['parameters']['team-id'] + } query: { /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team-discussion"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['team-discussion'][] + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/reference/teams#create-a-discussion) endpoint. * @@ -38527,132 +38492,132 @@ export interface operations { * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - "teams/create-discussion-legacy": { + 'teams/create-discussion-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; - }; + team_id: components['parameters']['team-id'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; + 'application/json': components['schemas']['team-discussion'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The discussion post's title. */ - title: string; + title: string /** @description The discussion post's body text. */ - body: string; + body: string /** @description Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. */ - private?: boolean; - }; - }; - }; - }; + private?: boolean + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/reference/teams#get-a-discussion) endpoint. * * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "teams/get-discussion-legacy": { + 'teams/get-discussion-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - }; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; - }; + 'application/json': components['schemas']['team-discussion'] + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/reference/teams#delete-a-discussion) endpoint. * * Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "teams/delete-discussion-legacy": { + 'teams/delete-discussion-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - }; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/reference/teams#update-a-discussion) endpoint. * * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "teams/update-discussion-legacy": { + 'teams/update-discussion-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - }; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; + 'application/json': components['schemas']['team-discussion'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The discussion post's title. */ - title?: string; + title?: string /** @description The discussion post's body text. */ - body?: string; - }; - }; - }; - }; + body?: string + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/reference/teams#list-discussion-comments) endpoint. * * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "teams/list-discussion-comments-legacy": { + 'teams/list-discussion-comments-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + } query: { /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team-discussion-comment"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['team-discussion-comment'][] + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/reference/teams#create-a-discussion-comment) endpoint. * @@ -38660,263 +38625,263 @@ export interface operations { * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - "teams/create-discussion-comment-legacy": { + 'teams/create-discussion-comment-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - }; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; + 'application/json': components['schemas']['team-discussion-comment'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The discussion comment's body text. */ - body: string; - }; - }; - }; - }; + body: string + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/reference/teams#get-a-discussion-comment) endpoint. * * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "teams/get-discussion-comment-legacy": { + 'teams/get-discussion-comment-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - comment_number: components["parameters"]["comment-number"]; - }; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + comment_number: components['parameters']['comment-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; - }; + 'application/json': components['schemas']['team-discussion-comment'] + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/reference/teams#delete-a-discussion-comment) endpoint. * * Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "teams/delete-discussion-comment-legacy": { + 'teams/delete-discussion-comment-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - comment_number: components["parameters"]["comment-number"]; - }; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + comment_number: components['parameters']['comment-number'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/reference/teams#update-a-discussion-comment) endpoint. * * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "teams/update-discussion-comment-legacy": { + 'teams/update-discussion-comment-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - comment_number: components["parameters"]["comment-number"]; - }; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + comment_number: components['parameters']['comment-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; + 'application/json': components['schemas']['team-discussion-comment'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The discussion comment's body text. */ - body: string; - }; - }; - }; - }; + body: string + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * * List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "reactions/list-for-team-discussion-comment-legacy": { + 'reactions/list-for-team-discussion-comment-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - comment_number: components["parameters"]["comment-number"]; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + comment_number: components['parameters']['comment-number'] + } query: { /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion comment. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content?: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["reaction"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['reaction'][] + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. * * Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. */ - "reactions/create-for-team-discussion-comment-legacy": { + 'reactions/create-for-team-discussion-comment-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - comment_number: components["parameters"]["comment-number"]; - }; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + comment_number: components['parameters']['comment-number'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - }; + 'application/json': components['schemas']['reaction'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion comment. * @enum {string} */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - }; + content: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion) endpoint. * * List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "reactions/list-for-team-discussion-legacy": { + 'reactions/list-for-team-discussion-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + } query: { /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content?: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["reaction"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['reaction'][] + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion) endpoint. * * Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. */ - "reactions/create-for-team-discussion-legacy": { + 'reactions/create-for-team-discussion-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - }; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - }; + 'application/json': components['schemas']['reaction'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion. * @enum {string} */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - }; + content: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/reference/teams#list-pending-team-invitations) endpoint. * * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. */ - "teams/list-pending-invitations-legacy": { + 'teams/list-pending-invitations-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; + team_id: components['parameters']['team-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["organization-invitation"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['organization-invitation'][] + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/reference/teams#list-team-members) endpoint. * * Team members will include the members of child teams. */ - "teams/list-members-legacy": { + 'teams/list-members-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; + team_id: components['parameters']['team-id'] + } query: { /** * Filters members returned by their role in the team. Can be one of: @@ -38924,24 +38889,24 @@ export interface operations { * \* `maintainer` - team maintainers. * \* `all` - all members of the team. */ - role?: "member" | "maintainer" | "all"; + role?: 'member' | 'maintainer' | 'all' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + 404: components['responses']['not_found'] + } + } /** * The "Get team member" endpoint (described below) is deprecated. * @@ -38949,20 +38914,20 @@ export interface operations { * * To list members in a team, the team must be visible to the authenticated user. */ - "teams/get-member-legacy": { + 'teams/get-member-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - username: components["parameters"]["username"]; - }; - }; + team_id: components['parameters']['team-id'] + username: components['parameters']['username'] + } + } responses: { /** if user is a member */ - 204: never; + 204: never /** if user is not a member */ - 404: unknown; - }; - }; + 404: unknown + } + } /** * The "Add team member" endpoint (described below) is deprecated. * @@ -38976,23 +38941,23 @@ export interface operations { * * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - "teams/add-member-legacy": { + 'teams/add-member-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - username: components["parameters"]["username"]; - }; - }; + team_id: components['parameters']['team-id'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 403: components["responses"]["forbidden"]; + 204: never + 403: components['responses']['forbidden'] /** Not Found if team synchronization is set up */ - 404: unknown; + 404: unknown /** Unprocessable Entity if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization */ - 422: unknown; - }; - }; + 422: unknown + } + } /** * The "Remove team member" endpoint (described below) is deprecated. * @@ -39004,20 +38969,20 @@ export interface operations { * * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ - "teams/remove-member-legacy": { + 'teams/remove-member-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - username: components["parameters"]["username"]; - }; - }; + team_id: components['parameters']['team-id'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; + 204: never /** Not Found if team synchronization is setup */ - 404: unknown; - }; - }; + 404: unknown + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/reference/teams#get-team-membership-for-a-user) endpoint. * @@ -39030,23 +38995,23 @@ export interface operations { * * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team). */ - "teams/get-membership-for-user-legacy": { + 'teams/get-membership-for-user-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - username: components["parameters"]["username"]; - }; - }; + team_id: components['parameters']['team-id'] + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-membership"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['team-membership'] + } + } + 404: components['responses']['not_found'] + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint. * @@ -39060,29 +39025,29 @@ export interface operations { * * If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. */ - "teams/add-or-update-membership-for-user-legacy": { + 'teams/add-or-update-membership-for-user-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - username: components["parameters"]["username"]; - }; - }; + team_id: components['parameters']['team-id'] + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-membership"]; - }; - }; + 'application/json': components['schemas']['team-membership'] + } + } /** Forbidden if team synchronization is set up */ - 403: unknown; - 404: components["responses"]["not_found"]; + 403: unknown + 404: components['responses']['not_found'] /** Unprocessable Entity if you attempt to add an organization to a team */ - 422: unknown; - }; + 422: unknown + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The role that this user should have in the team. Can be one of: * \* `member` - a normal member of the team. @@ -39090,11 +39055,11 @@ export interface operations { * @default member * @enum {string} */ - role?: "member" | "maintainer"; - }; - }; - }; - }; + role?: 'member' | 'maintainer' + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/reference/teams#remove-team-membership-for-a-user) endpoint. * @@ -39104,101 +39069,101 @@ export interface operations { * * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ - "teams/remove-membership-for-user-legacy": { + 'teams/remove-membership-for-user-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - username: components["parameters"]["username"]; - }; - }; + team_id: components['parameters']['team-id'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; + 204: never /** if team synchronization is set up */ - 403: unknown; - }; - }; + 403: unknown + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/reference/teams#list-team-projects) endpoint. * * Lists the organization projects for a team. */ - "teams/list-projects-legacy": { + 'teams/list-projects-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; + team_id: components['parameters']['team-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team-project"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['team-project'][] + } + } + 404: components['responses']['not_found'] + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/reference/teams#check-team-permissions-for-a-project) endpoint. * * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. */ - "teams/check-permissions-for-project-legacy": { + 'teams/check-permissions-for-project-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - project_id: components["parameters"]["project-id"]; - }; - }; + team_id: components['parameters']['team-id'] + project_id: components['parameters']['project-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-project"]; - }; - }; + 'application/json': components['schemas']['team-project'] + } + } /** Not Found if project is not managed by this team */ - 404: unknown; - }; - }; + 404: unknown + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/reference/teams#add-or-update-team-project-permissions) endpoint. * * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. */ - "teams/add-or-update-project-permissions-legacy": { + 'teams/add-or-update-project-permissions-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - project_id: components["parameters"]["project-id"]; - }; - }; + team_id: components['parameters']['team-id'] + project_id: components['parameters']['project-id'] + } + } responses: { /** Response */ - 204: never; + 204: never /** Forbidden if the project is not owned by the organization */ 403: { content: { - "application/json": { - message?: string; - documentation_url?: string; - }; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': { + message?: string + documentation_url?: string + } + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The permission to grant to the team for this project. Can be one of: * \* `read` - team members can read, but not write to or administer this project. @@ -39207,55 +39172,55 @@ export interface operations { * Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." * @enum {string} */ - permission?: "read" | "write" | "admin"; - }; - }; - }; - }; + permission?: 'read' | 'write' | 'admin' + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/reference/teams#remove-a-project-from-a-team) endpoint. * * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. */ - "teams/remove-project-legacy": { + 'teams/remove-project-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - project_id: components["parameters"]["project-id"]; - }; - }; + team_id: components['parameters']['team-id'] + project_id: components['parameters']['project-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - 415: components["responses"]["preview_header_missing"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + 415: components['responses']['preview_header_missing'] + 422: components['responses']['validation_failed'] + } + } /** **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/reference/teams#list-team-repositories) endpoint. */ - "teams/list-repos-legacy": { + 'teams/list-repos-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; + team_id: components['parameters']['team-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["minimal-repository"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['minimal-repository'][] + } + } + 404: components['responses']['not_found'] + } + } /** * **Note**: Repositories inherited through a parent team will also be checked. * @@ -39263,27 +39228,27 @@ export interface operations { * * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: */ - "teams/check-permissions-for-repo-legacy": { + 'teams/check-permissions-for-repo-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + team_id: components['parameters']['team-id'] + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Alternative response with extra repository information */ 200: { content: { - "application/json": components["schemas"]["team-repository"]; - }; - }; + 'application/json': components['schemas']['team-repository'] + } + } /** Response if repository is managed by this team */ - 204: never; + 204: never /** Not Found if repository is not managed by this team */ - 404: unknown; - }; - }; + 404: unknown + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/reference/teams#add-or-update-team-repository-permissions)" endpoint. * @@ -39291,23 +39256,23 @@ export interface operations { * * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - "teams/add-or-update-repo-permissions-legacy": { + 'teams/add-or-update-repo-permissions-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + team_id: components['parameters']['team-id'] + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + 204: never + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The permission to grant the team on this repository. Can be one of: * \* `pull` - team members can pull, but not push to or administer this repository. @@ -39317,29 +39282,29 @@ export interface operations { * If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. * @enum {string} */ - permission?: "pull" | "push" | "admin"; - }; - }; - }; - }; + permission?: 'pull' | 'push' | 'admin' + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/reference/teams#remove-a-repository-from-a-team) endpoint. * * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. */ - "teams/remove-repo-legacy": { + 'teams/remove-repo-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + team_id: components['parameters']['team-id'] + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List IdP groups for a team`](https://docs.github.com/rest/reference/teams#list-idp-groups-for-a-team) endpoint. * @@ -39347,23 +39312,23 @@ export interface operations { * * List IdP groups connected to a team on GitHub. */ - "teams/list-idp-groups-for-legacy": { + 'teams/list-idp-groups-for-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; - }; + team_id: components['parameters']['team-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["group-mapping"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['group-mapping'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create or update IdP group connections`](https://docs.github.com/rest/reference/teams#create-or-update-idp-group-connections) endpoint. * @@ -39371,249 +39336,249 @@ export interface operations { * * Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty `groups` array will remove all connections for a team. */ - "teams/create-or-update-idp-group-connections-legacy": { + 'teams/create-or-update-idp-group-connections-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; - }; + team_id: components['parameters']['team-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["group-mapping"]; - }; - }; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['group-mapping'] + } + } + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The IdP groups you want to connect to a GitHub team. When updating, the new `groups` object will replace the original one. You must include any existing groups that you don't want to remove. */ groups: { /** @description ID of the IdP group. */ - group_id: string; + group_id: string /** @description Name of the IdP group. */ - group_name: string; + group_name: string /** @description Description of the IdP group. */ - group_description: string; + group_description: string /** @example "caceab43fc9ffa20081c" */ - id?: string; + id?: string /** @example "external-team-6c13e7288ef7" */ - name?: string; + name?: string /** @example "moar cheese pleese" */ - description?: string; - }[]; + description?: string + }[] /** @example "I am not a timestamp" */ - synced_at?: string; - }; - }; - }; - }; + synced_at?: string + } + } + } + } /** **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/reference/teams#list-child-teams) endpoint. */ - "teams/list-child-legacy": { + 'teams/list-child-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; + team_id: components['parameters']['team-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** if child teams exist */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team"][]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['team'][] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** * If the authenticated user is authenticated through basic authentication or OAuth with the `user` scope, then the response lists public and private profile information. * * If the authenticated user is authenticated through OAuth without the `user` scope, then the response lists only public profile information. */ - "users/get-authenticated": { - parameters: {}; + 'users/get-authenticated': { + parameters: {} responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["private-user"] | components["schemas"]["public-user"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['private-user'] | components['schemas']['public-user'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** **Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API. */ - "users/update-authenticated": { - parameters: {}; + 'users/update-authenticated': { + parameters: {} responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["private-user"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['private-user'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The new name of the user. * @example Omar Jahandar */ - name?: string; + name?: string /** * @description The publicly visible email address of the user. * @example omar@example.com */ - email?: string; + email?: string /** * @description The new blog URL of the user. * @example blog.example.com */ - blog?: string; + blog?: string /** * @description The new Twitter username of the user. * @example therealomarj */ - twitter_username?: string | null; + twitter_username?: string | null /** * @description The new company of the user. * @example Acme corporation */ - company?: string; + company?: string /** * @description The new location of the user. * @example Berlin, Germany */ - location?: string; + location?: string /** @description The new hiring availability of the user. */ - hireable?: boolean; + hireable?: boolean /** @description The new short biography of the user. */ - bio?: string; - }; - }; - }; - }; + bio?: string + } + } + } + } /** List the users you've blocked on your personal account. */ - "users/list-blocked-by-authenticated-user": { - parameters: {}; + 'users/list-blocked-by-authenticated-user': { + parameters: {} responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 415: components["responses"]["preview_header_missing"]; - }; - }; - "users/check-blocked": { + 'application/json': components['schemas']['simple-user'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 415: components['responses']['preview_header_missing'] + } + } + 'users/check-blocked': { parameters: { path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** If the user is blocked: */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] /** If the user is not blocked: */ 404: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - }; - }; - "users/block": { + 'application/json': components['schemas']['basic-error'] + } + } + } + } + 'users/block': { parameters: { path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "users/unblock": { + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } + 'users/unblock': { parameters: { path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Lists the authenticated user's codespaces. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/list-for-authenticated-user": { + 'codespaces/list-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** ID of the Repository to filter on */ - repository_id?: components["parameters"]["repository-id-in-query"]; - }; - }; + repository_id?: components['parameters']['repository-id-in-query'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - codespaces: components["schemas"]["codespace"][]; - }; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': { + total_count: number + codespaces: components['schemas']['codespace'][] + } + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** * Creates a new codespace, owned by the authenticated user. * @@ -39621,119 +39586,119 @@ export interface operations { * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/create-for-authenticated-user": { + 'codespaces/create-for-authenticated-user': { responses: { /** Response when the codespace was successfully created */ 201: { content: { - "application/json": components["schemas"]["codespace"]; - }; - }; + 'application/json': components['schemas']['codespace'] + } + } /** Response when the codespace creation partially failed but is being retried in the background */ 202: { content: { - "application/json": components["schemas"]["codespace"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; + 'application/json': components['schemas']['codespace'] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description Repository id for this codespace */ - repository_id: number; + repository_id: number /** @description Git ref (typically a branch name) for this codespace */ - ref?: string; + ref?: string /** @description Location for this codespace */ - location: string; + location: string /** @description Machine type to use for this codespace */ - machine?: string; + machine?: string /** @description Working directory for this codespace */ - working_directory?: string; + working_directory?: string /** @description Time in minutes before codespace stops from inactivity */ - idle_timeout_minutes?: number; + idle_timeout_minutes?: number } | { /** @description Pull request number for this codespace */ pull_request: { /** @description Pull request number */ - pull_request_number: number; + pull_request_number: number /** @description Repository id for this codespace */ - repository_id: number; - }; + repository_id: number + } /** @description Location for this codespace */ - location: string; + location: string /** @description Machine type to use for this codespace */ - machine?: string; + machine?: string /** @description Working directory for this codespace */ - working_directory?: string; + working_directory?: string /** @description Time in minutes before codespace stops from inactivity */ - idle_timeout_minutes?: number; - }; - }; - }; - }; + idle_timeout_minutes?: number + } + } + } + } /** * Lists all secrets available for a user's Codespaces without revealing their * encrypted values. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - "codespaces/list-secrets-for-authenticated-user": { + 'codespaces/list-secrets-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - secrets: components["schemas"]["codespaces-secret"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + secrets: components['schemas']['codespaces-secret'][] + } + } + } + } + } /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with one of the 'read:user' or 'user' scopes in their personal access token. User must have Codespaces access to use this endpoint. */ - "codespaces/get-public-key-for-authenticated-user": { + 'codespaces/get-public-key-for-authenticated-user': { responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["codespaces-user-public-key"]; - }; - }; - }; - }; + 'application/json': components['schemas']['codespaces-user-public-key'] + } + } + } + } /** * Gets a secret available to a user's codespaces without revealing its encrypted value. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - "codespaces/get-secret-for-authenticated-user": { + 'codespaces/get-secret-for-authenticated-user': { parameters: { path: { /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["codespaces-secret"]; - }; - }; - }; - }; + 'application/json': components['schemas']['codespaces-secret'] + } + } + } + } /** * Creates or updates a secret for a user's codespace with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access token with the `user` scope to use this endpoint. User must also have Codespaces access to use this endpoint. @@ -39809,195 +39774,195 @@ export interface operations { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - "codespaces/create-or-update-secret-for-authenticated-user": { + 'codespaces/create-or-update-secret-for-authenticated-user': { parameters: { path: { /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response after successfully creaing a secret */ 201: { content: { - "application/json": { [key: string]: unknown }; - }; - }; + 'application/json': { [key: string]: unknown } + } + } /** Response after successfully updating a secret */ - 204: never; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 204: never + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for the authenticated user](https://docs.github.com/rest/reference/codespaces#get-the-public-key-for-the-authenticated-user) endpoint. */ - encrypted_value: string; + encrypted_value: string /** @description ID of the key you used to encrypt the secret. */ - key_id: string; + key_id: string /** @description An array of repository ids that can access the user secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/reference/codespaces#list-selected-repositories-for-a-user-secret), [Set selected repositories for a user secret](https://docs.github.com/rest/reference/codespaces#set-selected-repositories-for-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/reference/codespaces#remove-a-selected-repository-from-a-user-secret) endpoints. */ - selected_repository_ids?: string[]; - }; - }; - }; - }; + selected_repository_ids?: string[] + } + } + } + } /** Deletes a secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret. You must authenticate using an access token with the `user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - "codespaces/delete-secret-for-authenticated-user": { + 'codespaces/delete-secret-for-authenticated-user': { parameters: { path: { /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * List the repositories that have been granted the ability to use a user's codespace secret. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - "codespaces/list-repositories-for-secret-for-authenticated-user": { + 'codespaces/list-repositories-for-secret-for-authenticated-user': { parameters: { path: { /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - repositories: components["schemas"]["minimal-repository"][]; - }; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': { + total_count: number + repositories: components['schemas']['minimal-repository'][] + } + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** * Select the repositories that will use a user's codespace secret. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - "codespaces/set-repositories-for-secret-for-authenticated-user": { + 'codespaces/set-repositories-for-secret-for-authenticated-user': { parameters: { path: { /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** No Content when repositories were added to the selected list */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description An array of repository ids for which a codespace can access the secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/reference/codespaces#list-selected-repositories-for-a-user-secret), [Add a selected repository to a user secret](https://docs.github.com/rest/reference/codespaces#add-a-selected-repository-to-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/reference/codespaces#remove-a-selected-repository-from-a-user-secret) endpoints. */ - selected_repository_ids: number[]; - }; - }; - }; - }; + selected_repository_ids: number[] + } + } + } + } /** * Adds a repository to the selected repositories for a user's codespace secret. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - "codespaces/add-repository-for-secret-for-authenticated-user": { + 'codespaces/add-repository-for-secret-for-authenticated-user': { parameters: { path: { /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - repository_id: number; - }; - }; + secret_name: components['parameters']['secret-name'] + repository_id: number + } + } responses: { /** No Content when repository was added to the selected list */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** * Removes a repository from the selected repositories for a user's codespace secret. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - "codespaces/remove-repository-for-secret-for-authenticated-user": { + 'codespaces/remove-repository-for-secret-for-authenticated-user': { parameters: { path: { /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - repository_id: number; - }; - }; + secret_name: components['parameters']['secret-name'] + repository_id: number + } + } responses: { /** No Content when repository was removed from the selected list */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** * Gets information about a user's codespace. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/get-for-authenticated-user": { + 'codespaces/get-for-authenticated-user': { parameters: { path: { /** The name of the codespace. */ - codespace_name: components["parameters"]["codespace-name"]; - }; - }; + codespace_name: components['parameters']['codespace-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["codespace"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': components['schemas']['codespace'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** * Deletes a user's codespace. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/delete-for-authenticated-user": { + 'codespaces/delete-for-authenticated-user': { parameters: { path: { /** The name of the codespace. */ - codespace_name: components["parameters"]["codespace-name"]; - }; - }; - responses: { - 202: components["responses"]["accepted"]; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + codespace_name: components['parameters']['codespace-name'] + } + } + responses: { + 202: components['responses']['accepted'] + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** * Updates a codespace owned by the authenticated user. Currently only the codespace's machine type and recent folders can be modified using this endpoint. * @@ -40005,470 +39970,470 @@ export interface operations { * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/update-for-authenticated-user": { + 'codespaces/update-for-authenticated-user': { parameters: { path: { /** The name of the codespace. */ - codespace_name: components["parameters"]["codespace-name"]; - }; - }; + codespace_name: components['parameters']['codespace-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["codespace"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; + 'application/json': components['schemas']['codespace'] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description A valid machine to transition this codespace to. */ - machine?: string; + machine?: string /** @description Recently opened folders inside the codespace. It is currently used by the clients to determine the folder path to load the codespace in. */ - recent_folders?: string[]; - }; - }; - }; - }; + recent_folders?: string[] + } + } + } + } /** * Triggers an export of the specified codespace and returns a URL and ID where the status of the export can be monitored. * * You must authenticate using a personal access token with the `codespace` scope to use this endpoint. */ - "codespaces/export-for-authenticated-user": { + 'codespaces/export-for-authenticated-user': { parameters: { path: { /** The name of the codespace. */ - codespace_name: components["parameters"]["codespace-name"]; - }; - }; + codespace_name: components['parameters']['codespace-name'] + } + } responses: { /** Response */ 202: { content: { - "application/json": components["schemas"]["codespace-export-details"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': components['schemas']['codespace-export-details'] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + 500: components['responses']['internal_error'] + } + } /** * Gets information about an export of a codespace. * * You must authenticate using a personal access token with the `codespace` scope to use this endpoint. */ - "codespaces/get-export-details-for-authenticated-user": { + 'codespaces/get-export-details-for-authenticated-user': { parameters: { path: { /** The name of the codespace. */ - codespace_name: components["parameters"]["codespace-name"]; + codespace_name: components['parameters']['codespace-name'] /** The ID of the export operation, or `latest`. Currently only `latest` is currently supported. */ - export_id: components["parameters"]["export-id"]; - }; - }; + export_id: components['parameters']['export-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["codespace-export-details"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['codespace-export-details'] + } + } + 404: components['responses']['not_found'] + } + } /** * List the machine types a codespace can transition to use. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/codespace-machines-for-authenticated-user": { + 'codespaces/codespace-machines-for-authenticated-user': { parameters: { path: { /** The name of the codespace. */ - codespace_name: components["parameters"]["codespace-name"]; - }; - }; + codespace_name: components['parameters']['codespace-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - machines: components["schemas"]["codespace-machine"][]; - }; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': { + total_count: number + machines: components['schemas']['codespace-machine'][] + } + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** * Starts a user's codespace. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/start-for-authenticated-user": { + 'codespaces/start-for-authenticated-user': { parameters: { path: { /** The name of the codespace. */ - codespace_name: components["parameters"]["codespace-name"]; - }; - }; + codespace_name: components['parameters']['codespace-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["codespace"]; - }; - }; - 304: components["responses"]["not_modified"]; - 400: components["responses"]["bad_request"]; - 401: components["responses"]["requires_authentication"]; + 'application/json': components['schemas']['codespace'] + } + } + 304: components['responses']['not_modified'] + 400: components['responses']['bad_request'] + 401: components['responses']['requires_authentication'] /** Payment required */ 402: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 409: components['responses']['conflict'] + 500: components['responses']['internal_error'] + } + } /** * Stops a user's codespace. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/stop-for-authenticated-user": { + 'codespaces/stop-for-authenticated-user': { parameters: { path: { /** The name of the codespace. */ - codespace_name: components["parameters"]["codespace-name"]; - }; - }; + codespace_name: components['parameters']['codespace-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["codespace"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': components['schemas']['codespace'] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** Sets the visibility for your primary email addresses. */ - "users/set-primary-email-visibility-for-authenticated-user": { - parameters: {}; + 'users/set-primary-email-visibility-for-authenticated-user': { + parameters: {} responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["email"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['email'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description Denotes whether an email is publicly visible. * @enum {string} */ - visibility: "public" | "private"; - }; - }; - }; - }; + visibility: 'public' | 'private' + } + } + } + } /** Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope. */ - "users/list-emails-for-authenticated-user": { + 'users/list-emails-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["email"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['email'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** This endpoint is accessible with the `user` scope. */ - "users/add-email-for-authenticated-user": { - parameters: {}; + 'users/add-email-for-authenticated-user': { + parameters: {} responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["email"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['email'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** * @description Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key. * @example */ - emails: string[]; + emails: string[] } | string[] - | string; - }; - }; - }; + | string + } + } + } /** This endpoint is accessible with the `user` scope. */ - "users/delete-email-for-authenticated-user": { - parameters: {}; + 'users/delete-email-for-authenticated-user': { + parameters: {} responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description Email addresses associated with the GitHub user account. */ - emails: string[]; + emails: string[] } | string[] - | string; - }; - }; - }; + | string + } + } + } /** Lists the people following the authenticated user. */ - "users/list-followers-for-authenticated-user": { + 'users/list-followers-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** Lists the people who the authenticated user follows. */ - "users/list-followed-by-authenticated-user": { + 'users/list-followed-by-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; - "users/check-person-is-followed-by-authenticated": { + 'application/json': components['schemas']['simple-user'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } + 'users/check-person-is-followed-by-authenticated': { parameters: { path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** if the person is followed by the authenticated user */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] /** if the person is not followed by the authenticated user */ 404: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } + } + } /** * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." * * Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. */ - "users/follow": { + 'users/follow': { parameters: { path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. */ - "users/unfollow": { + 'users/unfollow': { parameters: { path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "users/list-gpg-keys-for-authenticated-user": { + 'users/list-gpg-keys-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["gpg-key"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['gpg-key'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "users/create-gpg-key-for-authenticated-user": { - parameters: {}; + 'users/create-gpg-key-for-authenticated-user': { + parameters: {} responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["gpg-key"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['gpg-key'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description A GPG key in ASCII-armored format. */ - armored_public_key: string; - }; - }; - }; - }; + armored_public_key: string + } + } + } + } /** View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "users/get-gpg-key-for-authenticated-user": { + 'users/get-gpg-key-for-authenticated-user': { parameters: { path: { /** gpg_key_id parameter */ - gpg_key_id: components["parameters"]["gpg-key-id"]; - }; - }; + gpg_key_id: components['parameters']['gpg-key-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["gpg-key"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['gpg-key'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "users/delete-gpg-key-for-authenticated-user": { + 'users/delete-gpg-key-for-authenticated-user': { parameters: { path: { /** gpg_key_id parameter */ - gpg_key_id: components["parameters"]["gpg-key-id"]; - }; - }; + gpg_key_id: components['parameters']['gpg-key-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** * Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. * @@ -40478,32 +40443,32 @@ export interface operations { * * You can find the permissions for the installation under the `permissions` key. */ - "apps/list-installations-for-authenticated-user": { + 'apps/list-installations-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** You can find the permissions for the installation under the `permissions` key. */ 200: { - headers: {}; - content: { - "application/json": { - total_count: number; - installations: components["schemas"]["installation"][]; - }; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 415: components["responses"]["preview_header_missing"]; - }; - }; + headers: {} + content: { + 'application/json': { + total_count: number + installations: components['schemas']['installation'][] + } + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 415: components['responses']['preview_header_missing'] + } + } /** * List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation. * @@ -40513,116 +40478,115 @@ export interface operations { * * The access the user has to each repository is included in the hash under the `permissions` key. */ - "apps/list-installation-repos-for-authenticated-user": { + 'apps/list-installation-repos-for-authenticated-user': { parameters: { path: { /** installation_id parameter */ - installation_id: components["parameters"]["installation-id"]; - }; + installation_id: components['parameters']['installation-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** The access the user has to each repository is included in the hash under the `permissions` key. */ 200: { - headers: {}; - content: { - "application/json": { - total_count: number; - repository_selection?: string; - repositories: components["schemas"]["repository"][]; - }; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + headers: {} + content: { + 'application/json': { + total_count: number + repository_selection?: string + repositories: components['schemas']['repository'][] + } + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Add a single repository to an installation. The authenticated user must have admin access to the repository. * * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. */ - "apps/add-repo-to-installation-for-authenticated-user": { + 'apps/add-repo-to-installation-for-authenticated-user': { parameters: { path: { /** installation_id parameter */ - installation_id: components["parameters"]["installation-id"]; - repository_id: components["parameters"]["repository-id"]; - }; - }; + installation_id: components['parameters']['installation-id'] + repository_id: components['parameters']['repository-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Remove a single repository from an installation. The authenticated user must have admin access to the repository. * * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. */ - "apps/remove-repo-from-installation-for-authenticated-user": { + 'apps/remove-repo-from-installation-for-authenticated-user': { parameters: { path: { /** installation_id parameter */ - installation_id: components["parameters"]["installation-id"]; - repository_id: components["parameters"]["repository-id"]; - }; - }; - responses: { - /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + installation_id: components['parameters']['installation-id'] + repository_id: components['parameters']['repository-id'] + } + } + responses: { + /** Response */ + 204: never + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Shows which type of GitHub user can interact with your public repositories and when the restriction expires. */ - "interactions/get-restrictions-for-authenticated-user": { + 'interactions/get-restrictions-for-authenticated-user': { responses: { /** Default response */ 200: { content: { - "application/json": Partial & - Partial<{ [key: string]: unknown }>; - }; - }; + 'application/json': Partial & Partial<{ [key: string]: unknown }> + } + } /** Response when there are no restrictions */ - 204: never; - }; - }; + 204: never + } + } /** Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user. */ - "interactions/set-restrictions-for-authenticated-user": { + 'interactions/set-restrictions-for-authenticated-user': { responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["interaction-limit-response"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['interaction-limit-response'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": components["schemas"]["interaction-limit"]; - }; - }; - }; + 'application/json': components['schemas']['interaction-limit'] + } + } + } /** Removes any interaction restrictions from your public repositories. */ - "interactions/remove-restrictions-for-authenticated-user": { + 'interactions/remove-restrictions-for-authenticated-user': { responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * List issues across owned and member repositories assigned to the authenticated user. * @@ -40631,7 +40595,7 @@ export interface operations { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - "issues/list-for-authenticated-user": { + 'issues/list-for-authenticated-user': { parameters: { query: { /** @@ -40642,314 +40606,314 @@ export interface operations { * \* `subscribed`: Issues you're subscribed to updates for * \* `all` or `repos`: All issues the authenticated user can see, regardless of participation or creation */ - filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all"; + filter?: 'assigned' | 'created' | 'mentioned' | 'subscribed' | 'repos' | 'all' /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ - state?: "open" | "closed" | "all"; + state?: 'open' | 'closed' | 'all' /** A list of comma separated label names. Example: `bug,ui,@high` */ - labels?: components["parameters"]["labels"]; + labels?: components['parameters']['labels'] /** What to sort results by. Can be either `created`, `updated`, `comments`. */ - sort?: "created" | "updated" | "comments"; + sort?: 'created' | 'updated' | 'comments' /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["issue"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['issue'][] + } + } + 304: components['responses']['not_modified'] + 404: components['responses']['not_found'] + } + } /** Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "users/list-public-ssh-keys-for-authenticated-user": { + 'users/list-public-ssh-keys-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["key"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['key'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "users/create-public-ssh-key-for-authenticated-user": { - parameters: {}; + 'users/create-public-ssh-key-for-authenticated-user': { + parameters: {} responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["key"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['key'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description A descriptive name for the new key. * @example Personal MacBook Air */ - title?: string; + title?: string /** @description The public SSH key to add to your GitHub account. */ - key: string; - }; - }; - }; - }; + key: string + } + } + } + } /** View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "users/get-public-ssh-key-for-authenticated-user": { + 'users/get-public-ssh-key-for-authenticated-user': { parameters: { path: { /** key_id parameter */ - key_id: components["parameters"]["key-id"]; - }; - }; + key_id: components['parameters']['key-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["key"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['key'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "users/delete-public-ssh-key-for-authenticated-user": { + 'users/delete-public-ssh-key-for-authenticated-user': { parameters: { path: { /** key_id parameter */ - key_id: components["parameters"]["key-id"]; - }; - }; - responses: { - /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + key_id: components['parameters']['key-id'] + } + } + responses: { + /** Response */ + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Lists the active subscriptions for the authenticated user. You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an [OAuth token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/). */ - "apps/list-subscriptions-for-authenticated-user": { + 'apps/list-subscriptions-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["user-marketplace-purchase"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['user-marketplace-purchase'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 404: components['responses']['not_found'] + } + } /** Lists the active subscriptions for the authenticated user. You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an [OAuth token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/). */ - "apps/list-subscriptions-for-authenticated-user-stubbed": { + 'apps/list-subscriptions-for-authenticated-user-stubbed': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["user-marketplace-purchase"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - }; - }; - "orgs/list-memberships-for-authenticated-user": { + 'application/json': components['schemas']['user-marketplace-purchase'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + } + } + 'orgs/list-memberships-for-authenticated-user': { parameters: { query: { /** Indicates the state of the memberships to return. Can be either `active` or `pending`. If not specified, the API returns both active and pending memberships. */ - state?: "active" | "pending"; + state?: 'active' | 'pending' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["org-membership"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "orgs/get-membership-for-authenticated-user": { + 'application/json': components['schemas']['org-membership'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } + } + 'orgs/get-membership-for-authenticated-user': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["org-membership"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "orgs/update-membership-for-authenticated-user": { + 'application/json': components['schemas']['org-membership'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'orgs/update-membership-for-authenticated-user': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["org-membership"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['org-membership'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The state that the membership should be in. Only `"active"` will be accepted. * @enum {string} */ - state: "active"; - }; - }; - }; - }; + state: 'active' + } + } + } + } /** Lists all migrations a user has started. */ - "migrations/list-for-authenticated-user": { + 'migrations/list-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["migration"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['migration'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** Initiates the generation of a user migration archive. */ - "migrations/start-for-authenticated-user": { - parameters: {}; + 'migrations/start-for-authenticated-user': { + parameters: {} responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["migration"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['migration'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description Lock the repositories being migrated at the start of the migration * @example true */ - lock_repositories?: boolean; + lock_repositories?: boolean /** * @description Do not include attachments in the migration * @example true */ - exclude_attachments?: boolean; + exclude_attachments?: boolean /** * @description Do not include releases in the migration * @example true */ - exclude_releases?: boolean; + exclude_releases?: boolean /** * @description Indicates whether projects owned by the organization or users should be excluded. * @example true */ - exclude_owner_projects?: boolean; + exclude_owner_projects?: boolean /** * @description Exclude attributes from the API response to improve performance * @example repositories */ - exclude?: "repositories"[]; - repositories: string[]; - }; - }; - }; - }; + exclude?: 'repositories'[] + repositories: string[] + } + } + } + } /** * Fetches a single user migration. The response includes the `state` of the migration, which can be one of the following values: * @@ -40960,29 +40924,29 @@ export interface operations { * * Once the migration has been `exported` you can [download the migration archive](https://docs.github.com/rest/reference/migrations#download-a-user-migration-archive). */ - "migrations/get-status-for-authenticated-user": { + 'migrations/get-status-for-authenticated-user': { parameters: { path: { /** migration_id parameter */ - migration_id: components["parameters"]["migration-id"]; - }; + migration_id: components['parameters']['migration-id'] + } query: { - exclude?: string[]; - }; - }; + exclude?: string[] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["migration"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['migration'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Fetches the URL to download the migration archive as a `tar.gz` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects: * @@ -41006,82 +40970,82 @@ export interface operations { * * The archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data. */ - "migrations/get-archive-for-authenticated-user": { + 'migrations/get-archive-for-authenticated-user': { parameters: { path: { /** migration_id parameter */ - migration_id: components["parameters"]["migration-id"]; - }; - }; + migration_id: components['parameters']['migration-id'] + } + } responses: { /** Response */ - 302: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 302: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the [List user migrations](https://docs.github.com/rest/reference/migrations#list-user-migrations) and [Get a user migration status](https://docs.github.com/rest/reference/migrations#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted. */ - "migrations/delete-archive-for-authenticated-user": { + 'migrations/delete-archive-for-authenticated-user': { parameters: { path: { /** migration_id parameter */ - migration_id: components["parameters"]["migration-id"]; - }; - }; - responses: { - /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + migration_id: components['parameters']['migration-id'] + } + } + responses: { + /** Response */ + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Unlocks a repository. You can lock repositories when you [start a user migration](https://docs.github.com/rest/reference/migrations#start-a-user-migration). Once the migration is complete you can unlock each repository to begin using it again or [delete the repository](https://docs.github.com/rest/reference/repos#delete-a-repository) if you no longer need the source data. Returns a status of `404 Not Found` if the repository is not locked. */ - "migrations/unlock-repo-for-authenticated-user": { + 'migrations/unlock-repo-for-authenticated-user': { parameters: { path: { /** migration_id parameter */ - migration_id: components["parameters"]["migration-id"]; + migration_id: components['parameters']['migration-id'] /** repo_name parameter */ - repo_name: components["parameters"]["repo-name"]; - }; - }; - responses: { - /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + repo_name: components['parameters']['repo-name'] + } + } + responses: { + /** Response */ + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Lists all the repositories for this user migration. */ - "migrations/list-repos-for-authenticated-user": { + 'migrations/list-repos-for-authenticated-user': { parameters: { path: { /** migration_id parameter */ - migration_id: components["parameters"]["migration-id"]; - }; + migration_id: components['parameters']['migration-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["minimal-repository"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['minimal-repository'][] + } + } + 404: components['responses']['not_found'] + } + } /** * List organizations for the authenticated user. * @@ -41089,99 +41053,99 @@ export interface operations { * * This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response. */ - "orgs/list-for-authenticated-user": { + 'orgs/list-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["organization-simple"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['organization-simple'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** * Lists packages owned by the authenticated user within the user's namespace. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/list-packages-for-authenticated-user": { + 'packages/list-packages-for-authenticated-user': { parameters: { query: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + package_type: 'npm' | 'maven' | 'rubygems' | 'docker' | 'nuget' | 'container' /** The selected visibility of the packages. Can be one of `public`, `private`, or `internal`. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set. */ - visibility?: components["parameters"]["package-visibility"]; - }; - }; + visibility?: components['parameters']['package-visibility'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['package'][] + } + } + } + } /** * Gets a specific package for a package owned by the authenticated user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/get-package-for-authenticated-user": { + 'packages/get-package-for-authenticated-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - }; - }; + package_name: components['parameters']['package-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package"]; - }; - }; - }; - }; + 'application/json': components['schemas']['package'] + } + } + } + } /** * Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:delete` scopes. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/delete-package-for-authenticated-user": { + 'packages/delete-package-for-authenticated-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - }; - }; + package_name: components['parameters']['package-name'] + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Restores a package owned by the authenticated user. * @@ -41191,113 +41155,113 @@ export interface operations { * * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/restore-package-for-authenticated-user": { + 'packages/restore-package-for-authenticated-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - }; + package_name: components['parameters']['package-name'] + } query: { /** package token */ - token?: string; - }; - }; + token?: string + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Returns all package versions for a package owned by the authenticated user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/get-all-package-versions-for-package-owned-by-authenticated-user": { + 'packages/get-all-package-versions-for-package-owned-by-authenticated-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - }; + package_name: components['parameters']['package-name'] + } query: { /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** The state of the package, either active or deleted. */ - state?: "active" | "deleted"; - }; - }; + state?: 'active' | 'deleted' + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package-version"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['package-version'][] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Gets a specific package version for a package owned by the authenticated user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/get-package-version-for-authenticated-user": { + 'packages/get-package-version-for-authenticated-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; + package_name: components['parameters']['package-name'] /** Unique identifier of the package version. */ - package_version_id: components["parameters"]["package-version-id"]; - }; - }; + package_version_id: components['parameters']['package-version-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package-version"]; - }; - }; - }; - }; + 'application/json': components['schemas']['package-version'] + } + } + } + } /** * Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:delete` scopes. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/delete-package-version-for-authenticated-user": { + 'packages/delete-package-version-for-authenticated-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; + package_name: components['parameters']['package-name'] /** Unique identifier of the package version. */ - package_version_id: components["parameters"]["package-version-id"]; - }; - }; + package_version_id: components['parameters']['package-version-id'] + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Restores a package version owned by the authenticated user. * @@ -41307,131 +41271,131 @@ export interface operations { * * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/restore-package-version-for-authenticated-user": { + 'packages/restore-package-version-for-authenticated-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; + package_name: components['parameters']['package-name'] /** Unique identifier of the package version. */ - package_version_id: components["parameters"]["package-version-id"]; - }; - }; + package_version_id: components['parameters']['package-version-id'] + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "projects/create-for-authenticated-user": { - parameters: {}; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'projects/create-for-authenticated-user': { + parameters: {} responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["project"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 415: components["responses"]["preview_header_missing"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': components['schemas']['project'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 415: components['responses']['preview_header_missing'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description Name of the project * @example Week One Sprint */ - name: string; + name: string /** * @description Body of the project * @example This project represents the sprint of the first week in January */ - body?: string | null; - }; - }; - }; - }; + body?: string | null + } + } + } + } /** Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope. */ - "users/list-public-emails-for-authenticated-user": { + 'users/list-public-emails-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["email"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['email'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. * * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. */ - "repos/list-for-authenticated-user": { + 'repos/list-for-authenticated-user': { parameters: { query: { /** Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`. */ - visibility?: "all" | "public" | "private"; + visibility?: 'all' | 'public' | 'private' /** * Comma-separated list of values. Can include: * \* `owner`: Repositories that are owned by the authenticated user. * \* `collaborator`: Repositories that the user has been added to as a collaborator. * \* `organization_member`: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on. */ - affiliation?: string; + affiliation?: string /** * Can be one of `all`, `owner`, `public`, `private`, `member`. Note: For GitHub AE, can be one of `all`, `owner`, `internal`, `private`, `member`. Default: `all` * * Will cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**. */ - type?: "all" | "owner" | "public" | "private" | "member"; + type?: 'all' | 'owner' | 'public' | 'private' | 'member' /** Can be one of `created`, `updated`, `pushed`, `full_name`. */ - sort?: "created" | "updated" | "pushed" | "full_name"; + sort?: 'created' | 'updated' | 'pushed' | 'full_name' /** Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc` */ - direction?: "asc" | "desc"; + direction?: 'asc' | 'desc' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - before?: components["parameters"]["before"]; - }; - }; + before?: components['parameters']['before'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["repository"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['repository'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } + } /** * Creates a new repository for the authenticated user. * @@ -41442,323 +41406,323 @@ export interface operations { * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. * * `repo` scope to create a private repository. */ - "repos/create-for-authenticated-user": { - parameters: {}; + 'repos/create-for-authenticated-user': { + parameters: {} responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["repository"]; - }; - }; - 304: components["responses"]["not_modified"]; - 400: components["responses"]["bad_request"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['repository'] + } + } + 304: components['responses']['not_modified'] + 400: components['responses']['bad_request'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The name of the repository. * @example Team Environment */ - name: string; + name: string /** @description A short description of the repository. */ - description?: string; + description?: string /** @description A URL with more information about the repository. */ - homepage?: string; + homepage?: string /** @description Whether the repository is private. */ - private?: boolean; + private?: boolean /** * @description Whether issues are enabled. * @default true * @example true */ - has_issues?: boolean; + has_issues?: boolean /** * @description Whether projects are enabled. * @default true * @example true */ - has_projects?: boolean; + has_projects?: boolean /** * @description Whether the wiki is enabled. * @default true * @example true */ - has_wiki?: boolean; + has_wiki?: boolean /** @description The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. */ - team_id?: number; + team_id?: number /** @description Whether the repository is initialized with a minimal README. */ - auto_init?: boolean; + auto_init?: boolean /** * @description The desired language or platform to apply to the .gitignore. * @example Haskell */ - gitignore_template?: string; + gitignore_template?: string /** * @description The license keyword of the open source license for this repository. * @example mit */ - license_template?: string; + license_template?: string /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - allow_squash_merge?: boolean; + allow_squash_merge?: boolean /** * @description Whether to allow merge commits for pull requests. * @default true * @example true */ - allow_merge_commit?: boolean; + allow_merge_commit?: boolean /** * @description Whether to allow rebase merges for pull requests. * @default true * @example true */ - allow_rebase_merge?: boolean; + allow_rebase_merge?: boolean /** @description Whether to allow Auto-merge to be used on pull requests. */ - allow_auto_merge?: boolean; + allow_auto_merge?: boolean /** @description Whether to delete head branches when pull requests are merged */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge?: boolean /** * @description Whether downloads are enabled. * @default true * @example true */ - has_downloads?: boolean; + has_downloads?: boolean /** * @description Whether this repository acts as a template that can be used to generate new repositories. * @example true */ - is_template?: boolean; - }; - }; - }; - }; + is_template?: boolean + } + } + } + } /** When authenticating as a user, this endpoint will list all currently open repository invitations for that user. */ - "repos/list-invitations-for-authenticated-user": { + 'repos/list-invitations-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["repository-invitation"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "repos/decline-invitation-for-authenticated-user": { + 'application/json': components['schemas']['repository-invitation'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'repos/decline-invitation-for-authenticated-user': { parameters: { path: { /** invitation_id parameter */ - invitation_id: components["parameters"]["invitation-id"]; - }; - }; + invitation_id: components['parameters']['invitation-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; - }; - }; - "repos/accept-invitation-for-authenticated-user": { + 204: never + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 409: components['responses']['conflict'] + } + } + 'repos/accept-invitation-for-authenticated-user': { parameters: { path: { /** invitation_id parameter */ - invitation_id: components["parameters"]["invitation-id"]; - }; - }; + invitation_id: components['parameters']['invitation-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 409: components['responses']['conflict'] + } + } /** * Lists repositories the authenticated user has starred. * * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: */ - "activity/list-repos-starred-by-authenticated-user": { + 'activity/list-repos-starred-by-authenticated-user': { parameters: { query: { /** One of `created` (when the repository was starred) or `updated` (when it was last pushed to). */ - sort?: components["parameters"]["sort"]; + sort?: components['parameters']['sort'] /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["repository"][]; - "application/vnd.github.v3.star+json": components["schemas"]["starred-repository"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; - "activity/check-repo-is-starred-by-authenticated-user": { + 'application/json': components['schemas']['repository'][] + 'application/vnd.github.v3.star+json': components['schemas']['starred-repository'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } + 'activity/check-repo-is-starred-by-authenticated-user': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response if this repository is starred by you */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] /** Not Found if this repository is not starred by you */ 404: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } + } + } /** Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - "activity/star-repo-for-authenticated-user": { + 'activity/star-repo-for-authenticated-user': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "activity/unstar-repo-for-authenticated-user": { + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'activity/unstar-repo-for-authenticated-user': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Lists repositories the authenticated user is watching. */ - "activity/list-watched-repos-for-authenticated-user": { + 'activity/list-watched-repos-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["minimal-repository"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['minimal-repository'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** List all of the teams across all of the organizations to which the authenticated user belongs. This method requires `user`, `repo`, or `read:org` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://docs.github.com/apps/building-oauth-apps/). */ - "teams/list-for-authenticated-user": { + 'teams/list-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team-full"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['team-full'][] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts. * * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of users. */ - "users/list": { + 'users/list': { parameters: { query: { /** A user ID. Only return users with an ID greater than this ID. */ - since?: components["parameters"]["since-user"]; + since?: components['parameters']['since-user'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { headers: { - Link?: string; - }; + Link?: string + } content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 304: components["responses"]["not_modified"]; - }; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + 304: components['responses']['not_modified'] + } + } /** * Provides publicly available information about someone with a GitHub account. * @@ -41768,197 +41732,197 @@ export interface operations { * * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/reference/users#emails)". */ - "users/get-by-username": { + 'users/get-by-username': { parameters: { path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["private-user"] | components["schemas"]["public-user"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['private-user'] | components['schemas']['public-user'] + } + } + 404: components['responses']['not_found'] + } + } /** If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. */ - "activity/list-events-for-authenticated-user": { + 'activity/list-events-for-authenticated-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["event"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['event'][] + } + } + } + } /** This is the user's organization dashboard. You must be authenticated as the user to view this. */ - "activity/list-org-events-for-authenticated-user": { + 'activity/list-org-events-for-authenticated-user': { parameters: { path: { - username: components["parameters"]["username"]; - org: components["parameters"]["org"]; - }; + username: components['parameters']['username'] + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["event"][]; - }; - }; - }; - }; - "activity/list-public-events-for-user": { + 'application/json': components['schemas']['event'][] + } + } + } + } + 'activity/list-public-events-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["event"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['event'][] + } + } + } + } /** Lists the people following the specified user. */ - "users/list-followers-for-user": { + 'users/list-followers-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + } + } /** Lists the people who the specified user follows. */ - "users/list-following-for-user": { + 'users/list-following-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - }; - }; - "users/check-following-for-user": { + 'application/json': components['schemas']['simple-user'][] + } + } + } + } + 'users/check-following-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - target_user: string; - }; - }; + username: components['parameters']['username'] + target_user: string + } + } responses: { /** if the user follows the target user */ - 204: never; + 204: never /** if the user does not follow the target user */ - 404: unknown; - }; - }; + 404: unknown + } + } /** Lists public gists for the specified user: */ - "gists/list-for-user": { + 'gists/list-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["base-gist"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['base-gist'][] + } + } + 422: components['responses']['validation_failed'] + } + } /** Lists the GPG keys for a user. This information is accessible by anyone. */ - "users/list-gpg-keys-for-user": { + 'users/list-gpg-keys-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["gpg-key"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['gpg-key'][] + } + } + } + } /** * Provides hovercard information when authenticated through basic auth or OAuth with the `repo` scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. * @@ -41969,153 +41933,153 @@ export interface operations { * https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 * ``` */ - "users/get-context-for-user": { + 'users/get-context-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, `pull_request`. **Required** when using `subject_id`. */ - subject_type?: "organization" | "repository" | "issue" | "pull_request"; + subject_type?: 'organization' | 'repository' | 'issue' | 'pull_request' /** Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`. */ - subject_id?: string; - }; - }; + subject_id?: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["hovercard"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['hovercard'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** * Enables an authenticated GitHub App to find the user’s installation information. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/get-user-installation": { + 'apps/get-user-installation': { parameters: { path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["installation"]; - }; - }; - }; - }; + 'application/json': components['schemas']['installation'] + } + } + } + } /** Lists the _verified_ public SSH keys for a user. This is accessible by anyone. */ - "users/list-public-keys-for-user": { + 'users/list-public-keys-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["key-simple"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['key-simple'][] + } + } + } + } /** * List [public organization memberships](https://docs.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user. * * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/rest/reference/orgs#list-organizations-for-the-authenticated-user) API instead. */ - "orgs/list-for-user": { + 'orgs/list-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["organization-simple"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['organization-simple'][] + } + } + } + } /** * Lists all packages in a user's namespace for which the requesting user has access. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/list-packages-for-user": { + 'packages/list-packages-for-user': { parameters: { query: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + package_type: 'npm' | 'maven' | 'rubygems' | 'docker' | 'nuget' | 'container' /** The selected visibility of the packages. Can be one of `public`, `private`, or `internal`. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set. */ - visibility?: components["parameters"]["package-visibility"]; - }; + visibility?: components['parameters']['package-visibility'] + } path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['package'][] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** * Gets a specific package metadata for a public package owned by a user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/get-package-for-user": { + 'packages/get-package-for-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - username: components["parameters"]["username"]; - }; - }; + package_name: components['parameters']['package-name'] + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package"]; - }; - }; - }; - }; + 'application/json': components['schemas']['package'] + } + } + } + } /** * Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * @@ -42123,24 +42087,24 @@ export interface operations { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. */ - "packages/delete-package-for-user": { + 'packages/delete-package-for-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - username: components["parameters"]["username"]; - }; - }; + package_name: components['parameters']['package-name'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Restores an entire package for a user. * @@ -42152,83 +42116,83 @@ export interface operations { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. */ - "packages/restore-package-for-user": { + 'packages/restore-package-for-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - username: components["parameters"]["username"]; - }; + package_name: components['parameters']['package-name'] + username: components['parameters']['username'] + } query: { /** package token */ - token?: string; - }; - }; + token?: string + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Returns all package versions for a public package owned by a specified user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/get-all-package-versions-for-package-owned-by-user": { + 'packages/get-all-package-versions-for-package-owned-by-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - username: components["parameters"]["username"]; - }; - }; + package_name: components['parameters']['package-name'] + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package-version"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['package-version'][] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Gets a specific package version for a public package owned by a specified user. * * At this time, to use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/get-package-version-for-user": { + 'packages/get-package-version-for-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; + package_name: components['parameters']['package-name'] /** Unique identifier of the package version. */ - package_version_id: components["parameters"]["package-version-id"]; - username: components["parameters"]["username"]; - }; - }; + package_version_id: components['parameters']['package-version-id'] + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package-version"]; - }; - }; - }; - }; + 'application/json': components['schemas']['package-version'] + } + } + } + } /** * Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * @@ -42236,26 +42200,26 @@ export interface operations { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. */ - "packages/delete-package-version-for-user": { + 'packages/delete-package-version-for-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - username: components["parameters"]["username"]; + package_name: components['parameters']['package-name'] + username: components['parameters']['username'] /** Unique identifier of the package version. */ - package_version_id: components["parameters"]["package-version-id"]; - }; - }; + package_version_id: components['parameters']['package-version-id'] + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Restores a specific package version for a user. * @@ -42267,123 +42231,123 @@ export interface operations { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. */ - "packages/restore-package-version-for-user": { + 'packages/restore-package-version-for-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - username: components["parameters"]["username"]; + package_name: components['parameters']['package-name'] + username: components['parameters']['username'] /** Unique identifier of the package version. */ - package_version_id: components["parameters"]["package-version-id"]; - }; - }; + package_version_id: components['parameters']['package-version-id'] + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "projects/list-for-user": { + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'projects/list-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. */ - state?: "open" | "closed" | "all"; + state?: 'open' | 'closed' | 'all' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["project"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['project'][] + } + } + 422: components['responses']['validation_failed'] + } + } /** These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. */ - "activity/list-received-events-for-user": { + 'activity/list-received-events-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["event"][]; - }; - }; - }; - }; - "activity/list-received-public-events-for-user": { + 'application/json': components['schemas']['event'][] + } + } + } + } + 'activity/list-received-public-events-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["event"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['event'][] + } + } + } + } /** Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user. */ - "repos/list-for-user": { + 'repos/list-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Can be one of `all`, `owner`, `member`. */ - type?: "all" | "owner" | "member"; + type?: 'all' | 'owner' | 'member' /** Can be one of `created`, `updated`, `pushed`, `full_name`. */ - sort?: "created" | "updated" | "pushed" | "full_name"; + sort?: 'created' | 'updated' | 'pushed' | 'full_name' /** Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc` */ - direction?: "asc" | "desc"; + direction?: 'asc' | 'desc' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["minimal-repository"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['minimal-repository'][] + } + } + } + } /** * Gets the summary of the free and paid GitHub Actions minutes used. * @@ -42391,21 +42355,21 @@ export interface operations { * * Access tokens must have the `user` scope. */ - "billing/get-github-actions-billing-user": { + 'billing/get-github-actions-billing-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-billing-usage"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-billing-usage'] + } + } + } + } /** * Gets the free and paid storage used for GitHub Packages in gigabytes. * @@ -42413,21 +42377,21 @@ export interface operations { * * Access tokens must have the `user` scope. */ - "billing/get-github-packages-billing-user": { + 'billing/get-github-packages-billing-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["packages-billing-usage"]; - }; - }; - }; - }; + 'application/json': components['schemas']['packages-billing-usage'] + } + } + } + } /** * Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. * @@ -42435,87 +42399,86 @@ export interface operations { * * Access tokens must have the `user` scope. */ - "billing/get-shared-storage-billing-user": { + 'billing/get-shared-storage-billing-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["combined-billing-usage"]; - }; - }; - }; - }; + 'application/json': components['schemas']['combined-billing-usage'] + } + } + } + } /** * Lists repositories a user has starred. * * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: */ - "activity/list-repos-starred-by-user": { + 'activity/list-repos-starred-by-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** One of `created` (when the repository was starred) or `updated` (when it was last pushed to). */ - sort?: components["parameters"]["sort"]; + sort?: components['parameters']['sort'] /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": Partial & - Partial; - }; - }; - }; - }; + 'application/json': Partial & Partial + } + } + } + } /** Lists repositories a user is watching. */ - "activity/list-repos-watched-by-user": { + 'activity/list-repos-watched-by-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["minimal-repository"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['minimal-repository'][] + } + } + } + } /** Get a random sentence from the Zen of GitHub */ - "meta/get-zen": { + 'meta/get-zen': { responses: { /** Response */ 200: { content: { - "text/plain": string; - }; - }; - }; - }; + 'text/plain': string + } + } + } + } } export interface external {} diff --git a/test/v3/expected/github.ts b/test/v3/expected/github.ts index 1ac0c19a7..588cd1cf9 100644 --- a/test/v3/expected/github.ts +++ b/test/v3/expected/github.ts @@ -4,152 +4,152 @@ */ export interface paths { - "/": { + '/': { /** Get Hypermedia links to resources accessible in GitHub's REST API */ - get: operations["meta/root"]; - }; - "/app": { + get: operations['meta/root'] + } + '/app': { /** * Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/rest/reference/apps#list-installations-for-the-authenticated-app)" endpoint. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - get: operations["apps/get-authenticated"]; - }; - "/app-manifests/{code}/conversions": { + get: operations['apps/get-authenticated'] + } + '/app-manifests/{code}/conversions': { /** Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. */ - post: operations["apps/create-from-manifest"]; - }; - "/app/hook/config": { + post: operations['apps/create-from-manifest'] + } + '/app/hook/config': { /** * Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - get: operations["apps/get-webhook-config-for-app"]; + get: operations['apps/get-webhook-config-for-app'] /** * Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - patch: operations["apps/update-webhook-config-for-app"]; - }; - "/app/hook/deliveries": { + patch: operations['apps/update-webhook-config-for-app'] + } + '/app/hook/deliveries': { /** * Returns a list of webhook deliveries for the webhook configured for a GitHub App. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - get: operations["apps/list-webhook-deliveries"]; - }; - "/app/hook/deliveries/{delivery_id}": { + get: operations['apps/list-webhook-deliveries'] + } + '/app/hook/deliveries/{delivery_id}': { /** * Returns a delivery for the webhook configured for a GitHub App. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - get: operations["apps/get-webhook-delivery"]; - }; - "/app/hook/deliveries/{delivery_id}/attempts": { + get: operations['apps/get-webhook-delivery'] + } + '/app/hook/deliveries/{delivery_id}/attempts': { /** * Redeliver a delivery for the webhook configured for a GitHub App. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - post: operations["apps/redeliver-webhook-delivery"]; - }; - "/app/installations": { + post: operations['apps/redeliver-webhook-delivery'] + } + '/app/installations': { /** * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. * * The permissions the installation has are included under the `permissions` key. */ - get: operations["apps/list-installations"]; - }; - "/app/installations/{installation_id}": { + get: operations['apps/list-installations'] + } + '/app/installations/{installation_id}': { /** * Enables an authenticated GitHub App to find an installation's information using the installation id. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - get: operations["apps/get-installation"]; + get: operations['apps/get-installation'] /** * Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/reference/apps/#suspend-an-app-installation)" endpoint. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - delete: operations["apps/delete-installation"]; - }; - "/app/installations/{installation_id}/access_tokens": { + delete: operations['apps/delete-installation'] + } + '/app/installations/{installation_id}/access_tokens': { /** * Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - post: operations["apps/create-installation-access-token"]; - }; - "/app/installations/{installation_id}/suspended": { + post: operations['apps/create-installation-access-token'] + } + '/app/installations/{installation_id}/suspended': { /** * Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - put: operations["apps/suspend-installation"]; + put: operations['apps/suspend-installation'] /** * Removes a GitHub App installation suspension. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - delete: operations["apps/unsuspend-installation"]; - }; - "/applications/grants": { + delete: operations['apps/unsuspend-installation'] + } + '/applications/grants': { /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * * You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/rest/reference/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `["repo", "user"]`. */ - get: operations["oauth-authorizations/list-grants"]; - }; - "/applications/grants/{grant_id}": { + get: operations['oauth-authorizations/list-grants'] + } + '/applications/grants/{grant_id}': { /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - get: operations["oauth-authorizations/get-grant"]; + get: operations['oauth-authorizations/get-grant'] /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ - delete: operations["oauth-authorizations/delete-grant"]; - }; - "/applications/{client_id}/grant": { + delete: operations['oauth-authorizations/delete-grant'] + } + '/applications/{client_id}/grant': { /** * OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ - delete: operations["apps/delete-authorization"]; - }; - "/applications/{client_id}/token": { + delete: operations['apps/delete-authorization'] + } + '/applications/{client_id}/token': { /** OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the OAuth application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`. */ - post: operations["apps/check-token"]; + post: operations['apps/check-token'] /** OAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. */ - delete: operations["apps/delete-token"]; + delete: operations['apps/delete-token'] /** OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. */ - patch: operations["apps/reset-token"]; - }; - "/applications/{client_id}/token/scoped": { + patch: operations['apps/reset-token'] + } + '/applications/{client_id}/token/scoped': { /** Use a non-scoped user-to-server OAuth access token to create a repository scoped and/or permission scoped user-to-server OAuth access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. */ - post: operations["apps/scope-token"]; - }; - "/apps/{app_slug}": { + post: operations['apps/scope-token'] + } + '/apps/{app_slug}': { /** * **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). * * If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ - get: operations["apps/get-by-slug"]; - }; - "/authorizations": { + get: operations['apps/get-by-slug'] + } + '/authorizations': { /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - get: operations["oauth-authorizations/list-authorizations"]; + get: operations['oauth-authorizations/list-authorizations'] /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * @@ -163,9 +163,9 @@ export interface paths { * * Organizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in [the GitHub Help documentation](https://docs.github.com/articles/about-identity-and-access-management-with-saml-single-sign-on). */ - post: operations["oauth-authorizations/create-authorization"]; - }; - "/authorizations/clients/{client_id}": { + post: operations['oauth-authorizations/create-authorization'] + } + '/authorizations/clients/{client_id}': { /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * @@ -177,9 +177,9 @@ export interface paths { * * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - put: operations["oauth-authorizations/get-or-create-authorization-for-app"]; - }; - "/authorizations/clients/{client_id}/{fingerprint}": { + put: operations['oauth-authorizations/get-or-create-authorization-for-app'] + } + '/authorizations/clients/{client_id}/{fingerprint}': { /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * @@ -189,13 +189,13 @@ export interface paths { * * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." */ - put: operations["oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint"]; - }; - "/authorizations/{authorization_id}": { + put: operations['oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint'] + } + '/authorizations/{authorization_id}': { /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - get: operations["oauth-authorizations/get-authorization"]; + get: operations['oauth-authorizations/get-authorization'] /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - delete: operations["oauth-authorizations/delete-authorization"]; + delete: operations['oauth-authorizations/delete-authorization'] /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * @@ -203,182 +203,182 @@ export interface paths { * * You can only send one of these scope keys at a time. */ - patch: operations["oauth-authorizations/update-authorization"]; - }; - "/codes_of_conduct": { - get: operations["codes-of-conduct/get-all-codes-of-conduct"]; - }; - "/codes_of_conduct/{key}": { - get: operations["codes-of-conduct/get-conduct-code"]; - }; - "/emojis": { + patch: operations['oauth-authorizations/update-authorization'] + } + '/codes_of_conduct': { + get: operations['codes-of-conduct/get-all-codes-of-conduct'] + } + '/codes_of_conduct/{key}': { + get: operations['codes-of-conduct/get-conduct-code'] + } + '/emojis': { /** Lists all the emojis available to use on GitHub. */ - get: operations["emojis/get"]; - }; - "/enterprises/{enterprise}/actions/permissions": { + get: operations['emojis/get'] + } + '/enterprises/{enterprise}/actions/permissions': { /** * Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - get: operations["enterprise-admin/get-github-actions-permissions-enterprise"]; + get: operations['enterprise-admin/get-github-actions-permissions-enterprise'] /** * Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - put: operations["enterprise-admin/set-github-actions-permissions-enterprise"]; - }; - "/enterprises/{enterprise}/actions/permissions/organizations": { + put: operations['enterprise-admin/set-github-actions-permissions-enterprise'] + } + '/enterprises/{enterprise}/actions/permissions/organizations': { /** * Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - get: operations["enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise"]; + get: operations['enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise'] /** * Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - put: operations["enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise"]; - }; - "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}": { + put: operations['enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise'] + } + '/enterprises/{enterprise}/actions/permissions/organizations/{org_id}': { /** * Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - put: operations["enterprise-admin/enable-selected-organization-github-actions-enterprise"]; + put: operations['enterprise-admin/enable-selected-organization-github-actions-enterprise'] /** * Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - delete: operations["enterprise-admin/disable-selected-organization-github-actions-enterprise"]; - }; - "/enterprises/{enterprise}/actions/permissions/selected-actions": { + delete: operations['enterprise-admin/disable-selected-organization-github-actions-enterprise'] + } + '/enterprises/{enterprise}/actions/permissions/selected-actions': { /** * Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - get: operations["enterprise-admin/get-allowed-actions-enterprise"]; + get: operations['enterprise-admin/get-allowed-actions-enterprise'] /** * Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - put: operations["enterprise-admin/set-allowed-actions-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runner-groups": { + put: operations['enterprise-admin/set-allowed-actions-enterprise'] + } + '/enterprises/{enterprise}/actions/runner-groups': { /** * Lists all self-hosted runner groups for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - get: operations["enterprise-admin/list-self-hosted-runner-groups-for-enterprise"]; + get: operations['enterprise-admin/list-self-hosted-runner-groups-for-enterprise'] /** * Creates a new self-hosted runner group for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - post: operations["enterprise-admin/create-self-hosted-runner-group-for-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}": { + post: operations['enterprise-admin/create-self-hosted-runner-group-for-enterprise'] + } + '/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}': { /** * Gets a specific self-hosted runner group for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - get: operations["enterprise-admin/get-self-hosted-runner-group-for-enterprise"]; + get: operations['enterprise-admin/get-self-hosted-runner-group-for-enterprise'] /** * Deletes a self-hosted runner group for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - delete: operations["enterprise-admin/delete-self-hosted-runner-group-from-enterprise"]; + delete: operations['enterprise-admin/delete-self-hosted-runner-group-from-enterprise'] /** * Updates the `name` and `visibility` of a self-hosted runner group in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - patch: operations["enterprise-admin/update-self-hosted-runner-group-for-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations": { + patch: operations['enterprise-admin/update-self-hosted-runner-group-for-enterprise'] + } + '/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations': { /** * Lists the organizations with access to a self-hosted runner group. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - get: operations["enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise"]; + get: operations['enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise'] /** * Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - put: operations["enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}": { + put: operations['enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise'] + } + '/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}': { /** * Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - put: operations["enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise"]; + put: operations['enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise'] /** * Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - delete: operations["enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": { + delete: operations['enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise'] + } + '/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners': { /** * Lists the self-hosted runners that are in a specific enterprise group. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - get: operations["enterprise-admin/list-self-hosted-runners-in-group-for-enterprise"]; + get: operations['enterprise-admin/list-self-hosted-runners-in-group-for-enterprise'] /** * Replaces the list of self-hosted runners that are part of an enterprise runner group. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - put: operations["enterprise-admin/set-self-hosted-runners-in-group-for-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + put: operations['enterprise-admin/set-self-hosted-runners-in-group-for-enterprise'] + } + '/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}': { /** * Adds a self-hosted runner to a runner group configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` * scope to use this endpoint. */ - put: operations["enterprise-admin/add-self-hosted-runner-to-group-for-enterprise"]; + put: operations['enterprise-admin/add-self-hosted-runner-to-group-for-enterprise'] /** * Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - delete: operations["enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runners": { + delete: operations['enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise'] + } + '/enterprises/{enterprise}/actions/runners': { /** * Lists all self-hosted runners configured for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - get: operations["enterprise-admin/list-self-hosted-runners-for-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runners/downloads": { + get: operations['enterprise-admin/list-self-hosted-runners-for-enterprise'] + } + '/enterprises/{enterprise}/actions/runners/downloads': { /** * Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - get: operations["enterprise-admin/list-runner-applications-for-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runners/registration-token": { + get: operations['enterprise-admin/list-runner-applications-for-enterprise'] + } + '/enterprises/{enterprise}/actions/runners/registration-token': { /** * Returns a token that you can pass to the `config` script. The token expires after one hour. * @@ -392,9 +392,9 @@ export interface paths { * ./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN * ``` */ - post: operations["enterprise-admin/create-registration-token-for-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runners/remove-token": { + post: operations['enterprise-admin/create-registration-token-for-enterprise'] + } + '/enterprises/{enterprise}/actions/runners/remove-token': { /** * Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour. * @@ -409,51 +409,51 @@ export interface paths { * ./config.sh remove --token TOKEN * ``` */ - post: operations["enterprise-admin/create-remove-token-for-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runners/{runner_id}": { + post: operations['enterprise-admin/create-remove-token-for-enterprise'] + } + '/enterprises/{enterprise}/actions/runners/{runner_id}': { /** * Gets a specific self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - get: operations["enterprise-admin/get-self-hosted-runner-for-enterprise"]; + get: operations['enterprise-admin/get-self-hosted-runner-for-enterprise'] /** * Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - delete: operations["enterprise-admin/delete-self-hosted-runner-from-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runners/{runner_id}/labels": { + delete: operations['enterprise-admin/delete-self-hosted-runner-from-enterprise'] + } + '/enterprises/{enterprise}/actions/runners/{runner_id}/labels': { /** * Lists all labels for a self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - get: operations["enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise"]; + get: operations['enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise'] /** * Remove all previous custom labels and set the new custom labels for a specific * self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - put: operations["enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise"]; + put: operations['enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise'] /** * Add custom labels to a self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - post: operations["enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise"]; + post: operations['enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise'] /** * Remove all custom labels from a self-hosted runner configured in an * enterprise. Returns the remaining read-only labels from the runner. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - delete: operations["enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise"]; - }; - "/enterprises/{enterprise}/actions/runners/{runner_id}/labels/{name}": { + delete: operations['enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise'] + } + '/enterprises/{enterprise}/actions/runners/{runner_id}/labels/{name}': { /** * Remove a custom label from a self-hosted runner configured * in an enterprise. Returns the remaining labels from the runner. @@ -463,20 +463,20 @@ export interface paths { * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - delete: operations["enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise"]; - }; - "/enterprises/{enterprise}/audit-log": { + delete: operations['enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise'] + } + '/enterprises/{enterprise}/audit-log': { /** Gets the audit log for an enterprise. To use this endpoint, you must be an enterprise admin, and you must use an access token with the `admin:enterprise` scope. */ - get: operations["enterprise-admin/get-audit-log"]; - }; - "/enterprises/{enterprise}/secret-scanning/alerts": { + get: operations['enterprise-admin/get-audit-log'] + } + '/enterprises/{enterprise}/secret-scanning/alerts': { /** * Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. * To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). */ - get: operations["secret-scanning/list-alerts-for-enterprise"]; - }; - "/enterprises/{enterprise}/settings/billing/actions": { + get: operations['secret-scanning/list-alerts-for-enterprise'] + } + '/enterprises/{enterprise}/settings/billing/actions': { /** * Gets the summary of the free and paid GitHub Actions minutes used. * @@ -484,16 +484,16 @@ export interface paths { * * The authenticated user must be an enterprise admin. */ - get: operations["billing/get-github-actions-billing-ghe"]; - }; - "/enterprises/{enterprise}/settings/billing/advanced-security": { + get: operations['billing/get-github-actions-billing-ghe'] + } + '/enterprises/{enterprise}/settings/billing/advanced-security': { /** * Gets the GitHub Advanced Security active committers for an enterprise per repository. * Each distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of active_users for each repository. */ - get: operations["billing/get-github-advanced-security-billing-ghe"]; - }; - "/enterprises/{enterprise}/settings/billing/packages": { + get: operations['billing/get-github-advanced-security-billing-ghe'] + } + '/enterprises/{enterprise}/settings/billing/packages': { /** * Gets the free and paid storage used for GitHub Packages in gigabytes. * @@ -501,9 +501,9 @@ export interface paths { * * The authenticated user must be an enterprise admin. */ - get: operations["billing/get-github-packages-billing-ghe"]; - }; - "/enterprises/{enterprise}/settings/billing/shared-storage": { + get: operations['billing/get-github-packages-billing-ghe'] + } + '/enterprises/{enterprise}/settings/billing/shared-storage': { /** * Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. * @@ -511,13 +511,13 @@ export interface paths { * * The authenticated user must be an enterprise admin. */ - get: operations["billing/get-shared-storage-billing-ghe"]; - }; - "/events": { + get: operations['billing/get-shared-storage-billing-ghe'] + } + '/events': { /** We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. */ - get: operations["activity/list-public-events"]; - }; - "/feeds": { + get: operations['activity/list-public-events'] + } + '/feeds': { /** * GitHub provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user: * @@ -531,82 +531,82 @@ export interface paths { * * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ - get: operations["activity/get-feeds"]; - }; - "/gists": { + get: operations['activity/get-feeds'] + } + '/gists': { /** Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists: */ - get: operations["gists/list"]; + get: operations['gists/list'] /** * Allows you to add a new gist with one or more files. * * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. */ - post: operations["gists/create"]; - }; - "/gists/public": { + post: operations['gists/create'] + } + '/gists/public': { /** * List public gists sorted by most recently updated to least recently updated. * * Note: With [pagination](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. */ - get: operations["gists/list-public"]; - }; - "/gists/starred": { + get: operations['gists/list-public'] + } + '/gists/starred': { /** List the authenticated user's starred gists: */ - get: operations["gists/list-starred"]; - }; - "/gists/{gist_id}": { - get: operations["gists/get"]; - delete: operations["gists/delete"]; + get: operations['gists/list-starred'] + } + '/gists/{gist_id}': { + get: operations['gists/get'] + delete: operations['gists/delete'] /** Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged. */ - patch: operations["gists/update"]; - }; - "/gists/{gist_id}/comments": { - get: operations["gists/list-comments"]; - post: operations["gists/create-comment"]; - }; - "/gists/{gist_id}/comments/{comment_id}": { - get: operations["gists/get-comment"]; - delete: operations["gists/delete-comment"]; - patch: operations["gists/update-comment"]; - }; - "/gists/{gist_id}/commits": { - get: operations["gists/list-commits"]; - }; - "/gists/{gist_id}/forks": { - get: operations["gists/list-forks"]; + patch: operations['gists/update'] + } + '/gists/{gist_id}/comments': { + get: operations['gists/list-comments'] + post: operations['gists/create-comment'] + } + '/gists/{gist_id}/comments/{comment_id}': { + get: operations['gists/get-comment'] + delete: operations['gists/delete-comment'] + patch: operations['gists/update-comment'] + } + '/gists/{gist_id}/commits': { + get: operations['gists/list-commits'] + } + '/gists/{gist_id}/forks': { + get: operations['gists/list-forks'] /** **Note**: This was previously `/gists/:gist_id/fork`. */ - post: operations["gists/fork"]; - }; - "/gists/{gist_id}/star": { - get: operations["gists/check-is-starred"]; + post: operations['gists/fork'] + } + '/gists/{gist_id}/star': { + get: operations['gists/check-is-starred'] /** Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - put: operations["gists/star"]; - delete: operations["gists/unstar"]; - }; - "/gists/{gist_id}/{sha}": { - get: operations["gists/get-revision"]; - }; - "/gitignore/templates": { + put: operations['gists/star'] + delete: operations['gists/unstar'] + } + '/gists/{gist_id}/{sha}': { + get: operations['gists/get-revision'] + } + '/gitignore/templates': { /** List all templates available to pass as an option when [creating a repository](https://docs.github.com/rest/reference/repos#create-a-repository-for-the-authenticated-user). */ - get: operations["gitignore/get-all-templates"]; - }; - "/gitignore/templates/{name}": { + get: operations['gitignore/get-all-templates'] + } + '/gitignore/templates/{name}': { /** * The API also allows fetching the source of a single template. * Use the raw [media type](https://docs.github.com/rest/overview/media-types/) to get the raw contents. */ - get: operations["gitignore/get-template"]; - }; - "/installation/repositories": { + get: operations['gitignore/get-template'] + } + '/installation/repositories': { /** * List repositories that an app installation can access. * * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ - get: operations["apps/list-repos-accessible-to-installation"]; - }; - "/installation/token": { + get: operations['apps/list-repos-accessible-to-installation'] + } + '/installation/token': { /** * Revokes the installation token you're using to authenticate as an installation and access this endpoint. * @@ -614,9 +614,9 @@ export interface paths { * * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ - delete: operations["apps/revoke-installation-access-token"]; - }; - "/issues": { + delete: operations['apps/revoke-installation-access-token'] + } + '/issues': { /** * List issues assigned to the authenticated user across all visible repositories including owned repositories, member * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not @@ -628,97 +628,97 @@ export interface paths { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - get: operations["issues/list"]; - }; - "/licenses": { - get: operations["licenses/get-all-commonly-used"]; - }; - "/licenses/{license}": { - get: operations["licenses/get"]; - }; - "/markdown": { - post: operations["markdown/render"]; - }; - "/markdown/raw": { + get: operations['issues/list'] + } + '/licenses': { + get: operations['licenses/get-all-commonly-used'] + } + '/licenses/{license}': { + get: operations['licenses/get'] + } + '/markdown': { + post: operations['markdown/render'] + } + '/markdown/raw': { /** You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less. */ - post: operations["markdown/render-raw"]; - }; - "/marketplace_listing/accounts/{account_id}": { + post: operations['markdown/render-raw'] + } + '/marketplace_listing/accounts/{account_id}': { /** * Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - get: operations["apps/get-subscription-plan-for-account"]; - }; - "/marketplace_listing/plans": { + get: operations['apps/get-subscription-plan-for-account'] + } + '/marketplace_listing/plans': { /** * Lists all plans that are part of your GitHub Marketplace listing. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - get: operations["apps/list-plans"]; - }; - "/marketplace_listing/plans/{plan_id}/accounts": { + get: operations['apps/list-plans'] + } + '/marketplace_listing/plans/{plan_id}/accounts': { /** * Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - get: operations["apps/list-accounts-for-plan"]; - }; - "/marketplace_listing/stubbed/accounts/{account_id}": { + get: operations['apps/list-accounts-for-plan'] + } + '/marketplace_listing/stubbed/accounts/{account_id}': { /** * Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - get: operations["apps/get-subscription-plan-for-account-stubbed"]; - }; - "/marketplace_listing/stubbed/plans": { + get: operations['apps/get-subscription-plan-for-account-stubbed'] + } + '/marketplace_listing/stubbed/plans': { /** * Lists all plans that are part of your GitHub Marketplace listing. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - get: operations["apps/list-plans-stubbed"]; - }; - "/marketplace_listing/stubbed/plans/{plan_id}/accounts": { + get: operations['apps/list-plans-stubbed'] + } + '/marketplace_listing/stubbed/plans/{plan_id}/accounts': { /** * Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - get: operations["apps/list-accounts-for-plan-stubbed"]; - }; - "/meta": { + get: operations['apps/list-accounts-for-plan-stubbed'] + } + '/meta': { /** * Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://docs.github.com/articles/about-github-s-ip-addresses/)." * * **Note:** The IP addresses shown in the documentation's response are only example values. You must always query the API directly to get the latest list of IP addresses. */ - get: operations["meta/get"]; - }; - "/networks/{owner}/{repo}/events": { - get: operations["activity/list-public-events-for-repo-network"]; - }; - "/notifications": { + get: operations['meta/get'] + } + '/networks/{owner}/{repo}/events': { + get: operations['activity/list-public-events-for-repo-network'] + } + '/notifications': { /** List all notifications for the current user, sorted by most recently updated. */ - get: operations["activity/list-notifications-for-authenticated-user"]; + get: operations['activity/list-notifications-for-authenticated-user'] /** Marks all notifications as "read" removes it from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ - put: operations["activity/mark-notifications-as-read"]; - }; - "/notifications/threads/{thread_id}": { - get: operations["activity/get-thread"]; - patch: operations["activity/mark-thread-as-read"]; - }; - "/notifications/threads/{thread_id}/subscription": { + put: operations['activity/mark-notifications-as-read'] + } + '/notifications/threads/{thread_id}': { + get: operations['activity/get-thread'] + patch: operations['activity/mark-thread-as-read'] + } + '/notifications/threads/{thread_id}/subscription': { /** * This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/rest/reference/activity#get-a-repository-subscription). * * Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. */ - get: operations["activity/get-thread-subscription-for-authenticated-user"]; + get: operations['activity/get-thread-subscription-for-authenticated-user'] /** * If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**. * @@ -726,60 +726,60 @@ export interface paths { * * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/rest/reference/activity#delete-a-thread-subscription) endpoint. */ - put: operations["activity/set-thread-subscription"]; + put: operations['activity/set-thread-subscription'] /** Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/rest/reference/activity#set-a-thread-subscription) endpoint and set `ignore` to `true`. */ - delete: operations["activity/delete-thread-subscription"]; - }; - "/octocat": { + delete: operations['activity/delete-thread-subscription'] + } + '/octocat': { /** Get the octocat as ASCII art */ - get: operations["meta/get-octocat"]; - }; - "/organizations": { + get: operations['meta/get-octocat'] + } + '/organizations': { /** * Lists all organizations, in the order that they were created on GitHub. * * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of organizations. */ - get: operations["orgs/list"]; - }; - "/organizations/{organization_id}/custom_roles": { + get: operations['orgs/list'] + } + '/organizations/{organization_id}/custom_roles': { /** * List the custom repository roles available in this organization. In order to see custom * repository roles in an organization, the authenticated user must be an organization owner. * * For more information on custom repository roles, see "[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)". */ - get: operations["orgs/list-custom-roles"]; - }; - "/organizations/{org}/team/{team_slug}/external-groups": { + get: operations['orgs/list-custom-roles'] + } + '/organizations/{org}/team/{team_slug}/external-groups': { /** * Lists a connection between a team and an external group. * * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ - get: operations["teams/list-linked-external-idp-groups-to-team-for-org"]; - }; - "/orgs/{org}": { + get: operations['teams/list-linked-external-idp-groups-to-team-for-org'] + } + '/orgs/{org}': { /** * To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). * * GitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub plan. See "[Authenticating with GitHub Apps](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/)" for details. For an example response, see 'Response with GitHub plan information' below." */ - get: operations["orgs/get"]; + get: operations['orgs/get'] /** * **Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). * * Enables an authenticated organization owner with the `admin:org` scope to update the organization's profile and member privileges. */ - patch: operations["orgs/update"]; - }; - "/orgs/{org}/actions/permissions": { + patch: operations['orgs/update'] + } + '/orgs/{org}/actions/permissions': { /** * Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - get: operations["actions/get-github-actions-permissions-organization"]; + get: operations['actions/get-github-actions-permissions-organization'] /** * Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization. * @@ -787,43 +787,43 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - put: operations["actions/set-github-actions-permissions-organization"]; - }; - "/orgs/{org}/actions/permissions/repositories": { + put: operations['actions/set-github-actions-permissions-organization'] + } + '/orgs/{org}/actions/permissions/repositories': { /** * Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - get: operations["actions/list-selected-repositories-enabled-github-actions-organization"]; + get: operations['actions/list-selected-repositories-enabled-github-actions-organization'] /** * Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - put: operations["actions/set-selected-repositories-enabled-github-actions-organization"]; - }; - "/orgs/{org}/actions/permissions/repositories/{repository_id}": { + put: operations['actions/set-selected-repositories-enabled-github-actions-organization'] + } + '/orgs/{org}/actions/permissions/repositories/{repository_id}': { /** * Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - put: operations["actions/enable-selected-repository-github-actions-organization"]; + put: operations['actions/enable-selected-repository-github-actions-organization'] /** * Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - delete: operations["actions/disable-selected-repository-github-actions-organization"]; - }; - "/orgs/{org}/actions/permissions/selected-actions": { + delete: operations['actions/disable-selected-repository-github-actions-organization'] + } + '/orgs/{org}/actions/permissions/selected-actions': { /** * Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."" * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - get: operations["actions/get-allowed-actions-organization"]; + get: operations['actions/get-allowed-actions-organization'] /** * Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * @@ -833,25 +833,25 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - put: operations["actions/set-allowed-actions-organization"]; - }; - "/orgs/{org}/actions/permissions/workflow": { + put: operations['actions/set-allowed-actions-organization'] + } + '/orgs/{org}/actions/permissions/workflow': { /** * Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, * as well if GitHub Actions can submit approving pull request reviews. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - get: operations["actions/get-github-actions-default-workflow-permissions-organization"]; + get: operations['actions/get-github-actions-default-workflow-permissions-organization'] /** * Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions * can submit approving pull request reviews. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - put: operations["actions/set-github-actions-default-workflow-permissions-organization"]; - }; - "/orgs/{org}/actions/runner-groups": { + put: operations['actions/set-github-actions-default-workflow-permissions-organization'] + } + '/orgs/{org}/actions/runner-groups': { /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -859,7 +859,7 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - get: operations["actions/list-self-hosted-runner-groups-for-org"]; + get: operations['actions/list-self-hosted-runner-groups-for-org'] /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -867,9 +867,9 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - post: operations["actions/create-self-hosted-runner-group-for-org"]; - }; - "/orgs/{org}/actions/runner-groups/{runner_group_id}": { + post: operations['actions/create-self-hosted-runner-group-for-org'] + } + '/orgs/{org}/actions/runner-groups/{runner_group_id}': { /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -877,7 +877,7 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - get: operations["actions/get-self-hosted-runner-group-for-org"]; + get: operations['actions/get-self-hosted-runner-group-for-org'] /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -885,7 +885,7 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - delete: operations["actions/delete-self-hosted-runner-group-from-org"]; + delete: operations['actions/delete-self-hosted-runner-group-from-org'] /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -893,9 +893,9 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - patch: operations["actions/update-self-hosted-runner-group-for-org"]; - }; - "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": { + patch: operations['actions/update-self-hosted-runner-group-for-org'] + } + '/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories': { /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -903,7 +903,7 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - get: operations["actions/list-repo-access-to-self-hosted-runner-group-in-org"]; + get: operations['actions/list-repo-access-to-self-hosted-runner-group-in-org'] /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -911,9 +911,9 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - put: operations["actions/set-repo-access-to-self-hosted-runner-group-in-org"]; - }; - "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": { + put: operations['actions/set-repo-access-to-self-hosted-runner-group-in-org'] + } + '/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}': { /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -923,7 +923,7 @@ export interface paths { * You must authenticate using an access token with the `admin:org` * scope to use this endpoint. */ - put: operations["actions/add-repo-access-to-self-hosted-runner-group-in-org"]; + put: operations['actions/add-repo-access-to-self-hosted-runner-group-in-org'] /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -932,9 +932,9 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - delete: operations["actions/remove-repo-access-to-self-hosted-runner-group-in-org"]; - }; - "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners": { + delete: operations['actions/remove-repo-access-to-self-hosted-runner-group-in-org'] + } + '/orgs/{org}/actions/runner-groups/{runner_group_id}/runners': { /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -942,7 +942,7 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - get: operations["actions/list-self-hosted-runners-in-group-for-org"]; + get: operations['actions/list-self-hosted-runners-in-group-for-org'] /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -950,9 +950,9 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - put: operations["actions/set-self-hosted-runners-in-group-for-org"]; - }; - "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + put: operations['actions/set-self-hosted-runners-in-group-for-org'] + } + '/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}': { /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -962,7 +962,7 @@ export interface paths { * You must authenticate using an access token with the `admin:org` * scope to use this endpoint. */ - put: operations["actions/add-self-hosted-runner-to-group-for-org"]; + put: operations['actions/add-self-hosted-runner-to-group-for-org'] /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -971,25 +971,25 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - delete: operations["actions/remove-self-hosted-runner-from-group-for-org"]; - }; - "/orgs/{org}/actions/runners": { + delete: operations['actions/remove-self-hosted-runner-from-group-for-org'] + } + '/orgs/{org}/actions/runners': { /** * Lists all self-hosted runners configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - get: operations["actions/list-self-hosted-runners-for-org"]; - }; - "/orgs/{org}/actions/runners/downloads": { + get: operations['actions/list-self-hosted-runners-for-org'] + } + '/orgs/{org}/actions/runners/downloads': { /** * Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - get: operations["actions/list-runner-applications-for-org"]; - }; - "/orgs/{org}/actions/runners/registration-token": { + get: operations['actions/list-runner-applications-for-org'] + } + '/orgs/{org}/actions/runners/registration-token': { /** * Returns a token that you can pass to the `config` script. The token expires after one hour. * @@ -1003,9 +1003,9 @@ export interface paths { * ./config.sh --url https://github.com/octo-org --token TOKEN * ``` */ - post: operations["actions/create-registration-token-for-org"]; - }; - "/orgs/{org}/actions/runners/remove-token": { + post: operations['actions/create-registration-token-for-org'] + } + '/orgs/{org}/actions/runners/remove-token': { /** * Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour. * @@ -1020,51 +1020,51 @@ export interface paths { * ./config.sh remove --token TOKEN * ``` */ - post: operations["actions/create-remove-token-for-org"]; - }; - "/orgs/{org}/actions/runners/{runner_id}": { + post: operations['actions/create-remove-token-for-org'] + } + '/orgs/{org}/actions/runners/{runner_id}': { /** * Gets a specific self-hosted runner configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - get: operations["actions/get-self-hosted-runner-for-org"]; + get: operations['actions/get-self-hosted-runner-for-org'] /** * Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - delete: operations["actions/delete-self-hosted-runner-from-org"]; - }; - "/orgs/{org}/actions/runners/{runner_id}/labels": { + delete: operations['actions/delete-self-hosted-runner-from-org'] + } + '/orgs/{org}/actions/runners/{runner_id}/labels': { /** * Lists all labels for a self-hosted runner configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - get: operations["actions/list-labels-for-self-hosted-runner-for-org"]; + get: operations['actions/list-labels-for-self-hosted-runner-for-org'] /** * Remove all previous custom labels and set the new custom labels for a specific * self-hosted runner configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - put: operations["actions/set-custom-labels-for-self-hosted-runner-for-org"]; + put: operations['actions/set-custom-labels-for-self-hosted-runner-for-org'] /** * Add custom labels to a self-hosted runner configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - post: operations["actions/add-custom-labels-to-self-hosted-runner-for-org"]; + post: operations['actions/add-custom-labels-to-self-hosted-runner-for-org'] /** * Remove all custom labels from a self-hosted runner configured in an * organization. Returns the remaining read-only labels from the runner. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - delete: operations["actions/remove-all-custom-labels-from-self-hosted-runner-for-org"]; - }; - "/orgs/{org}/actions/runners/{runner_id}/labels/{name}": { + delete: operations['actions/remove-all-custom-labels-from-self-hosted-runner-for-org'] + } + '/orgs/{org}/actions/runners/{runner_id}/labels/{name}': { /** * Remove a custom label from a self-hosted runner configured * in an organization. Returns the remaining labels from the runner. @@ -1074,19 +1074,19 @@ export interface paths { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - delete: operations["actions/remove-custom-label-from-self-hosted-runner-for-org"]; - }; - "/orgs/{org}/actions/secrets": { + delete: operations['actions/remove-custom-label-from-self-hosted-runner-for-org'] + } + '/orgs/{org}/actions/secrets': { /** Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - get: operations["actions/list-org-secrets"]; - }; - "/orgs/{org}/actions/secrets/public-key": { + get: operations['actions/list-org-secrets'] + } + '/orgs/{org}/actions/secrets/public-key': { /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - get: operations["actions/get-org-public-key"]; - }; - "/orgs/{org}/actions/secrets/{secret_name}": { + get: operations['actions/get-org-public-key'] + } + '/orgs/{org}/actions/secrets/{secret_name}': { /** Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - get: operations["actions/get-org-secret"]; + get: operations['actions/get-org-secret'] /** * Creates or updates an organization secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -1164,40 +1164,40 @@ export interface paths { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - put: operations["actions/create-or-update-org-secret"]; + put: operations['actions/create-or-update-org-secret'] /** Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - delete: operations["actions/delete-org-secret"]; - }; - "/orgs/{org}/actions/secrets/{secret_name}/repositories": { + delete: operations['actions/delete-org-secret'] + } + '/orgs/{org}/actions/secrets/{secret_name}/repositories': { /** Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - get: operations["actions/list-selected-repos-for-org-secret"]; + get: operations['actions/list-selected-repos-for-org-secret'] /** Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - put: operations["actions/set-selected-repos-for-org-secret"]; - }; - "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}": { + put: operations['actions/set-selected-repos-for-org-secret'] + } + '/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}': { /** Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - put: operations["actions/add-selected-repo-to-org-secret"]; + put: operations['actions/add-selected-repo-to-org-secret'] /** Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - delete: operations["actions/remove-selected-repo-from-org-secret"]; - }; - "/orgs/{org}/audit-log": { + delete: operations['actions/remove-selected-repo-from-org-secret'] + } + '/orgs/{org}/audit-log': { /** * Gets the audit log for an organization. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization)." * * This endpoint is available for organizations on GitHub Enterprise Cloud. To use this endpoint, you must be an organization owner, and you must use an access token with the `admin:org` scope. GitHub Apps must have the `organization_administration` read permission to use this endpoint. */ - get: operations["orgs/get-audit-log"]; - }; - "/orgs/{org}/blocks": { + get: operations['orgs/get-audit-log'] + } + '/orgs/{org}/blocks': { /** List the users blocked by an organization. */ - get: operations["orgs/list-blocked-users"]; - }; - "/orgs/{org}/blocks/{username}": { - get: operations["orgs/check-blocked-user"]; - put: operations["orgs/block-user"]; - delete: operations["orgs/unblock-user"]; - }; - "/orgs/{org}/code-scanning/alerts": { + get: operations['orgs/list-blocked-users'] + } + '/orgs/{org}/blocks/{username}': { + get: operations['orgs/check-blocked-user'] + put: operations['orgs/block-user'] + delete: operations['orgs/unblock-user'] + } + '/orgs/{org}/code-scanning/alerts': { /** * Lists all code scanning alerts for the default branch (usually `main` * or `master`) for all eligible repositories in an organization. @@ -1205,35 +1205,35 @@ export interface paths { * * GitHub Apps must have the `security_events` read permission to use this endpoint. */ - get: operations["code-scanning/list-alerts-for-org"]; - }; - "/orgs/{org}/credential-authorizations": { + get: operations['code-scanning/list-alerts-for-org'] + } + '/orgs/{org}/credential-authorizations': { /** * Listing and deleting credential authorizations is available to organizations with GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products). * * An authenticated organization owner with the `read:org` scope can list all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials are either personal access tokens or SSH keys that organization members have authorized for the organization. For more information, see [About authentication with SAML single sign-on](https://docs.github.com/en/articles/about-authentication-with-saml-single-sign-on). */ - get: operations["orgs/list-saml-sso-authorizations"]; - }; - "/orgs/{org}/credential-authorizations/{credential_id}": { + get: operations['orgs/list-saml-sso-authorizations'] + } + '/orgs/{org}/credential-authorizations/{credential_id}': { /** * Listing and deleting credential authorizations is available to organizations with GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products). * * An authenticated organization owner with the `admin:org` scope can remove a credential authorization for an organization that uses SAML SSO. Once you remove someone's credential authorization, they will need to create a new personal access token or SSH key and authorize it for the organization they want to access. */ - delete: operations["orgs/remove-saml-sso-authorization"]; - }; - "/orgs/{org}/dependabot/secrets": { + delete: operations['orgs/remove-saml-sso-authorization'] + } + '/orgs/{org}/dependabot/secrets': { /** Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - get: operations["dependabot/list-org-secrets"]; - }; - "/orgs/{org}/dependabot/secrets/public-key": { + get: operations['dependabot/list-org-secrets'] + } + '/orgs/{org}/dependabot/secrets/public-key': { /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - get: operations["dependabot/get-org-public-key"]; - }; - "/orgs/{org}/dependabot/secrets/{secret_name}": { + get: operations['dependabot/get-org-public-key'] + } + '/orgs/{org}/dependabot/secrets/{secret_name}': { /** Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - get: operations["dependabot/get-org-secret"]; + get: operations['dependabot/get-org-secret'] /** * Creates or updates an organization secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -1311,130 +1311,130 @@ export interface paths { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - put: operations["dependabot/create-or-update-org-secret"]; + put: operations['dependabot/create-or-update-org-secret'] /** Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - delete: operations["dependabot/delete-org-secret"]; - }; - "/orgs/{org}/dependabot/secrets/{secret_name}/repositories": { + delete: operations['dependabot/delete-org-secret'] + } + '/orgs/{org}/dependabot/secrets/{secret_name}/repositories': { /** Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - get: operations["dependabot/list-selected-repos-for-org-secret"]; + get: operations['dependabot/list-selected-repos-for-org-secret'] /** Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - put: operations["dependabot/set-selected-repos-for-org-secret"]; - }; - "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}": { + put: operations['dependabot/set-selected-repos-for-org-secret'] + } + '/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}': { /** Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - put: operations["dependabot/add-selected-repo-to-org-secret"]; + put: operations['dependabot/add-selected-repo-to-org-secret'] /** Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - delete: operations["dependabot/remove-selected-repo-from-org-secret"]; - }; - "/orgs/{org}/events": { - get: operations["activity/list-public-org-events"]; - }; - "/orgs/{org}/external-group/{group_id}": { + delete: operations['dependabot/remove-selected-repo-from-org-secret'] + } + '/orgs/{org}/events': { + get: operations['activity/list-public-org-events'] + } + '/orgs/{org}/external-group/{group_id}': { /** * Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to. * * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ - get: operations["teams/external-idp-group-info-for-org"]; - }; - "/orgs/{org}/external-groups": { + get: operations['teams/external-idp-group-info-for-org'] + } + '/orgs/{org}/external-groups': { /** * Lists external groups available in an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." * * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ - get: operations["teams/list-external-idp-groups-for-org"]; - }; - "/orgs/{org}/failed_invitations": { + get: operations['teams/list-external-idp-groups-for-org'] + } + '/orgs/{org}/failed_invitations': { /** The return hash contains `failed_at` and `failed_reason` fields which represent the time at which the invitation failed and the reason for the failure. */ - get: operations["orgs/list-failed-invitations"]; - }; - "/orgs/{org}/hooks": { - get: operations["orgs/list-webhooks"]; + get: operations['orgs/list-failed-invitations'] + } + '/orgs/{org}/hooks': { + get: operations['orgs/list-webhooks'] /** Here's how you can create a hook that posts payloads in JSON format: */ - post: operations["orgs/create-webhook"]; - }; - "/orgs/{org}/hooks/{hook_id}": { + post: operations['orgs/create-webhook'] + } + '/orgs/{org}/hooks/{hook_id}': { /** Returns a webhook configured in an organization. To get only the webhook `config` properties, see "[Get a webhook configuration for an organization](/rest/reference/orgs#get-a-webhook-configuration-for-an-organization)." */ - get: operations["orgs/get-webhook"]; - delete: operations["orgs/delete-webhook"]; + get: operations['orgs/get-webhook'] + delete: operations['orgs/delete-webhook'] /** Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for an organization](/rest/reference/orgs#update-a-webhook-configuration-for-an-organization)." */ - patch: operations["orgs/update-webhook"]; - }; - "/orgs/{org}/hooks/{hook_id}/config": { + patch: operations['orgs/update-webhook'] + } + '/orgs/{org}/hooks/{hook_id}/config': { /** * Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/reference/orgs#get-an-organization-webhook)." * * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission. */ - get: operations["orgs/get-webhook-config-for-org"]; + get: operations['orgs/get-webhook-config-for-org'] /** * Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/reference/orgs#update-an-organization-webhook)." * * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission. */ - patch: operations["orgs/update-webhook-config-for-org"]; - }; - "/orgs/{org}/hooks/{hook_id}/deliveries": { + patch: operations['orgs/update-webhook-config-for-org'] + } + '/orgs/{org}/hooks/{hook_id}/deliveries': { /** Returns a list of webhook deliveries for a webhook configured in an organization. */ - get: operations["orgs/list-webhook-deliveries"]; - }; - "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": { + get: operations['orgs/list-webhook-deliveries'] + } + '/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}': { /** Returns a delivery for a webhook configured in an organization. */ - get: operations["orgs/get-webhook-delivery"]; - }; - "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { + get: operations['orgs/get-webhook-delivery'] + } + '/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts': { /** Redeliver a delivery for a webhook configured in an organization. */ - post: operations["orgs/redeliver-webhook-delivery"]; - }; - "/orgs/{org}/hooks/{hook_id}/pings": { + post: operations['orgs/redeliver-webhook-delivery'] + } + '/orgs/{org}/hooks/{hook_id}/pings': { /** This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. */ - post: operations["orgs/ping-webhook"]; - }; - "/orgs/{org}/installation": { + post: operations['orgs/ping-webhook'] + } + '/orgs/{org}/installation': { /** * Enables an authenticated GitHub App to find the organization's installation information. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - get: operations["apps/get-org-installation"]; - }; - "/orgs/{org}/installations": { + get: operations['apps/get-org-installation'] + } + '/orgs/{org}/installations': { /** Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint. */ - get: operations["orgs/list-app-installations"]; - }; - "/orgs/{org}/interaction-limits": { + get: operations['orgs/list-app-installations'] + } + '/orgs/{org}/interaction-limits': { /** Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response. */ - get: operations["interactions/get-restrictions-for-org"]; + get: operations['interactions/get-restrictions-for-org'] /** Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization. */ - put: operations["interactions/set-restrictions-for-org"]; + put: operations['interactions/set-restrictions-for-org'] /** Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions. */ - delete: operations["interactions/remove-restrictions-for-org"]; - }; - "/orgs/{org}/invitations": { + delete: operations['interactions/remove-restrictions-for-org'] + } + '/orgs/{org}/invitations': { /** The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. */ - get: operations["orgs/list-pending-invitations"]; + get: operations['orgs/list-pending-invitations'] /** * Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - post: operations["orgs/create-invitation"]; - }; - "/orgs/{org}/invitations/{invitation_id}": { + post: operations['orgs/create-invitation'] + } + '/orgs/{org}/invitations/{invitation_id}': { /** * Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). */ - delete: operations["orgs/cancel-invitation"]; - }; - "/orgs/{org}/invitations/{invitation_id}/teams": { + delete: operations['orgs/cancel-invitation'] + } + '/orgs/{org}/invitations/{invitation_id}/teams': { /** List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner. */ - get: operations["orgs/list-invitation-teams"]; - }; - "/orgs/{org}/issues": { + get: operations['orgs/list-invitation-teams'] + } + '/orgs/{org}/issues': { /** * List issues in an organization assigned to the authenticated user. * @@ -1443,21 +1443,21 @@ export interface paths { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - get: operations["issues/list-for-org"]; - }; - "/orgs/{org}/members": { + get: operations['issues/list-for-org'] + } + '/orgs/{org}/members': { /** List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned. */ - get: operations["orgs/list-members"]; - }; - "/orgs/{org}/members/{username}": { + get: operations['orgs/list-members'] + } + '/orgs/{org}/members/{username}': { /** Check if a user is, publicly or privately, a member of the organization. */ - get: operations["orgs/check-membership-for-user"]; + get: operations['orgs/check-membership-for-user'] /** Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories. */ - delete: operations["orgs/remove-member"]; - }; - "/orgs/{org}/memberships/{username}": { + delete: operations['orgs/remove-member'] + } + '/orgs/{org}/memberships/{username}': { /** In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status. */ - get: operations["orgs/get-membership-for-user"]; + get: operations['orgs/get-membership-for-user'] /** * Only authenticated organization owners can add a member to the organization or update the member's role. * @@ -1469,21 +1469,21 @@ export interface paths { * * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. */ - put: operations["orgs/set-membership-for-user"]; + put: operations['orgs/set-membership-for-user'] /** * In order to remove a user's membership with an organization, the authenticated user must be an organization owner. * * If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases. */ - delete: operations["orgs/remove-membership-for-user"]; - }; - "/orgs/{org}/migrations": { + delete: operations['orgs/remove-membership-for-user'] + } + '/orgs/{org}/migrations': { /** Lists the most recent migrations. */ - get: operations["migrations/list-for-org"]; + get: operations['migrations/list-for-org'] /** Initiates the generation of a migration archive. */ - post: operations["migrations/start-for-org"]; - }; - "/orgs/{org}/migrations/{migration_id}": { + post: operations['migrations/start-for-org'] + } + '/orgs/{org}/migrations/{migration_id}': { /** * Fetches the status of a migration. * @@ -1494,49 +1494,49 @@ export interface paths { * * `exported`, which means the migration finished successfully. * * `failed`, which means the migration failed. */ - get: operations["migrations/get-status-for-org"]; - }; - "/orgs/{org}/migrations/{migration_id}/archive": { + get: operations['migrations/get-status-for-org'] + } + '/orgs/{org}/migrations/{migration_id}/archive': { /** Fetches the URL to a migration archive. */ - get: operations["migrations/download-archive-for-org"]; + get: operations['migrations/download-archive-for-org'] /** Deletes a previous migration archive. Migration archives are automatically deleted after seven days. */ - delete: operations["migrations/delete-archive-for-org"]; - }; - "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock": { + delete: operations['migrations/delete-archive-for-org'] + } + '/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock': { /** Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/rest/reference/repos#delete-a-repository) when the migration is complete and you no longer need the source data. */ - delete: operations["migrations/unlock-repo-for-org"]; - }; - "/orgs/{org}/migrations/{migration_id}/repositories": { + delete: operations['migrations/unlock-repo-for-org'] + } + '/orgs/{org}/migrations/{migration_id}/repositories': { /** List all the repositories for this organization migration. */ - get: operations["migrations/list-repos-for-org"]; - }; - "/orgs/{org}/outside_collaborators": { + get: operations['migrations/list-repos-for-org'] + } + '/orgs/{org}/outside_collaborators': { /** List all users who are outside collaborators of an organization. */ - get: operations["orgs/list-outside-collaborators"]; - }; - "/orgs/{org}/outside_collaborators/{username}": { + get: operations['orgs/list-outside-collaborators'] + } + '/orgs/{org}/outside_collaborators/{username}': { /** When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://docs.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)". */ - put: operations["orgs/convert-member-to-outside-collaborator"]; + put: operations['orgs/convert-member-to-outside-collaborator'] /** Removing a user from this list will remove them from all the organization's repositories. */ - delete: operations["orgs/remove-outside-collaborator"]; - }; - "/orgs/{org}/packages": { + delete: operations['orgs/remove-outside-collaborator'] + } + '/orgs/{org}/packages': { /** * Lists all packages in an organization readable by the user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/list-packages-for-organization"]; - }; - "/orgs/{org}/packages/{package_type}/{package_name}": { + get: operations['packages/list-packages-for-organization'] + } + '/orgs/{org}/packages/{package_type}/{package_name}': { /** * Gets a specific package in an organization. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/get-package-for-organization"]; + get: operations['packages/get-package-for-organization'] /** * Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * @@ -1544,9 +1544,9 @@ export interface paths { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. */ - delete: operations["packages/delete-package-for-org"]; - }; - "/orgs/{org}/packages/{package_type}/{package_name}/restore": { + delete: operations['packages/delete-package-for-org'] + } + '/orgs/{org}/packages/{package_type}/{package_name}/restore': { /** * Restores an entire package in an organization. * @@ -1558,25 +1558,25 @@ export interface paths { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. */ - post: operations["packages/restore-package-for-org"]; - }; - "/orgs/{org}/packages/{package_type}/{package_name}/versions": { + post: operations['packages/restore-package-for-org'] + } + '/orgs/{org}/packages/{package_type}/{package_name}/versions': { /** * Returns all package versions for a package owned by an organization. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/get-all-package-versions-for-package-owned-by-org"]; - }; - "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}": { + get: operations['packages/get-all-package-versions-for-package-owned-by-org'] + } + '/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}': { /** * Gets a specific package version in an organization. * * You must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/get-package-version-for-organization"]; + get: operations['packages/get-package-version-for-organization'] /** * Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * @@ -1584,9 +1584,9 @@ export interface paths { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. */ - delete: operations["packages/delete-package-version-for-org"]; - }; - "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { + delete: operations['packages/delete-package-version-for-org'] + } + '/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore': { /** * Restores a specific package version in an organization. * @@ -1598,31 +1598,31 @@ export interface paths { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. */ - post: operations["packages/restore-package-version-for-org"]; - }; - "/orgs/{org}/projects": { + post: operations['packages/restore-package-version-for-org'] + } + '/orgs/{org}/projects': { /** Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - get: operations["projects/list-for-org"]; + get: operations['projects/list-for-org'] /** Creates an organization project board. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - post: operations["projects/create-for-org"]; - }; - "/orgs/{org}/public_members": { + post: operations['projects/create-for-org'] + } + '/orgs/{org}/public_members': { /** Members of an organization can choose to have their membership publicized or not. */ - get: operations["orgs/list-public-members"]; - }; - "/orgs/{org}/public_members/{username}": { - get: operations["orgs/check-public-membership-for-user"]; + get: operations['orgs/list-public-members'] + } + '/orgs/{org}/public_members/{username}': { + get: operations['orgs/check-public-membership-for-user'] /** * The user can publicize their own membership. (A user cannot publicize the membership for another user.) * * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - put: operations["orgs/set-public-membership-for-authenticated-user"]; - delete: operations["orgs/remove-public-membership-for-authenticated-user"]; - }; - "/orgs/{org}/repos": { + put: operations['orgs/set-public-membership-for-authenticated-user'] + delete: operations['orgs/remove-public-membership-for-authenticated-user'] + } + '/orgs/{org}/repos': { /** Lists repositories for the specified organization. */ - get: operations["repos/list-for-org"]; + get: operations['repos/list-for-org'] /** * Creates a new repository in the specified organization. The authenticated user must be a member of the organization. * @@ -1633,18 +1633,18 @@ export interface paths { * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. * * `repo` scope to create a private repository */ - post: operations["repos/create-in-org"]; - }; - "/orgs/{org}/secret-scanning/alerts": { + post: operations['repos/create-in-org'] + } + '/orgs/{org}/secret-scanning/alerts': { /** * Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest. * To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. */ - get: operations["secret-scanning/list-alerts-for-org"]; - }; - "/orgs/{org}/settings/billing/actions": { + get: operations['secret-scanning/list-alerts-for-org'] + } + '/orgs/{org}/settings/billing/actions': { /** * Gets the summary of the free and paid GitHub Actions minutes used. * @@ -1652,17 +1652,17 @@ export interface paths { * * Access tokens must have the `repo` or `admin:org` scope. */ - get: operations["billing/get-github-actions-billing-org"]; - }; - "/orgs/{org}/settings/billing/advanced-security": { + get: operations['billing/get-github-actions-billing-org'] + } + '/orgs/{org}/settings/billing/advanced-security': { /** * Gets the GitHub Advanced Security active committers for an organization per repository. * Each distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of advanced_security_committers for each repository. * If this organization defers to an enterprise for billing, the total_advanced_security_committers returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level. */ - get: operations["billing/get-github-advanced-security-billing-org"]; - }; - "/orgs/{org}/settings/billing/packages": { + get: operations['billing/get-github-advanced-security-billing-org'] + } + '/orgs/{org}/settings/billing/packages': { /** * Gets the free and paid storage used for GitHub Packages in gigabytes. * @@ -1670,9 +1670,9 @@ export interface paths { * * Access tokens must have the `repo` or `admin:org` scope. */ - get: operations["billing/get-github-packages-billing-org"]; - }; - "/orgs/{org}/settings/billing/shared-storage": { + get: operations['billing/get-github-packages-billing-org'] + } + '/orgs/{org}/settings/billing/shared-storage': { /** * Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. * @@ -1680,33 +1680,33 @@ export interface paths { * * Access tokens must have the `repo` or `admin:org` scope. */ - get: operations["billing/get-shared-storage-billing-org"]; - }; - "/orgs/{org}/team-sync/groups": { + get: operations['billing/get-shared-storage-billing-org'] + } + '/orgs/{org}/team-sync/groups': { /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * List IdP groups available in an organization. You can limit your page results using the `per_page` parameter. GitHub generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." */ - get: operations["teams/list-idp-groups-for-org"]; - }; - "/orgs/{org}/teams": { + get: operations['teams/list-idp-groups-for-org'] + } + '/orgs/{org}/teams': { /** Lists all teams in an organization that are visible to the authenticated user. */ - get: operations["teams/list"]; + get: operations['teams/list'] /** * To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://docs.github.com/en/articles/setting-team-creation-permissions-in-your-organization)." * * When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)". */ - post: operations["teams/create"]; - }; - "/orgs/{org}/teams/{team_slug}": { + post: operations['teams/create'] + } + '/orgs/{org}/teams/{team_slug}': { /** * Gets a team using the team's `slug`. GitHub generates the `slug` from the team `name`. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. */ - get: operations["teams/get-by-name"]; + get: operations['teams/get-by-name'] /** * To delete a team, the authenticated user must be an organization owner or team maintainer. * @@ -1714,21 +1714,21 @@ export interface paths { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. */ - delete: operations["teams/delete-in-org"]; + delete: operations['teams/delete-in-org'] /** * To edit a team, the authenticated user must either be an organization owner or a team maintainer. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. */ - patch: operations["teams/update-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/discussions": { + patch: operations['teams/update-in-org'] + } + '/orgs/{org}/teams/{team_slug}/discussions': { /** * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. */ - get: operations["teams/list-discussions-in-org"]; + get: operations['teams/list-discussions-in-org'] /** * Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @@ -1736,35 +1736,35 @@ export interface paths { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. */ - post: operations["teams/create-discussion-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": { + post: operations['teams/create-discussion-in-org'] + } + '/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}': { /** * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. */ - get: operations["teams/get-discussion-in-org"]; + get: operations['teams/get-discussion-in-org'] /** * Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. */ - delete: operations["teams/delete-discussion-in-org"]; + delete: operations['teams/delete-discussion-in-org'] /** * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. */ - patch: operations["teams/update-discussion-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": { + patch: operations['teams/update-discussion-in-org'] + } + '/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments': { /** * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. */ - get: operations["teams/list-discussion-comments-in-org"]; + get: operations['teams/list-discussion-comments-in-org'] /** * Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @@ -1772,103 +1772,103 @@ export interface paths { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. */ - post: operations["teams/create-discussion-comment-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": { + post: operations['teams/create-discussion-comment-in-org'] + } + '/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}': { /** * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. */ - get: operations["teams/get-discussion-comment-in-org"]; + get: operations['teams/get-discussion-comment-in-org'] /** * Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. */ - delete: operations["teams/delete-discussion-comment-in-org"]; + delete: operations['teams/delete-discussion-comment-in-org'] /** * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. */ - patch: operations["teams/update-discussion-comment-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { + patch: operations['teams/update-discussion-comment-in-org'] + } + '/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions': { /** * List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments/). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. */ - get: operations["reactions/list-for-team-discussion-comment-in-org"]; + get: operations['reactions/list-for-team-discussion-comment-in-org'] /** * Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. */ - post: operations["reactions/create-for-team-discussion-comment-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { + post: operations['reactions/create-for-team-discussion-comment-in-org'] + } + '/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}': { /** * **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. * * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - delete: operations["reactions/delete-for-team-discussion-comment"]; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { + delete: operations['reactions/delete-for-team-discussion-comment'] + } + '/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions': { /** * List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. */ - get: operations["reactions/list-for-team-discussion-in-org"]; + get: operations['reactions/list-for-team-discussion-in-org'] /** * Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. */ - post: operations["reactions/create-for-team-discussion-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { + post: operations['reactions/create-for-team-discussion-in-org'] + } + '/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}': { /** * **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. * * Delete a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - delete: operations["reactions/delete-for-team-discussion"]; - }; - "/orgs/{org}/teams/{team_slug}/external-groups": { + delete: operations['reactions/delete-for-team-discussion'] + } + '/orgs/{org}/teams/{team_slug}/external-groups': { /** * Deletes a connection between a team and an external group. * * You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - delete: operations["teams/unlink-external-idp-group-from-team-for-org"]; + delete: operations['teams/unlink-external-idp-group-from-team-for-org'] /** * Creates a connection between a team and an external group. Only one external group can be linked to a team. * * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ - patch: operations["teams/link-external-idp-group-to-team-for-org"]; - }; - "/orgs/{org}/teams/{team_slug}/invitations": { + patch: operations['teams/link-external-idp-group-to-team-for-org'] + } + '/orgs/{org}/teams/{team_slug}/invitations': { /** * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. */ - get: operations["teams/list-pending-invitations-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/members": { + get: operations['teams/list-pending-invitations-in-org'] + } + '/orgs/{org}/teams/{team_slug}/members': { /** * Team members will include the members of child teams. * * To list members in a team, the team must be visible to the authenticated user. */ - get: operations["teams/list-members-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/memberships/{username}": { + get: operations['teams/list-members-in-org'] + } + '/orgs/{org}/teams/{team_slug}/memberships/{username}': { /** * Team members will include the members of child teams. * @@ -1881,7 +1881,7 @@ export interface paths { * * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team). */ - get: operations["teams/get-membership-for-user-in-org"]; + get: operations['teams/get-membership-for-user-in-org'] /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -1895,7 +1895,7 @@ export interface paths { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ - put: operations["teams/add-or-update-membership-for-user-in-org"]; + put: operations['teams/add-or-update-membership-for-user-in-org'] /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -1905,45 +1905,45 @@ export interface paths { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ - delete: operations["teams/remove-membership-for-user-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/projects": { + delete: operations['teams/remove-membership-for-user-in-org'] + } + '/orgs/{org}/teams/{team_slug}/projects': { /** * Lists the organization projects for a team. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. */ - get: operations["teams/list-projects-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { + get: operations['teams/list-projects-in-org'] + } + '/orgs/{org}/teams/{team_slug}/projects/{project_id}': { /** * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ - get: operations["teams/check-permissions-for-project-in-org"]; + get: operations['teams/check-permissions-for-project-in-org'] /** * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ - put: operations["teams/add-or-update-project-permissions-in-org"]; + put: operations['teams/add-or-update-project-permissions-in-org'] /** * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ - delete: operations["teams/remove-project-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/repos": { + delete: operations['teams/remove-project-in-org'] + } + '/orgs/{org}/teams/{team_slug}/repos': { /** * Lists a team's repositories visible to the authenticated user. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. */ - get: operations["teams/list-repos-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": { + get: operations['teams/list-repos-in-org'] + } + '/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}': { /** * Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. * @@ -1953,7 +1953,7 @@ export interface paths { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ - get: operations["teams/check-permissions-for-repo-in-org"]; + get: operations['teams/check-permissions-for-repo-in-org'] /** * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." * @@ -1961,15 +1961,15 @@ export interface paths { * * For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". */ - put: operations["teams/add-or-update-repo-permissions-in-org"]; + put: operations['teams/add-or-update-repo-permissions-in-org'] /** * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ - delete: operations["teams/remove-repo-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/team-sync/group-mappings": { + delete: operations['teams/remove-repo-in-org'] + } + '/orgs/{org}/teams/{team_slug}/team-sync/group-mappings': { /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -1977,7 +1977,7 @@ export interface paths { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`. */ - get: operations["teams/list-idp-groups-in-org"]; + get: operations['teams/list-idp-groups-in-org'] /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -1985,131 +1985,131 @@ export interface paths { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`. */ - patch: operations["teams/create-or-update-idp-group-connections-in-org"]; - }; - "/orgs/{org}/teams/{team_slug}/teams": { + patch: operations['teams/create-or-update-idp-group-connections-in-org'] + } + '/orgs/{org}/teams/{team_slug}/teams': { /** * Lists the child teams of the team specified by `{team_slug}`. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. */ - get: operations["teams/list-child-in-org"]; - }; - "/projects/columns/cards/{card_id}": { - get: operations["projects/get-card"]; - delete: operations["projects/delete-card"]; - patch: operations["projects/update-card"]; - }; - "/projects/columns/cards/{card_id}/moves": { - post: operations["projects/move-card"]; - }; - "/projects/columns/{column_id}": { - get: operations["projects/get-column"]; - delete: operations["projects/delete-column"]; - patch: operations["projects/update-column"]; - }; - "/projects/columns/{column_id}/cards": { - get: operations["projects/list-cards"]; - post: operations["projects/create-card"]; - }; - "/projects/columns/{column_id}/moves": { - post: operations["projects/move-column"]; - }; - "/projects/{project_id}": { + get: operations['teams/list-child-in-org'] + } + '/projects/columns/cards/{card_id}': { + get: operations['projects/get-card'] + delete: operations['projects/delete-card'] + patch: operations['projects/update-card'] + } + '/projects/columns/cards/{card_id}/moves': { + post: operations['projects/move-card'] + } + '/projects/columns/{column_id}': { + get: operations['projects/get-column'] + delete: operations['projects/delete-column'] + patch: operations['projects/update-column'] + } + '/projects/columns/{column_id}/cards': { + get: operations['projects/list-cards'] + post: operations['projects/create-card'] + } + '/projects/columns/{column_id}/moves': { + post: operations['projects/move-column'] + } + '/projects/{project_id}': { /** Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - get: operations["projects/get"]; + get: operations['projects/get'] /** Deletes a project board. Returns a `404 Not Found` status if projects are disabled. */ - delete: operations["projects/delete"]; + delete: operations['projects/delete'] /** Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - patch: operations["projects/update"]; - }; - "/projects/{project_id}/collaborators": { + patch: operations['projects/update'] + } + '/projects/{project_id}/collaborators': { /** Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators. */ - get: operations["projects/list-collaborators"]; - }; - "/projects/{project_id}/collaborators/{username}": { + get: operations['projects/list-collaborators'] + } + '/projects/{project_id}/collaborators/{username}': { /** Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator. */ - put: operations["projects/add-collaborator"]; + put: operations['projects/add-collaborator'] /** Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator. */ - delete: operations["projects/remove-collaborator"]; - }; - "/projects/{project_id}/collaborators/{username}/permission": { + delete: operations['projects/remove-collaborator'] + } + '/projects/{project_id}/collaborators/{username}/permission': { /** Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level. */ - get: operations["projects/get-permission-for-user"]; - }; - "/projects/{project_id}/columns": { - get: operations["projects/list-columns"]; - post: operations["projects/create-column"]; - }; - "/rate_limit": { + get: operations['projects/get-permission-for-user'] + } + '/projects/{project_id}/columns': { + get: operations['projects/list-columns'] + post: operations['projects/create-column'] + } + '/rate_limit': { /** * **Note:** Accessing this endpoint does not count against your REST API rate limit. * * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. */ - get: operations["rate-limit/get"]; - }; - "/reactions/{reaction_id}": { + get: operations['rate-limit/get'] + } + '/reactions/{reaction_id}': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Reactions API. We recommend migrating your existing code to use the new delete reactions endpoints. For more information, see this [blog post](https://developer.github.com/changes/2020-02-26-new-delete-reactions-endpoints/). * * OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), when deleting a [team discussion](https://docs.github.com/rest/reference/teams#discussions) or [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). */ - delete: operations["reactions/delete-legacy"]; - }; - "/repos/{owner}/{repo}": { + delete: operations['reactions/delete-legacy'] + } + '/repos/{owner}/{repo}': { /** The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. */ - get: operations["repos/get"]; + get: operations['repos/get'] /** * Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required. * * If an organization owner has configured the organization to prevent members from deleting organization-owned * repositories, you will get a `403 Forbidden` response. */ - delete: operations["repos/delete"]; + delete: operations['repos/delete'] /** **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/rest/reference/repos#replace-all-repository-topics) endpoint. */ - patch: operations["repos/update"]; - }; - "/repos/{owner}/{repo}/actions/artifacts": { + patch: operations['repos/update'] + } + '/repos/{owner}/{repo}/actions/artifacts': { /** Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/list-artifacts-for-repo"]; - }; - "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}": { + get: operations['actions/list-artifacts-for-repo'] + } + '/repos/{owner}/{repo}/actions/artifacts/{artifact_id}': { /** Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/get-artifact"]; + get: operations['actions/get-artifact'] /** Deletes an artifact for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - delete: operations["actions/delete-artifact"]; - }; - "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}": { + delete: operations['actions/delete-artifact'] + } + '/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}': { /** * Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in * the response header to find the URL for the download. The `:archive_format` must be `zip`. Anyone with read access to * the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/download-artifact"]; - }; - "/repos/{owner}/{repo}/actions/jobs/{job_id}": { + get: operations['actions/download-artifact'] + } + '/repos/{owner}/{repo}/actions/jobs/{job_id}': { /** Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/get-job-for-workflow-run"]; - }; - "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs": { + get: operations['actions/get-job-for-workflow-run'] + } + '/repos/{owner}/{repo}/actions/jobs/{job_id}/logs': { /** * Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look * for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can * use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must * have the `actions:read` permission to use this endpoint. */ - get: operations["actions/download-job-logs-for-workflow-run"]; - }; - "/repos/{owner}/{repo}/actions/permissions": { + get: operations['actions/download-job-logs-for-workflow-run'] + } + '/repos/{owner}/{repo}/actions/permissions': { /** * Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository. * * You must authenticate using an access token with the `repo` scope to use this * endpoint. GitHub Apps must have the `administration` repository permission to use this API. */ - get: operations["actions/get-github-actions-permissions-repository"]; + get: operations['actions/get-github-actions-permissions-repository'] /** * Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository. * @@ -2117,15 +2117,15 @@ export interface paths { * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. */ - put: operations["actions/set-github-actions-permissions-repository"]; - }; - "/repos/{owner}/{repo}/actions/permissions/selected-actions": { + put: operations['actions/set-github-actions-permissions-repository'] + } + '/repos/{owner}/{repo}/actions/permissions/selected-actions': { /** * Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. */ - get: operations["actions/get-allowed-actions-repository"]; + get: operations['actions/get-allowed-actions-repository'] /** * Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." * @@ -2135,21 +2135,21 @@ export interface paths { * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. */ - put: operations["actions/set-allowed-actions-repository"]; - }; - "/repos/{owner}/{repo}/actions/runners": { + put: operations['actions/set-allowed-actions-repository'] + } + '/repos/{owner}/{repo}/actions/runners': { /** Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. */ - get: operations["actions/list-self-hosted-runners-for-repo"]; - }; - "/repos/{owner}/{repo}/actions/runners/downloads": { + get: operations['actions/list-self-hosted-runners-for-repo'] + } + '/repos/{owner}/{repo}/actions/runners/downloads': { /** * Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `repo` scope to use this endpoint. */ - get: operations["actions/list-runner-applications-for-repo"]; - }; - "/repos/{owner}/{repo}/actions/runners/registration-token": { + get: operations['actions/list-runner-applications-for-repo'] + } + '/repos/{owner}/{repo}/actions/runners/registration-token': { /** * Returns a token that you can pass to the `config` script. The token expires after one hour. You must authenticate * using an access token with the `repo` scope to use this endpoint. @@ -2162,9 +2162,9 @@ export interface paths { * ./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN * ``` */ - post: operations["actions/create-registration-token-for-repo"]; - }; - "/repos/{owner}/{repo}/actions/runners/remove-token": { + post: operations['actions/create-registration-token-for-repo'] + } + '/repos/{owner}/{repo}/actions/runners/remove-token': { /** * Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour. * You must authenticate using an access token with the `repo` scope to use this endpoint. @@ -2177,32 +2177,32 @@ export interface paths { * ./config.sh remove --token TOKEN * ``` */ - post: operations["actions/create-remove-token-for-repo"]; - }; - "/repos/{owner}/{repo}/actions/runners/{runner_id}": { + post: operations['actions/create-remove-token-for-repo'] + } + '/repos/{owner}/{repo}/actions/runners/{runner_id}': { /** * Gets a specific self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - get: operations["actions/get-self-hosted-runner-for-repo"]; + get: operations['actions/get-self-hosted-runner-for-repo'] /** * Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * * You must authenticate using an access token with the `repo` * scope to use this endpoint. */ - delete: operations["actions/delete-self-hosted-runner-from-repo"]; - }; - "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels": { + delete: operations['actions/delete-self-hosted-runner-from-repo'] + } + '/repos/{owner}/{repo}/actions/runners/{runner_id}/labels': { /** * Lists all labels for a self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - get: operations["actions/list-labels-for-self-hosted-runner-for-repo"]; + get: operations['actions/list-labels-for-self-hosted-runner-for-repo'] /** * Remove all previous custom labels and set the new custom labels for a specific * self-hosted runner configured in a repository. @@ -2210,14 +2210,14 @@ export interface paths { * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - put: operations["actions/set-custom-labels-for-self-hosted-runner-for-repo"]; + put: operations['actions/set-custom-labels-for-self-hosted-runner-for-repo'] /** * Add custom labels to a self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - post: operations["actions/add-custom-labels-to-self-hosted-runner-for-repo"]; + post: operations['actions/add-custom-labels-to-self-hosted-runner-for-repo'] /** * Remove all custom labels from a self-hosted runner configured in a * repository. Returns the remaining read-only labels from the runner. @@ -2225,9 +2225,9 @@ export interface paths { * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - delete: operations["actions/remove-all-custom-labels-from-self-hosted-runner-for-repo"]; - }; - "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}": { + delete: operations['actions/remove-all-custom-labels-from-self-hosted-runner-for-repo'] + } + '/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}': { /** * Remove a custom label from a self-hosted runner configured * in a repository. Returns the remaining labels from the runner. @@ -2238,120 +2238,120 @@ export interface paths { * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - delete: operations["actions/remove-custom-label-from-self-hosted-runner-for-repo"]; - }; - "/repos/{owner}/{repo}/actions/runs": { + delete: operations['actions/remove-custom-label-from-self-hosted-runner-for-repo'] + } + '/repos/{owner}/{repo}/actions/runs': { /** * Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). * * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/list-workflow-runs-for-repo"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}": { + get: operations['actions/list-workflow-runs-for-repo'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}': { /** Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/get-workflow-run"]; + get: operations['actions/get-workflow-run'] /** * Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is * private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:write` permission to use * this endpoint. */ - delete: operations["actions/delete-workflow-run"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/approvals": { + delete: operations['actions/delete-workflow-run'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/approvals': { /** Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/get-reviews-for-run"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/approve": { + get: operations['actions/get-reviews-for-run'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/approve': { /** * Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)." * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - post: operations["actions/approve-workflow-run"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts": { + post: operations['actions/approve-workflow-run'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts': { /** Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/list-workflow-run-artifacts"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}": { + get: operations['actions/list-workflow-run-artifacts'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}': { /** * Gets a specific workflow run attempt. Anyone with read access to the repository * can use this endpoint. If the repository is private you must use an access token * with the `repo` scope. GitHub Apps must have the `actions:read` permission to * use this endpoint. */ - get: operations["actions/get-workflow-run-attempt"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs": { + get: operations['actions/get-workflow-run-attempt'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs': { /** Lists jobs for a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). */ - get: operations["actions/list-jobs-for-workflow-run-attempt"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs": { + get: operations['actions/list-jobs-for-workflow-run-attempt'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs': { /** * Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after * 1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to * the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/download-workflow-run-attempt-logs"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": { + get: operations['actions/download-workflow-run-attempt-logs'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/cancel': { /** Cancels a workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - post: operations["actions/cancel-workflow-run"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": { + post: operations['actions/cancel-workflow-run'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/jobs': { /** Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). */ - get: operations["actions/list-jobs-for-workflow-run"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/logs": { + get: operations['actions/list-jobs-for-workflow-run'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/logs': { /** * Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for * `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use * this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have * the `actions:read` permission to use this endpoint. */ - get: operations["actions/download-workflow-run-logs"]; + get: operations['actions/download-workflow-run-logs'] /** Deletes all logs for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - delete: operations["actions/delete-workflow-run-logs"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments": { + delete: operations['actions/delete-workflow-run-logs'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments': { /** * Get all deployment environments for a workflow run that are waiting for protection rules to pass. * * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/get-pending-deployments-for-run"]; + get: operations['actions/get-pending-deployments-for-run'] /** * Approve or reject pending deployments that are waiting on approval by a required reviewer. * * Anyone with read access to the repository contents and deployments can use this endpoint. */ - post: operations["actions/review-pending-deployments-for-run"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun": { + post: operations['actions/review-pending-deployments-for-run'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/rerun': { /** Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - post: operations["actions/re-run-workflow"]; - }; - "/repos/{owner}/{repo}/actions/runs/{run_id}/timing": { + post: operations['actions/re-run-workflow'] + } + '/repos/{owner}/{repo}/actions/runs/{run_id}/timing': { /** * Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/get-workflow-run-usage"]; - }; - "/repos/{owner}/{repo}/actions/secrets": { + get: operations['actions/get-workflow-run-usage'] + } + '/repos/{owner}/{repo}/actions/secrets': { /** Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - get: operations["actions/list-repo-secrets"]; - }; - "/repos/{owner}/{repo}/actions/secrets/public-key": { + get: operations['actions/list-repo-secrets'] + } + '/repos/{owner}/{repo}/actions/secrets/public-key': { /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - get: operations["actions/get-repo-public-key"]; - }; - "/repos/{owner}/{repo}/actions/secrets/{secret_name}": { + get: operations['actions/get-repo-public-key'] + } + '/repos/{owner}/{repo}/actions/secrets/{secret_name}': { /** Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - get: operations["actions/get-repo-secret"]; + get: operations['actions/get-repo-secret'] /** * Creates or updates a repository secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -2429,27 +2429,27 @@ export interface paths { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - put: operations["actions/create-or-update-repo-secret"]; + put: operations['actions/create-or-update-repo-secret'] /** Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - delete: operations["actions/delete-repo-secret"]; - }; - "/repos/{owner}/{repo}/actions/workflows": { + delete: operations['actions/delete-repo-secret'] + } + '/repos/{owner}/{repo}/actions/workflows': { /** Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/list-repo-workflows"]; - }; - "/repos/{owner}/{repo}/actions/workflows/{workflow_id}": { + get: operations['actions/list-repo-workflows'] + } + '/repos/{owner}/{repo}/actions/workflows/{workflow_id}': { /** Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/get-workflow"]; - }; - "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable": { + get: operations['actions/get-workflow'] + } + '/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable': { /** * Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - put: operations["actions/disable-workflow"]; - }; - "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches": { + put: operations['actions/disable-workflow'] + } + '/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches': { /** * You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * @@ -2457,37 +2457,37 @@ export interface paths { * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)." */ - post: operations["actions/create-workflow-dispatch"]; - }; - "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable": { + post: operations['actions/create-workflow-dispatch'] + } + '/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable': { /** * Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - put: operations["actions/enable-workflow"]; - }; - "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { + put: operations['actions/enable-workflow'] + } + '/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs': { /** * List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). * * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. */ - get: operations["actions/list-workflow-runs"]; - }; - "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing": { + get: operations['actions/list-workflow-runs'] + } + '/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing': { /** * Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * * You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["actions/get-workflow-usage"]; - }; - "/repos/{owner}/{repo}/assignees": { + get: operations['actions/get-workflow-usage'] + } + '/repos/{owner}/{repo}/assignees': { /** Lists the [available assignees](https://docs.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. */ - get: operations["issues/list-assignees"]; - }; - "/repos/{owner}/{repo}/assignees/{assignee}": { + get: operations['issues/list-assignees'] + } + '/repos/{owner}/{repo}/assignees/{assignee}': { /** * Checks if a user has permission to be assigned to an issue in this repository. * @@ -2495,47 +2495,47 @@ export interface paths { * * Otherwise a `404` status code is returned. */ - get: operations["issues/check-user-can-be-assigned"]; - }; - "/repos/{owner}/{repo}/autolinks": { + get: operations['issues/check-user-can-be-assigned'] + } + '/repos/{owner}/{repo}/autolinks': { /** * This returns a list of autolinks configured for the given repository. * * Information about autolinks are only available to repository administrators. */ - get: operations["repos/list-autolinks"]; + get: operations['repos/list-autolinks'] /** Users with admin access to the repository can create an autolink. */ - post: operations["repos/create-autolink"]; - }; - "/repos/{owner}/{repo}/autolinks/{autolink_id}": { + post: operations['repos/create-autolink'] + } + '/repos/{owner}/{repo}/autolinks/{autolink_id}': { /** * This returns a single autolink reference by ID that was configured for the given repository. * * Information about autolinks are only available to repository administrators. */ - get: operations["repos/get-autolink"]; + get: operations['repos/get-autolink'] /** * This deletes a single autolink reference by ID that was configured for the given repository. * * Information about autolinks are only available to repository administrators. */ - delete: operations["repos/delete-autolink"]; - }; - "/repos/{owner}/{repo}/automated-security-fixes": { + delete: operations['repos/delete-autolink'] + } + '/repos/{owner}/{repo}/automated-security-fixes': { /** Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/en/articles/configuring-automated-security-fixes)". */ - put: operations["repos/enable-automated-security-fixes"]; + put: operations['repos/enable-automated-security-fixes'] /** Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/en/articles/configuring-automated-security-fixes)". */ - delete: operations["repos/disable-automated-security-fixes"]; - }; - "/repos/{owner}/{repo}/branches": { - get: operations["repos/list-branches"]; - }; - "/repos/{owner}/{repo}/branches/{branch}": { - get: operations["repos/get-branch"]; - }; - "/repos/{owner}/{repo}/branches/{branch}/protection": { + delete: operations['repos/disable-automated-security-fixes'] + } + '/repos/{owner}/{repo}/branches': { + get: operations['repos/list-branches'] + } + '/repos/{owner}/{repo}/branches/{branch}': { + get: operations['repos/get-branch'] + } + '/repos/{owner}/{repo}/branches/{branch}/protection': { /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - get: operations["repos/get-branch-protection"]; + get: operations['repos/get-branch-protection'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2545,31 +2545,31 @@ export interface paths { * * **Note**: The list of users, apps, and teams in total is limited to 100 items. */ - put: operations["repos/update-branch-protection"]; + put: operations['repos/update-branch-protection'] /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - delete: operations["repos/delete-branch-protection"]; - }; - "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins": { + delete: operations['repos/delete-branch-protection'] + } + '/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins': { /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - get: operations["repos/get-admin-branch-protection"]; + get: operations['repos/get-admin-branch-protection'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ - post: operations["repos/set-admin-branch-protection"]; + post: operations['repos/set-admin-branch-protection'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ - delete: operations["repos/delete-admin-branch-protection"]; - }; - "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews": { + delete: operations['repos/delete-admin-branch-protection'] + } + '/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews': { /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - get: operations["repos/get-pull-request-review-protection"]; + get: operations['repos/get-pull-request-review-protection'] /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - delete: operations["repos/delete-pull-request-review-protection"]; + delete: operations['repos/delete-pull-request-review-protection'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2577,9 +2577,9 @@ export interface paths { * * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. */ - patch: operations["repos/update-pull-request-review-protection"]; - }; - "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures": { + patch: operations['repos/update-pull-request-review-protection'] + } + '/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures': { /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2587,43 +2587,43 @@ export interface paths { * * **Note**: You must enable branch protection to require signed commits. */ - get: operations["repos/get-commit-signature-protection"]; + get: operations['repos/get-commit-signature-protection'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits. */ - post: operations["repos/create-commit-signature-protection"]; + post: operations['repos/create-commit-signature-protection'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits. */ - delete: operations["repos/delete-commit-signature-protection"]; - }; - "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks": { + delete: operations['repos/delete-commit-signature-protection'] + } + '/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks': { /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - get: operations["repos/get-status-checks-protection"]; + get: operations['repos/get-status-checks-protection'] /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - delete: operations["repos/remove-status-check-protection"]; + delete: operations['repos/remove-status-check-protection'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. */ - patch: operations["repos/update-status-check-protection"]; - }; - "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts": { + patch: operations['repos/update-status-check-protection'] + } + '/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts': { /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - get: operations["repos/get-all-status-check-contexts"]; + get: operations['repos/get-all-status-check-contexts'] /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - put: operations["repos/set-status-check-contexts"]; + put: operations['repos/set-status-check-contexts'] /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - post: operations["repos/add-status-check-contexts"]; + post: operations['repos/add-status-check-contexts'] /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - delete: operations["repos/remove-status-check-contexts"]; - }; - "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions": { + delete: operations['repos/remove-status-check-contexts'] + } + '/repos/{owner}/{repo}/branches/{branch}/protection/restrictions': { /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2631,21 +2631,21 @@ export interface paths { * * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. */ - get: operations["repos/get-access-restrictions"]; + get: operations['repos/get-access-restrictions'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Disables the ability to restrict who can push to this branch. */ - delete: operations["repos/delete-access-restrictions"]; - }; - "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps": { + delete: operations['repos/delete-access-restrictions'] + } + '/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps': { /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. */ - get: operations["repos/get-apps-with-access-to-protected-branch"]; + get: operations['repos/get-apps-with-access-to-protected-branch'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2655,7 +2655,7 @@ export interface paths { * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - put: operations["repos/set-app-access-restrictions"]; + put: operations['repos/set-app-access-restrictions'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2665,7 +2665,7 @@ export interface paths { * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - post: operations["repos/add-app-access-restrictions"]; + post: operations['repos/add-app-access-restrictions'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2675,15 +2675,15 @@ export interface paths { * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - delete: operations["repos/remove-app-access-restrictions"]; - }; - "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams": { + delete: operations['repos/remove-app-access-restrictions'] + } + '/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams': { /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the teams who have push access to this branch. The list includes child teams. */ - get: operations["repos/get-teams-with-access-to-protected-branch"]; + get: operations['repos/get-teams-with-access-to-protected-branch'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2693,7 +2693,7 @@ export interface paths { * | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ | * | `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - put: operations["repos/set-team-access-restrictions"]; + put: operations['repos/set-team-access-restrictions'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2703,7 +2703,7 @@ export interface paths { * | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ | * | `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - post: operations["repos/add-team-access-restrictions"]; + post: operations['repos/add-team-access-restrictions'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2713,15 +2713,15 @@ export interface paths { * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | Teams that should no longer have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - delete: operations["repos/remove-team-access-restrictions"]; - }; - "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users": { + delete: operations['repos/remove-team-access-restrictions'] + } + '/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users': { /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the people who have push access to this branch. */ - get: operations["repos/get-users-with-access-to-protected-branch"]; + get: operations['repos/get-users-with-access-to-protected-branch'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2731,7 +2731,7 @@ export interface paths { * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - put: operations["repos/set-user-access-restrictions"]; + put: operations['repos/set-user-access-restrictions'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2741,7 +2741,7 @@ export interface paths { * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - post: operations["repos/add-user-access-restrictions"]; + post: operations['repos/add-user-access-restrictions'] /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -2751,9 +2751,9 @@ export interface paths { * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - delete: operations["repos/remove-user-access-restrictions"]; - }; - "/repos/{owner}/{repo}/branches/{branch}/rename": { + delete: operations['repos/remove-user-access-restrictions'] + } + '/repos/{owner}/{repo}/branches/{branch}/rename': { /** * Renames a branch in a repository. * @@ -2771,9 +2771,9 @@ export interface paths { * * Users must have admin or owner permissions. * * GitHub Apps must have the `administration:write` repository permission. */ - post: operations["repos/rename-branch"]; - }; - "/repos/{owner}/{repo}/check-runs": { + post: operations['repos/rename-branch'] + } + '/repos/{owner}/{repo}/check-runs': { /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * @@ -2781,71 +2781,71 @@ export interface paths { * * In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. */ - post: operations["checks/create"]; - }; - "/repos/{owner}/{repo}/check-runs/{check_run_id}": { + post: operations['checks/create'] + } + '/repos/{owner}/{repo}/check-runs/{check_run_id}': { /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * Gets a single check run using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. */ - get: operations["checks/get"]; + get: operations['checks/get'] /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. */ - patch: operations["checks/update"]; - }; - "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations": { + patch: operations['checks/update'] + } + '/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations': { /** Lists annotations for a check run using the annotation `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the `repo` scope to get annotations for a check run in a private repository. */ - get: operations["checks/list-annotations"]; - }; - "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest": { + get: operations['checks/list-annotations'] + } + '/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest': { /** * Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * * To rerequest a check run, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository. */ - post: operations["checks/rerequest-run"]; - }; - "/repos/{owner}/{repo}/check-suites": { + post: operations['checks/rerequest-run'] + } + '/repos/{owner}/{repo}/check-suites': { /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * * By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/reference/checks#check-runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/reference/checks#update-repository-preferences-for-check-suites)". Your GitHub App must have the `checks:write` permission to create check suites. */ - post: operations["checks/create-suite"]; - }; - "/repos/{owner}/{repo}/check-suites/preferences": { + post: operations['checks/create-suite'] + } + '/repos/{owner}/{repo}/check-suites/preferences': { /** Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/reference/checks#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites. */ - patch: operations["checks/set-suites-preferences"]; - }; - "/repos/{owner}/{repo}/check-suites/{check_suite_id}": { + patch: operations['checks/set-suites-preferences'] + } + '/repos/{owner}/{repo}/check-suites/{check_suite_id}': { /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * * Gets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository. */ - get: operations["checks/get-suite"]; - }; - "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": { + get: operations['checks/get-suite'] + } + '/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs': { /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. */ - get: operations["checks/list-for-suite"]; - }; - "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest": { + get: operations['checks/list-for-suite'] + } + '/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest': { /** * Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * * To rerequest a check suite, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository. */ - post: operations["checks/rerequest-suite"]; - }; - "/repos/{owner}/{repo}/code-scanning/alerts": { + post: operations['checks/rerequest-suite'] + } + '/repos/{owner}/{repo}/code-scanning/alerts': { /** * Lists all open code scanning alerts for the default branch (usually `main` * or `master`). You must use an access token with the `security_events` scope to use @@ -2858,29 +2858,29 @@ export interface paths { * for the default branch or for the specified Git reference * (if you used `ref` in the request). */ - get: operations["code-scanning/list-alerts-for-repo"]; - }; - "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}": { + get: operations['code-scanning/list-alerts-for-repo'] + } + '/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}': { /** * Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint. * * **Deprecation notice**: * The instances field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The same information can now be retrieved via a GET request to the URL specified by `instances_url`. */ - get: operations["code-scanning/get-alert"]; + get: operations['code-scanning/get-alert'] /** Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. */ - patch: operations["code-scanning/update-alert"]; - }; - "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances": { + patch: operations['code-scanning/update-alert'] + } + '/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances': { /** * Lists all instances of the specified code scanning alert. * You must use an access token with the `security_events` scope to use this endpoint with private repos, * the `public_repo` scope also grants permission to read security events on public repos only. * GitHub Apps must have the `security_events` read permission to use this endpoint. */ - get: operations["code-scanning/list-alert-instances"]; - }; - "/repos/{owner}/{repo}/code-scanning/analyses": { + get: operations['code-scanning/list-alert-instances'] + } + '/repos/{owner}/{repo}/code-scanning/analyses': { /** * Lists the details of all code scanning analyses for a repository, * starting with the most recent. @@ -2900,9 +2900,9 @@ export interface paths { * **Deprecation notice**: * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. */ - get: operations["code-scanning/list-recent-analyses"]; - }; - "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}": { + get: operations['code-scanning/list-recent-analyses'] + } + '/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}': { /** * Gets a specified code scanning analysis for a repository. * You must use an access token with the `security_events` scope to use this endpoint with private repos, @@ -2924,7 +2924,7 @@ export interface paths { * This is formatted as * [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). */ - get: operations["code-scanning/get-analysis"]; + get: operations['code-scanning/get-analysis'] /** * Deletes a specified code scanning analysis from a repository. For * private repositories, you must use an access token with the `repo` scope. For public repositories, @@ -2993,9 +2993,9 @@ export interface paths { * * The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely. */ - delete: operations["code-scanning/delete-analysis"]; - }; - "/repos/{owner}/{repo}/code-scanning/sarifs": { + delete: operations['code-scanning/delete-analysis'] + } + '/repos/{owner}/{repo}/code-scanning/sarifs': { /** * Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. * @@ -3015,27 +3015,27 @@ export interface paths { * You can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint. * For more information, see "[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload)." */ - post: operations["code-scanning/upload-sarif"]; - }; - "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}": { + post: operations['code-scanning/upload-sarif'] + } + '/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}': { /** Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository)." You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint. */ - get: operations["code-scanning/get-sarif"]; - }; - "/repos/{owner}/{repo}/codespaces": { + get: operations['code-scanning/get-sarif'] + } + '/repos/{owner}/{repo}/codespaces': { /** * Lists the codespaces associated to a specified repository and the authenticated user. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - get: operations["codespaces/list-in-repository-for-authenticated-user"]; + get: operations['codespaces/list-in-repository-for-authenticated-user'] /** * Creates a codespace owned by the authenticated user in the specified repository. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - post: operations["codespaces/create-with-repo-for-authenticated-user"]; - }; - "/repos/{owner}/{repo}/codespaces/machines": { + post: operations['codespaces/create-with-repo-for-authenticated-user'] + } + '/repos/{owner}/{repo}/codespaces/machines': { /** * List the machine types available for a given repository based on its configuration. * @@ -3043,9 +3043,9 @@ export interface paths { * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - get: operations["codespaces/repo-machines-for-authenticated-user"]; - }; - "/repos/{owner}/{repo}/collaborators": { + get: operations['codespaces/repo-machines-for-authenticated-user'] + } + '/repos/{owner}/{repo}/collaborators': { /** * For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. * @@ -3055,9 +3055,9 @@ export interface paths { * endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this * endpoint. */ - get: operations["repos/list-collaborators"]; - }; - "/repos/{owner}/{repo}/collaborators/{username}": { + get: operations['repos/list-collaborators'] + } + '/repos/{owner}/{repo}/collaborators/{username}': { /** * For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. * @@ -3067,7 +3067,7 @@ export interface paths { * endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this * endpoint. */ - get: operations["repos/check-collaborator"]; + get: operations['repos/check-collaborator'] /** * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. * @@ -3085,41 +3085,41 @@ export interface paths { * * You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository. */ - put: operations["repos/add-collaborator"]; - delete: operations["repos/remove-collaborator"]; - }; - "/repos/{owner}/{repo}/collaborators/{username}/permission": { + put: operations['repos/add-collaborator'] + delete: operations['repos/remove-collaborator'] + } + '/repos/{owner}/{repo}/collaborators/{username}/permission': { /** Checks the repository permission of a collaborator. The possible repository permissions are `admin`, `write`, `read`, and `none`. */ - get: operations["repos/get-collaborator-permission-level"]; - }; - "/repos/{owner}/{repo}/comments": { + get: operations['repos/get-collaborator-permission-level'] + } + '/repos/{owner}/{repo}/comments': { /** * Commit Comments use [these custom media types](https://docs.github.com/rest/reference/repos#custom-media-types). You can read more about the use of media types in the API [here](https://docs.github.com/rest/overview/media-types/). * * Comments are ordered by ascending ID. */ - get: operations["repos/list-commit-comments-for-repo"]; - }; - "/repos/{owner}/{repo}/comments/{comment_id}": { - get: operations["repos/get-commit-comment"]; - delete: operations["repos/delete-commit-comment"]; - patch: operations["repos/update-commit-comment"]; - }; - "/repos/{owner}/{repo}/comments/{comment_id}/reactions": { + get: operations['repos/list-commit-comments-for-repo'] + } + '/repos/{owner}/{repo}/comments/{comment_id}': { + get: operations['repos/get-commit-comment'] + delete: operations['repos/delete-commit-comment'] + patch: operations['repos/update-commit-comment'] + } + '/repos/{owner}/{repo}/comments/{comment_id}/reactions': { /** List the reactions to a [commit comment](https://docs.github.com/rest/reference/repos#comments). */ - get: operations["reactions/list-for-commit-comment"]; + get: operations['reactions/list-for-commit-comment'] /** Create a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. */ - post: operations["reactions/create-for-commit-comment"]; - }; - "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}": { + post: operations['reactions/create-for-commit-comment'] + } + '/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}': { /** * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. * * Delete a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). */ - delete: operations["reactions/delete-for-commit-comment"]; - }; - "/repos/{owner}/{repo}/commits": { + delete: operations['reactions/delete-for-commit-comment'] + } + '/repos/{owner}/{repo}/commits': { /** * **Signature verification object** * @@ -3150,31 +3150,31 @@ export interface paths { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - get: operations["repos/list-commits"]; - }; - "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head": { + get: operations['repos/list-commits'] + } + '/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head': { /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. */ - get: operations["repos/list-branches-for-head-commit"]; - }; - "/repos/{owner}/{repo}/commits/{commit_sha}/comments": { + get: operations['repos/list-branches-for-head-commit'] + } + '/repos/{owner}/{repo}/commits/{commit_sha}/comments': { /** Use the `:commit_sha` to specify the commit that will have its comments listed. */ - get: operations["repos/list-comments-for-commit"]; + get: operations['repos/list-comments-for-commit'] /** * Create a comment for a commit using its `:commit_sha`. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - post: operations["repos/create-commit-comment"]; - }; - "/repos/{owner}/{repo}/commits/{commit_sha}/pulls": { + post: operations['repos/create-commit-comment'] + } + '/repos/{owner}/{repo}/commits/{commit_sha}/pulls': { /** Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the [List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests) endpoint. */ - get: operations["repos/list-pull-requests-associated-with-commit"]; - }; - "/repos/{owner}/{repo}/commits/{ref}": { + get: operations['repos/list-pull-requests-associated-with-commit'] + } + '/repos/{owner}/{repo}/commits/{ref}': { /** * Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. * @@ -3213,25 +3213,25 @@ export interface paths { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - get: operations["repos/get-commit"]; - }; - "/repos/{owner}/{repo}/commits/{ref}/check-runs": { + get: operations['repos/get-commit'] + } + '/repos/{owner}/{repo}/commits/{ref}/check-runs': { /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. */ - get: operations["checks/list-for-ref"]; - }; - "/repos/{owner}/{repo}/commits/{ref}/check-suites": { + get: operations['checks/list-for-ref'] + } + '/repos/{owner}/{repo}/commits/{ref}/check-suites': { /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * * Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository. */ - get: operations["checks/list-suites-for-ref"]; - }; - "/repos/{owner}/{repo}/commits/{ref}/status": { + get: operations['checks/list-suites-for-ref'] + } + '/repos/{owner}/{repo}/commits/{ref}/status': { /** * Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. * @@ -3242,17 +3242,17 @@ export interface paths { * * **pending** if there are no statuses or a context is `pending` * * **success** if the latest status for all contexts is `success` */ - get: operations["repos/get-combined-status-for-ref"]; - }; - "/repos/{owner}/{repo}/commits/{ref}/statuses": { + get: operations['repos/get-combined-status-for-ref'] + } + '/repos/{owner}/{repo}/commits/{ref}/statuses': { /** * Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one. * * This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`. */ - get: operations["repos/list-commit-statuses-for-ref"]; - }; - "/repos/{owner}/{repo}/community/profile": { + get: operations['repos/list-commit-statuses-for-ref'] + } + '/repos/{owner}/{repo}/community/profile': { /** * This endpoint will return all community profile metrics, including an * overall health score, repository description, the presence of documentation, detected @@ -3267,9 +3267,9 @@ export interface paths { * * `content_reports_enabled` is only returned for organization-owned repositories. */ - get: operations["repos/get-community-profile-metrics"]; - }; - "/repos/{owner}/{repo}/compare/{basehead}": { + get: operations['repos/get-community-profile-metrics'] + } + '/repos/{owner}/{repo}/compare/{basehead}': { /** * The `basehead` param is comprised of two parts: `base` and `head`. Both must be branch names in `repo`. To compare branches across other repositories in the same network as `repo`, use the format `:branch`. * @@ -3312,9 +3312,9 @@ export interface paths { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - get: operations["repos/compare-commits"]; - }; - "/repos/{owner}/{repo}/contents/{path}": { + get: operations['repos/compare-commits'] + } + '/repos/{owner}/{repo}/contents/{path}': { /** * Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit * `:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. @@ -3349,9 +3349,9 @@ export interface paths { * If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the * github.com URLs (`html_url` and `_links["html"]`) will have null values. */ - get: operations["repos/get-content"]; + get: operations['repos/get-content'] /** Creates a new file or replaces an existing file in a repository. */ - put: operations["repos/create-or-update-file-contents"]; + put: operations['repos/create-or-update-file-contents'] /** * Deletes a file in a repository. * @@ -3361,27 +3361,27 @@ export interface paths { * * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. */ - delete: operations["repos/delete-file"]; - }; - "/repos/{owner}/{repo}/contributors": { + delete: operations['repos/delete-file'] + } + '/repos/{owner}/{repo}/contributors': { /** * Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance. * * GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information. */ - get: operations["repos/list-contributors"]; - }; - "/repos/{owner}/{repo}/dependabot/secrets": { + get: operations['repos/list-contributors'] + } + '/repos/{owner}/{repo}/dependabot/secrets': { /** Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */ - get: operations["dependabot/list-repo-secrets"]; - }; - "/repos/{owner}/{repo}/dependabot/secrets/public-key": { + get: operations['dependabot/list-repo-secrets'] + } + '/repos/{owner}/{repo}/dependabot/secrets/public-key': { /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */ - get: operations["dependabot/get-repo-public-key"]; - }; - "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}": { + get: operations['dependabot/get-repo-public-key'] + } + '/repos/{owner}/{repo}/dependabot/secrets/{secret_name}': { /** Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */ - get: operations["dependabot/get-repo-secret"]; + get: operations['dependabot/get-repo-secret'] /** * Creates or updates a repository secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -3459,13 +3459,13 @@ export interface paths { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - put: operations["dependabot/create-or-update-repo-secret"]; + put: operations['dependabot/create-or-update-repo-secret'] /** Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */ - delete: operations["dependabot/delete-repo-secret"]; - }; - "/repos/{owner}/{repo}/deployments": { + delete: operations['dependabot/delete-repo-secret'] + } + '/repos/{owner}/{repo}/deployments': { /** Simple filtering of deployments is available via query parameters: */ - get: operations["repos/list-deployments"]; + get: operations['repos/list-deployments'] /** * Deployments offer a few configurable parameters with certain defaults. * @@ -3513,10 +3513,10 @@ export interface paths { * This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` * status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. */ - post: operations["repos/create-deployment"]; - }; - "/repos/{owner}/{repo}/deployments/{deployment_id}": { - get: operations["repos/get-deployment"]; + post: operations['repos/create-deployment'] + } + '/repos/{owner}/{repo}/deployments/{deployment_id}': { + get: operations['repos/get-deployment'] /** * If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. Anyone with `repo` or `repo_deployment` scopes can delete a deployment. * @@ -3527,23 +3527,23 @@ export interface paths { * * For more information, see "[Create a deployment](https://docs.github.com/rest/reference/repos/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/reference/repos#create-a-deployment-status)." */ - delete: operations["repos/delete-deployment"]; - }; - "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses": { + delete: operations['repos/delete-deployment'] + } + '/repos/{owner}/{repo}/deployments/{deployment_id}/statuses': { /** Users with pull access can view deployment statuses for a deployment: */ - get: operations["repos/list-deployment-statuses"]; + get: operations['repos/list-deployment-statuses'] /** * Users with `push` access can create deployment statuses for a given deployment. * * GitHub Apps require `read & write` access to "Deployments" and `read-only` access to "Repo contents" (for private repos). OAuth Apps require the `repo_deployment` scope. */ - post: operations["repos/create-deployment-status"]; - }; - "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}": { + post: operations['repos/create-deployment-status'] + } + '/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}': { /** Users with pull access can view a deployment status for a deployment: */ - get: operations["repos/get-deployment-status"]; - }; - "/repos/{owner}/{repo}/dispatches": { + get: operations['repos/get-deployment-status'] + } + '/repos/{owner}/{repo}/dispatches': { /** * You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/webhooks/event-payloads/#repository_dispatch)." * @@ -3556,19 +3556,19 @@ export interface paths { * * This input example shows how you can use the `client_payload` as a test to debug your workflow. */ - post: operations["repos/create-dispatch-event"]; - }; - "/repos/{owner}/{repo}/environments": { + post: operations['repos/create-dispatch-event'] + } + '/repos/{owner}/{repo}/environments': { /** * Get all environments for a repository. * * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["repos/get-all-environments"]; - }; - "/repos/{owner}/{repo}/environments/{environment_name}": { + get: operations['repos/get-all-environments'] + } + '/repos/{owner}/{repo}/environments/{environment_name}': { /** Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - get: operations["repos/get-environment"]; + get: operations['repos/get-environment'] /** * Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)." * @@ -3578,34 +3578,34 @@ export interface paths { * * You must authenticate using an access token with the repo scope to use this endpoint. */ - put: operations["repos/create-or-update-environment"]; + put: operations['repos/create-or-update-environment'] /** You must authenticate using an access token with the repo scope to use this endpoint. */ - delete: operations["repos/delete-an-environment"]; - }; - "/repos/{owner}/{repo}/events": { - get: operations["activity/list-repo-events"]; - }; - "/repos/{owner}/{repo}/forks": { - get: operations["repos/list-forks"]; + delete: operations['repos/delete-an-environment'] + } + '/repos/{owner}/{repo}/events': { + get: operations['activity/list-repo-events'] + } + '/repos/{owner}/{repo}/forks': { + get: operations['repos/list-forks'] /** * Create a fork for the authenticated user. * * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). */ - post: operations["repos/create-fork"]; - }; - "/repos/{owner}/{repo}/git/blobs": { - post: operations["git/create-blob"]; - }; - "/repos/{owner}/{repo}/git/blobs/{file_sha}": { + post: operations['repos/create-fork'] + } + '/repos/{owner}/{repo}/git/blobs': { + post: operations['git/create-blob'] + } + '/repos/{owner}/{repo}/git/blobs/{file_sha}': { /** * The `content` in the response will always be Base64 encoded. * * _Note_: This API supports blobs up to 100 megabytes in size. */ - get: operations["git/get-blob"]; - }; - "/repos/{owner}/{repo}/git/commits": { + get: operations['git/get-blob'] + } + '/repos/{owner}/{repo}/git/commits': { /** * Creates a new Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects). * @@ -3638,9 +3638,9 @@ export interface paths { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - post: operations["git/create-commit"]; - }; - "/repos/{owner}/{repo}/git/commits/{commit_sha}": { + post: operations['git/create-commit'] + } + '/repos/{owner}/{repo}/git/commits/{commit_sha}': { /** * Gets a Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects). * @@ -3673,9 +3673,9 @@ export interface paths { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - get: operations["git/get-commit"]; - }; - "/repos/{owner}/{repo}/git/matching-refs/{ref}": { + get: operations['git/get-commit'] + } + '/repos/{owner}/{repo}/git/matching-refs/{ref}': { /** * Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array. * @@ -3685,25 +3685,25 @@ export interface paths { * * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. */ - get: operations["git/list-matching-refs"]; - }; - "/repos/{owner}/{repo}/git/ref/{ref}": { + get: operations['git/list-matching-refs'] + } + '/repos/{owner}/{repo}/git/ref/{ref}': { /** * Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. * * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". */ - get: operations["git/get-ref"]; - }; - "/repos/{owner}/{repo}/git/refs": { + get: operations['git/get-ref'] + } + '/repos/{owner}/{repo}/git/refs': { /** Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches. */ - post: operations["git/create-ref"]; - }; - "/repos/{owner}/{repo}/git/refs/{ref}": { - delete: operations["git/delete-ref"]; - patch: operations["git/update-ref"]; - }; - "/repos/{owner}/{repo}/git/tags": { + post: operations['git/create-ref'] + } + '/repos/{owner}/{repo}/git/refs/{ref}': { + delete: operations['git/delete-ref'] + patch: operations['git/update-ref'] + } + '/repos/{owner}/{repo}/git/tags': { /** * Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/rest/reference/git#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/rest/reference/git#create-a-reference) the tag reference - this call would be unnecessary. * @@ -3736,9 +3736,9 @@ export interface paths { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - post: operations["git/create-tag"]; - }; - "/repos/{owner}/{repo}/git/tags/{tag_sha}": { + post: operations['git/create-tag'] + } + '/repos/{owner}/{repo}/git/tags/{tag_sha}': { /** * **Signature verification object** * @@ -3769,78 +3769,78 @@ export interface paths { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - get: operations["git/get-tag"]; - }; - "/repos/{owner}/{repo}/git/trees": { + get: operations['git/get-tag'] + } + '/repos/{owner}/{repo}/git/trees': { /** * The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure. * * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/rest/reference/git#create-a-commit)" and "[Update a reference](https://docs.github.com/rest/reference/git#update-a-reference)." */ - post: operations["git/create-tree"]; - }; - "/repos/{owner}/{repo}/git/trees/{tree_sha}": { + post: operations['git/create-tree'] + } + '/repos/{owner}/{repo}/git/trees/{tree_sha}': { /** * Returns a single tree using the SHA1 value for that tree. * * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. */ - get: operations["git/get-tree"]; - }; - "/repos/{owner}/{repo}/hooks": { - get: operations["repos/list-webhooks"]; + get: operations['git/get-tree'] + } + '/repos/{owner}/{repo}/hooks': { + get: operations['repos/list-webhooks'] /** * Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can * share the same `config` as long as those webhooks do not have any `events` that overlap. */ - post: operations["repos/create-webhook"]; - }; - "/repos/{owner}/{repo}/hooks/{hook_id}": { + post: operations['repos/create-webhook'] + } + '/repos/{owner}/{repo}/hooks/{hook_id}': { /** Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/reference/repos#get-a-webhook-configuration-for-a-repository)." */ - get: operations["repos/get-webhook"]; - delete: operations["repos/delete-webhook"]; + get: operations['repos/get-webhook'] + delete: operations['repos/delete-webhook'] /** Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/reference/repos#update-a-webhook-configuration-for-a-repository)." */ - patch: operations["repos/update-webhook"]; - }; - "/repos/{owner}/{repo}/hooks/{hook_id}/config": { + patch: operations['repos/update-webhook'] + } + '/repos/{owner}/{repo}/hooks/{hook_id}/config': { /** * Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/reference/orgs#get-a-repository-webhook)." * * Access tokens must have the `read:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:read` permission. */ - get: operations["repos/get-webhook-config-for-repo"]; + get: operations['repos/get-webhook-config-for-repo'] /** * Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/reference/orgs#update-a-repository-webhook)." * * Access tokens must have the `write:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:write` permission. */ - patch: operations["repos/update-webhook-config-for-repo"]; - }; - "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries": { + patch: operations['repos/update-webhook-config-for-repo'] + } + '/repos/{owner}/{repo}/hooks/{hook_id}/deliveries': { /** Returns a list of webhook deliveries for a webhook configured in a repository. */ - get: operations["repos/list-webhook-deliveries"]; - }; - "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}": { + get: operations['repos/list-webhook-deliveries'] + } + '/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}': { /** Returns a delivery for a webhook configured in a repository. */ - get: operations["repos/get-webhook-delivery"]; - }; - "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { + get: operations['repos/get-webhook-delivery'] + } + '/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts': { /** Redeliver a webhook delivery for a webhook configured in a repository. */ - post: operations["repos/redeliver-webhook-delivery"]; - }; - "/repos/{owner}/{repo}/hooks/{hook_id}/pings": { + post: operations['repos/redeliver-webhook-delivery'] + } + '/repos/{owner}/{repo}/hooks/{hook_id}/pings': { /** This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. */ - post: operations["repos/ping-webhook"]; - }; - "/repos/{owner}/{repo}/hooks/{hook_id}/tests": { + post: operations['repos/ping-webhook'] + } + '/repos/{owner}/{repo}/hooks/{hook_id}/tests': { /** * This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. * * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` */ - post: operations["repos/test-push-webhook"]; - }; - "/repos/{owner}/{repo}/import": { + post: operations['repos/test-push-webhook'] + } + '/repos/{owner}/{repo}/import': { /** * View the progress of an import. * @@ -3877,62 +3877,62 @@ export interface paths { * * `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository. * * `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a "Get Large Files" request. */ - get: operations["migrations/get-import-status"]; + get: operations['migrations/get-import-status'] /** Start a source import to a GitHub repository using GitHub Importer. */ - put: operations["migrations/start-import"]; + put: operations['migrations/start-import'] /** Stop an import for a repository. */ - delete: operations["migrations/cancel-import"]; + delete: operations['migrations/cancel-import'] /** * An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API * request. If no parameters are provided, the import will be restarted. */ - patch: operations["migrations/update-import"]; - }; - "/repos/{owner}/{repo}/import/authors": { + patch: operations['migrations/update-import'] + } + '/repos/{owner}/{repo}/import/authors': { /** * Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `. * * This endpoint and the [Map a commit author](https://docs.github.com/rest/reference/migrations#map-a-commit-author) endpoint allow you to provide correct Git author information. */ - get: operations["migrations/get-commit-authors"]; - }; - "/repos/{owner}/{repo}/import/authors/{author_id}": { + get: operations['migrations/get-commit-authors'] + } + '/repos/{owner}/{repo}/import/authors/{author_id}': { /** Update an author's identity for the import. Your application can continue updating authors any time before you push new commits to the repository. */ - patch: operations["migrations/map-commit-author"]; - }; - "/repos/{owner}/{repo}/import/large_files": { + patch: operations['migrations/map-commit-author'] + } + '/repos/{owner}/{repo}/import/large_files': { /** List files larger than 100MB found during the import */ - get: operations["migrations/get-large-files"]; - }; - "/repos/{owner}/{repo}/import/lfs": { + get: operations['migrations/get-large-files'] + } + '/repos/{owner}/{repo}/import/lfs': { /** You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability is powered by [Git LFS](https://git-lfs.github.com). You can learn more about our LFS feature and working with large files [on our help site](https://docs.github.com/articles/versioning-large-files/). */ - patch: operations["migrations/set-lfs-preference"]; - }; - "/repos/{owner}/{repo}/installation": { + patch: operations['migrations/set-lfs-preference'] + } + '/repos/{owner}/{repo}/installation': { /** * Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - get: operations["apps/get-repo-installation"]; - }; - "/repos/{owner}/{repo}/interaction-limits": { + get: operations['apps/get-repo-installation'] + } + '/repos/{owner}/{repo}/interaction-limits': { /** Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response. */ - get: operations["interactions/get-restrictions-for-repo"]; + get: operations['interactions/get-restrictions-for-repo'] /** Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. */ - put: operations["interactions/set-restrictions-for-repo"]; + put: operations['interactions/set-restrictions-for-repo'] /** Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. */ - delete: operations["interactions/remove-restrictions-for-repo"]; - }; - "/repos/{owner}/{repo}/invitations": { + delete: operations['interactions/remove-restrictions-for-repo'] + } + '/repos/{owner}/{repo}/invitations': { /** When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations. */ - get: operations["repos/list-invitations"]; - }; - "/repos/{owner}/{repo}/invitations/{invitation_id}": { - delete: operations["repos/delete-invitation"]; - patch: operations["repos/update-invitation"]; - }; - "/repos/{owner}/{repo}/issues": { + get: operations['repos/list-invitations'] + } + '/repos/{owner}/{repo}/invitations/{invitation_id}': { + delete: operations['repos/delete-invitation'] + patch: operations['repos/update-invitation'] + } + '/repos/{owner}/{repo}/issues': { /** * List issues in a repository. * @@ -3941,44 +3941,44 @@ export interface paths { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - get: operations["issues/list-for-repo"]; + get: operations['issues/list-for-repo'] /** * Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - post: operations["issues/create"]; - }; - "/repos/{owner}/{repo}/issues/comments": { + post: operations['issues/create'] + } + '/repos/{owner}/{repo}/issues/comments': { /** By default, Issue Comments are ordered by ascending ID. */ - get: operations["issues/list-comments-for-repo"]; - }; - "/repos/{owner}/{repo}/issues/comments/{comment_id}": { - get: operations["issues/get-comment"]; - delete: operations["issues/delete-comment"]; - patch: operations["issues/update-comment"]; - }; - "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": { + get: operations['issues/list-comments-for-repo'] + } + '/repos/{owner}/{repo}/issues/comments/{comment_id}': { + get: operations['issues/get-comment'] + delete: operations['issues/delete-comment'] + patch: operations['issues/update-comment'] + } + '/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions': { /** List the reactions to an [issue comment](https://docs.github.com/rest/reference/issues#comments). */ - get: operations["reactions/list-for-issue-comment"]; + get: operations['reactions/list-for-issue-comment'] /** Create a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. */ - post: operations["reactions/create-for-issue-comment"]; - }; - "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}": { + post: operations['reactions/create-for-issue-comment'] + } + '/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}': { /** * **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. * * Delete a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). */ - delete: operations["reactions/delete-for-issue-comment"]; - }; - "/repos/{owner}/{repo}/issues/events": { - get: operations["issues/list-events-for-repo"]; - }; - "/repos/{owner}/{repo}/issues/events/{event_id}": { - get: operations["issues/get-event"]; - }; - "/repos/{owner}/{repo}/issues/{issue_number}": { + delete: operations['reactions/delete-for-issue-comment'] + } + '/repos/{owner}/{repo}/issues/events': { + get: operations['issues/list-events-for-repo'] + } + '/repos/{owner}/{repo}/issues/events/{event_id}': { + get: operations['issues/get-event'] + } + '/repos/{owner}/{repo}/issues/{issue_number}': { /** * The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was * [transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If @@ -3992,147 +3992,147 @@ export interface paths { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - get: operations["issues/get"]; + get: operations['issues/get'] /** Issue owners and users with push access can edit an issue. */ - patch: operations["issues/update"]; - }; - "/repos/{owner}/{repo}/issues/{issue_number}/assignees": { + patch: operations['issues/update'] + } + '/repos/{owner}/{repo}/issues/{issue_number}/assignees': { /** Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced. */ - post: operations["issues/add-assignees"]; + post: operations['issues/add-assignees'] /** Removes one or more assignees from an issue. */ - delete: operations["issues/remove-assignees"]; - }; - "/repos/{owner}/{repo}/issues/{issue_number}/comments": { + delete: operations['issues/remove-assignees'] + } + '/repos/{owner}/{repo}/issues/{issue_number}/comments': { /** Issue Comments are ordered by ascending ID. */ - get: operations["issues/list-comments"]; + get: operations['issues/list-comments'] /** This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - post: operations["issues/create-comment"]; - }; - "/repos/{owner}/{repo}/issues/{issue_number}/events": { - get: operations["issues/list-events"]; - }; - "/repos/{owner}/{repo}/issues/{issue_number}/labels": { - get: operations["issues/list-labels-on-issue"]; + post: operations['issues/create-comment'] + } + '/repos/{owner}/{repo}/issues/{issue_number}/events': { + get: operations['issues/list-events'] + } + '/repos/{owner}/{repo}/issues/{issue_number}/labels': { + get: operations['issues/list-labels-on-issue'] /** Removes any previous labels and sets the new labels for an issue. */ - put: operations["issues/set-labels"]; - post: operations["issues/add-labels"]; - delete: operations["issues/remove-all-labels"]; - }; - "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}": { + put: operations['issues/set-labels'] + post: operations['issues/add-labels'] + delete: operations['issues/remove-all-labels'] + } + '/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}': { /** Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist. */ - delete: operations["issues/remove-label"]; - }; - "/repos/{owner}/{repo}/issues/{issue_number}/lock": { + delete: operations['issues/remove-label'] + } + '/repos/{owner}/{repo}/issues/{issue_number}/lock': { /** * Users with push access can lock an issue or pull request's conversation. * * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - put: operations["issues/lock"]; + put: operations['issues/lock'] /** Users with push access can unlock an issue's conversation. */ - delete: operations["issues/unlock"]; - }; - "/repos/{owner}/{repo}/issues/{issue_number}/reactions": { + delete: operations['issues/unlock'] + } + '/repos/{owner}/{repo}/issues/{issue_number}/reactions': { /** List the reactions to an [issue](https://docs.github.com/rest/reference/issues). */ - get: operations["reactions/list-for-issue"]; + get: operations['reactions/list-for-issue'] /** Create a reaction to an [issue](https://docs.github.com/rest/reference/issues/). A response with an HTTP `200` status means that you already added the reaction type to this issue. */ - post: operations["reactions/create-for-issue"]; - }; - "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}": { + post: operations['reactions/create-for-issue'] + } + '/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}': { /** * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. * * Delete a reaction to an [issue](https://docs.github.com/rest/reference/issues/). */ - delete: operations["reactions/delete-for-issue"]; - }; - "/repos/{owner}/{repo}/issues/{issue_number}/timeline": { - get: operations["issues/list-events-for-timeline"]; - }; - "/repos/{owner}/{repo}/keys": { - get: operations["repos/list-deploy-keys"]; + delete: operations['reactions/delete-for-issue'] + } + '/repos/{owner}/{repo}/issues/{issue_number}/timeline': { + get: operations['issues/list-events-for-timeline'] + } + '/repos/{owner}/{repo}/keys': { + get: operations['repos/list-deploy-keys'] /** You can create a read-only deploy key. */ - post: operations["repos/create-deploy-key"]; - }; - "/repos/{owner}/{repo}/keys/{key_id}": { - get: operations["repos/get-deploy-key"]; + post: operations['repos/create-deploy-key'] + } + '/repos/{owner}/{repo}/keys/{key_id}': { + get: operations['repos/get-deploy-key'] /** Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead. */ - delete: operations["repos/delete-deploy-key"]; - }; - "/repos/{owner}/{repo}/labels": { - get: operations["issues/list-labels-for-repo"]; - post: operations["issues/create-label"]; - }; - "/repos/{owner}/{repo}/labels/{name}": { - get: operations["issues/get-label"]; - delete: operations["issues/delete-label"]; - patch: operations["issues/update-label"]; - }; - "/repos/{owner}/{repo}/languages": { + delete: operations['repos/delete-deploy-key'] + } + '/repos/{owner}/{repo}/labels': { + get: operations['issues/list-labels-for-repo'] + post: operations['issues/create-label'] + } + '/repos/{owner}/{repo}/labels/{name}': { + get: operations['issues/get-label'] + delete: operations['issues/delete-label'] + patch: operations['issues/update-label'] + } + '/repos/{owner}/{repo}/languages': { /** Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language. */ - get: operations["repos/list-languages"]; - }; - "/repos/{owner}/{repo}/lfs": { - put: operations["repos/enable-lfs-for-repo"]; - delete: operations["repos/disable-lfs-for-repo"]; - }; - "/repos/{owner}/{repo}/license": { + get: operations['repos/list-languages'] + } + '/repos/{owner}/{repo}/lfs': { + put: operations['repos/enable-lfs-for-repo'] + delete: operations['repos/disable-lfs-for-repo'] + } + '/repos/{owner}/{repo}/license': { /** * This method returns the contents of the repository's license file, if one is detected. * * Similar to [Get repository content](https://docs.github.com/rest/reference/repos#get-repository-content), this method also supports [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw license content or rendered license HTML. */ - get: operations["licenses/get-for-repo"]; - }; - "/repos/{owner}/{repo}/merge-upstream": { + get: operations['licenses/get-for-repo'] + } + '/repos/{owner}/{repo}/merge-upstream': { /** Sync a branch of a forked repository to keep it up-to-date with the upstream repository. */ - post: operations["repos/merge-upstream"]; - }; - "/repos/{owner}/{repo}/merges": { - post: operations["repos/merge"]; - }; - "/repos/{owner}/{repo}/milestones": { - get: operations["issues/list-milestones"]; - post: operations["issues/create-milestone"]; - }; - "/repos/{owner}/{repo}/milestones/{milestone_number}": { - get: operations["issues/get-milestone"]; - delete: operations["issues/delete-milestone"]; - patch: operations["issues/update-milestone"]; - }; - "/repos/{owner}/{repo}/milestones/{milestone_number}/labels": { - get: operations["issues/list-labels-for-milestone"]; - }; - "/repos/{owner}/{repo}/notifications": { + post: operations['repos/merge-upstream'] + } + '/repos/{owner}/{repo}/merges': { + post: operations['repos/merge'] + } + '/repos/{owner}/{repo}/milestones': { + get: operations['issues/list-milestones'] + post: operations['issues/create-milestone'] + } + '/repos/{owner}/{repo}/milestones/{milestone_number}': { + get: operations['issues/get-milestone'] + delete: operations['issues/delete-milestone'] + patch: operations['issues/update-milestone'] + } + '/repos/{owner}/{repo}/milestones/{milestone_number}/labels': { + get: operations['issues/list-labels-for-milestone'] + } + '/repos/{owner}/{repo}/notifications': { /** List all notifications for the current user. */ - get: operations["activity/list-repo-notifications-for-authenticated-user"]; + get: operations['activity/list-repo-notifications-for-authenticated-user'] /** Marks all notifications in a repository as "read" removes them from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ - put: operations["activity/mark-repo-notifications-as-read"]; - }; - "/repos/{owner}/{repo}/pages": { - get: operations["repos/get-pages"]; + put: operations['activity/mark-repo-notifications-as-read'] + } + '/repos/{owner}/{repo}/pages': { + get: operations['repos/get-pages'] /** Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). */ - put: operations["repos/update-information-about-pages-site"]; + put: operations['repos/update-information-about-pages-site'] /** Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)." */ - post: operations["repos/create-pages-site"]; - delete: operations["repos/delete-pages-site"]; - }; - "/repos/{owner}/{repo}/pages/builds": { - get: operations["repos/list-pages-builds"]; + post: operations['repos/create-pages-site'] + delete: operations['repos/delete-pages-site'] + } + '/repos/{owner}/{repo}/pages/builds': { + get: operations['repos/list-pages-builds'] /** * You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures. * * Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes. */ - post: operations["repos/request-pages-build"]; - }; - "/repos/{owner}/{repo}/pages/builds/latest": { - get: operations["repos/get-latest-pages-build"]; - }; - "/repos/{owner}/{repo}/pages/builds/{build_id}": { - get: operations["repos/get-pages-build"]; - }; - "/repos/{owner}/{repo}/pages/health": { + post: operations['repos/request-pages-build'] + } + '/repos/{owner}/{repo}/pages/builds/latest': { + get: operations['repos/get-latest-pages-build'] + } + '/repos/{owner}/{repo}/pages/builds/{build_id}': { + get: operations['repos/get-pages-build'] + } + '/repos/{owner}/{repo}/pages/health': { /** * Gets a health check of the DNS settings for the `CNAME` record configured for a repository's GitHub Pages. * @@ -4140,17 +4140,17 @@ export interface paths { * * Users must have admin or owner permissions. GitHub Apps must have the `pages:write` and `administration:write` permission to use this endpoint. */ - get: operations["repos/get-pages-health-check"]; - }; - "/repos/{owner}/{repo}/projects": { + get: operations['repos/get-pages-health-check'] + } + '/repos/{owner}/{repo}/projects': { /** Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - get: operations["projects/list-for-repo"]; + get: operations['projects/list-for-repo'] /** Creates a repository project board. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - post: operations["projects/create-for-repo"]; - }; - "/repos/{owner}/{repo}/pulls": { + post: operations['projects/create-for-repo'] + } + '/repos/{owner}/{repo}/pulls': { /** Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - get: operations["pulls/list"]; + get: operations['pulls/list'] /** * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -4160,35 +4160,35 @@ export interface paths { * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. */ - post: operations["pulls/create"]; - }; - "/repos/{owner}/{repo}/pulls/comments": { + post: operations['pulls/create'] + } + '/repos/{owner}/{repo}/pulls/comments': { /** Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID. */ - get: operations["pulls/list-review-comments-for-repo"]; - }; - "/repos/{owner}/{repo}/pulls/comments/{comment_id}": { + get: operations['pulls/list-review-comments-for-repo'] + } + '/repos/{owner}/{repo}/pulls/comments/{comment_id}': { /** Provides details for a review comment. */ - get: operations["pulls/get-review-comment"]; + get: operations['pulls/get-review-comment'] /** Deletes a review comment. */ - delete: operations["pulls/delete-review-comment"]; + delete: operations['pulls/delete-review-comment'] /** Enables you to edit a review comment. */ - patch: operations["pulls/update-review-comment"]; - }; - "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": { + patch: operations['pulls/update-review-comment'] + } + '/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions': { /** List the reactions to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). */ - get: operations["reactions/list-for-pull-request-review-comment"]; + get: operations['reactions/list-for-pull-request-review-comment'] /** Create a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#comments). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. */ - post: operations["reactions/create-for-pull-request-review-comment"]; - }; - "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}": { + post: operations['reactions/create-for-pull-request-review-comment'] + } + '/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}': { /** * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` * * Delete a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). */ - delete: operations["reactions/delete-for-pull-request-comment"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}": { + delete: operations['reactions/delete-for-pull-request-comment'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}': { /** * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -4206,25 +4206,25 @@ export interface paths { * * Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. */ - get: operations["pulls/get"]; + get: operations['pulls/get'] /** * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. */ - patch: operations["pulls/update"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": { + patch: operations['pulls/update'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/codespaces': { /** * Creates a codespace owned by the authenticated user for the specified pull request. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - post: operations["codespaces/create-with-pr-for-authenticated-user"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/comments": { + post: operations['codespaces/create-with-pr-for-authenticated-user'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/comments': { /** Lists all review comments for a pull request. By default, review comments are in ascending order by ID. */ - get: operations["pulls/list-review-comments"]; + get: operations['pulls/list-review-comments'] /** * Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/reference/issues#create-an-issue-comment)." We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff. * @@ -4234,38 +4234,38 @@ export interface paths { * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - post: operations["pulls/create-review-comment"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies": { + post: operations['pulls/create-review-comment'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies': { /** * Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - post: operations["pulls/create-reply-for-review-comment"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/commits": { + post: operations['pulls/create-reply-for-review-comment'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/commits': { /** Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/reference/repos#list-commits) endpoint. */ - get: operations["pulls/list-commits"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/files": { + get: operations['pulls/list-commits'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/files': { /** **Note:** Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. */ - get: operations["pulls/list-files"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/merge": { - get: operations["pulls/check-if-merged"]; + get: operations['pulls/list-files'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/merge': { + get: operations['pulls/check-if-merged'] /** This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - put: operations["pulls/merge"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { - get: operations["pulls/list-requested-reviewers"]; + put: operations['pulls/merge'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers': { + get: operations['pulls/list-requested-reviewers'] /** This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - post: operations["pulls/request-reviewers"]; - delete: operations["pulls/remove-requested-reviewers"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/reviews": { + post: operations['pulls/request-reviewers'] + delete: operations['pulls/remove-requested-reviewers'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/reviews': { /** The list of reviews returns in chronological order. */ - get: operations["pulls/list-reviews"]; + get: operations['pulls/list-reviews'] /** * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. * @@ -4275,92 +4275,92 @@ export interface paths { * * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. */ - post: operations["pulls/create-review"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}": { - get: operations["pulls/get-review"]; + post: operations['pulls/create-review'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}': { + get: operations['pulls/get-review'] /** Update the review summary comment with new text. */ - put: operations["pulls/update-review"]; - delete: operations["pulls/delete-pending-review"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments": { + put: operations['pulls/update-review'] + delete: operations['pulls/delete-pending-review'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments': { /** List comments for a specific pull request review. */ - get: operations["pulls/list-comments-for-review"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals": { + get: operations['pulls/list-comments-for-review'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals': { /** **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/reference/repos#branches), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. */ - put: operations["pulls/dismiss-review"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events": { - post: operations["pulls/submit-review"]; - }; - "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch": { + put: operations['pulls/dismiss-review'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events': { + post: operations['pulls/submit-review'] + } + '/repos/{owner}/{repo}/pulls/{pull_number}/update-branch': { /** Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. */ - put: operations["pulls/update-branch"]; - }; - "/repos/{owner}/{repo}/readme": { + put: operations['pulls/update-branch'] + } + '/repos/{owner}/{repo}/readme': { /** * Gets the preferred README for a repository. * * READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. */ - get: operations["repos/get-readme"]; - }; - "/repos/{owner}/{repo}/readme/{dir}": { + get: operations['repos/get-readme'] + } + '/repos/{owner}/{repo}/readme/{dir}': { /** * Gets the README from a repository directory. * * READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. */ - get: operations["repos/get-readme-in-directory"]; - }; - "/repos/{owner}/{repo}/releases": { + get: operations['repos/get-readme-in-directory'] + } + '/repos/{owner}/{repo}/releases': { /** * This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/rest/reference/repos#list-repository-tags). * * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. */ - get: operations["repos/list-releases"]; + get: operations['repos/list-releases'] /** * Users with push access to the repository can create a release. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - post: operations["repos/create-release"]; - }; - "/repos/{owner}/{repo}/releases/assets/{asset_id}": { + post: operations['repos/create-release'] + } + '/repos/{owner}/{repo}/releases/assets/{asset_id}': { /** To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. */ - get: operations["repos/get-release-asset"]; - delete: operations["repos/delete-release-asset"]; + get: operations['repos/get-release-asset'] + delete: operations['repos/delete-release-asset'] /** Users with push access to the repository can edit a release asset. */ - patch: operations["repos/update-release-asset"]; - }; - "/repos/{owner}/{repo}/releases/generate-notes": { + patch: operations['repos/update-release-asset'] + } + '/repos/{owner}/{repo}/releases/generate-notes': { /** Generate a name and body describing a [release](https://docs.github.com/rest/reference/repos#releases). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. */ - post: operations["repos/generate-release-notes"]; - }; - "/repos/{owner}/{repo}/releases/latest": { + post: operations['repos/generate-release-notes'] + } + '/repos/{owner}/{repo}/releases/latest': { /** * View the latest published full release for the repository. * * The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published. */ - get: operations["repos/get-latest-release"]; - }; - "/repos/{owner}/{repo}/releases/tags/{tag}": { + get: operations['repos/get-latest-release'] + } + '/repos/{owner}/{repo}/releases/tags/{tag}': { /** Get a published release with the specified tag. */ - get: operations["repos/get-release-by-tag"]; - }; - "/repos/{owner}/{repo}/releases/{release_id}": { + get: operations['repos/get-release-by-tag'] + } + '/repos/{owner}/{repo}/releases/{release_id}': { /** **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia). */ - get: operations["repos/get-release"]; + get: operations['repos/get-release'] /** Users with push access to the repository can delete a release. */ - delete: operations["repos/delete-release"]; + delete: operations['repos/delete-release'] /** Users with push access to the repository can edit a release. */ - patch: operations["repos/update-release"]; - }; - "/repos/{owner}/{repo}/releases/{release_id}/assets": { - get: operations["repos/list-release-assets"]; + patch: operations['repos/update-release'] + } + '/repos/{owner}/{repo}/releases/{release_id}/assets': { + get: operations['repos/list-release-assets'] /** * This endpoint makes use of [a Hypermedia relation](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in * the response of the [Create a release endpoint](https://docs.github.com/rest/reference/repos#create-a-release) to upload a release asset. @@ -4381,59 +4381,59 @@ export interface paths { * endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). * * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. */ - post: operations["repos/upload-release-asset"]; - }; - "/repos/{owner}/{repo}/releases/{release_id}/reactions": { + post: operations['repos/upload-release-asset'] + } + '/repos/{owner}/{repo}/releases/{release_id}/reactions': { /** Create a reaction to a [release](https://docs.github.com/rest/reference/repos#releases). A response with a `Status: 200 OK` means that you already added the reaction type to this release. */ - post: operations["reactions/create-for-release"]; - }; - "/repos/{owner}/{repo}/secret-scanning/alerts": { + post: operations['reactions/create-for-release'] + } + '/repos/{owner}/{repo}/secret-scanning/alerts': { /** * Lists secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. */ - get: operations["secret-scanning/list-alerts-for-repo"]; - }; - "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}": { + get: operations['secret-scanning/list-alerts-for-repo'] + } + '/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}': { /** * Gets a single secret scanning alert detected in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. */ - get: operations["secret-scanning/get-alert"]; + get: operations['secret-scanning/get-alert'] /** * Updates the status of a secret scanning alert in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint. */ - patch: operations["secret-scanning/update-alert"]; - }; - "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations": { + patch: operations['secret-scanning/update-alert'] + } + '/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations': { /** * Lists all locations for a given secret scanning alert for a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. */ - get: operations["secret-scanning/list-locations-for-alert"]; - }; - "/repos/{owner}/{repo}/stargazers": { + get: operations['secret-scanning/list-locations-for-alert'] + } + '/repos/{owner}/{repo}/stargazers': { /** * Lists the people that have starred the repository. * * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: */ - get: operations["activity/list-stargazers-for-repo"]; - }; - "/repos/{owner}/{repo}/stats/code_frequency": { + get: operations['activity/list-stargazers-for-repo'] + } + '/repos/{owner}/{repo}/stats/code_frequency': { /** Returns a weekly aggregate of the number of additions and deletions pushed to a repository. */ - get: operations["repos/get-code-frequency-stats"]; - }; - "/repos/{owner}/{repo}/stats/commit_activity": { + get: operations['repos/get-code-frequency-stats'] + } + '/repos/{owner}/{repo}/stats/commit_activity': { /** Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`. */ - get: operations["repos/get-commit-activity-stats"]; - }; - "/repos/{owner}/{repo}/stats/contributors": { + get: operations['repos/get-commit-activity-stats'] + } + '/repos/{owner}/{repo}/stats/contributors': { /** * Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information: * @@ -4442,17 +4442,17 @@ export interface paths { * * `d` - Number of deletions * * `c` - Number of commits */ - get: operations["repos/get-contributors-stats"]; - }; - "/repos/{owner}/{repo}/stats/participation": { + get: operations['repos/get-contributors-stats'] + } + '/repos/{owner}/{repo}/stats/participation': { /** * Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`. * * The array order is oldest week (index 0) to most recent week. */ - get: operations["repos/get-participation-stats"]; - }; - "/repos/{owner}/{repo}/stats/punch_card": { + get: operations['repos/get-participation-stats'] + } + '/repos/{owner}/{repo}/stats/punch_card': { /** * Each array contains the day number, hour number, and number of commits: * @@ -4462,84 +4462,84 @@ export interface paths { * * For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. */ - get: operations["repos/get-punch-card-stats"]; - }; - "/repos/{owner}/{repo}/statuses/{sha}": { + get: operations['repos/get-punch-card-stats'] + } + '/repos/{owner}/{repo}/statuses/{sha}': { /** * Users with push access in a repository can create commit statuses for a given SHA. * * Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error. */ - post: operations["repos/create-commit-status"]; - }; - "/repos/{owner}/{repo}/subscribers": { + post: operations['repos/create-commit-status'] + } + '/repos/{owner}/{repo}/subscribers': { /** Lists the people watching the specified repository. */ - get: operations["activity/list-watchers-for-repo"]; - }; - "/repos/{owner}/{repo}/subscription": { - get: operations["activity/get-repo-subscription"]; + get: operations['activity/list-watchers-for-repo'] + } + '/repos/{owner}/{repo}/subscription': { + get: operations['activity/get-repo-subscription'] /** If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/rest/reference/activity#delete-a-repository-subscription) completely. */ - put: operations["activity/set-repo-subscription"]; + put: operations['activity/set-repo-subscription'] /** This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/rest/reference/activity#set-a-repository-subscription). */ - delete: operations["activity/delete-repo-subscription"]; - }; - "/repos/{owner}/{repo}/tags": { - get: operations["repos/list-tags"]; - }; - "/repos/{owner}/{repo}/tarball/{ref}": { + delete: operations['activity/delete-repo-subscription'] + } + '/repos/{owner}/{repo}/tags': { + get: operations['repos/list-tags'] + } + '/repos/{owner}/{repo}/tarball/{ref}': { /** * Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually * `master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. * **Note**: For private repositories, these links are temporary and expire after five minutes. */ - get: operations["repos/download-tarball-archive"]; - }; - "/repos/{owner}/{repo}/teams": { - get: operations["repos/list-teams"]; - }; - "/repos/{owner}/{repo}/topics": { - get: operations["repos/get-all-topics"]; - put: operations["repos/replace-all-topics"]; - }; - "/repos/{owner}/{repo}/traffic/clones": { + get: operations['repos/download-tarball-archive'] + } + '/repos/{owner}/{repo}/teams': { + get: operations['repos/list-teams'] + } + '/repos/{owner}/{repo}/topics': { + get: operations['repos/get-all-topics'] + put: operations['repos/replace-all-topics'] + } + '/repos/{owner}/{repo}/traffic/clones': { /** Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. */ - get: operations["repos/get-clones"]; - }; - "/repos/{owner}/{repo}/traffic/popular/paths": { + get: operations['repos/get-clones'] + } + '/repos/{owner}/{repo}/traffic/popular/paths': { /** Get the top 10 popular contents over the last 14 days. */ - get: operations["repos/get-top-paths"]; - }; - "/repos/{owner}/{repo}/traffic/popular/referrers": { + get: operations['repos/get-top-paths'] + } + '/repos/{owner}/{repo}/traffic/popular/referrers': { /** Get the top 10 referrers over the last 14 days. */ - get: operations["repos/get-top-referrers"]; - }; - "/repos/{owner}/{repo}/traffic/views": { + get: operations['repos/get-top-referrers'] + } + '/repos/{owner}/{repo}/traffic/views': { /** Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. */ - get: operations["repos/get-views"]; - }; - "/repos/{owner}/{repo}/transfer": { + get: operations['repos/get-views'] + } + '/repos/{owner}/{repo}/transfer': { /** A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/). */ - post: operations["repos/transfer"]; - }; - "/repos/{owner}/{repo}/vulnerability-alerts": { + post: operations['repos/transfer'] + } + '/repos/{owner}/{repo}/vulnerability-alerts': { /** Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". */ - get: operations["repos/check-vulnerability-alerts"]; + get: operations['repos/check-vulnerability-alerts'] /** Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". */ - put: operations["repos/enable-vulnerability-alerts"]; + put: operations['repos/enable-vulnerability-alerts'] /** Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". */ - delete: operations["repos/disable-vulnerability-alerts"]; - }; - "/repos/{owner}/{repo}/zipball/{ref}": { + delete: operations['repos/disable-vulnerability-alerts'] + } + '/repos/{owner}/{repo}/zipball/{ref}': { /** * Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually * `master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. * **Note**: For private repositories, these links are temporary and expire after five minutes. */ - get: operations["repos/download-zipball-archive"]; - }; - "/repos/{template_owner}/{template_repo}/generate": { + get: operations['repos/download-zipball-archive'] + } + '/repos/{template_owner}/{template_repo}/generate': { /** * Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. * @@ -4550,9 +4550,9 @@ export interface paths { * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. * * `repo` scope to create a private repository */ - post: operations["repos/create-using-template"]; - }; - "/repositories": { + post: operations['repos/create-using-template'] + } + '/repositories': { /** * Lists all public repositories in the order that they were created. * @@ -4560,19 +4560,19 @@ export interface paths { * - For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories. */ - get: operations["repos/list-public"]; - }; - "/repositories/{repository_id}/environments/{environment_name}/secrets": { + get: operations['repos/list-public'] + } + '/repositories/{repository_id}/environments/{environment_name}/secrets': { /** Lists all secrets available in an environment without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - get: operations["actions/list-environment-secrets"]; - }; - "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key": { + get: operations['actions/list-environment-secrets'] + } + '/repositories/{repository_id}/environments/{environment_name}/secrets/public-key': { /** Get the public key for an environment, which you need to encrypt environment secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - get: operations["actions/get-environment-public-key"]; - }; - "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": { + get: operations['actions/get-environment-public-key'] + } + '/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}': { /** Gets a single environment secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - get: operations["actions/get-environment-secret"]; + get: operations['actions/get-environment-secret'] /** * Creates or updates an environment secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -4650,39 +4650,39 @@ export interface paths { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - put: operations["actions/create-or-update-environment-secret"]; + put: operations['actions/create-or-update-environment-secret'] /** Deletes a secret in an environment using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - delete: operations["actions/delete-environment-secret"]; - }; - "/scim/v2/enterprises/{enterprise}/Groups": { + delete: operations['actions/delete-environment-secret'] + } + '/scim/v2/enterprises/{enterprise}/Groups': { /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - get: operations["enterprise-admin/list-provisioned-groups-enterprise"]; + get: operations['enterprise-admin/list-provisioned-groups-enterprise'] /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * * Provision an enterprise group, and invite users to the group. This sends invitation emails to the email address of the invited users to join the GitHub organization that the SCIM group corresponds to. */ - post: operations["enterprise-admin/provision-and-invite-enterprise-group"]; - }; - "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": { + post: operations['enterprise-admin/provision-and-invite-enterprise-group'] + } + '/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}': { /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - get: operations["enterprise-admin/get-provisioning-information-for-enterprise-group"]; + get: operations['enterprise-admin/get-provisioning-information-for-enterprise-group'] /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * * Replaces an existing provisioned group’s information. You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead. */ - put: operations["enterprise-admin/set-information-for-provisioned-enterprise-group"]; + put: operations['enterprise-admin/set-information-for-provisioned-enterprise-group'] /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - delete: operations["enterprise-admin/delete-scim-group-from-enterprise"]; + delete: operations['enterprise-admin/delete-scim-group-from-enterprise'] /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * * Allows you to change a provisioned group’s individual attributes. To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). */ - patch: operations["enterprise-admin/update-attribute-for-enterprise-group"]; - }; - "/scim/v2/enterprises/{enterprise}/Users": { + patch: operations['enterprise-admin/update-attribute-for-enterprise-group'] + } + '/scim/v2/enterprises/{enterprise}/Users': { /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * @@ -4703,7 +4703,7 @@ export interface paths { * - If the user signs in, their GitHub account is linked to this entry. * - If the user does not sign in (or does not create a new account when prompted), they are not added to the GitHub enterprise, and the external identity `null` entry remains in place. */ - get: operations["enterprise-admin/list-provisioned-identities-enterprise"]; + get: operations['enterprise-admin/list-provisioned-identities-enterprise'] /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * @@ -4711,11 +4711,11 @@ export interface paths { * * You can optionally include the groups a user will be invited to join. If you do not provide a list of `groups`, the user is provisioned for the enterprise, but no organization invitation emails will be sent. */ - post: operations["enterprise-admin/provision-and-invite-enterprise-user"]; - }; - "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": { + post: operations['enterprise-admin/provision-and-invite-enterprise-user'] + } + '/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}': { /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - get: operations["enterprise-admin/get-provisioning-information-for-enterprise-user"]; + get: operations['enterprise-admin/get-provisioning-information-for-enterprise-user'] /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * @@ -4725,9 +4725,9 @@ export interface paths { * * **Warning:** Setting `active: false` removes the user from the enterprise, deletes the external identity, and deletes the associated `{scim_user_id}`. */ - put: operations["enterprise-admin/set-information-for-provisioned-enterprise-user"]; + put: operations['enterprise-admin/set-information-for-provisioned-enterprise-user'] /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - delete: operations["enterprise-admin/delete-user-from-enterprise"]; + delete: operations['enterprise-admin/delete-user-from-enterprise'] /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * @@ -4748,9 +4748,9 @@ export interface paths { * } * ``` */ - patch: operations["enterprise-admin/update-attribute-for-enterprise-user"]; - }; - "/scim/v2/organizations/{org}/Users": { + patch: operations['enterprise-admin/update-attribute-for-enterprise-user'] + } + '/scim/v2/organizations/{org}/Users': { /** * Retrieves a paginated list of all provisioned organization members, including pending invitations. If you provide the `filter` parameter, the resources for all matching provisions members are returned. * @@ -4769,12 +4769,12 @@ export interface paths { * - If the user signs in, their GitHub account is linked to this entry. * - If the user does not sign in (or does not create a new account when prompted), they are not added to the GitHub organization, and the external identity `null` entry remains in place. */ - get: operations["scim/list-provisioned-identities"]; + get: operations['scim/list-provisioned-identities'] /** Provision organization membership for a user, and send an activation email to the email address. */ - post: operations["scim/provision-and-invite-user"]; - }; - "/scim/v2/organizations/{org}/Users/{scim_user_id}": { - get: operations["scim/get-provisioning-information-for-user"]; + post: operations['scim/provision-and-invite-user'] + } + '/scim/v2/organizations/{org}/Users/{scim_user_id}': { + get: operations['scim/get-provisioning-information-for-user'] /** * Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](https://docs.github.com/rest/reference/scim#update-an-attribute-for-a-scim-user) endpoint instead. * @@ -4782,8 +4782,8 @@ export interface paths { * * **Warning:** Setting `active: false` removes the user from the organization, deletes the external identity, and deletes the associated `{scim_user_id}`. */ - put: operations["scim/set-information-for-provisioned-user"]; - delete: operations["scim/delete-user-from-org"]; + put: operations['scim/set-information-for-provisioned-user'] + delete: operations['scim/delete-user-from-org'] /** * Allows you to change a provisioned user's individual attributes. To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). * @@ -4802,9 +4802,9 @@ export interface paths { * } * ``` */ - patch: operations["scim/update-attribute-for-user"]; - }; - "/search/code": { + patch: operations['scim/update-attribute-for-user'] + } + '/search/code': { /** * Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -4825,9 +4825,9 @@ export interface paths { * * You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing * language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. */ - get: operations["search/code"]; - }; - "/search/commits": { + get: operations['search/code'] + } + '/search/commits': { /** * Find commits via various criteria on the default branch (usually `master`). This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -4838,9 +4838,9 @@ export interface paths { * * `q=repo:octocat/Spoon-Knife+css` */ - get: operations["search/commits"]; - }; - "/search/issues": { + get: operations['search/commits'] + } + '/search/issues': { /** * Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -4855,9 +4855,9 @@ export interface paths { * * **Note:** For [user-to-server](https://docs.github.com/developers/apps/identifying-and-authorizing-users-for-github-apps#user-to-server-requests) GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." */ - get: operations["search/issues-and-pull-requests"]; - }; - "/search/labels": { + get: operations['search/issues-and-pull-requests'] + } + '/search/labels': { /** * Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -4869,9 +4869,9 @@ export interface paths { * * The labels that best match the query appear first in the search results. */ - get: operations["search/labels"]; - }; - "/search/repositories": { + get: operations['search/labels'] + } + '/search/repositories': { /** * Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -4883,9 +4883,9 @@ export interface paths { * * This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results. */ - get: operations["search/repos"]; - }; - "/search/topics": { + get: operations['search/repos'] + } + '/search/topics': { /** * Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers. * @@ -4897,9 +4897,9 @@ export interface paths { * * This query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results. */ - get: operations["search/topics"]; - }; - "/search/users": { + get: operations['search/topics'] + } + '/search/users': { /** * Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -4911,11 +4911,11 @@ export interface paths { * * This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. */ - get: operations["search/users"]; - }; - "/teams/{team_id}": { + get: operations['search/users'] + } + '/teams/{team_id}': { /** **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/reference/teams#get-a-team-by-name) endpoint. */ - get: operations["teams/get-legacy"]; + get: operations['teams/get-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/reference/teams#delete-a-team) endpoint. * @@ -4923,7 +4923,7 @@ export interface paths { * * If you are an organization owner, deleting a parent team will delete all of its child teams as well. */ - delete: operations["teams/delete-legacy"]; + delete: operations['teams/delete-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/reference/teams#update-a-team) endpoint. * @@ -4931,15 +4931,15 @@ export interface paths { * * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. */ - patch: operations["teams/update-legacy"]; - }; - "/teams/{team_id}/discussions": { + patch: operations['teams/update-legacy'] + } + '/teams/{team_id}/discussions': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/reference/teams#list-discussions) endpoint. * * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - get: operations["teams/list-discussions-legacy"]; + get: operations['teams/list-discussions-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/reference/teams#create-a-discussion) endpoint. * @@ -4947,35 +4947,35 @@ export interface paths { * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - post: operations["teams/create-discussion-legacy"]; - }; - "/teams/{team_id}/discussions/{discussion_number}": { + post: operations['teams/create-discussion-legacy'] + } + '/teams/{team_id}/discussions/{discussion_number}': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/reference/teams#get-a-discussion) endpoint. * * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - get: operations["teams/get-discussion-legacy"]; + get: operations['teams/get-discussion-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/reference/teams#delete-a-discussion) endpoint. * * Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - delete: operations["teams/delete-discussion-legacy"]; + delete: operations['teams/delete-discussion-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/reference/teams#update-a-discussion) endpoint. * * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - patch: operations["teams/update-discussion-legacy"]; - }; - "/teams/{team_id}/discussions/{discussion_number}/comments": { + patch: operations['teams/update-discussion-legacy'] + } + '/teams/{team_id}/discussions/{discussion_number}/comments': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/reference/teams#list-discussion-comments) endpoint. * * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - get: operations["teams/list-discussion-comments-legacy"]; + get: operations['teams/list-discussion-comments-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/reference/teams#create-a-discussion-comment) endpoint. * @@ -4983,73 +4983,73 @@ export interface paths { * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - post: operations["teams/create-discussion-comment-legacy"]; - }; - "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": { + post: operations['teams/create-discussion-comment-legacy'] + } + '/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/reference/teams#get-a-discussion-comment) endpoint. * * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - get: operations["teams/get-discussion-comment-legacy"]; + get: operations['teams/get-discussion-comment-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/reference/teams#delete-a-discussion-comment) endpoint. * * Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - delete: operations["teams/delete-discussion-comment-legacy"]; + delete: operations['teams/delete-discussion-comment-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/reference/teams#update-a-discussion-comment) endpoint. * * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - patch: operations["teams/update-discussion-comment-legacy"]; - }; - "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": { + patch: operations['teams/update-discussion-comment-legacy'] + } + '/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * * List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - get: operations["reactions/list-for-team-discussion-comment-legacy"]; + get: operations['reactions/list-for-team-discussion-comment-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. * * Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. */ - post: operations["reactions/create-for-team-discussion-comment-legacy"]; - }; - "/teams/{team_id}/discussions/{discussion_number}/reactions": { + post: operations['reactions/create-for-team-discussion-comment-legacy'] + } + '/teams/{team_id}/discussions/{discussion_number}/reactions': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion) endpoint. * * List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - get: operations["reactions/list-for-team-discussion-legacy"]; + get: operations['reactions/list-for-team-discussion-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion) endpoint. * * Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. */ - post: operations["reactions/create-for-team-discussion-legacy"]; - }; - "/teams/{team_id}/invitations": { + post: operations['reactions/create-for-team-discussion-legacy'] + } + '/teams/{team_id}/invitations': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/reference/teams#list-pending-team-invitations) endpoint. * * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. */ - get: operations["teams/list-pending-invitations-legacy"]; - }; - "/teams/{team_id}/members": { + get: operations['teams/list-pending-invitations-legacy'] + } + '/teams/{team_id}/members': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/reference/teams#list-team-members) endpoint. * * Team members will include the members of child teams. */ - get: operations["teams/list-members-legacy"]; - }; - "/teams/{team_id}/members/{username}": { + get: operations['teams/list-members-legacy'] + } + '/teams/{team_id}/members/{username}': { /** * The "Get team member" endpoint (described below) is deprecated. * @@ -5057,7 +5057,7 @@ export interface paths { * * To list members in a team, the team must be visible to the authenticated user. */ - get: operations["teams/get-member-legacy"]; + get: operations['teams/get-member-legacy'] /** * The "Add team member" endpoint (described below) is deprecated. * @@ -5071,7 +5071,7 @@ export interface paths { * * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - put: operations["teams/add-member-legacy"]; + put: operations['teams/add-member-legacy'] /** * The "Remove team member" endpoint (described below) is deprecated. * @@ -5083,9 +5083,9 @@ export interface paths { * * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ - delete: operations["teams/remove-member-legacy"]; - }; - "/teams/{team_id}/memberships/{username}": { + delete: operations['teams/remove-member-legacy'] + } + '/teams/{team_id}/memberships/{username}': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/reference/teams#get-team-membership-for-a-user) endpoint. * @@ -5098,7 +5098,7 @@ export interface paths { * * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team). */ - get: operations["teams/get-membership-for-user-legacy"]; + get: operations['teams/get-membership-for-user-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint. * @@ -5112,7 +5112,7 @@ export interface paths { * * If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. */ - put: operations["teams/add-or-update-membership-for-user-legacy"]; + put: operations['teams/add-or-update-membership-for-user-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/reference/teams#remove-team-membership-for-a-user) endpoint. * @@ -5122,41 +5122,41 @@ export interface paths { * * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ - delete: operations["teams/remove-membership-for-user-legacy"]; - }; - "/teams/{team_id}/projects": { + delete: operations['teams/remove-membership-for-user-legacy'] + } + '/teams/{team_id}/projects': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/reference/teams#list-team-projects) endpoint. * * Lists the organization projects for a team. */ - get: operations["teams/list-projects-legacy"]; - }; - "/teams/{team_id}/projects/{project_id}": { + get: operations['teams/list-projects-legacy'] + } + '/teams/{team_id}/projects/{project_id}': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/reference/teams#check-team-permissions-for-a-project) endpoint. * * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. */ - get: operations["teams/check-permissions-for-project-legacy"]; + get: operations['teams/check-permissions-for-project-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/reference/teams#add-or-update-team-project-permissions) endpoint. * * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. */ - put: operations["teams/add-or-update-project-permissions-legacy"]; + put: operations['teams/add-or-update-project-permissions-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/reference/teams#remove-a-project-from-a-team) endpoint. * * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. */ - delete: operations["teams/remove-project-legacy"]; - }; - "/teams/{team_id}/repos": { + delete: operations['teams/remove-project-legacy'] + } + '/teams/{team_id}/repos': { /** **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/reference/teams#list-team-repositories) endpoint. */ - get: operations["teams/list-repos-legacy"]; - }; - "/teams/{team_id}/repos/{owner}/{repo}": { + get: operations['teams/list-repos-legacy'] + } + '/teams/{team_id}/repos/{owner}/{repo}': { /** * **Note**: Repositories inherited through a parent team will also be checked. * @@ -5164,7 +5164,7 @@ export interface paths { * * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: */ - get: operations["teams/check-permissions-for-repo-legacy"]; + get: operations['teams/check-permissions-for-repo-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/reference/teams#add-or-update-team-repository-permissions)" endpoint. * @@ -5172,15 +5172,15 @@ export interface paths { * * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - put: operations["teams/add-or-update-repo-permissions-legacy"]; + put: operations['teams/add-or-update-repo-permissions-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/reference/teams#remove-a-repository-from-a-team) endpoint. * * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. */ - delete: operations["teams/remove-repo-legacy"]; - }; - "/teams/{team_id}/team-sync/group-mappings": { + delete: operations['teams/remove-repo-legacy'] + } + '/teams/{team_id}/team-sync/group-mappings': { /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List IdP groups for a team`](https://docs.github.com/rest/reference/teams#list-idp-groups-for-a-team) endpoint. * @@ -5188,7 +5188,7 @@ export interface paths { * * List IdP groups connected to a team on GitHub. */ - get: operations["teams/list-idp-groups-for-legacy"]; + get: operations['teams/list-idp-groups-for-legacy'] /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create or update IdP group connections`](https://docs.github.com/rest/reference/teams#create-or-update-idp-group-connections) endpoint. * @@ -5196,38 +5196,38 @@ export interface paths { * * Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty `groups` array will remove all connections for a team. */ - patch: operations["teams/create-or-update-idp-group-connections-legacy"]; - }; - "/teams/{team_id}/teams": { + patch: operations['teams/create-or-update-idp-group-connections-legacy'] + } + '/teams/{team_id}/teams': { /** **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/reference/teams#list-child-teams) endpoint. */ - get: operations["teams/list-child-legacy"]; - }; - "/user": { + get: operations['teams/list-child-legacy'] + } + '/user': { /** * If the authenticated user is authenticated through basic authentication or OAuth with the `user` scope, then the response lists public and private profile information. * * If the authenticated user is authenticated through OAuth without the `user` scope, then the response lists only public profile information. */ - get: operations["users/get-authenticated"]; + get: operations['users/get-authenticated'] /** **Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API. */ - patch: operations["users/update-authenticated"]; - }; - "/user/blocks": { + patch: operations['users/update-authenticated'] + } + '/user/blocks': { /** List the users you've blocked on your personal account. */ - get: operations["users/list-blocked-by-authenticated-user"]; - }; - "/user/blocks/{username}": { - get: operations["users/check-blocked"]; - put: operations["users/block"]; - delete: operations["users/unblock"]; - }; - "/user/codespaces": { + get: operations['users/list-blocked-by-authenticated-user'] + } + '/user/blocks/{username}': { + get: operations['users/check-blocked'] + put: operations['users/block'] + delete: operations['users/unblock'] + } + '/user/codespaces': { /** * Lists the authenticated user's codespaces. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - get: operations["codespaces/list-for-authenticated-user"]; + get: operations['codespaces/list-for-authenticated-user'] /** * Creates a new codespace, owned by the authenticated user. * @@ -5235,26 +5235,26 @@ export interface paths { * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - post: operations["codespaces/create-for-authenticated-user"]; - }; - "/user/codespaces/secrets": { + post: operations['codespaces/create-for-authenticated-user'] + } + '/user/codespaces/secrets': { /** * Lists all secrets available for a user's Codespaces without revealing their * encrypted values. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - get: operations["codespaces/list-secrets-for-authenticated-user"]; - }; - "/user/codespaces/secrets/public-key": { + get: operations['codespaces/list-secrets-for-authenticated-user'] + } + '/user/codespaces/secrets/public-key': { /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with one of the 'read:user' or 'user' scopes in their personal access token. User must have Codespaces access to use this endpoint. */ - get: operations["codespaces/get-public-key-for-authenticated-user"]; - }; - "/user/codespaces/secrets/{secret_name}": { + get: operations['codespaces/get-public-key-for-authenticated-user'] + } + '/user/codespaces/secrets/{secret_name}': { /** * Gets a secret available to a user's codespaces without revealing its encrypted value. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - get: operations["codespaces/get-secret-for-authenticated-user"]; + get: operations['codespaces/get-secret-for-authenticated-user'] /** * Creates or updates a secret for a user's codespace with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access token with the `user` scope to use this endpoint. User must also have Codespaces access to use this endpoint. @@ -5330,47 +5330,47 @@ export interface paths { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - put: operations["codespaces/create-or-update-secret-for-authenticated-user"]; + put: operations['codespaces/create-or-update-secret-for-authenticated-user'] /** Deletes a secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret. You must authenticate using an access token with the `user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - delete: operations["codespaces/delete-secret-for-authenticated-user"]; - }; - "/user/codespaces/secrets/{secret_name}/repositories": { + delete: operations['codespaces/delete-secret-for-authenticated-user'] + } + '/user/codespaces/secrets/{secret_name}/repositories': { /** * List the repositories that have been granted the ability to use a user's codespace secret. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - get: operations["codespaces/list-repositories-for-secret-for-authenticated-user"]; + get: operations['codespaces/list-repositories-for-secret-for-authenticated-user'] /** * Select the repositories that will use a user's codespace secret. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - put: operations["codespaces/set-repositories-for-secret-for-authenticated-user"]; - }; - "/user/codespaces/secrets/{secret_name}/repositories/{repository_id}": { + put: operations['codespaces/set-repositories-for-secret-for-authenticated-user'] + } + '/user/codespaces/secrets/{secret_name}/repositories/{repository_id}': { /** * Adds a repository to the selected repositories for a user's codespace secret. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - put: operations["codespaces/add-repository-for-secret-for-authenticated-user"]; + put: operations['codespaces/add-repository-for-secret-for-authenticated-user'] /** * Removes a repository from the selected repositories for a user's codespace secret. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - delete: operations["codespaces/remove-repository-for-secret-for-authenticated-user"]; - }; - "/user/codespaces/{codespace_name}": { + delete: operations['codespaces/remove-repository-for-secret-for-authenticated-user'] + } + '/user/codespaces/{codespace_name}': { /** * Gets information about a user's codespace. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - get: operations["codespaces/get-for-authenticated-user"]; + get: operations['codespaces/get-for-authenticated-user'] /** * Deletes a user's codespace. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - delete: operations["codespaces/delete-for-authenticated-user"]; + delete: operations['codespaces/delete-for-authenticated-user'] /** * Updates a codespace owned by the authenticated user. Currently only the codespace's machine type and recent folders can be modified using this endpoint. * @@ -5378,92 +5378,92 @@ export interface paths { * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - patch: operations["codespaces/update-for-authenticated-user"]; - }; - "/user/codespaces/{codespace_name}/exports": { + patch: operations['codespaces/update-for-authenticated-user'] + } + '/user/codespaces/{codespace_name}/exports': { /** * Triggers an export of the specified codespace and returns a URL and ID where the status of the export can be monitored. * * You must authenticate using a personal access token with the `codespace` scope to use this endpoint. */ - post: operations["codespaces/export-for-authenticated-user"]; - }; - "/user/codespaces/{codespace_name}/exports/{export_id}": { + post: operations['codespaces/export-for-authenticated-user'] + } + '/user/codespaces/{codespace_name}/exports/{export_id}': { /** * Gets information about an export of a codespace. * * You must authenticate using a personal access token with the `codespace` scope to use this endpoint. */ - get: operations["codespaces/get-export-details-for-authenticated-user"]; - }; - "/user/codespaces/{codespace_name}/machines": { + get: operations['codespaces/get-export-details-for-authenticated-user'] + } + '/user/codespaces/{codespace_name}/machines': { /** * List the machine types a codespace can transition to use. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - get: operations["codespaces/codespace-machines-for-authenticated-user"]; - }; - "/user/codespaces/{codespace_name}/start": { + get: operations['codespaces/codespace-machines-for-authenticated-user'] + } + '/user/codespaces/{codespace_name}/start': { /** * Starts a user's codespace. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - post: operations["codespaces/start-for-authenticated-user"]; - }; - "/user/codespaces/{codespace_name}/stop": { + post: operations['codespaces/start-for-authenticated-user'] + } + '/user/codespaces/{codespace_name}/stop': { /** * Stops a user's codespace. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - post: operations["codespaces/stop-for-authenticated-user"]; - }; - "/user/email/visibility": { + post: operations['codespaces/stop-for-authenticated-user'] + } + '/user/email/visibility': { /** Sets the visibility for your primary email addresses. */ - patch: operations["users/set-primary-email-visibility-for-authenticated-user"]; - }; - "/user/emails": { + patch: operations['users/set-primary-email-visibility-for-authenticated-user'] + } + '/user/emails': { /** Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope. */ - get: operations["users/list-emails-for-authenticated-user"]; + get: operations['users/list-emails-for-authenticated-user'] /** This endpoint is accessible with the `user` scope. */ - post: operations["users/add-email-for-authenticated-user"]; + post: operations['users/add-email-for-authenticated-user'] /** This endpoint is accessible with the `user` scope. */ - delete: operations["users/delete-email-for-authenticated-user"]; - }; - "/user/followers": { + delete: operations['users/delete-email-for-authenticated-user'] + } + '/user/followers': { /** Lists the people following the authenticated user. */ - get: operations["users/list-followers-for-authenticated-user"]; - }; - "/user/following": { + get: operations['users/list-followers-for-authenticated-user'] + } + '/user/following': { /** Lists the people who the authenticated user follows. */ - get: operations["users/list-followed-by-authenticated-user"]; - }; - "/user/following/{username}": { - get: operations["users/check-person-is-followed-by-authenticated"]; + get: operations['users/list-followed-by-authenticated-user'] + } + '/user/following/{username}': { + get: operations['users/check-person-is-followed-by-authenticated'] /** * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." * * Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. */ - put: operations["users/follow"]; + put: operations['users/follow'] /** Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. */ - delete: operations["users/unfollow"]; - }; - "/user/gpg_keys": { + delete: operations['users/unfollow'] + } + '/user/gpg_keys': { /** Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - get: operations["users/list-gpg-keys-for-authenticated-user"]; + get: operations['users/list-gpg-keys-for-authenticated-user'] /** Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - post: operations["users/create-gpg-key-for-authenticated-user"]; - }; - "/user/gpg_keys/{gpg_key_id}": { + post: operations['users/create-gpg-key-for-authenticated-user'] + } + '/user/gpg_keys/{gpg_key_id}': { /** View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - get: operations["users/get-gpg-key-for-authenticated-user"]; + get: operations['users/get-gpg-key-for-authenticated-user'] /** Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - delete: operations["users/delete-gpg-key-for-authenticated-user"]; - }; - "/user/installations": { + delete: operations['users/delete-gpg-key-for-authenticated-user'] + } + '/user/installations': { /** * Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. * @@ -5473,9 +5473,9 @@ export interface paths { * * You can find the permissions for the installation under the `permissions` key. */ - get: operations["apps/list-installations-for-authenticated-user"]; - }; - "/user/installations/{installation_id}/repositories": { + get: operations['apps/list-installations-for-authenticated-user'] + } + '/user/installations/{installation_id}/repositories': { /** * List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation. * @@ -5485,31 +5485,31 @@ export interface paths { * * The access the user has to each repository is included in the hash under the `permissions` key. */ - get: operations["apps/list-installation-repos-for-authenticated-user"]; - }; - "/user/installations/{installation_id}/repositories/{repository_id}": { + get: operations['apps/list-installation-repos-for-authenticated-user'] + } + '/user/installations/{installation_id}/repositories/{repository_id}': { /** * Add a single repository to an installation. The authenticated user must have admin access to the repository. * * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. */ - put: operations["apps/add-repo-to-installation-for-authenticated-user"]; + put: operations['apps/add-repo-to-installation-for-authenticated-user'] /** * Remove a single repository from an installation. The authenticated user must have admin access to the repository. * * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. */ - delete: operations["apps/remove-repo-from-installation-for-authenticated-user"]; - }; - "/user/interaction-limits": { + delete: operations['apps/remove-repo-from-installation-for-authenticated-user'] + } + '/user/interaction-limits': { /** Shows which type of GitHub user can interact with your public repositories and when the restriction expires. */ - get: operations["interactions/get-restrictions-for-authenticated-user"]; + get: operations['interactions/get-restrictions-for-authenticated-user'] /** Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user. */ - put: operations["interactions/set-restrictions-for-authenticated-user"]; + put: operations['interactions/set-restrictions-for-authenticated-user'] /** Removes any interaction restrictions from your public repositories. */ - delete: operations["interactions/remove-restrictions-for-authenticated-user"]; - }; - "/user/issues": { + delete: operations['interactions/remove-restrictions-for-authenticated-user'] + } + '/user/issues': { /** * List issues across owned and member repositories assigned to the authenticated user. * @@ -5518,42 +5518,42 @@ export interface paths { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - get: operations["issues/list-for-authenticated-user"]; - }; - "/user/keys": { + get: operations['issues/list-for-authenticated-user'] + } + '/user/keys': { /** Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - get: operations["users/list-public-ssh-keys-for-authenticated-user"]; + get: operations['users/list-public-ssh-keys-for-authenticated-user'] /** Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - post: operations["users/create-public-ssh-key-for-authenticated-user"]; - }; - "/user/keys/{key_id}": { + post: operations['users/create-public-ssh-key-for-authenticated-user'] + } + '/user/keys/{key_id}': { /** View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - get: operations["users/get-public-ssh-key-for-authenticated-user"]; + get: operations['users/get-public-ssh-key-for-authenticated-user'] /** Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - delete: operations["users/delete-public-ssh-key-for-authenticated-user"]; - }; - "/user/marketplace_purchases": { + delete: operations['users/delete-public-ssh-key-for-authenticated-user'] + } + '/user/marketplace_purchases': { /** Lists the active subscriptions for the authenticated user. You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an [OAuth token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/). */ - get: operations["apps/list-subscriptions-for-authenticated-user"]; - }; - "/user/marketplace_purchases/stubbed": { + get: operations['apps/list-subscriptions-for-authenticated-user'] + } + '/user/marketplace_purchases/stubbed': { /** Lists the active subscriptions for the authenticated user. You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an [OAuth token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/). */ - get: operations["apps/list-subscriptions-for-authenticated-user-stubbed"]; - }; - "/user/memberships/orgs": { - get: operations["orgs/list-memberships-for-authenticated-user"]; - }; - "/user/memberships/orgs/{org}": { - get: operations["orgs/get-membership-for-authenticated-user"]; - patch: operations["orgs/update-membership-for-authenticated-user"]; - }; - "/user/migrations": { + get: operations['apps/list-subscriptions-for-authenticated-user-stubbed'] + } + '/user/memberships/orgs': { + get: operations['orgs/list-memberships-for-authenticated-user'] + } + '/user/memberships/orgs/{org}': { + get: operations['orgs/get-membership-for-authenticated-user'] + patch: operations['orgs/update-membership-for-authenticated-user'] + } + '/user/migrations': { /** Lists all migrations a user has started. */ - get: operations["migrations/list-for-authenticated-user"]; + get: operations['migrations/list-for-authenticated-user'] /** Initiates the generation of a user migration archive. */ - post: operations["migrations/start-for-authenticated-user"]; - }; - "/user/migrations/{migration_id}": { + post: operations['migrations/start-for-authenticated-user'] + } + '/user/migrations/{migration_id}': { /** * Fetches a single user migration. The response includes the `state` of the migration, which can be one of the following values: * @@ -5564,9 +5564,9 @@ export interface paths { * * Once the migration has been `exported` you can [download the migration archive](https://docs.github.com/rest/reference/migrations#download-a-user-migration-archive). */ - get: operations["migrations/get-status-for-authenticated-user"]; - }; - "/user/migrations/{migration_id}/archive": { + get: operations['migrations/get-status-for-authenticated-user'] + } + '/user/migrations/{migration_id}/archive': { /** * Fetches the URL to download the migration archive as a `tar.gz` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects: * @@ -5590,19 +5590,19 @@ export interface paths { * * The archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data. */ - get: operations["migrations/get-archive-for-authenticated-user"]; + get: operations['migrations/get-archive-for-authenticated-user'] /** Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the [List user migrations](https://docs.github.com/rest/reference/migrations#list-user-migrations) and [Get a user migration status](https://docs.github.com/rest/reference/migrations#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted. */ - delete: operations["migrations/delete-archive-for-authenticated-user"]; - }; - "/user/migrations/{migration_id}/repos/{repo_name}/lock": { + delete: operations['migrations/delete-archive-for-authenticated-user'] + } + '/user/migrations/{migration_id}/repos/{repo_name}/lock': { /** Unlocks a repository. You can lock repositories when you [start a user migration](https://docs.github.com/rest/reference/migrations#start-a-user-migration). Once the migration is complete you can unlock each repository to begin using it again or [delete the repository](https://docs.github.com/rest/reference/repos#delete-a-repository) if you no longer need the source data. Returns a status of `404 Not Found` if the repository is not locked. */ - delete: operations["migrations/unlock-repo-for-authenticated-user"]; - }; - "/user/migrations/{migration_id}/repositories": { + delete: operations['migrations/unlock-repo-for-authenticated-user'] + } + '/user/migrations/{migration_id}/repositories': { /** Lists all the repositories for this user migration. */ - get: operations["migrations/list-repos-for-authenticated-user"]; - }; - "/user/orgs": { + get: operations['migrations/list-repos-for-authenticated-user'] + } + '/user/orgs': { /** * List organizations for the authenticated user. * @@ -5610,34 +5610,34 @@ export interface paths { * * This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response. */ - get: operations["orgs/list-for-authenticated-user"]; - }; - "/user/packages": { + get: operations['orgs/list-for-authenticated-user'] + } + '/user/packages': { /** * Lists packages owned by the authenticated user within the user's namespace. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/list-packages-for-authenticated-user"]; - }; - "/user/packages/{package_type}/{package_name}": { + get: operations['packages/list-packages-for-authenticated-user'] + } + '/user/packages/{package_type}/{package_name}': { /** * Gets a specific package for a package owned by the authenticated user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/get-package-for-authenticated-user"]; + get: operations['packages/get-package-for-authenticated-user'] /** * Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:delete` scopes. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - delete: operations["packages/delete-package-for-authenticated-user"]; - }; - "/user/packages/{package_type}/{package_name}/restore": { + delete: operations['packages/delete-package-for-authenticated-user'] + } + '/user/packages/{package_type}/{package_name}/restore': { /** * Restores a package owned by the authenticated user. * @@ -5647,34 +5647,34 @@ export interface paths { * * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. If `package_type` is not `container`, your token must also include the `repo` scope. */ - post: operations["packages/restore-package-for-authenticated-user"]; - }; - "/user/packages/{package_type}/{package_name}/versions": { + post: operations['packages/restore-package-for-authenticated-user'] + } + '/user/packages/{package_type}/{package_name}/versions': { /** * Returns all package versions for a package owned by the authenticated user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/get-all-package-versions-for-package-owned-by-authenticated-user"]; - }; - "/user/packages/{package_type}/{package_name}/versions/{package_version_id}": { + get: operations['packages/get-all-package-versions-for-package-owned-by-authenticated-user'] + } + '/user/packages/{package_type}/{package_name}/versions/{package_version_id}': { /** * Gets a specific package version for a package owned by the authenticated user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/get-package-version-for-authenticated-user"]; + get: operations['packages/get-package-version-for-authenticated-user'] /** * Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:delete` scopes. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - delete: operations["packages/delete-package-version-for-authenticated-user"]; - }; - "/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { + delete: operations['packages/delete-package-version-for-authenticated-user'] + } + '/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore': { /** * Restores a package version owned by the authenticated user. * @@ -5684,22 +5684,22 @@ export interface paths { * * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. If `package_type` is not `container`, your token must also include the `repo` scope. */ - post: operations["packages/restore-package-version-for-authenticated-user"]; - }; - "/user/projects": { - post: operations["projects/create-for-authenticated-user"]; - }; - "/user/public_emails": { + post: operations['packages/restore-package-version-for-authenticated-user'] + } + '/user/projects': { + post: operations['projects/create-for-authenticated-user'] + } + '/user/public_emails': { /** Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope. */ - get: operations["users/list-public-emails-for-authenticated-user"]; - }; - "/user/repos": { + get: operations['users/list-public-emails-for-authenticated-user'] + } + '/user/repos': { /** * Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. * * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. */ - get: operations["repos/list-for-authenticated-user"]; + get: operations['repos/list-for-authenticated-user'] /** * Creates a new repository for the authenticated user. * @@ -5710,47 +5710,47 @@ export interface paths { * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. * * `repo` scope to create a private repository. */ - post: operations["repos/create-for-authenticated-user"]; - }; - "/user/repository_invitations": { + post: operations['repos/create-for-authenticated-user'] + } + '/user/repository_invitations': { /** When authenticating as a user, this endpoint will list all currently open repository invitations for that user. */ - get: operations["repos/list-invitations-for-authenticated-user"]; - }; - "/user/repository_invitations/{invitation_id}": { - delete: operations["repos/decline-invitation-for-authenticated-user"]; - patch: operations["repos/accept-invitation-for-authenticated-user"]; - }; - "/user/starred": { + get: operations['repos/list-invitations-for-authenticated-user'] + } + '/user/repository_invitations/{invitation_id}': { + delete: operations['repos/decline-invitation-for-authenticated-user'] + patch: operations['repos/accept-invitation-for-authenticated-user'] + } + '/user/starred': { /** * Lists repositories the authenticated user has starred. * * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: */ - get: operations["activity/list-repos-starred-by-authenticated-user"]; - }; - "/user/starred/{owner}/{repo}": { - get: operations["activity/check-repo-is-starred-by-authenticated-user"]; + get: operations['activity/list-repos-starred-by-authenticated-user'] + } + '/user/starred/{owner}/{repo}': { + get: operations['activity/check-repo-is-starred-by-authenticated-user'] /** Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - put: operations["activity/star-repo-for-authenticated-user"]; - delete: operations["activity/unstar-repo-for-authenticated-user"]; - }; - "/user/subscriptions": { + put: operations['activity/star-repo-for-authenticated-user'] + delete: operations['activity/unstar-repo-for-authenticated-user'] + } + '/user/subscriptions': { /** Lists repositories the authenticated user is watching. */ - get: operations["activity/list-watched-repos-for-authenticated-user"]; - }; - "/user/teams": { + get: operations['activity/list-watched-repos-for-authenticated-user'] + } + '/user/teams': { /** List all of the teams across all of the organizations to which the authenticated user belongs. This method requires `user`, `repo`, or `read:org` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://docs.github.com/apps/building-oauth-apps/). */ - get: operations["teams/list-for-authenticated-user"]; - }; - "/users": { + get: operations['teams/list-for-authenticated-user'] + } + '/users': { /** * Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts. * * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of users. */ - get: operations["users/list"]; - }; - "/users/{username}": { + get: operations['users/list'] + } + '/users/{username}': { /** * Provides publicly available information about someone with a GitHub account. * @@ -5760,39 +5760,39 @@ export interface paths { * * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/reference/users#emails)". */ - get: operations["users/get-by-username"]; - }; - "/users/{username}/events": { + get: operations['users/get-by-username'] + } + '/users/{username}/events': { /** If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. */ - get: operations["activity/list-events-for-authenticated-user"]; - }; - "/users/{username}/events/orgs/{org}": { + get: operations['activity/list-events-for-authenticated-user'] + } + '/users/{username}/events/orgs/{org}': { /** This is the user's organization dashboard. You must be authenticated as the user to view this. */ - get: operations["activity/list-org-events-for-authenticated-user"]; - }; - "/users/{username}/events/public": { - get: operations["activity/list-public-events-for-user"]; - }; - "/users/{username}/followers": { + get: operations['activity/list-org-events-for-authenticated-user'] + } + '/users/{username}/events/public': { + get: operations['activity/list-public-events-for-user'] + } + '/users/{username}/followers': { /** Lists the people following the specified user. */ - get: operations["users/list-followers-for-user"]; - }; - "/users/{username}/following": { + get: operations['users/list-followers-for-user'] + } + '/users/{username}/following': { /** Lists the people who the specified user follows. */ - get: operations["users/list-following-for-user"]; - }; - "/users/{username}/following/{target_user}": { - get: operations["users/check-following-for-user"]; - }; - "/users/{username}/gists": { + get: operations['users/list-following-for-user'] + } + '/users/{username}/following/{target_user}': { + get: operations['users/check-following-for-user'] + } + '/users/{username}/gists': { /** Lists public gists for the specified user: */ - get: operations["gists/list-for-user"]; - }; - "/users/{username}/gpg_keys": { + get: operations['gists/list-for-user'] + } + '/users/{username}/gpg_keys': { /** Lists the GPG keys for a user. This information is accessible by anyone. */ - get: operations["users/list-gpg-keys-for-user"]; - }; - "/users/{username}/hovercard": { + get: operations['users/list-gpg-keys-for-user'] + } + '/users/{username}/hovercard': { /** * Provides hovercard information when authenticated through basic auth or OAuth with the `repo` scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. * @@ -5803,45 +5803,45 @@ export interface paths { * https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 * ``` */ - get: operations["users/get-context-for-user"]; - }; - "/users/{username}/installation": { + get: operations['users/get-context-for-user'] + } + '/users/{username}/installation': { /** * Enables an authenticated GitHub App to find the user’s installation information. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - get: operations["apps/get-user-installation"]; - }; - "/users/{username}/keys": { + get: operations['apps/get-user-installation'] + } + '/users/{username}/keys': { /** Lists the _verified_ public SSH keys for a user. This is accessible by anyone. */ - get: operations["users/list-public-keys-for-user"]; - }; - "/users/{username}/orgs": { + get: operations['users/list-public-keys-for-user'] + } + '/users/{username}/orgs': { /** * List [public organization memberships](https://docs.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user. * * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/rest/reference/orgs#list-organizations-for-the-authenticated-user) API instead. */ - get: operations["orgs/list-for-user"]; - }; - "/users/{username}/packages": { + get: operations['orgs/list-for-user'] + } + '/users/{username}/packages': { /** * Lists all packages in a user's namespace for which the requesting user has access. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/list-packages-for-user"]; - }; - "/users/{username}/packages/{package_type}/{package_name}": { + get: operations['packages/list-packages-for-user'] + } + '/users/{username}/packages/{package_type}/{package_name}': { /** * Gets a specific package metadata for a public package owned by a user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/get-package-for-user"]; + get: operations['packages/get-package-for-user'] /** * Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * @@ -5849,9 +5849,9 @@ export interface paths { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. */ - delete: operations["packages/delete-package-for-user"]; - }; - "/users/{username}/packages/{package_type}/{package_name}/restore": { + delete: operations['packages/delete-package-for-user'] + } + '/users/{username}/packages/{package_type}/{package_name}/restore': { /** * Restores an entire package for a user. * @@ -5863,25 +5863,25 @@ export interface paths { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. */ - post: operations["packages/restore-package-for-user"]; - }; - "/users/{username}/packages/{package_type}/{package_name}/versions": { + post: operations['packages/restore-package-for-user'] + } + '/users/{username}/packages/{package_type}/{package_name}/versions': { /** * Returns all package versions for a public package owned by a specified user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/get-all-package-versions-for-package-owned-by-user"]; - }; - "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}": { + get: operations['packages/get-all-package-versions-for-package-owned-by-user'] + } + '/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}': { /** * Gets a specific package version for a public package owned by a specified user. * * At this time, to use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/get-package-version-for-user"]; + get: operations['packages/get-package-version-for-user'] /** * Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * @@ -5889,9 +5889,9 @@ export interface paths { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. */ - delete: operations["packages/delete-package-version-for-user"]; - }; - "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { + delete: operations['packages/delete-package-version-for-user'] + } + '/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore': { /** * Restores a specific package version for a user. * @@ -5903,23 +5903,23 @@ export interface paths { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. */ - post: operations["packages/restore-package-version-for-user"]; - }; - "/users/{username}/projects": { - get: operations["projects/list-for-user"]; - }; - "/users/{username}/received_events": { + post: operations['packages/restore-package-version-for-user'] + } + '/users/{username}/projects': { + get: operations['projects/list-for-user'] + } + '/users/{username}/received_events': { /** These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. */ - get: operations["activity/list-received-events-for-user"]; - }; - "/users/{username}/received_events/public": { - get: operations["activity/list-received-public-events-for-user"]; - }; - "/users/{username}/repos": { + get: operations['activity/list-received-events-for-user'] + } + '/users/{username}/received_events/public': { + get: operations['activity/list-received-public-events-for-user'] + } + '/users/{username}/repos': { /** Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user. */ - get: operations["repos/list-for-user"]; - }; - "/users/{username}/settings/billing/actions": { + get: operations['repos/list-for-user'] + } + '/users/{username}/settings/billing/actions': { /** * Gets the summary of the free and paid GitHub Actions minutes used. * @@ -5927,9 +5927,9 @@ export interface paths { * * Access tokens must have the `user` scope. */ - get: operations["billing/get-github-actions-billing-user"]; - }; - "/users/{username}/settings/billing/packages": { + get: operations['billing/get-github-actions-billing-user'] + } + '/users/{username}/settings/billing/packages': { /** * Gets the free and paid storage used for GitHub Packages in gigabytes. * @@ -5937,9 +5937,9 @@ export interface paths { * * Access tokens must have the `user` scope. */ - get: operations["billing/get-github-packages-billing-user"]; - }; - "/users/{username}/settings/billing/shared-storage": { + get: operations['billing/get-github-packages-billing-user'] + } + '/users/{username}/settings/billing/shared-storage': { /** * Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. * @@ -5947,24 +5947,24 @@ export interface paths { * * Access tokens must have the `user` scope. */ - get: operations["billing/get-shared-storage-billing-user"]; - }; - "/users/{username}/starred": { + get: operations['billing/get-shared-storage-billing-user'] + } + '/users/{username}/starred': { /** * Lists repositories a user has starred. * * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: */ - get: operations["activity/list-repos-starred-by-user"]; - }; - "/users/{username}/subscriptions": { + get: operations['activity/list-repos-starred-by-user'] + } + '/users/{username}/subscriptions': { /** Lists repositories a user is watching. */ - get: operations["activity/list-repos-watched-by-user"]; - }; - "/zen": { + get: operations['activity/list-repos-watched-by-user'] + } + '/zen': { /** Get a random sentence from the Zen of GitHub */ - get: operations["meta/get-zen"]; - }; + get: operations['meta/get-zen'] + } } export interface components { @@ -5973,71 +5973,71 @@ export interface components { * Simple User * @description Simple User */ - "nullable-simple-user": { - name?: string | null; - email?: string | null; + 'nullable-simple-user': { + name?: string | null + email?: string | null /** @example octocat */ - login: string; + login: string /** @example 1 */ - id: number; + id: number /** @example MDQ6VXNlcjE= */ - node_id: string; + node_id: string /** * Format: uri * @example https://github.com/images/error/octocat_happy.gif */ - avatar_url: string; + avatar_url: string /** @example 41d064eb2195891e12d0413f63227ea7 */ - gravatar_id: string | null; + gravatar_id: string | null /** * Format: uri * @example https://api.github.com/users/octocat */ - url: string; + url: string /** * Format: uri * @example https://github.com/octocat */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/users/octocat/followers */ - followers_url: string; + followers_url: string /** @example https://api.github.com/users/octocat/following{/other_user} */ - following_url: string; + following_url: string /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - gists_url: string; + gists_url: string /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - starred_url: string; + starred_url: string /** * Format: uri * @example https://api.github.com/users/octocat/subscriptions */ - subscriptions_url: string; + subscriptions_url: string /** * Format: uri * @example https://api.github.com/users/octocat/orgs */ - organizations_url: string; + organizations_url: string /** * Format: uri * @example https://api.github.com/users/octocat/repos */ - repos_url: string; + repos_url: string /** @example https://api.github.com/users/octocat/events{/privacy} */ - events_url: string; + events_url: string /** * Format: uri * @example https://api.github.com/users/octocat/received_events */ - received_events_url: string; + received_events_url: string /** @example User */ - type: string; - site_admin: boolean; + type: string + site_admin: boolean /** @example "2020-07-09T00:17:55Z" */ - starred_at?: string; - } | null; + starred_at?: string + } | null /** * GitHub app * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. @@ -6047,554 +6047,554 @@ export interface components { * @description Unique identifier of the GitHub app * @example 37 */ - id: number; + id: number /** * @description The slug name of the GitHub app * @example probot-owners */ - slug?: string; + slug?: string /** @example MDExOkludGVncmF0aW9uMQ== */ - node_id: string; - owner: components["schemas"]["nullable-simple-user"]; + node_id: string + owner: components['schemas']['nullable-simple-user'] /** * @description The name of the GitHub app * @example Probot Owners */ - name: string; + name: string /** @example The description of the app. */ - description: string | null; + description: string | null /** * Format: uri * @example https://example.com */ - external_url: string; + external_url: string /** * Format: uri * @example https://github.com/apps/super-ci */ - html_url: string; + html_url: string /** * Format: date-time * @example 2017-07-08T16:18:44-04:00 */ - created_at: string; + created_at: string /** * Format: date-time * @example 2017-07-08T16:18:44-04:00 */ - updated_at: string; + updated_at: string /** * @description The set of permissions for the GitHub app * @example [object Object] */ permissions: { - issues?: string; - checks?: string; - metadata?: string; - contents?: string; - deployments?: string; - } & { [key: string]: string }; + issues?: string + checks?: string + metadata?: string + contents?: string + deployments?: string + } & { [key: string]: string } /** * @description The list of events for the GitHub app * @example label,deployment */ - events: string[]; + events: string[] /** * @description The number of installations associated with the GitHub app * @example 5 */ - installations_count?: number; + installations_count?: number /** @example "Iv1.25b5d1e65ffc4022" */ - client_id?: string; + client_id?: string /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ - client_secret?: string; + client_secret?: string /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ - webhook_secret?: string | null; + webhook_secret?: string | null /** @example "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n" */ - pem?: string; - }; + pem?: string + } /** * Basic Error * @description Basic Error */ - "basic-error": { - message?: string; - documentation_url?: string; - url?: string; - status?: string; - }; + 'basic-error': { + message?: string + documentation_url?: string + url?: string + status?: string + } /** * Validation Error Simple * @description Validation Error Simple */ - "validation-error-simple": { - message: string; - documentation_url: string; - errors?: string[]; - }; + 'validation-error-simple': { + message: string + documentation_url: string + errors?: string[] + } /** * Format: uri * @description The URL to which the payloads will be delivered. * @example https://example.com/webhook */ - "webhook-config-url": string; + 'webhook-config-url': string /** * @description The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`. * @example "json" */ - "webhook-config-content-type": string; + 'webhook-config-content-type': string /** * @description If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers). * @example "********" */ - "webhook-config-secret": string; - "webhook-config-insecure-ssl": string | number; + 'webhook-config-secret': string + 'webhook-config-insecure-ssl': string | number /** * Webhook Configuration * @description Configuration object of the webhook */ - "webhook-config": { - url?: components["schemas"]["webhook-config-url"]; - content_type?: components["schemas"]["webhook-config-content-type"]; - secret?: components["schemas"]["webhook-config-secret"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - }; + 'webhook-config': { + url?: components['schemas']['webhook-config-url'] + content_type?: components['schemas']['webhook-config-content-type'] + secret?: components['schemas']['webhook-config-secret'] + insecure_ssl?: components['schemas']['webhook-config-insecure-ssl'] + } /** * Simple webhook delivery * @description Delivery made by a webhook, without request and response information. */ - "hook-delivery-item": { + 'hook-delivery-item': { /** * @description Unique identifier of the webhook delivery. * @example 42 */ - id: number; + id: number /** * @description Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event). * @example 58474f00-b361-11eb-836d-0e4f3503ccbe */ - guid: string; + guid: string /** * Format: date-time * @description Time when the webhook delivery occurred. * @example 2021-05-12T20:33:44Z */ - delivered_at: string; + delivered_at: string /** @description Whether the webhook delivery is a redelivery. */ - redelivery: boolean; + redelivery: boolean /** * @description Time spent delivering. * @example 0.03 */ - duration: number; + duration: number /** * @description Describes the response returned after attempting the delivery. * @example failed to connect */ - status: string; + status: string /** * @description Status code received when delivery was made. * @example 502 */ - status_code: number; + status_code: number /** * @description The event that triggered the delivery. * @example issues */ - event: string; + event: string /** * @description The type of activity for the event that triggered the delivery. * @example opened */ - action: string | null; + action: string | null /** * @description The id of the GitHub App installation associated with this event. * @example 123 */ - installation_id: number | null; + installation_id: number | null /** * @description The id of the repository associated with this event. * @example 123 */ - repository_id: number | null; - }; + repository_id: number | null + } /** * Scim Error * @description Scim Error */ - "scim-error": { - message?: string | null; - documentation_url?: string | null; - detail?: string | null; - status?: number; - scimType?: string | null; - schemas?: string[]; - }; + 'scim-error': { + message?: string | null + documentation_url?: string | null + detail?: string | null + status?: number + scimType?: string | null + schemas?: string[] + } /** * Validation Error * @description Validation Error */ - "validation-error": { - message: string; - documentation_url: string; + 'validation-error': { + message: string + documentation_url: string errors?: { - resource?: string; - field?: string; - message?: string; - code: string; - index?: number; - value?: (string | null) | (number | null) | (string[] | null); - }[]; - }; + resource?: string + field?: string + message?: string + code: string + index?: number + value?: (string | null) | (number | null) | (string[] | null) + }[] + } /** * Webhook delivery * @description Delivery made by a webhook. */ - "hook-delivery": { + 'hook-delivery': { /** * @description Unique identifier of the delivery. * @example 42 */ - id: number; + id: number /** * @description Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event). * @example 58474f00-b361-11eb-836d-0e4f3503ccbe */ - guid: string; + guid: string /** * Format: date-time * @description Time when the delivery was delivered. * @example 2021-05-12T20:33:44Z */ - delivered_at: string; + delivered_at: string /** @description Whether the delivery is a redelivery. */ - redelivery: boolean; + redelivery: boolean /** * @description Time spent delivering. * @example 0.03 */ - duration: number; + duration: number /** * @description Description of the status of the attempted delivery * @example failed to connect */ - status: string; + status: string /** * @description Status code received when delivery was made. * @example 502 */ - status_code: number; + status_code: number /** * @description The event that triggered the delivery. * @example issues */ - event: string; + event: string /** * @description The type of activity for the event that triggered the delivery. * @example opened */ - action: string | null; + action: string | null /** * @description The id of the GitHub App installation associated with this event. * @example 123 */ - installation_id: number | null; + installation_id: number | null /** * @description The id of the repository associated with this event. * @example 123 */ - repository_id: number | null; + repository_id: number | null /** * @description The URL target of the delivery. * @example https://www.example.com */ - url?: string; + url?: string request: { /** @description The request headers sent with the webhook delivery. */ - headers: { [key: string]: unknown } | null; + headers: { [key: string]: unknown } | null /** @description The webhook payload. */ - payload: { [key: string]: unknown } | null; - }; + payload: { [key: string]: unknown } | null + } response: { /** @description The response headers received when the delivery was made. */ - headers: { [key: string]: unknown } | null; + headers: { [key: string]: unknown } | null /** @description The response payload received. */ - payload: string | null; - }; - }; + payload: string | null + } + } /** * Simple User * @description Simple User */ - "simple-user": { - name?: string | null; - email?: string | null; + 'simple-user': { + name?: string | null + email?: string | null /** @example octocat */ - login: string; + login: string /** @example 1 */ - id: number; + id: number /** @example MDQ6VXNlcjE= */ - node_id: string; + node_id: string /** * Format: uri * @example https://github.com/images/error/octocat_happy.gif */ - avatar_url: string; + avatar_url: string /** @example 41d064eb2195891e12d0413f63227ea7 */ - gravatar_id: string | null; + gravatar_id: string | null /** * Format: uri * @example https://api.github.com/users/octocat */ - url: string; + url: string /** * Format: uri * @example https://github.com/octocat */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/users/octocat/followers */ - followers_url: string; + followers_url: string /** @example https://api.github.com/users/octocat/following{/other_user} */ - following_url: string; + following_url: string /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - gists_url: string; + gists_url: string /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - starred_url: string; + starred_url: string /** * Format: uri * @example https://api.github.com/users/octocat/subscriptions */ - subscriptions_url: string; + subscriptions_url: string /** * Format: uri * @example https://api.github.com/users/octocat/orgs */ - organizations_url: string; + organizations_url: string /** * Format: uri * @example https://api.github.com/users/octocat/repos */ - repos_url: string; + repos_url: string /** @example https://api.github.com/users/octocat/events{/privacy} */ - events_url: string; + events_url: string /** * Format: uri * @example https://api.github.com/users/octocat/received_events */ - received_events_url: string; + received_events_url: string /** @example User */ - type: string; - site_admin: boolean; + type: string + site_admin: boolean /** @example "2020-07-09T00:17:55Z" */ - starred_at?: string; - }; + starred_at?: string + } /** * Enterprise * @description An enterprise account */ enterprise: { /** @description A short description of the enterprise. */ - description?: string | null; + description?: string | null /** * Format: uri * @example https://github.com/enterprises/octo-business */ - html_url: string; + html_url: string /** * Format: uri * @description The enterprise's website URL. */ - website_url?: string | null; + website_url?: string | null /** * @description Unique identifier of the enterprise * @example 42 */ - id: number; + id: number /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - node_id: string; + node_id: string /** * @description The name of the enterprise. * @example Octo Business */ - name: string; + name: string /** * @description The slug url identifier for the enterprise. * @example octo-business */ - slug: string; + slug: string /** * Format: date-time * @example 2019-01-26T19:01:12Z */ - created_at: string | null; + created_at: string | null /** * Format: date-time * @example 2019-01-26T19:14:43Z */ - updated_at: string | null; + updated_at: string | null /** Format: uri */ - avatar_url: string; - }; + avatar_url: string + } /** * App Permissions * @description The permissions granted to the user-to-server access token. * @example [object Object] */ - "app-permissions": { + 'app-permissions': { /** * @description The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts. Can be one of: `read` or `write`. * @enum {string} */ - actions?: "read" | "write"; + actions?: 'read' | 'write' /** * @description The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation. Can be one of: `read` or `write`. * @enum {string} */ - administration?: "read" | "write"; + administration?: 'read' | 'write' /** * @description The level of permission to grant the access token for checks on code. Can be one of: `read` or `write`. * @enum {string} */ - checks?: "read" | "write"; + checks?: 'read' | 'write' /** * @description The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges. Can be one of: `read` or `write`. * @enum {string} */ - contents?: "read" | "write"; + contents?: 'read' | 'write' /** * @description The level of permission to grant the access token for deployments and deployment statuses. Can be one of: `read` or `write`. * @enum {string} */ - deployments?: "read" | "write"; + deployments?: 'read' | 'write' /** * @description The level of permission to grant the access token for managing repository environments. Can be one of: `read` or `write`. * @enum {string} */ - environments?: "read" | "write"; + environments?: 'read' | 'write' /** * @description The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones. Can be one of: `read` or `write`. * @enum {string} */ - issues?: "read" | "write"; + issues?: 'read' | 'write' /** * @description The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata. Can be one of: `read` or `write`. * @enum {string} */ - metadata?: "read" | "write"; + metadata?: 'read' | 'write' /** * @description The level of permission to grant the access token for packages published to GitHub Packages. Can be one of: `read` or `write`. * @enum {string} */ - packages?: "read" | "write"; + packages?: 'read' | 'write' /** * @description The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds. Can be one of: `read` or `write`. * @enum {string} */ - pages?: "read" | "write"; + pages?: 'read' | 'write' /** * @description The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges. Can be one of: `read` or `write`. * @enum {string} */ - pull_requests?: "read" | "write"; + pull_requests?: 'read' | 'write' /** * @description The level of permission to grant the access token to manage the post-receive hooks for a repository. Can be one of: `read` or `write`. * @enum {string} */ - repository_hooks?: "read" | "write"; + repository_hooks?: 'read' | 'write' /** * @description The level of permission to grant the access token to manage repository projects, columns, and cards. Can be one of: `read`, `write`, or `admin`. * @enum {string} */ - repository_projects?: "read" | "write" | "admin"; + repository_projects?: 'read' | 'write' | 'admin' /** * @description The level of permission to grant the access token to view and manage secret scanning alerts. Can be one of: `read` or `write`. * @enum {string} */ - secret_scanning_alerts?: "read" | "write"; + secret_scanning_alerts?: 'read' | 'write' /** * @description The level of permission to grant the access token to manage repository secrets. Can be one of: `read` or `write`. * @enum {string} */ - secrets?: "read" | "write"; + secrets?: 'read' | 'write' /** * @description The level of permission to grant the access token to view and manage security events like code scanning alerts. Can be one of: `read` or `write`. * @enum {string} */ - security_events?: "read" | "write"; + security_events?: 'read' | 'write' /** * @description The level of permission to grant the access token to manage just a single file. Can be one of: `read` or `write`. * @enum {string} */ - single_file?: "read" | "write"; + single_file?: 'read' | 'write' /** * @description The level of permission to grant the access token for commit statuses. Can be one of: `read` or `write`. * @enum {string} */ - statuses?: "read" | "write"; + statuses?: 'read' | 'write' /** * @description The level of permission to grant the access token to manage Dependabot alerts. Can be one of: `read` or `write`. * @enum {string} */ - vulnerability_alerts?: "read" | "write"; + vulnerability_alerts?: 'read' | 'write' /** * @description The level of permission to grant the access token to update GitHub Actions workflow files. Can be one of: `write`. * @enum {string} */ - workflows?: "write"; + workflows?: 'write' /** * @description The level of permission to grant the access token for organization teams and members. Can be one of: `read` or `write`. * @enum {string} */ - members?: "read" | "write"; + members?: 'read' | 'write' /** * @description The level of permission to grant the access token to manage access to an organization. Can be one of: `read` or `write`. * @enum {string} */ - organization_administration?: "read" | "write"; + organization_administration?: 'read' | 'write' /** * @description The level of permission to grant the access token to manage the post-receive hooks for an organization. Can be one of: `read` or `write`. * @enum {string} */ - organization_hooks?: "read" | "write"; + organization_hooks?: 'read' | 'write' /** * @description The level of permission to grant the access token for viewing an organization's plan. Can be one of: `read`. * @enum {string} */ - organization_plan?: "read"; + organization_plan?: 'read' /** * @description The level of permission to grant the access token to manage organization projects and projects beta (where available). Can be one of: `read`, `write`, or `admin`. * @enum {string} */ - organization_projects?: "read" | "write" | "admin"; + organization_projects?: 'read' | 'write' | 'admin' /** * @description The level of permission to grant the access token for organization packages published to GitHub Packages. Can be one of: `read` or `write`. * @enum {string} */ - organization_packages?: "read" | "write"; + organization_packages?: 'read' | 'write' /** * @description The level of permission to grant the access token to manage organization secrets. Can be one of: `read` or `write`. * @enum {string} */ - organization_secrets?: "read" | "write"; + organization_secrets?: 'read' | 'write' /** * @description The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization. Can be one of: `read` or `write`. * @enum {string} */ - organization_self_hosted_runners?: "read" | "write"; + organization_self_hosted_runners?: 'read' | 'write' /** * @description The level of permission to grant the access token to view and manage users blocked by the organization. Can be one of: `read` or `write`. * @enum {string} */ - organization_user_blocking?: "read" | "write"; + organization_user_blocking?: 'read' | 'write' /** * @description The level of permission to grant the access token to manage team discussions and related comments. Can be one of: `read` or `write`. * @enum {string} */ - team_discussions?: "read" | "write"; - }; + team_discussions?: 'read' | 'write' + } /** * Installation * @description Installation @@ -6604,75 +6604,75 @@ export interface components { * @description The ID of the installation. * @example 1 */ - id: number; - account: (Partial & Partial) | null; + id: number + account: (Partial & Partial) | null /** * @description Describe whether all repositories have been selected or there's a selection involved * @enum {string} */ - repository_selection: "all" | "selected"; + repository_selection: 'all' | 'selected' /** * Format: uri * @example https://api.github.com/installations/1/access_tokens */ - access_tokens_url: string; + access_tokens_url: string /** * Format: uri * @example https://api.github.com/installation/repositories */ - repositories_url: string; + repositories_url: string /** * Format: uri * @example https://github.com/organizations/github/settings/installations/1 */ - html_url: string; + html_url: string /** @example 1 */ - app_id: number; + app_id: number /** @description The ID of the user or organization this token is being scoped to. */ - target_id: number; + target_id: number /** @example Organization */ - target_type: string; - permissions: components["schemas"]["app-permissions"]; - events: string[]; + target_type: string + permissions: components['schemas']['app-permissions'] + events: string[] /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; + updated_at: string /** @example config.yaml */ - single_file_name: string | null; + single_file_name: string | null /** @example true */ - has_multiple_single_files?: boolean; + has_multiple_single_files?: boolean /** @example config.yml,.github/issue_TEMPLATE.md */ - single_file_paths?: string[]; + single_file_paths?: string[] /** @example github-actions */ - app_slug: string; - suspended_by: components["schemas"]["nullable-simple-user"]; + app_slug: string + suspended_by: components['schemas']['nullable-simple-user'] /** Format: date-time */ - suspended_at: string | null; + suspended_at: string | null /** @example "test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com" */ - contact_email?: string | null; - }; + contact_email?: string | null + } /** * License Simple * @description License Simple */ - "nullable-license-simple": { + 'nullable-license-simple': { /** @example mit */ - key: string; + key: string /** @example MIT License */ - name: string; + name: string /** * Format: uri * @example https://api.github.com/licenses/mit */ - url: string | null; + url: string | null /** @example MIT */ - spdx_id: string | null; + spdx_id: string | null /** @example MDc6TGljZW5zZW1pdA== */ - node_id: string; + node_id: string /** Format: uri */ - html_url?: string; - } | null; + html_url?: string + } | null /** * Repository * @description A git repository @@ -6682,503 +6682,503 @@ export interface components { * @description Unique identifier of the repository * @example 42 */ - id: number; + id: number /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - node_id: string; + node_id: string /** * @description The name of the repository. * @example Team Environment */ - name: string; + name: string /** @example octocat/Hello-World */ - full_name: string; - license: components["schemas"]["nullable-license-simple"]; - organization?: components["schemas"]["nullable-simple-user"]; - forks: number; + full_name: string + license: components['schemas']['nullable-license-simple'] + organization?: components['schemas']['nullable-simple-user'] + forks: number permissions?: { - admin: boolean; - pull: boolean; - triage?: boolean; - push: boolean; - maintain?: boolean; - }; - owner: components["schemas"]["simple-user"]; + admin: boolean + pull: boolean + triage?: boolean + push: boolean + maintain?: boolean + } + owner: components['schemas']['simple-user'] /** @description Whether the repository is private or public. */ - private: boolean; + private: boolean /** * Format: uri * @example https://github.com/octocat/Hello-World */ - html_url: string; + html_url: string /** @example This your first repo! */ - description: string | null; - fork: boolean; + description: string | null + fork: boolean /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World */ - url: string; + url: string /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - archive_url: string; + archive_url: string /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - assignees_url: string; + assignees_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - blobs_url: string; + blobs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - branches_url: string; + branches_url: string /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - collaborators_url: string; + collaborators_url: string /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - comments_url: string; + comments_url: string /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - commits_url: string; + commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - compare_url: string; + compare_url: string /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - contents_url: string; + contents_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - contributors_url: string; + contributors_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - deployments_url: string; + deployments_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - downloads_url: string; + downloads_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events */ - events_url: string; + events_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ - forks_url: string; + forks_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - git_commits_url: string; + git_commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - git_refs_url: string; + git_refs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - git_tags_url: string; + git_tags_url: string /** @example git:github.com/octocat/Hello-World.git */ - git_url: string; + git_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - issue_comment_url: string; + issue_comment_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - issue_events_url: string; + issue_events_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - issues_url: string; + issues_url: string /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - keys_url: string; + keys_url: string /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - labels_url: string; + labels_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ - languages_url: string; + languages_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ - merges_url: string; + merges_url: string /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - milestones_url: string; + milestones_url: string /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - notifications_url: string; + notifications_url: string /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - pulls_url: string; + pulls_url: string /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - releases_url: string; + releases_url: string /** @example git@github.com:octocat/Hello-World.git */ - ssh_url: string; + ssh_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - stargazers_url: string; + stargazers_url: string /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - statuses_url: string; + statuses_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - subscribers_url: string; + subscribers_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - subscription_url: string; + subscription_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ - tags_url: string; + tags_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ - teams_url: string; + teams_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - trees_url: string; + trees_url: string /** @example https://github.com/octocat/Hello-World.git */ - clone_url: string; + clone_url: string /** * Format: uri * @example git:git.example.com/octocat/Hello-World */ - mirror_url: string | null; + mirror_url: string | null /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - hooks_url: string; + hooks_url: string /** * Format: uri * @example https://svn.github.com/octocat/Hello-World */ - svn_url: string; + svn_url: string /** * Format: uri * @example https://github.com */ - homepage: string | null; - language: string | null; + homepage: string | null + language: string | null /** @example 9 */ - forks_count: number; + forks_count: number /** @example 80 */ - stargazers_count: number; + stargazers_count: number /** @example 80 */ - watchers_count: number; + watchers_count: number /** @example 108 */ - size: number; + size: number /** * @description The default branch of the repository. * @example master */ - default_branch: string; - open_issues_count: number; + default_branch: string + open_issues_count: number /** * @description Whether this repository acts as a template that can be used to generate new repositories. * @example true */ - is_template?: boolean; - topics?: string[]; + is_template?: boolean + topics?: string[] /** * @description Whether issues are enabled. * @default true * @example true */ - has_issues: boolean; + has_issues: boolean /** * @description Whether projects are enabled. * @default true * @example true */ - has_projects: boolean; + has_projects: boolean /** * @description Whether the wiki is enabled. * @default true * @example true */ - has_wiki: boolean; - has_pages: boolean; + has_wiki: boolean + has_pages: boolean /** * @description Whether downloads are enabled. * @default true * @example true */ - has_downloads: boolean; + has_downloads: boolean /** @description Whether the repository is archived. */ - archived: boolean; + archived: boolean /** @description Returns whether or not this repository disabled. */ - disabled: boolean; + disabled: boolean /** * @description The repository visibility: public, private, or internal. * @default public */ - visibility?: string; + visibility?: string /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - pushed_at: string | null; + pushed_at: string | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - created_at: string | null; + created_at: string | null /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - updated_at: string | null; + updated_at: string | null /** * @description Whether to allow rebase merges for pull requests. * @default true * @example true */ - allow_rebase_merge?: boolean; + allow_rebase_merge?: boolean template_repository?: { - id?: number; - node_id?: string; - name?: string; - full_name?: string; + id?: number + node_id?: string + name?: string + full_name?: string owner?: { - login?: string; - id?: number; - node_id?: string; - avatar_url?: string; - gravatar_id?: string; - url?: string; - html_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - starred_url?: string; - subscriptions_url?: string; - organizations_url?: string; - repos_url?: string; - events_url?: string; - received_events_url?: string; - type?: string; - site_admin?: boolean; - }; - private?: boolean; - html_url?: string; - description?: string; - fork?: boolean; - url?: string; - archive_url?: string; - assignees_url?: string; - blobs_url?: string; - branches_url?: string; - collaborators_url?: string; - comments_url?: string; - commits_url?: string; - compare_url?: string; - contents_url?: string; - contributors_url?: string; - deployments_url?: string; - downloads_url?: string; - events_url?: string; - forks_url?: string; - git_commits_url?: string; - git_refs_url?: string; - git_tags_url?: string; - git_url?: string; - issue_comment_url?: string; - issue_events_url?: string; - issues_url?: string; - keys_url?: string; - labels_url?: string; - languages_url?: string; - merges_url?: string; - milestones_url?: string; - notifications_url?: string; - pulls_url?: string; - releases_url?: string; - ssh_url?: string; - stargazers_url?: string; - statuses_url?: string; - subscribers_url?: string; - subscription_url?: string; - tags_url?: string; - teams_url?: string; - trees_url?: string; - clone_url?: string; - mirror_url?: string; - hooks_url?: string; - svn_url?: string; - homepage?: string; - language?: string; - forks_count?: number; - stargazers_count?: number; - watchers_count?: number; - size?: number; - default_branch?: string; - open_issues_count?: number; - is_template?: boolean; - topics?: string[]; - has_issues?: boolean; - has_projects?: boolean; - has_wiki?: boolean; - has_pages?: boolean; - has_downloads?: boolean; - archived?: boolean; - disabled?: boolean; - visibility?: string; - pushed_at?: string; - created_at?: string; - updated_at?: string; + login?: string + id?: number + node_id?: string + avatar_url?: string + gravatar_id?: string + url?: string + html_url?: string + followers_url?: string + following_url?: string + gists_url?: string + starred_url?: string + subscriptions_url?: string + organizations_url?: string + repos_url?: string + events_url?: string + received_events_url?: string + type?: string + site_admin?: boolean + } + private?: boolean + html_url?: string + description?: string + fork?: boolean + url?: string + archive_url?: string + assignees_url?: string + blobs_url?: string + branches_url?: string + collaborators_url?: string + comments_url?: string + commits_url?: string + compare_url?: string + contents_url?: string + contributors_url?: string + deployments_url?: string + downloads_url?: string + events_url?: string + forks_url?: string + git_commits_url?: string + git_refs_url?: string + git_tags_url?: string + git_url?: string + issue_comment_url?: string + issue_events_url?: string + issues_url?: string + keys_url?: string + labels_url?: string + languages_url?: string + merges_url?: string + milestones_url?: string + notifications_url?: string + pulls_url?: string + releases_url?: string + ssh_url?: string + stargazers_url?: string + statuses_url?: string + subscribers_url?: string + subscription_url?: string + tags_url?: string + teams_url?: string + trees_url?: string + clone_url?: string + mirror_url?: string + hooks_url?: string + svn_url?: string + homepage?: string + language?: string + forks_count?: number + stargazers_count?: number + watchers_count?: number + size?: number + default_branch?: string + open_issues_count?: number + is_template?: boolean + topics?: string[] + has_issues?: boolean + has_projects?: boolean + has_wiki?: boolean + has_pages?: boolean + has_downloads?: boolean + archived?: boolean + disabled?: boolean + visibility?: string + pushed_at?: string + created_at?: string + updated_at?: string permissions?: { - admin?: boolean; - maintain?: boolean; - push?: boolean; - triage?: boolean; - pull?: boolean; - }; - allow_rebase_merge?: boolean; - temp_clone_token?: string; - allow_squash_merge?: boolean; - allow_auto_merge?: boolean; - delete_branch_on_merge?: boolean; - allow_update_branch?: boolean; - allow_merge_commit?: boolean; - subscribers_count?: number; - network_count?: number; - } | null; - temp_clone_token?: string; + admin?: boolean + maintain?: boolean + push?: boolean + triage?: boolean + pull?: boolean + } + allow_rebase_merge?: boolean + temp_clone_token?: string + allow_squash_merge?: boolean + allow_auto_merge?: boolean + delete_branch_on_merge?: boolean + allow_update_branch?: boolean + allow_merge_commit?: boolean + subscribers_count?: number + network_count?: number + } | null + temp_clone_token?: string /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - allow_squash_merge?: boolean; + allow_squash_merge?: boolean /** @description Whether to allow Auto-merge to be used on pull requests. */ - allow_auto_merge?: boolean; + allow_auto_merge?: boolean /** @description Whether to delete head branches when pull requests are merged */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge?: boolean /** * @description Whether to allow merge commits for pull requests. * @default true * @example true */ - allow_merge_commit?: boolean; + allow_merge_commit?: boolean /** @description Whether to allow forking this repo */ - allow_forking?: boolean; - subscribers_count?: number; - network_count?: number; - open_issues: number; - watchers: number; - master_branch?: string; + allow_forking?: boolean + subscribers_count?: number + network_count?: number + open_issues: number + watchers: number + master_branch?: string /** @example "2020-07-09T00:17:42Z" */ - starred_at?: string; - }; + starred_at?: string + } /** * Installation Token * @description Authentication token for a GitHub App installed on a user or org. */ - "installation-token": { - token: string; - expires_at: string; - permissions?: components["schemas"]["app-permissions"]; + 'installation-token': { + token: string + expires_at: string + permissions?: components['schemas']['app-permissions'] /** @enum {string} */ - repository_selection?: "all" | "selected"; - repositories?: components["schemas"]["repository"][]; + repository_selection?: 'all' | 'selected' + repositories?: components['schemas']['repository'][] /** @example README.md */ - single_file?: string; + single_file?: string /** @example true */ - has_multiple_single_files?: boolean; + has_multiple_single_files?: boolean /** @example config.yml,.github/issue_TEMPLATE.md */ - single_file_paths?: string[]; - }; + single_file_paths?: string[] + } /** * Application Grant * @description The authorization associated with an OAuth Access. */ - "application-grant": { + 'application-grant': { /** @example 1 */ - id: number; + id: number /** * Format: uri * @example https://api.github.com/applications/grants/1 */ - url: string; + url: string app: { - client_id: string; - name: string; + client_id: string + name: string /** Format: uri */ - url: string; - }; + url: string + } /** * Format: date-time * @example 2011-09-06T17:26:27Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2011-09-06T20:39:23Z */ - updated_at: string; + updated_at: string /** @example public_repo */ - scopes: string[]; - user?: components["schemas"]["nullable-simple-user"]; - }; + scopes: string[] + user?: components['schemas']['nullable-simple-user'] + } /** Scoped Installation */ - "nullable-scoped-installation": { - permissions: components["schemas"]["app-permissions"]; + 'nullable-scoped-installation': { + permissions: components['schemas']['app-permissions'] /** * @description Describe whether all repositories have been selected or there's a selection involved * @enum {string} */ - repository_selection: "all" | "selected"; + repository_selection: 'all' | 'selected' /** @example config.yaml */ - single_file_name: string | null; + single_file_name: string | null /** @example true */ - has_multiple_single_files?: boolean; + has_multiple_single_files?: boolean /** @example config.yml,.github/issue_TEMPLATE.md */ - single_file_paths?: string[]; + single_file_paths?: string[] /** * Format: uri * @example https://api.github.com/users/octocat/repos */ - repositories_url: string; - account: components["schemas"]["simple-user"]; - } | null; + repositories_url: string + account: components['schemas']['simple-user'] + } | null /** * Authorization * @description The authorization for an OAuth app, GitHub App, or a Personal Access Token. */ authorization: { - id: number; + id: number /** Format: uri */ - url: string; + url: string /** @description A list of scopes that this authorization is in. */ - scopes: string[] | null; - token: string; - token_last_eight: string | null; - hashed_token: string | null; + scopes: string[] | null + token: string + token_last_eight: string | null + hashed_token: string | null app: { - client_id: string; - name: string; + client_id: string + name: string /** Format: uri */ - url: string; - }; - note: string | null; + url: string + } + note: string | null /** Format: uri */ - note_url: string | null; + note_url: string | null /** Format: date-time */ - updated_at: string; + updated_at: string /** Format: date-time */ - created_at: string; - fingerprint: string | null; - user?: components["schemas"]["nullable-simple-user"]; - installation?: components["schemas"]["nullable-scoped-installation"]; + created_at: string + fingerprint: string | null + user?: components['schemas']['nullable-simple-user'] + installation?: components['schemas']['nullable-scoped-installation'] /** Format: date-time */ - expires_at: string | null; - }; + expires_at: string | null + } /** * Code Of Conduct * @description Code Of Conduct */ - "code-of-conduct": { + 'code-of-conduct': { /** @example contributor_covenant */ - key: string; + key: string /** @example Contributor Covenant */ - name: string; + name: string /** * Format: uri * @example https://api.github.com/codes_of_conduct/contributor_covenant */ - url: string; + url: string /** * @example # Contributor Covenant Code of Conduct * @@ -7229,100 +7229,100 @@ export interface components { * [homepage]: http://contributor-covenant.org * [version]: http://contributor-covenant.org/version/1/4/ */ - body?: string; + body?: string /** Format: uri */ - html_url: string | null; - }; + html_url: string | null + } /** * @description The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`. * @enum {string} */ - "enabled-organizations": "all" | "none" | "selected"; + 'enabled-organizations': 'all' | 'none' | 'selected' /** * @description The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`. * @enum {string} */ - "allowed-actions": "all" | "local_only" | "selected"; + 'allowed-actions': 'all' | 'local_only' | 'selected' /** @description The API URL to use to get or set the actions that are allowed to run, when `allowed_actions` is set to `selected`. */ - "selected-actions-url": string; - "actions-enterprise-permissions": { - enabled_organizations: components["schemas"]["enabled-organizations"]; + 'selected-actions-url': string + 'actions-enterprise-permissions': { + enabled_organizations: components['schemas']['enabled-organizations'] /** @description The API URL to use to get or set the selected organizations that are allowed to run GitHub Actions, when `enabled_organizations` is set to `selected`. */ - selected_organizations_url?: string; - allowed_actions?: components["schemas"]["allowed-actions"]; - selected_actions_url?: components["schemas"]["selected-actions-url"]; - }; + selected_organizations_url?: string + allowed_actions?: components['schemas']['allowed-actions'] + selected_actions_url?: components['schemas']['selected-actions-url'] + } /** * Organization Simple * @description Organization Simple */ - "organization-simple": { + 'organization-simple': { /** @example github */ - login: string; + login: string /** @example 1 */ - id: number; + id: number /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ - node_id: string; + node_id: string /** * Format: uri * @example https://api.github.com/orgs/github */ - url: string; + url: string /** * Format: uri * @example https://api.github.com/orgs/github/repos */ - repos_url: string; + repos_url: string /** * Format: uri * @example https://api.github.com/orgs/github/events */ - events_url: string; + events_url: string /** @example https://api.github.com/orgs/github/hooks */ - hooks_url: string; + hooks_url: string /** @example https://api.github.com/orgs/github/issues */ - issues_url: string; + issues_url: string /** @example https://api.github.com/orgs/github/members{/member} */ - members_url: string; + members_url: string /** @example https://api.github.com/orgs/github/public_members{/member} */ - public_members_url: string; + public_members_url: string /** @example https://github.com/images/error/octocat_happy.gif */ - avatar_url: string; + avatar_url: string /** @example A great organization */ - description: string | null; - }; - "selected-actions": { + description: string | null + } + 'selected-actions': { /** @description Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization. */ - github_owned_allowed?: boolean; + github_owned_allowed?: boolean /** @description Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators. */ - verified_allowed?: boolean; + verified_allowed?: boolean /** @description Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`." */ - patterns_allowed?: string[]; - }; - "runner-groups-enterprise": { - id: number; - name: string; - visibility: string; - default: boolean; - selected_organizations_url?: string; - runners_url: string; - allows_public_repositories: boolean; - }; + patterns_allowed?: string[] + } + 'runner-groups-enterprise': { + id: number + name: string + visibility: string + default: boolean + selected_organizations_url?: string + runners_url: string + allows_public_repositories: boolean + } /** * Self hosted runner label * @description A label for a self hosted runner */ - "runner-label": { + 'runner-label': { /** @description Unique identifier of the label. */ - id?: number; + id?: number /** @description Name of the label. */ - name: string; + name: string /** * @description The type of label. Read-only labels are applied automatically when the runner is configured. * @enum {string} */ - type?: "read-only" | "custom"; - }; + type?: 'read-only' | 'custom' + } /** * Self hosted runners * @description A self hosted runner @@ -7332,1046 +7332,1038 @@ export interface components { * @description The id of the runner. * @example 5 */ - id: number; + id: number /** * @description The name of the runner. * @example iMac */ - name: string; + name: string /** * @description The Operating System of the runner. * @example macos */ - os: string; + os: string /** * @description The status of the runner. * @example online */ - status: string; - busy: boolean; - labels: components["schemas"]["runner-label"][]; - }; + status: string + busy: boolean + labels: components['schemas']['runner-label'][] + } /** * Runner Application * @description Runner Application */ - "runner-application": { - os: string; - architecture: string; - download_url: string; - filename: string; + 'runner-application': { + os: string + architecture: string + download_url: string + filename: string /** @description A short lived bearer token used to download the runner, if needed. */ - temp_download_token?: string; - sha256_checksum?: string; - }; + temp_download_token?: string + sha256_checksum?: string + } /** * Authentication Token * @description Authentication Token */ - "authentication-token": { + 'authentication-token': { /** * @description The token used for authentication * @example v1.1f699f1069f60xxx */ - token: string; + token: string /** * Format: date-time * @description The time this token expires * @example 2016-07-11T22:14:10Z */ - expires_at: string; + expires_at: string /** @example [object Object] */ - permissions?: { [key: string]: unknown }; + permissions?: { [key: string]: unknown } /** @description The repositories this token has access to */ - repositories?: components["schemas"]["repository"][]; + repositories?: components['schemas']['repository'][] /** @example config.yaml */ - single_file?: string | null; + single_file?: string | null /** * @description Describe whether all repositories have been selected or there's a selection involved * @enum {string} */ - repository_selection?: "all" | "selected"; - }; - "audit-log-event": { + repository_selection?: 'all' | 'selected' + } + 'audit-log-event': { /** @description The time the audit log event occurred, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time). */ - "@timestamp"?: number; + '@timestamp'?: number /** @description The name of the action that was performed, for example `user.login` or `repo.create`. */ - action?: string; - active?: boolean; - active_was?: boolean; + action?: string + active?: boolean + active_was?: boolean /** @description The actor who performed the action. */ - actor?: string; + actor?: string /** @description The id of the actor who performed the action. */ - actor_id?: number; + actor_id?: number actor_location?: { - country_name?: string; - }; - data?: { [key: string]: unknown }; - org_id?: number; + country_name?: string + } + data?: { [key: string]: unknown } + org_id?: number /** @description The username of the account being blocked. */ - blocked_user?: string; - business?: string; - config?: { [key: string]: unknown }[]; - config_was?: { [key: string]: unknown }[]; - content_type?: string; + blocked_user?: string + business?: string + config?: { [key: string]: unknown }[] + config_was?: { [key: string]: unknown }[] + content_type?: string /** @description The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time). */ - created_at?: number; - deploy_key_fingerprint?: string; + created_at?: number + deploy_key_fingerprint?: string /** @description A unique identifier for an audit event. */ - _document_id?: string; - emoji?: string; - events?: { [key: string]: unknown }[]; - events_were?: { [key: string]: unknown }[]; - explanation?: string; - fingerprint?: string; - hook_id?: number; - limited_availability?: boolean; - message?: string; - name?: string; - old_user?: string; - openssh_public_key?: string; - org?: string; - previous_visibility?: string; - read_only?: boolean; + _document_id?: string + emoji?: string + events?: { [key: string]: unknown }[] + events_were?: { [key: string]: unknown }[] + explanation?: string + fingerprint?: string + hook_id?: number + limited_availability?: boolean + message?: string + name?: string + old_user?: string + openssh_public_key?: string + org?: string + previous_visibility?: string + read_only?: boolean /** @description The name of the repository. */ - repo?: string; + repo?: string /** @description The name of the repository. */ - repository?: string; - repository_public?: boolean; - target_login?: string; - team?: string; + repository?: string + repository_public?: boolean + target_login?: string + team?: string /** @description The type of protocol (for example, HTTP or SSH) used to transfer Git data. */ - transport_protocol?: number; + transport_protocol?: number /** @description A human readable name for the protocol (for example, HTTP or SSH) used to transfer Git data. */ - transport_protocol_name?: string; + transport_protocol_name?: string /** @description The user that was affected by the action performed (if available). */ - user?: string; + user?: string /** @description The repository visibility, for example `public` or `private`. */ - visibility?: string; - }; + visibility?: string + } /** @description The security alert number. */ - "alert-number": number; + 'alert-number': number /** * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "alert-created-at": string; + 'alert-created-at': string /** * Format: uri * @description The REST API URL of the alert resource. */ - "alert-url": string; + 'alert-url': string /** * Format: uri * @description The GitHub URL of the alert resource. */ - "alert-html-url": string; + 'alert-html-url': string /** * @description Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`. * @enum {string} */ - "secret-scanning-alert-state": "open" | "resolved"; + 'secret-scanning-alert-state': 'open' | 'resolved' /** * @description **Required when the `state` is `resolved`.** The reason for resolving the alert. Can be one of `false_positive`, `wont_fix`, `revoked`, or `used_in_tests`. * @enum {string|null} */ - "secret-scanning-alert-resolution": (null | "false_positive" | "wont_fix" | "revoked" | "used_in_tests") | null; + 'secret-scanning-alert-resolution': (null | 'false_positive' | 'wont_fix' | 'revoked' | 'used_in_tests') | null /** * Repository * @description A git repository */ - "nullable-repository": { + 'nullable-repository': { /** * @description Unique identifier of the repository * @example 42 */ - id: number; + id: number /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - node_id: string; + node_id: string /** * @description The name of the repository. * @example Team Environment */ - name: string; + name: string /** @example octocat/Hello-World */ - full_name: string; - license: components["schemas"]["nullable-license-simple"]; - organization?: components["schemas"]["nullable-simple-user"]; - forks: number; + full_name: string + license: components['schemas']['nullable-license-simple'] + organization?: components['schemas']['nullable-simple-user'] + forks: number permissions?: { - admin: boolean; - pull: boolean; - triage?: boolean; - push: boolean; - maintain?: boolean; - }; - owner: components["schemas"]["simple-user"]; + admin: boolean + pull: boolean + triage?: boolean + push: boolean + maintain?: boolean + } + owner: components['schemas']['simple-user'] /** @description Whether the repository is private or public. */ - private: boolean; + private: boolean /** * Format: uri * @example https://github.com/octocat/Hello-World */ - html_url: string; + html_url: string /** @example This your first repo! */ - description: string | null; - fork: boolean; + description: string | null + fork: boolean /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World */ - url: string; + url: string /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - archive_url: string; + archive_url: string /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - assignees_url: string; + assignees_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - blobs_url: string; + blobs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - branches_url: string; + branches_url: string /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - collaborators_url: string; + collaborators_url: string /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - comments_url: string; + comments_url: string /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - commits_url: string; + commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - compare_url: string; + compare_url: string /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - contents_url: string; + contents_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - contributors_url: string; + contributors_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - deployments_url: string; + deployments_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - downloads_url: string; + downloads_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events */ - events_url: string; + events_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ - forks_url: string; + forks_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - git_commits_url: string; + git_commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - git_refs_url: string; + git_refs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - git_tags_url: string; + git_tags_url: string /** @example git:github.com/octocat/Hello-World.git */ - git_url: string; + git_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - issue_comment_url: string; + issue_comment_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - issue_events_url: string; + issue_events_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - issues_url: string; + issues_url: string /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - keys_url: string; + keys_url: string /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - labels_url: string; + labels_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ - languages_url: string; + languages_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ - merges_url: string; + merges_url: string /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - milestones_url: string; + milestones_url: string /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - notifications_url: string; + notifications_url: string /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - pulls_url: string; + pulls_url: string /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - releases_url: string; + releases_url: string /** @example git@github.com:octocat/Hello-World.git */ - ssh_url: string; + ssh_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - stargazers_url: string; + stargazers_url: string /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - statuses_url: string; + statuses_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - subscribers_url: string; + subscribers_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - subscription_url: string; + subscription_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ - tags_url: string; + tags_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ - teams_url: string; + teams_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - trees_url: string; + trees_url: string /** @example https://github.com/octocat/Hello-World.git */ - clone_url: string; + clone_url: string /** * Format: uri * @example git:git.example.com/octocat/Hello-World */ - mirror_url: string | null; + mirror_url: string | null /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - hooks_url: string; + hooks_url: string /** * Format: uri * @example https://svn.github.com/octocat/Hello-World */ - svn_url: string; + svn_url: string /** * Format: uri * @example https://github.com */ - homepage: string | null; - language: string | null; + homepage: string | null + language: string | null /** @example 9 */ - forks_count: number; + forks_count: number /** @example 80 */ - stargazers_count: number; + stargazers_count: number /** @example 80 */ - watchers_count: number; + watchers_count: number /** @example 108 */ - size: number; + size: number /** * @description The default branch of the repository. * @example master */ - default_branch: string; - open_issues_count: number; + default_branch: string + open_issues_count: number /** * @description Whether this repository acts as a template that can be used to generate new repositories. * @example true */ - is_template?: boolean; - topics?: string[]; + is_template?: boolean + topics?: string[] /** * @description Whether issues are enabled. * @default true * @example true */ - has_issues: boolean; + has_issues: boolean /** * @description Whether projects are enabled. * @default true * @example true */ - has_projects: boolean; + has_projects: boolean /** * @description Whether the wiki is enabled. * @default true * @example true */ - has_wiki: boolean; - has_pages: boolean; + has_wiki: boolean + has_pages: boolean /** * @description Whether downloads are enabled. * @default true * @example true */ - has_downloads: boolean; + has_downloads: boolean /** @description Whether the repository is archived. */ - archived: boolean; + archived: boolean /** @description Returns whether or not this repository disabled. */ - disabled: boolean; + disabled: boolean /** * @description The repository visibility: public, private, or internal. * @default public */ - visibility?: string; + visibility?: string /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - pushed_at: string | null; + pushed_at: string | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - created_at: string | null; + created_at: string | null /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - updated_at: string | null; + updated_at: string | null /** * @description Whether to allow rebase merges for pull requests. * @default true * @example true */ - allow_rebase_merge?: boolean; + allow_rebase_merge?: boolean template_repository?: { - id?: number; - node_id?: string; - name?: string; - full_name?: string; + id?: number + node_id?: string + name?: string + full_name?: string owner?: { - login?: string; - id?: number; - node_id?: string; - avatar_url?: string; - gravatar_id?: string; - url?: string; - html_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - starred_url?: string; - subscriptions_url?: string; - organizations_url?: string; - repos_url?: string; - events_url?: string; - received_events_url?: string; - type?: string; - site_admin?: boolean; - }; - private?: boolean; - html_url?: string; - description?: string; - fork?: boolean; - url?: string; - archive_url?: string; - assignees_url?: string; - blobs_url?: string; - branches_url?: string; - collaborators_url?: string; - comments_url?: string; - commits_url?: string; - compare_url?: string; - contents_url?: string; - contributors_url?: string; - deployments_url?: string; - downloads_url?: string; - events_url?: string; - forks_url?: string; - git_commits_url?: string; - git_refs_url?: string; - git_tags_url?: string; - git_url?: string; - issue_comment_url?: string; - issue_events_url?: string; - issues_url?: string; - keys_url?: string; - labels_url?: string; - languages_url?: string; - merges_url?: string; - milestones_url?: string; - notifications_url?: string; - pulls_url?: string; - releases_url?: string; - ssh_url?: string; - stargazers_url?: string; - statuses_url?: string; - subscribers_url?: string; - subscription_url?: string; - tags_url?: string; - teams_url?: string; - trees_url?: string; - clone_url?: string; - mirror_url?: string; - hooks_url?: string; - svn_url?: string; - homepage?: string; - language?: string; - forks_count?: number; - stargazers_count?: number; - watchers_count?: number; - size?: number; - default_branch?: string; - open_issues_count?: number; - is_template?: boolean; - topics?: string[]; - has_issues?: boolean; - has_projects?: boolean; - has_wiki?: boolean; - has_pages?: boolean; - has_downloads?: boolean; - archived?: boolean; - disabled?: boolean; - visibility?: string; - pushed_at?: string; - created_at?: string; - updated_at?: string; + login?: string + id?: number + node_id?: string + avatar_url?: string + gravatar_id?: string + url?: string + html_url?: string + followers_url?: string + following_url?: string + gists_url?: string + starred_url?: string + subscriptions_url?: string + organizations_url?: string + repos_url?: string + events_url?: string + received_events_url?: string + type?: string + site_admin?: boolean + } + private?: boolean + html_url?: string + description?: string + fork?: boolean + url?: string + archive_url?: string + assignees_url?: string + blobs_url?: string + branches_url?: string + collaborators_url?: string + comments_url?: string + commits_url?: string + compare_url?: string + contents_url?: string + contributors_url?: string + deployments_url?: string + downloads_url?: string + events_url?: string + forks_url?: string + git_commits_url?: string + git_refs_url?: string + git_tags_url?: string + git_url?: string + issue_comment_url?: string + issue_events_url?: string + issues_url?: string + keys_url?: string + labels_url?: string + languages_url?: string + merges_url?: string + milestones_url?: string + notifications_url?: string + pulls_url?: string + releases_url?: string + ssh_url?: string + stargazers_url?: string + statuses_url?: string + subscribers_url?: string + subscription_url?: string + tags_url?: string + teams_url?: string + trees_url?: string + clone_url?: string + mirror_url?: string + hooks_url?: string + svn_url?: string + homepage?: string + language?: string + forks_count?: number + stargazers_count?: number + watchers_count?: number + size?: number + default_branch?: string + open_issues_count?: number + is_template?: boolean + topics?: string[] + has_issues?: boolean + has_projects?: boolean + has_wiki?: boolean + has_pages?: boolean + has_downloads?: boolean + archived?: boolean + disabled?: boolean + visibility?: string + pushed_at?: string + created_at?: string + updated_at?: string permissions?: { - admin?: boolean; - maintain?: boolean; - push?: boolean; - triage?: boolean; - pull?: boolean; - }; - allow_rebase_merge?: boolean; - temp_clone_token?: string; - allow_squash_merge?: boolean; - allow_auto_merge?: boolean; - delete_branch_on_merge?: boolean; - allow_update_branch?: boolean; - allow_merge_commit?: boolean; - subscribers_count?: number; - network_count?: number; - } | null; - temp_clone_token?: string; + admin?: boolean + maintain?: boolean + push?: boolean + triage?: boolean + pull?: boolean + } + allow_rebase_merge?: boolean + temp_clone_token?: string + allow_squash_merge?: boolean + allow_auto_merge?: boolean + delete_branch_on_merge?: boolean + allow_update_branch?: boolean + allow_merge_commit?: boolean + subscribers_count?: number + network_count?: number + } | null + temp_clone_token?: string /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - allow_squash_merge?: boolean; + allow_squash_merge?: boolean /** @description Whether to allow Auto-merge to be used on pull requests. */ - allow_auto_merge?: boolean; + allow_auto_merge?: boolean /** @description Whether to delete head branches when pull requests are merged */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge?: boolean /** * @description Whether to allow merge commits for pull requests. * @default true * @example true */ - allow_merge_commit?: boolean; + allow_merge_commit?: boolean /** @description Whether to allow forking this repo */ - allow_forking?: boolean; - subscribers_count?: number; - network_count?: number; - open_issues: number; - watchers: number; - master_branch?: string; + allow_forking?: boolean + subscribers_count?: number + network_count?: number + open_issues: number + watchers: number + master_branch?: string /** @example "2020-07-09T00:17:42Z" */ - starred_at?: string; - } | null; + starred_at?: string + } | null /** * Minimal Repository * @description Minimal Repository */ - "minimal-repository": { + 'minimal-repository': { /** @example 1296269 */ - id: number; + id: number /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - node_id: string; + node_id: string /** @example Hello-World */ - name: string; + name: string /** @example octocat/Hello-World */ - full_name: string; - owner: components["schemas"]["simple-user"]; - private: boolean; + full_name: string + owner: components['schemas']['simple-user'] + private: boolean /** * Format: uri * @example https://github.com/octocat/Hello-World */ - html_url: string; + html_url: string /** @example This your first repo! */ - description: string | null; - fork: boolean; + description: string | null + fork: boolean /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World */ - url: string; + url: string /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - archive_url: string; + archive_url: string /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - assignees_url: string; + assignees_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - blobs_url: string; + blobs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - branches_url: string; + branches_url: string /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - collaborators_url: string; + collaborators_url: string /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - comments_url: string; + comments_url: string /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - commits_url: string; + commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - compare_url: string; + compare_url: string /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - contents_url: string; + contents_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - contributors_url: string; + contributors_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - deployments_url: string; + deployments_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - downloads_url: string; + downloads_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events */ - events_url: string; + events_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ - forks_url: string; + forks_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - git_commits_url: string; + git_commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - git_refs_url: string; + git_refs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - git_tags_url: string; - git_url?: string; + git_tags_url: string + git_url?: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - issue_comment_url: string; + issue_comment_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - issue_events_url: string; + issue_events_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - issues_url: string; + issues_url: string /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - keys_url: string; + keys_url: string /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - labels_url: string; + labels_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ - languages_url: string; + languages_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ - merges_url: string; + merges_url: string /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - milestones_url: string; + milestones_url: string /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - notifications_url: string; + notifications_url: string /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - pulls_url: string; + pulls_url: string /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - releases_url: string; - ssh_url?: string; + releases_url: string + ssh_url?: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - stargazers_url: string; + stargazers_url: string /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - statuses_url: string; + statuses_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - subscribers_url: string; + subscribers_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - subscription_url: string; + subscription_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ - tags_url: string; + tags_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ - teams_url: string; + teams_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - trees_url: string; - clone_url?: string; - mirror_url?: string | null; + trees_url: string + clone_url?: string + mirror_url?: string | null /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - hooks_url: string; - svn_url?: string; - homepage?: string | null; - language?: string | null; - forks_count?: number; - stargazers_count?: number; - watchers_count?: number; - size?: number; - default_branch?: string; - open_issues_count?: number; - is_template?: boolean; - topics?: string[]; - has_issues?: boolean; - has_projects?: boolean; - has_wiki?: boolean; - has_pages?: boolean; - has_downloads?: boolean; - archived?: boolean; - disabled?: boolean; - visibility?: string; + hooks_url: string + svn_url?: string + homepage?: string | null + language?: string | null + forks_count?: number + stargazers_count?: number + watchers_count?: number + size?: number + default_branch?: string + open_issues_count?: number + is_template?: boolean + topics?: string[] + has_issues?: boolean + has_projects?: boolean + has_wiki?: boolean + has_pages?: boolean + has_downloads?: boolean + archived?: boolean + disabled?: boolean + visibility?: string /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - pushed_at?: string | null; + pushed_at?: string | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - created_at?: string | null; + created_at?: string | null /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - updated_at?: string | null; + updated_at?: string | null permissions?: { - admin?: boolean; - maintain?: boolean; - push?: boolean; - triage?: boolean; - pull?: boolean; - }; + admin?: boolean + maintain?: boolean + push?: boolean + triage?: boolean + pull?: boolean + } /** @example admin */ - role_name?: string; - template_repository?: components["schemas"]["nullable-repository"]; - temp_clone_token?: string; - delete_branch_on_merge?: boolean; - subscribers_count?: number; - network_count?: number; - code_of_conduct?: components["schemas"]["code-of-conduct"]; + role_name?: string + template_repository?: components['schemas']['nullable-repository'] + temp_clone_token?: string + delete_branch_on_merge?: boolean + subscribers_count?: number + network_count?: number + code_of_conduct?: components['schemas']['code-of-conduct'] license?: { - key?: string; - name?: string; - spdx_id?: string; - url?: string; - node_id?: string; - } | null; - forks?: number; - open_issues?: number; - watchers?: number; - allow_forking?: boolean; - }; - "organization-secret-scanning-alert": { - number?: components["schemas"]["alert-number"]; - created_at?: components["schemas"]["alert-created-at"]; - url?: components["schemas"]["alert-url"]; - html_url?: components["schemas"]["alert-html-url"]; + key?: string + name?: string + spdx_id?: string + url?: string + node_id?: string + } | null + forks?: number + open_issues?: number + watchers?: number + allow_forking?: boolean + } + 'organization-secret-scanning-alert': { + number?: components['schemas']['alert-number'] + created_at?: components['schemas']['alert-created-at'] + url?: components['schemas']['alert-url'] + html_url?: components['schemas']['alert-html-url'] /** * Format: uri * @description The REST API URL of the code locations for this alert. */ - locations_url?: string; - state?: components["schemas"]["secret-scanning-alert-state"]; - resolution?: components["schemas"]["secret-scanning-alert-resolution"]; + locations_url?: string + state?: components['schemas']['secret-scanning-alert-state'] + resolution?: components['schemas']['secret-scanning-alert-resolution'] /** * Format: date-time * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - resolved_at?: string | null; - resolved_by?: components["schemas"]["nullable-simple-user"]; + resolved_at?: string | null + resolved_by?: components['schemas']['nullable-simple-user'] /** @description The type of secret that secret scanning detected. */ - secret_type?: string; + secret_type?: string /** @description The secret that was detected. */ - secret?: string; - repository?: components["schemas"]["minimal-repository"]; - }; - "actions-billing-usage": { + secret?: string + repository?: components['schemas']['minimal-repository'] + } + 'actions-billing-usage': { /** @description The sum of the free and paid GitHub Actions minutes used. */ - total_minutes_used: number; + total_minutes_used: number /** @description The total paid GitHub Actions minutes used. */ - total_paid_minutes_used: number; + total_paid_minutes_used: number /** @description The amount of free GitHub Actions minutes available. */ - included_minutes: number; + included_minutes: number minutes_used_breakdown: { /** @description Total minutes used on Ubuntu runner machines. */ - UBUNTU?: number; + UBUNTU?: number /** @description Total minutes used on macOS runner machines. */ - MACOS?: number; + MACOS?: number /** @description Total minutes used on Windows runner machines. */ - WINDOWS?: number; - }; - }; - "advanced-security-active-committers-user": { - user_login: string; + WINDOWS?: number + } + } + 'advanced-security-active-committers-user': { + user_login: string /** @example 2021-11-03 */ - last_pushed_date: string; - }; - "advanced-security-active-committers-repository": { + last_pushed_date: string + } + 'advanced-security-active-committers-repository': { /** @example octocat/Hello-World */ - name: string; + name: string /** @example 25 */ - advanced_security_committers: number; - advanced_security_committers_breakdown: components["schemas"]["advanced-security-active-committers-user"][]; - }; - "advanced-security-active-committers": { + advanced_security_committers: number + advanced_security_committers_breakdown: components['schemas']['advanced-security-active-committers-user'][] + } + 'advanced-security-active-committers': { /** @example 25 */ - total_advanced_security_committers?: number; - repositories: components["schemas"]["advanced-security-active-committers-repository"][]; - }; - "packages-billing-usage": { + total_advanced_security_committers?: number + repositories: components['schemas']['advanced-security-active-committers-repository'][] + } + 'packages-billing-usage': { /** @description Sum of the free and paid storage space (GB) for GitHuub Packages. */ - total_gigabytes_bandwidth_used: number; + total_gigabytes_bandwidth_used: number /** @description Total paid storage space (GB) for GitHuub Packages. */ - total_paid_gigabytes_bandwidth_used: number; + total_paid_gigabytes_bandwidth_used: number /** @description Free storage space (GB) for GitHub Packages. */ - included_gigabytes_bandwidth: number; - }; - "combined-billing-usage": { + included_gigabytes_bandwidth: number + } + 'combined-billing-usage': { /** @description Numbers of days left in billing cycle. */ - days_left_in_billing_cycle: number; + days_left_in_billing_cycle: number /** @description Estimated storage space (GB) used in billing cycle. */ - estimated_paid_storage_for_month: number; + estimated_paid_storage_for_month: number /** @description Estimated sum of free and paid storage space (GB) used in billing cycle. */ - estimated_storage_for_month: number; - }; + estimated_storage_for_month: number + } /** * Actor * @description Actor */ actor: { - id: number; - login: string; - display_login?: string; - gravatar_id: string | null; + id: number + login: string + display_login?: string + gravatar_id: string | null /** Format: uri */ - url: string; + url: string /** Format: uri */ - avatar_url: string; - }; + avatar_url: string + } /** * Milestone * @description A collection of related issues and pull requests. */ - "nullable-milestone": { + 'nullable-milestone': { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1 */ - url: string; + url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/milestones/v1.0 */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1/labels */ - labels_url: string; + labels_url: string /** @example 1002604 */ - id: number; + id: number /** @example MDk6TWlsZXN0b25lMTAwMjYwNA== */ - node_id: string; + node_id: string /** * @description The number of the milestone. * @example 42 */ - number: number; + number: number /** * @description The state of the milestone. * @default open * @example open * @enum {string} */ - state: "open" | "closed"; + state: 'open' | 'closed' /** * @description The title of the milestone. * @example v1.0 */ - title: string; + title: string /** @example Tracking milestone for version 1.0 */ - description: string | null; - creator: components["schemas"]["nullable-simple-user"]; + description: string | null + creator: components['schemas']['nullable-simple-user'] /** @example 4 */ - open_issues: number; + open_issues: number /** @example 8 */ - closed_issues: number; + closed_issues: number /** * Format: date-time * @example 2011-04-10T20:09:31Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2014-03-03T18:58:10Z */ - updated_at: string; + updated_at: string /** * Format: date-time * @example 2013-02-12T13:22:01Z */ - closed_at: string | null; + closed_at: string | null /** * Format: date-time * @example 2012-10-09T23:39:01Z */ - due_on: string | null; - } | null; + due_on: string | null + } | null /** * GitHub app * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - "nullable-integration": { + 'nullable-integration': { /** * @description Unique identifier of the GitHub app * @example 37 */ - id: number; + id: number /** * @description The slug name of the GitHub app * @example probot-owners */ - slug?: string; + slug?: string /** @example MDExOkludGVncmF0aW9uMQ== */ - node_id: string; - owner: components["schemas"]["nullable-simple-user"]; + node_id: string + owner: components['schemas']['nullable-simple-user'] /** * @description The name of the GitHub app * @example Probot Owners */ - name: string; + name: string /** @example The description of the app. */ - description: string | null; + description: string | null /** * Format: uri * @example https://example.com */ - external_url: string; + external_url: string /** * Format: uri * @example https://github.com/apps/super-ci */ - html_url: string; + html_url: string /** * Format: date-time * @example 2017-07-08T16:18:44-04:00 */ - created_at: string; + created_at: string /** * Format: date-time * @example 2017-07-08T16:18:44-04:00 */ - updated_at: string; + updated_at: string /** * @description The set of permissions for the GitHub app * @example [object Object] */ permissions: { - issues?: string; - checks?: string; - metadata?: string; - contents?: string; - deployments?: string; - } & { [key: string]: string }; + issues?: string + checks?: string + metadata?: string + contents?: string + deployments?: string + } & { [key: string]: string } /** * @description The list of events for the GitHub app * @example label,deployment */ - events: string[]; + events: string[] /** * @description The number of installations associated with the GitHub app * @example 5 */ - installations_count?: number; + installations_count?: number /** @example "Iv1.25b5d1e65ffc4022" */ - client_id?: string; + client_id?: string /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ - client_secret?: string; + client_secret?: string /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ - webhook_secret?: string | null; + webhook_secret?: string | null /** @example "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n" */ - pem?: string; - } | null; + pem?: string + } | null /** * author_association * @description How the author is associated with the repository. * @example OWNER * @enum {string} */ - author_association: - | "COLLABORATOR" - | "CONTRIBUTOR" - | "FIRST_TIMER" - | "FIRST_TIME_CONTRIBUTOR" - | "MANNEQUIN" - | "MEMBER" - | "NONE" - | "OWNER"; + author_association: 'COLLABORATOR' | 'CONTRIBUTOR' | 'FIRST_TIMER' | 'FIRST_TIME_CONTRIBUTOR' | 'MANNEQUIN' | 'MEMBER' | 'NONE' | 'OWNER' /** Reaction Rollup */ - "reaction-rollup": { + 'reaction-rollup': { /** Format: uri */ - url: string; - total_count: number; - "+1": number; - "-1": number; - laugh: number; - confused: number; - heart: number; - hooray: number; - eyes: number; - rocket: number; - }; + url: string + total_count: number + '+1': number + '-1': number + laugh: number + confused: number + heart: number + hooray: number + eyes: number + rocket: number + } /** * Issue * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. */ issue: { - id: number; - node_id: string; + id: number + node_id: string /** * Format: uri * @description URL for the issue * @example https://api.github.com/repositories/42/issues/1 */ - url: string; + url: string /** Format: uri */ - repository_url: string; - labels_url: string; + repository_url: string + labels_url: string /** Format: uri */ - comments_url: string; + comments_url: string /** Format: uri */ - events_url: string; + events_url: string /** Format: uri */ - html_url: string; + html_url: string /** * @description Number uniquely identifying the issue within its repository * @example 42 */ - number: number; + number: number /** * @description State of the issue; either 'open' or 'closed' * @example open */ - state: string; + state: string /** * @description Title of the issue * @example Widget creation fails in Safari on OS X 10.8 */ - title: string; + title: string /** * @description Contents of the issue * @example It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug? */ - body?: string | null; - user: components["schemas"]["nullable-simple-user"]; + body?: string | null + user: components['schemas']['nullable-simple-user'] /** * @description Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository * @example bug,registration @@ -8380,448 +8372,448 @@ export interface components { | string | { /** Format: int64 */ - id?: number; - node_id?: string; + id?: number + node_id?: string /** Format: uri */ - url?: string; - name?: string; - description?: string | null; - color?: string | null; - default?: boolean; + url?: string + name?: string + description?: string | null + color?: string | null + default?: boolean } - )[]; - assignee: components["schemas"]["nullable-simple-user"]; - assignees?: components["schemas"]["simple-user"][] | null; - milestone: components["schemas"]["nullable-milestone"]; - locked: boolean; - active_lock_reason?: string | null; - comments: number; + )[] + assignee: components['schemas']['nullable-simple-user'] + assignees?: components['schemas']['simple-user'][] | null + milestone: components['schemas']['nullable-milestone'] + locked: boolean + active_lock_reason?: string | null + comments: number pull_request?: { /** Format: date-time */ - merged_at?: string | null; + merged_at?: string | null /** Format: uri */ - diff_url: string | null; + diff_url: string | null /** Format: uri */ - html_url: string | null; + html_url: string | null /** Format: uri */ - patch_url: string | null; + patch_url: string | null /** Format: uri */ - url: string | null; - }; + url: string | null + } /** Format: date-time */ - closed_at: string | null; + closed_at: string | null /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - draft?: boolean; - closed_by?: components["schemas"]["nullable-simple-user"]; - body_html?: string; - body_text?: string; + updated_at: string + draft?: boolean + closed_by?: components['schemas']['nullable-simple-user'] + body_html?: string + body_text?: string /** Format: uri */ - timeline_url?: string; - repository?: components["schemas"]["repository"]; - performed_via_github_app?: components["schemas"]["nullable-integration"]; - author_association: components["schemas"]["author_association"]; - reactions?: components["schemas"]["reaction-rollup"]; - }; + timeline_url?: string + repository?: components['schemas']['repository'] + performed_via_github_app?: components['schemas']['nullable-integration'] + author_association: components['schemas']['author_association'] + reactions?: components['schemas']['reaction-rollup'] + } /** * Issue Comment * @description Comments provide a way for people to collaborate on an issue. */ - "issue-comment": { + 'issue-comment': { /** * @description Unique identifier of the issue comment * @example 42 */ - id: number; - node_id: string; + id: number + node_id: string /** * Format: uri * @description URL for the issue comment * @example https://api.github.com/repositories/42/issues/comments/1 */ - url: string; + url: string /** * @description Contents of the issue comment * @example What version of Safari were you using when you observed this bug? */ - body?: string; - body_text?: string; - body_html?: string; + body?: string + body_text?: string + body_html?: string /** Format: uri */ - html_url: string; - user: components["schemas"]["nullable-simple-user"]; + html_url: string + user: components['schemas']['nullable-simple-user'] /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - updated_at: string; + updated_at: string /** Format: uri */ - issue_url: string; - author_association: components["schemas"]["author_association"]; - performed_via_github_app?: components["schemas"]["nullable-integration"]; - reactions?: components["schemas"]["reaction-rollup"]; - }; + issue_url: string + author_association: components['schemas']['author_association'] + performed_via_github_app?: components['schemas']['nullable-integration'] + reactions?: components['schemas']['reaction-rollup'] + } /** * Event * @description Event */ event: { - id: string; - type: string | null; - actor: components["schemas"]["actor"]; + id: string + type: string | null + actor: components['schemas']['actor'] repo: { - id: number; - name: string; + id: number + name: string /** Format: uri */ - url: string; - }; - org?: components["schemas"]["actor"]; + url: string + } + org?: components['schemas']['actor'] payload: { - action?: string; - issue?: components["schemas"]["issue"]; - comment?: components["schemas"]["issue-comment"]; + action?: string + issue?: components['schemas']['issue'] + comment?: components['schemas']['issue-comment'] pages?: { - page_name?: string; - title?: string; - summary?: string | null; - action?: string; - sha?: string; - html_url?: string; - }[]; - }; - public: boolean; + page_name?: string + title?: string + summary?: string | null + action?: string + sha?: string + html_url?: string + }[] + } + public: boolean /** Format: date-time */ - created_at: string | null; - }; + created_at: string | null + } /** * Link With Type * @description Hypermedia Link with Type */ - "link-with-type": { - href: string; - type: string; - }; + 'link-with-type': { + href: string + type: string + } /** * Feed * @description Feed */ feed: { /** @example https://github.com/timeline */ - timeline_url: string; + timeline_url: string /** @example https://github.com/{user} */ - user_url: string; + user_url: string /** @example https://github.com/octocat */ - current_user_public_url?: string; + current_user_public_url?: string /** @example https://github.com/octocat.private?token=abc123 */ - current_user_url?: string; + current_user_url?: string /** @example https://github.com/octocat.private.actor?token=abc123 */ - current_user_actor_url?: string; + current_user_actor_url?: string /** @example https://github.com/octocat-org */ - current_user_organization_url?: string; + current_user_organization_url?: string /** @example https://github.com/organizations/github/octocat.private.atom?token=abc123 */ - current_user_organization_urls?: string[]; + current_user_organization_urls?: string[] /** @example https://github.com/security-advisories */ - security_advisories_url?: string; + security_advisories_url?: string _links: { - timeline: components["schemas"]["link-with-type"]; - user: components["schemas"]["link-with-type"]; - security_advisories?: components["schemas"]["link-with-type"]; - current_user?: components["schemas"]["link-with-type"]; - current_user_public?: components["schemas"]["link-with-type"]; - current_user_actor?: components["schemas"]["link-with-type"]; - current_user_organization?: components["schemas"]["link-with-type"]; - current_user_organizations?: components["schemas"]["link-with-type"][]; - }; - }; + timeline: components['schemas']['link-with-type'] + user: components['schemas']['link-with-type'] + security_advisories?: components['schemas']['link-with-type'] + current_user?: components['schemas']['link-with-type'] + current_user_public?: components['schemas']['link-with-type'] + current_user_actor?: components['schemas']['link-with-type'] + current_user_organization?: components['schemas']['link-with-type'] + current_user_organizations?: components['schemas']['link-with-type'][] + } + } /** * Base Gist * @description Base Gist */ - "base-gist": { + 'base-gist': { /** Format: uri */ - url: string; + url: string /** Format: uri */ - forks_url: string; + forks_url: string /** Format: uri */ - commits_url: string; - id: string; - node_id: string; + commits_url: string + id: string + node_id: string /** Format: uri */ - git_pull_url: string; + git_pull_url: string /** Format: uri */ - git_push_url: string; + git_push_url: string /** Format: uri */ - html_url: string; + html_url: string files: { [key: string]: { - filename?: string; - type?: string; - language?: string; - raw_url?: string; - size?: number; - }; - }; - public: boolean; + filename?: string + type?: string + language?: string + raw_url?: string + size?: number + } + } + public: boolean /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - description: string | null; - comments: number; - user: components["schemas"]["nullable-simple-user"]; + updated_at: string + description: string | null + comments: number + user: components['schemas']['nullable-simple-user'] /** Format: uri */ - comments_url: string; - owner?: components["schemas"]["simple-user"]; - truncated?: boolean; - forks?: unknown[]; - history?: unknown[]; - }; + comments_url: string + owner?: components['schemas']['simple-user'] + truncated?: boolean + forks?: unknown[] + history?: unknown[] + } /** * Public User * @description Public User */ - "public-user": { - login: string; - id: number; - node_id: string; + 'public-user': { + login: string + id: number + node_id: string /** Format: uri */ - avatar_url: string; - gravatar_id: string | null; + avatar_url: string + gravatar_id: string | null /** Format: uri */ - url: string; + url: string /** Format: uri */ - html_url: string; + html_url: string /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - starred_url: string; + followers_url: string + following_url: string + gists_url: string + starred_url: string /** Format: uri */ - subscriptions_url: string; + subscriptions_url: string /** Format: uri */ - organizations_url: string; + organizations_url: string /** Format: uri */ - repos_url: string; - events_url: string; + repos_url: string + events_url: string /** Format: uri */ - received_events_url: string; - type: string; - site_admin: boolean; - name: string | null; - company: string | null; - blog: string | null; - location: string | null; + received_events_url: string + type: string + site_admin: boolean + name: string | null + company: string | null + blog: string | null + location: string | null /** Format: email */ - email: string | null; - hireable: boolean | null; - bio: string | null; - twitter_username?: string | null; - public_repos: number; - public_gists: number; - followers: number; - following: number; + email: string | null + hireable: boolean | null + bio: string | null + twitter_username?: string | null + public_repos: number + public_gists: number + followers: number + following: number /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; + updated_at: string plan?: { - collaborators: number; - name: string; - space: number; - private_repos: number; - }; + collaborators: number + name: string + space: number + private_repos: number + } /** Format: date-time */ - suspended_at?: string | null; + suspended_at?: string | null /** @example 1 */ - private_gists?: number; + private_gists?: number /** @example 2 */ - total_private_repos?: number; + total_private_repos?: number /** @example 2 */ - owned_private_repos?: number; + owned_private_repos?: number /** @example 1 */ - disk_usage?: number; + disk_usage?: number /** @example 3 */ - collaborators?: number; - }; + collaborators?: number + } /** * Gist History * @description Gist History */ - "gist-history": { - user?: components["schemas"]["nullable-simple-user"]; - version?: string; + 'gist-history': { + user?: components['schemas']['nullable-simple-user'] + version?: string /** Format: date-time */ - committed_at?: string; + committed_at?: string change_status?: { - total?: number; - additions?: number; - deletions?: number; - }; + total?: number + additions?: number + deletions?: number + } /** Format: uri */ - url?: string; - }; + url?: string + } /** * Gist Simple * @description Gist Simple */ - "gist-simple": { + 'gist-simple': { /** @deprecated */ forks?: | { - id?: string; + id?: string /** Format: uri */ - url?: string; - user?: components["schemas"]["public-user"]; + url?: string + user?: components['schemas']['public-user'] /** Format: date-time */ - created_at?: string; + created_at?: string /** Format: date-time */ - updated_at?: string; + updated_at?: string }[] - | null; + | null /** @deprecated */ - history?: components["schemas"]["gist-history"][] | null; + history?: components['schemas']['gist-history'][] | null /** * Gist * @description Gist */ fork_of?: { /** Format: uri */ - url: string; + url: string /** Format: uri */ - forks_url: string; + forks_url: string /** Format: uri */ - commits_url: string; - id: string; - node_id: string; + commits_url: string + id: string + node_id: string /** Format: uri */ - git_pull_url: string; + git_pull_url: string /** Format: uri */ - git_push_url: string; + git_push_url: string /** Format: uri */ - html_url: string; + html_url: string files: { [key: string]: { - filename?: string; - type?: string; - language?: string; - raw_url?: string; - size?: number; - }; - }; - public: boolean; + filename?: string + type?: string + language?: string + raw_url?: string + size?: number + } + } + public: boolean /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - description: string | null; - comments: number; - user: components["schemas"]["nullable-simple-user"]; + updated_at: string + description: string | null + comments: number + user: components['schemas']['nullable-simple-user'] /** Format: uri */ - comments_url: string; - owner?: components["schemas"]["nullable-simple-user"]; - truncated?: boolean; - forks?: unknown[]; - history?: unknown[]; - } | null; - url?: string; - forks_url?: string; - commits_url?: string; - id?: string; - node_id?: string; - git_pull_url?: string; - git_push_url?: string; - html_url?: string; + comments_url: string + owner?: components['schemas']['nullable-simple-user'] + truncated?: boolean + forks?: unknown[] + history?: unknown[] + } | null + url?: string + forks_url?: string + commits_url?: string + id?: string + node_id?: string + git_pull_url?: string + git_push_url?: string + html_url?: string files?: { [key: string]: { - filename?: string; - type?: string; - language?: string; - raw_url?: string; - size?: number; - truncated?: boolean; - content?: string; - } | null; - }; - public?: boolean; - created_at?: string; - updated_at?: string; - description?: string | null; - comments?: number; - user?: string | null; - comments_url?: string; - owner?: components["schemas"]["simple-user"]; - truncated?: boolean; - }; + filename?: string + type?: string + language?: string + raw_url?: string + size?: number + truncated?: boolean + content?: string + } | null + } + public?: boolean + created_at?: string + updated_at?: string + description?: string | null + comments?: number + user?: string | null + comments_url?: string + owner?: components['schemas']['simple-user'] + truncated?: boolean + } /** * Gist Comment * @description A comment made to a gist. */ - "gist-comment": { + 'gist-comment': { /** @example 1 */ - id: number; + id: number /** @example MDExOkdpc3RDb21tZW50MQ== */ - node_id: string; + node_id: string /** * Format: uri * @example https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 */ - url: string; + url: string /** * @description The comment text. * @example Body of the attachment */ - body: string; - user: components["schemas"]["nullable-simple-user"]; + body: string + user: components['schemas']['nullable-simple-user'] /** * Format: date-time * @example 2011-04-18T23:23:56Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2011-04-18T23:23:56Z */ - updated_at: string; - author_association: components["schemas"]["author_association"]; - }; + updated_at: string + author_association: components['schemas']['author_association'] + } /** * Gist Commit * @description Gist Commit */ - "gist-commit": { + 'gist-commit': { /** * Format: uri * @example https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f */ - url: string; + url: string /** @example 57a7f021a713b1c5a6a199b54cc514735d2d462f */ - version: string; - user: components["schemas"]["nullable-simple-user"]; + version: string + user: components['schemas']['nullable-simple-user'] change_status: { - total?: number; - additions?: number; - deletions?: number; - }; + total?: number + additions?: number + deletions?: number + } /** * Format: date-time * @example 2010-04-14T02:15:15Z */ - committed_at: string; - }; + committed_at: string + } /** * Gitignore Template * @description Gitignore Template */ - "gitignore-template": { + 'gitignore-template': { /** @example C */ - name: string; + name: string /** * @example # Object files * *.o @@ -8841,62 +8833,62 @@ export interface components { * *.out * *.app */ - source: string; - }; + source: string + } /** * License Simple * @description License Simple */ - "license-simple": { + 'license-simple': { /** @example mit */ - key: string; + key: string /** @example MIT License */ - name: string; + name: string /** * Format: uri * @example https://api.github.com/licenses/mit */ - url: string | null; + url: string | null /** @example MIT */ - spdx_id: string | null; + spdx_id: string | null /** @example MDc6TGljZW5zZW1pdA== */ - node_id: string; + node_id: string /** Format: uri */ - html_url?: string; - }; + html_url?: string + } /** * License * @description License */ license: { /** @example mit */ - key: string; + key: string /** @example MIT License */ - name: string; + name: string /** @example MIT */ - spdx_id: string | null; + spdx_id: string | null /** * Format: uri * @example https://api.github.com/licenses/mit */ - url: string | null; + url: string | null /** @example MDc6TGljZW5zZW1pdA== */ - node_id: string; + node_id: string /** * Format: uri * @example http://choosealicense.com/licenses/mit/ */ - html_url: string; + html_url: string /** @example A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty. */ - description: string; + description: string /** @example Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders. */ - implementation: string; + implementation: string /** @example commercial-use,modifications,distribution,sublicense,private-use */ - permissions: string[]; + permissions: string[] /** @example include-copyright */ - conditions: string[]; + conditions: string[] /** @example no-liability */ - limitations: string[]; + limitations: string[] /** * @example * @@ -8922,174 +8914,174 @@ export interface components { * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ - body: string; + body: string /** @example true */ - featured: boolean; - }; + featured: boolean + } /** * Marketplace Listing Plan * @description Marketplace Listing Plan */ - "marketplace-listing-plan": { + 'marketplace-listing-plan': { /** * Format: uri * @example https://api.github.com/marketplace_listing/plans/1313 */ - url: string; + url: string /** * Format: uri * @example https://api.github.com/marketplace_listing/plans/1313/accounts */ - accounts_url: string; + accounts_url: string /** @example 1313 */ - id: number; + id: number /** @example 3 */ - number: number; + number: number /** @example Pro */ - name: string; + name: string /** @example A professional-grade CI solution */ - description: string; + description: string /** @example 1099 */ - monthly_price_in_cents: number; + monthly_price_in_cents: number /** @example 11870 */ - yearly_price_in_cents: number; + yearly_price_in_cents: number /** @example flat-rate */ - price_model: string; + price_model: string /** @example true */ - has_free_trial: boolean; - unit_name: string | null; + has_free_trial: boolean + unit_name: string | null /** @example published */ - state: string; + state: string /** @example Up to 25 private repositories,11 concurrent builds */ - bullets: string[]; - }; + bullets: string[] + } /** * Marketplace Purchase * @description Marketplace Purchase */ - "marketplace-purchase": { - url: string; - type: string; - id: number; - login: string; - organization_billing_email?: string; - email?: string | null; + 'marketplace-purchase': { + url: string + type: string + id: number + login: string + organization_billing_email?: string + email?: string | null marketplace_pending_change?: { - is_installed?: boolean; - effective_date?: string; - unit_count?: number | null; - id?: number; - plan?: components["schemas"]["marketplace-listing-plan"]; - } | null; + is_installed?: boolean + effective_date?: string + unit_count?: number | null + id?: number + plan?: components['schemas']['marketplace-listing-plan'] + } | null marketplace_purchase: { - billing_cycle?: string; - next_billing_date?: string | null; - is_installed?: boolean; - unit_count?: number | null; - on_free_trial?: boolean; - free_trial_ends_on?: string | null; - updated_at?: string; - plan?: components["schemas"]["marketplace-listing-plan"]; - }; - }; + billing_cycle?: string + next_billing_date?: string | null + is_installed?: boolean + unit_count?: number | null + on_free_trial?: boolean + free_trial_ends_on?: string | null + updated_at?: string + plan?: components['schemas']['marketplace-listing-plan'] + } + } /** * Api Overview * @description Api Overview */ - "api-overview": { + 'api-overview': { /** @example true */ - verifiable_password_authentication: boolean; + verifiable_password_authentication: boolean ssh_key_fingerprints?: { - SHA256_RSA?: string; - SHA256_DSA?: string; - SHA256_ECDSA?: string; - SHA256_ED25519?: string; - }; + SHA256_RSA?: string + SHA256_DSA?: string + SHA256_ECDSA?: string + SHA256_ED25519?: string + } /** @example ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIOMqqnkVzrm0SdG6UOoqKLsabgH5C9okWi0dh2l9GKJl */ - ssh_keys?: string[]; + ssh_keys?: string[] /** @example 127.0.0.1/32 */ - hooks?: string[]; + hooks?: string[] /** @example 127.0.0.1/32 */ - web?: string[]; + web?: string[] /** @example 127.0.0.1/32 */ - api?: string[]; + api?: string[] /** @example 127.0.0.1/32 */ - git?: string[]; + git?: string[] /** @example 13.65.0.0/16,157.55.204.33/32,2a01:111:f403:f90c::/62 */ - packages?: string[]; + packages?: string[] /** @example 192.30.252.153/32,192.30.252.154/32 */ - pages?: string[]; + pages?: string[] /** @example 54.158.161.132,54.226.70.38 */ - importer?: string[]; + importer?: string[] /** @example 13.64.0.0/16,13.65.0.0/16 */ - actions?: string[]; + actions?: string[] /** @example 192.168.7.15/32,192.168.7.16/32 */ - dependabot?: string[]; - }; + dependabot?: string[] + } /** * Thread * @description Thread */ thread: { - id: string; - repository: components["schemas"]["minimal-repository"]; + id: string + repository: components['schemas']['minimal-repository'] subject: { - title: string; - url: string; - latest_comment_url: string; - type: string; - }; - reason: string; - unread: boolean; - updated_at: string; - last_read_at: string | null; - url: string; + title: string + url: string + latest_comment_url: string + type: string + } + reason: string + unread: boolean + updated_at: string + last_read_at: string | null + url: string /** @example https://api.github.com/notifications/threads/2/subscription */ - subscription_url: string; - }; + subscription_url: string + } /** * Thread Subscription * @description Thread Subscription */ - "thread-subscription": { + 'thread-subscription': { /** @example true */ - subscribed: boolean; - ignored: boolean; - reason: string | null; + subscribed: boolean + ignored: boolean + reason: string | null /** * Format: date-time * @example 2012-10-06T21:34:12Z */ - created_at: string | null; + created_at: string | null /** * Format: uri * @example https://api.github.com/notifications/threads/1/subscription */ - url: string; + url: string /** * Format: uri * @example https://api.github.com/notifications/threads/1 */ - thread_url?: string; + thread_url?: string /** * Format: uri * @example https://api.github.com/repos/1 */ - repository_url?: string; - }; + repository_url?: string + } /** * Organization Custom Repository Role * @description Custom repository roles created by organization administrators */ - "organization-custom-repository-role": { - id: number; - name: string; - }; + 'organization-custom-repository-role': { + id: number + name: string + } /** * ExternalGroups * @description A list of external groups available to be connected to a team */ - "external-groups": { + 'external-groups': { /** * @description An array of external groups available to be mapped to a team * @example [object Object],[object Object] @@ -9099,488 +9091,488 @@ export interface components { * @description The internal ID of the group * @example 1 */ - group_id: number; + group_id: number /** * @description The display name of the group * @example group-azuread-test */ - group_name: string; + group_name: string /** * @description The time of the last update for this group * @example 2019-06-03 22:27:15:000 -700 */ - updated_at: string; - }[]; - }; + updated_at: string + }[] + } /** * Organization Full * @description Organization Full */ - "organization-full": { + 'organization-full': { /** @example github */ - login: string; + login: string /** @example 1 */ - id: number; + id: number /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ - node_id: string; + node_id: string /** * Format: uri * @example https://api.github.com/orgs/github */ - url: string; + url: string /** * Format: uri * @example https://api.github.com/orgs/github/repos */ - repos_url: string; + repos_url: string /** * Format: uri * @example https://api.github.com/orgs/github/events */ - events_url: string; + events_url: string /** @example https://api.github.com/orgs/github/hooks */ - hooks_url: string; + hooks_url: string /** @example https://api.github.com/orgs/github/issues */ - issues_url: string; + issues_url: string /** @example https://api.github.com/orgs/github/members{/member} */ - members_url: string; + members_url: string /** @example https://api.github.com/orgs/github/public_members{/member} */ - public_members_url: string; + public_members_url: string /** @example https://github.com/images/error/octocat_happy.gif */ - avatar_url: string; + avatar_url: string /** @example A great organization */ - description: string | null; + description: string | null /** @example github */ - name?: string; + name?: string /** @example GitHub */ - company?: string; + company?: string /** * Format: uri * @example https://github.com/blog */ - blog?: string; + blog?: string /** @example San Francisco */ - location?: string; + location?: string /** * Format: email * @example octocat@github.com */ - email?: string; + email?: string /** @example github */ - twitter_username?: string | null; + twitter_username?: string | null /** @example true */ - is_verified?: boolean; + is_verified?: boolean /** @example true */ - has_organization_projects: boolean; + has_organization_projects: boolean /** @example true */ - has_repository_projects: boolean; + has_repository_projects: boolean /** @example 2 */ - public_repos: number; + public_repos: number /** @example 1 */ - public_gists: number; + public_gists: number /** @example 20 */ - followers: number; - following: number; + followers: number + following: number /** * Format: uri * @example https://github.com/octocat */ - html_url: string; + html_url: string /** * Format: date-time * @example 2008-01-14T04:33:35Z */ - created_at: string; + created_at: string /** @example Organization */ - type: string; + type: string /** @example 100 */ - total_private_repos?: number; + total_private_repos?: number /** @example 100 */ - owned_private_repos?: number; + owned_private_repos?: number /** @example 81 */ - private_gists?: number | null; + private_gists?: number | null /** @example 10000 */ - disk_usage?: number | null; + disk_usage?: number | null /** @example 8 */ - collaborators?: number | null; + collaborators?: number | null /** * Format: email * @example org@example.com */ - billing_email?: string | null; + billing_email?: string | null plan?: { - name: string; - space: number; - private_repos: number; - filled_seats?: number; - seats?: number; - }; - default_repository_permission?: string | null; + name: string + space: number + private_repos: number + filled_seats?: number + seats?: number + } + default_repository_permission?: string | null /** @example true */ - members_can_create_repositories?: boolean | null; + members_can_create_repositories?: boolean | null /** @example true */ - two_factor_requirement_enabled?: boolean | null; + two_factor_requirement_enabled?: boolean | null /** @example all */ - members_allowed_repository_creation_type?: string; + members_allowed_repository_creation_type?: string /** @example true */ - members_can_create_public_repositories?: boolean; + members_can_create_public_repositories?: boolean /** @example true */ - members_can_create_private_repositories?: boolean; + members_can_create_private_repositories?: boolean /** @example true */ - members_can_create_internal_repositories?: boolean; + members_can_create_internal_repositories?: boolean /** @example true */ - members_can_create_pages?: boolean; + members_can_create_pages?: boolean /** @example true */ - members_can_create_public_pages?: boolean; + members_can_create_public_pages?: boolean /** @example true */ - members_can_create_private_pages?: boolean; - members_can_fork_private_repositories?: boolean | null; + members_can_create_private_pages?: boolean + members_can_fork_private_repositories?: boolean | null /** Format: date-time */ - updated_at: string; - }; + updated_at: string + } /** * @description The policy that controls the repositories in the organization that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`. * @enum {string} */ - "enabled-repositories": "all" | "none" | "selected"; - "actions-organization-permissions": { - enabled_repositories: components["schemas"]["enabled-repositories"]; + 'enabled-repositories': 'all' | 'none' | 'selected' + 'actions-organization-permissions': { + enabled_repositories: components['schemas']['enabled-repositories'] /** @description The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. */ - selected_repositories_url?: string; - allowed_actions?: components["schemas"]["allowed-actions"]; - selected_actions_url?: components["schemas"]["selected-actions-url"]; - }; + selected_repositories_url?: string + allowed_actions?: components['schemas']['allowed-actions'] + selected_actions_url?: components['schemas']['selected-actions-url'] + } /** * @description The default workflow permissions granted to the GITHUB_TOKEN when running workflows in an organization. * @enum {string} */ - "actions-default-workflow-permissions": "read" | "write"; + 'actions-default-workflow-permissions': 'read' | 'write' /** @description Whether GitHub Actions can submit approving pull request reviews. */ - "actions-can-approve-pull-request-reviews": boolean; - "actions-get-default-workflow-permissions": { - default_workflow_permissions: components["schemas"]["actions-default-workflow-permissions"]; - can_approve_pull_request_reviews: components["schemas"]["actions-can-approve-pull-request-reviews"]; - }; - "actions-set-default-workflow-permissions": { - default_workflow_permissions?: components["schemas"]["actions-default-workflow-permissions"]; - can_approve_pull_request_reviews?: components["schemas"]["actions-can-approve-pull-request-reviews"]; - }; - "runner-groups-org": { - id: number; - name: string; - visibility: string; - default: boolean; + 'actions-can-approve-pull-request-reviews': boolean + 'actions-get-default-workflow-permissions': { + default_workflow_permissions: components['schemas']['actions-default-workflow-permissions'] + can_approve_pull_request_reviews: components['schemas']['actions-can-approve-pull-request-reviews'] + } + 'actions-set-default-workflow-permissions': { + default_workflow_permissions?: components['schemas']['actions-default-workflow-permissions'] + can_approve_pull_request_reviews?: components['schemas']['actions-can-approve-pull-request-reviews'] + } + 'runner-groups-org': { + id: number + name: string + visibility: string + default: boolean /** @description Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected` */ - selected_repositories_url?: string; - runners_url: string; - inherited: boolean; - inherited_allows_public_repositories?: boolean; - allows_public_repositories: boolean; - }; + selected_repositories_url?: string + runners_url: string + inherited: boolean + inherited_allows_public_repositories?: boolean + allows_public_repositories: boolean + } /** * Actions Secret for an Organization * @description Secrets for GitHub Actions for an organization. */ - "organization-actions-secret": { + 'organization-actions-secret': { /** * @description The name of the secret. * @example SECRET_TOKEN */ - name: string; + name: string /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; + updated_at: string /** * @description Visibility of a secret * @enum {string} */ - visibility: "all" | "private" | "selected"; + visibility: 'all' | 'private' | 'selected' /** * Format: uri * @example https://api.github.com/organizations/org/secrets/my_secret/repositories */ - selected_repositories_url?: string; - }; + selected_repositories_url?: string + } /** * ActionsPublicKey * @description The public key used for setting Actions Secrets. */ - "actions-public-key": { + 'actions-public-key': { /** * @description The identifier for the key. * @example 1234567 */ - key_id: string; + key_id: string /** * @description The Base64 encoded public key. * @example hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= */ - key: string; + key: string /** @example 2 */ - id?: number; + id?: number /** @example https://api.github.com/user/keys/2 */ - url?: string; + url?: string /** @example ssh-rsa AAAAB3NzaC1yc2EAAA */ - title?: string; + title?: string /** @example 2011-01-26T19:01:12Z */ - created_at?: string; - }; + created_at?: string + } /** * Empty Object * @description An object without any properties. */ - "empty-object": { [key: string]: unknown }; + 'empty-object': { [key: string]: unknown } /** * @description State of a code scanning alert. * @enum {string} */ - "code-scanning-alert-state": "open" | "closed" | "dismissed" | "fixed"; + 'code-scanning-alert-state': 'open' | 'closed' | 'dismissed' | 'fixed' /** * Format: date-time * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "alert-updated-at": string; + 'alert-updated-at': string /** * Format: uri * @description The REST API URL for fetching the list of instances for an alert. */ - "alert-instances-url": string; + 'alert-instances-url': string /** * Format: date-time * @description The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "code-scanning-alert-fixed-at": string | null; + 'code-scanning-alert-fixed-at': string | null /** * Format: date-time * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "code-scanning-alert-dismissed-at": string | null; + 'code-scanning-alert-dismissed-at': string | null /** * @description **Required when the state is dismissed.** The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. * @enum {string|null} */ - "code-scanning-alert-dismissed-reason": (null | "false positive" | "won't fix" | "used in tests") | null; - "code-scanning-alert-rule": { + 'code-scanning-alert-dismissed-reason': (null | 'false positive' | "won't fix" | 'used in tests') | null + 'code-scanning-alert-rule': { /** @description A unique identifier for the rule used to detect the alert. */ - id?: string | null; + id?: string | null /** @description The name of the rule used to detect the alert. */ - name?: string; + name?: string /** * @description The severity of the alert. * @enum {string|null} */ - severity?: ("none" | "note" | "warning" | "error") | null; + severity?: ('none' | 'note' | 'warning' | 'error') | null /** * @description The security severity of the alert. * @enum {string|null} */ - security_severity_level?: ("low" | "medium" | "high" | "critical") | null; + security_severity_level?: ('low' | 'medium' | 'high' | 'critical') | null /** @description A short description of the rule used to detect the alert. */ - description?: string; + description?: string /** @description description of the rule used to detect the alert. */ - full_description?: string; + full_description?: string /** @description A set of tags applicable for the rule. */ - tags?: string[] | null; + tags?: string[] | null /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */ - help?: string | null; - }; + help?: string | null + } /** @description The name of the tool used to generate the code scanning analysis. */ - "code-scanning-analysis-tool-name": string; + 'code-scanning-analysis-tool-name': string /** @description The version of the tool used to generate the code scanning analysis. */ - "code-scanning-analysis-tool-version": string | null; + 'code-scanning-analysis-tool-version': string | null /** @description The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. */ - "code-scanning-analysis-tool-guid": string | null; - "code-scanning-analysis-tool": { - name?: components["schemas"]["code-scanning-analysis-tool-name"]; - version?: components["schemas"]["code-scanning-analysis-tool-version"]; - guid?: components["schemas"]["code-scanning-analysis-tool-guid"]; - }; + 'code-scanning-analysis-tool-guid': string | null + 'code-scanning-analysis-tool': { + name?: components['schemas']['code-scanning-analysis-tool-name'] + version?: components['schemas']['code-scanning-analysis-tool-version'] + guid?: components['schemas']['code-scanning-analysis-tool-guid'] + } /** * @description The full Git reference, formatted as `refs/heads/`, * `refs/pull//merge`, or `refs/pull//head`. */ - "code-scanning-ref": string; + 'code-scanning-ref': string /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - "code-scanning-analysis-analysis-key": string; + 'code-scanning-analysis-analysis-key': string /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - "code-scanning-alert-environment": string; + 'code-scanning-alert-environment': string /** @description Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code. */ - "code-scanning-analysis-category": string; + 'code-scanning-analysis-category': string /** @description Describe a region within a file for the alert. */ - "code-scanning-alert-location": { - path?: string; - start_line?: number; - end_line?: number; - start_column?: number; - end_column?: number; - }; + 'code-scanning-alert-location': { + path?: string + start_line?: number + end_line?: number + start_column?: number + end_column?: number + } /** * @description A classification of the file. For example to identify it as generated. * @enum {string|null} */ - "code-scanning-alert-classification": ("source" | "generated" | "test" | "library") | null; - "code-scanning-alert-instance": { - ref?: components["schemas"]["code-scanning-ref"]; - analysis_key?: components["schemas"]["code-scanning-analysis-analysis-key"]; - environment?: components["schemas"]["code-scanning-alert-environment"]; - category?: components["schemas"]["code-scanning-analysis-category"]; - state?: components["schemas"]["code-scanning-alert-state"]; - commit_sha?: string; + 'code-scanning-alert-classification': ('source' | 'generated' | 'test' | 'library') | null + 'code-scanning-alert-instance': { + ref?: components['schemas']['code-scanning-ref'] + analysis_key?: components['schemas']['code-scanning-analysis-analysis-key'] + environment?: components['schemas']['code-scanning-alert-environment'] + category?: components['schemas']['code-scanning-analysis-category'] + state?: components['schemas']['code-scanning-alert-state'] + commit_sha?: string message?: { - text?: string; - }; - location?: components["schemas"]["code-scanning-alert-location"]; - html_url?: string; + text?: string + } + location?: components['schemas']['code-scanning-alert-location'] + html_url?: string /** * @description Classifications that have been applied to the file that triggered the alert. * For example identifying it as documentation, or a generated file. */ - classifications?: components["schemas"]["code-scanning-alert-classification"][]; - }; - "code-scanning-organization-alert-items": { - number: components["schemas"]["alert-number"]; - created_at: components["schemas"]["alert-created-at"]; - updated_at?: components["schemas"]["alert-updated-at"]; - url: components["schemas"]["alert-url"]; - html_url: components["schemas"]["alert-html-url"]; - instances_url: components["schemas"]["alert-instances-url"]; - state: components["schemas"]["code-scanning-alert-state"]; - fixed_at?: components["schemas"]["code-scanning-alert-fixed-at"]; - dismissed_by: components["schemas"]["nullable-simple-user"]; - dismissed_at: components["schemas"]["code-scanning-alert-dismissed-at"]; - dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"]; - rule: components["schemas"]["code-scanning-alert-rule"]; - tool: components["schemas"]["code-scanning-analysis-tool"]; - most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; - repository: components["schemas"]["minimal-repository"]; - }; + classifications?: components['schemas']['code-scanning-alert-classification'][] + } + 'code-scanning-organization-alert-items': { + number: components['schemas']['alert-number'] + created_at: components['schemas']['alert-created-at'] + updated_at?: components['schemas']['alert-updated-at'] + url: components['schemas']['alert-url'] + html_url: components['schemas']['alert-html-url'] + instances_url: components['schemas']['alert-instances-url'] + state: components['schemas']['code-scanning-alert-state'] + fixed_at?: components['schemas']['code-scanning-alert-fixed-at'] + dismissed_by: components['schemas']['nullable-simple-user'] + dismissed_at: components['schemas']['code-scanning-alert-dismissed-at'] + dismissed_reason: components['schemas']['code-scanning-alert-dismissed-reason'] + rule: components['schemas']['code-scanning-alert-rule'] + tool: components['schemas']['code-scanning-analysis-tool'] + most_recent_instance: components['schemas']['code-scanning-alert-instance'] + repository: components['schemas']['minimal-repository'] + } /** * Credential Authorization * @description Credential Authorization */ - "credential-authorization": { + 'credential-authorization': { /** * @description User login that owns the underlying credential. * @example monalisa */ - login: string; + login: string /** * @description Unique identifier for the credential. * @example 1 */ - credential_id: number; + credential_id: number /** * @description Human-readable description of the credential type. * @example SSH Key */ - credential_type: string; + credential_type: string /** * @description Last eight characters of the credential. Only included in responses with credential_type of personal access token. * @example 12345678 */ - token_last_eight?: string; + token_last_eight?: string /** * Format: date-time * @description Date when the credential was authorized for use. * @example 2011-01-26T19:06:43Z */ - credential_authorized_at: string; + credential_authorized_at: string /** * @description List of oauth scopes the token has been granted. * @example user,repo */ - scopes?: string[]; + scopes?: string[] /** * @description Unique string to distinguish the credential. Only included in responses with credential_type of SSH Key. * @example jklmnop12345678 */ - fingerprint?: string; + fingerprint?: string /** * Format: date-time * @description Date when the credential was last accessed. May be null if it was never accessed * @example 2011-01-26T19:06:43Z */ - credential_accessed_at: string | null; + credential_accessed_at: string | null /** @example 12345678 */ - authorized_credential_id: number | null; + authorized_credential_id: number | null /** * @description The title given to the ssh key. This will only be present when the credential is an ssh key. * @example my ssh key */ - authorized_credential_title?: string | null; + authorized_credential_title?: string | null /** * @description The note given to the token. This will only be present when the credential is a token. * @example my token */ - authorized_credential_note?: string | null; + authorized_credential_note?: string | null /** * Format: date-time * @description The expiry for the token. This will only be present when the credential is a token. */ - authorized_credential_expires_at?: string | null; - }; + authorized_credential_expires_at?: string | null + } /** * Dependabot Secret for an Organization * @description Secrets for GitHub Dependabot for an organization. */ - "organization-dependabot-secret": { + 'organization-dependabot-secret': { /** * @description The name of the secret. * @example SECRET_TOKEN */ - name: string; + name: string /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; + updated_at: string /** * @description Visibility of a secret * @enum {string} */ - visibility: "all" | "private" | "selected"; + visibility: 'all' | 'private' | 'selected' /** * Format: uri * @example https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories */ - selected_repositories_url?: string; - }; + selected_repositories_url?: string + } /** * DependabotPublicKey * @description The public key used for setting Dependabot Secrets. */ - "dependabot-public-key": { + 'dependabot-public-key': { /** * @description The identifier for the key. * @example 1234567 */ - key_id: string; + key_id: string /** * @description The Base64 encoded public key. * @example hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= */ - key: string; - }; + key: string + } /** * ExternalGroup * @description Information about an external group's usage and its members */ - "external-group": { + 'external-group': { /** * @description The internal ID of the group * @example 1 */ - group_id: number; + group_id: number /** * @description The display name for the group * @example group-azuread-test */ - group_name: string; + group_name: string /** * @description The date when the group was last updated_at * @example 2021-01-03 22:27:15:000 -700 */ - updated_at?: string; + updated_at?: string /** * @description An array of teams linked to this group * @example [object Object],[object Object] @@ -9590,13 +9582,13 @@ export interface components { * @description The id for a team * @example 1 */ - team_id: number; + team_id: number /** * @description The name of the team * @example team-test */ - team_name: string; - }[]; + team_name: string + }[] /** * @description An array of external members linked to this group * @example [object Object],[object Object] @@ -9606,493 +9598,493 @@ export interface components { * @description The internal user ID of the identity * @example 1 */ - member_id: number; + member_id: number /** * @description The handle/login for the user * @example mona-lisa_eocsaxrs */ - member_login: string; + member_login: string /** * @description The user display name/profile name * @example Mona Lisa */ - member_name: string; + member_name: string /** * @description An email attached to a user * @example mona_lisa@github.com */ - member_email: string; - }[]; - }; + member_email: string + }[] + } /** * Organization Invitation * @description Organization Invitation */ - "organization-invitation": { - id: number; - login: string | null; - email: string | null; - role: string; - created_at: string; - failed_at?: string | null; - failed_reason?: string | null; - inviter: components["schemas"]["simple-user"]; - team_count: number; + 'organization-invitation': { + id: number + login: string | null + email: string | null + role: string + created_at: string + failed_at?: string | null + failed_reason?: string | null + inviter: components['schemas']['simple-user'] + team_count: number /** @example "MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x" */ - node_id: string; + node_id: string /** @example "https://api.github.com/organizations/16/invitations/1/teams" */ - invitation_teams_url: string; - }; + invitation_teams_url: string + } /** * Org Hook * @description Org Hook */ - "org-hook": { + 'org-hook': { /** @example 1 */ - id: number; + id: number /** * Format: uri * @example https://api.github.com/orgs/octocat/hooks/1 */ - url: string; + url: string /** * Format: uri * @example https://api.github.com/orgs/octocat/hooks/1/pings */ - ping_url: string; + ping_url: string /** * Format: uri * @example https://api.github.com/orgs/octocat/hooks/1/deliveries */ - deliveries_url?: string; + deliveries_url?: string /** @example web */ - name: string; + name: string /** @example push,pull_request */ - events: string[]; + events: string[] /** @example true */ - active: boolean; + active: boolean config: { /** @example "http://example.com/2" */ - url?: string; + url?: string /** @example "0" */ - insecure_ssl?: string; + insecure_ssl?: string /** @example "form" */ - content_type?: string; + content_type?: string /** @example "********" */ - secret?: string; - }; + secret?: string + } /** * Format: date-time * @example 2011-09-06T20:39:23Z */ - updated_at: string; + updated_at: string /** * Format: date-time * @example 2011-09-06T17:26:27Z */ - created_at: string; - type: string; - }; + created_at: string + type: string + } /** * @description The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. Can be one of: `existing_users`, `contributors_only`, `collaborators_only`. * @example collaborators_only * @enum {string} */ - "interaction-group": "existing_users" | "contributors_only" | "collaborators_only"; + 'interaction-group': 'existing_users' | 'contributors_only' | 'collaborators_only' /** * Interaction Limits * @description Interaction limit settings. */ - "interaction-limit-response": { - limit: components["schemas"]["interaction-group"]; + 'interaction-limit-response': { + limit: components['schemas']['interaction-group'] /** @example repository */ - origin: string; + origin: string /** * Format: date-time * @example 2018-08-17T04:18:39Z */ - expires_at: string; - }; + expires_at: string + } /** * @description The duration of the interaction restriction. Can be one of: `one_day`, `three_days`, `one_week`, `one_month`, `six_months`. Default: `one_day`. * @example one_month * @enum {string} */ - "interaction-expiry": "one_day" | "three_days" | "one_week" | "one_month" | "six_months"; + 'interaction-expiry': 'one_day' | 'three_days' | 'one_week' | 'one_month' | 'six_months' /** * Interaction Restrictions * @description Limit interactions to a specific type of user for a specified duration */ - "interaction-limit": { - limit: components["schemas"]["interaction-group"]; - expiry?: components["schemas"]["interaction-expiry"]; - }; + 'interaction-limit': { + limit: components['schemas']['interaction-group'] + expiry?: components['schemas']['interaction-expiry'] + } /** * Team Simple * @description Groups of organization members that gives permissions on specified repositories. */ - "nullable-team-simple": { + 'nullable-team-simple': { /** * @description Unique identifier of the team * @example 1 */ - id: number; + id: number /** @example MDQ6VGVhbTE= */ - node_id: string; + node_id: string /** * Format: uri * @description URL for the team * @example https://api.github.com/organizations/1/team/1 */ - url: string; + url: string /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - members_url: string; + members_url: string /** * @description Name of the team * @example Justice League */ - name: string; + name: string /** * @description Description of the team * @example A great team. */ - description: string | null; + description: string | null /** * @description Permission that the team will have for its repositories * @example admin */ - permission: string; + permission: string /** * @description The level of privacy this team should have * @example closed */ - privacy?: string; + privacy?: string /** * Format: uri * @example https://github.com/orgs/rails/teams/core */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/organizations/1/team/1/repos */ - repositories_url: string; + repositories_url: string /** @example justice-league */ - slug: string; + slug: string /** * @description Distinguished Name (DN) that team maps to within LDAP environment * @example uid=example,ou=users,dc=github,dc=com */ - ldap_dn?: string; - } | null; + ldap_dn?: string + } | null /** * Team * @description Groups of organization members that gives permissions on specified repositories. */ team: { - id: number; - node_id: string; - name: string; - slug: string; - description: string | null; - privacy?: string; - permission: string; + id: number + node_id: string + name: string + slug: string + description: string | null + privacy?: string + permission: string permissions?: { - pull: boolean; - triage: boolean; - push: boolean; - maintain: boolean; - admin: boolean; - }; + pull: boolean + triage: boolean + push: boolean + maintain: boolean + admin: boolean + } /** Format: uri */ - url: string; + url: string /** * Format: uri * @example https://github.com/orgs/rails/teams/core */ - html_url: string; - members_url: string; + html_url: string + members_url: string /** Format: uri */ - repositories_url: string; - parent: components["schemas"]["nullable-team-simple"]; - }; + repositories_url: string + parent: components['schemas']['nullable-team-simple'] + } /** * Org Membership * @description Org Membership */ - "org-membership": { + 'org-membership': { /** * Format: uri * @example https://api.github.com/orgs/octocat/memberships/defunkt */ - url: string; + url: string /** * @description The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation. * @example active * @enum {string} */ - state: "active" | "pending"; + state: 'active' | 'pending' /** * @description The user's membership type in the organization. * @example admin * @enum {string} */ - role: "admin" | "member" | "billing_manager"; + role: 'admin' | 'member' | 'billing_manager' /** * Format: uri * @example https://api.github.com/orgs/octocat */ - organization_url: string; - organization: components["schemas"]["organization-simple"]; - user: components["schemas"]["nullable-simple-user"]; + organization_url: string + organization: components['schemas']['organization-simple'] + user: components['schemas']['nullable-simple-user'] permissions?: { - can_create_repository: boolean; - }; - }; + can_create_repository: boolean + } + } /** * Migration * @description A migration. */ migration: { /** @example 79 */ - id: number; - owner: components["schemas"]["nullable-simple-user"]; + id: number + owner: components['schemas']['nullable-simple-user'] /** @example 0b989ba4-242f-11e5-81e1-c7b6966d2516 */ - guid: string; + guid: string /** @example pending */ - state: string; + state: string /** @example true */ - lock_repositories: boolean; - exclude_metadata: boolean; - exclude_git_data: boolean; - exclude_attachments: boolean; - exclude_releases: boolean; - exclude_owner_projects: boolean; - repositories: components["schemas"]["repository"][]; + lock_repositories: boolean + exclude_metadata: boolean + exclude_git_data: boolean + exclude_attachments: boolean + exclude_releases: boolean + exclude_owner_projects: boolean + repositories: components['schemas']['repository'][] /** * Format: uri * @example https://api.github.com/orgs/octo-org/migrations/79 */ - url: string; + url: string /** * Format: date-time * @example 2015-07-06T15:33:38-07:00 */ - created_at: string; + created_at: string /** * Format: date-time * @example 2015-07-06T15:33:38-07:00 */ - updated_at: string; - node_id: string; + updated_at: string + node_id: string /** Format: uri */ - archive_url?: string; - exclude?: unknown[]; - }; + archive_url?: string + exclude?: unknown[] + } /** * Minimal Repository * @description Minimal Repository */ - "nullable-minimal-repository": { + 'nullable-minimal-repository': { /** @example 1296269 */ - id: number; + id: number /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - node_id: string; + node_id: string /** @example Hello-World */ - name: string; + name: string /** @example octocat/Hello-World */ - full_name: string; - owner: components["schemas"]["simple-user"]; - private: boolean; + full_name: string + owner: components['schemas']['simple-user'] + private: boolean /** * Format: uri * @example https://github.com/octocat/Hello-World */ - html_url: string; + html_url: string /** @example This your first repo! */ - description: string | null; - fork: boolean; + description: string | null + fork: boolean /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World */ - url: string; + url: string /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - archive_url: string; + archive_url: string /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - assignees_url: string; + assignees_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - blobs_url: string; + blobs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - branches_url: string; + branches_url: string /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - collaborators_url: string; + collaborators_url: string /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - comments_url: string; + comments_url: string /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - commits_url: string; + commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - compare_url: string; + compare_url: string /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - contents_url: string; + contents_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - contributors_url: string; + contributors_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - deployments_url: string; + deployments_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - downloads_url: string; + downloads_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events */ - events_url: string; + events_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ - forks_url: string; + forks_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - git_commits_url: string; + git_commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - git_refs_url: string; + git_refs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - git_tags_url: string; - git_url?: string; + git_tags_url: string + git_url?: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - issue_comment_url: string; + issue_comment_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - issue_events_url: string; + issue_events_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - issues_url: string; + issues_url: string /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - keys_url: string; + keys_url: string /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - labels_url: string; + labels_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ - languages_url: string; + languages_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ - merges_url: string; + merges_url: string /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - milestones_url: string; + milestones_url: string /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - notifications_url: string; + notifications_url: string /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - pulls_url: string; + pulls_url: string /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - releases_url: string; - ssh_url?: string; + releases_url: string + ssh_url?: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - stargazers_url: string; + stargazers_url: string /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - statuses_url: string; + statuses_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - subscribers_url: string; + subscribers_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - subscription_url: string; + subscription_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ - tags_url: string; + tags_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ - teams_url: string; + teams_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - trees_url: string; - clone_url?: string; - mirror_url?: string | null; + trees_url: string + clone_url?: string + mirror_url?: string | null /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - hooks_url: string; - svn_url?: string; - homepage?: string | null; - language?: string | null; - forks_count?: number; - stargazers_count?: number; - watchers_count?: number; - size?: number; - default_branch?: string; - open_issues_count?: number; - is_template?: boolean; - topics?: string[]; - has_issues?: boolean; - has_projects?: boolean; - has_wiki?: boolean; - has_pages?: boolean; - has_downloads?: boolean; - archived?: boolean; - disabled?: boolean; - visibility?: string; + hooks_url: string + svn_url?: string + homepage?: string | null + language?: string | null + forks_count?: number + stargazers_count?: number + watchers_count?: number + size?: number + default_branch?: string + open_issues_count?: number + is_template?: boolean + topics?: string[] + has_issues?: boolean + has_projects?: boolean + has_wiki?: boolean + has_pages?: boolean + has_downloads?: boolean + archived?: boolean + disabled?: boolean + visibility?: string /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - pushed_at?: string | null; + pushed_at?: string | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - created_at?: string | null; + created_at?: string | null /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - updated_at?: string | null; + updated_at?: string | null permissions?: { - admin?: boolean; - maintain?: boolean; - push?: boolean; - triage?: boolean; - pull?: boolean; - }; + admin?: boolean + maintain?: boolean + push?: boolean + triage?: boolean + pull?: boolean + } /** @example admin */ - role_name?: string; - template_repository?: components["schemas"]["nullable-repository"]; - temp_clone_token?: string; - delete_branch_on_merge?: boolean; - subscribers_count?: number; - network_count?: number; - code_of_conduct?: components["schemas"]["code-of-conduct"]; + role_name?: string + template_repository?: components['schemas']['nullable-repository'] + temp_clone_token?: string + delete_branch_on_merge?: boolean + subscribers_count?: number + network_count?: number + code_of_conduct?: components['schemas']['code-of-conduct'] license?: { - key?: string; - name?: string; - spdx_id?: string; - url?: string; - node_id?: string; - } | null; - forks?: number; - open_issues?: number; - watchers?: number; - allow_forking?: boolean; - } | null; + key?: string + name?: string + spdx_id?: string + url?: string + node_id?: string + } | null + forks?: number + open_issues?: number + watchers?: number + allow_forking?: boolean + } | null /** * Package * @description A software package @@ -10102,96 +10094,96 @@ export interface components { * @description Unique identifier of the package. * @example 1 */ - id: number; + id: number /** * @description The name of the package. * @example super-linter */ - name: string; + name: string /** * @example docker * @enum {string} */ - package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + package_type: 'npm' | 'maven' | 'rubygems' | 'docker' | 'nuget' | 'container' /** @example https://api.github.com/orgs/github/packages/container/super-linter */ - url: string; + url: string /** @example https://github.com/orgs/github/packages/container/package/super-linter */ - html_url: string; + html_url: string /** * @description The number of versions of the package. * @example 1 */ - version_count: number; + version_count: number /** * @example private * @enum {string} */ - visibility: "private" | "public"; - owner?: components["schemas"]["nullable-simple-user"]; - repository?: components["schemas"]["nullable-minimal-repository"]; + visibility: 'private' | 'public' + owner?: components['schemas']['nullable-simple-user'] + repository?: components['schemas']['nullable-minimal-repository'] /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - }; + updated_at: string + } /** * Package Version * @description A version of a software package */ - "package-version": { + 'package-version': { /** * @description Unique identifier of the package version. * @example 1 */ - id: number; + id: number /** * @description The name of the package version. * @example latest */ - name: string; + name: string /** @example https://api.github.com/orgs/github/packages/container/super-linter/versions/786068 */ - url: string; + url: string /** @example https://github.com/orgs/github/packages/container/package/super-linter */ - package_html_url: string; + package_html_url: string /** @example https://github.com/orgs/github/packages/container/super-linter/786068 */ - html_url?: string; + html_url?: string /** @example MIT */ - license?: string; - description?: string; + license?: string + description?: string /** * Format: date-time * @example 2011-04-10T20:09:31Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2014-03-03T18:58:10Z */ - updated_at: string; + updated_at: string /** * Format: date-time * @example 2014-03-03T18:58:10Z */ - deleted_at?: string; + deleted_at?: string /** Package Version Metadata */ metadata?: { /** * @example docker * @enum {string} */ - package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + package_type: 'npm' | 'maven' | 'rubygems' | 'docker' | 'nuget' | 'container' /** Container Metadata */ container?: { - tags: string[]; - }; + tags: string[] + } /** Docker Metadata */ docker?: { - tag?: string[]; + tag?: string[] } & { - tags: unknown; - }; - }; - }; + tags: unknown + } + } + } /** * Project * @description Projects are a way to organize columns and cards of work. @@ -10201,67 +10193,67 @@ export interface components { * Format: uri * @example https://api.github.com/repos/api-playground/projects-test */ - owner_url: string; + owner_url: string /** * Format: uri * @example https://api.github.com/projects/1002604 */ - url: string; + url: string /** * Format: uri * @example https://github.com/api-playground/projects-test/projects/12 */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/projects/1002604/columns */ - columns_url: string; + columns_url: string /** @example 1002604 */ - id: number; + id: number /** @example MDc6UHJvamVjdDEwMDI2MDQ= */ - node_id: string; + node_id: string /** * @description Name of the project * @example Week One Sprint */ - name: string; + name: string /** * @description Body of the project * @example This project represents the sprint of the first week in January */ - body: string | null; + body: string | null /** @example 1 */ - number: number; + number: number /** * @description State of the project; either 'open' or 'closed' * @example open */ - state: string; - creator: components["schemas"]["nullable-simple-user"]; + state: string + creator: components['schemas']['nullable-simple-user'] /** * Format: date-time * @example 2011-04-10T20:09:31Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2014-03-03T18:58:10Z */ - updated_at: string; + updated_at: string /** * @description The baseline permission that all organization members have on this project. Only present if owner is an organization. * @enum {string} */ - organization_permission?: "read" | "write" | "admin" | "none"; + organization_permission?: 'read' | 'write' | 'admin' | 'none' /** @description Whether or not this project can be seen by everyone. Only present if owner is an organization. */ - private?: boolean; - }; + private?: boolean + } /** * GroupMapping * @description External Groups to be mapped to a team for membership */ - "group-mapping": { + 'group-mapping': { /** * @description Array of groups to be mapped to this team * @example [object Object],[object Object] @@ -10271,1012 +10263,1012 @@ export interface components { * @description The ID of the group * @example 111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa */ - group_id: string; + group_id: string /** * @description The name of the group * @example saml-azuread-test */ - group_name: string; + group_name: string /** * @description a description of the group * @example A group of Developers working on AzureAD SAML SSO */ - group_description: string; + group_description: string /** * @description synchronization status for this group mapping * @example unsynced */ - status?: string; + status?: string /** * @description the time of the last sync for this group-mapping * @example 2019-06-03 22:27:15:000 -700 */ - synced_at?: string | null; - }[]; - }; + synced_at?: string | null + }[] + } /** * Full Team * @description Groups of organization members that gives permissions on specified repositories. */ - "team-full": { + 'team-full': { /** * @description Unique identifier of the team * @example 42 */ - id: number; + id: number /** @example MDQ6VGVhbTE= */ - node_id: string; + node_id: string /** * Format: uri * @description URL for the team * @example https://api.github.com/organizations/1/team/1 */ - url: string; + url: string /** * Format: uri * @example https://github.com/orgs/rails/teams/core */ - html_url: string; + html_url: string /** * @description Name of the team * @example Developers */ - name: string; + name: string /** @example justice-league */ - slug: string; + slug: string /** @example A great team. */ - description: string | null; + description: string | null /** * @description The level of privacy this team should have * @example closed * @enum {string} */ - privacy?: "closed" | "secret"; + privacy?: 'closed' | 'secret' /** * @description Permission that the team will have for its repositories * @example push */ - permission: string; + permission: string /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - members_url: string; + members_url: string /** * Format: uri * @example https://api.github.com/organizations/1/team/1/repos */ - repositories_url: string; - parent?: components["schemas"]["nullable-team-simple"]; + repositories_url: string + parent?: components['schemas']['nullable-team-simple'] /** @example 3 */ - members_count: number; + members_count: number /** @example 10 */ - repos_count: number; + repos_count: number /** * Format: date-time * @example 2017-07-14T16:53:42Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2017-08-17T12:37:15Z */ - updated_at: string; - organization: components["schemas"]["organization-full"]; + updated_at: string + organization: components['schemas']['organization-full'] /** * @description Distinguished Name (DN) that team maps to within LDAP environment * @example uid=example,ou=users,dc=github,dc=com */ - ldap_dn?: string; - }; + ldap_dn?: string + } /** * Team Discussion * @description A team discussion is a persistent record of a free-form conversation within a team. */ - "team-discussion": { - author: components["schemas"]["nullable-simple-user"]; + 'team-discussion': { + author: components['schemas']['nullable-simple-user'] /** * @description The main text of the discussion. * @example Please suggest improvements to our workflow in comments. */ - body: string; + body: string /** @example

Hi! This is an area for us to collaborate as a team

*/ - body_html: string; + body_html: string /** * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server. * @example 0307116bbf7ced493b8d8a346c650b71 */ - body_version: string; - comments_count: number; + body_version: string + comments_count: number /** * Format: uri * @example https://api.github.com/organizations/1/team/2343027/discussions/1/comments */ - comments_url: string; + comments_url: string /** * Format: date-time * @example 2018-01-25T18:56:31Z */ - created_at: string; + created_at: string /** Format: date-time */ - last_edited_at: string | null; + last_edited_at: string | null /** * Format: uri * @example https://github.com/orgs/github/teams/justice-league/discussions/1 */ - html_url: string; + html_url: string /** @example MDE0OlRlYW1EaXNjdXNzaW9uMQ== */ - node_id: string; + node_id: string /** * @description The unique sequence number of a team discussion. * @example 42 */ - number: number; + number: number /** * @description Whether or not this discussion should be pinned for easy retrieval. * @example true */ - pinned: boolean; + pinned: boolean /** * @description Whether or not this discussion should be restricted to team members and organization administrators. * @example true */ - private: boolean; + private: boolean /** * Format: uri * @example https://api.github.com/organizations/1/team/2343027 */ - team_url: string; + team_url: string /** * @description The title of the discussion. * @example How can we improve our workflow? */ - title: string; + title: string /** * Format: date-time * @example 2018-01-25T18:56:31Z */ - updated_at: string; + updated_at: string /** * Format: uri * @example https://api.github.com/organizations/1/team/2343027/discussions/1 */ - url: string; - reactions?: components["schemas"]["reaction-rollup"]; - }; + url: string + reactions?: components['schemas']['reaction-rollup'] + } /** * Team Discussion Comment * @description A reply to a discussion within a team. */ - "team-discussion-comment": { - author: components["schemas"]["nullable-simple-user"]; + 'team-discussion-comment': { + author: components['schemas']['nullable-simple-user'] /** * @description The main text of the comment. * @example I agree with this suggestion. */ - body: string; + body: string /** @example

Do you like apples?

*/ - body_html: string; + body_html: string /** * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server. * @example 0307116bbf7ced493b8d8a346c650b71 */ - body_version: string; + body_version: string /** * Format: date-time * @example 2018-01-15T23:53:58Z */ - created_at: string; + created_at: string /** Format: date-time */ - last_edited_at: string | null; + last_edited_at: string | null /** * Format: uri * @example https://api.github.com/organizations/1/team/2403582/discussions/1 */ - discussion_url: string; + discussion_url: string /** * Format: uri * @example https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 */ - html_url: string; + html_url: string /** @example MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= */ - node_id: string; + node_id: string /** * @description The unique sequence number of a team discussion comment. * @example 42 */ - number: number; + number: number /** * Format: date-time * @example 2018-01-15T23:53:58Z */ - updated_at: string; + updated_at: string /** * Format: uri * @example https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 */ - url: string; - reactions?: components["schemas"]["reaction-rollup"]; - }; + url: string + reactions?: components['schemas']['reaction-rollup'] + } /** * Reaction * @description Reactions to conversations provide a way to help people express their feelings more simply and effectively. */ reaction: { /** @example 1 */ - id: number; + id: number /** @example MDg6UmVhY3Rpb24x */ - node_id: string; - user: components["schemas"]["nullable-simple-user"]; + node_id: string + user: components['schemas']['nullable-simple-user'] /** * @description The reaction to use * @example heart * @enum {string} */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' /** * Format: date-time * @example 2016-05-20T20:09:31Z */ - created_at: string; - }; + created_at: string + } /** * Team Membership * @description Team Membership */ - "team-membership": { + 'team-membership': { /** Format: uri */ - url: string; + url: string /** * @description The role of the user in the team. * @default member * @example member * @enum {string} */ - role: "member" | "maintainer"; + role: 'member' | 'maintainer' /** * @description The state of the user's membership in the team. * @enum {string} */ - state: "active" | "pending"; - }; + state: 'active' | 'pending' + } /** * Team Project * @description A team's access to a project. */ - "team-project": { - owner_url: string; - url: string; - html_url: string; - columns_url: string; - id: number; - node_id: string; - name: string; - body: string | null; - number: number; - state: string; - creator: components["schemas"]["simple-user"]; - created_at: string; - updated_at: string; + 'team-project': { + owner_url: string + url: string + html_url: string + columns_url: string + id: number + node_id: string + name: string + body: string | null + number: number + state: string + creator: components['schemas']['simple-user'] + created_at: string + updated_at: string /** @description The organization permission for this project. Only present when owner is an organization. */ - organization_permission?: string; + organization_permission?: string /** @description Whether the project is private or not. Only present when owner is an organization. */ - private?: boolean; + private?: boolean permissions: { - read: boolean; - write: boolean; - admin: boolean; - }; - }; + read: boolean + write: boolean + admin: boolean + } + } /** * Team Repository * @description A team's access to a repository. */ - "team-repository": { + 'team-repository': { /** * @description Unique identifier of the repository * @example 42 */ - id: number; + id: number /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - node_id: string; + node_id: string /** * @description The name of the repository. * @example Team Environment */ - name: string; + name: string /** @example octocat/Hello-World */ - full_name: string; - license: components["schemas"]["nullable-license-simple"]; - forks: number; + full_name: string + license: components['schemas']['nullable-license-simple'] + forks: number permissions?: { - admin: boolean; - pull: boolean; - triage?: boolean; - push: boolean; - maintain?: boolean; - }; + admin: boolean + pull: boolean + triage?: boolean + push: boolean + maintain?: boolean + } /** @example admin */ - role_name?: string; - owner: components["schemas"]["nullable-simple-user"]; + role_name?: string + owner: components['schemas']['nullable-simple-user'] /** @description Whether the repository is private or public. */ - private: boolean; + private: boolean /** * Format: uri * @example https://github.com/octocat/Hello-World */ - html_url: string; + html_url: string /** @example This your first repo! */ - description: string | null; - fork: boolean; + description: string | null + fork: boolean /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World */ - url: string; + url: string /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - archive_url: string; + archive_url: string /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - assignees_url: string; + assignees_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - blobs_url: string; + blobs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - branches_url: string; + branches_url: string /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - collaborators_url: string; + collaborators_url: string /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - comments_url: string; + comments_url: string /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - commits_url: string; + commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - compare_url: string; + compare_url: string /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - contents_url: string; + contents_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - contributors_url: string; + contributors_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - deployments_url: string; + deployments_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - downloads_url: string; + downloads_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events */ - events_url: string; + events_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ - forks_url: string; + forks_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - git_commits_url: string; + git_commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - git_refs_url: string; + git_refs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - git_tags_url: string; + git_tags_url: string /** @example git:github.com/octocat/Hello-World.git */ - git_url: string; + git_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - issue_comment_url: string; + issue_comment_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - issue_events_url: string; + issue_events_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - issues_url: string; + issues_url: string /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - keys_url: string; + keys_url: string /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - labels_url: string; + labels_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ - languages_url: string; + languages_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ - merges_url: string; + merges_url: string /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - milestones_url: string; + milestones_url: string /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - notifications_url: string; + notifications_url: string /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - pulls_url: string; + pulls_url: string /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - releases_url: string; + releases_url: string /** @example git@github.com:octocat/Hello-World.git */ - ssh_url: string; + ssh_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - stargazers_url: string; + stargazers_url: string /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - statuses_url: string; + statuses_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - subscribers_url: string; + subscribers_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - subscription_url: string; + subscription_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ - tags_url: string; + tags_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ - teams_url: string; + teams_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - trees_url: string; + trees_url: string /** @example https://github.com/octocat/Hello-World.git */ - clone_url: string; + clone_url: string /** * Format: uri * @example git:git.example.com/octocat/Hello-World */ - mirror_url: string | null; + mirror_url: string | null /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - hooks_url: string; + hooks_url: string /** * Format: uri * @example https://svn.github.com/octocat/Hello-World */ - svn_url: string; + svn_url: string /** * Format: uri * @example https://github.com */ - homepage: string | null; - language: string | null; + homepage: string | null + language: string | null /** @example 9 */ - forks_count: number; + forks_count: number /** @example 80 */ - stargazers_count: number; + stargazers_count: number /** @example 80 */ - watchers_count: number; + watchers_count: number /** @example 108 */ - size: number; + size: number /** * @description The default branch of the repository. * @example master */ - default_branch: string; - open_issues_count: number; + default_branch: string + open_issues_count: number /** * @description Whether this repository acts as a template that can be used to generate new repositories. * @example true */ - is_template?: boolean; - topics?: string[]; + is_template?: boolean + topics?: string[] /** * @description Whether issues are enabled. * @default true * @example true */ - has_issues: boolean; + has_issues: boolean /** * @description Whether projects are enabled. * @default true * @example true */ - has_projects: boolean; + has_projects: boolean /** * @description Whether the wiki is enabled. * @default true * @example true */ - has_wiki: boolean; - has_pages: boolean; + has_wiki: boolean + has_pages: boolean /** * @description Whether downloads are enabled. * @default true * @example true */ - has_downloads: boolean; + has_downloads: boolean /** @description Whether the repository is archived. */ - archived: boolean; + archived: boolean /** @description Returns whether or not this repository disabled. */ - disabled: boolean; + disabled: boolean /** * @description The repository visibility: public, private, or internal. * @default public */ - visibility?: string; + visibility?: string /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - pushed_at: string | null; + pushed_at: string | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - created_at: string | null; + created_at: string | null /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - updated_at: string | null; + updated_at: string | null /** * @description Whether to allow rebase merges for pull requests. * @default true * @example true */ - allow_rebase_merge?: boolean; - template_repository?: components["schemas"]["nullable-repository"]; - temp_clone_token?: string; + allow_rebase_merge?: boolean + template_repository?: components['schemas']['nullable-repository'] + temp_clone_token?: string /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - allow_squash_merge?: boolean; + allow_squash_merge?: boolean /** @description Whether to allow Auto-merge to be used on pull requests. */ - allow_auto_merge?: boolean; + allow_auto_merge?: boolean /** @description Whether to delete head branches when pull requests are merged */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge?: boolean /** * @description Whether to allow merge commits for pull requests. * @default true * @example true */ - allow_merge_commit?: boolean; + allow_merge_commit?: boolean /** @description Whether to allow forking this repo */ - allow_forking?: boolean; - subscribers_count?: number; - network_count?: number; - open_issues: number; - watchers: number; - master_branch?: string; - }; + allow_forking?: boolean + subscribers_count?: number + network_count?: number + open_issues: number + watchers: number + master_branch?: string + } /** * Project Card * @description Project cards represent a scope of work. */ - "project-card": { + 'project-card': { /** * Format: uri * @example https://api.github.com/projects/columns/cards/1478 */ - url: string; + url: string /** * @description The project card's ID * @example 42 */ - id: number; + id: number /** @example MDExOlByb2plY3RDYXJkMTQ3OA== */ - node_id: string; + node_id: string /** @example Add payload for delete Project column */ - note: string | null; - creator: components["schemas"]["nullable-simple-user"]; + note: string | null + creator: components['schemas']['nullable-simple-user'] /** * Format: date-time * @example 2016-09-05T14:21:06Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2016-09-05T14:20:22Z */ - updated_at: string; + updated_at: string /** @description Whether or not the card is archived */ - archived?: boolean; - column_name?: string; - project_id?: string; + archived?: boolean + column_name?: string + project_id?: string /** * Format: uri * @example https://api.github.com/projects/columns/367 */ - column_url: string; + column_url: string /** * Format: uri * @example https://api.github.com/repos/api-playground/projects-test/issues/3 */ - content_url?: string; + content_url?: string /** * Format: uri * @example https://api.github.com/projects/120 */ - project_url: string; - }; + project_url: string + } /** * Project Column * @description Project columns contain cards of work. */ - "project-column": { + 'project-column': { /** * Format: uri * @example https://api.github.com/projects/columns/367 */ - url: string; + url: string /** * Format: uri * @example https://api.github.com/projects/120 */ - project_url: string; + project_url: string /** * Format: uri * @example https://api.github.com/projects/columns/367/cards */ - cards_url: string; + cards_url: string /** * @description The unique identifier of the project column * @example 42 */ - id: number; + id: number /** @example MDEzOlByb2plY3RDb2x1bW4zNjc= */ - node_id: string; + node_id: string /** * @description Name of the project column * @example Remaining tasks */ - name: string; + name: string /** * Format: date-time * @example 2016-09-05T14:18:44Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2016-09-05T14:22:28Z */ - updated_at: string; - }; + updated_at: string + } /** * Project Collaborator Permission * @description Project Collaborator Permission */ - "project-collaborator-permission": { - permission: string; - user: components["schemas"]["nullable-simple-user"]; - }; + 'project-collaborator-permission': { + permission: string + user: components['schemas']['nullable-simple-user'] + } /** Rate Limit */ - "rate-limit": { - limit: number; - remaining: number; - reset: number; - used: number; - }; + 'rate-limit': { + limit: number + remaining: number + reset: number + used: number + } /** * Rate Limit Overview * @description Rate Limit Overview */ - "rate-limit-overview": { + 'rate-limit-overview': { resources: { - core: components["schemas"]["rate-limit"]; - graphql?: components["schemas"]["rate-limit"]; - search: components["schemas"]["rate-limit"]; - source_import?: components["schemas"]["rate-limit"]; - integration_manifest?: components["schemas"]["rate-limit"]; - code_scanning_upload?: components["schemas"]["rate-limit"]; - actions_runner_registration?: components["schemas"]["rate-limit"]; - scim?: components["schemas"]["rate-limit"]; - }; - rate: components["schemas"]["rate-limit"]; - }; + core: components['schemas']['rate-limit'] + graphql?: components['schemas']['rate-limit'] + search: components['schemas']['rate-limit'] + source_import?: components['schemas']['rate-limit'] + integration_manifest?: components['schemas']['rate-limit'] + code_scanning_upload?: components['schemas']['rate-limit'] + actions_runner_registration?: components['schemas']['rate-limit'] + scim?: components['schemas']['rate-limit'] + } + rate: components['schemas']['rate-limit'] + } /** * Code Of Conduct Simple * @description Code of Conduct Simple */ - "code-of-conduct-simple": { + 'code-of-conduct-simple': { /** * Format: uri * @example https://api.github.com/repos/github/docs/community/code_of_conduct */ - url: string; + url: string /** @example citizen_code_of_conduct */ - key: string; + key: string /** @example Citizen Code of Conduct */ - name: string; + name: string /** * Format: uri * @example https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md */ - html_url: string | null; - }; + html_url: string | null + } /** * Full Repository * @description Full Repository */ - "full-repository": { + 'full-repository': { /** @example 1296269 */ - id: number; + id: number /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - node_id: string; + node_id: string /** @example Hello-World */ - name: string; + name: string /** @example octocat/Hello-World */ - full_name: string; - owner: components["schemas"]["simple-user"]; - private: boolean; + full_name: string + owner: components['schemas']['simple-user'] + private: boolean /** * Format: uri * @example https://github.com/octocat/Hello-World */ - html_url: string; + html_url: string /** @example This your first repo! */ - description: string | null; - fork: boolean; + description: string | null + fork: boolean /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World */ - url: string; + url: string /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - archive_url: string; + archive_url: string /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - assignees_url: string; + assignees_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - blobs_url: string; + blobs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - branches_url: string; + branches_url: string /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - collaborators_url: string; + collaborators_url: string /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - comments_url: string; + comments_url: string /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - commits_url: string; + commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - compare_url: string; + compare_url: string /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - contents_url: string; + contents_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - contributors_url: string; + contributors_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - deployments_url: string; + deployments_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - downloads_url: string; + downloads_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events */ - events_url: string; + events_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ - forks_url: string; + forks_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - git_commits_url: string; + git_commits_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - git_refs_url: string; + git_refs_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - git_tags_url: string; + git_tags_url: string /** @example git:github.com/octocat/Hello-World.git */ - git_url: string; + git_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - issue_comment_url: string; + issue_comment_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - issue_events_url: string; + issue_events_url: string /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - issues_url: string; + issues_url: string /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - keys_url: string; + keys_url: string /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - labels_url: string; + labels_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ - languages_url: string; + languages_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ - merges_url: string; + merges_url: string /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - milestones_url: string; + milestones_url: string /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - notifications_url: string; + notifications_url: string /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - pulls_url: string; + pulls_url: string /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - releases_url: string; + releases_url: string /** @example git@github.com:octocat/Hello-World.git */ - ssh_url: string; + ssh_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - stargazers_url: string; + stargazers_url: string /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - statuses_url: string; + statuses_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - subscribers_url: string; + subscribers_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - subscription_url: string; + subscription_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ - tags_url: string; + tags_url: string /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ - teams_url: string; + teams_url: string /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - trees_url: string; + trees_url: string /** @example https://github.com/octocat/Hello-World.git */ - clone_url: string; + clone_url: string /** * Format: uri * @example git:git.example.com/octocat/Hello-World */ - mirror_url: string | null; + mirror_url: string | null /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - hooks_url: string; + hooks_url: string /** * Format: uri * @example https://svn.github.com/octocat/Hello-World */ - svn_url: string; + svn_url: string /** * Format: uri * @example https://github.com */ - homepage: string | null; - language: string | null; + homepage: string | null + language: string | null /** @example 9 */ - forks_count: number; + forks_count: number /** @example 80 */ - stargazers_count: number; + stargazers_count: number /** @example 80 */ - watchers_count: number; + watchers_count: number /** @example 108 */ - size: number; + size: number /** @example master */ - default_branch: string; - open_issues_count: number; + default_branch: string + open_issues_count: number /** @example true */ - is_template?: boolean; + is_template?: boolean /** @example octocat,atom,electron,API */ - topics?: string[]; + topics?: string[] /** @example true */ - has_issues: boolean; + has_issues: boolean /** @example true */ - has_projects: boolean; + has_projects: boolean /** @example true */ - has_wiki: boolean; - has_pages: boolean; + has_wiki: boolean + has_pages: boolean /** @example true */ - has_downloads: boolean; - archived: boolean; + has_downloads: boolean + archived: boolean /** @description Returns whether or not this repository disabled. */ - disabled: boolean; + disabled: boolean /** * @description The repository visibility: public, private, or internal. * @example public */ - visibility?: string; + visibility?: string /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - pushed_at: string; + pushed_at: string /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - updated_at: string; + updated_at: string permissions?: { - admin: boolean; - maintain?: boolean; - push: boolean; - triage?: boolean; - pull: boolean; - }; + admin: boolean + maintain?: boolean + push: boolean + triage?: boolean + pull: boolean + } /** @example true */ - allow_rebase_merge?: boolean; - template_repository?: components["schemas"]["nullable-repository"]; - temp_clone_token?: string | null; + allow_rebase_merge?: boolean + template_repository?: components['schemas']['nullable-repository'] + temp_clone_token?: string | null /** @example true */ - allow_squash_merge?: boolean; - allow_auto_merge?: boolean; - delete_branch_on_merge?: boolean; + allow_squash_merge?: boolean + allow_auto_merge?: boolean + delete_branch_on_merge?: boolean /** @example true */ - allow_merge_commit?: boolean; + allow_merge_commit?: boolean /** @example true */ - allow_forking?: boolean; + allow_forking?: boolean /** @example 42 */ - subscribers_count: number; - network_count: number; - license: components["schemas"]["nullable-license-simple"]; - organization?: components["schemas"]["nullable-simple-user"]; - parent?: components["schemas"]["repository"]; - source?: components["schemas"]["repository"]; - forks: number; - master_branch?: string; - open_issues: number; - watchers: number; + subscribers_count: number + network_count: number + license: components['schemas']['nullable-license-simple'] + organization?: components['schemas']['nullable-simple-user'] + parent?: components['schemas']['repository'] + source?: components['schemas']['repository'] + forks: number + master_branch?: string + open_issues: number + watchers: number /** * @description Whether anonymous git access is allowed. * @default true */ - anonymous_access_enabled?: boolean; - code_of_conduct?: components["schemas"]["code-of-conduct-simple"]; + anonymous_access_enabled?: boolean + code_of_conduct?: components['schemas']['code-of-conduct-simple'] security_and_analysis?: { advanced_security?: { /** @enum {string} */ - status?: "enabled" | "disabled"; - }; + status?: 'enabled' | 'disabled' + } secret_scanning?: { /** @enum {string} */ - status?: "enabled" | "disabled"; - }; - } | null; - }; + status?: 'enabled' | 'disabled' + } + } | null + } /** * Artifact * @description An artifact */ artifact: { /** @example 5 */ - id: number; + id: number /** @example MDEwOkNoZWNrU3VpdGU1 */ - node_id: string; + node_id: string /** * @description The name of the artifact. * @example AdventureWorks.Framework */ - name: string; + name: string /** * @description The size in bytes of the artifact. * @example 12345 */ - size_in_bytes: number; + size_in_bytes: number /** @example https://api.github.com/repos/github/hello-world/actions/artifacts/5 */ - url: string; + url: string /** @example https://api.github.com/repos/github/hello-world/actions/artifacts/5/zip */ - archive_download_url: string; + archive_download_url: string /** @description Whether or not the artifact has expired. */ - expired: boolean; + expired: boolean /** Format: date-time */ - created_at: string | null; + created_at: string | null /** Format: date-time */ - expires_at: string | null; + expires_at: string | null /** Format: date-time */ - updated_at: string | null; - }; + updated_at: string | null + } /** * Job * @description Information of a job execution in a workflow run @@ -11286,58 +11278,58 @@ export interface components { * @description The id of the job. * @example 21 */ - id: number; + id: number /** * @description The id of the associated workflow run. * @example 5 */ - run_id: number; + run_id: number /** @example https://api.github.com/repos/github/hello-world/actions/runs/5 */ - run_url: string; + run_url: string /** * @description Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run. * @example 1 */ - run_attempt?: number; + run_attempt?: number /** @example MDg6Q2hlY2tSdW40 */ - node_id: string; + node_id: string /** * @description The SHA of the commit that is being run. * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d */ - head_sha: string; + head_sha: string /** @example https://api.github.com/repos/github/hello-world/actions/jobs/21 */ - url: string; + url: string /** @example https://github.com/github/hello-world/runs/4 */ - html_url: string | null; + html_url: string | null /** * @description The phase of the lifecycle that the job is currently in. * @example queued * @enum {string} */ - status: "queued" | "in_progress" | "completed"; + status: 'queued' | 'in_progress' | 'completed' /** * @description The outcome of the job. * @example success */ - conclusion: string | null; + conclusion: string | null /** * Format: date-time * @description The time that the job started, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 */ - started_at: string; + started_at: string /** * Format: date-time * @description The time that the job finished, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 */ - completed_at: string | null; + completed_at: string | null /** * @description The name of the job. * @example test-coverage */ - name: string; + name: string /** @description Steps in this job. */ steps?: { /** @@ -11345,328 +11337,328 @@ export interface components { * @example queued * @enum {string} */ - status: "queued" | "in_progress" | "completed"; + status: 'queued' | 'in_progress' | 'completed' /** * @description The outcome of the job. * @example success */ - conclusion: string | null; + conclusion: string | null /** * @description The name of the job. * @example test-coverage */ - name: string; + name: string /** @example 1 */ - number: number; + number: number /** * Format: date-time * @description The time that the step started, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 */ - started_at?: string | null; + started_at?: string | null /** * Format: date-time * @description The time that the job finished, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 */ - completed_at?: string | null; - }[]; + completed_at?: string | null + }[] /** @example https://api.github.com/repos/github/hello-world/check-runs/4 */ - check_run_url: string; + check_run_url: string /** * @description Labels for the workflow job. Specified by the "runs_on" attribute in the action's workflow file. * @example self-hosted,foo,bar */ - labels: string[]; + labels: string[] /** * @description The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example 1 */ - runner_id: number | null; + runner_id: number | null /** * @description The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example my runner */ - runner_name: string | null; + runner_name: string | null /** * @description The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example 2 */ - runner_group_id: number | null; + runner_group_id: number | null /** * @description The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example my runner group */ - runner_group_name: string | null; - }; + runner_group_name: string | null + } /** @description Whether GitHub Actions is enabled on the repository. */ - "actions-enabled": boolean; - "actions-repository-permissions": { - enabled: components["schemas"]["actions-enabled"]; - allowed_actions?: components["schemas"]["allowed-actions"]; - selected_actions_url?: components["schemas"]["selected-actions-url"]; - }; + 'actions-enabled': boolean + 'actions-repository-permissions': { + enabled: components['schemas']['actions-enabled'] + allowed_actions?: components['schemas']['allowed-actions'] + selected_actions_url?: components['schemas']['selected-actions-url'] + } /** Pull Request Minimal */ - "pull-request-minimal": { - id: number; - number: number; - url: string; + 'pull-request-minimal': { + id: number + number: number + url: string head: { - ref: string; - sha: string; + ref: string + sha: string repo: { - id: number; - url: string; - name: string; - }; - }; + id: number + url: string + name: string + } + } base: { - ref: string; - sha: string; + ref: string + sha: string repo: { - id: number; - url: string; - name: string; - }; - }; - }; + id: number + url: string + name: string + } + } + } /** * Simple Commit * @description Simple Commit */ - "nullable-simple-commit": { - id: string; - tree_id: string; - message: string; + 'nullable-simple-commit': { + id: string + tree_id: string + message: string /** Format: date-time */ - timestamp: string; + timestamp: string author: { - name: string; - email: string; - } | null; + name: string + email: string + } | null committer: { - name: string; - email: string; - } | null; - } | null; + name: string + email: string + } | null + } | null /** * Workflow Run * @description An invocation of a workflow */ - "workflow-run": { + 'workflow-run': { /** * @description The ID of the workflow run. * @example 5 */ - id: number; + id: number /** * @description The name of the workflow run. * @example Build */ - name?: string | null; + name?: string | null /** @example MDEwOkNoZWNrU3VpdGU1 */ - node_id: string; + node_id: string /** * @description The ID of the associated check suite. * @example 42 */ - check_suite_id?: number; + check_suite_id?: number /** * @description The node ID of the associated check suite. * @example MDEwOkNoZWNrU3VpdGU0Mg== */ - check_suite_node_id?: string; + check_suite_node_id?: string /** @example master */ - head_branch: string | null; + head_branch: string | null /** * @description The SHA of the head commit that points to the version of the worflow being run. * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d */ - head_sha: string; + head_sha: string /** * @description The auto incrementing run number for the workflow run. * @example 106 */ - run_number: number; + run_number: number /** * @description Attempt number of the run, 1 for first attempt and higher if the workflow was re-run. * @example 1 */ - run_attempt?: number; + run_attempt?: number /** @example push */ - event: string; + event: string /** @example completed */ - status: string | null; + status: string | null /** @example neutral */ - conclusion: string | null; + conclusion: string | null /** * @description The ID of the parent workflow. * @example 5 */ - workflow_id: number; + workflow_id: number /** * @description The URL to the workflow run. * @example https://api.github.com/repos/github/hello-world/actions/runs/5 */ - url: string; + url: string /** @example https://github.com/github/hello-world/suites/4 */ - html_url: string; - pull_requests: components["schemas"]["pull-request-minimal"][] | null; + html_url: string + pull_requests: components['schemas']['pull-request-minimal'][] | null /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; + updated_at: string /** * Format: date-time * @description The start time of the latest run. Resets on re-run. */ - run_started_at?: string; + run_started_at?: string /** * @description The URL to the jobs for the workflow run. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/jobs */ - jobs_url: string; + jobs_url: string /** * @description The URL to download the logs for the workflow run. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/logs */ - logs_url: string; + logs_url: string /** * @description The URL to the associated check suite. * @example https://api.github.com/repos/github/hello-world/check-suites/12 */ - check_suite_url: string; + check_suite_url: string /** * @description The URL to the artifacts for the workflow run. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts */ - artifacts_url: string; + artifacts_url: string /** * @description The URL to cancel the workflow run. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/cancel */ - cancel_url: string; + cancel_url: string /** * @description The URL to rerun the workflow run. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/rerun */ - rerun_url: string; + rerun_url: string /** * @description The URL to the previous attempted run of this workflow, if one exists. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3 */ - previous_attempt_url?: string | null; + previous_attempt_url?: string | null /** * @description The URL to the workflow. * @example https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml */ - workflow_url: string; - head_commit: components["schemas"]["nullable-simple-commit"]; - repository: components["schemas"]["minimal-repository"]; - head_repository: components["schemas"]["minimal-repository"]; + workflow_url: string + head_commit: components['schemas']['nullable-simple-commit'] + repository: components['schemas']['minimal-repository'] + head_repository: components['schemas']['minimal-repository'] /** @example 5 */ - head_repository_id?: number; - }; + head_repository_id?: number + } /** * Environment Approval * @description An entry in the reviews log for environment deployments */ - "environment-approvals": { + 'environment-approvals': { /** @description The list of environments that were approved or rejected */ environments: { /** * @description The id of the environment. * @example 56780428 */ - id?: number; + id?: number /** @example MDExOkVudmlyb25tZW50NTY3ODA0Mjg= */ - node_id?: string; + node_id?: string /** * @description The name of the environment. * @example staging */ - name?: string; + name?: string /** @example https://api.github.com/repos/github/hello-world/environments/staging */ - url?: string; + url?: string /** @example https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging */ - html_url?: string; + html_url?: string /** * Format: date-time * @description The time that the environment was created, in ISO 8601 format. * @example 2020-11-23T22:00:40Z */ - created_at?: string; + created_at?: string /** * Format: date-time * @description The time that the environment was last updated, in ISO 8601 format. * @example 2020-11-23T22:00:40Z */ - updated_at?: string; - }[]; + updated_at?: string + }[] /** * @description Whether deployment to the environment(s) was approved or rejected * @example approved * @enum {string} */ - state: "approved" | "rejected"; - user: components["schemas"]["simple-user"]; + state: 'approved' | 'rejected' + user: components['schemas']['simple-user'] /** * @description The comment submitted with the deployment review * @example Ship it! */ - comment: string; - }; + comment: string + } /** * @description The type of reviewer. Must be one of: `User` or `Team` * @example User * @enum {string} */ - "deployment-reviewer-type": "User" | "Team"; + 'deployment-reviewer-type': 'User' | 'Team' /** * Pending Deployment * @description Details of a deployment that is waiting for protection rules to pass */ - "pending-deployment": { + 'pending-deployment': { environment: { /** * @description The id of the environment. * @example 56780428 */ - id?: number; + id?: number /** @example MDExOkVudmlyb25tZW50NTY3ODA0Mjg= */ - node_id?: string; + node_id?: string /** * @description The name of the environment. * @example staging */ - name?: string; + name?: string /** @example https://api.github.com/repos/github/hello-world/environments/staging */ - url?: string; + url?: string /** @example https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging */ - html_url?: string; - }; + html_url?: string + } /** * @description The set duration of the wait timer * @example 30 */ - wait_timer: number; + wait_timer: number /** * Format: date-time * @description The time that the wait timer began. * @example 2020-11-23T22:00:40Z */ - wait_timer_started_at: string | null; + wait_timer_started_at: string | null /** * @description Whether the currently authenticated user can approve the deployment * @example true */ - current_user_can_approve: boolean; + current_user_can_approve: boolean /** @description The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */ reviewers: { - type?: components["schemas"]["deployment-reviewer-type"]; - reviewer?: Partial & Partial; - }[]; - }; + type?: components['schemas']['deployment-reviewer-type'] + reviewer?: Partial & Partial + }[] + } /** * Deployment * @description A request for a specific ref(branch,sha,tag) to be deployed @@ -11676,469 +11668,469 @@ export interface components { * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1 */ - url: string; + url: string /** * @description Unique identifier of the deployment * @example 42 */ - id: number; + id: number /** @example MDEwOkRlcGxveW1lbnQx */ - node_id: string; + node_id: string /** @example a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d */ - sha: string; + sha: string /** * @description The ref to deploy. This can be a branch, tag, or sha. * @example topic-branch */ - ref: string; + ref: string /** * @description Parameter to specify a task to execute * @example deploy */ - task: string; - payload: { [key: string]: unknown } | string; + task: string + payload: { [key: string]: unknown } | string /** @example staging */ - original_environment?: string; + original_environment?: string /** * @description Name for the target deployment environment. * @example production */ - environment: string; + environment: string /** @example Deploy request from hubot */ - description: string | null; - creator: components["schemas"]["nullable-simple-user"]; + description: string | null + creator: components['schemas']['nullable-simple-user'] /** * Format: date-time * @example 2012-07-20T01:19:13Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2012-07-20T01:19:13Z */ - updated_at: string; + updated_at: string /** * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1/statuses */ - statuses_url: string; + statuses_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/example */ - repository_url: string; + repository_url: string /** * @description Specifies if the given environment is will no longer exist at some point in the future. Default: false. * @example true */ - transient_environment?: boolean; + transient_environment?: boolean /** * @description Specifies if the given environment is one that end-users directly interact with. Default: false. * @example true */ - production_environment?: boolean; - performed_via_github_app?: components["schemas"]["nullable-integration"]; - }; + production_environment?: boolean + performed_via_github_app?: components['schemas']['nullable-integration'] + } /** * Workflow Run Usage * @description Workflow Run Usage */ - "workflow-run-usage": { + 'workflow-run-usage': { billable: { UBUNTU?: { - total_ms: number; - jobs: number; + total_ms: number + jobs: number job_runs?: { - job_id: number; - duration_ms: number; - }[]; - }; + job_id: number + duration_ms: number + }[] + } MACOS?: { - total_ms: number; - jobs: number; + total_ms: number + jobs: number job_runs?: { - job_id: number; - duration_ms: number; - }[]; - }; + job_id: number + duration_ms: number + }[] + } WINDOWS?: { - total_ms: number; - jobs: number; + total_ms: number + jobs: number job_runs?: { - job_id: number; - duration_ms: number; - }[]; - }; - }; - run_duration_ms?: number; - }; + job_id: number + duration_ms: number + }[] + } + } + run_duration_ms?: number + } /** * Actions Secret * @description Set secrets for GitHub Actions. */ - "actions-secret": { + 'actions-secret': { /** * @description The name of the secret. * @example SECRET_TOKEN */ - name: string; + name: string /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - }; + updated_at: string + } /** * Workflow * @description A GitHub Actions workflow */ workflow: { /** @example 5 */ - id: number; + id: number /** @example MDg6V29ya2Zsb3cxMg== */ - node_id: string; + node_id: string /** @example CI */ - name: string; + name: string /** @example ruby.yaml */ - path: string; + path: string /** * @example active * @enum {string} */ - state: "active" | "deleted" | "disabled_fork" | "disabled_inactivity" | "disabled_manually"; + state: 'active' | 'deleted' | 'disabled_fork' | 'disabled_inactivity' | 'disabled_manually' /** * Format: date-time * @example 2019-12-06T14:20:20.000Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2019-12-06T14:20:20.000Z */ - updated_at: string; + updated_at: string /** @example https://api.github.com/repos/actions/setup-ruby/workflows/5 */ - url: string; + url: string /** @example https://github.com/actions/setup-ruby/blob/master/.github/workflows/ruby.yaml */ - html_url: string; + html_url: string /** @example https://github.com/actions/setup-ruby/workflows/CI/badge.svg */ - badge_url: string; + badge_url: string /** * Format: date-time * @example 2019-12-06T14:20:20.000Z */ - deleted_at?: string; - }; + deleted_at?: string + } /** * Workflow Usage * @description Workflow Usage */ - "workflow-usage": { + 'workflow-usage': { billable: { UBUNTU?: { - total_ms?: number; - }; + total_ms?: number + } MACOS?: { - total_ms?: number; - }; + total_ms?: number + } WINDOWS?: { - total_ms?: number; - }; - }; - }; + total_ms?: number + } + } + } /** * Autolink reference * @description An autolink reference. */ autolink: { /** @example 3 */ - id: number; + id: number /** * @description The prefix of a key that is linkified. * @example TICKET- */ - key_prefix: string; + key_prefix: string /** * @description A template for the target URL that is generated if a key was found. * @example https://example.com/TICKET?query= */ - url_template: string; - }; + url_template: string + } /** * Protected Branch Required Status Check * @description Protected Branch Required Status Check */ - "protected-branch-required-status-check": { - url?: string; - enforcement_level?: string; - contexts: string[]; + 'protected-branch-required-status-check': { + url?: string + enforcement_level?: string + contexts: string[] checks: { - context: string; - app_id: number | null; - }[]; - contexts_url?: string; - strict?: boolean; - }; + context: string + app_id: number | null + }[] + contexts_url?: string + strict?: boolean + } /** * Protected Branch Admin Enforced * @description Protected Branch Admin Enforced */ - "protected-branch-admin-enforced": { + 'protected-branch-admin-enforced': { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins */ - url: string; + url: string /** @example true */ - enabled: boolean; - }; + enabled: boolean + } /** * Protected Branch Pull Request Review * @description Protected Branch Pull Request Review */ - "protected-branch-pull-request-review": { + 'protected-branch-pull-request-review': { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions */ - url?: string; + url?: string dismissal_restrictions?: { /** @description The list of users with review dismissal access. */ - users?: components["schemas"]["simple-user"][]; + users?: components['schemas']['simple-user'][] /** @description The list of teams with review dismissal access. */ - teams?: components["schemas"]["team"][]; + teams?: components['schemas']['team'][] /** @example "https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions" */ - url?: string; + url?: string /** @example "https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users" */ - users_url?: string; + users_url?: string /** @example "https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams" */ - teams_url?: string; - }; + teams_url?: string + } /** @description Allow specific users or teams to bypass pull request requirements. Set to `null` to disable. */ bypass_pull_request_allowances?: { /** @description The list of users allowed to bypass pull request requirements. */ - users?: components["schemas"]["simple-user"][]; + users?: components['schemas']['simple-user'][] /** @description The list of teams allowed to bypass pull request requirements. */ - teams?: components["schemas"]["team"][]; - } | null; + teams?: components['schemas']['team'][] + } | null /** @example true */ - dismiss_stale_reviews: boolean; + dismiss_stale_reviews: boolean /** @example true */ - require_code_owner_reviews: boolean; + require_code_owner_reviews: boolean /** @example 2 */ - required_approving_review_count?: number; - }; + required_approving_review_count?: number + } /** * Branch Restriction Policy * @description Branch Restriction Policy */ - "branch-restriction-policy": { + 'branch-restriction-policy': { /** Format: uri */ - url: string; + url: string /** Format: uri */ - users_url: string; + users_url: string /** Format: uri */ - teams_url: string; + teams_url: string /** Format: uri */ - apps_url: string; + apps_url: string users: { - login?: string; - id?: number; - node_id?: string; - avatar_url?: string; - gravatar_id?: string; - url?: string; - html_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - starred_url?: string; - subscriptions_url?: string; - organizations_url?: string; - repos_url?: string; - events_url?: string; - received_events_url?: string; - type?: string; - site_admin?: boolean; - }[]; + login?: string + id?: number + node_id?: string + avatar_url?: string + gravatar_id?: string + url?: string + html_url?: string + followers_url?: string + following_url?: string + gists_url?: string + starred_url?: string + subscriptions_url?: string + organizations_url?: string + repos_url?: string + events_url?: string + received_events_url?: string + type?: string + site_admin?: boolean + }[] teams: { - id?: number; - node_id?: string; - url?: string; - html_url?: string; - name?: string; - slug?: string; - description?: string | null; - privacy?: string; - permission?: string; - members_url?: string; - repositories_url?: string; - parent?: string | null; - }[]; + id?: number + node_id?: string + url?: string + html_url?: string + name?: string + slug?: string + description?: string | null + privacy?: string + permission?: string + members_url?: string + repositories_url?: string + parent?: string | null + }[] apps: { - id?: number; - slug?: string; - node_id?: string; + id?: number + slug?: string + node_id?: string owner?: { - login?: string; - id?: number; - node_id?: string; - url?: string; - repos_url?: string; - events_url?: string; - hooks_url?: string; - issues_url?: string; - members_url?: string; - public_members_url?: string; - avatar_url?: string; - description?: string; + login?: string + id?: number + node_id?: string + url?: string + repos_url?: string + events_url?: string + hooks_url?: string + issues_url?: string + members_url?: string + public_members_url?: string + avatar_url?: string + description?: string /** @example "" */ - gravatar_id?: string; + gravatar_id?: string /** @example "https://github.com/testorg-ea8ec76d71c3af4b" */ - html_url?: string; + html_url?: string /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers" */ - followers_url?: string; + followers_url?: string /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}" */ - following_url?: string; + following_url?: string /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}" */ - gists_url?: string; + gists_url?: string /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}" */ - starred_url?: string; + starred_url?: string /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions" */ - subscriptions_url?: string; + subscriptions_url?: string /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs" */ - organizations_url?: string; + organizations_url?: string /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events" */ - received_events_url?: string; + received_events_url?: string /** @example "Organization" */ - type?: string; - site_admin?: boolean; - }; - name?: string; - description?: string; - external_url?: string; - html_url?: string; - created_at?: string; - updated_at?: string; + type?: string + site_admin?: boolean + } + name?: string + description?: string + external_url?: string + html_url?: string + created_at?: string + updated_at?: string permissions?: { - metadata?: string; - contents?: string; - issues?: string; - single_file?: string; - }; - events?: string[]; - }[]; - }; + metadata?: string + contents?: string + issues?: string + single_file?: string + } + events?: string[] + }[] + } /** * Branch Protection * @description Branch Protection */ - "branch-protection": { - url?: string; - enabled?: boolean; - required_status_checks?: components["schemas"]["protected-branch-required-status-check"]; - enforce_admins?: components["schemas"]["protected-branch-admin-enforced"]; - required_pull_request_reviews?: components["schemas"]["protected-branch-pull-request-review"]; - restrictions?: components["schemas"]["branch-restriction-policy"]; + 'branch-protection': { + url?: string + enabled?: boolean + required_status_checks?: components['schemas']['protected-branch-required-status-check'] + enforce_admins?: components['schemas']['protected-branch-admin-enforced'] + required_pull_request_reviews?: components['schemas']['protected-branch-pull-request-review'] + restrictions?: components['schemas']['branch-restriction-policy'] required_linear_history?: { - enabled?: boolean; - }; + enabled?: boolean + } allow_force_pushes?: { - enabled?: boolean; - }; + enabled?: boolean + } allow_deletions?: { - enabled?: boolean; - }; + enabled?: boolean + } required_conversation_resolution?: { - enabled?: boolean; - }; + enabled?: boolean + } /** @example "branch/with/protection" */ - name?: string; + name?: string /** @example "https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection" */ - protection_url?: string; + protection_url?: string required_signatures?: { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures */ - url: string; + url: string /** @example true */ - enabled: boolean; - }; - }; + enabled: boolean + } + } /** * Short Branch * @description Short Branch */ - "short-branch": { - name: string; + 'short-branch': { + name: string commit: { - sha: string; + sha: string /** Format: uri */ - url: string; - }; - protected: boolean; - protection?: components["schemas"]["branch-protection"]; + url: string + } + protected: boolean + protection?: components['schemas']['branch-protection'] /** Format: uri */ - protection_url?: string; - }; + protection_url?: string + } /** * Git User * @description Metaproperties for Git author/committer information. */ - "nullable-git-user": { + 'nullable-git-user': { /** @example "Chris Wanstrath" */ - name?: string; + name?: string /** @example "chris@ozmm.org" */ - email?: string; + email?: string /** @example "2007-10-29T02:42:39.000-07:00" */ - date?: string; - } | null; + date?: string + } | null /** Verification */ verification: { - verified: boolean; - reason: string; - payload: string | null; - signature: string | null; - }; + verified: boolean + reason: string + payload: string | null + signature: string | null + } /** * Diff Entry * @description Diff Entry */ - "diff-entry": { + 'diff-entry': { /** @example bbcd538c8e72b8c175046e27cc8f907076331401 */ - sha: string; + sha: string /** @example file1.txt */ - filename: string; + filename: string /** * @example added * @enum {string} */ - status: "added" | "removed" | "modified" | "renamed" | "copied" | "changed" | "unchanged"; + status: 'added' | 'removed' | 'modified' | 'renamed' | 'copied' | 'changed' | 'unchanged' /** @example 103 */ - additions: number; + additions: number /** @example 21 */ - deletions: number; + deletions: number /** @example 124 */ - changes: number; + changes: number /** * Format: uri * @example https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt */ - blob_url: string; + blob_url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt */ - raw_url: string; + raw_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e */ - contents_url: string; + contents_url: string /** @example @@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test */ - patch?: string; + patch?: string /** @example file.txt */ - previous_filename?: string; - }; + previous_filename?: string + } /** * Commit * @description Commit @@ -12148,1651 +12140,1647 @@ export interface components { * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e */ - url: string; + url: string /** @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */ - sha: string; + sha: string /** @example MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== */ - node_id: string; + node_id: string /** * Format: uri * @example https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments */ - comments_url: string; + comments_url: string commit: { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e */ - url: string; - author: components["schemas"]["nullable-git-user"]; - committer: components["schemas"]["nullable-git-user"]; + url: string + author: components['schemas']['nullable-git-user'] + committer: components['schemas']['nullable-git-user'] /** @example Fix all the bugs */ - message: string; - comment_count: number; + message: string + comment_count: number tree: { /** @example 827efc6d56897b048c772eb4087f854f46256132 */ - sha: string; + sha: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132 */ - url: string; - }; - verification?: components["schemas"]["verification"]; - }; - author: components["schemas"]["nullable-simple-user"]; - committer: components["schemas"]["nullable-simple-user"]; + url: string + } + verification?: components['schemas']['verification'] + } + author: components['schemas']['nullable-simple-user'] + committer: components['schemas']['nullable-simple-user'] parents: { /** @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - sha: string; + sha: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd */ - url: string; + url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd */ - html_url?: string; - }[]; + html_url?: string + }[] stats?: { - additions?: number; - deletions?: number; - total?: number; - }; - files?: components["schemas"]["diff-entry"][]; - }; + additions?: number + deletions?: number + total?: number + } + files?: components['schemas']['diff-entry'][] + } /** * Branch With Protection * @description Branch With Protection */ - "branch-with-protection": { - name: string; - commit: components["schemas"]["commit"]; + 'branch-with-protection': { + name: string + commit: components['schemas']['commit'] _links: { - html: string; + html: string /** Format: uri */ - self: string; - }; - protected: boolean; - protection: components["schemas"]["branch-protection"]; + self: string + } + protected: boolean + protection: components['schemas']['branch-protection'] /** Format: uri */ - protection_url: string; + protection_url: string /** @example "mas*" */ - pattern?: string; + pattern?: string /** @example 1 */ - required_approving_review_count?: number; - }; + required_approving_review_count?: number + } /** * Status Check Policy * @description Status Check Policy */ - "status-check-policy": { + 'status-check-policy': { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks */ - url: string; + url: string /** @example true */ - strict: boolean; + strict: boolean /** @example continuous-integration/travis-ci */ - contexts: string[]; + contexts: string[] checks: { /** @example continuous-integration/travis-ci */ - context: string; - app_id: number | null; - }[]; + context: string + app_id: number | null + }[] /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts */ - contexts_url: string; - }; + contexts_url: string + } /** * Protected Branch * @description Branch protections protect branches */ - "protected-branch": { + 'protected-branch': { /** Format: uri */ - url: string; - required_status_checks?: components["schemas"]["status-check-policy"]; + url: string + required_status_checks?: components['schemas']['status-check-policy'] required_pull_request_reviews?: { /** Format: uri */ - url: string; - dismiss_stale_reviews?: boolean; - require_code_owner_reviews?: boolean; - required_approving_review_count?: number; + url: string + dismiss_stale_reviews?: boolean + require_code_owner_reviews?: boolean + required_approving_review_count?: number dismissal_restrictions?: { /** Format: uri */ - url: string; + url: string /** Format: uri */ - users_url: string; + users_url: string /** Format: uri */ - teams_url: string; - users: components["schemas"]["simple-user"][]; - teams: components["schemas"]["team"][]; - }; + teams_url: string + users: components['schemas']['simple-user'][] + teams: components['schemas']['team'][] + } bypass_pull_request_allowances?: { - users: components["schemas"]["simple-user"][]; - teams: components["schemas"]["team"][]; - }; - }; + users: components['schemas']['simple-user'][] + teams: components['schemas']['team'][] + } + } required_signatures?: { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures */ - url: string; + url: string /** @example true */ - enabled: boolean; - }; + enabled: boolean + } enforce_admins?: { /** Format: uri */ - url: string; - enabled: boolean; - }; + url: string + enabled: boolean + } required_linear_history?: { - enabled: boolean; - }; + enabled: boolean + } allow_force_pushes?: { - enabled: boolean; - }; + enabled: boolean + } allow_deletions?: { - enabled: boolean; - }; - restrictions?: components["schemas"]["branch-restriction-policy"]; + enabled: boolean + } + restrictions?: components['schemas']['branch-restriction-policy'] required_conversation_resolution?: { - enabled?: boolean; - }; - }; + enabled?: boolean + } + } /** * Deployment * @description A deployment created as the result of an Actions check run from a workflow that references an environment */ - "deployment-simple": { + 'deployment-simple': { /** * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1 */ - url: string; + url: string /** * @description Unique identifier of the deployment * @example 42 */ - id: number; + id: number /** @example MDEwOkRlcGxveW1lbnQx */ - node_id: string; + node_id: string /** * @description Parameter to specify a task to execute * @example deploy */ - task: string; + task: string /** @example staging */ - original_environment?: string; + original_environment?: string /** * @description Name for the target deployment environment. * @example production */ - environment: string; + environment: string /** @example Deploy request from hubot */ - description: string | null; + description: string | null /** * Format: date-time * @example 2012-07-20T01:19:13Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2012-07-20T01:19:13Z */ - updated_at: string; + updated_at: string /** * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1/statuses */ - statuses_url: string; + statuses_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/example */ - repository_url: string; + repository_url: string /** * @description Specifies if the given environment is will no longer exist at some point in the future. Default: false. * @example true */ - transient_environment?: boolean; + transient_environment?: boolean /** * @description Specifies if the given environment is one that end-users directly interact with. Default: false. * @example true */ - production_environment?: boolean; - performed_via_github_app?: components["schemas"]["nullable-integration"]; - }; + production_environment?: boolean + performed_via_github_app?: components['schemas']['nullable-integration'] + } /** * CheckRun * @description A check performed on the code of a given code change */ - "check-run": { + 'check-run': { /** * @description The id of the check. * @example 21 */ - id: number; + id: number /** * @description The SHA of the commit that is being checked. * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d */ - head_sha: string; + head_sha: string /** @example MDg6Q2hlY2tSdW40 */ - node_id: string; + node_id: string /** @example 42 */ - external_id: string | null; + external_id: string | null /** @example https://api.github.com/repos/github/hello-world/check-runs/4 */ - url: string; + url: string /** @example https://github.com/github/hello-world/runs/4 */ - html_url: string | null; + html_url: string | null /** @example https://example.com */ - details_url: string | null; + details_url: string | null /** * @description The phase of the lifecycle that the check is currently in. * @example queued * @enum {string} */ - status: "queued" | "in_progress" | "completed"; + status: 'queued' | 'in_progress' | 'completed' /** * @example neutral * @enum {string|null} */ - conclusion: - | ("success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required") - | null; + conclusion: ('success' | 'failure' | 'neutral' | 'cancelled' | 'skipped' | 'timed_out' | 'action_required') | null /** * Format: date-time * @example 2018-05-04T01:14:52Z */ - started_at: string | null; + started_at: string | null /** * Format: date-time * @example 2018-05-04T01:14:52Z */ - completed_at: string | null; + completed_at: string | null output: { - title: string | null; - summary: string | null; - text: string | null; - annotations_count: number; + title: string | null + summary: string | null + text: string | null + annotations_count: number /** Format: uri */ - annotations_url: string; - }; + annotations_url: string + } /** * @description The name of the check. * @example test-coverage */ - name: string; + name: string check_suite: { - id: number; - } | null; - app: components["schemas"]["nullable-integration"]; - pull_requests: components["schemas"]["pull-request-minimal"][]; - deployment?: components["schemas"]["deployment-simple"]; - }; + id: number + } | null + app: components['schemas']['nullable-integration'] + pull_requests: components['schemas']['pull-request-minimal'][] + deployment?: components['schemas']['deployment-simple'] + } /** * Check Annotation * @description Check Annotation */ - "check-annotation": { + 'check-annotation': { /** @example README.md */ - path: string; + path: string /** @example 2 */ - start_line: number; + start_line: number /** @example 2 */ - end_line: number; + end_line: number /** @example 5 */ - start_column: number | null; + start_column: number | null /** @example 10 */ - end_column: number | null; + end_column: number | null /** @example warning */ - annotation_level: string | null; + annotation_level: string | null /** @example Spell Checker */ - title: string | null; + title: string | null /** @example Check your spelling for 'banaas'. */ - message: string | null; + message: string | null /** @example Do you mean 'bananas' or 'banana'? */ - raw_details: string | null; - blob_href: string; - }; + raw_details: string | null + blob_href: string + } /** * Simple Commit * @description Simple Commit */ - "simple-commit": { - id: string; - tree_id: string; - message: string; + 'simple-commit': { + id: string + tree_id: string + message: string /** Format: date-time */ - timestamp: string; + timestamp: string author: { - name: string; - email: string; - } | null; + name: string + email: string + } | null committer: { - name: string; - email: string; - } | null; - }; + name: string + email: string + } | null + } /** * CheckSuite * @description A suite of checks performed on the code of a given code change */ - "check-suite": { + 'check-suite': { /** @example 5 */ - id: number; + id: number /** @example MDEwOkNoZWNrU3VpdGU1 */ - node_id: string; + node_id: string /** @example master */ - head_branch: string | null; + head_branch: string | null /** * @description The SHA of the head commit that is being checked. * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d */ - head_sha: string; + head_sha: string /** * @example completed * @enum {string|null} */ - status: ("queued" | "in_progress" | "completed") | null; + status: ('queued' | 'in_progress' | 'completed') | null /** * @example neutral * @enum {string|null} */ - conclusion: - | ("success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required") - | null; + conclusion: ('success' | 'failure' | 'neutral' | 'cancelled' | 'skipped' | 'timed_out' | 'action_required') | null /** @example https://api.github.com/repos/github/hello-world/check-suites/5 */ - url: string | null; + url: string | null /** @example 146e867f55c26428e5f9fade55a9bbf5e95a7912 */ - before: string | null; + before: string | null /** @example d6fde92930d4715a2b49857d24b940956b26d2d3 */ - after: string | null; - pull_requests: components["schemas"]["pull-request-minimal"][] | null; - app: components["schemas"]["nullable-integration"]; - repository: components["schemas"]["minimal-repository"]; + after: string | null + pull_requests: components['schemas']['pull-request-minimal'][] | null + app: components['schemas']['nullable-integration'] + repository: components['schemas']['minimal-repository'] /** Format: date-time */ - created_at: string | null; + created_at: string | null /** Format: date-time */ - updated_at: string | null; - head_commit: components["schemas"]["simple-commit"]; - latest_check_runs_count: number; - check_runs_url: string; - rerequestable?: boolean; - runs_rerequestable?: boolean; - }; + updated_at: string | null + head_commit: components['schemas']['simple-commit'] + latest_check_runs_count: number + check_runs_url: string + rerequestable?: boolean + runs_rerequestable?: boolean + } /** * Check Suite Preference * @description Check suite configuration preferences for a repository. */ - "check-suite-preference": { + 'check-suite-preference': { preferences: { auto_trigger_checks?: { - app_id: number; - setting: boolean; - }[]; - }; - repository: components["schemas"]["minimal-repository"]; - }; - "code-scanning-alert-rule-summary": { + app_id: number + setting: boolean + }[] + } + repository: components['schemas']['minimal-repository'] + } + 'code-scanning-alert-rule-summary': { /** @description A unique identifier for the rule used to detect the alert. */ - id?: string | null; + id?: string | null /** @description The name of the rule used to detect the alert. */ - name?: string; + name?: string /** @description A set of tags applicable for the rule. */ - tags?: string[] | null; + tags?: string[] | null /** * @description The severity of the alert. * @enum {string|null} */ - severity?: ("none" | "note" | "warning" | "error") | null; + severity?: ('none' | 'note' | 'warning' | 'error') | null /** @description A short description of the rule used to detect the alert. */ - description?: string; - }; - "code-scanning-alert-items": { - number: components["schemas"]["alert-number"]; - created_at: components["schemas"]["alert-created-at"]; - updated_at?: components["schemas"]["alert-updated-at"]; - url: components["schemas"]["alert-url"]; - html_url: components["schemas"]["alert-html-url"]; - instances_url: components["schemas"]["alert-instances-url"]; - state: components["schemas"]["code-scanning-alert-state"]; - fixed_at?: components["schemas"]["code-scanning-alert-fixed-at"]; - dismissed_by: components["schemas"]["nullable-simple-user"]; - dismissed_at: components["schemas"]["code-scanning-alert-dismissed-at"]; - dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"]; - rule: components["schemas"]["code-scanning-alert-rule-summary"]; - tool: components["schemas"]["code-scanning-analysis-tool"]; - most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; - }; - "code-scanning-alert": { - number: components["schemas"]["alert-number"]; - created_at: components["schemas"]["alert-created-at"]; - updated_at?: components["schemas"]["alert-updated-at"]; - url: components["schemas"]["alert-url"]; - html_url: components["schemas"]["alert-html-url"]; - instances_url: components["schemas"]["alert-instances-url"]; - state: components["schemas"]["code-scanning-alert-state"]; - fixed_at?: components["schemas"]["code-scanning-alert-fixed-at"]; - dismissed_by: components["schemas"]["nullable-simple-user"]; - dismissed_at: components["schemas"]["code-scanning-alert-dismissed-at"]; - dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"]; - rule: components["schemas"]["code-scanning-alert-rule"]; - tool: components["schemas"]["code-scanning-analysis-tool"]; - most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; - }; + description?: string + } + 'code-scanning-alert-items': { + number: components['schemas']['alert-number'] + created_at: components['schemas']['alert-created-at'] + updated_at?: components['schemas']['alert-updated-at'] + url: components['schemas']['alert-url'] + html_url: components['schemas']['alert-html-url'] + instances_url: components['schemas']['alert-instances-url'] + state: components['schemas']['code-scanning-alert-state'] + fixed_at?: components['schemas']['code-scanning-alert-fixed-at'] + dismissed_by: components['schemas']['nullable-simple-user'] + dismissed_at: components['schemas']['code-scanning-alert-dismissed-at'] + dismissed_reason: components['schemas']['code-scanning-alert-dismissed-reason'] + rule: components['schemas']['code-scanning-alert-rule-summary'] + tool: components['schemas']['code-scanning-analysis-tool'] + most_recent_instance: components['schemas']['code-scanning-alert-instance'] + } + 'code-scanning-alert': { + number: components['schemas']['alert-number'] + created_at: components['schemas']['alert-created-at'] + updated_at?: components['schemas']['alert-updated-at'] + url: components['schemas']['alert-url'] + html_url: components['schemas']['alert-html-url'] + instances_url: components['schemas']['alert-instances-url'] + state: components['schemas']['code-scanning-alert-state'] + fixed_at?: components['schemas']['code-scanning-alert-fixed-at'] + dismissed_by: components['schemas']['nullable-simple-user'] + dismissed_at: components['schemas']['code-scanning-alert-dismissed-at'] + dismissed_reason: components['schemas']['code-scanning-alert-dismissed-reason'] + rule: components['schemas']['code-scanning-alert-rule'] + tool: components['schemas']['code-scanning-analysis-tool'] + most_recent_instance: components['schemas']['code-scanning-alert-instance'] + } /** * @description Sets the state of the code scanning alert. Can be one of `open` or `dismissed`. You must provide `dismissed_reason` when you set the state to `dismissed`. * @enum {string} */ - "code-scanning-alert-set-state": "open" | "dismissed"; + 'code-scanning-alert-set-state': 'open' | 'dismissed' /** * @description An identifier for the upload. * @example 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 */ - "code-scanning-analysis-sarif-id": string; + 'code-scanning-analysis-sarif-id': string /** @description The SHA of the commit to which the analysis you are uploading relates. */ - "code-scanning-analysis-commit-sha": string; + 'code-scanning-analysis-commit-sha': string /** @description Identifies the variable values associated with the environment in which this analysis was performed. */ - "code-scanning-analysis-environment": string; + 'code-scanning-analysis-environment': string /** * Format: date-time * @description The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "code-scanning-analysis-created-at": string; + 'code-scanning-analysis-created-at': string /** * Format: uri * @description The REST API URL of the analysis resource. */ - "code-scanning-analysis-url": string; - "code-scanning-analysis": { - ref: components["schemas"]["code-scanning-ref"]; - commit_sha: components["schemas"]["code-scanning-analysis-commit-sha"]; - analysis_key: components["schemas"]["code-scanning-analysis-analysis-key"]; - environment: components["schemas"]["code-scanning-analysis-environment"]; - category?: components["schemas"]["code-scanning-analysis-category"]; + 'code-scanning-analysis-url': string + 'code-scanning-analysis': { + ref: components['schemas']['code-scanning-ref'] + commit_sha: components['schemas']['code-scanning-analysis-commit-sha'] + analysis_key: components['schemas']['code-scanning-analysis-analysis-key'] + environment: components['schemas']['code-scanning-analysis-environment'] + category?: components['schemas']['code-scanning-analysis-category'] /** @example error reading field xyz */ - error: string; - created_at: components["schemas"]["code-scanning-analysis-created-at"]; + error: string + created_at: components['schemas']['code-scanning-analysis-created-at'] /** @description The total number of results in the analysis. */ - results_count: number; + results_count: number /** @description The total number of rules used in the analysis. */ - rules_count: number; + rules_count: number /** @description Unique identifier for this analysis. */ - id: number; - url: components["schemas"]["code-scanning-analysis-url"]; - sarif_id: components["schemas"]["code-scanning-analysis-sarif-id"]; - tool: components["schemas"]["code-scanning-analysis-tool"]; - deletable: boolean; + id: number + url: components['schemas']['code-scanning-analysis-url'] + sarif_id: components['schemas']['code-scanning-analysis-sarif-id'] + tool: components['schemas']['code-scanning-analysis-tool'] + deletable: boolean /** * @description Warning generated when processing the analysis * @example 123 results were ignored */ - warning: string; - }; + warning: string + } /** * Analysis deletion * @description Successful deletion of a code scanning analysis */ - "code-scanning-analysis-deletion": { + 'code-scanning-analysis-deletion': { /** * Format: uri * @description Next deletable analysis in chain, without last analysis deletion confirmation */ - next_analysis_url: string | null; + next_analysis_url: string | null /** * Format: uri * @description Next deletable analysis in chain, with last analysis deletion confirmation */ - confirm_delete_url: string | null; - }; + confirm_delete_url: string | null + } /** @description A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see "[SARIF support for code scanning](https://docs.github.com/code-security/secure-coding/sarif-support-for-code-scanning)." */ - "code-scanning-analysis-sarif-file": string; - "code-scanning-sarifs-receipt": { - id?: components["schemas"]["code-scanning-analysis-sarif-id"]; + 'code-scanning-analysis-sarif-file': string + 'code-scanning-sarifs-receipt': { + id?: components['schemas']['code-scanning-analysis-sarif-id'] /** * Format: uri * @description The REST API URL for checking the status of the upload. */ - url?: string; - }; - "code-scanning-sarifs-status": { + url?: string + } + 'code-scanning-sarifs-status': { /** * @description `pending` files have not yet been processed, while `complete` means results from the SARIF have been stored. `failed` files have either not been processed at all, or could only be partially processed. * @enum {string} */ - processing_status?: "pending" | "complete" | "failed"; + processing_status?: 'pending' | 'complete' | 'failed' /** * Format: uri * @description The REST API URL for getting the analyses associated with the upload. */ - analyses_url?: string | null; + analyses_url?: string | null /** @description Any errors that ocurred during processing of the delivery. */ - errors?: string[] | null; - }; + errors?: string[] | null + } /** * Codespace machine * @description A description of the machine powering a codespace. */ - "nullable-codespace-machine": { + 'nullable-codespace-machine': { /** * @description The name of the machine. * @example standardLinux */ - name: string; + name: string /** * @description The display name of the machine includes cores, memory, and storage. * @example 4 cores, 8 GB RAM, 64 GB storage */ - display_name: string; + display_name: string /** * @description The operating system of the machine. * @example linux */ - operating_system: string; + operating_system: string /** * @description How much storage is available to the codespace. * @example 68719476736 */ - storage_in_bytes: number; + storage_in_bytes: number /** * @description How much memory is available to the codespace. * @example 8589934592 */ - memory_in_bytes: number; + memory_in_bytes: number /** * @description How many cores are available to the codespace. * @example 4 */ - cpus: number; + cpus: number /** * @description Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be "null" if prebuilds are not supported or prebuild availability could not be determined. Value is the type of prebuild available, or "none" if none are available. * @example blob * @enum {string|null} */ - prebuild_availability: ("none" | "blob" | "pool") | null; - } | null; + prebuild_availability: ('none' | 'blob' | 'pool') | null + } | null /** * Codespace * @description A codespace. */ codespace: { /** @example 1 */ - id: number; + id: number /** * @description Automatically generated name of this codespace. * @example monalisa-octocat-hello-world-g4wpq6h95q */ - name: string; + name: string /** * @description UUID identifying this codespace's environment. * @example 26a7c758-7299-4a73-b978-5a92a7ae98a0 */ - environment_id: string | null; - owner: components["schemas"]["simple-user"]; - billable_owner: components["schemas"]["simple-user"]; - repository: components["schemas"]["minimal-repository"]; - machine: components["schemas"]["nullable-codespace-machine"]; + environment_id: string | null + owner: components['schemas']['simple-user'] + billable_owner: components['schemas']['simple-user'] + repository: components['schemas']['minimal-repository'] + machine: components['schemas']['nullable-codespace-machine'] /** @description Whether the codespace was created from a prebuild. */ - prebuild: boolean | null; + prebuild: boolean | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - updated_at: string; + updated_at: string /** * Format: date-time * @description Last known time this codespace was started. * @example 2011-01-26T19:01:12Z */ - last_used_at: string; + last_used_at: string /** * @description State of this codespace. * @example Available * @enum {string} */ state: - | "Unknown" - | "Created" - | "Queued" - | "Provisioning" - | "Available" - | "Awaiting" - | "Unavailable" - | "Deleted" - | "Moved" - | "Shutdown" - | "Archived" - | "Starting" - | "ShuttingDown" - | "Failed" - | "Exporting" - | "Updating" - | "Rebuilding"; + | 'Unknown' + | 'Created' + | 'Queued' + | 'Provisioning' + | 'Available' + | 'Awaiting' + | 'Unavailable' + | 'Deleted' + | 'Moved' + | 'Shutdown' + | 'Archived' + | 'Starting' + | 'ShuttingDown' + | 'Failed' + | 'Exporting' + | 'Updating' + | 'Rebuilding' /** * Format: uri * @description API URL for this codespace. */ - url: string; + url: string /** @description Details about the codespace's git repository. */ git_status: { /** @description The number of commits the local repository is ahead of the remote. */ - ahead?: number; + ahead?: number /** @description The number of commits the local repository is behind the remote. */ - behind?: number; + behind?: number /** @description Whether the local repository has unpushed changes. */ - has_unpushed_changes?: boolean; + has_unpushed_changes?: boolean /** @description Whether the local repository has uncommitted changes. */ - has_uncommitted_changes?: boolean; + has_uncommitted_changes?: boolean /** * @description The current branch (or SHA if in detached HEAD state) of the local repository. * @example main */ - ref?: string; - }; + ref?: string + } /** * @description The Azure region where this codespace is located. * @example WestUs2 * @enum {string} */ - location: "EastUs" | "SouthEastAsia" | "WestEurope" | "WestUs2"; + location: 'EastUs' | 'SouthEastAsia' | 'WestEurope' | 'WestUs2' /** * @description The number of minutes of inactivity after which this codespace will be automatically stopped. * @example 60 */ - idle_timeout_minutes: number | null; + idle_timeout_minutes: number | null /** * Format: uri * @description URL to access this codespace on the web. */ - web_url: string; + web_url: string /** * Format: uri * @description API URL to access available alternate machine types for this codespace. */ - machines_url: string; + machines_url: string /** * Format: uri * @description API URL to start this codespace. */ - start_url: string; + start_url: string /** * Format: uri * @description API URL to stop this codespace. */ - stop_url: string; + stop_url: string /** * Format: uri * @description API URL for the Pull Request associated with this codespace, if any. */ - pulls_url: string | null; - recent_folders: string[]; + pulls_url: string | null + recent_folders: string[] runtime_constraints?: { /** @description The privacy settings a user can select from when forwarding a port. */ - allowed_port_privacy_settings?: string[] | null; - }; - }; + allowed_port_privacy_settings?: string[] | null + } + } /** * Codespace machine * @description A description of the machine powering a codespace. */ - "codespace-machine": { + 'codespace-machine': { /** * @description The name of the machine. * @example standardLinux */ - name: string; + name: string /** * @description The display name of the machine includes cores, memory, and storage. * @example 4 cores, 8 GB RAM, 64 GB storage */ - display_name: string; + display_name: string /** * @description The operating system of the machine. * @example linux */ - operating_system: string; + operating_system: string /** * @description How much storage is available to the codespace. * @example 68719476736 */ - storage_in_bytes: number; + storage_in_bytes: number /** * @description How much memory is available to the codespace. * @example 8589934592 */ - memory_in_bytes: number; + memory_in_bytes: number /** * @description How many cores are available to the codespace. * @example 4 */ - cpus: number; + cpus: number /** * @description Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be "null" if prebuilds are not supported or prebuild availability could not be determined. Value is the type of prebuild available, or "none" if none are available. * @example blob * @enum {string|null} */ - prebuild_availability: ("none" | "blob" | "pool") | null; - }; + prebuild_availability: ('none' | 'blob' | 'pool') | null + } /** * Collaborator * @description Collaborator */ collaborator: { /** @example octocat */ - login: string; + login: string /** @example 1 */ - id: number; - email?: string | null; - name?: string | null; + id: number + email?: string | null + name?: string | null /** @example MDQ6VXNlcjE= */ - node_id: string; + node_id: string /** * Format: uri * @example https://github.com/images/error/octocat_happy.gif */ - avatar_url: string; + avatar_url: string /** @example 41d064eb2195891e12d0413f63227ea7 */ - gravatar_id: string | null; + gravatar_id: string | null /** * Format: uri * @example https://api.github.com/users/octocat */ - url: string; + url: string /** * Format: uri * @example https://github.com/octocat */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/users/octocat/followers */ - followers_url: string; + followers_url: string /** @example https://api.github.com/users/octocat/following{/other_user} */ - following_url: string; + following_url: string /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - gists_url: string; + gists_url: string /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - starred_url: string; + starred_url: string /** * Format: uri * @example https://api.github.com/users/octocat/subscriptions */ - subscriptions_url: string; + subscriptions_url: string /** * Format: uri * @example https://api.github.com/users/octocat/orgs */ - organizations_url: string; + organizations_url: string /** * Format: uri * @example https://api.github.com/users/octocat/repos */ - repos_url: string; + repos_url: string /** @example https://api.github.com/users/octocat/events{/privacy} */ - events_url: string; + events_url: string /** * Format: uri * @example https://api.github.com/users/octocat/received_events */ - received_events_url: string; + received_events_url: string /** @example User */ - type: string; - site_admin: boolean; + type: string + site_admin: boolean permissions?: { - pull: boolean; - triage?: boolean; - push: boolean; - maintain?: boolean; - admin: boolean; - }; + pull: boolean + triage?: boolean + push: boolean + maintain?: boolean + admin: boolean + } /** @example admin */ - role_name: string; - }; + role_name: string + } /** * Repository Invitation * @description Repository invitations let you manage who you collaborate with. */ - "repository-invitation": { + 'repository-invitation': { /** * @description Unique identifier of the repository invitation. * @example 42 */ - id: number; - repository: components["schemas"]["minimal-repository"]; - invitee: components["schemas"]["nullable-simple-user"]; - inviter: components["schemas"]["nullable-simple-user"]; + id: number + repository: components['schemas']['minimal-repository'] + invitee: components['schemas']['nullable-simple-user'] + inviter: components['schemas']['nullable-simple-user'] /** * @description The permission associated with the invitation. * @example read * @enum {string} */ - permissions: "read" | "write" | "admin" | "triage" | "maintain"; + permissions: 'read' | 'write' | 'admin' | 'triage' | 'maintain' /** * Format: date-time * @example 2016-06-13T14:52:50-05:00 */ - created_at: string; + created_at: string /** @description Whether or not the invitation has expired */ - expired?: boolean; + expired?: boolean /** * @description URL for the repository invitation * @example https://api.github.com/user/repository-invitations/1 */ - url: string; + url: string /** @example https://github.com/octocat/Hello-World/invitations */ - html_url: string; - node_id: string; - }; + html_url: string + node_id: string + } /** * Collaborator * @description Collaborator */ - "nullable-collaborator": { + 'nullable-collaborator': { /** @example octocat */ - login: string; + login: string /** @example 1 */ - id: number; - email?: string | null; - name?: string | null; + id: number + email?: string | null + name?: string | null /** @example MDQ6VXNlcjE= */ - node_id: string; + node_id: string /** * Format: uri * @example https://github.com/images/error/octocat_happy.gif */ - avatar_url: string; + avatar_url: string /** @example 41d064eb2195891e12d0413f63227ea7 */ - gravatar_id: string | null; + gravatar_id: string | null /** * Format: uri * @example https://api.github.com/users/octocat */ - url: string; + url: string /** * Format: uri * @example https://github.com/octocat */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/users/octocat/followers */ - followers_url: string; + followers_url: string /** @example https://api.github.com/users/octocat/following{/other_user} */ - following_url: string; + following_url: string /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - gists_url: string; + gists_url: string /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - starred_url: string; + starred_url: string /** * Format: uri * @example https://api.github.com/users/octocat/subscriptions */ - subscriptions_url: string; + subscriptions_url: string /** * Format: uri * @example https://api.github.com/users/octocat/orgs */ - organizations_url: string; + organizations_url: string /** * Format: uri * @example https://api.github.com/users/octocat/repos */ - repos_url: string; + repos_url: string /** @example https://api.github.com/users/octocat/events{/privacy} */ - events_url: string; + events_url: string /** * Format: uri * @example https://api.github.com/users/octocat/received_events */ - received_events_url: string; + received_events_url: string /** @example User */ - type: string; - site_admin: boolean; + type: string + site_admin: boolean permissions?: { - pull: boolean; - triage?: boolean; - push: boolean; - maintain?: boolean; - admin: boolean; - }; + pull: boolean + triage?: boolean + push: boolean + maintain?: boolean + admin: boolean + } /** @example admin */ - role_name: string; - } | null; + role_name: string + } | null /** * Repository Collaborator Permission * @description Repository Collaborator Permission */ - "repository-collaborator-permission": { - permission: string; + 'repository-collaborator-permission': { + permission: string /** @example admin */ - role_name: string; - user: components["schemas"]["nullable-collaborator"]; - }; + role_name: string + user: components['schemas']['nullable-collaborator'] + } /** * Commit Comment * @description Commit Comment */ - "commit-comment": { + 'commit-comment': { /** Format: uri */ - html_url: string; + html_url: string /** Format: uri */ - url: string; - id: number; - node_id: string; - body: string; - path: string | null; - position: number | null; - line: number | null; - commit_id: string; - user: components["schemas"]["nullable-simple-user"]; + url: string + id: number + node_id: string + body: string + path: string | null + position: number | null + line: number | null + commit_id: string + user: components['schemas']['nullable-simple-user'] /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - author_association: components["schemas"]["author_association"]; - reactions?: components["schemas"]["reaction-rollup"]; - }; + updated_at: string + author_association: components['schemas']['author_association'] + reactions?: components['schemas']['reaction-rollup'] + } /** * Branch Short * @description Branch Short */ - "branch-short": { - name: string; + 'branch-short': { + name: string commit: { - sha: string; - url: string; - }; - protected: boolean; - }; + sha: string + url: string + } + protected: boolean + } /** * Link * @description Hypermedia Link */ link: { - href: string; - }; + href: string + } /** * Auto merge * @description The status of auto merging a pull request. */ auto_merge: { - enabled_by: components["schemas"]["simple-user"]; + enabled_by: components['schemas']['simple-user'] /** * @description The merge method to use. * @enum {string} */ - merge_method: "merge" | "squash" | "rebase"; + merge_method: 'merge' | 'squash' | 'rebase' /** @description Title for the merge commit message. */ - commit_title: string; + commit_title: string /** @description Commit message for the merge commit. */ - commit_message: string; - } | null; + commit_message: string + } | null /** * Pull Request Simple * @description Pull Request Simple */ - "pull-request-simple": { + 'pull-request-simple': { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ - url: string; + url: string /** @example 1 */ - id: number; + id: number /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ - node_id: string; + node_id: string /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347 */ - html_url: string; + html_url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.diff */ - diff_url: string; + diff_url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.patch */ - patch_url: string; + patch_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 */ - issue_url: string; + issue_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits */ - commits_url: string; + commits_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments */ - review_comments_url: string; + review_comments_url: string /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} */ - review_comment_url: string; + review_comment_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347/comments */ - comments_url: string; + comments_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e */ - statuses_url: string; + statuses_url: string /** @example 1347 */ - number: number; + number: number /** @example open */ - state: string; + state: string /** @example true */ - locked: boolean; + locked: boolean /** @example new-feature */ - title: string; - user: components["schemas"]["nullable-simple-user"]; + title: string + user: components['schemas']['nullable-simple-user'] /** @example Please pull these awesome changes */ - body: string | null; + body: string | null labels: { /** Format: int64 */ - id: number; - node_id: string; - url: string; - name: string; - description: string; - color: string; - default: boolean; - }[]; - milestone: components["schemas"]["nullable-milestone"]; + id: number + node_id: string + url: string + name: string + description: string + color: string + default: boolean + }[] + milestone: components['schemas']['nullable-milestone'] /** @example too heated */ - active_lock_reason?: string | null; + active_lock_reason?: string | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - updated_at: string; + updated_at: string /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - closed_at: string | null; + closed_at: string | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - merged_at: string | null; + merged_at: string | null /** @example e5bd3914e2e596debea16f433f57875b5b90bcd6 */ - merge_commit_sha: string | null; - assignee: components["schemas"]["nullable-simple-user"]; - assignees?: components["schemas"]["simple-user"][] | null; - requested_reviewers?: components["schemas"]["simple-user"][] | null; - requested_teams?: components["schemas"]["team"][] | null; + merge_commit_sha: string | null + assignee: components['schemas']['nullable-simple-user'] + assignees?: components['schemas']['simple-user'][] | null + requested_reviewers?: components['schemas']['simple-user'][] | null + requested_teams?: components['schemas']['team'][] | null head: { - label: string; - ref: string; - repo: components["schemas"]["repository"]; - sha: string; - user: components["schemas"]["nullable-simple-user"]; - }; + label: string + ref: string + repo: components['schemas']['repository'] + sha: string + user: components['schemas']['nullable-simple-user'] + } base: { - label: string; - ref: string; - repo: components["schemas"]["repository"]; - sha: string; - user: components["schemas"]["nullable-simple-user"]; - }; + label: string + ref: string + repo: components['schemas']['repository'] + sha: string + user: components['schemas']['nullable-simple-user'] + } _links: { - comments: components["schemas"]["link"]; - commits: components["schemas"]["link"]; - statuses: components["schemas"]["link"]; - html: components["schemas"]["link"]; - issue: components["schemas"]["link"]; - review_comments: components["schemas"]["link"]; - review_comment: components["schemas"]["link"]; - self: components["schemas"]["link"]; - }; - author_association: components["schemas"]["author_association"]; - auto_merge: components["schemas"]["auto_merge"]; + comments: components['schemas']['link'] + commits: components['schemas']['link'] + statuses: components['schemas']['link'] + html: components['schemas']['link'] + issue: components['schemas']['link'] + review_comments: components['schemas']['link'] + review_comment: components['schemas']['link'] + self: components['schemas']['link'] + } + author_association: components['schemas']['author_association'] + auto_merge: components['schemas']['auto_merge'] /** @description Indicates whether or not the pull request is a draft. */ - draft?: boolean; - }; + draft?: boolean + } /** Simple Commit Status */ - "simple-commit-status": { - description: string | null; - id: number; - node_id: string; - state: string; - context: string; + 'simple-commit-status': { + description: string | null + id: number + node_id: string + state: string + context: string /** Format: uri */ - target_url: string; - required?: boolean | null; + target_url: string + required?: boolean | null /** Format: uri */ - avatar_url: string | null; + avatar_url: string | null /** Format: uri */ - url: string; + url: string /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - }; + updated_at: string + } /** * Combined Commit Status * @description Combined Commit Status */ - "combined-commit-status": { - state: string; - statuses: components["schemas"]["simple-commit-status"][]; - sha: string; - total_count: number; - repository: components["schemas"]["minimal-repository"]; + 'combined-commit-status': { + state: string + statuses: components['schemas']['simple-commit-status'][] + sha: string + total_count: number + repository: components['schemas']['minimal-repository'] /** Format: uri */ - commit_url: string; + commit_url: string /** Format: uri */ - url: string; - }; + url: string + } /** * Status * @description The status of a commit. */ status: { - url: string; - avatar_url: string | null; - id: number; - node_id: string; - state: string; - description: string; - target_url: string; - context: string; - created_at: string; - updated_at: string; - creator: components["schemas"]["nullable-simple-user"]; - }; + url: string + avatar_url: string | null + id: number + node_id: string + state: string + description: string + target_url: string + context: string + created_at: string + updated_at: string + creator: components['schemas']['nullable-simple-user'] + } /** * Code Of Conduct Simple * @description Code of Conduct Simple */ - "nullable-code-of-conduct-simple": { + 'nullable-code-of-conduct-simple': { /** * Format: uri * @example https://api.github.com/repos/github/docs/community/code_of_conduct */ - url: string; + url: string /** @example citizen_code_of_conduct */ - key: string; + key: string /** @example Citizen Code of Conduct */ - name: string; + name: string /** * Format: uri * @example https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md */ - html_url: string | null; - } | null; + html_url: string | null + } | null /** Community Health File */ - "nullable-community-health-file": { + 'nullable-community-health-file': { /** Format: uri */ - url: string; + url: string /** Format: uri */ - html_url: string; - } | null; + html_url: string + } | null /** * Community Profile * @description Community Profile */ - "community-profile": { + 'community-profile': { /** @example 100 */ - health_percentage: number; + health_percentage: number /** @example My first repository on GitHub! */ - description: string | null; + description: string | null /** @example example.com */ - documentation: string | null; + documentation: string | null files: { - code_of_conduct: components["schemas"]["nullable-code-of-conduct-simple"]; - code_of_conduct_file: components["schemas"]["nullable-community-health-file"]; - license: components["schemas"]["nullable-license-simple"]; - contributing: components["schemas"]["nullable-community-health-file"]; - readme: components["schemas"]["nullable-community-health-file"]; - issue_template: components["schemas"]["nullable-community-health-file"]; - pull_request_template: components["schemas"]["nullable-community-health-file"]; - }; + code_of_conduct: components['schemas']['nullable-code-of-conduct-simple'] + code_of_conduct_file: components['schemas']['nullable-community-health-file'] + license: components['schemas']['nullable-license-simple'] + contributing: components['schemas']['nullable-community-health-file'] + readme: components['schemas']['nullable-community-health-file'] + issue_template: components['schemas']['nullable-community-health-file'] + pull_request_template: components['schemas']['nullable-community-health-file'] + } /** * Format: date-time * @example 2017-02-28T19:09:29Z */ - updated_at: string | null; + updated_at: string | null /** @example true */ - content_reports_enabled?: boolean; - }; + content_reports_enabled?: boolean + } /** * Commit Comparison * @description Commit Comparison */ - "commit-comparison": { + 'commit-comparison': { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/compare/master...topic */ - url: string; + url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/compare/master...topic */ - html_url: string; + html_url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17 */ - permalink_url: string; + permalink_url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/compare/master...topic.diff */ - diff_url: string; + diff_url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/compare/master...topic.patch */ - patch_url: string; - base_commit: components["schemas"]["commit"]; - merge_base_commit: components["schemas"]["commit"]; + patch_url: string + base_commit: components['schemas']['commit'] + merge_base_commit: components['schemas']['commit'] /** * @example ahead * @enum {string} */ - status: "diverged" | "ahead" | "behind" | "identical"; + status: 'diverged' | 'ahead' | 'behind' | 'identical' /** @example 4 */ - ahead_by: number; + ahead_by: number /** @example 5 */ - behind_by: number; + behind_by: number /** @example 6 */ - total_commits: number; - commits: components["schemas"]["commit"][]; - files?: components["schemas"]["diff-entry"][]; - }; + total_commits: number + commits: components['schemas']['commit'][] + files?: components['schemas']['diff-entry'][] + } /** * Content Tree * @description Content Tree */ - "content-tree": { - type: string; - size: number; - name: string; - path: string; - sha: string; + 'content-tree': { + type: string + size: number + name: string + path: string + sha: string /** Format: uri */ - url: string; + url: string /** Format: uri */ - git_url: string | null; + git_url: string | null /** Format: uri */ - html_url: string | null; + html_url: string | null /** Format: uri */ - download_url: string | null; + download_url: string | null entries?: { - type: string; - size: number; - name: string; - path: string; - content?: string; - sha: string; + type: string + size: number + name: string + path: string + content?: string + sha: string /** Format: uri */ - url: string; + url: string /** Format: uri */ - git_url: string | null; + git_url: string | null /** Format: uri */ - html_url: string | null; + html_url: string | null /** Format: uri */ - download_url: string | null; + download_url: string | null _links: { /** Format: uri */ - git: string | null; + git: string | null /** Format: uri */ - html: string | null; + html: string | null /** Format: uri */ - self: string; - }; - }[]; + self: string + } + }[] _links: { /** Format: uri */ - git: string | null; + git: string | null /** Format: uri */ - html: string | null; + html: string | null /** Format: uri */ - self: string; - }; + self: string + } } & { - content: unknown; - encoding: unknown; - }; + content: unknown + encoding: unknown + } /** * Content Directory * @description A list of directory items */ - "content-directory": { - type: string; - size: number; - name: string; - path: string; - content?: string; - sha: string; + 'content-directory': { + type: string + size: number + name: string + path: string + content?: string + sha: string /** Format: uri */ - url: string; + url: string /** Format: uri */ - git_url: string | null; + git_url: string | null /** Format: uri */ - html_url: string | null; + html_url: string | null /** Format: uri */ - download_url: string | null; + download_url: string | null _links: { /** Format: uri */ - git: string | null; + git: string | null /** Format: uri */ - html: string | null; + html: string | null /** Format: uri */ - self: string; - }; - }[]; + self: string + } + }[] /** * Content File * @description Content File */ - "content-file": { - type: string; - encoding: string; - size: number; - name: string; - path: string; - content: string; - sha: string; + 'content-file': { + type: string + encoding: string + size: number + name: string + path: string + content: string + sha: string /** Format: uri */ - url: string; + url: string /** Format: uri */ - git_url: string | null; + git_url: string | null /** Format: uri */ - html_url: string | null; + html_url: string | null /** Format: uri */ - download_url: string | null; + download_url: string | null _links: { /** Format: uri */ - git: string | null; + git: string | null /** Format: uri */ - html: string | null; + html: string | null /** Format: uri */ - self: string; - }; + self: string + } /** @example "actual/actual.md" */ - target?: string; + target?: string /** @example "git://example.com/defunkt/dotjs.git" */ - submodule_git_url?: string; - }; + submodule_git_url?: string + } /** * Symlink Content * @description An object describing a symlink */ - "content-symlink": { - type: string; - target: string; - size: number; - name: string; - path: string; - sha: string; + 'content-symlink': { + type: string + target: string + size: number + name: string + path: string + sha: string /** Format: uri */ - url: string; + url: string /** Format: uri */ - git_url: string | null; + git_url: string | null /** Format: uri */ - html_url: string | null; + html_url: string | null /** Format: uri */ - download_url: string | null; + download_url: string | null _links: { /** Format: uri */ - git: string | null; + git: string | null /** Format: uri */ - html: string | null; + html: string | null /** Format: uri */ - self: string; - }; - }; + self: string + } + } /** * Symlink Content * @description An object describing a symlink */ - "content-submodule": { - type: string; + 'content-submodule': { + type: string /** Format: uri */ - submodule_git_url: string; - size: number; - name: string; - path: string; - sha: string; + submodule_git_url: string + size: number + name: string + path: string + sha: string /** Format: uri */ - url: string; + url: string /** Format: uri */ - git_url: string | null; + git_url: string | null /** Format: uri */ - html_url: string | null; + html_url: string | null /** Format: uri */ - download_url: string | null; + download_url: string | null _links: { /** Format: uri */ - git: string | null; + git: string | null /** Format: uri */ - html: string | null; + html: string | null /** Format: uri */ - self: string; - }; - }; + self: string + } + } /** * File Commit * @description File Commit */ - "file-commit": { + 'file-commit': { content: { - name?: string; - path?: string; - sha?: string; - size?: number; - url?: string; - html_url?: string; - git_url?: string; - download_url?: string; - type?: string; + name?: string + path?: string + sha?: string + size?: number + url?: string + html_url?: string + git_url?: string + download_url?: string + type?: string _links?: { - self?: string; - git?: string; - html?: string; - }; - } | null; + self?: string + git?: string + html?: string + } + } | null commit: { - sha?: string; - node_id?: string; - url?: string; - html_url?: string; + sha?: string + node_id?: string + url?: string + html_url?: string author?: { - date?: string; - name?: string; - email?: string; - }; + date?: string + name?: string + email?: string + } committer?: { - date?: string; - name?: string; - email?: string; - }; - message?: string; + date?: string + name?: string + email?: string + } + message?: string tree?: { - url?: string; - sha?: string; - }; + url?: string + sha?: string + } parents?: { - url?: string; - html_url?: string; - sha?: string; - }[]; + url?: string + html_url?: string + sha?: string + }[] verification?: { - verified?: boolean; - reason?: string; - signature?: string | null; - payload?: string | null; - }; - }; - }; + verified?: boolean + reason?: string + signature?: string | null + payload?: string | null + } + } + } /** * Contributor * @description Contributor */ contributor: { - login?: string; - id?: number; - node_id?: string; + login?: string + id?: number + node_id?: string /** Format: uri */ - avatar_url?: string; - gravatar_id?: string | null; + avatar_url?: string + gravatar_id?: string | null /** Format: uri */ - url?: string; + url?: string /** Format: uri */ - html_url?: string; + html_url?: string /** Format: uri */ - followers_url?: string; - following_url?: string; - gists_url?: string; - starred_url?: string; + followers_url?: string + following_url?: string + gists_url?: string + starred_url?: string /** Format: uri */ - subscriptions_url?: string; + subscriptions_url?: string /** Format: uri */ - organizations_url?: string; + organizations_url?: string /** Format: uri */ - repos_url?: string; - events_url?: string; + repos_url?: string + events_url?: string /** Format: uri */ - received_events_url?: string; - type: string; - site_admin?: boolean; - contributions: number; - email?: string; - name?: string; - }; + received_events_url?: string + type: string + site_admin?: boolean + contributions: number + email?: string + name?: string + } /** * Dependabot Secret * @description Set secrets for Dependabot. */ - "dependabot-secret": { + 'dependabot-secret': { /** * @description The name of the secret. * @example MY_ARTIFACTORY_PASSWORD */ - name: string; + name: string /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - }; + updated_at: string + } /** * Deployment Status * @description The status of a deployment. */ - "deployment-status": { + 'deployment-status': { /** * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/42/statuses/1 */ - url: string; + url: string /** @example 1 */ - id: number; + id: number /** @example MDE2OkRlcGxveW1lbnRTdGF0dXMx */ - node_id: string; + node_id: string /** * @description The state of the status. * @example success * @enum {string} */ - state: "error" | "failure" | "inactive" | "pending" | "success" | "queued" | "in_progress"; - creator: components["schemas"]["nullable-simple-user"]; + state: 'error' | 'failure' | 'inactive' | 'pending' | 'success' | 'queued' | 'in_progress' + creator: components['schemas']['nullable-simple-user'] /** * @description A short description of the status. * @example Deployment finished successfully. */ - description: string; + description: string /** * @description The environment of the deployment that the status is for. * @example production */ - environment?: string; + environment?: string /** * Format: uri * @description Deprecated: the URL to associate with this status. * @example https://example.com/deployment/42/output */ - target_url: string; + target_url: string /** * Format: date-time * @example 2012-07-20T01:19:13Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2012-07-20T01:19:13Z */ - updated_at: string; + updated_at: string /** * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/42 */ - deployment_url: string; + deployment_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/example */ - repository_url: string; + repository_url: string /** * Format: uri * @description The URL for accessing your environment. * @example https://staging.example.com/ */ - environment_url?: string; + environment_url?: string /** * Format: uri * @description The URL to associate with this status. * @example https://example.com/deployment/42/output */ - log_url?: string; - performed_via_github_app?: components["schemas"]["nullable-integration"]; - }; + log_url?: string + performed_via_github_app?: components['schemas']['nullable-integration'] + } /** * @description The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days). * @example 30 */ - "wait-timer": number; + 'wait-timer': number /** @description The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. */ deployment_branch_policy: { /** @description Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`. */ - protected_branches: boolean; + protected_branches: boolean /** @description Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`. */ - custom_branch_policies: boolean; - } | null; + custom_branch_policies: boolean + } | null /** * Environment * @description Details of a deployment environment @@ -13802,97 +13790,97 @@ export interface components { * @description The id of the environment. * @example 56780428 */ - id: number; + id: number /** @example MDExOkVudmlyb25tZW50NTY3ODA0Mjg= */ - node_id: string; + node_id: string /** * @description The name of the environment. * @example staging */ - name: string; + name: string /** @example https://api.github.com/repos/github/hello-world/environments/staging */ - url: string; + url: string /** @example https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging */ - html_url: string; + html_url: string /** * Format: date-time * @description The time that the environment was created, in ISO 8601 format. * @example 2020-11-23T22:00:40Z */ - created_at: string; + created_at: string /** * Format: date-time * @description The time that the environment was last updated, in ISO 8601 format. * @example 2020-11-23T22:00:40Z */ - updated_at: string; + updated_at: string protection_rules?: (Partial<{ /** @example 3515 */ - id: number; + id: number /** @example MDQ6R2F0ZTM1MTU= */ - node_id: string; + node_id: string /** @example wait_timer */ - type: string; - wait_timer?: components["schemas"]["wait-timer"]; + type: string + wait_timer?: components['schemas']['wait-timer'] }> & Partial<{ /** @example 3755 */ - id: number; + id: number /** @example MDQ6R2F0ZTM3NTU= */ - node_id: string; + node_id: string /** @example required_reviewers */ - type: string; + type: string /** @description The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */ reviewers?: { - type?: components["schemas"]["deployment-reviewer-type"]; - reviewer?: Partial & Partial; - }[]; + type?: components['schemas']['deployment-reviewer-type'] + reviewer?: Partial & Partial + }[] }> & Partial<{ /** @example 3515 */ - id: number; + id: number /** @example MDQ6R2F0ZTM1MTU= */ - node_id: string; + node_id: string /** @example branch_policy */ - type: string; - }>)[]; - deployment_branch_policy?: components["schemas"]["deployment_branch_policy"]; - }; + type: string + }>)[] + deployment_branch_policy?: components['schemas']['deployment_branch_policy'] + } /** * Short Blob * @description Short Blob */ - "short-blob": { - url: string; - sha: string; - }; + 'short-blob': { + url: string + sha: string + } /** * Blob * @description Blob */ blob: { - content: string; - encoding: string; + content: string + encoding: string /** Format: uri */ - url: string; - sha: string; - size: number | null; - node_id: string; - highlighted_content?: string; - }; + url: string + sha: string + size: number | null + node_id: string + highlighted_content?: string + } /** * Git Commit * @description Low-level Git commit operations within a repository */ - "git-commit": { + 'git-commit': { /** * @description SHA for the commit * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - sha: string; - node_id: string; + sha: string + node_id: string /** Format: uri */ - url: string; + url: string /** @description Identifying information for the git-user */ author: { /** @@ -13900,18 +13888,18 @@ export interface components { * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 */ - date: string; + date: string /** * @description Git email address of the user * @example monalisa.octocat@example.com */ - email: string; + email: string /** * @description Name of the git user * @example Monalisa Octocat */ - name: string; - }; + name: string + } /** @description Identifying information for the git-user */ committer: { /** @@ -13919,343 +13907,343 @@ export interface components { * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 */ - date: string; + date: string /** * @description Git email address of the user * @example monalisa.octocat@example.com */ - email: string; + email: string /** * @description Name of the git user * @example Monalisa Octocat */ - name: string; - }; + name: string + } /** * @description Message describing the purpose of the commit * @example Fix #42 */ - message: string; + message: string tree: { /** * @description SHA for the commit * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - sha: string; + sha: string /** Format: uri */ - url: string; - }; + url: string + } parents: { /** * @description SHA for the commit * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - sha: string; + sha: string /** Format: uri */ - url: string; + url: string /** Format: uri */ - html_url: string; - }[]; + html_url: string + }[] verification: { - verified: boolean; - reason: string; - signature: string | null; - payload: string | null; - }; + verified: boolean + reason: string + signature: string | null + payload: string | null + } /** Format: uri */ - html_url: string; - }; + html_url: string + } /** * Git Reference * @description Git references within a repository */ - "git-ref": { - ref: string; - node_id: string; + 'git-ref': { + ref: string + node_id: string /** Format: uri */ - url: string; + url: string object: { - type: string; + type: string /** * @description SHA for the reference * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - sha: string; + sha: string /** Format: uri */ - url: string; - }; - }; + url: string + } + } /** * Git Tag * @description Metadata for a Git tag */ - "git-tag": { + 'git-tag': { /** @example MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== */ - node_id: string; + node_id: string /** * @description Name of the tag * @example v0.0.1 */ - tag: string; + tag: string /** @example 940bd336248efae0f9ee5bc7b2d5c985887b16ac */ - sha: string; + sha: string /** * Format: uri * @description URL for the tag * @example https://api.github.com/repositories/42/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac */ - url: string; + url: string /** * @description Message describing the purpose of the tag * @example Initial public release */ - message: string; + message: string tagger: { - date: string; - email: string; - name: string; - }; + date: string + email: string + name: string + } object: { - sha: string; - type: string; + sha: string + type: string /** Format: uri */ - url: string; - }; - verification?: components["schemas"]["verification"]; - }; + url: string + } + verification?: components['schemas']['verification'] + } /** * Git Tree * @description The hierarchy between files in a Git repository. */ - "git-tree": { - sha: string; + 'git-tree': { + sha: string /** Format: uri */ - url: string; - truncated: boolean; + url: string + truncated: boolean /** * @description Objects specifying a tree structure * @example [object Object] */ tree: { /** @example test/file.rb */ - path?: string; + path?: string /** @example 040000 */ - mode?: string; + mode?: string /** @example tree */ - type?: string; + type?: string /** @example 23f6827669e43831def8a7ad935069c8bd418261 */ - sha?: string; + sha?: string /** @example 12 */ - size?: number; + size?: number /** @example https://api.github.com/repos/owner-482f3203ecf01f67e9deb18e/BBB_Private_Repo/git/blobs/23f6827669e43831def8a7ad935069c8bd418261 */ - url?: string; - }[]; - }; + url?: string + }[] + } /** Hook Response */ - "hook-response": { - code: number | null; - status: string | null; - message: string | null; - }; + 'hook-response': { + code: number | null + status: string | null + message: string | null + } /** * Webhook * @description Webhooks for repositories. */ hook: { - type: string; + type: string /** * @description Unique identifier of the webhook. * @example 42 */ - id: number; + id: number /** * @description The name of a valid service, use 'web' for a webhook. * @example web */ - name: string; + name: string /** * @description Determines whether the hook is actually triggered on pushes. * @example true */ - active: boolean; + active: boolean /** * @description Determines what events the hook is triggered for. Default: ['push']. * @example push,pull_request */ - events: string[]; + events: string[] config: { /** @example "foo@bar.com" */ - email?: string; + email?: string /** @example "foo" */ - password?: string; + password?: string /** @example "roomer" */ - room?: string; + room?: string /** @example "foo" */ - subdomain?: string; - url?: components["schemas"]["webhook-config-url"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - content_type?: components["schemas"]["webhook-config-content-type"]; + subdomain?: string + url?: components['schemas']['webhook-config-url'] + insecure_ssl?: components['schemas']['webhook-config-insecure-ssl'] + content_type?: components['schemas']['webhook-config-content-type'] /** @example "sha256" */ - digest?: string; - secret?: components["schemas"]["webhook-config-secret"]; + digest?: string + secret?: components['schemas']['webhook-config-secret'] /** @example "abc" */ - token?: string; - }; + token?: string + } /** * Format: date-time * @example 2011-09-06T20:39:23Z */ - updated_at: string; + updated_at: string /** * Format: date-time * @example 2011-09-06T17:26:27Z */ - created_at: string; + created_at: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1 */ - url: string; + url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/test */ - test_url: string; + test_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/pings */ - ping_url: string; + ping_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries */ - deliveries_url?: string; - last_response: components["schemas"]["hook-response"]; - }; + deliveries_url?: string + last_response: components['schemas']['hook-response'] + } /** * Import * @description A repository import from an external source. */ import: { - vcs: string | null; - use_lfs?: boolean; + vcs: string | null + use_lfs?: boolean /** @description The URL of the originating repository. */ - vcs_url: string; - svc_root?: string; - tfvc_project?: string; + vcs_url: string + svc_root?: string + tfvc_project?: string /** @enum {string} */ status: - | "auth" - | "error" - | "none" - | "detecting" - | "choose" - | "auth_failed" - | "importing" - | "mapping" - | "waiting_to_push" - | "pushing" - | "complete" - | "setup" - | "unknown" - | "detection_found_multiple" - | "detection_found_nothing" - | "detection_needs_auth"; - status_text?: string | null; - failed_step?: string | null; - error_message?: string | null; - import_percent?: number | null; - commit_count?: number | null; - push_percent?: number | null; - has_large_files?: boolean; - large_files_size?: number; - large_files_count?: number; + | 'auth' + | 'error' + | 'none' + | 'detecting' + | 'choose' + | 'auth_failed' + | 'importing' + | 'mapping' + | 'waiting_to_push' + | 'pushing' + | 'complete' + | 'setup' + | 'unknown' + | 'detection_found_multiple' + | 'detection_found_nothing' + | 'detection_needs_auth' + status_text?: string | null + failed_step?: string | null + error_message?: string | null + import_percent?: number | null + commit_count?: number | null + push_percent?: number | null + has_large_files?: boolean + large_files_size?: number + large_files_count?: number project_choices?: { - vcs?: string; - tfvc_project?: string; - human_name?: string; - }[]; - message?: string; - authors_count?: number | null; + vcs?: string + tfvc_project?: string + human_name?: string + }[] + message?: string + authors_count?: number | null /** Format: uri */ - url: string; + url: string /** Format: uri */ - html_url: string; + html_url: string /** Format: uri */ - authors_url: string; + authors_url: string /** Format: uri */ - repository_url: string; - svn_root?: string; - }; + repository_url: string + svn_root?: string + } /** * Porter Author * @description Porter Author */ - "porter-author": { - id: number; - remote_id: string; - remote_name: string; - email: string; - name: string; + 'porter-author': { + id: number + remote_id: string + remote_name: string + email: string + name: string /** Format: uri */ - url: string; + url: string /** Format: uri */ - import_url: string; - }; + import_url: string + } /** * Porter Large File * @description Porter Large File */ - "porter-large-file": { - ref_name: string; - path: string; - oid: string; - size: number; - }; + 'porter-large-file': { + ref_name: string + path: string + oid: string + size: number + } /** * Issue * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. */ - "nullable-issue": { - id: number; - node_id: string; + 'nullable-issue': { + id: number + node_id: string /** * Format: uri * @description URL for the issue * @example https://api.github.com/repositories/42/issues/1 */ - url: string; + url: string /** Format: uri */ - repository_url: string; - labels_url: string; + repository_url: string + labels_url: string /** Format: uri */ - comments_url: string; + comments_url: string /** Format: uri */ - events_url: string; + events_url: string /** Format: uri */ - html_url: string; + html_url: string /** * @description Number uniquely identifying the issue within its repository * @example 42 */ - number: number; + number: number /** * @description State of the issue; either 'open' or 'closed' * @example open */ - state: string; + state: string /** * @description Title of the issue * @example Widget creation fails in Safari on OS X 10.8 */ - title: string; + title: string /** * @description Contents of the issue * @example It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug? */ - body?: string | null; - user: components["schemas"]["nullable-simple-user"]; + body?: string | null + user: components['schemas']['nullable-simple-user'] /** * @description Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository * @example bug,registration @@ -14264,456 +14252,456 @@ export interface components { | string | { /** Format: int64 */ - id?: number; - node_id?: string; + id?: number + node_id?: string /** Format: uri */ - url?: string; - name?: string; - description?: string | null; - color?: string | null; - default?: boolean; + url?: string + name?: string + description?: string | null + color?: string | null + default?: boolean } - )[]; - assignee: components["schemas"]["nullable-simple-user"]; - assignees?: components["schemas"]["simple-user"][] | null; - milestone: components["schemas"]["nullable-milestone"]; - locked: boolean; - active_lock_reason?: string | null; - comments: number; + )[] + assignee: components['schemas']['nullable-simple-user'] + assignees?: components['schemas']['simple-user'][] | null + milestone: components['schemas']['nullable-milestone'] + locked: boolean + active_lock_reason?: string | null + comments: number pull_request?: { /** Format: date-time */ - merged_at?: string | null; + merged_at?: string | null /** Format: uri */ - diff_url: string | null; + diff_url: string | null /** Format: uri */ - html_url: string | null; + html_url: string | null /** Format: uri */ - patch_url: string | null; + patch_url: string | null /** Format: uri */ - url: string | null; - }; + url: string | null + } /** Format: date-time */ - closed_at: string | null; + closed_at: string | null /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - draft?: boolean; - closed_by?: components["schemas"]["nullable-simple-user"]; - body_html?: string; - body_text?: string; + updated_at: string + draft?: boolean + closed_by?: components['schemas']['nullable-simple-user'] + body_html?: string + body_text?: string /** Format: uri */ - timeline_url?: string; - repository?: components["schemas"]["repository"]; - performed_via_github_app?: components["schemas"]["nullable-integration"]; - author_association: components["schemas"]["author_association"]; - reactions?: components["schemas"]["reaction-rollup"]; - } | null; + timeline_url?: string + repository?: components['schemas']['repository'] + performed_via_github_app?: components['schemas']['nullable-integration'] + author_association: components['schemas']['author_association'] + reactions?: components['schemas']['reaction-rollup'] + } | null /** * Issue Event Label * @description Issue Event Label */ - "issue-event-label": { - name: string | null; - color: string | null; - }; + 'issue-event-label': { + name: string | null + color: string | null + } /** Issue Event Dismissed Review */ - "issue-event-dismissed-review": { - state: string; - review_id: number; - dismissal_message: string | null; - dismissal_commit_id?: string | null; - }; + 'issue-event-dismissed-review': { + state: string + review_id: number + dismissal_message: string | null + dismissal_commit_id?: string | null + } /** * Issue Event Milestone * @description Issue Event Milestone */ - "issue-event-milestone": { - title: string; - }; + 'issue-event-milestone': { + title: string + } /** * Issue Event Project Card * @description Issue Event Project Card */ - "issue-event-project-card": { + 'issue-event-project-card': { /** Format: uri */ - url: string; - id: number; + url: string + id: number /** Format: uri */ - project_url: string; - project_id: number; - column_name: string; - previous_column_name?: string; - }; + project_url: string + project_id: number + column_name: string + previous_column_name?: string + } /** * Issue Event Rename * @description Issue Event Rename */ - "issue-event-rename": { - from: string; - to: string; - }; + 'issue-event-rename': { + from: string + to: string + } /** * Issue Event * @description Issue Event */ - "issue-event": { + 'issue-event': { /** @example 1 */ - id: number; + id: number /** @example MDEwOklzc3VlRXZlbnQx */ - node_id: string; + node_id: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/events/1 */ - url: string; - actor: components["schemas"]["nullable-simple-user"]; + url: string + actor: components['schemas']['nullable-simple-user'] /** @example closed */ - event: string; + event: string /** @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */ - commit_id: string | null; + commit_id: string | null /** @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e */ - commit_url: string | null; + commit_url: string | null /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - created_at: string; - issue?: components["schemas"]["nullable-issue"]; - label?: components["schemas"]["issue-event-label"]; - assignee?: components["schemas"]["nullable-simple-user"]; - assigner?: components["schemas"]["nullable-simple-user"]; - review_requester?: components["schemas"]["nullable-simple-user"]; - requested_reviewer?: components["schemas"]["nullable-simple-user"]; - requested_team?: components["schemas"]["team"]; - dismissed_review?: components["schemas"]["issue-event-dismissed-review"]; - milestone?: components["schemas"]["issue-event-milestone"]; - project_card?: components["schemas"]["issue-event-project-card"]; - rename?: components["schemas"]["issue-event-rename"]; - author_association?: components["schemas"]["author_association"]; - lock_reason?: string | null; - performed_via_github_app?: components["schemas"]["nullable-integration"]; - }; + created_at: string + issue?: components['schemas']['nullable-issue'] + label?: components['schemas']['issue-event-label'] + assignee?: components['schemas']['nullable-simple-user'] + assigner?: components['schemas']['nullable-simple-user'] + review_requester?: components['schemas']['nullable-simple-user'] + requested_reviewer?: components['schemas']['nullable-simple-user'] + requested_team?: components['schemas']['team'] + dismissed_review?: components['schemas']['issue-event-dismissed-review'] + milestone?: components['schemas']['issue-event-milestone'] + project_card?: components['schemas']['issue-event-project-card'] + rename?: components['schemas']['issue-event-rename'] + author_association?: components['schemas']['author_association'] + lock_reason?: string | null + performed_via_github_app?: components['schemas']['nullable-integration'] + } /** * Labeled Issue Event * @description Labeled Issue Event */ - "labeled-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; + 'labeled-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] label: { - name: string; - color: string; - }; - }; + name: string + color: string + } + } /** * Unlabeled Issue Event * @description Unlabeled Issue Event */ - "unlabeled-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; + 'unlabeled-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] label: { - name: string; - color: string; - }; - }; + name: string + color: string + } + } /** * Assigned Issue Event * @description Assigned Issue Event */ - "assigned-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["integration"]; - assignee: components["schemas"]["simple-user"]; - assigner: components["schemas"]["simple-user"]; - }; + 'assigned-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['integration'] + assignee: components['schemas']['simple-user'] + assigner: components['schemas']['simple-user'] + } /** * Unassigned Issue Event * @description Unassigned Issue Event */ - "unassigned-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; - assignee: components["schemas"]["simple-user"]; - assigner: components["schemas"]["simple-user"]; - }; + 'unassigned-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] + assignee: components['schemas']['simple-user'] + assigner: components['schemas']['simple-user'] + } /** * Milestoned Issue Event * @description Milestoned Issue Event */ - "milestoned-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; + 'milestoned-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] milestone: { - title: string; - }; - }; + title: string + } + } /** * Demilestoned Issue Event * @description Demilestoned Issue Event */ - "demilestoned-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; + 'demilestoned-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] milestone: { - title: string; - }; - }; + title: string + } + } /** * Renamed Issue Event * @description Renamed Issue Event */ - "renamed-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; + 'renamed-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] rename: { - from: string; - to: string; - }; - }; + from: string + to: string + } + } /** * Review Requested Issue Event * @description Review Requested Issue Event */ - "review-requested-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; - review_requester: components["schemas"]["simple-user"]; - requested_team?: components["schemas"]["team"]; - requested_reviewer?: components["schemas"]["simple-user"]; - }; + 'review-requested-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] + review_requester: components['schemas']['simple-user'] + requested_team?: components['schemas']['team'] + requested_reviewer?: components['schemas']['simple-user'] + } /** * Review Request Removed Issue Event * @description Review Request Removed Issue Event */ - "review-request-removed-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; - review_requester: components["schemas"]["simple-user"]; - requested_team?: components["schemas"]["team"]; - requested_reviewer?: components["schemas"]["simple-user"]; - }; + 'review-request-removed-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] + review_requester: components['schemas']['simple-user'] + requested_team?: components['schemas']['team'] + requested_reviewer?: components['schemas']['simple-user'] + } /** * Review Dismissed Issue Event * @description Review Dismissed Issue Event */ - "review-dismissed-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; + 'review-dismissed-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] dismissed_review: { - state: string; - review_id: number; - dismissal_message: string | null; - dismissal_commit_id?: string; - }; - }; + state: string + review_id: number + dismissal_message: string | null + dismissal_commit_id?: string + } + } /** * Locked Issue Event * @description Locked Issue Event */ - "locked-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; + 'locked-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] /** @example "off-topic" */ - lock_reason: string | null; - }; + lock_reason: string | null + } /** * Added to Project Issue Event * @description Added to Project Issue Event */ - "added-to-project-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; + 'added-to-project-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] project_card?: { - id: number; + id: number /** Format: uri */ - url: string; - project_id: number; + url: string + project_id: number /** Format: uri */ - project_url: string; - column_name: string; - previous_column_name?: string; - }; - }; + project_url: string + column_name: string + previous_column_name?: string + } + } /** * Moved Column in Project Issue Event * @description Moved Column in Project Issue Event */ - "moved-column-in-project-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; + 'moved-column-in-project-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] project_card?: { - id: number; + id: number /** Format: uri */ - url: string; - project_id: number; + url: string + project_id: number /** Format: uri */ - project_url: string; - column_name: string; - previous_column_name?: string; - }; - }; + project_url: string + column_name: string + previous_column_name?: string + } + } /** * Removed from Project Issue Event * @description Removed from Project Issue Event */ - "removed-from-project-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; + 'removed-from-project-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] project_card?: { - id: number; + id: number /** Format: uri */ - url: string; - project_id: number; + url: string + project_id: number /** Format: uri */ - project_url: string; - column_name: string; - previous_column_name?: string; - }; - }; + project_url: string + column_name: string + previous_column_name?: string + } + } /** * Converted Note to Issue Issue Event * @description Converted Note to Issue Issue Event */ - "converted-note-to-issue-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["integration"]; + 'converted-note-to-issue-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['integration'] project_card?: { - id: number; + id: number /** Format: uri */ - url: string; - project_id: number; + url: string + project_id: number /** Format: uri */ - project_url: string; - column_name: string; - previous_column_name?: string; - }; - }; + project_url: string + column_name: string + previous_column_name?: string + } + } /** * Issue Event for Issue * @description Issue Event for Issue */ - "issue-event-for-issue": Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial; + 'issue-event-for-issue': Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial /** * Label * @description Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -14723,105 +14711,105 @@ export interface components { * Format: int64 * @example 208045946 */ - id: number; + id: number /** @example MDU6TGFiZWwyMDgwNDU5NDY= */ - node_id: string; + node_id: string /** * Format: uri * @description URL for the label * @example https://api.github.com/repositories/42/labels/bug */ - url: string; + url: string /** * @description The name of the label. * @example bug */ - name: string; + name: string /** @example Something isn't working */ - description: string | null; + description: string | null /** * @description 6-character hex code, without the leading #, identifying the color * @example FFFFFF */ - color: string; + color: string /** @example true */ - default: boolean; - }; + default: boolean + } /** * Timeline Comment Event * @description Timeline Comment Event */ - "timeline-comment-event": { - event: string; - actor: components["schemas"]["simple-user"]; + 'timeline-comment-event': { + event: string + actor: components['schemas']['simple-user'] /** * @description Unique identifier of the issue comment * @example 42 */ - id: number; - node_id: string; + id: number + node_id: string /** * Format: uri * @description URL for the issue comment * @example https://api.github.com/repositories/42/issues/comments/1 */ - url: string; + url: string /** * @description Contents of the issue comment * @example What version of Safari were you using when you observed this bug? */ - body?: string; - body_text?: string; - body_html?: string; + body?: string + body_text?: string + body_html?: string /** Format: uri */ - html_url: string; - user: components["schemas"]["simple-user"]; + html_url: string + user: components['schemas']['simple-user'] /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - updated_at: string; + updated_at: string /** Format: uri */ - issue_url: string; - author_association: components["schemas"]["author_association"]; - performed_via_github_app?: components["schemas"]["nullable-integration"]; - reactions?: components["schemas"]["reaction-rollup"]; - }; + issue_url: string + author_association: components['schemas']['author_association'] + performed_via_github_app?: components['schemas']['nullable-integration'] + reactions?: components['schemas']['reaction-rollup'] + } /** * Timeline Cross Referenced Event * @description Timeline Cross Referenced Event */ - "timeline-cross-referenced-event": { - event: string; - actor?: components["schemas"]["simple-user"]; + 'timeline-cross-referenced-event': { + event: string + actor?: components['schemas']['simple-user'] /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; + updated_at: string source: { - type?: string; - issue?: components["schemas"]["issue"]; - }; - }; + type?: string + issue?: components['schemas']['issue'] + } + } /** * Timeline Committed Event * @description Timeline Committed Event */ - "timeline-committed-event": { - event?: string; + 'timeline-committed-event': { + event?: string /** * @description SHA for the commit * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - sha: string; - node_id: string; + sha: string + node_id: string /** Format: uri */ - url: string; + url: string /** @description Identifying information for the git-user */ author: { /** @@ -14829,18 +14817,18 @@ export interface components { * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 */ - date: string; + date: string /** * @description Git email address of the user * @example monalisa.octocat@example.com */ - email: string; + email: string /** * @description Name of the git user * @example Monalisa Octocat */ - name: string; - }; + name: string + } /** @description Identifying information for the git-user */ committer: { /** @@ -14848,386 +14836,386 @@ export interface components { * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 */ - date: string; + date: string /** * @description Git email address of the user * @example monalisa.octocat@example.com */ - email: string; + email: string /** * @description Name of the git user * @example Monalisa Octocat */ - name: string; - }; + name: string + } /** * @description Message describing the purpose of the commit * @example Fix #42 */ - message: string; + message: string tree: { /** * @description SHA for the commit * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - sha: string; + sha: string /** Format: uri */ - url: string; - }; + url: string + } parents: { /** * @description SHA for the commit * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - sha: string; + sha: string /** Format: uri */ - url: string; + url: string /** Format: uri */ - html_url: string; - }[]; + html_url: string + }[] verification: { - verified: boolean; - reason: string; - signature: string | null; - payload: string | null; - }; + verified: boolean + reason: string + signature: string | null + payload: string | null + } /** Format: uri */ - html_url: string; - }; + html_url: string + } /** * Timeline Reviewed Event * @description Timeline Reviewed Event */ - "timeline-reviewed-event": { - event: string; + 'timeline-reviewed-event': { + event: string /** * @description Unique identifier of the review * @example 42 */ - id: number; + id: number /** @example MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= */ - node_id: string; - user: components["schemas"]["simple-user"]; + node_id: string + user: components['schemas']['simple-user'] /** * @description The text of the review. * @example This looks great. */ - body: string | null; + body: string | null /** @example CHANGES_REQUESTED */ - state: string; + state: string /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/12 */ - pull_request_url: string; + pull_request_url: string _links: { html: { - href: string; - }; + href: string + } pull_request: { - href: string; - }; - }; + href: string + } + } /** Format: date-time */ - submitted_at?: string; + submitted_at?: string /** * @description A commit SHA for the review. * @example 54bb654c9e6025347f57900a4a5c2313a96b8035 */ - commit_id: string; - body_html?: string; - body_text?: string; - author_association: components["schemas"]["author_association"]; - }; + commit_id: string + body_html?: string + body_text?: string + author_association: components['schemas']['author_association'] + } /** * Pull Request Review Comment * @description Pull Request Review Comments are comments on a portion of the Pull Request's diff. */ - "pull-request-review-comment": { + 'pull-request-review-comment': { /** * @description URL for the pull request review comment * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ - url: string; + url: string /** * @description The ID of the pull request review to which the comment belongs. * @example 42 */ - pull_request_review_id: number | null; + pull_request_review_id: number | null /** * @description The ID of the pull request review comment. * @example 1 */ - id: number; + id: number /** * @description The node ID of the pull request review comment. * @example MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw */ - node_id: string; + node_id: string /** * @description The diff of the line that the comment refers to. * @example @@ -16,33 +16,40 @@ public class Connection : IConnection... */ - diff_hunk: string; + diff_hunk: string /** * @description The relative path of the file to which the comment applies. * @example config/database.yaml */ - path: string; + path: string /** * @description The line index in the diff to which the comment applies. * @example 1 */ - position: number; + position: number /** * @description The index of the original line in the diff to which the comment applies. * @example 4 */ - original_position: number; + original_position: number /** * @description The SHA of the commit to which the comment applies. * @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */ - commit_id: string; + commit_id: string /** * @description The SHA of the original commit to which the comment applies. * @example 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 */ - original_commit_id: string; + original_commit_id: string /** * @description The comment ID to reply to. * @example 8 */ - in_reply_to_id?: number; - user: components["schemas"]["simple-user"]; + in_reply_to_id?: number + user: components['schemas']['simple-user'] /** * @description The text of the comment. * @example We should probably include a check for null values here. */ - body: string; + body: string /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - updated_at: string; + updated_at: string /** * Format: uri * @description HTML URL for the pull request review comment. * @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 */ - html_url: string; + html_url: string /** * Format: uri * @description URL for the pull request that the review comment belongs to. * @example https://api.github.com/repos/octocat/Hello-World/pulls/1 */ - pull_request_url: string; - author_association: components["schemas"]["author_association"]; + pull_request_url: string + author_association: components['schemas']['author_association'] _links: { self: { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ - href: string; - }; + href: string + } html: { /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 */ - href: string; - }; + href: string + } pull_request: { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1 */ - href: string; - }; - }; + href: string + } + } /** * @description The first line of the range for a multi-line comment. * @example 2 */ - start_line?: number | null; + start_line?: number | null /** * @description The first line of the range for a multi-line comment. * @example 2 */ - original_start_line?: number | null; + original_start_line?: number | null /** * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} */ - start_side?: ("LEFT" | "RIGHT") | null; + start_side?: ('LEFT' | 'RIGHT') | null /** * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment * @example 2 */ - line?: number; + line?: number /** * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment * @example 2 */ - original_line?: number; + original_line?: number /** * @description The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment * @default RIGHT * @enum {string} */ - side?: "LEFT" | "RIGHT"; - reactions?: components["schemas"]["reaction-rollup"]; + side?: 'LEFT' | 'RIGHT' + reactions?: components['schemas']['reaction-rollup'] /** @example "

comment body

" */ - body_html?: string; + body_html?: string /** @example "comment body" */ - body_text?: string; - }; + body_text?: string + } /** * Timeline Line Commented Event * @description Timeline Line Commented Event */ - "timeline-line-commented-event": { - event?: string; - node_id?: string; - comments?: components["schemas"]["pull-request-review-comment"][]; - }; + 'timeline-line-commented-event': { + event?: string + node_id?: string + comments?: components['schemas']['pull-request-review-comment'][] + } /** * Timeline Commit Commented Event * @description Timeline Commit Commented Event */ - "timeline-commit-commented-event": { - event?: string; - node_id?: string; - commit_id?: string; - comments?: components["schemas"]["commit-comment"][]; - }; + 'timeline-commit-commented-event': { + event?: string + node_id?: string + commit_id?: string + comments?: components['schemas']['commit-comment'][] + } /** * Timeline Assigned Issue Event * @description Timeline Assigned Issue Event */ - "timeline-assigned-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; - assignee: components["schemas"]["simple-user"]; - }; + 'timeline-assigned-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] + assignee: components['schemas']['simple-user'] + } /** * Timeline Unassigned Issue Event * @description Timeline Unassigned Issue Event */ - "timeline-unassigned-issue-event": { - id: number; - node_id: string; - url: string; - actor: components["schemas"]["simple-user"]; - event: string; - commit_id: string | null; - commit_url: string | null; - created_at: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; - assignee: components["schemas"]["simple-user"]; - }; + 'timeline-unassigned-issue-event': { + id: number + node_id: string + url: string + actor: components['schemas']['simple-user'] + event: string + commit_id: string | null + commit_url: string | null + created_at: string + performed_via_github_app: components['schemas']['nullable-integration'] + assignee: components['schemas']['simple-user'] + } /** * Timeline Event * @description Timeline Event */ - "timeline-issue-events": Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial; + 'timeline-issue-events': Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial /** * Deploy Key * @description An SSH key granting access to a single repository. */ - "deploy-key": { - id: number; - key: string; - url: string; - title: string; - verified: boolean; - created_at: string; - read_only: boolean; - }; + 'deploy-key': { + id: number + key: string + url: string + title: string + verified: boolean + created_at: string + read_only: boolean + } /** * Language * @description Language */ - language: { [key: string]: number }; + language: { [key: string]: number } /** * License Content * @description License Content */ - "license-content": { - name: string; - path: string; - sha: string; - size: number; + 'license-content': { + name: string + path: string + sha: string + size: number /** Format: uri */ - url: string; + url: string /** Format: uri */ - html_url: string | null; + html_url: string | null /** Format: uri */ - git_url: string | null; + git_url: string | null /** Format: uri */ - download_url: string | null; - type: string; - content: string; - encoding: string; + download_url: string | null + type: string + content: string + encoding: string _links: { /** Format: uri */ - git: string | null; + git: string | null /** Format: uri */ - html: string | null; + html: string | null /** Format: uri */ - self: string; - }; - license: components["schemas"]["nullable-license-simple"]; - }; + self: string + } + license: components['schemas']['nullable-license-simple'] + } /** * Merged upstream * @description Results of a successful merge upstream request */ - "merged-upstream": { - message?: string; + 'merged-upstream': { + message?: string /** @enum {string} */ - merge_type?: "merge" | "fast-forward" | "none"; - base_branch?: string; - }; + merge_type?: 'merge' | 'fast-forward' | 'none' + base_branch?: string + } /** * Milestone * @description A collection of related issues and pull requests. @@ -15237,100 +15225,100 @@ export interface components { * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1 */ - url: string; + url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/milestones/v1.0 */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1/labels */ - labels_url: string; + labels_url: string /** @example 1002604 */ - id: number; + id: number /** @example MDk6TWlsZXN0b25lMTAwMjYwNA== */ - node_id: string; + node_id: string /** * @description The number of the milestone. * @example 42 */ - number: number; + number: number /** * @description The state of the milestone. * @default open * @example open * @enum {string} */ - state: "open" | "closed"; + state: 'open' | 'closed' /** * @description The title of the milestone. * @example v1.0 */ - title: string; + title: string /** @example Tracking milestone for version 1.0 */ - description: string | null; - creator: components["schemas"]["nullable-simple-user"]; + description: string | null + creator: components['schemas']['nullable-simple-user'] /** @example 4 */ - open_issues: number; + open_issues: number /** @example 8 */ - closed_issues: number; + closed_issues: number /** * Format: date-time * @example 2011-04-10T20:09:31Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2014-03-03T18:58:10Z */ - updated_at: string; + updated_at: string /** * Format: date-time * @example 2013-02-12T13:22:01Z */ - closed_at: string | null; + closed_at: string | null /** * Format: date-time * @example 2012-10-09T23:39:01Z */ - due_on: string | null; - }; + due_on: string | null + } /** Pages Source Hash */ - "pages-source-hash": { - branch: string; - path: string; - }; + 'pages-source-hash': { + branch: string + path: string + } /** Pages Https Certificate */ - "pages-https-certificate": { + 'pages-https-certificate': { /** * @example approved * @enum {string} */ state: - | "new" - | "authorization_created" - | "authorization_pending" - | "authorized" - | "authorization_revoked" - | "issued" - | "uploaded" - | "approved" - | "errored" - | "bad_authz" - | "destroy_pending" - | "dns_changed"; + | 'new' + | 'authorization_created' + | 'authorization_pending' + | 'authorized' + | 'authorization_revoked' + | 'issued' + | 'uploaded' + | 'approved' + | 'errored' + | 'bad_authz' + | 'destroy_pending' + | 'dns_changed' /** @example Certificate is approved */ - description: string; + description: string /** * @description Array of the domain set and its alternate name (if it is configured) * @example example.com,www.example.com */ - domains: string[]; + domains: string[] /** Format: date */ - expires_at?: string; - }; + expires_at?: string + } /** * GitHub Pages * @description The configuration for GitHub Pages for a repository. @@ -15341,1967 +15329,1967 @@ export interface components { * @description The API address for accessing this Page resource. * @example https://api.github.com/repos/github/hello-world/pages */ - url: string; + url: string /** * @description The status of the most recent build of the Page. * @example built * @enum {string|null} */ - status: ("built" | "building" | "errored") | null; + status: ('built' | 'building' | 'errored') | null /** * @description The Pages site's custom domain * @example example.com */ - cname: string | null; + cname: string | null /** * @description The state if the domain is verified * @example pending * @enum {string|null} */ - protected_domain_state?: ("pending" | "verified" | "unverified") | null; + protected_domain_state?: ('pending' | 'verified' | 'unverified') | null /** * Format: date-time * @description The timestamp when a pending domain becomes unverified. */ - pending_domain_unverified_at?: string | null; + pending_domain_unverified_at?: string | null /** @description Whether the Page has a custom 404 page. */ - custom_404: boolean; + custom_404: boolean /** * Format: uri * @description The web address the Page can be accessed from. * @example https://example.com */ - html_url?: string; - source?: components["schemas"]["pages-source-hash"]; + html_url?: string + source?: components['schemas']['pages-source-hash'] /** * @description Whether the GitHub Pages site is publicly visible. If set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. * @example true */ - public: boolean; - https_certificate?: components["schemas"]["pages-https-certificate"]; + public: boolean + https_certificate?: components['schemas']['pages-https-certificate'] /** * @description Whether https is enabled on the domain * @example true */ - https_enforced?: boolean; - }; + https_enforced?: boolean + } /** * Page Build * @description Page Build */ - "page-build": { + 'page-build': { /** Format: uri */ - url: string; - status: string; + url: string + status: string error: { - message: string | null; - }; - pusher: components["schemas"]["nullable-simple-user"]; - commit: string; - duration: number; + message: string | null + } + pusher: components['schemas']['nullable-simple-user'] + commit: string + duration: number /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - }; + updated_at: string + } /** * Page Build Status * @description Page Build Status */ - "page-build-status": { + 'page-build-status': { /** * Format: uri * @example https://api.github.com/repos/github/hello-world/pages/builds/latest */ - url: string; + url: string /** @example queued */ - status: string; - }; + status: string + } /** * Pages Health Check Status * @description Pages Health Check Status */ - "pages-health-check": { + 'pages-health-check': { domain?: { - host?: string; - uri?: string; - nameservers?: string; - dns_resolves?: boolean; - is_proxied?: boolean | null; - is_cloudflare_ip?: boolean | null; - is_fastly_ip?: boolean | null; - is_old_ip_address?: boolean | null; - is_a_record?: boolean | null; - has_cname_record?: boolean | null; - has_mx_records_present?: boolean | null; - is_valid_domain?: boolean; - is_apex_domain?: boolean; - should_be_a_record?: boolean | null; - is_cname_to_github_user_domain?: boolean | null; - is_cname_to_pages_dot_github_dot_com?: boolean | null; - is_cname_to_fastly?: boolean | null; - is_pointed_to_github_pages_ip?: boolean | null; - is_non_github_pages_ip_present?: boolean | null; - is_pages_domain?: boolean; - is_served_by_pages?: boolean | null; - is_valid?: boolean; - reason?: string | null; - responds_to_https?: boolean; - enforces_https?: boolean; - https_error?: string | null; - is_https_eligible?: boolean | null; - caa_error?: string | null; - }; + host?: string + uri?: string + nameservers?: string + dns_resolves?: boolean + is_proxied?: boolean | null + is_cloudflare_ip?: boolean | null + is_fastly_ip?: boolean | null + is_old_ip_address?: boolean | null + is_a_record?: boolean | null + has_cname_record?: boolean | null + has_mx_records_present?: boolean | null + is_valid_domain?: boolean + is_apex_domain?: boolean + should_be_a_record?: boolean | null + is_cname_to_github_user_domain?: boolean | null + is_cname_to_pages_dot_github_dot_com?: boolean | null + is_cname_to_fastly?: boolean | null + is_pointed_to_github_pages_ip?: boolean | null + is_non_github_pages_ip_present?: boolean | null + is_pages_domain?: boolean + is_served_by_pages?: boolean | null + is_valid?: boolean + reason?: string | null + responds_to_https?: boolean + enforces_https?: boolean + https_error?: string | null + is_https_eligible?: boolean | null + caa_error?: string | null + } alt_domain?: { - host?: string; - uri?: string; - nameservers?: string; - dns_resolves?: boolean; - is_proxied?: boolean | null; - is_cloudflare_ip?: boolean | null; - is_fastly_ip?: boolean | null; - is_old_ip_address?: boolean | null; - is_a_record?: boolean | null; - has_cname_record?: boolean | null; - has_mx_records_present?: boolean | null; - is_valid_domain?: boolean; - is_apex_domain?: boolean; - should_be_a_record?: boolean | null; - is_cname_to_github_user_domain?: boolean | null; - is_cname_to_pages_dot_github_dot_com?: boolean | null; - is_cname_to_fastly?: boolean | null; - is_pointed_to_github_pages_ip?: boolean | null; - is_non_github_pages_ip_present?: boolean | null; - is_pages_domain?: boolean; - is_served_by_pages?: boolean | null; - is_valid?: boolean; - reason?: string | null; - responds_to_https?: boolean; - enforces_https?: boolean; - https_error?: string | null; - is_https_eligible?: boolean | null; - caa_error?: string | null; - } | null; - }; + host?: string + uri?: string + nameservers?: string + dns_resolves?: boolean + is_proxied?: boolean | null + is_cloudflare_ip?: boolean | null + is_fastly_ip?: boolean | null + is_old_ip_address?: boolean | null + is_a_record?: boolean | null + has_cname_record?: boolean | null + has_mx_records_present?: boolean | null + is_valid_domain?: boolean + is_apex_domain?: boolean + should_be_a_record?: boolean | null + is_cname_to_github_user_domain?: boolean | null + is_cname_to_pages_dot_github_dot_com?: boolean | null + is_cname_to_fastly?: boolean | null + is_pointed_to_github_pages_ip?: boolean | null + is_non_github_pages_ip_present?: boolean | null + is_pages_domain?: boolean + is_served_by_pages?: boolean | null + is_valid?: boolean + reason?: string | null + responds_to_https?: boolean + enforces_https?: boolean + https_error?: string | null + is_https_eligible?: boolean | null + caa_error?: string | null + } | null + } /** * Team Simple * @description Groups of organization members that gives permissions on specified repositories. */ - "team-simple": { + 'team-simple': { /** * @description Unique identifier of the team * @example 1 */ - id: number; + id: number /** @example MDQ6VGVhbTE= */ - node_id: string; + node_id: string /** * Format: uri * @description URL for the team * @example https://api.github.com/organizations/1/team/1 */ - url: string; + url: string /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - members_url: string; + members_url: string /** * @description Name of the team * @example Justice League */ - name: string; + name: string /** * @description Description of the team * @example A great team. */ - description: string | null; + description: string | null /** * @description Permission that the team will have for its repositories * @example admin */ - permission: string; + permission: string /** * @description The level of privacy this team should have * @example closed */ - privacy?: string; + privacy?: string /** * Format: uri * @example https://github.com/orgs/rails/teams/core */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/organizations/1/team/1/repos */ - repositories_url: string; + repositories_url: string /** @example justice-league */ - slug: string; + slug: string /** * @description Distinguished Name (DN) that team maps to within LDAP environment * @example uid=example,ou=users,dc=github,dc=com */ - ldap_dn?: string; - }; + ldap_dn?: string + } /** * Pull Request * @description Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary. */ - "pull-request": { + 'pull-request': { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ - url: string; + url: string /** @example 1 */ - id: number; + id: number /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ - node_id: string; + node_id: string /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347 */ - html_url: string; + html_url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.diff */ - diff_url: string; + diff_url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.patch */ - patch_url: string; + patch_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 */ - issue_url: string; + issue_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits */ - commits_url: string; + commits_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments */ - review_comments_url: string; + review_comments_url: string /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} */ - review_comment_url: string; + review_comment_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347/comments */ - comments_url: string; + comments_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e */ - statuses_url: string; + statuses_url: string /** * @description Number uniquely identifying the pull request within its repository. * @example 42 */ - number: number; + number: number /** * @description State of this Pull Request. Either `open` or `closed`. * @example open * @enum {string} */ - state: "open" | "closed"; + state: 'open' | 'closed' /** @example true */ - locked: boolean; + locked: boolean /** * @description The title of the pull request. * @example Amazing new feature */ - title: string; - user: components["schemas"]["nullable-simple-user"]; + title: string + user: components['schemas']['nullable-simple-user'] /** @example Please pull these awesome changes */ - body: string | null; + body: string | null labels: { /** Format: int64 */ - id: number; - node_id: string; - url: string; - name: string; - description: string | null; - color: string; - default: boolean; - }[]; - milestone: components["schemas"]["nullable-milestone"]; + id: number + node_id: string + url: string + name: string + description: string | null + color: string + default: boolean + }[] + milestone: components['schemas']['nullable-milestone'] /** @example too heated */ - active_lock_reason?: string | null; + active_lock_reason?: string | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - updated_at: string; + updated_at: string /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - closed_at: string | null; + closed_at: string | null /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - merged_at: string | null; + merged_at: string | null /** @example e5bd3914e2e596debea16f433f57875b5b90bcd6 */ - merge_commit_sha: string | null; - assignee: components["schemas"]["nullable-simple-user"]; - assignees?: components["schemas"]["simple-user"][] | null; - requested_reviewers?: components["schemas"]["simple-user"][] | null; - requested_teams?: components["schemas"]["team-simple"][] | null; + merge_commit_sha: string | null + assignee: components['schemas']['nullable-simple-user'] + assignees?: components['schemas']['simple-user'][] | null + requested_reviewers?: components['schemas']['simple-user'][] | null + requested_teams?: components['schemas']['team-simple'][] | null head: { - label: string; - ref: string; + label: string + ref: string repo: { - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; + archive_url: string + assignees_url: string + blobs_url: string + branches_url: string + collaborators_url: string + comments_url: string + commits_url: string + compare_url: string + contents_url: string /** Format: uri */ - contributors_url: string; + contributors_url: string /** Format: uri */ - deployments_url: string; - description: string | null; + deployments_url: string + description: string | null /** Format: uri */ - downloads_url: string; + downloads_url: string /** Format: uri */ - events_url: string; - fork: boolean; + events_url: string + fork: boolean /** Format: uri */ - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; + forks_url: string + full_name: string + git_commits_url: string + git_refs_url: string + git_tags_url: string /** Format: uri */ - hooks_url: string; + hooks_url: string /** Format: uri */ - html_url: string; - id: number; - node_id: string; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; + html_url: string + id: number + node_id: string + issue_comment_url: string + issue_events_url: string + issues_url: string + keys_url: string + labels_url: string /** Format: uri */ - languages_url: string; + languages_url: string /** Format: uri */ - merges_url: string; - milestones_url: string; - name: string; - notifications_url: string; + merges_url: string + milestones_url: string + name: string + notifications_url: string owner: { /** Format: uri */ - avatar_url: string; - events_url: string; + avatar_url: string + events_url: string /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; + followers_url: string + following_url: string + gists_url: string + gravatar_id: string | null /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; + html_url: string + id: number + node_id: string + login: string /** Format: uri */ - organizations_url: string; + organizations_url: string /** Format: uri */ - received_events_url: string; + received_events_url: string /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; + repos_url: string + site_admin: boolean + starred_url: string /** Format: uri */ - subscriptions_url: string; - type: string; + subscriptions_url: string + type: string /** Format: uri */ - url: string; - }; - private: boolean; - pulls_url: string; - releases_url: string; + url: string + } + private: boolean + pulls_url: string + releases_url: string /** Format: uri */ - stargazers_url: string; - statuses_url: string; + stargazers_url: string + statuses_url: string /** Format: uri */ - subscribers_url: string; + subscribers_url: string /** Format: uri */ - subscription_url: string; + subscription_url: string /** Format: uri */ - tags_url: string; + tags_url: string /** Format: uri */ - teams_url: string; - trees_url: string; + teams_url: string + trees_url: string /** Format: uri */ - url: string; - clone_url: string; - default_branch: string; - forks: number; - forks_count: number; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_projects: boolean; - has_wiki: boolean; - has_pages: boolean; + url: string + clone_url: string + default_branch: string + forks: number + forks_count: number + git_url: string + has_downloads: boolean + has_issues: boolean + has_projects: boolean + has_wiki: boolean + has_pages: boolean /** Format: uri */ - homepage: string | null; - language: string | null; - master_branch?: string; - archived: boolean; - disabled: boolean; + homepage: string | null + language: string | null + master_branch?: string + archived: boolean + disabled: boolean /** @description The repository visibility: public, private, or internal. */ - visibility?: string; + visibility?: string /** Format: uri */ - mirror_url: string | null; - open_issues: number; - open_issues_count: number; + mirror_url: string | null + open_issues: number + open_issues_count: number permissions?: { - admin: boolean; - maintain?: boolean; - push: boolean; - triage?: boolean; - pull: boolean; - }; - temp_clone_token?: string; - allow_merge_commit?: boolean; - allow_squash_merge?: boolean; - allow_rebase_merge?: boolean; + admin: boolean + maintain?: boolean + push: boolean + triage?: boolean + pull: boolean + } + temp_clone_token?: string + allow_merge_commit?: boolean + allow_squash_merge?: boolean + allow_rebase_merge?: boolean license: { - key: string; - name: string; + key: string + name: string /** Format: uri */ - url: string | null; - spdx_id: string | null; - node_id: string; - } | null; + url: string | null + spdx_id: string | null + node_id: string + } | null /** Format: date-time */ - pushed_at: string; - size: number; - ssh_url: string; - stargazers_count: number; + pushed_at: string + size: number + ssh_url: string + stargazers_count: number /** Format: uri */ - svn_url: string; - topics?: string[]; - watchers: number; - watchers_count: number; + svn_url: string + topics?: string[] + watchers: number + watchers_count: number /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - allow_forking?: boolean; - is_template?: boolean; - } | null; - sha: string; + updated_at: string + allow_forking?: boolean + is_template?: boolean + } | null + sha: string user: { /** Format: uri */ - avatar_url: string; - events_url: string; + avatar_url: string + events_url: string /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; + followers_url: string + following_url: string + gists_url: string + gravatar_id: string | null /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; + html_url: string + id: number + node_id: string + login: string /** Format: uri */ - organizations_url: string; + organizations_url: string /** Format: uri */ - received_events_url: string; + received_events_url: string /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; + repos_url: string + site_admin: boolean + starred_url: string /** Format: uri */ - subscriptions_url: string; - type: string; + subscriptions_url: string + type: string /** Format: uri */ - url: string; - }; - }; + url: string + } + } base: { - label: string; - ref: string; + label: string + ref: string repo: { - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; + archive_url: string + assignees_url: string + blobs_url: string + branches_url: string + collaborators_url: string + comments_url: string + commits_url: string + compare_url: string + contents_url: string /** Format: uri */ - contributors_url: string; + contributors_url: string /** Format: uri */ - deployments_url: string; - description: string | null; + deployments_url: string + description: string | null /** Format: uri */ - downloads_url: string; + downloads_url: string /** Format: uri */ - events_url: string; - fork: boolean; + events_url: string + fork: boolean /** Format: uri */ - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; + forks_url: string + full_name: string + git_commits_url: string + git_refs_url: string + git_tags_url: string /** Format: uri */ - hooks_url: string; + hooks_url: string /** Format: uri */ - html_url: string; - id: number; - is_template?: boolean; - node_id: string; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; + html_url: string + id: number + is_template?: boolean + node_id: string + issue_comment_url: string + issue_events_url: string + issues_url: string + keys_url: string + labels_url: string /** Format: uri */ - languages_url: string; + languages_url: string /** Format: uri */ - merges_url: string; - milestones_url: string; - name: string; - notifications_url: string; + merges_url: string + milestones_url: string + name: string + notifications_url: string owner: { /** Format: uri */ - avatar_url: string; - events_url: string; + avatar_url: string + events_url: string /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; + followers_url: string + following_url: string + gists_url: string + gravatar_id: string | null /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; + html_url: string + id: number + node_id: string + login: string /** Format: uri */ - organizations_url: string; + organizations_url: string /** Format: uri */ - received_events_url: string; + received_events_url: string /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; + repos_url: string + site_admin: boolean + starred_url: string /** Format: uri */ - subscriptions_url: string; - type: string; + subscriptions_url: string + type: string /** Format: uri */ - url: string; - }; - private: boolean; - pulls_url: string; - releases_url: string; + url: string + } + private: boolean + pulls_url: string + releases_url: string /** Format: uri */ - stargazers_url: string; - statuses_url: string; + stargazers_url: string + statuses_url: string /** Format: uri */ - subscribers_url: string; + subscribers_url: string /** Format: uri */ - subscription_url: string; + subscription_url: string /** Format: uri */ - tags_url: string; + tags_url: string /** Format: uri */ - teams_url: string; - trees_url: string; + teams_url: string + trees_url: string /** Format: uri */ - url: string; - clone_url: string; - default_branch: string; - forks: number; - forks_count: number; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_projects: boolean; - has_wiki: boolean; - has_pages: boolean; + url: string + clone_url: string + default_branch: string + forks: number + forks_count: number + git_url: string + has_downloads: boolean + has_issues: boolean + has_projects: boolean + has_wiki: boolean + has_pages: boolean /** Format: uri */ - homepage: string | null; - language: string | null; - master_branch?: string; - archived: boolean; - disabled: boolean; + homepage: string | null + language: string | null + master_branch?: string + archived: boolean + disabled: boolean /** @description The repository visibility: public, private, or internal. */ - visibility?: string; + visibility?: string /** Format: uri */ - mirror_url: string | null; - open_issues: number; - open_issues_count: number; + mirror_url: string | null + open_issues: number + open_issues_count: number permissions?: { - admin: boolean; - maintain?: boolean; - push: boolean; - triage?: boolean; - pull: boolean; - }; - temp_clone_token?: string; - allow_merge_commit?: boolean; - allow_squash_merge?: boolean; - allow_rebase_merge?: boolean; - license: components["schemas"]["nullable-license-simple"]; + admin: boolean + maintain?: boolean + push: boolean + triage?: boolean + pull: boolean + } + temp_clone_token?: string + allow_merge_commit?: boolean + allow_squash_merge?: boolean + allow_rebase_merge?: boolean + license: components['schemas']['nullable-license-simple'] /** Format: date-time */ - pushed_at: string; - size: number; - ssh_url: string; - stargazers_count: number; + pushed_at: string + size: number + ssh_url: string + stargazers_count: number /** Format: uri */ - svn_url: string; - topics?: string[]; - watchers: number; - watchers_count: number; + svn_url: string + topics?: string[] + watchers: number + watchers_count: number /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - allow_forking?: boolean; - }; - sha: string; + updated_at: string + allow_forking?: boolean + } + sha: string user: { /** Format: uri */ - avatar_url: string; - events_url: string; + avatar_url: string + events_url: string /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; + followers_url: string + following_url: string + gists_url: string + gravatar_id: string | null /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; + html_url: string + id: number + node_id: string + login: string /** Format: uri */ - organizations_url: string; + organizations_url: string /** Format: uri */ - received_events_url: string; + received_events_url: string /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; + repos_url: string + site_admin: boolean + starred_url: string /** Format: uri */ - subscriptions_url: string; - type: string; + subscriptions_url: string + type: string /** Format: uri */ - url: string; - }; - }; + url: string + } + } _links: { - comments: components["schemas"]["link"]; - commits: components["schemas"]["link"]; - statuses: components["schemas"]["link"]; - html: components["schemas"]["link"]; - issue: components["schemas"]["link"]; - review_comments: components["schemas"]["link"]; - review_comment: components["schemas"]["link"]; - self: components["schemas"]["link"]; - }; - author_association: components["schemas"]["author_association"]; - auto_merge: components["schemas"]["auto_merge"]; + comments: components['schemas']['link'] + commits: components['schemas']['link'] + statuses: components['schemas']['link'] + html: components['schemas']['link'] + issue: components['schemas']['link'] + review_comments: components['schemas']['link'] + review_comment: components['schemas']['link'] + self: components['schemas']['link'] + } + author_association: components['schemas']['author_association'] + auto_merge: components['schemas']['auto_merge'] /** @description Indicates whether or not the pull request is a draft. */ - draft?: boolean; - merged: boolean; + draft?: boolean + merged: boolean /** @example true */ - mergeable: boolean | null; + mergeable: boolean | null /** @example true */ - rebaseable?: boolean | null; + rebaseable?: boolean | null /** @example clean */ - mergeable_state: string; - merged_by: components["schemas"]["nullable-simple-user"]; + mergeable_state: string + merged_by: components['schemas']['nullable-simple-user'] /** @example 10 */ - comments: number; - review_comments: number; + comments: number + review_comments: number /** * @description Indicates whether maintainers can modify the pull request. * @example true */ - maintainer_can_modify: boolean; + maintainer_can_modify: boolean /** @example 3 */ - commits: number; + commits: number /** @example 100 */ - additions: number; + additions: number /** @example 3 */ - deletions: number; + deletions: number /** @example 5 */ - changed_files: number; - }; + changed_files: number + } /** * Pull Request Merge Result * @description Pull Request Merge Result */ - "pull-request-merge-result": { - sha: string; - merged: boolean; - message: string; - }; + 'pull-request-merge-result': { + sha: string + merged: boolean + message: string + } /** * Pull Request Review Request * @description Pull Request Review Request */ - "pull-request-review-request": { - users: components["schemas"]["simple-user"][]; - teams: components["schemas"]["team"][]; - }; + 'pull-request-review-request': { + users: components['schemas']['simple-user'][] + teams: components['schemas']['team'][] + } /** * Pull Request Review * @description Pull Request Reviews are reviews on pull requests. */ - "pull-request-review": { + 'pull-request-review': { /** * @description Unique identifier of the review * @example 42 */ - id: number; + id: number /** @example MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= */ - node_id: string; - user: components["schemas"]["nullable-simple-user"]; + node_id: string + user: components['schemas']['nullable-simple-user'] /** * @description The text of the review. * @example This looks great. */ - body: string; + body: string /** @example CHANGES_REQUESTED */ - state: string; + state: string /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/12 */ - pull_request_url: string; + pull_request_url: string _links: { html: { - href: string; - }; + href: string + } pull_request: { - href: string; - }; - }; + href: string + } + } /** Format: date-time */ - submitted_at?: string; + submitted_at?: string /** * @description A commit SHA for the review. * @example 54bb654c9e6025347f57900a4a5c2313a96b8035 */ - commit_id: string; - body_html?: string; - body_text?: string; - author_association: components["schemas"]["author_association"]; - }; + commit_id: string + body_html?: string + body_text?: string + author_association: components['schemas']['author_association'] + } /** * Legacy Review Comment * @description Legacy Review Comment */ - "review-comment": { + 'review-comment': { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ - url: string; + url: string /** @example 42 */ - pull_request_review_id: number | null; + pull_request_review_id: number | null /** @example 10 */ - id: number; + id: number /** @example MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw */ - node_id: string; + node_id: string /** @example @@ -16,33 +16,40 @@ public class Connection : IConnection... */ - diff_hunk: string; + diff_hunk: string /** @example file1.txt */ - path: string; + path: string /** @example 1 */ - position: number | null; + position: number | null /** @example 4 */ - original_position: number; + original_position: number /** @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */ - commit_id: string; + commit_id: string /** @example 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 */ - original_commit_id: string; + original_commit_id: string /** @example 8 */ - in_reply_to_id?: number; - user: components["schemas"]["nullable-simple-user"]; + in_reply_to_id?: number + user: components['schemas']['nullable-simple-user'] /** @example Great stuff */ - body: string; + body: string /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - updated_at: string; + updated_at: string /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1 */ - pull_request_url: string; - author_association: components["schemas"]["author_association"]; + pull_request_url: string + author_association: components['schemas']['author_association'] _links: { - self: components["schemas"]["link"]; - html: components["schemas"]["link"]; - pull_request: components["schemas"]["link"]; - }; - body_text?: string; - body_html?: string; - reactions?: components["schemas"]["reaction-rollup"]; + self: components['schemas']['link'] + html: components['schemas']['link'] + pull_request: components['schemas']['link'] + } + body_text?: string + body_html?: string + reactions?: components['schemas']['reaction-rollup'] /** * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string} */ - side?: "LEFT" | "RIGHT"; + side?: 'LEFT' | 'RIGHT' /** * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} */ - start_side?: ("LEFT" | "RIGHT") | null; + start_side?: ('LEFT' | 'RIGHT') | null /** * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment * @example 2 */ - line?: number; + line?: number /** * @description The original line of the blob to which the comment applies. The last line of the range for a multi-line comment * @example 2 */ - original_line?: number; + original_line?: number /** * @description The first line of the range for a multi-line comment. * @example 2 */ - start_line?: number | null; + start_line?: number | null /** * @description The original first line of the range for a multi-line comment. * @example 2 */ - original_start_line?: number | null; - }; + original_start_line?: number | null + } /** * Release Asset * @description Data related to a release. */ - "release-asset": { + 'release-asset': { /** Format: uri */ - url: string; + url: string /** Format: uri */ - browser_download_url: string; - id: number; - node_id: string; + browser_download_url: string + id: number + node_id: string /** * @description The file name of the asset. * @example Team Environment */ - name: string; - label: string | null; + name: string + label: string | null /** * @description State of the release asset. * @enum {string} */ - state: "uploaded" | "open"; - content_type: string; - size: number; - download_count: number; + state: 'uploaded' | 'open' + content_type: string + size: number + download_count: number /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - uploader: components["schemas"]["nullable-simple-user"]; - }; + updated_at: string + uploader: components['schemas']['nullable-simple-user'] + } /** * Release * @description A release. */ release: { /** Format: uri */ - url: string; + url: string /** Format: uri */ - html_url: string; + html_url: string /** Format: uri */ - assets_url: string; - upload_url: string; + assets_url: string + upload_url: string /** Format: uri */ - tarball_url: string | null; + tarball_url: string | null /** Format: uri */ - zipball_url: string | null; - id: number; - node_id: string; + zipball_url: string | null + id: number + node_id: string /** * @description The name of the tag. * @example v1.0.0 */ - tag_name: string; + tag_name: string /** * @description Specifies the commitish value that determines where the Git tag is created from. * @example master */ - target_commitish: string; - name: string | null; - body?: string | null; + target_commitish: string + name: string | null + body?: string | null /** @description true to create a draft (unpublished) release, false to create a published one. */ - draft: boolean; + draft: boolean /** @description Whether to identify the release as a prerelease or a full release. */ - prerelease: boolean; + prerelease: boolean /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - published_at: string | null; - author: components["schemas"]["simple-user"]; - assets: components["schemas"]["release-asset"][]; - body_html?: string; - body_text?: string; - mentions_count?: number; + published_at: string | null + author: components['schemas']['simple-user'] + assets: components['schemas']['release-asset'][] + body_html?: string + body_text?: string + mentions_count?: number /** * Format: uri * @description The URL of the release discussion. */ - discussion_url?: string; - reactions?: components["schemas"]["reaction-rollup"]; - }; + discussion_url?: string + reactions?: components['schemas']['reaction-rollup'] + } /** * Generated Release Notes Content * @description Generated name and body describing a release */ - "release-notes-content": { + 'release-notes-content': { /** * @description The generated name of the release * @example Release v1.0.0 is now available! */ - name: string; + name: string /** @description The generated body describing the contents of the release supporting markdown formatting */ - body: string; - }; - "secret-scanning-alert": { - number?: components["schemas"]["alert-number"]; - created_at?: components["schemas"]["alert-created-at"]; - url?: components["schemas"]["alert-url"]; - html_url?: components["schemas"]["alert-html-url"]; + body: string + } + 'secret-scanning-alert': { + number?: components['schemas']['alert-number'] + created_at?: components['schemas']['alert-created-at'] + url?: components['schemas']['alert-url'] + html_url?: components['schemas']['alert-html-url'] /** * Format: uri * @description The REST API URL of the code locations for this alert. */ - locations_url?: string; - state?: components["schemas"]["secret-scanning-alert-state"]; - resolution?: components["schemas"]["secret-scanning-alert-resolution"]; + locations_url?: string + state?: components['schemas']['secret-scanning-alert-state'] + resolution?: components['schemas']['secret-scanning-alert-resolution'] /** * Format: date-time * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - resolved_at?: string | null; - resolved_by?: components["schemas"]["nullable-simple-user"]; + resolved_at?: string | null + resolved_by?: components['schemas']['nullable-simple-user'] /** @description The type of secret that secret scanning detected. */ - secret_type?: string; + secret_type?: string /** @description The secret that was detected. */ - secret?: string; - }; + secret?: string + } /** @description Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. */ - "secret-scanning-location-commit": { + 'secret-scanning-location-commit': { /** * @description The file path in the repository * @example /example/secrets.txt */ - path: string; + path: string /** @description Line number at which the secret starts in the file */ - start_line: number; + start_line: number /** @description Line number at which the secret ends in the file */ - end_line: number; + end_line: number /** @description The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII */ - start_column: number; + start_column: number /** @description The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII */ - end_column: number; + end_column: number /** * @description SHA-1 hash ID of the associated blob * @example af5626b4a114abcb82d63db7c8082c3c4756e51b */ - blob_sha: string; + blob_sha: string /** @description The API URL to get the associated blob resource */ - blob_url: string; + blob_url: string /** * @description SHA-1 hash ID of the associated commit * @example af5626b4a114abcb82d63db7c8082c3c4756e51b */ - commit_sha: string; + commit_sha: string /** @description The API URL to get the associated commit resource */ - commit_url: string; - }; - "secret-scanning-location": { + commit_url: string + } + 'secret-scanning-location': { /** * @description The location type. Because secrets may be found in different types of resources (ie. code, comments, issues), this field identifies the type of resource where the secret was found. * @example commit * @enum {string} */ - type: "commit"; - details: components["schemas"]["secret-scanning-location-commit"]; - }; + type: 'commit' + details: components['schemas']['secret-scanning-location-commit'] + } /** * Stargazer * @description Stargazer */ stargazer: { /** Format: date-time */ - starred_at: string; - user: components["schemas"]["nullable-simple-user"]; - }; + starred_at: string + user: components['schemas']['nullable-simple-user'] + } /** * Code Frequency Stat * @description Code Frequency Stat */ - "code-frequency-stat": number[]; + 'code-frequency-stat': number[] /** * Commit Activity * @description Commit Activity */ - "commit-activity": { + 'commit-activity': { /** @example 0,3,26,20,39,1,0 */ - days: number[]; + days: number[] /** @example 89 */ - total: number; + total: number /** @example 1336280400 */ - week: number; - }; + week: number + } /** * Contributor Activity * @description Contributor Activity */ - "contributor-activity": { - author: components["schemas"]["nullable-simple-user"]; + 'contributor-activity': { + author: components['schemas']['nullable-simple-user'] /** @example 135 */ - total: number; + total: number /** @example [object Object] */ weeks: { - w?: number; - a?: number; - d?: number; - c?: number; - }[]; - }; + w?: number + a?: number + d?: number + c?: number + }[] + } /** Participation Stats */ - "participation-stats": { - all: number[]; - owner: number[]; - }; + 'participation-stats': { + all: number[] + owner: number[] + } /** * Repository Invitation * @description Repository invitations let you manage who you collaborate with. */ - "repository-subscription": { + 'repository-subscription': { /** * @description Determines if notifications should be received from this repository. * @example true */ - subscribed: boolean; + subscribed: boolean /** @description Determines if all notifications should be blocked from this repository. */ - ignored: boolean; - reason: string | null; + ignored: boolean + reason: string | null /** * Format: date-time * @example 2012-10-06T21:34:12Z */ - created_at: string; + created_at: string /** * Format: uri * @example https://api.github.com/repos/octocat/example/subscription */ - url: string; + url: string /** * Format: uri * @example https://api.github.com/repos/octocat/example */ - repository_url: string; - }; + repository_url: string + } /** * Tag * @description Tag */ tag: { /** @example v0.1 */ - name: string; + name: string commit: { - sha: string; + sha: string /** Format: uri */ - url: string; - }; + url: string + } /** * Format: uri * @example https://github.com/octocat/Hello-World/zipball/v0.1 */ - zipball_url: string; + zipball_url: string /** * Format: uri * @example https://github.com/octocat/Hello-World/tarball/v0.1 */ - tarball_url: string; - node_id: string; - }; + tarball_url: string + node_id: string + } /** * Topic * @description A topic aggregates entities that are related to a subject. */ topic: { - names: string[]; - }; + names: string[] + } /** Traffic */ traffic: { /** Format: date-time */ - timestamp: string; - uniques: number; - count: number; - }; + timestamp: string + uniques: number + count: number + } /** * Clone Traffic * @description Clone Traffic */ - "clone-traffic": { + 'clone-traffic': { /** @example 173 */ - count: number; + count: number /** @example 128 */ - uniques: number; - clones: components["schemas"]["traffic"][]; - }; + uniques: number + clones: components['schemas']['traffic'][] + } /** * Content Traffic * @description Content Traffic */ - "content-traffic": { + 'content-traffic': { /** @example /github/hubot */ - path: string; + path: string /** @example github/hubot: A customizable life embetterment robot. */ - title: string; + title: string /** @example 3542 */ - count: number; + count: number /** @example 2225 */ - uniques: number; - }; + uniques: number + } /** * Referrer Traffic * @description Referrer Traffic */ - "referrer-traffic": { + 'referrer-traffic': { /** @example Google */ - referrer: string; + referrer: string /** @example 4 */ - count: number; + count: number /** @example 3 */ - uniques: number; - }; + uniques: number + } /** * View Traffic * @description View Traffic */ - "view-traffic": { + 'view-traffic': { /** @example 14850 */ - count: number; + count: number /** @example 3782 */ - uniques: number; - views: components["schemas"]["traffic"][]; - }; - "scim-group-list-enterprise": { - schemas: string[]; - totalResults: number; - itemsPerPage: number; - startIndex: number; + uniques: number + views: components['schemas']['traffic'][] + } + 'scim-group-list-enterprise': { + schemas: string[] + totalResults: number + itemsPerPage: number + startIndex: number Resources: { - schemas: string[]; - id: string; - externalId?: string | null; - displayName?: string; + schemas: string[] + id: string + externalId?: string | null + displayName?: string members?: { - value?: string; - $ref?: string; - display?: string; - }[]; + value?: string + $ref?: string + display?: string + }[] meta?: { - resourceType?: string; - created?: string; - lastModified?: string; - location?: string; - }; - }[]; - }; - "scim-enterprise-group": { - schemas: string[]; - id: string; - externalId?: string | null; - displayName?: string; + resourceType?: string + created?: string + lastModified?: string + location?: string + } + }[] + } + 'scim-enterprise-group': { + schemas: string[] + id: string + externalId?: string | null + displayName?: string members?: { - value?: string; - $ref?: string; - display?: string; - }[]; + value?: string + $ref?: string + display?: string + }[] meta?: { - resourceType?: string; - created?: string; - lastModified?: string; - location?: string; - }; - }; - "scim-user-list-enterprise": { - schemas: string[]; - totalResults: number; - itemsPerPage: number; - startIndex: number; + resourceType?: string + created?: string + lastModified?: string + location?: string + } + } + 'scim-user-list-enterprise': { + schemas: string[] + totalResults: number + itemsPerPage: number + startIndex: number Resources: { - schemas: string[]; - id: string; - externalId?: string; - userName?: string; + schemas: string[] + id: string + externalId?: string + userName?: string name?: { - givenName?: string; - familyName?: string; - }; + givenName?: string + familyName?: string + } emails?: { - value?: string; - primary?: boolean; - type?: string; - }[]; + value?: string + primary?: boolean + type?: string + }[] groups?: { - value?: string; - }[]; - active?: boolean; + value?: string + }[] + active?: boolean meta?: { - resourceType?: string; - created?: string; - lastModified?: string; - location?: string; - }; - }[]; - }; - "scim-enterprise-user": { - schemas: string[]; - id: string; - externalId?: string; - userName?: string; + resourceType?: string + created?: string + lastModified?: string + location?: string + } + }[] + } + 'scim-enterprise-user': { + schemas: string[] + id: string + externalId?: string + userName?: string name?: { - givenName?: string; - familyName?: string; - }; + givenName?: string + familyName?: string + } emails?: { - value?: string; - type?: string; - primary?: boolean; - }[]; + value?: string + type?: string + primary?: boolean + }[] groups?: { - value?: string; - }[]; - active?: boolean; + value?: string + }[] + active?: boolean meta?: { - resourceType?: string; - created?: string; - lastModified?: string; - location?: string; - }; - }; + resourceType?: string + created?: string + lastModified?: string + location?: string + } + } /** * SCIM /Users * @description SCIM /Users provisioning endpoints */ - "scim-user": { + 'scim-user': { /** @description SCIM schema used. */ - schemas: string[]; + schemas: string[] /** * @description Unique identifier of an external identity * @example 1b78eada-9baa-11e6-9eb6-a431576d590e */ - id: string; + id: string /** * @description The ID of the User. * @example a7b0f98395 */ - externalId: string | null; + externalId: string | null /** * @description Configured by the admin. Could be an email, login, or username * @example someone@example.com */ - userName: string | null; + userName: string | null /** * @description The name of the user, suitable for display to end-users * @example Jon Doe */ - displayName?: string | null; + displayName?: string | null /** @example [object Object] */ name: { - givenName: string | null; - familyName: string | null; - formatted?: string | null; - }; + givenName: string | null + familyName: string | null + formatted?: string | null + } /** * @description user emails * @example [object Object],[object Object] */ emails: { - value: string; - primary?: boolean; - }[]; + value: string + primary?: boolean + }[] /** * @description The active status of the User. * @example true */ - active: boolean; + active: boolean meta: { /** @example User */ - resourceType?: string; + resourceType?: string /** * Format: date-time * @example 2019-01-24T22:45:36.000Z */ - created?: string; + created?: string /** * Format: date-time * @example 2019-01-24T22:45:36.000Z */ - lastModified?: string; + lastModified?: string /** * Format: uri * @example https://api.github.com/scim/v2/organizations/myorg-123abc55141bfd8f/Users/c42772b5-2029-11e9-8543-9264a97dec8d */ - location?: string; - }; + location?: string + } /** @description The ID of the organization. */ - organization_id?: number; + organization_id?: number /** * @description Set of operations to be performed * @example [object Object] */ operations?: { /** @enum {string} */ - op: "add" | "remove" | "replace"; - path?: string; - value?: string | { [key: string]: unknown } | unknown[]; - }[]; + op: 'add' | 'remove' | 'replace' + path?: string + value?: string | { [key: string]: unknown } | unknown[] + }[] /** @description associated groups */ groups?: { - value?: string; - display?: string; - }[]; - }; + value?: string + display?: string + }[] + } /** * SCIM User List * @description SCIM User List */ - "scim-user-list": { + 'scim-user-list': { /** @description SCIM schema used. */ - schemas: string[]; + schemas: string[] /** @example 3 */ - totalResults: number; + totalResults: number /** @example 10 */ - itemsPerPage: number; + itemsPerPage: number /** @example 1 */ - startIndex: number; - Resources: components["schemas"]["scim-user"][]; - }; + startIndex: number + Resources: components['schemas']['scim-user'][] + } /** Search Result Text Matches */ - "search-result-text-matches": { - object_url?: string; - object_type?: string | null; - property?: string; - fragment?: string; + 'search-result-text-matches': { + object_url?: string + object_type?: string | null + property?: string + fragment?: string matches?: { - text?: string; - indices?: number[]; - }[]; - }[]; + text?: string + indices?: number[] + }[] + }[] /** * Code Search Result Item * @description Code Search Result Item */ - "code-search-result-item": { - name: string; - path: string; - sha: string; + 'code-search-result-item': { + name: string + path: string + sha: string /** Format: uri */ - url: string; + url: string /** Format: uri */ - git_url: string; + git_url: string /** Format: uri */ - html_url: string; - repository: components["schemas"]["minimal-repository"]; - score: number; - file_size?: number; - language?: string | null; + html_url: string + repository: components['schemas']['minimal-repository'] + score: number + file_size?: number + language?: string | null /** Format: date-time */ - last_modified_at?: string; + last_modified_at?: string /** @example 73..77,77..78 */ - line_numbers?: string[]; - text_matches?: components["schemas"]["search-result-text-matches"]; - }; + line_numbers?: string[] + text_matches?: components['schemas']['search-result-text-matches'] + } /** * Commit Search Result Item * @description Commit Search Result Item */ - "commit-search-result-item": { + 'commit-search-result-item': { /** Format: uri */ - url: string; - sha: string; + url: string + sha: string /** Format: uri */ - html_url: string; + html_url: string /** Format: uri */ - comments_url: string; + comments_url: string commit: { author: { - name: string; - email: string; + name: string + email: string /** Format: date-time */ - date: string; - }; - committer: components["schemas"]["nullable-git-user"]; - comment_count: number; - message: string; + date: string + } + committer: components['schemas']['nullable-git-user'] + comment_count: number + message: string tree: { - sha: string; + sha: string /** Format: uri */ - url: string; - }; + url: string + } /** Format: uri */ - url: string; - verification?: components["schemas"]["verification"]; - }; - author: components["schemas"]["nullable-simple-user"]; - committer: components["schemas"]["nullable-git-user"]; + url: string + verification?: components['schemas']['verification'] + } + author: components['schemas']['nullable-simple-user'] + committer: components['schemas']['nullable-git-user'] parents: { - url?: string; - html_url?: string; - sha?: string; - }[]; - repository: components["schemas"]["minimal-repository"]; - score: number; - node_id: string; - text_matches?: components["schemas"]["search-result-text-matches"]; - }; + url?: string + html_url?: string + sha?: string + }[] + repository: components['schemas']['minimal-repository'] + score: number + node_id: string + text_matches?: components['schemas']['search-result-text-matches'] + } /** * Issue Search Result Item * @description Issue Search Result Item */ - "issue-search-result-item": { + 'issue-search-result-item': { /** Format: uri */ - url: string; + url: string /** Format: uri */ - repository_url: string; - labels_url: string; + repository_url: string + labels_url: string /** Format: uri */ - comments_url: string; + comments_url: string /** Format: uri */ - events_url: string; + events_url: string /** Format: uri */ - html_url: string; - id: number; - node_id: string; - number: number; - title: string; - locked: boolean; - active_lock_reason?: string | null; - assignees?: components["schemas"]["simple-user"][] | null; - user: components["schemas"]["nullable-simple-user"]; + html_url: string + id: number + node_id: string + number: number + title: string + locked: boolean + active_lock_reason?: string | null + assignees?: components['schemas']['simple-user'][] | null + user: components['schemas']['nullable-simple-user'] labels: { /** Format: int64 */ - id?: number; - node_id?: string; - url?: string; - name?: string; - color?: string; - default?: boolean; - description?: string | null; - }[]; - state: string; - assignee: components["schemas"]["nullable-simple-user"]; - milestone: components["schemas"]["nullable-milestone"]; - comments: number; + id?: number + node_id?: string + url?: string + name?: string + color?: string + default?: boolean + description?: string | null + }[] + state: string + assignee: components['schemas']['nullable-simple-user'] + milestone: components['schemas']['nullable-milestone'] + comments: number /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; + updated_at: string /** Format: date-time */ - closed_at: string | null; - text_matches?: components["schemas"]["search-result-text-matches"]; + closed_at: string | null + text_matches?: components['schemas']['search-result-text-matches'] pull_request?: { /** Format: date-time */ - merged_at?: string | null; + merged_at?: string | null /** Format: uri */ - diff_url: string | null; + diff_url: string | null /** Format: uri */ - html_url: string | null; + html_url: string | null /** Format: uri */ - patch_url: string | null; + patch_url: string | null /** Format: uri */ - url: string | null; - }; - body?: string; - score: number; - author_association: components["schemas"]["author_association"]; - draft?: boolean; - repository?: components["schemas"]["repository"]; - body_html?: string; - body_text?: string; + url: string | null + } + body?: string + score: number + author_association: components['schemas']['author_association'] + draft?: boolean + repository?: components['schemas']['repository'] + body_html?: string + body_text?: string /** Format: uri */ - timeline_url?: string; - performed_via_github_app?: components["schemas"]["nullable-integration"]; - reactions?: components["schemas"]["reaction-rollup"]; - }; + timeline_url?: string + performed_via_github_app?: components['schemas']['nullable-integration'] + reactions?: components['schemas']['reaction-rollup'] + } /** * Label Search Result Item * @description Label Search Result Item */ - "label-search-result-item": { - id: number; - node_id: string; + 'label-search-result-item': { + id: number + node_id: string /** Format: uri */ - url: string; - name: string; - color: string; - default: boolean; - description: string | null; - score: number; - text_matches?: components["schemas"]["search-result-text-matches"]; - }; + url: string + name: string + color: string + default: boolean + description: string | null + score: number + text_matches?: components['schemas']['search-result-text-matches'] + } /** * Repo Search Result Item * @description Repo Search Result Item */ - "repo-search-result-item": { - id: number; - node_id: string; - name: string; - full_name: string; - owner: components["schemas"]["nullable-simple-user"]; - private: boolean; + 'repo-search-result-item': { + id: number + node_id: string + name: string + full_name: string + owner: components['schemas']['nullable-simple-user'] + private: boolean /** Format: uri */ - html_url: string; - description: string | null; - fork: boolean; + html_url: string + description: string | null + fork: boolean /** Format: uri */ - url: string; + url: string /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; + updated_at: string /** Format: date-time */ - pushed_at: string; + pushed_at: string /** Format: uri */ - homepage: string | null; - size: number; - stargazers_count: number; - watchers_count: number; - language: string | null; - forks_count: number; - open_issues_count: number; - master_branch?: string; - default_branch: string; - score: number; + homepage: string | null + size: number + stargazers_count: number + watchers_count: number + language: string | null + forks_count: number + open_issues_count: number + master_branch?: string + default_branch: string + score: number /** Format: uri */ - forks_url: string; - keys_url: string; - collaborators_url: string; + forks_url: string + keys_url: string + collaborators_url: string /** Format: uri */ - teams_url: string; + teams_url: string /** Format: uri */ - hooks_url: string; - issue_events_url: string; + hooks_url: string + issue_events_url: string /** Format: uri */ - events_url: string; - assignees_url: string; - branches_url: string; + events_url: string + assignees_url: string + branches_url: string /** Format: uri */ - tags_url: string; - blobs_url: string; - git_tags_url: string; - git_refs_url: string; - trees_url: string; - statuses_url: string; + tags_url: string + blobs_url: string + git_tags_url: string + git_refs_url: string + trees_url: string + statuses_url: string /** Format: uri */ - languages_url: string; + languages_url: string /** Format: uri */ - stargazers_url: string; + stargazers_url: string /** Format: uri */ - contributors_url: string; + contributors_url: string /** Format: uri */ - subscribers_url: string; + subscribers_url: string /** Format: uri */ - subscription_url: string; - commits_url: string; - git_commits_url: string; - comments_url: string; - issue_comment_url: string; - contents_url: string; - compare_url: string; + subscription_url: string + commits_url: string + git_commits_url: string + comments_url: string + issue_comment_url: string + contents_url: string + compare_url: string /** Format: uri */ - merges_url: string; - archive_url: string; + merges_url: string + archive_url: string /** Format: uri */ - downloads_url: string; - issues_url: string; - pulls_url: string; - milestones_url: string; - notifications_url: string; - labels_url: string; - releases_url: string; + downloads_url: string + issues_url: string + pulls_url: string + milestones_url: string + notifications_url: string + labels_url: string + releases_url: string /** Format: uri */ - deployments_url: string; - git_url: string; - ssh_url: string; - clone_url: string; + deployments_url: string + git_url: string + ssh_url: string + clone_url: string /** Format: uri */ - svn_url: string; - forks: number; - open_issues: number; - watchers: number; - topics?: string[]; + svn_url: string + forks: number + open_issues: number + watchers: number + topics?: string[] /** Format: uri */ - mirror_url: string | null; - has_issues: boolean; - has_projects: boolean; - has_pages: boolean; - has_wiki: boolean; - has_downloads: boolean; - archived: boolean; + mirror_url: string | null + has_issues: boolean + has_projects: boolean + has_pages: boolean + has_wiki: boolean + has_downloads: boolean + archived: boolean /** @description Returns whether or not this repository disabled. */ - disabled: boolean; + disabled: boolean /** @description The repository visibility: public, private, or internal. */ - visibility?: string; - license: components["schemas"]["nullable-license-simple"]; + visibility?: string + license: components['schemas']['nullable-license-simple'] permissions?: { - admin: boolean; - maintain?: boolean; - push: boolean; - triage?: boolean; - pull: boolean; - }; - text_matches?: components["schemas"]["search-result-text-matches"]; - temp_clone_token?: string; - allow_merge_commit?: boolean; - allow_squash_merge?: boolean; - allow_rebase_merge?: boolean; - allow_auto_merge?: boolean; - delete_branch_on_merge?: boolean; - allow_forking?: boolean; - is_template?: boolean; - }; + admin: boolean + maintain?: boolean + push: boolean + triage?: boolean + pull: boolean + } + text_matches?: components['schemas']['search-result-text-matches'] + temp_clone_token?: string + allow_merge_commit?: boolean + allow_squash_merge?: boolean + allow_rebase_merge?: boolean + allow_auto_merge?: boolean + delete_branch_on_merge?: boolean + allow_forking?: boolean + is_template?: boolean + } /** * Topic Search Result Item * @description Topic Search Result Item */ - "topic-search-result-item": { - name: string; - display_name: string | null; - short_description: string | null; - description: string | null; - created_by: string | null; - released: string | null; + 'topic-search-result-item': { + name: string + display_name: string | null + short_description: string | null + description: string | null + created_by: string | null + released: string | null /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; - featured: boolean; - curated: boolean; - score: number; - repository_count?: number | null; + updated_at: string + featured: boolean + curated: boolean + score: number + repository_count?: number | null /** Format: uri */ - logo_url?: string | null; - text_matches?: components["schemas"]["search-result-text-matches"]; + logo_url?: string | null + text_matches?: components['schemas']['search-result-text-matches'] related?: | { topic_relation?: { - id?: number; - name?: string; - topic_id?: number; - relation_type?: string; - }; + id?: number + name?: string + topic_id?: number + relation_type?: string + } }[] - | null; + | null aliases?: | { topic_relation?: { - id?: number; - name?: string; - topic_id?: number; - relation_type?: string; - }; + id?: number + name?: string + topic_id?: number + relation_type?: string + } }[] - | null; - }; + | null + } /** * User Search Result Item * @description User Search Result Item */ - "user-search-result-item": { - login: string; - id: number; - node_id: string; + 'user-search-result-item': { + login: string + id: number + node_id: string /** Format: uri */ - avatar_url: string; - gravatar_id: string | null; + avatar_url: string + gravatar_id: string | null /** Format: uri */ - url: string; + url: string /** Format: uri */ - html_url: string; + html_url: string /** Format: uri */ - followers_url: string; + followers_url: string /** Format: uri */ - subscriptions_url: string; + subscriptions_url: string /** Format: uri */ - organizations_url: string; + organizations_url: string /** Format: uri */ - repos_url: string; + repos_url: string /** Format: uri */ - received_events_url: string; - type: string; - score: number; - following_url: string; - gists_url: string; - starred_url: string; - events_url: string; - public_repos?: number; - public_gists?: number; - followers?: number; - following?: number; + received_events_url: string + type: string + score: number + following_url: string + gists_url: string + starred_url: string + events_url: string + public_repos?: number + public_gists?: number + followers?: number + following?: number /** Format: date-time */ - created_at?: string; + created_at?: string /** Format: date-time */ - updated_at?: string; - name?: string | null; - bio?: string | null; + updated_at?: string + name?: string | null + bio?: string | null /** Format: email */ - email?: string | null; - location?: string | null; - site_admin: boolean; - hireable?: boolean | null; - text_matches?: components["schemas"]["search-result-text-matches"]; - blog?: string | null; - company?: string | null; + email?: string | null + location?: string | null + site_admin: boolean + hireable?: boolean | null + text_matches?: components['schemas']['search-result-text-matches'] + blog?: string | null + company?: string | null /** Format: date-time */ - suspended_at?: string | null; - }; + suspended_at?: string | null + } /** * Private User * @description Private User */ - "private-user": { + 'private-user': { /** @example octocat */ - login: string; + login: string /** @example 1 */ - id: number; + id: number /** @example MDQ6VXNlcjE= */ - node_id: string; + node_id: string /** * Format: uri * @example https://github.com/images/error/octocat_happy.gif */ - avatar_url: string; + avatar_url: string /** @example 41d064eb2195891e12d0413f63227ea7 */ - gravatar_id: string | null; + gravatar_id: string | null /** * Format: uri * @example https://api.github.com/users/octocat */ - url: string; + url: string /** * Format: uri * @example https://github.com/octocat */ - html_url: string; + html_url: string /** * Format: uri * @example https://api.github.com/users/octocat/followers */ - followers_url: string; + followers_url: string /** @example https://api.github.com/users/octocat/following{/other_user} */ - following_url: string; + following_url: string /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - gists_url: string; + gists_url: string /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - starred_url: string; + starred_url: string /** * Format: uri * @example https://api.github.com/users/octocat/subscriptions */ - subscriptions_url: string; + subscriptions_url: string /** * Format: uri * @example https://api.github.com/users/octocat/orgs */ - organizations_url: string; + organizations_url: string /** * Format: uri * @example https://api.github.com/users/octocat/repos */ - repos_url: string; + repos_url: string /** @example https://api.github.com/users/octocat/events{/privacy} */ - events_url: string; + events_url: string /** * Format: uri * @example https://api.github.com/users/octocat/received_events */ - received_events_url: string; + received_events_url: string /** @example User */ - type: string; - site_admin: boolean; + type: string + site_admin: boolean /** @example monalisa octocat */ - name: string | null; + name: string | null /** @example GitHub */ - company: string | null; + company: string | null /** @example https://github.com/blog */ - blog: string | null; + blog: string | null /** @example San Francisco */ - location: string | null; + location: string | null /** * Format: email * @example octocat@github.com */ - email: string | null; - hireable: boolean | null; + email: string | null + hireable: boolean | null /** @example There once was... */ - bio: string | null; + bio: string | null /** @example monalisa */ - twitter_username?: string | null; + twitter_username?: string | null /** @example 2 */ - public_repos: number; + public_repos: number /** @example 1 */ - public_gists: number; + public_gists: number /** @example 20 */ - followers: number; - following: number; + followers: number + following: number /** * Format: date-time * @example 2008-01-14T04:33:35Z */ - created_at: string; + created_at: string /** * Format: date-time * @example 2008-01-14T04:33:35Z */ - updated_at: string; + updated_at: string /** @example 81 */ - private_gists: number; + private_gists: number /** @example 100 */ - total_private_repos: number; + total_private_repos: number /** @example 100 */ - owned_private_repos: number; + owned_private_repos: number /** @example 10000 */ - disk_usage: number; + disk_usage: number /** @example 8 */ - collaborators: number; + collaborators: number /** @example true */ - two_factor_authentication: boolean; + two_factor_authentication: boolean plan?: { - collaborators: number; - name: string; - space: number; - private_repos: number; - }; + collaborators: number + name: string + space: number + private_repos: number + } /** Format: date-time */ - suspended_at?: string | null; - business_plus?: boolean; - ldap_dn?: string; - }; + suspended_at?: string | null + business_plus?: boolean + ldap_dn?: string + } /** * Codespaces Secret * @description Secrets for a GitHub Codespace. */ - "codespaces-secret": { + 'codespaces-secret': { /** * @description The name of the secret. * @example SECRET_NAME */ - name: string; + name: string /** Format: date-time */ - created_at: string; + created_at: string /** Format: date-time */ - updated_at: string; + updated_at: string /** * @description Visibility of a secret * @enum {string} */ - visibility: "all" | "private" | "selected"; + visibility: 'all' | 'private' | 'selected' /** * Format: uri * @example https://api.github.com/user/secrets/SECRET_NAME/repositories */ - selected_repositories_url: string; - }; + selected_repositories_url: string + } /** * CodespacesUserPublicKey * @description The public key used for setting user Codespaces' Secrets. */ - "codespaces-user-public-key": { + 'codespaces-user-public-key': { /** * @description The identifier for the key. * @example 1234567 */ - key_id: string; + key_id: string /** * @description The Base64 encoded public key. * @example hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= */ - key: string; - }; + key: string + } /** * Fetches information about an export of a codespace. * @description An export of a codespace. Also, latest export details for a codespace can be fetched with id = latest */ - "codespace-export-details": { + 'codespace-export-details': { /** * @description State of the latest export * @example succeeded | failed | in_progress */ - state?: string | null; + state?: string | null /** * Format: date-time * @description Completion time of the last export operation * @example 2021-01-01T19:01:12Z */ - completed_at?: string | null; + completed_at?: string | null /** * @description Name of the exported branch * @example codespace-monalisa-octocat-hello-world-g4wpq6h95q */ - branch?: string | null; + branch?: string | null /** * @description Git commit SHA of the exported branch * @example fd95a81ca01e48ede9f39c799ecbcef817b8a3b2 */ - sha?: string | null; + sha?: string | null /** * @description Id for the export details * @example latest */ - id?: string; + id?: string /** * @description Url for fetching export details * @example https://api.github.com/user/codespaces/:name/exports/latest */ - export_url?: string; - }; + export_url?: string + } /** * Email * @description Email @@ -17311,355 +17299,355 @@ export interface components { * Format: email * @example octocat@github.com */ - email: string; + email: string /** @example true */ - primary: boolean; + primary: boolean /** @example true */ - verified: boolean; + verified: boolean /** @example public */ - visibility: string | null; - }; + visibility: string | null + } /** * GPG Key * @description A unique encryption key */ - "gpg-key": { + 'gpg-key': { /** @example 3 */ - id: number; - primary_key_id: number | null; + id: number + primary_key_id: number | null /** @example 3262EFF25BA0D270 */ - key_id: string; + key_id: string /** @example xsBNBFayYZ... */ - public_key: string; + public_key: string /** @example [object Object] */ emails: { - email?: string; - verified?: boolean; - }[]; + email?: string + verified?: boolean + }[] /** @example [object Object] */ subkeys: { - id?: number; - primary_key_id?: number; - key_id?: string; - public_key?: string; - emails?: unknown[]; - subkeys?: unknown[]; - can_sign?: boolean; - can_encrypt_comms?: boolean; - can_encrypt_storage?: boolean; - can_certify?: boolean; - created_at?: string; - expires_at?: string | null; - raw_key?: string | null; - }[]; + id?: number + primary_key_id?: number + key_id?: string + public_key?: string + emails?: unknown[] + subkeys?: unknown[] + can_sign?: boolean + can_encrypt_comms?: boolean + can_encrypt_storage?: boolean + can_certify?: boolean + created_at?: string + expires_at?: string | null + raw_key?: string | null + }[] /** @example true */ - can_sign: boolean; - can_encrypt_comms: boolean; - can_encrypt_storage: boolean; + can_sign: boolean + can_encrypt_comms: boolean + can_encrypt_storage: boolean /** @example true */ - can_certify: boolean; + can_certify: boolean /** * Format: date-time * @example 2016-03-24T11:31:04-06:00 */ - created_at: string; + created_at: string /** Format: date-time */ - expires_at: string | null; - raw_key: string | null; - }; + expires_at: string | null + raw_key: string | null + } /** * Key * @description Key */ key: { - key: string; - id: number; - url: string; - title: string; + key: string + id: number + url: string + title: string /** Format: date-time */ - created_at: string; - verified: boolean; - read_only: boolean; - }; + created_at: string + verified: boolean + read_only: boolean + } /** Marketplace Account */ - "marketplace-account": { + 'marketplace-account': { /** Format: uri */ - url: string; - id: number; - type: string; - node_id?: string; - login: string; + url: string + id: number + type: string + node_id?: string + login: string /** Format: email */ - email?: string | null; + email?: string | null /** Format: email */ - organization_billing_email?: string | null; - }; + organization_billing_email?: string | null + } /** * User Marketplace Purchase * @description User Marketplace Purchase */ - "user-marketplace-purchase": { + 'user-marketplace-purchase': { /** @example monthly */ - billing_cycle: string; + billing_cycle: string /** * Format: date-time * @example 2017-11-11T00:00:00Z */ - next_billing_date: string | null; - unit_count: number | null; + next_billing_date: string | null + unit_count: number | null /** @example true */ - on_free_trial: boolean; + on_free_trial: boolean /** * Format: date-time * @example 2017-11-11T00:00:00Z */ - free_trial_ends_on: string | null; + free_trial_ends_on: string | null /** * Format: date-time * @example 2017-11-02T01:12:12Z */ - updated_at: string | null; - account: components["schemas"]["marketplace-account"]; - plan: components["schemas"]["marketplace-listing-plan"]; - }; + updated_at: string | null + account: components['schemas']['marketplace-account'] + plan: components['schemas']['marketplace-listing-plan'] + } /** * Starred Repository * @description Starred Repository */ - "starred-repository": { + 'starred-repository': { /** Format: date-time */ - starred_at: string; - repo: components["schemas"]["repository"]; - }; + starred_at: string + repo: components['schemas']['repository'] + } /** * Hovercard * @description Hovercard */ hovercard: { contexts: { - message: string; - octicon: string; - }[]; - }; + message: string + octicon: string + }[] + } /** * Key Simple * @description Key Simple */ - "key-simple": { - id: number; - key: string; - }; - }; + 'key-simple': { + id: number + key: string + } + } responses: { /** Resource not found */ not_found: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } /** Validation failed */ validation_failed_simple: { content: { - "application/json": components["schemas"]["validation-error-simple"]; - }; - }; + 'application/json': components['schemas']['validation-error-simple'] + } + } /** Bad Request */ bad_request: { content: { - "application/json": components["schemas"]["basic-error"]; - "application/scim+json": components["schemas"]["scim-error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + 'application/scim+json': components['schemas']['scim-error'] + } + } /** Validation failed */ validation_failed: { content: { - "application/json": components["schemas"]["validation-error"]; - }; - }; + 'application/json': components['schemas']['validation-error'] + } + } /** Accepted */ accepted: { content: { - "application/json": { [key: string]: unknown }; - }; - }; + 'application/json': { [key: string]: unknown } + } + } /** Preview header missing */ preview_header_missing: { content: { - "application/json": { - message: string; - documentation_url: string; - }; - }; - }; + 'application/json': { + message: string + documentation_url: string + } + } + } /** Forbidden */ forbidden: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } /** Requires authentication */ requires_authentication: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } /** Not modified */ - not_modified: unknown; + not_modified: unknown /** Gone */ gone: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } /** Response */ actions_runner_labels: { content: { - "application/json": { - total_count: number; - labels: components["schemas"]["runner-label"][]; - }; - }; - }; + 'application/json': { + total_count: number + labels: components['schemas']['runner-label'][] + } + } + } /** Response */ actions_runner_labels_readonly: { content: { - "application/json": { - total_count: number; - labels: components["schemas"]["runner-label"][]; - }; - }; - }; + 'application/json': { + total_count: number + labels: components['schemas']['runner-label'][] + } + } + } /** Service unavailable */ service_unavailable: { content: { - "application/json": { - code?: string; - message?: string; - documentation_url?: string; - }; - }; - }; + 'application/json': { + code?: string + message?: string + documentation_url?: string + } + } + } /** Response if GitHub Advanced Security is not enabled for this repository */ code_scanning_forbidden_read: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } /** Forbidden Gist */ forbidden_gist: { content: { - "application/json": { + 'application/json': { block?: { - reason?: string; - created_at?: string; - html_url?: string | null; - }; - message?: string; - documentation_url?: string; - }; - }; - }; + reason?: string + created_at?: string + html_url?: string | null + } + message?: string + documentation_url?: string + } + } + } /** Moved permanently */ moved_permanently: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } /** Conflict */ conflict: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } /** Temporary Redirect */ temporary_redirect: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } /** Internal Error */ internal_error: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } /** Response if the repository is archived or if github advanced security is not enabled for this repository */ code_scanning_forbidden_write: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } /** Found */ - found: unknown; + found: unknown /** A header with no content is returned. */ - no_content: unknown; + no_content: unknown /** Resource not found */ scim_not_found: { content: { - "application/json": components["schemas"]["scim-error"]; - "application/scim+json": components["schemas"]["scim-error"]; - }; - }; + 'application/json': components['schemas']['scim-error'] + 'application/scim+json': components['schemas']['scim-error'] + } + } /** Forbidden */ scim_forbidden: { content: { - "application/json": components["schemas"]["scim-error"]; - "application/scim+json": components["schemas"]["scim-error"]; - }; - }; + 'application/json': components['schemas']['scim-error'] + 'application/scim+json': components['schemas']['scim-error'] + } + } /** Bad Request */ scim_bad_request: { content: { - "application/json": components["schemas"]["scim-error"]; - "application/scim+json": components["schemas"]["scim-error"]; - }; - }; + 'application/json': components['schemas']['scim-error'] + 'application/scim+json': components['schemas']['scim-error'] + } + } /** Internal Error */ scim_internal_error: { content: { - "application/json": components["schemas"]["scim-error"]; - "application/scim+json": components["schemas"]["scim-error"]; - }; - }; + 'application/json': components['schemas']['scim-error'] + 'application/scim+json': components['schemas']['scim-error'] + } + } /** Conflict */ scim_conflict: { content: { - "application/json": components["schemas"]["scim-error"]; - "application/scim+json": components["schemas"]["scim-error"]; - }; - }; - }; + 'application/json': components['schemas']['scim-error'] + 'application/scim+json': components['schemas']['scim-error'] + } + } + } parameters: { /** @description Results per page (max 100) */ - "per-page": number; + 'per-page': number /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ - cursor: string; - "delivery-id": number; + cursor: string + 'delivery-id': number /** @description Page number of the results to fetch. */ - page: number; + page: number /** @description Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since: string; + since: string /** @description installation_id parameter */ - "installation-id": number; + 'installation-id': number /** @description grant_id parameter */ - "grant-id": number; + 'grant-id': number /** @description The client ID of your GitHub app. */ - "client-id": string; - "app-slug": string; + 'client-id': string + 'app-slug': string /** @description authorization_id parameter */ - "authorization-id": number; + 'authorization-id': number /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: string; + enterprise: string /** @description Unique identifier of an organization. */ - "org-id": number; + 'org-id': number /** @description Unique identifier of the self-hosted runner group. */ - "runner-group-id": number; + 'runner-group-id': number /** @description Unique identifier of the self-hosted runner. */ - "runner-id": number; + 'runner-id': number /** @description The name of a self-hosted runner's custom label. */ - "runner-label-name": string; + 'runner-label-name': string /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). */ - "audit-log-phrase": string; + 'audit-log-phrase': string /** * @description The event types to include: * @@ -17669,843 +17657,843 @@ export interface components { * * The default is `web`. */ - "audit-log-include": "web" | "git" | "all"; + 'audit-log-include': 'web' | 'git' | 'all' /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor. */ - "audit-log-after": string; + 'audit-log-after': string /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor. */ - "audit-log-before": string; + 'audit-log-before': string /** * @description The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. * * The default is `desc`. */ - "audit-log-order": "desc" | "asc"; + 'audit-log-order': 'desc' | 'asc' /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - "secret-scanning-alert-state": "open" | "resolved"; + 'secret-scanning-alert-state': 'open' | 'resolved' /** * @description A comma-separated list of secret types to return. By default all secret types are returned. * See "[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)" * for a complete list of secret types (API slug). */ - "secret-scanning-alert-secret-type": string; + 'secret-scanning-alert-secret-type': string /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - "secret-scanning-alert-resolution": string; + 'secret-scanning-alert-resolution': string /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor. */ - "pagination-before": string; + 'pagination-before': string /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor. */ - "pagination-after": string; + 'pagination-after': string /** @description gist_id parameter */ - "gist-id": string; + 'gist-id': string /** @description comment_id parameter */ - "comment-id": number; + 'comment-id': number /** @description A list of comma separated label names. Example: `bug,ui,@high` */ - labels: string; + labels: string /** @description One of `asc` (ascending) or `desc` (descending). */ - direction: "asc" | "desc"; + direction: 'asc' | 'desc' /** @description account_id parameter */ - "account-id": number; + 'account-id': number /** @description plan_id parameter */ - "plan-id": number; + 'plan-id': number /** @description One of `created` (when the repository was starred) or `updated` (when it was last pushed to). */ - sort: "created" | "updated"; - owner: string; - repo: string; + sort: 'created' | 'updated' + owner: string + repo: string /** @description If `true`, show notifications marked as read. */ - all: boolean; + all: boolean /** @description If `true`, only shows notifications in which the user is directly participating or mentioned. */ - participating: boolean; + participating: boolean /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - before: string; + before: string /** @description thread_id parameter */ - "thread-id": number; + 'thread-id': number /** @description An organization ID. Only return organizations with an ID greater than this ID. */ - "since-org": number; - org: string; + 'since-org': number + org: string /** @description team_slug parameter */ - "team-slug": string; - "repository-id": number; + 'team-slug': string + 'repository-id': number /** @description secret_name parameter */ - "secret-name": string; - username: string; + 'secret-name': string + username: string /** @description group_id parameter */ - "group-id": number; - "hook-id": number; + 'group-id': number + 'hook-id': number /** @description invitation_id parameter */ - "invitation-id": number; + 'invitation-id': number /** @description migration_id parameter */ - "migration-id": number; + 'migration-id': number /** @description repo_name parameter */ - "repo-name": string; + 'repo-name': string /** @description The selected visibility of the packages. Can be one of `public`, `private`, or `internal`. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set. */ - "package-visibility": "public" | "private" | "internal"; + 'package-visibility': 'public' | 'private' | 'internal' /** @description The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - "package-type": "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + 'package-type': 'npm' | 'maven' | 'rubygems' | 'docker' | 'nuget' | 'container' /** @description The name of the package. */ - "package-name": string; + 'package-name': string /** @description Unique identifier of the package version. */ - "package-version-id": number; - "discussion-number": number; - "comment-number": number; - "reaction-id": number; - "project-id": number; + 'package-version-id': number + 'discussion-number': number + 'comment-number': number + 'reaction-id': number + 'project-id': number /** @description card_id parameter */ - "card-id": number; + 'card-id': number /** @description column_id parameter */ - "column-id": number; + 'column-id': number /** @description artifact_id parameter */ - "artifact-id": number; + 'artifact-id': number /** @description job_id parameter */ - "job-id": number; + 'job-id': number /** @description Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ - actor: string; + actor: string /** @description Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ - "workflow-run-branch": string; + 'workflow-run-branch': string /** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ - event: string; + event: string /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. For a list of the possible `status` and `conclusion` options, see "[Create a check run](https://docs.github.com/rest/reference/checks#create-a-check-run)." */ - "workflow-run-status": - | "completed" - | "action_required" - | "cancelled" - | "failure" - | "neutral" - | "skipped" - | "stale" - | "success" - | "timed_out" - | "in_progress" - | "queued" - | "requested" - | "waiting"; + 'workflow-run-status': + | 'completed' + | 'action_required' + | 'cancelled' + | 'failure' + | 'neutral' + | 'skipped' + | 'stale' + | 'success' + | 'timed_out' + | 'in_progress' + | 'queued' + | 'requested' + | 'waiting' /** @description Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ - created: string; + created: string /** @description If `true` pull requests are omitted from the response (empty array). */ - "exclude-pull-requests": boolean; + 'exclude-pull-requests': boolean /** @description Returns workflow runs with the `check_suite_id` that you specify. */ - "workflow-run-check-suite-id": number; + 'workflow-run-check-suite-id': number /** @description The id of the workflow run. */ - "run-id": number; + 'run-id': number /** @description The attempt number of the workflow run. */ - "attempt-number": number; + 'attempt-number': number /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ - "workflow-id": number | string; + 'workflow-id': number | string /** @description autolink_id parameter */ - "autolink-id": number; + 'autolink-id': number /** @description The name of the branch. */ - branch: string; + branch: string /** @description check_run_id parameter */ - "check-run-id": number; + 'check-run-id': number /** @description check_suite_id parameter */ - "check-suite-id": number; + 'check-suite-id': number /** @description Returns check runs with the specified `name`. */ - "check-name": string; + 'check-name': string /** @description Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`. */ - status: "queued" | "in_progress" | "completed"; + status: 'queued' | 'in_progress' | 'completed' /** @description The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */ - "tool-name": components["schemas"]["code-scanning-analysis-tool-name"]; + 'tool-name': components['schemas']['code-scanning-analysis-tool-name'] /** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ - "tool-guid": components["schemas"]["code-scanning-analysis-tool-guid"]; + 'tool-guid': components['schemas']['code-scanning-analysis-tool-guid'] /** @description The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ - "git-ref": components["schemas"]["code-scanning-ref"]; + 'git-ref': components['schemas']['code-scanning-ref'] /** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ - "alert-number": components["schemas"]["alert-number"]; + 'alert-number': components['schemas']['alert-number'] /** @description commit_sha parameter */ - "commit-sha": string; + 'commit-sha': string /** @description deployment_id parameter */ - "deployment-id": number; + 'deployment-id': number /** @description The name of the environment */ - "environment-name": string; + 'environment-name': string /** @description A user ID. Only return users with an ID greater than this ID. */ - "since-user": number; + 'since-user': number /** @description issue_number parameter */ - "issue-number": number; + 'issue-number': number /** @description key_id parameter */ - "key-id": number; + 'key-id': number /** @description milestone_number parameter */ - "milestone-number": number; - "pull-number": number; + 'milestone-number': number + 'pull-number': number /** @description review_id parameter */ - "review-id": number; + 'review-id': number /** @description asset_id parameter */ - "asset-id": number; + 'asset-id': number /** @description release_id parameter */ - "release-id": number; + 'release-id': number /** @description Must be one of: `day`, `week`. */ - per: "" | "day" | "week"; + per: '' | 'day' | 'week' /** @description A repository ID. Only return repositories with an ID greater than this ID. */ - "since-repo": number; + 'since-repo': number /** @description Used for pagination: the index of the first result to return. */ - "start-index": number; + 'start-index': number /** @description Used for pagination: the number of results to return. */ - count: number; + count: number /** @description Identifier generated by the GitHub SCIM endpoint. */ - "scim-group-id": string; + 'scim-group-id': string /** @description scim_user_id parameter */ - "scim-user-id": string; + 'scim-user-id': string /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - order: "desc" | "asc"; - "team-id": number; + order: 'desc' | 'asc' + 'team-id': number /** @description ID of the Repository to filter on */ - "repository-id-in-query": number; + 'repository-id-in-query': number /** @description The name of the codespace. */ - "codespace-name": string; + 'codespace-name': string /** @description The ID of the export operation, or `latest`. Currently only `latest` is currently supported. */ - "export-id": string; + 'export-id': string /** @description gpg_key_id parameter */ - "gpg-key-id": number; - }; + 'gpg-key-id': number + } headers: { - link?: string; - "content-type"?: string; - "x-common-marker-version"?: string; - "x-rate-limit-limit"?: number; - "x-rate-limit-remaining"?: number; - "x-rate-limit-reset"?: number; - location?: string; - }; + link?: string + 'content-type'?: string + 'x-common-marker-version'?: string + 'x-rate-limit-limit'?: number + 'x-rate-limit-remaining'?: number + 'x-rate-limit-reset'?: number + location?: string + } } export interface operations { /** Get Hypermedia links to resources accessible in GitHub's REST API */ - "meta/root": { + 'meta/root': { responses: { /** Response */ 200: { content: { - "application/json": { + 'application/json': { /** Format: uri-template */ - current_user_url: string; + current_user_url: string /** Format: uri-template */ - current_user_authorizations_html_url: string; + current_user_authorizations_html_url: string /** Format: uri-template */ - authorizations_url: string; + authorizations_url: string /** Format: uri-template */ - code_search_url: string; + code_search_url: string /** Format: uri-template */ - commit_search_url: string; + commit_search_url: string /** Format: uri-template */ - emails_url: string; + emails_url: string /** Format: uri-template */ - emojis_url: string; + emojis_url: string /** Format: uri-template */ - events_url: string; + events_url: string /** Format: uri-template */ - feeds_url: string; + feeds_url: string /** Format: uri-template */ - followers_url: string; + followers_url: string /** Format: uri-template */ - following_url: string; + following_url: string /** Format: uri-template */ - gists_url: string; + gists_url: string /** Format: uri-template */ - hub_url: string; + hub_url: string /** Format: uri-template */ - issue_search_url: string; + issue_search_url: string /** Format: uri-template */ - issues_url: string; + issues_url: string /** Format: uri-template */ - keys_url: string; + keys_url: string /** Format: uri-template */ - label_search_url: string; + label_search_url: string /** Format: uri-template */ - notifications_url: string; + notifications_url: string /** Format: uri-template */ - organization_url: string; + organization_url: string /** Format: uri-template */ - organization_repositories_url: string; + organization_repositories_url: string /** Format: uri-template */ - organization_teams_url: string; + organization_teams_url: string /** Format: uri-template */ - public_gists_url: string; + public_gists_url: string /** Format: uri-template */ - rate_limit_url: string; + rate_limit_url: string /** Format: uri-template */ - repository_url: string; + repository_url: string /** Format: uri-template */ - repository_search_url: string; + repository_search_url: string /** Format: uri-template */ - current_user_repositories_url: string; + current_user_repositories_url: string /** Format: uri-template */ - starred_url: string; + starred_url: string /** Format: uri-template */ - starred_gists_url: string; + starred_gists_url: string /** Format: uri-template */ - topic_search_url?: string; + topic_search_url?: string /** Format: uri-template */ - user_url: string; + user_url: string /** Format: uri-template */ - user_organizations_url: string; + user_organizations_url: string /** Format: uri-template */ - user_repositories_url: string; + user_repositories_url: string /** Format: uri-template */ - user_search_url: string; - }; - }; - }; - }; - }; + user_search_url: string + } + } + } + } + } /** * Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/rest/reference/apps#list-installations-for-the-authenticated-app)" endpoint. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/get-authenticated": { - parameters: {}; + 'apps/get-authenticated': { + parameters: {} responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["integration"]; - }; - }; - }; - }; + 'application/json': components['schemas']['integration'] + } + } + } + } /** Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. */ - "apps/create-from-manifest": { + 'apps/create-from-manifest': { parameters: { path: { - code: string; - }; - }; + code: string + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["integration"] & + 'application/json': components['schemas']['integration'] & ({ - client_id: string; - client_secret: string; - webhook_secret: string | null; - pem: string; - } & { [key: string]: unknown }); - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + client_id: string + client_secret: string + webhook_secret: string | null + pem: string + } & { [key: string]: unknown }) + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { [key: string]: unknown }; - }; - }; - }; + 'application/json': { [key: string]: unknown } + } + } + } /** * Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/get-webhook-config-for-app": { + 'apps/get-webhook-config-for-app': { responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["webhook-config"]; - }; - }; - }; - }; + 'application/json': components['schemas']['webhook-config'] + } + } + } + } /** * Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/update-webhook-config-for-app": { + 'apps/update-webhook-config-for-app': { responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["webhook-config"]; - }; - }; - }; + 'application/json': components['schemas']['webhook-config'] + } + } + } requestBody: { content: { - "application/json": { - url?: components["schemas"]["webhook-config-url"]; - content_type?: components["schemas"]["webhook-config-content-type"]; - secret?: components["schemas"]["webhook-config-secret"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - }; - }; - }; - }; + 'application/json': { + url?: components['schemas']['webhook-config-url'] + content_type?: components['schemas']['webhook-config-content-type'] + secret?: components['schemas']['webhook-config-secret'] + insecure_ssl?: components['schemas']['webhook-config-insecure-ssl'] + } + } + } + } /** * Returns a list of webhook deliveries for the webhook configured for a GitHub App. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/list-webhook-deliveries": { + 'apps/list-webhook-deliveries': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ - cursor?: components["parameters"]["cursor"]; - }; - }; + cursor?: components['parameters']['cursor'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["hook-delivery-item"][]; - }; - }; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['hook-delivery-item'][] + } + } + 400: components['responses']['bad_request'] + 422: components['responses']['validation_failed'] + } + } /** * Returns a delivery for the webhook configured for a GitHub App. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/get-webhook-delivery": { + 'apps/get-webhook-delivery': { parameters: { path: { - delivery_id: components["parameters"]["delivery-id"]; - }; - }; + delivery_id: components['parameters']['delivery-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["hook-delivery"]; - }; - }; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['hook-delivery'] + } + } + 400: components['responses']['bad_request'] + 422: components['responses']['validation_failed'] + } + } /** * Redeliver a delivery for the webhook configured for a GitHub App. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/redeliver-webhook-delivery": { + 'apps/redeliver-webhook-delivery': { parameters: { path: { - delivery_id: components["parameters"]["delivery-id"]; - }; - }; + delivery_id: components['parameters']['delivery-id'] + } + } responses: { - 202: components["responses"]["accepted"]; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 202: components['responses']['accepted'] + 400: components['responses']['bad_request'] + 422: components['responses']['validation_failed'] + } + } /** * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. * * The permissions the installation has are included under the `permissions` key. */ - "apps/list-installations": { + 'apps/list-installations': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; - outdated?: string; - }; - }; + since?: components['parameters']['since'] + outdated?: string + } + } responses: { /** The permissions the installation has are included under the `permissions` key. */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["installation"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['installation'][] + } + } + } + } /** * Enables an authenticated GitHub App to find an installation's information using the installation id. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/get-installation": { + 'apps/get-installation': { parameters: { path: { /** installation_id parameter */ - installation_id: components["parameters"]["installation-id"]; - }; - }; + installation_id: components['parameters']['installation-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["installation"]; - }; - }; - 404: components["responses"]["not_found"]; - 415: components["responses"]["preview_header_missing"]; - }; - }; + 'application/json': components['schemas']['installation'] + } + } + 404: components['responses']['not_found'] + 415: components['responses']['preview_header_missing'] + } + } /** * Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/reference/apps/#suspend-an-app-installation)" endpoint. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/delete-installation": { + 'apps/delete-installation': { parameters: { path: { /** installation_id parameter */ - installation_id: components["parameters"]["installation-id"]; - }; - }; + installation_id: components['parameters']['installation-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** * Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/create-installation-access-token": { + 'apps/create-installation-access-token': { parameters: { path: { /** installation_id parameter */ - installation_id: components["parameters"]["installation-id"]; - }; - }; + installation_id: components['parameters']['installation-id'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["installation-token"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 415: components["responses"]["preview_header_missing"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['installation-token'] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 415: components['responses']['preview_header_missing'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description List of repository names that the token should have access to */ - repositories?: string[]; + repositories?: string[] /** * @description List of repository IDs that the token should have access to * @example 1 */ - repository_ids?: number[]; - permissions?: components["schemas"]["app-permissions"]; - }; - }; - }; - }; + repository_ids?: number[] + permissions?: components['schemas']['app-permissions'] + } + } + } + } /** * Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/suspend-installation": { + 'apps/suspend-installation': { parameters: { path: { /** installation_id parameter */ - installation_id: components["parameters"]["installation-id"]; - }; - }; + installation_id: components['parameters']['installation-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** * Removes a GitHub App installation suspension. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/unsuspend-installation": { + 'apps/unsuspend-installation': { parameters: { path: { /** installation_id parameter */ - installation_id: components["parameters"]["installation-id"]; - }; - }; + installation_id: components['parameters']['installation-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * * You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/rest/reference/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `["repo", "user"]`. */ - "oauth-authorizations/list-grants": { + 'oauth-authorizations/list-grants': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** The client ID of your GitHub app. */ - client_id?: string; - }; - }; + client_id?: string + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["application-grant"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['application-grant'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - "oauth-authorizations/get-grant": { + 'oauth-authorizations/get-grant': { parameters: { path: { /** grant_id parameter */ - grant_id: components["parameters"]["grant-id"]; - }; - }; + grant_id: components['parameters']['grant-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["application-grant"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['application-grant'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ - "oauth-authorizations/delete-grant": { + 'oauth-authorizations/delete-grant': { parameters: { path: { /** grant_id parameter */ - grant_id: components["parameters"]["grant-id"]; - }; - }; + grant_id: components['parameters']['grant-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** * OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ - "apps/delete-authorization": { + 'apps/delete-authorization': { parameters: { path: { /** The client ID of your GitHub app. */ - client_id: components["parameters"]["client-id"]; - }; - }; + client_id: components['parameters']['client-id'] + } + } responses: { /** Response */ - 204: never; - 422: components["responses"]["validation_failed"]; - }; + 204: never + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The OAuth access token used to authenticate to the GitHub API. */ - access_token: string; - }; - }; - }; - }; + access_token: string + } + } + } + } /** OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the OAuth application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`. */ - "apps/check-token": { + 'apps/check-token': { parameters: { path: { /** The client ID of your GitHub app. */ - client_id: components["parameters"]["client-id"]; - }; - }; + client_id: components['parameters']['client-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["authorization"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['authorization'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The access_token of the OAuth application. */ - access_token: string; - }; - }; - }; - }; + access_token: string + } + } + } + } /** OAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. */ - "apps/delete-token": { + 'apps/delete-token': { parameters: { path: { /** The client ID of your GitHub app. */ - client_id: components["parameters"]["client-id"]; - }; - }; + client_id: components['parameters']['client-id'] + } + } responses: { /** Response */ - 204: never; - 422: components["responses"]["validation_failed"]; - }; + 204: never + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The OAuth access token used to authenticate to the GitHub API. */ - access_token: string; - }; - }; - }; - }; + access_token: string + } + } + } + } /** OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. */ - "apps/reset-token": { + 'apps/reset-token': { parameters: { path: { /** The client ID of your GitHub app. */ - client_id: components["parameters"]["client-id"]; - }; - }; + client_id: components['parameters']['client-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["authorization"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['authorization'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The access_token of the OAuth application. */ - access_token: string; - }; - }; - }; - }; + access_token: string + } + } + } + } /** Use a non-scoped user-to-server OAuth access token to create a repository scoped and/or permission scoped user-to-server OAuth access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. */ - "apps/scope-token": { + 'apps/scope-token': { parameters: { path: { /** The client ID of your GitHub app. */ - client_id: components["parameters"]["client-id"]; - }; - }; + client_id: components['parameters']['client-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["authorization"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['authorization'] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The OAuth access token used to authenticate to the GitHub API. * @example e72e16c7e42f292c6912e7710c838347ae178b4a */ - access_token: string; + access_token: string /** * @description The name of the user or organization to scope the user-to-server access token to. **Required** unless `target_id` is specified. * @example octocat */ - target?: string; + target?: string /** * @description The ID of the user or organization to scope the user-to-server access token to. **Required** unless `target` is specified. * @example 1 */ - target_id?: number; + target_id?: number /** @description The list of repository names to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified. */ - repositories?: string[]; + repositories?: string[] /** * @description The list of repository IDs to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified. * @example 1 */ - repository_ids?: number[]; - permissions?: components["schemas"]["app-permissions"]; - }; - }; - }; - }; + repository_ids?: number[] + permissions?: components['schemas']['app-permissions'] + } + } + } + } /** * **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). * * If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ - "apps/get-by-slug": { + 'apps/get-by-slug': { parameters: { path: { - app_slug: components["parameters"]["app-slug"]; - }; - }; + app_slug: components['parameters']['app-slug'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["integration"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 415: components["responses"]["preview_header_missing"]; - }; - }; + 'application/json': components['schemas']['integration'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 415: components['responses']['preview_header_missing'] + } + } /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - "oauth-authorizations/list-authorizations": { + 'oauth-authorizations/list-authorizations': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** The client ID of your GitHub app. */ - client_id?: string; - }; - }; + client_id?: string + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["authorization"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['authorization'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * @@ -18519,49 +18507,49 @@ export interface operations { * * Organizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in [the GitHub Help documentation](https://docs.github.com/articles/about-identity-and-access-management-with-saml-single-sign-on). */ - "oauth-authorizations/create-authorization": { - parameters: {}; + 'oauth-authorizations/create-authorization': { + parameters: {} responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["authorization"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['authorization'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 410: components['responses']['gone'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description A list of scopes that this authorization is in. * @example public_repo,user */ - scopes?: string[] | null; + scopes?: string[] | null /** * @description A note to remind you what the OAuth token is for. * @example Update all gems */ - note?: string; + note?: string /** @description A URL to remind you what app the OAuth token is for. */ - note_url?: string; + note_url?: string /** @description The OAuth app client key for which to create the token. */ - client_id?: string; + client_id?: string /** @description The OAuth app client secret for which to create the token. */ - client_secret?: string; + client_secret?: string /** @description A unique string to distinguish an authorization from others created for the same client ID and user. */ - fingerprint?: string; - }; - }; - }; - }; + fingerprint?: string + } + } + } + } /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * @@ -18573,60 +18561,60 @@ export interface operations { * * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - "oauth-authorizations/get-or-create-authorization-for-app": { + 'oauth-authorizations/get-or-create-authorization-for-app': { parameters: { path: { /** The client ID of your GitHub app. */ - client_id: components["parameters"]["client-id"]; - }; - }; + client_id: components['parameters']['client-id'] + } + } responses: { /** if returning an existing token */ 200: { headers: { - Location?: string; - }; + Location?: string + } content: { - "application/json": components["schemas"]["authorization"]; - }; - }; + 'application/json': components['schemas']['authorization'] + } + } /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["authorization"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['authorization'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The OAuth app client secret for which to create the token. */ - client_secret: string; + client_secret: string /** * @description A list of scopes that this authorization is in. * @example public_repo,user */ - scopes?: string[] | null; + scopes?: string[] | null /** * @description A note to remind you what the OAuth token is for. * @example Update all gems */ - note?: string; + note?: string /** @description A URL to remind you what app the OAuth token is for. */ - note_url?: string; + note_url?: string /** @description A unique string to distinguish an authorization from others created for the same client ID and user. */ - fingerprint?: string; - }; - }; - }; - }; + fingerprint?: string + } + } + } + } /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * @@ -18636,92 +18624,92 @@ export interface operations { * * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." */ - "oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint": { + 'oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint': { parameters: { path: { /** The client ID of your GitHub app. */ - client_id: components["parameters"]["client-id"]; - fingerprint: string; - }; - }; + client_id: components['parameters']['client-id'] + fingerprint: string + } + } responses: { /** if returning an existing token */ 200: { headers: { - Location?: string; - }; + Location?: string + } content: { - "application/json": components["schemas"]["authorization"]; - }; - }; + 'application/json': components['schemas']['authorization'] + } + } /** Response if returning a new token */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["authorization"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['authorization'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The OAuth app client secret for which to create the token. */ - client_secret: string; + client_secret: string /** * @description A list of scopes that this authorization is in. * @example public_repo,user */ - scopes?: string[] | null; + scopes?: string[] | null /** * @description A note to remind you what the OAuth token is for. * @example Update all gems */ - note?: string; + note?: string /** @description A URL to remind you what app the OAuth token is for. */ - note_url?: string; - }; - }; - }; - }; + note_url?: string + } + } + } + } /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - "oauth-authorizations/get-authorization": { + 'oauth-authorizations/get-authorization': { parameters: { path: { /** authorization_id parameter */ - authorization_id: components["parameters"]["authorization-id"]; - }; - }; + authorization_id: components['parameters']['authorization-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["authorization"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['authorization'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ - "oauth-authorizations/delete-authorization": { + 'oauth-authorizations/delete-authorization': { parameters: { path: { /** authorization_id parameter */ - authorization_id: components["parameters"]["authorization-id"]; - }; - }; + authorization_id: components['parameters']['authorization-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * @@ -18729,678 +18717,678 @@ export interface operations { * * You can only send one of these scope keys at a time. */ - "oauth-authorizations/update-authorization": { + 'oauth-authorizations/update-authorization': { parameters: { path: { /** authorization_id parameter */ - authorization_id: components["parameters"]["authorization-id"]; - }; - }; + authorization_id: components['parameters']['authorization-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["authorization"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['authorization'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description A list of scopes that this authorization is in. * @example public_repo,user */ - scopes?: string[] | null; + scopes?: string[] | null /** @description A list of scopes to add to this authorization. */ - add_scopes?: string[]; + add_scopes?: string[] /** @description A list of scopes to remove from this authorization. */ - remove_scopes?: string[]; + remove_scopes?: string[] /** * @description A note to remind you what the OAuth token is for. * @example Update all gems */ - note?: string; + note?: string /** @description A URL to remind you what app the OAuth token is for. */ - note_url?: string; + note_url?: string /** @description A unique string to distinguish an authorization from others created for the same client ID and user. */ - fingerprint?: string; - }; - }; - }; - }; - "codes-of-conduct/get-all-codes-of-conduct": { - parameters: {}; + fingerprint?: string + } + } + } + } + 'codes-of-conduct/get-all-codes-of-conduct': { + parameters: {} responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["code-of-conduct"][]; - }; - }; - 304: components["responses"]["not_modified"]; - }; - }; - "codes-of-conduct/get-conduct-code": { + 'application/json': components['schemas']['code-of-conduct'][] + } + } + 304: components['responses']['not_modified'] + } + } + 'codes-of-conduct/get-conduct-code': { parameters: { path: { - key: string; - }; - }; + key: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["code-of-conduct"]; - }; - }; - 304: components["responses"]["not_modified"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['code-of-conduct'] + } + } + 304: components['responses']['not_modified'] + 404: components['responses']['not_found'] + } + } /** Lists all the emojis available to use on GitHub. */ - "emojis/get": { - parameters: {}; + 'emojis/get': { + parameters: {} responses: { /** Response */ 200: { content: { - "application/json": { [key: string]: string }; - }; - }; - 304: components["responses"]["not_modified"]; - }; - }; + 'application/json': { [key: string]: string } + } + } + 304: components['responses']['not_modified'] + } + } /** * Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - "enterprise-admin/get-github-actions-permissions-enterprise": { + 'enterprise-admin/get-github-actions-permissions-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-enterprise-permissions"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-enterprise-permissions'] + } + } + } + } /** * Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - "enterprise-admin/set-github-actions-permissions-enterprise": { + 'enterprise-admin/set-github-actions-permissions-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { - enabled_organizations: components["schemas"]["enabled-organizations"]; - allowed_actions?: components["schemas"]["allowed-actions"]; - }; - }; - }; - }; + 'application/json': { + enabled_organizations: components['schemas']['enabled-organizations'] + allowed_actions?: components['schemas']['allowed-actions'] + } + } + } + } /** * Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - "enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise": { + 'enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; + enterprise: components['parameters']['enterprise'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - organizations: components["schemas"]["organization-simple"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + organizations: components['schemas']['organization-simple'][] + } + } + } + } + } /** * Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - "enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise": { + 'enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description List of organization IDs to enable for GitHub Actions. */ - selected_organization_ids: number[]; - }; - }; - }; - }; + selected_organization_ids: number[] + } + } + } + } /** * Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - "enterprise-admin/enable-selected-organization-github-actions-enterprise": { + 'enterprise-admin/enable-selected-organization-github-actions-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of an organization. */ - org_id: components["parameters"]["org-id"]; - }; - }; + org_id: components['parameters']['org-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - "enterprise-admin/disable-selected-organization-github-actions-enterprise": { + 'enterprise-admin/disable-selected-organization-github-actions-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of an organization. */ - org_id: components["parameters"]["org-id"]; - }; - }; + org_id: components['parameters']['org-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - "enterprise-admin/get-allowed-actions-enterprise": { + 'enterprise-admin/get-allowed-actions-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["selected-actions"]; - }; - }; - }; - }; + 'application/json': components['schemas']['selected-actions'] + } + } + } + } /** * Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ - "enterprise-admin/set-allowed-actions-enterprise": { + 'enterprise-admin/set-allowed-actions-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": components["schemas"]["selected-actions"]; - }; - }; - }; + 'application/json': components['schemas']['selected-actions'] + } + } + } /** * Lists all self-hosted runner groups for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/list-self-hosted-runner-groups-for-enterprise": { + 'enterprise-admin/list-self-hosted-runner-groups-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; + enterprise: components['parameters']['enterprise'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - runner_groups: components["schemas"]["runner-groups-enterprise"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + runner_groups: components['schemas']['runner-groups-enterprise'][] + } + } + } + } + } /** * Creates a new self-hosted runner group for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/create-self-hosted-runner-group-for-enterprise": { + 'enterprise-admin/create-self-hosted-runner-group-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["runner-groups-enterprise"]; - }; - }; - }; + 'application/json': components['schemas']['runner-groups-enterprise'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Name of the runner group. */ - name: string; + name: string /** * @description Visibility of a runner group. You can select all organizations or select individual organization. Can be one of: `all` or `selected` * @enum {string} */ - visibility?: "selected" | "all"; + visibility?: 'selected' | 'all' /** @description List of organization IDs that can access the runner group. */ - selected_organization_ids?: number[]; + selected_organization_ids?: number[] /** @description List of runner IDs to add to the runner group. */ - runners?: number[]; + runners?: number[] /** @description Whether the runner group can be used by `public` repositories. */ - allows_public_repositories?: boolean; - }; - }; - }; - }; + allows_public_repositories?: boolean + } + } + } + } /** * Gets a specific self-hosted runner group for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/get-self-hosted-runner-group-for-enterprise": { + 'enterprise-admin/get-self-hosted-runner-group-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["runner-groups-enterprise"]; - }; - }; - }; - }; + 'application/json': components['schemas']['runner-groups-enterprise'] + } + } + } + } /** * Deletes a self-hosted runner group for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/delete-self-hosted-runner-group-from-enterprise": { + 'enterprise-admin/delete-self-hosted-runner-group-from-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Updates the `name` and `visibility` of a self-hosted runner group in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/update-self-hosted-runner-group-for-enterprise": { + 'enterprise-admin/update-self-hosted-runner-group-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["runner-groups-enterprise"]; - }; - }; - }; + 'application/json': components['schemas']['runner-groups-enterprise'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Name of the runner group. */ - name?: string; + name?: string /** * @description Visibility of a runner group. You can select all organizations or select individual organizations. Can be one of: `all` or `selected` * @default all * @enum {string} */ - visibility?: "selected" | "all"; + visibility?: 'selected' | 'all' /** @description Whether the runner group can be used by `public` repositories. */ - allows_public_repositories?: boolean; - }; - }; - }; - }; + allows_public_repositories?: boolean + } + } + } + } /** * Lists the organizations with access to a self-hosted runner group. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise": { + 'enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; + runner_group_id: components['parameters']['runner-group-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - organizations: components["schemas"]["organization-simple"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + organizations: components['schemas']['organization-simple'][] + } + } + } + } + } /** * Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise": { + 'enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description List of organization IDs that can access the runner group. */ - selected_organization_ids: number[]; - }; - }; - }; - }; + selected_organization_ids: number[] + } + } + } + } /** * Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise": { + 'enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components['parameters']['runner-group-id'] /** Unique identifier of an organization. */ - org_id: components["parameters"]["org-id"]; - }; - }; + org_id: components['parameters']['org-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise": { + 'enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components['parameters']['runner-group-id'] /** Unique identifier of an organization. */ - org_id: components["parameters"]["org-id"]; - }; - }; + org_id: components['parameters']['org-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Lists the self-hosted runners that are in a specific enterprise group. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise": { + 'enterprise-admin/list-self-hosted-runners-in-group-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; + runner_group_id: components['parameters']['runner-group-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - runners: components["schemas"]["runner"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + runners: components['schemas']['runner'][] + } + } + } + } + } /** * Replaces the list of self-hosted runners that are part of an enterprise runner group. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise": { + 'enterprise-admin/set-self-hosted-runners-in-group-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description List of runner IDs to add to the runner group. */ - runners: number[]; - }; - }; - }; - }; + runners: number[] + } + } + } + } /** * Adds a self-hosted runner to a runner group configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` * scope to use this endpoint. */ - "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise": { + 'enterprise-admin/add-self-hosted-runner-to-group-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components['parameters']['runner-group-id'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise": { + 'enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components['parameters']['runner-group-id'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Lists all self-hosted runners configured for an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/list-self-hosted-runners-for-enterprise": { + 'enterprise-admin/list-self-hosted-runners-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; + enterprise: components['parameters']['enterprise'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count?: number; - runners?: components["schemas"]["runner"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count?: number + runners?: components['schemas']['runner'][] + } + } + } + } + } /** * Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/list-runner-applications-for-enterprise": { + 'enterprise-admin/list-runner-applications-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["runner-application"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['runner-application'][] + } + } + } + } /** * Returns a token that you can pass to the `config` script. The token expires after one hour. * @@ -19414,22 +19402,22 @@ export interface operations { * ./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN * ``` */ - "enterprise-admin/create-registration-token-for-enterprise": { + 'enterprise-admin/create-registration-token-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["authentication-token"]; - }; - }; - }; - }; + 'application/json': components['schemas']['authentication-token'] + } + } + } + } /** * Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour. * @@ -19444,161 +19432,161 @@ export interface operations { * ./config.sh remove --token TOKEN * ``` */ - "enterprise-admin/create-remove-token-for-enterprise": { + 'enterprise-admin/create-remove-token-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["authentication-token"]; - }; - }; - }; - }; + 'application/json': components['schemas']['authentication-token'] + } + } + } + } /** * Gets a specific self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/get-self-hosted-runner-for-enterprise": { + 'enterprise-admin/get-self-hosted-runner-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["runner"]; - }; - }; - }; - }; + 'application/json': components['schemas']['runner'] + } + } + } + } /** * Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/delete-self-hosted-runner-from-enterprise": { + 'enterprise-admin/delete-self-hosted-runner-from-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Lists all labels for a self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise": { + 'enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - }; - }; + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + } + } /** * Remove all previous custom labels and set the new custom labels for a specific * self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise": { + 'enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; - responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + runner_id: components['parameters']['runner-id'] + } + } + responses: { + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels. */ - labels: string[]; - }; - }; - }; - }; + labels: string[] + } + } + } + } /** * Add custom labels to a self-hosted runner configured in an enterprise. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise": { + 'enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; - responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + runner_id: components['parameters']['runner-id'] + } + } + responses: { + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The names of the custom labels to add to the runner. */ - labels: string[]; - }; - }; - }; - }; + labels: string[] + } + } + } + } /** * Remove all custom labels from a self-hosted runner configured in an * enterprise. Returns the remaining read-only labels from the runner. * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise": { + 'enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { - 200: components["responses"]["actions_runner_labels_readonly"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; - }; + 200: components['responses']['actions_runner_labels_readonly'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } + } /** * Remove a custom label from a self-hosted runner configured * in an enterprise. Returns the remaining labels from the runner. @@ -19608,33 +19596,33 @@ export interface operations { * * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ - "enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise": { + 'enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; + runner_id: components['parameters']['runner-id'] /** The name of a self-hosted runner's custom label. */ - name: components["parameters"]["runner-label-name"]; - }; - }; - responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; - }; + name: components['parameters']['runner-label-name'] + } + } + responses: { + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } + } /** Gets the audit log for an enterprise. To use this endpoint, you must be an enterprise admin, and you must use an access token with the `admin:enterprise` scope. */ - "enterprise-admin/get-audit-log": { + 'enterprise-admin/get-audit-log': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; + enterprise: components['parameters']['enterprise'] + } query: { /** A search phrase. For more information, see [Searching the audit log](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). */ - phrase?: components["parameters"]["audit-log-phrase"]; + phrase?: components['parameters']['audit-log-phrase'] /** * The event types to include: * @@ -19644,73 +19632,73 @@ export interface operations { * * The default is `web`. */ - include?: components["parameters"]["audit-log-include"]; + include?: components['parameters']['audit-log-include'] /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor. */ - after?: components["parameters"]["audit-log-after"]; + after?: components['parameters']['audit-log-after'] /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor. */ - before?: components["parameters"]["audit-log-before"]; + before?: components['parameters']['audit-log-before'] /** * The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. * * The default is `desc`. */ - order?: components["parameters"]["audit-log-order"]; + order?: components['parameters']['audit-log-order'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["audit-log-event"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['audit-log-event'][] + } + } + } + } /** * Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. * To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). */ - "secret-scanning/list-alerts-for-enterprise": { + 'secret-scanning/list-alerts-for-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; + enterprise: components['parameters']['enterprise'] + } query: { /** Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - state?: components["parameters"]["secret-scanning-alert-state"]; + state?: components['parameters']['secret-scanning-alert-state'] /** * A comma-separated list of secret types to return. By default all secret types are returned. * See "[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)" * for a complete list of secret types (API slug). */ - secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; + secret_type?: components['parameters']['secret-scanning-alert-secret-type'] /** A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - resolution?: components["parameters"]["secret-scanning-alert-resolution"]; + resolution?: components['parameters']['secret-scanning-alert-resolution'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor. */ - before?: components["parameters"]["pagination-before"]; + before?: components['parameters']['pagination-before'] /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor. */ - after?: components["parameters"]["pagination-after"]; - }; - }; + after?: components['parameters']['pagination-after'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["organization-secret-scanning-alert"][]; - }; - }; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': components['schemas']['organization-secret-scanning-alert'][] + } + } + 404: components['responses']['not_found'] + 503: components['responses']['service_unavailable'] + } + } /** * Gets the summary of the free and paid GitHub Actions minutes used. * @@ -19718,49 +19706,49 @@ export interface operations { * * The authenticated user must be an enterprise admin. */ - "billing/get-github-actions-billing-ghe": { + 'billing/get-github-actions-billing-ghe': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-billing-usage"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-billing-usage'] + } + } + } + } /** * Gets the GitHub Advanced Security active committers for an enterprise per repository. * Each distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of active_users for each repository. */ - "billing/get-github-advanced-security-billing-ghe": { + 'billing/get-github-advanced-security-billing-ghe': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; + enterprise: components['parameters']['enterprise'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Success */ 200: { content: { - "application/json": components["schemas"]["advanced-security-active-committers"]; - }; - }; - 403: components["responses"]["code_scanning_forbidden_read"]; - }; - }; + 'application/json': components['schemas']['advanced-security-active-committers'] + } + } + 403: components['responses']['code_scanning_forbidden_read'] + } + } /** * Gets the free and paid storage used for GitHub Packages in gigabytes. * @@ -19768,22 +19756,22 @@ export interface operations { * * The authenticated user must be an enterprise admin. */ - "billing/get-github-packages-billing-ghe": { + 'billing/get-github-packages-billing-ghe': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["packages-billing-usage"]; - }; - }; - }; - }; + 'application/json': components['schemas']['packages-billing-usage'] + } + } + } + } /** * Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. * @@ -19791,44 +19779,44 @@ export interface operations { * * The authenticated user must be an enterprise admin. */ - "billing/get-shared-storage-billing-ghe": { + 'billing/get-shared-storage-billing-ghe': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["combined-billing-usage"]; - }; - }; - }; - }; + 'application/json': components['schemas']['combined-billing-usage'] + } + } + } + } /** We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. */ - "activity/list-public-events": { + 'activity/list-public-events': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["event"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': components['schemas']['event'][] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 503: components['responses']['service_unavailable'] + } + } /** * GitHub provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user: * @@ -19842,71 +19830,71 @@ export interface operations { * * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ - "activity/get-feeds": { - parameters: {}; + 'activity/get-feeds': { + parameters: {} responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["feed"]; - }; - }; - }; - }; + 'application/json': components['schemas']['feed'] + } + } + } + } /** Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists: */ - "gists/list": { + 'gists/list': { parameters: { query: { /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["base-gist"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['base-gist'][] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + } + } /** * Allows you to add a new gist with one or more files. * * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. */ - "gists/create": { - parameters: {}; + 'gists/create': { + parameters: {} responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["gist-simple"]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['gist-simple'] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description Description of the gist * @example Example Ruby script */ - description?: string; + description?: string /** * @description Names and content for the files that make up the gist * @example [object Object] @@ -19914,478 +19902,478 @@ export interface operations { files: { [key: string]: { /** @description Content of the file */ - content: string; - }; - }; - public?: boolean | ("true" | "false"); - }; - }; - }; - }; + content: string + } + } + public?: boolean | ('true' | 'false') + } + } + } + } /** * List public gists sorted by most recently updated to least recently updated. * * Note: With [pagination](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. */ - "gists/list-public": { + 'gists/list-public': { parameters: { query: { /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["base-gist"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['base-gist'][] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } + } /** List the authenticated user's starred gists: */ - "gists/list-starred": { + 'gists/list-starred': { parameters: { query: { /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["base-gist"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; - "gists/get": { + 'application/json': components['schemas']['base-gist'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } + 'gists/get': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - }; - }; + gist_id: components['parameters']['gist-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["gist-simple"]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden_gist"]; - 404: components["responses"]["not_found"]; - }; - }; - "gists/delete": { + 'application/json': components['schemas']['gist-simple'] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden_gist'] + 404: components['responses']['not_found'] + } + } + 'gists/delete': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - }; - }; + gist_id: components['parameters']['gist-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged. */ - "gists/update": { + 'gists/update': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - }; - }; + gist_id: components['parameters']['gist-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["gist-simple"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['gist-simple'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description Description of the gist * @example Example Ruby script */ - description?: string; + description?: string /** * @description Names of files to be updated * @example [object Object] */ - files?: { [key: string]: Partial<{ [key: string]: unknown }> }; - } | null; - }; - }; - }; - "gists/list-comments": { + files?: { [key: string]: Partial<{ [key: string]: unknown }> } + } | null + } + } + } + 'gists/list-comments': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - }; + gist_id: components['parameters']['gist-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["gist-comment"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "gists/create-comment": { + 'application/json': components['schemas']['gist-comment'][] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'gists/create-comment': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - }; - }; + gist_id: components['parameters']['gist-id'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["gist-comment"]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['gist-comment'] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The comment text. * @example Body of the attachment */ - body: string; - }; - }; - }; - }; - "gists/get-comment": { + body: string + } + } + } + } + 'gists/get-comment': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; + gist_id: components['parameters']['gist-id'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["gist-comment"]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden_gist"]; - 404: components["responses"]["not_found"]; - }; - }; - "gists/delete-comment": { + 'application/json': components['schemas']['gist-comment'] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden_gist'] + 404: components['responses']['not_found'] + } + } + 'gists/delete-comment': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; + gist_id: components['parameters']['gist-id'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "gists/update-comment": { + 204: never + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'gists/update-comment': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; + gist_id: components['parameters']['gist-id'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["gist-comment"]; - }; - }; - 404: components["responses"]["not_found"]; - }; + 'application/json': components['schemas']['gist-comment'] + } + } + 404: components['responses']['not_found'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The comment text. * @example Body of the attachment */ - body: string; - }; - }; - }; - }; - "gists/list-commits": { + body: string + } + } + } + } + 'gists/list-commits': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - }; + gist_id: components['parameters']['gist-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { headers: { - Link?: string; - }; + Link?: string + } content: { - "application/json": components["schemas"]["gist-commit"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "gists/list-forks": { + 'application/json': components['schemas']['gist-commit'][] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'gists/list-forks': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - }; + gist_id: components['parameters']['gist-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["gist-simple"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['gist-simple'][] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** **Note**: This was previously `/gists/:gist_id/fork`. */ - "gists/fork": { + 'gists/fork': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - }; - }; + gist_id: components['parameters']['gist-id'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; + Location?: string + } content: { - "application/json": components["schemas"]["base-gist"]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "gists/check-is-starred": { + 'application/json': components['schemas']['base-gist'] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } + 'gists/check-is-starred': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - }; - }; + gist_id: components['parameters']['gist-id'] + } + } responses: { /** Response if gist is starred */ - 204: never; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; + 204: never + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] /** Not Found if gist is not starred */ 404: { content: { - "application/json": { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': { [key: string]: unknown } + } + } + } + } /** Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - "gists/star": { + 'gists/star': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - }; - }; + gist_id: components['parameters']['gist-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "gists/unstar": { + 204: never + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'gists/unstar': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - }; - }; + gist_id: components['parameters']['gist-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "gists/get-revision": { + 204: never + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'gists/get-revision': { parameters: { path: { /** gist_id parameter */ - gist_id: components["parameters"]["gist-id"]; - sha: string; - }; - }; + gist_id: components['parameters']['gist-id'] + sha: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["gist-simple"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['gist-simple'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** List all templates available to pass as an option when [creating a repository](https://docs.github.com/rest/reference/repos#create-a-repository-for-the-authenticated-user). */ - "gitignore/get-all-templates": { - parameters: {}; + 'gitignore/get-all-templates': { + parameters: {} responses: { /** Response */ 200: { content: { - "application/json": string[]; - }; - }; - 304: components["responses"]["not_modified"]; - }; - }; + 'application/json': string[] + } + } + 304: components['responses']['not_modified'] + } + } /** * The API also allows fetching the source of a single template. * Use the raw [media type](https://docs.github.com/rest/overview/media-types/) to get the raw contents. */ - "gitignore/get-template": { + 'gitignore/get-template': { parameters: { path: { - name: string; - }; - }; + name: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["gitignore-template"]; - }; - }; - 304: components["responses"]["not_modified"]; - }; - }; + 'application/json': components['schemas']['gitignore-template'] + } + } + 304: components['responses']['not_modified'] + } + } /** * List repositories that an app installation can access. * * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ - "apps/list-repos-accessible-to-installation": { + 'apps/list-repos-accessible-to-installation': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - repositories: components["schemas"]["repository"][]; + 'application/json': { + total_count: number + repositories: components['schemas']['repository'][] /** @example selected */ - repository_selection?: string; - }; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + repository_selection?: string + } + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** * Revokes the installation token you're using to authenticate as an installation and access this endpoint. * @@ -20393,13 +20381,13 @@ export interface operations { * * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ - "apps/revoke-installation-access-token": { - parameters: {}; + 'apps/revoke-installation-access-token': { + parameters: {} responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * List issues assigned to the authenticated user across all visible repositories including owned repositories, member * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not @@ -20411,7 +20399,7 @@ export interface operations { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - "issues/list": { + 'issues/list': { parameters: { query: { /** @@ -20422,465 +20410,465 @@ export interface operations { * \* `subscribed`: Issues you're subscribed to updates for * \* `all` or `repos`: All issues the authenticated user can see, regardless of participation or creation */ - filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all"; + filter?: 'assigned' | 'created' | 'mentioned' | 'subscribed' | 'repos' | 'all' /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ - state?: "open" | "closed" | "all"; + state?: 'open' | 'closed' | 'all' /** A list of comma separated label names. Example: `bug,ui,@high` */ - labels?: components["parameters"]["labels"]; + labels?: components['parameters']['labels'] /** What to sort results by. Can be either `created`, `updated`, `comments`. */ - sort?: "created" | "updated" | "comments"; + sort?: 'created' | 'updated' | 'comments' /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; - collab?: boolean; - orgs?: boolean; - owned?: boolean; - pulls?: boolean; + since?: components['parameters']['since'] + collab?: boolean + orgs?: boolean + owned?: boolean + pulls?: boolean /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["issue"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "licenses/get-all-commonly-used": { + 'application/json': components['schemas']['issue'][] + } + } + 304: components['responses']['not_modified'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } + 'licenses/get-all-commonly-used': { parameters: { query: { - featured?: boolean; + featured?: boolean /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["license-simple"][]; - }; - }; - 304: components["responses"]["not_modified"]; - }; - }; - "licenses/get": { + 'application/json': components['schemas']['license-simple'][] + } + } + 304: components['responses']['not_modified'] + } + } + 'licenses/get': { parameters: { path: { - license: string; - }; - }; + license: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["license"]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "markdown/render": { - parameters: {}; + 'application/json': components['schemas']['license'] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'markdown/render': { + parameters: {} responses: { /** Response */ 200: { headers: { - "Content-Length"?: string; - }; - content: { - "text/html": string; - }; - }; - 304: components["responses"]["not_modified"]; - }; + 'Content-Length'?: string + } + content: { + 'text/html': string + } + } + 304: components['responses']['not_modified'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The Markdown text to render in HTML. */ - text: string; + text: string /** * @description The rendering mode. Can be either `markdown` or `gfm`. * @default markdown * @example markdown * @enum {string} */ - mode?: "markdown" | "gfm"; + mode?: 'markdown' | 'gfm' /** @description The repository context to use when creating references in `gfm` mode. For example, setting `context` to `octo-org/octo-repo` will change the text `#42` into an HTML link to issue 42 in the `octo-org/octo-repo` repository. */ - context?: string; - }; - }; - }; - }; + context?: string + } + } + } + } /** You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less. */ - "markdown/render-raw": { - parameters: {}; + 'markdown/render-raw': { + parameters: {} responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "text/html": string; - }; - }; - 304: components["responses"]["not_modified"]; - }; + 'text/html': string + } + } + 304: components['responses']['not_modified'] + } requestBody: { content: { - "text/plain": string; - "text/x-markdown": string; - }; - }; - }; + 'text/plain': string + 'text/x-markdown': string + } + } + } /** * Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - "apps/get-subscription-plan-for-account": { + 'apps/get-subscription-plan-for-account': { parameters: { path: { /** account_id parameter */ - account_id: components["parameters"]["account-id"]; - }; - }; + account_id: components['parameters']['account-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["marketplace-purchase"]; - }; - }; - 401: components["responses"]["requires_authentication"]; + 'application/json': components['schemas']['marketplace-purchase'] + } + } + 401: components['responses']['requires_authentication'] /** Not Found when the account has not purchased the listing */ 404: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } + } + } /** * Lists all plans that are part of your GitHub Marketplace listing. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - "apps/list-plans": { + 'apps/list-plans': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["marketplace-listing-plan"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['marketplace-listing-plan'][] + } + } + 401: components['responses']['requires_authentication'] + 404: components['responses']['not_found'] + } + } /** * Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - "apps/list-accounts-for-plan": { + 'apps/list-accounts-for-plan': { parameters: { path: { /** plan_id parameter */ - plan_id: components["parameters"]["plan-id"]; - }; + plan_id: components['parameters']['plan-id'] + } query: { /** One of `created` (when the repository was starred) or `updated` (when it was last pushed to). */ - sort?: components["parameters"]["sort"]; + sort?: components['parameters']['sort'] /** To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter. */ - direction?: "asc" | "desc"; + direction?: 'asc' | 'desc' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["marketplace-purchase"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['marketplace-purchase'][] + } + } + 401: components['responses']['requires_authentication'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** * Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - "apps/get-subscription-plan-for-account-stubbed": { + 'apps/get-subscription-plan-for-account-stubbed': { parameters: { path: { /** account_id parameter */ - account_id: components["parameters"]["account-id"]; - }; - }; + account_id: components['parameters']['account-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["marketplace-purchase"]; - }; - }; - 401: components["responses"]["requires_authentication"]; + 'application/json': components['schemas']['marketplace-purchase'] + } + } + 401: components['responses']['requires_authentication'] /** Not Found when the account has not purchased the listing */ - 404: unknown; - }; - }; + 404: unknown + } + } /** * Lists all plans that are part of your GitHub Marketplace listing. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - "apps/list-plans-stubbed": { + 'apps/list-plans-stubbed': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["marketplace-listing-plan"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - }; - }; + 'application/json': components['schemas']['marketplace-listing-plan'][] + } + } + 401: components['responses']['requires_authentication'] + } + } /** * Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ - "apps/list-accounts-for-plan-stubbed": { + 'apps/list-accounts-for-plan-stubbed': { parameters: { path: { /** plan_id parameter */ - plan_id: components["parameters"]["plan-id"]; - }; + plan_id: components['parameters']['plan-id'] + } query: { /** One of `created` (when the repository was starred) or `updated` (when it was last pushed to). */ - sort?: components["parameters"]["sort"]; + sort?: components['parameters']['sort'] /** To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter. */ - direction?: "asc" | "desc"; + direction?: 'asc' | 'desc' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["marketplace-purchase"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - }; - }; + 'application/json': components['schemas']['marketplace-purchase'][] + } + } + 401: components['responses']['requires_authentication'] + } + } /** * Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://docs.github.com/articles/about-github-s-ip-addresses/)." * * **Note:** The IP addresses shown in the documentation's response are only example values. You must always query the API directly to get the latest list of IP addresses. */ - "meta/get": { - parameters: {}; + 'meta/get': { + parameters: {} responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["api-overview"]; - }; - }; - 304: components["responses"]["not_modified"]; - }; - }; - "activity/list-public-events-for-repo-network": { + 'application/json': components['schemas']['api-overview'] + } + } + 304: components['responses']['not_modified'] + } + } + 'activity/list-public-events-for-repo-network': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["event"][]; - }; - }; - 301: components["responses"]["moved_permanently"]; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['event'][] + } + } + 301: components['responses']['moved_permanently'] + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** List all notifications for the current user, sorted by most recently updated. */ - "activity/list-notifications-for-authenticated-user": { + 'activity/list-notifications-for-authenticated-user': { parameters: { query: { /** If `true`, show notifications marked as read. */ - all?: components["parameters"]["all"]; + all?: components['parameters']['all'] /** If `true`, only shows notifications in which the user is directly participating or mentioned. */ - participating?: components["parameters"]["participating"]; + participating?: components['parameters']['participating'] /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - before?: components["parameters"]["before"]; + before?: components['parameters']['before'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["thread"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['thread'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } + } /** Marks all notifications as "read" removes it from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ - "activity/mark-notifications-as-read": { - parameters: {}; + 'activity/mark-notifications-as-read': { + parameters: {} responses: { /** Response */ 202: { content: { - "application/json": { - message?: string; - }; - }; - }; + 'application/json': { + message?: string + } + } + } /** Reset Content */ - 205: unknown; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; + 205: unknown + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * Format: date-time * @description Describes the last point that notifications were checked. */ - last_read_at?: string; + last_read_at?: string /** @description Whether the notification has been read. */ - read?: boolean; - }; - }; - }; - }; - "activity/get-thread": { + read?: boolean + } + } + } + } + 'activity/get-thread': { parameters: { path: { /** thread_id parameter */ - thread_id: components["parameters"]["thread-id"]; - }; - }; + thread_id: components['parameters']['thread-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["thread"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; - "activity/mark-thread-as-read": { + 'application/json': components['schemas']['thread'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } + 'activity/mark-thread-as-read': { parameters: { path: { /** thread_id parameter */ - thread_id: components["parameters"]["thread-id"]; - }; - }; + thread_id: components['parameters']['thread-id'] + } + } responses: { /** Reset Content */ - 205: unknown; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - }; - }; + 205: unknown + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + } + } /** * This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/rest/reference/activity#get-a-repository-subscription). * * Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. */ - "activity/get-thread-subscription-for-authenticated-user": { + 'activity/get-thread-subscription-for-authenticated-user': { parameters: { path: { /** thread_id parameter */ - thread_id: components["parameters"]["thread-id"]; - }; - }; + thread_id: components['parameters']['thread-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["thread-subscription"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['thread-subscription'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** * If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**. * @@ -20888,213 +20876,211 @@ export interface operations { * * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/rest/reference/activity#delete-a-thread-subscription) endpoint. */ - "activity/set-thread-subscription": { + 'activity/set-thread-subscription': { parameters: { path: { /** thread_id parameter */ - thread_id: components["parameters"]["thread-id"]; - }; - }; + thread_id: components['parameters']['thread-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["thread-subscription"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; + 'application/json': components['schemas']['thread-subscription'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Whether to block all notifications from a thread. */ - ignored?: boolean; - }; - }; - }; - }; + ignored?: boolean + } + } + } + } /** Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/rest/reference/activity#set-a-thread-subscription) endpoint and set `ignore` to `true`. */ - "activity/delete-thread-subscription": { + 'activity/delete-thread-subscription': { parameters: { path: { /** thread_id parameter */ - thread_id: components["parameters"]["thread-id"]; - }; - }; + thread_id: components['parameters']['thread-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** Get the octocat as ASCII art */ - "meta/get-octocat": { + 'meta/get-octocat': { parameters: { query: { /** The words to show in Octocat's speech bubble */ - s?: string; - }; - }; + s?: string + } + } responses: { /** Response */ 200: { content: { - "application/octocat-stream": string; - }; - }; - }; - }; + 'application/octocat-stream': string + } + } + } + } /** * Lists all organizations, in the order that they were created on GitHub. * * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of organizations. */ - "orgs/list": { + 'orgs/list': { parameters: { query: { /** An organization ID. Only return organizations with an ID greater than this ID. */ - since?: components["parameters"]["since-org"]; + since?: components['parameters']['since-org'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { headers: { - Link?: string; - }; + Link?: string + } content: { - "application/json": components["schemas"]["organization-simple"][]; - }; - }; - 304: components["responses"]["not_modified"]; - }; - }; + 'application/json': components['schemas']['organization-simple'][] + } + } + 304: components['responses']['not_modified'] + } + } /** * List the custom repository roles available in this organization. In order to see custom * repository roles in an organization, the authenticated user must be an organization owner. * * For more information on custom repository roles, see "[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)". */ - "orgs/list-custom-roles": { + 'orgs/list-custom-roles': { parameters: { path: { - organization_id: string; - }; - }; + organization_id: string + } + } responses: { /** Response - list of custom role names */ 200: { content: { - "application/json": { + 'application/json': { /** * @description The number of custom roles in this organization * @example 3 */ - total_count?: number; - custom_roles?: components["schemas"]["organization-custom-repository-role"][]; - }; - }; - }; - }; - }; + total_count?: number + custom_roles?: components['schemas']['organization-custom-repository-role'][] + } + } + } + } + } /** * Lists a connection between a team and an external group. * * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ - "teams/list-linked-external-idp-groups-to-team-for-org": { + 'teams/list-linked-external-idp-groups-to-team-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; - }; + team_slug: components['parameters']['team-slug'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["external-groups"]; - }; - }; - }; - }; + 'application/json': components['schemas']['external-groups'] + } + } + } + } /** * To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). * * GitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub plan. See "[Authenticating with GitHub Apps](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/)" for details. For an example response, see 'Response with GitHub plan information' below." */ - "orgs/get": { + 'orgs/get': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["organization-full"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['organization-full'] + } + } + 404: components['responses']['not_found'] + } + } /** * **Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). * * Enables an authenticated organization owner with the `admin:org` scope to update the organization's profile and member privileges. */ - "orgs/update": { + 'orgs/update': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["organization-full"]; - }; - }; - 409: components["responses"]["conflict"]; + 'application/json': components['schemas']['organization-full'] + } + } + 409: components['responses']['conflict'] /** Validation failed */ 422: { content: { - "application/json": - | components["schemas"]["validation-error"] - | components["schemas"]["validation-error-simple"]; - }; - }; - }; + 'application/json': components['schemas']['validation-error'] | components['schemas']['validation-error-simple'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Billing email address. This address is not publicized. */ - billing_email?: string; + billing_email?: string /** @description The company name. */ - company?: string; + company?: string /** @description The publicly visible email address. */ - email?: string; + email?: string /** @description The Twitter username of the company. */ - twitter_username?: string; + twitter_username?: string /** @description The location. */ - location?: string; + location?: string /** @description The shorthand name of the company. */ - name?: string; + name?: string /** @description The description of the company. */ - description?: string; + description?: string /** @description Toggles whether an organization can use organization projects. */ - has_organization_projects?: boolean; + has_organization_projects?: boolean /** @description Toggles whether repositories that belong to the organization can use repository projects. */ - has_repository_projects?: boolean; + has_repository_projects?: boolean /** * @description Default permission level members have for organization repositories: * \* `read` - can pull, but not push to or administer this repository. @@ -21104,7 +21090,7 @@ export interface operations { * @default read * @enum {string} */ - default_repository_permission?: "read" | "write" | "admin" | "none"; + default_repository_permission?: 'read' | 'write' | 'admin' | 'none' /** * @description Toggles the ability of non-admin organization members to create repositories. Can be one of: * \* `true` - all organization members can create repositories. @@ -21113,28 +21099,28 @@ export interface operations { * **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. * @default true */ - members_can_create_repositories?: boolean; + members_can_create_repositories?: boolean /** * @description Toggles whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. Can be one of: * \* `true` - all organization members can create internal repositories. * \* `false` - only organization owners can create internal repositories. * Default: `true`. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */ - members_can_create_internal_repositories?: boolean; + members_can_create_internal_repositories?: boolean /** * @description Toggles whether organization members can create private repositories, which are visible to organization members with permission. Can be one of: * \* `true` - all organization members can create private repositories. * \* `false` - only organization owners can create private repositories. * Default: `true`. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */ - members_can_create_private_repositories?: boolean; + members_can_create_private_repositories?: boolean /** * @description Toggles whether organization members can create public repositories, which are visible to anyone. Can be one of: * \* `true` - all organization members can create public repositories. * \* `false` - only organization owners can create public repositories. * Default: `true`. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */ - members_can_create_public_repositories?: boolean; + members_can_create_public_repositories?: boolean /** * @description Specifies which types of repositories non-admin organization members can create. Can be one of: * \* `all` - all organization members can create public and private repositories. @@ -21143,60 +21129,60 @@ export interface operations { * **Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details. * @enum {string} */ - members_allowed_repository_creation_type?: "all" | "private" | "none"; + members_allowed_repository_creation_type?: 'all' | 'private' | 'none' /** * @description Toggles whether organization members can create GitHub Pages sites. Can be one of: * \* `true` - all organization members can create GitHub Pages sites. * \* `false` - no organization members can create GitHub Pages sites. Existing published sites will not be impacted. * @default true */ - members_can_create_pages?: boolean; + members_can_create_pages?: boolean /** * @description Toggles whether organization members can create public GitHub Pages sites. Can be one of: * \* `true` - all organization members can create public GitHub Pages sites. * \* `false` - no organization members can create public GitHub Pages sites. Existing published sites will not be impacted. * @default true */ - members_can_create_public_pages?: boolean; + members_can_create_public_pages?: boolean /** * @description Toggles whether organization members can create private GitHub Pages sites. Can be one of: * \* `true` - all organization members can create private GitHub Pages sites. * \* `false` - no organization members can create private GitHub Pages sites. Existing published sites will not be impacted. * @default true */ - members_can_create_private_pages?: boolean; + members_can_create_private_pages?: boolean /** * @description Toggles whether organization members can fork private organization repositories. Can be one of: * \* `true` - all organization members can fork private repositories within the organization. * \* `false` - no organization members can fork private repositories within the organization. */ - members_can_fork_private_repositories?: boolean; + members_can_fork_private_repositories?: boolean /** @example "http://github.blog" */ - blog?: string; - }; - }; - }; - }; + blog?: string + } + } + } + } /** * Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - "actions/get-github-actions-permissions-organization": { + 'actions/get-github-actions-permissions-organization': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-organization-permissions"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-organization-permissions'] + } + } + } + } /** * Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization. * @@ -21204,132 +21190,132 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - "actions/set-github-actions-permissions-organization": { + 'actions/set-github-actions-permissions-organization': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { - enabled_repositories: components["schemas"]["enabled-repositories"]; - allowed_actions?: components["schemas"]["allowed-actions"]; - }; - }; - }; - }; + 'application/json': { + enabled_repositories: components['schemas']['enabled-repositories'] + allowed_actions?: components['schemas']['allowed-actions'] + } + } + } + } /** * Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - "actions/list-selected-repositories-enabled-github-actions-organization": { + 'actions/list-selected-repositories-enabled-github-actions-organization': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - repositories: components["schemas"]["repository"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + repositories: components['schemas']['repository'][] + } + } + } + } + } /** * Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - "actions/set-selected-repositories-enabled-github-actions-organization": { + 'actions/set-selected-repositories-enabled-github-actions-organization': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description List of repository IDs to enable for GitHub Actions. */ - selected_repository_ids: number[]; - }; - }; - }; - }; + selected_repository_ids: number[] + } + } + } + } /** * Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - "actions/enable-selected-repository-github-actions-organization": { + 'actions/enable-selected-repository-github-actions-organization': { parameters: { path: { - org: components["parameters"]["org"]; - repository_id: components["parameters"]["repository-id"]; - }; - }; + org: components['parameters']['org'] + repository_id: components['parameters']['repository-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - "actions/disable-selected-repository-github-actions-organization": { + 'actions/disable-selected-repository-github-actions-organization': { parameters: { path: { - org: components["parameters"]["org"]; - repository_id: components["parameters"]["repository-id"]; - }; - }; + org: components['parameters']['org'] + repository_id: components['parameters']['repository-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."" * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - "actions/get-allowed-actions-organization": { + 'actions/get-allowed-actions-organization': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["selected-actions"]; - }; - }; - }; - }; + 'application/json': components['schemas']['selected-actions'] + } + } + } + } /** * Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * @@ -21339,65 +21325,65 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - "actions/set-allowed-actions-organization": { + 'actions/set-allowed-actions-organization': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": components["schemas"]["selected-actions"]; - }; - }; - }; + 'application/json': components['schemas']['selected-actions'] + } + } + } /** * Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, * as well if GitHub Actions can submit approving pull request reviews. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - "actions/get-github-actions-default-workflow-permissions-organization": { + 'actions/get-github-actions-default-workflow-permissions-organization': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-get-default-workflow-permissions"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-get-default-workflow-permissions'] + } + } + } + } /** * Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions * can submit approving pull request reviews. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ - "actions/set-github-actions-default-workflow-permissions-organization": { + 'actions/set-github-actions-default-workflow-permissions-organization': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": components["schemas"]["actions-set-default-workflow-permissions"]; - }; - }; - }; + 'application/json': components['schemas']['actions-set-default-workflow-permissions'] + } + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21405,30 +21391,30 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/list-self-hosted-runner-groups-for-org": { + 'actions/list-self-hosted-runner-groups-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - runner_groups: components["schemas"]["runner-groups-org"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + runner_groups: components['schemas']['runner-groups-org'][] + } + } + } + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21436,41 +21422,41 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/create-self-hosted-runner-group-for-org": { + 'actions/create-self-hosted-runner-group-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["runner-groups-org"]; - }; - }; - }; + 'application/json': components['schemas']['runner-groups-org'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Name of the runner group. */ - name: string; + name: string /** * @description Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories. Can be one of: `all`, `selected`, or `private`. * @default all * @enum {string} */ - visibility?: "selected" | "all" | "private"; + visibility?: 'selected' | 'all' | 'private' /** @description List of repository IDs that can access the runner group. */ - selected_repository_ids?: number[]; + selected_repository_ids?: number[] /** @description List of runner IDs to add to the runner group. */ - runners?: number[]; + runners?: number[] /** @description Whether the runner group can be used by `public` repositories. */ - allows_public_repositories?: boolean; - }; - }; - }; - }; + allows_public_repositories?: boolean + } + } + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21478,23 +21464,23 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/get-self-hosted-runner-group-for-org": { + 'actions/get-self-hosted-runner-group-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["runner-groups-org"]; - }; - }; - }; - }; + 'application/json': components['schemas']['runner-groups-org'] + } + } + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21502,19 +21488,19 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/delete-self-hosted-runner-group-from-org": { + 'actions/delete-self-hosted-runner-group-from-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21522,38 +21508,38 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/update-self-hosted-runner-group-for-org": { + 'actions/update-self-hosted-runner-group-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["runner-groups-org"]; - }; - }; - }; + 'application/json': components['schemas']['runner-groups-org'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Name of the runner group. */ - name: string; + name: string /** * @description Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories. Can be one of: `all`, `selected`, or `private`. * @enum {string} */ - visibility?: "selected" | "all" | "private"; + visibility?: 'selected' | 'all' | 'private' /** @description Whether the runner group can be used by `public` repositories. */ - allows_public_repositories?: boolean; - }; - }; - }; - }; + allows_public_repositories?: boolean + } + } + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21561,32 +21547,32 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/list-repo-access-to-self-hosted-runner-group-in-org": { + 'actions/list-repo-access-to-self-hosted-runner-group-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; + runner_group_id: components['parameters']['runner-group-id'] + } query: { /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - repositories: components["schemas"]["minimal-repository"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + repositories: components['schemas']['minimal-repository'][] + } + } + } + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21594,27 +21580,27 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/set-repo-access-to-self-hosted-runner-group-in-org": { + 'actions/set-repo-access-to-self-hosted-runner-group-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description List of repository IDs that can access the runner group. */ - selected_repository_ids: number[]; - }; - }; - }; - }; + selected_repository_ids: number[] + } + } + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21624,20 +21610,20 @@ export interface operations { * You must authenticate using an access token with the `admin:org` * scope to use this endpoint. */ - "actions/add-repo-access-to-self-hosted-runner-group-in-org": { + 'actions/add-repo-access-to-self-hosted-runner-group-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - repository_id: components["parameters"]["repository-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + repository_id: components['parameters']['repository-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21646,20 +21632,20 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/remove-repo-access-to-self-hosted-runner-group-in-org": { + 'actions/remove-repo-access-to-self-hosted-runner-group-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - repository_id: components["parameters"]["repository-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + repository_id: components['parameters']['repository-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21667,33 +21653,33 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/list-self-hosted-runners-in-group-for-org": { + 'actions/list-self-hosted-runners-in-group-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; + runner_group_id: components['parameters']['runner-group-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - runners: components["schemas"]["runner"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + runners: components['schemas']['runner'][] + } + } + } + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21701,27 +21687,27 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/set-self-hosted-runners-in-group-for-org": { + 'actions/set-self-hosted-runners-in-group-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; - }; - }; + runner_group_id: components['parameters']['runner-group-id'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description List of runner IDs to add to the runner group. */ - runners: number[]; - }; - }; - }; - }; + runners: number[] + } + } + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21731,21 +21717,21 @@ export interface operations { * You must authenticate using an access token with the `admin:org` * scope to use this endpoint. */ - "actions/add-self-hosted-runner-to-group-for-org": { + 'actions/add-self-hosted-runner-to-group-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components['parameters']['runner-group-id'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." * @@ -21754,71 +21740,71 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/remove-self-hosted-runner-from-group-for-org": { + 'actions/remove-self-hosted-runner-from-group-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner group. */ - runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components['parameters']['runner-group-id'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Lists all self-hosted runners configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/list-self-hosted-runners-for-org": { + 'actions/list-self-hosted-runners-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - runners: components["schemas"]["runner"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + runners: components['schemas']['runner'][] + } + } + } + } + } /** * Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/list-runner-applications-for-org": { + 'actions/list-runner-applications-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["runner-application"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['runner-application'][] + } + } + } + } /** * Returns a token that you can pass to the `config` script. The token expires after one hour. * @@ -21832,21 +21818,21 @@ export interface operations { * ./config.sh --url https://github.com/octo-org --token TOKEN * ``` */ - "actions/create-registration-token-for-org": { + 'actions/create-registration-token-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["authentication-token"]; - }; - }; - }; - }; + 'application/json': components['schemas']['authentication-token'] + } + } + } + } /** * Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour. * @@ -21861,153 +21847,153 @@ export interface operations { * ./config.sh remove --token TOKEN * ``` */ - "actions/create-remove-token-for-org": { + 'actions/create-remove-token-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["authentication-token"]; - }; - }; - }; - }; + 'application/json': components['schemas']['authentication-token'] + } + } + } + } /** * Gets a specific self-hosted runner configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/get-self-hosted-runner-for-org": { + 'actions/get-self-hosted-runner-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["runner"]; - }; - }; - }; - }; + 'application/json': components['schemas']['runner'] + } + } + } + } /** * Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/delete-self-hosted-runner-from-org": { + 'actions/delete-self-hosted-runner-from-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Lists all labels for a self-hosted runner configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/list-labels-for-self-hosted-runner-for-org": { + 'actions/list-labels-for-self-hosted-runner-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - }; - }; + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + } + } /** * Remove all previous custom labels and set the new custom labels for a specific * self-hosted runner configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/set-custom-labels-for-self-hosted-runner-for-org": { + 'actions/set-custom-labels-for-self-hosted-runner-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; - responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + runner_id: components['parameters']['runner-id'] + } + } + responses: { + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels. */ - labels: string[]; - }; - }; - }; - }; + labels: string[] + } + } + } + } /** * Add custom labels to a self-hosted runner configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/add-custom-labels-to-self-hosted-runner-for-org": { + 'actions/add-custom-labels-to-self-hosted-runner-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; - responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + runner_id: components['parameters']['runner-id'] + } + } + responses: { + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The names of the custom labels to add to the runner. */ - labels: string[]; - }; - }; - }; - }; + labels: string[] + } + } + } + } /** * Remove all custom labels from a self-hosted runner configured in an * organization. Returns the remaining read-only labels from the runner. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/remove-all-custom-labels-from-self-hosted-runner-for-org": { + 'actions/remove-all-custom-labels-from-self-hosted-runner-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { - 200: components["responses"]["actions_runner_labels_readonly"]; - 404: components["responses"]["not_found"]; - }; - }; + 200: components['responses']['actions_runner_labels_readonly'] + 404: components['responses']['not_found'] + } + } /** * Remove a custom label from a self-hosted runner configured * in an organization. Returns the remaining labels from the runner. @@ -22017,82 +22003,82 @@ export interface operations { * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ - "actions/remove-custom-label-from-self-hosted-runner-for-org": { + 'actions/remove-custom-label-from-self-hosted-runner-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; + runner_id: components['parameters']['runner-id'] /** The name of a self-hosted runner's custom label. */ - name: components["parameters"]["runner-label-name"]; - }; - }; - responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; - }; + name: components['parameters']['runner-label-name'] + } + } + responses: { + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } + } /** Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - "actions/list-org-secrets": { + 'actions/list-org-secrets': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - secrets: components["schemas"]["organization-actions-secret"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + secrets: components['schemas']['organization-actions-secret'][] + } + } + } + } + } /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - "actions/get-org-public-key": { + 'actions/get-org-public-key': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-public-key"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-public-key'] + } + } + } + } /** Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - "actions/get-org-secret": { + 'actions/get-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["organization-actions-secret"]; - }; - }; - }; - }; + 'application/json': components['schemas']['organization-actions-secret'] + } + } + } + } /** * Creates or updates an organization secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -22170,31 +22156,31 @@ export interface operations { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - "actions/create-or-update-org-secret": { + 'actions/create-or-update-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response when creating a secret */ 201: { content: { - "application/json": components["schemas"]["empty-object"]; - }; - }; + 'application/json': components['schemas']['empty-object'] + } + } /** Response when updating a secret */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/reference/actions#get-an-organization-public-key) endpoint. */ - encrypted_value?: string; + encrypted_value?: string /** @description ID of the key you used to encrypt the secret. */ - key_id?: string; + key_id?: string /** * @description Configures the access that repositories have to the organization secret. Can be one of: * \- `all` - All repositories in an organization can access the secret. @@ -22202,123 +22188,123 @@ export interface operations { * \- `selected` - Only specific repositories can access the secret. * @enum {string} */ - visibility: "all" | "private" | "selected"; + visibility: 'all' | 'private' | 'selected' /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/reference/actions#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/actions#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints. */ - selected_repository_ids?: string[]; - }; - }; - }; - }; + selected_repository_ids?: string[] + } + } + } + } /** Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - "actions/delete-org-secret": { + 'actions/delete-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - "actions/list-selected-repos-for-org-secret": { + 'actions/list-selected-repos-for-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; + secret_name: components['parameters']['secret-name'] + } query: { /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - repositories: components["schemas"]["minimal-repository"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + repositories: components['schemas']['minimal-repository'][] + } + } + } + } + } /** Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - "actions/set-selected-repos-for-org-secret": { + 'actions/set-selected-repos-for-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/actions#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints. */ - selected_repository_ids: number[]; - }; - }; - }; - }; + selected_repository_ids: number[] + } + } + } + } /** Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - "actions/add-selected-repo-to-org-secret": { + 'actions/add-selected-repo-to-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - repository_id: number; - }; - }; + secret_name: components['parameters']['secret-name'] + repository_id: number + } + } responses: { /** No Content when repository was added to the selected list */ - 204: never; + 204: never /** Conflict when visibility type is not set to selected */ - 409: unknown; - }; - }; + 409: unknown + } + } /** Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ - "actions/remove-selected-repo-from-org-secret": { + 'actions/remove-selected-repo-from-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - repository_id: number; - }; - }; + secret_name: components['parameters']['secret-name'] + repository_id: number + } + } responses: { /** Response when repository was removed from the selected list */ - 204: never; + 204: never /** Conflict when visibility type not set to selected */ - 409: unknown; - }; - }; + 409: unknown + } + } /** * Gets the audit log for an organization. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization)." * * This endpoint is available for organizations on GitHub Enterprise Cloud. To use this endpoint, you must be an organization owner, and you must use an access token with the `admin:org` scope. GitHub Apps must have the `organization_administration` read permission to use this endpoint. */ - "orgs/get-audit-log": { + 'orgs/get-audit-log': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** A search phrase. For more information, see [Searching the audit log](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). */ - phrase?: components["parameters"]["audit-log-phrase"]; + phrase?: components['parameters']['audit-log-phrase'] /** * The event types to include: * @@ -22328,90 +22314,90 @@ export interface operations { * * The default is `web`. */ - include?: components["parameters"]["audit-log-include"]; + include?: components['parameters']['audit-log-include'] /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor. */ - after?: components["parameters"]["audit-log-after"]; + after?: components['parameters']['audit-log-after'] /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor. */ - before?: components["parameters"]["audit-log-before"]; + before?: components['parameters']['audit-log-before'] /** * The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. * * The default is `desc`. */ - order?: components["parameters"]["audit-log-order"]; + order?: components['parameters']['audit-log-order'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["audit-log-event"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['audit-log-event'][] + } + } + } + } /** List the users blocked by an organization. */ - "orgs/list-blocked-users": { + 'orgs/list-blocked-users': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 415: components["responses"]["preview_header_missing"]; - }; - }; - "orgs/check-blocked-user": { + 'application/json': components['schemas']['simple-user'][] + } + } + 415: components['responses']['preview_header_missing'] + } + } + 'orgs/check-blocked-user': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** If the user is blocked: */ - 204: never; + 204: never /** If the user is not blocked: */ 404: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - }; - }; - "orgs/block-user": { + 'application/json': components['schemas']['basic-error'] + } + } + } + } + 'orgs/block-user': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 422: components["responses"]["validation_failed"]; - }; - }; - "orgs/unblock-user": { + 204: never + 422: components['responses']['validation_failed'] + } + } + 'orgs/unblock-user': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Lists all code scanning alerts for the default branch (usually `main` * or `master`) for all eligible repositories in an organization. @@ -22419,147 +22405,147 @@ export interface operations { * * GitHub Apps must have the `security_events` read permission to use this endpoint. */ - "code-scanning/list-alerts-for-org": { + 'code-scanning/list-alerts-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor. */ - before?: components["parameters"]["pagination-before"]; + before?: components['parameters']['pagination-before'] /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor. */ - after?: components["parameters"]["pagination-after"]; + after?: components['parameters']['pagination-after'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Set to `open`, `closed, `fixed`, or `dismissed` to list code scanning alerts in a specific state. */ - state?: components["schemas"]["code-scanning-alert-state"]; + state?: components['schemas']['code-scanning-alert-state'] /** Can be one of `created`, `updated`. */ - sort?: "created" | "updated"; - }; - }; + sort?: 'created' | 'updated' + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["code-scanning-organization-alert-items"][]; - }; - }; - 403: components["responses"]["code_scanning_forbidden_read"]; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': components['schemas']['code-scanning-organization-alert-items'][] + } + } + 403: components['responses']['code_scanning_forbidden_read'] + 404: components['responses']['not_found'] + 503: components['responses']['service_unavailable'] + } + } /** * Listing and deleting credential authorizations is available to organizations with GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products). * * An authenticated organization owner with the `read:org` scope can list all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials are either personal access tokens or SSH keys that organization members have authorized for the organization. For more information, see [About authentication with SAML single sign-on](https://docs.github.com/en/articles/about-authentication-with-saml-single-sign-on). */ - "orgs/list-saml-sso-authorizations": { + 'orgs/list-saml-sso-authorizations': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page token */ - page?: number; + page?: number /** Limits the list of credentials authorizations for an organization to a specific login */ - login?: string; - }; - }; + login?: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["credential-authorization"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['credential-authorization'][] + } + } + } + } /** * Listing and deleting credential authorizations is available to organizations with GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products). * * An authenticated organization owner with the `admin:org` scope can remove a credential authorization for an organization that uses SAML SSO. Once you remove someone's credential authorization, they will need to create a new personal access token or SSH key and authorize it for the organization they want to access. */ - "orgs/remove-saml-sso-authorization": { + 'orgs/remove-saml-sso-authorization': { parameters: { path: { - org: components["parameters"]["org"]; - credential_id: number; - }; - }; + org: components['parameters']['org'] + credential_id: number + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - "dependabot/list-org-secrets": { + 'dependabot/list-org-secrets': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - secrets: components["schemas"]["organization-dependabot-secret"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + secrets: components['schemas']['organization-dependabot-secret'][] + } + } + } + } + } /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - "dependabot/get-org-public-key": { + 'dependabot/get-org-public-key': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["dependabot-public-key"]; - }; - }; - }; - }; + 'application/json': components['schemas']['dependabot-public-key'] + } + } + } + } /** Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - "dependabot/get-org-secret": { + 'dependabot/get-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["organization-dependabot-secret"]; - }; - }; - }; - }; + 'application/json': components['schemas']['organization-dependabot-secret'] + } + } + } + } /** * Creates or updates an organization secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -22637,31 +22623,31 @@ export interface operations { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - "dependabot/create-or-update-org-secret": { + 'dependabot/create-or-update-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response when creating a secret */ 201: { content: { - "application/json": components["schemas"]["empty-object"]; - }; - }; + 'application/json': components['schemas']['empty-object'] + } + } /** Response when updating a secret */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/reference/dependabot#get-an-organization-public-key) endpoint. */ - encrypted_value?: string; + encrypted_value?: string /** @description ID of the key you used to encrypt the secret. */ - key_id?: string; + key_id?: string /** * @description Configures the access that repositories have to the organization secret. Can be one of: * \- `all` - All repositories in an organization can access the secret. @@ -22669,631 +22655,630 @@ export interface operations { * \- `selected` - Only specific repositories can access the secret. * @enum {string} */ - visibility: "all" | "private" | "selected"; + visibility: 'all' | 'private' | 'selected' /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/reference/dependabot#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/dependabot#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/dependabot#remove-selected-repository-from-an-organization-secret) endpoints. */ - selected_repository_ids?: string[]; - }; - }; - }; - }; + selected_repository_ids?: string[] + } + } + } + } /** Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - "dependabot/delete-org-secret": { + 'dependabot/delete-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - "dependabot/list-selected-repos-for-org-secret": { + 'dependabot/list-selected-repos-for-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; + secret_name: components['parameters']['secret-name'] + } query: { /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - repositories: components["schemas"]["minimal-repository"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + repositories: components['schemas']['minimal-repository'][] + } + } + } + } + } /** Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - "dependabot/set-selected-repos-for-org-secret": { + 'dependabot/set-selected-repos-for-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/dependabot#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/dependabot#remove-selected-repository-from-an-organization-secret) endpoints. */ - selected_repository_ids: number[]; - }; - }; - }; - }; + selected_repository_ids: number[] + } + } + } + } /** Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - "dependabot/add-selected-repo-to-org-secret": { + 'dependabot/add-selected-repo-to-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - repository_id: number; - }; - }; + secret_name: components['parameters']['secret-name'] + repository_id: number + } + } responses: { /** No Content when repository was added to the selected list */ - 204: never; + 204: never /** Conflict when visibility type is not set to selected */ - 409: unknown; - }; - }; + 409: unknown + } + } /** Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - "dependabot/remove-selected-repo-from-org-secret": { + 'dependabot/remove-selected-repo-from-org-secret': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - repository_id: number; - }; - }; + secret_name: components['parameters']['secret-name'] + repository_id: number + } + } responses: { /** Response when repository was removed from the selected list */ - 204: never; + 204: never /** Conflict when visibility type not set to selected */ - 409: unknown; - }; - }; - "activity/list-public-org-events": { + 409: unknown + } + } + 'activity/list-public-org-events': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["event"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['event'][] + } + } + } + } /** * Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to. * * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ - "teams/external-idp-group-info-for-org": { + 'teams/external-idp-group-info-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** group_id parameter */ - group_id: components["parameters"]["group-id"]; - }; - }; + group_id: components['parameters']['group-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["external-group"]; - }; - }; - }; - }; + 'application/json': components['schemas']['external-group'] + } + } + } + } /** * Lists external groups available in an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." * * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ - "teams/list-external-idp-groups-for-org": { + 'teams/list-external-idp-groups-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page token */ - page?: number; + page?: number /** Limits the list to groups containing the text in the group name */ - display_name?: string; - }; - }; + display_name?: string + } + } responses: { /** Response */ 200: { headers: { - Link?: string; - }; - content: { - "application/json": components["schemas"]["external-groups"]; - }; - }; - }; - }; + Link?: string + } + content: { + 'application/json': components['schemas']['external-groups'] + } + } + } + } /** The return hash contains `failed_at` and `failed_reason` fields which represent the time at which the invitation failed and the reason for the failure. */ - "orgs/list-failed-invitations": { + 'orgs/list-failed-invitations': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["organization-invitation"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "orgs/list-webhooks": { + 'application/json': components['schemas']['organization-invitation'][] + } + } + 404: components['responses']['not_found'] + } + } + 'orgs/list-webhooks': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["org-hook"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['org-hook'][] + } + } + 404: components['responses']['not_found'] + } + } /** Here's how you can create a hook that posts payloads in JSON format: */ - "orgs/create-webhook": { + 'orgs/create-webhook': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["org-hook"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['org-hook'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Must be passed as "web". */ - name: string; + name: string /** @description Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/orgs#create-hook-config-params). */ config: { - url: components["schemas"]["webhook-config-url"]; - content_type?: components["schemas"]["webhook-config-content-type"]; - secret?: components["schemas"]["webhook-config-secret"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + url: components['schemas']['webhook-config-url'] + content_type?: components['schemas']['webhook-config-content-type'] + secret?: components['schemas']['webhook-config-secret'] + insecure_ssl?: components['schemas']['webhook-config-insecure-ssl'] /** @example "kdaigle" */ - username?: string; + username?: string /** @example "password" */ - password?: string; - }; + password?: string + } /** * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. * @default push */ - events?: string[]; + events?: string[] /** * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. * @default true */ - active?: boolean; - }; - }; - }; - }; + active?: boolean + } + } + } + } /** Returns a webhook configured in an organization. To get only the webhook `config` properties, see "[Get a webhook configuration for an organization](/rest/reference/orgs#get-a-webhook-configuration-for-an-organization)." */ - "orgs/get-webhook": { + 'orgs/get-webhook': { parameters: { path: { - org: components["parameters"]["org"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + org: components['parameters']['org'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["org-hook"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "orgs/delete-webhook": { + 'application/json': components['schemas']['org-hook'] + } + } + 404: components['responses']['not_found'] + } + } + 'orgs/delete-webhook': { parameters: { path: { - org: components["parameters"]["org"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + org: components['parameters']['org'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for an organization](/rest/reference/orgs#update-a-webhook-configuration-for-an-organization)." */ - "orgs/update-webhook": { + 'orgs/update-webhook': { parameters: { path: { - org: components["parameters"]["org"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + org: components['parameters']['org'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["org-hook"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['org-hook'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/orgs#update-hook-config-params). */ config?: { - url: components["schemas"]["webhook-config-url"]; - content_type?: components["schemas"]["webhook-config-content-type"]; - secret?: components["schemas"]["webhook-config-secret"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - }; + url: components['schemas']['webhook-config-url'] + content_type?: components['schemas']['webhook-config-content-type'] + secret?: components['schemas']['webhook-config-secret'] + insecure_ssl?: components['schemas']['webhook-config-insecure-ssl'] + } /** * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. * @default push */ - events?: string[]; + events?: string[] /** * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. * @default true */ - active?: boolean; + active?: boolean /** @example "web" */ - name?: string; - }; - }; - }; - }; + name?: string + } + } + } + } /** * Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/reference/orgs#get-an-organization-webhook)." * * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission. */ - "orgs/get-webhook-config-for-org": { + 'orgs/get-webhook-config-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + org: components['parameters']['org'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["webhook-config"]; - }; - }; - }; - }; + 'application/json': components['schemas']['webhook-config'] + } + } + } + } /** * Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/reference/orgs#update-an-organization-webhook)." * * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission. */ - "orgs/update-webhook-config-for-org": { + 'orgs/update-webhook-config-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + org: components['parameters']['org'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["webhook-config"]; - }; - }; - }; + 'application/json': components['schemas']['webhook-config'] + } + } + } requestBody: { content: { - "application/json": { - url?: components["schemas"]["webhook-config-url"]; - content_type?: components["schemas"]["webhook-config-content-type"]; - secret?: components["schemas"]["webhook-config-secret"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - }; - }; - }; - }; + 'application/json': { + url?: components['schemas']['webhook-config-url'] + content_type?: components['schemas']['webhook-config-content-type'] + secret?: components['schemas']['webhook-config-secret'] + insecure_ssl?: components['schemas']['webhook-config-insecure-ssl'] + } + } + } + } /** Returns a list of webhook deliveries for a webhook configured in an organization. */ - "orgs/list-webhook-deliveries": { + 'orgs/list-webhook-deliveries': { parameters: { path: { - org: components["parameters"]["org"]; - hook_id: components["parameters"]["hook-id"]; - }; + org: components['parameters']['org'] + hook_id: components['parameters']['hook-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ - cursor?: components["parameters"]["cursor"]; - }; - }; + cursor?: components['parameters']['cursor'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["hook-delivery-item"][]; - }; - }; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['hook-delivery-item'][] + } + } + 400: components['responses']['bad_request'] + 422: components['responses']['validation_failed'] + } + } /** Returns a delivery for a webhook configured in an organization. */ - "orgs/get-webhook-delivery": { + 'orgs/get-webhook-delivery': { parameters: { path: { - org: components["parameters"]["org"]; - hook_id: components["parameters"]["hook-id"]; - delivery_id: components["parameters"]["delivery-id"]; - }; - }; + org: components['parameters']['org'] + hook_id: components['parameters']['hook-id'] + delivery_id: components['parameters']['delivery-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["hook-delivery"]; - }; - }; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['hook-delivery'] + } + } + 400: components['responses']['bad_request'] + 422: components['responses']['validation_failed'] + } + } /** Redeliver a delivery for a webhook configured in an organization. */ - "orgs/redeliver-webhook-delivery": { + 'orgs/redeliver-webhook-delivery': { parameters: { path: { - org: components["parameters"]["org"]; - hook_id: components["parameters"]["hook-id"]; - delivery_id: components["parameters"]["delivery-id"]; - }; - }; + org: components['parameters']['org'] + hook_id: components['parameters']['hook-id'] + delivery_id: components['parameters']['delivery-id'] + } + } responses: { - 202: components["responses"]["accepted"]; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 202: components['responses']['accepted'] + 400: components['responses']['bad_request'] + 422: components['responses']['validation_failed'] + } + } /** This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. */ - "orgs/ping-webhook": { + 'orgs/ping-webhook': { parameters: { path: { - org: components["parameters"]["org"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + org: components['parameters']['org'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** * Enables an authenticated GitHub App to find the organization's installation information. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/get-org-installation": { + 'apps/get-org-installation': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["installation"]; - }; - }; - }; - }; + 'application/json': components['schemas']['installation'] + } + } + } + } /** Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint. */ - "orgs/list-app-installations": { + 'orgs/list-app-installations': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - installations: components["schemas"]["installation"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + installations: components['schemas']['installation'][] + } + } + } + } + } /** Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response. */ - "interactions/get-restrictions-for-org": { + 'interactions/get-restrictions-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": Partial & - Partial<{ [key: string]: unknown }>; - }; - }; - }; - }; + 'application/json': Partial & Partial<{ [key: string]: unknown }> + } + } + } + } /** Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization. */ - "interactions/set-restrictions-for-org": { + 'interactions/set-restrictions-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["interaction-limit-response"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['interaction-limit-response'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": components["schemas"]["interaction-limit"]; - }; - }; - }; + 'application/json': components['schemas']['interaction-limit'] + } + } + } /** Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions. */ - "interactions/remove-restrictions-for-org": { + 'interactions/remove-restrictions-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. */ - "orgs/list-pending-invitations": { + 'orgs/list-pending-invitations': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["organization-invitation"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['organization-invitation'][] + } + } + 404: components['responses']['not_found'] + } + } /** * Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - "orgs/create-invitation": { + 'orgs/create-invitation': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["organization-invitation"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['organization-invitation'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description **Required unless you provide `email`**. GitHub user ID for the person you are inviting. */ - invitee_id?: number; + invitee_id?: number /** @description **Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user. */ - email?: string; + email?: string /** * @description Specify role for new member. Can be one of: * \* `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. @@ -23302,59 +23287,59 @@ export interface operations { * @default direct_member * @enum {string} */ - role?: "admin" | "direct_member" | "billing_manager"; + role?: 'admin' | 'direct_member' | 'billing_manager' /** @description Specify IDs for the teams you want to invite new members to. */ - team_ids?: number[]; - }; - }; - }; - }; + team_ids?: number[] + } + } + } + } /** * Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). */ - "orgs/cancel-invitation": { + 'orgs/cancel-invitation': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** invitation_id parameter */ - invitation_id: components["parameters"]["invitation-id"]; - }; - }; + invitation_id: components['parameters']['invitation-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner. */ - "orgs/list-invitation-teams": { + 'orgs/list-invitation-teams': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** invitation_id parameter */ - invitation_id: components["parameters"]["invitation-id"]; - }; + invitation_id: components['parameters']['invitation-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['team'][] + } + } + 404: components['responses']['not_found'] + } + } /** * List issues in an organization assigned to the authenticated user. * @@ -23363,11 +23348,11 @@ export interface operations { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - "issues/list-for-org": { + 'issues/list-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** * Indicates which sorts of issues to return. Can be one of: @@ -23377,123 +23362,123 @@ export interface operations { * \* `subscribed`: Issues you're subscribed to updates for * \* `all` or `repos`: All issues the authenticated user can see, regardless of participation or creation */ - filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all"; + filter?: 'assigned' | 'created' | 'mentioned' | 'subscribed' | 'repos' | 'all' /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ - state?: "open" | "closed" | "all"; + state?: 'open' | 'closed' | 'all' /** A list of comma separated label names. Example: `bug,ui,@high` */ - labels?: components["parameters"]["labels"]; + labels?: components['parameters']['labels'] /** What to sort results by. Can be either `created`, `updated`, `comments`. */ - sort?: "created" | "updated" | "comments"; + sort?: 'created' | 'updated' | 'comments' /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["issue"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['issue'][] + } + } + 404: components['responses']['not_found'] + } + } /** List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned. */ - "orgs/list-members": { + 'orgs/list-members': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** * Filter members returned in the list. Can be one of: * \* `2fa_disabled` - Members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. Available for organization owners. * \* `all` - All members the authenticated user can see. */ - filter?: "2fa_disabled" | "all"; + filter?: '2fa_disabled' | 'all' /** * Filter members returned by their role. Can be one of: * \* `all` - All members of the organization, regardless of role. * \* `admin` - Organization owners. * \* `member` - Non-owner organization members. */ - role?: "all" | "admin" | "member"; + role?: 'all' | 'admin' | 'member' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; + 'application/json': components['schemas']['simple-user'][] + } + } /** Response if requester is not an organization member */ - 302: never; - 422: components["responses"]["validation_failed"]; - }; - }; + 302: never + 422: components['responses']['validation_failed'] + } + } /** Check if a user is, publicly or privately, a member of the organization. */ - "orgs/check-membership-for-user": { + 'orgs/check-membership-for-user': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** Response if requester is an organization member and user is a member */ - 204: never; + 204: never /** Response if requester is not an organization member */ - 302: never; + 302: never /** Not Found if requester is an organization member and user is not a member */ - 404: unknown; - }; - }; + 404: unknown + } + } /** Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories. */ - "orgs/remove-member": { + 'orgs/remove-member': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 403: components["responses"]["forbidden"]; - }; - }; + 204: never + 403: components['responses']['forbidden'] + } + } /** In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status. */ - "orgs/get-membership-for-user": { + 'orgs/get-membership-for-user': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["org-membership"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['org-membership'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Only authenticated organization owners can add a member to the organization or update the member's role. * @@ -23505,26 +23490,26 @@ export interface operations { * * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. */ - "orgs/set-membership-for-user": { + 'orgs/set-membership-for-user': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["org-membership"]; - }; - }; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['org-membership'] + } + } + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The role to give the user in the organization. Can be one of: * \* `admin` - The user will become an owner of the organization. @@ -23532,102 +23517,102 @@ export interface operations { * @default member * @enum {string} */ - role?: "admin" | "member"; - }; - }; - }; - }; + role?: 'admin' | 'member' + } + } + } + } /** * In order to remove a user's membership with an organization, the authenticated user must be an organization owner. * * If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases. */ - "orgs/remove-membership-for-user": { + 'orgs/remove-membership-for-user': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Lists the most recent migrations. */ - "migrations/list-for-org": { + 'migrations/list-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Exclude attributes from the API response to improve performance */ - exclude?: "repositories"[]; - }; - }; + exclude?: 'repositories'[] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["migration"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['migration'][] + } + } + } + } /** Initiates the generation of a migration archive. */ - "migrations/start-for-org": { + 'migrations/start-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["migration"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['migration'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description A list of arrays indicating which repositories should be migrated. */ - repositories: string[]; + repositories: string[] /** * @description Indicates whether repositories should be locked (to prevent manipulation) while migrating data. * @example true */ - lock_repositories?: boolean; + lock_repositories?: boolean /** * @description Indicates whether attachments should be excluded from the migration (to reduce migration archive file size). * @example true */ - exclude_attachments?: boolean; + exclude_attachments?: boolean /** * @description Indicates whether releases should be excluded from the migration (to reduce migration archive file size). * @example true */ - exclude_releases?: boolean; + exclude_releases?: boolean /** * @description Indicates whether projects owned by the organization or users should be excluded. from the migration. * @example true */ - exclude_owner_projects?: boolean; - exclude?: "repositories"[]; - }; - }; - }; - }; + exclude_owner_projects?: boolean + exclude?: 'repositories'[] + } + } + } + } /** * Fetches the status of a migration. * @@ -23638,18 +23623,18 @@ export interface operations { * * `exported`, which means the migration finished successfully. * * `failed`, which means the migration failed. */ - "migrations/get-status-for-org": { + 'migrations/get-status-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** migration_id parameter */ - migration_id: components["parameters"]["migration-id"]; - }; + migration_id: components['parameters']['migration-id'] + } query: { /** Exclude attributes from the API response to improve performance */ - exclude?: "repositories"[]; - }; - }; + exclude?: 'repositories'[] + } + } responses: { /** * * `pending`, which means the migration hasn't started yet. @@ -23659,212 +23644,212 @@ export interface operations { */ 200: { content: { - "application/json": components["schemas"]["migration"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['migration'] + } + } + 404: components['responses']['not_found'] + } + } /** Fetches the URL to a migration archive. */ - "migrations/download-archive-for-org": { + 'migrations/download-archive-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** migration_id parameter */ - migration_id: components["parameters"]["migration-id"]; - }; - }; + migration_id: components['parameters']['migration-id'] + } + } responses: { /** Response */ - 302: never; - 404: components["responses"]["not_found"]; - }; - }; + 302: never + 404: components['responses']['not_found'] + } + } /** Deletes a previous migration archive. Migration archives are automatically deleted after seven days. */ - "migrations/delete-archive-for-org": { + 'migrations/delete-archive-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** migration_id parameter */ - migration_id: components["parameters"]["migration-id"]; - }; - }; + migration_id: components['parameters']['migration-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/rest/reference/repos#delete-a-repository) when the migration is complete and you no longer need the source data. */ - "migrations/unlock-repo-for-org": { + 'migrations/unlock-repo-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** migration_id parameter */ - migration_id: components["parameters"]["migration-id"]; + migration_id: components['parameters']['migration-id'] /** repo_name parameter */ - repo_name: components["parameters"]["repo-name"]; - }; - }; + repo_name: components['parameters']['repo-name'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** List all the repositories for this organization migration. */ - "migrations/list-repos-for-org": { + 'migrations/list-repos-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** migration_id parameter */ - migration_id: components["parameters"]["migration-id"]; - }; + migration_id: components['parameters']['migration-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["minimal-repository"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['minimal-repository'][] + } + } + 404: components['responses']['not_found'] + } + } /** List all users who are outside collaborators of an organization. */ - "orgs/list-outside-collaborators": { + 'orgs/list-outside-collaborators': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** * Filter the list of outside collaborators. Can be one of: * \* `2fa_disabled`: Outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. * \* `all`: All outside collaborators. */ - filter?: "2fa_disabled" | "all"; + filter?: '2fa_disabled' | 'all' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + } + } /** When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://docs.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)". */ - "orgs/convert-member-to-outside-collaborator": { + 'orgs/convert-member-to-outside-collaborator': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** User is getting converted asynchronously */ 202: { content: { - "application/json": { [key: string]: unknown }; - }; - }; + 'application/json': { [key: string]: unknown } + } + } /** User was converted */ - 204: never; + 204: never /** Forbidden if user is the last owner of the organization or not a member of the organization */ - 403: unknown; - 404: components["responses"]["not_found"]; - }; - }; + 403: unknown + 404: components['responses']['not_found'] + } + } /** Removing a user from this list will remove them from all the organization's repositories. */ - "orgs/remove-outside-collaborator": { + 'orgs/remove-outside-collaborator': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; + 204: never /** Unprocessable Entity if user is a member of the organization */ 422: { content: { - "application/json": { - message?: string; - documentation_url?: string; - }; - }; - }; - }; - }; + 'application/json': { + message?: string + documentation_url?: string + } + } + } + } + } /** * Lists all packages in an organization readable by the user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/list-packages-for-organization": { + 'packages/list-packages-for-organization': { parameters: { query: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + package_type: 'npm' | 'maven' | 'rubygems' | 'docker' | 'nuget' | 'container' /** The selected visibility of the packages. Can be one of `public`, `private`, or `internal`. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set. */ - visibility?: components["parameters"]["package-visibility"]; - }; + visibility?: components['parameters']['package-visibility'] + } path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['package'][] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** * Gets a specific package in an organization. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/get-package-for-organization": { + 'packages/get-package-for-organization': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - org: components["parameters"]["org"]; - }; - }; + package_name: components['parameters']['package-name'] + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package"]; - }; - }; - }; - }; + 'application/json': components['schemas']['package'] + } + } + } + } /** * Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * @@ -23872,24 +23857,24 @@ export interface operations { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. */ - "packages/delete-package-for-org": { + 'packages/delete-package-for-org': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - org: components["parameters"]["org"]; - }; - }; + package_name: components['parameters']['package-name'] + org: components['parameters']['org'] + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Restores an entire package in an organization. * @@ -23901,91 +23886,91 @@ export interface operations { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. */ - "packages/restore-package-for-org": { + 'packages/restore-package-for-org': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - org: components["parameters"]["org"]; - }; + package_name: components['parameters']['package-name'] + org: components['parameters']['org'] + } query: { /** package token */ - token?: string; - }; - }; + token?: string + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Returns all package versions for a package owned by an organization. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/get-all-package-versions-for-package-owned-by-org": { + 'packages/get-all-package-versions-for-package-owned-by-org': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - org: components["parameters"]["org"]; - }; + package_name: components['parameters']['package-name'] + org: components['parameters']['org'] + } query: { /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** The state of the package, either active or deleted. */ - state?: "active" | "deleted"; - }; - }; + state?: 'active' | 'deleted' + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package-version"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['package-version'][] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Gets a specific package version in an organization. * * You must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/get-package-version-for-organization": { + 'packages/get-package-version-for-organization': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - org: components["parameters"]["org"]; + package_name: components['parameters']['package-name'] + org: components['parameters']['org'] /** Unique identifier of the package version. */ - package_version_id: components["parameters"]["package-version-id"]; - }; - }; + package_version_id: components['parameters']['package-version-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package-version"]; - }; - }; - }; - }; + 'application/json': components['schemas']['package-version'] + } + } + } + } /** * Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * @@ -23993,26 +23978,26 @@ export interface operations { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. */ - "packages/delete-package-version-for-org": { + 'packages/delete-package-version-for-org': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - org: components["parameters"]["org"]; + package_name: components['parameters']['package-name'] + org: components['parameters']['org'] /** Unique identifier of the package version. */ - package_version_id: components["parameters"]["package-version-id"]; - }; - }; + package_version_id: components['parameters']['package-version-id'] + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Restores a specific package version in an organization. * @@ -24024,179 +24009,179 @@ export interface operations { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. */ - "packages/restore-package-version-for-org": { + 'packages/restore-package-version-for-org': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - org: components["parameters"]["org"]; + package_name: components['parameters']['package-name'] + org: components['parameters']['org'] /** Unique identifier of the package version. */ - package_version_id: components["parameters"]["package-version-id"]; - }; - }; + package_version_id: components['parameters']['package-version-id'] + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - "projects/list-for-org": { + 'projects/list-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. */ - state?: "open" | "closed" | "all"; + state?: 'open' | 'closed' | 'all' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["project"][]; - }; - }; - 422: components["responses"]["validation_failed_simple"]; - }; - }; + 'application/json': components['schemas']['project'][] + } + } + 422: components['responses']['validation_failed_simple'] + } + } /** Creates an organization project board. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - "projects/create-for-org": { + 'projects/create-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["project"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': components['schemas']['project'] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the project. */ - name: string; + name: string /** @description The description of the project. */ - body?: string; - }; - }; - }; - }; + body?: string + } + } + } + } /** Members of an organization can choose to have their membership publicized or not. */ - "orgs/list-public-members": { + 'orgs/list-public-members': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - }; - }; - "orgs/check-public-membership-for-user": { + 'application/json': components['schemas']['simple-user'][] + } + } + } + } + 'orgs/check-public-membership-for-user': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** Response if user is a public member */ - 204: never; + 204: never /** Not Found if user is not a public member */ - 404: unknown; - }; - }; + 404: unknown + } + } /** * The user can publicize their own membership. (A user cannot publicize the membership for another user.) * * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - "orgs/set-public-membership-for-authenticated-user": { + 'orgs/set-public-membership-for-authenticated-user': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 403: components["responses"]["forbidden"]; - }; - }; - "orgs/remove-public-membership-for-authenticated-user": { + 204: never + 403: components['responses']['forbidden'] + } + } + 'orgs/remove-public-membership-for-authenticated-user': { parameters: { path: { - org: components["parameters"]["org"]; - username: components["parameters"]["username"]; - }; - }; + org: components['parameters']['org'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** Lists repositories for the specified organization. */ - "repos/list-for-org": { + 'repos/list-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Note: For GitHub AE, can be one of `all`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`. However, the `internal` value is not yet supported when a GitHub App calls this API with an installation access token. */ - type?: "all" | "public" | "private" | "forks" | "sources" | "member" | "internal"; + type?: 'all' | 'public' | 'private' | 'forks' | 'sources' | 'member' | 'internal' /** Can be one of `created`, `updated`, `pushed`, `full_name`. */ - sort?: "created" | "updated" | "pushed" | "full_name"; + sort?: 'created' | 'updated' | 'pushed' | 'full_name' /** Can be one of `asc` or `desc`. Default: when using `full_name`: `asc`, otherwise `desc` */ - direction?: "asc" | "desc"; + direction?: 'asc' | 'desc' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["minimal-repository"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['minimal-repository'][] + } + } + } + } /** * Creates a new repository in the specified organization. The authenticated user must be a member of the organization. * @@ -24207,129 +24192,129 @@ export interface operations { * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. * * `repo` scope to create a private repository */ - "repos/create-in-org": { + 'repos/create-in-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["repository"]; - }; - }; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['repository'] + } + } + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the repository. */ - name: string; + name: string /** @description A short description of the repository. */ - description?: string; + description?: string /** @description A URL with more information about the repository. */ - homepage?: string; + homepage?: string /** @description Whether the repository is private. */ - private?: boolean; + private?: boolean /** * @description Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see "[Creating an internal repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)" in the GitHub Help documentation. * @enum {string} */ - visibility?: "public" | "private" | "internal"; + visibility?: 'public' | 'private' | 'internal' /** * @description Either `true` to enable issues for this repository or `false` to disable them. * @default true */ - has_issues?: boolean; + has_issues?: boolean /** * @description Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error. * @default true */ - has_projects?: boolean; + has_projects?: boolean /** * @description Either `true` to enable the wiki for this repository or `false` to disable it. * @default true */ - has_wiki?: boolean; + has_wiki?: boolean /** @description Either `true` to make this repo available as a template repository or `false` to prevent it. */ - is_template?: boolean; + is_template?: boolean /** @description The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. */ - team_id?: number; + team_id?: number /** @description Pass `true` to create an initial commit with empty README. */ - auto_init?: boolean; + auto_init?: boolean /** @description Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, "Haskell". */ - gitignore_template?: string; + gitignore_template?: string /** @description Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, "mit" or "mpl-2.0". */ - license_template?: string; + license_template?: string /** * @description Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge?: boolean /** * @description Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit?: boolean /** * @description Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge?: boolean /** @description Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. */ - allow_auto_merge?: boolean; + allow_auto_merge?: boolean /** @description Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. */ - delete_branch_on_merge?: boolean; - }; - }; - }; - }; + delete_branch_on_merge?: boolean + } + } + } + } /** * Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest. * To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. */ - "secret-scanning/list-alerts-for-org": { + 'secret-scanning/list-alerts-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - state?: components["parameters"]["secret-scanning-alert-state"]; + state?: components['parameters']['secret-scanning-alert-state'] /** * A comma-separated list of secret types to return. By default all secret types are returned. * See "[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)" * for a complete list of secret types (API slug). */ - secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; + secret_type?: components['parameters']['secret-scanning-alert-secret-type'] /** A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - resolution?: components["parameters"]["secret-scanning-alert-resolution"]; + resolution?: components['parameters']['secret-scanning-alert-resolution'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["organization-secret-scanning-alert"][]; - }; - }; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': components['schemas']['organization-secret-scanning-alert'][] + } + } + 404: components['responses']['not_found'] + 503: components['responses']['service_unavailable'] + } + } /** * Gets the summary of the free and paid GitHub Actions minutes used. * @@ -24337,48 +24322,48 @@ export interface operations { * * Access tokens must have the `repo` or `admin:org` scope. */ - "billing/get-github-actions-billing-org": { + 'billing/get-github-actions-billing-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-billing-usage"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-billing-usage'] + } + } + } + } /** * Gets the GitHub Advanced Security active committers for an organization per repository. * Each distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of advanced_security_committers for each repository. * If this organization defers to an enterprise for billing, the total_advanced_security_committers returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level. */ - "billing/get-github-advanced-security-billing-org": { + 'billing/get-github-advanced-security-billing-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Success */ 200: { content: { - "application/json": components["schemas"]["advanced-security-active-committers"]; - }; - }; - 403: components["responses"]["code_scanning_forbidden_read"]; - }; - }; + 'application/json': components['schemas']['advanced-security-active-committers'] + } + } + 403: components['responses']['code_scanning_forbidden_read'] + } + } /** * Gets the free and paid storage used for GitHub Packages in gigabytes. * @@ -24386,21 +24371,21 @@ export interface operations { * * Access tokens must have the `repo` or `admin:org` scope. */ - "billing/get-github-packages-billing-org": { + 'billing/get-github-packages-billing-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["packages-billing-usage"]; - }; - }; - }; - }; + 'application/json': components['schemas']['packages-billing-usage'] + } + } + } + } /** * Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. * @@ -24408,106 +24393,106 @@ export interface operations { * * Access tokens must have the `repo` or `admin:org` scope. */ - "billing/get-shared-storage-billing-org": { + 'billing/get-shared-storage-billing-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["combined-billing-usage"]; - }; - }; - }; - }; + 'application/json': components['schemas']['combined-billing-usage'] + } + } + } + } /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * List IdP groups available in an organization. You can limit your page results using the `per_page` parameter. GitHub generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." */ - "teams/list-idp-groups-for-org": { + 'teams/list-idp-groups-for-org': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page token */ - page?: string; - }; - }; + page?: string + } + } responses: { /** Response */ 200: { headers: { - Link?: string; - }; - content: { - "application/json": components["schemas"]["group-mapping"]; - }; - }; - }; - }; + Link?: string + } + content: { + 'application/json': components['schemas']['group-mapping'] + } + } + } + } /** Lists all teams in an organization that are visible to the authenticated user. */ - "teams/list": { + 'teams/list': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team"][]; - }; - }; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['team'][] + } + } + 403: components['responses']['forbidden'] + } + } /** * To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://docs.github.com/en/articles/setting-team-creation-permissions-in-your-organization)." * * When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)". */ - "teams/create": { + 'teams/create': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["team-full"]; - }; - }; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['team-full'] + } + } + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the team. */ - name: string; + name: string /** @description The description of the team. */ - description?: string; + description?: string /** @description List GitHub IDs for organization members who will become team maintainers. */ - maintainers?: string[]; + maintainers?: string[] /** @description The full name (e.g., "organization-name/repository-name") of repositories to add the team to. */ - repo_names?: string[]; + repo_names?: string[] /** * @description The level of privacy this team should have. The options are: * **For a non-nested team:** @@ -24519,7 +24504,7 @@ export interface operations { * Default for child team: `closed` * @enum {string} */ - privacy?: "secret" | "closed"; + privacy?: 'secret' | 'closed' /** * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: * \* `pull` - team members can pull, but not push to or administer newly-added repositories. @@ -24527,36 +24512,36 @@ export interface operations { * @default pull * @enum {string} */ - permission?: "pull" | "push"; + permission?: 'pull' | 'push' /** @description The ID of a team to set as the parent team. */ - parent_team_id?: number; - }; - }; - }; - }; + parent_team_id?: number + } + } + } + } /** * Gets a team using the team's `slug`. GitHub generates the `slug` from the team `name`. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. */ - "teams/get-by-name": { + 'teams/get-by-name': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; - }; + team_slug: components['parameters']['team-slug'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-full"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['team-full'] + } + } + 404: components['responses']['not_found'] + } + } /** * To delete a team, the authenticated user must be an organization owner or team maintainer. * @@ -24564,47 +24549,47 @@ export interface operations { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. */ - "teams/delete-in-org": { + 'teams/delete-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; - }; + team_slug: components['parameters']['team-slug'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * To edit a team, the authenticated user must either be an organization owner or a team maintainer. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. */ - "teams/update-in-org": { + 'teams/update-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; - }; + team_slug: components['parameters']['team-slug'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["team-full"]; - }; - }; - }; + 'application/json': components['schemas']['team-full'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the team. */ - name?: string; + name?: string /** @description The description of the team. */ - description?: string; + description?: string /** * @description The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: * **For a non-nested team:** @@ -24614,7 +24599,7 @@ export interface operations { * \* `closed` - visible to all members of this organization. * @enum {string} */ - privacy?: "secret" | "closed"; + privacy?: 'secret' | 'closed' /** * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: * \* `pull` - team members can pull, but not push to or administer newly-added repositories. @@ -24623,46 +24608,46 @@ export interface operations { * @default pull * @enum {string} */ - permission?: "pull" | "push" | "admin"; + permission?: 'pull' | 'push' | 'admin' /** @description The ID of a team to set as the parent team. */ - parent_team_id?: number | null; - }; - }; - }; - }; + parent_team_id?: number | null + } + } + } + } /** * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. */ - "teams/list-discussions-in-org": { + 'teams/list-discussions-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; + team_slug: components['parameters']['team-slug'] + } query: { /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Pinned discussions only filter */ - pinned?: string; - }; - }; + pinned?: string + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team-discussion"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['team-discussion'][] + } + } + } + } /** * Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @@ -24670,142 +24655,142 @@ export interface operations { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. */ - "teams/create-discussion-in-org": { + 'teams/create-discussion-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; - }; + team_slug: components['parameters']['team-slug'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; + 'application/json': components['schemas']['team-discussion'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The discussion post's title. */ - title: string; + title: string /** @description The discussion post's body text. */ - body: string; + body: string /** @description Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. */ - private?: boolean; - }; - }; - }; - }; + private?: boolean + } + } + } + } /** * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. */ - "teams/get-discussion-in-org": { + 'teams/get-discussion-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - }; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; - }; + 'application/json': components['schemas']['team-discussion'] + } + } + } + } /** * Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. */ - "teams/delete-discussion-in-org": { + 'teams/delete-discussion-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - }; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. */ - "teams/update-discussion-in-org": { + 'teams/update-discussion-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - }; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; + 'application/json': components['schemas']['team-discussion'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The discussion post's title. */ - title?: string; + title?: string /** @description The discussion post's body text. */ - body?: string; - }; - }; - }; - }; + body?: string + } + } + } + } /** * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. */ - "teams/list-discussion-comments-in-org": { + 'teams/list-discussion-comments-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + } query: { /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team-discussion-comment"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['team-discussion-comment'][] + } + } + } + } /** * Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @@ -24813,387 +24798,387 @@ export interface operations { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. */ - "teams/create-discussion-comment-in-org": { + 'teams/create-discussion-comment-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - }; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; + 'application/json': components['schemas']['team-discussion-comment'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The discussion comment's body text. */ - body: string; - }; - }; - }; - }; + body: string + } + } + } + } /** * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. */ - "teams/get-discussion-comment-in-org": { + 'teams/get-discussion-comment-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - comment_number: components["parameters"]["comment-number"]; - }; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + comment_number: components['parameters']['comment-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; - }; + 'application/json': components['schemas']['team-discussion-comment'] + } + } + } + } /** * Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. */ - "teams/delete-discussion-comment-in-org": { + 'teams/delete-discussion-comment-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - comment_number: components["parameters"]["comment-number"]; - }; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + comment_number: components['parameters']['comment-number'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. */ - "teams/update-discussion-comment-in-org": { + 'teams/update-discussion-comment-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - comment_number: components["parameters"]["comment-number"]; - }; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + comment_number: components['parameters']['comment-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; + 'application/json': components['schemas']['team-discussion-comment'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The discussion comment's body text. */ - body: string; - }; - }; - }; - }; + body: string + } + } + } + } /** * List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments/). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. */ - "reactions/list-for-team-discussion-comment-in-org": { + 'reactions/list-for-team-discussion-comment-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - comment_number: components["parameters"]["comment-number"]; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + comment_number: components['parameters']['comment-number'] + } query: { /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion comment. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content?: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["reaction"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['reaction'][] + } + } + } + } /** * Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. */ - "reactions/create-for-team-discussion-comment-in-org": { + 'reactions/create-for-team-discussion-comment-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - comment_number: components["parameters"]["comment-number"]; - }; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + comment_number: components['parameters']['comment-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; + 'application/json': components['schemas']['reaction'] + } + } /** Response */ 201: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - }; + 'application/json': components['schemas']['reaction'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion comment. * @enum {string} */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - }; + content: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' + } + } + } + } /** * **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. * * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "reactions/delete-for-team-discussion-comment": { + 'reactions/delete-for-team-discussion-comment': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - comment_number: components["parameters"]["comment-number"]; - reaction_id: components["parameters"]["reaction-id"]; - }; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + comment_number: components['parameters']['comment-number'] + reaction_id: components['parameters']['reaction-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. */ - "reactions/list-for-team-discussion-in-org": { + 'reactions/list-for-team-discussion-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + } query: { /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content?: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["reaction"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['reaction'][] + } + } + } + } /** * Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. */ - "reactions/create-for-team-discussion-in-org": { + 'reactions/create-for-team-discussion-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - }; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; + 'application/json': components['schemas']['reaction'] + } + } /** Response */ 201: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - }; + 'application/json': components['schemas']['reaction'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion. * @enum {string} */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - }; + content: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' + } + } + } + } /** * **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. * * Delete a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "reactions/delete-for-team-discussion": { + 'reactions/delete-for-team-discussion': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - discussion_number: components["parameters"]["discussion-number"]; - reaction_id: components["parameters"]["reaction-id"]; - }; - }; + team_slug: components['parameters']['team-slug'] + discussion_number: components['parameters']['discussion-number'] + reaction_id: components['parameters']['reaction-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Deletes a connection between a team and an external group. * * You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "teams/unlink-external-idp-group-from-team-for-org": { + 'teams/unlink-external-idp-group-from-team-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; - }; + team_slug: components['parameters']['team-slug'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Creates a connection between a team and an external group. Only one external group can be linked to a team. * * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ - "teams/link-external-idp-group-to-team-for-org": { + 'teams/link-external-idp-group-to-team-for-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; - }; + team_slug: components['parameters']['team-slug'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["external-group"]; - }; - }; - }; + 'application/json': components['schemas']['external-group'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description External Group Id * @example 1 */ - group_id: number; - }; - }; - }; - }; + group_id: number + } + } + } + } /** * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. */ - "teams/list-pending-invitations-in-org": { + 'teams/list-pending-invitations-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; + team_slug: components['parameters']['team-slug'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["organization-invitation"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['organization-invitation'][] + } + } + } + } /** * Team members will include the members of child teams. * * To list members in a team, the team must be visible to the authenticated user. */ - "teams/list-members-in-org": { + 'teams/list-members-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; + team_slug: components['parameters']['team-slug'] + } query: { /** * Filters members returned by their role in the team. Can be one of: @@ -25201,23 +25186,23 @@ export interface operations { * \* `maintainer` - team maintainers. * \* `all` - all members of the team. */ - role?: "member" | "maintainer" | "all"; + role?: 'member' | 'maintainer' | 'all' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + } + } /** * Team members will include the members of child teams. * @@ -25230,26 +25215,26 @@ export interface operations { * * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team). */ - "teams/get-membership-for-user-in-org": { + 'teams/get-membership-for-user-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - username: components["parameters"]["username"]; - }; - }; + team_slug: components['parameters']['team-slug'] + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-membership"]; - }; - }; + 'application/json': components['schemas']['team-membership'] + } + } /** if user has no team membership */ - 404: unknown; - }; - }; + 404: unknown + } + } /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -25263,30 +25248,30 @@ export interface operations { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ - "teams/add-or-update-membership-for-user-in-org": { + 'teams/add-or-update-membership-for-user-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - username: components["parameters"]["username"]; - }; - }; + team_slug: components['parameters']['team-slug'] + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-membership"]; - }; - }; + 'application/json': components['schemas']['team-membership'] + } + } /** Forbidden if team synchronization is set up */ - 403: unknown; + 403: unknown /** Unprocessable Entity if you attempt to add an organization to a team */ - 422: unknown; - }; + 422: unknown + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The role that this user should have in the team. Can be one of: * \* `member` - a normal member of the team. @@ -25294,11 +25279,11 @@ export interface operations { * @default member * @enum {string} */ - role?: "member" | "maintainer"; - }; - }; - }; - }; + role?: 'member' | 'maintainer' + } + } + } + } /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -25308,106 +25293,106 @@ export interface operations { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ - "teams/remove-membership-for-user-in-org": { + 'teams/remove-membership-for-user-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - username: components["parameters"]["username"]; - }; - }; + team_slug: components['parameters']['team-slug'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; + 204: never /** Forbidden if team synchronization is set up */ - 403: unknown; - }; - }; + 403: unknown + } + } /** * Lists the organization projects for a team. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. */ - "teams/list-projects-in-org": { + 'teams/list-projects-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; + team_slug: components['parameters']['team-slug'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team-project"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['team-project'][] + } + } + } + } /** * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ - "teams/check-permissions-for-project-in-org": { + 'teams/check-permissions-for-project-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - project_id: components["parameters"]["project-id"]; - }; - }; + team_slug: components['parameters']['team-slug'] + project_id: components['parameters']['project-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-project"]; - }; - }; + 'application/json': components['schemas']['team-project'] + } + } /** Not Found if project is not managed by this team */ - 404: unknown; - }; - }; + 404: unknown + } + } /** * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ - "teams/add-or-update-project-permissions-in-org": { + 'teams/add-or-update-project-permissions-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - project_id: components["parameters"]["project-id"]; - }; - }; + team_slug: components['parameters']['team-slug'] + project_id: components['parameters']['project-id'] + } + } responses: { /** Response */ - 204: never; + 204: never /** Forbidden if the project is not owned by the organization */ 403: { content: { - "application/json": { - message?: string; - documentation_url?: string; - }; - }; - }; - }; + 'application/json': { + message?: string + documentation_url?: string + } + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The permission to grant to the team for this project. Can be one of: * \* `read` - team members can read, but not write to or administer this project. @@ -25416,59 +25401,59 @@ export interface operations { * Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." * @enum {string} */ - permission?: "read" | "write" | "admin"; - } | null; - }; - }; - }; + permission?: 'read' | 'write' | 'admin' + } | null + } + } + } /** * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ - "teams/remove-project-in-org": { + 'teams/remove-project-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - project_id: components["parameters"]["project-id"]; - }; - }; + team_slug: components['parameters']['team-slug'] + project_id: components['parameters']['project-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Lists a team's repositories visible to the authenticated user. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. */ - "teams/list-repos-in-org": { + 'teams/list-repos-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; + team_slug: components['parameters']['team-slug'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["minimal-repository"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['minimal-repository'][] + } + } + } + } /** * Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. * @@ -25478,29 +25463,29 @@ export interface operations { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ - "teams/check-permissions-for-repo-in-org": { + 'teams/check-permissions-for-repo-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + team_slug: components['parameters']['team-slug'] + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Alternative response with repository permissions */ 200: { content: { - "application/json": components["schemas"]["team-repository"]; - }; - }; + 'application/json': components['schemas']['team-repository'] + } + } /** Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header. */ - 204: never; + 204: never /** Not Found if team does not have permission for the repository */ - 404: unknown; - }; - }; + 404: unknown + } + } /** * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." * @@ -25508,23 +25493,23 @@ export interface operations { * * For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". */ - "teams/add-or-update-repo-permissions-in-org": { + 'teams/add-or-update-repo-permissions-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + team_slug: components['parameters']['team-slug'] + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The permission to grant the team on this repository. Can be one of: * \* `pull` - team members can pull, but not push to or administer this repository. @@ -25538,31 +25523,31 @@ export interface operations { * @default push * @enum {string} */ - permission?: "pull" | "push" | "admin" | "maintain" | "triage"; - }; - }; - }; - }; + permission?: 'pull' | 'push' | 'admin' | 'maintain' | 'triage' + } + } + } + } /** * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ - "teams/remove-repo-in-org": { + 'teams/remove-repo-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + team_slug: components['parameters']['team-slug'] + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -25570,23 +25555,23 @@ export interface operations { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`. */ - "teams/list-idp-groups-in-org": { + 'teams/list-idp-groups-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; - }; + team_slug: components['parameters']['team-slug'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["group-mapping"]; - }; - }; - }; - }; + 'application/json': components['schemas']['group-mapping'] + } + } + } + } /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -25594,510 +25579,508 @@ export interface operations { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`. */ - "teams/create-or-update-idp-group-connections-in-org": { + 'teams/create-or-update-idp-group-connections-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; - }; + team_slug: components['parameters']['team-slug'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["group-mapping"]; - }; - }; - }; + 'application/json': components['schemas']['group-mapping'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The IdP groups you want to connect to a GitHub team. When updating, the new `groups` object will replace the original one. You must include any existing groups that you don't want to remove. */ groups?: { /** @description ID of the IdP group. */ - group_id: string; + group_id: string /** @description Name of the IdP group. */ - group_name: string; + group_name: string /** @description Description of the IdP group. */ - group_description: string; - }[]; - }; - }; - }; - }; + group_description: string + }[] + } + } + } + } /** * Lists the child teams of the team specified by `{team_slug}`. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. */ - "teams/list-child-in-org": { + 'teams/list-child-in-org': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** team_slug parameter */ - team_slug: components["parameters"]["team-slug"]; - }; + team_slug: components['parameters']['team-slug'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** if child teams exist */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team"][]; - }; - }; - }; - }; - "projects/get-card": { + 'application/json': components['schemas']['team'][] + } + } + } + } + 'projects/get-card': { parameters: { path: { /** card_id parameter */ - card_id: components["parameters"]["card-id"]; - }; - }; + card_id: components['parameters']['card-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["project-card"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "projects/delete-card": { + 'application/json': components['schemas']['project-card'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'projects/delete-card': { parameters: { path: { /** card_id parameter */ - card_id: components["parameters"]["card-id"]; - }; - }; + card_id: components['parameters']['card-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] /** Forbidden */ 403: { content: { - "application/json": { - message?: string; - documentation_url?: string; - errors?: string[]; - }; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "projects/update-card": { + 'application/json': { + message?: string + documentation_url?: string + errors?: string[] + } + } + } + 404: components['responses']['not_found'] + } + } + 'projects/update-card': { parameters: { path: { /** card_id parameter */ - card_id: components["parameters"]["card-id"]; - }; - }; + card_id: components['parameters']['card-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["project-card"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': components['schemas']['project-card'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The project card's note * @example Update all gems */ - note?: string | null; + note?: string | null /** @description Whether or not the card is archived */ - archived?: boolean; - }; - }; - }; - }; - "projects/move-card": { + archived?: boolean + } + } + } + } + 'projects/move-card': { parameters: { path: { /** card_id parameter */ - card_id: components["parameters"]["card-id"]; - }; - }; + card_id: components['parameters']['card-id'] + } + } responses: { /** Response */ 201: { content: { - "application/json": { [key: string]: unknown }; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; + 'application/json': { [key: string]: unknown } + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] /** Forbidden */ 403: { content: { - "application/json": { - message?: string; - documentation_url?: string; + 'application/json': { + message?: string + documentation_url?: string errors?: { - code?: string; - message?: string; - resource?: string; - field?: string; - }[]; - }; - }; - }; - 422: components["responses"]["validation_failed"]; + code?: string + message?: string + resource?: string + field?: string + }[] + } + } + } + 422: components['responses']['validation_failed'] /** Response */ 503: { content: { - "application/json": { - code?: string; - message?: string; - documentation_url?: string; + 'application/json': { + code?: string + message?: string + documentation_url?: string errors?: { - code?: string; - message?: string; - }[]; - }; - }; - }; - }; + code?: string + message?: string + }[] + } + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card. * @example bottom */ - position: string; + position: string /** * @description The unique identifier of the column the card should be moved to * @example 42 */ - column_id?: number; - }; - }; - }; - }; - "projects/get-column": { + column_id?: number + } + } + } + } + 'projects/get-column': { parameters: { path: { /** column_id parameter */ - column_id: components["parameters"]["column-id"]; - }; - }; + column_id: components['parameters']['column-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["project-column"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "projects/delete-column": { + 'application/json': components['schemas']['project-column'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'projects/delete-column': { parameters: { path: { /** column_id parameter */ - column_id: components["parameters"]["column-id"]; - }; - }; + column_id: components['parameters']['column-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; - "projects/update-column": { + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } + 'projects/update-column': { parameters: { path: { /** column_id parameter */ - column_id: components["parameters"]["column-id"]; - }; - }; + column_id: components['parameters']['column-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["project-column"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; + 'application/json': components['schemas']['project-column'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description Name of the project column * @example Remaining tasks */ - name: string; - }; - }; - }; - }; - "projects/list-cards": { + name: string + } + } + } + } + 'projects/list-cards': { parameters: { path: { /** column_id parameter */ - column_id: components["parameters"]["column-id"]; - }; + column_id: components['parameters']['column-id'] + } query: { /** Filters the project cards that are returned by the card's state. Can be one of `all`,`archived`, or `not_archived`. */ - archived_state?: "all" | "archived" | "not_archived"; + archived_state?: 'all' | 'archived' | 'not_archived' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["project-card"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; - "projects/create-card": { + 'application/json': components['schemas']['project-card'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } + 'projects/create-card': { parameters: { path: { /** column_id parameter */ - column_id: components["parameters"]["column-id"]; - }; - }; + column_id: components['parameters']['column-id'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["project-card"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; + 'application/json': components['schemas']['project-card'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] /** Validation failed */ 422: { content: { - "application/json": - | components["schemas"]["validation-error"] - | components["schemas"]["validation-error-simple"]; - }; - }; + 'application/json': components['schemas']['validation-error'] | components['schemas']['validation-error-simple'] + } + } /** Response */ 503: { content: { - "application/json": { - code?: string; - message?: string; - documentation_url?: string; + 'application/json': { + code?: string + message?: string + documentation_url?: string errors?: { - code?: string; - message?: string; - }[]; - }; - }; - }; - }; + code?: string + message?: string + }[] + } + } + } + } requestBody: { content: { - "application/json": + 'application/json': | { /** * @description The project card's note * @example Update all gems */ - note: string | null; + note: string | null } | { /** * @description The unique identifier of the content associated with the card * @example 42 */ - content_id: number; + content_id: number /** * @description The piece of content associated with the card * @example PullRequest */ - content_type: string; - }; - }; - }; - }; - "projects/move-column": { + content_type: string + } + } + } + } + 'projects/move-column': { parameters: { path: { /** column_id parameter */ - column_id: components["parameters"]["column-id"]; - }; - }; + column_id: components['parameters']['column-id'] + } + } responses: { /** Response */ 201: { content: { - "application/json": { [key: string]: unknown }; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': { [key: string]: unknown } + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column. * @example last */ - position: string; - }; - }; - }; - }; + position: string + } + } + } + } /** Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - "projects/get": { + 'projects/get': { parameters: { path: { - project_id: components["parameters"]["project-id"]; - }; - }; + project_id: components['parameters']['project-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["project"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['project'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** Deletes a project board. Returns a `404 Not Found` status if projects are disabled. */ - "projects/delete": { + 'projects/delete': { parameters: { path: { - project_id: components["parameters"]["project-id"]; - }; - }; + project_id: components['parameters']['project-id'] + } + } responses: { /** Delete Success */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] /** Forbidden */ 403: { content: { - "application/json": { - message?: string; - documentation_url?: string; - errors?: string[]; - }; - }; - }; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - }; - }; + 'application/json': { + message?: string + documentation_url?: string + errors?: string[] + } + } + } + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + } + } /** Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - "projects/update": { + 'projects/update': { parameters: { path: { - project_id: components["parameters"]["project-id"]; - }; - }; + project_id: components['parameters']['project-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["project"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; + 'application/json': components['schemas']['project'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] /** Forbidden */ 403: { content: { - "application/json": { - message?: string; - documentation_url?: string; - errors?: string[]; - }; - }; - }; + 'application/json': { + message?: string + documentation_url?: string + errors?: string[] + } + } + } /** Not Found if the authenticated user does not have access to the project */ - 404: unknown; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 404: unknown + 410: components['responses']['gone'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description Name of the project * @example Week One Sprint */ - name?: string; + name?: string /** * @description Body of the project * @example This project represents the sprint of the first week in January */ - body?: string | null; + body?: string | null /** * @description State of the project; either 'open' or 'closed' * @example open */ - state?: string; + state?: string /** * @description The baseline permission that all organization members have on this project * @enum {string} */ - organization_permission?: "read" | "write" | "admin" | "none"; + organization_permission?: 'read' | 'write' | 'admin' | 'none' /** @description Whether or not this project can be seen by everyone. */ - private?: boolean; - }; - }; - }; - }; + private?: boolean + } + } + } + } /** Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators. */ - "projects/list-collaborators": { + 'projects/list-collaborators': { parameters: { path: { - project_id: components["parameters"]["project-id"]; - }; + project_id: components['parameters']['project-id'] + } query: { /** * Filters the collaborators by their affiliation. Can be one of: @@ -26105,483 +26088,483 @@ export interface operations { * \* `direct`: Collaborators with permissions to a project, regardless of organization membership status. * \* `all`: All collaborators the authenticated user can see. */ - affiliation?: "outside" | "direct" | "all"; + affiliation?: 'outside' | 'direct' | 'all' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator. */ - "projects/add-collaborator": { + 'projects/add-collaborator': { parameters: { path: { - project_id: components["parameters"]["project-id"]; - username: components["parameters"]["username"]; - }; - }; + project_id: components['parameters']['project-id'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The permission to grant the collaborator. * @default write * @example write * @enum {string} */ - permission?: "read" | "write" | "admin"; - } | null; - }; - }; - }; + permission?: 'read' | 'write' | 'admin' + } | null + } + } + } /** Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator. */ - "projects/remove-collaborator": { + 'projects/remove-collaborator': { parameters: { path: { - project_id: components["parameters"]["project-id"]; - username: components["parameters"]["username"]; - }; - }; + project_id: components['parameters']['project-id'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level. */ - "projects/get-permission-for-user": { + 'projects/get-permission-for-user': { parameters: { path: { - project_id: components["parameters"]["project-id"]; - username: components["parameters"]["username"]; - }; - }; + project_id: components['parameters']['project-id'] + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["project-collaborator-permission"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "projects/list-columns": { + 'application/json': components['schemas']['project-collaborator-permission'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } + 'projects/list-columns': { parameters: { path: { - project_id: components["parameters"]["project-id"]; - }; + project_id: components['parameters']['project-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["project-column"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; - "projects/create-column": { + 'application/json': components['schemas']['project-column'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } + 'projects/create-column': { parameters: { path: { - project_id: components["parameters"]["project-id"]; - }; - }; + project_id: components['parameters']['project-id'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["project-column"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': components['schemas']['project-column'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description Name of the project column * @example Remaining tasks */ - name: string; - }; - }; - }; - }; + name: string + } + } + } + } /** * **Note:** Accessing this endpoint does not count against your REST API rate limit. * * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. */ - "rate-limit/get": { - parameters: {}; + 'rate-limit/get': { + parameters: {} responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["rate-limit-overview"]; - }; - }; - 304: components["responses"]["not_modified"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['rate-limit-overview'] + } + } + 304: components['responses']['not_modified'] + 404: components['responses']['not_found'] + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Reactions API. We recommend migrating your existing code to use the new delete reactions endpoints. For more information, see this [blog post](https://developer.github.com/changes/2020-02-26-new-delete-reactions-endpoints/). * * OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), when deleting a [team discussion](https://docs.github.com/rest/reference/teams#discussions) or [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). */ - "reactions/delete-legacy": { + 'reactions/delete-legacy': { parameters: { path: { - reaction_id: components["parameters"]["reaction-id"]; - }; - }; + reaction_id: components['parameters']['reaction-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 410: components["responses"]["gone"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 410: components['responses']['gone'] + } + } /** The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. */ - "repos/get": { + 'repos/get': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["full-repository"]; - }; - }; - 301: components["responses"]["moved_permanently"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['full-repository'] + } + } + 301: components['responses']['moved_permanently'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required. * * If an organization owner has configured the organization to prevent members from deleting organization-owned * repositories, you will get a `403 Forbidden` response. */ - "repos/delete": { + 'repos/delete': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - 307: components["responses"]["temporary_redirect"]; + 204: never + 307: components['responses']['temporary_redirect'] /** If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response: */ 403: { content: { - "application/json": { - message?: string; - documentation_url?: string; - }; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': { + message?: string + documentation_url?: string + } + } + } + 404: components['responses']['not_found'] + } + } /** **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/rest/reference/repos#replace-all-repository-topics) endpoint. */ - "repos/update": { + 'repos/update': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["full-repository"]; - }; - }; - 307: components["responses"]["temporary_redirect"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['full-repository'] + } + } + 307: components['responses']['temporary_redirect'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the repository. */ - name?: string; + name?: string /** @description A short description of the repository. */ - description?: string; + description?: string /** @description A URL with more information about the repository. */ - homepage?: string; + homepage?: string /** * @description Either `true` to make the repository private or `false` to make it public. Default: `false`. * **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. */ - private?: boolean; + private?: boolean /** * @description Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`." * @enum {string} */ - visibility?: "public" | "private" | "internal"; + visibility?: 'public' | 'private' | 'internal' /** @description Specify which security and analysis features to enable or disable. For example, to enable GitHub Advanced Security, use this data in the body of the PATCH request: `{"security_and_analysis": {"advanced_security": {"status": "enabled"}}}`. If you have admin permissions for a private repository covered by an Advanced Security license, you can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request. */ security_and_analysis?: { /** @description Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see "[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security)." */ advanced_security?: { /** @description Can be `enabled` or `disabled`. */ - status?: string; - }; + status?: string + } /** @description Use the `status` property to enable or disable secret scanning for this repository. For more information, see "[About secret scanning](/code-security/secret-security/about-secret-scanning)." */ secret_scanning?: { /** @description Can be `enabled` or `disabled`. */ - status?: string; - }; - } | null; + status?: string + } + } | null /** * @description Either `true` to enable issues for this repository or `false` to disable them. * @default true */ - has_issues?: boolean; + has_issues?: boolean /** * @description Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error. * @default true */ - has_projects?: boolean; + has_projects?: boolean /** * @description Either `true` to enable the wiki for this repository or `false` to disable it. * @default true */ - has_wiki?: boolean; + has_wiki?: boolean /** @description Either `true` to make this repo available as a template repository or `false` to prevent it. */ - is_template?: boolean; + is_template?: boolean /** @description Updates the default branch for this repository. */ - default_branch?: string; + default_branch?: string /** * @description Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge?: boolean /** * @description Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit?: boolean /** * @description Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge?: boolean /** @description Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. */ - allow_auto_merge?: boolean; + allow_auto_merge?: boolean /** @description Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge?: boolean /** @description `true` to archive this repository. **Note**: You cannot unarchive repositories through the API. */ - archived?: boolean; + archived?: boolean /** @description Either `true` to allow private forks, or `false` to prevent private forks. */ - allow_forking?: boolean; - }; - }; - }; - }; + allow_forking?: boolean + } + } + } + } /** Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/list-artifacts-for-repo": { + 'actions/list-artifacts-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - artifacts: components["schemas"]["artifact"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + artifacts: components['schemas']['artifact'][] + } + } + } + } + } /** Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/get-artifact": { + 'actions/get-artifact': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** artifact_id parameter */ - artifact_id: components["parameters"]["artifact-id"]; - }; - }; + artifact_id: components['parameters']['artifact-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["artifact"]; - }; - }; - }; - }; + 'application/json': components['schemas']['artifact'] + } + } + } + } /** Deletes an artifact for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - "actions/delete-artifact": { + 'actions/delete-artifact': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** artifact_id parameter */ - artifact_id: components["parameters"]["artifact-id"]; - }; - }; + artifact_id: components['parameters']['artifact-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in * the response header to find the URL for the download. The `:archive_format` must be `zip`. Anyone with read access to * the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/download-artifact": { + 'actions/download-artifact': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** artifact_id parameter */ - artifact_id: components["parameters"]["artifact-id"]; - archive_format: string; - }; - }; + artifact_id: components['parameters']['artifact-id'] + archive_format: string + } + } responses: { /** Response */ - 302: never; - }; - }; + 302: never + } + } /** Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/get-job-for-workflow-run": { + 'actions/get-job-for-workflow-run': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** job_id parameter */ - job_id: components["parameters"]["job-id"]; - }; - }; + job_id: components['parameters']['job-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["job"]; - }; - }; - }; - }; + 'application/json': components['schemas']['job'] + } + } + } + } /** * Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look * for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can * use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must * have the `actions:read` permission to use this endpoint. */ - "actions/download-job-logs-for-workflow-run": { + 'actions/download-job-logs-for-workflow-run': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** job_id parameter */ - job_id: components["parameters"]["job-id"]; - }; - }; + job_id: components['parameters']['job-id'] + } + } responses: { /** Response */ - 302: never; - }; - }; + 302: never + } + } /** * Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository. * * You must authenticate using an access token with the `repo` scope to use this * endpoint. GitHub Apps must have the `administration` repository permission to use this API. */ - "actions/get-github-actions-permissions-repository": { + 'actions/get-github-actions-permissions-repository': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-repository-permissions"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-repository-permissions'] + } + } + } + } /** * Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository. * @@ -26589,47 +26572,47 @@ export interface operations { * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. */ - "actions/set-github-actions-permissions-repository": { + 'actions/set-github-actions-permissions-repository': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { - enabled: components["schemas"]["actions-enabled"]; - allowed_actions?: components["schemas"]["allowed-actions"]; - }; - }; - }; - }; + 'application/json': { + enabled: components['schemas']['actions-enabled'] + allowed_actions?: components['schemas']['allowed-actions'] + } + } + } + } /** * Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. */ - "actions/get-allowed-actions-repository": { + 'actions/get-allowed-actions-repository': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["selected-actions"]; - }; - }; - }; - }; + 'application/json': components['schemas']['selected-actions'] + } + } + } + } /** * Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." * @@ -26639,71 +26622,71 @@ export interface operations { * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. */ - "actions/set-allowed-actions-repository": { + 'actions/set-allowed-actions-repository': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": components["schemas"]["selected-actions"]; - }; - }; - }; + 'application/json': components['schemas']['selected-actions'] + } + } + } /** Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. */ - "actions/list-self-hosted-runners-for-repo": { + 'actions/list-self-hosted-runners-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - runners: components["schemas"]["runner"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + runners: components['schemas']['runner'][] + } + } + } + } + } /** * Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `repo` scope to use this endpoint. */ - "actions/list-runner-applications-for-repo": { + 'actions/list-runner-applications-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["runner-application"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['runner-application'][] + } + } + } + } /** * Returns a token that you can pass to the `config` script. The token expires after one hour. You must authenticate * using an access token with the `repo` scope to use this endpoint. @@ -26716,22 +26699,22 @@ export interface operations { * ./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN * ``` */ - "actions/create-registration-token-for-repo": { + 'actions/create-registration-token-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["authentication-token"]; - }; - }; - }; - }; + 'application/json': components['schemas']['authentication-token'] + } + } + } + } /** * Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour. * You must authenticate using an access token with the `repo` scope to use this endpoint. @@ -26744,86 +26727,86 @@ export interface operations { * ./config.sh remove --token TOKEN * ``` */ - "actions/create-remove-token-for-repo": { + 'actions/create-remove-token-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["authentication-token"]; - }; - }; - }; - }; + 'application/json': components['schemas']['authentication-token'] + } + } + } + } /** * Gets a specific self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - "actions/get-self-hosted-runner-for-repo": { + 'actions/get-self-hosted-runner-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["runner"]; - }; - }; - }; - }; + 'application/json': components['schemas']['runner'] + } + } + } + } /** * Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * * You must authenticate using an access token with the `repo` * scope to use this endpoint. */ - "actions/delete-self-hosted-runner-from-repo": { + 'actions/delete-self-hosted-runner-from-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Lists all labels for a self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - "actions/list-labels-for-self-hosted-runner-for-repo": { + 'actions/list-labels-for-self-hosted-runner-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - }; - }; + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + } + } /** * Remove all previous custom labels and set the new custom labels for a specific * self-hosted runner configured in a repository. @@ -26831,58 +26814,58 @@ export interface operations { * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - "actions/set-custom-labels-for-self-hosted-runner-for-repo": { + 'actions/set-custom-labels-for-self-hosted-runner-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; - responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + runner_id: components['parameters']['runner-id'] + } + } + responses: { + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels. */ - labels: string[]; - }; - }; - }; - }; + labels: string[] + } + } + } + } /** * Add custom labels to a self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - "actions/add-custom-labels-to-self-hosted-runner-for-repo": { + 'actions/add-custom-labels-to-self-hosted-runner-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; - responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + runner_id: components['parameters']['runner-id'] + } + } + responses: { + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The names of the custom labels to add to the runner. */ - labels: string[]; - }; - }; - }; - }; + labels: string[] + } + } + } + } /** * Remove all custom labels from a self-hosted runner configured in a * repository. Returns the remaining read-only labels from the runner. @@ -26890,20 +26873,20 @@ export interface operations { * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - "actions/remove-all-custom-labels-from-self-hosted-runner-for-repo": { + 'actions/remove-all-custom-labels-from-self-hosted-runner-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; - }; - }; + runner_id: components['parameters']['runner-id'] + } + } responses: { - 200: components["responses"]["actions_runner_labels_readonly"]; - 404: components["responses"]["not_found"]; - }; - }; + 200: components['responses']['actions_runner_labels_readonly'] + 404: components['responses']['not_found'] + } + } /** * Remove a custom label from a self-hosted runner configured * in a repository. Returns the remaining labels from the runner. @@ -26914,531 +26897,531 @@ export interface operations { * You must authenticate using an access token with the `repo` scope to use this * endpoint. */ - "actions/remove-custom-label-from-self-hosted-runner-for-repo": { + 'actions/remove-custom-label-from-self-hosted-runner-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** Unique identifier of the self-hosted runner. */ - runner_id: components["parameters"]["runner-id"]; + runner_id: components['parameters']['runner-id'] /** The name of a self-hosted runner's custom label. */ - name: components["parameters"]["runner-label-name"]; - }; - }; + name: components['parameters']['runner-label-name'] + } + } responses: { - 200: components["responses"]["actions_runner_labels"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; - }; + 200: components['responses']['actions_runner_labels'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } + } /** * Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). * * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/list-workflow-runs-for-repo": { + 'actions/list-workflow-runs-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ - actor?: components["parameters"]["actor"]; + actor?: components['parameters']['actor'] /** Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ - branch?: components["parameters"]["workflow-run-branch"]; + branch?: components['parameters']['workflow-run-branch'] /** Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ - event?: components["parameters"]["event"]; + event?: components['parameters']['event'] /** Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. For a list of the possible `status` and `conclusion` options, see "[Create a check run](https://docs.github.com/rest/reference/checks#create-a-check-run)." */ - status?: components["parameters"]["workflow-run-status"]; + status?: components['parameters']['workflow-run-status'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ - created?: components["parameters"]["created"]; + created?: components['parameters']['created'] /** If `true` pull requests are omitted from the response (empty array). */ - exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; + exclude_pull_requests?: components['parameters']['exclude-pull-requests'] /** Returns workflow runs with the `check_suite_id` that you specify. */ - check_suite_id?: components["parameters"]["workflow-run-check-suite-id"]; - }; - }; + check_suite_id?: components['parameters']['workflow-run-check-suite-id'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - workflow_runs: components["schemas"]["workflow-run"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + workflow_runs: components['schemas']['workflow-run'][] + } + } + } + } + } /** Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/get-workflow-run": { + 'actions/get-workflow-run': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; + run_id: components['parameters']['run-id'] + } query: { /** If `true` pull requests are omitted from the response (empty array). */ - exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; - }; - }; + exclude_pull_requests?: components['parameters']['exclude-pull-requests'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["workflow-run"]; - }; - }; - }; - }; + 'application/json': components['schemas']['workflow-run'] + } + } + } + } /** * Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is * private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:write` permission to use * this endpoint. */ - "actions/delete-workflow-run": { + 'actions/delete-workflow-run': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; - }; + run_id: components['parameters']['run-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/get-reviews-for-run": { + 'actions/get-reviews-for-run': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; - }; + run_id: components['parameters']['run-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["environment-approvals"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['environment-approvals'][] + } + } + } + } /** * Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)." * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - "actions/approve-workflow-run": { + 'actions/approve-workflow-run': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; - }; + run_id: components['parameters']['run-id'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["empty-object"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['empty-object'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/list-workflow-run-artifacts": { + 'actions/list-workflow-run-artifacts': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; + run_id: components['parameters']['run-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - artifacts: components["schemas"]["artifact"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + artifacts: components['schemas']['artifact'][] + } + } + } + } + } /** * Gets a specific workflow run attempt. Anyone with read access to the repository * can use this endpoint. If the repository is private you must use an access token * with the `repo` scope. GitHub Apps must have the `actions:read` permission to * use this endpoint. */ - "actions/get-workflow-run-attempt": { + 'actions/get-workflow-run-attempt': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; + run_id: components['parameters']['run-id'] /** The attempt number of the workflow run. */ - attempt_number: components["parameters"]["attempt-number"]; - }; + attempt_number: components['parameters']['attempt-number'] + } query: { /** If `true` pull requests are omitted from the response (empty array). */ - exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; - }; - }; + exclude_pull_requests?: components['parameters']['exclude-pull-requests'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["workflow-run"]; - }; - }; - }; - }; + 'application/json': components['schemas']['workflow-run'] + } + } + } + } /** Lists jobs for a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). */ - "actions/list-jobs-for-workflow-run-attempt": { + 'actions/list-jobs-for-workflow-run-attempt': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; + run_id: components['parameters']['run-id'] /** The attempt number of the workflow run. */ - attempt_number: components["parameters"]["attempt-number"]; - }; + attempt_number: components['parameters']['attempt-number'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - jobs: components["schemas"]["job"][]; - }; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': { + total_count: number + jobs: components['schemas']['job'][] + } + } + } + 404: components['responses']['not_found'] + } + } /** * Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after * 1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to * the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/download-workflow-run-attempt-logs": { + 'actions/download-workflow-run-attempt-logs': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; + run_id: components['parameters']['run-id'] /** The attempt number of the workflow run. */ - attempt_number: components["parameters"]["attempt-number"]; - }; - }; + attempt_number: components['parameters']['attempt-number'] + } + } responses: { /** Response */ - 302: never; - }; - }; + 302: never + } + } /** Cancels a workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - "actions/cancel-workflow-run": { + 'actions/cancel-workflow-run': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; - }; + run_id: components['parameters']['run-id'] + } + } responses: { /** Response */ 202: { content: { - "application/json": { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': { [key: string]: unknown } + } + } + } + } /** Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). */ - "actions/list-jobs-for-workflow-run": { + 'actions/list-jobs-for-workflow-run': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; + run_id: components['parameters']['run-id'] + } query: { /** * Filters jobs by their `completed_at` timestamp. Can be one of: * \* `latest`: Returns jobs from the most recent execution of the workflow run. * \* `all`: Returns all jobs for a workflow run, including from old executions of the workflow run. */ - filter?: "latest" | "all"; + filter?: 'latest' | 'all' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - jobs: components["schemas"]["job"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + jobs: components['schemas']['job'][] + } + } + } + } + } /** * Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for * `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use * this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have * the `actions:read` permission to use this endpoint. */ - "actions/download-workflow-run-logs": { + 'actions/download-workflow-run-logs': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; - }; + run_id: components['parameters']['run-id'] + } + } responses: { /** Response */ - 302: never; - }; - }; + 302: never + } + } /** Deletes all logs for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - "actions/delete-workflow-run-logs": { + 'actions/delete-workflow-run-logs': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; - }; + run_id: components['parameters']['run-id'] + } + } responses: { /** Response */ - 204: never; - 403: components["responses"]["forbidden"]; - 500: components["responses"]["internal_error"]; - }; - }; + 204: never + 403: components['responses']['forbidden'] + 500: components['responses']['internal_error'] + } + } /** * Get all deployment environments for a workflow run that are waiting for protection rules to pass. * * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/get-pending-deployments-for-run": { + 'actions/get-pending-deployments-for-run': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; - }; + run_id: components['parameters']['run-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pending-deployment"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['pending-deployment'][] + } + } + } + } /** * Approve or reject pending deployments that are waiting on approval by a required reviewer. * * Anyone with read access to the repository contents and deployments can use this endpoint. */ - "actions/review-pending-deployments-for-run": { + 'actions/review-pending-deployments-for-run': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; - }; + run_id: components['parameters']['run-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["deployment"][]; - }; - }; - }; + 'application/json': components['schemas']['deployment'][] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The list of environment ids to approve or reject * @example 161171787,161171795 */ - environment_ids: number[]; + environment_ids: number[] /** * @description Whether to approve or reject deployment to the specified environments. Must be one of: `approved` or `rejected` * @example approved * @enum {string} */ - state: "approved" | "rejected"; + state: 'approved' | 'rejected' /** * @description A comment to accompany the deployment review * @example Ship it! */ - comment: string; - }; - }; - }; - }; + comment: string + } + } + } + } /** Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - "actions/re-run-workflow": { + 'actions/re-run-workflow': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; - }; + run_id: components['parameters']['run-id'] + } + } responses: { /** Response */ 201: { content: { - "application/json": { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': { [key: string]: unknown } + } + } + } + } /** * Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/get-workflow-run-usage": { + 'actions/get-workflow-run-usage': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The id of the workflow run. */ - run_id: components["parameters"]["run-id"]; - }; - }; + run_id: components['parameters']['run-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["workflow-run-usage"]; - }; - }; - }; - }; + 'application/json': components['schemas']['workflow-run-usage'] + } + } + } + } /** Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - "actions/list-repo-secrets": { + 'actions/list-repo-secrets': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - secrets: components["schemas"]["actions-secret"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + secrets: components['schemas']['actions-secret'][] + } + } + } + } + } /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - "actions/get-repo-public-key": { + 'actions/get-repo-public-key': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-public-key"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-public-key'] + } + } + } + } /** Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - "actions/get-repo-secret": { + 'actions/get-repo-secret': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-secret"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-secret'] + } + } + } + } /** * Creates or updates a repository secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -27516,116 +27499,116 @@ export interface operations { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - "actions/create-or-update-repo-secret": { + 'actions/create-or-update-repo-secret': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response when creating a secret */ 201: { content: { - "application/json": { [key: string]: unknown }; - }; - }; + 'application/json': { [key: string]: unknown } + } + } /** Response when updating a secret */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/reference/actions#get-a-repository-public-key) endpoint. */ - encrypted_value?: string; + encrypted_value?: string /** @description ID of the key you used to encrypt the secret. */ - key_id?: string; - }; - }; - }; - }; + key_id?: string + } + } + } + } /** Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - "actions/delete-repo-secret": { + 'actions/delete-repo-secret': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/list-repo-workflows": { + 'actions/list-repo-workflows': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - workflows: components["schemas"]["workflow"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + workflows: components['schemas']['workflow'][] + } + } + } + } + } /** Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/get-workflow": { + 'actions/get-workflow': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The ID of the workflow. You can also pass the workflow file name as a string. */ - workflow_id: components["parameters"]["workflow-id"]; - }; - }; + workflow_id: components['parameters']['workflow-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["workflow"]; - }; - }; - }; - }; + 'application/json': components['schemas']['workflow'] + } + } + } + } /** * Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - "actions/disable-workflow": { + 'actions/disable-workflow': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The ID of the workflow. You can also pass the workflow file name as a string. */ - workflow_id: components["parameters"]["workflow-id"]; - }; - }; + workflow_id: components['parameters']['workflow-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * @@ -27633,144 +27616,144 @@ export interface operations { * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)." */ - "actions/create-workflow-dispatch": { + 'actions/create-workflow-dispatch': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The ID of the workflow. You can also pass the workflow file name as a string. */ - workflow_id: components["parameters"]["workflow-id"]; - }; - }; + workflow_id: components['parameters']['workflow-id'] + } + } responses: { /** Response */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The git reference for the workflow. The reference can be a branch or tag name. */ - ref: string; + ref: string /** @description Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted. */ - inputs?: { [key: string]: string }; - }; - }; - }; - }; + inputs?: { [key: string]: string } + } + } + } + } /** * Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ - "actions/enable-workflow": { + 'actions/enable-workflow': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The ID of the workflow. You can also pass the workflow file name as a string. */ - workflow_id: components["parameters"]["workflow-id"]; - }; - }; + workflow_id: components['parameters']['workflow-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). * * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. */ - "actions/list-workflow-runs": { + 'actions/list-workflow-runs': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The ID of the workflow. You can also pass the workflow file name as a string. */ - workflow_id: components["parameters"]["workflow-id"]; - }; + workflow_id: components['parameters']['workflow-id'] + } query: { /** Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ - actor?: components["parameters"]["actor"]; + actor?: components['parameters']['actor'] /** Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ - branch?: components["parameters"]["workflow-run-branch"]; + branch?: components['parameters']['workflow-run-branch'] /** Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ - event?: components["parameters"]["event"]; + event?: components['parameters']['event'] /** Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. For a list of the possible `status` and `conclusion` options, see "[Create a check run](https://docs.github.com/rest/reference/checks#create-a-check-run)." */ - status?: components["parameters"]["workflow-run-status"]; + status?: components['parameters']['workflow-run-status'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ - created?: components["parameters"]["created"]; + created?: components['parameters']['created'] /** If `true` pull requests are omitted from the response (empty array). */ - exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; + exclude_pull_requests?: components['parameters']['exclude-pull-requests'] /** Returns workflow runs with the `check_suite_id` that you specify. */ - check_suite_id?: components["parameters"]["workflow-run-check-suite-id"]; - }; - }; + check_suite_id?: components['parameters']['workflow-run-check-suite-id'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - workflow_runs: components["schemas"]["workflow-run"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + workflow_runs: components['schemas']['workflow-run'][] + } + } + } + } + } /** * Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * * You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "actions/get-workflow-usage": { + 'actions/get-workflow-usage': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The ID of the workflow. You can also pass the workflow file name as a string. */ - workflow_id: components["parameters"]["workflow-id"]; - }; - }; + workflow_id: components['parameters']['workflow-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["workflow-usage"]; - }; - }; - }; - }; + 'application/json': components['schemas']['workflow-usage'] + } + } + } + } /** Lists the [available assignees](https://docs.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. */ - "issues/list-assignees": { + 'issues/list-assignees': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + 404: components['responses']['not_found'] + } + } /** * Checks if a user has permission to be assigned to an issue in this repository. * @@ -27778,218 +27761,218 @@ export interface operations { * * Otherwise a `404` status code is returned. */ - "issues/check-user-can-be-assigned": { + 'issues/check-user-can-be-assigned': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - assignee: string; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + assignee: string + } + } responses: { /** If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. */ - 204: never; + 204: never /** Otherwise a `404` status code is returned. */ 404: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } + } + } /** * This returns a list of autolinks configured for the given repository. * * Information about autolinks are only available to repository administrators. */ - "repos/list-autolinks": { + 'repos/list-autolinks': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["autolink"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['autolink'][] + } + } + } + } /** Users with admin access to the repository can create an autolink. */ - "repos/create-autolink": { + 'repos/create-autolink': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["autolink"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['autolink'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit. */ - key_prefix: string; + key_prefix: string /** @description The URL must contain for the reference number. */ - url_template: string; - }; - }; - }; - }; + url_template: string + } + } + } + } /** * This returns a single autolink reference by ID that was configured for the given repository. * * Information about autolinks are only available to repository administrators. */ - "repos/get-autolink": { + 'repos/get-autolink': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** autolink_id parameter */ - autolink_id: components["parameters"]["autolink-id"]; - }; - }; + autolink_id: components['parameters']['autolink-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["autolink"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['autolink'] + } + } + 404: components['responses']['not_found'] + } + } /** * This deletes a single autolink reference by ID that was configured for the given repository. * * Information about autolinks are only available to repository administrators. */ - "repos/delete-autolink": { + 'repos/delete-autolink': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** autolink_id parameter */ - autolink_id: components["parameters"]["autolink-id"]; - }; - }; + autolink_id: components['parameters']['autolink-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/en/articles/configuring-automated-security-fixes)". */ - "repos/enable-automated-security-fixes": { + 'repos/enable-automated-security-fixes': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/en/articles/configuring-automated-security-fixes)". */ - "repos/disable-automated-security-fixes": { + 'repos/disable-automated-security-fixes': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; - }; - "repos/list-branches": { + 204: never + } + } + 'repos/list-branches': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches. */ - protected?: boolean; + protected?: boolean /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["short-branch"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "repos/get-branch": { + 'application/json': components['schemas']['short-branch'][] + } + } + 404: components['responses']['not_found'] + } + } + 'repos/get-branch': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["branch-with-protection"]; - }; - }; - 301: components["responses"]["moved_permanently"]; - 404: components["responses"]["not_found"]; - 415: components["responses"]["preview_header_missing"]; - }; - }; + 'application/json': components['schemas']['branch-with-protection'] + } + } + 301: components['responses']['moved_permanently'] + 404: components['responses']['not_found'] + 415: components['responses']['preview_header_missing'] + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "repos/get-branch-protection": { + 'repos/get-branch-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["branch-protection"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['branch-protection'] + } + } + 404: components['responses']['not_found'] + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -27999,205 +27982,205 @@ export interface operations { * * **Note**: The list of users, apps, and teams in total is limited to 100 items. */ - "repos/update-branch-protection": { + 'repos/update-branch-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["protected-branch"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': components['schemas']['protected-branch'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Require status checks to pass before merging. Set to `null` to disable. */ required_status_checks: { /** @description Require branches to be up to date before merging. */ - strict: boolean; + strict: boolean /** * @deprecated * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. */ - contexts: string[]; + contexts: string[] /** @description The list of status checks to require in order to merge into this branch. */ checks?: { /** @description The name of the required check */ - context: string; + context: string /** @description The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status. */ - app_id?: number; - }[]; - } | null; + app_id?: number + }[] + } | null /** @description Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable. */ - enforce_admins: boolean | null; + enforce_admins: boolean | null /** @description Require at least one approving review on a pull request, before merging. Set to `null` to disable. */ required_pull_request_reviews: { /** @description Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories. */ dismissal_restrictions?: { /** @description The list of user `login`s with dismissal access */ - users?: string[]; + users?: string[] /** @description The list of team `slug`s with dismissal access */ - teams?: string[]; - }; + teams?: string[] + } /** @description Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit. */ - dismiss_stale_reviews?: boolean; + dismiss_stale_reviews?: boolean /** @description Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them. */ - require_code_owner_reviews?: boolean; + require_code_owner_reviews?: boolean /** @description Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers. */ - required_approving_review_count?: number; + required_approving_review_count?: number /** @description Allow specific users or teams to bypass pull request requirements. Set to `null` to disable. */ bypass_pull_request_allowances?: { /** @description The list of user `login`s allowed to bypass pull request requirements. */ - users?: string[]; + users?: string[] /** @description The list of team `slug`s allowed to bypass pull request requirements. */ - teams?: string[]; - } | null; - } | null; + teams?: string[] + } | null + } | null /** @description Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable. */ restrictions: { /** @description The list of user `login`s with push access */ - users: string[]; + users: string[] /** @description The list of team `slug`s with push access */ - teams: string[]; + teams: string[] /** @description The list of app `slug`s with push access */ - apps?: string[]; - } | null; + apps?: string[] + } | null /** @description Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see "[Requiring a linear commit history](https://docs.github.com/github/administering-a-repository/requiring-a-linear-commit-history)" in the GitHub Help documentation. */ - required_linear_history?: boolean; + required_linear_history?: boolean /** @description Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation." */ - allow_force_pushes?: boolean | null; + allow_force_pushes?: boolean | null /** @description Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation. */ - allow_deletions?: boolean; + allow_deletions?: boolean /** @description Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`. */ - required_conversation_resolution?: boolean; - }; - }; - }; - }; + required_conversation_resolution?: boolean + } + } + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "repos/delete-branch-protection": { + 'repos/delete-branch-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ - 204: never; - 403: components["responses"]["forbidden"]; - }; - }; + 204: never + 403: components['responses']['forbidden'] + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "repos/get-admin-branch-protection": { + 'repos/get-admin-branch-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["protected-branch-admin-enforced"]; - }; - }; - }; - }; + 'application/json': components['schemas']['protected-branch-admin-enforced'] + } + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ - "repos/set-admin-branch-protection": { + 'repos/set-admin-branch-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["protected-branch-admin-enforced"]; - }; - }; - }; - }; + 'application/json': components['schemas']['protected-branch-admin-enforced'] + } + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ - "repos/delete-admin-branch-protection": { + 'repos/delete-admin-branch-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "repos/get-pull-request-review-protection": { + 'repos/get-pull-request-review-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["protected-branch-pull-request-review"]; - }; - }; - }; - }; + 'application/json': components['schemas']['protected-branch-pull-request-review'] + } + } + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "repos/delete-pull-request-review-protection": { + 'repos/delete-pull-request-review-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28205,51 +28188,51 @@ export interface operations { * * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. */ - "repos/update-pull-request-review-protection": { + 'repos/update-pull-request-review-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["protected-branch-pull-request-review"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['protected-branch-pull-request-review'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories. */ dismissal_restrictions?: { /** @description The list of user `login`s with dismissal access */ - users?: string[]; + users?: string[] /** @description The list of team `slug`s with dismissal access */ - teams?: string[]; - }; + teams?: string[] + } /** @description Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit. */ - dismiss_stale_reviews?: boolean; + dismiss_stale_reviews?: boolean /** @description Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) have reviewed. */ - require_code_owner_reviews?: boolean; + require_code_owner_reviews?: boolean /** @description Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers. */ - required_approving_review_count?: number; + required_approving_review_count?: number /** @description Allow specific users or teams to bypass pull request requirements. Set to `null` to disable. */ bypass_pull_request_allowances?: { /** @description The list of user `login`s allowed to bypass pull request requirements. */ - users?: string[]; + users?: string[] /** @description The list of team `slug`s allowed to bypass pull request requirements. */ - teams?: string[]; - } | null; - }; - }; - }; - }; + teams?: string[] + } | null + } + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28257,263 +28240,263 @@ export interface operations { * * **Note**: You must enable branch protection to require signed commits. */ - "repos/get-commit-signature-protection": { + 'repos/get-commit-signature-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["protected-branch-admin-enforced"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['protected-branch-admin-enforced'] + } + } + 404: components['responses']['not_found'] + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits. */ - "repos/create-commit-signature-protection": { + 'repos/create-commit-signature-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["protected-branch-admin-enforced"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['protected-branch-admin-enforced'] + } + } + 404: components['responses']['not_found'] + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits. */ - "repos/delete-commit-signature-protection": { + 'repos/delete-commit-signature-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "repos/get-status-checks-protection": { + 'repos/get-status-checks-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["status-check-policy"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['status-check-policy'] + } + } + 404: components['responses']['not_found'] + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "repos/remove-status-check-protection": { + 'repos/remove-status-check-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. */ - "repos/update-status-check-protection": { + 'repos/update-status-check-protection': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["status-check-policy"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['status-check-policy'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Require branches to be up to date before merging. */ - strict?: boolean; + strict?: boolean /** * @deprecated * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. */ - contexts?: string[]; + contexts?: string[] /** @description The list of status checks to require in order to merge into this branch. */ checks?: { /** @description The name of the required check */ - context: string; + context: string /** @description The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status. */ - app_id?: number; - }[]; - }; - }; - }; - }; + app_id?: number + }[] + } + } + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "repos/get-all-status-check-contexts": { + 'repos/get-all-status-check-contexts': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": string[]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': string[] + } + } + 404: components['responses']['not_found'] + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "repos/set-status-check-contexts": { + 'repos/set-status-check-contexts': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": string[]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': string[] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description contexts parameter */ - contexts: string[]; + contexts: string[] } - | string[]; - }; - }; - }; + | string[] + } + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "repos/add-status-check-contexts": { + 'repos/add-status-check-contexts': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": string[]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': string[] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description contexts parameter */ - contexts: string[]; + contexts: string[] } - | string[]; - }; - }; - }; + | string[] + } + } + } /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "repos/remove-status-check-contexts": { + 'repos/remove-status-check-contexts': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": string[]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': string[] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description contexts parameter */ - contexts: string[]; + contexts: string[] } - | string[]; - }; - }; - }; + | string[] + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28521,68 +28504,68 @@ export interface operations { * * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. */ - "repos/get-access-restrictions": { + 'repos/get-access-restrictions': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["branch-restriction-policy"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['branch-restriction-policy'] + } + } + 404: components['responses']['not_found'] + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Disables the ability to restrict who can push to this branch. */ - "repos/delete-access-restrictions": { + 'repos/delete-access-restrictions': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. */ - "repos/get-apps-with-access-to-protected-branch": { + 'repos/get-apps-with-access-to-protected-branch': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["integration"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['integration'][] + } + } + 404: components['responses']['not_found'] + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28592,35 +28575,35 @@ export interface operations { * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - "repos/set-app-access-restrictions": { + 'repos/set-app-access-restrictions': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["integration"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['integration'][] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description apps parameter */ - apps: string[]; + apps: string[] } - | string[]; - }; - }; - }; + | string[] + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28630,35 +28613,35 @@ export interface operations { * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - "repos/add-app-access-restrictions": { + 'repos/add-app-access-restrictions': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["integration"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['integration'][] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description apps parameter */ - apps: string[]; + apps: string[] } - | string[]; - }; - }; - }; + | string[] + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28668,59 +28651,59 @@ export interface operations { * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - "repos/remove-app-access-restrictions": { + 'repos/remove-app-access-restrictions': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["integration"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['integration'][] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description apps parameter */ - apps: string[]; + apps: string[] } - | string[]; - }; - }; - }; + | string[] + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the teams who have push access to this branch. The list includes child teams. */ - "repos/get-teams-with-access-to-protected-branch": { + 'repos/get-teams-with-access-to-protected-branch': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['team'][] + } + } + 404: components['responses']['not_found'] + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28730,35 +28713,35 @@ export interface operations { * | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ | * | `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - "repos/set-team-access-restrictions": { + 'repos/set-team-access-restrictions': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['team'][] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description teams parameter */ - teams: string[]; + teams: string[] } - | string[]; - }; - }; - }; + | string[] + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28768,35 +28751,35 @@ export interface operations { * | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ | * | `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - "repos/add-team-access-restrictions": { + 'repos/add-team-access-restrictions': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['team'][] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description teams parameter */ - teams: string[]; + teams: string[] } - | string[]; - }; - }; - }; + | string[] + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28806,59 +28789,59 @@ export interface operations { * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | Teams that should no longer have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - "repos/remove-team-access-restrictions": { + 'repos/remove-team-access-restrictions': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['team'][] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description teams parameter */ - teams: string[]; + teams: string[] } - | string[]; - }; - }; - }; + | string[] + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the people who have push access to this branch. */ - "repos/get-users-with-access-to-protected-branch": { + 'repos/get-users-with-access-to-protected-branch': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + 404: components['responses']['not_found'] + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28868,35 +28851,35 @@ export interface operations { * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - "repos/set-user-access-restrictions": { + 'repos/set-user-access-restrictions': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description users parameter */ - users: string[]; + users: string[] } - | string[]; - }; - }; - }; + | string[] + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28906,35 +28889,35 @@ export interface operations { * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - "repos/add-user-access-restrictions": { + 'repos/add-user-access-restrictions': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description users parameter */ - users: string[]; + users: string[] } - | string[]; - }; - }; - }; + | string[] + } + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -28944,35 +28927,35 @@ export interface operations { * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - "repos/remove-user-access-restrictions": { + 'repos/remove-user-access-restrictions': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description users parameter */ - users: string[]; + users: string[] } - | string[]; - }; - }; - }; + | string[] + } + } + } /** * Renames a branch in a repository. * @@ -28990,35 +28973,35 @@ export interface operations { * * Users must have admin or owner permissions. * * GitHub Apps must have the `administration:write` repository permission. */ - "repos/rename-branch": { + 'repos/rename-branch': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the branch. */ - branch: components["parameters"]["branch"]; - }; - }; + branch: components['parameters']['branch'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["branch-with-protection"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['branch-with-protection'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The new name of the branch. */ - new_name: string; - }; - }; - }; - }; + new_name: string + } + } + } + } /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * @@ -29026,494 +29009,478 @@ export interface operations { * * In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. */ - "checks/create": { + 'checks/create': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["check-run"]; - }; - }; - }; + 'application/json': components['schemas']['check-run'] + } + } + } requestBody: { content: { - "application/json": ( + 'application/json': ( | ({ /** @enum {undefined} */ - status: "completed"; + status: 'completed' } & { - conclusion: unknown; + conclusion: unknown } & { [key: string]: unknown }) | ({ /** @enum {undefined} */ - status?: "queued" | "in_progress"; + status?: 'queued' | 'in_progress' } & { [key: string]: unknown }) ) & { /** @description The name of the check. For example, "code-coverage". */ - name: string; + name: string /** @description The SHA of the commit. */ - head_sha: string; + head_sha: string /** @description The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used. */ - details_url?: string; + details_url?: string /** @description A reference for the run on the integrator's system. */ - external_id?: string; + external_id?: string /** * @description The current status. Can be one of `queued`, `in_progress`, or `completed`. * @default queued * @enum {string} */ - status?: "queued" | "in_progress" | "completed"; + status?: 'queued' | 'in_progress' | 'completed' /** * Format: date-time * @description The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - started_at?: string; + started_at?: string /** * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. * @enum {string} */ - conclusion?: - | "action_required" - | "cancelled" - | "failure" - | "neutral" - | "success" - | "skipped" - | "stale" - | "timed_out"; + conclusion?: 'action_required' | 'cancelled' | 'failure' | 'neutral' | 'success' | 'skipped' | 'stale' | 'timed_out' /** * Format: date-time * @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - completed_at?: string; + completed_at?: string /** @description Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/rest/reference/checks#output-object) description. */ output?: { /** @description The title of the check run. */ - title: string; + title: string /** @description The summary of the check run. This parameter supports Markdown. */ - summary: string; + summary: string /** @description The details of the check run. This parameter supports Markdown. */ - text?: string; + text?: string /** @description Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". See the [`annotations` object](https://docs.github.com/rest/reference/checks#annotations-object) description for details about how to use this parameter. */ annotations?: { /** @description The path of the file to add an annotation to. For example, `assets/css/main.css`. */ - path: string; + path: string /** @description The start line of the annotation. */ - start_line: number; + start_line: number /** @description The end line of the annotation. */ - end_line: number; + end_line: number /** @description The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */ - start_column?: number; + start_column?: number /** @description The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */ - end_column?: number; + end_column?: number /** * @description The level of the annotation. Can be one of `notice`, `warning`, or `failure`. * @enum {string} */ - annotation_level: "notice" | "warning" | "failure"; + annotation_level: 'notice' | 'warning' | 'failure' /** @description A short description of the feedback for these lines of code. The maximum size is 64 KB. */ - message: string; + message: string /** @description The title that represents the annotation. The maximum size is 255 characters. */ - title?: string; + title?: string /** @description Details about this annotation. The maximum size is 64 KB. */ - raw_details?: string; - }[]; + raw_details?: string + }[] /** @description Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/rest/reference/checks#images-object) description for details. */ images?: { /** @description The alternative text for the image. */ - alt: string; + alt: string /** @description The full URL of the image. */ - image_url: string; + image_url: string /** @description A short image description. */ - caption?: string; - }[]; - }; + caption?: string + }[] + } /** @description Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions)." */ actions?: { /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ - label: string; + label: string /** @description A short explanation of what this action would do. The maximum size is 40 characters. */ - description: string; + description: string /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ - identifier: string; - }[]; - }; - }; - }; - }; + identifier: string + }[] + } + } + } + } /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * Gets a single check run using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. */ - "checks/get": { + 'checks/get': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** check_run_id parameter */ - check_run_id: components["parameters"]["check-run-id"]; - }; - }; + check_run_id: components['parameters']['check-run-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["check-run"]; - }; - }; - }; - }; + 'application/json': components['schemas']['check-run'] + } + } + } + } /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. */ - "checks/update": { + 'checks/update': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** check_run_id parameter */ - check_run_id: components["parameters"]["check-run-id"]; - }; - }; + check_run_id: components['parameters']['check-run-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["check-run"]; - }; - }; - }; + 'application/json': components['schemas']['check-run'] + } + } + } requestBody: { content: { - "application/json": (Partial< + 'application/json': (Partial< { /** @enum {undefined} */ - status?: "completed"; + status?: 'completed' } & { - conclusion: unknown; + conclusion: unknown } & { [key: string]: unknown } > & Partial< { /** @enum {undefined} */ - status?: "queued" | "in_progress"; + status?: 'queued' | 'in_progress' } & { [key: string]: unknown } >) & { /** @description The name of the check. For example, "code-coverage". */ - name?: string; + name?: string /** @description The URL of the integrator's site that has the full details of the check. */ - details_url?: string; + details_url?: string /** @description A reference for the run on the integrator's system. */ - external_id?: string; + external_id?: string /** * Format: date-time * @description This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - started_at?: string; + started_at?: string /** * @description The current status. Can be one of `queued`, `in_progress`, or `completed`. * @enum {string} */ - status?: "queued" | "in_progress" | "completed"; + status?: 'queued' | 'in_progress' | 'completed' /** * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. * @enum {string} */ - conclusion?: - | "action_required" - | "cancelled" - | "failure" - | "neutral" - | "success" - | "skipped" - | "stale" - | "timed_out"; + conclusion?: 'action_required' | 'cancelled' | 'failure' | 'neutral' | 'success' | 'skipped' | 'stale' | 'timed_out' /** * Format: date-time * @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - completed_at?: string; + completed_at?: string /** @description Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/rest/reference/checks#output-object-1) description. */ output?: { /** @description **Required**. */ - title?: string; + title?: string /** @description Can contain Markdown. */ - summary: string; + summary: string /** @description Can contain Markdown. */ - text?: string; + text?: string /** @description Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". See the [`annotations` object](https://docs.github.com/rest/reference/checks#annotations-object-1) description for details. */ annotations?: { /** @description The path of the file to add an annotation to. For example, `assets/css/main.css`. */ - path: string; + path: string /** @description The start line of the annotation. */ - start_line: number; + start_line: number /** @description The end line of the annotation. */ - end_line: number; + end_line: number /** @description The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */ - start_column?: number; + start_column?: number /** @description The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */ - end_column?: number; + end_column?: number /** * @description The level of the annotation. Can be one of `notice`, `warning`, or `failure`. * @enum {string} */ - annotation_level: "notice" | "warning" | "failure"; + annotation_level: 'notice' | 'warning' | 'failure' /** @description A short description of the feedback for these lines of code. The maximum size is 64 KB. */ - message: string; + message: string /** @description The title that represents the annotation. The maximum size is 255 characters. */ - title?: string; + title?: string /** @description Details about this annotation. The maximum size is 64 KB. */ - raw_details?: string; - }[]; + raw_details?: string + }[] /** @description Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/rest/reference/checks#annotations-object-1) description for details. */ images?: { /** @description The alternative text for the image. */ - alt: string; + alt: string /** @description The full URL of the image. */ - image_url: string; + image_url: string /** @description A short image description. */ - caption?: string; - }[]; - }; + caption?: string + }[] + } /** @description Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions)." */ actions?: { /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ - label: string; + label: string /** @description A short explanation of what this action would do. The maximum size is 40 characters. */ - description: string; + description: string /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ - identifier: string; - }[]; - }; - }; - }; - }; + identifier: string + }[] + } + } + } + } /** Lists annotations for a check run using the annotation `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the `repo` scope to get annotations for a check run in a private repository. */ - "checks/list-annotations": { + 'checks/list-annotations': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** check_run_id parameter */ - check_run_id: components["parameters"]["check-run-id"]; - }; + check_run_id: components['parameters']['check-run-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["check-annotation"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['check-annotation'][] + } + } + } + } /** * Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * * To rerequest a check run, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository. */ - "checks/rerequest-run": { + 'checks/rerequest-run': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** check_run_id parameter */ - check_run_id: components["parameters"]["check-run-id"]; - }; - }; + check_run_id: components['parameters']['check-run-id'] + } + } responses: { /** Response */ 201: { content: { - "application/json": { [key: string]: unknown }; - }; - }; + 'application/json': { [key: string]: unknown } + } + } /** Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App */ 403: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - 404: components["responses"]["not_found"]; + 'application/json': components['schemas']['basic-error'] + } + } + 404: components['responses']['not_found'] /** Validation error if the check run is not rerequestable */ 422: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } + } + } /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * * By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/reference/checks#check-runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/reference/checks#update-repository-preferences-for-check-suites)". Your GitHub App must have the `checks:write` permission to create check suites. */ - "checks/create-suite": { + 'checks/create-suite': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** when the suite already existed */ 200: { content: { - "application/json": components["schemas"]["check-suite"]; - }; - }; + 'application/json': components['schemas']['check-suite'] + } + } /** Response when the suite was created */ 201: { content: { - "application/json": components["schemas"]["check-suite"]; - }; - }; - }; + 'application/json': components['schemas']['check-suite'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The sha of the head commit. */ - head_sha: string; - }; - }; - }; - }; + head_sha: string + } + } + } + } /** Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/reference/checks#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites. */ - "checks/set-suites-preferences": { + 'checks/set-suites-preferences': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["check-suite-preference"]; - }; - }; - }; + 'application/json': components['schemas']['check-suite-preference'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/rest/reference/checks#auto_trigger_checks-object) description for details. */ auto_trigger_checks?: { /** @description The `id` of the GitHub App. */ - app_id: number; + app_id: number /** * @description Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them. * @default true */ - setting: boolean; - }[]; - }; - }; - }; - }; + setting: boolean + }[] + } + } + } + } /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * * Gets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository. */ - "checks/get-suite": { + 'checks/get-suite': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** check_suite_id parameter */ - check_suite_id: components["parameters"]["check-suite-id"]; - }; - }; + check_suite_id: components['parameters']['check-suite-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["check-suite"]; - }; - }; - }; - }; + 'application/json': components['schemas']['check-suite'] + } + } + } + } /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. */ - "checks/list-for-suite": { + 'checks/list-for-suite': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** check_suite_id parameter */ - check_suite_id: components["parameters"]["check-suite-id"]; - }; + check_suite_id: components['parameters']['check-suite-id'] + } query: { /** Returns check runs with the specified `name`. */ - check_name?: components["parameters"]["check-name"]; + check_name?: components['parameters']['check-name'] /** Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`. */ - status?: components["parameters"]["status"]; + status?: components['parameters']['status'] /** Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`. */ - filter?: "latest" | "all"; + filter?: 'latest' | 'all' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - check_runs: components["schemas"]["check-run"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + check_runs: components['schemas']['check-run'][] + } + } + } + } + } /** * Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * * To rerequest a check suite, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository. */ - "checks/rerequest-suite": { + 'checks/rerequest-suite': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** check_suite_id parameter */ - check_suite_id: components["parameters"]["check-suite-id"]; - }; - }; + check_suite_id: components['parameters']['check-suite-id'] + } + } responses: { /** Response */ 201: { content: { - "application/json": { [key: string]: unknown }; - }; - }; - }; - }; + 'application/json': { [key: string]: unknown } + } + } + } + } /** * Lists all open code scanning alerts for the default branch (usually `main` * or `master`). You must use an access token with the `security_events` scope to use @@ -29526,137 +29493,137 @@ export interface operations { * for the default branch or for the specified Git reference * (if you used `ref` in the request). */ - "code-scanning/list-alerts-for-repo": { + 'code-scanning/list-alerts-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */ - tool_name?: components["parameters"]["tool-name"]; + tool_name?: components['parameters']['tool-name'] /** The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ - tool_guid?: components["parameters"]["tool-guid"]; + tool_guid?: components['parameters']['tool-guid'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ - ref?: components["parameters"]["git-ref"]; + ref?: components['parameters']['git-ref'] /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Can be one of `created`, `updated`, `number`. */ - sort?: "created" | "updated" | "number"; + sort?: 'created' | 'updated' | 'number' /** Set to `open`, `closed, `fixed`, or `dismissed` to list code scanning alerts in a specific state. */ - state?: components["schemas"]["code-scanning-alert-state"]; - }; - }; + state?: components['schemas']['code-scanning-alert-state'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["code-scanning-alert-items"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["code_scanning_forbidden_read"]; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': components['schemas']['code-scanning-alert-items'][] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['code_scanning_forbidden_read'] + 404: components['responses']['not_found'] + 503: components['responses']['service_unavailable'] + } + } /** * Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint. * * **Deprecation notice**: * The instances field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The same information can now be retrieved via a GET request to the URL specified by `instances_url`. */ - "code-scanning/get-alert": { + 'code-scanning/get-alert': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ - alert_number: components["parameters"]["alert-number"]; - }; - }; + alert_number: components['parameters']['alert-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["code-scanning-alert"]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["code_scanning_forbidden_read"]; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': components['schemas']['code-scanning-alert'] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['code_scanning_forbidden_read'] + 404: components['responses']['not_found'] + 503: components['responses']['service_unavailable'] + } + } /** Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. */ - "code-scanning/update-alert": { + 'code-scanning/update-alert': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ - alert_number: components["parameters"]["alert-number"]; - }; - }; + alert_number: components['parameters']['alert-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["code-scanning-alert"]; - }; - }; - 403: components["responses"]["code_scanning_forbidden_write"]; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; - }; + 'application/json': components['schemas']['code-scanning-alert'] + } + } + 403: components['responses']['code_scanning_forbidden_write'] + 404: components['responses']['not_found'] + 503: components['responses']['service_unavailable'] + } requestBody: { content: { - "application/json": { - state: components["schemas"]["code-scanning-alert-set-state"]; - dismissed_reason?: components["schemas"]["code-scanning-alert-dismissed-reason"]; - }; - }; - }; - }; + 'application/json': { + state: components['schemas']['code-scanning-alert-set-state'] + dismissed_reason?: components['schemas']['code-scanning-alert-dismissed-reason'] + } + } + } + } /** * Lists all instances of the specified code scanning alert. * You must use an access token with the `security_events` scope to use this endpoint with private repos, * the `public_repo` scope also grants permission to read security events on public repos only. * GitHub Apps must have the `security_events` read permission to use this endpoint. */ - "code-scanning/list-alert-instances": { + 'code-scanning/list-alert-instances': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ - alert_number: components["parameters"]["alert-number"]; - }; + alert_number: components['parameters']['alert-number'] + } query: { /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ - ref?: components["parameters"]["git-ref"]; - }; - }; + ref?: components['parameters']['git-ref'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["code-scanning-alert-instance"][]; - }; - }; - 403: components["responses"]["code_scanning_forbidden_read"]; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': components['schemas']['code-scanning-alert-instance'][] + } + } + 403: components['responses']['code_scanning_forbidden_read'] + 404: components['responses']['not_found'] + 503: components['responses']['service_unavailable'] + } + } /** * Lists the details of all code scanning analyses for a repository, * starting with the most recent. @@ -29676,39 +29643,39 @@ export interface operations { * **Deprecation notice**: * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. */ - "code-scanning/list-recent-analyses": { + 'code-scanning/list-recent-analyses': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */ - tool_name?: components["parameters"]["tool-name"]; + tool_name?: components['parameters']['tool-name'] /** The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ - tool_guid?: components["parameters"]["tool-guid"]; + tool_guid?: components['parameters']['tool-guid'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ - ref?: components["schemas"]["code-scanning-ref"]; + ref?: components['schemas']['code-scanning-ref'] /** Filter analyses belonging to the same SARIF upload. */ - sarif_id?: components["schemas"]["code-scanning-analysis-sarif-id"]; - }; - }; + sarif_id?: components['schemas']['code-scanning-analysis-sarif-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["code-scanning-analysis"][]; - }; - }; - 403: components["responses"]["code_scanning_forbidden_read"]; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': components['schemas']['code-scanning-analysis'][] + } + } + 403: components['responses']['code_scanning_forbidden_read'] + 404: components['responses']['not_found'] + 503: components['responses']['service_unavailable'] + } + } /** * Gets a specified code scanning analysis for a repository. * You must use an access token with the `security_events` scope to use this endpoint with private repos, @@ -29730,28 +29697,28 @@ export interface operations { * This is formatted as * [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). */ - "code-scanning/get-analysis": { + 'code-scanning/get-analysis': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation. */ - analysis_id: number; - }; - }; + analysis_id: number + } + } responses: { /** Response */ 200: { content: { - "application/json+sarif": string; - "application/json": components["schemas"]["code-scanning-analysis"]; - }; - }; - 403: components["responses"]["code_scanning_forbidden_read"]; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json+sarif': string + 'application/json': components['schemas']['code-scanning-analysis'] + } + } + 403: components['responses']['code_scanning_forbidden_read'] + 404: components['responses']['not_found'] + 503: components['responses']['service_unavailable'] + } + } /** * Deletes a specified code scanning analysis from a repository. For * private repositories, you must use an access token with the `repo` scope. For public repositories, @@ -29820,32 +29787,32 @@ export interface operations { * * The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely. */ - "code-scanning/delete-analysis": { + 'code-scanning/delete-analysis': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation. */ - analysis_id: number; - }; + analysis_id: number + } query: { /** Allow deletion if the specified analysis is the last in a set. If you attempt to delete the final analysis in a set without setting this parameter to `true`, you'll get a 400 response with the message: `Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.` */ - confirm_delete?: string | null; - }; - }; + confirm_delete?: string | null + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["code-scanning-analysis-deletion"]; - }; - }; - 400: components["responses"]["bad_request"]; - 403: components["responses"]["code_scanning_forbidden_write"]; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': components['schemas']['code-scanning-analysis-deletion'] + } + } + 400: components['responses']['bad_request'] + 403: components['responses']['code_scanning_forbidden_write'] + 404: components['responses']['not_found'] + 503: components['responses']['service_unavailable'] + } + } /** * Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. * @@ -29865,155 +29832,155 @@ export interface operations { * You can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint. * For more information, see "[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload)." */ - "code-scanning/upload-sarif": { + 'code-scanning/upload-sarif': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 202: { content: { - "application/json": components["schemas"]["code-scanning-sarifs-receipt"]; - }; - }; + 'application/json': components['schemas']['code-scanning-sarifs-receipt'] + } + } /** Bad Request if the sarif field is invalid */ - 400: unknown; - 403: components["responses"]["code_scanning_forbidden_write"]; - 404: components["responses"]["not_found"]; + 400: unknown + 403: components['responses']['code_scanning_forbidden_write'] + 404: components['responses']['not_found'] /** Payload Too Large if the sarif field is too large */ - 413: unknown; - 503: components["responses"]["service_unavailable"]; - }; + 413: unknown + 503: components['responses']['service_unavailable'] + } requestBody: { content: { - "application/json": { - commit_sha: components["schemas"]["code-scanning-analysis-commit-sha"]; - ref: components["schemas"]["code-scanning-ref"]; - sarif: components["schemas"]["code-scanning-analysis-sarif-file"]; + 'application/json': { + commit_sha: components['schemas']['code-scanning-analysis-commit-sha'] + ref: components['schemas']['code-scanning-ref'] + sarif: components['schemas']['code-scanning-analysis-sarif-file'] /** * Format: uri * @description The base directory used in the analysis, as it appears in the SARIF file. * This property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository. * @example file:///github/workspace/ */ - checkout_uri?: string; + checkout_uri?: string /** * Format: date-time * @description The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - started_at?: string; + started_at?: string /** @description The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to "API". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`. */ - tool_name?: string; - }; - }; - }; - }; + tool_name?: string + } + } + } + } /** Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository)." You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint. */ - "code-scanning/get-sarif": { + 'code-scanning/get-sarif': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The SARIF ID obtained after uploading. */ - sarif_id: string; - }; - }; + sarif_id: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["code-scanning-sarifs-status"]; - }; - }; - 403: components["responses"]["code_scanning_forbidden_read"]; + 'application/json': components['schemas']['code-scanning-sarifs-status'] + } + } + 403: components['responses']['code_scanning_forbidden_read'] /** Not Found if the sarif id does not match any upload */ - 404: unknown; - 503: components["responses"]["service_unavailable"]; - }; - }; + 404: unknown + 503: components['responses']['service_unavailable'] + } + } /** * Lists the codespaces associated to a specified repository and the authenticated user. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/list-in-repository-for-authenticated-user": { + 'codespaces/list-in-repository-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; + page?: components['parameters']['page'] + } path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - codespaces: components["schemas"]["codespace"][]; - }; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': { + total_count: number + codespaces: components['schemas']['codespace'][] + } + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** * Creates a codespace owned by the authenticated user in the specified repository. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/create-with-repo-for-authenticated-user": { + 'codespaces/create-with-repo-for-authenticated-user': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response when the codespace was successfully created */ 201: { content: { - "application/json": components["schemas"]["codespace"]; - }; - }; + 'application/json': components['schemas']['codespace'] + } + } /** Response when the codespace creation partially failed but is being retried in the background */ 202: { content: { - "application/json": components["schemas"]["codespace"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; + 'application/json': components['schemas']['codespace'] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Git ref (typically a branch name) for this codespace */ - ref?: string; + ref?: string /** @description Location for this codespace */ - location: string; + location: string /** @description Machine type to use for this codespace */ - machine?: string; + machine?: string /** @description Working directory for this codespace */ - working_directory?: string; + working_directory?: string /** @description Time in minutes before codespace stops from inactivity */ - idle_timeout_minutes?: number; - }; - }; - }; - }; + idle_timeout_minutes?: number + } + } + } + } /** * List the machine types available for a given repository based on its configuration. * @@ -30021,34 +29988,34 @@ export interface operations { * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/repo-machines-for-authenticated-user": { + 'codespaces/repo-machines-for-authenticated-user': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Required. The location to check for available machines. */ - location: string; - }; - }; + location: string + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - machines: components["schemas"]["codespace-machine"][]; - }; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': { + total_count: number + machines: components['schemas']['codespace-machine'][] + } + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** * For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. * @@ -30058,12 +30025,12 @@ export interface operations { * endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this * endpoint. */ - "repos/list-collaborators": { + 'repos/list-collaborators': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** * Filter collaborators returned by their affiliation. Can be one of: @@ -30071,24 +30038,24 @@ export interface operations { * \* `direct`: All collaborators with permissions to an organization-owned repository, regardless of organization membership status. * \* `all`: All collaborators the authenticated user can see. */ - affiliation?: "outside" | "direct" | "all"; + affiliation?: 'outside' | 'direct' | 'all' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["collaborator"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['collaborator'][] + } + } + 404: components['responses']['not_found'] + } + } /** * For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. * @@ -30098,21 +30065,21 @@ export interface operations { * endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this * endpoint. */ - "repos/check-collaborator": { + 'repos/check-collaborator': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - username: components["parameters"]["username"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + username: components['parameters']['username'] + } + } responses: { /** Response if user is a collaborator */ - 204: never; + 204: never /** Not Found if user is not a collaborator */ - 404: unknown; - }; - }; + 404: unknown + } + } /** * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. * @@ -30130,29 +30097,29 @@ export interface operations { * * You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository. */ - "repos/add-collaborator": { + 'repos/add-collaborator': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - username: components["parameters"]["username"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + username: components['parameters']['username'] + } + } responses: { /** Response when a new invitation is created */ 201: { content: { - "application/json": components["schemas"]["repository-invitation"]; - }; - }; + 'application/json': components['schemas']['repository-invitation'] + } + } /** Response when person is already a collaborator */ - 204: never; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + 204: never + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: * \* `pull` - can pull, but not push to or administer this repository. @@ -30164,221 +30131,221 @@ export interface operations { * @default push * @enum {string} */ - permission?: "pull" | "push" | "admin" | "maintain" | "triage"; + permission?: 'pull' | 'push' | 'admin' | 'maintain' | 'triage' /** @example "push" */ - permissions?: string; - }; - }; - }; - }; - "repos/remove-collaborator": { + permissions?: string + } + } + } + } + 'repos/remove-collaborator': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - username: components["parameters"]["username"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** Checks the repository permission of a collaborator. The possible repository permissions are `admin`, `write`, `read`, and `none`. */ - "repos/get-collaborator-permission-level": { + 'repos/get-collaborator-permission-level': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - username: components["parameters"]["username"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + username: components['parameters']['username'] + } + } responses: { /** if user has admin permissions */ 200: { content: { - "application/json": components["schemas"]["repository-collaborator-permission"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['repository-collaborator-permission'] + } + } + 404: components['responses']['not_found'] + } + } /** * Commit Comments use [these custom media types](https://docs.github.com/rest/reference/repos#custom-media-types). You can read more about the use of media types in the API [here](https://docs.github.com/rest/overview/media-types/). * * Comments are ordered by ascending ID. */ - "repos/list-commit-comments-for-repo": { + 'repos/list-commit-comments-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["commit-comment"][]; - }; - }; - }; - }; - "repos/get-commit-comment": { + 'application/json': components['schemas']['commit-comment'][] + } + } + } + } + 'repos/get-commit-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["commit-comment"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "repos/delete-commit-comment": { + 'application/json': components['schemas']['commit-comment'] + } + } + 404: components['responses']['not_found'] + } + } + 'repos/delete-commit-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; - "repos/update-commit-comment": { + 204: never + 404: components['responses']['not_found'] + } + } + 'repos/update-commit-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["commit-comment"]; - }; - }; - 404: components["responses"]["not_found"]; - }; + 'application/json': components['schemas']['commit-comment'] + } + } + 404: components['responses']['not_found'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The contents of the comment */ - body: string; - }; - }; - }; - }; + body: string + } + } + } + } /** List the reactions to a [commit comment](https://docs.github.com/rest/reference/repos#comments). */ - "reactions/list-for-commit-comment": { + 'reactions/list-for-commit-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; + comment_id: components['parameters']['comment-id'] + } query: { /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a commit comment. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content?: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["reaction"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['reaction'][] + } + } + 404: components['responses']['not_found'] + } + } /** Create a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. */ - "reactions/create-for-commit-comment": { + 'reactions/create-for-commit-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Reaction exists */ 200: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; + 'application/json': components['schemas']['reaction'] + } + } /** Reaction created */ 201: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - 415: components["responses"]["preview_header_missing"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['reaction'] + } + } + 415: components['responses']['preview_header_missing'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the commit comment. * @enum {string} */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - }; + content: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' + } + } + } + } /** * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. * * Delete a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). */ - "reactions/delete-for-commit-comment": { + 'reactions/delete-for-commit-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - reaction_id: components["parameters"]["reaction-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + reaction_id: components['parameters']['reaction-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * **Signature verification object** * @@ -30409,161 +30376,161 @@ export interface operations { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - "repos/list-commits": { + 'repos/list-commits': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** SHA or branch to start listing commits from. Default: the repository’s default branch (usually `master`). */ - sha?: string; + sha?: string /** Only commits containing this file path will be returned. */ - path?: string; + path?: string /** GitHub login or email address by which to filter by commit author. */ - author?: string; + author?: string /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - until?: string; + until?: string /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["commit"][]; - }; - }; - 400: components["responses"]["bad_request"]; - 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': components['schemas']['commit'][] + } + } + 400: components['responses']['bad_request'] + 404: components['responses']['not_found'] + 409: components['responses']['conflict'] + 500: components['responses']['internal_error'] + } + } /** * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. */ - "repos/list-branches-for-head-commit": { + 'repos/list-branches-for-head-commit': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** commit_sha parameter */ - commit_sha: components["parameters"]["commit-sha"]; - }; - }; + commit_sha: components['parameters']['commit-sha'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["branch-short"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['branch-short'][] + } + } + 422: components['responses']['validation_failed'] + } + } /** Use the `:commit_sha` to specify the commit that will have its comments listed. */ - "repos/list-comments-for-commit": { + 'repos/list-comments-for-commit': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** commit_sha parameter */ - commit_sha: components["parameters"]["commit-sha"]; - }; + commit_sha: components['parameters']['commit-sha'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["commit-comment"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['commit-comment'][] + } + } + } + } /** * Create a comment for a commit using its `:commit_sha`. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - "repos/create-commit-comment": { + 'repos/create-commit-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** commit_sha parameter */ - commit_sha: components["parameters"]["commit-sha"]; - }; - }; + commit_sha: components['parameters']['commit-sha'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["commit-comment"]; - }; - }; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['commit-comment'] + } + } + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The contents of the comment. */ - body: string; + body: string /** @description Relative path of the file to comment on. */ - path?: string; + path?: string /** @description Line index in the diff to comment on. */ - position?: number; + position?: number /** @description **Deprecated**. Use **position** parameter instead. Line number in the file to comment on. */ - line?: number; - }; - }; - }; - }; + line?: number + } + } + } + } /** Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the [List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests) endpoint. */ - "repos/list-pull-requests-associated-with-commit": { + 'repos/list-pull-requests-associated-with-commit': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** commit_sha parameter */ - commit_sha: components["parameters"]["commit-sha"]; - }; + commit_sha: components['parameters']['commit-sha'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["pull-request-simple"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['pull-request-simple'][] + } + } + } + } /** * Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. * @@ -30602,110 +30569,110 @@ export interface operations { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - "repos/get-commit": { + 'repos/get-commit': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** ref parameter */ - ref: string; - }; + ref: string + } query: { /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["commit"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': components['schemas']['commit'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + 500: components['responses']['internal_error'] + } + } /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. */ - "checks/list-for-ref": { + 'checks/list-for-ref': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** ref parameter */ - ref: string; - }; + ref: string + } query: { /** Returns check runs with the specified `name`. */ - check_name?: components["parameters"]["check-name"]; + check_name?: components['parameters']['check-name'] /** Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`. */ - status?: components["parameters"]["status"]; + status?: components['parameters']['status'] /** Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`. */ - filter?: "latest" | "all"; + filter?: 'latest' | 'all' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - app_id?: number; - }; - }; + page?: components['parameters']['page'] + app_id?: number + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - check_runs: components["schemas"]["check-run"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + check_runs: components['schemas']['check-run'][] + } + } + } + } + } /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * * Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository. */ - "checks/list-suites-for-ref": { + 'checks/list-suites-for-ref': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** ref parameter */ - ref: string; - }; + ref: string + } query: { /** Filters check suites by GitHub App `id`. */ - app_id?: number; + app_id?: number /** Returns check runs with the specified `name`. */ - check_name?: components["parameters"]["check-name"]; + check_name?: components['parameters']['check-name'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - check_suites: components["schemas"]["check-suite"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + check_suites: components['schemas']['check-suite'][] + } + } + } + } + } /** * Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. * @@ -30716,62 +30683,62 @@ export interface operations { * * **pending** if there are no statuses or a context is `pending` * * **success** if the latest status for all contexts is `success` */ - "repos/get-combined-status-for-ref": { + 'repos/get-combined-status-for-ref': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** ref parameter */ - ref: string; - }; + ref: string + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["combined-commit-status"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['combined-commit-status'] + } + } + 404: components['responses']['not_found'] + } + } /** * Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one. * * This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`. */ - "repos/list-commit-statuses-for-ref": { + 'repos/list-commit-statuses-for-ref': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** ref parameter */ - ref: string; - }; + ref: string + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["status"][]; - }; - }; - 301: components["responses"]["moved_permanently"]; - }; - }; + 'application/json': components['schemas']['status'][] + } + } + 301: components['responses']['moved_permanently'] + } + } /** * This endpoint will return all community profile metrics, including an * overall health score, repository description, the presence of documentation, detected @@ -30786,22 +30753,22 @@ export interface operations { * * `content_reports_enabled` is only returned for organization-owned repositories. */ - "repos/get-community-profile-metrics": { + 'repos/get-community-profile-metrics': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["community-profile"]; - }; - }; - }; - }; + 'application/json': components['schemas']['community-profile'] + } + } + } + } /** * The `basehead` param is comprised of two parts: `base` and `head`. Both must be branch names in `repo`. To compare branches across other repositories in the same network as `repo`, use the format `:branch`. * @@ -30844,32 +30811,32 @@ export interface operations { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - "repos/compare-commits": { + 'repos/compare-commits': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The base branch and head branch to compare. This parameter expects the format `{base}...{head}`. */ - basehead: string; - }; + basehead: string + } query: { /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["commit-comparison"]; - }; - }; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': components['schemas']['commit-comparison'] + } + } + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** * Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit * `:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. @@ -30904,96 +30871,96 @@ export interface operations { * If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the * github.com URLs (`html_url` and `_links["html"]`) will have null values. */ - "repos/get-content": { + 'repos/get-content': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** path parameter */ - path: string; - }; + path: string + } query: { /** The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`) */ - ref?: string; - }; - }; - responses: { - /** Response */ - 200: { - content: { - "application/vnd.github.v3.object": components["schemas"]["content-tree"]; - "application/json": - | components["schemas"]["content-directory"] - | components["schemas"]["content-file"] - | components["schemas"]["content-symlink"] - | components["schemas"]["content-submodule"]; - }; - }; - 302: components["responses"]["found"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + ref?: string + } + } + responses: { + /** Response */ + 200: { + content: { + 'application/vnd.github.v3.object': components['schemas']['content-tree'] + 'application/json': + | components['schemas']['content-directory'] + | components['schemas']['content-file'] + | components['schemas']['content-symlink'] + | components['schemas']['content-submodule'] + } + } + 302: components['responses']['found'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Creates a new file or replaces an existing file in a repository. */ - "repos/create-or-update-file-contents": { + 'repos/create-or-update-file-contents': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** path parameter */ - path: string; - }; - }; + path: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["file-commit"]; - }; - }; + 'application/json': components['schemas']['file-commit'] + } + } /** Response */ 201: { content: { - "application/json": components["schemas"]["file-commit"]; - }; - }; - 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['file-commit'] + } + } + 404: components['responses']['not_found'] + 409: components['responses']['conflict'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The commit message. */ - message: string; + message: string /** @description The new file content, using Base64 encoding. */ - content: string; + content: string /** @description **Required if you are updating a file**. The blob SHA of the file being replaced. */ - sha?: string; + sha?: string /** @description The branch name. Default: the repository’s default branch (usually `master`) */ - branch?: string; + branch?: string /** @description The person that committed the file. Default: the authenticated user. */ committer?: { /** @description The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted. */ - name: string; + name: string /** @description The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted. */ - email: string; + email: string /** @example "2013-01-05T13:13:22+05:00" */ - date?: string; - }; + date?: string + } /** @description The author of the file. Default: The `committer` or the authenticated user if you omit `committer`. */ author?: { /** @description The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted. */ - name: string; + name: string /** @description The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted. */ - email: string; + email: string /** @example "2013-01-15T17:13:22+05:00" */ - date?: string; - }; - }; - }; - }; - }; + date?: string + } + } + } + } + } /** * Deletes a file in a repository. * @@ -31003,151 +30970,151 @@ export interface operations { * * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. */ - "repos/delete-file": { + 'repos/delete-file': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** path parameter */ - path: string; - }; - }; + path: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["file-commit"]; - }; - }; - 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; - 422: components["responses"]["validation_failed"]; - 503: components["responses"]["service_unavailable"]; - }; + 'application/json': components['schemas']['file-commit'] + } + } + 404: components['responses']['not_found'] + 409: components['responses']['conflict'] + 422: components['responses']['validation_failed'] + 503: components['responses']['service_unavailable'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The commit message. */ - message: string; + message: string /** @description The blob SHA of the file being replaced. */ - sha: string; + sha: string /** @description The branch name. Default: the repository’s default branch (usually `master`) */ - branch?: string; + branch?: string /** @description object containing information about the committer. */ committer?: { /** @description The name of the author (or committer) of the commit */ - name?: string; + name?: string /** @description The email of the author (or committer) of the commit */ - email?: string; - }; + email?: string + } /** @description object containing information about the author. */ author?: { /** @description The name of the author (or committer) of the commit */ - name?: string; + name?: string /** @description The email of the author (or committer) of the commit */ - email?: string; - }; - }; - }; - }; - }; + email?: string + } + } + } + } + } /** * Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance. * * GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information. */ - "repos/list-contributors": { + 'repos/list-contributors': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Set to `1` or `true` to include anonymous contributors in results. */ - anon?: string; + anon?: string /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** if repository contains content */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["contributor"][]; - }; - }; + 'application/json': components['schemas']['contributor'][] + } + } /** Response if repository is empty */ - 204: never; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */ - "dependabot/list-repo-secrets": { + 'dependabot/list-repo-secrets': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - secrets: components["schemas"]["dependabot-secret"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + secrets: components['schemas']['dependabot-secret'][] + } + } + } + } + } /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */ - "dependabot/get-repo-public-key": { + 'dependabot/get-repo-public-key': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["dependabot-public-key"]; - }; - }; - }; - }; + 'application/json': components['schemas']['dependabot-public-key'] + } + } + } + } /** Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */ - "dependabot/get-repo-secret": { + 'dependabot/get-repo-secret': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["dependabot-secret"]; - }; - }; - }; - }; + 'application/json': components['schemas']['dependabot-secret'] + } + } + } + } /** * Creates or updates a repository secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -31225,83 +31192,83 @@ export interface operations { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - "dependabot/create-or-update-repo-secret": { + 'dependabot/create-or-update-repo-secret': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response when creating a secret */ 201: { content: { - "application/json": { [key: string]: unknown }; - }; - }; + 'application/json': { [key: string]: unknown } + } + } /** Response when updating a secret */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/reference/dependabot#get-a-repository-public-key) endpoint. */ - encrypted_value?: string; + encrypted_value?: string /** @description ID of the key you used to encrypt the secret. */ - key_id?: string; - }; - }; - }; - }; + key_id?: string + } + } + } + } /** Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */ - "dependabot/delete-repo-secret": { + 'dependabot/delete-repo-secret': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** Simple filtering of deployments is available via query parameters: */ - "repos/list-deployments": { + 'repos/list-deployments': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** The SHA recorded at creation time. */ - sha?: string; + sha?: string /** The name of the ref. This can be a branch, tag, or SHA. */ - ref?: string; + ref?: string /** The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`). */ - task?: string; + task?: string /** The name of the environment that was deployed to (e.g., `staging` or `production`). */ - environment?: string | null; + environment?: string | null /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["deployment"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['deployment'][] + } + } + } + } /** * Deployments offer a few configurable parameters with certain defaults. * @@ -31349,84 +31316,84 @@ export interface operations { * This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` * status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. */ - "repos/create-deployment": { + 'repos/create-deployment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["deployment"]; - }; - }; + 'application/json': components['schemas']['deployment'] + } + } /** Merged branch response */ 202: { content: { - "application/json": { - message?: string; - }; - }; - }; + 'application/json': { + message?: string + } + } + } /** Conflict when there is a merge conflict or the commit's status checks failed */ - 409: unknown; - 422: components["responses"]["validation_failed"]; - }; + 409: unknown + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The ref to deploy. This can be a branch, tag, or SHA. */ - ref: string; + ref: string /** * @description Specifies a task to execute (e.g., `deploy` or `deploy:migrations`). * @default deploy */ - task?: string; + task?: string /** * @description Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch. * @default true */ - auto_merge?: boolean; + auto_merge?: boolean /** @description The [status](https://docs.github.com/rest/reference/commits#commit-statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts. */ - required_contexts?: string[]; - payload?: { [key: string]: unknown } | string; + required_contexts?: string[] + payload?: { [key: string]: unknown } | string /** * @description Name for the target deployment environment (e.g., `production`, `staging`, `qa`). * @default production */ - environment?: string; + environment?: string /** @description Short description of the deployment. */ - description?: string | null; + description?: string | null /** @description Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false` */ - transient_environment?: boolean; + transient_environment?: boolean /** @description Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise. */ - production_environment?: boolean; - }; - }; - }; - }; - "repos/get-deployment": { + production_environment?: boolean + } + } + } + } + 'repos/get-deployment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** deployment_id parameter */ - deployment_id: components["parameters"]["deployment-id"]; - }; - }; + deployment_id: components['parameters']['deployment-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["deployment"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['deployment'] + } + } + 404: components['responses']['not_found'] + } + } /** * If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. Anyone with `repo` or `repo_deployment` scopes can delete a deployment. * @@ -31437,123 +31404,123 @@ export interface operations { * * For more information, see "[Create a deployment](https://docs.github.com/rest/reference/repos/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/reference/repos#create-a-deployment-status)." */ - "repos/delete-deployment": { + 'repos/delete-deployment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** deployment_id parameter */ - deployment_id: components["parameters"]["deployment-id"]; - }; - }; + deployment_id: components['parameters']['deployment-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } + } /** Users with pull access can view deployment statuses for a deployment: */ - "repos/list-deployment-statuses": { + 'repos/list-deployment-statuses': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** deployment_id parameter */ - deployment_id: components["parameters"]["deployment-id"]; - }; + deployment_id: components['parameters']['deployment-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["deployment-status"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['deployment-status'][] + } + } + 404: components['responses']['not_found'] + } + } /** * Users with `push` access can create deployment statuses for a given deployment. * * GitHub Apps require `read & write` access to "Deployments" and `read-only` access to "Repo contents" (for private repos). OAuth Apps require the `repo_deployment` scope. */ - "repos/create-deployment-status": { + 'repos/create-deployment-status': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** deployment_id parameter */ - deployment_id: components["parameters"]["deployment-id"]; - }; - }; + deployment_id: components['parameters']['deployment-id'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["deployment-status"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['deployment-status'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued`, `pending`, or `success`. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub. * @enum {string} */ - state: "error" | "failure" | "inactive" | "in_progress" | "queued" | "pending" | "success"; + state: 'error' | 'failure' | 'inactive' | 'in_progress' | 'queued' | 'pending' | 'success' /** @description The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`. */ - target_url?: string; + target_url?: string /** @description The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `""` */ - log_url?: string; + log_url?: string /** @description A short description of the status. The maximum description length is 140 characters. */ - description?: string; + description?: string /** * @description Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. * @enum {string} */ - environment?: "production" | "staging" | "qa"; + environment?: 'production' | 'staging' | 'qa' /** @description Sets the URL for accessing your environment. Default: `""` */ - environment_url?: string; + environment_url?: string /** @description Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true` */ - auto_inactive?: boolean; - }; - }; - }; - }; + auto_inactive?: boolean + } + } + } + } /** Users with pull access can view a deployment status for a deployment: */ - "repos/get-deployment-status": { + 'repos/get-deployment-status': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** deployment_id parameter */ - deployment_id: components["parameters"]["deployment-id"]; - status_id: number; - }; - }; + deployment_id: components['parameters']['deployment-id'] + status_id: number + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["deployment-status"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['deployment-status'] + } + } + 404: components['responses']['not_found'] + } + } /** * You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/webhooks/event-payloads/#repository_dispatch)." * @@ -31566,76 +31533,76 @@ export interface operations { * * This input example shows how you can use the `client_payload` as a test to debug your workflow. */ - "repos/create-dispatch-event": { + 'repos/create-dispatch-event': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - 422: components["responses"]["validation_failed"]; - }; + 204: never + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description A custom webhook event name. */ - event_type: string; + event_type: string /** @description JSON payload with extra information about the webhook event that your action or worklow may use. */ - client_payload?: { [key: string]: unknown }; - }; - }; - }; - }; + client_payload?: { [key: string]: unknown } + } + } + } + } /** * Get all environments for a repository. * * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "repos/get-all-environments": { + 'repos/get-all-environments': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { + 'application/json': { /** * @description The number of environments in this repository * @example 5 */ - total_count?: number; - environments?: components["schemas"]["environment"][]; - }; - }; - }; - }; - }; + total_count?: number + environments?: components['schemas']['environment'][] + } + } + } + } + } /** Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ - "repos/get-environment": { + 'repos/get-environment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the environment */ - environment_name: components["parameters"]["environment-name"]; - }; - }; + environment_name: components['parameters']['environment-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["environment"]; - }; - }; - }; - }; + 'application/json': components['schemas']['environment'] + } + } + } + } /** * Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)." * @@ -31645,206 +31612,206 @@ export interface operations { * * You must authenticate using an access token with the repo scope to use this endpoint. */ - "repos/create-or-update-environment": { + 'repos/create-or-update-environment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the environment */ - environment_name: components["parameters"]["environment-name"]; - }; - }; + environment_name: components['parameters']['environment-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["environment"]; - }; - }; + 'application/json': components['schemas']['environment'] + } + } /** Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` are set to the same value */ 422: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } + } requestBody: { content: { - "application/json": { - wait_timer?: components["schemas"]["wait-timer"]; + 'application/json': { + wait_timer?: components['schemas']['wait-timer'] /** @description The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */ reviewers?: | { - type?: components["schemas"]["deployment-reviewer-type"]; + type?: components['schemas']['deployment-reviewer-type'] /** * @description The id of the user or team who can review the deployment * @example 4532992 */ - id?: number; + id?: number }[] - | null; - deployment_branch_policy?: components["schemas"]["deployment_branch_policy"]; - } | null; - }; - }; - }; + | null + deployment_branch_policy?: components['schemas']['deployment_branch_policy'] + } | null + } + } + } /** You must authenticate using an access token with the repo scope to use this endpoint. */ - "repos/delete-an-environment": { + 'repos/delete-an-environment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The name of the environment */ - environment_name: components["parameters"]["environment-name"]; - }; - }; + environment_name: components['parameters']['environment-name'] + } + } responses: { /** Default response */ - 204: never; - }; - }; - "activity/list-repo-events": { + 204: never + } + } + 'activity/list-repo-events': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["event"][]; - }; - }; - }; - }; - "repos/list-forks": { + 'application/json': components['schemas']['event'][] + } + } + } + } + 'repos/list-forks': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** The sort order. Can be either `newest`, `oldest`, or `stargazers`. */ - sort?: "newest" | "oldest" | "stargazers" | "watchers"; + sort?: 'newest' | 'oldest' | 'stargazers' | 'watchers' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["minimal-repository"][]; - }; - }; - 400: components["responses"]["bad_request"]; - }; - }; + 'application/json': components['schemas']['minimal-repository'][] + } + } + 400: components['responses']['bad_request'] + } + } /** * Create a fork for the authenticated user. * * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). */ - "repos/create-fork": { + 'repos/create-fork': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 202: { content: { - "application/json": components["schemas"]["full-repository"]; - }; - }; - 400: components["responses"]["bad_request"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['full-repository'] + } + } + 400: components['responses']['bad_request'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Optional parameter to specify the organization name if forking into an organization. */ - organization?: string; - } | null; - }; - }; - }; - "git/create-blob": { + organization?: string + } | null + } + } + } + 'git/create-blob': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["short-blob"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['short-blob'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 409: components['responses']['conflict'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The new blob's content. */ - content: string; + content: string /** * @description The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. * @default utf-8 */ - encoding?: string; - }; - }; - }; - }; + encoding?: string + } + } + } + } /** * The `content` in the response will always be Base64 encoded. * * _Note_: This API supports blobs up to 100 megabytes in size. */ - "git/get-blob": { + 'git/get-blob': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - file_sha: string; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + file_sha: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["blob"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['blob'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** * Creates a new Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects). * @@ -31877,65 +31844,65 @@ export interface operations { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - "git/create-commit": { + 'git/create-commit': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["git-commit"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['git-commit'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The commit message */ - message: string; + message: string /** @description The SHA of the tree object this commit points to */ - tree: string; + tree: string /** @description The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. */ - parents?: string[]; + parents?: string[] /** @description Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details. */ author?: { /** @description The name of the author (or committer) of the commit */ - name: string; + name: string /** @description The email of the author (or committer) of the commit */ - email: string; + email: string /** * Format: date-time * @description Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - date?: string; - }; + date?: string + } /** @description Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details. */ committer?: { /** @description The name of the author (or committer) of the commit */ - name?: string; + name?: string /** @description The email of the author (or committer) of the commit */ - email?: string; + email?: string /** * Format: date-time * @description Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - date?: string; - }; + date?: string + } /** @description The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits. */ - signature?: string; - }; - }; - }; - }; + signature?: string + } + } + } + } /** * Gets a Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects). * @@ -31968,25 +31935,25 @@ export interface operations { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - "git/get-commit": { + 'git/get-commit': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** commit_sha parameter */ - commit_sha: components["parameters"]["commit-sha"]; - }; - }; + commit_sha: components['parameters']['commit-sha'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["git-commit"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['git-commit'] + } + } + 404: components['responses']['not_found'] + } + } /** * Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array. * @@ -31996,132 +31963,132 @@ export interface operations { * * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. */ - "git/list-matching-refs": { + 'git/list-matching-refs': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** ref parameter */ - ref: string; - }; + ref: string + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["git-ref"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['git-ref'][] + } + } + } + } /** * Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. * * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". */ - "git/get-ref": { + 'git/get-ref': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** ref parameter */ - ref: string; - }; - }; + ref: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["git-ref"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['git-ref'] + } + } + 404: components['responses']['not_found'] + } + } /** Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches. */ - "git/create-ref": { + 'git/create-ref': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["git-ref"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['git-ref'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected. */ - ref: string; + ref: string /** @description The SHA1 value for this reference. */ - sha: string; + sha: string /** @example "refs/heads/newbranch" */ - key?: string; - }; - }; - }; - }; - "git/delete-ref": { + key?: string + } + } + } + } + 'git/delete-ref': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** ref parameter */ - ref: string; - }; - }; + ref: string + } + } responses: { /** Response */ - 204: never; - 422: components["responses"]["validation_failed"]; - }; - }; - "git/update-ref": { + 204: never + 422: components['responses']['validation_failed'] + } + } + 'git/update-ref': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** ref parameter */ - ref: string; - }; - }; + ref: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["git-ref"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['git-ref'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The SHA1 value to set this reference to */ - sha: string; + sha: string /** @description Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work. */ - force?: boolean; - }; - }; - }; - }; + force?: boolean + } + } + } + } /** * Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/rest/reference/git#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/rest/reference/git#create-a-reference) the tag reference - this call would be unnecessary. * @@ -32154,55 +32121,55 @@ export interface operations { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - "git/create-tag": { + 'git/create-tag': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["git-tag"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['git-tag'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The tag's name. This is typically a version (e.g., "v0.0.1"). */ - tag: string; + tag: string /** @description The tag message. */ - message: string; + message: string /** @description The SHA of the git object this is tagging. */ - object: string; + object: string /** * @description The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`. * @enum {string} */ - type: "commit" | "tree" | "blob"; + type: 'commit' | 'tree' | 'blob' /** @description An object with information about the individual creating the tag. */ tagger?: { /** @description The name of the author of the tag */ - name: string; + name: string /** @description The email of the author of the tag */ - email: string; + email: string /** * Format: date-time * @description When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - date?: string; - }; - }; - }; - }; - }; + date?: string + } + } + } + } + } /** * **Signature verification object** * @@ -32233,431 +32200,431 @@ export interface operations { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - "git/get-tag": { + 'git/get-tag': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - tag_sha: string; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + tag_sha: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["git-tag"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['git-tag'] + } + } + 404: components['responses']['not_found'] + } + } /** * The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure. * * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/rest/reference/git#create-a-commit)" and "[Update a reference](https://docs.github.com/rest/reference/git#update-a-reference)." */ - "git/create-tree": { + 'git/create-tree': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["git-tree"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['git-tree'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure. */ tree: { /** @description The file referenced in the tree. */ - path?: string; + path?: string /** * @description The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink. * @enum {string} */ - mode?: "100644" | "100755" | "040000" | "160000" | "120000"; + mode?: '100644' | '100755' | '040000' | '160000' | '120000' /** * @description Either `blob`, `tree`, or `commit`. * @enum {string} */ - type?: "blob" | "tree" | "commit"; + type?: 'blob' | 'tree' | 'commit' /** * @description The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. * * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. */ - sha?: string | null; + sha?: string | null /** * @description The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. * * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. */ - content?: string; - }[]; + content?: string + }[] /** * @description The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on. * If not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit. */ - base_tree?: string; - }; - }; - }; - }; + base_tree?: string + } + } + } + } /** * Returns a single tree using the SHA1 value for that tree. * * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. */ - "git/get-tree": { + 'git/get-tree': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - tree_sha: string; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + tree_sha: string + } query: { /** Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` to any of the following will enable returning objects or subtrees: `0`, `1`, `"true"`, and `"false"`. Omit this parameter to prevent recursively returning objects or subtrees. */ - recursive?: string; - }; - }; + recursive?: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["git-tree"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "repos/list-webhooks": { + 'application/json': components['schemas']['git-tree'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } + 'repos/list-webhooks': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["hook"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['hook'][] + } + } + 404: components['responses']['not_found'] + } + } /** * Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can * share the same `config` as long as those webhooks do not have any `events` that overlap. */ - "repos/create-webhook": { + 'repos/create-webhook': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["hook"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['hook'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`. */ - name?: string; + name?: string /** @description Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/repos#create-hook-config-params). */ config?: { - url?: components["schemas"]["webhook-config-url"]; - content_type?: components["schemas"]["webhook-config-content-type"]; - secret?: components["schemas"]["webhook-config-secret"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + url?: components['schemas']['webhook-config-url'] + content_type?: components['schemas']['webhook-config-content-type'] + secret?: components['schemas']['webhook-config-secret'] + insecure_ssl?: components['schemas']['webhook-config-insecure-ssl'] /** @example "abc" */ - token?: string; + token?: string /** @example "sha256" */ - digest?: string; - }; + digest?: string + } /** * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. * @default push */ - events?: string[]; + events?: string[] /** * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. * @default true */ - active?: boolean; - } | null; - }; - }; - }; + active?: boolean + } | null + } + } + } /** Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/reference/repos#get-a-webhook-configuration-for-a-repository)." */ - "repos/get-webhook": { + 'repos/get-webhook': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["hook"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "repos/delete-webhook": { + 'application/json': components['schemas']['hook'] + } + } + 404: components['responses']['not_found'] + } + } + 'repos/delete-webhook': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/reference/repos#update-a-webhook-configuration-for-a-repository)." */ - "repos/update-webhook": { + 'repos/update-webhook': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["hook"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['hook'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/repos#create-hook-config-params). */ config?: { - url: components["schemas"]["webhook-config-url"]; - content_type?: components["schemas"]["webhook-config-content-type"]; - secret?: components["schemas"]["webhook-config-secret"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + url: components['schemas']['webhook-config-url'] + content_type?: components['schemas']['webhook-config-content-type'] + secret?: components['schemas']['webhook-config-secret'] + insecure_ssl?: components['schemas']['webhook-config-insecure-ssl'] /** @example "bar@example.com" */ - address?: string; + address?: string /** @example "The Serious Room" */ - room?: string; - }; + room?: string + } /** * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events. * @default push */ - events?: string[]; + events?: string[] /** @description Determines a list of events to be added to the list of events that the Hook triggers for. */ - add_events?: string[]; + add_events?: string[] /** @description Determines a list of events to be removed from the list of events that the Hook triggers for. */ - remove_events?: string[]; + remove_events?: string[] /** * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. * @default true */ - active?: boolean; - }; - }; - }; - }; + active?: boolean + } + } + } + } /** * Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/reference/orgs#get-a-repository-webhook)." * * Access tokens must have the `read:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:read` permission. */ - "repos/get-webhook-config-for-repo": { + 'repos/get-webhook-config-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["webhook-config"]; - }; - }; - }; - }; + 'application/json': components['schemas']['webhook-config'] + } + } + } + } /** * Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/reference/orgs#update-a-repository-webhook)." * * Access tokens must have the `write:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:write` permission. */ - "repos/update-webhook-config-for-repo": { + 'repos/update-webhook-config-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["webhook-config"]; - }; - }; - }; + 'application/json': components['schemas']['webhook-config'] + } + } + } requestBody: { content: { - "application/json": { - url?: components["schemas"]["webhook-config-url"]; - content_type?: components["schemas"]["webhook-config-content-type"]; - secret?: components["schemas"]["webhook-config-secret"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - }; - }; - }; - }; + 'application/json': { + url?: components['schemas']['webhook-config-url'] + content_type?: components['schemas']['webhook-config-content-type'] + secret?: components['schemas']['webhook-config-secret'] + insecure_ssl?: components['schemas']['webhook-config-insecure-ssl'] + } + } + } + } /** Returns a list of webhook deliveries for a webhook configured in a repository. */ - "repos/list-webhook-deliveries": { + 'repos/list-webhook-deliveries': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - hook_id: components["parameters"]["hook-id"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + hook_id: components['parameters']['hook-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ - cursor?: components["parameters"]["cursor"]; - }; - }; + cursor?: components['parameters']['cursor'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["hook-delivery-item"][]; - }; - }; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['hook-delivery-item'][] + } + } + 400: components['responses']['bad_request'] + 422: components['responses']['validation_failed'] + } + } /** Returns a delivery for a webhook configured in a repository. */ - "repos/get-webhook-delivery": { + 'repos/get-webhook-delivery': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - hook_id: components["parameters"]["hook-id"]; - delivery_id: components["parameters"]["delivery-id"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + hook_id: components['parameters']['hook-id'] + delivery_id: components['parameters']['delivery-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["hook-delivery"]; - }; - }; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['hook-delivery'] + } + } + 400: components['responses']['bad_request'] + 422: components['responses']['validation_failed'] + } + } /** Redeliver a webhook delivery for a webhook configured in a repository. */ - "repos/redeliver-webhook-delivery": { + 'repos/redeliver-webhook-delivery': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - hook_id: components["parameters"]["hook-id"]; - delivery_id: components["parameters"]["delivery-id"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + hook_id: components['parameters']['hook-id'] + delivery_id: components['parameters']['delivery-id'] + } + } responses: { - 202: components["responses"]["accepted"]; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 202: components['responses']['accepted'] + 400: components['responses']['bad_request'] + 422: components['responses']['validation_failed'] + } + } /** This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. */ - "repos/ping-webhook": { + 'repos/ping-webhook': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** * This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. * * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` */ - "repos/test-push-webhook": { + 'repos/test-push-webhook': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - hook_id: components["parameters"]["hook-id"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + hook_id: components['parameters']['hook-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** * View the progress of an import. * @@ -32694,360 +32661,359 @@ export interface operations { * * `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository. * * `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a "Get Large Files" request. */ - "migrations/get-import-status": { + 'migrations/get-import-status': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["import"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['import'] + } + } + 404: components['responses']['not_found'] + } + } /** Start a source import to a GitHub repository using GitHub Importer. */ - "migrations/start-import": { + 'migrations/start-import': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["import"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['import'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The URL of the originating repository. */ - vcs_url: string; + vcs_url: string /** * @description The originating VCS type. Can be one of `subversion`, `git`, `mercurial`, or `tfvc`. Please be aware that without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response. * @enum {string} */ - vcs?: "subversion" | "git" | "mercurial" | "tfvc"; + vcs?: 'subversion' | 'git' | 'mercurial' | 'tfvc' /** @description If authentication is required, the username to provide to `vcs_url`. */ - vcs_username?: string; + vcs_username?: string /** @description If authentication is required, the password to provide to `vcs_url`. */ - vcs_password?: string; + vcs_password?: string /** @description For a tfvc import, the name of the project that is being imported. */ - tfvc_project?: string; - }; - }; - }; - }; + tfvc_project?: string + } + } + } + } /** Stop an import for a repository. */ - "migrations/cancel-import": { + 'migrations/cancel-import': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API * request. If no parameters are provided, the import will be restarted. */ - "migrations/update-import": { + 'migrations/update-import': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["import"]; - }; - }; - }; + 'application/json': components['schemas']['import'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The username to provide to the originating repository. */ - vcs_username?: string; + vcs_username?: string /** @description The password to provide to the originating repository. */ - vcs_password?: string; + vcs_password?: string /** @example "git" */ - vcs?: string; + vcs?: string /** @example "project1" */ - tfvc_project?: string; - } | null; - }; - }; - }; + tfvc_project?: string + } | null + } + } + } /** * Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `. * * This endpoint and the [Map a commit author](https://docs.github.com/rest/reference/migrations#map-a-commit-author) endpoint allow you to provide correct Git author information. */ - "migrations/get-commit-authors": { + 'migrations/get-commit-authors': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** A user ID. Only return users with an ID greater than this ID. */ - since?: components["parameters"]["since-user"]; - }; - }; + since?: components['parameters']['since-user'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["porter-author"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['porter-author'][] + } + } + 404: components['responses']['not_found'] + } + } /** Update an author's identity for the import. Your application can continue updating authors any time before you push new commits to the repository. */ - "migrations/map-commit-author": { + 'migrations/map-commit-author': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - author_id: number; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + author_id: number + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["porter-author"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['porter-author'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The new Git author email. */ - email?: string; + email?: string /** @description The new Git author name. */ - name?: string; - }; - }; - }; - }; + name?: string + } + } + } + } /** List files larger than 100MB found during the import */ - "migrations/get-large-files": { + 'migrations/get-large-files': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["porter-large-file"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['porter-large-file'][] + } + } + } + } /** You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability is powered by [Git LFS](https://git-lfs.github.com). You can learn more about our LFS feature and working with large files [on our help site](https://docs.github.com/articles/versioning-large-files/). */ - "migrations/set-lfs-preference": { + 'migrations/set-lfs-preference': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["import"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['import'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description Can be one of `opt_in` (large files will be stored using Git LFS) or `opt_out` (large files will be removed during the import). * @enum {string} */ - use_lfs: "opt_in" | "opt_out"; - }; - }; - }; - }; + use_lfs: 'opt_in' | 'opt_out' + } + } + } + } /** * Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/get-repo-installation": { + 'apps/get-repo-installation': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["installation"]; - }; - }; - 301: components["responses"]["moved_permanently"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['installation'] + } + } + 301: components['responses']['moved_permanently'] + 404: components['responses']['not_found'] + } + } /** Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response. */ - "interactions/get-restrictions-for-repo": { + 'interactions/get-restrictions-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": Partial & - Partial<{ [key: string]: unknown }>; - }; - }; - }; - }; + 'application/json': Partial & Partial<{ [key: string]: unknown }> + } + } + } + } /** Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. */ - "interactions/set-restrictions-for-repo": { + 'interactions/set-restrictions-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["interaction-limit-response"]; - }; - }; + 'application/json': components['schemas']['interaction-limit-response'] + } + } /** Response */ - 409: unknown; - }; + 409: unknown + } requestBody: { content: { - "application/json": components["schemas"]["interaction-limit"]; - }; - }; - }; + 'application/json': components['schemas']['interaction-limit'] + } + } + } /** Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. */ - "interactions/remove-restrictions-for-repo": { + 'interactions/remove-restrictions-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; + 204: never /** Response */ - 409: unknown; - }; - }; + 409: unknown + } + } /** When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations. */ - "repos/list-invitations": { + 'repos/list-invitations': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["repository-invitation"][]; - }; - }; - }; - }; - "repos/delete-invitation": { + 'application/json': components['schemas']['repository-invitation'][] + } + } + } + } + 'repos/delete-invitation': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** invitation_id parameter */ - invitation_id: components["parameters"]["invitation-id"]; - }; - }; + invitation_id: components['parameters']['invitation-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; - "repos/update-invitation": { + 204: never + } + } + 'repos/update-invitation': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** invitation_id parameter */ - invitation_id: components["parameters"]["invitation-id"]; - }; - }; + invitation_id: components['parameters']['invitation-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["repository-invitation"]; - }; - }; - }; + 'application/json': components['schemas']['repository-invitation'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The permissions that the associated user will have on the repository. Valid values are `read`, `write`, `maintain`, `triage`, and `admin`. * @enum {string} */ - permissions?: "read" | "write" | "maintain" | "triage" | "admin"; - }; - }; - }; - }; + permissions?: 'read' | 'write' | 'maintain' | 'triage' | 'admin' + } + } + } + } /** * List issues in a repository. * @@ -33056,326 +33022,326 @@ export interface operations { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - "issues/list-for-repo": { + 'issues/list-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned. */ - milestone?: string; + milestone?: string /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ - state?: "open" | "closed" | "all"; + state?: 'open' | 'closed' | 'all' /** Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user. */ - assignee?: string; + assignee?: string /** The user that created the issue. */ - creator?: string; + creator?: string /** A user that's mentioned in the issue. */ - mentioned?: string; + mentioned?: string /** A list of comma separated label names. Example: `bug,ui,@high` */ - labels?: components["parameters"]["labels"]; + labels?: components['parameters']['labels'] /** What to sort results by. Can be either `created`, `updated`, `comments`. */ - sort?: "created" | "updated" | "comments"; + sort?: 'created' | 'updated' | 'comments' /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["issue"][]; - }; - }; - 301: components["responses"]["moved_permanently"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['issue'][] + } + } + 301: components['responses']['moved_permanently'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** * Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - "issues/create": { + 'issues/create': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["issue"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed"]; - 503: components["responses"]["service_unavailable"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['issue'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + 422: components['responses']['validation_failed'] + 503: components['responses']['service_unavailable'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The title of the issue. */ - title: string | number; + title: string | number /** @description The contents of the issue. */ - body?: string; + body?: string /** @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_ */ - assignee?: string | null; - milestone?: (string | number) | null; + assignee?: string | null + milestone?: (string | number) | null /** @description Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._ */ labels?: ( | string | { - id?: number; - name?: string; - description?: string | null; - color?: string | null; + id?: number + name?: string + description?: string | null + color?: string | null } - )[]; + )[] /** @description Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ */ - assignees?: string[]; - }; - }; - }; - }; + assignees?: string[] + } + } + } + } /** By default, Issue Comments are ordered by ascending ID. */ - "issues/list-comments-for-repo": { + 'issues/list-comments-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** One of `created` (when the repository was starred) or `updated` (when it was last pushed to). */ - sort?: components["parameters"]["sort"]; + sort?: components['parameters']['sort'] /** Either `asc` or `desc`. Ignored without the `sort` parameter. */ - direction?: "asc" | "desc"; + direction?: 'asc' | 'desc' /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["issue-comment"][]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "issues/get-comment": { + 'application/json': components['schemas']['issue-comment'][] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } + 'issues/get-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["issue-comment"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "issues/delete-comment": { + 'application/json': components['schemas']['issue-comment'] + } + } + 404: components['responses']['not_found'] + } + } + 'issues/delete-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; - "issues/update-comment": { + 204: never + } + } + 'issues/update-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["issue-comment"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['issue-comment'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The contents of the comment. */ - body: string; - }; - }; - }; - }; + body: string + } + } + } + } /** List the reactions to an [issue comment](https://docs.github.com/rest/reference/issues#comments). */ - "reactions/list-for-issue-comment": { + 'reactions/list-for-issue-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; + comment_id: components['parameters']['comment-id'] + } query: { /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue comment. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content?: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["reaction"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['reaction'][] + } + } + 404: components['responses']['not_found'] + } + } /** Create a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. */ - "reactions/create-for-issue-comment": { + 'reactions/create-for-issue-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Reaction exists */ 200: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; + 'application/json': components['schemas']['reaction'] + } + } /** Reaction created */ 201: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['reaction'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the issue comment. * @enum {string} */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - }; + content: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' + } + } + } + } /** * **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. * * Delete a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). */ - "reactions/delete-for-issue-comment": { + 'reactions/delete-for-issue-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - reaction_id: components["parameters"]["reaction-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + reaction_id: components['parameters']['reaction-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; - "issues/list-events-for-repo": { + 204: never + } + } + 'issues/list-events-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["issue-event"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; - }; - "issues/get-event": { + 'application/json': components['schemas']['issue-event'][] + } + } + 422: components['responses']['validation_failed'] + } + } + 'issues/get-event': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - event_id: number; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + event_id: number + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["issue-event"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - }; - }; + 'application/json': components['schemas']['issue-event'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + } + } /** * The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was * [transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If @@ -33389,394 +33355,394 @@ export interface operations { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - "issues/get": { + 'issues/get': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; - }; + issue_number: components['parameters']['issue-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["issue"]; - }; - }; - 301: components["responses"]["moved_permanently"]; - 304: components["responses"]["not_modified"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - }; - }; + 'application/json': components['schemas']['issue'] + } + } + 301: components['responses']['moved_permanently'] + 304: components['responses']['not_modified'] + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + } + } /** Issue owners and users with push access can edit an issue. */ - "issues/update": { + 'issues/update': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; - }; + issue_number: components['parameters']['issue-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["issue"]; - }; - }; - 301: components["responses"]["moved_permanently"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed"]; - 503: components["responses"]["service_unavailable"]; - }; + 'application/json': components['schemas']['issue'] + } + } + 301: components['responses']['moved_permanently'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + 422: components['responses']['validation_failed'] + 503: components['responses']['service_unavailable'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The title of the issue. */ - title?: (string | number) | null; + title?: (string | number) | null /** @description The contents of the issue. */ - body?: string | null; + body?: string | null /** @description Login for the user that this issue should be assigned to. **This field is deprecated.** */ - assignee?: string | null; + assignee?: string | null /** * @description State of the issue. Either `open` or `closed`. * @enum {string} */ - state?: "open" | "closed"; - milestone?: (string | number) | null; + state?: 'open' | 'closed' + milestone?: (string | number) | null /** @description Labels to associate with this issue. Pass one or more Labels to _replace_ the set of Labels on this Issue. Send an empty array (`[]`) to clear all Labels from the Issue. _NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise._ */ labels?: ( | string | { - id?: number; - name?: string; - description?: string | null; - color?: string | null; + id?: number + name?: string + description?: string | null + color?: string | null } - )[]; + )[] /** @description Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ */ - assignees?: string[]; - }; - }; - }; - }; + assignees?: string[] + } + } + } + } /** Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced. */ - "issues/add-assignees": { + 'issues/add-assignees': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; - }; + issue_number: components['parameters']['issue-number'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["issue"]; - }; - }; - }; + 'application/json': components['schemas']['issue'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._ */ - assignees?: string[]; - }; - }; - }; - }; + assignees?: string[] + } + } + } + } /** Removes one or more assignees from an issue. */ - "issues/remove-assignees": { + 'issues/remove-assignees': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; - }; + issue_number: components['parameters']['issue-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["issue"]; - }; - }; - }; + 'application/json': components['schemas']['issue'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._ */ - assignees?: string[]; - }; - }; - }; - }; + assignees?: string[] + } + } + } + } /** Issue Comments are ordered by ascending ID. */ - "issues/list-comments": { + 'issues/list-comments': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; + issue_number: components['parameters']['issue-number'] + } query: { /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["issue-comment"][]; - }; - }; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - }; - }; + 'application/json': components['schemas']['issue-comment'][] + } + } + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + } + } /** This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - "issues/create-comment": { + 'issues/create-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; - }; + issue_number: components['parameters']['issue-number'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["issue-comment"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['issue-comment'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The contents of the comment. */ - body: string; - }; - }; - }; - }; - "issues/list-events": { + body: string + } + } + } + } + 'issues/list-events': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; + issue_number: components['parameters']['issue-number'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["issue-event-for-issue"][]; - }; - }; - 410: components["responses"]["gone"]; - }; - }; - "issues/list-labels-on-issue": { + 'application/json': components['schemas']['issue-event-for-issue'][] + } + } + 410: components['responses']['gone'] + } + } + 'issues/list-labels-on-issue': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; + issue_number: components['parameters']['issue-number'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["label"][]; - }; - }; - 410: components["responses"]["gone"]; - }; - }; + 'application/json': components['schemas']['label'][] + } + } + 410: components['responses']['gone'] + } + } /** Removes any previous labels and sets the new labels for an issue. */ - "issues/set-labels": { + 'issues/set-labels': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; - }; + issue_number: components['parameters']['issue-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["label"][]; - }; - }; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['label'][] + } + } + 410: components['responses']['gone'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see "[Add labels to an issue](https://docs.github.com/rest/reference/issues#add-labels-to-an-issue)." */ - labels?: string[]; + labels?: string[] } | string[] | { labels?: { - name: string; - }[]; + name: string + }[] } | { - name: string; + name: string }[] - | string; - }; - }; - }; - "issues/add-labels": { + | string + } + } + } + 'issues/add-labels': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; - }; + issue_number: components['parameters']['issue-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["label"][]; - }; - }; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['label'][] + } + } + 410: components['responses']['gone'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also replace all of the labels for an issue. For more information, see "[Set labels for an issue](https://docs.github.com/rest/reference/issues#set-labels-for-an-issue)." */ - labels?: string[]; + labels?: string[] } | string[] | { labels?: { - name: string; - }[]; + name: string + }[] } | { - name: string; + name: string }[] - | string; - }; - }; - }; - "issues/remove-all-labels": { + | string + } + } + } + 'issues/remove-all-labels': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; - }; + issue_number: components['parameters']['issue-number'] + } + } responses: { /** Response */ - 204: never; - 410: components["responses"]["gone"]; - }; - }; + 204: never + 410: components['responses']['gone'] + } + } /** Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist. */ - "issues/remove-label": { + 'issues/remove-label': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - name: string; - }; - }; + issue_number: components['parameters']['issue-number'] + name: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["label"][]; - }; - }; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - }; - }; + 'application/json': components['schemas']['label'][] + } + } + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + } + } /** * Users with push access can lock an issue or pull request's conversation. * * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - "issues/lock": { + 'issues/lock': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; - }; + issue_number: components['parameters']['issue-number'] + } + } responses: { /** Response */ - 204: never; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed"]; - }; + 204: never + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: * \* `off-topic` @@ -33785,379 +33751,379 @@ export interface operations { * \* `spam` * @enum {string} */ - lock_reason?: "off-topic" | "too heated" | "resolved" | "spam"; - } | null; - }; - }; - }; + lock_reason?: 'off-topic' | 'too heated' | 'resolved' | 'spam' + } | null + } + } + } /** Users with push access can unlock an issue's conversation. */ - "issues/unlock": { + 'issues/unlock': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; - }; + issue_number: components['parameters']['issue-number'] + } + } responses: { /** Response */ - 204: never; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** List the reactions to an [issue](https://docs.github.com/rest/reference/issues). */ - "reactions/list-for-issue": { + 'reactions/list-for-issue': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; + issue_number: components['parameters']['issue-number'] + } query: { /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content?: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["reaction"][]; - }; - }; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - }; - }; + 'application/json': components['schemas']['reaction'][] + } + } + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + } + } /** Create a reaction to an [issue](https://docs.github.com/rest/reference/issues/). A response with an HTTP `200` status means that you already added the reaction type to this issue. */ - "reactions/create-for-issue": { + 'reactions/create-for-issue': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; - }; + issue_number: components['parameters']['issue-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; + 'application/json': components['schemas']['reaction'] + } + } /** Response */ 201: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['reaction'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the issue. * @enum {string} */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - }; + content: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' + } + } + } + } /** * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. * * Delete a reaction to an [issue](https://docs.github.com/rest/reference/issues/). */ - "reactions/delete-for-issue": { + 'reactions/delete-for-issue': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - reaction_id: components["parameters"]["reaction-id"]; - }; - }; + issue_number: components['parameters']['issue-number'] + reaction_id: components['parameters']['reaction-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; - "issues/list-events-for-timeline": { + 204: never + } + } + 'issues/list-events-for-timeline': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** issue_number parameter */ - issue_number: components["parameters"]["issue-number"]; - }; + issue_number: components['parameters']['issue-number'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["timeline-issue-events"][]; - }; - }; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - }; - }; - "repos/list-deploy-keys": { + 'application/json': components['schemas']['timeline-issue-events'][] + } + } + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + } + } + 'repos/list-deploy-keys': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["deploy-key"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['deploy-key'][] + } + } + } + } /** You can create a read-only deploy key. */ - "repos/create-deploy-key": { + 'repos/create-deploy-key': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["deploy-key"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['deploy-key'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description A name for the key. */ - title?: string; + title?: string /** @description The contents of the key. */ - key: string; + key: string /** * @description If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. * * Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)" and "[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/)." */ - read_only?: boolean; - }; - }; - }; - }; - "repos/get-deploy-key": { + read_only?: boolean + } + } + } + } + 'repos/get-deploy-key': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** key_id parameter */ - key_id: components["parameters"]["key-id"]; - }; - }; + key_id: components['parameters']['key-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["deploy-key"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['deploy-key'] + } + } + 404: components['responses']['not_found'] + } + } /** Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead. */ - "repos/delete-deploy-key": { + 'repos/delete-deploy-key': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** key_id parameter */ - key_id: components["parameters"]["key-id"]; - }; - }; + key_id: components['parameters']['key-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; - "issues/list-labels-for-repo": { + 204: never + } + } + 'issues/list-labels-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["label"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "issues/create-label": { + 'application/json': components['schemas']['label'][] + } + } + 404: components['responses']['not_found'] + } + } + 'issues/create-label': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["label"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['label'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see "[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet)." */ - name: string; + name: string /** @description The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. */ - color?: string; + color?: string /** @description A short description of the label. Must be 100 characters or fewer. */ - description?: string; - }; - }; - }; - }; - "issues/get-label": { + description?: string + } + } + } + } + 'issues/get-label': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - name: string; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + name: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["label"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "issues/delete-label": { + 'application/json': components['schemas']['label'] + } + } + 404: components['responses']['not_found'] + } + } + 'issues/delete-label': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - name: string; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + name: string + } + } responses: { /** Response */ - 204: never; - }; - }; - "issues/update-label": { + 204: never + } + } + 'issues/update-label': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - name: string; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + name: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["label"]; - }; - }; - }; + 'application/json': components['schemas']['label'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see "[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet)." */ - new_name?: string; + new_name?: string /** @description The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. */ - color?: string; + color?: string /** @description A short description of the label. Must be 100 characters or fewer. */ - description?: string; - }; - }; - }; - }; + description?: string + } + } + } + } /** Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language. */ - "repos/list-languages": { + 'repos/list-languages': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["language"]; - }; - }; - }; - }; - "repos/enable-lfs-for-repo": { + 'application/json': components['schemas']['language'] + } + } + } + } + 'repos/enable-lfs-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { - 202: components["responses"]["accepted"]; + 202: components['responses']['accepted'] /** * We will return a 403 with one of the following messages: * @@ -34165,523 +34131,523 @@ export interface operations { * - Git LFS support not enabled because Git LFS is disabled for the root repository in the network. * - Git LFS support not enabled because Git LFS is disabled for . */ - 403: unknown; - }; - }; - "repos/disable-lfs-for-repo": { + 403: unknown + } + } + 'repos/disable-lfs-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * This method returns the contents of the repository's license file, if one is detected. * * Similar to [Get repository content](https://docs.github.com/rest/reference/repos#get-repository-content), this method also supports [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw license content or rendered license HTML. */ - "licenses/get-for-repo": { + 'licenses/get-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["license-content"]; - }; - }; - }; - }; + 'application/json': components['schemas']['license-content'] + } + } + } + } /** Sync a branch of a forked repository to keep it up-to-date with the upstream repository. */ - "repos/merge-upstream": { + 'repos/merge-upstream': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** The branch has been successfully synced with the upstream repository */ 200: { content: { - "application/json": components["schemas"]["merged-upstream"]; - }; - }; + 'application/json': components['schemas']['merged-upstream'] + } + } /** The branch could not be synced because of a merge conflict */ - 409: unknown; + 409: unknown /** The branch could not be synced for some other reason */ - 422: unknown; - }; + 422: unknown + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the branch which should be updated to match upstream. */ - branch: string; - }; - }; - }; - }; - "repos/merge": { + branch: string + } + } + } + } + 'repos/merge': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Successful Response (The resulting merge commit) */ 201: { content: { - "application/json": components["schemas"]["commit"]; - }; - }; + 'application/json': components['schemas']['commit'] + } + } /** Response when already merged */ - 204: never; - 403: components["responses"]["forbidden"]; + 204: never + 403: components['responses']['forbidden'] /** Not Found when the base or head does not exist */ - 404: unknown; + 404: unknown /** Conflict when there is a merge conflict */ - 409: unknown; - 422: components["responses"]["validation_failed"]; - }; + 409: unknown + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the base branch that the head will be merged into. */ - base: string; + base: string /** @description The head to merge. This can be a branch name or a commit SHA1. */ - head: string; + head: string /** @description Commit message to use for the merge commit. If omitted, a default message will be used. */ - commit_message?: string; - }; - }; - }; - }; - "issues/list-milestones": { + commit_message?: string + } + } + } + } + 'issues/list-milestones': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** The state of the milestone. Either `open`, `closed`, or `all`. */ - state?: "open" | "closed" | "all"; + state?: 'open' | 'closed' | 'all' /** What to sort results by. Either `due_on` or `completeness`. */ - sort?: "due_on" | "completeness"; + sort?: 'due_on' | 'completeness' /** The direction of the sort. Either `asc` or `desc`. */ - direction?: "asc" | "desc"; + direction?: 'asc' | 'desc' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["milestone"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "issues/create-milestone": { + 'application/json': components['schemas']['milestone'][] + } + } + 404: components['responses']['not_found'] + } + } + 'issues/create-milestone': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["milestone"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['milestone'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The title of the milestone. */ - title: string; + title: string /** * @description The state of the milestone. Either `open` or `closed`. * @default open * @enum {string} */ - state?: "open" | "closed"; + state?: 'open' | 'closed' /** @description A description of the milestone. */ - description?: string; + description?: string /** * Format: date-time * @description The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - due_on?: string; - }; - }; - }; - }; - "issues/get-milestone": { + due_on?: string + } + } + } + } + 'issues/get-milestone': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** milestone_number parameter */ - milestone_number: components["parameters"]["milestone-number"]; - }; - }; + milestone_number: components['parameters']['milestone-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["milestone"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "issues/delete-milestone": { + 'application/json': components['schemas']['milestone'] + } + } + 404: components['responses']['not_found'] + } + } + 'issues/delete-milestone': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** milestone_number parameter */ - milestone_number: components["parameters"]["milestone-number"]; - }; - }; + milestone_number: components['parameters']['milestone-number'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; - "issues/update-milestone": { + 204: never + 404: components['responses']['not_found'] + } + } + 'issues/update-milestone': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** milestone_number parameter */ - milestone_number: components["parameters"]["milestone-number"]; - }; - }; + milestone_number: components['parameters']['milestone-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["milestone"]; - }; - }; - }; + 'application/json': components['schemas']['milestone'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The title of the milestone. */ - title?: string; + title?: string /** * @description The state of the milestone. Either `open` or `closed`. * @default open * @enum {string} */ - state?: "open" | "closed"; + state?: 'open' | 'closed' /** @description A description of the milestone. */ - description?: string; + description?: string /** * Format: date-time * @description The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - due_on?: string; - }; - }; - }; - }; - "issues/list-labels-for-milestone": { + due_on?: string + } + } + } + } + 'issues/list-labels-for-milestone': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** milestone_number parameter */ - milestone_number: components["parameters"]["milestone-number"]; - }; + milestone_number: components['parameters']['milestone-number'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["label"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['label'][] + } + } + } + } /** List all notifications for the current user. */ - "activity/list-repo-notifications-for-authenticated-user": { + 'activity/list-repo-notifications-for-authenticated-user': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** If `true`, show notifications marked as read. */ - all?: components["parameters"]["all"]; + all?: components['parameters']['all'] /** If `true`, only shows notifications in which the user is directly participating or mentioned. */ - participating?: components["parameters"]["participating"]; + participating?: components['parameters']['participating'] /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - before?: components["parameters"]["before"]; + before?: components['parameters']['before'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["thread"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['thread'][] + } + } + } + } /** Marks all notifications in a repository as "read" removes them from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ - "activity/mark-repo-notifications-as-read": { + 'activity/mark-repo-notifications-as-read': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 202: { content: { - "application/json": { - message?: string; - url?: string; - }; - }; - }; + 'application/json': { + message?: string + url?: string + } + } + } /** Reset Content */ - 205: unknown; - }; + 205: unknown + } requestBody: { content: { - "application/json": { + 'application/json': { /** * Format: date-time * @description Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. */ - last_read_at?: string; - }; - }; - }; - }; - "repos/get-pages": { + last_read_at?: string + } + } + } + } + 'repos/get-pages': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["page"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['page'] + } + } + 404: components['responses']['not_found'] + } + } /** Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). */ - "repos/update-information-about-pages-site": { + 'repos/update-information-about-pages-site': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; - }; + 204: never + 400: components['responses']['bad_request'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/articles/using-a-custom-domain-with-github-pages/)." */ - cname?: string | null; + cname?: string | null /** @description Specify whether HTTPS should be enforced for the repository. */ - https_enforced?: boolean; + https_enforced?: boolean /** @description Configures access controls for the GitHub Pages site. If public is set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to `internal` visibility. This feature is only available to repositories in an organization on an Enterprise plan. */ - public?: boolean; - source?: Partial<"gh-pages" | "master" | "master /docs"> & + public?: boolean + source?: Partial<'gh-pages' | 'master' | 'master /docs'> & Partial<{ /** @description The repository branch used to publish your site's source files. */ - branch: string; + branch: string /** * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. * @enum {string} */ - path: "/" | "/docs"; - }>; - }; - }; - }; - }; + path: '/' | '/docs' + }> + } + } + } + } /** Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)." */ - "repos/create-pages-site": { + 'repos/create-pages-site': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["page"]; - }; - }; - 409: components["responses"]["conflict"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['page'] + } + } + 409: components['responses']['conflict'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The source branch and directory used to publish your Pages site. */ source: { /** @description The repository branch used to publish your site's source files. */ - branch: string; + branch: string /** * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/` * @default / * @enum {string} */ - path?: "/" | "/docs"; - }; - } | null; - }; - }; - }; - "repos/delete-pages-site": { + path?: '/' | '/docs' + } + } | null + } + } + } + 'repos/delete-pages-site': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "repos/list-pages-builds": { + 204: never + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } + 'repos/list-pages-builds': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["page-build"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['page-build'][] + } + } + } + } /** * You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures. * * Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes. */ - "repos/request-pages-build": { + 'repos/request-pages-build': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["page-build-status"]; - }; - }; - }; - }; - "repos/get-latest-pages-build": { + 'application/json': components['schemas']['page-build-status'] + } + } + } + } + 'repos/get-latest-pages-build': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["page-build"]; - }; - }; - }; - }; - "repos/get-pages-build": { + 'application/json': components['schemas']['page-build'] + } + } + } + } + 'repos/get-pages-build': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - build_id: number; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + build_id: number + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["page-build"]; - }; - }; - }; - }; + 'application/json': components['schemas']['page-build'] + } + } + } + } /** * Gets a health check of the DNS settings for the `CNAME` record configured for a repository's GitHub Pages. * @@ -34689,132 +34655,132 @@ export interface operations { * * Users must have admin or owner permissions. GitHub Apps must have the `pages:write` and `administration:write` permission to use this endpoint. */ - "repos/get-pages-health-check": { + 'repos/get-pages-health-check': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pages-health-check"]; - }; - }; + 'application/json': components['schemas']['pages-health-check'] + } + } /** Empty response */ 202: { content: { - "application/json": components["schemas"]["empty-object"]; - }; - }; + 'application/json': components['schemas']['empty-object'] + } + } /** Custom domains are not available for GitHub Pages */ - 400: unknown; - 404: components["responses"]["not_found"]; + 400: unknown + 404: components['responses']['not_found'] /** There isn't a CNAME for this page */ - 422: unknown; - }; - }; + 422: unknown + } + } /** Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - "projects/list-for-repo": { + 'projects/list-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. */ - state?: "open" | "closed" | "all"; + state?: 'open' | 'closed' | 'all' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["project"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed_simple"]; - }; - }; + 'application/json': components['schemas']['project'][] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + 422: components['responses']['validation_failed_simple'] + } + } /** Creates a repository project board. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ - "projects/create-for-repo": { + 'projects/create-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["project"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': components['schemas']['project'] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 410: components['responses']['gone'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the project. */ - name: string; + name: string /** @description The description of the project. */ - body?: string; - }; - }; - }; - }; + body?: string + } + } + } + } /** Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - "pulls/list": { + 'pulls/list': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Either `open`, `closed`, or `all` to filter by state. */ - state?: "open" | "closed" | "all"; + state?: 'open' | 'closed' | 'all' /** Filter pulls by head user or head organization and branch name in the format of `user:ref-name` or `organization:ref-name`. For example: `github:new-script-format` or `octocat:test-branch`. */ - head?: string; + head?: string /** Filter pulls by base branch name. Example: `gh-pages`. */ - base?: string; + base?: string /** What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month). */ - sort?: "created" | "updated" | "popularity" | "long-running"; + sort?: 'created' | 'updated' | 'popularity' | 'long-running' /** The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`. */ - direction?: "asc" | "desc"; + direction?: 'asc' | 'desc' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["pull-request-simple"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['pull-request-simple'][] + } + } + 304: components['responses']['not_modified'] + 422: components['responses']['validation_failed'] + } + } /** * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -34824,225 +34790,225 @@ export interface operations { * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. */ - "pulls/create": { + 'pulls/create': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["pull-request"]; - }; - }; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['pull-request'] + } + } + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The title of the new pull request. */ - title?: string; + title?: string /** @description The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`. */ - head: string; + head: string /** @description The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository. */ - base: string; + base: string /** @description The contents of the pull request. */ - body?: string; + body?: string /** @description Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. */ - maintainer_can_modify?: boolean; + maintainer_can_modify?: boolean /** @description Indicates whether the pull request is a draft. See "[Draft Pull Requests](https://docs.github.com/en/articles/about-pull-requests#draft-pull-requests)" in the GitHub Help documentation to learn more. */ - draft?: boolean; + draft?: boolean /** @example 1 */ - issue?: number; - }; - }; - }; - }; + issue?: number + } + } + } + } /** Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID. */ - "pulls/list-review-comments-for-repo": { + 'pulls/list-review-comments-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { - sort?: "created" | "updated" | "created_at"; + sort?: 'created' | 'updated' | 'created_at' /** Can be either `asc` or `desc`. Ignored without `sort` parameter. */ - direction?: "asc" | "desc"; + direction?: 'asc' | 'desc' /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["pull-request-review-comment"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['pull-request-review-comment'][] + } + } + } + } /** Provides details for a review comment. */ - "pulls/get-review-comment": { + 'pulls/get-review-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pull-request-review-comment"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['pull-request-review-comment'] + } + } + 404: components['responses']['not_found'] + } + } /** Deletes a review comment. */ - "pulls/delete-review-comment": { + 'pulls/delete-review-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + } + } /** Enables you to edit a review comment. */ - "pulls/update-review-comment": { + 'pulls/update-review-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pull-request-review-comment"]; - }; - }; - }; + 'application/json': components['schemas']['pull-request-review-comment'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The text of the reply to the review comment. */ - body: string; - }; - }; - }; - }; + body: string + } + } + } + } /** List the reactions to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). */ - "reactions/list-for-pull-request-review-comment": { + 'reactions/list-for-pull-request-review-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; + comment_id: components['parameters']['comment-id'] + } query: { /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a pull request review comment. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content?: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["reaction"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['reaction'][] + } + } + 404: components['responses']['not_found'] + } + } /** Create a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#comments). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. */ - "reactions/create-for-pull-request-review-comment": { + 'reactions/create-for-pull-request-review-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Reaction exists */ 200: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; + 'application/json': components['schemas']['reaction'] + } + } /** Reaction created */ 201: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['reaction'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the pull request review comment. * @enum {string} */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - }; + content: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' + } + } + } + } /** * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` * * Delete a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). */ - "reactions/delete-for-pull-request-comment": { + 'reactions/delete-for-pull-request-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - reaction_id: components["parameters"]["reaction-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + reaction_id: components['parameters']['reaction-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -35060,145 +35026,145 @@ export interface operations { * * Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. */ - "pulls/get": { + 'pulls/get': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } + } responses: { /** Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. */ 200: { content: { - "application/json": components["schemas"]["pull-request"]; - }; - }; - 304: components["responses"]["not_modified"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': components['schemas']['pull-request'] + } + } + 304: components['responses']['not_modified'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. */ - "pulls/update": { + 'pulls/update': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pull-request"]; - }; - }; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['pull-request'] + } + } + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The title of the pull request. */ - title?: string; + title?: string /** @description The contents of the pull request. */ - body?: string; + body?: string /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ - state?: "open" | "closed"; + state?: 'open' | 'closed' /** @description The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository. */ - base?: string; + base?: string /** @description Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. */ - maintainer_can_modify?: boolean; - }; - }; - }; - }; + maintainer_can_modify?: boolean + } + } + } + } /** * Creates a codespace owned by the authenticated user for the specified pull request. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/create-with-pr-for-authenticated-user": { + 'codespaces/create-with-pr-for-authenticated-user': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } + } responses: { /** Response when the codespace was successfully created */ 201: { content: { - "application/json": components["schemas"]["codespace"]; - }; - }; + 'application/json': components['schemas']['codespace'] + } + } /** Response when the codespace creation partially failed but is being retried in the background */ 202: { content: { - "application/json": components["schemas"]["codespace"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; + 'application/json': components['schemas']['codespace'] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Location for this codespace */ - location: string; + location: string /** @description Machine type to use for this codespace */ - machine?: string; + machine?: string /** @description Working directory for this codespace */ - working_directory?: string; + working_directory?: string /** @description Time in minutes before codespace stops from inactivity */ - idle_timeout_minutes?: number; - }; - }; - }; - }; + idle_timeout_minutes?: number + } + } + } + } /** Lists all review comments for a pull request. By default, review comments are in ascending order by ID. */ - "pulls/list-review-comments": { + 'pulls/list-review-comments': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } query: { /** One of `created` (when the repository was starred) or `updated` (when it was last pushed to). */ - sort?: components["parameters"]["sort"]; + sort?: components['parameters']['sort'] /** Can be either `asc` or `desc`. Ignored without `sort` parameter. */ - direction?: "asc" | "desc"; + direction?: 'asc' | 'desc' /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["pull-request-review-comment"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['pull-request-review-comment'][] + } + } + } + } /** * Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/reference/issues#create-an-issue-comment)." We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff. * @@ -35208,328 +35174,328 @@ export interface operations { * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - "pulls/create-review-comment": { + 'pulls/create-review-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["pull-request-review-comment"]; - }; - }; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['pull-request-review-comment'] + } + } + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The text of the review comment. */ - body: string; + body: string /** @description The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`. */ - commit_id?: string; + commit_id?: string /** @description The relative path to the file that necessitates a comment. */ - path?: string; + path?: string /** @description **Required without `comfort-fade` preview unless using `in_reply_to`**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above. */ - position?: number; + position?: number /** * @description **Required with `comfort-fade` preview unless using `in_reply_to`**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "[Diff view options](https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation. * @enum {string} */ - side?: "LEFT" | "RIGHT"; + side?: 'LEFT' | 'RIGHT' /** @description **Required with `comfort-fade` preview unless using `in_reply_to`**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to. */ - line?: number; + line?: number /** @description **Required when using multi-line comments unless using `in_reply_to`**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. */ - start_line?: number; + start_line?: number /** * @description **Required when using multi-line comments unless using `in_reply_to`**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context. * @enum {string} */ - start_side?: "LEFT" | "RIGHT" | "side"; + start_side?: 'LEFT' | 'RIGHT' | 'side' /** * @description The ID of the review comment to reply to. To find the ID of a review comment with ["List review comments on a pull request"](#list-review-comments-on-a-pull-request). When specified, all parameters other than `body` in the request body are ignored. * @example 2 */ - in_reply_to?: number; - }; - }; - }; - }; + in_reply_to?: number + } + } + } + } /** * Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - "pulls/create-reply-for-review-comment": { + 'pulls/create-reply-for-review-comment': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] /** comment_id parameter */ - comment_id: components["parameters"]["comment-id"]; - }; - }; + comment_id: components['parameters']['comment-id'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["pull-request-review-comment"]; - }; - }; - 404: components["responses"]["not_found"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['pull-request-review-comment'] + } + } + 404: components['responses']['not_found'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The text of the review comment. */ - body: string; - }; - }; - }; - }; + body: string + } + } + } + } /** Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/reference/repos#list-commits) endpoint. */ - "pulls/list-commits": { + 'pulls/list-commits': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["commit"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['commit'][] + } + } + } + } /** **Note:** Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. */ - "pulls/list-files": { + 'pulls/list-files': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["diff-entry"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - 500: components["responses"]["internal_error"]; - }; - }; - "pulls/check-if-merged": { + 'application/json': components['schemas']['diff-entry'][] + } + } + 422: components['responses']['validation_failed'] + 500: components['responses']['internal_error'] + } + } + 'pulls/check-if-merged': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } + } responses: { /** Response if pull request has been merged */ - 204: never; + 204: never /** Not Found if pull request has not been merged */ - 404: unknown; - }; - }; + 404: unknown + } + } /** This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - "pulls/merge": { + 'pulls/merge': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } + } responses: { /** if merge was successful */ 200: { content: { - "application/json": components["schemas"]["pull-request-merge-result"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; + 'application/json': components['schemas']['pull-request-merge-result'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] /** Method Not Allowed if merge cannot be performed */ 405: { content: { - "application/json": { - message?: string; - documentation_url?: string; - }; - }; - }; + 'application/json': { + message?: string + documentation_url?: string + } + } + } /** Conflict if sha was provided and pull request head did not match */ 409: { content: { - "application/json": { - message?: string; - documentation_url?: string; - }; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': { + message?: string + documentation_url?: string + } + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Title for the automatic commit message. */ - commit_title?: string; + commit_title?: string /** @description Extra detail to append to automatic commit message. */ - commit_message?: string; + commit_message?: string /** @description SHA that pull request head must match to allow merge. */ - sha?: string; + sha?: string /** * @description Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`. * @enum {string} */ - merge_method?: "merge" | "squash" | "rebase"; - } | null; - }; - }; - }; - "pulls/list-requested-reviewers": { - parameters: { - path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; + merge_method?: 'merge' | 'squash' | 'rebase' + } | null + } + } + } + 'pulls/list-requested-reviewers': { + parameters: { + path: { + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["pull-request-review-request"]; - }; - }; - }; - }; + 'application/json': components['schemas']['pull-request-review-request'] + } + } + } + } /** This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - "pulls/request-reviewers": { + 'pulls/request-reviewers': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["pull-request-simple"]; - }; - }; - 403: components["responses"]["forbidden"]; + 'application/json': components['schemas']['pull-request-simple'] + } + } + 403: components['responses']['forbidden'] /** Unprocessable Entity if user is not a collaborator */ - 422: unknown; - }; + 422: unknown + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description An array of user `login`s that will be requested. */ - reviewers?: string[]; + reviewers?: string[] /** @description An array of team `slug`s that will be requested. */ - team_reviewers?: string[]; - }; - }; - }; - }; - "pulls/remove-requested-reviewers": { + team_reviewers?: string[] + } + } + } + } + 'pulls/remove-requested-reviewers': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pull-request-simple"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['pull-request-simple'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description An array of user `login`s that will be removed. */ - reviewers: string[]; + reviewers: string[] /** @description An array of team `slug`s that will be removed. */ - team_reviewers?: string[]; - }; - }; - }; - }; + team_reviewers?: string[] + } + } + } + } /** The list of reviews returns in chronological order. */ - "pulls/list-reviews": { + 'pulls/list-reviews': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** The list of reviews returns in chronological order. */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["pull-request-review"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['pull-request-review'][] + } + } + } + } /** * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. * @@ -35539,636 +35505,636 @@ export interface operations { * * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. */ - "pulls/create-review": { + 'pulls/create-review': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pull-request-review"]; - }; - }; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': components['schemas']['pull-request-review'] + } + } + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value. */ - commit_id?: string; + commit_id?: string /** @description **Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review. */ - body?: string; + body?: string /** * @description The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/rest/reference/pulls#submit-a-review-for-a-pull-request) when you are ready. * @enum {string} */ - event?: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; + event?: 'APPROVE' | 'REQUEST_CHANGES' | 'COMMENT' /** @description Use the following table to specify the location, destination, and contents of the draft review comment. */ comments?: { /** @description The relative path to the file that necessitates a review comment. */ - path: string; + path: string /** @description The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below. */ - position?: number; + position?: number /** @description Text of the review comment. */ - body: string; + body: string /** @example 28 */ - line?: number; + line?: number /** @example RIGHT */ - side?: string; + side?: string /** @example 26 */ - start_line?: number; + start_line?: number /** @example LEFT */ - start_side?: string; - }[]; - }; - }; - }; - }; - "pulls/get-review": { - parameters: { - path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; + start_side?: string + }[] + } + } + } + } + 'pulls/get-review': { + parameters: { + path: { + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] /** review_id parameter */ - review_id: components["parameters"]["review-id"]; - }; - }; + review_id: components['parameters']['review-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pull-request-review"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['pull-request-review'] + } + } + 404: components['responses']['not_found'] + } + } /** Update the review summary comment with new text. */ - "pulls/update-review": { + 'pulls/update-review': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] /** review_id parameter */ - review_id: components["parameters"]["review-id"]; - }; - }; + review_id: components['parameters']['review-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pull-request-review"]; - }; - }; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': components['schemas']['pull-request-review'] + } + } + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The body text of the pull request review. */ - body: string; - }; - }; - }; - }; - "pulls/delete-pending-review": { + body: string + } + } + } + } + 'pulls/delete-pending-review': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] /** review_id parameter */ - review_id: components["parameters"]["review-id"]; - }; - }; + review_id: components['parameters']['review-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pull-request-review"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; - }; + 'application/json': components['schemas']['pull-request-review'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } + } /** List comments for a specific pull request review. */ - "pulls/list-comments-for-review": { + 'pulls/list-comments-for-review': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] /** review_id parameter */ - review_id: components["parameters"]["review-id"]; - }; + review_id: components['parameters']['review-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["review-comment"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['review-comment'][] + } + } + 404: components['responses']['not_found'] + } + } /** **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/reference/repos#branches), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. */ - "pulls/dismiss-review": { + 'pulls/dismiss-review': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] /** review_id parameter */ - review_id: components["parameters"]["review-id"]; - }; - }; + review_id: components['parameters']['review-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pull-request-review"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': components['schemas']['pull-request-review'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The message for the pull request review dismissal */ - message: string; + message: string /** @example "APPROVE" */ - event?: string; - }; - }; - }; - }; - "pulls/submit-review": { + event?: string + } + } + } + } + 'pulls/submit-review': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] /** review_id parameter */ - review_id: components["parameters"]["review-id"]; - }; - }; + review_id: components['parameters']['review-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["pull-request-review"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': components['schemas']['pull-request-review'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The body text of the pull request review */ - body?: string; + body?: string /** * @description The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When you leave this blank, the API returns _HTTP 422 (Unrecognizable entity)_ and sets the review action state to `PENDING`, which means you will need to re-submit the pull request review using a review action. * @enum {string} */ - event: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; - }; - }; - }; - }; + event: 'APPROVE' | 'REQUEST_CHANGES' | 'COMMENT' + } + } + } + } /** Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. */ - "pulls/update-branch": { + 'pulls/update-branch': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - pull_number: components["parameters"]["pull-number"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + pull_number: components['parameters']['pull-number'] + } + } responses: { /** Response */ 202: { content: { - "application/json": { - message?: string; - url?: string; - }; - }; - }; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': { + message?: string + url?: string + } + } + } + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the "[List commits](https://docs.github.com/rest/reference/repos#list-commits)" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref. */ - expected_head_sha?: string; - } | null; - }; - }; - }; + expected_head_sha?: string + } | null + } + } + } /** * Gets the preferred README for a repository. * * READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. */ - "repos/get-readme": { + 'repos/get-readme': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`) */ - ref?: string; - }; - }; + ref?: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["content-file"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['content-file'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** * Gets the README from a repository directory. * * READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. */ - "repos/get-readme-in-directory": { + 'repos/get-readme-in-directory': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The alternate path to look for a README file */ - dir: string; - }; + dir: string + } query: { /** The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`) */ - ref?: string; - }; - }; + ref?: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["content-file"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['content-file'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** * This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/rest/reference/repos#list-repository-tags). * * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. */ - "repos/list-releases": { + 'repos/list-releases': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["release"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['release'][] + } + } + 404: components['responses']['not_found'] + } + } /** * Users with push access to the repository can create a release. * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - "repos/create-release": { + 'repos/create-release': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; + Location?: string + } content: { - "application/json": components["schemas"]["release"]; - }; - }; + 'application/json': components['schemas']['release'] + } + } /** Not Found if the discussion category name is invalid */ 404: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['basic-error'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the tag. */ - tag_name: string; + tag_name: string /** @description Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`). */ - target_commitish?: string; + target_commitish?: string /** @description The name of the release. */ - name?: string; + name?: string /** @description Text describing the contents of the tag. */ - body?: string; + body?: string /** @description `true` to create a draft (unpublished) release, `false` to create a published one. */ - draft?: boolean; + draft?: boolean /** @description `true` to identify the release as a prerelease. `false` to identify the release as a full release. */ - prerelease?: boolean; + prerelease?: boolean /** @description If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see "[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." */ - discussion_category_name?: string; + discussion_category_name?: string /** @description Whether to automatically generate the name and body for this release. If `name` is specified, the specified name will be used; otherwise, a name will be automatically generated. If `body` is specified, the body will be pre-pended to the automatically generated notes. */ - generate_release_notes?: boolean; - }; - }; - }; - }; + generate_release_notes?: boolean + } + } + } + } /** To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. */ - "repos/get-release-asset": { + 'repos/get-release-asset': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** asset_id parameter */ - asset_id: components["parameters"]["asset-id"]; - }; - }; + asset_id: components['parameters']['asset-id'] + } + } responses: { /** To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. */ 200: { content: { - "application/json": components["schemas"]["release-asset"]; - }; - }; - 302: components["responses"]["found"]; - 404: components["responses"]["not_found"]; - 415: components["responses"]["preview_header_missing"]; - }; - }; - "repos/delete-release-asset": { + 'application/json': components['schemas']['release-asset'] + } + } + 302: components['responses']['found'] + 404: components['responses']['not_found'] + 415: components['responses']['preview_header_missing'] + } + } + 'repos/delete-release-asset': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** asset_id parameter */ - asset_id: components["parameters"]["asset-id"]; - }; - }; + asset_id: components['parameters']['asset-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** Users with push access to the repository can edit a release asset. */ - "repos/update-release-asset": { + 'repos/update-release-asset': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** asset_id parameter */ - asset_id: components["parameters"]["asset-id"]; - }; - }; + asset_id: components['parameters']['asset-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["release-asset"]; - }; - }; - }; + 'application/json': components['schemas']['release-asset'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The file name of the asset. */ - name?: string; + name?: string /** @description An alternate short description of the asset. Used in place of the filename. */ - label?: string; + label?: string /** @example "uploaded" */ - state?: string; - }; - }; - }; - }; + state?: string + } + } + } + } /** Generate a name and body describing a [release](https://docs.github.com/rest/reference/repos#releases). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. */ - "repos/generate-release-notes": { + 'repos/generate-release-notes': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Name and body of generated release notes */ 200: { content: { - "application/json": components["schemas"]["release-notes-content"]; - }; - }; - 404: components["responses"]["not_found"]; - }; + 'application/json': components['schemas']['release-notes-content'] + } + } + 404: components['responses']['not_found'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The tag name for the release. This can be an existing tag or a new one. */ - tag_name: string; + tag_name: string /** @description Specifies the commitish value that will be the target for the release's tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists. */ - target_commitish?: string; + target_commitish?: string /** @description The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release. */ - previous_tag_name?: string; + previous_tag_name?: string /** @description Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used. */ - configuration_file_path?: string; - }; - }; - }; - }; + configuration_file_path?: string + } + } + } + } /** * View the latest published full release for the repository. * * The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published. */ - "repos/get-latest-release": { + 'repos/get-latest-release': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["release"]; - }; - }; - }; - }; + 'application/json': components['schemas']['release'] + } + } + } + } /** Get a published release with the specified tag. */ - "repos/get-release-by-tag": { + 'repos/get-release-by-tag': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** tag parameter */ - tag: string; - }; - }; + tag: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["release"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['release'] + } + } + 404: components['responses']['not_found'] + } + } /** **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia). */ - "repos/get-release": { + 'repos/get-release': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** release_id parameter */ - release_id: components["parameters"]["release-id"]; - }; - }; + release_id: components['parameters']['release-id'] + } + } responses: { /** **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia). */ 200: { content: { - "application/json": components["schemas"]["release"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['release'] + } + } + 404: components['responses']['not_found'] + } + } /** Users with push access to the repository can delete a release. */ - "repos/delete-release": { + 'repos/delete-release': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** release_id parameter */ - release_id: components["parameters"]["release-id"]; - }; - }; + release_id: components['parameters']['release-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** Users with push access to the repository can edit a release. */ - "repos/update-release": { + 'repos/update-release': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** release_id parameter */ - release_id: components["parameters"]["release-id"]; - }; - }; + release_id: components['parameters']['release-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["release"]; - }; - }; + 'application/json': components['schemas']['release'] + } + } /** Not Found if the discussion category name is invalid */ 404: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the tag. */ - tag_name?: string; + tag_name?: string /** @description Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`). */ - target_commitish?: string; + target_commitish?: string /** @description The name of the release. */ - name?: string; + name?: string /** @description Text describing the contents of the tag. */ - body?: string; + body?: string /** @description `true` makes the release a draft, and `false` publishes the release. */ - draft?: boolean; + draft?: boolean /** @description `true` to identify the release as a prerelease, `false` to identify the release as a full release. */ - prerelease?: boolean; + prerelease?: boolean /** @description If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. If there is already a discussion linked to the release, this parameter is ignored. For more information, see "[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." */ - discussion_category_name?: string; - }; - }; - }; - }; - "repos/list-release-assets": { + discussion_category_name?: string + } + } + } + } + 'repos/list-release-assets': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** release_id parameter */ - release_id: components["parameters"]["release-id"]; - }; + release_id: components['parameters']['release-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["release-asset"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['release-asset'][] + } + } + } + } /** * This endpoint makes use of [a Hypermedia relation](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in * the response of the [Create a release endpoint](https://docs.github.com/rest/reference/repos#create-a-release) to upload a release asset. @@ -36189,276 +36155,275 @@ export interface operations { * endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). * * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. */ - "repos/upload-release-asset": { + 'repos/upload-release-asset': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** release_id parameter */ - release_id: components["parameters"]["release-id"]; - }; + release_id: components['parameters']['release-id'] + } query: { - name: string; - label?: string; - }; - }; + name: string + label?: string + } + } responses: { /** Response for successful upload */ 201: { content: { - "application/json": components["schemas"]["release-asset"]; - }; - }; + 'application/json': components['schemas']['release-asset'] + } + } /** Response if you upload an asset with the same filename as another uploaded asset */ - 422: unknown; - }; + 422: unknown + } requestBody: { content: { - "*/*": string; - }; - }; - }; + '*/*': string + } + } + } /** Create a reaction to a [release](https://docs.github.com/rest/reference/repos#releases). A response with a `Status: 200 OK` means that you already added the reaction type to this release. */ - "reactions/create-for-release": { + 'reactions/create-for-release': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** release_id parameter */ - release_id: components["parameters"]["release-id"]; - }; - }; + release_id: components['parameters']['release-id'] + } + } responses: { /** Reaction exists */ 200: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; + 'application/json': components['schemas']['reaction'] + } + } /** Reaction created */ 201: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['reaction'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the release. * @enum {string} */ - content: "+1" | "laugh" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - }; + content: '+1' | 'laugh' | 'heart' | 'hooray' | 'rocket' | 'eyes' + } + } + } + } /** * Lists secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. */ - "secret-scanning/list-alerts-for-repo": { + 'secret-scanning/list-alerts-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - state?: components["parameters"]["secret-scanning-alert-state"]; + state?: components['parameters']['secret-scanning-alert-state'] /** * A comma-separated list of secret types to return. By default all secret types are returned. * See "[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)" * for a complete list of secret types (API slug). */ - secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; + secret_type?: components['parameters']['secret-scanning-alert-secret-type'] /** A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - resolution?: components["parameters"]["secret-scanning-alert-resolution"]; + resolution?: components['parameters']['secret-scanning-alert-resolution'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["secret-scanning-alert"][]; - }; - }; + 'application/json': components['schemas']['secret-scanning-alert'][] + } + } /** Repository is public or secret scanning is disabled for the repository */ - 404: unknown; - 503: components["responses"]["service_unavailable"]; - }; - }; + 404: unknown + 503: components['responses']['service_unavailable'] + } + } /** * Gets a single secret scanning alert detected in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. */ - "secret-scanning/get-alert": { + 'secret-scanning/get-alert': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ - alert_number: components["parameters"]["alert-number"]; - }; - }; + alert_number: components['parameters']['alert-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["secret-scanning-alert"]; - }; - }; - 304: components["responses"]["not_modified"]; + 'application/json': components['schemas']['secret-scanning-alert'] + } + } + 304: components['responses']['not_modified'] /** Repository is public, or secret scanning is disabled for the repository, or the resource is not found */ - 404: unknown; - 503: components["responses"]["service_unavailable"]; - }; - }; + 404: unknown + 503: components['responses']['service_unavailable'] + } + } /** * Updates the status of a secret scanning alert in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint. */ - "secret-scanning/update-alert": { + 'secret-scanning/update-alert': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ - alert_number: components["parameters"]["alert-number"]; - }; - }; + alert_number: components['parameters']['alert-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["secret-scanning-alert"]; - }; - }; + 'application/json': components['schemas']['secret-scanning-alert'] + } + } /** Repository is public, or secret scanning is disabled for the repository, or the resource is not found */ - 404: unknown; + 404: unknown /** State does not match the resolution */ - 422: unknown; - 503: components["responses"]["service_unavailable"]; - }; + 422: unknown + 503: components['responses']['service_unavailable'] + } requestBody: { content: { - "application/json": { - state: components["schemas"]["secret-scanning-alert-state"]; - resolution?: components["schemas"]["secret-scanning-alert-resolution"]; - }; - }; - }; - }; + 'application/json': { + state: components['schemas']['secret-scanning-alert-state'] + resolution?: components['schemas']['secret-scanning-alert-resolution'] + } + } + } + } /** * Lists all locations for a given secret scanning alert for a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. * * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. */ - "secret-scanning/list-locations-for-alert": { + 'secret-scanning/list-locations-for-alert': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] /** The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ - alert_number: components["parameters"]["alert-number"]; - }; + alert_number: components['parameters']['alert-number'] + } query: { /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["secret-scanning-location"][]; - }; - }; + 'application/json': components['schemas']['secret-scanning-location'][] + } + } /** Repository is public, or secret scanning is disabled for the repository, or the resource is not found */ - 404: unknown; - 503: components["responses"]["service_unavailable"]; - }; - }; + 404: unknown + 503: components['responses']['service_unavailable'] + } + } /** * Lists the people that have starred the repository. * * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: */ - "activity/list-stargazers-for-repo": { + 'activity/list-stargazers-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": Partial & - Partial; - }; - }; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': Partial & Partial + } + } + 422: components['responses']['validation_failed'] + } + } /** Returns a weekly aggregate of the number of additions and deletions pushed to a repository. */ - "repos/get-code-frequency-stats": { + 'repos/get-code-frequency-stats': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Returns a weekly aggregate of the number of additions and deletions pushed to a repository. */ 200: { content: { - "application/json": components["schemas"]["code-frequency-stat"][]; - }; - }; - 202: components["responses"]["accepted"]; - 204: components["responses"]["no_content"]; - }; - }; + 'application/json': components['schemas']['code-frequency-stat'][] + } + } + 202: components['responses']['accepted'] + 204: components['responses']['no_content'] + } + } /** Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`. */ - "repos/get-commit-activity-stats": { + 'repos/get-commit-activity-stats': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["commit-activity"][]; - }; - }; - 202: components["responses"]["accepted"]; - 204: components["responses"]["no_content"]; - }; - }; + 'application/json': components['schemas']['commit-activity'][] + } + } + 202: components['responses']['accepted'] + 204: components['responses']['no_content'] + } + } /** * Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information: * @@ -36467,13 +36432,13 @@ export interface operations { * * `d` - Number of deletions * * `c` - Number of commits */ - "repos/get-contributors-stats": { + 'repos/get-contributors-stats': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** * * `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time). @@ -36483,35 +36448,35 @@ export interface operations { */ 200: { content: { - "application/json": components["schemas"]["contributor-activity"][]; - }; - }; - 202: components["responses"]["accepted"]; - 204: components["responses"]["no_content"]; - }; - }; + 'application/json': components['schemas']['contributor-activity'][] + } + } + 202: components['responses']['accepted'] + 204: components['responses']['no_content'] + } + } /** * Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`. * * The array order is oldest week (index 0) to most recent week. */ - "repos/get-participation-stats": { + 'repos/get-participation-stats': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** The array order is oldest week (index 0) to most recent week. */ 200: { content: { - "application/json": components["schemas"]["participation-stats"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['participation-stats'] + } + } + 404: components['responses']['not_found'] + } + } /** * Each array contains the day number, hour number, and number of commits: * @@ -36521,436 +36486,436 @@ export interface operations { * * For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. */ - "repos/get-punch-card-stats": { + 'repos/get-punch-card-stats': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. */ 200: { content: { - "application/json": components["schemas"]["code-frequency-stat"][]; - }; - }; - 204: components["responses"]["no_content"]; - }; - }; + 'application/json': components['schemas']['code-frequency-stat'][] + } + } + 204: components['responses']['no_content'] + } + } /** * Users with push access in a repository can create commit statuses for a given SHA. * * Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error. */ - "repos/create-commit-status": { + 'repos/create-commit-status': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - sha: string; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + sha: string + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; + Location?: string + } content: { - "application/json": components["schemas"]["status"]; - }; - }; - }; + 'application/json': components['schemas']['status'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The state of the status. Can be one of `error`, `failure`, `pending`, or `success`. * @enum {string} */ - state: "error" | "failure" | "pending" | "success"; + state: 'error' | 'failure' | 'pending' | 'success' /** * @description The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. * For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: * `http://ci.example.com/user/repo/build/sha` */ - target_url?: string; + target_url?: string /** @description A short description of the status. */ - description?: string; + description?: string /** * @description A string label to differentiate this status from the status of other systems. This field is case-insensitive. * @default default */ - context?: string; - }; - }; - }; - }; + context?: string + } + } + } + } /** Lists the people watching the specified repository. */ - "activity/list-watchers-for-repo": { + 'activity/list-watchers-for-repo': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - }; - }; - "activity/get-repo-subscription": { + 'application/json': components['schemas']['simple-user'][] + } + } + } + } + 'activity/get-repo-subscription': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** if you subscribe to the repository */ 200: { content: { - "application/json": components["schemas"]["repository-subscription"]; - }; - }; - 403: components["responses"]["forbidden"]; + 'application/json': components['schemas']['repository-subscription'] + } + } + 403: components['responses']['forbidden'] /** Not Found if you don't subscribe to the repository */ - 404: unknown; - }; - }; + 404: unknown + } + } /** If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/rest/reference/activity#delete-a-repository-subscription) completely. */ - "activity/set-repo-subscription": { + 'activity/set-repo-subscription': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["repository-subscription"]; - }; - }; - }; + 'application/json': components['schemas']['repository-subscription'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Determines if notifications should be received from this repository. */ - subscribed?: boolean; + subscribed?: boolean /** @description Determines if all notifications should be blocked from this repository. */ - ignored?: boolean; - }; - }; - }; - }; + ignored?: boolean + } + } + } + } /** This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/rest/reference/activity#set-a-repository-subscription). */ - "activity/delete-repo-subscription": { + 'activity/delete-repo-subscription': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; - }; - "repos/list-tags": { + 204: never + } + } + 'repos/list-tags': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["tag"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['tag'][] + } + } + } + } /** * Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually * `master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. * **Note**: For private repositories, these links are temporary and expire after five minutes. */ - "repos/download-tarball-archive": { + 'repos/download-tarball-archive': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - ref: string; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + ref: string + } + } responses: { /** Response */ - 302: never; - }; - }; - "repos/list-teams": { + 302: never + } + } + 'repos/list-teams': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team"][]; - }; - }; - }; - }; - "repos/get-all-topics": { + 'application/json': components['schemas']['team'][] + } + } + } + } + 'repos/get-all-topics': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["topic"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "repos/replace-all-topics": { + 'application/json': components['schemas']['topic'] + } + } + 404: components['responses']['not_found'] + } + } + 'repos/replace-all-topics': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["topic"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': components['schemas']['topic'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters. */ - names: string[]; - }; - }; - }; - }; + names: string[] + } + } + } + } /** Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. */ - "repos/get-clones": { + 'repos/get-clones': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Must be one of: `day`, `week`. */ - per?: components["parameters"]["per"]; - }; - }; + per?: components['parameters']['per'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["clone-traffic"]; - }; - }; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['clone-traffic'] + } + } + 403: components['responses']['forbidden'] + } + } /** Get the top 10 popular contents over the last 14 days. */ - "repos/get-top-paths": { + 'repos/get-top-paths': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["content-traffic"][]; - }; - }; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['content-traffic'][] + } + } + 403: components['responses']['forbidden'] + } + } /** Get the top 10 referrers over the last 14 days. */ - "repos/get-top-referrers": { + 'repos/get-top-referrers': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["referrer-traffic"][]; - }; - }; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['referrer-traffic'][] + } + } + 403: components['responses']['forbidden'] + } + } /** Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. */ - "repos/get-views": { + 'repos/get-views': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } query: { /** Must be one of: `day`, `week`. */ - per?: components["parameters"]["per"]; - }; - }; + per?: components['parameters']['per'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["view-traffic"]; - }; - }; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['view-traffic'] + } + } + 403: components['responses']['forbidden'] + } + } /** A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/). */ - "repos/transfer": { + 'repos/transfer': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ 202: { content: { - "application/json": components["schemas"]["minimal-repository"]; - }; - }; - }; + 'application/json': components['schemas']['minimal-repository'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The username or organization name the repository will be transferred to. */ - new_owner: string; + new_owner: string /** @description ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories. */ - team_ids?: number[]; - }; - }; - }; - }; + team_ids?: number[] + } + } + } + } /** Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". */ - "repos/check-vulnerability-alerts": { + 'repos/check-vulnerability-alerts': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response if repository is enabled with vulnerability alerts */ - 204: never; + 204: never /** Not Found if repository is not enabled with vulnerability alerts */ - 404: unknown; - }; - }; + 404: unknown + } + } /** Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". */ - "repos/enable-vulnerability-alerts": { + 'repos/enable-vulnerability-alerts': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". */ - "repos/disable-vulnerability-alerts": { + 'repos/disable-vulnerability-alerts': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually * `master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. * **Note**: For private repositories, these links are temporary and expire after five minutes. */ - "repos/download-zipball-archive": { + 'repos/download-zipball-archive': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - ref: string; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + ref: string + } + } responses: { /** Response */ - 302: never; - }; - }; + 302: never + } + } /** * Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. * @@ -36961,41 +36926,41 @@ export interface operations { * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. * * `repo` scope to create a private repository */ - "repos/create-using-template": { + 'repos/create-using-template': { parameters: { path: { - template_owner: string; - template_repo: string; - }; - }; + template_owner: string + template_repo: string + } + } responses: { /** Response */ 201: { headers: { - Location?: string; - }; + Location?: string + } content: { - "application/json": components["schemas"]["repository"]; - }; - }; - }; + 'application/json': components['schemas']['repository'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization. */ - owner?: string; + owner?: string /** @description The name of the new repository. */ - name: string; + name: string /** @description A short description of the new repository. */ - description?: string; + description?: string /** @description Set to `true` to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: `false`. */ - include_all_branches?: boolean; + include_all_branches?: boolean /** @description Either `true` to create a new private repository or `false` to create a new public one. */ - private?: boolean; - }; - }; - }; - }; + private?: boolean + } + } + } + } /** * Lists all public repositories in the order that they were created. * @@ -37003,93 +36968,93 @@ export interface operations { * - For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories. */ - "repos/list-public": { + 'repos/list-public': { parameters: { query: { /** A repository ID. Only return repositories with an ID greater than this ID. */ - since?: components["parameters"]["since-repo"]; - }; - }; + since?: components['parameters']['since-repo'] + } + } responses: { /** Response */ 200: { headers: { - Link?: string; - }; - content: { - "application/json": components["schemas"]["minimal-repository"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 422: components["responses"]["validation_failed"]; - }; - }; + Link?: string + } + content: { + 'application/json': components['schemas']['minimal-repository'][] + } + } + 304: components['responses']['not_modified'] + 422: components['responses']['validation_failed'] + } + } /** Lists all secrets available in an environment without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - "actions/list-environment-secrets": { + 'actions/list-environment-secrets': { parameters: { path: { - repository_id: components["parameters"]["repository-id"]; + repository_id: components['parameters']['repository-id'] /** The name of the environment */ - environment_name: components["parameters"]["environment-name"]; - }; + environment_name: components['parameters']['environment-name'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - secrets: components["schemas"]["actions-secret"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + secrets: components['schemas']['actions-secret'][] + } + } + } + } + } /** Get the public key for an environment, which you need to encrypt environment secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - "actions/get-environment-public-key": { + 'actions/get-environment-public-key': { parameters: { path: { - repository_id: components["parameters"]["repository-id"]; + repository_id: components['parameters']['repository-id'] /** The name of the environment */ - environment_name: components["parameters"]["environment-name"]; - }; - }; + environment_name: components['parameters']['environment-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-public-key"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-public-key'] + } + } + } + } /** Gets a single environment secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - "actions/get-environment-secret": { + 'actions/get-environment-secret': { parameters: { path: { - repository_id: components["parameters"]["repository-id"]; + repository_id: components['parameters']['repository-id'] /** The name of the environment */ - environment_name: components["parameters"]["environment-name"]; + environment_name: components['parameters']['environment-name'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-secret"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-secret'] + } + } + } + } /** * Creates or updates an environment secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access @@ -37167,229 +37132,229 @@ export interface operations { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - "actions/create-or-update-environment-secret": { + 'actions/create-or-update-environment-secret': { parameters: { path: { - repository_id: components["parameters"]["repository-id"]; + repository_id: components['parameters']['repository-id'] /** The name of the environment */ - environment_name: components["parameters"]["environment-name"]; + environment_name: components['parameters']['environment-name'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response when creating a secret */ 201: { content: { - "application/json": components["schemas"]["empty-object"]; - }; - }; + 'application/json': components['schemas']['empty-object'] + } + } /** Response when updating a secret */ - 204: never; - }; + 204: never + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/reference/actions#get-an-environment-public-key) endpoint. */ - encrypted_value: string; + encrypted_value: string /** @description ID of the key you used to encrypt the secret. */ - key_id: string; - }; - }; - }; - }; + key_id: string + } + } + } + } /** Deletes a secret in an environment using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */ - "actions/delete-environment-secret": { + 'actions/delete-environment-secret': { parameters: { path: { - repository_id: components["parameters"]["repository-id"]; + repository_id: components['parameters']['repository-id'] /** The name of the environment */ - environment_name: components["parameters"]["environment-name"]; + environment_name: components['parameters']['environment-name'] /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Default response */ - 204: never; - }; - }; + 204: never + } + } /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - "enterprise-admin/list-provisioned-groups-enterprise": { + 'enterprise-admin/list-provisioned-groups-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; + enterprise: components['parameters']['enterprise'] + } query: { /** Used for pagination: the index of the first result to return. */ - startIndex?: components["parameters"]["start-index"]; + startIndex?: components['parameters']['start-index'] /** Used for pagination: the number of results to return. */ - count?: components["parameters"]["count"]; + count?: components['parameters']['count'] /** filter results */ - filter?: string; + filter?: string /** attributes to exclude */ - excludedAttributes?: string; - }; - }; + excludedAttributes?: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["scim-group-list-enterprise"]; - }; - }; - }; - }; + 'application/json': components['schemas']['scim-group-list-enterprise'] + } + } + } + } /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * * Provision an enterprise group, and invite users to the group. This sends invitation emails to the email address of the invited users to join the GitHub organization that the SCIM group corresponds to. */ - "enterprise-admin/provision-and-invite-enterprise-group": { + 'enterprise-admin/provision-and-invite-enterprise-group': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["scim-enterprise-group"]; - }; - }; - }; + 'application/json': components['schemas']['scim-enterprise-group'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The SCIM schema URIs. */ - schemas: string[]; + schemas: string[] /** @description The name of the SCIM group. This must match the GitHub organization that the group maps to. */ - displayName: string; + displayName: string members?: { /** @description The SCIM user ID for a user. */ - value: string; - }[]; - }; - }; - }; - }; + value: string + }[] + } + } + } + } /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - "enterprise-admin/get-provisioning-information-for-enterprise-group": { + 'enterprise-admin/get-provisioning-information-for-enterprise-group': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Identifier generated by the GitHub SCIM endpoint. */ - scim_group_id: components["parameters"]["scim-group-id"]; - }; + scim_group_id: components['parameters']['scim-group-id'] + } query: { /** Attributes to exclude. */ - excludedAttributes?: string; - }; - }; + excludedAttributes?: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["scim-enterprise-group"]; - }; - }; - }; - }; + 'application/json': components['schemas']['scim-enterprise-group'] + } + } + } + } /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * * Replaces an existing provisioned group’s information. You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead. */ - "enterprise-admin/set-information-for-provisioned-enterprise-group": { + 'enterprise-admin/set-information-for-provisioned-enterprise-group': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Identifier generated by the GitHub SCIM endpoint. */ - scim_group_id: components["parameters"]["scim-group-id"]; - }; - }; + scim_group_id: components['parameters']['scim-group-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["scim-enterprise-group"]; - }; - }; - }; + 'application/json': components['schemas']['scim-enterprise-group'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The SCIM schema URIs. */ - schemas: string[]; + schemas: string[] /** @description The name of the SCIM group. This must match the GitHub organization that the group maps to. */ - displayName: string; + displayName: string members?: { /** @description The SCIM user ID for a user. */ - value: string; - }[]; - }; - }; - }; - }; + value: string + }[] + } + } + } + } /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - "enterprise-admin/delete-scim-group-from-enterprise": { + 'enterprise-admin/delete-scim-group-from-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Identifier generated by the GitHub SCIM endpoint. */ - scim_group_id: components["parameters"]["scim-group-id"]; - }; - }; + scim_group_id: components['parameters']['scim-group-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * * Allows you to change a provisioned group’s individual attributes. To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). */ - "enterprise-admin/update-attribute-for-enterprise-group": { + 'enterprise-admin/update-attribute-for-enterprise-group': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** Identifier generated by the GitHub SCIM endpoint. */ - scim_group_id: components["parameters"]["scim-group-id"]; - }; - }; + scim_group_id: components['parameters']['scim-group-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["scim-enterprise-group"]; - }; - }; - }; + 'application/json': components['schemas']['scim-enterprise-group'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The SCIM schema URIs. */ - schemas: string[]; + schemas: string[] /** @description Array of [SCIM operations](https://tools.ietf.org/html/rfc7644#section-3.5.2). */ Operations: { /** @enum {string} */ - op: "add" | "Add" | "remove" | "Remove" | "replace" | "Replace"; - path?: string; + op: 'add' | 'Add' | 'remove' | 'Remove' | 'replace' | 'Replace' + path?: string /** @description Can be any value - string, number, array or object. */ - value?: unknown; - }[]; - }; - }; - }; - }; + value?: unknown + }[] + } + } + } + } /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * @@ -37410,30 +37375,30 @@ export interface operations { * - If the user signs in, their GitHub account is linked to this entry. * - If the user does not sign in (or does not create a new account when prompted), they are not added to the GitHub enterprise, and the external identity `null` entry remains in place. */ - "enterprise-admin/list-provisioned-identities-enterprise": { + 'enterprise-admin/list-provisioned-identities-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; + enterprise: components['parameters']['enterprise'] + } query: { /** Used for pagination: the index of the first result to return. */ - startIndex?: components["parameters"]["start-index"]; + startIndex?: components['parameters']['start-index'] /** Used for pagination: the number of results to return. */ - count?: components["parameters"]["count"]; + count?: components['parameters']['count'] /** filter results */ - filter?: string; - }; - }; + filter?: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["scim-user-list-enterprise"]; - }; - }; - }; - }; + 'application/json': components['schemas']['scim-user-list-enterprise'] + } + } + } + } /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * @@ -37441,70 +37406,70 @@ export interface operations { * * You can optionally include the groups a user will be invited to join. If you do not provide a list of `groups`, the user is provisioned for the enterprise, but no organization invitation emails will be sent. */ - "enterprise-admin/provision-and-invite-enterprise-user": { + 'enterprise-admin/provision-and-invite-enterprise-user': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - }; - }; + enterprise: components['parameters']['enterprise'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["scim-enterprise-user"]; - }; - }; - }; + 'application/json': components['schemas']['scim-enterprise-user'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The SCIM schema URIs. */ - schemas: string[]; + schemas: string[] /** @description The username for the user. */ - userName: string; + userName: string name: { /** @description The first name of the user. */ - givenName: string; + givenName: string /** @description The last name of the user. */ - familyName: string; - }; + familyName: string + } /** @description List of user emails. */ emails: { /** @description The email address. */ - value: string; + value: string /** @description The type of email address. */ - type: string; + type: string /** @description Whether this email address is the primary address. */ - primary: boolean; - }[]; + primary: boolean + }[] /** @description List of SCIM group IDs the user is a member of. */ groups?: { - value?: string; - }[]; - }; - }; - }; - }; + value?: string + }[] + } + } + } + } /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - "enterprise-admin/get-provisioning-information-for-enterprise-user": { + 'enterprise-admin/get-provisioning-information-for-enterprise-user': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** scim_user_id parameter */ - scim_user_id: components["parameters"]["scim-user-id"]; - }; - }; + scim_user_id: components['parameters']['scim-user-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["scim-enterprise-user"]; - }; - }; - }; - }; + 'application/json': components['schemas']['scim-enterprise-user'] + } + } + } + } /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * @@ -37514,68 +37479,68 @@ export interface operations { * * **Warning:** Setting `active: false` removes the user from the enterprise, deletes the external identity, and deletes the associated `{scim_user_id}`. */ - "enterprise-admin/set-information-for-provisioned-enterprise-user": { + 'enterprise-admin/set-information-for-provisioned-enterprise-user': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** scim_user_id parameter */ - scim_user_id: components["parameters"]["scim-user-id"]; - }; - }; + scim_user_id: components['parameters']['scim-user-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["scim-enterprise-user"]; - }; - }; - }; + 'application/json': components['schemas']['scim-enterprise-user'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The SCIM schema URIs. */ - schemas: string[]; + schemas: string[] /** @description The username for the user. */ - userName: string; + userName: string name: { /** @description The first name of the user. */ - givenName: string; + givenName: string /** @description The last name of the user. */ - familyName: string; - }; + familyName: string + } /** @description List of user emails. */ emails: { /** @description The email address. */ - value: string; + value: string /** @description The type of email address. */ - type: string; + type: string /** @description Whether this email address is the primary address. */ - primary: boolean; - }[]; + primary: boolean + }[] /** @description List of SCIM group IDs the user is a member of. */ groups?: { - value?: string; - }[]; - }; - }; - }; - }; + value?: string + }[] + } + } + } + } /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ - "enterprise-admin/delete-user-from-enterprise": { + 'enterprise-admin/delete-user-from-enterprise': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** scim_user_id parameter */ - scim_user_id: components["parameters"]["scim-user-id"]; - }; - }; + scim_user_id: components['parameters']['scim-user-id'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * @@ -37596,34 +37561,34 @@ export interface operations { * } * ``` */ - "enterprise-admin/update-attribute-for-enterprise-user": { + 'enterprise-admin/update-attribute-for-enterprise-user': { parameters: { path: { /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; + enterprise: components['parameters']['enterprise'] /** scim_user_id parameter */ - scim_user_id: components["parameters"]["scim-user-id"]; - }; - }; + scim_user_id: components['parameters']['scim-user-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["scim-enterprise-user"]; - }; - }; - }; + 'application/json': components['schemas']['scim-enterprise-user'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The SCIM schema URIs. */ - schemas: string[]; + schemas: string[] /** @description Array of [SCIM operations](https://tools.ietf.org/html/rfc7644#section-3.5.2). */ - Operations: { [key: string]: unknown }[]; - }; - }; - }; - }; + Operations: { [key: string]: unknown }[] + } + } + } + } /** * Retrieves a paginated list of all provisioned organization members, including pending invitations. If you provide the `filter` parameter, the resources for all matching provisions members are returned. * @@ -37642,16 +37607,16 @@ export interface operations { * - If the user signs in, their GitHub account is linked to this entry. * - If the user does not sign in (or does not create a new account when prompted), they are not added to the GitHub organization, and the external identity `null` entry remains in place. */ - "scim/list-provisioned-identities": { + 'scim/list-provisioned-identities': { parameters: { path: { - org: components["parameters"]["org"]; - }; + org: components['parameters']['org'] + } query: { /** Used for pagination: the index of the first result to return. */ - startIndex?: number; + startIndex?: number /** Used for pagination: the number of results to return. */ - count?: number; + count?: number /** * Filters results using the equals query parameter operator (`eq`). You can filter results that are equal to `id`, `userName`, `emails`, and `external_id`. For example, to search for an identity with the `userName` Octocat, you would use this query: * @@ -37661,99 +37626,99 @@ export interface operations { * * `?filter=emails%20eq%20\"octocat@github.com\"`. */ - filter?: string; - }; - }; + filter?: string + } + } responses: { /** Response */ 200: { content: { - "application/scim+json": components["schemas"]["scim-user-list"]; - }; - }; - 304: components["responses"]["not_modified"]; - 400: components["responses"]["scim_bad_request"]; - 403: components["responses"]["scim_forbidden"]; - 404: components["responses"]["scim_not_found"]; - }; - }; + 'application/scim+json': components['schemas']['scim-user-list'] + } + } + 304: components['responses']['not_modified'] + 400: components['responses']['scim_bad_request'] + 403: components['responses']['scim_forbidden'] + 404: components['responses']['scim_not_found'] + } + } /** Provision organization membership for a user, and send an activation email to the email address. */ - "scim/provision-and-invite-user": { + 'scim/provision-and-invite-user': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 201: { content: { - "application/scim+json": components["schemas"]["scim-user"]; - }; - }; - 304: components["responses"]["not_modified"]; - 400: components["responses"]["scim_bad_request"]; - 403: components["responses"]["scim_forbidden"]; - 404: components["responses"]["scim_not_found"]; - 409: components["responses"]["scim_conflict"]; - 500: components["responses"]["scim_internal_error"]; - }; + 'application/scim+json': components['schemas']['scim-user'] + } + } + 304: components['responses']['not_modified'] + 400: components['responses']['scim_bad_request'] + 403: components['responses']['scim_forbidden'] + 404: components['responses']['scim_not_found'] + 409: components['responses']['scim_conflict'] + 500: components['responses']['scim_internal_error'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description Configured by the admin. Could be an email, login, or username * @example someone@example.com */ - userName: string; + userName: string /** * @description The name of the user, suitable for display to end-users * @example Jon Doe */ - displayName?: string; + displayName?: string /** @example [object Object] */ name: { - givenName: string; - familyName: string; - formatted?: string; - }; + givenName: string + familyName: string + formatted?: string + } /** * @description user emails * @example [object Object],[object Object] */ emails: { - value: string; - primary?: boolean; - type?: string; - }[]; - schemas?: string[]; - externalId?: string; - groups?: string[]; - active?: boolean; - }; - }; - }; - }; - "scim/get-provisioning-information-for-user": { - parameters: { - path: { - org: components["parameters"]["org"]; + value: string + primary?: boolean + type?: string + }[] + schemas?: string[] + externalId?: string + groups?: string[] + active?: boolean + } + } + } + } + 'scim/get-provisioning-information-for-user': { + parameters: { + path: { + org: components['parameters']['org'] /** scim_user_id parameter */ - scim_user_id: components["parameters"]["scim-user-id"]; - }; - }; + scim_user_id: components['parameters']['scim-user-id'] + } + } responses: { /** Response */ 200: { content: { - "application/scim+json": components["schemas"]["scim-user"]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["scim_forbidden"]; - 404: components["responses"]["scim_not_found"]; - }; - }; + 'application/scim+json': components['schemas']['scim-user'] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['scim_forbidden'] + 404: components['responses']['scim_not_found'] + } + } /** * Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](https://docs.github.com/rest/reference/scim#update-an-attribute-for-a-scim-user) endpoint instead. * @@ -37761,77 +37726,77 @@ export interface operations { * * **Warning:** Setting `active: false` removes the user from the organization, deletes the external identity, and deletes the associated `{scim_user_id}`. */ - "scim/set-information-for-provisioned-user": { + 'scim/set-information-for-provisioned-user': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** scim_user_id parameter */ - scim_user_id: components["parameters"]["scim-user-id"]; - }; - }; + scim_user_id: components['parameters']['scim-user-id'] + } + } responses: { /** Response */ 200: { content: { - "application/scim+json": components["schemas"]["scim-user"]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["scim_forbidden"]; - 404: components["responses"]["scim_not_found"]; - }; + 'application/scim+json': components['schemas']['scim-user'] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['scim_forbidden'] + 404: components['responses']['scim_not_found'] + } requestBody: { content: { - "application/json": { - schemas?: string[]; + 'application/json': { + schemas?: string[] /** * @description The name of the user, suitable for display to end-users * @example Jon Doe */ - displayName?: string; - externalId?: string; - groups?: string[]; - active?: boolean; + displayName?: string + externalId?: string + groups?: string[] + active?: boolean /** * @description Configured by the admin. Could be an email, login, or username * @example someone@example.com */ - userName: string; + userName: string /** @example [object Object] */ name: { - givenName: string; - familyName: string; - formatted?: string; - }; + givenName: string + familyName: string + formatted?: string + } /** * @description user emails * @example [object Object],[object Object] */ emails: { - type?: string; - value: string; - primary?: boolean; - }[]; - }; - }; - }; - }; - "scim/delete-user-from-org": { - parameters: { - path: { - org: components["parameters"]["org"]; + type?: string + value: string + primary?: boolean + }[] + } + } + } + } + 'scim/delete-user-from-org': { + parameters: { + path: { + org: components['parameters']['org'] /** scim_user_id parameter */ - scim_user_id: components["parameters"]["scim-user-id"]; - }; - }; + scim_user_id: components['parameters']['scim-user-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["scim_forbidden"]; - 404: components["responses"]["scim_not_found"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 403: components['responses']['scim_forbidden'] + 404: components['responses']['scim_not_found'] + } + } /** * Allows you to change a provisioned user's individual attributes. To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). * @@ -37850,62 +37815,62 @@ export interface operations { * } * ``` */ - "scim/update-attribute-for-user": { + 'scim/update-attribute-for-user': { parameters: { path: { - org: components["parameters"]["org"]; + org: components['parameters']['org'] /** scim_user_id parameter */ - scim_user_id: components["parameters"]["scim-user-id"]; - }; - }; + scim_user_id: components['parameters']['scim-user-id'] + } + } responses: { /** Response */ 200: { content: { - "application/scim+json": components["schemas"]["scim-user"]; - }; - }; - 304: components["responses"]["not_modified"]; - 400: components["responses"]["scim_bad_request"]; - 403: components["responses"]["scim_forbidden"]; - 404: components["responses"]["scim_not_found"]; + 'application/scim+json': components['schemas']['scim-user'] + } + } + 304: components['responses']['not_modified'] + 400: components['responses']['scim_bad_request'] + 403: components['responses']['scim_forbidden'] + 404: components['responses']['scim_not_found'] /** Response */ 429: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } + } requestBody: { content: { - "application/json": { - schemas?: string[]; + 'application/json': { + schemas?: string[] /** * @description Set of operations to be performed * @example [object Object] */ Operations: { /** @enum {string} */ - op: "add" | "remove" | "replace"; - path?: string; + op: 'add' | 'remove' | 'replace' + path?: string value?: | { - active?: boolean | null; - userName?: string | null; - externalId?: string | null; - givenName?: string | null; - familyName?: string | null; + active?: boolean | null + userName?: string | null + externalId?: string | null + givenName?: string | null + familyName?: string | null } | { - value?: string; - primary?: boolean; + value?: string + primary?: boolean }[] - | string; - }[]; - }; - }; - }; - }; + | string + }[] + } + } + } + } /** * Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -37926,38 +37891,38 @@ export interface operations { * * You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing * language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. */ - "search/code": { + 'search/code': { parameters: { query: { /** The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching code](https://docs.github.com/articles/searching-code/)" for a detailed list of qualifiers. */ - q: string; + q: string /** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */ - sort?: "indexed"; + sort?: 'indexed' /** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - order?: components["parameters"]["order"]; + order?: components['parameters']['order'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - incomplete_results: boolean; - items: components["schemas"]["code-search-result-item"][]; - }; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': { + total_count: number + incomplete_results: boolean + items: components['schemas']['code-search-result-item'][] + } + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + 503: components['responses']['service_unavailable'] + } + } /** * Find commits via various criteria on the default branch (usually `master`). This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -37968,35 +37933,35 @@ export interface operations { * * `q=repo:octocat/Spoon-Knife+css` */ - "search/commits": { + 'search/commits': { parameters: { query: { /** The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching commits](https://docs.github.com/articles/searching-commits/)" for a detailed list of qualifiers. */ - q: string; + q: string /** Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */ - sort?: "author-date" | "committer-date"; + sort?: 'author-date' | 'committer-date' /** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - order?: components["parameters"]["order"]; + order?: components['parameters']['order'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - incomplete_results: boolean; - items: components["schemas"]["commit-search-result-item"][]; - }; - }; - }; - 304: components["responses"]["not_modified"]; - }; - }; + 'application/json': { + total_count: number + incomplete_results: boolean + items: components['schemas']['commit-search-result-item'][] + } + } + } + 304: components['responses']['not_modified'] + } + } /** * Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -38011,49 +37976,49 @@ export interface operations { * * **Note:** For [user-to-server](https://docs.github.com/developers/apps/identifying-and-authorizing-users-for-github-apps#user-to-server-requests) GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." */ - "search/issues-and-pull-requests": { + 'search/issues-and-pull-requests': { parameters: { query: { /** The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching issues and pull requests](https://docs.github.com/articles/searching-issues-and-pull-requests/)" for a detailed list of qualifiers. */ - q: string; + q: string /** Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */ sort?: - | "comments" - | "reactions" - | "reactions-+1" - | "reactions--1" - | "reactions-smile" - | "reactions-thinking_face" - | "reactions-heart" - | "reactions-tada" - | "interactions" - | "created" - | "updated"; + | 'comments' + | 'reactions' + | 'reactions-+1' + | 'reactions--1' + | 'reactions-smile' + | 'reactions-thinking_face' + | 'reactions-heart' + | 'reactions-tada' + | 'interactions' + | 'created' + | 'updated' /** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - order?: components["parameters"]["order"]; + order?: components['parameters']['order'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - incomplete_results: boolean; - items: components["schemas"]["issue-search-result-item"][]; - }; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': { + total_count: number + incomplete_results: boolean + items: components['schemas']['issue-search-result-item'][] + } + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + 503: components['responses']['service_unavailable'] + } + } /** * Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -38065,40 +38030,40 @@ export interface operations { * * The labels that best match the query appear first in the search results. */ - "search/labels": { + 'search/labels': { parameters: { query: { /** The id of the repository. */ - repository_id: number; + repository_id: number /** The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). */ - q: string; + q: string /** Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */ - sort?: "created" | "updated"; + sort?: 'created' | 'updated' /** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - order?: components["parameters"]["order"]; + order?: components['parameters']['order'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - incomplete_results: boolean; - items: components["schemas"]["label-search-result-item"][]; - }; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': { + total_count: number + incomplete_results: boolean + items: components['schemas']['label-search-result-item'][] + } + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** * Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -38110,37 +38075,37 @@ export interface operations { * * This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results. */ - "search/repos": { + 'search/repos': { parameters: { query: { /** The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers. */ - q: string; + q: string /** Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */ - sort?: "stars" | "forks" | "help-wanted-issues" | "updated"; + sort?: 'stars' | 'forks' | 'help-wanted-issues' | 'updated' /** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - order?: components["parameters"]["order"]; + order?: components['parameters']['order'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - incomplete_results: boolean; - items: components["schemas"]["repo-search-result-item"][]; - }; - }; - }; - 304: components["responses"]["not_modified"]; - 422: components["responses"]["validation_failed"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': { + total_count: number + incomplete_results: boolean + items: components['schemas']['repo-search-result-item'][] + } + } + } + 304: components['responses']['not_modified'] + 422: components['responses']['validation_failed'] + 503: components['responses']['service_unavailable'] + } + } /** * Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers. * @@ -38152,31 +38117,31 @@ export interface operations { * * This query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results. */ - "search/topics": { + 'search/topics': { parameters: { query: { /** The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). */ - q: string; + q: string /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - incomplete_results: boolean; - items: components["schemas"]["topic-search-result-item"][]; - }; - }; - }; - 304: components["responses"]["not_modified"]; - }; - }; + 'application/json': { + total_count: number + incomplete_results: boolean + items: components['schemas']['topic-search-result-item'][] + } + } + } + 304: components['responses']['not_modified'] + } + } /** * Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * @@ -38188,54 +38153,54 @@ export interface operations { * * This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. */ - "search/users": { + 'search/users': { parameters: { query: { /** The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching users](https://docs.github.com/articles/searching-users/)" for a detailed list of qualifiers. */ - q: string; + q: string /** Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */ - sort?: "followers" | "repositories" | "joined"; + sort?: 'followers' | 'repositories' | 'joined' /** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - order?: components["parameters"]["order"]; + order?: components['parameters']['order'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - incomplete_results: boolean; - items: components["schemas"]["user-search-result-item"][]; - }; - }; - }; - 304: components["responses"]["not_modified"]; - 422: components["responses"]["validation_failed"]; - 503: components["responses"]["service_unavailable"]; - }; - }; + 'application/json': { + total_count: number + incomplete_results: boolean + items: components['schemas']['user-search-result-item'][] + } + } + } + 304: components['responses']['not_modified'] + 422: components['responses']['validation_failed'] + 503: components['responses']['service_unavailable'] + } + } /** **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/reference/teams#get-a-team-by-name) endpoint. */ - "teams/get-legacy": { + 'teams/get-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; - }; + team_id: components['parameters']['team-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-full"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['team-full'] + } + } + 404: components['responses']['not_found'] + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/reference/teams#delete-a-team) endpoint. * @@ -38243,19 +38208,19 @@ export interface operations { * * If you are an organization owner, deleting a parent team will delete all of its child teams as well. */ - "teams/delete-legacy": { + 'teams/delete-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; - }; + team_id: components['parameters']['team-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/reference/teams#update-a-team) endpoint. * @@ -38263,36 +38228,36 @@ export interface operations { * * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. */ - "teams/update-legacy": { + 'teams/update-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; - }; + team_id: components['parameters']['team-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-full"]; - }; - }; + 'application/json': components['schemas']['team-full'] + } + } /** Response */ 201: { content: { - "application/json": components["schemas"]["team-full"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['team-full'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The name of the team. */ - name: string; + name: string /** @description The description of the team. */ - description?: string; + description?: string /** * @description The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: * **For a non-nested team:** @@ -38302,7 +38267,7 @@ export interface operations { * \* `closed` - visible to all members of this organization. * @enum {string} */ - privacy?: "secret" | "closed"; + privacy?: 'secret' | 'closed' /** * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: * \* `pull` - team members can pull, but not push to or administer newly-added repositories. @@ -38311,42 +38276,42 @@ export interface operations { * @default pull * @enum {string} */ - permission?: "pull" | "push" | "admin"; + permission?: 'pull' | 'push' | 'admin' /** @description The ID of a team to set as the parent team. */ - parent_team_id?: number | null; - }; - }; - }; - }; + parent_team_id?: number | null + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/reference/teams#list-discussions) endpoint. * * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "teams/list-discussions-legacy": { + 'teams/list-discussions-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; + team_id: components['parameters']['team-id'] + } query: { /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team-discussion"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['team-discussion'][] + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/reference/teams#create-a-discussion) endpoint. * @@ -38354,132 +38319,132 @@ export interface operations { * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - "teams/create-discussion-legacy": { + 'teams/create-discussion-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; - }; + team_id: components['parameters']['team-id'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; + 'application/json': components['schemas']['team-discussion'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The discussion post's title. */ - title: string; + title: string /** @description The discussion post's body text. */ - body: string; + body: string /** @description Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. */ - private?: boolean; - }; - }; - }; - }; + private?: boolean + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/reference/teams#get-a-discussion) endpoint. * * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "teams/get-discussion-legacy": { + 'teams/get-discussion-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - }; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; - }; + 'application/json': components['schemas']['team-discussion'] + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/reference/teams#delete-a-discussion) endpoint. * * Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "teams/delete-discussion-legacy": { + 'teams/delete-discussion-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - }; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/reference/teams#update-a-discussion) endpoint. * * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "teams/update-discussion-legacy": { + 'teams/update-discussion-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - }; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; + 'application/json': components['schemas']['team-discussion'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The discussion post's title. */ - title?: string; + title?: string /** @description The discussion post's body text. */ - body?: string; - }; - }; - }; - }; + body?: string + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/reference/teams#list-discussion-comments) endpoint. * * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "teams/list-discussion-comments-legacy": { + 'teams/list-discussion-comments-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + } query: { /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team-discussion-comment"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['team-discussion-comment'][] + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/reference/teams#create-a-discussion-comment) endpoint. * @@ -38487,263 +38452,263 @@ export interface operations { * * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ - "teams/create-discussion-comment-legacy": { + 'teams/create-discussion-comment-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - }; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; + 'application/json': components['schemas']['team-discussion-comment'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The discussion comment's body text. */ - body: string; - }; - }; - }; - }; + body: string + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/reference/teams#get-a-discussion-comment) endpoint. * * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "teams/get-discussion-comment-legacy": { + 'teams/get-discussion-comment-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - comment_number: components["parameters"]["comment-number"]; - }; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + comment_number: components['parameters']['comment-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; - }; + 'application/json': components['schemas']['team-discussion-comment'] + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/reference/teams#delete-a-discussion-comment) endpoint. * * Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "teams/delete-discussion-comment-legacy": { + 'teams/delete-discussion-comment-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - comment_number: components["parameters"]["comment-number"]; - }; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + comment_number: components['parameters']['comment-number'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/reference/teams#update-a-discussion-comment) endpoint. * * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "teams/update-discussion-comment-legacy": { + 'teams/update-discussion-comment-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - comment_number: components["parameters"]["comment-number"]; - }; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + comment_number: components['parameters']['comment-number'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; + 'application/json': components['schemas']['team-discussion-comment'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The discussion comment's body text. */ - body: string; - }; - }; - }; - }; + body: string + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * * List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "reactions/list-for-team-discussion-comment-legacy": { + 'reactions/list-for-team-discussion-comment-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - comment_number: components["parameters"]["comment-number"]; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + comment_number: components['parameters']['comment-number'] + } query: { /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion comment. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content?: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["reaction"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['reaction'][] + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. * * Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. */ - "reactions/create-for-team-discussion-comment-legacy": { + 'reactions/create-for-team-discussion-comment-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - comment_number: components["parameters"]["comment-number"]; - }; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + comment_number: components['parameters']['comment-number'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - }; + 'application/json': components['schemas']['reaction'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion comment. * @enum {string} */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - }; + content: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion) endpoint. * * List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "reactions/list-for-team-discussion-legacy": { + 'reactions/list-for-team-discussion-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + } query: { /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content?: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["reaction"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['reaction'][] + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion) endpoint. * * Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. */ - "reactions/create-for-team-discussion-legacy": { + 'reactions/create-for-team-discussion-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - discussion_number: components["parameters"]["discussion-number"]; - }; - }; + team_id: components['parameters']['team-id'] + discussion_number: components['parameters']['discussion-number'] + } + } responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - }; + 'application/json': components['schemas']['reaction'] + } + } + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion. * @enum {string} */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - }; + content: '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes' + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/reference/teams#list-pending-team-invitations) endpoint. * * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. */ - "teams/list-pending-invitations-legacy": { + 'teams/list-pending-invitations-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; + team_id: components['parameters']['team-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["organization-invitation"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['organization-invitation'][] + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/reference/teams#list-team-members) endpoint. * * Team members will include the members of child teams. */ - "teams/list-members-legacy": { + 'teams/list-members-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; + team_id: components['parameters']['team-id'] + } query: { /** * Filters members returned by their role in the team. Can be one of: @@ -38751,24 +38716,24 @@ export interface operations { * \* `maintainer` - team maintainers. * \* `all` - all members of the team. */ - role?: "member" | "maintainer" | "all"; + role?: 'member' | 'maintainer' | 'all' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + 404: components['responses']['not_found'] + } + } /** * The "Get team member" endpoint (described below) is deprecated. * @@ -38776,20 +38741,20 @@ export interface operations { * * To list members in a team, the team must be visible to the authenticated user. */ - "teams/get-member-legacy": { + 'teams/get-member-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - username: components["parameters"]["username"]; - }; - }; + team_id: components['parameters']['team-id'] + username: components['parameters']['username'] + } + } responses: { /** if user is a member */ - 204: never; + 204: never /** if user is not a member */ - 404: unknown; - }; - }; + 404: unknown + } + } /** * The "Add team member" endpoint (described below) is deprecated. * @@ -38803,23 +38768,23 @@ export interface operations { * * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - "teams/add-member-legacy": { + 'teams/add-member-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - username: components["parameters"]["username"]; - }; - }; + team_id: components['parameters']['team-id'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 403: components["responses"]["forbidden"]; + 204: never + 403: components['responses']['forbidden'] /** Not Found if team synchronization is set up */ - 404: unknown; + 404: unknown /** Unprocessable Entity if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization */ - 422: unknown; - }; - }; + 422: unknown + } + } /** * The "Remove team member" endpoint (described below) is deprecated. * @@ -38831,20 +38796,20 @@ export interface operations { * * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ - "teams/remove-member-legacy": { + 'teams/remove-member-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - username: components["parameters"]["username"]; - }; - }; + team_id: components['parameters']['team-id'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; + 204: never /** Not Found if team synchronization is setup */ - 404: unknown; - }; - }; + 404: unknown + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/reference/teams#get-team-membership-for-a-user) endpoint. * @@ -38857,23 +38822,23 @@ export interface operations { * * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team). */ - "teams/get-membership-for-user-legacy": { + 'teams/get-membership-for-user-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - username: components["parameters"]["username"]; - }; - }; + team_id: components['parameters']['team-id'] + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-membership"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['team-membership'] + } + } + 404: components['responses']['not_found'] + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint. * @@ -38887,29 +38852,29 @@ export interface operations { * * If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. */ - "teams/add-or-update-membership-for-user-legacy": { + 'teams/add-or-update-membership-for-user-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - username: components["parameters"]["username"]; - }; - }; + team_id: components['parameters']['team-id'] + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-membership"]; - }; - }; + 'application/json': components['schemas']['team-membership'] + } + } /** Forbidden if team synchronization is set up */ - 403: unknown; - 404: components["responses"]["not_found"]; + 403: unknown + 404: components['responses']['not_found'] /** Unprocessable Entity if you attempt to add an organization to a team */ - 422: unknown; - }; + 422: unknown + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The role that this user should have in the team. Can be one of: * \* `member` - a normal member of the team. @@ -38917,11 +38882,11 @@ export interface operations { * @default member * @enum {string} */ - role?: "member" | "maintainer"; - }; - }; - }; - }; + role?: 'member' | 'maintainer' + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/reference/teams#remove-team-membership-for-a-user) endpoint. * @@ -38931,101 +38896,101 @@ export interface operations { * * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ - "teams/remove-membership-for-user-legacy": { + 'teams/remove-membership-for-user-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - username: components["parameters"]["username"]; - }; - }; + team_id: components['parameters']['team-id'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; + 204: never /** if team synchronization is set up */ - 403: unknown; - }; - }; + 403: unknown + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/reference/teams#list-team-projects) endpoint. * * Lists the organization projects for a team. */ - "teams/list-projects-legacy": { + 'teams/list-projects-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; + team_id: components['parameters']['team-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team-project"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['team-project'][] + } + } + 404: components['responses']['not_found'] + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/reference/teams#check-team-permissions-for-a-project) endpoint. * * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. */ - "teams/check-permissions-for-project-legacy": { + 'teams/check-permissions-for-project-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - project_id: components["parameters"]["project-id"]; - }; - }; + team_id: components['parameters']['team-id'] + project_id: components['parameters']['project-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["team-project"]; - }; - }; + 'application/json': components['schemas']['team-project'] + } + } /** Not Found if project is not managed by this team */ - 404: unknown; - }; - }; + 404: unknown + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/reference/teams#add-or-update-team-project-permissions) endpoint. * * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. */ - "teams/add-or-update-project-permissions-legacy": { + 'teams/add-or-update-project-permissions-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - project_id: components["parameters"]["project-id"]; - }; - }; + team_id: components['parameters']['team-id'] + project_id: components['parameters']['project-id'] + } + } responses: { /** Response */ - 204: never; + 204: never /** Forbidden if the project is not owned by the organization */ 403: { content: { - "application/json": { - message?: string; - documentation_url?: string; - }; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': { + message?: string + documentation_url?: string + } + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The permission to grant to the team for this project. Can be one of: * \* `read` - team members can read, but not write to or administer this project. @@ -39034,55 +38999,55 @@ export interface operations { * Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." * @enum {string} */ - permission?: "read" | "write" | "admin"; - }; - }; - }; - }; + permission?: 'read' | 'write' | 'admin' + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/reference/teams#remove-a-project-from-a-team) endpoint. * * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. */ - "teams/remove-project-legacy": { + 'teams/remove-project-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - project_id: components["parameters"]["project-id"]; - }; - }; + team_id: components['parameters']['team-id'] + project_id: components['parameters']['project-id'] + } + } responses: { /** Response */ - 204: never; - 404: components["responses"]["not_found"]; - 415: components["responses"]["preview_header_missing"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 204: never + 404: components['responses']['not_found'] + 415: components['responses']['preview_header_missing'] + 422: components['responses']['validation_failed'] + } + } /** **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/reference/teams#list-team-repositories) endpoint. */ - "teams/list-repos-legacy": { + 'teams/list-repos-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; + team_id: components['parameters']['team-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["minimal-repository"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['minimal-repository'][] + } + } + 404: components['responses']['not_found'] + } + } /** * **Note**: Repositories inherited through a parent team will also be checked. * @@ -39090,27 +39055,27 @@ export interface operations { * * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: */ - "teams/check-permissions-for-repo-legacy": { + 'teams/check-permissions-for-repo-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + team_id: components['parameters']['team-id'] + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Alternative response with extra repository information */ 200: { content: { - "application/json": components["schemas"]["team-repository"]; - }; - }; + 'application/json': components['schemas']['team-repository'] + } + } /** Response if repository is managed by this team */ - 204: never; + 204: never /** Not Found if repository is not managed by this team */ - 404: unknown; - }; - }; + 404: unknown + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/reference/teams#add-or-update-team-repository-permissions)" endpoint. * @@ -39118,23 +39083,23 @@ export interface operations { * * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - "teams/add-or-update-repo-permissions-legacy": { + 'teams/add-or-update-repo-permissions-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + team_id: components['parameters']['team-id'] + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + 204: never + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The permission to grant the team on this repository. Can be one of: * \* `pull` - team members can pull, but not push to or administer this repository. @@ -39144,29 +39109,29 @@ export interface operations { * If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. * @enum {string} */ - permission?: "pull" | "push" | "admin"; - }; - }; - }; - }; + permission?: 'pull' | 'push' | 'admin' + } + } + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/reference/teams#remove-a-repository-from-a-team) endpoint. * * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. */ - "teams/remove-repo-legacy": { + 'teams/remove-repo-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + team_id: components['parameters']['team-id'] + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List IdP groups for a team`](https://docs.github.com/rest/reference/teams#list-idp-groups-for-a-team) endpoint. * @@ -39174,23 +39139,23 @@ export interface operations { * * List IdP groups connected to a team on GitHub. */ - "teams/list-idp-groups-for-legacy": { + 'teams/list-idp-groups-for-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; - }; + team_id: components['parameters']['team-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["group-mapping"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['group-mapping'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create or update IdP group connections`](https://docs.github.com/rest/reference/teams#create-or-update-idp-group-connections) endpoint. * @@ -39198,249 +39163,249 @@ export interface operations { * * Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty `groups` array will remove all connections for a team. */ - "teams/create-or-update-idp-group-connections-legacy": { + 'teams/create-or-update-idp-group-connections-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; - }; + team_id: components['parameters']['team-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["group-mapping"]; - }; - }; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['group-mapping'] + } + } + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description The IdP groups you want to connect to a GitHub team. When updating, the new `groups` object will replace the original one. You must include any existing groups that you don't want to remove. */ groups: { /** @description ID of the IdP group. */ - group_id: string; + group_id: string /** @description Name of the IdP group. */ - group_name: string; + group_name: string /** @description Description of the IdP group. */ - group_description: string; + group_description: string /** @example "caceab43fc9ffa20081c" */ - id?: string; + id?: string /** @example "external-team-6c13e7288ef7" */ - name?: string; + name?: string /** @example "moar cheese pleese" */ - description?: string; - }[]; + description?: string + }[] /** @example "I am not a timestamp" */ - synced_at?: string; - }; - }; - }; - }; + synced_at?: string + } + } + } + } /** **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/reference/teams#list-child-teams) endpoint. */ - "teams/list-child-legacy": { + 'teams/list-child-legacy': { parameters: { path: { - team_id: components["parameters"]["team-id"]; - }; + team_id: components['parameters']['team-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** if child teams exist */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team"][]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['team'][] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** * If the authenticated user is authenticated through basic authentication or OAuth with the `user` scope, then the response lists public and private profile information. * * If the authenticated user is authenticated through OAuth without the `user` scope, then the response lists only public profile information. */ - "users/get-authenticated": { - parameters: {}; + 'users/get-authenticated': { + parameters: {} responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["private-user"] | components["schemas"]["public-user"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['private-user'] | components['schemas']['public-user'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** **Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API. */ - "users/update-authenticated": { - parameters: {}; + 'users/update-authenticated': { + parameters: {} responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["private-user"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['private-user'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The new name of the user. * @example Omar Jahandar */ - name?: string; + name?: string /** * @description The publicly visible email address of the user. * @example omar@example.com */ - email?: string; + email?: string /** * @description The new blog URL of the user. * @example blog.example.com */ - blog?: string; + blog?: string /** * @description The new Twitter username of the user. * @example therealomarj */ - twitter_username?: string | null; + twitter_username?: string | null /** * @description The new company of the user. * @example Acme corporation */ - company?: string; + company?: string /** * @description The new location of the user. * @example Berlin, Germany */ - location?: string; + location?: string /** @description The new hiring availability of the user. */ - hireable?: boolean; + hireable?: boolean /** @description The new short biography of the user. */ - bio?: string; - }; - }; - }; - }; + bio?: string + } + } + } + } /** List the users you've blocked on your personal account. */ - "users/list-blocked-by-authenticated-user": { - parameters: {}; + 'users/list-blocked-by-authenticated-user': { + parameters: {} responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 415: components["responses"]["preview_header_missing"]; - }; - }; - "users/check-blocked": { + 'application/json': components['schemas']['simple-user'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 415: components['responses']['preview_header_missing'] + } + } + 'users/check-blocked': { parameters: { path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** If the user is blocked: */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] /** If the user is not blocked: */ 404: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - }; - }; - "users/block": { + 'application/json': components['schemas']['basic-error'] + } + } + } + } + 'users/block': { parameters: { path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "users/unblock": { + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } + 'users/unblock': { parameters: { path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Lists the authenticated user's codespaces. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/list-for-authenticated-user": { + 'codespaces/list-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** ID of the Repository to filter on */ - repository_id?: components["parameters"]["repository-id-in-query"]; - }; - }; + repository_id?: components['parameters']['repository-id-in-query'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - codespaces: components["schemas"]["codespace"][]; - }; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': { + total_count: number + codespaces: components['schemas']['codespace'][] + } + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** * Creates a new codespace, owned by the authenticated user. * @@ -39448,119 +39413,119 @@ export interface operations { * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/create-for-authenticated-user": { + 'codespaces/create-for-authenticated-user': { responses: { /** Response when the codespace was successfully created */ 201: { content: { - "application/json": components["schemas"]["codespace"]; - }; - }; + 'application/json': components['schemas']['codespace'] + } + } /** Response when the codespace creation partially failed but is being retried in the background */ 202: { content: { - "application/json": components["schemas"]["codespace"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; + 'application/json': components['schemas']['codespace'] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description Repository id for this codespace */ - repository_id: number; + repository_id: number /** @description Git ref (typically a branch name) for this codespace */ - ref?: string; + ref?: string /** @description Location for this codespace */ - location: string; + location: string /** @description Machine type to use for this codespace */ - machine?: string; + machine?: string /** @description Working directory for this codespace */ - working_directory?: string; + working_directory?: string /** @description Time in minutes before codespace stops from inactivity */ - idle_timeout_minutes?: number; + idle_timeout_minutes?: number } | { /** @description Pull request number for this codespace */ pull_request: { /** @description Pull request number */ - pull_request_number: number; + pull_request_number: number /** @description Repository id for this codespace */ - repository_id: number; - }; + repository_id: number + } /** @description Location for this codespace */ - location: string; + location: string /** @description Machine type to use for this codespace */ - machine?: string; + machine?: string /** @description Working directory for this codespace */ - working_directory?: string; + working_directory?: string /** @description Time in minutes before codespace stops from inactivity */ - idle_timeout_minutes?: number; - }; - }; - }; - }; + idle_timeout_minutes?: number + } + } + } + } /** * Lists all secrets available for a user's Codespaces without revealing their * encrypted values. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - "codespaces/list-secrets-for-authenticated-user": { + 'codespaces/list-secrets-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": { - total_count: number; - secrets: components["schemas"]["codespaces-secret"][]; - }; - }; - }; - }; - }; + 'application/json': { + total_count: number + secrets: components['schemas']['codespaces-secret'][] + } + } + } + } + } /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with one of the 'read:user' or 'user' scopes in their personal access token. User must have Codespaces access to use this endpoint. */ - "codespaces/get-public-key-for-authenticated-user": { + 'codespaces/get-public-key-for-authenticated-user': { responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["codespaces-user-public-key"]; - }; - }; - }; - }; + 'application/json': components['schemas']['codespaces-user-public-key'] + } + } + } + } /** * Gets a secret available to a user's codespaces without revealing its encrypted value. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - "codespaces/get-secret-for-authenticated-user": { + 'codespaces/get-secret-for-authenticated-user': { parameters: { path: { /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["codespaces-secret"]; - }; - }; - }; - }; + 'application/json': components['schemas']['codespaces-secret'] + } + } + } + } /** * Creates or updates a secret for a user's codespace with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access token with the `user` scope to use this endpoint. User must also have Codespaces access to use this endpoint. @@ -39636,195 +39601,195 @@ export interface operations { * puts Base64.strict_encode64(encrypted_secret) * ``` */ - "codespaces/create-or-update-secret-for-authenticated-user": { + 'codespaces/create-or-update-secret-for-authenticated-user': { parameters: { path: { /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response after successfully creaing a secret */ 201: { content: { - "application/json": { [key: string]: unknown }; - }; - }; + 'application/json': { [key: string]: unknown } + } + } /** Response after successfully updating a secret */ - 204: never; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 204: never + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for the authenticated user](https://docs.github.com/rest/reference/codespaces#get-the-public-key-for-the-authenticated-user) endpoint. */ - encrypted_value: string; + encrypted_value: string /** @description ID of the key you used to encrypt the secret. */ - key_id: string; + key_id: string /** @description An array of repository ids that can access the user secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/reference/codespaces#list-selected-repositories-for-a-user-secret), [Set selected repositories for a user secret](https://docs.github.com/rest/reference/codespaces#set-selected-repositories-for-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/reference/codespaces#remove-a-selected-repository-from-a-user-secret) endpoints. */ - selected_repository_ids?: string[]; - }; - }; - }; - }; + selected_repository_ids?: string[] + } + } + } + } /** Deletes a secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret. You must authenticate using an access token with the `user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - "codespaces/delete-secret-for-authenticated-user": { + 'codespaces/delete-secret-for-authenticated-user': { parameters: { path: { /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * List the repositories that have been granted the ability to use a user's codespace secret. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - "codespaces/list-repositories-for-secret-for-authenticated-user": { + 'codespaces/list-repositories-for-secret-for-authenticated-user': { parameters: { path: { /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - repositories: components["schemas"]["minimal-repository"][]; - }; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': { + total_count: number + repositories: components['schemas']['minimal-repository'][] + } + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** * Select the repositories that will use a user's codespace secret. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - "codespaces/set-repositories-for-secret-for-authenticated-user": { + 'codespaces/set-repositories-for-secret-for-authenticated-user': { parameters: { path: { /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - }; - }; + secret_name: components['parameters']['secret-name'] + } + } responses: { /** No Content when repositories were added to the selected list */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description An array of repository ids for which a codespace can access the secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/reference/codespaces#list-selected-repositories-for-a-user-secret), [Add a selected repository to a user secret](https://docs.github.com/rest/reference/codespaces#add-a-selected-repository-to-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/reference/codespaces#remove-a-selected-repository-from-a-user-secret) endpoints. */ - selected_repository_ids: number[]; - }; - }; - }; - }; + selected_repository_ids: number[] + } + } + } + } /** * Adds a repository to the selected repositories for a user's codespace secret. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - "codespaces/add-repository-for-secret-for-authenticated-user": { + 'codespaces/add-repository-for-secret-for-authenticated-user': { parameters: { path: { /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - repository_id: number; - }; - }; + secret_name: components['parameters']['secret-name'] + repository_id: number + } + } responses: { /** No Content when repository was added to the selected list */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** * Removes a repository from the selected repositories for a user's codespace secret. * You must authenticate using an access token with the `user` or `read:user` scope to use this endpoint. User must have Codespaces access to use this endpoint. */ - "codespaces/remove-repository-for-secret-for-authenticated-user": { + 'codespaces/remove-repository-for-secret-for-authenticated-user': { parameters: { path: { /** secret_name parameter */ - secret_name: components["parameters"]["secret-name"]; - repository_id: number; - }; - }; + secret_name: components['parameters']['secret-name'] + repository_id: number + } + } responses: { /** No Content when repository was removed from the selected list */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** * Gets information about a user's codespace. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/get-for-authenticated-user": { + 'codespaces/get-for-authenticated-user': { parameters: { path: { /** The name of the codespace. */ - codespace_name: components["parameters"]["codespace-name"]; - }; - }; + codespace_name: components['parameters']['codespace-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["codespace"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': components['schemas']['codespace'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** * Deletes a user's codespace. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/delete-for-authenticated-user": { + 'codespaces/delete-for-authenticated-user': { parameters: { path: { /** The name of the codespace. */ - codespace_name: components["parameters"]["codespace-name"]; - }; - }; - responses: { - 202: components["responses"]["accepted"]; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + codespace_name: components['parameters']['codespace-name'] + } + } + responses: { + 202: components['responses']['accepted'] + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** * Updates a codespace owned by the authenticated user. Currently only the codespace's machine type and recent folders can be modified using this endpoint. * @@ -39832,470 +39797,470 @@ export interface operations { * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/update-for-authenticated-user": { + 'codespaces/update-for-authenticated-user': { parameters: { path: { /** The name of the codespace. */ - codespace_name: components["parameters"]["codespace-name"]; - }; - }; + codespace_name: components['parameters']['codespace-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["codespace"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; + 'application/json': components['schemas']['codespace'] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description A valid machine to transition this codespace to. */ - machine?: string; + machine?: string /** @description Recently opened folders inside the codespace. It is currently used by the clients to determine the folder path to load the codespace in. */ - recent_folders?: string[]; - }; - }; - }; - }; + recent_folders?: string[] + } + } + } + } /** * Triggers an export of the specified codespace and returns a URL and ID where the status of the export can be monitored. * * You must authenticate using a personal access token with the `codespace` scope to use this endpoint. */ - "codespaces/export-for-authenticated-user": { + 'codespaces/export-for-authenticated-user': { parameters: { path: { /** The name of the codespace. */ - codespace_name: components["parameters"]["codespace-name"]; - }; - }; + codespace_name: components['parameters']['codespace-name'] + } + } responses: { /** Response */ 202: { content: { - "application/json": components["schemas"]["codespace-export-details"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': components['schemas']['codespace-export-details'] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + 500: components['responses']['internal_error'] + } + } /** * Gets information about an export of a codespace. * * You must authenticate using a personal access token with the `codespace` scope to use this endpoint. */ - "codespaces/get-export-details-for-authenticated-user": { + 'codespaces/get-export-details-for-authenticated-user': { parameters: { path: { /** The name of the codespace. */ - codespace_name: components["parameters"]["codespace-name"]; + codespace_name: components['parameters']['codespace-name'] /** The ID of the export operation, or `latest`. Currently only `latest` is currently supported. */ - export_id: components["parameters"]["export-id"]; - }; - }; + export_id: components['parameters']['export-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["codespace-export-details"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['codespace-export-details'] + } + } + 404: components['responses']['not_found'] + } + } /** * List the machine types a codespace can transition to use. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/codespace-machines-for-authenticated-user": { + 'codespaces/codespace-machines-for-authenticated-user': { parameters: { path: { /** The name of the codespace. */ - codespace_name: components["parameters"]["codespace-name"]; - }; - }; + codespace_name: components['parameters']['codespace-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": { - total_count: number; - machines: components["schemas"]["codespace-machine"][]; - }; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': { + total_count: number + machines: components['schemas']['codespace-machine'][] + } + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** * Starts a user's codespace. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/start-for-authenticated-user": { + 'codespaces/start-for-authenticated-user': { parameters: { path: { /** The name of the codespace. */ - codespace_name: components["parameters"]["codespace-name"]; - }; - }; + codespace_name: components['parameters']['codespace-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["codespace"]; - }; - }; - 304: components["responses"]["not_modified"]; - 400: components["responses"]["bad_request"]; - 401: components["responses"]["requires_authentication"]; + 'application/json': components['schemas']['codespace'] + } + } + 304: components['responses']['not_modified'] + 400: components['responses']['bad_request'] + 401: components['responses']['requires_authentication'] /** Payment required */ 402: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 409: components['responses']['conflict'] + 500: components['responses']['internal_error'] + } + } /** * Stops a user's codespace. * * You must authenticate using an access token with the `codespace` scope to use this endpoint. */ - "codespaces/stop-for-authenticated-user": { + 'codespaces/stop-for-authenticated-user': { parameters: { path: { /** The name of the codespace. */ - codespace_name: components["parameters"]["codespace-name"]; - }; - }; + codespace_name: components['parameters']['codespace-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["codespace"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; + 'application/json': components['schemas']['codespace'] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 500: components['responses']['internal_error'] + } + } /** Sets the visibility for your primary email addresses. */ - "users/set-primary-email-visibility-for-authenticated-user": { - parameters: {}; + 'users/set-primary-email-visibility-for-authenticated-user': { + parameters: {} responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["email"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['email'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description Denotes whether an email is publicly visible. * @enum {string} */ - visibility: "public" | "private"; - }; - }; - }; - }; + visibility: 'public' | 'private' + } + } + } + } /** Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope. */ - "users/list-emails-for-authenticated-user": { + 'users/list-emails-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["email"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['email'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** This endpoint is accessible with the `user` scope. */ - "users/add-email-for-authenticated-user": { - parameters: {}; + 'users/add-email-for-authenticated-user': { + parameters: {} responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["email"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['email'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** * @description Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key. * @example */ - emails: string[]; + emails: string[] } | string[] - | string; - }; - }; - }; + | string + } + } + } /** This endpoint is accessible with the `user` scope. */ - "users/delete-email-for-authenticated-user": { - parameters: {}; + 'users/delete-email-for-authenticated-user': { + parameters: {} responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": + 'application/json': | { /** @description Email addresses associated with the GitHub user account. */ - emails: string[]; + emails: string[] } | string[] - | string; - }; - }; - }; + | string + } + } + } /** Lists the people following the authenticated user. */ - "users/list-followers-for-authenticated-user": { + 'users/list-followers-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** Lists the people who the authenticated user follows. */ - "users/list-followed-by-authenticated-user": { + 'users/list-followed-by-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; - "users/check-person-is-followed-by-authenticated": { + 'application/json': components['schemas']['simple-user'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } + 'users/check-person-is-followed-by-authenticated': { parameters: { path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** if the person is followed by the authenticated user */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] /** if the person is not followed by the authenticated user */ 404: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } + } + } /** * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." * * Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. */ - "users/follow": { + 'users/follow': { parameters: { path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. */ - "users/unfollow": { + 'users/unfollow': { parameters: { path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "users/list-gpg-keys-for-authenticated-user": { + 'users/list-gpg-keys-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["gpg-key"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['gpg-key'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "users/create-gpg-key-for-authenticated-user": { - parameters: {}; + 'users/create-gpg-key-for-authenticated-user': { + parameters: {} responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["gpg-key"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['gpg-key'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** @description A GPG key in ASCII-armored format. */ - armored_public_key: string; - }; - }; - }; - }; + armored_public_key: string + } + } + } + } /** View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "users/get-gpg-key-for-authenticated-user": { + 'users/get-gpg-key-for-authenticated-user': { parameters: { path: { /** gpg_key_id parameter */ - gpg_key_id: components["parameters"]["gpg-key-id"]; - }; - }; + gpg_key_id: components['parameters']['gpg-key-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["gpg-key"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['gpg-key'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "users/delete-gpg-key-for-authenticated-user": { + 'users/delete-gpg-key-for-authenticated-user': { parameters: { path: { /** gpg_key_id parameter */ - gpg_key_id: components["parameters"]["gpg-key-id"]; - }; - }; + gpg_key_id: components['parameters']['gpg-key-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** * Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. * @@ -40305,32 +40270,32 @@ export interface operations { * * You can find the permissions for the installation under the `permissions` key. */ - "apps/list-installations-for-authenticated-user": { + 'apps/list-installations-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** You can find the permissions for the installation under the `permissions` key. */ 200: { - headers: {}; - content: { - "application/json": { - total_count: number; - installations: components["schemas"]["installation"][]; - }; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 415: components["responses"]["preview_header_missing"]; - }; - }; + headers: {} + content: { + 'application/json': { + total_count: number + installations: components['schemas']['installation'][] + } + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 415: components['responses']['preview_header_missing'] + } + } /** * List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation. * @@ -40340,116 +40305,115 @@ export interface operations { * * The access the user has to each repository is included in the hash under the `permissions` key. */ - "apps/list-installation-repos-for-authenticated-user": { + 'apps/list-installation-repos-for-authenticated-user': { parameters: { path: { /** installation_id parameter */ - installation_id: components["parameters"]["installation-id"]; - }; + installation_id: components['parameters']['installation-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** The access the user has to each repository is included in the hash under the `permissions` key. */ 200: { - headers: {}; - content: { - "application/json": { - total_count: number; - repository_selection?: string; - repositories: components["schemas"]["repository"][]; - }; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + headers: {} + content: { + 'application/json': { + total_count: number + repository_selection?: string + repositories: components['schemas']['repository'][] + } + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Add a single repository to an installation. The authenticated user must have admin access to the repository. * * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. */ - "apps/add-repo-to-installation-for-authenticated-user": { + 'apps/add-repo-to-installation-for-authenticated-user': { parameters: { path: { /** installation_id parameter */ - installation_id: components["parameters"]["installation-id"]; - repository_id: components["parameters"]["repository-id"]; - }; - }; + installation_id: components['parameters']['installation-id'] + repository_id: components['parameters']['repository-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Remove a single repository from an installation. The authenticated user must have admin access to the repository. * * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. */ - "apps/remove-repo-from-installation-for-authenticated-user": { + 'apps/remove-repo-from-installation-for-authenticated-user': { parameters: { path: { /** installation_id parameter */ - installation_id: components["parameters"]["installation-id"]; - repository_id: components["parameters"]["repository-id"]; - }; - }; - responses: { - /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + installation_id: components['parameters']['installation-id'] + repository_id: components['parameters']['repository-id'] + } + } + responses: { + /** Response */ + 204: never + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Shows which type of GitHub user can interact with your public repositories and when the restriction expires. */ - "interactions/get-restrictions-for-authenticated-user": { + 'interactions/get-restrictions-for-authenticated-user': { responses: { /** Default response */ 200: { content: { - "application/json": Partial & - Partial<{ [key: string]: unknown }>; - }; - }; + 'application/json': Partial & Partial<{ [key: string]: unknown }> + } + } /** Response when there are no restrictions */ - 204: never; - }; - }; + 204: never + } + } /** Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user. */ - "interactions/set-restrictions-for-authenticated-user": { + 'interactions/set-restrictions-for-authenticated-user': { responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["interaction-limit-response"]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['interaction-limit-response'] + } + } + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": components["schemas"]["interaction-limit"]; - }; - }; - }; + 'application/json': components['schemas']['interaction-limit'] + } + } + } /** Removes any interaction restrictions from your public repositories. */ - "interactions/remove-restrictions-for-authenticated-user": { + 'interactions/remove-restrictions-for-authenticated-user': { responses: { /** Response */ - 204: never; - }; - }; + 204: never + } + } /** * List issues across owned and member repositories assigned to the authenticated user. * @@ -40458,7 +40422,7 @@ export interface operations { * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. */ - "issues/list-for-authenticated-user": { + 'issues/list-for-authenticated-user': { parameters: { query: { /** @@ -40469,314 +40433,314 @@ export interface operations { * \* `subscribed`: Issues you're subscribed to updates for * \* `all` or `repos`: All issues the authenticated user can see, regardless of participation or creation */ - filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all"; + filter?: 'assigned' | 'created' | 'mentioned' | 'subscribed' | 'repos' | 'all' /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ - state?: "open" | "closed" | "all"; + state?: 'open' | 'closed' | 'all' /** A list of comma separated label names. Example: `bug,ui,@high` */ - labels?: components["parameters"]["labels"]; + labels?: components['parameters']['labels'] /** What to sort results by. Can be either `created`, `updated`, `comments`. */ - sort?: "created" | "updated" | "comments"; + sort?: 'created' | 'updated' | 'comments' /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["issue"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['issue'][] + } + } + 304: components['responses']['not_modified'] + 404: components['responses']['not_found'] + } + } /** Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "users/list-public-ssh-keys-for-authenticated-user": { + 'users/list-public-ssh-keys-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["key"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['key'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "users/create-public-ssh-key-for-authenticated-user": { - parameters: {}; + 'users/create-public-ssh-key-for-authenticated-user': { + parameters: {} responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["key"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['key'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description A descriptive name for the new key. * @example Personal MacBook Air */ - title?: string; + title?: string /** @description The public SSH key to add to your GitHub account. */ - key: string; - }; - }; - }; - }; + key: string + } + } + } + } /** View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "users/get-public-ssh-key-for-authenticated-user": { + 'users/get-public-ssh-key-for-authenticated-user': { parameters: { path: { /** key_id parameter */ - key_id: components["parameters"]["key-id"]; - }; - }; + key_id: components['parameters']['key-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["key"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['key'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ - "users/delete-public-ssh-key-for-authenticated-user": { + 'users/delete-public-ssh-key-for-authenticated-user': { parameters: { path: { /** key_id parameter */ - key_id: components["parameters"]["key-id"]; - }; - }; - responses: { - /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + key_id: components['parameters']['key-id'] + } + } + responses: { + /** Response */ + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Lists the active subscriptions for the authenticated user. You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an [OAuth token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/). */ - "apps/list-subscriptions-for-authenticated-user": { + 'apps/list-subscriptions-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["user-marketplace-purchase"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['user-marketplace-purchase'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 404: components['responses']['not_found'] + } + } /** Lists the active subscriptions for the authenticated user. You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an [OAuth token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/). */ - "apps/list-subscriptions-for-authenticated-user-stubbed": { + 'apps/list-subscriptions-for-authenticated-user-stubbed': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["user-marketplace-purchase"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - }; - }; - "orgs/list-memberships-for-authenticated-user": { + 'application/json': components['schemas']['user-marketplace-purchase'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + } + } + 'orgs/list-memberships-for-authenticated-user': { parameters: { query: { /** Indicates the state of the memberships to return. Can be either `active` or `pending`. If not specified, the API returns both active and pending memberships. */ - state?: "active" | "pending"; + state?: 'active' | 'pending' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["org-membership"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "orgs/get-membership-for-authenticated-user": { + 'application/json': components['schemas']['org-membership'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } + } + 'orgs/get-membership-for-authenticated-user': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["org-membership"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "orgs/update-membership-for-authenticated-user": { + 'application/json': components['schemas']['org-membership'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'orgs/update-membership-for-authenticated-user': { parameters: { path: { - org: components["parameters"]["org"]; - }; - }; + org: components['parameters']['org'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["org-membership"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['org-membership'] + } + } + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The state that the membership should be in. Only `"active"` will be accepted. * @enum {string} */ - state: "active"; - }; - }; - }; - }; + state: 'active' + } + } + } + } /** Lists all migrations a user has started. */ - "migrations/list-for-authenticated-user": { + 'migrations/list-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["migration"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['migration'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** Initiates the generation of a user migration archive. */ - "migrations/start-for-authenticated-user": { - parameters: {}; + 'migrations/start-for-authenticated-user': { + parameters: {} responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["migration"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; + 'application/json': components['schemas']['migration'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description Lock the repositories being migrated at the start of the migration * @example true */ - lock_repositories?: boolean; + lock_repositories?: boolean /** * @description Do not include attachments in the migration * @example true */ - exclude_attachments?: boolean; + exclude_attachments?: boolean /** * @description Do not include releases in the migration * @example true */ - exclude_releases?: boolean; + exclude_releases?: boolean /** * @description Indicates whether projects owned by the organization or users should be excluded. * @example true */ - exclude_owner_projects?: boolean; + exclude_owner_projects?: boolean /** * @description Exclude attributes from the API response to improve performance * @example repositories */ - exclude?: "repositories"[]; - repositories: string[]; - }; - }; - }; - }; + exclude?: 'repositories'[] + repositories: string[] + } + } + } + } /** * Fetches a single user migration. The response includes the `state` of the migration, which can be one of the following values: * @@ -40787,29 +40751,29 @@ export interface operations { * * Once the migration has been `exported` you can [download the migration archive](https://docs.github.com/rest/reference/migrations#download-a-user-migration-archive). */ - "migrations/get-status-for-authenticated-user": { + 'migrations/get-status-for-authenticated-user': { parameters: { path: { /** migration_id parameter */ - migration_id: components["parameters"]["migration-id"]; - }; + migration_id: components['parameters']['migration-id'] + } query: { - exclude?: string[]; - }; - }; + exclude?: string[] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["migration"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['migration'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Fetches the URL to download the migration archive as a `tar.gz` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects: * @@ -40833,82 +40797,82 @@ export interface operations { * * The archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data. */ - "migrations/get-archive-for-authenticated-user": { + 'migrations/get-archive-for-authenticated-user': { parameters: { path: { /** migration_id parameter */ - migration_id: components["parameters"]["migration-id"]; - }; - }; + migration_id: components['parameters']['migration-id'] + } + } responses: { /** Response */ - 302: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 302: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the [List user migrations](https://docs.github.com/rest/reference/migrations#list-user-migrations) and [Get a user migration status](https://docs.github.com/rest/reference/migrations#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted. */ - "migrations/delete-archive-for-authenticated-user": { + 'migrations/delete-archive-for-authenticated-user': { parameters: { path: { /** migration_id parameter */ - migration_id: components["parameters"]["migration-id"]; - }; - }; - responses: { - /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + migration_id: components['parameters']['migration-id'] + } + } + responses: { + /** Response */ + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Unlocks a repository. You can lock repositories when you [start a user migration](https://docs.github.com/rest/reference/migrations#start-a-user-migration). Once the migration is complete you can unlock each repository to begin using it again or [delete the repository](https://docs.github.com/rest/reference/repos#delete-a-repository) if you no longer need the source data. Returns a status of `404 Not Found` if the repository is not locked. */ - "migrations/unlock-repo-for-authenticated-user": { + 'migrations/unlock-repo-for-authenticated-user': { parameters: { path: { /** migration_id parameter */ - migration_id: components["parameters"]["migration-id"]; + migration_id: components['parameters']['migration-id'] /** repo_name parameter */ - repo_name: components["parameters"]["repo-name"]; - }; - }; - responses: { - /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + repo_name: components['parameters']['repo-name'] + } + } + responses: { + /** Response */ + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Lists all the repositories for this user migration. */ - "migrations/list-repos-for-authenticated-user": { + 'migrations/list-repos-for-authenticated-user': { parameters: { path: { /** migration_id parameter */ - migration_id: components["parameters"]["migration-id"]; - }; + migration_id: components['parameters']['migration-id'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["minimal-repository"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['minimal-repository'][] + } + } + 404: components['responses']['not_found'] + } + } /** * List organizations for the authenticated user. * @@ -40916,99 +40880,99 @@ export interface operations { * * This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response. */ - "orgs/list-for-authenticated-user": { + 'orgs/list-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["organization-simple"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['organization-simple'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** * Lists packages owned by the authenticated user within the user's namespace. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/list-packages-for-authenticated-user": { + 'packages/list-packages-for-authenticated-user': { parameters: { query: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + package_type: 'npm' | 'maven' | 'rubygems' | 'docker' | 'nuget' | 'container' /** The selected visibility of the packages. Can be one of `public`, `private`, or `internal`. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set. */ - visibility?: components["parameters"]["package-visibility"]; - }; - }; + visibility?: components['parameters']['package-visibility'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['package'][] + } + } + } + } /** * Gets a specific package for a package owned by the authenticated user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/get-package-for-authenticated-user": { + 'packages/get-package-for-authenticated-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - }; - }; + package_name: components['parameters']['package-name'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package"]; - }; - }; - }; - }; + 'application/json': components['schemas']['package'] + } + } + } + } /** * Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:delete` scopes. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/delete-package-for-authenticated-user": { + 'packages/delete-package-for-authenticated-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - }; - }; + package_name: components['parameters']['package-name'] + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Restores a package owned by the authenticated user. * @@ -41018,113 +40982,113 @@ export interface operations { * * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/restore-package-for-authenticated-user": { + 'packages/restore-package-for-authenticated-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - }; + package_name: components['parameters']['package-name'] + } query: { /** package token */ - token?: string; - }; - }; + token?: string + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Returns all package versions for a package owned by the authenticated user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/get-all-package-versions-for-package-owned-by-authenticated-user": { + 'packages/get-all-package-versions-for-package-owned-by-authenticated-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - }; + package_name: components['parameters']['package-name'] + } query: { /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** The state of the package, either active or deleted. */ - state?: "active" | "deleted"; - }; - }; + state?: 'active' | 'deleted' + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package-version"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['package-version'][] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Gets a specific package version for a package owned by the authenticated user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/get-package-version-for-authenticated-user": { + 'packages/get-package-version-for-authenticated-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; + package_name: components['parameters']['package-name'] /** Unique identifier of the package version. */ - package_version_id: components["parameters"]["package-version-id"]; - }; - }; + package_version_id: components['parameters']['package-version-id'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package-version"]; - }; - }; - }; - }; + 'application/json': components['schemas']['package-version'] + } + } + } + } /** * Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:delete` scopes. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/delete-package-version-for-authenticated-user": { + 'packages/delete-package-version-for-authenticated-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; + package_name: components['parameters']['package-name'] /** Unique identifier of the package version. */ - package_version_id: components["parameters"]["package-version-id"]; - }; - }; + package_version_id: components['parameters']['package-version-id'] + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Restores a package version owned by the authenticated user. * @@ -41134,131 +41098,131 @@ export interface operations { * * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/restore-package-version-for-authenticated-user": { + 'packages/restore-package-version-for-authenticated-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; + package_name: components['parameters']['package-name'] /** Unique identifier of the package version. */ - package_version_id: components["parameters"]["package-version-id"]; - }; - }; + package_version_id: components['parameters']['package-version-id'] + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "projects/create-for-authenticated-user": { - parameters: {}; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'projects/create-for-authenticated-user': { + parameters: {} responses: { /** Response */ 201: { content: { - "application/json": components["schemas"]["project"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 415: components["responses"]["preview_header_missing"]; - 422: components["responses"]["validation_failed_simple"]; - }; + 'application/json': components['schemas']['project'] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 415: components['responses']['preview_header_missing'] + 422: components['responses']['validation_failed_simple'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description Name of the project * @example Week One Sprint */ - name: string; + name: string /** * @description Body of the project * @example This project represents the sprint of the first week in January */ - body?: string | null; - }; - }; - }; - }; + body?: string | null + } + } + } + } /** Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope. */ - "users/list-public-emails-for-authenticated-user": { + 'users/list-public-emails-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["email"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['email'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. * * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. */ - "repos/list-for-authenticated-user": { + 'repos/list-for-authenticated-user': { parameters: { query: { /** Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`. */ - visibility?: "all" | "public" | "private"; + visibility?: 'all' | 'public' | 'private' /** * Comma-separated list of values. Can include: * \* `owner`: Repositories that are owned by the authenticated user. * \* `collaborator`: Repositories that the user has been added to as a collaborator. * \* `organization_member`: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on. */ - affiliation?: string; + affiliation?: string /** * Can be one of `all`, `owner`, `public`, `private`, `member`. Note: For GitHub AE, can be one of `all`, `owner`, `internal`, `private`, `member`. Default: `all` * * Will cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**. */ - type?: "all" | "owner" | "public" | "private" | "member"; + type?: 'all' | 'owner' | 'public' | 'private' | 'member' /** Can be one of `created`, `updated`, `pushed`, `full_name`. */ - sort?: "created" | "updated" | "pushed" | "full_name"; + sort?: 'created' | 'updated' | 'pushed' | 'full_name' /** Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc` */ - direction?: "asc" | "desc"; + direction?: 'asc' | 'desc' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + page?: components['parameters']['page'] /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - before?: components["parameters"]["before"]; - }; - }; + before?: components['parameters']['before'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["repository"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['repository'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 422: components['responses']['validation_failed'] + } + } /** * Creates a new repository for the authenticated user. * @@ -41269,323 +41233,323 @@ export interface operations { * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. * * `repo` scope to create a private repository. */ - "repos/create-for-authenticated-user": { - parameters: {}; + 'repos/create-for-authenticated-user': { + parameters: {} responses: { /** Response */ 201: { headers: { - Location?: string; - }; - content: { - "application/json": components["schemas"]["repository"]; - }; - }; - 304: components["responses"]["not_modified"]; - 400: components["responses"]["bad_request"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; + Location?: string + } + content: { + 'application/json': components['schemas']['repository'] + } + } + 304: components['responses']['not_modified'] + 400: components['responses']['bad_request'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } requestBody: { content: { - "application/json": { + 'application/json': { /** * @description The name of the repository. * @example Team Environment */ - name: string; + name: string /** @description A short description of the repository. */ - description?: string; + description?: string /** @description A URL with more information about the repository. */ - homepage?: string; + homepage?: string /** @description Whether the repository is private. */ - private?: boolean; + private?: boolean /** * @description Whether issues are enabled. * @default true * @example true */ - has_issues?: boolean; + has_issues?: boolean /** * @description Whether projects are enabled. * @default true * @example true */ - has_projects?: boolean; + has_projects?: boolean /** * @description Whether the wiki is enabled. * @default true * @example true */ - has_wiki?: boolean; + has_wiki?: boolean /** @description The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. */ - team_id?: number; + team_id?: number /** @description Whether the repository is initialized with a minimal README. */ - auto_init?: boolean; + auto_init?: boolean /** * @description The desired language or platform to apply to the .gitignore. * @example Haskell */ - gitignore_template?: string; + gitignore_template?: string /** * @description The license keyword of the open source license for this repository. * @example mit */ - license_template?: string; + license_template?: string /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - allow_squash_merge?: boolean; + allow_squash_merge?: boolean /** * @description Whether to allow merge commits for pull requests. * @default true * @example true */ - allow_merge_commit?: boolean; + allow_merge_commit?: boolean /** * @description Whether to allow rebase merges for pull requests. * @default true * @example true */ - allow_rebase_merge?: boolean; + allow_rebase_merge?: boolean /** @description Whether to allow Auto-merge to be used on pull requests. */ - allow_auto_merge?: boolean; + allow_auto_merge?: boolean /** @description Whether to delete head branches when pull requests are merged */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge?: boolean /** * @description Whether downloads are enabled. * @default true * @example true */ - has_downloads?: boolean; + has_downloads?: boolean /** * @description Whether this repository acts as a template that can be used to generate new repositories. * @example true */ - is_template?: boolean; - }; - }; - }; - }; + is_template?: boolean + } + } + } + } /** When authenticating as a user, this endpoint will list all currently open repository invitations for that user. */ - "repos/list-invitations-for-authenticated-user": { + 'repos/list-invitations-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["repository-invitation"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "repos/decline-invitation-for-authenticated-user": { + 'application/json': components['schemas']['repository-invitation'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'repos/decline-invitation-for-authenticated-user': { parameters: { path: { /** invitation_id parameter */ - invitation_id: components["parameters"]["invitation-id"]; - }; - }; + invitation_id: components['parameters']['invitation-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; - }; - }; - "repos/accept-invitation-for-authenticated-user": { + 204: never + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 409: components['responses']['conflict'] + } + } + 'repos/accept-invitation-for-authenticated-user': { parameters: { path: { /** invitation_id parameter */ - invitation_id: components["parameters"]["invitation-id"]; - }; - }; + invitation_id: components['parameters']['invitation-id'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + 409: components['responses']['conflict'] + } + } /** * Lists repositories the authenticated user has starred. * * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: */ - "activity/list-repos-starred-by-authenticated-user": { + 'activity/list-repos-starred-by-authenticated-user': { parameters: { query: { /** One of `created` (when the repository was starred) or `updated` (when it was last pushed to). */ - sort?: components["parameters"]["sort"]; + sort?: components['parameters']['sort'] /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["repository"][]; - "application/vnd.github.v3.star+json": components["schemas"]["starred-repository"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; - "activity/check-repo-is-starred-by-authenticated-user": { + 'application/json': components['schemas']['repository'][] + 'application/vnd.github.v3.star+json': components['schemas']['starred-repository'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } + 'activity/check-repo-is-starred-by-authenticated-user': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response if this repository is starred by you */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] /** Not Found if this repository is not starred by you */ 404: { content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['basic-error'] + } + } + } + } /** Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ - "activity/star-repo-for-authenticated-user": { + 'activity/star-repo-for-authenticated-user': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "activity/unstar-repo-for-authenticated-user": { + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'activity/unstar-repo-for-authenticated-user': { parameters: { path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - }; - }; + owner: components['parameters']['owner'] + repo: components['parameters']['repo'] + } + } responses: { /** Response */ - 204: never; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** Lists repositories the authenticated user is watching. */ - "activity/list-watched-repos-for-authenticated-user": { + 'activity/list-watched-repos-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["minimal-repository"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['minimal-repository'][] + } + } + 304: components['responses']['not_modified'] + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** List all of the teams across all of the organizations to which the authenticated user belongs. This method requires `user`, `repo`, or `read:org` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://docs.github.com/apps/building-oauth-apps/). */ - "teams/list-for-authenticated-user": { + 'teams/list-for-authenticated-user': { parameters: { query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["team-full"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['team-full'][] + } + } + 304: components['responses']['not_modified'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts. * * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of users. */ - "users/list": { + 'users/list': { parameters: { query: { /** A user ID. Only return users with an ID greater than this ID. */ - since?: components["parameters"]["since-user"]; + since?: components['parameters']['since-user'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; - }; - }; + per_page?: components['parameters']['per-page'] + } + } responses: { /** Response */ 200: { headers: { - Link?: string; - }; + Link?: string + } content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 304: components["responses"]["not_modified"]; - }; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + 304: components['responses']['not_modified'] + } + } /** * Provides publicly available information about someone with a GitHub account. * @@ -41595,197 +41559,197 @@ export interface operations { * * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/reference/users#emails)". */ - "users/get-by-username": { + 'users/get-by-username': { parameters: { path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["private-user"] | components["schemas"]["public-user"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['private-user'] | components['schemas']['public-user'] + } + } + 404: components['responses']['not_found'] + } + } /** If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. */ - "activity/list-events-for-authenticated-user": { + 'activity/list-events-for-authenticated-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["event"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['event'][] + } + } + } + } /** This is the user's organization dashboard. You must be authenticated as the user to view this. */ - "activity/list-org-events-for-authenticated-user": { + 'activity/list-org-events-for-authenticated-user': { parameters: { path: { - username: components["parameters"]["username"]; - org: components["parameters"]["org"]; - }; + username: components['parameters']['username'] + org: components['parameters']['org'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["event"][]; - }; - }; - }; - }; - "activity/list-public-events-for-user": { + 'application/json': components['schemas']['event'][] + } + } + } + } + 'activity/list-public-events-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["event"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['event'][] + } + } + } + } /** Lists the people following the specified user. */ - "users/list-followers-for-user": { + 'users/list-followers-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['simple-user'][] + } + } + } + } /** Lists the people who the specified user follows. */ - "users/list-following-for-user": { + 'users/list-following-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - }; - }; - "users/check-following-for-user": { + 'application/json': components['schemas']['simple-user'][] + } + } + } + } + 'users/check-following-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - target_user: string; - }; - }; + username: components['parameters']['username'] + target_user: string + } + } responses: { /** if the user follows the target user */ - 204: never; + 204: never /** if the user does not follow the target user */ - 404: unknown; - }; - }; + 404: unknown + } + } /** Lists public gists for the specified user: */ - "gists/list-for-user": { + 'gists/list-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; + since?: components['parameters']['since'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["base-gist"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['base-gist'][] + } + } + 422: components['responses']['validation_failed'] + } + } /** Lists the GPG keys for a user. This information is accessible by anyone. */ - "users/list-gpg-keys-for-user": { + 'users/list-gpg-keys-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["gpg-key"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['gpg-key'][] + } + } + } + } /** * Provides hovercard information when authenticated through basic auth or OAuth with the `repo` scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. * @@ -41796,153 +41760,153 @@ export interface operations { * https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 * ``` */ - "users/get-context-for-user": { + 'users/get-context-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, `pull_request`. **Required** when using `subject_id`. */ - subject_type?: "organization" | "repository" | "issue" | "pull_request"; + subject_type?: 'organization' | 'repository' | 'issue' | 'pull_request' /** Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`. */ - subject_id?: string; - }; - }; + subject_id?: string + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["hovercard"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['hovercard'] + } + } + 404: components['responses']['not_found'] + 422: components['responses']['validation_failed'] + } + } /** * Enables an authenticated GitHub App to find the user’s installation information. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - "apps/get-user-installation": { + 'apps/get-user-installation': { parameters: { path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["installation"]; - }; - }; - }; - }; + 'application/json': components['schemas']['installation'] + } + } + } + } /** Lists the _verified_ public SSH keys for a user. This is accessible by anyone. */ - "users/list-public-keys-for-user": { + 'users/list-public-keys-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["key-simple"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['key-simple'][] + } + } + } + } /** * List [public organization memberships](https://docs.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user. * * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/rest/reference/orgs#list-organizations-for-the-authenticated-user) API instead. */ - "orgs/list-for-user": { + 'orgs/list-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["organization-simple"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['organization-simple'][] + } + } + } + } /** * Lists all packages in a user's namespace for which the requesting user has access. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/list-packages-for-user": { + 'packages/list-packages-for-user': { parameters: { query: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + package_type: 'npm' | 'maven' | 'rubygems' | 'docker' | 'nuget' | 'container' /** The selected visibility of the packages. Can be one of `public`, `private`, or `internal`. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set. */ - visibility?: components["parameters"]["package-visibility"]; - }; + visibility?: components['parameters']['package-visibility'] + } path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; + 'application/json': components['schemas']['package'][] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + } + } /** * Gets a specific package metadata for a public package owned by a user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/get-package-for-user": { + 'packages/get-package-for-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - username: components["parameters"]["username"]; - }; - }; + package_name: components['parameters']['package-name'] + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package"]; - }; - }; - }; - }; + 'application/json': components['schemas']['package'] + } + } + } + } /** * Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * @@ -41950,24 +41914,24 @@ export interface operations { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. */ - "packages/delete-package-for-user": { + 'packages/delete-package-for-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - username: components["parameters"]["username"]; - }; - }; + package_name: components['parameters']['package-name'] + username: components['parameters']['username'] + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Restores an entire package for a user. * @@ -41979,83 +41943,83 @@ export interface operations { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. */ - "packages/restore-package-for-user": { + 'packages/restore-package-for-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - username: components["parameters"]["username"]; - }; + package_name: components['parameters']['package-name'] + username: components['parameters']['username'] + } query: { /** package token */ - token?: string; - }; - }; + token?: string + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Returns all package versions for a public package owned by a specified user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/get-all-package-versions-for-package-owned-by-user": { + 'packages/get-all-package-versions-for-package-owned-by-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - username: components["parameters"]["username"]; - }; - }; + package_name: components['parameters']['package-name'] + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package-version"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 'application/json': components['schemas']['package-version'][] + } + } + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Gets a specific package version for a public package owned by a specified user. * * At this time, to use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/get-package-version-for-user": { + 'packages/get-package-version-for-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; + package_name: components['parameters']['package-name'] /** Unique identifier of the package version. */ - package_version_id: components["parameters"]["package-version-id"]; - username: components["parameters"]["username"]; - }; - }; + package_version_id: components['parameters']['package-version-id'] + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["package-version"]; - }; - }; - }; - }; + 'application/json': components['schemas']['package-version'] + } + } + } + } /** * Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * @@ -42063,26 +42027,26 @@ export interface operations { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. */ - "packages/delete-package-version-for-user": { + 'packages/delete-package-version-for-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - username: components["parameters"]["username"]; + package_name: components['parameters']['package-name'] + username: components['parameters']['username'] /** Unique identifier of the package version. */ - package_version_id: components["parameters"]["package-version-id"]; - }; - }; + package_version_id: components['parameters']['package-version-id'] + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } /** * Restores a specific package version for a user. * @@ -42094,123 +42058,123 @@ export interface operations { * - If `package_type` is not `container`, your token must also include the `repo` scope. * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. */ - "packages/restore-package-version-for-user": { + 'packages/restore-package-version-for-user': { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; + package_type: components['parameters']['package-type'] /** The name of the package. */ - package_name: components["parameters"]["package-name"]; - username: components["parameters"]["username"]; + package_name: components['parameters']['package-name'] + username: components['parameters']['username'] /** Unique identifier of the package version. */ - package_version_id: components["parameters"]["package-version-id"]; - }; - }; + package_version_id: components['parameters']['package-version-id'] + } + } responses: { /** Response */ - 204: never; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "projects/list-for-user": { + 204: never + 401: components['responses']['requires_authentication'] + 403: components['responses']['forbidden'] + 404: components['responses']['not_found'] + } + } + 'projects/list-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. */ - state?: "open" | "closed" | "all"; + state?: 'open' | 'closed' | 'all' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["project"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; - }; + 'application/json': components['schemas']['project'][] + } + } + 422: components['responses']['validation_failed'] + } + } /** These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. */ - "activity/list-received-events-for-user": { + 'activity/list-received-events-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["event"][]; - }; - }; - }; - }; - "activity/list-received-public-events-for-user": { + 'application/json': components['schemas']['event'][] + } + } + } + } + 'activity/list-received-public-events-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["event"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['event'][] + } + } + } + } /** Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user. */ - "repos/list-for-user": { + 'repos/list-for-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Can be one of `all`, `owner`, `member`. */ - type?: "all" | "owner" | "member"; + type?: 'all' | 'owner' | 'member' /** Can be one of `created`, `updated`, `pushed`, `full_name`. */ - sort?: "created" | "updated" | "pushed" | "full_name"; + sort?: 'created' | 'updated' | 'pushed' | 'full_name' /** Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc` */ - direction?: "asc" | "desc"; + direction?: 'asc' | 'desc' /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["minimal-repository"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['minimal-repository'][] + } + } + } + } /** * Gets the summary of the free and paid GitHub Actions minutes used. * @@ -42218,21 +42182,21 @@ export interface operations { * * Access tokens must have the `user` scope. */ - "billing/get-github-actions-billing-user": { + 'billing/get-github-actions-billing-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["actions-billing-usage"]; - }; - }; - }; - }; + 'application/json': components['schemas']['actions-billing-usage'] + } + } + } + } /** * Gets the free and paid storage used for GitHub Packages in gigabytes. * @@ -42240,21 +42204,21 @@ export interface operations { * * Access tokens must have the `user` scope. */ - "billing/get-github-packages-billing-user": { + 'billing/get-github-packages-billing-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["packages-billing-usage"]; - }; - }; - }; - }; + 'application/json': components['schemas']['packages-billing-usage'] + } + } + } + } /** * Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. * @@ -42262,87 +42226,86 @@ export interface operations { * * Access tokens must have the `user` scope. */ - "billing/get-shared-storage-billing-user": { + 'billing/get-shared-storage-billing-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; - }; + username: components['parameters']['username'] + } + } responses: { /** Response */ 200: { content: { - "application/json": components["schemas"]["combined-billing-usage"]; - }; - }; - }; - }; + 'application/json': components['schemas']['combined-billing-usage'] + } + } + } + } /** * Lists repositories a user has starred. * * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: */ - "activity/list-repos-starred-by-user": { + 'activity/list-repos-starred-by-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** One of `created` (when the repository was starred) or `updated` (when it was last pushed to). */ - sort?: components["parameters"]["sort"]; + sort?: components['parameters']['sort'] /** One of `asc` (ascending) or `desc` (descending). */ - direction?: components["parameters"]["direction"]; + direction?: components['parameters']['direction'] /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": Partial & - Partial; - }; - }; - }; - }; + 'application/json': Partial & Partial + } + } + } + } /** Lists repositories a user is watching. */ - "activity/list-repos-watched-by-user": { + 'activity/list-repos-watched-by-user': { parameters: { path: { - username: components["parameters"]["username"]; - }; + username: components['parameters']['username'] + } query: { /** Results per page (max 100) */ - per_page?: components["parameters"]["per-page"]; + per_page?: components['parameters']['per-page'] /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - }; + page?: components['parameters']['page'] + } + } responses: { /** Response */ 200: { - headers: {}; + headers: {} content: { - "application/json": components["schemas"]["minimal-repository"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['minimal-repository'][] + } + } + } + } /** Get a random sentence from the Zen of GitHub */ - "meta/get-zen": { + 'meta/get-zen': { responses: { /** Response */ 200: { content: { - "text/plain": string; - }; - }; - }; - }; + 'text/plain': string + } + } + } + } } export interface external {} diff --git a/test/v3/expected/jsdoc.additional.ts b/test/v3/expected/jsdoc.additional.ts index 70b7b7d76..92ee6ef3e 100644 --- a/test/v3/expected/jsdoc.additional.ts +++ b/test/v3/expected/jsdoc.additional.ts @@ -4,22 +4,22 @@ */ export interface paths { - "/contacts": { - get: operations["getContacts"]; - }; - "/contacts/{userUid}": { - get: operations["getContactInfo"]; - }; - "/contacts/{userUid}/icon": { - get: operations["getContactIcon"]; - }; - "/contacts/me": { - get: operations["getMyInfo"]; - }; - "/contacts/me/icon": { - get: operations["getMyIcon"]; - delete: operations["deleteMyIcon"]; - }; + '/contacts': { + get: operations['getContacts'] + } + '/contacts/{userUid}': { + get: operations['getContactInfo'] + } + '/contacts/{userUid}/icon': { + get: operations['getContactIcon'] + } + '/contacts/me': { + get: operations['getMyInfo'] + } + '/contacts/me/icon': { + get: operations['getMyIcon'] + delete: operations['deleteMyIcon'] + } } export interface components { @@ -32,51 +32,51 @@ export interface components { * @description Test description with deprecated * @example njbusD52k6YoRG346tPgD */ - uid?: string; + uid?: string /** * Format: date-time * @description It's date example * @example 1999-03-31 15:00:00.000 */ - created_at?: string; + created_at?: string /** * Format: date-time * @example 2020-07-10 10:10:00.000 */ - updated_at?: string; - deleted?: boolean; - } & { [key: string]: unknown }; + updated_at?: string + deleted?: boolean + } & { [key: string]: unknown } /** Image for preview */ Image: { /** @example https://shantichat.com/data/V1StGXR8_Z5jdHi6B-myT/white-rabbit.png */ - url: string; + url: string /** @example 128 */ - width: unknown; + width: unknown /** @example 128 */ - height: unknown; + height: unknown /** @example LEHV6nWB2yk8pyo0adR*.7kCMdnj */ - blurhash?: string; - } & { [key: string]: unknown }; + blurhash?: string + } & { [key: string]: unknown } /** User object */ - User: components["schemas"]["BaseEntity"] & + User: components['schemas']['BaseEntity'] & ({ /** @example Thomas A. Anderson */ - name?: string; + name?: string /** * @default test * @example The One */ - description?: string; - icon?: components["schemas"]["Image"]; + description?: string + icon?: components['schemas']['Image'] /** @example America/Chicago */ - timezone?: string; + timezone?: string /** * Format: date-time * @example 2020-07-10 15:00:00.000 */ - last_online_at?: string; - } & { [key: string]: unknown }) & { [key: string]: unknown }; - }; + last_online_at?: string + } & { [key: string]: unknown }) & { [key: string]: unknown } + } } export interface operations { @@ -85,67 +85,67 @@ export interface operations { /** OK */ 200: { content: { - "application/json": components["schemas"]["User"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['User'][] + } + } + } + } getContactInfo: { parameters: { path: { - userUid: string; - }; - }; + userUid: string + } + } responses: { /** OK */ 200: { content: { - "application/json": components["schemas"]["User"]; - }; - }; - }; - }; + 'application/json': components['schemas']['User'] + } + } + } + } getContactIcon: { parameters: { path: { - userUid: string; - }; - }; + userUid: string + } + } responses: { /** OK */ 200: { content: { - "application/json": components["schemas"]["Image"]; - }; - }; - }; - }; + 'application/json': components['schemas']['Image'] + } + } + } + } getMyInfo: { responses: { /** OK */ 200: { content: { - "application/json": components["schemas"]["User"]; - }; - }; - }; - }; + 'application/json': components['schemas']['User'] + } + } + } + } getMyIcon: { responses: { /** OK */ 200: { content: { - "application/json": components["schemas"]["Image"]; - }; - }; - }; - }; + 'application/json': components['schemas']['Image'] + } + } + } + } deleteMyIcon: { responses: { /** OK */ - 200: unknown; - }; - }; + 200: unknown + } + } } export interface external {} diff --git a/test/v3/expected/jsdoc.exported-type.ts b/test/v3/expected/jsdoc.exported-type.ts index 2fdfe5104..a4fbf5e5d 100644 --- a/test/v3/expected/jsdoc.exported-type.ts +++ b/test/v3/expected/jsdoc.exported-type.ts @@ -4,23 +4,23 @@ */ export type paths = { - "/contacts": { - get: operations["getContacts"]; - }; - "/contacts/{userUid}": { - get: operations["getContactInfo"]; - }; - "/contacts/{userUid}/icon": { - get: operations["getContactIcon"]; - }; - "/contacts/me": { - get: operations["getMyInfo"]; - }; - "/contacts/me/icon": { - get: operations["getMyIcon"]; - delete: operations["deleteMyIcon"]; - }; -}; + '/contacts': { + get: operations['getContacts'] + } + '/contacts/{userUid}': { + get: operations['getContactInfo'] + } + '/contacts/{userUid}/icon': { + get: operations['getContactIcon'] + } + '/contacts/me': { + get: operations['getMyInfo'] + } + '/contacts/me/icon': { + get: operations['getMyIcon'] + delete: operations['deleteMyIcon'] + } +} export type components = { schemas: { @@ -32,51 +32,51 @@ export type components = { * @description Test description with deprecated * @example njbusD52k6YoRG346tPgD */ - uid?: string; + uid?: string /** * Format: date-time * @description It's date example * @example 1999-03-31 15:00:00.000 */ - created_at?: string; + created_at?: string /** * Format: date-time * @example 2020-07-10 10:10:00.000 */ - updated_at?: string; - deleted?: boolean; - }; + updated_at?: string + deleted?: boolean + } /** Image for preview */ Image: { /** @example https://shantichat.com/data/V1StGXR8_Z5jdHi6B-myT/white-rabbit.png */ - url: string; + url: string /** @example 128 */ - width: unknown; + width: unknown /** @example 128 */ - height: unknown; + height: unknown /** @example LEHV6nWB2yk8pyo0adR*.7kCMdnj */ - blurhash?: string; - }; + blurhash?: string + } /** User object */ - User: components["schemas"]["BaseEntity"] & { + User: components['schemas']['BaseEntity'] & { /** @example Thomas A. Anderson */ - name?: string; + name?: string /** * @default test * @example The One */ - description?: string; - icon?: components["schemas"]["Image"]; + description?: string + icon?: components['schemas']['Image'] /** @example America/Chicago */ - timezone?: string; + timezone?: string /** * Format: date-time * @example 2020-07-10 15:00:00.000 */ - last_online_at?: string; - }; - }; -}; + last_online_at?: string + } + } +} export type operations = { getContacts: { @@ -84,67 +84,67 @@ export type operations = { /** OK */ 200: { content: { - "application/json": components["schemas"]["User"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['User'][] + } + } + } + } getContactInfo: { parameters: { path: { - userUid: string; - }; - }; + userUid: string + } + } responses: { /** OK */ 200: { content: { - "application/json": components["schemas"]["User"]; - }; - }; - }; - }; + 'application/json': components['schemas']['User'] + } + } + } + } getContactIcon: { parameters: { path: { - userUid: string; - }; - }; + userUid: string + } + } responses: { /** OK */ 200: { content: { - "application/json": components["schemas"]["Image"]; - }; - }; - }; - }; + 'application/json': components['schemas']['Image'] + } + } + } + } getMyInfo: { responses: { /** OK */ 200: { content: { - "application/json": components["schemas"]["User"]; - }; - }; - }; - }; + 'application/json': components['schemas']['User'] + } + } + } + } getMyIcon: { responses: { /** OK */ 200: { content: { - "application/json": components["schemas"]["Image"]; - }; - }; - }; - }; + 'application/json': components['schemas']['Image'] + } + } + } + } deleteMyIcon: { responses: { /** OK */ - 200: unknown; - }; - }; -}; + 200: unknown + } + } +} -export type external = {}; +export type external = {} diff --git a/test/v3/expected/jsdoc.immutable.ts b/test/v3/expected/jsdoc.immutable.ts index 392cae5df..2c3961643 100644 --- a/test/v3/expected/jsdoc.immutable.ts +++ b/test/v3/expected/jsdoc.immutable.ts @@ -4,22 +4,22 @@ */ export interface paths { - readonly "/contacts": { - readonly get: operations["getContacts"]; - }; - readonly "/contacts/{userUid}": { - readonly get: operations["getContactInfo"]; - }; - readonly "/contacts/{userUid}/icon": { - readonly get: operations["getContactIcon"]; - }; - readonly "/contacts/me": { - readonly get: operations["getMyInfo"]; - }; - readonly "/contacts/me/icon": { - readonly get: operations["getMyIcon"]; - readonly delete: operations["deleteMyIcon"]; - }; + readonly '/contacts': { + readonly get: operations['getContacts'] + } + readonly '/contacts/{userUid}': { + readonly get: operations['getContactInfo'] + } + readonly '/contacts/{userUid}/icon': { + readonly get: operations['getContactIcon'] + } + readonly '/contacts/me': { + readonly get: operations['getMyInfo'] + } + readonly '/contacts/me/icon': { + readonly get: operations['getMyIcon'] + readonly delete: operations['deleteMyIcon'] + } } export interface components { @@ -32,50 +32,50 @@ export interface components { * @description Test description with deprecated * @example njbusD52k6YoRG346tPgD */ - readonly uid?: string; + readonly uid?: string /** * Format: date-time * @description It's date example * @example 1999-03-31 15:00:00.000 */ - readonly created_at?: string; + readonly created_at?: string /** * Format: date-time * @example 2020-07-10 10:10:00.000 */ - readonly updated_at?: string; - readonly deleted?: boolean; - }; + readonly updated_at?: string + readonly deleted?: boolean + } /** Image for preview */ readonly Image: { /** @example https://shantichat.com/data/V1StGXR8_Z5jdHi6B-myT/white-rabbit.png */ - readonly url: string; + readonly url: string /** @example 128 */ - readonly width: unknown; + readonly width: unknown /** @example 128 */ - readonly height: unknown; + readonly height: unknown /** @example LEHV6nWB2yk8pyo0adR*.7kCMdnj */ - readonly blurhash?: string; - }; + readonly blurhash?: string + } /** User object */ - readonly User: components["schemas"]["BaseEntity"] & { + readonly User: components['schemas']['BaseEntity'] & { /** @example Thomas A. Anderson */ - readonly name?: string; + readonly name?: string /** * @default test * @example The One */ - readonly description?: string; - readonly icon?: components["schemas"]["Image"]; + readonly description?: string + readonly icon?: components['schemas']['Image'] /** @example America/Chicago */ - readonly timezone?: string; + readonly timezone?: string /** * Format: date-time * @example 2020-07-10 15:00:00.000 */ - readonly last_online_at?: string; - }; - }; + readonly last_online_at?: string + } + } } export interface operations { @@ -84,67 +84,67 @@ export interface operations { /** OK */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["User"][]; - }; - }; - }; - }; + readonly 'application/json': readonly components['schemas']['User'][] + } + } + } + } readonly getContactInfo: { readonly parameters: { readonly path: { - readonly userUid: string; - }; - }; + readonly userUid: string + } + } readonly responses: { /** OK */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["User"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['User'] + } + } + } + } readonly getContactIcon: { readonly parameters: { readonly path: { - readonly userUid: string; - }; - }; + readonly userUid: string + } + } readonly responses: { /** OK */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["Image"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['Image'] + } + } + } + } readonly getMyInfo: { readonly responses: { /** OK */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["User"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['User'] + } + } + } + } readonly getMyIcon: { readonly responses: { /** OK */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["Image"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['Image'] + } + } + } + } readonly deleteMyIcon: { readonly responses: { /** OK */ - readonly 200: unknown; - }; - }; + readonly 200: unknown + } + } } export interface external {} diff --git a/test/v3/expected/jsdoc.support-array-length.ts b/test/v3/expected/jsdoc.support-array-length.ts index b11e684c5..70bcda2a2 100644 --- a/test/v3/expected/jsdoc.support-array-length.ts +++ b/test/v3/expected/jsdoc.support-array-length.ts @@ -4,22 +4,22 @@ */ export interface paths { - "/contacts": { - get: operations["getContacts"]; - }; - "/contacts/{userUid}": { - get: operations["getContactInfo"]; - }; - "/contacts/{userUid}/icon": { - get: operations["getContactIcon"]; - }; - "/contacts/me": { - get: operations["getMyInfo"]; - }; - "/contacts/me/icon": { - get: operations["getMyIcon"]; - delete: operations["deleteMyIcon"]; - }; + '/contacts': { + get: operations['getContacts'] + } + '/contacts/{userUid}': { + get: operations['getContactInfo'] + } + '/contacts/{userUid}/icon': { + get: operations['getContactIcon'] + } + '/contacts/me': { + get: operations['getMyInfo'] + } + '/contacts/me/icon': { + get: operations['getMyIcon'] + delete: operations['deleteMyIcon'] + } } export interface components { @@ -32,50 +32,50 @@ export interface components { * @description Test description with deprecated * @example njbusD52k6YoRG346tPgD */ - uid?: string; + uid?: string /** * Format: date-time * @description It's date example * @example 1999-03-31 15:00:00.000 */ - created_at?: string; + created_at?: string /** * Format: date-time * @example 2020-07-10 10:10:00.000 */ - updated_at?: string; - deleted?: boolean; - }; + updated_at?: string + deleted?: boolean + } /** Image for preview */ Image: { /** @example https://shantichat.com/data/V1StGXR8_Z5jdHi6B-myT/white-rabbit.png */ - url: string; + url: string /** @example 128 */ - width: unknown; + width: unknown /** @example 128 */ - height: unknown; + height: unknown /** @example LEHV6nWB2yk8pyo0adR*.7kCMdnj */ - blurhash?: string; - }; + blurhash?: string + } /** User object */ - User: components["schemas"]["BaseEntity"] & { + User: components['schemas']['BaseEntity'] & { /** @example Thomas A. Anderson */ - name?: string; + name?: string /** * @default test * @example The One */ - description?: string; - icon?: components["schemas"]["Image"]; + description?: string + icon?: components['schemas']['Image'] /** @example America/Chicago */ - timezone?: string; + timezone?: string /** * Format: date-time * @example 2020-07-10 15:00:00.000 */ - last_online_at?: string; - }; - }; + last_online_at?: string + } + } } export interface operations { @@ -84,67 +84,67 @@ export interface operations { /** OK */ 200: { content: { - "application/json": components["schemas"]["User"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['User'][] + } + } + } + } getContactInfo: { parameters: { path: { - userUid: string; - }; - }; + userUid: string + } + } responses: { /** OK */ 200: { content: { - "application/json": components["schemas"]["User"]; - }; - }; - }; - }; + 'application/json': components['schemas']['User'] + } + } + } + } getContactIcon: { parameters: { path: { - userUid: string; - }; - }; + userUid: string + } + } responses: { /** OK */ 200: { content: { - "application/json": components["schemas"]["Image"]; - }; - }; - }; - }; + 'application/json': components['schemas']['Image'] + } + } + } + } getMyInfo: { responses: { /** OK */ 200: { content: { - "application/json": components["schemas"]["User"]; - }; - }; - }; - }; + 'application/json': components['schemas']['User'] + } + } + } + } getMyIcon: { responses: { /** OK */ 200: { content: { - "application/json": components["schemas"]["Image"]; - }; - }; - }; - }; + 'application/json': components['schemas']['Image'] + } + } + } + } deleteMyIcon: { responses: { /** OK */ - 200: unknown; - }; - }; + 200: unknown + } + } } export interface external {} diff --git a/test/v3/expected/jsdoc.ts b/test/v3/expected/jsdoc.ts index b11e684c5..70bcda2a2 100644 --- a/test/v3/expected/jsdoc.ts +++ b/test/v3/expected/jsdoc.ts @@ -4,22 +4,22 @@ */ export interface paths { - "/contacts": { - get: operations["getContacts"]; - }; - "/contacts/{userUid}": { - get: operations["getContactInfo"]; - }; - "/contacts/{userUid}/icon": { - get: operations["getContactIcon"]; - }; - "/contacts/me": { - get: operations["getMyInfo"]; - }; - "/contacts/me/icon": { - get: operations["getMyIcon"]; - delete: operations["deleteMyIcon"]; - }; + '/contacts': { + get: operations['getContacts'] + } + '/contacts/{userUid}': { + get: operations['getContactInfo'] + } + '/contacts/{userUid}/icon': { + get: operations['getContactIcon'] + } + '/contacts/me': { + get: operations['getMyInfo'] + } + '/contacts/me/icon': { + get: operations['getMyIcon'] + delete: operations['deleteMyIcon'] + } } export interface components { @@ -32,50 +32,50 @@ export interface components { * @description Test description with deprecated * @example njbusD52k6YoRG346tPgD */ - uid?: string; + uid?: string /** * Format: date-time * @description It's date example * @example 1999-03-31 15:00:00.000 */ - created_at?: string; + created_at?: string /** * Format: date-time * @example 2020-07-10 10:10:00.000 */ - updated_at?: string; - deleted?: boolean; - }; + updated_at?: string + deleted?: boolean + } /** Image for preview */ Image: { /** @example https://shantichat.com/data/V1StGXR8_Z5jdHi6B-myT/white-rabbit.png */ - url: string; + url: string /** @example 128 */ - width: unknown; + width: unknown /** @example 128 */ - height: unknown; + height: unknown /** @example LEHV6nWB2yk8pyo0adR*.7kCMdnj */ - blurhash?: string; - }; + blurhash?: string + } /** User object */ - User: components["schemas"]["BaseEntity"] & { + User: components['schemas']['BaseEntity'] & { /** @example Thomas A. Anderson */ - name?: string; + name?: string /** * @default test * @example The One */ - description?: string; - icon?: components["schemas"]["Image"]; + description?: string + icon?: components['schemas']['Image'] /** @example America/Chicago */ - timezone?: string; + timezone?: string /** * Format: date-time * @example 2020-07-10 15:00:00.000 */ - last_online_at?: string; - }; - }; + last_online_at?: string + } + } } export interface operations { @@ -84,67 +84,67 @@ export interface operations { /** OK */ 200: { content: { - "application/json": components["schemas"]["User"][]; - }; - }; - }; - }; + 'application/json': components['schemas']['User'][] + } + } + } + } getContactInfo: { parameters: { path: { - userUid: string; - }; - }; + userUid: string + } + } responses: { /** OK */ 200: { content: { - "application/json": components["schemas"]["User"]; - }; - }; - }; - }; + 'application/json': components['schemas']['User'] + } + } + } + } getContactIcon: { parameters: { path: { - userUid: string; - }; - }; + userUid: string + } + } responses: { /** OK */ 200: { content: { - "application/json": components["schemas"]["Image"]; - }; - }; - }; - }; + 'application/json': components['schemas']['Image'] + } + } + } + } getMyInfo: { responses: { /** OK */ 200: { content: { - "application/json": components["schemas"]["User"]; - }; - }; - }; - }; + 'application/json': components['schemas']['User'] + } + } + } + } getMyIcon: { responses: { /** OK */ 200: { content: { - "application/json": components["schemas"]["Image"]; - }; - }; - }; - }; + 'application/json': components['schemas']['Image'] + } + } + } + } deleteMyIcon: { responses: { /** OK */ - 200: unknown; - }; - }; + 200: unknown + } + } } export interface external {} diff --git a/test/v3/expected/manifold.additional.ts b/test/v3/expected/manifold.additional.ts index e3f70acd3..ccff5ad3c 100644 --- a/test/v3/expected/manifold.additional.ts +++ b/test/v3/expected/manifold.additional.ts @@ -4,286 +4,286 @@ */ export interface paths { - "/regions/": { + '/regions/': { get: { parameters: { query: { /** Filter results to only include the regions that have this location. */ - location?: string; + location?: string /** * Filter results to only include the regions that are on this * platform. */ - platform?: string; - }; - }; + platform?: string + } + } responses: { /** A list of regions. */ 200: { content: { - "application/json": components["schemas"]["Region"][]; - }; - }; + 'application/json': components['schemas']['Region'][] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } + } post: { responses: { /** Complete region object */ 201: { content: { - "application/json": components["schemas"]["Region"]; - }; - }; + 'application/json': components['schemas']['Region'] + } + } /** Invalid request provided */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Region already exists for that platform and location */ 409: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } /** Region create request */ requestBody: { content: { - "application/json": components["schemas"]["CreateRegion"]; - }; - }; - }; - }; - "/regions/{id}": { + 'application/json': components['schemas']['CreateRegion'] + } + } + } + } + '/regions/{id}': { get: { parameters: { path: { /** ID of the region to lookup, stored as a base32 encoded 18 byte identifier. */ - id: string; - }; - }; + id: string + } + } responses: { /** A region. */ 200: { content: { - "application/json": components["schemas"]["Region"]; - }; - }; + 'application/json': components['schemas']['Region'] + } + } /** Provided Region ID is Invalid */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Region could not be found */ 404: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } + } patch: { parameters: { path: { /** ID of the region to lookup, stored as a base32 encoded 18 byte identifier. */ - id: string; - }; - }; + id: string + } + } responses: { /** Complete region object */ 200: { content: { - "application/json": components["schemas"]["Region"]; - }; - }; + 'application/json': components['schemas']['Region'] + } + } /** Invalid request provided */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } /** Region update request */ requestBody: { content: { - "application/json": components["schemas"]["UpdateRegion"]; - }; - }; - }; - }; - "/providers/": { + 'application/json': components['schemas']['UpdateRegion'] + } + } + } + } + '/providers/': { get: { parameters: { query: { /** Filter results to only include those that have this label. */ - label?: string; - }; - }; + label?: string + } + } responses: { /** A list of providers. */ 200: { content: { - "application/json": components["schemas"]["Provider"][]; - }; - }; + 'application/json': components['schemas']['Provider'][] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } + } post: { responses: { /** Complete provider object */ 201: { content: { - "application/json": components["schemas"]["Provider"]; - }; - }; + 'application/json': components['schemas']['Provider'] + } + } /** Invalid request provided */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Forbidden */ 403: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Provider already exists with that label */ 409: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } /** Provider create request */ requestBody: { content: { - "application/json": components["schemas"]["CreateProvider"]; - }; - }; - }; - }; - "/providers/{id}": { + 'application/json': components['schemas']['CreateProvider'] + } + } + } + } + '/providers/{id}': { get: { parameters: { path: { /** ID of the provider to lookup, stored as a base32 encoded 18 byte identifier. */ - id: string; - }; - }; + id: string + } + } responses: { /** A provider. */ 200: { content: { - "application/json": components["schemas"]["Provider"]; - }; - }; + 'application/json': components['schemas']['Provider'] + } + } /** Unknown provider error */ 404: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } + } patch: { parameters: { path: { /** ID of the provider to update, stored as a base32 encoded 18 byte identifier. */ - id: string; - }; - }; + id: string + } + } responses: { /** Complete provider object */ 200: { content: { - "application/json": components["schemas"]["Provider"]; - }; - }; + 'application/json': components['schemas']['Provider'] + } + } /** Invalid request provided */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Forbidden */ 403: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Provider not found */ 404: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Provider already exists with that label */ 409: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } /** Provider update request */ requestBody: { content: { - "application/json": components["schemas"]["UpdateProvider"]; - }; - }; - }; - }; - "/products/": { + 'application/json': components['schemas']['UpdateProvider'] + } + } + } + } + '/products/': { get: { parameters: { query: { @@ -291,76 +291,76 @@ export interface paths { * Base32 encoded 18 byte identifier of the provider that these * products must belong to. */ - provider_id?: string; + provider_id?: string /** Filter results to only include those that have this label. */ - label?: string; + label?: string /** Return only products matching at least one of the tags. */ - tags?: string[]; - }; - }; + tags?: string[] + } + } responses: { /** A product. */ 200: { content: { - "application/json": components["schemas"]["Product"][]; - }; - }; + 'application/json': components['schemas']['Product'][] + } + } /** Invalid provider_id supplied */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } + } post: { responses: { /** Complete product object */ 201: { content: { - "application/json": components["schemas"]["Product"]; - }; - }; + 'application/json': components['schemas']['Product'] + } + } /** Invalid request provided */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Forbidden */ 403: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Product already exists with that label */ 409: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } /** Product create request */ requestBody: { content: { - "application/json": components["schemas"]["CreateProduct"]; - }; - }; - }; - }; - "/internal/products": { + 'application/json': components['schemas']['CreateProduct'] + } + } + } + } + '/internal/products': { get: { parameters: { query: { @@ -368,38 +368,38 @@ export interface paths { * Base32 encoded 18 byte identifier of the provider that these * products must belong to. */ - provider_id?: string; + provider_id?: string /** Filter results to only include those that have this label. */ - label?: string; + label?: string /** Return only products matching at least one of the tags. */ - tags?: string[]; + tags?: string[] /** Return product listings without plan information */ - include_plans?: boolean; - }; - }; + include_plans?: boolean + } + } responses: { /** A product. */ 200: { content: { - "application/json": components["schemas"]["ExpandedProduct"][]; - }; - }; + 'application/json': components['schemas']['ExpandedProduct'][] + } + } /** Invalid provider_id supplied */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; - }; - "/products/{id}": { + 'application/json': components['schemas']['Error'] + } + } + } + } + } + '/products/{id}': { get: { parameters: { path: { @@ -407,36 +407,36 @@ export interface paths { * ID of the product to lookup, stored as a base32 encoded 18 byte * identifier. */ - id: string; - }; - }; + id: string + } + } responses: { /** A product. */ 200: { content: { - "application/json": components["schemas"]["Product"]; - }; - }; + 'application/json': components['schemas']['Product'] + } + } /** Invalid Product ID */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Product not found error */ 404: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } + } patch: { parameters: { path: { @@ -444,44 +444,44 @@ export interface paths { * ID of the product to lookup, stored as a base32 encoded 18 byte * identifier. */ - id: string; - }; - }; + id: string + } + } responses: { /** Complete product object */ 200: { content: { - "application/json": components["schemas"]["Product"]; - }; - }; + 'application/json': components['schemas']['Product'] + } + } /** Invalid Product ID */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Product not found error */ 404: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } /** Product update request */ requestBody: { content: { - "application/json": components["schemas"]["UpdateProduct"]; - }; - }; - }; - }; - "/plans/{id}": { + 'application/json': components['schemas']['UpdateProduct'] + } + } + } + } + '/plans/{id}': { get: { parameters: { path: { @@ -489,36 +489,36 @@ export interface paths { * ID of the plan to lookup, stored as a base32 encoded 18 byte * identifier. */ - id: string; - }; - }; + id: string + } + } responses: { /** A plan. */ 200: { content: { - "application/json": components["schemas"]["ExpandedPlan"]; - }; - }; + 'application/json': components['schemas']['ExpandedPlan'] + } + } /** Invalid Plan ID Provided */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unknown plan error */ 404: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected error */ default: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } + } patch: { parameters: { path: { @@ -526,121 +526,121 @@ export interface paths { * ID of the plan to lookup, stored as a base32 encoded 18 byte * identifier. */ - id: string; - }; - }; + id: string + } + } responses: { /** Complete product plan */ 200: { content: { - "application/json": components["schemas"]["Plan"]; - }; - }; + 'application/json': components['schemas']['Plan'] + } + } /** Invalid Plan ID */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Plan not found error */ 404: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } /** Plan update request */ requestBody: { content: { - "application/json": components["schemas"]["UpdatePlan"]; - }; - }; - }; - }; - "/plans/": { + 'application/json': components['schemas']['UpdatePlan'] + } + } + } + } + '/plans/': { get: { parameters: { query: { /** Return the plans that are associated with this product. */ - product_id: string[]; + product_id: string[] /** Filter results to only include those that have this label. */ - label?: string; - }; - }; + label?: string + } + } responses: { /** A list of plans for the given product. */ 200: { content: { - "application/json": components["schemas"]["ExpandedPlan"][]; - }; - }; + 'application/json': components['schemas']['ExpandedPlan'][] + } + } /** Invalid Parameters Provided */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Could not find product */ 404: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } + } post: { responses: { /** Complete plan object */ 201: { content: { - "application/json": components["schemas"]["Plan"]; - }; - }; + 'application/json': components['schemas']['Plan'] + } + } /** Invalid request provided */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Forbidden */ 403: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Plan already exists with that label */ 409: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } /** Plan create request */ requestBody: { content: { - "application/json": components["schemas"]["CreatePlan"]; - }; - }; - }; - }; + 'application/json': components['schemas']['CreatePlan'] + } + } + } + } } export interface components { @@ -649,204 +649,204 @@ export interface components { * Format: base32ID * @description A base32 encoded 18 byte identifier. */ - ID: string; + ID: string /** * Format: base32ID * @description A base32 encoded 18 byte identifier. */ - OptionalID: string | null; + OptionalID: string | null /** @description A flexible identifier for internal or external entities. */ - FlexID: string; + FlexID: string /** @description A flexible identifier for internal or external entities. */ - OptionalFlexID: string | null; + OptionalFlexID: string | null /** @description A machine readable unique label, which is url safe. */ - Label: string; + Label: string /** @description A machine readable unique label, which is url safe. */ - OptionalLabel: string | null; + OptionalLabel: string | null /** @description A machine readable unique label, which is url safe. */ - FeatureValueLabel: string; + FeatureValueLabel: string /** @description A location of where a potential resource can be provisioned. */ - Location: string; + Location: string /** @description A name of a platform which is used to provision resources. */ - Platform: string; + Platform: string /** @description A name of an entity which is displayed to a human. */ - Name: string; + Name: string /** @description A name of an entity which is displayed to a human. */ - OptionalName: string | null; + OptionalName: string | null /** * Format: url * @description Logo used for Provider and Product listings. * * Must be square (same width and height) and minimum 400px. Maximum of 800px. */ - LogoURL: string; + LogoURL: string /** * Format: url * @description Logo used for Provider and Product listings. * * Must be square (same width and height) and minimum 400px. Maximum of 800px. */ - OptionalLogoURL: string | null; + OptionalLogoURL: string | null RegionBody: { - platform: components["schemas"]["Platform"]; - location: components["schemas"]["Location"]; - name: string; - priority: number; - } & { [key: string]: unknown }; + platform: components['schemas']['Platform'] + location: components['schemas']['Location'] + name: string + priority: number + } & { [key: string]: unknown } Region: { - id: components["schemas"]["ID"]; + id: components['schemas']['ID'] /** @enum {string} */ - type: "region"; - version: number; - body: components["schemas"]["RegionBody"]; - } & { [key: string]: unknown }; + type: 'region' + version: number + body: components['schemas']['RegionBody'] + } & { [key: string]: unknown } CreateRegion: { - body: components["schemas"]["RegionBody"]; - } & { [key: string]: unknown }; + body: components['schemas']['RegionBody'] + } & { [key: string]: unknown } UpdateRegion: { - name: string; - } & { [key: string]: unknown }; + name: string + } & { [key: string]: unknown } ProviderBody: { - owner_id?: components["schemas"]["OptionalFlexID"]; - team_id?: components["schemas"]["OptionalID"]; - label: components["schemas"]["Label"]; - name: components["schemas"]["Name"]; - logo_url?: components["schemas"]["LogoURL"]; + owner_id?: components['schemas']['OptionalFlexID'] + team_id?: components['schemas']['OptionalID'] + label: components['schemas']['Label'] + name: components['schemas']['Name'] + logo_url?: components['schemas']['LogoURL'] /** Format: email */ - support_email?: string; + support_email?: string /** Format: url */ - documentation_url?: string; - } & { [key: string]: unknown }; + documentation_url?: string + } & { [key: string]: unknown } UpdateProviderBody: { - owner_id?: components["schemas"]["OptionalFlexID"]; - team_id?: components["schemas"]["OptionalID"]; - label?: components["schemas"]["OptionalLabel"]; - name?: components["schemas"]["OptionalName"]; - logo_url?: components["schemas"]["OptionalLogoURL"]; + owner_id?: components['schemas']['OptionalFlexID'] + team_id?: components['schemas']['OptionalID'] + label?: components['schemas']['OptionalLabel'] + name?: components['schemas']['OptionalName'] + logo_url?: components['schemas']['OptionalLogoURL'] /** Format: email */ - support_email?: string | null; + support_email?: string | null /** Format: url */ - documentation_url?: string | null; - } & { [key: string]: unknown }; + documentation_url?: string | null + } & { [key: string]: unknown } Provider: { - id: components["schemas"]["ID"]; - version: number; + id: components['schemas']['ID'] + version: number /** @enum {string} */ - type: "provider"; - body: components["schemas"]["ProviderBody"]; - } & { [key: string]: unknown }; + type: 'provider' + body: components['schemas']['ProviderBody'] + } & { [key: string]: unknown } CreateProvider: { - body: components["schemas"]["ProviderBody"]; - } & { [key: string]: unknown }; + body: components['schemas']['ProviderBody'] + } & { [key: string]: unknown } UpdateProvider: { - id: components["schemas"]["ID"]; - body: components["schemas"]["UpdateProviderBody"]; - } & { [key: string]: unknown }; + id: components['schemas']['ID'] + body: components['schemas']['UpdateProviderBody'] + } & { [key: string]: unknown } UpdateProduct: { - id: components["schemas"]["ID"]; - body: components["schemas"]["UpdateProductBody"]; - } & { [key: string]: unknown }; + id: components['schemas']['ID'] + body: components['schemas']['UpdateProductBody'] + } & { [key: string]: unknown } UpdateProductBody: { - name?: components["schemas"]["Name"]; - label?: components["schemas"]["Label"]; - logo_url?: components["schemas"]["LogoURL"]; - listing?: components["schemas"]["ProductListing"]; + name?: components['schemas']['Name'] + label?: components['schemas']['Label'] + logo_url?: components['schemas']['LogoURL'] + listing?: components['schemas']['ProductListing'] /** @description 140 character sentence positioning the product. */ - tagline?: string | null; + tagline?: string | null /** @description A list of value propositions of the product. */ - value_props?: components["schemas"]["ValueProp"][] | null; + value_props?: components['schemas']['ValueProp'][] | null /** @description A list of getting started steps for the product */ - setup_steps?: string[] | null; - images?: components["schemas"]["ProductImageURL"][] | null; + setup_steps?: string[] | null + images?: components['schemas']['ProductImageURL'][] | null /** Format: email */ - support_email?: string | null; + support_email?: string | null /** Format: url */ - documentation_url?: string | null; + documentation_url?: string | null /** * @description URL to this Product's Terms of Service. If provided is true, then * a url must be set. Otherwise, provided is false. */ - terms_url?: string | null; - feature_types?: components["schemas"]["FeatureType"][] | null; + terms_url?: string | null + feature_types?: components['schemas']['FeatureType'][] | null integration?: | ({ - provisioning?: components["schemas"]["ProductProvisioning"]; + provisioning?: components['schemas']['ProductProvisioning'] /** Format: url */ - base_url?: string | null; + base_url?: string | null /** Format: url */ - sso_url?: string | null; + sso_url?: string | null /** @enum {string|null} */ - version?: "v1" | null; + version?: 'v1' | null features?: { - access_code?: boolean | null; - sso?: boolean | null; - plan_change?: boolean | null; + access_code?: boolean | null + sso?: boolean | null + plan_change?: boolean | null /** * @default multiple * @enum {string|null} */ - credential?: ("none" | "single" | "multiple" | "unknown") | null; - } & { [key: string]: unknown }; + credential?: ('none' | 'single' | 'multiple' | 'unknown') | null + } & { [key: string]: unknown } } & { [key: string]: unknown }) - | null; + | null /** @description An array of platform ids to restrict this product for. */ - platform_ids?: components["schemas"]["ID"][] | null; - tags?: components["schemas"]["ProductTags"]; - } & { [key: string]: unknown }; + platform_ids?: components['schemas']['ID'][] | null + tags?: components['schemas']['ProductTags'] + } & { [key: string]: unknown } UpdatePlan: { - id: components["schemas"]["ID"]; - body: components["schemas"]["UpdatePlanBody"]; - } & { [key: string]: unknown }; + id: components['schemas']['ID'] + body: components['schemas']['UpdatePlanBody'] + } & { [key: string]: unknown } UpdatePlanBody: { - name?: components["schemas"]["Name"]; - label?: components["schemas"]["Label"]; - state?: components["schemas"]["PlanState"]; + name?: components['schemas']['Name'] + label?: components['schemas']['Label'] + state?: components['schemas']['PlanState'] /** @description Used in conjuction with resizable_to to set or unset the list */ - has_resize_constraints?: boolean | null; - resizable_to?: components["schemas"]["PlanResizeList"]; + has_resize_constraints?: boolean | null + resizable_to?: components['schemas']['PlanResizeList'] /** @description Array of Region IDs */ - regions?: components["schemas"]["ID"][] | null; + regions?: components['schemas']['ID'][] | null /** @description Array of Feature Values */ - features?: components["schemas"]["FeatureValue"][] | null; + features?: components['schemas']['FeatureValue'][] | null /** * @description The number of days a user gets as a free trial when subscribing to * this plan. Trials are valid only once per product; changing plans * or adding an additional subscription will not start a new trial. */ - trial_days?: number | null; + trial_days?: number | null /** @description Dollar value in cents */ - cost?: number | null; - } & { [key: string]: unknown }; + cost?: number | null + } & { [key: string]: unknown } /** * @description A feature type represents the different aspects of a product that are * offered, these features can manifest differently depending on the plan. */ FeatureType: { - label: components["schemas"]["Label"]; - name: components["schemas"]["Name"]; + label: components['schemas']['Label'] + name: components['schemas']['Name'] /** @enum {string} */ - type: "boolean" | "string" | "number"; + type: 'boolean' | 'string' | 'number' /** @description This sets whether or not the feature can be customized by a consumer. */ - customizable?: boolean; + customizable?: boolean /** * @description This sets whether or not the feature can be upgraded by the consumer after the * resource has provisioned. Upgrading means setting a higher value or selecting a * higher element in the list. */ - upgradable?: boolean; + upgradable?: boolean /** * @description This sets whether or not the feature can be downgraded by the consumer after the * resource has provisioned. Downgrading means setting a lower value or selecting a * lower element in the list. */ - downgradable?: boolean; + downgradable?: boolean /** * @description Sets if this feature’s value is trackable from the provider, * this only really affects numeric constraints. */ - measurable?: boolean; - values?: components["schemas"]["FeatureValuesList"]; - } & { [key: string]: unknown }; + measurable?: boolean + values?: components['schemas']['FeatureValuesList'] + } & { [key: string]: unknown } /** * @description A list of allowable values for the feature. * To define values for a boolean feature type, only `true` is required, @@ -855,16 +855,16 @@ export interface components { * `numeric_details` definition, and the plan will determine which * `numeric_details` set is used based on it's setting. */ - FeatureValuesList: components["schemas"]["FeatureValueDetails"][] | null; + FeatureValuesList: components['schemas']['FeatureValueDetails'][] | null FeatureValueDetails: { - label: components["schemas"]["FeatureValueLabel"]; - name: components["schemas"]["Name"]; + label: components['schemas']['FeatureValueLabel'] + name: components['schemas']['Name'] /** * @description The cost that will be added to the monthly plan cost when this value * is selected or is default for the plan. * Cost is deprecated in favor of the `price.cost` field. */ - cost?: number; + cost?: number /** * @description Price describes the cost of a feature. It should be preferred over * the `cost` property. @@ -875,19 +875,19 @@ export interface components { * when this value is selected or is default for the plan. * Number features should use the cost range instead. */ - cost?: number; + cost?: number /** * @description When a feature is used to multiply the cost of the plan or of * another feature, multiply factor is used for calculation. * A feature cannot have both a cost and a multiply factor. */ - multiply_factor?: number; - formula?: components["schemas"]["PriceFormula"]; + multiply_factor?: number + formula?: components['schemas']['PriceFormula'] /** @description Description explains how a feature is calculated to the user. */ - description?: string; - } & { [key: string]: unknown }; - numeric_details?: components["schemas"]["FeatureNumericDetails"]; - } & { [key: string]: unknown }; + description?: string + } & { [key: string]: unknown } + numeric_details?: components['schemas']['FeatureNumericDetails'] + } & { [key: string]: unknown } /** * @description Optional container for additional details relating to numeric features. * This is required if the feature is measurable and numeric. @@ -902,16 +902,16 @@ export interface components { * means this numeric details has no scale, and will not be or customizable. * Some plans may not have a measureable or customizable feature. */ - increment?: number; + increment?: number /** @description Minimum value that can be set by a user if customizable */ - min?: number; + min?: number /** @description Maximum value that can be set by a user if customizable */ - max?: number | null; + max?: number | null /** @description Applied to the end of the number for display, for example the ‘GB’ in ‘20 GB’. */ - suffix?: string | null; - cost_ranges?: components["schemas"]["FeatureNumericRange"][] | null; + suffix?: string | null + cost_ranges?: components['schemas']['FeatureNumericRange'][] | null } & { [key: string]: unknown }) - | null; + | null FeatureNumericRange: { /** * @description Defines the end of the range ( inclusive ), from the previous, or 0; @@ -919,40 +919,40 @@ export interface components { * range to infinity, or the maximum integer the system can handle * ( whichever comes first ). */ - limit?: number; + limit?: number /** * @description An integer in 10,000,000ths of cents, will be multiplied by the * numeric value set in the feature to determine the cost. */ - cost_multiple?: number; - } & { [key: string]: unknown }; + cost_multiple?: number + } & { [key: string]: unknown } FeatureValue: { - feature: components["schemas"]["Label"]; - value: components["schemas"]["FeatureValueLabel"]; - } & { [key: string]: unknown }; + feature: components['schemas']['Label'] + value: components['schemas']['FeatureValueLabel'] + } & { [key: string]: unknown } ValueProp: { /** @description Heading of a value proposition. */ - header: string; + header: string /** @description Body of a value proposition. */ - body: string; - } & { [key: string]: unknown }; + body: string + } & { [key: string]: unknown } /** * Format: url * @description Image URL used for Product listings. * * Minimum 660px wide, 400px high. */ - ProductImageURL: string; + ProductImageURL: string /** @description List of tags for product categorization and search */ - ProductTags: components["schemas"]["Label"][]; + ProductTags: components['schemas']['Label'][] /** @enum {string} */ - ProductState: "available" | "hidden" | "grandfathered" | "new" | "upcoming"; + ProductState: 'available' | 'hidden' | 'grandfathered' | 'new' | 'upcoming' ProductListing: { /** * @description When true, everyone can see the product when requested. When false it will * not be visible to anyone except those on the provider team. */ - public?: boolean; + public?: boolean /** * @description When true, the product will be displayed in product listings alongside * other products. When false the product will be excluded from listings, @@ -960,7 +960,7 @@ export interface components { * Any pages that display information about the product when not listed, * should indicate to webcrawlers that the content should not be indexed. */ - listed?: boolean; + listed?: boolean /** * @description Object to hold various flags for marketing purposes only. These are values * that need to be stored, but should not affect decision making in code. If @@ -973,21 +973,21 @@ export interface components { * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. */ - beta?: boolean; + beta?: boolean /** * @description Indicates whether or not the product is in `New` and should be * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. */ - new?: boolean; + new?: boolean /** * @description Indicates whether or not the product is in `New` and should be * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. */ - featured?: boolean; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + featured?: boolean + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** * @description Provider Only, implies that the product should only be provisionable by the * provider; so members of the provider team, no one else should be allowed. @@ -997,23 +997,23 @@ export interface components { * * @enum {string} */ - ProductProvisioning: "provider-only" | "pre-order" | "public"; + ProductProvisioning: 'provider-only' | 'pre-order' | 'public' ProductIntegrationFeatures: { /** * @description Indicates whether or not this product supports resource transitions to * manifold by access_code. */ - access_code?: boolean; + access_code?: boolean /** * @description Represents whether or not this product supports Single * Sign On */ - sso?: boolean; + sso?: boolean /** * @description Represents whether or not this product supports changing * the plan of a resource. */ - plan_change?: boolean; + plan_change?: boolean /** * @description Describes how the region for a resource is specified, if * unspecified, then regions have no impact on this @@ -1021,7 +1021,7 @@ export interface components { * * @enum {string} */ - region?: "user-specified" | "unspecified"; + region?: 'user-specified' | 'unspecified' /** * @description Describes the credential type that is supported by this product. * @@ -1033,129 +1033,129 @@ export interface components { * @default multiple * @enum {string} */ - credential?: "none" | "single" | "multiple" | "unknown"; - } & { [key: string]: unknown }; + credential?: 'none' | 'single' | 'multiple' | 'unknown' + } & { [key: string]: unknown } ProductBody: { - provider_id: components["schemas"]["ID"]; - label: components["schemas"]["Label"]; - name: components["schemas"]["Name"]; - state: components["schemas"]["ProductState"]; - listing: components["schemas"]["ProductListing"]; - logo_url: components["schemas"]["LogoURL"]; + provider_id: components['schemas']['ID'] + label: components['schemas']['Label'] + name: components['schemas']['Name'] + state: components['schemas']['ProductState'] + listing: components['schemas']['ProductListing'] + logo_url: components['schemas']['LogoURL'] /** @description 140 character sentence positioning the product. */ - tagline: string; + tagline: string /** @description A list of value propositions of the product. */ - value_props: components["schemas"]["ValueProp"][]; + value_props: components['schemas']['ValueProp'][] /** @description A list of getting started steps for the product */ - setup_steps?: string[] | null; - images: components["schemas"]["ProductImageURL"][]; + setup_steps?: string[] | null + images: components['schemas']['ProductImageURL'][] /** Format: email */ - support_email: string; + support_email: string /** Format: url */ - documentation_url: string; + documentation_url: string /** * @description URL to this Product's Terms of Service. If provided is true, then * a url must be set. Otherwise, provided is false. */ terms: { /** Format: url */ - url?: string | null; - provided: boolean; - } & { [key: string]: unknown }; - feature_types: components["schemas"]["FeatureType"][]; + url?: string | null + provided: boolean + } & { [key: string]: unknown } + feature_types: components['schemas']['FeatureType'][] billing: { /** @enum {string} */ - type: "monthly-prorated" | "monthly-anniversary" | "annual-anniversary"; + type: 'monthly-prorated' | 'monthly-anniversary' | 'annual-anniversary' /** @enum {string} */ - currency: "usd"; - } & { [key: string]: unknown }; + currency: 'usd' + } & { [key: string]: unknown } integration: { - provisioning: components["schemas"]["ProductProvisioning"]; + provisioning: components['schemas']['ProductProvisioning'] /** Format: url */ - base_url: string; + base_url: string /** Format: url */ - sso_url?: string | null; + sso_url?: string | null /** @enum {string} */ - version: "v1"; - features: components["schemas"]["ProductIntegrationFeatures"]; - } & { [key: string]: unknown }; - tags?: components["schemas"]["ProductTags"]; - } & { [key: string]: unknown }; + version: 'v1' + features: components['schemas']['ProductIntegrationFeatures'] + } & { [key: string]: unknown } + tags?: components['schemas']['ProductTags'] + } & { [key: string]: unknown } Product: { - id: components["schemas"]["ID"]; - version: number; + id: components['schemas']['ID'] + version: number /** @enum {string} */ - type: "product"; - body: components["schemas"]["ProductBody"]; - } & { [key: string]: unknown }; + type: 'product' + body: components['schemas']['ProductBody'] + } & { [key: string]: unknown } CreateProduct: { - body: components["schemas"]["ProductBody"]; - } & { [key: string]: unknown }; + body: components['schemas']['ProductBody'] + } & { [key: string]: unknown } /** @description Array of Plan IDs that this Plan can be resized to, if null all will be assumed */ - PlanResizeList: components["schemas"]["ID"][] | null; + PlanResizeList: components['schemas']['ID'][] | null PlanBody: { - provider_id: components["schemas"]["ID"]; - product_id: components["schemas"]["ID"]; - name: components["schemas"]["Name"]; - label: components["schemas"]["Label"]; - state: components["schemas"]["PlanState"]; - resizable_to?: components["schemas"]["PlanResizeList"]; + provider_id: components['schemas']['ID'] + product_id: components['schemas']['ID'] + name: components['schemas']['Name'] + label: components['schemas']['Label'] + state: components['schemas']['PlanState'] + resizable_to?: components['schemas']['PlanResizeList'] /** @description Array of Region IDs */ - regions: components["schemas"]["ID"][]; + regions: components['schemas']['ID'][] /** @description Array of Feature Values */ - features: components["schemas"]["FeatureValue"][]; + features: components['schemas']['FeatureValue'][] /** * @description The number of days a user gets as a free trial when subscribing to * this plan. Trials are valid only once per product; changing plans * or adding an additional subscription will not start a new trial. */ - trial_days?: number; + trial_days?: number /** @description Dollar value in cents. */ - cost: number; - } & { [key: string]: unknown }; + cost: number + } & { [key: string]: unknown } /** @enum {string} */ - PlanState: "hidden" | "available" | "grandfathered" | "unlisted"; - ExpandedPlanBody: components["schemas"]["PlanBody"] & + PlanState: 'hidden' | 'available' | 'grandfathered' | 'unlisted' + ExpandedPlanBody: components['schemas']['PlanBody'] & ({ /** @description An array of feature definitions for the plan, as defined on the Product. */ - expanded_features: components["schemas"]["ExpandedFeature"][]; + expanded_features: components['schemas']['ExpandedFeature'][] /** @description A boolean flag that indicates if a plan is free or not based on it's cost and features. */ - free: boolean; + free: boolean /** @description Plan cost using its default features plus base cost. */ - defaultCost?: number; + defaultCost?: number /** @description A boolean flag that indicates if a plan has customizable features. */ - customizable?: boolean; - } & { [key: string]: unknown }) & { [key: string]: unknown }; - ExpandedFeature: components["schemas"]["FeatureType"] & + customizable?: boolean + } & { [key: string]: unknown }) & { [key: string]: unknown } + ExpandedFeature: components['schemas']['FeatureType'] & ({ /** @description The string value set for the feature on the plan, this should only be used if the value property is null. */ - value_string: string; - value: components["schemas"]["FeatureValueDetails"]; - } & { [key: string]: unknown }) & { [key: string]: unknown }; + value_string: string + value: components['schemas']['FeatureValueDetails'] + } & { [key: string]: unknown }) & { [key: string]: unknown } Plan: { - id: components["schemas"]["ID"]; - version: number; + id: components['schemas']['ID'] + version: number /** @enum {string} */ - type: "plan"; - body: components["schemas"]["PlanBody"]; - } & { [key: string]: unknown }; + type: 'plan' + body: components['schemas']['PlanBody'] + } & { [key: string]: unknown } ExpandedPlan: { - id: components["schemas"]["ID"]; - version: number; + id: components['schemas']['ID'] + version: number /** @enum {string} */ - type: "plan"; - body: components["schemas"]["ExpandedPlanBody"]; - } & { [key: string]: unknown }; + type: 'plan' + body: components['schemas']['ExpandedPlanBody'] + } & { [key: string]: unknown } CreatePlan: { - body: components["schemas"]["PlanBody"]; - } & { [key: string]: unknown }; + body: components['schemas']['PlanBody'] + } & { [key: string]: unknown } /** @description Unexpected error */ Error: { /** @description The error type */ - type: string; + type: string /** @description Explanation of the errors */ - message: string[]; - } & { [key: string]: unknown }; + message: string[] + } & { [key: string]: unknown } /** * @description Describes how a feature cost should be calculated. An empty * string defaults to the normal price calculation using the value cost. @@ -1179,21 +1179,21 @@ export interface components { * - `another-feature-label#number` is the numeric value of a number feature * In a feature formula, plan base cost and total cost cannot be used */ - PriceFormula: string; + PriceFormula: string ExpandedProduct: { - id: components["schemas"]["ID"]; - version: number; + id: components['schemas']['ID'] + version: number /** @enum {string} */ - type: "product"; - body: components["schemas"]["ProductBody"]; - plans?: components["schemas"]["ExpandedPlan"][]; - provider: components["schemas"]["Provider"]; - } & { [key: string]: unknown }; - }; + type: 'product' + body: components['schemas']['ProductBody'] + plans?: components['schemas']['ExpandedPlan'][] + provider: components['schemas']['Provider'] + } & { [key: string]: unknown } + } parameters: { /** @description Filter results to only include those that have this label. */ - LabelFilter: string; - }; + LabelFilter: string + } } export interface operations {} diff --git a/test/v3/expected/manifold.exported-type.ts b/test/v3/expected/manifold.exported-type.ts index 08ecd778b..286993632 100644 --- a/test/v3/expected/manifold.exported-type.ts +++ b/test/v3/expected/manifold.exported-type.ts @@ -4,286 +4,286 @@ */ export type paths = { - "/regions/": { + '/regions/': { get: { parameters: { query: { /** Filter results to only include the regions that have this location. */ - location?: string; + location?: string /** * Filter results to only include the regions that are on this * platform. */ - platform?: string; - }; - }; + platform?: string + } + } responses: { /** A list of regions. */ 200: { content: { - "application/json": components["schemas"]["Region"][]; - }; - }; + 'application/json': components['schemas']['Region'][] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } + } post: { responses: { /** Complete region object */ 201: { content: { - "application/json": components["schemas"]["Region"]; - }; - }; + 'application/json': components['schemas']['Region'] + } + } /** Invalid request provided */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Region already exists for that platform and location */ 409: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } /** Region create request */ requestBody: { content: { - "application/json": components["schemas"]["CreateRegion"]; - }; - }; - }; - }; - "/regions/{id}": { + 'application/json': components['schemas']['CreateRegion'] + } + } + } + } + '/regions/{id}': { get: { parameters: { path: { /** ID of the region to lookup, stored as a base32 encoded 18 byte identifier. */ - id: string; - }; - }; + id: string + } + } responses: { /** A region. */ 200: { content: { - "application/json": components["schemas"]["Region"]; - }; - }; + 'application/json': components['schemas']['Region'] + } + } /** Provided Region ID is Invalid */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Region could not be found */ 404: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } + } patch: { parameters: { path: { /** ID of the region to lookup, stored as a base32 encoded 18 byte identifier. */ - id: string; - }; - }; + id: string + } + } responses: { /** Complete region object */ 200: { content: { - "application/json": components["schemas"]["Region"]; - }; - }; + 'application/json': components['schemas']['Region'] + } + } /** Invalid request provided */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } /** Region update request */ requestBody: { content: { - "application/json": components["schemas"]["UpdateRegion"]; - }; - }; - }; - }; - "/providers/": { + 'application/json': components['schemas']['UpdateRegion'] + } + } + } + } + '/providers/': { get: { parameters: { query: { /** Filter results to only include those that have this label. */ - label?: string; - }; - }; + label?: string + } + } responses: { /** A list of providers. */ 200: { content: { - "application/json": components["schemas"]["Provider"][]; - }; - }; + 'application/json': components['schemas']['Provider'][] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } + } post: { responses: { /** Complete provider object */ 201: { content: { - "application/json": components["schemas"]["Provider"]; - }; - }; + 'application/json': components['schemas']['Provider'] + } + } /** Invalid request provided */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Forbidden */ 403: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Provider already exists with that label */ 409: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } /** Provider create request */ requestBody: { content: { - "application/json": components["schemas"]["CreateProvider"]; - }; - }; - }; - }; - "/providers/{id}": { + 'application/json': components['schemas']['CreateProvider'] + } + } + } + } + '/providers/{id}': { get: { parameters: { path: { /** ID of the provider to lookup, stored as a base32 encoded 18 byte identifier. */ - id: string; - }; - }; + id: string + } + } responses: { /** A provider. */ 200: { content: { - "application/json": components["schemas"]["Provider"]; - }; - }; + 'application/json': components['schemas']['Provider'] + } + } /** Unknown provider error */ 404: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } + } patch: { parameters: { path: { /** ID of the provider to update, stored as a base32 encoded 18 byte identifier. */ - id: string; - }; - }; + id: string + } + } responses: { /** Complete provider object */ 200: { content: { - "application/json": components["schemas"]["Provider"]; - }; - }; + 'application/json': components['schemas']['Provider'] + } + } /** Invalid request provided */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Forbidden */ 403: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Provider not found */ 404: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Provider already exists with that label */ 409: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } /** Provider update request */ requestBody: { content: { - "application/json": components["schemas"]["UpdateProvider"]; - }; - }; - }; - }; - "/products/": { + 'application/json': components['schemas']['UpdateProvider'] + } + } + } + } + '/products/': { get: { parameters: { query: { @@ -291,76 +291,76 @@ export type paths = { * Base32 encoded 18 byte identifier of the provider that these * products must belong to. */ - provider_id?: string; + provider_id?: string /** Filter results to only include those that have this label. */ - label?: string; + label?: string /** Return only products matching at least one of the tags. */ - tags?: string[]; - }; - }; + tags?: string[] + } + } responses: { /** A product. */ 200: { content: { - "application/json": components["schemas"]["Product"][]; - }; - }; + 'application/json': components['schemas']['Product'][] + } + } /** Invalid provider_id supplied */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } + } post: { responses: { /** Complete product object */ 201: { content: { - "application/json": components["schemas"]["Product"]; - }; - }; + 'application/json': components['schemas']['Product'] + } + } /** Invalid request provided */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Forbidden */ 403: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Product already exists with that label */ 409: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } /** Product create request */ requestBody: { content: { - "application/json": components["schemas"]["CreateProduct"]; - }; - }; - }; - }; - "/internal/products": { + 'application/json': components['schemas']['CreateProduct'] + } + } + } + } + '/internal/products': { get: { parameters: { query: { @@ -368,38 +368,38 @@ export type paths = { * Base32 encoded 18 byte identifier of the provider that these * products must belong to. */ - provider_id?: string; + provider_id?: string /** Filter results to only include those that have this label. */ - label?: string; + label?: string /** Return only products matching at least one of the tags. */ - tags?: string[]; + tags?: string[] /** Return product listings without plan information */ - include_plans?: boolean; - }; - }; + include_plans?: boolean + } + } responses: { /** A product. */ 200: { content: { - "application/json": components["schemas"]["ExpandedProduct"][]; - }; - }; + 'application/json': components['schemas']['ExpandedProduct'][] + } + } /** Invalid provider_id supplied */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; - }; - "/products/{id}": { + 'application/json': components['schemas']['Error'] + } + } + } + } + } + '/products/{id}': { get: { parameters: { path: { @@ -407,36 +407,36 @@ export type paths = { * ID of the product to lookup, stored as a base32 encoded 18 byte * identifier. */ - id: string; - }; - }; + id: string + } + } responses: { /** A product. */ 200: { content: { - "application/json": components["schemas"]["Product"]; - }; - }; + 'application/json': components['schemas']['Product'] + } + } /** Invalid Product ID */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Product not found error */ 404: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } + } patch: { parameters: { path: { @@ -444,44 +444,44 @@ export type paths = { * ID of the product to lookup, stored as a base32 encoded 18 byte * identifier. */ - id: string; - }; - }; + id: string + } + } responses: { /** Complete product object */ 200: { content: { - "application/json": components["schemas"]["Product"]; - }; - }; + 'application/json': components['schemas']['Product'] + } + } /** Invalid Product ID */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Product not found error */ 404: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } /** Product update request */ requestBody: { content: { - "application/json": components["schemas"]["UpdateProduct"]; - }; - }; - }; - }; - "/plans/{id}": { + 'application/json': components['schemas']['UpdateProduct'] + } + } + } + } + '/plans/{id}': { get: { parameters: { path: { @@ -489,36 +489,36 @@ export type paths = { * ID of the plan to lookup, stored as a base32 encoded 18 byte * identifier. */ - id: string; - }; - }; + id: string + } + } responses: { /** A plan. */ 200: { content: { - "application/json": components["schemas"]["ExpandedPlan"]; - }; - }; + 'application/json': components['schemas']['ExpandedPlan'] + } + } /** Invalid Plan ID Provided */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unknown plan error */ 404: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected error */ default: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } + } patch: { parameters: { path: { @@ -526,122 +526,122 @@ export type paths = { * ID of the plan to lookup, stored as a base32 encoded 18 byte * identifier. */ - id: string; - }; - }; + id: string + } + } responses: { /** Complete product plan */ 200: { content: { - "application/json": components["schemas"]["Plan"]; - }; - }; + 'application/json': components['schemas']['Plan'] + } + } /** Invalid Plan ID */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Plan not found error */ 404: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } /** Plan update request */ requestBody: { content: { - "application/json": components["schemas"]["UpdatePlan"]; - }; - }; - }; - }; - "/plans/": { + 'application/json': components['schemas']['UpdatePlan'] + } + } + } + } + '/plans/': { get: { parameters: { query: { /** Return the plans that are associated with this product. */ - product_id: string[]; + product_id: string[] /** Filter results to only include those that have this label. */ - label?: string; - }; - }; + label?: string + } + } responses: { /** A list of plans for the given product. */ 200: { content: { - "application/json": components["schemas"]["ExpandedPlan"][]; - }; - }; + 'application/json': components['schemas']['ExpandedPlan'][] + } + } /** Invalid Parameters Provided */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Could not find product */ 404: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } + } post: { responses: { /** Complete plan object */ 201: { content: { - "application/json": components["schemas"]["Plan"]; - }; - }; + 'application/json': components['schemas']['Plan'] + } + } /** Invalid request provided */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Forbidden */ 403: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Plan already exists with that label */ 409: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } /** Plan create request */ requestBody: { content: { - "application/json": components["schemas"]["CreatePlan"]; - }; - }; - }; - }; -}; + 'application/json': components['schemas']['CreatePlan'] + } + } + } + } +} export type components = { schemas: { @@ -649,202 +649,202 @@ export type components = { * Format: base32ID * @description A base32 encoded 18 byte identifier. */ - ID: string; + ID: string /** * Format: base32ID * @description A base32 encoded 18 byte identifier. */ - OptionalID: string | null; + OptionalID: string | null /** @description A flexible identifier for internal or external entities. */ - FlexID: string; + FlexID: string /** @description A flexible identifier for internal or external entities. */ - OptionalFlexID: string | null; + OptionalFlexID: string | null /** @description A machine readable unique label, which is url safe. */ - Label: string; + Label: string /** @description A machine readable unique label, which is url safe. */ - OptionalLabel: string | null; + OptionalLabel: string | null /** @description A machine readable unique label, which is url safe. */ - FeatureValueLabel: string; + FeatureValueLabel: string /** @description A location of where a potential resource can be provisioned. */ - Location: string; + Location: string /** @description A name of a platform which is used to provision resources. */ - Platform: string; + Platform: string /** @description A name of an entity which is displayed to a human. */ - Name: string; + Name: string /** @description A name of an entity which is displayed to a human. */ - OptionalName: string | null; + OptionalName: string | null /** * Format: url * @description Logo used for Provider and Product listings. * * Must be square (same width and height) and minimum 400px. Maximum of 800px. */ - LogoURL: string; + LogoURL: string /** * Format: url * @description Logo used for Provider and Product listings. * * Must be square (same width and height) and minimum 400px. Maximum of 800px. */ - OptionalLogoURL: string | null; + OptionalLogoURL: string | null RegionBody: { - platform: components["schemas"]["Platform"]; - location: components["schemas"]["Location"]; - name: string; - priority: number; - }; + platform: components['schemas']['Platform'] + location: components['schemas']['Location'] + name: string + priority: number + } Region: { - id: components["schemas"]["ID"]; + id: components['schemas']['ID'] /** @enum {string} */ - type: "region"; - version: number; - body: components["schemas"]["RegionBody"]; - }; + type: 'region' + version: number + body: components['schemas']['RegionBody'] + } CreateRegion: { - body: components["schemas"]["RegionBody"]; - }; + body: components['schemas']['RegionBody'] + } UpdateRegion: { - name: string; - }; + name: string + } ProviderBody: { - owner_id?: components["schemas"]["OptionalFlexID"]; - team_id?: components["schemas"]["OptionalID"]; - label: components["schemas"]["Label"]; - name: components["schemas"]["Name"]; - logo_url?: components["schemas"]["LogoURL"]; + owner_id?: components['schemas']['OptionalFlexID'] + team_id?: components['schemas']['OptionalID'] + label: components['schemas']['Label'] + name: components['schemas']['Name'] + logo_url?: components['schemas']['LogoURL'] /** Format: email */ - support_email?: string; + support_email?: string /** Format: url */ - documentation_url?: string; - }; + documentation_url?: string + } UpdateProviderBody: { - owner_id?: components["schemas"]["OptionalFlexID"]; - team_id?: components["schemas"]["OptionalID"]; - label?: components["schemas"]["OptionalLabel"]; - name?: components["schemas"]["OptionalName"]; - logo_url?: components["schemas"]["OptionalLogoURL"]; + owner_id?: components['schemas']['OptionalFlexID'] + team_id?: components['schemas']['OptionalID'] + label?: components['schemas']['OptionalLabel'] + name?: components['schemas']['OptionalName'] + logo_url?: components['schemas']['OptionalLogoURL'] /** Format: email */ - support_email?: string | null; + support_email?: string | null /** Format: url */ - documentation_url?: string | null; - }; + documentation_url?: string | null + } Provider: { - id: components["schemas"]["ID"]; - version: number; + id: components['schemas']['ID'] + version: number /** @enum {string} */ - type: "provider"; - body: components["schemas"]["ProviderBody"]; - }; + type: 'provider' + body: components['schemas']['ProviderBody'] + } CreateProvider: { - body: components["schemas"]["ProviderBody"]; - }; + body: components['schemas']['ProviderBody'] + } UpdateProvider: { - id: components["schemas"]["ID"]; - body: components["schemas"]["UpdateProviderBody"]; - }; + id: components['schemas']['ID'] + body: components['schemas']['UpdateProviderBody'] + } UpdateProduct: { - id: components["schemas"]["ID"]; - body: components["schemas"]["UpdateProductBody"]; - }; + id: components['schemas']['ID'] + body: components['schemas']['UpdateProductBody'] + } UpdateProductBody: { - name?: components["schemas"]["Name"]; - label?: components["schemas"]["Label"]; - logo_url?: components["schemas"]["LogoURL"]; - listing?: components["schemas"]["ProductListing"]; + name?: components['schemas']['Name'] + label?: components['schemas']['Label'] + logo_url?: components['schemas']['LogoURL'] + listing?: components['schemas']['ProductListing'] /** @description 140 character sentence positioning the product. */ - tagline?: string | null; + tagline?: string | null /** @description A list of value propositions of the product. */ - value_props?: components["schemas"]["ValueProp"][] | null; + value_props?: components['schemas']['ValueProp'][] | null /** @description A list of getting started steps for the product */ - setup_steps?: string[] | null; - images?: components["schemas"]["ProductImageURL"][] | null; + setup_steps?: string[] | null + images?: components['schemas']['ProductImageURL'][] | null /** Format: email */ - support_email?: string | null; + support_email?: string | null /** Format: url */ - documentation_url?: string | null; + documentation_url?: string | null /** * @description URL to this Product's Terms of Service. If provided is true, then * a url must be set. Otherwise, provided is false. */ - terms_url?: string | null; - feature_types?: components["schemas"]["FeatureType"][] | null; + terms_url?: string | null + feature_types?: components['schemas']['FeatureType'][] | null integration?: { - provisioning?: components["schemas"]["ProductProvisioning"]; + provisioning?: components['schemas']['ProductProvisioning'] /** Format: url */ - base_url?: string | null; + base_url?: string | null /** Format: url */ - sso_url?: string | null; + sso_url?: string | null /** @enum {string|null} */ - version?: "v1" | null; + version?: 'v1' | null features?: { - access_code?: boolean | null; - sso?: boolean | null; - plan_change?: boolean | null; + access_code?: boolean | null + sso?: boolean | null + plan_change?: boolean | null /** * @default multiple * @enum {string|null} */ - credential?: ("none" | "single" | "multiple" | "unknown") | null; - }; - } | null; + credential?: ('none' | 'single' | 'multiple' | 'unknown') | null + } + } | null /** @description An array of platform ids to restrict this product for. */ - platform_ids?: components["schemas"]["ID"][] | null; - tags?: components["schemas"]["ProductTags"]; - }; + platform_ids?: components['schemas']['ID'][] | null + tags?: components['schemas']['ProductTags'] + } UpdatePlan: { - id: components["schemas"]["ID"]; - body: components["schemas"]["UpdatePlanBody"]; - }; + id: components['schemas']['ID'] + body: components['schemas']['UpdatePlanBody'] + } UpdatePlanBody: { - name?: components["schemas"]["Name"]; - label?: components["schemas"]["Label"]; - state?: components["schemas"]["PlanState"]; + name?: components['schemas']['Name'] + label?: components['schemas']['Label'] + state?: components['schemas']['PlanState'] /** @description Used in conjuction with resizable_to to set or unset the list */ - has_resize_constraints?: boolean | null; - resizable_to?: components["schemas"]["PlanResizeList"]; + has_resize_constraints?: boolean | null + resizable_to?: components['schemas']['PlanResizeList'] /** @description Array of Region IDs */ - regions?: components["schemas"]["ID"][] | null; + regions?: components['schemas']['ID'][] | null /** @description Array of Feature Values */ - features?: components["schemas"]["FeatureValue"][] | null; + features?: components['schemas']['FeatureValue'][] | null /** * @description The number of days a user gets as a free trial when subscribing to * this plan. Trials are valid only once per product; changing plans * or adding an additional subscription will not start a new trial. */ - trial_days?: number | null; + trial_days?: number | null /** @description Dollar value in cents */ - cost?: number | null; - }; + cost?: number | null + } /** * @description A feature type represents the different aspects of a product that are * offered, these features can manifest differently depending on the plan. */ FeatureType: { - label: components["schemas"]["Label"]; - name: components["schemas"]["Name"]; + label: components['schemas']['Label'] + name: components['schemas']['Name'] /** @enum {string} */ - type: "boolean" | "string" | "number"; + type: 'boolean' | 'string' | 'number' /** @description This sets whether or not the feature can be customized by a consumer. */ - customizable?: boolean; + customizable?: boolean /** * @description This sets whether or not the feature can be upgraded by the consumer after the * resource has provisioned. Upgrading means setting a higher value or selecting a * higher element in the list. */ - upgradable?: boolean; + upgradable?: boolean /** * @description This sets whether or not the feature can be downgraded by the consumer after the * resource has provisioned. Downgrading means setting a lower value or selecting a * lower element in the list. */ - downgradable?: boolean; + downgradable?: boolean /** * @description Sets if this feature’s value is trackable from the provider, * this only really affects numeric constraints. */ - measurable?: boolean; - values?: components["schemas"]["FeatureValuesList"]; - }; + measurable?: boolean + values?: components['schemas']['FeatureValuesList'] + } /** * @description A list of allowable values for the feature. * To define values for a boolean feature type, only `true` is required, @@ -853,16 +853,16 @@ export type components = { * `numeric_details` definition, and the plan will determine which * `numeric_details` set is used based on it's setting. */ - FeatureValuesList: components["schemas"]["FeatureValueDetails"][] | null; + FeatureValuesList: components['schemas']['FeatureValueDetails'][] | null FeatureValueDetails: { - label: components["schemas"]["FeatureValueLabel"]; - name: components["schemas"]["Name"]; + label: components['schemas']['FeatureValueLabel'] + name: components['schemas']['Name'] /** * @description The cost that will be added to the monthly plan cost when this value * is selected or is default for the plan. * Cost is deprecated in favor of the `price.cost` field. */ - cost?: number; + cost?: number /** * @description Price describes the cost of a feature. It should be preferred over * the `cost` property. @@ -873,19 +873,19 @@ export type components = { * when this value is selected or is default for the plan. * Number features should use the cost range instead. */ - cost?: number; + cost?: number /** * @description When a feature is used to multiply the cost of the plan or of * another feature, multiply factor is used for calculation. * A feature cannot have both a cost and a multiply factor. */ - multiply_factor?: number; - formula?: components["schemas"]["PriceFormula"]; + multiply_factor?: number + formula?: components['schemas']['PriceFormula'] /** @description Description explains how a feature is calculated to the user. */ - description?: string; - }; - numeric_details?: components["schemas"]["FeatureNumericDetails"]; - }; + description?: string + } + numeric_details?: components['schemas']['FeatureNumericDetails'] + } /** * @description Optional container for additional details relating to numeric features. * This is required if the feature is measurable and numeric. @@ -899,15 +899,15 @@ export type components = { * means this numeric details has no scale, and will not be or customizable. * Some plans may not have a measureable or customizable feature. */ - increment?: number; + increment?: number /** @description Minimum value that can be set by a user if customizable */ - min?: number; + min?: number /** @description Maximum value that can be set by a user if customizable */ - max?: number | null; + max?: number | null /** @description Applied to the end of the number for display, for example the ‘GB’ in ‘20 GB’. */ - suffix?: string | null; - cost_ranges?: components["schemas"]["FeatureNumericRange"][] | null; - } | null; + suffix?: string | null + cost_ranges?: components['schemas']['FeatureNumericRange'][] | null + } | null FeatureNumericRange: { /** * @description Defines the end of the range ( inclusive ), from the previous, or 0; @@ -915,40 +915,40 @@ export type components = { * range to infinity, or the maximum integer the system can handle * ( whichever comes first ). */ - limit?: number; + limit?: number /** * @description An integer in 10,000,000ths of cents, will be multiplied by the * numeric value set in the feature to determine the cost. */ - cost_multiple?: number; - }; + cost_multiple?: number + } FeatureValue: { - feature: components["schemas"]["Label"]; - value: components["schemas"]["FeatureValueLabel"]; - }; + feature: components['schemas']['Label'] + value: components['schemas']['FeatureValueLabel'] + } ValueProp: { /** @description Heading of a value proposition. */ - header: string; + header: string /** @description Body of a value proposition. */ - body: string; - }; + body: string + } /** * Format: url * @description Image URL used for Product listings. * * Minimum 660px wide, 400px high. */ - ProductImageURL: string; + ProductImageURL: string /** @description List of tags for product categorization and search */ - ProductTags: components["schemas"]["Label"][]; + ProductTags: components['schemas']['Label'][] /** @enum {string} */ - ProductState: "available" | "hidden" | "grandfathered" | "new" | "upcoming"; + ProductState: 'available' | 'hidden' | 'grandfathered' | 'new' | 'upcoming' ProductListing: { /** * @description When true, everyone can see the product when requested. When false it will * not be visible to anyone except those on the provider team. */ - public?: boolean; + public?: boolean /** * @description When true, the product will be displayed in product listings alongside * other products. When false the product will be excluded from listings, @@ -956,7 +956,7 @@ export type components = { * Any pages that display information about the product when not listed, * should indicate to webcrawlers that the content should not be indexed. */ - listed?: boolean; + listed?: boolean /** * @description Object to hold various flags for marketing purposes only. These are values * that need to be stored, but should not affect decision making in code. If @@ -969,21 +969,21 @@ export type components = { * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. */ - beta?: boolean; + beta?: boolean /** * @description Indicates whether or not the product is in `New` and should be * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. */ - new?: boolean; + new?: boolean /** * @description Indicates whether or not the product is in `New` and should be * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. */ - featured?: boolean; - }; - }; + featured?: boolean + } + } /** * @description Provider Only, implies that the product should only be provisionable by the * provider; so members of the provider team, no one else should be allowed. @@ -993,23 +993,23 @@ export type components = { * * @enum {string} */ - ProductProvisioning: "provider-only" | "pre-order" | "public"; + ProductProvisioning: 'provider-only' | 'pre-order' | 'public' ProductIntegrationFeatures: { /** * @description Indicates whether or not this product supports resource transitions to * manifold by access_code. */ - access_code?: boolean; + access_code?: boolean /** * @description Represents whether or not this product supports Single * Sign On */ - sso?: boolean; + sso?: boolean /** * @description Represents whether or not this product supports changing * the plan of a resource. */ - plan_change?: boolean; + plan_change?: boolean /** * @description Describes how the region for a resource is specified, if * unspecified, then regions have no impact on this @@ -1017,7 +1017,7 @@ export type components = { * * @enum {string} */ - region?: "user-specified" | "unspecified"; + region?: 'user-specified' | 'unspecified' /** * @description Describes the credential type that is supported by this product. * @@ -1029,127 +1029,127 @@ export type components = { * @default multiple * @enum {string} */ - credential?: "none" | "single" | "multiple" | "unknown"; - }; + credential?: 'none' | 'single' | 'multiple' | 'unknown' + } ProductBody: { - provider_id: components["schemas"]["ID"]; - label: components["schemas"]["Label"]; - name: components["schemas"]["Name"]; - state: components["schemas"]["ProductState"]; - listing: components["schemas"]["ProductListing"]; - logo_url: components["schemas"]["LogoURL"]; + provider_id: components['schemas']['ID'] + label: components['schemas']['Label'] + name: components['schemas']['Name'] + state: components['schemas']['ProductState'] + listing: components['schemas']['ProductListing'] + logo_url: components['schemas']['LogoURL'] /** @description 140 character sentence positioning the product. */ - tagline: string; + tagline: string /** @description A list of value propositions of the product. */ - value_props: components["schemas"]["ValueProp"][]; + value_props: components['schemas']['ValueProp'][] /** @description A list of getting started steps for the product */ - setup_steps?: string[] | null; - images: components["schemas"]["ProductImageURL"][]; + setup_steps?: string[] | null + images: components['schemas']['ProductImageURL'][] /** Format: email */ - support_email: string; + support_email: string /** Format: url */ - documentation_url: string; + documentation_url: string /** * @description URL to this Product's Terms of Service. If provided is true, then * a url must be set. Otherwise, provided is false. */ terms: { /** Format: url */ - url?: string | null; - provided: boolean; - }; - feature_types: components["schemas"]["FeatureType"][]; + url?: string | null + provided: boolean + } + feature_types: components['schemas']['FeatureType'][] billing: { /** @enum {string} */ - type: "monthly-prorated" | "monthly-anniversary" | "annual-anniversary"; + type: 'monthly-prorated' | 'monthly-anniversary' | 'annual-anniversary' /** @enum {string} */ - currency: "usd"; - }; + currency: 'usd' + } integration: { - provisioning: components["schemas"]["ProductProvisioning"]; + provisioning: components['schemas']['ProductProvisioning'] /** Format: url */ - base_url: string; + base_url: string /** Format: url */ - sso_url?: string | null; + sso_url?: string | null /** @enum {string} */ - version: "v1"; - features: components["schemas"]["ProductIntegrationFeatures"]; - }; - tags?: components["schemas"]["ProductTags"]; - }; + version: 'v1' + features: components['schemas']['ProductIntegrationFeatures'] + } + tags?: components['schemas']['ProductTags'] + } Product: { - id: components["schemas"]["ID"]; - version: number; + id: components['schemas']['ID'] + version: number /** @enum {string} */ - type: "product"; - body: components["schemas"]["ProductBody"]; - }; + type: 'product' + body: components['schemas']['ProductBody'] + } CreateProduct: { - body: components["schemas"]["ProductBody"]; - }; + body: components['schemas']['ProductBody'] + } /** @description Array of Plan IDs that this Plan can be resized to, if null all will be assumed */ - PlanResizeList: components["schemas"]["ID"][] | null; + PlanResizeList: components['schemas']['ID'][] | null PlanBody: { - provider_id: components["schemas"]["ID"]; - product_id: components["schemas"]["ID"]; - name: components["schemas"]["Name"]; - label: components["schemas"]["Label"]; - state: components["schemas"]["PlanState"]; - resizable_to?: components["schemas"]["PlanResizeList"]; + provider_id: components['schemas']['ID'] + product_id: components['schemas']['ID'] + name: components['schemas']['Name'] + label: components['schemas']['Label'] + state: components['schemas']['PlanState'] + resizable_to?: components['schemas']['PlanResizeList'] /** @description Array of Region IDs */ - regions: components["schemas"]["ID"][]; + regions: components['schemas']['ID'][] /** @description Array of Feature Values */ - features: components["schemas"]["FeatureValue"][]; + features: components['schemas']['FeatureValue'][] /** * @description The number of days a user gets as a free trial when subscribing to * this plan. Trials are valid only once per product; changing plans * or adding an additional subscription will not start a new trial. */ - trial_days?: number; + trial_days?: number /** @description Dollar value in cents. */ - cost: number; - }; + cost: number + } /** @enum {string} */ - PlanState: "hidden" | "available" | "grandfathered" | "unlisted"; - ExpandedPlanBody: components["schemas"]["PlanBody"] & { + PlanState: 'hidden' | 'available' | 'grandfathered' | 'unlisted' + ExpandedPlanBody: components['schemas']['PlanBody'] & { /** @description An array of feature definitions for the plan, as defined on the Product. */ - expanded_features: components["schemas"]["ExpandedFeature"][]; + expanded_features: components['schemas']['ExpandedFeature'][] /** @description A boolean flag that indicates if a plan is free or not based on it's cost and features. */ - free: boolean; + free: boolean /** @description Plan cost using its default features plus base cost. */ - defaultCost?: number; + defaultCost?: number /** @description A boolean flag that indicates if a plan has customizable features. */ - customizable?: boolean; - }; - ExpandedFeature: components["schemas"]["FeatureType"] & { + customizable?: boolean + } + ExpandedFeature: components['schemas']['FeatureType'] & { /** @description The string value set for the feature on the plan, this should only be used if the value property is null. */ - value_string: string; - value: components["schemas"]["FeatureValueDetails"]; - }; + value_string: string + value: components['schemas']['FeatureValueDetails'] + } Plan: { - id: components["schemas"]["ID"]; - version: number; + id: components['schemas']['ID'] + version: number /** @enum {string} */ - type: "plan"; - body: components["schemas"]["PlanBody"]; - }; + type: 'plan' + body: components['schemas']['PlanBody'] + } ExpandedPlan: { - id: components["schemas"]["ID"]; - version: number; + id: components['schemas']['ID'] + version: number /** @enum {string} */ - type: "plan"; - body: components["schemas"]["ExpandedPlanBody"]; - }; + type: 'plan' + body: components['schemas']['ExpandedPlanBody'] + } CreatePlan: { - body: components["schemas"]["PlanBody"]; - }; + body: components['schemas']['PlanBody'] + } /** @description Unexpected error */ Error: { /** @description The error type */ - type: string; + type: string /** @description Explanation of the errors */ - message: string[]; - }; + message: string[] + } /** * @description Describes how a feature cost should be calculated. An empty * string defaults to the normal price calculation using the value cost. @@ -1173,23 +1173,23 @@ export type components = { * - `another-feature-label#number` is the numeric value of a number feature * In a feature formula, plan base cost and total cost cannot be used */ - PriceFormula: string; + PriceFormula: string ExpandedProduct: { - id: components["schemas"]["ID"]; - version: number; + id: components['schemas']['ID'] + version: number /** @enum {string} */ - type: "product"; - body: components["schemas"]["ProductBody"]; - plans?: components["schemas"]["ExpandedPlan"][]; - provider: components["schemas"]["Provider"]; - }; - }; + type: 'product' + body: components['schemas']['ProductBody'] + plans?: components['schemas']['ExpandedPlan'][] + provider: components['schemas']['Provider'] + } + } parameters: { /** @description Filter results to only include those that have this label. */ - LabelFilter: string; - }; -}; + LabelFilter: string + } +} -export type operations = {}; +export type operations = {} -export type external = {}; +export type external = {} diff --git a/test/v3/expected/manifold.immutable.ts b/test/v3/expected/manifold.immutable.ts index 47c3575ff..c31fc4f2d 100644 --- a/test/v3/expected/manifold.immutable.ts +++ b/test/v3/expected/manifold.immutable.ts @@ -4,286 +4,286 @@ */ export interface paths { - readonly "/regions/": { + readonly '/regions/': { readonly get: { readonly parameters: { readonly query: { /** Filter results to only include the regions that have this location. */ - readonly location?: string; + readonly location?: string /** * Filter results to only include the regions that are on this * platform. */ - readonly platform?: string; - }; - }; + readonly platform?: string + } + } readonly responses: { /** A list of regions. */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["Region"][]; - }; - }; + readonly 'application/json': readonly components['schemas']['Region'][] + } + } /** Unexpected Error */ readonly 500: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } + } + } readonly post: { readonly responses: { /** Complete region object */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["Region"]; - }; - }; + readonly 'application/json': components['schemas']['Region'] + } + } /** Invalid request provided */ readonly 400: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } /** Region already exists for that platform and location */ readonly 409: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ readonly 500: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } + } /** Region create request */ readonly requestBody: { readonly content: { - readonly "application/json": components["schemas"]["CreateRegion"]; - }; - }; - }; - }; - readonly "/regions/{id}": { + readonly 'application/json': components['schemas']['CreateRegion'] + } + } + } + } + readonly '/regions/{id}': { readonly get: { readonly parameters: { readonly path: { /** ID of the region to lookup, stored as a base32 encoded 18 byte identifier. */ - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** A region. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["Region"]; - }; - }; + readonly 'application/json': components['schemas']['Region'] + } + } /** Provided Region ID is Invalid */ readonly 400: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } /** Region could not be found */ readonly 404: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ readonly 500: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } + } + } readonly patch: { readonly parameters: { readonly path: { /** ID of the region to lookup, stored as a base32 encoded 18 byte identifier. */ - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Complete region object */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["Region"]; - }; - }; + readonly 'application/json': components['schemas']['Region'] + } + } /** Invalid request provided */ readonly 400: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ readonly 500: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } + } /** Region update request */ readonly requestBody: { readonly content: { - readonly "application/json": components["schemas"]["UpdateRegion"]; - }; - }; - }; - }; - readonly "/providers/": { + readonly 'application/json': components['schemas']['UpdateRegion'] + } + } + } + } + readonly '/providers/': { readonly get: { readonly parameters: { readonly query: { /** Filter results to only include those that have this label. */ - readonly label?: string; - }; - }; + readonly label?: string + } + } readonly responses: { /** A list of providers. */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["Provider"][]; - }; - }; + readonly 'application/json': readonly components['schemas']['Provider'][] + } + } /** Unexpected Error */ readonly 500: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } + } + } readonly post: { readonly responses: { /** Complete provider object */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["Provider"]; - }; - }; + readonly 'application/json': components['schemas']['Provider'] + } + } /** Invalid request provided */ readonly 400: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } /** Forbidden */ readonly 403: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } /** Provider already exists with that label */ readonly 409: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ readonly 500: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } + } /** Provider create request */ readonly requestBody: { readonly content: { - readonly "application/json": components["schemas"]["CreateProvider"]; - }; - }; - }; - }; - readonly "/providers/{id}": { + readonly 'application/json': components['schemas']['CreateProvider'] + } + } + } + } + readonly '/providers/{id}': { readonly get: { readonly parameters: { readonly path: { /** ID of the provider to lookup, stored as a base32 encoded 18 byte identifier. */ - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** A provider. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["Provider"]; - }; - }; + readonly 'application/json': components['schemas']['Provider'] + } + } /** Unknown provider error */ readonly 404: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ readonly 500: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } + } + } readonly patch: { readonly parameters: { readonly path: { /** ID of the provider to update, stored as a base32 encoded 18 byte identifier. */ - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Complete provider object */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["Provider"]; - }; - }; + readonly 'application/json': components['schemas']['Provider'] + } + } /** Invalid request provided */ readonly 400: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } /** Forbidden */ readonly 403: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } /** Provider not found */ readonly 404: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } /** Provider already exists with that label */ readonly 409: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ readonly 500: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } + } /** Provider update request */ readonly requestBody: { readonly content: { - readonly "application/json": components["schemas"]["UpdateProvider"]; - }; - }; - }; - }; - readonly "/products/": { + readonly 'application/json': components['schemas']['UpdateProvider'] + } + } + } + } + readonly '/products/': { readonly get: { readonly parameters: { readonly query: { @@ -291,76 +291,76 @@ export interface paths { * Base32 encoded 18 byte identifier of the provider that these * products must belong to. */ - readonly provider_id?: string; + readonly provider_id?: string /** Filter results to only include those that have this label. */ - readonly label?: string; + readonly label?: string /** Return only products matching at least one of the tags. */ - readonly tags?: readonly string[]; - }; - }; + readonly tags?: readonly string[] + } + } readonly responses: { /** A product. */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["Product"][]; - }; - }; + readonly 'application/json': readonly components['schemas']['Product'][] + } + } /** Invalid provider_id supplied */ readonly 400: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ readonly 500: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } + } + } readonly post: { readonly responses: { /** Complete product object */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["Product"]; - }; - }; + readonly 'application/json': components['schemas']['Product'] + } + } /** Invalid request provided */ readonly 400: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } /** Forbidden */ readonly 403: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } /** Product already exists with that label */ readonly 409: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ readonly 500: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } + } /** Product create request */ readonly requestBody: { readonly content: { - readonly "application/json": components["schemas"]["CreateProduct"]; - }; - }; - }; - }; - readonly "/internal/products": { + readonly 'application/json': components['schemas']['CreateProduct'] + } + } + } + } + readonly '/internal/products': { readonly get: { readonly parameters: { readonly query: { @@ -368,38 +368,38 @@ export interface paths { * Base32 encoded 18 byte identifier of the provider that these * products must belong to. */ - readonly provider_id?: string; + readonly provider_id?: string /** Filter results to only include those that have this label. */ - readonly label?: string; + readonly label?: string /** Return only products matching at least one of the tags. */ - readonly tags?: readonly string[]; + readonly tags?: readonly string[] /** Return product listings without plan information */ - readonly include_plans?: boolean; - }; - }; + readonly include_plans?: boolean + } + } readonly responses: { /** A product. */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["ExpandedProduct"][]; - }; - }; + readonly 'application/json': readonly components['schemas']['ExpandedProduct'][] + } + } /** Invalid provider_id supplied */ readonly 400: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ readonly 500: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; - }; - readonly "/products/{id}": { + readonly 'application/json': components['schemas']['Error'] + } + } + } + } + } + readonly '/products/{id}': { readonly get: { readonly parameters: { readonly path: { @@ -407,36 +407,36 @@ export interface paths { * ID of the product to lookup, stored as a base32 encoded 18 byte * identifier. */ - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** A product. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["Product"]; - }; - }; + readonly 'application/json': components['schemas']['Product'] + } + } /** Invalid Product ID */ readonly 400: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } /** Product not found error */ readonly 404: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } /** Unexpected error */ readonly 500: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } + } + } readonly patch: { readonly parameters: { readonly path: { @@ -444,44 +444,44 @@ export interface paths { * ID of the product to lookup, stored as a base32 encoded 18 byte * identifier. */ - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Complete product object */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["Product"]; - }; - }; + readonly 'application/json': components['schemas']['Product'] + } + } /** Invalid Product ID */ readonly 400: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } /** Product not found error */ readonly 404: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } /** Unexpected error */ readonly 500: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } + } /** Product update request */ readonly requestBody: { readonly content: { - readonly "application/json": components["schemas"]["UpdateProduct"]; - }; - }; - }; - }; - readonly "/plans/{id}": { + readonly 'application/json': components['schemas']['UpdateProduct'] + } + } + } + } + readonly '/plans/{id}': { readonly get: { readonly parameters: { readonly path: { @@ -489,36 +489,36 @@ export interface paths { * ID of the plan to lookup, stored as a base32 encoded 18 byte * identifier. */ - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** A plan. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["ExpandedPlan"]; - }; - }; + readonly 'application/json': components['schemas']['ExpandedPlan'] + } + } /** Invalid Plan ID Provided */ readonly 400: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } /** Unknown plan error */ readonly 404: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } /** Unexpected error */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } + } + } readonly patch: { readonly parameters: { readonly path: { @@ -526,121 +526,121 @@ export interface paths { * ID of the plan to lookup, stored as a base32 encoded 18 byte * identifier. */ - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Complete product plan */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["Plan"]; - }; - }; + readonly 'application/json': components['schemas']['Plan'] + } + } /** Invalid Plan ID */ readonly 400: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } /** Plan not found error */ readonly 404: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } /** Unexpected error */ readonly 500: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } + } /** Plan update request */ readonly requestBody: { readonly content: { - readonly "application/json": components["schemas"]["UpdatePlan"]; - }; - }; - }; - }; - readonly "/plans/": { + readonly 'application/json': components['schemas']['UpdatePlan'] + } + } + } + } + readonly '/plans/': { readonly get: { readonly parameters: { readonly query: { /** Return the plans that are associated with this product. */ - readonly product_id: readonly string[]; + readonly product_id: readonly string[] /** Filter results to only include those that have this label. */ - readonly label?: string; - }; - }; + readonly label?: string + } + } readonly responses: { /** A list of plans for the given product. */ readonly 200: { readonly content: { - readonly "application/json": readonly components["schemas"]["ExpandedPlan"][]; - }; - }; + readonly 'application/json': readonly components['schemas']['ExpandedPlan'][] + } + } /** Invalid Parameters Provided */ readonly 400: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } /** Could not find product */ readonly 404: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } /** Unexpected error */ readonly 500: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } + } + } readonly post: { readonly responses: { /** Complete plan object */ readonly 201: { readonly content: { - readonly "application/json": components["schemas"]["Plan"]; - }; - }; + readonly 'application/json': components['schemas']['Plan'] + } + } /** Invalid request provided */ readonly 400: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } /** Forbidden */ readonly 403: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } /** Plan already exists with that label */ readonly 409: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ readonly 500: { readonly content: { - readonly "application/json": components["schemas"]["Error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['Error'] + } + } + } /** Plan create request */ readonly requestBody: { readonly content: { - readonly "application/json": components["schemas"]["CreatePlan"]; - }; - }; - }; - }; + readonly 'application/json': components['schemas']['CreatePlan'] + } + } + } + } } export interface components { @@ -649,202 +649,202 @@ export interface components { * Format: base32ID * @description A base32 encoded 18 byte identifier. */ - readonly ID: string; + readonly ID: string /** * Format: base32ID * @description A base32 encoded 18 byte identifier. */ - readonly OptionalID: string | null; + readonly OptionalID: string | null /** @description A flexible identifier for internal or external entities. */ - readonly FlexID: string; + readonly FlexID: string /** @description A flexible identifier for internal or external entities. */ - readonly OptionalFlexID: string | null; + readonly OptionalFlexID: string | null /** @description A machine readable unique label, which is url safe. */ - readonly Label: string; + readonly Label: string /** @description A machine readable unique label, which is url safe. */ - readonly OptionalLabel: string | null; + readonly OptionalLabel: string | null /** @description A machine readable unique label, which is url safe. */ - readonly FeatureValueLabel: string; + readonly FeatureValueLabel: string /** @description A location of where a potential resource can be provisioned. */ - readonly Location: string; + readonly Location: string /** @description A name of a platform which is used to provision resources. */ - readonly Platform: string; + readonly Platform: string /** @description A name of an entity which is displayed to a human. */ - readonly Name: string; + readonly Name: string /** @description A name of an entity which is displayed to a human. */ - readonly OptionalName: string | null; + readonly OptionalName: string | null /** * Format: url * @description Logo used for Provider and Product listings. * * Must be square (same width and height) and minimum 400px. Maximum of 800px. */ - readonly LogoURL: string; + readonly LogoURL: string /** * Format: url * @description Logo used for Provider and Product listings. * * Must be square (same width and height) and minimum 400px. Maximum of 800px. */ - readonly OptionalLogoURL: string | null; + readonly OptionalLogoURL: string | null readonly RegionBody: { - readonly platform: components["schemas"]["Platform"]; - readonly location: components["schemas"]["Location"]; - readonly name: string; - readonly priority: number; - }; + readonly platform: components['schemas']['Platform'] + readonly location: components['schemas']['Location'] + readonly name: string + readonly priority: number + } readonly Region: { - readonly id: components["schemas"]["ID"]; + readonly id: components['schemas']['ID'] /** @enum {string} */ - readonly type: "region"; - readonly version: number; - readonly body: components["schemas"]["RegionBody"]; - }; + readonly type: 'region' + readonly version: number + readonly body: components['schemas']['RegionBody'] + } readonly CreateRegion: { - readonly body: components["schemas"]["RegionBody"]; - }; + readonly body: components['schemas']['RegionBody'] + } readonly UpdateRegion: { - readonly name: string; - }; + readonly name: string + } readonly ProviderBody: { - readonly owner_id?: components["schemas"]["OptionalFlexID"]; - readonly team_id?: components["schemas"]["OptionalID"]; - readonly label: components["schemas"]["Label"]; - readonly name: components["schemas"]["Name"]; - readonly logo_url?: components["schemas"]["LogoURL"]; + readonly owner_id?: components['schemas']['OptionalFlexID'] + readonly team_id?: components['schemas']['OptionalID'] + readonly label: components['schemas']['Label'] + readonly name: components['schemas']['Name'] + readonly logo_url?: components['schemas']['LogoURL'] /** Format: email */ - readonly support_email?: string; + readonly support_email?: string /** Format: url */ - readonly documentation_url?: string; - }; + readonly documentation_url?: string + } readonly UpdateProviderBody: { - readonly owner_id?: components["schemas"]["OptionalFlexID"]; - readonly team_id?: components["schemas"]["OptionalID"]; - readonly label?: components["schemas"]["OptionalLabel"]; - readonly name?: components["schemas"]["OptionalName"]; - readonly logo_url?: components["schemas"]["OptionalLogoURL"]; + readonly owner_id?: components['schemas']['OptionalFlexID'] + readonly team_id?: components['schemas']['OptionalID'] + readonly label?: components['schemas']['OptionalLabel'] + readonly name?: components['schemas']['OptionalName'] + readonly logo_url?: components['schemas']['OptionalLogoURL'] /** Format: email */ - readonly support_email?: string | null; + readonly support_email?: string | null /** Format: url */ - readonly documentation_url?: string | null; - }; + readonly documentation_url?: string | null + } readonly Provider: { - readonly id: components["schemas"]["ID"]; - readonly version: number; + readonly id: components['schemas']['ID'] + readonly version: number /** @enum {string} */ - readonly type: "provider"; - readonly body: components["schemas"]["ProviderBody"]; - }; + readonly type: 'provider' + readonly body: components['schemas']['ProviderBody'] + } readonly CreateProvider: { - readonly body: components["schemas"]["ProviderBody"]; - }; + readonly body: components['schemas']['ProviderBody'] + } readonly UpdateProvider: { - readonly id: components["schemas"]["ID"]; - readonly body: components["schemas"]["UpdateProviderBody"]; - }; + readonly id: components['schemas']['ID'] + readonly body: components['schemas']['UpdateProviderBody'] + } readonly UpdateProduct: { - readonly id: components["schemas"]["ID"]; - readonly body: components["schemas"]["UpdateProductBody"]; - }; + readonly id: components['schemas']['ID'] + readonly body: components['schemas']['UpdateProductBody'] + } readonly UpdateProductBody: { - readonly name?: components["schemas"]["Name"]; - readonly label?: components["schemas"]["Label"]; - readonly logo_url?: components["schemas"]["LogoURL"]; - readonly listing?: components["schemas"]["ProductListing"]; + readonly name?: components['schemas']['Name'] + readonly label?: components['schemas']['Label'] + readonly logo_url?: components['schemas']['LogoURL'] + readonly listing?: components['schemas']['ProductListing'] /** @description 140 character sentence positioning the product. */ - readonly tagline?: string | null; + readonly tagline?: string | null /** @description A list of value propositions of the product. */ - readonly value_props?: readonly components["schemas"]["ValueProp"][] | null; + readonly value_props?: readonly components['schemas']['ValueProp'][] | null /** @description A list of getting started steps for the product */ - readonly setup_steps?: readonly string[] | null; - readonly images?: readonly components["schemas"]["ProductImageURL"][] | null; + readonly setup_steps?: readonly string[] | null + readonly images?: readonly components['schemas']['ProductImageURL'][] | null /** Format: email */ - readonly support_email?: string | null; + readonly support_email?: string | null /** Format: url */ - readonly documentation_url?: string | null; + readonly documentation_url?: string | null /** * @description URL to this Product's Terms of Service. If provided is true, then * a url must be set. Otherwise, provided is false. */ - readonly terms_url?: string | null; - readonly feature_types?: readonly components["schemas"]["FeatureType"][] | null; + readonly terms_url?: string | null + readonly feature_types?: readonly components['schemas']['FeatureType'][] | null readonly integration?: { - readonly provisioning?: components["schemas"]["ProductProvisioning"]; + readonly provisioning?: components['schemas']['ProductProvisioning'] /** Format: url */ - readonly base_url?: string | null; + readonly base_url?: string | null /** Format: url */ - readonly sso_url?: string | null; + readonly sso_url?: string | null /** @enum {string|null} */ - readonly version?: "v1" | null; + readonly version?: 'v1' | null readonly features?: { - readonly access_code?: boolean | null; - readonly sso?: boolean | null; - readonly plan_change?: boolean | null; + readonly access_code?: boolean | null + readonly sso?: boolean | null + readonly plan_change?: boolean | null /** * @default multiple * @enum {string|null} */ - readonly credential?: ("none" | "single" | "multiple" | "unknown") | null; - }; - } | null; + readonly credential?: ('none' | 'single' | 'multiple' | 'unknown') | null + } + } | null /** @description An array of platform ids to restrict this product for. */ - readonly platform_ids?: readonly components["schemas"]["ID"][] | null; - readonly tags?: components["schemas"]["ProductTags"]; - }; + readonly platform_ids?: readonly components['schemas']['ID'][] | null + readonly tags?: components['schemas']['ProductTags'] + } readonly UpdatePlan: { - readonly id: components["schemas"]["ID"]; - readonly body: components["schemas"]["UpdatePlanBody"]; - }; + readonly id: components['schemas']['ID'] + readonly body: components['schemas']['UpdatePlanBody'] + } readonly UpdatePlanBody: { - readonly name?: components["schemas"]["Name"]; - readonly label?: components["schemas"]["Label"]; - readonly state?: components["schemas"]["PlanState"]; + readonly name?: components['schemas']['Name'] + readonly label?: components['schemas']['Label'] + readonly state?: components['schemas']['PlanState'] /** @description Used in conjuction with resizable_to to set or unset the list */ - readonly has_resize_constraints?: boolean | null; - readonly resizable_to?: components["schemas"]["PlanResizeList"]; + readonly has_resize_constraints?: boolean | null + readonly resizable_to?: components['schemas']['PlanResizeList'] /** @description Array of Region IDs */ - readonly regions?: readonly components["schemas"]["ID"][] | null; + readonly regions?: readonly components['schemas']['ID'][] | null /** @description Array of Feature Values */ - readonly features?: readonly components["schemas"]["FeatureValue"][] | null; + readonly features?: readonly components['schemas']['FeatureValue'][] | null /** * @description The number of days a user gets as a free trial when subscribing to * this plan. Trials are valid only once per product; changing plans * or adding an additional subscription will not start a new trial. */ - readonly trial_days?: number | null; + readonly trial_days?: number | null /** @description Dollar value in cents */ - readonly cost?: number | null; - }; + readonly cost?: number | null + } /** * @description A feature type represents the different aspects of a product that are * offered, these features can manifest differently depending on the plan. */ readonly FeatureType: { - readonly label: components["schemas"]["Label"]; - readonly name: components["schemas"]["Name"]; + readonly label: components['schemas']['Label'] + readonly name: components['schemas']['Name'] /** @enum {string} */ - readonly type: "boolean" | "string" | "number"; + readonly type: 'boolean' | 'string' | 'number' /** @description This sets whether or not the feature can be customized by a consumer. */ - readonly customizable?: boolean; + readonly customizable?: boolean /** * @description This sets whether or not the feature can be upgraded by the consumer after the * resource has provisioned. Upgrading means setting a higher value or selecting a * higher element in the list. */ - readonly upgradable?: boolean; + readonly upgradable?: boolean /** * @description This sets whether or not the feature can be downgraded by the consumer after the * resource has provisioned. Downgrading means setting a lower value or selecting a * lower element in the list. */ - readonly downgradable?: boolean; + readonly downgradable?: boolean /** * @description Sets if this feature’s value is trackable from the provider, * this only really affects numeric constraints. */ - readonly measurable?: boolean; - readonly values?: components["schemas"]["FeatureValuesList"]; - }; + readonly measurable?: boolean + readonly values?: components['schemas']['FeatureValuesList'] + } /** * @description A list of allowable values for the feature. * To define values for a boolean feature type, only `true` is required, @@ -853,16 +853,16 @@ export interface components { * `numeric_details` definition, and the plan will determine which * `numeric_details` set is used based on it's setting. */ - readonly FeatureValuesList: readonly components["schemas"]["FeatureValueDetails"][] | null; + readonly FeatureValuesList: readonly components['schemas']['FeatureValueDetails'][] | null readonly FeatureValueDetails: { - readonly label: components["schemas"]["FeatureValueLabel"]; - readonly name: components["schemas"]["Name"]; + readonly label: components['schemas']['FeatureValueLabel'] + readonly name: components['schemas']['Name'] /** * @description The cost that will be added to the monthly plan cost when this value * is selected or is default for the plan. * Cost is deprecated in favor of the `price.cost` field. */ - readonly cost?: number; + readonly cost?: number /** * @description Price describes the cost of a feature. It should be preferred over * the `cost` property. @@ -873,19 +873,19 @@ export interface components { * when this value is selected or is default for the plan. * Number features should use the cost range instead. */ - readonly cost?: number; + readonly cost?: number /** * @description When a feature is used to multiply the cost of the plan or of * another feature, multiply factor is used for calculation. * A feature cannot have both a cost and a multiply factor. */ - readonly multiply_factor?: number; - readonly formula?: components["schemas"]["PriceFormula"]; + readonly multiply_factor?: number + readonly formula?: components['schemas']['PriceFormula'] /** @description Description explains how a feature is calculated to the user. */ - readonly description?: string; - }; - readonly numeric_details?: components["schemas"]["FeatureNumericDetails"]; - }; + readonly description?: string + } + readonly numeric_details?: components['schemas']['FeatureNumericDetails'] + } /** * @description Optional container for additional details relating to numeric features. * This is required if the feature is measurable and numeric. @@ -899,15 +899,15 @@ export interface components { * means this numeric details has no scale, and will not be or customizable. * Some plans may not have a measureable or customizable feature. */ - readonly increment?: number; + readonly increment?: number /** @description Minimum value that can be set by a user if customizable */ - readonly min?: number; + readonly min?: number /** @description Maximum value that can be set by a user if customizable */ - readonly max?: number | null; + readonly max?: number | null /** @description Applied to the end of the number for display, for example the ‘GB’ in ‘20 GB’. */ - readonly suffix?: string | null; - readonly cost_ranges?: readonly components["schemas"]["FeatureNumericRange"][] | null; - } | null; + readonly suffix?: string | null + readonly cost_ranges?: readonly components['schemas']['FeatureNumericRange'][] | null + } | null readonly FeatureNumericRange: { /** * @description Defines the end of the range ( inclusive ), from the previous, or 0; @@ -915,40 +915,40 @@ export interface components { * range to infinity, or the maximum integer the system can handle * ( whichever comes first ). */ - readonly limit?: number; + readonly limit?: number /** * @description An integer in 10,000,000ths of cents, will be multiplied by the * numeric value set in the feature to determine the cost. */ - readonly cost_multiple?: number; - }; + readonly cost_multiple?: number + } readonly FeatureValue: { - readonly feature: components["schemas"]["Label"]; - readonly value: components["schemas"]["FeatureValueLabel"]; - }; + readonly feature: components['schemas']['Label'] + readonly value: components['schemas']['FeatureValueLabel'] + } readonly ValueProp: { /** @description Heading of a value proposition. */ - readonly header: string; + readonly header: string /** @description Body of a value proposition. */ - readonly body: string; - }; + readonly body: string + } /** * Format: url * @description Image URL used for Product listings. * * Minimum 660px wide, 400px high. */ - readonly ProductImageURL: string; + readonly ProductImageURL: string /** @description List of tags for product categorization and search */ - readonly ProductTags: readonly components["schemas"]["Label"][]; + readonly ProductTags: readonly components['schemas']['Label'][] /** @enum {string} */ - readonly ProductState: "available" | "hidden" | "grandfathered" | "new" | "upcoming"; + readonly ProductState: 'available' | 'hidden' | 'grandfathered' | 'new' | 'upcoming' readonly ProductListing: { /** * @description When true, everyone can see the product when requested. When false it will * not be visible to anyone except those on the provider team. */ - readonly public?: boolean; + readonly public?: boolean /** * @description When true, the product will be displayed in product listings alongside * other products. When false the product will be excluded from listings, @@ -956,7 +956,7 @@ export interface components { * Any pages that display information about the product when not listed, * should indicate to webcrawlers that the content should not be indexed. */ - readonly listed?: boolean; + readonly listed?: boolean /** * @description Object to hold various flags for marketing purposes only. These are values * that need to be stored, but should not affect decision making in code. If @@ -969,21 +969,21 @@ export interface components { * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. */ - readonly beta?: boolean; + readonly beta?: boolean /** * @description Indicates whether or not the product is in `New` and should be * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. */ - readonly new?: boolean; + readonly new?: boolean /** * @description Indicates whether or not the product is in `New` and should be * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. */ - readonly featured?: boolean; - }; - }; + readonly featured?: boolean + } + } /** * @description Provider Only, implies that the product should only be provisionable by the * provider; so members of the provider team, no one else should be allowed. @@ -993,23 +993,23 @@ export interface components { * * @enum {string} */ - readonly ProductProvisioning: "provider-only" | "pre-order" | "public"; + readonly ProductProvisioning: 'provider-only' | 'pre-order' | 'public' readonly ProductIntegrationFeatures: { /** * @description Indicates whether or not this product supports resource transitions to * manifold by access_code. */ - readonly access_code?: boolean; + readonly access_code?: boolean /** * @description Represents whether or not this product supports Single * Sign On */ - readonly sso?: boolean; + readonly sso?: boolean /** * @description Represents whether or not this product supports changing * the plan of a resource. */ - readonly plan_change?: boolean; + readonly plan_change?: boolean /** * @description Describes how the region for a resource is specified, if * unspecified, then regions have no impact on this @@ -1017,7 +1017,7 @@ export interface components { * * @enum {string} */ - readonly region?: "user-specified" | "unspecified"; + readonly region?: 'user-specified' | 'unspecified' /** * @description Describes the credential type that is supported by this product. * @@ -1029,127 +1029,127 @@ export interface components { * @default multiple * @enum {string} */ - readonly credential?: "none" | "single" | "multiple" | "unknown"; - }; + readonly credential?: 'none' | 'single' | 'multiple' | 'unknown' + } readonly ProductBody: { - readonly provider_id: components["schemas"]["ID"]; - readonly label: components["schemas"]["Label"]; - readonly name: components["schemas"]["Name"]; - readonly state: components["schemas"]["ProductState"]; - readonly listing: components["schemas"]["ProductListing"]; - readonly logo_url: components["schemas"]["LogoURL"]; + readonly provider_id: components['schemas']['ID'] + readonly label: components['schemas']['Label'] + readonly name: components['schemas']['Name'] + readonly state: components['schemas']['ProductState'] + readonly listing: components['schemas']['ProductListing'] + readonly logo_url: components['schemas']['LogoURL'] /** @description 140 character sentence positioning the product. */ - readonly tagline: string; + readonly tagline: string /** @description A list of value propositions of the product. */ - readonly value_props: readonly components["schemas"]["ValueProp"][]; + readonly value_props: readonly components['schemas']['ValueProp'][] /** @description A list of getting started steps for the product */ - readonly setup_steps?: readonly string[] | null; - readonly images: readonly components["schemas"]["ProductImageURL"][]; + readonly setup_steps?: readonly string[] | null + readonly images: readonly components['schemas']['ProductImageURL'][] /** Format: email */ - readonly support_email: string; + readonly support_email: string /** Format: url */ - readonly documentation_url: string; + readonly documentation_url: string /** * @description URL to this Product's Terms of Service. If provided is true, then * a url must be set. Otherwise, provided is false. */ readonly terms: { /** Format: url */ - readonly url?: string | null; - readonly provided: boolean; - }; - readonly feature_types: readonly components["schemas"]["FeatureType"][]; + readonly url?: string | null + readonly provided: boolean + } + readonly feature_types: readonly components['schemas']['FeatureType'][] readonly billing: { /** @enum {string} */ - readonly type: "monthly-prorated" | "monthly-anniversary" | "annual-anniversary"; + readonly type: 'monthly-prorated' | 'monthly-anniversary' | 'annual-anniversary' /** @enum {string} */ - readonly currency: "usd"; - }; + readonly currency: 'usd' + } readonly integration: { - readonly provisioning: components["schemas"]["ProductProvisioning"]; + readonly provisioning: components['schemas']['ProductProvisioning'] /** Format: url */ - readonly base_url: string; + readonly base_url: string /** Format: url */ - readonly sso_url?: string | null; + readonly sso_url?: string | null /** @enum {string} */ - readonly version: "v1"; - readonly features: components["schemas"]["ProductIntegrationFeatures"]; - }; - readonly tags?: components["schemas"]["ProductTags"]; - }; + readonly version: 'v1' + readonly features: components['schemas']['ProductIntegrationFeatures'] + } + readonly tags?: components['schemas']['ProductTags'] + } readonly Product: { - readonly id: components["schemas"]["ID"]; - readonly version: number; + readonly id: components['schemas']['ID'] + readonly version: number /** @enum {string} */ - readonly type: "product"; - readonly body: components["schemas"]["ProductBody"]; - }; + readonly type: 'product' + readonly body: components['schemas']['ProductBody'] + } readonly CreateProduct: { - readonly body: components["schemas"]["ProductBody"]; - }; + readonly body: components['schemas']['ProductBody'] + } /** @description Array of Plan IDs that this Plan can be resized to, if null all will be assumed */ - readonly PlanResizeList: readonly components["schemas"]["ID"][] | null; + readonly PlanResizeList: readonly components['schemas']['ID'][] | null readonly PlanBody: { - readonly provider_id: components["schemas"]["ID"]; - readonly product_id: components["schemas"]["ID"]; - readonly name: components["schemas"]["Name"]; - readonly label: components["schemas"]["Label"]; - readonly state: components["schemas"]["PlanState"]; - readonly resizable_to?: components["schemas"]["PlanResizeList"]; + readonly provider_id: components['schemas']['ID'] + readonly product_id: components['schemas']['ID'] + readonly name: components['schemas']['Name'] + readonly label: components['schemas']['Label'] + readonly state: components['schemas']['PlanState'] + readonly resizable_to?: components['schemas']['PlanResizeList'] /** @description Array of Region IDs */ - readonly regions: readonly components["schemas"]["ID"][]; + readonly regions: readonly components['schemas']['ID'][] /** @description Array of Feature Values */ - readonly features: readonly components["schemas"]["FeatureValue"][]; + readonly features: readonly components['schemas']['FeatureValue'][] /** * @description The number of days a user gets as a free trial when subscribing to * this plan. Trials are valid only once per product; changing plans * or adding an additional subscription will not start a new trial. */ - readonly trial_days?: number; + readonly trial_days?: number /** @description Dollar value in cents. */ - readonly cost: number; - }; + readonly cost: number + } /** @enum {string} */ - readonly PlanState: "hidden" | "available" | "grandfathered" | "unlisted"; - readonly ExpandedPlanBody: components["schemas"]["PlanBody"] & { + readonly PlanState: 'hidden' | 'available' | 'grandfathered' | 'unlisted' + readonly ExpandedPlanBody: components['schemas']['PlanBody'] & { /** @description An array of feature definitions for the plan, as defined on the Product. */ - readonly expanded_features: readonly components["schemas"]["ExpandedFeature"][]; + readonly expanded_features: readonly components['schemas']['ExpandedFeature'][] /** @description A boolean flag that indicates if a plan is free or not based on it's cost and features. */ - readonly free: boolean; + readonly free: boolean /** @description Plan cost using its default features plus base cost. */ - readonly defaultCost?: number; + readonly defaultCost?: number /** @description A boolean flag that indicates if a plan has customizable features. */ - readonly customizable?: boolean; - }; - readonly ExpandedFeature: components["schemas"]["FeatureType"] & { + readonly customizable?: boolean + } + readonly ExpandedFeature: components['schemas']['FeatureType'] & { /** @description The string value set for the feature on the plan, this should only be used if the value property is null. */ - readonly value_string: string; - readonly value: components["schemas"]["FeatureValueDetails"]; - }; + readonly value_string: string + readonly value: components['schemas']['FeatureValueDetails'] + } readonly Plan: { - readonly id: components["schemas"]["ID"]; - readonly version: number; + readonly id: components['schemas']['ID'] + readonly version: number /** @enum {string} */ - readonly type: "plan"; - readonly body: components["schemas"]["PlanBody"]; - }; + readonly type: 'plan' + readonly body: components['schemas']['PlanBody'] + } readonly ExpandedPlan: { - readonly id: components["schemas"]["ID"]; - readonly version: number; + readonly id: components['schemas']['ID'] + readonly version: number /** @enum {string} */ - readonly type: "plan"; - readonly body: components["schemas"]["ExpandedPlanBody"]; - }; + readonly type: 'plan' + readonly body: components['schemas']['ExpandedPlanBody'] + } readonly CreatePlan: { - readonly body: components["schemas"]["PlanBody"]; - }; + readonly body: components['schemas']['PlanBody'] + } /** @description Unexpected error */ readonly Error: { /** @description The error type */ - readonly type: string; + readonly type: string /** @description Explanation of the errors */ - readonly message: readonly string[]; - }; + readonly message: readonly string[] + } /** * @description Describes how a feature cost should be calculated. An empty * string defaults to the normal price calculation using the value cost. @@ -1173,21 +1173,21 @@ export interface components { * - `another-feature-label#number` is the numeric value of a number feature * In a feature formula, plan base cost and total cost cannot be used */ - readonly PriceFormula: string; + readonly PriceFormula: string readonly ExpandedProduct: { - readonly id: components["schemas"]["ID"]; - readonly version: number; + readonly id: components['schemas']['ID'] + readonly version: number /** @enum {string} */ - readonly type: "product"; - readonly body: components["schemas"]["ProductBody"]; - readonly plans?: readonly components["schemas"]["ExpandedPlan"][]; - readonly provider: components["schemas"]["Provider"]; - }; - }; + readonly type: 'product' + readonly body: components['schemas']['ProductBody'] + readonly plans?: readonly components['schemas']['ExpandedPlan'][] + readonly provider: components['schemas']['Provider'] + } + } readonly parameters: { /** @description Filter results to only include those that have this label. */ - readonly LabelFilter: string; - }; + readonly LabelFilter: string + } } export interface operations {} diff --git a/test/v3/expected/manifold.support-array-length.ts b/test/v3/expected/manifold.support-array-length.ts index 9280fd9c2..4a49d45e4 100644 --- a/test/v3/expected/manifold.support-array-length.ts +++ b/test/v3/expected/manifold.support-array-length.ts @@ -4,286 +4,286 @@ */ export interface paths { - "/regions/": { + '/regions/': { get: { parameters: { query: { /** Filter results to only include the regions that have this location. */ - location?: string; + location?: string /** * Filter results to only include the regions that are on this * platform. */ - platform?: string; - }; - }; + platform?: string + } + } responses: { /** A list of regions. */ 200: { content: { - "application/json": components["schemas"]["Region"][]; - }; - }; + 'application/json': components['schemas']['Region'][] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } + } post: { responses: { /** Complete region object */ 201: { content: { - "application/json": components["schemas"]["Region"]; - }; - }; + 'application/json': components['schemas']['Region'] + } + } /** Invalid request provided */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Region already exists for that platform and location */ 409: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } /** Region create request */ requestBody: { content: { - "application/json": components["schemas"]["CreateRegion"]; - }; - }; - }; - }; - "/regions/{id}": { + 'application/json': components['schemas']['CreateRegion'] + } + } + } + } + '/regions/{id}': { get: { parameters: { path: { /** ID of the region to lookup, stored as a base32 encoded 18 byte identifier. */ - id: string; - }; - }; + id: string + } + } responses: { /** A region. */ 200: { content: { - "application/json": components["schemas"]["Region"]; - }; - }; + 'application/json': components['schemas']['Region'] + } + } /** Provided Region ID is Invalid */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Region could not be found */ 404: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } + } patch: { parameters: { path: { /** ID of the region to lookup, stored as a base32 encoded 18 byte identifier. */ - id: string; - }; - }; + id: string + } + } responses: { /** Complete region object */ 200: { content: { - "application/json": components["schemas"]["Region"]; - }; - }; + 'application/json': components['schemas']['Region'] + } + } /** Invalid request provided */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } /** Region update request */ requestBody: { content: { - "application/json": components["schemas"]["UpdateRegion"]; - }; - }; - }; - }; - "/providers/": { + 'application/json': components['schemas']['UpdateRegion'] + } + } + } + } + '/providers/': { get: { parameters: { query: { /** Filter results to only include those that have this label. */ - label?: string; - }; - }; + label?: string + } + } responses: { /** A list of providers. */ 200: { content: { - "application/json": components["schemas"]["Provider"][]; - }; - }; + 'application/json': components['schemas']['Provider'][] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } + } post: { responses: { /** Complete provider object */ 201: { content: { - "application/json": components["schemas"]["Provider"]; - }; - }; + 'application/json': components['schemas']['Provider'] + } + } /** Invalid request provided */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Forbidden */ 403: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Provider already exists with that label */ 409: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } /** Provider create request */ requestBody: { content: { - "application/json": components["schemas"]["CreateProvider"]; - }; - }; - }; - }; - "/providers/{id}": { + 'application/json': components['schemas']['CreateProvider'] + } + } + } + } + '/providers/{id}': { get: { parameters: { path: { /** ID of the provider to lookup, stored as a base32 encoded 18 byte identifier. */ - id: string; - }; - }; + id: string + } + } responses: { /** A provider. */ 200: { content: { - "application/json": components["schemas"]["Provider"]; - }; - }; + 'application/json': components['schemas']['Provider'] + } + } /** Unknown provider error */ 404: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } + } patch: { parameters: { path: { /** ID of the provider to update, stored as a base32 encoded 18 byte identifier. */ - id: string; - }; - }; + id: string + } + } responses: { /** Complete provider object */ 200: { content: { - "application/json": components["schemas"]["Provider"]; - }; - }; + 'application/json': components['schemas']['Provider'] + } + } /** Invalid request provided */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Forbidden */ 403: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Provider not found */ 404: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Provider already exists with that label */ 409: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } /** Provider update request */ requestBody: { content: { - "application/json": components["schemas"]["UpdateProvider"]; - }; - }; - }; - }; - "/products/": { + 'application/json': components['schemas']['UpdateProvider'] + } + } + } + } + '/products/': { get: { parameters: { query: { @@ -291,76 +291,76 @@ export interface paths { * Base32 encoded 18 byte identifier of the provider that these * products must belong to. */ - provider_id?: string; + provider_id?: string /** Filter results to only include those that have this label. */ - label?: string; + label?: string /** Return only products matching at least one of the tags. */ - tags?: string[]; - }; - }; + tags?: string[] + } + } responses: { /** A product. */ 200: { content: { - "application/json": components["schemas"]["Product"][]; - }; - }; + 'application/json': components['schemas']['Product'][] + } + } /** Invalid provider_id supplied */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } + } post: { responses: { /** Complete product object */ 201: { content: { - "application/json": components["schemas"]["Product"]; - }; - }; + 'application/json': components['schemas']['Product'] + } + } /** Invalid request provided */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Forbidden */ 403: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Product already exists with that label */ 409: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } /** Product create request */ requestBody: { content: { - "application/json": components["schemas"]["CreateProduct"]; - }; - }; - }; - }; - "/internal/products": { + 'application/json': components['schemas']['CreateProduct'] + } + } + } + } + '/internal/products': { get: { parameters: { query: { @@ -368,38 +368,38 @@ export interface paths { * Base32 encoded 18 byte identifier of the provider that these * products must belong to. */ - provider_id?: string; + provider_id?: string /** Filter results to only include those that have this label. */ - label?: string; + label?: string /** Return only products matching at least one of the tags. */ - tags?: string[]; + tags?: string[] /** Return product listings without plan information */ - include_plans?: boolean; - }; - }; + include_plans?: boolean + } + } responses: { /** A product. */ 200: { content: { - "application/json": components["schemas"]["ExpandedProduct"][]; - }; - }; + 'application/json': components['schemas']['ExpandedProduct'][] + } + } /** Invalid provider_id supplied */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; - }; - "/products/{id}": { + 'application/json': components['schemas']['Error'] + } + } + } + } + } + '/products/{id}': { get: { parameters: { path: { @@ -407,36 +407,36 @@ export interface paths { * ID of the product to lookup, stored as a base32 encoded 18 byte * identifier. */ - id: string; - }; - }; + id: string + } + } responses: { /** A product. */ 200: { content: { - "application/json": components["schemas"]["Product"]; - }; - }; + 'application/json': components['schemas']['Product'] + } + } /** Invalid Product ID */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Product not found error */ 404: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } + } patch: { parameters: { path: { @@ -444,44 +444,44 @@ export interface paths { * ID of the product to lookup, stored as a base32 encoded 18 byte * identifier. */ - id: string; - }; - }; + id: string + } + } responses: { /** Complete product object */ 200: { content: { - "application/json": components["schemas"]["Product"]; - }; - }; + 'application/json': components['schemas']['Product'] + } + } /** Invalid Product ID */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Product not found error */ 404: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } /** Product update request */ requestBody: { content: { - "application/json": components["schemas"]["UpdateProduct"]; - }; - }; - }; - }; - "/plans/{id}": { + 'application/json': components['schemas']['UpdateProduct'] + } + } + } + } + '/plans/{id}': { get: { parameters: { path: { @@ -489,36 +489,36 @@ export interface paths { * ID of the plan to lookup, stored as a base32 encoded 18 byte * identifier. */ - id: string; - }; - }; + id: string + } + } responses: { /** A plan. */ 200: { content: { - "application/json": components["schemas"]["ExpandedPlan"]; - }; - }; + 'application/json': components['schemas']['ExpandedPlan'] + } + } /** Invalid Plan ID Provided */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unknown plan error */ 404: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected error */ default: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } + } patch: { parameters: { path: { @@ -526,121 +526,121 @@ export interface paths { * ID of the plan to lookup, stored as a base32 encoded 18 byte * identifier. */ - id: string; - }; - }; + id: string + } + } responses: { /** Complete product plan */ 200: { content: { - "application/json": components["schemas"]["Plan"]; - }; - }; + 'application/json': components['schemas']['Plan'] + } + } /** Invalid Plan ID */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Plan not found error */ 404: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } /** Plan update request */ requestBody: { content: { - "application/json": components["schemas"]["UpdatePlan"]; - }; - }; - }; - }; - "/plans/": { + 'application/json': components['schemas']['UpdatePlan'] + } + } + } + } + '/plans/': { get: { parameters: { query: { /** Return the plans that are associated with this product. */ - product_id: string[]; + product_id: string[] /** Filter results to only include those that have this label. */ - label?: string; - }; - }; + label?: string + } + } responses: { /** A list of plans for the given product. */ 200: { content: { - "application/json": components["schemas"]["ExpandedPlan"][]; - }; - }; + 'application/json': components['schemas']['ExpandedPlan'][] + } + } /** Invalid Parameters Provided */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Could not find product */ 404: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } + } post: { responses: { /** Complete plan object */ 201: { content: { - "application/json": components["schemas"]["Plan"]; - }; - }; + 'application/json': components['schemas']['Plan'] + } + } /** Invalid request provided */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Forbidden */ 403: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Plan already exists with that label */ 409: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } /** Plan create request */ requestBody: { content: { - "application/json": components["schemas"]["CreatePlan"]; - }; - }; - }; - }; + 'application/json': components['schemas']['CreatePlan'] + } + } + } + } } export interface components { @@ -649,202 +649,202 @@ export interface components { * Format: base32ID * @description A base32 encoded 18 byte identifier. */ - ID: string; + ID: string /** * Format: base32ID * @description A base32 encoded 18 byte identifier. */ - OptionalID: string | null; + OptionalID: string | null /** @description A flexible identifier for internal or external entities. */ - FlexID: string; + FlexID: string /** @description A flexible identifier for internal or external entities. */ - OptionalFlexID: string | null; + OptionalFlexID: string | null /** @description A machine readable unique label, which is url safe. */ - Label: string; + Label: string /** @description A machine readable unique label, which is url safe. */ - OptionalLabel: string | null; + OptionalLabel: string | null /** @description A machine readable unique label, which is url safe. */ - FeatureValueLabel: string; + FeatureValueLabel: string /** @description A location of where a potential resource can be provisioned. */ - Location: string; + Location: string /** @description A name of a platform which is used to provision resources. */ - Platform: string; + Platform: string /** @description A name of an entity which is displayed to a human. */ - Name: string; + Name: string /** @description A name of an entity which is displayed to a human. */ - OptionalName: string | null; + OptionalName: string | null /** * Format: url * @description Logo used for Provider and Product listings. * * Must be square (same width and height) and minimum 400px. Maximum of 800px. */ - LogoURL: string; + LogoURL: string /** * Format: url * @description Logo used for Provider and Product listings. * * Must be square (same width and height) and minimum 400px. Maximum of 800px. */ - OptionalLogoURL: string | null; + OptionalLogoURL: string | null RegionBody: { - platform: components["schemas"]["Platform"]; - location: components["schemas"]["Location"]; - name: string; - priority: number; - }; + platform: components['schemas']['Platform'] + location: components['schemas']['Location'] + name: string + priority: number + } Region: { - id: components["schemas"]["ID"]; + id: components['schemas']['ID'] /** @enum {string} */ - type: "region"; - version: number; - body: components["schemas"]["RegionBody"]; - }; + type: 'region' + version: number + body: components['schemas']['RegionBody'] + } CreateRegion: { - body: components["schemas"]["RegionBody"]; - }; + body: components['schemas']['RegionBody'] + } UpdateRegion: { - name: string; - }; + name: string + } ProviderBody: { - owner_id?: components["schemas"]["OptionalFlexID"]; - team_id?: components["schemas"]["OptionalID"]; - label: components["schemas"]["Label"]; - name: components["schemas"]["Name"]; - logo_url?: components["schemas"]["LogoURL"]; + owner_id?: components['schemas']['OptionalFlexID'] + team_id?: components['schemas']['OptionalID'] + label: components['schemas']['Label'] + name: components['schemas']['Name'] + logo_url?: components['schemas']['LogoURL'] /** Format: email */ - support_email?: string; + support_email?: string /** Format: url */ - documentation_url?: string; - }; + documentation_url?: string + } UpdateProviderBody: { - owner_id?: components["schemas"]["OptionalFlexID"]; - team_id?: components["schemas"]["OptionalID"]; - label?: components["schemas"]["OptionalLabel"]; - name?: components["schemas"]["OptionalName"]; - logo_url?: components["schemas"]["OptionalLogoURL"]; + owner_id?: components['schemas']['OptionalFlexID'] + team_id?: components['schemas']['OptionalID'] + label?: components['schemas']['OptionalLabel'] + name?: components['schemas']['OptionalName'] + logo_url?: components['schemas']['OptionalLogoURL'] /** Format: email */ - support_email?: string | null; + support_email?: string | null /** Format: url */ - documentation_url?: string | null; - }; + documentation_url?: string | null + } Provider: { - id: components["schemas"]["ID"]; - version: number; + id: components['schemas']['ID'] + version: number /** @enum {string} */ - type: "provider"; - body: components["schemas"]["ProviderBody"]; - }; + type: 'provider' + body: components['schemas']['ProviderBody'] + } CreateProvider: { - body: components["schemas"]["ProviderBody"]; - }; + body: components['schemas']['ProviderBody'] + } UpdateProvider: { - id: components["schemas"]["ID"]; - body: components["schemas"]["UpdateProviderBody"]; - }; + id: components['schemas']['ID'] + body: components['schemas']['UpdateProviderBody'] + } UpdateProduct: { - id: components["schemas"]["ID"]; - body: components["schemas"]["UpdateProductBody"]; - }; + id: components['schemas']['ID'] + body: components['schemas']['UpdateProductBody'] + } UpdateProductBody: { - name?: components["schemas"]["Name"]; - label?: components["schemas"]["Label"]; - logo_url?: components["schemas"]["LogoURL"]; - listing?: components["schemas"]["ProductListing"]; + name?: components['schemas']['Name'] + label?: components['schemas']['Label'] + logo_url?: components['schemas']['LogoURL'] + listing?: components['schemas']['ProductListing'] /** @description 140 character sentence positioning the product. */ - tagline?: string | null; + tagline?: string | null /** @description A list of value propositions of the product. */ - value_props?: components["schemas"]["ValueProp"][] | null; + value_props?: components['schemas']['ValueProp'][] | null /** @description A list of getting started steps for the product */ - setup_steps?: string[] | null; - images?: components["schemas"]["ProductImageURL"][] | null; + setup_steps?: string[] | null + images?: components['schemas']['ProductImageURL'][] | null /** Format: email */ - support_email?: string | null; + support_email?: string | null /** Format: url */ - documentation_url?: string | null; + documentation_url?: string | null /** * @description URL to this Product's Terms of Service. If provided is true, then * a url must be set. Otherwise, provided is false. */ - terms_url?: string | null; - feature_types?: components["schemas"]["FeatureType"][] | null; + terms_url?: string | null + feature_types?: components['schemas']['FeatureType'][] | null integration?: { - provisioning?: components["schemas"]["ProductProvisioning"]; + provisioning?: components['schemas']['ProductProvisioning'] /** Format: url */ - base_url?: string | null; + base_url?: string | null /** Format: url */ - sso_url?: string | null; + sso_url?: string | null /** @enum {string|null} */ - version?: "v1" | null; + version?: 'v1' | null features?: { - access_code?: boolean | null; - sso?: boolean | null; - plan_change?: boolean | null; + access_code?: boolean | null + sso?: boolean | null + plan_change?: boolean | null /** * @default multiple * @enum {string|null} */ - credential?: ("none" | "single" | "multiple" | "unknown") | null; - }; - } | null; + credential?: ('none' | 'single' | 'multiple' | 'unknown') | null + } + } | null /** @description An array of platform ids to restrict this product for. */ - platform_ids?: components["schemas"]["ID"][] | null; - tags?: components["schemas"]["ProductTags"]; - }; + platform_ids?: components['schemas']['ID'][] | null + tags?: components['schemas']['ProductTags'] + } UpdatePlan: { - id: components["schemas"]["ID"]; - body: components["schemas"]["UpdatePlanBody"]; - }; + id: components['schemas']['ID'] + body: components['schemas']['UpdatePlanBody'] + } UpdatePlanBody: { - name?: components["schemas"]["Name"]; - label?: components["schemas"]["Label"]; - state?: components["schemas"]["PlanState"]; + name?: components['schemas']['Name'] + label?: components['schemas']['Label'] + state?: components['schemas']['PlanState'] /** @description Used in conjuction with resizable_to to set or unset the list */ - has_resize_constraints?: boolean | null; - resizable_to?: components["schemas"]["PlanResizeList"]; + has_resize_constraints?: boolean | null + resizable_to?: components['schemas']['PlanResizeList'] /** @description Array of Region IDs */ - regions?: components["schemas"]["ID"][] | null; + regions?: components['schemas']['ID'][] | null /** @description Array of Feature Values */ - features?: components["schemas"]["FeatureValue"][] | null; + features?: components['schemas']['FeatureValue'][] | null /** * @description The number of days a user gets as a free trial when subscribing to * this plan. Trials are valid only once per product; changing plans * or adding an additional subscription will not start a new trial. */ - trial_days?: number | null; + trial_days?: number | null /** @description Dollar value in cents */ - cost?: number | null; - }; + cost?: number | null + } /** * @description A feature type represents the different aspects of a product that are * offered, these features can manifest differently depending on the plan. */ FeatureType: { - label: components["schemas"]["Label"]; - name: components["schemas"]["Name"]; + label: components['schemas']['Label'] + name: components['schemas']['Name'] /** @enum {string} */ - type: "boolean" | "string" | "number"; + type: 'boolean' | 'string' | 'number' /** @description This sets whether or not the feature can be customized by a consumer. */ - customizable?: boolean; + customizable?: boolean /** * @description This sets whether or not the feature can be upgraded by the consumer after the * resource has provisioned. Upgrading means setting a higher value or selecting a * higher element in the list. */ - upgradable?: boolean; + upgradable?: boolean /** * @description This sets whether or not the feature can be downgraded by the consumer after the * resource has provisioned. Downgrading means setting a lower value or selecting a * lower element in the list. */ - downgradable?: boolean; + downgradable?: boolean /** * @description Sets if this feature’s value is trackable from the provider, * this only really affects numeric constraints. */ - measurable?: boolean; - values?: components["schemas"]["FeatureValuesList"]; - }; + measurable?: boolean + values?: components['schemas']['FeatureValuesList'] + } /** * @description A list of allowable values for the feature. * To define values for a boolean feature type, only `true` is required, @@ -853,16 +853,16 @@ export interface components { * `numeric_details` definition, and the plan will determine which * `numeric_details` set is used based on it's setting. */ - FeatureValuesList: components["schemas"]["FeatureValueDetails"][] | null; + FeatureValuesList: components['schemas']['FeatureValueDetails'][] | null FeatureValueDetails: { - label: components["schemas"]["FeatureValueLabel"]; - name: components["schemas"]["Name"]; + label: components['schemas']['FeatureValueLabel'] + name: components['schemas']['Name'] /** * @description The cost that will be added to the monthly plan cost when this value * is selected or is default for the plan. * Cost is deprecated in favor of the `price.cost` field. */ - cost?: number; + cost?: number /** * @description Price describes the cost of a feature. It should be preferred over * the `cost` property. @@ -873,19 +873,19 @@ export interface components { * when this value is selected or is default for the plan. * Number features should use the cost range instead. */ - cost?: number; + cost?: number /** * @description When a feature is used to multiply the cost of the plan or of * another feature, multiply factor is used for calculation. * A feature cannot have both a cost and a multiply factor. */ - multiply_factor?: number; - formula?: components["schemas"]["PriceFormula"]; + multiply_factor?: number + formula?: components['schemas']['PriceFormula'] /** @description Description explains how a feature is calculated to the user. */ - description?: string; - }; - numeric_details?: components["schemas"]["FeatureNumericDetails"]; - }; + description?: string + } + numeric_details?: components['schemas']['FeatureNumericDetails'] + } /** * @description Optional container for additional details relating to numeric features. * This is required if the feature is measurable and numeric. @@ -899,15 +899,15 @@ export interface components { * means this numeric details has no scale, and will not be or customizable. * Some plans may not have a measureable or customizable feature. */ - increment?: number; + increment?: number /** @description Minimum value that can be set by a user if customizable */ - min?: number; + min?: number /** @description Maximum value that can be set by a user if customizable */ - max?: number | null; + max?: number | null /** @description Applied to the end of the number for display, for example the ‘GB’ in ‘20 GB’. */ - suffix?: string | null; - cost_ranges?: components["schemas"]["FeatureNumericRange"][] | null; - } | null; + suffix?: string | null + cost_ranges?: components['schemas']['FeatureNumericRange'][] | null + } | null FeatureNumericRange: { /** * @description Defines the end of the range ( inclusive ), from the previous, or 0; @@ -915,40 +915,40 @@ export interface components { * range to infinity, or the maximum integer the system can handle * ( whichever comes first ). */ - limit?: number; + limit?: number /** * @description An integer in 10,000,000ths of cents, will be multiplied by the * numeric value set in the feature to determine the cost. */ - cost_multiple?: number; - }; + cost_multiple?: number + } FeatureValue: { - feature: components["schemas"]["Label"]; - value: components["schemas"]["FeatureValueLabel"]; - }; + feature: components['schemas']['Label'] + value: components['schemas']['FeatureValueLabel'] + } ValueProp: { /** @description Heading of a value proposition. */ - header: string; + header: string /** @description Body of a value proposition. */ - body: string; - }; + body: string + } /** * Format: url * @description Image URL used for Product listings. * * Minimum 660px wide, 400px high. */ - ProductImageURL: string; + ProductImageURL: string /** @description List of tags for product categorization and search */ - ProductTags: components["schemas"]["Label"][]; + ProductTags: components['schemas']['Label'][] /** @enum {string} */ - ProductState: "available" | "hidden" | "grandfathered" | "new" | "upcoming"; + ProductState: 'available' | 'hidden' | 'grandfathered' | 'new' | 'upcoming' ProductListing: { /** * @description When true, everyone can see the product when requested. When false it will * not be visible to anyone except those on the provider team. */ - public?: boolean; + public?: boolean /** * @description When true, the product will be displayed in product listings alongside * other products. When false the product will be excluded from listings, @@ -956,7 +956,7 @@ export interface components { * Any pages that display information about the product when not listed, * should indicate to webcrawlers that the content should not be indexed. */ - listed?: boolean; + listed?: boolean /** * @description Object to hold various flags for marketing purposes only. These are values * that need to be stored, but should not affect decision making in code. If @@ -969,21 +969,21 @@ export interface components { * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. */ - beta?: boolean; + beta?: boolean /** * @description Indicates whether or not the product is in `New` and should be * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. */ - new?: boolean; + new?: boolean /** * @description Indicates whether or not the product is in `New` and should be * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. */ - featured?: boolean; - }; - }; + featured?: boolean + } + } /** * @description Provider Only, implies that the product should only be provisionable by the * provider; so members of the provider team, no one else should be allowed. @@ -993,23 +993,23 @@ export interface components { * * @enum {string} */ - ProductProvisioning: "provider-only" | "pre-order" | "public"; + ProductProvisioning: 'provider-only' | 'pre-order' | 'public' ProductIntegrationFeatures: { /** * @description Indicates whether or not this product supports resource transitions to * manifold by access_code. */ - access_code?: boolean; + access_code?: boolean /** * @description Represents whether or not this product supports Single * Sign On */ - sso?: boolean; + sso?: boolean /** * @description Represents whether or not this product supports changing * the plan of a resource. */ - plan_change?: boolean; + plan_change?: boolean /** * @description Describes how the region for a resource is specified, if * unspecified, then regions have no impact on this @@ -1017,7 +1017,7 @@ export interface components { * * @enum {string} */ - region?: "user-specified" | "unspecified"; + region?: 'user-specified' | 'unspecified' /** * @description Describes the credential type that is supported by this product. * @@ -1029,127 +1029,127 @@ export interface components { * @default multiple * @enum {string} */ - credential?: "none" | "single" | "multiple" | "unknown"; - }; + credential?: 'none' | 'single' | 'multiple' | 'unknown' + } ProductBody: { - provider_id: components["schemas"]["ID"]; - label: components["schemas"]["Label"]; - name: components["schemas"]["Name"]; - state: components["schemas"]["ProductState"]; - listing: components["schemas"]["ProductListing"]; - logo_url: components["schemas"]["LogoURL"]; + provider_id: components['schemas']['ID'] + label: components['schemas']['Label'] + name: components['schemas']['Name'] + state: components['schemas']['ProductState'] + listing: components['schemas']['ProductListing'] + logo_url: components['schemas']['LogoURL'] /** @description 140 character sentence positioning the product. */ - tagline: string; + tagline: string /** @description A list of value propositions of the product. */ - value_props: components["schemas"]["ValueProp"][]; + value_props: components['schemas']['ValueProp'][] /** @description A list of getting started steps for the product */ - setup_steps?: string[] | null; - images: components["schemas"]["ProductImageURL"][]; + setup_steps?: string[] | null + images: components['schemas']['ProductImageURL'][] /** Format: email */ - support_email: string; + support_email: string /** Format: url */ - documentation_url: string; + documentation_url: string /** * @description URL to this Product's Terms of Service. If provided is true, then * a url must be set. Otherwise, provided is false. */ terms: { /** Format: url */ - url?: string | null; - provided: boolean; - }; - feature_types: components["schemas"]["FeatureType"][]; + url?: string | null + provided: boolean + } + feature_types: components['schemas']['FeatureType'][] billing: { /** @enum {string} */ - type: "monthly-prorated" | "monthly-anniversary" | "annual-anniversary"; + type: 'monthly-prorated' | 'monthly-anniversary' | 'annual-anniversary' /** @enum {string} */ - currency: "usd"; - }; + currency: 'usd' + } integration: { - provisioning: components["schemas"]["ProductProvisioning"]; + provisioning: components['schemas']['ProductProvisioning'] /** Format: url */ - base_url: string; + base_url: string /** Format: url */ - sso_url?: string | null; + sso_url?: string | null /** @enum {string} */ - version: "v1"; - features: components["schemas"]["ProductIntegrationFeatures"]; - }; - tags?: components["schemas"]["ProductTags"]; - }; + version: 'v1' + features: components['schemas']['ProductIntegrationFeatures'] + } + tags?: components['schemas']['ProductTags'] + } Product: { - id: components["schemas"]["ID"]; - version: number; + id: components['schemas']['ID'] + version: number /** @enum {string} */ - type: "product"; - body: components["schemas"]["ProductBody"]; - }; + type: 'product' + body: components['schemas']['ProductBody'] + } CreateProduct: { - body: components["schemas"]["ProductBody"]; - }; + body: components['schemas']['ProductBody'] + } /** @description Array of Plan IDs that this Plan can be resized to, if null all will be assumed */ - PlanResizeList: components["schemas"]["ID"][] | null; + PlanResizeList: components['schemas']['ID'][] | null PlanBody: { - provider_id: components["schemas"]["ID"]; - product_id: components["schemas"]["ID"]; - name: components["schemas"]["Name"]; - label: components["schemas"]["Label"]; - state: components["schemas"]["PlanState"]; - resizable_to?: components["schemas"]["PlanResizeList"]; + provider_id: components['schemas']['ID'] + product_id: components['schemas']['ID'] + name: components['schemas']['Name'] + label: components['schemas']['Label'] + state: components['schemas']['PlanState'] + resizable_to?: components['schemas']['PlanResizeList'] /** @description Array of Region IDs */ - regions: components["schemas"]["ID"][]; + regions: components['schemas']['ID'][] /** @description Array of Feature Values */ - features: components["schemas"]["FeatureValue"][]; + features: components['schemas']['FeatureValue'][] /** * @description The number of days a user gets as a free trial when subscribing to * this plan. Trials are valid only once per product; changing plans * or adding an additional subscription will not start a new trial. */ - trial_days?: number; + trial_days?: number /** @description Dollar value in cents. */ - cost: number; - }; + cost: number + } /** @enum {string} */ - PlanState: "hidden" | "available" | "grandfathered" | "unlisted"; - ExpandedPlanBody: components["schemas"]["PlanBody"] & { + PlanState: 'hidden' | 'available' | 'grandfathered' | 'unlisted' + ExpandedPlanBody: components['schemas']['PlanBody'] & { /** @description An array of feature definitions for the plan, as defined on the Product. */ - expanded_features: components["schemas"]["ExpandedFeature"][]; + expanded_features: components['schemas']['ExpandedFeature'][] /** @description A boolean flag that indicates if a plan is free or not based on it's cost and features. */ - free: boolean; + free: boolean /** @description Plan cost using its default features plus base cost. */ - defaultCost?: number; + defaultCost?: number /** @description A boolean flag that indicates if a plan has customizable features. */ - customizable?: boolean; - }; - ExpandedFeature: components["schemas"]["FeatureType"] & { + customizable?: boolean + } + ExpandedFeature: components['schemas']['FeatureType'] & { /** @description The string value set for the feature on the plan, this should only be used if the value property is null. */ - value_string: string; - value: components["schemas"]["FeatureValueDetails"]; - }; + value_string: string + value: components['schemas']['FeatureValueDetails'] + } Plan: { - id: components["schemas"]["ID"]; - version: number; + id: components['schemas']['ID'] + version: number /** @enum {string} */ - type: "plan"; - body: components["schemas"]["PlanBody"]; - }; + type: 'plan' + body: components['schemas']['PlanBody'] + } ExpandedPlan: { - id: components["schemas"]["ID"]; - version: number; + id: components['schemas']['ID'] + version: number /** @enum {string} */ - type: "plan"; - body: components["schemas"]["ExpandedPlanBody"]; - }; + type: 'plan' + body: components['schemas']['ExpandedPlanBody'] + } CreatePlan: { - body: components["schemas"]["PlanBody"]; - }; + body: components['schemas']['PlanBody'] + } /** @description Unexpected error */ Error: { /** @description The error type */ - type: string; + type: string /** @description Explanation of the errors */ - message: string[]; - }; + message: string[] + } /** * @description Describes how a feature cost should be calculated. An empty * string defaults to the normal price calculation using the value cost. @@ -1173,21 +1173,21 @@ export interface components { * - `another-feature-label#number` is the numeric value of a number feature * In a feature formula, plan base cost and total cost cannot be used */ - PriceFormula: string; + PriceFormula: string ExpandedProduct: { - id: components["schemas"]["ID"]; - version: number; + id: components['schemas']['ID'] + version: number /** @enum {string} */ - type: "product"; - body: components["schemas"]["ProductBody"]; - plans?: components["schemas"]["ExpandedPlan"][]; - provider: components["schemas"]["Provider"]; - }; - }; + type: 'product' + body: components['schemas']['ProductBody'] + plans?: components['schemas']['ExpandedPlan'][] + provider: components['schemas']['Provider'] + } + } parameters: { /** @description Filter results to only include those that have this label. */ - LabelFilter: string; - }; + LabelFilter: string + } } export interface operations {} diff --git a/test/v3/expected/manifold.ts b/test/v3/expected/manifold.ts index 9280fd9c2..4a49d45e4 100644 --- a/test/v3/expected/manifold.ts +++ b/test/v3/expected/manifold.ts @@ -4,286 +4,286 @@ */ export interface paths { - "/regions/": { + '/regions/': { get: { parameters: { query: { /** Filter results to only include the regions that have this location. */ - location?: string; + location?: string /** * Filter results to only include the regions that are on this * platform. */ - platform?: string; - }; - }; + platform?: string + } + } responses: { /** A list of regions. */ 200: { content: { - "application/json": components["schemas"]["Region"][]; - }; - }; + 'application/json': components['schemas']['Region'][] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } + } post: { responses: { /** Complete region object */ 201: { content: { - "application/json": components["schemas"]["Region"]; - }; - }; + 'application/json': components['schemas']['Region'] + } + } /** Invalid request provided */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Region already exists for that platform and location */ 409: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } /** Region create request */ requestBody: { content: { - "application/json": components["schemas"]["CreateRegion"]; - }; - }; - }; - }; - "/regions/{id}": { + 'application/json': components['schemas']['CreateRegion'] + } + } + } + } + '/regions/{id}': { get: { parameters: { path: { /** ID of the region to lookup, stored as a base32 encoded 18 byte identifier. */ - id: string; - }; - }; + id: string + } + } responses: { /** A region. */ 200: { content: { - "application/json": components["schemas"]["Region"]; - }; - }; + 'application/json': components['schemas']['Region'] + } + } /** Provided Region ID is Invalid */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Region could not be found */ 404: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } + } patch: { parameters: { path: { /** ID of the region to lookup, stored as a base32 encoded 18 byte identifier. */ - id: string; - }; - }; + id: string + } + } responses: { /** Complete region object */ 200: { content: { - "application/json": components["schemas"]["Region"]; - }; - }; + 'application/json': components['schemas']['Region'] + } + } /** Invalid request provided */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } /** Region update request */ requestBody: { content: { - "application/json": components["schemas"]["UpdateRegion"]; - }; - }; - }; - }; - "/providers/": { + 'application/json': components['schemas']['UpdateRegion'] + } + } + } + } + '/providers/': { get: { parameters: { query: { /** Filter results to only include those that have this label. */ - label?: string; - }; - }; + label?: string + } + } responses: { /** A list of providers. */ 200: { content: { - "application/json": components["schemas"]["Provider"][]; - }; - }; + 'application/json': components['schemas']['Provider'][] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } + } post: { responses: { /** Complete provider object */ 201: { content: { - "application/json": components["schemas"]["Provider"]; - }; - }; + 'application/json': components['schemas']['Provider'] + } + } /** Invalid request provided */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Forbidden */ 403: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Provider already exists with that label */ 409: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } /** Provider create request */ requestBody: { content: { - "application/json": components["schemas"]["CreateProvider"]; - }; - }; - }; - }; - "/providers/{id}": { + 'application/json': components['schemas']['CreateProvider'] + } + } + } + } + '/providers/{id}': { get: { parameters: { path: { /** ID of the provider to lookup, stored as a base32 encoded 18 byte identifier. */ - id: string; - }; - }; + id: string + } + } responses: { /** A provider. */ 200: { content: { - "application/json": components["schemas"]["Provider"]; - }; - }; + 'application/json': components['schemas']['Provider'] + } + } /** Unknown provider error */ 404: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } + } patch: { parameters: { path: { /** ID of the provider to update, stored as a base32 encoded 18 byte identifier. */ - id: string; - }; - }; + id: string + } + } responses: { /** Complete provider object */ 200: { content: { - "application/json": components["schemas"]["Provider"]; - }; - }; + 'application/json': components['schemas']['Provider'] + } + } /** Invalid request provided */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Forbidden */ 403: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Provider not found */ 404: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Provider already exists with that label */ 409: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } /** Provider update request */ requestBody: { content: { - "application/json": components["schemas"]["UpdateProvider"]; - }; - }; - }; - }; - "/products/": { + 'application/json': components['schemas']['UpdateProvider'] + } + } + } + } + '/products/': { get: { parameters: { query: { @@ -291,76 +291,76 @@ export interface paths { * Base32 encoded 18 byte identifier of the provider that these * products must belong to. */ - provider_id?: string; + provider_id?: string /** Filter results to only include those that have this label. */ - label?: string; + label?: string /** Return only products matching at least one of the tags. */ - tags?: string[]; - }; - }; + tags?: string[] + } + } responses: { /** A product. */ 200: { content: { - "application/json": components["schemas"]["Product"][]; - }; - }; + 'application/json': components['schemas']['Product'][] + } + } /** Invalid provider_id supplied */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } + } post: { responses: { /** Complete product object */ 201: { content: { - "application/json": components["schemas"]["Product"]; - }; - }; + 'application/json': components['schemas']['Product'] + } + } /** Invalid request provided */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Forbidden */ 403: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Product already exists with that label */ 409: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } /** Product create request */ requestBody: { content: { - "application/json": components["schemas"]["CreateProduct"]; - }; - }; - }; - }; - "/internal/products": { + 'application/json': components['schemas']['CreateProduct'] + } + } + } + } + '/internal/products': { get: { parameters: { query: { @@ -368,38 +368,38 @@ export interface paths { * Base32 encoded 18 byte identifier of the provider that these * products must belong to. */ - provider_id?: string; + provider_id?: string /** Filter results to only include those that have this label. */ - label?: string; + label?: string /** Return only products matching at least one of the tags. */ - tags?: string[]; + tags?: string[] /** Return product listings without plan information */ - include_plans?: boolean; - }; - }; + include_plans?: boolean + } + } responses: { /** A product. */ 200: { content: { - "application/json": components["schemas"]["ExpandedProduct"][]; - }; - }; + 'application/json': components['schemas']['ExpandedProduct'][] + } + } /** Invalid provider_id supplied */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; - }; - "/products/{id}": { + 'application/json': components['schemas']['Error'] + } + } + } + } + } + '/products/{id}': { get: { parameters: { path: { @@ -407,36 +407,36 @@ export interface paths { * ID of the product to lookup, stored as a base32 encoded 18 byte * identifier. */ - id: string; - }; - }; + id: string + } + } responses: { /** A product. */ 200: { content: { - "application/json": components["schemas"]["Product"]; - }; - }; + 'application/json': components['schemas']['Product'] + } + } /** Invalid Product ID */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Product not found error */ 404: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } + } patch: { parameters: { path: { @@ -444,44 +444,44 @@ export interface paths { * ID of the product to lookup, stored as a base32 encoded 18 byte * identifier. */ - id: string; - }; - }; + id: string + } + } responses: { /** Complete product object */ 200: { content: { - "application/json": components["schemas"]["Product"]; - }; - }; + 'application/json': components['schemas']['Product'] + } + } /** Invalid Product ID */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Product not found error */ 404: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } /** Product update request */ requestBody: { content: { - "application/json": components["schemas"]["UpdateProduct"]; - }; - }; - }; - }; - "/plans/{id}": { + 'application/json': components['schemas']['UpdateProduct'] + } + } + } + } + '/plans/{id}': { get: { parameters: { path: { @@ -489,36 +489,36 @@ export interface paths { * ID of the plan to lookup, stored as a base32 encoded 18 byte * identifier. */ - id: string; - }; - }; + id: string + } + } responses: { /** A plan. */ 200: { content: { - "application/json": components["schemas"]["ExpandedPlan"]; - }; - }; + 'application/json': components['schemas']['ExpandedPlan'] + } + } /** Invalid Plan ID Provided */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unknown plan error */ 404: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected error */ default: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } + } patch: { parameters: { path: { @@ -526,121 +526,121 @@ export interface paths { * ID of the plan to lookup, stored as a base32 encoded 18 byte * identifier. */ - id: string; - }; - }; + id: string + } + } responses: { /** Complete product plan */ 200: { content: { - "application/json": components["schemas"]["Plan"]; - }; - }; + 'application/json': components['schemas']['Plan'] + } + } /** Invalid Plan ID */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Plan not found error */ 404: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } /** Plan update request */ requestBody: { content: { - "application/json": components["schemas"]["UpdatePlan"]; - }; - }; - }; - }; - "/plans/": { + 'application/json': components['schemas']['UpdatePlan'] + } + } + } + } + '/plans/': { get: { parameters: { query: { /** Return the plans that are associated with this product. */ - product_id: string[]; + product_id: string[] /** Filter results to only include those that have this label. */ - label?: string; - }; - }; + label?: string + } + } responses: { /** A list of plans for the given product. */ 200: { content: { - "application/json": components["schemas"]["ExpandedPlan"][]; - }; - }; + 'application/json': components['schemas']['ExpandedPlan'][] + } + } /** Invalid Parameters Provided */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Could not find product */ 404: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } + } post: { responses: { /** Complete plan object */ 201: { content: { - "application/json": components["schemas"]["Plan"]; - }; - }; + 'application/json': components['schemas']['Plan'] + } + } /** Invalid request provided */ 400: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Forbidden */ 403: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Plan already exists with that label */ 409: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; + 'application/json': components['schemas']['Error'] + } + } /** Unexpected Error */ 500: { content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; + 'application/json': components['schemas']['Error'] + } + } + } /** Plan create request */ requestBody: { content: { - "application/json": components["schemas"]["CreatePlan"]; - }; - }; - }; - }; + 'application/json': components['schemas']['CreatePlan'] + } + } + } + } } export interface components { @@ -649,202 +649,202 @@ export interface components { * Format: base32ID * @description A base32 encoded 18 byte identifier. */ - ID: string; + ID: string /** * Format: base32ID * @description A base32 encoded 18 byte identifier. */ - OptionalID: string | null; + OptionalID: string | null /** @description A flexible identifier for internal or external entities. */ - FlexID: string; + FlexID: string /** @description A flexible identifier for internal or external entities. */ - OptionalFlexID: string | null; + OptionalFlexID: string | null /** @description A machine readable unique label, which is url safe. */ - Label: string; + Label: string /** @description A machine readable unique label, which is url safe. */ - OptionalLabel: string | null; + OptionalLabel: string | null /** @description A machine readable unique label, which is url safe. */ - FeatureValueLabel: string; + FeatureValueLabel: string /** @description A location of where a potential resource can be provisioned. */ - Location: string; + Location: string /** @description A name of a platform which is used to provision resources. */ - Platform: string; + Platform: string /** @description A name of an entity which is displayed to a human. */ - Name: string; + Name: string /** @description A name of an entity which is displayed to a human. */ - OptionalName: string | null; + OptionalName: string | null /** * Format: url * @description Logo used for Provider and Product listings. * * Must be square (same width and height) and minimum 400px. Maximum of 800px. */ - LogoURL: string; + LogoURL: string /** * Format: url * @description Logo used for Provider and Product listings. * * Must be square (same width and height) and minimum 400px. Maximum of 800px. */ - OptionalLogoURL: string | null; + OptionalLogoURL: string | null RegionBody: { - platform: components["schemas"]["Platform"]; - location: components["schemas"]["Location"]; - name: string; - priority: number; - }; + platform: components['schemas']['Platform'] + location: components['schemas']['Location'] + name: string + priority: number + } Region: { - id: components["schemas"]["ID"]; + id: components['schemas']['ID'] /** @enum {string} */ - type: "region"; - version: number; - body: components["schemas"]["RegionBody"]; - }; + type: 'region' + version: number + body: components['schemas']['RegionBody'] + } CreateRegion: { - body: components["schemas"]["RegionBody"]; - }; + body: components['schemas']['RegionBody'] + } UpdateRegion: { - name: string; - }; + name: string + } ProviderBody: { - owner_id?: components["schemas"]["OptionalFlexID"]; - team_id?: components["schemas"]["OptionalID"]; - label: components["schemas"]["Label"]; - name: components["schemas"]["Name"]; - logo_url?: components["schemas"]["LogoURL"]; + owner_id?: components['schemas']['OptionalFlexID'] + team_id?: components['schemas']['OptionalID'] + label: components['schemas']['Label'] + name: components['schemas']['Name'] + logo_url?: components['schemas']['LogoURL'] /** Format: email */ - support_email?: string; + support_email?: string /** Format: url */ - documentation_url?: string; - }; + documentation_url?: string + } UpdateProviderBody: { - owner_id?: components["schemas"]["OptionalFlexID"]; - team_id?: components["schemas"]["OptionalID"]; - label?: components["schemas"]["OptionalLabel"]; - name?: components["schemas"]["OptionalName"]; - logo_url?: components["schemas"]["OptionalLogoURL"]; + owner_id?: components['schemas']['OptionalFlexID'] + team_id?: components['schemas']['OptionalID'] + label?: components['schemas']['OptionalLabel'] + name?: components['schemas']['OptionalName'] + logo_url?: components['schemas']['OptionalLogoURL'] /** Format: email */ - support_email?: string | null; + support_email?: string | null /** Format: url */ - documentation_url?: string | null; - }; + documentation_url?: string | null + } Provider: { - id: components["schemas"]["ID"]; - version: number; + id: components['schemas']['ID'] + version: number /** @enum {string} */ - type: "provider"; - body: components["schemas"]["ProviderBody"]; - }; + type: 'provider' + body: components['schemas']['ProviderBody'] + } CreateProvider: { - body: components["schemas"]["ProviderBody"]; - }; + body: components['schemas']['ProviderBody'] + } UpdateProvider: { - id: components["schemas"]["ID"]; - body: components["schemas"]["UpdateProviderBody"]; - }; + id: components['schemas']['ID'] + body: components['schemas']['UpdateProviderBody'] + } UpdateProduct: { - id: components["schemas"]["ID"]; - body: components["schemas"]["UpdateProductBody"]; - }; + id: components['schemas']['ID'] + body: components['schemas']['UpdateProductBody'] + } UpdateProductBody: { - name?: components["schemas"]["Name"]; - label?: components["schemas"]["Label"]; - logo_url?: components["schemas"]["LogoURL"]; - listing?: components["schemas"]["ProductListing"]; + name?: components['schemas']['Name'] + label?: components['schemas']['Label'] + logo_url?: components['schemas']['LogoURL'] + listing?: components['schemas']['ProductListing'] /** @description 140 character sentence positioning the product. */ - tagline?: string | null; + tagline?: string | null /** @description A list of value propositions of the product. */ - value_props?: components["schemas"]["ValueProp"][] | null; + value_props?: components['schemas']['ValueProp'][] | null /** @description A list of getting started steps for the product */ - setup_steps?: string[] | null; - images?: components["schemas"]["ProductImageURL"][] | null; + setup_steps?: string[] | null + images?: components['schemas']['ProductImageURL'][] | null /** Format: email */ - support_email?: string | null; + support_email?: string | null /** Format: url */ - documentation_url?: string | null; + documentation_url?: string | null /** * @description URL to this Product's Terms of Service. If provided is true, then * a url must be set. Otherwise, provided is false. */ - terms_url?: string | null; - feature_types?: components["schemas"]["FeatureType"][] | null; + terms_url?: string | null + feature_types?: components['schemas']['FeatureType'][] | null integration?: { - provisioning?: components["schemas"]["ProductProvisioning"]; + provisioning?: components['schemas']['ProductProvisioning'] /** Format: url */ - base_url?: string | null; + base_url?: string | null /** Format: url */ - sso_url?: string | null; + sso_url?: string | null /** @enum {string|null} */ - version?: "v1" | null; + version?: 'v1' | null features?: { - access_code?: boolean | null; - sso?: boolean | null; - plan_change?: boolean | null; + access_code?: boolean | null + sso?: boolean | null + plan_change?: boolean | null /** * @default multiple * @enum {string|null} */ - credential?: ("none" | "single" | "multiple" | "unknown") | null; - }; - } | null; + credential?: ('none' | 'single' | 'multiple' | 'unknown') | null + } + } | null /** @description An array of platform ids to restrict this product for. */ - platform_ids?: components["schemas"]["ID"][] | null; - tags?: components["schemas"]["ProductTags"]; - }; + platform_ids?: components['schemas']['ID'][] | null + tags?: components['schemas']['ProductTags'] + } UpdatePlan: { - id: components["schemas"]["ID"]; - body: components["schemas"]["UpdatePlanBody"]; - }; + id: components['schemas']['ID'] + body: components['schemas']['UpdatePlanBody'] + } UpdatePlanBody: { - name?: components["schemas"]["Name"]; - label?: components["schemas"]["Label"]; - state?: components["schemas"]["PlanState"]; + name?: components['schemas']['Name'] + label?: components['schemas']['Label'] + state?: components['schemas']['PlanState'] /** @description Used in conjuction with resizable_to to set or unset the list */ - has_resize_constraints?: boolean | null; - resizable_to?: components["schemas"]["PlanResizeList"]; + has_resize_constraints?: boolean | null + resizable_to?: components['schemas']['PlanResizeList'] /** @description Array of Region IDs */ - regions?: components["schemas"]["ID"][] | null; + regions?: components['schemas']['ID'][] | null /** @description Array of Feature Values */ - features?: components["schemas"]["FeatureValue"][] | null; + features?: components['schemas']['FeatureValue'][] | null /** * @description The number of days a user gets as a free trial when subscribing to * this plan. Trials are valid only once per product; changing plans * or adding an additional subscription will not start a new trial. */ - trial_days?: number | null; + trial_days?: number | null /** @description Dollar value in cents */ - cost?: number | null; - }; + cost?: number | null + } /** * @description A feature type represents the different aspects of a product that are * offered, these features can manifest differently depending on the plan. */ FeatureType: { - label: components["schemas"]["Label"]; - name: components["schemas"]["Name"]; + label: components['schemas']['Label'] + name: components['schemas']['Name'] /** @enum {string} */ - type: "boolean" | "string" | "number"; + type: 'boolean' | 'string' | 'number' /** @description This sets whether or not the feature can be customized by a consumer. */ - customizable?: boolean; + customizable?: boolean /** * @description This sets whether or not the feature can be upgraded by the consumer after the * resource has provisioned. Upgrading means setting a higher value or selecting a * higher element in the list. */ - upgradable?: boolean; + upgradable?: boolean /** * @description This sets whether or not the feature can be downgraded by the consumer after the * resource has provisioned. Downgrading means setting a lower value or selecting a * lower element in the list. */ - downgradable?: boolean; + downgradable?: boolean /** * @description Sets if this feature’s value is trackable from the provider, * this only really affects numeric constraints. */ - measurable?: boolean; - values?: components["schemas"]["FeatureValuesList"]; - }; + measurable?: boolean + values?: components['schemas']['FeatureValuesList'] + } /** * @description A list of allowable values for the feature. * To define values for a boolean feature type, only `true` is required, @@ -853,16 +853,16 @@ export interface components { * `numeric_details` definition, and the plan will determine which * `numeric_details` set is used based on it's setting. */ - FeatureValuesList: components["schemas"]["FeatureValueDetails"][] | null; + FeatureValuesList: components['schemas']['FeatureValueDetails'][] | null FeatureValueDetails: { - label: components["schemas"]["FeatureValueLabel"]; - name: components["schemas"]["Name"]; + label: components['schemas']['FeatureValueLabel'] + name: components['schemas']['Name'] /** * @description The cost that will be added to the monthly plan cost when this value * is selected or is default for the plan. * Cost is deprecated in favor of the `price.cost` field. */ - cost?: number; + cost?: number /** * @description Price describes the cost of a feature. It should be preferred over * the `cost` property. @@ -873,19 +873,19 @@ export interface components { * when this value is selected or is default for the plan. * Number features should use the cost range instead. */ - cost?: number; + cost?: number /** * @description When a feature is used to multiply the cost of the plan or of * another feature, multiply factor is used for calculation. * A feature cannot have both a cost and a multiply factor. */ - multiply_factor?: number; - formula?: components["schemas"]["PriceFormula"]; + multiply_factor?: number + formula?: components['schemas']['PriceFormula'] /** @description Description explains how a feature is calculated to the user. */ - description?: string; - }; - numeric_details?: components["schemas"]["FeatureNumericDetails"]; - }; + description?: string + } + numeric_details?: components['schemas']['FeatureNumericDetails'] + } /** * @description Optional container for additional details relating to numeric features. * This is required if the feature is measurable and numeric. @@ -899,15 +899,15 @@ export interface components { * means this numeric details has no scale, and will not be or customizable. * Some plans may not have a measureable or customizable feature. */ - increment?: number; + increment?: number /** @description Minimum value that can be set by a user if customizable */ - min?: number; + min?: number /** @description Maximum value that can be set by a user if customizable */ - max?: number | null; + max?: number | null /** @description Applied to the end of the number for display, for example the ‘GB’ in ‘20 GB’. */ - suffix?: string | null; - cost_ranges?: components["schemas"]["FeatureNumericRange"][] | null; - } | null; + suffix?: string | null + cost_ranges?: components['schemas']['FeatureNumericRange'][] | null + } | null FeatureNumericRange: { /** * @description Defines the end of the range ( inclusive ), from the previous, or 0; @@ -915,40 +915,40 @@ export interface components { * range to infinity, or the maximum integer the system can handle * ( whichever comes first ). */ - limit?: number; + limit?: number /** * @description An integer in 10,000,000ths of cents, will be multiplied by the * numeric value set in the feature to determine the cost. */ - cost_multiple?: number; - }; + cost_multiple?: number + } FeatureValue: { - feature: components["schemas"]["Label"]; - value: components["schemas"]["FeatureValueLabel"]; - }; + feature: components['schemas']['Label'] + value: components['schemas']['FeatureValueLabel'] + } ValueProp: { /** @description Heading of a value proposition. */ - header: string; + header: string /** @description Body of a value proposition. */ - body: string; - }; + body: string + } /** * Format: url * @description Image URL used for Product listings. * * Minimum 660px wide, 400px high. */ - ProductImageURL: string; + ProductImageURL: string /** @description List of tags for product categorization and search */ - ProductTags: components["schemas"]["Label"][]; + ProductTags: components['schemas']['Label'][] /** @enum {string} */ - ProductState: "available" | "hidden" | "grandfathered" | "new" | "upcoming"; + ProductState: 'available' | 'hidden' | 'grandfathered' | 'new' | 'upcoming' ProductListing: { /** * @description When true, everyone can see the product when requested. When false it will * not be visible to anyone except those on the provider team. */ - public?: boolean; + public?: boolean /** * @description When true, the product will be displayed in product listings alongside * other products. When false the product will be excluded from listings, @@ -956,7 +956,7 @@ export interface components { * Any pages that display information about the product when not listed, * should indicate to webcrawlers that the content should not be indexed. */ - listed?: boolean; + listed?: boolean /** * @description Object to hold various flags for marketing purposes only. These are values * that need to be stored, but should not affect decision making in code. If @@ -969,21 +969,21 @@ export interface components { * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. */ - beta?: boolean; + beta?: boolean /** * @description Indicates whether or not the product is in `New` and should be * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. */ - new?: boolean; + new?: boolean /** * @description Indicates whether or not the product is in `New` and should be * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. */ - featured?: boolean; - }; - }; + featured?: boolean + } + } /** * @description Provider Only, implies that the product should only be provisionable by the * provider; so members of the provider team, no one else should be allowed. @@ -993,23 +993,23 @@ export interface components { * * @enum {string} */ - ProductProvisioning: "provider-only" | "pre-order" | "public"; + ProductProvisioning: 'provider-only' | 'pre-order' | 'public' ProductIntegrationFeatures: { /** * @description Indicates whether or not this product supports resource transitions to * manifold by access_code. */ - access_code?: boolean; + access_code?: boolean /** * @description Represents whether or not this product supports Single * Sign On */ - sso?: boolean; + sso?: boolean /** * @description Represents whether or not this product supports changing * the plan of a resource. */ - plan_change?: boolean; + plan_change?: boolean /** * @description Describes how the region for a resource is specified, if * unspecified, then regions have no impact on this @@ -1017,7 +1017,7 @@ export interface components { * * @enum {string} */ - region?: "user-specified" | "unspecified"; + region?: 'user-specified' | 'unspecified' /** * @description Describes the credential type that is supported by this product. * @@ -1029,127 +1029,127 @@ export interface components { * @default multiple * @enum {string} */ - credential?: "none" | "single" | "multiple" | "unknown"; - }; + credential?: 'none' | 'single' | 'multiple' | 'unknown' + } ProductBody: { - provider_id: components["schemas"]["ID"]; - label: components["schemas"]["Label"]; - name: components["schemas"]["Name"]; - state: components["schemas"]["ProductState"]; - listing: components["schemas"]["ProductListing"]; - logo_url: components["schemas"]["LogoURL"]; + provider_id: components['schemas']['ID'] + label: components['schemas']['Label'] + name: components['schemas']['Name'] + state: components['schemas']['ProductState'] + listing: components['schemas']['ProductListing'] + logo_url: components['schemas']['LogoURL'] /** @description 140 character sentence positioning the product. */ - tagline: string; + tagline: string /** @description A list of value propositions of the product. */ - value_props: components["schemas"]["ValueProp"][]; + value_props: components['schemas']['ValueProp'][] /** @description A list of getting started steps for the product */ - setup_steps?: string[] | null; - images: components["schemas"]["ProductImageURL"][]; + setup_steps?: string[] | null + images: components['schemas']['ProductImageURL'][] /** Format: email */ - support_email: string; + support_email: string /** Format: url */ - documentation_url: string; + documentation_url: string /** * @description URL to this Product's Terms of Service. If provided is true, then * a url must be set. Otherwise, provided is false. */ terms: { /** Format: url */ - url?: string | null; - provided: boolean; - }; - feature_types: components["schemas"]["FeatureType"][]; + url?: string | null + provided: boolean + } + feature_types: components['schemas']['FeatureType'][] billing: { /** @enum {string} */ - type: "monthly-prorated" | "monthly-anniversary" | "annual-anniversary"; + type: 'monthly-prorated' | 'monthly-anniversary' | 'annual-anniversary' /** @enum {string} */ - currency: "usd"; - }; + currency: 'usd' + } integration: { - provisioning: components["schemas"]["ProductProvisioning"]; + provisioning: components['schemas']['ProductProvisioning'] /** Format: url */ - base_url: string; + base_url: string /** Format: url */ - sso_url?: string | null; + sso_url?: string | null /** @enum {string} */ - version: "v1"; - features: components["schemas"]["ProductIntegrationFeatures"]; - }; - tags?: components["schemas"]["ProductTags"]; - }; + version: 'v1' + features: components['schemas']['ProductIntegrationFeatures'] + } + tags?: components['schemas']['ProductTags'] + } Product: { - id: components["schemas"]["ID"]; - version: number; + id: components['schemas']['ID'] + version: number /** @enum {string} */ - type: "product"; - body: components["schemas"]["ProductBody"]; - }; + type: 'product' + body: components['schemas']['ProductBody'] + } CreateProduct: { - body: components["schemas"]["ProductBody"]; - }; + body: components['schemas']['ProductBody'] + } /** @description Array of Plan IDs that this Plan can be resized to, if null all will be assumed */ - PlanResizeList: components["schemas"]["ID"][] | null; + PlanResizeList: components['schemas']['ID'][] | null PlanBody: { - provider_id: components["schemas"]["ID"]; - product_id: components["schemas"]["ID"]; - name: components["schemas"]["Name"]; - label: components["schemas"]["Label"]; - state: components["schemas"]["PlanState"]; - resizable_to?: components["schemas"]["PlanResizeList"]; + provider_id: components['schemas']['ID'] + product_id: components['schemas']['ID'] + name: components['schemas']['Name'] + label: components['schemas']['Label'] + state: components['schemas']['PlanState'] + resizable_to?: components['schemas']['PlanResizeList'] /** @description Array of Region IDs */ - regions: components["schemas"]["ID"][]; + regions: components['schemas']['ID'][] /** @description Array of Feature Values */ - features: components["schemas"]["FeatureValue"][]; + features: components['schemas']['FeatureValue'][] /** * @description The number of days a user gets as a free trial when subscribing to * this plan. Trials are valid only once per product; changing plans * or adding an additional subscription will not start a new trial. */ - trial_days?: number; + trial_days?: number /** @description Dollar value in cents. */ - cost: number; - }; + cost: number + } /** @enum {string} */ - PlanState: "hidden" | "available" | "grandfathered" | "unlisted"; - ExpandedPlanBody: components["schemas"]["PlanBody"] & { + PlanState: 'hidden' | 'available' | 'grandfathered' | 'unlisted' + ExpandedPlanBody: components['schemas']['PlanBody'] & { /** @description An array of feature definitions for the plan, as defined on the Product. */ - expanded_features: components["schemas"]["ExpandedFeature"][]; + expanded_features: components['schemas']['ExpandedFeature'][] /** @description A boolean flag that indicates if a plan is free or not based on it's cost and features. */ - free: boolean; + free: boolean /** @description Plan cost using its default features plus base cost. */ - defaultCost?: number; + defaultCost?: number /** @description A boolean flag that indicates if a plan has customizable features. */ - customizable?: boolean; - }; - ExpandedFeature: components["schemas"]["FeatureType"] & { + customizable?: boolean + } + ExpandedFeature: components['schemas']['FeatureType'] & { /** @description The string value set for the feature on the plan, this should only be used if the value property is null. */ - value_string: string; - value: components["schemas"]["FeatureValueDetails"]; - }; + value_string: string + value: components['schemas']['FeatureValueDetails'] + } Plan: { - id: components["schemas"]["ID"]; - version: number; + id: components['schemas']['ID'] + version: number /** @enum {string} */ - type: "plan"; - body: components["schemas"]["PlanBody"]; - }; + type: 'plan' + body: components['schemas']['PlanBody'] + } ExpandedPlan: { - id: components["schemas"]["ID"]; - version: number; + id: components['schemas']['ID'] + version: number /** @enum {string} */ - type: "plan"; - body: components["schemas"]["ExpandedPlanBody"]; - }; + type: 'plan' + body: components['schemas']['ExpandedPlanBody'] + } CreatePlan: { - body: components["schemas"]["PlanBody"]; - }; + body: components['schemas']['PlanBody'] + } /** @description Unexpected error */ Error: { /** @description The error type */ - type: string; + type: string /** @description Explanation of the errors */ - message: string[]; - }; + message: string[] + } /** * @description Describes how a feature cost should be calculated. An empty * string defaults to the normal price calculation using the value cost. @@ -1173,21 +1173,21 @@ export interface components { * - `another-feature-label#number` is the numeric value of a number feature * In a feature formula, plan base cost and total cost cannot be used */ - PriceFormula: string; + PriceFormula: string ExpandedProduct: { - id: components["schemas"]["ID"]; - version: number; + id: components['schemas']['ID'] + version: number /** @enum {string} */ - type: "product"; - body: components["schemas"]["ProductBody"]; - plans?: components["schemas"]["ExpandedPlan"][]; - provider: components["schemas"]["Provider"]; - }; - }; + type: 'product' + body: components['schemas']['ProductBody'] + plans?: components['schemas']['ExpandedPlan'][] + provider: components['schemas']['Provider'] + } + } parameters: { /** @description Filter results to only include those that have this label. */ - LabelFilter: string; - }; + LabelFilter: string + } } export interface operations {} diff --git a/test/v3/expected/null-in-enum.additional.ts b/test/v3/expected/null-in-enum.additional.ts index 7a0c7d555..b64067748 100644 --- a/test/v3/expected/null-in-enum.additional.ts +++ b/test/v3/expected/null-in-enum.additional.ts @@ -4,14 +4,14 @@ */ export interface paths { - "/test": { + '/test': { get: { responses: { /** A list of types. */ - 200: unknown; - }; - }; - }; + 200: unknown + } + } + } } export interface components { @@ -19,24 +19,24 @@ export interface components { /** @description Enum with null and nullable */ MyType: { /** @enum {string|null} */ - myField?: ("foo" | "bar" | null) | null; - } & { [key: string]: unknown }; + myField?: ('foo' | 'bar' | null) | null + } & { [key: string]: unknown } /** @description Enum with null */ MyTypeNotNullable: { /** @enum {string} */ - myField?: "foo" | "bar" | null; - } & { [key: string]: unknown }; + myField?: 'foo' | 'bar' | null + } & { [key: string]: unknown } /** @description Enum with null */ MyTypeNotNullableNotNull: { /** @enum {string} */ - myField?: "foo" | "bar"; - } & { [key: string]: unknown }; + myField?: 'foo' | 'bar' + } & { [key: string]: unknown } /** @description Enum with null */ MyTypeMixed: { /** @enum {string} */ - myField?: "foo" | 2 | false | null; - } & { [key: string]: unknown }; - }; + myField?: 'foo' | 2 | false | null + } & { [key: string]: unknown } + } } export interface operations {} diff --git a/test/v3/expected/null-in-enum.exported-type.ts b/test/v3/expected/null-in-enum.exported-type.ts index f4201b58a..2ff5c24e5 100644 --- a/test/v3/expected/null-in-enum.exported-type.ts +++ b/test/v3/expected/null-in-enum.exported-type.ts @@ -4,41 +4,41 @@ */ export type paths = { - "/test": { + '/test': { get: { responses: { /** A list of types. */ - 200: unknown; - }; - }; - }; -}; + 200: unknown + } + } + } +} export type components = { schemas: { /** @description Enum with null and nullable */ MyType: { /** @enum {string|null} */ - myField?: ("foo" | "bar" | null) | null; - }; + myField?: ('foo' | 'bar' | null) | null + } /** @description Enum with null */ MyTypeNotNullable: { /** @enum {string} */ - myField?: "foo" | "bar" | null; - }; + myField?: 'foo' | 'bar' | null + } /** @description Enum with null */ MyTypeNotNullableNotNull: { /** @enum {string} */ - myField?: "foo" | "bar"; - }; + myField?: 'foo' | 'bar' + } /** @description Enum with null */ MyTypeMixed: { /** @enum {string} */ - myField?: "foo" | 2 | false | null; - }; - }; -}; + myField?: 'foo' | 2 | false | null + } + } +} -export type operations = {}; +export type operations = {} -export type external = {}; +export type external = {} diff --git a/test/v3/expected/null-in-enum.immutable.ts b/test/v3/expected/null-in-enum.immutable.ts index 4046246f5..4c89af095 100644 --- a/test/v3/expected/null-in-enum.immutable.ts +++ b/test/v3/expected/null-in-enum.immutable.ts @@ -4,14 +4,14 @@ */ export interface paths { - readonly "/test": { + readonly '/test': { readonly get: { readonly responses: { /** A list of types. */ - readonly 200: unknown; - }; - }; - }; + readonly 200: unknown + } + } + } } export interface components { @@ -19,24 +19,24 @@ export interface components { /** @description Enum with null and nullable */ readonly MyType: { /** @enum {string|null} */ - readonly myField?: ("foo" | "bar" | null) | null; - }; + readonly myField?: ('foo' | 'bar' | null) | null + } /** @description Enum with null */ readonly MyTypeNotNullable: { /** @enum {string} */ - readonly myField?: "foo" | "bar" | null; - }; + readonly myField?: 'foo' | 'bar' | null + } /** @description Enum with null */ readonly MyTypeNotNullableNotNull: { /** @enum {string} */ - readonly myField?: "foo" | "bar"; - }; + readonly myField?: 'foo' | 'bar' + } /** @description Enum with null */ readonly MyTypeMixed: { /** @enum {string} */ - readonly myField?: "foo" | 2 | false | null; - }; - }; + readonly myField?: 'foo' | 2 | false | null + } + } } export interface operations {} diff --git a/test/v3/expected/null-in-enum.support-array-length.ts b/test/v3/expected/null-in-enum.support-array-length.ts index 61f8c54f5..8be75085e 100644 --- a/test/v3/expected/null-in-enum.support-array-length.ts +++ b/test/v3/expected/null-in-enum.support-array-length.ts @@ -4,14 +4,14 @@ */ export interface paths { - "/test": { + '/test': { get: { responses: { /** A list of types. */ - 200: unknown; - }; - }; - }; + 200: unknown + } + } + } } export interface components { @@ -19,24 +19,24 @@ export interface components { /** @description Enum with null and nullable */ MyType: { /** @enum {string|null} */ - myField?: ("foo" | "bar" | null) | null; - }; + myField?: ('foo' | 'bar' | null) | null + } /** @description Enum with null */ MyTypeNotNullable: { /** @enum {string} */ - myField?: "foo" | "bar" | null; - }; + myField?: 'foo' | 'bar' | null + } /** @description Enum with null */ MyTypeNotNullableNotNull: { /** @enum {string} */ - myField?: "foo" | "bar"; - }; + myField?: 'foo' | 'bar' + } /** @description Enum with null */ MyTypeMixed: { /** @enum {string} */ - myField?: "foo" | 2 | false | null; - }; - }; + myField?: 'foo' | 2 | false | null + } + } } export interface operations {} diff --git a/test/v3/expected/null-in-enum.ts b/test/v3/expected/null-in-enum.ts index 61f8c54f5..8be75085e 100644 --- a/test/v3/expected/null-in-enum.ts +++ b/test/v3/expected/null-in-enum.ts @@ -4,14 +4,14 @@ */ export interface paths { - "/test": { + '/test': { get: { responses: { /** A list of types. */ - 200: unknown; - }; - }; - }; + 200: unknown + } + } + } } export interface components { @@ -19,24 +19,24 @@ export interface components { /** @description Enum with null and nullable */ MyType: { /** @enum {string|null} */ - myField?: ("foo" | "bar" | null) | null; - }; + myField?: ('foo' | 'bar' | null) | null + } /** @description Enum with null */ MyTypeNotNullable: { /** @enum {string} */ - myField?: "foo" | "bar" | null; - }; + myField?: 'foo' | 'bar' | null + } /** @description Enum with null */ MyTypeNotNullableNotNull: { /** @enum {string} */ - myField?: "foo" | "bar"; - }; + myField?: 'foo' | 'bar' + } /** @description Enum with null */ MyTypeMixed: { /** @enum {string} */ - myField?: "foo" | 2 | false | null; - }; - }; + myField?: 'foo' | 2 | false | null + } + } } export interface operations {} diff --git a/test/v3/expected/one-of-empty.additional.ts b/test/v3/expected/one-of-empty.additional.ts index 079a85a4a..85b2c6a18 100644 --- a/test/v3/expected/one-of-empty.additional.ts +++ b/test/v3/expected/one-of-empty.additional.ts @@ -4,25 +4,25 @@ */ export interface paths { - "/test": { + '/test': { get: { responses: { /** A list of types. */ - 200: unknown; - }; - }; - }; + 200: unknown + } + } + } } export interface components { schemas: { /** @description Enum with null and nullable */ Example: { - emptyAllOf?: { [key: string]: unknown }; - emptyOneOf?: undefined & { [key: string]: unknown }; - emptyAnyOf?: { [key: string]: unknown }; - } & { [key: string]: unknown }; - }; + emptyAllOf?: { [key: string]: unknown } + emptyOneOf?: undefined & { [key: string]: unknown } + emptyAnyOf?: { [key: string]: unknown } + } & { [key: string]: unknown } + } } export interface operations {} diff --git a/test/v3/expected/one-of-empty.exported-type.ts b/test/v3/expected/one-of-empty.exported-type.ts index f67d0efed..f1d681bbb 100644 --- a/test/v3/expected/one-of-empty.exported-type.ts +++ b/test/v3/expected/one-of-empty.exported-type.ts @@ -4,27 +4,27 @@ */ export type paths = { - "/test": { + '/test': { get: { responses: { /** A list of types. */ - 200: unknown; - }; - }; - }; -}; + 200: unknown + } + } + } +} export type components = { schemas: { /** @description Enum with null and nullable */ Example: { - emptyAllOf?: undefined; - emptyOneOf?: undefined; - emptyAnyOf?: undefined; - }; - }; -}; + emptyAllOf?: undefined + emptyOneOf?: undefined + emptyAnyOf?: undefined + } + } +} -export type operations = {}; +export type operations = {} -export type external = {}; +export type external = {} diff --git a/test/v3/expected/one-of-empty.immutable.ts b/test/v3/expected/one-of-empty.immutable.ts index c88ded8ea..ebeab4c22 100644 --- a/test/v3/expected/one-of-empty.immutable.ts +++ b/test/v3/expected/one-of-empty.immutable.ts @@ -4,25 +4,25 @@ */ export interface paths { - readonly "/test": { + readonly '/test': { readonly get: { readonly responses: { /** A list of types. */ - readonly 200: unknown; - }; - }; - }; + readonly 200: unknown + } + } + } } export interface components { readonly schemas: { /** @description Enum with null and nullable */ readonly Example: { - readonly emptyAllOf?: undefined; - readonly emptyOneOf?: undefined; - readonly emptyAnyOf?: undefined; - }; - }; + readonly emptyAllOf?: undefined + readonly emptyOneOf?: undefined + readonly emptyAnyOf?: undefined + } + } } export interface operations {} diff --git a/test/v3/expected/one-of-empty.support-array-length.ts b/test/v3/expected/one-of-empty.support-array-length.ts index 7d391f33d..04761c861 100644 --- a/test/v3/expected/one-of-empty.support-array-length.ts +++ b/test/v3/expected/one-of-empty.support-array-length.ts @@ -4,25 +4,25 @@ */ export interface paths { - "/test": { + '/test': { get: { responses: { /** A list of types. */ - 200: unknown; - }; - }; - }; + 200: unknown + } + } + } } export interface components { schemas: { /** @description Enum with null and nullable */ Example: { - emptyAllOf?: undefined; - emptyOneOf?: undefined; - emptyAnyOf?: undefined; - }; - }; + emptyAllOf?: undefined + emptyOneOf?: undefined + emptyAnyOf?: undefined + } + } } export interface operations {} diff --git a/test/v3/expected/one-of-empty.ts b/test/v3/expected/one-of-empty.ts index 7d391f33d..04761c861 100644 --- a/test/v3/expected/one-of-empty.ts +++ b/test/v3/expected/one-of-empty.ts @@ -4,25 +4,25 @@ */ export interface paths { - "/test": { + '/test': { get: { responses: { /** A list of types. */ - 200: unknown; - }; - }; - }; + 200: unknown + } + } + } } export interface components { schemas: { /** @description Enum with null and nullable */ Example: { - emptyAllOf?: undefined; - emptyOneOf?: undefined; - emptyAnyOf?: undefined; - }; - }; + emptyAllOf?: undefined + emptyOneOf?: undefined + emptyAnyOf?: undefined + } + } } export interface operations {} diff --git a/test/v3/expected/petstore-openapitools.additional.ts b/test/v3/expected/petstore-openapitools.additional.ts index 643c33773..a1ee76285 100644 --- a/test/v3/expected/petstore-openapitools.additional.ts +++ b/test/v3/expected/petstore-openapitools.additional.ts @@ -4,63 +4,63 @@ */ export interface paths { - "/pet": { - put: operations["updatePet"]; - post: operations["addPet"]; - }; - "/pet/findByStatus": { + '/pet': { + put: operations['updatePet'] + post: operations['addPet'] + } + '/pet/findByStatus': { /** Multiple status values can be provided with comma separated strings */ - get: operations["findPetsByStatus"]; - }; - "/pet/findByTags": { + get: operations['findPetsByStatus'] + } + '/pet/findByTags': { /** Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. */ - get: operations["findPetsByTags"]; - }; - "/pet/{petId}": { + get: operations['findPetsByTags'] + } + '/pet/{petId}': { /** Returns a single pet */ - get: operations["getPetById"]; - post: operations["updatePetWithForm"]; - delete: operations["deletePet"]; - }; - "/pet/{petId}/uploadImage": { - post: operations["uploadFile"]; - }; - "/store/inventory": { + get: operations['getPetById'] + post: operations['updatePetWithForm'] + delete: operations['deletePet'] + } + '/pet/{petId}/uploadImage': { + post: operations['uploadFile'] + } + '/store/inventory': { /** Returns a map of status codes to quantities */ - get: operations["getInventory"]; - }; - "/store/order": { - post: operations["placeOrder"]; - }; - "/store/order/{orderId}": { + get: operations['getInventory'] + } + '/store/order': { + post: operations['placeOrder'] + } + '/store/order/{orderId}': { /** For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions */ - get: operations["getOrderById"]; + get: operations['getOrderById'] /** For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors */ - delete: operations["deleteOrder"]; - }; - "/user": { + delete: operations['deleteOrder'] + } + '/user': { /** This can only be done by the logged in user. */ - post: operations["createUser"]; - }; - "/user/createWithArray": { - post: operations["createUsersWithArrayInput"]; - }; - "/user/createWithList": { - post: operations["createUsersWithListInput"]; - }; - "/user/login": { - get: operations["loginUser"]; - }; - "/user/logout": { - get: operations["logoutUser"]; - }; - "/user/{username}": { - get: operations["getUserByName"]; + post: operations['createUser'] + } + '/user/createWithArray': { + post: operations['createUsersWithArrayInput'] + } + '/user/createWithList': { + post: operations['createUsersWithListInput'] + } + '/user/login': { + get: operations['loginUser'] + } + '/user/logout': { + get: operations['logoutUser'] + } + '/user/{username}': { + get: operations['getUserByName'] /** This can only be done by the logged in user. */ - put: operations["updateUser"]; + put: operations['updateUser'] /** This can only be done by the logged in user. */ - delete: operations["deleteUser"]; - }; + delete: operations['deleteUser'] + } } export interface components { @@ -71,101 +71,101 @@ export interface components { */ Order: { /** Format: int64 */ - id?: number; + id?: number /** Format: int64 */ - petId?: number; + petId?: number /** Format: int32 */ - quantity?: number; + quantity?: number /** Format: date-time */ - shipDate?: string; + shipDate?: string /** * @description Order Status * @enum {string} */ - status?: "placed" | "approved" | "delivered"; - complete?: boolean; - } & { [key: string]: unknown }; + status?: 'placed' | 'approved' | 'delivered' + complete?: boolean + } & { [key: string]: unknown } /** * Pet category * @description A category for a pet */ Category: { /** Format: int64 */ - id?: number; - name?: string; - } & { [key: string]: unknown }; + id?: number + name?: string + } & { [key: string]: unknown } /** * a User * @description A User who is purchasing from the pet store */ User: { /** Format: int64 */ - id?: number; - username?: string; - firstName?: string; - lastName?: string; - email?: string; - password?: string; - phone?: string; + id?: number + username?: string + firstName?: string + lastName?: string + email?: string + password?: string + phone?: string /** * Format: int32 * @description User Status */ - userStatus?: number; - } & { [key: string]: unknown }; + userStatus?: number + } & { [key: string]: unknown } /** * Pet Tag * @description A tag for a pet */ Tag: { /** Format: int64 */ - id?: number; - name?: string; - } & { [key: string]: unknown }; + id?: number + name?: string + } & { [key: string]: unknown } /** * a Pet * @description A pet for sale in the pet store */ Pet: { /** Format: int64 */ - id?: number; - category?: components["schemas"]["Category"]; + id?: number + category?: components['schemas']['Category'] /** @example doggie */ - name: string; - photoUrls: string[]; - tags?: components["schemas"]["Tag"][]; + name: string + photoUrls: string[] + tags?: components['schemas']['Tag'][] /** * @description pet status in the store * @enum {string} */ - status?: "available" | "pending" | "sold"; - } & { [key: string]: unknown }; + status?: 'available' | 'pending' | 'sold' + } & { [key: string]: unknown } /** * An uploaded response * @description Describes the result of uploading an image resource */ ApiResponse: { /** Format: int32 */ - code?: number; - type?: string; - message?: string; - } & { [key: string]: unknown }; - }; + code?: number + type?: string + message?: string + } & { [key: string]: unknown } + } requestBodies: { /** List of user object */ UserArray: { content: { - "application/json": components["schemas"]["User"][]; - }; - }; + 'application/json': components['schemas']['User'][] + } + } /** Pet object that needs to be added to the store */ Pet: { content: { - "application/json": components["schemas"]["Pet"]; - "application/xml": components["schemas"]["Pet"]; - }; - }; - }; + 'application/json': components['schemas']['Pet'] + 'application/xml': components['schemas']['Pet'] + } + } + } } export interface operations { @@ -174,347 +174,347 @@ export interface operations { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Pet"]; - "application/json": components["schemas"]["Pet"]; - }; - }; + 'application/xml': components['schemas']['Pet'] + 'application/json': components['schemas']['Pet'] + } + } /** Invalid ID supplied */ - 400: unknown; + 400: unknown /** Pet not found */ - 404: unknown; + 404: unknown /** Validation exception */ - 405: unknown; - }; - requestBody: components["requestBodies"]["Pet"]; - }; + 405: unknown + } + requestBody: components['requestBodies']['Pet'] + } addPet: { responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Pet"]; - "application/json": components["schemas"]["Pet"]; - }; - }; + 'application/xml': components['schemas']['Pet'] + 'application/json': components['schemas']['Pet'] + } + } /** Invalid input */ - 405: unknown; - }; - requestBody: components["requestBodies"]["Pet"]; - }; + 405: unknown + } + requestBody: components['requestBodies']['Pet'] + } /** Multiple status values can be provided with comma separated strings */ findPetsByStatus: { parameters: { query: { /** Status values that need to be considered for filter */ - status: ("available" | "pending" | "sold")[]; - }; - }; + status: ('available' | 'pending' | 'sold')[] + } + } responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Pet"][]; - "application/json": components["schemas"]["Pet"][]; - }; - }; + 'application/xml': components['schemas']['Pet'][] + 'application/json': components['schemas']['Pet'][] + } + } /** Invalid status value */ - 400: unknown; - }; - }; + 400: unknown + } + } /** Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. */ findPetsByTags: { parameters: { query: { /** Tags to filter by */ - tags: string[]; - }; - }; + tags: string[] + } + } responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Pet"][]; - "application/json": components["schemas"]["Pet"][]; - }; - }; + 'application/xml': components['schemas']['Pet'][] + 'application/json': components['schemas']['Pet'][] + } + } /** Invalid tag value */ - 400: unknown; - }; - }; + 400: unknown + } + } /** Returns a single pet */ getPetById: { parameters: { path: { /** ID of pet to return */ - petId: number; - }; - }; + petId: number + } + } responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Pet"]; - "application/json": components["schemas"]["Pet"]; - }; - }; + 'application/xml': components['schemas']['Pet'] + 'application/json': components['schemas']['Pet'] + } + } /** Invalid ID supplied */ - 400: unknown; + 400: unknown /** Pet not found */ - 404: unknown; - }; - }; + 404: unknown + } + } updatePetWithForm: { parameters: { path: { /** ID of pet that needs to be updated */ - petId: number; - }; - }; + petId: number + } + } responses: { /** Invalid input */ - 405: unknown; - }; + 405: unknown + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Updated name of the pet */ - name?: string; + name?: string /** @description Updated status of the pet */ - status?: string; - } & { [key: string]: unknown }; - }; - }; - }; + status?: string + } & { [key: string]: unknown } + } + } + } deletePet: { parameters: { header: { - api_key?: string; - }; + api_key?: string + } path: { /** Pet id to delete */ - petId: number; - }; - }; + petId: number + } + } responses: { /** Invalid pet value */ - 400: unknown; - }; - }; + 400: unknown + } + } uploadFile: { parameters: { path: { /** ID of pet to update */ - petId: number; - }; - }; + petId: number + } + } responses: { /** successful operation */ 200: { content: { - "application/json": components["schemas"]["ApiResponse"]; - }; - }; - }; + 'application/json': components['schemas']['ApiResponse'] + } + } + } requestBody: { content: { - "multipart/form-data": { + 'multipart/form-data': { /** @description Additional data to pass to server */ - additionalMetadata?: string; + additionalMetadata?: string /** * Format: binary * @description file to upload */ - file?: string; - } & { [key: string]: unknown }; - }; - }; - }; + file?: string + } & { [key: string]: unknown } + } + } + } /** Returns a map of status codes to quantities */ getInventory: { responses: { /** successful operation */ 200: { content: { - "application/json": { [key: string]: number }; - }; - }; - }; - }; + 'application/json': { [key: string]: number } + } + } + } + } placeOrder: { responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Order"]; - "application/json": components["schemas"]["Order"]; - }; - }; + 'application/xml': components['schemas']['Order'] + 'application/json': components['schemas']['Order'] + } + } /** Invalid Order */ - 400: unknown; - }; + 400: unknown + } /** order placed for purchasing the pet */ requestBody: { content: { - "application/json": components["schemas"]["Order"]; - }; - }; - }; + 'application/json': components['schemas']['Order'] + } + } + } /** For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions */ getOrderById: { parameters: { path: { /** ID of pet that needs to be fetched */ - orderId: number; - }; - }; + orderId: number + } + } responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Order"]; - "application/json": components["schemas"]["Order"]; - }; - }; + 'application/xml': components['schemas']['Order'] + 'application/json': components['schemas']['Order'] + } + } /** Invalid ID supplied */ - 400: unknown; + 400: unknown /** Order not found */ - 404: unknown; - }; - }; + 404: unknown + } + } /** For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors */ deleteOrder: { parameters: { path: { /** ID of the order that needs to be deleted */ - orderId: string; - }; - }; + orderId: string + } + } responses: { /** Invalid ID supplied */ - 400: unknown; + 400: unknown /** Order not found */ - 404: unknown; - }; - }; + 404: unknown + } + } /** This can only be done by the logged in user. */ createUser: { responses: { /** successful operation */ - default: unknown; - }; + default: unknown + } /** Created user object */ requestBody: { content: { - "application/json": components["schemas"]["User"]; - }; - }; - }; + 'application/json': components['schemas']['User'] + } + } + } createUsersWithArrayInput: { responses: { /** successful operation */ - default: unknown; - }; - requestBody: components["requestBodies"]["UserArray"]; - }; + default: unknown + } + requestBody: components['requestBodies']['UserArray'] + } createUsersWithListInput: { responses: { /** successful operation */ - default: unknown; - }; - requestBody: components["requestBodies"]["UserArray"]; - }; + default: unknown + } + requestBody: components['requestBodies']['UserArray'] + } loginUser: { parameters: { query: { /** The user name for login */ - username: string; + username: string /** The password for login in clear text */ - password: string; - }; - }; + password: string + } + } responses: { /** successful operation */ 200: { headers: { /** Cookie authentication key for use with the `api_key` apiKey authentication. */ - "Set-Cookie"?: string; + 'Set-Cookie'?: string /** calls per hour allowed by the user */ - "X-Rate-Limit"?: number; + 'X-Rate-Limit'?: number /** date in UTC when toekn expires */ - "X-Expires-After"?: string; - }; + 'X-Expires-After'?: string + } content: { - "application/xml": string; - "application/json": string; - }; - }; + 'application/xml': string + 'application/json': string + } + } /** Invalid username/password supplied */ - 400: unknown; - }; - }; + 400: unknown + } + } logoutUser: { responses: { /** successful operation */ - default: unknown; - }; - }; + default: unknown + } + } getUserByName: { parameters: { path: { /** The name that needs to be fetched. Use user1 for testing. */ - username: string; - }; - }; + username: string + } + } responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["User"]; - "application/json": components["schemas"]["User"]; - }; - }; + 'application/xml': components['schemas']['User'] + 'application/json': components['schemas']['User'] + } + } /** Invalid username supplied */ - 400: unknown; + 400: unknown /** User not found */ - 404: unknown; - }; - }; + 404: unknown + } + } /** This can only be done by the logged in user. */ updateUser: { parameters: { path: { /** name that need to be deleted */ - username: string; - }; - }; + username: string + } + } responses: { /** Invalid user supplied */ - 400: unknown; + 400: unknown /** User not found */ - 404: unknown; - }; + 404: unknown + } /** Updated user object */ requestBody: { content: { - "application/json": components["schemas"]["User"]; - }; - }; - }; + 'application/json': components['schemas']['User'] + } + } + } /** This can only be done by the logged in user. */ deleteUser: { parameters: { path: { /** The name that needs to be deleted */ - username: string; - }; - }; + username: string + } + } responses: { /** Invalid username supplied */ - 400: unknown; + 400: unknown /** User not found */ - 404: unknown; - }; - }; + 404: unknown + } + } } export interface external {} diff --git a/test/v3/expected/petstore-openapitools.exported-type.ts b/test/v3/expected/petstore-openapitools.exported-type.ts index 8a2e654f6..270d67a05 100644 --- a/test/v3/expected/petstore-openapitools.exported-type.ts +++ b/test/v3/expected/petstore-openapitools.exported-type.ts @@ -4,64 +4,64 @@ */ export type paths = { - "/pet": { - put: operations["updatePet"]; - post: operations["addPet"]; - }; - "/pet/findByStatus": { + '/pet': { + put: operations['updatePet'] + post: operations['addPet'] + } + '/pet/findByStatus': { /** Multiple status values can be provided with comma separated strings */ - get: operations["findPetsByStatus"]; - }; - "/pet/findByTags": { + get: operations['findPetsByStatus'] + } + '/pet/findByTags': { /** Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. */ - get: operations["findPetsByTags"]; - }; - "/pet/{petId}": { + get: operations['findPetsByTags'] + } + '/pet/{petId}': { /** Returns a single pet */ - get: operations["getPetById"]; - post: operations["updatePetWithForm"]; - delete: operations["deletePet"]; - }; - "/pet/{petId}/uploadImage": { - post: operations["uploadFile"]; - }; - "/store/inventory": { + get: operations['getPetById'] + post: operations['updatePetWithForm'] + delete: operations['deletePet'] + } + '/pet/{petId}/uploadImage': { + post: operations['uploadFile'] + } + '/store/inventory': { /** Returns a map of status codes to quantities */ - get: operations["getInventory"]; - }; - "/store/order": { - post: operations["placeOrder"]; - }; - "/store/order/{orderId}": { + get: operations['getInventory'] + } + '/store/order': { + post: operations['placeOrder'] + } + '/store/order/{orderId}': { /** For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions */ - get: operations["getOrderById"]; + get: operations['getOrderById'] /** For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors */ - delete: operations["deleteOrder"]; - }; - "/user": { + delete: operations['deleteOrder'] + } + '/user': { /** This can only be done by the logged in user. */ - post: operations["createUser"]; - }; - "/user/createWithArray": { - post: operations["createUsersWithArrayInput"]; - }; - "/user/createWithList": { - post: operations["createUsersWithListInput"]; - }; - "/user/login": { - get: operations["loginUser"]; - }; - "/user/logout": { - get: operations["logoutUser"]; - }; - "/user/{username}": { - get: operations["getUserByName"]; + post: operations['createUser'] + } + '/user/createWithArray': { + post: operations['createUsersWithArrayInput'] + } + '/user/createWithList': { + post: operations['createUsersWithListInput'] + } + '/user/login': { + get: operations['loginUser'] + } + '/user/logout': { + get: operations['logoutUser'] + } + '/user/{username}': { + get: operations['getUserByName'] /** This can only be done by the logged in user. */ - put: operations["updateUser"]; + put: operations['updateUser'] /** This can only be done by the logged in user. */ - delete: operations["deleteUser"]; - }; -}; + delete: operations['deleteUser'] + } +} export type components = { schemas: { @@ -71,102 +71,102 @@ export type components = { */ Order: { /** Format: int64 */ - id?: number; + id?: number /** Format: int64 */ - petId?: number; + petId?: number /** Format: int32 */ - quantity?: number; + quantity?: number /** Format: date-time */ - shipDate?: string; + shipDate?: string /** * @description Order Status * @enum {string} */ - status?: "placed" | "approved" | "delivered"; - complete?: boolean; - }; + status?: 'placed' | 'approved' | 'delivered' + complete?: boolean + } /** * Pet category * @description A category for a pet */ Category: { /** Format: int64 */ - id?: number; - name?: string; - }; + id?: number + name?: string + } /** * a User * @description A User who is purchasing from the pet store */ User: { /** Format: int64 */ - id?: number; - username?: string; - firstName?: string; - lastName?: string; - email?: string; - password?: string; - phone?: string; + id?: number + username?: string + firstName?: string + lastName?: string + email?: string + password?: string + phone?: string /** * Format: int32 * @description User Status */ - userStatus?: number; - }; + userStatus?: number + } /** * Pet Tag * @description A tag for a pet */ Tag: { /** Format: int64 */ - id?: number; - name?: string; - }; + id?: number + name?: string + } /** * a Pet * @description A pet for sale in the pet store */ Pet: { /** Format: int64 */ - id?: number; - category?: components["schemas"]["Category"]; + id?: number + category?: components['schemas']['Category'] /** @example doggie */ - name: string; - photoUrls: string[]; - tags?: components["schemas"]["Tag"][]; + name: string + photoUrls: string[] + tags?: components['schemas']['Tag'][] /** * @description pet status in the store * @enum {string} */ - status?: "available" | "pending" | "sold"; - }; + status?: 'available' | 'pending' | 'sold' + } /** * An uploaded response * @description Describes the result of uploading an image resource */ ApiResponse: { /** Format: int32 */ - code?: number; - type?: string; - message?: string; - }; - }; + code?: number + type?: string + message?: string + } + } requestBodies: { /** List of user object */ UserArray: { content: { - "application/json": components["schemas"]["User"][]; - }; - }; + 'application/json': components['schemas']['User'][] + } + } /** Pet object that needs to be added to the store */ Pet: { content: { - "application/json": components["schemas"]["Pet"]; - "application/xml": components["schemas"]["Pet"]; - }; - }; - }; -}; + 'application/json': components['schemas']['Pet'] + 'application/xml': components['schemas']['Pet'] + } + } + } +} export type operations = { updatePet: { @@ -174,347 +174,347 @@ export type operations = { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Pet"]; - "application/json": components["schemas"]["Pet"]; - }; - }; + 'application/xml': components['schemas']['Pet'] + 'application/json': components['schemas']['Pet'] + } + } /** Invalid ID supplied */ - 400: unknown; + 400: unknown /** Pet not found */ - 404: unknown; + 404: unknown /** Validation exception */ - 405: unknown; - }; - requestBody: components["requestBodies"]["Pet"]; - }; + 405: unknown + } + requestBody: components['requestBodies']['Pet'] + } addPet: { responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Pet"]; - "application/json": components["schemas"]["Pet"]; - }; - }; + 'application/xml': components['schemas']['Pet'] + 'application/json': components['schemas']['Pet'] + } + } /** Invalid input */ - 405: unknown; - }; - requestBody: components["requestBodies"]["Pet"]; - }; + 405: unknown + } + requestBody: components['requestBodies']['Pet'] + } /** Multiple status values can be provided with comma separated strings */ findPetsByStatus: { parameters: { query: { /** Status values that need to be considered for filter */ - status: ("available" | "pending" | "sold")[]; - }; - }; + status: ('available' | 'pending' | 'sold')[] + } + } responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Pet"][]; - "application/json": components["schemas"]["Pet"][]; - }; - }; + 'application/xml': components['schemas']['Pet'][] + 'application/json': components['schemas']['Pet'][] + } + } /** Invalid status value */ - 400: unknown; - }; - }; + 400: unknown + } + } /** Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. */ findPetsByTags: { parameters: { query: { /** Tags to filter by */ - tags: string[]; - }; - }; + tags: string[] + } + } responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Pet"][]; - "application/json": components["schemas"]["Pet"][]; - }; - }; + 'application/xml': components['schemas']['Pet'][] + 'application/json': components['schemas']['Pet'][] + } + } /** Invalid tag value */ - 400: unknown; - }; - }; + 400: unknown + } + } /** Returns a single pet */ getPetById: { parameters: { path: { /** ID of pet to return */ - petId: number; - }; - }; + petId: number + } + } responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Pet"]; - "application/json": components["schemas"]["Pet"]; - }; - }; + 'application/xml': components['schemas']['Pet'] + 'application/json': components['schemas']['Pet'] + } + } /** Invalid ID supplied */ - 400: unknown; + 400: unknown /** Pet not found */ - 404: unknown; - }; - }; + 404: unknown + } + } updatePetWithForm: { parameters: { path: { /** ID of pet that needs to be updated */ - petId: number; - }; - }; + petId: number + } + } responses: { /** Invalid input */ - 405: unknown; - }; + 405: unknown + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Updated name of the pet */ - name?: string; + name?: string /** @description Updated status of the pet */ - status?: string; - }; - }; - }; - }; + status?: string + } + } + } + } deletePet: { parameters: { header: { - api_key?: string; - }; + api_key?: string + } path: { /** Pet id to delete */ - petId: number; - }; - }; + petId: number + } + } responses: { /** Invalid pet value */ - 400: unknown; - }; - }; + 400: unknown + } + } uploadFile: { parameters: { path: { /** ID of pet to update */ - petId: number; - }; - }; + petId: number + } + } responses: { /** successful operation */ 200: { content: { - "application/json": components["schemas"]["ApiResponse"]; - }; - }; - }; + 'application/json': components['schemas']['ApiResponse'] + } + } + } requestBody: { content: { - "multipart/form-data": { + 'multipart/form-data': { /** @description Additional data to pass to server */ - additionalMetadata?: string; + additionalMetadata?: string /** * Format: binary * @description file to upload */ - file?: string; - }; - }; - }; - }; + file?: string + } + } + } + } /** Returns a map of status codes to quantities */ getInventory: { responses: { /** successful operation */ 200: { content: { - "application/json": { [key: string]: number }; - }; - }; - }; - }; + 'application/json': { [key: string]: number } + } + } + } + } placeOrder: { responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Order"]; - "application/json": components["schemas"]["Order"]; - }; - }; + 'application/xml': components['schemas']['Order'] + 'application/json': components['schemas']['Order'] + } + } /** Invalid Order */ - 400: unknown; - }; + 400: unknown + } /** order placed for purchasing the pet */ requestBody: { content: { - "application/json": components["schemas"]["Order"]; - }; - }; - }; + 'application/json': components['schemas']['Order'] + } + } + } /** For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions */ getOrderById: { parameters: { path: { /** ID of pet that needs to be fetched */ - orderId: number; - }; - }; + orderId: number + } + } responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Order"]; - "application/json": components["schemas"]["Order"]; - }; - }; + 'application/xml': components['schemas']['Order'] + 'application/json': components['schemas']['Order'] + } + } /** Invalid ID supplied */ - 400: unknown; + 400: unknown /** Order not found */ - 404: unknown; - }; - }; + 404: unknown + } + } /** For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors */ deleteOrder: { parameters: { path: { /** ID of the order that needs to be deleted */ - orderId: string; - }; - }; + orderId: string + } + } responses: { /** Invalid ID supplied */ - 400: unknown; + 400: unknown /** Order not found */ - 404: unknown; - }; - }; + 404: unknown + } + } /** This can only be done by the logged in user. */ createUser: { responses: { /** successful operation */ - default: unknown; - }; + default: unknown + } /** Created user object */ requestBody: { content: { - "application/json": components["schemas"]["User"]; - }; - }; - }; + 'application/json': components['schemas']['User'] + } + } + } createUsersWithArrayInput: { responses: { /** successful operation */ - default: unknown; - }; - requestBody: components["requestBodies"]["UserArray"]; - }; + default: unknown + } + requestBody: components['requestBodies']['UserArray'] + } createUsersWithListInput: { responses: { /** successful operation */ - default: unknown; - }; - requestBody: components["requestBodies"]["UserArray"]; - }; + default: unknown + } + requestBody: components['requestBodies']['UserArray'] + } loginUser: { parameters: { query: { /** The user name for login */ - username: string; + username: string /** The password for login in clear text */ - password: string; - }; - }; + password: string + } + } responses: { /** successful operation */ 200: { headers: { /** Cookie authentication key for use with the `api_key` apiKey authentication. */ - "Set-Cookie"?: string; + 'Set-Cookie'?: string /** calls per hour allowed by the user */ - "X-Rate-Limit"?: number; + 'X-Rate-Limit'?: number /** date in UTC when toekn expires */ - "X-Expires-After"?: string; - }; + 'X-Expires-After'?: string + } content: { - "application/xml": string; - "application/json": string; - }; - }; + 'application/xml': string + 'application/json': string + } + } /** Invalid username/password supplied */ - 400: unknown; - }; - }; + 400: unknown + } + } logoutUser: { responses: { /** successful operation */ - default: unknown; - }; - }; + default: unknown + } + } getUserByName: { parameters: { path: { /** The name that needs to be fetched. Use user1 for testing. */ - username: string; - }; - }; + username: string + } + } responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["User"]; - "application/json": components["schemas"]["User"]; - }; - }; + 'application/xml': components['schemas']['User'] + 'application/json': components['schemas']['User'] + } + } /** Invalid username supplied */ - 400: unknown; + 400: unknown /** User not found */ - 404: unknown; - }; - }; + 404: unknown + } + } /** This can only be done by the logged in user. */ updateUser: { parameters: { path: { /** name that need to be deleted */ - username: string; - }; - }; + username: string + } + } responses: { /** Invalid user supplied */ - 400: unknown; + 400: unknown /** User not found */ - 404: unknown; - }; + 404: unknown + } /** Updated user object */ requestBody: { content: { - "application/json": components["schemas"]["User"]; - }; - }; - }; + 'application/json': components['schemas']['User'] + } + } + } /** This can only be done by the logged in user. */ deleteUser: { parameters: { path: { /** The name that needs to be deleted */ - username: string; - }; - }; + username: string + } + } responses: { /** Invalid username supplied */ - 400: unknown; + 400: unknown /** User not found */ - 404: unknown; - }; - }; -}; + 404: unknown + } + } +} -export type external = {}; +export type external = {} diff --git a/test/v3/expected/petstore-openapitools.immutable.ts b/test/v3/expected/petstore-openapitools.immutable.ts index 28d8ab03f..b8e4884b4 100644 --- a/test/v3/expected/petstore-openapitools.immutable.ts +++ b/test/v3/expected/petstore-openapitools.immutable.ts @@ -4,63 +4,63 @@ */ export interface paths { - readonly "/pet": { - readonly put: operations["updatePet"]; - readonly post: operations["addPet"]; - }; - readonly "/pet/findByStatus": { + readonly '/pet': { + readonly put: operations['updatePet'] + readonly post: operations['addPet'] + } + readonly '/pet/findByStatus': { /** Multiple status values can be provided with comma separated strings */ - readonly get: operations["findPetsByStatus"]; - }; - readonly "/pet/findByTags": { + readonly get: operations['findPetsByStatus'] + } + readonly '/pet/findByTags': { /** Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. */ - readonly get: operations["findPetsByTags"]; - }; - readonly "/pet/{petId}": { + readonly get: operations['findPetsByTags'] + } + readonly '/pet/{petId}': { /** Returns a single pet */ - readonly get: operations["getPetById"]; - readonly post: operations["updatePetWithForm"]; - readonly delete: operations["deletePet"]; - }; - readonly "/pet/{petId}/uploadImage": { - readonly post: operations["uploadFile"]; - }; - readonly "/store/inventory": { + readonly get: operations['getPetById'] + readonly post: operations['updatePetWithForm'] + readonly delete: operations['deletePet'] + } + readonly '/pet/{petId}/uploadImage': { + readonly post: operations['uploadFile'] + } + readonly '/store/inventory': { /** Returns a map of status codes to quantities */ - readonly get: operations["getInventory"]; - }; - readonly "/store/order": { - readonly post: operations["placeOrder"]; - }; - readonly "/store/order/{orderId}": { + readonly get: operations['getInventory'] + } + readonly '/store/order': { + readonly post: operations['placeOrder'] + } + readonly '/store/order/{orderId}': { /** For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions */ - readonly get: operations["getOrderById"]; + readonly get: operations['getOrderById'] /** For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors */ - readonly delete: operations["deleteOrder"]; - }; - readonly "/user": { + readonly delete: operations['deleteOrder'] + } + readonly '/user': { /** This can only be done by the logged in user. */ - readonly post: operations["createUser"]; - }; - readonly "/user/createWithArray": { - readonly post: operations["createUsersWithArrayInput"]; - }; - readonly "/user/createWithList": { - readonly post: operations["createUsersWithListInput"]; - }; - readonly "/user/login": { - readonly get: operations["loginUser"]; - }; - readonly "/user/logout": { - readonly get: operations["logoutUser"]; - }; - readonly "/user/{username}": { - readonly get: operations["getUserByName"]; + readonly post: operations['createUser'] + } + readonly '/user/createWithArray': { + readonly post: operations['createUsersWithArrayInput'] + } + readonly '/user/createWithList': { + readonly post: operations['createUsersWithListInput'] + } + readonly '/user/login': { + readonly get: operations['loginUser'] + } + readonly '/user/logout': { + readonly get: operations['logoutUser'] + } + readonly '/user/{username}': { + readonly get: operations['getUserByName'] /** This can only be done by the logged in user. */ - readonly put: operations["updateUser"]; + readonly put: operations['updateUser'] /** This can only be done by the logged in user. */ - readonly delete: operations["deleteUser"]; - }; + readonly delete: operations['deleteUser'] + } } export interface components { @@ -71,101 +71,101 @@ export interface components { */ readonly Order: { /** Format: int64 */ - readonly id?: number; + readonly id?: number /** Format: int64 */ - readonly petId?: number; + readonly petId?: number /** Format: int32 */ - readonly quantity?: number; + readonly quantity?: number /** Format: date-time */ - readonly shipDate?: string; + readonly shipDate?: string /** * @description Order Status * @enum {string} */ - readonly status?: "placed" | "approved" | "delivered"; - readonly complete?: boolean; - }; + readonly status?: 'placed' | 'approved' | 'delivered' + readonly complete?: boolean + } /** * Pet category * @description A category for a pet */ readonly Category: { /** Format: int64 */ - readonly id?: number; - readonly name?: string; - }; + readonly id?: number + readonly name?: string + } /** * a User * @description A User who is purchasing from the pet store */ readonly User: { /** Format: int64 */ - readonly id?: number; - readonly username?: string; - readonly firstName?: string; - readonly lastName?: string; - readonly email?: string; - readonly password?: string; - readonly phone?: string; + readonly id?: number + readonly username?: string + readonly firstName?: string + readonly lastName?: string + readonly email?: string + readonly password?: string + readonly phone?: string /** * Format: int32 * @description User Status */ - readonly userStatus?: number; - }; + readonly userStatus?: number + } /** * Pet Tag * @description A tag for a pet */ readonly Tag: { /** Format: int64 */ - readonly id?: number; - readonly name?: string; - }; + readonly id?: number + readonly name?: string + } /** * a Pet * @description A pet for sale in the pet store */ readonly Pet: { /** Format: int64 */ - readonly id?: number; - readonly category?: components["schemas"]["Category"]; + readonly id?: number + readonly category?: components['schemas']['Category'] /** @example doggie */ - readonly name: string; - readonly photoUrls: readonly string[]; - readonly tags?: readonly components["schemas"]["Tag"][]; + readonly name: string + readonly photoUrls: readonly string[] + readonly tags?: readonly components['schemas']['Tag'][] /** * @description pet status in the store * @enum {string} */ - readonly status?: "available" | "pending" | "sold"; - }; + readonly status?: 'available' | 'pending' | 'sold' + } /** * An uploaded response * @description Describes the result of uploading an image resource */ readonly ApiResponse: { /** Format: int32 */ - readonly code?: number; - readonly type?: string; - readonly message?: string; - }; - }; + readonly code?: number + readonly type?: string + readonly message?: string + } + } readonly requestBodies: { /** List of user object */ UserArray: { readonly content: { - readonly "application/json": readonly components["schemas"]["User"][]; - }; - }; + readonly 'application/json': readonly components['schemas']['User'][] + } + } /** Pet object that needs to be added to the store */ Pet: { readonly content: { - readonly "application/json": components["schemas"]["Pet"]; - readonly "application/xml": components["schemas"]["Pet"]; - }; - }; - }; + readonly 'application/json': components['schemas']['Pet'] + readonly 'application/xml': components['schemas']['Pet'] + } + } + } } export interface operations { @@ -174,347 +174,347 @@ export interface operations { /** successful operation */ readonly 200: { readonly content: { - readonly "application/xml": components["schemas"]["Pet"]; - readonly "application/json": components["schemas"]["Pet"]; - }; - }; + readonly 'application/xml': components['schemas']['Pet'] + readonly 'application/json': components['schemas']['Pet'] + } + } /** Invalid ID supplied */ - readonly 400: unknown; + readonly 400: unknown /** Pet not found */ - readonly 404: unknown; + readonly 404: unknown /** Validation exception */ - readonly 405: unknown; - }; - readonly requestBody: components["requestBodies"]["Pet"]; - }; + readonly 405: unknown + } + readonly requestBody: components['requestBodies']['Pet'] + } readonly addPet: { readonly responses: { /** successful operation */ readonly 200: { readonly content: { - readonly "application/xml": components["schemas"]["Pet"]; - readonly "application/json": components["schemas"]["Pet"]; - }; - }; + readonly 'application/xml': components['schemas']['Pet'] + readonly 'application/json': components['schemas']['Pet'] + } + } /** Invalid input */ - readonly 405: unknown; - }; - readonly requestBody: components["requestBodies"]["Pet"]; - }; + readonly 405: unknown + } + readonly requestBody: components['requestBodies']['Pet'] + } /** Multiple status values can be provided with comma separated strings */ readonly findPetsByStatus: { readonly parameters: { readonly query: { /** Status values that need to be considered for filter */ - readonly status: readonly ("available" | "pending" | "sold")[]; - }; - }; + readonly status: readonly ('available' | 'pending' | 'sold')[] + } + } readonly responses: { /** successful operation */ readonly 200: { readonly content: { - readonly "application/xml": readonly components["schemas"]["Pet"][]; - readonly "application/json": readonly components["schemas"]["Pet"][]; - }; - }; + readonly 'application/xml': readonly components['schemas']['Pet'][] + readonly 'application/json': readonly components['schemas']['Pet'][] + } + } /** Invalid status value */ - readonly 400: unknown; - }; - }; + readonly 400: unknown + } + } /** Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. */ readonly findPetsByTags: { readonly parameters: { readonly query: { /** Tags to filter by */ - readonly tags: readonly string[]; - }; - }; + readonly tags: readonly string[] + } + } readonly responses: { /** successful operation */ readonly 200: { readonly content: { - readonly "application/xml": readonly components["schemas"]["Pet"][]; - readonly "application/json": readonly components["schemas"]["Pet"][]; - }; - }; + readonly 'application/xml': readonly components['schemas']['Pet'][] + readonly 'application/json': readonly components['schemas']['Pet'][] + } + } /** Invalid tag value */ - readonly 400: unknown; - }; - }; + readonly 400: unknown + } + } /** Returns a single pet */ readonly getPetById: { readonly parameters: { readonly path: { /** ID of pet to return */ - readonly petId: number; - }; - }; + readonly petId: number + } + } readonly responses: { /** successful operation */ readonly 200: { readonly content: { - readonly "application/xml": components["schemas"]["Pet"]; - readonly "application/json": components["schemas"]["Pet"]; - }; - }; + readonly 'application/xml': components['schemas']['Pet'] + readonly 'application/json': components['schemas']['Pet'] + } + } /** Invalid ID supplied */ - readonly 400: unknown; + readonly 400: unknown /** Pet not found */ - readonly 404: unknown; - }; - }; + readonly 404: unknown + } + } readonly updatePetWithForm: { readonly parameters: { readonly path: { /** ID of pet that needs to be updated */ - readonly petId: number; - }; - }; + readonly petId: number + } + } readonly responses: { /** Invalid input */ - readonly 405: unknown; - }; + readonly 405: unknown + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Updated name of the pet */ - readonly name?: string; + readonly name?: string /** @description Updated status of the pet */ - readonly status?: string; - }; - }; - }; - }; + readonly status?: string + } + } + } + } readonly deletePet: { readonly parameters: { readonly header: { - readonly api_key?: string; - }; + readonly api_key?: string + } readonly path: { /** Pet id to delete */ - readonly petId: number; - }; - }; + readonly petId: number + } + } readonly responses: { /** Invalid pet value */ - readonly 400: unknown; - }; - }; + readonly 400: unknown + } + } readonly uploadFile: { readonly parameters: { readonly path: { /** ID of pet to update */ - readonly petId: number; - }; - }; + readonly petId: number + } + } readonly responses: { /** successful operation */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["ApiResponse"]; - }; - }; - }; + readonly 'application/json': components['schemas']['ApiResponse'] + } + } + } readonly requestBody: { readonly content: { - readonly "multipart/form-data": { + readonly 'multipart/form-data': { /** @description Additional data to pass to server */ - readonly additionalMetadata?: string; + readonly additionalMetadata?: string /** * Format: binary * @description file to upload */ - readonly file?: string; - }; - }; - }; - }; + readonly file?: string + } + } + } + } /** Returns a map of status codes to quantities */ readonly getInventory: { readonly responses: { /** successful operation */ readonly 200: { readonly content: { - readonly "application/json": { readonly [key: string]: number }; - }; - }; - }; - }; + readonly 'application/json': { readonly [key: string]: number } + } + } + } + } readonly placeOrder: { readonly responses: { /** successful operation */ readonly 200: { readonly content: { - readonly "application/xml": components["schemas"]["Order"]; - readonly "application/json": components["schemas"]["Order"]; - }; - }; + readonly 'application/xml': components['schemas']['Order'] + readonly 'application/json': components['schemas']['Order'] + } + } /** Invalid Order */ - readonly 400: unknown; - }; + readonly 400: unknown + } /** order placed for purchasing the pet */ readonly requestBody: { readonly content: { - readonly "application/json": components["schemas"]["Order"]; - }; - }; - }; + readonly 'application/json': components['schemas']['Order'] + } + } + } /** For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions */ readonly getOrderById: { readonly parameters: { readonly path: { /** ID of pet that needs to be fetched */ - readonly orderId: number; - }; - }; + readonly orderId: number + } + } readonly responses: { /** successful operation */ readonly 200: { readonly content: { - readonly "application/xml": components["schemas"]["Order"]; - readonly "application/json": components["schemas"]["Order"]; - }; - }; + readonly 'application/xml': components['schemas']['Order'] + readonly 'application/json': components['schemas']['Order'] + } + } /** Invalid ID supplied */ - readonly 400: unknown; + readonly 400: unknown /** Order not found */ - readonly 404: unknown; - }; - }; + readonly 404: unknown + } + } /** For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors */ readonly deleteOrder: { readonly parameters: { readonly path: { /** ID of the order that needs to be deleted */ - readonly orderId: string; - }; - }; + readonly orderId: string + } + } readonly responses: { /** Invalid ID supplied */ - readonly 400: unknown; + readonly 400: unknown /** Order not found */ - readonly 404: unknown; - }; - }; + readonly 404: unknown + } + } /** This can only be done by the logged in user. */ readonly createUser: { readonly responses: { /** successful operation */ - readonly default: unknown; - }; + readonly default: unknown + } /** Created user object */ readonly requestBody: { readonly content: { - readonly "application/json": components["schemas"]["User"]; - }; - }; - }; + readonly 'application/json': components['schemas']['User'] + } + } + } readonly createUsersWithArrayInput: { readonly responses: { /** successful operation */ - readonly default: unknown; - }; - readonly requestBody: components["requestBodies"]["UserArray"]; - }; + readonly default: unknown + } + readonly requestBody: components['requestBodies']['UserArray'] + } readonly createUsersWithListInput: { readonly responses: { /** successful operation */ - readonly default: unknown; - }; - readonly requestBody: components["requestBodies"]["UserArray"]; - }; + readonly default: unknown + } + readonly requestBody: components['requestBodies']['UserArray'] + } readonly loginUser: { readonly parameters: { readonly query: { /** The user name for login */ - readonly username: string; + readonly username: string /** The password for login in clear text */ - readonly password: string; - }; - }; + readonly password: string + } + } readonly responses: { /** successful operation */ readonly 200: { readonly headers: { /** Cookie authentication key for use with the `api_key` apiKey authentication. */ - readonly "Set-Cookie"?: string; + readonly 'Set-Cookie'?: string /** calls per hour allowed by the user */ - readonly "X-Rate-Limit"?: number; + readonly 'X-Rate-Limit'?: number /** date in UTC when toekn expires */ - readonly "X-Expires-After"?: string; - }; + readonly 'X-Expires-After'?: string + } readonly content: { - readonly "application/xml": string; - readonly "application/json": string; - }; - }; + readonly 'application/xml': string + readonly 'application/json': string + } + } /** Invalid username/password supplied */ - readonly 400: unknown; - }; - }; + readonly 400: unknown + } + } readonly logoutUser: { readonly responses: { /** successful operation */ - readonly default: unknown; - }; - }; + readonly default: unknown + } + } readonly getUserByName: { readonly parameters: { readonly path: { /** The name that needs to be fetched. Use user1 for testing. */ - readonly username: string; - }; - }; + readonly username: string + } + } readonly responses: { /** successful operation */ readonly 200: { readonly content: { - readonly "application/xml": components["schemas"]["User"]; - readonly "application/json": components["schemas"]["User"]; - }; - }; + readonly 'application/xml': components['schemas']['User'] + readonly 'application/json': components['schemas']['User'] + } + } /** Invalid username supplied */ - readonly 400: unknown; + readonly 400: unknown /** User not found */ - readonly 404: unknown; - }; - }; + readonly 404: unknown + } + } /** This can only be done by the logged in user. */ readonly updateUser: { readonly parameters: { readonly path: { /** name that need to be deleted */ - readonly username: string; - }; - }; + readonly username: string + } + } readonly responses: { /** Invalid user supplied */ - readonly 400: unknown; + readonly 400: unknown /** User not found */ - readonly 404: unknown; - }; + readonly 404: unknown + } /** Updated user object */ readonly requestBody: { readonly content: { - readonly "application/json": components["schemas"]["User"]; - }; - }; - }; + readonly 'application/json': components['schemas']['User'] + } + } + } /** This can only be done by the logged in user. */ readonly deleteUser: { readonly parameters: { readonly path: { /** The name that needs to be deleted */ - readonly username: string; - }; - }; + readonly username: string + } + } readonly responses: { /** Invalid username supplied */ - readonly 400: unknown; + readonly 400: unknown /** User not found */ - readonly 404: unknown; - }; - }; + readonly 404: unknown + } + } } export interface external {} diff --git a/test/v3/expected/petstore-openapitools.support-array-length.ts b/test/v3/expected/petstore-openapitools.support-array-length.ts index c6fb95bc1..d426ccef4 100644 --- a/test/v3/expected/petstore-openapitools.support-array-length.ts +++ b/test/v3/expected/petstore-openapitools.support-array-length.ts @@ -4,63 +4,63 @@ */ export interface paths { - "/pet": { - put: operations["updatePet"]; - post: operations["addPet"]; - }; - "/pet/findByStatus": { + '/pet': { + put: operations['updatePet'] + post: operations['addPet'] + } + '/pet/findByStatus': { /** Multiple status values can be provided with comma separated strings */ - get: operations["findPetsByStatus"]; - }; - "/pet/findByTags": { + get: operations['findPetsByStatus'] + } + '/pet/findByTags': { /** Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. */ - get: operations["findPetsByTags"]; - }; - "/pet/{petId}": { + get: operations['findPetsByTags'] + } + '/pet/{petId}': { /** Returns a single pet */ - get: operations["getPetById"]; - post: operations["updatePetWithForm"]; - delete: operations["deletePet"]; - }; - "/pet/{petId}/uploadImage": { - post: operations["uploadFile"]; - }; - "/store/inventory": { + get: operations['getPetById'] + post: operations['updatePetWithForm'] + delete: operations['deletePet'] + } + '/pet/{petId}/uploadImage': { + post: operations['uploadFile'] + } + '/store/inventory': { /** Returns a map of status codes to quantities */ - get: operations["getInventory"]; - }; - "/store/order": { - post: operations["placeOrder"]; - }; - "/store/order/{orderId}": { + get: operations['getInventory'] + } + '/store/order': { + post: operations['placeOrder'] + } + '/store/order/{orderId}': { /** For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions */ - get: operations["getOrderById"]; + get: operations['getOrderById'] /** For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors */ - delete: operations["deleteOrder"]; - }; - "/user": { + delete: operations['deleteOrder'] + } + '/user': { /** This can only be done by the logged in user. */ - post: operations["createUser"]; - }; - "/user/createWithArray": { - post: operations["createUsersWithArrayInput"]; - }; - "/user/createWithList": { - post: operations["createUsersWithListInput"]; - }; - "/user/login": { - get: operations["loginUser"]; - }; - "/user/logout": { - get: operations["logoutUser"]; - }; - "/user/{username}": { - get: operations["getUserByName"]; + post: operations['createUser'] + } + '/user/createWithArray': { + post: operations['createUsersWithArrayInput'] + } + '/user/createWithList': { + post: operations['createUsersWithListInput'] + } + '/user/login': { + get: operations['loginUser'] + } + '/user/logout': { + get: operations['logoutUser'] + } + '/user/{username}': { + get: operations['getUserByName'] /** This can only be done by the logged in user. */ - put: operations["updateUser"]; + put: operations['updateUser'] /** This can only be done by the logged in user. */ - delete: operations["deleteUser"]; - }; + delete: operations['deleteUser'] + } } export interface components { @@ -71,101 +71,101 @@ export interface components { */ Order: { /** Format: int64 */ - id?: number; + id?: number /** Format: int64 */ - petId?: number; + petId?: number /** Format: int32 */ - quantity?: number; + quantity?: number /** Format: date-time */ - shipDate?: string; + shipDate?: string /** * @description Order Status * @enum {string} */ - status?: "placed" | "approved" | "delivered"; - complete?: boolean; - }; + status?: 'placed' | 'approved' | 'delivered' + complete?: boolean + } /** * Pet category * @description A category for a pet */ Category: { /** Format: int64 */ - id?: number; - name?: string; - }; + id?: number + name?: string + } /** * a User * @description A User who is purchasing from the pet store */ User: { /** Format: int64 */ - id?: number; - username?: string; - firstName?: string; - lastName?: string; - email?: string; - password?: string; - phone?: string; + id?: number + username?: string + firstName?: string + lastName?: string + email?: string + password?: string + phone?: string /** * Format: int32 * @description User Status */ - userStatus?: number; - }; + userStatus?: number + } /** * Pet Tag * @description A tag for a pet */ Tag: { /** Format: int64 */ - id?: number; - name?: string; - }; + id?: number + name?: string + } /** * a Pet * @description A pet for sale in the pet store */ Pet: { /** Format: int64 */ - id?: number; - category?: components["schemas"]["Category"]; + id?: number + category?: components['schemas']['Category'] /** @example doggie */ - name: string; - photoUrls: string[]; - tags?: components["schemas"]["Tag"][]; + name: string + photoUrls: string[] + tags?: components['schemas']['Tag'][] /** * @description pet status in the store * @enum {string} */ - status?: "available" | "pending" | "sold"; - }; + status?: 'available' | 'pending' | 'sold' + } /** * An uploaded response * @description Describes the result of uploading an image resource */ ApiResponse: { /** Format: int32 */ - code?: number; - type?: string; - message?: string; - }; - }; + code?: number + type?: string + message?: string + } + } requestBodies: { /** List of user object */ UserArray: { content: { - "application/json": components["schemas"]["User"][]; - }; - }; + 'application/json': components['schemas']['User'][] + } + } /** Pet object that needs to be added to the store */ Pet: { content: { - "application/json": components["schemas"]["Pet"]; - "application/xml": components["schemas"]["Pet"]; - }; - }; - }; + 'application/json': components['schemas']['Pet'] + 'application/xml': components['schemas']['Pet'] + } + } + } } export interface operations { @@ -174,347 +174,347 @@ export interface operations { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Pet"]; - "application/json": components["schemas"]["Pet"]; - }; - }; + 'application/xml': components['schemas']['Pet'] + 'application/json': components['schemas']['Pet'] + } + } /** Invalid ID supplied */ - 400: unknown; + 400: unknown /** Pet not found */ - 404: unknown; + 404: unknown /** Validation exception */ - 405: unknown; - }; - requestBody: components["requestBodies"]["Pet"]; - }; + 405: unknown + } + requestBody: components['requestBodies']['Pet'] + } addPet: { responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Pet"]; - "application/json": components["schemas"]["Pet"]; - }; - }; + 'application/xml': components['schemas']['Pet'] + 'application/json': components['schemas']['Pet'] + } + } /** Invalid input */ - 405: unknown; - }; - requestBody: components["requestBodies"]["Pet"]; - }; + 405: unknown + } + requestBody: components['requestBodies']['Pet'] + } /** Multiple status values can be provided with comma separated strings */ findPetsByStatus: { parameters: { query: { /** Status values that need to be considered for filter */ - status: ("available" | "pending" | "sold")[]; - }; - }; + status: ('available' | 'pending' | 'sold')[] + } + } responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Pet"][]; - "application/json": components["schemas"]["Pet"][]; - }; - }; + 'application/xml': components['schemas']['Pet'][] + 'application/json': components['schemas']['Pet'][] + } + } /** Invalid status value */ - 400: unknown; - }; - }; + 400: unknown + } + } /** Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. */ findPetsByTags: { parameters: { query: { /** Tags to filter by */ - tags: string[]; - }; - }; + tags: string[] + } + } responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Pet"][]; - "application/json": components["schemas"]["Pet"][]; - }; - }; + 'application/xml': components['schemas']['Pet'][] + 'application/json': components['schemas']['Pet'][] + } + } /** Invalid tag value */ - 400: unknown; - }; - }; + 400: unknown + } + } /** Returns a single pet */ getPetById: { parameters: { path: { /** ID of pet to return */ - petId: number; - }; - }; + petId: number + } + } responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Pet"]; - "application/json": components["schemas"]["Pet"]; - }; - }; + 'application/xml': components['schemas']['Pet'] + 'application/json': components['schemas']['Pet'] + } + } /** Invalid ID supplied */ - 400: unknown; + 400: unknown /** Pet not found */ - 404: unknown; - }; - }; + 404: unknown + } + } updatePetWithForm: { parameters: { path: { /** ID of pet that needs to be updated */ - petId: number; - }; - }; + petId: number + } + } responses: { /** Invalid input */ - 405: unknown; - }; + 405: unknown + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Updated name of the pet */ - name?: string; + name?: string /** @description Updated status of the pet */ - status?: string; - }; - }; - }; - }; + status?: string + } + } + } + } deletePet: { parameters: { header: { - api_key?: string; - }; + api_key?: string + } path: { /** Pet id to delete */ - petId: number; - }; - }; + petId: number + } + } responses: { /** Invalid pet value */ - 400: unknown; - }; - }; + 400: unknown + } + } uploadFile: { parameters: { path: { /** ID of pet to update */ - petId: number; - }; - }; + petId: number + } + } responses: { /** successful operation */ 200: { content: { - "application/json": components["schemas"]["ApiResponse"]; - }; - }; - }; + 'application/json': components['schemas']['ApiResponse'] + } + } + } requestBody: { content: { - "multipart/form-data": { + 'multipart/form-data': { /** @description Additional data to pass to server */ - additionalMetadata?: string; + additionalMetadata?: string /** * Format: binary * @description file to upload */ - file?: string; - }; - }; - }; - }; + file?: string + } + } + } + } /** Returns a map of status codes to quantities */ getInventory: { responses: { /** successful operation */ 200: { content: { - "application/json": { [key: string]: number }; - }; - }; - }; - }; + 'application/json': { [key: string]: number } + } + } + } + } placeOrder: { responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Order"]; - "application/json": components["schemas"]["Order"]; - }; - }; + 'application/xml': components['schemas']['Order'] + 'application/json': components['schemas']['Order'] + } + } /** Invalid Order */ - 400: unknown; - }; + 400: unknown + } /** order placed for purchasing the pet */ requestBody: { content: { - "application/json": components["schemas"]["Order"]; - }; - }; - }; + 'application/json': components['schemas']['Order'] + } + } + } /** For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions */ getOrderById: { parameters: { path: { /** ID of pet that needs to be fetched */ - orderId: number; - }; - }; + orderId: number + } + } responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Order"]; - "application/json": components["schemas"]["Order"]; - }; - }; + 'application/xml': components['schemas']['Order'] + 'application/json': components['schemas']['Order'] + } + } /** Invalid ID supplied */ - 400: unknown; + 400: unknown /** Order not found */ - 404: unknown; - }; - }; + 404: unknown + } + } /** For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors */ deleteOrder: { parameters: { path: { /** ID of the order that needs to be deleted */ - orderId: string; - }; - }; + orderId: string + } + } responses: { /** Invalid ID supplied */ - 400: unknown; + 400: unknown /** Order not found */ - 404: unknown; - }; - }; + 404: unknown + } + } /** This can only be done by the logged in user. */ createUser: { responses: { /** successful operation */ - default: unknown; - }; + default: unknown + } /** Created user object */ requestBody: { content: { - "application/json": components["schemas"]["User"]; - }; - }; - }; + 'application/json': components['schemas']['User'] + } + } + } createUsersWithArrayInput: { responses: { /** successful operation */ - default: unknown; - }; - requestBody: components["requestBodies"]["UserArray"]; - }; + default: unknown + } + requestBody: components['requestBodies']['UserArray'] + } createUsersWithListInput: { responses: { /** successful operation */ - default: unknown; - }; - requestBody: components["requestBodies"]["UserArray"]; - }; + default: unknown + } + requestBody: components['requestBodies']['UserArray'] + } loginUser: { parameters: { query: { /** The user name for login */ - username: string; + username: string /** The password for login in clear text */ - password: string; - }; - }; + password: string + } + } responses: { /** successful operation */ 200: { headers: { /** Cookie authentication key for use with the `api_key` apiKey authentication. */ - "Set-Cookie"?: string; + 'Set-Cookie'?: string /** calls per hour allowed by the user */ - "X-Rate-Limit"?: number; + 'X-Rate-Limit'?: number /** date in UTC when toekn expires */ - "X-Expires-After"?: string; - }; + 'X-Expires-After'?: string + } content: { - "application/xml": string; - "application/json": string; - }; - }; + 'application/xml': string + 'application/json': string + } + } /** Invalid username/password supplied */ - 400: unknown; - }; - }; + 400: unknown + } + } logoutUser: { responses: { /** successful operation */ - default: unknown; - }; - }; + default: unknown + } + } getUserByName: { parameters: { path: { /** The name that needs to be fetched. Use user1 for testing. */ - username: string; - }; - }; + username: string + } + } responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["User"]; - "application/json": components["schemas"]["User"]; - }; - }; + 'application/xml': components['schemas']['User'] + 'application/json': components['schemas']['User'] + } + } /** Invalid username supplied */ - 400: unknown; + 400: unknown /** User not found */ - 404: unknown; - }; - }; + 404: unknown + } + } /** This can only be done by the logged in user. */ updateUser: { parameters: { path: { /** name that need to be deleted */ - username: string; - }; - }; + username: string + } + } responses: { /** Invalid user supplied */ - 400: unknown; + 400: unknown /** User not found */ - 404: unknown; - }; + 404: unknown + } /** Updated user object */ requestBody: { content: { - "application/json": components["schemas"]["User"]; - }; - }; - }; + 'application/json': components['schemas']['User'] + } + } + } /** This can only be done by the logged in user. */ deleteUser: { parameters: { path: { /** The name that needs to be deleted */ - username: string; - }; - }; + username: string + } + } responses: { /** Invalid username supplied */ - 400: unknown; + 400: unknown /** User not found */ - 404: unknown; - }; - }; + 404: unknown + } + } } export interface external {} diff --git a/test/v3/expected/petstore-openapitools.ts b/test/v3/expected/petstore-openapitools.ts index c6fb95bc1..d426ccef4 100644 --- a/test/v3/expected/petstore-openapitools.ts +++ b/test/v3/expected/petstore-openapitools.ts @@ -4,63 +4,63 @@ */ export interface paths { - "/pet": { - put: operations["updatePet"]; - post: operations["addPet"]; - }; - "/pet/findByStatus": { + '/pet': { + put: operations['updatePet'] + post: operations['addPet'] + } + '/pet/findByStatus': { /** Multiple status values can be provided with comma separated strings */ - get: operations["findPetsByStatus"]; - }; - "/pet/findByTags": { + get: operations['findPetsByStatus'] + } + '/pet/findByTags': { /** Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. */ - get: operations["findPetsByTags"]; - }; - "/pet/{petId}": { + get: operations['findPetsByTags'] + } + '/pet/{petId}': { /** Returns a single pet */ - get: operations["getPetById"]; - post: operations["updatePetWithForm"]; - delete: operations["deletePet"]; - }; - "/pet/{petId}/uploadImage": { - post: operations["uploadFile"]; - }; - "/store/inventory": { + get: operations['getPetById'] + post: operations['updatePetWithForm'] + delete: operations['deletePet'] + } + '/pet/{petId}/uploadImage': { + post: operations['uploadFile'] + } + '/store/inventory': { /** Returns a map of status codes to quantities */ - get: operations["getInventory"]; - }; - "/store/order": { - post: operations["placeOrder"]; - }; - "/store/order/{orderId}": { + get: operations['getInventory'] + } + '/store/order': { + post: operations['placeOrder'] + } + '/store/order/{orderId}': { /** For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions */ - get: operations["getOrderById"]; + get: operations['getOrderById'] /** For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors */ - delete: operations["deleteOrder"]; - }; - "/user": { + delete: operations['deleteOrder'] + } + '/user': { /** This can only be done by the logged in user. */ - post: operations["createUser"]; - }; - "/user/createWithArray": { - post: operations["createUsersWithArrayInput"]; - }; - "/user/createWithList": { - post: operations["createUsersWithListInput"]; - }; - "/user/login": { - get: operations["loginUser"]; - }; - "/user/logout": { - get: operations["logoutUser"]; - }; - "/user/{username}": { - get: operations["getUserByName"]; + post: operations['createUser'] + } + '/user/createWithArray': { + post: operations['createUsersWithArrayInput'] + } + '/user/createWithList': { + post: operations['createUsersWithListInput'] + } + '/user/login': { + get: operations['loginUser'] + } + '/user/logout': { + get: operations['logoutUser'] + } + '/user/{username}': { + get: operations['getUserByName'] /** This can only be done by the logged in user. */ - put: operations["updateUser"]; + put: operations['updateUser'] /** This can only be done by the logged in user. */ - delete: operations["deleteUser"]; - }; + delete: operations['deleteUser'] + } } export interface components { @@ -71,101 +71,101 @@ export interface components { */ Order: { /** Format: int64 */ - id?: number; + id?: number /** Format: int64 */ - petId?: number; + petId?: number /** Format: int32 */ - quantity?: number; + quantity?: number /** Format: date-time */ - shipDate?: string; + shipDate?: string /** * @description Order Status * @enum {string} */ - status?: "placed" | "approved" | "delivered"; - complete?: boolean; - }; + status?: 'placed' | 'approved' | 'delivered' + complete?: boolean + } /** * Pet category * @description A category for a pet */ Category: { /** Format: int64 */ - id?: number; - name?: string; - }; + id?: number + name?: string + } /** * a User * @description A User who is purchasing from the pet store */ User: { /** Format: int64 */ - id?: number; - username?: string; - firstName?: string; - lastName?: string; - email?: string; - password?: string; - phone?: string; + id?: number + username?: string + firstName?: string + lastName?: string + email?: string + password?: string + phone?: string /** * Format: int32 * @description User Status */ - userStatus?: number; - }; + userStatus?: number + } /** * Pet Tag * @description A tag for a pet */ Tag: { /** Format: int64 */ - id?: number; - name?: string; - }; + id?: number + name?: string + } /** * a Pet * @description A pet for sale in the pet store */ Pet: { /** Format: int64 */ - id?: number; - category?: components["schemas"]["Category"]; + id?: number + category?: components['schemas']['Category'] /** @example doggie */ - name: string; - photoUrls: string[]; - tags?: components["schemas"]["Tag"][]; + name: string + photoUrls: string[] + tags?: components['schemas']['Tag'][] /** * @description pet status in the store * @enum {string} */ - status?: "available" | "pending" | "sold"; - }; + status?: 'available' | 'pending' | 'sold' + } /** * An uploaded response * @description Describes the result of uploading an image resource */ ApiResponse: { /** Format: int32 */ - code?: number; - type?: string; - message?: string; - }; - }; + code?: number + type?: string + message?: string + } + } requestBodies: { /** List of user object */ UserArray: { content: { - "application/json": components["schemas"]["User"][]; - }; - }; + 'application/json': components['schemas']['User'][] + } + } /** Pet object that needs to be added to the store */ Pet: { content: { - "application/json": components["schemas"]["Pet"]; - "application/xml": components["schemas"]["Pet"]; - }; - }; - }; + 'application/json': components['schemas']['Pet'] + 'application/xml': components['schemas']['Pet'] + } + } + } } export interface operations { @@ -174,347 +174,347 @@ export interface operations { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Pet"]; - "application/json": components["schemas"]["Pet"]; - }; - }; + 'application/xml': components['schemas']['Pet'] + 'application/json': components['schemas']['Pet'] + } + } /** Invalid ID supplied */ - 400: unknown; + 400: unknown /** Pet not found */ - 404: unknown; + 404: unknown /** Validation exception */ - 405: unknown; - }; - requestBody: components["requestBodies"]["Pet"]; - }; + 405: unknown + } + requestBody: components['requestBodies']['Pet'] + } addPet: { responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Pet"]; - "application/json": components["schemas"]["Pet"]; - }; - }; + 'application/xml': components['schemas']['Pet'] + 'application/json': components['schemas']['Pet'] + } + } /** Invalid input */ - 405: unknown; - }; - requestBody: components["requestBodies"]["Pet"]; - }; + 405: unknown + } + requestBody: components['requestBodies']['Pet'] + } /** Multiple status values can be provided with comma separated strings */ findPetsByStatus: { parameters: { query: { /** Status values that need to be considered for filter */ - status: ("available" | "pending" | "sold")[]; - }; - }; + status: ('available' | 'pending' | 'sold')[] + } + } responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Pet"][]; - "application/json": components["schemas"]["Pet"][]; - }; - }; + 'application/xml': components['schemas']['Pet'][] + 'application/json': components['schemas']['Pet'][] + } + } /** Invalid status value */ - 400: unknown; - }; - }; + 400: unknown + } + } /** Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. */ findPetsByTags: { parameters: { query: { /** Tags to filter by */ - tags: string[]; - }; - }; + tags: string[] + } + } responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Pet"][]; - "application/json": components["schemas"]["Pet"][]; - }; - }; + 'application/xml': components['schemas']['Pet'][] + 'application/json': components['schemas']['Pet'][] + } + } /** Invalid tag value */ - 400: unknown; - }; - }; + 400: unknown + } + } /** Returns a single pet */ getPetById: { parameters: { path: { /** ID of pet to return */ - petId: number; - }; - }; + petId: number + } + } responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Pet"]; - "application/json": components["schemas"]["Pet"]; - }; - }; + 'application/xml': components['schemas']['Pet'] + 'application/json': components['schemas']['Pet'] + } + } /** Invalid ID supplied */ - 400: unknown; + 400: unknown /** Pet not found */ - 404: unknown; - }; - }; + 404: unknown + } + } updatePetWithForm: { parameters: { path: { /** ID of pet that needs to be updated */ - petId: number; - }; - }; + petId: number + } + } responses: { /** Invalid input */ - 405: unknown; - }; + 405: unknown + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Updated name of the pet */ - name?: string; + name?: string /** @description Updated status of the pet */ - status?: string; - }; - }; - }; - }; + status?: string + } + } + } + } deletePet: { parameters: { header: { - api_key?: string; - }; + api_key?: string + } path: { /** Pet id to delete */ - petId: number; - }; - }; + petId: number + } + } responses: { /** Invalid pet value */ - 400: unknown; - }; - }; + 400: unknown + } + } uploadFile: { parameters: { path: { /** ID of pet to update */ - petId: number; - }; - }; + petId: number + } + } responses: { /** successful operation */ 200: { content: { - "application/json": components["schemas"]["ApiResponse"]; - }; - }; - }; + 'application/json': components['schemas']['ApiResponse'] + } + } + } requestBody: { content: { - "multipart/form-data": { + 'multipart/form-data': { /** @description Additional data to pass to server */ - additionalMetadata?: string; + additionalMetadata?: string /** * Format: binary * @description file to upload */ - file?: string; - }; - }; - }; - }; + file?: string + } + } + } + } /** Returns a map of status codes to quantities */ getInventory: { responses: { /** successful operation */ 200: { content: { - "application/json": { [key: string]: number }; - }; - }; - }; - }; + 'application/json': { [key: string]: number } + } + } + } + } placeOrder: { responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Order"]; - "application/json": components["schemas"]["Order"]; - }; - }; + 'application/xml': components['schemas']['Order'] + 'application/json': components['schemas']['Order'] + } + } /** Invalid Order */ - 400: unknown; - }; + 400: unknown + } /** order placed for purchasing the pet */ requestBody: { content: { - "application/json": components["schemas"]["Order"]; - }; - }; - }; + 'application/json': components['schemas']['Order'] + } + } + } /** For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions */ getOrderById: { parameters: { path: { /** ID of pet that needs to be fetched */ - orderId: number; - }; - }; + orderId: number + } + } responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Order"]; - "application/json": components["schemas"]["Order"]; - }; - }; + 'application/xml': components['schemas']['Order'] + 'application/json': components['schemas']['Order'] + } + } /** Invalid ID supplied */ - 400: unknown; + 400: unknown /** Order not found */ - 404: unknown; - }; - }; + 404: unknown + } + } /** For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors */ deleteOrder: { parameters: { path: { /** ID of the order that needs to be deleted */ - orderId: string; - }; - }; + orderId: string + } + } responses: { /** Invalid ID supplied */ - 400: unknown; + 400: unknown /** Order not found */ - 404: unknown; - }; - }; + 404: unknown + } + } /** This can only be done by the logged in user. */ createUser: { responses: { /** successful operation */ - default: unknown; - }; + default: unknown + } /** Created user object */ requestBody: { content: { - "application/json": components["schemas"]["User"]; - }; - }; - }; + 'application/json': components['schemas']['User'] + } + } + } createUsersWithArrayInput: { responses: { /** successful operation */ - default: unknown; - }; - requestBody: components["requestBodies"]["UserArray"]; - }; + default: unknown + } + requestBody: components['requestBodies']['UserArray'] + } createUsersWithListInput: { responses: { /** successful operation */ - default: unknown; - }; - requestBody: components["requestBodies"]["UserArray"]; - }; + default: unknown + } + requestBody: components['requestBodies']['UserArray'] + } loginUser: { parameters: { query: { /** The user name for login */ - username: string; + username: string /** The password for login in clear text */ - password: string; - }; - }; + password: string + } + } responses: { /** successful operation */ 200: { headers: { /** Cookie authentication key for use with the `api_key` apiKey authentication. */ - "Set-Cookie"?: string; + 'Set-Cookie'?: string /** calls per hour allowed by the user */ - "X-Rate-Limit"?: number; + 'X-Rate-Limit'?: number /** date in UTC when toekn expires */ - "X-Expires-After"?: string; - }; + 'X-Expires-After'?: string + } content: { - "application/xml": string; - "application/json": string; - }; - }; + 'application/xml': string + 'application/json': string + } + } /** Invalid username/password supplied */ - 400: unknown; - }; - }; + 400: unknown + } + } logoutUser: { responses: { /** successful operation */ - default: unknown; - }; - }; + default: unknown + } + } getUserByName: { parameters: { path: { /** The name that needs to be fetched. Use user1 for testing. */ - username: string; - }; - }; + username: string + } + } responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["User"]; - "application/json": components["schemas"]["User"]; - }; - }; + 'application/xml': components['schemas']['User'] + 'application/json': components['schemas']['User'] + } + } /** Invalid username supplied */ - 400: unknown; + 400: unknown /** User not found */ - 404: unknown; - }; - }; + 404: unknown + } + } /** This can only be done by the logged in user. */ updateUser: { parameters: { path: { /** name that need to be deleted */ - username: string; - }; - }; + username: string + } + } responses: { /** Invalid user supplied */ - 400: unknown; + 400: unknown /** User not found */ - 404: unknown; - }; + 404: unknown + } /** Updated user object */ requestBody: { content: { - "application/json": components["schemas"]["User"]; - }; - }; - }; + 'application/json': components['schemas']['User'] + } + } + } /** This can only be done by the logged in user. */ deleteUser: { parameters: { path: { /** The name that needs to be deleted */ - username: string; - }; - }; + username: string + } + } responses: { /** Invalid username supplied */ - 400: unknown; + 400: unknown /** User not found */ - 404: unknown; - }; - }; + 404: unknown + } + } } export interface external {} diff --git a/test/v3/expected/petstore.additional.ts b/test/v3/expected/petstore.additional.ts index 4c88dd37c..568cfdf97 100644 --- a/test/v3/expected/petstore.additional.ts +++ b/test/v3/expected/petstore.additional.ts @@ -4,486 +4,486 @@ */ export interface paths { - "/pet": { - put: operations["updatePet"]; - post: operations["addPet"]; - }; - "/pet/findByStatus": { + '/pet': { + put: operations['updatePet'] + post: operations['addPet'] + } + '/pet/findByStatus': { /** Multiple status values can be provided with comma separated strings */ - get: operations["findPetsByStatus"]; - }; - "/pet/findByTags": { + get: operations['findPetsByStatus'] + } + '/pet/findByTags': { /** Muliple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. */ - get: operations["findPetsByTags"]; - }; - "/pet/{petId}": { + get: operations['findPetsByTags'] + } + '/pet/{petId}': { /** Returns a single pet */ - get: operations["getPetById"]; - post: operations["updatePetWithForm"]; - delete: operations["deletePet"]; - }; - "/pet/{petId}/uploadImage": { - post: operations["uploadFile"]; - }; - "/store/inventory": { + get: operations['getPetById'] + post: operations['updatePetWithForm'] + delete: operations['deletePet'] + } + '/pet/{petId}/uploadImage': { + post: operations['uploadFile'] + } + '/store/inventory': { /** Returns a map of status codes to quantities */ - get: operations["getInventory"]; - }; - "/store/order": { - post: operations["placeOrder"]; - }; - "/store/order/{orderId}": { + get: operations['getInventory'] + } + '/store/order': { + post: operations['placeOrder'] + } + '/store/order/{orderId}': { /** For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions */ - get: operations["getOrderById"]; + get: operations['getOrderById'] /** For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors */ - delete: operations["deleteOrder"]; - }; - "/user": { + delete: operations['deleteOrder'] + } + '/user': { /** This can only be done by the logged in user. */ - post: operations["createUser"]; - }; - "/user/createWithArray": { - post: operations["createUsersWithArrayInput"]; - }; - "/user/createWithList": { - post: operations["createUsersWithListInput"]; - }; - "/user/login": { - get: operations["loginUser"]; - }; - "/user/logout": { - get: operations["logoutUser"]; - }; - "/user/{username}": { - get: operations["getUserByName"]; + post: operations['createUser'] + } + '/user/createWithArray': { + post: operations['createUsersWithArrayInput'] + } + '/user/createWithList': { + post: operations['createUsersWithListInput'] + } + '/user/login': { + get: operations['loginUser'] + } + '/user/logout': { + get: operations['logoutUser'] + } + '/user/{username}': { + get: operations['getUserByName'] /** This can only be done by the logged in user. */ - put: operations["updateUser"]; + put: operations['updateUser'] /** This can only be done by the logged in user. */ - delete: operations["deleteUser"]; - }; + delete: operations['deleteUser'] + } } export interface components { schemas: { Order: { /** Format: int64 */ - id?: number; + id?: number /** Format: int64 */ - petId?: number; + petId?: number /** Format: int32 */ - quantity?: number; + quantity?: number /** Format: date-time */ - shipDate?: string; + shipDate?: string /** * @description Order Status * @enum {string} */ - status?: "placed" | "approved" | "delivered"; - complete?: boolean; - } & { [key: string]: unknown }; + status?: 'placed' | 'approved' | 'delivered' + complete?: boolean + } & { [key: string]: unknown } Category: { /** Format: int64 */ - id?: number; - name?: string; - } & { [key: string]: unknown }; + id?: number + name?: string + } & { [key: string]: unknown } User: { /** Format: int64 */ - id?: number; - username?: string; - firstName?: string; - lastName?: string; - email?: string; - password?: string; - phone?: string; + id?: number + username?: string + firstName?: string + lastName?: string + email?: string + password?: string + phone?: string /** * Format: int32 * @description User Status */ - userStatus?: number; - } & { [key: string]: unknown }; + userStatus?: number + } & { [key: string]: unknown } Tag: { /** Format: int64 */ - id?: number; - name?: string; - } & { [key: string]: unknown }; + id?: number + name?: string + } & { [key: string]: unknown } Pet: { /** Format: int64 */ - id?: number; - category?: components["schemas"]["Category"]; + id?: number + category?: components['schemas']['Category'] /** @example doggie */ - name: string; - photoUrls: string[]; - tags?: components["schemas"]["Tag"][]; + name: string + photoUrls: string[] + tags?: components['schemas']['Tag'][] /** * @description pet status in the store * @enum {string} */ - status?: "available" | "pending" | "sold"; - } & { [key: string]: unknown }; + status?: 'available' | 'pending' | 'sold' + } & { [key: string]: unknown } ApiResponse: { /** Format: int32 */ - code?: number; - type?: string; - message?: string; - } & { [key: string]: unknown }; - }; + code?: number + type?: string + message?: string + } & { [key: string]: unknown } + } } export interface operations { updatePet: { responses: { /** Invalid ID supplied */ - 400: unknown; + 400: unknown /** Pet not found */ - 404: unknown; + 404: unknown /** Validation exception */ - 405: unknown; - }; + 405: unknown + } /** Pet object that needs to be added to the store */ requestBody: { content: { - "application/json": components["schemas"]["Pet"]; - "application/xml": components["schemas"]["Pet"]; - }; - }; - }; + 'application/json': components['schemas']['Pet'] + 'application/xml': components['schemas']['Pet'] + } + } + } addPet: { responses: { /** Invalid input */ - 405: unknown; - }; + 405: unknown + } /** Pet object that needs to be added to the store */ requestBody: { content: { - "application/json": components["schemas"]["Pet"]; - "application/xml": components["schemas"]["Pet"]; - }; - }; - }; + 'application/json': components['schemas']['Pet'] + 'application/xml': components['schemas']['Pet'] + } + } + } /** Multiple status values can be provided with comma separated strings */ findPetsByStatus: { parameters: { query: { /** Status values that need to be considered for filter */ - status: ("available" | "pending" | "sold")[]; - }; - }; + status: ('available' | 'pending' | 'sold')[] + } + } responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Pet"][]; - "application/json": components["schemas"]["Pet"][]; - }; - }; + 'application/xml': components['schemas']['Pet'][] + 'application/json': components['schemas']['Pet'][] + } + } /** Invalid status value */ - 400: unknown; - }; - }; + 400: unknown + } + } /** Muliple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. */ findPetsByTags: { parameters: { query: { /** Tags to filter by */ - tags: string[]; - }; - }; + tags: string[] + } + } responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Pet"][]; - "application/json": components["schemas"]["Pet"][]; - }; - }; + 'application/xml': components['schemas']['Pet'][] + 'application/json': components['schemas']['Pet'][] + } + } /** Invalid tag value */ - 400: unknown; - }; - }; + 400: unknown + } + } /** Returns a single pet */ getPetById: { parameters: { path: { /** ID of pet to return */ - petId: number; - }; - }; + petId: number + } + } responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Pet"]; - "application/json": components["schemas"]["Pet"]; - }; - }; + 'application/xml': components['schemas']['Pet'] + 'application/json': components['schemas']['Pet'] + } + } /** Invalid ID supplied */ - 400: unknown; + 400: unknown /** Pet not found */ - 404: unknown; - }; - }; + 404: unknown + } + } updatePetWithForm: { parameters: { path: { /** ID of pet that needs to be updated */ - petId: number; - }; - }; + petId: number + } + } responses: { /** Invalid input */ - 405: unknown; - }; + 405: unknown + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Updated name of the pet */ - name?: string; + name?: string /** @description Updated status of the pet */ - status?: string; - } & { [key: string]: unknown }; - }; - }; - }; + status?: string + } & { [key: string]: unknown } + } + } + } deletePet: { parameters: { header: { - api_key?: string; - }; + api_key?: string + } path: { /** Pet id to delete */ - petId: number; - }; - }; + petId: number + } + } responses: { /** Invalid ID supplied */ - 400: unknown; + 400: unknown /** Pet not found */ - 404: unknown; - }; - }; + 404: unknown + } + } uploadFile: { parameters: { path: { /** ID of pet to update */ - petId: number; - }; - }; + petId: number + } + } responses: { /** successful operation */ 200: { content: { - "application/json": components["schemas"]["ApiResponse"]; - }; - }; - }; + 'application/json': components['schemas']['ApiResponse'] + } + } + } requestBody: { content: { - "multipart/form-data": { + 'multipart/form-data': { /** @description Additional data to pass to server */ - additionalMetadata?: string; + additionalMetadata?: string /** * Format: binary * @description file to upload */ - file?: string; - } & { [key: string]: unknown }; - }; - }; - }; + file?: string + } & { [key: string]: unknown } + } + } + } /** Returns a map of status codes to quantities */ getInventory: { responses: { /** successful operation */ 200: { content: { - "application/json": { [key: string]: number }; - }; - }; - }; - }; + 'application/json': { [key: string]: number } + } + } + } + } placeOrder: { responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Order"]; - "application/json": components["schemas"]["Order"]; - }; - }; + 'application/xml': components['schemas']['Order'] + 'application/json': components['schemas']['Order'] + } + } /** Invalid Order */ - 400: unknown; - }; + 400: unknown + } /** order placed for purchasing the pet */ requestBody: { content: { - "*/*": components["schemas"]["Order"]; - }; - }; - }; + '*/*': components['schemas']['Order'] + } + } + } /** For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions */ getOrderById: { parameters: { path: { /** ID of pet that needs to be fetched */ - orderId: number; - }; - }; + orderId: number + } + } responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Order"]; - "application/json": components["schemas"]["Order"]; - }; - }; + 'application/xml': components['schemas']['Order'] + 'application/json': components['schemas']['Order'] + } + } /** Invalid ID supplied */ - 400: unknown; + 400: unknown /** Order not found */ - 404: unknown; - }; - }; + 404: unknown + } + } /** For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors */ deleteOrder: { parameters: { path: { /** ID of the order that needs to be deleted */ - orderId: number; - }; - }; + orderId: number + } + } responses: { /** Invalid ID supplied */ - 400: unknown; + 400: unknown /** Order not found */ - 404: unknown; - }; - }; + 404: unknown + } + } /** This can only be done by the logged in user. */ createUser: { responses: { /** successful operation */ - default: unknown; - }; + default: unknown + } /** Created user object */ requestBody: { content: { - "*/*": components["schemas"]["User"]; - }; - }; - }; + '*/*': components['schemas']['User'] + } + } + } createUsersWithArrayInput: { responses: { /** successful operation */ - default: unknown; - }; + default: unknown + } /** List of user object */ requestBody: { content: { - "*/*": components["schemas"]["User"][]; - }; - }; - }; + '*/*': components['schemas']['User'][] + } + } + } createUsersWithListInput: { responses: { /** successful operation */ - default: unknown; - }; + default: unknown + } /** List of user object */ requestBody: { content: { - "*/*": components["schemas"]["User"][]; - }; - }; - }; + '*/*': components['schemas']['User'][] + } + } + } loginUser: { parameters: { query: { /** The user name for login */ - username: string; + username: string /** The password for login in clear text */ - password: string; - }; - }; + password: string + } + } responses: { /** successful operation */ 200: { headers: { /** calls per hour allowed by the user */ - "X-Rate-Limit"?: number; + 'X-Rate-Limit'?: number /** date in UTC when token expires */ - "X-Expires-After"?: string; - }; + 'X-Expires-After'?: string + } content: { - "application/xml": string; - "application/json": string; - }; - }; + 'application/xml': string + 'application/json': string + } + } /** Invalid username/password supplied */ - 400: unknown; - }; - }; + 400: unknown + } + } logoutUser: { responses: { /** successful operation */ - default: unknown; - }; - }; + default: unknown + } + } getUserByName: { parameters: { path: { /** The name that needs to be fetched. Use user1 for testing. */ - username: string; - }; - }; + username: string + } + } responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["User"]; - "application/json": components["schemas"]["User"]; - }; - }; + 'application/xml': components['schemas']['User'] + 'application/json': components['schemas']['User'] + } + } /** Invalid username supplied */ - 400: unknown; + 400: unknown /** User not found */ - 404: unknown; - }; - }; + 404: unknown + } + } /** This can only be done by the logged in user. */ updateUser: { parameters: { path: { /** name that need to be updated */ - username: string; - }; - }; + username: string + } + } responses: { /** Invalid user supplied */ - 400: unknown; + 400: unknown /** User not found */ - 404: unknown; - }; + 404: unknown + } /** Updated user object */ requestBody: { content: { - "*/*": components["schemas"]["User"]; - }; - }; - }; + '*/*': components['schemas']['User'] + } + } + } /** This can only be done by the logged in user. */ deleteUser: { parameters: { path: { /** The name that needs to be deleted */ - username: string; - }; - }; + username: string + } + } responses: { /** Invalid username supplied */ - 400: unknown; + 400: unknown /** User not found */ - 404: unknown; - }; - }; + 404: unknown + } + } } export interface external {} diff --git a/test/v3/expected/petstore.exported-type.ts b/test/v3/expected/petstore.exported-type.ts index cec931168..144051c8c 100644 --- a/test/v3/expected/petstore.exported-type.ts +++ b/test/v3/expected/petstore.exported-type.ts @@ -4,486 +4,486 @@ */ export type paths = { - "/pet": { - put: operations["updatePet"]; - post: operations["addPet"]; - }; - "/pet/findByStatus": { + '/pet': { + put: operations['updatePet'] + post: operations['addPet'] + } + '/pet/findByStatus': { /** Multiple status values can be provided with comma separated strings */ - get: operations["findPetsByStatus"]; - }; - "/pet/findByTags": { + get: operations['findPetsByStatus'] + } + '/pet/findByTags': { /** Muliple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. */ - get: operations["findPetsByTags"]; - }; - "/pet/{petId}": { + get: operations['findPetsByTags'] + } + '/pet/{petId}': { /** Returns a single pet */ - get: operations["getPetById"]; - post: operations["updatePetWithForm"]; - delete: operations["deletePet"]; - }; - "/pet/{petId}/uploadImage": { - post: operations["uploadFile"]; - }; - "/store/inventory": { + get: operations['getPetById'] + post: operations['updatePetWithForm'] + delete: operations['deletePet'] + } + '/pet/{petId}/uploadImage': { + post: operations['uploadFile'] + } + '/store/inventory': { /** Returns a map of status codes to quantities */ - get: operations["getInventory"]; - }; - "/store/order": { - post: operations["placeOrder"]; - }; - "/store/order/{orderId}": { + get: operations['getInventory'] + } + '/store/order': { + post: operations['placeOrder'] + } + '/store/order/{orderId}': { /** For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions */ - get: operations["getOrderById"]; + get: operations['getOrderById'] /** For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors */ - delete: operations["deleteOrder"]; - }; - "/user": { + delete: operations['deleteOrder'] + } + '/user': { /** This can only be done by the logged in user. */ - post: operations["createUser"]; - }; - "/user/createWithArray": { - post: operations["createUsersWithArrayInput"]; - }; - "/user/createWithList": { - post: operations["createUsersWithListInput"]; - }; - "/user/login": { - get: operations["loginUser"]; - }; - "/user/logout": { - get: operations["logoutUser"]; - }; - "/user/{username}": { - get: operations["getUserByName"]; + post: operations['createUser'] + } + '/user/createWithArray': { + post: operations['createUsersWithArrayInput'] + } + '/user/createWithList': { + post: operations['createUsersWithListInput'] + } + '/user/login': { + get: operations['loginUser'] + } + '/user/logout': { + get: operations['logoutUser'] + } + '/user/{username}': { + get: operations['getUserByName'] /** This can only be done by the logged in user. */ - put: operations["updateUser"]; + put: operations['updateUser'] /** This can only be done by the logged in user. */ - delete: operations["deleteUser"]; - }; -}; + delete: operations['deleteUser'] + } +} export type components = { schemas: { Order: { /** Format: int64 */ - id?: number; + id?: number /** Format: int64 */ - petId?: number; + petId?: number /** Format: int32 */ - quantity?: number; + quantity?: number /** Format: date-time */ - shipDate?: string; + shipDate?: string /** * @description Order Status * @enum {string} */ - status?: "placed" | "approved" | "delivered"; - complete?: boolean; - }; + status?: 'placed' | 'approved' | 'delivered' + complete?: boolean + } Category: { /** Format: int64 */ - id?: number; - name?: string; - }; + id?: number + name?: string + } User: { /** Format: int64 */ - id?: number; - username?: string; - firstName?: string; - lastName?: string; - email?: string; - password?: string; - phone?: string; + id?: number + username?: string + firstName?: string + lastName?: string + email?: string + password?: string + phone?: string /** * Format: int32 * @description User Status */ - userStatus?: number; - }; + userStatus?: number + } Tag: { /** Format: int64 */ - id?: number; - name?: string; - }; + id?: number + name?: string + } Pet: { /** Format: int64 */ - id?: number; - category?: components["schemas"]["Category"]; + id?: number + category?: components['schemas']['Category'] /** @example doggie */ - name: string; - photoUrls: string[]; - tags?: components["schemas"]["Tag"][]; + name: string + photoUrls: string[] + tags?: components['schemas']['Tag'][] /** * @description pet status in the store * @enum {string} */ - status?: "available" | "pending" | "sold"; - }; + status?: 'available' | 'pending' | 'sold' + } ApiResponse: { /** Format: int32 */ - code?: number; - type?: string; - message?: string; - }; - }; -}; + code?: number + type?: string + message?: string + } + } +} export type operations = { updatePet: { responses: { /** Invalid ID supplied */ - 400: unknown; + 400: unknown /** Pet not found */ - 404: unknown; + 404: unknown /** Validation exception */ - 405: unknown; - }; + 405: unknown + } /** Pet object that needs to be added to the store */ requestBody: { content: { - "application/json": components["schemas"]["Pet"]; - "application/xml": components["schemas"]["Pet"]; - }; - }; - }; + 'application/json': components['schemas']['Pet'] + 'application/xml': components['schemas']['Pet'] + } + } + } addPet: { responses: { /** Invalid input */ - 405: unknown; - }; + 405: unknown + } /** Pet object that needs to be added to the store */ requestBody: { content: { - "application/json": components["schemas"]["Pet"]; - "application/xml": components["schemas"]["Pet"]; - }; - }; - }; + 'application/json': components['schemas']['Pet'] + 'application/xml': components['schemas']['Pet'] + } + } + } /** Multiple status values can be provided with comma separated strings */ findPetsByStatus: { parameters: { query: { /** Status values that need to be considered for filter */ - status: ("available" | "pending" | "sold")[]; - }; - }; + status: ('available' | 'pending' | 'sold')[] + } + } responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Pet"][]; - "application/json": components["schemas"]["Pet"][]; - }; - }; + 'application/xml': components['schemas']['Pet'][] + 'application/json': components['schemas']['Pet'][] + } + } /** Invalid status value */ - 400: unknown; - }; - }; + 400: unknown + } + } /** Muliple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. */ findPetsByTags: { parameters: { query: { /** Tags to filter by */ - tags: string[]; - }; - }; + tags: string[] + } + } responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Pet"][]; - "application/json": components["schemas"]["Pet"][]; - }; - }; + 'application/xml': components['schemas']['Pet'][] + 'application/json': components['schemas']['Pet'][] + } + } /** Invalid tag value */ - 400: unknown; - }; - }; + 400: unknown + } + } /** Returns a single pet */ getPetById: { parameters: { path: { /** ID of pet to return */ - petId: number; - }; - }; + petId: number + } + } responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Pet"]; - "application/json": components["schemas"]["Pet"]; - }; - }; + 'application/xml': components['schemas']['Pet'] + 'application/json': components['schemas']['Pet'] + } + } /** Invalid ID supplied */ - 400: unknown; + 400: unknown /** Pet not found */ - 404: unknown; - }; - }; + 404: unknown + } + } updatePetWithForm: { parameters: { path: { /** ID of pet that needs to be updated */ - petId: number; - }; - }; + petId: number + } + } responses: { /** Invalid input */ - 405: unknown; - }; + 405: unknown + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Updated name of the pet */ - name?: string; + name?: string /** @description Updated status of the pet */ - status?: string; - }; - }; - }; - }; + status?: string + } + } + } + } deletePet: { parameters: { header: { - api_key?: string; - }; + api_key?: string + } path: { /** Pet id to delete */ - petId: number; - }; - }; + petId: number + } + } responses: { /** Invalid ID supplied */ - 400: unknown; + 400: unknown /** Pet not found */ - 404: unknown; - }; - }; + 404: unknown + } + } uploadFile: { parameters: { path: { /** ID of pet to update */ - petId: number; - }; - }; + petId: number + } + } responses: { /** successful operation */ 200: { content: { - "application/json": components["schemas"]["ApiResponse"]; - }; - }; - }; + 'application/json': components['schemas']['ApiResponse'] + } + } + } requestBody: { content: { - "multipart/form-data": { + 'multipart/form-data': { /** @description Additional data to pass to server */ - additionalMetadata?: string; + additionalMetadata?: string /** * Format: binary * @description file to upload */ - file?: string; - }; - }; - }; - }; + file?: string + } + } + } + } /** Returns a map of status codes to quantities */ getInventory: { responses: { /** successful operation */ 200: { content: { - "application/json": { [key: string]: number }; - }; - }; - }; - }; + 'application/json': { [key: string]: number } + } + } + } + } placeOrder: { responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Order"]; - "application/json": components["schemas"]["Order"]; - }; - }; + 'application/xml': components['schemas']['Order'] + 'application/json': components['schemas']['Order'] + } + } /** Invalid Order */ - 400: unknown; - }; + 400: unknown + } /** order placed for purchasing the pet */ requestBody: { content: { - "*/*": components["schemas"]["Order"]; - }; - }; - }; + '*/*': components['schemas']['Order'] + } + } + } /** For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions */ getOrderById: { parameters: { path: { /** ID of pet that needs to be fetched */ - orderId: number; - }; - }; + orderId: number + } + } responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Order"]; - "application/json": components["schemas"]["Order"]; - }; - }; + 'application/xml': components['schemas']['Order'] + 'application/json': components['schemas']['Order'] + } + } /** Invalid ID supplied */ - 400: unknown; + 400: unknown /** Order not found */ - 404: unknown; - }; - }; + 404: unknown + } + } /** For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors */ deleteOrder: { parameters: { path: { /** ID of the order that needs to be deleted */ - orderId: number; - }; - }; + orderId: number + } + } responses: { /** Invalid ID supplied */ - 400: unknown; + 400: unknown /** Order not found */ - 404: unknown; - }; - }; + 404: unknown + } + } /** This can only be done by the logged in user. */ createUser: { responses: { /** successful operation */ - default: unknown; - }; + default: unknown + } /** Created user object */ requestBody: { content: { - "*/*": components["schemas"]["User"]; - }; - }; - }; + '*/*': components['schemas']['User'] + } + } + } createUsersWithArrayInput: { responses: { /** successful operation */ - default: unknown; - }; + default: unknown + } /** List of user object */ requestBody: { content: { - "*/*": components["schemas"]["User"][]; - }; - }; - }; + '*/*': components['schemas']['User'][] + } + } + } createUsersWithListInput: { responses: { /** successful operation */ - default: unknown; - }; + default: unknown + } /** List of user object */ requestBody: { content: { - "*/*": components["schemas"]["User"][]; - }; - }; - }; + '*/*': components['schemas']['User'][] + } + } + } loginUser: { parameters: { query: { /** The user name for login */ - username: string; + username: string /** The password for login in clear text */ - password: string; - }; - }; + password: string + } + } responses: { /** successful operation */ 200: { headers: { /** calls per hour allowed by the user */ - "X-Rate-Limit"?: number; + 'X-Rate-Limit'?: number /** date in UTC when token expires */ - "X-Expires-After"?: string; - }; + 'X-Expires-After'?: string + } content: { - "application/xml": string; - "application/json": string; - }; - }; + 'application/xml': string + 'application/json': string + } + } /** Invalid username/password supplied */ - 400: unknown; - }; - }; + 400: unknown + } + } logoutUser: { responses: { /** successful operation */ - default: unknown; - }; - }; + default: unknown + } + } getUserByName: { parameters: { path: { /** The name that needs to be fetched. Use user1 for testing. */ - username: string; - }; - }; + username: string + } + } responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["User"]; - "application/json": components["schemas"]["User"]; - }; - }; + 'application/xml': components['schemas']['User'] + 'application/json': components['schemas']['User'] + } + } /** Invalid username supplied */ - 400: unknown; + 400: unknown /** User not found */ - 404: unknown; - }; - }; + 404: unknown + } + } /** This can only be done by the logged in user. */ updateUser: { parameters: { path: { /** name that need to be updated */ - username: string; - }; - }; + username: string + } + } responses: { /** Invalid user supplied */ - 400: unknown; + 400: unknown /** User not found */ - 404: unknown; - }; + 404: unknown + } /** Updated user object */ requestBody: { content: { - "*/*": components["schemas"]["User"]; - }; - }; - }; + '*/*': components['schemas']['User'] + } + } + } /** This can only be done by the logged in user. */ deleteUser: { parameters: { path: { /** The name that needs to be deleted */ - username: string; - }; - }; + username: string + } + } responses: { /** Invalid username supplied */ - 400: unknown; + 400: unknown /** User not found */ - 404: unknown; - }; - }; -}; + 404: unknown + } + } +} -export type external = {}; +export type external = {} diff --git a/test/v3/expected/petstore.immutable.ts b/test/v3/expected/petstore.immutable.ts index 71eda2cc3..d495878be 100644 --- a/test/v3/expected/petstore.immutable.ts +++ b/test/v3/expected/petstore.immutable.ts @@ -4,486 +4,486 @@ */ export interface paths { - readonly "/pet": { - readonly put: operations["updatePet"]; - readonly post: operations["addPet"]; - }; - readonly "/pet/findByStatus": { + readonly '/pet': { + readonly put: operations['updatePet'] + readonly post: operations['addPet'] + } + readonly '/pet/findByStatus': { /** Multiple status values can be provided with comma separated strings */ - readonly get: operations["findPetsByStatus"]; - }; - readonly "/pet/findByTags": { + readonly get: operations['findPetsByStatus'] + } + readonly '/pet/findByTags': { /** Muliple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. */ - readonly get: operations["findPetsByTags"]; - }; - readonly "/pet/{petId}": { + readonly get: operations['findPetsByTags'] + } + readonly '/pet/{petId}': { /** Returns a single pet */ - readonly get: operations["getPetById"]; - readonly post: operations["updatePetWithForm"]; - readonly delete: operations["deletePet"]; - }; - readonly "/pet/{petId}/uploadImage": { - readonly post: operations["uploadFile"]; - }; - readonly "/store/inventory": { + readonly get: operations['getPetById'] + readonly post: operations['updatePetWithForm'] + readonly delete: operations['deletePet'] + } + readonly '/pet/{petId}/uploadImage': { + readonly post: operations['uploadFile'] + } + readonly '/store/inventory': { /** Returns a map of status codes to quantities */ - readonly get: operations["getInventory"]; - }; - readonly "/store/order": { - readonly post: operations["placeOrder"]; - }; - readonly "/store/order/{orderId}": { + readonly get: operations['getInventory'] + } + readonly '/store/order': { + readonly post: operations['placeOrder'] + } + readonly '/store/order/{orderId}': { /** For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions */ - readonly get: operations["getOrderById"]; + readonly get: operations['getOrderById'] /** For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors */ - readonly delete: operations["deleteOrder"]; - }; - readonly "/user": { + readonly delete: operations['deleteOrder'] + } + readonly '/user': { /** This can only be done by the logged in user. */ - readonly post: operations["createUser"]; - }; - readonly "/user/createWithArray": { - readonly post: operations["createUsersWithArrayInput"]; - }; - readonly "/user/createWithList": { - readonly post: operations["createUsersWithListInput"]; - }; - readonly "/user/login": { - readonly get: operations["loginUser"]; - }; - readonly "/user/logout": { - readonly get: operations["logoutUser"]; - }; - readonly "/user/{username}": { - readonly get: operations["getUserByName"]; + readonly post: operations['createUser'] + } + readonly '/user/createWithArray': { + readonly post: operations['createUsersWithArrayInput'] + } + readonly '/user/createWithList': { + readonly post: operations['createUsersWithListInput'] + } + readonly '/user/login': { + readonly get: operations['loginUser'] + } + readonly '/user/logout': { + readonly get: operations['logoutUser'] + } + readonly '/user/{username}': { + readonly get: operations['getUserByName'] /** This can only be done by the logged in user. */ - readonly put: operations["updateUser"]; + readonly put: operations['updateUser'] /** This can only be done by the logged in user. */ - readonly delete: operations["deleteUser"]; - }; + readonly delete: operations['deleteUser'] + } } export interface components { readonly schemas: { readonly Order: { /** Format: int64 */ - readonly id?: number; + readonly id?: number /** Format: int64 */ - readonly petId?: number; + readonly petId?: number /** Format: int32 */ - readonly quantity?: number; + readonly quantity?: number /** Format: date-time */ - readonly shipDate?: string; + readonly shipDate?: string /** * @description Order Status * @enum {string} */ - readonly status?: "placed" | "approved" | "delivered"; - readonly complete?: boolean; - }; + readonly status?: 'placed' | 'approved' | 'delivered' + readonly complete?: boolean + } readonly Category: { /** Format: int64 */ - readonly id?: number; - readonly name?: string; - }; + readonly id?: number + readonly name?: string + } readonly User: { /** Format: int64 */ - readonly id?: number; - readonly username?: string; - readonly firstName?: string; - readonly lastName?: string; - readonly email?: string; - readonly password?: string; - readonly phone?: string; + readonly id?: number + readonly username?: string + readonly firstName?: string + readonly lastName?: string + readonly email?: string + readonly password?: string + readonly phone?: string /** * Format: int32 * @description User Status */ - readonly userStatus?: number; - }; + readonly userStatus?: number + } readonly Tag: { /** Format: int64 */ - readonly id?: number; - readonly name?: string; - }; + readonly id?: number + readonly name?: string + } readonly Pet: { /** Format: int64 */ - readonly id?: number; - readonly category?: components["schemas"]["Category"]; + readonly id?: number + readonly category?: components['schemas']['Category'] /** @example doggie */ - readonly name: string; - readonly photoUrls: readonly string[]; - readonly tags?: readonly components["schemas"]["Tag"][]; + readonly name: string + readonly photoUrls: readonly string[] + readonly tags?: readonly components['schemas']['Tag'][] /** * @description pet status in the store * @enum {string} */ - readonly status?: "available" | "pending" | "sold"; - }; + readonly status?: 'available' | 'pending' | 'sold' + } readonly ApiResponse: { /** Format: int32 */ - readonly code?: number; - readonly type?: string; - readonly message?: string; - }; - }; + readonly code?: number + readonly type?: string + readonly message?: string + } + } } export interface operations { readonly updatePet: { readonly responses: { /** Invalid ID supplied */ - readonly 400: unknown; + readonly 400: unknown /** Pet not found */ - readonly 404: unknown; + readonly 404: unknown /** Validation exception */ - readonly 405: unknown; - }; + readonly 405: unknown + } /** Pet object that needs to be added to the store */ readonly requestBody: { readonly content: { - readonly "application/json": components["schemas"]["Pet"]; - readonly "application/xml": components["schemas"]["Pet"]; - }; - }; - }; + readonly 'application/json': components['schemas']['Pet'] + readonly 'application/xml': components['schemas']['Pet'] + } + } + } readonly addPet: { readonly responses: { /** Invalid input */ - readonly 405: unknown; - }; + readonly 405: unknown + } /** Pet object that needs to be added to the store */ readonly requestBody: { readonly content: { - readonly "application/json": components["schemas"]["Pet"]; - readonly "application/xml": components["schemas"]["Pet"]; - }; - }; - }; + readonly 'application/json': components['schemas']['Pet'] + readonly 'application/xml': components['schemas']['Pet'] + } + } + } /** Multiple status values can be provided with comma separated strings */ readonly findPetsByStatus: { readonly parameters: { readonly query: { /** Status values that need to be considered for filter */ - readonly status: readonly ("available" | "pending" | "sold")[]; - }; - }; + readonly status: readonly ('available' | 'pending' | 'sold')[] + } + } readonly responses: { /** successful operation */ readonly 200: { readonly content: { - readonly "application/xml": readonly components["schemas"]["Pet"][]; - readonly "application/json": readonly components["schemas"]["Pet"][]; - }; - }; + readonly 'application/xml': readonly components['schemas']['Pet'][] + readonly 'application/json': readonly components['schemas']['Pet'][] + } + } /** Invalid status value */ - readonly 400: unknown; - }; - }; + readonly 400: unknown + } + } /** Muliple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. */ readonly findPetsByTags: { readonly parameters: { readonly query: { /** Tags to filter by */ - readonly tags: readonly string[]; - }; - }; + readonly tags: readonly string[] + } + } readonly responses: { /** successful operation */ readonly 200: { readonly content: { - readonly "application/xml": readonly components["schemas"]["Pet"][]; - readonly "application/json": readonly components["schemas"]["Pet"][]; - }; - }; + readonly 'application/xml': readonly components['schemas']['Pet'][] + readonly 'application/json': readonly components['schemas']['Pet'][] + } + } /** Invalid tag value */ - readonly 400: unknown; - }; - }; + readonly 400: unknown + } + } /** Returns a single pet */ readonly getPetById: { readonly parameters: { readonly path: { /** ID of pet to return */ - readonly petId: number; - }; - }; + readonly petId: number + } + } readonly responses: { /** successful operation */ readonly 200: { readonly content: { - readonly "application/xml": components["schemas"]["Pet"]; - readonly "application/json": components["schemas"]["Pet"]; - }; - }; + readonly 'application/xml': components['schemas']['Pet'] + readonly 'application/json': components['schemas']['Pet'] + } + } /** Invalid ID supplied */ - readonly 400: unknown; + readonly 400: unknown /** Pet not found */ - readonly 404: unknown; - }; - }; + readonly 404: unknown + } + } readonly updatePetWithForm: { readonly parameters: { readonly path: { /** ID of pet that needs to be updated */ - readonly petId: number; - }; - }; + readonly petId: number + } + } readonly responses: { /** Invalid input */ - readonly 405: unknown; - }; + readonly 405: unknown + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Updated name of the pet */ - readonly name?: string; + readonly name?: string /** @description Updated status of the pet */ - readonly status?: string; - }; - }; - }; - }; + readonly status?: string + } + } + } + } readonly deletePet: { readonly parameters: { readonly header: { - readonly api_key?: string; - }; + readonly api_key?: string + } readonly path: { /** Pet id to delete */ - readonly petId: number; - }; - }; + readonly petId: number + } + } readonly responses: { /** Invalid ID supplied */ - readonly 400: unknown; + readonly 400: unknown /** Pet not found */ - readonly 404: unknown; - }; - }; + readonly 404: unknown + } + } readonly uploadFile: { readonly parameters: { readonly path: { /** ID of pet to update */ - readonly petId: number; - }; - }; + readonly petId: number + } + } readonly responses: { /** successful operation */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["ApiResponse"]; - }; - }; - }; + readonly 'application/json': components['schemas']['ApiResponse'] + } + } + } readonly requestBody: { readonly content: { - readonly "multipart/form-data": { + readonly 'multipart/form-data': { /** @description Additional data to pass to server */ - readonly additionalMetadata?: string; + readonly additionalMetadata?: string /** * Format: binary * @description file to upload */ - readonly file?: string; - }; - }; - }; - }; + readonly file?: string + } + } + } + } /** Returns a map of status codes to quantities */ readonly getInventory: { readonly responses: { /** successful operation */ readonly 200: { readonly content: { - readonly "application/json": { readonly [key: string]: number }; - }; - }; - }; - }; + readonly 'application/json': { readonly [key: string]: number } + } + } + } + } readonly placeOrder: { readonly responses: { /** successful operation */ readonly 200: { readonly content: { - readonly "application/xml": components["schemas"]["Order"]; - readonly "application/json": components["schemas"]["Order"]; - }; - }; + readonly 'application/xml': components['schemas']['Order'] + readonly 'application/json': components['schemas']['Order'] + } + } /** Invalid Order */ - readonly 400: unknown; - }; + readonly 400: unknown + } /** order placed for purchasing the pet */ readonly requestBody: { readonly content: { - readonly "*/*": components["schemas"]["Order"]; - }; - }; - }; + readonly '*/*': components['schemas']['Order'] + } + } + } /** For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions */ readonly getOrderById: { readonly parameters: { readonly path: { /** ID of pet that needs to be fetched */ - readonly orderId: number; - }; - }; + readonly orderId: number + } + } readonly responses: { /** successful operation */ readonly 200: { readonly content: { - readonly "application/xml": components["schemas"]["Order"]; - readonly "application/json": components["schemas"]["Order"]; - }; - }; + readonly 'application/xml': components['schemas']['Order'] + readonly 'application/json': components['schemas']['Order'] + } + } /** Invalid ID supplied */ - readonly 400: unknown; + readonly 400: unknown /** Order not found */ - readonly 404: unknown; - }; - }; + readonly 404: unknown + } + } /** For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors */ readonly deleteOrder: { readonly parameters: { readonly path: { /** ID of the order that needs to be deleted */ - readonly orderId: number; - }; - }; + readonly orderId: number + } + } readonly responses: { /** Invalid ID supplied */ - readonly 400: unknown; + readonly 400: unknown /** Order not found */ - readonly 404: unknown; - }; - }; + readonly 404: unknown + } + } /** This can only be done by the logged in user. */ readonly createUser: { readonly responses: { /** successful operation */ - readonly default: unknown; - }; + readonly default: unknown + } /** Created user object */ readonly requestBody: { readonly content: { - readonly "*/*": components["schemas"]["User"]; - }; - }; - }; + readonly '*/*': components['schemas']['User'] + } + } + } readonly createUsersWithArrayInput: { readonly responses: { /** successful operation */ - readonly default: unknown; - }; + readonly default: unknown + } /** List of user object */ readonly requestBody: { readonly content: { - readonly "*/*": readonly components["schemas"]["User"][]; - }; - }; - }; + readonly '*/*': readonly components['schemas']['User'][] + } + } + } readonly createUsersWithListInput: { readonly responses: { /** successful operation */ - readonly default: unknown; - }; + readonly default: unknown + } /** List of user object */ readonly requestBody: { readonly content: { - readonly "*/*": readonly components["schemas"]["User"][]; - }; - }; - }; + readonly '*/*': readonly components['schemas']['User'][] + } + } + } readonly loginUser: { readonly parameters: { readonly query: { /** The user name for login */ - readonly username: string; + readonly username: string /** The password for login in clear text */ - readonly password: string; - }; - }; + readonly password: string + } + } readonly responses: { /** successful operation */ readonly 200: { readonly headers: { /** calls per hour allowed by the user */ - readonly "X-Rate-Limit"?: number; + readonly 'X-Rate-Limit'?: number /** date in UTC when token expires */ - readonly "X-Expires-After"?: string; - }; + readonly 'X-Expires-After'?: string + } readonly content: { - readonly "application/xml": string; - readonly "application/json": string; - }; - }; + readonly 'application/xml': string + readonly 'application/json': string + } + } /** Invalid username/password supplied */ - readonly 400: unknown; - }; - }; + readonly 400: unknown + } + } readonly logoutUser: { readonly responses: { /** successful operation */ - readonly default: unknown; - }; - }; + readonly default: unknown + } + } readonly getUserByName: { readonly parameters: { readonly path: { /** The name that needs to be fetched. Use user1 for testing. */ - readonly username: string; - }; - }; + readonly username: string + } + } readonly responses: { /** successful operation */ readonly 200: { readonly content: { - readonly "application/xml": components["schemas"]["User"]; - readonly "application/json": components["schemas"]["User"]; - }; - }; + readonly 'application/xml': components['schemas']['User'] + readonly 'application/json': components['schemas']['User'] + } + } /** Invalid username supplied */ - readonly 400: unknown; + readonly 400: unknown /** User not found */ - readonly 404: unknown; - }; - }; + readonly 404: unknown + } + } /** This can only be done by the logged in user. */ readonly updateUser: { readonly parameters: { readonly path: { /** name that need to be updated */ - readonly username: string; - }; - }; + readonly username: string + } + } readonly responses: { /** Invalid user supplied */ - readonly 400: unknown; + readonly 400: unknown /** User not found */ - readonly 404: unknown; - }; + readonly 404: unknown + } /** Updated user object */ readonly requestBody: { readonly content: { - readonly "*/*": components["schemas"]["User"]; - }; - }; - }; + readonly '*/*': components['schemas']['User'] + } + } + } /** This can only be done by the logged in user. */ readonly deleteUser: { readonly parameters: { readonly path: { /** The name that needs to be deleted */ - readonly username: string; - }; - }; + readonly username: string + } + } readonly responses: { /** Invalid username supplied */ - readonly 400: unknown; + readonly 400: unknown /** User not found */ - readonly 404: unknown; - }; - }; + readonly 404: unknown + } + } } export interface external {} diff --git a/test/v3/expected/petstore.support-array-length.ts b/test/v3/expected/petstore.support-array-length.ts index 9199645c1..733c95a71 100644 --- a/test/v3/expected/petstore.support-array-length.ts +++ b/test/v3/expected/petstore.support-array-length.ts @@ -4,486 +4,486 @@ */ export interface paths { - "/pet": { - put: operations["updatePet"]; - post: operations["addPet"]; - }; - "/pet/findByStatus": { + '/pet': { + put: operations['updatePet'] + post: operations['addPet'] + } + '/pet/findByStatus': { /** Multiple status values can be provided with comma separated strings */ - get: operations["findPetsByStatus"]; - }; - "/pet/findByTags": { + get: operations['findPetsByStatus'] + } + '/pet/findByTags': { /** Muliple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. */ - get: operations["findPetsByTags"]; - }; - "/pet/{petId}": { + get: operations['findPetsByTags'] + } + '/pet/{petId}': { /** Returns a single pet */ - get: operations["getPetById"]; - post: operations["updatePetWithForm"]; - delete: operations["deletePet"]; - }; - "/pet/{petId}/uploadImage": { - post: operations["uploadFile"]; - }; - "/store/inventory": { + get: operations['getPetById'] + post: operations['updatePetWithForm'] + delete: operations['deletePet'] + } + '/pet/{petId}/uploadImage': { + post: operations['uploadFile'] + } + '/store/inventory': { /** Returns a map of status codes to quantities */ - get: operations["getInventory"]; - }; - "/store/order": { - post: operations["placeOrder"]; - }; - "/store/order/{orderId}": { + get: operations['getInventory'] + } + '/store/order': { + post: operations['placeOrder'] + } + '/store/order/{orderId}': { /** For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions */ - get: operations["getOrderById"]; + get: operations['getOrderById'] /** For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors */ - delete: operations["deleteOrder"]; - }; - "/user": { + delete: operations['deleteOrder'] + } + '/user': { /** This can only be done by the logged in user. */ - post: operations["createUser"]; - }; - "/user/createWithArray": { - post: operations["createUsersWithArrayInput"]; - }; - "/user/createWithList": { - post: operations["createUsersWithListInput"]; - }; - "/user/login": { - get: operations["loginUser"]; - }; - "/user/logout": { - get: operations["logoutUser"]; - }; - "/user/{username}": { - get: operations["getUserByName"]; + post: operations['createUser'] + } + '/user/createWithArray': { + post: operations['createUsersWithArrayInput'] + } + '/user/createWithList': { + post: operations['createUsersWithListInput'] + } + '/user/login': { + get: operations['loginUser'] + } + '/user/logout': { + get: operations['logoutUser'] + } + '/user/{username}': { + get: operations['getUserByName'] /** This can only be done by the logged in user. */ - put: operations["updateUser"]; + put: operations['updateUser'] /** This can only be done by the logged in user. */ - delete: operations["deleteUser"]; - }; + delete: operations['deleteUser'] + } } export interface components { schemas: { Order: { /** Format: int64 */ - id?: number; + id?: number /** Format: int64 */ - petId?: number; + petId?: number /** Format: int32 */ - quantity?: number; + quantity?: number /** Format: date-time */ - shipDate?: string; + shipDate?: string /** * @description Order Status * @enum {string} */ - status?: "placed" | "approved" | "delivered"; - complete?: boolean; - }; + status?: 'placed' | 'approved' | 'delivered' + complete?: boolean + } Category: { /** Format: int64 */ - id?: number; - name?: string; - }; + id?: number + name?: string + } User: { /** Format: int64 */ - id?: number; - username?: string; - firstName?: string; - lastName?: string; - email?: string; - password?: string; - phone?: string; + id?: number + username?: string + firstName?: string + lastName?: string + email?: string + password?: string + phone?: string /** * Format: int32 * @description User Status */ - userStatus?: number; - }; + userStatus?: number + } Tag: { /** Format: int64 */ - id?: number; - name?: string; - }; + id?: number + name?: string + } Pet: { /** Format: int64 */ - id?: number; - category?: components["schemas"]["Category"]; + id?: number + category?: components['schemas']['Category'] /** @example doggie */ - name: string; - photoUrls: string[]; - tags?: components["schemas"]["Tag"][]; + name: string + photoUrls: string[] + tags?: components['schemas']['Tag'][] /** * @description pet status in the store * @enum {string} */ - status?: "available" | "pending" | "sold"; - }; + status?: 'available' | 'pending' | 'sold' + } ApiResponse: { /** Format: int32 */ - code?: number; - type?: string; - message?: string; - }; - }; + code?: number + type?: string + message?: string + } + } } export interface operations { updatePet: { responses: { /** Invalid ID supplied */ - 400: unknown; + 400: unknown /** Pet not found */ - 404: unknown; + 404: unknown /** Validation exception */ - 405: unknown; - }; + 405: unknown + } /** Pet object that needs to be added to the store */ requestBody: { content: { - "application/json": components["schemas"]["Pet"]; - "application/xml": components["schemas"]["Pet"]; - }; - }; - }; + 'application/json': components['schemas']['Pet'] + 'application/xml': components['schemas']['Pet'] + } + } + } addPet: { responses: { /** Invalid input */ - 405: unknown; - }; + 405: unknown + } /** Pet object that needs to be added to the store */ requestBody: { content: { - "application/json": components["schemas"]["Pet"]; - "application/xml": components["schemas"]["Pet"]; - }; - }; - }; + 'application/json': components['schemas']['Pet'] + 'application/xml': components['schemas']['Pet'] + } + } + } /** Multiple status values can be provided with comma separated strings */ findPetsByStatus: { parameters: { query: { /** Status values that need to be considered for filter */ - status: ("available" | "pending" | "sold")[]; - }; - }; + status: ('available' | 'pending' | 'sold')[] + } + } responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Pet"][]; - "application/json": components["schemas"]["Pet"][]; - }; - }; + 'application/xml': components['schemas']['Pet'][] + 'application/json': components['schemas']['Pet'][] + } + } /** Invalid status value */ - 400: unknown; - }; - }; + 400: unknown + } + } /** Muliple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. */ findPetsByTags: { parameters: { query: { /** Tags to filter by */ - tags: string[]; - }; - }; + tags: string[] + } + } responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Pet"][]; - "application/json": components["schemas"]["Pet"][]; - }; - }; + 'application/xml': components['schemas']['Pet'][] + 'application/json': components['schemas']['Pet'][] + } + } /** Invalid tag value */ - 400: unknown; - }; - }; + 400: unknown + } + } /** Returns a single pet */ getPetById: { parameters: { path: { /** ID of pet to return */ - petId: number; - }; - }; + petId: number + } + } responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Pet"]; - "application/json": components["schemas"]["Pet"]; - }; - }; + 'application/xml': components['schemas']['Pet'] + 'application/json': components['schemas']['Pet'] + } + } /** Invalid ID supplied */ - 400: unknown; + 400: unknown /** Pet not found */ - 404: unknown; - }; - }; + 404: unknown + } + } updatePetWithForm: { parameters: { path: { /** ID of pet that needs to be updated */ - petId: number; - }; - }; + petId: number + } + } responses: { /** Invalid input */ - 405: unknown; - }; + 405: unknown + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Updated name of the pet */ - name?: string; + name?: string /** @description Updated status of the pet */ - status?: string; - }; - }; - }; - }; + status?: string + } + } + } + } deletePet: { parameters: { header: { - api_key?: string; - }; + api_key?: string + } path: { /** Pet id to delete */ - petId: number; - }; - }; + petId: number + } + } responses: { /** Invalid ID supplied */ - 400: unknown; + 400: unknown /** Pet not found */ - 404: unknown; - }; - }; + 404: unknown + } + } uploadFile: { parameters: { path: { /** ID of pet to update */ - petId: number; - }; - }; + petId: number + } + } responses: { /** successful operation */ 200: { content: { - "application/json": components["schemas"]["ApiResponse"]; - }; - }; - }; + 'application/json': components['schemas']['ApiResponse'] + } + } + } requestBody: { content: { - "multipart/form-data": { + 'multipart/form-data': { /** @description Additional data to pass to server */ - additionalMetadata?: string; + additionalMetadata?: string /** * Format: binary * @description file to upload */ - file?: string; - }; - }; - }; - }; + file?: string + } + } + } + } /** Returns a map of status codes to quantities */ getInventory: { responses: { /** successful operation */ 200: { content: { - "application/json": { [key: string]: number }; - }; - }; - }; - }; + 'application/json': { [key: string]: number } + } + } + } + } placeOrder: { responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Order"]; - "application/json": components["schemas"]["Order"]; - }; - }; + 'application/xml': components['schemas']['Order'] + 'application/json': components['schemas']['Order'] + } + } /** Invalid Order */ - 400: unknown; - }; + 400: unknown + } /** order placed for purchasing the pet */ requestBody: { content: { - "*/*": components["schemas"]["Order"]; - }; - }; - }; + '*/*': components['schemas']['Order'] + } + } + } /** For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions */ getOrderById: { parameters: { path: { /** ID of pet that needs to be fetched */ - orderId: number; - }; - }; + orderId: number + } + } responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Order"]; - "application/json": components["schemas"]["Order"]; - }; - }; + 'application/xml': components['schemas']['Order'] + 'application/json': components['schemas']['Order'] + } + } /** Invalid ID supplied */ - 400: unknown; + 400: unknown /** Order not found */ - 404: unknown; - }; - }; + 404: unknown + } + } /** For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors */ deleteOrder: { parameters: { path: { /** ID of the order that needs to be deleted */ - orderId: number; - }; - }; + orderId: number + } + } responses: { /** Invalid ID supplied */ - 400: unknown; + 400: unknown /** Order not found */ - 404: unknown; - }; - }; + 404: unknown + } + } /** This can only be done by the logged in user. */ createUser: { responses: { /** successful operation */ - default: unknown; - }; + default: unknown + } /** Created user object */ requestBody: { content: { - "*/*": components["schemas"]["User"]; - }; - }; - }; + '*/*': components['schemas']['User'] + } + } + } createUsersWithArrayInput: { responses: { /** successful operation */ - default: unknown; - }; + default: unknown + } /** List of user object */ requestBody: { content: { - "*/*": components["schemas"]["User"][]; - }; - }; - }; + '*/*': components['schemas']['User'][] + } + } + } createUsersWithListInput: { responses: { /** successful operation */ - default: unknown; - }; + default: unknown + } /** List of user object */ requestBody: { content: { - "*/*": components["schemas"]["User"][]; - }; - }; - }; + '*/*': components['schemas']['User'][] + } + } + } loginUser: { parameters: { query: { /** The user name for login */ - username: string; + username: string /** The password for login in clear text */ - password: string; - }; - }; + password: string + } + } responses: { /** successful operation */ 200: { headers: { /** calls per hour allowed by the user */ - "X-Rate-Limit"?: number; + 'X-Rate-Limit'?: number /** date in UTC when token expires */ - "X-Expires-After"?: string; - }; + 'X-Expires-After'?: string + } content: { - "application/xml": string; - "application/json": string; - }; - }; + 'application/xml': string + 'application/json': string + } + } /** Invalid username/password supplied */ - 400: unknown; - }; - }; + 400: unknown + } + } logoutUser: { responses: { /** successful operation */ - default: unknown; - }; - }; + default: unknown + } + } getUserByName: { parameters: { path: { /** The name that needs to be fetched. Use user1 for testing. */ - username: string; - }; - }; + username: string + } + } responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["User"]; - "application/json": components["schemas"]["User"]; - }; - }; + 'application/xml': components['schemas']['User'] + 'application/json': components['schemas']['User'] + } + } /** Invalid username supplied */ - 400: unknown; + 400: unknown /** User not found */ - 404: unknown; - }; - }; + 404: unknown + } + } /** This can only be done by the logged in user. */ updateUser: { parameters: { path: { /** name that need to be updated */ - username: string; - }; - }; + username: string + } + } responses: { /** Invalid user supplied */ - 400: unknown; + 400: unknown /** User not found */ - 404: unknown; - }; + 404: unknown + } /** Updated user object */ requestBody: { content: { - "*/*": components["schemas"]["User"]; - }; - }; - }; + '*/*': components['schemas']['User'] + } + } + } /** This can only be done by the logged in user. */ deleteUser: { parameters: { path: { /** The name that needs to be deleted */ - username: string; - }; - }; + username: string + } + } responses: { /** Invalid username supplied */ - 400: unknown; + 400: unknown /** User not found */ - 404: unknown; - }; - }; + 404: unknown + } + } } export interface external {} diff --git a/test/v3/expected/petstore.ts b/test/v3/expected/petstore.ts index 9199645c1..733c95a71 100644 --- a/test/v3/expected/petstore.ts +++ b/test/v3/expected/petstore.ts @@ -4,486 +4,486 @@ */ export interface paths { - "/pet": { - put: operations["updatePet"]; - post: operations["addPet"]; - }; - "/pet/findByStatus": { + '/pet': { + put: operations['updatePet'] + post: operations['addPet'] + } + '/pet/findByStatus': { /** Multiple status values can be provided with comma separated strings */ - get: operations["findPetsByStatus"]; - }; - "/pet/findByTags": { + get: operations['findPetsByStatus'] + } + '/pet/findByTags': { /** Muliple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. */ - get: operations["findPetsByTags"]; - }; - "/pet/{petId}": { + get: operations['findPetsByTags'] + } + '/pet/{petId}': { /** Returns a single pet */ - get: operations["getPetById"]; - post: operations["updatePetWithForm"]; - delete: operations["deletePet"]; - }; - "/pet/{petId}/uploadImage": { - post: operations["uploadFile"]; - }; - "/store/inventory": { + get: operations['getPetById'] + post: operations['updatePetWithForm'] + delete: operations['deletePet'] + } + '/pet/{petId}/uploadImage': { + post: operations['uploadFile'] + } + '/store/inventory': { /** Returns a map of status codes to quantities */ - get: operations["getInventory"]; - }; - "/store/order": { - post: operations["placeOrder"]; - }; - "/store/order/{orderId}": { + get: operations['getInventory'] + } + '/store/order': { + post: operations['placeOrder'] + } + '/store/order/{orderId}': { /** For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions */ - get: operations["getOrderById"]; + get: operations['getOrderById'] /** For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors */ - delete: operations["deleteOrder"]; - }; - "/user": { + delete: operations['deleteOrder'] + } + '/user': { /** This can only be done by the logged in user. */ - post: operations["createUser"]; - }; - "/user/createWithArray": { - post: operations["createUsersWithArrayInput"]; - }; - "/user/createWithList": { - post: operations["createUsersWithListInput"]; - }; - "/user/login": { - get: operations["loginUser"]; - }; - "/user/logout": { - get: operations["logoutUser"]; - }; - "/user/{username}": { - get: operations["getUserByName"]; + post: operations['createUser'] + } + '/user/createWithArray': { + post: operations['createUsersWithArrayInput'] + } + '/user/createWithList': { + post: operations['createUsersWithListInput'] + } + '/user/login': { + get: operations['loginUser'] + } + '/user/logout': { + get: operations['logoutUser'] + } + '/user/{username}': { + get: operations['getUserByName'] /** This can only be done by the logged in user. */ - put: operations["updateUser"]; + put: operations['updateUser'] /** This can only be done by the logged in user. */ - delete: operations["deleteUser"]; - }; + delete: operations['deleteUser'] + } } export interface components { schemas: { Order: { /** Format: int64 */ - id?: number; + id?: number /** Format: int64 */ - petId?: number; + petId?: number /** Format: int32 */ - quantity?: number; + quantity?: number /** Format: date-time */ - shipDate?: string; + shipDate?: string /** * @description Order Status * @enum {string} */ - status?: "placed" | "approved" | "delivered"; - complete?: boolean; - }; + status?: 'placed' | 'approved' | 'delivered' + complete?: boolean + } Category: { /** Format: int64 */ - id?: number; - name?: string; - }; + id?: number + name?: string + } User: { /** Format: int64 */ - id?: number; - username?: string; - firstName?: string; - lastName?: string; - email?: string; - password?: string; - phone?: string; + id?: number + username?: string + firstName?: string + lastName?: string + email?: string + password?: string + phone?: string /** * Format: int32 * @description User Status */ - userStatus?: number; - }; + userStatus?: number + } Tag: { /** Format: int64 */ - id?: number; - name?: string; - }; + id?: number + name?: string + } Pet: { /** Format: int64 */ - id?: number; - category?: components["schemas"]["Category"]; + id?: number + category?: components['schemas']['Category'] /** @example doggie */ - name: string; - photoUrls: string[]; - tags?: components["schemas"]["Tag"][]; + name: string + photoUrls: string[] + tags?: components['schemas']['Tag'][] /** * @description pet status in the store * @enum {string} */ - status?: "available" | "pending" | "sold"; - }; + status?: 'available' | 'pending' | 'sold' + } ApiResponse: { /** Format: int32 */ - code?: number; - type?: string; - message?: string; - }; - }; + code?: number + type?: string + message?: string + } + } } export interface operations { updatePet: { responses: { /** Invalid ID supplied */ - 400: unknown; + 400: unknown /** Pet not found */ - 404: unknown; + 404: unknown /** Validation exception */ - 405: unknown; - }; + 405: unknown + } /** Pet object that needs to be added to the store */ requestBody: { content: { - "application/json": components["schemas"]["Pet"]; - "application/xml": components["schemas"]["Pet"]; - }; - }; - }; + 'application/json': components['schemas']['Pet'] + 'application/xml': components['schemas']['Pet'] + } + } + } addPet: { responses: { /** Invalid input */ - 405: unknown; - }; + 405: unknown + } /** Pet object that needs to be added to the store */ requestBody: { content: { - "application/json": components["schemas"]["Pet"]; - "application/xml": components["schemas"]["Pet"]; - }; - }; - }; + 'application/json': components['schemas']['Pet'] + 'application/xml': components['schemas']['Pet'] + } + } + } /** Multiple status values can be provided with comma separated strings */ findPetsByStatus: { parameters: { query: { /** Status values that need to be considered for filter */ - status: ("available" | "pending" | "sold")[]; - }; - }; + status: ('available' | 'pending' | 'sold')[] + } + } responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Pet"][]; - "application/json": components["schemas"]["Pet"][]; - }; - }; + 'application/xml': components['schemas']['Pet'][] + 'application/json': components['schemas']['Pet'][] + } + } /** Invalid status value */ - 400: unknown; - }; - }; + 400: unknown + } + } /** Muliple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. */ findPetsByTags: { parameters: { query: { /** Tags to filter by */ - tags: string[]; - }; - }; + tags: string[] + } + } responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Pet"][]; - "application/json": components["schemas"]["Pet"][]; - }; - }; + 'application/xml': components['schemas']['Pet'][] + 'application/json': components['schemas']['Pet'][] + } + } /** Invalid tag value */ - 400: unknown; - }; - }; + 400: unknown + } + } /** Returns a single pet */ getPetById: { parameters: { path: { /** ID of pet to return */ - petId: number; - }; - }; + petId: number + } + } responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Pet"]; - "application/json": components["schemas"]["Pet"]; - }; - }; + 'application/xml': components['schemas']['Pet'] + 'application/json': components['schemas']['Pet'] + } + } /** Invalid ID supplied */ - 400: unknown; + 400: unknown /** Pet not found */ - 404: unknown; - }; - }; + 404: unknown + } + } updatePetWithForm: { parameters: { path: { /** ID of pet that needs to be updated */ - petId: number; - }; - }; + petId: number + } + } responses: { /** Invalid input */ - 405: unknown; - }; + 405: unknown + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Updated name of the pet */ - name?: string; + name?: string /** @description Updated status of the pet */ - status?: string; - }; - }; - }; - }; + status?: string + } + } + } + } deletePet: { parameters: { header: { - api_key?: string; - }; + api_key?: string + } path: { /** Pet id to delete */ - petId: number; - }; - }; + petId: number + } + } responses: { /** Invalid ID supplied */ - 400: unknown; + 400: unknown /** Pet not found */ - 404: unknown; - }; - }; + 404: unknown + } + } uploadFile: { parameters: { path: { /** ID of pet to update */ - petId: number; - }; - }; + petId: number + } + } responses: { /** successful operation */ 200: { content: { - "application/json": components["schemas"]["ApiResponse"]; - }; - }; - }; + 'application/json': components['schemas']['ApiResponse'] + } + } + } requestBody: { content: { - "multipart/form-data": { + 'multipart/form-data': { /** @description Additional data to pass to server */ - additionalMetadata?: string; + additionalMetadata?: string /** * Format: binary * @description file to upload */ - file?: string; - }; - }; - }; - }; + file?: string + } + } + } + } /** Returns a map of status codes to quantities */ getInventory: { responses: { /** successful operation */ 200: { content: { - "application/json": { [key: string]: number }; - }; - }; - }; - }; + 'application/json': { [key: string]: number } + } + } + } + } placeOrder: { responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Order"]; - "application/json": components["schemas"]["Order"]; - }; - }; + 'application/xml': components['schemas']['Order'] + 'application/json': components['schemas']['Order'] + } + } /** Invalid Order */ - 400: unknown; - }; + 400: unknown + } /** order placed for purchasing the pet */ requestBody: { content: { - "*/*": components["schemas"]["Order"]; - }; - }; - }; + '*/*': components['schemas']['Order'] + } + } + } /** For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions */ getOrderById: { parameters: { path: { /** ID of pet that needs to be fetched */ - orderId: number; - }; - }; + orderId: number + } + } responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["Order"]; - "application/json": components["schemas"]["Order"]; - }; - }; + 'application/xml': components['schemas']['Order'] + 'application/json': components['schemas']['Order'] + } + } /** Invalid ID supplied */ - 400: unknown; + 400: unknown /** Order not found */ - 404: unknown; - }; - }; + 404: unknown + } + } /** For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors */ deleteOrder: { parameters: { path: { /** ID of the order that needs to be deleted */ - orderId: number; - }; - }; + orderId: number + } + } responses: { /** Invalid ID supplied */ - 400: unknown; + 400: unknown /** Order not found */ - 404: unknown; - }; - }; + 404: unknown + } + } /** This can only be done by the logged in user. */ createUser: { responses: { /** successful operation */ - default: unknown; - }; + default: unknown + } /** Created user object */ requestBody: { content: { - "*/*": components["schemas"]["User"]; - }; - }; - }; + '*/*': components['schemas']['User'] + } + } + } createUsersWithArrayInput: { responses: { /** successful operation */ - default: unknown; - }; + default: unknown + } /** List of user object */ requestBody: { content: { - "*/*": components["schemas"]["User"][]; - }; - }; - }; + '*/*': components['schemas']['User'][] + } + } + } createUsersWithListInput: { responses: { /** successful operation */ - default: unknown; - }; + default: unknown + } /** List of user object */ requestBody: { content: { - "*/*": components["schemas"]["User"][]; - }; - }; - }; + '*/*': components['schemas']['User'][] + } + } + } loginUser: { parameters: { query: { /** The user name for login */ - username: string; + username: string /** The password for login in clear text */ - password: string; - }; - }; + password: string + } + } responses: { /** successful operation */ 200: { headers: { /** calls per hour allowed by the user */ - "X-Rate-Limit"?: number; + 'X-Rate-Limit'?: number /** date in UTC when token expires */ - "X-Expires-After"?: string; - }; + 'X-Expires-After'?: string + } content: { - "application/xml": string; - "application/json": string; - }; - }; + 'application/xml': string + 'application/json': string + } + } /** Invalid username/password supplied */ - 400: unknown; - }; - }; + 400: unknown + } + } logoutUser: { responses: { /** successful operation */ - default: unknown; - }; - }; + default: unknown + } + } getUserByName: { parameters: { path: { /** The name that needs to be fetched. Use user1 for testing. */ - username: string; - }; - }; + username: string + } + } responses: { /** successful operation */ 200: { content: { - "application/xml": components["schemas"]["User"]; - "application/json": components["schemas"]["User"]; - }; - }; + 'application/xml': components['schemas']['User'] + 'application/json': components['schemas']['User'] + } + } /** Invalid username supplied */ - 400: unknown; + 400: unknown /** User not found */ - 404: unknown; - }; - }; + 404: unknown + } + } /** This can only be done by the logged in user. */ updateUser: { parameters: { path: { /** name that need to be updated */ - username: string; - }; - }; + username: string + } + } responses: { /** Invalid user supplied */ - 400: unknown; + 400: unknown /** User not found */ - 404: unknown; - }; + 404: unknown + } /** Updated user object */ requestBody: { content: { - "*/*": components["schemas"]["User"]; - }; - }; - }; + '*/*': components['schemas']['User'] + } + } + } /** This can only be done by the logged in user. */ deleteUser: { parameters: { path: { /** The name that needs to be deleted */ - username: string; - }; - }; + username: string + } + } responses: { /** Invalid username supplied */ - 400: unknown; + 400: unknown /** User not found */ - 404: unknown; - }; - }; + 404: unknown + } + } } export interface external {} diff --git a/test/v3/expected/reference-to-properties.additional.ts b/test/v3/expected/reference-to-properties.additional.ts index eb61f0e3f..16d0ce702 100644 --- a/test/v3/expected/reference-to-properties.additional.ts +++ b/test/v3/expected/reference-to-properties.additional.ts @@ -4,32 +4,32 @@ */ export interface paths { - "/pet": { - put: operations["updatePet"]; - }; + '/pet': { + put: operations['updatePet'] + } } export interface components { schemas: { Pet: { - name: string; - } & { [key: string]: unknown }; - }; + name: string + } & { [key: string]: unknown } + } } export interface operations { updatePet: { responses: { - 200: unknown; - }; + 200: unknown + } requestBody: { content: { - "application/json": { - name?: components["schemas"]["Pet"]["name"]; - } & { [key: string]: unknown }; - }; - }; - }; + 'application/json': { + name?: components['schemas']['Pet']['name'] + } & { [key: string]: unknown } + } + } + } } export interface external {} diff --git a/test/v3/expected/reference-to-properties.exported-type.ts b/test/v3/expected/reference-to-properties.exported-type.ts index 6bfcdfde3..c90e799b2 100644 --- a/test/v3/expected/reference-to-properties.exported-type.ts +++ b/test/v3/expected/reference-to-properties.exported-type.ts @@ -4,32 +4,32 @@ */ export type paths = { - "/pet": { - put: operations["updatePet"]; - }; -}; + '/pet': { + put: operations['updatePet'] + } +} export type components = { schemas: { Pet: { - name: string; - }; - }; -}; + name: string + } + } +} export type operations = { updatePet: { responses: { - 200: unknown; - }; + 200: unknown + } requestBody: { content: { - "application/json": { - name?: components["schemas"]["Pet"]["name"]; - }; - }; - }; - }; -}; + 'application/json': { + name?: components['schemas']['Pet']['name'] + } + } + } + } +} -export type external = {}; +export type external = {} diff --git a/test/v3/expected/reference-to-properties.immutable.ts b/test/v3/expected/reference-to-properties.immutable.ts index 224f2fe04..81559c097 100644 --- a/test/v3/expected/reference-to-properties.immutable.ts +++ b/test/v3/expected/reference-to-properties.immutable.ts @@ -4,32 +4,32 @@ */ export interface paths { - readonly "/pet": { - readonly put: operations["updatePet"]; - }; + readonly '/pet': { + readonly put: operations['updatePet'] + } } export interface components { readonly schemas: { readonly Pet: { - readonly name: string; - }; - }; + readonly name: string + } + } } export interface operations { readonly updatePet: { readonly responses: { - readonly 200: unknown; - }; + readonly 200: unknown + } readonly requestBody: { readonly content: { - readonly "application/json": { - readonly name?: components["schemas"]["Pet"]["name"]; - }; - }; - }; - }; + readonly 'application/json': { + readonly name?: components['schemas']['Pet']['name'] + } + } + } + } } export interface external {} diff --git a/test/v3/expected/reference-to-properties.support-array-length.ts b/test/v3/expected/reference-to-properties.support-array-length.ts index 4990796f3..48b4e4ceb 100644 --- a/test/v3/expected/reference-to-properties.support-array-length.ts +++ b/test/v3/expected/reference-to-properties.support-array-length.ts @@ -4,32 +4,32 @@ */ export interface paths { - "/pet": { - put: operations["updatePet"]; - }; + '/pet': { + put: operations['updatePet'] + } } export interface components { schemas: { Pet: { - name: string; - }; - }; + name: string + } + } } export interface operations { updatePet: { responses: { - 200: unknown; - }; + 200: unknown + } requestBody: { content: { - "application/json": { - name?: components["schemas"]["Pet"]["name"]; - }; - }; - }; - }; + 'application/json': { + name?: components['schemas']['Pet']['name'] + } + } + } + } } export interface external {} diff --git a/test/v3/expected/reference-to-properties.ts b/test/v3/expected/reference-to-properties.ts index 4990796f3..48b4e4ceb 100644 --- a/test/v3/expected/reference-to-properties.ts +++ b/test/v3/expected/reference-to-properties.ts @@ -4,32 +4,32 @@ */ export interface paths { - "/pet": { - put: operations["updatePet"]; - }; + '/pet': { + put: operations['updatePet'] + } } export interface components { schemas: { Pet: { - name: string; - }; - }; + name: string + } + } } export interface operations { updatePet: { responses: { - 200: unknown; - }; + 200: unknown + } requestBody: { content: { - "application/json": { - name?: components["schemas"]["Pet"]["name"]; - }; - }; - }; - }; + 'application/json': { + name?: components['schemas']['Pet']['name'] + } + } + } + } } export interface external {} diff --git a/test/v3/expected/stripe.additional.ts b/test/v3/expected/stripe.additional.ts index e76e0afc1..6c11326b6 100644 --- a/test/v3/expected/stripe.additional.ts +++ b/test/v3/expected/stripe.additional.ts @@ -4,23 +4,23 @@ */ export interface paths { - "/v1/3d_secure": { + '/v1/3d_secure': { /**

Initiate 3D Secure authentication.

*/ - post: operations["Post3dSecure"]; - }; - "/v1/3d_secure/{three_d_secure}": { + post: operations['Post3dSecure'] + } + '/v1/3d_secure/{three_d_secure}': { /**

Retrieves a 3D Secure object.

*/ - get: operations["Get3dSecureThreeDSecure"]; - }; - "/v1/account": { + get: operations['Get3dSecureThreeDSecure'] + } + '/v1/account': { /**

Retrieves the details of an account.

*/ - get: operations["GetAccount"]; + get: operations['GetAccount'] /** *

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged. Most parameters can be changed only for Custom accounts. (These are marked Custom Only below.) Parameters marked Custom and Express are not supported for Standard accounts.

* *

To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.

*/ - post: operations["PostAccount"]; + post: operations['PostAccount'] /** *

With Connect, you can delete accounts you manage.

* @@ -28,110 +28,110 @@ export interface paths { * *

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

*/ - delete: operations["DeleteAccount"]; - }; - "/v1/account/bank_accounts": { + delete: operations['DeleteAccount'] + } + '/v1/account/bank_accounts': { /**

Create an external account for a given account.

*/ - post: operations["PostAccountBankAccounts"]; - }; - "/v1/account/bank_accounts/{id}": { + post: operations['PostAccountBankAccounts'] + } + '/v1/account/bank_accounts/{id}': { /**

Retrieve a specified external account for a given account.

*/ - get: operations["GetAccountBankAccountsId"]; + get: operations['GetAccountBankAccountsId'] /** *

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

* *

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

*/ - post: operations["PostAccountBankAccountsId"]; + post: operations['PostAccountBankAccountsId'] /**

Delete a specified external account for a given account.

*/ - delete: operations["DeleteAccountBankAccountsId"]; - }; - "/v1/account/capabilities": { + delete: operations['DeleteAccountBankAccountsId'] + } + '/v1/account/capabilities': { /**

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

*/ - get: operations["GetAccountCapabilities"]; - }; - "/v1/account/capabilities/{capability}": { + get: operations['GetAccountCapabilities'] + } + '/v1/account/capabilities/{capability}': { /**

Retrieves information about the specified Account Capability.

*/ - get: operations["GetAccountCapabilitiesCapability"]; + get: operations['GetAccountCapabilitiesCapability'] /**

Updates an existing Account Capability.

*/ - post: operations["PostAccountCapabilitiesCapability"]; - }; - "/v1/account/external_accounts": { + post: operations['PostAccountCapabilitiesCapability'] + } + '/v1/account/external_accounts': { /**

List external accounts for an account.

*/ - get: operations["GetAccountExternalAccounts"]; + get: operations['GetAccountExternalAccounts'] /**

Create an external account for a given account.

*/ - post: operations["PostAccountExternalAccounts"]; - }; - "/v1/account/external_accounts/{id}": { + post: operations['PostAccountExternalAccounts'] + } + '/v1/account/external_accounts/{id}': { /**

Retrieve a specified external account for a given account.

*/ - get: operations["GetAccountExternalAccountsId"]; + get: operations['GetAccountExternalAccountsId'] /** *

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

* *

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

*/ - post: operations["PostAccountExternalAccountsId"]; + post: operations['PostAccountExternalAccountsId'] /**

Delete a specified external account for a given account.

*/ - delete: operations["DeleteAccountExternalAccountsId"]; - }; - "/v1/account/login_links": { + delete: operations['DeleteAccountExternalAccountsId'] + } + '/v1/account/login_links': { /** *

Creates a single-use login link for an Express account to access their Stripe dashboard.

* *

You may only create login links for Express accounts connected to your platform.

*/ - post: operations["PostAccountLoginLinks"]; - }; - "/v1/account/people": { + post: operations['PostAccountLoginLinks'] + } + '/v1/account/people': { /**

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.

*/ - get: operations["GetAccountPeople"]; + get: operations['GetAccountPeople'] /**

Creates a new person.

*/ - post: operations["PostAccountPeople"]; - }; - "/v1/account/people/{person}": { + post: operations['PostAccountPeople'] + } + '/v1/account/people/{person}': { /**

Retrieves an existing person.

*/ - get: operations["GetAccountPeoplePerson"]; + get: operations['GetAccountPeoplePerson'] /**

Updates an existing person.

*/ - post: operations["PostAccountPeoplePerson"]; + post: operations['PostAccountPeoplePerson'] /**

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.

*/ - delete: operations["DeleteAccountPeoplePerson"]; - }; - "/v1/account/persons": { + delete: operations['DeleteAccountPeoplePerson'] + } + '/v1/account/persons': { /**

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.

*/ - get: operations["GetAccountPersons"]; + get: operations['GetAccountPersons'] /**

Creates a new person.

*/ - post: operations["PostAccountPersons"]; - }; - "/v1/account/persons/{person}": { + post: operations['PostAccountPersons'] + } + '/v1/account/persons/{person}': { /**

Retrieves an existing person.

*/ - get: operations["GetAccountPersonsPerson"]; + get: operations['GetAccountPersonsPerson'] /**

Updates an existing person.

*/ - post: operations["PostAccountPersonsPerson"]; + post: operations['PostAccountPersonsPerson'] /**

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.

*/ - delete: operations["DeleteAccountPersonsPerson"]; - }; - "/v1/account_links": { + delete: operations['DeleteAccountPersonsPerson'] + } + '/v1/account_links': { /**

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.

*/ - post: operations["PostAccountLinks"]; - }; - "/v1/accounts": { + post: operations['PostAccountLinks'] + } + '/v1/accounts': { /**

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

*/ - get: operations["GetAccounts"]; + get: operations['GetAccounts'] /** *

With Connect, you can create Stripe accounts for your users. * To do this, you’ll first need to register your platform.

*/ - post: operations["PostAccounts"]; - }; - "/v1/accounts/{account}": { + post: operations['PostAccounts'] + } + '/v1/accounts/{account}': { /**

Retrieves the details of an account.

*/ - get: operations["GetAccountsAccount"]; + get: operations['GetAccountsAccount'] /** *

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged. Most parameters can be changed only for Custom accounts. (These are marked Custom Only below.) Parameters marked Custom and Express are not supported for Standard accounts.

* *

To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.

*/ - post: operations["PostAccountsAccount"]; + post: operations['PostAccountsAccount'] /** *

With Connect, you can delete accounts you manage.

* @@ -139,132 +139,132 @@ export interface paths { * *

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

*/ - delete: operations["DeleteAccountsAccount"]; - }; - "/v1/accounts/{account}/bank_accounts": { + delete: operations['DeleteAccountsAccount'] + } + '/v1/accounts/{account}/bank_accounts': { /**

Create an external account for a given account.

*/ - post: operations["PostAccountsAccountBankAccounts"]; - }; - "/v1/accounts/{account}/bank_accounts/{id}": { + post: operations['PostAccountsAccountBankAccounts'] + } + '/v1/accounts/{account}/bank_accounts/{id}': { /**

Retrieve a specified external account for a given account.

*/ - get: operations["GetAccountsAccountBankAccountsId"]; + get: operations['GetAccountsAccountBankAccountsId'] /** *

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

* *

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

*/ - post: operations["PostAccountsAccountBankAccountsId"]; + post: operations['PostAccountsAccountBankAccountsId'] /**

Delete a specified external account for a given account.

*/ - delete: operations["DeleteAccountsAccountBankAccountsId"]; - }; - "/v1/accounts/{account}/capabilities": { + delete: operations['DeleteAccountsAccountBankAccountsId'] + } + '/v1/accounts/{account}/capabilities': { /**

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

*/ - get: operations["GetAccountsAccountCapabilities"]; - }; - "/v1/accounts/{account}/capabilities/{capability}": { + get: operations['GetAccountsAccountCapabilities'] + } + '/v1/accounts/{account}/capabilities/{capability}': { /**

Retrieves information about the specified Account Capability.

*/ - get: operations["GetAccountsAccountCapabilitiesCapability"]; + get: operations['GetAccountsAccountCapabilitiesCapability'] /**

Updates an existing Account Capability.

*/ - post: operations["PostAccountsAccountCapabilitiesCapability"]; - }; - "/v1/accounts/{account}/external_accounts": { + post: operations['PostAccountsAccountCapabilitiesCapability'] + } + '/v1/accounts/{account}/external_accounts': { /**

List external accounts for an account.

*/ - get: operations["GetAccountsAccountExternalAccounts"]; + get: operations['GetAccountsAccountExternalAccounts'] /**

Create an external account for a given account.

*/ - post: operations["PostAccountsAccountExternalAccounts"]; - }; - "/v1/accounts/{account}/external_accounts/{id}": { + post: operations['PostAccountsAccountExternalAccounts'] + } + '/v1/accounts/{account}/external_accounts/{id}': { /**

Retrieve a specified external account for a given account.

*/ - get: operations["GetAccountsAccountExternalAccountsId"]; + get: operations['GetAccountsAccountExternalAccountsId'] /** *

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

* *

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

*/ - post: operations["PostAccountsAccountExternalAccountsId"]; + post: operations['PostAccountsAccountExternalAccountsId'] /**

Delete a specified external account for a given account.

*/ - delete: operations["DeleteAccountsAccountExternalAccountsId"]; - }; - "/v1/accounts/{account}/login_links": { + delete: operations['DeleteAccountsAccountExternalAccountsId'] + } + '/v1/accounts/{account}/login_links': { /** *

Creates a single-use login link for an Express account to access their Stripe dashboard.

* *

You may only create login links for Express accounts connected to your platform.

*/ - post: operations["PostAccountsAccountLoginLinks"]; - }; - "/v1/accounts/{account}/people": { + post: operations['PostAccountsAccountLoginLinks'] + } + '/v1/accounts/{account}/people': { /**

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.

*/ - get: operations["GetAccountsAccountPeople"]; + get: operations['GetAccountsAccountPeople'] /**

Creates a new person.

*/ - post: operations["PostAccountsAccountPeople"]; - }; - "/v1/accounts/{account}/people/{person}": { + post: operations['PostAccountsAccountPeople'] + } + '/v1/accounts/{account}/people/{person}': { /**

Retrieves an existing person.

*/ - get: operations["GetAccountsAccountPeoplePerson"]; + get: operations['GetAccountsAccountPeoplePerson'] /**

Updates an existing person.

*/ - post: operations["PostAccountsAccountPeoplePerson"]; + post: operations['PostAccountsAccountPeoplePerson'] /**

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.

*/ - delete: operations["DeleteAccountsAccountPeoplePerson"]; - }; - "/v1/accounts/{account}/persons": { + delete: operations['DeleteAccountsAccountPeoplePerson'] + } + '/v1/accounts/{account}/persons': { /**

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.

*/ - get: operations["GetAccountsAccountPersons"]; + get: operations['GetAccountsAccountPersons'] /**

Creates a new person.

*/ - post: operations["PostAccountsAccountPersons"]; - }; - "/v1/accounts/{account}/persons/{person}": { + post: operations['PostAccountsAccountPersons'] + } + '/v1/accounts/{account}/persons/{person}': { /**

Retrieves an existing person.

*/ - get: operations["GetAccountsAccountPersonsPerson"]; + get: operations['GetAccountsAccountPersonsPerson'] /**

Updates an existing person.

*/ - post: operations["PostAccountsAccountPersonsPerson"]; + post: operations['PostAccountsAccountPersonsPerson'] /**

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.

*/ - delete: operations["DeleteAccountsAccountPersonsPerson"]; - }; - "/v1/accounts/{account}/reject": { + delete: operations['DeleteAccountsAccountPersonsPerson'] + } + '/v1/accounts/{account}/reject': { /** *

With Connect, you may flag accounts as suspicious.

* *

Test-mode Custom and Express accounts can be rejected at any time. Accounts created using live-mode keys may only be rejected once all balances are zero.

*/ - post: operations["PostAccountsAccountReject"]; - }; - "/v1/apple_pay/domains": { + post: operations['PostAccountsAccountReject'] + } + '/v1/apple_pay/domains': { /**

List apple pay domains.

*/ - get: operations["GetApplePayDomains"]; + get: operations['GetApplePayDomains'] /**

Create an apple pay domain.

*/ - post: operations["PostApplePayDomains"]; - }; - "/v1/apple_pay/domains/{domain}": { + post: operations['PostApplePayDomains'] + } + '/v1/apple_pay/domains/{domain}': { /**

Retrieve an apple pay domain.

*/ - get: operations["GetApplePayDomainsDomain"]; + get: operations['GetApplePayDomainsDomain'] /**

Delete an apple pay domain.

*/ - delete: operations["DeleteApplePayDomainsDomain"]; - }; - "/v1/application_fees": { + delete: operations['DeleteApplePayDomainsDomain'] + } + '/v1/application_fees': { /**

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.

*/ - get: operations["GetApplicationFees"]; - }; - "/v1/application_fees/{fee}/refunds/{id}": { + get: operations['GetApplicationFees'] + } + '/v1/application_fees/{fee}/refunds/{id}': { /**

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.

*/ - get: operations["GetApplicationFeesFeeRefundsId"]; + get: operations['GetApplicationFeesFeeRefundsId'] /** *

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

* *

This request only accepts metadata as an argument.

*/ - post: operations["PostApplicationFeesFeeRefundsId"]; - }; - "/v1/application_fees/{id}": { + post: operations['PostApplicationFeesFeeRefundsId'] + } + '/v1/application_fees/{id}': { /**

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

*/ - get: operations["GetApplicationFeesId"]; - }; - "/v1/application_fees/{id}/refund": { - post: operations["PostApplicationFeesIdRefund"]; - }; - "/v1/application_fees/{id}/refunds": { + get: operations['GetApplicationFeesId'] + } + '/v1/application_fees/{id}/refund': { + post: operations['PostApplicationFeesIdRefund'] + } + '/v1/application_fees/{id}/refunds': { /**

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.

*/ - get: operations["GetApplicationFeesIdRefunds"]; + get: operations['GetApplicationFeesIdRefunds'] /** *

Refunds an application fee that has previously been collected but not yet refunded. * Funds will be refunded to the Stripe account from which the fee was originally collected.

@@ -276,108 +276,108 @@ export interface paths { * This method will raise an error when called on an already-refunded application fee, * or when trying to refund more money than is left on an application fee.

*/ - post: operations["PostApplicationFeesIdRefunds"]; - }; - "/v1/balance": { + post: operations['PostApplicationFeesIdRefunds'] + } + '/v1/balance': { /** *

Retrieves the current account balance, based on the authentication that was used to make the request. * For a sample request, see Accounting for negative balances.

*/ - get: operations["GetBalance"]; - }; - "/v1/balance/history": { + get: operations['GetBalance'] + } + '/v1/balance/history': { /** *

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

* *

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

*/ - get: operations["GetBalanceHistory"]; - }; - "/v1/balance/history/{id}": { + get: operations['GetBalanceHistory'] + } + '/v1/balance/history/{id}': { /** *

Retrieves the balance transaction with the given ID.

* *

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

*/ - get: operations["GetBalanceHistoryId"]; - }; - "/v1/balance_transactions": { + get: operations['GetBalanceHistoryId'] + } + '/v1/balance_transactions': { /** *

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

* *

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

*/ - get: operations["GetBalanceTransactions"]; - }; - "/v1/balance_transactions/{id}": { + get: operations['GetBalanceTransactions'] + } + '/v1/balance_transactions/{id}': { /** *

Retrieves the balance transaction with the given ID.

* *

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

*/ - get: operations["GetBalanceTransactionsId"]; - }; - "/v1/billing_portal/configurations": { + get: operations['GetBalanceTransactionsId'] + } + '/v1/billing_portal/configurations': { /**

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

*/ - get: operations["GetBillingPortalConfigurations"]; + get: operations['GetBillingPortalConfigurations'] /**

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

*/ - post: operations["PostBillingPortalConfigurations"]; - }; - "/v1/billing_portal/configurations/{configuration}": { + post: operations['PostBillingPortalConfigurations'] + } + '/v1/billing_portal/configurations/{configuration}': { /**

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

*/ - get: operations["GetBillingPortalConfigurationsConfiguration"]; + get: operations['GetBillingPortalConfigurationsConfiguration'] /**

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

*/ - post: operations["PostBillingPortalConfigurationsConfiguration"]; - }; - "/v1/billing_portal/sessions": { + post: operations['PostBillingPortalConfigurationsConfiguration'] + } + '/v1/billing_portal/sessions': { /**

Creates a session of the customer portal.

*/ - post: operations["PostBillingPortalSessions"]; - }; - "/v1/bitcoin/receivers": { + post: operations['PostBillingPortalSessions'] + } + '/v1/bitcoin/receivers': { /**

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

*/ - get: operations["GetBitcoinReceivers"]; - }; - "/v1/bitcoin/receivers/{id}": { + get: operations['GetBitcoinReceivers'] + } + '/v1/bitcoin/receivers/{id}': { /**

Retrieves the Bitcoin receiver with the given ID.

*/ - get: operations["GetBitcoinReceiversId"]; - }; - "/v1/bitcoin/receivers/{receiver}/transactions": { + get: operations['GetBitcoinReceiversId'] + } + '/v1/bitcoin/receivers/{receiver}/transactions': { /**

List bitcoin transacitons for a given receiver.

*/ - get: operations["GetBitcoinReceiversReceiverTransactions"]; - }; - "/v1/bitcoin/transactions": { + get: operations['GetBitcoinReceiversReceiverTransactions'] + } + '/v1/bitcoin/transactions': { /**

List bitcoin transacitons for a given receiver.

*/ - get: operations["GetBitcoinTransactions"]; - }; - "/v1/charges": { + get: operations['GetBitcoinTransactions'] + } + '/v1/charges': { /**

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

*/ - get: operations["GetCharges"]; + get: operations['GetCharges'] /**

To charge a credit card or other payment source, you create a Charge object. If your API key is in test mode, the supplied payment source (e.g., card) won’t actually be charged, although everything else will occur as if in live mode. (Stripe assumes that the charge would have completed successfully).

*/ - post: operations["PostCharges"]; - }; - "/v1/charges/{charge}": { + post: operations['PostCharges'] + } + '/v1/charges/{charge}': { /**

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.

*/ - get: operations["GetChargesCharge"]; + get: operations['GetChargesCharge'] /**

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

*/ - post: operations["PostChargesCharge"]; - }; - "/v1/charges/{charge}/capture": { + post: operations['PostChargesCharge'] + } + '/v1/charges/{charge}/capture': { /** *

Capture the payment of an existing, uncaptured, charge. This is the second half of the two-step payment flow, where first you created a charge with the capture option set to false.

* *

Uncaptured payments expire a set number of days after they are created (7 by default). If they are not captured by that point in time, they will be marked as refunded and will no longer be capturable.

*/ - post: operations["PostChargesChargeCapture"]; - }; - "/v1/charges/{charge}/dispute": { + post: operations['PostChargesChargeCapture'] + } + '/v1/charges/{charge}/dispute': { /**

Retrieve a dispute for a specified charge.

*/ - get: operations["GetChargesChargeDispute"]; - post: operations["PostChargesChargeDispute"]; - }; - "/v1/charges/{charge}/dispute/close": { - post: operations["PostChargesChargeDisputeClose"]; - }; - "/v1/charges/{charge}/refund": { + get: operations['GetChargesChargeDispute'] + post: operations['PostChargesChargeDispute'] + } + '/v1/charges/{charge}/dispute/close': { + post: operations['PostChargesChargeDisputeClose'] + } + '/v1/charges/{charge}/refund': { /** *

When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.

* @@ -391,71 +391,71 @@ export interface paths { * 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.

*/ - post: operations["PostChargesChargeRefund"]; - }; - "/v1/charges/{charge}/refunds": { + post: operations['PostChargesChargeRefund'] + } + '/v1/charges/{charge}/refunds': { /**

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.

*/ - get: operations["GetChargesChargeRefunds"]; + get: operations['GetChargesChargeRefunds'] /**

Create a refund.

*/ - post: operations["PostChargesChargeRefunds"]; - }; - "/v1/charges/{charge}/refunds/{refund}": { + post: operations['PostChargesChargeRefunds'] + } + '/v1/charges/{charge}/refunds/{refund}': { /**

Retrieves the details of an existing refund.

*/ - get: operations["GetChargesChargeRefundsRefund"]; + get: operations['GetChargesChargeRefundsRefund'] /**

Update a specified refund.

*/ - post: operations["PostChargesChargeRefundsRefund"]; - }; - "/v1/checkout/sessions": { + post: operations['PostChargesChargeRefundsRefund'] + } + '/v1/checkout/sessions': { /**

Returns a list of Checkout Sessions.

*/ - get: operations["GetCheckoutSessions"]; + get: operations['GetCheckoutSessions'] /**

Creates a Session object.

*/ - post: operations["PostCheckoutSessions"]; - }; - "/v1/checkout/sessions/{session}": { + post: operations['PostCheckoutSessions'] + } + '/v1/checkout/sessions/{session}': { /**

Retrieves a Session object.

*/ - get: operations["GetCheckoutSessionsSession"]; - }; - "/v1/checkout/sessions/{session}/expire": { + get: operations['GetCheckoutSessionsSession'] + } + '/v1/checkout/sessions/{session}/expire': { /** *

A Session can be expired when it is in one of these statuses: open

* *

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

*/ - post: operations["PostCheckoutSessionsSessionExpire"]; - }; - "/v1/checkout/sessions/{session}/line_items": { + post: operations['PostCheckoutSessionsSessionExpire'] + } + '/v1/checkout/sessions/{session}/line_items': { /**

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.

*/ - get: operations["GetCheckoutSessionsSessionLineItems"]; - }; - "/v1/country_specs": { + get: operations['GetCheckoutSessionsSessionLineItems'] + } + '/v1/country_specs': { /**

Lists all Country Spec objects available in the API.

*/ - get: operations["GetCountrySpecs"]; - }; - "/v1/country_specs/{country}": { + get: operations['GetCountrySpecs'] + } + '/v1/country_specs/{country}': { /**

Returns a Country Spec for a given Country code.

*/ - get: operations["GetCountrySpecsCountry"]; - }; - "/v1/coupons": { + get: operations['GetCountrySpecsCountry'] + } + '/v1/coupons': { /**

Returns a list of your coupons.

*/ - get: operations["GetCoupons"]; + get: operations['GetCoupons'] /** *

You can create coupons easily via the coupon management page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.

* *

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.

*/ - post: operations["PostCoupons"]; - }; - "/v1/coupons/{coupon}": { + post: operations['PostCoupons'] + } + '/v1/coupons/{coupon}': { /**

Retrieves the coupon with the given ID.

*/ - get: operations["GetCouponsCoupon"]; + get: operations['GetCouponsCoupon'] /**

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

*/ - post: operations["PostCouponsCoupon"]; + post: operations['PostCouponsCoupon'] /**

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.

*/ - delete: operations["DeleteCouponsCoupon"]; - }; - "/v1/credit_notes": { + delete: operations['DeleteCouponsCoupon'] + } + '/v1/credit_notes': { /**

Returns a list of credit notes.

*/ - get: operations["GetCreditNotes"]; + get: operations['GetCreditNotes'] /** *

Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces * its amount_due. For a status=paid invoice, a credit note does not affect its amount_due. Instead, it can result @@ -472,63 +472,63 @@ export interface paths { *

You may issue multiple credit notes for an invoice. Each credit note will increment the invoice’s pre_payment_credit_notes_amount * or post_payment_credit_notes_amount depending on its status at the time of credit note creation.

*/ - post: operations["PostCreditNotes"]; - }; - "/v1/credit_notes/preview": { + post: operations['PostCreditNotes'] + } + '/v1/credit_notes/preview': { /**

Get a preview of a credit note without creating it.

*/ - get: operations["GetCreditNotesPreview"]; - }; - "/v1/credit_notes/preview/lines": { + get: operations['GetCreditNotesPreview'] + } + '/v1/credit_notes/preview/lines': { /**

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.

*/ - get: operations["GetCreditNotesPreviewLines"]; - }; - "/v1/credit_notes/{credit_note}/lines": { + get: operations['GetCreditNotesPreviewLines'] + } + '/v1/credit_notes/{credit_note}/lines': { /**

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

*/ - get: operations["GetCreditNotesCreditNoteLines"]; - }; - "/v1/credit_notes/{id}": { + get: operations['GetCreditNotesCreditNoteLines'] + } + '/v1/credit_notes/{id}': { /**

Retrieves the credit note object with the given identifier.

*/ - get: operations["GetCreditNotesId"]; + get: operations['GetCreditNotesId'] /**

Updates an existing credit note.

*/ - post: operations["PostCreditNotesId"]; - }; - "/v1/credit_notes/{id}/void": { + post: operations['PostCreditNotesId'] + } + '/v1/credit_notes/{id}/void': { /**

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

*/ - post: operations["PostCreditNotesIdVoid"]; - }; - "/v1/customers": { + post: operations['PostCreditNotesIdVoid'] + } + '/v1/customers': { /**

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

*/ - get: operations["GetCustomers"]; + get: operations['GetCustomers'] /**

Creates a new customer object.

*/ - post: operations["PostCustomers"]; - }; - "/v1/customers/{customer}": { + post: operations['PostCustomers'] + } + '/v1/customers/{customer}': { /**

Retrieves a Customer object.

*/ - get: operations["GetCustomersCustomer"]; + get: operations['GetCustomersCustomer'] /** *

Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the source parameter, that becomes the customer’s active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the source parameter: for each of the customer’s current subscriptions, if the subscription bills automatically and is in the past_due state, then the latest open invoice for the subscription with automatic collection enabled will be retried. This retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice. Changing the default_source for a customer will not trigger this behavior.

* *

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

*/ - post: operations["PostCustomersCustomer"]; + post: operations['PostCustomersCustomer'] /**

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

*/ - delete: operations["DeleteCustomersCustomer"]; - }; - "/v1/customers/{customer}/balance_transactions": { + delete: operations['DeleteCustomersCustomer'] + } + '/v1/customers/{customer}/balance_transactions': { /**

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

*/ - get: operations["GetCustomersCustomerBalanceTransactions"]; + get: operations['GetCustomersCustomerBalanceTransactions'] /**

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

*/ - post: operations["PostCustomersCustomerBalanceTransactions"]; - }; - "/v1/customers/{customer}/balance_transactions/{transaction}": { + post: operations['PostCustomersCustomerBalanceTransactions'] + } + '/v1/customers/{customer}/balance_transactions/{transaction}': { /**

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

*/ - get: operations["GetCustomersCustomerBalanceTransactionsTransaction"]; + get: operations['GetCustomersCustomerBalanceTransactionsTransaction'] /**

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

*/ - post: operations["PostCustomersCustomerBalanceTransactionsTransaction"]; - }; - "/v1/customers/{customer}/bank_accounts": { + post: operations['PostCustomersCustomerBalanceTransactionsTransaction'] + } + '/v1/customers/{customer}/bank_accounts': { /**

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.

*/ - get: operations["GetCustomersCustomerBankAccounts"]; + get: operations['GetCustomersCustomerBankAccounts'] /** *

When you create a new credit card, you must specify a customer or recipient on which to create it.

* @@ -536,27 +536,27 @@ export interface paths { * 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.

*/ - post: operations["PostCustomersCustomerBankAccounts"]; - }; - "/v1/customers/{customer}/bank_accounts/{id}": { + post: operations['PostCustomersCustomerBankAccounts'] + } + '/v1/customers/{customer}/bank_accounts/{id}': { /**

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.

*/ - get: operations["GetCustomersCustomerBankAccountsId"]; + get: operations['GetCustomersCustomerBankAccountsId'] /**

Update a specified source for a given customer.

*/ - post: operations["PostCustomersCustomerBankAccountsId"]; + post: operations['PostCustomersCustomerBankAccountsId'] /**

Delete a specified source for a given customer.

*/ - delete: operations["DeleteCustomersCustomerBankAccountsId"]; - }; - "/v1/customers/{customer}/bank_accounts/{id}/verify": { + delete: operations['DeleteCustomersCustomerBankAccountsId'] + } + '/v1/customers/{customer}/bank_accounts/{id}/verify': { /**

Verify a specified bank account for a given customer.

*/ - post: operations["PostCustomersCustomerBankAccountsIdVerify"]; - }; - "/v1/customers/{customer}/cards": { + post: operations['PostCustomersCustomerBankAccountsIdVerify'] + } + '/v1/customers/{customer}/cards': { /** *

You can see a list of the cards belonging to a customer. * Note that the 10 most recent sources are always available on the Customer 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 cards.

*/ - get: operations["GetCustomersCustomerCards"]; + get: operations['GetCustomersCustomerCards'] /** *

When you create a new credit card, you must specify a customer or recipient on which to create it.

* @@ -564,28 +564,28 @@ export interface paths { * 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.

*/ - post: operations["PostCustomersCustomerCards"]; - }; - "/v1/customers/{customer}/cards/{id}": { + post: operations['PostCustomersCustomerCards'] + } + '/v1/customers/{customer}/cards/{id}': { /**

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.

*/ - get: operations["GetCustomersCustomerCardsId"]; + get: operations['GetCustomersCustomerCardsId'] /**

Update a specified source for a given customer.

*/ - post: operations["PostCustomersCustomerCardsId"]; + post: operations['PostCustomersCustomerCardsId'] /**

Delete a specified source for a given customer.

*/ - delete: operations["DeleteCustomersCustomerCardsId"]; - }; - "/v1/customers/{customer}/discount": { - get: operations["GetCustomersCustomerDiscount"]; + delete: operations['DeleteCustomersCustomerCardsId'] + } + '/v1/customers/{customer}/discount': { + get: operations['GetCustomersCustomerDiscount'] /**

Removes the currently applied discount on a customer.

*/ - delete: operations["DeleteCustomersCustomerDiscount"]; - }; - "/v1/customers/{customer}/payment_methods": { + delete: operations['DeleteCustomersCustomerDiscount'] + } + '/v1/customers/{customer}/payment_methods': { /**

Returns a list of PaymentMethods for a given Customer

*/ - get: operations["GetCustomersCustomerPaymentMethods"]; - }; - "/v1/customers/{customer}/sources": { + get: operations['GetCustomersCustomerPaymentMethods'] + } + '/v1/customers/{customer}/sources': { /**

List sources for a specified customer.

*/ - get: operations["GetCustomersCustomerSources"]; + get: operations['GetCustomersCustomerSources'] /** *

When you create a new credit card, you must specify a customer or recipient on which to create it.

* @@ -593,31 +593,31 @@ export interface paths { * 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.

*/ - post: operations["PostCustomersCustomerSources"]; - }; - "/v1/customers/{customer}/sources/{id}": { + post: operations['PostCustomersCustomerSources'] + } + '/v1/customers/{customer}/sources/{id}': { /**

Retrieve a specified source for a given customer.

*/ - get: operations["GetCustomersCustomerSourcesId"]; + get: operations['GetCustomersCustomerSourcesId'] /**

Update a specified source for a given customer.

*/ - post: operations["PostCustomersCustomerSourcesId"]; + post: operations['PostCustomersCustomerSourcesId'] /**

Delete a specified source for a given customer.

*/ - delete: operations["DeleteCustomersCustomerSourcesId"]; - }; - "/v1/customers/{customer}/sources/{id}/verify": { + delete: operations['DeleteCustomersCustomerSourcesId'] + } + '/v1/customers/{customer}/sources/{id}/verify': { /**

Verify a specified bank account for a given customer.

*/ - post: operations["PostCustomersCustomerSourcesIdVerify"]; - }; - "/v1/customers/{customer}/subscriptions": { + post: operations['PostCustomersCustomerSourcesIdVerify'] + } + '/v1/customers/{customer}/subscriptions': { /**

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.

*/ - get: operations["GetCustomersCustomerSubscriptions"]; + get: operations['GetCustomersCustomerSubscriptions'] /**

Creates a new subscription on an existing customer.

*/ - post: operations["PostCustomersCustomerSubscriptions"]; - }; - "/v1/customers/{customer}/subscriptions/{subscription_exposed_id}": { + post: operations['PostCustomersCustomerSubscriptions'] + } + '/v1/customers/{customer}/subscriptions/{subscription_exposed_id}': { /**

Retrieves the subscription with the given ID.

*/ - get: operations["GetCustomersCustomerSubscriptionsSubscriptionExposedId"]; + get: operations['GetCustomersCustomerSubscriptionsSubscriptionExposedId'] /**

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.

*/ - post: operations["PostCustomersCustomerSubscriptionsSubscriptionExposedId"]; + post: operations['PostCustomersCustomerSubscriptionsSubscriptionExposedId'] /** *

Cancels a customer’s subscription. If you set the at_period_end parameter to true, the subscription will remain active until the end of the period, at which point it will be canceled and not renewed. Otherwise, with the default false value, the subscription is terminated immediately. In either case, the customer will not be charged again for the subscription.

* @@ -625,108 +625,108 @@ export interface paths { * *

By default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.

*/ - delete: operations["DeleteCustomersCustomerSubscriptionsSubscriptionExposedId"]; - }; - "/v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discount": { - get: operations["GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount"]; + delete: operations['DeleteCustomersCustomerSubscriptionsSubscriptionExposedId'] + } + '/v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discount': { + get: operations['GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount'] /**

Removes the currently applied discount on a customer.

*/ - delete: operations["DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount"]; - }; - "/v1/customers/{customer}/tax_ids": { + delete: operations['DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount'] + } + '/v1/customers/{customer}/tax_ids': { /**

Returns a list of tax IDs for a customer.

*/ - get: operations["GetCustomersCustomerTaxIds"]; + get: operations['GetCustomersCustomerTaxIds'] /**

Creates a new TaxID object for a customer.

*/ - post: operations["PostCustomersCustomerTaxIds"]; - }; - "/v1/customers/{customer}/tax_ids/{id}": { + post: operations['PostCustomersCustomerTaxIds'] + } + '/v1/customers/{customer}/tax_ids/{id}': { /**

Retrieves the TaxID object with the given identifier.

*/ - get: operations["GetCustomersCustomerTaxIdsId"]; + get: operations['GetCustomersCustomerTaxIdsId'] /**

Deletes an existing TaxID object.

*/ - delete: operations["DeleteCustomersCustomerTaxIdsId"]; - }; - "/v1/disputes": { + delete: operations['DeleteCustomersCustomerTaxIdsId'] + } + '/v1/disputes': { /**

Returns a list of your disputes.

*/ - get: operations["GetDisputes"]; - }; - "/v1/disputes/{dispute}": { + get: operations['GetDisputes'] + } + '/v1/disputes/{dispute}': { /**

Retrieves the dispute with the given ID.

*/ - get: operations["GetDisputesDispute"]; + get: operations['GetDisputesDispute'] /** *

When you get a dispute, contacting your customer is always the best first step. If that doesn’t work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your dashboard, but if you prefer, you can use the API to submit evidence programmatically.

* *

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.

*/ - post: operations["PostDisputesDispute"]; - }; - "/v1/disputes/{dispute}/close": { + post: operations['PostDisputesDispute'] + } + '/v1/disputes/{dispute}/close': { /** *

Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.

* *

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

*/ - post: operations["PostDisputesDisputeClose"]; - }; - "/v1/ephemeral_keys": { + post: operations['PostDisputesDisputeClose'] + } + '/v1/ephemeral_keys': { /**

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

*/ - post: operations["PostEphemeralKeys"]; - }; - "/v1/ephemeral_keys/{key}": { + post: operations['PostEphemeralKeys'] + } + '/v1/ephemeral_keys/{key}': { /**

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

*/ - delete: operations["DeleteEphemeralKeysKey"]; - }; - "/v1/events": { + delete: operations['DeleteEphemeralKeysKey'] + } + '/v1/events': { /**

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).

*/ - get: operations["GetEvents"]; - }; - "/v1/events/{id}": { + get: operations['GetEvents'] + } + '/v1/events/{id}': { /**

Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.

*/ - get: operations["GetEventsId"]; - }; - "/v1/exchange_rates": { + get: operations['GetEventsId'] + } + '/v1/exchange_rates': { /**

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.

*/ - get: operations["GetExchangeRates"]; - }; - "/v1/exchange_rates/{rate_id}": { + get: operations['GetExchangeRates'] + } + '/v1/exchange_rates/{rate_id}': { /**

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

*/ - get: operations["GetExchangeRatesRateId"]; - }; - "/v1/file_links": { + get: operations['GetExchangeRatesRateId'] + } + '/v1/file_links': { /**

Returns a list of file links.

*/ - get: operations["GetFileLinks"]; + get: operations['GetFileLinks'] /**

Creates a new file link object.

*/ - post: operations["PostFileLinks"]; - }; - "/v1/file_links/{link}": { + post: operations['PostFileLinks'] + } + '/v1/file_links/{link}': { /**

Retrieves the file link with the given ID.

*/ - get: operations["GetFileLinksLink"]; + get: operations['GetFileLinksLink'] /**

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

*/ - post: operations["PostFileLinksLink"]; - }; - "/v1/files": { + post: operations['PostFileLinksLink'] + } + '/v1/files': { /**

Returns a list of the files that your account has access to. The files are returned sorted by creation date, with the most recently created files appearing first.

*/ - get: operations["GetFiles"]; + get: operations['GetFiles'] /** *

To upload a file to Stripe, you’ll need to send a request of type multipart/form-data. The request should contain the file you would like to upload, as well as the parameters for creating a file.

* *

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

*/ - post: operations["PostFiles"]; - }; - "/v1/files/{file}": { + post: operations['PostFiles'] + } + '/v1/files/{file}': { /**

Retrieves the details of an existing file object. Supply the unique file ID from a file, and Stripe will return the corresponding file object. To access file contents, see the File Upload Guide.

*/ - get: operations["GetFilesFile"]; - }; - "/v1/identity/verification_reports": { + get: operations['GetFilesFile'] + } + '/v1/identity/verification_reports': { /**

List all verification reports.

*/ - get: operations["GetIdentityVerificationReports"]; - }; - "/v1/identity/verification_reports/{report}": { + get: operations['GetIdentityVerificationReports'] + } + '/v1/identity/verification_reports/{report}': { /**

Retrieves an existing VerificationReport

*/ - get: operations["GetIdentityVerificationReportsReport"]; - }; - "/v1/identity/verification_sessions": { + get: operations['GetIdentityVerificationReportsReport'] + } + '/v1/identity/verification_sessions': { /**

Returns a list of VerificationSessions

*/ - get: operations["GetIdentityVerificationSessions"]; + get: operations['GetIdentityVerificationSessions'] /** *

Creates a VerificationSession object.

* @@ -736,33 +736,33 @@ export interface paths { * *

Related guide: Verify your users’ identity documents.

*/ - post: operations["PostIdentityVerificationSessions"]; - }; - "/v1/identity/verification_sessions/{session}": { + post: operations['PostIdentityVerificationSessions'] + } + '/v1/identity/verification_sessions/{session}': { /** *

Retrieves the details of a VerificationSession that was previously created.

* *

When the session status is requires_input, you can use this method to retrieve a valid * client_secret or url to allow re-submission.

*/ - get: operations["GetIdentityVerificationSessionsSession"]; + get: operations['GetIdentityVerificationSessionsSession'] /** *

Updates a VerificationSession object.

* *

When the session status is requires_input, you can use this method to update the * verification check and options.

*/ - post: operations["PostIdentityVerificationSessionsSession"]; - }; - "/v1/identity/verification_sessions/{session}/cancel": { + post: operations['PostIdentityVerificationSessionsSession'] + } + '/v1/identity/verification_sessions/{session}/cancel': { /** *

A VerificationSession object can be canceled when it is in requires_input status.

* *

Once canceled, future submission attempts are disabled. This cannot be undone. Learn more.

*/ - post: operations["PostIdentityVerificationSessionsSessionCancel"]; - }; - "/v1/identity/verification_sessions/{session}/redact": { + post: operations['PostIdentityVerificationSessionsSessionCancel'] + } + '/v1/identity/verification_sessions/{session}/redact': { /** *

Redact a VerificationSession to remove all collected information from Stripe. This will redact * the VerificationSession and all objects related to it, including VerificationReports, Events, @@ -784,29 +784,29 @@ export interface paths { * *

Learn more.

*/ - post: operations["PostIdentityVerificationSessionsSessionRedact"]; - }; - "/v1/invoiceitems": { + post: operations['PostIdentityVerificationSessionsSessionRedact'] + } + '/v1/invoiceitems': { /**

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

*/ - get: operations["GetInvoiceitems"]; + get: operations['GetInvoiceitems'] /**

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.

*/ - post: operations["PostInvoiceitems"]; - }; - "/v1/invoiceitems/{invoiceitem}": { + post: operations['PostInvoiceitems'] + } + '/v1/invoiceitems/{invoiceitem}': { /**

Retrieves the invoice item with the given ID.

*/ - get: operations["GetInvoiceitemsInvoiceitem"]; + get: operations['GetInvoiceitemsInvoiceitem'] /**

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.

*/ - post: operations["PostInvoiceitemsInvoiceitem"]; + post: operations['PostInvoiceitemsInvoiceitem'] /**

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.

*/ - delete: operations["DeleteInvoiceitemsInvoiceitem"]; - }; - "/v1/invoices": { + delete: operations['DeleteInvoiceitemsInvoiceitem'] + } + '/v1/invoices': { /**

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.

*/ - get: operations["GetInvoices"]; + get: operations['GetInvoices'] /**

This endpoint creates a draft invoice for a given customer. The draft invoice created pulls in all pending invoice items on that customer, including prorations. The invoice remains a draft until you finalize the invoice, which allows you to pay or send the invoice to your customers.

*/ - post: operations["PostInvoices"]; - }; - "/v1/invoices/upcoming": { + post: operations['PostInvoices'] + } + '/v1/invoices/upcoming': { /** *

At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.

* @@ -814,15 +814,15 @@ export interface paths { * *

You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass a proration_date parameter when doing the actual subscription update. The value passed in should be the same as the subscription_proration_date returned on the upcoming invoice resource. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_proration_date on the upcoming invoice resource.

*/ - get: operations["GetInvoicesUpcoming"]; - }; - "/v1/invoices/upcoming/lines": { + get: operations['GetInvoicesUpcoming'] + } + '/v1/invoices/upcoming/lines': { /**

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.

*/ - get: operations["GetInvoicesUpcomingLines"]; - }; - "/v1/invoices/{invoice}": { + get: operations['GetInvoicesUpcomingLines'] + } + '/v1/invoices/{invoice}': { /**

Retrieves the invoice with the given ID.

*/ - get: operations["GetInvoicesInvoice"]; + get: operations['GetInvoicesInvoice'] /** *

Draft invoices are fully editable. Once an invoice is finalized, * monetary values, as well as collection_method, become uneditable.

@@ -831,163 +831,163 @@ export interface paths { * sending reminders for, or automatically reconciling invoices, pass * auto_advance=false.

*/ - post: operations["PostInvoicesInvoice"]; + post: operations['PostInvoicesInvoice'] /**

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.

*/ - delete: operations["DeleteInvoicesInvoice"]; - }; - "/v1/invoices/{invoice}/finalize": { + delete: operations['DeleteInvoicesInvoice'] + } + '/v1/invoices/{invoice}/finalize': { /**

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.

*/ - post: operations["PostInvoicesInvoiceFinalize"]; - }; - "/v1/invoices/{invoice}/lines": { + post: operations['PostInvoicesInvoiceFinalize'] + } + '/v1/invoices/{invoice}/lines': { /**

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.

*/ - get: operations["GetInvoicesInvoiceLines"]; - }; - "/v1/invoices/{invoice}/mark_uncollectible": { + get: operations['GetInvoicesInvoiceLines'] + } + '/v1/invoices/{invoice}/mark_uncollectible': { /**

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

*/ - post: operations["PostInvoicesInvoiceMarkUncollectible"]; - }; - "/v1/invoices/{invoice}/pay": { + post: operations['PostInvoicesInvoiceMarkUncollectible'] + } + '/v1/invoices/{invoice}/pay': { /**

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.

*/ - post: operations["PostInvoicesInvoicePay"]; - }; - "/v1/invoices/{invoice}/send": { + post: operations['PostInvoicesInvoicePay'] + } + '/v1/invoices/{invoice}/send': { /** *

Stripe will automatically send invoices to customers according to your subscriptions settings. However, if you’d like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.

* *

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

*/ - post: operations["PostInvoicesInvoiceSend"]; - }; - "/v1/invoices/{invoice}/void": { + post: operations['PostInvoicesInvoiceSend'] + } + '/v1/invoices/{invoice}/void': { /**

Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.

*/ - post: operations["PostInvoicesInvoiceVoid"]; - }; - "/v1/issuer_fraud_records": { + post: operations['PostInvoicesInvoiceVoid'] + } + '/v1/issuer_fraud_records': { /**

Returns a list of issuer fraud records.

*/ - get: operations["GetIssuerFraudRecords"]; - }; - "/v1/issuer_fraud_records/{issuer_fraud_record}": { + get: operations['GetIssuerFraudRecords'] + } + '/v1/issuer_fraud_records/{issuer_fraud_record}': { /** *

Retrieves the details of an issuer fraud record that has previously been created.

* *

Please refer to the issuer fraud record object reference for more details.

*/ - get: operations["GetIssuerFraudRecordsIssuerFraudRecord"]; - }; - "/v1/issuing/authorizations": { + get: operations['GetIssuerFraudRecordsIssuerFraudRecord'] + } + '/v1/issuing/authorizations': { /**

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.

*/ - get: operations["GetIssuingAuthorizations"]; - }; - "/v1/issuing/authorizations/{authorization}": { + get: operations['GetIssuingAuthorizations'] + } + '/v1/issuing/authorizations/{authorization}': { /**

Retrieves an Issuing Authorization object.

*/ - get: operations["GetIssuingAuthorizationsAuthorization"]; + get: operations['GetIssuingAuthorizationsAuthorization'] /**

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

*/ - post: operations["PostIssuingAuthorizationsAuthorization"]; - }; - "/v1/issuing/authorizations/{authorization}/approve": { + post: operations['PostIssuingAuthorizationsAuthorization'] + } + '/v1/issuing/authorizations/{authorization}/approve': { /**

Approves a pending Issuing Authorization object. This request should be made within the timeout window of the real-time authorization flow.

*/ - post: operations["PostIssuingAuthorizationsAuthorizationApprove"]; - }; - "/v1/issuing/authorizations/{authorization}/decline": { + post: operations['PostIssuingAuthorizationsAuthorizationApprove'] + } + '/v1/issuing/authorizations/{authorization}/decline': { /**

Declines a pending Issuing Authorization object. This request should be made within the timeout window of the real time authorization flow.

*/ - post: operations["PostIssuingAuthorizationsAuthorizationDecline"]; - }; - "/v1/issuing/cardholders": { + post: operations['PostIssuingAuthorizationsAuthorizationDecline'] + } + '/v1/issuing/cardholders': { /**

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

*/ - get: operations["GetIssuingCardholders"]; + get: operations['GetIssuingCardholders'] /**

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

*/ - post: operations["PostIssuingCardholders"]; - }; - "/v1/issuing/cardholders/{cardholder}": { + post: operations['PostIssuingCardholders'] + } + '/v1/issuing/cardholders/{cardholder}': { /**

Retrieves an Issuing Cardholder object.

*/ - get: operations["GetIssuingCardholdersCardholder"]; + get: operations['GetIssuingCardholdersCardholder'] /**

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

*/ - post: operations["PostIssuingCardholdersCardholder"]; - }; - "/v1/issuing/cards": { + post: operations['PostIssuingCardholdersCardholder'] + } + '/v1/issuing/cards': { /**

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

*/ - get: operations["GetIssuingCards"]; + get: operations['GetIssuingCards'] /**

Creates an Issuing Card object.

*/ - post: operations["PostIssuingCards"]; - }; - "/v1/issuing/cards/{card}": { + post: operations['PostIssuingCards'] + } + '/v1/issuing/cards/{card}': { /**

Retrieves an Issuing Card object.

*/ - get: operations["GetIssuingCardsCard"]; + get: operations['GetIssuingCardsCard'] /**

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

*/ - post: operations["PostIssuingCardsCard"]; - }; - "/v1/issuing/disputes": { + post: operations['PostIssuingCardsCard'] + } + '/v1/issuing/disputes': { /**

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

*/ - get: operations["GetIssuingDisputes"]; + get: operations['GetIssuingDisputes'] /**

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.

*/ - post: operations["PostIssuingDisputes"]; - }; - "/v1/issuing/disputes/{dispute}": { + post: operations['PostIssuingDisputes'] + } + '/v1/issuing/disputes/{dispute}': { /**

Retrieves an Issuing Dispute object.

*/ - get: operations["GetIssuingDisputesDispute"]; + get: operations['GetIssuingDisputesDispute'] /**

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.

*/ - post: operations["PostIssuingDisputesDispute"]; - }; - "/v1/issuing/disputes/{dispute}/submit": { + post: operations['PostIssuingDisputesDispute'] + } + '/v1/issuing/disputes/{dispute}/submit': { /**

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.

*/ - post: operations["PostIssuingDisputesDisputeSubmit"]; - }; - "/v1/issuing/settlements": { + post: operations['PostIssuingDisputesDisputeSubmit'] + } + '/v1/issuing/settlements': { /**

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

*/ - get: operations["GetIssuingSettlements"]; - }; - "/v1/issuing/settlements/{settlement}": { + get: operations['GetIssuingSettlements'] + } + '/v1/issuing/settlements/{settlement}': { /**

Retrieves an Issuing Settlement object.

*/ - get: operations["GetIssuingSettlementsSettlement"]; + get: operations['GetIssuingSettlementsSettlement'] /**

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

*/ - post: operations["PostIssuingSettlementsSettlement"]; - }; - "/v1/issuing/transactions": { + post: operations['PostIssuingSettlementsSettlement'] + } + '/v1/issuing/transactions': { /**

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.

*/ - get: operations["GetIssuingTransactions"]; - }; - "/v1/issuing/transactions/{transaction}": { + get: operations['GetIssuingTransactions'] + } + '/v1/issuing/transactions/{transaction}': { /**

Retrieves an Issuing Transaction object.

*/ - get: operations["GetIssuingTransactionsTransaction"]; + get: operations['GetIssuingTransactionsTransaction'] /**

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

*/ - post: operations["PostIssuingTransactionsTransaction"]; - }; - "/v1/mandates/{mandate}": { + post: operations['PostIssuingTransactionsTransaction'] + } + '/v1/mandates/{mandate}': { /**

Retrieves a Mandate object.

*/ - get: operations["GetMandatesMandate"]; - }; - "/v1/order_returns": { + get: operations['GetMandatesMandate'] + } + '/v1/order_returns': { /**

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

*/ - get: operations["GetOrderReturns"]; - }; - "/v1/order_returns/{id}": { + get: operations['GetOrderReturns'] + } + '/v1/order_returns/{id}': { /**

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

*/ - get: operations["GetOrderReturnsId"]; - }; - "/v1/orders": { + get: operations['GetOrderReturnsId'] + } + '/v1/orders': { /**

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

*/ - get: operations["GetOrders"]; + get: operations['GetOrders'] /**

Creates a new order object.

*/ - post: operations["PostOrders"]; - }; - "/v1/orders/{id}": { + post: operations['PostOrders'] + } + '/v1/orders/{id}': { /**

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

*/ - get: operations["GetOrdersId"]; + get: operations['GetOrdersId'] /**

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

*/ - post: operations["PostOrdersId"]; - }; - "/v1/orders/{id}/pay": { + post: operations['PostOrdersId'] + } + '/v1/orders/{id}/pay': { /**

Pay an order by providing a source to create a payment.

*/ - post: operations["PostOrdersIdPay"]; - }; - "/v1/orders/{id}/returns": { + post: operations['PostOrdersIdPay'] + } + '/v1/orders/{id}/returns': { /**

Return all or part of an order. The order must have a status of paid or fulfilled before it can be returned. Once all items have been returned, the order will become canceled or returned depending on which status the order started in.

*/ - post: operations["PostOrdersIdReturns"]; - }; - "/v1/payment_intents": { + post: operations['PostOrdersIdReturns'] + } + '/v1/payment_intents': { /**

Returns a list of PaymentIntents.

*/ - get: operations["GetPaymentIntents"]; + get: operations['GetPaymentIntents'] /** *

Creates a PaymentIntent object.

* @@ -1000,9 +1000,9 @@ export interface paths { * available in the confirm API when confirm=true * is supplied.

*/ - post: operations["PostPaymentIntents"]; - }; - "/v1/payment_intents/{intent}": { + post: operations['PostPaymentIntents'] + } + '/v1/payment_intents/{intent}': { /** *

Retrieves the details of a PaymentIntent that has previously been created.

* @@ -1010,7 +1010,7 @@ export interface paths { * *

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

*/ - get: operations["GetPaymentIntentsIntent"]; + get: operations['GetPaymentIntentsIntent'] /** *

Updates properties on a PaymentIntent object without confirming.

* @@ -1020,17 +1020,17 @@ export interface paths { * update and confirm at the same time, we recommend updating properties via * the confirm API instead.

*/ - post: operations["PostPaymentIntentsIntent"]; - }; - "/v1/payment_intents/{intent}/cancel": { + post: operations['PostPaymentIntentsIntent'] + } + '/v1/payment_intents/{intent}/cancel': { /** *

A PaymentIntent object can be canceled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action, or processing.

* *

Once canceled, no additional charges will be made by the PaymentIntent and any operations on the PaymentIntent will fail with an error. For PaymentIntents with status=’requires_capture’, the remaining amount_capturable will automatically be refunded.

*/ - post: operations["PostPaymentIntentsIntentCancel"]; - }; - "/v1/payment_intents/{intent}/capture": { + post: operations['PostPaymentIntentsIntentCancel'] + } + '/v1/payment_intents/{intent}/capture': { /** *

Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.

* @@ -1038,9 +1038,9 @@ export interface paths { * *

Learn more about separate authorization and capture.

*/ - post: operations["PostPaymentIntentsIntentCapture"]; - }; - "/v1/payment_intents/{intent}/confirm": { + post: operations['PostPaymentIntentsIntentCapture'] + } + '/v1/payment_intents/{intent}/confirm': { /** *

Confirm that your customer intends to pay with current or provided * payment method. Upon confirmation, the PaymentIntent will attempt to initiate @@ -1068,45 +1068,45 @@ export interface paths { * attempt. Read the expanded documentation * to learn more about manual confirmation.

*/ - post: operations["PostPaymentIntentsIntentConfirm"]; - }; - "/v1/payment_intents/{intent}/verify_microdeposits": { + post: operations['PostPaymentIntentsIntentConfirm'] + } + '/v1/payment_intents/{intent}/verify_microdeposits': { /**

Verifies microdeposits on a PaymentIntent object.

*/ - post: operations["PostPaymentIntentsIntentVerifyMicrodeposits"]; - }; - "/v1/payment_links": { + post: operations['PostPaymentIntentsIntentVerifyMicrodeposits'] + } + '/v1/payment_links': { /**

Returns a list of your payment links.

*/ - get: operations["GetPaymentLinks"]; + get: operations['GetPaymentLinks'] /**

Creates a payment link.

*/ - post: operations["PostPaymentLinks"]; - }; - "/v1/payment_links/{payment_link}": { + post: operations['PostPaymentLinks'] + } + '/v1/payment_links/{payment_link}': { /**

Retrieve a payment link.

*/ - get: operations["GetPaymentLinksPaymentLink"]; + get: operations['GetPaymentLinksPaymentLink'] /**

Updates a payment link.

*/ - post: operations["PostPaymentLinksPaymentLink"]; - }; - "/v1/payment_links/{payment_link}/line_items": { + post: operations['PostPaymentLinksPaymentLink'] + } + '/v1/payment_links/{payment_link}/line_items': { /**

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.

*/ - get: operations["GetPaymentLinksPaymentLinkLineItems"]; - }; - "/v1/payment_methods": { + get: operations['GetPaymentLinksPaymentLinkLineItems'] + } + '/v1/payment_methods': { /**

Returns a list of PaymentMethods. For listing a customer’s payment methods, you should use List a Customer’s PaymentMethods

*/ - get: operations["GetPaymentMethods"]; + get: operations['GetPaymentMethods'] /** *

Creates a PaymentMethod object. Read the Stripe.js reference to learn how to create PaymentMethods via Stripe.js.

* *

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.

*/ - post: operations["PostPaymentMethods"]; - }; - "/v1/payment_methods/{payment_method}": { + post: operations['PostPaymentMethods'] + } + '/v1/payment_methods/{payment_method}': { /**

Retrieves a PaymentMethod object.

*/ - get: operations["GetPaymentMethodsPaymentMethod"]; + get: operations['GetPaymentMethodsPaymentMethod'] /**

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

*/ - post: operations["PostPaymentMethodsPaymentMethod"]; - }; - "/v1/payment_methods/{payment_method}/attach": { + post: operations['PostPaymentMethodsPaymentMethod'] + } + '/v1/payment_methods/{payment_method}/attach': { /** *

Attaches a PaymentMethod object to a Customer.

* @@ -1120,15 +1120,15 @@ export interface paths { * set invoice_settings.default_payment_method, * on the Customer to the PaymentMethod’s ID.

*/ - post: operations["PostPaymentMethodsPaymentMethodAttach"]; - }; - "/v1/payment_methods/{payment_method}/detach": { + post: operations['PostPaymentMethodsPaymentMethodAttach'] + } + '/v1/payment_methods/{payment_method}/detach': { /**

Detaches a PaymentMethod object from a Customer.

*/ - post: operations["PostPaymentMethodsPaymentMethodDetach"]; - }; - "/v1/payouts": { + post: operations['PostPaymentMethodsPaymentMethodDetach'] + } + '/v1/payouts': { /**

Returns a list of existing payouts sent to third-party bank accounts or that Stripe has sent you. The payouts are returned in sorted order, with the most recently created payouts appearing first.

*/ - get: operations["GetPayouts"]; + get: operations['GetPayouts'] /** *

To send funds to your own bank account, you create a new payout object. Your Stripe balance must be able to cover the payout amount, or you’ll receive an “Insufficient Funds” error.

* @@ -1136,164 +1136,164 @@ export interface paths { * *

If you are creating a manual payout on a Stripe account that uses multiple payment source types, you’ll need to specify the source type balance that the payout should draw from. The balance object details available and pending amounts by source type.

*/ - post: operations["PostPayouts"]; - }; - "/v1/payouts/{payout}": { + post: operations['PostPayouts'] + } + '/v1/payouts/{payout}': { /**

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

*/ - get: operations["GetPayoutsPayout"]; + get: operations['GetPayoutsPayout'] /**

Updates the specified payout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request accepts only the metadata as arguments.

*/ - post: operations["PostPayoutsPayout"]; - }; - "/v1/payouts/{payout}/cancel": { + post: operations['PostPayoutsPayout'] + } + '/v1/payouts/{payout}/cancel': { /**

A previously created payout can be canceled if it has not yet been paid out. Funds will be refunded to your available balance. You may not cancel automatic Stripe payouts.

*/ - post: operations["PostPayoutsPayoutCancel"]; - }; - "/v1/payouts/{payout}/reverse": { + post: operations['PostPayoutsPayoutCancel'] + } + '/v1/payouts/{payout}/reverse': { /** *

Reverses a payout by debiting the destination bank account. Only payouts for connected accounts to US bank accounts may be reversed at this time. If the payout is in the pending status, /v1/payouts/:id/cancel should be used instead.

* *

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

*/ - post: operations["PostPayoutsPayoutReverse"]; - }; - "/v1/plans": { + post: operations['PostPayoutsPayoutReverse'] + } + '/v1/plans': { /**

Returns a list of your plans.

*/ - get: operations["GetPlans"]; + get: operations['GetPlans'] /**

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

*/ - post: operations["PostPlans"]; - }; - "/v1/plans/{plan}": { + post: operations['PostPlans'] + } + '/v1/plans/{plan}': { /**

Retrieves the plan with the given ID.

*/ - get: operations["GetPlansPlan"]; + get: operations['GetPlansPlan'] /**

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.

*/ - post: operations["PostPlansPlan"]; + post: operations['PostPlansPlan'] /**

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

*/ - delete: operations["DeletePlansPlan"]; - }; - "/v1/prices": { + delete: operations['DeletePlansPlan'] + } + '/v1/prices': { /**

Returns a list of your prices.

*/ - get: operations["GetPrices"]; + get: operations['GetPrices'] /**

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

*/ - post: operations["PostPrices"]; - }; - "/v1/prices/{price}": { + post: operations['PostPrices'] + } + '/v1/prices/{price}': { /**

Retrieves the price with the given ID.

*/ - get: operations["GetPricesPrice"]; + get: operations['GetPricesPrice'] /**

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

*/ - post: operations["PostPricesPrice"]; - }; - "/v1/products": { + post: operations['PostPricesPrice'] + } + '/v1/products': { /**

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

*/ - get: operations["GetProducts"]; + get: operations['GetProducts'] /**

Creates a new product object.

*/ - post: operations["PostProducts"]; - }; - "/v1/products/{id}": { + post: operations['PostProducts'] + } + '/v1/products/{id}': { /**

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.

*/ - get: operations["GetProductsId"]; + get: operations['GetProductsId'] /**

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

*/ - post: operations["PostProductsId"]; + post: operations['PostProductsId'] /**

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.

*/ - delete: operations["DeleteProductsId"]; - }; - "/v1/promotion_codes": { + delete: operations['DeleteProductsId'] + } + '/v1/promotion_codes': { /**

Returns a list of your promotion codes.

*/ - get: operations["GetPromotionCodes"]; + get: operations['GetPromotionCodes'] /**

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

*/ - post: operations["PostPromotionCodes"]; - }; - "/v1/promotion_codes/{promotion_code}": { + post: operations['PostPromotionCodes'] + } + '/v1/promotion_codes/{promotion_code}': { /**

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.

*/ - get: operations["GetPromotionCodesPromotionCode"]; + get: operations['GetPromotionCodesPromotionCode'] /**

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

*/ - post: operations["PostPromotionCodesPromotionCode"]; - }; - "/v1/quotes": { + post: operations['PostPromotionCodesPromotionCode'] + } + '/v1/quotes': { /**

Returns a list of your quotes.

*/ - get: operations["GetQuotes"]; + get: operations['GetQuotes'] /**

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.

*/ - post: operations["PostQuotes"]; - }; - "/v1/quotes/{quote}": { + post: operations['PostQuotes'] + } + '/v1/quotes/{quote}': { /**

Retrieves the quote with the given ID.

*/ - get: operations["GetQuotesQuote"]; + get: operations['GetQuotesQuote'] /**

A quote models prices and services for a customer.

*/ - post: operations["PostQuotesQuote"]; - }; - "/v1/quotes/{quote}/accept": { + post: operations['PostQuotesQuote'] + } + '/v1/quotes/{quote}/accept': { /**

Accepts the specified quote.

*/ - post: operations["PostQuotesQuoteAccept"]; - }; - "/v1/quotes/{quote}/cancel": { + post: operations['PostQuotesQuoteAccept'] + } + '/v1/quotes/{quote}/cancel': { /**

Cancels the quote.

*/ - post: operations["PostQuotesQuoteCancel"]; - }; - "/v1/quotes/{quote}/computed_upfront_line_items": { + post: operations['PostQuotesQuoteCancel'] + } + '/v1/quotes/{quote}/computed_upfront_line_items': { /**

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.

*/ - get: operations["GetQuotesQuoteComputedUpfrontLineItems"]; - }; - "/v1/quotes/{quote}/finalize": { + get: operations['GetQuotesQuoteComputedUpfrontLineItems'] + } + '/v1/quotes/{quote}/finalize': { /**

Finalizes the quote.

*/ - post: operations["PostQuotesQuoteFinalize"]; - }; - "/v1/quotes/{quote}/line_items": { + post: operations['PostQuotesQuoteFinalize'] + } + '/v1/quotes/{quote}/line_items': { /**

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.

*/ - get: operations["GetQuotesQuoteLineItems"]; - }; - "/v1/quotes/{quote}/pdf": { + get: operations['GetQuotesQuoteLineItems'] + } + '/v1/quotes/{quote}/pdf': { /**

Download the PDF for a finalized quote

*/ - get: operations["GetQuotesQuotePdf"]; - }; - "/v1/radar/early_fraud_warnings": { + get: operations['GetQuotesQuotePdf'] + } + '/v1/radar/early_fraud_warnings': { /**

Returns a list of early fraud warnings.

*/ - get: operations["GetRadarEarlyFraudWarnings"]; - }; - "/v1/radar/early_fraud_warnings/{early_fraud_warning}": { + get: operations['GetRadarEarlyFraudWarnings'] + } + '/v1/radar/early_fraud_warnings/{early_fraud_warning}': { /** *

Retrieves the details of an early fraud warning that has previously been created.

* *

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

*/ - get: operations["GetRadarEarlyFraudWarningsEarlyFraudWarning"]; - }; - "/v1/radar/value_list_items": { + get: operations['GetRadarEarlyFraudWarningsEarlyFraudWarning'] + } + '/v1/radar/value_list_items': { /**

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

*/ - get: operations["GetRadarValueListItems"]; + get: operations['GetRadarValueListItems'] /**

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

*/ - post: operations["PostRadarValueListItems"]; - }; - "/v1/radar/value_list_items/{item}": { + post: operations['PostRadarValueListItems'] + } + '/v1/radar/value_list_items/{item}': { /**

Retrieves a ValueListItem object.

*/ - get: operations["GetRadarValueListItemsItem"]; + get: operations['GetRadarValueListItemsItem'] /**

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

*/ - delete: operations["DeleteRadarValueListItemsItem"]; - }; - "/v1/radar/value_lists": { + delete: operations['DeleteRadarValueListItemsItem'] + } + '/v1/radar/value_lists': { /**

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

*/ - get: operations["GetRadarValueLists"]; + get: operations['GetRadarValueLists'] /**

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

*/ - post: operations["PostRadarValueLists"]; - }; - "/v1/radar/value_lists/{value_list}": { + post: operations['PostRadarValueLists'] + } + '/v1/radar/value_lists/{value_list}': { /**

Retrieves a ValueList object.

*/ - get: operations["GetRadarValueListsValueList"]; + get: operations['GetRadarValueListsValueList'] /**

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.

*/ - post: operations["PostRadarValueListsValueList"]; + post: operations['PostRadarValueListsValueList'] /**

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.

*/ - delete: operations["DeleteRadarValueListsValueList"]; - }; - "/v1/recipients": { + delete: operations['DeleteRadarValueListsValueList'] + } + '/v1/recipients': { /**

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

*/ - get: operations["GetRecipients"]; + get: operations['GetRecipients'] /** *

Creates a new Recipient object and verifies the recipient’s identity. * Also verifies the recipient’s bank account information or debit card, if either is provided.

*/ - post: operations["PostRecipients"]; - }; - "/v1/recipients/{id}": { + post: operations['PostRecipients'] + } + '/v1/recipients/{id}': { /**

Retrieves the details of an existing recipient. You need only supply the unique recipient identifier that was returned upon recipient creation.

*/ - get: operations["GetRecipientsId"]; + get: operations['GetRecipientsId'] /** *

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

@@ -1301,72 +1301,72 @@ export interface paths { *

If you update the name or tax ID, the identity verification will automatically be rerun. * If you update the bank account, the bank account validation will automatically be rerun.

*/ - post: operations["PostRecipientsId"]; + post: operations['PostRecipientsId'] /**

Permanently deletes a recipient. It cannot be undone.

*/ - delete: operations["DeleteRecipientsId"]; - }; - "/v1/refunds": { + delete: operations['DeleteRecipientsId'] + } + '/v1/refunds': { /**

Returns a list of all refunds you’ve previously created. The refunds are returned in sorted order, with the most recent refunds appearing first. For convenience, the 10 most recent refunds are always available by default on the charge object.

*/ - get: operations["GetRefunds"]; + get: operations['GetRefunds'] /**

Create a refund.

*/ - post: operations["PostRefunds"]; - }; - "/v1/refunds/{refund}": { + post: operations['PostRefunds'] + } + '/v1/refunds/{refund}': { /**

Retrieves the details of an existing refund.

*/ - get: operations["GetRefundsRefund"]; + get: operations['GetRefundsRefund'] /** *

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

* *

This request only accepts metadata as an argument.

*/ - post: operations["PostRefundsRefund"]; - }; - "/v1/reporting/report_runs": { + post: operations['PostRefundsRefund'] + } + '/v1/reporting/report_runs': { /**

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

*/ - get: operations["GetReportingReportRuns"]; + get: operations['GetReportingReportRuns'] /**

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

*/ - post: operations["PostReportingReportRuns"]; - }; - "/v1/reporting/report_runs/{report_run}": { + post: operations['PostReportingReportRuns'] + } + '/v1/reporting/report_runs/{report_run}': { /**

Retrieves the details of an existing Report Run.

*/ - get: operations["GetReportingReportRunsReportRun"]; - }; - "/v1/reporting/report_types": { + get: operations['GetReportingReportRunsReportRun'] + } + '/v1/reporting/report_types': { /**

Returns a full list of Report Types.

*/ - get: operations["GetReportingReportTypes"]; - }; - "/v1/reporting/report_types/{report_type}": { + get: operations['GetReportingReportTypes'] + } + '/v1/reporting/report_types/{report_type}': { /**

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

*/ - get: operations["GetReportingReportTypesReportType"]; - }; - "/v1/reviews": { + get: operations['GetReportingReportTypesReportType'] + } + '/v1/reviews': { /**

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.

*/ - get: operations["GetReviews"]; - }; - "/v1/reviews/{review}": { + get: operations['GetReviews'] + } + '/v1/reviews/{review}': { /**

Retrieves a Review object.

*/ - get: operations["GetReviewsReview"]; - }; - "/v1/reviews/{review}/approve": { + get: operations['GetReviewsReview'] + } + '/v1/reviews/{review}/approve': { /**

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

*/ - post: operations["PostReviewsReviewApprove"]; - }; - "/v1/setup_attempts": { + post: operations['PostReviewsReviewApprove'] + } + '/v1/setup_attempts': { /**

Returns a list of SetupAttempts associated with a provided SetupIntent.

*/ - get: operations["GetSetupAttempts"]; - }; - "/v1/setup_intents": { + get: operations['GetSetupAttempts'] + } + '/v1/setup_intents': { /**

Returns a list of SetupIntents.

*/ - get: operations["GetSetupIntents"]; + get: operations['GetSetupIntents'] /** *

Creates a SetupIntent object.

* *

After the SetupIntent is created, attach a payment method and confirm * to collect any required permissions to charge the payment method later.

*/ - post: operations["PostSetupIntents"]; - }; - "/v1/setup_intents/{intent}": { + post: operations['PostSetupIntents'] + } + '/v1/setup_intents/{intent}': { /** *

Retrieves the details of a SetupIntent that has previously been created.

* @@ -1374,19 +1374,19 @@ export interface paths { * *

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

*/ - get: operations["GetSetupIntentsIntent"]; + get: operations['GetSetupIntentsIntent'] /**

Updates a SetupIntent object.

*/ - post: operations["PostSetupIntentsIntent"]; - }; - "/v1/setup_intents/{intent}/cancel": { + post: operations['PostSetupIntentsIntent'] + } + '/v1/setup_intents/{intent}/cancel': { /** *

A SetupIntent object can be canceled when it is in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.

* *

Once canceled, setup is abandoned and any operations on the SetupIntent will fail with an error.

*/ - post: operations["PostSetupIntentsIntentCancel"]; - }; - "/v1/setup_intents/{intent}/confirm": { + post: operations['PostSetupIntentsIntentCancel'] + } + '/v1/setup_intents/{intent}/confirm': { /** *

Confirm that your customer intends to set up the current or * provided payment method. For example, you would confirm a SetupIntent @@ -1402,103 +1402,103 @@ export interface paths { * the SetupIntent will transition to the * requires_payment_method status.

*/ - post: operations["PostSetupIntentsIntentConfirm"]; - }; - "/v1/setup_intents/{intent}/verify_microdeposits": { + post: operations['PostSetupIntentsIntentConfirm'] + } + '/v1/setup_intents/{intent}/verify_microdeposits': { /**

Verifies microdeposits on a SetupIntent object.

*/ - post: operations["PostSetupIntentsIntentVerifyMicrodeposits"]; - }; - "/v1/shipping_rates": { + post: operations['PostSetupIntentsIntentVerifyMicrodeposits'] + } + '/v1/shipping_rates': { /**

Returns a list of your shipping rates.

*/ - get: operations["GetShippingRates"]; + get: operations['GetShippingRates'] /**

Creates a new shipping rate object.

*/ - post: operations["PostShippingRates"]; - }; - "/v1/shipping_rates/{shipping_rate_token}": { + post: operations['PostShippingRates'] + } + '/v1/shipping_rates/{shipping_rate_token}': { /**

Returns the shipping rate object with the given ID.

*/ - get: operations["GetShippingRatesShippingRateToken"]; + get: operations['GetShippingRatesShippingRateToken'] /**

Updates an existing shipping rate object.

*/ - post: operations["PostShippingRatesShippingRateToken"]; - }; - "/v1/sigma/scheduled_query_runs": { + post: operations['PostShippingRatesShippingRateToken'] + } + '/v1/sigma/scheduled_query_runs': { /**

Returns a list of scheduled query runs.

*/ - get: operations["GetSigmaScheduledQueryRuns"]; - }; - "/v1/sigma/scheduled_query_runs/{scheduled_query_run}": { + get: operations['GetSigmaScheduledQueryRuns'] + } + '/v1/sigma/scheduled_query_runs/{scheduled_query_run}': { /**

Retrieves the details of an scheduled query run.

*/ - get: operations["GetSigmaScheduledQueryRunsScheduledQueryRun"]; - }; - "/v1/skus": { + get: operations['GetSigmaScheduledQueryRunsScheduledQueryRun'] + } + '/v1/skus': { /**

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

*/ - get: operations["GetSkus"]; + get: operations['GetSkus'] /**

Creates a new SKU associated with a product.

*/ - post: operations["PostSkus"]; - }; - "/v1/skus/{id}": { + post: operations['PostSkus'] + } + '/v1/skus/{id}': { /**

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

*/ - get: operations["GetSkusId"]; + get: operations['GetSkusId'] /** *

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

* *

Note that a SKU’s attributes are not editable. Instead, you would need to deactivate the existing SKU and create a new one with the new attribute values.

*/ - post: operations["PostSkusId"]; + post: operations['PostSkusId'] /**

Delete a SKU. Deleting a SKU is only possible until it has been used in an order.

*/ - delete: operations["DeleteSkusId"]; - }; - "/v1/sources": { + delete: operations['DeleteSkusId'] + } + '/v1/sources': { /**

Creates a new source object.

*/ - post: operations["PostSources"]; - }; - "/v1/sources/{source}": { + post: operations['PostSources'] + } + '/v1/sources/{source}': { /**

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.

*/ - get: operations["GetSourcesSource"]; + get: operations['GetSourcesSource'] /** *

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

* *

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.

*/ - post: operations["PostSourcesSource"]; - }; - "/v1/sources/{source}/mandate_notifications/{mandate_notification}": { + post: operations['PostSourcesSource'] + } + '/v1/sources/{source}/mandate_notifications/{mandate_notification}': { /**

Retrieves a new Source MandateNotification.

*/ - get: operations["GetSourcesSourceMandateNotificationsMandateNotification"]; - }; - "/v1/sources/{source}/source_transactions": { + get: operations['GetSourcesSourceMandateNotificationsMandateNotification'] + } + '/v1/sources/{source}/source_transactions': { /**

List source transactions for a given source.

*/ - get: operations["GetSourcesSourceSourceTransactions"]; - }; - "/v1/sources/{source}/source_transactions/{source_transaction}": { + get: operations['GetSourcesSourceSourceTransactions'] + } + '/v1/sources/{source}/source_transactions/{source_transaction}': { /**

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.

*/ - get: operations["GetSourcesSourceSourceTransactionsSourceTransaction"]; - }; - "/v1/sources/{source}/verify": { + get: operations['GetSourcesSourceSourceTransactionsSourceTransaction'] + } + '/v1/sources/{source}/verify': { /**

Verify a given source.

*/ - post: operations["PostSourcesSourceVerify"]; - }; - "/v1/subscription_items": { + post: operations['PostSourcesSourceVerify'] + } + '/v1/subscription_items': { /**

Returns a list of your subscription items for a given subscription.

*/ - get: operations["GetSubscriptionItems"]; + get: operations['GetSubscriptionItems'] /**

Adds a new item to an existing subscription. No existing items will be changed or replaced.

*/ - post: operations["PostSubscriptionItems"]; - }; - "/v1/subscription_items/{item}": { + post: operations['PostSubscriptionItems'] + } + '/v1/subscription_items/{item}': { /**

Retrieves the subscription item with the given ID.

*/ - get: operations["GetSubscriptionItemsItem"]; + get: operations['GetSubscriptionItemsItem'] /**

Updates the plan or quantity of an item on a current subscription.

*/ - post: operations["PostSubscriptionItemsItem"]; + post: operations['PostSubscriptionItemsItem'] /**

Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.

*/ - delete: operations["DeleteSubscriptionItemsItem"]; - }; - "/v1/subscription_items/{subscription_item}/usage_record_summaries": { + delete: operations['DeleteSubscriptionItemsItem'] + } + '/v1/subscription_items/{subscription_item}/usage_record_summaries': { /** *

For the specified subscription item, returns a list of summary objects. Each object in the list provides usage information that’s been summarized from multiple usage records and over a subscription billing period (e.g., 15 usage records in the month of September).

* *

The list is sorted in reverse-chronological order (newest first). The first list item represents the most current usage period that hasn’t ended yet. Since new usage records can still be added, the returned summary information for the subscription item’s ID should be seen as unstable until the subscription billing period ends.

*/ - get: operations["GetSubscriptionItemsSubscriptionItemUsageRecordSummaries"]; - }; - "/v1/subscription_items/{subscription_item}/usage_records": { + get: operations['GetSubscriptionItemsSubscriptionItemUsageRecordSummaries'] + } + '/v1/subscription_items/{subscription_item}/usage_records': { /** *

Creates a usage record for a specified subscription item and date, and fills it with a quantity.

* @@ -1508,39 +1508,39 @@ export interface paths { * *

The default pricing model for metered billing is per-unit pricing. For finer granularity, you can configure metered billing to have a tiered pricing model.

*/ - post: operations["PostSubscriptionItemsSubscriptionItemUsageRecords"]; - }; - "/v1/subscription_schedules": { + post: operations['PostSubscriptionItemsSubscriptionItemUsageRecords'] + } + '/v1/subscription_schedules': { /**

Retrieves the list of your subscription schedules.

*/ - get: operations["GetSubscriptionSchedules"]; + get: operations['GetSubscriptionSchedules'] /**

Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.

*/ - post: operations["PostSubscriptionSchedules"]; - }; - "/v1/subscription_schedules/{schedule}": { + post: operations['PostSubscriptionSchedules'] + } + '/v1/subscription_schedules/{schedule}': { /**

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.

*/ - get: operations["GetSubscriptionSchedulesSchedule"]; + get: operations['GetSubscriptionSchedulesSchedule'] /**

Updates an existing subscription schedule.

*/ - post: operations["PostSubscriptionSchedulesSchedule"]; - }; - "/v1/subscription_schedules/{schedule}/cancel": { + post: operations['PostSubscriptionSchedulesSchedule'] + } + '/v1/subscription_schedules/{schedule}/cancel': { /**

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.

*/ - post: operations["PostSubscriptionSchedulesScheduleCancel"]; - }; - "/v1/subscription_schedules/{schedule}/release": { + post: operations['PostSubscriptionSchedulesScheduleCancel'] + } + '/v1/subscription_schedules/{schedule}/release': { /**

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.

*/ - post: operations["PostSubscriptionSchedulesScheduleRelease"]; - }; - "/v1/subscriptions": { + post: operations['PostSubscriptionSchedulesScheduleRelease'] + } + '/v1/subscriptions': { /**

By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.

*/ - get: operations["GetSubscriptions"]; + get: operations['GetSubscriptions'] /**

Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.

*/ - post: operations["PostSubscriptions"]; - }; - "/v1/subscriptions/{subscription_exposed_id}": { + post: operations['PostSubscriptions'] + } + '/v1/subscriptions/{subscription_exposed_id}': { /**

Retrieves the subscription with the given ID.

*/ - get: operations["GetSubscriptionsSubscriptionExposedId"]; + get: operations['GetSubscriptionsSubscriptionExposedId'] /**

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.

*/ - post: operations["PostSubscriptionsSubscriptionExposedId"]; + post: operations['PostSubscriptionsSubscriptionExposedId'] /** *

Cancels a customer’s subscription immediately. The customer will not be charged again for the subscription.

* @@ -1548,103 +1548,103 @@ export interface paths { * *

By default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.

*/ - delete: operations["DeleteSubscriptionsSubscriptionExposedId"]; - }; - "/v1/subscriptions/{subscription_exposed_id}/discount": { + delete: operations['DeleteSubscriptionsSubscriptionExposedId'] + } + '/v1/subscriptions/{subscription_exposed_id}/discount': { /**

Removes the currently applied discount on a subscription.

*/ - delete: operations["DeleteSubscriptionsSubscriptionExposedIdDiscount"]; - }; - "/v1/tax_codes": { + delete: operations['DeleteSubscriptionsSubscriptionExposedIdDiscount'] + } + '/v1/tax_codes': { /**

A list of all tax codes available to add to Products in order to allow specific tax calculations.

*/ - get: operations["GetTaxCodes"]; - }; - "/v1/tax_codes/{id}": { + get: operations['GetTaxCodes'] + } + '/v1/tax_codes/{id}': { /**

Retrieves the details of an existing tax code. Supply the unique tax code ID and Stripe will return the corresponding tax code information.

*/ - get: operations["GetTaxCodesId"]; - }; - "/v1/tax_rates": { + get: operations['GetTaxCodesId'] + } + '/v1/tax_rates': { /**

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

*/ - get: operations["GetTaxRates"]; + get: operations['GetTaxRates'] /**

Creates a new tax rate.

*/ - post: operations["PostTaxRates"]; - }; - "/v1/tax_rates/{tax_rate}": { + post: operations['PostTaxRates'] + } + '/v1/tax_rates/{tax_rate}': { /**

Retrieves a tax rate with the given ID

*/ - get: operations["GetTaxRatesTaxRate"]; + get: operations['GetTaxRatesTaxRate'] /**

Updates an existing tax rate.

*/ - post: operations["PostTaxRatesTaxRate"]; - }; - "/v1/terminal/connection_tokens": { + post: operations['PostTaxRatesTaxRate'] + } + '/v1/terminal/connection_tokens': { /**

To connect to a reader the Stripe Terminal SDK needs to retrieve a short-lived connection token from Stripe, proxied through your server. On your backend, add an endpoint that creates and returns a connection token.

*/ - post: operations["PostTerminalConnectionTokens"]; - }; - "/v1/terminal/locations": { + post: operations['PostTerminalConnectionTokens'] + } + '/v1/terminal/locations': { /**

Returns a list of Location objects.

*/ - get: operations["GetTerminalLocations"]; + get: operations['GetTerminalLocations'] /** *

Creates a new Location object. * For further details, including which address fields are required in each country, see the Manage locations guide.

*/ - post: operations["PostTerminalLocations"]; - }; - "/v1/terminal/locations/{location}": { + post: operations['PostTerminalLocations'] + } + '/v1/terminal/locations/{location}': { /**

Retrieves a Location object.

*/ - get: operations["GetTerminalLocationsLocation"]; + get: operations['GetTerminalLocationsLocation'] /**

Updates a Location object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ - post: operations["PostTerminalLocationsLocation"]; + post: operations['PostTerminalLocationsLocation'] /**

Deletes a Location object.

*/ - delete: operations["DeleteTerminalLocationsLocation"]; - }; - "/v1/terminal/readers": { + delete: operations['DeleteTerminalLocationsLocation'] + } + '/v1/terminal/readers': { /**

Returns a list of Reader objects.

*/ - get: operations["GetTerminalReaders"]; + get: operations['GetTerminalReaders'] /**

Creates a new Reader object.

*/ - post: operations["PostTerminalReaders"]; - }; - "/v1/terminal/readers/{reader}": { + post: operations['PostTerminalReaders'] + } + '/v1/terminal/readers/{reader}': { /**

Retrieves a Reader object.

*/ - get: operations["GetTerminalReadersReader"]; + get: operations['GetTerminalReadersReader'] /**

Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ - post: operations["PostTerminalReadersReader"]; + post: operations['PostTerminalReadersReader'] /**

Deletes a Reader object.

*/ - delete: operations["DeleteTerminalReadersReader"]; - }; - "/v1/tokens": { + delete: operations['DeleteTerminalReadersReader'] + } + '/v1/tokens': { /** *

Creates a single-use token that represents a bank account’s details. * This token can be used with any API method in place of a bank account dictionary. This token can be used only once, by attaching it to a Custom account.

*/ - post: operations["PostTokens"]; - }; - "/v1/tokens/{token}": { + post: operations['PostTokens'] + } + '/v1/tokens/{token}': { /**

Retrieves the token with the given ID.

*/ - get: operations["GetTokensToken"]; - }; - "/v1/topups": { + get: operations['GetTokensToken'] + } + '/v1/topups': { /**

Returns a list of top-ups.

*/ - get: operations["GetTopups"]; + get: operations['GetTopups'] /**

Top up the balance of an account

*/ - post: operations["PostTopups"]; - }; - "/v1/topups/{topup}": { + post: operations['PostTopups'] + } + '/v1/topups/{topup}': { /**

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.

*/ - get: operations["GetTopupsTopup"]; + get: operations['GetTopupsTopup'] /**

Updates the metadata of a top-up. Other top-up details are not editable by design.

*/ - post: operations["PostTopupsTopup"]; - }; - "/v1/topups/{topup}/cancel": { + post: operations['PostTopupsTopup'] + } + '/v1/topups/{topup}/cancel': { /**

Cancels a top-up. Only pending top-ups can be canceled.

*/ - post: operations["PostTopupsTopupCancel"]; - }; - "/v1/transfers": { + post: operations['PostTopupsTopupCancel'] + } + '/v1/transfers': { /**

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.

*/ - get: operations["GetTransfers"]; + get: operations['GetTransfers'] /**

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.

*/ - post: operations["PostTransfers"]; - }; - "/v1/transfers/{id}/reversals": { + post: operations['PostTransfers'] + } + '/v1/transfers/{id}/reversals': { /**

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.

*/ - get: operations["GetTransfersIdReversals"]; + get: operations['GetTransfersIdReversals'] /** *

When you create a new reversal, you must specify a transfer to create it on.

* @@ -1652,42 +1652,42 @@ export interface paths { * *

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.

*/ - post: operations["PostTransfersIdReversals"]; - }; - "/v1/transfers/{transfer}": { + post: operations['PostTransfersIdReversals'] + } + '/v1/transfers/{transfer}': { /**

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.

*/ - get: operations["GetTransfersTransfer"]; + get: operations['GetTransfersTransfer'] /** *

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

* *

This request accepts only metadata as an argument.

*/ - post: operations["PostTransfersTransfer"]; - }; - "/v1/transfers/{transfer}/reversals/{id}": { + post: operations['PostTransfersTransfer'] + } + '/v1/transfers/{transfer}/reversals/{id}': { /**

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.

*/ - get: operations["GetTransfersTransferReversalsId"]; + get: operations['GetTransfersTransferReversalsId'] /** *

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

* *

This request only accepts metadata and description as arguments.

*/ - post: operations["PostTransfersTransferReversalsId"]; - }; - "/v1/webhook_endpoints": { + post: operations['PostTransfersTransferReversalsId'] + } + '/v1/webhook_endpoints': { /**

Returns a list of your webhook endpoints.

*/ - get: operations["GetWebhookEndpoints"]; + get: operations['GetWebhookEndpoints'] /**

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.

*/ - post: operations["PostWebhookEndpoints"]; - }; - "/v1/webhook_endpoints/{webhook_endpoint}": { + post: operations['PostWebhookEndpoints'] + } + '/v1/webhook_endpoints/{webhook_endpoint}': { /**

Retrieves the webhook endpoint with the given ID.

*/ - get: operations["GetWebhookEndpointsWebhookEndpoint"]; + get: operations['GetWebhookEndpointsWebhookEndpoint'] /**

Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.

*/ - post: operations["PostWebhookEndpointsWebhookEndpoint"]; + post: operations['PostWebhookEndpointsWebhookEndpoint'] /**

You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.

*/ - delete: operations["DeleteWebhookEndpointsWebhookEndpoint"]; - }; + delete: operations['DeleteWebhookEndpointsWebhookEndpoint'] + } } export interface components { @@ -1703,265 +1703,261 @@ export interface components { */ account: { /** @description Business information about the account. */ - business_profile?: - | (Partial & { [key: string]: unknown }) - | null; + business_profile?: (Partial & { [key: string]: unknown }) | null /** * @description The business type. * @enum {string|null} */ - business_type?: ("company" | "government_entity" | "individual" | "non_profit") | null; - capabilities?: components["schemas"]["account_capabilities"]; + business_type?: ('company' | 'government_entity' | 'individual' | 'non_profit') | null + capabilities?: components['schemas']['account_capabilities'] /** @description Whether the account can create live charges. */ - charges_enabled?: boolean; - company?: components["schemas"]["legal_entity_company"]; - controller?: components["schemas"]["account_unification_account_controller"]; + charges_enabled?: boolean + company?: components['schemas']['legal_entity_company'] + controller?: components['schemas']['account_unification_account_controller'] /** @description The account's country. */ - country?: string; + country?: string /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created?: number; + created?: number /** @description 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?: string; + default_currency?: string /** @description Whether account details have been submitted. Standard accounts cannot receive payouts before this is true. */ - details_submitted?: boolean; + details_submitted?: boolean /** @description An email address associated with the account. You can treat this as metadata: it is not used for authentication or messaging account holders. */ - email?: string | null; + email?: string | null /** * ExternalAccountList * @description External accounts (bank accounts and debit cards) currently attached to this account */ external_accounts?: { /** @description The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards. */ - data: ((Partial & Partial) & { - [key: string]: unknown; - })[]; + data: ((Partial & Partial) & { [key: string]: unknown })[] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - future_requirements?: components["schemas"]["account_future_requirements"]; + url: string + } & { [key: string]: unknown } + future_requirements?: components['schemas']['account_future_requirements'] /** @description Unique identifier for the object. */ - id: string; - individual?: components["schemas"]["person"]; + id: string + individual?: components['schemas']['person'] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "account"; + object: 'account' /** @description Whether Stripe can send payouts to this account. */ - payouts_enabled?: boolean; - requirements?: components["schemas"]["account_requirements"]; + payouts_enabled?: boolean + requirements?: components['schemas']['account_requirements'] /** @description Options for customizing how the account functions within Stripe. */ - settings?: (Partial & { [key: string]: unknown }) | null; - tos_acceptance?: components["schemas"]["account_tos_acceptance"]; + settings?: (Partial & { [key: string]: unknown }) | null + tos_acceptance?: components['schemas']['account_tos_acceptance'] /** * @description The Stripe account type. Can be `standard`, `express`, or `custom`. * @enum {string} */ - type?: "custom" | "express" | "standard"; - } & { [key: string]: unknown }; + type?: 'custom' | 'express' | 'standard' + } & { [key: string]: unknown } /** AccountBacsDebitPaymentsSettings */ account_bacs_debit_payments_settings: { /** @description The Bacs Direct Debit Display Name for this account. For payments made with Bacs Direct Debit, this will appear on the mandate, and as the statement descriptor. */ - display_name?: string; - } & { [key: string]: unknown }; + display_name?: string + } & { [key: string]: unknown } /** AccountBrandingSettings */ account_branding_settings: { /** @description (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?: ((Partial & Partial) & { [key: string]: unknown }) | null; + icon?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description (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?: ((Partial & Partial) & { [key: string]: unknown }) | null; + logo?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description A CSS hex color value representing the primary branding color for this account */ - primary_color?: string | null; + primary_color?: string | null /** @description A CSS hex color value representing the secondary branding color for this account */ - secondary_color?: string | null; - } & { [key: string]: unknown }; + secondary_color?: string | null + } & { [key: string]: unknown } /** AccountBusinessProfile */ account_business_profile: { /** @description [The merchant category code for the account](https://stripe.com/docs/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide. */ - mcc?: string | null; + mcc?: string | null /** @description The customer-facing business name. */ - name?: string | null; + name?: string | null /** @description 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?: string | null; + product_description?: string | null /** @description A publicly available mailing address for sending support issues to. */ - support_address?: (Partial & { [key: string]: unknown }) | null; + support_address?: (Partial & { [key: string]: unknown }) | null /** @description A publicly available email address for sending support issues to. */ - support_email?: string | null; + support_email?: string | null /** @description A publicly available phone number to call with support issues. */ - support_phone?: string | null; + support_phone?: string | null /** @description A publicly available website for handling support issues. */ - support_url?: string | null; + support_url?: string | null /** @description The business's publicly available website. */ - url?: string | null; - } & { [key: string]: unknown }; + url?: string | null + } & { [key: string]: unknown } /** AccountCapabilities */ account_capabilities: { /** * @description 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. * @enum {string} */ - acss_debit_payments?: "active" | "inactive" | "pending"; + acss_debit_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the Afterpay Clearpay capability of the account, or whether the account can directly process Afterpay Clearpay charges. * @enum {string} */ - afterpay_clearpay_payments?: "active" | "inactive" | "pending"; + afterpay_clearpay_payments?: 'active' | 'inactive' | 'pending' /** * @description 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. * @enum {string} */ - au_becs_debit_payments?: "active" | "inactive" | "pending"; + au_becs_debit_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the Bacs Direct Debits payments capability of the account, or whether the account can directly process Bacs Direct Debits charges. * @enum {string} */ - bacs_debit_payments?: "active" | "inactive" | "pending"; + bacs_debit_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the Bancontact payments capability of the account, or whether the account can directly process Bancontact charges. * @enum {string} */ - bancontact_payments?: "active" | "inactive" | "pending"; + bancontact_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the boleto payments capability of the account, or whether the account can directly process boleto charges. * @enum {string} */ - boleto_payments?: "active" | "inactive" | "pending"; + boleto_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the card issuing capability of the account, or whether you can use Issuing to distribute funds on cards * @enum {string} */ - card_issuing?: "active" | "inactive" | "pending"; + card_issuing?: 'active' | 'inactive' | 'pending' /** * @description The status of the card payments capability of the account, or whether the account can directly process credit and debit card charges. * @enum {string} */ - card_payments?: "active" | "inactive" | "pending"; + card_payments?: 'active' | 'inactive' | 'pending' /** * @description 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. * @enum {string} */ - cartes_bancaires_payments?: "active" | "inactive" | "pending"; + cartes_bancaires_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the EPS payments capability of the account, or whether the account can directly process EPS charges. * @enum {string} */ - eps_payments?: "active" | "inactive" | "pending"; + eps_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the FPX payments capability of the account, or whether the account can directly process FPX charges. * @enum {string} */ - fpx_payments?: "active" | "inactive" | "pending"; + fpx_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the giropay payments capability of the account, or whether the account can directly process giropay charges. * @enum {string} */ - giropay_payments?: "active" | "inactive" | "pending"; + giropay_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the GrabPay payments capability of the account, or whether the account can directly process GrabPay charges. * @enum {string} */ - grabpay_payments?: "active" | "inactive" | "pending"; + grabpay_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the iDEAL payments capability of the account, or whether the account can directly process iDEAL charges. * @enum {string} */ - ideal_payments?: "active" | "inactive" | "pending"; + ideal_payments?: 'active' | 'inactive' | 'pending' /** * @description 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. * @enum {string} */ - jcb_payments?: "active" | "inactive" | "pending"; + jcb_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the Klarna payments capability of the account, or whether the account can directly process Klarna charges. * @enum {string} */ - klarna_payments?: "active" | "inactive" | "pending"; + klarna_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the legacy payments capability of the account. * @enum {string} */ - legacy_payments?: "active" | "inactive" | "pending"; + legacy_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the OXXO payments capability of the account, or whether the account can directly process OXXO charges. * @enum {string} */ - oxxo_payments?: "active" | "inactive" | "pending"; + oxxo_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the P24 payments capability of the account, or whether the account can directly process P24 charges. * @enum {string} */ - p24_payments?: "active" | "inactive" | "pending"; + p24_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the SEPA Direct Debits payments capability of the account, or whether the account can directly process SEPA Direct Debits charges. * @enum {string} */ - sepa_debit_payments?: "active" | "inactive" | "pending"; + sepa_debit_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the Sofort payments capability of the account, or whether the account can directly process Sofort charges. * @enum {string} */ - sofort_payments?: "active" | "inactive" | "pending"; + sofort_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the tax reporting 1099-K (US) capability of the account. * @enum {string} */ - tax_reporting_us_1099_k?: "active" | "inactive" | "pending"; + tax_reporting_us_1099_k?: 'active' | 'inactive' | 'pending' /** * @description The status of the tax reporting 1099-MISC (US) capability of the account. * @enum {string} */ - tax_reporting_us_1099_misc?: "active" | "inactive" | "pending"; + tax_reporting_us_1099_misc?: 'active' | 'inactive' | 'pending' /** * @description The status of the transfers capability of the account, or whether your platform can transfer funds to the account. * @enum {string} */ - transfers?: "active" | "inactive" | "pending"; - } & { [key: string]: unknown }; + transfers?: 'active' | 'inactive' | 'pending' + } & { [key: string]: unknown } /** AccountCapabilityFutureRequirements */ account_capability_future_requirements: { /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ - alternatives?: components["schemas"]["account_requirements_alternative"][] | null; + alternatives?: components['schemas']['account_requirements_alternative'][] | null /** * Format: unix-time * @description Date on which `future_requirements` merges with 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?: number | null; + current_deadline?: number | null /** @description 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: string[]; + currently_due: string[] /** @description This is typed as a string for consistency with `requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is empty because fields in `future_requirements` will never disable the account. */ - disabled_reason?: string | null; + disabled_reason?: string | null /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ - errors: components["schemas"]["account_requirements_error"][]; + errors: components['schemas']['account_requirements_error'][] /** @description Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well. */ - eventually_due: string[]; + eventually_due: string[] /** @description 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: string[]; + past_due: string[] /** @description Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. */ - pending_verification: string[]; - } & { [key: string]: unknown }; + pending_verification: string[] + } & { [key: string]: unknown } /** AccountCapabilityRequirements */ account_capability_requirements: { /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ - alternatives?: components["schemas"]["account_requirements_alternative"][] | null; + alternatives?: components['schemas']['account_requirements_alternative'][] | null /** * Format: unix-time * @description 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?: number | null; + current_deadline?: number | null /** @description 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: string[]; + currently_due: string[] /** * @description If the capability is disabled, this string describes why. Can be `requirements.past_due`, `requirements.pending_verification`, `listed`, `platform_paused`, `rejected.fraud`, `rejected.listed`, `rejected.terms_of_service`, `rejected.other`, `under_review`, or `other`. * @@ -1971,62 +1967,62 @@ export interface components { * * If you believe that the rejection is in error, please contact support at https://support.stripe.com/contact/ for assistance. */ - disabled_reason?: string | null; + disabled_reason?: string | null /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ - errors: components["schemas"]["account_requirements_error"][]; + errors: components['schemas']['account_requirements_error'][] /** @description Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set. */ - eventually_due: string[]; + eventually_due: string[] /** @description Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the capability on the account. */ - past_due: string[]; + past_due: string[] /** @description Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. */ - pending_verification: string[]; - } & { [key: string]: unknown }; + pending_verification: string[] + } & { [key: string]: unknown } /** AccountCardIssuingSettings */ account_card_issuing_settings: { - tos_acceptance?: components["schemas"]["card_issuing_account_terms_of_service"]; - } & { [key: string]: unknown }; + tos_acceptance?: components['schemas']['card_issuing_account_terms_of_service'] + } & { [key: string]: unknown } /** AccountCardPaymentsSettings */ account_card_payments_settings: { - decline_on?: components["schemas"]["account_decline_charge_on"]; + decline_on?: components['schemas']['account_decline_charge_on'] /** @description 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?: string | null; - } & { [key: string]: unknown }; + statement_descriptor_prefix?: string | null + } & { [key: string]: unknown } /** AccountDashboardSettings */ account_dashboard_settings: { /** @description The display name for this account. This is used on the Stripe Dashboard to differentiate between accounts. */ - display_name?: string | null; + display_name?: string | null /** @description 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?: string | null; - } & { [key: string]: unknown }; + timezone?: string | null + } & { [key: string]: unknown } /** AccountDeclineChargeOn */ account_decline_charge_on: { /** @description 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: boolean; + avs_failure: boolean /** @description 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: boolean; - } & { [key: string]: unknown }; + cvc_failure: boolean + } & { [key: string]: unknown } /** AccountFutureRequirements */ account_future_requirements: { /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ - alternatives?: components["schemas"]["account_requirements_alternative"][] | null; + alternatives?: components['schemas']['account_requirements_alternative'][] | null /** * Format: unix-time * @description Date on which `future_requirements` merges with 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?: number | null; + current_deadline?: number | null /** @description 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?: string[] | null; + currently_due?: string[] | null /** @description This is typed as a string for consistency with `requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is empty because fields in `future_requirements` will never disable the account. */ - disabled_reason?: string | null; + disabled_reason?: string | null /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ - errors?: components["schemas"]["account_requirements_error"][] | null; + errors?: components['schemas']['account_requirements_error'][] | null /** @description Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well. */ - eventually_due?: string[] | null; + eventually_due?: string[] | null /** @description 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?: string[] | null; + past_due?: string[] | null /** @description Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. */ - pending_verification?: string[] | null; - } & { [key: string]: unknown }; + pending_verification?: string[] | null + } & { [key: string]: unknown } /** * AccountLink * @description Account Links are the means by which a Connect platform grants a connected account permission to access @@ -2039,66 +2035,66 @@ export interface components { * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** * Format: unix-time * @description The timestamp at which this account link will expire. */ - expires_at: number; + expires_at: number /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "account_link"; + object: 'account_link' /** @description The URL for the account link. */ - url: string; - } & { [key: string]: unknown }; + url: string + } & { [key: string]: unknown } /** AccountPaymentsSettings */ account_payments_settings: { /** @description 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?: string | null; + statement_descriptor?: string | null /** @description The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only) */ - statement_descriptor_kana?: string | null; + statement_descriptor_kana?: string | null /** @description The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only) */ - statement_descriptor_kanji?: string | null; - } & { [key: string]: unknown }; + statement_descriptor_kanji?: string | null + } & { [key: string]: unknown } /** AccountPayoutSettings */ account_payout_settings: { /** @description A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See our [Understanding Connect Account Balances](https://stripe.com/docs/connect/account-balances) documentation for details. Default value is `false` for Custom accounts, otherwise `true`. */ - debit_negative_balances: boolean; - schedule: components["schemas"]["transfer_schedule"]; + debit_negative_balances: boolean + schedule: components['schemas']['transfer_schedule'] /** @description 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?: string | null; - } & { [key: string]: unknown }; + statement_descriptor?: string | null + } & { [key: string]: unknown } /** AccountRequirements */ account_requirements: { /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ - alternatives?: components["schemas"]["account_requirements_alternative"][] | null; + alternatives?: components['schemas']['account_requirements_alternative'][] | null /** * Format: unix-time * @description 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?: number | null; + current_deadline?: number | null /** @description 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?: string[] | null; + currently_due?: string[] | null /** @description If the account is disabled, this string describes why. Can be `requirements.past_due`, `requirements.pending_verification`, `listed`, `platform_paused`, `rejected.fraud`, `rejected.listed`, `rejected.terms_of_service`, `rejected.other`, `under_review`, or `other`. */ - disabled_reason?: string | null; + disabled_reason?: string | null /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ - errors?: components["schemas"]["account_requirements_error"][] | null; + errors?: components['schemas']['account_requirements_error'][] | null /** @description Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set. */ - eventually_due?: string[] | null; + eventually_due?: string[] | null /** @description Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the account. */ - past_due?: string[] | null; + past_due?: string[] | null /** @description Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. */ - pending_verification?: string[] | null; - } & { [key: string]: unknown }; + pending_verification?: string[] | null + } & { [key: string]: unknown } /** AccountRequirementsAlternative */ account_requirements_alternative: { /** @description Fields that can be provided to satisfy all fields in `original_fields_due`. */ - alternative_fields_due: string[]; + alternative_fields_due: string[] /** @description Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`. */ - original_fields_due: string[]; - } & { [key: string]: unknown }; + original_fields_due: string[] + } & { [key: string]: unknown } /** AccountRequirementsError */ account_requirements_error: { /** @@ -2106,273 +2102,269 @@ export interface components { * @enum {string} */ code: - | "invalid_address_city_state_postal_code" - | "invalid_street_address" - | "invalid_value_other" - | "verification_document_address_mismatch" - | "verification_document_address_missing" - | "verification_document_corrupt" - | "verification_document_country_not_supported" - | "verification_document_dob_mismatch" - | "verification_document_duplicate_type" - | "verification_document_expired" - | "verification_document_failed_copy" - | "verification_document_failed_greyscale" - | "verification_document_failed_other" - | "verification_document_failed_test_mode" - | "verification_document_fraudulent" - | "verification_document_id_number_mismatch" - | "verification_document_id_number_missing" - | "verification_document_incomplete" - | "verification_document_invalid" - | "verification_document_issue_or_expiry_date_missing" - | "verification_document_manipulated" - | "verification_document_missing_back" - | "verification_document_missing_front" - | "verification_document_name_mismatch" - | "verification_document_name_missing" - | "verification_document_nationality_mismatch" - | "verification_document_not_readable" - | "verification_document_not_signed" - | "verification_document_not_uploaded" - | "verification_document_photo_mismatch" - | "verification_document_too_large" - | "verification_document_type_not_supported" - | "verification_failed_address_match" - | "verification_failed_business_iec_number" - | "verification_failed_document_match" - | "verification_failed_id_number_match" - | "verification_failed_keyed_identity" - | "verification_failed_keyed_match" - | "verification_failed_name_match" - | "verification_failed_other" - | "verification_failed_tax_id_match" - | "verification_failed_tax_id_not_issued" - | "verification_missing_executives" - | "verification_missing_owners" - | "verification_requires_additional_memorandum_of_associations"; + | 'invalid_address_city_state_postal_code' + | 'invalid_street_address' + | 'invalid_value_other' + | 'verification_document_address_mismatch' + | 'verification_document_address_missing' + | 'verification_document_corrupt' + | 'verification_document_country_not_supported' + | 'verification_document_dob_mismatch' + | 'verification_document_duplicate_type' + | 'verification_document_expired' + | 'verification_document_failed_copy' + | 'verification_document_failed_greyscale' + | 'verification_document_failed_other' + | 'verification_document_failed_test_mode' + | 'verification_document_fraudulent' + | 'verification_document_id_number_mismatch' + | 'verification_document_id_number_missing' + | 'verification_document_incomplete' + | 'verification_document_invalid' + | 'verification_document_issue_or_expiry_date_missing' + | 'verification_document_manipulated' + | 'verification_document_missing_back' + | 'verification_document_missing_front' + | 'verification_document_name_mismatch' + | 'verification_document_name_missing' + | 'verification_document_nationality_mismatch' + | 'verification_document_not_readable' + | 'verification_document_not_signed' + | 'verification_document_not_uploaded' + | 'verification_document_photo_mismatch' + | 'verification_document_too_large' + | 'verification_document_type_not_supported' + | 'verification_failed_address_match' + | 'verification_failed_business_iec_number' + | 'verification_failed_document_match' + | 'verification_failed_id_number_match' + | 'verification_failed_keyed_identity' + | 'verification_failed_keyed_match' + | 'verification_failed_name_match' + | 'verification_failed_other' + | 'verification_failed_tax_id_match' + | 'verification_failed_tax_id_not_issued' + | 'verification_missing_executives' + | 'verification_missing_owners' + | 'verification_requires_additional_memorandum_of_associations' /** @description An informative message that indicates the error type and provides additional details about the error. */ - reason: string; + reason: string /** @description The specific user onboarding requirement field (in the requirements hash) that needs to be resolved. */ - requirement: string; - } & { [key: string]: unknown }; + requirement: string + } & { [key: string]: unknown } /** AccountSepaDebitPaymentsSettings */ account_sepa_debit_payments_settings: { /** @description SEPA creditor identifier that identifies the company making the payment. */ - creditor_id?: string; - } & { [key: string]: unknown }; + creditor_id?: string + } & { [key: string]: unknown } /** AccountSettings */ account_settings: { - bacs_debit_payments?: components["schemas"]["account_bacs_debit_payments_settings"]; - branding: components["schemas"]["account_branding_settings"]; - card_issuing?: components["schemas"]["account_card_issuing_settings"]; - card_payments: components["schemas"]["account_card_payments_settings"]; - dashboard: components["schemas"]["account_dashboard_settings"]; - payments: components["schemas"]["account_payments_settings"]; - payouts?: components["schemas"]["account_payout_settings"]; - sepa_debit_payments?: components["schemas"]["account_sepa_debit_payments_settings"]; - } & { [key: string]: unknown }; + bacs_debit_payments?: components['schemas']['account_bacs_debit_payments_settings'] + branding: components['schemas']['account_branding_settings'] + card_issuing?: components['schemas']['account_card_issuing_settings'] + card_payments: components['schemas']['account_card_payments_settings'] + dashboard: components['schemas']['account_dashboard_settings'] + payments: components['schemas']['account_payments_settings'] + payouts?: components['schemas']['account_payout_settings'] + sepa_debit_payments?: components['schemas']['account_sepa_debit_payments_settings'] + } & { [key: string]: unknown } /** AccountTOSAcceptance */ account_tos_acceptance: { /** * Format: unix-time * @description The Unix timestamp marking when the account representative accepted their service agreement */ - date?: number | null; + date?: number | null /** @description The IP address from which the account representative accepted their service agreement */ - ip?: string | null; + ip?: string | null /** @description The user's service agreement type */ - service_agreement?: string; + service_agreement?: string /** @description The user agent of the browser from which the account representative accepted their service agreement */ - user_agent?: string | null; - } & { [key: string]: unknown }; + user_agent?: string | null + } & { [key: string]: unknown } /** AccountUnificationAccountController */ account_unification_account_controller: { /** @description `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?: boolean; + is_controller?: boolean /** * @description The controller type. Can be `application`, if a Connect application controls the account, or `account`, if the account controls itself. * @enum {string} */ - type: "account" | "application"; - } & { [key: string]: unknown }; + type: 'account' | 'application' + } & { [key: string]: unknown } /** Address */ address: { /** @description City, district, suburb, town, or village. */ - city?: string | null; + city?: string | null /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ - country?: string | null; + country?: string | null /** @description Address line 1 (e.g., street, PO Box, or company name). */ - line1?: string | null; + line1?: string | null /** @description Address line 2 (e.g., apartment, suite, unit, or building). */ - line2?: string | null; + line2?: string | null /** @description ZIP or postal code. */ - postal_code?: string | null; + postal_code?: string | null /** @description State, county, province, or region. */ - state?: string | null; - } & { [key: string]: unknown }; + state?: string | null + } & { [key: string]: unknown } /** AlipayAccount */ alipay_account: { /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The ID of the customer associated with this Alipay Account. */ customer?: - | ((Partial & - Partial & - Partial) & { [key: string]: unknown }) - | null; + | ((Partial & Partial & Partial) & { + [key: string]: unknown + }) + | null /** @description Uniquely identifies the account and will be the same across all Alipay account objects that are linked to the same Alipay account. */ - fingerprint: string; + fingerprint: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "alipay_account"; + object: 'alipay_account' /** @description If the Alipay account object is not reusable, the exact amount that you can create a charge for. */ - payment_amount?: number | null; + payment_amount?: number | null /** @description If the Alipay account object is not reusable, the exact currency that you can create a charge for. */ - payment_currency?: string | null; + payment_currency?: string | null /** @description True if you can create multiple payments using this account. If the account is reusable, then you can freely choose the amount of each payment. */ - reusable: boolean; + reusable: boolean /** @description Whether this Alipay account object has ever been used for a payment. */ - used: boolean; + used: boolean /** @description The username for the Alipay account. */ - username: string; - } & { [key: string]: unknown }; + username: string + } & { [key: string]: unknown } /** APIErrors */ api_errors: { /** @description For card errors, the ID of the failed charge. */ - charge?: string; + charge?: string /** @description For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported. */ - code?: string; + code?: string /** @description 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?: string; + decline_code?: string /** @description A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported. */ - doc_url?: string; + doc_url?: string /** @description A human-readable message providing more details about the error. For card errors, these messages can be shown to your users. */ - message?: string; + message?: string /** @description 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?: string; - payment_intent?: components["schemas"]["payment_intent"]; - payment_method?: components["schemas"]["payment_method"]; + param?: string + payment_intent?: components['schemas']['payment_intent'] + payment_method?: components['schemas']['payment_method'] /** @description 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?: string; - setup_intent?: components["schemas"]["setup_intent"]; + payment_method_type?: string + setup_intent?: components['schemas']['setup_intent'] /** @description The source object for errors returned on a request involving a source. */ - source?: (Partial & - Partial & - Partial) & { [key: string]: unknown }; + source?: (Partial & + Partial & + Partial) & { [key: string]: unknown } /** * @description The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error` * @enum {string} */ - type: "api_error" | "card_error" | "idempotency_error" | "invalid_request_error"; - } & { [key: string]: unknown }; + type: 'api_error' | 'card_error' | 'idempotency_error' | 'invalid_request_error' + } & { [key: string]: unknown } /** ApplePayDomain */ apple_pay_domain: { /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; - domain_name: string; + created: number + domain_name: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "apple_pay_domain"; - } & { [key: string]: unknown }; + object: 'apple_pay_domain' + } & { [key: string]: unknown } /** Application */ application: { /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The name of the application. */ - name?: string | null; + name?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "application"; - } & { [key: string]: unknown }; + object: 'application' + } & { [key: string]: unknown } /** PlatformFee */ application_fee: { /** @description ID of the Stripe account this fee was taken from. */ - account: (Partial & Partial) & { [key: string]: unknown }; + account: (Partial & Partial) & { [key: string]: unknown } /** @description Amount earned, in %s. */ - amount: number; + amount: number /** @description Amount in %s refunded (can be less than the amount attribute on the fee if a partial refund was issued) */ - amount_refunded: number; + amount_refunded: number /** @description ID of the Connect application that earned the fee. */ - application: (Partial & Partial) & { [key: string]: unknown }; + application: (Partial & Partial) & { [key: string]: unknown } /** @description Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds). */ - balance_transaction?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + balance_transaction?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description ID of the charge that the application fee was taken from. */ - charge: (Partial & Partial) & { [key: string]: unknown }; + charge: (Partial & Partial) & { [key: string]: unknown } /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "application_fee"; + object: 'application_fee' /** @description ID of the corresponding charge on the platform account, if this fee was the result of a charge using the `destination` parameter. */ - originating_transaction?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + originating_transaction?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false. */ - refunded: boolean; + refunded: boolean /** * FeeRefundList * @description A list of refunds that have been applied to the fee. */ refunds: { /** @description Details about each object. */ - data: components["schemas"]["fee_refund"][]; + data: components['schemas']['fee_refund'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + url: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** AutomaticTax */ automatic_tax: { /** @description Whether Stripe automatically computes tax on this invoice. */ - enabled: boolean; + enabled: boolean /** * @description The status of the most recent automated tax calculation for this invoice. * @enum {string|null} */ - status?: ("complete" | "failed" | "requires_location_inputs") | null; - } & { [key: string]: unknown }; + status?: ('complete' | 'failed' | 'requires_location_inputs') | null + } & { [key: string]: unknown } /** * Balance * @description This is an object representing your Stripe balance. You can retrieve it to see @@ -2389,44 +2381,44 @@ export interface components { */ balance: { /** @description Funds that are available to be transferred or paid out, whether automatically by Stripe or explicitly via the [Transfers API](https://stripe.com/docs/api#transfers) or [Payouts API](https://stripe.com/docs/api#payouts). The available balance for each currency and payment type can be found in the `source_types` property. */ - available: components["schemas"]["balance_amount"][]; + available: components['schemas']['balance_amount'][] /** @description Funds held due to negative balances on connected Custom accounts. The connect reserve balance for each currency and payment type can be found in the `source_types` property. */ - connect_reserved?: components["schemas"]["balance_amount"][]; + connect_reserved?: components['schemas']['balance_amount'][] /** @description Funds that can be paid out using Instant Payouts. */ - instant_available?: components["schemas"]["balance_amount"][]; - issuing?: components["schemas"]["balance_detail"]; + instant_available?: components['schemas']['balance_amount'][] + issuing?: components['schemas']['balance_detail'] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "balance"; + object: 'balance' /** @description Funds that are not yet available in the balance, due to the 7-day rolling pay cycle. The pending balance for each currency, and for each payment type, can be found in the `source_types` property. */ - pending: components["schemas"]["balance_amount"][]; - } & { [key: string]: unknown }; + pending: components['schemas']['balance_amount'][] + } & { [key: string]: unknown } /** BalanceAmount */ balance_amount: { /** @description Balance amount. */ - amount: number; + amount: number /** @description 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: string; - source_types?: components["schemas"]["balance_amount_by_source_type"]; - } & { [key: string]: unknown }; + currency: string + source_types?: components['schemas']['balance_amount_by_source_type'] + } & { [key: string]: unknown } /** BalanceAmountBySourceType */ balance_amount_by_source_type: { /** @description Amount for bank account. */ - bank_account?: number; + bank_account?: number /** @description Amount for card. */ - card?: number; + card?: number /** @description Amount for FPX. */ - fpx?: number; - } & { [key: string]: unknown }; + fpx?: number + } & { [key: string]: unknown } /** BalanceDetail */ balance_detail: { /** @description Funds that are available for use. */ - available: components["schemas"]["balance_amount"][]; - } & { [key: string]: unknown }; + available: components['schemas']['balance_amount'][] + } & { [key: string]: unknown } /** * BalanceTransaction * @description Balance transactions represent funds moving through your Stripe account. @@ -2436,98 +2428,98 @@ export interface components { */ balance_transaction: { /** @description Gross amount of the transaction, in %s. */ - amount: number; + amount: number /** * Format: unix-time * @description The date the transaction's net funds will become available in the Stripe balance. */ - available_on: number; + available_on: number /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description The exchange rate used, if applicable, for this transaction. Specifically, if money was converted from currency A to currency B, then the `amount` in currency A, times `exchange_rate`, would be the `amount` in currency B. For example, suppose you charged a customer 10.00 EUR. Then the PaymentIntent's `amount` would be `1000` and `currency` would be `eur`. Suppose this was converted into 12.34 USD in your Stripe account. Then the BalanceTransaction's `amount` would be `1234`, `currency` would be `usd`, and `exchange_rate` would be `1.234`. */ - exchange_rate?: number | null; + exchange_rate?: number | null /** @description Fees (in %s) paid for this transaction. */ - fee: number; + fee: number /** @description Detailed breakdown of fees (in %s) paid for this transaction. */ - fee_details: components["schemas"]["fee"][]; + fee_details: components['schemas']['fee'][] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Net amount of the transaction, in %s. */ - net: number; + net: number /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "balance_transaction"; + object: 'balance_transaction' /** @description [Learn more](https://stripe.com/docs/reports/reporting-categories) about how reporting categories can help you understand balance transactions from an accounting perspective. */ - reporting_category: string; + reporting_category: string /** @description The Stripe object to which this transaction is related. */ source?: | ((Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial) & { [key: string]: unknown }) - | null; + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial) & { [key: string]: unknown }) + | null /** @description If the transaction's net funds are available in the Stripe balance yet. Either `available` or `pending`. */ - status: string; + status: string /** * @description Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `payment`, `payment_failure_refund`, `payment_refund`, `payout`, `payout_cancel`, `payout_failure`, `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](https://stripe.com/docs/reports/balance-transaction-types) about balance transaction types and what they represent. If you are looking to classify transactions for accounting purposes, you might want to consider `reporting_category` instead. * @enum {string} */ type: - | "adjustment" - | "advance" - | "advance_funding" - | "anticipation_repayment" - | "application_fee" - | "application_fee_refund" - | "charge" - | "connect_collection_transfer" - | "contribution" - | "issuing_authorization_hold" - | "issuing_authorization_release" - | "issuing_dispute" - | "issuing_transaction" - | "payment" - | "payment_failure_refund" - | "payment_refund" - | "payout" - | "payout_cancel" - | "payout_failure" - | "refund" - | "refund_failure" - | "reserve_transaction" - | "reserved_funds" - | "stripe_fee" - | "stripe_fx_fee" - | "tax_fee" - | "topup" - | "topup_reversal" - | "transfer" - | "transfer_cancel" - | "transfer_failure" - | "transfer_refund"; - } & { [key: string]: unknown }; + | 'adjustment' + | 'advance' + | 'advance_funding' + | 'anticipation_repayment' + | 'application_fee' + | 'application_fee_refund' + | 'charge' + | 'connect_collection_transfer' + | 'contribution' + | 'issuing_authorization_hold' + | 'issuing_authorization_release' + | 'issuing_dispute' + | 'issuing_transaction' + | 'payment' + | 'payment_failure_refund' + | 'payment_refund' + | 'payout' + | 'payout_cancel' + | 'payout_failure' + | 'refund' + | 'refund_failure' + | 'reserve_transaction' + | 'reserved_funds' + | 'stripe_fee' + | 'stripe_fx_fee' + | 'tax_fee' + | 'topup' + | 'topup_reversal' + | 'transfer' + | 'transfer_cancel' + | 'transfer_failure' + | 'transfer_refund' + } & { [key: string]: unknown } /** * BankAccount * @description These bank accounts are payment methods on `Customer` objects. @@ -2540,99 +2532,99 @@ export interface components { */ bank_account: { /** @description The ID of the account that the bank account is associated with. */ - account?: ((Partial & Partial) & { [key: string]: unknown }) | null; + account?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description The name of the person or business that owns the bank account. */ - account_holder_name?: string | null; + account_holder_name?: string | null /** @description The type of entity that holds the account. This can be either `individual` or `company`. */ - account_holder_type?: string | null; + account_holder_type?: string | null /** @description 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?: string | null; + account_type?: string | null /** @description 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?: ("instant" | "standard")[] | null; + available_payout_methods?: ('instant' | 'standard')[] | null /** @description Name of the bank associated with the routing number (e.g., `WELLS FARGO`). */ - bank_name?: string | null; + bank_name?: string | null /** @description Two-letter ISO code representing the country the bank account is located in. */ - country: string; + country: string /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. */ - currency: string; + currency: string /** @description The ID of the customer that the bank account is associated with. */ customer?: - | ((Partial & - Partial & - Partial) & { [key: string]: unknown }) - | null; + | ((Partial & Partial & Partial) & { + [key: string]: unknown + }) + | null /** @description Whether this bank account is the default external account for its currency. */ - default_for_currency?: boolean | null; + default_for_currency?: boolean | null /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The last four digits of the bank account number. */ - last4: string; + last4: string /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "bank_account"; + object: 'bank_account' /** @description The routing transit number for the bank account. */ - routing_number?: string | null; + routing_number?: string | null /** * @description For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a transfer sent to this bank account fails, we'll set the status to `errored` and will not continue to send transfers until the bank details are updated. * * For external accounts, possible values are `new` and `errored`. Validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply. If a transfer fails, the status is set to `errored` and transfers are stopped until account details are updated. */ - status: string; - } & { [key: string]: unknown }; + status: string + } & { [key: string]: unknown } /** billing_details */ billing_details: { /** @description Billing address. */ - address?: (Partial & { [key: string]: unknown }) | null; + address?: (Partial & { [key: string]: unknown }) | null /** @description Email address. */ - email?: string | null; + email?: string | null /** @description Full name. */ - name?: string | null; + name?: string | null /** @description Billing phone number (including extension). */ - phone?: string | null; - } & { [key: string]: unknown }; + phone?: string | null + } & { [key: string]: unknown } /** * PortalConfiguration * @description A portal configuration describes the functionality and behavior of a portal session. */ - "billing_portal.configuration": { + 'billing_portal.configuration': { /** @description Whether the configuration is active and can be used to create portal sessions. */ - active: boolean; + active: boolean /** @description ID of the Connect Application that created the configuration. */ - application?: string | null; - business_profile: components["schemas"]["portal_business_profile"]; + application?: string | null + business_profile: components['schemas']['portal_business_profile'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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?: string | null; - features: components["schemas"]["portal_features"]; + default_return_url?: string | null + features: components['schemas']['portal_features'] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description 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: boolean; + is_default: boolean /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "billing_portal.configuration"; + object: 'billing_portal.configuration' /** * Format: unix-time * @description Time at which the object was last updated. Measured in seconds since the Unix epoch. */ - updated: number; - } & { [key: string]: unknown }; + updated: number + } & { [key: string]: unknown } /** * PortalSession * @description The Billing customer portal is a Stripe-hosted UI for subscription and @@ -2650,180 +2642,178 @@ export interface components { * * Learn more in the [integration guide](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal). */ - "billing_portal.session": { + 'billing_portal.session': { /** @description The configuration used by this session, describing the features available. */ - configuration: (Partial & Partial) & { - [key: string]: unknown; - }; + configuration: (Partial & Partial) & { [key: string]: unknown } /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The ID of the customer for this session. */ - customer: string; + customer: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description 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. * @enum {string|null} */ locale?: | ( - | "auto" - | "bg" - | "cs" - | "da" - | "de" - | "el" - | "en" - | "en-AU" - | "en-CA" - | "en-GB" - | "en-IE" - | "en-IN" - | "en-NZ" - | "en-SG" - | "es" - | "es-419" - | "et" - | "fi" - | "fil" - | "fr" - | "fr-CA" - | "hr" - | "hu" - | "id" - | "it" - | "ja" - | "ko" - | "lt" - | "lv" - | "ms" - | "mt" - | "nb" - | "nl" - | "pl" - | "pt" - | "pt-BR" - | "ro" - | "ru" - | "sk" - | "sl" - | "sv" - | "th" - | "tr" - | "vi" - | "zh" - | "zh-HK" - | "zh-TW" + | 'auto' + | 'bg' + | 'cs' + | 'da' + | 'de' + | 'el' + | 'en' + | 'en-AU' + | 'en-CA' + | 'en-GB' + | 'en-IE' + | 'en-IN' + | 'en-NZ' + | 'en-SG' + | 'es' + | 'es-419' + | 'et' + | 'fi' + | 'fil' + | 'fr' + | 'fr-CA' + | 'hr' + | 'hu' + | 'id' + | 'it' + | 'ja' + | 'ko' + | 'lt' + | 'lv' + | 'ms' + | 'mt' + | 'nb' + | 'nl' + | 'pl' + | 'pt' + | 'pt-BR' + | 'ro' + | 'ru' + | 'sk' + | 'sl' + | 'sv' + | 'th' + | 'tr' + | 'vi' + | 'zh' + | 'zh-HK' + | 'zh-TW' ) - | null; + | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "billing_portal.session"; + object: 'billing_portal.session' /** @description 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/charges-transfers#on-behalf-of). 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?: string | null; + on_behalf_of?: string | null /** @description The URL to redirect customers to when they click on the portal's link to return to your website. */ - return_url: string; + return_url: string /** @description The short-lived URL of the session that gives customers access to the customer portal. */ - url: string; - } & { [key: string]: unknown }; + url: string + } & { [key: string]: unknown } /** BitcoinReceiver */ bitcoin_receiver: { /** @description True when this bitcoin receiver has received a non-zero amount of bitcoin. */ - active: boolean; + active: boolean /** @description The amount of `currency` that you are collecting as payment. */ - amount: number; + amount: number /** @description The amount of `currency` to which `bitcoin_amount_received` has been converted. */ - amount_received: number; + amount_received: number /** @description The amount of bitcoin that the customer should send to fill the receiver. The `bitcoin_amount` is denominated in Satoshi: there are 10^8 Satoshi in one bitcoin. */ - bitcoin_amount: number; + bitcoin_amount: number /** @description The amount of bitcoin that has been sent by the customer to this receiver. */ - bitcoin_amount_received: number; + bitcoin_amount_received: number /** @description This URI can be displayed to the customer as a clickable link (to activate their bitcoin client) or as a QR code (for mobile wallets). */ - bitcoin_uri: string; + bitcoin_uri: string /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) to which the bitcoin will be converted. */ - currency: string; + currency: string /** @description The customer ID of the bitcoin receiver. */ - customer?: string | null; + customer?: string | null /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description The customer's email address, set by the API call that creates the receiver. */ - email?: string | null; + email?: string | null /** @description This flag is initially false and updates to true when the customer sends the `bitcoin_amount` to this receiver. */ - filled: boolean; + filled: boolean /** @description Unique identifier for the object. */ - id: string; + id: string /** @description A bitcoin address that is specific to this receiver. The customer can send bitcoin to this address to fill the receiver. */ - inbound_address: string; + inbound_address: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "bitcoin_receiver"; + object: 'bitcoin_receiver' /** @description The ID of the payment created from the receiver, if any. Hidden when viewing the receiver with a publishable key. */ - payment?: string | null; + payment?: string | null /** @description The refund address of this bitcoin receiver. */ - refund_address?: string | null; + refund_address?: string | null /** * BitcoinTransactionList * @description A list with one entry for each time that the customer sent bitcoin to the receiver. Hidden when viewing the receiver with a publishable key. */ transactions?: { /** @description Details about each object. */ - data: components["schemas"]["bitcoin_transaction"][]; + data: components['schemas']['bitcoin_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; + url: string + } & { [key: string]: unknown } /** @description This receiver contains uncaptured funds that can be used for a payment or refunded. */ - uncaptured_funds: boolean; + uncaptured_funds: boolean /** @description Indicate if this source is used for payment. */ - used_for_payment?: boolean | null; - } & { [key: string]: unknown }; + used_for_payment?: boolean | null + } & { [key: string]: unknown } /** BitcoinTransaction */ bitcoin_transaction: { /** @description The amount of `currency` that the transaction was converted to in real-time. */ - amount: number; + amount: number /** @description The amount of bitcoin contained in the transaction. */ - bitcoin_amount: number; + bitcoin_amount: number /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) to which this transaction was converted. */ - currency: string; + currency: string /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "bitcoin_transaction"; + object: 'bitcoin_transaction' /** @description The receiver to which this transaction was sent. */ - receiver: string; - } & { [key: string]: unknown }; + receiver: string + } & { [key: string]: unknown } /** * AccountCapability * @description This is an object representing a capability for a Stripe account. @@ -2832,29 +2822,29 @@ export interface components { */ capability: { /** @description The account for which the capability enables functionality. */ - account: (Partial & Partial) & { [key: string]: unknown }; - future_requirements?: components["schemas"]["account_capability_future_requirements"]; + account: (Partial & Partial) & { [key: string]: unknown } + future_requirements?: components['schemas']['account_capability_future_requirements'] /** @description The identifier for the capability. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "capability"; + object: 'capability' /** @description Whether the capability has been requested. */ - requested: boolean; + requested: boolean /** * Format: unix-time * @description Time at which the capability was requested. Measured in seconds since the Unix epoch. */ - requested_at?: number | null; - requirements?: components["schemas"]["account_capability_requirements"]; + requested_at?: number | null + requirements?: components['schemas']['account_capability_requirements'] /** * @description The status of the capability. Can be `active`, `inactive`, `pending`, or `unrequested`. * @enum {string} */ - status: "active" | "disabled" | "inactive" | "pending" | "unrequested"; - } & { [key: string]: unknown }; + status: 'active' | 'disabled' | 'inactive' | 'pending' | 'unrequested' + } & { [key: string]: unknown } /** * Card * @description You can store multiple cards on a customer in order to charge the customer @@ -2865,90 +2855,90 @@ export interface components { */ card: { /** @description 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. */ - account?: ((Partial & Partial) & { [key: string]: unknown }) | null; + account?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description City/District/Suburb/Town/Village. */ - address_city?: string | null; + address_city?: string | null /** @description Billing address country, if provided when creating card. */ - address_country?: string | null; + address_country?: string | null /** @description Address line 1 (Street address/PO Box/Company name). */ - address_line1?: string | null; + address_line1?: string | null /** @description If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. */ - address_line1_check?: string | null; + address_line1_check?: string | null /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - address_line2?: string | null; + address_line2?: string | null /** @description State/County/Province/Region. */ - address_state?: string | null; + address_state?: string | null /** @description ZIP or postal code. */ - address_zip?: string | null; + address_zip?: string | null /** @description If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. */ - address_zip_check?: string | null; + address_zip_check?: string | null /** @description 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?: ("instant" | "standard")[] | null; + available_payout_methods?: ('instant' | 'standard')[] | null /** @description Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`. */ - brand: string; + brand: string /** @description 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?: string | null; + country?: string | null /** @description Three-letter [ISO code for currency](https://stripe.com/docs/payouts). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. */ - currency?: string | null; + currency?: string | null /** @description 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?: - | ((Partial & - Partial & - Partial) & { [key: string]: unknown }) - | null; + | ((Partial & Partial & Partial) & { + [key: string]: unknown + }) + | null /** @description 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?: string | null; + cvc_check?: string | null /** @description Whether this card is the default external account for its currency. */ - default_for_currency?: boolean | null; + default_for_currency?: boolean | null /** @description (For tokenized numbers only.) The last four digits of the device account number. */ - dynamic_last4?: string | null; + dynamic_last4?: string | null /** @description Two-digit number representing the card's expiration month. */ - exp_month: number; + exp_month: number /** @description Four-digit number representing the card's expiration year. */ - exp_year: number; + exp_year: number /** * @description 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. * * *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.* */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ - funding: string; + funding: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The last four digits of the card. */ - last4: string; + last4: string /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** @description Cardholder name. */ - name?: string | null; + name?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "card"; + object: 'card' /** @description The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead. */ - recipient?: ((Partial & Partial) & { [key: string]: unknown }) | null; + recipient?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description 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?: string | null; - } & { [key: string]: unknown }; + tokenization_method?: string | null + } & { [key: string]: unknown } /** card_generated_from_payment_method_details */ card_generated_from_payment_method_details: { - card_present?: components["schemas"]["payment_method_details_card_present"]; + card_present?: components['schemas']['payment_method_details_card_present'] /** @description The type of payment method transaction-specific details from the transaction that generated this `card` payment method. Always `card_present`. */ - type: string; - } & { [key: string]: unknown }; + type: string + } & { [key: string]: unknown } /** CardIssuingAccountTermsOfService */ card_issuing_account_terms_of_service: { /** @description The Unix timestamp marking when the account representative accepted the service agreement. */ - date?: number | null; + date?: number | null /** @description The IP address from which the account representative accepted the service agreement. */ - ip?: string | null; + ip?: string | null /** @description The user agent of the browser from which the account representative accepted the service agreement. */ - user_agent?: string; - } & { [key: string]: unknown }; + user_agent?: string + } & { [key: string]: unknown } /** card_mandate_payment_method_details */ - card_mandate_payment_method_details: { [key: string]: unknown }; + card_mandate_payment_method_details: { [key: string]: unknown } /** * Charge * @description To charge a credit or a debit card, you create a `Charge` object. You can @@ -2959,166 +2949,152 @@ export interface components { */ charge: { /** @description 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: number; + amount: number /** @description Amount in %s captured (can be less than the amount attribute on the charge if a partial capture was made). */ - amount_captured: number; + amount_captured: number /** @description Amount in %s refunded (can be less than the amount attribute on the charge if a partial refund was issued). */ - amount_refunded: number; + amount_refunded: number /** @description ID of the Connect application that created the charge. */ - application?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + application?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description The application fee (if any) for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees) for details. */ - application_fee?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + application_fee?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description The amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees) for details. */ - application_fee_amount?: number | null; + application_fee_amount?: number | null /** @description ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes). */ - balance_transaction?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; - billing_details: components["schemas"]["billing_details"]; + balance_transaction?: ((Partial & Partial) & { [key: string]: unknown }) | null + billing_details: components['schemas']['billing_details'] /** @description 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. */ - calculated_statement_descriptor?: string | null; + calculated_statement_descriptor?: string | null /** @description If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured. */ - captured: boolean; + captured: boolean /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description ID of the customer this charge is for if one exists. */ customer?: - | ((Partial & - Partial & - Partial) & { [key: string]: unknown }) - | null; + | ((Partial & Partial & Partial) & { + [key: string]: unknown + }) + | null /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description Whether the charge has been disputed. */ - disputed: boolean; + disputed: boolean /** @description Error code explaining reason for charge failure if available (see [the errors section](https://stripe.com/docs/api#errors) for a list of codes). */ - failure_code?: string | null; + failure_code?: string | null /** @description Message to user further explaining reason for charge failure if available. */ - failure_message?: string | null; + failure_message?: string | null /** @description Information on fraud assessments for the charge. */ - fraud_details?: (Partial & { [key: string]: unknown }) | null; + fraud_details?: (Partial & { [key: string]: unknown }) | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description ID of the invoice this charge is for if one exists. */ - invoice?: ((Partial & Partial) & { [key: string]: unknown }) | null; + invoice?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "charge"; + object: 'charge' /** @description 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/charges-transfers) for details. */ - on_behalf_of?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + on_behalf_of?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description ID of the order this charge is for if one exists. */ - order?: ((Partial & Partial) & { [key: string]: unknown }) | null; + order?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description Details about whether the payment was accepted, and why. See [understanding declines](https://stripe.com/docs/declines) for details. */ - outcome?: (Partial & { [key: string]: unknown }) | null; + outcome?: (Partial & { [key: string]: unknown }) | null /** @description `true` if the charge succeeded, or was successfully authorized for later capture. */ - paid: boolean; + paid: boolean /** @description ID of the PaymentIntent associated with this charge, if one exists. */ - payment_intent?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + payment_intent?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description ID of the payment method used in this charge. */ - payment_method?: string | null; + payment_method?: string | null /** @description Details about the payment method at the time of the transaction. */ - payment_method_details?: - | (Partial & { [key: string]: unknown }) - | null; + payment_method_details?: (Partial & { [key: string]: unknown }) | null /** @description This is the email address that the receipt for this charge was sent to. */ - receipt_email?: string | null; + receipt_email?: string | null /** @description 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?: string | null; + receipt_number?: string | null /** @description 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?: string | null; + receipt_url?: string | null /** @description Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false. */ - refunded: boolean; + refunded: boolean /** * RefundList * @description A list of refunds that have been applied to the charge. */ refunds: { /** @description Details about each object. */ - data: components["schemas"]["refund"][]; + data: components['schemas']['refund'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; + url: string + } & { [key: string]: unknown } /** @description ID of the review associated with this charge if one exists. */ - review?: ((Partial & Partial) & { [key: string]: unknown }) | null; + review?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description Shipping information for the charge. */ - shipping?: (Partial & { [key: string]: unknown }) | null; + shipping?: (Partial & { [key: string]: unknown }) | null /** @description The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details. */ - source_transfer?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + source_transfer?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - statement_descriptor?: string | null; + statement_descriptor?: string | null /** @description Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - statement_descriptor_suffix?: string | null; + statement_descriptor_suffix?: string | null /** * @description The status of the payment is either `succeeded`, `pending`, or `failed`. * @enum {string} */ - status: "failed" | "pending" | "succeeded"; + status: 'failed' | 'pending' | 'succeeded' /** @description ID of the transfer to the `destination` account (only applicable if the charge was created using the `destination` parameter). */ - transfer?: (Partial & Partial) & { [key: string]: unknown }; + transfer?: (Partial & Partial) & { [key: string]: unknown } /** @description 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?: (Partial & { [key: string]: unknown }) | null; + transfer_data?: (Partial & { [key: string]: unknown }) | null /** @description A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-options) for details. */ - transfer_group?: string | null; - } & { [key: string]: unknown }; + transfer_group?: string | null + } & { [key: string]: unknown } /** ChargeFraudDetails */ charge_fraud_details: { /** @description Assessments from Stripe. If set, the value is `fraudulent`. */ - stripe_report?: string; + stripe_report?: string /** @description Assessments reported by you. If set, possible values of are `safe` and `fraudulent`. */ - user_report?: string; - } & { [key: string]: unknown }; + user_report?: string + } & { [key: string]: unknown } /** ChargeOutcome */ charge_outcome: { /** @description 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?: string | null; + network_status?: string | null /** @description 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?: string | null; + reason?: string | null /** @description 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?: string; + risk_level?: string /** @description 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?: number; + risk_score?: number /** @description The ID of the Radar rule that matched the payment, if applicable. */ - rule?: (Partial & Partial) & { [key: string]: unknown }; + rule?: (Partial & Partial) & { [key: string]: unknown } /** @description A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer. */ - seller_message?: string | null; + seller_message?: string | null /** @description 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: string; - } & { [key: string]: unknown }; + type: string + } & { [key: string]: unknown } /** ChargeTransferData */ charge_transfer_data: { /** @description The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account. */ - amount?: number | null; + amount?: number | null /** @description ID of an existing, connected Stripe account to transfer funds to if `transfer_data` was specified in the charge request. */ - destination: (Partial & Partial) & { [key: string]: unknown }; - } & { [key: string]: unknown }; + destination: (Partial & Partial) & { [key: string]: unknown } + } & { [key: string]: unknown } /** * Session * @description A Checkout Session represents your customer's session as they pay for @@ -3136,45 +3112,35 @@ export interface components { * * Related guide: [Checkout Server Quickstart](https://stripe.com/docs/payments/checkout/api). */ - "checkout.session": { + 'checkout.session': { /** @description When set, provides configuration for actions to take if this Checkout Session expires. */ - after_expiration?: - | (Partial & { - [key: string]: unknown; - }) - | null; + after_expiration?: (Partial & { [key: string]: unknown }) | null /** @description Enables user redeemable promotion codes. */ - allow_promotion_codes?: boolean | null; + allow_promotion_codes?: boolean | null /** @description Total of all items before discounts or taxes are applied. */ - amount_subtotal?: number | null; + amount_subtotal?: number | null /** @description Total of all items after discounts and taxes are applied. */ - amount_total?: number | null; - automatic_tax: components["schemas"]["payment_pages_checkout_session_automatic_tax"]; + amount_total?: number | null + automatic_tax: components['schemas']['payment_pages_checkout_session_automatic_tax'] /** * @description Describes whether Checkout should collect the customer's billing address. * @enum {string|null} */ - billing_address_collection?: ("auto" | "required") | null; + billing_address_collection?: ('auto' | 'required') | null /** @description The URL the customer will be directed to if they decide to cancel payment and return to your website. */ - cancel_url: string; + cancel_url: string /** * @description A unique string to reference the Checkout Session. This can be a * customer ID, a cart ID, or similar, and can be used to reconcile the * Session with your internal systems. */ - client_reference_id?: string | null; + client_reference_id?: string | null /** @description Results of `consent_collection` for this session. */ - consent?: - | (Partial & { [key: string]: unknown }) - | null; + consent?: (Partial & { [key: string]: unknown }) | null /** @description When set, provides configuration for the Checkout Session to gather active consent from customers. */ - consent_collection?: - | (Partial & { - [key: string]: unknown; - }) - | null; + consent_collection?: (Partial & { [key: string]: unknown }) | null /** @description 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?: string | null; + currency?: string | null /** * @description The ID of the customer for this Session. * For Checkout Sessions in `payment` or `subscription` mode, Checkout @@ -3183,21 +3149,17 @@ export interface components { * the Session was created. */ customer?: - | ((Partial & - Partial & - Partial) & { [key: string]: unknown }) - | null; + | ((Partial & Partial & Partial) & { + [key: string]: unknown + }) + | null /** * @description Configure whether a Checkout Session creates a Customer when the Checkout Session completes. * @enum {string|null} */ - customer_creation?: ("always" | "if_required") | null; + customer_creation?: ('always' | 'if_required') | null /** @description The customer details including the customer's tax exempt status and the customer's tax IDs. Only present on Sessions in `payment` or `subscription` mode. */ - customer_details?: - | (Partial & { - [key: string]: unknown; - }) - | null; + customer_details?: (Partial & { [key: string]: unknown }) | null /** * @description 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. @@ -3205,146 +3167,134 @@ export interface components { * on file. To access information about the customer once the payment flow is * complete, use the `customer` attribute. */ - customer_email?: string | null; + customer_email?: string | null /** * Format: unix-time * @description The timestamp at which the Checkout Session will expire. */ - expires_at: number; + expires_at: number /** * @description Unique identifier for the object. Used to pass to `redirectToCheckout` * in Stripe.js. */ - id: string; + id: string /** * PaymentPagesCheckoutSessionListLineItems * @description The line items purchased by the customer. */ line_items?: { /** @description Details about each object. */ - data: components["schemas"]["item"][]; + data: components['schemas']['item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; + url: string + } & { [key: string]: unknown } /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used. * @enum {string|null} */ locale?: | ( - | "auto" - | "bg" - | "cs" - | "da" - | "de" - | "el" - | "en" - | "en-GB" - | "es" - | "es-419" - | "et" - | "fi" - | "fil" - | "fr" - | "fr-CA" - | "hr" - | "hu" - | "id" - | "it" - | "ja" - | "ko" - | "lt" - | "lv" - | "ms" - | "mt" - | "nb" - | "nl" - | "pl" - | "pt" - | "pt-BR" - | "ro" - | "ru" - | "sk" - | "sl" - | "sv" - | "th" - | "tr" - | "vi" - | "zh" - | "zh-HK" - | "zh-TW" + | 'auto' + | 'bg' + | 'cs' + | 'da' + | 'de' + | 'el' + | 'en' + | 'en-GB' + | 'es' + | 'es-419' + | 'et' + | 'fi' + | 'fil' + | 'fr' + | 'fr-CA' + | 'hr' + | 'hu' + | 'id' + | 'it' + | 'ja' + | 'ko' + | 'lt' + | 'lv' + | 'ms' + | 'mt' + | 'nb' + | 'nl' + | 'pl' + | 'pt' + | 'pt-BR' + | 'ro' + | 'ru' + | 'sk' + | 'sl' + | 'sv' + | 'th' + | 'tr' + | 'vi' + | 'zh' + | 'zh-HK' + | 'zh-TW' ) - | null; + | null /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description The mode of the Checkout Session. * @enum {string} */ - mode: "payment" | "setup" | "subscription"; + mode: 'payment' | 'setup' | 'subscription' /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "checkout.session"; + object: 'checkout.session' /** @description The ID of the PaymentIntent for Checkout Sessions in `payment` mode. */ - payment_intent?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + payment_intent?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description The ID of the Payment Link that created this Session. */ - payment_link?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + payment_link?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession. */ - payment_method_options?: - | (Partial & { [key: string]: unknown }) - | null; + payment_method_options?: (Partial & { [key: string]: unknown }) | null /** * @description A list of the types of payment methods (e.g. card) this Checkout * Session is allowed to accept. */ - payment_method_types: string[]; + payment_method_types: string[] /** * @description The payment status of the Checkout Session, one of `paid`, `unpaid`, or `no_payment_required`. * You can use this value to decide when to fulfill your customer's order. * @enum {string} */ - payment_status: "no_payment_required" | "paid" | "unpaid"; - phone_number_collection?: components["schemas"]["payment_pages_checkout_session_phone_number_collection"]; + payment_status: 'no_payment_required' | 'paid' | 'unpaid' + phone_number_collection?: components['schemas']['payment_pages_checkout_session_phone_number_collection'] /** @description The ID of the original expired Checkout Session that triggered the recovery flow. */ - recovered_from?: string | null; + recovered_from?: string | null /** @description The ID of the SetupIntent for Checkout Sessions in `setup` mode. */ - setup_intent?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + setup_intent?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description Shipping information for this Checkout Session. */ - shipping?: (Partial & { [key: string]: unknown }) | null; + shipping?: (Partial & { [key: string]: unknown }) | null /** @description When set, provides configuration for Checkout to collect a shipping address from a customer. */ shipping_address_collection?: - | (Partial & { - [key: string]: unknown; - }) - | null; + | (Partial & { [key: string]: unknown }) + | null /** @description The shipping rate options applied to this Session. */ - shipping_options: components["schemas"]["payment_pages_checkout_session_shipping_option"][]; + shipping_options: components['schemas']['payment_pages_checkout_session_shipping_option'][] /** @description The ID of the ShippingRate for Checkout Sessions in `payment` mode. */ - shipping_rate?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + shipping_rate?: ((Partial & Partial) & { [key: string]: unknown }) | null /** * @description The status of the Checkout Session, one of `open`, `complete`, or `expired`. * @enum {string|null} */ - status?: ("complete" | "expired" | "open") | null; + status?: ('complete' | 'expired' | 'open') | null /** * @description Describes the type of transaction being performed by Checkout in order to customize * relevant text on the page, such as the submit button. `submit_type` can only be @@ -3352,91 +3302,87 @@ export interface components { * in `subscription` or `setup` mode. * @enum {string|null} */ - submit_type?: ("auto" | "book" | "donate" | "pay") | null; + submit_type?: ('auto' | 'book' | 'donate' | 'pay') | null /** @description The ID of the subscription for Checkout Sessions in `subscription` mode. */ - subscription?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + subscription?: ((Partial & Partial) & { [key: string]: unknown }) | null /** * @description The URL the customer will be directed to after the payment or * subscription creation is successful. */ - success_url: string; - tax_id_collection?: components["schemas"]["payment_pages_checkout_session_tax_id_collection"]; + success_url: string + tax_id_collection?: components['schemas']['payment_pages_checkout_session_tax_id_collection'] /** @description Tax and discount details for the computed total amount. */ - total_details?: - | (Partial & { [key: string]: unknown }) - | null; + total_details?: (Partial & { [key: string]: unknown }) | null /** @description The URL to the Checkout Session. */ - url?: string | null; - } & { [key: string]: unknown }; + url?: string | null + } & { [key: string]: unknown } /** CheckoutAcssDebitMandateOptions */ checkout_acss_debit_mandate_options: { /** @description A URL for custom mandate text */ - custom_mandate_url?: string; + custom_mandate_url?: string /** @description List of Stripe products where this mandate can be selected automatically. Returned when the Session is in `setup` mode. */ - default_for?: ("invoice" | "subscription")[]; + default_for?: ('invoice' | 'subscription')[] /** @description Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. */ - interval_description?: string | null; + interval_description?: string | null /** * @description Payment schedule for the mandate. * @enum {string|null} */ - payment_schedule?: ("combined" | "interval" | "sporadic") | null; + payment_schedule?: ('combined' | 'interval' | 'sporadic') | null /** * @description Transaction type of the mandate. * @enum {string|null} */ - transaction_type?: ("business" | "personal") | null; - } & { [key: string]: unknown }; + transaction_type?: ('business' | 'personal') | null + } & { [key: string]: unknown } /** CheckoutAcssDebitPaymentMethodOptions */ checkout_acss_debit_payment_method_options: { /** * @description Currency supported by the bank account. Returned when the Session is in `setup` mode. * @enum {string} */ - currency?: "cad" | "usd"; - mandate_options?: components["schemas"]["checkout_acss_debit_mandate_options"]; + currency?: 'cad' | 'usd' + mandate_options?: components['schemas']['checkout_acss_debit_mandate_options'] /** * @description Bank account verification method. * @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; - } & { [key: string]: unknown }; + verification_method?: 'automatic' | 'instant' | 'microdeposits' + } & { [key: string]: unknown } /** CheckoutBoletoPaymentMethodOptions */ checkout_boleto_payment_method_options: { /** @description 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: number; - } & { [key: string]: unknown }; + expires_after_days: number + } & { [key: string]: unknown } /** CheckoutOxxoPaymentMethodOptions */ checkout_oxxo_payment_method_options: { /** @description 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: number; - } & { [key: string]: unknown }; + expires_after_days: number + } & { [key: string]: unknown } /** CheckoutSessionPaymentMethodOptions */ checkout_session_payment_method_options: { - acss_debit?: components["schemas"]["checkout_acss_debit_payment_method_options"]; - boleto?: components["schemas"]["checkout_boleto_payment_method_options"]; - oxxo?: components["schemas"]["checkout_oxxo_payment_method_options"]; - } & { [key: string]: unknown }; + acss_debit?: components['schemas']['checkout_acss_debit_payment_method_options'] + boleto?: components['schemas']['checkout_boleto_payment_method_options'] + oxxo?: components['schemas']['checkout_oxxo_payment_method_options'] + } & { [key: string]: unknown } /** ConnectCollectionTransfer */ connect_collection_transfer: { /** @description Amount transferred, in %s. */ - amount: number; + amount: number /** @description 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: string; + currency: string /** @description ID of the account that funds are being collected for. */ - destination: (Partial & Partial) & { [key: string]: unknown }; + destination: (Partial & Partial) & { [key: string]: unknown } /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "connect_collection_transfer"; - } & { [key: string]: unknown }; + object: 'connect_collection_transfer' + } & { [key: string]: unknown } /** * CountrySpec * @description Stripe needs to collect certain pieces of information about each account @@ -3448,36 +3394,36 @@ export interface components { */ country_spec: { /** @description The default currency for this country. This applies to both payment methods and bank accounts. */ - default_currency: string; + default_currency: string /** @description Unique identifier for the object. Represented as the ISO country code for this country. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "country_spec"; + object: 'country_spec' /** @description Currencies that can be accepted in the specific country (for transfers). */ - supported_bank_account_currencies: { [key: string]: string[] }; + supported_bank_account_currencies: { [key: string]: string[] } /** @description Currencies that can be accepted in the specified country (for payments). */ - supported_payment_currencies: string[]; + supported_payment_currencies: string[] /** @description 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: string[]; + supported_payment_methods: string[] /** @description Countries that can accept transfers from the specified country. */ - supported_transfer_countries: string[]; - verification_fields: components["schemas"]["country_spec_verification_fields"]; - } & { [key: string]: unknown }; + supported_transfer_countries: string[] + verification_fields: components['schemas']['country_spec_verification_fields'] + } & { [key: string]: unknown } /** CountrySpecVerificationFieldDetails */ country_spec_verification_field_details: { /** @description Additional fields which are only required for some users. */ - additional: string[]; + additional: string[] /** @description Fields which every account must eventually provide. */ - minimum: string[]; - } & { [key: string]: unknown }; + minimum: string[] + } & { [key: string]: unknown } /** CountrySpecVerificationFields */ country_spec_verification_fields: { - company: components["schemas"]["country_spec_verification_field_details"]; - individual: components["schemas"]["country_spec_verification_field_details"]; - } & { [key: string]: unknown }; + company: components['schemas']['country_spec_verification_field_details'] + individual: components['schemas']['country_spec_verification_field_details'] + } & { [key: string]: unknown } /** * Coupon * @description A coupon contains information about a percent-off or amount-off discount you @@ -3486,54 +3432,54 @@ export interface components { */ coupon: { /** @description Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer. */ - amount_off?: number | null; - applies_to?: components["schemas"]["coupon_applies_to"]; + amount_off?: number | null + applies_to?: components['schemas']['coupon_applies_to'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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?: string | null; + currency?: string | null /** * @description One of `forever`, `once`, and `repeating`. Describes how long a customer who applies this coupon will get the discount. * @enum {string} */ - duration: "forever" | "once" | "repeating"; + duration: 'forever' | 'once' | 'repeating' /** @description If `duration` is `repeating`, the number of months the coupon applies. Null if coupon `duration` is `forever` or `once`. */ - duration_in_months?: number | null; + duration_in_months?: number | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid. */ - max_redemptions?: number | null; + max_redemptions?: number | null /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** @description Name of the coupon displayed to customers on for instance invoices or receipts. */ - name?: string | null; + name?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "coupon"; + object: 'coupon' /** @description 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 %s100 invoice %s50 instead. */ - percent_off?: number | null; + percent_off?: number | null /** * Format: unix-time * @description Date after which the coupon can no longer be redeemed. */ - redeem_by?: number | null; + redeem_by?: number | null /** @description Number of times this coupon has been applied to a customer. */ - times_redeemed: number; + times_redeemed: number /** @description Taking account of the above properties, whether this coupon can still be applied to a customer. */ - valid: boolean; - } & { [key: string]: unknown }; + valid: boolean + } & { [key: string]: unknown } /** CouponAppliesTo */ coupon_applies_to: { /** @description A list of product IDs this coupon applies to */ - products: string[]; - } & { [key: string]: unknown }; + products: string[] + } & { [key: string]: unknown } /** * CreditNote * @description Issue a credit note to adjust an invoice's amount after the invoice is finalized. @@ -3542,144 +3488,142 @@ export interface components { */ credit_note: { /** @description The integer amount in %s representing the total amount of the credit note, including tax. */ - amount: number; + amount: number /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description ID of the customer. */ - customer: (Partial & - Partial & - Partial) & { [key: string]: unknown }; + customer: (Partial & Partial & Partial) & { + [key: string]: unknown + } /** @description Customer balance transaction related to this credit note. */ customer_balance_transaction?: - | ((Partial & Partial) & { - [key: string]: unknown; - }) - | null; + | ((Partial & Partial) & { [key: string]: unknown }) + | null /** @description The integer amount in %s representing the total amount of discount that was credited. */ - discount_amount: number; + discount_amount: number /** @description The aggregate amounts calculated per discount for all line items. */ - discount_amounts: components["schemas"]["discounts_resource_discount_amount"][]; + discount_amounts: components['schemas']['discounts_resource_discount_amount'][] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description ID of the invoice. */ - invoice: (Partial & Partial) & { [key: string]: unknown }; + invoice: (Partial & Partial) & { [key: string]: unknown } /** * CreditNoteLinesList * @description Line items that make up the credit note */ lines: { /** @description Details about each object. */ - data: components["schemas"]["credit_note_line_item"][]; + data: components['schemas']['credit_note_line_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; + url: string + } & { [key: string]: unknown } /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description Customer-facing text that appears on the credit note PDF. */ - memo?: string | null; + memo?: string | null /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** @description A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice. */ - number: string; + number: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "credit_note"; + object: 'credit_note' /** @description Amount that was credited outside of Stripe. */ - out_of_band_amount?: number | null; + out_of_band_amount?: number | null /** @description The link to download the PDF of the credit note. */ - pdf: string; + pdf: string /** * @description Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` * @enum {string|null} */ - reason?: ("duplicate" | "fraudulent" | "order_change" | "product_unsatisfactory") | null; + reason?: ('duplicate' | 'fraudulent' | 'order_change' | 'product_unsatisfactory') | null /** @description Refund related to this credit note. */ - refund?: ((Partial & Partial) & { [key: string]: unknown }) | null; + refund?: ((Partial & Partial) & { [key: string]: unknown }) | null /** * @description 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). * @enum {string} */ - status: "issued" | "void"; + status: 'issued' | 'void' /** @description The integer amount in %s representing the amount of the credit note, excluding tax and invoice level discounts. */ - subtotal: number; + subtotal: number /** @description The aggregate amounts calculated per tax rate for all line items. */ - tax_amounts: components["schemas"]["credit_note_tax_amount"][]; + tax_amounts: components['schemas']['credit_note_tax_amount'][] /** @description The integer amount in %s representing the total amount of the credit note, including tax and all discount. */ - total: number; + total: number /** * @description 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. * @enum {string} */ - type: "post_payment" | "pre_payment"; + type: 'post_payment' | 'pre_payment' /** * Format: unix-time * @description The time that the credit note was voided. */ - voided_at?: number | null; - } & { [key: string]: unknown }; + voided_at?: number | null + } & { [key: string]: unknown } /** CreditNoteLineItem */ credit_note_line_item: { /** @description The integer amount in %s representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts. */ - amount: number; + amount: number /** @description Description of the item being credited. */ - description?: string | null; + description?: string | null /** @description The integer amount in %s representing the discount being credited for this line item. */ - discount_amount: number; + discount_amount: number /** @description The amount of discount calculated per discount for this line item */ - discount_amounts: components["schemas"]["discounts_resource_discount_amount"][]; + discount_amounts: components['schemas']['discounts_resource_discount_amount'][] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description ID of the invoice line item being credited */ - invoice_line_item?: string; + invoice_line_item?: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "credit_note_line_item"; + object: 'credit_note_line_item' /** @description The number of units of product being credited. */ - quantity?: number | null; + quantity?: number | null /** @description The amount of tax calculated per tax rate for this line item */ - tax_amounts: components["schemas"]["credit_note_tax_amount"][]; + tax_amounts: components['schemas']['credit_note_tax_amount'][] /** @description The tax rates which apply to the line item. */ - tax_rates: components["schemas"]["tax_rate"][]; + tax_rates: components['schemas']['tax_rate'][] /** * @description 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. * @enum {string} */ - type: "custom_line_item" | "invoice_line_item"; + type: 'custom_line_item' | 'invoice_line_item' /** @description The cost of each unit of product being credited. */ - unit_amount?: number | null; + unit_amount?: number | null /** * Format: decimal * @description Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. */ - unit_amount_decimal?: string | null; - } & { [key: string]: unknown }; + unit_amount_decimal?: string | null + } & { [key: string]: unknown } /** CreditNoteTaxAmount */ credit_note_tax_amount: { /** @description The amount, in %s, of the tax. */ - amount: number; + amount: number /** @description Whether this tax amount is inclusive or exclusive. */ - inclusive: boolean; + inclusive: boolean /** @description The tax rate that was applied to get this tax amount. */ - tax_rate: (Partial & Partial) & { [key: string]: unknown }; - } & { [key: string]: unknown }; + tax_rate: (Partial & Partial) & { [key: string]: unknown } + } & { [key: string]: unknown } /** * Customer * @description This object represents a customer of your business. It lets you create recurring charges and track payments that belong to the same customer. @@ -3688,16 +3632,16 @@ export interface components { */ customer: { /** @description The customer's address. */ - address?: (Partial & { [key: string]: unknown }) | null; + address?: (Partial & { [key: string]: unknown }) | null /** @description Current balance, if any, being 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 will be added to their next invoice. The balance does not refer to any unpaid invoices; it solely takes into account amounts that have yet to be successfully applied to any invoice. This balance is only taken into account as invoices are finalized. */ - balance?: number; + balance?: number /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes. */ - currency?: string | null; + currency?: string | null /** * @description ID of the default payment source for the customer. * @@ -3705,125 +3649,125 @@ export interface components { */ default_source?: | ((Partial & - Partial & - Partial & - Partial & - Partial & - Partial) & { [key: string]: unknown }) - | null; + Partial & + Partial & + Partial & + Partial & + Partial) & { [key: string]: unknown }) + | null /** * @description When the customer's latest invoice is billed by charging automatically, `delinquent` is `true` if the invoice's latest charge failed. When the customer's latest invoice is billed by sending an invoice, `delinquent` is `true` if the invoice isn't paid by its due date. * * If an invoice is marked uncollectible by [dunning](https://stripe.com/docs/billing/automatic-collection), `delinquent` doesn't get reset to `false`. */ - delinquent?: boolean | null; + delinquent?: boolean | null /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description Describes the current discount active on the customer, if there is one. */ - discount?: (Partial & { [key: string]: unknown }) | null; + discount?: (Partial & { [key: string]: unknown }) | null /** @description The customer's email address. */ - email?: string | null; + email?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The prefix for the customer used to generate unique invoice numbers. */ - invoice_prefix?: string | null; - invoice_settings?: components["schemas"]["invoice_setting_customer_setting"]; + invoice_prefix?: string | null + invoice_settings?: components['schemas']['invoice_setting_customer_setting'] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The customer's full name or business name. */ - name?: string | null; + name?: string | null /** @description The suffix of the customer's next invoice number, e.g., 0001. */ - next_invoice_sequence?: number; + next_invoice_sequence?: number /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "customer"; + object: 'customer' /** @description The customer's phone number. */ - phone?: string | null; + phone?: string | null /** @description The customer's preferred locales (languages), ordered by preference. */ - preferred_locales?: string[] | null; + preferred_locales?: string[] | null /** @description Mailing and shipping address for the customer. Appears on invoices emailed to this customer. */ - shipping?: (Partial & { [key: string]: unknown }) | null; + shipping?: (Partial & { [key: string]: unknown }) | null /** * ApmsSourcesSourceList * @description The customer's payment sources, if any. */ sources?: { /** @description Details about each object. */ - data: ((Partial & - Partial & - Partial & - Partial & - Partial) & { [key: string]: unknown })[]; + data: ((Partial & + Partial & + Partial & + Partial & + Partial) & { [key: string]: unknown })[] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; + url: string + } & { [key: string]: unknown } /** * SubscriptionList * @description The customer's current subscriptions, if any. */ subscriptions?: { /** @description Details about each object. */ - data: components["schemas"]["subscription"][]; + data: components['schemas']['subscription'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - tax?: components["schemas"]["customer_tax"]; + url: string + } & { [key: string]: unknown } + tax?: components['schemas']['customer_tax'] /** * @description Describes the customer's tax exemption status. One of `none`, `exempt`, or `reverse`. When set to `reverse`, invoice and receipt PDFs include the text **"Reverse charge"**. * @enum {string|null} */ - tax_exempt?: ("exempt" | "none" | "reverse") | null; + tax_exempt?: ('exempt' | 'none' | 'reverse') | null /** * TaxIDsList * @description The customer's tax IDs. */ tax_ids?: { /** @description Details about each object. */ - data: components["schemas"]["tax_id"][]; + data: components['schemas']['tax_id'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + url: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** customer_acceptance */ customer_acceptance: { /** * Format: unix-time * @description The time at which the customer accepted the Mandate. */ - accepted_at?: number | null; - offline?: components["schemas"]["offline_acceptance"]; - online?: components["schemas"]["online_acceptance"]; + accepted_at?: number | null + offline?: components['schemas']['offline_acceptance'] + online?: components['schemas']['online_acceptance'] /** * @description The type of customer acceptance information included with the Mandate. One of `online` or `offline`. * @enum {string} */ - type: "offline" | "online"; - } & { [key: string]: unknown }; + type: 'offline' | 'online' + } & { [key: string]: unknown } /** * CustomerBalanceTransaction * @description Each customer has a [`balance`](https://stripe.com/docs/api/customers/object#customer_object-balance) value, @@ -3835,483 +3779,480 @@ export interface components { */ customer_balance_transaction: { /** @description 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: number; + amount: number /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The ID of the credit note (if any) related to the transaction. */ - credit_note?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + credit_note?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description 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: string; + currency: string /** @description The ID of the customer the transaction belongs to. */ - customer: (Partial & Partial) & { [key: string]: unknown }; + customer: (Partial & Partial) & { [key: string]: unknown } /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description 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: number; + ending_balance: number /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The ID of the invoice (if any) related to the transaction. */ - invoice?: ((Partial & Partial) & { [key: string]: unknown }) | null; + invoice?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "customer_balance_transaction"; + object: 'customer_balance_transaction' /** * @description Transaction type: `adjustment`, `applied_to_invoice`, `credit_note`, `initial`, `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. * @enum {string} */ type: - | "adjustment" - | "applied_to_invoice" - | "credit_note" - | "initial" - | "invoice_too_large" - | "invoice_too_small" - | "migration" - | "unapplied_from_invoice" - | "unspent_receiver_credit"; - } & { [key: string]: unknown }; + | 'adjustment' + | 'applied_to_invoice' + | 'credit_note' + | 'initial' + | 'invoice_too_large' + | 'invoice_too_small' + | 'migration' + | 'unapplied_from_invoice' + | 'unspent_receiver_credit' + } & { [key: string]: unknown } /** CustomerTax */ customer_tax: { /** * @description Surfaces if automatic tax computation is possible given the current customer location information. * @enum {string} */ - automatic_tax: "failed" | "not_collecting" | "supported" | "unrecognized_location"; + automatic_tax: 'failed' | 'not_collecting' | 'supported' | 'unrecognized_location' /** @description A recent IP address of the customer used for tax reporting and tax location inference. */ - ip_address?: string | null; + ip_address?: string | null /** @description The customer's location as identified by Stripe Tax. */ - location?: (Partial & { [key: string]: unknown }) | null; - } & { [key: string]: unknown }; + location?: (Partial & { [key: string]: unknown }) | null + } & { [key: string]: unknown } /** CustomerTaxLocation */ customer_tax_location: { /** @description The customer's country as identified by Stripe Tax. */ - country: string; + country: string /** * @description The data source used to infer the customer's location. * @enum {string} */ - source: "billing_address" | "ip_address" | "payment_method" | "shipping_destination"; + source: 'billing_address' | 'ip_address' | 'payment_method' | 'shipping_destination' /** @description The customer's state, county, province, or region as identified by Stripe Tax. */ - state?: string | null; - } & { [key: string]: unknown }; + state?: string | null + } & { [key: string]: unknown } /** DeletedAccount */ deleted_account: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "account"; - } & { [key: string]: unknown }; + object: 'account' + } & { [key: string]: unknown } /** AlipayDeletedAccount */ deleted_alipay_account: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "alipay_account"; - } & { [key: string]: unknown }; + object: 'alipay_account' + } & { [key: string]: unknown } /** DeletedApplePayDomain */ deleted_apple_pay_domain: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "apple_pay_domain"; - } & { [key: string]: unknown }; + object: 'apple_pay_domain' + } & { [key: string]: unknown } /** DeletedBankAccount */ deleted_bank_account: { /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. */ - currency?: string | null; + currency?: string | null /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "bank_account"; - } & { [key: string]: unknown }; + object: 'bank_account' + } & { [key: string]: unknown } /** BitcoinDeletedReceiver */ deleted_bitcoin_receiver: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "bitcoin_receiver"; - } & { [key: string]: unknown }; + object: 'bitcoin_receiver' + } & { [key: string]: unknown } /** DeletedCard */ deleted_card: { /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. */ - currency?: string | null; + currency?: string | null /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "card"; - } & { [key: string]: unknown }; + object: 'card' + } & { [key: string]: unknown } /** DeletedCoupon */ deleted_coupon: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "coupon"; - } & { [key: string]: unknown }; + object: 'coupon' + } & { [key: string]: unknown } /** DeletedCustomer */ deleted_customer: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "customer"; - } & { [key: string]: unknown }; + object: 'customer' + } & { [key: string]: unknown } /** DeletedDiscount */ deleted_discount: { /** @description 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?: string | null; - coupon: components["schemas"]["coupon"]; + checkout_session?: string | null + coupon: components['schemas']['coupon'] /** @description The ID of the customer associated with this discount. */ customer?: - | ((Partial & - Partial & - Partial) & { [key: string]: unknown }) - | null; + | ((Partial & Partial & Partial) & { + [key: string]: unknown + }) + | null /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description 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: string; + id: string /** @description The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice. */ - invoice?: string | null; + invoice?: string | null /** @description 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?: string | null; + invoice_item?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "discount"; + object: 'discount' /** @description The promotion code applied to create this discount. */ - promotion_code?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + promotion_code?: ((Partial & Partial) & { [key: string]: unknown }) | null /** * Format: unix-time * @description Date that the coupon was applied. */ - start: number; + start: number /** @description The subscription that this coupon is applied to, if it is applied to a particular subscription. */ - subscription?: string | null; - } & { [key: string]: unknown }; + subscription?: string | null + } & { [key: string]: unknown } /** Polymorphic */ - deleted_external_account: (Partial & - Partial) & { [key: string]: unknown }; + deleted_external_account: (Partial & Partial) & { + [key: string]: unknown + } /** DeletedInvoice */ deleted_invoice: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "invoice"; - } & { [key: string]: unknown }; + object: 'invoice' + } & { [key: string]: unknown } /** DeletedInvoiceItem */ deleted_invoiceitem: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "invoiceitem"; - } & { [key: string]: unknown }; + object: 'invoiceitem' + } & { [key: string]: unknown } /** Polymorphic */ - deleted_payment_source: (Partial & - Partial & - Partial & - Partial) & { [key: string]: unknown }; + deleted_payment_source: (Partial & + Partial & + Partial & + Partial) & { [key: string]: unknown } /** DeletedPerson */ deleted_person: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "person"; - } & { [key: string]: unknown }; + object: 'person' + } & { [key: string]: unknown } /** DeletedPlan */ deleted_plan: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "plan"; - } & { [key: string]: unknown }; + object: 'plan' + } & { [key: string]: unknown } /** DeletedPrice */ deleted_price: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "price"; - } & { [key: string]: unknown }; + object: 'price' + } & { [key: string]: unknown } /** DeletedProduct */ deleted_product: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "product"; - } & { [key: string]: unknown }; + object: 'product' + } & { [key: string]: unknown } /** RadarListDeletedList */ - "deleted_radar.value_list": { + 'deleted_radar.value_list': { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "radar.value_list"; - } & { [key: string]: unknown }; + object: 'radar.value_list' + } & { [key: string]: unknown } /** RadarListDeletedListItem */ - "deleted_radar.value_list_item": { + 'deleted_radar.value_list_item': { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "radar.value_list_item"; - } & { [key: string]: unknown }; + object: 'radar.value_list_item' + } & { [key: string]: unknown } /** DeletedTransferRecipient */ deleted_recipient: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "recipient"; - } & { [key: string]: unknown }; + object: 'recipient' + } & { [key: string]: unknown } /** DeletedSku */ deleted_sku: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "sku"; - } & { [key: string]: unknown }; + object: 'sku' + } & { [key: string]: unknown } /** DeletedSubscriptionItem */ deleted_subscription_item: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "subscription_item"; - } & { [key: string]: unknown }; + object: 'subscription_item' + } & { [key: string]: unknown } /** deleted_tax_id */ deleted_tax_id: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "tax_id"; - } & { [key: string]: unknown }; + object: 'tax_id' + } & { [key: string]: unknown } /** TerminalLocationDeletedLocation */ - "deleted_terminal.location": { + 'deleted_terminal.location': { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "terminal.location"; - } & { [key: string]: unknown }; + object: 'terminal.location' + } & { [key: string]: unknown } /** TerminalReaderDeletedReader */ - "deleted_terminal.reader": { + 'deleted_terminal.reader': { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "terminal.reader"; - } & { [key: string]: unknown }; + object: 'terminal.reader' + } & { [key: string]: unknown } /** NotificationWebhookEndpointDeleted */ deleted_webhook_endpoint: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "webhook_endpoint"; - } & { [key: string]: unknown }; + object: 'webhook_endpoint' + } & { [key: string]: unknown } /** DeliveryEstimate */ delivery_estimate: { /** @description If `type` is `"exact"`, `date` will be the expected delivery date in the format YYYY-MM-DD. */ - date?: string; + date?: string /** @description If `type` is `"range"`, `earliest` will be be the earliest delivery date in the format YYYY-MM-DD. */ - earliest?: string; + earliest?: string /** @description If `type` is `"range"`, `latest` will be the latest delivery date in the format YYYY-MM-DD. */ - latest?: string; + latest?: string /** @description The type of estimate. Must be either `"range"` or `"exact"`. */ - type: string; - } & { [key: string]: unknown }; + type: string + } & { [key: string]: unknown } /** * Discount * @description A discount represents the actual application of a coupon to a particular @@ -4322,51 +4263,49 @@ export interface components { */ discount: { /** @description 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?: string | null; - coupon: components["schemas"]["coupon"]; + checkout_session?: string | null + coupon: components['schemas']['coupon'] /** @description The ID of the customer associated with this discount. */ customer?: - | ((Partial & - Partial & - Partial) & { [key: string]: unknown }) - | null; + | ((Partial & Partial & Partial) & { + [key: string]: unknown + }) + | null /** * Format: unix-time * @description 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?: number | null; + end?: number | null /** @description 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: string; + id: string /** @description The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice. */ - invoice?: string | null; + invoice?: string | null /** @description 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?: string | null; + invoice_item?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "discount"; + object: 'discount' /** @description The promotion code applied to create this discount. */ - promotion_code?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + promotion_code?: ((Partial & Partial) & { [key: string]: unknown }) | null /** * Format: unix-time * @description Date that the coupon was applied. */ - start: number; + start: number /** @description The subscription that this coupon is applied to, if it is applied to a particular subscription. */ - subscription?: string | null; - } & { [key: string]: unknown }; + subscription?: string | null + } & { [key: string]: unknown } /** DiscountsResourceDiscountAmount */ discounts_resource_discount_amount: { /** @description The amount, in %s, of the discount. */ - amount: number; + amount: number /** @description The discount that was applied to get this discount amount. */ - discount: (Partial & - Partial & - Partial) & { [key: string]: unknown }; - } & { [key: string]: unknown }; + discount: (Partial & Partial & Partial) & { + [key: string]: unknown + } + } & { [key: string]: unknown } /** * Dispute * @description A dispute occurs when a customer questions your charge with their card issuer. @@ -4379,166 +4318,150 @@ export interface components { */ dispute: { /** @description Disputed amount. Usually the amount of the charge, but can differ (usually because of currency fluctuation or because only part of the order is disputed). */ - amount: number; + amount: number /** @description 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: components["schemas"]["balance_transaction"][]; + balance_transactions: components['schemas']['balance_transaction'][] /** @description ID of the charge that was disputed. */ - charge: (Partial & Partial) & { [key: string]: unknown }; + charge: (Partial & Partial) & { [key: string]: unknown } /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; - evidence: components["schemas"]["dispute_evidence"]; - evidence_details: components["schemas"]["dispute_evidence_details"]; + currency: string + evidence: components['schemas']['dispute_evidence'] + evidence_details: components['schemas']['dispute_evidence_details'] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description If true, it is still possible to refund the disputed payment. Once the payment has been fully refunded, no further funds will be withdrawn from your Stripe account as a result of this dispute. */ - is_charge_refundable: boolean; + is_charge_refundable: boolean /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "dispute"; + object: 'dispute' /** @description ID of the PaymentIntent that was disputed. */ - payment_intent?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + payment_intent?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description 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`. Read more about [dispute reasons](https://stripe.com/docs/disputes/categories). */ - reason: string; + reason: string /** * @description Current status of dispute. Possible values are `warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `charge_refunded`, `won`, or `lost`. * @enum {string} */ status: - | "charge_refunded" - | "lost" - | "needs_response" - | "under_review" - | "warning_closed" - | "warning_needs_response" - | "warning_under_review" - | "won"; - } & { [key: string]: unknown }; + | 'charge_refunded' + | 'lost' + | 'needs_response' + | 'under_review' + | 'warning_closed' + | 'warning_needs_response' + | 'warning_under_review' + | 'won' + } & { [key: string]: unknown } /** DisputeEvidence */ dispute_evidence: { /** @description 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?: string | null; + access_activity_log?: string | null /** @description The billing address provided by the customer. */ - billing_address?: string | null; + billing_address?: string | null /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your subscription cancellation policy, as shown to the customer. */ - cancellation_policy?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + cancellation_policy?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description An explanation of how and when the customer was shown your refund policy prior to purchase. */ - cancellation_policy_disclosure?: string | null; + cancellation_policy_disclosure?: string | null /** @description A justification for why the customer's subscription was not canceled. */ - cancellation_rebuttal?: string | null; + cancellation_rebuttal?: string | null /** @description (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?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + customer_communication?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description The email address of the customer. */ - customer_email_address?: string | null; + customer_email_address?: string | null /** @description The name of the customer. */ - customer_name?: string | null; + customer_name?: string | null /** @description The IP address that the customer used when making the purchase. */ - customer_purchase_ip?: string | null; + customer_purchase_ip?: string | null /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A relevant document or contract showing the customer's signature. */ - customer_signature?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + customer_signature?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description (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?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + duplicate_charge_documentation?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description An explanation of the difference between the disputed charge versus the prior charge that appears to be a duplicate. */ - duplicate_charge_explanation?: string | null; + duplicate_charge_explanation?: string | null /** @description The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge. */ - duplicate_charge_id?: string | null; + duplicate_charge_id?: string | null /** @description A description of the product or service that was sold. */ - product_description?: string | null; + product_description?: string | null /** @description (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?: ((Partial & Partial) & { [key: string]: unknown }) | null; + receipt?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your refund policy, as shown to the customer. */ - refund_policy?: ((Partial & Partial) & { [key: string]: unknown }) | null; + refund_policy?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description Documentation demonstrating that the customer was shown your refund policy prior to purchase. */ - refund_policy_disclosure?: string | null; + refund_policy_disclosure?: string | null /** @description A justification for why the customer is not entitled to a refund. */ - refund_refusal_explanation?: string | null; + refund_refusal_explanation?: string | null /** @description The date on which the customer received or began receiving the purchased service, in a clear human-readable format. */ - service_date?: string | null; + service_date?: string | null /** @description (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?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + service_documentation?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description The address to which a physical product was shipped. You should try to include as complete address information as possible. */ - shipping_address?: string | null; + shipping_address?: string | null /** @description 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?: string | null; + shipping_carrier?: string | null /** @description The date on which a physical product began its route to the shipping address, in a clear human-readable format. */ - shipping_date?: string | null; + shipping_date?: string | null /** @description (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?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + shipping_documentation?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description 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?: string | null; + shipping_tracking_number?: string | null /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any additional evidence or statements. */ - uncategorized_file?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + uncategorized_file?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description Any additional evidence or statements. */ - uncategorized_text?: string | null; - } & { [key: string]: unknown }; + uncategorized_text?: string | null + } & { [key: string]: unknown } /** DisputeEvidenceDetails */ dispute_evidence_details: { /** * Format: unix-time * @description Date by which evidence must be submitted in order to successfully challenge dispute. Will be null if the customer's bank or credit card company doesn't allow a response for this particular dispute. */ - due_by?: number | null; + due_by?: number | null /** @description Whether evidence has been staged for this dispute. */ - has_evidence: boolean; + has_evidence: boolean /** @description 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: boolean; + past_due: boolean /** @description The number of times evidence has been submitted. Typically, you may only submit evidence once. */ - submission_count: number; - } & { [key: string]: unknown }; + submission_count: number + } & { [key: string]: unknown } /** EphemeralKey */ ephemeral_key: { /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** * Format: unix-time * @description Time at which the key will expire. Measured in seconds since the Unix epoch. */ - expires: number; + expires: number /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "ephemeral_key"; + object: 'ephemeral_key' /** @description The key's secret. You can use this value to make authorized requests to the Stripe API. */ - secret?: string; - } & { [key: string]: unknown }; + secret?: string + } & { [key: string]: unknown } /** @description An error response from the Stripe API */ error: { - error: components["schemas"]["api_errors"]; - } & { [key: string]: unknown }; + error: components['schemas']['api_errors'] + } & { [key: string]: unknown } /** * NotificationEvent * @description Events are our way of letting you know when something interesting happens in @@ -4573,31 +4496,31 @@ export interface components { */ event: { /** @description The connected account that originated the event. */ - account?: string; + account?: string /** @description The Stripe API version used to render `data`. *Note: This property is populated only for events on or after October 31, 2014*. */ - api_version?: string | null; + api_version?: string | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; - data: components["schemas"]["notification_event_data"]; + created: number + data: components['schemas']['notification_event_data'] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "event"; + object: 'event' /** @description Number of webhooks that have yet to be successfully delivered (i.e., to return a 20x response) to the URLs you've specified. */ - pending_webhooks: number; + pending_webhooks: number /** @description Information on the API request that instigated the event. */ - request?: (Partial & { [key: string]: unknown }) | null; + request?: (Partial & { [key: string]: unknown }) | null /** @description Description of the event (e.g., `invoice.created` or `charge.refunded`). */ - type: string; - } & { [key: string]: unknown }; + type: string + } & { [key: string]: unknown } /** * ExchangeRate * @description `Exchange Rate` objects allow you to determine the rates that Stripe is @@ -4614,32 +4537,30 @@ export interface components { */ exchange_rate: { /** @description 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: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "exchange_rate"; + object: 'exchange_rate' /** @description 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: { [key: string]: number }; - } & { [key: string]: unknown }; + rates: { [key: string]: number } + } & { [key: string]: unknown } /** Polymorphic */ - external_account: (Partial & Partial) & { - [key: string]: unknown; - }; + external_account: (Partial & Partial) & { [key: string]: unknown } /** Fee */ fee: { /** @description Amount of the fee, in cents. */ - amount: number; + amount: number /** @description ID of the Connect application that earned the fee. */ - application?: string | null; + application?: string | null /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description Type of the fee, one of: `application_fee`, `stripe_fee` or `tax`. */ - type: string; - } & { [key: string]: unknown }; + type: string + } & { [key: string]: unknown } /** * FeeRefund * @description `Application Fee Refund` objects allow you to refund an application fee that @@ -4650,30 +4571,28 @@ export interface components { */ fee_refund: { /** @description Amount, in %s. */ - amount: number; + amount: number /** @description Balance transaction that describes the impact on your account balance. */ - balance_transaction?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + balance_transaction?: ((Partial & Partial) & { [key: string]: unknown }) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description ID of the application fee that was refunded. */ - fee: (Partial & Partial) & { [key: string]: unknown }; + fee: (Partial & Partial) & { [key: string]: unknown } /** @description Unique identifier for the object. */ - id: string; + id: string /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "fee_refund"; - } & { [key: string]: unknown }; + object: 'fee_refund' + } & { [key: string]: unknown } /** * File * @description This is an object representing a file hosted on Stripe's servers. The @@ -4689,16 +4608,16 @@ export interface components { * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** * Format: unix-time * @description The time at which the file expires and is no longer available in epoch seconds. */ - expires_at?: number | null; + expires_at?: number | null /** @description A filename for the file, suitable for saving to a filesystem. */ - filename?: string | null; + filename?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** * FileFileLinkList * @description A list of [file links](https://stripe.com/docs/api#file_links) that point at this file. @@ -4706,51 +4625,51 @@ export interface components { links?: | ({ /** @description Details about each object. */ - data: components["schemas"]["file_link"][]; + data: components['schemas']['file_link'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; + url: string } & { [key: string]: unknown }) - | null; + | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "file"; + object: 'file' /** * @description The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file. * @enum {string} */ purpose: - | "account_requirement" - | "additional_verification" - | "business_icon" - | "business_logo" - | "customer_signature" - | "dispute_evidence" - | "document_provider_identity_document" - | "finance_report_run" - | "identity_document" - | "identity_document_downloadable" - | "pci_document" - | "selfie" - | "sigma_scheduled_query" - | "tax_document_user_upload"; + | 'account_requirement' + | 'additional_verification' + | 'business_icon' + | 'business_logo' + | 'customer_signature' + | 'dispute_evidence' + | 'document_provider_identity_document' + | 'finance_report_run' + | 'identity_document' + | 'identity_document_downloadable' + | 'pci_document' + | 'selfie' + | 'sigma_scheduled_query' + | 'tax_document_user_upload' /** @description The size in bytes of the file object. */ - size: number; + size: number /** @description A user friendly title for the document. */ - title?: string | null; + title?: string | null /** @description The type of the file returned (e.g., `csv`, `pdf`, `jpg`, or `png`). */ - type?: string | null; + type?: string | null /** @description The URL from which the file can be downloaded using your live secret API key. */ - url?: string | null; - } & { [key: string]: unknown }; + url?: string | null + } & { [key: string]: unknown } /** * FileLink * @description To share the contents of a `File` object with non-Stripe users, you can @@ -4762,258 +4681,250 @@ export interface components { * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Whether this link is already expired. */ - expired: boolean; + expired: boolean /** * Format: unix-time * @description Time at which the link expires. */ - expires_at?: number | null; + expires_at?: number | null /** @description The file object this link points to. */ - file: (Partial & Partial) & { [key: string]: unknown }; + file: (Partial & Partial) & { [key: string]: unknown } /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "file_link"; + object: 'file_link' /** @description The publicly accessible URL to download the file. */ - url?: string | null; - } & { [key: string]: unknown }; + url?: string | null + } & { [key: string]: unknown } /** FinancialReportingFinanceReportRunRunParameters */ financial_reporting_finance_report_run_run_parameters: { /** @description The set of output columns requested for inclusion in the report run. */ - columns?: string[]; + columns?: string[] /** @description Connected account ID by which to filter the report run. */ - connected_account?: string; + connected_account?: string /** @description Currency of objects to be included in the report run. */ - currency?: string; + currency?: string /** * Format: unix-time * @description Ending timestamp of data to be included in the report run (exclusive). */ - interval_end?: number; + interval_end?: number /** * Format: unix-time * @description Starting timestamp of data to be included in the report run. */ - interval_start?: number; + interval_start?: number /** @description Payout ID by which to filter the report run. */ - payout?: string; + payout?: string /** @description Category of balance transactions to be included in the report run. */ - reporting_category?: string; + reporting_category?: string /** @description 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?: string; - } & { [key: string]: unknown }; + timezone?: string + } & { [key: string]: unknown } /** * GelatoDataDocumentReportDateOfBirth * @description Point in Time */ gelato_data_document_report_date_of_birth: { /** @description Numerical day between 1 and 31. */ - day?: number | null; + day?: number | null /** @description Numerical month between 1 and 12. */ - month?: number | null; + month?: number | null /** @description The four-digit year. */ - year?: number | null; - } & { [key: string]: unknown }; + year?: number | null + } & { [key: string]: unknown } /** * GelatoDataDocumentReportExpirationDate * @description Point in Time */ gelato_data_document_report_expiration_date: { /** @description Numerical day between 1 and 31. */ - day?: number | null; + day?: number | null /** @description Numerical month between 1 and 12. */ - month?: number | null; + month?: number | null /** @description The four-digit year. */ - year?: number | null; - } & { [key: string]: unknown }; + year?: number | null + } & { [key: string]: unknown } /** * GelatoDataDocumentReportIssuedDate * @description Point in Time */ gelato_data_document_report_issued_date: { /** @description Numerical day between 1 and 31. */ - day?: number | null; + day?: number | null /** @description Numerical month between 1 and 12. */ - month?: number | null; + month?: number | null /** @description The four-digit year. */ - year?: number | null; - } & { [key: string]: unknown }; + year?: number | null + } & { [key: string]: unknown } /** * GelatoDataIdNumberReportDate * @description Point in Time */ gelato_data_id_number_report_date: { /** @description Numerical day between 1 and 31. */ - day?: number | null; + day?: number | null /** @description Numerical month between 1 and 12. */ - month?: number | null; + month?: number | null /** @description The four-digit year. */ - year?: number | null; - } & { [key: string]: unknown }; + year?: number | null + } & { [key: string]: unknown } /** * GelatoDataVerifiedOutputsDate * @description Point in Time */ gelato_data_verified_outputs_date: { /** @description Numerical day between 1 and 31. */ - day?: number | null; + day?: number | null /** @description Numerical month between 1 and 12. */ - month?: number | null; + month?: number | null /** @description The four-digit year. */ - year?: number | null; - } & { [key: string]: unknown }; + year?: number | null + } & { [key: string]: unknown } /** * GelatoDocumentReport * @description Result from a document check */ gelato_document_report: { /** @description Address as it appears in the document. */ - address?: (Partial & { [key: string]: unknown }) | null; + address?: (Partial & { [key: string]: unknown }) | null /** @description Date of birth as it appears in the document. */ - dob?: - | (Partial & { [key: string]: unknown }) - | null; + dob?: (Partial & { [key: string]: unknown }) | null /** @description Details on the verification error. Present when status is `unverified`. */ - error?: (Partial & { [key: string]: unknown }) | null; + error?: (Partial & { [key: string]: unknown }) | null /** @description Expiration date of the document. */ - expiration_date?: - | (Partial & { [key: string]: unknown }) - | null; + expiration_date?: (Partial & { [key: string]: unknown }) | null /** @description Array of [File](https://stripe.com/docs/api/files) ids containing images for this document. */ - files?: string[] | null; + files?: string[] | null /** @description First name as it appears in the document. */ - first_name?: string | null; + first_name?: string | null /** @description Issued date of the document. */ - issued_date?: - | (Partial & { [key: string]: unknown }) - | null; + issued_date?: (Partial & { [key: string]: unknown }) | null /** @description Issuing country of the document. */ - issuing_country?: string | null; + issuing_country?: string | null /** @description Last name as it appears in the document. */ - last_name?: string | null; + last_name?: string | null /** @description Document ID number. */ - number?: string | null; + number?: string | null /** * @description Status of this `document` check. * @enum {string} */ - status: "unverified" | "verified"; + status: 'unverified' | 'verified' /** * @description Type of the document. * @enum {string|null} */ - type?: ("driving_license" | "id_card" | "passport") | null; - } & { [key: string]: unknown }; + type?: ('driving_license' | 'id_card' | 'passport') | null + } & { [key: string]: unknown } /** GelatoDocumentReportError */ gelato_document_report_error: { /** * @description A short machine-readable string giving the reason for the verification failure. * @enum {string|null} */ - code?: ("document_expired" | "document_type_not_supported" | "document_unverified_other") | null; + code?: ('document_expired' | 'document_type_not_supported' | 'document_unverified_other') | null /** @description A human-readable message giving the reason for the failure. These messages can be shown to your users. */ - reason?: string | null; - } & { [key: string]: unknown }; + reason?: string | null + } & { [key: string]: unknown } /** * GelatoIdNumberReport * @description Result from an id_number check */ gelato_id_number_report: { /** @description Date of birth. */ - dob?: (Partial & { [key: string]: unknown }) | null; + dob?: (Partial & { [key: string]: unknown }) | null /** @description Details on the verification error. Present when status is `unverified`. */ - error?: (Partial & { [key: string]: unknown }) | null; + error?: (Partial & { [key: string]: unknown }) | null /** @description First name. */ - first_name?: string | null; + first_name?: string | null /** @description ID number. */ - id_number?: string | null; + id_number?: string | null /** * @description Type of ID number. * @enum {string|null} */ - id_number_type?: ("br_cpf" | "sg_nric" | "us_ssn") | null; + id_number_type?: ('br_cpf' | 'sg_nric' | 'us_ssn') | null /** @description Last name. */ - last_name?: string | null; + last_name?: string | null /** * @description Status of this `id_number` check. * @enum {string} */ - status: "unverified" | "verified"; - } & { [key: string]: unknown }; + status: 'unverified' | 'verified' + } & { [key: string]: unknown } /** GelatoIdNumberReportError */ gelato_id_number_report_error: { /** * @description A short machine-readable string giving the reason for the verification failure. * @enum {string|null} */ - code?: ("id_number_insufficient_document_data" | "id_number_mismatch" | "id_number_unverified_other") | null; + code?: ('id_number_insufficient_document_data' | 'id_number_mismatch' | 'id_number_unverified_other') | null /** @description A human-readable message giving the reason for the failure. These messages can be shown to your users. */ - reason?: string | null; - } & { [key: string]: unknown }; + reason?: string | null + } & { [key: string]: unknown } /** GelatoReportDocumentOptions */ gelato_report_document_options: { /** @description 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?: ("driving_license" | "id_card" | "passport")[]; + allowed_types?: ('driving_license' | 'id_card' | 'passport')[] /** @description 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?: boolean; + require_id_number?: boolean /** @description Disable image uploads, identity document images have to be captured using the device’s camera. */ - require_live_capture?: boolean; + require_live_capture?: boolean /** @description 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?: boolean; - } & { [key: string]: unknown }; + require_matching_selfie?: boolean + } & { [key: string]: unknown } /** GelatoReportIdNumberOptions */ - gelato_report_id_number_options: { [key: string]: unknown }; + gelato_report_id_number_options: { [key: string]: unknown } /** * GelatoSelfieReport * @description Result from a selfie check */ gelato_selfie_report: { /** @description ID of the [File](https://stripe.com/docs/api/files) holding the image of the identity document used in this check. */ - document?: string | null; + document?: string | null /** @description Details on the verification error. Present when status is `unverified`. */ - error?: (Partial & { [key: string]: unknown }) | null; + error?: (Partial & { [key: string]: unknown }) | null /** @description ID of the [File](https://stripe.com/docs/api/files) holding the image of the selfie used in this check. */ - selfie?: string | null; + selfie?: string | null /** * @description Status of this `selfie` check. * @enum {string} */ - status: "unverified" | "verified"; - } & { [key: string]: unknown }; + status: 'unverified' | 'verified' + } & { [key: string]: unknown } /** GelatoSelfieReportError */ gelato_selfie_report_error: { /** * @description A short machine-readable string giving the reason for the verification failure. * @enum {string|null} */ - code?: - | ("selfie_document_missing_photo" | "selfie_face_mismatch" | "selfie_manipulated" | "selfie_unverified_other") - | null; + code?: ('selfie_document_missing_photo' | 'selfie_face_mismatch' | 'selfie_manipulated' | 'selfie_unverified_other') | null /** @description A human-readable message giving the reason for the failure. These messages can be shown to your users. */ - reason?: string | null; - } & { [key: string]: unknown }; + reason?: string | null + } & { [key: string]: unknown } /** GelatoSessionDocumentOptions */ gelato_session_document_options: { /** @description 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?: ("driving_license" | "id_card" | "passport")[]; + allowed_types?: ('driving_license' | 'id_card' | 'passport')[] /** @description 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?: boolean; + require_id_number?: boolean /** @description Disable image uploads, identity document images have to be captured using the device’s camera. */ - require_live_capture?: boolean; + require_live_capture?: boolean /** @description 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?: boolean; - } & { [key: string]: unknown }; + require_matching_selfie?: boolean + } & { [key: string]: unknown } /** GelatoSessionIdNumberOptions */ - gelato_session_id_number_options: { [key: string]: unknown }; + gelato_session_id_number_options: { [key: string]: unknown } /** * GelatoSessionLastError * @description Shows last VerificationSession error @@ -5025,54 +4936,54 @@ export interface components { */ code?: | ( - | "abandoned" - | "consent_declined" - | "country_not_supported" - | "device_not_supported" - | "document_expired" - | "document_type_not_supported" - | "document_unverified_other" - | "id_number_insufficient_document_data" - | "id_number_mismatch" - | "id_number_unverified_other" - | "selfie_document_missing_photo" - | "selfie_face_mismatch" - | "selfie_manipulated" - | "selfie_unverified_other" - | "under_supported_age" + | 'abandoned' + | 'consent_declined' + | 'country_not_supported' + | 'device_not_supported' + | 'document_expired' + | 'document_type_not_supported' + | 'document_unverified_other' + | 'id_number_insufficient_document_data' + | 'id_number_mismatch' + | 'id_number_unverified_other' + | 'selfie_document_missing_photo' + | 'selfie_face_mismatch' + | 'selfie_manipulated' + | 'selfie_unverified_other' + | 'under_supported_age' ) - | null; + | null /** @description A message that explains the reason for verification or user-session failure. */ - reason?: string | null; - } & { [key: string]: unknown }; + reason?: string | null + } & { [key: string]: unknown } /** GelatoVerificationReportOptions */ gelato_verification_report_options: { - document?: components["schemas"]["gelato_report_document_options"]; - id_number?: components["schemas"]["gelato_report_id_number_options"]; - } & { [key: string]: unknown }; + document?: components['schemas']['gelato_report_document_options'] + id_number?: components['schemas']['gelato_report_id_number_options'] + } & { [key: string]: unknown } /** GelatoVerificationSessionOptions */ gelato_verification_session_options: { - document?: components["schemas"]["gelato_session_document_options"]; - id_number?: components["schemas"]["gelato_session_id_number_options"]; - } & { [key: string]: unknown }; + document?: components['schemas']['gelato_session_document_options'] + id_number?: components['schemas']['gelato_session_id_number_options'] + } & { [key: string]: unknown } /** GelatoVerifiedOutputs */ gelato_verified_outputs: { /** @description The user's verified address. */ - address?: (Partial & { [key: string]: unknown }) | null; + address?: (Partial & { [key: string]: unknown }) | null /** @description The user’s verified date of birth. */ - dob?: (Partial & { [key: string]: unknown }) | null; + dob?: (Partial & { [key: string]: unknown }) | null /** @description The user's verified first name. */ - first_name?: string | null; + first_name?: string | null /** @description The user's verified id number. */ - id_number?: string | null; + id_number?: string | null /** * @description The user's verified id number type. * @enum {string|null} */ - id_number_type?: ("br_cpf" | "sg_nric" | "us_ssn") | null; + id_number_type?: ('br_cpf' | 'sg_nric' | 'us_ssn') | null /** @description The user's verified last name. */ - last_name?: string | null; - } & { [key: string]: unknown }; + last_name?: string | null + } & { [key: string]: unknown } /** * GelatoVerificationReport * @description A VerificationReport is the result of an attempt to collect and verify data from a user. @@ -5087,33 +4998,33 @@ export interface components { * * Related guides: [Accessing verification results](https://stripe.com/docs/identity/verification-sessions#results). */ - "identity.verification_report": { + 'identity.verification_report': { /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; - document?: components["schemas"]["gelato_document_report"]; + created: number + document?: components['schemas']['gelato_document_report'] /** @description Unique identifier for the object. */ - id: string; - id_number?: components["schemas"]["gelato_id_number_report"]; + id: string + id_number?: components['schemas']['gelato_id_number_report'] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "identity.verification_report"; - options: components["schemas"]["gelato_verification_report_options"]; - selfie?: components["schemas"]["gelato_selfie_report"]; + object: 'identity.verification_report' + options: components['schemas']['gelato_verification_report_options'] + selfie?: components['schemas']['gelato_selfie_report'] /** * @description Type of report. * @enum {string} */ - type: "document" | "id_number"; + type: 'document' | 'id_number' /** @description ID of the VerificationSession that created this report. */ - verification_session?: string | null; - } & { [key: string]: unknown }; + verification_session?: string | null + } & { [key: string]: unknown } /** * GelatoVerificationSession * @description A VerificationSession guides you through the process of collecting and verifying the identities @@ -5128,55 +5039,49 @@ export interface components { * * Related guide: [The Verification Sessions API](https://stripe.com/docs/identity/verification-sessions) */ - "identity.verification_session": { + 'identity.verification_session': { /** @description 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?: string | null; + client_secret?: string | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Unique identifier for the object. */ - id: string; + id: string /** @description If present, this property tells you the last error encountered when processing the verification. */ - last_error?: (Partial & { [key: string]: unknown }) | null; + last_error?: (Partial & { [key: string]: unknown }) | null /** @description ID of the most recent VerificationReport. [Learn more about accessing detailed verification results.](https://stripe.com/docs/identity/verification-sessions#results) */ last_verification_report?: - | ((Partial & Partial) & { - [key: string]: unknown; - }) - | null; + | ((Partial & Partial) & { [key: string]: unknown }) + | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "identity.verification_session"; - options: components["schemas"]["gelato_verification_session_options"]; + object: 'identity.verification_session' + options: components['schemas']['gelato_verification_session_options'] /** @description Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null. */ - redaction?: - | (Partial & { [key: string]: unknown }) - | null; + redaction?: (Partial & { [key: string]: unknown }) | null /** * @description Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work). * @enum {string} */ - status: "canceled" | "processing" | "requires_input" | "verified"; + status: 'canceled' | 'processing' | 'requires_input' | 'verified' /** * @description The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. * @enum {string} */ - type: "document" | "id_number"; + type: 'document' | 'id_number' /** @description 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?: string | null; + url?: string | null /** @description The user’s verified data. */ - verified_outputs?: - | (Partial & { [key: string]: unknown }) - | null; - } & { [key: string]: unknown }; + verified_outputs?: (Partial & { [key: string]: unknown }) | null + } & { [key: string]: unknown } /** * Invoice * @description Invoices are statements of amounts owed by a customer, and are either @@ -5214,343 +5119,333 @@ export interface components { */ invoice: { /** @description The country of the business associated with this invoice, most often the business creating the invoice. */ - account_country?: string | null; + account_country?: string | null /** @description The public name of the business associated with this invoice, most often the business creating the invoice. */ - account_name?: string | null; + account_name?: string | null /** @description The account tax IDs associated with the invoice. Only editable when the invoice is a draft. */ account_tax_ids?: - | ((Partial & - Partial & - Partial) & { [key: string]: unknown })[] - | null; + | ((Partial & Partial & Partial) & { + [key: string]: unknown + })[] + | null /** @description 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: number; + amount_due: number /** @description The amount, in %s, that was paid. */ - amount_paid: number; + amount_paid: number /** @description The amount remaining, in %s, that is due. */ - amount_remaining: number; + amount_remaining: number /** @description The fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account when the invoice is paid. */ - application_fee_amount?: number | null; + application_fee_amount?: number | null /** @description 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. */ - attempt_count: number; + attempt_count: number /** @description 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: boolean; + attempted: boolean /** @description Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice. When `false`, the invoice's state will not automatically advance without an explicit action. */ - auto_advance?: boolean; - automatic_tax: components["schemas"]["automatic_tax"]; + auto_advance?: boolean + automatic_tax: components['schemas']['automatic_tax'] /** * @description Indicates the reason why the invoice was created. `subscription_cycle` indicates an invoice created by a subscription advancing into a new period. `subscription_create` indicates an invoice created due to creating a subscription. `subscription_update` indicates an invoice created due to updating a subscription. `subscription` is set for all old invoices to indicate either a change to a subscription or a period advancement. `manual` is set for all invoices unrelated to a subscription (for example: created via the invoice editor). The `upcoming` value is reserved for simulated invoices per the upcoming invoice endpoint. `subscription_threshold` indicates an invoice created due to a billing threshold being reached. * @enum {string|null} */ billing_reason?: | ( - | "automatic_pending_invoice_item_invoice" - | "manual" - | "quote_accept" - | "subscription" - | "subscription_create" - | "subscription_cycle" - | "subscription_threshold" - | "subscription_update" - | "upcoming" + | 'automatic_pending_invoice_item_invoice' + | 'manual' + | 'quote_accept' + | 'subscription' + | 'subscription_create' + | 'subscription_cycle' + | 'subscription_threshold' + | 'subscription_update' + | 'upcoming' ) - | null; + | null /** @description ID of the latest charge generated for this invoice, if any. */ - charge?: ((Partial & Partial) & { [key: string]: unknown }) | null; + charge?: ((Partial & Partial) & { [key: string]: unknown }) | null /** * @description 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. * @enum {string} */ - collection_method: "charge_automatically" | "send_invoice"; + collection_method: 'charge_automatically' | 'send_invoice' /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Custom fields displayed on the invoice. */ - custom_fields?: components["schemas"]["invoice_setting_custom_field"][] | null; + custom_fields?: components['schemas']['invoice_setting_custom_field'][] | null /** @description The ID of the customer who will be billed. */ customer?: - | ((Partial & - Partial & - Partial) & { [key: string]: unknown }) - | null; + | ((Partial & Partial & Partial) & { + [key: string]: unknown + }) + | null /** @description 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?: (Partial & { [key: string]: unknown }) | null; + customer_address?: (Partial & { [key: string]: unknown }) | null /** @description 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?: string | null; + customer_email?: string | null /** @description 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?: string | null; + customer_name?: string | null /** @description 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?: string | null; + customer_phone?: string | null /** @description 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?: (Partial & { [key: string]: unknown }) | null; + customer_shipping?: (Partial & { [key: string]: unknown }) | null /** * @description 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. * @enum {string|null} */ - customer_tax_exempt?: ("exempt" | "none" | "reverse") | null; + customer_tax_exempt?: ('exempt' | 'none' | 'reverse') | null /** @description 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?: components["schemas"]["invoices_resource_invoice_tax_id"][] | null; + customer_tax_ids?: components['schemas']['invoices_resource_invoice_tax_id'][] | null /** @description 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?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + default_payment_method?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description 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?: | ((Partial & - Partial & - Partial & - Partial & - Partial & - Partial) & { [key: string]: unknown }) - | null; + Partial & + Partial & + Partial & + Partial & + Partial) & { [key: string]: unknown }) + | null /** @description The tax rates applied to this invoice, if any. */ - default_tax_rates: components["schemas"]["tax_rate"][]; + default_tax_rates: components['schemas']['tax_rate'][] /** @description An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. */ - description?: string | null; + description?: string | null /** @description Describes the current discount applied to this invoice, if there is one. Not populated if there are multiple discounts. */ - discount?: (Partial & { [key: string]: unknown }) | null; + discount?: (Partial & { [key: string]: unknown }) | null /** @description The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount. */ discounts?: - | ((Partial & - Partial & - Partial) & { [key: string]: unknown })[] - | null; + | ((Partial & Partial & Partial) & { + [key: string]: unknown + })[] + | null /** * Format: unix-time * @description The date on which payment for this invoice is due. This value will be `null` for invoices where `collection_method=charge_automatically`. */ - due_date?: number | null; + due_date?: number | null /** @description 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?: number | null; + ending_balance?: number | null /** @description Footer displayed on the invoice. */ - footer?: string | null; + footer?: string | null /** @description 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?: string | null; + hosted_invoice_url?: string | null /** @description Unique identifier for the object. */ - id?: string; + id?: string /** @description The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null. */ - invoice_pdf?: string | null; + invoice_pdf?: string | null /** @description The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized. */ - last_finalization_error?: (Partial & { [key: string]: unknown }) | null; + last_finalization_error?: (Partial & { [key: string]: unknown }) | null /** * InvoiceLinesList * @description The individual line items that make up the invoice. `lines` is sorted as follows: invoice items in reverse chronological order, followed by the subscription, if any. */ lines: { /** @description Details about each object. */ - data: components["schemas"]["line_item"][]; + data: components['schemas']['line_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; + url: string + } & { [key: string]: unknown } /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * Format: unix-time * @description The time at which payment will next be attempted. This value will be `null` for invoices where `collection_method=send_invoice`. */ - next_payment_attempt?: number | null; + next_payment_attempt?: number | null /** @description 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?: string | null; + number?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "invoice"; + object: 'invoice' /** @description 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?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + on_behalf_of?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description 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: boolean; + paid: boolean /** @description 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: boolean; + paid_out_of_band: boolean /** @description 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?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; - payment_settings: components["schemas"]["invoices_payment_settings"]; + payment_intent?: ((Partial & Partial) & { [key: string]: unknown }) | null + payment_settings: components['schemas']['invoices_payment_settings'] /** * Format: unix-time * @description End of the usage period during which invoice items were added to this invoice. */ - period_end: number; + period_end: number /** * Format: unix-time * @description Start of the usage period during which invoice items were added to this invoice. */ - period_start: number; + period_start: number /** @description Total amount of all post-payment credit notes issued for this invoice. */ - post_payment_credit_notes_amount: number; + post_payment_credit_notes_amount: number /** @description Total amount of all pre-payment credit notes issued for this invoice. */ - pre_payment_credit_notes_amount: number; + pre_payment_credit_notes_amount: number /** @description The quote this invoice was generated from. */ - quote?: ((Partial & Partial) & { [key: string]: unknown }) | null; + quote?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description This is the transaction number that appears on email receipts sent for this invoice. */ - receipt_number?: string | null; + receipt_number?: string | null /** @description Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. */ - starting_balance: number; + starting_balance: number /** @description Extra information about an invoice for the customer's credit card statement. */ - statement_descriptor?: string | null; + statement_descriptor?: string | null /** * @description The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview) * @enum {string|null} */ - status?: ("deleted" | "draft" | "open" | "paid" | "uncollectible" | "void") | null; - status_transitions: components["schemas"]["invoices_status_transitions"]; + status?: ('deleted' | 'draft' | 'open' | 'paid' | 'uncollectible' | 'void') | null + status_transitions: components['schemas']['invoices_status_transitions'] /** @description The subscription that this invoice was prepared for, if any. */ - subscription?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + subscription?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description Only set for upcoming invoices that preview prorations. The time used to calculate prorations. */ - subscription_proration_date?: number; + subscription_proration_date?: number /** @description Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated */ - subtotal: number; + subtotal: number /** @description The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice. */ - tax?: number | null; - threshold_reason?: components["schemas"]["invoice_threshold_reason"]; + tax?: number | null + threshold_reason?: components['schemas']['invoice_threshold_reason'] /** @description Total after discounts and taxes. */ - total: number; + total: number /** @description The aggregate amounts calculated per discount across all line items. */ - total_discount_amounts?: components["schemas"]["discounts_resource_discount_amount"][] | null; + total_discount_amounts?: components['schemas']['discounts_resource_discount_amount'][] | null /** @description The aggregate amounts calculated per tax rate for all line items. */ - total_tax_amounts: components["schemas"]["invoice_tax_amount"][]; + total_tax_amounts: components['schemas']['invoice_tax_amount'][] /** @description 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?: (Partial & { [key: string]: unknown }) | null; + transfer_data?: (Partial & { [key: string]: unknown }) | null /** * Format: unix-time * @description 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?: number | null; - } & { [key: string]: unknown }; + webhooks_delivered_at?: number | null + } & { [key: string]: unknown } /** InvoiceItemThresholdReason */ invoice_item_threshold_reason: { /** @description The IDs of the line items that triggered the threshold invoice. */ - line_item_ids: string[]; + line_item_ids: string[] /** @description The quantity threshold boundary that applied to the given line item. */ - usage_gte: number; - } & { [key: string]: unknown }; + usage_gte: number + } & { [key: string]: unknown } /** InvoiceLineItemPeriod */ invoice_line_item_period: { /** * Format: unix-time * @description End of the line item's billing period */ - end: number; + end: number /** * Format: unix-time * @description Start of the line item's billing period */ - start: number; - } & { [key: string]: unknown }; + start: number + } & { [key: string]: unknown } /** invoice_mandate_options_card */ invoice_mandate_options_card: { /** @description Amount to be charged for future payments. */ - amount?: number | null; + amount?: number | null /** * @description 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. * @enum {string|null} */ - amount_type?: ("fixed" | "maximum") | null; + amount_type?: ('fixed' | 'maximum') | null /** @description A description of the mandate or subscription that is meant to be displayed to the customer. */ - description?: string | null; - } & { [key: string]: unknown }; + description?: string | null + } & { [key: string]: unknown } /** invoice_payment_method_options_acss_debit */ invoice_payment_method_options_acss_debit: { - mandate_options?: components["schemas"]["invoice_payment_method_options_acss_debit_mandate_options"]; + mandate_options?: components['schemas']['invoice_payment_method_options_acss_debit_mandate_options'] /** * @description Bank account verification method. * @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; - } & { [key: string]: unknown }; + verification_method?: 'automatic' | 'instant' | 'microdeposits' + } & { [key: string]: unknown } /** invoice_payment_method_options_acss_debit_mandate_options */ invoice_payment_method_options_acss_debit_mandate_options: { /** * @description Transaction type of the mandate. * @enum {string|null} */ - transaction_type?: ("business" | "personal") | null; - } & { [key: string]: unknown }; + transaction_type?: ('business' | 'personal') | null + } & { [key: string]: unknown } /** invoice_payment_method_options_bancontact */ invoice_payment_method_options_bancontact: { /** * @description Preferred language of the Bancontact authorization page that the customer is redirected to. * @enum {string} */ - preferred_language: "de" | "en" | "fr" | "nl"; - } & { [key: string]: unknown }; + preferred_language: 'de' | 'en' | 'fr' | 'nl' + } & { [key: string]: unknown } /** invoice_payment_method_options_card */ invoice_payment_method_options_card: { /** * @description 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#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. * @enum {string|null} */ - request_three_d_secure?: ("any" | "automatic") | null; - } & { [key: string]: unknown }; + request_three_d_secure?: ('any' | 'automatic') | null + } & { [key: string]: unknown } /** InvoiceSettingCustomField */ invoice_setting_custom_field: { /** @description The name of the custom field. */ - name: string; + name: string /** @description The value of the custom field. */ - value: string; - } & { [key: string]: unknown }; + value: string + } & { [key: string]: unknown } /** InvoiceSettingCustomerSetting */ invoice_setting_customer_setting: { /** @description Default custom fields to be displayed on invoices for this customer. */ - custom_fields?: components["schemas"]["invoice_setting_custom_field"][] | null; + custom_fields?: components['schemas']['invoice_setting_custom_field'][] | null /** @description 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?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + default_payment_method?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description Default footer to be displayed on invoices for this customer. */ - footer?: string | null; - } & { [key: string]: unknown }; + footer?: string | null + } & { [key: string]: unknown } /** InvoiceSettingQuoteSetting */ invoice_setting_quote_setting: { /** @description 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?: number | null; - } & { [key: string]: unknown }; + days_until_due?: number | null + } & { [key: string]: unknown } /** InvoiceSettingSubscriptionScheduleSetting */ invoice_setting_subscription_schedule_setting: { /** @description 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?: number | null; - } & { [key: string]: unknown }; + days_until_due?: number | null + } & { [key: string]: unknown } /** InvoiceTaxAmount */ invoice_tax_amount: { /** @description The amount, in %s, of the tax. */ - amount: number; + amount: number /** @description Whether this tax amount is inclusive or exclusive. */ - inclusive: boolean; + inclusive: boolean /** @description The tax rate that was applied to get this tax amount. */ - tax_rate: (Partial & Partial) & { [key: string]: unknown }; - } & { [key: string]: unknown }; + tax_rate: (Partial & Partial) & { [key: string]: unknown } + } & { [key: string]: unknown } /** InvoiceThresholdReason */ invoice_threshold_reason: { /** @description The total invoice amount threshold boundary if it triggered the threshold invoice. */ - amount_gte?: number | null; + amount_gte?: number | null /** @description Indicates which line items triggered a threshold invoice. */ - item_reasons: components["schemas"]["invoice_item_threshold_reason"][]; - } & { [key: string]: unknown }; + item_reasons: components['schemas']['invoice_item_threshold_reason'][] + } & { [key: string]: unknown } /** InvoiceTransferData */ invoice_transfer_data: { /** @description The amount in %s that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination. */ - amount?: number | null; + amount?: number | null /** @description The account where funds from the payment will be transferred to upon payment success. */ - destination: (Partial & Partial) & { [key: string]: unknown }; - } & { [key: string]: unknown }; + destination: (Partial & Partial) & { [key: string]: unknown } + } & { [key: string]: unknown } /** * InvoiceItem * @description Sometimes you want to add a charge or credit to a customer, but actually @@ -5563,104 +5458,92 @@ export interface components { */ invoiceitem: { /** @description Amount (in the `currency` specified) of the invoice item. This should always be equal to `unit_amount * quantity`. */ - amount: number; + amount: number /** @description 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: string; + currency: string /** @description The ID of the customer who will be billed when this invoice item is billed. */ - customer: (Partial & - Partial & - Partial) & { [key: string]: unknown }; + customer: (Partial & Partial & Partial) & { + [key: string]: unknown + } /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - date: number; + date: number /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description If true, discounts will apply to this invoice item. Always false for prorations. */ - discountable: boolean; + discountable: boolean /** @description The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount. */ - discounts?: - | ((Partial & Partial) & { [key: string]: unknown })[] - | null; + discounts?: ((Partial & Partial) & { [key: string]: unknown })[] | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The ID of the invoice this invoice item belongs to. */ - invoice?: ((Partial & Partial) & { [key: string]: unknown }) | null; + invoice?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "invoiceitem"; - period: components["schemas"]["invoice_line_item_period"]; + object: 'invoiceitem' + period: components['schemas']['invoice_line_item_period'] /** @description The price of the invoice item. */ - price?: (Partial & { [key: string]: unknown }) | null; + price?: (Partial & { [key: string]: unknown }) | null /** @description Whether the invoice item was created automatically as a proration adjustment when the customer switched plans. */ - proration: boolean; + proration: boolean /** @description 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: number; + quantity: number /** @description The subscription that this invoice item has been created for, if any. */ - subscription?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + subscription?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description The subscription item that this invoice item has been created for, if any. */ - subscription_item?: string; + subscription_item?: string /** @description 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?: components["schemas"]["tax_rate"][] | null; + tax_rates?: components['schemas']['tax_rate'][] | null /** @description Unit amount (in the `currency` specified) of the invoice item. */ - unit_amount?: number | null; + unit_amount?: number | null /** * Format: decimal * @description Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. */ - unit_amount_decimal?: string | null; - } & { [key: string]: unknown }; + unit_amount_decimal?: string | null + } & { [key: string]: unknown } /** InvoicesPaymentMethodOptions */ invoices_payment_method_options: { /** @description 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?: - | (Partial & { [key: string]: unknown }) - | null; + acss_debit?: (Partial & { [key: string]: unknown }) | null /** @description If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent. */ - bancontact?: - | (Partial & { [key: string]: unknown }) - | null; + bancontact?: (Partial & { [key: string]: unknown }) | null /** @description If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent. */ - card?: - | (Partial & { [key: string]: unknown }) - | null; - } & { [key: string]: unknown }; + card?: (Partial & { [key: string]: unknown }) | null + } & { [key: string]: unknown } /** InvoicesPaymentSettings */ invoices_payment_settings: { /** @description Payment-method-specific configuration to provide to the invoice’s PaymentIntent. */ - payment_method_options?: - | (Partial & { [key: string]: unknown }) - | null; + payment_method_options?: (Partial & { [key: string]: unknown }) | null /** @description 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?: | ( - | "ach_credit_transfer" - | "ach_debit" - | "acss_debit" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "sepa_debit" - | "sofort" - | "wechat_pay" + | 'ach_credit_transfer' + | 'ach_debit' + | 'acss_debit' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' )[] - | null; - } & { [key: string]: unknown }; + | null + } & { [key: string]: unknown } /** InvoicesResourceInvoiceTaxID */ invoices_resource_invoice_tax_id: { /** @@ -5668,75 +5551,75 @@ export interface components { * @enum {string} */ type: - | "ae_trn" - | "au_abn" - | "au_arn" - | "br_cnpj" - | "br_cpf" - | "ca_bn" - | "ca_gst_hst" - | "ca_pst_bc" - | "ca_pst_mb" - | "ca_pst_sk" - | "ca_qst" - | "ch_vat" - | "cl_tin" - | "es_cif" - | "eu_vat" - | "gb_vat" - | "ge_vat" - | "hk_br" - | "id_npwp" - | "il_vat" - | "in_gst" - | "is_vat" - | "jp_cn" - | "jp_rn" - | "kr_brn" - | "li_uid" - | "mx_rfc" - | "my_frp" - | "my_itn" - | "my_sst" - | "no_vat" - | "nz_gst" - | "ru_inn" - | "ru_kpp" - | "sa_vat" - | "sg_gst" - | "sg_uen" - | "th_vat" - | "tw_vat" - | "ua_vat" - | "unknown" - | "us_ein" - | "za_vat"; + | 'ae_trn' + | 'au_abn' + | 'au_arn' + | 'br_cnpj' + | 'br_cpf' + | 'ca_bn' + | 'ca_gst_hst' + | 'ca_pst_bc' + | 'ca_pst_mb' + | 'ca_pst_sk' + | 'ca_qst' + | 'ch_vat' + | 'cl_tin' + | 'es_cif' + | 'eu_vat' + | 'gb_vat' + | 'ge_vat' + | 'hk_br' + | 'id_npwp' + | 'il_vat' + | 'in_gst' + | 'is_vat' + | 'jp_cn' + | 'jp_rn' + | 'kr_brn' + | 'li_uid' + | 'mx_rfc' + | 'my_frp' + | 'my_itn' + | 'my_sst' + | 'no_vat' + | 'nz_gst' + | 'ru_inn' + | 'ru_kpp' + | 'sa_vat' + | 'sg_gst' + | 'sg_uen' + | 'th_vat' + | 'tw_vat' + | 'ua_vat' + | 'unknown' + | 'us_ein' + | 'za_vat' /** @description The value of the tax ID. */ - value?: string | null; - } & { [key: string]: unknown }; + value?: string | null + } & { [key: string]: unknown } /** InvoicesStatusTransitions */ invoices_status_transitions: { /** * Format: unix-time * @description The time that the invoice draft was finalized. */ - finalized_at?: number | null; + finalized_at?: number | null /** * Format: unix-time * @description The time that the invoice was marked uncollectible. */ - marked_uncollectible_at?: number | null; + marked_uncollectible_at?: number | null /** * Format: unix-time * @description The time that the invoice was paid. */ - paid_at?: number | null; + paid_at?: number | null /** * Format: unix-time * @description The time that the invoice was voided. */ - voided_at?: number | null; - } & { [key: string]: unknown }; + voided_at?: number | null + } & { [key: string]: unknown } /** * IssuerFraudRecord * @description This resource has been renamed to [Early Fraud @@ -5745,30 +5628,30 @@ export interface components { */ issuer_fraud_record: { /** @description An IFR 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 IFR, in order to avoid receiving a dispute later. */ - actionable: boolean; + actionable: boolean /** @description ID of the charge this issuer fraud record is for, optionally expanded. */ - charge: (Partial & Partial) & { [key: string]: unknown }; + charge: (Partial & Partial) & { [key: string]: unknown } /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + fraud_type: string /** @description If true, the associated charge is subject to [liability shift](https://stripe.com/docs/payments/3d-secure#disputed-payments). */ - has_liability_shift: boolean; + has_liability_shift: boolean /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "issuer_fraud_record"; + object: 'issuer_fraud_record' /** @description The timestamp at which the card issuer posted the issuer fraud record. */ - post_date: number; - } & { [key: string]: unknown }; + post_date: number + } & { [key: string]: unknown } /** * IssuingAuthorization * @description When an [issued card](https://stripe.com/docs/issuing) is used to make a purchase, an Issuing `Authorization` @@ -5777,276 +5660,260 @@ export interface components { * * Related guide: [Issued Card Authorizations](https://stripe.com/docs/issuing/purchases/authorizations). */ - "issuing.authorization": { + 'issuing.authorization': { /** @description The total amount that was authorized or rejected. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ - amount: number; + amount: number /** @description 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?: - | (Partial & { [key: string]: unknown }) - | null; + amount_details?: (Partial & { [key: string]: unknown }) | null /** @description Whether the authorization has been approved. */ - approved: boolean; + approved: boolean /** * @description How the card details were provided. * @enum {string} */ - authorization_method: "chip" | "contactless" | "keyed_in" | "online" | "swipe"; + authorization_method: 'chip' | 'contactless' | 'keyed_in' | 'online' | 'swipe' /** @description List of balance transactions associated with this authorization. */ - balance_transactions: components["schemas"]["balance_transaction"][]; - card: components["schemas"]["issuing.card"]; + balance_transactions: components['schemas']['balance_transaction'][] + card: components['schemas']['issuing.card'] /** @description The cardholder to whom this authorization belongs. */ - cardholder?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + cardholder?: ((Partial & Partial) & { [key: string]: unknown }) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: number; + merchant_amount: number /** @description The currency that was 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: string; - merchant_data: components["schemas"]["issuing_authorization_merchant_data"]; + merchant_currency: string + merchant_data: components['schemas']['issuing_authorization_merchant_data'] /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "issuing.authorization"; + object: 'issuing.authorization' /** @description The pending authorization request. This field will only be non-null during an `issuing_authorization.request` webhook. */ - pending_request?: - | (Partial & { [key: string]: unknown }) - | null; + pending_request?: (Partial & { [key: string]: unknown }) | null /** @description History of every time `pending_request` was approved/denied, 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](https://stripe.com/docs/issuing/purchases/authorizations), you can look at this field to see the previous requests for the authorization. */ - request_history: components["schemas"]["issuing_authorization_request"][]; + request_history: components['schemas']['issuing_authorization_request'][] /** * @description The current status of the authorization in its lifecycle. * @enum {string} */ - status: "closed" | "pending" | "reversed"; + status: 'closed' | 'pending' | 'reversed' /** @description List of [transactions](https://stripe.com/docs/api/issuing/transactions) associated with this authorization. */ - transactions: components["schemas"]["issuing.transaction"][]; - verification_data: components["schemas"]["issuing_authorization_verification_data"]; + transactions: components['schemas']['issuing.transaction'][] + verification_data: components['schemas']['issuing_authorization_verification_data'] /** @description The digital wallet used for this authorization. One of `apple_pay`, `google_pay`, or `samsung_pay`. */ - wallet?: string | null; - } & { [key: string]: unknown }; + wallet?: string | null + } & { [key: string]: unknown } /** * IssuingCard * @description You can [create physical or virtual cards](https://stripe.com/docs/issuing/cards) that are issued to cardholders. */ - "issuing.card": { + 'issuing.card': { /** @description The brand of the card. */ - brand: string; + brand: string /** * @description The reason why the card was canceled. * @enum {string|null} */ - cancellation_reason?: ("lost" | "stolen") | null; - cardholder: components["schemas"]["issuing.cardholder"]; + cancellation_reason?: ('lost' | 'stolen') | null + cardholder: components['schemas']['issuing.cardholder'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description 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?: string; + cvc?: string /** @description The expiration month of the card. */ - exp_month: number; + exp_month: number /** @description The expiration year of the card. */ - exp_year: number; + exp_year: number /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The last 4 digits of the card number. */ - last4: string; + last4: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** @description 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?: string; + number?: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "issuing.card"; + object: 'issuing.card' /** @description The latest card that replaces this card, if any. */ - replaced_by?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + replaced_by?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description The card this card replaces, if any. */ - replacement_for?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + replacement_for?: ((Partial & Partial) & { [key: string]: unknown }) | null /** * @description The reason why the previous card needed to be replaced. * @enum {string|null} */ - replacement_reason?: ("damaged" | "expired" | "lost" | "stolen") | null; + replacement_reason?: ('damaged' | 'expired' | 'lost' | 'stolen') | null /** @description Where and how the card will be shipped. */ - shipping?: (Partial & { [key: string]: unknown }) | null; - spending_controls: components["schemas"]["issuing_card_authorization_controls"]; + shipping?: (Partial & { [key: string]: unknown }) | null + spending_controls: components['schemas']['issuing_card_authorization_controls'] /** * @description Whether authorizations can be approved on this card. * @enum {string} */ - status: "active" | "canceled" | "inactive"; + status: 'active' | 'canceled' | 'inactive' /** * @description The type of the card. * @enum {string} */ - type: "physical" | "virtual"; + type: 'physical' | 'virtual' /** @description Information relating to digital wallets (like Apple Pay and Google Pay). */ - wallets?: (Partial & { [key: string]: unknown }) | null; - } & { [key: string]: unknown }; + wallets?: (Partial & { [key: string]: unknown }) | null + } & { [key: string]: unknown } /** * IssuingCardholder * @description An Issuing `Cardholder` object represents an individual or business entity who is [issued](https://stripe.com/docs/issuing) cards. * * Related guide: [How to create a Cardholder](https://stripe.com/docs/issuing/cards#create-cardholder) */ - "issuing.cardholder": { - billing: components["schemas"]["issuing_cardholder_address"]; + 'issuing.cardholder': { + billing: components['schemas']['issuing_cardholder_address'] /** @description Additional information about a `company` cardholder. */ - company?: (Partial & { [key: string]: unknown }) | null; + company?: (Partial & { [key: string]: unknown }) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The cardholder's email address. */ - email?: string | null; + email?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Additional information about an `individual` cardholder. */ - individual?: - | (Partial & { [key: string]: unknown }) - | null; + individual?: (Partial & { [key: string]: unknown }) | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** @description The cardholder's name. This will be printed on cards issued to them. */ - name: string; + name: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "issuing.cardholder"; + object: 'issuing.cardholder' /** @description 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?: string | null; - requirements: components["schemas"]["issuing_cardholder_requirements"]; + phone_number?: string | null + requirements: components['schemas']['issuing_cardholder_requirements'] /** @description 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?: - | (Partial & { [key: string]: unknown }) - | null; + spending_controls?: (Partial & { [key: string]: unknown }) | null /** * @description Specifies whether to permit authorizations on this cardholder's cards. * @enum {string} */ - status: "active" | "blocked" | "inactive"; + status: 'active' | 'blocked' | 'inactive' /** * @description One of `individual` or `company`. * @enum {string} */ - type: "company" | "individual"; - } & { [key: string]: unknown }; + type: 'company' | 'individual' + } & { [key: string]: unknown } /** * IssuingDispute * @description 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. * * Related guide: [Disputing Transactions](https://stripe.com/docs/issuing/purchases/disputes) */ - "issuing.dispute": { + 'issuing.dispute': { /** @description Disputed amount. Usually the amount of the `transaction`, but can differ (usually because of currency fluctuation). */ - amount: number; + amount: number /** @description List of balance transactions associated with the dispute. */ - balance_transactions?: components["schemas"]["balance_transaction"][] | null; + balance_transactions?: components['schemas']['balance_transaction'][] | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The currency the `transaction` was made in. */ - currency: string; - evidence: components["schemas"]["issuing_dispute_evidence"]; + currency: string + evidence: components['schemas']['issuing_dispute_evidence'] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "issuing.dispute"; + object: 'issuing.dispute' /** * @description Current status of the dispute. * @enum {string} */ - status: "expired" | "lost" | "submitted" | "unsubmitted" | "won"; + status: 'expired' | 'lost' | 'submitted' | 'unsubmitted' | 'won' /** @description The transaction being disputed. */ - transaction: (Partial & Partial) & { - [key: string]: unknown; - }; - } & { [key: string]: unknown }; + transaction: (Partial & Partial) & { [key: string]: unknown } + } & { [key: string]: unknown } /** * IssuingSettlement * @description 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. */ - "issuing.settlement": { + 'issuing.settlement': { /** @description The Bank Identification Number reflecting this settlement record. */ - bin: string; + bin: string /** @description The date that the transactions are cleared and posted to user's accounts. */ - clearing_date: number; + clearing_date: number /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The total interchange received as reimbursement for the transactions. */ - interchange_fees: number; + interchange_fees: number /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** @description The total net amount required to settle with the network. */ - net_total: number; + net_total: number /** * @description The card network for this settlement report. One of ["visa"] * @enum {string} */ - network: "visa"; + network: 'visa' /** @description The total amount of fees owed to the network. */ - network_fees: number; + network_fees: number /** @description The Settlement Identification Number assigned by the network. */ - network_settlement_identifier: string; + network_settlement_identifier: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "issuing.settlement"; + object: 'issuing.settlement' /** @description One of `international` or `uk_national_net`. */ - settlement_service: string; + settlement_service: string /** @description The total number of transactions reflected in this settlement. */ - transaction_count: number; + transaction_count: number /** @description The total transaction amount reflected in this settlement. */ - transaction_volume: number; - } & { [key: string]: unknown }; + transaction_volume: number + } & { [key: string]: unknown } /** * IssuingTransaction * @description Any use of an [issued card](https://stripe.com/docs/issuing) that results in funds entering or leaving @@ -6055,2713 +5922,2662 @@ export interface components { * * Related guide: [Issued Card Transactions](https://stripe.com/docs/issuing/purchases/transactions). */ - "issuing.transaction": { + 'issuing.transaction': { /** @description 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: number; + amount: number /** @description 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?: - | (Partial & { [key: string]: unknown }) - | null; + amount_details?: (Partial & { [key: string]: unknown }) | null /** @description The `Authorization` object that led to this transaction. */ - authorization?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + authorization?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description ID of the [balance transaction](https://stripe.com/docs/api/balance_transactions) associated with this transaction. */ - balance_transaction?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + balance_transaction?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description The card used to make this transaction. */ - card: (Partial & Partial) & { [key: string]: unknown }; + card: (Partial & Partial) & { [key: string]: unknown } /** @description The cardholder to whom this transaction belongs. */ - cardholder?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + cardholder?: ((Partial & Partial) & { [key: string]: unknown }) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description If you've disputed the transaction, the ID of the dispute. */ - dispute?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + dispute?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: number; + merchant_amount: number /** @description The currency with which the merchant is taking payment. */ - merchant_currency: string; - merchant_data: components["schemas"]["issuing_authorization_merchant_data"]; + merchant_currency: string + merchant_data: components['schemas']['issuing_authorization_merchant_data'] /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "issuing.transaction"; + object: 'issuing.transaction' /** @description Additional purchase information that is optionally provided by the merchant. */ - purchase_details?: - | (Partial & { [key: string]: unknown }) - | null; + purchase_details?: (Partial & { [key: string]: unknown }) | null /** * @description The nature of the transaction. * @enum {string} */ - type: "capture" | "refund"; + type: 'capture' | 'refund' /** * @description The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. * @enum {string|null} */ - wallet?: ("apple_pay" | "google_pay" | "samsung_pay") | null; - } & { [key: string]: unknown }; + wallet?: ('apple_pay' | 'google_pay' | 'samsung_pay') | null + } & { [key: string]: unknown } /** IssuingAuthorizationAmountDetails */ issuing_authorization_amount_details: { /** @description The fee charged by the ATM for the cash withdrawal. */ - atm_fee?: number | null; - } & { [key: string]: unknown }; + atm_fee?: number | null + } & { [key: string]: unknown } /** IssuingAuthorizationMerchantData */ issuing_authorization_merchant_data: { /** @description 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: string; + category: string /** @description The merchant category code for the seller’s business */ - category_code: string; + category_code: string /** @description City where the seller is located */ - city?: string | null; + city?: string | null /** @description Country where the seller is located */ - country?: string | null; + country?: string | null /** @description Name of the seller */ - name?: string | null; + name?: string | null /** @description Identifier assigned to the seller by the card brand */ - network_id: string; + network_id: string /** @description Postal code where the seller is located */ - postal_code?: string | null; + postal_code?: string | null /** @description State where the seller is located */ - state?: string | null; - } & { [key: string]: unknown }; + state?: string | null + } & { [key: string]: unknown } /** IssuingAuthorizationPendingRequest */ issuing_authorization_pending_request: { /** @description 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: number; + amount: number /** @description 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?: - | (Partial & { [key: string]: unknown }) - | null; + amount_details?: (Partial & { [key: string]: unknown }) | null /** @description 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: string; + currency: string /** @description 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: boolean; + is_amount_controllable: boolean /** @description 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: number; + merchant_amount: number /** @description The local currency the merchant is requesting to authorize. */ - merchant_currency: string; - } & { [key: string]: unknown }; + merchant_currency: string + } & { [key: string]: unknown } /** IssuingAuthorizationRequest */ issuing_authorization_request: { /** @description 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: number; + amount: number /** @description 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?: - | (Partial & { [key: string]: unknown }) - | null; + amount_details?: (Partial & { [key: string]: unknown }) | null /** @description Whether this request was approved. */ - approved: boolean; + approved: boolean /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description 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: number; + merchant_amount: number /** @description 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: string; + merchant_currency: string /** * @description The reason for the approval or decline. * @enum {string} */ reason: - | "account_disabled" - | "card_active" - | "card_inactive" - | "cardholder_inactive" - | "cardholder_verification_required" - | "insufficient_funds" - | "not_allowed" - | "spending_controls" - | "suspected_fraud" - | "verification_failed" - | "webhook_approved" - | "webhook_declined" - | "webhook_timeout"; - } & { [key: string]: unknown }; + | 'account_disabled' + | 'card_active' + | 'card_inactive' + | 'cardholder_inactive' + | 'cardholder_verification_required' + | 'insufficient_funds' + | 'not_allowed' + | 'spending_controls' + | 'suspected_fraud' + | 'verification_failed' + | 'webhook_approved' + | 'webhook_declined' + | 'webhook_timeout' + } & { [key: string]: unknown } /** IssuingAuthorizationVerificationData */ issuing_authorization_verification_data: { /** * @description Whether the cardholder provided an address first line and if it matched the cardholder’s `billing.address.line1`. * @enum {string} */ - address_line1_check: "match" | "mismatch" | "not_provided"; + address_line1_check: 'match' | 'mismatch' | 'not_provided' /** * @description Whether the cardholder provided a postal code and if it matched the cardholder’s `billing.address.postal_code`. * @enum {string} */ - address_postal_code_check: "match" | "mismatch" | "not_provided"; + address_postal_code_check: 'match' | 'mismatch' | 'not_provided' /** * @description Whether the cardholder provided a CVC and if it matched Stripe’s record. * @enum {string} */ - cvc_check: "match" | "mismatch" | "not_provided"; + cvc_check: 'match' | 'mismatch' | 'not_provided' /** * @description Whether the cardholder provided an expiry date and if it matched Stripe’s record. * @enum {string} */ - expiry_check: "match" | "mismatch" | "not_provided"; - } & { [key: string]: unknown }; + expiry_check: 'match' | 'mismatch' | 'not_provided' + } & { [key: string]: unknown } /** IssuingCardApplePay */ issuing_card_apple_pay: { /** @description Apple Pay Eligibility */ - eligible: boolean; + eligible: boolean /** * @description Reason the card is ineligible for Apple Pay * @enum {string|null} */ - ineligible_reason?: ("missing_agreement" | "missing_cardholder_contact" | "unsupported_region") | null; - } & { [key: string]: unknown }; + ineligible_reason?: ('missing_agreement' | 'missing_cardholder_contact' | 'unsupported_region') | null + } & { [key: string]: unknown } /** IssuingCardAuthorizationControls */ issuing_card_authorization_controls: { /** @description 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?: | ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' )[] - | null; + | null /** @description 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?: | ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' )[] - | null; + | null /** @description 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?: components["schemas"]["issuing_card_spending_limit"][] | null; + spending_limits?: components['schemas']['issuing_card_spending_limit'][] | null /** @description Currency of the amounts within `spending_limits`. Always the same as the currency of the card. */ - spending_limits_currency?: string | null; - } & { [key: string]: unknown }; + spending_limits_currency?: string | null + } & { [key: string]: unknown } /** IssuingCardGooglePay */ issuing_card_google_pay: { /** @description Google Pay Eligibility */ - eligible: boolean; + eligible: boolean /** * @description Reason the card is ineligible for Google Pay * @enum {string|null} */ - ineligible_reason?: ("missing_agreement" | "missing_cardholder_contact" | "unsupported_region") | null; - } & { [key: string]: unknown }; + ineligible_reason?: ('missing_agreement' | 'missing_cardholder_contact' | 'unsupported_region') | null + } & { [key: string]: unknown } /** IssuingCardShipping */ issuing_card_shipping: { - address: components["schemas"]["address"]; + address: components['schemas']['address'] /** * @description The delivery company that shipped a card. * @enum {string|null} */ - carrier?: ("dhl" | "fedex" | "royal_mail" | "usps") | null; + carrier?: ('dhl' | 'fedex' | 'royal_mail' | 'usps') | null /** * Format: unix-time * @description A unix timestamp representing a best estimate of when the card will be delivered. */ - eta?: number | null; + eta?: number | null /** @description Recipient name. */ - name: string; + name: string /** * @description Shipment service, such as `standard` or `express`. * @enum {string} */ - service: "express" | "priority" | "standard"; + service: 'express' | 'priority' | 'standard' /** * @description The delivery status of the card. * @enum {string|null} */ - status?: ("canceled" | "delivered" | "failure" | "pending" | "returned" | "shipped") | null; + status?: ('canceled' | 'delivered' | 'failure' | 'pending' | 'returned' | 'shipped') | null /** @description A tracking number for a card shipment. */ - tracking_number?: string | null; + tracking_number?: string | null /** @description A link to the shipping carrier's site where you can view detailed information about a card shipment. */ - tracking_url?: string | null; + tracking_url?: string | null /** * @description Packaging options. * @enum {string} */ - type: "bulk" | "individual"; - } & { [key: string]: unknown }; + type: 'bulk' | 'individual' + } & { [key: string]: unknown } /** IssuingCardSpendingLimit */ issuing_card_spending_limit: { /** @description Maximum amount allowed to spend per interval. */ - amount: number; + amount: number /** @description 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?: | ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' )[] - | null; + | null /** * @description Interval (or event) to which the amount applies. * @enum {string} */ - interval: "all_time" | "daily" | "monthly" | "per_authorization" | "weekly" | "yearly"; - } & { [key: string]: unknown }; + interval: 'all_time' | 'daily' | 'monthly' | 'per_authorization' | 'weekly' | 'yearly' + } & { [key: string]: unknown } /** IssuingCardWallets */ issuing_card_wallets: { - apple_pay: components["schemas"]["issuing_card_apple_pay"]; - google_pay: components["schemas"]["issuing_card_google_pay"]; + apple_pay: components['schemas']['issuing_card_apple_pay'] + google_pay: components['schemas']['issuing_card_google_pay'] /** @description Unique identifier for a card used with digital wallets */ - primary_account_identifier?: string | null; - } & { [key: string]: unknown }; + primary_account_identifier?: string | null + } & { [key: string]: unknown } /** IssuingCardholderAddress */ issuing_cardholder_address: { - address: components["schemas"]["address"]; - } & { [key: string]: unknown }; + address: components['schemas']['address'] + } & { [key: string]: unknown } /** IssuingCardholderAuthorizationControls */ issuing_cardholder_authorization_controls: { /** @description 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?: | ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' )[] - | null; + | null /** @description 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?: | ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' )[] - | null; + | null /** @description Limit spending with amount-based rules that apply across this cardholder's cards. */ - spending_limits?: components["schemas"]["issuing_cardholder_spending_limit"][] | null; + spending_limits?: components['schemas']['issuing_cardholder_spending_limit'][] | null /** @description Currency of the amounts within `spending_limits`. */ - spending_limits_currency?: string | null; - } & { [key: string]: unknown }; + spending_limits_currency?: string | null + } & { [key: string]: unknown } /** IssuingCardholderCompany */ issuing_cardholder_company: { /** @description Whether the company's business ID number was provided. */ - tax_id_provided: boolean; - } & { [key: string]: unknown }; + tax_id_provided: boolean + } & { [key: string]: unknown } /** IssuingCardholderIdDocument */ issuing_cardholder_id_document: { /** @description 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?: ((Partial & Partial) & { [key: string]: unknown }) | null; + back?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description 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?: ((Partial & Partial) & { [key: string]: unknown }) | null; - } & { [key: string]: unknown }; + front?: ((Partial & Partial) & { [key: string]: unknown }) | null + } & { [key: string]: unknown } /** IssuingCardholderIndividual */ issuing_cardholder_individual: { /** @description The date of birth of this cardholder. */ - dob?: (Partial & { [key: string]: unknown }) | null; + dob?: (Partial & { [key: string]: unknown }) | null /** @description The first name of this cardholder. */ - first_name: string; + first_name: string /** @description The last name of this cardholder. */ - last_name: string; + last_name: string /** @description Government-issued ID document for this cardholder. */ - verification?: - | (Partial & { [key: string]: unknown }) - | null; - } & { [key: string]: unknown }; + verification?: (Partial & { [key: string]: unknown }) | null + } & { [key: string]: unknown } /** IssuingCardholderIndividualDOB */ issuing_cardholder_individual_dob: { /** @description The day of birth, between 1 and 31. */ - day?: number | null; + day?: number | null /** @description The month of birth, between 1 and 12. */ - month?: number | null; + month?: number | null /** @description The four-digit year of birth. */ - year?: number | null; - } & { [key: string]: unknown }; + year?: number | null + } & { [key: string]: unknown } /** IssuingCardholderRequirements */ issuing_cardholder_requirements: { /** * @description If `disabled_reason` is present, all cards will decline authorizations with `cardholder_verification_required` reason. * @enum {string|null} */ - disabled_reason?: ("listed" | "rejected.listed" | "under_review") | null; + disabled_reason?: ('listed' | 'rejected.listed' | 'under_review') | null /** @description Array of fields that need to be collected in order to verify and re-enable the cardholder. */ past_due?: | ( - | "company.tax_id" - | "individual.dob.day" - | "individual.dob.month" - | "individual.dob.year" - | "individual.first_name" - | "individual.last_name" - | "individual.verification.document" + | 'company.tax_id' + | 'individual.dob.day' + | 'individual.dob.month' + | 'individual.dob.year' + | 'individual.first_name' + | 'individual.last_name' + | 'individual.verification.document' )[] - | null; - } & { [key: string]: unknown }; + | null + } & { [key: string]: unknown } /** IssuingCardholderSpendingLimit */ issuing_cardholder_spending_limit: { /** @description Maximum amount allowed to spend per interval. */ - amount: number; + amount: number /** @description 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?: | ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' )[] - | null; + | null /** * @description Interval (or event) to which the amount applies. * @enum {string} */ - interval: "all_time" | "daily" | "monthly" | "per_authorization" | "weekly" | "yearly"; - } & { [key: string]: unknown }; + interval: 'all_time' | 'daily' | 'monthly' | 'per_authorization' | 'weekly' | 'yearly' + } & { [key: string]: unknown } /** IssuingCardholderVerification */ issuing_cardholder_verification: { /** @description An identifying document, either a passport or local ID card. */ - document?: (Partial & { [key: string]: unknown }) | null; - } & { [key: string]: unknown }; + document?: (Partial & { [key: string]: unknown }) | null + } & { [key: string]: unknown } /** IssuingDisputeCanceledEvidence */ issuing_dispute_canceled_evidence: { /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ - additional_documentation?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + additional_documentation?: ((Partial & Partial) & { [key: string]: unknown }) | null /** * Format: unix-time * @description Date when order was canceled. */ - canceled_at?: number | null; + canceled_at?: number | null /** @description Whether the cardholder was provided with a cancellation policy. */ - cancellation_policy_provided?: boolean | null; + cancellation_policy_provided?: boolean | null /** @description Reason for canceling the order. */ - cancellation_reason?: string | null; + cancellation_reason?: string | null /** * Format: unix-time * @description Date when the cardholder expected to receive the product. */ - expected_at?: number | null; + expected_at?: number | null /** @description Explanation of why the cardholder is disputing this transaction. */ - explanation?: string | null; + explanation?: string | null /** @description Description of the merchandise or service that was purchased. */ - product_description?: string | null; + product_description?: string | null /** * @description Whether the product was a merchandise or service. * @enum {string|null} */ - product_type?: ("merchandise" | "service") | null; + product_type?: ('merchandise' | 'service') | null /** * @description Result of cardholder's attempt to return the product. * @enum {string|null} */ - return_status?: ("merchant_rejected" | "successful") | null; + return_status?: ('merchant_rejected' | 'successful') | null /** * Format: unix-time * @description Date when the product was returned or attempted to be returned. */ - returned_at?: number | null; - } & { [key: string]: unknown }; + returned_at?: number | null + } & { [key: string]: unknown } /** IssuingDisputeDuplicateEvidence */ issuing_dispute_duplicate_evidence: { /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ - additional_documentation?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + additional_documentation?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description (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?: ((Partial & Partial) & { [key: string]: unknown }) | null; + card_statement?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description (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?: ((Partial & Partial) & { [key: string]: unknown }) | null; + cash_receipt?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description (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?: ((Partial & Partial) & { [key: string]: unknown }) | null; + check_image?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description Explanation of why the cardholder is disputing this transaction. */ - explanation?: string | null; + explanation?: string | null /** @description 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?: string | null; - } & { [key: string]: unknown }; + original_transaction?: string | null + } & { [key: string]: unknown } /** IssuingDisputeEvidence */ issuing_dispute_evidence: { - canceled?: components["schemas"]["issuing_dispute_canceled_evidence"]; - duplicate?: components["schemas"]["issuing_dispute_duplicate_evidence"]; - fraudulent?: components["schemas"]["issuing_dispute_fraudulent_evidence"]; - merchandise_not_as_described?: components["schemas"]["issuing_dispute_merchandise_not_as_described_evidence"]; - not_received?: components["schemas"]["issuing_dispute_not_received_evidence"]; - other?: components["schemas"]["issuing_dispute_other_evidence"]; + canceled?: components['schemas']['issuing_dispute_canceled_evidence'] + duplicate?: components['schemas']['issuing_dispute_duplicate_evidence'] + fraudulent?: components['schemas']['issuing_dispute_fraudulent_evidence'] + merchandise_not_as_described?: components['schemas']['issuing_dispute_merchandise_not_as_described_evidence'] + not_received?: components['schemas']['issuing_dispute_not_received_evidence'] + other?: components['schemas']['issuing_dispute_other_evidence'] /** * @description The reason for filing the dispute. Its value will match the field containing the evidence. * @enum {string} */ - reason: - | "canceled" - | "duplicate" - | "fraudulent" - | "merchandise_not_as_described" - | "not_received" - | "other" - | "service_not_as_described"; - service_not_as_described?: components["schemas"]["issuing_dispute_service_not_as_described_evidence"]; - } & { [key: string]: unknown }; + reason: 'canceled' | 'duplicate' | 'fraudulent' | 'merchandise_not_as_described' | 'not_received' | 'other' | 'service_not_as_described' + service_not_as_described?: components['schemas']['issuing_dispute_service_not_as_described_evidence'] + } & { [key: string]: unknown } /** IssuingDisputeFraudulentEvidence */ issuing_dispute_fraudulent_evidence: { /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ - additional_documentation?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + additional_documentation?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description Explanation of why the cardholder is disputing this transaction. */ - explanation?: string | null; - } & { [key: string]: unknown }; + explanation?: string | null + } & { [key: string]: unknown } /** IssuingDisputeMerchandiseNotAsDescribedEvidence */ issuing_dispute_merchandise_not_as_described_evidence: { /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ - additional_documentation?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + additional_documentation?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description Explanation of why the cardholder is disputing this transaction. */ - explanation?: string | null; + explanation?: string | null /** * Format: unix-time * @description Date when the product was received. */ - received_at?: number | null; + received_at?: number | null /** @description Description of the cardholder's attempt to return the product. */ - return_description?: string | null; + return_description?: string | null /** * @description Result of cardholder's attempt to return the product. * @enum {string|null} */ - return_status?: ("merchant_rejected" | "successful") | null; + return_status?: ('merchant_rejected' | 'successful') | null /** * Format: unix-time * @description Date when the product was returned or attempted to be returned. */ - returned_at?: number | null; - } & { [key: string]: unknown }; + returned_at?: number | null + } & { [key: string]: unknown } /** IssuingDisputeNotReceivedEvidence */ issuing_dispute_not_received_evidence: { /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ - additional_documentation?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + additional_documentation?: ((Partial & Partial) & { [key: string]: unknown }) | null /** * Format: unix-time * @description Date when the cardholder expected to receive the product. */ - expected_at?: number | null; + expected_at?: number | null /** @description Explanation of why the cardholder is disputing this transaction. */ - explanation?: string | null; + explanation?: string | null /** @description Description of the merchandise or service that was purchased. */ - product_description?: string | null; + product_description?: string | null /** * @description Whether the product was a merchandise or service. * @enum {string|null} */ - product_type?: ("merchandise" | "service") | null; - } & { [key: string]: unknown }; + product_type?: ('merchandise' | 'service') | null + } & { [key: string]: unknown } /** IssuingDisputeOtherEvidence */ issuing_dispute_other_evidence: { /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ - additional_documentation?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + additional_documentation?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description Explanation of why the cardholder is disputing this transaction. */ - explanation?: string | null; + explanation?: string | null /** @description Description of the merchandise or service that was purchased. */ - product_description?: string | null; + product_description?: string | null /** * @description Whether the product was a merchandise or service. * @enum {string|null} */ - product_type?: ("merchandise" | "service") | null; - } & { [key: string]: unknown }; + product_type?: ('merchandise' | 'service') | null + } & { [key: string]: unknown } /** IssuingDisputeServiceNotAsDescribedEvidence */ issuing_dispute_service_not_as_described_evidence: { /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ - additional_documentation?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + additional_documentation?: ((Partial & Partial) & { [key: string]: unknown }) | null /** * Format: unix-time * @description Date when order was canceled. */ - canceled_at?: number | null; + canceled_at?: number | null /** @description Reason for canceling the order. */ - cancellation_reason?: string | null; + cancellation_reason?: string | null /** @description Explanation of why the cardholder is disputing this transaction. */ - explanation?: string | null; + explanation?: string | null /** * Format: unix-time * @description Date when the product was received. */ - received_at?: number | null; - } & { [key: string]: unknown }; + received_at?: number | null + } & { [key: string]: unknown } /** IssuingTransactionAmountDetails */ issuing_transaction_amount_details: { /** @description The fee charged by the ATM for the cash withdrawal. */ - atm_fee?: number | null; - } & { [key: string]: unknown }; + atm_fee?: number | null + } & { [key: string]: unknown } /** IssuingTransactionFlightData */ issuing_transaction_flight_data: { /** @description The time that the flight departed. */ - departure_at?: number | null; + departure_at?: number | null /** @description The name of the passenger. */ - passenger_name?: string | null; + passenger_name?: string | null /** @description Whether the ticket is refundable. */ - refundable?: boolean | null; + refundable?: boolean | null /** @description The legs of the trip. */ - segments?: components["schemas"]["issuing_transaction_flight_data_leg"][] | null; + segments?: components['schemas']['issuing_transaction_flight_data_leg'][] | null /** @description The travel agency that issued the ticket. */ - travel_agency?: string | null; - } & { [key: string]: unknown }; + travel_agency?: string | null + } & { [key: string]: unknown } /** IssuingTransactionFlightDataLeg */ issuing_transaction_flight_data_leg: { /** @description The three-letter IATA airport code of the flight's destination. */ - arrival_airport_code?: string | null; + arrival_airport_code?: string | null /** @description The airline carrier code. */ - carrier?: string | null; + carrier?: string | null /** @description The three-letter IATA airport code that the flight departed from. */ - departure_airport_code?: string | null; + departure_airport_code?: string | null /** @description The flight number. */ - flight_number?: string | null; + flight_number?: string | null /** @description The flight's service class. */ - service_class?: string | null; + service_class?: string | null /** @description Whether a stopover is allowed on this flight. */ - stopover_allowed?: boolean | null; - } & { [key: string]: unknown }; + stopover_allowed?: boolean | null + } & { [key: string]: unknown } /** IssuingTransactionFuelData */ issuing_transaction_fuel_data: { /** @description The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`. */ - type: string; + type: string /** @description The units for `volume_decimal`. One of `us_gallon` or `liter`. */ - unit: string; + unit: string /** * Format: decimal * @description The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places. */ - unit_cost_decimal: string; + unit_cost_decimal: string /** * Format: decimal * @description The volume of the fuel that was pumped, represented as a decimal string with at most 12 decimal places. */ - volume_decimal?: string | null; - } & { [key: string]: unknown }; + volume_decimal?: string | null + } & { [key: string]: unknown } /** IssuingTransactionLodgingData */ issuing_transaction_lodging_data: { /** @description The time of checking into the lodging. */ - check_in_at?: number | null; + check_in_at?: number | null /** @description The number of nights stayed at the lodging. */ - nights?: number | null; - } & { [key: string]: unknown }; + nights?: number | null + } & { [key: string]: unknown } /** IssuingTransactionPurchaseDetails */ issuing_transaction_purchase_details: { /** @description Information about the flight that was purchased with this transaction. */ - flight?: (Partial & { [key: string]: unknown }) | null; + flight?: (Partial & { [key: string]: unknown }) | null /** @description Information about fuel that was purchased with this transaction. */ - fuel?: (Partial & { [key: string]: unknown }) | null; + fuel?: (Partial & { [key: string]: unknown }) | null /** @description Information about lodging that was purchased with this transaction. */ - lodging?: - | (Partial & { [key: string]: unknown }) - | null; + lodging?: (Partial & { [key: string]: unknown }) | null /** @description The line items in the purchase. */ - receipt?: components["schemas"]["issuing_transaction_receipt_data"][] | null; + receipt?: components['schemas']['issuing_transaction_receipt_data'][] | null /** @description A merchant-specific order number. */ - reference?: string | null; - } & { [key: string]: unknown }; + reference?: string | null + } & { [key: string]: unknown } /** IssuingTransactionReceiptData */ issuing_transaction_receipt_data: { /** @description The description of the item. The maximum length of this field is 26 characters. */ - description?: string | null; + description?: string | null /** @description The quantity of the item. */ - quantity?: number | null; + quantity?: number | null /** @description The total for this line item in cents. */ - total?: number | null; + total?: number | null /** @description The unit cost of the item in cents. */ - unit_cost?: number | null; - } & { [key: string]: unknown }; + unit_cost?: number | null + } & { [key: string]: unknown } /** * LineItem * @description A line item. */ item: { /** @description Total before any discounts or taxes are applied. */ - amount_subtotal: number; + amount_subtotal: number /** @description Total after discounts and taxes. */ - amount_total: number; + amount_total: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name. */ - description: string; + description: string /** @description The discounts applied to the line item. */ - discounts?: components["schemas"]["line_items_discount_amount"][]; + discounts?: components['schemas']['line_items_discount_amount'][] /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "item"; + object: 'item' /** @description The price used to generate the line item. */ - price?: (Partial & { [key: string]: unknown }) | null; + price?: (Partial & { [key: string]: unknown }) | null /** @description The quantity of products being purchased. */ - quantity?: number | null; + quantity?: number | null /** @description The taxes applied to the line item. */ - taxes?: components["schemas"]["line_items_tax_amount"][]; - } & { [key: string]: unknown }; + taxes?: components['schemas']['line_items_tax_amount'][] + } & { [key: string]: unknown } /** LegalEntityCompany */ legal_entity_company: { - address?: components["schemas"]["address"]; + address?: components['schemas']['address'] /** @description The Kana variation of the company's primary address (Japan only). */ - address_kana?: (Partial & { [key: string]: unknown }) | null; + address_kana?: (Partial & { [key: string]: unknown }) | null /** @description The Kanji variation of the company's primary address (Japan only). */ - address_kanji?: - | (Partial & { [key: string]: unknown }) - | null; + address_kanji?: (Partial & { [key: string]: unknown }) | null /** @description 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?: boolean; + directors_provided?: boolean /** @description 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?: boolean; + executives_provided?: boolean /** @description The company's legal name. */ - name?: string | null; + name?: string | null /** @description The Kana variation of the company's legal name (Japan only). */ - name_kana?: string | null; + name_kana?: string | null /** @description The Kanji variation of the company's legal name (Japan only). */ - name_kanji?: string | null; + name_kanji?: string | null /** @description 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?: boolean; + owners_provided?: boolean /** @description This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct. */ - ownership_declaration?: - | (Partial & { [key: string]: unknown }) - | null; + ownership_declaration?: (Partial & { [key: string]: unknown }) | null /** @description The company's phone number (used for verification). */ - phone?: string | null; + phone?: string | null /** * @description 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. * @enum {string} */ structure?: - | "free_zone_establishment" - | "free_zone_llc" - | "government_instrumentality" - | "governmental_unit" - | "incorporated_non_profit" - | "limited_liability_partnership" - | "llc" - | "multi_member_llc" - | "private_company" - | "private_corporation" - | "private_partnership" - | "public_company" - | "public_corporation" - | "public_partnership" - | "single_member_llc" - | "sole_establishment" - | "sole_proprietorship" - | "tax_exempt_government_instrumentality" - | "unincorporated_association" - | "unincorporated_non_profit"; + | 'free_zone_establishment' + | 'free_zone_llc' + | 'government_instrumentality' + | 'governmental_unit' + | 'incorporated_non_profit' + | 'limited_liability_partnership' + | 'llc' + | 'multi_member_llc' + | 'private_company' + | 'private_corporation' + | 'private_partnership' + | 'public_company' + | 'public_corporation' + | 'public_partnership' + | 'single_member_llc' + | 'sole_establishment' + | 'sole_proprietorship' + | 'tax_exempt_government_instrumentality' + | 'unincorporated_association' + | 'unincorporated_non_profit' /** @description Whether the company's business ID number was provided. */ - tax_id_provided?: boolean; + tax_id_provided?: boolean /** @description The jurisdiction in which the `tax_id` is registered (Germany-based companies only). */ - tax_id_registrar?: string; + tax_id_registrar?: string /** @description Whether the company's business VAT number was provided. */ - vat_id_provided?: boolean; + vat_id_provided?: boolean /** @description Information on the verification state of the company. */ - verification?: - | (Partial & { [key: string]: unknown }) - | null; - } & { [key: string]: unknown }; + verification?: (Partial & { [key: string]: unknown }) | null + } & { [key: string]: unknown } /** LegalEntityCompanyVerification */ legal_entity_company_verification: { - document: components["schemas"]["legal_entity_company_verification_document"]; - } & { [key: string]: unknown }; + document: components['schemas']['legal_entity_company_verification_document'] + } & { [key: string]: unknown } /** LegalEntityCompanyVerificationDocument */ legal_entity_company_verification_document: { /** @description 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?: ((Partial & Partial) & { [key: string]: unknown }) | null; + back?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description A user-displayable string describing the verification state of this document. */ - details?: string | null; + details?: string | null /** @description 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?: string | null; + details_code?: string | null /** @description 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?: ((Partial & Partial) & { [key: string]: unknown }) | null; - } & { [key: string]: unknown }; + front?: ((Partial & Partial) & { [key: string]: unknown }) | null + } & { [key: string]: unknown } /** LegalEntityDOB */ legal_entity_dob: { /** @description The day of birth, between 1 and 31. */ - day?: number | null; + day?: number | null /** @description The month of birth, between 1 and 12. */ - month?: number | null; + month?: number | null /** @description The four-digit year of birth. */ - year?: number | null; - } & { [key: string]: unknown }; + year?: number | null + } & { [key: string]: unknown } /** LegalEntityJapanAddress */ legal_entity_japan_address: { /** @description City/Ward. */ - city?: string | null; + city?: string | null /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ - country?: string | null; + country?: string | null /** @description Block/Building number. */ - line1?: string | null; + line1?: string | null /** @description Building details. */ - line2?: string | null; + line2?: string | null /** @description ZIP or postal code. */ - postal_code?: string | null; + postal_code?: string | null /** @description Prefecture. */ - state?: string | null; + state?: string | null /** @description Town/cho-me. */ - town?: string | null; - } & { [key: string]: unknown }; + town?: string | null + } & { [key: string]: unknown } /** LegalEntityPersonVerification */ legal_entity_person_verification: { /** @description A document showing address, either a passport, local ID card, or utility bill from a well-known utility company. */ - additional_document?: - | (Partial & { [key: string]: unknown }) - | null; + additional_document?: (Partial & { [key: string]: unknown }) | null /** @description A user-displayable string describing the verification state for the person. For example, this may say "Provided identity information could not be verified". */ - details?: string | null; + details?: string | null /** @description 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?: string | null; - document?: components["schemas"]["legal_entity_person_verification_document"]; + details_code?: string | null + document?: components['schemas']['legal_entity_person_verification_document'] /** @description The state of verification for the person. Possible values are `unverified`, `pending`, or `verified`. */ - status: string; - } & { [key: string]: unknown }; + status: string + } & { [key: string]: unknown } /** LegalEntityPersonVerificationDocument */ legal_entity_person_verification_document: { /** @description 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?: ((Partial & Partial) & { [key: string]: unknown }) | null; + back?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description 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?: string | null; + details?: string | null /** @description 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?: string | null; + details_code?: string | null /** @description 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?: ((Partial & Partial) & { [key: string]: unknown }) | null; - } & { [key: string]: unknown }; + front?: ((Partial & Partial) & { [key: string]: unknown }) | null + } & { [key: string]: unknown } /** LegalEntityUBODeclaration */ legal_entity_ubo_declaration: { /** * Format: unix-time * @description The Unix timestamp marking when the beneficial owner attestation was made. */ - date?: number | null; + date?: number | null /** @description The IP address from which the beneficial owner attestation was made. */ - ip?: string | null; + ip?: string | null /** @description The user-agent string from the browser where the beneficial owner attestation was made. */ - user_agent?: string | null; - } & { [key: string]: unknown }; + user_agent?: string | null + } & { [key: string]: unknown } /** InvoiceLineItem */ line_item: { /** @description The amount, in %s. */ - amount: number; + amount: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description The amount of discount calculated per discount for this line item. */ - discount_amounts?: components["schemas"]["discounts_resource_discount_amount"][] | null; + discount_amounts?: components['schemas']['discounts_resource_discount_amount'][] | null /** @description If true, discounts will apply to this line item. Always false for prorations. */ - discountable: boolean; + discountable: boolean /** @description The discounts applied to the invoice line item. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount. */ - discounts?: - | ((Partial & Partial) & { [key: string]: unknown })[] - | null; + discounts?: ((Partial & Partial) & { [key: string]: unknown })[] | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The ID of the [invoice item](https://stripe.com/docs/api/invoiceitems) associated with this line item if any. */ - invoice_item?: string; + invoice_item?: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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` this will reflect the metadata of the subscription that caused the line item to be created. */ - metadata: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "line_item"; - period: components["schemas"]["invoice_line_item_period"]; + object: 'line_item' + period: components['schemas']['invoice_line_item_period'] /** @description The price of the line item. */ - price?: (Partial & { [key: string]: unknown }) | null; + price?: (Partial & { [key: string]: unknown }) | null /** @description Whether this is a proration. */ - proration: boolean; + proration: boolean /** @description The quantity of the subscription, if the line item is a subscription or a proration. */ - quantity?: number | null; + quantity?: number | null /** @description The subscription that the invoice item pertains to, if any. */ - subscription?: string | null; + subscription?: string | null /** @description The subscription item that generated this invoice item. Left empty if the line item is not an explicit result of a subscription. */ - subscription_item?: string; + subscription_item?: string /** @description The amount of tax calculated per tax rate for this line item */ - tax_amounts?: components["schemas"]["invoice_tax_amount"][]; + tax_amounts?: components['schemas']['invoice_tax_amount'][] /** @description The tax rates which apply to the line item. */ - tax_rates?: components["schemas"]["tax_rate"][]; + tax_rates?: components['schemas']['tax_rate'][] /** * @description A string identifying the type of the source of this line item, either an `invoiceitem` or a `subscription`. * @enum {string} */ - type: "invoiceitem" | "subscription"; - } & { [key: string]: unknown }; + type: 'invoiceitem' | 'subscription' + } & { [key: string]: unknown } /** LineItemsDiscountAmount */ line_items_discount_amount: { /** @description The amount discounted. */ - amount: number; - discount: components["schemas"]["discount"]; - } & { [key: string]: unknown }; + amount: number + discount: components['schemas']['discount'] + } & { [key: string]: unknown } /** LineItemsTaxAmount */ line_items_tax_amount: { /** @description Amount of tax applied for this rate. */ - amount: number; - rate: components["schemas"]["tax_rate"]; - } & { [key: string]: unknown }; + amount: number + rate: components['schemas']['tax_rate'] + } & { [key: string]: unknown } /** LoginLink */ login_link: { /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "login_link"; + object: 'login_link' /** @description The URL for the login link. */ - url: string; - } & { [key: string]: unknown }; + url: string + } & { [key: string]: unknown } /** * Mandate * @description A Mandate is a record of the permission a customer has given you to debit their payment method. */ mandate: { - customer_acceptance: components["schemas"]["customer_acceptance"]; + customer_acceptance: components['schemas']['customer_acceptance'] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; - multi_use?: components["schemas"]["mandate_multi_use"]; + livemode: boolean + multi_use?: components['schemas']['mandate_multi_use'] /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "mandate"; + object: 'mandate' /** @description ID of the payment method associated with this mandate. */ - payment_method: (Partial & Partial) & { [key: string]: unknown }; - payment_method_details: components["schemas"]["mandate_payment_method_details"]; - single_use?: components["schemas"]["mandate_single_use"]; + payment_method: (Partial & Partial) & { [key: string]: unknown } + payment_method_details: components['schemas']['mandate_payment_method_details'] + single_use?: components['schemas']['mandate_single_use'] /** * @description The status of the mandate, which indicates whether it can be used to initiate a payment. * @enum {string} */ - status: "active" | "inactive" | "pending"; + status: 'active' | 'inactive' | 'pending' /** * @description The type of the mandate. * @enum {string} */ - type: "multi_use" | "single_use"; - } & { [key: string]: unknown }; + type: 'multi_use' | 'single_use' + } & { [key: string]: unknown } /** mandate_acss_debit */ mandate_acss_debit: { /** @description List of Stripe products where this mandate can be selected automatically. */ - default_for?: ("invoice" | "subscription")[]; + default_for?: ('invoice' | 'subscription')[] /** @description Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. */ - interval_description?: string | null; + interval_description?: string | null /** * @description Payment schedule for the mandate. * @enum {string} */ - payment_schedule: "combined" | "interval" | "sporadic"; + payment_schedule: 'combined' | 'interval' | 'sporadic' /** * @description Transaction type of the mandate. * @enum {string} */ - transaction_type: "business" | "personal"; - } & { [key: string]: unknown }; + transaction_type: 'business' | 'personal' + } & { [key: string]: unknown } /** mandate_au_becs_debit */ mandate_au_becs_debit: { /** @description The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively. */ - url: string; - } & { [key: string]: unknown }; + url: string + } & { [key: string]: unknown } /** mandate_bacs_debit */ mandate_bacs_debit: { /** * @description The status of the mandate on the Bacs network. Can be one of `pending`, `revoked`, `refused`, or `accepted`. * @enum {string} */ - network_status: "accepted" | "pending" | "refused" | "revoked"; + network_status: 'accepted' | 'pending' | 'refused' | 'revoked' /** @description The unique reference identifying the mandate on the Bacs network. */ - reference: string; + reference: string /** @description The URL that will contain the mandate that the customer has signed. */ - url: string; - } & { [key: string]: unknown }; + url: string + } & { [key: string]: unknown } /** mandate_multi_use */ - mandate_multi_use: { [key: string]: unknown }; + mandate_multi_use: { [key: string]: unknown } /** mandate_payment_method_details */ mandate_payment_method_details: { - acss_debit?: components["schemas"]["mandate_acss_debit"]; - au_becs_debit?: components["schemas"]["mandate_au_becs_debit"]; - bacs_debit?: components["schemas"]["mandate_bacs_debit"]; - card?: components["schemas"]["card_mandate_payment_method_details"]; - sepa_debit?: components["schemas"]["mandate_sepa_debit"]; + acss_debit?: components['schemas']['mandate_acss_debit'] + au_becs_debit?: components['schemas']['mandate_au_becs_debit'] + bacs_debit?: components['schemas']['mandate_bacs_debit'] + card?: components['schemas']['card_mandate_payment_method_details'] + sepa_debit?: components['schemas']['mandate_sepa_debit'] /** @description The type of the payment method associated with this mandate. An additional hash is included on `payment_method_details` with a name matching this value. It contains mandate information specific to the payment method. */ - type: string; - } & { [key: string]: unknown }; + type: string + } & { [key: string]: unknown } /** mandate_sepa_debit */ mandate_sepa_debit: { /** @description The unique reference of the mandate. */ - reference: string; + reference: string /** @description The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively. */ - url: string; - } & { [key: string]: unknown }; + url: string + } & { [key: string]: unknown } /** mandate_single_use */ mandate_single_use: { /** @description On a single use mandate, the amount of the payment. */ - amount: number; + amount: number /** @description On a single use mandate, the currency of the payment. */ - currency: string; - } & { [key: string]: unknown }; + currency: string + } & { [key: string]: unknown } /** networks */ networks: { /** @description All available networks for the card. */ - available: string[]; + available: string[] /** @description The preferred network for the card. */ - preferred?: string | null; - } & { [key: string]: unknown }; + preferred?: string | null + } & { [key: string]: unknown } /** NotificationEventData */ notification_event_data: { /** @description 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: { [key: string]: unknown }; + object: { [key: string]: unknown } /** @description Object containing the names of the attributes that have changed, and their previous values (sent along only with *.updated events). */ - previous_attributes?: { [key: string]: unknown }; - } & { [key: string]: unknown }; + previous_attributes?: { [key: string]: unknown } + } & { [key: string]: unknown } /** NotificationEventRequest */ notification_event_request: { /** @description 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?: string | null; + id?: string | null /** @description 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?: string | null; - } & { [key: string]: unknown }; + idempotency_key?: string | null + } & { [key: string]: unknown } /** offline_acceptance */ - offline_acceptance: { [key: string]: unknown }; + offline_acceptance: { [key: string]: unknown } /** online_acceptance */ online_acceptance: { /** @description The IP address from which the Mandate was accepted by the customer. */ - ip_address?: string | null; + ip_address?: string | null /** @description The user agent of the browser from which the Mandate was accepted by the customer. */ - user_agent?: string | null; - } & { [key: string]: unknown }; + user_agent?: string | null + } & { [key: string]: unknown } /** * Order * @description Order objects are created to handle end customers' purchases of previously @@ -8772,45 +8588,45 @@ export interface components { */ order: { /** @description 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: number; + amount: number /** @description The total amount that was returned to the customer. */ - amount_returned?: number | null; + amount_returned?: number | null /** @description ID of the Connect Application that created the order. */ - application?: string | null; + application?: string | null /** @description A fee in cents that will be applied to the order and transferred to the application owner’s Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees documentation. */ - application_fee?: number | null; + application_fee?: number | null /** @description The ID of the payment used to pay for the order. Present if the order status is `paid`, `fulfilled`, or `refunded`. */ - charge?: ((Partial & Partial) & { [key: string]: unknown }) | null; + charge?: ((Partial & Partial) & { [key: string]: unknown }) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description The customer used for the order. */ customer?: - | ((Partial & - Partial & - Partial) & { [key: string]: unknown }) - | null; + | ((Partial & Partial & Partial) & { + [key: string]: unknown + }) + | null /** @description The email address of the customer placing the order. */ - email?: string | null; + email?: string | null /** @description External coupon code to load for this order. */ - external_coupon_code?: string; + external_coupon_code?: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description List of items constituting the order. An order can have up to 25 items. */ - items: components["schemas"]["order_item"][]; + items: components['schemas']['order_item'][] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "order"; + object: 'order' /** * OrdersResourceOrderReturnList * @description A list of returns that have taken place for this order. @@ -8818,36 +8634,36 @@ export interface components { returns?: | ({ /** @description Details about each object. */ - data: components["schemas"]["order_return"][]; + data: components['schemas']['order_return'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; + url: string } & { [key: string]: unknown }) - | null; + | null /** @description The shipping method that is currently selected for this order, if any. If present, it is equal to one of the `id`s of shipping methods in the `shipping_methods` array. At order creation time, if there are multiple shipping methods, Stripe will automatically selected the first method. */ - selected_shipping_method?: string | null; + selected_shipping_method?: string | null /** @description The shipping address for the order. Present if the order is for goods to be shipped. */ - shipping?: (Partial & { [key: string]: unknown }) | null; + shipping?: (Partial & { [key: string]: unknown }) | null /** @description A list of supported shipping methods for this order. The desired shipping method can be specified either by updating the order, or when paying it. */ - shipping_methods?: components["schemas"]["shipping_method"][] | null; + shipping_methods?: components['schemas']['shipping_method'][] | null /** @description Current order status. One of `created`, `paid`, `canceled`, `fulfilled`, or `returned`. More details in the [Orders Guide](https://stripe.com/docs/orders/guide#understanding-order-statuses). */ - status: string; + status: string /** @description The timestamps at which the order status was updated. */ - status_transitions?: (Partial & { [key: string]: unknown }) | null; + status_transitions?: (Partial & { [key: string]: unknown }) | null /** * Format: unix-time * @description Time at which the object was last updated. Measured in seconds since the Unix epoch. */ - updated?: number | null; + updated?: number | null /** @description The user's order ID if it is different from the Stripe order ID. */ - upstream_id?: string; - } & { [key: string]: unknown }; + upstream_id?: string + } & { [key: string]: unknown } /** * OrderItem * @description A representation of the constituent items of any given order. Can be used to @@ -8857,23 +8673,23 @@ export interface components { */ order_item: { /** @description 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 line item. */ - amount: number; + amount: number /** @description 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: string; + currency: string /** @description Description of the line item, meant to be displayable to the user (e.g., `"Express shipping"`). */ - description: string; + description: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "order_item"; + object: 'order_item' /** @description The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a SKU). */ - parent?: ((Partial & Partial) & { [key: string]: unknown }) | null; + parent?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description A positive integer representing the number of instances of `parent` that are included in this order item. Applicable/present only if `type` is `sku`. */ - quantity?: number | null; + quantity?: number | null /** @description The type of line item. One of `sku`, `tax`, `shipping`, or `discount`. */ - type: string; - } & { [key: string]: unknown }; + type: string + } & { [key: string]: unknown } /** * OrderReturn * @description A return represents the full or partial return of a number of [order items](https://stripe.com/docs/api#order_items). @@ -8883,66 +8699,66 @@ export interface components { */ order_return: { /** @description 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 returned line item. */ - amount: number; + amount: number /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The items included in this order return. */ - items: components["schemas"]["order_item"][]; + items: components['schemas']['order_item'][] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "order_return"; + object: 'order_return' /** @description The order that this return includes items from. */ - order?: ((Partial & Partial) & { [key: string]: unknown }) | null; + order?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description The ID of the refund issued for this return. */ - refund?: ((Partial & Partial) & { [key: string]: unknown }) | null; - } & { [key: string]: unknown }; + refund?: ((Partial & Partial) & { [key: string]: unknown }) | null + } & { [key: string]: unknown } /** PackageDimensions */ package_dimensions: { /** @description Height, in inches. */ - height: number; + height: number /** @description Length, in inches. */ - length: number; + length: number /** @description Weight, in ounces. */ - weight: number; + weight: number /** @description Width, in inches. */ - width: number; - } & { [key: string]: unknown }; + width: number + } & { [key: string]: unknown } /** PaymentFlowsAutomaticPaymentMethodsPaymentIntent */ payment_flows_automatic_payment_methods_payment_intent: { /** @description Automatically calculates compatible payment methods */ - enabled: boolean; - } & { [key: string]: unknown }; + enabled: boolean + } & { [key: string]: unknown } /** PaymentFlowsPrivatePaymentMethodsAlipay */ - payment_flows_private_payment_methods_alipay: { [key: string]: unknown }; + payment_flows_private_payment_methods_alipay: { [key: string]: unknown } /** PaymentFlowsPrivatePaymentMethodsAlipayDetails */ payment_flows_private_payment_methods_alipay_details: { /** @description Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same. */ - buyer_id?: string; + buyer_id?: string /** @description Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Transaction ID of this particular Alipay transaction. */ - transaction_id?: string | null; - } & { [key: string]: unknown }; + transaction_id?: string | null + } & { [key: string]: unknown } /** PaymentFlowsPrivatePaymentMethodsKlarnaDOB */ payment_flows_private_payment_methods_klarna_dob: { /** @description The day of birth, between 1 and 31. */ - day?: number | null; + day?: number | null /** @description The month of birth, between 1 and 12. */ - month?: number | null; + month?: number | null /** @description The four-digit year of birth. */ - year?: number | null; - } & { [key: string]: unknown }; + year?: number | null + } & { [key: string]: unknown } /** * PaymentIntent * @description A PaymentIntent guides you through the process of collecting a payment from your customer. @@ -8959,65 +8775,53 @@ export interface components { */ payment_intent: { /** @description 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: number; + amount: number /** @description Amount that can be captured from this PaymentIntent. */ - amount_capturable?: number; + amount_capturable?: number /** @description Amount that was collected by this PaymentIntent. */ - amount_received?: number; + amount_received?: number /** @description ID of the Connect application that created the PaymentIntent. */ - application?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + application?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description 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?: number | null; + application_fee_amount?: number | null /** @description Settings to configure compatible payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods) */ automatic_payment_methods?: - | (Partial & { - [key: string]: unknown; - }) - | null; + | (Partial & { [key: string]: unknown }) + | null /** * Format: unix-time * @description Populated when `status` is `canceled`, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch. */ - canceled_at?: number | null; + canceled_at?: number | null /** * @description 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`). * @enum {string|null} */ cancellation_reason?: - | ( - | "abandoned" - | "automatic" - | "duplicate" - | "failed_invoice" - | "fraudulent" - | "requested_by_customer" - | "void_invoice" - ) - | null; + | ('abandoned' | 'automatic' | 'duplicate' | 'failed_invoice' | 'fraudulent' | 'requested_by_customer' | 'void_invoice') + | null /** * @description Controls when the funds will be captured from the customer's account. * @enum {string} */ - capture_method: "automatic" | "manual"; + capture_method: 'automatic' | 'manual' /** * PaymentFlowsPaymentIntentResourceChargeList * @description Charges that were created by this PaymentIntent, if any. */ charges?: { /** @description This list only contains the latest charge, even if there were previously multiple unsuccessful charges. To view all previous charges for a PaymentIntent, you can filter the charges list using the `payment_intent` [parameter](https://stripe.com/docs/api/charges/list#list_charges-payment_intent). */ - data: components["schemas"]["charge"][]; + data: components['schemas']['charge'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; + url: string + } & { [key: string]: unknown } /** * @description The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key. * @@ -9025,16 +8829,16 @@ export interface components { * * Refer to our docs to [accept a payment](https://stripe.com/docs/payments/accept-a-payment?integration=elements) and learn about how `client_secret` should be handled. */ - client_secret?: string | null; + client_secret?: string | null /** @enum {string} */ - confirmation_method: "automatic" | "manual"; + confirmation_method: 'automatic' | 'manual' /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** * @description ID of the Customer this PaymentIntent belongs to, if one exists. * @@ -9043,49 +8847,43 @@ export interface components { * If present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. */ customer?: - | ((Partial & - Partial & - Partial) & { [key: string]: unknown }) - | null; + | ((Partial & Partial & Partial) & { + [key: string]: unknown + }) + | null /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description ID of the invoice that created this PaymentIntent, if it exists. */ - invoice?: ((Partial & Partial) & { [key: string]: unknown }) | null; + invoice?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description 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?: (Partial & { [key: string]: unknown }) | null; + last_payment_error?: (Partial & { [key: string]: unknown }) | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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. For more information, see the [documentation](https://stripe.com/docs/payments/payment-intents/creating-payment-intents#storing-information-in-metadata). */ - metadata?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description 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?: (Partial & { [key: string]: unknown }) | null; + next_action?: (Partial & { [key: string]: unknown }) | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "payment_intent"; + object: 'payment_intent' /** @description 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?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + on_behalf_of?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description ID of the payment method used in this PaymentIntent. */ - payment_method?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + payment_method?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description Payment-method-specific configuration for this PaymentIntent. */ - payment_method_options?: - | (Partial & { [key: string]: unknown }) - | null; + payment_method_options?: (Partial & { [key: string]: unknown }) | null /** @description The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. */ - payment_method_types: string[]; + payment_method_types: string[] /** @description If present, this property tells you about the processing state of the payment. */ - processing?: (Partial & { [key: string]: unknown }) | null; + processing?: (Partial & { [key: string]: unknown }) | null /** @description 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?: string | null; + receipt_email?: string | null /** @description ID of the review associated with this PaymentIntent, if any. */ - review?: ((Partial & Partial) & { [key: string]: unknown }) | null; + review?: ((Partial & Partial) & { [key: string]: unknown }) | null /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * @@ -9094,232 +8892,183 @@ export interface components { * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string|null} */ - setup_future_usage?: ("off_session" | "on_session") | null; + setup_future_usage?: ('off_session' | 'on_session') | null /** @description Shipping information for this PaymentIntent. */ - shipping?: (Partial & { [key: string]: unknown }) | null; + shipping?: (Partial & { [key: string]: unknown }) | null /** @description For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - statement_descriptor?: string | null; + statement_descriptor?: string | null /** @description Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - statement_descriptor_suffix?: string | null; + statement_descriptor_suffix?: string | null /** * @description 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). * @enum {string} */ - status: - | "canceled" - | "processing" - | "requires_action" - | "requires_capture" - | "requires_confirmation" - | "requires_payment_method" - | "succeeded"; + status: 'canceled' | 'processing' | 'requires_action' | 'requires_capture' | 'requires_confirmation' | 'requires_payment_method' | 'succeeded' /** @description The data with which to automatically create a Transfer when the payment is finalized. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. */ - transfer_data?: (Partial & { [key: string]: unknown }) | null; + transfer_data?: (Partial & { [key: string]: unknown }) | null /** @description A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. */ - transfer_group?: string | null; - } & { [key: string]: unknown }; + transfer_group?: string | null + } & { [key: string]: unknown } /** PaymentIntentCardProcessing */ - payment_intent_card_processing: { [key: string]: unknown }; + payment_intent_card_processing: { [key: string]: unknown } /** PaymentIntentNextAction */ payment_intent_next_action: { - alipay_handle_redirect?: components["schemas"]["payment_intent_next_action_alipay_handle_redirect"]; - boleto_display_details?: components["schemas"]["payment_intent_next_action_boleto"]; - oxxo_display_details?: components["schemas"]["payment_intent_next_action_display_oxxo_details"]; - redirect_to_url?: components["schemas"]["payment_intent_next_action_redirect_to_url"]; + alipay_handle_redirect?: components['schemas']['payment_intent_next_action_alipay_handle_redirect'] + boleto_display_details?: components['schemas']['payment_intent_next_action_boleto'] + oxxo_display_details?: components['schemas']['payment_intent_next_action_display_oxxo_details'] + redirect_to_url?: components['schemas']['payment_intent_next_action_redirect_to_url'] /** @description 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: string; + type: string /** @description 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?: { [key: string]: unknown }; - verify_with_microdeposits?: components["schemas"]["payment_intent_next_action_verify_with_microdeposits"]; - wechat_pay_display_qr_code?: components["schemas"]["payment_intent_next_action_wechat_pay_display_qr_code"]; - wechat_pay_redirect_to_android_app?: components["schemas"]["payment_intent_next_action_wechat_pay_redirect_to_android_app"]; - wechat_pay_redirect_to_ios_app?: components["schemas"]["payment_intent_next_action_wechat_pay_redirect_to_ios_app"]; - } & { [key: string]: unknown }; + use_stripe_sdk?: { [key: string]: unknown } + verify_with_microdeposits?: components['schemas']['payment_intent_next_action_verify_with_microdeposits'] + wechat_pay_display_qr_code?: components['schemas']['payment_intent_next_action_wechat_pay_display_qr_code'] + wechat_pay_redirect_to_android_app?: components['schemas']['payment_intent_next_action_wechat_pay_redirect_to_android_app'] + wechat_pay_redirect_to_ios_app?: components['schemas']['payment_intent_next_action_wechat_pay_redirect_to_ios_app'] + } & { [key: string]: unknown } /** PaymentIntentNextActionAlipayHandleRedirect */ payment_intent_next_action_alipay_handle_redirect: { /** @description 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?: string | null; + native_data?: string | null /** @description The native URL you must redirect your customer to in order to authenticate the payment in an iOS App. */ - native_url?: string | null; + native_url?: string | null /** @description If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion. */ - return_url?: string | null; + return_url?: string | null /** @description The URL you must redirect your customer to in order to authenticate the payment. */ - url?: string | null; - } & { [key: string]: unknown }; + url?: string | null + } & { [key: string]: unknown } /** payment_intent_next_action_boleto */ payment_intent_next_action_boleto: { /** * Format: unix-time * @description The timestamp after which the boleto expires. */ - expires_at?: number | null; + expires_at?: number | null /** @description The URL to the hosted boleto voucher page, which allows customers to view the boleto voucher. */ - hosted_voucher_url?: string | null; + hosted_voucher_url?: string | null /** @description The boleto number. */ - number?: string | null; + number?: string | null /** @description The URL to the downloadable boleto voucher PDF. */ - pdf?: string | null; - } & { [key: string]: unknown }; + pdf?: string | null + } & { [key: string]: unknown } /** PaymentIntentNextActionDisplayOxxoDetails */ payment_intent_next_action_display_oxxo_details: { /** * Format: unix-time * @description The timestamp after which the OXXO voucher expires. */ - expires_after?: number | null; + expires_after?: number | null /** @description The URL for the hosted OXXO voucher page, which allows customers to view and print an OXXO voucher. */ - hosted_voucher_url?: string | null; + hosted_voucher_url?: string | null /** @description OXXO reference number. */ - number?: string | null; - } & { [key: string]: unknown }; + number?: string | null + } & { [key: string]: unknown } /** PaymentIntentNextActionRedirectToUrl */ payment_intent_next_action_redirect_to_url: { /** @description If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion. */ - return_url?: string | null; + return_url?: string | null /** @description The URL you must redirect your customer to in order to authenticate the payment. */ - url?: string | null; - } & { [key: string]: unknown }; + url?: string | null + } & { [key: string]: unknown } /** PaymentIntentNextActionVerifyWithMicrodeposits */ payment_intent_next_action_verify_with_microdeposits: { /** * Format: unix-time * @description The timestamp when the microdeposits are expected to land. */ - arrival_date: number; + arrival_date: number /** @description The URL for the hosted verification page, which allows customers to verify their bank account. */ - hosted_verification_url: string; - } & { [key: string]: unknown }; + hosted_verification_url: string + } & { [key: string]: unknown } /** PaymentIntentNextActionWechatPayDisplayQrCode */ payment_intent_next_action_wechat_pay_display_qr_code: { /** @description The data being used to generate QR code */ - data: string; + data: string /** @description The base64 image data for a pre-generated QR code */ - image_data_url: string; + image_data_url: string /** @description The image_url_png string used to render QR code */ - image_url_png: string; + image_url_png: string /** @description The image_url_svg string used to render QR code */ - image_url_svg: string; - } & { [key: string]: unknown }; + image_url_svg: string + } & { [key: string]: unknown } /** PaymentIntentNextActionWechatPayRedirectToAndroidApp */ payment_intent_next_action_wechat_pay_redirect_to_android_app: { /** @description app_id is the APP ID registered on WeChat open platform */ - app_id: string; + app_id: string /** @description nonce_str is a random string */ - nonce_str: string; + nonce_str: string /** @description package is static value */ - package: string; + package: string /** @description an unique merchant ID assigned by Wechat Pay */ - partner_id: string; + partner_id: string /** @description an unique trading ID assigned by Wechat Pay */ - prepay_id: string; + prepay_id: string /** @description A signature */ - sign: string; + sign: string /** @description Specifies the current time in epoch format */ - timestamp: string; - } & { [key: string]: unknown }; + timestamp: string + } & { [key: string]: unknown } /** PaymentIntentNextActionWechatPayRedirectToIOSApp */ payment_intent_next_action_wechat_pay_redirect_to_ios_app: { /** @description An universal link that redirect to Wechat Pay APP */ - native_url: string; - } & { [key: string]: unknown }; + native_url: string + } & { [key: string]: unknown } /** PaymentIntentPaymentMethodOptions */ payment_intent_payment_method_options: { - acss_debit?: (Partial & - Partial) & { - [key: string]: unknown; - }; - afterpay_clearpay?: (Partial & - Partial) & { - [key: string]: unknown; - }; - alipay?: (Partial & - Partial) & { - [key: string]: unknown; - }; - au_becs_debit?: (Partial & - Partial) & { - [key: string]: unknown; - }; - bacs_debit?: (Partial & - Partial) & { - [key: string]: unknown; - }; - bancontact?: (Partial & - Partial) & { - [key: string]: unknown; - }; - boleto?: (Partial & - Partial) & { - [key: string]: unknown; - }; - card?: (Partial & - Partial) & { - [key: string]: unknown; - }; - card_present?: (Partial & - Partial) & { - [key: string]: unknown; - }; - eps?: (Partial & - Partial) & { - [key: string]: unknown; - }; - fpx?: (Partial & - Partial) & { - [key: string]: unknown; - }; - giropay?: (Partial & - Partial) & { - [key: string]: unknown; - }; - grabpay?: (Partial & - Partial) & { - [key: string]: unknown; - }; - ideal?: (Partial & - Partial) & { - [key: string]: unknown; - }; - interac_present?: (Partial & - Partial) & { - [key: string]: unknown; - }; - klarna?: (Partial & - Partial) & { - [key: string]: unknown; - }; - oxxo?: (Partial & - Partial) & { - [key: string]: unknown; - }; - p24?: (Partial & - Partial) & { - [key: string]: unknown; - }; - sepa_debit?: (Partial & - Partial) & { - [key: string]: unknown; - }; - sofort?: (Partial & - Partial) & { - [key: string]: unknown; - }; - wechat_pay?: (Partial & - Partial) & { - [key: string]: unknown; - }; - } & { [key: string]: unknown }; + acss_debit?: (Partial & + Partial) & { [key: string]: unknown } + afterpay_clearpay?: (Partial & + Partial) & { [key: string]: unknown } + alipay?: (Partial & + Partial) & { [key: string]: unknown } + au_becs_debit?: (Partial & + Partial) & { [key: string]: unknown } + bacs_debit?: (Partial & + Partial) & { [key: string]: unknown } + bancontact?: (Partial & + Partial) & { [key: string]: unknown } + boleto?: (Partial & + Partial) & { [key: string]: unknown } + card?: (Partial & + Partial) & { [key: string]: unknown } + card_present?: (Partial & + Partial) & { [key: string]: unknown } + eps?: (Partial & + Partial) & { [key: string]: unknown } + fpx?: (Partial & + Partial) & { [key: string]: unknown } + giropay?: (Partial & + Partial) & { [key: string]: unknown } + grabpay?: (Partial & + Partial) & { [key: string]: unknown } + ideal?: (Partial & + Partial) & { [key: string]: unknown } + interac_present?: (Partial & + Partial) & { [key: string]: unknown } + klarna?: (Partial & + Partial) & { [key: string]: unknown } + oxxo?: (Partial & + Partial) & { [key: string]: unknown } + p24?: (Partial & + Partial) & { [key: string]: unknown } + sepa_debit?: (Partial & + Partial) & { [key: string]: unknown } + sofort?: (Partial & + Partial) & { [key: string]: unknown } + wechat_pay?: (Partial & + Partial) & { [key: string]: unknown } + } & { [key: string]: unknown } /** payment_intent_payment_method_options_acss_debit */ payment_intent_payment_method_options_acss_debit: { - mandate_options?: components["schemas"]["payment_intent_payment_method_options_mandate_options_acss_debit"]; + mandate_options?: components['schemas']['payment_intent_payment_method_options_mandate_options_acss_debit'] /** * @description Bank account verification method. * @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; - } & { [key: string]: unknown }; + verification_method?: 'automatic' | 'instant' | 'microdeposits' + } & { [key: string]: unknown } /** payment_intent_payment_method_options_au_becs_debit */ - payment_intent_payment_method_options_au_becs_debit: { [key: string]: unknown }; + payment_intent_payment_method_options_au_becs_debit: { [key: string]: unknown } /** payment_intent_payment_method_options_card */ payment_intent_payment_method_options_card: { /** @@ -9327,32 +9076,17 @@ export interface components { * * For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments). */ - installments?: - | (Partial & { [key: string]: unknown }) - | null; + installments?: (Partial & { [key: string]: unknown }) | null /** * @description 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. * @enum {string|null} */ - network?: - | ( - | "amex" - | "cartes_bancaires" - | "diners" - | "discover" - | "interac" - | "jcb" - | "mastercard" - | "unionpay" - | "unknown" - | "visa" - ) - | null; + network?: ('amex' | 'cartes_bancaires' | 'diners' | 'discover' | 'interac' | 'jcb' | 'mastercard' | 'unionpay' | 'unknown' | 'visa') | null /** * @description 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. Permitted values include: `automatic` or `any`. If not provided, defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. * @enum {string|null} */ - request_three_d_secure?: ("any" | "automatic" | "challenge_only") | null; + request_three_d_secure?: ('any' | 'automatic' | 'challenge_only') | null /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * @@ -9361,42 +9095,42 @@ export interface components { * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ - setup_future_usage?: "none" | "off_session" | "on_session"; - } & { [key: string]: unknown }; + setup_future_usage?: 'none' | 'off_session' | 'on_session' + } & { [key: string]: unknown } /** payment_intent_payment_method_options_eps */ - payment_intent_payment_method_options_eps: { [key: string]: unknown }; + payment_intent_payment_method_options_eps: { [key: string]: unknown } /** payment_intent_payment_method_options_mandate_options_acss_debit */ payment_intent_payment_method_options_mandate_options_acss_debit: { /** @description A URL for custom mandate text */ - custom_mandate_url?: string; + custom_mandate_url?: string /** @description Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. */ - interval_description?: string | null; + interval_description?: string | null /** * @description Payment schedule for the mandate. * @enum {string|null} */ - payment_schedule?: ("combined" | "interval" | "sporadic") | null; + payment_schedule?: ('combined' | 'interval' | 'sporadic') | null /** * @description Transaction type of the mandate. * @enum {string|null} */ - transaction_type?: ("business" | "personal") | null; - } & { [key: string]: unknown }; + transaction_type?: ('business' | 'personal') | null + } & { [key: string]: unknown } /** payment_intent_payment_method_options_mandate_options_sepa_debit */ - payment_intent_payment_method_options_mandate_options_sepa_debit: { [key: string]: unknown }; + payment_intent_payment_method_options_mandate_options_sepa_debit: { [key: string]: unknown } /** payment_intent_payment_method_options_sepa_debit */ payment_intent_payment_method_options_sepa_debit: { - mandate_options?: components["schemas"]["payment_intent_payment_method_options_mandate_options_sepa_debit"]; - } & { [key: string]: unknown }; + mandate_options?: components['schemas']['payment_intent_payment_method_options_mandate_options_sepa_debit'] + } & { [key: string]: unknown } /** PaymentIntentProcessing */ payment_intent_processing: { - card?: components["schemas"]["payment_intent_card_processing"]; + card?: components['schemas']['payment_intent_card_processing'] /** * @description Type of the payment method for which payment is in `processing` state, one of `card`. * @enum {string} */ - type: "card"; - } & { [key: string]: unknown }; + type: 'card' + } & { [key: string]: unknown } /** PaymentIntentTypeSpecificPaymentMethodOptionsClient */ payment_intent_type_specific_payment_method_options_client: { /** @@ -9407,8 +9141,8 @@ export interface components { * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ - setup_future_usage?: "none" | "off_session" | "on_session"; - } & { [key: string]: unknown }; + setup_future_usage?: 'none' | 'off_session' | 'on_session' + } & { [key: string]: unknown } /** * PaymentLink * @description A payment link is a shareable URL that will take your customers to a hosted payment page. A payment link can be shared and used multiple times. @@ -9419,357 +9153,349 @@ export interface components { */ payment_link: { /** @description 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: boolean; - after_completion: components["schemas"]["payment_links_resource_after_completion"]; + active: boolean + after_completion: components['schemas']['payment_links_resource_after_completion'] /** @description Whether user redeemable promotion codes are enabled. */ - allow_promotion_codes: boolean; + allow_promotion_codes: boolean /** @description 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?: number | null; + application_fee_amount?: number | null /** @description This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. */ - application_fee_percent?: number | null; - automatic_tax: components["schemas"]["payment_links_resource_automatic_tax"]; + application_fee_percent?: number | null + automatic_tax: components['schemas']['payment_links_resource_automatic_tax'] /** * @description Configuration for collecting the customer's billing address. * @enum {string} */ - billing_address_collection: "auto" | "required"; + billing_address_collection: 'auto' | 'required' /** @description Unique identifier for the object. */ - id: string; + id: string /** * PaymentLinksResourceListLineItems * @description The line items representing what is being sold. */ line_items?: { /** @description Details about each object. */ - data: components["schemas"]["item"][]; + data: components['schemas']['item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; + url: string + } & { [key: string]: unknown } /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "payment_link"; + object: 'payment_link' /** @description 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?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + on_behalf_of?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description 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?: "card"[] | null; - phone_number_collection: components["schemas"]["payment_links_resource_phone_number_collection"]; + payment_method_types?: 'card'[] | null + phone_number_collection: components['schemas']['payment_links_resource_phone_number_collection'] /** @description Configuration for collecting the customer's shipping address. */ shipping_address_collection?: - | (Partial & { - [key: string]: unknown; - }) - | null; + | (Partial & { [key: string]: unknown }) + | null /** @description 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?: - | (Partial & { [key: string]: unknown }) - | null; + subscription_data?: (Partial & { [key: string]: unknown }) | null /** @description 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?: - | (Partial & { [key: string]: unknown }) - | null; + transfer_data?: (Partial & { [key: string]: unknown }) | null /** @description The public URL that can be shared with customers. */ - url: string; - } & { [key: string]: unknown }; + url: string + } & { [key: string]: unknown } /** PaymentLinksResourceAfterCompletion */ payment_links_resource_after_completion: { - hosted_confirmation?: components["schemas"]["payment_links_resource_completion_behavior_confirmation_page"]; - redirect?: components["schemas"]["payment_links_resource_completion_behavior_redirect"]; + hosted_confirmation?: components['schemas']['payment_links_resource_completion_behavior_confirmation_page'] + redirect?: components['schemas']['payment_links_resource_completion_behavior_redirect'] /** * @description The specified behavior after the purchase is complete. * @enum {string} */ - type: "hosted_confirmation" | "redirect"; - } & { [key: string]: unknown }; + type: 'hosted_confirmation' | 'redirect' + } & { [key: string]: unknown } /** PaymentLinksResourceAutomaticTax */ payment_links_resource_automatic_tax: { /** @description If `true`, tax will be calculated automatically using the customer's location. */ - enabled: boolean; - } & { [key: string]: unknown }; + enabled: boolean + } & { [key: string]: unknown } /** PaymentLinksResourceCompletionBehaviorConfirmationPage */ payment_links_resource_completion_behavior_confirmation_page: { /** @description The custom message that is displayed to the customer after the purchase is complete. */ - custom_message?: string | null; - } & { [key: string]: unknown }; + custom_message?: string | null + } & { [key: string]: unknown } /** PaymentLinksResourceCompletionBehaviorRedirect */ payment_links_resource_completion_behavior_redirect: { /** @description The URL the customer will be redirected to after the purchase is complete. */ - url: string; - } & { [key: string]: unknown }; + url: string + } & { [key: string]: unknown } /** PaymentLinksResourcePhoneNumberCollection */ payment_links_resource_phone_number_collection: { /** @description If `true`, a phone number will be collected during checkout. */ - enabled: boolean; - } & { [key: string]: unknown }; + enabled: boolean + } & { [key: string]: unknown } /** PaymentLinksResourceShippingAddressCollection */ payment_links_resource_shipping_address_collection: { /** @description 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: ( - | "AC" - | "AD" - | "AE" - | "AF" - | "AG" - | "AI" - | "AL" - | "AM" - | "AO" - | "AQ" - | "AR" - | "AT" - | "AU" - | "AW" - | "AX" - | "AZ" - | "BA" - | "BB" - | "BD" - | "BE" - | "BF" - | "BG" - | "BH" - | "BI" - | "BJ" - | "BL" - | "BM" - | "BN" - | "BO" - | "BQ" - | "BR" - | "BS" - | "BT" - | "BV" - | "BW" - | "BY" - | "BZ" - | "CA" - | "CD" - | "CF" - | "CG" - | "CH" - | "CI" - | "CK" - | "CL" - | "CM" - | "CN" - | "CO" - | "CR" - | "CV" - | "CW" - | "CY" - | "CZ" - | "DE" - | "DJ" - | "DK" - | "DM" - | "DO" - | "DZ" - | "EC" - | "EE" - | "EG" - | "EH" - | "ER" - | "ES" - | "ET" - | "FI" - | "FJ" - | "FK" - | "FO" - | "FR" - | "GA" - | "GB" - | "GD" - | "GE" - | "GF" - | "GG" - | "GH" - | "GI" - | "GL" - | "GM" - | "GN" - | "GP" - | "GQ" - | "GR" - | "GS" - | "GT" - | "GU" - | "GW" - | "GY" - | "HK" - | "HN" - | "HR" - | "HT" - | "HU" - | "ID" - | "IE" - | "IL" - | "IM" - | "IN" - | "IO" - | "IQ" - | "IS" - | "IT" - | "JE" - | "JM" - | "JO" - | "JP" - | "KE" - | "KG" - | "KH" - | "KI" - | "KM" - | "KN" - | "KR" - | "KW" - | "KY" - | "KZ" - | "LA" - | "LB" - | "LC" - | "LI" - | "LK" - | "LR" - | "LS" - | "LT" - | "LU" - | "LV" - | "LY" - | "MA" - | "MC" - | "MD" - | "ME" - | "MF" - | "MG" - | "MK" - | "ML" - | "MM" - | "MN" - | "MO" - | "MQ" - | "MR" - | "MS" - | "MT" - | "MU" - | "MV" - | "MW" - | "MX" - | "MY" - | "MZ" - | "NA" - | "NC" - | "NE" - | "NG" - | "NI" - | "NL" - | "NO" - | "NP" - | "NR" - | "NU" - | "NZ" - | "OM" - | "PA" - | "PE" - | "PF" - | "PG" - | "PH" - | "PK" - | "PL" - | "PM" - | "PN" - | "PR" - | "PS" - | "PT" - | "PY" - | "QA" - | "RE" - | "RO" - | "RS" - | "RU" - | "RW" - | "SA" - | "SB" - | "SC" - | "SE" - | "SG" - | "SH" - | "SI" - | "SJ" - | "SK" - | "SL" - | "SM" - | "SN" - | "SO" - | "SR" - | "SS" - | "ST" - | "SV" - | "SX" - | "SZ" - | "TA" - | "TC" - | "TD" - | "TF" - | "TG" - | "TH" - | "TJ" - | "TK" - | "TL" - | "TM" - | "TN" - | "TO" - | "TR" - | "TT" - | "TV" - | "TW" - | "TZ" - | "UA" - | "UG" - | "US" - | "UY" - | "UZ" - | "VA" - | "VC" - | "VE" - | "VG" - | "VN" - | "VU" - | "WF" - | "WS" - | "XK" - | "YE" - | "YT" - | "ZA" - | "ZM" - | "ZW" - | "ZZ" - )[]; - } & { [key: string]: unknown }; + | 'AC' + | 'AD' + | 'AE' + | 'AF' + | 'AG' + | 'AI' + | 'AL' + | 'AM' + | 'AO' + | 'AQ' + | 'AR' + | 'AT' + | 'AU' + | 'AW' + | 'AX' + | 'AZ' + | 'BA' + | 'BB' + | 'BD' + | 'BE' + | 'BF' + | 'BG' + | 'BH' + | 'BI' + | 'BJ' + | 'BL' + | 'BM' + | 'BN' + | 'BO' + | 'BQ' + | 'BR' + | 'BS' + | 'BT' + | 'BV' + | 'BW' + | 'BY' + | 'BZ' + | 'CA' + | 'CD' + | 'CF' + | 'CG' + | 'CH' + | 'CI' + | 'CK' + | 'CL' + | 'CM' + | 'CN' + | 'CO' + | 'CR' + | 'CV' + | 'CW' + | 'CY' + | 'CZ' + | 'DE' + | 'DJ' + | 'DK' + | 'DM' + | 'DO' + | 'DZ' + | 'EC' + | 'EE' + | 'EG' + | 'EH' + | 'ER' + | 'ES' + | 'ET' + | 'FI' + | 'FJ' + | 'FK' + | 'FO' + | 'FR' + | 'GA' + | 'GB' + | 'GD' + | 'GE' + | 'GF' + | 'GG' + | 'GH' + | 'GI' + | 'GL' + | 'GM' + | 'GN' + | 'GP' + | 'GQ' + | 'GR' + | 'GS' + | 'GT' + | 'GU' + | 'GW' + | 'GY' + | 'HK' + | 'HN' + | 'HR' + | 'HT' + | 'HU' + | 'ID' + | 'IE' + | 'IL' + | 'IM' + | 'IN' + | 'IO' + | 'IQ' + | 'IS' + | 'IT' + | 'JE' + | 'JM' + | 'JO' + | 'JP' + | 'KE' + | 'KG' + | 'KH' + | 'KI' + | 'KM' + | 'KN' + | 'KR' + | 'KW' + | 'KY' + | 'KZ' + | 'LA' + | 'LB' + | 'LC' + | 'LI' + | 'LK' + | 'LR' + | 'LS' + | 'LT' + | 'LU' + | 'LV' + | 'LY' + | 'MA' + | 'MC' + | 'MD' + | 'ME' + | 'MF' + | 'MG' + | 'MK' + | 'ML' + | 'MM' + | 'MN' + | 'MO' + | 'MQ' + | 'MR' + | 'MS' + | 'MT' + | 'MU' + | 'MV' + | 'MW' + | 'MX' + | 'MY' + | 'MZ' + | 'NA' + | 'NC' + | 'NE' + | 'NG' + | 'NI' + | 'NL' + | 'NO' + | 'NP' + | 'NR' + | 'NU' + | 'NZ' + | 'OM' + | 'PA' + | 'PE' + | 'PF' + | 'PG' + | 'PH' + | 'PK' + | 'PL' + | 'PM' + | 'PN' + | 'PR' + | 'PS' + | 'PT' + | 'PY' + | 'QA' + | 'RE' + | 'RO' + | 'RS' + | 'RU' + | 'RW' + | 'SA' + | 'SB' + | 'SC' + | 'SE' + | 'SG' + | 'SH' + | 'SI' + | 'SJ' + | 'SK' + | 'SL' + | 'SM' + | 'SN' + | 'SO' + | 'SR' + | 'SS' + | 'ST' + | 'SV' + | 'SX' + | 'SZ' + | 'TA' + | 'TC' + | 'TD' + | 'TF' + | 'TG' + | 'TH' + | 'TJ' + | 'TK' + | 'TL' + | 'TM' + | 'TN' + | 'TO' + | 'TR' + | 'TT' + | 'TV' + | 'TW' + | 'TZ' + | 'UA' + | 'UG' + | 'US' + | 'UY' + | 'UZ' + | 'VA' + | 'VC' + | 'VE' + | 'VG' + | 'VN' + | 'VU' + | 'WF' + | 'WS' + | 'XK' + | 'YE' + | 'YT' + | 'ZA' + | 'ZM' + | 'ZW' + | 'ZZ' + )[] + } & { [key: string]: unknown } /** PaymentLinksResourceSubscriptionData */ payment_links_resource_subscription_data: { /** @description Integer representing the number of trial period days before the customer is charged for the first time. */ - trial_period_days?: number | null; - } & { [key: string]: unknown }; + trial_period_days?: number | null + } & { [key: string]: unknown } /** PaymentLinksResourceTransferData */ payment_links_resource_transfer_data: { /** @description The amount in %s that will be transferred to the destination account. By default, the entire amount is transferred to the destination. */ - amount?: number | null; + amount?: number | null /** @description The connected account receiving the transfer. */ - destination: (Partial & Partial) & { [key: string]: unknown }; - } & { [key: string]: unknown }; + destination: (Partial & Partial) & { [key: string]: unknown } + } & { [key: string]: unknown } /** * PaymentMethod * @description PaymentMethod objects represent your customer's payment instruments. @@ -9779,552 +9505,522 @@ export interface components { * Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios). */ payment_method: { - acss_debit?: components["schemas"]["payment_method_acss_debit"]; - afterpay_clearpay?: components["schemas"]["payment_method_afterpay_clearpay"]; - alipay?: components["schemas"]["payment_flows_private_payment_methods_alipay"]; - au_becs_debit?: components["schemas"]["payment_method_au_becs_debit"]; - bacs_debit?: components["schemas"]["payment_method_bacs_debit"]; - bancontact?: components["schemas"]["payment_method_bancontact"]; - billing_details: components["schemas"]["billing_details"]; - boleto?: components["schemas"]["payment_method_boleto"]; - card?: components["schemas"]["payment_method_card"]; - card_present?: components["schemas"]["payment_method_card_present"]; + acss_debit?: components['schemas']['payment_method_acss_debit'] + afterpay_clearpay?: components['schemas']['payment_method_afterpay_clearpay'] + alipay?: components['schemas']['payment_flows_private_payment_methods_alipay'] + au_becs_debit?: components['schemas']['payment_method_au_becs_debit'] + bacs_debit?: components['schemas']['payment_method_bacs_debit'] + bancontact?: components['schemas']['payment_method_bancontact'] + billing_details: components['schemas']['billing_details'] + boleto?: components['schemas']['payment_method_boleto'] + card?: components['schemas']['payment_method_card'] + card_present?: components['schemas']['payment_method_card_present'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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?: ((Partial & Partial) & { [key: string]: unknown }) | null; - eps?: components["schemas"]["payment_method_eps"]; - fpx?: components["schemas"]["payment_method_fpx"]; - giropay?: components["schemas"]["payment_method_giropay"]; - grabpay?: components["schemas"]["payment_method_grabpay"]; + customer?: ((Partial & Partial) & { [key: string]: unknown }) | null + eps?: components['schemas']['payment_method_eps'] + fpx?: components['schemas']['payment_method_fpx'] + giropay?: components['schemas']['payment_method_giropay'] + grabpay?: components['schemas']['payment_method_grabpay'] /** @description Unique identifier for the object. */ - id: string; - ideal?: components["schemas"]["payment_method_ideal"]; - interac_present?: components["schemas"]["payment_method_interac_present"]; - klarna?: components["schemas"]["payment_method_klarna"]; + id: string + ideal?: components['schemas']['payment_method_ideal'] + interac_present?: components['schemas']['payment_method_interac_present'] + klarna?: components['schemas']['payment_method_klarna'] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "payment_method"; - oxxo?: components["schemas"]["payment_method_oxxo"]; - p24?: components["schemas"]["payment_method_p24"]; - sepa_debit?: components["schemas"]["payment_method_sepa_debit"]; - sofort?: components["schemas"]["payment_method_sofort"]; + object: 'payment_method' + oxxo?: components['schemas']['payment_method_oxxo'] + p24?: components['schemas']['payment_method_p24'] + sepa_debit?: components['schemas']['payment_method_sepa_debit'] + sofort?: components['schemas']['payment_method_sofort'] /** * @description 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. * @enum {string} */ type: - | "acss_debit" - | "afterpay_clearpay" - | "alipay" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "card_present" - | "eps" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "interac_present" - | "klarna" - | "oxxo" - | "p24" - | "sepa_debit" - | "sofort" - | "wechat_pay"; - wechat_pay?: components["schemas"]["payment_method_wechat_pay"]; - } & { [key: string]: unknown }; + | 'acss_debit' + | 'afterpay_clearpay' + | 'alipay' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'card_present' + | 'eps' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'interac_present' + | 'klarna' + | 'oxxo' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' + wechat_pay?: components['schemas']['payment_method_wechat_pay'] + } & { [key: string]: unknown } /** payment_method_acss_debit */ payment_method_acss_debit: { /** @description Name of the bank associated with the bank account. */ - bank_name?: string | null; + bank_name?: string | null /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Institution number of the bank account. */ - institution_number?: string | null; + institution_number?: string | null /** @description Last four digits of the bank account number. */ - last4?: string | null; + last4?: string | null /** @description Transit number of the bank account. */ - transit_number?: string | null; - } & { [key: string]: unknown }; + transit_number?: string | null + } & { [key: string]: unknown } /** payment_method_afterpay_clearpay */ - payment_method_afterpay_clearpay: { [key: string]: unknown }; + payment_method_afterpay_clearpay: { [key: string]: unknown } /** payment_method_au_becs_debit */ payment_method_au_becs_debit: { /** @description Six-digit number identifying bank and branch associated with this bank account. */ - bsb_number?: string | null; + bsb_number?: string | null /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Last four digits of the bank account number. */ - last4?: string | null; - } & { [key: string]: unknown }; + last4?: string | null + } & { [key: string]: unknown } /** payment_method_bacs_debit */ payment_method_bacs_debit: { /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Last four digits of the bank account number. */ - last4?: string | null; + last4?: string | null /** @description Sort code of the bank account. (e.g., `10-20-30`) */ - sort_code?: string | null; - } & { [key: string]: unknown }; + sort_code?: string | null + } & { [key: string]: unknown } /** payment_method_bancontact */ - payment_method_bancontact: { [key: string]: unknown }; + payment_method_bancontact: { [key: string]: unknown } /** payment_method_boleto */ payment_method_boleto: { /** @description Uniquely identifies the customer tax id (CNPJ or CPF) */ - tax_id: string; - } & { [key: string]: unknown }; + tax_id: string + } & { [key: string]: unknown } /** payment_method_card */ payment_method_card: { /** @description Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ - brand: string; + brand: string /** @description Checks on Card address and CVC if provided. */ - checks?: (Partial & { [key: string]: unknown }) | null; + checks?: (Partial & { [key: string]: unknown }) | null /** @description 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?: string | null; + country?: string | null /** @description Two-digit number representing the card's expiration month. */ - exp_month: number; + exp_month: number /** @description Four-digit number representing the card's expiration year. */ - exp_year: number; + exp_year: number /** * @description 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. * * *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.* */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ - funding: string; + funding: string /** @description Details of the original PaymentMethod that created this object. */ - generated_from?: - | (Partial & { [key: string]: unknown }) - | null; + generated_from?: (Partial & { [key: string]: unknown }) | null /** @description The last four digits of the card. */ - last4: string; + last4: string /** @description Contains information about card networks that can be used to process the payment. */ - networks?: (Partial & { [key: string]: unknown }) | null; + networks?: (Partial & { [key: string]: unknown }) | null /** @description Contains details on how this Card maybe be used for 3D Secure authentication. */ - three_d_secure_usage?: - | (Partial & { [key: string]: unknown }) - | null; + three_d_secure_usage?: (Partial & { [key: string]: unknown }) | null /** @description If this Card is part of a card wallet, this contains the details of the card wallet. */ - wallet?: (Partial & { [key: string]: unknown }) | null; - } & { [key: string]: unknown }; + wallet?: (Partial & { [key: string]: unknown }) | null + } & { [key: string]: unknown } /** payment_method_card_checks */ payment_method_card_checks: { /** @description If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ - address_line1_check?: string | null; + address_line1_check?: string | null /** @description If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ - address_postal_code_check?: string | null; + address_postal_code_check?: string | null /** @description If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ - cvc_check?: string | null; - } & { [key: string]: unknown }; + cvc_check?: string | null + } & { [key: string]: unknown } /** payment_method_card_generated_card */ payment_method_card_generated_card: { /** @description The charge that created this object. */ - charge?: string | null; + charge?: string | null /** @description Transaction-specific details of the payment method used in the payment. */ - payment_method_details?: - | (Partial & { [key: string]: unknown }) - | null; + payment_method_details?: (Partial & { [key: string]: unknown }) | null /** @description The ID of the SetupAttempt that generated this PaymentMethod, if any. */ - setup_attempt?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; - } & { [key: string]: unknown }; + setup_attempt?: ((Partial & Partial) & { [key: string]: unknown }) | null + } & { [key: string]: unknown } /** payment_method_card_present */ - payment_method_card_present: { [key: string]: unknown }; + payment_method_card_present: { [key: string]: unknown } /** payment_method_card_wallet */ payment_method_card_wallet: { - amex_express_checkout?: components["schemas"]["payment_method_card_wallet_amex_express_checkout"]; - apple_pay?: components["schemas"]["payment_method_card_wallet_apple_pay"]; + amex_express_checkout?: components['schemas']['payment_method_card_wallet_amex_express_checkout'] + apple_pay?: components['schemas']['payment_method_card_wallet_apple_pay'] /** @description (For tokenized numbers only.) The last four digits of the device account number. */ - dynamic_last4?: string | null; - google_pay?: components["schemas"]["payment_method_card_wallet_google_pay"]; - masterpass?: components["schemas"]["payment_method_card_wallet_masterpass"]; - samsung_pay?: components["schemas"]["payment_method_card_wallet_samsung_pay"]; + dynamic_last4?: string | null + google_pay?: components['schemas']['payment_method_card_wallet_google_pay'] + masterpass?: components['schemas']['payment_method_card_wallet_masterpass'] + samsung_pay?: components['schemas']['payment_method_card_wallet_samsung_pay'] /** * @description The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, or `visa_checkout`. 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. * @enum {string} */ - type: "amex_express_checkout" | "apple_pay" | "google_pay" | "masterpass" | "samsung_pay" | "visa_checkout"; - visa_checkout?: components["schemas"]["payment_method_card_wallet_visa_checkout"]; - } & { [key: string]: unknown }; + type: 'amex_express_checkout' | 'apple_pay' | 'google_pay' | 'masterpass' | 'samsung_pay' | 'visa_checkout' + visa_checkout?: components['schemas']['payment_method_card_wallet_visa_checkout'] + } & { [key: string]: unknown } /** payment_method_card_wallet_amex_express_checkout */ - payment_method_card_wallet_amex_express_checkout: { [key: string]: unknown }; + payment_method_card_wallet_amex_express_checkout: { [key: string]: unknown } /** payment_method_card_wallet_apple_pay */ - payment_method_card_wallet_apple_pay: { [key: string]: unknown }; + payment_method_card_wallet_apple_pay: { [key: string]: unknown } /** payment_method_card_wallet_google_pay */ - payment_method_card_wallet_google_pay: { [key: string]: unknown }; + payment_method_card_wallet_google_pay: { [key: string]: unknown } /** payment_method_card_wallet_masterpass */ payment_method_card_wallet_masterpass: { /** @description 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?: (Partial & { [key: string]: unknown }) | null; + billing_address?: (Partial & { [key: string]: unknown }) | null /** @description 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?: string | null; + email?: string | null /** @description 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?: string | null; + name?: string | null /** @description 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?: (Partial & { [key: string]: unknown }) | null; - } & { [key: string]: unknown }; + shipping_address?: (Partial & { [key: string]: unknown }) | null + } & { [key: string]: unknown } /** payment_method_card_wallet_samsung_pay */ - payment_method_card_wallet_samsung_pay: { [key: string]: unknown }; + payment_method_card_wallet_samsung_pay: { [key: string]: unknown } /** payment_method_card_wallet_visa_checkout */ payment_method_card_wallet_visa_checkout: { /** @description 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?: (Partial & { [key: string]: unknown }) | null; + billing_address?: (Partial & { [key: string]: unknown }) | null /** @description 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?: string | null; + email?: string | null /** @description 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?: string | null; + name?: string | null /** @description 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?: (Partial & { [key: string]: unknown }) | null; - } & { [key: string]: unknown }; + shipping_address?: (Partial & { [key: string]: unknown }) | null + } & { [key: string]: unknown } /** payment_method_details */ payment_method_details: { - ach_credit_transfer?: components["schemas"]["payment_method_details_ach_credit_transfer"]; - ach_debit?: components["schemas"]["payment_method_details_ach_debit"]; - acss_debit?: components["schemas"]["payment_method_details_acss_debit"]; - afterpay_clearpay?: components["schemas"]["payment_method_details_afterpay_clearpay"]; - alipay?: components["schemas"]["payment_flows_private_payment_methods_alipay_details"]; - au_becs_debit?: components["schemas"]["payment_method_details_au_becs_debit"]; - bacs_debit?: components["schemas"]["payment_method_details_bacs_debit"]; - bancontact?: components["schemas"]["payment_method_details_bancontact"]; - boleto?: components["schemas"]["payment_method_details_boleto"]; - card?: components["schemas"]["payment_method_details_card"]; - card_present?: components["schemas"]["payment_method_details_card_present"]; - eps?: components["schemas"]["payment_method_details_eps"]; - fpx?: components["schemas"]["payment_method_details_fpx"]; - giropay?: components["schemas"]["payment_method_details_giropay"]; - grabpay?: components["schemas"]["payment_method_details_grabpay"]; - ideal?: components["schemas"]["payment_method_details_ideal"]; - interac_present?: components["schemas"]["payment_method_details_interac_present"]; - klarna?: components["schemas"]["payment_method_details_klarna"]; - multibanco?: components["schemas"]["payment_method_details_multibanco"]; - oxxo?: components["schemas"]["payment_method_details_oxxo"]; - p24?: components["schemas"]["payment_method_details_p24"]; - sepa_debit?: components["schemas"]["payment_method_details_sepa_debit"]; - sofort?: components["schemas"]["payment_method_details_sofort"]; - stripe_account?: components["schemas"]["payment_method_details_stripe_account"]; + ach_credit_transfer?: components['schemas']['payment_method_details_ach_credit_transfer'] + ach_debit?: components['schemas']['payment_method_details_ach_debit'] + acss_debit?: components['schemas']['payment_method_details_acss_debit'] + afterpay_clearpay?: components['schemas']['payment_method_details_afterpay_clearpay'] + alipay?: components['schemas']['payment_flows_private_payment_methods_alipay_details'] + au_becs_debit?: components['schemas']['payment_method_details_au_becs_debit'] + bacs_debit?: components['schemas']['payment_method_details_bacs_debit'] + bancontact?: components['schemas']['payment_method_details_bancontact'] + boleto?: components['schemas']['payment_method_details_boleto'] + card?: components['schemas']['payment_method_details_card'] + card_present?: components['schemas']['payment_method_details_card_present'] + eps?: components['schemas']['payment_method_details_eps'] + fpx?: components['schemas']['payment_method_details_fpx'] + giropay?: components['schemas']['payment_method_details_giropay'] + grabpay?: components['schemas']['payment_method_details_grabpay'] + ideal?: components['schemas']['payment_method_details_ideal'] + interac_present?: components['schemas']['payment_method_details_interac_present'] + klarna?: components['schemas']['payment_method_details_klarna'] + multibanco?: components['schemas']['payment_method_details_multibanco'] + oxxo?: components['schemas']['payment_method_details_oxxo'] + p24?: components['schemas']['payment_method_details_p24'] + sepa_debit?: components['schemas']['payment_method_details_sepa_debit'] + sofort?: components['schemas']['payment_method_details_sofort'] + stripe_account?: components['schemas']['payment_method_details_stripe_account'] /** * @description The type of transaction-specific details of the payment method used in the payment, one of `ach_credit_transfer`, `ach_debit`, `acss_debit`, `alipay`, `au_becs_debit`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `klarna`, `multibanco`, `p24`, `sepa_debit`, `sofort`, `stripe_account`, or `wechat`. * An additional hash is included on `payment_method_details` with a name matching this value. * It contains information specific to the payment method. */ - type: string; - wechat?: components["schemas"]["payment_method_details_wechat"]; - wechat_pay?: components["schemas"]["payment_method_details_wechat_pay"]; - } & { [key: string]: unknown }; + type: string + wechat?: components['schemas']['payment_method_details_wechat'] + wechat_pay?: components['schemas']['payment_method_details_wechat_pay'] + } & { [key: string]: unknown } /** payment_method_details_ach_credit_transfer */ payment_method_details_ach_credit_transfer: { /** @description Account number to transfer funds to. */ - account_number?: string | null; + account_number?: string | null /** @description Name of the bank associated with the routing number. */ - bank_name?: string | null; + bank_name?: string | null /** @description Routing transit number for the bank account to transfer funds to. */ - routing_number?: string | null; + routing_number?: string | null /** @description SWIFT code of the bank associated with the routing number. */ - swift_code?: string | null; - } & { [key: string]: unknown }; + swift_code?: string | null + } & { [key: string]: unknown } /** payment_method_details_ach_debit */ payment_method_details_ach_debit: { /** * @description Type of entity that holds the account. This can be either `individual` or `company`. * @enum {string|null} */ - account_holder_type?: ("company" | "individual") | null; + account_holder_type?: ('company' | 'individual') | null /** @description Name of the bank associated with the bank account. */ - bank_name?: string | null; + bank_name?: string | null /** @description Two-letter ISO code representing the country the bank account is located in. */ - country?: string | null; + country?: string | null /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Last four digits of the bank account number. */ - last4?: string | null; + last4?: string | null /** @description Routing transit number of the bank account. */ - routing_number?: string | null; - } & { [key: string]: unknown }; + routing_number?: string | null + } & { [key: string]: unknown } /** payment_method_details_acss_debit */ payment_method_details_acss_debit: { /** @description Name of the bank associated with the bank account. */ - bank_name?: string | null; + bank_name?: string | null /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Institution number of the bank account */ - institution_number?: string | null; + institution_number?: string | null /** @description Last four digits of the bank account number. */ - last4?: string | null; + last4?: string | null /** @description ID of the mandate used to make this payment. */ - mandate?: string; + mandate?: string /** @description Transit number of the bank account. */ - transit_number?: string | null; - } & { [key: string]: unknown }; + transit_number?: string | null + } & { [key: string]: unknown } /** payment_method_details_afterpay_clearpay */ payment_method_details_afterpay_clearpay: { /** @description Order identifier shown to the merchant in Afterpay’s online portal. */ - reference?: string | null; - } & { [key: string]: unknown }; + reference?: string | null + } & { [key: string]: unknown } /** payment_method_details_au_becs_debit */ payment_method_details_au_becs_debit: { /** @description Bank-State-Branch number of the bank account. */ - bsb_number?: string | null; + bsb_number?: string | null /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Last four digits of the bank account number. */ - last4?: string | null; + last4?: string | null /** @description ID of the mandate used to make this payment. */ - mandate?: string; - } & { [key: string]: unknown }; + mandate?: string + } & { [key: string]: unknown } /** payment_method_details_bacs_debit */ payment_method_details_bacs_debit: { /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Last four digits of the bank account number. */ - last4?: string | null; + last4?: string | null /** @description ID of the mandate used to make this payment. */ - mandate?: string | null; + mandate?: string | null /** @description Sort code of the bank account. (e.g., `10-20-30`) */ - sort_code?: string | null; - } & { [key: string]: unknown }; + sort_code?: string | null + } & { [key: string]: unknown } /** payment_method_details_bancontact */ payment_method_details_bancontact: { /** @description Bank code of bank associated with the bank account. */ - bank_code?: string | null; + bank_code?: string | null /** @description Name of the bank associated with the bank account. */ - bank_name?: string | null; + bank_name?: string | null /** @description Bank Identifier Code of the bank associated with the bank account. */ - bic?: string | null; + bic?: string | null /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ - generated_sepa_debit?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + generated_sepa_debit?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ - generated_sepa_debit_mandate?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + generated_sepa_debit_mandate?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description Last four characters of the IBAN. */ - iban_last4?: string | null; + iban_last4?: string | null /** * @description Preferred language of the Bancontact authorization page that the customer is redirected to. * Can be one of `en`, `de`, `fr`, or `nl` * @enum {string|null} */ - preferred_language?: ("de" | "en" | "fr" | "nl") | null; + preferred_language?: ('de' | 'en' | 'fr' | 'nl') | null /** * @description Owner's verified full name. Values are verified or provided by Bancontact directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - verified_name?: string | null; - } & { [key: string]: unknown }; + verified_name?: string | null + } & { [key: string]: unknown } /** payment_method_details_boleto */ payment_method_details_boleto: { /** @description The tax ID of the customer (CPF for individuals consumers or CNPJ for businesses consumers) */ - tax_id: string; - } & { [key: string]: unknown }; + tax_id: string + } & { [key: string]: unknown } /** payment_method_details_card */ payment_method_details_card: { /** @description Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ - brand?: string | null; + brand?: string | null /** @description Check results by Card networks on Card address and CVC at time of payment. */ - checks?: - | (Partial & { [key: string]: unknown }) - | null; + checks?: (Partial & { [key: string]: unknown }) | null /** @description 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?: string | null; + country?: string | null /** @description Two-digit number representing the card's expiration month. */ - exp_month: number; + exp_month: number /** @description Four-digit number representing the card's expiration year. */ - exp_year: number; + exp_year: number /** * @description 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. * * *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.* */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ - funding?: string | null; + funding?: string | null /** * @description Installment details for this payment (Mexico only). * * For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments). */ - installments?: - | (Partial & { [key: string]: unknown }) - | null; + installments?: (Partial & { [key: string]: unknown }) | null /** @description The last four digits of the card. */ - last4?: string | null; + last4?: string | null /** @description Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ - network?: string | null; + network?: string | null /** @description Populated if this transaction used 3D Secure authentication. */ - three_d_secure?: (Partial & { [key: string]: unknown }) | null; + three_d_secure?: (Partial & { [key: string]: unknown }) | null /** @description If this Card is part of a card wallet, this contains the details of the card wallet. */ - wallet?: - | (Partial & { [key: string]: unknown }) - | null; - } & { [key: string]: unknown }; + wallet?: (Partial & { [key: string]: unknown }) | null + } & { [key: string]: unknown } /** payment_method_details_card_checks */ payment_method_details_card_checks: { /** @description If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ - address_line1_check?: string | null; + address_line1_check?: string | null /** @description If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ - address_postal_code_check?: string | null; + address_postal_code_check?: string | null /** @description If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ - cvc_check?: string | null; - } & { [key: string]: unknown }; + cvc_check?: string | null + } & { [key: string]: unknown } /** payment_method_details_card_installments */ payment_method_details_card_installments: { /** @description Installment plan selected for the payment. */ - plan?: - | (Partial & { [key: string]: unknown }) - | null; - } & { [key: string]: unknown }; + plan?: (Partial & { [key: string]: unknown }) | null + } & { [key: string]: unknown } /** payment_method_details_card_installments_plan */ payment_method_details_card_installments_plan: { /** @description For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card. */ - count?: number | null; + count?: number | null /** * @description For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card. * One of `month`. * @enum {string|null} */ - interval?: "month" | null; + interval?: 'month' | null /** * @description Type of installment plan, one of `fixed_count`. * @enum {string} */ - type: "fixed_count"; - } & { [key: string]: unknown }; + type: 'fixed_count' + } & { [key: string]: unknown } /** payment_method_details_card_present */ payment_method_details_card_present: { /** @description The authorized amount */ - amount_authorized?: number | null; + amount_authorized?: number | null /** @description Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ - brand?: string | null; + brand?: string | null /** @description 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?: string | null; + cardholder_name?: string | null /** @description 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?: string | null; + country?: string | null /** @description Authorization response cryptogram. */ - emv_auth_data?: string | null; + emv_auth_data?: string | null /** @description Two-digit number representing the card's expiration month. */ - exp_month: number; + exp_month: number /** @description Four-digit number representing the card's expiration year. */ - exp_year: number; + exp_year: number /** * @description 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. * * *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.* */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ - funding?: string | null; + funding?: string | null /** @description 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?: string | null; + generated_card?: string | null /** @description The last four digits of the card. */ - last4?: string | null; + last4?: string | null /** @description Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ - network?: string | null; + network?: string | null /** @description Defines whether the authorized amount can be over-captured or not */ - overcapture_supported?: boolean | null; + overcapture_supported?: boolean | null /** * @description How card details were read in this transaction. * @enum {string|null} */ - read_method?: - | ( - | "contact_emv" - | "contactless_emv" - | "contactless_magstripe_mode" - | "magnetic_stripe_fallback" - | "magnetic_stripe_track2" - ) - | null; + read_method?: ('contact_emv' | 'contactless_emv' | 'contactless_magstripe_mode' | 'magnetic_stripe_fallback' | 'magnetic_stripe_track2') | null /** @description A collection of fields required to be displayed on receipts. Only required for EMV transactions. */ - receipt?: - | (Partial & { [key: string]: unknown }) - | null; - } & { [key: string]: unknown }; + receipt?: (Partial & { [key: string]: unknown }) | null + } & { [key: string]: unknown } /** payment_method_details_card_present_receipt */ payment_method_details_card_present_receipt: { /** * @description The type of account being debited or credited * @enum {string} */ - account_type?: "checking" | "credit" | "prepaid" | "unknown"; + account_type?: 'checking' | 'credit' | 'prepaid' | 'unknown' /** @description EMV tag 9F26, cryptogram generated by the integrated circuit chip. */ - application_cryptogram?: string | null; + application_cryptogram?: string | null /** @description Mnenomic of the Application Identifier. */ - application_preferred_name?: string | null; + application_preferred_name?: string | null /** @description Identifier for this transaction. */ - authorization_code?: string | null; + authorization_code?: string | null /** @description EMV tag 8A. A code returned by the card issuer. */ - authorization_response_code?: string | null; + authorization_response_code?: string | null /** @description How the cardholder verified ownership of the card. */ - cardholder_verification_method?: string | null; + cardholder_verification_method?: string | null /** @description EMV tag 84. Similar to the application identifier stored on the integrated circuit chip. */ - dedicated_file_name?: string | null; + dedicated_file_name?: string | null /** @description The outcome of a series of EMV functions performed by the card reader. */ - terminal_verification_results?: string | null; + terminal_verification_results?: string | null /** @description An indication of various EMV functions performed during the transaction. */ - transaction_status_information?: string | null; - } & { [key: string]: unknown }; + transaction_status_information?: string | null + } & { [key: string]: unknown } /** payment_method_details_card_wallet */ payment_method_details_card_wallet: { - amex_express_checkout?: components["schemas"]["payment_method_details_card_wallet_amex_express_checkout"]; - apple_pay?: components["schemas"]["payment_method_details_card_wallet_apple_pay"]; + amex_express_checkout?: components['schemas']['payment_method_details_card_wallet_amex_express_checkout'] + apple_pay?: components['schemas']['payment_method_details_card_wallet_apple_pay'] /** @description (For tokenized numbers only.) The last four digits of the device account number. */ - dynamic_last4?: string | null; - google_pay?: components["schemas"]["payment_method_details_card_wallet_google_pay"]; - masterpass?: components["schemas"]["payment_method_details_card_wallet_masterpass"]; - samsung_pay?: components["schemas"]["payment_method_details_card_wallet_samsung_pay"]; + dynamic_last4?: string | null + google_pay?: components['schemas']['payment_method_details_card_wallet_google_pay'] + masterpass?: components['schemas']['payment_method_details_card_wallet_masterpass'] + samsung_pay?: components['schemas']['payment_method_details_card_wallet_samsung_pay'] /** * @description The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, or `visa_checkout`. 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. * @enum {string} */ - type: "amex_express_checkout" | "apple_pay" | "google_pay" | "masterpass" | "samsung_pay" | "visa_checkout"; - visa_checkout?: components["schemas"]["payment_method_details_card_wallet_visa_checkout"]; - } & { [key: string]: unknown }; + type: 'amex_express_checkout' | 'apple_pay' | 'google_pay' | 'masterpass' | 'samsung_pay' | 'visa_checkout' + visa_checkout?: components['schemas']['payment_method_details_card_wallet_visa_checkout'] + } & { [key: string]: unknown } /** payment_method_details_card_wallet_amex_express_checkout */ - payment_method_details_card_wallet_amex_express_checkout: { [key: string]: unknown }; + payment_method_details_card_wallet_amex_express_checkout: { [key: string]: unknown } /** payment_method_details_card_wallet_apple_pay */ - payment_method_details_card_wallet_apple_pay: { [key: string]: unknown }; + payment_method_details_card_wallet_apple_pay: { [key: string]: unknown } /** payment_method_details_card_wallet_google_pay */ - payment_method_details_card_wallet_google_pay: { [key: string]: unknown }; + payment_method_details_card_wallet_google_pay: { [key: string]: unknown } /** payment_method_details_card_wallet_masterpass */ payment_method_details_card_wallet_masterpass: { /** @description 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?: (Partial & { [key: string]: unknown }) | null; + billing_address?: (Partial & { [key: string]: unknown }) | null /** @description 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?: string | null; + email?: string | null /** @description 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?: string | null; + name?: string | null /** @description 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?: (Partial & { [key: string]: unknown }) | null; - } & { [key: string]: unknown }; + shipping_address?: (Partial & { [key: string]: unknown }) | null + } & { [key: string]: unknown } /** payment_method_details_card_wallet_samsung_pay */ - payment_method_details_card_wallet_samsung_pay: { [key: string]: unknown }; + payment_method_details_card_wallet_samsung_pay: { [key: string]: unknown } /** payment_method_details_card_wallet_visa_checkout */ payment_method_details_card_wallet_visa_checkout: { /** @description 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?: (Partial & { [key: string]: unknown }) | null; + billing_address?: (Partial & { [key: string]: unknown }) | null /** @description 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?: string | null; + email?: string | null /** @description 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?: string | null; + name?: string | null /** @description 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?: (Partial & { [key: string]: unknown }) | null; - } & { [key: string]: unknown }; + shipping_address?: (Partial & { [key: string]: unknown }) | null + } & { [key: string]: unknown } /** payment_method_details_eps */ payment_method_details_eps: { /** @@ -10333,42 +10029,42 @@ export interface components { */ bank?: | ( - | "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" - | "dolomitenbank" - | "easybank_ag" - | "erste_bank_und_sparkassen" - | "hypo_alpeadriabank_international_ag" - | "hypo_bank_burgenland_aktiengesellschaft" - | "hypo_noe_lb_fur_niederosterreich_u_wien" - | "hypo_oberosterreich_salzburg_steiermark" - | "hypo_tirol_bank_ag" - | "hypo_vorarlberg_bank_ag" - | "marchfelder_bank" - | "oberbank_ag" - | "raiffeisen_bankengruppe_osterreich" - | "schoellerbank_ag" - | "sparda_bank_wien" - | "volksbank_gruppe" - | "volkskreditbank_ag" - | "vr_bank_braunau" + | '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' + | 'dolomitenbank' + | 'easybank_ag' + | 'erste_bank_und_sparkassen' + | 'hypo_alpeadriabank_international_ag' + | 'hypo_bank_burgenland_aktiengesellschaft' + | 'hypo_noe_lb_fur_niederosterreich_u_wien' + | 'hypo_oberosterreich_salzburg_steiermark' + | 'hypo_tirol_bank_ag' + | 'hypo_vorarlberg_bank_ag' + | 'marchfelder_bank' + | 'oberbank_ag' + | 'raiffeisen_bankengruppe_osterreich' + | 'schoellerbank_ag' + | 'sparda_bank_wien' + | 'volksbank_gruppe' + | 'volkskreditbank_ag' + | 'vr_bank_braunau' ) - | null; + | null /** * @description Owner's verified full name. Values are verified or provided by EPS directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. * EPS rarely provides this information so the attribute is usually empty. */ - verified_name?: string | null; - } & { [key: string]: unknown }; + verified_name?: string | null + } & { [key: string]: unknown } /** payment_method_details_fpx */ payment_method_details_fpx: { /** @@ -10376,50 +10072,50 @@ export interface components { * @enum {string} */ bank: - | "affin_bank" - | "agrobank" - | "alliance_bank" - | "ambank" - | "bank_islam" - | "bank_muamalat" - | "bank_rakyat" - | "bsn" - | "cimb" - | "deutsche_bank" - | "hong_leong_bank" - | "hsbc" - | "kfh" - | "maybank2e" - | "maybank2u" - | "ocbc" - | "pb_enterprise" - | "public_bank" - | "rhb" - | "standard_chartered" - | "uob"; + | 'affin_bank' + | 'agrobank' + | 'alliance_bank' + | 'ambank' + | 'bank_islam' + | 'bank_muamalat' + | 'bank_rakyat' + | 'bsn' + | 'cimb' + | 'deutsche_bank' + | 'hong_leong_bank' + | 'hsbc' + | 'kfh' + | 'maybank2e' + | 'maybank2u' + | 'ocbc' + | 'pb_enterprise' + | 'public_bank' + | 'rhb' + | 'standard_chartered' + | 'uob' /** @description Unique transaction id generated by FPX for every request from the merchant */ - transaction_id?: string | null; - } & { [key: string]: unknown }; + transaction_id?: string | null + } & { [key: string]: unknown } /** payment_method_details_giropay */ payment_method_details_giropay: { /** @description Bank code of bank associated with the bank account. */ - bank_code?: string | null; + bank_code?: string | null /** @description Name of the bank associated with the bank account. */ - bank_name?: string | null; + bank_name?: string | null /** @description Bank Identifier Code of the bank associated with the bank account. */ - bic?: string | null; + bic?: string | null /** * @description Owner's verified full name. Values are verified or provided by Giropay directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. * Giropay rarely provides this information so the attribute is usually empty. */ - verified_name?: string | null; - } & { [key: string]: unknown }; + verified_name?: string | null + } & { [key: string]: unknown } /** payment_method_details_grabpay */ payment_method_details_grabpay: { /** @description Unique transaction id generated by GrabPay */ - transaction_id?: string | null; - } & { [key: string]: unknown }; + transaction_id?: string | null + } & { [key: string]: unknown } /** payment_method_details_ideal */ payment_method_details_ideal: { /** @@ -10428,157 +10124,141 @@ export interface components { */ bank?: | ( - | "abn_amro" - | "asn_bank" - | "bunq" - | "handelsbanken" - | "ing" - | "knab" - | "moneyou" - | "rabobank" - | "regiobank" - | "revolut" - | "sns_bank" - | "triodos_bank" - | "van_lanschot" + | 'abn_amro' + | 'asn_bank' + | 'bunq' + | 'handelsbanken' + | 'ing' + | 'knab' + | 'moneyou' + | 'rabobank' + | 'regiobank' + | 'revolut' + | 'sns_bank' + | 'triodos_bank' + | 'van_lanschot' ) - | null; + | null /** * @description The Bank Identifier Code of the customer's bank. * @enum {string|null} */ bic?: | ( - | "ABNANL2A" - | "ASNBNL21" - | "BUNQNL2A" - | "FVLBNL22" - | "HANDNL2A" - | "INGBNL2A" - | "KNABNL2H" - | "MOYONL21" - | "RABONL2U" - | "RBRBNL21" - | "REVOLT21" - | "SNSBNL2A" - | "TRIONL2U" + | 'ABNANL2A' + | 'ASNBNL21' + | 'BUNQNL2A' + | 'FVLBNL22' + | 'HANDNL2A' + | 'INGBNL2A' + | 'KNABNL2H' + | 'MOYONL21' + | 'RABONL2U' + | 'RBRBNL21' + | 'REVOLT21' + | 'SNSBNL2A' + | 'TRIONL2U' ) - | null; + | null /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ - generated_sepa_debit?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + generated_sepa_debit?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ - generated_sepa_debit_mandate?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + generated_sepa_debit_mandate?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description Last four characters of the IBAN. */ - iban_last4?: string | null; + iban_last4?: string | null /** * @description Owner's verified full name. Values are verified or provided by iDEAL directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - verified_name?: string | null; - } & { [key: string]: unknown }; + verified_name?: string | null + } & { [key: string]: unknown } /** payment_method_details_interac_present */ payment_method_details_interac_present: { /** @description Card brand. Can be `interac`, `mastercard` or `visa`. */ - brand?: string | null; + brand?: string | null /** @description 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?: string | null; + cardholder_name?: string | null /** @description 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?: string | null; + country?: string | null /** @description Authorization response cryptogram. */ - emv_auth_data?: string | null; + emv_auth_data?: string | null /** @description Two-digit number representing the card's expiration month. */ - exp_month: number; + exp_month: number /** @description Four-digit number representing the card's expiration year. */ - exp_year: number; + exp_year: number /** * @description 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. * * *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.* */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ - funding?: string | null; + funding?: string | null /** @description 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?: string | null; + generated_card?: string | null /** @description The last four digits of the card. */ - last4?: string | null; + last4?: string | null /** @description Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ - network?: string | null; + network?: string | null /** @description EMV tag 5F2D. Preferred languages specified by the integrated circuit chip. */ - preferred_locales?: string[] | null; + preferred_locales?: string[] | null /** * @description How card details were read in this transaction. * @enum {string|null} */ - read_method?: - | ( - | "contact_emv" - | "contactless_emv" - | "contactless_magstripe_mode" - | "magnetic_stripe_fallback" - | "magnetic_stripe_track2" - ) - | null; + read_method?: ('contact_emv' | 'contactless_emv' | 'contactless_magstripe_mode' | 'magnetic_stripe_fallback' | 'magnetic_stripe_track2') | null /** @description A collection of fields required to be displayed on receipts. Only required for EMV transactions. */ - receipt?: - | (Partial & { - [key: string]: unknown; - }) - | null; - } & { [key: string]: unknown }; + receipt?: (Partial & { [key: string]: unknown }) | null + } & { [key: string]: unknown } /** payment_method_details_interac_present_receipt */ payment_method_details_interac_present_receipt: { /** * @description The type of account being debited or credited * @enum {string} */ - account_type?: "checking" | "savings" | "unknown"; + account_type?: 'checking' | 'savings' | 'unknown' /** @description EMV tag 9F26, cryptogram generated by the integrated circuit chip. */ - application_cryptogram?: string | null; + application_cryptogram?: string | null /** @description Mnenomic of the Application Identifier. */ - application_preferred_name?: string | null; + application_preferred_name?: string | null /** @description Identifier for this transaction. */ - authorization_code?: string | null; + authorization_code?: string | null /** @description EMV tag 8A. A code returned by the card issuer. */ - authorization_response_code?: string | null; + authorization_response_code?: string | null /** @description How the cardholder verified ownership of the card. */ - cardholder_verification_method?: string | null; + cardholder_verification_method?: string | null /** @description EMV tag 84. Similar to the application identifier stored on the integrated circuit chip. */ - dedicated_file_name?: string | null; + dedicated_file_name?: string | null /** @description The outcome of a series of EMV functions performed by the card reader. */ - terminal_verification_results?: string | null; + terminal_verification_results?: string | null /** @description An indication of various EMV functions performed during the transaction. */ - transaction_status_information?: string | null; - } & { [key: string]: unknown }; + transaction_status_information?: string | null + } & { [key: string]: unknown } /** payment_method_details_klarna */ payment_method_details_klarna: { /** * @description The Klarna payment method used for this transaction. * Can be one of `pay_later`, `pay_now`, `pay_with_financing`, or `pay_in_installments` */ - payment_method_category?: string | null; + payment_method_category?: string | null /** * @description Preferred language of the Klarna authorization page that the customer is redirected to. * Can 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`, or `en-FR` */ - preferred_locale?: string | null; - } & { [key: string]: unknown }; + preferred_locale?: string | null + } & { [key: string]: unknown } /** payment_method_details_multibanco */ payment_method_details_multibanco: { /** @description Entity number associated with this Multibanco payment. */ - entity?: string | null; + entity?: string | null /** @description Reference number associated with this Multibanco payment. */ - reference?: string | null; - } & { [key: string]: unknown }; + reference?: string | null + } & { [key: string]: unknown } /** payment_method_details_oxxo */ payment_method_details_oxxo: { /** @description OXXO reference number */ - number?: string | null; - } & { [key: string]: unknown }; + number?: string | null + } & { [key: string]: unknown } /** payment_method_details_p24 */ payment_method_details_p24: { /** @@ -10587,100 +10267,96 @@ export interface components { */ bank?: | ( - | "alior_bank" - | "bank_millennium" - | "bank_nowy_bfg_sa" - | "bank_pekao_sa" - | "banki_spbdzielcze" - | "blik" - | "bnp_paribas" - | "boz" - | "citi_handlowy" - | "credit_agricole" - | "envelobank" - | "etransfer_pocztowy24" - | "getin_bank" - | "ideabank" - | "ing" - | "inteligo" - | "mbank_mtransfer" - | "nest_przelew" - | "noble_pay" - | "pbac_z_ipko" - | "plus_bank" - | "santander_przelew24" - | "tmobile_usbugi_bankowe" - | "toyota_bank" - | "volkswagen_bank" + | 'alior_bank' + | 'bank_millennium' + | 'bank_nowy_bfg_sa' + | 'bank_pekao_sa' + | 'banki_spbdzielcze' + | 'blik' + | 'bnp_paribas' + | 'boz' + | 'citi_handlowy' + | 'credit_agricole' + | 'envelobank' + | 'etransfer_pocztowy24' + | 'getin_bank' + | 'ideabank' + | 'ing' + | 'inteligo' + | 'mbank_mtransfer' + | 'nest_przelew' + | 'noble_pay' + | 'pbac_z_ipko' + | 'plus_bank' + | 'santander_przelew24' + | 'tmobile_usbugi_bankowe' + | 'toyota_bank' + | 'volkswagen_bank' ) - | null; + | null /** @description Unique reference for this Przelewy24 payment. */ - reference?: string | null; + reference?: string | null /** * @description Owner's verified full name. Values are verified or provided by Przelewy24 directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. * Przelewy24 rarely provides this information so the attribute is usually empty. */ - verified_name?: string | null; - } & { [key: string]: unknown }; + verified_name?: string | null + } & { [key: string]: unknown } /** payment_method_details_sepa_debit */ payment_method_details_sepa_debit: { /** @description Bank code of bank associated with the bank account. */ - bank_code?: string | null; + bank_code?: string | null /** @description Branch code of bank associated with the bank account. */ - branch_code?: string | null; + branch_code?: string | null /** @description Two-letter ISO code representing the country the bank account is located in. */ - country?: string | null; + country?: string | null /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Last four characters of the IBAN. */ - last4?: string | null; + last4?: string | null /** @description ID of the mandate used to make this payment. */ - mandate?: string | null; - } & { [key: string]: unknown }; + mandate?: string | null + } & { [key: string]: unknown } /** payment_method_details_sofort */ payment_method_details_sofort: { /** @description Bank code of bank associated with the bank account. */ - bank_code?: string | null; + bank_code?: string | null /** @description Name of the bank associated with the bank account. */ - bank_name?: string | null; + bank_name?: string | null /** @description Bank Identifier Code of the bank associated with the bank account. */ - bic?: string | null; + bic?: string | null /** @description Two-letter ISO code representing the country the bank account is located in. */ - country?: string | null; + country?: string | null /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ - generated_sepa_debit?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + generated_sepa_debit?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ - generated_sepa_debit_mandate?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + generated_sepa_debit_mandate?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description Last four characters of the IBAN. */ - iban_last4?: string | null; + iban_last4?: string | null /** * @description Preferred language of the SOFORT authorization page that the customer is redirected to. * Can be one of `de`, `en`, `es`, `fr`, `it`, `nl`, or `pl` * @enum {string|null} */ - preferred_language?: ("de" | "en" | "es" | "fr" | "it" | "nl" | "pl") | null; + preferred_language?: ('de' | 'en' | 'es' | 'fr' | 'it' | 'nl' | 'pl') | null /** * @description Owner's verified full name. Values are verified or provided by SOFORT directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - verified_name?: string | null; - } & { [key: string]: unknown }; + verified_name?: string | null + } & { [key: string]: unknown } /** payment_method_details_stripe_account */ - payment_method_details_stripe_account: { [key: string]: unknown }; + payment_method_details_stripe_account: { [key: string]: unknown } /** payment_method_details_wechat */ - payment_method_details_wechat: { [key: string]: unknown }; + payment_method_details_wechat: { [key: string]: unknown } /** payment_method_details_wechat_pay */ payment_method_details_wechat_pay: { /** @description Uniquely identifies this particular WeChat Pay account. You can use this attribute to check whether two WeChat accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Transaction ID of this particular WeChat Pay transaction. */ - transaction_id?: string | null; - } & { [key: string]: unknown }; + transaction_id?: string | null + } & { [key: string]: unknown } /** payment_method_eps */ payment_method_eps: { /** @@ -10689,36 +10365,36 @@ export interface components { */ bank?: | ( - | "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" - | "dolomitenbank" - | "easybank_ag" - | "erste_bank_und_sparkassen" - | "hypo_alpeadriabank_international_ag" - | "hypo_bank_burgenland_aktiengesellschaft" - | "hypo_noe_lb_fur_niederosterreich_u_wien" - | "hypo_oberosterreich_salzburg_steiermark" - | "hypo_tirol_bank_ag" - | "hypo_vorarlberg_bank_ag" - | "marchfelder_bank" - | "oberbank_ag" - | "raiffeisen_bankengruppe_osterreich" - | "schoellerbank_ag" - | "sparda_bank_wien" - | "volksbank_gruppe" - | "volkskreditbank_ag" - | "vr_bank_braunau" + | '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' + | 'dolomitenbank' + | 'easybank_ag' + | 'erste_bank_und_sparkassen' + | 'hypo_alpeadriabank_international_ag' + | 'hypo_bank_burgenland_aktiengesellschaft' + | 'hypo_noe_lb_fur_niederosterreich_u_wien' + | 'hypo_oberosterreich_salzburg_steiermark' + | 'hypo_tirol_bank_ag' + | 'hypo_vorarlberg_bank_ag' + | 'marchfelder_bank' + | 'oberbank_ag' + | 'raiffeisen_bankengruppe_osterreich' + | 'schoellerbank_ag' + | 'sparda_bank_wien' + | 'volksbank_gruppe' + | 'volkskreditbank_ag' + | 'vr_bank_braunau' ) - | null; - } & { [key: string]: unknown }; + | null + } & { [key: string]: unknown } /** payment_method_fpx */ payment_method_fpx: { /** @@ -10726,32 +10402,32 @@ export interface components { * @enum {string} */ bank: - | "affin_bank" - | "agrobank" - | "alliance_bank" - | "ambank" - | "bank_islam" - | "bank_muamalat" - | "bank_rakyat" - | "bsn" - | "cimb" - | "deutsche_bank" - | "hong_leong_bank" - | "hsbc" - | "kfh" - | "maybank2e" - | "maybank2u" - | "ocbc" - | "pb_enterprise" - | "public_bank" - | "rhb" - | "standard_chartered" - | "uob"; - } & { [key: string]: unknown }; + | 'affin_bank' + | 'agrobank' + | 'alliance_bank' + | 'ambank' + | 'bank_islam' + | 'bank_muamalat' + | 'bank_rakyat' + | 'bsn' + | 'cimb' + | 'deutsche_bank' + | 'hong_leong_bank' + | 'hsbc' + | 'kfh' + | 'maybank2e' + | 'maybank2u' + | 'ocbc' + | 'pb_enterprise' + | 'public_bank' + | 'rhb' + | 'standard_chartered' + | 'uob' + } & { [key: string]: unknown } /** payment_method_giropay */ - payment_method_giropay: { [key: string]: unknown }; + payment_method_giropay: { [key: string]: unknown } /** payment_method_grabpay */ - payment_method_grabpay: { [key: string]: unknown }; + payment_method_grabpay: { [key: string]: unknown } /** payment_method_ideal */ payment_method_ideal: { /** @@ -10760,134 +10436,128 @@ export interface components { */ bank?: | ( - | "abn_amro" - | "asn_bank" - | "bunq" - | "handelsbanken" - | "ing" - | "knab" - | "moneyou" - | "rabobank" - | "regiobank" - | "revolut" - | "sns_bank" - | "triodos_bank" - | "van_lanschot" + | 'abn_amro' + | 'asn_bank' + | 'bunq' + | 'handelsbanken' + | 'ing' + | 'knab' + | 'moneyou' + | 'rabobank' + | 'regiobank' + | 'revolut' + | 'sns_bank' + | 'triodos_bank' + | 'van_lanschot' ) - | null; + | null /** * @description The Bank Identifier Code of the customer's bank, if the bank was provided. * @enum {string|null} */ bic?: | ( - | "ABNANL2A" - | "ASNBNL21" - | "BUNQNL2A" - | "FVLBNL22" - | "HANDNL2A" - | "INGBNL2A" - | "KNABNL2H" - | "MOYONL21" - | "RABONL2U" - | "RBRBNL21" - | "REVOLT21" - | "SNSBNL2A" - | "TRIONL2U" + | 'ABNANL2A' + | 'ASNBNL21' + | 'BUNQNL2A' + | 'FVLBNL22' + | 'HANDNL2A' + | 'INGBNL2A' + | 'KNABNL2H' + | 'MOYONL21' + | 'RABONL2U' + | 'RBRBNL21' + | 'REVOLT21' + | 'SNSBNL2A' + | 'TRIONL2U' ) - | null; - } & { [key: string]: unknown }; + | null + } & { [key: string]: unknown } /** payment_method_interac_present */ - payment_method_interac_present: { [key: string]: unknown }; + payment_method_interac_present: { [key: string]: unknown } /** payment_method_klarna */ payment_method_klarna: { /** @description The customer's date of birth, if provided. */ - dob?: - | (Partial & { - [key: string]: unknown; - }) - | null; - } & { [key: string]: unknown }; + dob?: (Partial & { [key: string]: unknown }) | null + } & { [key: string]: unknown } /** payment_method_options_afterpay_clearpay */ payment_method_options_afterpay_clearpay: { /** * @description Order identifier shown to the merchant in Afterpay’s online portal. We recommend using a value that helps you answer any questions a customer might have about * the payment. The identifier is limited to 128 characters and may contain only letters, digits, underscores, backslashes and dashes. */ - reference?: string | null; - } & { [key: string]: unknown }; + reference?: string | null + } & { [key: string]: unknown } /** payment_method_options_alipay */ - payment_method_options_alipay: { [key: string]: unknown }; + payment_method_options_alipay: { [key: string]: unknown } /** payment_method_options_bacs_debit */ - payment_method_options_bacs_debit: { [key: string]: unknown }; + payment_method_options_bacs_debit: { [key: string]: unknown } /** payment_method_options_bancontact */ payment_method_options_bancontact: { /** * @description Preferred language of the Bancontact authorization page that the customer is redirected to. * @enum {string} */ - preferred_language: "de" | "en" | "fr" | "nl"; - } & { [key: string]: unknown }; + preferred_language: 'de' | 'en' | 'fr' | 'nl' + } & { [key: string]: unknown } /** payment_method_options_boleto */ payment_method_options_boleto: { /** @description 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: number; - } & { [key: string]: unknown }; + expires_after_days: number + } & { [key: string]: unknown } /** payment_method_options_card_installments */ payment_method_options_card_installments: { /** @description Installment plans that may be selected for this PaymentIntent. */ - available_plans?: components["schemas"]["payment_method_details_card_installments_plan"][] | null; + available_plans?: components['schemas']['payment_method_details_card_installments_plan'][] | null /** @description Whether Installments are enabled for this PaymentIntent. */ - enabled: boolean; + enabled: boolean /** @description Installment plan selected for this PaymentIntent. */ - plan?: - | (Partial & { [key: string]: unknown }) - | null; - } & { [key: string]: unknown }; + plan?: (Partial & { [key: string]: unknown }) | null + } & { [key: string]: unknown } /** payment_method_options_card_present */ - payment_method_options_card_present: { [key: string]: unknown }; + payment_method_options_card_present: { [key: string]: unknown } /** payment_method_options_fpx */ - payment_method_options_fpx: { [key: string]: unknown }; + payment_method_options_fpx: { [key: string]: unknown } /** payment_method_options_giropay */ - payment_method_options_giropay: { [key: string]: unknown }; + payment_method_options_giropay: { [key: string]: unknown } /** payment_method_options_grabpay */ - payment_method_options_grabpay: { [key: string]: unknown }; + payment_method_options_grabpay: { [key: string]: unknown } /** payment_method_options_ideal */ - payment_method_options_ideal: { [key: string]: unknown }; + payment_method_options_ideal: { [key: string]: unknown } /** payment_method_options_interac_present */ - payment_method_options_interac_present: { [key: string]: unknown }; + payment_method_options_interac_present: { [key: string]: unknown } /** payment_method_options_klarna */ payment_method_options_klarna: { /** @description Preferred locale of the Klarna checkout page that the customer is redirected to. */ - preferred_locale?: string | null; - } & { [key: string]: unknown }; + preferred_locale?: string | null + } & { [key: string]: unknown } /** payment_method_options_oxxo */ payment_method_options_oxxo: { /** @description 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: number; - } & { [key: string]: unknown }; + expires_after_days: number + } & { [key: string]: unknown } /** payment_method_options_p24 */ - payment_method_options_p24: { [key: string]: unknown }; + payment_method_options_p24: { [key: string]: unknown } /** payment_method_options_sofort */ payment_method_options_sofort: { /** * @description Preferred language of the SOFORT authorization page that the customer is redirected to. * @enum {string|null} */ - preferred_language?: ("de" | "en" | "es" | "fr" | "it" | "nl" | "pl") | null; - } & { [key: string]: unknown }; + preferred_language?: ('de' | 'en' | 'es' | 'fr' | 'it' | 'nl' | 'pl') | null + } & { [key: string]: unknown } /** payment_method_options_wechat_pay */ payment_method_options_wechat_pay: { /** @description The app ID registered with WeChat Pay. Only required when client is ios or android. */ - app_id?: string | null; + app_id?: string | null /** * @description The client type that the end customer will pay from * @enum {string|null} */ - client?: ("android" | "ios" | "web") | null; - } & { [key: string]: unknown }; + client?: ('android' | 'ios' | 'web') | null + } & { [key: string]: unknown } /** payment_method_oxxo */ - payment_method_oxxo: { [key: string]: unknown }; + payment_method_oxxo: { [key: string]: unknown } /** payment_method_p24 */ payment_method_p24: { /** @@ -10896,95 +10566,89 @@ export interface components { */ bank?: | ( - | "alior_bank" - | "bank_millennium" - | "bank_nowy_bfg_sa" - | "bank_pekao_sa" - | "banki_spbdzielcze" - | "blik" - | "bnp_paribas" - | "boz" - | "citi_handlowy" - | "credit_agricole" - | "envelobank" - | "etransfer_pocztowy24" - | "getin_bank" - | "ideabank" - | "ing" - | "inteligo" - | "mbank_mtransfer" - | "nest_przelew" - | "noble_pay" - | "pbac_z_ipko" - | "plus_bank" - | "santander_przelew24" - | "tmobile_usbugi_bankowe" - | "toyota_bank" - | "volkswagen_bank" + | 'alior_bank' + | 'bank_millennium' + | 'bank_nowy_bfg_sa' + | 'bank_pekao_sa' + | 'banki_spbdzielcze' + | 'blik' + | 'bnp_paribas' + | 'boz' + | 'citi_handlowy' + | 'credit_agricole' + | 'envelobank' + | 'etransfer_pocztowy24' + | 'getin_bank' + | 'ideabank' + | 'ing' + | 'inteligo' + | 'mbank_mtransfer' + | 'nest_przelew' + | 'noble_pay' + | 'pbac_z_ipko' + | 'plus_bank' + | 'santander_przelew24' + | 'tmobile_usbugi_bankowe' + | 'toyota_bank' + | 'volkswagen_bank' ) - | null; - } & { [key: string]: unknown }; + | null + } & { [key: string]: unknown } /** payment_method_sepa_debit */ payment_method_sepa_debit: { /** @description Bank code of bank associated with the bank account. */ - bank_code?: string | null; + bank_code?: string | null /** @description Branch code of bank associated with the bank account. */ - branch_code?: string | null; + branch_code?: string | null /** @description Two-letter ISO code representing the country the bank account is located in. */ - country?: string | null; + country?: string | null /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Information about the object that generated this PaymentMethod. */ - generated_from?: - | (Partial & { [key: string]: unknown }) - | null; + generated_from?: (Partial & { [key: string]: unknown }) | null /** @description Last four characters of the IBAN. */ - last4?: string | null; - } & { [key: string]: unknown }; + last4?: string | null + } & { [key: string]: unknown } /** payment_method_sofort */ payment_method_sofort: { /** @description Two-letter ISO code representing the country the bank account is located in. */ - country?: string | null; - } & { [key: string]: unknown }; + country?: string | null + } & { [key: string]: unknown } /** payment_method_wechat_pay */ - payment_method_wechat_pay: { [key: string]: unknown }; + payment_method_wechat_pay: { [key: string]: unknown } /** PaymentPagesCheckoutSessionAfterExpiration */ payment_pages_checkout_session_after_expiration: { /** @description When set, configuration used to recover the Checkout Session on expiry. */ - recovery?: - | (Partial & { - [key: string]: unknown; - }) - | null; - } & { [key: string]: unknown }; + recovery?: (Partial & { [key: string]: unknown }) | null + } & { [key: string]: unknown } /** PaymentPagesCheckoutSessionAfterExpirationRecovery */ payment_pages_checkout_session_after_expiration_recovery: { /** @description Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to `false` */ - allow_promotion_codes: boolean; + allow_promotion_codes: boolean /** * @description If `true`, a recovery url will be generated to recover this Checkout Session if it * expires before a transaction is completed. It will be attached to the * Checkout Session object upon expiration. */ - enabled: boolean; + enabled: boolean /** * Format: unix-time * @description The timestamp at which the recovery URL will expire. */ - expires_at?: number | null; + expires_at?: number | null /** @description URL that creates a new Checkout Session when clicked that is a copy of this expired Checkout Session */ - url?: string | null; - } & { [key: string]: unknown }; + url?: string | null + } & { [key: string]: unknown } /** PaymentPagesCheckoutSessionAutomaticTax */ payment_pages_checkout_session_automatic_tax: { /** @description Indicates whether automatic tax is enabled for the session */ - enabled: boolean; + enabled: boolean /** * @description The status of the most recent automated tax calculation for this session. * @enum {string|null} */ - status?: ("complete" | "failed" | "requires_location_inputs") | null; - } & { [key: string]: unknown }; + status?: ('complete' | 'failed' | 'requires_location_inputs') | null + } & { [key: string]: unknown } /** PaymentPagesCheckoutSessionConsent */ payment_pages_checkout_session_consent: { /** @@ -10992,8 +10656,8 @@ export interface components { * from the merchant about this Checkout Session. * @enum {string|null} */ - promotions?: ("opt_in" | "opt_out") | null; - } & { [key: string]: unknown }; + promotions?: ('opt_in' | 'opt_out') | null + } & { [key: string]: unknown } /** PaymentPagesCheckoutSessionConsentCollection */ payment_pages_checkout_session_consent_collection: { /** @@ -11002,30 +10666,30 @@ export interface components { * from the merchant depending on the customer's locale. Only available to US merchants. * @enum {string|null} */ - promotions?: "auto" | null; - } & { [key: string]: unknown }; + promotions?: 'auto' | null + } & { [key: string]: unknown } /** PaymentPagesCheckoutSessionCustomerDetails */ payment_pages_checkout_session_customer_details: { /** * @description The email associated with the Customer, if one exists, on the Checkout Session at the time of checkout 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. */ - email?: string | null; + email?: string | null /** @description The customer's phone number at the time of checkout */ - phone?: string | null; + phone?: string | null /** * @description The customer’s tax exempt status at time of checkout. * @enum {string|null} */ - tax_exempt?: ("exempt" | "none" | "reverse") | null; + tax_exempt?: ('exempt' | 'none' | 'reverse') | null /** @description The customer’s tax IDs at time of checkout. */ - tax_ids?: components["schemas"]["payment_pages_checkout_session_tax_id"][] | null; - } & { [key: string]: unknown }; + tax_ids?: components['schemas']['payment_pages_checkout_session_tax_id'][] | null + } & { [key: string]: unknown } /** PaymentPagesCheckoutSessionPhoneNumberCollection */ payment_pages_checkout_session_phone_number_collection: { /** @description Indicates whether phone number collection is enabled for the session */ - enabled: boolean; - } & { [key: string]: unknown }; + enabled: boolean + } & { [key: string]: unknown } /** PaymentPagesCheckoutSessionShippingAddressCollection */ payment_pages_checkout_session_shipping_address_collection: { /** @@ -11033,252 +10697,252 @@ export interface components { * shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI`. */ allowed_countries: ( - | "AC" - | "AD" - | "AE" - | "AF" - | "AG" - | "AI" - | "AL" - | "AM" - | "AO" - | "AQ" - | "AR" - | "AT" - | "AU" - | "AW" - | "AX" - | "AZ" - | "BA" - | "BB" - | "BD" - | "BE" - | "BF" - | "BG" - | "BH" - | "BI" - | "BJ" - | "BL" - | "BM" - | "BN" - | "BO" - | "BQ" - | "BR" - | "BS" - | "BT" - | "BV" - | "BW" - | "BY" - | "BZ" - | "CA" - | "CD" - | "CF" - | "CG" - | "CH" - | "CI" - | "CK" - | "CL" - | "CM" - | "CN" - | "CO" - | "CR" - | "CV" - | "CW" - | "CY" - | "CZ" - | "DE" - | "DJ" - | "DK" - | "DM" - | "DO" - | "DZ" - | "EC" - | "EE" - | "EG" - | "EH" - | "ER" - | "ES" - | "ET" - | "FI" - | "FJ" - | "FK" - | "FO" - | "FR" - | "GA" - | "GB" - | "GD" - | "GE" - | "GF" - | "GG" - | "GH" - | "GI" - | "GL" - | "GM" - | "GN" - | "GP" - | "GQ" - | "GR" - | "GS" - | "GT" - | "GU" - | "GW" - | "GY" - | "HK" - | "HN" - | "HR" - | "HT" - | "HU" - | "ID" - | "IE" - | "IL" - | "IM" - | "IN" - | "IO" - | "IQ" - | "IS" - | "IT" - | "JE" - | "JM" - | "JO" - | "JP" - | "KE" - | "KG" - | "KH" - | "KI" - | "KM" - | "KN" - | "KR" - | "KW" - | "KY" - | "KZ" - | "LA" - | "LB" - | "LC" - | "LI" - | "LK" - | "LR" - | "LS" - | "LT" - | "LU" - | "LV" - | "LY" - | "MA" - | "MC" - | "MD" - | "ME" - | "MF" - | "MG" - | "MK" - | "ML" - | "MM" - | "MN" - | "MO" - | "MQ" - | "MR" - | "MS" - | "MT" - | "MU" - | "MV" - | "MW" - | "MX" - | "MY" - | "MZ" - | "NA" - | "NC" - | "NE" - | "NG" - | "NI" - | "NL" - | "NO" - | "NP" - | "NR" - | "NU" - | "NZ" - | "OM" - | "PA" - | "PE" - | "PF" - | "PG" - | "PH" - | "PK" - | "PL" - | "PM" - | "PN" - | "PR" - | "PS" - | "PT" - | "PY" - | "QA" - | "RE" - | "RO" - | "RS" - | "RU" - | "RW" - | "SA" - | "SB" - | "SC" - | "SE" - | "SG" - | "SH" - | "SI" - | "SJ" - | "SK" - | "SL" - | "SM" - | "SN" - | "SO" - | "SR" - | "SS" - | "ST" - | "SV" - | "SX" - | "SZ" - | "TA" - | "TC" - | "TD" - | "TF" - | "TG" - | "TH" - | "TJ" - | "TK" - | "TL" - | "TM" - | "TN" - | "TO" - | "TR" - | "TT" - | "TV" - | "TW" - | "TZ" - | "UA" - | "UG" - | "US" - | "UY" - | "UZ" - | "VA" - | "VC" - | "VE" - | "VG" - | "VN" - | "VU" - | "WF" - | "WS" - | "XK" - | "YE" - | "YT" - | "ZA" - | "ZM" - | "ZW" - | "ZZ" - )[]; - } & { [key: string]: unknown }; + | 'AC' + | 'AD' + | 'AE' + | 'AF' + | 'AG' + | 'AI' + | 'AL' + | 'AM' + | 'AO' + | 'AQ' + | 'AR' + | 'AT' + | 'AU' + | 'AW' + | 'AX' + | 'AZ' + | 'BA' + | 'BB' + | 'BD' + | 'BE' + | 'BF' + | 'BG' + | 'BH' + | 'BI' + | 'BJ' + | 'BL' + | 'BM' + | 'BN' + | 'BO' + | 'BQ' + | 'BR' + | 'BS' + | 'BT' + | 'BV' + | 'BW' + | 'BY' + | 'BZ' + | 'CA' + | 'CD' + | 'CF' + | 'CG' + | 'CH' + | 'CI' + | 'CK' + | 'CL' + | 'CM' + | 'CN' + | 'CO' + | 'CR' + | 'CV' + | 'CW' + | 'CY' + | 'CZ' + | 'DE' + | 'DJ' + | 'DK' + | 'DM' + | 'DO' + | 'DZ' + | 'EC' + | 'EE' + | 'EG' + | 'EH' + | 'ER' + | 'ES' + | 'ET' + | 'FI' + | 'FJ' + | 'FK' + | 'FO' + | 'FR' + | 'GA' + | 'GB' + | 'GD' + | 'GE' + | 'GF' + | 'GG' + | 'GH' + | 'GI' + | 'GL' + | 'GM' + | 'GN' + | 'GP' + | 'GQ' + | 'GR' + | 'GS' + | 'GT' + | 'GU' + | 'GW' + | 'GY' + | 'HK' + | 'HN' + | 'HR' + | 'HT' + | 'HU' + | 'ID' + | 'IE' + | 'IL' + | 'IM' + | 'IN' + | 'IO' + | 'IQ' + | 'IS' + | 'IT' + | 'JE' + | 'JM' + | 'JO' + | 'JP' + | 'KE' + | 'KG' + | 'KH' + | 'KI' + | 'KM' + | 'KN' + | 'KR' + | 'KW' + | 'KY' + | 'KZ' + | 'LA' + | 'LB' + | 'LC' + | 'LI' + | 'LK' + | 'LR' + | 'LS' + | 'LT' + | 'LU' + | 'LV' + | 'LY' + | 'MA' + | 'MC' + | 'MD' + | 'ME' + | 'MF' + | 'MG' + | 'MK' + | 'ML' + | 'MM' + | 'MN' + | 'MO' + | 'MQ' + | 'MR' + | 'MS' + | 'MT' + | 'MU' + | 'MV' + | 'MW' + | 'MX' + | 'MY' + | 'MZ' + | 'NA' + | 'NC' + | 'NE' + | 'NG' + | 'NI' + | 'NL' + | 'NO' + | 'NP' + | 'NR' + | 'NU' + | 'NZ' + | 'OM' + | 'PA' + | 'PE' + | 'PF' + | 'PG' + | 'PH' + | 'PK' + | 'PL' + | 'PM' + | 'PN' + | 'PR' + | 'PS' + | 'PT' + | 'PY' + | 'QA' + | 'RE' + | 'RO' + | 'RS' + | 'RU' + | 'RW' + | 'SA' + | 'SB' + | 'SC' + | 'SE' + | 'SG' + | 'SH' + | 'SI' + | 'SJ' + | 'SK' + | 'SL' + | 'SM' + | 'SN' + | 'SO' + | 'SR' + | 'SS' + | 'ST' + | 'SV' + | 'SX' + | 'SZ' + | 'TA' + | 'TC' + | 'TD' + | 'TF' + | 'TG' + | 'TH' + | 'TJ' + | 'TK' + | 'TL' + | 'TM' + | 'TN' + | 'TO' + | 'TR' + | 'TT' + | 'TV' + | 'TW' + | 'TZ' + | 'UA' + | 'UG' + | 'US' + | 'UY' + | 'UZ' + | 'VA' + | 'VC' + | 'VE' + | 'VG' + | 'VN' + | 'VU' + | 'WF' + | 'WS' + | 'XK' + | 'YE' + | 'YT' + | 'ZA' + | 'ZM' + | 'ZW' + | 'ZZ' + )[] + } & { [key: string]: unknown } /** PaymentPagesCheckoutSessionShippingOption */ payment_pages_checkout_session_shipping_option: { /** @description A non-negative integer in cents representing how much to charge. */ - shipping_amount: number; + shipping_amount: number /** @description The shipping rate. */ - shipping_rate: (Partial & Partial) & { [key: string]: unknown }; - } & { [key: string]: unknown }; + shipping_rate: (Partial & Partial) & { [key: string]: unknown } + } & { [key: string]: unknown } /** PaymentPagesCheckoutSessionTaxID */ payment_pages_checkout_session_tax_id: { /** @@ -11286,81 +10950,81 @@ export interface components { * @enum {string} */ type: - | "ae_trn" - | "au_abn" - | "au_arn" - | "br_cnpj" - | "br_cpf" - | "ca_bn" - | "ca_gst_hst" - | "ca_pst_bc" - | "ca_pst_mb" - | "ca_pst_sk" - | "ca_qst" - | "ch_vat" - | "cl_tin" - | "es_cif" - | "eu_vat" - | "gb_vat" - | "ge_vat" - | "hk_br" - | "id_npwp" - | "il_vat" - | "in_gst" - | "is_vat" - | "jp_cn" - | "jp_rn" - | "kr_brn" - | "li_uid" - | "mx_rfc" - | "my_frp" - | "my_itn" - | "my_sst" - | "no_vat" - | "nz_gst" - | "ru_inn" - | "ru_kpp" - | "sa_vat" - | "sg_gst" - | "sg_uen" - | "th_vat" - | "tw_vat" - | "ua_vat" - | "unknown" - | "us_ein" - | "za_vat"; + | 'ae_trn' + | 'au_abn' + | 'au_arn' + | 'br_cnpj' + | 'br_cpf' + | 'ca_bn' + | 'ca_gst_hst' + | 'ca_pst_bc' + | 'ca_pst_mb' + | 'ca_pst_sk' + | 'ca_qst' + | 'ch_vat' + | 'cl_tin' + | 'es_cif' + | 'eu_vat' + | 'gb_vat' + | 'ge_vat' + | 'hk_br' + | 'id_npwp' + | 'il_vat' + | 'in_gst' + | 'is_vat' + | 'jp_cn' + | 'jp_rn' + | 'kr_brn' + | 'li_uid' + | 'mx_rfc' + | 'my_frp' + | 'my_itn' + | 'my_sst' + | 'no_vat' + | 'nz_gst' + | 'ru_inn' + | 'ru_kpp' + | 'sa_vat' + | 'sg_gst' + | 'sg_uen' + | 'th_vat' + | 'tw_vat' + | 'ua_vat' + | 'unknown' + | 'us_ein' + | 'za_vat' /** @description The value of the tax ID. */ - value?: string | null; - } & { [key: string]: unknown }; + value?: string | null + } & { [key: string]: unknown } /** PaymentPagesCheckoutSessionTaxIDCollection */ payment_pages_checkout_session_tax_id_collection: { /** @description Indicates whether tax ID collection is enabled for the session */ - enabled: boolean; - } & { [key: string]: unknown }; + enabled: boolean + } & { [key: string]: unknown } /** PaymentPagesCheckoutSessionTotalDetails */ payment_pages_checkout_session_total_details: { /** @description This is the sum of all the line item discounts. */ - amount_discount: number; + amount_discount: number /** @description This is the sum of all the line item shipping amounts. */ - amount_shipping?: number | null; + amount_shipping?: number | null /** @description This is the sum of all the line item tax amounts. */ - amount_tax: number; - breakdown?: components["schemas"]["payment_pages_checkout_session_total_details_resource_breakdown"]; - } & { [key: string]: unknown }; + amount_tax: number + breakdown?: components['schemas']['payment_pages_checkout_session_total_details_resource_breakdown'] + } & { [key: string]: unknown } /** PaymentPagesCheckoutSessionTotalDetailsResourceBreakdown */ payment_pages_checkout_session_total_details_resource_breakdown: { /** @description The aggregated line item discounts. */ - discounts: components["schemas"]["line_items_discount_amount"][]; + discounts: components['schemas']['line_items_discount_amount'][] /** @description The aggregated line item tax amounts by rate. */ - taxes: components["schemas"]["line_items_tax_amount"][]; - } & { [key: string]: unknown }; + taxes: components['schemas']['line_items_tax_amount'][] + } & { [key: string]: unknown } /** Polymorphic */ - payment_source: (Partial & - Partial & - Partial & - Partial & - Partial & - Partial) & { [key: string]: unknown }; + payment_source: (Partial & + Partial & + Partial & + Partial & + Partial & + Partial) & { [key: string]: unknown } /** * Payout * @description A `Payout` object is created when you receive funds from Stripe, or when you @@ -11374,87 +11038,81 @@ export interface components { */ payout: { /** @description Amount (in %s) to be transferred to your bank account or debit card. */ - amount: number; + amount: number /** * Format: unix-time * @description Date the payout is expected to arrive in the bank. This factors in delays like weekends or bank holidays. */ - arrival_date: number; + arrival_date: number /** @description Returns `true` if the payout was created by an [automated payout schedule](https://stripe.com/docs/payouts#payout-schedule), and `false` if it was [requested manually](https://stripe.com/docs/payouts#manual-payouts). */ - automatic: boolean; + automatic: boolean /** @description ID of the balance transaction that describes the impact of this payout on your account balance. */ - balance_transaction?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + balance_transaction?: ((Partial & Partial) & { [key: string]: unknown }) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description ID of the bank account or card the payout was sent to. */ destination?: | ((Partial & - Partial & - Partial & - Partial & - Partial) & { [key: string]: unknown }) - | null; + Partial & + Partial & + Partial & + Partial) & { [key: string]: unknown }) + | null /** @description If the payout failed or was canceled, this will be the ID of the balance transaction that reversed the initial balance transaction, and puts the funds from the failed payout back in your balance. */ - failure_balance_transaction?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + failure_balance_transaction?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description Error code explaining reason for payout failure if available. See [Types of payout failures](https://stripe.com/docs/api#payout_failures) for a list of failure codes. */ - failure_code?: string | null; + failure_code?: string | null /** @description Message to user further explaining reason for payout failure if available. */ - failure_message?: string | null; + failure_message?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** @description The method used to send this payout, which can be `standard` or `instant`. `instant` is only supported for payouts to debit cards. (See [Instant payouts for marketplaces](https://stripe.com/blog/instant-payouts-for-marketplaces) for more information.) */ - method: string; + method: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "payout"; + object: 'payout' /** @description If the payout reverses another, this is the ID of the original payout. */ - original_payout?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + original_payout?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description If the payout was reversed, this is the ID of the payout that reverses this payout. */ - reversed_by?: ((Partial & Partial) & { [key: string]: unknown }) | null; + reversed_by?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description The source balance this payout came from. One of `card`, `fpx`, or `bank_account`. */ - source_type: string; + source_type: string /** @description Extra information about a payout to be displayed on the user's bank statement. */ - statement_descriptor?: string | null; + statement_descriptor?: string | null /** @description Current status of the payout: `paid`, `pending`, `in_transit`, `canceled` or `failed`. A payout is `pending` until it is submitted to the bank, when it becomes `in_transit`. The status then changes to `paid` if the transaction goes through, or to `failed` or `canceled` (within 5 business days). Some failed payouts may initially show as `paid` but then change to `failed`. */ - status: string; + status: string /** * @description Can be `bank_account` or `card`. * @enum {string} */ - type: "bank_account" | "card"; - } & { [key: string]: unknown }; + type: 'bank_account' | 'card' + } & { [key: string]: unknown } /** Period */ period: { /** * Format: unix-time * @description The end date of this usage period. All usage up to and including this point in time is included. */ - end?: number | null; + end?: number | null /** * Format: unix-time * @description The start date of this usage period. All usage after this point in time is included. */ - start?: number | null; - } & { [key: string]: unknown }; + start?: number | null + } & { [key: string]: unknown } /** * Person * @description This is an object representing a person associated with a Stripe account. @@ -11466,112 +11124,108 @@ export interface components { */ person: { /** @description The account the person is associated with. */ - account: string; - address?: components["schemas"]["address"]; - address_kana?: (Partial & { [key: string]: unknown }) | null; - address_kanji?: - | (Partial & { [key: string]: unknown }) - | null; + account: string + address?: components['schemas']['address'] + address_kana?: (Partial & { [key: string]: unknown }) | null + address_kanji?: (Partial & { [key: string]: unknown }) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; - dob?: components["schemas"]["legal_entity_dob"]; + created: number + dob?: components['schemas']['legal_entity_dob'] /** @description The person's email address. */ - email?: string | null; + email?: string | null /** @description The person's first name. */ - first_name?: string | null; + first_name?: string | null /** @description The Kana variation of the person's first name (Japan only). */ - first_name_kana?: string | null; + first_name_kana?: string | null /** @description The Kanji variation of the person's first name (Japan only). */ - first_name_kanji?: string | null; + first_name_kanji?: string | null /** @description A list of alternate names or aliases that the person is known by. */ - full_name_aliases?: string[]; - future_requirements?: - | (Partial & { [key: string]: unknown }) - | null; + full_name_aliases?: string[] + future_requirements?: (Partial & { [key: string]: unknown }) | null /** @description The person's gender (International regulations require either "male" or "female"). */ - gender?: string | null; + gender?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Whether the person's `id_number` was provided. */ - id_number_provided?: boolean; + id_number_provided?: boolean /** @description The person's last name. */ - last_name?: string | null; + last_name?: string | null /** @description The Kana variation of the person's last name (Japan only). */ - last_name_kana?: string | null; + last_name_kana?: string | null /** @description The Kanji variation of the person's last name (Japan only). */ - last_name_kanji?: string | null; + last_name_kanji?: string | null /** @description The person's maiden name. */ - maiden_name?: string | null; + maiden_name?: string | null /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The country where the person is a national. */ - nationality?: string | null; + nationality?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "person"; + object: 'person' /** @description The person's phone number. */ - phone?: string | null; + phone?: string | null /** * @description 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. * @enum {string} */ - political_exposure?: "existing" | "none"; - relationship?: components["schemas"]["person_relationship"]; - requirements?: (Partial & { [key: string]: unknown }) | null; + political_exposure?: 'existing' | 'none' + relationship?: components['schemas']['person_relationship'] + requirements?: (Partial & { [key: string]: unknown }) | null /** @description Whether the last four digits of the person's Social Security number have been provided (U.S. only). */ - ssn_last_4_provided?: boolean; - verification?: components["schemas"]["legal_entity_person_verification"]; - } & { [key: string]: unknown }; + ssn_last_4_provided?: boolean + verification?: components['schemas']['legal_entity_person_verification'] + } & { [key: string]: unknown } /** PersonFutureRequirements */ person_future_requirements: { /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ - alternatives?: components["schemas"]["account_requirements_alternative"][] | null; + alternatives?: components['schemas']['account_requirements_alternative'][] | null /** @description 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: string[]; + currently_due: string[] /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ - errors: components["schemas"]["account_requirements_error"][]; + errors: components['schemas']['account_requirements_error'][] /** @description Fields that need to be collected assuming all volume 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: string[]; + eventually_due: string[] /** @description 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: string[]; + past_due: string[] /** @description Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. */ - pending_verification: string[]; - } & { [key: string]: unknown }; + pending_verification: string[] + } & { [key: string]: unknown } /** PersonRelationship */ person_relationship: { /** @description 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?: boolean | null; + director?: boolean | null /** @description Whether the person has significant responsibility to control, manage, or direct the organization. */ - executive?: boolean | null; + executive?: boolean | null /** @description Whether the person is an owner of the account’s legal entity. */ - owner?: boolean | null; + owner?: boolean | null /** @description The percent owned by the person of the account's legal entity. */ - percent_ownership?: number | null; + percent_ownership?: number | null /** @description 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?: boolean | null; + representative?: boolean | null /** @description The person's title (e.g., CEO, Support Engineer). */ - title?: string | null; - } & { [key: string]: unknown }; + title?: string | null + } & { [key: string]: unknown } /** PersonRequirements */ person_requirements: { /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ - alternatives?: components["schemas"]["account_requirements_alternative"][] | null; + alternatives?: components['schemas']['account_requirements_alternative'][] | null /** @description 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: string[]; + currently_due: string[] /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ - errors: components["schemas"]["account_requirements_error"][]; + errors: components['schemas']['account_requirements_error'][] /** @description Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `current_deadline` becomes set. */ - eventually_due: string[]; + eventually_due: string[] /** @description 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: string[]; + past_due: string[] /** @description Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. */ - pending_verification: string[]; - } & { [key: string]: unknown }; + pending_verification: string[] + } & { [key: string]: unknown } /** * Plan * @description You can now model subscriptions more flexibly using the [Prices API](https://stripe.com/docs/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration. @@ -11585,202 +11239,193 @@ export interface components { */ plan: { /** @description Whether the plan can be used for new purchases. */ - active: boolean; + active: boolean /** * @description 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`. * @enum {string|null} */ - aggregate_usage?: ("last_during_period" | "last_ever" | "max" | "sum") | null; + aggregate_usage?: ('last_during_period' | 'last_ever' | 'max' | 'sum') | null /** @description The unit amount in %s to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. */ - amount?: number | null; + amount?: number | null /** * Format: decimal * @description The unit amount in %s to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`. */ - amount_decimal?: string | null; + amount_decimal?: string | null /** * @description 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. * @enum {string} */ - billing_scheme: "per_unit" | "tiered"; + billing_scheme: 'per_unit' | 'tiered' /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`. * @enum {string} */ - interval: "day" | "month" | "week" | "year"; + interval: 'day' | 'month' | 'week' | 'year' /** @description 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: number; + interval_count: number /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** @description A brief description of the plan, hidden from customers. */ - nickname?: string | null; + nickname?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "plan"; + object: 'plan' /** @description The product whose pricing this plan determines. */ product?: - | ((Partial & - Partial & - Partial) & { [key: string]: unknown }) - | null; + | ((Partial & Partial & Partial) & { + [key: string]: unknown + }) + | null /** @description Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. */ - tiers?: components["schemas"]["plan_tier"][]; + tiers?: components['schemas']['plan_tier'][] /** * @description 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. * @enum {string|null} */ - tiers_mode?: ("graduated" | "volume") | null; + tiers_mode?: ('graduated' | 'volume') | null /** @description Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`. */ - transform_usage?: (Partial & { [key: string]: unknown }) | null; + transform_usage?: (Partial & { [key: string]: unknown }) | null /** @description 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?: number | null; + trial_period_days?: number | null /** * @description 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`. * @enum {string} */ - usage_type: "licensed" | "metered"; - } & { [key: string]: unknown }; + usage_type: 'licensed' | 'metered' + } & { [key: string]: unknown } /** PlanTier */ plan_tier: { /** @description Price for the entire tier. */ - flat_amount?: number | null; + flat_amount?: number | null /** * Format: decimal * @description Same as `flat_amount`, but contains a decimal value with at most 12 decimal places. */ - flat_amount_decimal?: string | null; + flat_amount_decimal?: string | null /** @description Per unit price for units relevant to the tier. */ - unit_amount?: number | null; + unit_amount?: number | null /** * Format: decimal * @description Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. */ - unit_amount_decimal?: string | null; + unit_amount_decimal?: string | null /** @description Up to and including to this quantity will be contained in the tier. */ - up_to?: number | null; - } & { [key: string]: unknown }; + up_to?: number | null + } & { [key: string]: unknown } /** PlatformTax */ platform_tax_fee: { /** @description The Connected account that incurred this charge. */ - account: string; + account: string /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "platform_tax_fee"; + object: 'platform_tax_fee' /** @description The payment object that caused this tax to be inflicted. */ - source_transaction: string; + source_transaction: string /** @description The type of tax (VAT). */ - type: string; - } & { [key: string]: unknown }; + type: string + } & { [key: string]: unknown } /** PortalBusinessProfile */ portal_business_profile: { /** @description The messaging shown to customers in the portal. */ - headline?: string | null; + headline?: string | null /** @description A link to the business’s publicly available privacy policy. */ - privacy_policy_url: string; + privacy_policy_url: string /** @description A link to the business’s publicly available terms of service. */ - terms_of_service_url: string; - } & { [key: string]: unknown }; + terms_of_service_url: string + } & { [key: string]: unknown } /** PortalCustomerUpdate */ portal_customer_update: { /** @description The types of customer updates that are supported. When empty, customers are not updateable. */ - allowed_updates: ("address" | "email" | "phone" | "shipping" | "tax_id")[]; + allowed_updates: ('address' | 'email' | 'phone' | 'shipping' | 'tax_id')[] /** @description Whether the feature is enabled. */ - enabled: boolean; - } & { [key: string]: unknown }; + enabled: boolean + } & { [key: string]: unknown } /** PortalFeatures */ portal_features: { - customer_update: components["schemas"]["portal_customer_update"]; - invoice_history: components["schemas"]["portal_invoice_list"]; - payment_method_update: components["schemas"]["portal_payment_method_update"]; - subscription_cancel: components["schemas"]["portal_subscription_cancel"]; - subscription_pause: components["schemas"]["portal_subscription_pause"]; - subscription_update: components["schemas"]["portal_subscription_update"]; - } & { [key: string]: unknown }; + customer_update: components['schemas']['portal_customer_update'] + invoice_history: components['schemas']['portal_invoice_list'] + payment_method_update: components['schemas']['portal_payment_method_update'] + subscription_cancel: components['schemas']['portal_subscription_cancel'] + subscription_pause: components['schemas']['portal_subscription_pause'] + subscription_update: components['schemas']['portal_subscription_update'] + } & { [key: string]: unknown } /** PortalInvoiceList */ portal_invoice_list: { /** @description Whether the feature is enabled. */ - enabled: boolean; - } & { [key: string]: unknown }; + enabled: boolean + } & { [key: string]: unknown } /** PortalPaymentMethodUpdate */ portal_payment_method_update: { /** @description Whether the feature is enabled. */ - enabled: boolean; - } & { [key: string]: unknown }; + enabled: boolean + } & { [key: string]: unknown } /** PortalSubscriptionCancel */ portal_subscription_cancel: { - cancellation_reason: components["schemas"]["portal_subscription_cancellation_reason"]; + cancellation_reason: components['schemas']['portal_subscription_cancellation_reason'] /** @description Whether the feature is enabled. */ - enabled: boolean; + enabled: boolean /** * @description Whether to cancel subscriptions immediately or at the end of the billing period. * @enum {string} */ - mode: "at_period_end" | "immediately"; + mode: 'at_period_end' | 'immediately' /** * @description Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`. * @enum {string} */ - proration_behavior: "always_invoice" | "create_prorations" | "none"; - } & { [key: string]: unknown }; + proration_behavior: 'always_invoice' | 'create_prorations' | 'none' + } & { [key: string]: unknown } /** PortalSubscriptionCancellationReason */ portal_subscription_cancellation_reason: { /** @description Whether the feature is enabled. */ - enabled: boolean; + enabled: boolean /** @description Which cancellation reasons will be given as options to the customer. */ - options: ( - | "customer_service" - | "low_quality" - | "missing_features" - | "other" - | "switched_service" - | "too_complex" - | "too_expensive" - | "unused" - )[]; - } & { [key: string]: unknown }; + options: ('customer_service' | 'low_quality' | 'missing_features' | 'other' | 'switched_service' | 'too_complex' | 'too_expensive' | 'unused')[] + } & { [key: string]: unknown } /** PortalSubscriptionPause */ portal_subscription_pause: { /** @description Whether the feature is enabled. */ - enabled: boolean; - } & { [key: string]: unknown }; + enabled: boolean + } & { [key: string]: unknown } /** PortalSubscriptionUpdate */ portal_subscription_update: { /** @description The types of subscription updates that are supported for items listed in the `products` attribute. When empty, subscriptions are not updateable. */ - default_allowed_updates: ("price" | "promotion_code" | "quantity")[]; + default_allowed_updates: ('price' | 'promotion_code' | 'quantity')[] /** @description Whether the feature is enabled. */ - enabled: boolean; + enabled: boolean /** @description The list of products that support subscription updates. */ - products?: components["schemas"]["portal_subscription_update_product"][] | null; + products?: components['schemas']['portal_subscription_update_product'][] | null /** * @description Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`. * @enum {string} */ - proration_behavior: "always_invoice" | "create_prorations" | "none"; - } & { [key: string]: unknown }; + proration_behavior: 'always_invoice' | 'create_prorations' | 'none' + } & { [key: string]: unknown } /** PortalSubscriptionUpdateProduct */ portal_subscription_update_product: { /** @description The list of price IDs which, when subscribed to, a subscription can be updated. */ - prices: string[]; + prices: string[] /** @description The product ID. */ - product: string; - } & { [key: string]: unknown }; + product: string + } & { [key: string]: unknown } /** * Price * @description Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. @@ -11792,86 +11437,86 @@ export interface components { */ price: { /** @description Whether the price can be used for new purchases. */ - active: boolean; + active: boolean /** * @description 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. * @enum {string} */ - billing_scheme: "per_unit" | "tiered"; + billing_scheme: 'per_unit' | 'tiered' /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters. */ - lookup_key?: string | null; + lookup_key?: string | null /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** @description A brief description of the price, hidden from customers. */ - nickname?: string | null; + nickname?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "price"; + object: 'price' /** @description The ID of the product this price is associated with. */ - product: (Partial & - Partial & - Partial) & { [key: string]: unknown }; + product: (Partial & Partial & Partial) & { + [key: string]: unknown + } /** @description The recurring components of a price such as `interval` and `usage_type`. */ - recurring?: (Partial & { [key: string]: unknown }) | null; + recurring?: (Partial & { [key: string]: unknown }) | null /** * @description 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. * @enum {string|null} */ - tax_behavior?: ("exclusive" | "inclusive" | "unspecified") | null; + tax_behavior?: ('exclusive' | 'inclusive' | 'unspecified') | null /** @description Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. */ - tiers?: components["schemas"]["price_tier"][]; + tiers?: components['schemas']['price_tier'][] /** * @description 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. * @enum {string|null} */ - tiers_mode?: ("graduated" | "volume") | null; + tiers_mode?: ('graduated' | 'volume') | null /** @description Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`. */ - transform_quantity?: (Partial & { [key: string]: unknown }) | null; + transform_quantity?: (Partial & { [key: string]: unknown }) | null /** * @description One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase. * @enum {string} */ - type: "one_time" | "recurring"; + type: 'one_time' | 'recurring' /** @description The unit amount in %s to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. */ - unit_amount?: number | null; + unit_amount?: number | null /** * Format: decimal * @description The unit amount in %s to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`. */ - unit_amount_decimal?: string | null; - } & { [key: string]: unknown }; + unit_amount_decimal?: string | null + } & { [key: string]: unknown } /** PriceTier */ price_tier: { /** @description Price for the entire tier. */ - flat_amount?: number | null; + flat_amount?: number | null /** * Format: decimal * @description Same as `flat_amount`, but contains a decimal value with at most 12 decimal places. */ - flat_amount_decimal?: string | null; + flat_amount_decimal?: string | null /** @description Per unit price for units relevant to the tier. */ - unit_amount?: number | null; + unit_amount?: number | null /** * Format: decimal * @description Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. */ - unit_amount_decimal?: string | null; + unit_amount_decimal?: string | null /** @description Up to and including to this quantity will be contained in the tier. */ - up_to?: number | null; - } & { [key: string]: unknown }; + up_to?: number | null + } & { [key: string]: unknown } /** * Product * @description Products describe the specific goods or services you offer to your customers. @@ -11885,47 +11530,47 @@ export interface components { */ product: { /** @description Whether the product is currently available for purchase. */ - active: boolean; + active: boolean /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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?: string | null; + description?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description A list of up to 8 URLs of images for this product, meant to be displayable to the customer. */ - images: string[]; + images: string[] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** @description The product's name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions. */ - name: string; + name: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "product"; + object: 'product' /** @description The dimensions of this product for shipping purposes. */ - package_dimensions?: (Partial & { [key: string]: unknown }) | null; + package_dimensions?: (Partial & { [key: string]: unknown }) | null /** @description Whether this product is shipped (i.e., physical goods). */ - shippable?: boolean | null; + shippable?: boolean | null /** @description 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. */ - statement_descriptor?: string | null; + statement_descriptor?: string | null /** @description A [tax code](https://stripe.com/docs/tax/tax-codes) ID. */ - tax_code?: ((Partial & Partial) & { [key: string]: unknown }) | null; + tax_code?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description A label that represents units of this product in Stripe and on customers’ receipts and invoices. When set, this will be included in associated invoice line item descriptions. */ - unit_label?: string | null; + unit_label?: string | null /** * Format: unix-time * @description Time at which the object was last updated. Measured in seconds since the Unix epoch. */ - updated: number; + updated: number /** @description A URL of a publicly-accessible webpage for this product. */ - url?: string | null; - } & { [key: string]: unknown }; + url?: string | null + } & { [key: string]: unknown } /** * PromotionCode * @description A Promotion Code represents a customer-redeemable code for a coupon. It can be used to @@ -11933,52 +11578,52 @@ export interface components { */ promotion_code: { /** @description Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid. */ - active: boolean; + active: boolean /** @description The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. */ - code: string; - coupon: components["schemas"]["coupon"]; + code: string + coupon: components['schemas']['coupon'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The customer that this promotion code can be used by. */ customer?: - | ((Partial & - Partial & - Partial) & { [key: string]: unknown }) - | null; + | ((Partial & Partial & Partial) & { + [key: string]: unknown + }) + | null /** * Format: unix-time * @description Date at which the promotion code can no longer be redeemed. */ - expires_at?: number | null; + expires_at?: number | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description Maximum number of times this promotion code can be redeemed. */ - max_redemptions?: number | null; + max_redemptions?: number | null /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "promotion_code"; - restrictions: components["schemas"]["promotion_codes_resource_restrictions"]; + object: 'promotion_code' + restrictions: components['schemas']['promotion_codes_resource_restrictions'] /** @description Number of times this promotion code has been used. */ - times_redeemed: number; - } & { [key: string]: unknown }; + times_redeemed: number + } & { [key: string]: unknown } /** PromotionCodesResourceRestrictions */ promotion_codes_resource_restrictions: { /** @description A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices */ - first_time_transaction: boolean; + first_time_transaction: boolean /** @description Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work). */ - minimum_amount?: number | null; + minimum_amount?: number | null /** @description Three-letter [ISO code](https://stripe.com/docs/currencies) for minimum_amount */ - minimum_amount_currency?: string | null; - } & { [key: string]: unknown }; + minimum_amount_currency?: string | null + } & { [key: string]: unknown } /** * Quote * @description A Quote is a way to model prices that you'd like to provide to a customer. @@ -11986,234 +11631,222 @@ export interface components { */ quote: { /** @description Total before any discounts or taxes are applied. */ - amount_subtotal: number; + amount_subtotal: number /** @description Total after discounts and taxes are applied. */ - amount_total: number; + amount_total: number /** @description 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?: number | null; + application_fee_amount?: number | null /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal 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?: number | null; - automatic_tax: components["schemas"]["quotes_resource_automatic_tax"]; + application_fee_percent?: number | null + automatic_tax: components['schemas']['quotes_resource_automatic_tax'] /** * @description 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. Defaults to `charge_automatically`. * @enum {string} */ - collection_method: "charge_automatically" | "send_invoice"; - computed: components["schemas"]["quotes_resource_computed"]; + collection_method: 'charge_automatically' | 'send_invoice' + computed: components['schemas']['quotes_resource_computed'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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?: string | null; + currency?: string | null /** @description The customer which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed. */ customer?: - | ((Partial & - Partial & - Partial) & { [key: string]: unknown }) - | null; + | ((Partial & Partial & Partial) & { + [key: string]: unknown + }) + | null /** @description The tax rates applied to this quote. */ - default_tax_rates?: ((Partial & Partial) & { - [key: string]: unknown; - })[]; + default_tax_rates?: ((Partial & Partial) & { [key: string]: unknown })[] /** @description A description that will be displayed on the quote PDF. */ - description?: string | null; + description?: string | null /** @description The discounts applied to this quote. */ - discounts: ((Partial & Partial) & { [key: string]: unknown })[]; + discounts: ((Partial & Partial) & { [key: string]: unknown })[] /** * Format: unix-time * @description The date on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. */ - expires_at: number; + expires_at: number /** @description A footer that will be displayed on the quote PDF. */ - footer?: string | null; + footer?: string | null /** @description Details of the quote that was cloned. See the [cloning documentation](https://stripe.com/docs/quotes/clone) for more details. */ - from_quote?: (Partial & { [key: string]: unknown }) | null; + from_quote?: (Partial & { [key: string]: unknown }) | null /** @description A header that will be displayed on the quote PDF. */ - header?: string | null; + header?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The invoice that was created from this quote. */ invoice?: - | ((Partial & - Partial & - Partial) & { [key: string]: unknown }) - | null; + | ((Partial & Partial & Partial) & { + [key: string]: unknown + }) + | null /** @description All invoices will be billed using the specified settings. */ - invoice_settings?: - | (Partial & { [key: string]: unknown }) - | null; + invoice_settings?: (Partial & { [key: string]: unknown }) | null /** * QuotesResourceListLineItems * @description A list of items the customer is being quoted for. */ line_items?: { /** @description Details about each object. */ - data: components["schemas"]["item"][]; + data: components['schemas']['item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; + url: string + } & { [key: string]: unknown } /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** @description 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?: string | null; + number?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "quote"; + object: 'quote' /** @description 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?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + on_behalf_of?: ((Partial & Partial) & { [key: string]: unknown }) | null /** * @description The status of the quote. * @enum {string} */ - status: "accepted" | "canceled" | "draft" | "open"; - status_transitions: components["schemas"]["quotes_resource_status_transitions"]; + status: 'accepted' | 'canceled' | 'draft' | 'open' + status_transitions: components['schemas']['quotes_resource_status_transitions'] /** @description The subscription that was created or updated from this quote. */ - subscription?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; - subscription_data: components["schemas"]["quotes_resource_subscription_data"]; + subscription?: ((Partial & Partial) & { [key: string]: unknown }) | null + subscription_data: components['schemas']['quotes_resource_subscription_data'] /** @description The subscription schedule that was created or updated from this quote. */ - subscription_schedule?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; - total_details: components["schemas"]["quotes_resource_total_details"]; + subscription_schedule?: ((Partial & Partial) & { [key: string]: unknown }) | null + total_details: components['schemas']['quotes_resource_total_details'] /** @description 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?: - | (Partial & { [key: string]: unknown }) - | null; - } & { [key: string]: unknown }; + transfer_data?: (Partial & { [key: string]: unknown }) | null + } & { [key: string]: unknown } /** QuotesResourceAutomaticTax */ quotes_resource_automatic_tax: { /** @description Automatically calculate taxes */ - enabled: boolean; + enabled: boolean /** * @description The status of the most recent automated tax calculation for this quote. * @enum {string|null} */ - status?: ("complete" | "failed" | "requires_location_inputs") | null; - } & { [key: string]: unknown }; + status?: ('complete' | 'failed' | 'requires_location_inputs') | null + } & { [key: string]: unknown } /** QuotesResourceComputed */ quotes_resource_computed: { /** @description 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?: (Partial & { [key: string]: unknown }) | null; - upfront: components["schemas"]["quotes_resource_upfront"]; - } & { [key: string]: unknown }; + recurring?: (Partial & { [key: string]: unknown }) | null + upfront: components['schemas']['quotes_resource_upfront'] + } & { [key: string]: unknown } /** QuotesResourceFromQuote */ quotes_resource_from_quote: { /** @description Whether this quote is a revision of a different quote. */ - is_revision: boolean; + is_revision: boolean /** @description The quote that was cloned. */ - quote: (Partial & Partial) & { [key: string]: unknown }; - } & { [key: string]: unknown }; + quote: (Partial & Partial) & { [key: string]: unknown } + } & { [key: string]: unknown } /** QuotesResourceRecurring */ quotes_resource_recurring: { /** @description Total before any discounts or taxes are applied. */ - amount_subtotal: number; + amount_subtotal: number /** @description Total after discounts and taxes are applied. */ - amount_total: number; + amount_total: number /** * @description The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`. * @enum {string} */ - interval: "day" | "month" | "week" | "year"; + interval: 'day' | 'month' | 'week' | 'year' /** @description 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: number; - total_details: components["schemas"]["quotes_resource_total_details"]; - } & { [key: string]: unknown }; + interval_count: number + total_details: components['schemas']['quotes_resource_total_details'] + } & { [key: string]: unknown } /** QuotesResourceStatusTransitions */ quotes_resource_status_transitions: { /** * Format: unix-time * @description The time that the quote was accepted. Measured in seconds since Unix epoch. */ - accepted_at?: number | null; + accepted_at?: number | null /** * Format: unix-time * @description The time that the quote was canceled. Measured in seconds since Unix epoch. */ - canceled_at?: number | null; + canceled_at?: number | null /** * Format: unix-time * @description The time that the quote was finalized. Measured in seconds since Unix epoch. */ - finalized_at?: number | null; - } & { [key: string]: unknown }; + finalized_at?: number | null + } & { [key: string]: unknown } /** QuotesResourceSubscriptionData */ quotes_resource_subscription_data: { /** * Format: unix-time * @description 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?: number | null; + effective_date?: number | null /** @description Integer representing the number of trial period days before the customer is charged for the first time. */ - trial_period_days?: number | null; - } & { [key: string]: unknown }; + trial_period_days?: number | null + } & { [key: string]: unknown } /** QuotesResourceTotalDetails */ quotes_resource_total_details: { /** @description This is the sum of all the line item discounts. */ - amount_discount: number; + amount_discount: number /** @description This is the sum of all the line item shipping amounts. */ - amount_shipping?: number | null; + amount_shipping?: number | null /** @description This is the sum of all the line item tax amounts. */ - amount_tax: number; - breakdown?: components["schemas"]["quotes_resource_total_details_resource_breakdown"]; - } & { [key: string]: unknown }; + amount_tax: number + breakdown?: components['schemas']['quotes_resource_total_details_resource_breakdown'] + } & { [key: string]: unknown } /** QuotesResourceTotalDetailsResourceBreakdown */ quotes_resource_total_details_resource_breakdown: { /** @description The aggregated line item discounts. */ - discounts: components["schemas"]["line_items_discount_amount"][]; + discounts: components['schemas']['line_items_discount_amount'][] /** @description The aggregated line item tax amounts by rate. */ - taxes: components["schemas"]["line_items_tax_amount"][]; - } & { [key: string]: unknown }; + taxes: components['schemas']['line_items_tax_amount'][] + } & { [key: string]: unknown } /** QuotesResourceTransferData */ quotes_resource_transfer_data: { /** @description The amount in %s that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination. */ - amount?: number | null; + amount?: number | null /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the destination account. By default, the entire amount will be transferred to the destination. */ - amount_percent?: number | null; + amount_percent?: number | null /** @description The account where funds from the payment will be transferred to upon payment success. */ - destination: (Partial & Partial) & { [key: string]: unknown }; - } & { [key: string]: unknown }; + destination: (Partial & Partial) & { [key: string]: unknown } + } & { [key: string]: unknown } /** QuotesResourceUpfront */ quotes_resource_upfront: { /** @description Total before any discounts or taxes are applied. */ - amount_subtotal: number; + amount_subtotal: number /** @description Total after discounts and taxes are applied. */ - amount_total: number; + amount_total: number /** * QuotesResourceListLineItems * @description 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?: { /** @description Details about each object. */ - data: components["schemas"]["item"][]; + data: components['schemas']['item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - total_details: components["schemas"]["quotes_resource_total_details"]; - } & { [key: string]: unknown }; + url: string + } & { [key: string]: unknown } + total_details: components['schemas']['quotes_resource_total_details'] + } & { [key: string]: unknown } /** * RadarEarlyFraudWarning * @description An early fraud warning indicates that the card issuer has notified us that a @@ -12221,144 +11854,134 @@ export interface components { * * Related guide: [Early Fraud Warnings](https://stripe.com/docs/disputes/measuring#early-fraud-warnings). */ - "radar.early_fraud_warning": { + 'radar.early_fraud_warning': { /** @description 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: boolean; + actionable: boolean /** @description ID of the charge this early fraud warning is for, optionally expanded. */ - charge: (Partial & Partial) & { [key: string]: unknown }; + charge: (Partial & Partial) & { [key: string]: unknown } /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + fraud_type: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "radar.early_fraud_warning"; + object: 'radar.early_fraud_warning' /** @description ID of the Payment Intent this early fraud warning is for, optionally expanded. */ - payment_intent?: (Partial & Partial) & { - [key: string]: unknown; - }; - } & { [key: string]: unknown }; + payment_intent?: (Partial & Partial) & { [key: string]: unknown } + } & { [key: string]: unknown } /** * RadarListList * @description Value lists allow you to group values together which can then be referenced in rules. * * Related guide: [Default Stripe Lists](https://stripe.com/docs/radar/lists#managing-list-items). */ - "radar.value_list": { + 'radar.value_list': { /** @description The name of the value list for use in rules. */ - alias: string; + alias: string /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The name or email address of the user who created this value list. */ - created_by: string; + created_by: string /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description The type of items in the value list. One of `card_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, `case_sensitive_string`, or `customer_id`. * @enum {string} */ - item_type: - | "card_bin" - | "card_fingerprint" - | "case_sensitive_string" - | "country" - | "customer_id" - | "email" - | "ip_address" - | "string"; + item_type: 'card_bin' | 'card_fingerprint' | 'case_sensitive_string' | 'country' | 'customer_id' | 'email' | 'ip_address' | 'string' /** * RadarListListItemList * @description List of items contained within this value list. */ list_items: { /** @description Details about each object. */ - data: components["schemas"]["radar.value_list_item"][]; + data: components['schemas']['radar.value_list_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; + url: string + } & { [key: string]: unknown } /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** @description The name of the value list. */ - name: string; + name: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "radar.value_list"; - } & { [key: string]: unknown }; + object: 'radar.value_list' + } & { [key: string]: unknown } /** * RadarListListItem * @description Value list items allow you to add specific values to a given Radar value list, which can then be used in rules. * * Related guide: [Managing List Items](https://stripe.com/docs/radar/lists#managing-list-items). */ - "radar.value_list_item": { + 'radar.value_list_item': { /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The name or email address of the user who added this item to the value list. */ - created_by: string; + created_by: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "radar.value_list_item"; + object: 'radar.value_list_item' /** @description The value of the item. */ - value: string; + value: string /** @description The identifier of the value list this item belongs to. */ - value_list: string; - } & { [key: string]: unknown }; + value_list: string + } & { [key: string]: unknown } /** RadarReviewResourceLocation */ radar_review_resource_location: { /** @description The city where the payment originated. */ - city?: string | null; + city?: string | null /** @description Two-letter ISO code representing the country where the payment originated. */ - country?: string | null; + country?: string | null /** @description The geographic latitude where the payment originated. */ - latitude?: number | null; + latitude?: number | null /** @description The geographic longitude where the payment originated. */ - longitude?: number | null; + longitude?: number | null /** @description The state/county/province/region where the payment originated. */ - region?: string | null; - } & { [key: string]: unknown }; + region?: string | null + } & { [key: string]: unknown } /** RadarReviewResourceSession */ radar_review_resource_session: { /** @description The browser used in this browser session (e.g., `Chrome`). */ - browser?: string | null; + browser?: string | null /** @description Information about the device used for the browser session (e.g., `Samsung SM-G930T`). */ - device?: string | null; + device?: string | null /** @description The platform for the browser session (e.g., `Macintosh`). */ - platform?: string | null; + platform?: string | null /** @description The version for the browser session (e.g., `61.0.3163.100`). */ - version?: string | null; - } & { [key: string]: unknown }; + version?: string | null + } & { [key: string]: unknown } /** * TransferRecipient * @description With `Recipient` objects, you can transfer money from your Stripe account to a @@ -12374,71 +11997,71 @@ export interface components { */ recipient: { /** @description Hash describing the current account on the recipient, if there is one. */ - active_account?: (Partial & { [key: string]: unknown }) | null; + active_account?: (Partial & { [key: string]: unknown }) | null /** CardList */ cards?: | ({ - data: components["schemas"]["card"][]; + data: components['schemas']['card'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; + url: string } & { [key: string]: unknown }) - | null; + | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The default card to use for creating transfers to this recipient. */ - default_card?: ((Partial & Partial) & { [key: string]: unknown }) | null; + default_card?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; - email?: string | null; + description?: string | null + email?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** @description The ID of the [Custom account](https://stripe.com/docs/connect/custom-accounts) this recipient was migrated to. If set, the recipient can no longer be updated, nor can transfers be made to it: use the Custom account instead. */ - migrated_to?: ((Partial & Partial) & { [key: string]: unknown }) | null; + migrated_to?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description Full, legal name of the recipient. */ - name?: string | null; + name?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "recipient"; - rolled_back_from?: (Partial & Partial) & { [key: string]: unknown }; + object: 'recipient' + rolled_back_from?: (Partial & Partial) & { [key: string]: unknown } /** @description Type of the recipient, one of `individual` or `corporation`. */ - type: string; - } & { [key: string]: unknown }; + type: string + } & { [key: string]: unknown } /** Recurring */ recurring: { /** * @description Specifies a usage aggregation strategy for prices 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`. * @enum {string|null} */ - aggregate_usage?: ("last_during_period" | "last_ever" | "max" | "sum") | null; + aggregate_usage?: ('last_during_period' | 'last_ever' | 'max' | 'sum') | null /** * @description The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`. * @enum {string} */ - interval: "day" | "month" | "week" | "year"; + interval: 'day' | 'month' | 'week' | 'year' /** @description 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: number; + interval_count: number /** * @description 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`. * @enum {string} */ - usage_type: "licensed" | "metered"; - } & { [key: string]: unknown }; + usage_type: 'licensed' | 'metered' + } & { [key: string]: unknown } /** * Refund * @description `Refund` objects allow you to refund a charge that has previously been created @@ -12449,59 +12072,49 @@ export interface components { */ refund: { /** @description Amount, in %s. */ - amount: number; + amount: number /** @description Balance transaction that describes the impact on your account balance. */ - balance_transaction?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + balance_transaction?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description ID of the charge that was refunded. */ - charge?: ((Partial & Partial) & { [key: string]: unknown }) | null; + charge?: ((Partial & Partial) & { [key: string]: unknown }) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. (Available on non-card refunds only) */ - description?: string; + description?: string /** @description If the refund failed, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction. */ - failure_balance_transaction?: (Partial & Partial) & { - [key: string]: unknown; - }; + failure_balance_transaction?: (Partial & Partial) & { [key: string]: unknown } /** @description If the refund failed, the reason for refund failure if known. Possible values are `lost_or_stolen_card`, `expired_or_canceled_card`, or `unknown`. */ - failure_reason?: string; + failure_reason?: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "refund"; + object: 'refund' /** @description ID of the PaymentIntent that was refunded. */ - payment_intent?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + payment_intent?: ((Partial & Partial) & { [key: string]: unknown }) | null /** * @description Reason for the refund, either user-provided (`duplicate`, `fraudulent`, or `requested_by_customer`) or generated by Stripe internally (`expired_uncaptured_charge`). * @enum {string|null} */ - reason?: ("duplicate" | "expired_uncaptured_charge" | "fraudulent" | "requested_by_customer") | null; + reason?: ('duplicate' | 'expired_uncaptured_charge' | 'fraudulent' | 'requested_by_customer') | null /** @description This is the transaction number that appears on email receipts sent for this refund. */ - receipt_number?: string | null; + receipt_number?: string | null /** @description The transfer reversal that is associated with the refund. Only present if the charge came from another Stripe account. See the Connect documentation for details. */ - source_transfer_reversal?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + source_transfer_reversal?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description Status of the refund. For credit card refunds, this can be `pending`, `succeeded`, or `failed`. For other types of refunds, it can be `pending`, `succeeded`, `failed`, or `canceled`. Refer to our [refunds](https://stripe.com/docs/refunds#failed-refunds) documentation for more details. */ - status?: string | null; + status?: string | null /** @description If the accompanying transfer was reversed, the transfer reversal object. Only applicable if the charge was created using the destination parameter. */ - transfer_reversal?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; - } & { [key: string]: unknown }; + transfer_reversal?: ((Partial & Partial) & { [key: string]: unknown }) | null + } & { [key: string]: unknown } /** * reporting_report_run * @description The Report Run object represents an instance of a report type generated with @@ -12513,47 +12126,47 @@ export interface components { * Note that certain report types can only be run based on your live-mode data (not test-mode * data), and will error when queried without a [live-mode API key](https://stripe.com/docs/keys#test-live-modes). */ - "reporting.report_run": { + 'reporting.report_run': { /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** * @description If something should go wrong during the run, a message about the failure (populated when * `status=failed`). */ - error?: string | null; + error?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description `true` if the report is run on live mode data and `false` if it is run on test mode data. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "reporting.report_run"; - parameters: components["schemas"]["financial_reporting_finance_report_run_run_parameters"]; + object: 'reporting.report_run' + parameters: components['schemas']['financial_reporting_finance_report_run_run_parameters'] /** @description The ID of the [report type](https://stripe.com/docs/reports/report-types) to run, such as `"balance.summary.1"`. */ - report_type: string; + report_type: string /** * @description The file object representing the result of the report run (populated when * `status=succeeded`). */ - result?: (Partial & { [key: string]: unknown }) | null; + result?: (Partial & { [key: string]: unknown }) | null /** * @description 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. * Rarely, we may encounter an error, at which point this will be set to `failed` and the `error` field will be populated. */ - status: string; + status: string /** * Format: unix-time * @description Timestamp at which this run successfully finished (populated when * `status=succeeded`). Measured in seconds since the Unix epoch. */ - succeeded_at?: number | null; - } & { [key: string]: unknown }; + succeeded_at?: number | null + } & { [key: string]: unknown } /** * reporting_report_type * @description The Report Type resource corresponds to a particular type of report, such as @@ -12565,53 +12178,53 @@ export interface components { * Note that certain report types can only be run based on your live-mode data (not test-mode * data), and will error when queried without a [live-mode API key](https://stripe.com/docs/keys#test-live-modes). */ - "reporting.report_type": { + 'reporting.report_type': { /** * Format: unix-time * @description Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch. */ - data_available_end: number; + data_available_end: number /** * Format: unix-time * @description Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch. */ - data_available_start: number; + data_available_start: number /** @description 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?: string[] | null; + default_columns?: string[] | null /** @description The [ID of the Report Type](https://stripe.com/docs/reporting/statements/api#available-report-types), such as `balance.summary.1`. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description Human-readable name of the Report Type */ - name: string; + name: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "reporting.report_type"; + object: 'reporting.report_type' /** * Format: unix-time * @description When this Report Type was latest updated. Measured in seconds since the Unix epoch. */ - updated: number; + updated: number /** @description 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: number; - } & { [key: string]: unknown }; + version: number + } & { [key: string]: unknown } /** ReserveTransaction */ reserve_transaction: { - amount: number; + amount: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "reserve_transaction"; - } & { [key: string]: unknown }; + object: 'reserve_transaction' + } & { [key: string]: unknown } /** * RadarReview * @description Reviews can be used to supplement automated fraud detection with human expertise. @@ -12621,59 +12234,55 @@ export interface components { */ review: { /** @description The ZIP or postal code of the card used, if applicable. */ - billing_zip?: string | null; + billing_zip?: string | null /** @description The charge associated with this review. */ - charge?: ((Partial & Partial) & { [key: string]: unknown }) | null; + charge?: ((Partial & Partial) & { [key: string]: unknown }) | null /** * @description 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`. * @enum {string|null} */ - closed_reason?: ("approved" | "disputed" | "redacted" | "refunded" | "refunded_as_fraud") | null; + closed_reason?: ('approved' | 'disputed' | 'redacted' | 'refunded' | 'refunded_as_fraud') | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The IP address where the payment originated. */ - ip_address?: string | null; + ip_address?: string | null /** @description 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?: - | (Partial & { [key: string]: unknown }) - | null; + ip_address_location?: (Partial & { [key: string]: unknown }) | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "review"; + object: 'review' /** @description If `true`, the review needs action. */ - open: boolean; + open: boolean /** * @description The reason the review was opened. One of `rule` or `manual`. * @enum {string} */ - opened_reason: "manual" | "rule"; + opened_reason: 'manual' | 'rule' /** @description The PaymentIntent ID associated with this review, if one exists. */ - payment_intent?: (Partial & Partial) & { - [key: string]: unknown; - }; + payment_intent?: (Partial & Partial) & { [key: string]: unknown } /** @description The reason the review is currently open or closed. One of `rule`, `manual`, `approved`, `refunded`, `refunded_as_fraud`, `disputed`, or `redacted`. */ - reason: string; + reason: string /** @description Information related to the browsing session of the user who initiated the payment. */ - session?: (Partial & { [key: string]: unknown }) | null; - } & { [key: string]: unknown }; + session?: (Partial & { [key: string]: unknown }) | null + } & { [key: string]: unknown } /** RadarRule */ rule: { /** @description The action taken on the payment. */ - action: string; + action: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The predicate to evaluate the payment against. */ - predicate: string; - } & { [key: string]: unknown }; + predicate: string + } & { [key: string]: unknown } /** * ScheduledQueryRun * @description If you have [scheduled a Sigma query](https://stripe.com/docs/sigma/scheduled-queries), you'll @@ -12686,50 +12295,48 @@ export interface components { * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** * Format: unix-time * @description When the query was run, Sigma contained a snapshot of your Stripe data at this time. */ - data_load_time: number; - error?: components["schemas"]["sigma_scheduled_query_run_error"]; + data_load_time: number + error?: components['schemas']['sigma_scheduled_query_run_error'] /** @description The file object representing the results of the query. */ - file?: (Partial & { [key: string]: unknown }) | null; + file?: (Partial & { [key: string]: unknown }) | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "scheduled_query_run"; + object: 'scheduled_query_run' /** * Format: unix-time * @description Time at which the result expires and is no longer available for download. */ - result_available_until: number; + result_available_until: number /** @description SQL for the query. */ - sql: string; + sql: string /** @description The query's execution status, which will be `completed` for successful runs, and `canceled`, `failed`, or `timed_out` otherwise. */ - status: string; + status: string /** @description Title of the query. */ - title: string; - } & { [key: string]: unknown }; + title: string + } & { [key: string]: unknown } /** SchedulesPhaseAutomaticTax */ schedules_phase_automatic_tax: { /** @description Whether Stripe automatically computes tax on invoices created during this phase. */ - enabled: boolean; - } & { [key: string]: unknown }; + enabled: boolean + } & { [key: string]: unknown } /** sepa_debit_generated_from */ sepa_debit_generated_from: { /** @description The ID of the Charge that generated this PaymentMethod, if any. */ - charge?: ((Partial & Partial) & { [key: string]: unknown }) | null; + charge?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description The ID of the SetupAttempt that generated this PaymentMethod, if any. */ - setup_attempt?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; - } & { [key: string]: unknown }; + setup_attempt?: ((Partial & Partial) & { [key: string]: unknown }) | null + } & { [key: string]: unknown } /** * PaymentFlowsSetupIntentSetupAttempt * @description A SetupAttempt describes one attempted confirmation of a SetupIntent, @@ -12739,110 +12346,100 @@ export interface components { */ setup_attempt: { /** @description 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?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + application?: ((Partial & Partial) & { [key: string]: unknown }) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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?: - | ((Partial & - Partial & - Partial) & { [key: string]: unknown }) - | null; + | ((Partial & Partial & Partial) & { + [key: string]: unknown + }) + | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "setup_attempt"; + object: 'setup_attempt' /** @description 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?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + on_behalf_of?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description ID of the payment method used with this SetupAttempt. */ - payment_method: (Partial & Partial) & { [key: string]: unknown }; - payment_method_details: components["schemas"]["setup_attempt_payment_method_details"]; + payment_method: (Partial & Partial) & { [key: string]: unknown } + payment_method_details: components['schemas']['setup_attempt_payment_method_details'] /** @description The error encountered during this attempt to confirm the SetupIntent, if any. */ - setup_error?: (Partial & { [key: string]: unknown }) | null; + setup_error?: (Partial & { [key: string]: unknown }) | null /** @description ID of the SetupIntent that this attempt belongs to. */ - setup_intent: (Partial & Partial) & { [key: string]: unknown }; + setup_intent: (Partial & Partial) & { [key: string]: unknown } /** @description Status of this SetupAttempt, one of `requires_confirmation`, `requires_action`, `processing`, `succeeded`, `failed`, or `abandoned`. */ - status: string; + status: string /** @description 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: string; - } & { [key: string]: unknown }; + usage: string + } & { [key: string]: unknown } /** SetupAttemptPaymentMethodDetails */ setup_attempt_payment_method_details: { - acss_debit?: components["schemas"]["setup_attempt_payment_method_details_acss_debit"]; - au_becs_debit?: components["schemas"]["setup_attempt_payment_method_details_au_becs_debit"]; - bacs_debit?: components["schemas"]["setup_attempt_payment_method_details_bacs_debit"]; - bancontact?: components["schemas"]["setup_attempt_payment_method_details_bancontact"]; - boleto?: components["schemas"]["setup_attempt_payment_method_details_boleto"]; - card?: components["schemas"]["setup_attempt_payment_method_details_card"]; - card_present?: components["schemas"]["setup_attempt_payment_method_details_card_present"]; - ideal?: components["schemas"]["setup_attempt_payment_method_details_ideal"]; - sepa_debit?: components["schemas"]["setup_attempt_payment_method_details_sepa_debit"]; - sofort?: components["schemas"]["setup_attempt_payment_method_details_sofort"]; + acss_debit?: components['schemas']['setup_attempt_payment_method_details_acss_debit'] + au_becs_debit?: components['schemas']['setup_attempt_payment_method_details_au_becs_debit'] + bacs_debit?: components['schemas']['setup_attempt_payment_method_details_bacs_debit'] + bancontact?: components['schemas']['setup_attempt_payment_method_details_bancontact'] + boleto?: components['schemas']['setup_attempt_payment_method_details_boleto'] + card?: components['schemas']['setup_attempt_payment_method_details_card'] + card_present?: components['schemas']['setup_attempt_payment_method_details_card_present'] + ideal?: components['schemas']['setup_attempt_payment_method_details_ideal'] + sepa_debit?: components['schemas']['setup_attempt_payment_method_details_sepa_debit'] + sofort?: components['schemas']['setup_attempt_payment_method_details_sofort'] /** @description 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: string; - } & { [key: string]: unknown }; + type: string + } & { [key: string]: unknown } /** setup_attempt_payment_method_details_acss_debit */ - setup_attempt_payment_method_details_acss_debit: { [key: string]: unknown }; + setup_attempt_payment_method_details_acss_debit: { [key: string]: unknown } /** setup_attempt_payment_method_details_au_becs_debit */ - setup_attempt_payment_method_details_au_becs_debit: { [key: string]: unknown }; + setup_attempt_payment_method_details_au_becs_debit: { [key: string]: unknown } /** setup_attempt_payment_method_details_bacs_debit */ - setup_attempt_payment_method_details_bacs_debit: { [key: string]: unknown }; + setup_attempt_payment_method_details_bacs_debit: { [key: string]: unknown } /** setup_attempt_payment_method_details_bancontact */ setup_attempt_payment_method_details_bancontact: { /** @description Bank code of bank associated with the bank account. */ - bank_code?: string | null; + bank_code?: string | null /** @description Name of the bank associated with the bank account. */ - bank_name?: string | null; + bank_name?: string | null /** @description Bank Identifier Code of the bank associated with the bank account. */ - bic?: string | null; + bic?: string | null /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ - generated_sepa_debit?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + generated_sepa_debit?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ - generated_sepa_debit_mandate?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + generated_sepa_debit_mandate?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description Last four characters of the IBAN. */ - iban_last4?: string | null; + iban_last4?: string | null /** * @description Preferred language of the Bancontact authorization page that the customer is redirected to. * Can be one of `en`, `de`, `fr`, or `nl` * @enum {string|null} */ - preferred_language?: ("de" | "en" | "fr" | "nl") | null; + preferred_language?: ('de' | 'en' | 'fr' | 'nl') | null /** * @description Owner's verified full name. Values are verified or provided by Bancontact directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - verified_name?: string | null; - } & { [key: string]: unknown }; + verified_name?: string | null + } & { [key: string]: unknown } /** setup_attempt_payment_method_details_boleto */ - setup_attempt_payment_method_details_boleto: { [key: string]: unknown }; + setup_attempt_payment_method_details_boleto: { [key: string]: unknown } /** setup_attempt_payment_method_details_card */ setup_attempt_payment_method_details_card: { /** @description Populated if this authorization used 3D Secure authentication. */ - three_d_secure?: (Partial & { [key: string]: unknown }) | null; - } & { [key: string]: unknown }; + three_d_secure?: (Partial & { [key: string]: unknown }) | null + } & { [key: string]: unknown } /** setup_attempt_payment_method_details_card_present */ setup_attempt_payment_method_details_card_present: { /** @description The ID of the Card PaymentMethod which was generated by this SetupAttempt. */ - generated_card?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; - } & { [key: string]: unknown }; + generated_card?: ((Partial & Partial) & { [key: string]: unknown }) | null + } & { [key: string]: unknown } /** setup_attempt_payment_method_details_ideal */ setup_attempt_payment_method_details_ideal: { /** @@ -12851,90 +12448,82 @@ export interface components { */ bank?: | ( - | "abn_amro" - | "asn_bank" - | "bunq" - | "handelsbanken" - | "ing" - | "knab" - | "moneyou" - | "rabobank" - | "regiobank" - | "revolut" - | "sns_bank" - | "triodos_bank" - | "van_lanschot" + | 'abn_amro' + | 'asn_bank' + | 'bunq' + | 'handelsbanken' + | 'ing' + | 'knab' + | 'moneyou' + | 'rabobank' + | 'regiobank' + | 'revolut' + | 'sns_bank' + | 'triodos_bank' + | 'van_lanschot' ) - | null; + | null /** * @description The Bank Identifier Code of the customer's bank. * @enum {string|null} */ bic?: | ( - | "ABNANL2A" - | "ASNBNL21" - | "BUNQNL2A" - | "FVLBNL22" - | "HANDNL2A" - | "INGBNL2A" - | "KNABNL2H" - | "MOYONL21" - | "RABONL2U" - | "RBRBNL21" - | "REVOLT21" - | "SNSBNL2A" - | "TRIONL2U" + | 'ABNANL2A' + | 'ASNBNL21' + | 'BUNQNL2A' + | 'FVLBNL22' + | 'HANDNL2A' + | 'INGBNL2A' + | 'KNABNL2H' + | 'MOYONL21' + | 'RABONL2U' + | 'RBRBNL21' + | 'REVOLT21' + | 'SNSBNL2A' + | 'TRIONL2U' ) - | null; + | null /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ - generated_sepa_debit?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + generated_sepa_debit?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ - generated_sepa_debit_mandate?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + generated_sepa_debit_mandate?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description Last four characters of the IBAN. */ - iban_last4?: string | null; + iban_last4?: string | null /** * @description Owner's verified full name. Values are verified or provided by iDEAL directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - verified_name?: string | null; - } & { [key: string]: unknown }; + verified_name?: string | null + } & { [key: string]: unknown } /** setup_attempt_payment_method_details_sepa_debit */ - setup_attempt_payment_method_details_sepa_debit: { [key: string]: unknown }; + setup_attempt_payment_method_details_sepa_debit: { [key: string]: unknown } /** setup_attempt_payment_method_details_sofort */ setup_attempt_payment_method_details_sofort: { /** @description Bank code of bank associated with the bank account. */ - bank_code?: string | null; + bank_code?: string | null /** @description Name of the bank associated with the bank account. */ - bank_name?: string | null; + bank_name?: string | null /** @description Bank Identifier Code of the bank associated with the bank account. */ - bic?: string | null; + bic?: string | null /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ - generated_sepa_debit?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + generated_sepa_debit?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ - generated_sepa_debit_mandate?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + generated_sepa_debit_mandate?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description Last four characters of the IBAN. */ - iban_last4?: string | null; + iban_last4?: string | null /** * @description Preferred language of the Sofort authorization page that the customer is redirected to. * Can be one of `en`, `de`, `fr`, or `nl` * @enum {string|null} */ - preferred_language?: ("de" | "en" | "fr" | "nl") | null; + preferred_language?: ('de' | 'en' | 'fr' | 'nl') | null /** * @description Owner's verified full name. Values are verified or provided by Sofort directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - verified_name?: string | null; - } & { [key: string]: unknown }; + verified_name?: string | null + } & { [key: string]: unknown } /** * SetupIntent * @description A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. @@ -12962,198 +12551,180 @@ export interface components { */ setup_intent: { /** @description ID of the Connect application that created the SetupIntent. */ - application?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + application?: ((Partial & Partial) & { [key: string]: unknown }) | null /** * @description Reason for cancellation of this SetupIntent, one of `abandoned`, `requested_by_customer`, or `duplicate`. * @enum {string|null} */ - cancellation_reason?: ("abandoned" | "duplicate" | "requested_by_customer") | null; + cancellation_reason?: ('abandoned' | 'duplicate' | 'requested_by_customer') | null /** * @description The client secret of this SetupIntent. Used for client-side retrieval using a publishable key. * * The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, embedded in URLs, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret. */ - client_secret?: string | null; + client_secret?: string | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** * @description ID of the Customer this SetupIntent belongs to, if one exists. * * If 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. */ customer?: - | ((Partial & - Partial & - Partial) & { [key: string]: unknown }) - | null; + | ((Partial & Partial & Partial) & { + [key: string]: unknown + }) + | null /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The error encountered in the previous SetupIntent confirmation. */ - last_setup_error?: (Partial & { [key: string]: unknown }) | null; + last_setup_error?: (Partial & { [key: string]: unknown }) | null /** @description The most recent SetupAttempt for this SetupIntent. */ - latest_attempt?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + latest_attempt?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description ID of the multi use Mandate generated by the SetupIntent. */ - mandate?: ((Partial & Partial) & { [key: string]: unknown }) | null; + mandate?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** @description If present, this property tells you what actions you need to take in order for your customer to continue payment setup. */ - next_action?: (Partial & { [key: string]: unknown }) | null; + next_action?: (Partial & { [key: string]: unknown }) | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "setup_intent"; + object: 'setup_intent' /** @description The account (if any) for which the setup is intended. */ - on_behalf_of?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + on_behalf_of?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description ID of the payment method used with this SetupIntent. */ - payment_method?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + payment_method?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description Payment-method-specific configuration for this SetupIntent. */ - payment_method_options?: - | (Partial & { [key: string]: unknown }) - | null; + payment_method_options?: (Partial & { [key: string]: unknown }) | null /** @description The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. */ - payment_method_types: string[]; + payment_method_types: string[] /** @description ID of the single_use Mandate generated by the SetupIntent. */ - single_use_mandate?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + single_use_mandate?: ((Partial & Partial) & { [key: string]: unknown }) | null /** * @description [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`. * @enum {string} */ - status: - | "canceled" - | "processing" - | "requires_action" - | "requires_confirmation" - | "requires_payment_method" - | "succeeded"; + status: 'canceled' | 'processing' | 'requires_action' | 'requires_confirmation' | 'requires_payment_method' | 'succeeded' /** * @description Indicates how the payment method is intended to be used in the future. * * Use `on_session` if you intend to only reuse the payment method when the customer is in your checkout flow. Use `off_session` if your customer may or may not be in your checkout flow. If not provided, this value defaults to `off_session`. */ - usage: string; - } & { [key: string]: unknown }; + usage: string + } & { [key: string]: unknown } /** SetupIntentNextAction */ setup_intent_next_action: { - redirect_to_url?: components["schemas"]["setup_intent_next_action_redirect_to_url"]; + redirect_to_url?: components['schemas']['setup_intent_next_action_redirect_to_url'] /** @description 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: string; + type: string /** @description 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?: { [key: string]: unknown }; - verify_with_microdeposits?: components["schemas"]["setup_intent_next_action_verify_with_microdeposits"]; - } & { [key: string]: unknown }; + use_stripe_sdk?: { [key: string]: unknown } + verify_with_microdeposits?: components['schemas']['setup_intent_next_action_verify_with_microdeposits'] + } & { [key: string]: unknown } /** SetupIntentNextActionRedirectToUrl */ setup_intent_next_action_redirect_to_url: { /** @description If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion. */ - return_url?: string | null; + return_url?: string | null /** @description The URL you must redirect your customer to in order to authenticate. */ - url?: string | null; - } & { [key: string]: unknown }; + url?: string | null + } & { [key: string]: unknown } /** SetupIntentNextActionVerifyWithMicrodeposits */ setup_intent_next_action_verify_with_microdeposits: { /** * Format: unix-time * @description The timestamp when the microdeposits are expected to land. */ - arrival_date: number; + arrival_date: number /** @description The URL for the hosted verification page, which allows customers to verify their bank account. */ - hosted_verification_url: string; - } & { [key: string]: unknown }; + hosted_verification_url: string + } & { [key: string]: unknown } /** SetupIntentPaymentMethodOptions */ setup_intent_payment_method_options: { - acss_debit?: components["schemas"]["setup_intent_payment_method_options_acss_debit"]; - card?: components["schemas"]["setup_intent_payment_method_options_card"]; - sepa_debit?: components["schemas"]["setup_intent_payment_method_options_sepa_debit"]; - } & { [key: string]: unknown }; + acss_debit?: components['schemas']['setup_intent_payment_method_options_acss_debit'] + card?: components['schemas']['setup_intent_payment_method_options_card'] + sepa_debit?: components['schemas']['setup_intent_payment_method_options_sepa_debit'] + } & { [key: string]: unknown } /** setup_intent_payment_method_options_acss_debit */ setup_intent_payment_method_options_acss_debit: { /** * @description Currency supported by the bank account * @enum {string|null} */ - currency?: ("cad" | "usd") | null; - mandate_options?: components["schemas"]["setup_intent_payment_method_options_mandate_options_acss_debit"]; + currency?: ('cad' | 'usd') | null + mandate_options?: components['schemas']['setup_intent_payment_method_options_mandate_options_acss_debit'] /** * @description Bank account verification method. * @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; - } & { [key: string]: unknown }; + verification_method?: 'automatic' | 'instant' | 'microdeposits' + } & { [key: string]: unknown } /** setup_intent_payment_method_options_card */ setup_intent_payment_method_options_card: { /** * @description 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. Permitted values include: `automatic` or `any`. If not provided, defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. * @enum {string|null} */ - request_three_d_secure?: ("any" | "automatic" | "challenge_only") | null; - } & { [key: string]: unknown }; + request_three_d_secure?: ('any' | 'automatic' | 'challenge_only') | null + } & { [key: string]: unknown } /** setup_intent_payment_method_options_mandate_options_acss_debit */ setup_intent_payment_method_options_mandate_options_acss_debit: { /** @description A URL for custom mandate text */ - custom_mandate_url?: string; + custom_mandate_url?: string /** @description List of Stripe products where this mandate can be selected automatically. */ - default_for?: ("invoice" | "subscription")[]; + default_for?: ('invoice' | 'subscription')[] /** @description Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. */ - interval_description?: string | null; + interval_description?: string | null /** * @description Payment schedule for the mandate. * @enum {string|null} */ - payment_schedule?: ("combined" | "interval" | "sporadic") | null; + payment_schedule?: ('combined' | 'interval' | 'sporadic') | null /** * @description Transaction type of the mandate. * @enum {string|null} */ - transaction_type?: ("business" | "personal") | null; - } & { [key: string]: unknown }; + transaction_type?: ('business' | 'personal') | null + } & { [key: string]: unknown } /** setup_intent_payment_method_options_mandate_options_sepa_debit */ - setup_intent_payment_method_options_mandate_options_sepa_debit: { [key: string]: unknown }; + setup_intent_payment_method_options_mandate_options_sepa_debit: { [key: string]: unknown } /** setup_intent_payment_method_options_sepa_debit */ setup_intent_payment_method_options_sepa_debit: { - mandate_options?: components["schemas"]["setup_intent_payment_method_options_mandate_options_sepa_debit"]; - } & { [key: string]: unknown }; + mandate_options?: components['schemas']['setup_intent_payment_method_options_mandate_options_sepa_debit'] + } & { [key: string]: unknown } /** Shipping */ shipping: { - address?: components["schemas"]["address"]; + address?: components['schemas']['address'] /** @description The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. */ - carrier?: string | null; + carrier?: string | null /** @description Recipient name. */ - name?: string | null; + name?: string | null /** @description Recipient phone (including extension). */ - phone?: string | null; + phone?: string | null /** @description 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?: string | null; - } & { [key: string]: unknown }; + tracking_number?: string | null + } & { [key: string]: unknown } /** ShippingMethod */ shipping_method: { /** @description 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 line item. */ - amount: number; + amount: number /** @description 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: string; + currency: string /** @description The estimated delivery date for the given shipping method. Can be either a specific date or a range. */ - delivery_estimate?: (Partial & { [key: string]: unknown }) | null; + delivery_estimate?: (Partial & { [key: string]: unknown }) | null /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description: string; + description: string /** @description Unique identifier for the object. */ - id: string; - } & { [key: string]: unknown }; + id: string + } & { [key: string]: unknown } /** * ShippingRate * @description Shipping rates describe the price of shipping presented to your customers and can be @@ -13161,76 +12732,70 @@ export interface components { */ shipping_rate: { /** @description Whether the shipping rate can be used for new purchases. Defaults to `true`. */ - active: boolean; + active: boolean /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions. */ - delivery_estimate?: - | (Partial & { [key: string]: unknown }) - | null; + delivery_estimate?: (Partial & { [key: string]: unknown }) | null /** @description The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions. */ - display_name?: string | null; - fixed_amount?: components["schemas"]["shipping_rate_fixed_amount"]; + display_name?: string | null + fixed_amount?: components['schemas']['shipping_rate_fixed_amount'] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "shipping_rate"; + object: 'shipping_rate' /** * @description Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. * @enum {string|null} */ - tax_behavior?: ("exclusive" | "inclusive" | "unspecified") | null; + tax_behavior?: ('exclusive' | 'inclusive' | 'unspecified') | null /** @description A [tax code](https://stripe.com/docs/tax/tax-codes) ID. The Shipping tax code is `txcd_92010001`. */ - tax_code?: ((Partial & Partial) & { [key: string]: unknown }) | null; + tax_code?: ((Partial & Partial) & { [key: string]: unknown }) | null /** * @description The type of calculation to use on the shipping rate. Can only be `fixed_amount` for now. * @enum {string} */ - type: "fixed_amount"; - } & { [key: string]: unknown }; + type: 'fixed_amount' + } & { [key: string]: unknown } /** ShippingRateDeliveryEstimate */ shipping_rate_delivery_estimate: { /** @description The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite. */ - maximum?: - | (Partial & { [key: string]: unknown }) - | null; + maximum?: (Partial & { [key: string]: unknown }) | null /** @description The lower bound of the estimated range. If empty, represents no lower bound. */ - minimum?: - | (Partial & { [key: string]: unknown }) - | null; - } & { [key: string]: unknown }; + minimum?: (Partial & { [key: string]: unknown }) | null + } & { [key: string]: unknown } /** ShippingRateDeliveryEstimateBound */ shipping_rate_delivery_estimate_bound: { /** * @description A unit of time. * @enum {string} */ - unit: "business_day" | "day" | "hour" | "month" | "week"; + unit: 'business_day' | 'day' | 'hour' | 'month' | 'week' /** @description Must be greater than 0. */ - value: number; - } & { [key: string]: unknown }; + value: number + } & { [key: string]: unknown } /** ShippingRateFixedAmount */ shipping_rate_fixed_amount: { /** @description A non-negative integer in cents representing how much to charge. */ - amount: number; + amount: number /** @description 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: string; - } & { [key: string]: unknown }; + currency: string + } & { [key: string]: unknown } /** SigmaScheduledQueryRunError */ sigma_scheduled_query_run_error: { /** @description Information about the run failure. */ - message: string; - } & { [key: string]: unknown }; + message: string + } & { [key: string]: unknown } /** * Sku * @description Stores representations of [stock keeping units](http://en.wikipedia.org/wiki/Stock_keeping_unit). @@ -13244,51 +12809,51 @@ export interface components { */ sku: { /** @description Whether the SKU is available for purchase. */ - active: boolean; + active: boolean /** @description A dictionary of attributes and values for the attributes defined by the product. If, for example, a product's attributes are `["size", "gender"]`, a valid SKU has the following dictionary of attributes: `{"size": "Medium", "gender": "Unisex"}`. */ - attributes: { [key: string]: string }; + attributes: { [key: string]: string } /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The URL of an image for this SKU, meant to be displayable to the customer. */ - image?: string | null; - inventory: components["schemas"]["sku_inventory"]; + image?: string | null + inventory: components['schemas']['sku_inventory'] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "sku"; + object: 'sku' /** @description The dimensions of this SKU for shipping purposes. */ - package_dimensions?: (Partial & { [key: string]: unknown }) | null; + package_dimensions?: (Partial & { [key: string]: unknown }) | null /** @description The cost of the item as a positive integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a zero-decimal currency). */ - price: number; + price: number /** @description The ID of the product this SKU is associated with. The product must be currently active. */ - product: (Partial & Partial) & { [key: string]: unknown }; + product: (Partial & Partial) & { [key: string]: unknown } /** * Format: unix-time * @description Time at which the object was last updated. Measured in seconds since the Unix epoch. */ - updated: number; - } & { [key: string]: unknown }; + updated: number + } & { [key: string]: unknown } /** SKUInventory */ sku_inventory: { /** @description The count of inventory available. Will be present if and only if `type` is `finite`. */ - quantity?: number | null; + quantity?: number | null /** @description Inventory type. Possible values are `finite`, `bucket` (not quantified), and `infinite`. */ - type: string; + type: string /** @description An indicator of the inventory available. Possible values are `in_stock`, `limited`, and `out_of_stock`. Will be present if and only if `type` is `bucket`. */ - value?: string | null; - } & { [key: string]: unknown }; + value?: string | null + } & { [key: string]: unknown } /** * Source * @description `Source` objects allow you to accept a variety of payment methods. They @@ -13299,93 +12864,93 @@ export interface components { * Related guides: [Sources API](https://stripe.com/docs/sources) and [Sources & Customers](https://stripe.com/docs/sources/customers). */ source: { - ach_credit_transfer?: components["schemas"]["source_type_ach_credit_transfer"]; - ach_debit?: components["schemas"]["source_type_ach_debit"]; - acss_debit?: components["schemas"]["source_type_acss_debit"]; - alipay?: components["schemas"]["source_type_alipay"]; + ach_credit_transfer?: components['schemas']['source_type_ach_credit_transfer'] + ach_debit?: components['schemas']['source_type_ach_debit'] + acss_debit?: components['schemas']['source_type_acss_debit'] + alipay?: components['schemas']['source_type_alipay'] /** @description 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?: number | null; - au_becs_debit?: components["schemas"]["source_type_au_becs_debit"]; - bancontact?: components["schemas"]["source_type_bancontact"]; - card?: components["schemas"]["source_type_card"]; - card_present?: components["schemas"]["source_type_card_present"]; + amount?: number | null + au_becs_debit?: components['schemas']['source_type_au_becs_debit'] + bancontact?: components['schemas']['source_type_bancontact'] + card?: components['schemas']['source_type_card'] + card_present?: components['schemas']['source_type_card_present'] /** @description The client secret of the source. Used for client-side retrieval using a publishable key. */ - client_secret: string; - code_verification?: components["schemas"]["source_code_verification_flow"]; + client_secret: string + code_verification?: components['schemas']['source_code_verification_flow'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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?: string | null; + currency?: string | null /** @description 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?: string; - eps?: components["schemas"]["source_type_eps"]; + customer?: string + eps?: components['schemas']['source_type_eps'] /** @description The authentication `flow` of the source. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`. */ - flow: string; - giropay?: components["schemas"]["source_type_giropay"]; + flow: string + giropay?: components['schemas']['source_type_giropay'] /** @description Unique identifier for the object. */ - id: string; - ideal?: components["schemas"]["source_type_ideal"]; - klarna?: components["schemas"]["source_type_klarna"]; + id: string + ideal?: components['schemas']['source_type_ideal'] + klarna?: components['schemas']['source_type_klarna'] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; - multibanco?: components["schemas"]["source_type_multibanco"]; + metadata?: { [key: string]: string } | null + multibanco?: components['schemas']['source_type_multibanco'] /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "source"; + object: 'source' /** @description Information about the owner of the payment instrument that may be used or required by particular source types. */ - owner?: (Partial & { [key: string]: unknown }) | null; - p24?: components["schemas"]["source_type_p24"]; - receiver?: components["schemas"]["source_receiver_flow"]; - redirect?: components["schemas"]["source_redirect_flow"]; - sepa_debit?: components["schemas"]["source_type_sepa_debit"]; - sofort?: components["schemas"]["source_type_sofort"]; - source_order?: components["schemas"]["source_order"]; + owner?: (Partial & { [key: string]: unknown }) | null + p24?: components['schemas']['source_type_p24'] + receiver?: components['schemas']['source_receiver_flow'] + redirect?: components['schemas']['source_redirect_flow'] + sepa_debit?: components['schemas']['source_type_sepa_debit'] + sofort?: components['schemas']['source_type_sofort'] + source_order?: components['schemas']['source_order'] /** @description Extra information about a source. This will appear on your customer's statement every time you charge the source. */ - statement_descriptor?: string | null; + statement_descriptor?: string | null /** @description The status of the source, one of `canceled`, `chargeable`, `consumed`, `failed`, or `pending`. Only `chargeable` sources can be used to create a charge. */ - status: string; - three_d_secure?: components["schemas"]["source_type_three_d_secure"]; + status: string + three_d_secure?: components['schemas']['source_type_three_d_secure'] /** * @description 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. * @enum {string} */ type: - | "ach_credit_transfer" - | "ach_debit" - | "acss_debit" - | "alipay" - | "au_becs_debit" - | "bancontact" - | "card" - | "card_present" - | "eps" - | "giropay" - | "ideal" - | "klarna" - | "multibanco" - | "p24" - | "sepa_debit" - | "sofort" - | "three_d_secure" - | "wechat"; + | 'ach_credit_transfer' + | 'ach_debit' + | 'acss_debit' + | 'alipay' + | 'au_becs_debit' + | 'bancontact' + | 'card' + | 'card_present' + | 'eps' + | 'giropay' + | 'ideal' + | 'klarna' + | 'multibanco' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'three_d_secure' + | 'wechat' /** @description 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?: string | null; - wechat?: components["schemas"]["source_type_wechat"]; - } & { [key: string]: unknown }; + usage?: string | null + wechat?: components['schemas']['source_type_wechat'] + } & { [key: string]: unknown } /** SourceCodeVerificationFlow */ source_code_verification_flow: { /** @description The number of attempts remaining to authenticate the source object with a verification code. */ - attempts_remaining: number; + attempts_remaining: number /** @description 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: string; - } & { [key: string]: unknown }; + status: string + } & { [key: string]: unknown } /** * SourceMandateNotification * @description Source mandate notifications should be created when a notification related to @@ -13393,124 +12958,124 @@ export interface components { * deliver an email to the customer. */ source_mandate_notification: { - acss_debit?: components["schemas"]["source_mandate_notification_acss_debit_data"]; + acss_debit?: components['schemas']['source_mandate_notification_acss_debit_data'] /** @description 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?: number | null; - bacs_debit?: components["schemas"]["source_mandate_notification_bacs_debit_data"]; + amount?: number | null + bacs_debit?: components['schemas']['source_mandate_notification_bacs_debit_data'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "source_mandate_notification"; + object: 'source_mandate_notification' /** @description The reason of the mandate notification. Valid reasons are `mandate_confirmed` or `debit_initiated`. */ - reason: string; - sepa_debit?: components["schemas"]["source_mandate_notification_sepa_debit_data"]; - source: components["schemas"]["source"]; + reason: string + sepa_debit?: components['schemas']['source_mandate_notification_sepa_debit_data'] + source: components['schemas']['source'] /** @description The status of the mandate notification. Valid statuses are `pending` or `submitted`. */ - status: string; + status: string /** @description 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: string; - } & { [key: string]: unknown }; + type: string + } & { [key: string]: unknown } /** SourceMandateNotificationAcssDebitData */ source_mandate_notification_acss_debit_data: { /** @description The statement descriptor associate with the debit. */ - statement_descriptor?: string; - } & { [key: string]: unknown }; + statement_descriptor?: string + } & { [key: string]: unknown } /** SourceMandateNotificationBacsDebitData */ source_mandate_notification_bacs_debit_data: { /** @description Last 4 digits of the account number associated with the debit. */ - last4?: string; - } & { [key: string]: unknown }; + last4?: string + } & { [key: string]: unknown } /** SourceMandateNotificationSepaDebitData */ source_mandate_notification_sepa_debit_data: { /** @description SEPA creditor ID. */ - creditor_identifier?: string; + creditor_identifier?: string /** @description Last 4 digits of the account number associated with the debit. */ - last4?: string; + last4?: string /** @description Mandate reference associated with the debit. */ - mandate_reference?: string; - } & { [key: string]: unknown }; + mandate_reference?: string + } & { [key: string]: unknown } /** SourceOrder */ source_order: { /** @description 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: number; + amount: number /** @description 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: string; + currency: string /** @description The email address of the customer placing the order. */ - email?: string; + email?: string /** @description List of items constituting the order. */ - items?: components["schemas"]["source_order_item"][] | null; - shipping?: components["schemas"]["shipping"]; - } & { [key: string]: unknown }; + items?: components['schemas']['source_order_item'][] | null + shipping?: components['schemas']['shipping'] + } & { [key: string]: unknown } /** SourceOrderItem */ source_order_item: { /** @description The amount (price) for this order item. */ - amount?: number | null; + amount?: number | null /** @description This currency of this order item. Required when `amount` is present. */ - currency?: string | null; + currency?: string | null /** @description Human-readable description for this order item. */ - description?: string | null; + description?: string | null /** @description The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a SKU). */ - parent?: string | null; + parent?: string | null /** @description The quantity of this order item. When type is `sku`, this is the number of instances of the SKU to be ordered. */ - quantity?: number; + quantity?: number /** @description The type of this order item. Must be `sku`, `tax`, or `shipping`. */ - type?: string | null; - } & { [key: string]: unknown }; + type?: string | null + } & { [key: string]: unknown } /** SourceOwner */ source_owner: { /** @description Owner's address. */ - address?: (Partial & { [key: string]: unknown }) | null; + address?: (Partial & { [key: string]: unknown }) | null /** @description Owner's email address. */ - email?: string | null; + email?: string | null /** @description Owner's full name. */ - name?: string | null; + name?: string | null /** @description Owner's phone number (including extension). */ - phone?: string | null; + phone?: string | null /** @description 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?: (Partial & { [key: string]: unknown }) | null; + verified_address?: (Partial & { [key: string]: unknown }) | null /** @description 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?: string | null; + verified_email?: string | null /** @description 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?: string | null; + verified_name?: string | null /** @description 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?: string | null; - } & { [key: string]: unknown }; + verified_phone?: string | null + } & { [key: string]: unknown } /** SourceReceiverFlow */ source_receiver_flow: { /** @description The address of the receiver source. This is the value that should be communicated to the customer to send their funds to. */ - address?: string | null; + address?: string | null /** @description 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: number; + amount_charged: number /** @description 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: number; + amount_received: number /** @description The total amount that was returned to the customer. The amount returned is expressed in the source's currency. */ - amount_returned: number; + amount_returned: number /** @description Type of refund attribute method, one of `email`, `manual`, or `none`. */ - refund_attributes_method: string; + refund_attributes_method: string /** @description Type of refund attribute status, one of `missing`, `requested`, or `available`. */ - refund_attributes_status: string; - } & { [key: string]: unknown }; + refund_attributes_status: string + } & { [key: string]: unknown } /** SourceRedirectFlow */ source_redirect_flow: { /** @description 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?: string | null; + failure_reason?: string | null /** @description The URL you provide to redirect the customer to after they authenticated their payment. */ - return_url: string; + return_url: string /** @description 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: string; + status: string /** @description The URL provided to you to redirect a customer to as part of a `redirect` authentication flow. */ - url: string; - } & { [key: string]: unknown }; + url: string + } & { [key: string]: unknown } /** * SourceTransaction * @description Some payment methods have no required amount that a customer must send. @@ -13519,325 +13084,325 @@ export interface components { * transactions. */ source_transaction: { - ach_credit_transfer?: components["schemas"]["source_transaction_ach_credit_transfer_data"]; + ach_credit_transfer?: components['schemas']['source_transaction_ach_credit_transfer_data'] /** @description 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: number; - chf_credit_transfer?: components["schemas"]["source_transaction_chf_credit_transfer_data"]; + amount: number + chf_credit_transfer?: components['schemas']['source_transaction_chf_credit_transfer_data'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; - gbp_credit_transfer?: components["schemas"]["source_transaction_gbp_credit_transfer_data"]; + currency: string + gbp_credit_transfer?: components['schemas']['source_transaction_gbp_credit_transfer_data'] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "source_transaction"; - paper_check?: components["schemas"]["source_transaction_paper_check_data"]; - sepa_credit_transfer?: components["schemas"]["source_transaction_sepa_credit_transfer_data"]; + object: 'source_transaction' + paper_check?: components['schemas']['source_transaction_paper_check_data'] + sepa_credit_transfer?: components['schemas']['source_transaction_sepa_credit_transfer_data'] /** @description The ID of the source this transaction is attached to. */ - source: string; + source: string /** @description The status of the transaction, one of `succeeded`, `pending`, or `failed`. */ - status: string; + status: string /** * @description The type of source this transaction is attached to. * @enum {string} */ type: - | "ach_credit_transfer" - | "ach_debit" - | "alipay" - | "bancontact" - | "card" - | "card_present" - | "eps" - | "giropay" - | "ideal" - | "klarna" - | "multibanco" - | "p24" - | "sepa_debit" - | "sofort" - | "three_d_secure" - | "wechat"; - } & { [key: string]: unknown }; + | 'ach_credit_transfer' + | 'ach_debit' + | 'alipay' + | 'bancontact' + | 'card' + | 'card_present' + | 'eps' + | 'giropay' + | 'ideal' + | 'klarna' + | 'multibanco' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'three_d_secure' + | 'wechat' + } & { [key: string]: unknown } /** SourceTransactionAchCreditTransferData */ source_transaction_ach_credit_transfer_data: { /** @description Customer data associated with the transfer. */ - customer_data?: string; + customer_data?: string /** @description Bank account fingerprint associated with the transfer. */ - fingerprint?: string; + fingerprint?: string /** @description Last 4 digits of the account number associated with the transfer. */ - last4?: string; + last4?: string /** @description Routing number associated with the transfer. */ - routing_number?: string; - } & { [key: string]: unknown }; + routing_number?: string + } & { [key: string]: unknown } /** SourceTransactionChfCreditTransferData */ source_transaction_chf_credit_transfer_data: { /** @description Reference associated with the transfer. */ - reference?: string; + reference?: string /** @description Sender's country address. */ - sender_address_country?: string; + sender_address_country?: string /** @description Sender's line 1 address. */ - sender_address_line1?: string; + sender_address_line1?: string /** @description Sender's bank account IBAN. */ - sender_iban?: string; + sender_iban?: string /** @description Sender's name. */ - sender_name?: string; - } & { [key: string]: unknown }; + sender_name?: string + } & { [key: string]: unknown } /** SourceTransactionGbpCreditTransferData */ source_transaction_gbp_credit_transfer_data: { /** @description Bank account fingerprint associated with the Stripe owned bank account receiving the transfer. */ - fingerprint?: string; + fingerprint?: string /** @description 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?: string; + funding_method?: string /** @description Last 4 digits of sender account number associated with the transfer. */ - last4?: string; + last4?: string /** @description Sender entered arbitrary information about the transfer. */ - reference?: string; + reference?: string /** @description Sender account number associated with the transfer. */ - sender_account_number?: string; + sender_account_number?: string /** @description Sender name associated with the transfer. */ - sender_name?: string; + sender_name?: string /** @description Sender sort code associated with the transfer. */ - sender_sort_code?: string; - } & { [key: string]: unknown }; + sender_sort_code?: string + } & { [key: string]: unknown } /** SourceTransactionPaperCheckData */ source_transaction_paper_check_data: { /** @description Time at which the deposited funds will be available for use. Measured in seconds since the Unix epoch. */ - available_at?: string; + available_at?: string /** @description Comma-separated list of invoice IDs associated with the paper check. */ - invoices?: string; - } & { [key: string]: unknown }; + invoices?: string + } & { [key: string]: unknown } /** SourceTransactionSepaCreditTransferData */ source_transaction_sepa_credit_transfer_data: { /** @description Reference associated with the transfer. */ - reference?: string; + reference?: string /** @description Sender's bank account IBAN. */ - sender_iban?: string; + sender_iban?: string /** @description Sender's name. */ - sender_name?: string; - } & { [key: string]: unknown }; + sender_name?: string + } & { [key: string]: unknown } source_type_ach_credit_transfer: { - account_number?: string | null; - bank_name?: string | null; - fingerprint?: string | null; - refund_account_holder_name?: string | null; - refund_account_holder_type?: string | null; - refund_routing_number?: string | null; - routing_number?: string | null; - swift_code?: string | null; - } & { [key: string]: unknown }; + account_number?: string | null + bank_name?: string | null + fingerprint?: string | null + refund_account_holder_name?: string | null + refund_account_holder_type?: string | null + refund_routing_number?: string | null + routing_number?: string | null + swift_code?: string | null + } & { [key: string]: unknown } source_type_ach_debit: { - bank_name?: string | null; - country?: string | null; - fingerprint?: string | null; - last4?: string | null; - routing_number?: string | null; - type?: string | null; - } & { [key: string]: unknown }; + bank_name?: string | null + country?: string | null + fingerprint?: string | null + last4?: string | null + routing_number?: string | null + type?: string | null + } & { [key: string]: unknown } source_type_acss_debit: { - bank_address_city?: string | null; - bank_address_line_1?: string | null; - bank_address_line_2?: string | null; - bank_address_postal_code?: string | null; - bank_name?: string | null; - category?: string | null; - country?: string | null; - fingerprint?: string | null; - last4?: string | null; - routing_number?: string | null; - } & { [key: string]: unknown }; + bank_address_city?: string | null + bank_address_line_1?: string | null + bank_address_line_2?: string | null + bank_address_postal_code?: string | null + bank_name?: string | null + category?: string | null + country?: string | null + fingerprint?: string | null + last4?: string | null + routing_number?: string | null + } & { [key: string]: unknown } source_type_alipay: { - data_string?: string | null; - native_url?: string | null; - statement_descriptor?: string | null; - } & { [key: string]: unknown }; + data_string?: string | null + native_url?: string | null + statement_descriptor?: string | null + } & { [key: string]: unknown } source_type_au_becs_debit: { - bsb_number?: string | null; - fingerprint?: string | null; - last4?: string | null; - } & { [key: string]: unknown }; + bsb_number?: string | null + fingerprint?: string | null + last4?: string | null + } & { [key: string]: unknown } source_type_bancontact: { - bank_code?: string | null; - bank_name?: string | null; - bic?: string | null; - iban_last4?: string | null; - preferred_language?: string | null; - statement_descriptor?: string | null; - } & { [key: string]: unknown }; + bank_code?: string | null + bank_name?: string | null + bic?: string | null + iban_last4?: string | null + preferred_language?: string | null + statement_descriptor?: string | null + } & { [key: string]: unknown } source_type_card: { - address_line1_check?: string | null; - address_zip_check?: string | null; - brand?: string | null; - country?: string | null; - cvc_check?: string | null; - dynamic_last4?: string | null; - exp_month?: number | null; - exp_year?: number | null; - fingerprint?: string; - funding?: string | null; - last4?: string | null; - name?: string | null; - three_d_secure?: string; - tokenization_method?: string | null; - } & { [key: string]: unknown }; + address_line1_check?: string | null + address_zip_check?: string | null + brand?: string | null + country?: string | null + cvc_check?: string | null + dynamic_last4?: string | null + exp_month?: number | null + exp_year?: number | null + fingerprint?: string + funding?: string | null + last4?: string | null + name?: string | null + three_d_secure?: string + tokenization_method?: string | null + } & { [key: string]: unknown } source_type_card_present: { - application_cryptogram?: string; - application_preferred_name?: string; - authorization_code?: string | null; - authorization_response_code?: string; - brand?: string | null; - country?: string | null; - cvm_type?: string; - data_type?: string | null; - dedicated_file_name?: string; - emv_auth_data?: string; - evidence_customer_signature?: string | null; - evidence_transaction_certificate?: string | null; - exp_month?: number | null; - exp_year?: number | null; - fingerprint?: string; - funding?: string | null; - last4?: string | null; - pos_device_id?: string | null; - pos_entry_mode?: string; - read_method?: string | null; - reader?: string | null; - terminal_verification_results?: string; - transaction_status_information?: string; - } & { [key: string]: unknown }; + application_cryptogram?: string + application_preferred_name?: string + authorization_code?: string | null + authorization_response_code?: string + brand?: string | null + country?: string | null + cvm_type?: string + data_type?: string | null + dedicated_file_name?: string + emv_auth_data?: string + evidence_customer_signature?: string | null + evidence_transaction_certificate?: string | null + exp_month?: number | null + exp_year?: number | null + fingerprint?: string + funding?: string | null + last4?: string | null + pos_device_id?: string | null + pos_entry_mode?: string + read_method?: string | null + reader?: string | null + terminal_verification_results?: string + transaction_status_information?: string + } & { [key: string]: unknown } source_type_eps: { - reference?: string | null; - statement_descriptor?: string | null; - } & { [key: string]: unknown }; + reference?: string | null + statement_descriptor?: string | null + } & { [key: string]: unknown } source_type_giropay: { - bank_code?: string | null; - bank_name?: string | null; - bic?: string | null; - statement_descriptor?: string | null; - } & { [key: string]: unknown }; + bank_code?: string | null + bank_name?: string | null + bic?: string | null + statement_descriptor?: string | null + } & { [key: string]: unknown } source_type_ideal: { - bank?: string | null; - bic?: string | null; - iban_last4?: string | null; - statement_descriptor?: string | null; - } & { [key: string]: unknown }; + bank?: string | null + bic?: string | null + iban_last4?: string | null + statement_descriptor?: string | null + } & { [key: string]: unknown } source_type_klarna: { - background_image_url?: string; - client_token?: string | null; - first_name?: string; - last_name?: string; - locale?: string; - logo_url?: string; - page_title?: string; - pay_later_asset_urls_descriptive?: string; - pay_later_asset_urls_standard?: string; - pay_later_name?: string; - pay_later_redirect_url?: string; - pay_now_asset_urls_descriptive?: string; - pay_now_asset_urls_standard?: string; - pay_now_name?: string; - pay_now_redirect_url?: string; - pay_over_time_asset_urls_descriptive?: string; - pay_over_time_asset_urls_standard?: string; - pay_over_time_name?: string; - pay_over_time_redirect_url?: string; - payment_method_categories?: string; - purchase_country?: string; - purchase_type?: string; - redirect_url?: string; - shipping_delay?: number; - shipping_first_name?: string; - shipping_last_name?: string; - } & { [key: string]: unknown }; + background_image_url?: string + client_token?: string | null + first_name?: string + last_name?: string + locale?: string + logo_url?: string + page_title?: string + pay_later_asset_urls_descriptive?: string + pay_later_asset_urls_standard?: string + pay_later_name?: string + pay_later_redirect_url?: string + pay_now_asset_urls_descriptive?: string + pay_now_asset_urls_standard?: string + pay_now_name?: string + pay_now_redirect_url?: string + pay_over_time_asset_urls_descriptive?: string + pay_over_time_asset_urls_standard?: string + pay_over_time_name?: string + pay_over_time_redirect_url?: string + payment_method_categories?: string + purchase_country?: string + purchase_type?: string + redirect_url?: string + shipping_delay?: number + shipping_first_name?: string + shipping_last_name?: string + } & { [key: string]: unknown } source_type_multibanco: { - entity?: string | null; - reference?: string | null; - refund_account_holder_address_city?: string | null; - refund_account_holder_address_country?: string | null; - refund_account_holder_address_line1?: string | null; - refund_account_holder_address_line2?: string | null; - refund_account_holder_address_postal_code?: string | null; - refund_account_holder_address_state?: string | null; - refund_account_holder_name?: string | null; - refund_iban?: string | null; - } & { [key: string]: unknown }; + entity?: string | null + reference?: string | null + refund_account_holder_address_city?: string | null + refund_account_holder_address_country?: string | null + refund_account_holder_address_line1?: string | null + refund_account_holder_address_line2?: string | null + refund_account_holder_address_postal_code?: string | null + refund_account_holder_address_state?: string | null + refund_account_holder_name?: string | null + refund_iban?: string | null + } & { [key: string]: unknown } source_type_p24: { - reference?: string | null; - } & { [key: string]: unknown }; + reference?: string | null + } & { [key: string]: unknown } source_type_sepa_debit: { - bank_code?: string | null; - branch_code?: string | null; - country?: string | null; - fingerprint?: string | null; - last4?: string | null; - mandate_reference?: string | null; - mandate_url?: string | null; - } & { [key: string]: unknown }; + bank_code?: string | null + branch_code?: string | null + country?: string | null + fingerprint?: string | null + last4?: string | null + mandate_reference?: string | null + mandate_url?: string | null + } & { [key: string]: unknown } source_type_sofort: { - bank_code?: string | null; - bank_name?: string | null; - bic?: string | null; - country?: string | null; - iban_last4?: string | null; - preferred_language?: string | null; - statement_descriptor?: string | null; - } & { [key: string]: unknown }; + bank_code?: string | null + bank_name?: string | null + bic?: string | null + country?: string | null + iban_last4?: string | null + preferred_language?: string | null + statement_descriptor?: string | null + } & { [key: string]: unknown } source_type_three_d_secure: { - address_line1_check?: string | null; - address_zip_check?: string | null; - authenticated?: boolean | null; - brand?: string | null; - card?: string | null; - country?: string | null; - customer?: string | null; - cvc_check?: string | null; - dynamic_last4?: string | null; - exp_month?: number | null; - exp_year?: number | null; - fingerprint?: string; - funding?: string | null; - last4?: string | null; - name?: string | null; - three_d_secure?: string; - tokenization_method?: string | null; - } & { [key: string]: unknown }; + address_line1_check?: string | null + address_zip_check?: string | null + authenticated?: boolean | null + brand?: string | null + card?: string | null + country?: string | null + customer?: string | null + cvc_check?: string | null + dynamic_last4?: string | null + exp_month?: number | null + exp_year?: number | null + fingerprint?: string + funding?: string | null + last4?: string | null + name?: string | null + three_d_secure?: string + tokenization_method?: string | null + } & { [key: string]: unknown } source_type_wechat: { - prepay_id?: string; - qr_code_url?: string | null; - statement_descriptor?: string; - } & { [key: string]: unknown }; + prepay_id?: string + qr_code_url?: string | null + statement_descriptor?: string + } & { [key: string]: unknown } /** StatusTransitions */ status_transitions: { /** * Format: unix-time * @description The time that the order was canceled. */ - canceled?: number | null; + canceled?: number | null /** * Format: unix-time * @description The time that the order was fulfilled. */ - fulfiled?: number | null; + fulfiled?: number | null /** * Format: unix-time * @description The time that the order was paid. */ - paid?: number | null; + paid?: number | null /** * Format: unix-time * @description The time that the order was returned. */ - returned?: number | null; - } & { [key: string]: unknown }; + returned?: number | null + } & { [key: string]: unknown } /** * Subscription * @description Subscriptions allow you to charge a customer on a recurring basis. @@ -13846,143 +13411,127 @@ export interface components { */ subscription: { /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. */ - application_fee_percent?: number | null; - automatic_tax: components["schemas"]["subscription_automatic_tax"]; + application_fee_percent?: number | null + automatic_tax: components['schemas']['subscription_automatic_tax'] /** * Format: unix-time * @description Determines the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. */ - billing_cycle_anchor: number; + billing_cycle_anchor: number /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period */ - billing_thresholds?: - | (Partial & { [key: string]: unknown }) - | null; + billing_thresholds?: (Partial & { [key: string]: unknown }) | null /** * Format: unix-time * @description A date in the future at which the subscription will automatically get canceled */ - cancel_at?: number | null; + cancel_at?: number | null /** @description If the subscription has been canceled with the `at_period_end` flag set to `true`, `cancel_at_period_end` on the subscription will be true. You can use this attribute to determine whether a subscription that has a status of active is scheduled to be canceled at the end of the current period. */ - cancel_at_period_end: boolean; + cancel_at_period_end: boolean /** * Format: unix-time * @description 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?: number | null; + canceled_at?: number | null /** * @description 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. * @enum {string} */ - collection_method: "charge_automatically" | "send_invoice"; + collection_method: 'charge_automatically' | 'send_invoice' /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** * Format: unix-time * @description 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: number; + current_period_end: number /** * Format: unix-time * @description Start of the current period that the subscription has been invoiced for. */ - current_period_start: number; + current_period_start: number /** @description ID of the customer who owns the subscription. */ - customer: (Partial & - Partial & - Partial) & { [key: string]: unknown }; + customer: (Partial & Partial & Partial) & { + [key: string]: unknown + } /** @description 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?: number | null; + days_until_due?: number | null /** @description 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?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + default_payment_method?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description 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?: | ((Partial & - Partial & - Partial & - Partial & - Partial & - Partial) & { [key: string]: unknown }) - | null; + Partial & + Partial & + Partial & + Partial & + Partial) & { [key: string]: unknown }) + | null /** @description 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?: components["schemas"]["tax_rate"][] | null; + default_tax_rates?: components['schemas']['tax_rate'][] | null /** @description 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. */ - discount?: (Partial & { [key: string]: unknown }) | null; + discount?: (Partial & { [key: string]: unknown }) | null /** * Format: unix-time * @description If the subscription has ended, the date the subscription ended. */ - ended_at?: number | null; + ended_at?: number | null /** @description Unique identifier for the object. */ - id: string; + id: string /** * SubscriptionItemList * @description List of subscription items, each with an attached price. */ items: { /** @description Details about each object. */ - data: components["schemas"]["subscription_item"][]; + data: components['schemas']['subscription_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; + url: string + } & { [key: string]: unknown } /** @description The most recent invoice this subscription has generated. */ - latest_invoice?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + latest_invoice?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * Format: unix-time * @description 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?: number | null; + next_pending_invoice_item_invoice?: number | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "subscription"; + object: 'subscription' /** @description If specified, payment collection for this subscription will be paused. */ - pause_collection?: - | (Partial & { [key: string]: unknown }) - | null; + pause_collection?: (Partial & { [key: string]: unknown }) | null /** @description Payment settings passed on to invoices created by the subscription. */ - payment_settings?: - | (Partial & { [key: string]: unknown }) - | null; + payment_settings?: (Partial & { [key: string]: unknown }) | null /** @description 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?: - | (Partial & { [key: string]: unknown }) - | null; + | (Partial & { [key: string]: unknown }) + | null /** @description 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?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + pending_setup_intent?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description 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?: - | (Partial & { [key: string]: unknown }) - | null; + pending_update?: (Partial & { [key: string]: unknown }) | null /** @description The schedule attached to the subscription */ - schedule?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + schedule?: ((Partial & Partial) & { [key: string]: unknown }) | null /** * Format: unix-time * @description Date when the subscription was first created. The date might differ from the `created` date due to backdating. */ - start_date: number; + start_date: number /** * @description Possible values are `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `canceled`, or `unpaid`. * @@ -13995,34 +13544,32 @@ export interface components { * If 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. * @enum {string} */ - status: "active" | "canceled" | "incomplete" | "incomplete_expired" | "past_due" | "trialing" | "unpaid"; + status: 'active' | 'canceled' | 'incomplete' | 'incomplete_expired' | 'past_due' | 'trialing' | 'unpaid' /** @description 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?: - | (Partial & { [key: string]: unknown }) - | null; + transfer_data?: (Partial & { [key: string]: unknown }) | null /** * Format: unix-time * @description If the subscription has a trial, the end of that trial. */ - trial_end?: number | null; + trial_end?: number | null /** * Format: unix-time * @description If the subscription has a trial, the beginning of that trial. */ - trial_start?: number | null; - } & { [key: string]: unknown }; + trial_start?: number | null + } & { [key: string]: unknown } /** SubscriptionAutomaticTax */ subscription_automatic_tax: { /** @description Whether Stripe automatically computes tax on this subscription. */ - enabled: boolean; - } & { [key: string]: unknown }; + enabled: boolean + } & { [key: string]: unknown } /** SubscriptionBillingThresholds */ subscription_billing_thresholds: { /** @description Monetary threshold that triggers the subscription to create an invoice */ - amount_gte?: number | null; + amount_gte?: number | null /** @description 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?: boolean | null; - } & { [key: string]: unknown }; + reset_billing_cycle_anchor?: boolean | null + } & { [key: string]: unknown } /** * SubscriptionItem * @description Subscription items allow you to create customer subscriptions with more than @@ -14030,52 +13577,50 @@ export interface components { */ subscription_item: { /** @description Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period */ - billing_thresholds?: - | (Partial & { [key: string]: unknown }) - | null; + billing_thresholds?: (Partial & { [key: string]: unknown }) | null /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Unique identifier for the object. */ - id: string; + id: string /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "subscription_item"; - price: components["schemas"]["price"]; + object: 'subscription_item' + price: components['schemas']['price'] /** @description The [quantity](https://stripe.com/docs/subscriptions/quantities) of the plan to which the customer should be subscribed. */ - quantity?: number; + quantity?: number /** @description The `subscription` this `subscription_item` belongs to. */ - subscription: string; + subscription: string /** @description 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?: components["schemas"]["tax_rate"][] | null; - } & { [key: string]: unknown }; + tax_rates?: components['schemas']['tax_rate'][] | null + } & { [key: string]: unknown } /** SubscriptionItemBillingThresholds */ subscription_item_billing_thresholds: { /** @description Usage threshold that triggers the subscription to create an invoice */ - usage_gte?: number | null; - } & { [key: string]: unknown }; + usage_gte?: number | null + } & { [key: string]: unknown } /** subscription_payment_method_options_card */ subscription_payment_method_options_card: { - mandate_options?: components["schemas"]["invoice_mandate_options_card"]; + mandate_options?: components['schemas']['invoice_mandate_options_card'] /** * @description 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#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. * @enum {string|null} */ - request_three_d_secure?: ("any" | "automatic") | null; - } & { [key: string]: unknown }; + request_three_d_secure?: ('any' | 'automatic') | null + } & { [key: string]: unknown } /** SubscriptionPendingInvoiceItemInterval */ subscription_pending_invoice_item_interval: { /** * @description Specifies invoicing frequency. Either `day`, `week`, `month` or `year`. * @enum {string} */ - interval: "day" | "month" | "week" | "year"; + interval: 'day' | 'month' | 'week' | 'year' /** @description 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: number; - } & { [key: string]: unknown }; + interval_count: number + } & { [key: string]: unknown } /** * SubscriptionSchedule * @description A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes. @@ -14087,217 +13632,195 @@ export interface components { * Format: unix-time * @description Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch. */ - canceled_at?: number | null; + canceled_at?: number | null /** * Format: unix-time * @description Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch. */ - completed_at?: number | null; + completed_at?: number | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Object representing the start and end dates for the current phase of the subscription schedule, if it is `active`. */ - current_phase?: - | (Partial & { [key: string]: unknown }) - | null; + current_phase?: (Partial & { [key: string]: unknown }) | null /** @description ID of the customer who owns the subscription schedule. */ - customer: (Partial & - Partial & - Partial) & { [key: string]: unknown }; - default_settings: components["schemas"]["subscription_schedules_resource_default_settings"]; + customer: (Partial & Partial & Partial) & { + [key: string]: unknown + } + default_settings: components['schemas']['subscription_schedules_resource_default_settings'] /** * @description Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` and `cancel`. * @enum {string} */ - end_behavior: "cancel" | "none" | "release" | "renew"; + end_behavior: 'cancel' | 'none' | 'release' | 'renew' /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "subscription_schedule"; + object: 'subscription_schedule' /** @description Configuration for the subscription schedule's phases. */ - phases: components["schemas"]["subscription_schedule_phase_configuration"][]; + phases: components['schemas']['subscription_schedule_phase_configuration'][] /** * Format: unix-time * @description Time at which the subscription schedule was released. Measured in seconds since the Unix epoch. */ - released_at?: number | null; + released_at?: number | null /** @description ID of the subscription once managed by the subscription schedule (if it is released). */ - released_subscription?: string | null; + released_subscription?: string | null /** * @description 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). * @enum {string} */ - status: "active" | "canceled" | "completed" | "not_started" | "released"; + status: 'active' | 'canceled' | 'completed' | 'not_started' | 'released' /** @description ID of the subscription managed by the subscription schedule. */ - subscription?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; - } & { [key: string]: unknown }; + subscription?: ((Partial & Partial) & { [key: string]: unknown }) | null + } & { [key: string]: unknown } /** * SubscriptionScheduleAddInvoiceItem * @description An Add Invoice Item describes the prices and quantities that will be added as pending invoice items when entering a phase. */ subscription_schedule_add_invoice_item: { /** @description ID of the price used to generate the invoice item. */ - price: (Partial & - Partial & - Partial) & { [key: string]: unknown }; + price: (Partial & Partial & Partial) & { + [key: string]: unknown + } /** @description The quantity of the invoice item. */ - quantity?: number | null; + quantity?: number | null /** @description The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item. */ - tax_rates?: components["schemas"]["tax_rate"][] | null; - } & { [key: string]: unknown }; + tax_rates?: components['schemas']['tax_rate'][] | null + } & { [key: string]: unknown } /** * SubscriptionScheduleConfigurationItem * @description A phase item describes the price and quantity of a phase. */ subscription_schedule_configuration_item: { /** @description Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period */ - billing_thresholds?: - | (Partial & { [key: string]: unknown }) - | null; + billing_thresholds?: (Partial & { [key: string]: unknown }) | null /** @description ID of the price to which the customer should be subscribed. */ - price: (Partial & - Partial & - Partial) & { [key: string]: unknown }; + price: (Partial & Partial & Partial) & { + [key: string]: unknown + } /** @description Quantity of the plan to which the customer should be subscribed. */ - quantity?: number; + quantity?: number /** @description 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?: components["schemas"]["tax_rate"][] | null; - } & { [key: string]: unknown }; + tax_rates?: components['schemas']['tax_rate'][] | null + } & { [key: string]: unknown } /** SubscriptionScheduleCurrentPhase */ subscription_schedule_current_phase: { /** * Format: unix-time * @description The end of this phase of the subscription schedule. */ - end_date: number; + end_date: number /** * Format: unix-time * @description The start of this phase of the subscription schedule. */ - start_date: number; - } & { [key: string]: unknown }; + start_date: number + } & { [key: string]: unknown } /** * SubscriptionSchedulePhaseConfiguration * @description A phase describes the plans, coupon, and trialing status of a subscription for a predefined time period. */ subscription_schedule_phase_configuration: { /** @description A list of prices and quantities that will generate invoice items appended to the first invoice for this phase. */ - add_invoice_items: components["schemas"]["subscription_schedule_add_invoice_item"][]; + add_invoice_items: components['schemas']['subscription_schedule_add_invoice_item'][] /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account during this phase of the schedule. */ - application_fee_percent?: number | null; - automatic_tax?: components["schemas"]["schedules_phase_automatic_tax"]; + application_fee_percent?: number | null + automatic_tax?: components['schemas']['schedules_phase_automatic_tax'] /** * @description 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). * @enum {string|null} */ - billing_cycle_anchor?: ("automatic" | "phase_start") | null; + billing_cycle_anchor?: ('automatic' | 'phase_start') | null /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period */ - billing_thresholds?: - | (Partial & { [key: string]: unknown }) - | null; + billing_thresholds?: (Partial & { [key: string]: unknown }) | null /** * @description 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. * @enum {string|null} */ - collection_method?: ("charge_automatically" | "send_invoice") | null; + collection_method?: ('charge_automatically' | 'send_invoice') | null /** @description ID of the coupon to use during this phase of the subscription schedule. */ coupon?: - | ((Partial & - Partial & - Partial) & { [key: string]: unknown }) - | null; + | ((Partial & Partial & Partial) & { + [key: string]: unknown + }) + | null /** @description 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?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + default_payment_method?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description The default tax rates to apply to the subscription during this phase of the subscription schedule. */ - default_tax_rates?: components["schemas"]["tax_rate"][] | null; + default_tax_rates?: components['schemas']['tax_rate'][] | null /** * Format: unix-time * @description The end of this phase of the subscription schedule. */ - end_date: number; + end_date: number /** @description The invoice settings applicable during this phase. */ - invoice_settings?: - | (Partial & { [key: string]: unknown }) - | null; + invoice_settings?: (Partial & { [key: string]: unknown }) | null /** @description Subscription items to configure the subscription to during this phase of the subscription schedule. */ - items: components["schemas"]["subscription_schedule_configuration_item"][]; + items: components['schemas']['subscription_schedule_configuration_item'][] /** * @description If the subscription schedule will prorate when transitioning to this phase. Possible values are `create_prorations` and `none`. * @enum {string} */ - proration_behavior: "always_invoice" | "create_prorations" | "none"; + proration_behavior: 'always_invoice' | 'create_prorations' | 'none' /** * Format: unix-time * @description The start of this phase of the subscription schedule. */ - start_date: number; + start_date: number /** @description 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?: - | (Partial & { [key: string]: unknown }) - | null; + transfer_data?: (Partial & { [key: string]: unknown }) | null /** * Format: unix-time * @description When the trial ends within the phase. */ - trial_end?: number | null; - } & { [key: string]: unknown }; + trial_end?: number | null + } & { [key: string]: unknown } /** SubscriptionSchedulesResourceDefaultSettings */ subscription_schedules_resource_default_settings: { /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account during this phase of the schedule. */ - application_fee_percent?: number | null; - automatic_tax?: components["schemas"]["subscription_schedules_resource_default_settings_automatic_tax"]; + application_fee_percent?: number | null + automatic_tax?: components['schemas']['subscription_schedules_resource_default_settings_automatic_tax'] /** * @description 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). * @enum {string} */ - billing_cycle_anchor: "automatic" | "phase_start"; + billing_cycle_anchor: 'automatic' | 'phase_start' /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period */ - billing_thresholds?: - | (Partial & { [key: string]: unknown }) - | null; + billing_thresholds?: (Partial & { [key: string]: unknown }) | null /** * @description 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. * @enum {string|null} */ - collection_method?: ("charge_automatically" | "send_invoice") | null; + collection_method?: ('charge_automatically' | 'send_invoice') | null /** @description 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?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + default_payment_method?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description The subscription schedule's default invoice settings. */ - invoice_settings?: - | (Partial & { [key: string]: unknown }) - | null; + invoice_settings?: (Partial & { [key: string]: unknown }) | null /** @description 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?: - | (Partial & { [key: string]: unknown }) - | null; - } & { [key: string]: unknown }; + transfer_data?: (Partial & { [key: string]: unknown }) | null + } & { [key: string]: unknown } /** SubscriptionSchedulesResourceDefaultSettingsAutomaticTax */ subscription_schedules_resource_default_settings_automatic_tax: { /** @description Whether Stripe automatically computes tax on invoices created during this phase. */ - enabled: boolean; - } & { [key: string]: unknown }; + enabled: boolean + } & { [key: string]: unknown } /** SubscriptionTransferData */ subscription_transfer_data: { /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the destination account. By default, the entire amount is transferred to the destination. */ - amount_percent?: number | null; + amount_percent?: number | null /** @description The account where funds from the payment will be transferred to upon payment success. */ - destination: (Partial & Partial) & { [key: string]: unknown }; - } & { [key: string]: unknown }; + destination: (Partial & Partial) & { [key: string]: unknown } + } & { [key: string]: unknown } /** * SubscriptionsResourcePauseCollection * @description The Pause Collection settings determine how we will pause collection for this subscription and for how long the subscription @@ -14308,55 +13831,47 @@ export interface components { * @description The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`. * @enum {string} */ - behavior: "keep_as_draft" | "mark_uncollectible" | "void"; + behavior: 'keep_as_draft' | 'mark_uncollectible' | 'void' /** * Format: unix-time * @description The time after which the subscription will resume collecting payments. */ - resumes_at?: number | null; - } & { [key: string]: unknown }; + resumes_at?: number | null + } & { [key: string]: unknown } /** SubscriptionsResourcePaymentMethodOptions */ subscriptions_resource_payment_method_options: { /** @description This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to invoices created by the subscription. */ - acss_debit?: - | (Partial & { [key: string]: unknown }) - | null; + acss_debit?: (Partial & { [key: string]: unknown }) | null /** @description This sub-hash contains details about the Bancontact payment method options to pass to invoices created by the subscription. */ - bancontact?: - | (Partial & { [key: string]: unknown }) - | null; + bancontact?: (Partial & { [key: string]: unknown }) | null /** @description This sub-hash contains details about the Card payment method options to pass to invoices created by the subscription. */ - card?: - | (Partial & { [key: string]: unknown }) - | null; - } & { [key: string]: unknown }; + card?: (Partial & { [key: string]: unknown }) | null + } & { [key: string]: unknown } /** SubscriptionsResourcePaymentSettings */ subscriptions_resource_payment_settings: { /** @description Payment-method-specific configuration to provide to invoices created by the subscription. */ - payment_method_options?: - | (Partial & { [key: string]: unknown }) - | null; + payment_method_options?: (Partial & { [key: string]: unknown }) | null /** @description 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?: | ( - | "ach_credit_transfer" - | "ach_debit" - | "acss_debit" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "sepa_debit" - | "sofort" - | "wechat_pay" + | 'ach_credit_transfer' + | 'ach_debit' + | 'acss_debit' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' )[] - | null; - } & { [key: string]: unknown }; + | null + } & { [key: string]: unknown } /** * SubscriptionsResourcePendingUpdate * @description Pending Updates store the changes pending from a previous update that will be applied @@ -14367,61 +13882,61 @@ export interface components { * Format: unix-time * @description 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. */ - billing_cycle_anchor?: number | null; + billing_cycle_anchor?: number | null /** * Format: unix-time * @description The point after which the changes reflected by this update will be discarded and no longer applied. */ - expires_at: number; + expires_at: number /** @description List of subscription items, each with an attached plan, that will be set if the update is applied. */ - subscription_items?: components["schemas"]["subscription_item"][] | null; + subscription_items?: components['schemas']['subscription_item'][] | null /** * Format: unix-time * @description 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?: number | null; + trial_end?: number | null /** @description 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?: boolean | null; - } & { [key: string]: unknown }; + trial_from_plan?: boolean | null + } & { [key: string]: unknown } /** * TaxProductResourceTaxCode * @description [Tax codes](https://stripe.com/docs/tax/tax-codes) classify goods and services for tax purposes. */ tax_code: { /** @description A detailed description of which types of products the tax code represents. */ - description: string; + description: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description A short name for the tax code. */ - name: string; + name: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "tax_code"; - } & { [key: string]: unknown }; + object: 'tax_code' + } & { [key: string]: unknown } /** TaxDeductedAtSource */ tax_deducted_at_source: { /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "tax_deducted_at_source"; + object: 'tax_deducted_at_source' /** * Format: unix-time * @description The end of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period. */ - period_end: number; + period_end: number /** * Format: unix-time * @description The start of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period. */ - period_start: number; + period_start: number /** @description The TAN that was supplied to Stripe when TDS was assessed */ - tax_deduction_account_number: string; - } & { [key: string]: unknown }; + tax_deduction_account_number: string + } & { [key: string]: unknown } /** * tax_id * @description You can add one or multiple tax IDs to a [customer](https://stripe.com/docs/api/customers). @@ -14431,88 +13946,88 @@ export interface components { */ tax_id: { /** @description Two-letter ISO code representing the country of the tax ID. */ - country?: string | null; + country?: string | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description ID of the customer. */ - customer?: ((Partial & Partial) & { [key: string]: unknown }) | null; + customer?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "tax_id"; + object: 'tax_id' /** * @description Type of the tax ID, one of `ae_trn`, `au_abn`, `au_arn`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `es_cif`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `th_vat`, `tw_vat`, `ua_vat`, `us_ein`, or `za_vat`. Note that some legacy tax IDs have type `unknown` * @enum {string} */ type: - | "ae_trn" - | "au_abn" - | "au_arn" - | "br_cnpj" - | "br_cpf" - | "ca_bn" - | "ca_gst_hst" - | "ca_pst_bc" - | "ca_pst_mb" - | "ca_pst_sk" - | "ca_qst" - | "ch_vat" - | "cl_tin" - | "es_cif" - | "eu_vat" - | "gb_vat" - | "ge_vat" - | "hk_br" - | "id_npwp" - | "il_vat" - | "in_gst" - | "is_vat" - | "jp_cn" - | "jp_rn" - | "kr_brn" - | "li_uid" - | "mx_rfc" - | "my_frp" - | "my_itn" - | "my_sst" - | "no_vat" - | "nz_gst" - | "ru_inn" - | "ru_kpp" - | "sa_vat" - | "sg_gst" - | "sg_uen" - | "th_vat" - | "tw_vat" - | "ua_vat" - | "unknown" - | "us_ein" - | "za_vat"; + | 'ae_trn' + | 'au_abn' + | 'au_arn' + | 'br_cnpj' + | 'br_cpf' + | 'ca_bn' + | 'ca_gst_hst' + | 'ca_pst_bc' + | 'ca_pst_mb' + | 'ca_pst_sk' + | 'ca_qst' + | 'ch_vat' + | 'cl_tin' + | 'es_cif' + | 'eu_vat' + | 'gb_vat' + | 'ge_vat' + | 'hk_br' + | 'id_npwp' + | 'il_vat' + | 'in_gst' + | 'is_vat' + | 'jp_cn' + | 'jp_rn' + | 'kr_brn' + | 'li_uid' + | 'mx_rfc' + | 'my_frp' + | 'my_itn' + | 'my_sst' + | 'no_vat' + | 'nz_gst' + | 'ru_inn' + | 'ru_kpp' + | 'sa_vat' + | 'sg_gst' + | 'sg_uen' + | 'th_vat' + | 'tw_vat' + | 'ua_vat' + | 'unknown' + | 'us_ein' + | 'za_vat' /** @description Value of the tax ID. */ - value: string; + value: string /** @description Tax ID verification information. */ - verification?: (Partial & { [key: string]: unknown }) | null; - } & { [key: string]: unknown }; + verification?: (Partial & { [key: string]: unknown }) | null + } & { [key: string]: unknown } /** tax_id_verification */ tax_id_verification: { /** * @description Verification status, one of `pending`, `verified`, `unverified`, or `unavailable`. * @enum {string} */ - status: "pending" | "unavailable" | "unverified" | "verified"; + status: 'pending' | 'unavailable' | 'unverified' | 'verified' /** @description Verified address. */ - verified_address?: string | null; + verified_address?: string | null /** @description Verified name. */ - verified_name?: string | null; - } & { [key: string]: unknown }; + verified_name?: string | null + } & { [key: string]: unknown } /** * TaxRate * @description Tax rates can be applied to [invoices](https://stripe.com/docs/billing/invoices/tax-rates), [subscriptions](https://stripe.com/docs/billing/subscriptions/taxes) and [Checkout Sessions](https://stripe.com/docs/payments/checkout/set-up-a-subscription#tax-rates) to collect tax. @@ -14521,120 +14036,118 @@ export interface components { */ tax_rate: { /** @description 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: boolean; + active: boolean /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ - country?: string | null; + country?: string | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. */ - description?: string | null; + description?: string | null /** @description 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: string; + display_name: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description This specifies if the tax rate is inclusive or exclusive. */ - inclusive: boolean; + inclusive: boolean /** @description 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?: string | null; + jurisdiction?: string | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "tax_rate"; + object: 'tax_rate' /** @description This represents the tax rate percent out of 100. */ - percentage: number; + percentage: number /** @description [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States. */ - state?: string | null; + state?: string | null /** * @description The high-level tax type, such as `vat` or `sales_tax`. * @enum {string|null} */ - tax_type?: ("gst" | "hst" | "jct" | "pst" | "qst" | "rst" | "sales_tax" | "vat") | null; - } & { [key: string]: unknown }; + tax_type?: ('gst' | 'hst' | 'jct' | 'pst' | 'qst' | 'rst' | 'sales_tax' | 'vat') | null + } & { [key: string]: unknown } /** * TerminalConnectionToken * @description A Connection Token is used by the Stripe Terminal SDK to connect to a reader. * * Related guide: [Fleet Management](https://stripe.com/docs/terminal/fleet/locations). */ - "terminal.connection_token": { + 'terminal.connection_token': { /** @description 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://stripe.com/docs/terminal/fleet/locations#connection-tokens). */ - location?: string; + location?: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "terminal.connection_token"; + object: 'terminal.connection_token' /** @description Your application should pass this token to the Stripe Terminal SDK. */ - secret: string; - } & { [key: string]: unknown }; + secret: string + } & { [key: string]: unknown } /** * TerminalLocationLocation * @description A Location represents a grouping of readers. * * Related guide: [Fleet Management](https://stripe.com/docs/terminal/fleet/locations). */ - "terminal.location": { - address: components["schemas"]["address"]; + 'terminal.location': { + address: components['schemas']['address'] /** @description The display name of the location. */ - display_name: string; + display_name: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "terminal.location"; - } & { [key: string]: unknown }; + object: 'terminal.location' + } & { [key: string]: unknown } /** * TerminalReaderReader * @description A Reader represents a physical device for accepting payment details. * * Related guide: [Connecting to a Reader](https://stripe.com/docs/terminal/payments/connect-reader). */ - "terminal.reader": { + 'terminal.reader': { /** @description The current software version of the reader. */ - device_sw_version?: string | null; + device_sw_version?: string | null /** * @description Type of reader, one of `bbpos_chipper2x`, `bbpos_wisepos_e`, or `verifone_P400`. * @enum {string} */ - device_type: "bbpos_chipper2x" | "bbpos_wisepos_e" | "verifone_P400"; + device_type: 'bbpos_chipper2x' | 'bbpos_wisepos_e' | 'verifone_P400' /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The local IP address of the reader. */ - ip_address?: string | null; + ip_address?: string | null /** @description Custom label given to the reader for easier identification. */ - label: string; + label: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description The location identifier of the reader. */ - location?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + location?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "terminal.reader"; + object: 'terminal.reader' /** @description Serial number of the reader. */ - serial_number: string; + serial_number: string /** @description The networking status of the reader. */ - status?: string | null; - } & { [key: string]: unknown }; + status?: string | null + } & { [key: string]: unknown } /** * ThreeDSecure * @description Cardholder authentication via 3D Secure is initiated by creating a `3D Secure` @@ -14643,31 +14156,31 @@ export interface components { */ three_d_secure: { /** @description Amount of the charge that you will create when authentication completes. */ - amount: number; + amount: number /** @description True if the cardholder went through the authentication flow and their bank indicated that authentication succeeded. */ - authenticated: boolean; - card: components["schemas"]["card"]; + authenticated: boolean + card: components['schemas']['card'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "three_d_secure"; + object: 'three_d_secure' /** @description If present, this is the URL that you should send the cardholder to for authentication. If you are going to use Stripe.js to display the authentication page in an iframe, you should use the value "_callback". */ - redirect_url?: string | null; + redirect_url?: string | null /** @description Possible values are `redirect_pending`, `succeeded`, or `failed`. When the cardholder can be authenticated, the object starts with status `redirect_pending`. When liability will be shifted to the cardholder's bank (either because the cardholder was successfully authenticated, or because the bank has not implemented 3D Secure, the object wlil be in status `succeeded`. `failed` indicates that authentication was attempted unsuccessfully. */ - status: string; - } & { [key: string]: unknown }; + status: string + } & { [key: string]: unknown } /** three_d_secure_details */ three_d_secure_details: { /** @@ -14675,39 +14188,29 @@ export interface components { * the issuing bank. * @enum {string|null} */ - authentication_flow?: ("challenge" | "frictionless") | null; + authentication_flow?: ('challenge' | 'frictionless') | null /** * @description Indicates the outcome of 3D Secure authentication. * @enum {string|null} */ - result?: ("attempt_acknowledged" | "authenticated" | "failed" | "not_supported" | "processing_error") | null; + result?: ('attempt_acknowledged' | 'authenticated' | 'failed' | 'not_supported' | 'processing_error') | null /** * @description Additional information about why 3D Secure succeeded or failed based * on the `result`. * @enum {string|null} */ - result_reason?: - | ( - | "abandoned" - | "bypassed" - | "canceled" - | "card_not_enrolled" - | "network_not_supported" - | "protocol_error" - | "rejected" - ) - | null; + result_reason?: ('abandoned' | 'bypassed' | 'canceled' | 'card_not_enrolled' | 'network_not_supported' | 'protocol_error' | 'rejected') | null /** * @description The version of 3D Secure that was used. * @enum {string|null} */ - version?: ("1.0.2" | "2.1.0" | "2.2.0") | null; - } & { [key: string]: unknown }; + version?: ('1.0.2' | '2.1.0' | '2.2.0') | null + } & { [key: string]: unknown } /** three_d_secure_usage */ three_d_secure_usage: { /** @description Whether 3D Secure is supported on this card. */ - supported: boolean; - } & { [key: string]: unknown }; + supported: boolean + } & { [key: string]: unknown } /** * Token * @description Tokenization is the process Stripe uses to collect sensitive card or bank @@ -14734,29 +14237,29 @@ export interface components { * Related guide: [Accept a payment](https://stripe.com/docs/payments/accept-a-payment-charges#web-create-token) */ token: { - bank_account?: components["schemas"]["bank_account"]; - card?: components["schemas"]["card"]; + bank_account?: components['schemas']['bank_account'] + card?: components['schemas']['card'] /** @description IP address of the client that generated the token. */ - client_ip?: string | null; + client_ip?: string | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "token"; + object: 'token' /** @description Type of the token: `account`, `bank_account`, `card`, or `pii`. */ - type: string; + type: string /** @description Whether this token has already been used (tokens can be used only once). */ - used: boolean; - } & { [key: string]: unknown }; + used: boolean + } & { [key: string]: unknown } /** * Topup * @description To top up your Stripe balance, you create a top-up object. You can retrieve @@ -14767,48 +14270,46 @@ export interface components { */ topup: { /** @description Amount transferred. */ - amount: number; + amount: number /** @description 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?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + balance_transaction?: ((Partial & Partial) & { [key: string]: unknown }) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description 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?: number | null; + expected_availability_date?: number | null /** @description 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?: string | null; + failure_code?: string | null /** @description Message to user further explaining reason for top-up failure if available. */ - failure_message?: string | null; + failure_message?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "topup"; - source: components["schemas"]["source"]; + object: 'topup' + source: components['schemas']['source'] /** @description Extra information about a top-up. This will appear on your source's bank statement. It must contain at least one letter. */ - statement_descriptor?: string | null; + statement_descriptor?: string | null /** * @description The status of the top-up is either `canceled`, `failed`, `pending`, `reversed`, or `succeeded`. * @enum {string} */ - status: "canceled" | "failed" | "pending" | "reversed" | "succeeded"; + status: 'canceled' | 'failed' | 'pending' | 'reversed' | 'succeeded' /** @description A string that identifies this top-up as part of a group. */ - transfer_group?: string | null; - } & { [key: string]: unknown }; + transfer_group?: string | null + } & { [key: string]: unknown } /** * Transfer * @description A `Transfer` object is created when you move funds between Stripe accounts as @@ -14824,76 +14325,72 @@ export interface components { */ transfer: { /** @description Amount in %s to be transferred. */ - amount: number; + amount: number /** @description Amount in %s reversed (can be less than the amount attribute on the transfer if a partial reversal was issued). */ - amount_reversed: number; + amount_reversed: number /** @description Balance transaction that describes the impact of this transfer on your account balance. */ - balance_transaction?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + balance_transaction?: ((Partial & Partial) & { [key: string]: unknown }) | null /** * Format: unix-time * @description Time that this record of the transfer was first created. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description ID of the Stripe account the transfer was sent to. */ - destination?: ((Partial & Partial) & { [key: string]: unknown }) | null; + destination?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description 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?: (Partial & Partial) & { [key: string]: unknown }; + destination_payment?: (Partial & Partial) & { [key: string]: unknown } /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "transfer"; + object: 'transfer' /** * TransferReversalList * @description A list of reversals that have been applied to the transfer. */ reversals: { /** @description Details about each object. */ - data: components["schemas"]["transfer_reversal"][]; + data: components['schemas']['transfer_reversal'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; + url: string + } & { [key: string]: unknown } /** @description Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false. */ - reversed: boolean; + reversed: boolean /** @description ID of the charge or payment that was used to fund the transfer. If null, the transfer was funded from the available balance. */ - source_transaction?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + source_transaction?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description The source balance this transfer came from. One of `card`, `fpx`, or `bank_account`. */ - source_type?: string | null; + source_type?: string | null /** @description A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-options) for details. */ - transfer_group?: string | null; - } & { [key: string]: unknown }; + transfer_group?: string | null + } & { [key: string]: unknown } /** transfer_data */ transfer_data: { /** @description 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?: number; + amount?: number /** * @description The account (if any) the payment will be attributed to for tax * reporting, and where funds from the payment will be transferred to upon * payment success. */ - destination: (Partial & Partial) & { [key: string]: unknown }; - } & { [key: string]: unknown }; + destination: (Partial & Partial) & { [key: string]: unknown } + } & { [key: string]: unknown } /** * TransferReversal * @description [Stripe Connect](https://stripe.com/docs/connect) platforms can reverse transfers made to a @@ -14912,69 +14409,63 @@ export interface components { */ transfer_reversal: { /** @description Amount, in %s. */ - amount: number; + amount: number /** @description Balance transaction that describes the impact on your account balance. */ - balance_transaction?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + balance_transaction?: ((Partial & Partial) & { [key: string]: unknown }) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Linked payment refund for the transfer reversal. */ - destination_payment_refund?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + destination_payment_refund?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "transfer_reversal"; + object: 'transfer_reversal' /** @description ID of the refund responsible for the transfer reversal. */ - source_refund?: - | ((Partial & Partial) & { [key: string]: unknown }) - | null; + source_refund?: ((Partial & Partial) & { [key: string]: unknown }) | null /** @description ID of the transfer that was reversed. */ - transfer: (Partial & Partial) & { [key: string]: unknown }; - } & { [key: string]: unknown }; + transfer: (Partial & Partial) & { [key: string]: unknown } + } & { [key: string]: unknown } /** TransferSchedule */ transfer_schedule: { /** @description The number of days charges for the account will be held before being paid out. */ - delay_days: number; + delay_days: number /** @description How frequently funds will be paid out. One of `manual` (payouts only created via API call), `daily`, `weekly`, or `monthly`. */ - interval: string; + interval: string /** @description 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?: number; + monthly_anchor?: number /** @description The day of the week funds will be paid out, of the style 'monday', 'tuesday', etc. Only shown if `interval` is weekly. */ - weekly_anchor?: string; - } & { [key: string]: unknown }; + weekly_anchor?: string + } & { [key: string]: unknown } /** TransformQuantity */ transform_quantity: { /** @description Divide usage by this number. */ - divide_by: number; + divide_by: number /** * @description After division, either round the result `up` or `down`. * @enum {string} */ - round: "down" | "up"; - } & { [key: string]: unknown }; + round: 'down' | 'up' + } & { [key: string]: unknown } /** TransformUsage */ transform_usage: { /** @description Divide usage by this number. */ - divide_by: number; + divide_by: number /** * @description After division, either round the result `up` or `down`. * @enum {string} */ - round: "down" | "up"; - } & { [key: string]: unknown }; + round: 'down' | 'up' + } & { [key: string]: unknown } /** * UsageRecord * @description Usage records allow you to report customer usage and metrics to Stripe for @@ -14984,51 +14475,51 @@ export interface components { */ usage_record: { /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "usage_record"; + object: 'usage_record' /** @description The usage quantity for the specified date. */ - quantity: number; + quantity: number /** @description The ID of the subscription item this usage record contains data for. */ - subscription_item: string; + subscription_item: string /** * Format: unix-time * @description The timestamp when this usage occurred. */ - timestamp: number; - } & { [key: string]: unknown }; + timestamp: number + } & { [key: string]: unknown } /** UsageRecordSummary */ usage_record_summary: { /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The invoice in which this usage period has been billed for. */ - invoice?: string | null; + invoice?: string | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "usage_record_summary"; - period: components["schemas"]["period"]; + object: 'usage_record_summary' + period: components['schemas']['period'] /** @description The ID of the subscription item this summary is describing. */ - subscription_item: string; + subscription_item: string /** @description The total usage within this usage period. */ - total_usage: number; - } & { [key: string]: unknown }; + total_usage: number + } & { [key: string]: unknown } /** verification_session_redaction */ verification_session_redaction: { /** * @description Indicates whether this object and its related objects have been redacted or not. * @enum {string} */ - status: "processing" | "redacted"; - } & { [key: string]: unknown }; + status: 'processing' | 'redacted' + } & { [key: string]: unknown } /** * NotificationWebhookEndpoint * @description You can configure [webhook endpoints](https://stripe.com/docs/webhooks/) via the API to be @@ -15041,37 +14532,37 @@ export interface components { */ webhook_endpoint: { /** @description The API version events are rendered as for this webhook endpoint. */ - api_version?: string | null; + api_version?: string | null /** @description The ID of the associated Connect application. */ - application?: string | null; + application?: string | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description An optional description of what the webhook is used for. */ - description?: string | null; + description?: string | null /** @description The list of events to enable for this endpoint. `['*']` indicates that all events are enabled, except those that require explicit selection. */ - enabled_events: string[]; + enabled_events: string[] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "webhook_endpoint"; + object: 'webhook_endpoint' /** @description The endpoint's secret, used to generate [webhook signatures](https://stripe.com/docs/webhooks/signatures). Only returned at creation. */ - secret?: string; + secret?: string /** @description The status of the webhook. It can be `enabled` or `disabled`. */ - status: string; + status: string /** @description The URL of the webhook endpoint. */ - url: string; - } & { [key: string]: unknown }; - }; + url: string + } & { [key: string]: unknown } + } } export interface operations { @@ -15081,94 +14572,94 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["three_d_secure"]; - }; - }; + 'application/json': components['schemas']['three_d_secure'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Amount of the charge that you will create when authentication completes. */ - amount: number; + amount: number /** @description The ID of a card token, or the ID of a card belonging to the given customer. */ - card?: string; + card?: string /** @description 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: string; + currency: string /** @description The customer associated with this 3D secure authentication. */ - customer?: string; + customer?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The URL that the cardholder's browser will be returned to when authentication completes. */ - return_url: string; - }; - }; - }; - }; + return_url: string + } + } + } + } /**

Retrieves a 3D Secure object.

*/ Get3dSecureThreeDSecure: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - three_d_secure: string; - }; - }; + three_d_secure: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["three_d_secure"]; - }; - }; + 'application/json': components['schemas']['three_d_secure'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves the details of an account.

*/ GetAccount: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["account"]; - }; - }; + 'application/json': components['schemas']['account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged. Most parameters can be changed only for Custom accounts. (These are marked Custom Only below.) Parameters marked Custom and Express are not supported for Standard accounts.

* @@ -15179,65 +14670,65 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["account"]; - }; - }; + 'application/json': components['schemas']['account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account. */ - account_token?: string; + account_token?: string /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ bank_account?: (Partial< { - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; + account_holder_type?: 'company' | 'individual' + account_number: string /** @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; - country: string; - currency?: string; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' + country: string + currency?: string /** @enum {string} */ - object?: "bank_account"; - routing_number?: string; + object?: 'bank_account' + routing_number?: string } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** * business_profile_specs * @description Business information about the account. */ business_profile?: { - mcc?: string; - name?: string; - product_description?: string; + mcc?: string + name?: string + product_description?: string /** address_specs */ support_address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - } & { [key: string]: unknown }; - support_email?: string; - support_phone?: string; - support_url?: (Partial & Partial<"">) & { [key: string]: unknown }; - url?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } & { [key: string]: unknown } + support_email?: string + support_phone?: string + support_url?: (Partial & Partial<''>) & { [key: string]: unknown } + url?: string + } & { [key: string]: unknown } /** * @description The business type. * @enum {string} */ - business_type?: "company" | "government_entity" | "individual" | "non_profit"; + business_type?: 'company' | 'government_entity' | 'individual' | 'non_profit' /** * capabilities_param * @description Each key of the dictionary represents a capability, and each capability maps to its settings (e.g. whether it has been requested or not). Each capability will be inactive until you have provided its specific requirements and Stripe has verified them. An account may have some of its requested capabilities be active and some be inactive. @@ -15245,101 +14736,101 @@ export interface operations { capabilities?: { /** capability_param */ acss_debit_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ afterpay_clearpay_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ au_becs_debit_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ bacs_debit_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ bancontact_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ boleto_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ card_issuing?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ card_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ cartes_bancaires_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ eps_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ fpx_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ giropay_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ grabpay_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ ideal_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ jcb_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ klarna_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ legacy_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ oxxo_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ p24_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ sepa_debit_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ sofort_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ tax_reporting_us_1099_k?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ tax_reporting_us_1099_misc?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ transfers?: { - requested?: boolean; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** * company_specs * @description Information about the company or business. This field is available for any `business_type`. @@ -15347,85 +14838,85 @@ export interface operations { company?: { /** address_specs */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } & { [key: string]: unknown } /** japan_address_kana_specs */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } & { [key: string]: unknown } /** japan_address_kanji_specs */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - } & { [key: string]: unknown }; - directors_provided?: boolean; - executives_provided?: boolean; - name?: string; - name_kana?: string; - name_kanji?: string; - owners_provided?: boolean; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } & { [key: string]: unknown } + directors_provided?: boolean + executives_provided?: boolean + name?: string + name_kana?: string + name_kanji?: string + owners_provided?: boolean /** company_ownership_declaration */ ownership_declaration?: { /** Format: unix-time */ - date?: number; - ip?: string; - user_agent?: string; - } & { [key: string]: unknown }; - phone?: string; - registration_number?: string; + date?: number + ip?: string + user_agent?: string + } & { [key: string]: unknown } + phone?: string + registration_number?: string /** @enum {string} */ structure?: - | "" - | "free_zone_establishment" - | "free_zone_llc" - | "government_instrumentality" - | "governmental_unit" - | "incorporated_non_profit" - | "limited_liability_partnership" - | "llc" - | "multi_member_llc" - | "private_company" - | "private_corporation" - | "private_partnership" - | "public_company" - | "public_corporation" - | "public_partnership" - | "single_member_llc" - | "sole_establishment" - | "sole_proprietorship" - | "tax_exempt_government_instrumentality" - | "unincorporated_association" - | "unincorporated_non_profit"; - tax_id?: string; - tax_id_registrar?: string; - vat_id?: string; + | '' + | 'free_zone_establishment' + | 'free_zone_llc' + | 'government_instrumentality' + | 'governmental_unit' + | 'incorporated_non_profit' + | 'limited_liability_partnership' + | 'llc' + | 'multi_member_llc' + | 'private_company' + | 'private_corporation' + | 'private_partnership' + | 'public_company' + | 'public_corporation' + | 'public_partnership' + | 'single_member_llc' + | 'sole_establishment' + | 'sole_proprietorship' + | 'tax_exempt_government_instrumentality' + | 'unincorporated_association' + | 'unincorporated_non_profit' + tax_id?: string + tax_id_registrar?: string + vat_id?: string /** verification_specs */ verification?: { /** verification_document_specs */ document?: { - back?: string; - front?: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + back?: string + front?: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** @description 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?: string; + default_currency?: string /** * documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -15433,39 +14924,39 @@ export interface operations { documents?: { /** documents_param */ bank_account_ownership_verification?: { - files?: string[]; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } /** documents_param */ company_license?: { - files?: string[]; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } /** documents_param */ company_memorandum_of_association?: { - files?: string[]; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } /** documents_param */ company_ministerial_decree?: { - files?: string[]; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } /** documents_param */ company_registration_verification?: { - files?: string[]; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } /** documents_param */ company_tax_id_verification?: { - files?: string[]; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } /** documents_param */ proof_of_registration?: { - files?: string[]; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** @description The email address of the account holder. This is only to make the account easier to identify to you. Stripe only emails Custom accounts with your consent. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A card or bank account to attach to the account for receiving [payouts](https://stripe.com/docs/connect/bank-debit-card-payouts) (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://stripe.com/docs/api#account_create_bank_account) creation.

By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the bank account or card creation API. */ - external_account?: string; + external_account?: string /** * individual_specs * @description Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. @@ -15473,73 +14964,73 @@ export interface operations { individual?: { /** address_specs */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } & { [key: string]: unknown } /** japan_address_kana_specs */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } & { [key: string]: unknown } /** japan_address_kanji_specs */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } & { [key: string]: unknown } dob?: (Partial< { - day: number; - month: number; - year: number; + day: number + month: number + year: number } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - email?: string; - first_name?: string; - first_name_kana?: string; - first_name_kanji?: string; - full_name_aliases?: (Partial & Partial<"">) & { [key: string]: unknown }; - gender?: string; - id_number?: string; - last_name?: string; - last_name_kana?: string; - last_name_kanji?: string; - maiden_name?: string; - metadata?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; - phone?: string; + Partial<''>) & { [key: string]: unknown } + email?: string + first_name?: string + first_name_kana?: string + first_name_kanji?: string + full_name_aliases?: (Partial & Partial<''>) & { [key: string]: unknown } + gender?: string + id_number?: string + last_name?: string + last_name_kana?: string + last_name_kanji?: string + maiden_name?: string + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } + phone?: string /** @enum {string} */ - political_exposure?: "existing" | "none"; - ssn_last_4?: string; + political_exposure?: 'existing' | 'none' + ssn_last_4?: string /** person_verification_specs */ verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - } & { [key: string]: unknown }; + back?: string + front?: string + } & { [key: string]: unknown } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + back?: string + front?: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** * settings_specs_update * @description Options for customizing how the account functions within Stripe. @@ -15547,66 +15038,66 @@ export interface operations { settings?: { /** branding_settings_specs */ branding?: { - icon?: string; - logo?: string; - primary_color?: string; - secondary_color?: string; - } & { [key: string]: unknown }; + icon?: string + logo?: string + primary_color?: string + secondary_color?: string + } & { [key: string]: unknown } /** card_issuing_settings_specs */ card_issuing?: { /** settings_terms_of_service_specs */ tos_acceptance?: { /** Format: unix-time */ - date?: number; - ip?: string; - user_agent?: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + date?: number + ip?: string + user_agent?: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** card_payments_settings_specs */ card_payments?: { /** decline_charge_on_specs */ decline_on?: { - avs_failure?: boolean; - cvc_failure?: boolean; - } & { [key: string]: unknown }; - statement_descriptor_prefix?: string; - } & { [key: string]: unknown }; + avs_failure?: boolean + cvc_failure?: boolean + } & { [key: string]: unknown } + statement_descriptor_prefix?: string + } & { [key: string]: unknown } /** payments_settings_specs */ payments?: { - statement_descriptor?: string; - statement_descriptor_kana?: string; - statement_descriptor_kanji?: string; - } & { [key: string]: unknown }; + statement_descriptor?: string + statement_descriptor_kana?: string + statement_descriptor_kanji?: string + } & { [key: string]: unknown } /** payout_settings_specs */ payouts?: { - debit_negative_balances?: boolean; + debit_negative_balances?: boolean /** transfer_schedule_specs */ schedule?: { - delay_days?: (Partial<"minimum"> & Partial) & { [key: string]: unknown }; + delay_days?: (Partial<'minimum'> & Partial) & { [key: string]: unknown } /** @enum {string} */ - interval?: "daily" | "manual" | "monthly" | "weekly"; - monthly_anchor?: number; + interval?: 'daily' | 'manual' | 'monthly' | 'weekly' + monthly_anchor?: number /** @enum {string} */ - weekly_anchor?: "friday" | "monday" | "saturday" | "sunday" | "thursday" | "tuesday" | "wednesday"; - } & { [key: string]: unknown }; - statement_descriptor?: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + weekly_anchor?: 'friday' | 'monday' | 'saturday' | 'sunday' | 'thursday' | 'tuesday' | 'wednesday' + } & { [key: string]: unknown } + statement_descriptor?: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** * tos_acceptance_specs * @description Details on the account's acceptance of the [Stripe Services Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance). */ tos_acceptance?: { /** Format: unix-time */ - date?: number; - ip?: string; - service_agreement?: string; - user_agent?: string; - } & { [key: string]: unknown }; - }; - }; - }; - }; + date?: number + ip?: string + service_agreement?: string + user_agent?: string + } & { [key: string]: unknown } + } + } + } + } /** *

With Connect, you can delete accounts you manage.

* @@ -15619,103 +15110,103 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_account"]; - }; - }; + 'application/json': components['schemas']['deleted_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { - account?: string; - }; - }; - }; - }; + 'application/x-www-form-urlencoded': { + account?: string + } + } + } + } /**

Create an external account for a given account.

*/ PostAccountBankAccounts: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ bank_account?: (Partial< { - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; + account_holder_type?: 'company' | 'individual' + account_number: string /** @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; - country: string; - currency?: string; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' + country: string + currency?: string /** @enum {string} */ - object?: "bank_account"; - routing_number?: string; + object?: 'bank_account' + routing_number?: string } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** @description When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency. */ - default_for_currency?: boolean; + default_for_currency?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - external_account?: string; + external_account?: string /** @description 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?: { [key: string]: string }; - }; - }; - }; - }; + metadata?: { [key: string]: string } + } + } + } + } /**

Retrieve a specified external account for a given account.

*/ GetAccountBankAccountsId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

* @@ -15724,322 +15215,320 @@ export interface operations { PostAccountBankAccountsId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The name of the person or business that owns the bank account. */ - account_holder_name?: string; + account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - account_holder_type?: "" | "company" | "individual"; + account_holder_type?: '' | 'company' | 'individual' /** * @description The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`. * @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' /** @description City/District/Suburb/Town/Village. */ - address_city?: string; + address_city?: string /** @description Billing address country, if provided when creating card. */ - address_country?: string; + address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - address_line1?: string; + address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - address_line2?: string; + address_line2?: string /** @description State/County/Province/Region. */ - address_state?: string; + address_state?: string /** @description ZIP or postal code. */ - address_zip?: string; + address_zip?: string /** @description When set to true, this becomes the default external account for its currency. */ - default_for_currency?: boolean; + default_for_currency?: boolean /** @description Two digit number representing the card’s expiration month. */ - exp_month?: string; + exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - exp_year?: string; + exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description Cardholder name. */ - name?: string; - }; - }; - }; - }; + name?: string + } + } + } + } /**

Delete a specified external account for a given account.

*/ DeleteAccountBankAccountsId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_external_account"]; - }; - }; + 'application/json': components['schemas']['deleted_external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ GetAccountCapabilities: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["capability"][]; + 'application/json': { + data: components['schemas']['capability'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves information about the specified Account Capability.

*/ GetAccountCapabilitiesCapability: { parameters: { path: { - capability: string; - }; + capability: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["capability"]; - }; - }; + 'application/json': components['schemas']['capability'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates an existing Account Capability.

*/ PostAccountCapabilitiesCapability: { parameters: { path: { - capability: string; - }; - }; + capability: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["capability"]; - }; - }; + 'application/json': components['schemas']['capability'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. */ - requested?: boolean; - }; - }; - }; - }; + requested?: boolean + } + } + } + } /**

List external accounts for an account.

*/ GetAccountExternalAccounts: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards. */ - data: ((Partial & Partial) & { - [key: string]: unknown; - })[]; + data: ((Partial & Partial) & { [key: string]: unknown })[] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Create an external account for a given account.

*/ PostAccountExternalAccounts: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ bank_account?: (Partial< { - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; + account_holder_type?: 'company' | 'individual' + account_number: string /** @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; - country: string; - currency?: string; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' + country: string + currency?: string /** @enum {string} */ - object?: "bank_account"; - routing_number?: string; + object?: 'bank_account' + routing_number?: string } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** @description When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency. */ - default_for_currency?: boolean; + default_for_currency?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - external_account?: string; + external_account?: string /** @description 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?: { [key: string]: string }; - }; - }; - }; - }; + metadata?: { [key: string]: string } + } + } + } + } /**

Retrieve a specified external account for a given account.

*/ GetAccountExternalAccountsId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

* @@ -16048,93 +15537,93 @@ export interface operations { PostAccountExternalAccountsId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The name of the person or business that owns the bank account. */ - account_holder_name?: string; + account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - account_holder_type?: "" | "company" | "individual"; + account_holder_type?: '' | 'company' | 'individual' /** * @description The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`. * @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' /** @description City/District/Suburb/Town/Village. */ - address_city?: string; + address_city?: string /** @description Billing address country, if provided when creating card. */ - address_country?: string; + address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - address_line1?: string; + address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - address_line2?: string; + address_line2?: string /** @description State/County/Province/Region. */ - address_state?: string; + address_state?: string /** @description ZIP or postal code. */ - address_zip?: string; + address_zip?: string /** @description When set to true, this becomes the default external account for its currency. */ - default_for_currency?: boolean; + default_for_currency?: boolean /** @description Two digit number representing the card’s expiration month. */ - exp_month?: string; + exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - exp_year?: string; + exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description Cardholder name. */ - name?: string; - }; - }; - }; - }; + name?: string + } + } + } + } /**

Delete a specified external account for a given account.

*/ DeleteAccountExternalAccountsId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_external_account"]; - }; - }; + 'application/json': components['schemas']['deleted_external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Creates a single-use login link for an Express account to access their Stripe dashboard.

* @@ -16145,147 +15634,147 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["login_link"]; - }; - }; + 'application/json': components['schemas']['login_link'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { - account: string; + 'application/x-www-form-urlencoded': { + account: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Where to redirect the user after they log out of their dashboard. */ - redirect_url?: string; - }; - }; - }; - }; + redirect_url?: string + } + } + } + } /**

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.

*/ GetAccountPeople: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Filters on the list of people returned based on the person's relationship to the account's company. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - representative?: boolean; - } & { [key: string]: unknown }; + director?: boolean + executive?: boolean + owner?: boolean + representative?: boolean + } & { [key: string]: unknown } /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["person"][]; + 'application/json': { + data: components['schemas']['person'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new person.

*/ PostAccountPeople: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { - account?: string; + 'application/x-www-form-urlencoded': { + account?: string /** * address_specs * @description The person's address. */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } & { [key: string]: unknown } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } & { [key: string]: unknown } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } & { [key: string]: unknown } /** @description The person's date of birth. */ dob?: (Partial< { - day: number; - month: number; - year: number; + day: number + month: number + year: number } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** * person_documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -16293,65 +15782,65 @@ export interface operations { documents?: { /** documents_param */ company_authorization?: { - files?: string[]; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } /** documents_param */ passport?: { - files?: string[]; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } /** documents_param */ visa?: { - files?: string[]; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** @description The person's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The person's first name. */ - first_name?: string; + first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - first_name_kana?: string; + first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - first_name_kanji?: string; + first_name_kanji?: string /** @description A list of alternate names or aliases that the person is known by. */ - full_name_aliases?: (Partial & Partial<"">) & { [key: string]: unknown }; + full_name_aliases?: (Partial & Partial<''>) & { [key: string]: unknown } /** @description The person's gender (International regulations require either "male" or "female"). */ - gender?: string; + gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ - id_number?: string; + id_number?: string /** @description The person's last name. */ - last_name?: string; + last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - last_name_kana?: string; + last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - last_name_kanji?: string; + last_name_kanji?: string /** @description The person's maiden name. */ - maiden_name?: string; + maiden_name?: string /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ - nationality?: string; + nationality?: string /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - person_token?: string; + person_token?: string /** @description The person's phone number. */ - phone?: string; + phone?: string /** @description 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?: string; + political_exposure?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - percent_ownership?: (Partial & Partial<"">) & { [key: string]: unknown }; - representative?: boolean; - title?: string; - } & { [key: string]: unknown }; + director?: boolean + executive?: boolean + owner?: boolean + percent_ownership?: (Partial & Partial<''>) & { [key: string]: unknown } + representative?: boolean + title?: string + } & { [key: string]: unknown } /** @description The last four digits of the person's Social Security number (U.S. only). */ - ssn_last_4?: string; + ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -16359,122 +15848,122 @@ export interface operations { verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - } & { [key: string]: unknown }; + back?: string + front?: string + } & { [key: string]: unknown } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; - }; - }; - }; - }; + back?: string + front?: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } + } + } + } + } /**

Retrieves an existing person.

*/ GetAccountPeoplePerson: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - person: string; - }; - }; + person: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates an existing person.

*/ PostAccountPeoplePerson: { parameters: { path: { - person: string; - }; - }; + person: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { - account?: string; + 'application/x-www-form-urlencoded': { + account?: string /** * address_specs * @description The person's address. */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } & { [key: string]: unknown } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } & { [key: string]: unknown } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } & { [key: string]: unknown } /** @description The person's date of birth. */ dob?: (Partial< { - day: number; - month: number; - year: number; + day: number + month: number + year: number } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** * person_documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -16482,65 +15971,65 @@ export interface operations { documents?: { /** documents_param */ company_authorization?: { - files?: string[]; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } /** documents_param */ passport?: { - files?: string[]; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } /** documents_param */ visa?: { - files?: string[]; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** @description The person's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The person's first name. */ - first_name?: string; + first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - first_name_kana?: string; + first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - first_name_kanji?: string; + first_name_kanji?: string /** @description A list of alternate names or aliases that the person is known by. */ - full_name_aliases?: (Partial & Partial<"">) & { [key: string]: unknown }; + full_name_aliases?: (Partial & Partial<''>) & { [key: string]: unknown } /** @description The person's gender (International regulations require either "male" or "female"). */ - gender?: string; + gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ - id_number?: string; + id_number?: string /** @description The person's last name. */ - last_name?: string; + last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - last_name_kana?: string; + last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - last_name_kanji?: string; + last_name_kanji?: string /** @description The person's maiden name. */ - maiden_name?: string; + maiden_name?: string /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ - nationality?: string; + nationality?: string /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - person_token?: string; + person_token?: string /** @description The person's phone number. */ - phone?: string; + phone?: string /** @description 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?: string; + political_exposure?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - percent_ownership?: (Partial & Partial<"">) & { [key: string]: unknown }; - representative?: boolean; - title?: string; - } & { [key: string]: unknown }; + director?: boolean + executive?: boolean + owner?: boolean + percent_ownership?: (Partial & Partial<''>) & { [key: string]: unknown } + representative?: boolean + title?: string + } & { [key: string]: unknown } /** @description The last four digits of the person's Social Security number (U.S. only). */ - ssn_last_4?: string; + ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -16548,165 +16037,165 @@ export interface operations { verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - } & { [key: string]: unknown }; + back?: string + front?: string + } & { [key: string]: unknown } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; - }; - }; - }; - }; + back?: string + front?: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } + } + } + } + } /**

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.

*/ DeleteAccountPeoplePerson: { parameters: { path: { - person: string; - }; - }; + person: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_person"]; - }; - }; + 'application/json': components['schemas']['deleted_person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ GetAccountPersons: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Filters on the list of people returned based on the person's relationship to the account's company. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - representative?: boolean; - } & { [key: string]: unknown }; + director?: boolean + executive?: boolean + owner?: boolean + representative?: boolean + } & { [key: string]: unknown } /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["person"][]; + 'application/json': { + data: components['schemas']['person'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new person.

*/ PostAccountPersons: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { - account?: string; + 'application/x-www-form-urlencoded': { + account?: string /** * address_specs * @description The person's address. */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } & { [key: string]: unknown } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } & { [key: string]: unknown } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } & { [key: string]: unknown } /** @description The person's date of birth. */ dob?: (Partial< { - day: number; - month: number; - year: number; + day: number + month: number + year: number } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** * person_documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -16714,65 +16203,65 @@ export interface operations { documents?: { /** documents_param */ company_authorization?: { - files?: string[]; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } /** documents_param */ passport?: { - files?: string[]; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } /** documents_param */ visa?: { - files?: string[]; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** @description The person's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The person's first name. */ - first_name?: string; + first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - first_name_kana?: string; + first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - first_name_kanji?: string; + first_name_kanji?: string /** @description A list of alternate names or aliases that the person is known by. */ - full_name_aliases?: (Partial & Partial<"">) & { [key: string]: unknown }; + full_name_aliases?: (Partial & Partial<''>) & { [key: string]: unknown } /** @description The person's gender (International regulations require either "male" or "female"). */ - gender?: string; + gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ - id_number?: string; + id_number?: string /** @description The person's last name. */ - last_name?: string; + last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - last_name_kana?: string; + last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - last_name_kanji?: string; + last_name_kanji?: string /** @description The person's maiden name. */ - maiden_name?: string; + maiden_name?: string /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ - nationality?: string; + nationality?: string /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - person_token?: string; + person_token?: string /** @description The person's phone number. */ - phone?: string; + phone?: string /** @description 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?: string; + political_exposure?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - percent_ownership?: (Partial & Partial<"">) & { [key: string]: unknown }; - representative?: boolean; - title?: string; - } & { [key: string]: unknown }; + director?: boolean + executive?: boolean + owner?: boolean + percent_ownership?: (Partial & Partial<''>) & { [key: string]: unknown } + representative?: boolean + title?: string + } & { [key: string]: unknown } /** @description The last four digits of the person's Social Security number (U.S. only). */ - ssn_last_4?: string; + ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -16780,122 +16269,122 @@ export interface operations { verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - } & { [key: string]: unknown }; + back?: string + front?: string + } & { [key: string]: unknown } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; - }; - }; - }; - }; + back?: string + front?: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } + } + } + } + } /**

Retrieves an existing person.

*/ GetAccountPersonsPerson: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - person: string; - }; - }; + person: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates an existing person.

*/ PostAccountPersonsPerson: { parameters: { path: { - person: string; - }; - }; + person: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { - account?: string; + 'application/x-www-form-urlencoded': { + account?: string /** * address_specs * @description The person's address. */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } & { [key: string]: unknown } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } & { [key: string]: unknown } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } & { [key: string]: unknown } /** @description The person's date of birth. */ dob?: (Partial< { - day: number; - month: number; - year: number; + day: number + month: number + year: number } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** * person_documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -16903,65 +16392,65 @@ export interface operations { documents?: { /** documents_param */ company_authorization?: { - files?: string[]; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } /** documents_param */ passport?: { - files?: string[]; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } /** documents_param */ visa?: { - files?: string[]; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** @description The person's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The person's first name. */ - first_name?: string; + first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - first_name_kana?: string; + first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - first_name_kanji?: string; + first_name_kanji?: string /** @description A list of alternate names or aliases that the person is known by. */ - full_name_aliases?: (Partial & Partial<"">) & { [key: string]: unknown }; + full_name_aliases?: (Partial & Partial<''>) & { [key: string]: unknown } /** @description The person's gender (International regulations require either "male" or "female"). */ - gender?: string; + gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ - id_number?: string; + id_number?: string /** @description The person's last name. */ - last_name?: string; + last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - last_name_kana?: string; + last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - last_name_kanji?: string; + last_name_kanji?: string /** @description The person's maiden name. */ - maiden_name?: string; + maiden_name?: string /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ - nationality?: string; + nationality?: string /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - person_token?: string; + person_token?: string /** @description The person's phone number. */ - phone?: string; + phone?: string /** @description 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?: string; + political_exposure?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - percent_ownership?: (Partial & Partial<"">) & { [key: string]: unknown }; - representative?: boolean; - title?: string; - } & { [key: string]: unknown }; + director?: boolean + executive?: boolean + owner?: boolean + percent_ownership?: (Partial & Partial<''>) & { [key: string]: unknown } + representative?: boolean + title?: string + } & { [key: string]: unknown } /** @description The last four digits of the person's Social Security number (U.S. only). */ - ssn_last_4?: string; + ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -16969,141 +16458,141 @@ export interface operations { verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - } & { [key: string]: unknown }; + back?: string + front?: string + } & { [key: string]: unknown } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; - }; - }; - }; - }; + back?: string + front?: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } + } + } + } + } /**

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.

*/ DeleteAccountPersonsPerson: { parameters: { path: { - person: string; - }; - }; + person: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_person"]; - }; - }; + 'application/json': components['schemas']['deleted_person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostAccountLinks: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["account_link"]; - }; - }; + 'application/json': components['schemas']['account_link'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The identifier of the account to create an account link for. */ - account: string; + account: string /** * @description Which information the platform needs to collect from the user. One of `currently_due` or `eventually_due`. Default is `currently_due`. * @enum {string} */ - collect?: "currently_due" | "eventually_due"; + collect?: 'currently_due' | 'eventually_due' /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The URL the user will be redirected to if the account link is expired, has been previously-visited, or is otherwise invalid. The URL you specify should attempt to generate a new account link with the same parameters used to create the original account link, then redirect the user to the new account link's URL so they can continue with Connect Onboarding. If a new account link cannot be generated or the redirect fails you should display a useful error to the user. */ - refresh_url?: string; + refresh_url?: string /** @description The URL that the user will be redirected to upon leaving or completing the linked flow. */ - return_url?: string; + return_url?: string /** * @description The type of account link the user is requesting. Possible values are `account_onboarding` or `account_update`. * @enum {string} */ - type: "account_onboarding" | "account_update"; - }; - }; - }; - }; + type: 'account_onboarding' | 'account_update' + } + } + } + } /**

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

*/ GetAccounts: { parameters: { query: { created?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["account"][]; + 'application/json': { + data: components['schemas']['account'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

With Connect, you can create Stripe accounts for your users. * To do this, you’ll first need to register your platform.

@@ -17113,65 +16602,65 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["account"]; - }; - }; + 'application/json': components['schemas']['account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account. */ - account_token?: string; + account_token?: string /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ bank_account?: (Partial< { - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; + account_holder_type?: 'company' | 'individual' + account_number: string /** @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; - country: string; - currency?: string; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' + country: string + currency?: string /** @enum {string} */ - object?: "bank_account"; - routing_number?: string; + object?: 'bank_account' + routing_number?: string } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** * business_profile_specs * @description Business information about the account. */ business_profile?: { - mcc?: string; - name?: string; - product_description?: string; + mcc?: string + name?: string + product_description?: string /** address_specs */ support_address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - } & { [key: string]: unknown }; - support_email?: string; - support_phone?: string; - support_url?: (Partial & Partial<"">) & { [key: string]: unknown }; - url?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } & { [key: string]: unknown } + support_email?: string + support_phone?: string + support_url?: (Partial & Partial<''>) & { [key: string]: unknown } + url?: string + } & { [key: string]: unknown } /** * @description The business type. * @enum {string} */ - business_type?: "company" | "government_entity" | "individual" | "non_profit"; + business_type?: 'company' | 'government_entity' | 'individual' | 'non_profit' /** * capabilities_param * @description Each key of the dictionary represents a capability, and each capability maps to its settings (e.g. whether it has been requested or not). Each capability will be inactive until you have provided its specific requirements and Stripe has verified them. An account may have some of its requested capabilities be active and some be inactive. @@ -17179,101 +16668,101 @@ export interface operations { capabilities?: { /** capability_param */ acss_debit_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ afterpay_clearpay_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ au_becs_debit_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ bacs_debit_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ bancontact_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ boleto_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ card_issuing?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ card_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ cartes_bancaires_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ eps_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ fpx_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ giropay_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ grabpay_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ ideal_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ jcb_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ klarna_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ legacy_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ oxxo_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ p24_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ sepa_debit_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ sofort_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ tax_reporting_us_1099_k?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ tax_reporting_us_1099_misc?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ transfers?: { - requested?: boolean; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** * company_specs * @description Information about the company or business. This field is available for any `business_type`. @@ -17281,87 +16770,87 @@ export interface operations { company?: { /** address_specs */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } & { [key: string]: unknown } /** japan_address_kana_specs */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } & { [key: string]: unknown } /** japan_address_kanji_specs */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - } & { [key: string]: unknown }; - directors_provided?: boolean; - executives_provided?: boolean; - name?: string; - name_kana?: string; - name_kanji?: string; - owners_provided?: boolean; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } & { [key: string]: unknown } + directors_provided?: boolean + executives_provided?: boolean + name?: string + name_kana?: string + name_kanji?: string + owners_provided?: boolean /** company_ownership_declaration */ ownership_declaration?: { /** Format: unix-time */ - date?: number; - ip?: string; - user_agent?: string; - } & { [key: string]: unknown }; - phone?: string; - registration_number?: string; + date?: number + ip?: string + user_agent?: string + } & { [key: string]: unknown } + phone?: string + registration_number?: string /** @enum {string} */ structure?: - | "" - | "free_zone_establishment" - | "free_zone_llc" - | "government_instrumentality" - | "governmental_unit" - | "incorporated_non_profit" - | "limited_liability_partnership" - | "llc" - | "multi_member_llc" - | "private_company" - | "private_corporation" - | "private_partnership" - | "public_company" - | "public_corporation" - | "public_partnership" - | "single_member_llc" - | "sole_establishment" - | "sole_proprietorship" - | "tax_exempt_government_instrumentality" - | "unincorporated_association" - | "unincorporated_non_profit"; - tax_id?: string; - tax_id_registrar?: string; - vat_id?: string; + | '' + | 'free_zone_establishment' + | 'free_zone_llc' + | 'government_instrumentality' + | 'governmental_unit' + | 'incorporated_non_profit' + | 'limited_liability_partnership' + | 'llc' + | 'multi_member_llc' + | 'private_company' + | 'private_corporation' + | 'private_partnership' + | 'public_company' + | 'public_corporation' + | 'public_partnership' + | 'single_member_llc' + | 'sole_establishment' + | 'sole_proprietorship' + | 'tax_exempt_government_instrumentality' + | 'unincorporated_association' + | 'unincorporated_non_profit' + tax_id?: string + tax_id_registrar?: string + vat_id?: string /** verification_specs */ verification?: { /** verification_document_specs */ document?: { - back?: string; - front?: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + back?: string + front?: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** @description The country in which the account holder resides, or in which the business is legally established. This should be an ISO 3166-1 alpha-2 country code. For example, if you are in the United States and the business for which you're creating an account is legally represented in Canada, you would use `CA` as the country for the account being created. */ - country?: string; + country?: string /** @description 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?: string; + default_currency?: string /** * documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -17369,39 +16858,39 @@ export interface operations { documents?: { /** documents_param */ bank_account_ownership_verification?: { - files?: string[]; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } /** documents_param */ company_license?: { - files?: string[]; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } /** documents_param */ company_memorandum_of_association?: { - files?: string[]; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } /** documents_param */ company_ministerial_decree?: { - files?: string[]; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } /** documents_param */ company_registration_verification?: { - files?: string[]; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } /** documents_param */ company_tax_id_verification?: { - files?: string[]; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } /** documents_param */ proof_of_registration?: { - files?: string[]; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** @description The email address of the account holder. This is only to make the account easier to identify to you. Stripe only emails Custom accounts with your consent. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A card or bank account to attach to the account for receiving [payouts](https://stripe.com/docs/connect/bank-debit-card-payouts) (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://stripe.com/docs/api#account_create_bank_account) creation.

By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the bank account or card creation API. */ - external_account?: string; + external_account?: string /** * individual_specs * @description Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. @@ -17409,73 +16898,73 @@ export interface operations { individual?: { /** address_specs */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } & { [key: string]: unknown } /** japan_address_kana_specs */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } & { [key: string]: unknown } /** japan_address_kanji_specs */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } & { [key: string]: unknown } dob?: (Partial< { - day: number; - month: number; - year: number; + day: number + month: number + year: number } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - email?: string; - first_name?: string; - first_name_kana?: string; - first_name_kanji?: string; - full_name_aliases?: (Partial & Partial<"">) & { [key: string]: unknown }; - gender?: string; - id_number?: string; - last_name?: string; - last_name_kana?: string; - last_name_kanji?: string; - maiden_name?: string; - metadata?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; - phone?: string; + Partial<''>) & { [key: string]: unknown } + email?: string + first_name?: string + first_name_kana?: string + first_name_kanji?: string + full_name_aliases?: (Partial & Partial<''>) & { [key: string]: unknown } + gender?: string + id_number?: string + last_name?: string + last_name_kana?: string + last_name_kanji?: string + maiden_name?: string + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } + phone?: string /** @enum {string} */ - political_exposure?: "existing" | "none"; - ssn_last_4?: string; + political_exposure?: 'existing' | 'none' + ssn_last_4?: string /** person_verification_specs */ verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - } & { [key: string]: unknown }; + back?: string + front?: string + } & { [key: string]: unknown } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + back?: string + front?: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** * settings_specs * @description Options for customizing how the account functions within Stripe. @@ -17483,102 +16972,102 @@ export interface operations { settings?: { /** branding_settings_specs */ branding?: { - icon?: string; - logo?: string; - primary_color?: string; - secondary_color?: string; - } & { [key: string]: unknown }; + icon?: string + logo?: string + primary_color?: string + secondary_color?: string + } & { [key: string]: unknown } /** card_issuing_settings_specs */ card_issuing?: { /** settings_terms_of_service_specs */ tos_acceptance?: { /** Format: unix-time */ - date?: number; - ip?: string; - user_agent?: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + date?: number + ip?: string + user_agent?: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** card_payments_settings_specs */ card_payments?: { /** decline_charge_on_specs */ decline_on?: { - avs_failure?: boolean; - cvc_failure?: boolean; - } & { [key: string]: unknown }; - statement_descriptor_prefix?: string; - } & { [key: string]: unknown }; + avs_failure?: boolean + cvc_failure?: boolean + } & { [key: string]: unknown } + statement_descriptor_prefix?: string + } & { [key: string]: unknown } /** payments_settings_specs */ payments?: { - statement_descriptor?: string; - statement_descriptor_kana?: string; - statement_descriptor_kanji?: string; - } & { [key: string]: unknown }; + statement_descriptor?: string + statement_descriptor_kana?: string + statement_descriptor_kanji?: string + } & { [key: string]: unknown } /** payout_settings_specs */ payouts?: { - debit_negative_balances?: boolean; + debit_negative_balances?: boolean /** transfer_schedule_specs */ schedule?: { - delay_days?: (Partial<"minimum"> & Partial) & { [key: string]: unknown }; + delay_days?: (Partial<'minimum'> & Partial) & { [key: string]: unknown } /** @enum {string} */ - interval?: "daily" | "manual" | "monthly" | "weekly"; - monthly_anchor?: number; + interval?: 'daily' | 'manual' | 'monthly' | 'weekly' + monthly_anchor?: number /** @enum {string} */ - weekly_anchor?: "friday" | "monday" | "saturday" | "sunday" | "thursday" | "tuesday" | "wednesday"; - } & { [key: string]: unknown }; - statement_descriptor?: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + weekly_anchor?: 'friday' | 'monday' | 'saturday' | 'sunday' | 'thursday' | 'tuesday' | 'wednesday' + } & { [key: string]: unknown } + statement_descriptor?: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** * tos_acceptance_specs * @description Details on the account's acceptance of the [Stripe Services Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance). */ tos_acceptance?: { /** Format: unix-time */ - date?: number; - ip?: string; - service_agreement?: string; - user_agent?: string; - } & { [key: string]: unknown }; + date?: number + ip?: string + service_agreement?: string + user_agent?: string + } & { [key: string]: unknown } /** * @description The type of Stripe account to create. May be one of `custom`, `express` or `standard`. * @enum {string} */ - type?: "custom" | "express" | "standard"; - }; - }; - }; - }; + type?: 'custom' | 'express' | 'standard' + } + } + } + } /**

Retrieves the details of an account.

*/ GetAccountsAccount: { parameters: { path: { - account: string; - }; + account: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["account"]; - }; - }; + 'application/json': components['schemas']['account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged. Most parameters can be changed only for Custom accounts. (These are marked Custom Only below.) Parameters marked Custom and Express are not supported for Standard accounts.

* @@ -17587,72 +17076,72 @@ export interface operations { PostAccountsAccount: { parameters: { path: { - account: string; - }; - }; + account: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["account"]; - }; - }; + 'application/json': components['schemas']['account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account. */ - account_token?: string; + account_token?: string /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ bank_account?: (Partial< { - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; + account_holder_type?: 'company' | 'individual' + account_number: string /** @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; - country: string; - currency?: string; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' + country: string + currency?: string /** @enum {string} */ - object?: "bank_account"; - routing_number?: string; + object?: 'bank_account' + routing_number?: string } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** * business_profile_specs * @description Business information about the account. */ business_profile?: { - mcc?: string; - name?: string; - product_description?: string; + mcc?: string + name?: string + product_description?: string /** address_specs */ support_address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - } & { [key: string]: unknown }; - support_email?: string; - support_phone?: string; - support_url?: (Partial & Partial<"">) & { [key: string]: unknown }; - url?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } & { [key: string]: unknown } + support_email?: string + support_phone?: string + support_url?: (Partial & Partial<''>) & { [key: string]: unknown } + url?: string + } & { [key: string]: unknown } /** * @description The business type. * @enum {string} */ - business_type?: "company" | "government_entity" | "individual" | "non_profit"; + business_type?: 'company' | 'government_entity' | 'individual' | 'non_profit' /** * capabilities_param * @description Each key of the dictionary represents a capability, and each capability maps to its settings (e.g. whether it has been requested or not). Each capability will be inactive until you have provided its specific requirements and Stripe has verified them. An account may have some of its requested capabilities be active and some be inactive. @@ -17660,187 +17149,187 @@ export interface operations { capabilities?: { /** capability_param */ acss_debit_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ afterpay_clearpay_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ au_becs_debit_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ bacs_debit_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ bancontact_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ boleto_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ card_issuing?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ card_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ cartes_bancaires_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ eps_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ fpx_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ giropay_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ grabpay_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ ideal_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ jcb_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ klarna_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ legacy_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ oxxo_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ p24_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ sepa_debit_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ sofort_payments?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ tax_reporting_us_1099_k?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ tax_reporting_us_1099_misc?: { - requested?: boolean; - } & { [key: string]: unknown }; + requested?: boolean + } & { [key: string]: unknown } /** capability_param */ transfers?: { - requested?: boolean; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; - /** + requested?: boolean + } & { [key: string]: unknown } + } & { [key: string]: unknown } + /** * company_specs * @description Information about the company or business. This field is available for any `business_type`. */ company?: { /** address_specs */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } & { [key: string]: unknown } /** japan_address_kana_specs */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } & { [key: string]: unknown } /** japan_address_kanji_specs */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - } & { [key: string]: unknown }; - directors_provided?: boolean; - executives_provided?: boolean; - name?: string; - name_kana?: string; - name_kanji?: string; - owners_provided?: boolean; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } & { [key: string]: unknown } + directors_provided?: boolean + executives_provided?: boolean + name?: string + name_kana?: string + name_kanji?: string + owners_provided?: boolean /** company_ownership_declaration */ ownership_declaration?: { /** Format: unix-time */ - date?: number; - ip?: string; - user_agent?: string; - } & { [key: string]: unknown }; - phone?: string; - registration_number?: string; + date?: number + ip?: string + user_agent?: string + } & { [key: string]: unknown } + phone?: string + registration_number?: string /** @enum {string} */ structure?: - | "" - | "free_zone_establishment" - | "free_zone_llc" - | "government_instrumentality" - | "governmental_unit" - | "incorporated_non_profit" - | "limited_liability_partnership" - | "llc" - | "multi_member_llc" - | "private_company" - | "private_corporation" - | "private_partnership" - | "public_company" - | "public_corporation" - | "public_partnership" - | "single_member_llc" - | "sole_establishment" - | "sole_proprietorship" - | "tax_exempt_government_instrumentality" - | "unincorporated_association" - | "unincorporated_non_profit"; - tax_id?: string; - tax_id_registrar?: string; - vat_id?: string; + | '' + | 'free_zone_establishment' + | 'free_zone_llc' + | 'government_instrumentality' + | 'governmental_unit' + | 'incorporated_non_profit' + | 'limited_liability_partnership' + | 'llc' + | 'multi_member_llc' + | 'private_company' + | 'private_corporation' + | 'private_partnership' + | 'public_company' + | 'public_corporation' + | 'public_partnership' + | 'single_member_llc' + | 'sole_establishment' + | 'sole_proprietorship' + | 'tax_exempt_government_instrumentality' + | 'unincorporated_association' + | 'unincorporated_non_profit' + tax_id?: string + tax_id_registrar?: string + vat_id?: string /** verification_specs */ verification?: { /** verification_document_specs */ document?: { - back?: string; - front?: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + back?: string + front?: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** @description 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?: string; + default_currency?: string /** * documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -17848,39 +17337,39 @@ export interface operations { documents?: { /** documents_param */ bank_account_ownership_verification?: { - files?: string[]; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } /** documents_param */ company_license?: { - files?: string[]; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } /** documents_param */ company_memorandum_of_association?: { - files?: string[]; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } /** documents_param */ company_ministerial_decree?: { - files?: string[]; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } /** documents_param */ company_registration_verification?: { - files?: string[]; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } /** documents_param */ company_tax_id_verification?: { - files?: string[]; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } /** documents_param */ proof_of_registration?: { - files?: string[]; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** @description The email address of the account holder. This is only to make the account easier to identify to you. Stripe only emails Custom accounts with your consent. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A card or bank account to attach to the account for receiving [payouts](https://stripe.com/docs/connect/bank-debit-card-payouts) (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://stripe.com/docs/api#account_create_bank_account) creation.

By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the bank account or card creation API. */ - external_account?: string; + external_account?: string /** * individual_specs * @description Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. @@ -17888,73 +17377,73 @@ export interface operations { individual?: { /** address_specs */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } & { [key: string]: unknown } /** japan_address_kana_specs */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } & { [key: string]: unknown } /** japan_address_kanji_specs */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } & { [key: string]: unknown } dob?: (Partial< { - day: number; - month: number; - year: number; + day: number + month: number + year: number } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - email?: string; - first_name?: string; - first_name_kana?: string; - first_name_kanji?: string; - full_name_aliases?: (Partial & Partial<"">) & { [key: string]: unknown }; - gender?: string; - id_number?: string; - last_name?: string; - last_name_kana?: string; - last_name_kanji?: string; - maiden_name?: string; - metadata?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; - phone?: string; + Partial<''>) & { [key: string]: unknown } + email?: string + first_name?: string + first_name_kana?: string + first_name_kanji?: string + full_name_aliases?: (Partial & Partial<''>) & { [key: string]: unknown } + gender?: string + id_number?: string + last_name?: string + last_name_kana?: string + last_name_kanji?: string + maiden_name?: string + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } + phone?: string /** @enum {string} */ - political_exposure?: "existing" | "none"; - ssn_last_4?: string; + political_exposure?: 'existing' | 'none' + ssn_last_4?: string /** person_verification_specs */ verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - } & { [key: string]: unknown }; + back?: string + front?: string + } & { [key: string]: unknown } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + back?: string + front?: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** * settings_specs_update * @description Options for customizing how the account functions within Stripe. @@ -17962,66 +17451,66 @@ export interface operations { settings?: { /** branding_settings_specs */ branding?: { - icon?: string; - logo?: string; - primary_color?: string; - secondary_color?: string; - } & { [key: string]: unknown }; + icon?: string + logo?: string + primary_color?: string + secondary_color?: string + } & { [key: string]: unknown } /** card_issuing_settings_specs */ card_issuing?: { /** settings_terms_of_service_specs */ tos_acceptance?: { /** Format: unix-time */ - date?: number; - ip?: string; - user_agent?: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + date?: number + ip?: string + user_agent?: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** card_payments_settings_specs */ card_payments?: { /** decline_charge_on_specs */ decline_on?: { - avs_failure?: boolean; - cvc_failure?: boolean; - } & { [key: string]: unknown }; - statement_descriptor_prefix?: string; - } & { [key: string]: unknown }; + avs_failure?: boolean + cvc_failure?: boolean + } & { [key: string]: unknown } + statement_descriptor_prefix?: string + } & { [key: string]: unknown } /** payments_settings_specs */ payments?: { - statement_descriptor?: string; - statement_descriptor_kana?: string; - statement_descriptor_kanji?: string; - } & { [key: string]: unknown }; + statement_descriptor?: string + statement_descriptor_kana?: string + statement_descriptor_kanji?: string + } & { [key: string]: unknown } /** payout_settings_specs */ payouts?: { - debit_negative_balances?: boolean; + debit_negative_balances?: boolean /** transfer_schedule_specs */ schedule?: { - delay_days?: (Partial<"minimum"> & Partial) & { [key: string]: unknown }; + delay_days?: (Partial<'minimum'> & Partial) & { [key: string]: unknown } /** @enum {string} */ - interval?: "daily" | "manual" | "monthly" | "weekly"; - monthly_anchor?: number; + interval?: 'daily' | 'manual' | 'monthly' | 'weekly' + monthly_anchor?: number /** @enum {string} */ - weekly_anchor?: "friday" | "monday" | "saturday" | "sunday" | "thursday" | "tuesday" | "wednesday"; - } & { [key: string]: unknown }; - statement_descriptor?: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + weekly_anchor?: 'friday' | 'monday' | 'saturday' | 'sunday' | 'thursday' | 'tuesday' | 'wednesday' + } & { [key: string]: unknown } + statement_descriptor?: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** * tos_acceptance_specs * @description Details on the account's acceptance of the [Stripe Services Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance). */ tos_acceptance?: { /** Format: unix-time */ - date?: number; - ip?: string; - service_agreement?: string; - user_agent?: string; - } & { [key: string]: unknown }; - }; - }; - }; - }; + date?: number + ip?: string + service_agreement?: string + user_agent?: string + } & { [key: string]: unknown } + } + } + } + } /** *

With Connect, you can delete accounts you manage.

* @@ -18032,114 +17521,114 @@ export interface operations { DeleteAccountsAccount: { parameters: { path: { - account: string; - }; - }; + account: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_account"]; - }; - }; + 'application/json': components['schemas']['deleted_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Create an external account for a given account.

*/ PostAccountsAccountBankAccounts: { parameters: { path: { - account: string; - }; - }; + account: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ bank_account?: (Partial< { - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; + account_holder_type?: 'company' | 'individual' + account_number: string /** @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; - country: string; - currency?: string; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' + country: string + currency?: string /** @enum {string} */ - object?: "bank_account"; - routing_number?: string; + object?: 'bank_account' + routing_number?: string } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** @description When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency. */ - default_for_currency?: boolean; + default_for_currency?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - external_account?: string; + external_account?: string /** @description 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?: { [key: string]: string }; - }; - }; - }; - }; + metadata?: { [key: string]: string } + } + } + } + } /**

Retrieve a specified external account for a given account.

*/ GetAccountsAccountBankAccountsId: { parameters: { path: { - account: string; - id: string; - }; + account: string + id: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

* @@ -18148,338 +17637,336 @@ export interface operations { PostAccountsAccountBankAccountsId: { parameters: { path: { - account: string; - id: string; - }; - }; + account: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The name of the person or business that owns the bank account. */ - account_holder_name?: string; + account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - account_holder_type?: "" | "company" | "individual"; + account_holder_type?: '' | 'company' | 'individual' /** * @description The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`. * @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' /** @description City/District/Suburb/Town/Village. */ - address_city?: string; + address_city?: string /** @description Billing address country, if provided when creating card. */ - address_country?: string; + address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - address_line1?: string; + address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - address_line2?: string; + address_line2?: string /** @description State/County/Province/Region. */ - address_state?: string; + address_state?: string /** @description ZIP or postal code. */ - address_zip?: string; + address_zip?: string /** @description When set to true, this becomes the default external account for its currency. */ - default_for_currency?: boolean; + default_for_currency?: boolean /** @description Two digit number representing the card’s expiration month. */ - exp_month?: string; + exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - exp_year?: string; + exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description Cardholder name. */ - name?: string; - }; - }; - }; - }; + name?: string + } + } + } + } /**

Delete a specified external account for a given account.

*/ DeleteAccountsAccountBankAccountsId: { parameters: { path: { - account: string; - id: string; - }; - }; + account: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_external_account"]; - }; - }; + 'application/json': components['schemas']['deleted_external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ GetAccountsAccountCapabilities: { parameters: { path: { - account: string; - }; + account: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["capability"][]; + 'application/json': { + data: components['schemas']['capability'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves information about the specified Account Capability.

*/ GetAccountsAccountCapabilitiesCapability: { parameters: { path: { - account: string; - capability: string; - }; + account: string + capability: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["capability"]; - }; - }; + 'application/json': components['schemas']['capability'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates an existing Account Capability.

*/ PostAccountsAccountCapabilitiesCapability: { parameters: { path: { - account: string; - capability: string; - }; - }; + account: string + capability: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["capability"]; - }; - }; + 'application/json': components['schemas']['capability'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. */ - requested?: boolean; - }; - }; - }; - }; + requested?: boolean + } + } + } + } /**

List external accounts for an account.

*/ GetAccountsAccountExternalAccounts: { parameters: { path: { - account: string; - }; + account: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards. */ - data: ((Partial & Partial) & { - [key: string]: unknown; - })[]; + data: ((Partial & Partial) & { [key: string]: unknown })[] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Create an external account for a given account.

*/ PostAccountsAccountExternalAccounts: { parameters: { path: { - account: string; - }; - }; + account: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ bank_account?: (Partial< { - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; + account_holder_type?: 'company' | 'individual' + account_number: string /** @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; - country: string; - currency?: string; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' + country: string + currency?: string /** @enum {string} */ - object?: "bank_account"; - routing_number?: string; + object?: 'bank_account' + routing_number?: string } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** @description When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency. */ - default_for_currency?: boolean; + default_for_currency?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - external_account?: string; + external_account?: string /** @description 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?: { [key: string]: string }; - }; - }; - }; - }; + metadata?: { [key: string]: string } + } + } + } + } /**

Retrieve a specified external account for a given account.

*/ GetAccountsAccountExternalAccountsId: { parameters: { path: { - account: string; - id: string; - }; + account: string + id: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

* @@ -18488,95 +17975,95 @@ export interface operations { PostAccountsAccountExternalAccountsId: { parameters: { path: { - account: string; - id: string; - }; - }; + account: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The name of the person or business that owns the bank account. */ - account_holder_name?: string; + account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - account_holder_type?: "" | "company" | "individual"; + account_holder_type?: '' | 'company' | 'individual' /** * @description The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`. * @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' /** @description City/District/Suburb/Town/Village. */ - address_city?: string; + address_city?: string /** @description Billing address country, if provided when creating card. */ - address_country?: string; + address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - address_line1?: string; + address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - address_line2?: string; + address_line2?: string /** @description State/County/Province/Region. */ - address_state?: string; + address_state?: string /** @description ZIP or postal code. */ - address_zip?: string; + address_zip?: string /** @description When set to true, this becomes the default external account for its currency. */ - default_for_currency?: boolean; + default_for_currency?: boolean /** @description Two digit number representing the card’s expiration month. */ - exp_month?: string; + exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - exp_year?: string; + exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description Cardholder name. */ - name?: string; - }; - }; - }; - }; + name?: string + } + } + } + } /**

Delete a specified external account for a given account.

*/ DeleteAccountsAccountExternalAccountsId: { parameters: { path: { - account: string; - id: string; - }; - }; + account: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_external_account"]; - }; - }; + 'application/json': components['schemas']['deleted_external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Creates a single-use login link for an Express account to access their Stripe dashboard.

* @@ -18585,160 +18072,160 @@ export interface operations { PostAccountsAccountLoginLinks: { parameters: { path: { - account: string; - }; - }; + account: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["login_link"]; - }; - }; + 'application/json': components['schemas']['login_link'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Where to redirect the user after they log out of their dashboard. */ - redirect_url?: string; - }; - }; - }; - }; + redirect_url?: string + } + } + } + } /**

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.

*/ GetAccountsAccountPeople: { parameters: { path: { - account: string; - }; + account: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Filters on the list of people returned based on the person's relationship to the account's company. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - representative?: boolean; - } & { [key: string]: unknown }; + director?: boolean + executive?: boolean + owner?: boolean + representative?: boolean + } & { [key: string]: unknown } /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["person"][]; + 'application/json': { + data: components['schemas']['person'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new person.

*/ PostAccountsAccountPeople: { parameters: { path: { - account: string; - }; - }; + account: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * address_specs * @description The person's address. */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } & { [key: string]: unknown } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } & { [key: string]: unknown } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } & { [key: string]: unknown } /** @description The person's date of birth. */ dob?: (Partial< { - day: number; - month: number; - year: number; + day: number + month: number + year: number } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** * person_documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -18746,65 +18233,65 @@ export interface operations { documents?: { /** documents_param */ company_authorization?: { - files?: string[]; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } /** documents_param */ passport?: { - files?: string[]; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } /** documents_param */ visa?: { - files?: string[]; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** @description The person's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The person's first name. */ - first_name?: string; + first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - first_name_kana?: string; + first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - first_name_kanji?: string; + first_name_kanji?: string /** @description A list of alternate names or aliases that the person is known by. */ - full_name_aliases?: (Partial & Partial<"">) & { [key: string]: unknown }; + full_name_aliases?: (Partial & Partial<''>) & { [key: string]: unknown } /** @description The person's gender (International regulations require either "male" or "female"). */ - gender?: string; + gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ - id_number?: string; + id_number?: string /** @description The person's last name. */ - last_name?: string; + last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - last_name_kana?: string; + last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - last_name_kanji?: string; + last_name_kanji?: string /** @description The person's maiden name. */ - maiden_name?: string; + maiden_name?: string /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ - nationality?: string; + nationality?: string /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - person_token?: string; + person_token?: string /** @description The person's phone number. */ - phone?: string; + phone?: string /** @description 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?: string; + political_exposure?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - percent_ownership?: (Partial & Partial<"">) & { [key: string]: unknown }; - representative?: boolean; - title?: string; - } & { [key: string]: unknown }; + director?: boolean + executive?: boolean + owner?: boolean + percent_ownership?: (Partial & Partial<''>) & { [key: string]: unknown } + representative?: boolean + title?: string + } & { [key: string]: unknown } /** @description The last four digits of the person's Social Security number (U.S. only). */ - ssn_last_4?: string; + ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -18812,123 +18299,123 @@ export interface operations { verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - } & { [key: string]: unknown }; + back?: string + front?: string + } & { [key: string]: unknown } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; - }; - }; - }; - }; + back?: string + front?: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } + } + } + } + } /**

Retrieves an existing person.

*/ GetAccountsAccountPeoplePerson: { parameters: { path: { - account: string; - person: string; - }; + account: string + person: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates an existing person.

*/ PostAccountsAccountPeoplePerson: { parameters: { path: { - account: string; - person: string; - }; - }; + account: string + person: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * address_specs * @description The person's address. */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } & { [key: string]: unknown } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } & { [key: string]: unknown } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } & { [key: string]: unknown } /** @description The person's date of birth. */ dob?: (Partial< { - day: number; - month: number; - year: number; + day: number + month: number + year: number } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** * person_documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -18936,65 +18423,65 @@ export interface operations { documents?: { /** documents_param */ company_authorization?: { - files?: string[]; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } /** documents_param */ passport?: { - files?: string[]; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } /** documents_param */ visa?: { - files?: string[]; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** @description The person's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The person's first name. */ - first_name?: string; + first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - first_name_kana?: string; + first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - first_name_kanji?: string; + first_name_kanji?: string /** @description A list of alternate names or aliases that the person is known by. */ - full_name_aliases?: (Partial & Partial<"">) & { [key: string]: unknown }; + full_name_aliases?: (Partial & Partial<''>) & { [key: string]: unknown } /** @description The person's gender (International regulations require either "male" or "female"). */ - gender?: string; + gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ - id_number?: string; + id_number?: string /** @description The person's last name. */ - last_name?: string; + last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - last_name_kana?: string; + last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - last_name_kanji?: string; + last_name_kanji?: string /** @description The person's maiden name. */ - maiden_name?: string; + maiden_name?: string /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ - nationality?: string; + nationality?: string /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - person_token?: string; + person_token?: string /** @description The person's phone number. */ - phone?: string; + phone?: string /** @description 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?: string; + political_exposure?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - percent_ownership?: (Partial & Partial<"">) & { [key: string]: unknown }; - representative?: boolean; - title?: string; - } & { [key: string]: unknown }; + director?: boolean + executive?: boolean + owner?: boolean + percent_ownership?: (Partial & Partial<''>) & { [key: string]: unknown } + representative?: boolean + title?: string + } & { [key: string]: unknown } /** @description The last four digits of the person's Social Security number (U.S. only). */ - ssn_last_4?: string; + ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -19002,173 +18489,173 @@ export interface operations { verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - } & { [key: string]: unknown }; + back?: string + front?: string + } & { [key: string]: unknown } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; - }; - }; - }; - }; + back?: string + front?: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } + } + } + } + } /**

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.

*/ DeleteAccountsAccountPeoplePerson: { parameters: { path: { - account: string; - person: string; - }; - }; + account: string + person: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_person"]; - }; - }; + 'application/json': components['schemas']['deleted_person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ GetAccountsAccountPersons: { parameters: { path: { - account: string; - }; + account: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Filters on the list of people returned based on the person's relationship to the account's company. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - representative?: boolean; - } & { [key: string]: unknown }; + director?: boolean + executive?: boolean + owner?: boolean + representative?: boolean + } & { [key: string]: unknown } /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["person"][]; + 'application/json': { + data: components['schemas']['person'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new person.

*/ PostAccountsAccountPersons: { parameters: { path: { - account: string; - }; - }; + account: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * address_specs * @description The person's address. */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } & { [key: string]: unknown } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } & { [key: string]: unknown } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } & { [key: string]: unknown } /** @description The person's date of birth. */ dob?: (Partial< { - day: number; - month: number; - year: number; + day: number + month: number + year: number } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** * person_documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -19176,65 +18663,65 @@ export interface operations { documents?: { /** documents_param */ company_authorization?: { - files?: string[]; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } /** documents_param */ passport?: { - files?: string[]; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } /** documents_param */ visa?: { - files?: string[]; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** @description The person's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The person's first name. */ - first_name?: string; + first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - first_name_kana?: string; + first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - first_name_kanji?: string; + first_name_kanji?: string /** @description A list of alternate names or aliases that the person is known by. */ - full_name_aliases?: (Partial & Partial<"">) & { [key: string]: unknown }; + full_name_aliases?: (Partial & Partial<''>) & { [key: string]: unknown } /** @description The person's gender (International regulations require either "male" or "female"). */ - gender?: string; + gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ - id_number?: string; + id_number?: string /** @description The person's last name. */ - last_name?: string; + last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - last_name_kana?: string; + last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - last_name_kanji?: string; + last_name_kanji?: string /** @description The person's maiden name. */ - maiden_name?: string; + maiden_name?: string /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ - nationality?: string; + nationality?: string /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - person_token?: string; + person_token?: string /** @description The person's phone number. */ - phone?: string; + phone?: string /** @description 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?: string; + political_exposure?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - percent_ownership?: (Partial & Partial<"">) & { [key: string]: unknown }; - representative?: boolean; - title?: string; - } & { [key: string]: unknown }; + director?: boolean + executive?: boolean + owner?: boolean + percent_ownership?: (Partial & Partial<''>) & { [key: string]: unknown } + representative?: boolean + title?: string + } & { [key: string]: unknown } /** @description The last four digits of the person's Social Security number (U.S. only). */ - ssn_last_4?: string; + ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -19242,123 +18729,123 @@ export interface operations { verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - } & { [key: string]: unknown }; + back?: string + front?: string + } & { [key: string]: unknown } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; - }; - }; - }; - }; + back?: string + front?: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } + } + } + } + } /**

Retrieves an existing person.

*/ GetAccountsAccountPersonsPerson: { parameters: { path: { - account: string; - person: string; - }; + account: string + person: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates an existing person.

*/ PostAccountsAccountPersonsPerson: { parameters: { path: { - account: string; - person: string; - }; - }; + account: string + person: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * address_specs * @description The person's address. */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } & { [key: string]: unknown } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } & { [key: string]: unknown } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } & { [key: string]: unknown } /** @description The person's date of birth. */ dob?: (Partial< { - day: number; - month: number; - year: number; + day: number + month: number + year: number } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** * person_documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -19366,65 +18853,65 @@ export interface operations { documents?: { /** documents_param */ company_authorization?: { - files?: string[]; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } /** documents_param */ passport?: { - files?: string[]; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } /** documents_param */ visa?: { - files?: string[]; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** @description The person's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The person's first name. */ - first_name?: string; + first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - first_name_kana?: string; + first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - first_name_kanji?: string; + first_name_kanji?: string /** @description A list of alternate names or aliases that the person is known by. */ - full_name_aliases?: (Partial & Partial<"">) & { [key: string]: unknown }; + full_name_aliases?: (Partial & Partial<''>) & { [key: string]: unknown } /** @description The person's gender (International regulations require either "male" or "female"). */ - gender?: string; + gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ - id_number?: string; + id_number?: string /** @description The person's last name. */ - last_name?: string; + last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - last_name_kana?: string; + last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - last_name_kanji?: string; + last_name_kanji?: string /** @description The person's maiden name. */ - maiden_name?: string; + maiden_name?: string /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ - nationality?: string; + nationality?: string /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - person_token?: string; + person_token?: string /** @description The person's phone number. */ - phone?: string; + phone?: string /** @description 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?: string; + political_exposure?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - percent_ownership?: (Partial & Partial<"">) & { [key: string]: unknown }; - representative?: boolean; - title?: string; - } & { [key: string]: unknown }; + director?: boolean + executive?: boolean + owner?: boolean + percent_ownership?: (Partial & Partial<''>) & { [key: string]: unknown } + representative?: boolean + title?: string + } & { [key: string]: unknown } /** @description The last four digits of the person's Social Security number (U.S. only). */ - ssn_last_4?: string; + ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -19432,47 +18919,47 @@ export interface operations { verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - } & { [key: string]: unknown }; + back?: string + front?: string + } & { [key: string]: unknown } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; - }; - }; - }; - }; + back?: string + front?: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } + } + } + } + } /**

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.

*/ DeleteAccountsAccountPersonsPerson: { parameters: { path: { - account: string; - person: string; - }; - }; + account: string + person: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_person"]; - }; - }; + 'application/json': components['schemas']['deleted_person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

With Connect, you may flag accounts as suspicious.

* @@ -19481,252 +18968,252 @@ export interface operations { PostAccountsAccountReject: { parameters: { path: { - account: string; - }; - }; + account: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["account"]; - }; - }; + 'application/json': components['schemas']['account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The reason for rejecting the account. Can be `fraud`, `terms_of_service`, or `other`. */ - reason: string; - }; - }; - }; - }; + reason: string + } + } + } + } /**

List apple pay domains.

*/ GetApplePayDomains: { parameters: { query: { - domain_name?: string; + domain_name?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["apple_pay_domain"][]; + 'application/json': { + data: components['schemas']['apple_pay_domain'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Create an apple pay domain.

*/ PostApplePayDomains: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["apple_pay_domain"]; - }; - }; + 'application/json': components['schemas']['apple_pay_domain'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { - domain_name: string; + 'application/x-www-form-urlencoded': { + domain_name: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Retrieve an apple pay domain.

*/ GetApplePayDomainsDomain: { parameters: { path: { - domain: string; - }; + domain: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["apple_pay_domain"]; - }; - }; + 'application/json': components['schemas']['apple_pay_domain'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Delete an apple pay domain.

*/ DeleteApplePayDomainsDomain: { parameters: { path: { - domain: string; - }; - }; + domain: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_apple_pay_domain"]; - }; - }; + 'application/json': components['schemas']['deleted_apple_pay_domain'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ GetApplicationFees: { parameters: { query: { /** Only return application fees for the charge specified by this charge ID. */ - charge?: string; + charge?: string created?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["application_fee"][]; + 'application/json': { + data: components['schemas']['application_fee'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ GetApplicationFeesFeeRefundsId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - fee: string; - id: string; - }; - }; + fee: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["fee_refund"]; - }; - }; + 'application/json': components['schemas']['fee_refund'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

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

* @@ -19735,146 +19222,146 @@ export interface operations { PostApplicationFeesFeeRefundsId: { parameters: { path: { - fee: string; - id: string; - }; - }; + fee: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["fee_refund"]; - }; - }; + 'application/json': components['schemas']['fee_refund'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; - }; - }; - }; - }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } + } + } + } + } /**

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

*/ GetApplicationFeesId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["application_fee"]; - }; - }; + 'application/json': components['schemas']['application_fee'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } PostApplicationFeesIdRefund: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["application_fee"]; - }; - }; + 'application/json': components['schemas']['application_fee'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { - amount?: number; - directive?: string; + 'application/x-www-form-urlencoded': { + amount?: number + directive?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

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.

*/ GetApplicationFeesIdRefunds: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["fee_refund"][]; + data: components['schemas']['fee_refund'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Refunds an application fee that has previously been collected but not yet refunded. * Funds will be refunded to the Stripe account from which the fee was originally collected.

@@ -19889,36 +19376,36 @@ export interface operations { PostApplicationFeesIdRefunds: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["fee_refund"]; - }; - }; + 'application/json': components['schemas']['fee_refund'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A positive integer, in _%s_, representing how much of this fee to refund. Can refund only up to the remaining unrefunded amount of the fee. */ - amount?: number; + amount?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; - }; - }; - }; - }; + metadata?: { [key: string]: string } + } + } + } + } /** *

Retrieves the current account balance, based on the authentication that was used to make the request. * For a sample request, see Accounting for negative balances.

@@ -19927,29 +19414,29 @@ export interface operations { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["balance"]; - }; - }; + 'application/json': components['schemas']['balance'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

* @@ -19960,62 +19447,62 @@ export interface operations { query: { created?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** 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?: string; + currency?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID. */ - payout?: string; + payout?: string /** Only returns the original transaction. */ - source?: string; + source?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `payment`, `payment_failure_refund`, `payment_refund`, `payout`, `payout_cancel`, `payout_failure`, `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?: string; - }; - }; + type?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["balance_transaction"][]; + 'application/json': { + data: components['schemas']['balance_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Retrieves the balance transaction with the given ID.

* @@ -20025,32 +19512,32 @@ export interface operations { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["balance_transaction"]; - }; - }; + 'application/json': components['schemas']['balance_transaction'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

* @@ -20061,62 +19548,62 @@ export interface operations { query: { created?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** 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?: string; + currency?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID. */ - payout?: string; + payout?: string /** Only returns the original transaction. */ - source?: string; + source?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `payment`, `payment_failure_refund`, `payment_refund`, `payout`, `payout_cancel`, `payout_failure`, `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?: string; - }; - }; + type?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["balance_transaction"][]; + 'application/json': { + data: components['schemas']['balance_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Retrieves the balance transaction with the given ID.

* @@ -20126,113 +19613,113 @@ export interface operations { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["balance_transaction"]; - }; - }; + 'application/json': components['schemas']['balance_transaction'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ GetBillingPortalConfigurations: { parameters: { query: { /** Only return configurations that are active or inactive (e.g., pass `true` to only list active configurations). */ - active?: boolean; + active?: boolean /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** Only return the default or non-default configurations (e.g., pass `true` to only list the default configuration). */ - is_default?: boolean; + is_default?: boolean /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["billing_portal.configuration"][]; + 'application/json': { + data: components['schemas']['billing_portal.configuration'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostBillingPortalConfigurations: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["billing_portal.configuration"]; - }; - }; + 'application/json': components['schemas']['billing_portal.configuration'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * business_profile_create_param * @description The business information shown to customers in the portal. */ business_profile: { - headline?: string; - privacy_policy_url: string; - terms_of_service_url: string; - } & { [key: string]: unknown }; + headline?: string + privacy_policy_url: string + terms_of_service_url: string + } & { [key: string]: unknown } /** @description 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?: (Partial & Partial<"">) & { [key: string]: unknown }; + default_return_url?: (Partial & Partial<''>) & { [key: string]: unknown } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * features_creation_param * @description Information about the features available in the portal. @@ -20240,141 +19727,137 @@ export interface operations { features: { /** customer_update_creation_param */ customer_update?: { - allowed_updates: (Partial<("address" | "email" | "phone" | "shipping" | "tax_id")[]> & Partial<"">) & { - [key: string]: unknown; - }; - enabled: boolean; - } & { [key: string]: unknown }; + allowed_updates: (Partial<('address' | 'email' | 'phone' | 'shipping' | 'tax_id')[]> & Partial<''>) & { [key: string]: unknown } + enabled: boolean + } & { [key: string]: unknown } /** invoice_list_param */ invoice_history?: { - enabled: boolean; - } & { [key: string]: unknown }; + enabled: boolean + } & { [key: string]: unknown } /** payment_method_update_param */ payment_method_update?: { - enabled: boolean; - } & { [key: string]: unknown }; + enabled: boolean + } & { [key: string]: unknown } /** subscription_cancel_creation_param */ subscription_cancel?: { /** subscription_cancellation_reason_creation_param */ cancellation_reason?: { - enabled: boolean; + enabled: boolean options: (Partial< ( - | "customer_service" - | "low_quality" - | "missing_features" - | "other" - | "switched_service" - | "too_complex" - | "too_expensive" - | "unused" + | 'customer_service' + | 'low_quality' + | 'missing_features' + | 'other' + | 'switched_service' + | 'too_complex' + | 'too_expensive' + | 'unused' )[] > & - Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown }; - enabled: boolean; + Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown } + enabled: boolean /** @enum {string} */ - mode?: "at_period_end" | "immediately"; + mode?: 'at_period_end' | 'immediately' /** @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; - } & { [key: string]: unknown }; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' + } & { [key: string]: unknown } /** subscription_pause_param */ subscription_pause?: { - enabled?: boolean; - } & { [key: string]: unknown }; + enabled?: boolean + } & { [key: string]: unknown } /** subscription_update_creation_param */ subscription_update?: { - default_allowed_updates: (Partial<("price" | "promotion_code" | "quantity")[]> & Partial<"">) & { - [key: string]: unknown; - }; - enabled: boolean; + default_allowed_updates: (Partial<('price' | 'promotion_code' | 'quantity')[]> & Partial<''>) & { [key: string]: unknown } + enabled: boolean products: (Partial< ({ - prices: string[]; - product: string; + prices: string[] + product: string } & { [key: string]: unknown })[] > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** @description 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?: { [key: string]: string }; - }; - }; - }; - }; + metadata?: { [key: string]: string } + } + } + } + } /**

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

*/ GetBillingPortalConfigurationsConfiguration: { parameters: { path: { - configuration: string; - }; + configuration: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["billing_portal.configuration"]; - }; - }; + 'application/json': components['schemas']['billing_portal.configuration'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostBillingPortalConfigurationsConfiguration: { parameters: { path: { - configuration: string; - }; - }; + configuration: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["billing_portal.configuration"]; - }; - }; + 'application/json': components['schemas']['billing_portal.configuration'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether the configuration is active and can be used to create portal sessions. */ - active?: boolean; + active?: boolean /** * business_profile_update_param * @description The business information shown to customers in the portal. */ business_profile?: { - headline?: string; - privacy_policy_url?: string; - terms_of_service_url?: string; - } & { [key: string]: unknown }; + headline?: string + privacy_policy_url?: string + terms_of_service_url?: string + } & { [key: string]: unknown } /** @description 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?: (Partial & Partial<"">) & { [key: string]: unknown }; + default_return_url?: (Partial & Partial<''>) & { [key: string]: unknown } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * features_updating_param * @description Information about the features available in the portal. @@ -20382,465 +19865,461 @@ export interface operations { features?: { /** customer_update_updating_param */ customer_update?: { - allowed_updates?: (Partial<("address" | "email" | "phone" | "shipping" | "tax_id")[]> & Partial<"">) & { - [key: string]: unknown; - }; - enabled?: boolean; - } & { [key: string]: unknown }; + allowed_updates?: (Partial<('address' | 'email' | 'phone' | 'shipping' | 'tax_id')[]> & Partial<''>) & { [key: string]: unknown } + enabled?: boolean + } & { [key: string]: unknown } /** invoice_list_param */ invoice_history?: { - enabled: boolean; - } & { [key: string]: unknown }; + enabled: boolean + } & { [key: string]: unknown } /** payment_method_update_param */ payment_method_update?: { - enabled: boolean; - } & { [key: string]: unknown }; + enabled: boolean + } & { [key: string]: unknown } /** subscription_cancel_updating_param */ subscription_cancel?: { /** subscription_cancellation_reason_updating_param */ cancellation_reason?: { - enabled: boolean; + enabled: boolean options?: (Partial< ( - | "customer_service" - | "low_quality" - | "missing_features" - | "other" - | "switched_service" - | "too_complex" - | "too_expensive" - | "unused" + | 'customer_service' + | 'low_quality' + | 'missing_features' + | 'other' + | 'switched_service' + | 'too_complex' + | 'too_expensive' + | 'unused' )[] > & - Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown }; - enabled?: boolean; + Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown } + enabled?: boolean /** @enum {string} */ - mode?: "at_period_end" | "immediately"; + mode?: 'at_period_end' | 'immediately' /** @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; - } & { [key: string]: unknown }; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' + } & { [key: string]: unknown } /** subscription_pause_param */ subscription_pause?: { - enabled?: boolean; - } & { [key: string]: unknown }; + enabled?: boolean + } & { [key: string]: unknown } /** subscription_update_updating_param */ subscription_update?: { - default_allowed_updates?: (Partial<("price" | "promotion_code" | "quantity")[]> & Partial<"">) & { - [key: string]: unknown; - }; - enabled?: boolean; + default_allowed_updates?: (Partial<('price' | 'promotion_code' | 'quantity')[]> & Partial<''>) & { [key: string]: unknown } + enabled?: boolean products?: (Partial< ({ - prices: string[]; - product: string; + prices: string[] + product: string } & { [key: string]: unknown })[] > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; - }; - }; - }; - }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } + } + } + } + } /**

Creates a session of the customer portal.

*/ PostBillingPortalSessions: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["billing_portal.session"]; - }; - }; + 'application/json': components['schemas']['billing_portal.session'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The ID of an existing [configuration](https://stripe.com/docs/api/customer_portal/configuration) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration. */ - configuration?: string; + configuration?: string /** @description The ID of an existing customer. */ - customer: string; + customer: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * @description 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. * @enum {string} */ locale?: - | "auto" - | "bg" - | "cs" - | "da" - | "de" - | "el" - | "en" - | "en-AU" - | "en-CA" - | "en-GB" - | "en-IE" - | "en-IN" - | "en-NZ" - | "en-SG" - | "es" - | "es-419" - | "et" - | "fi" - | "fil" - | "fr" - | "fr-CA" - | "hr" - | "hu" - | "id" - | "it" - | "ja" - | "ko" - | "lt" - | "lv" - | "ms" - | "mt" - | "nb" - | "nl" - | "pl" - | "pt" - | "pt-BR" - | "ro" - | "ru" - | "sk" - | "sl" - | "sv" - | "th" - | "tr" - | "vi" - | "zh" - | "zh-HK" - | "zh-TW"; + | 'auto' + | 'bg' + | 'cs' + | 'da' + | 'de' + | 'el' + | 'en' + | 'en-AU' + | 'en-CA' + | 'en-GB' + | 'en-IE' + | 'en-IN' + | 'en-NZ' + | 'en-SG' + | 'es' + | 'es-419' + | 'et' + | 'fi' + | 'fil' + | 'fr' + | 'fr-CA' + | 'hr' + | 'hu' + | 'id' + | 'it' + | 'ja' + | 'ko' + | 'lt' + | 'lv' + | 'ms' + | 'mt' + | 'nb' + | 'nl' + | 'pl' + | 'pt' + | 'pt-BR' + | 'ro' + | 'ru' + | 'sk' + | 'sl' + | 'sv' + | 'th' + | 'tr' + | 'vi' + | 'zh' + | 'zh-HK' + | 'zh-TW' /** @description The `on_behalf_of` account to use for this session. 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/charges-transfers#on-behalf-of). 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?: string; + on_behalf_of?: string /** @description The default URL to redirect customers to when they click on the portal's link to return to your website. */ - return_url?: string; - }; - }; - }; - }; + return_url?: string + } + } + } + } /**

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

*/ GetBitcoinReceivers: { parameters: { query: { /** Filter for active receivers. */ - active?: boolean; + active?: boolean /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** Filter for filled receivers. */ - filled?: boolean; + filled?: boolean /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Filter for receivers with uncaptured funds. */ - uncaptured_funds?: boolean; - }; - }; + uncaptured_funds?: boolean + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["bitcoin_receiver"][]; + 'application/json': { + data: components['schemas']['bitcoin_receiver'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves the Bitcoin receiver with the given ID.

*/ GetBitcoinReceiversId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["bitcoin_receiver"]; - }; - }; + 'application/json': components['schemas']['bitcoin_receiver'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

List bitcoin transacitons for a given receiver.

*/ GetBitcoinReceiversReceiverTransactions: { parameters: { query: { /** Only return transactions for the customer specified by this customer ID. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - receiver: string; - }; - }; + receiver: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["bitcoin_transaction"][]; + data: components['schemas']['bitcoin_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

List bitcoin transacitons for a given receiver.

*/ GetBitcoinTransactions: { parameters: { query: { /** Only return transactions for the customer specified by this customer ID. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; - receiver?: string; + limit?: number + receiver?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["bitcoin_transaction"][]; + data: components['schemas']['bitcoin_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ GetCharges: { parameters: { query: { created?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** Only return charges for the customer specified by this customer ID. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return charges that were created by the PaymentIntent specified by this PaymentIntent ID. */ - payment_intent?: string; + payment_intent?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return charges for this transfer group. */ - transfer_group?: string; - }; - }; + transfer_group?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["charge"][]; + 'application/json': { + data: components['schemas']['charge'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

To charge a credit card or other payment source, you create a Charge object. If your API key is in test mode, the supplied payment source (e.g., card) won’t actually be charged, although everything else will occur as if in live mode. (Stripe assumes that the charge would have completed successfully).

*/ PostCharges: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["charge"]; - }; - }; + 'application/json': components['schemas']['charge'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description 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?: number; - application_fee?: number; + amount?: number + application_fee?: number /** @description A fee in %s that will be applied to the charge and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the `Stripe-Account` header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees). */ - application_fee_amount?: number; + application_fee_amount?: number /** @description Whether to immediately capture the charge. Defaults to `true`. When `false`, the charge issues an authorization (or pre-authorization), and will need to be [captured](https://stripe.com/docs/api#capture_charge) later. Uncaptured charges expire after a set number of days (7 by default). For more information, see the [authorizing charges and settling later](https://stripe.com/docs/charges/placing-a-hold) documentation. */ - capture?: boolean; + capture?: boolean /** @description A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js). */ card?: (Partial< { - address_city?: string; - address_country?: string; - address_line1?: string; - address_line2?: string; - address_state?: string; - address_zip?: string; - cvc?: string; - exp_month: number; - exp_year: number; - metadata?: { [key: string]: string }; - name?: string; - number: string; + address_city?: string + address_country?: string + address_line1?: string + address_line2?: string + address_state?: string + address_zip?: string + cvc?: string + exp_month: number + exp_year: number + metadata?: { [key: string]: string } + name?: string + number: string /** @enum {string} */ - object?: "card"; + object?: 'card' } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** @description 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?: string; + currency?: string /** @description The ID of an existing customer that will be charged in this request. */ - customer?: string; + customer?: string /** @description An arbitrary string which you can attach to a `Charge` object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the `description` of the charge(s) that they are describing. */ - description?: string; + description?: string destination?: (Partial< { - account: string; - amount?: number; + account: string + amount?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description The Stripe account ID for which these funds are intended. Automatically set if you use the `destination` parameter. For details, see [Creating Separate Charges and Transfers](https://stripe.com/docs/connect/charges-transfers#on-behalf-of). */ - on_behalf_of?: string; + on_behalf_of?: string /** @description The email address to which this charge's [receipt](https://stripe.com/docs/dashboard/receipts) will be sent. The receipt will not be sent until the charge is paid, and no receipts will be sent for test mode charges. If this charge is for a [Customer](https://stripe.com/docs/api/customers/object), the email address specified here will override the customer's email address. If `receipt_email` is specified for a charge in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails). */ - receipt_email?: string; + receipt_email?: string /** * optional_fields_shipping * @description Shipping information for the charge. Helps prevent fraud on charges for physical goods. @@ -20848,111 +20327,111 @@ export interface operations { shipping?: { /** optional_fields_address */ address: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - } & { [key: string]: unknown }; - carrier?: string; - name: string; - phone?: string; - tracking_number?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } & { [key: string]: unknown } + carrier?: string + name: string + phone?: string + tracking_number?: string + } & { [key: string]: unknown } /** @description A payment source to be charged. This can be the ID of a [card](https://stripe.com/docs/api#cards) (i.e., credit or debit card), a [bank account](https://stripe.com/docs/api#bank_accounts), a [source](https://stripe.com/docs/api#sources), a [token](https://stripe.com/docs/api#tokens), or a [connected account](https://stripe.com/docs/connect/account-debits#charging-a-connected-account). For certain sources---namely, [cards](https://stripe.com/docs/api#cards), [bank accounts](https://stripe.com/docs/api#bank_accounts), and attached [sources](https://stripe.com/docs/api#sources)---you must also pass the ID of the associated customer. */ - source?: string; + source?: string /** @description For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - statement_descriptor_suffix?: string; + statement_descriptor_suffix?: string /** * transfer_data_specs * @description 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?: { - amount?: number; - destination: string; - } & { [key: string]: unknown }; + amount?: number + destination: string + } & { [key: string]: unknown } /** @description A string that identifies this transaction as part of a group. For details, see [Grouping transactions](https://stripe.com/docs/connect/charges-transfers#transfer-options). */ - transfer_group?: string; - }; - }; - }; - }; + transfer_group?: string + } + } + } + } /**

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.

*/ GetChargesCharge: { parameters: { path: { - charge: string; - }; + charge: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["charge"]; - }; - }; + 'application/json': components['schemas']['charge'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostChargesCharge: { parameters: { path: { - charge: string; - }; - }; + charge: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["charge"]; - }; - }; + 'application/json': components['schemas']['charge'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The ID of an existing customer that will be associated with this request. This field may only be updated if there is no existing associated customer with this charge. */ - customer?: string; + customer?: string /** @description An arbitrary string which you can attach to a charge object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the `description` of the charge(s) that they are describing. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * fraud_details * @description A set of key-value pairs you can attach to a charge giving information about its riskiness. If you believe a charge is fraudulent, include a `user_report` key with a value of `fraudulent`. If you believe a charge is safe, include a `user_report` key with a value of `safe`. Stripe will use the information you send to improve our fraud detection algorithms. */ fraud_details?: { /** @enum {string} */ - user_report: "" | "fraudulent" | "safe"; - } & { [key: string]: unknown }; + user_report: '' | 'fraudulent' | 'safe' + } & { [key: string]: unknown } /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description This is the email address that the receipt for this charge will be sent to. If this field is updated, then a new email receipt will be sent to the updated address. */ - receipt_email?: string; + receipt_email?: string /** * optional_fields_shipping * @description Shipping information for the charge. Helps prevent fraud on charges for physical goods. @@ -20960,24 +20439,24 @@ export interface operations { shipping?: { /** optional_fields_address */ address: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - } & { [key: string]: unknown }; - carrier?: string; - name: string; - phone?: string; - tracking_number?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } & { [key: string]: unknown } + carrier?: string + name: string + phone?: string + tracking_number?: string + } & { [key: string]: unknown } /** @description A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-options) for details. */ - transfer_group?: string; - }; - }; - }; - }; + transfer_group?: string + } + } + } + } /** *

Capture the payment of an existing, uncaptured, charge. This is the second half of the two-step payment flow, where first you created a charge with the capture option set to false.

* @@ -20986,179 +20465,179 @@ export interface operations { PostChargesChargeCapture: { parameters: { path: { - charge: string; - }; - }; + charge: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["charge"]; - }; - }; + 'application/json': components['schemas']['charge'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The amount to capture, which must be less than or equal to the original amount. Any additional amount will be automatically refunded. */ - amount?: number; + amount?: number /** @description An application fee to add on to this charge. */ - application_fee?: number; + application_fee?: number /** @description An application fee amount to add on to this charge, which must be less than or equal to the original amount. */ - application_fee_amount?: number; + application_fee_amount?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The email address to send this charge's receipt to. This will override the previously-specified email address for this charge, if one was set. Receipts will not be sent in test mode. */ - receipt_email?: string; + receipt_email?: string /** @description For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - statement_descriptor_suffix?: string; + statement_descriptor_suffix?: string /** * transfer_data_specs * @description 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?: { - amount?: number; - } & { [key: string]: unknown }; + amount?: number + } & { [key: string]: unknown } /** @description A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-options) for details. */ - transfer_group?: string; - }; - }; - }; - }; + transfer_group?: string + } + } + } + } /**

Retrieve a dispute for a specified charge.

*/ GetChargesChargeDispute: { parameters: { path: { - charge: string; - }; + charge: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["dispute"]; - }; - }; + 'application/json': components['schemas']['dispute'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } PostChargesChargeDispute: { parameters: { path: { - charge: string; - }; - }; + charge: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["dispute"]; - }; - }; + 'application/json': components['schemas']['dispute'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * dispute_evidence_params * @description Evidence to upload, to respond to a dispute. Updating any field in the hash will submit all fields in the hash for review. The combined character count of all fields is limited to 150,000. */ evidence?: { - access_activity_log?: string; - billing_address?: string; - cancellation_policy?: string; - cancellation_policy_disclosure?: string; - cancellation_rebuttal?: string; - customer_communication?: string; - customer_email_address?: string; - customer_name?: string; - customer_purchase_ip?: string; - customer_signature?: string; - duplicate_charge_documentation?: string; - duplicate_charge_explanation?: string; - duplicate_charge_id?: string; - product_description?: string; - receipt?: string; - refund_policy?: string; - refund_policy_disclosure?: string; - refund_refusal_explanation?: string; - service_date?: string; - service_documentation?: string; - shipping_address?: string; - shipping_carrier?: string; - shipping_date?: string; - shipping_documentation?: string; - shipping_tracking_number?: string; - uncategorized_file?: string; - uncategorized_text?: string; - } & { [key: string]: unknown }; + access_activity_log?: string + billing_address?: string + cancellation_policy?: string + cancellation_policy_disclosure?: string + cancellation_rebuttal?: string + customer_communication?: string + customer_email_address?: string + customer_name?: string + customer_purchase_ip?: string + customer_signature?: string + duplicate_charge_documentation?: string + duplicate_charge_explanation?: string + duplicate_charge_id?: string + product_description?: string + receipt?: string + refund_policy?: string + refund_policy_disclosure?: string + refund_refusal_explanation?: string + service_date?: string + service_documentation?: string + shipping_address?: string + shipping_carrier?: string + shipping_date?: string + shipping_documentation?: string + shipping_tracking_number?: string + uncategorized_file?: string + uncategorized_text?: string + } & { [key: string]: unknown } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description Whether to immediately submit evidence to the bank. If `false`, evidence is staged on the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank by making another request with this attribute set to `true` (the default). */ - submit?: boolean; - }; - }; - }; - }; + submit?: boolean + } + } + } + } PostChargesChargeDisputeClose: { parameters: { path: { - charge: string; - }; - }; + charge: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["dispute"]; - }; - }; + 'application/json': components['schemas']['dispute'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /** *

When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.

* @@ -21175,259 +20654,259 @@ export interface operations { PostChargesChargeRefund: { parameters: { path: { - charge: string; - }; - }; + charge: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["charge"]; - }; - }; + 'application/json': components['schemas']['charge'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { - amount?: number; + 'application/x-www-form-urlencoded': { + amount?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; - payment_intent?: string; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } + payment_intent?: string /** @enum {string} */ - reason?: "duplicate" | "fraudulent" | "requested_by_customer"; - refund_application_fee?: boolean; - reverse_transfer?: boolean; - }; - }; - }; - }; + reason?: 'duplicate' | 'fraudulent' | 'requested_by_customer' + refund_application_fee?: boolean + reverse_transfer?: boolean + } + } + } + } /**

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.

*/ GetChargesChargeRefunds: { parameters: { path: { - charge: string; - }; + charge: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["refund"][]; + data: components['schemas']['refund'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Create a refund.

*/ PostChargesChargeRefunds: { parameters: { path: { - charge: string; - }; - }; + charge: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["refund"]; - }; - }; + 'application/json': components['schemas']['refund'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { - amount?: number; + 'application/x-www-form-urlencoded': { + amount?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; - payment_intent?: string; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } + payment_intent?: string /** @enum {string} */ - reason?: "duplicate" | "fraudulent" | "requested_by_customer"; - refund_application_fee?: boolean; - reverse_transfer?: boolean; - }; - }; - }; - }; + reason?: 'duplicate' | 'fraudulent' | 'requested_by_customer' + refund_application_fee?: boolean + reverse_transfer?: boolean + } + } + } + } /**

Retrieves the details of an existing refund.

*/ GetChargesChargeRefundsRefund: { parameters: { path: { - charge: string; - refund: string; - }; + charge: string + refund: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["refund"]; - }; - }; + 'application/json': components['schemas']['refund'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Update a specified refund.

*/ PostChargesChargeRefundsRefund: { parameters: { path: { - charge: string; - refund: string; - }; - }; + charge: string + refund: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["refund"]; - }; - }; + 'application/json': components['schemas']['refund'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - metadata?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; - }; - }; - }; - }; + expand?: string[] + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } + } + } + } + } /**

Returns a list of Checkout Sessions.

*/ GetCheckoutSessions: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return the Checkout Session for the PaymentIntent specified. */ - payment_intent?: string; + payment_intent?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return the Checkout Session for the subscription specified. */ - subscription?: string; - }; - }; + subscription?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["checkout.session"][]; + 'application/json': { + data: components['schemas']['checkout.session'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a Session object.

*/ PostCheckoutSessions: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["checkout.session"]; - }; - }; + 'application/json': components['schemas']['checkout.session'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * after_expiration_params * @description Configure actions after a Checkout Session has expired. @@ -21435,40 +20914,40 @@ export interface operations { after_expiration?: { /** recovery_params */ recovery?: { - allow_promotion_codes?: boolean; - enabled: boolean; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + allow_promotion_codes?: boolean + enabled: boolean + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** @description Enables user redeemable promotion codes. */ - allow_promotion_codes?: boolean; + allow_promotion_codes?: boolean /** * automatic_tax_params * @description Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions. */ automatic_tax?: { - enabled: boolean; - } & { [key: string]: unknown }; + enabled: boolean + } & { [key: string]: unknown } /** * @description Specify whether Checkout should collect the customer's billing address. * @enum {string} */ - billing_address_collection?: "auto" | "required"; + billing_address_collection?: 'auto' | 'required' /** @description The URL the customer will be directed to if they decide to cancel payment and return to your website. */ - cancel_url: string; + cancel_url: string /** * @description A unique string to reference the Checkout Session. This can be a * customer ID, a cart ID, or similar, and can be used to reconcile the * session with your internal systems. */ - client_reference_id?: string; + client_reference_id?: string /** * consent_collection_params * @description Configure fields for the Checkout Session to gather active consent from customers. */ consent_collection?: { /** @enum {string} */ - promotions?: "auto"; - } & { [key: string]: unknown }; + promotions?: 'auto' + } & { [key: string]: unknown } /** * @description ID of an existing Customer, if one exists. In `payment` mode, the customer’s most recent card * payment method will be used to prefill the email, name, card details, and billing address @@ -21482,7 +20961,7 @@ export interface operations { * * You can set [`payment_intent_data.setup_future_usage`](https://stripe.com/docs/api/checkout/sessions/create#create_checkout_session-payment_intent_data-setup_future_usage) to have Checkout automatically attach the payment method to the Customer you pass in for future reuse. */ - customer?: string; + customer?: string /** * @description Configure whether a Checkout Session creates a [Customer](https://stripe.com/docs/api/customers) during Session confirmation. * @@ -21494,7 +20973,7 @@ export interface operations { * Can only be set in `payment` and `setup` mode. * @enum {string} */ - customer_creation?: "always" | "if_required"; + customer_creation?: 'always' | 'if_required' /** * @description 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. @@ -21502,31 +20981,31 @@ export interface operations { * on file. To access information about the customer once a session is * complete, use the `customer` field. */ - customer_email?: string; + customer_email?: string /** * customer_update_params * @description Controls what fields on Customer can be updated by the Checkout Session. Can only be provided when `customer` is provided. */ customer_update?: { /** @enum {string} */ - address?: "auto" | "never"; + address?: 'auto' | 'never' /** @enum {string} */ - name?: "auto" | "never"; + name?: 'auto' | 'never' /** @enum {string} */ - shipping?: "auto" | "never"; - } & { [key: string]: unknown }; + shipping?: 'auto' | 'never' + } & { [key: string]: unknown } /** @description The coupon or promotion code to apply to this Session. Currently, only up to one may be specified. */ discounts?: ({ - coupon?: string; - promotion_code?: string; - } & { [key: string]: unknown })[]; + coupon?: string + promotion_code?: string + } & { [key: string]: unknown })[] /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * Format: unix-time * @description The Epoch time in seconds at which the Checkout Session will expire. It can be anywhere from 1 to 24 hours after Checkout Session creation. By default, this value is 24 hours from creation. */ - expires_at?: number; + expires_at?: number /** * @description A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices). * @@ -21537,132 +21016,132 @@ export interface operations { line_items?: ({ /** adjustable_quantity_params */ adjustable_quantity?: { - enabled: boolean; - maximum?: number; - minimum?: number; - } & { [key: string]: unknown }; - description?: string; - dynamic_tax_rates?: string[]; - price?: string; + enabled: boolean + maximum?: number + minimum?: number + } & { [key: string]: unknown } + description?: string + dynamic_tax_rates?: string[] + price?: string /** price_data_with_product_data */ price_data?: { - currency: string; - product?: string; + currency: string + product?: string /** product_data */ product_data?: { - description?: string; - images?: string[]; - metadata?: { [key: string]: string }; - name: string; - tax_code?: string; - } & { [key: string]: unknown }; + description?: string + images?: string[] + metadata?: { [key: string]: string } + name: string + tax_code?: string + } & { [key: string]: unknown } /** recurring_adhoc */ recurring?: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - } & { [key: string]: unknown }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } & { [key: string]: unknown } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - } & { [key: string]: unknown }; - quantity?: number; - tax_rates?: string[]; - } & { [key: string]: unknown })[]; + unit_amount_decimal?: string + } & { [key: string]: unknown } + quantity?: number + tax_rates?: string[] + } & { [key: string]: unknown })[] /** * @description The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used. * @enum {string} */ locale?: - | "auto" - | "bg" - | "cs" - | "da" - | "de" - | "el" - | "en" - | "en-GB" - | "es" - | "es-419" - | "et" - | "fi" - | "fil" - | "fr" - | "fr-CA" - | "hr" - | "hu" - | "id" - | "it" - | "ja" - | "ko" - | "lt" - | "lv" - | "ms" - | "mt" - | "nb" - | "nl" - | "pl" - | "pt" - | "pt-BR" - | "ro" - | "ru" - | "sk" - | "sl" - | "sv" - | "th" - | "tr" - | "vi" - | "zh" - | "zh-HK" - | "zh-TW"; + | 'auto' + | 'bg' + | 'cs' + | 'da' + | 'de' + | 'el' + | 'en' + | 'en-GB' + | 'es' + | 'es-419' + | 'et' + | 'fi' + | 'fil' + | 'fr' + | 'fr-CA' + | 'hr' + | 'hu' + | 'id' + | 'it' + | 'ja' + | 'ko' + | 'lt' + | 'lv' + | 'ms' + | 'mt' + | 'nb' + | 'nl' + | 'pl' + | 'pt' + | 'pt-BR' + | 'ro' + | 'ru' + | 'sk' + | 'sl' + | 'sv' + | 'th' + | 'tr' + | 'vi' + | 'zh' + | 'zh-HK' + | 'zh-TW' /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * @description The mode of the Checkout Session. Required when using prices or `setup` mode. Pass `subscription` if the Checkout Session includes at least one recurring item. * @enum {string} */ - mode?: "payment" | "setup" | "subscription"; + mode?: 'payment' | 'setup' | 'subscription' /** * payment_intent_data_params * @description A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode. */ payment_intent_data?: { - application_fee_amount?: number; + application_fee_amount?: number /** @enum {string} */ - capture_method?: "automatic" | "manual"; - description?: string; - metadata?: { [key: string]: string }; - on_behalf_of?: string; - receipt_email?: string; + capture_method?: 'automatic' | 'manual' + description?: string + metadata?: { [key: string]: string } + on_behalf_of?: string + receipt_email?: string /** @enum {string} */ - setup_future_usage?: "off_session" | "on_session"; + setup_future_usage?: 'off_session' | 'on_session' /** shipping */ shipping?: { /** address */ address: { - city?: string; - country?: string; - line1: string; - line2?: string; - postal_code?: string; - state?: string; - } & { [key: string]: unknown }; - carrier?: string; - name: string; - phone?: string; - tracking_number?: string; - } & { [key: string]: unknown }; - statement_descriptor?: string; - statement_descriptor_suffix?: string; + city?: string + country?: string + line1: string + line2?: string + postal_code?: string + state?: string + } & { [key: string]: unknown } + carrier?: string + name: string + phone?: string + tracking_number?: string + } & { [key: string]: unknown } + statement_descriptor?: string + statement_descriptor_suffix?: string /** transfer_data_params */ transfer_data?: { - amount?: number; - destination: string; - } & { [key: string]: unknown }; - transfer_group?: string; - } & { [key: string]: unknown }; + amount?: number + destination: string + } & { [key: string]: unknown } + transfer_group?: string + } & { [key: string]: unknown } /** * payment_method_options_param * @description Payment-method-specific configuration. @@ -21671,35 +21150,35 @@ export interface operations { /** payment_method_options_param */ acss_debit?: { /** @enum {string} */ - currency?: "cad" | "usd"; + currency?: 'cad' | 'usd' /** mandate_options_param */ mandate_options?: { - custom_mandate_url?: (Partial & Partial<"">) & { [key: string]: unknown }; - default_for?: ("invoice" | "subscription")[]; - interval_description?: string; + custom_mandate_url?: (Partial & Partial<''>) & { [key: string]: unknown } + default_for?: ('invoice' | 'subscription')[] + interval_description?: string /** @enum {string} */ - payment_schedule?: "combined" | "interval" | "sporadic"; + payment_schedule?: 'combined' | 'interval' | 'sporadic' /** @enum {string} */ - transaction_type?: "business" | "personal"; - } & { [key: string]: unknown }; + transaction_type?: 'business' | 'personal' + } & { [key: string]: unknown } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; - } & { [key: string]: unknown }; + verification_method?: 'automatic' | 'instant' | 'microdeposits' + } & { [key: string]: unknown } /** payment_method_options_param */ boleto?: { - expires_after_days?: number; - } & { [key: string]: unknown }; + expires_after_days?: number + } & { [key: string]: unknown } /** payment_method_options_param */ oxxo?: { - expires_after_days?: number; - } & { [key: string]: unknown }; + expires_after_days?: number + } & { [key: string]: unknown } /** payment_method_options_param */ wechat_pay?: { - app_id?: string; + app_id?: string /** @enum {string} */ - client: "android" | "ios" | "web"; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + client: 'android' | 'ios' | 'web' + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** * @description A list of the types of payment methods (e.g., `card`) this Checkout Session can accept. * @@ -21711,26 +21190,26 @@ export interface operations { * other characteristics. */ payment_method_types?: ( - | "acss_debit" - | "afterpay_clearpay" - | "alipay" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "eps" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "klarna" - | "oxxo" - | "p24" - | "sepa_debit" - | "sofort" - | "wechat_pay" - )[]; + | 'acss_debit' + | 'afterpay_clearpay' + | 'alipay' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'eps' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'klarna' + | 'oxxo' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' + )[] /** * phone_number_collection_params * @description Controls phone number collection settings for the session. @@ -21739,265 +21218,265 @@ export interface operations { * before using this feature. Learn more about [collecting phone numbers with Checkout](https://stripe.com/docs/payments/checkout/phone-numbers). */ phone_number_collection?: { - enabled: boolean; - } & { [key: string]: unknown }; + enabled: boolean + } & { [key: string]: unknown } /** * setup_intent_data_param * @description A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in `setup` mode. */ setup_intent_data?: { - description?: string; - metadata?: { [key: string]: string }; - on_behalf_of?: string; - } & { [key: string]: unknown }; + description?: string + metadata?: { [key: string]: string } + on_behalf_of?: string + } & { [key: string]: unknown } /** * shipping_address_collection_params * @description When set, provides configuration for Checkout to collect a shipping address from a customer. */ shipping_address_collection?: { allowed_countries: ( - | "AC" - | "AD" - | "AE" - | "AF" - | "AG" - | "AI" - | "AL" - | "AM" - | "AO" - | "AQ" - | "AR" - | "AT" - | "AU" - | "AW" - | "AX" - | "AZ" - | "BA" - | "BB" - | "BD" - | "BE" - | "BF" - | "BG" - | "BH" - | "BI" - | "BJ" - | "BL" - | "BM" - | "BN" - | "BO" - | "BQ" - | "BR" - | "BS" - | "BT" - | "BV" - | "BW" - | "BY" - | "BZ" - | "CA" - | "CD" - | "CF" - | "CG" - | "CH" - | "CI" - | "CK" - | "CL" - | "CM" - | "CN" - | "CO" - | "CR" - | "CV" - | "CW" - | "CY" - | "CZ" - | "DE" - | "DJ" - | "DK" - | "DM" - | "DO" - | "DZ" - | "EC" - | "EE" - | "EG" - | "EH" - | "ER" - | "ES" - | "ET" - | "FI" - | "FJ" - | "FK" - | "FO" - | "FR" - | "GA" - | "GB" - | "GD" - | "GE" - | "GF" - | "GG" - | "GH" - | "GI" - | "GL" - | "GM" - | "GN" - | "GP" - | "GQ" - | "GR" - | "GS" - | "GT" - | "GU" - | "GW" - | "GY" - | "HK" - | "HN" - | "HR" - | "HT" - | "HU" - | "ID" - | "IE" - | "IL" - | "IM" - | "IN" - | "IO" - | "IQ" - | "IS" - | "IT" - | "JE" - | "JM" - | "JO" - | "JP" - | "KE" - | "KG" - | "KH" - | "KI" - | "KM" - | "KN" - | "KR" - | "KW" - | "KY" - | "KZ" - | "LA" - | "LB" - | "LC" - | "LI" - | "LK" - | "LR" - | "LS" - | "LT" - | "LU" - | "LV" - | "LY" - | "MA" - | "MC" - | "MD" - | "ME" - | "MF" - | "MG" - | "MK" - | "ML" - | "MM" - | "MN" - | "MO" - | "MQ" - | "MR" - | "MS" - | "MT" - | "MU" - | "MV" - | "MW" - | "MX" - | "MY" - | "MZ" - | "NA" - | "NC" - | "NE" - | "NG" - | "NI" - | "NL" - | "NO" - | "NP" - | "NR" - | "NU" - | "NZ" - | "OM" - | "PA" - | "PE" - | "PF" - | "PG" - | "PH" - | "PK" - | "PL" - | "PM" - | "PN" - | "PR" - | "PS" - | "PT" - | "PY" - | "QA" - | "RE" - | "RO" - | "RS" - | "RU" - | "RW" - | "SA" - | "SB" - | "SC" - | "SE" - | "SG" - | "SH" - | "SI" - | "SJ" - | "SK" - | "SL" - | "SM" - | "SN" - | "SO" - | "SR" - | "SS" - | "ST" - | "SV" - | "SX" - | "SZ" - | "TA" - | "TC" - | "TD" - | "TF" - | "TG" - | "TH" - | "TJ" - | "TK" - | "TL" - | "TM" - | "TN" - | "TO" - | "TR" - | "TT" - | "TV" - | "TW" - | "TZ" - | "UA" - | "UG" - | "US" - | "UY" - | "UZ" - | "VA" - | "VC" - | "VE" - | "VG" - | "VN" - | "VU" - | "WF" - | "WS" - | "XK" - | "YE" - | "YT" - | "ZA" - | "ZM" - | "ZW" - | "ZZ" - )[]; - } & { [key: string]: unknown }; + | 'AC' + | 'AD' + | 'AE' + | 'AF' + | 'AG' + | 'AI' + | 'AL' + | 'AM' + | 'AO' + | 'AQ' + | 'AR' + | 'AT' + | 'AU' + | 'AW' + | 'AX' + | 'AZ' + | 'BA' + | 'BB' + | 'BD' + | 'BE' + | 'BF' + | 'BG' + | 'BH' + | 'BI' + | 'BJ' + | 'BL' + | 'BM' + | 'BN' + | 'BO' + | 'BQ' + | 'BR' + | 'BS' + | 'BT' + | 'BV' + | 'BW' + | 'BY' + | 'BZ' + | 'CA' + | 'CD' + | 'CF' + | 'CG' + | 'CH' + | 'CI' + | 'CK' + | 'CL' + | 'CM' + | 'CN' + | 'CO' + | 'CR' + | 'CV' + | 'CW' + | 'CY' + | 'CZ' + | 'DE' + | 'DJ' + | 'DK' + | 'DM' + | 'DO' + | 'DZ' + | 'EC' + | 'EE' + | 'EG' + | 'EH' + | 'ER' + | 'ES' + | 'ET' + | 'FI' + | 'FJ' + | 'FK' + | 'FO' + | 'FR' + | 'GA' + | 'GB' + | 'GD' + | 'GE' + | 'GF' + | 'GG' + | 'GH' + | 'GI' + | 'GL' + | 'GM' + | 'GN' + | 'GP' + | 'GQ' + | 'GR' + | 'GS' + | 'GT' + | 'GU' + | 'GW' + | 'GY' + | 'HK' + | 'HN' + | 'HR' + | 'HT' + | 'HU' + | 'ID' + | 'IE' + | 'IL' + | 'IM' + | 'IN' + | 'IO' + | 'IQ' + | 'IS' + | 'IT' + | 'JE' + | 'JM' + | 'JO' + | 'JP' + | 'KE' + | 'KG' + | 'KH' + | 'KI' + | 'KM' + | 'KN' + | 'KR' + | 'KW' + | 'KY' + | 'KZ' + | 'LA' + | 'LB' + | 'LC' + | 'LI' + | 'LK' + | 'LR' + | 'LS' + | 'LT' + | 'LU' + | 'LV' + | 'LY' + | 'MA' + | 'MC' + | 'MD' + | 'ME' + | 'MF' + | 'MG' + | 'MK' + | 'ML' + | 'MM' + | 'MN' + | 'MO' + | 'MQ' + | 'MR' + | 'MS' + | 'MT' + | 'MU' + | 'MV' + | 'MW' + | 'MX' + | 'MY' + | 'MZ' + | 'NA' + | 'NC' + | 'NE' + | 'NG' + | 'NI' + | 'NL' + | 'NO' + | 'NP' + | 'NR' + | 'NU' + | 'NZ' + | 'OM' + | 'PA' + | 'PE' + | 'PF' + | 'PG' + | 'PH' + | 'PK' + | 'PL' + | 'PM' + | 'PN' + | 'PR' + | 'PS' + | 'PT' + | 'PY' + | 'QA' + | 'RE' + | 'RO' + | 'RS' + | 'RU' + | 'RW' + | 'SA' + | 'SB' + | 'SC' + | 'SE' + | 'SG' + | 'SH' + | 'SI' + | 'SJ' + | 'SK' + | 'SL' + | 'SM' + | 'SN' + | 'SO' + | 'SR' + | 'SS' + | 'ST' + | 'SV' + | 'SX' + | 'SZ' + | 'TA' + | 'TC' + | 'TD' + | 'TF' + | 'TG' + | 'TH' + | 'TJ' + | 'TK' + | 'TL' + | 'TM' + | 'TN' + | 'TO' + | 'TR' + | 'TT' + | 'TV' + | 'TW' + | 'TZ' + | 'UA' + | 'UG' + | 'US' + | 'UY' + | 'UZ' + | 'VA' + | 'VC' + | 'VE' + | 'VG' + | 'VN' + | 'VU' + | 'WF' + | 'WS' + | 'XK' + | 'YE' + | 'YT' + | 'ZA' + | 'ZM' + | 'ZW' + | 'ZZ' + )[] + } & { [key: string]: unknown } /** @description The shipping rate options to apply to this Session. */ shipping_options?: ({ - shipping_rate?: string; + shipping_rate?: string /** method_params */ shipping_rate_data?: { /** delivery_estimate */ @@ -22005,30 +21484,30 @@ export interface operations { /** delivery_estimate_bound */ maximum?: { /** @enum {string} */ - unit: "business_day" | "day" | "hour" | "month" | "week"; - value: number; - } & { [key: string]: unknown }; + unit: 'business_day' | 'day' | 'hour' | 'month' | 'week' + value: number + } & { [key: string]: unknown } /** delivery_estimate_bound */ minimum?: { /** @enum {string} */ - unit: "business_day" | "day" | "hour" | "month" | "week"; - value: number; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; - display_name: string; + unit: 'business_day' | 'day' | 'hour' | 'month' | 'week' + value: number + } & { [key: string]: unknown } + } & { [key: string]: unknown } + display_name: string /** fixed_amount */ fixed_amount?: { - amount: number; - currency: string; - } & { [key: string]: unknown }; - metadata?: { [key: string]: string }; + amount: number + currency: string + } & { [key: string]: unknown } + metadata?: { [key: string]: string } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - tax_code?: string; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + tax_code?: string /** @enum {string} */ - type?: "fixed_amount"; - } & { [key: string]: unknown }; - } & { [key: string]: unknown })[]; + type?: 'fixed_amount' + } & { [key: string]: unknown } + } & { [key: string]: unknown })[] /** * @description Describes the type of transaction being performed by Checkout in order to customize * relevant text on the page, such as the submit button. `submit_type` can only be @@ -22036,78 +21515,78 @@ export interface operations { * in `subscription` or `setup` mode. * @enum {string} */ - submit_type?: "auto" | "book" | "donate" | "pay"; + submit_type?: 'auto' | 'book' | 'donate' | 'pay' /** * subscription_data_params * @description A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode. */ subscription_data?: { - application_fee_percent?: number; - default_tax_rates?: string[]; + application_fee_percent?: number + default_tax_rates?: string[] items?: ({ - plan: string; - quantity?: number; - tax_rates?: string[]; - } & { [key: string]: unknown })[]; - metadata?: { [key: string]: string }; + plan: string + quantity?: number + tax_rates?: string[] + } & { [key: string]: unknown })[] + metadata?: { [key: string]: string } /** transfer_data_specs */ transfer_data?: { - amount_percent?: number; - destination: string; - } & { [key: string]: unknown }; + amount_percent?: number + destination: string + } & { [key: string]: unknown } /** Format: unix-time */ - trial_end?: number; - trial_period_days?: number; - } & { [key: string]: unknown }; + trial_end?: number + trial_period_days?: number + } & { [key: string]: unknown } /** * @description The URL to which Stripe should send customers when payment or setup * is complete. * If you’d like to use information from the successful Checkout Session on your page, * read the guide on [customizing your success page](https://stripe.com/docs/payments/checkout/custom-success-page). */ - success_url: string; + success_url: string /** * tax_id_collection_params * @description Controls tax ID collection settings for the session. */ tax_id_collection?: { - enabled: boolean; - } & { [key: string]: unknown }; - }; - }; - }; - }; + enabled: boolean + } & { [key: string]: unknown } + } + } + } + } /**

Retrieves a Session object.

*/ GetCheckoutSessionsSession: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - session: string; - }; - }; + session: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["checkout.session"]; - }; - }; + 'application/json': components['schemas']['checkout.session'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

A Session can be expired when it is in one of these statuses: open

* @@ -22116,157 +21595,157 @@ export interface operations { PostCheckoutSessionsSessionExpire: { parameters: { path: { - session: string; - }; - }; + session: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["checkout.session"]; - }; - }; + 'application/json': components['schemas']['checkout.session'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

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.

*/ GetCheckoutSessionsSessionLineItems: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - session: string; - }; - }; + session: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["item"][]; + data: components['schemas']['item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Lists all Country Spec objects available in the API.

*/ GetCountrySpecs: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["country_spec"][]; + 'application/json': { + data: components['schemas']['country_spec'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a Country Spec for a given Country code.

*/ GetCountrySpecsCountry: { parameters: { path: { - country: string; - }; + country: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["country_spec"]; - }; - }; + 'application/json': components['schemas']['country_spec'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of your coupons.

*/ GetCoupons: { parameters: { @@ -22274,54 +21753,54 @@ export interface operations { /** 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?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["coupon"][]; + 'application/json': { + data: components['schemas']['coupon'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

You can create coupons easily via the coupon management page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.

* @@ -22332,199 +21811,199 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["coupon"]; - }; - }; + 'application/json': components['schemas']['coupon'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed). */ - amount_off?: number; + amount_off?: number /** * applies_to_params * @description A hash containing directions for what this Coupon will apply discounts to. */ applies_to?: { - products?: string[]; - } & { [key: string]: unknown }; + products?: string[] + } & { [key: string]: unknown } /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed). */ - currency?: string; + currency?: string /** * @description Specifies how long the discount will be in effect if used on a subscription. Can be `forever`, `once`, or `repeating`. Defaults to `once`. * @enum {string} */ - duration?: "forever" | "once" | "repeating"; + duration?: 'forever' | 'once' | 'repeating' /** @description Required only if `duration` is `repeating`, in which case it must be a positive integer that specifies the number of months the discount will be in effect. */ - duration_in_months?: number; + duration_in_months?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Unique string of your choice that will be used to identify this coupon when applying it to a customer. If you don't want to specify a particular code, you can leave the ID blank and we'll generate a random code for you. */ - id?: string; + id?: string /** @description A positive integer specifying the number of times the coupon can be redeemed before it's no longer valid. For example, you might have a 50% off coupon that the first 20 readers of your blog can use. */ - max_redemptions?: number; + max_redemptions?: number /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set. */ - name?: string; + name?: string /** @description A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if `amount_off` is not passed). */ - percent_off?: number; + percent_off?: number /** * Format: unix-time * @description Unix timestamp specifying the last time at which the coupon can be redeemed. After the redeem_by date, the coupon can no longer be applied to new customers. */ - redeem_by?: number; - }; - }; - }; - }; + redeem_by?: number + } + } + } + } /**

Retrieves the coupon with the given ID.

*/ GetCouponsCoupon: { parameters: { path: { - coupon: string; - }; + coupon: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["coupon"]; - }; - }; + 'application/json': components['schemas']['coupon'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostCouponsCoupon: { parameters: { path: { - coupon: string; - }; - }; + coupon: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["coupon"]; - }; - }; + 'application/json': components['schemas']['coupon'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set. */ - name?: string; - }; - }; - }; - }; + name?: string + } + } + } + } /**

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.

*/ DeleteCouponsCoupon: { parameters: { path: { - coupon: string; - }; - }; + coupon: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_coupon"]; - }; - }; + 'application/json': components['schemas']['deleted_coupon'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of credit notes.

*/ GetCreditNotes: { parameters: { query: { /** Only return credit notes for the customer specified by this customer ID. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** Only return credit notes for the invoice specified by this invoice ID. */ - invoice?: string; + invoice?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["credit_note"][]; + 'application/json': { + data: components['schemas']['credit_note'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces * its amount_due. For a status=paid invoice, a credit note does not affect its amount_due. Instead, it can result @@ -22546,437 +22025,437 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["credit_note"]; - }; - }; + 'application/json': components['schemas']['credit_note'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The integer amount in %s representing the total amount of the credit note. */ - amount?: number; + amount?: number /** @description The integer amount in %s representing the amount to credit the customer's balance, which will be automatically applied to their next invoice. */ - credit_amount?: number; + credit_amount?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description ID of the invoice. */ - invoice: string; + invoice: string /** @description Line items that make up the credit note. */ lines?: ({ - amount?: number; - description?: string; - invoice_line_item?: string; - quantity?: number; - tax_rates?: (Partial & Partial<"">) & { [key: string]: unknown }; + amount?: number + description?: string + invoice_line_item?: string + quantity?: number + tax_rates?: (Partial & Partial<''>) & { [key: string]: unknown } /** @enum {string} */ - type: "custom_line_item" | "invoice_line_item"; - unit_amount?: number; + type: 'custom_line_item' | 'invoice_line_item' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - } & { [key: string]: unknown })[]; + unit_amount_decimal?: string + } & { [key: string]: unknown })[] /** @description The credit note's memo appears on the credit note PDF. */ - memo?: string; + memo?: string /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The integer amount in %s representing the amount that is credited outside of Stripe. */ - out_of_band_amount?: number; + out_of_band_amount?: number /** * @description Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` * @enum {string} */ - reason?: "duplicate" | "fraudulent" | "order_change" | "product_unsatisfactory"; + reason?: 'duplicate' | 'fraudulent' | 'order_change' | 'product_unsatisfactory' /** @description ID of an existing refund to link this credit note to. */ - refund?: string; + refund?: string /** @description The integer amount in %s representing the amount to refund. If set, a refund will be created for the charge associated with the invoice. */ - refund_amount?: number; - }; - }; - }; - }; + refund_amount?: number + } + } + } + } /**

Get a preview of a credit note without creating it.

*/ GetCreditNotesPreview: { parameters: { query: { /** The integer amount in %s representing the total amount of the credit note. */ - amount?: number; + amount?: number /** The integer amount in %s representing the amount to credit the customer's balance, which will be automatically applied to their next invoice. */ - credit_amount?: number; + credit_amount?: number /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** ID of the invoice. */ - invoice: string; + invoice: string /** Line items that make up the credit note. */ lines?: ({ - amount?: number; - description?: string; - invoice_line_item?: string; - quantity?: number; - tax_rates?: (Partial & Partial<"">) & { [key: string]: unknown }; + amount?: number + description?: string + invoice_line_item?: string + quantity?: number + tax_rates?: (Partial & Partial<''>) & { [key: string]: unknown } /** @enum {string} */ - type: "custom_line_item" | "invoice_line_item"; - unit_amount?: number; + type: 'custom_line_item' | 'invoice_line_item' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - } & { [key: string]: unknown })[]; + unit_amount_decimal?: string + } & { [key: string]: unknown })[] /** The credit note's memo appears on the credit note PDF. */ - memo?: string; + memo?: string /** 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** The integer amount in %s representing the amount that is credited outside of Stripe. */ - out_of_band_amount?: number; + out_of_band_amount?: number /** Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` */ - reason?: "duplicate" | "fraudulent" | "order_change" | "product_unsatisfactory"; + reason?: 'duplicate' | 'fraudulent' | 'order_change' | 'product_unsatisfactory' /** ID of an existing refund to link this credit note to. */ - refund?: string; + refund?: string /** The integer amount in %s representing the amount to refund. If set, a refund will be created for the charge associated with the invoice. */ - refund_amount?: number; - }; - }; + refund_amount?: number + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["credit_note"]; - }; - }; + 'application/json': components['schemas']['credit_note'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ GetCreditNotesPreviewLines: { parameters: { query: { /** The integer amount in %s representing the total amount of the credit note. */ - amount?: number; + amount?: number /** The integer amount in %s representing the amount to credit the customer's balance, which will be automatically applied to their next invoice. */ - credit_amount?: number; + credit_amount?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** ID of the invoice. */ - invoice: string; + invoice: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Line items that make up the credit note. */ lines?: ({ - amount?: number; - description?: string; - invoice_line_item?: string; - quantity?: number; - tax_rates?: (Partial & Partial<"">) & { [key: string]: unknown }; + amount?: number + description?: string + invoice_line_item?: string + quantity?: number + tax_rates?: (Partial & Partial<''>) & { [key: string]: unknown } /** @enum {string} */ - type: "custom_line_item" | "invoice_line_item"; - unit_amount?: number; + type: 'custom_line_item' | 'invoice_line_item' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - } & { [key: string]: unknown })[]; + unit_amount_decimal?: string + } & { [key: string]: unknown })[] /** The credit note's memo appears on the credit note PDF. */ - memo?: string; + memo?: string /** 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** The integer amount in %s representing the amount that is credited outside of Stripe. */ - out_of_band_amount?: number; + out_of_band_amount?: number /** Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` */ - reason?: "duplicate" | "fraudulent" | "order_change" | "product_unsatisfactory"; + reason?: 'duplicate' | 'fraudulent' | 'order_change' | 'product_unsatisfactory' /** ID of an existing refund to link this credit note to. */ - refund?: string; + refund?: string /** The integer amount in %s representing the amount to refund. If set, a refund will be created for the charge associated with the invoice. */ - refund_amount?: number; + refund_amount?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["credit_note_line_item"][]; + data: components['schemas']['credit_note_line_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ GetCreditNotesCreditNoteLines: { parameters: { path: { - credit_note: string; - }; + credit_note: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["credit_note_line_item"][]; + data: components['schemas']['credit_note_line_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves the credit note object with the given identifier.

*/ GetCreditNotesId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["credit_note"]; - }; - }; + 'application/json': components['schemas']['credit_note'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates an existing credit note.

*/ PostCreditNotesId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["credit_note"]; - }; - }; + 'application/json': components['schemas']['credit_note'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Credit note memo. */ - memo?: string; + memo?: string /** @description 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?: { [key: string]: string }; - }; - }; - }; - }; + metadata?: { [key: string]: string } + } + } + } + } /**

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

*/ PostCreditNotesIdVoid: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["credit_note"]; - }; - }; + 'application/json': components['schemas']['credit_note'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

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

*/ GetCustomers: { parameters: { query: { created?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** A case-sensitive filter on the list based on the customer's `email` field. The value must be a string. */ - email?: string; + email?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["customer"][]; + 'application/json': { + data: components['schemas']['customer'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new customer object.

*/ PostCustomers: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["customer"]; - }; - }; + 'application/json': components['schemas']['customer'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The customer's address. */ address?: (Partial< { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** @description An integer amount in %s that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice. */ - balance?: number; - coupon?: string; + balance?: number + coupon?: string /** @description An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard. */ - description?: string; + description?: string /** @description Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers. */ - invoice_prefix?: string; + invoice_prefix?: string /** * customer_param * @description Default invoice settings for this customer. @@ -22984,141 +22463,142 @@ export interface operations { invoice_settings?: { custom_fields?: (Partial< ({ - name: string; - value: string; + name: string + value: string } & { [key: string]: unknown })[] > & - Partial<"">) & { [key: string]: unknown }; - default_payment_method?: string; - footer?: string; - } & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } + default_payment_method?: string + footer?: string + } & { [key: string]: unknown } /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description The customer's full name or business name. */ - name?: string; + name?: string /** @description The sequence to be used on the customer's next invoice. Defaults to 1. */ - next_invoice_sequence?: number; - payment_method?: string; + next_invoice_sequence?: number + payment_method?: string /** @description The customer's phone number. */ - phone?: string; + phone?: string /** @description Customer's preferred languages, ordered by preference. */ - preferred_locales?: string[]; + preferred_locales?: string[] /** @description The API ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount. */ - promotion_code?: string; + promotion_code?: string /** @description The customer's shipping information. Appears on invoices emailed to this customer. */ shipping?: (Partial< { /** optional_fields_address */ address: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - } & { [key: string]: unknown }; - name: string; - phone?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } & { [key: string]: unknown } + name: string + phone?: string } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - source?: string; + Partial<''>) & { [key: string]: unknown } + source?: string /** * tax_param * @description Tax details about the customer. */ tax?: { - ip_address?: (Partial & Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown }; + ip_address?: (Partial & Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown } /** * @description The customer's tax exemption. One of `none`, `exempt`, or `reverse`. * @enum {string} */ - tax_exempt?: "" | "exempt" | "none" | "reverse"; + tax_exempt?: '' | 'exempt' | 'none' | 'reverse' /** @description The customer's tax IDs. */ tax_id_data?: ({ /** @enum {string} */ type: - | "ae_trn" - | "au_abn" - | "au_arn" - | "br_cnpj" - | "br_cpf" - | "ca_bn" - | "ca_gst_hst" - | "ca_pst_bc" - | "ca_pst_mb" - | "ca_pst_sk" - | "ca_qst" - | "ch_vat" - | "cl_tin" - | "es_cif" - | "eu_vat" - | "gb_vat" - | "ge_vat" - | "hk_br" - | "id_npwp" - | "il_vat" - | "in_gst" - | "is_vat" - | "jp_cn" - | "jp_rn" - | "kr_brn" - | "li_uid" - | "mx_rfc" - | "my_frp" - | "my_itn" - | "my_sst" - | "no_vat" - | "nz_gst" - | "ru_inn" - | "ru_kpp" - | "sa_vat" - | "sg_gst" - | "sg_uen" - | "th_vat" - | "tw_vat" - | "ua_vat" - | "us_ein" - | "za_vat"; - value: string; - } & { [key: string]: unknown })[]; - }; - }; - }; - }; + | 'ae_trn' + | 'au_abn' + | 'au_arn' + | 'br_cnpj' + | 'br_cpf' + | 'ca_bn' + | 'ca_gst_hst' + | 'ca_pst_bc' + | 'ca_pst_mb' + | 'ca_pst_sk' + | 'ca_qst' + | 'ch_vat' + | 'cl_tin' + | 'es_cif' + | 'eu_vat' + | 'gb_vat' + | 'ge_vat' + | 'hk_br' + | 'id_npwp' + | 'il_vat' + | 'in_gst' + | 'is_vat' + | 'jp_cn' + | 'jp_rn' + | 'kr_brn' + | 'li_uid' + | 'mx_rfc' + | 'my_frp' + | 'my_itn' + | 'my_sst' + | 'no_vat' + | 'nz_gst' + | 'ru_inn' + | 'ru_kpp' + | 'sa_vat' + | 'sg_gst' + | 'sg_uen' + | 'th_vat' + | 'tw_vat' + | 'ua_vat' + | 'us_ein' + | 'za_vat' + value: string + } & { [key: string]: unknown })[] + } + } + } + } /**

Retrieves a Customer object.

*/ GetCustomersCustomer: { parameters: { path: { - customer: string; - }; + customer: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": (Partial & - Partial) & { [key: string]: unknown }; - }; - }; + 'application/json': (Partial & Partial) & { + [key: string]: unknown + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the source parameter, that becomes the customer’s active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the source parameter: for each of the customer’s current subscriptions, if the subscription bills automatically and is in the past_due state, then the latest open invoice for the subscription with automatic collection enabled will be retried. This retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice. Changing the default_source for a customer will not trigger this behavior.

* @@ -23127,82 +22607,82 @@ export interface operations { PostCustomersCustomer: { parameters: { path: { - customer: string; - }; - }; + customer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["customer"]; - }; - }; + 'application/json': components['schemas']['customer'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The customer's address. */ address?: (Partial< { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** @description An integer amount in %s that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice. */ - balance?: number; + balance?: number /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ bank_account?: (Partial< { - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; - country: string; - currency?: string; + account_holder_type?: 'company' | 'individual' + account_number: string + country: string + currency?: string /** @enum {string} */ - object?: "bank_account"; - routing_number?: string; + object?: 'bank_account' + routing_number?: string } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** @description A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js). */ card?: (Partial< { - address_city?: string; - address_country?: string; - address_line1?: string; - address_line2?: string; - address_state?: string; - address_zip?: string; - cvc?: string; - exp_month: number; - exp_year: number; - metadata?: { [key: string]: string }; - name?: string; - number: string; + address_city?: string + address_country?: string + address_line1?: string + address_line2?: string + address_state?: string + address_zip?: string + cvc?: string + exp_month: number + exp_year: number + metadata?: { [key: string]: string } + name?: string + number: string /** @enum {string} */ - object?: "card"; + object?: 'card' } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; - coupon?: string; + Partial) & { [key: string]: unknown } + coupon?: string /** @description ID of Alipay account to make the customer's new default for invoice payments. */ - default_alipay_account?: string; + default_alipay_account?: string /** @description ID of bank account to make the customer's new default for invoice payments. */ - default_bank_account?: string; + default_bank_account?: string /** @description ID of card to make the customer's new default for invoice payments. */ - default_card?: string; + default_card?: string /** * @description If you are using payment methods created via the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method) parameter. * @@ -23210,15 +22690,15 @@ export interface operations { * * If you want to add a new payment source and make it the default, see the [source](https://stripe.com/docs/api/customers/update#update_customer-source) property. */ - default_source?: string; + default_source?: string /** @description An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard. */ - description?: string; + description?: string /** @description Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers. */ - invoice_prefix?: string; + invoice_prefix?: string /** * customer_param * @description Default invoice settings for this customer. @@ -23226,292 +22706,292 @@ export interface operations { invoice_settings?: { custom_fields?: (Partial< ({ - name: string; - value: string; + name: string + value: string } & { [key: string]: unknown })[] > & - Partial<"">) & { [key: string]: unknown }; - default_payment_method?: string; - footer?: string; - } & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } + default_payment_method?: string + footer?: string + } & { [key: string]: unknown } /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description The customer's full name or business name. */ - name?: string; + name?: string /** @description The sequence to be used on the customer's next invoice. Defaults to 1. */ - next_invoice_sequence?: number; + next_invoice_sequence?: number /** @description The customer's phone number. */ - phone?: string; + phone?: string /** @description Customer's preferred languages, ordered by preference. */ - preferred_locales?: string[]; + preferred_locales?: string[] /** @description The API ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount. */ - promotion_code?: string; + promotion_code?: string /** @description The customer's shipping information. Appears on invoices emailed to this customer. */ shipping?: (Partial< { /** optional_fields_address */ address: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - } & { [key: string]: unknown }; - name: string; - phone?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } & { [key: string]: unknown } + name: string + phone?: string } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - source?: string; + Partial<''>) & { [key: string]: unknown } + source?: string /** * tax_param * @description Tax details about the customer. */ tax?: { - ip_address?: (Partial & Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown }; + ip_address?: (Partial & Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown } /** * @description The customer's tax exemption. One of `none`, `exempt`, or `reverse`. * @enum {string} */ - tax_exempt?: "" | "exempt" | "none" | "reverse"; + tax_exempt?: '' | 'exempt' | 'none' | 'reverse' /** @description Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. */ - trial_end?: (Partial<"now"> & Partial) & { [key: string]: unknown }; - }; - }; - }; - }; + trial_end?: (Partial<'now'> & Partial) & { [key: string]: unknown } + } + } + } + } /**

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

*/ DeleteCustomersCustomer: { parameters: { path: { - customer: string; - }; - }; + customer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_customer"]; - }; - }; + 'application/json': components['schemas']['deleted_customer'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ GetCustomersCustomerBalanceTransactions: { parameters: { path: { - customer: string; - }; + customer: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["customer_balance_transaction"][]; + data: components['schemas']['customer_balance_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostCustomersCustomerBalanceTransactions: { parameters: { path: { - customer: string; - }; - }; + customer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["customer_balance_transaction"]; - }; - }; + 'application/json': components['schemas']['customer_balance_transaction'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The integer amount in **%s** to apply to the customer's credit balance. */ - amount: number; + amount: number /** @description 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 the customer's [`currency`](https://stripe.com/docs/api/customers/object#customer_object-currency) is set, this value must match it. If the customer's `currency` is not set, it will be updated to this value. */ - currency: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; - }; - }; - }; - }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } + } + } + } + } /**

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

*/ GetCustomersCustomerBalanceTransactionsTransaction: { parameters: { path: { - customer: string; - transaction: string; - }; + customer: string + transaction: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["customer_balance_transaction"]; - }; - }; + 'application/json': components['schemas']['customer_balance_transaction'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostCustomersCustomerBalanceTransactionsTransaction: { parameters: { path: { - customer: string; - transaction: string; - }; - }; + customer: string + transaction: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["customer_balance_transaction"]; - }; - }; + 'application/json': components['schemas']['customer_balance_transaction'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; - }; - }; - }; - }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } + } + } + } + } /**

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.

*/ GetCustomersCustomerBankAccounts: { parameters: { path: { - customer: string; - }; + customer: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["bank_account"][]; + data: components['schemas']['bank_account'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

When you create a new credit card, you must specify a customer or recipient on which to create it.

* @@ -23522,245 +23002,246 @@ export interface operations { PostCustomersCustomerBankAccounts: { parameters: { path: { - customer: string; - }; - }; + customer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_source"]; - }; - }; + 'application/json': components['schemas']['payment_source'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A token returned by [Stripe.js](https://stripe.com/docs/js) representing the user’s Alipay account details. */ - alipay_account?: string; + alipay_account?: string /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ bank_account?: (Partial< { - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; - country: string; - currency?: string; + account_holder_type?: 'company' | 'individual' + account_number: string + country: string + currency?: string /** @enum {string} */ - object?: "bank_account"; - routing_number?: string; + object?: 'bank_account' + routing_number?: string } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** @description A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js). */ card?: (Partial< { - address_city?: string; - address_country?: string; - address_line1?: string; - address_line2?: string; - address_state?: string; - address_zip?: string; - cvc?: string; - exp_month: number; - exp_year: number; - metadata?: { [key: string]: string }; - name?: string; - number: string; + address_city?: string + address_country?: string + address_line1?: string + address_line2?: string + address_state?: string + address_zip?: string + cvc?: string + exp_month: number + exp_year: number + metadata?: { [key: string]: string } + name?: string + number: string /** @enum {string} */ - object?: "card"; + object?: 'card' } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - source?: string; - }; - }; - }; - }; + source?: string + } + } + } + } /**

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.

*/ GetCustomersCustomerBankAccountsId: { parameters: { path: { - customer: string; - id: string; - }; + customer: string + id: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["bank_account"]; - }; - }; + 'application/json': components['schemas']['bank_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Update a specified source for a given customer.

*/ PostCustomersCustomerBankAccountsId: { parameters: { path: { - customer: string; - id: string; - }; - }; + customer: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": (Partial & - Partial & - Partial) & { [key: string]: unknown }; - }; - }; + 'application/json': (Partial & + Partial & + Partial) & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The name of the person or business that owns the bank account. */ - account_holder_name?: string; + account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - account_holder_type?: "company" | "individual"; + account_holder_type?: 'company' | 'individual' /** @description City/District/Suburb/Town/Village. */ - address_city?: string; + address_city?: string /** @description Billing address country, if provided when creating card. */ - address_country?: string; + address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - address_line1?: string; + address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - address_line2?: string; + address_line2?: string /** @description State/County/Province/Region. */ - address_state?: string; + address_state?: string /** @description ZIP or postal code. */ - address_zip?: string; + address_zip?: string /** @description Two digit number representing the card’s expiration month. */ - exp_month?: string; + exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - exp_year?: string; + exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description Cardholder name. */ - name?: string; + name?: string /** owner */ owner?: { /** source_address */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - } & { [key: string]: unknown }; - email?: string; - name?: string; - phone?: string; - } & { [key: string]: unknown }; - }; - }; - }; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } & { [key: string]: unknown } + email?: string + name?: string + phone?: string + } & { [key: string]: unknown } + } + } + } + } /**

Delete a specified source for a given customer.

*/ DeleteCustomersCustomerBankAccountsId: { parameters: { path: { - customer: string; - id: string; - }; - }; + customer: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": (Partial & - Partial) & { [key: string]: unknown }; - }; - }; + 'application/json': (Partial & Partial) & { + [key: string]: unknown + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Verify a specified bank account for a given customer.

*/ PostCustomersCustomerBankAccountsIdVerify: { parameters: { path: { - customer: string; - id: string; - }; - }; + customer: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["bank_account"]; - }; - }; + 'application/json': components['schemas']['bank_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account. */ - amounts?: number[]; + amounts?: number[] /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /** *

You can see a list of the cards belonging to a customer. * Note that the 10 most recent sources are always available on the Customer object. @@ -23769,50 +23250,50 @@ export interface operations { GetCustomersCustomerCards: { parameters: { path: { - customer: string; - }; + customer: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["card"][]; + 'application/json': { + data: components['schemas']['card'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

When you create a new credit card, you must specify a customer or recipient on which to create it.

* @@ -23823,393 +23304,394 @@ export interface operations { PostCustomersCustomerCards: { parameters: { path: { - customer: string; - }; - }; + customer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_source"]; - }; - }; + 'application/json': components['schemas']['payment_source'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A token returned by [Stripe.js](https://stripe.com/docs/js) representing the user’s Alipay account details. */ - alipay_account?: string; + alipay_account?: string /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ bank_account?: (Partial< { - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; - country: string; - currency?: string; + account_holder_type?: 'company' | 'individual' + account_number: string + country: string + currency?: string /** @enum {string} */ - object?: "bank_account"; - routing_number?: string; + object?: 'bank_account' + routing_number?: string } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** @description A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js). */ card?: (Partial< { - address_city?: string; - address_country?: string; - address_line1?: string; - address_line2?: string; - address_state?: string; - address_zip?: string; - cvc?: string; - exp_month: number; - exp_year: number; - metadata?: { [key: string]: string }; - name?: string; - number: string; + address_city?: string + address_country?: string + address_line1?: string + address_line2?: string + address_state?: string + address_zip?: string + cvc?: string + exp_month: number + exp_year: number + metadata?: { [key: string]: string } + name?: string + number: string /** @enum {string} */ - object?: "card"; + object?: 'card' } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - source?: string; - }; - }; - }; - }; + source?: string + } + } + } + } /**

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.

*/ GetCustomersCustomerCardsId: { parameters: { path: { - customer: string; - id: string; - }; + customer: string + id: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["card"]; - }; - }; + 'application/json': components['schemas']['card'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Update a specified source for a given customer.

*/ PostCustomersCustomerCardsId: { parameters: { path: { - customer: string; - id: string; - }; - }; + customer: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": (Partial & - Partial & - Partial) & { [key: string]: unknown }; - }; - }; + 'application/json': (Partial & + Partial & + Partial) & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The name of the person or business that owns the bank account. */ - account_holder_name?: string; + account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - account_holder_type?: "company" | "individual"; + account_holder_type?: 'company' | 'individual' /** @description City/District/Suburb/Town/Village. */ - address_city?: string; + address_city?: string /** @description Billing address country, if provided when creating card. */ - address_country?: string; + address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - address_line1?: string; + address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - address_line2?: string; + address_line2?: string /** @description State/County/Province/Region. */ - address_state?: string; + address_state?: string /** @description ZIP or postal code. */ - address_zip?: string; + address_zip?: string /** @description Two digit number representing the card’s expiration month. */ - exp_month?: string; + exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - exp_year?: string; + exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description Cardholder name. */ - name?: string; + name?: string /** owner */ owner?: { /** source_address */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - } & { [key: string]: unknown }; - email?: string; - name?: string; - phone?: string; - } & { [key: string]: unknown }; - }; - }; - }; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } & { [key: string]: unknown } + email?: string + name?: string + phone?: string + } & { [key: string]: unknown } + } + } + } + } /**

Delete a specified source for a given customer.

*/ DeleteCustomersCustomerCardsId: { parameters: { path: { - customer: string; - id: string; - }; - }; + customer: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": (Partial & - Partial) & { [key: string]: unknown }; - }; - }; + 'application/json': (Partial & Partial) & { + [key: string]: unknown + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } GetCustomersCustomerDiscount: { parameters: { path: { - customer: string; - }; + customer: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["discount"]; - }; - }; + 'application/json': components['schemas']['discount'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Removes the currently applied discount on a customer.

*/ DeleteCustomersCustomerDiscount: { parameters: { path: { - customer: string; - }; - }; + customer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_discount"]; - }; - }; + 'application/json': components['schemas']['deleted_discount'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of PaymentMethods for a given Customer

*/ GetCustomersCustomerPaymentMethods: { parameters: { path: { - customer: string; - }; + customer: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** A required filter on the list, based on the object `type` field. */ type: - | "acss_debit" - | "afterpay_clearpay" - | "alipay" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "eps" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "klarna" - | "oxxo" - | "p24" - | "sepa_debit" - | "sofort" - | "wechat_pay"; - }; - }; - responses: { - /** Successful response. */ - 200: { - content: { - "application/json": { - data: components["schemas"]["payment_method"][]; + | 'acss_debit' + | 'afterpay_clearpay' + | 'alipay' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'eps' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'klarna' + | 'oxxo' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' + } + } + responses: { + /** Successful response. */ + 200: { + content: { + 'application/json': { + data: components['schemas']['payment_method'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

List sources for a specified customer.

*/ GetCustomersCustomerSources: { parameters: { path: { - customer: string; - }; + customer: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Filter sources according to a particular object type. */ - object?: string; + object?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: ((Partial & - Partial & - Partial & - Partial & - Partial) & { [key: string]: unknown })[]; + data: ((Partial & + Partial & + Partial & + Partial & + Partial) & { [key: string]: unknown })[] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

When you create a new credit card, you must specify a customer or recipient on which to create it.

* @@ -24220,418 +23702,419 @@ export interface operations { PostCustomersCustomerSources: { parameters: { path: { - customer: string; - }; - }; + customer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_source"]; - }; - }; + 'application/json': components['schemas']['payment_source'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A token returned by [Stripe.js](https://stripe.com/docs/js) representing the user’s Alipay account details. */ - alipay_account?: string; + alipay_account?: string /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ bank_account?: (Partial< { - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; - country: string; - currency?: string; + account_holder_type?: 'company' | 'individual' + account_number: string + country: string + currency?: string /** @enum {string} */ - object?: "bank_account"; - routing_number?: string; + object?: 'bank_account' + routing_number?: string } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** @description A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js). */ card?: (Partial< { - address_city?: string; - address_country?: string; - address_line1?: string; - address_line2?: string; - address_state?: string; - address_zip?: string; - cvc?: string; - exp_month: number; - exp_year: number; - metadata?: { [key: string]: string }; - name?: string; - number: string; + address_city?: string + address_country?: string + address_line1?: string + address_line2?: string + address_state?: string + address_zip?: string + cvc?: string + exp_month: number + exp_year: number + metadata?: { [key: string]: string } + name?: string + number: string /** @enum {string} */ - object?: "card"; + object?: 'card' } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - source?: string; - }; - }; - }; - }; + source?: string + } + } + } + } /**

Retrieve a specified source for a given customer.

*/ GetCustomersCustomerSourcesId: { parameters: { path: { - customer: string; - id: string; - }; + customer: string + id: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_source"]; - }; - }; + 'application/json': components['schemas']['payment_source'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Update a specified source for a given customer.

*/ PostCustomersCustomerSourcesId: { parameters: { path: { - customer: string; - id: string; - }; - }; + customer: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": (Partial & - Partial & - Partial) & { [key: string]: unknown }; - }; - }; + 'application/json': (Partial & + Partial & + Partial) & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The name of the person or business that owns the bank account. */ - account_holder_name?: string; + account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - account_holder_type?: "company" | "individual"; + account_holder_type?: 'company' | 'individual' /** @description City/District/Suburb/Town/Village. */ - address_city?: string; + address_city?: string /** @description Billing address country, if provided when creating card. */ - address_country?: string; + address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - address_line1?: string; + address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - address_line2?: string; + address_line2?: string /** @description State/County/Province/Region. */ - address_state?: string; + address_state?: string /** @description ZIP or postal code. */ - address_zip?: string; + address_zip?: string /** @description Two digit number representing the card’s expiration month. */ - exp_month?: string; + exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - exp_year?: string; + exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description Cardholder name. */ - name?: string; + name?: string /** owner */ owner?: { /** source_address */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - } & { [key: string]: unknown }; - email?: string; - name?: string; - phone?: string; - } & { [key: string]: unknown }; - }; - }; - }; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } & { [key: string]: unknown } + email?: string + name?: string + phone?: string + } & { [key: string]: unknown } + } + } + } + } /**

Delete a specified source for a given customer.

*/ DeleteCustomersCustomerSourcesId: { parameters: { path: { - customer: string; - id: string; - }; - }; + customer: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": (Partial & - Partial) & { [key: string]: unknown }; - }; - }; + 'application/json': (Partial & Partial) & { + [key: string]: unknown + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Verify a specified bank account for a given customer.

*/ PostCustomersCustomerSourcesIdVerify: { parameters: { path: { - customer: string; - id: string; - }; - }; + customer: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["bank_account"]; - }; - }; + 'application/json': components['schemas']['bank_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account. */ - amounts?: number[]; + amounts?: number[] /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

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.

*/ GetCustomersCustomerSubscriptions: { parameters: { path: { - customer: string; - }; + customer: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["subscription"][]; + data: components['schemas']['subscription'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new subscription on an existing customer.

*/ PostCustomersCustomerSubscriptions: { parameters: { path: { - customer: string; - }; - }; + customer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription"]; - }; - }; + 'application/json': components['schemas']['subscription'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A list of prices and quantities that will generate invoice items appended to the first invoice for this subscription. You may pass up to 20 items. */ add_invoice_items?: ({ - price?: string; + price?: string /** one_time_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - } & { [key: string]: unknown }; - quantity?: number; - tax_rates?: (Partial & Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown })[]; + unit_amount_decimal?: string + } & { [key: string]: unknown } + quantity?: number + tax_rates?: (Partial & Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown })[] /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). */ - application_fee_percent?: number; + application_fee_percent?: number /** * automatic_tax_config * @description Automatic tax settings for this subscription. */ automatic_tax?: { - enabled: boolean; - } & { [key: string]: unknown }; + enabled: boolean + } & { [key: string]: unknown } /** * Format: unix-time * @description For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor. */ - backdate_start_date?: number; + backdate_start_date?: number /** * Format: unix-time * @description 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. */ - billing_cycle_anchor?: number; + billing_cycle_anchor?: number /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. */ billing_thresholds?: (Partial< { - amount_gte?: number; - reset_billing_cycle_anchor?: boolean; + amount_gte?: number + reset_billing_cycle_anchor?: boolean } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** * Format: unix-time * @description 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. */ - cancel_at?: number; + cancel_at?: number /** @description Boolean indicating whether this subscription should cancel at the end of the current period. */ - cancel_at_period_end?: boolean; + cancel_at_period_end?: boolean /** * @description 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. Defaults to `charge_automatically`. * @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' /** @description The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. */ - coupon?: string; + coupon?: string /** @description Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. */ - days_until_due?: number; + days_until_due?: number /** @description 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?: string; + default_payment_method?: string /** @description 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?: string; + default_source?: string /** @description 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?: (Partial & Partial<"">) & { [key: string]: unknown }; + default_tax_rates?: (Partial & Partial<''>) & { [key: string]: unknown } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A list of up to 20 subscription items, each with an attached price. */ items?: ({ billing_thresholds?: (Partial< { - usage_gte: number; + usage_gte: number } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - metadata?: { [key: string]: string }; - price?: string; + Partial<''>) & { [key: string]: unknown } + metadata?: { [key: string]: string } + price?: string /** recurring_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - } & { [key: string]: unknown }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } & { [key: string]: unknown } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - } & { [key: string]: unknown }; - quantity?: number; - tax_rates?: (Partial & Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown })[]; + unit_amount_decimal?: string + } & { [key: string]: unknown } + quantity?: number + tax_rates?: (Partial & Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown })[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. */ - off_session?: boolean; + off_session?: boolean /** * @description Use `allow_incomplete` to create subscriptions with `status=incomplete` if the first invoice cannot be paid. Creating subscriptions with this status allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * @@ -24642,11 +24125,7 @@ export interface operations { * `pending_if_incomplete` is only used with updates and cannot be passed when creating a subscription. * @enum {string} */ - payment_behavior?: - | "allow_incomplete" - | "default_incomplete" - | "error_if_incomplete" - | "pending_if_incomplete"; + payment_behavior?: 'allow_incomplete' | 'default_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete' /** * payment_settings * @description Payment settings to pass to invoices created by the subscription. @@ -24659,254 +24138,254 @@ export interface operations { /** mandate_options_param */ mandate_options?: { /** @enum {string} */ - transaction_type?: "business" | "personal"; - } & { [key: string]: unknown }; + transaction_type?: 'business' | 'personal' + } & { [key: string]: unknown } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; + verification_method?: 'automatic' | 'instant' | 'microdeposits' } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } bancontact?: (Partial< { /** @enum {string} */ - preferred_language?: "de" | "en" | "fr" | "nl"; + preferred_language?: 'de' | 'en' | 'fr' | 'nl' } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } card?: (Partial< { /** mandate_options_param */ mandate_options?: { - amount?: number; + amount?: number /** @enum {string} */ - amount_type?: "fixed" | "maximum"; - description?: string; - } & { [key: string]: unknown }; + amount_type?: 'fixed' | 'maximum' + description?: string + } & { [key: string]: unknown } /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: 'any' | 'automatic' } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown } payment_method_types?: (Partial< ( - | "ach_credit_transfer" - | "ach_debit" - | "acss_debit" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "sepa_debit" - | "sofort" - | "wechat_pay" + | 'ach_credit_transfer' + | 'ach_debit' + | 'acss_debit' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' )[] > & - Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown } /** @description 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?: (Partial< { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** @description The API ID of a promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. */ - promotion_code?: string; + promotion_code?: string /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) resulting from the `billing_cycle_anchor`. Valid values are `create_prorations` or `none`. * * Passing `create_prorations` will cause proration invoice items to be created when applicable. Prorations can be disabled by passing `none`. If no value is passed, the default is `create_prorations`. * @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** * transfer_data_specs * @description If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. */ transfer_data?: { - amount_percent?: number; - destination: string; - } & { [key: string]: unknown }; + amount_percent?: number + destination: string + } & { [key: string]: unknown } /** @description Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. */ - trial_end?: (Partial<"now"> & Partial) & { [key: string]: unknown }; + trial_end?: (Partial<'now'> & Partial) & { [key: string]: unknown } /** @description 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?: boolean; + trial_from_plan?: boolean /** @description Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. */ - trial_period_days?: number; - }; - }; - }; - }; + trial_period_days?: number + } + } + } + } /**

Retrieves the subscription with the given ID.

*/ GetCustomersCustomerSubscriptionsSubscriptionExposedId: { parameters: { path: { - customer: string; - subscription_exposed_id: string; - }; + customer: string + subscription_exposed_id: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription"]; - }; - }; + 'application/json': components['schemas']['subscription'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostCustomersCustomerSubscriptionsSubscriptionExposedId: { parameters: { path: { - customer: string; - subscription_exposed_id: string; - }; - }; + customer: string + subscription_exposed_id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription"]; - }; - }; + 'application/json': components['schemas']['subscription'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A list of prices and quantities that will generate invoice items appended to the first invoice for this subscription. You may pass up to 20 items. */ add_invoice_items?: ({ - price?: string; + price?: string /** one_time_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - } & { [key: string]: unknown }; - quantity?: number; - tax_rates?: (Partial & Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown })[]; + unit_amount_decimal?: string + } & { [key: string]: unknown } + quantity?: number + tax_rates?: (Partial & Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown })[] /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). */ - application_fee_percent?: number; + application_fee_percent?: number /** * automatic_tax_config * @description Automatic tax settings for this subscription. */ automatic_tax?: { - enabled: boolean; - } & { [key: string]: unknown }; + enabled: boolean + } & { [key: string]: unknown } /** * @description Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). * @enum {string} */ - billing_cycle_anchor?: "now" | "unchanged"; + billing_cycle_anchor?: 'now' | 'unchanged' /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. */ billing_thresholds?: (Partial< { - amount_gte?: number; - reset_billing_cycle_anchor?: boolean; + amount_gte?: number + reset_billing_cycle_anchor?: boolean } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** @description 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. */ - cancel_at?: (Partial & Partial<"">) & { [key: string]: unknown }; + cancel_at?: (Partial & Partial<''>) & { [key: string]: unknown } /** @description Boolean indicating whether this subscription should cancel at the end of the current period. */ - cancel_at_period_end?: boolean; + cancel_at_period_end?: boolean /** * @description 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. Defaults to `charge_automatically`. * @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' /** @description The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. */ - coupon?: string; + coupon?: string /** @description Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. */ - days_until_due?: number; + days_until_due?: number /** @description 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?: string; + default_payment_method?: string /** @description 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?: string; + default_source?: string /** @description 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. Pass an empty string to remove previously-defined tax rates. */ - default_tax_rates?: (Partial & Partial<"">) & { [key: string]: unknown }; + default_tax_rates?: (Partial & Partial<''>) & { [key: string]: unknown } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A list of up to 20 subscription items, each with an attached price. */ items?: ({ billing_thresholds?: (Partial< { - usage_gte: number; + usage_gte: number } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - clear_usage?: boolean; - deleted?: boolean; - id?: string; - metadata?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; - price?: string; + Partial<''>) & { [key: string]: unknown } + clear_usage?: boolean + deleted?: boolean + id?: string + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } + price?: string /** recurring_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - } & { [key: string]: unknown }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } & { [key: string]: unknown } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - } & { [key: string]: unknown }; - quantity?: number; - tax_rates?: (Partial & Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown })[]; + unit_amount_decimal?: string + } & { [key: string]: unknown } + quantity?: number + tax_rates?: (Partial & Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown })[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. */ - off_session?: boolean; + off_session?: boolean /** @description If specified, payment collection for this subscription will be paused. */ pause_collection?: (Partial< { /** @enum {string} */ - behavior: "keep_as_draft" | "mark_uncollectible" | "void"; + behavior: 'keep_as_draft' | 'mark_uncollectible' | 'void' /** Format: unix-time */ - resumes_at?: number; + resumes_at?: number } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** * @description Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * @@ -24917,11 +24396,7 @@ export interface operations { * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. * @enum {string} */ - payment_behavior?: - | "allow_incomplete" - | "default_incomplete" - | "error_if_incomplete" - | "pending_if_incomplete"; + payment_behavior?: 'allow_incomplete' | 'default_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete' /** * payment_settings * @description Payment settings to pass to invoices created by the subscription. @@ -24934,67 +24409,67 @@ export interface operations { /** mandate_options_param */ mandate_options?: { /** @enum {string} */ - transaction_type?: "business" | "personal"; - } & { [key: string]: unknown }; + transaction_type?: 'business' | 'personal' + } & { [key: string]: unknown } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; + verification_method?: 'automatic' | 'instant' | 'microdeposits' } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } bancontact?: (Partial< { /** @enum {string} */ - preferred_language?: "de" | "en" | "fr" | "nl"; + preferred_language?: 'de' | 'en' | 'fr' | 'nl' } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } card?: (Partial< { /** mandate_options_param */ mandate_options?: { - amount?: number; + amount?: number /** @enum {string} */ - amount_type?: "fixed" | "maximum"; - description?: string; - } & { [key: string]: unknown }; + amount_type?: 'fixed' | 'maximum' + description?: string + } & { [key: string]: unknown } /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: 'any' | 'automatic' } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown } payment_method_types?: (Partial< ( - | "ach_credit_transfer" - | "ach_debit" - | "acss_debit" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "sepa_debit" - | "sofort" - | "wechat_pay" + | 'ach_credit_transfer' + | 'ach_debit' + | 'acss_debit' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' )[] > & - Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown } /** @description 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?: (Partial< { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** @description The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. */ - promotion_code?: string; + promotion_code?: string /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -25003,28 +24478,28 @@ export interface operations { * Prorations can be disabled by passing `none`. * @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** * Format: unix-time * @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations. */ - proration_date?: number; + proration_date?: number /** @description If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. This will be unset if you POST an empty value. */ transfer_data?: (Partial< { - amount_percent?: number; - destination: string; + amount_percent?: number + destination: string } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** @description Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. */ - trial_end?: (Partial<"now"> & Partial) & { [key: string]: unknown }; + trial_end?: (Partial<'now'> & Partial) & { [key: string]: unknown } /** @description 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?: boolean; - }; - }; - }; - }; + trial_from_plan?: boolean + } + } + } + } /** *

Cancels a customer’s subscription. If you set the at_period_end parameter to true, the subscription will remain active until the end of the period, at which point it will be canceled and not renewed. Otherwise, with the default false value, the subscription is terminated immediately. In either case, the customer will not be charged again for the subscription.

* @@ -25035,373 +24510,373 @@ export interface operations { DeleteCustomersCustomerSubscriptionsSubscriptionExposedId: { parameters: { path: { - customer: string; - subscription_exposed_id: string; - }; - }; + customer: string + subscription_exposed_id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription"]; - }; - }; + 'application/json': components['schemas']['subscription'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Can be set to `true` if `at_period_end` is not set to `true`. Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items. */ - invoice_now?: boolean; + invoice_now?: boolean /** @description Can be set to `true` if `at_period_end` is not set to `true`. Will generate a proration invoice item that credits remaining unused time until the subscription period end. */ - prorate?: boolean; - }; - }; - }; - }; + prorate?: boolean + } + } + } + } GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount: { parameters: { path: { - customer: string; - subscription_exposed_id: string; - }; + customer: string + subscription_exposed_id: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["discount"]; - }; - }; + 'application/json': components['schemas']['discount'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Removes the currently applied discount on a customer.

*/ DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount: { parameters: { path: { - customer: string; - subscription_exposed_id: string; - }; - }; + customer: string + subscription_exposed_id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_discount"]; - }; - }; + 'application/json': components['schemas']['deleted_discount'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of tax IDs for a customer.

*/ GetCustomersCustomerTaxIds: { parameters: { path: { - customer: string; - }; + customer: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["tax_id"][]; + data: components['schemas']['tax_id'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new TaxID object for a customer.

*/ PostCustomersCustomerTaxIds: { parameters: { path: { - customer: string; - }; - }; + customer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["tax_id"]; - }; - }; + 'application/json': components['schemas']['tax_id'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * @description Type of the tax ID, one of `ae_trn`, `au_abn`, `au_arn`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `es_cif`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `th_vat`, `tw_vat`, `ua_vat`, `us_ein`, or `za_vat` * @enum {string} */ type: - | "ae_trn" - | "au_abn" - | "au_arn" - | "br_cnpj" - | "br_cpf" - | "ca_bn" - | "ca_gst_hst" - | "ca_pst_bc" - | "ca_pst_mb" - | "ca_pst_sk" - | "ca_qst" - | "ch_vat" - | "cl_tin" - | "es_cif" - | "eu_vat" - | "gb_vat" - | "ge_vat" - | "hk_br" - | "id_npwp" - | "il_vat" - | "in_gst" - | "is_vat" - | "jp_cn" - | "jp_rn" - | "kr_brn" - | "li_uid" - | "mx_rfc" - | "my_frp" - | "my_itn" - | "my_sst" - | "no_vat" - | "nz_gst" - | "ru_inn" - | "ru_kpp" - | "sa_vat" - | "sg_gst" - | "sg_uen" - | "th_vat" - | "tw_vat" - | "ua_vat" - | "us_ein" - | "za_vat"; + | 'ae_trn' + | 'au_abn' + | 'au_arn' + | 'br_cnpj' + | 'br_cpf' + | 'ca_bn' + | 'ca_gst_hst' + | 'ca_pst_bc' + | 'ca_pst_mb' + | 'ca_pst_sk' + | 'ca_qst' + | 'ch_vat' + | 'cl_tin' + | 'es_cif' + | 'eu_vat' + | 'gb_vat' + | 'ge_vat' + | 'hk_br' + | 'id_npwp' + | 'il_vat' + | 'in_gst' + | 'is_vat' + | 'jp_cn' + | 'jp_rn' + | 'kr_brn' + | 'li_uid' + | 'mx_rfc' + | 'my_frp' + | 'my_itn' + | 'my_sst' + | 'no_vat' + | 'nz_gst' + | 'ru_inn' + | 'ru_kpp' + | 'sa_vat' + | 'sg_gst' + | 'sg_uen' + | 'th_vat' + | 'tw_vat' + | 'ua_vat' + | 'us_ein' + | 'za_vat' /** @description Value of the tax ID. */ - value: string; - }; - }; - }; - }; + value: string + } + } + } + } /**

Retrieves the TaxID object with the given identifier.

*/ GetCustomersCustomerTaxIdsId: { parameters: { path: { - customer: string; - id: string; - }; + customer: string + id: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["tax_id"]; - }; - }; + 'application/json': components['schemas']['tax_id'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Deletes an existing TaxID object.

*/ DeleteCustomersCustomerTaxIdsId: { parameters: { path: { - customer: string; - id: string; - }; - }; + customer: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_tax_id"]; - }; - }; + 'application/json': components['schemas']['deleted_tax_id'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of your disputes.

*/ GetDisputes: { parameters: { query: { /** Only return disputes associated to the charge specified by this charge ID. */ - charge?: string; + charge?: string created?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return disputes associated to the PaymentIntent specified by this PaymentIntent ID. */ - payment_intent?: string; + payment_intent?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["dispute"][]; + 'application/json': { + data: components['schemas']['dispute'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves the dispute with the given ID.

*/ GetDisputesDispute: { parameters: { path: { - dispute: string; - }; + dispute: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["dispute"]; - }; - }; + 'application/json': components['schemas']['dispute'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

When you get a dispute, contacting your customer is always the best first step. If that doesn’t work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your dashboard, but if you prefer, you can use the API to submit evidence programmatically.

* @@ -25410,69 +24885,69 @@ export interface operations { PostDisputesDispute: { parameters: { path: { - dispute: string; - }; - }; + dispute: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["dispute"]; - }; - }; + 'application/json': components['schemas']['dispute'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * dispute_evidence_params * @description Evidence to upload, to respond to a dispute. Updating any field in the hash will submit all fields in the hash for review. The combined character count of all fields is limited to 150,000. */ evidence?: { - access_activity_log?: string; - billing_address?: string; - cancellation_policy?: string; - cancellation_policy_disclosure?: string; - cancellation_rebuttal?: string; - customer_communication?: string; - customer_email_address?: string; - customer_name?: string; - customer_purchase_ip?: string; - customer_signature?: string; - duplicate_charge_documentation?: string; - duplicate_charge_explanation?: string; - duplicate_charge_id?: string; - product_description?: string; - receipt?: string; - refund_policy?: string; - refund_policy_disclosure?: string; - refund_refusal_explanation?: string; - service_date?: string; - service_documentation?: string; - shipping_address?: string; - shipping_carrier?: string; - shipping_date?: string; - shipping_documentation?: string; - shipping_tracking_number?: string; - uncategorized_file?: string; - uncategorized_text?: string; - } & { [key: string]: unknown }; + access_activity_log?: string + billing_address?: string + cancellation_policy?: string + cancellation_policy_disclosure?: string + cancellation_rebuttal?: string + customer_communication?: string + customer_email_address?: string + customer_name?: string + customer_purchase_ip?: string + customer_signature?: string + duplicate_charge_documentation?: string + duplicate_charge_explanation?: string + duplicate_charge_id?: string + product_description?: string + receipt?: string + refund_policy?: string + refund_policy_disclosure?: string + refund_refusal_explanation?: string + service_date?: string + service_documentation?: string + shipping_address?: string + shipping_carrier?: string + shipping_date?: string + shipping_documentation?: string + shipping_tracking_number?: string + uncategorized_file?: string + uncategorized_text?: string + } & { [key: string]: unknown } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description Whether to immediately submit evidence to the bank. If `false`, evidence is staged on the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank by making another request with this attribute set to `true` (the default). */ - submit?: boolean; - }; - }; - }; - }; + submit?: boolean + } + } + } + } /** *

Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.

* @@ -25481,485 +24956,485 @@ export interface operations { PostDisputesDisputeClose: { parameters: { path: { - dispute: string; - }; - }; + dispute: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["dispute"]; - }; - }; + 'application/json': components['schemas']['dispute'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

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

*/ PostEphemeralKeys: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["ephemeral_key"]; - }; - }; + 'application/json': components['schemas']['ephemeral_key'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The ID of the Customer you'd like to modify using the resulting ephemeral key. */ - customer?: string; + customer?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The ID of the Issuing Card you'd like to access using the resulting ephemeral key. */ - issuing_card?: string; - }; - }; - }; - }; + issuing_card?: string + } + } + } + } /**

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

*/ DeleteEphemeralKeysKey: { parameters: { path: { - key: string; - }; - }; + key: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["ephemeral_key"]; - }; - }; + 'application/json': components['schemas']['ephemeral_key'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

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).

*/ GetEvents: { parameters: { query: { created?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** 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?: boolean; + delivery_success?: boolean /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** 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?: string; + type?: string /** 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?: string[]; - }; - }; + types?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["event"][]; + 'application/json': { + data: components['schemas']['event'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.

*/ GetEventsId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["event"]; - }; - }; + 'application/json': components['schemas']['event'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ GetExchangeRates: { parameters: { query: { /** 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** 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?: number; + limit?: number /** 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["exchange_rate"][]; + 'application/json': { + data: components['schemas']['exchange_rate'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ GetExchangeRatesRateId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - rate_id: string; - }; - }; + rate_id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["exchange_rate"]; - }; - }; + 'application/json': components['schemas']['exchange_rate'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of file links.

*/ GetFileLinks: { parameters: { query: { created?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** Filter links by their expiration status. By default, all links are returned. */ - expired?: boolean; + expired?: boolean /** Only return links for the given file. */ - file?: string; + file?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["file_link"][]; + 'application/json': { + data: components['schemas']['file_link'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new file link object.

*/ PostFileLinks: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["file_link"]; - }; - }; + 'application/json': components['schemas']['file_link'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * Format: unix-time * @description A future timestamp after which the link will no longer be usable. */ - expires_at?: number; + expires_at?: number /** @description The ID of the file. The file's `purpose` must be one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `finance_report_run`, `identity_document_downloadable`, `pci_document`, `selfie`, `sigma_scheduled_query`, or `tax_document_user_upload`. */ - file: string; + file: string /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; - }; - }; - }; - }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } + } + } + } + } /**

Retrieves the file link with the given ID.

*/ GetFileLinksLink: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - link: string; - }; - }; + link: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["file_link"]; - }; - }; + 'application/json': components['schemas']['file_link'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostFileLinksLink: { parameters: { path: { - link: string; - }; - }; + link: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["file_link"]; - }; - }; + 'application/json': components['schemas']['file_link'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A future timestamp after which the link will no longer be usable, or `now` to expire the link immediately. */ - expires_at?: (Partial<"now"> & Partial & Partial<"">) & { [key: string]: unknown }; + expires_at?: (Partial<'now'> & Partial & Partial<''>) & { [key: string]: unknown } /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; - }; - }; - }; - }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } + } + } + } + } /**

Returns a list of the files that your account has access to. The files are returned sorted by creation date, with the most recently created files appearing first.

*/ GetFiles: { parameters: { query: { created?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** The file purpose to filter queries by. If none is provided, files will not be filtered by purpose. */ purpose?: - | "account_requirement" - | "additional_verification" - | "business_icon" - | "business_logo" - | "customer_signature" - | "dispute_evidence" - | "document_provider_identity_document" - | "finance_report_run" - | "identity_document" - | "identity_document_downloadable" - | "pci_document" - | "selfie" - | "sigma_scheduled_query" - | "tax_document_user_upload"; + | 'account_requirement' + | 'additional_verification' + | 'business_icon' + | 'business_logo' + | 'customer_signature' + | 'dispute_evidence' + | 'document_provider_identity_document' + | 'finance_report_run' + | 'identity_document' + | 'identity_document_downloadable' + | 'pci_document' + | 'selfie' + | 'sigma_scheduled_query' + | 'tax_document_user_upload' /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["file"][]; + 'application/json': { + data: components['schemas']['file'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

To upload a file to Stripe, you’ll need to send a request of type multipart/form-data. The request should contain the file you would like to upload, as well as the parameters for creating a file.

* @@ -25970,227 +25445,227 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["file"]; - }; - }; + 'application/json': components['schemas']['file'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "multipart/form-data": { + 'multipart/form-data': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A file to upload. The file should follow the specifications of RFC 2388 (which defines file transfers for the `multipart/form-data` protocol). */ - file: string; + file: string /** * file_link_creation_params * @description Optional parameters to automatically create a [file link](https://stripe.com/docs/api#file_links) for the newly created file. */ file_link_data?: { - create: boolean; + create: boolean /** Format: unix-time */ - expires_at?: number; - metadata?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown }; + expires_at?: number + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown } /** * @description The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file. * @enum {string} */ purpose: - | "account_requirement" - | "additional_verification" - | "business_icon" - | "business_logo" - | "customer_signature" - | "dispute_evidence" - | "identity_document" - | "pci_document" - | "tax_document_user_upload"; - }; - }; - }; - }; + | 'account_requirement' + | 'additional_verification' + | 'business_icon' + | 'business_logo' + | 'customer_signature' + | 'dispute_evidence' + | 'identity_document' + | 'pci_document' + | 'tax_document_user_upload' + } + } + } + } /**

Retrieves the details of an existing file object. Supply the unique file ID from a file, and Stripe will return the corresponding file object. To access file contents, see the File Upload Guide.

*/ GetFilesFile: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - file: string; - }; - }; + file: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["file"]; - }; - }; + 'application/json': components['schemas']['file'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

List all verification reports.

*/ GetIdentityVerificationReports: { parameters: { query: { created?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return VerificationReports of this type */ - type?: "document" | "id_number"; + type?: 'document' | 'id_number' /** Only return VerificationReports created by this VerificationSession ID. It is allowed to provide a VerificationIntent ID. */ - verification_session?: string; - }; - }; + verification_session?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["identity.verification_report"][]; + 'application/json': { + data: components['schemas']['identity.verification_report'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves an existing VerificationReport

*/ GetIdentityVerificationReportsReport: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - report: string; - }; - }; + report: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["identity.verification_report"]; - }; - }; + 'application/json': components['schemas']['identity.verification_report'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of VerificationSessions

*/ GetIdentityVerificationSessions: { parameters: { query: { created?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return VerificationSessions with this status. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work). */ - status?: "canceled" | "processing" | "requires_input" | "verified"; - }; - }; + status?: 'canceled' | 'processing' | 'requires_input' | 'verified' + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["identity.verification_session"][]; + 'application/json': { + data: components['schemas']['identity.verification_session'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Creates a VerificationSession object.

* @@ -26205,23 +25680,23 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["identity.verification_session"]; - }; - }; + 'application/json': components['schemas']['identity.verification_session'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * session_options_param * @description A set of options for the session’s verification checks. @@ -26229,25 +25704,25 @@ export interface operations { options?: { document?: (Partial< { - allowed_types?: ("driving_license" | "id_card" | "passport")[]; - require_id_number?: boolean; - require_live_capture?: boolean; - require_matching_selfie?: boolean; + allowed_types?: ('driving_license' | 'id_card' | 'passport')[] + require_id_number?: boolean + require_live_capture?: boolean + require_matching_selfie?: boolean } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown } /** @description The URL that the user will be redirected to upon completing the verification flow. */ - return_url?: string; + return_url?: string /** * @description The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. * @enum {string} */ - type: "document" | "id_number"; - }; - }; - }; - }; + type: 'document' | 'id_number' + } + } + } + } /** *

Retrieves the details of a VerificationSession that was previously created.

* @@ -26258,32 +25733,32 @@ export interface operations { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - session: string; - }; - }; + session: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["identity.verification_session"]; - }; - }; + 'application/json': components['schemas']['identity.verification_session'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates a VerificationSession object.

* @@ -26293,30 +25768,30 @@ export interface operations { PostIdentityVerificationSessionsSession: { parameters: { path: { - session: string; - }; - }; + session: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["identity.verification_session"]; - }; - }; + 'application/json': components['schemas']['identity.verification_session'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * session_options_param * @description A set of options for the session’s verification checks. @@ -26324,23 +25799,23 @@ export interface operations { options?: { document?: (Partial< { - allowed_types?: ("driving_license" | "id_card" | "passport")[]; - require_id_number?: boolean; - require_live_capture?: boolean; - require_matching_selfie?: boolean; + allowed_types?: ('driving_license' | 'id_card' | 'passport')[] + require_id_number?: boolean + require_live_capture?: boolean + require_matching_selfie?: boolean } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown } /** * @description The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. * @enum {string} */ - type?: "document" | "id_number"; - }; - }; - }; - }; + type?: 'document' | 'id_number' + } + } + } + } /** *

A VerificationSession object can be canceled when it is in requires_input status.

* @@ -26349,32 +25824,32 @@ export interface operations { PostIdentityVerificationSessionsSessionCancel: { parameters: { path: { - session: string; - }; - }; + session: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["identity.verification_session"]; - }; - }; + 'application/json': components['schemas']['identity.verification_session'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /** *

Redact a VerificationSession to remove all collected information from Stripe. This will redact * the VerificationSession and all objects related to it, including VerificationReports, Events, @@ -26399,466 +25874,466 @@ export interface operations { PostIdentityVerificationSessionsSessionRedact: { parameters: { path: { - session: string; - }; - }; + session: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["identity.verification_session"]; - }; - }; + 'application/json': components['schemas']['identity.verification_session'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

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

*/ GetInvoiceitems: { parameters: { query: { created?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** The identifier of the customer whose invoice items to return. If none is provided, all invoice items will be returned. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** 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?: string; + invoice?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** 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?: boolean; + pending?: boolean /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["invoiceitem"][]; + 'application/json': { + data: components['schemas']['invoiceitem'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostInvoiceitems: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoiceitem"]; - }; - }; + 'application/json': components['schemas']['invoiceitem'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The integer amount in %s of the charge to be applied to the upcoming invoice. Passing in a negative `amount` will reduce the `amount_due` on the invoice. */ - amount?: number; + amount?: number /** @description 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?: string; + currency?: string /** @description The ID of the customer who will be billed when this invoice item is billed. */ - customer: string; + customer: string /** @description An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking. */ - description?: string; + description?: string /** @description Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items. */ - discountable?: boolean; + discountable?: boolean /** @description The coupons to redeem into discounts for the invoice item or invoice line item. */ discounts?: (Partial< ({ - coupon?: string; - discount?: string; + coupon?: string + discount?: string } & { [key: string]: unknown })[] > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The ID of an existing invoice to add this invoice item to. When left blank, the invoice item will be added to the next upcoming scheduled invoice. This is useful when adding invoice items in response to an invoice.created webhook. You can only add invoice items to draft invoices and there is a maximum of 250 items per invoice. */ - invoice?: string; + invoice?: string /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** * period * @description The period associated with this invoice item. */ period?: { /** Format: unix-time */ - end: number; + end: number /** Format: unix-time */ - start: number; - } & { [key: string]: unknown }; + start: number + } & { [key: string]: unknown } /** @description The ID of the price object. */ - price?: string; + price?: string /** * one_time_price_data * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - } & { [key: string]: unknown }; + unit_amount_decimal?: string + } & { [key: string]: unknown } /** @description Non-negative integer. The quantity of units for the invoice item. */ - quantity?: number; + quantity?: number /** @description The ID of a subscription to add this invoice item to. When left blank, the invoice item will be be added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription. */ - subscription?: string; + subscription?: string /** @description 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?: string[]; + tax_rates?: string[] /** @description The integer unit amount in %s of the charge to be applied to the upcoming invoice. This `unit_amount` will be multiplied by the quantity to get the full amount. Passing in a negative `unit_amount` will reduce the `amount_due` on the invoice. */ - unit_amount?: number; + unit_amount?: number /** * Format: decimal * @description Same as `unit_amount`, but accepts a decimal value in %s with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. */ - unit_amount_decimal?: string; - }; - }; - }; - }; + unit_amount_decimal?: string + } + } + } + } /**

Retrieves the invoice item with the given ID.

*/ GetInvoiceitemsInvoiceitem: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - invoiceitem: string; - }; - }; + invoiceitem: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoiceitem"]; - }; - }; + 'application/json': components['schemas']['invoiceitem'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostInvoiceitemsInvoiceitem: { parameters: { path: { - invoiceitem: string; - }; - }; + invoiceitem: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoiceitem"]; - }; - }; + 'application/json': components['schemas']['invoiceitem'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The integer amount in %s of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount. */ - amount?: number; + amount?: number /** @description An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking. */ - description?: string; + description?: string /** @description Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items. Cannot be set to true for prorations. */ - discountable?: boolean; + discountable?: boolean /** @description The coupons & existing discounts which apply to the invoice item or invoice line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts. */ discounts?: (Partial< ({ - coupon?: string; - discount?: string; + coupon?: string + discount?: string } & { [key: string]: unknown })[] > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** * period * @description The period associated with this invoice item. */ period?: { /** Format: unix-time */ - end: number; + end: number /** Format: unix-time */ - start: number; - } & { [key: string]: unknown }; + start: number + } & { [key: string]: unknown } /** @description The ID of the price object. */ - price?: string; + price?: string /** * one_time_price_data * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - } & { [key: string]: unknown }; + unit_amount_decimal?: string + } & { [key: string]: unknown } /** @description Non-negative integer. The quantity of units for the invoice item. */ - quantity?: number; + quantity?: number /** @description 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. Pass an empty string to remove previously-defined tax rates. */ - tax_rates?: (Partial & Partial<"">) & { [key: string]: unknown }; + tax_rates?: (Partial & Partial<''>) & { [key: string]: unknown } /** @description The integer unit amount in %s of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount. */ - unit_amount?: number; + unit_amount?: number /** * Format: decimal * @description Same as `unit_amount`, but accepts a decimal value in %s with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. */ - unit_amount_decimal?: string; - }; - }; - }; - }; + unit_amount_decimal?: string + } + } + } + } /**

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.

*/ DeleteInvoiceitemsInvoiceitem: { parameters: { path: { - invoiceitem: string; - }; - }; + invoiceitem: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_invoiceitem"]; - }; - }; + 'application/json': components['schemas']['deleted_invoiceitem'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ GetInvoices: { parameters: { query: { /** The collection method of the invoice to retrieve. Either `charge_automatically` or `send_invoice`. */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' created?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** Only return invoices for the customer specified by this customer ID. */ - customer?: string; + customer?: string due_date?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** 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?: "draft" | "open" | "paid" | "uncollectible" | "void"; + status?: 'draft' | 'open' | 'paid' | 'uncollectible' | 'void' /** Only return invoices for the subscription specified by this subscription ID. */ - subscription?: string; - }; - }; + subscription?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["invoice"][]; + 'application/json': { + data: components['schemas']['invoice'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

This endpoint creates a draft invoice for a given customer. The draft invoice created pulls in all pending invoice items on that customer, including prorations. The invoice remains a draft until you finalize the invoice, which allows you to pay or send the invoice to your customers.

*/ PostInvoices: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoice"]; - }; - }; + 'application/json': components['schemas']['invoice'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The account tax IDs associated with the invoice. Only editable when the invoice is a draft. */ - account_tax_ids?: (Partial & Partial<"">) & { [key: string]: unknown }; + account_tax_ids?: (Partial & Partial<''>) & { [key: string]: unknown } /** @description A fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees). */ - application_fee_amount?: number; + application_fee_amount?: number /** @description Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice. When `false`, the invoice's state will not automatically advance without an explicit action. */ - auto_advance?: boolean; + auto_advance?: boolean /** * automatic_tax_param * @description Settings for automatic tax lookup for this invoice. */ automatic_tax?: { - enabled: boolean; - } & { [key: string]: unknown }; + enabled: boolean + } & { [key: string]: unknown } /** * @description 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. Defaults to `charge_automatically`. * @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' /** @description A list of up to 4 custom fields to be displayed on the invoice. */ custom_fields?: (Partial< ({ - name: string; - value: string; + name: string + value: string } & { [key: string]: unknown })[] > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** @description The ID of the customer who will be billed. */ - customer: string; + customer: string /** @description The number of days from when the invoice is created until it is due. Valid only for invoices where `collection_method=send_invoice`. */ - days_until_due?: number; + days_until_due?: number /** @description 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?: string; + default_payment_method?: string /** @description 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?: string; + default_source?: string /** @description The tax rates that will apply to any line item that does not have `tax_rates` set. */ - default_tax_rates?: string[]; + default_tax_rates?: string[] /** @description An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. */ - description?: string; + description?: string /** @description The coupons to redeem into discounts for the invoice. If not specified, inherits the discount from the invoice's customer. Pass an empty string to avoid inheriting any discounts. */ discounts?: (Partial< ({ - coupon?: string; - discount?: string; + coupon?: string + discount?: string } & { [key: string]: unknown })[] > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** * Format: unix-time * @description The date on which payment for this invoice is due. Valid only for invoices where `collection_method=send_invoice`. */ - due_date?: number; + due_date?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Footer to be displayed on the invoice. */ - footer?: string; + footer?: string /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description 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?: string; + on_behalf_of?: string /** * payment_settings * @description Configuration settings for the PaymentIntent that is generated when the invoice is finalized. @@ -26871,65 +26346,65 @@ export interface operations { /** mandate_options_param */ mandate_options?: { /** @enum {string} */ - transaction_type?: "business" | "personal"; - } & { [key: string]: unknown }; + transaction_type?: 'business' | 'personal' + } & { [key: string]: unknown } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; + verification_method?: 'automatic' | 'instant' | 'microdeposits' } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } bancontact?: (Partial< { /** @enum {string} */ - preferred_language?: "de" | "en" | "fr" | "nl"; + preferred_language?: 'de' | 'en' | 'fr' | 'nl' } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } card?: (Partial< { /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: 'any' | 'automatic' } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown } payment_method_types?: (Partial< ( - | "ach_credit_transfer" - | "ach_debit" - | "acss_debit" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "sepa_debit" - | "sofort" - | "wechat_pay" + | 'ach_credit_transfer' + | 'ach_debit' + | 'acss_debit' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' )[] > & - Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown } /** @description Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description The ID of the subscription to invoice, if any. If not set, the created invoice will include all pending invoice items for the customer. If set, the created invoice will only include pending invoice items for that subscription and pending invoice items not associated with any subscription. The subscription's billing cycle and regular subscription events won't be affected. */ - subscription?: string; + subscription?: string /** * transfer_data_specs * @description If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge. */ transfer_data?: { - amount?: number; - destination: string; - } & { [key: string]: unknown }; - }; - }; - }; - }; + amount?: number + destination: string + } & { [key: string]: unknown } + } + } + } + } /** *

At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.

* @@ -26942,192 +26417,190 @@ export interface operations { query: { /** Settings for automatic tax lookup for this invoice preview. */ automatic_tax?: { - enabled: boolean; - } & { [key: string]: unknown }; + enabled: boolean + } & { [key: string]: unknown } /** The code of the coupon to apply. If `subscription` or `subscription_items` is provided, the invoice returned will preview updating or creating a subscription with that coupon. Otherwise, it will preview applying that coupon to the customer for the next upcoming invoice from among the customer's subscriptions. The invoice can be previewed without a coupon by passing this value as an empty string. */ - coupon?: string; + coupon?: string /** The identifier of the customer whose upcoming invoice you'd like to retrieve. */ - customer?: string; + customer?: string /** Details about the customer you want to invoice or overrides for an existing customer. */ customer_details?: { address?: (Partial< { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } shipping?: (Partial< { /** optional_fields_address */ address: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - } & { [key: string]: unknown }; - name: string; - phone?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } & { [key: string]: unknown } + name: string + phone?: string } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** tax_param */ tax?: { - ip_address?: (Partial & Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown }; + ip_address?: (Partial & Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown } /** @enum {string} */ - tax_exempt?: "" | "exempt" | "none" | "reverse"; + tax_exempt?: '' | 'exempt' | 'none' | 'reverse' tax_ids?: ({ /** @enum {string} */ type: - | "ae_trn" - | "au_abn" - | "au_arn" - | "br_cnpj" - | "br_cpf" - | "ca_bn" - | "ca_gst_hst" - | "ca_pst_bc" - | "ca_pst_mb" - | "ca_pst_sk" - | "ca_qst" - | "ch_vat" - | "cl_tin" - | "es_cif" - | "eu_vat" - | "gb_vat" - | "ge_vat" - | "hk_br" - | "id_npwp" - | "il_vat" - | "in_gst" - | "is_vat" - | "jp_cn" - | "jp_rn" - | "kr_brn" - | "li_uid" - | "mx_rfc" - | "my_frp" - | "my_itn" - | "my_sst" - | "no_vat" - | "nz_gst" - | "ru_inn" - | "ru_kpp" - | "sa_vat" - | "sg_gst" - | "sg_uen" - | "th_vat" - | "tw_vat" - | "ua_vat" - | "us_ein" - | "za_vat"; - value: string; - } & { [key: string]: unknown })[]; - } & { [key: string]: unknown }; + | 'ae_trn' + | 'au_abn' + | 'au_arn' + | 'br_cnpj' + | 'br_cpf' + | 'ca_bn' + | 'ca_gst_hst' + | 'ca_pst_bc' + | 'ca_pst_mb' + | 'ca_pst_sk' + | 'ca_qst' + | 'ch_vat' + | 'cl_tin' + | 'es_cif' + | 'eu_vat' + | 'gb_vat' + | 'ge_vat' + | 'hk_br' + | 'id_npwp' + | 'il_vat' + | 'in_gst' + | 'is_vat' + | 'jp_cn' + | 'jp_rn' + | 'kr_brn' + | 'li_uid' + | 'mx_rfc' + | 'my_frp' + | 'my_itn' + | 'my_sst' + | 'no_vat' + | 'nz_gst' + | 'ru_inn' + | 'ru_kpp' + | 'sa_vat' + | 'sg_gst' + | 'sg_uen' + | 'th_vat' + | 'tw_vat' + | 'ua_vat' + | 'us_ein' + | 'za_vat' + value: string + } & { [key: string]: unknown })[] + } & { [key: string]: unknown } /** The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the customer or subscription. This only works for coupons directly applied to the invoice. To apply a coupon to a subscription, you must use the `coupon` parameter instead. Pass an empty string to avoid inheriting any discounts. To preview the upcoming invoice for a subscription that hasn't been created, use `coupon` instead. */ discounts?: (Partial< ({ - coupon?: string; - discount?: string; + coupon?: string + discount?: string } & { [key: string]: unknown })[] > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** List of invoice items to add or update in the upcoming invoice preview. */ invoice_items?: ({ - amount?: number; - currency?: string; - description?: string; - discountable?: boolean; + amount?: number + currency?: string + description?: string + discountable?: boolean discounts?: (Partial< ({ - coupon?: string; - discount?: string; + coupon?: string + discount?: string } & { [key: string]: unknown })[] > & - Partial<"">) & { [key: string]: unknown }; - invoiceitem?: string; - metadata?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } + invoiceitem?: string + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** period */ period?: { /** Format: unix-time */ - end: number; + end: number /** Format: unix-time */ - start: number; - } & { [key: string]: unknown }; - price?: string; + start: number + } & { [key: string]: unknown } + price?: string /** one_time_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - } & { [key: string]: unknown }; - quantity?: number; - tax_rates?: (Partial & Partial<"">) & { [key: string]: unknown }; - unit_amount?: number; + unit_amount_decimal?: string + } & { [key: string]: unknown } + quantity?: number + tax_rates?: (Partial & Partial<''>) & { [key: string]: unknown } + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - } & { [key: string]: unknown })[]; + unit_amount_decimal?: string + } & { [key: string]: unknown })[] /** The identifier of the unstarted schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields. */ - schedule?: string; + schedule?: string /** The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions. */ - subscription?: string; + subscription?: string /** 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`. */ - subscription_billing_cycle_anchor?: (Partial<"now" | "unchanged"> & Partial) & { - [key: string]: unknown; - }; + subscription_billing_cycle_anchor?: (Partial<'now' | 'unchanged'> & Partial) & { [key: string]: unknown } /** Timestamp indicating when the subscription should be scheduled to cancel. Will prorate if within the current period and prorations have been enabled using `proration_behavior`. */ - subscription_cancel_at?: (Partial & Partial<"">) & { [key: string]: unknown }; + subscription_cancel_at?: (Partial & Partial<''>) & { [key: string]: unknown } /** Boolean indicating whether this subscription should cancel at the end of the current period. */ - subscription_cancel_at_period_end?: boolean; + subscription_cancel_at_period_end?: boolean /** This simulates the subscription being canceled or expired immediately. */ - subscription_cancel_now?: boolean; + subscription_cancel_now?: boolean /** 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. */ - subscription_default_tax_rates?: (Partial & Partial<"">) & { [key: string]: unknown }; + subscription_default_tax_rates?: (Partial & Partial<''>) & { [key: string]: unknown } /** A list of up to 20 subscription items, each with an attached price. */ subscription_items?: ({ billing_thresholds?: (Partial< { - usage_gte: number; + usage_gte: number } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - clear_usage?: boolean; - deleted?: boolean; - id?: string; - metadata?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; - price?: string; + Partial<''>) & { [key: string]: unknown } + clear_usage?: boolean + deleted?: boolean + id?: string + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } + price?: string /** recurring_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - } & { [key: string]: unknown }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } & { [key: string]: unknown } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - } & { [key: string]: unknown }; - quantity?: number; - tax_rates?: (Partial & Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown })[]; + unit_amount_decimal?: string + } & { [key: string]: unknown } + quantity?: number + tax_rates?: (Partial & Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown })[] /** * Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -27135,235 +26608,233 @@ export interface operations { * * Prorations can be disabled by passing `none`. */ - subscription_proration_behavior?: "always_invoice" | "create_prorations" | "none"; + subscription_proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** 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 cannot be before the subscription was on its current plan. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'. */ - subscription_proration_date?: number; + subscription_proration_date?: number /** Date a subscription is intended to start (can be future or past) */ - subscription_start_date?: number; + subscription_start_date?: number /** 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. */ - subscription_trial_end?: (Partial<"now"> & Partial) & { [key: string]: unknown }; + subscription_trial_end?: (Partial<'now'> & Partial) & { [key: string]: unknown } /** Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `subscription_trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `subscription_trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. */ - subscription_trial_from_plan?: boolean; - }; - }; + subscription_trial_from_plan?: boolean + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoice"]; - }; - }; + 'application/json': components['schemas']['invoice'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ GetInvoicesUpcomingLines: { parameters: { query: { /** Settings for automatic tax lookup for this invoice preview. */ automatic_tax?: { - enabled: boolean; - } & { [key: string]: unknown }; + enabled: boolean + } & { [key: string]: unknown } /** The code of the coupon to apply. If `subscription` or `subscription_items` is provided, the invoice returned will preview updating or creating a subscription with that coupon. Otherwise, it will preview applying that coupon to the customer for the next upcoming invoice from among the customer's subscriptions. The invoice can be previewed without a coupon by passing this value as an empty string. */ - coupon?: string; + coupon?: string /** The identifier of the customer whose upcoming invoice you'd like to retrieve. */ - customer?: string; + customer?: string /** Details about the customer you want to invoice or overrides for an existing customer. */ customer_details?: { address?: (Partial< { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } shipping?: (Partial< { /** optional_fields_address */ address: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - } & { [key: string]: unknown }; - name: string; - phone?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } & { [key: string]: unknown } + name: string + phone?: string } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** tax_param */ tax?: { - ip_address?: (Partial & Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown }; + ip_address?: (Partial & Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown } /** @enum {string} */ - tax_exempt?: "" | "exempt" | "none" | "reverse"; + tax_exempt?: '' | 'exempt' | 'none' | 'reverse' tax_ids?: ({ /** @enum {string} */ type: - | "ae_trn" - | "au_abn" - | "au_arn" - | "br_cnpj" - | "br_cpf" - | "ca_bn" - | "ca_gst_hst" - | "ca_pst_bc" - | "ca_pst_mb" - | "ca_pst_sk" - | "ca_qst" - | "ch_vat" - | "cl_tin" - | "es_cif" - | "eu_vat" - | "gb_vat" - | "ge_vat" - | "hk_br" - | "id_npwp" - | "il_vat" - | "in_gst" - | "is_vat" - | "jp_cn" - | "jp_rn" - | "kr_brn" - | "li_uid" - | "mx_rfc" - | "my_frp" - | "my_itn" - | "my_sst" - | "no_vat" - | "nz_gst" - | "ru_inn" - | "ru_kpp" - | "sa_vat" - | "sg_gst" - | "sg_uen" - | "th_vat" - | "tw_vat" - | "ua_vat" - | "us_ein" - | "za_vat"; - value: string; - } & { [key: string]: unknown })[]; - } & { [key: string]: unknown }; + | 'ae_trn' + | 'au_abn' + | 'au_arn' + | 'br_cnpj' + | 'br_cpf' + | 'ca_bn' + | 'ca_gst_hst' + | 'ca_pst_bc' + | 'ca_pst_mb' + | 'ca_pst_sk' + | 'ca_qst' + | 'ch_vat' + | 'cl_tin' + | 'es_cif' + | 'eu_vat' + | 'gb_vat' + | 'ge_vat' + | 'hk_br' + | 'id_npwp' + | 'il_vat' + | 'in_gst' + | 'is_vat' + | 'jp_cn' + | 'jp_rn' + | 'kr_brn' + | 'li_uid' + | 'mx_rfc' + | 'my_frp' + | 'my_itn' + | 'my_sst' + | 'no_vat' + | 'nz_gst' + | 'ru_inn' + | 'ru_kpp' + | 'sa_vat' + | 'sg_gst' + | 'sg_uen' + | 'th_vat' + | 'tw_vat' + | 'ua_vat' + | 'us_ein' + | 'za_vat' + value: string + } & { [key: string]: unknown })[] + } & { [key: string]: unknown } /** The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the customer or subscription. This only works for coupons directly applied to the invoice. To apply a coupon to a subscription, you must use the `coupon` parameter instead. Pass an empty string to avoid inheriting any discounts. To preview the upcoming invoice for a subscription that hasn't been created, use `coupon` instead. */ discounts?: (Partial< ({ - coupon?: string; - discount?: string; + coupon?: string + discount?: string } & { [key: string]: unknown })[] > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** List of invoice items to add or update in the upcoming invoice preview. */ invoice_items?: ({ - amount?: number; - currency?: string; - description?: string; - discountable?: boolean; + amount?: number + currency?: string + description?: string + discountable?: boolean discounts?: (Partial< ({ - coupon?: string; - discount?: string; + coupon?: string + discount?: string } & { [key: string]: unknown })[] > & - Partial<"">) & { [key: string]: unknown }; - invoiceitem?: string; - metadata?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } + invoiceitem?: string + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** period */ period?: { /** Format: unix-time */ - end: number; + end: number /** Format: unix-time */ - start: number; - } & { [key: string]: unknown }; - price?: string; + start: number + } & { [key: string]: unknown } + price?: string /** one_time_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - } & { [key: string]: unknown }; - quantity?: number; - tax_rates?: (Partial & Partial<"">) & { [key: string]: unknown }; - unit_amount?: number; + unit_amount_decimal?: string + } & { [key: string]: unknown } + quantity?: number + tax_rates?: (Partial & Partial<''>) & { [key: string]: unknown } + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - } & { [key: string]: unknown })[]; + unit_amount_decimal?: string + } & { [key: string]: unknown })[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** The identifier of the unstarted schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields. */ - schedule?: string; + schedule?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions. */ - subscription?: string; + subscription?: string /** 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`. */ - subscription_billing_cycle_anchor?: (Partial<"now" | "unchanged"> & Partial) & { - [key: string]: unknown; - }; + subscription_billing_cycle_anchor?: (Partial<'now' | 'unchanged'> & Partial) & { [key: string]: unknown } /** Timestamp indicating when the subscription should be scheduled to cancel. Will prorate if within the current period and prorations have been enabled using `proration_behavior`. */ - subscription_cancel_at?: (Partial & Partial<"">) & { [key: string]: unknown }; + subscription_cancel_at?: (Partial & Partial<''>) & { [key: string]: unknown } /** Boolean indicating whether this subscription should cancel at the end of the current period. */ - subscription_cancel_at_period_end?: boolean; + subscription_cancel_at_period_end?: boolean /** This simulates the subscription being canceled or expired immediately. */ - subscription_cancel_now?: boolean; + subscription_cancel_now?: boolean /** 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. */ - subscription_default_tax_rates?: (Partial & Partial<"">) & { [key: string]: unknown }; + subscription_default_tax_rates?: (Partial & Partial<''>) & { [key: string]: unknown } /** A list of up to 20 subscription items, each with an attached price. */ subscription_items?: ({ billing_thresholds?: (Partial< { - usage_gte: number; + usage_gte: number } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - clear_usage?: boolean; - deleted?: boolean; - id?: string; - metadata?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; - price?: string; + Partial<''>) & { [key: string]: unknown } + clear_usage?: boolean + deleted?: boolean + id?: string + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } + price?: string /** recurring_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - } & { [key: string]: unknown }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } & { [key: string]: unknown } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - } & { [key: string]: unknown }; - quantity?: number; - tax_rates?: (Partial & Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown })[]; + unit_amount_decimal?: string + } & { [key: string]: unknown } + quantity?: number + tax_rates?: (Partial & Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown })[] /** * Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -27371,80 +26842,80 @@ export interface operations { * * Prorations can be disabled by passing `none`. */ - subscription_proration_behavior?: "always_invoice" | "create_prorations" | "none"; + subscription_proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** 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 cannot be before the subscription was on its current plan. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'. */ - subscription_proration_date?: number; + subscription_proration_date?: number /** Date a subscription is intended to start (can be future or past) */ - subscription_start_date?: number; + subscription_start_date?: number /** 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. */ - subscription_trial_end?: (Partial<"now"> & Partial) & { [key: string]: unknown }; + subscription_trial_end?: (Partial<'now'> & Partial) & { [key: string]: unknown } /** Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `subscription_trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `subscription_trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. */ - subscription_trial_from_plan?: boolean; - }; - }; + subscription_trial_from_plan?: boolean + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["line_item"][]; + data: components['schemas']['line_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves the invoice with the given ID.

*/ GetInvoicesInvoice: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - invoice: string; - }; - }; + invoice: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoice"]; - }; - }; + 'application/json': components['schemas']['invoice'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Draft invoices are fully editable. Once an invoice is finalized, * monetary values, as well as collection_method, become uneditable.

@@ -27456,83 +26927,83 @@ export interface operations { PostInvoicesInvoice: { parameters: { path: { - invoice: string; - }; - }; + invoice: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoice"]; - }; - }; + 'application/json': components['schemas']['invoice'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The account tax IDs associated with the invoice. Only editable when the invoice is a draft. */ - account_tax_ids?: (Partial & Partial<"">) & { [key: string]: unknown }; + account_tax_ids?: (Partial & Partial<''>) & { [key: string]: unknown } /** @description A fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees). */ - application_fee_amount?: number; + application_fee_amount?: number /** @description Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice. */ - auto_advance?: boolean; + auto_advance?: boolean /** * automatic_tax_param * @description Settings for automatic tax lookup for this invoice. */ automatic_tax?: { - enabled: boolean; - } & { [key: string]: unknown }; + enabled: boolean + } & { [key: string]: unknown } /** * @description Either `charge_automatically` or `send_invoice`. This field can be updated only on `draft` invoices. * @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' /** @description A list of up to 4 custom fields to be displayed on the invoice. If a value for `custom_fields` is specified, the list specified will replace the existing custom field list on this invoice. Pass an empty string to remove previously-defined fields. */ custom_fields?: (Partial< ({ - name: string; - value: string; + name: string + value: string } & { [key: string]: unknown })[] > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** @description The number of days from which the invoice is created until it is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices. */ - days_until_due?: number; + days_until_due?: number /** @description 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?: string; + default_payment_method?: string /** @description 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?: string; + default_source?: string /** @description The tax rates that will apply to any line item that does not have `tax_rates` set. Pass an empty string to remove previously-defined tax rates. */ - default_tax_rates?: (Partial & Partial<"">) & { [key: string]: unknown }; + default_tax_rates?: (Partial & Partial<''>) & { [key: string]: unknown } /** @description An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. */ - description?: string; + description?: string /** @description The discounts that will apply to the invoice. Pass an empty string to remove previously-defined discounts. */ discounts?: (Partial< ({ - coupon?: string; - discount?: string; + coupon?: string + discount?: string } & { [key: string]: unknown })[] > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** * Format: unix-time * @description The date on which payment for this invoice is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices. */ - due_date?: number; + due_date?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Footer to be displayed on the invoice. */ - footer?: string; + footer?: string /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description 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?: (Partial & Partial<"">) & { [key: string]: unknown }; + on_behalf_of?: (Partial & Partial<''>) & { [key: string]: unknown } /** * payment_settings * @description Configuration settings for the PaymentIntent that is generated when the invoice is finalized. @@ -27545,245 +27016,245 @@ export interface operations { /** mandate_options_param */ mandate_options?: { /** @enum {string} */ - transaction_type?: "business" | "personal"; - } & { [key: string]: unknown }; + transaction_type?: 'business' | 'personal' + } & { [key: string]: unknown } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; + verification_method?: 'automatic' | 'instant' | 'microdeposits' } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } bancontact?: (Partial< { /** @enum {string} */ - preferred_language?: "de" | "en" | "fr" | "nl"; + preferred_language?: 'de' | 'en' | 'fr' | 'nl' } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } card?: (Partial< { /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: 'any' | 'automatic' } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown } payment_method_types?: (Partial< ( - | "ach_credit_transfer" - | "ach_debit" - | "acss_debit" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "sepa_debit" - | "sofort" - | "wechat_pay" + | 'ach_credit_transfer' + | 'ach_debit' + | 'acss_debit' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' )[] > & - Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown } /** @description Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge. This will be unset if you POST an empty value. */ transfer_data?: (Partial< { - amount?: number; - destination: string; + amount?: number + destination: string } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - }; - }; - }; - }; + Partial<''>) & { [key: string]: unknown } + } + } + } + } /**

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.

*/ DeleteInvoicesInvoice: { parameters: { path: { - invoice: string; - }; - }; + invoice: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_invoice"]; - }; - }; + 'application/json': components['schemas']['deleted_invoice'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostInvoicesInvoiceFinalize: { parameters: { path: { - invoice: string; - }; - }; + invoice: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoice"]; - }; - }; + 'application/json': components['schemas']['invoice'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/invoicing/automatic-charging) of the invoice. When `false`, the invoice's state will not automatically advance without an explicit action. */ - auto_advance?: boolean; + auto_advance?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

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.

*/ GetInvoicesInvoiceLines: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - invoice: string; - }; - }; + invoice: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["line_item"][]; + data: components['schemas']['line_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostInvoicesInvoiceMarkUncollectible: { parameters: { path: { - invoice: string; - }; - }; + invoice: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoice"]; - }; - }; + 'application/json': components['schemas']['invoice'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

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.

*/ PostInvoicesInvoicePay: { parameters: { path: { - invoice: string; - }; - }; + invoice: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoice"]; - }; - }; + 'application/json': components['schemas']['invoice'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * @description In cases where the source used to pay the invoice has insufficient funds, passing `forgive=true` controls whether a charge should be attempted for the full amount available on the source, up to the amount to fully pay the invoice. This effectively forgives the difference between the amount available on the source and the amount due. * * Passing `forgive=false` will fail the charge if the source hasn't been pre-funded with the right amount. An example for this case is with ACH Credit Transfers and wires: if the amount wired is less than the amount due by a small amount, you might want to forgive the difference. Defaults to `false`. */ - forgive?: boolean; + forgive?: boolean /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `true` (off-session). */ - off_session?: boolean; + off_session?: boolean /** @description Boolean representing whether an invoice is paid outside of Stripe. This will result in no charge being made. Defaults to `false`. */ - paid_out_of_band?: boolean; + paid_out_of_band?: boolean /** @description A PaymentMethod to be charged. The PaymentMethod must be the ID of a PaymentMethod belonging to the customer associated with the invoice being paid. */ - payment_method?: string; + payment_method?: string /** @description A payment source to be charged. The source must be the ID of a source belonging to the customer associated with the invoice being paid. */ - source?: string; - }; - }; - }; - }; + source?: string + } + } + } + } /** *

Stripe will automatically send invoices to customers according to your subscriptions settings. However, if you’d like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.

* @@ -27792,109 +27263,109 @@ export interface operations { PostInvoicesInvoiceSend: { parameters: { path: { - invoice: string; - }; - }; + invoice: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoice"]; - }; - }; + 'application/json': components['schemas']['invoice'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.

*/ PostInvoicesInvoiceVoid: { parameters: { path: { - invoice: string; - }; - }; + invoice: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoice"]; - }; - }; + 'application/json': components['schemas']['invoice'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Returns a list of issuer fraud records.

*/ GetIssuerFraudRecords: { parameters: { query: { /** Only return issuer fraud records for the charge specified by this charge ID. */ - charge?: string; + charge?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["issuer_fraud_record"][]; + 'application/json': { + data: components['schemas']['issuer_fraud_record'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Retrieves the details of an issuer fraud record that has previously been created.

* @@ -27904,222 +27375,222 @@ export interface operations { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - issuer_fraud_record: string; - }; - }; + issuer_fraud_record: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuer_fraud_record"]; - }; - }; + 'application/json': components['schemas']['issuer_fraud_record'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ GetIssuingAuthorizations: { parameters: { query: { /** Only return authorizations that belong to the given card. */ - card?: string; + card?: string /** Only return authorizations that belong to the given cardholder. */ - cardholder?: string; + cardholder?: string /** Only return authorizations that were created during the given date interval. */ created?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return authorizations with the given status. One of `pending`, `closed`, or `reversed`. */ - status?: "closed" | "pending" | "reversed"; - }; - }; + status?: 'closed' | 'pending' | 'reversed' + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["issuing.authorization"][]; + 'application/json': { + data: components['schemas']['issuing.authorization'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves an Issuing Authorization object.

*/ GetIssuingAuthorizationsAuthorization: { parameters: { path: { - authorization: string; - }; + authorization: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.authorization"]; - }; - }; + 'application/json': components['schemas']['issuing.authorization'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostIssuingAuthorizationsAuthorization: { parameters: { path: { - authorization: string; - }; - }; + authorization: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.authorization"]; - }; - }; + 'application/json': components['schemas']['issuing.authorization'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; - }; - }; - }; - }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } + } + } + } + } /**

Approves a pending Issuing Authorization object. This request should be made within the timeout window of the real-time authorization flow.

*/ PostIssuingAuthorizationsAuthorizationApprove: { parameters: { path: { - authorization: string; - }; - }; + authorization: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.authorization"]; - }; - }; + 'application/json': components['schemas']['issuing.authorization'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description If the authorization's `pending_request.is_amount_controllable` property is `true`, you may provide this value to control how much to hold for the authorization. Must be positive (use [`decline`](https://stripe.com/docs/api/issuing/authorizations/decline) to decline an authorization request). */ - amount?: number; + amount?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; - }; - }; - }; - }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } + } + } + } + } /**

Declines a pending Issuing Authorization object. This request should be made within the timeout window of the real time authorization flow.

*/ PostIssuingAuthorizationsAuthorizationDecline: { parameters: { path: { - authorization: string; - }; - }; + authorization: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.authorization"]; - }; - }; + 'application/json': components['schemas']['issuing.authorization'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; - }; - }; - }; - }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } + } + } + } + } /**

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

*/ GetIssuingCardholders: { parameters: { @@ -28127,81 +27598,81 @@ export interface operations { /** Only return cardholders that were created during the given date interval. */ created?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** Only return cardholders that have the given email address. */ - email?: string; + email?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return cardholders that have the given phone number. */ - phone_number?: string; + phone_number?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return cardholders that have the given status. One of `active`, `inactive`, or `blocked`. */ - status?: "active" | "blocked" | "inactive"; + status?: 'active' | 'blocked' | 'inactive' /** Only return cardholders that have the given type. One of `individual` or `company`. */ - type?: "company" | "individual"; - }; - }; + type?: 'company' | 'individual' + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["issuing.cardholder"][]; + 'application/json': { + data: components['schemas']['issuing.cardholder'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostIssuingCardholders: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.cardholder"]; - }; - }; + 'application/json': components['schemas']['issuing.cardholder'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * billing_specs * @description The cardholder's billing address. @@ -28209,25 +27680,25 @@ export interface operations { billing: { /** required_address */ address: { - city: string; - country: string; - line1: string; - line2?: string; - postal_code: string; - state?: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + city: string + country: string + line1: string + line2?: string + postal_code: string + state?: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** * company_param * @description Additional information about a `company` cardholder. */ company?: { - tax_id?: string; - } & { [key: string]: unknown }; + tax_id?: string + } & { [key: string]: unknown } /** @description The cardholder's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * individual_param * @description Additional information about an `individual` cardholder. @@ -28235,978 +27706,978 @@ export interface operations { individual?: { /** date_of_birth_specs */ dob?: { - day: number; - month: number; - year: number; - } & { [key: string]: unknown }; - first_name: string; - last_name: string; + day: number + month: number + year: number + } & { [key: string]: unknown } + first_name: string + last_name: string /** person_verification_param */ verification?: { /** person_verification_document_param */ document?: { - back?: string; - front?: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + back?: string + front?: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The cardholder's name. This will be printed on cards issued to them. The maximum length of this field is 24 characters. */ - name: string; + name: string /** @description The cardholder's phone number. This will be transformed to [E.164](https://en.wikipedia.org/wiki/E.164) if it is not provided in that format already. 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?: string; + phone_number?: string /** * authorization_controls_param_v2 * @description 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?: { allowed_categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] blocked_categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] spending_limits?: ({ - amount: number; + amount: number categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] /** @enum {string} */ - interval: "all_time" | "daily" | "monthly" | "per_authorization" | "weekly" | "yearly"; - } & { [key: string]: unknown })[]; - spending_limits_currency?: string; - } & { [key: string]: unknown }; + interval: 'all_time' | 'daily' | 'monthly' | 'per_authorization' | 'weekly' | 'yearly' + } & { [key: string]: unknown })[] + spending_limits_currency?: string + } & { [key: string]: unknown } /** * @description Specifies whether to permit authorizations on this cardholder's cards. Defaults to `active`. * @enum {string} */ - status?: "active" | "inactive"; + status?: 'active' | 'inactive' /** * @description One of `individual` or `company`. * @enum {string} */ - type: "company" | "individual"; - }; - }; - }; - }; + type: 'company' | 'individual' + } + } + } + } /**

Retrieves an Issuing Cardholder object.

*/ GetIssuingCardholdersCardholder: { parameters: { path: { - cardholder: string; - }; + cardholder: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.cardholder"]; - }; - }; + 'application/json': components['schemas']['issuing.cardholder'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostIssuingCardholdersCardholder: { parameters: { path: { - cardholder: string; - }; - }; + cardholder: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.cardholder"]; - }; - }; + 'application/json': components['schemas']['issuing.cardholder'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * billing_specs * @description The cardholder's billing address. @@ -29214,25 +28685,25 @@ export interface operations { billing?: { /** required_address */ address: { - city: string; - country: string; - line1: string; - line2?: string; - postal_code: string; - state?: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; - /** + city: string + country: string + line1: string + line2?: string + postal_code: string + state?: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } + /** * company_param * @description Additional information about a `company` cardholder. */ company?: { - tax_id?: string; - } & { [key: string]: unknown }; + tax_id?: string + } & { [key: string]: unknown } /** @description The cardholder's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * individual_param * @description Additional information about an `individual` cardholder. @@ -29240,1017 +28711,1017 @@ export interface operations { individual?: { /** date_of_birth_specs */ dob?: { - day: number; - month: number; - year: number; - } & { [key: string]: unknown }; - first_name: string; - last_name: string; + day: number + month: number + year: number + } & { [key: string]: unknown } + first_name: string + last_name: string /** person_verification_param */ verification?: { /** person_verification_document_param */ document?: { - back?: string; - front?: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + back?: string + front?: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description 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) for more details. */ - phone_number?: string; + phone_number?: string /** * authorization_controls_param_v2 * @description 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?: { allowed_categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] blocked_categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] spending_limits?: ({ - amount: number; + amount: number categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] /** @enum {string} */ - interval: "all_time" | "daily" | "monthly" | "per_authorization" | "weekly" | "yearly"; - } & { [key: string]: unknown })[]; - spending_limits_currency?: string; - } & { [key: string]: unknown }; + interval: 'all_time' | 'daily' | 'monthly' | 'per_authorization' | 'weekly' | 'yearly' + } & { [key: string]: unknown })[] + spending_limits_currency?: string + } & { [key: string]: unknown } /** * @description Specifies whether to permit authorizations on this cardholder's cards. * @enum {string} */ - status?: "active" | "inactive"; - }; - }; - }; - }; + status?: 'active' | 'inactive' + } + } + } + } /**

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

*/ GetIssuingCards: { parameters: { query: { /** Only return cards belonging to the Cardholder with the provided ID. */ - cardholder?: string; + cardholder?: string /** Only return cards that were issued during the given date interval. */ created?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Only return cards that have the given expiration month. */ - exp_month?: number; + exp_month?: number /** Only return cards that have the given expiration year. */ - exp_year?: number; + exp_year?: number /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** Only return cards that have the given last four digits. */ - last4?: string; + last4?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return cards that have the given status. One of `active`, `inactive`, or `canceled`. */ - status?: "active" | "canceled" | "inactive"; + status?: 'active' | 'canceled' | 'inactive' /** Only return cards that have the given type. One of `virtual` or `physical`. */ - type?: "physical" | "virtual"; - }; - }; + type?: 'physical' | 'virtual' + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["issuing.card"][]; + 'application/json': { + data: components['schemas']['issuing.card'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates an Issuing Card object.

*/ PostIssuingCards: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.card"]; - }; - }; + 'application/json': components['schemas']['issuing.card'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The [Cardholder](https://stripe.com/docs/api#issuing_cardholder_object) object with which the card will be associated. */ - cardholder?: string; + cardholder?: string /** @description The currency for the card. */ - currency: string; + currency: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The card this is meant to be a replacement for (if any). */ - replacement_for?: string; + replacement_for?: string /** * @description If `replacement_for` is specified, this should indicate why that card is being replaced. * @enum {string} */ - replacement_reason?: "damaged" | "expired" | "lost" | "stolen"; + replacement_reason?: 'damaged' | 'expired' | 'lost' | 'stolen' /** * shipping_specs * @description The address where the card will be shipped. @@ -30258,1875 +29729,1875 @@ export interface operations { shipping?: { /** required_address */ address: { - city: string; - country: string; - line1: string; - line2?: string; - postal_code: string; - state?: string; - } & { [key: string]: unknown }; - name: string; + city: string + country: string + line1: string + line2?: string + postal_code: string + state?: string + } & { [key: string]: unknown } + name: string /** @enum {string} */ - service?: "express" | "priority" | "standard"; + service?: 'express' | 'priority' | 'standard' /** @enum {string} */ - type?: "bulk" | "individual"; - } & { [key: string]: unknown }; + type?: 'bulk' | 'individual' + } & { [key: string]: unknown } /** * authorization_controls_param * @description Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details. */ spending_controls?: { allowed_categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] blocked_categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] spending_limits?: ({ - amount: number; + amount: number categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] /** @enum {string} */ - interval: "all_time" | "daily" | "monthly" | "per_authorization" | "weekly" | "yearly"; - } & { [key: string]: unknown })[]; - } & { [key: string]: unknown }; + interval: 'all_time' | 'daily' | 'monthly' | 'per_authorization' | 'weekly' | 'yearly' + } & { [key: string]: unknown })[] + } & { [key: string]: unknown } /** * @description Whether authorizations can be approved on this card. Defaults to `inactive`. * @enum {string} */ - status?: "active" | "inactive"; + status?: 'active' | 'inactive' /** * @description The type of card to issue. Possible values are `physical` or `virtual`. * @enum {string} */ - type: "physical" | "virtual"; - }; - }; - }; - }; + type: 'physical' | 'virtual' + } + } + } + } /**

Retrieves an Issuing Card object.

*/ GetIssuingCardsCard: { parameters: { path: { - card: string; - }; + card: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.card"]; - }; - }; + 'application/json': components['schemas']['issuing.card'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostIssuingCardsCard: { parameters: { path: { - card: string; - }; - }; + card: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.card"]; - }; - }; + 'application/json': components['schemas']['issuing.card'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * @description Reason why the `status` of this card is `canceled`. * @enum {string} */ - cancellation_reason?: "lost" | "stolen"; + cancellation_reason?: 'lost' | 'stolen' /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** * encrypted_pin_param * @description The desired new PIN for this card. */ pin?: { - encrypted_number?: string; - } & { [key: string]: unknown }; + encrypted_number?: string + } & { [key: string]: unknown } /** * authorization_controls_param * @description Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details. */ spending_controls?: { allowed_categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] blocked_categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] spending_limits?: ({ - amount: number; + amount: number categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] /** @enum {string} */ - interval: "all_time" | "daily" | "monthly" | "per_authorization" | "weekly" | "yearly"; - } & { [key: string]: unknown })[]; - } & { [key: string]: unknown }; + interval: 'all_time' | 'daily' | 'monthly' | 'per_authorization' | 'weekly' | 'yearly' + } & { [key: string]: unknown })[] + } & { [key: string]: unknown } /** * @description Dictates whether authorizations can be approved on this card. If this card is being canceled because it was lost or stolen, this information should be provided as `cancellation_reason`. * @enum {string} */ - status?: "active" | "canceled" | "inactive"; - }; - }; - }; - }; + status?: 'active' | 'canceled' | 'inactive' + } + } + } + } /**

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

*/ GetIssuingDisputes: { parameters: { @@ -32134,77 +31605,77 @@ export interface operations { /** Select Issuing disputes that were created during the given date interval. */ created?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Select Issuing disputes with the given status. */ - status?: "expired" | "lost" | "submitted" | "unsubmitted" | "won"; + status?: 'expired' | 'lost' | 'submitted' | 'unsubmitted' | 'won' /** Select the Issuing dispute for the given transaction. */ - transaction?: string; - }; - }; + transaction?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["issuing.dispute"][]; + 'application/json': { + data: components['schemas']['issuing.dispute'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostIssuingDisputes: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.dispute"]; - }; - }; + 'application/json': components['schemas']['issuing.dispute'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * evidence_param * @description Evidence provided for the dispute. @@ -32212,157 +31683,150 @@ export interface operations { evidence?: { canceled?: (Partial< { - additional_documentation?: (Partial & Partial<"">) & { [key: string]: unknown }; - canceled_at?: (Partial & Partial<"">) & { [key: string]: unknown }; - cancellation_policy_provided?: (Partial & Partial<"">) & { [key: string]: unknown }; - cancellation_reason?: string; - expected_at?: (Partial & Partial<"">) & { [key: string]: unknown }; - explanation?: string; - product_description?: string; + additional_documentation?: (Partial & Partial<''>) & { [key: string]: unknown } + canceled_at?: (Partial & Partial<''>) & { [key: string]: unknown } + cancellation_policy_provided?: (Partial & Partial<''>) & { [key: string]: unknown } + cancellation_reason?: string + expected_at?: (Partial & Partial<''>) & { [key: string]: unknown } + explanation?: string + product_description?: string /** @enum {string} */ - product_type?: "" | "merchandise" | "service"; + product_type?: '' | 'merchandise' | 'service' /** @enum {string} */ - return_status?: "" | "merchant_rejected" | "successful"; - returned_at?: (Partial & Partial<"">) & { [key: string]: unknown }; + return_status?: '' | 'merchant_rejected' | 'successful' + returned_at?: (Partial & Partial<''>) & { [key: string]: unknown } } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } duplicate?: (Partial< { - additional_documentation?: (Partial & Partial<"">) & { [key: string]: unknown }; - card_statement?: (Partial & Partial<"">) & { [key: string]: unknown }; - cash_receipt?: (Partial & Partial<"">) & { [key: string]: unknown }; - check_image?: (Partial & Partial<"">) & { [key: string]: unknown }; - explanation?: string; - original_transaction?: string; + additional_documentation?: (Partial & Partial<''>) & { [key: string]: unknown } + card_statement?: (Partial & Partial<''>) & { [key: string]: unknown } + cash_receipt?: (Partial & Partial<''>) & { [key: string]: unknown } + check_image?: (Partial & Partial<''>) & { [key: string]: unknown } + explanation?: string + original_transaction?: string } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } fraudulent?: (Partial< { - additional_documentation?: (Partial & Partial<"">) & { [key: string]: unknown }; - explanation?: string; + additional_documentation?: (Partial & Partial<''>) & { [key: string]: unknown } + explanation?: string } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } merchandise_not_as_described?: (Partial< { - additional_documentation?: (Partial & Partial<"">) & { [key: string]: unknown }; - explanation?: string; - received_at?: (Partial & Partial<"">) & { [key: string]: unknown }; - return_description?: string; + additional_documentation?: (Partial & Partial<''>) & { [key: string]: unknown } + explanation?: string + received_at?: (Partial & Partial<''>) & { [key: string]: unknown } + return_description?: string /** @enum {string} */ - return_status?: "" | "merchant_rejected" | "successful"; - returned_at?: (Partial & Partial<"">) & { [key: string]: unknown }; + return_status?: '' | 'merchant_rejected' | 'successful' + returned_at?: (Partial & Partial<''>) & { [key: string]: unknown } } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } not_received?: (Partial< { - additional_documentation?: (Partial & Partial<"">) & { [key: string]: unknown }; - expected_at?: (Partial & Partial<"">) & { [key: string]: unknown }; - explanation?: string; - product_description?: string; + additional_documentation?: (Partial & Partial<''>) & { [key: string]: unknown } + expected_at?: (Partial & Partial<''>) & { [key: string]: unknown } + explanation?: string + product_description?: string /** @enum {string} */ - product_type?: "" | "merchandise" | "service"; + product_type?: '' | 'merchandise' | 'service' } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } other?: (Partial< { - additional_documentation?: (Partial & Partial<"">) & { [key: string]: unknown }; - explanation?: string; - product_description?: string; + additional_documentation?: (Partial & Partial<''>) & { [key: string]: unknown } + explanation?: string + product_description?: string /** @enum {string} */ - product_type?: "" | "merchandise" | "service"; + product_type?: '' | 'merchandise' | 'service' } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** @enum {string} */ - reason?: - | "canceled" - | "duplicate" - | "fraudulent" - | "merchandise_not_as_described" - | "not_received" - | "other" - | "service_not_as_described"; + reason?: 'canceled' | 'duplicate' | 'fraudulent' | 'merchandise_not_as_described' | 'not_received' | 'other' | 'service_not_as_described' service_not_as_described?: (Partial< { - additional_documentation?: (Partial & Partial<"">) & { [key: string]: unknown }; - canceled_at?: (Partial & Partial<"">) & { [key: string]: unknown }; - cancellation_reason?: string; - explanation?: string; - received_at?: (Partial & Partial<"">) & { [key: string]: unknown }; + additional_documentation?: (Partial & Partial<''>) & { [key: string]: unknown } + canceled_at?: (Partial & Partial<''>) & { [key: string]: unknown } + cancellation_reason?: string + explanation?: string + received_at?: (Partial & Partial<''>) & { [key: string]: unknown } } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The ID of the issuing transaction to create a dispute for. */ - transaction: string; - }; - }; - }; - }; + transaction: string + } + } + } + } /**

Retrieves an Issuing Dispute object.

*/ GetIssuingDisputesDispute: { parameters: { path: { - dispute: string; - }; + dispute: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.dispute"]; - }; - }; + 'application/json': components['schemas']['issuing.dispute'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostIssuingDisputesDispute: { parameters: { path: { - dispute: string; - }; - }; + dispute: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.dispute"]; - }; - }; + 'application/json': components['schemas']['issuing.dispute'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * evidence_param * @description Evidence provided for the dispute. @@ -32370,132 +31834,125 @@ export interface operations { evidence?: { canceled?: (Partial< { - additional_documentation?: (Partial & Partial<"">) & { [key: string]: unknown }; - canceled_at?: (Partial & Partial<"">) & { [key: string]: unknown }; - cancellation_policy_provided?: (Partial & Partial<"">) & { [key: string]: unknown }; - cancellation_reason?: string; - expected_at?: (Partial & Partial<"">) & { [key: string]: unknown }; - explanation?: string; - product_description?: string; + additional_documentation?: (Partial & Partial<''>) & { [key: string]: unknown } + canceled_at?: (Partial & Partial<''>) & { [key: string]: unknown } + cancellation_policy_provided?: (Partial & Partial<''>) & { [key: string]: unknown } + cancellation_reason?: string + expected_at?: (Partial & Partial<''>) & { [key: string]: unknown } + explanation?: string + product_description?: string /** @enum {string} */ - product_type?: "" | "merchandise" | "service"; + product_type?: '' | 'merchandise' | 'service' /** @enum {string} */ - return_status?: "" | "merchant_rejected" | "successful"; - returned_at?: (Partial & Partial<"">) & { [key: string]: unknown }; + return_status?: '' | 'merchant_rejected' | 'successful' + returned_at?: (Partial & Partial<''>) & { [key: string]: unknown } } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } duplicate?: (Partial< { - additional_documentation?: (Partial & Partial<"">) & { [key: string]: unknown }; - card_statement?: (Partial & Partial<"">) & { [key: string]: unknown }; - cash_receipt?: (Partial & Partial<"">) & { [key: string]: unknown }; - check_image?: (Partial & Partial<"">) & { [key: string]: unknown }; - explanation?: string; - original_transaction?: string; + additional_documentation?: (Partial & Partial<''>) & { [key: string]: unknown } + card_statement?: (Partial & Partial<''>) & { [key: string]: unknown } + cash_receipt?: (Partial & Partial<''>) & { [key: string]: unknown } + check_image?: (Partial & Partial<''>) & { [key: string]: unknown } + explanation?: string + original_transaction?: string } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } fraudulent?: (Partial< { - additional_documentation?: (Partial & Partial<"">) & { [key: string]: unknown }; - explanation?: string; + additional_documentation?: (Partial & Partial<''>) & { [key: string]: unknown } + explanation?: string } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } merchandise_not_as_described?: (Partial< { - additional_documentation?: (Partial & Partial<"">) & { [key: string]: unknown }; - explanation?: string; - received_at?: (Partial & Partial<"">) & { [key: string]: unknown }; - return_description?: string; + additional_documentation?: (Partial & Partial<''>) & { [key: string]: unknown } + explanation?: string + received_at?: (Partial & Partial<''>) & { [key: string]: unknown } + return_description?: string /** @enum {string} */ - return_status?: "" | "merchant_rejected" | "successful"; - returned_at?: (Partial & Partial<"">) & { [key: string]: unknown }; + return_status?: '' | 'merchant_rejected' | 'successful' + returned_at?: (Partial & Partial<''>) & { [key: string]: unknown } } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } not_received?: (Partial< { - additional_documentation?: (Partial & Partial<"">) & { [key: string]: unknown }; - expected_at?: (Partial & Partial<"">) & { [key: string]: unknown }; - explanation?: string; - product_description?: string; + additional_documentation?: (Partial & Partial<''>) & { [key: string]: unknown } + expected_at?: (Partial & Partial<''>) & { [key: string]: unknown } + explanation?: string + product_description?: string /** @enum {string} */ - product_type?: "" | "merchandise" | "service"; + product_type?: '' | 'merchandise' | 'service' } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } other?: (Partial< { - additional_documentation?: (Partial & Partial<"">) & { [key: string]: unknown }; - explanation?: string; - product_description?: string; + additional_documentation?: (Partial & Partial<''>) & { [key: string]: unknown } + explanation?: string + product_description?: string /** @enum {string} */ - product_type?: "" | "merchandise" | "service"; + product_type?: '' | 'merchandise' | 'service' } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** @enum {string} */ - reason?: - | "canceled" - | "duplicate" - | "fraudulent" - | "merchandise_not_as_described" - | "not_received" - | "other" - | "service_not_as_described"; + reason?: 'canceled' | 'duplicate' | 'fraudulent' | 'merchandise_not_as_described' | 'not_received' | 'other' | 'service_not_as_described' service_not_as_described?: (Partial< { - additional_documentation?: (Partial & Partial<"">) & { [key: string]: unknown }; - canceled_at?: (Partial & Partial<"">) & { [key: string]: unknown }; - cancellation_reason?: string; - explanation?: string; - received_at?: (Partial & Partial<"">) & { [key: string]: unknown }; + additional_documentation?: (Partial & Partial<''>) & { [key: string]: unknown } + canceled_at?: (Partial & Partial<''>) & { [key: string]: unknown } + cancellation_reason?: string + explanation?: string + received_at?: (Partial & Partial<''>) & { [key: string]: unknown } } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; - }; - }; - }; - }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } + } + } + } + } /**

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.

*/ PostIssuingDisputesDisputeSubmit: { parameters: { path: { - dispute: string; - }; - }; + dispute: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.dispute"]; - }; - }; + 'application/json': components['schemas']['issuing.dispute'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; - }; - }; - }; - }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } + } + } + } + } /**

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

*/ GetIssuingSettlements: { parameters: { @@ -32503,272 +31960,272 @@ export interface operations { /** Only return issuing settlements that were created during the given date interval. */ created?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["issuing.settlement"][]; + 'application/json': { + data: components['schemas']['issuing.settlement'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves an Issuing Settlement object.

*/ GetIssuingSettlementsSettlement: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - settlement: string; - }; - }; + settlement: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.settlement"]; - }; - }; + 'application/json': components['schemas']['issuing.settlement'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostIssuingSettlementsSettlement: { parameters: { path: { - settlement: string; - }; - }; + settlement: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.settlement"]; - }; - }; + 'application/json': components['schemas']['issuing.settlement'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; - }; - }; - }; - }; + metadata?: { [key: string]: string } + } + } + } + } /**

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.

*/ GetIssuingTransactions: { parameters: { query: { /** Only return transactions that belong to the given card. */ - card?: string; + card?: string /** Only return transactions that belong to the given cardholder. */ - cardholder?: string; + cardholder?: string /** Only return transactions that were created during the given date interval. */ created?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return transactions that have the given type. One of `capture` or `refund`. */ - type?: "capture" | "refund"; - }; - }; + type?: 'capture' | 'refund' + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["issuing.transaction"][]; + 'application/json': { + data: components['schemas']['issuing.transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves an Issuing Transaction object.

*/ GetIssuingTransactionsTransaction: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - transaction: string; - }; - }; + transaction: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.transaction"]; - }; - }; + 'application/json': components['schemas']['issuing.transaction'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostIssuingTransactionsTransaction: { parameters: { path: { - transaction: string; - }; - }; + transaction: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.transaction"]; - }; - }; + 'application/json': components['schemas']['issuing.transaction'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; - }; - }; - }; - }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } + } + } + } + } /**

Retrieves a Mandate object.

*/ GetMandatesMandate: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - mandate: string; - }; - }; + mandate: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["mandate"]; - }; - }; + 'application/json': components['schemas']['mandate'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ GetOrderReturns: { parameters: { @@ -32776,87 +32233,87 @@ export interface operations { /** Date this return was created. */ created?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** The order to retrieve returns for. */ - order?: string; + order?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["order_return"][]; + 'application/json': { + data: components['schemas']['order_return'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ GetOrderReturnsId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["order_return"]; - }; - }; + 'application/json': components['schemas']['order_return'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ GetOrders: { parameters: { @@ -32864,142 +32321,142 @@ export interface operations { /** Date this order was created. */ created?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** Only return orders for the given customer. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** Only return orders with the given IDs. */ - ids?: string[]; + ids?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return orders that have the given status. One of `created`, `paid`, `fulfilled`, or `refunded`. */ - status?: string; + status?: string /** Filter orders based on when they were paid, fulfilled, canceled, or returned. */ status_transitions?: { canceled?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } fulfilled?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } paid?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } returned?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; - } & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } + } & { [key: string]: unknown } /** Only return orders with the given upstream order IDs. */ - upstream_ids?: string[]; - }; - }; + upstream_ids?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["order"][]; + 'application/json': { + data: components['schemas']['order'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new order object.

*/ PostOrders: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["order"]; - }; - }; + 'application/json': components['schemas']['order'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A coupon code that represents a discount to be applied to this order. Must be one-time duration and in same currency as the order. An order can have multiple coupons. */ - coupon?: string; + coupon?: string /** @description 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: string; + currency: string /** @description The ID of an existing customer to use for this order. If provided, the customer email and shipping address will be used to create the order. Subsequently, the customer will also be charged to pay the order. If `email` or `shipping` are also provided, they will override the values retrieved from the customer object. */ - customer?: string; + customer?: string /** @description The email address of the customer placing the order. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description List of items constituting the order. An order can have up to 25 items. */ items?: ({ - amount?: number; - currency?: string; - description?: string; - parent?: string; - quantity?: number; + amount?: number + currency?: string + description?: string + parent?: string + quantity?: number /** @enum {string} */ - type?: "discount" | "shipping" | "sku" | "tax"; - } & { [key: string]: unknown })[]; + type?: 'discount' | 'shipping' | 'sku' | 'tax' + } & { [key: string]: unknown })[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * customer_shipping * @description Shipping address for the order. Required if any of the SKUs are for products that have `shippable` set to true. @@ -33007,182 +32464,182 @@ export interface operations { shipping?: { /** optional_fields_address */ address: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - } & { [key: string]: unknown }; - name: string; - phone?: string; - } & { [key: string]: unknown }; - }; - }; - }; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } & { [key: string]: unknown } + name: string + phone?: string + } & { [key: string]: unknown } + } + } + } + } /**

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

*/ GetOrdersId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["order"]; - }; - }; + 'application/json': components['schemas']['order'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostOrdersId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["order"]; - }; - }; + 'application/json': components['schemas']['order'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A coupon code that represents a discount to be applied to this order. Must be one-time duration and in same currency as the order. An order can have multiple coupons. */ - coupon?: string; + coupon?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description The shipping method to select for fulfilling this order. If specified, must be one of the `id`s of a shipping method in the `shipping_methods` array. If specified, will overwrite the existing selected shipping method, updating `items` as necessary. */ - selected_shipping_method?: string; + selected_shipping_method?: string /** * shipping_tracking_params * @description Tracking information once the order has been fulfilled. */ shipping?: { - carrier: string; - tracking_number: string; - } & { [key: string]: unknown }; + carrier: string + tracking_number: string + } & { [key: string]: unknown } /** * @description Current order status. One of `created`, `paid`, `canceled`, `fulfilled`, or `returned`. More detail in the [Orders Guide](https://stripe.com/docs/orders/guide#understanding-order-statuses). * @enum {string} */ - status?: "canceled" | "created" | "fulfilled" | "paid" | "returned"; - }; - }; - }; - }; + status?: 'canceled' | 'created' | 'fulfilled' | 'paid' | 'returned' + } + } + } + } /**

Pay an order by providing a source to create a payment.

*/ PostOrdersIdPay: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["order"]; - }; - }; + 'application/json': components['schemas']['order'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A fee in %s that will be applied to the order and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the `Stripe-Account` header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees). */ - application_fee?: number; + application_fee?: number /** @description The ID of an existing customer that will be charged for this order. If no customer was attached to the order at creation, either `source` or `customer` is required. Otherwise, the specified customer will be charged instead of the one attached to the order. */ - customer?: string; + customer?: string /** @description The email address of the customer placing the order. Required if not previously specified for the order. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description A [Token](https://stripe.com/docs/api#tokens)'s or a [Source](https://stripe.com/docs/api#sources)'s ID, as returned by [Elements](https://stripe.com/docs/elements). If no customer was attached to the order at creation, either `source` or `customer` is required. Otherwise, the specified source will be charged intead of the customer attached to the order. */ - source?: string; - }; - }; - }; - }; + source?: string + } + } + } + } /**

Return all or part of an order. The order must have a status of paid or fulfilled before it can be returned. Once all items have been returned, the order will become canceled or returned depending on which status the order started in.

*/ PostOrdersIdReturns: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["order_return"]; - }; - }; + 'application/json': components['schemas']['order_return'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description List of items to return. */ items?: (Partial< ({ - amount?: number; - description?: string; - parent?: string; - quantity?: number; + amount?: number + description?: string + parent?: string + quantity?: number /** @enum {string} */ - type?: "discount" | "shipping" | "sku" | "tax"; + type?: 'discount' | 'shipping' | 'sku' | 'tax' } & { [key: string]: unknown })[] > & - Partial<"">) & { [key: string]: unknown }; - }; - }; - }; - }; + Partial<''>) & { [key: string]: unknown } + } + } + } + } /**

Returns a list of PaymentIntents.

*/ GetPaymentIntents: { parameters: { @@ -33190,56 +32647,56 @@ export interface operations { /** 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?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** Only return PaymentIntents for the customer specified by this customer ID. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["payment_intent"][]; + 'application/json': { + data: components['schemas']['payment_intent'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Creates a PaymentIntent object.

* @@ -33257,41 +32714,41 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_intent"]; - }; - }; + 'application/json': components['schemas']['payment_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description 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: number; + amount: number /** @description 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?: number; + application_fee_amount?: number /** * automatic_payment_methods_param * @description When enabled, this PaymentIntent will accept payment methods that you have enabled in the Dashboard and are compatible with this PaymentIntent's other parameters. */ automatic_payment_methods?: { - enabled: boolean; - } & { [key: string]: unknown }; + enabled: boolean + } & { [key: string]: unknown } /** * @description Controls when the funds will be captured from the customer's account. * @enum {string} */ - capture_method?: "automatic" | "manual"; + capture_method?: 'automatic' | 'manual' /** @description Set to `true` to attempt to [confirm](https://stripe.com/docs/api/payment_intents/confirm) this PaymentIntent immediately. This parameter defaults to `false`. When creating and confirming a PaymentIntent at the same time, parameters available in the [confirm](https://stripe.com/docs/api/payment_intents/confirm) API may also be provided. */ - confirm?: boolean; + confirm?: boolean /** @enum {string} */ - confirmation_method?: "automatic" | "manual"; + confirmation_method?: 'automatic' | 'manual' /** @description 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: string; + currency: string /** * @description ID of the Customer this PaymentIntent belongs to, if one exists. * @@ -33299,15 +32756,15 @@ export interface operations { * * If present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. */ - customer?: string; + customer?: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. This parameter is intended for simpler integrations that do not handle customer actions, like [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). */ - error_on_requires_action?: boolean; + error_on_requires_action?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description ID of the mandate to be used for this payment. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). */ - mandate?: string; + mandate?: string /** * secret_key_param * @description This hash contains details about the Mandate to create. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). @@ -33316,30 +32773,30 @@ export interface operations { /** customer_acceptance_param */ customer_acceptance: { /** Format: unix-time */ - accepted_at?: number; + accepted_at?: number /** offline_param */ - offline?: { [key: string]: unknown }; + offline?: { [key: string]: unknown } /** online_param */ online?: { - ip_address: string; - user_agent: string; - } & { [key: string]: unknown }; + ip_address: string + user_agent: string + } & { [key: string]: unknown } /** @enum {string} */ - type: "offline" | "online"; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + type: 'offline' | 'online' + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description Set to `true` to indicate that the customer is not in your checkout flow during this payment attempt, and therefore is unable to authenticate. This parameter is intended for scenarios where you collect card details and [charge them later](https://stripe.com/docs/payments/cards/charging-saved-cards). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). */ - off_session?: (Partial & Partial<"one_off" | "recurring">) & { [key: string]: unknown }; + off_session?: (Partial & Partial<'one_off' | 'recurring'>) & { [key: string]: unknown } /** @description The Stripe account ID for which these funds are intended. For details, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ - on_behalf_of?: string; + on_behalf_of?: string /** * @description ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. * * If this parameter is omitted with `confirm=true`, `customer.default_source` will be attached as this PaymentIntent's payment instrument to improve the migration experience for users of the Charges API. We recommend that you explicitly provide the `payment_method` going forward. */ - payment_method?: string; + payment_method?: string /** * payment_method_data_params * @description If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear @@ -33349,203 +32806,203 @@ export interface operations { payment_method_data?: { /** payment_method_param */ acss_debit?: { - account_number: string; - institution_number: string; - transit_number: string; - } & { [key: string]: unknown }; + account_number: string + institution_number: string + transit_number: string + } & { [key: string]: unknown } /** param */ - afterpay_clearpay?: { [key: string]: unknown }; + afterpay_clearpay?: { [key: string]: unknown } /** param */ - alipay?: { [key: string]: unknown }; + alipay?: { [key: string]: unknown } /** param */ au_becs_debit?: { - account_number: string; - bsb_number: string; - } & { [key: string]: unknown }; + account_number: string + bsb_number: string + } & { [key: string]: unknown } /** param */ bacs_debit?: { - account_number?: string; - sort_code?: string; - } & { [key: string]: unknown }; + account_number?: string + sort_code?: string + } & { [key: string]: unknown } /** param */ - bancontact?: { [key: string]: unknown }; + bancontact?: { [key: string]: unknown } /** billing_details_inner_params */ billing_details?: { address?: (Partial< { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - email?: (Partial & Partial<"">) & { [key: string]: unknown }; - name?: string; - phone?: string; - } & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } + email?: (Partial & Partial<''>) & { [key: string]: unknown } + name?: string + phone?: string + } & { [key: string]: unknown } /** param */ boleto?: { - tax_id: string; - } & { [key: string]: unknown }; + tax_id: string + } & { [key: string]: unknown } /** param */ eps?: { /** @enum {string} */ bank?: - | "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" - | "dolomitenbank" - | "easybank_ag" - | "erste_bank_und_sparkassen" - | "hypo_alpeadriabank_international_ag" - | "hypo_bank_burgenland_aktiengesellschaft" - | "hypo_noe_lb_fur_niederosterreich_u_wien" - | "hypo_oberosterreich_salzburg_steiermark" - | "hypo_tirol_bank_ag" - | "hypo_vorarlberg_bank_ag" - | "marchfelder_bank" - | "oberbank_ag" - | "raiffeisen_bankengruppe_osterreich" - | "schoellerbank_ag" - | "sparda_bank_wien" - | "volksbank_gruppe" - | "volkskreditbank_ag" - | "vr_bank_braunau"; - } & { [key: string]: unknown }; + | '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' + | 'dolomitenbank' + | 'easybank_ag' + | 'erste_bank_und_sparkassen' + | 'hypo_alpeadriabank_international_ag' + | 'hypo_bank_burgenland_aktiengesellschaft' + | 'hypo_noe_lb_fur_niederosterreich_u_wien' + | 'hypo_oberosterreich_salzburg_steiermark' + | 'hypo_tirol_bank_ag' + | 'hypo_vorarlberg_bank_ag' + | 'marchfelder_bank' + | 'oberbank_ag' + | 'raiffeisen_bankengruppe_osterreich' + | 'schoellerbank_ag' + | 'sparda_bank_wien' + | 'volksbank_gruppe' + | 'volkskreditbank_ag' + | 'vr_bank_braunau' + } & { [key: string]: unknown } /** param */ fpx?: { /** @enum {string} */ bank: - | "affin_bank" - | "agrobank" - | "alliance_bank" - | "ambank" - | "bank_islam" - | "bank_muamalat" - | "bank_rakyat" - | "bsn" - | "cimb" - | "deutsche_bank" - | "hong_leong_bank" - | "hsbc" - | "kfh" - | "maybank2e" - | "maybank2u" - | "ocbc" - | "pb_enterprise" - | "public_bank" - | "rhb" - | "standard_chartered" - | "uob"; - } & { [key: string]: unknown }; + | 'affin_bank' + | 'agrobank' + | 'alliance_bank' + | 'ambank' + | 'bank_islam' + | 'bank_muamalat' + | 'bank_rakyat' + | 'bsn' + | 'cimb' + | 'deutsche_bank' + | 'hong_leong_bank' + | 'hsbc' + | 'kfh' + | 'maybank2e' + | 'maybank2u' + | 'ocbc' + | 'pb_enterprise' + | 'public_bank' + | 'rhb' + | 'standard_chartered' + | 'uob' + } & { [key: string]: unknown } /** param */ - giropay?: { [key: string]: unknown }; + giropay?: { [key: string]: unknown } /** param */ - grabpay?: { [key: string]: unknown }; + grabpay?: { [key: string]: unknown } /** param */ ideal?: { /** @enum {string} */ bank?: - | "abn_amro" - | "asn_bank" - | "bunq" - | "handelsbanken" - | "ing" - | "knab" - | "moneyou" - | "rabobank" - | "regiobank" - | "revolut" - | "sns_bank" - | "triodos_bank" - | "van_lanschot"; - } & { [key: string]: unknown }; + | 'abn_amro' + | 'asn_bank' + | 'bunq' + | 'handelsbanken' + | 'ing' + | 'knab' + | 'moneyou' + | 'rabobank' + | 'regiobank' + | 'revolut' + | 'sns_bank' + | 'triodos_bank' + | 'van_lanschot' + } & { [key: string]: unknown } /** param */ - interac_present?: { [key: string]: unknown }; + interac_present?: { [key: string]: unknown } /** param */ klarna?: { /** date_of_birth */ dob?: { - day: number; - month: number; - year: number; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; - metadata?: { [key: string]: string }; + day: number + month: number + year: number + } & { [key: string]: unknown } + } & { [key: string]: unknown } + metadata?: { [key: string]: string } /** param */ - oxxo?: { [key: string]: unknown }; + oxxo?: { [key: string]: unknown } /** param */ p24?: { /** @enum {string} */ bank?: - | "alior_bank" - | "bank_millennium" - | "bank_nowy_bfg_sa" - | "bank_pekao_sa" - | "banki_spbdzielcze" - | "blik" - | "bnp_paribas" - | "boz" - | "citi_handlowy" - | "credit_agricole" - | "envelobank" - | "etransfer_pocztowy24" - | "getin_bank" - | "ideabank" - | "ing" - | "inteligo" - | "mbank_mtransfer" - | "nest_przelew" - | "noble_pay" - | "pbac_z_ipko" - | "plus_bank" - | "santander_przelew24" - | "tmobile_usbugi_bankowe" - | "toyota_bank" - | "volkswagen_bank"; - } & { [key: string]: unknown }; + | 'alior_bank' + | 'bank_millennium' + | 'bank_nowy_bfg_sa' + | 'bank_pekao_sa' + | 'banki_spbdzielcze' + | 'blik' + | 'bnp_paribas' + | 'boz' + | 'citi_handlowy' + | 'credit_agricole' + | 'envelobank' + | 'etransfer_pocztowy24' + | 'getin_bank' + | 'ideabank' + | 'ing' + | 'inteligo' + | 'mbank_mtransfer' + | 'nest_przelew' + | 'noble_pay' + | 'pbac_z_ipko' + | 'plus_bank' + | 'santander_przelew24' + | 'tmobile_usbugi_bankowe' + | 'toyota_bank' + | 'volkswagen_bank' + } & { [key: string]: unknown } /** param */ sepa_debit?: { - iban: string; - } & { [key: string]: unknown }; + iban: string + } & { [key: string]: unknown } /** param */ sofort?: { /** @enum {string} */ - country: "AT" | "BE" | "DE" | "ES" | "IT" | "NL"; - } & { [key: string]: unknown }; + country: 'AT' | 'BE' | 'DE' | 'ES' | 'IT' | 'NL' + } & { [key: string]: unknown } /** @enum {string} */ type: - | "acss_debit" - | "afterpay_clearpay" - | "alipay" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "eps" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "klarna" - | "oxxo" - | "p24" - | "sepa_debit" - | "sofort" - | "wechat_pay"; + | 'acss_debit' + | 'afterpay_clearpay' + | 'alipay' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'eps' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'klarna' + | 'oxxo' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' /** param */ - wechat_pay?: { [key: string]: unknown }; - } & { [key: string]: unknown }; + wechat_pay?: { [key: string]: unknown } + } & { [key: string]: unknown } /** * payment_method_options_param * @description Payment-method-specific configuration for this PaymentIntent. @@ -33555,159 +33012,149 @@ export interface operations { { /** payment_intent_payment_method_options_mandate_options_param */ mandate_options?: { - custom_mandate_url?: (Partial & Partial<"">) & { [key: string]: unknown }; - interval_description?: string; + custom_mandate_url?: (Partial & Partial<''>) & { [key: string]: unknown } + interval_description?: string /** @enum {string} */ - payment_schedule?: "combined" | "interval" | "sporadic"; + payment_schedule?: 'combined' | 'interval' | 'sporadic' /** @enum {string} */ - transaction_type?: "business" | "personal"; - } & { [key: string]: unknown }; + transaction_type?: 'business' | 'personal' + } & { [key: string]: unknown } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; + verification_method?: 'automatic' | 'instant' | 'microdeposits' } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } afterpay_clearpay?: (Partial< { - reference?: string; + reference?: string } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - alipay?: (Partial<{ [key: string]: unknown }> & Partial<"">) & { [key: string]: unknown }; - au_becs_debit?: (Partial<{ [key: string]: unknown }> & Partial<"">) & { [key: string]: unknown }; - bacs_debit?: (Partial<{ [key: string]: unknown }> & Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } + alipay?: (Partial<{ [key: string]: unknown }> & Partial<''>) & { [key: string]: unknown } + au_becs_debit?: (Partial<{ [key: string]: unknown }> & Partial<''>) & { [key: string]: unknown } + bacs_debit?: (Partial<{ [key: string]: unknown }> & Partial<''>) & { [key: string]: unknown } bancontact?: (Partial< { /** @enum {string} */ - preferred_language?: "de" | "en" | "fr" | "nl"; + preferred_language?: 'de' | 'en' | 'fr' | 'nl' } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } boleto?: (Partial< { - expires_after_days?: number; + expires_after_days?: number } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } card?: (Partial< { - cvc_token?: string; + cvc_token?: string /** installments_param */ installments?: { - enabled?: boolean; + enabled?: boolean plan?: (Partial< { - count: number; + count: number /** @enum {string} */ - interval: "month"; + interval: 'month' /** @enum {string} */ - type: "fixed_count"; + type: 'fixed_count' } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown } /** @enum {string} */ - network?: - | "amex" - | "cartes_bancaires" - | "diners" - | "discover" - | "interac" - | "jcb" - | "mastercard" - | "unionpay" - | "unknown" - | "visa"; + network?: 'amex' | 'cartes_bancaires' | 'diners' | 'discover' | 'interac' | 'jcb' | 'mastercard' | 'unionpay' | 'unknown' | 'visa' /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: 'any' | 'automatic' /** @enum {string} */ - setup_future_usage?: "" | "none" | "off_session" | "on_session"; + setup_future_usage?: '' | 'none' | 'off_session' | 'on_session' } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - card_present?: (Partial<{ [key: string]: unknown }> & Partial<"">) & { [key: string]: unknown }; - eps?: (Partial<{ [key: string]: unknown }> & Partial<"">) & { [key: string]: unknown }; - fpx?: (Partial<{ [key: string]: unknown }> & Partial<"">) & { [key: string]: unknown }; - giropay?: (Partial<{ [key: string]: unknown }> & Partial<"">) & { [key: string]: unknown }; - grabpay?: (Partial<{ [key: string]: unknown }> & Partial<"">) & { [key: string]: unknown }; - ideal?: (Partial<{ [key: string]: unknown }> & Partial<"">) & { [key: string]: unknown }; - interac_present?: (Partial<{ [key: string]: unknown }> & Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } + card_present?: (Partial<{ [key: string]: unknown }> & Partial<''>) & { [key: string]: unknown } + eps?: (Partial<{ [key: string]: unknown }> & Partial<''>) & { [key: string]: unknown } + fpx?: (Partial<{ [key: string]: unknown }> & Partial<''>) & { [key: string]: unknown } + giropay?: (Partial<{ [key: string]: unknown }> & Partial<''>) & { [key: string]: unknown } + grabpay?: (Partial<{ [key: string]: unknown }> & Partial<''>) & { [key: string]: unknown } + ideal?: (Partial<{ [key: string]: unknown }> & Partial<''>) & { [key: string]: unknown } + interac_present?: (Partial<{ [key: string]: unknown }> & Partial<''>) & { [key: string]: unknown } klarna?: (Partial< { /** @enum {string} */ preferred_locale?: - | "da-DK" - | "de-AT" - | "de-DE" - | "en-AT" - | "en-BE" - | "en-DE" - | "en-DK" - | "en-ES" - | "en-FI" - | "en-FR" - | "en-GB" - | "en-IE" - | "en-IT" - | "en-NL" - | "en-NO" - | "en-SE" - | "en-US" - | "es-ES" - | "es-US" - | "fi-FI" - | "fr-BE" - | "fr-FR" - | "it-IT" - | "nb-NO" - | "nl-BE" - | "nl-NL" - | "sv-FI" - | "sv-SE"; + | 'da-DK' + | 'de-AT' + | 'de-DE' + | 'en-AT' + | 'en-BE' + | 'en-DE' + | 'en-DK' + | 'en-ES' + | 'en-FI' + | 'en-FR' + | 'en-GB' + | 'en-IE' + | 'en-IT' + | 'en-NL' + | 'en-NO' + | 'en-SE' + | 'en-US' + | 'es-ES' + | 'es-US' + | 'fi-FI' + | 'fr-BE' + | 'fr-FR' + | 'it-IT' + | 'nb-NO' + | 'nl-BE' + | 'nl-NL' + | 'sv-FI' + | 'sv-SE' } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } oxxo?: (Partial< { - expires_after_days?: number; + expires_after_days?: number } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } p24?: (Partial< { - tos_shown_and_accepted?: boolean; + tos_shown_and_accepted?: boolean } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } sepa_debit?: (Partial< { /** payment_method_options_mandate_options_param */ - mandate_options?: { [key: string]: unknown }; + mandate_options?: { [key: string]: unknown } } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } sofort?: (Partial< { /** @enum {string} */ - preferred_language?: "" | "de" | "en" | "es" | "fr" | "it" | "nl" | "pl"; + preferred_language?: '' | 'de' | 'en' | 'es' | 'fr' | 'it' | 'nl' | 'pl' } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } wechat_pay?: (Partial< { - app_id?: string; + app_id?: string /** @enum {string} */ - client: "android" | "ios" | "web"; + client: 'android' | 'ios' | 'web' } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown } /** @description The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. If this is not provided, defaults to ["card"]. */ - payment_method_types?: string[]; + payment_method_types?: string[] /** @description 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?: string; + receipt_email?: string /** @description The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). */ - return_url?: string; + return_url?: string /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * @@ -33716,7 +33163,7 @@ export interface operations { * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ - setup_future_usage?: "off_session" | "on_session"; + setup_future_usage?: 'off_session' | 'on_session' /** * optional_fields_shipping * @description Shipping information for this PaymentIntent. @@ -33724,39 +33171,39 @@ export interface operations { shipping?: { /** optional_fields_address */ address: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - } & { [key: string]: unknown }; - carrier?: string; - name: string; - phone?: string; - tracking_number?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } & { [key: string]: unknown } + carrier?: string + name: string + phone?: string + tracking_number?: string + } & { [key: string]: unknown } /** @description For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - statement_descriptor_suffix?: string; + statement_descriptor_suffix?: string /** * transfer_data_creation_params * @description The parameters used to automatically create a Transfer when the payment succeeds. * For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ transfer_data?: { - amount?: number; - destination: string; - } & { [key: string]: unknown }; + amount?: number + destination: string + } & { [key: string]: unknown } /** @description A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. */ - transfer_group?: string; + transfer_group?: string /** @description Set to `true` only when using manual confirmation and the iOS or Android SDKs to handle additional authentication steps. */ - use_stripe_sdk?: boolean; - }; - }; - }; - }; + use_stripe_sdk?: boolean + } + } + } + } /** *

Retrieves the details of a PaymentIntent that has previously been created.

* @@ -33768,34 +33215,34 @@ export interface operations { parameters: { query: { /** The client secret of the PaymentIntent. Required if a publishable key is used to retrieve the source. */ - client_secret?: string; + client_secret?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - intent: string; - }; - }; + intent: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_intent"]; - }; - }; + 'application/json': components['schemas']['payment_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates properties on a PaymentIntent object without confirming.

* @@ -33808,32 +33255,32 @@ export interface operations { PostPaymentIntentsIntent: { parameters: { path: { - intent: string; - }; - }; + intent: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_intent"]; - }; - }; + 'application/json': components['schemas']['payment_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description 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?: number; + amount?: number /** @description 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?: (Partial & Partial<"">) & { [key: string]: unknown }; + application_fee_amount?: (Partial & Partial<''>) & { [key: string]: unknown } /** @description 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?: string; + currency?: string /** * @description ID of the Customer this PaymentIntent belongs to, if one exists. * @@ -33841,15 +33288,15 @@ export interface operations { * * If present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. */ - customer?: string; + customer?: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. */ - payment_method?: string; + payment_method?: string /** * payment_method_data_params * @description If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear @@ -33859,203 +33306,203 @@ export interface operations { payment_method_data?: { /** payment_method_param */ acss_debit?: { - account_number: string; - institution_number: string; - transit_number: string; - } & { [key: string]: unknown }; + account_number: string + institution_number: string + transit_number: string + } & { [key: string]: unknown } /** param */ - afterpay_clearpay?: { [key: string]: unknown }; + afterpay_clearpay?: { [key: string]: unknown } /** param */ - alipay?: { [key: string]: unknown }; + alipay?: { [key: string]: unknown } /** param */ au_becs_debit?: { - account_number: string; - bsb_number: string; - } & { [key: string]: unknown }; + account_number: string + bsb_number: string + } & { [key: string]: unknown } /** param */ bacs_debit?: { - account_number?: string; - sort_code?: string; - } & { [key: string]: unknown }; + account_number?: string + sort_code?: string + } & { [key: string]: unknown } /** param */ - bancontact?: { [key: string]: unknown }; + bancontact?: { [key: string]: unknown } /** billing_details_inner_params */ billing_details?: { address?: (Partial< { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - email?: (Partial & Partial<"">) & { [key: string]: unknown }; - name?: string; - phone?: string; - } & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } + email?: (Partial & Partial<''>) & { [key: string]: unknown } + name?: string + phone?: string + } & { [key: string]: unknown } /** param */ boleto?: { - tax_id: string; - } & { [key: string]: unknown }; + tax_id: string + } & { [key: string]: unknown } /** param */ eps?: { /** @enum {string} */ bank?: - | "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" - | "dolomitenbank" - | "easybank_ag" - | "erste_bank_und_sparkassen" - | "hypo_alpeadriabank_international_ag" - | "hypo_bank_burgenland_aktiengesellschaft" - | "hypo_noe_lb_fur_niederosterreich_u_wien" - | "hypo_oberosterreich_salzburg_steiermark" - | "hypo_tirol_bank_ag" - | "hypo_vorarlberg_bank_ag" - | "marchfelder_bank" - | "oberbank_ag" - | "raiffeisen_bankengruppe_osterreich" - | "schoellerbank_ag" - | "sparda_bank_wien" - | "volksbank_gruppe" - | "volkskreditbank_ag" - | "vr_bank_braunau"; - } & { [key: string]: unknown }; + | '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' + | 'dolomitenbank' + | 'easybank_ag' + | 'erste_bank_und_sparkassen' + | 'hypo_alpeadriabank_international_ag' + | 'hypo_bank_burgenland_aktiengesellschaft' + | 'hypo_noe_lb_fur_niederosterreich_u_wien' + | 'hypo_oberosterreich_salzburg_steiermark' + | 'hypo_tirol_bank_ag' + | 'hypo_vorarlberg_bank_ag' + | 'marchfelder_bank' + | 'oberbank_ag' + | 'raiffeisen_bankengruppe_osterreich' + | 'schoellerbank_ag' + | 'sparda_bank_wien' + | 'volksbank_gruppe' + | 'volkskreditbank_ag' + | 'vr_bank_braunau' + } & { [key: string]: unknown } /** param */ fpx?: { /** @enum {string} */ bank: - | "affin_bank" - | "agrobank" - | "alliance_bank" - | "ambank" - | "bank_islam" - | "bank_muamalat" - | "bank_rakyat" - | "bsn" - | "cimb" - | "deutsche_bank" - | "hong_leong_bank" - | "hsbc" - | "kfh" - | "maybank2e" - | "maybank2u" - | "ocbc" - | "pb_enterprise" - | "public_bank" - | "rhb" - | "standard_chartered" - | "uob"; - } & { [key: string]: unknown }; + | 'affin_bank' + | 'agrobank' + | 'alliance_bank' + | 'ambank' + | 'bank_islam' + | 'bank_muamalat' + | 'bank_rakyat' + | 'bsn' + | 'cimb' + | 'deutsche_bank' + | 'hong_leong_bank' + | 'hsbc' + | 'kfh' + | 'maybank2e' + | 'maybank2u' + | 'ocbc' + | 'pb_enterprise' + | 'public_bank' + | 'rhb' + | 'standard_chartered' + | 'uob' + } & { [key: string]: unknown } /** param */ - giropay?: { [key: string]: unknown }; + giropay?: { [key: string]: unknown } /** param */ - grabpay?: { [key: string]: unknown }; + grabpay?: { [key: string]: unknown } /** param */ ideal?: { /** @enum {string} */ bank?: - | "abn_amro" - | "asn_bank" - | "bunq" - | "handelsbanken" - | "ing" - | "knab" - | "moneyou" - | "rabobank" - | "regiobank" - | "revolut" - | "sns_bank" - | "triodos_bank" - | "van_lanschot"; - } & { [key: string]: unknown }; + | 'abn_amro' + | 'asn_bank' + | 'bunq' + | 'handelsbanken' + | 'ing' + | 'knab' + | 'moneyou' + | 'rabobank' + | 'regiobank' + | 'revolut' + | 'sns_bank' + | 'triodos_bank' + | 'van_lanschot' + } & { [key: string]: unknown } /** param */ - interac_present?: { [key: string]: unknown }; + interac_present?: { [key: string]: unknown } /** param */ klarna?: { /** date_of_birth */ dob?: { - day: number; - month: number; - year: number; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; - metadata?: { [key: string]: string }; + day: number + month: number + year: number + } & { [key: string]: unknown } + } & { [key: string]: unknown } + metadata?: { [key: string]: string } /** param */ - oxxo?: { [key: string]: unknown }; + oxxo?: { [key: string]: unknown } /** param */ p24?: { /** @enum {string} */ bank?: - | "alior_bank" - | "bank_millennium" - | "bank_nowy_bfg_sa" - | "bank_pekao_sa" - | "banki_spbdzielcze" - | "blik" - | "bnp_paribas" - | "boz" - | "citi_handlowy" - | "credit_agricole" - | "envelobank" - | "etransfer_pocztowy24" - | "getin_bank" - | "ideabank" - | "ing" - | "inteligo" - | "mbank_mtransfer" - | "nest_przelew" - | "noble_pay" - | "pbac_z_ipko" - | "plus_bank" - | "santander_przelew24" - | "tmobile_usbugi_bankowe" - | "toyota_bank" - | "volkswagen_bank"; - } & { [key: string]: unknown }; + | 'alior_bank' + | 'bank_millennium' + | 'bank_nowy_bfg_sa' + | 'bank_pekao_sa' + | 'banki_spbdzielcze' + | 'blik' + | 'bnp_paribas' + | 'boz' + | 'citi_handlowy' + | 'credit_agricole' + | 'envelobank' + | 'etransfer_pocztowy24' + | 'getin_bank' + | 'ideabank' + | 'ing' + | 'inteligo' + | 'mbank_mtransfer' + | 'nest_przelew' + | 'noble_pay' + | 'pbac_z_ipko' + | 'plus_bank' + | 'santander_przelew24' + | 'tmobile_usbugi_bankowe' + | 'toyota_bank' + | 'volkswagen_bank' + } & { [key: string]: unknown } /** param */ sepa_debit?: { - iban: string; - } & { [key: string]: unknown }; + iban: string + } & { [key: string]: unknown } /** param */ sofort?: { /** @enum {string} */ - country: "AT" | "BE" | "DE" | "ES" | "IT" | "NL"; - } & { [key: string]: unknown }; + country: 'AT' | 'BE' | 'DE' | 'ES' | 'IT' | 'NL' + } & { [key: string]: unknown } /** @enum {string} */ type: - | "acss_debit" - | "afterpay_clearpay" - | "alipay" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "eps" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "klarna" - | "oxxo" - | "p24" - | "sepa_debit" - | "sofort" - | "wechat_pay"; + | 'acss_debit' + | 'afterpay_clearpay' + | 'alipay' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'eps' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'klarna' + | 'oxxo' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' /** param */ - wechat_pay?: { [key: string]: unknown }; - } & { [key: string]: unknown }; + wechat_pay?: { [key: string]: unknown } + } & { [key: string]: unknown } /** * payment_method_options_param * @description Payment-method-specific configuration for this PaymentIntent. @@ -34065,157 +33512,147 @@ export interface operations { { /** payment_intent_payment_method_options_mandate_options_param */ mandate_options?: { - custom_mandate_url?: (Partial & Partial<"">) & { [key: string]: unknown }; - interval_description?: string; + custom_mandate_url?: (Partial & Partial<''>) & { [key: string]: unknown } + interval_description?: string /** @enum {string} */ - payment_schedule?: "combined" | "interval" | "sporadic"; + payment_schedule?: 'combined' | 'interval' | 'sporadic' /** @enum {string} */ - transaction_type?: "business" | "personal"; - } & { [key: string]: unknown }; + transaction_type?: 'business' | 'personal' + } & { [key: string]: unknown } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; + verification_method?: 'automatic' | 'instant' | 'microdeposits' } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } afterpay_clearpay?: (Partial< { - reference?: string; + reference?: string } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - alipay?: (Partial<{ [key: string]: unknown }> & Partial<"">) & { [key: string]: unknown }; - au_becs_debit?: (Partial<{ [key: string]: unknown }> & Partial<"">) & { [key: string]: unknown }; - bacs_debit?: (Partial<{ [key: string]: unknown }> & Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } + alipay?: (Partial<{ [key: string]: unknown }> & Partial<''>) & { [key: string]: unknown } + au_becs_debit?: (Partial<{ [key: string]: unknown }> & Partial<''>) & { [key: string]: unknown } + bacs_debit?: (Partial<{ [key: string]: unknown }> & Partial<''>) & { [key: string]: unknown } bancontact?: (Partial< { /** @enum {string} */ - preferred_language?: "de" | "en" | "fr" | "nl"; + preferred_language?: 'de' | 'en' | 'fr' | 'nl' } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } boleto?: (Partial< { - expires_after_days?: number; + expires_after_days?: number } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } card?: (Partial< { - cvc_token?: string; + cvc_token?: string /** installments_param */ installments?: { - enabled?: boolean; + enabled?: boolean plan?: (Partial< { - count: number; + count: number /** @enum {string} */ - interval: "month"; + interval: 'month' /** @enum {string} */ - type: "fixed_count"; + type: 'fixed_count' } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown } /** @enum {string} */ - network?: - | "amex" - | "cartes_bancaires" - | "diners" - | "discover" - | "interac" - | "jcb" - | "mastercard" - | "unionpay" - | "unknown" - | "visa"; + network?: 'amex' | 'cartes_bancaires' | 'diners' | 'discover' | 'interac' | 'jcb' | 'mastercard' | 'unionpay' | 'unknown' | 'visa' /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: 'any' | 'automatic' /** @enum {string} */ - setup_future_usage?: "" | "none" | "off_session" | "on_session"; + setup_future_usage?: '' | 'none' | 'off_session' | 'on_session' } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - card_present?: (Partial<{ [key: string]: unknown }> & Partial<"">) & { [key: string]: unknown }; - eps?: (Partial<{ [key: string]: unknown }> & Partial<"">) & { [key: string]: unknown }; - fpx?: (Partial<{ [key: string]: unknown }> & Partial<"">) & { [key: string]: unknown }; - giropay?: (Partial<{ [key: string]: unknown }> & Partial<"">) & { [key: string]: unknown }; - grabpay?: (Partial<{ [key: string]: unknown }> & Partial<"">) & { [key: string]: unknown }; - ideal?: (Partial<{ [key: string]: unknown }> & Partial<"">) & { [key: string]: unknown }; - interac_present?: (Partial<{ [key: string]: unknown }> & Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } + card_present?: (Partial<{ [key: string]: unknown }> & Partial<''>) & { [key: string]: unknown } + eps?: (Partial<{ [key: string]: unknown }> & Partial<''>) & { [key: string]: unknown } + fpx?: (Partial<{ [key: string]: unknown }> & Partial<''>) & { [key: string]: unknown } + giropay?: (Partial<{ [key: string]: unknown }> & Partial<''>) & { [key: string]: unknown } + grabpay?: (Partial<{ [key: string]: unknown }> & Partial<''>) & { [key: string]: unknown } + ideal?: (Partial<{ [key: string]: unknown }> & Partial<''>) & { [key: string]: unknown } + interac_present?: (Partial<{ [key: string]: unknown }> & Partial<''>) & { [key: string]: unknown } klarna?: (Partial< { /** @enum {string} */ preferred_locale?: - | "da-DK" - | "de-AT" - | "de-DE" - | "en-AT" - | "en-BE" - | "en-DE" - | "en-DK" - | "en-ES" - | "en-FI" - | "en-FR" - | "en-GB" - | "en-IE" - | "en-IT" - | "en-NL" - | "en-NO" - | "en-SE" - | "en-US" - | "es-ES" - | "es-US" - | "fi-FI" - | "fr-BE" - | "fr-FR" - | "it-IT" - | "nb-NO" - | "nl-BE" - | "nl-NL" - | "sv-FI" - | "sv-SE"; + | 'da-DK' + | 'de-AT' + | 'de-DE' + | 'en-AT' + | 'en-BE' + | 'en-DE' + | 'en-DK' + | 'en-ES' + | 'en-FI' + | 'en-FR' + | 'en-GB' + | 'en-IE' + | 'en-IT' + | 'en-NL' + | 'en-NO' + | 'en-SE' + | 'en-US' + | 'es-ES' + | 'es-US' + | 'fi-FI' + | 'fr-BE' + | 'fr-FR' + | 'it-IT' + | 'nb-NO' + | 'nl-BE' + | 'nl-NL' + | 'sv-FI' + | 'sv-SE' } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } oxxo?: (Partial< { - expires_after_days?: number; + expires_after_days?: number } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } p24?: (Partial< { - tos_shown_and_accepted?: boolean; + tos_shown_and_accepted?: boolean } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } sepa_debit?: (Partial< { /** payment_method_options_mandate_options_param */ - mandate_options?: { [key: string]: unknown }; + mandate_options?: { [key: string]: unknown } } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } sofort?: (Partial< { /** @enum {string} */ - preferred_language?: "" | "de" | "en" | "es" | "fr" | "it" | "nl" | "pl"; + preferred_language?: '' | 'de' | 'en' | 'es' | 'fr' | 'it' | 'nl' | 'pl' } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } wechat_pay?: (Partial< { - app_id?: string; + app_id?: string /** @enum {string} */ - client: "android" | "ios" | "web"; + client: 'android' | 'ios' | 'web' } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown } /** @description The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. */ - payment_method_types?: string[]; + payment_method_types?: string[] /** @description 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?: (Partial & Partial<"">) & { [key: string]: unknown }; + receipt_email?: (Partial & Partial<''>) & { [key: string]: unknown } /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * @@ -34226,43 +33663,43 @@ export interface operations { * If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. * @enum {string} */ - setup_future_usage?: "" | "off_session" | "on_session"; + setup_future_usage?: '' | 'off_session' | 'on_session' /** @description Shipping information for this PaymentIntent. */ shipping?: (Partial< { /** optional_fields_address */ address: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - } & { [key: string]: unknown }; - carrier?: string; - name: string; - phone?: string; - tracking_number?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } & { [key: string]: unknown } + carrier?: string + name: string + phone?: string + tracking_number?: string } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** @description For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - statement_descriptor_suffix?: string; + statement_descriptor_suffix?: string /** * transfer_data_update_params * @description The parameters used to automatically create a Transfer when the payment succeeds. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ transfer_data?: { - amount?: number; - } & { [key: string]: unknown }; + amount?: number + } & { [key: string]: unknown } /** @description A string that identifies the resulting payment as part of a group. `transfer_group` may only be provided if it has not been set. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. */ - transfer_group?: string; - }; - }; - }; - }; + transfer_group?: string + } + } + } + } /** *

A PaymentIntent object can be canceled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action, or processing.

* @@ -34271,37 +33708,37 @@ export interface operations { PostPaymentIntentsIntentCancel: { parameters: { path: { - intent: string; - }; - }; + intent: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_intent"]; - }; - }; + 'application/json': components['schemas']['payment_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * @description Reason for canceling this PaymentIntent. Possible values are `duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned` * @enum {string} */ - cancellation_reason?: "abandoned" | "duplicate" | "fraudulent" | "requested_by_customer"; + cancellation_reason?: 'abandoned' | 'duplicate' | 'fraudulent' | 'requested_by_customer' /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /** *

Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.

* @@ -34312,48 +33749,48 @@ export interface operations { PostPaymentIntentsIntentCapture: { parameters: { path: { - intent: string; - }; - }; + intent: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_intent"]; - }; - }; + 'application/json': components['schemas']['payment_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The amount to capture from the PaymentIntent, which must be less than or equal to the original amount. Any additional amount will be automatically refunded. Defaults to the full `amount_capturable` if not provided. */ - amount_to_capture?: number; + amount_to_capture?: number /** @description 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?: number; + application_fee_amount?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - statement_descriptor_suffix?: string; + statement_descriptor_suffix?: string /** * transfer_data_update_params * @description The parameters used to automatically create a Transfer when the payment * is captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ transfer_data?: { - amount?: number; - } & { [key: string]: unknown }; - }; - }; - }; - }; + amount?: number + } & { [key: string]: unknown } + } + } + } + } /** *

Confirm that your customer intends to pay with current or provided * payment method. Upon confirmation, the PaymentIntent will attempt to initiate @@ -34384,51 +33821,51 @@ export interface operations { PostPaymentIntentsIntentConfirm: { parameters: { path: { - intent: string; - }; - }; + intent: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_intent"]; - }; - }; + 'application/json': components['schemas']['payment_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The client secret of the PaymentIntent. */ - client_secret?: string; + client_secret?: string /** @description Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. This parameter is intended for simpler integrations that do not handle customer actions, like [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication). */ - error_on_requires_action?: boolean; + error_on_requires_action?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description ID of the mandate to be used for this payment. */ - mandate?: string; + mandate?: string /** @description This hash contains details about the Mandate to create */ mandate_data?: (Partial< { /** customer_acceptance_param */ customer_acceptance: { /** Format: unix-time */ - accepted_at?: number; + accepted_at?: number /** offline_param */ - offline?: { [key: string]: unknown }; + offline?: { [key: string]: unknown } /** online_param */ online?: { - ip_address: string; - user_agent: string; - } & { [key: string]: unknown }; + ip_address: string + user_agent: string + } & { [key: string]: unknown } /** @enum {string} */ - type: "offline" | "online"; - } & { [key: string]: unknown }; + type: 'offline' | 'online' + } & { [key: string]: unknown } } & { [key: string]: unknown } > & Partial< @@ -34437,18 +33874,18 @@ export interface operations { customer_acceptance: { /** online_param */ online: { - ip_address?: string; - user_agent?: string; - } & { [key: string]: unknown }; + ip_address?: string + user_agent?: string + } & { [key: string]: unknown } /** @enum {string} */ - type: "online"; - } & { [key: string]: unknown }; + type: 'online' + } & { [key: string]: unknown } } & { [key: string]: unknown } - >) & { [key: string]: unknown }; + >) & { [key: string]: unknown } /** @description Set to `true` to indicate that the customer is not in your checkout flow during this payment attempt, and therefore is unable to authenticate. This parameter is intended for scenarios where you collect card details and [charge them later](https://stripe.com/docs/payments/cards/charging-saved-cards). */ - off_session?: (Partial & Partial<"one_off" | "recurring">) & { [key: string]: unknown }; + off_session?: (Partial & Partial<'one_off' | 'recurring'>) & { [key: string]: unknown } /** @description ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. */ - payment_method?: string; + payment_method?: string /** * payment_method_data_params * @description If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear @@ -34458,203 +33895,203 @@ export interface operations { payment_method_data?: { /** payment_method_param */ acss_debit?: { - account_number: string; - institution_number: string; - transit_number: string; - } & { [key: string]: unknown }; + account_number: string + institution_number: string + transit_number: string + } & { [key: string]: unknown } /** param */ - afterpay_clearpay?: { [key: string]: unknown }; + afterpay_clearpay?: { [key: string]: unknown } /** param */ - alipay?: { [key: string]: unknown }; + alipay?: { [key: string]: unknown } /** param */ au_becs_debit?: { - account_number: string; - bsb_number: string; - } & { [key: string]: unknown }; + account_number: string + bsb_number: string + } & { [key: string]: unknown } /** param */ bacs_debit?: { - account_number?: string; - sort_code?: string; - } & { [key: string]: unknown }; + account_number?: string + sort_code?: string + } & { [key: string]: unknown } /** param */ - bancontact?: { [key: string]: unknown }; + bancontact?: { [key: string]: unknown } /** billing_details_inner_params */ billing_details?: { address?: (Partial< { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - email?: (Partial & Partial<"">) & { [key: string]: unknown }; - name?: string; - phone?: string; - } & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } + email?: (Partial & Partial<''>) & { [key: string]: unknown } + name?: string + phone?: string + } & { [key: string]: unknown } /** param */ boleto?: { - tax_id: string; - } & { [key: string]: unknown }; + tax_id: string + } & { [key: string]: unknown } /** param */ eps?: { /** @enum {string} */ bank?: - | "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" - | "dolomitenbank" - | "easybank_ag" - | "erste_bank_und_sparkassen" - | "hypo_alpeadriabank_international_ag" - | "hypo_bank_burgenland_aktiengesellschaft" - | "hypo_noe_lb_fur_niederosterreich_u_wien" - | "hypo_oberosterreich_salzburg_steiermark" - | "hypo_tirol_bank_ag" - | "hypo_vorarlberg_bank_ag" - | "marchfelder_bank" - | "oberbank_ag" - | "raiffeisen_bankengruppe_osterreich" - | "schoellerbank_ag" - | "sparda_bank_wien" - | "volksbank_gruppe" - | "volkskreditbank_ag" - | "vr_bank_braunau"; - } & { [key: string]: unknown }; + | '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' + | 'dolomitenbank' + | 'easybank_ag' + | 'erste_bank_und_sparkassen' + | 'hypo_alpeadriabank_international_ag' + | 'hypo_bank_burgenland_aktiengesellschaft' + | 'hypo_noe_lb_fur_niederosterreich_u_wien' + | 'hypo_oberosterreich_salzburg_steiermark' + | 'hypo_tirol_bank_ag' + | 'hypo_vorarlberg_bank_ag' + | 'marchfelder_bank' + | 'oberbank_ag' + | 'raiffeisen_bankengruppe_osterreich' + | 'schoellerbank_ag' + | 'sparda_bank_wien' + | 'volksbank_gruppe' + | 'volkskreditbank_ag' + | 'vr_bank_braunau' + } & { [key: string]: unknown } /** param */ fpx?: { /** @enum {string} */ bank: - | "affin_bank" - | "agrobank" - | "alliance_bank" - | "ambank" - | "bank_islam" - | "bank_muamalat" - | "bank_rakyat" - | "bsn" - | "cimb" - | "deutsche_bank" - | "hong_leong_bank" - | "hsbc" - | "kfh" - | "maybank2e" - | "maybank2u" - | "ocbc" - | "pb_enterprise" - | "public_bank" - | "rhb" - | "standard_chartered" - | "uob"; - } & { [key: string]: unknown }; + | 'affin_bank' + | 'agrobank' + | 'alliance_bank' + | 'ambank' + | 'bank_islam' + | 'bank_muamalat' + | 'bank_rakyat' + | 'bsn' + | 'cimb' + | 'deutsche_bank' + | 'hong_leong_bank' + | 'hsbc' + | 'kfh' + | 'maybank2e' + | 'maybank2u' + | 'ocbc' + | 'pb_enterprise' + | 'public_bank' + | 'rhb' + | 'standard_chartered' + | 'uob' + } & { [key: string]: unknown } /** param */ - giropay?: { [key: string]: unknown }; + giropay?: { [key: string]: unknown } /** param */ - grabpay?: { [key: string]: unknown }; + grabpay?: { [key: string]: unknown } /** param */ ideal?: { /** @enum {string} */ bank?: - | "abn_amro" - | "asn_bank" - | "bunq" - | "handelsbanken" - | "ing" - | "knab" - | "moneyou" - | "rabobank" - | "regiobank" - | "revolut" - | "sns_bank" - | "triodos_bank" - | "van_lanschot"; - } & { [key: string]: unknown }; + | 'abn_amro' + | 'asn_bank' + | 'bunq' + | 'handelsbanken' + | 'ing' + | 'knab' + | 'moneyou' + | 'rabobank' + | 'regiobank' + | 'revolut' + | 'sns_bank' + | 'triodos_bank' + | 'van_lanschot' + } & { [key: string]: unknown } /** param */ - interac_present?: { [key: string]: unknown }; + interac_present?: { [key: string]: unknown } /** param */ klarna?: { /** date_of_birth */ dob?: { - day: number; - month: number; - year: number; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; - metadata?: { [key: string]: string }; + day: number + month: number + year: number + } & { [key: string]: unknown } + } & { [key: string]: unknown } + metadata?: { [key: string]: string } /** param */ - oxxo?: { [key: string]: unknown }; + oxxo?: { [key: string]: unknown } /** param */ p24?: { /** @enum {string} */ bank?: - | "alior_bank" - | "bank_millennium" - | "bank_nowy_bfg_sa" - | "bank_pekao_sa" - | "banki_spbdzielcze" - | "blik" - | "bnp_paribas" - | "boz" - | "citi_handlowy" - | "credit_agricole" - | "envelobank" - | "etransfer_pocztowy24" - | "getin_bank" - | "ideabank" - | "ing" - | "inteligo" - | "mbank_mtransfer" - | "nest_przelew" - | "noble_pay" - | "pbac_z_ipko" - | "plus_bank" - | "santander_przelew24" - | "tmobile_usbugi_bankowe" - | "toyota_bank" - | "volkswagen_bank"; - } & { [key: string]: unknown }; + | 'alior_bank' + | 'bank_millennium' + | 'bank_nowy_bfg_sa' + | 'bank_pekao_sa' + | 'banki_spbdzielcze' + | 'blik' + | 'bnp_paribas' + | 'boz' + | 'citi_handlowy' + | 'credit_agricole' + | 'envelobank' + | 'etransfer_pocztowy24' + | 'getin_bank' + | 'ideabank' + | 'ing' + | 'inteligo' + | 'mbank_mtransfer' + | 'nest_przelew' + | 'noble_pay' + | 'pbac_z_ipko' + | 'plus_bank' + | 'santander_przelew24' + | 'tmobile_usbugi_bankowe' + | 'toyota_bank' + | 'volkswagen_bank' + } & { [key: string]: unknown } /** param */ sepa_debit?: { - iban: string; - } & { [key: string]: unknown }; + iban: string + } & { [key: string]: unknown } /** param */ sofort?: { /** @enum {string} */ - country: "AT" | "BE" | "DE" | "ES" | "IT" | "NL"; - } & { [key: string]: unknown }; + country: 'AT' | 'BE' | 'DE' | 'ES' | 'IT' | 'NL' + } & { [key: string]: unknown } /** @enum {string} */ type: - | "acss_debit" - | "afterpay_clearpay" - | "alipay" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "eps" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "klarna" - | "oxxo" - | "p24" - | "sepa_debit" - | "sofort" - | "wechat_pay"; + | 'acss_debit' + | 'afterpay_clearpay' + | 'alipay' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'eps' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'klarna' + | 'oxxo' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' /** param */ - wechat_pay?: { [key: string]: unknown }; - } & { [key: string]: unknown }; + wechat_pay?: { [key: string]: unknown } + } & { [key: string]: unknown } /** * payment_method_options_param * @description Payment-method-specific configuration for this PaymentIntent. @@ -34664,163 +34101,153 @@ export interface operations { { /** payment_intent_payment_method_options_mandate_options_param */ mandate_options?: { - custom_mandate_url?: (Partial & Partial<"">) & { [key: string]: unknown }; - interval_description?: string; + custom_mandate_url?: (Partial & Partial<''>) & { [key: string]: unknown } + interval_description?: string /** @enum {string} */ - payment_schedule?: "combined" | "interval" | "sporadic"; + payment_schedule?: 'combined' | 'interval' | 'sporadic' /** @enum {string} */ - transaction_type?: "business" | "personal"; - } & { [key: string]: unknown }; + transaction_type?: 'business' | 'personal' + } & { [key: string]: unknown } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; + verification_method?: 'automatic' | 'instant' | 'microdeposits' } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } afterpay_clearpay?: (Partial< { - reference?: string; + reference?: string } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - alipay?: (Partial<{ [key: string]: unknown }> & Partial<"">) & { [key: string]: unknown }; - au_becs_debit?: (Partial<{ [key: string]: unknown }> & Partial<"">) & { [key: string]: unknown }; - bacs_debit?: (Partial<{ [key: string]: unknown }> & Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } + alipay?: (Partial<{ [key: string]: unknown }> & Partial<''>) & { [key: string]: unknown } + au_becs_debit?: (Partial<{ [key: string]: unknown }> & Partial<''>) & { [key: string]: unknown } + bacs_debit?: (Partial<{ [key: string]: unknown }> & Partial<''>) & { [key: string]: unknown } bancontact?: (Partial< { /** @enum {string} */ - preferred_language?: "de" | "en" | "fr" | "nl"; + preferred_language?: 'de' | 'en' | 'fr' | 'nl' } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } boleto?: (Partial< { - expires_after_days?: number; + expires_after_days?: number } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } card?: (Partial< { - cvc_token?: string; + cvc_token?: string /** installments_param */ installments?: { - enabled?: boolean; + enabled?: boolean plan?: (Partial< { - count: number; + count: number /** @enum {string} */ - interval: "month"; + interval: 'month' /** @enum {string} */ - type: "fixed_count"; + type: 'fixed_count' } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown } /** @enum {string} */ - network?: - | "amex" - | "cartes_bancaires" - | "diners" - | "discover" - | "interac" - | "jcb" - | "mastercard" - | "unionpay" - | "unknown" - | "visa"; + network?: 'amex' | 'cartes_bancaires' | 'diners' | 'discover' | 'interac' | 'jcb' | 'mastercard' | 'unionpay' | 'unknown' | 'visa' /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: 'any' | 'automatic' /** @enum {string} */ - setup_future_usage?: "" | "none" | "off_session" | "on_session"; + setup_future_usage?: '' | 'none' | 'off_session' | 'on_session' } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - card_present?: (Partial<{ [key: string]: unknown }> & Partial<"">) & { [key: string]: unknown }; - eps?: (Partial<{ [key: string]: unknown }> & Partial<"">) & { [key: string]: unknown }; - fpx?: (Partial<{ [key: string]: unknown }> & Partial<"">) & { [key: string]: unknown }; - giropay?: (Partial<{ [key: string]: unknown }> & Partial<"">) & { [key: string]: unknown }; - grabpay?: (Partial<{ [key: string]: unknown }> & Partial<"">) & { [key: string]: unknown }; - ideal?: (Partial<{ [key: string]: unknown }> & Partial<"">) & { [key: string]: unknown }; - interac_present?: (Partial<{ [key: string]: unknown }> & Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } + card_present?: (Partial<{ [key: string]: unknown }> & Partial<''>) & { [key: string]: unknown } + eps?: (Partial<{ [key: string]: unknown }> & Partial<''>) & { [key: string]: unknown } + fpx?: (Partial<{ [key: string]: unknown }> & Partial<''>) & { [key: string]: unknown } + giropay?: (Partial<{ [key: string]: unknown }> & Partial<''>) & { [key: string]: unknown } + grabpay?: (Partial<{ [key: string]: unknown }> & Partial<''>) & { [key: string]: unknown } + ideal?: (Partial<{ [key: string]: unknown }> & Partial<''>) & { [key: string]: unknown } + interac_present?: (Partial<{ [key: string]: unknown }> & Partial<''>) & { [key: string]: unknown } klarna?: (Partial< { /** @enum {string} */ preferred_locale?: - | "da-DK" - | "de-AT" - | "de-DE" - | "en-AT" - | "en-BE" - | "en-DE" - | "en-DK" - | "en-ES" - | "en-FI" - | "en-FR" - | "en-GB" - | "en-IE" - | "en-IT" - | "en-NL" - | "en-NO" - | "en-SE" - | "en-US" - | "es-ES" - | "es-US" - | "fi-FI" - | "fr-BE" - | "fr-FR" - | "it-IT" - | "nb-NO" - | "nl-BE" - | "nl-NL" - | "sv-FI" - | "sv-SE"; + | 'da-DK' + | 'de-AT' + | 'de-DE' + | 'en-AT' + | 'en-BE' + | 'en-DE' + | 'en-DK' + | 'en-ES' + | 'en-FI' + | 'en-FR' + | 'en-GB' + | 'en-IE' + | 'en-IT' + | 'en-NL' + | 'en-NO' + | 'en-SE' + | 'en-US' + | 'es-ES' + | 'es-US' + | 'fi-FI' + | 'fr-BE' + | 'fr-FR' + | 'it-IT' + | 'nb-NO' + | 'nl-BE' + | 'nl-NL' + | 'sv-FI' + | 'sv-SE' } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } oxxo?: (Partial< { - expires_after_days?: number; + expires_after_days?: number } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } p24?: (Partial< { - tos_shown_and_accepted?: boolean; + tos_shown_and_accepted?: boolean } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } sepa_debit?: (Partial< { /** payment_method_options_mandate_options_param */ - mandate_options?: { [key: string]: unknown }; + mandate_options?: { [key: string]: unknown } } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } sofort?: (Partial< { /** @enum {string} */ - preferred_language?: "" | "de" | "en" | "es" | "fr" | "it" | "nl" | "pl"; + preferred_language?: '' | 'de' | 'en' | 'es' | 'fr' | 'it' | 'nl' | 'pl' } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } wechat_pay?: (Partial< { - app_id?: string; + app_id?: string /** @enum {string} */ - client: "android" | "ios" | "web"; + client: 'android' | 'ios' | 'web' } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown } /** @description The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. */ - payment_method_types?: string[]; + payment_method_types?: string[] /** @description 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?: (Partial & Partial<"">) & { [key: string]: unknown }; + receipt_email?: (Partial & Partial<''>) & { [key: string]: unknown } /** * @description The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. * If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. * This parameter is only used for cards and other redirect-based payment methods. */ - return_url?: string; + return_url?: string /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * @@ -34831,132 +34258,132 @@ export interface operations { * If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. * @enum {string} */ - setup_future_usage?: "" | "off_session" | "on_session"; + setup_future_usage?: '' | 'off_session' | 'on_session' /** @description Shipping information for this PaymentIntent. */ shipping?: (Partial< { /** optional_fields_address */ address: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - } & { [key: string]: unknown }; - carrier?: string; - name: string; - phone?: string; - tracking_number?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } & { [key: string]: unknown } + carrier?: string + name: string + phone?: string + tracking_number?: string } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** @description Set to `true` only when using manual confirmation and the iOS or Android SDKs to handle additional authentication steps. */ - use_stripe_sdk?: boolean; - }; - }; - }; - }; + use_stripe_sdk?: boolean + } + } + } + } /**

Verifies microdeposits on a PaymentIntent object.

*/ PostPaymentIntentsIntentVerifyMicrodeposits: { parameters: { path: { - intent: string; - }; - }; + intent: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_intent"]; - }; - }; + 'application/json': components['schemas']['payment_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account. */ - amounts?: number[]; + amounts?: number[] /** @description The client secret of the PaymentIntent. */ - client_secret?: string; + client_secret?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Returns a list of your payment links.

*/ GetPaymentLinks: { parameters: { query: { /** Only return payment links that are active or inactive (e.g., pass `false` to list all inactive payment links). */ - active?: boolean; + active?: boolean /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["payment_link"][]; + 'application/json': { + data: components['schemas']['payment_link'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a payment link.

*/ PostPaymentLinks: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_link"]; - }; - }; + 'application/json': components['schemas']['payment_link'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * after_completion_params * @description Behavior after the purchase is complete. @@ -34964,52 +34391,52 @@ export interface operations { after_completion?: { /** after_completion_confirmation_page_params */ hosted_confirmation?: { - custom_message?: string; - } & { [key: string]: unknown }; + custom_message?: string + } & { [key: string]: unknown } /** after_completion_redirect_params */ redirect?: { - url: string; - } & { [key: string]: unknown }; + url: string + } & { [key: string]: unknown } /** @enum {string} */ - type: "hosted_confirmation" | "redirect"; - } & { [key: string]: unknown }; + type: 'hosted_confirmation' | 'redirect' + } & { [key: string]: unknown } /** @description Enables user redeemable promotion codes. */ - allow_promotion_codes?: boolean; + allow_promotion_codes?: boolean /** @description 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. Can only be applied when there are no line items with recurring prices. */ - application_fee_amount?: number; + application_fee_amount?: number /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field. */ - application_fee_percent?: number; + application_fee_percent?: number /** * automatic_tax_params * @description Configuration for automatic tax collection. */ automatic_tax?: { - enabled: boolean; - } & { [key: string]: unknown }; + enabled: boolean + } & { [key: string]: unknown } /** * @description Configuration for collecting the customer's billing address. * @enum {string} */ - billing_address_collection?: "auto" | "required"; + billing_address_collection?: 'auto' | 'required' /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported. */ line_items?: ({ /** adjustable_quantity_params */ adjustable_quantity?: { - enabled: boolean; - maximum?: number; - minimum?: number; - } & { [key: string]: unknown }; - price: string; - quantity: number; - } & { [key: string]: unknown })[]; + enabled: boolean + maximum?: number + minimum?: number + } & { [key: string]: unknown } + price: string + quantity: number + } & { [key: string]: unknown })[] /** @description 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 associated with this Payment Link will automatically be copied to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link. */ - metadata?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The account on behalf of which to charge. */ - on_behalf_of?: string; + on_behalf_of?: string /** @description The list of payment method types that customers can use. Only `card` is supported. If no value is passed, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods) (20+ payment methods [supported](https://stripe.com/docs/payments/payment-methods/integration-options#payment-method-product-support)). */ - payment_method_types?: "card"[]; + payment_method_types?: 'card'[] /** * phone_number_collection_params * @description Controls phone number collection settings during checkout. @@ -35017,329 +34444,329 @@ export interface operations { * We recommend that you review your privacy policy and check with your legal contacts. */ phone_number_collection?: { - enabled: boolean; - } & { [key: string]: unknown }; + enabled: boolean + } & { [key: string]: unknown } /** * shipping_address_collection_params * @description Configuration for collecting the customer's shipping address. */ shipping_address_collection?: { allowed_countries: ( - | "AC" - | "AD" - | "AE" - | "AF" - | "AG" - | "AI" - | "AL" - | "AM" - | "AO" - | "AQ" - | "AR" - | "AT" - | "AU" - | "AW" - | "AX" - | "AZ" - | "BA" - | "BB" - | "BD" - | "BE" - | "BF" - | "BG" - | "BH" - | "BI" - | "BJ" - | "BL" - | "BM" - | "BN" - | "BO" - | "BQ" - | "BR" - | "BS" - | "BT" - | "BV" - | "BW" - | "BY" - | "BZ" - | "CA" - | "CD" - | "CF" - | "CG" - | "CH" - | "CI" - | "CK" - | "CL" - | "CM" - | "CN" - | "CO" - | "CR" - | "CV" - | "CW" - | "CY" - | "CZ" - | "DE" - | "DJ" - | "DK" - | "DM" - | "DO" - | "DZ" - | "EC" - | "EE" - | "EG" - | "EH" - | "ER" - | "ES" - | "ET" - | "FI" - | "FJ" - | "FK" - | "FO" - | "FR" - | "GA" - | "GB" - | "GD" - | "GE" - | "GF" - | "GG" - | "GH" - | "GI" - | "GL" - | "GM" - | "GN" - | "GP" - | "GQ" - | "GR" - | "GS" - | "GT" - | "GU" - | "GW" - | "GY" - | "HK" - | "HN" - | "HR" - | "HT" - | "HU" - | "ID" - | "IE" - | "IL" - | "IM" - | "IN" - | "IO" - | "IQ" - | "IS" - | "IT" - | "JE" - | "JM" - | "JO" - | "JP" - | "KE" - | "KG" - | "KH" - | "KI" - | "KM" - | "KN" - | "KR" - | "KW" - | "KY" - | "KZ" - | "LA" - | "LB" - | "LC" - | "LI" - | "LK" - | "LR" - | "LS" - | "LT" - | "LU" - | "LV" - | "LY" - | "MA" - | "MC" - | "MD" - | "ME" - | "MF" - | "MG" - | "MK" - | "ML" - | "MM" - | "MN" - | "MO" - | "MQ" - | "MR" - | "MS" - | "MT" - | "MU" - | "MV" - | "MW" - | "MX" - | "MY" - | "MZ" - | "NA" - | "NC" - | "NE" - | "NG" - | "NI" - | "NL" - | "NO" - | "NP" - | "NR" - | "NU" - | "NZ" - | "OM" - | "PA" - | "PE" - | "PF" - | "PG" - | "PH" - | "PK" - | "PL" - | "PM" - | "PN" - | "PR" - | "PS" - | "PT" - | "PY" - | "QA" - | "RE" - | "RO" - | "RS" - | "RU" - | "RW" - | "SA" - | "SB" - | "SC" - | "SE" - | "SG" - | "SH" - | "SI" - | "SJ" - | "SK" - | "SL" - | "SM" - | "SN" - | "SO" - | "SR" - | "SS" - | "ST" - | "SV" - | "SX" - | "SZ" - | "TA" - | "TC" - | "TD" - | "TF" - | "TG" - | "TH" - | "TJ" - | "TK" - | "TL" - | "TM" - | "TN" - | "TO" - | "TR" - | "TT" - | "TV" - | "TW" - | "TZ" - | "UA" - | "UG" - | "US" - | "UY" - | "UZ" - | "VA" - | "VC" - | "VE" - | "VG" - | "VN" - | "VU" - | "WF" - | "WS" - | "XK" - | "YE" - | "YT" - | "ZA" - | "ZM" - | "ZW" - | "ZZ" - )[]; - } & { [key: string]: unknown }; + | 'AC' + | 'AD' + | 'AE' + | 'AF' + | 'AG' + | 'AI' + | 'AL' + | 'AM' + | 'AO' + | 'AQ' + | 'AR' + | 'AT' + | 'AU' + | 'AW' + | 'AX' + | 'AZ' + | 'BA' + | 'BB' + | 'BD' + | 'BE' + | 'BF' + | 'BG' + | 'BH' + | 'BI' + | 'BJ' + | 'BL' + | 'BM' + | 'BN' + | 'BO' + | 'BQ' + | 'BR' + | 'BS' + | 'BT' + | 'BV' + | 'BW' + | 'BY' + | 'BZ' + | 'CA' + | 'CD' + | 'CF' + | 'CG' + | 'CH' + | 'CI' + | 'CK' + | 'CL' + | 'CM' + | 'CN' + | 'CO' + | 'CR' + | 'CV' + | 'CW' + | 'CY' + | 'CZ' + | 'DE' + | 'DJ' + | 'DK' + | 'DM' + | 'DO' + | 'DZ' + | 'EC' + | 'EE' + | 'EG' + | 'EH' + | 'ER' + | 'ES' + | 'ET' + | 'FI' + | 'FJ' + | 'FK' + | 'FO' + | 'FR' + | 'GA' + | 'GB' + | 'GD' + | 'GE' + | 'GF' + | 'GG' + | 'GH' + | 'GI' + | 'GL' + | 'GM' + | 'GN' + | 'GP' + | 'GQ' + | 'GR' + | 'GS' + | 'GT' + | 'GU' + | 'GW' + | 'GY' + | 'HK' + | 'HN' + | 'HR' + | 'HT' + | 'HU' + | 'ID' + | 'IE' + | 'IL' + | 'IM' + | 'IN' + | 'IO' + | 'IQ' + | 'IS' + | 'IT' + | 'JE' + | 'JM' + | 'JO' + | 'JP' + | 'KE' + | 'KG' + | 'KH' + | 'KI' + | 'KM' + | 'KN' + | 'KR' + | 'KW' + | 'KY' + | 'KZ' + | 'LA' + | 'LB' + | 'LC' + | 'LI' + | 'LK' + | 'LR' + | 'LS' + | 'LT' + | 'LU' + | 'LV' + | 'LY' + | 'MA' + | 'MC' + | 'MD' + | 'ME' + | 'MF' + | 'MG' + | 'MK' + | 'ML' + | 'MM' + | 'MN' + | 'MO' + | 'MQ' + | 'MR' + | 'MS' + | 'MT' + | 'MU' + | 'MV' + | 'MW' + | 'MX' + | 'MY' + | 'MZ' + | 'NA' + | 'NC' + | 'NE' + | 'NG' + | 'NI' + | 'NL' + | 'NO' + | 'NP' + | 'NR' + | 'NU' + | 'NZ' + | 'OM' + | 'PA' + | 'PE' + | 'PF' + | 'PG' + | 'PH' + | 'PK' + | 'PL' + | 'PM' + | 'PN' + | 'PR' + | 'PS' + | 'PT' + | 'PY' + | 'QA' + | 'RE' + | 'RO' + | 'RS' + | 'RU' + | 'RW' + | 'SA' + | 'SB' + | 'SC' + | 'SE' + | 'SG' + | 'SH' + | 'SI' + | 'SJ' + | 'SK' + | 'SL' + | 'SM' + | 'SN' + | 'SO' + | 'SR' + | 'SS' + | 'ST' + | 'SV' + | 'SX' + | 'SZ' + | 'TA' + | 'TC' + | 'TD' + | 'TF' + | 'TG' + | 'TH' + | 'TJ' + | 'TK' + | 'TL' + | 'TM' + | 'TN' + | 'TO' + | 'TR' + | 'TT' + | 'TV' + | 'TW' + | 'TZ' + | 'UA' + | 'UG' + | 'US' + | 'UY' + | 'UZ' + | 'VA' + | 'VC' + | 'VE' + | 'VG' + | 'VN' + | 'VU' + | 'WF' + | 'WS' + | 'XK' + | 'YE' + | 'YT' + | 'ZA' + | 'ZM' + | 'ZW' + | 'ZZ' + )[] + } & { [key: string]: unknown } /** * subscription_data_params * @description 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?: { - trial_period_days?: number; - } & { [key: string]: unknown }; + trial_period_days?: number + } & { [key: string]: unknown } /** * transfer_data_params * @description 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?: { - amount?: number; - destination: string; - } & { [key: string]: unknown }; - }; - }; - }; - }; + amount?: number + destination: string + } & { [key: string]: unknown } + } + } + } + } /**

Retrieve a payment link.

*/ GetPaymentLinksPaymentLink: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - payment_link: string; - }; - }; + payment_link: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_link"]; - }; - }; + 'application/json': components['schemas']['payment_link'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates a payment link.

*/ PostPaymentLinksPaymentLink: { parameters: { path: { - payment_link: string; - }; - }; + payment_link: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_link"]; - }; - }; + 'application/json': components['schemas']['payment_link'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description 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?: boolean; + active?: boolean /** * after_completion_params * @description Behavior after the purchase is complete. @@ -35347,412 +34774,412 @@ export interface operations { after_completion?: { /** after_completion_confirmation_page_params */ hosted_confirmation?: { - custom_message?: string; - } & { [key: string]: unknown }; + custom_message?: string + } & { [key: string]: unknown } /** after_completion_redirect_params */ redirect?: { - url: string; - } & { [key: string]: unknown }; + url: string + } & { [key: string]: unknown } /** @enum {string} */ - type: "hosted_confirmation" | "redirect"; - } & { [key: string]: unknown }; + type: 'hosted_confirmation' | 'redirect' + } & { [key: string]: unknown } /** @description Enables user redeemable promotion codes. */ - allow_promotion_codes?: boolean; + allow_promotion_codes?: boolean /** * automatic_tax_params * @description Configuration for automatic tax collection. */ automatic_tax?: { - enabled: boolean; - } & { [key: string]: unknown }; + enabled: boolean + } & { [key: string]: unknown } /** * @description Configuration for collecting the customer's billing address. * @enum {string} */ - billing_address_collection?: "auto" | "required"; + billing_address_collection?: 'auto' | 'required' /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported. */ line_items?: ({ /** adjustable_quantity_params */ adjustable_quantity?: { - enabled: boolean; - maximum?: number; - minimum?: number; - } & { [key: string]: unknown }; - id: string; - quantity?: number; - } & { [key: string]: unknown })[]; + enabled: boolean + maximum?: number + minimum?: number + } & { [key: string]: unknown } + id: string + quantity?: number + } & { [key: string]: unknown })[] /** @description 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 associated with this Payment Link will automatically be copied to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link. */ - metadata?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The list of payment method types that customers can use. Only `card` is supported. Pass an empty string to enable automatic payment methods that use your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). */ - payment_method_types?: (Partial<"card"[]> & Partial<"">) & { [key: string]: unknown }; + payment_method_types?: (Partial<'card'[]> & Partial<''>) & { [key: string]: unknown } /** @description Configuration for collecting the customer's shipping address. */ shipping_address_collection?: (Partial< { allowed_countries: ( - | "AC" - | "AD" - | "AE" - | "AF" - | "AG" - | "AI" - | "AL" - | "AM" - | "AO" - | "AQ" - | "AR" - | "AT" - | "AU" - | "AW" - | "AX" - | "AZ" - | "BA" - | "BB" - | "BD" - | "BE" - | "BF" - | "BG" - | "BH" - | "BI" - | "BJ" - | "BL" - | "BM" - | "BN" - | "BO" - | "BQ" - | "BR" - | "BS" - | "BT" - | "BV" - | "BW" - | "BY" - | "BZ" - | "CA" - | "CD" - | "CF" - | "CG" - | "CH" - | "CI" - | "CK" - | "CL" - | "CM" - | "CN" - | "CO" - | "CR" - | "CV" - | "CW" - | "CY" - | "CZ" - | "DE" - | "DJ" - | "DK" - | "DM" - | "DO" - | "DZ" - | "EC" - | "EE" - | "EG" - | "EH" - | "ER" - | "ES" - | "ET" - | "FI" - | "FJ" - | "FK" - | "FO" - | "FR" - | "GA" - | "GB" - | "GD" - | "GE" - | "GF" - | "GG" - | "GH" - | "GI" - | "GL" - | "GM" - | "GN" - | "GP" - | "GQ" - | "GR" - | "GS" - | "GT" - | "GU" - | "GW" - | "GY" - | "HK" - | "HN" - | "HR" - | "HT" - | "HU" - | "ID" - | "IE" - | "IL" - | "IM" - | "IN" - | "IO" - | "IQ" - | "IS" - | "IT" - | "JE" - | "JM" - | "JO" - | "JP" - | "KE" - | "KG" - | "KH" - | "KI" - | "KM" - | "KN" - | "KR" - | "KW" - | "KY" - | "KZ" - | "LA" - | "LB" - | "LC" - | "LI" - | "LK" - | "LR" - | "LS" - | "LT" - | "LU" - | "LV" - | "LY" - | "MA" - | "MC" - | "MD" - | "ME" - | "MF" - | "MG" - | "MK" - | "ML" - | "MM" - | "MN" - | "MO" - | "MQ" - | "MR" - | "MS" - | "MT" - | "MU" - | "MV" - | "MW" - | "MX" - | "MY" - | "MZ" - | "NA" - | "NC" - | "NE" - | "NG" - | "NI" - | "NL" - | "NO" - | "NP" - | "NR" - | "NU" - | "NZ" - | "OM" - | "PA" - | "PE" - | "PF" - | "PG" - | "PH" - | "PK" - | "PL" - | "PM" - | "PN" - | "PR" - | "PS" - | "PT" - | "PY" - | "QA" - | "RE" - | "RO" - | "RS" - | "RU" - | "RW" - | "SA" - | "SB" - | "SC" - | "SE" - | "SG" - | "SH" - | "SI" - | "SJ" - | "SK" - | "SL" - | "SM" - | "SN" - | "SO" - | "SR" - | "SS" - | "ST" - | "SV" - | "SX" - | "SZ" - | "TA" - | "TC" - | "TD" - | "TF" - | "TG" - | "TH" - | "TJ" - | "TK" - | "TL" - | "TM" - | "TN" - | "TO" - | "TR" - | "TT" - | "TV" - | "TW" - | "TZ" - | "UA" - | "UG" - | "US" - | "UY" - | "UZ" - | "VA" - | "VC" - | "VE" - | "VG" - | "VN" - | "VU" - | "WF" - | "WS" - | "XK" - | "YE" - | "YT" - | "ZA" - | "ZM" - | "ZW" - | "ZZ" - )[]; + | 'AC' + | 'AD' + | 'AE' + | 'AF' + | 'AG' + | 'AI' + | 'AL' + | 'AM' + | 'AO' + | 'AQ' + | 'AR' + | 'AT' + | 'AU' + | 'AW' + | 'AX' + | 'AZ' + | 'BA' + | 'BB' + | 'BD' + | 'BE' + | 'BF' + | 'BG' + | 'BH' + | 'BI' + | 'BJ' + | 'BL' + | 'BM' + | 'BN' + | 'BO' + | 'BQ' + | 'BR' + | 'BS' + | 'BT' + | 'BV' + | 'BW' + | 'BY' + | 'BZ' + | 'CA' + | 'CD' + | 'CF' + | 'CG' + | 'CH' + | 'CI' + | 'CK' + | 'CL' + | 'CM' + | 'CN' + | 'CO' + | 'CR' + | 'CV' + | 'CW' + | 'CY' + | 'CZ' + | 'DE' + | 'DJ' + | 'DK' + | 'DM' + | 'DO' + | 'DZ' + | 'EC' + | 'EE' + | 'EG' + | 'EH' + | 'ER' + | 'ES' + | 'ET' + | 'FI' + | 'FJ' + | 'FK' + | 'FO' + | 'FR' + | 'GA' + | 'GB' + | 'GD' + | 'GE' + | 'GF' + | 'GG' + | 'GH' + | 'GI' + | 'GL' + | 'GM' + | 'GN' + | 'GP' + | 'GQ' + | 'GR' + | 'GS' + | 'GT' + | 'GU' + | 'GW' + | 'GY' + | 'HK' + | 'HN' + | 'HR' + | 'HT' + | 'HU' + | 'ID' + | 'IE' + | 'IL' + | 'IM' + | 'IN' + | 'IO' + | 'IQ' + | 'IS' + | 'IT' + | 'JE' + | 'JM' + | 'JO' + | 'JP' + | 'KE' + | 'KG' + | 'KH' + | 'KI' + | 'KM' + | 'KN' + | 'KR' + | 'KW' + | 'KY' + | 'KZ' + | 'LA' + | 'LB' + | 'LC' + | 'LI' + | 'LK' + | 'LR' + | 'LS' + | 'LT' + | 'LU' + | 'LV' + | 'LY' + | 'MA' + | 'MC' + | 'MD' + | 'ME' + | 'MF' + | 'MG' + | 'MK' + | 'ML' + | 'MM' + | 'MN' + | 'MO' + | 'MQ' + | 'MR' + | 'MS' + | 'MT' + | 'MU' + | 'MV' + | 'MW' + | 'MX' + | 'MY' + | 'MZ' + | 'NA' + | 'NC' + | 'NE' + | 'NG' + | 'NI' + | 'NL' + | 'NO' + | 'NP' + | 'NR' + | 'NU' + | 'NZ' + | 'OM' + | 'PA' + | 'PE' + | 'PF' + | 'PG' + | 'PH' + | 'PK' + | 'PL' + | 'PM' + | 'PN' + | 'PR' + | 'PS' + | 'PT' + | 'PY' + | 'QA' + | 'RE' + | 'RO' + | 'RS' + | 'RU' + | 'RW' + | 'SA' + | 'SB' + | 'SC' + | 'SE' + | 'SG' + | 'SH' + | 'SI' + | 'SJ' + | 'SK' + | 'SL' + | 'SM' + | 'SN' + | 'SO' + | 'SR' + | 'SS' + | 'ST' + | 'SV' + | 'SX' + | 'SZ' + | 'TA' + | 'TC' + | 'TD' + | 'TF' + | 'TG' + | 'TH' + | 'TJ' + | 'TK' + | 'TL' + | 'TM' + | 'TN' + | 'TO' + | 'TR' + | 'TT' + | 'TV' + | 'TW' + | 'TZ' + | 'UA' + | 'UG' + | 'US' + | 'UY' + | 'UZ' + | 'VA' + | 'VC' + | 'VE' + | 'VG' + | 'VN' + | 'VU' + | 'WF' + | 'WS' + | 'XK' + | 'YE' + | 'YT' + | 'ZA' + | 'ZM' + | 'ZW' + | 'ZZ' + )[] } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - }; - }; - }; - }; + Partial<''>) & { [key: string]: unknown } + } + } + } + } /**

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.

*/ GetPaymentLinksPaymentLinkLineItems: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - payment_link: string; - }; - }; + payment_link: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["item"][]; + data: components['schemas']['item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of PaymentMethods. For listing a customer’s payment methods, you should use List a Customer’s PaymentMethods

*/ GetPaymentMethods: { parameters: { query: { /** The ID of the customer whose PaymentMethods will be retrieved. If not provided, the response list will be empty. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** A required filter on the list, based on the object `type` field. */ type: - | "acss_debit" - | "afterpay_clearpay" - | "alipay" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "eps" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "klarna" - | "oxxo" - | "p24" - | "sepa_debit" - | "sofort" - | "wechat_pay"; - }; - }; - responses: { - /** Successful response. */ - 200: { - content: { - "application/json": { - data: components["schemas"]["payment_method"][]; + | 'acss_debit' + | 'afterpay_clearpay' + | 'alipay' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'eps' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'klarna' + | 'oxxo' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' + } + } + responses: { + /** Successful response. */ + 200: { + content: { + 'application/json': { + data: components['schemas']['payment_method'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Creates a PaymentMethod object. Read the Stripe.js reference to learn how to create PaymentMethods via Stripe.js.

* @@ -35763,59 +35190,59 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_method"]; - }; - }; + 'application/json': components['schemas']['payment_method'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * payment_method_param * @description If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. */ acss_debit?: { - account_number: string; - institution_number: string; - transit_number: string; - } & { [key: string]: unknown }; + account_number: string + institution_number: string + transit_number: string + } & { [key: string]: unknown } /** * param * @description If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method. */ - afterpay_clearpay?: { [key: string]: unknown }; + afterpay_clearpay?: { [key: string]: unknown } /** * param * @description If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method. */ - alipay?: { [key: string]: unknown }; + alipay?: { [key: string]: unknown } /** * param * @description If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account. */ au_becs_debit?: { - account_number: string; - bsb_number: string; - } & { [key: string]: unknown }; + account_number: string + bsb_number: string + } & { [key: string]: unknown } /** * param * @description If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account. */ bacs_debit?: { - account_number?: string; - sort_code?: string; - } & { [key: string]: unknown }; + account_number?: string + sort_code?: string + } & { [key: string]: unknown } /** * param * @description If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method. */ - bancontact?: { [key: string]: unknown }; + bancontact?: { [key: string]: unknown } /** * billing_details_inner_params * @description Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods. @@ -35823,42 +35250,42 @@ export interface operations { billing_details?: { address?: (Partial< { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - email?: (Partial & Partial<"">) & { [key: string]: unknown }; - name?: string; - phone?: string; - } & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } + email?: (Partial & Partial<''>) & { [key: string]: unknown } + name?: string + phone?: string + } & { [key: string]: unknown } /** * param * @description If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method. */ boleto?: { - tax_id: string; - } & { [key: string]: unknown }; + tax_id: string + } & { [key: string]: unknown } /** @description If this is a `card` PaymentMethod, this hash contains the user's card details. For backwards compatibility, you can alternatively provide a Stripe token (e.g., for Apple Pay, Amex Express Checkout, or legacy Checkout) into the card hash with format `card: {token: "tok_visa"}`. When providing a card number, you must meet the requirements for [PCI compliance](https://stripe.com/docs/security#validating-pci-compliance). We strongly recommend using Stripe.js instead of interacting with this API directly. */ card?: (Partial< { - cvc?: string; - exp_month: number; - exp_year: number; - number: string; + cvc?: string + exp_month: number + exp_year: number + number: string } & { [key: string]: unknown } > & Partial< { - token: string; + token: string } & { [key: string]: unknown } - >) & { [key: string]: unknown }; + >) & { [key: string]: unknown } /** @description The `Customer` to whom the original PaymentMethod is attached. */ - customer?: string; + customer?: string /** * param * @description If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method. @@ -35866,36 +35293,36 @@ export interface operations { eps?: { /** @enum {string} */ bank?: - | "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" - | "dolomitenbank" - | "easybank_ag" - | "erste_bank_und_sparkassen" - | "hypo_alpeadriabank_international_ag" - | "hypo_bank_burgenland_aktiengesellschaft" - | "hypo_noe_lb_fur_niederosterreich_u_wien" - | "hypo_oberosterreich_salzburg_steiermark" - | "hypo_tirol_bank_ag" - | "hypo_vorarlberg_bank_ag" - | "marchfelder_bank" - | "oberbank_ag" - | "raiffeisen_bankengruppe_osterreich" - | "schoellerbank_ag" - | "sparda_bank_wien" - | "volksbank_gruppe" - | "volkskreditbank_ag" - | "vr_bank_braunau"; - } & { [key: string]: unknown }; + | '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' + | 'dolomitenbank' + | 'easybank_ag' + | 'erste_bank_und_sparkassen' + | 'hypo_alpeadriabank_international_ag' + | 'hypo_bank_burgenland_aktiengesellschaft' + | 'hypo_noe_lb_fur_niederosterreich_u_wien' + | 'hypo_oberosterreich_salzburg_steiermark' + | 'hypo_tirol_bank_ag' + | 'hypo_vorarlberg_bank_ag' + | 'marchfelder_bank' + | 'oberbank_ag' + | 'raiffeisen_bankengruppe_osterreich' + | 'schoellerbank_ag' + | 'sparda_bank_wien' + | 'volksbank_gruppe' + | 'volkskreditbank_ag' + | 'vr_bank_braunau' + } & { [key: string]: unknown } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * param * @description If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method. @@ -35903,38 +35330,38 @@ export interface operations { fpx?: { /** @enum {string} */ bank: - | "affin_bank" - | "agrobank" - | "alliance_bank" - | "ambank" - | "bank_islam" - | "bank_muamalat" - | "bank_rakyat" - | "bsn" - | "cimb" - | "deutsche_bank" - | "hong_leong_bank" - | "hsbc" - | "kfh" - | "maybank2e" - | "maybank2u" - | "ocbc" - | "pb_enterprise" - | "public_bank" - | "rhb" - | "standard_chartered" - | "uob"; - } & { [key: string]: unknown }; + | 'affin_bank' + | 'agrobank' + | 'alliance_bank' + | 'ambank' + | 'bank_islam' + | 'bank_muamalat' + | 'bank_rakyat' + | 'bsn' + | 'cimb' + | 'deutsche_bank' + | 'hong_leong_bank' + | 'hsbc' + | 'kfh' + | 'maybank2e' + | 'maybank2u' + | 'ocbc' + | 'pb_enterprise' + | 'public_bank' + | 'rhb' + | 'standard_chartered' + | 'uob' + } & { [key: string]: unknown } /** * param * @description If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method. */ - giropay?: { [key: string]: unknown }; + giropay?: { [key: string]: unknown } /** * param * @description If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method. */ - grabpay?: { [key: string]: unknown }; + grabpay?: { [key: string]: unknown } /** * param * @description If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method. @@ -35942,25 +35369,25 @@ export interface operations { ideal?: { /** @enum {string} */ bank?: - | "abn_amro" - | "asn_bank" - | "bunq" - | "handelsbanken" - | "ing" - | "knab" - | "moneyou" - | "rabobank" - | "regiobank" - | "revolut" - | "sns_bank" - | "triodos_bank" - | "van_lanschot"; - } & { [key: string]: unknown }; + | 'abn_amro' + | 'asn_bank' + | 'bunq' + | 'handelsbanken' + | 'ing' + | 'knab' + | 'moneyou' + | 'rabobank' + | 'regiobank' + | 'revolut' + | 'sns_bank' + | 'triodos_bank' + | 'van_lanschot' + } & { [key: string]: unknown } /** * param * @description If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method. */ - interac_present?: { [key: string]: unknown }; + interac_present?: { [key: string]: unknown } /** * param * @description If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method. @@ -35968,18 +35395,18 @@ export interface operations { klarna?: { /** date_of_birth */ dob?: { - day: number; - month: number; - year: number; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + day: number + month: number + year: number + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * param * @description If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method. */ - oxxo?: { [key: string]: unknown }; + oxxo?: { [key: string]: unknown } /** * param * @description If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method. @@ -35987,137 +35414,137 @@ export interface operations { p24?: { /** @enum {string} */ bank?: - | "alior_bank" - | "bank_millennium" - | "bank_nowy_bfg_sa" - | "bank_pekao_sa" - | "banki_spbdzielcze" - | "blik" - | "bnp_paribas" - | "boz" - | "citi_handlowy" - | "credit_agricole" - | "envelobank" - | "etransfer_pocztowy24" - | "getin_bank" - | "ideabank" - | "ing" - | "inteligo" - | "mbank_mtransfer" - | "nest_przelew" - | "noble_pay" - | "pbac_z_ipko" - | "plus_bank" - | "santander_przelew24" - | "tmobile_usbugi_bankowe" - | "toyota_bank" - | "volkswagen_bank"; - } & { [key: string]: unknown }; + | 'alior_bank' + | 'bank_millennium' + | 'bank_nowy_bfg_sa' + | 'bank_pekao_sa' + | 'banki_spbdzielcze' + | 'blik' + | 'bnp_paribas' + | 'boz' + | 'citi_handlowy' + | 'credit_agricole' + | 'envelobank' + | 'etransfer_pocztowy24' + | 'getin_bank' + | 'ideabank' + | 'ing' + | 'inteligo' + | 'mbank_mtransfer' + | 'nest_przelew' + | 'noble_pay' + | 'pbac_z_ipko' + | 'plus_bank' + | 'santander_przelew24' + | 'tmobile_usbugi_bankowe' + | 'toyota_bank' + | 'volkswagen_bank' + } & { [key: string]: unknown } /** @description The PaymentMethod to share. */ - payment_method?: string; + payment_method?: string /** * param * @description If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account. */ sepa_debit?: { - iban: string; - } & { [key: string]: unknown }; + iban: string + } & { [key: string]: unknown } /** * param * @description If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method. */ sofort?: { /** @enum {string} */ - country: "AT" | "BE" | "DE" | "ES" | "IT" | "NL"; - } & { [key: string]: unknown }; + country: 'AT' | 'BE' | 'DE' | 'ES' | 'IT' | 'NL' + } & { [key: string]: unknown } /** * @description 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. * @enum {string} */ type?: - | "acss_debit" - | "afterpay_clearpay" - | "alipay" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "eps" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "klarna" - | "oxxo" - | "p24" - | "sepa_debit" - | "sofort" - | "wechat_pay"; + | 'acss_debit' + | 'afterpay_clearpay' + | 'alipay' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'eps' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'klarna' + | 'oxxo' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' /** * param * @description If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method. */ - wechat_pay?: { [key: string]: unknown }; - }; - }; - }; - }; + wechat_pay?: { [key: string]: unknown } + } + } + } + } /**

Retrieves a PaymentMethod object.

*/ GetPaymentMethodsPaymentMethod: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - payment_method: string; - }; - }; + payment_method: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_method"]; - }; - }; + 'application/json': components['schemas']['payment_method'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostPaymentMethodsPaymentMethod: { parameters: { path: { - payment_method: string; - }; - }; + payment_method: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_method"]; - }; - }; + 'application/json': components['schemas']['payment_method'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * billing_details_inner_params * @description Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods. @@ -36125,35 +35552,35 @@ export interface operations { billing_details?: { address?: (Partial< { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - email?: (Partial & Partial<"">) & { [key: string]: unknown }; - name?: string; - phone?: string; - } & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } + email?: (Partial & Partial<''>) & { [key: string]: unknown } + name?: string + phone?: string + } & { [key: string]: unknown } /** * update_api_param * @description If this is a `card` PaymentMethod, this hash contains the user's card details. */ card?: { - exp_month?: number; - exp_year?: number; - } & { [key: string]: unknown }; + exp_month?: number + exp_year?: number + } & { [key: string]: unknown } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; - }; - }; - }; - }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } + } + } + } + } /** *

Attaches a PaymentMethod object to a Customer.

* @@ -36170,131 +35597,131 @@ export interface operations { PostPaymentMethodsPaymentMethodAttach: { parameters: { path: { - payment_method: string; - }; - }; + payment_method: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_method"]; - }; - }; + 'application/json': components['schemas']['payment_method'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The ID of the customer to which to attach the PaymentMethod. */ - customer: string; + customer: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Detaches a PaymentMethod object from a Customer.

*/ PostPaymentMethodsPaymentMethodDetach: { parameters: { path: { - payment_method: string; - }; - }; + payment_method: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_method"]; - }; - }; + 'application/json': components['schemas']['payment_method'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Returns a list of existing payouts sent to third-party bank accounts or that Stripe has sent you. The payouts are returned in sorted order, with the most recently created payouts appearing first.

*/ GetPayouts: { parameters: { query: { arrival_date?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } created?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** The ID of an external account - only return payouts sent to this external account. */ - destination?: string; + destination?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return payouts that have the given status: `pending`, `paid`, `failed`, or `canceled`. */ - status?: string; - }; - }; + status?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["payout"][]; + 'application/json': { + data: components['schemas']['payout'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

To send funds to your own bank account, you create a new payout object. Your Stripe balance must be able to cover the payout amount, or you’ll receive an “Insufficient Funds” error.

* @@ -36307,140 +35734,140 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payout"]; - }; - }; + 'application/json': components['schemas']['payout'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A positive integer in cents representing how much to payout. */ - amount: number; + amount: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description The ID of a bank account or a card to send the payout to. If no destination is supplied, the default external account for the specified currency will be used. */ - destination?: string; + destination?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * @description The method used to send this payout, which can be `standard` or `instant`. `instant` is only supported for payouts to debit cards. (See [Instant payouts for marketplaces for more information](https://stripe.com/blog/instant-payouts-for-marketplaces).) * @enum {string} */ - method?: "instant" | "standard"; + method?: 'instant' | 'standard' /** * @description The balance type of your Stripe balance to draw this payout from. Balances for different payment sources are kept separately. You can find the amounts with the balances API. One of `bank_account`, `card`, or `fpx`. * @enum {string} */ - source_type?: "bank_account" | "card" | "fpx"; + source_type?: 'bank_account' | 'card' | 'fpx' /** @description A string to be displayed on the recipient's bank or card statement. This may be at most 22 characters. Attempting to use a `statement_descriptor` longer than 22 characters will return an error. Note: Most banks will truncate this information and/or display it inconsistently. Some may not display it at all. */ - statement_descriptor?: string; - }; - }; - }; - }; + statement_descriptor?: string + } + } + } + } /**

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

*/ GetPayoutsPayout: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - payout: string; - }; - }; + payout: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payout"]; - }; - }; + 'application/json': components['schemas']['payout'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates the specified payout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request accepts only the metadata as arguments.

*/ PostPayoutsPayout: { parameters: { path: { - payout: string; - }; - }; + payout: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payout"]; - }; - }; + 'application/json': components['schemas']['payout'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; - }; - }; - }; - }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } + } + } + } + } /**

A previously created payout can be canceled if it has not yet been paid out. Funds will be refunded to your available balance. You may not cancel automatic Stripe payouts.

*/ PostPayoutsPayoutCancel: { parameters: { path: { - payout: string; - }; - }; + payout: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payout"]; - }; - }; + 'application/json': components['schemas']['payout'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /** *

Reverses a payout by debiting the destination bank account. Only payouts for connected accounts to US bank accounts may be reversed at this time. If the payout is in the pending status, /v1/payouts/:id/cancel should be used instead.

* @@ -36449,1576 +35876,1572 @@ export interface operations { PostPayoutsPayoutReverse: { parameters: { path: { - payout: string; - }; - }; + payout: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payout"]; - }; - }; + 'application/json': components['schemas']['payout'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; - }; - }; - }; - }; + metadata?: { [key: string]: string } + } + } + } + } /**

Returns a list of your plans.

*/ GetPlans: { parameters: { query: { /** Only return plans that are active or inactive (e.g., pass `false` to list all inactive plans). */ - active?: boolean; + active?: boolean /** 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?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return plans for the given product. */ - product?: string; + product?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["plan"][]; + data: components['schemas']['plan'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostPlans: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["plan"]; - }; - }; + 'application/json': components['schemas']['plan'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether the plan is currently available for new subscriptions. Defaults to `true`. */ - active?: boolean; + active?: boolean /** * @description 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`. * @enum {string} */ - aggregate_usage?: "last_during_period" | "last_ever" | "max" | "sum"; + aggregate_usage?: 'last_during_period' | 'last_ever' | 'max' | 'sum' /** @description A positive integer in %s (or 0 for a free plan) representing how much to charge on a recurring basis. */ - amount?: number; + amount?: number /** * Format: decimal * @description Same as `amount`, but accepts a decimal value with at most 12 decimal places. Only one of `amount` and `amount_decimal` can be set. */ - amount_decimal?: string; + amount_decimal?: string /** * @description 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. * @enum {string} */ - billing_scheme?: "per_unit" | "tiered"; + billing_scheme?: 'per_unit' | 'tiered' /** @description 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: string; + currency: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description An identifier randomly generated by Stripe. Used to identify this plan when subscribing a customer. You can optionally override this ID, but the ID must be unique across all plans in your Stripe account. You can, however, use the same plan ID in both live and test modes. */ - id?: string; + id?: string /** * @description Specifies billing frequency. Either `day`, `week`, `month` or `year`. * @enum {string} */ - interval: "day" | "month" | "week" | "year"; + interval: 'day' | 'month' | 'week' | 'year' /** @description The number of intervals between subscription billings. 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?: number; + interval_count?: number /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description A brief description of the plan, hidden from customers. */ - nickname?: string; + nickname?: string product?: (Partial< { - active?: boolean; - id?: string; - metadata?: { [key: string]: string }; - name: string; - statement_descriptor?: string; - tax_code?: string; - unit_label?: string; + active?: boolean + id?: string + metadata?: { [key: string]: string } + name: string + statement_descriptor?: string + tax_code?: string + unit_label?: string } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** @description Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. */ tiers?: ({ - flat_amount?: number; + flat_amount?: number /** Format: decimal */ - flat_amount_decimal?: string; - unit_amount?: number; + flat_amount_decimal?: string + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - up_to: (Partial<"inf"> & Partial) & { [key: string]: unknown }; - } & { [key: string]: unknown })[]; + unit_amount_decimal?: string + up_to: (Partial<'inf'> & Partial) & { [key: string]: unknown } + } & { [key: string]: unknown })[] /** * @description 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 successively change as the quantity grows. * @enum {string} */ - tiers_mode?: "graduated" | "volume"; + tiers_mode?: 'graduated' | 'volume' /** * transform_usage_param * @description Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`. */ transform_usage?: { - divide_by: number; + divide_by: number /** @enum {string} */ - round: "down" | "up"; - } & { [key: string]: unknown }; + round: 'down' | 'up' + } & { [key: string]: unknown } /** @description 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?: number; + trial_period_days?: number /** * @description 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`. * @enum {string} */ - usage_type?: "licensed" | "metered"; - }; - }; - }; - }; + usage_type?: 'licensed' | 'metered' + } + } + } + } /**

Retrieves the plan with the given ID.

*/ GetPlansPlan: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - plan: string; - }; - }; + plan: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["plan"]; - }; - }; + 'application/json': components['schemas']['plan'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostPlansPlan: { parameters: { path: { - plan: string; - }; - }; + plan: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["plan"]; - }; - }; + 'application/json': components['schemas']['plan'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether the plan is currently available for new subscriptions. */ - active?: boolean; + active?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description A brief description of the plan, hidden from customers. */ - nickname?: string; + nickname?: string /** @description The product the plan belongs to. This cannot be changed once it has been used in a subscription or subscription schedule. */ - product?: string; + product?: string /** @description 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?: number; - }; - }; - }; - }; + trial_period_days?: number + } + } + } + } /**

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

*/ DeletePlansPlan: { parameters: { path: { - plan: string; - }; - }; + plan: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_plan"]; - }; - }; + 'application/json': components['schemas']['deleted_plan'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of your prices.

*/ GetPrices: { parameters: { query: { /** Only return prices that are active or inactive (e.g., pass `false` to list all inactive prices). */ - active?: boolean; + active?: boolean /** 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?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** Only return prices for the given currency. */ - currency?: string; + currency?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return the price with these lookup_keys, if any exist. */ - lookup_keys?: string[]; + lookup_keys?: string[] /** Only return prices for the given product. */ - product?: string; + product?: string /** Only return prices with these recurring fields. */ recurring?: { /** @enum {string} */ - interval?: "day" | "month" | "week" | "year"; + interval?: 'day' | 'month' | 'week' | 'year' /** @enum {string} */ - usage_type?: "licensed" | "metered"; - } & { [key: string]: unknown }; + usage_type?: 'licensed' | 'metered' + } & { [key: string]: unknown } /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return prices of type `recurring` or `one_time`. */ - type?: "one_time" | "recurring"; - }; - }; + type?: 'one_time' | 'recurring' + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["price"][]; + data: components['schemas']['price'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostPrices: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["price"]; - }; - }; + 'application/json': components['schemas']['price'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether the price can be used for new purchases. Defaults to `true`. */ - active?: boolean; + active?: boolean /** * @description 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. * @enum {string} */ - billing_scheme?: "per_unit" | "tiered"; + billing_scheme?: 'per_unit' | 'tiered' /** @description 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: string; + currency: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters. */ - lookup_key?: string; + lookup_key?: string /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description A brief description of the price, hidden from customers. */ - nickname?: string; + nickname?: string /** @description The ID of the product that this price will belong to. */ - product?: string; + product?: string /** * inline_product_params * @description These fields can be used to create a new product that this price will belong to. */ product_data?: { - active?: boolean; - id?: string; - metadata?: { [key: string]: string }; - name: string; - statement_descriptor?: string; - tax_code?: string; - unit_label?: string; - } & { [key: string]: unknown }; + active?: boolean + id?: string + metadata?: { [key: string]: string } + name: string + statement_descriptor?: string + tax_code?: string + unit_label?: string + } & { [key: string]: unknown } /** * recurring * @description The recurring components of a price such as `interval` and `usage_type`. */ recurring?: { /** @enum {string} */ - aggregate_usage?: "last_during_period" | "last_ever" | "max" | "sum"; + aggregate_usage?: 'last_during_period' | 'last_ever' | 'max' | 'sum' /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number /** @enum {string} */ - usage_type?: "licensed" | "metered"; - } & { [key: string]: unknown }; + usage_type?: 'licensed' | 'metered' + } & { [key: string]: unknown } /** * @description 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. * @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' /** @description Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. */ tiers?: ({ - flat_amount?: number; + flat_amount?: number /** Format: decimal */ - flat_amount_decimal?: string; - unit_amount?: number; + flat_amount_decimal?: string + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - up_to: (Partial<"inf"> & Partial) & { [key: string]: unknown }; - } & { [key: string]: unknown })[]; + unit_amount_decimal?: string + up_to: (Partial<'inf'> & Partial) & { [key: string]: unknown } + } & { [key: string]: unknown })[] /** * @description 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 successively change as the quantity grows. * @enum {string} */ - tiers_mode?: "graduated" | "volume"; + tiers_mode?: 'graduated' | 'volume' /** @description If set to true, will atomically remove the lookup key from the existing price, and assign it to this price. */ - transfer_lookup_key?: boolean; + transfer_lookup_key?: boolean /** * transform_usage_param * @description Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`. */ transform_quantity?: { - divide_by: number; + divide_by: number /** @enum {string} */ - round: "down" | "up"; - } & { [key: string]: unknown }; + round: 'down' | 'up' + } & { [key: string]: unknown } /** @description A positive integer in %s (or 0 for a free price) representing how much to charge. */ - unit_amount?: number; + unit_amount?: number /** * Format: decimal * @description Same as `unit_amount`, but accepts a decimal value in %s with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. */ - unit_amount_decimal?: string; - }; - }; - }; - }; + unit_amount_decimal?: string + } + } + } + } /**

Retrieves the price with the given ID.

*/ GetPricesPrice: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - price: string; - }; - }; + price: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["price"]; - }; - }; + 'application/json': components['schemas']['price'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostPricesPrice: { parameters: { path: { - price: string; - }; - }; + price: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["price"]; - }; - }; + 'application/json': components['schemas']['price'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether the price can be used for new purchases. Defaults to `true`. */ - active?: boolean; + active?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters. */ - lookup_key?: string; + lookup_key?: string /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description A brief description of the price, hidden from customers. */ - nickname?: string; + nickname?: string /** * @description 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. * @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' /** @description If set to true, will atomically remove the lookup key from the existing price, and assign it to this price. */ - transfer_lookup_key?: boolean; - }; - }; - }; - }; + transfer_lookup_key?: boolean + } + } + } + } /**

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

*/ GetProducts: { parameters: { query: { /** Only return products that are active or inactive (e.g., pass `false` to list all inactive products). */ - active?: boolean; + active?: boolean /** Only return products that were created during the given date interval. */ created?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** Only return products with the given IDs. */ - ids?: string[]; + ids?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return products that can be shipped (i.e., physical, not digital products). */ - shippable?: boolean; + shippable?: boolean /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return products with the given url. */ - url?: string; - }; - }; + url?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["product"][]; + data: components['schemas']['product'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new product object.

*/ PostProducts: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["product"]; - }; - }; + 'application/json': components['schemas']['product'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether the product is currently available for purchase. Defaults to `true`. */ - active?: boolean; + active?: boolean /** @description 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?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description An identifier will be randomly generated by Stripe. You can optionally override this ID, but the ID must be unique across all products in your Stripe account. */ - id?: string; + id?: string /** @description A list of up to 8 URLs of images for this product, meant to be displayable to the customer. */ - images?: string[]; + images?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The product's name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions. */ - name: string; + name: string /** * package_dimensions_specs * @description The dimensions of this product for shipping purposes. */ package_dimensions?: { - height: number; - length: number; - weight: number; - width: number; - } & { [key: string]: unknown }; + height: number + length: number + weight: number + width: number + } & { [key: string]: unknown } /** @description Whether this product is shipped (i.e., physical goods). */ - shippable?: boolean; + shippable?: boolean /** * @description An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all. * * This may be up to 22 characters. The statement description may not include `<`, `>`, `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. * It must contain at least one letter. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description A [tax code](https://stripe.com/docs/tax/tax-codes) ID. */ - tax_code?: string; + tax_code?: string /** @description A label that represents units of this product in Stripe and on customers’ receipts and invoices. When set, this will be included in associated invoice line item descriptions. */ - unit_label?: string; + unit_label?: string /** @description A URL of a publicly-accessible webpage for this product. */ - url?: string; - }; - }; - }; - }; + url?: string + } + } + } + } /**

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.

*/ GetProductsId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["product"]; - }; - }; + 'application/json': components['schemas']['product'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostProductsId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["product"]; - }; - }; + 'application/json': components['schemas']['product'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether the product is available for purchase. */ - active?: boolean; + active?: boolean /** @description 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?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A list of up to 8 URLs of images for this product, meant to be displayable to the customer. */ - images?: (Partial & Partial<"">) & { [key: string]: unknown }; + images?: (Partial & Partial<''>) & { [key: string]: unknown } /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description The product's name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions. */ - name?: string; + name?: string /** @description The dimensions of this product for shipping purposes. */ package_dimensions?: (Partial< { - height: number; - length: number; - weight: number; - width: number; + height: number + length: number + weight: number + width: number } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** @description Whether this product is shipped (i.e., physical goods). */ - shippable?: boolean; + shippable?: boolean /** * @description An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all. * * This may be up to 22 characters. The statement description may not include `<`, `>`, `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. * It must contain at least one letter. May only be set if `type=service`. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description A [tax code](https://stripe.com/docs/tax/tax-codes) ID. */ - tax_code?: (Partial & Partial<"">) & { [key: string]: unknown }; + tax_code?: (Partial & Partial<''>) & { [key: string]: unknown } /** @description A label that represents units of this product in Stripe and on customers’ receipts and invoices. When set, this will be included in associated invoice line item descriptions. May only be set if `type=service`. */ - unit_label?: string; + unit_label?: string /** @description A URL of a publicly-accessible webpage for this product. */ - url?: string; - }; - }; - }; - }; + url?: string + } + } + } + } /**

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.

*/ DeleteProductsId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_product"]; - }; - }; + 'application/json': components['schemas']['deleted_product'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of your promotion codes.

*/ GetPromotionCodes: { parameters: { query: { /** Filter promotion codes by whether they are active. */ - active?: boolean; + active?: boolean /** Only return promotion codes that have this case-insensitive code. */ - code?: string; + code?: string /** Only return promotion codes for this coupon. */ - coupon?: string; + coupon?: string /** 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?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** Only return promotion codes that are restricted to this customer. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["promotion_code"][]; + 'application/json': { + data: components['schemas']['promotion_code'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostPromotionCodes: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["promotion_code"]; - }; - }; + 'application/json': components['schemas']['promotion_code'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether the promotion code is currently active. */ - active?: boolean; + active?: boolean /** @description The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for a specific customer. If left blank, we will generate one automatically. */ - code?: string; + code?: string /** @description The coupon for this promotion code. */ - coupon: string; + coupon: string /** @description The customer that this promotion code can be used by. If not set, the promotion code can be used by all customers. */ - customer?: string; + customer?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * Format: unix-time * @description The timestamp at which this promotion code will expire. If the coupon has specified a `redeems_by`, then this value cannot be after the coupon's `redeems_by`. */ - expires_at?: number; + expires_at?: number /** @description A positive integer specifying the number of times the promotion code can be redeemed. If the coupon has specified a `max_redemptions`, then this value cannot be greater than the coupon's `max_redemptions`. */ - max_redemptions?: number; + max_redemptions?: number /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * restrictions_params * @description Settings that restrict the redemption of the promotion code. */ restrictions?: { - first_time_transaction?: boolean; - minimum_amount?: number; - minimum_amount_currency?: string; - } & { [key: string]: unknown }; - }; - }; - }; - }; + first_time_transaction?: boolean + minimum_amount?: number + minimum_amount_currency?: string + } & { [key: string]: unknown } + } + } + } + } /**

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.

*/ GetPromotionCodesPromotionCode: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - promotion_code: string; - }; - }; + promotion_code: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["promotion_code"]; - }; - }; + 'application/json': components['schemas']['promotion_code'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostPromotionCodesPromotionCode: { parameters: { path: { - promotion_code: string; - }; - }; + promotion_code: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["promotion_code"]; - }; - }; + 'application/json': components['schemas']['promotion_code'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether the promotion code is currently active. A promotion code can only be reactivated when the coupon is still valid and the promotion code is otherwise redeemable. */ - active?: boolean; + active?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; - }; - }; - }; - }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } + } + } + } + } /**

Returns a list of your quotes.

*/ GetQuotes: { parameters: { query: { /** The ID of the customer whose quotes will be retrieved. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** The status of the quote. */ - status?: "accepted" | "canceled" | "draft" | "open"; - }; - }; + status?: 'accepted' | 'canceled' | 'draft' | 'open' + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["quote"][]; + 'application/json': { + data: components['schemas']['quote'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostQuotes: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["quote"]; - }; - }; + 'application/json': components['schemas']['quote'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description 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. There cannot be any line items with recurring prices when using this field. */ - application_fee_amount?: (Partial & Partial<"">) & { [key: string]: unknown }; + application_fee_amount?: (Partial & Partial<''>) & { [key: string]: unknown } /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field. */ - application_fee_percent?: (Partial & Partial<"">) & { [key: string]: unknown }; + application_fee_percent?: (Partial & Partial<''>) & { [key: string]: unknown } /** * automatic_tax_param * @description Settings for automatic tax lookup for this quote and resulting invoices and subscriptions. */ automatic_tax?: { - enabled: boolean; - } & { [key: string]: unknown }; + enabled: boolean + } & { [key: string]: unknown } /** * @description Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice 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. Defaults to `charge_automatically`. * @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' /** @description The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed. */ - customer?: string; + customer?: string /** @description The tax rates that will apply to any line item that does not have `tax_rates` set. */ - default_tax_rates?: (Partial & Partial<"">) & { [key: string]: unknown }; + default_tax_rates?: (Partial & Partial<''>) & { [key: string]: unknown } /** @description A description that will be displayed on the quote PDF. If no value is passed, the default description configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used. */ - description?: string; + description?: string /** @description The discounts applied to the quote. You can only set up to one discount. */ discounts?: (Partial< ({ - coupon?: string; - discount?: string; + coupon?: string + discount?: string } & { [key: string]: unknown })[] > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * Format: unix-time * @description A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. If no value is passed, the default expiration date configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used. */ - expires_at?: number; + expires_at?: number /** @description A footer that will be displayed on the quote PDF. If no value is passed, the default footer configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used. */ - footer?: string; + footer?: string /** * from_quote_params * @description Clone an existing quote. The new quote will be created in `status=draft`. When using this parameter, you cannot specify any other parameters except for `expires_at`. */ from_quote?: { - is_revision?: boolean; - quote: string; - } & { [key: string]: unknown }; + is_revision?: boolean + quote: string + } & { [key: string]: unknown } /** @description A header that will be displayed on the quote PDF. If no value is passed, the default header configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used. */ - header?: string; + header?: string /** * quote_param * @description All invoices will be billed using the specified settings. */ invoice_settings?: { - days_until_due?: number; - } & { [key: string]: unknown }; + days_until_due?: number + } & { [key: string]: unknown } /** @description A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost. */ line_items?: ({ - price?: string; + price?: string /** price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring?: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - } & { [key: string]: unknown }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } & { [key: string]: unknown } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - } & { [key: string]: unknown }; - quantity?: number; - tax_rates?: (Partial & Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown })[]; + unit_amount_decimal?: string + } & { [key: string]: unknown } + quantity?: number + tax_rates?: (Partial & Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown })[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The account on behalf of which to charge. */ - on_behalf_of?: (Partial & Partial<"">) & { [key: string]: unknown }; + on_behalf_of?: (Partial & Partial<''>) & { [key: string]: unknown } /** * subscription_data_create_params * @description When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if `subscription_data[effective_date]` is present and in the future, otherwise a subscription is created. */ subscription_data?: { - effective_date?: (Partial<"current_period_end"> & Partial & Partial<"">) & { - [key: string]: unknown; - }; - trial_period_days?: (Partial & Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown }; + effective_date?: (Partial<'current_period_end'> & Partial & Partial<''>) & { [key: string]: unknown } + trial_period_days?: (Partial & Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown } /** @description The data with which to automatically create a Transfer for each of the invoices. */ transfer_data?: (Partial< { - amount?: number; - amount_percent?: number; - destination: string; + amount?: number + amount_percent?: number + destination: string } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - }; - }; - }; - }; + Partial<''>) & { [key: string]: unknown } + } + } + } + } /**

Retrieves the quote with the given ID.

*/ GetQuotesQuote: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - quote: string; - }; - }; + quote: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["quote"]; - }; - }; + 'application/json': components['schemas']['quote'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

A quote models prices and services for a customer.

*/ PostQuotesQuote: { parameters: { path: { - quote: string; - }; - }; + quote: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["quote"]; - }; - }; + 'application/json': components['schemas']['quote'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description 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. There cannot be any line items with recurring prices when using this field. */ - application_fee_amount?: (Partial & Partial<"">) & { [key: string]: unknown }; + application_fee_amount?: (Partial & Partial<''>) & { [key: string]: unknown } /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field. */ - application_fee_percent?: (Partial & Partial<"">) & { [key: string]: unknown }; + application_fee_percent?: (Partial & Partial<''>) & { [key: string]: unknown } /** * automatic_tax_param * @description Settings for automatic tax lookup for this quote and resulting invoices and subscriptions. */ automatic_tax?: { - enabled: boolean; - } & { [key: string]: unknown }; + enabled: boolean + } & { [key: string]: unknown } /** * @description Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice 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. Defaults to `charge_automatically`. * @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' /** @description The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed. */ - customer?: string; + customer?: string /** @description The tax rates that will apply to any line item that does not have `tax_rates` set. */ - default_tax_rates?: (Partial & Partial<"">) & { [key: string]: unknown }; + default_tax_rates?: (Partial & Partial<''>) & { [key: string]: unknown } /** @description A description that will be displayed on the quote PDF. */ - description?: string; + description?: string /** @description The discounts applied to the quote. You can only set up to one discount. */ discounts?: (Partial< ({ - coupon?: string; - discount?: string; + coupon?: string + discount?: string } & { [key: string]: unknown })[] > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * Format: unix-time * @description A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. */ - expires_at?: number; + expires_at?: number /** @description A footer that will be displayed on the quote PDF. */ - footer?: string; + footer?: string /** @description A header that will be displayed on the quote PDF. */ - header?: string; + header?: string /** * quote_param * @description All invoices will be billed using the specified settings. */ invoice_settings?: { - days_until_due?: number; - } & { [key: string]: unknown }; + days_until_due?: number + } & { [key: string]: unknown } /** @description A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost. */ line_items?: ({ - id?: string; - price?: string; + id?: string + price?: string /** price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring?: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - } & { [key: string]: unknown }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } & { [key: string]: unknown } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - } & { [key: string]: unknown }; - quantity?: number; - tax_rates?: (Partial & Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown })[]; + unit_amount_decimal?: string + } & { [key: string]: unknown } + quantity?: number + tax_rates?: (Partial & Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown })[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The account on behalf of which to charge. */ - on_behalf_of?: (Partial & Partial<"">) & { [key: string]: unknown }; + on_behalf_of?: (Partial & Partial<''>) & { [key: string]: unknown } /** * subscription_data_update_params * @description When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if `subscription_data[effective_date]` is present and in the future, otherwise a subscription is created. */ subscription_data?: { - effective_date?: (Partial<"current_period_end"> & Partial & Partial<"">) & { - [key: string]: unknown; - }; - trial_period_days?: (Partial & Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown }; + effective_date?: (Partial<'current_period_end'> & Partial & Partial<''>) & { [key: string]: unknown } + trial_period_days?: (Partial & Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown } /** @description The data with which to automatically create a Transfer for each of the invoices. */ transfer_data?: (Partial< { - amount?: number; - amount_percent?: number; - destination: string; + amount?: number + amount_percent?: number + destination: string } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - }; - }; - }; - }; + Partial<''>) & { [key: string]: unknown } + } + } + } + } /**

Accepts the specified quote.

*/ PostQuotesQuoteAccept: { parameters: { path: { - quote: string; - }; - }; + quote: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["quote"]; - }; - }; + 'application/json': components['schemas']['quote'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Cancels the quote.

*/ PostQuotesQuoteCancel: { parameters: { path: { - quote: string; - }; - }; + quote: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["quote"]; - }; - }; + 'application/json': components['schemas']['quote'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

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.

*/ GetQuotesQuoteComputedUpfrontLineItems: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - quote: string; - }; - }; + quote: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["item"][]; + data: components['schemas']['item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Finalizes the quote.

*/ PostQuotesQuoteFinalize: { parameters: { path: { - quote: string; - }; - }; + quote: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["quote"]; - }; - }; + 'application/json': components['schemas']['quote'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * Format: unix-time * @description A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. */ - expires_at?: number; - }; - }; - }; - }; + expires_at?: number + } + } + } + } /**

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.

*/ GetQuotesQuoteLineItems: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - quote: string; - }; - }; + quote: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["item"][]; + data: components['schemas']['item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Download the PDF for a finalized quote

*/ GetQuotesQuotePdf: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - quote: string; - }; - }; + quote: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/pdf": string; - }; - }; + 'application/pdf': string + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of early fraud warnings.

*/ GetRadarEarlyFraudWarnings: { parameters: { query: { /** Only return early fraud warnings for the charge specified by this charge ID. */ - charge?: string; + charge?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return early fraud warnings for charges that were created by the PaymentIntent specified by this PaymentIntent ID. */ - payment_intent?: string; + payment_intent?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["radar.early_fraud_warning"][]; + 'application/json': { + data: components['schemas']['radar.early_fraud_warning'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Retrieves the details of an early fraud warning that has previously been created.

* @@ -38027,431 +37450,423 @@ export interface operations { GetRadarEarlyFraudWarningsEarlyFraudWarning: { parameters: { path: { - early_fraud_warning: string; - }; + early_fraud_warning: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["radar.early_fraud_warning"]; - }; - }; + 'application/json': components['schemas']['radar.early_fraud_warning'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ GetRadarValueListItems: { parameters: { query: { created?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Return items belonging to the parent list whose value matches the specified value (using an "is like" match). */ - value?: string; + value?: string /** Identifier for the parent value list this item belongs to. */ - value_list: string; - }; - }; + value_list: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["radar.value_list_item"][]; + 'application/json': { + data: components['schemas']['radar.value_list_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostRadarValueListItems: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["radar.value_list_item"]; - }; - }; + 'application/json': components['schemas']['radar.value_list_item'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The value of the item (whose type must match the type of the parent value list). */ - value: string; + value: string /** @description The identifier of the value list which the created item will be added to. */ - value_list: string; - }; - }; - }; - }; + value_list: string + } + } + } + } /**

Retrieves a ValueListItem object.

*/ GetRadarValueListItemsItem: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - item: string; - }; - }; + item: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["radar.value_list_item"]; - }; - }; + 'application/json': components['schemas']['radar.value_list_item'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ DeleteRadarValueListItemsItem: { parameters: { path: { - item: string; - }; - }; + item: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_radar.value_list_item"]; - }; - }; + 'application/json': components['schemas']['deleted_radar.value_list_item'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ GetRadarValueLists: { parameters: { query: { /** The alias used to reference the value list when writing rules. */ - alias?: string; + alias?: string /** A value contained within a value list - returns all value lists containing this value. */ - contains?: string; + contains?: string created?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["radar.value_list"][]; + 'application/json': { + data: components['schemas']['radar.value_list'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostRadarValueLists: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["radar.value_list"]; - }; - }; + 'application/json': components['schemas']['radar.value_list'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The name of the value list for use in rules. */ - alias: string; + alias: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * @description Type of the items in the value list. One of `card_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, `case_sensitive_string`, or `customer_id`. Use `string` if the item type is unknown or mixed. * @enum {string} */ - item_type?: - | "card_bin" - | "card_fingerprint" - | "case_sensitive_string" - | "country" - | "customer_id" - | "email" - | "ip_address" - | "string"; + item_type?: 'card_bin' | 'card_fingerprint' | 'case_sensitive_string' | 'country' | 'customer_id' | 'email' | 'ip_address' | 'string' /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The human-readable name of the value list. */ - name: string; - }; - }; - }; - }; + name: string + } + } + } + } /**

Retrieves a ValueList object.

*/ GetRadarValueListsValueList: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - value_list: string; - }; - }; + value_list: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["radar.value_list"]; - }; - }; + 'application/json': components['schemas']['radar.value_list'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostRadarValueListsValueList: { parameters: { path: { - value_list: string; - }; - }; + value_list: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["radar.value_list"]; - }; - }; + 'application/json': components['schemas']['radar.value_list'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The name of the value list for use in rules. */ - alias?: string; + alias?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The human-readable name of the value list. */ - name?: string; - }; - }; - }; - }; + name?: string + } + } + } + } /**

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.

*/ DeleteRadarValueListsValueList: { parameters: { path: { - value_list: string; - }; - }; + value_list: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_radar.value_list"]; - }; - }; + 'application/json': components['schemas']['deleted_radar.value_list'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ GetRecipients: { parameters: { query: { created?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - type?: "corporation" | "individual"; + starting_after?: string + type?: 'corporation' | 'individual' /** Only return recipients that are verified or unverified. */ - verified?: boolean; - }; - }; + verified?: boolean + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["recipient"][]; + 'application/json': { + data: components['schemas']['recipient'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Creates a new Recipient object and verifies the recipient’s identity. * Also verifies the recipient’s bank account information or debit card, if either is provided.

@@ -38461,73 +37876,74 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["recipient"]; - }; - }; + 'application/json': components['schemas']['recipient'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A bank account to attach to the recipient. You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details, with the options described below. */ - bank_account?: string; + bank_account?: string /** @description A U.S. Visa or MasterCard debit card (_not_ prepaid) to attach to the recipient. If the debit card is not valid, recipient creation will fail. You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's debit card details, with the options described below. Although not all information is required, the extra info helps prevent fraud. */ - card?: string; + card?: string /** @description An arbitrary string which you can attach to a `Recipient` object. It is displayed alongside the recipient in the web interface. */ - description?: string; + description?: string /** @description The recipient's email address. It is displayed alongside the recipient in the web interface, and can be useful for searching and tracking. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description The recipient's full, legal name. For type `individual`, should be in the format `First Last`, `First Middle Last`, or `First M Last` (no prefixes or suffixes). For `corporation`, the full, incorporated name. */ - name: string; + name: string /** @description The recipient's tax ID, as a string. For type `individual`, the full SSN; for type `corporation`, the full EIN. */ - tax_id?: string; + tax_id?: string /** @description Type of the recipient: either `individual` or `corporation`. */ - type: string; - }; - }; - }; - }; + type: string + } + } + } + } /**

Retrieves the details of an existing recipient. You need only supply the unique recipient identifier that was returned upon recipient creation.

*/ GetRecipientsId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": (Partial & - Partial) & { [key: string]: unknown }; - }; - }; + 'application/json': (Partial & Partial) & { + [key: string]: unknown + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

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

@@ -38538,198 +37954,198 @@ export interface operations { PostRecipientsId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["recipient"]; - }; - }; + 'application/json': components['schemas']['recipient'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A bank account to attach to the recipient. You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details, with the options described below. */ - bank_account?: string; + bank_account?: string /** @description A U.S. Visa or MasterCard debit card (not prepaid) to attach to the recipient. You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's debit card details, with the options described below. Passing `card` will create a new card, make it the new recipient default card, and delete the old recipient default (if one exists). If you want to add additional debit cards instead of replacing the existing default, use the [card creation API](https://stripe.com/docs/api#create_card). Whenever you attach a card to a recipient, Stripe will automatically validate the debit card. */ - card?: string; + card?: string /** @description ID of the card to set as the recipient's new default for payouts. */ - default_card?: string; + default_card?: string /** @description An arbitrary string which you can attach to a `Recipient` object. It is displayed alongside the recipient in the web interface. */ - description?: string; + description?: string /** @description The recipient's email address. It is displayed alongside the recipient in the web interface, and can be useful for searching and tracking. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description The recipient's full, legal name. For type `individual`, should be in the format `First Last`, `First Middle Last`, or `First M Last` (no prefixes or suffixes). For `corporation`, the full, incorporated name. */ - name?: string; + name?: string /** @description The recipient's tax ID, as a string. For type `individual`, the full SSN; for type `corporation`, the full EIN. */ - tax_id?: string; - }; - }; - }; - }; + tax_id?: string + } + } + } + } /**

Permanently deletes a recipient. It cannot be undone.

*/ DeleteRecipientsId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_recipient"]; - }; - }; + 'application/json': components['schemas']['deleted_recipient'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of all refunds you’ve previously created. The refunds are returned in sorted order, with the most recent refunds appearing first. For convenience, the 10 most recent refunds are always available by default on the charge object.

*/ GetRefunds: { parameters: { query: { /** Only return refunds for the charge specified by this charge ID. */ - charge?: string; + charge?: string created?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return refunds for the PaymentIntent specified by this ID. */ - payment_intent?: string; + payment_intent?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["refund"][]; + 'application/json': { + data: components['schemas']['refund'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Create a refund.

*/ PostRefunds: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["refund"]; - }; - }; + 'application/json': components['schemas']['refund'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { - amount?: number; - charge?: string; + 'application/x-www-form-urlencoded': { + amount?: number + charge?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; - payment_intent?: string; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } + payment_intent?: string /** @enum {string} */ - reason?: "duplicate" | "fraudulent" | "requested_by_customer"; - refund_application_fee?: boolean; - reverse_transfer?: boolean; - }; - }; - }; - }; + reason?: 'duplicate' | 'fraudulent' | 'requested_by_customer' + refund_application_fee?: boolean + reverse_transfer?: boolean + } + } + } + } /**

Retrieves the details of an existing refund.

*/ GetRefundsRefund: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - refund: string; - }; - }; + refund: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["refund"]; - }; - }; + 'application/json': components['schemas']['refund'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

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

* @@ -38738,977 +38154,977 @@ export interface operations { PostRefundsRefund: { parameters: { path: { - refund: string; - }; - }; + refund: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["refund"]; - }; - }; + 'application/json': components['schemas']['refund'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; - }; - }; - }; - }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } + } + } + } + } /**

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

*/ GetReportingReportRuns: { parameters: { query: { created?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["reporting.report_run"][]; + 'application/json': { + data: components['schemas']['reporting.report_run'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostReportingReportRuns: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["reporting.report_run"]; - }; - }; + 'application/json': components['schemas']['reporting.report_run'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * run_parameter_specs * @description Parameters specifying how the report should be run. Different Report Types have different required and optional parameters, listed in the [API Access to Reports](https://stripe.com/docs/reporting/statements/api) documentation. */ parameters?: { - columns?: string[]; - connected_account?: string; - currency?: string; + columns?: string[] + connected_account?: string + currency?: string /** Format: unix-time */ - interval_end?: number; + interval_end?: number /** Format: unix-time */ - interval_start?: number; - payout?: string; + interval_start?: number + payout?: string /** @enum {string} */ reporting_category?: - | "advance" - | "advance_funding" - | "anticipation_repayment" - | "charge" - | "charge_failure" - | "connect_collection_transfer" - | "connect_reserved_funds" - | "contribution" - | "dispute" - | "dispute_reversal" - | "fee" - | "financing_paydown" - | "financing_paydown_reversal" - | "financing_payout" - | "financing_payout_reversal" - | "issuing_authorization_hold" - | "issuing_authorization_release" - | "issuing_dispute" - | "issuing_transaction" - | "network_cost" - | "other_adjustment" - | "partial_capture_reversal" - | "payout" - | "payout_reversal" - | "platform_earning" - | "platform_earning_refund" - | "refund" - | "refund_failure" - | "risk_reserved_funds" - | "tax" - | "topup" - | "topup_reversal" - | "transfer" - | "transfer_reversal"; + | 'advance' + | 'advance_funding' + | 'anticipation_repayment' + | 'charge' + | 'charge_failure' + | 'connect_collection_transfer' + | 'connect_reserved_funds' + | 'contribution' + | 'dispute' + | 'dispute_reversal' + | 'fee' + | 'financing_paydown' + | 'financing_paydown_reversal' + | 'financing_payout' + | 'financing_payout_reversal' + | 'issuing_authorization_hold' + | 'issuing_authorization_release' + | 'issuing_dispute' + | 'issuing_transaction' + | 'network_cost' + | 'other_adjustment' + | 'partial_capture_reversal' + | 'payout' + | 'payout_reversal' + | 'platform_earning' + | 'platform_earning_refund' + | 'refund' + | 'refund_failure' + | 'risk_reserved_funds' + | 'tax' + | 'topup' + | 'topup_reversal' + | 'transfer' + | 'transfer_reversal' /** @enum {string} */ timezone?: - | "Africa/Abidjan" - | "Africa/Accra" - | "Africa/Addis_Ababa" - | "Africa/Algiers" - | "Africa/Asmara" - | "Africa/Asmera" - | "Africa/Bamako" - | "Africa/Bangui" - | "Africa/Banjul" - | "Africa/Bissau" - | "Africa/Blantyre" - | "Africa/Brazzaville" - | "Africa/Bujumbura" - | "Africa/Cairo" - | "Africa/Casablanca" - | "Africa/Ceuta" - | "Africa/Conakry" - | "Africa/Dakar" - | "Africa/Dar_es_Salaam" - | "Africa/Djibouti" - | "Africa/Douala" - | "Africa/El_Aaiun" - | "Africa/Freetown" - | "Africa/Gaborone" - | "Africa/Harare" - | "Africa/Johannesburg" - | "Africa/Juba" - | "Africa/Kampala" - | "Africa/Khartoum" - | "Africa/Kigali" - | "Africa/Kinshasa" - | "Africa/Lagos" - | "Africa/Libreville" - | "Africa/Lome" - | "Africa/Luanda" - | "Africa/Lubumbashi" - | "Africa/Lusaka" - | "Africa/Malabo" - | "Africa/Maputo" - | "Africa/Maseru" - | "Africa/Mbabane" - | "Africa/Mogadishu" - | "Africa/Monrovia" - | "Africa/Nairobi" - | "Africa/Ndjamena" - | "Africa/Niamey" - | "Africa/Nouakchott" - | "Africa/Ouagadougou" - | "Africa/Porto-Novo" - | "Africa/Sao_Tome" - | "Africa/Timbuktu" - | "Africa/Tripoli" - | "Africa/Tunis" - | "Africa/Windhoek" - | "America/Adak" - | "America/Anchorage" - | "America/Anguilla" - | "America/Antigua" - | "America/Araguaina" - | "America/Argentina/Buenos_Aires" - | "America/Argentina/Catamarca" - | "America/Argentina/ComodRivadavia" - | "America/Argentina/Cordoba" - | "America/Argentina/Jujuy" - | "America/Argentina/La_Rioja" - | "America/Argentina/Mendoza" - | "America/Argentina/Rio_Gallegos" - | "America/Argentina/Salta" - | "America/Argentina/San_Juan" - | "America/Argentina/San_Luis" - | "America/Argentina/Tucuman" - | "America/Argentina/Ushuaia" - | "America/Aruba" - | "America/Asuncion" - | "America/Atikokan" - | "America/Atka" - | "America/Bahia" - | "America/Bahia_Banderas" - | "America/Barbados" - | "America/Belem" - | "America/Belize" - | "America/Blanc-Sablon" - | "America/Boa_Vista" - | "America/Bogota" - | "America/Boise" - | "America/Buenos_Aires" - | "America/Cambridge_Bay" - | "America/Campo_Grande" - | "America/Cancun" - | "America/Caracas" - | "America/Catamarca" - | "America/Cayenne" - | "America/Cayman" - | "America/Chicago" - | "America/Chihuahua" - | "America/Coral_Harbour" - | "America/Cordoba" - | "America/Costa_Rica" - | "America/Creston" - | "America/Cuiaba" - | "America/Curacao" - | "America/Danmarkshavn" - | "America/Dawson" - | "America/Dawson_Creek" - | "America/Denver" - | "America/Detroit" - | "America/Dominica" - | "America/Edmonton" - | "America/Eirunepe" - | "America/El_Salvador" - | "America/Ensenada" - | "America/Fort_Nelson" - | "America/Fort_Wayne" - | "America/Fortaleza" - | "America/Glace_Bay" - | "America/Godthab" - | "America/Goose_Bay" - | "America/Grand_Turk" - | "America/Grenada" - | "America/Guadeloupe" - | "America/Guatemala" - | "America/Guayaquil" - | "America/Guyana" - | "America/Halifax" - | "America/Havana" - | "America/Hermosillo" - | "America/Indiana/Indianapolis" - | "America/Indiana/Knox" - | "America/Indiana/Marengo" - | "America/Indiana/Petersburg" - | "America/Indiana/Tell_City" - | "America/Indiana/Vevay" - | "America/Indiana/Vincennes" - | "America/Indiana/Winamac" - | "America/Indianapolis" - | "America/Inuvik" - | "America/Iqaluit" - | "America/Jamaica" - | "America/Jujuy" - | "America/Juneau" - | "America/Kentucky/Louisville" - | "America/Kentucky/Monticello" - | "America/Knox_IN" - | "America/Kralendijk" - | "America/La_Paz" - | "America/Lima" - | "America/Los_Angeles" - | "America/Louisville" - | "America/Lower_Princes" - | "America/Maceio" - | "America/Managua" - | "America/Manaus" - | "America/Marigot" - | "America/Martinique" - | "America/Matamoros" - | "America/Mazatlan" - | "America/Mendoza" - | "America/Menominee" - | "America/Merida" - | "America/Metlakatla" - | "America/Mexico_City" - | "America/Miquelon" - | "America/Moncton" - | "America/Monterrey" - | "America/Montevideo" - | "America/Montreal" - | "America/Montserrat" - | "America/Nassau" - | "America/New_York" - | "America/Nipigon" - | "America/Nome" - | "America/Noronha" - | "America/North_Dakota/Beulah" - | "America/North_Dakota/Center" - | "America/North_Dakota/New_Salem" - | "America/Ojinaga" - | "America/Panama" - | "America/Pangnirtung" - | "America/Paramaribo" - | "America/Phoenix" - | "America/Port-au-Prince" - | "America/Port_of_Spain" - | "America/Porto_Acre" - | "America/Porto_Velho" - | "America/Puerto_Rico" - | "America/Punta_Arenas" - | "America/Rainy_River" - | "America/Rankin_Inlet" - | "America/Recife" - | "America/Regina" - | "America/Resolute" - | "America/Rio_Branco" - | "America/Rosario" - | "America/Santa_Isabel" - | "America/Santarem" - | "America/Santiago" - | "America/Santo_Domingo" - | "America/Sao_Paulo" - | "America/Scoresbysund" - | "America/Shiprock" - | "America/Sitka" - | "America/St_Barthelemy" - | "America/St_Johns" - | "America/St_Kitts" - | "America/St_Lucia" - | "America/St_Thomas" - | "America/St_Vincent" - | "America/Swift_Current" - | "America/Tegucigalpa" - | "America/Thule" - | "America/Thunder_Bay" - | "America/Tijuana" - | "America/Toronto" - | "America/Tortola" - | "America/Vancouver" - | "America/Virgin" - | "America/Whitehorse" - | "America/Winnipeg" - | "America/Yakutat" - | "America/Yellowknife" - | "Antarctica/Casey" - | "Antarctica/Davis" - | "Antarctica/DumontDUrville" - | "Antarctica/Macquarie" - | "Antarctica/Mawson" - | "Antarctica/McMurdo" - | "Antarctica/Palmer" - | "Antarctica/Rothera" - | "Antarctica/South_Pole" - | "Antarctica/Syowa" - | "Antarctica/Troll" - | "Antarctica/Vostok" - | "Arctic/Longyearbyen" - | "Asia/Aden" - | "Asia/Almaty" - | "Asia/Amman" - | "Asia/Anadyr" - | "Asia/Aqtau" - | "Asia/Aqtobe" - | "Asia/Ashgabat" - | "Asia/Ashkhabad" - | "Asia/Atyrau" - | "Asia/Baghdad" - | "Asia/Bahrain" - | "Asia/Baku" - | "Asia/Bangkok" - | "Asia/Barnaul" - | "Asia/Beirut" - | "Asia/Bishkek" - | "Asia/Brunei" - | "Asia/Calcutta" - | "Asia/Chita" - | "Asia/Choibalsan" - | "Asia/Chongqing" - | "Asia/Chungking" - | "Asia/Colombo" - | "Asia/Dacca" - | "Asia/Damascus" - | "Asia/Dhaka" - | "Asia/Dili" - | "Asia/Dubai" - | "Asia/Dushanbe" - | "Asia/Famagusta" - | "Asia/Gaza" - | "Asia/Harbin" - | "Asia/Hebron" - | "Asia/Ho_Chi_Minh" - | "Asia/Hong_Kong" - | "Asia/Hovd" - | "Asia/Irkutsk" - | "Asia/Istanbul" - | "Asia/Jakarta" - | "Asia/Jayapura" - | "Asia/Jerusalem" - | "Asia/Kabul" - | "Asia/Kamchatka" - | "Asia/Karachi" - | "Asia/Kashgar" - | "Asia/Kathmandu" - | "Asia/Katmandu" - | "Asia/Khandyga" - | "Asia/Kolkata" - | "Asia/Krasnoyarsk" - | "Asia/Kuala_Lumpur" - | "Asia/Kuching" - | "Asia/Kuwait" - | "Asia/Macao" - | "Asia/Macau" - | "Asia/Magadan" - | "Asia/Makassar" - | "Asia/Manila" - | "Asia/Muscat" - | "Asia/Nicosia" - | "Asia/Novokuznetsk" - | "Asia/Novosibirsk" - | "Asia/Omsk" - | "Asia/Oral" - | "Asia/Phnom_Penh" - | "Asia/Pontianak" - | "Asia/Pyongyang" - | "Asia/Qatar" - | "Asia/Qostanay" - | "Asia/Qyzylorda" - | "Asia/Rangoon" - | "Asia/Riyadh" - | "Asia/Saigon" - | "Asia/Sakhalin" - | "Asia/Samarkand" - | "Asia/Seoul" - | "Asia/Shanghai" - | "Asia/Singapore" - | "Asia/Srednekolymsk" - | "Asia/Taipei" - | "Asia/Tashkent" - | "Asia/Tbilisi" - | "Asia/Tehran" - | "Asia/Tel_Aviv" - | "Asia/Thimbu" - | "Asia/Thimphu" - | "Asia/Tokyo" - | "Asia/Tomsk" - | "Asia/Ujung_Pandang" - | "Asia/Ulaanbaatar" - | "Asia/Ulan_Bator" - | "Asia/Urumqi" - | "Asia/Ust-Nera" - | "Asia/Vientiane" - | "Asia/Vladivostok" - | "Asia/Yakutsk" - | "Asia/Yangon" - | "Asia/Yekaterinburg" - | "Asia/Yerevan" - | "Atlantic/Azores" - | "Atlantic/Bermuda" - | "Atlantic/Canary" - | "Atlantic/Cape_Verde" - | "Atlantic/Faeroe" - | "Atlantic/Faroe" - | "Atlantic/Jan_Mayen" - | "Atlantic/Madeira" - | "Atlantic/Reykjavik" - | "Atlantic/South_Georgia" - | "Atlantic/St_Helena" - | "Atlantic/Stanley" - | "Australia/ACT" - | "Australia/Adelaide" - | "Australia/Brisbane" - | "Australia/Broken_Hill" - | "Australia/Canberra" - | "Australia/Currie" - | "Australia/Darwin" - | "Australia/Eucla" - | "Australia/Hobart" - | "Australia/LHI" - | "Australia/Lindeman" - | "Australia/Lord_Howe" - | "Australia/Melbourne" - | "Australia/NSW" - | "Australia/North" - | "Australia/Perth" - | "Australia/Queensland" - | "Australia/South" - | "Australia/Sydney" - | "Australia/Tasmania" - | "Australia/Victoria" - | "Australia/West" - | "Australia/Yancowinna" - | "Brazil/Acre" - | "Brazil/DeNoronha" - | "Brazil/East" - | "Brazil/West" - | "CET" - | "CST6CDT" - | "Canada/Atlantic" - | "Canada/Central" - | "Canada/Eastern" - | "Canada/Mountain" - | "Canada/Newfoundland" - | "Canada/Pacific" - | "Canada/Saskatchewan" - | "Canada/Yukon" - | "Chile/Continental" - | "Chile/EasterIsland" - | "Cuba" - | "EET" - | "EST" - | "EST5EDT" - | "Egypt" - | "Eire" - | "Etc/GMT" - | "Etc/GMT+0" - | "Etc/GMT+1" - | "Etc/GMT+10" - | "Etc/GMT+11" - | "Etc/GMT+12" - | "Etc/GMT+2" - | "Etc/GMT+3" - | "Etc/GMT+4" - | "Etc/GMT+5" - | "Etc/GMT+6" - | "Etc/GMT+7" - | "Etc/GMT+8" - | "Etc/GMT+9" - | "Etc/GMT-0" - | "Etc/GMT-1" - | "Etc/GMT-10" - | "Etc/GMT-11" - | "Etc/GMT-12" - | "Etc/GMT-13" - | "Etc/GMT-14" - | "Etc/GMT-2" - | "Etc/GMT-3" - | "Etc/GMT-4" - | "Etc/GMT-5" - | "Etc/GMT-6" - | "Etc/GMT-7" - | "Etc/GMT-8" - | "Etc/GMT-9" - | "Etc/GMT0" - | "Etc/Greenwich" - | "Etc/UCT" - | "Etc/UTC" - | "Etc/Universal" - | "Etc/Zulu" - | "Europe/Amsterdam" - | "Europe/Andorra" - | "Europe/Astrakhan" - | "Europe/Athens" - | "Europe/Belfast" - | "Europe/Belgrade" - | "Europe/Berlin" - | "Europe/Bratislava" - | "Europe/Brussels" - | "Europe/Bucharest" - | "Europe/Budapest" - | "Europe/Busingen" - | "Europe/Chisinau" - | "Europe/Copenhagen" - | "Europe/Dublin" - | "Europe/Gibraltar" - | "Europe/Guernsey" - | "Europe/Helsinki" - | "Europe/Isle_of_Man" - | "Europe/Istanbul" - | "Europe/Jersey" - | "Europe/Kaliningrad" - | "Europe/Kiev" - | "Europe/Kirov" - | "Europe/Lisbon" - | "Europe/Ljubljana" - | "Europe/London" - | "Europe/Luxembourg" - | "Europe/Madrid" - | "Europe/Malta" - | "Europe/Mariehamn" - | "Europe/Minsk" - | "Europe/Monaco" - | "Europe/Moscow" - | "Europe/Nicosia" - | "Europe/Oslo" - | "Europe/Paris" - | "Europe/Podgorica" - | "Europe/Prague" - | "Europe/Riga" - | "Europe/Rome" - | "Europe/Samara" - | "Europe/San_Marino" - | "Europe/Sarajevo" - | "Europe/Saratov" - | "Europe/Simferopol" - | "Europe/Skopje" - | "Europe/Sofia" - | "Europe/Stockholm" - | "Europe/Tallinn" - | "Europe/Tirane" - | "Europe/Tiraspol" - | "Europe/Ulyanovsk" - | "Europe/Uzhgorod" - | "Europe/Vaduz" - | "Europe/Vatican" - | "Europe/Vienna" - | "Europe/Vilnius" - | "Europe/Volgograd" - | "Europe/Warsaw" - | "Europe/Zagreb" - | "Europe/Zaporozhye" - | "Europe/Zurich" - | "Factory" - | "GB" - | "GB-Eire" - | "GMT" - | "GMT+0" - | "GMT-0" - | "GMT0" - | "Greenwich" - | "HST" - | "Hongkong" - | "Iceland" - | "Indian/Antananarivo" - | "Indian/Chagos" - | "Indian/Christmas" - | "Indian/Cocos" - | "Indian/Comoro" - | "Indian/Kerguelen" - | "Indian/Mahe" - | "Indian/Maldives" - | "Indian/Mauritius" - | "Indian/Mayotte" - | "Indian/Reunion" - | "Iran" - | "Israel" - | "Jamaica" - | "Japan" - | "Kwajalein" - | "Libya" - | "MET" - | "MST" - | "MST7MDT" - | "Mexico/BajaNorte" - | "Mexico/BajaSur" - | "Mexico/General" - | "NZ" - | "NZ-CHAT" - | "Navajo" - | "PRC" - | "PST8PDT" - | "Pacific/Apia" - | "Pacific/Auckland" - | "Pacific/Bougainville" - | "Pacific/Chatham" - | "Pacific/Chuuk" - | "Pacific/Easter" - | "Pacific/Efate" - | "Pacific/Enderbury" - | "Pacific/Fakaofo" - | "Pacific/Fiji" - | "Pacific/Funafuti" - | "Pacific/Galapagos" - | "Pacific/Gambier" - | "Pacific/Guadalcanal" - | "Pacific/Guam" - | "Pacific/Honolulu" - | "Pacific/Johnston" - | "Pacific/Kiritimati" - | "Pacific/Kosrae" - | "Pacific/Kwajalein" - | "Pacific/Majuro" - | "Pacific/Marquesas" - | "Pacific/Midway" - | "Pacific/Nauru" - | "Pacific/Niue" - | "Pacific/Norfolk" - | "Pacific/Noumea" - | "Pacific/Pago_Pago" - | "Pacific/Palau" - | "Pacific/Pitcairn" - | "Pacific/Pohnpei" - | "Pacific/Ponape" - | "Pacific/Port_Moresby" - | "Pacific/Rarotonga" - | "Pacific/Saipan" - | "Pacific/Samoa" - | "Pacific/Tahiti" - | "Pacific/Tarawa" - | "Pacific/Tongatapu" - | "Pacific/Truk" - | "Pacific/Wake" - | "Pacific/Wallis" - | "Pacific/Yap" - | "Poland" - | "Portugal" - | "ROC" - | "ROK" - | "Singapore" - | "Turkey" - | "UCT" - | "US/Alaska" - | "US/Aleutian" - | "US/Arizona" - | "US/Central" - | "US/East-Indiana" - | "US/Eastern" - | "US/Hawaii" - | "US/Indiana-Starke" - | "US/Michigan" - | "US/Mountain" - | "US/Pacific" - | "US/Pacific-New" - | "US/Samoa" - | "UTC" - | "Universal" - | "W-SU" - | "WET" - | "Zulu"; - } & { [key: string]: unknown }; + | 'Africa/Abidjan' + | 'Africa/Accra' + | 'Africa/Addis_Ababa' + | 'Africa/Algiers' + | 'Africa/Asmara' + | 'Africa/Asmera' + | 'Africa/Bamako' + | 'Africa/Bangui' + | 'Africa/Banjul' + | 'Africa/Bissau' + | 'Africa/Blantyre' + | 'Africa/Brazzaville' + | 'Africa/Bujumbura' + | 'Africa/Cairo' + | 'Africa/Casablanca' + | 'Africa/Ceuta' + | 'Africa/Conakry' + | 'Africa/Dakar' + | 'Africa/Dar_es_Salaam' + | 'Africa/Djibouti' + | 'Africa/Douala' + | 'Africa/El_Aaiun' + | 'Africa/Freetown' + | 'Africa/Gaborone' + | 'Africa/Harare' + | 'Africa/Johannesburg' + | 'Africa/Juba' + | 'Africa/Kampala' + | 'Africa/Khartoum' + | 'Africa/Kigali' + | 'Africa/Kinshasa' + | 'Africa/Lagos' + | 'Africa/Libreville' + | 'Africa/Lome' + | 'Africa/Luanda' + | 'Africa/Lubumbashi' + | 'Africa/Lusaka' + | 'Africa/Malabo' + | 'Africa/Maputo' + | 'Africa/Maseru' + | 'Africa/Mbabane' + | 'Africa/Mogadishu' + | 'Africa/Monrovia' + | 'Africa/Nairobi' + | 'Africa/Ndjamena' + | 'Africa/Niamey' + | 'Africa/Nouakchott' + | 'Africa/Ouagadougou' + | 'Africa/Porto-Novo' + | 'Africa/Sao_Tome' + | 'Africa/Timbuktu' + | 'Africa/Tripoli' + | 'Africa/Tunis' + | 'Africa/Windhoek' + | 'America/Adak' + | 'America/Anchorage' + | 'America/Anguilla' + | 'America/Antigua' + | 'America/Araguaina' + | 'America/Argentina/Buenos_Aires' + | 'America/Argentina/Catamarca' + | 'America/Argentina/ComodRivadavia' + | 'America/Argentina/Cordoba' + | 'America/Argentina/Jujuy' + | 'America/Argentina/La_Rioja' + | 'America/Argentina/Mendoza' + | 'America/Argentina/Rio_Gallegos' + | 'America/Argentina/Salta' + | 'America/Argentina/San_Juan' + | 'America/Argentina/San_Luis' + | 'America/Argentina/Tucuman' + | 'America/Argentina/Ushuaia' + | 'America/Aruba' + | 'America/Asuncion' + | 'America/Atikokan' + | 'America/Atka' + | 'America/Bahia' + | 'America/Bahia_Banderas' + | 'America/Barbados' + | 'America/Belem' + | 'America/Belize' + | 'America/Blanc-Sablon' + | 'America/Boa_Vista' + | 'America/Bogota' + | 'America/Boise' + | 'America/Buenos_Aires' + | 'America/Cambridge_Bay' + | 'America/Campo_Grande' + | 'America/Cancun' + | 'America/Caracas' + | 'America/Catamarca' + | 'America/Cayenne' + | 'America/Cayman' + | 'America/Chicago' + | 'America/Chihuahua' + | 'America/Coral_Harbour' + | 'America/Cordoba' + | 'America/Costa_Rica' + | 'America/Creston' + | 'America/Cuiaba' + | 'America/Curacao' + | 'America/Danmarkshavn' + | 'America/Dawson' + | 'America/Dawson_Creek' + | 'America/Denver' + | 'America/Detroit' + | 'America/Dominica' + | 'America/Edmonton' + | 'America/Eirunepe' + | 'America/El_Salvador' + | 'America/Ensenada' + | 'America/Fort_Nelson' + | 'America/Fort_Wayne' + | 'America/Fortaleza' + | 'America/Glace_Bay' + | 'America/Godthab' + | 'America/Goose_Bay' + | 'America/Grand_Turk' + | 'America/Grenada' + | 'America/Guadeloupe' + | 'America/Guatemala' + | 'America/Guayaquil' + | 'America/Guyana' + | 'America/Halifax' + | 'America/Havana' + | 'America/Hermosillo' + | 'America/Indiana/Indianapolis' + | 'America/Indiana/Knox' + | 'America/Indiana/Marengo' + | 'America/Indiana/Petersburg' + | 'America/Indiana/Tell_City' + | 'America/Indiana/Vevay' + | 'America/Indiana/Vincennes' + | 'America/Indiana/Winamac' + | 'America/Indianapolis' + | 'America/Inuvik' + | 'America/Iqaluit' + | 'America/Jamaica' + | 'America/Jujuy' + | 'America/Juneau' + | 'America/Kentucky/Louisville' + | 'America/Kentucky/Monticello' + | 'America/Knox_IN' + | 'America/Kralendijk' + | 'America/La_Paz' + | 'America/Lima' + | 'America/Los_Angeles' + | 'America/Louisville' + | 'America/Lower_Princes' + | 'America/Maceio' + | 'America/Managua' + | 'America/Manaus' + | 'America/Marigot' + | 'America/Martinique' + | 'America/Matamoros' + | 'America/Mazatlan' + | 'America/Mendoza' + | 'America/Menominee' + | 'America/Merida' + | 'America/Metlakatla' + | 'America/Mexico_City' + | 'America/Miquelon' + | 'America/Moncton' + | 'America/Monterrey' + | 'America/Montevideo' + | 'America/Montreal' + | 'America/Montserrat' + | 'America/Nassau' + | 'America/New_York' + | 'America/Nipigon' + | 'America/Nome' + | 'America/Noronha' + | 'America/North_Dakota/Beulah' + | 'America/North_Dakota/Center' + | 'America/North_Dakota/New_Salem' + | 'America/Ojinaga' + | 'America/Panama' + | 'America/Pangnirtung' + | 'America/Paramaribo' + | 'America/Phoenix' + | 'America/Port-au-Prince' + | 'America/Port_of_Spain' + | 'America/Porto_Acre' + | 'America/Porto_Velho' + | 'America/Puerto_Rico' + | 'America/Punta_Arenas' + | 'America/Rainy_River' + | 'America/Rankin_Inlet' + | 'America/Recife' + | 'America/Regina' + | 'America/Resolute' + | 'America/Rio_Branco' + | 'America/Rosario' + | 'America/Santa_Isabel' + | 'America/Santarem' + | 'America/Santiago' + | 'America/Santo_Domingo' + | 'America/Sao_Paulo' + | 'America/Scoresbysund' + | 'America/Shiprock' + | 'America/Sitka' + | 'America/St_Barthelemy' + | 'America/St_Johns' + | 'America/St_Kitts' + | 'America/St_Lucia' + | 'America/St_Thomas' + | 'America/St_Vincent' + | 'America/Swift_Current' + | 'America/Tegucigalpa' + | 'America/Thule' + | 'America/Thunder_Bay' + | 'America/Tijuana' + | 'America/Toronto' + | 'America/Tortola' + | 'America/Vancouver' + | 'America/Virgin' + | 'America/Whitehorse' + | 'America/Winnipeg' + | 'America/Yakutat' + | 'America/Yellowknife' + | 'Antarctica/Casey' + | 'Antarctica/Davis' + | 'Antarctica/DumontDUrville' + | 'Antarctica/Macquarie' + | 'Antarctica/Mawson' + | 'Antarctica/McMurdo' + | 'Antarctica/Palmer' + | 'Antarctica/Rothera' + | 'Antarctica/South_Pole' + | 'Antarctica/Syowa' + | 'Antarctica/Troll' + | 'Antarctica/Vostok' + | 'Arctic/Longyearbyen' + | 'Asia/Aden' + | 'Asia/Almaty' + | 'Asia/Amman' + | 'Asia/Anadyr' + | 'Asia/Aqtau' + | 'Asia/Aqtobe' + | 'Asia/Ashgabat' + | 'Asia/Ashkhabad' + | 'Asia/Atyrau' + | 'Asia/Baghdad' + | 'Asia/Bahrain' + | 'Asia/Baku' + | 'Asia/Bangkok' + | 'Asia/Barnaul' + | 'Asia/Beirut' + | 'Asia/Bishkek' + | 'Asia/Brunei' + | 'Asia/Calcutta' + | 'Asia/Chita' + | 'Asia/Choibalsan' + | 'Asia/Chongqing' + | 'Asia/Chungking' + | 'Asia/Colombo' + | 'Asia/Dacca' + | 'Asia/Damascus' + | 'Asia/Dhaka' + | 'Asia/Dili' + | 'Asia/Dubai' + | 'Asia/Dushanbe' + | 'Asia/Famagusta' + | 'Asia/Gaza' + | 'Asia/Harbin' + | 'Asia/Hebron' + | 'Asia/Ho_Chi_Minh' + | 'Asia/Hong_Kong' + | 'Asia/Hovd' + | 'Asia/Irkutsk' + | 'Asia/Istanbul' + | 'Asia/Jakarta' + | 'Asia/Jayapura' + | 'Asia/Jerusalem' + | 'Asia/Kabul' + | 'Asia/Kamchatka' + | 'Asia/Karachi' + | 'Asia/Kashgar' + | 'Asia/Kathmandu' + | 'Asia/Katmandu' + | 'Asia/Khandyga' + | 'Asia/Kolkata' + | 'Asia/Krasnoyarsk' + | 'Asia/Kuala_Lumpur' + | 'Asia/Kuching' + | 'Asia/Kuwait' + | 'Asia/Macao' + | 'Asia/Macau' + | 'Asia/Magadan' + | 'Asia/Makassar' + | 'Asia/Manila' + | 'Asia/Muscat' + | 'Asia/Nicosia' + | 'Asia/Novokuznetsk' + | 'Asia/Novosibirsk' + | 'Asia/Omsk' + | 'Asia/Oral' + | 'Asia/Phnom_Penh' + | 'Asia/Pontianak' + | 'Asia/Pyongyang' + | 'Asia/Qatar' + | 'Asia/Qostanay' + | 'Asia/Qyzylorda' + | 'Asia/Rangoon' + | 'Asia/Riyadh' + | 'Asia/Saigon' + | 'Asia/Sakhalin' + | 'Asia/Samarkand' + | 'Asia/Seoul' + | 'Asia/Shanghai' + | 'Asia/Singapore' + | 'Asia/Srednekolymsk' + | 'Asia/Taipei' + | 'Asia/Tashkent' + | 'Asia/Tbilisi' + | 'Asia/Tehran' + | 'Asia/Tel_Aviv' + | 'Asia/Thimbu' + | 'Asia/Thimphu' + | 'Asia/Tokyo' + | 'Asia/Tomsk' + | 'Asia/Ujung_Pandang' + | 'Asia/Ulaanbaatar' + | 'Asia/Ulan_Bator' + | 'Asia/Urumqi' + | 'Asia/Ust-Nera' + | 'Asia/Vientiane' + | 'Asia/Vladivostok' + | 'Asia/Yakutsk' + | 'Asia/Yangon' + | 'Asia/Yekaterinburg' + | 'Asia/Yerevan' + | 'Atlantic/Azores' + | 'Atlantic/Bermuda' + | 'Atlantic/Canary' + | 'Atlantic/Cape_Verde' + | 'Atlantic/Faeroe' + | 'Atlantic/Faroe' + | 'Atlantic/Jan_Mayen' + | 'Atlantic/Madeira' + | 'Atlantic/Reykjavik' + | 'Atlantic/South_Georgia' + | 'Atlantic/St_Helena' + | 'Atlantic/Stanley' + | 'Australia/ACT' + | 'Australia/Adelaide' + | 'Australia/Brisbane' + | 'Australia/Broken_Hill' + | 'Australia/Canberra' + | 'Australia/Currie' + | 'Australia/Darwin' + | 'Australia/Eucla' + | 'Australia/Hobart' + | 'Australia/LHI' + | 'Australia/Lindeman' + | 'Australia/Lord_Howe' + | 'Australia/Melbourne' + | 'Australia/NSW' + | 'Australia/North' + | 'Australia/Perth' + | 'Australia/Queensland' + | 'Australia/South' + | 'Australia/Sydney' + | 'Australia/Tasmania' + | 'Australia/Victoria' + | 'Australia/West' + | 'Australia/Yancowinna' + | 'Brazil/Acre' + | 'Brazil/DeNoronha' + | 'Brazil/East' + | 'Brazil/West' + | 'CET' + | 'CST6CDT' + | 'Canada/Atlantic' + | 'Canada/Central' + | 'Canada/Eastern' + | 'Canada/Mountain' + | 'Canada/Newfoundland' + | 'Canada/Pacific' + | 'Canada/Saskatchewan' + | 'Canada/Yukon' + | 'Chile/Continental' + | 'Chile/EasterIsland' + | 'Cuba' + | 'EET' + | 'EST' + | 'EST5EDT' + | 'Egypt' + | 'Eire' + | 'Etc/GMT' + | 'Etc/GMT+0' + | 'Etc/GMT+1' + | 'Etc/GMT+10' + | 'Etc/GMT+11' + | 'Etc/GMT+12' + | 'Etc/GMT+2' + | 'Etc/GMT+3' + | 'Etc/GMT+4' + | 'Etc/GMT+5' + | 'Etc/GMT+6' + | 'Etc/GMT+7' + | 'Etc/GMT+8' + | 'Etc/GMT+9' + | 'Etc/GMT-0' + | 'Etc/GMT-1' + | 'Etc/GMT-10' + | 'Etc/GMT-11' + | 'Etc/GMT-12' + | 'Etc/GMT-13' + | 'Etc/GMT-14' + | 'Etc/GMT-2' + | 'Etc/GMT-3' + | 'Etc/GMT-4' + | 'Etc/GMT-5' + | 'Etc/GMT-6' + | 'Etc/GMT-7' + | 'Etc/GMT-8' + | 'Etc/GMT-9' + | 'Etc/GMT0' + | 'Etc/Greenwich' + | 'Etc/UCT' + | 'Etc/UTC' + | 'Etc/Universal' + | 'Etc/Zulu' + | 'Europe/Amsterdam' + | 'Europe/Andorra' + | 'Europe/Astrakhan' + | 'Europe/Athens' + | 'Europe/Belfast' + | 'Europe/Belgrade' + | 'Europe/Berlin' + | 'Europe/Bratislava' + | 'Europe/Brussels' + | 'Europe/Bucharest' + | 'Europe/Budapest' + | 'Europe/Busingen' + | 'Europe/Chisinau' + | 'Europe/Copenhagen' + | 'Europe/Dublin' + | 'Europe/Gibraltar' + | 'Europe/Guernsey' + | 'Europe/Helsinki' + | 'Europe/Isle_of_Man' + | 'Europe/Istanbul' + | 'Europe/Jersey' + | 'Europe/Kaliningrad' + | 'Europe/Kiev' + | 'Europe/Kirov' + | 'Europe/Lisbon' + | 'Europe/Ljubljana' + | 'Europe/London' + | 'Europe/Luxembourg' + | 'Europe/Madrid' + | 'Europe/Malta' + | 'Europe/Mariehamn' + | 'Europe/Minsk' + | 'Europe/Monaco' + | 'Europe/Moscow' + | 'Europe/Nicosia' + | 'Europe/Oslo' + | 'Europe/Paris' + | 'Europe/Podgorica' + | 'Europe/Prague' + | 'Europe/Riga' + | 'Europe/Rome' + | 'Europe/Samara' + | 'Europe/San_Marino' + | 'Europe/Sarajevo' + | 'Europe/Saratov' + | 'Europe/Simferopol' + | 'Europe/Skopje' + | 'Europe/Sofia' + | 'Europe/Stockholm' + | 'Europe/Tallinn' + | 'Europe/Tirane' + | 'Europe/Tiraspol' + | 'Europe/Ulyanovsk' + | 'Europe/Uzhgorod' + | 'Europe/Vaduz' + | 'Europe/Vatican' + | 'Europe/Vienna' + | 'Europe/Vilnius' + | 'Europe/Volgograd' + | 'Europe/Warsaw' + | 'Europe/Zagreb' + | 'Europe/Zaporozhye' + | 'Europe/Zurich' + | 'Factory' + | 'GB' + | 'GB-Eire' + | 'GMT' + | 'GMT+0' + | 'GMT-0' + | 'GMT0' + | 'Greenwich' + | 'HST' + | 'Hongkong' + | 'Iceland' + | 'Indian/Antananarivo' + | 'Indian/Chagos' + | 'Indian/Christmas' + | 'Indian/Cocos' + | 'Indian/Comoro' + | 'Indian/Kerguelen' + | 'Indian/Mahe' + | 'Indian/Maldives' + | 'Indian/Mauritius' + | 'Indian/Mayotte' + | 'Indian/Reunion' + | 'Iran' + | 'Israel' + | 'Jamaica' + | 'Japan' + | 'Kwajalein' + | 'Libya' + | 'MET' + | 'MST' + | 'MST7MDT' + | 'Mexico/BajaNorte' + | 'Mexico/BajaSur' + | 'Mexico/General' + | 'NZ' + | 'NZ-CHAT' + | 'Navajo' + | 'PRC' + | 'PST8PDT' + | 'Pacific/Apia' + | 'Pacific/Auckland' + | 'Pacific/Bougainville' + | 'Pacific/Chatham' + | 'Pacific/Chuuk' + | 'Pacific/Easter' + | 'Pacific/Efate' + | 'Pacific/Enderbury' + | 'Pacific/Fakaofo' + | 'Pacific/Fiji' + | 'Pacific/Funafuti' + | 'Pacific/Galapagos' + | 'Pacific/Gambier' + | 'Pacific/Guadalcanal' + | 'Pacific/Guam' + | 'Pacific/Honolulu' + | 'Pacific/Johnston' + | 'Pacific/Kiritimati' + | 'Pacific/Kosrae' + | 'Pacific/Kwajalein' + | 'Pacific/Majuro' + | 'Pacific/Marquesas' + | 'Pacific/Midway' + | 'Pacific/Nauru' + | 'Pacific/Niue' + | 'Pacific/Norfolk' + | 'Pacific/Noumea' + | 'Pacific/Pago_Pago' + | 'Pacific/Palau' + | 'Pacific/Pitcairn' + | 'Pacific/Pohnpei' + | 'Pacific/Ponape' + | 'Pacific/Port_Moresby' + | 'Pacific/Rarotonga' + | 'Pacific/Saipan' + | 'Pacific/Samoa' + | 'Pacific/Tahiti' + | 'Pacific/Tarawa' + | 'Pacific/Tongatapu' + | 'Pacific/Truk' + | 'Pacific/Wake' + | 'Pacific/Wallis' + | 'Pacific/Yap' + | 'Poland' + | 'Portugal' + | 'ROC' + | 'ROK' + | 'Singapore' + | 'Turkey' + | 'UCT' + | 'US/Alaska' + | 'US/Aleutian' + | 'US/Arizona' + | 'US/Central' + | 'US/East-Indiana' + | 'US/Eastern' + | 'US/Hawaii' + | 'US/Indiana-Starke' + | 'US/Michigan' + | 'US/Mountain' + | 'US/Pacific' + | 'US/Pacific-New' + | 'US/Samoa' + | 'UTC' + | 'Universal' + | 'W-SU' + | 'WET' + | 'Zulu' + } & { [key: string]: unknown } /** @description The ID of the [report type](https://stripe.com/docs/reporting/statements/api#report-types) to run, such as `"balance.summary.1"`. */ - report_type: string; - }; - }; - }; - }; + report_type: string + } + } + } + } /**

Retrieves the details of an existing Report Run.

*/ GetReportingReportRunsReportRun: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - report_run: string; - }; - }; + report_run: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["reporting.report_run"]; - }; - }; + 'application/json': components['schemas']['reporting.report_run'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a full list of Report Types.

*/ GetReportingReportTypes: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["reporting.report_type"][]; + 'application/json': { + data: components['schemas']['reporting.report_type'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ GetReportingReportTypesReportType: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - report_type: string; - }; - }; + report_type: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["reporting.report_type"]; - }; - }; + 'application/json': components['schemas']['reporting.report_type'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ GetReviews: { parameters: { query: { created?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["review"][]; + 'application/json': { + data: components['schemas']['review'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves a Review object.

*/ GetReviewsReview: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - review: string; - }; - }; + review: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["review"]; - }; - }; + 'application/json': components['schemas']['review'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostReviewsReviewApprove: { parameters: { path: { - review: string; - }; - }; + review: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["review"]; - }; - }; + 'application/json': components['schemas']['review'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Returns a list of SetupAttempts associated with a provided SetupIntent.

*/ GetSetupAttempts: { parameters: { @@ -39720,59 +39136,59 @@ export interface operations { */ created?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** * Only return SetupAttempts created by the SetupIntent specified by * this ID. */ - setup_intent: string; + setup_intent: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["setup_attempt"][]; + 'application/json': { + data: components['schemas']['setup_attempt'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of SetupIntents.

*/ GetSetupIntents: { parameters: { @@ -39780,58 +39196,58 @@ export interface operations { /** 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?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** Only return SetupIntents for the customer specified by this customer ID. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return SetupIntents associated with the specified payment method. */ - payment_method?: string; + payment_method?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["setup_intent"][]; + 'application/json': { + data: components['schemas']['setup_intent'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Creates a SetupIntent object.

* @@ -39843,31 +39259,31 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["setup_intent"]; - }; - }; + 'application/json': components['schemas']['setup_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Set to `true` to attempt to confirm this SetupIntent immediately. This parameter defaults to `false`. If the payment method attached is a card, a return_url may be provided in case additional authentication is required. */ - confirm?: boolean; + confirm?: boolean /** * @description ID of the Customer this SetupIntent belongs to, if one exists. * * If 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. */ - customer?: string; + customer?: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * secret_key_param * @description This hash contains details about the Mandate to create. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm). @@ -39876,24 +39292,24 @@ export interface operations { /** customer_acceptance_param */ customer_acceptance: { /** Format: unix-time */ - accepted_at?: number; + accepted_at?: number /** offline_param */ - offline?: { [key: string]: unknown }; + offline?: { [key: string]: unknown } /** online_param */ online?: { - ip_address: string; - user_agent: string; - } & { [key: string]: unknown }; + ip_address: string + user_agent: string + } & { [key: string]: unknown } /** @enum {string} */ - type: "offline" | "online"; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + type: 'offline' | 'online' + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The Stripe account ID for which this SetupIntent is created. */ - on_behalf_of?: string; + on_behalf_of?: string /** @description ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. */ - payment_method?: string; + payment_method?: string /** * payment_method_options_param * @description Payment-method-specific configuration for this SetupIntent. @@ -39902,52 +39318,52 @@ export interface operations { /** setup_intent_payment_method_options_param */ acss_debit?: { /** @enum {string} */ - currency?: "cad" | "usd"; + currency?: 'cad' | 'usd' /** setup_intent_payment_method_options_mandate_options_param */ mandate_options?: { - custom_mandate_url?: (Partial & Partial<"">) & { [key: string]: unknown }; - default_for?: ("invoice" | "subscription")[]; - interval_description?: string; + custom_mandate_url?: (Partial & Partial<''>) & { [key: string]: unknown } + default_for?: ('invoice' | 'subscription')[] + interval_description?: string /** @enum {string} */ - payment_schedule?: "combined" | "interval" | "sporadic"; + payment_schedule?: 'combined' | 'interval' | 'sporadic' /** @enum {string} */ - transaction_type?: "business" | "personal"; - } & { [key: string]: unknown }; + transaction_type?: 'business' | 'personal' + } & { [key: string]: unknown } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; - } & { [key: string]: unknown }; + verification_method?: 'automatic' | 'instant' | 'microdeposits' + } & { [key: string]: unknown } /** setup_intent_param */ card?: { /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; - } & { [key: string]: unknown }; + request_three_d_secure?: 'any' | 'automatic' + } & { [key: string]: unknown } /** setup_intent_payment_method_options_param */ sepa_debit?: { /** payment_method_options_mandate_options_param */ - mandate_options?: { [key: string]: unknown }; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + mandate_options?: { [key: string]: unknown } + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** @description The list of payment method types (e.g. card) that this SetupIntent is allowed to use. If this is not provided, defaults to ["card"]. */ - payment_method_types?: string[]; + payment_method_types?: string[] /** @description The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm). */ - return_url?: string; + return_url?: string /** * setup_intent_single_use_params * @description If this hash is populated, this SetupIntent will generate a single_use Mandate on success. */ single_use?: { - amount: number; - currency: string; - } & { [key: string]: unknown }; + amount: number + currency: string + } & { [key: string]: unknown } /** * @description Indicates how the payment method is intended to be used in the future. If not provided, this value defaults to `off_session`. * @enum {string} */ - usage?: "off_session" | "on_session"; - }; - }; - }; - }; + usage?: 'off_session' | 'on_session' + } + } + } + } /** *

Retrieves the details of a SetupIntent that has previously been created.

* @@ -39959,72 +39375,72 @@ export interface operations { parameters: { query: { /** The client secret of the SetupIntent. Required if a publishable key is used to retrieve the SetupIntent. */ - client_secret?: string; + client_secret?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - intent: string; - }; - }; + intent: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["setup_intent"]; - }; - }; + 'application/json': components['schemas']['setup_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates a SetupIntent object.

*/ PostSetupIntentsIntent: { parameters: { path: { - intent: string; - }; - }; + intent: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["setup_intent"]; - }; - }; + 'application/json': components['schemas']['setup_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * @description ID of the Customer this SetupIntent belongs to, if one exists. * * If 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. */ - customer?: string; + customer?: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. */ - payment_method?: string; + payment_method?: string /** * payment_method_options_param * @description Payment-method-specific configuration for this SetupIntent. @@ -40033,37 +39449,37 @@ export interface operations { /** setup_intent_payment_method_options_param */ acss_debit?: { /** @enum {string} */ - currency?: "cad" | "usd"; + currency?: 'cad' | 'usd' /** setup_intent_payment_method_options_mandate_options_param */ mandate_options?: { - custom_mandate_url?: (Partial & Partial<"">) & { [key: string]: unknown }; - default_for?: ("invoice" | "subscription")[]; - interval_description?: string; + custom_mandate_url?: (Partial & Partial<''>) & { [key: string]: unknown } + default_for?: ('invoice' | 'subscription')[] + interval_description?: string /** @enum {string} */ - payment_schedule?: "combined" | "interval" | "sporadic"; + payment_schedule?: 'combined' | 'interval' | 'sporadic' /** @enum {string} */ - transaction_type?: "business" | "personal"; - } & { [key: string]: unknown }; + transaction_type?: 'business' | 'personal' + } & { [key: string]: unknown } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; - } & { [key: string]: unknown }; + verification_method?: 'automatic' | 'instant' | 'microdeposits' + } & { [key: string]: unknown } /** setup_intent_param */ card?: { /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; - } & { [key: string]: unknown }; + request_three_d_secure?: 'any' | 'automatic' + } & { [key: string]: unknown } /** setup_intent_payment_method_options_param */ sepa_debit?: { /** payment_method_options_mandate_options_param */ - mandate_options?: { [key: string]: unknown }; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + mandate_options?: { [key: string]: unknown } + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** @description The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. If this is not provided, defaults to ["card"]. */ - payment_method_types?: string[]; - }; - }; - }; - }; + payment_method_types?: string[] + } + } + } + } /** *

A SetupIntent object can be canceled when it is in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.

* @@ -40072,37 +39488,37 @@ export interface operations { PostSetupIntentsIntentCancel: { parameters: { path: { - intent: string; - }; - }; + intent: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["setup_intent"]; - }; - }; + 'application/json': components['schemas']['setup_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * @description Reason for canceling this SetupIntent. Possible values are `abandoned`, `requested_by_customer`, or `duplicate` * @enum {string} */ - cancellation_reason?: "abandoned" | "duplicate" | "requested_by_customer"; + cancellation_reason?: 'abandoned' | 'duplicate' | 'requested_by_customer' /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /** *

Confirm that your customer intends to set up the current or * provided payment method. For example, you would confirm a SetupIntent @@ -40121,47 +39537,47 @@ export interface operations { PostSetupIntentsIntentConfirm: { parameters: { path: { - intent: string; - }; - }; + intent: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["setup_intent"]; - }; - }; + 'application/json': components['schemas']['setup_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The client secret of the SetupIntent. */ - client_secret?: string; + client_secret?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description This hash contains details about the Mandate to create */ mandate_data?: (Partial< { /** customer_acceptance_param */ customer_acceptance: { /** Format: unix-time */ - accepted_at?: number; + accepted_at?: number /** offline_param */ - offline?: { [key: string]: unknown }; + offline?: { [key: string]: unknown } /** online_param */ online?: { - ip_address: string; - user_agent: string; - } & { [key: string]: unknown }; + ip_address: string + user_agent: string + } & { [key: string]: unknown } /** @enum {string} */ - type: "offline" | "online"; - } & { [key: string]: unknown }; + type: 'offline' | 'online' + } & { [key: string]: unknown } } & { [key: string]: unknown } > & Partial< @@ -40170,16 +39586,16 @@ export interface operations { customer_acceptance: { /** online_param */ online: { - ip_address?: string; - user_agent?: string; - } & { [key: string]: unknown }; + ip_address?: string + user_agent?: string + } & { [key: string]: unknown } /** @enum {string} */ - type: "online"; - } & { [key: string]: unknown }; + type: 'online' + } & { [key: string]: unknown } } & { [key: string]: unknown } - >) & { [key: string]: unknown }; + >) & { [key: string]: unknown } /** @description ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. */ - payment_method?: string; + payment_method?: string /** * payment_method_options_param * @description Payment-method-specific configuration for this SetupIntent. @@ -40188,153 +39604,153 @@ export interface operations { /** setup_intent_payment_method_options_param */ acss_debit?: { /** @enum {string} */ - currency?: "cad" | "usd"; + currency?: 'cad' | 'usd' /** setup_intent_payment_method_options_mandate_options_param */ mandate_options?: { - custom_mandate_url?: (Partial & Partial<"">) & { [key: string]: unknown }; - default_for?: ("invoice" | "subscription")[]; - interval_description?: string; + custom_mandate_url?: (Partial & Partial<''>) & { [key: string]: unknown } + default_for?: ('invoice' | 'subscription')[] + interval_description?: string /** @enum {string} */ - payment_schedule?: "combined" | "interval" | "sporadic"; + payment_schedule?: 'combined' | 'interval' | 'sporadic' /** @enum {string} */ - transaction_type?: "business" | "personal"; - } & { [key: string]: unknown }; + transaction_type?: 'business' | 'personal' + } & { [key: string]: unknown } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; - } & { [key: string]: unknown }; + verification_method?: 'automatic' | 'instant' | 'microdeposits' + } & { [key: string]: unknown } /** setup_intent_param */ card?: { /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; - } & { [key: string]: unknown }; + request_three_d_secure?: 'any' | 'automatic' + } & { [key: string]: unknown } /** setup_intent_payment_method_options_param */ sepa_debit?: { /** payment_method_options_mandate_options_param */ - mandate_options?: { [key: string]: unknown }; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + mandate_options?: { [key: string]: unknown } + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** * @description The URL to redirect your customer back to after they authenticate on the payment method's app or site. * If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. * This parameter is only used for cards and other redirect-based payment methods. */ - return_url?: string; - }; - }; - }; - }; + return_url?: string + } + } + } + } /**

Verifies microdeposits on a SetupIntent object.

*/ PostSetupIntentsIntentVerifyMicrodeposits: { parameters: { path: { - intent: string; - }; - }; + intent: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["setup_intent"]; - }; - }; + 'application/json': components['schemas']['setup_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account. */ - amounts?: number[]; + amounts?: number[] /** @description The client secret of the SetupIntent. */ - client_secret?: string; + client_secret?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Returns a list of your shipping rates.

*/ GetShippingRates: { parameters: { query: { /** Only return shipping rates that are active or inactive. */ - active?: boolean; + active?: boolean /** 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?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** Only return shipping rates for the given currency. */ - currency?: string; + currency?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["shipping_rate"][]; + 'application/json': { + data: components['schemas']['shipping_rate'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new shipping rate object.

*/ PostShippingRates: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["shipping_rate"]; - }; - }; + 'application/json': components['schemas']['shipping_rate'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * delivery_estimate * @description The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions. @@ -40343,336 +39759,335 @@ export interface operations { /** delivery_estimate_bound */ maximum?: { /** @enum {string} */ - unit: "business_day" | "day" | "hour" | "month" | "week"; - value: number; - } & { [key: string]: unknown }; + unit: 'business_day' | 'day' | 'hour' | 'month' | 'week' + value: number + } & { [key: string]: unknown } /** delivery_estimate_bound */ minimum?: { /** @enum {string} */ - unit: "business_day" | "day" | "hour" | "month" | "week"; - value: number; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + unit: 'business_day' | 'day' | 'hour' | 'month' | 'week' + value: number + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** @description The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions. */ - display_name: string; + display_name: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * fixed_amount * @description Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`. */ fixed_amount?: { - amount: number; - currency: string; - } & { [key: string]: unknown }; + amount: number + currency: string + } & { [key: string]: unknown } /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * @description Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. * @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' /** @description A [tax code](https://stripe.com/docs/tax/tax-codes) ID. The Shipping tax code is `txcd_92010001`. */ - tax_code?: string; + tax_code?: string /** * @description The type of calculation to use on the shipping rate. Can only be `fixed_amount` for now. * @enum {string} */ - type?: "fixed_amount"; - }; - }; - }; - }; + type?: 'fixed_amount' + } + } + } + } /**

Returns the shipping rate object with the given ID.

*/ GetShippingRatesShippingRateToken: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - shipping_rate_token: string; - }; - }; + shipping_rate_token: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["shipping_rate"]; - }; - }; + 'application/json': components['schemas']['shipping_rate'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates an existing shipping rate object.

*/ PostShippingRatesShippingRateToken: { parameters: { path: { - shipping_rate_token: string; - }; - }; + shipping_rate_token: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["shipping_rate"]; - }; - }; + 'application/json': components['schemas']['shipping_rate'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether the shipping rate can be used for new purchases. Defaults to `true`. */ - active?: boolean; + active?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; - }; - }; - }; - }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } + } + } + } + } /**

Returns a list of scheduled query runs.

*/ GetSigmaScheduledQueryRuns: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["scheduled_query_run"][]; + 'application/json': { + data: components['schemas']['scheduled_query_run'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves the details of an scheduled query run.

*/ GetSigmaScheduledQueryRunsScheduledQueryRun: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - scheduled_query_run: string; - }; - }; + scheduled_query_run: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["scheduled_query_run"]; - }; - }; + 'application/json': components['schemas']['scheduled_query_run'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ GetSkus: { parameters: { query: { /** Only return SKUs that are active or inactive (e.g., pass `false` to list all inactive products). */ - active?: boolean; + active?: boolean /** Only return SKUs that have the specified key-value pairs in this partially constructed dictionary. Can be specified only if `product` is also supplied. For instance, if the associated product has attributes `["color", "size"]`, passing in `attributes[color]=red` returns all the SKUs for this product that have `color` set to `red`. */ - attributes?: { [key: string]: string }; + attributes?: { [key: string]: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** Only return SKUs with the given IDs. */ - ids?: string[]; + ids?: string[] /** Only return SKUs that are either in stock or out of stock (e.g., pass `false` to list all SKUs that are out of stock). If no value is provided, all SKUs are returned. */ - in_stock?: boolean; + in_stock?: boolean /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** The ID of the product whose SKUs will be retrieved. Must be a product with type `good`. */ - product?: string; + product?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["sku"][]; + 'application/json': { + data: components['schemas']['sku'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new SKU associated with a product.

*/ PostSkus: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["sku"]; - }; - }; + 'application/json': components['schemas']['sku'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether the SKU is available for purchase. Default to `true`. */ - active?: boolean; + active?: boolean /** @description A dictionary of attributes and values for the attributes defined by the product. If, for example, a product's attributes are `["size", "gender"]`, a valid SKU has the following dictionary of attributes: `{"size": "Medium", "gender": "Unisex"}`. */ - attributes?: { [key: string]: string }; + attributes?: { [key: string]: string } /** @description 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: string; + currency: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The identifier for the SKU. Must be unique. If not provided, an identifier will be randomly generated. */ - id?: string; + id?: string /** @description The URL of an image for this SKU, meant to be displayable to the customer. */ - image?: string; + image?: string /** * inventory_create_specs * @description Description of the SKU's inventory. */ inventory: { - quantity?: number; + quantity?: number /** @enum {string} */ - type: "bucket" | "finite" | "infinite"; + type: 'bucket' | 'finite' | 'infinite' /** @enum {string} */ - value?: "" | "in_stock" | "limited" | "out_of_stock"; - } & { [key: string]: unknown }; + value?: '' | 'in_stock' | 'limited' | 'out_of_stock' + } & { [key: string]: unknown } /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * package_dimensions_specs * @description The dimensions of this SKU for shipping purposes. */ package_dimensions?: { - height: number; - length: number; - weight: number; - width: number; - } & { [key: string]: unknown }; + height: number + length: number + weight: number + width: number + } & { [key: string]: unknown } /** @description The cost of the item as a nonnegative integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a zero-decimal currency). */ - price: number; + price: number /** @description The ID of the product this SKU is associated with. Must be a product with type `good`. */ - product: string; - }; - }; - }; - }; + product: string + } + } + } + } /**

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

*/ GetSkusId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": (Partial & - Partial) & { [key: string]: unknown }; - }; - }; + 'application/json': (Partial & Partial) & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

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

* @@ -40681,126 +40096,126 @@ export interface operations { PostSkusId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["sku"]; - }; - }; + 'application/json': components['schemas']['sku'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether this SKU is available for purchase. */ - active?: boolean; + active?: boolean /** @description A dictionary of attributes and values for the attributes defined by the product. When specified, `attributes` will partially update the existing attributes dictionary on the product, with the postcondition that a value must be present for each attribute key on the product. */ - attributes?: { [key: string]: string }; + attributes?: { [key: string]: string } /** @description 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?: string; + currency?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The URL of an image for this SKU, meant to be displayable to the customer. */ - image?: string; + image?: string /** * inventory_update_specs * @description Description of the SKU's inventory. */ inventory?: { - quantity?: number; + quantity?: number /** @enum {string} */ - type?: "bucket" | "finite" | "infinite"; + type?: 'bucket' | 'finite' | 'infinite' /** @enum {string} */ - value?: "" | "in_stock" | "limited" | "out_of_stock"; - } & { [key: string]: unknown }; + value?: '' | 'in_stock' | 'limited' | 'out_of_stock' + } & { [key: string]: unknown } /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description The dimensions of this SKU for shipping purposes. */ package_dimensions?: (Partial< { - height: number; - length: number; - weight: number; - width: number; + height: number + length: number + weight: number + width: number } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** @description The cost of the item as a positive integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a zero-decimal currency). */ - price?: number; + price?: number /** @description The ID of the product that this SKU should belong to. The product must exist, have the same set of attribute names as the SKU's current product, and be of type `good`. */ - product?: string; - }; - }; - }; - }; + product?: string + } + } + } + } /**

Delete a SKU. Deleting a SKU is only possible until it has been used in an order.

*/ DeleteSkusId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_sku"]; - }; - }; + 'application/json': components['schemas']['deleted_sku'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new source object.

*/ PostSources: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["source"]; - }; - }; + 'application/json': components['schemas']['source'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources. Not supported for `receiver` type sources, where charge amount may not be specified until funds land. */ - amount?: number; + amount?: number /** @description 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. */ - currency?: string; + currency?: string /** @description The `Customer` to whom the original source is attached to. Must be set when the original source is not a `Source` (e.g., `Card`). */ - customer?: string; + customer?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * @description The authentication `flow` of the source to create. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`. It is generally inferred unless a type supports multiple flows. * @enum {string} */ - flow?: "code_verification" | "none" | "receiver" | "redirect"; + flow?: 'code_verification' | 'none' | 'receiver' | 'redirect' /** * mandate_params * @description Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status. @@ -40809,35 +40224,35 @@ export interface operations { /** mandate_acceptance_params */ acceptance?: { /** Format: unix-time */ - date?: number; - ip?: string; + date?: number + ip?: string /** mandate_offline_acceptance_params */ offline?: { - contact_email: string; - } & { [key: string]: unknown }; + contact_email: string + } & { [key: string]: unknown } /** mandate_online_acceptance_params */ online?: { /** Format: unix-time */ - date?: number; - ip?: string; - user_agent?: string; - } & { [key: string]: unknown }; + date?: number + ip?: string + user_agent?: string + } & { [key: string]: unknown } /** @enum {string} */ - status: "accepted" | "pending" | "refused" | "revoked"; + status: 'accepted' | 'pending' | 'refused' | 'revoked' /** @enum {string} */ - type?: "offline" | "online"; - user_agent?: string; - } & { [key: string]: unknown }; - amount?: (Partial & Partial<"">) & { [key: string]: unknown }; - currency?: string; + type?: 'offline' | 'online' + user_agent?: string + } & { [key: string]: unknown } + amount?: (Partial & Partial<''>) & { [key: string]: unknown } + currency?: string /** @enum {string} */ - interval?: "one_time" | "scheduled" | "variable"; + interval?: 'one_time' | 'scheduled' | 'variable' /** @enum {string} */ - notification_method?: "deprecated_none" | "email" | "manual" | "none" | "stripe_email"; - } & { [key: string]: unknown }; - metadata?: { [key: string]: string }; + notification_method?: 'deprecated_none' | 'email' | 'manual' | 'none' | 'stripe_email' + } & { [key: string]: unknown } + metadata?: { [key: string]: string } /** @description The source to share. */ - original_source?: string; + original_source?: string /** * owner * @description Information about the owner of the payment instrument that may be used or required by particular source types. @@ -40845,108 +40260,108 @@ export interface operations { owner?: { /** source_address */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - } & { [key: string]: unknown }; - email?: string; - name?: string; - phone?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } & { [key: string]: unknown } + email?: string + name?: string + phone?: string + } & { [key: string]: unknown } /** * receiver_params * @description Optional parameters for the receiver flow. Can be set only if the source is a receiver (`flow` is `receiver`). */ receiver?: { /** @enum {string} */ - refund_attributes_method?: "email" | "manual" | "none"; - } & { [key: string]: unknown }; + refund_attributes_method?: 'email' | 'manual' | 'none' + } & { [key: string]: unknown } /** * redirect_params * @description Parameters required for the redirect flow. Required if the source is authenticated by a redirect (`flow` is `redirect`). */ redirect?: { - return_url: string; - } & { [key: string]: unknown }; + return_url: string + } & { [key: string]: unknown } /** * shallow_order_specs * @description Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it. */ source_order?: { items?: ({ - amount?: number; - currency?: string; - description?: string; - parent?: string; - quantity?: number; + amount?: number + currency?: string + description?: string + parent?: string + quantity?: number /** @enum {string} */ - type?: "discount" | "shipping" | "sku" | "tax"; - } & { [key: string]: unknown })[]; + type?: 'discount' | 'shipping' | 'sku' | 'tax' + } & { [key: string]: unknown })[] /** order_shipping */ shipping?: { /** address */ address: { - city?: string; - country?: string; - line1: string; - line2?: string; - postal_code?: string; - state?: string; - } & { [key: string]: unknown }; - carrier?: string; - name?: string; - phone?: string; - tracking_number?: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + city?: string + country?: string + line1: string + line2?: string + postal_code?: string + state?: string + } & { [key: string]: unknown } + carrier?: string + name?: string + phone?: string + tracking_number?: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** @description An arbitrary string to be displayed on your customer's statement. As an example, if your website is `RunClub` and the item you're charging for is a race ticket, you may want to specify a `statement_descriptor` of `RunClub 5K race ticket.` While many payment types will display this information, some may not display it at all. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description An optional token used to create the source. When passed, token properties will override source parameters. */ - token?: string; + token?: string /** @description The `type` of the source to create. Required unless `customer` and `original_source` are specified (see the [Cloning card Sources](https://stripe.com/docs/sources/connect#cloning-card-sources) guide) */ - type?: string; + type?: string /** @enum {string} */ - usage?: "reusable" | "single_use"; - }; - }; - }; - }; + usage?: 'reusable' | 'single_use' + } + } + } + } /**

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.

*/ GetSourcesSource: { parameters: { query: { /** The client secret of the source. Required if a publishable key is used to retrieve the source. */ - client_secret?: string; + client_secret?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - source: string; - }; - }; + source: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["source"]; - }; - }; + 'application/json': components['schemas']['source'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

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

* @@ -40955,30 +40370,30 @@ export interface operations { PostSourcesSource: { parameters: { path: { - source: string; - }; - }; + source: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["source"]; - }; - }; + 'application/json': components['schemas']['source'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Amount associated with the source. */ - amount?: number; + amount?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * mandate_params * @description Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status. @@ -40987,34 +40402,34 @@ export interface operations { /** mandate_acceptance_params */ acceptance?: { /** Format: unix-time */ - date?: number; - ip?: string; + date?: number + ip?: string /** mandate_offline_acceptance_params */ offline?: { - contact_email: string; - } & { [key: string]: unknown }; + contact_email: string + } & { [key: string]: unknown } /** mandate_online_acceptance_params */ online?: { /** Format: unix-time */ - date?: number; - ip?: string; - user_agent?: string; - } & { [key: string]: unknown }; + date?: number + ip?: string + user_agent?: string + } & { [key: string]: unknown } /** @enum {string} */ - status: "accepted" | "pending" | "refused" | "revoked"; + status: 'accepted' | 'pending' | 'refused' | 'revoked' /** @enum {string} */ - type?: "offline" | "online"; - user_agent?: string; - } & { [key: string]: unknown }; - amount?: (Partial & Partial<"">) & { [key: string]: unknown }; - currency?: string; + type?: 'offline' | 'online' + user_agent?: string + } & { [key: string]: unknown } + amount?: (Partial & Partial<''>) & { [key: string]: unknown } + currency?: string /** @enum {string} */ - interval?: "one_time" | "scheduled" | "variable"; + interval?: 'one_time' | 'scheduled' | 'variable' /** @enum {string} */ - notification_method?: "deprecated_none" | "email" | "manual" | "none" | "stripe_email"; - } & { [key: string]: unknown }; + notification_method?: 'deprecated_none' | 'email' | 'manual' | 'none' | 'stripe_email' + } & { [key: string]: unknown } /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** * owner * @description Information about the owner of the payment instrument that may be used or required by particular source types. @@ -41022,273 +40437,273 @@ export interface operations { owner?: { /** source_address */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - } & { [key: string]: unknown }; - email?: string; - name?: string; - phone?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } & { [key: string]: unknown } + email?: string + name?: string + phone?: string + } & { [key: string]: unknown } /** * order_params * @description Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it. */ source_order?: { items?: ({ - amount?: number; - currency?: string; - description?: string; - parent?: string; - quantity?: number; + amount?: number + currency?: string + description?: string + parent?: string + quantity?: number /** @enum {string} */ - type?: "discount" | "shipping" | "sku" | "tax"; - } & { [key: string]: unknown })[]; + type?: 'discount' | 'shipping' | 'sku' | 'tax' + } & { [key: string]: unknown })[] /** order_shipping */ shipping?: { /** address */ address: { - city?: string; - country?: string; - line1: string; - line2?: string; - postal_code?: string; - state?: string; - } & { [key: string]: unknown }; - carrier?: string; - name?: string; - phone?: string; - tracking_number?: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; - }; - }; - }; - }; + city?: string + country?: string + line1: string + line2?: string + postal_code?: string + state?: string + } & { [key: string]: unknown } + carrier?: string + name?: string + phone?: string + tracking_number?: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } + } + } + } + } /**

Retrieves a new Source MandateNotification.

*/ GetSourcesSourceMandateNotificationsMandateNotification: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - mandate_notification: string; - source: string; - }; - }; + mandate_notification: string + source: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["source_mandate_notification"]; - }; - }; + 'application/json': components['schemas']['source_mandate_notification'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

List source transactions for a given source.

*/ GetSourcesSourceSourceTransactions: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - source: string; - }; - }; + source: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["source_transaction"][]; + 'application/json': { + data: components['schemas']['source_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ GetSourcesSourceSourceTransactionsSourceTransaction: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - source: string; - source_transaction: string; - }; - }; + source: string + source_transaction: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["source_transaction"]; - }; - }; + 'application/json': components['schemas']['source_transaction'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Verify a given source.

*/ PostSourcesSourceVerify: { parameters: { path: { - source: string; - }; - }; + source: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["source"]; - }; - }; + 'application/json': components['schemas']['source'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The values needed to verify the source. */ - values: string[]; - }; - }; - }; - }; + values: string[] + } + } + } + } /**

Returns a list of your subscription items for a given subscription.

*/ GetSubscriptionItems: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** The ID of the subscription whose items will be retrieved. */ - subscription: string; - }; - }; + subscription: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["subscription_item"][]; + 'application/json': { + data: components['schemas']['subscription_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Adds a new item to an existing subscription. No existing items will be changed or replaced.

*/ PostSubscriptionItems: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription_item"]; - }; - }; + 'application/json': components['schemas']['subscription_item'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. */ billing_thresholds?: (Partial< { - usage_gte: number; + usage_gte: number } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * @description Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * @@ -41299,32 +40714,28 @@ export interface operations { * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. * @enum {string} */ - payment_behavior?: - | "allow_incomplete" - | "default_incomplete" - | "error_if_incomplete" - | "pending_if_incomplete"; + payment_behavior?: 'allow_incomplete' | 'default_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete' /** @description The ID of the price object. */ - price?: string; + price?: string /** * recurring_price_data * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - } & { [key: string]: unknown }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } & { [key: string]: unknown } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - } & { [key: string]: unknown }; + unit_amount_decimal?: string + } & { [key: string]: unknown } /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -41333,90 +40744,90 @@ export interface operations { * Prorations can be disabled by passing `none`. * @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** * Format: unix-time * @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. */ - proration_date?: number; + proration_date?: number /** @description The quantity you'd like to apply to the subscription item you're creating. */ - quantity?: number; + quantity?: number /** @description The identifier of the subscription to modify. */ - subscription: string; + subscription: string /** @description A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. */ - tax_rates?: (Partial & Partial<"">) & { [key: string]: unknown }; - }; - }; - }; - }; + tax_rates?: (Partial & Partial<''>) & { [key: string]: unknown } + } + } + } + } /**

Retrieves the subscription item with the given ID.

*/ GetSubscriptionItemsItem: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - item: string; - }; - }; + item: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription_item"]; - }; - }; + 'application/json': components['schemas']['subscription_item'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates the plan or quantity of an item on a current subscription.

*/ PostSubscriptionItemsItem: { parameters: { path: { - item: string; - }; - }; + item: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription_item"]; - }; - }; + 'application/json': components['schemas']['subscription_item'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. */ billing_thresholds?: (Partial< { - usage_gte: number; + usage_gte: number } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. */ - off_session?: boolean; + off_session?: boolean /** * @description Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * @@ -41427,32 +40838,28 @@ export interface operations { * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. * @enum {string} */ - payment_behavior?: - | "allow_incomplete" - | "default_incomplete" - | "error_if_incomplete" - | "pending_if_incomplete"; + payment_behavior?: 'allow_incomplete' | 'default_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete' /** @description The ID of the price object. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided. */ - price?: string; + price?: string /** * recurring_price_data * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - } & { [key: string]: unknown }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } & { [key: string]: unknown } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - } & { [key: string]: unknown }; + unit_amount_decimal?: string + } & { [key: string]: unknown } /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -41461,46 +40868,46 @@ export interface operations { * Prorations can be disabled by passing `none`. * @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** * Format: unix-time * @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. */ - proration_date?: number; + proration_date?: number /** @description The quantity you'd like to apply to the subscription item you're creating. */ - quantity?: number; + quantity?: number /** @description A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. */ - tax_rates?: (Partial & Partial<"">) & { [key: string]: unknown }; - }; - }; - }; - }; + tax_rates?: (Partial & Partial<''>) & { [key: string]: unknown } + } + } + } + } /**

Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.

*/ DeleteSubscriptionItemsItem: { parameters: { path: { - item: string; - }; - }; + item: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_subscription_item"]; - }; - }; + 'application/json': components['schemas']['deleted_subscription_item'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Delete all usage for the given subscription item. Allowed only when the current plan's `usage_type` is `metered`. */ - clear_usage?: boolean; + clear_usage?: boolean /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -41509,16 +40916,16 @@ export interface operations { * Prorations can be disabled by passing `none`. * @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** * Format: unix-time * @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. */ - proration_date?: number; - }; - }; - }; - }; + proration_date?: number + } + } + } + } /** *

For the specified subscription item, returns a list of summary objects. Each object in the list provides usage information that’s been summarized from multiple usage records and over a subscription billing period (e.g., 15 usage records in the month of September).

* @@ -41528,49 +40935,49 @@ export interface operations { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - subscription_item: string; - }; - }; + subscription_item: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["usage_record_summary"][]; + 'application/json': { + data: components['schemas']['usage_record_summary'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Creates a usage record for a specified subscription item and date, and fills it with a quantity.

* @@ -41583,41 +40990,41 @@ export interface operations { PostSubscriptionItemsSubscriptionItemUsageRecords: { parameters: { path: { - subscription_item: string; - }; - }; + subscription_item: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["usage_record"]; - }; - }; + 'application/json': components['schemas']['usage_record'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * @description Valid values are `increment` (default) or `set`. When using `increment` the specified `quantity` will be added to the usage at the specified timestamp. The `set` action will overwrite the usage quantity at that timestamp. If the subscription has [billing thresholds](https://stripe.com/docs/api/subscriptions/object#subscription_object-billing_thresholds), `increment` is the only allowed value. * @enum {string} */ - action?: "increment" | "set"; + action?: 'increment' | 'set' /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The usage quantity for the specified timestamp. */ - quantity: number; + quantity: number /** @description The timestamp for the usage event. This timestamp must be within the current billing period of the subscription of the provided `subscription_item`, and must not be in the future. When passing `"now"`, Stripe records usage for the current time. Default is `"now"` if a value is not provided. */ - timestamp?: (Partial<"now"> & Partial) & { [key: string]: unknown }; - }; - }; - }; - }; + timestamp?: (Partial<'now'> & Partial) & { [key: string]: unknown } + } + } + } + } /**

Retrieves the list of your subscription schedules.

*/ GetSubscriptionSchedules: { parameters: { @@ -41625,704 +41032,695 @@ export interface operations { /** Only return subscription schedules that were created canceled the given date interval. */ canceled_at?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** Only return subscription schedules that completed during the given date interval. */ completed_at?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** Only return subscription schedules that were created during the given date interval. */ created?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** Only return subscription schedules for the given customer. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return subscription schedules that were released during the given date interval. */ released_at?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** Only return subscription schedules that have not started yet. */ - scheduled?: boolean; + scheduled?: boolean /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["subscription_schedule"][]; + 'application/json': { + data: components['schemas']['subscription_schedule'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.

*/ PostSubscriptionSchedules: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription_schedule"]; - }; - }; + 'application/json': components['schemas']['subscription_schedule'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The identifier of the customer to create the subscription schedule for. */ - customer?: string; + customer?: string /** * default_settings_params * @description Object representing the subscription schedule's default settings. */ default_settings?: { - application_fee_percent?: number; + application_fee_percent?: number /** automatic_tax_config */ automatic_tax?: { - enabled: boolean; - } & { [key: string]: unknown }; + enabled: boolean + } & { [key: string]: unknown } /** @enum {string} */ - billing_cycle_anchor?: "automatic" | "phase_start"; + billing_cycle_anchor?: 'automatic' | 'phase_start' billing_thresholds?: (Partial< { - amount_gte?: number; - reset_billing_cycle_anchor?: boolean; + amount_gte?: number + reset_billing_cycle_anchor?: boolean } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; - default_payment_method?: string; + collection_method?: 'charge_automatically' | 'send_invoice' + default_payment_method?: string /** subscription_schedules_param */ invoice_settings?: { - days_until_due?: number; - } & { [key: string]: unknown }; + days_until_due?: number + } & { [key: string]: unknown } transfer_data?: (Partial< { - amount_percent?: number; - destination: string; + amount_percent?: number + destination: string } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown } /** * @description Configures how the subscription schedule behaves 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. * @enum {string} */ - end_behavior?: "cancel" | "none" | "release" | "renew"; + end_behavior?: 'cancel' | 'none' | 'release' | 'renew' /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls. */ - from_subscription?: string; + from_subscription?: string /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. */ phases?: ({ add_invoice_items?: ({ - price?: string; + price?: string /** one_time_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - } & { [key: string]: unknown }; - quantity?: number; - tax_rates?: (Partial & Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown })[]; - application_fee_percent?: number; + unit_amount_decimal?: string + } & { [key: string]: unknown } + quantity?: number + tax_rates?: (Partial & Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown })[] + application_fee_percent?: number /** automatic_tax_config */ automatic_tax?: { - enabled: boolean; - } & { [key: string]: unknown }; + enabled: boolean + } & { [key: string]: unknown } /** @enum {string} */ - billing_cycle_anchor?: "automatic" | "phase_start"; + billing_cycle_anchor?: 'automatic' | 'phase_start' billing_thresholds?: (Partial< { - amount_gte?: number; - reset_billing_cycle_anchor?: boolean; + amount_gte?: number + reset_billing_cycle_anchor?: boolean } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; - coupon?: string; - default_payment_method?: string; - default_tax_rates?: (Partial & Partial<"">) & { [key: string]: unknown }; + collection_method?: 'charge_automatically' | 'send_invoice' + coupon?: string + default_payment_method?: string + default_tax_rates?: (Partial & Partial<''>) & { [key: string]: unknown } /** Format: unix-time */ - end_date?: number; + end_date?: number /** subscription_schedules_param */ invoice_settings?: { - days_until_due?: number; - } & { [key: string]: unknown }; + days_until_due?: number + } & { [key: string]: unknown } items: ({ billing_thresholds?: (Partial< { - usage_gte: number; + usage_gte: number } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - price?: string; + Partial<''>) & { [key: string]: unknown } + price?: string /** recurring_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - } & { [key: string]: unknown }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } & { [key: string]: unknown } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - } & { [key: string]: unknown }; - quantity?: number; - tax_rates?: (Partial & Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown })[]; - iterations?: number; + unit_amount_decimal?: string + } & { [key: string]: unknown } + quantity?: number + tax_rates?: (Partial & Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown })[] + iterations?: number /** @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** transfer_data_specs */ transfer_data?: { - amount_percent?: number; - destination: string; - } & { [key: string]: unknown }; - trial?: boolean; + amount_percent?: number + destination: string + } & { [key: string]: unknown } + trial?: boolean /** Format: unix-time */ - trial_end?: number; - } & { [key: string]: unknown })[]; + trial_end?: number + } & { [key: string]: unknown })[] /** @description When the subscription schedule starts. We recommend using `now` so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on. */ - start_date?: (Partial & Partial<"now">) & { [key: string]: unknown }; - }; - }; - }; - }; + start_date?: (Partial & Partial<'now'>) & { [key: string]: unknown } + } + } + } + } /**

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.

*/ GetSubscriptionSchedulesSchedule: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - schedule: string; - }; - }; + schedule: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription_schedule"]; - }; - }; + 'application/json': components['schemas']['subscription_schedule'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates an existing subscription schedule.

*/ PostSubscriptionSchedulesSchedule: { parameters: { path: { - schedule: string; - }; - }; + schedule: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription_schedule"]; - }; - }; + 'application/json': components['schemas']['subscription_schedule'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * default_settings_params * @description Object representing the subscription schedule's default settings. */ default_settings?: { - application_fee_percent?: number; + application_fee_percent?: number /** automatic_tax_config */ automatic_tax?: { - enabled: boolean; - } & { [key: string]: unknown }; + enabled: boolean + } & { [key: string]: unknown } /** @enum {string} */ - billing_cycle_anchor?: "automatic" | "phase_start"; + billing_cycle_anchor?: 'automatic' | 'phase_start' billing_thresholds?: (Partial< { - amount_gte?: number; - reset_billing_cycle_anchor?: boolean; + amount_gte?: number + reset_billing_cycle_anchor?: boolean } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; - default_payment_method?: string; + collection_method?: 'charge_automatically' | 'send_invoice' + default_payment_method?: string /** subscription_schedules_param */ invoice_settings?: { - days_until_due?: number; - } & { [key: string]: unknown }; + days_until_due?: number + } & { [key: string]: unknown } transfer_data?: (Partial< { - amount_percent?: number; - destination: string; + amount_percent?: number + destination: string } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown } /** * @description Configures how the subscription schedule behaves 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. * @enum {string} */ - end_behavior?: "cancel" | "none" | "release" | "renew"; + end_behavior?: 'cancel' | 'none' | 'release' | 'renew' /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. Note that past phases can be omitted. */ phases?: ({ add_invoice_items?: ({ - price?: string; + price?: string /** one_time_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - } & { [key: string]: unknown }; - quantity?: number; - tax_rates?: (Partial & Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown })[]; - application_fee_percent?: number; + unit_amount_decimal?: string + } & { [key: string]: unknown } + quantity?: number + tax_rates?: (Partial & Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown })[] + application_fee_percent?: number /** automatic_tax_config */ automatic_tax?: { - enabled: boolean; - } & { [key: string]: unknown }; + enabled: boolean + } & { [key: string]: unknown } /** @enum {string} */ - billing_cycle_anchor?: "automatic" | "phase_start"; + billing_cycle_anchor?: 'automatic' | 'phase_start' billing_thresholds?: (Partial< { - amount_gte?: number; - reset_billing_cycle_anchor?: boolean; + amount_gte?: number + reset_billing_cycle_anchor?: boolean } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; - coupon?: string; - default_payment_method?: string; - default_tax_rates?: (Partial & Partial<"">) & { [key: string]: unknown }; - end_date?: (Partial & Partial<"now">) & { [key: string]: unknown }; + collection_method?: 'charge_automatically' | 'send_invoice' + coupon?: string + default_payment_method?: string + default_tax_rates?: (Partial & Partial<''>) & { [key: string]: unknown } + end_date?: (Partial & Partial<'now'>) & { [key: string]: unknown } /** subscription_schedules_param */ invoice_settings?: { - days_until_due?: number; - } & { [key: string]: unknown }; + days_until_due?: number + } & { [key: string]: unknown } items: ({ billing_thresholds?: (Partial< { - usage_gte: number; + usage_gte: number } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - price?: string; + Partial<''>) & { [key: string]: unknown } + price?: string /** recurring_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - } & { [key: string]: unknown }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } & { [key: string]: unknown } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - } & { [key: string]: unknown }; - quantity?: number; - tax_rates?: (Partial & Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown })[]; - iterations?: number; + unit_amount_decimal?: string + } & { [key: string]: unknown } + quantity?: number + tax_rates?: (Partial & Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown })[] + iterations?: number /** @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; - start_date?: (Partial & Partial<"now">) & { [key: string]: unknown }; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' + start_date?: (Partial & Partial<'now'>) & { [key: string]: unknown } /** transfer_data_specs */ transfer_data?: { - amount_percent?: number; - destination: string; - } & { [key: string]: unknown }; - trial?: boolean; - trial_end?: (Partial & Partial<"now">) & { [key: string]: unknown }; - } & { [key: string]: unknown })[]; + amount_percent?: number + destination: string + } & { [key: string]: unknown } + trial?: boolean + trial_end?: (Partial & Partial<'now'>) & { [key: string]: unknown } + } & { [key: string]: unknown })[] /** * @description If the update changes the current phase, indicates if the changes should be prorated. Possible values are `create_prorations` or `none`, and the default value is `create_prorations`. * @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; - }; - }; - }; - }; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' + } + } + } + } /**

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.

*/ PostSubscriptionSchedulesScheduleCancel: { parameters: { path: { - schedule: string; - }; - }; + schedule: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription_schedule"]; - }; - }; + 'application/json': components['schemas']['subscription_schedule'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Defaults to `true`. */ - invoice_now?: boolean; + invoice_now?: boolean /** @description If the subscription schedule is `active`, indicates if the cancellation should be prorated. Defaults to `true`. */ - prorate?: boolean; - }; - }; - }; - }; + prorate?: boolean + } + } + } + } /**

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.

*/ PostSubscriptionSchedulesScheduleRelease: { parameters: { path: { - schedule: string; - }; - }; + schedule: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription_schedule"]; - }; - }; + 'application/json': components['schemas']['subscription_schedule'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Keep any cancellation on the subscription that the schedule has set */ - preserve_cancel_date?: boolean; - }; - }; - }; - }; + preserve_cancel_date?: boolean + } + } + } + } /**

By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.

*/ GetSubscriptions: { parameters: { query: { /** The collection method of the subscriptions to retrieve. Either `charge_automatically` or `send_invoice`. */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' created?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } current_period_end?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } current_period_start?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** The ID of the customer whose subscriptions will be retrieved. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Filter for subscriptions that contain this recurring price ID. */ - price?: string; + price?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** 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?: - | "active" - | "all" - | "canceled" - | "ended" - | "incomplete" - | "incomplete_expired" - | "past_due" - | "trialing" - | "unpaid"; - }; - }; + status?: 'active' | 'all' | 'canceled' | 'ended' | 'incomplete' | 'incomplete_expired' | 'past_due' | 'trialing' | 'unpaid' + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["subscription"][]; + 'application/json': { + data: components['schemas']['subscription'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.

*/ PostSubscriptions: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription"]; - }; - }; + 'application/json': components['schemas']['subscription'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A list of prices and quantities that will generate invoice items appended to the first invoice for this subscription. You may pass up to 20 items. */ add_invoice_items?: ({ - price?: string; + price?: string /** one_time_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - } & { [key: string]: unknown }; - quantity?: number; - tax_rates?: (Partial & Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown })[]; + unit_amount_decimal?: string + } & { [key: string]: unknown } + quantity?: number + tax_rates?: (Partial & Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown })[] /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). */ - application_fee_percent?: number; + application_fee_percent?: number /** * automatic_tax_config * @description Automatic tax settings for this subscription. */ automatic_tax?: { - enabled: boolean; - } & { [key: string]: unknown }; + enabled: boolean + } & { [key: string]: unknown } /** * Format: unix-time * @description For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor. */ - backdate_start_date?: number; + backdate_start_date?: number /** * Format: unix-time * @description 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. */ - billing_cycle_anchor?: number; + billing_cycle_anchor?: number /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. */ billing_thresholds?: (Partial< { - amount_gte?: number; - reset_billing_cycle_anchor?: boolean; + amount_gte?: number + reset_billing_cycle_anchor?: boolean } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** * Format: unix-time * @description 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. */ - cancel_at?: number; + cancel_at?: number /** @description Boolean indicating whether this subscription should cancel at the end of the current period. */ - cancel_at_period_end?: boolean; + cancel_at_period_end?: boolean /** * @description 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. Defaults to `charge_automatically`. * @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' /** @description The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. */ - coupon?: string; + coupon?: string /** @description The identifier of the customer to subscribe. */ - customer: string; + customer: string /** @description Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. */ - days_until_due?: number; + days_until_due?: number /** @description 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?: string; + default_payment_method?: string /** @description 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?: string; + default_source?: string /** @description 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?: (Partial & Partial<"">) & { [key: string]: unknown }; + default_tax_rates?: (Partial & Partial<''>) & { [key: string]: unknown } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A list of up to 20 subscription items, each with an attached price. */ items?: ({ billing_thresholds?: (Partial< { - usage_gte: number; + usage_gte: number } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - metadata?: { [key: string]: string }; - price?: string; + Partial<''>) & { [key: string]: unknown } + metadata?: { [key: string]: string } + price?: string /** recurring_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - } & { [key: string]: unknown }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } & { [key: string]: unknown } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - } & { [key: string]: unknown }; - quantity?: number; - tax_rates?: (Partial & Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown })[]; + unit_amount_decimal?: string + } & { [key: string]: unknown } + quantity?: number + tax_rates?: (Partial & Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown })[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. */ - off_session?: boolean; + off_session?: boolean /** * @description Use `allow_incomplete` to create subscriptions with `status=incomplete` if the first invoice cannot be paid. Creating subscriptions with this status allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * @@ -42333,11 +41731,7 @@ export interface operations { * `pending_if_incomplete` is only used with updates and cannot be passed when creating a subscription. * @enum {string} */ - payment_behavior?: - | "allow_incomplete" - | "default_incomplete" - | "error_if_incomplete" - | "pending_if_incomplete"; + payment_behavior?: 'allow_incomplete' | 'default_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete' /** * payment_settings * @description Payment settings to pass to invoices created by the subscription. @@ -42350,252 +41744,252 @@ export interface operations { /** mandate_options_param */ mandate_options?: { /** @enum {string} */ - transaction_type?: "business" | "personal"; - } & { [key: string]: unknown }; + transaction_type?: 'business' | 'personal' + } & { [key: string]: unknown } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; + verification_method?: 'automatic' | 'instant' | 'microdeposits' } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } bancontact?: (Partial< { /** @enum {string} */ - preferred_language?: "de" | "en" | "fr" | "nl"; + preferred_language?: 'de' | 'en' | 'fr' | 'nl' } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } card?: (Partial< { /** mandate_options_param */ mandate_options?: { - amount?: number; + amount?: number /** @enum {string} */ - amount_type?: "fixed" | "maximum"; - description?: string; - } & { [key: string]: unknown }; + amount_type?: 'fixed' | 'maximum' + description?: string + } & { [key: string]: unknown } /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: 'any' | 'automatic' } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown } payment_method_types?: (Partial< ( - | "ach_credit_transfer" - | "ach_debit" - | "acss_debit" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "sepa_debit" - | "sofort" - | "wechat_pay" + | 'ach_credit_transfer' + | 'ach_debit' + | 'acss_debit' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' )[] > & - Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown } /** @description 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?: (Partial< { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** @description The API ID of a promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. */ - promotion_code?: string; + promotion_code?: string /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) resulting from the `billing_cycle_anchor`. Valid values are `create_prorations` or `none`. * * Passing `create_prorations` will cause proration invoice items to be created when applicable. Prorations can be disabled by passing `none`. If no value is passed, the default is `create_prorations`. * @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** * transfer_data_specs * @description If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. */ transfer_data?: { - amount_percent?: number; - destination: string; - } & { [key: string]: unknown }; + amount_percent?: number + destination: string + } & { [key: string]: unknown } /** @description Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. */ - trial_end?: (Partial<"now"> & Partial) & { [key: string]: unknown }; + trial_end?: (Partial<'now'> & Partial) & { [key: string]: unknown } /** @description 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?: boolean; + trial_from_plan?: boolean /** @description Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. */ - trial_period_days?: number; - }; - }; - }; - }; + trial_period_days?: number + } + } + } + } /**

Retrieves the subscription with the given ID.

*/ GetSubscriptionsSubscriptionExposedId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - subscription_exposed_id: string; - }; - }; + subscription_exposed_id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription"]; - }; - }; + 'application/json': components['schemas']['subscription'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostSubscriptionsSubscriptionExposedId: { parameters: { path: { - subscription_exposed_id: string; - }; - }; + subscription_exposed_id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription"]; - }; - }; + 'application/json': components['schemas']['subscription'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A list of prices and quantities that will generate invoice items appended to the first invoice for this subscription. You may pass up to 20 items. */ add_invoice_items?: ({ - price?: string; + price?: string /** one_time_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - } & { [key: string]: unknown }; - quantity?: number; - tax_rates?: (Partial & Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown })[]; + unit_amount_decimal?: string + } & { [key: string]: unknown } + quantity?: number + tax_rates?: (Partial & Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown })[] /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). */ - application_fee_percent?: number; + application_fee_percent?: number /** * automatic_tax_config * @description Automatic tax settings for this subscription. */ automatic_tax?: { - enabled: boolean; - } & { [key: string]: unknown }; + enabled: boolean + } & { [key: string]: unknown } /** * @description Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). * @enum {string} */ - billing_cycle_anchor?: "now" | "unchanged"; + billing_cycle_anchor?: 'now' | 'unchanged' /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. */ billing_thresholds?: (Partial< { - amount_gte?: number; - reset_billing_cycle_anchor?: boolean; + amount_gte?: number + reset_billing_cycle_anchor?: boolean } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** @description 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. */ - cancel_at?: (Partial & Partial<"">) & { [key: string]: unknown }; + cancel_at?: (Partial & Partial<''>) & { [key: string]: unknown } /** @description Boolean indicating whether this subscription should cancel at the end of the current period. */ - cancel_at_period_end?: boolean; + cancel_at_period_end?: boolean /** * @description 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. Defaults to `charge_automatically`. * @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' /** @description The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. */ - coupon?: string; + coupon?: string /** @description Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. */ - days_until_due?: number; + days_until_due?: number /** @description 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?: string; + default_payment_method?: string /** @description 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?: string; + default_source?: string /** @description 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. Pass an empty string to remove previously-defined tax rates. */ - default_tax_rates?: (Partial & Partial<"">) & { [key: string]: unknown }; + default_tax_rates?: (Partial & Partial<''>) & { [key: string]: unknown } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A list of up to 20 subscription items, each with an attached price. */ items?: ({ billing_thresholds?: (Partial< { - usage_gte: number; + usage_gte: number } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - clear_usage?: boolean; - deleted?: boolean; - id?: string; - metadata?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; - price?: string; + Partial<''>) & { [key: string]: unknown } + clear_usage?: boolean + deleted?: boolean + id?: string + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } + price?: string /** recurring_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - } & { [key: string]: unknown }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } & { [key: string]: unknown } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - } & { [key: string]: unknown }; - quantity?: number; - tax_rates?: (Partial & Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown })[]; + unit_amount_decimal?: string + } & { [key: string]: unknown } + quantity?: number + tax_rates?: (Partial & Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown })[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. */ - off_session?: boolean; + off_session?: boolean /** @description If specified, payment collection for this subscription will be paused. */ pause_collection?: (Partial< { /** @enum {string} */ - behavior: "keep_as_draft" | "mark_uncollectible" | "void"; + behavior: 'keep_as_draft' | 'mark_uncollectible' | 'void' /** Format: unix-time */ - resumes_at?: number; + resumes_at?: number } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** * @description Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * @@ -42606,11 +42000,7 @@ export interface operations { * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. * @enum {string} */ - payment_behavior?: - | "allow_incomplete" - | "default_incomplete" - | "error_if_incomplete" - | "pending_if_incomplete"; + payment_behavior?: 'allow_incomplete' | 'default_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete' /** * payment_settings * @description Payment settings to pass to invoices created by the subscription. @@ -42623,67 +42013,67 @@ export interface operations { /** mandate_options_param */ mandate_options?: { /** @enum {string} */ - transaction_type?: "business" | "personal"; - } & { [key: string]: unknown }; + transaction_type?: 'business' | 'personal' + } & { [key: string]: unknown } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; + verification_method?: 'automatic' | 'instant' | 'microdeposits' } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } bancontact?: (Partial< { /** @enum {string} */ - preferred_language?: "de" | "en" | "fr" | "nl"; + preferred_language?: 'de' | 'en' | 'fr' | 'nl' } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } card?: (Partial< { /** mandate_options_param */ mandate_options?: { - amount?: number; + amount?: number /** @enum {string} */ - amount_type?: "fixed" | "maximum"; - description?: string; - } & { [key: string]: unknown }; + amount_type?: 'fixed' | 'maximum' + description?: string + } & { [key: string]: unknown } /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: 'any' | 'automatic' } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown } payment_method_types?: (Partial< ( - | "ach_credit_transfer" - | "ach_debit" - | "acss_debit" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "sepa_debit" - | "sofort" - | "wechat_pay" + | 'ach_credit_transfer' + | 'ach_debit' + | 'acss_debit' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' )[] > & - Partial<"">) & { [key: string]: unknown }; - } & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } + } & { [key: string]: unknown } /** @description 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?: (Partial< { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** @description The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. */ - promotion_code?: string; + promotion_code?: string /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -42692,28 +42082,28 @@ export interface operations { * Prorations can be disabled by passing `none`. * @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** * Format: unix-time * @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations. */ - proration_date?: number; + proration_date?: number /** @description If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. This will be unset if you POST an empty value. */ transfer_data?: (Partial< { - amount_percent?: number; - destination: string; + amount_percent?: number + destination: string } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** @description Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. */ - trial_end?: (Partial<"now"> & Partial) & { [key: string]: unknown }; + trial_end?: (Partial<'now'> & Partial) & { [key: string]: unknown } /** @description 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?: boolean; - }; - }; - }; - }; + trial_from_plan?: boolean + } + } + } + } /** *

Cancels a customer’s subscription immediately. The customer will not be charged again for the subscription.

* @@ -42724,398 +42114,398 @@ export interface operations { DeleteSubscriptionsSubscriptionExposedId: { parameters: { path: { - subscription_exposed_id: string; - }; - }; + subscription_exposed_id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription"]; - }; - }; + 'application/json': components['schemas']['subscription'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items. */ - invoice_now?: boolean; + invoice_now?: boolean /** @description Will generate a proration invoice item that credits remaining unused time until the subscription period end. */ - prorate?: boolean; - }; - }; - }; - }; + prorate?: boolean + } + } + } + } /**

Removes the currently applied discount on a subscription.

*/ DeleteSubscriptionsSubscriptionExposedIdDiscount: { parameters: { path: { - subscription_exposed_id: string; - }; - }; + subscription_exposed_id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_discount"]; - }; - }; + 'application/json': components['schemas']['deleted_discount'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

A list of all tax codes available to add to Products in order to allow specific tax calculations.

*/ GetTaxCodes: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["tax_code"][]; + 'application/json': { + data: components['schemas']['tax_code'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves the details of an existing tax code. Supply the unique tax code ID and Stripe will return the corresponding tax code information.

*/ GetTaxCodesId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["tax_code"]; - }; - }; + 'application/json': components['schemas']['tax_code'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ GetTaxRates: { parameters: { query: { /** Optional flag to filter by tax rates that are either active or inactive (archived). */ - active?: boolean; + active?: boolean /** Optional range for filtering created date. */ created?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** Optional flag to filter by tax rates that are inclusive (or those that are not inclusive). */ - inclusive?: boolean; + inclusive?: boolean /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["tax_rate"][]; + 'application/json': { + data: components['schemas']['tax_rate'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new tax rate.

*/ PostTaxRates: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["tax_rate"]; - }; - }; + 'application/json': components['schemas']['tax_rate'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Flag determining whether the tax rate is active or inactive (archived). Inactive tax rates cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set. */ - active?: boolean; + active?: boolean /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ - country?: string; + country?: string /** @description An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. */ - description?: string; + description?: string /** @description The display name of the tax rate, which will be shown to users. */ - display_name: string; + display_name: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description This specifies if the tax rate is inclusive or exclusive. */ - inclusive: boolean; + inclusive: boolean /** @description 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?: string; + jurisdiction?: string /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description This represents the tax rate percent out of 100. */ - percentage: number; + percentage: number /** @description [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States. */ - state?: string; + state?: string /** * @description The high-level tax type, such as `vat` or `sales_tax`. * @enum {string} */ - tax_type?: "gst" | "hst" | "jct" | "pst" | "qst" | "rst" | "sales_tax" | "vat"; - }; - }; - }; - }; + tax_type?: 'gst' | 'hst' | 'jct' | 'pst' | 'qst' | 'rst' | 'sales_tax' | 'vat' + } + } + } + } /**

Retrieves a tax rate with the given ID

*/ GetTaxRatesTaxRate: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - tax_rate: string; - }; - }; + tax_rate: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["tax_rate"]; - }; - }; + 'application/json': components['schemas']['tax_rate'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates an existing tax rate.

*/ PostTaxRatesTaxRate: { parameters: { path: { - tax_rate: string; - }; - }; + tax_rate: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["tax_rate"]; - }; - }; + 'application/json': components['schemas']['tax_rate'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Flag determining whether the tax rate is active or inactive (archived). Inactive tax rates cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set. */ - active?: boolean; + active?: boolean /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ - country?: string; + country?: string /** @description An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. */ - description?: string; + description?: string /** @description The display name of the tax rate, which will be shown to users. */ - display_name?: string; + display_name?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: string; + jurisdiction?: string /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States. */ - state?: string; + state?: string /** * @description The high-level tax type, such as `vat` or `sales_tax`. * @enum {string} */ - tax_type?: "gst" | "hst" | "jct" | "pst" | "qst" | "rst" | "sales_tax" | "vat"; - }; - }; - }; - }; + tax_type?: 'gst' | 'hst' | 'jct' | 'pst' | 'qst' | 'rst' | 'sales_tax' | 'vat' + } + } + } + } /**

To connect to a reader the Stripe Terminal SDK needs to retrieve a short-lived connection token from Stripe, proxied through your server. On your backend, add an endpoint that creates and returns a connection token.

*/ PostTerminalConnectionTokens: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["terminal.connection_token"]; - }; - }; + 'application/json': components['schemas']['terminal.connection_token'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The id of the location that this connection token is scoped to. If specified the connection token will only be usable with readers assigned to that location, otherwise the connection token will be usable with all readers. Note that location scoping only applies to internet-connected readers. For more details, see [the docs on scoping connection tokens](https://stripe.com/docs/terminal/fleet/locations#connection-tokens). */ - location?: string; - }; - }; - }; - }; + location?: string + } + } + } + } /**

Returns a list of Location objects.

*/ GetTerminalLocations: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["terminal.location"][]; + 'application/json': { + data: components['schemas']['terminal.location'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Creates a new Location object. * For further details, including which address fields are required in each country, see the Manage locations guide.

@@ -43125,324 +42515,326 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["terminal.location"]; - }; - }; + 'application/json': components['schemas']['terminal.location'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * create_location_address_param * @description The full address of the location. */ address: { - city?: string; - country: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - } & { [key: string]: unknown }; + city?: string + country: string + line1?: string + line2?: string + postal_code?: string + state?: string + } & { [key: string]: unknown } /** @description A name for the location. */ - display_name: string; + display_name: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; - }; - }; - }; - }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } + } + } + } + } /**

Retrieves a Location object.

*/ GetTerminalLocationsLocation: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - location: string; - }; - }; + location: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["terminal.location"]; - }; - }; + 'application/json': components['schemas']['terminal.location'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates a Location object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ PostTerminalLocationsLocation: { parameters: { path: { - location: string; - }; - }; + location: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["terminal.location"]; - }; - }; + 'application/json': components['schemas']['terminal.location'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * optional_fields_address * @description The full address of the location. */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } & { [key: string]: unknown } /** @description A name for the location. */ - display_name?: string; + display_name?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; - }; - }; - }; - }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } + } + } + } + } /**

Deletes a Location object.

*/ DeleteTerminalLocationsLocation: { parameters: { path: { - location: string; - }; - }; + location: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_terminal.location"]; - }; - }; + 'application/json': components['schemas']['deleted_terminal.location'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of Reader objects.

*/ GetTerminalReaders: { parameters: { query: { /** Filters readers by device type */ - device_type?: "bbpos_chipper2x" | "bbpos_wisepos_e" | "verifone_P400"; + device_type?: 'bbpos_chipper2x' | 'bbpos_wisepos_e' | 'verifone_P400' /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A location ID to filter the response list to only readers at the specific location */ - location?: string; + location?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** A status filter to filter readers to only offline or online readers */ - status?: "offline" | "online"; - }; - }; + status?: 'offline' | 'online' + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description A list of readers */ - data: components["schemas"]["terminal.reader"][]; + data: components['schemas']['terminal.reader'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new Reader object.

*/ PostTerminalReaders: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["terminal.reader"]; - }; - }; + 'application/json': components['schemas']['terminal.reader'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Custom label given to the reader for easier identification. If no label is specified, the registration code will be used. */ - label?: string; + label?: string /** @description The location to assign the reader to. */ - location?: string; + location?: string /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description A code generated by the reader used for registering to an account. */ - registration_code: string; - }; - }; - }; - }; + registration_code: string + } + } + } + } /**

Retrieves a Reader object.

*/ GetTerminalReadersReader: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - reader: string; - }; - }; + reader: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": (Partial & - Partial) & { [key: string]: unknown }; - }; - }; + 'application/json': (Partial & Partial) & { + [key: string]: unknown + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ PostTerminalReadersReader: { parameters: { path: { - reader: string; - }; - }; + reader: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": (Partial & - Partial) & { [key: string]: unknown }; - }; - }; + 'application/json': (Partial & Partial) & { + [key: string]: unknown + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The new label of the reader. */ - label?: string; + label?: string /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; - }; - }; - }; - }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } + } + } + } + } /**

Deletes a Reader object.

*/ DeleteTerminalReadersReader: { parameters: { path: { - reader: string; - }; - }; + reader: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_terminal.reader"]; - }; - }; + 'application/json': components['schemas']['deleted_terminal.reader'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Creates a single-use token that represents a bank account’s details. * This token can be used with any API method in place of a bank account dictionary. This token can be used only once, by attaching it to a Custom account.

@@ -43452,222 +42844,222 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["token"]; - }; - }; + 'application/json': components['schemas']['token'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * connect_js_account_token_specs * @description Information for the account this token will represent. */ account?: { /** @enum {string} */ - business_type?: "company" | "government_entity" | "individual" | "non_profit"; + business_type?: 'company' | 'government_entity' | 'individual' | 'non_profit' /** connect_js_account_token_company_specs */ company?: { /** address_specs */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } & { [key: string]: unknown } /** japan_address_kana_specs */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } & { [key: string]: unknown } /** japan_address_kanji_specs */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - } & { [key: string]: unknown }; - directors_provided?: boolean; - executives_provided?: boolean; - name?: string; - name_kana?: string; - name_kanji?: string; - owners_provided?: boolean; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } & { [key: string]: unknown } + directors_provided?: boolean + executives_provided?: boolean + name?: string + name_kana?: string + name_kanji?: string + owners_provided?: boolean /** company_ownership_declaration */ ownership_declaration?: { /** Format: unix-time */ - date?: number; - ip?: string; - user_agent?: string; - } & { [key: string]: unknown }; - ownership_declaration_shown_and_signed?: boolean; - phone?: string; - registration_number?: string; + date?: number + ip?: string + user_agent?: string + } & { [key: string]: unknown } + ownership_declaration_shown_and_signed?: boolean + phone?: string + registration_number?: string /** @enum {string} */ structure?: - | "" - | "free_zone_establishment" - | "free_zone_llc" - | "government_instrumentality" - | "governmental_unit" - | "incorporated_non_profit" - | "limited_liability_partnership" - | "llc" - | "multi_member_llc" - | "private_company" - | "private_corporation" - | "private_partnership" - | "public_company" - | "public_corporation" - | "public_partnership" - | "single_member_llc" - | "sole_establishment" - | "sole_proprietorship" - | "tax_exempt_government_instrumentality" - | "unincorporated_association" - | "unincorporated_non_profit"; - tax_id?: string; - tax_id_registrar?: string; - vat_id?: string; + | '' + | 'free_zone_establishment' + | 'free_zone_llc' + | 'government_instrumentality' + | 'governmental_unit' + | 'incorporated_non_profit' + | 'limited_liability_partnership' + | 'llc' + | 'multi_member_llc' + | 'private_company' + | 'private_corporation' + | 'private_partnership' + | 'public_company' + | 'public_corporation' + | 'public_partnership' + | 'single_member_llc' + | 'sole_establishment' + | 'sole_proprietorship' + | 'tax_exempt_government_instrumentality' + | 'unincorporated_association' + | 'unincorporated_non_profit' + tax_id?: string + tax_id_registrar?: string + vat_id?: string /** verification_specs */ verification?: { /** verification_document_specs */ document?: { - back?: string; - front?: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + back?: string + front?: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** individual_specs */ individual?: { /** address_specs */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } & { [key: string]: unknown } /** japan_address_kana_specs */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } & { [key: string]: unknown } /** japan_address_kanji_specs */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } & { [key: string]: unknown } dob?: (Partial< { - day: number; - month: number; - year: number; + day: number + month: number + year: number } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; - email?: string; - first_name?: string; - first_name_kana?: string; - first_name_kanji?: string; - full_name_aliases?: (Partial & Partial<"">) & { [key: string]: unknown }; - gender?: string; - id_number?: string; - last_name?: string; - last_name_kana?: string; - last_name_kanji?: string; - maiden_name?: string; - metadata?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; - phone?: string; + Partial<''>) & { [key: string]: unknown } + email?: string + first_name?: string + first_name_kana?: string + first_name_kanji?: string + full_name_aliases?: (Partial & Partial<''>) & { [key: string]: unknown } + gender?: string + id_number?: string + last_name?: string + last_name_kana?: string + last_name_kanji?: string + maiden_name?: string + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } + phone?: string /** @enum {string} */ - political_exposure?: "existing" | "none"; - ssn_last_4?: string; + political_exposure?: 'existing' | 'none' + ssn_last_4?: string /** person_verification_specs */ verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - } & { [key: string]: unknown }; + back?: string + front?: string + } & { [key: string]: unknown } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; - tos_shown_and_accepted?: boolean; - } & { [key: string]: unknown }; + back?: string + front?: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } + } & { [key: string]: unknown } + tos_shown_and_accepted?: boolean + } & { [key: string]: unknown } /** * token_create_bank_account * @description The bank account this token will represent. */ bank_account?: { - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; + account_holder_type?: 'company' | 'individual' + account_number: string /** @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; - country: string; - currency?: string; - routing_number?: string; - } & { [key: string]: unknown }; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' + country: string + currency?: string + routing_number?: string + } & { [key: string]: unknown } card?: (Partial< { - address_city?: string; - address_country?: string; - address_line1?: string; - address_line2?: string; - address_state?: string; - address_zip?: string; - currency?: string; - cvc?: string; - exp_month: string; - exp_year: string; - name?: string; - number: string; + address_city?: string + address_country?: string + address_line1?: string + address_line2?: string + address_state?: string + address_zip?: string + currency?: string + cvc?: string + exp_month: string + exp_year: string + name?: string + number: string } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** @description The customer (owned by the application's account) for which to create a token. This can be used only with an [OAuth access token](https://stripe.com/docs/connect/standard-accounts) or [Stripe-Account header](https://stripe.com/docs/connect/authentication). For more details, see [Cloning Saved Payment Methods](https://stripe.com/docs/connect/cloning-saved-payment-methods). */ - customer?: string; + customer?: string /** * cvc_params * @description The updated CVC value this token will represent. */ cvc_update?: { - cvc: string; - } & { [key: string]: unknown }; + cvc: string + } & { [key: string]: unknown } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * person_token_specs * @description Information for the person this token will represent. @@ -43675,137 +43067,137 @@ export interface operations { person?: { /** address_specs */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } & { [key: string]: unknown } /** japan_address_kana_specs */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } & { [key: string]: unknown } /** japan_address_kanji_specs */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - } & { [key: string]: unknown }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } & { [key: string]: unknown } dob?: (Partial< { - day: number; - month: number; - year: number; + day: number + month: number + year: number } & { [key: string]: unknown } > & - Partial<"">) & { [key: string]: unknown }; + Partial<''>) & { [key: string]: unknown } /** person_documents_specs */ documents?: { /** documents_param */ company_authorization?: { - files?: string[]; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } /** documents_param */ passport?: { - files?: string[]; - } & { [key: string]: unknown }; + files?: string[] + } & { [key: string]: unknown } /** documents_param */ visa?: { - files?: string[]; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; - email?: string; - first_name?: string; - first_name_kana?: string; - first_name_kanji?: string; - full_name_aliases?: (Partial & Partial<"">) & { [key: string]: unknown }; - gender?: string; - id_number?: string; - last_name?: string; - last_name_kana?: string; - last_name_kanji?: string; - maiden_name?: string; - metadata?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; - nationality?: string; - phone?: string; - political_exposure?: string; + files?: string[] + } & { [key: string]: unknown } + } & { [key: string]: unknown } + email?: string + first_name?: string + first_name_kana?: string + first_name_kanji?: string + full_name_aliases?: (Partial & Partial<''>) & { [key: string]: unknown } + gender?: string + id_number?: string + last_name?: string + last_name_kana?: string + last_name_kanji?: string + maiden_name?: string + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } + nationality?: string + phone?: string + political_exposure?: string /** relationship_specs */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - percent_ownership?: (Partial & Partial<"">) & { [key: string]: unknown }; - representative?: boolean; - title?: string; - } & { [key: string]: unknown }; - ssn_last_4?: string; + director?: boolean + executive?: boolean + owner?: boolean + percent_ownership?: (Partial & Partial<''>) & { [key: string]: unknown } + representative?: boolean + title?: string + } & { [key: string]: unknown } + ssn_last_4?: string /** person_verification_specs */ verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - } & { [key: string]: unknown }; + back?: string + front?: string + } & { [key: string]: unknown } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; - } & { [key: string]: unknown }; + back?: string + front?: string + } & { [key: string]: unknown } + } & { [key: string]: unknown } + } & { [key: string]: unknown } /** * pii_token_specs * @description The PII this token will represent. */ pii?: { - id_number?: string; - } & { [key: string]: unknown }; - }; - }; - }; - }; + id_number?: string + } & { [key: string]: unknown } + } + } + } + } /**

Retrieves the token with the given ID.

*/ GetTokensToken: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - token: string; - }; - }; + token: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["token"]; - }; - }; + 'application/json': components['schemas']['token'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of top-ups.

*/ GetTopups: { parameters: { @@ -43813,352 +43205,352 @@ export interface operations { /** A positive integer representing how much to transfer. */ amount?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** 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?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return top-ups that have the given status. One of `canceled`, `failed`, `pending` or `succeeded`. */ - status?: "canceled" | "failed" | "pending" | "succeeded"; - }; - }; + status?: 'canceled' | 'failed' | 'pending' | 'succeeded' + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["topup"][]; + 'application/json': { + data: components['schemas']['topup'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Top up the balance of an account

*/ PostTopups: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["topup"]; - }; - }; + 'application/json': components['schemas']['topup'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A positive integer representing how much to transfer. */ - amount: number; + amount: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description The ID of a source to transfer funds from. For most users, this should be left unspecified which will use the bank account that was set up in the dashboard for the specified currency. In test mode, this can be a test bank token (see [Testing Top-ups](https://stripe.com/docs/connect/testing#testing-top-ups)). */ - source?: string; + source?: string /** @description Extra information about a top-up for the source's bank statement. Limited to 15 ASCII characters. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description A string that identifies this top-up as part of a group. */ - transfer_group?: string; - }; - }; - }; - }; + transfer_group?: string + } + } + } + } /**

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.

*/ GetTopupsTopup: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - topup: string; - }; - }; + topup: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["topup"]; - }; - }; + 'application/json': components['schemas']['topup'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates the metadata of a top-up. Other top-up details are not editable by design.

*/ PostTopupsTopup: { parameters: { path: { - topup: string; - }; - }; + topup: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["topup"]; - }; - }; + 'application/json': components['schemas']['topup'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; - }; - }; - }; - }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } + } + } + } + } /**

Cancels a top-up. Only pending top-ups can be canceled.

*/ PostTopupsTopupCancel: { parameters: { path: { - topup: string; - }; - }; + topup: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["topup"]; - }; - }; + 'application/json': components['schemas']['topup'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

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.

*/ GetTransfers: { parameters: { query: { created?: (Partial< { - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number } & { [key: string]: unknown } > & - Partial) & { [key: string]: unknown }; + Partial) & { [key: string]: unknown } /** Only return transfers for the destination specified by this account ID. */ - destination?: string; + destination?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return transfers with the specified transfer group. */ - transfer_group?: string; - }; - }; + transfer_group?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["transfer"][]; + data: components['schemas']['transfer'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostTransfers: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["transfer"]; - }; - }; + 'application/json': components['schemas']['transfer'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A positive integer in %s representing how much to transfer. */ - amount?: number; + amount?: number /** @description 3-letter [ISO code for currency](https://stripe.com/docs/payouts). */ - currency: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description The ID of a connected Stripe account. See the Connect documentation for details. */ - destination: string; + destination: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description You can use this parameter to transfer funds from a charge before they are added to your available balance. A pending balance will transfer immediately but the funds will not become available until the original charge becomes available. [See the Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-availability) for details. */ - source_transaction?: string; + source_transaction?: string /** * @description The source balance to use for this transfer. One of `bank_account`, `card`, or `fpx`. For most users, this will default to `card`. * @enum {string} */ - source_type?: "bank_account" | "card" | "fpx"; + source_type?: 'bank_account' | 'card' | 'fpx' /** @description A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-options) for details. */ - transfer_group?: string; - }; - }; - }; - }; + transfer_group?: string + } + } + } + } /**

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.

*/ GetTransfersIdReversals: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["transfer_reversal"][]; + data: components['schemas']['transfer_reversal'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

When you create a new reversal, you must specify a transfer to create it on.

* @@ -44169,71 +43561,71 @@ export interface operations { PostTransfersIdReversals: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["transfer_reversal"]; - }; - }; + 'application/json': components['schemas']['transfer_reversal'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A positive integer in %s representing how much of this transfer to reverse. Can only reverse up to the unreversed amount remaining of the transfer. Partial transfer reversals are only allowed for transfers to Stripe Accounts. Defaults to the entire transfer amount. */ - amount?: number; + amount?: number /** @description An arbitrary string which you can attach to a reversal object. It is displayed alongside the reversal in the Dashboard. This will be unset if you POST an empty value. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description Boolean indicating whether the application fee should be refunded when reversing this transfer. If a full transfer reversal is given, the full application fee will be refunded. Otherwise, the application fee will be refunded with an amount proportional to the amount of the transfer reversed. */ - refund_application_fee?: boolean; - }; - }; - }; - }; + refund_application_fee?: boolean + } + } + } + } /**

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.

*/ GetTransfersTransfer: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - transfer: string; - }; - }; + transfer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["transfer"]; - }; - }; + 'application/json': components['schemas']['transfer'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

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

* @@ -44242,68 +43634,68 @@ export interface operations { PostTransfersTransfer: { parameters: { path: { - transfer: string; - }; - }; + transfer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["transfer"]; - }; - }; + 'application/json': components['schemas']['transfer'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; - }; - }; - }; - }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } + } + } + } + } /**

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.

*/ GetTransfersTransferReversalsId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - transfer: string; - }; - }; + id: string + transfer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["transfer_reversal"]; - }; - }; + 'application/json': components['schemas']['transfer_reversal'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

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

* @@ -44312,676 +43704,676 @@ export interface operations { PostTransfersTransferReversalsId: { parameters: { path: { - id: string; - transfer: string; - }; - }; + id: string + transfer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["transfer_reversal"]; - }; - }; + 'application/json': components['schemas']['transfer_reversal'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; - }; - }; - }; - }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } + } + } + } + } /**

Returns a list of your webhook endpoints.

*/ GetWebhookEndpoints: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["webhook_endpoint"][]; + 'application/json': { + data: components['schemas']['webhook_endpoint'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } & { [key: string]: unknown }; - }; - }; + url: string + } & { [key: string]: unknown } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostWebhookEndpoints: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["webhook_endpoint"]; - }; - }; + 'application/json': components['schemas']['webhook_endpoint'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * @description Events sent to this endpoint will be generated with this Stripe Version instead of your account's default Stripe Version. * @enum {string} */ api_version?: - | "2011-01-01" - | "2011-06-21" - | "2011-06-28" - | "2011-08-01" - | "2011-09-15" - | "2011-11-17" - | "2012-02-23" - | "2012-03-25" - | "2012-06-18" - | "2012-06-28" - | "2012-07-09" - | "2012-09-24" - | "2012-10-26" - | "2012-11-07" - | "2013-02-11" - | "2013-02-13" - | "2013-07-05" - | "2013-08-12" - | "2013-08-13" - | "2013-10-29" - | "2013-12-03" - | "2014-01-31" - | "2014-03-13" - | "2014-03-28" - | "2014-05-19" - | "2014-06-13" - | "2014-06-17" - | "2014-07-22" - | "2014-07-26" - | "2014-08-04" - | "2014-08-20" - | "2014-09-08" - | "2014-10-07" - | "2014-11-05" - | "2014-11-20" - | "2014-12-08" - | "2014-12-17" - | "2014-12-22" - | "2015-01-11" - | "2015-01-26" - | "2015-02-10" - | "2015-02-16" - | "2015-02-18" - | "2015-03-24" - | "2015-04-07" - | "2015-06-15" - | "2015-07-07" - | "2015-07-13" - | "2015-07-28" - | "2015-08-07" - | "2015-08-19" - | "2015-09-03" - | "2015-09-08" - | "2015-09-23" - | "2015-10-01" - | "2015-10-12" - | "2015-10-16" - | "2016-02-03" - | "2016-02-19" - | "2016-02-22" - | "2016-02-23" - | "2016-02-29" - | "2016-03-07" - | "2016-06-15" - | "2016-07-06" - | "2016-10-19" - | "2017-01-27" - | "2017-02-14" - | "2017-04-06" - | "2017-05-25" - | "2017-06-05" - | "2017-08-15" - | "2017-12-14" - | "2018-01-23" - | "2018-02-05" - | "2018-02-06" - | "2018-02-28" - | "2018-05-21" - | "2018-07-27" - | "2018-08-23" - | "2018-09-06" - | "2018-09-24" - | "2018-10-31" - | "2018-11-08" - | "2019-02-11" - | "2019-02-19" - | "2019-03-14" - | "2019-05-16" - | "2019-08-14" - | "2019-09-09" - | "2019-10-08" - | "2019-10-17" - | "2019-11-05" - | "2019-12-03" - | "2020-03-02" - | "2020-08-27"; + | '2011-01-01' + | '2011-06-21' + | '2011-06-28' + | '2011-08-01' + | '2011-09-15' + | '2011-11-17' + | '2012-02-23' + | '2012-03-25' + | '2012-06-18' + | '2012-06-28' + | '2012-07-09' + | '2012-09-24' + | '2012-10-26' + | '2012-11-07' + | '2013-02-11' + | '2013-02-13' + | '2013-07-05' + | '2013-08-12' + | '2013-08-13' + | '2013-10-29' + | '2013-12-03' + | '2014-01-31' + | '2014-03-13' + | '2014-03-28' + | '2014-05-19' + | '2014-06-13' + | '2014-06-17' + | '2014-07-22' + | '2014-07-26' + | '2014-08-04' + | '2014-08-20' + | '2014-09-08' + | '2014-10-07' + | '2014-11-05' + | '2014-11-20' + | '2014-12-08' + | '2014-12-17' + | '2014-12-22' + | '2015-01-11' + | '2015-01-26' + | '2015-02-10' + | '2015-02-16' + | '2015-02-18' + | '2015-03-24' + | '2015-04-07' + | '2015-06-15' + | '2015-07-07' + | '2015-07-13' + | '2015-07-28' + | '2015-08-07' + | '2015-08-19' + | '2015-09-03' + | '2015-09-08' + | '2015-09-23' + | '2015-10-01' + | '2015-10-12' + | '2015-10-16' + | '2016-02-03' + | '2016-02-19' + | '2016-02-22' + | '2016-02-23' + | '2016-02-29' + | '2016-03-07' + | '2016-06-15' + | '2016-07-06' + | '2016-10-19' + | '2017-01-27' + | '2017-02-14' + | '2017-04-06' + | '2017-05-25' + | '2017-06-05' + | '2017-08-15' + | '2017-12-14' + | '2018-01-23' + | '2018-02-05' + | '2018-02-06' + | '2018-02-28' + | '2018-05-21' + | '2018-07-27' + | '2018-08-23' + | '2018-09-06' + | '2018-09-24' + | '2018-10-31' + | '2018-11-08' + | '2019-02-11' + | '2019-02-19' + | '2019-03-14' + | '2019-05-16' + | '2019-08-14' + | '2019-09-09' + | '2019-10-08' + | '2019-10-17' + | '2019-11-05' + | '2019-12-03' + | '2020-03-02' + | '2020-08-27' /** @description Whether this endpoint should receive events from connected accounts (`true`), or from your account (`false`). Defaults to `false`. */ - connect?: boolean; + connect?: boolean /** @description An optional description of what the webhook is used for. */ - description?: string; + description?: string /** @description The list of events to enable for this endpoint. You may specify `['*']` to enable all events, except those that require explicit selection. */ enabled_events: ( - | "*" - | "account.application.authorized" - | "account.application.deauthorized" - | "account.external_account.created" - | "account.external_account.deleted" - | "account.external_account.updated" - | "account.updated" - | "application_fee.created" - | "application_fee.refund.updated" - | "application_fee.refunded" - | "balance.available" - | "billing_portal.configuration.created" - | "billing_portal.configuration.updated" - | "capability.updated" - | "charge.captured" - | "charge.dispute.closed" - | "charge.dispute.created" - | "charge.dispute.funds_reinstated" - | "charge.dispute.funds_withdrawn" - | "charge.dispute.updated" - | "charge.expired" - | "charge.failed" - | "charge.pending" - | "charge.refund.updated" - | "charge.refunded" - | "charge.succeeded" - | "charge.updated" - | "checkout.session.async_payment_failed" - | "checkout.session.async_payment_succeeded" - | "checkout.session.completed" - | "checkout.session.expired" - | "coupon.created" - | "coupon.deleted" - | "coupon.updated" - | "credit_note.created" - | "credit_note.updated" - | "credit_note.voided" - | "customer.created" - | "customer.deleted" - | "customer.discount.created" - | "customer.discount.deleted" - | "customer.discount.updated" - | "customer.source.created" - | "customer.source.deleted" - | "customer.source.expiring" - | "customer.source.updated" - | "customer.subscription.created" - | "customer.subscription.deleted" - | "customer.subscription.pending_update_applied" - | "customer.subscription.pending_update_expired" - | "customer.subscription.trial_will_end" - | "customer.subscription.updated" - | "customer.tax_id.created" - | "customer.tax_id.deleted" - | "customer.tax_id.updated" - | "customer.updated" - | "file.created" - | "identity.verification_session.canceled" - | "identity.verification_session.created" - | "identity.verification_session.processing" - | "identity.verification_session.redacted" - | "identity.verification_session.requires_input" - | "identity.verification_session.verified" - | "invoice.created" - | "invoice.deleted" - | "invoice.finalization_failed" - | "invoice.finalized" - | "invoice.marked_uncollectible" - | "invoice.paid" - | "invoice.payment_action_required" - | "invoice.payment_failed" - | "invoice.payment_succeeded" - | "invoice.sent" - | "invoice.upcoming" - | "invoice.updated" - | "invoice.voided" - | "invoiceitem.created" - | "invoiceitem.deleted" - | "invoiceitem.updated" - | "issuing_authorization.created" - | "issuing_authorization.request" - | "issuing_authorization.updated" - | "issuing_card.created" - | "issuing_card.updated" - | "issuing_cardholder.created" - | "issuing_cardholder.updated" - | "issuing_dispute.closed" - | "issuing_dispute.created" - | "issuing_dispute.funds_reinstated" - | "issuing_dispute.submitted" - | "issuing_dispute.updated" - | "issuing_transaction.created" - | "issuing_transaction.updated" - | "mandate.updated" - | "order.created" - | "order.payment_failed" - | "order.payment_succeeded" - | "order.updated" - | "order_return.created" - | "payment_intent.amount_capturable_updated" - | "payment_intent.canceled" - | "payment_intent.created" - | "payment_intent.payment_failed" - | "payment_intent.processing" - | "payment_intent.requires_action" - | "payment_intent.succeeded" - | "payment_link.created" - | "payment_link.updated" - | "payment_method.attached" - | "payment_method.automatically_updated" - | "payment_method.detached" - | "payment_method.updated" - | "payout.canceled" - | "payout.created" - | "payout.failed" - | "payout.paid" - | "payout.updated" - | "person.created" - | "person.deleted" - | "person.updated" - | "plan.created" - | "plan.deleted" - | "plan.updated" - | "price.created" - | "price.deleted" - | "price.updated" - | "product.created" - | "product.deleted" - | "product.updated" - | "promotion_code.created" - | "promotion_code.updated" - | "quote.accepted" - | "quote.canceled" - | "quote.created" - | "quote.finalized" - | "radar.early_fraud_warning.created" - | "radar.early_fraud_warning.updated" - | "recipient.created" - | "recipient.deleted" - | "recipient.updated" - | "reporting.report_run.failed" - | "reporting.report_run.succeeded" - | "reporting.report_type.updated" - | "review.closed" - | "review.opened" - | "setup_intent.canceled" - | "setup_intent.created" - | "setup_intent.requires_action" - | "setup_intent.setup_failed" - | "setup_intent.succeeded" - | "sigma.scheduled_query_run.created" - | "sku.created" - | "sku.deleted" - | "sku.updated" - | "source.canceled" - | "source.chargeable" - | "source.failed" - | "source.mandate_notification" - | "source.refund_attributes_required" - | "source.transaction.created" - | "source.transaction.updated" - | "subscription_schedule.aborted" - | "subscription_schedule.canceled" - | "subscription_schedule.completed" - | "subscription_schedule.created" - | "subscription_schedule.expiring" - | "subscription_schedule.released" - | "subscription_schedule.updated" - | "tax_rate.created" - | "tax_rate.updated" - | "topup.canceled" - | "topup.created" - | "topup.failed" - | "topup.reversed" - | "topup.succeeded" - | "transfer.created" - | "transfer.failed" - | "transfer.paid" - | "transfer.reversed" - | "transfer.updated" - )[]; + | '*' + | 'account.application.authorized' + | 'account.application.deauthorized' + | 'account.external_account.created' + | 'account.external_account.deleted' + | 'account.external_account.updated' + | 'account.updated' + | 'application_fee.created' + | 'application_fee.refund.updated' + | 'application_fee.refunded' + | 'balance.available' + | 'billing_portal.configuration.created' + | 'billing_portal.configuration.updated' + | 'capability.updated' + | 'charge.captured' + | 'charge.dispute.closed' + | 'charge.dispute.created' + | 'charge.dispute.funds_reinstated' + | 'charge.dispute.funds_withdrawn' + | 'charge.dispute.updated' + | 'charge.expired' + | 'charge.failed' + | 'charge.pending' + | 'charge.refund.updated' + | 'charge.refunded' + | 'charge.succeeded' + | 'charge.updated' + | 'checkout.session.async_payment_failed' + | 'checkout.session.async_payment_succeeded' + | 'checkout.session.completed' + | 'checkout.session.expired' + | 'coupon.created' + | 'coupon.deleted' + | 'coupon.updated' + | 'credit_note.created' + | 'credit_note.updated' + | 'credit_note.voided' + | 'customer.created' + | 'customer.deleted' + | 'customer.discount.created' + | 'customer.discount.deleted' + | 'customer.discount.updated' + | 'customer.source.created' + | 'customer.source.deleted' + | 'customer.source.expiring' + | 'customer.source.updated' + | 'customer.subscription.created' + | 'customer.subscription.deleted' + | 'customer.subscription.pending_update_applied' + | 'customer.subscription.pending_update_expired' + | 'customer.subscription.trial_will_end' + | 'customer.subscription.updated' + | 'customer.tax_id.created' + | 'customer.tax_id.deleted' + | 'customer.tax_id.updated' + | 'customer.updated' + | 'file.created' + | 'identity.verification_session.canceled' + | 'identity.verification_session.created' + | 'identity.verification_session.processing' + | 'identity.verification_session.redacted' + | 'identity.verification_session.requires_input' + | 'identity.verification_session.verified' + | 'invoice.created' + | 'invoice.deleted' + | 'invoice.finalization_failed' + | 'invoice.finalized' + | 'invoice.marked_uncollectible' + | 'invoice.paid' + | 'invoice.payment_action_required' + | 'invoice.payment_failed' + | 'invoice.payment_succeeded' + | 'invoice.sent' + | 'invoice.upcoming' + | 'invoice.updated' + | 'invoice.voided' + | 'invoiceitem.created' + | 'invoiceitem.deleted' + | 'invoiceitem.updated' + | 'issuing_authorization.created' + | 'issuing_authorization.request' + | 'issuing_authorization.updated' + | 'issuing_card.created' + | 'issuing_card.updated' + | 'issuing_cardholder.created' + | 'issuing_cardholder.updated' + | 'issuing_dispute.closed' + | 'issuing_dispute.created' + | 'issuing_dispute.funds_reinstated' + | 'issuing_dispute.submitted' + | 'issuing_dispute.updated' + | 'issuing_transaction.created' + | 'issuing_transaction.updated' + | 'mandate.updated' + | 'order.created' + | 'order.payment_failed' + | 'order.payment_succeeded' + | 'order.updated' + | 'order_return.created' + | 'payment_intent.amount_capturable_updated' + | 'payment_intent.canceled' + | 'payment_intent.created' + | 'payment_intent.payment_failed' + | 'payment_intent.processing' + | 'payment_intent.requires_action' + | 'payment_intent.succeeded' + | 'payment_link.created' + | 'payment_link.updated' + | 'payment_method.attached' + | 'payment_method.automatically_updated' + | 'payment_method.detached' + | 'payment_method.updated' + | 'payout.canceled' + | 'payout.created' + | 'payout.failed' + | 'payout.paid' + | 'payout.updated' + | 'person.created' + | 'person.deleted' + | 'person.updated' + | 'plan.created' + | 'plan.deleted' + | 'plan.updated' + | 'price.created' + | 'price.deleted' + | 'price.updated' + | 'product.created' + | 'product.deleted' + | 'product.updated' + | 'promotion_code.created' + | 'promotion_code.updated' + | 'quote.accepted' + | 'quote.canceled' + | 'quote.created' + | 'quote.finalized' + | 'radar.early_fraud_warning.created' + | 'radar.early_fraud_warning.updated' + | 'recipient.created' + | 'recipient.deleted' + | 'recipient.updated' + | 'reporting.report_run.failed' + | 'reporting.report_run.succeeded' + | 'reporting.report_type.updated' + | 'review.closed' + | 'review.opened' + | 'setup_intent.canceled' + | 'setup_intent.created' + | 'setup_intent.requires_action' + | 'setup_intent.setup_failed' + | 'setup_intent.succeeded' + | 'sigma.scheduled_query_run.created' + | 'sku.created' + | 'sku.deleted' + | 'sku.updated' + | 'source.canceled' + | 'source.chargeable' + | 'source.failed' + | 'source.mandate_notification' + | 'source.refund_attributes_required' + | 'source.transaction.created' + | 'source.transaction.updated' + | 'subscription_schedule.aborted' + | 'subscription_schedule.canceled' + | 'subscription_schedule.completed' + | 'subscription_schedule.created' + | 'subscription_schedule.expiring' + | 'subscription_schedule.released' + | 'subscription_schedule.updated' + | 'tax_rate.created' + | 'tax_rate.updated' + | 'topup.canceled' + | 'topup.created' + | 'topup.failed' + | 'topup.reversed' + | 'topup.succeeded' + | 'transfer.created' + | 'transfer.failed' + | 'transfer.paid' + | 'transfer.reversed' + | 'transfer.updated' + )[] /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description The URL of the webhook endpoint. */ - url: string; - }; - }; - }; - }; + url: string + } + } + } + } /**

Retrieves the webhook endpoint with the given ID.

*/ GetWebhookEndpointsWebhookEndpoint: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - webhook_endpoint: string; - }; - }; + webhook_endpoint: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["webhook_endpoint"]; - }; - }; + 'application/json': components['schemas']['webhook_endpoint'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.

*/ PostWebhookEndpointsWebhookEndpoint: { parameters: { path: { - webhook_endpoint: string; - }; - }; + webhook_endpoint: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["webhook_endpoint"]; - }; - }; + 'application/json': components['schemas']['webhook_endpoint'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description An optional description of what the webhook is used for. */ - description?: string; + description?: string /** @description Disable the webhook endpoint if set to true. */ - disabled?: boolean; + disabled?: boolean /** @description The list of events to enable for this endpoint. You may specify `['*']` to enable all events, except those that require explicit selection. */ enabled_events?: ( - | "*" - | "account.application.authorized" - | "account.application.deauthorized" - | "account.external_account.created" - | "account.external_account.deleted" - | "account.external_account.updated" - | "account.updated" - | "application_fee.created" - | "application_fee.refund.updated" - | "application_fee.refunded" - | "balance.available" - | "billing_portal.configuration.created" - | "billing_portal.configuration.updated" - | "capability.updated" - | "charge.captured" - | "charge.dispute.closed" - | "charge.dispute.created" - | "charge.dispute.funds_reinstated" - | "charge.dispute.funds_withdrawn" - | "charge.dispute.updated" - | "charge.expired" - | "charge.failed" - | "charge.pending" - | "charge.refund.updated" - | "charge.refunded" - | "charge.succeeded" - | "charge.updated" - | "checkout.session.async_payment_failed" - | "checkout.session.async_payment_succeeded" - | "checkout.session.completed" - | "checkout.session.expired" - | "coupon.created" - | "coupon.deleted" - | "coupon.updated" - | "credit_note.created" - | "credit_note.updated" - | "credit_note.voided" - | "customer.created" - | "customer.deleted" - | "customer.discount.created" - | "customer.discount.deleted" - | "customer.discount.updated" - | "customer.source.created" - | "customer.source.deleted" - | "customer.source.expiring" - | "customer.source.updated" - | "customer.subscription.created" - | "customer.subscription.deleted" - | "customer.subscription.pending_update_applied" - | "customer.subscription.pending_update_expired" - | "customer.subscription.trial_will_end" - | "customer.subscription.updated" - | "customer.tax_id.created" - | "customer.tax_id.deleted" - | "customer.tax_id.updated" - | "customer.updated" - | "file.created" - | "identity.verification_session.canceled" - | "identity.verification_session.created" - | "identity.verification_session.processing" - | "identity.verification_session.redacted" - | "identity.verification_session.requires_input" - | "identity.verification_session.verified" - | "invoice.created" - | "invoice.deleted" - | "invoice.finalization_failed" - | "invoice.finalized" - | "invoice.marked_uncollectible" - | "invoice.paid" - | "invoice.payment_action_required" - | "invoice.payment_failed" - | "invoice.payment_succeeded" - | "invoice.sent" - | "invoice.upcoming" - | "invoice.updated" - | "invoice.voided" - | "invoiceitem.created" - | "invoiceitem.deleted" - | "invoiceitem.updated" - | "issuing_authorization.created" - | "issuing_authorization.request" - | "issuing_authorization.updated" - | "issuing_card.created" - | "issuing_card.updated" - | "issuing_cardholder.created" - | "issuing_cardholder.updated" - | "issuing_dispute.closed" - | "issuing_dispute.created" - | "issuing_dispute.funds_reinstated" - | "issuing_dispute.submitted" - | "issuing_dispute.updated" - | "issuing_transaction.created" - | "issuing_transaction.updated" - | "mandate.updated" - | "order.created" - | "order.payment_failed" - | "order.payment_succeeded" - | "order.updated" - | "order_return.created" - | "payment_intent.amount_capturable_updated" - | "payment_intent.canceled" - | "payment_intent.created" - | "payment_intent.payment_failed" - | "payment_intent.processing" - | "payment_intent.requires_action" - | "payment_intent.succeeded" - | "payment_link.created" - | "payment_link.updated" - | "payment_method.attached" - | "payment_method.automatically_updated" - | "payment_method.detached" - | "payment_method.updated" - | "payout.canceled" - | "payout.created" - | "payout.failed" - | "payout.paid" - | "payout.updated" - | "person.created" - | "person.deleted" - | "person.updated" - | "plan.created" - | "plan.deleted" - | "plan.updated" - | "price.created" - | "price.deleted" - | "price.updated" - | "product.created" - | "product.deleted" - | "product.updated" - | "promotion_code.created" - | "promotion_code.updated" - | "quote.accepted" - | "quote.canceled" - | "quote.created" - | "quote.finalized" - | "radar.early_fraud_warning.created" - | "radar.early_fraud_warning.updated" - | "recipient.created" - | "recipient.deleted" - | "recipient.updated" - | "reporting.report_run.failed" - | "reporting.report_run.succeeded" - | "reporting.report_type.updated" - | "review.closed" - | "review.opened" - | "setup_intent.canceled" - | "setup_intent.created" - | "setup_intent.requires_action" - | "setup_intent.setup_failed" - | "setup_intent.succeeded" - | "sigma.scheduled_query_run.created" - | "sku.created" - | "sku.deleted" - | "sku.updated" - | "source.canceled" - | "source.chargeable" - | "source.failed" - | "source.mandate_notification" - | "source.refund_attributes_required" - | "source.transaction.created" - | "source.transaction.updated" - | "subscription_schedule.aborted" - | "subscription_schedule.canceled" - | "subscription_schedule.completed" - | "subscription_schedule.created" - | "subscription_schedule.expiring" - | "subscription_schedule.released" - | "subscription_schedule.updated" - | "tax_rate.created" - | "tax_rate.updated" - | "topup.canceled" - | "topup.created" - | "topup.failed" - | "topup.reversed" - | "topup.succeeded" - | "transfer.created" - | "transfer.failed" - | "transfer.paid" - | "transfer.reversed" - | "transfer.updated" - )[]; + | '*' + | 'account.application.authorized' + | 'account.application.deauthorized' + | 'account.external_account.created' + | 'account.external_account.deleted' + | 'account.external_account.updated' + | 'account.updated' + | 'application_fee.created' + | 'application_fee.refund.updated' + | 'application_fee.refunded' + | 'balance.available' + | 'billing_portal.configuration.created' + | 'billing_portal.configuration.updated' + | 'capability.updated' + | 'charge.captured' + | 'charge.dispute.closed' + | 'charge.dispute.created' + | 'charge.dispute.funds_reinstated' + | 'charge.dispute.funds_withdrawn' + | 'charge.dispute.updated' + | 'charge.expired' + | 'charge.failed' + | 'charge.pending' + | 'charge.refund.updated' + | 'charge.refunded' + | 'charge.succeeded' + | 'charge.updated' + | 'checkout.session.async_payment_failed' + | 'checkout.session.async_payment_succeeded' + | 'checkout.session.completed' + | 'checkout.session.expired' + | 'coupon.created' + | 'coupon.deleted' + | 'coupon.updated' + | 'credit_note.created' + | 'credit_note.updated' + | 'credit_note.voided' + | 'customer.created' + | 'customer.deleted' + | 'customer.discount.created' + | 'customer.discount.deleted' + | 'customer.discount.updated' + | 'customer.source.created' + | 'customer.source.deleted' + | 'customer.source.expiring' + | 'customer.source.updated' + | 'customer.subscription.created' + | 'customer.subscription.deleted' + | 'customer.subscription.pending_update_applied' + | 'customer.subscription.pending_update_expired' + | 'customer.subscription.trial_will_end' + | 'customer.subscription.updated' + | 'customer.tax_id.created' + | 'customer.tax_id.deleted' + | 'customer.tax_id.updated' + | 'customer.updated' + | 'file.created' + | 'identity.verification_session.canceled' + | 'identity.verification_session.created' + | 'identity.verification_session.processing' + | 'identity.verification_session.redacted' + | 'identity.verification_session.requires_input' + | 'identity.verification_session.verified' + | 'invoice.created' + | 'invoice.deleted' + | 'invoice.finalization_failed' + | 'invoice.finalized' + | 'invoice.marked_uncollectible' + | 'invoice.paid' + | 'invoice.payment_action_required' + | 'invoice.payment_failed' + | 'invoice.payment_succeeded' + | 'invoice.sent' + | 'invoice.upcoming' + | 'invoice.updated' + | 'invoice.voided' + | 'invoiceitem.created' + | 'invoiceitem.deleted' + | 'invoiceitem.updated' + | 'issuing_authorization.created' + | 'issuing_authorization.request' + | 'issuing_authorization.updated' + | 'issuing_card.created' + | 'issuing_card.updated' + | 'issuing_cardholder.created' + | 'issuing_cardholder.updated' + | 'issuing_dispute.closed' + | 'issuing_dispute.created' + | 'issuing_dispute.funds_reinstated' + | 'issuing_dispute.submitted' + | 'issuing_dispute.updated' + | 'issuing_transaction.created' + | 'issuing_transaction.updated' + | 'mandate.updated' + | 'order.created' + | 'order.payment_failed' + | 'order.payment_succeeded' + | 'order.updated' + | 'order_return.created' + | 'payment_intent.amount_capturable_updated' + | 'payment_intent.canceled' + | 'payment_intent.created' + | 'payment_intent.payment_failed' + | 'payment_intent.processing' + | 'payment_intent.requires_action' + | 'payment_intent.succeeded' + | 'payment_link.created' + | 'payment_link.updated' + | 'payment_method.attached' + | 'payment_method.automatically_updated' + | 'payment_method.detached' + | 'payment_method.updated' + | 'payout.canceled' + | 'payout.created' + | 'payout.failed' + | 'payout.paid' + | 'payout.updated' + | 'person.created' + | 'person.deleted' + | 'person.updated' + | 'plan.created' + | 'plan.deleted' + | 'plan.updated' + | 'price.created' + | 'price.deleted' + | 'price.updated' + | 'product.created' + | 'product.deleted' + | 'product.updated' + | 'promotion_code.created' + | 'promotion_code.updated' + | 'quote.accepted' + | 'quote.canceled' + | 'quote.created' + | 'quote.finalized' + | 'radar.early_fraud_warning.created' + | 'radar.early_fraud_warning.updated' + | 'recipient.created' + | 'recipient.deleted' + | 'recipient.updated' + | 'reporting.report_run.failed' + | 'reporting.report_run.succeeded' + | 'reporting.report_type.updated' + | 'review.closed' + | 'review.opened' + | 'setup_intent.canceled' + | 'setup_intent.created' + | 'setup_intent.requires_action' + | 'setup_intent.setup_failed' + | 'setup_intent.succeeded' + | 'sigma.scheduled_query_run.created' + | 'sku.created' + | 'sku.deleted' + | 'sku.updated' + | 'source.canceled' + | 'source.chargeable' + | 'source.failed' + | 'source.mandate_notification' + | 'source.refund_attributes_required' + | 'source.transaction.created' + | 'source.transaction.updated' + | 'subscription_schedule.aborted' + | 'subscription_schedule.canceled' + | 'subscription_schedule.completed' + | 'subscription_schedule.created' + | 'subscription_schedule.expiring' + | 'subscription_schedule.released' + | 'subscription_schedule.updated' + | 'tax_rate.created' + | 'tax_rate.updated' + | 'topup.canceled' + | 'topup.created' + | 'topup.failed' + | 'topup.reversed' + | 'topup.succeeded' + | 'transfer.created' + | 'transfer.failed' + | 'transfer.paid' + | 'transfer.reversed' + | 'transfer.updated' + )[] /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: (Partial<{ [key: string]: string }> & Partial<"">) & { [key: string]: unknown }; + metadata?: (Partial<{ [key: string]: string }> & Partial<''>) & { [key: string]: unknown } /** @description The URL of the webhook endpoint. */ - url?: string; - }; - }; - }; - }; + url?: string + } + } + } + } /**

You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.

*/ DeleteWebhookEndpointsWebhookEndpoint: { parameters: { path: { - webhook_endpoint: string; - }; - }; + webhook_endpoint: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_webhook_endpoint"]; - }; - }; + 'application/json': components['schemas']['deleted_webhook_endpoint'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } } export interface external {} diff --git a/test/v3/expected/stripe.exported-type.ts b/test/v3/expected/stripe.exported-type.ts index b7a4d1832..194c64281 100644 --- a/test/v3/expected/stripe.exported-type.ts +++ b/test/v3/expected/stripe.exported-type.ts @@ -4,23 +4,23 @@ */ export type paths = { - "/v1/3d_secure": { + '/v1/3d_secure': { /**

Initiate 3D Secure authentication.

*/ - post: operations["Post3dSecure"]; - }; - "/v1/3d_secure/{three_d_secure}": { + post: operations['Post3dSecure'] + } + '/v1/3d_secure/{three_d_secure}': { /**

Retrieves a 3D Secure object.

*/ - get: operations["Get3dSecureThreeDSecure"]; - }; - "/v1/account": { + get: operations['Get3dSecureThreeDSecure'] + } + '/v1/account': { /**

Retrieves the details of an account.

*/ - get: operations["GetAccount"]; + get: operations['GetAccount'] /** *

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged. Most parameters can be changed only for Custom accounts. (These are marked Custom Only below.) Parameters marked Custom and Express are not supported for Standard accounts.

* *

To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.

*/ - post: operations["PostAccount"]; + post: operations['PostAccount'] /** *

With Connect, you can delete accounts you manage.

* @@ -28,110 +28,110 @@ export type paths = { * *

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

*/ - delete: operations["DeleteAccount"]; - }; - "/v1/account/bank_accounts": { + delete: operations['DeleteAccount'] + } + '/v1/account/bank_accounts': { /**

Create an external account for a given account.

*/ - post: operations["PostAccountBankAccounts"]; - }; - "/v1/account/bank_accounts/{id}": { + post: operations['PostAccountBankAccounts'] + } + '/v1/account/bank_accounts/{id}': { /**

Retrieve a specified external account for a given account.

*/ - get: operations["GetAccountBankAccountsId"]; + get: operations['GetAccountBankAccountsId'] /** *

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

* *

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

*/ - post: operations["PostAccountBankAccountsId"]; + post: operations['PostAccountBankAccountsId'] /**

Delete a specified external account for a given account.

*/ - delete: operations["DeleteAccountBankAccountsId"]; - }; - "/v1/account/capabilities": { + delete: operations['DeleteAccountBankAccountsId'] + } + '/v1/account/capabilities': { /**

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

*/ - get: operations["GetAccountCapabilities"]; - }; - "/v1/account/capabilities/{capability}": { + get: operations['GetAccountCapabilities'] + } + '/v1/account/capabilities/{capability}': { /**

Retrieves information about the specified Account Capability.

*/ - get: operations["GetAccountCapabilitiesCapability"]; + get: operations['GetAccountCapabilitiesCapability'] /**

Updates an existing Account Capability.

*/ - post: operations["PostAccountCapabilitiesCapability"]; - }; - "/v1/account/external_accounts": { + post: operations['PostAccountCapabilitiesCapability'] + } + '/v1/account/external_accounts': { /**

List external accounts for an account.

*/ - get: operations["GetAccountExternalAccounts"]; + get: operations['GetAccountExternalAccounts'] /**

Create an external account for a given account.

*/ - post: operations["PostAccountExternalAccounts"]; - }; - "/v1/account/external_accounts/{id}": { + post: operations['PostAccountExternalAccounts'] + } + '/v1/account/external_accounts/{id}': { /**

Retrieve a specified external account for a given account.

*/ - get: operations["GetAccountExternalAccountsId"]; + get: operations['GetAccountExternalAccountsId'] /** *

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

* *

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

*/ - post: operations["PostAccountExternalAccountsId"]; + post: operations['PostAccountExternalAccountsId'] /**

Delete a specified external account for a given account.

*/ - delete: operations["DeleteAccountExternalAccountsId"]; - }; - "/v1/account/login_links": { + delete: operations['DeleteAccountExternalAccountsId'] + } + '/v1/account/login_links': { /** *

Creates a single-use login link for an Express account to access their Stripe dashboard.

* *

You may only create login links for Express accounts connected to your platform.

*/ - post: operations["PostAccountLoginLinks"]; - }; - "/v1/account/people": { + post: operations['PostAccountLoginLinks'] + } + '/v1/account/people': { /**

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.

*/ - get: operations["GetAccountPeople"]; + get: operations['GetAccountPeople'] /**

Creates a new person.

*/ - post: operations["PostAccountPeople"]; - }; - "/v1/account/people/{person}": { + post: operations['PostAccountPeople'] + } + '/v1/account/people/{person}': { /**

Retrieves an existing person.

*/ - get: operations["GetAccountPeoplePerson"]; + get: operations['GetAccountPeoplePerson'] /**

Updates an existing person.

*/ - post: operations["PostAccountPeoplePerson"]; + post: operations['PostAccountPeoplePerson'] /**

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.

*/ - delete: operations["DeleteAccountPeoplePerson"]; - }; - "/v1/account/persons": { + delete: operations['DeleteAccountPeoplePerson'] + } + '/v1/account/persons': { /**

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.

*/ - get: operations["GetAccountPersons"]; + get: operations['GetAccountPersons'] /**

Creates a new person.

*/ - post: operations["PostAccountPersons"]; - }; - "/v1/account/persons/{person}": { + post: operations['PostAccountPersons'] + } + '/v1/account/persons/{person}': { /**

Retrieves an existing person.

*/ - get: operations["GetAccountPersonsPerson"]; + get: operations['GetAccountPersonsPerson'] /**

Updates an existing person.

*/ - post: operations["PostAccountPersonsPerson"]; + post: operations['PostAccountPersonsPerson'] /**

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.

*/ - delete: operations["DeleteAccountPersonsPerson"]; - }; - "/v1/account_links": { + delete: operations['DeleteAccountPersonsPerson'] + } + '/v1/account_links': { /**

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.

*/ - post: operations["PostAccountLinks"]; - }; - "/v1/accounts": { + post: operations['PostAccountLinks'] + } + '/v1/accounts': { /**

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

*/ - get: operations["GetAccounts"]; + get: operations['GetAccounts'] /** *

With Connect, you can create Stripe accounts for your users. * To do this, you’ll first need to register your platform.

*/ - post: operations["PostAccounts"]; - }; - "/v1/accounts/{account}": { + post: operations['PostAccounts'] + } + '/v1/accounts/{account}': { /**

Retrieves the details of an account.

*/ - get: operations["GetAccountsAccount"]; + get: operations['GetAccountsAccount'] /** *

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged. Most parameters can be changed only for Custom accounts. (These are marked Custom Only below.) Parameters marked Custom and Express are not supported for Standard accounts.

* *

To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.

*/ - post: operations["PostAccountsAccount"]; + post: operations['PostAccountsAccount'] /** *

With Connect, you can delete accounts you manage.

* @@ -139,132 +139,132 @@ export type paths = { * *

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

*/ - delete: operations["DeleteAccountsAccount"]; - }; - "/v1/accounts/{account}/bank_accounts": { + delete: operations['DeleteAccountsAccount'] + } + '/v1/accounts/{account}/bank_accounts': { /**

Create an external account for a given account.

*/ - post: operations["PostAccountsAccountBankAccounts"]; - }; - "/v1/accounts/{account}/bank_accounts/{id}": { + post: operations['PostAccountsAccountBankAccounts'] + } + '/v1/accounts/{account}/bank_accounts/{id}': { /**

Retrieve a specified external account for a given account.

*/ - get: operations["GetAccountsAccountBankAccountsId"]; + get: operations['GetAccountsAccountBankAccountsId'] /** *

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

* *

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

*/ - post: operations["PostAccountsAccountBankAccountsId"]; + post: operations['PostAccountsAccountBankAccountsId'] /**

Delete a specified external account for a given account.

*/ - delete: operations["DeleteAccountsAccountBankAccountsId"]; - }; - "/v1/accounts/{account}/capabilities": { + delete: operations['DeleteAccountsAccountBankAccountsId'] + } + '/v1/accounts/{account}/capabilities': { /**

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

*/ - get: operations["GetAccountsAccountCapabilities"]; - }; - "/v1/accounts/{account}/capabilities/{capability}": { + get: operations['GetAccountsAccountCapabilities'] + } + '/v1/accounts/{account}/capabilities/{capability}': { /**

Retrieves information about the specified Account Capability.

*/ - get: operations["GetAccountsAccountCapabilitiesCapability"]; + get: operations['GetAccountsAccountCapabilitiesCapability'] /**

Updates an existing Account Capability.

*/ - post: operations["PostAccountsAccountCapabilitiesCapability"]; - }; - "/v1/accounts/{account}/external_accounts": { + post: operations['PostAccountsAccountCapabilitiesCapability'] + } + '/v1/accounts/{account}/external_accounts': { /**

List external accounts for an account.

*/ - get: operations["GetAccountsAccountExternalAccounts"]; + get: operations['GetAccountsAccountExternalAccounts'] /**

Create an external account for a given account.

*/ - post: operations["PostAccountsAccountExternalAccounts"]; - }; - "/v1/accounts/{account}/external_accounts/{id}": { + post: operations['PostAccountsAccountExternalAccounts'] + } + '/v1/accounts/{account}/external_accounts/{id}': { /**

Retrieve a specified external account for a given account.

*/ - get: operations["GetAccountsAccountExternalAccountsId"]; + get: operations['GetAccountsAccountExternalAccountsId'] /** *

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

* *

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

*/ - post: operations["PostAccountsAccountExternalAccountsId"]; + post: operations['PostAccountsAccountExternalAccountsId'] /**

Delete a specified external account for a given account.

*/ - delete: operations["DeleteAccountsAccountExternalAccountsId"]; - }; - "/v1/accounts/{account}/login_links": { + delete: operations['DeleteAccountsAccountExternalAccountsId'] + } + '/v1/accounts/{account}/login_links': { /** *

Creates a single-use login link for an Express account to access their Stripe dashboard.

* *

You may only create login links for Express accounts connected to your platform.

*/ - post: operations["PostAccountsAccountLoginLinks"]; - }; - "/v1/accounts/{account}/people": { + post: operations['PostAccountsAccountLoginLinks'] + } + '/v1/accounts/{account}/people': { /**

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.

*/ - get: operations["GetAccountsAccountPeople"]; + get: operations['GetAccountsAccountPeople'] /**

Creates a new person.

*/ - post: operations["PostAccountsAccountPeople"]; - }; - "/v1/accounts/{account}/people/{person}": { + post: operations['PostAccountsAccountPeople'] + } + '/v1/accounts/{account}/people/{person}': { /**

Retrieves an existing person.

*/ - get: operations["GetAccountsAccountPeoplePerson"]; + get: operations['GetAccountsAccountPeoplePerson'] /**

Updates an existing person.

*/ - post: operations["PostAccountsAccountPeoplePerson"]; + post: operations['PostAccountsAccountPeoplePerson'] /**

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.

*/ - delete: operations["DeleteAccountsAccountPeoplePerson"]; - }; - "/v1/accounts/{account}/persons": { + delete: operations['DeleteAccountsAccountPeoplePerson'] + } + '/v1/accounts/{account}/persons': { /**

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.

*/ - get: operations["GetAccountsAccountPersons"]; + get: operations['GetAccountsAccountPersons'] /**

Creates a new person.

*/ - post: operations["PostAccountsAccountPersons"]; - }; - "/v1/accounts/{account}/persons/{person}": { + post: operations['PostAccountsAccountPersons'] + } + '/v1/accounts/{account}/persons/{person}': { /**

Retrieves an existing person.

*/ - get: operations["GetAccountsAccountPersonsPerson"]; + get: operations['GetAccountsAccountPersonsPerson'] /**

Updates an existing person.

*/ - post: operations["PostAccountsAccountPersonsPerson"]; + post: operations['PostAccountsAccountPersonsPerson'] /**

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.

*/ - delete: operations["DeleteAccountsAccountPersonsPerson"]; - }; - "/v1/accounts/{account}/reject": { + delete: operations['DeleteAccountsAccountPersonsPerson'] + } + '/v1/accounts/{account}/reject': { /** *

With Connect, you may flag accounts as suspicious.

* *

Test-mode Custom and Express accounts can be rejected at any time. Accounts created using live-mode keys may only be rejected once all balances are zero.

*/ - post: operations["PostAccountsAccountReject"]; - }; - "/v1/apple_pay/domains": { + post: operations['PostAccountsAccountReject'] + } + '/v1/apple_pay/domains': { /**

List apple pay domains.

*/ - get: operations["GetApplePayDomains"]; + get: operations['GetApplePayDomains'] /**

Create an apple pay domain.

*/ - post: operations["PostApplePayDomains"]; - }; - "/v1/apple_pay/domains/{domain}": { + post: operations['PostApplePayDomains'] + } + '/v1/apple_pay/domains/{domain}': { /**

Retrieve an apple pay domain.

*/ - get: operations["GetApplePayDomainsDomain"]; + get: operations['GetApplePayDomainsDomain'] /**

Delete an apple pay domain.

*/ - delete: operations["DeleteApplePayDomainsDomain"]; - }; - "/v1/application_fees": { + delete: operations['DeleteApplePayDomainsDomain'] + } + '/v1/application_fees': { /**

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.

*/ - get: operations["GetApplicationFees"]; - }; - "/v1/application_fees/{fee}/refunds/{id}": { + get: operations['GetApplicationFees'] + } + '/v1/application_fees/{fee}/refunds/{id}': { /**

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.

*/ - get: operations["GetApplicationFeesFeeRefundsId"]; + get: operations['GetApplicationFeesFeeRefundsId'] /** *

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

* *

This request only accepts metadata as an argument.

*/ - post: operations["PostApplicationFeesFeeRefundsId"]; - }; - "/v1/application_fees/{id}": { + post: operations['PostApplicationFeesFeeRefundsId'] + } + '/v1/application_fees/{id}': { /**

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

*/ - get: operations["GetApplicationFeesId"]; - }; - "/v1/application_fees/{id}/refund": { - post: operations["PostApplicationFeesIdRefund"]; - }; - "/v1/application_fees/{id}/refunds": { + get: operations['GetApplicationFeesId'] + } + '/v1/application_fees/{id}/refund': { + post: operations['PostApplicationFeesIdRefund'] + } + '/v1/application_fees/{id}/refunds': { /**

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.

*/ - get: operations["GetApplicationFeesIdRefunds"]; + get: operations['GetApplicationFeesIdRefunds'] /** *

Refunds an application fee that has previously been collected but not yet refunded. * Funds will be refunded to the Stripe account from which the fee was originally collected.

@@ -276,108 +276,108 @@ export type paths = { * This method will raise an error when called on an already-refunded application fee, * or when trying to refund more money than is left on an application fee.

*/ - post: operations["PostApplicationFeesIdRefunds"]; - }; - "/v1/balance": { + post: operations['PostApplicationFeesIdRefunds'] + } + '/v1/balance': { /** *

Retrieves the current account balance, based on the authentication that was used to make the request. * For a sample request, see Accounting for negative balances.

*/ - get: operations["GetBalance"]; - }; - "/v1/balance/history": { + get: operations['GetBalance'] + } + '/v1/balance/history': { /** *

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

* *

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

*/ - get: operations["GetBalanceHistory"]; - }; - "/v1/balance/history/{id}": { + get: operations['GetBalanceHistory'] + } + '/v1/balance/history/{id}': { /** *

Retrieves the balance transaction with the given ID.

* *

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

*/ - get: operations["GetBalanceHistoryId"]; - }; - "/v1/balance_transactions": { + get: operations['GetBalanceHistoryId'] + } + '/v1/balance_transactions': { /** *

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

* *

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

*/ - get: operations["GetBalanceTransactions"]; - }; - "/v1/balance_transactions/{id}": { + get: operations['GetBalanceTransactions'] + } + '/v1/balance_transactions/{id}': { /** *

Retrieves the balance transaction with the given ID.

* *

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

*/ - get: operations["GetBalanceTransactionsId"]; - }; - "/v1/billing_portal/configurations": { + get: operations['GetBalanceTransactionsId'] + } + '/v1/billing_portal/configurations': { /**

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

*/ - get: operations["GetBillingPortalConfigurations"]; + get: operations['GetBillingPortalConfigurations'] /**

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

*/ - post: operations["PostBillingPortalConfigurations"]; - }; - "/v1/billing_portal/configurations/{configuration}": { + post: operations['PostBillingPortalConfigurations'] + } + '/v1/billing_portal/configurations/{configuration}': { /**

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

*/ - get: operations["GetBillingPortalConfigurationsConfiguration"]; + get: operations['GetBillingPortalConfigurationsConfiguration'] /**

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

*/ - post: operations["PostBillingPortalConfigurationsConfiguration"]; - }; - "/v1/billing_portal/sessions": { + post: operations['PostBillingPortalConfigurationsConfiguration'] + } + '/v1/billing_portal/sessions': { /**

Creates a session of the customer portal.

*/ - post: operations["PostBillingPortalSessions"]; - }; - "/v1/bitcoin/receivers": { + post: operations['PostBillingPortalSessions'] + } + '/v1/bitcoin/receivers': { /**

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

*/ - get: operations["GetBitcoinReceivers"]; - }; - "/v1/bitcoin/receivers/{id}": { + get: operations['GetBitcoinReceivers'] + } + '/v1/bitcoin/receivers/{id}': { /**

Retrieves the Bitcoin receiver with the given ID.

*/ - get: operations["GetBitcoinReceiversId"]; - }; - "/v1/bitcoin/receivers/{receiver}/transactions": { + get: operations['GetBitcoinReceiversId'] + } + '/v1/bitcoin/receivers/{receiver}/transactions': { /**

List bitcoin transacitons for a given receiver.

*/ - get: operations["GetBitcoinReceiversReceiverTransactions"]; - }; - "/v1/bitcoin/transactions": { + get: operations['GetBitcoinReceiversReceiverTransactions'] + } + '/v1/bitcoin/transactions': { /**

List bitcoin transacitons for a given receiver.

*/ - get: operations["GetBitcoinTransactions"]; - }; - "/v1/charges": { + get: operations['GetBitcoinTransactions'] + } + '/v1/charges': { /**

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

*/ - get: operations["GetCharges"]; + get: operations['GetCharges'] /**

To charge a credit card or other payment source, you create a Charge object. If your API key is in test mode, the supplied payment source (e.g., card) won’t actually be charged, although everything else will occur as if in live mode. (Stripe assumes that the charge would have completed successfully).

*/ - post: operations["PostCharges"]; - }; - "/v1/charges/{charge}": { + post: operations['PostCharges'] + } + '/v1/charges/{charge}': { /**

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.

*/ - get: operations["GetChargesCharge"]; + get: operations['GetChargesCharge'] /**

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

*/ - post: operations["PostChargesCharge"]; - }; - "/v1/charges/{charge}/capture": { + post: operations['PostChargesCharge'] + } + '/v1/charges/{charge}/capture': { /** *

Capture the payment of an existing, uncaptured, charge. This is the second half of the two-step payment flow, where first you created a charge with the capture option set to false.

* *

Uncaptured payments expire a set number of days after they are created (7 by default). If they are not captured by that point in time, they will be marked as refunded and will no longer be capturable.

*/ - post: operations["PostChargesChargeCapture"]; - }; - "/v1/charges/{charge}/dispute": { + post: operations['PostChargesChargeCapture'] + } + '/v1/charges/{charge}/dispute': { /**

Retrieve a dispute for a specified charge.

*/ - get: operations["GetChargesChargeDispute"]; - post: operations["PostChargesChargeDispute"]; - }; - "/v1/charges/{charge}/dispute/close": { - post: operations["PostChargesChargeDisputeClose"]; - }; - "/v1/charges/{charge}/refund": { + get: operations['GetChargesChargeDispute'] + post: operations['PostChargesChargeDispute'] + } + '/v1/charges/{charge}/dispute/close': { + post: operations['PostChargesChargeDisputeClose'] + } + '/v1/charges/{charge}/refund': { /** *

When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.

* @@ -391,71 +391,71 @@ export type paths = { * 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.

*/ - post: operations["PostChargesChargeRefund"]; - }; - "/v1/charges/{charge}/refunds": { + post: operations['PostChargesChargeRefund'] + } + '/v1/charges/{charge}/refunds': { /**

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.

*/ - get: operations["GetChargesChargeRefunds"]; + get: operations['GetChargesChargeRefunds'] /**

Create a refund.

*/ - post: operations["PostChargesChargeRefunds"]; - }; - "/v1/charges/{charge}/refunds/{refund}": { + post: operations['PostChargesChargeRefunds'] + } + '/v1/charges/{charge}/refunds/{refund}': { /**

Retrieves the details of an existing refund.

*/ - get: operations["GetChargesChargeRefundsRefund"]; + get: operations['GetChargesChargeRefundsRefund'] /**

Update a specified refund.

*/ - post: operations["PostChargesChargeRefundsRefund"]; - }; - "/v1/checkout/sessions": { + post: operations['PostChargesChargeRefundsRefund'] + } + '/v1/checkout/sessions': { /**

Returns a list of Checkout Sessions.

*/ - get: operations["GetCheckoutSessions"]; + get: operations['GetCheckoutSessions'] /**

Creates a Session object.

*/ - post: operations["PostCheckoutSessions"]; - }; - "/v1/checkout/sessions/{session}": { + post: operations['PostCheckoutSessions'] + } + '/v1/checkout/sessions/{session}': { /**

Retrieves a Session object.

*/ - get: operations["GetCheckoutSessionsSession"]; - }; - "/v1/checkout/sessions/{session}/expire": { + get: operations['GetCheckoutSessionsSession'] + } + '/v1/checkout/sessions/{session}/expire': { /** *

A Session can be expired when it is in one of these statuses: open

* *

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

*/ - post: operations["PostCheckoutSessionsSessionExpire"]; - }; - "/v1/checkout/sessions/{session}/line_items": { + post: operations['PostCheckoutSessionsSessionExpire'] + } + '/v1/checkout/sessions/{session}/line_items': { /**

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.

*/ - get: operations["GetCheckoutSessionsSessionLineItems"]; - }; - "/v1/country_specs": { + get: operations['GetCheckoutSessionsSessionLineItems'] + } + '/v1/country_specs': { /**

Lists all Country Spec objects available in the API.

*/ - get: operations["GetCountrySpecs"]; - }; - "/v1/country_specs/{country}": { + get: operations['GetCountrySpecs'] + } + '/v1/country_specs/{country}': { /**

Returns a Country Spec for a given Country code.

*/ - get: operations["GetCountrySpecsCountry"]; - }; - "/v1/coupons": { + get: operations['GetCountrySpecsCountry'] + } + '/v1/coupons': { /**

Returns a list of your coupons.

*/ - get: operations["GetCoupons"]; + get: operations['GetCoupons'] /** *

You can create coupons easily via the coupon management page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.

* *

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.

*/ - post: operations["PostCoupons"]; - }; - "/v1/coupons/{coupon}": { + post: operations['PostCoupons'] + } + '/v1/coupons/{coupon}': { /**

Retrieves the coupon with the given ID.

*/ - get: operations["GetCouponsCoupon"]; + get: operations['GetCouponsCoupon'] /**

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

*/ - post: operations["PostCouponsCoupon"]; + post: operations['PostCouponsCoupon'] /**

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.

*/ - delete: operations["DeleteCouponsCoupon"]; - }; - "/v1/credit_notes": { + delete: operations['DeleteCouponsCoupon'] + } + '/v1/credit_notes': { /**

Returns a list of credit notes.

*/ - get: operations["GetCreditNotes"]; + get: operations['GetCreditNotes'] /** *

Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces * its amount_due. For a status=paid invoice, a credit note does not affect its amount_due. Instead, it can result @@ -472,63 +472,63 @@ export type paths = { *

You may issue multiple credit notes for an invoice. Each credit note will increment the invoice’s pre_payment_credit_notes_amount * or post_payment_credit_notes_amount depending on its status at the time of credit note creation.

*/ - post: operations["PostCreditNotes"]; - }; - "/v1/credit_notes/preview": { + post: operations['PostCreditNotes'] + } + '/v1/credit_notes/preview': { /**

Get a preview of a credit note without creating it.

*/ - get: operations["GetCreditNotesPreview"]; - }; - "/v1/credit_notes/preview/lines": { + get: operations['GetCreditNotesPreview'] + } + '/v1/credit_notes/preview/lines': { /**

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.

*/ - get: operations["GetCreditNotesPreviewLines"]; - }; - "/v1/credit_notes/{credit_note}/lines": { + get: operations['GetCreditNotesPreviewLines'] + } + '/v1/credit_notes/{credit_note}/lines': { /**

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

*/ - get: operations["GetCreditNotesCreditNoteLines"]; - }; - "/v1/credit_notes/{id}": { + get: operations['GetCreditNotesCreditNoteLines'] + } + '/v1/credit_notes/{id}': { /**

Retrieves the credit note object with the given identifier.

*/ - get: operations["GetCreditNotesId"]; + get: operations['GetCreditNotesId'] /**

Updates an existing credit note.

*/ - post: operations["PostCreditNotesId"]; - }; - "/v1/credit_notes/{id}/void": { + post: operations['PostCreditNotesId'] + } + '/v1/credit_notes/{id}/void': { /**

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

*/ - post: operations["PostCreditNotesIdVoid"]; - }; - "/v1/customers": { + post: operations['PostCreditNotesIdVoid'] + } + '/v1/customers': { /**

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

*/ - get: operations["GetCustomers"]; + get: operations['GetCustomers'] /**

Creates a new customer object.

*/ - post: operations["PostCustomers"]; - }; - "/v1/customers/{customer}": { + post: operations['PostCustomers'] + } + '/v1/customers/{customer}': { /**

Retrieves a Customer object.

*/ - get: operations["GetCustomersCustomer"]; + get: operations['GetCustomersCustomer'] /** *

Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the source parameter, that becomes the customer’s active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the source parameter: for each of the customer’s current subscriptions, if the subscription bills automatically and is in the past_due state, then the latest open invoice for the subscription with automatic collection enabled will be retried. This retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice. Changing the default_source for a customer will not trigger this behavior.

* *

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

*/ - post: operations["PostCustomersCustomer"]; + post: operations['PostCustomersCustomer'] /**

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

*/ - delete: operations["DeleteCustomersCustomer"]; - }; - "/v1/customers/{customer}/balance_transactions": { + delete: operations['DeleteCustomersCustomer'] + } + '/v1/customers/{customer}/balance_transactions': { /**

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

*/ - get: operations["GetCustomersCustomerBalanceTransactions"]; + get: operations['GetCustomersCustomerBalanceTransactions'] /**

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

*/ - post: operations["PostCustomersCustomerBalanceTransactions"]; - }; - "/v1/customers/{customer}/balance_transactions/{transaction}": { + post: operations['PostCustomersCustomerBalanceTransactions'] + } + '/v1/customers/{customer}/balance_transactions/{transaction}': { /**

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

*/ - get: operations["GetCustomersCustomerBalanceTransactionsTransaction"]; + get: operations['GetCustomersCustomerBalanceTransactionsTransaction'] /**

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

*/ - post: operations["PostCustomersCustomerBalanceTransactionsTransaction"]; - }; - "/v1/customers/{customer}/bank_accounts": { + post: operations['PostCustomersCustomerBalanceTransactionsTransaction'] + } + '/v1/customers/{customer}/bank_accounts': { /**

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.

*/ - get: operations["GetCustomersCustomerBankAccounts"]; + get: operations['GetCustomersCustomerBankAccounts'] /** *

When you create a new credit card, you must specify a customer or recipient on which to create it.

* @@ -536,27 +536,27 @@ export type paths = { * 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.

*/ - post: operations["PostCustomersCustomerBankAccounts"]; - }; - "/v1/customers/{customer}/bank_accounts/{id}": { + post: operations['PostCustomersCustomerBankAccounts'] + } + '/v1/customers/{customer}/bank_accounts/{id}': { /**

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.

*/ - get: operations["GetCustomersCustomerBankAccountsId"]; + get: operations['GetCustomersCustomerBankAccountsId'] /**

Update a specified source for a given customer.

*/ - post: operations["PostCustomersCustomerBankAccountsId"]; + post: operations['PostCustomersCustomerBankAccountsId'] /**

Delete a specified source for a given customer.

*/ - delete: operations["DeleteCustomersCustomerBankAccountsId"]; - }; - "/v1/customers/{customer}/bank_accounts/{id}/verify": { + delete: operations['DeleteCustomersCustomerBankAccountsId'] + } + '/v1/customers/{customer}/bank_accounts/{id}/verify': { /**

Verify a specified bank account for a given customer.

*/ - post: operations["PostCustomersCustomerBankAccountsIdVerify"]; - }; - "/v1/customers/{customer}/cards": { + post: operations['PostCustomersCustomerBankAccountsIdVerify'] + } + '/v1/customers/{customer}/cards': { /** *

You can see a list of the cards belonging to a customer. * Note that the 10 most recent sources are always available on the Customer 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 cards.

*/ - get: operations["GetCustomersCustomerCards"]; + get: operations['GetCustomersCustomerCards'] /** *

When you create a new credit card, you must specify a customer or recipient on which to create it.

* @@ -564,28 +564,28 @@ export type paths = { * 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.

*/ - post: operations["PostCustomersCustomerCards"]; - }; - "/v1/customers/{customer}/cards/{id}": { + post: operations['PostCustomersCustomerCards'] + } + '/v1/customers/{customer}/cards/{id}': { /**

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.

*/ - get: operations["GetCustomersCustomerCardsId"]; + get: operations['GetCustomersCustomerCardsId'] /**

Update a specified source for a given customer.

*/ - post: operations["PostCustomersCustomerCardsId"]; + post: operations['PostCustomersCustomerCardsId'] /**

Delete a specified source for a given customer.

*/ - delete: operations["DeleteCustomersCustomerCardsId"]; - }; - "/v1/customers/{customer}/discount": { - get: operations["GetCustomersCustomerDiscount"]; + delete: operations['DeleteCustomersCustomerCardsId'] + } + '/v1/customers/{customer}/discount': { + get: operations['GetCustomersCustomerDiscount'] /**

Removes the currently applied discount on a customer.

*/ - delete: operations["DeleteCustomersCustomerDiscount"]; - }; - "/v1/customers/{customer}/payment_methods": { + delete: operations['DeleteCustomersCustomerDiscount'] + } + '/v1/customers/{customer}/payment_methods': { /**

Returns a list of PaymentMethods for a given Customer

*/ - get: operations["GetCustomersCustomerPaymentMethods"]; - }; - "/v1/customers/{customer}/sources": { + get: operations['GetCustomersCustomerPaymentMethods'] + } + '/v1/customers/{customer}/sources': { /**

List sources for a specified customer.

*/ - get: operations["GetCustomersCustomerSources"]; + get: operations['GetCustomersCustomerSources'] /** *

When you create a new credit card, you must specify a customer or recipient on which to create it.

* @@ -593,31 +593,31 @@ export type paths = { * 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.

*/ - post: operations["PostCustomersCustomerSources"]; - }; - "/v1/customers/{customer}/sources/{id}": { + post: operations['PostCustomersCustomerSources'] + } + '/v1/customers/{customer}/sources/{id}': { /**

Retrieve a specified source for a given customer.

*/ - get: operations["GetCustomersCustomerSourcesId"]; + get: operations['GetCustomersCustomerSourcesId'] /**

Update a specified source for a given customer.

*/ - post: operations["PostCustomersCustomerSourcesId"]; + post: operations['PostCustomersCustomerSourcesId'] /**

Delete a specified source for a given customer.

*/ - delete: operations["DeleteCustomersCustomerSourcesId"]; - }; - "/v1/customers/{customer}/sources/{id}/verify": { + delete: operations['DeleteCustomersCustomerSourcesId'] + } + '/v1/customers/{customer}/sources/{id}/verify': { /**

Verify a specified bank account for a given customer.

*/ - post: operations["PostCustomersCustomerSourcesIdVerify"]; - }; - "/v1/customers/{customer}/subscriptions": { + post: operations['PostCustomersCustomerSourcesIdVerify'] + } + '/v1/customers/{customer}/subscriptions': { /**

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.

*/ - get: operations["GetCustomersCustomerSubscriptions"]; + get: operations['GetCustomersCustomerSubscriptions'] /**

Creates a new subscription on an existing customer.

*/ - post: operations["PostCustomersCustomerSubscriptions"]; - }; - "/v1/customers/{customer}/subscriptions/{subscription_exposed_id}": { + post: operations['PostCustomersCustomerSubscriptions'] + } + '/v1/customers/{customer}/subscriptions/{subscription_exposed_id}': { /**

Retrieves the subscription with the given ID.

*/ - get: operations["GetCustomersCustomerSubscriptionsSubscriptionExposedId"]; + get: operations['GetCustomersCustomerSubscriptionsSubscriptionExposedId'] /**

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.

*/ - post: operations["PostCustomersCustomerSubscriptionsSubscriptionExposedId"]; + post: operations['PostCustomersCustomerSubscriptionsSubscriptionExposedId'] /** *

Cancels a customer’s subscription. If you set the at_period_end parameter to true, the subscription will remain active until the end of the period, at which point it will be canceled and not renewed. Otherwise, with the default false value, the subscription is terminated immediately. In either case, the customer will not be charged again for the subscription.

* @@ -625,108 +625,108 @@ export type paths = { * *

By default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.

*/ - delete: operations["DeleteCustomersCustomerSubscriptionsSubscriptionExposedId"]; - }; - "/v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discount": { - get: operations["GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount"]; + delete: operations['DeleteCustomersCustomerSubscriptionsSubscriptionExposedId'] + } + '/v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discount': { + get: operations['GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount'] /**

Removes the currently applied discount on a customer.

*/ - delete: operations["DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount"]; - }; - "/v1/customers/{customer}/tax_ids": { + delete: operations['DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount'] + } + '/v1/customers/{customer}/tax_ids': { /**

Returns a list of tax IDs for a customer.

*/ - get: operations["GetCustomersCustomerTaxIds"]; + get: operations['GetCustomersCustomerTaxIds'] /**

Creates a new TaxID object for a customer.

*/ - post: operations["PostCustomersCustomerTaxIds"]; - }; - "/v1/customers/{customer}/tax_ids/{id}": { + post: operations['PostCustomersCustomerTaxIds'] + } + '/v1/customers/{customer}/tax_ids/{id}': { /**

Retrieves the TaxID object with the given identifier.

*/ - get: operations["GetCustomersCustomerTaxIdsId"]; + get: operations['GetCustomersCustomerTaxIdsId'] /**

Deletes an existing TaxID object.

*/ - delete: operations["DeleteCustomersCustomerTaxIdsId"]; - }; - "/v1/disputes": { + delete: operations['DeleteCustomersCustomerTaxIdsId'] + } + '/v1/disputes': { /**

Returns a list of your disputes.

*/ - get: operations["GetDisputes"]; - }; - "/v1/disputes/{dispute}": { + get: operations['GetDisputes'] + } + '/v1/disputes/{dispute}': { /**

Retrieves the dispute with the given ID.

*/ - get: operations["GetDisputesDispute"]; + get: operations['GetDisputesDispute'] /** *

When you get a dispute, contacting your customer is always the best first step. If that doesn’t work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your dashboard, but if you prefer, you can use the API to submit evidence programmatically.

* *

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.

*/ - post: operations["PostDisputesDispute"]; - }; - "/v1/disputes/{dispute}/close": { + post: operations['PostDisputesDispute'] + } + '/v1/disputes/{dispute}/close': { /** *

Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.

* *

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

*/ - post: operations["PostDisputesDisputeClose"]; - }; - "/v1/ephemeral_keys": { + post: operations['PostDisputesDisputeClose'] + } + '/v1/ephemeral_keys': { /**

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

*/ - post: operations["PostEphemeralKeys"]; - }; - "/v1/ephemeral_keys/{key}": { + post: operations['PostEphemeralKeys'] + } + '/v1/ephemeral_keys/{key}': { /**

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

*/ - delete: operations["DeleteEphemeralKeysKey"]; - }; - "/v1/events": { + delete: operations['DeleteEphemeralKeysKey'] + } + '/v1/events': { /**

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).

*/ - get: operations["GetEvents"]; - }; - "/v1/events/{id}": { + get: operations['GetEvents'] + } + '/v1/events/{id}': { /**

Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.

*/ - get: operations["GetEventsId"]; - }; - "/v1/exchange_rates": { + get: operations['GetEventsId'] + } + '/v1/exchange_rates': { /**

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.

*/ - get: operations["GetExchangeRates"]; - }; - "/v1/exchange_rates/{rate_id}": { + get: operations['GetExchangeRates'] + } + '/v1/exchange_rates/{rate_id}': { /**

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

*/ - get: operations["GetExchangeRatesRateId"]; - }; - "/v1/file_links": { + get: operations['GetExchangeRatesRateId'] + } + '/v1/file_links': { /**

Returns a list of file links.

*/ - get: operations["GetFileLinks"]; + get: operations['GetFileLinks'] /**

Creates a new file link object.

*/ - post: operations["PostFileLinks"]; - }; - "/v1/file_links/{link}": { + post: operations['PostFileLinks'] + } + '/v1/file_links/{link}': { /**

Retrieves the file link with the given ID.

*/ - get: operations["GetFileLinksLink"]; + get: operations['GetFileLinksLink'] /**

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

*/ - post: operations["PostFileLinksLink"]; - }; - "/v1/files": { + post: operations['PostFileLinksLink'] + } + '/v1/files': { /**

Returns a list of the files that your account has access to. The files are returned sorted by creation date, with the most recently created files appearing first.

*/ - get: operations["GetFiles"]; + get: operations['GetFiles'] /** *

To upload a file to Stripe, you’ll need to send a request of type multipart/form-data. The request should contain the file you would like to upload, as well as the parameters for creating a file.

* *

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

*/ - post: operations["PostFiles"]; - }; - "/v1/files/{file}": { + post: operations['PostFiles'] + } + '/v1/files/{file}': { /**

Retrieves the details of an existing file object. Supply the unique file ID from a file, and Stripe will return the corresponding file object. To access file contents, see the File Upload Guide.

*/ - get: operations["GetFilesFile"]; - }; - "/v1/identity/verification_reports": { + get: operations['GetFilesFile'] + } + '/v1/identity/verification_reports': { /**

List all verification reports.

*/ - get: operations["GetIdentityVerificationReports"]; - }; - "/v1/identity/verification_reports/{report}": { + get: operations['GetIdentityVerificationReports'] + } + '/v1/identity/verification_reports/{report}': { /**

Retrieves an existing VerificationReport

*/ - get: operations["GetIdentityVerificationReportsReport"]; - }; - "/v1/identity/verification_sessions": { + get: operations['GetIdentityVerificationReportsReport'] + } + '/v1/identity/verification_sessions': { /**

Returns a list of VerificationSessions

*/ - get: operations["GetIdentityVerificationSessions"]; + get: operations['GetIdentityVerificationSessions'] /** *

Creates a VerificationSession object.

* @@ -736,33 +736,33 @@ export type paths = { * *

Related guide: Verify your users’ identity documents.

*/ - post: operations["PostIdentityVerificationSessions"]; - }; - "/v1/identity/verification_sessions/{session}": { + post: operations['PostIdentityVerificationSessions'] + } + '/v1/identity/verification_sessions/{session}': { /** *

Retrieves the details of a VerificationSession that was previously created.

* *

When the session status is requires_input, you can use this method to retrieve a valid * client_secret or url to allow re-submission.

*/ - get: operations["GetIdentityVerificationSessionsSession"]; + get: operations['GetIdentityVerificationSessionsSession'] /** *

Updates a VerificationSession object.

* *

When the session status is requires_input, you can use this method to update the * verification check and options.

*/ - post: operations["PostIdentityVerificationSessionsSession"]; - }; - "/v1/identity/verification_sessions/{session}/cancel": { + post: operations['PostIdentityVerificationSessionsSession'] + } + '/v1/identity/verification_sessions/{session}/cancel': { /** *

A VerificationSession object can be canceled when it is in requires_input status.

* *

Once canceled, future submission attempts are disabled. This cannot be undone. Learn more.

*/ - post: operations["PostIdentityVerificationSessionsSessionCancel"]; - }; - "/v1/identity/verification_sessions/{session}/redact": { + post: operations['PostIdentityVerificationSessionsSessionCancel'] + } + '/v1/identity/verification_sessions/{session}/redact': { /** *

Redact a VerificationSession to remove all collected information from Stripe. This will redact * the VerificationSession and all objects related to it, including VerificationReports, Events, @@ -784,29 +784,29 @@ export type paths = { * *

Learn more.

*/ - post: operations["PostIdentityVerificationSessionsSessionRedact"]; - }; - "/v1/invoiceitems": { + post: operations['PostIdentityVerificationSessionsSessionRedact'] + } + '/v1/invoiceitems': { /**

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

*/ - get: operations["GetInvoiceitems"]; + get: operations['GetInvoiceitems'] /**

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.

*/ - post: operations["PostInvoiceitems"]; - }; - "/v1/invoiceitems/{invoiceitem}": { + post: operations['PostInvoiceitems'] + } + '/v1/invoiceitems/{invoiceitem}': { /**

Retrieves the invoice item with the given ID.

*/ - get: operations["GetInvoiceitemsInvoiceitem"]; + get: operations['GetInvoiceitemsInvoiceitem'] /**

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.

*/ - post: operations["PostInvoiceitemsInvoiceitem"]; + post: operations['PostInvoiceitemsInvoiceitem'] /**

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.

*/ - delete: operations["DeleteInvoiceitemsInvoiceitem"]; - }; - "/v1/invoices": { + delete: operations['DeleteInvoiceitemsInvoiceitem'] + } + '/v1/invoices': { /**

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.

*/ - get: operations["GetInvoices"]; + get: operations['GetInvoices'] /**

This endpoint creates a draft invoice for a given customer. The draft invoice created pulls in all pending invoice items on that customer, including prorations. The invoice remains a draft until you finalize the invoice, which allows you to pay or send the invoice to your customers.

*/ - post: operations["PostInvoices"]; - }; - "/v1/invoices/upcoming": { + post: operations['PostInvoices'] + } + '/v1/invoices/upcoming': { /** *

At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.

* @@ -814,15 +814,15 @@ export type paths = { * *

You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass a proration_date parameter when doing the actual subscription update. The value passed in should be the same as the subscription_proration_date returned on the upcoming invoice resource. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_proration_date on the upcoming invoice resource.

*/ - get: operations["GetInvoicesUpcoming"]; - }; - "/v1/invoices/upcoming/lines": { + get: operations['GetInvoicesUpcoming'] + } + '/v1/invoices/upcoming/lines': { /**

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.

*/ - get: operations["GetInvoicesUpcomingLines"]; - }; - "/v1/invoices/{invoice}": { + get: operations['GetInvoicesUpcomingLines'] + } + '/v1/invoices/{invoice}': { /**

Retrieves the invoice with the given ID.

*/ - get: operations["GetInvoicesInvoice"]; + get: operations['GetInvoicesInvoice'] /** *

Draft invoices are fully editable. Once an invoice is finalized, * monetary values, as well as collection_method, become uneditable.

@@ -831,163 +831,163 @@ export type paths = { * sending reminders for, or automatically reconciling invoices, pass * auto_advance=false.

*/ - post: operations["PostInvoicesInvoice"]; + post: operations['PostInvoicesInvoice'] /**

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.

*/ - delete: operations["DeleteInvoicesInvoice"]; - }; - "/v1/invoices/{invoice}/finalize": { + delete: operations['DeleteInvoicesInvoice'] + } + '/v1/invoices/{invoice}/finalize': { /**

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.

*/ - post: operations["PostInvoicesInvoiceFinalize"]; - }; - "/v1/invoices/{invoice}/lines": { + post: operations['PostInvoicesInvoiceFinalize'] + } + '/v1/invoices/{invoice}/lines': { /**

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.

*/ - get: operations["GetInvoicesInvoiceLines"]; - }; - "/v1/invoices/{invoice}/mark_uncollectible": { + get: operations['GetInvoicesInvoiceLines'] + } + '/v1/invoices/{invoice}/mark_uncollectible': { /**

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

*/ - post: operations["PostInvoicesInvoiceMarkUncollectible"]; - }; - "/v1/invoices/{invoice}/pay": { + post: operations['PostInvoicesInvoiceMarkUncollectible'] + } + '/v1/invoices/{invoice}/pay': { /**

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.

*/ - post: operations["PostInvoicesInvoicePay"]; - }; - "/v1/invoices/{invoice}/send": { + post: operations['PostInvoicesInvoicePay'] + } + '/v1/invoices/{invoice}/send': { /** *

Stripe will automatically send invoices to customers according to your subscriptions settings. However, if you’d like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.

* *

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

*/ - post: operations["PostInvoicesInvoiceSend"]; - }; - "/v1/invoices/{invoice}/void": { + post: operations['PostInvoicesInvoiceSend'] + } + '/v1/invoices/{invoice}/void': { /**

Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.

*/ - post: operations["PostInvoicesInvoiceVoid"]; - }; - "/v1/issuer_fraud_records": { + post: operations['PostInvoicesInvoiceVoid'] + } + '/v1/issuer_fraud_records': { /**

Returns a list of issuer fraud records.

*/ - get: operations["GetIssuerFraudRecords"]; - }; - "/v1/issuer_fraud_records/{issuer_fraud_record}": { + get: operations['GetIssuerFraudRecords'] + } + '/v1/issuer_fraud_records/{issuer_fraud_record}': { /** *

Retrieves the details of an issuer fraud record that has previously been created.

* *

Please refer to the issuer fraud record object reference for more details.

*/ - get: operations["GetIssuerFraudRecordsIssuerFraudRecord"]; - }; - "/v1/issuing/authorizations": { + get: operations['GetIssuerFraudRecordsIssuerFraudRecord'] + } + '/v1/issuing/authorizations': { /**

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.

*/ - get: operations["GetIssuingAuthorizations"]; - }; - "/v1/issuing/authorizations/{authorization}": { + get: operations['GetIssuingAuthorizations'] + } + '/v1/issuing/authorizations/{authorization}': { /**

Retrieves an Issuing Authorization object.

*/ - get: operations["GetIssuingAuthorizationsAuthorization"]; + get: operations['GetIssuingAuthorizationsAuthorization'] /**

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

*/ - post: operations["PostIssuingAuthorizationsAuthorization"]; - }; - "/v1/issuing/authorizations/{authorization}/approve": { + post: operations['PostIssuingAuthorizationsAuthorization'] + } + '/v1/issuing/authorizations/{authorization}/approve': { /**

Approves a pending Issuing Authorization object. This request should be made within the timeout window of the real-time authorization flow.

*/ - post: operations["PostIssuingAuthorizationsAuthorizationApprove"]; - }; - "/v1/issuing/authorizations/{authorization}/decline": { + post: operations['PostIssuingAuthorizationsAuthorizationApprove'] + } + '/v1/issuing/authorizations/{authorization}/decline': { /**

Declines a pending Issuing Authorization object. This request should be made within the timeout window of the real time authorization flow.

*/ - post: operations["PostIssuingAuthorizationsAuthorizationDecline"]; - }; - "/v1/issuing/cardholders": { + post: operations['PostIssuingAuthorizationsAuthorizationDecline'] + } + '/v1/issuing/cardholders': { /**

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

*/ - get: operations["GetIssuingCardholders"]; + get: operations['GetIssuingCardholders'] /**

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

*/ - post: operations["PostIssuingCardholders"]; - }; - "/v1/issuing/cardholders/{cardholder}": { + post: operations['PostIssuingCardholders'] + } + '/v1/issuing/cardholders/{cardholder}': { /**

Retrieves an Issuing Cardholder object.

*/ - get: operations["GetIssuingCardholdersCardholder"]; + get: operations['GetIssuingCardholdersCardholder'] /**

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

*/ - post: operations["PostIssuingCardholdersCardholder"]; - }; - "/v1/issuing/cards": { + post: operations['PostIssuingCardholdersCardholder'] + } + '/v1/issuing/cards': { /**

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

*/ - get: operations["GetIssuingCards"]; + get: operations['GetIssuingCards'] /**

Creates an Issuing Card object.

*/ - post: operations["PostIssuingCards"]; - }; - "/v1/issuing/cards/{card}": { + post: operations['PostIssuingCards'] + } + '/v1/issuing/cards/{card}': { /**

Retrieves an Issuing Card object.

*/ - get: operations["GetIssuingCardsCard"]; + get: operations['GetIssuingCardsCard'] /**

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

*/ - post: operations["PostIssuingCardsCard"]; - }; - "/v1/issuing/disputes": { + post: operations['PostIssuingCardsCard'] + } + '/v1/issuing/disputes': { /**

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

*/ - get: operations["GetIssuingDisputes"]; + get: operations['GetIssuingDisputes'] /**

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.

*/ - post: operations["PostIssuingDisputes"]; - }; - "/v1/issuing/disputes/{dispute}": { + post: operations['PostIssuingDisputes'] + } + '/v1/issuing/disputes/{dispute}': { /**

Retrieves an Issuing Dispute object.

*/ - get: operations["GetIssuingDisputesDispute"]; + get: operations['GetIssuingDisputesDispute'] /**

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.

*/ - post: operations["PostIssuingDisputesDispute"]; - }; - "/v1/issuing/disputes/{dispute}/submit": { + post: operations['PostIssuingDisputesDispute'] + } + '/v1/issuing/disputes/{dispute}/submit': { /**

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.

*/ - post: operations["PostIssuingDisputesDisputeSubmit"]; - }; - "/v1/issuing/settlements": { + post: operations['PostIssuingDisputesDisputeSubmit'] + } + '/v1/issuing/settlements': { /**

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

*/ - get: operations["GetIssuingSettlements"]; - }; - "/v1/issuing/settlements/{settlement}": { + get: operations['GetIssuingSettlements'] + } + '/v1/issuing/settlements/{settlement}': { /**

Retrieves an Issuing Settlement object.

*/ - get: operations["GetIssuingSettlementsSettlement"]; + get: operations['GetIssuingSettlementsSettlement'] /**

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

*/ - post: operations["PostIssuingSettlementsSettlement"]; - }; - "/v1/issuing/transactions": { + post: operations['PostIssuingSettlementsSettlement'] + } + '/v1/issuing/transactions': { /**

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.

*/ - get: operations["GetIssuingTransactions"]; - }; - "/v1/issuing/transactions/{transaction}": { + get: operations['GetIssuingTransactions'] + } + '/v1/issuing/transactions/{transaction}': { /**

Retrieves an Issuing Transaction object.

*/ - get: operations["GetIssuingTransactionsTransaction"]; + get: operations['GetIssuingTransactionsTransaction'] /**

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

*/ - post: operations["PostIssuingTransactionsTransaction"]; - }; - "/v1/mandates/{mandate}": { + post: operations['PostIssuingTransactionsTransaction'] + } + '/v1/mandates/{mandate}': { /**

Retrieves a Mandate object.

*/ - get: operations["GetMandatesMandate"]; - }; - "/v1/order_returns": { + get: operations['GetMandatesMandate'] + } + '/v1/order_returns': { /**

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

*/ - get: operations["GetOrderReturns"]; - }; - "/v1/order_returns/{id}": { + get: operations['GetOrderReturns'] + } + '/v1/order_returns/{id}': { /**

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

*/ - get: operations["GetOrderReturnsId"]; - }; - "/v1/orders": { + get: operations['GetOrderReturnsId'] + } + '/v1/orders': { /**

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

*/ - get: operations["GetOrders"]; + get: operations['GetOrders'] /**

Creates a new order object.

*/ - post: operations["PostOrders"]; - }; - "/v1/orders/{id}": { + post: operations['PostOrders'] + } + '/v1/orders/{id}': { /**

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

*/ - get: operations["GetOrdersId"]; + get: operations['GetOrdersId'] /**

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

*/ - post: operations["PostOrdersId"]; - }; - "/v1/orders/{id}/pay": { + post: operations['PostOrdersId'] + } + '/v1/orders/{id}/pay': { /**

Pay an order by providing a source to create a payment.

*/ - post: operations["PostOrdersIdPay"]; - }; - "/v1/orders/{id}/returns": { + post: operations['PostOrdersIdPay'] + } + '/v1/orders/{id}/returns': { /**

Return all or part of an order. The order must have a status of paid or fulfilled before it can be returned. Once all items have been returned, the order will become canceled or returned depending on which status the order started in.

*/ - post: operations["PostOrdersIdReturns"]; - }; - "/v1/payment_intents": { + post: operations['PostOrdersIdReturns'] + } + '/v1/payment_intents': { /**

Returns a list of PaymentIntents.

*/ - get: operations["GetPaymentIntents"]; + get: operations['GetPaymentIntents'] /** *

Creates a PaymentIntent object.

* @@ -1000,9 +1000,9 @@ export type paths = { * available in the confirm API when confirm=true * is supplied.

*/ - post: operations["PostPaymentIntents"]; - }; - "/v1/payment_intents/{intent}": { + post: operations['PostPaymentIntents'] + } + '/v1/payment_intents/{intent}': { /** *

Retrieves the details of a PaymentIntent that has previously been created.

* @@ -1010,7 +1010,7 @@ export type paths = { * *

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

*/ - get: operations["GetPaymentIntentsIntent"]; + get: operations['GetPaymentIntentsIntent'] /** *

Updates properties on a PaymentIntent object without confirming.

* @@ -1020,17 +1020,17 @@ export type paths = { * update and confirm at the same time, we recommend updating properties via * the confirm API instead.

*/ - post: operations["PostPaymentIntentsIntent"]; - }; - "/v1/payment_intents/{intent}/cancel": { + post: operations['PostPaymentIntentsIntent'] + } + '/v1/payment_intents/{intent}/cancel': { /** *

A PaymentIntent object can be canceled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action, or processing.

* *

Once canceled, no additional charges will be made by the PaymentIntent and any operations on the PaymentIntent will fail with an error. For PaymentIntents with status=’requires_capture’, the remaining amount_capturable will automatically be refunded.

*/ - post: operations["PostPaymentIntentsIntentCancel"]; - }; - "/v1/payment_intents/{intent}/capture": { + post: operations['PostPaymentIntentsIntentCancel'] + } + '/v1/payment_intents/{intent}/capture': { /** *

Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.

* @@ -1038,9 +1038,9 @@ export type paths = { * *

Learn more about separate authorization and capture.

*/ - post: operations["PostPaymentIntentsIntentCapture"]; - }; - "/v1/payment_intents/{intent}/confirm": { + post: operations['PostPaymentIntentsIntentCapture'] + } + '/v1/payment_intents/{intent}/confirm': { /** *

Confirm that your customer intends to pay with current or provided * payment method. Upon confirmation, the PaymentIntent will attempt to initiate @@ -1068,45 +1068,45 @@ export type paths = { * attempt. Read the expanded documentation * to learn more about manual confirmation.

*/ - post: operations["PostPaymentIntentsIntentConfirm"]; - }; - "/v1/payment_intents/{intent}/verify_microdeposits": { + post: operations['PostPaymentIntentsIntentConfirm'] + } + '/v1/payment_intents/{intent}/verify_microdeposits': { /**

Verifies microdeposits on a PaymentIntent object.

*/ - post: operations["PostPaymentIntentsIntentVerifyMicrodeposits"]; - }; - "/v1/payment_links": { + post: operations['PostPaymentIntentsIntentVerifyMicrodeposits'] + } + '/v1/payment_links': { /**

Returns a list of your payment links.

*/ - get: operations["GetPaymentLinks"]; + get: operations['GetPaymentLinks'] /**

Creates a payment link.

*/ - post: operations["PostPaymentLinks"]; - }; - "/v1/payment_links/{payment_link}": { + post: operations['PostPaymentLinks'] + } + '/v1/payment_links/{payment_link}': { /**

Retrieve a payment link.

*/ - get: operations["GetPaymentLinksPaymentLink"]; + get: operations['GetPaymentLinksPaymentLink'] /**

Updates a payment link.

*/ - post: operations["PostPaymentLinksPaymentLink"]; - }; - "/v1/payment_links/{payment_link}/line_items": { + post: operations['PostPaymentLinksPaymentLink'] + } + '/v1/payment_links/{payment_link}/line_items': { /**

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.

*/ - get: operations["GetPaymentLinksPaymentLinkLineItems"]; - }; - "/v1/payment_methods": { + get: operations['GetPaymentLinksPaymentLinkLineItems'] + } + '/v1/payment_methods': { /**

Returns a list of PaymentMethods. For listing a customer’s payment methods, you should use List a Customer’s PaymentMethods

*/ - get: operations["GetPaymentMethods"]; + get: operations['GetPaymentMethods'] /** *

Creates a PaymentMethod object. Read the Stripe.js reference to learn how to create PaymentMethods via Stripe.js.

* *

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.

*/ - post: operations["PostPaymentMethods"]; - }; - "/v1/payment_methods/{payment_method}": { + post: operations['PostPaymentMethods'] + } + '/v1/payment_methods/{payment_method}': { /**

Retrieves a PaymentMethod object.

*/ - get: operations["GetPaymentMethodsPaymentMethod"]; + get: operations['GetPaymentMethodsPaymentMethod'] /**

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

*/ - post: operations["PostPaymentMethodsPaymentMethod"]; - }; - "/v1/payment_methods/{payment_method}/attach": { + post: operations['PostPaymentMethodsPaymentMethod'] + } + '/v1/payment_methods/{payment_method}/attach': { /** *

Attaches a PaymentMethod object to a Customer.

* @@ -1120,15 +1120,15 @@ export type paths = { * set invoice_settings.default_payment_method, * on the Customer to the PaymentMethod’s ID.

*/ - post: operations["PostPaymentMethodsPaymentMethodAttach"]; - }; - "/v1/payment_methods/{payment_method}/detach": { + post: operations['PostPaymentMethodsPaymentMethodAttach'] + } + '/v1/payment_methods/{payment_method}/detach': { /**

Detaches a PaymentMethod object from a Customer.

*/ - post: operations["PostPaymentMethodsPaymentMethodDetach"]; - }; - "/v1/payouts": { + post: operations['PostPaymentMethodsPaymentMethodDetach'] + } + '/v1/payouts': { /**

Returns a list of existing payouts sent to third-party bank accounts or that Stripe has sent you. The payouts are returned in sorted order, with the most recently created payouts appearing first.

*/ - get: operations["GetPayouts"]; + get: operations['GetPayouts'] /** *

To send funds to your own bank account, you create a new payout object. Your Stripe balance must be able to cover the payout amount, or you’ll receive an “Insufficient Funds” error.

* @@ -1136,164 +1136,164 @@ export type paths = { * *

If you are creating a manual payout on a Stripe account that uses multiple payment source types, you’ll need to specify the source type balance that the payout should draw from. The balance object details available and pending amounts by source type.

*/ - post: operations["PostPayouts"]; - }; - "/v1/payouts/{payout}": { + post: operations['PostPayouts'] + } + '/v1/payouts/{payout}': { /**

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

*/ - get: operations["GetPayoutsPayout"]; + get: operations['GetPayoutsPayout'] /**

Updates the specified payout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request accepts only the metadata as arguments.

*/ - post: operations["PostPayoutsPayout"]; - }; - "/v1/payouts/{payout}/cancel": { + post: operations['PostPayoutsPayout'] + } + '/v1/payouts/{payout}/cancel': { /**

A previously created payout can be canceled if it has not yet been paid out. Funds will be refunded to your available balance. You may not cancel automatic Stripe payouts.

*/ - post: operations["PostPayoutsPayoutCancel"]; - }; - "/v1/payouts/{payout}/reverse": { + post: operations['PostPayoutsPayoutCancel'] + } + '/v1/payouts/{payout}/reverse': { /** *

Reverses a payout by debiting the destination bank account. Only payouts for connected accounts to US bank accounts may be reversed at this time. If the payout is in the pending status, /v1/payouts/:id/cancel should be used instead.

* *

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

*/ - post: operations["PostPayoutsPayoutReverse"]; - }; - "/v1/plans": { + post: operations['PostPayoutsPayoutReverse'] + } + '/v1/plans': { /**

Returns a list of your plans.

*/ - get: operations["GetPlans"]; + get: operations['GetPlans'] /**

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

*/ - post: operations["PostPlans"]; - }; - "/v1/plans/{plan}": { + post: operations['PostPlans'] + } + '/v1/plans/{plan}': { /**

Retrieves the plan with the given ID.

*/ - get: operations["GetPlansPlan"]; + get: operations['GetPlansPlan'] /**

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.

*/ - post: operations["PostPlansPlan"]; + post: operations['PostPlansPlan'] /**

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

*/ - delete: operations["DeletePlansPlan"]; - }; - "/v1/prices": { + delete: operations['DeletePlansPlan'] + } + '/v1/prices': { /**

Returns a list of your prices.

*/ - get: operations["GetPrices"]; + get: operations['GetPrices'] /**

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

*/ - post: operations["PostPrices"]; - }; - "/v1/prices/{price}": { + post: operations['PostPrices'] + } + '/v1/prices/{price}': { /**

Retrieves the price with the given ID.

*/ - get: operations["GetPricesPrice"]; + get: operations['GetPricesPrice'] /**

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

*/ - post: operations["PostPricesPrice"]; - }; - "/v1/products": { + post: operations['PostPricesPrice'] + } + '/v1/products': { /**

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

*/ - get: operations["GetProducts"]; + get: operations['GetProducts'] /**

Creates a new product object.

*/ - post: operations["PostProducts"]; - }; - "/v1/products/{id}": { + post: operations['PostProducts'] + } + '/v1/products/{id}': { /**

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.

*/ - get: operations["GetProductsId"]; + get: operations['GetProductsId'] /**

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

*/ - post: operations["PostProductsId"]; + post: operations['PostProductsId'] /**

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.

*/ - delete: operations["DeleteProductsId"]; - }; - "/v1/promotion_codes": { + delete: operations['DeleteProductsId'] + } + '/v1/promotion_codes': { /**

Returns a list of your promotion codes.

*/ - get: operations["GetPromotionCodes"]; + get: operations['GetPromotionCodes'] /**

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

*/ - post: operations["PostPromotionCodes"]; - }; - "/v1/promotion_codes/{promotion_code}": { + post: operations['PostPromotionCodes'] + } + '/v1/promotion_codes/{promotion_code}': { /**

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.

*/ - get: operations["GetPromotionCodesPromotionCode"]; + get: operations['GetPromotionCodesPromotionCode'] /**

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

*/ - post: operations["PostPromotionCodesPromotionCode"]; - }; - "/v1/quotes": { + post: operations['PostPromotionCodesPromotionCode'] + } + '/v1/quotes': { /**

Returns a list of your quotes.

*/ - get: operations["GetQuotes"]; + get: operations['GetQuotes'] /**

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.

*/ - post: operations["PostQuotes"]; - }; - "/v1/quotes/{quote}": { + post: operations['PostQuotes'] + } + '/v1/quotes/{quote}': { /**

Retrieves the quote with the given ID.

*/ - get: operations["GetQuotesQuote"]; + get: operations['GetQuotesQuote'] /**

A quote models prices and services for a customer.

*/ - post: operations["PostQuotesQuote"]; - }; - "/v1/quotes/{quote}/accept": { + post: operations['PostQuotesQuote'] + } + '/v1/quotes/{quote}/accept': { /**

Accepts the specified quote.

*/ - post: operations["PostQuotesQuoteAccept"]; - }; - "/v1/quotes/{quote}/cancel": { + post: operations['PostQuotesQuoteAccept'] + } + '/v1/quotes/{quote}/cancel': { /**

Cancels the quote.

*/ - post: operations["PostQuotesQuoteCancel"]; - }; - "/v1/quotes/{quote}/computed_upfront_line_items": { + post: operations['PostQuotesQuoteCancel'] + } + '/v1/quotes/{quote}/computed_upfront_line_items': { /**

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.

*/ - get: operations["GetQuotesQuoteComputedUpfrontLineItems"]; - }; - "/v1/quotes/{quote}/finalize": { + get: operations['GetQuotesQuoteComputedUpfrontLineItems'] + } + '/v1/quotes/{quote}/finalize': { /**

Finalizes the quote.

*/ - post: operations["PostQuotesQuoteFinalize"]; - }; - "/v1/quotes/{quote}/line_items": { + post: operations['PostQuotesQuoteFinalize'] + } + '/v1/quotes/{quote}/line_items': { /**

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.

*/ - get: operations["GetQuotesQuoteLineItems"]; - }; - "/v1/quotes/{quote}/pdf": { + get: operations['GetQuotesQuoteLineItems'] + } + '/v1/quotes/{quote}/pdf': { /**

Download the PDF for a finalized quote

*/ - get: operations["GetQuotesQuotePdf"]; - }; - "/v1/radar/early_fraud_warnings": { + get: operations['GetQuotesQuotePdf'] + } + '/v1/radar/early_fraud_warnings': { /**

Returns a list of early fraud warnings.

*/ - get: operations["GetRadarEarlyFraudWarnings"]; - }; - "/v1/radar/early_fraud_warnings/{early_fraud_warning}": { + get: operations['GetRadarEarlyFraudWarnings'] + } + '/v1/radar/early_fraud_warnings/{early_fraud_warning}': { /** *

Retrieves the details of an early fraud warning that has previously been created.

* *

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

*/ - get: operations["GetRadarEarlyFraudWarningsEarlyFraudWarning"]; - }; - "/v1/radar/value_list_items": { + get: operations['GetRadarEarlyFraudWarningsEarlyFraudWarning'] + } + '/v1/radar/value_list_items': { /**

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

*/ - get: operations["GetRadarValueListItems"]; + get: operations['GetRadarValueListItems'] /**

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

*/ - post: operations["PostRadarValueListItems"]; - }; - "/v1/radar/value_list_items/{item}": { + post: operations['PostRadarValueListItems'] + } + '/v1/radar/value_list_items/{item}': { /**

Retrieves a ValueListItem object.

*/ - get: operations["GetRadarValueListItemsItem"]; + get: operations['GetRadarValueListItemsItem'] /**

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

*/ - delete: operations["DeleteRadarValueListItemsItem"]; - }; - "/v1/radar/value_lists": { + delete: operations['DeleteRadarValueListItemsItem'] + } + '/v1/radar/value_lists': { /**

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

*/ - get: operations["GetRadarValueLists"]; + get: operations['GetRadarValueLists'] /**

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

*/ - post: operations["PostRadarValueLists"]; - }; - "/v1/radar/value_lists/{value_list}": { + post: operations['PostRadarValueLists'] + } + '/v1/radar/value_lists/{value_list}': { /**

Retrieves a ValueList object.

*/ - get: operations["GetRadarValueListsValueList"]; + get: operations['GetRadarValueListsValueList'] /**

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.

*/ - post: operations["PostRadarValueListsValueList"]; + post: operations['PostRadarValueListsValueList'] /**

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.

*/ - delete: operations["DeleteRadarValueListsValueList"]; - }; - "/v1/recipients": { + delete: operations['DeleteRadarValueListsValueList'] + } + '/v1/recipients': { /**

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

*/ - get: operations["GetRecipients"]; + get: operations['GetRecipients'] /** *

Creates a new Recipient object and verifies the recipient’s identity. * Also verifies the recipient’s bank account information or debit card, if either is provided.

*/ - post: operations["PostRecipients"]; - }; - "/v1/recipients/{id}": { + post: operations['PostRecipients'] + } + '/v1/recipients/{id}': { /**

Retrieves the details of an existing recipient. You need only supply the unique recipient identifier that was returned upon recipient creation.

*/ - get: operations["GetRecipientsId"]; + get: operations['GetRecipientsId'] /** *

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

@@ -1301,72 +1301,72 @@ export type paths = { *

If you update the name or tax ID, the identity verification will automatically be rerun. * If you update the bank account, the bank account validation will automatically be rerun.

*/ - post: operations["PostRecipientsId"]; + post: operations['PostRecipientsId'] /**

Permanently deletes a recipient. It cannot be undone.

*/ - delete: operations["DeleteRecipientsId"]; - }; - "/v1/refunds": { + delete: operations['DeleteRecipientsId'] + } + '/v1/refunds': { /**

Returns a list of all refunds you’ve previously created. The refunds are returned in sorted order, with the most recent refunds appearing first. For convenience, the 10 most recent refunds are always available by default on the charge object.

*/ - get: operations["GetRefunds"]; + get: operations['GetRefunds'] /**

Create a refund.

*/ - post: operations["PostRefunds"]; - }; - "/v1/refunds/{refund}": { + post: operations['PostRefunds'] + } + '/v1/refunds/{refund}': { /**

Retrieves the details of an existing refund.

*/ - get: operations["GetRefundsRefund"]; + get: operations['GetRefundsRefund'] /** *

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

* *

This request only accepts metadata as an argument.

*/ - post: operations["PostRefundsRefund"]; - }; - "/v1/reporting/report_runs": { + post: operations['PostRefundsRefund'] + } + '/v1/reporting/report_runs': { /**

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

*/ - get: operations["GetReportingReportRuns"]; + get: operations['GetReportingReportRuns'] /**

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

*/ - post: operations["PostReportingReportRuns"]; - }; - "/v1/reporting/report_runs/{report_run}": { + post: operations['PostReportingReportRuns'] + } + '/v1/reporting/report_runs/{report_run}': { /**

Retrieves the details of an existing Report Run.

*/ - get: operations["GetReportingReportRunsReportRun"]; - }; - "/v1/reporting/report_types": { + get: operations['GetReportingReportRunsReportRun'] + } + '/v1/reporting/report_types': { /**

Returns a full list of Report Types.

*/ - get: operations["GetReportingReportTypes"]; - }; - "/v1/reporting/report_types/{report_type}": { + get: operations['GetReportingReportTypes'] + } + '/v1/reporting/report_types/{report_type}': { /**

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

*/ - get: operations["GetReportingReportTypesReportType"]; - }; - "/v1/reviews": { + get: operations['GetReportingReportTypesReportType'] + } + '/v1/reviews': { /**

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.

*/ - get: operations["GetReviews"]; - }; - "/v1/reviews/{review}": { + get: operations['GetReviews'] + } + '/v1/reviews/{review}': { /**

Retrieves a Review object.

*/ - get: operations["GetReviewsReview"]; - }; - "/v1/reviews/{review}/approve": { + get: operations['GetReviewsReview'] + } + '/v1/reviews/{review}/approve': { /**

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

*/ - post: operations["PostReviewsReviewApprove"]; - }; - "/v1/setup_attempts": { + post: operations['PostReviewsReviewApprove'] + } + '/v1/setup_attempts': { /**

Returns a list of SetupAttempts associated with a provided SetupIntent.

*/ - get: operations["GetSetupAttempts"]; - }; - "/v1/setup_intents": { + get: operations['GetSetupAttempts'] + } + '/v1/setup_intents': { /**

Returns a list of SetupIntents.

*/ - get: operations["GetSetupIntents"]; + get: operations['GetSetupIntents'] /** *

Creates a SetupIntent object.

* *

After the SetupIntent is created, attach a payment method and confirm * to collect any required permissions to charge the payment method later.

*/ - post: operations["PostSetupIntents"]; - }; - "/v1/setup_intents/{intent}": { + post: operations['PostSetupIntents'] + } + '/v1/setup_intents/{intent}': { /** *

Retrieves the details of a SetupIntent that has previously been created.

* @@ -1374,19 +1374,19 @@ export type paths = { * *

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

*/ - get: operations["GetSetupIntentsIntent"]; + get: operations['GetSetupIntentsIntent'] /**

Updates a SetupIntent object.

*/ - post: operations["PostSetupIntentsIntent"]; - }; - "/v1/setup_intents/{intent}/cancel": { + post: operations['PostSetupIntentsIntent'] + } + '/v1/setup_intents/{intent}/cancel': { /** *

A SetupIntent object can be canceled when it is in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.

* *

Once canceled, setup is abandoned and any operations on the SetupIntent will fail with an error.

*/ - post: operations["PostSetupIntentsIntentCancel"]; - }; - "/v1/setup_intents/{intent}/confirm": { + post: operations['PostSetupIntentsIntentCancel'] + } + '/v1/setup_intents/{intent}/confirm': { /** *

Confirm that your customer intends to set up the current or * provided payment method. For example, you would confirm a SetupIntent @@ -1402,103 +1402,103 @@ export type paths = { * the SetupIntent will transition to the * requires_payment_method status.

*/ - post: operations["PostSetupIntentsIntentConfirm"]; - }; - "/v1/setup_intents/{intent}/verify_microdeposits": { + post: operations['PostSetupIntentsIntentConfirm'] + } + '/v1/setup_intents/{intent}/verify_microdeposits': { /**

Verifies microdeposits on a SetupIntent object.

*/ - post: operations["PostSetupIntentsIntentVerifyMicrodeposits"]; - }; - "/v1/shipping_rates": { + post: operations['PostSetupIntentsIntentVerifyMicrodeposits'] + } + '/v1/shipping_rates': { /**

Returns a list of your shipping rates.

*/ - get: operations["GetShippingRates"]; + get: operations['GetShippingRates'] /**

Creates a new shipping rate object.

*/ - post: operations["PostShippingRates"]; - }; - "/v1/shipping_rates/{shipping_rate_token}": { + post: operations['PostShippingRates'] + } + '/v1/shipping_rates/{shipping_rate_token}': { /**

Returns the shipping rate object with the given ID.

*/ - get: operations["GetShippingRatesShippingRateToken"]; + get: operations['GetShippingRatesShippingRateToken'] /**

Updates an existing shipping rate object.

*/ - post: operations["PostShippingRatesShippingRateToken"]; - }; - "/v1/sigma/scheduled_query_runs": { + post: operations['PostShippingRatesShippingRateToken'] + } + '/v1/sigma/scheduled_query_runs': { /**

Returns a list of scheduled query runs.

*/ - get: operations["GetSigmaScheduledQueryRuns"]; - }; - "/v1/sigma/scheduled_query_runs/{scheduled_query_run}": { + get: operations['GetSigmaScheduledQueryRuns'] + } + '/v1/sigma/scheduled_query_runs/{scheduled_query_run}': { /**

Retrieves the details of an scheduled query run.

*/ - get: operations["GetSigmaScheduledQueryRunsScheduledQueryRun"]; - }; - "/v1/skus": { + get: operations['GetSigmaScheduledQueryRunsScheduledQueryRun'] + } + '/v1/skus': { /**

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

*/ - get: operations["GetSkus"]; + get: operations['GetSkus'] /**

Creates a new SKU associated with a product.

*/ - post: operations["PostSkus"]; - }; - "/v1/skus/{id}": { + post: operations['PostSkus'] + } + '/v1/skus/{id}': { /**

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

*/ - get: operations["GetSkusId"]; + get: operations['GetSkusId'] /** *

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

* *

Note that a SKU’s attributes are not editable. Instead, you would need to deactivate the existing SKU and create a new one with the new attribute values.

*/ - post: operations["PostSkusId"]; + post: operations['PostSkusId'] /**

Delete a SKU. Deleting a SKU is only possible until it has been used in an order.

*/ - delete: operations["DeleteSkusId"]; - }; - "/v1/sources": { + delete: operations['DeleteSkusId'] + } + '/v1/sources': { /**

Creates a new source object.

*/ - post: operations["PostSources"]; - }; - "/v1/sources/{source}": { + post: operations['PostSources'] + } + '/v1/sources/{source}': { /**

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.

*/ - get: operations["GetSourcesSource"]; + get: operations['GetSourcesSource'] /** *

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

* *

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.

*/ - post: operations["PostSourcesSource"]; - }; - "/v1/sources/{source}/mandate_notifications/{mandate_notification}": { + post: operations['PostSourcesSource'] + } + '/v1/sources/{source}/mandate_notifications/{mandate_notification}': { /**

Retrieves a new Source MandateNotification.

*/ - get: operations["GetSourcesSourceMandateNotificationsMandateNotification"]; - }; - "/v1/sources/{source}/source_transactions": { + get: operations['GetSourcesSourceMandateNotificationsMandateNotification'] + } + '/v1/sources/{source}/source_transactions': { /**

List source transactions for a given source.

*/ - get: operations["GetSourcesSourceSourceTransactions"]; - }; - "/v1/sources/{source}/source_transactions/{source_transaction}": { + get: operations['GetSourcesSourceSourceTransactions'] + } + '/v1/sources/{source}/source_transactions/{source_transaction}': { /**

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.

*/ - get: operations["GetSourcesSourceSourceTransactionsSourceTransaction"]; - }; - "/v1/sources/{source}/verify": { + get: operations['GetSourcesSourceSourceTransactionsSourceTransaction'] + } + '/v1/sources/{source}/verify': { /**

Verify a given source.

*/ - post: operations["PostSourcesSourceVerify"]; - }; - "/v1/subscription_items": { + post: operations['PostSourcesSourceVerify'] + } + '/v1/subscription_items': { /**

Returns a list of your subscription items for a given subscription.

*/ - get: operations["GetSubscriptionItems"]; + get: operations['GetSubscriptionItems'] /**

Adds a new item to an existing subscription. No existing items will be changed or replaced.

*/ - post: operations["PostSubscriptionItems"]; - }; - "/v1/subscription_items/{item}": { + post: operations['PostSubscriptionItems'] + } + '/v1/subscription_items/{item}': { /**

Retrieves the subscription item with the given ID.

*/ - get: operations["GetSubscriptionItemsItem"]; + get: operations['GetSubscriptionItemsItem'] /**

Updates the plan or quantity of an item on a current subscription.

*/ - post: operations["PostSubscriptionItemsItem"]; + post: operations['PostSubscriptionItemsItem'] /**

Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.

*/ - delete: operations["DeleteSubscriptionItemsItem"]; - }; - "/v1/subscription_items/{subscription_item}/usage_record_summaries": { + delete: operations['DeleteSubscriptionItemsItem'] + } + '/v1/subscription_items/{subscription_item}/usage_record_summaries': { /** *

For the specified subscription item, returns a list of summary objects. Each object in the list provides usage information that’s been summarized from multiple usage records and over a subscription billing period (e.g., 15 usage records in the month of September).

* *

The list is sorted in reverse-chronological order (newest first). The first list item represents the most current usage period that hasn’t ended yet. Since new usage records can still be added, the returned summary information for the subscription item’s ID should be seen as unstable until the subscription billing period ends.

*/ - get: operations["GetSubscriptionItemsSubscriptionItemUsageRecordSummaries"]; - }; - "/v1/subscription_items/{subscription_item}/usage_records": { + get: operations['GetSubscriptionItemsSubscriptionItemUsageRecordSummaries'] + } + '/v1/subscription_items/{subscription_item}/usage_records': { /** *

Creates a usage record for a specified subscription item and date, and fills it with a quantity.

* @@ -1508,39 +1508,39 @@ export type paths = { * *

The default pricing model for metered billing is per-unit pricing. For finer granularity, you can configure metered billing to have a tiered pricing model.

*/ - post: operations["PostSubscriptionItemsSubscriptionItemUsageRecords"]; - }; - "/v1/subscription_schedules": { + post: operations['PostSubscriptionItemsSubscriptionItemUsageRecords'] + } + '/v1/subscription_schedules': { /**

Retrieves the list of your subscription schedules.

*/ - get: operations["GetSubscriptionSchedules"]; + get: operations['GetSubscriptionSchedules'] /**

Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.

*/ - post: operations["PostSubscriptionSchedules"]; - }; - "/v1/subscription_schedules/{schedule}": { + post: operations['PostSubscriptionSchedules'] + } + '/v1/subscription_schedules/{schedule}': { /**

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.

*/ - get: operations["GetSubscriptionSchedulesSchedule"]; + get: operations['GetSubscriptionSchedulesSchedule'] /**

Updates an existing subscription schedule.

*/ - post: operations["PostSubscriptionSchedulesSchedule"]; - }; - "/v1/subscription_schedules/{schedule}/cancel": { + post: operations['PostSubscriptionSchedulesSchedule'] + } + '/v1/subscription_schedules/{schedule}/cancel': { /**

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.

*/ - post: operations["PostSubscriptionSchedulesScheduleCancel"]; - }; - "/v1/subscription_schedules/{schedule}/release": { + post: operations['PostSubscriptionSchedulesScheduleCancel'] + } + '/v1/subscription_schedules/{schedule}/release': { /**

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.

*/ - post: operations["PostSubscriptionSchedulesScheduleRelease"]; - }; - "/v1/subscriptions": { + post: operations['PostSubscriptionSchedulesScheduleRelease'] + } + '/v1/subscriptions': { /**

By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.

*/ - get: operations["GetSubscriptions"]; + get: operations['GetSubscriptions'] /**

Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.

*/ - post: operations["PostSubscriptions"]; - }; - "/v1/subscriptions/{subscription_exposed_id}": { + post: operations['PostSubscriptions'] + } + '/v1/subscriptions/{subscription_exposed_id}': { /**

Retrieves the subscription with the given ID.

*/ - get: operations["GetSubscriptionsSubscriptionExposedId"]; + get: operations['GetSubscriptionsSubscriptionExposedId'] /**

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.

*/ - post: operations["PostSubscriptionsSubscriptionExposedId"]; + post: operations['PostSubscriptionsSubscriptionExposedId'] /** *

Cancels a customer’s subscription immediately. The customer will not be charged again for the subscription.

* @@ -1548,103 +1548,103 @@ export type paths = { * *

By default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.

*/ - delete: operations["DeleteSubscriptionsSubscriptionExposedId"]; - }; - "/v1/subscriptions/{subscription_exposed_id}/discount": { + delete: operations['DeleteSubscriptionsSubscriptionExposedId'] + } + '/v1/subscriptions/{subscription_exposed_id}/discount': { /**

Removes the currently applied discount on a subscription.

*/ - delete: operations["DeleteSubscriptionsSubscriptionExposedIdDiscount"]; - }; - "/v1/tax_codes": { + delete: operations['DeleteSubscriptionsSubscriptionExposedIdDiscount'] + } + '/v1/tax_codes': { /**

A list of all tax codes available to add to Products in order to allow specific tax calculations.

*/ - get: operations["GetTaxCodes"]; - }; - "/v1/tax_codes/{id}": { + get: operations['GetTaxCodes'] + } + '/v1/tax_codes/{id}': { /**

Retrieves the details of an existing tax code. Supply the unique tax code ID and Stripe will return the corresponding tax code information.

*/ - get: operations["GetTaxCodesId"]; - }; - "/v1/tax_rates": { + get: operations['GetTaxCodesId'] + } + '/v1/tax_rates': { /**

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

*/ - get: operations["GetTaxRates"]; + get: operations['GetTaxRates'] /**

Creates a new tax rate.

*/ - post: operations["PostTaxRates"]; - }; - "/v1/tax_rates/{tax_rate}": { + post: operations['PostTaxRates'] + } + '/v1/tax_rates/{tax_rate}': { /**

Retrieves a tax rate with the given ID

*/ - get: operations["GetTaxRatesTaxRate"]; + get: operations['GetTaxRatesTaxRate'] /**

Updates an existing tax rate.

*/ - post: operations["PostTaxRatesTaxRate"]; - }; - "/v1/terminal/connection_tokens": { + post: operations['PostTaxRatesTaxRate'] + } + '/v1/terminal/connection_tokens': { /**

To connect to a reader the Stripe Terminal SDK needs to retrieve a short-lived connection token from Stripe, proxied through your server. On your backend, add an endpoint that creates and returns a connection token.

*/ - post: operations["PostTerminalConnectionTokens"]; - }; - "/v1/terminal/locations": { + post: operations['PostTerminalConnectionTokens'] + } + '/v1/terminal/locations': { /**

Returns a list of Location objects.

*/ - get: operations["GetTerminalLocations"]; + get: operations['GetTerminalLocations'] /** *

Creates a new Location object. * For further details, including which address fields are required in each country, see the Manage locations guide.

*/ - post: operations["PostTerminalLocations"]; - }; - "/v1/terminal/locations/{location}": { + post: operations['PostTerminalLocations'] + } + '/v1/terminal/locations/{location}': { /**

Retrieves a Location object.

*/ - get: operations["GetTerminalLocationsLocation"]; + get: operations['GetTerminalLocationsLocation'] /**

Updates a Location object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ - post: operations["PostTerminalLocationsLocation"]; + post: operations['PostTerminalLocationsLocation'] /**

Deletes a Location object.

*/ - delete: operations["DeleteTerminalLocationsLocation"]; - }; - "/v1/terminal/readers": { + delete: operations['DeleteTerminalLocationsLocation'] + } + '/v1/terminal/readers': { /**

Returns a list of Reader objects.

*/ - get: operations["GetTerminalReaders"]; + get: operations['GetTerminalReaders'] /**

Creates a new Reader object.

*/ - post: operations["PostTerminalReaders"]; - }; - "/v1/terminal/readers/{reader}": { + post: operations['PostTerminalReaders'] + } + '/v1/terminal/readers/{reader}': { /**

Retrieves a Reader object.

*/ - get: operations["GetTerminalReadersReader"]; + get: operations['GetTerminalReadersReader'] /**

Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ - post: operations["PostTerminalReadersReader"]; + post: operations['PostTerminalReadersReader'] /**

Deletes a Reader object.

*/ - delete: operations["DeleteTerminalReadersReader"]; - }; - "/v1/tokens": { + delete: operations['DeleteTerminalReadersReader'] + } + '/v1/tokens': { /** *

Creates a single-use token that represents a bank account’s details. * This token can be used with any API method in place of a bank account dictionary. This token can be used only once, by attaching it to a Custom account.

*/ - post: operations["PostTokens"]; - }; - "/v1/tokens/{token}": { + post: operations['PostTokens'] + } + '/v1/tokens/{token}': { /**

Retrieves the token with the given ID.

*/ - get: operations["GetTokensToken"]; - }; - "/v1/topups": { + get: operations['GetTokensToken'] + } + '/v1/topups': { /**

Returns a list of top-ups.

*/ - get: operations["GetTopups"]; + get: operations['GetTopups'] /**

Top up the balance of an account

*/ - post: operations["PostTopups"]; - }; - "/v1/topups/{topup}": { + post: operations['PostTopups'] + } + '/v1/topups/{topup}': { /**

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.

*/ - get: operations["GetTopupsTopup"]; + get: operations['GetTopupsTopup'] /**

Updates the metadata of a top-up. Other top-up details are not editable by design.

*/ - post: operations["PostTopupsTopup"]; - }; - "/v1/topups/{topup}/cancel": { + post: operations['PostTopupsTopup'] + } + '/v1/topups/{topup}/cancel': { /**

Cancels a top-up. Only pending top-ups can be canceled.

*/ - post: operations["PostTopupsTopupCancel"]; - }; - "/v1/transfers": { + post: operations['PostTopupsTopupCancel'] + } + '/v1/transfers': { /**

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.

*/ - get: operations["GetTransfers"]; + get: operations['GetTransfers'] /**

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.

*/ - post: operations["PostTransfers"]; - }; - "/v1/transfers/{id}/reversals": { + post: operations['PostTransfers'] + } + '/v1/transfers/{id}/reversals': { /**

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.

*/ - get: operations["GetTransfersIdReversals"]; + get: operations['GetTransfersIdReversals'] /** *

When you create a new reversal, you must specify a transfer to create it on.

* @@ -1652,43 +1652,43 @@ export type paths = { * *

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.

*/ - post: operations["PostTransfersIdReversals"]; - }; - "/v1/transfers/{transfer}": { + post: operations['PostTransfersIdReversals'] + } + '/v1/transfers/{transfer}': { /**

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.

*/ - get: operations["GetTransfersTransfer"]; + get: operations['GetTransfersTransfer'] /** *

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

* *

This request accepts only metadata as an argument.

*/ - post: operations["PostTransfersTransfer"]; - }; - "/v1/transfers/{transfer}/reversals/{id}": { + post: operations['PostTransfersTransfer'] + } + '/v1/transfers/{transfer}/reversals/{id}': { /**

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.

*/ - get: operations["GetTransfersTransferReversalsId"]; + get: operations['GetTransfersTransferReversalsId'] /** *

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

* *

This request only accepts metadata and description as arguments.

*/ - post: operations["PostTransfersTransferReversalsId"]; - }; - "/v1/webhook_endpoints": { + post: operations['PostTransfersTransferReversalsId'] + } + '/v1/webhook_endpoints': { /**

Returns a list of your webhook endpoints.

*/ - get: operations["GetWebhookEndpoints"]; + get: operations['GetWebhookEndpoints'] /**

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.

*/ - post: operations["PostWebhookEndpoints"]; - }; - "/v1/webhook_endpoints/{webhook_endpoint}": { + post: operations['PostWebhookEndpoints'] + } + '/v1/webhook_endpoints/{webhook_endpoint}': { /**

Retrieves the webhook endpoint with the given ID.

*/ - get: operations["GetWebhookEndpointsWebhookEndpoint"]; + get: operations['GetWebhookEndpointsWebhookEndpoint'] /**

Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.

*/ - post: operations["PostWebhookEndpointsWebhookEndpoint"]; + post: operations['PostWebhookEndpointsWebhookEndpoint'] /**

You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.

*/ - delete: operations["DeleteWebhookEndpointsWebhookEndpoint"]; - }; -}; + delete: operations['DeleteWebhookEndpointsWebhookEndpoint'] + } +} export type components = { schemas: { @@ -1703,261 +1703,261 @@ export type components = { */ account: { /** @description Business information about the account. */ - business_profile?: Partial | null; + business_profile?: Partial | null /** * @description The business type. * @enum {string|null} */ - business_type?: ("company" | "government_entity" | "individual" | "non_profit") | null; - capabilities?: components["schemas"]["account_capabilities"]; + business_type?: ('company' | 'government_entity' | 'individual' | 'non_profit') | null + capabilities?: components['schemas']['account_capabilities'] /** @description Whether the account can create live charges. */ - charges_enabled?: boolean; - company?: components["schemas"]["legal_entity_company"]; - controller?: components["schemas"]["account_unification_account_controller"]; + charges_enabled?: boolean + company?: components['schemas']['legal_entity_company'] + controller?: components['schemas']['account_unification_account_controller'] /** @description The account's country. */ - country?: string; + country?: string /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created?: number; + created?: number /** @description 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?: string; + default_currency?: string /** @description Whether account details have been submitted. Standard accounts cannot receive payouts before this is true. */ - details_submitted?: boolean; + details_submitted?: boolean /** @description An email address associated with the account. You can treat this as metadata: it is not used for authentication or messaging account holders. */ - email?: string | null; + email?: string | null /** * ExternalAccountList * @description External accounts (bank accounts and debit cards) currently attached to this account */ external_accounts?: { /** @description The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards. */ - data: (Partial & Partial)[]; + data: (Partial & Partial)[] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - future_requirements?: components["schemas"]["account_future_requirements"]; + url: string + } + future_requirements?: components['schemas']['account_future_requirements'] /** @description Unique identifier for the object. */ - id: string; - individual?: components["schemas"]["person"]; + id: string + individual?: components['schemas']['person'] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "account"; + object: 'account' /** @description Whether Stripe can send payouts to this account. */ - payouts_enabled?: boolean; - requirements?: components["schemas"]["account_requirements"]; + payouts_enabled?: boolean + requirements?: components['schemas']['account_requirements'] /** @description Options for customizing how the account functions within Stripe. */ - settings?: Partial | null; - tos_acceptance?: components["schemas"]["account_tos_acceptance"]; + settings?: Partial | null + tos_acceptance?: components['schemas']['account_tos_acceptance'] /** * @description The Stripe account type. Can be `standard`, `express`, or `custom`. * @enum {string} */ - type?: "custom" | "express" | "standard"; - }; + type?: 'custom' | 'express' | 'standard' + } /** AccountBacsDebitPaymentsSettings */ account_bacs_debit_payments_settings: { /** @description The Bacs Direct Debit Display Name for this account. For payments made with Bacs Direct Debit, this will appear on the mandate, and as the statement descriptor. */ - display_name?: string; - }; + display_name?: string + } /** AccountBrandingSettings */ account_branding_settings: { /** @description (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?: (Partial & Partial) | null; + icon?: (Partial & Partial) | null /** @description (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?: (Partial & Partial) | null; + logo?: (Partial & Partial) | null /** @description A CSS hex color value representing the primary branding color for this account */ - primary_color?: string | null; + primary_color?: string | null /** @description A CSS hex color value representing the secondary branding color for this account */ - secondary_color?: string | null; - }; + secondary_color?: string | null + } /** AccountBusinessProfile */ account_business_profile: { /** @description [The merchant category code for the account](https://stripe.com/docs/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide. */ - mcc?: string | null; + mcc?: string | null /** @description The customer-facing business name. */ - name?: string | null; + name?: string | null /** @description 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?: string | null; + product_description?: string | null /** @description A publicly available mailing address for sending support issues to. */ - support_address?: Partial | null; + support_address?: Partial | null /** @description A publicly available email address for sending support issues to. */ - support_email?: string | null; + support_email?: string | null /** @description A publicly available phone number to call with support issues. */ - support_phone?: string | null; + support_phone?: string | null /** @description A publicly available website for handling support issues. */ - support_url?: string | null; + support_url?: string | null /** @description The business's publicly available website. */ - url?: string | null; - }; + url?: string | null + } /** AccountCapabilities */ account_capabilities: { /** * @description 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. * @enum {string} */ - acss_debit_payments?: "active" | "inactive" | "pending"; + acss_debit_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the Afterpay Clearpay capability of the account, or whether the account can directly process Afterpay Clearpay charges. * @enum {string} */ - afterpay_clearpay_payments?: "active" | "inactive" | "pending"; + afterpay_clearpay_payments?: 'active' | 'inactive' | 'pending' /** * @description 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. * @enum {string} */ - au_becs_debit_payments?: "active" | "inactive" | "pending"; + au_becs_debit_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the Bacs Direct Debits payments capability of the account, or whether the account can directly process Bacs Direct Debits charges. * @enum {string} */ - bacs_debit_payments?: "active" | "inactive" | "pending"; + bacs_debit_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the Bancontact payments capability of the account, or whether the account can directly process Bancontact charges. * @enum {string} */ - bancontact_payments?: "active" | "inactive" | "pending"; + bancontact_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the boleto payments capability of the account, or whether the account can directly process boleto charges. * @enum {string} */ - boleto_payments?: "active" | "inactive" | "pending"; + boleto_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the card issuing capability of the account, or whether you can use Issuing to distribute funds on cards * @enum {string} */ - card_issuing?: "active" | "inactive" | "pending"; + card_issuing?: 'active' | 'inactive' | 'pending' /** * @description The status of the card payments capability of the account, or whether the account can directly process credit and debit card charges. * @enum {string} */ - card_payments?: "active" | "inactive" | "pending"; + card_payments?: 'active' | 'inactive' | 'pending' /** * @description 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. * @enum {string} */ - cartes_bancaires_payments?: "active" | "inactive" | "pending"; + cartes_bancaires_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the EPS payments capability of the account, or whether the account can directly process EPS charges. * @enum {string} */ - eps_payments?: "active" | "inactive" | "pending"; + eps_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the FPX payments capability of the account, or whether the account can directly process FPX charges. * @enum {string} */ - fpx_payments?: "active" | "inactive" | "pending"; + fpx_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the giropay payments capability of the account, or whether the account can directly process giropay charges. * @enum {string} */ - giropay_payments?: "active" | "inactive" | "pending"; + giropay_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the GrabPay payments capability of the account, or whether the account can directly process GrabPay charges. * @enum {string} */ - grabpay_payments?: "active" | "inactive" | "pending"; + grabpay_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the iDEAL payments capability of the account, or whether the account can directly process iDEAL charges. * @enum {string} */ - ideal_payments?: "active" | "inactive" | "pending"; + ideal_payments?: 'active' | 'inactive' | 'pending' /** * @description 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. * @enum {string} */ - jcb_payments?: "active" | "inactive" | "pending"; + jcb_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the Klarna payments capability of the account, or whether the account can directly process Klarna charges. * @enum {string} */ - klarna_payments?: "active" | "inactive" | "pending"; + klarna_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the legacy payments capability of the account. * @enum {string} */ - legacy_payments?: "active" | "inactive" | "pending"; + legacy_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the OXXO payments capability of the account, or whether the account can directly process OXXO charges. * @enum {string} */ - oxxo_payments?: "active" | "inactive" | "pending"; + oxxo_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the P24 payments capability of the account, or whether the account can directly process P24 charges. * @enum {string} */ - p24_payments?: "active" | "inactive" | "pending"; + p24_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the SEPA Direct Debits payments capability of the account, or whether the account can directly process SEPA Direct Debits charges. * @enum {string} */ - sepa_debit_payments?: "active" | "inactive" | "pending"; + sepa_debit_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the Sofort payments capability of the account, or whether the account can directly process Sofort charges. * @enum {string} */ - sofort_payments?: "active" | "inactive" | "pending"; + sofort_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the tax reporting 1099-K (US) capability of the account. * @enum {string} */ - tax_reporting_us_1099_k?: "active" | "inactive" | "pending"; + tax_reporting_us_1099_k?: 'active' | 'inactive' | 'pending' /** * @description The status of the tax reporting 1099-MISC (US) capability of the account. * @enum {string} */ - tax_reporting_us_1099_misc?: "active" | "inactive" | "pending"; + tax_reporting_us_1099_misc?: 'active' | 'inactive' | 'pending' /** * @description The status of the transfers capability of the account, or whether your platform can transfer funds to the account. * @enum {string} */ - transfers?: "active" | "inactive" | "pending"; - }; + transfers?: 'active' | 'inactive' | 'pending' + } /** AccountCapabilityFutureRequirements */ account_capability_future_requirements: { /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ - alternatives?: components["schemas"]["account_requirements_alternative"][] | null; + alternatives?: components['schemas']['account_requirements_alternative'][] | null /** * Format: unix-time * @description Date on which `future_requirements` merges with 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?: number | null; + current_deadline?: number | null /** @description 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: string[]; + currently_due: string[] /** @description This is typed as a string for consistency with `requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is empty because fields in `future_requirements` will never disable the account. */ - disabled_reason?: string | null; + disabled_reason?: string | null /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ - errors: components["schemas"]["account_requirements_error"][]; + errors: components['schemas']['account_requirements_error'][] /** @description Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well. */ - eventually_due: string[]; + eventually_due: string[] /** @description 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: string[]; + past_due: string[] /** @description Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. */ - pending_verification: string[]; - }; + pending_verification: string[] + } /** AccountCapabilityRequirements */ account_capability_requirements: { /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ - alternatives?: components["schemas"]["account_requirements_alternative"][] | null; + alternatives?: components['schemas']['account_requirements_alternative'][] | null /** * Format: unix-time * @description 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?: number | null; + current_deadline?: number | null /** @description 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: string[]; + currently_due: string[] /** * @description If the capability is disabled, this string describes why. Can be `requirements.past_due`, `requirements.pending_verification`, `listed`, `platform_paused`, `rejected.fraud`, `rejected.listed`, `rejected.terms_of_service`, `rejected.other`, `under_review`, or `other`. * @@ -1967,62 +1967,62 @@ export type components = { * * If you believe that the rejection is in error, please contact support at https://support.stripe.com/contact/ for assistance. */ - disabled_reason?: string | null; + disabled_reason?: string | null /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ - errors: components["schemas"]["account_requirements_error"][]; + errors: components['schemas']['account_requirements_error'][] /** @description Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set. */ - eventually_due: string[]; + eventually_due: string[] /** @description Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the capability on the account. */ - past_due: string[]; + past_due: string[] /** @description Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. */ - pending_verification: string[]; - }; + pending_verification: string[] + } /** AccountCardIssuingSettings */ account_card_issuing_settings: { - tos_acceptance?: components["schemas"]["card_issuing_account_terms_of_service"]; - }; + tos_acceptance?: components['schemas']['card_issuing_account_terms_of_service'] + } /** AccountCardPaymentsSettings */ account_card_payments_settings: { - decline_on?: components["schemas"]["account_decline_charge_on"]; + decline_on?: components['schemas']['account_decline_charge_on'] /** @description 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?: string | null; - }; + statement_descriptor_prefix?: string | null + } /** AccountDashboardSettings */ account_dashboard_settings: { /** @description The display name for this account. This is used on the Stripe Dashboard to differentiate between accounts. */ - display_name?: string | null; + display_name?: string | null /** @description 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?: string | null; - }; + timezone?: string | null + } /** AccountDeclineChargeOn */ account_decline_charge_on: { /** @description 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: boolean; + avs_failure: boolean /** @description 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: boolean; - }; + cvc_failure: boolean + } /** AccountFutureRequirements */ account_future_requirements: { /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ - alternatives?: components["schemas"]["account_requirements_alternative"][] | null; + alternatives?: components['schemas']['account_requirements_alternative'][] | null /** * Format: unix-time * @description Date on which `future_requirements` merges with 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?: number | null; + current_deadline?: number | null /** @description 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?: string[] | null; + currently_due?: string[] | null /** @description This is typed as a string for consistency with `requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is empty because fields in `future_requirements` will never disable the account. */ - disabled_reason?: string | null; + disabled_reason?: string | null /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ - errors?: components["schemas"]["account_requirements_error"][] | null; + errors?: components['schemas']['account_requirements_error'][] | null /** @description Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well. */ - eventually_due?: string[] | null; + eventually_due?: string[] | null /** @description 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?: string[] | null; + past_due?: string[] | null /** @description Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. */ - pending_verification?: string[] | null; - }; + pending_verification?: string[] | null + } /** * AccountLink * @description Account Links are the means by which a Connect platform grants a connected account permission to access @@ -2035,66 +2035,66 @@ export type components = { * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** * Format: unix-time * @description The timestamp at which this account link will expire. */ - expires_at: number; + expires_at: number /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "account_link"; + object: 'account_link' /** @description The URL for the account link. */ - url: string; - }; + url: string + } /** AccountPaymentsSettings */ account_payments_settings: { /** @description 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?: string | null; + statement_descriptor?: string | null /** @description The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only) */ - statement_descriptor_kana?: string | null; + statement_descriptor_kana?: string | null /** @description The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only) */ - statement_descriptor_kanji?: string | null; - }; + statement_descriptor_kanji?: string | null + } /** AccountPayoutSettings */ account_payout_settings: { /** @description A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See our [Understanding Connect Account Balances](https://stripe.com/docs/connect/account-balances) documentation for details. Default value is `false` for Custom accounts, otherwise `true`. */ - debit_negative_balances: boolean; - schedule: components["schemas"]["transfer_schedule"]; + debit_negative_balances: boolean + schedule: components['schemas']['transfer_schedule'] /** @description 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?: string | null; - }; + statement_descriptor?: string | null + } /** AccountRequirements */ account_requirements: { /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ - alternatives?: components["schemas"]["account_requirements_alternative"][] | null; + alternatives?: components['schemas']['account_requirements_alternative'][] | null /** * Format: unix-time * @description 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?: number | null; + current_deadline?: number | null /** @description 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?: string[] | null; + currently_due?: string[] | null /** @description If the account is disabled, this string describes why. Can be `requirements.past_due`, `requirements.pending_verification`, `listed`, `platform_paused`, `rejected.fraud`, `rejected.listed`, `rejected.terms_of_service`, `rejected.other`, `under_review`, or `other`. */ - disabled_reason?: string | null; + disabled_reason?: string | null /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ - errors?: components["schemas"]["account_requirements_error"][] | null; + errors?: components['schemas']['account_requirements_error'][] | null /** @description Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set. */ - eventually_due?: string[] | null; + eventually_due?: string[] | null /** @description Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the account. */ - past_due?: string[] | null; + past_due?: string[] | null /** @description Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. */ - pending_verification?: string[] | null; - }; + pending_verification?: string[] | null + } /** AccountRequirementsAlternative */ account_requirements_alternative: { /** @description Fields that can be provided to satisfy all fields in `original_fields_due`. */ - alternative_fields_due: string[]; + alternative_fields_due: string[] /** @description Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`. */ - original_fields_due: string[]; - }; + original_fields_due: string[] + } /** AccountRequirementsError */ account_requirements_error: { /** @@ -2102,269 +2102,263 @@ export type components = { * @enum {string} */ code: - | "invalid_address_city_state_postal_code" - | "invalid_street_address" - | "invalid_value_other" - | "verification_document_address_mismatch" - | "verification_document_address_missing" - | "verification_document_corrupt" - | "verification_document_country_not_supported" - | "verification_document_dob_mismatch" - | "verification_document_duplicate_type" - | "verification_document_expired" - | "verification_document_failed_copy" - | "verification_document_failed_greyscale" - | "verification_document_failed_other" - | "verification_document_failed_test_mode" - | "verification_document_fraudulent" - | "verification_document_id_number_mismatch" - | "verification_document_id_number_missing" - | "verification_document_incomplete" - | "verification_document_invalid" - | "verification_document_issue_or_expiry_date_missing" - | "verification_document_manipulated" - | "verification_document_missing_back" - | "verification_document_missing_front" - | "verification_document_name_mismatch" - | "verification_document_name_missing" - | "verification_document_nationality_mismatch" - | "verification_document_not_readable" - | "verification_document_not_signed" - | "verification_document_not_uploaded" - | "verification_document_photo_mismatch" - | "verification_document_too_large" - | "verification_document_type_not_supported" - | "verification_failed_address_match" - | "verification_failed_business_iec_number" - | "verification_failed_document_match" - | "verification_failed_id_number_match" - | "verification_failed_keyed_identity" - | "verification_failed_keyed_match" - | "verification_failed_name_match" - | "verification_failed_other" - | "verification_failed_tax_id_match" - | "verification_failed_tax_id_not_issued" - | "verification_missing_executives" - | "verification_missing_owners" - | "verification_requires_additional_memorandum_of_associations"; + | 'invalid_address_city_state_postal_code' + | 'invalid_street_address' + | 'invalid_value_other' + | 'verification_document_address_mismatch' + | 'verification_document_address_missing' + | 'verification_document_corrupt' + | 'verification_document_country_not_supported' + | 'verification_document_dob_mismatch' + | 'verification_document_duplicate_type' + | 'verification_document_expired' + | 'verification_document_failed_copy' + | 'verification_document_failed_greyscale' + | 'verification_document_failed_other' + | 'verification_document_failed_test_mode' + | 'verification_document_fraudulent' + | 'verification_document_id_number_mismatch' + | 'verification_document_id_number_missing' + | 'verification_document_incomplete' + | 'verification_document_invalid' + | 'verification_document_issue_or_expiry_date_missing' + | 'verification_document_manipulated' + | 'verification_document_missing_back' + | 'verification_document_missing_front' + | 'verification_document_name_mismatch' + | 'verification_document_name_missing' + | 'verification_document_nationality_mismatch' + | 'verification_document_not_readable' + | 'verification_document_not_signed' + | 'verification_document_not_uploaded' + | 'verification_document_photo_mismatch' + | 'verification_document_too_large' + | 'verification_document_type_not_supported' + | 'verification_failed_address_match' + | 'verification_failed_business_iec_number' + | 'verification_failed_document_match' + | 'verification_failed_id_number_match' + | 'verification_failed_keyed_identity' + | 'verification_failed_keyed_match' + | 'verification_failed_name_match' + | 'verification_failed_other' + | 'verification_failed_tax_id_match' + | 'verification_failed_tax_id_not_issued' + | 'verification_missing_executives' + | 'verification_missing_owners' + | 'verification_requires_additional_memorandum_of_associations' /** @description An informative message that indicates the error type and provides additional details about the error. */ - reason: string; + reason: string /** @description The specific user onboarding requirement field (in the requirements hash) that needs to be resolved. */ - requirement: string; - }; + requirement: string + } /** AccountSepaDebitPaymentsSettings */ account_sepa_debit_payments_settings: { /** @description SEPA creditor identifier that identifies the company making the payment. */ - creditor_id?: string; - }; + creditor_id?: string + } /** AccountSettings */ account_settings: { - bacs_debit_payments?: components["schemas"]["account_bacs_debit_payments_settings"]; - branding: components["schemas"]["account_branding_settings"]; - card_issuing?: components["schemas"]["account_card_issuing_settings"]; - card_payments: components["schemas"]["account_card_payments_settings"]; - dashboard: components["schemas"]["account_dashboard_settings"]; - payments: components["schemas"]["account_payments_settings"]; - payouts?: components["schemas"]["account_payout_settings"]; - sepa_debit_payments?: components["schemas"]["account_sepa_debit_payments_settings"]; - }; + bacs_debit_payments?: components['schemas']['account_bacs_debit_payments_settings'] + branding: components['schemas']['account_branding_settings'] + card_issuing?: components['schemas']['account_card_issuing_settings'] + card_payments: components['schemas']['account_card_payments_settings'] + dashboard: components['schemas']['account_dashboard_settings'] + payments: components['schemas']['account_payments_settings'] + payouts?: components['schemas']['account_payout_settings'] + sepa_debit_payments?: components['schemas']['account_sepa_debit_payments_settings'] + } /** AccountTOSAcceptance */ account_tos_acceptance: { /** * Format: unix-time * @description The Unix timestamp marking when the account representative accepted their service agreement */ - date?: number | null; + date?: number | null /** @description The IP address from which the account representative accepted their service agreement */ - ip?: string | null; + ip?: string | null /** @description The user's service agreement type */ - service_agreement?: string; + service_agreement?: string /** @description The user agent of the browser from which the account representative accepted their service agreement */ - user_agent?: string | null; - }; + user_agent?: string | null + } /** AccountUnificationAccountController */ account_unification_account_controller: { /** @description `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?: boolean; + is_controller?: boolean /** * @description The controller type. Can be `application`, if a Connect application controls the account, or `account`, if the account controls itself. * @enum {string} */ - type: "account" | "application"; - }; + type: 'account' | 'application' + } /** Address */ address: { /** @description City, district, suburb, town, or village. */ - city?: string | null; + city?: string | null /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ - country?: string | null; + country?: string | null /** @description Address line 1 (e.g., street, PO Box, or company name). */ - line1?: string | null; + line1?: string | null /** @description Address line 2 (e.g., apartment, suite, unit, or building). */ - line2?: string | null; + line2?: string | null /** @description ZIP or postal code. */ - postal_code?: string | null; + postal_code?: string | null /** @description State, county, province, or region. */ - state?: string | null; - }; + state?: string | null + } /** AlipayAccount */ alipay_account: { /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The ID of the customer associated with this Alipay Account. */ - customer?: - | (Partial & - Partial & - Partial) - | null; + customer?: (Partial & Partial & Partial) | null /** @description Uniquely identifies the account and will be the same across all Alipay account objects that are linked to the same Alipay account. */ - fingerprint: string; + fingerprint: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "alipay_account"; + object: 'alipay_account' /** @description If the Alipay account object is not reusable, the exact amount that you can create a charge for. */ - payment_amount?: number | null; + payment_amount?: number | null /** @description If the Alipay account object is not reusable, the exact currency that you can create a charge for. */ - payment_currency?: string | null; + payment_currency?: string | null /** @description True if you can create multiple payments using this account. If the account is reusable, then you can freely choose the amount of each payment. */ - reusable: boolean; + reusable: boolean /** @description Whether this Alipay account object has ever been used for a payment. */ - used: boolean; + used: boolean /** @description The username for the Alipay account. */ - username: string; - }; + username: string + } /** APIErrors */ api_errors: { /** @description For card errors, the ID of the failed charge. */ - charge?: string; + charge?: string /** @description For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported. */ - code?: string; + code?: string /** @description 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?: string; + decline_code?: string /** @description A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported. */ - doc_url?: string; + doc_url?: string /** @description A human-readable message providing more details about the error. For card errors, these messages can be shown to your users. */ - message?: string; + message?: string /** @description 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?: string; - payment_intent?: components["schemas"]["payment_intent"]; - payment_method?: components["schemas"]["payment_method"]; + param?: string + payment_intent?: components['schemas']['payment_intent'] + payment_method?: components['schemas']['payment_method'] /** @description 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?: string; - setup_intent?: components["schemas"]["setup_intent"]; + payment_method_type?: string + setup_intent?: components['schemas']['setup_intent'] /** @description The source object for errors returned on a request involving a source. */ - source?: Partial & - Partial & - Partial; + source?: Partial & Partial & Partial /** * @description The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error` * @enum {string} */ - type: "api_error" | "card_error" | "idempotency_error" | "invalid_request_error"; - }; + type: 'api_error' | 'card_error' | 'idempotency_error' | 'invalid_request_error' + } /** ApplePayDomain */ apple_pay_domain: { /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; - domain_name: string; + created: number + domain_name: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "apple_pay_domain"; - }; + object: 'apple_pay_domain' + } /** Application */ application: { /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The name of the application. */ - name?: string | null; + name?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "application"; - }; + object: 'application' + } /** PlatformFee */ application_fee: { /** @description ID of the Stripe account this fee was taken from. */ - account: Partial & Partial; + account: Partial & Partial /** @description Amount earned, in %s. */ - amount: number; + amount: number /** @description Amount in %s refunded (can be less than the amount attribute on the fee if a partial refund was issued) */ - amount_refunded: number; + amount_refunded: number /** @description ID of the Connect application that earned the fee. */ - application: Partial & Partial; + application: Partial & Partial /** @description Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds). */ - balance_transaction?: (Partial & Partial) | null; + balance_transaction?: (Partial & Partial) | null /** @description ID of the charge that the application fee was taken from. */ - charge: Partial & Partial; + charge: Partial & Partial /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "application_fee"; + object: 'application_fee' /** @description ID of the corresponding charge on the platform account, if this fee was the result of a charge using the `destination` parameter. */ - originating_transaction?: (Partial & Partial) | null; + originating_transaction?: (Partial & Partial) | null /** @description Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false. */ - refunded: boolean; + refunded: boolean /** * FeeRefundList * @description A list of refunds that have been applied to the fee. */ refunds: { /** @description Details about each object. */ - data: components["schemas"]["fee_refund"][]; + data: components['schemas']['fee_refund'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** AutomaticTax */ automatic_tax: { /** @description Whether Stripe automatically computes tax on this invoice. */ - enabled: boolean; + enabled: boolean /** * @description The status of the most recent automated tax calculation for this invoice. * @enum {string|null} */ - status?: ("complete" | "failed" | "requires_location_inputs") | null; - }; + status?: ('complete' | 'failed' | 'requires_location_inputs') | null + } /** * Balance * @description This is an object representing your Stripe balance. You can retrieve it to see @@ -2381,44 +2375,44 @@ export type components = { */ balance: { /** @description Funds that are available to be transferred or paid out, whether automatically by Stripe or explicitly via the [Transfers API](https://stripe.com/docs/api#transfers) or [Payouts API](https://stripe.com/docs/api#payouts). The available balance for each currency and payment type can be found in the `source_types` property. */ - available: components["schemas"]["balance_amount"][]; + available: components['schemas']['balance_amount'][] /** @description Funds held due to negative balances on connected Custom accounts. The connect reserve balance for each currency and payment type can be found in the `source_types` property. */ - connect_reserved?: components["schemas"]["balance_amount"][]; + connect_reserved?: components['schemas']['balance_amount'][] /** @description Funds that can be paid out using Instant Payouts. */ - instant_available?: components["schemas"]["balance_amount"][]; - issuing?: components["schemas"]["balance_detail"]; + instant_available?: components['schemas']['balance_amount'][] + issuing?: components['schemas']['balance_detail'] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "balance"; + object: 'balance' /** @description Funds that are not yet available in the balance, due to the 7-day rolling pay cycle. The pending balance for each currency, and for each payment type, can be found in the `source_types` property. */ - pending: components["schemas"]["balance_amount"][]; - }; + pending: components['schemas']['balance_amount'][] + } /** BalanceAmount */ balance_amount: { /** @description Balance amount. */ - amount: number; + amount: number /** @description 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: string; - source_types?: components["schemas"]["balance_amount_by_source_type"]; - }; + currency: string + source_types?: components['schemas']['balance_amount_by_source_type'] + } /** BalanceAmountBySourceType */ balance_amount_by_source_type: { /** @description Amount for bank account. */ - bank_account?: number; + bank_account?: number /** @description Amount for card. */ - card?: number; + card?: number /** @description Amount for FPX. */ - fpx?: number; - }; + fpx?: number + } /** BalanceDetail */ balance_detail: { /** @description Funds that are available for use. */ - available: components["schemas"]["balance_amount"][]; - }; + available: components['schemas']['balance_amount'][] + } /** * BalanceTransaction * @description Balance transactions represent funds moving through your Stripe account. @@ -2428,98 +2422,98 @@ export type components = { */ balance_transaction: { /** @description Gross amount of the transaction, in %s. */ - amount: number; + amount: number /** * Format: unix-time * @description The date the transaction's net funds will become available in the Stripe balance. */ - available_on: number; + available_on: number /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description The exchange rate used, if applicable, for this transaction. Specifically, if money was converted from currency A to currency B, then the `amount` in currency A, times `exchange_rate`, would be the `amount` in currency B. For example, suppose you charged a customer 10.00 EUR. Then the PaymentIntent's `amount` would be `1000` and `currency` would be `eur`. Suppose this was converted into 12.34 USD in your Stripe account. Then the BalanceTransaction's `amount` would be `1234`, `currency` would be `usd`, and `exchange_rate` would be `1.234`. */ - exchange_rate?: number | null; + exchange_rate?: number | null /** @description Fees (in %s) paid for this transaction. */ - fee: number; + fee: number /** @description Detailed breakdown of fees (in %s) paid for this transaction. */ - fee_details: components["schemas"]["fee"][]; + fee_details: components['schemas']['fee'][] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Net amount of the transaction, in %s. */ - net: number; + net: number /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "balance_transaction"; + object: 'balance_transaction' /** @description [Learn more](https://stripe.com/docs/reports/reporting-categories) about how reporting categories can help you understand balance transactions from an accounting perspective. */ - reporting_category: string; + reporting_category: string /** @description The Stripe object to which this transaction is related. */ source?: | (Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial) - | null; + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial) + | null /** @description If the transaction's net funds are available in the Stripe balance yet. Either `available` or `pending`. */ - status: string; + status: string /** * @description Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `payment`, `payment_failure_refund`, `payment_refund`, `payout`, `payout_cancel`, `payout_failure`, `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](https://stripe.com/docs/reports/balance-transaction-types) about balance transaction types and what they represent. If you are looking to classify transactions for accounting purposes, you might want to consider `reporting_category` instead. * @enum {string} */ type: - | "adjustment" - | "advance" - | "advance_funding" - | "anticipation_repayment" - | "application_fee" - | "application_fee_refund" - | "charge" - | "connect_collection_transfer" - | "contribution" - | "issuing_authorization_hold" - | "issuing_authorization_release" - | "issuing_dispute" - | "issuing_transaction" - | "payment" - | "payment_failure_refund" - | "payment_refund" - | "payout" - | "payout_cancel" - | "payout_failure" - | "refund" - | "refund_failure" - | "reserve_transaction" - | "reserved_funds" - | "stripe_fee" - | "stripe_fx_fee" - | "tax_fee" - | "topup" - | "topup_reversal" - | "transfer" - | "transfer_cancel" - | "transfer_failure" - | "transfer_refund"; - }; + | 'adjustment' + | 'advance' + | 'advance_funding' + | 'anticipation_repayment' + | 'application_fee' + | 'application_fee_refund' + | 'charge' + | 'connect_collection_transfer' + | 'contribution' + | 'issuing_authorization_hold' + | 'issuing_authorization_release' + | 'issuing_dispute' + | 'issuing_transaction' + | 'payment' + | 'payment_failure_refund' + | 'payment_refund' + | 'payout' + | 'payout_cancel' + | 'payout_failure' + | 'refund' + | 'refund_failure' + | 'reserve_transaction' + | 'reserved_funds' + | 'stripe_fee' + | 'stripe_fx_fee' + | 'tax_fee' + | 'topup' + | 'topup_reversal' + | 'transfer' + | 'transfer_cancel' + | 'transfer_failure' + | 'transfer_refund' + } /** * BankAccount * @description These bank accounts are payment methods on `Customer` objects. @@ -2532,99 +2526,95 @@ export type components = { */ bank_account: { /** @description The ID of the account that the bank account is associated with. */ - account?: (Partial & Partial) | null; + account?: (Partial & Partial) | null /** @description The name of the person or business that owns the bank account. */ - account_holder_name?: string | null; + account_holder_name?: string | null /** @description The type of entity that holds the account. This can be either `individual` or `company`. */ - account_holder_type?: string | null; + account_holder_type?: string | null /** @description 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?: string | null; + account_type?: string | null /** @description 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?: ("instant" | "standard")[] | null; + available_payout_methods?: ('instant' | 'standard')[] | null /** @description Name of the bank associated with the routing number (e.g., `WELLS FARGO`). */ - bank_name?: string | null; + bank_name?: string | null /** @description Two-letter ISO code representing the country the bank account is located in. */ - country: string; + country: string /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. */ - currency: string; + currency: string /** @description The ID of the customer that the bank account is associated with. */ - customer?: - | (Partial & - Partial & - Partial) - | null; + customer?: (Partial & Partial & Partial) | null /** @description Whether this bank account is the default external account for its currency. */ - default_for_currency?: boolean | null; + default_for_currency?: boolean | null /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The last four digits of the bank account number. */ - last4: string; + last4: string /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "bank_account"; + object: 'bank_account' /** @description The routing transit number for the bank account. */ - routing_number?: string | null; + routing_number?: string | null /** * @description For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a transfer sent to this bank account fails, we'll set the status to `errored` and will not continue to send transfers until the bank details are updated. * * For external accounts, possible values are `new` and `errored`. Validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply. If a transfer fails, the status is set to `errored` and transfers are stopped until account details are updated. */ - status: string; - }; + status: string + } /** billing_details */ billing_details: { /** @description Billing address. */ - address?: Partial | null; + address?: Partial | null /** @description Email address. */ - email?: string | null; + email?: string | null /** @description Full name. */ - name?: string | null; + name?: string | null /** @description Billing phone number (including extension). */ - phone?: string | null; - }; + phone?: string | null + } /** * PortalConfiguration * @description A portal configuration describes the functionality and behavior of a portal session. */ - "billing_portal.configuration": { + 'billing_portal.configuration': { /** @description Whether the configuration is active and can be used to create portal sessions. */ - active: boolean; + active: boolean /** @description ID of the Connect Application that created the configuration. */ - application?: string | null; - business_profile: components["schemas"]["portal_business_profile"]; + application?: string | null + business_profile: components['schemas']['portal_business_profile'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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?: string | null; - features: components["schemas"]["portal_features"]; + default_return_url?: string | null + features: components['schemas']['portal_features'] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description 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: boolean; + is_default: boolean /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "billing_portal.configuration"; + object: 'billing_portal.configuration' /** * Format: unix-time * @description Time at which the object was last updated. Measured in seconds since the Unix epoch. */ - updated: number; - }; + updated: number + } /** * PortalSession * @description The Billing customer portal is a Stripe-hosted UI for subscription and @@ -2642,178 +2632,178 @@ export type components = { * * Learn more in the [integration guide](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal). */ - "billing_portal.session": { + 'billing_portal.session': { /** @description The configuration used by this session, describing the features available. */ - configuration: Partial & Partial; + configuration: Partial & Partial /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The ID of the customer for this session. */ - customer: string; + customer: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description 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. * @enum {string|null} */ locale?: | ( - | "auto" - | "bg" - | "cs" - | "da" - | "de" - | "el" - | "en" - | "en-AU" - | "en-CA" - | "en-GB" - | "en-IE" - | "en-IN" - | "en-NZ" - | "en-SG" - | "es" - | "es-419" - | "et" - | "fi" - | "fil" - | "fr" - | "fr-CA" - | "hr" - | "hu" - | "id" - | "it" - | "ja" - | "ko" - | "lt" - | "lv" - | "ms" - | "mt" - | "nb" - | "nl" - | "pl" - | "pt" - | "pt-BR" - | "ro" - | "ru" - | "sk" - | "sl" - | "sv" - | "th" - | "tr" - | "vi" - | "zh" - | "zh-HK" - | "zh-TW" + | 'auto' + | 'bg' + | 'cs' + | 'da' + | 'de' + | 'el' + | 'en' + | 'en-AU' + | 'en-CA' + | 'en-GB' + | 'en-IE' + | 'en-IN' + | 'en-NZ' + | 'en-SG' + | 'es' + | 'es-419' + | 'et' + | 'fi' + | 'fil' + | 'fr' + | 'fr-CA' + | 'hr' + | 'hu' + | 'id' + | 'it' + | 'ja' + | 'ko' + | 'lt' + | 'lv' + | 'ms' + | 'mt' + | 'nb' + | 'nl' + | 'pl' + | 'pt' + | 'pt-BR' + | 'ro' + | 'ru' + | 'sk' + | 'sl' + | 'sv' + | 'th' + | 'tr' + | 'vi' + | 'zh' + | 'zh-HK' + | 'zh-TW' ) - | null; + | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "billing_portal.session"; + object: 'billing_portal.session' /** @description 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/charges-transfers#on-behalf-of). 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?: string | null; + on_behalf_of?: string | null /** @description The URL to redirect customers to when they click on the portal's link to return to your website. */ - return_url: string; + return_url: string /** @description The short-lived URL of the session that gives customers access to the customer portal. */ - url: string; - }; + url: string + } /** BitcoinReceiver */ bitcoin_receiver: { /** @description True when this bitcoin receiver has received a non-zero amount of bitcoin. */ - active: boolean; + active: boolean /** @description The amount of `currency` that you are collecting as payment. */ - amount: number; + amount: number /** @description The amount of `currency` to which `bitcoin_amount_received` has been converted. */ - amount_received: number; + amount_received: number /** @description The amount of bitcoin that the customer should send to fill the receiver. The `bitcoin_amount` is denominated in Satoshi: there are 10^8 Satoshi in one bitcoin. */ - bitcoin_amount: number; + bitcoin_amount: number /** @description The amount of bitcoin that has been sent by the customer to this receiver. */ - bitcoin_amount_received: number; + bitcoin_amount_received: number /** @description This URI can be displayed to the customer as a clickable link (to activate their bitcoin client) or as a QR code (for mobile wallets). */ - bitcoin_uri: string; + bitcoin_uri: string /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) to which the bitcoin will be converted. */ - currency: string; + currency: string /** @description The customer ID of the bitcoin receiver. */ - customer?: string | null; + customer?: string | null /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description The customer's email address, set by the API call that creates the receiver. */ - email?: string | null; + email?: string | null /** @description This flag is initially false and updates to true when the customer sends the `bitcoin_amount` to this receiver. */ - filled: boolean; + filled: boolean /** @description Unique identifier for the object. */ - id: string; + id: string /** @description A bitcoin address that is specific to this receiver. The customer can send bitcoin to this address to fill the receiver. */ - inbound_address: string; + inbound_address: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "bitcoin_receiver"; + object: 'bitcoin_receiver' /** @description The ID of the payment created from the receiver, if any. Hidden when viewing the receiver with a publishable key. */ - payment?: string | null; + payment?: string | null /** @description The refund address of this bitcoin receiver. */ - refund_address?: string | null; + refund_address?: string | null /** * BitcoinTransactionList * @description A list with one entry for each time that the customer sent bitcoin to the receiver. Hidden when viewing the receiver with a publishable key. */ transactions?: { /** @description Details about each object. */ - data: components["schemas"]["bitcoin_transaction"][]; + data: components['schemas']['bitcoin_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** @description This receiver contains uncaptured funds that can be used for a payment or refunded. */ - uncaptured_funds: boolean; + uncaptured_funds: boolean /** @description Indicate if this source is used for payment. */ - used_for_payment?: boolean | null; - }; + used_for_payment?: boolean | null + } /** BitcoinTransaction */ bitcoin_transaction: { /** @description The amount of `currency` that the transaction was converted to in real-time. */ - amount: number; + amount: number /** @description The amount of bitcoin contained in the transaction. */ - bitcoin_amount: number; + bitcoin_amount: number /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) to which this transaction was converted. */ - currency: string; + currency: string /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "bitcoin_transaction"; + object: 'bitcoin_transaction' /** @description The receiver to which this transaction was sent. */ - receiver: string; - }; + receiver: string + } /** * AccountCapability * @description This is an object representing a capability for a Stripe account. @@ -2822,29 +2812,29 @@ export type components = { */ capability: { /** @description The account for which the capability enables functionality. */ - account: Partial & Partial; - future_requirements?: components["schemas"]["account_capability_future_requirements"]; + account: Partial & Partial + future_requirements?: components['schemas']['account_capability_future_requirements'] /** @description The identifier for the capability. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "capability"; + object: 'capability' /** @description Whether the capability has been requested. */ - requested: boolean; + requested: boolean /** * Format: unix-time * @description Time at which the capability was requested. Measured in seconds since the Unix epoch. */ - requested_at?: number | null; - requirements?: components["schemas"]["account_capability_requirements"]; + requested_at?: number | null + requirements?: components['schemas']['account_capability_requirements'] /** * @description The status of the capability. Can be `active`, `inactive`, `pending`, or `unrequested`. * @enum {string} */ - status: "active" | "disabled" | "inactive" | "pending" | "unrequested"; - }; + status: 'active' | 'disabled' | 'inactive' | 'pending' | 'unrequested' + } /** * Card * @description You can store multiple cards on a customer in order to charge the customer @@ -2855,90 +2845,86 @@ export type components = { */ card: { /** @description 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. */ - account?: (Partial & Partial) | null; + account?: (Partial & Partial) | null /** @description City/District/Suburb/Town/Village. */ - address_city?: string | null; + address_city?: string | null /** @description Billing address country, if provided when creating card. */ - address_country?: string | null; + address_country?: string | null /** @description Address line 1 (Street address/PO Box/Company name). */ - address_line1?: string | null; + address_line1?: string | null /** @description If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. */ - address_line1_check?: string | null; + address_line1_check?: string | null /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - address_line2?: string | null; + address_line2?: string | null /** @description State/County/Province/Region. */ - address_state?: string | null; + address_state?: string | null /** @description ZIP or postal code. */ - address_zip?: string | null; + address_zip?: string | null /** @description If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. */ - address_zip_check?: string | null; + address_zip_check?: string | null /** @description 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?: ("instant" | "standard")[] | null; + available_payout_methods?: ('instant' | 'standard')[] | null /** @description Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`. */ - brand: string; + brand: string /** @description 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?: string | null; + country?: string | null /** @description Three-letter [ISO code for currency](https://stripe.com/docs/payouts). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. */ - currency?: string | null; + currency?: string | null /** @description 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?: - | (Partial & - Partial & - Partial) - | null; + customer?: (Partial & Partial & Partial) | null /** @description 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?: string | null; + cvc_check?: string | null /** @description Whether this card is the default external account for its currency. */ - default_for_currency?: boolean | null; + default_for_currency?: boolean | null /** @description (For tokenized numbers only.) The last four digits of the device account number. */ - dynamic_last4?: string | null; + dynamic_last4?: string | null /** @description Two-digit number representing the card's expiration month. */ - exp_month: number; + exp_month: number /** @description Four-digit number representing the card's expiration year. */ - exp_year: number; + exp_year: number /** * @description 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. * * *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.* */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ - funding: string; + funding: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The last four digits of the card. */ - last4: string; + last4: string /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** @description Cardholder name. */ - name?: string | null; + name?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "card"; + object: 'card' /** @description The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead. */ - recipient?: (Partial & Partial) | null; + recipient?: (Partial & Partial) | null /** @description 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?: string | null; - }; + tokenization_method?: string | null + } /** card_generated_from_payment_method_details */ card_generated_from_payment_method_details: { - card_present?: components["schemas"]["payment_method_details_card_present"]; + card_present?: components['schemas']['payment_method_details_card_present'] /** @description The type of payment method transaction-specific details from the transaction that generated this `card` payment method. Always `card_present`. */ - type: string; - }; + type: string + } /** CardIssuingAccountTermsOfService */ card_issuing_account_terms_of_service: { /** @description The Unix timestamp marking when the account representative accepted the service agreement. */ - date?: number | null; + date?: number | null /** @description The IP address from which the account representative accepted the service agreement. */ - ip?: string | null; + ip?: string | null /** @description The user agent of the browser from which the account representative accepted the service agreement. */ - user_agent?: string; - }; + user_agent?: string + } /** card_mandate_payment_method_details */ - card_mandate_payment_method_details: { [key: string]: unknown }; + card_mandate_payment_method_details: { [key: string]: unknown } /** * Charge * @description To charge a credit or a debit card, you create a `Charge` object. You can @@ -2949,152 +2935,148 @@ export type components = { */ charge: { /** @description 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: number; + amount: number /** @description Amount in %s captured (can be less than the amount attribute on the charge if a partial capture was made). */ - amount_captured: number; + amount_captured: number /** @description Amount in %s refunded (can be less than the amount attribute on the charge if a partial refund was issued). */ - amount_refunded: number; + amount_refunded: number /** @description ID of the Connect application that created the charge. */ - application?: (Partial & Partial) | null; + application?: (Partial & Partial) | null /** @description The application fee (if any) for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees) for details. */ - application_fee?: (Partial & Partial) | null; + application_fee?: (Partial & Partial) | null /** @description The amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees) for details. */ - application_fee_amount?: number | null; + application_fee_amount?: number | null /** @description ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes). */ - balance_transaction?: (Partial & Partial) | null; - billing_details: components["schemas"]["billing_details"]; + balance_transaction?: (Partial & Partial) | null + billing_details: components['schemas']['billing_details'] /** @description 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. */ - calculated_statement_descriptor?: string | null; + calculated_statement_descriptor?: string | null /** @description If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured. */ - captured: boolean; + captured: boolean /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description ID of the customer this charge is for if one exists. */ - customer?: - | (Partial & - Partial & - Partial) - | null; + customer?: (Partial & Partial & Partial) | null /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description Whether the charge has been disputed. */ - disputed: boolean; + disputed: boolean /** @description Error code explaining reason for charge failure if available (see [the errors section](https://stripe.com/docs/api#errors) for a list of codes). */ - failure_code?: string | null; + failure_code?: string | null /** @description Message to user further explaining reason for charge failure if available. */ - failure_message?: string | null; + failure_message?: string | null /** @description Information on fraud assessments for the charge. */ - fraud_details?: Partial | null; + fraud_details?: Partial | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description ID of the invoice this charge is for if one exists. */ - invoice?: (Partial & Partial) | null; + invoice?: (Partial & Partial) | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "charge"; + object: 'charge' /** @description 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/charges-transfers) for details. */ - on_behalf_of?: (Partial & Partial) | null; + on_behalf_of?: (Partial & Partial) | null /** @description ID of the order this charge is for if one exists. */ - order?: (Partial & Partial) | null; + order?: (Partial & Partial) | null /** @description Details about whether the payment was accepted, and why. See [understanding declines](https://stripe.com/docs/declines) for details. */ - outcome?: Partial | null; + outcome?: Partial | null /** @description `true` if the charge succeeded, or was successfully authorized for later capture. */ - paid: boolean; + paid: boolean /** @description ID of the PaymentIntent associated with this charge, if one exists. */ - payment_intent?: (Partial & Partial) | null; + payment_intent?: (Partial & Partial) | null /** @description ID of the payment method used in this charge. */ - payment_method?: string | null; + payment_method?: string | null /** @description Details about the payment method at the time of the transaction. */ - payment_method_details?: Partial | null; + payment_method_details?: Partial | null /** @description This is the email address that the receipt for this charge was sent to. */ - receipt_email?: string | null; + receipt_email?: string | null /** @description 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?: string | null; + receipt_number?: string | null /** @description 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?: string | null; + receipt_url?: string | null /** @description Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false. */ - refunded: boolean; + refunded: boolean /** * RefundList * @description A list of refunds that have been applied to the charge. */ refunds: { /** @description Details about each object. */ - data: components["schemas"]["refund"][]; + data: components['schemas']['refund'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** @description ID of the review associated with this charge if one exists. */ - review?: (Partial & Partial) | null; + review?: (Partial & Partial) | null /** @description Shipping information for the charge. */ - shipping?: Partial | null; + shipping?: Partial | null /** @description The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details. */ - source_transfer?: (Partial & Partial) | null; + source_transfer?: (Partial & Partial) | null /** @description For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - statement_descriptor?: string | null; + statement_descriptor?: string | null /** @description Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - statement_descriptor_suffix?: string | null; + statement_descriptor_suffix?: string | null /** * @description The status of the payment is either `succeeded`, `pending`, or `failed`. * @enum {string} */ - status: "failed" | "pending" | "succeeded"; + status: 'failed' | 'pending' | 'succeeded' /** @description ID of the transfer to the `destination` account (only applicable if the charge was created using the `destination` parameter). */ - transfer?: Partial & Partial; + transfer?: Partial & Partial /** @description 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?: Partial | null; + transfer_data?: Partial | null /** @description A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-options) for details. */ - transfer_group?: string | null; - }; + transfer_group?: string | null + } /** ChargeFraudDetails */ charge_fraud_details: { /** @description Assessments from Stripe. If set, the value is `fraudulent`. */ - stripe_report?: string; + stripe_report?: string /** @description Assessments reported by you. If set, possible values of are `safe` and `fraudulent`. */ - user_report?: string; - }; + user_report?: string + } /** ChargeOutcome */ charge_outcome: { /** @description 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?: string | null; + network_status?: string | null /** @description 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?: string | null; + reason?: string | null /** @description 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?: string; + risk_level?: string /** @description 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?: number; + risk_score?: number /** @description The ID of the Radar rule that matched the payment, if applicable. */ - rule?: Partial & Partial; + rule?: Partial & Partial /** @description A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer. */ - seller_message?: string | null; + seller_message?: string | null /** @description 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: string; - }; + type: string + } /** ChargeTransferData */ charge_transfer_data: { /** @description The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account. */ - amount?: number | null; + amount?: number | null /** @description ID of an existing, connected Stripe account to transfer funds to if `transfer_data` was specified in the charge request. */ - destination: Partial & Partial; - }; + destination: Partial & Partial + } /** * Session * @description A Checkout Session represents your customer's session as they pay for @@ -3112,35 +3094,35 @@ export type components = { * * Related guide: [Checkout Server Quickstart](https://stripe.com/docs/payments/checkout/api). */ - "checkout.session": { + 'checkout.session': { /** @description When set, provides configuration for actions to take if this Checkout Session expires. */ - after_expiration?: Partial | null; + after_expiration?: Partial | null /** @description Enables user redeemable promotion codes. */ - allow_promotion_codes?: boolean | null; + allow_promotion_codes?: boolean | null /** @description Total of all items before discounts or taxes are applied. */ - amount_subtotal?: number | null; + amount_subtotal?: number | null /** @description Total of all items after discounts and taxes are applied. */ - amount_total?: number | null; - automatic_tax: components["schemas"]["payment_pages_checkout_session_automatic_tax"]; + amount_total?: number | null + automatic_tax: components['schemas']['payment_pages_checkout_session_automatic_tax'] /** * @description Describes whether Checkout should collect the customer's billing address. * @enum {string|null} */ - billing_address_collection?: ("auto" | "required") | null; + billing_address_collection?: ('auto' | 'required') | null /** @description The URL the customer will be directed to if they decide to cancel payment and return to your website. */ - cancel_url: string; + cancel_url: string /** * @description A unique string to reference the Checkout Session. This can be a * customer ID, a cart ID, or similar, and can be used to reconcile the * Session with your internal systems. */ - client_reference_id?: string | null; + client_reference_id?: string | null /** @description Results of `consent_collection` for this session. */ - consent?: Partial | null; + consent?: Partial | null /** @description When set, provides configuration for the Checkout Session to gather active consent from customers. */ - consent_collection?: Partial | null; + consent_collection?: Partial | null /** @description 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?: string | null; + currency?: string | null /** * @description The ID of the customer for this Session. * For Checkout Sessions in `payment` or `subscription` mode, Checkout @@ -3148,18 +3130,14 @@ export type components = { * during the payment flow unless an existing customer was provided when * the Session was created. */ - customer?: - | (Partial & - Partial & - Partial) - | null; + customer?: (Partial & Partial & Partial) | null /** * @description Configure whether a Checkout Session creates a Customer when the Checkout Session completes. * @enum {string|null} */ - customer_creation?: ("always" | "if_required") | null; + customer_creation?: ('always' | 'if_required') | null /** @description The customer details including the customer's tax exempt status and the customer's tax IDs. Only present on Sessions in `payment` or `subscription` mode. */ - customer_details?: Partial | null; + customer_details?: Partial | null /** * @description 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. @@ -3167,134 +3145,132 @@ export type components = { * on file. To access information about the customer once the payment flow is * complete, use the `customer` attribute. */ - customer_email?: string | null; + customer_email?: string | null /** * Format: unix-time * @description The timestamp at which the Checkout Session will expire. */ - expires_at: number; + expires_at: number /** * @description Unique identifier for the object. Used to pass to `redirectToCheckout` * in Stripe.js. */ - id: string; + id: string /** * PaymentPagesCheckoutSessionListLineItems * @description The line items purchased by the customer. */ line_items?: { /** @description Details about each object. */ - data: components["schemas"]["item"][]; + data: components['schemas']['item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used. * @enum {string|null} */ locale?: | ( - | "auto" - | "bg" - | "cs" - | "da" - | "de" - | "el" - | "en" - | "en-GB" - | "es" - | "es-419" - | "et" - | "fi" - | "fil" - | "fr" - | "fr-CA" - | "hr" - | "hu" - | "id" - | "it" - | "ja" - | "ko" - | "lt" - | "lv" - | "ms" - | "mt" - | "nb" - | "nl" - | "pl" - | "pt" - | "pt-BR" - | "ro" - | "ru" - | "sk" - | "sl" - | "sv" - | "th" - | "tr" - | "vi" - | "zh" - | "zh-HK" - | "zh-TW" + | 'auto' + | 'bg' + | 'cs' + | 'da' + | 'de' + | 'el' + | 'en' + | 'en-GB' + | 'es' + | 'es-419' + | 'et' + | 'fi' + | 'fil' + | 'fr' + | 'fr-CA' + | 'hr' + | 'hu' + | 'id' + | 'it' + | 'ja' + | 'ko' + | 'lt' + | 'lv' + | 'ms' + | 'mt' + | 'nb' + | 'nl' + | 'pl' + | 'pt' + | 'pt-BR' + | 'ro' + | 'ru' + | 'sk' + | 'sl' + | 'sv' + | 'th' + | 'tr' + | 'vi' + | 'zh' + | 'zh-HK' + | 'zh-TW' ) - | null; + | null /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description The mode of the Checkout Session. * @enum {string} */ - mode: "payment" | "setup" | "subscription"; + mode: 'payment' | 'setup' | 'subscription' /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "checkout.session"; + object: 'checkout.session' /** @description The ID of the PaymentIntent for Checkout Sessions in `payment` mode. */ - payment_intent?: (Partial & Partial) | null; + payment_intent?: (Partial & Partial) | null /** @description The ID of the Payment Link that created this Session. */ - payment_link?: (Partial & Partial) | null; + payment_link?: (Partial & Partial) | null /** @description Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession. */ - payment_method_options?: Partial | null; + payment_method_options?: Partial | null /** * @description A list of the types of payment methods (e.g. card) this Checkout * Session is allowed to accept. */ - payment_method_types: string[]; + payment_method_types: string[] /** * @description The payment status of the Checkout Session, one of `paid`, `unpaid`, or `no_payment_required`. * You can use this value to decide when to fulfill your customer's order. * @enum {string} */ - payment_status: "no_payment_required" | "paid" | "unpaid"; - phone_number_collection?: components["schemas"]["payment_pages_checkout_session_phone_number_collection"]; + payment_status: 'no_payment_required' | 'paid' | 'unpaid' + phone_number_collection?: components['schemas']['payment_pages_checkout_session_phone_number_collection'] /** @description The ID of the original expired Checkout Session that triggered the recovery flow. */ - recovered_from?: string | null; + recovered_from?: string | null /** @description The ID of the SetupIntent for Checkout Sessions in `setup` mode. */ - setup_intent?: (Partial & Partial) | null; + setup_intent?: (Partial & Partial) | null /** @description Shipping information for this Checkout Session. */ - shipping?: Partial | null; + shipping?: Partial | null /** @description When set, provides configuration for Checkout to collect a shipping address from a customer. */ - shipping_address_collection?: Partial< - components["schemas"]["payment_pages_checkout_session_shipping_address_collection"] - > | null; + shipping_address_collection?: Partial | null /** @description The shipping rate options applied to this Session. */ - shipping_options: components["schemas"]["payment_pages_checkout_session_shipping_option"][]; + shipping_options: components['schemas']['payment_pages_checkout_session_shipping_option'][] /** @description The ID of the ShippingRate for Checkout Sessions in `payment` mode. */ - shipping_rate?: (Partial & Partial) | null; + shipping_rate?: (Partial & Partial) | null /** * @description The status of the Checkout Session, one of `open`, `complete`, or `expired`. * @enum {string|null} */ - status?: ("complete" | "expired" | "open") | null; + status?: ('complete' | 'expired' | 'open') | null /** * @description Describes the type of transaction being performed by Checkout in order to customize * relevant text on the page, such as the submit button. `submit_type` can only be @@ -3302,87 +3278,87 @@ export type components = { * in `subscription` or `setup` mode. * @enum {string|null} */ - submit_type?: ("auto" | "book" | "donate" | "pay") | null; + submit_type?: ('auto' | 'book' | 'donate' | 'pay') | null /** @description The ID of the subscription for Checkout Sessions in `subscription` mode. */ - subscription?: (Partial & Partial) | null; + subscription?: (Partial & Partial) | null /** * @description The URL the customer will be directed to after the payment or * subscription creation is successful. */ - success_url: string; - tax_id_collection?: components["schemas"]["payment_pages_checkout_session_tax_id_collection"]; + success_url: string + tax_id_collection?: components['schemas']['payment_pages_checkout_session_tax_id_collection'] /** @description Tax and discount details for the computed total amount. */ - total_details?: Partial | null; + total_details?: Partial | null /** @description The URL to the Checkout Session. */ - url?: string | null; - }; + url?: string | null + } /** CheckoutAcssDebitMandateOptions */ checkout_acss_debit_mandate_options: { /** @description A URL for custom mandate text */ - custom_mandate_url?: string; + custom_mandate_url?: string /** @description List of Stripe products where this mandate can be selected automatically. Returned when the Session is in `setup` mode. */ - default_for?: ("invoice" | "subscription")[]; + default_for?: ('invoice' | 'subscription')[] /** @description Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. */ - interval_description?: string | null; + interval_description?: string | null /** * @description Payment schedule for the mandate. * @enum {string|null} */ - payment_schedule?: ("combined" | "interval" | "sporadic") | null; + payment_schedule?: ('combined' | 'interval' | 'sporadic') | null /** * @description Transaction type of the mandate. * @enum {string|null} */ - transaction_type?: ("business" | "personal") | null; - }; + transaction_type?: ('business' | 'personal') | null + } /** CheckoutAcssDebitPaymentMethodOptions */ checkout_acss_debit_payment_method_options: { /** * @description Currency supported by the bank account. Returned when the Session is in `setup` mode. * @enum {string} */ - currency?: "cad" | "usd"; - mandate_options?: components["schemas"]["checkout_acss_debit_mandate_options"]; + currency?: 'cad' | 'usd' + mandate_options?: components['schemas']['checkout_acss_debit_mandate_options'] /** * @description Bank account verification method. * @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; - }; + verification_method?: 'automatic' | 'instant' | 'microdeposits' + } /** CheckoutBoletoPaymentMethodOptions */ checkout_boleto_payment_method_options: { /** @description 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: number; - }; + expires_after_days: number + } /** CheckoutOxxoPaymentMethodOptions */ checkout_oxxo_payment_method_options: { /** @description 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: number; - }; + expires_after_days: number + } /** CheckoutSessionPaymentMethodOptions */ checkout_session_payment_method_options: { - acss_debit?: components["schemas"]["checkout_acss_debit_payment_method_options"]; - boleto?: components["schemas"]["checkout_boleto_payment_method_options"]; - oxxo?: components["schemas"]["checkout_oxxo_payment_method_options"]; - }; + acss_debit?: components['schemas']['checkout_acss_debit_payment_method_options'] + boleto?: components['schemas']['checkout_boleto_payment_method_options'] + oxxo?: components['schemas']['checkout_oxxo_payment_method_options'] + } /** ConnectCollectionTransfer */ connect_collection_transfer: { /** @description Amount transferred, in %s. */ - amount: number; + amount: number /** @description 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: string; + currency: string /** @description ID of the account that funds are being collected for. */ - destination: Partial & Partial; + destination: Partial & Partial /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "connect_collection_transfer"; - }; + object: 'connect_collection_transfer' + } /** * CountrySpec * @description Stripe needs to collect certain pieces of information about each account @@ -3394,36 +3370,36 @@ export type components = { */ country_spec: { /** @description The default currency for this country. This applies to both payment methods and bank accounts. */ - default_currency: string; + default_currency: string /** @description Unique identifier for the object. Represented as the ISO country code for this country. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "country_spec"; + object: 'country_spec' /** @description Currencies that can be accepted in the specific country (for transfers). */ - supported_bank_account_currencies: { [key: string]: string[] }; + supported_bank_account_currencies: { [key: string]: string[] } /** @description Currencies that can be accepted in the specified country (for payments). */ - supported_payment_currencies: string[]; + supported_payment_currencies: string[] /** @description 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: string[]; + supported_payment_methods: string[] /** @description Countries that can accept transfers from the specified country. */ - supported_transfer_countries: string[]; - verification_fields: components["schemas"]["country_spec_verification_fields"]; - }; + supported_transfer_countries: string[] + verification_fields: components['schemas']['country_spec_verification_fields'] + } /** CountrySpecVerificationFieldDetails */ country_spec_verification_field_details: { /** @description Additional fields which are only required for some users. */ - additional: string[]; + additional: string[] /** @description Fields which every account must eventually provide. */ - minimum: string[]; - }; + minimum: string[] + } /** CountrySpecVerificationFields */ country_spec_verification_fields: { - company: components["schemas"]["country_spec_verification_field_details"]; - individual: components["schemas"]["country_spec_verification_field_details"]; - }; + company: components['schemas']['country_spec_verification_field_details'] + individual: components['schemas']['country_spec_verification_field_details'] + } /** * Coupon * @description A coupon contains information about a percent-off or amount-off discount you @@ -3432,54 +3408,54 @@ export type components = { */ coupon: { /** @description Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer. */ - amount_off?: number | null; - applies_to?: components["schemas"]["coupon_applies_to"]; + amount_off?: number | null + applies_to?: components['schemas']['coupon_applies_to'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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?: string | null; + currency?: string | null /** * @description One of `forever`, `once`, and `repeating`. Describes how long a customer who applies this coupon will get the discount. * @enum {string} */ - duration: "forever" | "once" | "repeating"; + duration: 'forever' | 'once' | 'repeating' /** @description If `duration` is `repeating`, the number of months the coupon applies. Null if coupon `duration` is `forever` or `once`. */ - duration_in_months?: number | null; + duration_in_months?: number | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid. */ - max_redemptions?: number | null; + max_redemptions?: number | null /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** @description Name of the coupon displayed to customers on for instance invoices or receipts. */ - name?: string | null; + name?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "coupon"; + object: 'coupon' /** @description 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 %s100 invoice %s50 instead. */ - percent_off?: number | null; + percent_off?: number | null /** * Format: unix-time * @description Date after which the coupon can no longer be redeemed. */ - redeem_by?: number | null; + redeem_by?: number | null /** @description Number of times this coupon has been applied to a customer. */ - times_redeemed: number; + times_redeemed: number /** @description Taking account of the above properties, whether this coupon can still be applied to a customer. */ - valid: boolean; - }; + valid: boolean + } /** CouponAppliesTo */ coupon_applies_to: { /** @description A list of product IDs this coupon applies to */ - products: string[]; - }; + products: string[] + } /** * CreditNote * @description Issue a credit note to adjust an invoice's amount after the invoice is finalized. @@ -3488,142 +3464,138 @@ export type components = { */ credit_note: { /** @description The integer amount in %s representing the total amount of the credit note, including tax. */ - amount: number; + amount: number /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description ID of the customer. */ - customer: Partial & - Partial & - Partial; + customer: Partial & Partial & Partial /** @description Customer balance transaction related to this credit note. */ - customer_balance_transaction?: - | (Partial & Partial) - | null; + customer_balance_transaction?: (Partial & Partial) | null /** @description The integer amount in %s representing the total amount of discount that was credited. */ - discount_amount: number; + discount_amount: number /** @description The aggregate amounts calculated per discount for all line items. */ - discount_amounts: components["schemas"]["discounts_resource_discount_amount"][]; + discount_amounts: components['schemas']['discounts_resource_discount_amount'][] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description ID of the invoice. */ - invoice: Partial & Partial; + invoice: Partial & Partial /** * CreditNoteLinesList * @description Line items that make up the credit note */ lines: { /** @description Details about each object. */ - data: components["schemas"]["credit_note_line_item"][]; + data: components['schemas']['credit_note_line_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description Customer-facing text that appears on the credit note PDF. */ - memo?: string | null; + memo?: string | null /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** @description A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice. */ - number: string; + number: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "credit_note"; + object: 'credit_note' /** @description Amount that was credited outside of Stripe. */ - out_of_band_amount?: number | null; + out_of_band_amount?: number | null /** @description The link to download the PDF of the credit note. */ - pdf: string; + pdf: string /** * @description Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` * @enum {string|null} */ - reason?: ("duplicate" | "fraudulent" | "order_change" | "product_unsatisfactory") | null; + reason?: ('duplicate' | 'fraudulent' | 'order_change' | 'product_unsatisfactory') | null /** @description Refund related to this credit note. */ - refund?: (Partial & Partial) | null; + refund?: (Partial & Partial) | null /** * @description 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). * @enum {string} */ - status: "issued" | "void"; + status: 'issued' | 'void' /** @description The integer amount in %s representing the amount of the credit note, excluding tax and invoice level discounts. */ - subtotal: number; + subtotal: number /** @description The aggregate amounts calculated per tax rate for all line items. */ - tax_amounts: components["schemas"]["credit_note_tax_amount"][]; + tax_amounts: components['schemas']['credit_note_tax_amount'][] /** @description The integer amount in %s representing the total amount of the credit note, including tax and all discount. */ - total: number; + total: number /** * @description 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. * @enum {string} */ - type: "post_payment" | "pre_payment"; + type: 'post_payment' | 'pre_payment' /** * Format: unix-time * @description The time that the credit note was voided. */ - voided_at?: number | null; - }; + voided_at?: number | null + } /** CreditNoteLineItem */ credit_note_line_item: { /** @description The integer amount in %s representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts. */ - amount: number; + amount: number /** @description Description of the item being credited. */ - description?: string | null; + description?: string | null /** @description The integer amount in %s representing the discount being credited for this line item. */ - discount_amount: number; + discount_amount: number /** @description The amount of discount calculated per discount for this line item */ - discount_amounts: components["schemas"]["discounts_resource_discount_amount"][]; + discount_amounts: components['schemas']['discounts_resource_discount_amount'][] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description ID of the invoice line item being credited */ - invoice_line_item?: string; + invoice_line_item?: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "credit_note_line_item"; + object: 'credit_note_line_item' /** @description The number of units of product being credited. */ - quantity?: number | null; + quantity?: number | null /** @description The amount of tax calculated per tax rate for this line item */ - tax_amounts: components["schemas"]["credit_note_tax_amount"][]; + tax_amounts: components['schemas']['credit_note_tax_amount'][] /** @description The tax rates which apply to the line item. */ - tax_rates: components["schemas"]["tax_rate"][]; + tax_rates: components['schemas']['tax_rate'][] /** * @description 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. * @enum {string} */ - type: "custom_line_item" | "invoice_line_item"; + type: 'custom_line_item' | 'invoice_line_item' /** @description The cost of each unit of product being credited. */ - unit_amount?: number | null; + unit_amount?: number | null /** * Format: decimal * @description Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. */ - unit_amount_decimal?: string | null; - }; + unit_amount_decimal?: string | null + } /** CreditNoteTaxAmount */ credit_note_tax_amount: { /** @description The amount, in %s, of the tax. */ - amount: number; + amount: number /** @description Whether this tax amount is inclusive or exclusive. */ - inclusive: boolean; + inclusive: boolean /** @description The tax rate that was applied to get this tax amount. */ - tax_rate: Partial & Partial; - }; + tax_rate: Partial & Partial + } /** * Customer * @description This object represents a customer of your business. It lets you create recurring charges and track payments that belong to the same customer. @@ -3632,16 +3604,16 @@ export type components = { */ customer: { /** @description The customer's address. */ - address?: Partial | null; + address?: Partial | null /** @description Current balance, if any, being 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 will be added to their next invoice. The balance does not refer to any unpaid invoices; it solely takes into account amounts that have yet to be successfully applied to any invoice. This balance is only taken into account as invoices are finalized. */ - balance?: number; + balance?: number /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes. */ - currency?: string | null; + currency?: string | null /** * @description ID of the default payment source for the customer. * @@ -3649,125 +3621,125 @@ export type components = { */ default_source?: | (Partial & - Partial & - Partial & - Partial & - Partial & - Partial) - | null; + Partial & + Partial & + Partial & + Partial & + Partial) + | null /** * @description When the customer's latest invoice is billed by charging automatically, `delinquent` is `true` if the invoice's latest charge failed. When the customer's latest invoice is billed by sending an invoice, `delinquent` is `true` if the invoice isn't paid by its due date. * * If an invoice is marked uncollectible by [dunning](https://stripe.com/docs/billing/automatic-collection), `delinquent` doesn't get reset to `false`. */ - delinquent?: boolean | null; + delinquent?: boolean | null /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description Describes the current discount active on the customer, if there is one. */ - discount?: Partial | null; + discount?: Partial | null /** @description The customer's email address. */ - email?: string | null; + email?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The prefix for the customer used to generate unique invoice numbers. */ - invoice_prefix?: string | null; - invoice_settings?: components["schemas"]["invoice_setting_customer_setting"]; + invoice_prefix?: string | null + invoice_settings?: components['schemas']['invoice_setting_customer_setting'] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The customer's full name or business name. */ - name?: string | null; + name?: string | null /** @description The suffix of the customer's next invoice number, e.g., 0001. */ - next_invoice_sequence?: number; + next_invoice_sequence?: number /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "customer"; + object: 'customer' /** @description The customer's phone number. */ - phone?: string | null; + phone?: string | null /** @description The customer's preferred locales (languages), ordered by preference. */ - preferred_locales?: string[] | null; + preferred_locales?: string[] | null /** @description Mailing and shipping address for the customer. Appears on invoices emailed to this customer. */ - shipping?: Partial | null; + shipping?: Partial | null /** * ApmsSourcesSourceList * @description The customer's payment sources, if any. */ sources?: { /** @description Details about each object. */ - data: (Partial & - Partial & - Partial & - Partial & - Partial)[]; + data: (Partial & + Partial & + Partial & + Partial & + Partial)[] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** * SubscriptionList * @description The customer's current subscriptions, if any. */ subscriptions?: { /** @description Details about each object. */ - data: components["schemas"]["subscription"][]; + data: components['schemas']['subscription'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - tax?: components["schemas"]["customer_tax"]; + url: string + } + tax?: components['schemas']['customer_tax'] /** * @description Describes the customer's tax exemption status. One of `none`, `exempt`, or `reverse`. When set to `reverse`, invoice and receipt PDFs include the text **"Reverse charge"**. * @enum {string|null} */ - tax_exempt?: ("exempt" | "none" | "reverse") | null; + tax_exempt?: ('exempt' | 'none' | 'reverse') | null /** * TaxIDsList * @description The customer's tax IDs. */ tax_ids?: { /** @description Details about each object. */ - data: components["schemas"]["tax_id"][]; + data: components['schemas']['tax_id'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** customer_acceptance */ customer_acceptance: { /** * Format: unix-time * @description The time at which the customer accepted the Mandate. */ - accepted_at?: number | null; - offline?: components["schemas"]["offline_acceptance"]; - online?: components["schemas"]["online_acceptance"]; + accepted_at?: number | null + offline?: components['schemas']['offline_acceptance'] + online?: components['schemas']['online_acceptance'] /** * @description The type of customer acceptance information included with the Mandate. One of `online` or `offline`. * @enum {string} */ - type: "offline" | "online"; - }; + type: 'offline' | 'online' + } /** * CustomerBalanceTransaction * @description Each customer has a [`balance`](https://stripe.com/docs/api/customers/object#customer_object-balance) value, @@ -3779,479 +3751,474 @@ export type components = { */ customer_balance_transaction: { /** @description 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: number; + amount: number /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The ID of the credit note (if any) related to the transaction. */ - credit_note?: (Partial & Partial) | null; + credit_note?: (Partial & Partial) | null /** @description 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: string; + currency: string /** @description The ID of the customer the transaction belongs to. */ - customer: Partial & Partial; + customer: Partial & Partial /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description 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: number; + ending_balance: number /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The ID of the invoice (if any) related to the transaction. */ - invoice?: (Partial & Partial) | null; + invoice?: (Partial & Partial) | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "customer_balance_transaction"; + object: 'customer_balance_transaction' /** * @description Transaction type: `adjustment`, `applied_to_invoice`, `credit_note`, `initial`, `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. * @enum {string} */ type: - | "adjustment" - | "applied_to_invoice" - | "credit_note" - | "initial" - | "invoice_too_large" - | "invoice_too_small" - | "migration" - | "unapplied_from_invoice" - | "unspent_receiver_credit"; - }; + | 'adjustment' + | 'applied_to_invoice' + | 'credit_note' + | 'initial' + | 'invoice_too_large' + | 'invoice_too_small' + | 'migration' + | 'unapplied_from_invoice' + | 'unspent_receiver_credit' + } /** CustomerTax */ customer_tax: { /** * @description Surfaces if automatic tax computation is possible given the current customer location information. * @enum {string} */ - automatic_tax: "failed" | "not_collecting" | "supported" | "unrecognized_location"; + automatic_tax: 'failed' | 'not_collecting' | 'supported' | 'unrecognized_location' /** @description A recent IP address of the customer used for tax reporting and tax location inference. */ - ip_address?: string | null; + ip_address?: string | null /** @description The customer's location as identified by Stripe Tax. */ - location?: Partial | null; - }; + location?: Partial | null + } /** CustomerTaxLocation */ customer_tax_location: { /** @description The customer's country as identified by Stripe Tax. */ - country: string; + country: string /** * @description The data source used to infer the customer's location. * @enum {string} */ - source: "billing_address" | "ip_address" | "payment_method" | "shipping_destination"; + source: 'billing_address' | 'ip_address' | 'payment_method' | 'shipping_destination' /** @description The customer's state, county, province, or region as identified by Stripe Tax. */ - state?: string | null; - }; + state?: string | null + } /** DeletedAccount */ deleted_account: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "account"; - }; + object: 'account' + } /** AlipayDeletedAccount */ deleted_alipay_account: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "alipay_account"; - }; + object: 'alipay_account' + } /** DeletedApplePayDomain */ deleted_apple_pay_domain: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "apple_pay_domain"; - }; + object: 'apple_pay_domain' + } /** DeletedBankAccount */ deleted_bank_account: { /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. */ - currency?: string | null; + currency?: string | null /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "bank_account"; - }; + object: 'bank_account' + } /** BitcoinDeletedReceiver */ deleted_bitcoin_receiver: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "bitcoin_receiver"; - }; + object: 'bitcoin_receiver' + } /** DeletedCard */ deleted_card: { /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. */ - currency?: string | null; + currency?: string | null /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "card"; - }; + object: 'card' + } /** DeletedCoupon */ deleted_coupon: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "coupon"; - }; + object: 'coupon' + } /** DeletedCustomer */ deleted_customer: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "customer"; - }; + object: 'customer' + } /** DeletedDiscount */ deleted_discount: { /** @description 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?: string | null; - coupon: components["schemas"]["coupon"]; + checkout_session?: string | null + coupon: components['schemas']['coupon'] /** @description The ID of the customer associated with this discount. */ - customer?: - | (Partial & - Partial & - Partial) - | null; + customer?: (Partial & Partial & Partial) | null /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description 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: string; + id: string /** @description The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice. */ - invoice?: string | null; + invoice?: string | null /** @description 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?: string | null; + invoice_item?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "discount"; + object: 'discount' /** @description The promotion code applied to create this discount. */ - promotion_code?: (Partial & Partial) | null; + promotion_code?: (Partial & Partial) | null /** * Format: unix-time * @description Date that the coupon was applied. */ - start: number; + start: number /** @description The subscription that this coupon is applied to, if it is applied to a particular subscription. */ - subscription?: string | null; - }; + subscription?: string | null + } /** Polymorphic */ - deleted_external_account: Partial & - Partial; + deleted_external_account: Partial & Partial /** DeletedInvoice */ deleted_invoice: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "invoice"; - }; + object: 'invoice' + } /** DeletedInvoiceItem */ deleted_invoiceitem: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "invoiceitem"; - }; + object: 'invoiceitem' + } /** Polymorphic */ - deleted_payment_source: Partial & - Partial & - Partial & - Partial; + deleted_payment_source: Partial & + Partial & + Partial & + Partial /** DeletedPerson */ deleted_person: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "person"; - }; + object: 'person' + } /** DeletedPlan */ deleted_plan: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "plan"; - }; + object: 'plan' + } /** DeletedPrice */ deleted_price: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "price"; - }; + object: 'price' + } /** DeletedProduct */ deleted_product: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "product"; - }; + object: 'product' + } /** RadarListDeletedList */ - "deleted_radar.value_list": { + 'deleted_radar.value_list': { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "radar.value_list"; - }; + object: 'radar.value_list' + } /** RadarListDeletedListItem */ - "deleted_radar.value_list_item": { + 'deleted_radar.value_list_item': { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "radar.value_list_item"; - }; + object: 'radar.value_list_item' + } /** DeletedTransferRecipient */ deleted_recipient: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "recipient"; - }; + object: 'recipient' + } /** DeletedSku */ deleted_sku: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "sku"; - }; + object: 'sku' + } /** DeletedSubscriptionItem */ deleted_subscription_item: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "subscription_item"; - }; + object: 'subscription_item' + } /** deleted_tax_id */ deleted_tax_id: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "tax_id"; - }; + object: 'tax_id' + } /** TerminalLocationDeletedLocation */ - "deleted_terminal.location": { + 'deleted_terminal.location': { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "terminal.location"; - }; + object: 'terminal.location' + } /** TerminalReaderDeletedReader */ - "deleted_terminal.reader": { + 'deleted_terminal.reader': { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "terminal.reader"; - }; + object: 'terminal.reader' + } /** NotificationWebhookEndpointDeleted */ deleted_webhook_endpoint: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "webhook_endpoint"; - }; + object: 'webhook_endpoint' + } /** DeliveryEstimate */ delivery_estimate: { /** @description If `type` is `"exact"`, `date` will be the expected delivery date in the format YYYY-MM-DD. */ - date?: string; + date?: string /** @description If `type` is `"range"`, `earliest` will be be the earliest delivery date in the format YYYY-MM-DD. */ - earliest?: string; + earliest?: string /** @description If `type` is `"range"`, `latest` will be the latest delivery date in the format YYYY-MM-DD. */ - latest?: string; + latest?: string /** @description The type of estimate. Must be either `"range"` or `"exact"`. */ - type: string; - }; + type: string + } /** * Discount * @description A discount represents the actual application of a coupon to a particular @@ -4262,49 +4229,43 @@ export type components = { */ discount: { /** @description 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?: string | null; - coupon: components["schemas"]["coupon"]; + checkout_session?: string | null + coupon: components['schemas']['coupon'] /** @description The ID of the customer associated with this discount. */ - customer?: - | (Partial & - Partial & - Partial) - | null; + customer?: (Partial & Partial & Partial) | null /** * Format: unix-time * @description 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?: number | null; + end?: number | null /** @description 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: string; + id: string /** @description The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice. */ - invoice?: string | null; + invoice?: string | null /** @description 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?: string | null; + invoice_item?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "discount"; + object: 'discount' /** @description The promotion code applied to create this discount. */ - promotion_code?: (Partial & Partial) | null; + promotion_code?: (Partial & Partial) | null /** * Format: unix-time * @description Date that the coupon was applied. */ - start: number; + start: number /** @description The subscription that this coupon is applied to, if it is applied to a particular subscription. */ - subscription?: string | null; - }; + subscription?: string | null + } /** DiscountsResourceDiscountAmount */ discounts_resource_discount_amount: { /** @description The amount, in %s, of the discount. */ - amount: number; + amount: number /** @description The discount that was applied to get this discount amount. */ - discount: Partial & - Partial & - Partial; - }; + discount: Partial & Partial & Partial + } /** * Dispute * @description A dispute occurs when a customer questions your charge with their card issuer. @@ -4317,150 +4278,150 @@ export type components = { */ dispute: { /** @description Disputed amount. Usually the amount of the charge, but can differ (usually because of currency fluctuation or because only part of the order is disputed). */ - amount: number; + amount: number /** @description 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: components["schemas"]["balance_transaction"][]; + balance_transactions: components['schemas']['balance_transaction'][] /** @description ID of the charge that was disputed. */ - charge: Partial & Partial; + charge: Partial & Partial /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; - evidence: components["schemas"]["dispute_evidence"]; - evidence_details: components["schemas"]["dispute_evidence_details"]; + currency: string + evidence: components['schemas']['dispute_evidence'] + evidence_details: components['schemas']['dispute_evidence_details'] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description If true, it is still possible to refund the disputed payment. Once the payment has been fully refunded, no further funds will be withdrawn from your Stripe account as a result of this dispute. */ - is_charge_refundable: boolean; + is_charge_refundable: boolean /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "dispute"; + object: 'dispute' /** @description ID of the PaymentIntent that was disputed. */ - payment_intent?: (Partial & Partial) | null; + payment_intent?: (Partial & Partial) | null /** @description 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`. Read more about [dispute reasons](https://stripe.com/docs/disputes/categories). */ - reason: string; + reason: string /** * @description Current status of dispute. Possible values are `warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `charge_refunded`, `won`, or `lost`. * @enum {string} */ status: - | "charge_refunded" - | "lost" - | "needs_response" - | "under_review" - | "warning_closed" - | "warning_needs_response" - | "warning_under_review" - | "won"; - }; + | 'charge_refunded' + | 'lost' + | 'needs_response' + | 'under_review' + | 'warning_closed' + | 'warning_needs_response' + | 'warning_under_review' + | 'won' + } /** DisputeEvidence */ dispute_evidence: { /** @description 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?: string | null; + access_activity_log?: string | null /** @description The billing address provided by the customer. */ - billing_address?: string | null; + billing_address?: string | null /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your subscription cancellation policy, as shown to the customer. */ - cancellation_policy?: (Partial & Partial) | null; + cancellation_policy?: (Partial & Partial) | null /** @description An explanation of how and when the customer was shown your refund policy prior to purchase. */ - cancellation_policy_disclosure?: string | null; + cancellation_policy_disclosure?: string | null /** @description A justification for why the customer's subscription was not canceled. */ - cancellation_rebuttal?: string | null; + cancellation_rebuttal?: string | null /** @description (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?: (Partial & Partial) | null; + customer_communication?: (Partial & Partial) | null /** @description The email address of the customer. */ - customer_email_address?: string | null; + customer_email_address?: string | null /** @description The name of the customer. */ - customer_name?: string | null; + customer_name?: string | null /** @description The IP address that the customer used when making the purchase. */ - customer_purchase_ip?: string | null; + customer_purchase_ip?: string | null /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A relevant document or contract showing the customer's signature. */ - customer_signature?: (Partial & Partial) | null; + customer_signature?: (Partial & Partial) | null /** @description (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?: (Partial & Partial) | null; + duplicate_charge_documentation?: (Partial & Partial) | null /** @description An explanation of the difference between the disputed charge versus the prior charge that appears to be a duplicate. */ - duplicate_charge_explanation?: string | null; + duplicate_charge_explanation?: string | null /** @description The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge. */ - duplicate_charge_id?: string | null; + duplicate_charge_id?: string | null /** @description A description of the product or service that was sold. */ - product_description?: string | null; + product_description?: string | null /** @description (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?: (Partial & Partial) | null; + receipt?: (Partial & Partial) | null /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your refund policy, as shown to the customer. */ - refund_policy?: (Partial & Partial) | null; + refund_policy?: (Partial & Partial) | null /** @description Documentation demonstrating that the customer was shown your refund policy prior to purchase. */ - refund_policy_disclosure?: string | null; + refund_policy_disclosure?: string | null /** @description A justification for why the customer is not entitled to a refund. */ - refund_refusal_explanation?: string | null; + refund_refusal_explanation?: string | null /** @description The date on which the customer received or began receiving the purchased service, in a clear human-readable format. */ - service_date?: string | null; + service_date?: string | null /** @description (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?: (Partial & Partial) | null; + service_documentation?: (Partial & Partial) | null /** @description The address to which a physical product was shipped. You should try to include as complete address information as possible. */ - shipping_address?: string | null; + shipping_address?: string | null /** @description 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?: string | null; + shipping_carrier?: string | null /** @description The date on which a physical product began its route to the shipping address, in a clear human-readable format. */ - shipping_date?: string | null; + shipping_date?: string | null /** @description (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?: (Partial & Partial) | null; + shipping_documentation?: (Partial & Partial) | null /** @description 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?: string | null; + shipping_tracking_number?: string | null /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any additional evidence or statements. */ - uncategorized_file?: (Partial & Partial) | null; + uncategorized_file?: (Partial & Partial) | null /** @description Any additional evidence or statements. */ - uncategorized_text?: string | null; - }; + uncategorized_text?: string | null + } /** DisputeEvidenceDetails */ dispute_evidence_details: { /** * Format: unix-time * @description Date by which evidence must be submitted in order to successfully challenge dispute. Will be null if the customer's bank or credit card company doesn't allow a response for this particular dispute. */ - due_by?: number | null; + due_by?: number | null /** @description Whether evidence has been staged for this dispute. */ - has_evidence: boolean; + has_evidence: boolean /** @description 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: boolean; + past_due: boolean /** @description The number of times evidence has been submitted. Typically, you may only submit evidence once. */ - submission_count: number; - }; + submission_count: number + } /** EphemeralKey */ ephemeral_key: { /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** * Format: unix-time * @description Time at which the key will expire. Measured in seconds since the Unix epoch. */ - expires: number; + expires: number /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "ephemeral_key"; + object: 'ephemeral_key' /** @description The key's secret. You can use this value to make authorized requests to the Stripe API. */ - secret?: string; - }; + secret?: string + } /** @description An error response from the Stripe API */ error: { - error: components["schemas"]["api_errors"]; - }; + error: components['schemas']['api_errors'] + } /** * NotificationEvent * @description Events are our way of letting you know when something interesting happens in @@ -4495,31 +4456,31 @@ export type components = { */ event: { /** @description The connected account that originated the event. */ - account?: string; + account?: string /** @description The Stripe API version used to render `data`. *Note: This property is populated only for events on or after October 31, 2014*. */ - api_version?: string | null; + api_version?: string | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; - data: components["schemas"]["notification_event_data"]; + created: number + data: components['schemas']['notification_event_data'] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "event"; + object: 'event' /** @description Number of webhooks that have yet to be successfully delivered (i.e., to return a 20x response) to the URLs you've specified. */ - pending_webhooks: number; + pending_webhooks: number /** @description Information on the API request that instigated the event. */ - request?: Partial | null; + request?: Partial | null /** @description Description of the event (e.g., `invoice.created` or `charge.refunded`). */ - type: string; - }; + type: string + } /** * ExchangeRate * @description `Exchange Rate` objects allow you to determine the rates that Stripe is @@ -4536,30 +4497,30 @@ export type components = { */ exchange_rate: { /** @description 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: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "exchange_rate"; + object: 'exchange_rate' /** @description 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: { [key: string]: number }; - }; + rates: { [key: string]: number } + } /** Polymorphic */ - external_account: Partial & Partial; + external_account: Partial & Partial /** Fee */ fee: { /** @description Amount of the fee, in cents. */ - amount: number; + amount: number /** @description ID of the Connect application that earned the fee. */ - application?: string | null; + application?: string | null /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description Type of the fee, one of: `application_fee`, `stripe_fee` or `tax`. */ - type: string; - }; + type: string + } /** * FeeRefund * @description `Application Fee Refund` objects allow you to refund an application fee that @@ -4570,28 +4531,28 @@ export type components = { */ fee_refund: { /** @description Amount, in %s. */ - amount: number; + amount: number /** @description Balance transaction that describes the impact on your account balance. */ - balance_transaction?: (Partial & Partial) | null; + balance_transaction?: (Partial & Partial) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description ID of the application fee that was refunded. */ - fee: Partial & Partial; + fee: Partial & Partial /** @description Unique identifier for the object. */ - id: string; + id: string /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "fee_refund"; - }; + object: 'fee_refund' + } /** * File * @description This is an object representing a file hosted on Stripe's servers. The @@ -4607,66 +4568,66 @@ export type components = { * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** * Format: unix-time * @description The time at which the file expires and is no longer available in epoch seconds. */ - expires_at?: number | null; + expires_at?: number | null /** @description A filename for the file, suitable for saving to a filesystem. */ - filename?: string | null; + filename?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** * FileFileLinkList * @description A list of [file links](https://stripe.com/docs/api#file_links) that point at this file. */ links?: { /** @description Details about each object. */ - data: components["schemas"]["file_link"][]; + data: components['schemas']['file_link'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } | null; + url: string + } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "file"; + object: 'file' /** * @description The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file. * @enum {string} */ purpose: - | "account_requirement" - | "additional_verification" - | "business_icon" - | "business_logo" - | "customer_signature" - | "dispute_evidence" - | "document_provider_identity_document" - | "finance_report_run" - | "identity_document" - | "identity_document_downloadable" - | "pci_document" - | "selfie" - | "sigma_scheduled_query" - | "tax_document_user_upload"; + | 'account_requirement' + | 'additional_verification' + | 'business_icon' + | 'business_logo' + | 'customer_signature' + | 'dispute_evidence' + | 'document_provider_identity_document' + | 'finance_report_run' + | 'identity_document' + | 'identity_document_downloadable' + | 'pci_document' + | 'selfie' + | 'sigma_scheduled_query' + | 'tax_document_user_upload' /** @description The size in bytes of the file object. */ - size: number; + size: number /** @description A user friendly title for the document. */ - title?: string | null; + title?: string | null /** @description The type of the file returned (e.g., `csv`, `pdf`, `jpg`, or `png`). */ - type?: string | null; + type?: string | null /** @description The URL from which the file can be downloaded using your live secret API key. */ - url?: string | null; - }; + url?: string | null + } /** * FileLink * @description To share the contents of a `File` object with non-Stripe users, you can @@ -4678,252 +4639,250 @@ export type components = { * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Whether this link is already expired. */ - expired: boolean; + expired: boolean /** * Format: unix-time * @description Time at which the link expires. */ - expires_at?: number | null; + expires_at?: number | null /** @description The file object this link points to. */ - file: Partial & Partial; + file: Partial & Partial /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "file_link"; + object: 'file_link' /** @description The publicly accessible URL to download the file. */ - url?: string | null; - }; + url?: string | null + } /** FinancialReportingFinanceReportRunRunParameters */ financial_reporting_finance_report_run_run_parameters: { /** @description The set of output columns requested for inclusion in the report run. */ - columns?: string[]; + columns?: string[] /** @description Connected account ID by which to filter the report run. */ - connected_account?: string; + connected_account?: string /** @description Currency of objects to be included in the report run. */ - currency?: string; + currency?: string /** * Format: unix-time * @description Ending timestamp of data to be included in the report run (exclusive). */ - interval_end?: number; + interval_end?: number /** * Format: unix-time * @description Starting timestamp of data to be included in the report run. */ - interval_start?: number; + interval_start?: number /** @description Payout ID by which to filter the report run. */ - payout?: string; + payout?: string /** @description Category of balance transactions to be included in the report run. */ - reporting_category?: string; + reporting_category?: string /** @description 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?: string; - }; + timezone?: string + } /** * GelatoDataDocumentReportDateOfBirth * @description Point in Time */ gelato_data_document_report_date_of_birth: { /** @description Numerical day between 1 and 31. */ - day?: number | null; + day?: number | null /** @description Numerical month between 1 and 12. */ - month?: number | null; + month?: number | null /** @description The four-digit year. */ - year?: number | null; - }; + year?: number | null + } /** * GelatoDataDocumentReportExpirationDate * @description Point in Time */ gelato_data_document_report_expiration_date: { /** @description Numerical day between 1 and 31. */ - day?: number | null; + day?: number | null /** @description Numerical month between 1 and 12. */ - month?: number | null; + month?: number | null /** @description The four-digit year. */ - year?: number | null; - }; + year?: number | null + } /** * GelatoDataDocumentReportIssuedDate * @description Point in Time */ gelato_data_document_report_issued_date: { /** @description Numerical day between 1 and 31. */ - day?: number | null; + day?: number | null /** @description Numerical month between 1 and 12. */ - month?: number | null; + month?: number | null /** @description The four-digit year. */ - year?: number | null; - }; + year?: number | null + } /** * GelatoDataIdNumberReportDate * @description Point in Time */ gelato_data_id_number_report_date: { /** @description Numerical day between 1 and 31. */ - day?: number | null; + day?: number | null /** @description Numerical month between 1 and 12. */ - month?: number | null; + month?: number | null /** @description The four-digit year. */ - year?: number | null; - }; + year?: number | null + } /** * GelatoDataVerifiedOutputsDate * @description Point in Time */ gelato_data_verified_outputs_date: { /** @description Numerical day between 1 and 31. */ - day?: number | null; + day?: number | null /** @description Numerical month between 1 and 12. */ - month?: number | null; + month?: number | null /** @description The four-digit year. */ - year?: number | null; - }; + year?: number | null + } /** * GelatoDocumentReport * @description Result from a document check */ gelato_document_report: { /** @description Address as it appears in the document. */ - address?: Partial | null; + address?: Partial | null /** @description Date of birth as it appears in the document. */ - dob?: Partial | null; + dob?: Partial | null /** @description Details on the verification error. Present when status is `unverified`. */ - error?: Partial | null; + error?: Partial | null /** @description Expiration date of the document. */ - expiration_date?: Partial | null; + expiration_date?: Partial | null /** @description Array of [File](https://stripe.com/docs/api/files) ids containing images for this document. */ - files?: string[] | null; + files?: string[] | null /** @description First name as it appears in the document. */ - first_name?: string | null; + first_name?: string | null /** @description Issued date of the document. */ - issued_date?: Partial | null; + issued_date?: Partial | null /** @description Issuing country of the document. */ - issuing_country?: string | null; + issuing_country?: string | null /** @description Last name as it appears in the document. */ - last_name?: string | null; + last_name?: string | null /** @description Document ID number. */ - number?: string | null; + number?: string | null /** * @description Status of this `document` check. * @enum {string} */ - status: "unverified" | "verified"; + status: 'unverified' | 'verified' /** * @description Type of the document. * @enum {string|null} */ - type?: ("driving_license" | "id_card" | "passport") | null; - }; + type?: ('driving_license' | 'id_card' | 'passport') | null + } /** GelatoDocumentReportError */ gelato_document_report_error: { /** * @description A short machine-readable string giving the reason for the verification failure. * @enum {string|null} */ - code?: ("document_expired" | "document_type_not_supported" | "document_unverified_other") | null; + code?: ('document_expired' | 'document_type_not_supported' | 'document_unverified_other') | null /** @description A human-readable message giving the reason for the failure. These messages can be shown to your users. */ - reason?: string | null; - }; + reason?: string | null + } /** * GelatoIdNumberReport * @description Result from an id_number check */ gelato_id_number_report: { /** @description Date of birth. */ - dob?: Partial | null; + dob?: Partial | null /** @description Details on the verification error. Present when status is `unverified`. */ - error?: Partial | null; + error?: Partial | null /** @description First name. */ - first_name?: string | null; + first_name?: string | null /** @description ID number. */ - id_number?: string | null; + id_number?: string | null /** * @description Type of ID number. * @enum {string|null} */ - id_number_type?: ("br_cpf" | "sg_nric" | "us_ssn") | null; + id_number_type?: ('br_cpf' | 'sg_nric' | 'us_ssn') | null /** @description Last name. */ - last_name?: string | null; + last_name?: string | null /** * @description Status of this `id_number` check. * @enum {string} */ - status: "unverified" | "verified"; - }; + status: 'unverified' | 'verified' + } /** GelatoIdNumberReportError */ gelato_id_number_report_error: { /** * @description A short machine-readable string giving the reason for the verification failure. * @enum {string|null} */ - code?: ("id_number_insufficient_document_data" | "id_number_mismatch" | "id_number_unverified_other") | null; + code?: ('id_number_insufficient_document_data' | 'id_number_mismatch' | 'id_number_unverified_other') | null /** @description A human-readable message giving the reason for the failure. These messages can be shown to your users. */ - reason?: string | null; - }; + reason?: string | null + } /** GelatoReportDocumentOptions */ gelato_report_document_options: { /** @description 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?: ("driving_license" | "id_card" | "passport")[]; + allowed_types?: ('driving_license' | 'id_card' | 'passport')[] /** @description 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?: boolean; + require_id_number?: boolean /** @description Disable image uploads, identity document images have to be captured using the device’s camera. */ - require_live_capture?: boolean; + require_live_capture?: boolean /** @description 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?: boolean; - }; + require_matching_selfie?: boolean + } /** GelatoReportIdNumberOptions */ - gelato_report_id_number_options: { [key: string]: unknown }; + gelato_report_id_number_options: { [key: string]: unknown } /** * GelatoSelfieReport * @description Result from a selfie check */ gelato_selfie_report: { /** @description ID of the [File](https://stripe.com/docs/api/files) holding the image of the identity document used in this check. */ - document?: string | null; + document?: string | null /** @description Details on the verification error. Present when status is `unverified`. */ - error?: Partial | null; + error?: Partial | null /** @description ID of the [File](https://stripe.com/docs/api/files) holding the image of the selfie used in this check. */ - selfie?: string | null; + selfie?: string | null /** * @description Status of this `selfie` check. * @enum {string} */ - status: "unverified" | "verified"; - }; + status: 'unverified' | 'verified' + } /** GelatoSelfieReportError */ gelato_selfie_report_error: { /** * @description A short machine-readable string giving the reason for the verification failure. * @enum {string|null} */ - code?: - | ("selfie_document_missing_photo" | "selfie_face_mismatch" | "selfie_manipulated" | "selfie_unverified_other") - | null; + code?: ('selfie_document_missing_photo' | 'selfie_face_mismatch' | 'selfie_manipulated' | 'selfie_unverified_other') | null /** @description A human-readable message giving the reason for the failure. These messages can be shown to your users. */ - reason?: string | null; - }; + reason?: string | null + } /** GelatoSessionDocumentOptions */ gelato_session_document_options: { /** @description 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?: ("driving_license" | "id_card" | "passport")[]; + allowed_types?: ('driving_license' | 'id_card' | 'passport')[] /** @description 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?: boolean; + require_id_number?: boolean /** @description Disable image uploads, identity document images have to be captured using the device’s camera. */ - require_live_capture?: boolean; + require_live_capture?: boolean /** @description 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?: boolean; - }; + require_matching_selfie?: boolean + } /** GelatoSessionIdNumberOptions */ - gelato_session_id_number_options: { [key: string]: unknown }; + gelato_session_id_number_options: { [key: string]: unknown } /** * GelatoSessionLastError * @description Shows last VerificationSession error @@ -4935,54 +4894,54 @@ export type components = { */ code?: | ( - | "abandoned" - | "consent_declined" - | "country_not_supported" - | "device_not_supported" - | "document_expired" - | "document_type_not_supported" - | "document_unverified_other" - | "id_number_insufficient_document_data" - | "id_number_mismatch" - | "id_number_unverified_other" - | "selfie_document_missing_photo" - | "selfie_face_mismatch" - | "selfie_manipulated" - | "selfie_unverified_other" - | "under_supported_age" + | 'abandoned' + | 'consent_declined' + | 'country_not_supported' + | 'device_not_supported' + | 'document_expired' + | 'document_type_not_supported' + | 'document_unverified_other' + | 'id_number_insufficient_document_data' + | 'id_number_mismatch' + | 'id_number_unverified_other' + | 'selfie_document_missing_photo' + | 'selfie_face_mismatch' + | 'selfie_manipulated' + | 'selfie_unverified_other' + | 'under_supported_age' ) - | null; + | null /** @description A message that explains the reason for verification or user-session failure. */ - reason?: string | null; - }; + reason?: string | null + } /** GelatoVerificationReportOptions */ gelato_verification_report_options: { - document?: components["schemas"]["gelato_report_document_options"]; - id_number?: components["schemas"]["gelato_report_id_number_options"]; - }; + document?: components['schemas']['gelato_report_document_options'] + id_number?: components['schemas']['gelato_report_id_number_options'] + } /** GelatoVerificationSessionOptions */ gelato_verification_session_options: { - document?: components["schemas"]["gelato_session_document_options"]; - id_number?: components["schemas"]["gelato_session_id_number_options"]; - }; + document?: components['schemas']['gelato_session_document_options'] + id_number?: components['schemas']['gelato_session_id_number_options'] + } /** GelatoVerifiedOutputs */ gelato_verified_outputs: { /** @description The user's verified address. */ - address?: Partial | null; + address?: Partial | null /** @description The user’s verified date of birth. */ - dob?: Partial | null; + dob?: Partial | null /** @description The user's verified first name. */ - first_name?: string | null; + first_name?: string | null /** @description The user's verified id number. */ - id_number?: string | null; + id_number?: string | null /** * @description The user's verified id number type. * @enum {string|null} */ - id_number_type?: ("br_cpf" | "sg_nric" | "us_ssn") | null; + id_number_type?: ('br_cpf' | 'sg_nric' | 'us_ssn') | null /** @description The user's verified last name. */ - last_name?: string | null; - }; + last_name?: string | null + } /** * GelatoVerificationReport * @description A VerificationReport is the result of an attempt to collect and verify data from a user. @@ -4997,33 +4956,33 @@ export type components = { * * Related guides: [Accessing verification results](https://stripe.com/docs/identity/verification-sessions#results). */ - "identity.verification_report": { + 'identity.verification_report': { /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; - document?: components["schemas"]["gelato_document_report"]; + created: number + document?: components['schemas']['gelato_document_report'] /** @description Unique identifier for the object. */ - id: string; - id_number?: components["schemas"]["gelato_id_number_report"]; + id: string + id_number?: components['schemas']['gelato_id_number_report'] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "identity.verification_report"; - options: components["schemas"]["gelato_verification_report_options"]; - selfie?: components["schemas"]["gelato_selfie_report"]; + object: 'identity.verification_report' + options: components['schemas']['gelato_verification_report_options'] + selfie?: components['schemas']['gelato_selfie_report'] /** * @description Type of report. * @enum {string} */ - type: "document" | "id_number"; + type: 'document' | 'id_number' /** @description ID of the VerificationSession that created this report. */ - verification_session?: string | null; - }; + verification_session?: string | null + } /** * GelatoVerificationSession * @description A VerificationSession guides you through the process of collecting and verifying the identities @@ -5038,49 +4997,47 @@ export type components = { * * Related guide: [The Verification Sessions API](https://stripe.com/docs/identity/verification-sessions) */ - "identity.verification_session": { + 'identity.verification_session': { /** @description 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?: string | null; + client_secret?: string | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Unique identifier for the object. */ - id: string; + id: string /** @description If present, this property tells you the last error encountered when processing the verification. */ - last_error?: Partial | null; + last_error?: Partial | null /** @description ID of the most recent VerificationReport. [Learn more about accessing detailed verification results.](https://stripe.com/docs/identity/verification-sessions#results) */ - last_verification_report?: - | (Partial & Partial) - | null; + last_verification_report?: (Partial & Partial) | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "identity.verification_session"; - options: components["schemas"]["gelato_verification_session_options"]; + object: 'identity.verification_session' + options: components['schemas']['gelato_verification_session_options'] /** @description Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null. */ - redaction?: Partial | null; + redaction?: Partial | null /** * @description Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work). * @enum {string} */ - status: "canceled" | "processing" | "requires_input" | "verified"; + status: 'canceled' | 'processing' | 'requires_input' | 'verified' /** * @description The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. * @enum {string} */ - type: "document" | "id_number"; + type: 'document' | 'id_number' /** @description 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?: string | null; + url?: string | null /** @description The user’s verified data. */ - verified_outputs?: Partial | null; - }; + verified_outputs?: Partial | null + } /** * Invoice * @description Invoices are statements of amounts owed by a customer, and are either @@ -5118,333 +5075,321 @@ export type components = { */ invoice: { /** @description The country of the business associated with this invoice, most often the business creating the invoice. */ - account_country?: string | null; + account_country?: string | null /** @description The public name of the business associated with this invoice, most often the business creating the invoice. */ - account_name?: string | null; + account_name?: string | null /** @description The account tax IDs associated with the invoice. Only editable when the invoice is a draft. */ - account_tax_ids?: - | (Partial & - Partial & - Partial)[] - | null; + account_tax_ids?: (Partial & Partial & Partial)[] | null /** @description 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: number; + amount_due: number /** @description The amount, in %s, that was paid. */ - amount_paid: number; + amount_paid: number /** @description The amount remaining, in %s, that is due. */ - amount_remaining: number; + amount_remaining: number /** @description The fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account when the invoice is paid. */ - application_fee_amount?: number | null; + application_fee_amount?: number | null /** @description 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. */ - attempt_count: number; + attempt_count: number /** @description 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: boolean; + attempted: boolean /** @description Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice. When `false`, the invoice's state will not automatically advance without an explicit action. */ - auto_advance?: boolean; - automatic_tax: components["schemas"]["automatic_tax"]; + auto_advance?: boolean + automatic_tax: components['schemas']['automatic_tax'] /** * @description Indicates the reason why the invoice was created. `subscription_cycle` indicates an invoice created by a subscription advancing into a new period. `subscription_create` indicates an invoice created due to creating a subscription. `subscription_update` indicates an invoice created due to updating a subscription. `subscription` is set for all old invoices to indicate either a change to a subscription or a period advancement. `manual` is set for all invoices unrelated to a subscription (for example: created via the invoice editor). The `upcoming` value is reserved for simulated invoices per the upcoming invoice endpoint. `subscription_threshold` indicates an invoice created due to a billing threshold being reached. * @enum {string|null} */ billing_reason?: | ( - | "automatic_pending_invoice_item_invoice" - | "manual" - | "quote_accept" - | "subscription" - | "subscription_create" - | "subscription_cycle" - | "subscription_threshold" - | "subscription_update" - | "upcoming" + | 'automatic_pending_invoice_item_invoice' + | 'manual' + | 'quote_accept' + | 'subscription' + | 'subscription_create' + | 'subscription_cycle' + | 'subscription_threshold' + | 'subscription_update' + | 'upcoming' ) - | null; + | null /** @description ID of the latest charge generated for this invoice, if any. */ - charge?: (Partial & Partial) | null; + charge?: (Partial & Partial) | null /** * @description 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. * @enum {string} */ - collection_method: "charge_automatically" | "send_invoice"; + collection_method: 'charge_automatically' | 'send_invoice' /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Custom fields displayed on the invoice. */ - custom_fields?: components["schemas"]["invoice_setting_custom_field"][] | null; + custom_fields?: components['schemas']['invoice_setting_custom_field'][] | null /** @description The ID of the customer who will be billed. */ - customer?: - | (Partial & - Partial & - Partial) - | null; + customer?: (Partial & Partial & Partial) | null /** @description 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?: Partial | null; + customer_address?: Partial | null /** @description 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?: string | null; + customer_email?: string | null /** @description 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?: string | null; + customer_name?: string | null /** @description 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?: string | null; + customer_phone?: string | null /** @description 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?: Partial | null; + customer_shipping?: Partial | null /** * @description 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. * @enum {string|null} */ - customer_tax_exempt?: ("exempt" | "none" | "reverse") | null; + customer_tax_exempt?: ('exempt' | 'none' | 'reverse') | null /** @description 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?: components["schemas"]["invoices_resource_invoice_tax_id"][] | null; + customer_tax_ids?: components['schemas']['invoices_resource_invoice_tax_id'][] | null /** @description 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?: (Partial & Partial) | null; + default_payment_method?: (Partial & Partial) | null /** @description 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?: | (Partial & - Partial & - Partial & - Partial & - Partial & - Partial) - | null; + Partial & + Partial & + Partial & + Partial & + Partial) + | null /** @description The tax rates applied to this invoice, if any. */ - default_tax_rates: components["schemas"]["tax_rate"][]; + default_tax_rates: components['schemas']['tax_rate'][] /** @description An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. */ - description?: string | null; + description?: string | null /** @description Describes the current discount applied to this invoice, if there is one. Not populated if there are multiple discounts. */ - discount?: Partial | null; + discount?: Partial | null /** @description The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount. */ - discounts?: - | (Partial & - Partial & - Partial)[] - | null; + discounts?: (Partial & Partial & Partial)[] | null /** * Format: unix-time * @description The date on which payment for this invoice is due. This value will be `null` for invoices where `collection_method=charge_automatically`. */ - due_date?: number | null; + due_date?: number | null /** @description 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?: number | null; + ending_balance?: number | null /** @description Footer displayed on the invoice. */ - footer?: string | null; + footer?: string | null /** @description 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?: string | null; + hosted_invoice_url?: string | null /** @description Unique identifier for the object. */ - id?: string; + id?: string /** @description The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null. */ - invoice_pdf?: string | null; + invoice_pdf?: string | null /** @description The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized. */ - last_finalization_error?: Partial | null; + last_finalization_error?: Partial | null /** * InvoiceLinesList * @description The individual line items that make up the invoice. `lines` is sorted as follows: invoice items in reverse chronological order, followed by the subscription, if any. */ lines: { /** @description Details about each object. */ - data: components["schemas"]["line_item"][]; + data: components['schemas']['line_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * Format: unix-time * @description The time at which payment will next be attempted. This value will be `null` for invoices where `collection_method=send_invoice`. */ - next_payment_attempt?: number | null; + next_payment_attempt?: number | null /** @description 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?: string | null; + number?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "invoice"; + object: 'invoice' /** @description 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?: (Partial & Partial) | null; + on_behalf_of?: (Partial & Partial) | null /** @description 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: boolean; + paid: boolean /** @description 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: boolean; + paid_out_of_band: boolean /** @description 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?: (Partial & Partial) | null; - payment_settings: components["schemas"]["invoices_payment_settings"]; + payment_intent?: (Partial & Partial) | null + payment_settings: components['schemas']['invoices_payment_settings'] /** * Format: unix-time * @description End of the usage period during which invoice items were added to this invoice. */ - period_end: number; + period_end: number /** * Format: unix-time * @description Start of the usage period during which invoice items were added to this invoice. */ - period_start: number; + period_start: number /** @description Total amount of all post-payment credit notes issued for this invoice. */ - post_payment_credit_notes_amount: number; + post_payment_credit_notes_amount: number /** @description Total amount of all pre-payment credit notes issued for this invoice. */ - pre_payment_credit_notes_amount: number; + pre_payment_credit_notes_amount: number /** @description The quote this invoice was generated from. */ - quote?: (Partial & Partial) | null; + quote?: (Partial & Partial) | null /** @description This is the transaction number that appears on email receipts sent for this invoice. */ - receipt_number?: string | null; + receipt_number?: string | null /** @description Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. */ - starting_balance: number; + starting_balance: number /** @description Extra information about an invoice for the customer's credit card statement. */ - statement_descriptor?: string | null; + statement_descriptor?: string | null /** * @description The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview) * @enum {string|null} */ - status?: ("deleted" | "draft" | "open" | "paid" | "uncollectible" | "void") | null; - status_transitions: components["schemas"]["invoices_status_transitions"]; + status?: ('deleted' | 'draft' | 'open' | 'paid' | 'uncollectible' | 'void') | null + status_transitions: components['schemas']['invoices_status_transitions'] /** @description The subscription that this invoice was prepared for, if any. */ - subscription?: (Partial & Partial) | null; + subscription?: (Partial & Partial) | null /** @description Only set for upcoming invoices that preview prorations. The time used to calculate prorations. */ - subscription_proration_date?: number; + subscription_proration_date?: number /** @description Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated */ - subtotal: number; + subtotal: number /** @description The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice. */ - tax?: number | null; - threshold_reason?: components["schemas"]["invoice_threshold_reason"]; + tax?: number | null + threshold_reason?: components['schemas']['invoice_threshold_reason'] /** @description Total after discounts and taxes. */ - total: number; + total: number /** @description The aggregate amounts calculated per discount across all line items. */ - total_discount_amounts?: components["schemas"]["discounts_resource_discount_amount"][] | null; + total_discount_amounts?: components['schemas']['discounts_resource_discount_amount'][] | null /** @description The aggregate amounts calculated per tax rate for all line items. */ - total_tax_amounts: components["schemas"]["invoice_tax_amount"][]; + total_tax_amounts: components['schemas']['invoice_tax_amount'][] /** @description 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?: Partial | null; + transfer_data?: Partial | null /** * Format: unix-time * @description 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?: number | null; - }; + webhooks_delivered_at?: number | null + } /** InvoiceItemThresholdReason */ invoice_item_threshold_reason: { /** @description The IDs of the line items that triggered the threshold invoice. */ - line_item_ids: string[]; + line_item_ids: string[] /** @description The quantity threshold boundary that applied to the given line item. */ - usage_gte: number; - }; + usage_gte: number + } /** InvoiceLineItemPeriod */ invoice_line_item_period: { /** * Format: unix-time * @description End of the line item's billing period */ - end: number; + end: number /** * Format: unix-time * @description Start of the line item's billing period */ - start: number; - }; + start: number + } /** invoice_mandate_options_card */ invoice_mandate_options_card: { /** @description Amount to be charged for future payments. */ - amount?: number | null; + amount?: number | null /** * @description 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. * @enum {string|null} */ - amount_type?: ("fixed" | "maximum") | null; + amount_type?: ('fixed' | 'maximum') | null /** @description A description of the mandate or subscription that is meant to be displayed to the customer. */ - description?: string | null; - }; + description?: string | null + } /** invoice_payment_method_options_acss_debit */ invoice_payment_method_options_acss_debit: { - mandate_options?: components["schemas"]["invoice_payment_method_options_acss_debit_mandate_options"]; + mandate_options?: components['schemas']['invoice_payment_method_options_acss_debit_mandate_options'] /** * @description Bank account verification method. * @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; - }; + verification_method?: 'automatic' | 'instant' | 'microdeposits' + } /** invoice_payment_method_options_acss_debit_mandate_options */ invoice_payment_method_options_acss_debit_mandate_options: { /** * @description Transaction type of the mandate. * @enum {string|null} */ - transaction_type?: ("business" | "personal") | null; - }; + transaction_type?: ('business' | 'personal') | null + } /** invoice_payment_method_options_bancontact */ invoice_payment_method_options_bancontact: { /** * @description Preferred language of the Bancontact authorization page that the customer is redirected to. * @enum {string} */ - preferred_language: "de" | "en" | "fr" | "nl"; - }; + preferred_language: 'de' | 'en' | 'fr' | 'nl' + } /** invoice_payment_method_options_card */ invoice_payment_method_options_card: { /** * @description 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#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. * @enum {string|null} */ - request_three_d_secure?: ("any" | "automatic") | null; - }; + request_three_d_secure?: ('any' | 'automatic') | null + } /** InvoiceSettingCustomField */ invoice_setting_custom_field: { /** @description The name of the custom field. */ - name: string; + name: string /** @description The value of the custom field. */ - value: string; - }; + value: string + } /** InvoiceSettingCustomerSetting */ invoice_setting_customer_setting: { /** @description Default custom fields to be displayed on invoices for this customer. */ - custom_fields?: components["schemas"]["invoice_setting_custom_field"][] | null; + custom_fields?: components['schemas']['invoice_setting_custom_field'][] | null /** @description 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?: (Partial & Partial) | null; + default_payment_method?: (Partial & Partial) | null /** @description Default footer to be displayed on invoices for this customer. */ - footer?: string | null; - }; + footer?: string | null + } /** InvoiceSettingQuoteSetting */ invoice_setting_quote_setting: { /** @description 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?: number | null; - }; + days_until_due?: number | null + } /** InvoiceSettingSubscriptionScheduleSetting */ invoice_setting_subscription_schedule_setting: { /** @description 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?: number | null; - }; + days_until_due?: number | null + } /** InvoiceTaxAmount */ invoice_tax_amount: { /** @description The amount, in %s, of the tax. */ - amount: number; + amount: number /** @description Whether this tax amount is inclusive or exclusive. */ - inclusive: boolean; + inclusive: boolean /** @description The tax rate that was applied to get this tax amount. */ - tax_rate: Partial & Partial; - }; + tax_rate: Partial & Partial + } /** InvoiceThresholdReason */ invoice_threshold_reason: { /** @description The total invoice amount threshold boundary if it triggered the threshold invoice. */ - amount_gte?: number | null; + amount_gte?: number | null /** @description Indicates which line items triggered a threshold invoice. */ - item_reasons: components["schemas"]["invoice_item_threshold_reason"][]; - }; + item_reasons: components['schemas']['invoice_item_threshold_reason'][] + } /** InvoiceTransferData */ invoice_transfer_data: { /** @description The amount in %s that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination. */ - amount?: number | null; + amount?: number | null /** @description The account where funds from the payment will be transferred to upon payment success. */ - destination: Partial & Partial; - }; + destination: Partial & Partial + } /** * InvoiceItem * @description Sometimes you want to add a charge or credit to a customer, but actually @@ -5457,92 +5402,90 @@ export type components = { */ invoiceitem: { /** @description Amount (in the `currency` specified) of the invoice item. This should always be equal to `unit_amount * quantity`. */ - amount: number; + amount: number /** @description 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: string; + currency: string /** @description The ID of the customer who will be billed when this invoice item is billed. */ - customer: Partial & - Partial & - Partial; + customer: Partial & Partial & Partial /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - date: number; + date: number /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description If true, discounts will apply to this invoice item. Always false for prorations. */ - discountable: boolean; + discountable: boolean /** @description The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount. */ - discounts?: (Partial & Partial)[] | null; + discounts?: (Partial & Partial)[] | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The ID of the invoice this invoice item belongs to. */ - invoice?: (Partial & Partial) | null; + invoice?: (Partial & Partial) | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "invoiceitem"; - period: components["schemas"]["invoice_line_item_period"]; + object: 'invoiceitem' + period: components['schemas']['invoice_line_item_period'] /** @description The price of the invoice item. */ - price?: Partial | null; + price?: Partial | null /** @description Whether the invoice item was created automatically as a proration adjustment when the customer switched plans. */ - proration: boolean; + proration: boolean /** @description 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: number; + quantity: number /** @description The subscription that this invoice item has been created for, if any. */ - subscription?: (Partial & Partial) | null; + subscription?: (Partial & Partial) | null /** @description The subscription item that this invoice item has been created for, if any. */ - subscription_item?: string; + subscription_item?: string /** @description 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?: components["schemas"]["tax_rate"][] | null; + tax_rates?: components['schemas']['tax_rate'][] | null /** @description Unit amount (in the `currency` specified) of the invoice item. */ - unit_amount?: number | null; + unit_amount?: number | null /** * Format: decimal * @description Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. */ - unit_amount_decimal?: string | null; - }; + unit_amount_decimal?: string | null + } /** InvoicesPaymentMethodOptions */ invoices_payment_method_options: { /** @description 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?: Partial | null; + acss_debit?: Partial | null /** @description If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent. */ - bancontact?: Partial | null; + bancontact?: Partial | null /** @description If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent. */ - card?: Partial | null; - }; + card?: Partial | null + } /** InvoicesPaymentSettings */ invoices_payment_settings: { /** @description Payment-method-specific configuration to provide to the invoice’s PaymentIntent. */ - payment_method_options?: Partial | null; + payment_method_options?: Partial | null /** @description 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?: | ( - | "ach_credit_transfer" - | "ach_debit" - | "acss_debit" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "sepa_debit" - | "sofort" - | "wechat_pay" + | 'ach_credit_transfer' + | 'ach_debit' + | 'acss_debit' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' )[] - | null; - }; + | null + } /** InvoicesResourceInvoiceTaxID */ invoices_resource_invoice_tax_id: { /** @@ -5550,75 +5493,75 @@ export type components = { * @enum {string} */ type: - | "ae_trn" - | "au_abn" - | "au_arn" - | "br_cnpj" - | "br_cpf" - | "ca_bn" - | "ca_gst_hst" - | "ca_pst_bc" - | "ca_pst_mb" - | "ca_pst_sk" - | "ca_qst" - | "ch_vat" - | "cl_tin" - | "es_cif" - | "eu_vat" - | "gb_vat" - | "ge_vat" - | "hk_br" - | "id_npwp" - | "il_vat" - | "in_gst" - | "is_vat" - | "jp_cn" - | "jp_rn" - | "kr_brn" - | "li_uid" - | "mx_rfc" - | "my_frp" - | "my_itn" - | "my_sst" - | "no_vat" - | "nz_gst" - | "ru_inn" - | "ru_kpp" - | "sa_vat" - | "sg_gst" - | "sg_uen" - | "th_vat" - | "tw_vat" - | "ua_vat" - | "unknown" - | "us_ein" - | "za_vat"; + | 'ae_trn' + | 'au_abn' + | 'au_arn' + | 'br_cnpj' + | 'br_cpf' + | 'ca_bn' + | 'ca_gst_hst' + | 'ca_pst_bc' + | 'ca_pst_mb' + | 'ca_pst_sk' + | 'ca_qst' + | 'ch_vat' + | 'cl_tin' + | 'es_cif' + | 'eu_vat' + | 'gb_vat' + | 'ge_vat' + | 'hk_br' + | 'id_npwp' + | 'il_vat' + | 'in_gst' + | 'is_vat' + | 'jp_cn' + | 'jp_rn' + | 'kr_brn' + | 'li_uid' + | 'mx_rfc' + | 'my_frp' + | 'my_itn' + | 'my_sst' + | 'no_vat' + | 'nz_gst' + | 'ru_inn' + | 'ru_kpp' + | 'sa_vat' + | 'sg_gst' + | 'sg_uen' + | 'th_vat' + | 'tw_vat' + | 'ua_vat' + | 'unknown' + | 'us_ein' + | 'za_vat' /** @description The value of the tax ID. */ - value?: string | null; - }; + value?: string | null + } /** InvoicesStatusTransitions */ invoices_status_transitions: { /** * Format: unix-time * @description The time that the invoice draft was finalized. */ - finalized_at?: number | null; + finalized_at?: number | null /** * Format: unix-time * @description The time that the invoice was marked uncollectible. */ - marked_uncollectible_at?: number | null; + marked_uncollectible_at?: number | null /** * Format: unix-time * @description The time that the invoice was paid. */ - paid_at?: number | null; + paid_at?: number | null /** * Format: unix-time * @description The time that the invoice was voided. */ - voided_at?: number | null; - }; + voided_at?: number | null + } /** * IssuerFraudRecord * @description This resource has been renamed to [Early Fraud @@ -5627,30 +5570,30 @@ export type components = { */ issuer_fraud_record: { /** @description An IFR 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 IFR, in order to avoid receiving a dispute later. */ - actionable: boolean; + actionable: boolean /** @description ID of the charge this issuer fraud record is for, optionally expanded. */ - charge: Partial & Partial; + charge: Partial & Partial /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + fraud_type: string /** @description If true, the associated charge is subject to [liability shift](https://stripe.com/docs/payments/3d-secure#disputed-payments). */ - has_liability_shift: boolean; + has_liability_shift: boolean /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "issuer_fraud_record"; + object: 'issuer_fraud_record' /** @description The timestamp at which the card issuer posted the issuer fraud record. */ - post_date: number; - }; + post_date: number + } /** * IssuingAuthorization * @description When an [issued card](https://stripe.com/docs/issuing) is used to make a purchase, an Issuing `Authorization` @@ -5659,260 +5602,260 @@ export type components = { * * Related guide: [Issued Card Authorizations](https://stripe.com/docs/issuing/purchases/authorizations). */ - "issuing.authorization": { + 'issuing.authorization': { /** @description The total amount that was authorized or rejected. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ - amount: number; + amount: number /** @description 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?: Partial | null; + amount_details?: Partial | null /** @description Whether the authorization has been approved. */ - approved: boolean; + approved: boolean /** * @description How the card details were provided. * @enum {string} */ - authorization_method: "chip" | "contactless" | "keyed_in" | "online" | "swipe"; + authorization_method: 'chip' | 'contactless' | 'keyed_in' | 'online' | 'swipe' /** @description List of balance transactions associated with this authorization. */ - balance_transactions: components["schemas"]["balance_transaction"][]; - card: components["schemas"]["issuing.card"]; + balance_transactions: components['schemas']['balance_transaction'][] + card: components['schemas']['issuing.card'] /** @description The cardholder to whom this authorization belongs. */ - cardholder?: (Partial & Partial) | null; + cardholder?: (Partial & Partial) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: number; + merchant_amount: number /** @description The currency that was 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: string; - merchant_data: components["schemas"]["issuing_authorization_merchant_data"]; + merchant_currency: string + merchant_data: components['schemas']['issuing_authorization_merchant_data'] /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "issuing.authorization"; + object: 'issuing.authorization' /** @description The pending authorization request. This field will only be non-null during an `issuing_authorization.request` webhook. */ - pending_request?: Partial | null; + pending_request?: Partial | null /** @description History of every time `pending_request` was approved/denied, 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](https://stripe.com/docs/issuing/purchases/authorizations), you can look at this field to see the previous requests for the authorization. */ - request_history: components["schemas"]["issuing_authorization_request"][]; + request_history: components['schemas']['issuing_authorization_request'][] /** * @description The current status of the authorization in its lifecycle. * @enum {string} */ - status: "closed" | "pending" | "reversed"; + status: 'closed' | 'pending' | 'reversed' /** @description List of [transactions](https://stripe.com/docs/api/issuing/transactions) associated with this authorization. */ - transactions: components["schemas"]["issuing.transaction"][]; - verification_data: components["schemas"]["issuing_authorization_verification_data"]; + transactions: components['schemas']['issuing.transaction'][] + verification_data: components['schemas']['issuing_authorization_verification_data'] /** @description The digital wallet used for this authorization. One of `apple_pay`, `google_pay`, or `samsung_pay`. */ - wallet?: string | null; - }; + wallet?: string | null + } /** * IssuingCard * @description You can [create physical or virtual cards](https://stripe.com/docs/issuing/cards) that are issued to cardholders. */ - "issuing.card": { + 'issuing.card': { /** @description The brand of the card. */ - brand: string; + brand: string /** * @description The reason why the card was canceled. * @enum {string|null} */ - cancellation_reason?: ("lost" | "stolen") | null; - cardholder: components["schemas"]["issuing.cardholder"]; + cancellation_reason?: ('lost' | 'stolen') | null + cardholder: components['schemas']['issuing.cardholder'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description 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?: string; + cvc?: string /** @description The expiration month of the card. */ - exp_month: number; + exp_month: number /** @description The expiration year of the card. */ - exp_year: number; + exp_year: number /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The last 4 digits of the card number. */ - last4: string; + last4: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** @description 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?: string; + number?: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "issuing.card"; + object: 'issuing.card' /** @description The latest card that replaces this card, if any. */ - replaced_by?: (Partial & Partial) | null; + replaced_by?: (Partial & Partial) | null /** @description The card this card replaces, if any. */ - replacement_for?: (Partial & Partial) | null; + replacement_for?: (Partial & Partial) | null /** * @description The reason why the previous card needed to be replaced. * @enum {string|null} */ - replacement_reason?: ("damaged" | "expired" | "lost" | "stolen") | null; + replacement_reason?: ('damaged' | 'expired' | 'lost' | 'stolen') | null /** @description Where and how the card will be shipped. */ - shipping?: Partial | null; - spending_controls: components["schemas"]["issuing_card_authorization_controls"]; + shipping?: Partial | null + spending_controls: components['schemas']['issuing_card_authorization_controls'] /** * @description Whether authorizations can be approved on this card. * @enum {string} */ - status: "active" | "canceled" | "inactive"; + status: 'active' | 'canceled' | 'inactive' /** * @description The type of the card. * @enum {string} */ - type: "physical" | "virtual"; + type: 'physical' | 'virtual' /** @description Information relating to digital wallets (like Apple Pay and Google Pay). */ - wallets?: Partial | null; - }; + wallets?: Partial | null + } /** * IssuingCardholder * @description An Issuing `Cardholder` object represents an individual or business entity who is [issued](https://stripe.com/docs/issuing) cards. * * Related guide: [How to create a Cardholder](https://stripe.com/docs/issuing/cards#create-cardholder) */ - "issuing.cardholder": { - billing: components["schemas"]["issuing_cardholder_address"]; + 'issuing.cardholder': { + billing: components['schemas']['issuing_cardholder_address'] /** @description Additional information about a `company` cardholder. */ - company?: Partial | null; + company?: Partial | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The cardholder's email address. */ - email?: string | null; + email?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Additional information about an `individual` cardholder. */ - individual?: Partial | null; + individual?: Partial | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** @description The cardholder's name. This will be printed on cards issued to them. */ - name: string; + name: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "issuing.cardholder"; + object: 'issuing.cardholder' /** @description 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?: string | null; - requirements: components["schemas"]["issuing_cardholder_requirements"]; + phone_number?: string | null + requirements: components['schemas']['issuing_cardholder_requirements'] /** @description 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?: Partial | null; + spending_controls?: Partial | null /** * @description Specifies whether to permit authorizations on this cardholder's cards. * @enum {string} */ - status: "active" | "blocked" | "inactive"; + status: 'active' | 'blocked' | 'inactive' /** * @description One of `individual` or `company`. * @enum {string} */ - type: "company" | "individual"; - }; + type: 'company' | 'individual' + } /** * IssuingDispute * @description 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. * * Related guide: [Disputing Transactions](https://stripe.com/docs/issuing/purchases/disputes) */ - "issuing.dispute": { + 'issuing.dispute': { /** @description Disputed amount. Usually the amount of the `transaction`, but can differ (usually because of currency fluctuation). */ - amount: number; + amount: number /** @description List of balance transactions associated with the dispute. */ - balance_transactions?: components["schemas"]["balance_transaction"][] | null; + balance_transactions?: components['schemas']['balance_transaction'][] | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The currency the `transaction` was made in. */ - currency: string; - evidence: components["schemas"]["issuing_dispute_evidence"]; + currency: string + evidence: components['schemas']['issuing_dispute_evidence'] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "issuing.dispute"; + object: 'issuing.dispute' /** * @description Current status of the dispute. * @enum {string} */ - status: "expired" | "lost" | "submitted" | "unsubmitted" | "won"; + status: 'expired' | 'lost' | 'submitted' | 'unsubmitted' | 'won' /** @description The transaction being disputed. */ - transaction: Partial & Partial; - }; + transaction: Partial & Partial + } /** * IssuingSettlement * @description 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. */ - "issuing.settlement": { + 'issuing.settlement': { /** @description The Bank Identification Number reflecting this settlement record. */ - bin: string; + bin: string /** @description The date that the transactions are cleared and posted to user's accounts. */ - clearing_date: number; + clearing_date: number /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The total interchange received as reimbursement for the transactions. */ - interchange_fees: number; + interchange_fees: number /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** @description The total net amount required to settle with the network. */ - net_total: number; + net_total: number /** * @description The card network for this settlement report. One of ["visa"] * @enum {string} */ - network: "visa"; + network: 'visa' /** @description The total amount of fees owed to the network. */ - network_fees: number; + network_fees: number /** @description The Settlement Identification Number assigned by the network. */ - network_settlement_identifier: string; + network_settlement_identifier: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "issuing.settlement"; + object: 'issuing.settlement' /** @description One of `international` or `uk_national_net`. */ - settlement_service: string; + settlement_service: string /** @description The total number of transactions reflected in this settlement. */ - transaction_count: number; + transaction_count: number /** @description The total transaction amount reflected in this settlement. */ - transaction_volume: number; - }; + transaction_volume: number + } /** * IssuingTransaction * @description Any use of an [issued card](https://stripe.com/docs/issuing) that results in funds entering or leaving @@ -5921,2669 +5864,2662 @@ export type components = { * * Related guide: [Issued Card Transactions](https://stripe.com/docs/issuing/purchases/transactions). */ - "issuing.transaction": { + 'issuing.transaction': { /** @description 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: number; + amount: number /** @description 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?: Partial | null; + amount_details?: Partial | null /** @description The `Authorization` object that led to this transaction. */ - authorization?: (Partial & Partial) | null; + authorization?: (Partial & Partial) | null /** @description ID of the [balance transaction](https://stripe.com/docs/api/balance_transactions) associated with this transaction. */ - balance_transaction?: (Partial & Partial) | null; + balance_transaction?: (Partial & Partial) | null /** @description The card used to make this transaction. */ - card: Partial & Partial; + card: Partial & Partial /** @description The cardholder to whom this transaction belongs. */ - cardholder?: (Partial & Partial) | null; + cardholder?: (Partial & Partial) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description If you've disputed the transaction, the ID of the dispute. */ - dispute?: (Partial & Partial) | null; + dispute?: (Partial & Partial) | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: number; + merchant_amount: number /** @description The currency with which the merchant is taking payment. */ - merchant_currency: string; - merchant_data: components["schemas"]["issuing_authorization_merchant_data"]; + merchant_currency: string + merchant_data: components['schemas']['issuing_authorization_merchant_data'] /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "issuing.transaction"; + object: 'issuing.transaction' /** @description Additional purchase information that is optionally provided by the merchant. */ - purchase_details?: Partial | null; + purchase_details?: Partial | null /** * @description The nature of the transaction. * @enum {string} */ - type: "capture" | "refund"; + type: 'capture' | 'refund' /** * @description The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. * @enum {string|null} */ - wallet?: ("apple_pay" | "google_pay" | "samsung_pay") | null; - }; + wallet?: ('apple_pay' | 'google_pay' | 'samsung_pay') | null + } /** IssuingAuthorizationAmountDetails */ issuing_authorization_amount_details: { /** @description The fee charged by the ATM for the cash withdrawal. */ - atm_fee?: number | null; - }; + atm_fee?: number | null + } /** IssuingAuthorizationMerchantData */ issuing_authorization_merchant_data: { /** @description 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: string; + category: string /** @description The merchant category code for the seller’s business */ - category_code: string; + category_code: string /** @description City where the seller is located */ - city?: string | null; + city?: string | null /** @description Country where the seller is located */ - country?: string | null; + country?: string | null /** @description Name of the seller */ - name?: string | null; + name?: string | null /** @description Identifier assigned to the seller by the card brand */ - network_id: string; + network_id: string /** @description Postal code where the seller is located */ - postal_code?: string | null; + postal_code?: string | null /** @description State where the seller is located */ - state?: string | null; - }; + state?: string | null + } /** IssuingAuthorizationPendingRequest */ issuing_authorization_pending_request: { /** @description 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: number; + amount: number /** @description 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?: Partial | null; + amount_details?: Partial | null /** @description 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: string; + currency: string /** @description 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: boolean; + is_amount_controllable: boolean /** @description 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: number; + merchant_amount: number /** @description The local currency the merchant is requesting to authorize. */ - merchant_currency: string; - }; + merchant_currency: string + } /** IssuingAuthorizationRequest */ issuing_authorization_request: { /** @description 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: number; + amount: number /** @description 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?: Partial | null; + amount_details?: Partial | null /** @description Whether this request was approved. */ - approved: boolean; + approved: boolean /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description 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: number; + merchant_amount: number /** @description 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: string; + merchant_currency: string /** * @description The reason for the approval or decline. * @enum {string} */ reason: - | "account_disabled" - | "card_active" - | "card_inactive" - | "cardholder_inactive" - | "cardholder_verification_required" - | "insufficient_funds" - | "not_allowed" - | "spending_controls" - | "suspected_fraud" - | "verification_failed" - | "webhook_approved" - | "webhook_declined" - | "webhook_timeout"; - }; + | 'account_disabled' + | 'card_active' + | 'card_inactive' + | 'cardholder_inactive' + | 'cardholder_verification_required' + | 'insufficient_funds' + | 'not_allowed' + | 'spending_controls' + | 'suspected_fraud' + | 'verification_failed' + | 'webhook_approved' + | 'webhook_declined' + | 'webhook_timeout' + } /** IssuingAuthorizationVerificationData */ issuing_authorization_verification_data: { /** * @description Whether the cardholder provided an address first line and if it matched the cardholder’s `billing.address.line1`. * @enum {string} */ - address_line1_check: "match" | "mismatch" | "not_provided"; + address_line1_check: 'match' | 'mismatch' | 'not_provided' /** * @description Whether the cardholder provided a postal code and if it matched the cardholder’s `billing.address.postal_code`. * @enum {string} */ - address_postal_code_check: "match" | "mismatch" | "not_provided"; + address_postal_code_check: 'match' | 'mismatch' | 'not_provided' /** * @description Whether the cardholder provided a CVC and if it matched Stripe’s record. * @enum {string} */ - cvc_check: "match" | "mismatch" | "not_provided"; + cvc_check: 'match' | 'mismatch' | 'not_provided' /** * @description Whether the cardholder provided an expiry date and if it matched Stripe’s record. * @enum {string} */ - expiry_check: "match" | "mismatch" | "not_provided"; - }; + expiry_check: 'match' | 'mismatch' | 'not_provided' + } /** IssuingCardApplePay */ issuing_card_apple_pay: { /** @description Apple Pay Eligibility */ - eligible: boolean; + eligible: boolean /** * @description Reason the card is ineligible for Apple Pay * @enum {string|null} */ - ineligible_reason?: ("missing_agreement" | "missing_cardholder_contact" | "unsupported_region") | null; - }; + ineligible_reason?: ('missing_agreement' | 'missing_cardholder_contact' | 'unsupported_region') | null + } /** IssuingCardAuthorizationControls */ issuing_card_authorization_controls: { /** @description 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?: | ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' )[] - | null; + | null /** @description 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?: | ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' )[] - | null; + | null /** @description 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?: components["schemas"]["issuing_card_spending_limit"][] | null; + spending_limits?: components['schemas']['issuing_card_spending_limit'][] | null /** @description Currency of the amounts within `spending_limits`. Always the same as the currency of the card. */ - spending_limits_currency?: string | null; - }; + spending_limits_currency?: string | null + } /** IssuingCardGooglePay */ issuing_card_google_pay: { /** @description Google Pay Eligibility */ - eligible: boolean; + eligible: boolean /** * @description Reason the card is ineligible for Google Pay * @enum {string|null} */ - ineligible_reason?: ("missing_agreement" | "missing_cardholder_contact" | "unsupported_region") | null; - }; + ineligible_reason?: ('missing_agreement' | 'missing_cardholder_contact' | 'unsupported_region') | null + } /** IssuingCardShipping */ issuing_card_shipping: { - address: components["schemas"]["address"]; + address: components['schemas']['address'] /** * @description The delivery company that shipped a card. * @enum {string|null} */ - carrier?: ("dhl" | "fedex" | "royal_mail" | "usps") | null; + carrier?: ('dhl' | 'fedex' | 'royal_mail' | 'usps') | null /** * Format: unix-time * @description A unix timestamp representing a best estimate of when the card will be delivered. */ - eta?: number | null; + eta?: number | null /** @description Recipient name. */ - name: string; + name: string /** * @description Shipment service, such as `standard` or `express`. * @enum {string} */ - service: "express" | "priority" | "standard"; + service: 'express' | 'priority' | 'standard' /** * @description The delivery status of the card. * @enum {string|null} */ - status?: ("canceled" | "delivered" | "failure" | "pending" | "returned" | "shipped") | null; + status?: ('canceled' | 'delivered' | 'failure' | 'pending' | 'returned' | 'shipped') | null /** @description A tracking number for a card shipment. */ - tracking_number?: string | null; + tracking_number?: string | null /** @description A link to the shipping carrier's site where you can view detailed information about a card shipment. */ - tracking_url?: string | null; + tracking_url?: string | null /** * @description Packaging options. * @enum {string} */ - type: "bulk" | "individual"; - }; + type: 'bulk' | 'individual' + } /** IssuingCardSpendingLimit */ issuing_card_spending_limit: { /** @description Maximum amount allowed to spend per interval. */ - amount: number; + amount: number /** @description 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?: | ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' )[] - | null; + | null /** * @description Interval (or event) to which the amount applies. * @enum {string} */ - interval: "all_time" | "daily" | "monthly" | "per_authorization" | "weekly" | "yearly"; - }; + interval: 'all_time' | 'daily' | 'monthly' | 'per_authorization' | 'weekly' | 'yearly' + } /** IssuingCardWallets */ issuing_card_wallets: { - apple_pay: components["schemas"]["issuing_card_apple_pay"]; - google_pay: components["schemas"]["issuing_card_google_pay"]; + apple_pay: components['schemas']['issuing_card_apple_pay'] + google_pay: components['schemas']['issuing_card_google_pay'] /** @description Unique identifier for a card used with digital wallets */ - primary_account_identifier?: string | null; - }; + primary_account_identifier?: string | null + } /** IssuingCardholderAddress */ issuing_cardholder_address: { - address: components["schemas"]["address"]; - }; + address: components['schemas']['address'] + } /** IssuingCardholderAuthorizationControls */ issuing_cardholder_authorization_controls: { /** @description 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?: | ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' )[] - | null; + | null /** @description 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?: | ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' )[] - | null; + | null /** @description Limit spending with amount-based rules that apply across this cardholder's cards. */ - spending_limits?: components["schemas"]["issuing_cardholder_spending_limit"][] | null; + spending_limits?: components['schemas']['issuing_cardholder_spending_limit'][] | null /** @description Currency of the amounts within `spending_limits`. */ - spending_limits_currency?: string | null; - }; + spending_limits_currency?: string | null + } /** IssuingCardholderCompany */ issuing_cardholder_company: { /** @description Whether the company's business ID number was provided. */ - tax_id_provided: boolean; - }; + tax_id_provided: boolean + } /** IssuingCardholderIdDocument */ issuing_cardholder_id_document: { /** @description 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?: (Partial & Partial) | null; + back?: (Partial & Partial) | null /** @description 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?: (Partial & Partial) | null; - }; + front?: (Partial & Partial) | null + } /** IssuingCardholderIndividual */ issuing_cardholder_individual: { /** @description The date of birth of this cardholder. */ - dob?: Partial | null; + dob?: Partial | null /** @description The first name of this cardholder. */ - first_name: string; + first_name: string /** @description The last name of this cardholder. */ - last_name: string; + last_name: string /** @description Government-issued ID document for this cardholder. */ - verification?: Partial | null; - }; + verification?: Partial | null + } /** IssuingCardholderIndividualDOB */ issuing_cardholder_individual_dob: { /** @description The day of birth, between 1 and 31. */ - day?: number | null; + day?: number | null /** @description The month of birth, between 1 and 12. */ - month?: number | null; + month?: number | null /** @description The four-digit year of birth. */ - year?: number | null; - }; + year?: number | null + } /** IssuingCardholderRequirements */ issuing_cardholder_requirements: { /** * @description If `disabled_reason` is present, all cards will decline authorizations with `cardholder_verification_required` reason. * @enum {string|null} */ - disabled_reason?: ("listed" | "rejected.listed" | "under_review") | null; + disabled_reason?: ('listed' | 'rejected.listed' | 'under_review') | null /** @description Array of fields that need to be collected in order to verify and re-enable the cardholder. */ past_due?: | ( - | "company.tax_id" - | "individual.dob.day" - | "individual.dob.month" - | "individual.dob.year" - | "individual.first_name" - | "individual.last_name" - | "individual.verification.document" + | 'company.tax_id' + | 'individual.dob.day' + | 'individual.dob.month' + | 'individual.dob.year' + | 'individual.first_name' + | 'individual.last_name' + | 'individual.verification.document' )[] - | null; - }; + | null + } /** IssuingCardholderSpendingLimit */ issuing_cardholder_spending_limit: { /** @description Maximum amount allowed to spend per interval. */ - amount: number; + amount: number /** @description 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?: | ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' )[] - | null; + | null /** * @description Interval (or event) to which the amount applies. * @enum {string} */ - interval: "all_time" | "daily" | "monthly" | "per_authorization" | "weekly" | "yearly"; - }; + interval: 'all_time' | 'daily' | 'monthly' | 'per_authorization' | 'weekly' | 'yearly' + } /** IssuingCardholderVerification */ issuing_cardholder_verification: { /** @description An identifying document, either a passport or local ID card. */ - document?: Partial | null; - }; + document?: Partial | null + } /** IssuingDisputeCanceledEvidence */ issuing_dispute_canceled_evidence: { /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ - additional_documentation?: (Partial & Partial) | null; + additional_documentation?: (Partial & Partial) | null /** * Format: unix-time * @description Date when order was canceled. */ - canceled_at?: number | null; + canceled_at?: number | null /** @description Whether the cardholder was provided with a cancellation policy. */ - cancellation_policy_provided?: boolean | null; + cancellation_policy_provided?: boolean | null /** @description Reason for canceling the order. */ - cancellation_reason?: string | null; + cancellation_reason?: string | null /** * Format: unix-time * @description Date when the cardholder expected to receive the product. */ - expected_at?: number | null; + expected_at?: number | null /** @description Explanation of why the cardholder is disputing this transaction. */ - explanation?: string | null; + explanation?: string | null /** @description Description of the merchandise or service that was purchased. */ - product_description?: string | null; + product_description?: string | null /** * @description Whether the product was a merchandise or service. * @enum {string|null} */ - product_type?: ("merchandise" | "service") | null; + product_type?: ('merchandise' | 'service') | null /** * @description Result of cardholder's attempt to return the product. * @enum {string|null} */ - return_status?: ("merchant_rejected" | "successful") | null; + return_status?: ('merchant_rejected' | 'successful') | null /** * Format: unix-time * @description Date when the product was returned or attempted to be returned. */ - returned_at?: number | null; - }; + returned_at?: number | null + } /** IssuingDisputeDuplicateEvidence */ issuing_dispute_duplicate_evidence: { /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ - additional_documentation?: (Partial & Partial) | null; + additional_documentation?: (Partial & Partial) | null /** @description (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?: (Partial & Partial) | null; + card_statement?: (Partial & Partial) | null /** @description (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?: (Partial & Partial) | null; + cash_receipt?: (Partial & Partial) | null /** @description (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?: (Partial & Partial) | null; + check_image?: (Partial & Partial) | null /** @description Explanation of why the cardholder is disputing this transaction. */ - explanation?: string | null; + explanation?: string | null /** @description 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?: string | null; - }; + original_transaction?: string | null + } /** IssuingDisputeEvidence */ issuing_dispute_evidence: { - canceled?: components["schemas"]["issuing_dispute_canceled_evidence"]; - duplicate?: components["schemas"]["issuing_dispute_duplicate_evidence"]; - fraudulent?: components["schemas"]["issuing_dispute_fraudulent_evidence"]; - merchandise_not_as_described?: components["schemas"]["issuing_dispute_merchandise_not_as_described_evidence"]; - not_received?: components["schemas"]["issuing_dispute_not_received_evidence"]; - other?: components["schemas"]["issuing_dispute_other_evidence"]; + canceled?: components['schemas']['issuing_dispute_canceled_evidence'] + duplicate?: components['schemas']['issuing_dispute_duplicate_evidence'] + fraudulent?: components['schemas']['issuing_dispute_fraudulent_evidence'] + merchandise_not_as_described?: components['schemas']['issuing_dispute_merchandise_not_as_described_evidence'] + not_received?: components['schemas']['issuing_dispute_not_received_evidence'] + other?: components['schemas']['issuing_dispute_other_evidence'] /** * @description The reason for filing the dispute. Its value will match the field containing the evidence. * @enum {string} */ - reason: - | "canceled" - | "duplicate" - | "fraudulent" - | "merchandise_not_as_described" - | "not_received" - | "other" - | "service_not_as_described"; - service_not_as_described?: components["schemas"]["issuing_dispute_service_not_as_described_evidence"]; - }; + reason: 'canceled' | 'duplicate' | 'fraudulent' | 'merchandise_not_as_described' | 'not_received' | 'other' | 'service_not_as_described' + service_not_as_described?: components['schemas']['issuing_dispute_service_not_as_described_evidence'] + } /** IssuingDisputeFraudulentEvidence */ issuing_dispute_fraudulent_evidence: { /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ - additional_documentation?: (Partial & Partial) | null; + additional_documentation?: (Partial & Partial) | null /** @description Explanation of why the cardholder is disputing this transaction. */ - explanation?: string | null; - }; + explanation?: string | null + } /** IssuingDisputeMerchandiseNotAsDescribedEvidence */ issuing_dispute_merchandise_not_as_described_evidence: { /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ - additional_documentation?: (Partial & Partial) | null; + additional_documentation?: (Partial & Partial) | null /** @description Explanation of why the cardholder is disputing this transaction. */ - explanation?: string | null; + explanation?: string | null /** * Format: unix-time * @description Date when the product was received. */ - received_at?: number | null; + received_at?: number | null /** @description Description of the cardholder's attempt to return the product. */ - return_description?: string | null; + return_description?: string | null /** * @description Result of cardholder's attempt to return the product. * @enum {string|null} */ - return_status?: ("merchant_rejected" | "successful") | null; + return_status?: ('merchant_rejected' | 'successful') | null /** * Format: unix-time * @description Date when the product was returned or attempted to be returned. */ - returned_at?: number | null; - }; + returned_at?: number | null + } /** IssuingDisputeNotReceivedEvidence */ issuing_dispute_not_received_evidence: { /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ - additional_documentation?: (Partial & Partial) | null; + additional_documentation?: (Partial & Partial) | null /** * Format: unix-time * @description Date when the cardholder expected to receive the product. */ - expected_at?: number | null; + expected_at?: number | null /** @description Explanation of why the cardholder is disputing this transaction. */ - explanation?: string | null; + explanation?: string | null /** @description Description of the merchandise or service that was purchased. */ - product_description?: string | null; + product_description?: string | null /** * @description Whether the product was a merchandise or service. * @enum {string|null} */ - product_type?: ("merchandise" | "service") | null; - }; + product_type?: ('merchandise' | 'service') | null + } /** IssuingDisputeOtherEvidence */ issuing_dispute_other_evidence: { /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ - additional_documentation?: (Partial & Partial) | null; + additional_documentation?: (Partial & Partial) | null /** @description Explanation of why the cardholder is disputing this transaction. */ - explanation?: string | null; + explanation?: string | null /** @description Description of the merchandise or service that was purchased. */ - product_description?: string | null; + product_description?: string | null /** * @description Whether the product was a merchandise or service. * @enum {string|null} */ - product_type?: ("merchandise" | "service") | null; - }; + product_type?: ('merchandise' | 'service') | null + } /** IssuingDisputeServiceNotAsDescribedEvidence */ issuing_dispute_service_not_as_described_evidence: { /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ - additional_documentation?: (Partial & Partial) | null; + additional_documentation?: (Partial & Partial) | null /** * Format: unix-time * @description Date when order was canceled. */ - canceled_at?: number | null; + canceled_at?: number | null /** @description Reason for canceling the order. */ - cancellation_reason?: string | null; + cancellation_reason?: string | null /** @description Explanation of why the cardholder is disputing this transaction. */ - explanation?: string | null; + explanation?: string | null /** * Format: unix-time * @description Date when the product was received. */ - received_at?: number | null; - }; + received_at?: number | null + } /** IssuingTransactionAmountDetails */ issuing_transaction_amount_details: { /** @description The fee charged by the ATM for the cash withdrawal. */ - atm_fee?: number | null; - }; + atm_fee?: number | null + } /** IssuingTransactionFlightData */ issuing_transaction_flight_data: { /** @description The time that the flight departed. */ - departure_at?: number | null; + departure_at?: number | null /** @description The name of the passenger. */ - passenger_name?: string | null; + passenger_name?: string | null /** @description Whether the ticket is refundable. */ - refundable?: boolean | null; + refundable?: boolean | null /** @description The legs of the trip. */ - segments?: components["schemas"]["issuing_transaction_flight_data_leg"][] | null; + segments?: components['schemas']['issuing_transaction_flight_data_leg'][] | null /** @description The travel agency that issued the ticket. */ - travel_agency?: string | null; - }; + travel_agency?: string | null + } /** IssuingTransactionFlightDataLeg */ issuing_transaction_flight_data_leg: { /** @description The three-letter IATA airport code of the flight's destination. */ - arrival_airport_code?: string | null; + arrival_airport_code?: string | null /** @description The airline carrier code. */ - carrier?: string | null; + carrier?: string | null /** @description The three-letter IATA airport code that the flight departed from. */ - departure_airport_code?: string | null; + departure_airport_code?: string | null /** @description The flight number. */ - flight_number?: string | null; + flight_number?: string | null /** @description The flight's service class. */ - service_class?: string | null; + service_class?: string | null /** @description Whether a stopover is allowed on this flight. */ - stopover_allowed?: boolean | null; - }; + stopover_allowed?: boolean | null + } /** IssuingTransactionFuelData */ issuing_transaction_fuel_data: { /** @description The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`. */ - type: string; + type: string /** @description The units for `volume_decimal`. One of `us_gallon` or `liter`. */ - unit: string; + unit: string /** * Format: decimal * @description The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places. */ - unit_cost_decimal: string; + unit_cost_decimal: string /** * Format: decimal * @description The volume of the fuel that was pumped, represented as a decimal string with at most 12 decimal places. */ - volume_decimal?: string | null; - }; + volume_decimal?: string | null + } /** IssuingTransactionLodgingData */ issuing_transaction_lodging_data: { /** @description The time of checking into the lodging. */ - check_in_at?: number | null; + check_in_at?: number | null /** @description The number of nights stayed at the lodging. */ - nights?: number | null; - }; + nights?: number | null + } /** IssuingTransactionPurchaseDetails */ issuing_transaction_purchase_details: { /** @description Information about the flight that was purchased with this transaction. */ - flight?: Partial | null; + flight?: Partial | null /** @description Information about fuel that was purchased with this transaction. */ - fuel?: Partial | null; + fuel?: Partial | null /** @description Information about lodging that was purchased with this transaction. */ - lodging?: Partial | null; + lodging?: Partial | null /** @description The line items in the purchase. */ - receipt?: components["schemas"]["issuing_transaction_receipt_data"][] | null; + receipt?: components['schemas']['issuing_transaction_receipt_data'][] | null /** @description A merchant-specific order number. */ - reference?: string | null; - }; + reference?: string | null + } /** IssuingTransactionReceiptData */ issuing_transaction_receipt_data: { /** @description The description of the item. The maximum length of this field is 26 characters. */ - description?: string | null; + description?: string | null /** @description The quantity of the item. */ - quantity?: number | null; + quantity?: number | null /** @description The total for this line item in cents. */ - total?: number | null; + total?: number | null /** @description The unit cost of the item in cents. */ - unit_cost?: number | null; - }; + unit_cost?: number | null + } /** * LineItem * @description A line item. */ item: { /** @description Total before any discounts or taxes are applied. */ - amount_subtotal: number; + amount_subtotal: number /** @description Total after discounts and taxes. */ - amount_total: number; + amount_total: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name. */ - description: string; + description: string /** @description The discounts applied to the line item. */ - discounts?: components["schemas"]["line_items_discount_amount"][]; + discounts?: components['schemas']['line_items_discount_amount'][] /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "item"; + object: 'item' /** @description The price used to generate the line item. */ - price?: Partial | null; + price?: Partial | null /** @description The quantity of products being purchased. */ - quantity?: number | null; + quantity?: number | null /** @description The taxes applied to the line item. */ - taxes?: components["schemas"]["line_items_tax_amount"][]; - }; + taxes?: components['schemas']['line_items_tax_amount'][] + } /** LegalEntityCompany */ legal_entity_company: { - address?: components["schemas"]["address"]; + address?: components['schemas']['address'] /** @description The Kana variation of the company's primary address (Japan only). */ - address_kana?: Partial | null; + address_kana?: Partial | null /** @description The Kanji variation of the company's primary address (Japan only). */ - address_kanji?: Partial | null; + address_kanji?: Partial | null /** @description 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?: boolean; + directors_provided?: boolean /** @description 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?: boolean; + executives_provided?: boolean /** @description The company's legal name. */ - name?: string | null; + name?: string | null /** @description The Kana variation of the company's legal name (Japan only). */ - name_kana?: string | null; + name_kana?: string | null /** @description The Kanji variation of the company's legal name (Japan only). */ - name_kanji?: string | null; + name_kanji?: string | null /** @description 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?: boolean; + owners_provided?: boolean /** @description This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct. */ - ownership_declaration?: Partial | null; + ownership_declaration?: Partial | null /** @description The company's phone number (used for verification). */ - phone?: string | null; + phone?: string | null /** * @description 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. * @enum {string} */ structure?: - | "free_zone_establishment" - | "free_zone_llc" - | "government_instrumentality" - | "governmental_unit" - | "incorporated_non_profit" - | "limited_liability_partnership" - | "llc" - | "multi_member_llc" - | "private_company" - | "private_corporation" - | "private_partnership" - | "public_company" - | "public_corporation" - | "public_partnership" - | "single_member_llc" - | "sole_establishment" - | "sole_proprietorship" - | "tax_exempt_government_instrumentality" - | "unincorporated_association" - | "unincorporated_non_profit"; + | 'free_zone_establishment' + | 'free_zone_llc' + | 'government_instrumentality' + | 'governmental_unit' + | 'incorporated_non_profit' + | 'limited_liability_partnership' + | 'llc' + | 'multi_member_llc' + | 'private_company' + | 'private_corporation' + | 'private_partnership' + | 'public_company' + | 'public_corporation' + | 'public_partnership' + | 'single_member_llc' + | 'sole_establishment' + | 'sole_proprietorship' + | 'tax_exempt_government_instrumentality' + | 'unincorporated_association' + | 'unincorporated_non_profit' /** @description Whether the company's business ID number was provided. */ - tax_id_provided?: boolean; + tax_id_provided?: boolean /** @description The jurisdiction in which the `tax_id` is registered (Germany-based companies only). */ - tax_id_registrar?: string; + tax_id_registrar?: string /** @description Whether the company's business VAT number was provided. */ - vat_id_provided?: boolean; + vat_id_provided?: boolean /** @description Information on the verification state of the company. */ - verification?: Partial | null; - }; + verification?: Partial | null + } /** LegalEntityCompanyVerification */ legal_entity_company_verification: { - document: components["schemas"]["legal_entity_company_verification_document"]; - }; + document: components['schemas']['legal_entity_company_verification_document'] + } /** LegalEntityCompanyVerificationDocument */ legal_entity_company_verification_document: { /** @description 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?: (Partial & Partial) | null; + back?: (Partial & Partial) | null /** @description A user-displayable string describing the verification state of this document. */ - details?: string | null; + details?: string | null /** @description 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?: string | null; + details_code?: string | null /** @description 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?: (Partial & Partial) | null; - }; + front?: (Partial & Partial) | null + } /** LegalEntityDOB */ legal_entity_dob: { /** @description The day of birth, between 1 and 31. */ - day?: number | null; + day?: number | null /** @description The month of birth, between 1 and 12. */ - month?: number | null; + month?: number | null /** @description The four-digit year of birth. */ - year?: number | null; - }; + year?: number | null + } /** LegalEntityJapanAddress */ legal_entity_japan_address: { /** @description City/Ward. */ - city?: string | null; + city?: string | null /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ - country?: string | null; + country?: string | null /** @description Block/Building number. */ - line1?: string | null; + line1?: string | null /** @description Building details. */ - line2?: string | null; + line2?: string | null /** @description ZIP or postal code. */ - postal_code?: string | null; + postal_code?: string | null /** @description Prefecture. */ - state?: string | null; + state?: string | null /** @description Town/cho-me. */ - town?: string | null; - }; + town?: string | null + } /** LegalEntityPersonVerification */ legal_entity_person_verification: { /** @description A document showing address, either a passport, local ID card, or utility bill from a well-known utility company. */ - additional_document?: Partial | null; + additional_document?: Partial | null /** @description A user-displayable string describing the verification state for the person. For example, this may say "Provided identity information could not be verified". */ - details?: string | null; + details?: string | null /** @description 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?: string | null; - document?: components["schemas"]["legal_entity_person_verification_document"]; + details_code?: string | null + document?: components['schemas']['legal_entity_person_verification_document'] /** @description The state of verification for the person. Possible values are `unverified`, `pending`, or `verified`. */ - status: string; - }; + status: string + } /** LegalEntityPersonVerificationDocument */ legal_entity_person_verification_document: { /** @description 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?: (Partial & Partial) | null; + back?: (Partial & Partial) | null /** @description 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?: string | null; + details?: string | null /** @description 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?: string | null; + details_code?: string | null /** @description 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?: (Partial & Partial) | null; - }; + front?: (Partial & Partial) | null + } /** LegalEntityUBODeclaration */ legal_entity_ubo_declaration: { /** * Format: unix-time * @description The Unix timestamp marking when the beneficial owner attestation was made. */ - date?: number | null; + date?: number | null /** @description The IP address from which the beneficial owner attestation was made. */ - ip?: string | null; + ip?: string | null /** @description The user-agent string from the browser where the beneficial owner attestation was made. */ - user_agent?: string | null; - }; + user_agent?: string | null + } /** InvoiceLineItem */ line_item: { /** @description The amount, in %s. */ - amount: number; + amount: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description The amount of discount calculated per discount for this line item. */ - discount_amounts?: components["schemas"]["discounts_resource_discount_amount"][] | null; + discount_amounts?: components['schemas']['discounts_resource_discount_amount'][] | null /** @description If true, discounts will apply to this line item. Always false for prorations. */ - discountable: boolean; + discountable: boolean /** @description The discounts applied to the invoice line item. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount. */ - discounts?: (Partial & Partial)[] | null; + discounts?: (Partial & Partial)[] | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The ID of the [invoice item](https://stripe.com/docs/api/invoiceitems) associated with this line item if any. */ - invoice_item?: string; + invoice_item?: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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` this will reflect the metadata of the subscription that caused the line item to be created. */ - metadata: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "line_item"; - period: components["schemas"]["invoice_line_item_period"]; + object: 'line_item' + period: components['schemas']['invoice_line_item_period'] /** @description The price of the line item. */ - price?: Partial | null; + price?: Partial | null /** @description Whether this is a proration. */ - proration: boolean; + proration: boolean /** @description The quantity of the subscription, if the line item is a subscription or a proration. */ - quantity?: number | null; + quantity?: number | null /** @description The subscription that the invoice item pertains to, if any. */ - subscription?: string | null; + subscription?: string | null /** @description The subscription item that generated this invoice item. Left empty if the line item is not an explicit result of a subscription. */ - subscription_item?: string; + subscription_item?: string /** @description The amount of tax calculated per tax rate for this line item */ - tax_amounts?: components["schemas"]["invoice_tax_amount"][]; + tax_amounts?: components['schemas']['invoice_tax_amount'][] /** @description The tax rates which apply to the line item. */ - tax_rates?: components["schemas"]["tax_rate"][]; + tax_rates?: components['schemas']['tax_rate'][] /** * @description A string identifying the type of the source of this line item, either an `invoiceitem` or a `subscription`. * @enum {string} */ - type: "invoiceitem" | "subscription"; - }; + type: 'invoiceitem' | 'subscription' + } /** LineItemsDiscountAmount */ line_items_discount_amount: { /** @description The amount discounted. */ - amount: number; - discount: components["schemas"]["discount"]; - }; + amount: number + discount: components['schemas']['discount'] + } /** LineItemsTaxAmount */ line_items_tax_amount: { /** @description Amount of tax applied for this rate. */ - amount: number; - rate: components["schemas"]["tax_rate"]; - }; + amount: number + rate: components['schemas']['tax_rate'] + } /** LoginLink */ login_link: { /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "login_link"; + object: 'login_link' /** @description The URL for the login link. */ - url: string; - }; + url: string + } /** * Mandate * @description A Mandate is a record of the permission a customer has given you to debit their payment method. */ mandate: { - customer_acceptance: components["schemas"]["customer_acceptance"]; + customer_acceptance: components['schemas']['customer_acceptance'] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; - multi_use?: components["schemas"]["mandate_multi_use"]; + livemode: boolean + multi_use?: components['schemas']['mandate_multi_use'] /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "mandate"; + object: 'mandate' /** @description ID of the payment method associated with this mandate. */ - payment_method: Partial & Partial; - payment_method_details: components["schemas"]["mandate_payment_method_details"]; - single_use?: components["schemas"]["mandate_single_use"]; + payment_method: Partial & Partial + payment_method_details: components['schemas']['mandate_payment_method_details'] + single_use?: components['schemas']['mandate_single_use'] /** * @description The status of the mandate, which indicates whether it can be used to initiate a payment. * @enum {string} */ - status: "active" | "inactive" | "pending"; + status: 'active' | 'inactive' | 'pending' /** * @description The type of the mandate. * @enum {string} */ - type: "multi_use" | "single_use"; - }; + type: 'multi_use' | 'single_use' + } /** mandate_acss_debit */ mandate_acss_debit: { /** @description List of Stripe products where this mandate can be selected automatically. */ - default_for?: ("invoice" | "subscription")[]; + default_for?: ('invoice' | 'subscription')[] /** @description Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. */ - interval_description?: string | null; + interval_description?: string | null /** * @description Payment schedule for the mandate. * @enum {string} */ - payment_schedule: "combined" | "interval" | "sporadic"; + payment_schedule: 'combined' | 'interval' | 'sporadic' /** * @description Transaction type of the mandate. * @enum {string} */ - transaction_type: "business" | "personal"; - }; + transaction_type: 'business' | 'personal' + } /** mandate_au_becs_debit */ mandate_au_becs_debit: { /** @description The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively. */ - url: string; - }; + url: string + } /** mandate_bacs_debit */ mandate_bacs_debit: { /** * @description The status of the mandate on the Bacs network. Can be one of `pending`, `revoked`, `refused`, or `accepted`. * @enum {string} */ - network_status: "accepted" | "pending" | "refused" | "revoked"; + network_status: 'accepted' | 'pending' | 'refused' | 'revoked' /** @description The unique reference identifying the mandate on the Bacs network. */ - reference: string; + reference: string /** @description The URL that will contain the mandate that the customer has signed. */ - url: string; - }; + url: string + } /** mandate_multi_use */ - mandate_multi_use: { [key: string]: unknown }; + mandate_multi_use: { [key: string]: unknown } /** mandate_payment_method_details */ mandate_payment_method_details: { - acss_debit?: components["schemas"]["mandate_acss_debit"]; - au_becs_debit?: components["schemas"]["mandate_au_becs_debit"]; - bacs_debit?: components["schemas"]["mandate_bacs_debit"]; - card?: components["schemas"]["card_mandate_payment_method_details"]; - sepa_debit?: components["schemas"]["mandate_sepa_debit"]; + acss_debit?: components['schemas']['mandate_acss_debit'] + au_becs_debit?: components['schemas']['mandate_au_becs_debit'] + bacs_debit?: components['schemas']['mandate_bacs_debit'] + card?: components['schemas']['card_mandate_payment_method_details'] + sepa_debit?: components['schemas']['mandate_sepa_debit'] /** @description The type of the payment method associated with this mandate. An additional hash is included on `payment_method_details` with a name matching this value. It contains mandate information specific to the payment method. */ - type: string; - }; + type: string + } /** mandate_sepa_debit */ mandate_sepa_debit: { /** @description The unique reference of the mandate. */ - reference: string; + reference: string /** @description The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively. */ - url: string; - }; + url: string + } /** mandate_single_use */ mandate_single_use: { /** @description On a single use mandate, the amount of the payment. */ - amount: number; + amount: number /** @description On a single use mandate, the currency of the payment. */ - currency: string; - }; + currency: string + } /** networks */ networks: { /** @description All available networks for the card. */ - available: string[]; + available: string[] /** @description The preferred network for the card. */ - preferred?: string | null; - }; + preferred?: string | null + } /** NotificationEventData */ notification_event_data: { /** @description 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: { [key: string]: unknown }; + object: { [key: string]: unknown } /** @description Object containing the names of the attributes that have changed, and their previous values (sent along only with *.updated events). */ - previous_attributes?: { [key: string]: unknown }; - }; + previous_attributes?: { [key: string]: unknown } + } /** NotificationEventRequest */ notification_event_request: { /** @description 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?: string | null; + id?: string | null /** @description 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?: string | null; - }; + idempotency_key?: string | null + } /** offline_acceptance */ - offline_acceptance: { [key: string]: unknown }; + offline_acceptance: { [key: string]: unknown } /** online_acceptance */ online_acceptance: { /** @description The IP address from which the Mandate was accepted by the customer. */ - ip_address?: string | null; + ip_address?: string | null /** @description The user agent of the browser from which the Mandate was accepted by the customer. */ - user_agent?: string | null; - }; + user_agent?: string | null + } /** * Order * @description Order objects are created to handle end customers' purchases of previously @@ -8594,80 +8530,76 @@ export type components = { */ order: { /** @description 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: number; + amount: number /** @description The total amount that was returned to the customer. */ - amount_returned?: number | null; + amount_returned?: number | null /** @description ID of the Connect Application that created the order. */ - application?: string | null; + application?: string | null /** @description A fee in cents that will be applied to the order and transferred to the application owner’s Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees documentation. */ - application_fee?: number | null; + application_fee?: number | null /** @description The ID of the payment used to pay for the order. Present if the order status is `paid`, `fulfilled`, or `refunded`. */ - charge?: (Partial & Partial) | null; + charge?: (Partial & Partial) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description The customer used for the order. */ - customer?: - | (Partial & - Partial & - Partial) - | null; + customer?: (Partial & Partial & Partial) | null /** @description The email address of the customer placing the order. */ - email?: string | null; + email?: string | null /** @description External coupon code to load for this order. */ - external_coupon_code?: string; + external_coupon_code?: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description List of items constituting the order. An order can have up to 25 items. */ - items: components["schemas"]["order_item"][]; + items: components['schemas']['order_item'][] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "order"; + object: 'order' /** * OrdersResourceOrderReturnList * @description A list of returns that have taken place for this order. */ returns?: { /** @description Details about each object. */ - data: components["schemas"]["order_return"][]; + data: components['schemas']['order_return'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } | null; + url: string + } | null /** @description The shipping method that is currently selected for this order, if any. If present, it is equal to one of the `id`s of shipping methods in the `shipping_methods` array. At order creation time, if there are multiple shipping methods, Stripe will automatically selected the first method. */ - selected_shipping_method?: string | null; + selected_shipping_method?: string | null /** @description The shipping address for the order. Present if the order is for goods to be shipped. */ - shipping?: Partial | null; + shipping?: Partial | null /** @description A list of supported shipping methods for this order. The desired shipping method can be specified either by updating the order, or when paying it. */ - shipping_methods?: components["schemas"]["shipping_method"][] | null; + shipping_methods?: components['schemas']['shipping_method'][] | null /** @description Current order status. One of `created`, `paid`, `canceled`, `fulfilled`, or `returned`. More details in the [Orders Guide](https://stripe.com/docs/orders/guide#understanding-order-statuses). */ - status: string; + status: string /** @description The timestamps at which the order status was updated. */ - status_transitions?: Partial | null; + status_transitions?: Partial | null /** * Format: unix-time * @description Time at which the object was last updated. Measured in seconds since the Unix epoch. */ - updated?: number | null; + updated?: number | null /** @description The user's order ID if it is different from the Stripe order ID. */ - upstream_id?: string; - }; + upstream_id?: string + } /** * OrderItem * @description A representation of the constituent items of any given order. Can be used to @@ -8677,23 +8609,23 @@ export type components = { */ order_item: { /** @description 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 line item. */ - amount: number; + amount: number /** @description 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: string; + currency: string /** @description Description of the line item, meant to be displayable to the user (e.g., `"Express shipping"`). */ - description: string; + description: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "order_item"; + object: 'order_item' /** @description The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a SKU). */ - parent?: (Partial & Partial) | null; + parent?: (Partial & Partial) | null /** @description A positive integer representing the number of instances of `parent` that are included in this order item. Applicable/present only if `type` is `sku`. */ - quantity?: number | null; + quantity?: number | null /** @description The type of line item. One of `sku`, `tax`, `shipping`, or `discount`. */ - type: string; - }; + type: string + } /** * OrderReturn * @description A return represents the full or partial return of a number of [order items](https://stripe.com/docs/api#order_items). @@ -8703,66 +8635,66 @@ export type components = { */ order_return: { /** @description 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 returned line item. */ - amount: number; + amount: number /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The items included in this order return. */ - items: components["schemas"]["order_item"][]; + items: components['schemas']['order_item'][] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "order_return"; + object: 'order_return' /** @description The order that this return includes items from. */ - order?: (Partial & Partial) | null; + order?: (Partial & Partial) | null /** @description The ID of the refund issued for this return. */ - refund?: (Partial & Partial) | null; - }; + refund?: (Partial & Partial) | null + } /** PackageDimensions */ package_dimensions: { /** @description Height, in inches. */ - height: number; + height: number /** @description Length, in inches. */ - length: number; + length: number /** @description Weight, in ounces. */ - weight: number; + weight: number /** @description Width, in inches. */ - width: number; - }; + width: number + } /** PaymentFlowsAutomaticPaymentMethodsPaymentIntent */ payment_flows_automatic_payment_methods_payment_intent: { /** @description Automatically calculates compatible payment methods */ - enabled: boolean; - }; + enabled: boolean + } /** PaymentFlowsPrivatePaymentMethodsAlipay */ - payment_flows_private_payment_methods_alipay: { [key: string]: unknown }; + payment_flows_private_payment_methods_alipay: { [key: string]: unknown } /** PaymentFlowsPrivatePaymentMethodsAlipayDetails */ payment_flows_private_payment_methods_alipay_details: { /** @description Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same. */ - buyer_id?: string; + buyer_id?: string /** @description Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Transaction ID of this particular Alipay transaction. */ - transaction_id?: string | null; - }; + transaction_id?: string | null + } /** PaymentFlowsPrivatePaymentMethodsKlarnaDOB */ payment_flows_private_payment_methods_klarna_dob: { /** @description The day of birth, between 1 and 31. */ - day?: number | null; + day?: number | null /** @description The month of birth, between 1 and 12. */ - month?: number | null; + month?: number | null /** @description The four-digit year of birth. */ - year?: number | null; - }; + year?: number | null + } /** * PaymentIntent * @description A PaymentIntent guides you through the process of collecting a payment from your customer. @@ -8779,61 +8711,51 @@ export type components = { */ payment_intent: { /** @description 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: number; + amount: number /** @description Amount that can be captured from this PaymentIntent. */ - amount_capturable?: number; + amount_capturable?: number /** @description Amount that was collected by this PaymentIntent. */ - amount_received?: number; + amount_received?: number /** @description ID of the Connect application that created the PaymentIntent. */ - application?: (Partial & Partial) | null; + application?: (Partial & Partial) | null /** @description 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?: number | null; + application_fee_amount?: number | null /** @description Settings to configure compatible payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods) */ - automatic_payment_methods?: Partial< - components["schemas"]["payment_flows_automatic_payment_methods_payment_intent"] - > | null; + automatic_payment_methods?: Partial | null /** * Format: unix-time * @description Populated when `status` is `canceled`, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch. */ - canceled_at?: number | null; + canceled_at?: number | null /** * @description 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`). * @enum {string|null} */ cancellation_reason?: - | ( - | "abandoned" - | "automatic" - | "duplicate" - | "failed_invoice" - | "fraudulent" - | "requested_by_customer" - | "void_invoice" - ) - | null; + | ('abandoned' | 'automatic' | 'duplicate' | 'failed_invoice' | 'fraudulent' | 'requested_by_customer' | 'void_invoice') + | null /** * @description Controls when the funds will be captured from the customer's account. * @enum {string} */ - capture_method: "automatic" | "manual"; + capture_method: 'automatic' | 'manual' /** * PaymentFlowsPaymentIntentResourceChargeList * @description Charges that were created by this PaymentIntent, if any. */ charges?: { /** @description This list only contains the latest charge, even if there were previously multiple unsuccessful charges. To view all previous charges for a PaymentIntent, you can filter the charges list using the `payment_intent` [parameter](https://stripe.com/docs/api/charges/list#list_charges-payment_intent). */ - data: components["schemas"]["charge"][]; + data: components['schemas']['charge'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** * @description The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key. * @@ -8841,16 +8763,16 @@ export type components = { * * Refer to our docs to [accept a payment](https://stripe.com/docs/payments/accept-a-payment?integration=elements) and learn about how `client_secret` should be handled. */ - client_secret?: string | null; + client_secret?: string | null /** @enum {string} */ - confirmation_method: "automatic" | "manual"; + confirmation_method: 'automatic' | 'manual' /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** * @description ID of the Customer this PaymentIntent belongs to, if one exists. * @@ -8858,44 +8780,40 @@ export type components = { * * If present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. */ - customer?: - | (Partial & - Partial & - Partial) - | null; + customer?: (Partial & Partial & Partial) | null /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description ID of the invoice that created this PaymentIntent, if it exists. */ - invoice?: (Partial & Partial) | null; + invoice?: (Partial & Partial) | null /** @description 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?: Partial | null; + last_payment_error?: Partial | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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. For more information, see the [documentation](https://stripe.com/docs/payments/payment-intents/creating-payment-intents#storing-information-in-metadata). */ - metadata?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description 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?: Partial | null; + next_action?: Partial | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "payment_intent"; + object: 'payment_intent' /** @description 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?: (Partial & Partial) | null; + on_behalf_of?: (Partial & Partial) | null /** @description ID of the payment method used in this PaymentIntent. */ - payment_method?: (Partial & Partial) | null; + payment_method?: (Partial & Partial) | null /** @description Payment-method-specific configuration for this PaymentIntent. */ - payment_method_options?: Partial | null; + payment_method_options?: Partial | null /** @description The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. */ - payment_method_types: string[]; + payment_method_types: string[] /** @description If present, this property tells you about the processing state of the payment. */ - processing?: Partial | null; + processing?: Partial | null /** @description 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?: string | null; + receipt_email?: string | null /** @description ID of the review associated with this PaymentIntent, if any. */ - review?: (Partial & Partial) | null; + review?: (Partial & Partial) | null /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * @@ -8904,190 +8822,183 @@ export type components = { * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string|null} */ - setup_future_usage?: ("off_session" | "on_session") | null; + setup_future_usage?: ('off_session' | 'on_session') | null /** @description Shipping information for this PaymentIntent. */ - shipping?: Partial | null; + shipping?: Partial | null /** @description For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - statement_descriptor?: string | null; + statement_descriptor?: string | null /** @description Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - statement_descriptor_suffix?: string | null; + statement_descriptor_suffix?: string | null /** * @description 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). * @enum {string} */ - status: - | "canceled" - | "processing" - | "requires_action" - | "requires_capture" - | "requires_confirmation" - | "requires_payment_method" - | "succeeded"; + status: 'canceled' | 'processing' | 'requires_action' | 'requires_capture' | 'requires_confirmation' | 'requires_payment_method' | 'succeeded' /** @description The data with which to automatically create a Transfer when the payment is finalized. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. */ - transfer_data?: Partial | null; + transfer_data?: Partial | null /** @description A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. */ - transfer_group?: string | null; - }; + transfer_group?: string | null + } /** PaymentIntentCardProcessing */ - payment_intent_card_processing: { [key: string]: unknown }; + payment_intent_card_processing: { [key: string]: unknown } /** PaymentIntentNextAction */ payment_intent_next_action: { - alipay_handle_redirect?: components["schemas"]["payment_intent_next_action_alipay_handle_redirect"]; - boleto_display_details?: components["schemas"]["payment_intent_next_action_boleto"]; - oxxo_display_details?: components["schemas"]["payment_intent_next_action_display_oxxo_details"]; - redirect_to_url?: components["schemas"]["payment_intent_next_action_redirect_to_url"]; + alipay_handle_redirect?: components['schemas']['payment_intent_next_action_alipay_handle_redirect'] + boleto_display_details?: components['schemas']['payment_intent_next_action_boleto'] + oxxo_display_details?: components['schemas']['payment_intent_next_action_display_oxxo_details'] + redirect_to_url?: components['schemas']['payment_intent_next_action_redirect_to_url'] /** @description 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: string; + type: string /** @description 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?: { [key: string]: unknown }; - verify_with_microdeposits?: components["schemas"]["payment_intent_next_action_verify_with_microdeposits"]; - wechat_pay_display_qr_code?: components["schemas"]["payment_intent_next_action_wechat_pay_display_qr_code"]; - wechat_pay_redirect_to_android_app?: components["schemas"]["payment_intent_next_action_wechat_pay_redirect_to_android_app"]; - wechat_pay_redirect_to_ios_app?: components["schemas"]["payment_intent_next_action_wechat_pay_redirect_to_ios_app"]; - }; + use_stripe_sdk?: { [key: string]: unknown } + verify_with_microdeposits?: components['schemas']['payment_intent_next_action_verify_with_microdeposits'] + wechat_pay_display_qr_code?: components['schemas']['payment_intent_next_action_wechat_pay_display_qr_code'] + wechat_pay_redirect_to_android_app?: components['schemas']['payment_intent_next_action_wechat_pay_redirect_to_android_app'] + wechat_pay_redirect_to_ios_app?: components['schemas']['payment_intent_next_action_wechat_pay_redirect_to_ios_app'] + } /** PaymentIntentNextActionAlipayHandleRedirect */ payment_intent_next_action_alipay_handle_redirect: { /** @description 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?: string | null; + native_data?: string | null /** @description The native URL you must redirect your customer to in order to authenticate the payment in an iOS App. */ - native_url?: string | null; + native_url?: string | null /** @description If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion. */ - return_url?: string | null; + return_url?: string | null /** @description The URL you must redirect your customer to in order to authenticate the payment. */ - url?: string | null; - }; + url?: string | null + } /** payment_intent_next_action_boleto */ payment_intent_next_action_boleto: { /** * Format: unix-time * @description The timestamp after which the boleto expires. */ - expires_at?: number | null; + expires_at?: number | null /** @description The URL to the hosted boleto voucher page, which allows customers to view the boleto voucher. */ - hosted_voucher_url?: string | null; + hosted_voucher_url?: string | null /** @description The boleto number. */ - number?: string | null; + number?: string | null /** @description The URL to the downloadable boleto voucher PDF. */ - pdf?: string | null; - }; + pdf?: string | null + } /** PaymentIntentNextActionDisplayOxxoDetails */ payment_intent_next_action_display_oxxo_details: { /** * Format: unix-time * @description The timestamp after which the OXXO voucher expires. */ - expires_after?: number | null; + expires_after?: number | null /** @description The URL for the hosted OXXO voucher page, which allows customers to view and print an OXXO voucher. */ - hosted_voucher_url?: string | null; + hosted_voucher_url?: string | null /** @description OXXO reference number. */ - number?: string | null; - }; + number?: string | null + } /** PaymentIntentNextActionRedirectToUrl */ payment_intent_next_action_redirect_to_url: { /** @description If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion. */ - return_url?: string | null; + return_url?: string | null /** @description The URL you must redirect your customer to in order to authenticate the payment. */ - url?: string | null; - }; + url?: string | null + } /** PaymentIntentNextActionVerifyWithMicrodeposits */ payment_intent_next_action_verify_with_microdeposits: { /** * Format: unix-time * @description The timestamp when the microdeposits are expected to land. */ - arrival_date: number; + arrival_date: number /** @description The URL for the hosted verification page, which allows customers to verify their bank account. */ - hosted_verification_url: string; - }; + hosted_verification_url: string + } /** PaymentIntentNextActionWechatPayDisplayQrCode */ payment_intent_next_action_wechat_pay_display_qr_code: { /** @description The data being used to generate QR code */ - data: string; + data: string /** @description The base64 image data for a pre-generated QR code */ - image_data_url: string; + image_data_url: string /** @description The image_url_png string used to render QR code */ - image_url_png: string; + image_url_png: string /** @description The image_url_svg string used to render QR code */ - image_url_svg: string; - }; + image_url_svg: string + } /** PaymentIntentNextActionWechatPayRedirectToAndroidApp */ payment_intent_next_action_wechat_pay_redirect_to_android_app: { /** @description app_id is the APP ID registered on WeChat open platform */ - app_id: string; + app_id: string /** @description nonce_str is a random string */ - nonce_str: string; + nonce_str: string /** @description package is static value */ - package: string; + package: string /** @description an unique merchant ID assigned by Wechat Pay */ - partner_id: string; + partner_id: string /** @description an unique trading ID assigned by Wechat Pay */ - prepay_id: string; + prepay_id: string /** @description A signature */ - sign: string; + sign: string /** @description Specifies the current time in epoch format */ - timestamp: string; - }; + timestamp: string + } /** PaymentIntentNextActionWechatPayRedirectToIOSApp */ payment_intent_next_action_wechat_pay_redirect_to_ios_app: { /** @description An universal link that redirect to Wechat Pay APP */ - native_url: string; - }; + native_url: string + } /** PaymentIntentPaymentMethodOptions */ payment_intent_payment_method_options: { - acss_debit?: Partial & - Partial; - afterpay_clearpay?: Partial & - Partial; - alipay?: Partial & - Partial; - au_becs_debit?: Partial & - Partial; - bacs_debit?: Partial & - Partial; - bancontact?: Partial & - Partial; - boleto?: Partial & - Partial; - card?: Partial & - Partial; - card_present?: Partial & - Partial; - eps?: Partial & - Partial; - fpx?: Partial & - Partial; - giropay?: Partial & - Partial; - grabpay?: Partial & - Partial; - ideal?: Partial & - Partial; - interac_present?: Partial & - Partial; - klarna?: Partial & - Partial; - oxxo?: Partial & - Partial; - p24?: Partial & - Partial; - sepa_debit?: Partial & - Partial; - sofort?: Partial & - Partial; - wechat_pay?: Partial & - Partial; - }; + acss_debit?: Partial & + Partial + afterpay_clearpay?: Partial & + Partial + alipay?: Partial & + Partial + au_becs_debit?: Partial & + Partial + bacs_debit?: Partial & + Partial + bancontact?: Partial & + Partial + boleto?: Partial & + Partial + card?: Partial & + Partial + card_present?: Partial & + Partial + eps?: Partial & + Partial + fpx?: Partial & + Partial + giropay?: Partial & + Partial + grabpay?: Partial & + Partial + ideal?: Partial & + Partial + interac_present?: Partial & + Partial + klarna?: Partial & + Partial + oxxo?: Partial & + Partial + p24?: Partial & + Partial + sepa_debit?: Partial & + Partial + sofort?: Partial & + Partial + wechat_pay?: Partial & + Partial + } /** payment_intent_payment_method_options_acss_debit */ payment_intent_payment_method_options_acss_debit: { - mandate_options?: components["schemas"]["payment_intent_payment_method_options_mandate_options_acss_debit"]; + mandate_options?: components['schemas']['payment_intent_payment_method_options_mandate_options_acss_debit'] /** * @description Bank account verification method. * @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; - }; + verification_method?: 'automatic' | 'instant' | 'microdeposits' + } /** payment_intent_payment_method_options_au_becs_debit */ - payment_intent_payment_method_options_au_becs_debit: { [key: string]: unknown }; + payment_intent_payment_method_options_au_becs_debit: { [key: string]: unknown } /** payment_intent_payment_method_options_card */ payment_intent_payment_method_options_card: { /** @@ -9095,30 +9006,17 @@ export type components = { * * For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments). */ - installments?: Partial | null; + installments?: Partial | null /** * @description 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. * @enum {string|null} */ - network?: - | ( - | "amex" - | "cartes_bancaires" - | "diners" - | "discover" - | "interac" - | "jcb" - | "mastercard" - | "unionpay" - | "unknown" - | "visa" - ) - | null; + network?: ('amex' | 'cartes_bancaires' | 'diners' | 'discover' | 'interac' | 'jcb' | 'mastercard' | 'unionpay' | 'unknown' | 'visa') | null /** * @description 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. Permitted values include: `automatic` or `any`. If not provided, defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. * @enum {string|null} */ - request_three_d_secure?: ("any" | "automatic" | "challenge_only") | null; + request_three_d_secure?: ('any' | 'automatic' | 'challenge_only') | null /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * @@ -9127,42 +9025,42 @@ export type components = { * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ - setup_future_usage?: "none" | "off_session" | "on_session"; - }; + setup_future_usage?: 'none' | 'off_session' | 'on_session' + } /** payment_intent_payment_method_options_eps */ - payment_intent_payment_method_options_eps: { [key: string]: unknown }; + payment_intent_payment_method_options_eps: { [key: string]: unknown } /** payment_intent_payment_method_options_mandate_options_acss_debit */ payment_intent_payment_method_options_mandate_options_acss_debit: { /** @description A URL for custom mandate text */ - custom_mandate_url?: string; + custom_mandate_url?: string /** @description Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. */ - interval_description?: string | null; + interval_description?: string | null /** * @description Payment schedule for the mandate. * @enum {string|null} */ - payment_schedule?: ("combined" | "interval" | "sporadic") | null; + payment_schedule?: ('combined' | 'interval' | 'sporadic') | null /** * @description Transaction type of the mandate. * @enum {string|null} */ - transaction_type?: ("business" | "personal") | null; - }; + transaction_type?: ('business' | 'personal') | null + } /** payment_intent_payment_method_options_mandate_options_sepa_debit */ - payment_intent_payment_method_options_mandate_options_sepa_debit: { [key: string]: unknown }; + payment_intent_payment_method_options_mandate_options_sepa_debit: { [key: string]: unknown } /** payment_intent_payment_method_options_sepa_debit */ payment_intent_payment_method_options_sepa_debit: { - mandate_options?: components["schemas"]["payment_intent_payment_method_options_mandate_options_sepa_debit"]; - }; + mandate_options?: components['schemas']['payment_intent_payment_method_options_mandate_options_sepa_debit'] + } /** PaymentIntentProcessing */ payment_intent_processing: { - card?: components["schemas"]["payment_intent_card_processing"]; + card?: components['schemas']['payment_intent_card_processing'] /** * @description Type of the payment method for which payment is in `processing` state, one of `card`. * @enum {string} */ - type: "card"; - }; + type: 'card' + } /** PaymentIntentTypeSpecificPaymentMethodOptionsClient */ payment_intent_type_specific_payment_method_options_client: { /** @@ -9173,8 +9071,8 @@ export type components = { * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ - setup_future_usage?: "none" | "off_session" | "on_session"; - }; + setup_future_usage?: 'none' | 'off_session' | 'on_session' + } /** * PaymentLink * @description A payment link is a shareable URL that will take your customers to a hosted payment page. A payment link can be shared and used multiple times. @@ -9185,349 +9083,347 @@ export type components = { */ payment_link: { /** @description 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: boolean; - after_completion: components["schemas"]["payment_links_resource_after_completion"]; + active: boolean + after_completion: components['schemas']['payment_links_resource_after_completion'] /** @description Whether user redeemable promotion codes are enabled. */ - allow_promotion_codes: boolean; + allow_promotion_codes: boolean /** @description 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?: number | null; + application_fee_amount?: number | null /** @description This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. */ - application_fee_percent?: number | null; - automatic_tax: components["schemas"]["payment_links_resource_automatic_tax"]; + application_fee_percent?: number | null + automatic_tax: components['schemas']['payment_links_resource_automatic_tax'] /** * @description Configuration for collecting the customer's billing address. * @enum {string} */ - billing_address_collection: "auto" | "required"; + billing_address_collection: 'auto' | 'required' /** @description Unique identifier for the object. */ - id: string; + id: string /** * PaymentLinksResourceListLineItems * @description The line items representing what is being sold. */ line_items?: { /** @description Details about each object. */ - data: components["schemas"]["item"][]; + data: components['schemas']['item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "payment_link"; + object: 'payment_link' /** @description 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?: (Partial & Partial) | null; + on_behalf_of?: (Partial & Partial) | null /** @description 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?: "card"[] | null; - phone_number_collection: components["schemas"]["payment_links_resource_phone_number_collection"]; + payment_method_types?: 'card'[] | null + phone_number_collection: components['schemas']['payment_links_resource_phone_number_collection'] /** @description Configuration for collecting the customer's shipping address. */ - shipping_address_collection?: Partial< - components["schemas"]["payment_links_resource_shipping_address_collection"] - > | null; + shipping_address_collection?: Partial | null /** @description 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?: Partial | null; + subscription_data?: Partial | null /** @description 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?: Partial | null; + transfer_data?: Partial | null /** @description The public URL that can be shared with customers. */ - url: string; - }; + url: string + } /** PaymentLinksResourceAfterCompletion */ payment_links_resource_after_completion: { - hosted_confirmation?: components["schemas"]["payment_links_resource_completion_behavior_confirmation_page"]; - redirect?: components["schemas"]["payment_links_resource_completion_behavior_redirect"]; + hosted_confirmation?: components['schemas']['payment_links_resource_completion_behavior_confirmation_page'] + redirect?: components['schemas']['payment_links_resource_completion_behavior_redirect'] /** * @description The specified behavior after the purchase is complete. * @enum {string} */ - type: "hosted_confirmation" | "redirect"; - }; + type: 'hosted_confirmation' | 'redirect' + } /** PaymentLinksResourceAutomaticTax */ payment_links_resource_automatic_tax: { /** @description If `true`, tax will be calculated automatically using the customer's location. */ - enabled: boolean; - }; + enabled: boolean + } /** PaymentLinksResourceCompletionBehaviorConfirmationPage */ payment_links_resource_completion_behavior_confirmation_page: { /** @description The custom message that is displayed to the customer after the purchase is complete. */ - custom_message?: string | null; - }; + custom_message?: string | null + } /** PaymentLinksResourceCompletionBehaviorRedirect */ payment_links_resource_completion_behavior_redirect: { /** @description The URL the customer will be redirected to after the purchase is complete. */ - url: string; - }; + url: string + } /** PaymentLinksResourcePhoneNumberCollection */ payment_links_resource_phone_number_collection: { /** @description If `true`, a phone number will be collected during checkout. */ - enabled: boolean; - }; + enabled: boolean + } /** PaymentLinksResourceShippingAddressCollection */ payment_links_resource_shipping_address_collection: { /** @description 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: ( - | "AC" - | "AD" - | "AE" - | "AF" - | "AG" - | "AI" - | "AL" - | "AM" - | "AO" - | "AQ" - | "AR" - | "AT" - | "AU" - | "AW" - | "AX" - | "AZ" - | "BA" - | "BB" - | "BD" - | "BE" - | "BF" - | "BG" - | "BH" - | "BI" - | "BJ" - | "BL" - | "BM" - | "BN" - | "BO" - | "BQ" - | "BR" - | "BS" - | "BT" - | "BV" - | "BW" - | "BY" - | "BZ" - | "CA" - | "CD" - | "CF" - | "CG" - | "CH" - | "CI" - | "CK" - | "CL" - | "CM" - | "CN" - | "CO" - | "CR" - | "CV" - | "CW" - | "CY" - | "CZ" - | "DE" - | "DJ" - | "DK" - | "DM" - | "DO" - | "DZ" - | "EC" - | "EE" - | "EG" - | "EH" - | "ER" - | "ES" - | "ET" - | "FI" - | "FJ" - | "FK" - | "FO" - | "FR" - | "GA" - | "GB" - | "GD" - | "GE" - | "GF" - | "GG" - | "GH" - | "GI" - | "GL" - | "GM" - | "GN" - | "GP" - | "GQ" - | "GR" - | "GS" - | "GT" - | "GU" - | "GW" - | "GY" - | "HK" - | "HN" - | "HR" - | "HT" - | "HU" - | "ID" - | "IE" - | "IL" - | "IM" - | "IN" - | "IO" - | "IQ" - | "IS" - | "IT" - | "JE" - | "JM" - | "JO" - | "JP" - | "KE" - | "KG" - | "KH" - | "KI" - | "KM" - | "KN" - | "KR" - | "KW" - | "KY" - | "KZ" - | "LA" - | "LB" - | "LC" - | "LI" - | "LK" - | "LR" - | "LS" - | "LT" - | "LU" - | "LV" - | "LY" - | "MA" - | "MC" - | "MD" - | "ME" - | "MF" - | "MG" - | "MK" - | "ML" - | "MM" - | "MN" - | "MO" - | "MQ" - | "MR" - | "MS" - | "MT" - | "MU" - | "MV" - | "MW" - | "MX" - | "MY" - | "MZ" - | "NA" - | "NC" - | "NE" - | "NG" - | "NI" - | "NL" - | "NO" - | "NP" - | "NR" - | "NU" - | "NZ" - | "OM" - | "PA" - | "PE" - | "PF" - | "PG" - | "PH" - | "PK" - | "PL" - | "PM" - | "PN" - | "PR" - | "PS" - | "PT" - | "PY" - | "QA" - | "RE" - | "RO" - | "RS" - | "RU" - | "RW" - | "SA" - | "SB" - | "SC" - | "SE" - | "SG" - | "SH" - | "SI" - | "SJ" - | "SK" - | "SL" - | "SM" - | "SN" - | "SO" - | "SR" - | "SS" - | "ST" - | "SV" - | "SX" - | "SZ" - | "TA" - | "TC" - | "TD" - | "TF" - | "TG" - | "TH" - | "TJ" - | "TK" - | "TL" - | "TM" - | "TN" - | "TO" - | "TR" - | "TT" - | "TV" - | "TW" - | "TZ" - | "UA" - | "UG" - | "US" - | "UY" - | "UZ" - | "VA" - | "VC" - | "VE" - | "VG" - | "VN" - | "VU" - | "WF" - | "WS" - | "XK" - | "YE" - | "YT" - | "ZA" - | "ZM" - | "ZW" - | "ZZ" - )[]; - }; + | 'AC' + | 'AD' + | 'AE' + | 'AF' + | 'AG' + | 'AI' + | 'AL' + | 'AM' + | 'AO' + | 'AQ' + | 'AR' + | 'AT' + | 'AU' + | 'AW' + | 'AX' + | 'AZ' + | 'BA' + | 'BB' + | 'BD' + | 'BE' + | 'BF' + | 'BG' + | 'BH' + | 'BI' + | 'BJ' + | 'BL' + | 'BM' + | 'BN' + | 'BO' + | 'BQ' + | 'BR' + | 'BS' + | 'BT' + | 'BV' + | 'BW' + | 'BY' + | 'BZ' + | 'CA' + | 'CD' + | 'CF' + | 'CG' + | 'CH' + | 'CI' + | 'CK' + | 'CL' + | 'CM' + | 'CN' + | 'CO' + | 'CR' + | 'CV' + | 'CW' + | 'CY' + | 'CZ' + | 'DE' + | 'DJ' + | 'DK' + | 'DM' + | 'DO' + | 'DZ' + | 'EC' + | 'EE' + | 'EG' + | 'EH' + | 'ER' + | 'ES' + | 'ET' + | 'FI' + | 'FJ' + | 'FK' + | 'FO' + | 'FR' + | 'GA' + | 'GB' + | 'GD' + | 'GE' + | 'GF' + | 'GG' + | 'GH' + | 'GI' + | 'GL' + | 'GM' + | 'GN' + | 'GP' + | 'GQ' + | 'GR' + | 'GS' + | 'GT' + | 'GU' + | 'GW' + | 'GY' + | 'HK' + | 'HN' + | 'HR' + | 'HT' + | 'HU' + | 'ID' + | 'IE' + | 'IL' + | 'IM' + | 'IN' + | 'IO' + | 'IQ' + | 'IS' + | 'IT' + | 'JE' + | 'JM' + | 'JO' + | 'JP' + | 'KE' + | 'KG' + | 'KH' + | 'KI' + | 'KM' + | 'KN' + | 'KR' + | 'KW' + | 'KY' + | 'KZ' + | 'LA' + | 'LB' + | 'LC' + | 'LI' + | 'LK' + | 'LR' + | 'LS' + | 'LT' + | 'LU' + | 'LV' + | 'LY' + | 'MA' + | 'MC' + | 'MD' + | 'ME' + | 'MF' + | 'MG' + | 'MK' + | 'ML' + | 'MM' + | 'MN' + | 'MO' + | 'MQ' + | 'MR' + | 'MS' + | 'MT' + | 'MU' + | 'MV' + | 'MW' + | 'MX' + | 'MY' + | 'MZ' + | 'NA' + | 'NC' + | 'NE' + | 'NG' + | 'NI' + | 'NL' + | 'NO' + | 'NP' + | 'NR' + | 'NU' + | 'NZ' + | 'OM' + | 'PA' + | 'PE' + | 'PF' + | 'PG' + | 'PH' + | 'PK' + | 'PL' + | 'PM' + | 'PN' + | 'PR' + | 'PS' + | 'PT' + | 'PY' + | 'QA' + | 'RE' + | 'RO' + | 'RS' + | 'RU' + | 'RW' + | 'SA' + | 'SB' + | 'SC' + | 'SE' + | 'SG' + | 'SH' + | 'SI' + | 'SJ' + | 'SK' + | 'SL' + | 'SM' + | 'SN' + | 'SO' + | 'SR' + | 'SS' + | 'ST' + | 'SV' + | 'SX' + | 'SZ' + | 'TA' + | 'TC' + | 'TD' + | 'TF' + | 'TG' + | 'TH' + | 'TJ' + | 'TK' + | 'TL' + | 'TM' + | 'TN' + | 'TO' + | 'TR' + | 'TT' + | 'TV' + | 'TW' + | 'TZ' + | 'UA' + | 'UG' + | 'US' + | 'UY' + | 'UZ' + | 'VA' + | 'VC' + | 'VE' + | 'VG' + | 'VN' + | 'VU' + | 'WF' + | 'WS' + | 'XK' + | 'YE' + | 'YT' + | 'ZA' + | 'ZM' + | 'ZW' + | 'ZZ' + )[] + } /** PaymentLinksResourceSubscriptionData */ payment_links_resource_subscription_data: { /** @description Integer representing the number of trial period days before the customer is charged for the first time. */ - trial_period_days?: number | null; - }; + trial_period_days?: number | null + } /** PaymentLinksResourceTransferData */ payment_links_resource_transfer_data: { /** @description The amount in %s that will be transferred to the destination account. By default, the entire amount is transferred to the destination. */ - amount?: number | null; + amount?: number | null /** @description The connected account receiving the transfer. */ - destination: Partial & Partial; - }; + destination: Partial & Partial + } /** * PaymentMethod * @description PaymentMethod objects represent your customer's payment instruments. @@ -9537,530 +9433,522 @@ export type components = { * Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios). */ payment_method: { - acss_debit?: components["schemas"]["payment_method_acss_debit"]; - afterpay_clearpay?: components["schemas"]["payment_method_afterpay_clearpay"]; - alipay?: components["schemas"]["payment_flows_private_payment_methods_alipay"]; - au_becs_debit?: components["schemas"]["payment_method_au_becs_debit"]; - bacs_debit?: components["schemas"]["payment_method_bacs_debit"]; - bancontact?: components["schemas"]["payment_method_bancontact"]; - billing_details: components["schemas"]["billing_details"]; - boleto?: components["schemas"]["payment_method_boleto"]; - card?: components["schemas"]["payment_method_card"]; - card_present?: components["schemas"]["payment_method_card_present"]; + acss_debit?: components['schemas']['payment_method_acss_debit'] + afterpay_clearpay?: components['schemas']['payment_method_afterpay_clearpay'] + alipay?: components['schemas']['payment_flows_private_payment_methods_alipay'] + au_becs_debit?: components['schemas']['payment_method_au_becs_debit'] + bacs_debit?: components['schemas']['payment_method_bacs_debit'] + bancontact?: components['schemas']['payment_method_bancontact'] + billing_details: components['schemas']['billing_details'] + boleto?: components['schemas']['payment_method_boleto'] + card?: components['schemas']['payment_method_card'] + card_present?: components['schemas']['payment_method_card_present'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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?: (Partial & Partial) | null; - eps?: components["schemas"]["payment_method_eps"]; - fpx?: components["schemas"]["payment_method_fpx"]; - giropay?: components["schemas"]["payment_method_giropay"]; - grabpay?: components["schemas"]["payment_method_grabpay"]; + customer?: (Partial & Partial) | null + eps?: components['schemas']['payment_method_eps'] + fpx?: components['schemas']['payment_method_fpx'] + giropay?: components['schemas']['payment_method_giropay'] + grabpay?: components['schemas']['payment_method_grabpay'] /** @description Unique identifier for the object. */ - id: string; - ideal?: components["schemas"]["payment_method_ideal"]; - interac_present?: components["schemas"]["payment_method_interac_present"]; - klarna?: components["schemas"]["payment_method_klarna"]; + id: string + ideal?: components['schemas']['payment_method_ideal'] + interac_present?: components['schemas']['payment_method_interac_present'] + klarna?: components['schemas']['payment_method_klarna'] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "payment_method"; - oxxo?: components["schemas"]["payment_method_oxxo"]; - p24?: components["schemas"]["payment_method_p24"]; - sepa_debit?: components["schemas"]["payment_method_sepa_debit"]; - sofort?: components["schemas"]["payment_method_sofort"]; + object: 'payment_method' + oxxo?: components['schemas']['payment_method_oxxo'] + p24?: components['schemas']['payment_method_p24'] + sepa_debit?: components['schemas']['payment_method_sepa_debit'] + sofort?: components['schemas']['payment_method_sofort'] /** * @description 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. * @enum {string} */ type: - | "acss_debit" - | "afterpay_clearpay" - | "alipay" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "card_present" - | "eps" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "interac_present" - | "klarna" - | "oxxo" - | "p24" - | "sepa_debit" - | "sofort" - | "wechat_pay"; - wechat_pay?: components["schemas"]["payment_method_wechat_pay"]; - }; + | 'acss_debit' + | 'afterpay_clearpay' + | 'alipay' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'card_present' + | 'eps' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'interac_present' + | 'klarna' + | 'oxxo' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' + wechat_pay?: components['schemas']['payment_method_wechat_pay'] + } /** payment_method_acss_debit */ payment_method_acss_debit: { /** @description Name of the bank associated with the bank account. */ - bank_name?: string | null; + bank_name?: string | null /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Institution number of the bank account. */ - institution_number?: string | null; + institution_number?: string | null /** @description Last four digits of the bank account number. */ - last4?: string | null; + last4?: string | null /** @description Transit number of the bank account. */ - transit_number?: string | null; - }; + transit_number?: string | null + } /** payment_method_afterpay_clearpay */ - payment_method_afterpay_clearpay: { [key: string]: unknown }; + payment_method_afterpay_clearpay: { [key: string]: unknown } /** payment_method_au_becs_debit */ payment_method_au_becs_debit: { /** @description Six-digit number identifying bank and branch associated with this bank account. */ - bsb_number?: string | null; + bsb_number?: string | null /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Last four digits of the bank account number. */ - last4?: string | null; - }; + last4?: string | null + } /** payment_method_bacs_debit */ payment_method_bacs_debit: { /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Last four digits of the bank account number. */ - last4?: string | null; + last4?: string | null /** @description Sort code of the bank account. (e.g., `10-20-30`) */ - sort_code?: string | null; - }; + sort_code?: string | null + } /** payment_method_bancontact */ - payment_method_bancontact: { [key: string]: unknown }; + payment_method_bancontact: { [key: string]: unknown } /** payment_method_boleto */ payment_method_boleto: { /** @description Uniquely identifies the customer tax id (CNPJ or CPF) */ - tax_id: string; - }; + tax_id: string + } /** payment_method_card */ payment_method_card: { /** @description Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ - brand: string; + brand: string /** @description Checks on Card address and CVC if provided. */ - checks?: Partial | null; + checks?: Partial | null /** @description 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?: string | null; + country?: string | null /** @description Two-digit number representing the card's expiration month. */ - exp_month: number; + exp_month: number /** @description Four-digit number representing the card's expiration year. */ - exp_year: number; + exp_year: number /** * @description 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. * * *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.* */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ - funding: string; + funding: string /** @description Details of the original PaymentMethod that created this object. */ - generated_from?: Partial | null; + generated_from?: Partial | null /** @description The last four digits of the card. */ - last4: string; + last4: string /** @description Contains information about card networks that can be used to process the payment. */ - networks?: Partial | null; + networks?: Partial | null /** @description Contains details on how this Card maybe be used for 3D Secure authentication. */ - three_d_secure_usage?: Partial | null; + three_d_secure_usage?: Partial | null /** @description If this Card is part of a card wallet, this contains the details of the card wallet. */ - wallet?: Partial | null; - }; + wallet?: Partial | null + } /** payment_method_card_checks */ payment_method_card_checks: { /** @description If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ - address_line1_check?: string | null; + address_line1_check?: string | null /** @description If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ - address_postal_code_check?: string | null; + address_postal_code_check?: string | null /** @description If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ - cvc_check?: string | null; - }; + cvc_check?: string | null + } /** payment_method_card_generated_card */ payment_method_card_generated_card: { /** @description The charge that created this object. */ - charge?: string | null; + charge?: string | null /** @description Transaction-specific details of the payment method used in the payment. */ - payment_method_details?: Partial | null; + payment_method_details?: Partial | null /** @description The ID of the SetupAttempt that generated this PaymentMethod, if any. */ - setup_attempt?: (Partial & Partial) | null; - }; + setup_attempt?: (Partial & Partial) | null + } /** payment_method_card_present */ - payment_method_card_present: { [key: string]: unknown }; + payment_method_card_present: { [key: string]: unknown } /** payment_method_card_wallet */ payment_method_card_wallet: { - amex_express_checkout?: components["schemas"]["payment_method_card_wallet_amex_express_checkout"]; - apple_pay?: components["schemas"]["payment_method_card_wallet_apple_pay"]; + amex_express_checkout?: components['schemas']['payment_method_card_wallet_amex_express_checkout'] + apple_pay?: components['schemas']['payment_method_card_wallet_apple_pay'] /** @description (For tokenized numbers only.) The last four digits of the device account number. */ - dynamic_last4?: string | null; - google_pay?: components["schemas"]["payment_method_card_wallet_google_pay"]; - masterpass?: components["schemas"]["payment_method_card_wallet_masterpass"]; - samsung_pay?: components["schemas"]["payment_method_card_wallet_samsung_pay"]; + dynamic_last4?: string | null + google_pay?: components['schemas']['payment_method_card_wallet_google_pay'] + masterpass?: components['schemas']['payment_method_card_wallet_masterpass'] + samsung_pay?: components['schemas']['payment_method_card_wallet_samsung_pay'] /** * @description The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, or `visa_checkout`. 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. * @enum {string} */ - type: "amex_express_checkout" | "apple_pay" | "google_pay" | "masterpass" | "samsung_pay" | "visa_checkout"; - visa_checkout?: components["schemas"]["payment_method_card_wallet_visa_checkout"]; - }; + type: 'amex_express_checkout' | 'apple_pay' | 'google_pay' | 'masterpass' | 'samsung_pay' | 'visa_checkout' + visa_checkout?: components['schemas']['payment_method_card_wallet_visa_checkout'] + } /** payment_method_card_wallet_amex_express_checkout */ - payment_method_card_wallet_amex_express_checkout: { [key: string]: unknown }; + payment_method_card_wallet_amex_express_checkout: { [key: string]: unknown } /** payment_method_card_wallet_apple_pay */ - payment_method_card_wallet_apple_pay: { [key: string]: unknown }; + payment_method_card_wallet_apple_pay: { [key: string]: unknown } /** payment_method_card_wallet_google_pay */ - payment_method_card_wallet_google_pay: { [key: string]: unknown }; + payment_method_card_wallet_google_pay: { [key: string]: unknown } /** payment_method_card_wallet_masterpass */ payment_method_card_wallet_masterpass: { /** @description 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?: Partial | null; + billing_address?: Partial | null /** @description 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?: string | null; + email?: string | null /** @description 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?: string | null; + name?: string | null /** @description 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?: Partial | null; - }; + shipping_address?: Partial | null + } /** payment_method_card_wallet_samsung_pay */ - payment_method_card_wallet_samsung_pay: { [key: string]: unknown }; + payment_method_card_wallet_samsung_pay: { [key: string]: unknown } /** payment_method_card_wallet_visa_checkout */ payment_method_card_wallet_visa_checkout: { /** @description 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?: Partial | null; + billing_address?: Partial | null /** @description 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?: string | null; + email?: string | null /** @description 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?: string | null; + name?: string | null /** @description 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?: Partial | null; - }; + shipping_address?: Partial | null + } /** payment_method_details */ payment_method_details: { - ach_credit_transfer?: components["schemas"]["payment_method_details_ach_credit_transfer"]; - ach_debit?: components["schemas"]["payment_method_details_ach_debit"]; - acss_debit?: components["schemas"]["payment_method_details_acss_debit"]; - afterpay_clearpay?: components["schemas"]["payment_method_details_afterpay_clearpay"]; - alipay?: components["schemas"]["payment_flows_private_payment_methods_alipay_details"]; - au_becs_debit?: components["schemas"]["payment_method_details_au_becs_debit"]; - bacs_debit?: components["schemas"]["payment_method_details_bacs_debit"]; - bancontact?: components["schemas"]["payment_method_details_bancontact"]; - boleto?: components["schemas"]["payment_method_details_boleto"]; - card?: components["schemas"]["payment_method_details_card"]; - card_present?: components["schemas"]["payment_method_details_card_present"]; - eps?: components["schemas"]["payment_method_details_eps"]; - fpx?: components["schemas"]["payment_method_details_fpx"]; - giropay?: components["schemas"]["payment_method_details_giropay"]; - grabpay?: components["schemas"]["payment_method_details_grabpay"]; - ideal?: components["schemas"]["payment_method_details_ideal"]; - interac_present?: components["schemas"]["payment_method_details_interac_present"]; - klarna?: components["schemas"]["payment_method_details_klarna"]; - multibanco?: components["schemas"]["payment_method_details_multibanco"]; - oxxo?: components["schemas"]["payment_method_details_oxxo"]; - p24?: components["schemas"]["payment_method_details_p24"]; - sepa_debit?: components["schemas"]["payment_method_details_sepa_debit"]; - sofort?: components["schemas"]["payment_method_details_sofort"]; - stripe_account?: components["schemas"]["payment_method_details_stripe_account"]; + ach_credit_transfer?: components['schemas']['payment_method_details_ach_credit_transfer'] + ach_debit?: components['schemas']['payment_method_details_ach_debit'] + acss_debit?: components['schemas']['payment_method_details_acss_debit'] + afterpay_clearpay?: components['schemas']['payment_method_details_afterpay_clearpay'] + alipay?: components['schemas']['payment_flows_private_payment_methods_alipay_details'] + au_becs_debit?: components['schemas']['payment_method_details_au_becs_debit'] + bacs_debit?: components['schemas']['payment_method_details_bacs_debit'] + bancontact?: components['schemas']['payment_method_details_bancontact'] + boleto?: components['schemas']['payment_method_details_boleto'] + card?: components['schemas']['payment_method_details_card'] + card_present?: components['schemas']['payment_method_details_card_present'] + eps?: components['schemas']['payment_method_details_eps'] + fpx?: components['schemas']['payment_method_details_fpx'] + giropay?: components['schemas']['payment_method_details_giropay'] + grabpay?: components['schemas']['payment_method_details_grabpay'] + ideal?: components['schemas']['payment_method_details_ideal'] + interac_present?: components['schemas']['payment_method_details_interac_present'] + klarna?: components['schemas']['payment_method_details_klarna'] + multibanco?: components['schemas']['payment_method_details_multibanco'] + oxxo?: components['schemas']['payment_method_details_oxxo'] + p24?: components['schemas']['payment_method_details_p24'] + sepa_debit?: components['schemas']['payment_method_details_sepa_debit'] + sofort?: components['schemas']['payment_method_details_sofort'] + stripe_account?: components['schemas']['payment_method_details_stripe_account'] /** * @description The type of transaction-specific details of the payment method used in the payment, one of `ach_credit_transfer`, `ach_debit`, `acss_debit`, `alipay`, `au_becs_debit`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `klarna`, `multibanco`, `p24`, `sepa_debit`, `sofort`, `stripe_account`, or `wechat`. * An additional hash is included on `payment_method_details` with a name matching this value. * It contains information specific to the payment method. */ - type: string; - wechat?: components["schemas"]["payment_method_details_wechat"]; - wechat_pay?: components["schemas"]["payment_method_details_wechat_pay"]; - }; + type: string + wechat?: components['schemas']['payment_method_details_wechat'] + wechat_pay?: components['schemas']['payment_method_details_wechat_pay'] + } /** payment_method_details_ach_credit_transfer */ payment_method_details_ach_credit_transfer: { /** @description Account number to transfer funds to. */ - account_number?: string | null; + account_number?: string | null /** @description Name of the bank associated with the routing number. */ - bank_name?: string | null; + bank_name?: string | null /** @description Routing transit number for the bank account to transfer funds to. */ - routing_number?: string | null; + routing_number?: string | null /** @description SWIFT code of the bank associated with the routing number. */ - swift_code?: string | null; - }; + swift_code?: string | null + } /** payment_method_details_ach_debit */ payment_method_details_ach_debit: { /** * @description Type of entity that holds the account. This can be either `individual` or `company`. * @enum {string|null} */ - account_holder_type?: ("company" | "individual") | null; + account_holder_type?: ('company' | 'individual') | null /** @description Name of the bank associated with the bank account. */ - bank_name?: string | null; + bank_name?: string | null /** @description Two-letter ISO code representing the country the bank account is located in. */ - country?: string | null; + country?: string | null /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Last four digits of the bank account number. */ - last4?: string | null; + last4?: string | null /** @description Routing transit number of the bank account. */ - routing_number?: string | null; - }; + routing_number?: string | null + } /** payment_method_details_acss_debit */ payment_method_details_acss_debit: { /** @description Name of the bank associated with the bank account. */ - bank_name?: string | null; + bank_name?: string | null /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Institution number of the bank account */ - institution_number?: string | null; + institution_number?: string | null /** @description Last four digits of the bank account number. */ - last4?: string | null; + last4?: string | null /** @description ID of the mandate used to make this payment. */ - mandate?: string; + mandate?: string /** @description Transit number of the bank account. */ - transit_number?: string | null; - }; + transit_number?: string | null + } /** payment_method_details_afterpay_clearpay */ payment_method_details_afterpay_clearpay: { /** @description Order identifier shown to the merchant in Afterpay’s online portal. */ - reference?: string | null; - }; + reference?: string | null + } /** payment_method_details_au_becs_debit */ payment_method_details_au_becs_debit: { /** @description Bank-State-Branch number of the bank account. */ - bsb_number?: string | null; + bsb_number?: string | null /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Last four digits of the bank account number. */ - last4?: string | null; + last4?: string | null /** @description ID of the mandate used to make this payment. */ - mandate?: string; - }; + mandate?: string + } /** payment_method_details_bacs_debit */ payment_method_details_bacs_debit: { /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Last four digits of the bank account number. */ - last4?: string | null; + last4?: string | null /** @description ID of the mandate used to make this payment. */ - mandate?: string | null; + mandate?: string | null /** @description Sort code of the bank account. (e.g., `10-20-30`) */ - sort_code?: string | null; - }; + sort_code?: string | null + } /** payment_method_details_bancontact */ payment_method_details_bancontact: { /** @description Bank code of bank associated with the bank account. */ - bank_code?: string | null; + bank_code?: string | null /** @description Name of the bank associated with the bank account. */ - bank_name?: string | null; + bank_name?: string | null /** @description Bank Identifier Code of the bank associated with the bank account. */ - bic?: string | null; + bic?: string | null /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ - generated_sepa_debit?: (Partial & Partial) | null; + generated_sepa_debit?: (Partial & Partial) | null /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ - generated_sepa_debit_mandate?: (Partial & Partial) | null; + generated_sepa_debit_mandate?: (Partial & Partial) | null /** @description Last four characters of the IBAN. */ - iban_last4?: string | null; + iban_last4?: string | null /** * @description Preferred language of the Bancontact authorization page that the customer is redirected to. * Can be one of `en`, `de`, `fr`, or `nl` * @enum {string|null} */ - preferred_language?: ("de" | "en" | "fr" | "nl") | null; + preferred_language?: ('de' | 'en' | 'fr' | 'nl') | null /** * @description Owner's verified full name. Values are verified or provided by Bancontact directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - verified_name?: string | null; - }; + verified_name?: string | null + } /** payment_method_details_boleto */ payment_method_details_boleto: { /** @description The tax ID of the customer (CPF for individuals consumers or CNPJ for businesses consumers) */ - tax_id: string; - }; + tax_id: string + } /** payment_method_details_card */ payment_method_details_card: { /** @description Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ - brand?: string | null; + brand?: string | null /** @description Check results by Card networks on Card address and CVC at time of payment. */ - checks?: Partial | null; + checks?: Partial | null /** @description 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?: string | null; + country?: string | null /** @description Two-digit number representing the card's expiration month. */ - exp_month: number; + exp_month: number /** @description Four-digit number representing the card's expiration year. */ - exp_year: number; + exp_year: number /** * @description 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. * * *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.* */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ - funding?: string | null; + funding?: string | null /** * @description Installment details for this payment (Mexico only). * * For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments). */ - installments?: Partial | null; + installments?: Partial | null /** @description The last four digits of the card. */ - last4?: string | null; + last4?: string | null /** @description Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ - network?: string | null; + network?: string | null /** @description Populated if this transaction used 3D Secure authentication. */ - three_d_secure?: Partial | null; + three_d_secure?: Partial | null /** @description If this Card is part of a card wallet, this contains the details of the card wallet. */ - wallet?: Partial | null; - }; + wallet?: Partial | null + } /** payment_method_details_card_checks */ payment_method_details_card_checks: { /** @description If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ - address_line1_check?: string | null; + address_line1_check?: string | null /** @description If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ - address_postal_code_check?: string | null; + address_postal_code_check?: string | null /** @description If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ - cvc_check?: string | null; - }; + cvc_check?: string | null + } /** payment_method_details_card_installments */ payment_method_details_card_installments: { /** @description Installment plan selected for the payment. */ - plan?: Partial | null; - }; + plan?: Partial | null + } /** payment_method_details_card_installments_plan */ payment_method_details_card_installments_plan: { /** @description For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card. */ - count?: number | null; + count?: number | null /** * @description For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card. * One of `month`. * @enum {string|null} */ - interval?: "month" | null; + interval?: 'month' | null /** * @description Type of installment plan, one of `fixed_count`. * @enum {string} */ - type: "fixed_count"; - }; + type: 'fixed_count' + } /** payment_method_details_card_present */ payment_method_details_card_present: { /** @description The authorized amount */ - amount_authorized?: number | null; + amount_authorized?: number | null /** @description Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ - brand?: string | null; + brand?: string | null /** @description 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?: string | null; + cardholder_name?: string | null /** @description 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?: string | null; + country?: string | null /** @description Authorization response cryptogram. */ - emv_auth_data?: string | null; + emv_auth_data?: string | null /** @description Two-digit number representing the card's expiration month. */ - exp_month: number; + exp_month: number /** @description Four-digit number representing the card's expiration year. */ - exp_year: number; + exp_year: number /** * @description 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. * * *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.* */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ - funding?: string | null; + funding?: string | null /** @description 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?: string | null; + generated_card?: string | null /** @description The last four digits of the card. */ - last4?: string | null; + last4?: string | null /** @description Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ - network?: string | null; + network?: string | null /** @description Defines whether the authorized amount can be over-captured or not */ - overcapture_supported?: boolean | null; + overcapture_supported?: boolean | null /** * @description How card details were read in this transaction. * @enum {string|null} */ - read_method?: - | ( - | "contact_emv" - | "contactless_emv" - | "contactless_magstripe_mode" - | "magnetic_stripe_fallback" - | "magnetic_stripe_track2" - ) - | null; + read_method?: ('contact_emv' | 'contactless_emv' | 'contactless_magstripe_mode' | 'magnetic_stripe_fallback' | 'magnetic_stripe_track2') | null /** @description A collection of fields required to be displayed on receipts. Only required for EMV transactions. */ - receipt?: Partial | null; - }; + receipt?: Partial | null + } /** payment_method_details_card_present_receipt */ payment_method_details_card_present_receipt: { /** * @description The type of account being debited or credited * @enum {string} */ - account_type?: "checking" | "credit" | "prepaid" | "unknown"; + account_type?: 'checking' | 'credit' | 'prepaid' | 'unknown' /** @description EMV tag 9F26, cryptogram generated by the integrated circuit chip. */ - application_cryptogram?: string | null; + application_cryptogram?: string | null /** @description Mnenomic of the Application Identifier. */ - application_preferred_name?: string | null; + application_preferred_name?: string | null /** @description Identifier for this transaction. */ - authorization_code?: string | null; + authorization_code?: string | null /** @description EMV tag 8A. A code returned by the card issuer. */ - authorization_response_code?: string | null; + authorization_response_code?: string | null /** @description How the cardholder verified ownership of the card. */ - cardholder_verification_method?: string | null; + cardholder_verification_method?: string | null /** @description EMV tag 84. Similar to the application identifier stored on the integrated circuit chip. */ - dedicated_file_name?: string | null; + dedicated_file_name?: string | null /** @description The outcome of a series of EMV functions performed by the card reader. */ - terminal_verification_results?: string | null; + terminal_verification_results?: string | null /** @description An indication of various EMV functions performed during the transaction. */ - transaction_status_information?: string | null; - }; + transaction_status_information?: string | null + } /** payment_method_details_card_wallet */ payment_method_details_card_wallet: { - amex_express_checkout?: components["schemas"]["payment_method_details_card_wallet_amex_express_checkout"]; - apple_pay?: components["schemas"]["payment_method_details_card_wallet_apple_pay"]; + amex_express_checkout?: components['schemas']['payment_method_details_card_wallet_amex_express_checkout'] + apple_pay?: components['schemas']['payment_method_details_card_wallet_apple_pay'] /** @description (For tokenized numbers only.) The last four digits of the device account number. */ - dynamic_last4?: string | null; - google_pay?: components["schemas"]["payment_method_details_card_wallet_google_pay"]; - masterpass?: components["schemas"]["payment_method_details_card_wallet_masterpass"]; - samsung_pay?: components["schemas"]["payment_method_details_card_wallet_samsung_pay"]; + dynamic_last4?: string | null + google_pay?: components['schemas']['payment_method_details_card_wallet_google_pay'] + masterpass?: components['schemas']['payment_method_details_card_wallet_masterpass'] + samsung_pay?: components['schemas']['payment_method_details_card_wallet_samsung_pay'] /** * @description The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, or `visa_checkout`. 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. * @enum {string} */ - type: "amex_express_checkout" | "apple_pay" | "google_pay" | "masterpass" | "samsung_pay" | "visa_checkout"; - visa_checkout?: components["schemas"]["payment_method_details_card_wallet_visa_checkout"]; - }; + type: 'amex_express_checkout' | 'apple_pay' | 'google_pay' | 'masterpass' | 'samsung_pay' | 'visa_checkout' + visa_checkout?: components['schemas']['payment_method_details_card_wallet_visa_checkout'] + } /** payment_method_details_card_wallet_amex_express_checkout */ - payment_method_details_card_wallet_amex_express_checkout: { [key: string]: unknown }; + payment_method_details_card_wallet_amex_express_checkout: { [key: string]: unknown } /** payment_method_details_card_wallet_apple_pay */ - payment_method_details_card_wallet_apple_pay: { [key: string]: unknown }; + payment_method_details_card_wallet_apple_pay: { [key: string]: unknown } /** payment_method_details_card_wallet_google_pay */ - payment_method_details_card_wallet_google_pay: { [key: string]: unknown }; + payment_method_details_card_wallet_google_pay: { [key: string]: unknown } /** payment_method_details_card_wallet_masterpass */ payment_method_details_card_wallet_masterpass: { /** @description 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?: Partial | null; + billing_address?: Partial | null /** @description 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?: string | null; + email?: string | null /** @description 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?: string | null; + name?: string | null /** @description 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?: Partial | null; - }; + shipping_address?: Partial | null + } /** payment_method_details_card_wallet_samsung_pay */ - payment_method_details_card_wallet_samsung_pay: { [key: string]: unknown }; + payment_method_details_card_wallet_samsung_pay: { [key: string]: unknown } /** payment_method_details_card_wallet_visa_checkout */ payment_method_details_card_wallet_visa_checkout: { /** @description 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?: Partial | null; + billing_address?: Partial | null /** @description 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?: string | null; + email?: string | null /** @description 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?: string | null; + name?: string | null /** @description 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?: Partial | null; - }; + shipping_address?: Partial | null + } /** payment_method_details_eps */ payment_method_details_eps: { /** @@ -10069,42 +9957,42 @@ export type components = { */ bank?: | ( - | "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" - | "dolomitenbank" - | "easybank_ag" - | "erste_bank_und_sparkassen" - | "hypo_alpeadriabank_international_ag" - | "hypo_bank_burgenland_aktiengesellschaft" - | "hypo_noe_lb_fur_niederosterreich_u_wien" - | "hypo_oberosterreich_salzburg_steiermark" - | "hypo_tirol_bank_ag" - | "hypo_vorarlberg_bank_ag" - | "marchfelder_bank" - | "oberbank_ag" - | "raiffeisen_bankengruppe_osterreich" - | "schoellerbank_ag" - | "sparda_bank_wien" - | "volksbank_gruppe" - | "volkskreditbank_ag" - | "vr_bank_braunau" + | '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' + | 'dolomitenbank' + | 'easybank_ag' + | 'erste_bank_und_sparkassen' + | 'hypo_alpeadriabank_international_ag' + | 'hypo_bank_burgenland_aktiengesellschaft' + | 'hypo_noe_lb_fur_niederosterreich_u_wien' + | 'hypo_oberosterreich_salzburg_steiermark' + | 'hypo_tirol_bank_ag' + | 'hypo_vorarlberg_bank_ag' + | 'marchfelder_bank' + | 'oberbank_ag' + | 'raiffeisen_bankengruppe_osterreich' + | 'schoellerbank_ag' + | 'sparda_bank_wien' + | 'volksbank_gruppe' + | 'volkskreditbank_ag' + | 'vr_bank_braunau' ) - | null; + | null /** * @description Owner's verified full name. Values are verified or provided by EPS directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. * EPS rarely provides this information so the attribute is usually empty. */ - verified_name?: string | null; - }; + verified_name?: string | null + } /** payment_method_details_fpx */ payment_method_details_fpx: { /** @@ -10112,50 +10000,50 @@ export type components = { * @enum {string} */ bank: - | "affin_bank" - | "agrobank" - | "alliance_bank" - | "ambank" - | "bank_islam" - | "bank_muamalat" - | "bank_rakyat" - | "bsn" - | "cimb" - | "deutsche_bank" - | "hong_leong_bank" - | "hsbc" - | "kfh" - | "maybank2e" - | "maybank2u" - | "ocbc" - | "pb_enterprise" - | "public_bank" - | "rhb" - | "standard_chartered" - | "uob"; + | 'affin_bank' + | 'agrobank' + | 'alliance_bank' + | 'ambank' + | 'bank_islam' + | 'bank_muamalat' + | 'bank_rakyat' + | 'bsn' + | 'cimb' + | 'deutsche_bank' + | 'hong_leong_bank' + | 'hsbc' + | 'kfh' + | 'maybank2e' + | 'maybank2u' + | 'ocbc' + | 'pb_enterprise' + | 'public_bank' + | 'rhb' + | 'standard_chartered' + | 'uob' /** @description Unique transaction id generated by FPX for every request from the merchant */ - transaction_id?: string | null; - }; + transaction_id?: string | null + } /** payment_method_details_giropay */ payment_method_details_giropay: { /** @description Bank code of bank associated with the bank account. */ - bank_code?: string | null; + bank_code?: string | null /** @description Name of the bank associated with the bank account. */ - bank_name?: string | null; + bank_name?: string | null /** @description Bank Identifier Code of the bank associated with the bank account. */ - bic?: string | null; + bic?: string | null /** * @description Owner's verified full name. Values are verified or provided by Giropay directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. * Giropay rarely provides this information so the attribute is usually empty. */ - verified_name?: string | null; - }; + verified_name?: string | null + } /** payment_method_details_grabpay */ payment_method_details_grabpay: { /** @description Unique transaction id generated by GrabPay */ - transaction_id?: string | null; - }; + transaction_id?: string | null + } /** payment_method_details_ideal */ payment_method_details_ideal: { /** @@ -10164,149 +10052,141 @@ export type components = { */ bank?: | ( - | "abn_amro" - | "asn_bank" - | "bunq" - | "handelsbanken" - | "ing" - | "knab" - | "moneyou" - | "rabobank" - | "regiobank" - | "revolut" - | "sns_bank" - | "triodos_bank" - | "van_lanschot" + | 'abn_amro' + | 'asn_bank' + | 'bunq' + | 'handelsbanken' + | 'ing' + | 'knab' + | 'moneyou' + | 'rabobank' + | 'regiobank' + | 'revolut' + | 'sns_bank' + | 'triodos_bank' + | 'van_lanschot' ) - | null; + | null /** * @description The Bank Identifier Code of the customer's bank. * @enum {string|null} */ bic?: | ( - | "ABNANL2A" - | "ASNBNL21" - | "BUNQNL2A" - | "FVLBNL22" - | "HANDNL2A" - | "INGBNL2A" - | "KNABNL2H" - | "MOYONL21" - | "RABONL2U" - | "RBRBNL21" - | "REVOLT21" - | "SNSBNL2A" - | "TRIONL2U" + | 'ABNANL2A' + | 'ASNBNL21' + | 'BUNQNL2A' + | 'FVLBNL22' + | 'HANDNL2A' + | 'INGBNL2A' + | 'KNABNL2H' + | 'MOYONL21' + | 'RABONL2U' + | 'RBRBNL21' + | 'REVOLT21' + | 'SNSBNL2A' + | 'TRIONL2U' ) - | null; + | null /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ - generated_sepa_debit?: (Partial & Partial) | null; + generated_sepa_debit?: (Partial & Partial) | null /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ - generated_sepa_debit_mandate?: (Partial & Partial) | null; + generated_sepa_debit_mandate?: (Partial & Partial) | null /** @description Last four characters of the IBAN. */ - iban_last4?: string | null; + iban_last4?: string | null /** * @description Owner's verified full name. Values are verified or provided by iDEAL directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - verified_name?: string | null; - }; + verified_name?: string | null + } /** payment_method_details_interac_present */ payment_method_details_interac_present: { /** @description Card brand. Can be `interac`, `mastercard` or `visa`. */ - brand?: string | null; + brand?: string | null /** @description 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?: string | null; + cardholder_name?: string | null /** @description 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?: string | null; + country?: string | null /** @description Authorization response cryptogram. */ - emv_auth_data?: string | null; + emv_auth_data?: string | null /** @description Two-digit number representing the card's expiration month. */ - exp_month: number; + exp_month: number /** @description Four-digit number representing the card's expiration year. */ - exp_year: number; + exp_year: number /** * @description 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. * * *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.* */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ - funding?: string | null; + funding?: string | null /** @description 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?: string | null; + generated_card?: string | null /** @description The last four digits of the card. */ - last4?: string | null; + last4?: string | null /** @description Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ - network?: string | null; + network?: string | null /** @description EMV tag 5F2D. Preferred languages specified by the integrated circuit chip. */ - preferred_locales?: string[] | null; + preferred_locales?: string[] | null /** * @description How card details were read in this transaction. * @enum {string|null} */ - read_method?: - | ( - | "contact_emv" - | "contactless_emv" - | "contactless_magstripe_mode" - | "magnetic_stripe_fallback" - | "magnetic_stripe_track2" - ) - | null; + read_method?: ('contact_emv' | 'contactless_emv' | 'contactless_magstripe_mode' | 'magnetic_stripe_fallback' | 'magnetic_stripe_track2') | null /** @description A collection of fields required to be displayed on receipts. Only required for EMV transactions. */ - receipt?: Partial | null; - }; + receipt?: Partial | null + } /** payment_method_details_interac_present_receipt */ payment_method_details_interac_present_receipt: { /** * @description The type of account being debited or credited * @enum {string} */ - account_type?: "checking" | "savings" | "unknown"; + account_type?: 'checking' | 'savings' | 'unknown' /** @description EMV tag 9F26, cryptogram generated by the integrated circuit chip. */ - application_cryptogram?: string | null; + application_cryptogram?: string | null /** @description Mnenomic of the Application Identifier. */ - application_preferred_name?: string | null; + application_preferred_name?: string | null /** @description Identifier for this transaction. */ - authorization_code?: string | null; + authorization_code?: string | null /** @description EMV tag 8A. A code returned by the card issuer. */ - authorization_response_code?: string | null; + authorization_response_code?: string | null /** @description How the cardholder verified ownership of the card. */ - cardholder_verification_method?: string | null; + cardholder_verification_method?: string | null /** @description EMV tag 84. Similar to the application identifier stored on the integrated circuit chip. */ - dedicated_file_name?: string | null; + dedicated_file_name?: string | null /** @description The outcome of a series of EMV functions performed by the card reader. */ - terminal_verification_results?: string | null; + terminal_verification_results?: string | null /** @description An indication of various EMV functions performed during the transaction. */ - transaction_status_information?: string | null; - }; + transaction_status_information?: string | null + } /** payment_method_details_klarna */ payment_method_details_klarna: { /** * @description The Klarna payment method used for this transaction. * Can be one of `pay_later`, `pay_now`, `pay_with_financing`, or `pay_in_installments` */ - payment_method_category?: string | null; + payment_method_category?: string | null /** * @description Preferred language of the Klarna authorization page that the customer is redirected to. * Can 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`, or `en-FR` */ - preferred_locale?: string | null; - }; + preferred_locale?: string | null + } /** payment_method_details_multibanco */ payment_method_details_multibanco: { /** @description Entity number associated with this Multibanco payment. */ - entity?: string | null; + entity?: string | null /** @description Reference number associated with this Multibanco payment. */ - reference?: string | null; - }; + reference?: string | null + } /** payment_method_details_oxxo */ payment_method_details_oxxo: { /** @description OXXO reference number */ - number?: string | null; - }; + number?: string | null + } /** payment_method_details_p24 */ payment_method_details_p24: { /** @@ -10315,96 +10195,96 @@ export type components = { */ bank?: | ( - | "alior_bank" - | "bank_millennium" - | "bank_nowy_bfg_sa" - | "bank_pekao_sa" - | "banki_spbdzielcze" - | "blik" - | "bnp_paribas" - | "boz" - | "citi_handlowy" - | "credit_agricole" - | "envelobank" - | "etransfer_pocztowy24" - | "getin_bank" - | "ideabank" - | "ing" - | "inteligo" - | "mbank_mtransfer" - | "nest_przelew" - | "noble_pay" - | "pbac_z_ipko" - | "plus_bank" - | "santander_przelew24" - | "tmobile_usbugi_bankowe" - | "toyota_bank" - | "volkswagen_bank" + | 'alior_bank' + | 'bank_millennium' + | 'bank_nowy_bfg_sa' + | 'bank_pekao_sa' + | 'banki_spbdzielcze' + | 'blik' + | 'bnp_paribas' + | 'boz' + | 'citi_handlowy' + | 'credit_agricole' + | 'envelobank' + | 'etransfer_pocztowy24' + | 'getin_bank' + | 'ideabank' + | 'ing' + | 'inteligo' + | 'mbank_mtransfer' + | 'nest_przelew' + | 'noble_pay' + | 'pbac_z_ipko' + | 'plus_bank' + | 'santander_przelew24' + | 'tmobile_usbugi_bankowe' + | 'toyota_bank' + | 'volkswagen_bank' ) - | null; + | null /** @description Unique reference for this Przelewy24 payment. */ - reference?: string | null; + reference?: string | null /** * @description Owner's verified full name. Values are verified or provided by Przelewy24 directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. * Przelewy24 rarely provides this information so the attribute is usually empty. */ - verified_name?: string | null; - }; + verified_name?: string | null + } /** payment_method_details_sepa_debit */ payment_method_details_sepa_debit: { /** @description Bank code of bank associated with the bank account. */ - bank_code?: string | null; + bank_code?: string | null /** @description Branch code of bank associated with the bank account. */ - branch_code?: string | null; + branch_code?: string | null /** @description Two-letter ISO code representing the country the bank account is located in. */ - country?: string | null; + country?: string | null /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Last four characters of the IBAN. */ - last4?: string | null; + last4?: string | null /** @description ID of the mandate used to make this payment. */ - mandate?: string | null; - }; + mandate?: string | null + } /** payment_method_details_sofort */ payment_method_details_sofort: { /** @description Bank code of bank associated with the bank account. */ - bank_code?: string | null; + bank_code?: string | null /** @description Name of the bank associated with the bank account. */ - bank_name?: string | null; + bank_name?: string | null /** @description Bank Identifier Code of the bank associated with the bank account. */ - bic?: string | null; + bic?: string | null /** @description Two-letter ISO code representing the country the bank account is located in. */ - country?: string | null; + country?: string | null /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ - generated_sepa_debit?: (Partial & Partial) | null; + generated_sepa_debit?: (Partial & Partial) | null /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ - generated_sepa_debit_mandate?: (Partial & Partial) | null; + generated_sepa_debit_mandate?: (Partial & Partial) | null /** @description Last four characters of the IBAN. */ - iban_last4?: string | null; + iban_last4?: string | null /** * @description Preferred language of the SOFORT authorization page that the customer is redirected to. * Can be one of `de`, `en`, `es`, `fr`, `it`, `nl`, or `pl` * @enum {string|null} */ - preferred_language?: ("de" | "en" | "es" | "fr" | "it" | "nl" | "pl") | null; + preferred_language?: ('de' | 'en' | 'es' | 'fr' | 'it' | 'nl' | 'pl') | null /** * @description Owner's verified full name. Values are verified or provided by SOFORT directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - verified_name?: string | null; - }; + verified_name?: string | null + } /** payment_method_details_stripe_account */ - payment_method_details_stripe_account: { [key: string]: unknown }; + payment_method_details_stripe_account: { [key: string]: unknown } /** payment_method_details_wechat */ - payment_method_details_wechat: { [key: string]: unknown }; + payment_method_details_wechat: { [key: string]: unknown } /** payment_method_details_wechat_pay */ payment_method_details_wechat_pay: { /** @description Uniquely identifies this particular WeChat Pay account. You can use this attribute to check whether two WeChat accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Transaction ID of this particular WeChat Pay transaction. */ - transaction_id?: string | null; - }; + transaction_id?: string | null + } /** payment_method_eps */ payment_method_eps: { /** @@ -10413,36 +10293,36 @@ export type components = { */ bank?: | ( - | "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" - | "dolomitenbank" - | "easybank_ag" - | "erste_bank_und_sparkassen" - | "hypo_alpeadriabank_international_ag" - | "hypo_bank_burgenland_aktiengesellschaft" - | "hypo_noe_lb_fur_niederosterreich_u_wien" - | "hypo_oberosterreich_salzburg_steiermark" - | "hypo_tirol_bank_ag" - | "hypo_vorarlberg_bank_ag" - | "marchfelder_bank" - | "oberbank_ag" - | "raiffeisen_bankengruppe_osterreich" - | "schoellerbank_ag" - | "sparda_bank_wien" - | "volksbank_gruppe" - | "volkskreditbank_ag" - | "vr_bank_braunau" + | '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' + | 'dolomitenbank' + | 'easybank_ag' + | 'erste_bank_und_sparkassen' + | 'hypo_alpeadriabank_international_ag' + | 'hypo_bank_burgenland_aktiengesellschaft' + | 'hypo_noe_lb_fur_niederosterreich_u_wien' + | 'hypo_oberosterreich_salzburg_steiermark' + | 'hypo_tirol_bank_ag' + | 'hypo_vorarlberg_bank_ag' + | 'marchfelder_bank' + | 'oberbank_ag' + | 'raiffeisen_bankengruppe_osterreich' + | 'schoellerbank_ag' + | 'sparda_bank_wien' + | 'volksbank_gruppe' + | 'volkskreditbank_ag' + | 'vr_bank_braunau' ) - | null; - }; + | null + } /** payment_method_fpx */ payment_method_fpx: { /** @@ -10450,32 +10330,32 @@ export type components = { * @enum {string} */ bank: - | "affin_bank" - | "agrobank" - | "alliance_bank" - | "ambank" - | "bank_islam" - | "bank_muamalat" - | "bank_rakyat" - | "bsn" - | "cimb" - | "deutsche_bank" - | "hong_leong_bank" - | "hsbc" - | "kfh" - | "maybank2e" - | "maybank2u" - | "ocbc" - | "pb_enterprise" - | "public_bank" - | "rhb" - | "standard_chartered" - | "uob"; - }; + | 'affin_bank' + | 'agrobank' + | 'alliance_bank' + | 'ambank' + | 'bank_islam' + | 'bank_muamalat' + | 'bank_rakyat' + | 'bsn' + | 'cimb' + | 'deutsche_bank' + | 'hong_leong_bank' + | 'hsbc' + | 'kfh' + | 'maybank2e' + | 'maybank2u' + | 'ocbc' + | 'pb_enterprise' + | 'public_bank' + | 'rhb' + | 'standard_chartered' + | 'uob' + } /** payment_method_giropay */ - payment_method_giropay: { [key: string]: unknown }; + payment_method_giropay: { [key: string]: unknown } /** payment_method_grabpay */ - payment_method_grabpay: { [key: string]: unknown }; + payment_method_grabpay: { [key: string]: unknown } /** payment_method_ideal */ payment_method_ideal: { /** @@ -10484,128 +10364,128 @@ export type components = { */ bank?: | ( - | "abn_amro" - | "asn_bank" - | "bunq" - | "handelsbanken" - | "ing" - | "knab" - | "moneyou" - | "rabobank" - | "regiobank" - | "revolut" - | "sns_bank" - | "triodos_bank" - | "van_lanschot" + | 'abn_amro' + | 'asn_bank' + | 'bunq' + | 'handelsbanken' + | 'ing' + | 'knab' + | 'moneyou' + | 'rabobank' + | 'regiobank' + | 'revolut' + | 'sns_bank' + | 'triodos_bank' + | 'van_lanschot' ) - | null; + | null /** * @description The Bank Identifier Code of the customer's bank, if the bank was provided. * @enum {string|null} */ bic?: | ( - | "ABNANL2A" - | "ASNBNL21" - | "BUNQNL2A" - | "FVLBNL22" - | "HANDNL2A" - | "INGBNL2A" - | "KNABNL2H" - | "MOYONL21" - | "RABONL2U" - | "RBRBNL21" - | "REVOLT21" - | "SNSBNL2A" - | "TRIONL2U" + | 'ABNANL2A' + | 'ASNBNL21' + | 'BUNQNL2A' + | 'FVLBNL22' + | 'HANDNL2A' + | 'INGBNL2A' + | 'KNABNL2H' + | 'MOYONL21' + | 'RABONL2U' + | 'RBRBNL21' + | 'REVOLT21' + | 'SNSBNL2A' + | 'TRIONL2U' ) - | null; - }; + | null + } /** payment_method_interac_present */ - payment_method_interac_present: { [key: string]: unknown }; + payment_method_interac_present: { [key: string]: unknown } /** payment_method_klarna */ payment_method_klarna: { /** @description The customer's date of birth, if provided. */ - dob?: Partial | null; - }; + dob?: Partial | null + } /** payment_method_options_afterpay_clearpay */ payment_method_options_afterpay_clearpay: { /** * @description Order identifier shown to the merchant in Afterpay’s online portal. We recommend using a value that helps you answer any questions a customer might have about * the payment. The identifier is limited to 128 characters and may contain only letters, digits, underscores, backslashes and dashes. */ - reference?: string | null; - }; + reference?: string | null + } /** payment_method_options_alipay */ - payment_method_options_alipay: { [key: string]: unknown }; + payment_method_options_alipay: { [key: string]: unknown } /** payment_method_options_bacs_debit */ - payment_method_options_bacs_debit: { [key: string]: unknown }; + payment_method_options_bacs_debit: { [key: string]: unknown } /** payment_method_options_bancontact */ payment_method_options_bancontact: { /** * @description Preferred language of the Bancontact authorization page that the customer is redirected to. * @enum {string} */ - preferred_language: "de" | "en" | "fr" | "nl"; - }; + preferred_language: 'de' | 'en' | 'fr' | 'nl' + } /** payment_method_options_boleto */ payment_method_options_boleto: { /** @description 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: number; - }; + expires_after_days: number + } /** payment_method_options_card_installments */ payment_method_options_card_installments: { /** @description Installment plans that may be selected for this PaymentIntent. */ - available_plans?: components["schemas"]["payment_method_details_card_installments_plan"][] | null; + available_plans?: components['schemas']['payment_method_details_card_installments_plan'][] | null /** @description Whether Installments are enabled for this PaymentIntent. */ - enabled: boolean; + enabled: boolean /** @description Installment plan selected for this PaymentIntent. */ - plan?: Partial | null; - }; + plan?: Partial | null + } /** payment_method_options_card_present */ - payment_method_options_card_present: { [key: string]: unknown }; + payment_method_options_card_present: { [key: string]: unknown } /** payment_method_options_fpx */ - payment_method_options_fpx: { [key: string]: unknown }; + payment_method_options_fpx: { [key: string]: unknown } /** payment_method_options_giropay */ - payment_method_options_giropay: { [key: string]: unknown }; + payment_method_options_giropay: { [key: string]: unknown } /** payment_method_options_grabpay */ - payment_method_options_grabpay: { [key: string]: unknown }; + payment_method_options_grabpay: { [key: string]: unknown } /** payment_method_options_ideal */ - payment_method_options_ideal: { [key: string]: unknown }; + payment_method_options_ideal: { [key: string]: unknown } /** payment_method_options_interac_present */ - payment_method_options_interac_present: { [key: string]: unknown }; + payment_method_options_interac_present: { [key: string]: unknown } /** payment_method_options_klarna */ payment_method_options_klarna: { /** @description Preferred locale of the Klarna checkout page that the customer is redirected to. */ - preferred_locale?: string | null; - }; + preferred_locale?: string | null + } /** payment_method_options_oxxo */ payment_method_options_oxxo: { /** @description 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: number; - }; + expires_after_days: number + } /** payment_method_options_p24 */ - payment_method_options_p24: { [key: string]: unknown }; + payment_method_options_p24: { [key: string]: unknown } /** payment_method_options_sofort */ payment_method_options_sofort: { /** * @description Preferred language of the SOFORT authorization page that the customer is redirected to. * @enum {string|null} */ - preferred_language?: ("de" | "en" | "es" | "fr" | "it" | "nl" | "pl") | null; - }; + preferred_language?: ('de' | 'en' | 'es' | 'fr' | 'it' | 'nl' | 'pl') | null + } /** payment_method_options_wechat_pay */ payment_method_options_wechat_pay: { /** @description The app ID registered with WeChat Pay. Only required when client is ios or android. */ - app_id?: string | null; + app_id?: string | null /** * @description The client type that the end customer will pay from * @enum {string|null} */ - client?: ("android" | "ios" | "web") | null; - }; + client?: ('android' | 'ios' | 'web') | null + } /** payment_method_oxxo */ - payment_method_oxxo: { [key: string]: unknown }; + payment_method_oxxo: { [key: string]: unknown } /** payment_method_p24 */ payment_method_p24: { /** @@ -10614,89 +10494,89 @@ export type components = { */ bank?: | ( - | "alior_bank" - | "bank_millennium" - | "bank_nowy_bfg_sa" - | "bank_pekao_sa" - | "banki_spbdzielcze" - | "blik" - | "bnp_paribas" - | "boz" - | "citi_handlowy" - | "credit_agricole" - | "envelobank" - | "etransfer_pocztowy24" - | "getin_bank" - | "ideabank" - | "ing" - | "inteligo" - | "mbank_mtransfer" - | "nest_przelew" - | "noble_pay" - | "pbac_z_ipko" - | "plus_bank" - | "santander_przelew24" - | "tmobile_usbugi_bankowe" - | "toyota_bank" - | "volkswagen_bank" + | 'alior_bank' + | 'bank_millennium' + | 'bank_nowy_bfg_sa' + | 'bank_pekao_sa' + | 'banki_spbdzielcze' + | 'blik' + | 'bnp_paribas' + | 'boz' + | 'citi_handlowy' + | 'credit_agricole' + | 'envelobank' + | 'etransfer_pocztowy24' + | 'getin_bank' + | 'ideabank' + | 'ing' + | 'inteligo' + | 'mbank_mtransfer' + | 'nest_przelew' + | 'noble_pay' + | 'pbac_z_ipko' + | 'plus_bank' + | 'santander_przelew24' + | 'tmobile_usbugi_bankowe' + | 'toyota_bank' + | 'volkswagen_bank' ) - | null; - }; + | null + } /** payment_method_sepa_debit */ payment_method_sepa_debit: { /** @description Bank code of bank associated with the bank account. */ - bank_code?: string | null; + bank_code?: string | null /** @description Branch code of bank associated with the bank account. */ - branch_code?: string | null; + branch_code?: string | null /** @description Two-letter ISO code representing the country the bank account is located in. */ - country?: string | null; + country?: string | null /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Information about the object that generated this PaymentMethod. */ - generated_from?: Partial | null; + generated_from?: Partial | null /** @description Last four characters of the IBAN. */ - last4?: string | null; - }; + last4?: string | null + } /** payment_method_sofort */ payment_method_sofort: { /** @description Two-letter ISO code representing the country the bank account is located in. */ - country?: string | null; - }; + country?: string | null + } /** payment_method_wechat_pay */ - payment_method_wechat_pay: { [key: string]: unknown }; + payment_method_wechat_pay: { [key: string]: unknown } /** PaymentPagesCheckoutSessionAfterExpiration */ payment_pages_checkout_session_after_expiration: { /** @description When set, configuration used to recover the Checkout Session on expiry. */ - recovery?: Partial | null; - }; + recovery?: Partial | null + } /** PaymentPagesCheckoutSessionAfterExpirationRecovery */ payment_pages_checkout_session_after_expiration_recovery: { /** @description Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to `false` */ - allow_promotion_codes: boolean; + allow_promotion_codes: boolean /** * @description If `true`, a recovery url will be generated to recover this Checkout Session if it * expires before a transaction is completed. It will be attached to the * Checkout Session object upon expiration. */ - enabled: boolean; + enabled: boolean /** * Format: unix-time * @description The timestamp at which the recovery URL will expire. */ - expires_at?: number | null; + expires_at?: number | null /** @description URL that creates a new Checkout Session when clicked that is a copy of this expired Checkout Session */ - url?: string | null; - }; + url?: string | null + } /** PaymentPagesCheckoutSessionAutomaticTax */ payment_pages_checkout_session_automatic_tax: { /** @description Indicates whether automatic tax is enabled for the session */ - enabled: boolean; + enabled: boolean /** * @description The status of the most recent automated tax calculation for this session. * @enum {string|null} */ - status?: ("complete" | "failed" | "requires_location_inputs") | null; - }; + status?: ('complete' | 'failed' | 'requires_location_inputs') | null + } /** PaymentPagesCheckoutSessionConsent */ payment_pages_checkout_session_consent: { /** @@ -10704,8 +10584,8 @@ export type components = { * from the merchant about this Checkout Session. * @enum {string|null} */ - promotions?: ("opt_in" | "opt_out") | null; - }; + promotions?: ('opt_in' | 'opt_out') | null + } /** PaymentPagesCheckoutSessionConsentCollection */ payment_pages_checkout_session_consent_collection: { /** @@ -10714,30 +10594,30 @@ export type components = { * from the merchant depending on the customer's locale. Only available to US merchants. * @enum {string|null} */ - promotions?: "auto" | null; - }; + promotions?: 'auto' | null + } /** PaymentPagesCheckoutSessionCustomerDetails */ payment_pages_checkout_session_customer_details: { /** * @description The email associated with the Customer, if one exists, on the Checkout Session at the time of checkout 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. */ - email?: string | null; + email?: string | null /** @description The customer's phone number at the time of checkout */ - phone?: string | null; + phone?: string | null /** * @description The customer’s tax exempt status at time of checkout. * @enum {string|null} */ - tax_exempt?: ("exempt" | "none" | "reverse") | null; + tax_exempt?: ('exempt' | 'none' | 'reverse') | null /** @description The customer’s tax IDs at time of checkout. */ - tax_ids?: components["schemas"]["payment_pages_checkout_session_tax_id"][] | null; - }; + tax_ids?: components['schemas']['payment_pages_checkout_session_tax_id'][] | null + } /** PaymentPagesCheckoutSessionPhoneNumberCollection */ payment_pages_checkout_session_phone_number_collection: { /** @description Indicates whether phone number collection is enabled for the session */ - enabled: boolean; - }; + enabled: boolean + } /** PaymentPagesCheckoutSessionShippingAddressCollection */ payment_pages_checkout_session_shipping_address_collection: { /** @@ -10745,252 +10625,252 @@ export type components = { * shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI`. */ allowed_countries: ( - | "AC" - | "AD" - | "AE" - | "AF" - | "AG" - | "AI" - | "AL" - | "AM" - | "AO" - | "AQ" - | "AR" - | "AT" - | "AU" - | "AW" - | "AX" - | "AZ" - | "BA" - | "BB" - | "BD" - | "BE" - | "BF" - | "BG" - | "BH" - | "BI" - | "BJ" - | "BL" - | "BM" - | "BN" - | "BO" - | "BQ" - | "BR" - | "BS" - | "BT" - | "BV" - | "BW" - | "BY" - | "BZ" - | "CA" - | "CD" - | "CF" - | "CG" - | "CH" - | "CI" - | "CK" - | "CL" - | "CM" - | "CN" - | "CO" - | "CR" - | "CV" - | "CW" - | "CY" - | "CZ" - | "DE" - | "DJ" - | "DK" - | "DM" - | "DO" - | "DZ" - | "EC" - | "EE" - | "EG" - | "EH" - | "ER" - | "ES" - | "ET" - | "FI" - | "FJ" - | "FK" - | "FO" - | "FR" - | "GA" - | "GB" - | "GD" - | "GE" - | "GF" - | "GG" - | "GH" - | "GI" - | "GL" - | "GM" - | "GN" - | "GP" - | "GQ" - | "GR" - | "GS" - | "GT" - | "GU" - | "GW" - | "GY" - | "HK" - | "HN" - | "HR" - | "HT" - | "HU" - | "ID" - | "IE" - | "IL" - | "IM" - | "IN" - | "IO" - | "IQ" - | "IS" - | "IT" - | "JE" - | "JM" - | "JO" - | "JP" - | "KE" - | "KG" - | "KH" - | "KI" - | "KM" - | "KN" - | "KR" - | "KW" - | "KY" - | "KZ" - | "LA" - | "LB" - | "LC" - | "LI" - | "LK" - | "LR" - | "LS" - | "LT" - | "LU" - | "LV" - | "LY" - | "MA" - | "MC" - | "MD" - | "ME" - | "MF" - | "MG" - | "MK" - | "ML" - | "MM" - | "MN" - | "MO" - | "MQ" - | "MR" - | "MS" - | "MT" - | "MU" - | "MV" - | "MW" - | "MX" - | "MY" - | "MZ" - | "NA" - | "NC" - | "NE" - | "NG" - | "NI" - | "NL" - | "NO" - | "NP" - | "NR" - | "NU" - | "NZ" - | "OM" - | "PA" - | "PE" - | "PF" - | "PG" - | "PH" - | "PK" - | "PL" - | "PM" - | "PN" - | "PR" - | "PS" - | "PT" - | "PY" - | "QA" - | "RE" - | "RO" - | "RS" - | "RU" - | "RW" - | "SA" - | "SB" - | "SC" - | "SE" - | "SG" - | "SH" - | "SI" - | "SJ" - | "SK" - | "SL" - | "SM" - | "SN" - | "SO" - | "SR" - | "SS" - | "ST" - | "SV" - | "SX" - | "SZ" - | "TA" - | "TC" - | "TD" - | "TF" - | "TG" - | "TH" - | "TJ" - | "TK" - | "TL" - | "TM" - | "TN" - | "TO" - | "TR" - | "TT" - | "TV" - | "TW" - | "TZ" - | "UA" - | "UG" - | "US" - | "UY" - | "UZ" - | "VA" - | "VC" - | "VE" - | "VG" - | "VN" - | "VU" - | "WF" - | "WS" - | "XK" - | "YE" - | "YT" - | "ZA" - | "ZM" - | "ZW" - | "ZZ" - )[]; - }; + | 'AC' + | 'AD' + | 'AE' + | 'AF' + | 'AG' + | 'AI' + | 'AL' + | 'AM' + | 'AO' + | 'AQ' + | 'AR' + | 'AT' + | 'AU' + | 'AW' + | 'AX' + | 'AZ' + | 'BA' + | 'BB' + | 'BD' + | 'BE' + | 'BF' + | 'BG' + | 'BH' + | 'BI' + | 'BJ' + | 'BL' + | 'BM' + | 'BN' + | 'BO' + | 'BQ' + | 'BR' + | 'BS' + | 'BT' + | 'BV' + | 'BW' + | 'BY' + | 'BZ' + | 'CA' + | 'CD' + | 'CF' + | 'CG' + | 'CH' + | 'CI' + | 'CK' + | 'CL' + | 'CM' + | 'CN' + | 'CO' + | 'CR' + | 'CV' + | 'CW' + | 'CY' + | 'CZ' + | 'DE' + | 'DJ' + | 'DK' + | 'DM' + | 'DO' + | 'DZ' + | 'EC' + | 'EE' + | 'EG' + | 'EH' + | 'ER' + | 'ES' + | 'ET' + | 'FI' + | 'FJ' + | 'FK' + | 'FO' + | 'FR' + | 'GA' + | 'GB' + | 'GD' + | 'GE' + | 'GF' + | 'GG' + | 'GH' + | 'GI' + | 'GL' + | 'GM' + | 'GN' + | 'GP' + | 'GQ' + | 'GR' + | 'GS' + | 'GT' + | 'GU' + | 'GW' + | 'GY' + | 'HK' + | 'HN' + | 'HR' + | 'HT' + | 'HU' + | 'ID' + | 'IE' + | 'IL' + | 'IM' + | 'IN' + | 'IO' + | 'IQ' + | 'IS' + | 'IT' + | 'JE' + | 'JM' + | 'JO' + | 'JP' + | 'KE' + | 'KG' + | 'KH' + | 'KI' + | 'KM' + | 'KN' + | 'KR' + | 'KW' + | 'KY' + | 'KZ' + | 'LA' + | 'LB' + | 'LC' + | 'LI' + | 'LK' + | 'LR' + | 'LS' + | 'LT' + | 'LU' + | 'LV' + | 'LY' + | 'MA' + | 'MC' + | 'MD' + | 'ME' + | 'MF' + | 'MG' + | 'MK' + | 'ML' + | 'MM' + | 'MN' + | 'MO' + | 'MQ' + | 'MR' + | 'MS' + | 'MT' + | 'MU' + | 'MV' + | 'MW' + | 'MX' + | 'MY' + | 'MZ' + | 'NA' + | 'NC' + | 'NE' + | 'NG' + | 'NI' + | 'NL' + | 'NO' + | 'NP' + | 'NR' + | 'NU' + | 'NZ' + | 'OM' + | 'PA' + | 'PE' + | 'PF' + | 'PG' + | 'PH' + | 'PK' + | 'PL' + | 'PM' + | 'PN' + | 'PR' + | 'PS' + | 'PT' + | 'PY' + | 'QA' + | 'RE' + | 'RO' + | 'RS' + | 'RU' + | 'RW' + | 'SA' + | 'SB' + | 'SC' + | 'SE' + | 'SG' + | 'SH' + | 'SI' + | 'SJ' + | 'SK' + | 'SL' + | 'SM' + | 'SN' + | 'SO' + | 'SR' + | 'SS' + | 'ST' + | 'SV' + | 'SX' + | 'SZ' + | 'TA' + | 'TC' + | 'TD' + | 'TF' + | 'TG' + | 'TH' + | 'TJ' + | 'TK' + | 'TL' + | 'TM' + | 'TN' + | 'TO' + | 'TR' + | 'TT' + | 'TV' + | 'TW' + | 'TZ' + | 'UA' + | 'UG' + | 'US' + | 'UY' + | 'UZ' + | 'VA' + | 'VC' + | 'VE' + | 'VG' + | 'VN' + | 'VU' + | 'WF' + | 'WS' + | 'XK' + | 'YE' + | 'YT' + | 'ZA' + | 'ZM' + | 'ZW' + | 'ZZ' + )[] + } /** PaymentPagesCheckoutSessionShippingOption */ payment_pages_checkout_session_shipping_option: { /** @description A non-negative integer in cents representing how much to charge. */ - shipping_amount: number; + shipping_amount: number /** @description The shipping rate. */ - shipping_rate: Partial & Partial; - }; + shipping_rate: Partial & Partial + } /** PaymentPagesCheckoutSessionTaxID */ payment_pages_checkout_session_tax_id: { /** @@ -10998,81 +10878,81 @@ export type components = { * @enum {string} */ type: - | "ae_trn" - | "au_abn" - | "au_arn" - | "br_cnpj" - | "br_cpf" - | "ca_bn" - | "ca_gst_hst" - | "ca_pst_bc" - | "ca_pst_mb" - | "ca_pst_sk" - | "ca_qst" - | "ch_vat" - | "cl_tin" - | "es_cif" - | "eu_vat" - | "gb_vat" - | "ge_vat" - | "hk_br" - | "id_npwp" - | "il_vat" - | "in_gst" - | "is_vat" - | "jp_cn" - | "jp_rn" - | "kr_brn" - | "li_uid" - | "mx_rfc" - | "my_frp" - | "my_itn" - | "my_sst" - | "no_vat" - | "nz_gst" - | "ru_inn" - | "ru_kpp" - | "sa_vat" - | "sg_gst" - | "sg_uen" - | "th_vat" - | "tw_vat" - | "ua_vat" - | "unknown" - | "us_ein" - | "za_vat"; + | 'ae_trn' + | 'au_abn' + | 'au_arn' + | 'br_cnpj' + | 'br_cpf' + | 'ca_bn' + | 'ca_gst_hst' + | 'ca_pst_bc' + | 'ca_pst_mb' + | 'ca_pst_sk' + | 'ca_qst' + | 'ch_vat' + | 'cl_tin' + | 'es_cif' + | 'eu_vat' + | 'gb_vat' + | 'ge_vat' + | 'hk_br' + | 'id_npwp' + | 'il_vat' + | 'in_gst' + | 'is_vat' + | 'jp_cn' + | 'jp_rn' + | 'kr_brn' + | 'li_uid' + | 'mx_rfc' + | 'my_frp' + | 'my_itn' + | 'my_sst' + | 'no_vat' + | 'nz_gst' + | 'ru_inn' + | 'ru_kpp' + | 'sa_vat' + | 'sg_gst' + | 'sg_uen' + | 'th_vat' + | 'tw_vat' + | 'ua_vat' + | 'unknown' + | 'us_ein' + | 'za_vat' /** @description The value of the tax ID. */ - value?: string | null; - }; + value?: string | null + } /** PaymentPagesCheckoutSessionTaxIDCollection */ payment_pages_checkout_session_tax_id_collection: { /** @description Indicates whether tax ID collection is enabled for the session */ - enabled: boolean; - }; + enabled: boolean + } /** PaymentPagesCheckoutSessionTotalDetails */ payment_pages_checkout_session_total_details: { /** @description This is the sum of all the line item discounts. */ - amount_discount: number; + amount_discount: number /** @description This is the sum of all the line item shipping amounts. */ - amount_shipping?: number | null; + amount_shipping?: number | null /** @description This is the sum of all the line item tax amounts. */ - amount_tax: number; - breakdown?: components["schemas"]["payment_pages_checkout_session_total_details_resource_breakdown"]; - }; + amount_tax: number + breakdown?: components['schemas']['payment_pages_checkout_session_total_details_resource_breakdown'] + } /** PaymentPagesCheckoutSessionTotalDetailsResourceBreakdown */ payment_pages_checkout_session_total_details_resource_breakdown: { /** @description The aggregated line item discounts. */ - discounts: components["schemas"]["line_items_discount_amount"][]; + discounts: components['schemas']['line_items_discount_amount'][] /** @description The aggregated line item tax amounts by rate. */ - taxes: components["schemas"]["line_items_tax_amount"][]; - }; + taxes: components['schemas']['line_items_tax_amount'][] + } /** Polymorphic */ - payment_source: Partial & - Partial & - Partial & - Partial & - Partial & - Partial; + payment_source: Partial & + Partial & + Partial & + Partial & + Partial & + Partial /** * Payout * @description A `Payout` object is created when you receive funds from Stripe, or when you @@ -11086,81 +10966,81 @@ export type components = { */ payout: { /** @description Amount (in %s) to be transferred to your bank account or debit card. */ - amount: number; + amount: number /** * Format: unix-time * @description Date the payout is expected to arrive in the bank. This factors in delays like weekends or bank holidays. */ - arrival_date: number; + arrival_date: number /** @description Returns `true` if the payout was created by an [automated payout schedule](https://stripe.com/docs/payouts#payout-schedule), and `false` if it was [requested manually](https://stripe.com/docs/payouts#manual-payouts). */ - automatic: boolean; + automatic: boolean /** @description ID of the balance transaction that describes the impact of this payout on your account balance. */ - balance_transaction?: (Partial & Partial) | null; + balance_transaction?: (Partial & Partial) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description ID of the bank account or card the payout was sent to. */ destination?: | (Partial & - Partial & - Partial & - Partial & - Partial) - | null; + Partial & + Partial & + Partial & + Partial) + | null /** @description If the payout failed or was canceled, this will be the ID of the balance transaction that reversed the initial balance transaction, and puts the funds from the failed payout back in your balance. */ - failure_balance_transaction?: (Partial & Partial) | null; + failure_balance_transaction?: (Partial & Partial) | null /** @description Error code explaining reason for payout failure if available. See [Types of payout failures](https://stripe.com/docs/api#payout_failures) for a list of failure codes. */ - failure_code?: string | null; + failure_code?: string | null /** @description Message to user further explaining reason for payout failure if available. */ - failure_message?: string | null; + failure_message?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** @description The method used to send this payout, which can be `standard` or `instant`. `instant` is only supported for payouts to debit cards. (See [Instant payouts for marketplaces](https://stripe.com/blog/instant-payouts-for-marketplaces) for more information.) */ - method: string; + method: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "payout"; + object: 'payout' /** @description If the payout reverses another, this is the ID of the original payout. */ - original_payout?: (Partial & Partial) | null; + original_payout?: (Partial & Partial) | null /** @description If the payout was reversed, this is the ID of the payout that reverses this payout. */ - reversed_by?: (Partial & Partial) | null; + reversed_by?: (Partial & Partial) | null /** @description The source balance this payout came from. One of `card`, `fpx`, or `bank_account`. */ - source_type: string; + source_type: string /** @description Extra information about a payout to be displayed on the user's bank statement. */ - statement_descriptor?: string | null; + statement_descriptor?: string | null /** @description Current status of the payout: `paid`, `pending`, `in_transit`, `canceled` or `failed`. A payout is `pending` until it is submitted to the bank, when it becomes `in_transit`. The status then changes to `paid` if the transaction goes through, or to `failed` or `canceled` (within 5 business days). Some failed payouts may initially show as `paid` but then change to `failed`. */ - status: string; + status: string /** * @description Can be `bank_account` or `card`. * @enum {string} */ - type: "bank_account" | "card"; - }; + type: 'bank_account' | 'card' + } /** Period */ period: { /** * Format: unix-time * @description The end date of this usage period. All usage up to and including this point in time is included. */ - end?: number | null; + end?: number | null /** * Format: unix-time * @description The start date of this usage period. All usage after this point in time is included. */ - start?: number | null; - }; + start?: number | null + } /** * Person * @description This is an object representing a person associated with a Stripe account. @@ -11172,108 +11052,108 @@ export type components = { */ person: { /** @description The account the person is associated with. */ - account: string; - address?: components["schemas"]["address"]; - address_kana?: Partial | null; - address_kanji?: Partial | null; + account: string + address?: components['schemas']['address'] + address_kana?: Partial | null + address_kanji?: Partial | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; - dob?: components["schemas"]["legal_entity_dob"]; + created: number + dob?: components['schemas']['legal_entity_dob'] /** @description The person's email address. */ - email?: string | null; + email?: string | null /** @description The person's first name. */ - first_name?: string | null; + first_name?: string | null /** @description The Kana variation of the person's first name (Japan only). */ - first_name_kana?: string | null; + first_name_kana?: string | null /** @description The Kanji variation of the person's first name (Japan only). */ - first_name_kanji?: string | null; + first_name_kanji?: string | null /** @description A list of alternate names or aliases that the person is known by. */ - full_name_aliases?: string[]; - future_requirements?: Partial | null; + full_name_aliases?: string[] + future_requirements?: Partial | null /** @description The person's gender (International regulations require either "male" or "female"). */ - gender?: string | null; + gender?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Whether the person's `id_number` was provided. */ - id_number_provided?: boolean; + id_number_provided?: boolean /** @description The person's last name. */ - last_name?: string | null; + last_name?: string | null /** @description The Kana variation of the person's last name (Japan only). */ - last_name_kana?: string | null; + last_name_kana?: string | null /** @description The Kanji variation of the person's last name (Japan only). */ - last_name_kanji?: string | null; + last_name_kanji?: string | null /** @description The person's maiden name. */ - maiden_name?: string | null; + maiden_name?: string | null /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The country where the person is a national. */ - nationality?: string | null; + nationality?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "person"; + object: 'person' /** @description The person's phone number. */ - phone?: string | null; + phone?: string | null /** * @description 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. * @enum {string} */ - political_exposure?: "existing" | "none"; - relationship?: components["schemas"]["person_relationship"]; - requirements?: Partial | null; + political_exposure?: 'existing' | 'none' + relationship?: components['schemas']['person_relationship'] + requirements?: Partial | null /** @description Whether the last four digits of the person's Social Security number have been provided (U.S. only). */ - ssn_last_4_provided?: boolean; - verification?: components["schemas"]["legal_entity_person_verification"]; - }; + ssn_last_4_provided?: boolean + verification?: components['schemas']['legal_entity_person_verification'] + } /** PersonFutureRequirements */ person_future_requirements: { /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ - alternatives?: components["schemas"]["account_requirements_alternative"][] | null; + alternatives?: components['schemas']['account_requirements_alternative'][] | null /** @description 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: string[]; + currently_due: string[] /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ - errors: components["schemas"]["account_requirements_error"][]; + errors: components['schemas']['account_requirements_error'][] /** @description Fields that need to be collected assuming all volume 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: string[]; + eventually_due: string[] /** @description 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: string[]; + past_due: string[] /** @description Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. */ - pending_verification: string[]; - }; + pending_verification: string[] + } /** PersonRelationship */ person_relationship: { /** @description 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?: boolean | null; + director?: boolean | null /** @description Whether the person has significant responsibility to control, manage, or direct the organization. */ - executive?: boolean | null; + executive?: boolean | null /** @description Whether the person is an owner of the account’s legal entity. */ - owner?: boolean | null; + owner?: boolean | null /** @description The percent owned by the person of the account's legal entity. */ - percent_ownership?: number | null; + percent_ownership?: number | null /** @description 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?: boolean | null; + representative?: boolean | null /** @description The person's title (e.g., CEO, Support Engineer). */ - title?: string | null; - }; + title?: string | null + } /** PersonRequirements */ person_requirements: { /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ - alternatives?: components["schemas"]["account_requirements_alternative"][] | null; + alternatives?: components['schemas']['account_requirements_alternative'][] | null /** @description 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: string[]; + currently_due: string[] /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ - errors: components["schemas"]["account_requirements_error"][]; + errors: components['schemas']['account_requirements_error'][] /** @description Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `current_deadline` becomes set. */ - eventually_due: string[]; + eventually_due: string[] /** @description 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: string[]; + past_due: string[] /** @description Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. */ - pending_verification: string[]; - }; + pending_verification: string[] + } /** * Plan * @description You can now model subscriptions more flexibly using the [Prices API](https://stripe.com/docs/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration. @@ -11287,202 +11167,189 @@ export type components = { */ plan: { /** @description Whether the plan can be used for new purchases. */ - active: boolean; + active: boolean /** * @description 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`. * @enum {string|null} */ - aggregate_usage?: ("last_during_period" | "last_ever" | "max" | "sum") | null; + aggregate_usage?: ('last_during_period' | 'last_ever' | 'max' | 'sum') | null /** @description The unit amount in %s to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. */ - amount?: number | null; + amount?: number | null /** * Format: decimal * @description The unit amount in %s to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`. */ - amount_decimal?: string | null; + amount_decimal?: string | null /** * @description 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. * @enum {string} */ - billing_scheme: "per_unit" | "tiered"; + billing_scheme: 'per_unit' | 'tiered' /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`. * @enum {string} */ - interval: "day" | "month" | "week" | "year"; + interval: 'day' | 'month' | 'week' | 'year' /** @description 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: number; + interval_count: number /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** @description A brief description of the plan, hidden from customers. */ - nickname?: string | null; + nickname?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "plan"; + object: 'plan' /** @description The product whose pricing this plan determines. */ - product?: - | (Partial & - Partial & - Partial) - | null; + product?: (Partial & Partial & Partial) | null /** @description Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. */ - tiers?: components["schemas"]["plan_tier"][]; + tiers?: components['schemas']['plan_tier'][] /** * @description 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. * @enum {string|null} */ - tiers_mode?: ("graduated" | "volume") | null; + tiers_mode?: ('graduated' | 'volume') | null /** @description Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`. */ - transform_usage?: Partial | null; + transform_usage?: Partial | null /** @description 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?: number | null; + trial_period_days?: number | null /** * @description 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`. * @enum {string} */ - usage_type: "licensed" | "metered"; - }; + usage_type: 'licensed' | 'metered' + } /** PlanTier */ plan_tier: { /** @description Price for the entire tier. */ - flat_amount?: number | null; + flat_amount?: number | null /** * Format: decimal * @description Same as `flat_amount`, but contains a decimal value with at most 12 decimal places. */ - flat_amount_decimal?: string | null; + flat_amount_decimal?: string | null /** @description Per unit price for units relevant to the tier. */ - unit_amount?: number | null; + unit_amount?: number | null /** * Format: decimal * @description Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. */ - unit_amount_decimal?: string | null; + unit_amount_decimal?: string | null /** @description Up to and including to this quantity will be contained in the tier. */ - up_to?: number | null; - }; + up_to?: number | null + } /** PlatformTax */ platform_tax_fee: { /** @description The Connected account that incurred this charge. */ - account: string; + account: string /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "platform_tax_fee"; + object: 'platform_tax_fee' /** @description The payment object that caused this tax to be inflicted. */ - source_transaction: string; + source_transaction: string /** @description The type of tax (VAT). */ - type: string; - }; + type: string + } /** PortalBusinessProfile */ portal_business_profile: { /** @description The messaging shown to customers in the portal. */ - headline?: string | null; + headline?: string | null /** @description A link to the business’s publicly available privacy policy. */ - privacy_policy_url: string; + privacy_policy_url: string /** @description A link to the business’s publicly available terms of service. */ - terms_of_service_url: string; - }; + terms_of_service_url: string + } /** PortalCustomerUpdate */ portal_customer_update: { /** @description The types of customer updates that are supported. When empty, customers are not updateable. */ - allowed_updates: ("address" | "email" | "phone" | "shipping" | "tax_id")[]; + allowed_updates: ('address' | 'email' | 'phone' | 'shipping' | 'tax_id')[] /** @description Whether the feature is enabled. */ - enabled: boolean; - }; + enabled: boolean + } /** PortalFeatures */ portal_features: { - customer_update: components["schemas"]["portal_customer_update"]; - invoice_history: components["schemas"]["portal_invoice_list"]; - payment_method_update: components["schemas"]["portal_payment_method_update"]; - subscription_cancel: components["schemas"]["portal_subscription_cancel"]; - subscription_pause: components["schemas"]["portal_subscription_pause"]; - subscription_update: components["schemas"]["portal_subscription_update"]; - }; + customer_update: components['schemas']['portal_customer_update'] + invoice_history: components['schemas']['portal_invoice_list'] + payment_method_update: components['schemas']['portal_payment_method_update'] + subscription_cancel: components['schemas']['portal_subscription_cancel'] + subscription_pause: components['schemas']['portal_subscription_pause'] + subscription_update: components['schemas']['portal_subscription_update'] + } /** PortalInvoiceList */ portal_invoice_list: { /** @description Whether the feature is enabled. */ - enabled: boolean; - }; + enabled: boolean + } /** PortalPaymentMethodUpdate */ portal_payment_method_update: { /** @description Whether the feature is enabled. */ - enabled: boolean; - }; + enabled: boolean + } /** PortalSubscriptionCancel */ portal_subscription_cancel: { - cancellation_reason: components["schemas"]["portal_subscription_cancellation_reason"]; + cancellation_reason: components['schemas']['portal_subscription_cancellation_reason'] /** @description Whether the feature is enabled. */ - enabled: boolean; + enabled: boolean /** * @description Whether to cancel subscriptions immediately or at the end of the billing period. * @enum {string} */ - mode: "at_period_end" | "immediately"; + mode: 'at_period_end' | 'immediately' /** * @description Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`. * @enum {string} */ - proration_behavior: "always_invoice" | "create_prorations" | "none"; - }; + proration_behavior: 'always_invoice' | 'create_prorations' | 'none' + } /** PortalSubscriptionCancellationReason */ portal_subscription_cancellation_reason: { /** @description Whether the feature is enabled. */ - enabled: boolean; + enabled: boolean /** @description Which cancellation reasons will be given as options to the customer. */ - options: ( - | "customer_service" - | "low_quality" - | "missing_features" - | "other" - | "switched_service" - | "too_complex" - | "too_expensive" - | "unused" - )[]; - }; + options: ('customer_service' | 'low_quality' | 'missing_features' | 'other' | 'switched_service' | 'too_complex' | 'too_expensive' | 'unused')[] + } /** PortalSubscriptionPause */ portal_subscription_pause: { /** @description Whether the feature is enabled. */ - enabled: boolean; - }; + enabled: boolean + } /** PortalSubscriptionUpdate */ portal_subscription_update: { /** @description The types of subscription updates that are supported for items listed in the `products` attribute. When empty, subscriptions are not updateable. */ - default_allowed_updates: ("price" | "promotion_code" | "quantity")[]; + default_allowed_updates: ('price' | 'promotion_code' | 'quantity')[] /** @description Whether the feature is enabled. */ - enabled: boolean; + enabled: boolean /** @description The list of products that support subscription updates. */ - products?: components["schemas"]["portal_subscription_update_product"][] | null; + products?: components['schemas']['portal_subscription_update_product'][] | null /** * @description Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`. * @enum {string} */ - proration_behavior: "always_invoice" | "create_prorations" | "none"; - }; + proration_behavior: 'always_invoice' | 'create_prorations' | 'none' + } /** PortalSubscriptionUpdateProduct */ portal_subscription_update_product: { /** @description The list of price IDs which, when subscribed to, a subscription can be updated. */ - prices: string[]; + prices: string[] /** @description The product ID. */ - product: string; - }; + product: string + } /** * Price * @description Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. @@ -11494,86 +11361,84 @@ export type components = { */ price: { /** @description Whether the price can be used for new purchases. */ - active: boolean; + active: boolean /** * @description 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. * @enum {string} */ - billing_scheme: "per_unit" | "tiered"; + billing_scheme: 'per_unit' | 'tiered' /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters. */ - lookup_key?: string | null; + lookup_key?: string | null /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** @description A brief description of the price, hidden from customers. */ - nickname?: string | null; + nickname?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "price"; + object: 'price' /** @description The ID of the product this price is associated with. */ - product: Partial & - Partial & - Partial; + product: Partial & Partial & Partial /** @description The recurring components of a price such as `interval` and `usage_type`. */ - recurring?: Partial | null; + recurring?: Partial | null /** * @description 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. * @enum {string|null} */ - tax_behavior?: ("exclusive" | "inclusive" | "unspecified") | null; + tax_behavior?: ('exclusive' | 'inclusive' | 'unspecified') | null /** @description Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. */ - tiers?: components["schemas"]["price_tier"][]; + tiers?: components['schemas']['price_tier'][] /** * @description 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. * @enum {string|null} */ - tiers_mode?: ("graduated" | "volume") | null; + tiers_mode?: ('graduated' | 'volume') | null /** @description Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`. */ - transform_quantity?: Partial | null; + transform_quantity?: Partial | null /** * @description One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase. * @enum {string} */ - type: "one_time" | "recurring"; + type: 'one_time' | 'recurring' /** @description The unit amount in %s to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. */ - unit_amount?: number | null; + unit_amount?: number | null /** * Format: decimal * @description The unit amount in %s to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`. */ - unit_amount_decimal?: string | null; - }; + unit_amount_decimal?: string | null + } /** PriceTier */ price_tier: { /** @description Price for the entire tier. */ - flat_amount?: number | null; + flat_amount?: number | null /** * Format: decimal * @description Same as `flat_amount`, but contains a decimal value with at most 12 decimal places. */ - flat_amount_decimal?: string | null; + flat_amount_decimal?: string | null /** @description Per unit price for units relevant to the tier. */ - unit_amount?: number | null; + unit_amount?: number | null /** * Format: decimal * @description Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. */ - unit_amount_decimal?: string | null; + unit_amount_decimal?: string | null /** @description Up to and including to this quantity will be contained in the tier. */ - up_to?: number | null; - }; + up_to?: number | null + } /** * Product * @description Products describe the specific goods or services you offer to your customers. @@ -11587,47 +11452,47 @@ export type components = { */ product: { /** @description Whether the product is currently available for purchase. */ - active: boolean; + active: boolean /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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?: string | null; + description?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description A list of up to 8 URLs of images for this product, meant to be displayable to the customer. */ - images: string[]; + images: string[] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** @description The product's name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions. */ - name: string; + name: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "product"; + object: 'product' /** @description The dimensions of this product for shipping purposes. */ - package_dimensions?: Partial | null; + package_dimensions?: Partial | null /** @description Whether this product is shipped (i.e., physical goods). */ - shippable?: boolean | null; + shippable?: boolean | null /** @description 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. */ - statement_descriptor?: string | null; + statement_descriptor?: string | null /** @description A [tax code](https://stripe.com/docs/tax/tax-codes) ID. */ - tax_code?: (Partial & Partial) | null; + tax_code?: (Partial & Partial) | null /** @description A label that represents units of this product in Stripe and on customers’ receipts and invoices. When set, this will be included in associated invoice line item descriptions. */ - unit_label?: string | null; + unit_label?: string | null /** * Format: unix-time * @description Time at which the object was last updated. Measured in seconds since the Unix epoch. */ - updated: number; + updated: number /** @description A URL of a publicly-accessible webpage for this product. */ - url?: string | null; - }; + url?: string | null + } /** * PromotionCode * @description A Promotion Code represents a customer-redeemable code for a coupon. It can be used to @@ -11635,52 +11500,48 @@ export type components = { */ promotion_code: { /** @description Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid. */ - active: boolean; + active: boolean /** @description The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. */ - code: string; - coupon: components["schemas"]["coupon"]; + code: string + coupon: components['schemas']['coupon'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The customer that this promotion code can be used by. */ - customer?: - | (Partial & - Partial & - Partial) - | null; + customer?: (Partial & Partial & Partial) | null /** * Format: unix-time * @description Date at which the promotion code can no longer be redeemed. */ - expires_at?: number | null; + expires_at?: number | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description Maximum number of times this promotion code can be redeemed. */ - max_redemptions?: number | null; + max_redemptions?: number | null /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "promotion_code"; - restrictions: components["schemas"]["promotion_codes_resource_restrictions"]; + object: 'promotion_code' + restrictions: components['schemas']['promotion_codes_resource_restrictions'] /** @description Number of times this promotion code has been used. */ - times_redeemed: number; - }; + times_redeemed: number + } /** PromotionCodesResourceRestrictions */ promotion_codes_resource_restrictions: { /** @description A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices */ - first_time_transaction: boolean; + first_time_transaction: boolean /** @description Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work). */ - minimum_amount?: number | null; + minimum_amount?: number | null /** @description Three-letter [ISO code](https://stripe.com/docs/currencies) for minimum_amount */ - minimum_amount_currency?: string | null; - }; + minimum_amount_currency?: string | null + } /** * Quote * @description A Quote is a way to model prices that you'd like to provide to a customer. @@ -11688,222 +11549,214 @@ export type components = { */ quote: { /** @description Total before any discounts or taxes are applied. */ - amount_subtotal: number; + amount_subtotal: number /** @description Total after discounts and taxes are applied. */ - amount_total: number; + amount_total: number /** @description 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?: number | null; + application_fee_amount?: number | null /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal 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?: number | null; - automatic_tax: components["schemas"]["quotes_resource_automatic_tax"]; + application_fee_percent?: number | null + automatic_tax: components['schemas']['quotes_resource_automatic_tax'] /** * @description 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. Defaults to `charge_automatically`. * @enum {string} */ - collection_method: "charge_automatically" | "send_invoice"; - computed: components["schemas"]["quotes_resource_computed"]; + collection_method: 'charge_automatically' | 'send_invoice' + computed: components['schemas']['quotes_resource_computed'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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?: string | null; + currency?: string | null /** @description The customer which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed. */ - customer?: - | (Partial & - Partial & - Partial) - | null; + customer?: (Partial & Partial & Partial) | null /** @description The tax rates applied to this quote. */ - default_tax_rates?: (Partial & Partial)[]; + default_tax_rates?: (Partial & Partial)[] /** @description A description that will be displayed on the quote PDF. */ - description?: string | null; + description?: string | null /** @description The discounts applied to this quote. */ - discounts: (Partial & Partial)[]; + discounts: (Partial & Partial)[] /** * Format: unix-time * @description The date on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. */ - expires_at: number; + expires_at: number /** @description A footer that will be displayed on the quote PDF. */ - footer?: string | null; + footer?: string | null /** @description Details of the quote that was cloned. See the [cloning documentation](https://stripe.com/docs/quotes/clone) for more details. */ - from_quote?: Partial | null; + from_quote?: Partial | null /** @description A header that will be displayed on the quote PDF. */ - header?: string | null; + header?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The invoice that was created from this quote. */ - invoice?: - | (Partial & - Partial & - Partial) - | null; + invoice?: (Partial & Partial & Partial) | null /** @description All invoices will be billed using the specified settings. */ - invoice_settings?: Partial | null; + invoice_settings?: Partial | null /** * QuotesResourceListLineItems * @description A list of items the customer is being quoted for. */ line_items?: { /** @description Details about each object. */ - data: components["schemas"]["item"][]; + data: components['schemas']['item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** @description 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?: string | null; + number?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "quote"; + object: 'quote' /** @description 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?: (Partial & Partial) | null; + on_behalf_of?: (Partial & Partial) | null /** * @description The status of the quote. * @enum {string} */ - status: "accepted" | "canceled" | "draft" | "open"; - status_transitions: components["schemas"]["quotes_resource_status_transitions"]; + status: 'accepted' | 'canceled' | 'draft' | 'open' + status_transitions: components['schemas']['quotes_resource_status_transitions'] /** @description The subscription that was created or updated from this quote. */ - subscription?: (Partial & Partial) | null; - subscription_data: components["schemas"]["quotes_resource_subscription_data"]; + subscription?: (Partial & Partial) | null + subscription_data: components['schemas']['quotes_resource_subscription_data'] /** @description The subscription schedule that was created or updated from this quote. */ - subscription_schedule?: (Partial & Partial) | null; - total_details: components["schemas"]["quotes_resource_total_details"]; + subscription_schedule?: (Partial & Partial) | null + total_details: components['schemas']['quotes_resource_total_details'] /** @description 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?: Partial | null; - }; + transfer_data?: Partial | null + } /** QuotesResourceAutomaticTax */ quotes_resource_automatic_tax: { /** @description Automatically calculate taxes */ - enabled: boolean; + enabled: boolean /** * @description The status of the most recent automated tax calculation for this quote. * @enum {string|null} */ - status?: ("complete" | "failed" | "requires_location_inputs") | null; - }; + status?: ('complete' | 'failed' | 'requires_location_inputs') | null + } /** QuotesResourceComputed */ quotes_resource_computed: { /** @description 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?: Partial | null; - upfront: components["schemas"]["quotes_resource_upfront"]; - }; + recurring?: Partial | null + upfront: components['schemas']['quotes_resource_upfront'] + } /** QuotesResourceFromQuote */ quotes_resource_from_quote: { /** @description Whether this quote is a revision of a different quote. */ - is_revision: boolean; + is_revision: boolean /** @description The quote that was cloned. */ - quote: Partial & Partial; - }; + quote: Partial & Partial + } /** QuotesResourceRecurring */ quotes_resource_recurring: { /** @description Total before any discounts or taxes are applied. */ - amount_subtotal: number; + amount_subtotal: number /** @description Total after discounts and taxes are applied. */ - amount_total: number; + amount_total: number /** * @description The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`. * @enum {string} */ - interval: "day" | "month" | "week" | "year"; + interval: 'day' | 'month' | 'week' | 'year' /** @description 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: number; - total_details: components["schemas"]["quotes_resource_total_details"]; - }; + interval_count: number + total_details: components['schemas']['quotes_resource_total_details'] + } /** QuotesResourceStatusTransitions */ quotes_resource_status_transitions: { /** * Format: unix-time * @description The time that the quote was accepted. Measured in seconds since Unix epoch. */ - accepted_at?: number | null; + accepted_at?: number | null /** * Format: unix-time * @description The time that the quote was canceled. Measured in seconds since Unix epoch. */ - canceled_at?: number | null; + canceled_at?: number | null /** * Format: unix-time * @description The time that the quote was finalized. Measured in seconds since Unix epoch. */ - finalized_at?: number | null; - }; + finalized_at?: number | null + } /** QuotesResourceSubscriptionData */ quotes_resource_subscription_data: { /** * Format: unix-time * @description 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?: number | null; + effective_date?: number | null /** @description Integer representing the number of trial period days before the customer is charged for the first time. */ - trial_period_days?: number | null; - }; + trial_period_days?: number | null + } /** QuotesResourceTotalDetails */ quotes_resource_total_details: { /** @description This is the sum of all the line item discounts. */ - amount_discount: number; + amount_discount: number /** @description This is the sum of all the line item shipping amounts. */ - amount_shipping?: number | null; + amount_shipping?: number | null /** @description This is the sum of all the line item tax amounts. */ - amount_tax: number; - breakdown?: components["schemas"]["quotes_resource_total_details_resource_breakdown"]; - }; + amount_tax: number + breakdown?: components['schemas']['quotes_resource_total_details_resource_breakdown'] + } /** QuotesResourceTotalDetailsResourceBreakdown */ quotes_resource_total_details_resource_breakdown: { /** @description The aggregated line item discounts. */ - discounts: components["schemas"]["line_items_discount_amount"][]; + discounts: components['schemas']['line_items_discount_amount'][] /** @description The aggregated line item tax amounts by rate. */ - taxes: components["schemas"]["line_items_tax_amount"][]; - }; + taxes: components['schemas']['line_items_tax_amount'][] + } /** QuotesResourceTransferData */ quotes_resource_transfer_data: { /** @description The amount in %s that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination. */ - amount?: number | null; + amount?: number | null /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the destination account. By default, the entire amount will be transferred to the destination. */ - amount_percent?: number | null; + amount_percent?: number | null /** @description The account where funds from the payment will be transferred to upon payment success. */ - destination: Partial & Partial; - }; + destination: Partial & Partial + } /** QuotesResourceUpfront */ quotes_resource_upfront: { /** @description Total before any discounts or taxes are applied. */ - amount_subtotal: number; + amount_subtotal: number /** @description Total after discounts and taxes are applied. */ - amount_total: number; + amount_total: number /** * QuotesResourceListLineItems * @description 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?: { /** @description Details about each object. */ - data: components["schemas"]["item"][]; + data: components['schemas']['item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - total_details: components["schemas"]["quotes_resource_total_details"]; - }; + url: string + } + total_details: components['schemas']['quotes_resource_total_details'] + } /** * RadarEarlyFraudWarning * @description An early fraud warning indicates that the card issuer has notified us that a @@ -11911,142 +11764,134 @@ export type components = { * * Related guide: [Early Fraud Warnings](https://stripe.com/docs/disputes/measuring#early-fraud-warnings). */ - "radar.early_fraud_warning": { + 'radar.early_fraud_warning': { /** @description 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: boolean; + actionable: boolean /** @description ID of the charge this early fraud warning is for, optionally expanded. */ - charge: Partial & Partial; + charge: Partial & Partial /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + fraud_type: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "radar.early_fraud_warning"; + object: 'radar.early_fraud_warning' /** @description ID of the Payment Intent this early fraud warning is for, optionally expanded. */ - payment_intent?: Partial & Partial; - }; + payment_intent?: Partial & Partial + } /** * RadarListList * @description Value lists allow you to group values together which can then be referenced in rules. * * Related guide: [Default Stripe Lists](https://stripe.com/docs/radar/lists#managing-list-items). */ - "radar.value_list": { + 'radar.value_list': { /** @description The name of the value list for use in rules. */ - alias: string; + alias: string /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The name or email address of the user who created this value list. */ - created_by: string; + created_by: string /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description The type of items in the value list. One of `card_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, `case_sensitive_string`, or `customer_id`. * @enum {string} */ - item_type: - | "card_bin" - | "card_fingerprint" - | "case_sensitive_string" - | "country" - | "customer_id" - | "email" - | "ip_address" - | "string"; + item_type: 'card_bin' | 'card_fingerprint' | 'case_sensitive_string' | 'country' | 'customer_id' | 'email' | 'ip_address' | 'string' /** * RadarListListItemList * @description List of items contained within this value list. */ list_items: { /** @description Details about each object. */ - data: components["schemas"]["radar.value_list_item"][]; + data: components['schemas']['radar.value_list_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** @description The name of the value list. */ - name: string; + name: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "radar.value_list"; - }; + object: 'radar.value_list' + } /** * RadarListListItem * @description Value list items allow you to add specific values to a given Radar value list, which can then be used in rules. * * Related guide: [Managing List Items](https://stripe.com/docs/radar/lists#managing-list-items). */ - "radar.value_list_item": { + 'radar.value_list_item': { /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The name or email address of the user who added this item to the value list. */ - created_by: string; + created_by: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "radar.value_list_item"; + object: 'radar.value_list_item' /** @description The value of the item. */ - value: string; + value: string /** @description The identifier of the value list this item belongs to. */ - value_list: string; - }; + value_list: string + } /** RadarReviewResourceLocation */ radar_review_resource_location: { /** @description The city where the payment originated. */ - city?: string | null; + city?: string | null /** @description Two-letter ISO code representing the country where the payment originated. */ - country?: string | null; + country?: string | null /** @description The geographic latitude where the payment originated. */ - latitude?: number | null; + latitude?: number | null /** @description The geographic longitude where the payment originated. */ - longitude?: number | null; + longitude?: number | null /** @description The state/county/province/region where the payment originated. */ - region?: string | null; - }; + region?: string | null + } /** RadarReviewResourceSession */ radar_review_resource_session: { /** @description The browser used in this browser session (e.g., `Chrome`). */ - browser?: string | null; + browser?: string | null /** @description Information about the device used for the browser session (e.g., `Samsung SM-G930T`). */ - device?: string | null; + device?: string | null /** @description The platform for the browser session (e.g., `Macintosh`). */ - platform?: string | null; + platform?: string | null /** @description The version for the browser session (e.g., `61.0.3163.100`). */ - version?: string | null; - }; + version?: string | null + } /** * TransferRecipient * @description With `Recipient` objects, you can transfer money from your Stripe account to a @@ -12062,69 +11907,69 @@ export type components = { */ recipient: { /** @description Hash describing the current account on the recipient, if there is one. */ - active_account?: Partial | null; + active_account?: Partial | null /** CardList */ cards?: { - data: components["schemas"]["card"][]; + data: components['schemas']['card'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } | null; + url: string + } | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The default card to use for creating transfers to this recipient. */ - default_card?: (Partial & Partial) | null; + default_card?: (Partial & Partial) | null /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; - email?: string | null; + description?: string | null + email?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** @description The ID of the [Custom account](https://stripe.com/docs/connect/custom-accounts) this recipient was migrated to. If set, the recipient can no longer be updated, nor can transfers be made to it: use the Custom account instead. */ - migrated_to?: (Partial & Partial) | null; + migrated_to?: (Partial & Partial) | null /** @description Full, legal name of the recipient. */ - name?: string | null; + name?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "recipient"; - rolled_back_from?: Partial & Partial; + object: 'recipient' + rolled_back_from?: Partial & Partial /** @description Type of the recipient, one of `individual` or `corporation`. */ - type: string; - }; + type: string + } /** Recurring */ recurring: { /** * @description Specifies a usage aggregation strategy for prices 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`. * @enum {string|null} */ - aggregate_usage?: ("last_during_period" | "last_ever" | "max" | "sum") | null; + aggregate_usage?: ('last_during_period' | 'last_ever' | 'max' | 'sum') | null /** * @description The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`. * @enum {string} */ - interval: "day" | "month" | "week" | "year"; + interval: 'day' | 'month' | 'week' | 'year' /** @description 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: number; + interval_count: number /** * @description 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`. * @enum {string} */ - usage_type: "licensed" | "metered"; - }; + usage_type: 'licensed' | 'metered' + } /** * Refund * @description `Refund` objects allow you to refund a charge that has previously been created @@ -12135,49 +11980,49 @@ export type components = { */ refund: { /** @description Amount, in %s. */ - amount: number; + amount: number /** @description Balance transaction that describes the impact on your account balance. */ - balance_transaction?: (Partial & Partial) | null; + balance_transaction?: (Partial & Partial) | null /** @description ID of the charge that was refunded. */ - charge?: (Partial & Partial) | null; + charge?: (Partial & Partial) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. (Available on non-card refunds only) */ - description?: string; + description?: string /** @description If the refund failed, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction. */ - failure_balance_transaction?: Partial & Partial; + failure_balance_transaction?: Partial & Partial /** @description If the refund failed, the reason for refund failure if known. Possible values are `lost_or_stolen_card`, `expired_or_canceled_card`, or `unknown`. */ - failure_reason?: string; + failure_reason?: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "refund"; + object: 'refund' /** @description ID of the PaymentIntent that was refunded. */ - payment_intent?: (Partial & Partial) | null; + payment_intent?: (Partial & Partial) | null /** * @description Reason for the refund, either user-provided (`duplicate`, `fraudulent`, or `requested_by_customer`) or generated by Stripe internally (`expired_uncaptured_charge`). * @enum {string|null} */ - reason?: ("duplicate" | "expired_uncaptured_charge" | "fraudulent" | "requested_by_customer") | null; + reason?: ('duplicate' | 'expired_uncaptured_charge' | 'fraudulent' | 'requested_by_customer') | null /** @description This is the transaction number that appears on email receipts sent for this refund. */ - receipt_number?: string | null; + receipt_number?: string | null /** @description The transfer reversal that is associated with the refund. Only present if the charge came from another Stripe account. See the Connect documentation for details. */ - source_transfer_reversal?: (Partial & Partial) | null; + source_transfer_reversal?: (Partial & Partial) | null /** @description Status of the refund. For credit card refunds, this can be `pending`, `succeeded`, or `failed`. For other types of refunds, it can be `pending`, `succeeded`, `failed`, or `canceled`. Refer to our [refunds](https://stripe.com/docs/refunds#failed-refunds) documentation for more details. */ - status?: string | null; + status?: string | null /** @description If the accompanying transfer was reversed, the transfer reversal object. Only applicable if the charge was created using the destination parameter. */ - transfer_reversal?: (Partial & Partial) | null; - }; + transfer_reversal?: (Partial & Partial) | null + } /** * reporting_report_run * @description The Report Run object represents an instance of a report type generated with @@ -12189,47 +12034,47 @@ export type components = { * Note that certain report types can only be run based on your live-mode data (not test-mode * data), and will error when queried without a [live-mode API key](https://stripe.com/docs/keys#test-live-modes). */ - "reporting.report_run": { + 'reporting.report_run': { /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** * @description If something should go wrong during the run, a message about the failure (populated when * `status=failed`). */ - error?: string | null; + error?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description `true` if the report is run on live mode data and `false` if it is run on test mode data. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "reporting.report_run"; - parameters: components["schemas"]["financial_reporting_finance_report_run_run_parameters"]; + object: 'reporting.report_run' + parameters: components['schemas']['financial_reporting_finance_report_run_run_parameters'] /** @description The ID of the [report type](https://stripe.com/docs/reports/report-types) to run, such as `"balance.summary.1"`. */ - report_type: string; + report_type: string /** * @description The file object representing the result of the report run (populated when * `status=succeeded`). */ - result?: Partial | null; + result?: Partial | null /** * @description 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. * Rarely, we may encounter an error, at which point this will be set to `failed` and the `error` field will be populated. */ - status: string; + status: string /** * Format: unix-time * @description Timestamp at which this run successfully finished (populated when * `status=succeeded`). Measured in seconds since the Unix epoch. */ - succeeded_at?: number | null; - }; + succeeded_at?: number | null + } /** * reporting_report_type * @description The Report Type resource corresponds to a particular type of report, such as @@ -12241,53 +12086,53 @@ export type components = { * Note that certain report types can only be run based on your live-mode data (not test-mode * data), and will error when queried without a [live-mode API key](https://stripe.com/docs/keys#test-live-modes). */ - "reporting.report_type": { + 'reporting.report_type': { /** * Format: unix-time * @description Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch. */ - data_available_end: number; + data_available_end: number /** * Format: unix-time * @description Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch. */ - data_available_start: number; + data_available_start: number /** @description 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?: string[] | null; + default_columns?: string[] | null /** @description The [ID of the Report Type](https://stripe.com/docs/reporting/statements/api#available-report-types), such as `balance.summary.1`. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description Human-readable name of the Report Type */ - name: string; + name: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "reporting.report_type"; + object: 'reporting.report_type' /** * Format: unix-time * @description When this Report Type was latest updated. Measured in seconds since the Unix epoch. */ - updated: number; + updated: number /** @description 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: number; - }; + version: number + } /** ReserveTransaction */ reserve_transaction: { - amount: number; + amount: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "reserve_transaction"; - }; + object: 'reserve_transaction' + } /** * RadarReview * @description Reviews can be used to supplement automated fraud detection with human expertise. @@ -12297,55 +12142,55 @@ export type components = { */ review: { /** @description The ZIP or postal code of the card used, if applicable. */ - billing_zip?: string | null; + billing_zip?: string | null /** @description The charge associated with this review. */ - charge?: (Partial & Partial) | null; + charge?: (Partial & Partial) | null /** * @description 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`. * @enum {string|null} */ - closed_reason?: ("approved" | "disputed" | "redacted" | "refunded" | "refunded_as_fraud") | null; + closed_reason?: ('approved' | 'disputed' | 'redacted' | 'refunded' | 'refunded_as_fraud') | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The IP address where the payment originated. */ - ip_address?: string | null; + ip_address?: string | null /** @description 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?: Partial | null; + ip_address_location?: Partial | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "review"; + object: 'review' /** @description If `true`, the review needs action. */ - open: boolean; + open: boolean /** * @description The reason the review was opened. One of `rule` or `manual`. * @enum {string} */ - opened_reason: "manual" | "rule"; + opened_reason: 'manual' | 'rule' /** @description The PaymentIntent ID associated with this review, if one exists. */ - payment_intent?: Partial & Partial; + payment_intent?: Partial & Partial /** @description The reason the review is currently open or closed. One of `rule`, `manual`, `approved`, `refunded`, `refunded_as_fraud`, `disputed`, or `redacted`. */ - reason: string; + reason: string /** @description Information related to the browsing session of the user who initiated the payment. */ - session?: Partial | null; - }; + session?: Partial | null + } /** RadarRule */ rule: { /** @description The action taken on the payment. */ - action: string; + action: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The predicate to evaluate the payment against. */ - predicate: string; - }; + predicate: string + } /** * ScheduledQueryRun * @description If you have [scheduled a Sigma query](https://stripe.com/docs/sigma/scheduled-queries), you'll @@ -12358,48 +12203,48 @@ export type components = { * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** * Format: unix-time * @description When the query was run, Sigma contained a snapshot of your Stripe data at this time. */ - data_load_time: number; - error?: components["schemas"]["sigma_scheduled_query_run_error"]; + data_load_time: number + error?: components['schemas']['sigma_scheduled_query_run_error'] /** @description The file object representing the results of the query. */ - file?: Partial | null; + file?: Partial | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "scheduled_query_run"; + object: 'scheduled_query_run' /** * Format: unix-time * @description Time at which the result expires and is no longer available for download. */ - result_available_until: number; + result_available_until: number /** @description SQL for the query. */ - sql: string; + sql: string /** @description The query's execution status, which will be `completed` for successful runs, and `canceled`, `failed`, or `timed_out` otherwise. */ - status: string; + status: string /** @description Title of the query. */ - title: string; - }; + title: string + } /** SchedulesPhaseAutomaticTax */ schedules_phase_automatic_tax: { /** @description Whether Stripe automatically computes tax on invoices created during this phase. */ - enabled: boolean; - }; + enabled: boolean + } /** sepa_debit_generated_from */ sepa_debit_generated_from: { /** @description The ID of the Charge that generated this PaymentMethod, if any. */ - charge?: (Partial & Partial) | null; + charge?: (Partial & Partial) | null /** @description The ID of the SetupAttempt that generated this PaymentMethod, if any. */ - setup_attempt?: (Partial & Partial) | null; - }; + setup_attempt?: (Partial & Partial) | null + } /** * PaymentFlowsSetupIntentSetupAttempt * @description A SetupAttempt describes one attempted confirmation of a SetupIntent, @@ -12409,100 +12254,96 @@ export type components = { */ setup_attempt: { /** @description 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?: (Partial & Partial) | null; + application?: (Partial & Partial) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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?: - | (Partial & - Partial & - Partial) - | null; + customer?: (Partial & Partial & Partial) | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "setup_attempt"; + object: 'setup_attempt' /** @description 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?: (Partial & Partial) | null; + on_behalf_of?: (Partial & Partial) | null /** @description ID of the payment method used with this SetupAttempt. */ - payment_method: Partial & Partial; - payment_method_details: components["schemas"]["setup_attempt_payment_method_details"]; + payment_method: Partial & Partial + payment_method_details: components['schemas']['setup_attempt_payment_method_details'] /** @description The error encountered during this attempt to confirm the SetupIntent, if any. */ - setup_error?: Partial | null; + setup_error?: Partial | null /** @description ID of the SetupIntent that this attempt belongs to. */ - setup_intent: Partial & Partial; + setup_intent: Partial & Partial /** @description Status of this SetupAttempt, one of `requires_confirmation`, `requires_action`, `processing`, `succeeded`, `failed`, or `abandoned`. */ - status: string; + status: string /** @description 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: string; - }; + usage: string + } /** SetupAttemptPaymentMethodDetails */ setup_attempt_payment_method_details: { - acss_debit?: components["schemas"]["setup_attempt_payment_method_details_acss_debit"]; - au_becs_debit?: components["schemas"]["setup_attempt_payment_method_details_au_becs_debit"]; - bacs_debit?: components["schemas"]["setup_attempt_payment_method_details_bacs_debit"]; - bancontact?: components["schemas"]["setup_attempt_payment_method_details_bancontact"]; - boleto?: components["schemas"]["setup_attempt_payment_method_details_boleto"]; - card?: components["schemas"]["setup_attempt_payment_method_details_card"]; - card_present?: components["schemas"]["setup_attempt_payment_method_details_card_present"]; - ideal?: components["schemas"]["setup_attempt_payment_method_details_ideal"]; - sepa_debit?: components["schemas"]["setup_attempt_payment_method_details_sepa_debit"]; - sofort?: components["schemas"]["setup_attempt_payment_method_details_sofort"]; + acss_debit?: components['schemas']['setup_attempt_payment_method_details_acss_debit'] + au_becs_debit?: components['schemas']['setup_attempt_payment_method_details_au_becs_debit'] + bacs_debit?: components['schemas']['setup_attempt_payment_method_details_bacs_debit'] + bancontact?: components['schemas']['setup_attempt_payment_method_details_bancontact'] + boleto?: components['schemas']['setup_attempt_payment_method_details_boleto'] + card?: components['schemas']['setup_attempt_payment_method_details_card'] + card_present?: components['schemas']['setup_attempt_payment_method_details_card_present'] + ideal?: components['schemas']['setup_attempt_payment_method_details_ideal'] + sepa_debit?: components['schemas']['setup_attempt_payment_method_details_sepa_debit'] + sofort?: components['schemas']['setup_attempt_payment_method_details_sofort'] /** @description 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: string; - }; + type: string + } /** setup_attempt_payment_method_details_acss_debit */ - setup_attempt_payment_method_details_acss_debit: { [key: string]: unknown }; + setup_attempt_payment_method_details_acss_debit: { [key: string]: unknown } /** setup_attempt_payment_method_details_au_becs_debit */ - setup_attempt_payment_method_details_au_becs_debit: { [key: string]: unknown }; + setup_attempt_payment_method_details_au_becs_debit: { [key: string]: unknown } /** setup_attempt_payment_method_details_bacs_debit */ - setup_attempt_payment_method_details_bacs_debit: { [key: string]: unknown }; + setup_attempt_payment_method_details_bacs_debit: { [key: string]: unknown } /** setup_attempt_payment_method_details_bancontact */ setup_attempt_payment_method_details_bancontact: { /** @description Bank code of bank associated with the bank account. */ - bank_code?: string | null; + bank_code?: string | null /** @description Name of the bank associated with the bank account. */ - bank_name?: string | null; + bank_name?: string | null /** @description Bank Identifier Code of the bank associated with the bank account. */ - bic?: string | null; + bic?: string | null /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ - generated_sepa_debit?: (Partial & Partial) | null; + generated_sepa_debit?: (Partial & Partial) | null /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ - generated_sepa_debit_mandate?: (Partial & Partial) | null; + generated_sepa_debit_mandate?: (Partial & Partial) | null /** @description Last four characters of the IBAN. */ - iban_last4?: string | null; + iban_last4?: string | null /** * @description Preferred language of the Bancontact authorization page that the customer is redirected to. * Can be one of `en`, `de`, `fr`, or `nl` * @enum {string|null} */ - preferred_language?: ("de" | "en" | "fr" | "nl") | null; + preferred_language?: ('de' | 'en' | 'fr' | 'nl') | null /** * @description Owner's verified full name. Values are verified or provided by Bancontact directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - verified_name?: string | null; - }; + verified_name?: string | null + } /** setup_attempt_payment_method_details_boleto */ - setup_attempt_payment_method_details_boleto: { [key: string]: unknown }; + setup_attempt_payment_method_details_boleto: { [key: string]: unknown } /** setup_attempt_payment_method_details_card */ setup_attempt_payment_method_details_card: { /** @description Populated if this authorization used 3D Secure authentication. */ - three_d_secure?: Partial | null; - }; + three_d_secure?: Partial | null + } /** setup_attempt_payment_method_details_card_present */ setup_attempt_payment_method_details_card_present: { /** @description The ID of the Card PaymentMethod which was generated by this SetupAttempt. */ - generated_card?: (Partial & Partial) | null; - }; + generated_card?: (Partial & Partial) | null + } /** setup_attempt_payment_method_details_ideal */ setup_attempt_payment_method_details_ideal: { /** @@ -12511,82 +12352,82 @@ export type components = { */ bank?: | ( - | "abn_amro" - | "asn_bank" - | "bunq" - | "handelsbanken" - | "ing" - | "knab" - | "moneyou" - | "rabobank" - | "regiobank" - | "revolut" - | "sns_bank" - | "triodos_bank" - | "van_lanschot" + | 'abn_amro' + | 'asn_bank' + | 'bunq' + | 'handelsbanken' + | 'ing' + | 'knab' + | 'moneyou' + | 'rabobank' + | 'regiobank' + | 'revolut' + | 'sns_bank' + | 'triodos_bank' + | 'van_lanschot' ) - | null; + | null /** * @description The Bank Identifier Code of the customer's bank. * @enum {string|null} */ bic?: | ( - | "ABNANL2A" - | "ASNBNL21" - | "BUNQNL2A" - | "FVLBNL22" - | "HANDNL2A" - | "INGBNL2A" - | "KNABNL2H" - | "MOYONL21" - | "RABONL2U" - | "RBRBNL21" - | "REVOLT21" - | "SNSBNL2A" - | "TRIONL2U" + | 'ABNANL2A' + | 'ASNBNL21' + | 'BUNQNL2A' + | 'FVLBNL22' + | 'HANDNL2A' + | 'INGBNL2A' + | 'KNABNL2H' + | 'MOYONL21' + | 'RABONL2U' + | 'RBRBNL21' + | 'REVOLT21' + | 'SNSBNL2A' + | 'TRIONL2U' ) - | null; + | null /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ - generated_sepa_debit?: (Partial & Partial) | null; + generated_sepa_debit?: (Partial & Partial) | null /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ - generated_sepa_debit_mandate?: (Partial & Partial) | null; + generated_sepa_debit_mandate?: (Partial & Partial) | null /** @description Last four characters of the IBAN. */ - iban_last4?: string | null; + iban_last4?: string | null /** * @description Owner's verified full name. Values are verified or provided by iDEAL directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - verified_name?: string | null; - }; + verified_name?: string | null + } /** setup_attempt_payment_method_details_sepa_debit */ - setup_attempt_payment_method_details_sepa_debit: { [key: string]: unknown }; + setup_attempt_payment_method_details_sepa_debit: { [key: string]: unknown } /** setup_attempt_payment_method_details_sofort */ setup_attempt_payment_method_details_sofort: { /** @description Bank code of bank associated with the bank account. */ - bank_code?: string | null; + bank_code?: string | null /** @description Name of the bank associated with the bank account. */ - bank_name?: string | null; + bank_name?: string | null /** @description Bank Identifier Code of the bank associated with the bank account. */ - bic?: string | null; + bic?: string | null /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ - generated_sepa_debit?: (Partial & Partial) | null; + generated_sepa_debit?: (Partial & Partial) | null /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ - generated_sepa_debit_mandate?: (Partial & Partial) | null; + generated_sepa_debit_mandate?: (Partial & Partial) | null /** @description Last four characters of the IBAN. */ - iban_last4?: string | null; + iban_last4?: string | null /** * @description Preferred language of the Sofort authorization page that the customer is redirected to. * Can be one of `en`, `de`, `fr`, or `nl` * @enum {string|null} */ - preferred_language?: ("de" | "en" | "fr" | "nl") | null; + preferred_language?: ('de' | 'en' | 'fr' | 'nl') | null /** * @description Owner's verified full name. Values are verified or provided by Sofort directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - verified_name?: string | null; - }; + verified_name?: string | null + } /** * SetupIntent * @description A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. @@ -12614,186 +12455,176 @@ export type components = { */ setup_intent: { /** @description ID of the Connect application that created the SetupIntent. */ - application?: (Partial & Partial) | null; + application?: (Partial & Partial) | null /** * @description Reason for cancellation of this SetupIntent, one of `abandoned`, `requested_by_customer`, or `duplicate`. * @enum {string|null} */ - cancellation_reason?: ("abandoned" | "duplicate" | "requested_by_customer") | null; + cancellation_reason?: ('abandoned' | 'duplicate' | 'requested_by_customer') | null /** * @description The client secret of this SetupIntent. Used for client-side retrieval using a publishable key. * * The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, embedded in URLs, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret. */ - client_secret?: string | null; + client_secret?: string | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** * @description ID of the Customer this SetupIntent belongs to, if one exists. * * If 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. */ - customer?: - | (Partial & - Partial & - Partial) - | null; + customer?: (Partial & Partial & Partial) | null /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The error encountered in the previous SetupIntent confirmation. */ - last_setup_error?: Partial | null; + last_setup_error?: Partial | null /** @description The most recent SetupAttempt for this SetupIntent. */ - latest_attempt?: (Partial & Partial) | null; + latest_attempt?: (Partial & Partial) | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description ID of the multi use Mandate generated by the SetupIntent. */ - mandate?: (Partial & Partial) | null; + mandate?: (Partial & Partial) | null /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** @description If present, this property tells you what actions you need to take in order for your customer to continue payment setup. */ - next_action?: Partial | null; + next_action?: Partial | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "setup_intent"; + object: 'setup_intent' /** @description The account (if any) for which the setup is intended. */ - on_behalf_of?: (Partial & Partial) | null; + on_behalf_of?: (Partial & Partial) | null /** @description ID of the payment method used with this SetupIntent. */ - payment_method?: (Partial & Partial) | null; + payment_method?: (Partial & Partial) | null /** @description Payment-method-specific configuration for this SetupIntent. */ - payment_method_options?: Partial | null; + payment_method_options?: Partial | null /** @description The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. */ - payment_method_types: string[]; + payment_method_types: string[] /** @description ID of the single_use Mandate generated by the SetupIntent. */ - single_use_mandate?: (Partial & Partial) | null; + single_use_mandate?: (Partial & Partial) | null /** * @description [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`. * @enum {string} */ - status: - | "canceled" - | "processing" - | "requires_action" - | "requires_confirmation" - | "requires_payment_method" - | "succeeded"; + status: 'canceled' | 'processing' | 'requires_action' | 'requires_confirmation' | 'requires_payment_method' | 'succeeded' /** * @description Indicates how the payment method is intended to be used in the future. * * Use `on_session` if you intend to only reuse the payment method when the customer is in your checkout flow. Use `off_session` if your customer may or may not be in your checkout flow. If not provided, this value defaults to `off_session`. */ - usage: string; - }; + usage: string + } /** SetupIntentNextAction */ setup_intent_next_action: { - redirect_to_url?: components["schemas"]["setup_intent_next_action_redirect_to_url"]; + redirect_to_url?: components['schemas']['setup_intent_next_action_redirect_to_url'] /** @description 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: string; + type: string /** @description 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?: { [key: string]: unknown }; - verify_with_microdeposits?: components["schemas"]["setup_intent_next_action_verify_with_microdeposits"]; - }; + use_stripe_sdk?: { [key: string]: unknown } + verify_with_microdeposits?: components['schemas']['setup_intent_next_action_verify_with_microdeposits'] + } /** SetupIntentNextActionRedirectToUrl */ setup_intent_next_action_redirect_to_url: { /** @description If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion. */ - return_url?: string | null; + return_url?: string | null /** @description The URL you must redirect your customer to in order to authenticate. */ - url?: string | null; - }; + url?: string | null + } /** SetupIntentNextActionVerifyWithMicrodeposits */ setup_intent_next_action_verify_with_microdeposits: { /** * Format: unix-time * @description The timestamp when the microdeposits are expected to land. */ - arrival_date: number; + arrival_date: number /** @description The URL for the hosted verification page, which allows customers to verify their bank account. */ - hosted_verification_url: string; - }; + hosted_verification_url: string + } /** SetupIntentPaymentMethodOptions */ setup_intent_payment_method_options: { - acss_debit?: components["schemas"]["setup_intent_payment_method_options_acss_debit"]; - card?: components["schemas"]["setup_intent_payment_method_options_card"]; - sepa_debit?: components["schemas"]["setup_intent_payment_method_options_sepa_debit"]; - }; + acss_debit?: components['schemas']['setup_intent_payment_method_options_acss_debit'] + card?: components['schemas']['setup_intent_payment_method_options_card'] + sepa_debit?: components['schemas']['setup_intent_payment_method_options_sepa_debit'] + } /** setup_intent_payment_method_options_acss_debit */ setup_intent_payment_method_options_acss_debit: { /** * @description Currency supported by the bank account * @enum {string|null} */ - currency?: ("cad" | "usd") | null; - mandate_options?: components["schemas"]["setup_intent_payment_method_options_mandate_options_acss_debit"]; + currency?: ('cad' | 'usd') | null + mandate_options?: components['schemas']['setup_intent_payment_method_options_mandate_options_acss_debit'] /** * @description Bank account verification method. * @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; - }; + verification_method?: 'automatic' | 'instant' | 'microdeposits' + } /** setup_intent_payment_method_options_card */ setup_intent_payment_method_options_card: { /** * @description 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. Permitted values include: `automatic` or `any`. If not provided, defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. * @enum {string|null} */ - request_three_d_secure?: ("any" | "automatic" | "challenge_only") | null; - }; + request_three_d_secure?: ('any' | 'automatic' | 'challenge_only') | null + } /** setup_intent_payment_method_options_mandate_options_acss_debit */ setup_intent_payment_method_options_mandate_options_acss_debit: { /** @description A URL for custom mandate text */ - custom_mandate_url?: string; + custom_mandate_url?: string /** @description List of Stripe products where this mandate can be selected automatically. */ - default_for?: ("invoice" | "subscription")[]; + default_for?: ('invoice' | 'subscription')[] /** @description Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. */ - interval_description?: string | null; + interval_description?: string | null /** * @description Payment schedule for the mandate. * @enum {string|null} */ - payment_schedule?: ("combined" | "interval" | "sporadic") | null; + payment_schedule?: ('combined' | 'interval' | 'sporadic') | null /** * @description Transaction type of the mandate. * @enum {string|null} */ - transaction_type?: ("business" | "personal") | null; - }; + transaction_type?: ('business' | 'personal') | null + } /** setup_intent_payment_method_options_mandate_options_sepa_debit */ - setup_intent_payment_method_options_mandate_options_sepa_debit: { [key: string]: unknown }; + setup_intent_payment_method_options_mandate_options_sepa_debit: { [key: string]: unknown } /** setup_intent_payment_method_options_sepa_debit */ setup_intent_payment_method_options_sepa_debit: { - mandate_options?: components["schemas"]["setup_intent_payment_method_options_mandate_options_sepa_debit"]; - }; + mandate_options?: components['schemas']['setup_intent_payment_method_options_mandate_options_sepa_debit'] + } /** Shipping */ shipping: { - address?: components["schemas"]["address"]; + address?: components['schemas']['address'] /** @description The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. */ - carrier?: string | null; + carrier?: string | null /** @description Recipient name. */ - name?: string | null; + name?: string | null /** @description Recipient phone (including extension). */ - phone?: string | null; + phone?: string | null /** @description 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?: string | null; - }; + tracking_number?: string | null + } /** ShippingMethod */ shipping_method: { /** @description 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 line item. */ - amount: number; + amount: number /** @description 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: string; + currency: string /** @description The estimated delivery date for the given shipping method. Can be either a specific date or a range. */ - delivery_estimate?: Partial | null; + delivery_estimate?: Partial | null /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description: string; + description: string /** @description Unique identifier for the object. */ - id: string; - }; + id: string + } /** * ShippingRate * @description Shipping rates describe the price of shipping presented to your customers and can be @@ -12801,70 +12632,70 @@ export type components = { */ shipping_rate: { /** @description Whether the shipping rate can be used for new purchases. Defaults to `true`. */ - active: boolean; + active: boolean /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions. */ - delivery_estimate?: Partial | null; + delivery_estimate?: Partial | null /** @description The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions. */ - display_name?: string | null; - fixed_amount?: components["schemas"]["shipping_rate_fixed_amount"]; + display_name?: string | null + fixed_amount?: components['schemas']['shipping_rate_fixed_amount'] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "shipping_rate"; + object: 'shipping_rate' /** * @description Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. * @enum {string|null} */ - tax_behavior?: ("exclusive" | "inclusive" | "unspecified") | null; + tax_behavior?: ('exclusive' | 'inclusive' | 'unspecified') | null /** @description A [tax code](https://stripe.com/docs/tax/tax-codes) ID. The Shipping tax code is `txcd_92010001`. */ - tax_code?: (Partial & Partial) | null; + tax_code?: (Partial & Partial) | null /** * @description The type of calculation to use on the shipping rate. Can only be `fixed_amount` for now. * @enum {string} */ - type: "fixed_amount"; - }; + type: 'fixed_amount' + } /** ShippingRateDeliveryEstimate */ shipping_rate_delivery_estimate: { /** @description The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite. */ - maximum?: Partial | null; + maximum?: Partial | null /** @description The lower bound of the estimated range. If empty, represents no lower bound. */ - minimum?: Partial | null; - }; + minimum?: Partial | null + } /** ShippingRateDeliveryEstimateBound */ shipping_rate_delivery_estimate_bound: { /** * @description A unit of time. * @enum {string} */ - unit: "business_day" | "day" | "hour" | "month" | "week"; + unit: 'business_day' | 'day' | 'hour' | 'month' | 'week' /** @description Must be greater than 0. */ - value: number; - }; + value: number + } /** ShippingRateFixedAmount */ shipping_rate_fixed_amount: { /** @description A non-negative integer in cents representing how much to charge. */ - amount: number; + amount: number /** @description 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: string; - }; + currency: string + } /** SigmaScheduledQueryRunError */ sigma_scheduled_query_run_error: { /** @description Information about the run failure. */ - message: string; - }; + message: string + } /** * Sku * @description Stores representations of [stock keeping units](http://en.wikipedia.org/wiki/Stock_keeping_unit). @@ -12878,51 +12709,51 @@ export type components = { */ sku: { /** @description Whether the SKU is available for purchase. */ - active: boolean; + active: boolean /** @description A dictionary of attributes and values for the attributes defined by the product. If, for example, a product's attributes are `["size", "gender"]`, a valid SKU has the following dictionary of attributes: `{"size": "Medium", "gender": "Unisex"}`. */ - attributes: { [key: string]: string }; + attributes: { [key: string]: string } /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The URL of an image for this SKU, meant to be displayable to the customer. */ - image?: string | null; - inventory: components["schemas"]["sku_inventory"]; + image?: string | null + inventory: components['schemas']['sku_inventory'] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "sku"; + object: 'sku' /** @description The dimensions of this SKU for shipping purposes. */ - package_dimensions?: Partial | null; + package_dimensions?: Partial | null /** @description The cost of the item as a positive integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a zero-decimal currency). */ - price: number; + price: number /** @description The ID of the product this SKU is associated with. The product must be currently active. */ - product: Partial & Partial; + product: Partial & Partial /** * Format: unix-time * @description Time at which the object was last updated. Measured in seconds since the Unix epoch. */ - updated: number; - }; + updated: number + } /** SKUInventory */ sku_inventory: { /** @description The count of inventory available. Will be present if and only if `type` is `finite`. */ - quantity?: number | null; + quantity?: number | null /** @description Inventory type. Possible values are `finite`, `bucket` (not quantified), and `infinite`. */ - type: string; + type: string /** @description An indicator of the inventory available. Possible values are `in_stock`, `limited`, and `out_of_stock`. Will be present if and only if `type` is `bucket`. */ - value?: string | null; - }; + value?: string | null + } /** * Source * @description `Source` objects allow you to accept a variety of payment methods. They @@ -12933,93 +12764,93 @@ export type components = { * Related guides: [Sources API](https://stripe.com/docs/sources) and [Sources & Customers](https://stripe.com/docs/sources/customers). */ source: { - ach_credit_transfer?: components["schemas"]["source_type_ach_credit_transfer"]; - ach_debit?: components["schemas"]["source_type_ach_debit"]; - acss_debit?: components["schemas"]["source_type_acss_debit"]; - alipay?: components["schemas"]["source_type_alipay"]; + ach_credit_transfer?: components['schemas']['source_type_ach_credit_transfer'] + ach_debit?: components['schemas']['source_type_ach_debit'] + acss_debit?: components['schemas']['source_type_acss_debit'] + alipay?: components['schemas']['source_type_alipay'] /** @description 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?: number | null; - au_becs_debit?: components["schemas"]["source_type_au_becs_debit"]; - bancontact?: components["schemas"]["source_type_bancontact"]; - card?: components["schemas"]["source_type_card"]; - card_present?: components["schemas"]["source_type_card_present"]; + amount?: number | null + au_becs_debit?: components['schemas']['source_type_au_becs_debit'] + bancontact?: components['schemas']['source_type_bancontact'] + card?: components['schemas']['source_type_card'] + card_present?: components['schemas']['source_type_card_present'] /** @description The client secret of the source. Used for client-side retrieval using a publishable key. */ - client_secret: string; - code_verification?: components["schemas"]["source_code_verification_flow"]; + client_secret: string + code_verification?: components['schemas']['source_code_verification_flow'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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?: string | null; + currency?: string | null /** @description 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?: string; - eps?: components["schemas"]["source_type_eps"]; + customer?: string + eps?: components['schemas']['source_type_eps'] /** @description The authentication `flow` of the source. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`. */ - flow: string; - giropay?: components["schemas"]["source_type_giropay"]; + flow: string + giropay?: components['schemas']['source_type_giropay'] /** @description Unique identifier for the object. */ - id: string; - ideal?: components["schemas"]["source_type_ideal"]; - klarna?: components["schemas"]["source_type_klarna"]; + id: string + ideal?: components['schemas']['source_type_ideal'] + klarna?: components['schemas']['source_type_klarna'] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; - multibanco?: components["schemas"]["source_type_multibanco"]; + metadata?: { [key: string]: string } | null + multibanco?: components['schemas']['source_type_multibanco'] /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "source"; + object: 'source' /** @description Information about the owner of the payment instrument that may be used or required by particular source types. */ - owner?: Partial | null; - p24?: components["schemas"]["source_type_p24"]; - receiver?: components["schemas"]["source_receiver_flow"]; - redirect?: components["schemas"]["source_redirect_flow"]; - sepa_debit?: components["schemas"]["source_type_sepa_debit"]; - sofort?: components["schemas"]["source_type_sofort"]; - source_order?: components["schemas"]["source_order"]; + owner?: Partial | null + p24?: components['schemas']['source_type_p24'] + receiver?: components['schemas']['source_receiver_flow'] + redirect?: components['schemas']['source_redirect_flow'] + sepa_debit?: components['schemas']['source_type_sepa_debit'] + sofort?: components['schemas']['source_type_sofort'] + source_order?: components['schemas']['source_order'] /** @description Extra information about a source. This will appear on your customer's statement every time you charge the source. */ - statement_descriptor?: string | null; + statement_descriptor?: string | null /** @description The status of the source, one of `canceled`, `chargeable`, `consumed`, `failed`, or `pending`. Only `chargeable` sources can be used to create a charge. */ - status: string; - three_d_secure?: components["schemas"]["source_type_three_d_secure"]; + status: string + three_d_secure?: components['schemas']['source_type_three_d_secure'] /** * @description 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. * @enum {string} */ type: - | "ach_credit_transfer" - | "ach_debit" - | "acss_debit" - | "alipay" - | "au_becs_debit" - | "bancontact" - | "card" - | "card_present" - | "eps" - | "giropay" - | "ideal" - | "klarna" - | "multibanco" - | "p24" - | "sepa_debit" - | "sofort" - | "three_d_secure" - | "wechat"; + | 'ach_credit_transfer' + | 'ach_debit' + | 'acss_debit' + | 'alipay' + | 'au_becs_debit' + | 'bancontact' + | 'card' + | 'card_present' + | 'eps' + | 'giropay' + | 'ideal' + | 'klarna' + | 'multibanco' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'three_d_secure' + | 'wechat' /** @description 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?: string | null; - wechat?: components["schemas"]["source_type_wechat"]; - }; + usage?: string | null + wechat?: components['schemas']['source_type_wechat'] + } /** SourceCodeVerificationFlow */ source_code_verification_flow: { /** @description The number of attempts remaining to authenticate the source object with a verification code. */ - attempts_remaining: number; + attempts_remaining: number /** @description 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: string; - }; + status: string + } /** * SourceMandateNotification * @description Source mandate notifications should be created when a notification related to @@ -13027,124 +12858,124 @@ export type components = { * deliver an email to the customer. */ source_mandate_notification: { - acss_debit?: components["schemas"]["source_mandate_notification_acss_debit_data"]; + acss_debit?: components['schemas']['source_mandate_notification_acss_debit_data'] /** @description 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?: number | null; - bacs_debit?: components["schemas"]["source_mandate_notification_bacs_debit_data"]; + amount?: number | null + bacs_debit?: components['schemas']['source_mandate_notification_bacs_debit_data'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "source_mandate_notification"; + object: 'source_mandate_notification' /** @description The reason of the mandate notification. Valid reasons are `mandate_confirmed` or `debit_initiated`. */ - reason: string; - sepa_debit?: components["schemas"]["source_mandate_notification_sepa_debit_data"]; - source: components["schemas"]["source"]; + reason: string + sepa_debit?: components['schemas']['source_mandate_notification_sepa_debit_data'] + source: components['schemas']['source'] /** @description The status of the mandate notification. Valid statuses are `pending` or `submitted`. */ - status: string; + status: string /** @description 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: string; - }; + type: string + } /** SourceMandateNotificationAcssDebitData */ source_mandate_notification_acss_debit_data: { /** @description The statement descriptor associate with the debit. */ - statement_descriptor?: string; - }; + statement_descriptor?: string + } /** SourceMandateNotificationBacsDebitData */ source_mandate_notification_bacs_debit_data: { /** @description Last 4 digits of the account number associated with the debit. */ - last4?: string; - }; + last4?: string + } /** SourceMandateNotificationSepaDebitData */ source_mandate_notification_sepa_debit_data: { /** @description SEPA creditor ID. */ - creditor_identifier?: string; + creditor_identifier?: string /** @description Last 4 digits of the account number associated with the debit. */ - last4?: string; + last4?: string /** @description Mandate reference associated with the debit. */ - mandate_reference?: string; - }; + mandate_reference?: string + } /** SourceOrder */ source_order: { /** @description 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: number; + amount: number /** @description 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: string; + currency: string /** @description The email address of the customer placing the order. */ - email?: string; + email?: string /** @description List of items constituting the order. */ - items?: components["schemas"]["source_order_item"][] | null; - shipping?: components["schemas"]["shipping"]; - }; + items?: components['schemas']['source_order_item'][] | null + shipping?: components['schemas']['shipping'] + } /** SourceOrderItem */ source_order_item: { /** @description The amount (price) for this order item. */ - amount?: number | null; + amount?: number | null /** @description This currency of this order item. Required when `amount` is present. */ - currency?: string | null; + currency?: string | null /** @description Human-readable description for this order item. */ - description?: string | null; + description?: string | null /** @description The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a SKU). */ - parent?: string | null; + parent?: string | null /** @description The quantity of this order item. When type is `sku`, this is the number of instances of the SKU to be ordered. */ - quantity?: number; + quantity?: number /** @description The type of this order item. Must be `sku`, `tax`, or `shipping`. */ - type?: string | null; - }; + type?: string | null + } /** SourceOwner */ source_owner: { /** @description Owner's address. */ - address?: Partial | null; + address?: Partial | null /** @description Owner's email address. */ - email?: string | null; + email?: string | null /** @description Owner's full name. */ - name?: string | null; + name?: string | null /** @description Owner's phone number (including extension). */ - phone?: string | null; + phone?: string | null /** @description 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?: Partial | null; + verified_address?: Partial | null /** @description 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?: string | null; + verified_email?: string | null /** @description 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?: string | null; + verified_name?: string | null /** @description 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?: string | null; - }; + verified_phone?: string | null + } /** SourceReceiverFlow */ source_receiver_flow: { /** @description The address of the receiver source. This is the value that should be communicated to the customer to send their funds to. */ - address?: string | null; + address?: string | null /** @description 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: number; + amount_charged: number /** @description 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: number; + amount_received: number /** @description The total amount that was returned to the customer. The amount returned is expressed in the source's currency. */ - amount_returned: number; + amount_returned: number /** @description Type of refund attribute method, one of `email`, `manual`, or `none`. */ - refund_attributes_method: string; + refund_attributes_method: string /** @description Type of refund attribute status, one of `missing`, `requested`, or `available`. */ - refund_attributes_status: string; - }; + refund_attributes_status: string + } /** SourceRedirectFlow */ source_redirect_flow: { /** @description 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?: string | null; + failure_reason?: string | null /** @description The URL you provide to redirect the customer to after they authenticated their payment. */ - return_url: string; + return_url: string /** @description 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: string; + status: string /** @description The URL provided to you to redirect a customer to as part of a `redirect` authentication flow. */ - url: string; - }; + url: string + } /** * SourceTransaction * @description Some payment methods have no required amount that a customer must send. @@ -13153,325 +12984,325 @@ export type components = { * transactions. */ source_transaction: { - ach_credit_transfer?: components["schemas"]["source_transaction_ach_credit_transfer_data"]; + ach_credit_transfer?: components['schemas']['source_transaction_ach_credit_transfer_data'] /** @description 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: number; - chf_credit_transfer?: components["schemas"]["source_transaction_chf_credit_transfer_data"]; + amount: number + chf_credit_transfer?: components['schemas']['source_transaction_chf_credit_transfer_data'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; - gbp_credit_transfer?: components["schemas"]["source_transaction_gbp_credit_transfer_data"]; + currency: string + gbp_credit_transfer?: components['schemas']['source_transaction_gbp_credit_transfer_data'] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "source_transaction"; - paper_check?: components["schemas"]["source_transaction_paper_check_data"]; - sepa_credit_transfer?: components["schemas"]["source_transaction_sepa_credit_transfer_data"]; + object: 'source_transaction' + paper_check?: components['schemas']['source_transaction_paper_check_data'] + sepa_credit_transfer?: components['schemas']['source_transaction_sepa_credit_transfer_data'] /** @description The ID of the source this transaction is attached to. */ - source: string; + source: string /** @description The status of the transaction, one of `succeeded`, `pending`, or `failed`. */ - status: string; + status: string /** * @description The type of source this transaction is attached to. * @enum {string} */ type: - | "ach_credit_transfer" - | "ach_debit" - | "alipay" - | "bancontact" - | "card" - | "card_present" - | "eps" - | "giropay" - | "ideal" - | "klarna" - | "multibanco" - | "p24" - | "sepa_debit" - | "sofort" - | "three_d_secure" - | "wechat"; - }; + | 'ach_credit_transfer' + | 'ach_debit' + | 'alipay' + | 'bancontact' + | 'card' + | 'card_present' + | 'eps' + | 'giropay' + | 'ideal' + | 'klarna' + | 'multibanco' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'three_d_secure' + | 'wechat' + } /** SourceTransactionAchCreditTransferData */ source_transaction_ach_credit_transfer_data: { /** @description Customer data associated with the transfer. */ - customer_data?: string; + customer_data?: string /** @description Bank account fingerprint associated with the transfer. */ - fingerprint?: string; + fingerprint?: string /** @description Last 4 digits of the account number associated with the transfer. */ - last4?: string; + last4?: string /** @description Routing number associated with the transfer. */ - routing_number?: string; - }; + routing_number?: string + } /** SourceTransactionChfCreditTransferData */ source_transaction_chf_credit_transfer_data: { /** @description Reference associated with the transfer. */ - reference?: string; + reference?: string /** @description Sender's country address. */ - sender_address_country?: string; + sender_address_country?: string /** @description Sender's line 1 address. */ - sender_address_line1?: string; + sender_address_line1?: string /** @description Sender's bank account IBAN. */ - sender_iban?: string; + sender_iban?: string /** @description Sender's name. */ - sender_name?: string; - }; + sender_name?: string + } /** SourceTransactionGbpCreditTransferData */ source_transaction_gbp_credit_transfer_data: { /** @description Bank account fingerprint associated with the Stripe owned bank account receiving the transfer. */ - fingerprint?: string; + fingerprint?: string /** @description 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?: string; + funding_method?: string /** @description Last 4 digits of sender account number associated with the transfer. */ - last4?: string; + last4?: string /** @description Sender entered arbitrary information about the transfer. */ - reference?: string; + reference?: string /** @description Sender account number associated with the transfer. */ - sender_account_number?: string; + sender_account_number?: string /** @description Sender name associated with the transfer. */ - sender_name?: string; + sender_name?: string /** @description Sender sort code associated with the transfer. */ - sender_sort_code?: string; - }; + sender_sort_code?: string + } /** SourceTransactionPaperCheckData */ source_transaction_paper_check_data: { /** @description Time at which the deposited funds will be available for use. Measured in seconds since the Unix epoch. */ - available_at?: string; + available_at?: string /** @description Comma-separated list of invoice IDs associated with the paper check. */ - invoices?: string; - }; + invoices?: string + } /** SourceTransactionSepaCreditTransferData */ source_transaction_sepa_credit_transfer_data: { /** @description Reference associated with the transfer. */ - reference?: string; + reference?: string /** @description Sender's bank account IBAN. */ - sender_iban?: string; + sender_iban?: string /** @description Sender's name. */ - sender_name?: string; - }; + sender_name?: string + } source_type_ach_credit_transfer: { - account_number?: string | null; - bank_name?: string | null; - fingerprint?: string | null; - refund_account_holder_name?: string | null; - refund_account_holder_type?: string | null; - refund_routing_number?: string | null; - routing_number?: string | null; - swift_code?: string | null; - }; + account_number?: string | null + bank_name?: string | null + fingerprint?: string | null + refund_account_holder_name?: string | null + refund_account_holder_type?: string | null + refund_routing_number?: string | null + routing_number?: string | null + swift_code?: string | null + } source_type_ach_debit: { - bank_name?: string | null; - country?: string | null; - fingerprint?: string | null; - last4?: string | null; - routing_number?: string | null; - type?: string | null; - }; + bank_name?: string | null + country?: string | null + fingerprint?: string | null + last4?: string | null + routing_number?: string | null + type?: string | null + } source_type_acss_debit: { - bank_address_city?: string | null; - bank_address_line_1?: string | null; - bank_address_line_2?: string | null; - bank_address_postal_code?: string | null; - bank_name?: string | null; - category?: string | null; - country?: string | null; - fingerprint?: string | null; - last4?: string | null; - routing_number?: string | null; - }; + bank_address_city?: string | null + bank_address_line_1?: string | null + bank_address_line_2?: string | null + bank_address_postal_code?: string | null + bank_name?: string | null + category?: string | null + country?: string | null + fingerprint?: string | null + last4?: string | null + routing_number?: string | null + } source_type_alipay: { - data_string?: string | null; - native_url?: string | null; - statement_descriptor?: string | null; - }; + data_string?: string | null + native_url?: string | null + statement_descriptor?: string | null + } source_type_au_becs_debit: { - bsb_number?: string | null; - fingerprint?: string | null; - last4?: string | null; - }; + bsb_number?: string | null + fingerprint?: string | null + last4?: string | null + } source_type_bancontact: { - bank_code?: string | null; - bank_name?: string | null; - bic?: string | null; - iban_last4?: string | null; - preferred_language?: string | null; - statement_descriptor?: string | null; - }; + bank_code?: string | null + bank_name?: string | null + bic?: string | null + iban_last4?: string | null + preferred_language?: string | null + statement_descriptor?: string | null + } source_type_card: { - address_line1_check?: string | null; - address_zip_check?: string | null; - brand?: string | null; - country?: string | null; - cvc_check?: string | null; - dynamic_last4?: string | null; - exp_month?: number | null; - exp_year?: number | null; - fingerprint?: string; - funding?: string | null; - last4?: string | null; - name?: string | null; - three_d_secure?: string; - tokenization_method?: string | null; - }; + address_line1_check?: string | null + address_zip_check?: string | null + brand?: string | null + country?: string | null + cvc_check?: string | null + dynamic_last4?: string | null + exp_month?: number | null + exp_year?: number | null + fingerprint?: string + funding?: string | null + last4?: string | null + name?: string | null + three_d_secure?: string + tokenization_method?: string | null + } source_type_card_present: { - application_cryptogram?: string; - application_preferred_name?: string; - authorization_code?: string | null; - authorization_response_code?: string; - brand?: string | null; - country?: string | null; - cvm_type?: string; - data_type?: string | null; - dedicated_file_name?: string; - emv_auth_data?: string; - evidence_customer_signature?: string | null; - evidence_transaction_certificate?: string | null; - exp_month?: number | null; - exp_year?: number | null; - fingerprint?: string; - funding?: string | null; - last4?: string | null; - pos_device_id?: string | null; - pos_entry_mode?: string; - read_method?: string | null; - reader?: string | null; - terminal_verification_results?: string; - transaction_status_information?: string; - }; + application_cryptogram?: string + application_preferred_name?: string + authorization_code?: string | null + authorization_response_code?: string + brand?: string | null + country?: string | null + cvm_type?: string + data_type?: string | null + dedicated_file_name?: string + emv_auth_data?: string + evidence_customer_signature?: string | null + evidence_transaction_certificate?: string | null + exp_month?: number | null + exp_year?: number | null + fingerprint?: string + funding?: string | null + last4?: string | null + pos_device_id?: string | null + pos_entry_mode?: string + read_method?: string | null + reader?: string | null + terminal_verification_results?: string + transaction_status_information?: string + } source_type_eps: { - reference?: string | null; - statement_descriptor?: string | null; - }; + reference?: string | null + statement_descriptor?: string | null + } source_type_giropay: { - bank_code?: string | null; - bank_name?: string | null; - bic?: string | null; - statement_descriptor?: string | null; - }; + bank_code?: string | null + bank_name?: string | null + bic?: string | null + statement_descriptor?: string | null + } source_type_ideal: { - bank?: string | null; - bic?: string | null; - iban_last4?: string | null; - statement_descriptor?: string | null; - }; + bank?: string | null + bic?: string | null + iban_last4?: string | null + statement_descriptor?: string | null + } source_type_klarna: { - background_image_url?: string; - client_token?: string | null; - first_name?: string; - last_name?: string; - locale?: string; - logo_url?: string; - page_title?: string; - pay_later_asset_urls_descriptive?: string; - pay_later_asset_urls_standard?: string; - pay_later_name?: string; - pay_later_redirect_url?: string; - pay_now_asset_urls_descriptive?: string; - pay_now_asset_urls_standard?: string; - pay_now_name?: string; - pay_now_redirect_url?: string; - pay_over_time_asset_urls_descriptive?: string; - pay_over_time_asset_urls_standard?: string; - pay_over_time_name?: string; - pay_over_time_redirect_url?: string; - payment_method_categories?: string; - purchase_country?: string; - purchase_type?: string; - redirect_url?: string; - shipping_delay?: number; - shipping_first_name?: string; - shipping_last_name?: string; - }; + background_image_url?: string + client_token?: string | null + first_name?: string + last_name?: string + locale?: string + logo_url?: string + page_title?: string + pay_later_asset_urls_descriptive?: string + pay_later_asset_urls_standard?: string + pay_later_name?: string + pay_later_redirect_url?: string + pay_now_asset_urls_descriptive?: string + pay_now_asset_urls_standard?: string + pay_now_name?: string + pay_now_redirect_url?: string + pay_over_time_asset_urls_descriptive?: string + pay_over_time_asset_urls_standard?: string + pay_over_time_name?: string + pay_over_time_redirect_url?: string + payment_method_categories?: string + purchase_country?: string + purchase_type?: string + redirect_url?: string + shipping_delay?: number + shipping_first_name?: string + shipping_last_name?: string + } source_type_multibanco: { - entity?: string | null; - reference?: string | null; - refund_account_holder_address_city?: string | null; - refund_account_holder_address_country?: string | null; - refund_account_holder_address_line1?: string | null; - refund_account_holder_address_line2?: string | null; - refund_account_holder_address_postal_code?: string | null; - refund_account_holder_address_state?: string | null; - refund_account_holder_name?: string | null; - refund_iban?: string | null; - }; + entity?: string | null + reference?: string | null + refund_account_holder_address_city?: string | null + refund_account_holder_address_country?: string | null + refund_account_holder_address_line1?: string | null + refund_account_holder_address_line2?: string | null + refund_account_holder_address_postal_code?: string | null + refund_account_holder_address_state?: string | null + refund_account_holder_name?: string | null + refund_iban?: string | null + } source_type_p24: { - reference?: string | null; - }; + reference?: string | null + } source_type_sepa_debit: { - bank_code?: string | null; - branch_code?: string | null; - country?: string | null; - fingerprint?: string | null; - last4?: string | null; - mandate_reference?: string | null; - mandate_url?: string | null; - }; + bank_code?: string | null + branch_code?: string | null + country?: string | null + fingerprint?: string | null + last4?: string | null + mandate_reference?: string | null + mandate_url?: string | null + } source_type_sofort: { - bank_code?: string | null; - bank_name?: string | null; - bic?: string | null; - country?: string | null; - iban_last4?: string | null; - preferred_language?: string | null; - statement_descriptor?: string | null; - }; + bank_code?: string | null + bank_name?: string | null + bic?: string | null + country?: string | null + iban_last4?: string | null + preferred_language?: string | null + statement_descriptor?: string | null + } source_type_three_d_secure: { - address_line1_check?: string | null; - address_zip_check?: string | null; - authenticated?: boolean | null; - brand?: string | null; - card?: string | null; - country?: string | null; - customer?: string | null; - cvc_check?: string | null; - dynamic_last4?: string | null; - exp_month?: number | null; - exp_year?: number | null; - fingerprint?: string; - funding?: string | null; - last4?: string | null; - name?: string | null; - three_d_secure?: string; - tokenization_method?: string | null; - }; + address_line1_check?: string | null + address_zip_check?: string | null + authenticated?: boolean | null + brand?: string | null + card?: string | null + country?: string | null + customer?: string | null + cvc_check?: string | null + dynamic_last4?: string | null + exp_month?: number | null + exp_year?: number | null + fingerprint?: string + funding?: string | null + last4?: string | null + name?: string | null + three_d_secure?: string + tokenization_method?: string | null + } source_type_wechat: { - prepay_id?: string; - qr_code_url?: string | null; - statement_descriptor?: string; - }; + prepay_id?: string + qr_code_url?: string | null + statement_descriptor?: string + } /** StatusTransitions */ status_transitions: { /** * Format: unix-time * @description The time that the order was canceled. */ - canceled?: number | null; + canceled?: number | null /** * Format: unix-time * @description The time that the order was fulfilled. */ - fulfiled?: number | null; + fulfiled?: number | null /** * Format: unix-time * @description The time that the order was paid. */ - paid?: number | null; + paid?: number | null /** * Format: unix-time * @description The time that the order was returned. */ - returned?: number | null; - }; + returned?: number | null + } /** * Subscription * @description Subscriptions allow you to charge a customer on a recurring basis. @@ -13480,127 +13311,123 @@ export type components = { */ subscription: { /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. */ - application_fee_percent?: number | null; - automatic_tax: components["schemas"]["subscription_automatic_tax"]; + application_fee_percent?: number | null + automatic_tax: components['schemas']['subscription_automatic_tax'] /** * Format: unix-time * @description Determines the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. */ - billing_cycle_anchor: number; + billing_cycle_anchor: number /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period */ - billing_thresholds?: Partial | null; + billing_thresholds?: Partial | null /** * Format: unix-time * @description A date in the future at which the subscription will automatically get canceled */ - cancel_at?: number | null; + cancel_at?: number | null /** @description If the subscription has been canceled with the `at_period_end` flag set to `true`, `cancel_at_period_end` on the subscription will be true. You can use this attribute to determine whether a subscription that has a status of active is scheduled to be canceled at the end of the current period. */ - cancel_at_period_end: boolean; + cancel_at_period_end: boolean /** * Format: unix-time * @description 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?: number | null; + canceled_at?: number | null /** * @description 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. * @enum {string} */ - collection_method: "charge_automatically" | "send_invoice"; + collection_method: 'charge_automatically' | 'send_invoice' /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** * Format: unix-time * @description 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: number; + current_period_end: number /** * Format: unix-time * @description Start of the current period that the subscription has been invoiced for. */ - current_period_start: number; + current_period_start: number /** @description ID of the customer who owns the subscription. */ - customer: Partial & - Partial & - Partial; + customer: Partial & Partial & Partial /** @description 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?: number | null; + days_until_due?: number | null /** @description 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?: (Partial & Partial) | null; + default_payment_method?: (Partial & Partial) | null /** @description 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?: | (Partial & - Partial & - Partial & - Partial & - Partial & - Partial) - | null; + Partial & + Partial & + Partial & + Partial & + Partial) + | null /** @description 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?: components["schemas"]["tax_rate"][] | null; + default_tax_rates?: components['schemas']['tax_rate'][] | null /** @description 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. */ - discount?: Partial | null; + discount?: Partial | null /** * Format: unix-time * @description If the subscription has ended, the date the subscription ended. */ - ended_at?: number | null; + ended_at?: number | null /** @description Unique identifier for the object. */ - id: string; + id: string /** * SubscriptionItemList * @description List of subscription items, each with an attached price. */ items: { /** @description Details about each object. */ - data: components["schemas"]["subscription_item"][]; + data: components['schemas']['subscription_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** @description The most recent invoice this subscription has generated. */ - latest_invoice?: (Partial & Partial) | null; + latest_invoice?: (Partial & Partial) | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * Format: unix-time * @description 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?: number | null; + next_pending_invoice_item_invoice?: number | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "subscription"; + object: 'subscription' /** @description If specified, payment collection for this subscription will be paused. */ - pause_collection?: Partial | null; + pause_collection?: Partial | null /** @description Payment settings passed on to invoices created by the subscription. */ - payment_settings?: Partial | null; + payment_settings?: Partial | null /** @description 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?: Partial< - components["schemas"]["subscription_pending_invoice_item_interval"] - > | null; + pending_invoice_item_interval?: Partial | null /** @description 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?: (Partial & Partial) | null; + pending_setup_intent?: (Partial & Partial) | null /** @description 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?: Partial | null; + pending_update?: Partial | null /** @description The schedule attached to the subscription */ - schedule?: (Partial & Partial) | null; + schedule?: (Partial & Partial) | null /** * Format: unix-time * @description Date when the subscription was first created. The date might differ from the `created` date due to backdating. */ - start_date: number; + start_date: number /** * @description Possible values are `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `canceled`, or `unpaid`. * @@ -13613,32 +13440,32 @@ export type components = { * If 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. * @enum {string} */ - status: "active" | "canceled" | "incomplete" | "incomplete_expired" | "past_due" | "trialing" | "unpaid"; + status: 'active' | 'canceled' | 'incomplete' | 'incomplete_expired' | 'past_due' | 'trialing' | 'unpaid' /** @description 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?: Partial | null; + transfer_data?: Partial | null /** * Format: unix-time * @description If the subscription has a trial, the end of that trial. */ - trial_end?: number | null; + trial_end?: number | null /** * Format: unix-time * @description If the subscription has a trial, the beginning of that trial. */ - trial_start?: number | null; - }; + trial_start?: number | null + } /** SubscriptionAutomaticTax */ subscription_automatic_tax: { /** @description Whether Stripe automatically computes tax on this subscription. */ - enabled: boolean; - }; + enabled: boolean + } /** SubscriptionBillingThresholds */ subscription_billing_thresholds: { /** @description Monetary threshold that triggers the subscription to create an invoice */ - amount_gte?: number | null; + amount_gte?: number | null /** @description 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?: boolean | null; - }; + reset_billing_cycle_anchor?: boolean | null + } /** * SubscriptionItem * @description Subscription items allow you to create customer subscriptions with more than @@ -13646,50 +13473,50 @@ export type components = { */ subscription_item: { /** @description Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period */ - billing_thresholds?: Partial | null; + billing_thresholds?: Partial | null /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Unique identifier for the object. */ - id: string; + id: string /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "subscription_item"; - price: components["schemas"]["price"]; + object: 'subscription_item' + price: components['schemas']['price'] /** @description The [quantity](https://stripe.com/docs/subscriptions/quantities) of the plan to which the customer should be subscribed. */ - quantity?: number; + quantity?: number /** @description The `subscription` this `subscription_item` belongs to. */ - subscription: string; + subscription: string /** @description 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?: components["schemas"]["tax_rate"][] | null; - }; + tax_rates?: components['schemas']['tax_rate'][] | null + } /** SubscriptionItemBillingThresholds */ subscription_item_billing_thresholds: { /** @description Usage threshold that triggers the subscription to create an invoice */ - usage_gte?: number | null; - }; + usage_gte?: number | null + } /** subscription_payment_method_options_card */ subscription_payment_method_options_card: { - mandate_options?: components["schemas"]["invoice_mandate_options_card"]; + mandate_options?: components['schemas']['invoice_mandate_options_card'] /** * @description 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#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. * @enum {string|null} */ - request_three_d_secure?: ("any" | "automatic") | null; - }; + request_three_d_secure?: ('any' | 'automatic') | null + } /** SubscriptionPendingInvoiceItemInterval */ subscription_pending_invoice_item_interval: { /** * @description Specifies invoicing frequency. Either `day`, `week`, `month` or `year`. * @enum {string} */ - interval: "day" | "month" | "week" | "year"; + interval: 'day' | 'month' | 'week' | 'year' /** @description 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: number; - }; + interval_count: number + } /** * SubscriptionSchedule * @description A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes. @@ -13701,195 +13528,185 @@ export type components = { * Format: unix-time * @description Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch. */ - canceled_at?: number | null; + canceled_at?: number | null /** * Format: unix-time * @description Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch. */ - completed_at?: number | null; + completed_at?: number | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Object representing the start and end dates for the current phase of the subscription schedule, if it is `active`. */ - current_phase?: Partial | null; + current_phase?: Partial | null /** @description ID of the customer who owns the subscription schedule. */ - customer: Partial & - Partial & - Partial; - default_settings: components["schemas"]["subscription_schedules_resource_default_settings"]; + customer: Partial & Partial & Partial + default_settings: components['schemas']['subscription_schedules_resource_default_settings'] /** * @description Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` and `cancel`. * @enum {string} */ - end_behavior: "cancel" | "none" | "release" | "renew"; + end_behavior: 'cancel' | 'none' | 'release' | 'renew' /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "subscription_schedule"; + object: 'subscription_schedule' /** @description Configuration for the subscription schedule's phases. */ - phases: components["schemas"]["subscription_schedule_phase_configuration"][]; + phases: components['schemas']['subscription_schedule_phase_configuration'][] /** * Format: unix-time * @description Time at which the subscription schedule was released. Measured in seconds since the Unix epoch. */ - released_at?: number | null; + released_at?: number | null /** @description ID of the subscription once managed by the subscription schedule (if it is released). */ - released_subscription?: string | null; + released_subscription?: string | null /** * @description 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). * @enum {string} */ - status: "active" | "canceled" | "completed" | "not_started" | "released"; + status: 'active' | 'canceled' | 'completed' | 'not_started' | 'released' /** @description ID of the subscription managed by the subscription schedule. */ - subscription?: (Partial & Partial) | null; - }; + subscription?: (Partial & Partial) | null + } /** * SubscriptionScheduleAddInvoiceItem * @description An Add Invoice Item describes the prices and quantities that will be added as pending invoice items when entering a phase. */ subscription_schedule_add_invoice_item: { /** @description ID of the price used to generate the invoice item. */ - price: Partial & - Partial & - Partial; + price: Partial & Partial & Partial /** @description The quantity of the invoice item. */ - quantity?: number | null; + quantity?: number | null /** @description The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item. */ - tax_rates?: components["schemas"]["tax_rate"][] | null; - }; + tax_rates?: components['schemas']['tax_rate'][] | null + } /** * SubscriptionScheduleConfigurationItem * @description A phase item describes the price and quantity of a phase. */ subscription_schedule_configuration_item: { /** @description Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period */ - billing_thresholds?: Partial | null; + billing_thresholds?: Partial | null /** @description ID of the price to which the customer should be subscribed. */ - price: Partial & - Partial & - Partial; + price: Partial & Partial & Partial /** @description Quantity of the plan to which the customer should be subscribed. */ - quantity?: number; + quantity?: number /** @description 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?: components["schemas"]["tax_rate"][] | null; - }; + tax_rates?: components['schemas']['tax_rate'][] | null + } /** SubscriptionScheduleCurrentPhase */ subscription_schedule_current_phase: { /** * Format: unix-time * @description The end of this phase of the subscription schedule. */ - end_date: number; + end_date: number /** * Format: unix-time * @description The start of this phase of the subscription schedule. */ - start_date: number; - }; + start_date: number + } /** * SubscriptionSchedulePhaseConfiguration * @description A phase describes the plans, coupon, and trialing status of a subscription for a predefined time period. */ subscription_schedule_phase_configuration: { /** @description A list of prices and quantities that will generate invoice items appended to the first invoice for this phase. */ - add_invoice_items: components["schemas"]["subscription_schedule_add_invoice_item"][]; + add_invoice_items: components['schemas']['subscription_schedule_add_invoice_item'][] /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account during this phase of the schedule. */ - application_fee_percent?: number | null; - automatic_tax?: components["schemas"]["schedules_phase_automatic_tax"]; + application_fee_percent?: number | null + automatic_tax?: components['schemas']['schedules_phase_automatic_tax'] /** * @description 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). * @enum {string|null} */ - billing_cycle_anchor?: ("automatic" | "phase_start") | null; + billing_cycle_anchor?: ('automatic' | 'phase_start') | null /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period */ - billing_thresholds?: Partial | null; + billing_thresholds?: Partial | null /** * @description 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. * @enum {string|null} */ - collection_method?: ("charge_automatically" | "send_invoice") | null; + collection_method?: ('charge_automatically' | 'send_invoice') | null /** @description ID of the coupon to use during this phase of the subscription schedule. */ - coupon?: - | (Partial & - Partial & - Partial) - | null; + coupon?: (Partial & Partial & Partial) | null /** @description 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?: (Partial & Partial) | null; + default_payment_method?: (Partial & Partial) | null /** @description The default tax rates to apply to the subscription during this phase of the subscription schedule. */ - default_tax_rates?: components["schemas"]["tax_rate"][] | null; + default_tax_rates?: components['schemas']['tax_rate'][] | null /** * Format: unix-time * @description The end of this phase of the subscription schedule. */ - end_date: number; + end_date: number /** @description The invoice settings applicable during this phase. */ - invoice_settings?: Partial | null; + invoice_settings?: Partial | null /** @description Subscription items to configure the subscription to during this phase of the subscription schedule. */ - items: components["schemas"]["subscription_schedule_configuration_item"][]; + items: components['schemas']['subscription_schedule_configuration_item'][] /** * @description If the subscription schedule will prorate when transitioning to this phase. Possible values are `create_prorations` and `none`. * @enum {string} */ - proration_behavior: "always_invoice" | "create_prorations" | "none"; + proration_behavior: 'always_invoice' | 'create_prorations' | 'none' /** * Format: unix-time * @description The start of this phase of the subscription schedule. */ - start_date: number; + start_date: number /** @description 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?: Partial | null; + transfer_data?: Partial | null /** * Format: unix-time * @description When the trial ends within the phase. */ - trial_end?: number | null; - }; + trial_end?: number | null + } /** SubscriptionSchedulesResourceDefaultSettings */ subscription_schedules_resource_default_settings: { /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account during this phase of the schedule. */ - application_fee_percent?: number | null; - automatic_tax?: components["schemas"]["subscription_schedules_resource_default_settings_automatic_tax"]; + application_fee_percent?: number | null + automatic_tax?: components['schemas']['subscription_schedules_resource_default_settings_automatic_tax'] /** * @description 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). * @enum {string} */ - billing_cycle_anchor: "automatic" | "phase_start"; + billing_cycle_anchor: 'automatic' | 'phase_start' /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period */ - billing_thresholds?: Partial | null; + billing_thresholds?: Partial | null /** * @description 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. * @enum {string|null} */ - collection_method?: ("charge_automatically" | "send_invoice") | null; + collection_method?: ('charge_automatically' | 'send_invoice') | null /** @description 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?: (Partial & Partial) | null; + default_payment_method?: (Partial & Partial) | null /** @description The subscription schedule's default invoice settings. */ - invoice_settings?: Partial | null; + invoice_settings?: Partial | null /** @description 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?: Partial | null; - }; + transfer_data?: Partial | null + } /** SubscriptionSchedulesResourceDefaultSettingsAutomaticTax */ subscription_schedules_resource_default_settings_automatic_tax: { /** @description Whether Stripe automatically computes tax on invoices created during this phase. */ - enabled: boolean; - }; + enabled: boolean + } /** SubscriptionTransferData */ subscription_transfer_data: { /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the destination account. By default, the entire amount is transferred to the destination. */ - amount_percent?: number | null; + amount_percent?: number | null /** @description The account where funds from the payment will be transferred to upon payment success. */ - destination: Partial & Partial; - }; + destination: Partial & Partial + } /** * SubscriptionsResourcePauseCollection * @description The Pause Collection settings determine how we will pause collection for this subscription and for how long the subscription @@ -13900,47 +13717,47 @@ export type components = { * @description The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`. * @enum {string} */ - behavior: "keep_as_draft" | "mark_uncollectible" | "void"; + behavior: 'keep_as_draft' | 'mark_uncollectible' | 'void' /** * Format: unix-time * @description The time after which the subscription will resume collecting payments. */ - resumes_at?: number | null; - }; + resumes_at?: number | null + } /** SubscriptionsResourcePaymentMethodOptions */ subscriptions_resource_payment_method_options: { /** @description This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to invoices created by the subscription. */ - acss_debit?: Partial | null; + acss_debit?: Partial | null /** @description This sub-hash contains details about the Bancontact payment method options to pass to invoices created by the subscription. */ - bancontact?: Partial | null; + bancontact?: Partial | null /** @description This sub-hash contains details about the Card payment method options to pass to invoices created by the subscription. */ - card?: Partial | null; - }; + card?: Partial | null + } /** SubscriptionsResourcePaymentSettings */ subscriptions_resource_payment_settings: { /** @description Payment-method-specific configuration to provide to invoices created by the subscription. */ - payment_method_options?: Partial | null; + payment_method_options?: Partial | null /** @description 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?: | ( - | "ach_credit_transfer" - | "ach_debit" - | "acss_debit" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "sepa_debit" - | "sofort" - | "wechat_pay" + | 'ach_credit_transfer' + | 'ach_debit' + | 'acss_debit' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' )[] - | null; - }; + | null + } /** * SubscriptionsResourcePendingUpdate * @description Pending Updates store the changes pending from a previous update that will be applied @@ -13951,61 +13768,61 @@ export type components = { * Format: unix-time * @description 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. */ - billing_cycle_anchor?: number | null; + billing_cycle_anchor?: number | null /** * Format: unix-time * @description The point after which the changes reflected by this update will be discarded and no longer applied. */ - expires_at: number; + expires_at: number /** @description List of subscription items, each with an attached plan, that will be set if the update is applied. */ - subscription_items?: components["schemas"]["subscription_item"][] | null; + subscription_items?: components['schemas']['subscription_item'][] | null /** * Format: unix-time * @description 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?: number | null; + trial_end?: number | null /** @description 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?: boolean | null; - }; + trial_from_plan?: boolean | null + } /** * TaxProductResourceTaxCode * @description [Tax codes](https://stripe.com/docs/tax/tax-codes) classify goods and services for tax purposes. */ tax_code: { /** @description A detailed description of which types of products the tax code represents. */ - description: string; + description: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description A short name for the tax code. */ - name: string; + name: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "tax_code"; - }; + object: 'tax_code' + } /** TaxDeductedAtSource */ tax_deducted_at_source: { /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "tax_deducted_at_source"; + object: 'tax_deducted_at_source' /** * Format: unix-time * @description The end of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period. */ - period_end: number; + period_end: number /** * Format: unix-time * @description The start of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period. */ - period_start: number; + period_start: number /** @description The TAN that was supplied to Stripe when TDS was assessed */ - tax_deduction_account_number: string; - }; + tax_deduction_account_number: string + } /** * tax_id * @description You can add one or multiple tax IDs to a [customer](https://stripe.com/docs/api/customers). @@ -14015,88 +13832,88 @@ export type components = { */ tax_id: { /** @description Two-letter ISO code representing the country of the tax ID. */ - country?: string | null; + country?: string | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description ID of the customer. */ - customer?: (Partial & Partial) | null; + customer?: (Partial & Partial) | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "tax_id"; + object: 'tax_id' /** * @description Type of the tax ID, one of `ae_trn`, `au_abn`, `au_arn`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `es_cif`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `th_vat`, `tw_vat`, `ua_vat`, `us_ein`, or `za_vat`. Note that some legacy tax IDs have type `unknown` * @enum {string} */ type: - | "ae_trn" - | "au_abn" - | "au_arn" - | "br_cnpj" - | "br_cpf" - | "ca_bn" - | "ca_gst_hst" - | "ca_pst_bc" - | "ca_pst_mb" - | "ca_pst_sk" - | "ca_qst" - | "ch_vat" - | "cl_tin" - | "es_cif" - | "eu_vat" - | "gb_vat" - | "ge_vat" - | "hk_br" - | "id_npwp" - | "il_vat" - | "in_gst" - | "is_vat" - | "jp_cn" - | "jp_rn" - | "kr_brn" - | "li_uid" - | "mx_rfc" - | "my_frp" - | "my_itn" - | "my_sst" - | "no_vat" - | "nz_gst" - | "ru_inn" - | "ru_kpp" - | "sa_vat" - | "sg_gst" - | "sg_uen" - | "th_vat" - | "tw_vat" - | "ua_vat" - | "unknown" - | "us_ein" - | "za_vat"; + | 'ae_trn' + | 'au_abn' + | 'au_arn' + | 'br_cnpj' + | 'br_cpf' + | 'ca_bn' + | 'ca_gst_hst' + | 'ca_pst_bc' + | 'ca_pst_mb' + | 'ca_pst_sk' + | 'ca_qst' + | 'ch_vat' + | 'cl_tin' + | 'es_cif' + | 'eu_vat' + | 'gb_vat' + | 'ge_vat' + | 'hk_br' + | 'id_npwp' + | 'il_vat' + | 'in_gst' + | 'is_vat' + | 'jp_cn' + | 'jp_rn' + | 'kr_brn' + | 'li_uid' + | 'mx_rfc' + | 'my_frp' + | 'my_itn' + | 'my_sst' + | 'no_vat' + | 'nz_gst' + | 'ru_inn' + | 'ru_kpp' + | 'sa_vat' + | 'sg_gst' + | 'sg_uen' + | 'th_vat' + | 'tw_vat' + | 'ua_vat' + | 'unknown' + | 'us_ein' + | 'za_vat' /** @description Value of the tax ID. */ - value: string; + value: string /** @description Tax ID verification information. */ - verification?: Partial | null; - }; + verification?: Partial | null + } /** tax_id_verification */ tax_id_verification: { /** * @description Verification status, one of `pending`, `verified`, `unverified`, or `unavailable`. * @enum {string} */ - status: "pending" | "unavailable" | "unverified" | "verified"; + status: 'pending' | 'unavailable' | 'unverified' | 'verified' /** @description Verified address. */ - verified_address?: string | null; + verified_address?: string | null /** @description Verified name. */ - verified_name?: string | null; - }; + verified_name?: string | null + } /** * TaxRate * @description Tax rates can be applied to [invoices](https://stripe.com/docs/billing/invoices/tax-rates), [subscriptions](https://stripe.com/docs/billing/subscriptions/taxes) and [Checkout Sessions](https://stripe.com/docs/payments/checkout/set-up-a-subscription#tax-rates) to collect tax. @@ -14105,118 +13922,118 @@ export type components = { */ tax_rate: { /** @description 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: boolean; + active: boolean /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ - country?: string | null; + country?: string | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. */ - description?: string | null; + description?: string | null /** @description 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: string; + display_name: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description This specifies if the tax rate is inclusive or exclusive. */ - inclusive: boolean; + inclusive: boolean /** @description 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?: string | null; + jurisdiction?: string | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "tax_rate"; + object: 'tax_rate' /** @description This represents the tax rate percent out of 100. */ - percentage: number; + percentage: number /** @description [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States. */ - state?: string | null; + state?: string | null /** * @description The high-level tax type, such as `vat` or `sales_tax`. * @enum {string|null} */ - tax_type?: ("gst" | "hst" | "jct" | "pst" | "qst" | "rst" | "sales_tax" | "vat") | null; - }; + tax_type?: ('gst' | 'hst' | 'jct' | 'pst' | 'qst' | 'rst' | 'sales_tax' | 'vat') | null + } /** * TerminalConnectionToken * @description A Connection Token is used by the Stripe Terminal SDK to connect to a reader. * * Related guide: [Fleet Management](https://stripe.com/docs/terminal/fleet/locations). */ - "terminal.connection_token": { + 'terminal.connection_token': { /** @description 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://stripe.com/docs/terminal/fleet/locations#connection-tokens). */ - location?: string; + location?: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "terminal.connection_token"; + object: 'terminal.connection_token' /** @description Your application should pass this token to the Stripe Terminal SDK. */ - secret: string; - }; + secret: string + } /** * TerminalLocationLocation * @description A Location represents a grouping of readers. * * Related guide: [Fleet Management](https://stripe.com/docs/terminal/fleet/locations). */ - "terminal.location": { - address: components["schemas"]["address"]; + 'terminal.location': { + address: components['schemas']['address'] /** @description The display name of the location. */ - display_name: string; + display_name: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "terminal.location"; - }; + object: 'terminal.location' + } /** * TerminalReaderReader * @description A Reader represents a physical device for accepting payment details. * * Related guide: [Connecting to a Reader](https://stripe.com/docs/terminal/payments/connect-reader). */ - "terminal.reader": { + 'terminal.reader': { /** @description The current software version of the reader. */ - device_sw_version?: string | null; + device_sw_version?: string | null /** * @description Type of reader, one of `bbpos_chipper2x`, `bbpos_wisepos_e`, or `verifone_P400`. * @enum {string} */ - device_type: "bbpos_chipper2x" | "bbpos_wisepos_e" | "verifone_P400"; + device_type: 'bbpos_chipper2x' | 'bbpos_wisepos_e' | 'verifone_P400' /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The local IP address of the reader. */ - ip_address?: string | null; + ip_address?: string | null /** @description Custom label given to the reader for easier identification. */ - label: string; + label: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description The location identifier of the reader. */ - location?: (Partial & Partial) | null; + location?: (Partial & Partial) | null /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "terminal.reader"; + object: 'terminal.reader' /** @description Serial number of the reader. */ - serial_number: string; + serial_number: string /** @description The networking status of the reader. */ - status?: string | null; - }; + status?: string | null + } /** * ThreeDSecure * @description Cardholder authentication via 3D Secure is initiated by creating a `3D Secure` @@ -14225,31 +14042,31 @@ export type components = { */ three_d_secure: { /** @description Amount of the charge that you will create when authentication completes. */ - amount: number; + amount: number /** @description True if the cardholder went through the authentication flow and their bank indicated that authentication succeeded. */ - authenticated: boolean; - card: components["schemas"]["card"]; + authenticated: boolean + card: components['schemas']['card'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "three_d_secure"; + object: 'three_d_secure' /** @description If present, this is the URL that you should send the cardholder to for authentication. If you are going to use Stripe.js to display the authentication page in an iframe, you should use the value "_callback". */ - redirect_url?: string | null; + redirect_url?: string | null /** @description Possible values are `redirect_pending`, `succeeded`, or `failed`. When the cardholder can be authenticated, the object starts with status `redirect_pending`. When liability will be shifted to the cardholder's bank (either because the cardholder was successfully authenticated, or because the bank has not implemented 3D Secure, the object wlil be in status `succeeded`. `failed` indicates that authentication was attempted unsuccessfully. */ - status: string; - }; + status: string + } /** three_d_secure_details */ three_d_secure_details: { /** @@ -14257,39 +14074,29 @@ export type components = { * the issuing bank. * @enum {string|null} */ - authentication_flow?: ("challenge" | "frictionless") | null; + authentication_flow?: ('challenge' | 'frictionless') | null /** * @description Indicates the outcome of 3D Secure authentication. * @enum {string|null} */ - result?: ("attempt_acknowledged" | "authenticated" | "failed" | "not_supported" | "processing_error") | null; + result?: ('attempt_acknowledged' | 'authenticated' | 'failed' | 'not_supported' | 'processing_error') | null /** * @description Additional information about why 3D Secure succeeded or failed based * on the `result`. * @enum {string|null} */ - result_reason?: - | ( - | "abandoned" - | "bypassed" - | "canceled" - | "card_not_enrolled" - | "network_not_supported" - | "protocol_error" - | "rejected" - ) - | null; + result_reason?: ('abandoned' | 'bypassed' | 'canceled' | 'card_not_enrolled' | 'network_not_supported' | 'protocol_error' | 'rejected') | null /** * @description The version of 3D Secure that was used. * @enum {string|null} */ - version?: ("1.0.2" | "2.1.0" | "2.2.0") | null; - }; + version?: ('1.0.2' | '2.1.0' | '2.2.0') | null + } /** three_d_secure_usage */ three_d_secure_usage: { /** @description Whether 3D Secure is supported on this card. */ - supported: boolean; - }; + supported: boolean + } /** * Token * @description Tokenization is the process Stripe uses to collect sensitive card or bank @@ -14316,29 +14123,29 @@ export type components = { * Related guide: [Accept a payment](https://stripe.com/docs/payments/accept-a-payment-charges#web-create-token) */ token: { - bank_account?: components["schemas"]["bank_account"]; - card?: components["schemas"]["card"]; + bank_account?: components['schemas']['bank_account'] + card?: components['schemas']['card'] /** @description IP address of the client that generated the token. */ - client_ip?: string | null; + client_ip?: string | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "token"; + object: 'token' /** @description Type of the token: `account`, `bank_account`, `card`, or `pii`. */ - type: string; + type: string /** @description Whether this token has already been used (tokens can be used only once). */ - used: boolean; - }; + used: boolean + } /** * Topup * @description To top up your Stripe balance, you create a top-up object. You can retrieve @@ -14349,46 +14156,46 @@ export type components = { */ topup: { /** @description Amount transferred. */ - amount: number; + amount: number /** @description 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?: (Partial & Partial) | null; + balance_transaction?: (Partial & Partial) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description 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?: number | null; + expected_availability_date?: number | null /** @description 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?: string | null; + failure_code?: string | null /** @description Message to user further explaining reason for top-up failure if available. */ - failure_message?: string | null; + failure_message?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "topup"; - source: components["schemas"]["source"]; + object: 'topup' + source: components['schemas']['source'] /** @description Extra information about a top-up. This will appear on your source's bank statement. It must contain at least one letter. */ - statement_descriptor?: string | null; + statement_descriptor?: string | null /** * @description The status of the top-up is either `canceled`, `failed`, `pending`, `reversed`, or `succeeded`. * @enum {string} */ - status: "canceled" | "failed" | "pending" | "reversed" | "succeeded"; + status: 'canceled' | 'failed' | 'pending' | 'reversed' | 'succeeded' /** @description A string that identifies this top-up as part of a group. */ - transfer_group?: string | null; - }; + transfer_group?: string | null + } /** * Transfer * @description A `Transfer` object is created when you move funds between Stripe accounts as @@ -14404,72 +14211,72 @@ export type components = { */ transfer: { /** @description Amount in %s to be transferred. */ - amount: number; + amount: number /** @description Amount in %s reversed (can be less than the amount attribute on the transfer if a partial reversal was issued). */ - amount_reversed: number; + amount_reversed: number /** @description Balance transaction that describes the impact of this transfer on your account balance. */ - balance_transaction?: (Partial & Partial) | null; + balance_transaction?: (Partial & Partial) | null /** * Format: unix-time * @description Time that this record of the transfer was first created. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description ID of the Stripe account the transfer was sent to. */ - destination?: (Partial & Partial) | null; + destination?: (Partial & Partial) | null /** @description 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?: Partial & Partial; + destination_payment?: Partial & Partial /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "transfer"; + object: 'transfer' /** * TransferReversalList * @description A list of reversals that have been applied to the transfer. */ reversals: { /** @description Details about each object. */ - data: components["schemas"]["transfer_reversal"][]; + data: components['schemas']['transfer_reversal'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** @description Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false. */ - reversed: boolean; + reversed: boolean /** @description ID of the charge or payment that was used to fund the transfer. If null, the transfer was funded from the available balance. */ - source_transaction?: (Partial & Partial) | null; + source_transaction?: (Partial & Partial) | null /** @description The source balance this transfer came from. One of `card`, `fpx`, or `bank_account`. */ - source_type?: string | null; + source_type?: string | null /** @description A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-options) for details. */ - transfer_group?: string | null; - }; + transfer_group?: string | null + } /** transfer_data */ transfer_data: { /** @description 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?: number; + amount?: number /** * @description The account (if any) the payment will be attributed to for tax * reporting, and where funds from the payment will be transferred to upon * payment success. */ - destination: Partial & Partial; - }; + destination: Partial & Partial + } /** * TransferReversal * @description [Stripe Connect](https://stripe.com/docs/connect) platforms can reverse transfers made to a @@ -14488,63 +14295,63 @@ export type components = { */ transfer_reversal: { /** @description Amount, in %s. */ - amount: number; + amount: number /** @description Balance transaction that describes the impact on your account balance. */ - balance_transaction?: (Partial & Partial) | null; + balance_transaction?: (Partial & Partial) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Linked payment refund for the transfer reversal. */ - destination_payment_refund?: (Partial & Partial) | null; + destination_payment_refund?: (Partial & Partial) | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "transfer_reversal"; + object: 'transfer_reversal' /** @description ID of the refund responsible for the transfer reversal. */ - source_refund?: (Partial & Partial) | null; + source_refund?: (Partial & Partial) | null /** @description ID of the transfer that was reversed. */ - transfer: Partial & Partial; - }; + transfer: Partial & Partial + } /** TransferSchedule */ transfer_schedule: { /** @description The number of days charges for the account will be held before being paid out. */ - delay_days: number; + delay_days: number /** @description How frequently funds will be paid out. One of `manual` (payouts only created via API call), `daily`, `weekly`, or `monthly`. */ - interval: string; + interval: string /** @description 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?: number; + monthly_anchor?: number /** @description The day of the week funds will be paid out, of the style 'monday', 'tuesday', etc. Only shown if `interval` is weekly. */ - weekly_anchor?: string; - }; + weekly_anchor?: string + } /** TransformQuantity */ transform_quantity: { /** @description Divide usage by this number. */ - divide_by: number; + divide_by: number /** * @description After division, either round the result `up` or `down`. * @enum {string} */ - round: "down" | "up"; - }; + round: 'down' | 'up' + } /** TransformUsage */ transform_usage: { /** @description Divide usage by this number. */ - divide_by: number; + divide_by: number /** * @description After division, either round the result `up` or `down`. * @enum {string} */ - round: "down" | "up"; - }; + round: 'down' | 'up' + } /** * UsageRecord * @description Usage records allow you to report customer usage and metrics to Stripe for @@ -14554,51 +14361,51 @@ export type components = { */ usage_record: { /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "usage_record"; + object: 'usage_record' /** @description The usage quantity for the specified date. */ - quantity: number; + quantity: number /** @description The ID of the subscription item this usage record contains data for. */ - subscription_item: string; + subscription_item: string /** * Format: unix-time * @description The timestamp when this usage occurred. */ - timestamp: number; - }; + timestamp: number + } /** UsageRecordSummary */ usage_record_summary: { /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The invoice in which this usage period has been billed for. */ - invoice?: string | null; + invoice?: string | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "usage_record_summary"; - period: components["schemas"]["period"]; + object: 'usage_record_summary' + period: components['schemas']['period'] /** @description The ID of the subscription item this summary is describing. */ - subscription_item: string; + subscription_item: string /** @description The total usage within this usage period. */ - total_usage: number; - }; + total_usage: number + } /** verification_session_redaction */ verification_session_redaction: { /** * @description Indicates whether this object and its related objects have been redacted or not. * @enum {string} */ - status: "processing" | "redacted"; - }; + status: 'processing' | 'redacted' + } /** * NotificationWebhookEndpoint * @description You can configure [webhook endpoints](https://stripe.com/docs/webhooks/) via the API to be @@ -14611,38 +14418,38 @@ export type components = { */ webhook_endpoint: { /** @description The API version events are rendered as for this webhook endpoint. */ - api_version?: string | null; + api_version?: string | null /** @description The ID of the associated Connect application. */ - application?: string | null; + application?: string | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description An optional description of what the webhook is used for. */ - description?: string | null; + description?: string | null /** @description The list of events to enable for this endpoint. `['*']` indicates that all events are enabled, except those that require explicit selection. */ - enabled_events: string[]; + enabled_events: string[] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "webhook_endpoint"; + object: 'webhook_endpoint' /** @description The endpoint's secret, used to generate [webhook signatures](https://stripe.com/docs/webhooks/signatures). Only returned at creation. */ - secret?: string; + secret?: string /** @description The status of the webhook. It can be `enabled` or `disabled`. */ - status: string; + status: string /** @description The URL of the webhook endpoint. */ - url: string; - }; - }; -}; + url: string + } + } +} export type operations = { /**

Initiate 3D Secure authentication.

*/ @@ -14651,94 +14458,94 @@ export type operations = { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["three_d_secure"]; - }; - }; + 'application/json': components['schemas']['three_d_secure'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Amount of the charge that you will create when authentication completes. */ - amount: number; + amount: number /** @description The ID of a card token, or the ID of a card belonging to the given customer. */ - card?: string; + card?: string /** @description 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: string; + currency: string /** @description The customer associated with this 3D secure authentication. */ - customer?: string; + customer?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The URL that the cardholder's browser will be returned to when authentication completes. */ - return_url: string; - }; - }; - }; - }; + return_url: string + } + } + } + } /**

Retrieves a 3D Secure object.

*/ Get3dSecureThreeDSecure: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - three_d_secure: string; - }; - }; + three_d_secure: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["three_d_secure"]; - }; - }; + 'application/json': components['schemas']['three_d_secure'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves the details of an account.

*/ GetAccount: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["account"]; - }; - }; + 'application/json': components['schemas']['account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged. Most parameters can be changed only for Custom accounts. (These are marked Custom Only below.) Parameters marked Custom and Express are not supported for Standard accounts.

* @@ -14749,63 +14556,63 @@ export type operations = { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["account"]; - }; - }; + 'application/json': components['schemas']['account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account. */ - account_token?: string; + account_token?: string /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ bank_account?: Partial<{ - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; + account_holder_type?: 'company' | 'individual' + account_number: string /** @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; - country: string; - currency?: string; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' + country: string + currency?: string /** @enum {string} */ - object?: "bank_account"; - routing_number?: string; + object?: 'bank_account' + routing_number?: string }> & - Partial; + Partial /** * business_profile_specs * @description Business information about the account. */ business_profile?: { - mcc?: string; - name?: string; - product_description?: string; + mcc?: string + name?: string + product_description?: string /** address_specs */ support_address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - support_email?: string; - support_phone?: string; - support_url?: Partial & Partial<"">; - url?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + support_email?: string + support_phone?: string + support_url?: Partial & Partial<''> + url?: string + } /** * @description The business type. * @enum {string} */ - business_type?: "company" | "government_entity" | "individual" | "non_profit"; + business_type?: 'company' | 'government_entity' | 'individual' | 'non_profit' /** * capabilities_param * @description Each key of the dictionary represents a capability, and each capability maps to its settings (e.g. whether it has been requested or not). Each capability will be inactive until you have provided its specific requirements and Stripe has verified them. An account may have some of its requested capabilities be active and some be inactive. @@ -14813,101 +14620,101 @@ export type operations = { capabilities?: { /** capability_param */ acss_debit_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ afterpay_clearpay_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ au_becs_debit_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ bacs_debit_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ bancontact_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ boleto_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ card_issuing?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ card_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ cartes_bancaires_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ eps_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ fpx_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ giropay_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ grabpay_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ ideal_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ jcb_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ klarna_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ legacy_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ oxxo_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ p24_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ sepa_debit_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ sofort_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ tax_reporting_us_1099_k?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ tax_reporting_us_1099_misc?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ transfers?: { - requested?: boolean; - }; - }; + requested?: boolean + } + } /** * company_specs * @description Information about the company or business. This field is available for any `business_type`. @@ -14915,85 +14722,85 @@ export type operations = { company?: { /** address_specs */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** japan_address_kana_specs */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** japan_address_kanji_specs */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; - directors_provided?: boolean; - executives_provided?: boolean; - name?: string; - name_kana?: string; - name_kanji?: string; - owners_provided?: boolean; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } + directors_provided?: boolean + executives_provided?: boolean + name?: string + name_kana?: string + name_kanji?: string + owners_provided?: boolean /** company_ownership_declaration */ ownership_declaration?: { /** Format: unix-time */ - date?: number; - ip?: string; - user_agent?: string; - }; - phone?: string; - registration_number?: string; + date?: number + ip?: string + user_agent?: string + } + phone?: string + registration_number?: string /** @enum {string} */ structure?: - | "" - | "free_zone_establishment" - | "free_zone_llc" - | "government_instrumentality" - | "governmental_unit" - | "incorporated_non_profit" - | "limited_liability_partnership" - | "llc" - | "multi_member_llc" - | "private_company" - | "private_corporation" - | "private_partnership" - | "public_company" - | "public_corporation" - | "public_partnership" - | "single_member_llc" - | "sole_establishment" - | "sole_proprietorship" - | "tax_exempt_government_instrumentality" - | "unincorporated_association" - | "unincorporated_non_profit"; - tax_id?: string; - tax_id_registrar?: string; - vat_id?: string; + | '' + | 'free_zone_establishment' + | 'free_zone_llc' + | 'government_instrumentality' + | 'governmental_unit' + | 'incorporated_non_profit' + | 'limited_liability_partnership' + | 'llc' + | 'multi_member_llc' + | 'private_company' + | 'private_corporation' + | 'private_partnership' + | 'public_company' + | 'public_corporation' + | 'public_partnership' + | 'single_member_llc' + | 'sole_establishment' + | 'sole_proprietorship' + | 'tax_exempt_government_instrumentality' + | 'unincorporated_association' + | 'unincorporated_non_profit' + tax_id?: string + tax_id_registrar?: string + vat_id?: string /** verification_specs */ verification?: { /** verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; + back?: string + front?: string + } + } + } /** @description 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?: string; + default_currency?: string /** * documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -15001,39 +14808,39 @@ export type operations = { documents?: { /** documents_param */ bank_account_ownership_verification?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ company_license?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ company_memorandum_of_association?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ company_ministerial_decree?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ company_registration_verification?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ company_tax_id_verification?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ proof_of_registration?: { - files?: string[]; - }; - }; + files?: string[] + } + } /** @description The email address of the account holder. This is only to make the account easier to identify to you. Stripe only emails Custom accounts with your consent. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A card or bank account to attach to the account for receiving [payouts](https://stripe.com/docs/connect/bank-debit-card-payouts) (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://stripe.com/docs/api#account_create_bank_account) creation.

By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the bank account or card creation API. */ - external_account?: string; + external_account?: string /** * individual_specs * @description Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. @@ -15041,71 +14848,71 @@ export type operations = { individual?: { /** address_specs */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** japan_address_kana_specs */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** japan_address_kanji_specs */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } dob?: Partial<{ - day: number; - month: number; - year: number; + day: number + month: number + year: number }> & - Partial<"">; - email?: string; - first_name?: string; - first_name_kana?: string; - first_name_kanji?: string; - full_name_aliases?: Partial & Partial<"">; - gender?: string; - id_number?: string; - last_name?: string; - last_name_kana?: string; - last_name_kanji?: string; - maiden_name?: string; - metadata?: Partial<{ [key: string]: string }> & Partial<"">; - phone?: string; + Partial<''> + email?: string + first_name?: string + first_name_kana?: string + first_name_kanji?: string + full_name_aliases?: Partial & Partial<''> + gender?: string + id_number?: string + last_name?: string + last_name_kana?: string + last_name_kanji?: string + maiden_name?: string + metadata?: Partial<{ [key: string]: string }> & Partial<''> + phone?: string /** @enum {string} */ - political_exposure?: "existing" | "none"; - ssn_last_4?: string; + political_exposure?: 'existing' | 'none' + ssn_last_4?: string /** person_verification_specs */ verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; + back?: string + front?: string + } + } + } /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** * settings_specs_update * @description Options for customizing how the account functions within Stripe. @@ -15113,66 +14920,66 @@ export type operations = { settings?: { /** branding_settings_specs */ branding?: { - icon?: string; - logo?: string; - primary_color?: string; - secondary_color?: string; - }; + icon?: string + logo?: string + primary_color?: string + secondary_color?: string + } /** card_issuing_settings_specs */ card_issuing?: { /** settings_terms_of_service_specs */ tos_acceptance?: { /** Format: unix-time */ - date?: number; - ip?: string; - user_agent?: string; - }; - }; + date?: number + ip?: string + user_agent?: string + } + } /** card_payments_settings_specs */ card_payments?: { /** decline_charge_on_specs */ decline_on?: { - avs_failure?: boolean; - cvc_failure?: boolean; - }; - statement_descriptor_prefix?: string; - }; + avs_failure?: boolean + cvc_failure?: boolean + } + statement_descriptor_prefix?: string + } /** payments_settings_specs */ payments?: { - statement_descriptor?: string; - statement_descriptor_kana?: string; - statement_descriptor_kanji?: string; - }; + statement_descriptor?: string + statement_descriptor_kana?: string + statement_descriptor_kanji?: string + } /** payout_settings_specs */ payouts?: { - debit_negative_balances?: boolean; + debit_negative_balances?: boolean /** transfer_schedule_specs */ schedule?: { - delay_days?: Partial<"minimum"> & Partial; + delay_days?: Partial<'minimum'> & Partial /** @enum {string} */ - interval?: "daily" | "manual" | "monthly" | "weekly"; - monthly_anchor?: number; + interval?: 'daily' | 'manual' | 'monthly' | 'weekly' + monthly_anchor?: number /** @enum {string} */ - weekly_anchor?: "friday" | "monday" | "saturday" | "sunday" | "thursday" | "tuesday" | "wednesday"; - }; - statement_descriptor?: string; - }; - }; + weekly_anchor?: 'friday' | 'monday' | 'saturday' | 'sunday' | 'thursday' | 'tuesday' | 'wednesday' + } + statement_descriptor?: string + } + } /** * tos_acceptance_specs * @description Details on the account's acceptance of the [Stripe Services Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance). */ tos_acceptance?: { /** Format: unix-time */ - date?: number; - ip?: string; - service_agreement?: string; - user_agent?: string; - }; - }; - }; - }; - }; + date?: number + ip?: string + service_agreement?: string + user_agent?: string + } + } + } + } + } /** *

With Connect, you can delete accounts you manage.

* @@ -15185,101 +14992,101 @@ export type operations = { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_account"]; - }; - }; + 'application/json': components['schemas']['deleted_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { - account?: string; - }; - }; - }; - }; + 'application/x-www-form-urlencoded': { + account?: string + } + } + } + } /**

Create an external account for a given account.

*/ PostAccountBankAccounts: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ bank_account?: Partial<{ - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; + account_holder_type?: 'company' | 'individual' + account_number: string /** @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; - country: string; - currency?: string; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' + country: string + currency?: string /** @enum {string} */ - object?: "bank_account"; - routing_number?: string; + object?: 'bank_account' + routing_number?: string }> & - Partial; + Partial /** @description When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency. */ - default_for_currency?: boolean; + default_for_currency?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - external_account?: string; + external_account?: string /** @description 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?: { [key: string]: string }; - }; - }; - }; - }; + metadata?: { [key: string]: string } + } + } + } + } /**

Retrieve a specified external account for a given account.

*/ GetAccountBankAccountsId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

* @@ -15288,318 +15095,318 @@ export type operations = { PostAccountBankAccountsId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The name of the person or business that owns the bank account. */ - account_holder_name?: string; + account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - account_holder_type?: "" | "company" | "individual"; + account_holder_type?: '' | 'company' | 'individual' /** * @description The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`. * @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' /** @description City/District/Suburb/Town/Village. */ - address_city?: string; + address_city?: string /** @description Billing address country, if provided when creating card. */ - address_country?: string; + address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - address_line1?: string; + address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - address_line2?: string; + address_line2?: string /** @description State/County/Province/Region. */ - address_state?: string; + address_state?: string /** @description ZIP or postal code. */ - address_zip?: string; + address_zip?: string /** @description When set to true, this becomes the default external account for its currency. */ - default_for_currency?: boolean; + default_for_currency?: boolean /** @description Two digit number representing the card’s expiration month. */ - exp_month?: string; + exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - exp_year?: string; + exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Cardholder name. */ - name?: string; - }; - }; - }; - }; + name?: string + } + } + } + } /**

Delete a specified external account for a given account.

*/ DeleteAccountBankAccountsId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_external_account"]; - }; - }; + 'application/json': components['schemas']['deleted_external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ GetAccountCapabilities: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["capability"][]; + 'application/json': { + data: components['schemas']['capability'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves information about the specified Account Capability.

*/ GetAccountCapabilitiesCapability: { parameters: { path: { - capability: string; - }; + capability: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["capability"]; - }; - }; + 'application/json': components['schemas']['capability'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates an existing Account Capability.

*/ PostAccountCapabilitiesCapability: { parameters: { path: { - capability: string; - }; - }; + capability: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["capability"]; - }; - }; + 'application/json': components['schemas']['capability'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. */ - requested?: boolean; - }; - }; - }; - }; + requested?: boolean + } + } + } + } /**

List external accounts for an account.

*/ GetAccountExternalAccounts: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards. */ - data: (Partial & Partial)[]; + data: (Partial & Partial)[] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Create an external account for a given account.

*/ PostAccountExternalAccounts: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ bank_account?: Partial<{ - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; + account_holder_type?: 'company' | 'individual' + account_number: string /** @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; - country: string; - currency?: string; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' + country: string + currency?: string /** @enum {string} */ - object?: "bank_account"; - routing_number?: string; + object?: 'bank_account' + routing_number?: string }> & - Partial; + Partial /** @description When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency. */ - default_for_currency?: boolean; + default_for_currency?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - external_account?: string; + external_account?: string /** @description 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?: { [key: string]: string }; - }; - }; - }; - }; + metadata?: { [key: string]: string } + } + } + } + } /**

Retrieve a specified external account for a given account.

*/ GetAccountExternalAccountsId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

* @@ -15608,93 +15415,93 @@ export type operations = { PostAccountExternalAccountsId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The name of the person or business that owns the bank account. */ - account_holder_name?: string; + account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - account_holder_type?: "" | "company" | "individual"; + account_holder_type?: '' | 'company' | 'individual' /** * @description The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`. * @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' /** @description City/District/Suburb/Town/Village. */ - address_city?: string; + address_city?: string /** @description Billing address country, if provided when creating card. */ - address_country?: string; + address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - address_line1?: string; + address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - address_line2?: string; + address_line2?: string /** @description State/County/Province/Region. */ - address_state?: string; + address_state?: string /** @description ZIP or postal code. */ - address_zip?: string; + address_zip?: string /** @description When set to true, this becomes the default external account for its currency. */ - default_for_currency?: boolean; + default_for_currency?: boolean /** @description Two digit number representing the card’s expiration month. */ - exp_month?: string; + exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - exp_year?: string; + exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Cardholder name. */ - name?: string; - }; - }; - }; - }; + name?: string + } + } + } + } /**

Delete a specified external account for a given account.

*/ DeleteAccountExternalAccountsId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_external_account"]; - }; - }; + 'application/json': components['schemas']['deleted_external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Creates a single-use login link for an Express account to access their Stripe dashboard.

* @@ -15705,145 +15512,145 @@ export type operations = { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["login_link"]; - }; - }; + 'application/json': components['schemas']['login_link'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { - account: string; + 'application/x-www-form-urlencoded': { + account: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Where to redirect the user after they log out of their dashboard. */ - redirect_url?: string; - }; - }; - }; - }; + redirect_url?: string + } + } + } + } /**

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.

*/ GetAccountPeople: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Filters on the list of people returned based on the person's relationship to the account's company. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - representative?: boolean; - }; + director?: boolean + executive?: boolean + owner?: boolean + representative?: boolean + } /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["person"][]; + 'application/json': { + data: components['schemas']['person'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new person.

*/ PostAccountPeople: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { - account?: string; + 'application/x-www-form-urlencoded': { + account?: string /** * address_specs * @description The person's address. */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** @description The person's date of birth. */ dob?: Partial<{ - day: number; - month: number; - year: number; + day: number + month: number + year: number }> & - Partial<"">; + Partial<''> /** * person_documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -15851,65 +15658,65 @@ export type operations = { documents?: { /** documents_param */ company_authorization?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ passport?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ visa?: { - files?: string[]; - }; - }; + files?: string[] + } + } /** @description The person's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The person's first name. */ - first_name?: string; + first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - first_name_kana?: string; + first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - first_name_kanji?: string; + first_name_kanji?: string /** @description A list of alternate names or aliases that the person is known by. */ - full_name_aliases?: Partial & Partial<"">; + full_name_aliases?: Partial & Partial<''> /** @description The person's gender (International regulations require either "male" or "female"). */ - gender?: string; + gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ - id_number?: string; + id_number?: string /** @description The person's last name. */ - last_name?: string; + last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - last_name_kana?: string; + last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - last_name_kanji?: string; + last_name_kanji?: string /** @description The person's maiden name. */ - maiden_name?: string; + maiden_name?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ - nationality?: string; + nationality?: string /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - person_token?: string; + person_token?: string /** @description The person's phone number. */ - phone?: string; + phone?: string /** @description 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?: string; + political_exposure?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - percent_ownership?: Partial & Partial<"">; - representative?: boolean; - title?: string; - }; + director?: boolean + executive?: boolean + owner?: boolean + percent_ownership?: Partial & Partial<''> + representative?: boolean + title?: string + } /** @description The last four digits of the person's Social Security number (U.S. only). */ - ssn_last_4?: string; + ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -15917,120 +15724,120 @@ export type operations = { verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; - }; - }; - }; + back?: string + front?: string + } + } + } + } + } + } /**

Retrieves an existing person.

*/ GetAccountPeoplePerson: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - person: string; - }; - }; + person: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates an existing person.

*/ PostAccountPeoplePerson: { parameters: { path: { - person: string; - }; - }; + person: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { - account?: string; + 'application/x-www-form-urlencoded': { + account?: string /** * address_specs * @description The person's address. */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** @description The person's date of birth. */ dob?: Partial<{ - day: number; - month: number; - year: number; + day: number + month: number + year: number }> & - Partial<"">; + Partial<''> /** * person_documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -16038,65 +15845,65 @@ export type operations = { documents?: { /** documents_param */ company_authorization?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ passport?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ visa?: { - files?: string[]; - }; - }; + files?: string[] + } + } /** @description The person's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The person's first name. */ - first_name?: string; + first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - first_name_kana?: string; + first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - first_name_kanji?: string; + first_name_kanji?: string /** @description A list of alternate names or aliases that the person is known by. */ - full_name_aliases?: Partial & Partial<"">; + full_name_aliases?: Partial & Partial<''> /** @description The person's gender (International regulations require either "male" or "female"). */ - gender?: string; + gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ - id_number?: string; + id_number?: string /** @description The person's last name. */ - last_name?: string; + last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - last_name_kana?: string; + last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - last_name_kanji?: string; + last_name_kanji?: string /** @description The person's maiden name. */ - maiden_name?: string; + maiden_name?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ - nationality?: string; + nationality?: string /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - person_token?: string; + person_token?: string /** @description The person's phone number. */ - phone?: string; + phone?: string /** @description 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?: string; + political_exposure?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - percent_ownership?: Partial & Partial<"">; - representative?: boolean; - title?: string; - }; + director?: boolean + executive?: boolean + owner?: boolean + percent_ownership?: Partial & Partial<''> + representative?: boolean + title?: string + } /** @description The last four digits of the person's Social Security number (U.S. only). */ - ssn_last_4?: string; + ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -16104,163 +15911,163 @@ export type operations = { verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; - }; - }; - }; + back?: string + front?: string + } + } + } + } + } + } /**

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.

*/ DeleteAccountPeoplePerson: { parameters: { path: { - person: string; - }; - }; + person: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_person"]; - }; - }; + 'application/json': components['schemas']['deleted_person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ GetAccountPersons: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Filters on the list of people returned based on the person's relationship to the account's company. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - representative?: boolean; - }; + director?: boolean + executive?: boolean + owner?: boolean + representative?: boolean + } /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["person"][]; + 'application/json': { + data: components['schemas']['person'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new person.

*/ PostAccountPersons: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { - account?: string; + 'application/x-www-form-urlencoded': { + account?: string /** * address_specs * @description The person's address. */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** @description The person's date of birth. */ dob?: Partial<{ - day: number; - month: number; - year: number; + day: number + month: number + year: number }> & - Partial<"">; + Partial<''> /** * person_documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -16268,65 +16075,65 @@ export type operations = { documents?: { /** documents_param */ company_authorization?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ passport?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ visa?: { - files?: string[]; - }; - }; + files?: string[] + } + } /** @description The person's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The person's first name. */ - first_name?: string; + first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - first_name_kana?: string; + first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - first_name_kanji?: string; + first_name_kanji?: string /** @description A list of alternate names or aliases that the person is known by. */ - full_name_aliases?: Partial & Partial<"">; + full_name_aliases?: Partial & Partial<''> /** @description The person's gender (International regulations require either "male" or "female"). */ - gender?: string; + gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ - id_number?: string; + id_number?: string /** @description The person's last name. */ - last_name?: string; + last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - last_name_kana?: string; + last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - last_name_kanji?: string; + last_name_kanji?: string /** @description The person's maiden name. */ - maiden_name?: string; + maiden_name?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ - nationality?: string; + nationality?: string /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - person_token?: string; + person_token?: string /** @description The person's phone number. */ - phone?: string; + phone?: string /** @description 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?: string; + political_exposure?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - percent_ownership?: Partial & Partial<"">; - representative?: boolean; - title?: string; - }; + director?: boolean + executive?: boolean + owner?: boolean + percent_ownership?: Partial & Partial<''> + representative?: boolean + title?: string + } /** @description The last four digits of the person's Social Security number (U.S. only). */ - ssn_last_4?: string; + ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -16334,120 +16141,120 @@ export type operations = { verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; - }; - }; - }; + back?: string + front?: string + } + } + } + } + } + } /**

Retrieves an existing person.

*/ GetAccountPersonsPerson: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - person: string; - }; - }; + person: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates an existing person.

*/ PostAccountPersonsPerson: { parameters: { path: { - person: string; - }; - }; + person: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { - account?: string; + 'application/x-www-form-urlencoded': { + account?: string /** * address_specs * @description The person's address. */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** @description The person's date of birth. */ dob?: Partial<{ - day: number; - month: number; - year: number; + day: number + month: number + year: number }> & - Partial<"">; + Partial<''> /** * person_documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -16455,65 +16262,65 @@ export type operations = { documents?: { /** documents_param */ company_authorization?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ passport?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ visa?: { - files?: string[]; - }; - }; + files?: string[] + } + } /** @description The person's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The person's first name. */ - first_name?: string; + first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - first_name_kana?: string; + first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - first_name_kanji?: string; + first_name_kanji?: string /** @description A list of alternate names or aliases that the person is known by. */ - full_name_aliases?: Partial & Partial<"">; + full_name_aliases?: Partial & Partial<''> /** @description The person's gender (International regulations require either "male" or "female"). */ - gender?: string; + gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ - id_number?: string; + id_number?: string /** @description The person's last name. */ - last_name?: string; + last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - last_name_kana?: string; + last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - last_name_kanji?: string; + last_name_kanji?: string /** @description The person's maiden name. */ - maiden_name?: string; + maiden_name?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ - nationality?: string; + nationality?: string /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - person_token?: string; + person_token?: string /** @description The person's phone number. */ - phone?: string; + phone?: string /** @description 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?: string; + political_exposure?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - percent_ownership?: Partial & Partial<"">; - representative?: boolean; - title?: string; - }; + director?: boolean + executive?: boolean + owner?: boolean + percent_ownership?: Partial & Partial<''> + representative?: boolean + title?: string + } /** @description The last four digits of the person's Social Security number (U.S. only). */ - ssn_last_4?: string; + ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -16521,139 +16328,139 @@ export type operations = { verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; - }; - }; - }; + back?: string + front?: string + } + } + } + } + } + } /**

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.

*/ DeleteAccountPersonsPerson: { parameters: { path: { - person: string; - }; - }; + person: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_person"]; - }; - }; + 'application/json': components['schemas']['deleted_person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostAccountLinks: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["account_link"]; - }; - }; + 'application/json': components['schemas']['account_link'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The identifier of the account to create an account link for. */ - account: string; + account: string /** * @description Which information the platform needs to collect from the user. One of `currently_due` or `eventually_due`. Default is `currently_due`. * @enum {string} */ - collect?: "currently_due" | "eventually_due"; + collect?: 'currently_due' | 'eventually_due' /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The URL the user will be redirected to if the account link is expired, has been previously-visited, or is otherwise invalid. The URL you specify should attempt to generate a new account link with the same parameters used to create the original account link, then redirect the user to the new account link's URL so they can continue with Connect Onboarding. If a new account link cannot be generated or the redirect fails you should display a useful error to the user. */ - refresh_url?: string; + refresh_url?: string /** @description The URL that the user will be redirected to upon leaving or completing the linked flow. */ - return_url?: string; + return_url?: string /** * @description The type of account link the user is requesting. Possible values are `account_onboarding` or `account_update`. * @enum {string} */ - type: "account_onboarding" | "account_update"; - }; - }; - }; - }; + type: 'account_onboarding' | 'account_update' + } + } + } + } /**

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

*/ GetAccounts: { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["account"][]; + 'application/json': { + data: components['schemas']['account'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

With Connect, you can create Stripe accounts for your users. * To do this, you’ll first need to register your platform.

@@ -16663,63 +16470,63 @@ export type operations = { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["account"]; - }; - }; + 'application/json': components['schemas']['account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account. */ - account_token?: string; + account_token?: string /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ bank_account?: Partial<{ - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; + account_holder_type?: 'company' | 'individual' + account_number: string /** @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; - country: string; - currency?: string; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' + country: string + currency?: string /** @enum {string} */ - object?: "bank_account"; - routing_number?: string; + object?: 'bank_account' + routing_number?: string }> & - Partial; + Partial /** * business_profile_specs * @description Business information about the account. */ business_profile?: { - mcc?: string; - name?: string; - product_description?: string; + mcc?: string + name?: string + product_description?: string /** address_specs */ support_address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - support_email?: string; - support_phone?: string; - support_url?: Partial & Partial<"">; - url?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + support_email?: string + support_phone?: string + support_url?: Partial & Partial<''> + url?: string + } /** * @description The business type. * @enum {string} */ - business_type?: "company" | "government_entity" | "individual" | "non_profit"; + business_type?: 'company' | 'government_entity' | 'individual' | 'non_profit' /** * capabilities_param * @description Each key of the dictionary represents a capability, and each capability maps to its settings (e.g. whether it has been requested or not). Each capability will be inactive until you have provided its specific requirements and Stripe has verified them. An account may have some of its requested capabilities be active and some be inactive. @@ -16727,101 +16534,101 @@ export type operations = { capabilities?: { /** capability_param */ acss_debit_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ afterpay_clearpay_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ au_becs_debit_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ bacs_debit_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ bancontact_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ boleto_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ card_issuing?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ card_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ cartes_bancaires_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ eps_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ fpx_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ giropay_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ grabpay_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ ideal_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ jcb_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ klarna_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ legacy_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ oxxo_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ p24_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ sepa_debit_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ sofort_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ tax_reporting_us_1099_k?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ tax_reporting_us_1099_misc?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ transfers?: { - requested?: boolean; - }; - }; + requested?: boolean + } + } /** * company_specs * @description Information about the company or business. This field is available for any `business_type`. @@ -16829,87 +16636,87 @@ export type operations = { company?: { /** address_specs */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** japan_address_kana_specs */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** japan_address_kanji_specs */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; - directors_provided?: boolean; - executives_provided?: boolean; - name?: string; - name_kana?: string; - name_kanji?: string; - owners_provided?: boolean; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } + directors_provided?: boolean + executives_provided?: boolean + name?: string + name_kana?: string + name_kanji?: string + owners_provided?: boolean /** company_ownership_declaration */ ownership_declaration?: { /** Format: unix-time */ - date?: number; - ip?: string; - user_agent?: string; - }; - phone?: string; - registration_number?: string; + date?: number + ip?: string + user_agent?: string + } + phone?: string + registration_number?: string /** @enum {string} */ structure?: - | "" - | "free_zone_establishment" - | "free_zone_llc" - | "government_instrumentality" - | "governmental_unit" - | "incorporated_non_profit" - | "limited_liability_partnership" - | "llc" - | "multi_member_llc" - | "private_company" - | "private_corporation" - | "private_partnership" - | "public_company" - | "public_corporation" - | "public_partnership" - | "single_member_llc" - | "sole_establishment" - | "sole_proprietorship" - | "tax_exempt_government_instrumentality" - | "unincorporated_association" - | "unincorporated_non_profit"; - tax_id?: string; - tax_id_registrar?: string; - vat_id?: string; + | '' + | 'free_zone_establishment' + | 'free_zone_llc' + | 'government_instrumentality' + | 'governmental_unit' + | 'incorporated_non_profit' + | 'limited_liability_partnership' + | 'llc' + | 'multi_member_llc' + | 'private_company' + | 'private_corporation' + | 'private_partnership' + | 'public_company' + | 'public_corporation' + | 'public_partnership' + | 'single_member_llc' + | 'sole_establishment' + | 'sole_proprietorship' + | 'tax_exempt_government_instrumentality' + | 'unincorporated_association' + | 'unincorporated_non_profit' + tax_id?: string + tax_id_registrar?: string + vat_id?: string /** verification_specs */ verification?: { /** verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; + back?: string + front?: string + } + } + } /** @description The country in which the account holder resides, or in which the business is legally established. This should be an ISO 3166-1 alpha-2 country code. For example, if you are in the United States and the business for which you're creating an account is legally represented in Canada, you would use `CA` as the country for the account being created. */ - country?: string; + country?: string /** @description 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?: string; + default_currency?: string /** * documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -16917,39 +16724,39 @@ export type operations = { documents?: { /** documents_param */ bank_account_ownership_verification?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ company_license?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ company_memorandum_of_association?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ company_ministerial_decree?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ company_registration_verification?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ company_tax_id_verification?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ proof_of_registration?: { - files?: string[]; - }; - }; + files?: string[] + } + } /** @description The email address of the account holder. This is only to make the account easier to identify to you. Stripe only emails Custom accounts with your consent. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A card or bank account to attach to the account for receiving [payouts](https://stripe.com/docs/connect/bank-debit-card-payouts) (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://stripe.com/docs/api#account_create_bank_account) creation.

By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the bank account or card creation API. */ - external_account?: string; + external_account?: string /** * individual_specs * @description Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. @@ -16957,71 +16764,71 @@ export type operations = { individual?: { /** address_specs */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** japan_address_kana_specs */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** japan_address_kanji_specs */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } dob?: Partial<{ - day: number; - month: number; - year: number; + day: number + month: number + year: number }> & - Partial<"">; - email?: string; - first_name?: string; - first_name_kana?: string; - first_name_kanji?: string; - full_name_aliases?: Partial & Partial<"">; - gender?: string; - id_number?: string; - last_name?: string; - last_name_kana?: string; - last_name_kanji?: string; - maiden_name?: string; - metadata?: Partial<{ [key: string]: string }> & Partial<"">; - phone?: string; + Partial<''> + email?: string + first_name?: string + first_name_kana?: string + first_name_kanji?: string + full_name_aliases?: Partial & Partial<''> + gender?: string + id_number?: string + last_name?: string + last_name_kana?: string + last_name_kanji?: string + maiden_name?: string + metadata?: Partial<{ [key: string]: string }> & Partial<''> + phone?: string /** @enum {string} */ - political_exposure?: "existing" | "none"; - ssn_last_4?: string; + political_exposure?: 'existing' | 'none' + ssn_last_4?: string /** person_verification_specs */ verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; + back?: string + front?: string + } + } + } /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** * settings_specs * @description Options for customizing how the account functions within Stripe. @@ -17029,102 +16836,102 @@ export type operations = { settings?: { /** branding_settings_specs */ branding?: { - icon?: string; - logo?: string; - primary_color?: string; - secondary_color?: string; - }; + icon?: string + logo?: string + primary_color?: string + secondary_color?: string + } /** card_issuing_settings_specs */ card_issuing?: { /** settings_terms_of_service_specs */ tos_acceptance?: { /** Format: unix-time */ - date?: number; - ip?: string; - user_agent?: string; - }; - }; + date?: number + ip?: string + user_agent?: string + } + } /** card_payments_settings_specs */ card_payments?: { /** decline_charge_on_specs */ decline_on?: { - avs_failure?: boolean; - cvc_failure?: boolean; - }; - statement_descriptor_prefix?: string; - }; + avs_failure?: boolean + cvc_failure?: boolean + } + statement_descriptor_prefix?: string + } /** payments_settings_specs */ payments?: { - statement_descriptor?: string; - statement_descriptor_kana?: string; - statement_descriptor_kanji?: string; - }; + statement_descriptor?: string + statement_descriptor_kana?: string + statement_descriptor_kanji?: string + } /** payout_settings_specs */ payouts?: { - debit_negative_balances?: boolean; + debit_negative_balances?: boolean /** transfer_schedule_specs */ schedule?: { - delay_days?: Partial<"minimum"> & Partial; + delay_days?: Partial<'minimum'> & Partial /** @enum {string} */ - interval?: "daily" | "manual" | "monthly" | "weekly"; - monthly_anchor?: number; + interval?: 'daily' | 'manual' | 'monthly' | 'weekly' + monthly_anchor?: number /** @enum {string} */ - weekly_anchor?: "friday" | "monday" | "saturday" | "sunday" | "thursday" | "tuesday" | "wednesday"; - }; - statement_descriptor?: string; - }; - }; + weekly_anchor?: 'friday' | 'monday' | 'saturday' | 'sunday' | 'thursday' | 'tuesday' | 'wednesday' + } + statement_descriptor?: string + } + } /** * tos_acceptance_specs * @description Details on the account's acceptance of the [Stripe Services Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance). */ tos_acceptance?: { /** Format: unix-time */ - date?: number; - ip?: string; - service_agreement?: string; - user_agent?: string; - }; + date?: number + ip?: string + service_agreement?: string + user_agent?: string + } /** * @description The type of Stripe account to create. May be one of `custom`, `express` or `standard`. * @enum {string} */ - type?: "custom" | "express" | "standard"; - }; - }; - }; - }; + type?: 'custom' | 'express' | 'standard' + } + } + } + } /**

Retrieves the details of an account.

*/ GetAccountsAccount: { parameters: { path: { - account: string; - }; + account: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["account"]; - }; - }; + 'application/json': components['schemas']['account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged. Most parameters can be changed only for Custom accounts. (These are marked Custom Only below.) Parameters marked Custom and Express are not supported for Standard accounts.

* @@ -17133,70 +16940,70 @@ export type operations = { PostAccountsAccount: { parameters: { path: { - account: string; - }; - }; + account: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["account"]; - }; - }; + 'application/json': components['schemas']['account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account. */ - account_token?: string; + account_token?: string /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ bank_account?: Partial<{ - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; + account_holder_type?: 'company' | 'individual' + account_number: string /** @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; - country: string; - currency?: string; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' + country: string + currency?: string /** @enum {string} */ - object?: "bank_account"; - routing_number?: string; + object?: 'bank_account' + routing_number?: string }> & - Partial; + Partial /** * business_profile_specs * @description Business information about the account. */ business_profile?: { - mcc?: string; - name?: string; - product_description?: string; + mcc?: string + name?: string + product_description?: string /** address_specs */ support_address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - support_email?: string; - support_phone?: string; - support_url?: Partial & Partial<"">; - url?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + support_email?: string + support_phone?: string + support_url?: Partial & Partial<''> + url?: string + } /** * @description The business type. * @enum {string} */ - business_type?: "company" | "government_entity" | "individual" | "non_profit"; + business_type?: 'company' | 'government_entity' | 'individual' | 'non_profit' /** * capabilities_param * @description Each key of the dictionary represents a capability, and each capability maps to its settings (e.g. whether it has been requested or not). Each capability will be inactive until you have provided its specific requirements and Stripe has verified them. An account may have some of its requested capabilities be active and some be inactive. @@ -17204,101 +17011,101 @@ export type operations = { capabilities?: { /** capability_param */ acss_debit_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ afterpay_clearpay_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ au_becs_debit_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ bacs_debit_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ bancontact_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ boleto_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ card_issuing?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ card_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ cartes_bancaires_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ eps_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ fpx_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ giropay_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ grabpay_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ ideal_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ jcb_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ klarna_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ legacy_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ oxxo_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ p24_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ sepa_debit_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ sofort_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ tax_reporting_us_1099_k?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ tax_reporting_us_1099_misc?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ transfers?: { - requested?: boolean; - }; - }; + requested?: boolean + } + } /** * company_specs * @description Information about the company or business. This field is available for any `business_type`. @@ -17306,85 +17113,85 @@ export type operations = { company?: { /** address_specs */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** japan_address_kana_specs */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** japan_address_kanji_specs */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; - directors_provided?: boolean; - executives_provided?: boolean; - name?: string; - name_kana?: string; - name_kanji?: string; - owners_provided?: boolean; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } + directors_provided?: boolean + executives_provided?: boolean + name?: string + name_kana?: string + name_kanji?: string + owners_provided?: boolean /** company_ownership_declaration */ ownership_declaration?: { /** Format: unix-time */ - date?: number; - ip?: string; - user_agent?: string; - }; - phone?: string; - registration_number?: string; + date?: number + ip?: string + user_agent?: string + } + phone?: string + registration_number?: string /** @enum {string} */ structure?: - | "" - | "free_zone_establishment" - | "free_zone_llc" - | "government_instrumentality" - | "governmental_unit" - | "incorporated_non_profit" - | "limited_liability_partnership" - | "llc" - | "multi_member_llc" - | "private_company" - | "private_corporation" - | "private_partnership" - | "public_company" - | "public_corporation" - | "public_partnership" - | "single_member_llc" - | "sole_establishment" - | "sole_proprietorship" - | "tax_exempt_government_instrumentality" - | "unincorporated_association" - | "unincorporated_non_profit"; - tax_id?: string; - tax_id_registrar?: string; - vat_id?: string; + | '' + | 'free_zone_establishment' + | 'free_zone_llc' + | 'government_instrumentality' + | 'governmental_unit' + | 'incorporated_non_profit' + | 'limited_liability_partnership' + | 'llc' + | 'multi_member_llc' + | 'private_company' + | 'private_corporation' + | 'private_partnership' + | 'public_company' + | 'public_corporation' + | 'public_partnership' + | 'single_member_llc' + | 'sole_establishment' + | 'sole_proprietorship' + | 'tax_exempt_government_instrumentality' + | 'unincorporated_association' + | 'unincorporated_non_profit' + tax_id?: string + tax_id_registrar?: string + vat_id?: string /** verification_specs */ verification?: { /** verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; + back?: string + front?: string + } + } + } /** @description 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?: string; + default_currency?: string /** * documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -17392,39 +17199,39 @@ export type operations = { documents?: { /** documents_param */ bank_account_ownership_verification?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ company_license?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ company_memorandum_of_association?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ company_ministerial_decree?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ company_registration_verification?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ company_tax_id_verification?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ proof_of_registration?: { - files?: string[]; - }; - }; + files?: string[] + } + } /** @description The email address of the account holder. This is only to make the account easier to identify to you. Stripe only emails Custom accounts with your consent. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A card or bank account to attach to the account for receiving [payouts](https://stripe.com/docs/connect/bank-debit-card-payouts) (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://stripe.com/docs/api#account_create_bank_account) creation.

By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the bank account or card creation API. */ - external_account?: string; + external_account?: string /** * individual_specs * @description Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. @@ -17432,71 +17239,71 @@ export type operations = { individual?: { /** address_specs */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** japan_address_kana_specs */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** japan_address_kanji_specs */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } dob?: Partial<{ - day: number; - month: number; - year: number; + day: number + month: number + year: number }> & - Partial<"">; - email?: string; - first_name?: string; - first_name_kana?: string; - first_name_kanji?: string; - full_name_aliases?: Partial & Partial<"">; - gender?: string; - id_number?: string; - last_name?: string; - last_name_kana?: string; - last_name_kanji?: string; - maiden_name?: string; - metadata?: Partial<{ [key: string]: string }> & Partial<"">; - phone?: string; + Partial<''> + email?: string + first_name?: string + first_name_kana?: string + first_name_kanji?: string + full_name_aliases?: Partial & Partial<''> + gender?: string + id_number?: string + last_name?: string + last_name_kana?: string + last_name_kanji?: string + maiden_name?: string + metadata?: Partial<{ [key: string]: string }> & Partial<''> + phone?: string /** @enum {string} */ - political_exposure?: "existing" | "none"; - ssn_last_4?: string; + political_exposure?: 'existing' | 'none' + ssn_last_4?: string /** person_verification_specs */ verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; + back?: string + front?: string + } + } + } /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** * settings_specs_update * @description Options for customizing how the account functions within Stripe. @@ -17504,66 +17311,66 @@ export type operations = { settings?: { /** branding_settings_specs */ branding?: { - icon?: string; - logo?: string; - primary_color?: string; - secondary_color?: string; - }; + icon?: string + logo?: string + primary_color?: string + secondary_color?: string + } /** card_issuing_settings_specs */ card_issuing?: { /** settings_terms_of_service_specs */ tos_acceptance?: { /** Format: unix-time */ - date?: number; - ip?: string; - user_agent?: string; - }; - }; + date?: number + ip?: string + user_agent?: string + } + } /** card_payments_settings_specs */ card_payments?: { /** decline_charge_on_specs */ decline_on?: { - avs_failure?: boolean; - cvc_failure?: boolean; - }; - statement_descriptor_prefix?: string; - }; + avs_failure?: boolean + cvc_failure?: boolean + } + statement_descriptor_prefix?: string + } /** payments_settings_specs */ payments?: { - statement_descriptor?: string; - statement_descriptor_kana?: string; - statement_descriptor_kanji?: string; - }; + statement_descriptor?: string + statement_descriptor_kana?: string + statement_descriptor_kanji?: string + } /** payout_settings_specs */ payouts?: { - debit_negative_balances?: boolean; + debit_negative_balances?: boolean /** transfer_schedule_specs */ schedule?: { - delay_days?: Partial<"minimum"> & Partial; + delay_days?: Partial<'minimum'> & Partial /** @enum {string} */ - interval?: "daily" | "manual" | "monthly" | "weekly"; - monthly_anchor?: number; + interval?: 'daily' | 'manual' | 'monthly' | 'weekly' + monthly_anchor?: number /** @enum {string} */ - weekly_anchor?: "friday" | "monday" | "saturday" | "sunday" | "thursday" | "tuesday" | "wednesday"; - }; - statement_descriptor?: string; - }; - }; + weekly_anchor?: 'friday' | 'monday' | 'saturday' | 'sunday' | 'thursday' | 'tuesday' | 'wednesday' + } + statement_descriptor?: string + } + } /** * tos_acceptance_specs * @description Details on the account's acceptance of the [Stripe Services Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance). */ tos_acceptance?: { /** Format: unix-time */ - date?: number; - ip?: string; - service_agreement?: string; - user_agent?: string; - }; - }; - }; - }; - }; + date?: number + ip?: string + service_agreement?: string + user_agent?: string + } + } + } + } + } /** *

With Connect, you can delete accounts you manage.

* @@ -17574,112 +17381,112 @@ export type operations = { DeleteAccountsAccount: { parameters: { path: { - account: string; - }; - }; + account: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_account"]; - }; - }; + 'application/json': components['schemas']['deleted_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Create an external account for a given account.

*/ PostAccountsAccountBankAccounts: { parameters: { path: { - account: string; - }; - }; + account: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ bank_account?: Partial<{ - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; + account_holder_type?: 'company' | 'individual' + account_number: string /** @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; - country: string; - currency?: string; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' + country: string + currency?: string /** @enum {string} */ - object?: "bank_account"; - routing_number?: string; + object?: 'bank_account' + routing_number?: string }> & - Partial; + Partial /** @description When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency. */ - default_for_currency?: boolean; + default_for_currency?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - external_account?: string; + external_account?: string /** @description 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?: { [key: string]: string }; - }; - }; - }; - }; + metadata?: { [key: string]: string } + } + } + } + } /**

Retrieve a specified external account for a given account.

*/ GetAccountsAccountBankAccountsId: { parameters: { path: { - account: string; - id: string; - }; + account: string + id: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

* @@ -17688,334 +17495,334 @@ export type operations = { PostAccountsAccountBankAccountsId: { parameters: { path: { - account: string; - id: string; - }; - }; + account: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The name of the person or business that owns the bank account. */ - account_holder_name?: string; + account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - account_holder_type?: "" | "company" | "individual"; + account_holder_type?: '' | 'company' | 'individual' /** * @description The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`. * @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' /** @description City/District/Suburb/Town/Village. */ - address_city?: string; + address_city?: string /** @description Billing address country, if provided when creating card. */ - address_country?: string; + address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - address_line1?: string; + address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - address_line2?: string; + address_line2?: string /** @description State/County/Province/Region. */ - address_state?: string; + address_state?: string /** @description ZIP or postal code. */ - address_zip?: string; + address_zip?: string /** @description When set to true, this becomes the default external account for its currency. */ - default_for_currency?: boolean; + default_for_currency?: boolean /** @description Two digit number representing the card’s expiration month. */ - exp_month?: string; + exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - exp_year?: string; + exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Cardholder name. */ - name?: string; - }; - }; - }; - }; + name?: string + } + } + } + } /**

Delete a specified external account for a given account.

*/ DeleteAccountsAccountBankAccountsId: { parameters: { path: { - account: string; - id: string; - }; - }; + account: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_external_account"]; - }; - }; + 'application/json': components['schemas']['deleted_external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ GetAccountsAccountCapabilities: { parameters: { path: { - account: string; - }; + account: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["capability"][]; + 'application/json': { + data: components['schemas']['capability'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves information about the specified Account Capability.

*/ GetAccountsAccountCapabilitiesCapability: { parameters: { path: { - account: string; - capability: string; - }; + account: string + capability: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["capability"]; - }; - }; + 'application/json': components['schemas']['capability'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates an existing Account Capability.

*/ PostAccountsAccountCapabilitiesCapability: { parameters: { path: { - account: string; - capability: string; - }; - }; + account: string + capability: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["capability"]; - }; - }; + 'application/json': components['schemas']['capability'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. */ - requested?: boolean; - }; - }; - }; - }; + requested?: boolean + } + } + } + } /**

List external accounts for an account.

*/ GetAccountsAccountExternalAccounts: { parameters: { path: { - account: string; - }; + account: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards. */ - data: (Partial & Partial)[]; + data: (Partial & Partial)[] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Create an external account for a given account.

*/ PostAccountsAccountExternalAccounts: { parameters: { path: { - account: string; - }; - }; + account: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ bank_account?: Partial<{ - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; + account_holder_type?: 'company' | 'individual' + account_number: string /** @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; - country: string; - currency?: string; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' + country: string + currency?: string /** @enum {string} */ - object?: "bank_account"; - routing_number?: string; + object?: 'bank_account' + routing_number?: string }> & - Partial; + Partial /** @description When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency. */ - default_for_currency?: boolean; + default_for_currency?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - external_account?: string; + external_account?: string /** @description 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?: { [key: string]: string }; - }; - }; - }; - }; + metadata?: { [key: string]: string } + } + } + } + } /**

Retrieve a specified external account for a given account.

*/ GetAccountsAccountExternalAccountsId: { parameters: { path: { - account: string; - id: string; - }; + account: string + id: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

* @@ -18024,95 +17831,95 @@ export type operations = { PostAccountsAccountExternalAccountsId: { parameters: { path: { - account: string; - id: string; - }; - }; + account: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The name of the person or business that owns the bank account. */ - account_holder_name?: string; + account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - account_holder_type?: "" | "company" | "individual"; + account_holder_type?: '' | 'company' | 'individual' /** * @description The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`. * @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' /** @description City/District/Suburb/Town/Village. */ - address_city?: string; + address_city?: string /** @description Billing address country, if provided when creating card. */ - address_country?: string; + address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - address_line1?: string; + address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - address_line2?: string; + address_line2?: string /** @description State/County/Province/Region. */ - address_state?: string; + address_state?: string /** @description ZIP or postal code. */ - address_zip?: string; + address_zip?: string /** @description When set to true, this becomes the default external account for its currency. */ - default_for_currency?: boolean; + default_for_currency?: boolean /** @description Two digit number representing the card’s expiration month. */ - exp_month?: string; + exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - exp_year?: string; + exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Cardholder name. */ - name?: string; - }; - }; - }; - }; + name?: string + } + } + } + } /**

Delete a specified external account for a given account.

*/ DeleteAccountsAccountExternalAccountsId: { parameters: { path: { - account: string; - id: string; - }; - }; + account: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_external_account"]; - }; - }; + 'application/json': components['schemas']['deleted_external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Creates a single-use login link for an Express account to access their Stripe dashboard.

* @@ -18121,158 +17928,158 @@ export type operations = { PostAccountsAccountLoginLinks: { parameters: { path: { - account: string; - }; - }; + account: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["login_link"]; - }; - }; + 'application/json': components['schemas']['login_link'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Where to redirect the user after they log out of their dashboard. */ - redirect_url?: string; - }; - }; - }; - }; + redirect_url?: string + } + } + } + } /**

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.

*/ GetAccountsAccountPeople: { parameters: { path: { - account: string; - }; + account: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Filters on the list of people returned based on the person's relationship to the account's company. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - representative?: boolean; - }; + director?: boolean + executive?: boolean + owner?: boolean + representative?: boolean + } /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["person"][]; + 'application/json': { + data: components['schemas']['person'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new person.

*/ PostAccountsAccountPeople: { parameters: { path: { - account: string; - }; - }; + account: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * address_specs * @description The person's address. */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** @description The person's date of birth. */ dob?: Partial<{ - day: number; - month: number; - year: number; + day: number + month: number + year: number }> & - Partial<"">; + Partial<''> /** * person_documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -18280,65 +18087,65 @@ export type operations = { documents?: { /** documents_param */ company_authorization?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ passport?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ visa?: { - files?: string[]; - }; - }; + files?: string[] + } + } /** @description The person's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The person's first name. */ - first_name?: string; + first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - first_name_kana?: string; + first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - first_name_kanji?: string; + first_name_kanji?: string /** @description A list of alternate names or aliases that the person is known by. */ - full_name_aliases?: Partial & Partial<"">; + full_name_aliases?: Partial & Partial<''> /** @description The person's gender (International regulations require either "male" or "female"). */ - gender?: string; + gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ - id_number?: string; + id_number?: string /** @description The person's last name. */ - last_name?: string; + last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - last_name_kana?: string; + last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - last_name_kanji?: string; + last_name_kanji?: string /** @description The person's maiden name. */ - maiden_name?: string; + maiden_name?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ - nationality?: string; + nationality?: string /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - person_token?: string; + person_token?: string /** @description The person's phone number. */ - phone?: string; + phone?: string /** @description 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?: string; + political_exposure?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - percent_ownership?: Partial & Partial<"">; - representative?: boolean; - title?: string; - }; + director?: boolean + executive?: boolean + owner?: boolean + percent_ownership?: Partial & Partial<''> + representative?: boolean + title?: string + } /** @description The last four digits of the person's Social Security number (U.S. only). */ - ssn_last_4?: string; + ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -18346,121 +18153,121 @@ export type operations = { verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; - }; - }; - }; + back?: string + front?: string + } + } + } + } + } + } /**

Retrieves an existing person.

*/ GetAccountsAccountPeoplePerson: { parameters: { path: { - account: string; - person: string; - }; + account: string + person: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates an existing person.

*/ PostAccountsAccountPeoplePerson: { parameters: { path: { - account: string; - person: string; - }; - }; + account: string + person: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * address_specs * @description The person's address. */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** @description The person's date of birth. */ dob?: Partial<{ - day: number; - month: number; - year: number; + day: number + month: number + year: number }> & - Partial<"">; + Partial<''> /** * person_documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -18468,65 +18275,65 @@ export type operations = { documents?: { /** documents_param */ company_authorization?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ passport?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ visa?: { - files?: string[]; - }; - }; + files?: string[] + } + } /** @description The person's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The person's first name. */ - first_name?: string; + first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - first_name_kana?: string; + first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - first_name_kanji?: string; + first_name_kanji?: string /** @description A list of alternate names or aliases that the person is known by. */ - full_name_aliases?: Partial & Partial<"">; + full_name_aliases?: Partial & Partial<''> /** @description The person's gender (International regulations require either "male" or "female"). */ - gender?: string; + gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ - id_number?: string; + id_number?: string /** @description The person's last name. */ - last_name?: string; + last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - last_name_kana?: string; + last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - last_name_kanji?: string; + last_name_kanji?: string /** @description The person's maiden name. */ - maiden_name?: string; + maiden_name?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ - nationality?: string; + nationality?: string /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - person_token?: string; + person_token?: string /** @description The person's phone number. */ - phone?: string; + phone?: string /** @description 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?: string; + political_exposure?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - percent_ownership?: Partial & Partial<"">; - representative?: boolean; - title?: string; - }; + director?: boolean + executive?: boolean + owner?: boolean + percent_ownership?: Partial & Partial<''> + representative?: boolean + title?: string + } /** @description The last four digits of the person's Social Security number (U.S. only). */ - ssn_last_4?: string; + ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -18534,171 +18341,171 @@ export type operations = { verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; - }; - }; - }; + back?: string + front?: string + } + } + } + } + } + } /**

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.

*/ DeleteAccountsAccountPeoplePerson: { parameters: { path: { - account: string; - person: string; - }; - }; + account: string + person: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_person"]; - }; - }; + 'application/json': components['schemas']['deleted_person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ GetAccountsAccountPersons: { parameters: { path: { - account: string; - }; + account: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Filters on the list of people returned based on the person's relationship to the account's company. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - representative?: boolean; - }; + director?: boolean + executive?: boolean + owner?: boolean + representative?: boolean + } /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["person"][]; + 'application/json': { + data: components['schemas']['person'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new person.

*/ PostAccountsAccountPersons: { parameters: { path: { - account: string; - }; - }; + account: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * address_specs * @description The person's address. */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** @description The person's date of birth. */ dob?: Partial<{ - day: number; - month: number; - year: number; + day: number + month: number + year: number }> & - Partial<"">; + Partial<''> /** * person_documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -18706,65 +18513,65 @@ export type operations = { documents?: { /** documents_param */ company_authorization?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ passport?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ visa?: { - files?: string[]; - }; - }; + files?: string[] + } + } /** @description The person's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The person's first name. */ - first_name?: string; + first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - first_name_kana?: string; + first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - first_name_kanji?: string; + first_name_kanji?: string /** @description A list of alternate names or aliases that the person is known by. */ - full_name_aliases?: Partial & Partial<"">; + full_name_aliases?: Partial & Partial<''> /** @description The person's gender (International regulations require either "male" or "female"). */ - gender?: string; + gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ - id_number?: string; + id_number?: string /** @description The person's last name. */ - last_name?: string; + last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - last_name_kana?: string; + last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - last_name_kanji?: string; + last_name_kanji?: string /** @description The person's maiden name. */ - maiden_name?: string; + maiden_name?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ - nationality?: string; + nationality?: string /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - person_token?: string; + person_token?: string /** @description The person's phone number. */ - phone?: string; + phone?: string /** @description 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?: string; + political_exposure?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - percent_ownership?: Partial & Partial<"">; - representative?: boolean; - title?: string; - }; + director?: boolean + executive?: boolean + owner?: boolean + percent_ownership?: Partial & Partial<''> + representative?: boolean + title?: string + } /** @description The last four digits of the person's Social Security number (U.S. only). */ - ssn_last_4?: string; + ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -18772,121 +18579,121 @@ export type operations = { verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; - }; - }; - }; + back?: string + front?: string + } + } + } + } + } + } /**

Retrieves an existing person.

*/ GetAccountsAccountPersonsPerson: { parameters: { path: { - account: string; - person: string; - }; + account: string + person: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates an existing person.

*/ PostAccountsAccountPersonsPerson: { parameters: { path: { - account: string; - person: string; - }; - }; + account: string + person: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * address_specs * @description The person's address. */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** @description The person's date of birth. */ dob?: Partial<{ - day: number; - month: number; - year: number; + day: number + month: number + year: number }> & - Partial<"">; + Partial<''> /** * person_documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -18894,65 +18701,65 @@ export type operations = { documents?: { /** documents_param */ company_authorization?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ passport?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ visa?: { - files?: string[]; - }; - }; + files?: string[] + } + } /** @description The person's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The person's first name. */ - first_name?: string; + first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - first_name_kana?: string; + first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - first_name_kanji?: string; + first_name_kanji?: string /** @description A list of alternate names or aliases that the person is known by. */ - full_name_aliases?: Partial & Partial<"">; + full_name_aliases?: Partial & Partial<''> /** @description The person's gender (International regulations require either "male" or "female"). */ - gender?: string; + gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ - id_number?: string; + id_number?: string /** @description The person's last name. */ - last_name?: string; + last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - last_name_kana?: string; + last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - last_name_kanji?: string; + last_name_kanji?: string /** @description The person's maiden name. */ - maiden_name?: string; + maiden_name?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ - nationality?: string; + nationality?: string /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - person_token?: string; + person_token?: string /** @description The person's phone number. */ - phone?: string; + phone?: string /** @description 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?: string; + political_exposure?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - percent_ownership?: Partial & Partial<"">; - representative?: boolean; - title?: string; - }; + director?: boolean + executive?: boolean + owner?: boolean + percent_ownership?: Partial & Partial<''> + representative?: boolean + title?: string + } /** @description The last four digits of the person's Social Security number (U.S. only). */ - ssn_last_4?: string; + ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -18960,47 +18767,47 @@ export type operations = { verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; - }; - }; - }; + back?: string + front?: string + } + } + } + } + } + } /**

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.

*/ DeleteAccountsAccountPersonsPerson: { parameters: { path: { - account: string; - person: string; - }; - }; + account: string + person: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_person"]; - }; - }; + 'application/json': components['schemas']['deleted_person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

With Connect, you may flag accounts as suspicious.

* @@ -19009,250 +18816,250 @@ export type operations = { PostAccountsAccountReject: { parameters: { path: { - account: string; - }; - }; + account: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["account"]; - }; - }; + 'application/json': components['schemas']['account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The reason for rejecting the account. Can be `fraud`, `terms_of_service`, or `other`. */ - reason: string; - }; - }; - }; - }; + reason: string + } + } + } + } /**

List apple pay domains.

*/ GetApplePayDomains: { parameters: { query: { - domain_name?: string; + domain_name?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["apple_pay_domain"][]; + 'application/json': { + data: components['schemas']['apple_pay_domain'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Create an apple pay domain.

*/ PostApplePayDomains: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["apple_pay_domain"]; - }; - }; + 'application/json': components['schemas']['apple_pay_domain'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { - domain_name: string; + 'application/x-www-form-urlencoded': { + domain_name: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Retrieve an apple pay domain.

*/ GetApplePayDomainsDomain: { parameters: { path: { - domain: string; - }; + domain: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["apple_pay_domain"]; - }; - }; + 'application/json': components['schemas']['apple_pay_domain'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Delete an apple pay domain.

*/ DeleteApplePayDomainsDomain: { parameters: { path: { - domain: string; - }; - }; + domain: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_apple_pay_domain"]; - }; - }; + 'application/json': components['schemas']['deleted_apple_pay_domain'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ GetApplicationFees: { parameters: { query: { /** Only return application fees for the charge specified by this charge ID. */ - charge?: string; + charge?: string created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["application_fee"][]; + 'application/json': { + data: components['schemas']['application_fee'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ GetApplicationFeesFeeRefundsId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - fee: string; - id: string; - }; - }; + fee: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["fee_refund"]; - }; - }; + 'application/json': components['schemas']['fee_refund'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

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

* @@ -19261,146 +19068,146 @@ export type operations = { PostApplicationFeesFeeRefundsId: { parameters: { path: { - fee: string; - id: string; - }; - }; + fee: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["fee_refund"]; - }; - }; + 'application/json': components['schemas']['fee_refund'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

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

*/ GetApplicationFeesId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["application_fee"]; - }; - }; + 'application/json': components['schemas']['application_fee'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } PostApplicationFeesIdRefund: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["application_fee"]; - }; - }; + 'application/json': components['schemas']['application_fee'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { - amount?: number; - directive?: string; + 'application/x-www-form-urlencoded': { + amount?: number + directive?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

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.

*/ GetApplicationFeesIdRefunds: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["fee_refund"][]; + data: components['schemas']['fee_refund'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Refunds an application fee that has previously been collected but not yet refunded. * Funds will be refunded to the Stripe account from which the fee was originally collected.

@@ -19415,36 +19222,36 @@ export type operations = { PostApplicationFeesIdRefunds: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["fee_refund"]; - }; - }; + 'application/json': components['schemas']['fee_refund'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A positive integer, in _%s_, representing how much of this fee to refund. Can refund only up to the remaining unrefunded amount of the fee. */ - amount?: number; + amount?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; - }; - }; - }; - }; + metadata?: { [key: string]: string } + } + } + } + } /** *

Retrieves the current account balance, based on the authentication that was used to make the request. * For a sample request, see Accounting for negative balances.

@@ -19453,29 +19260,29 @@ export type operations = { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["balance"]; - }; - }; + 'application/json': components['schemas']['balance'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

* @@ -19485,61 +19292,61 @@ export type operations = { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** 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?: string; + currency?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID. */ - payout?: string; + payout?: string /** Only returns the original transaction. */ - source?: string; + source?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `payment`, `payment_failure_refund`, `payment_refund`, `payout`, `payout_cancel`, `payout_failure`, `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?: string; - }; - }; + type?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["balance_transaction"][]; + 'application/json': { + data: components['schemas']['balance_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Retrieves the balance transaction with the given ID.

* @@ -19549,32 +19356,32 @@ export type operations = { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["balance_transaction"]; - }; - }; + 'application/json': components['schemas']['balance_transaction'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

* @@ -19584,61 +19391,61 @@ export type operations = { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** 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?: string; + currency?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID. */ - payout?: string; + payout?: string /** Only returns the original transaction. */ - source?: string; + source?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `payment`, `payment_failure_refund`, `payment_refund`, `payout`, `payout_cancel`, `payout_failure`, `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?: string; - }; - }; + type?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["balance_transaction"][]; + 'application/json': { + data: components['schemas']['balance_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Retrieves the balance transaction with the given ID.

* @@ -19648,113 +19455,113 @@ export type operations = { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["balance_transaction"]; - }; - }; + 'application/json': components['schemas']['balance_transaction'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ GetBillingPortalConfigurations: { parameters: { query: { /** Only return configurations that are active or inactive (e.g., pass `true` to only list active configurations). */ - active?: boolean; + active?: boolean /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** Only return the default or non-default configurations (e.g., pass `true` to only list the default configuration). */ - is_default?: boolean; + is_default?: boolean /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["billing_portal.configuration"][]; + 'application/json': { + data: components['schemas']['billing_portal.configuration'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostBillingPortalConfigurations: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["billing_portal.configuration"]; - }; - }; + 'application/json': components['schemas']['billing_portal.configuration'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * business_profile_create_param * @description The business information shown to customers in the portal. */ business_profile: { - headline?: string; - privacy_policy_url: string; - terms_of_service_url: string; - }; + headline?: string + privacy_policy_url: string + terms_of_service_url: string + } /** @description 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?: Partial & Partial<"">; + default_return_url?: Partial & Partial<''> /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * features_creation_param * @description Information about the features available in the portal. @@ -19762,137 +19569,137 @@ export type operations = { features: { /** customer_update_creation_param */ customer_update?: { - allowed_updates: Partial<("address" | "email" | "phone" | "shipping" | "tax_id")[]> & Partial<"">; - enabled: boolean; - }; + allowed_updates: Partial<('address' | 'email' | 'phone' | 'shipping' | 'tax_id')[]> & Partial<''> + enabled: boolean + } /** invoice_list_param */ invoice_history?: { - enabled: boolean; - }; + enabled: boolean + } /** payment_method_update_param */ payment_method_update?: { - enabled: boolean; - }; + enabled: boolean + } /** subscription_cancel_creation_param */ subscription_cancel?: { /** subscription_cancellation_reason_creation_param */ cancellation_reason?: { - enabled: boolean; + enabled: boolean options: Partial< ( - | "customer_service" - | "low_quality" - | "missing_features" - | "other" - | "switched_service" - | "too_complex" - | "too_expensive" - | "unused" + | 'customer_service' + | 'low_quality' + | 'missing_features' + | 'other' + | 'switched_service' + | 'too_complex' + | 'too_expensive' + | 'unused' )[] > & - Partial<"">; - }; - enabled: boolean; + Partial<''> + } + enabled: boolean /** @enum {string} */ - mode?: "at_period_end" | "immediately"; + mode?: 'at_period_end' | 'immediately' /** @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; - }; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' + } /** subscription_pause_param */ subscription_pause?: { - enabled?: boolean; - }; + enabled?: boolean + } /** subscription_update_creation_param */ subscription_update?: { - default_allowed_updates: Partial<("price" | "promotion_code" | "quantity")[]> & Partial<"">; - enabled: boolean; + default_allowed_updates: Partial<('price' | 'promotion_code' | 'quantity')[]> & Partial<''> + enabled: boolean products: Partial< { - prices: string[]; - product: string; + prices: string[] + product: string }[] > & - Partial<"">; + Partial<''> /** @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; - }; - }; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' + } + } /** @description 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?: { [key: string]: string }; - }; - }; - }; - }; + metadata?: { [key: string]: string } + } + } + } + } /**

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

*/ GetBillingPortalConfigurationsConfiguration: { parameters: { path: { - configuration: string; - }; + configuration: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["billing_portal.configuration"]; - }; - }; + 'application/json': components['schemas']['billing_portal.configuration'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostBillingPortalConfigurationsConfiguration: { parameters: { path: { - configuration: string; - }; - }; + configuration: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["billing_portal.configuration"]; - }; - }; + 'application/json': components['schemas']['billing_portal.configuration'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether the configuration is active and can be used to create portal sessions. */ - active?: boolean; + active?: boolean /** * business_profile_update_param * @description The business information shown to customers in the portal. */ business_profile?: { - headline?: string; - privacy_policy_url?: string; - terms_of_service_url?: string; - }; + headline?: string + privacy_policy_url?: string + terms_of_service_url?: string + } /** @description 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?: Partial & Partial<"">; + default_return_url?: Partial & Partial<''> /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * features_updating_param * @description Information about the features available in the portal. @@ -19900,455 +19707,455 @@ export type operations = { features?: { /** customer_update_updating_param */ customer_update?: { - allowed_updates?: Partial<("address" | "email" | "phone" | "shipping" | "tax_id")[]> & Partial<"">; - enabled?: boolean; - }; + allowed_updates?: Partial<('address' | 'email' | 'phone' | 'shipping' | 'tax_id')[]> & Partial<''> + enabled?: boolean + } /** invoice_list_param */ invoice_history?: { - enabled: boolean; - }; + enabled: boolean + } /** payment_method_update_param */ payment_method_update?: { - enabled: boolean; - }; + enabled: boolean + } /** subscription_cancel_updating_param */ subscription_cancel?: { /** subscription_cancellation_reason_updating_param */ cancellation_reason?: { - enabled: boolean; + enabled: boolean options?: Partial< ( - | "customer_service" - | "low_quality" - | "missing_features" - | "other" - | "switched_service" - | "too_complex" - | "too_expensive" - | "unused" + | 'customer_service' + | 'low_quality' + | 'missing_features' + | 'other' + | 'switched_service' + | 'too_complex' + | 'too_expensive' + | 'unused' )[] > & - Partial<"">; - }; - enabled?: boolean; + Partial<''> + } + enabled?: boolean /** @enum {string} */ - mode?: "at_period_end" | "immediately"; + mode?: 'at_period_end' | 'immediately' /** @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; - }; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' + } /** subscription_pause_param */ subscription_pause?: { - enabled?: boolean; - }; + enabled?: boolean + } /** subscription_update_updating_param */ subscription_update?: { - default_allowed_updates?: Partial<("price" | "promotion_code" | "quantity")[]> & Partial<"">; - enabled?: boolean; + default_allowed_updates?: Partial<('price' | 'promotion_code' | 'quantity')[]> & Partial<''> + enabled?: boolean products?: Partial< { - prices: string[]; - product: string; + prices: string[] + product: string }[] > & - Partial<"">; + Partial<''> /** @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; - }; - }; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' + } + } /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Creates a session of the customer portal.

*/ PostBillingPortalSessions: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["billing_portal.session"]; - }; - }; + 'application/json': components['schemas']['billing_portal.session'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The ID of an existing [configuration](https://stripe.com/docs/api/customer_portal/configuration) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration. */ - configuration?: string; + configuration?: string /** @description The ID of an existing customer. */ - customer: string; + customer: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * @description 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. * @enum {string} */ locale?: - | "auto" - | "bg" - | "cs" - | "da" - | "de" - | "el" - | "en" - | "en-AU" - | "en-CA" - | "en-GB" - | "en-IE" - | "en-IN" - | "en-NZ" - | "en-SG" - | "es" - | "es-419" - | "et" - | "fi" - | "fil" - | "fr" - | "fr-CA" - | "hr" - | "hu" - | "id" - | "it" - | "ja" - | "ko" - | "lt" - | "lv" - | "ms" - | "mt" - | "nb" - | "nl" - | "pl" - | "pt" - | "pt-BR" - | "ro" - | "ru" - | "sk" - | "sl" - | "sv" - | "th" - | "tr" - | "vi" - | "zh" - | "zh-HK" - | "zh-TW"; + | 'auto' + | 'bg' + | 'cs' + | 'da' + | 'de' + | 'el' + | 'en' + | 'en-AU' + | 'en-CA' + | 'en-GB' + | 'en-IE' + | 'en-IN' + | 'en-NZ' + | 'en-SG' + | 'es' + | 'es-419' + | 'et' + | 'fi' + | 'fil' + | 'fr' + | 'fr-CA' + | 'hr' + | 'hu' + | 'id' + | 'it' + | 'ja' + | 'ko' + | 'lt' + | 'lv' + | 'ms' + | 'mt' + | 'nb' + | 'nl' + | 'pl' + | 'pt' + | 'pt-BR' + | 'ro' + | 'ru' + | 'sk' + | 'sl' + | 'sv' + | 'th' + | 'tr' + | 'vi' + | 'zh' + | 'zh-HK' + | 'zh-TW' /** @description The `on_behalf_of` account to use for this session. 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/charges-transfers#on-behalf-of). 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?: string; + on_behalf_of?: string /** @description The default URL to redirect customers to when they click on the portal's link to return to your website. */ - return_url?: string; - }; - }; - }; - }; + return_url?: string + } + } + } + } /**

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

*/ GetBitcoinReceivers: { parameters: { query: { /** Filter for active receivers. */ - active?: boolean; + active?: boolean /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** Filter for filled receivers. */ - filled?: boolean; + filled?: boolean /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Filter for receivers with uncaptured funds. */ - uncaptured_funds?: boolean; - }; - }; + uncaptured_funds?: boolean + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["bitcoin_receiver"][]; + 'application/json': { + data: components['schemas']['bitcoin_receiver'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves the Bitcoin receiver with the given ID.

*/ GetBitcoinReceiversId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["bitcoin_receiver"]; - }; - }; + 'application/json': components['schemas']['bitcoin_receiver'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

List bitcoin transacitons for a given receiver.

*/ GetBitcoinReceiversReceiverTransactions: { parameters: { query: { /** Only return transactions for the customer specified by this customer ID. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - receiver: string; - }; - }; + receiver: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["bitcoin_transaction"][]; + data: components['schemas']['bitcoin_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

List bitcoin transacitons for a given receiver.

*/ GetBitcoinTransactions: { parameters: { query: { /** Only return transactions for the customer specified by this customer ID. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; - receiver?: string; + limit?: number + receiver?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["bitcoin_transaction"][]; + data: components['schemas']['bitcoin_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ GetCharges: { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** Only return charges for the customer specified by this customer ID. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return charges that were created by the PaymentIntent specified by this PaymentIntent ID. */ - payment_intent?: string; + payment_intent?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return charges for this transfer group. */ - transfer_group?: string; - }; - }; + transfer_group?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["charge"][]; + 'application/json': { + data: components['schemas']['charge'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

To charge a credit card or other payment source, you create a Charge object. If your API key is in test mode, the supplied payment source (e.g., card) won’t actually be charged, although everything else will occur as if in live mode. (Stripe assumes that the charge would have completed successfully).

*/ PostCharges: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["charge"]; - }; - }; + 'application/json': components['schemas']['charge'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description 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?: number; - application_fee?: number; + amount?: number + application_fee?: number /** @description A fee in %s that will be applied to the charge and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the `Stripe-Account` header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees). */ - application_fee_amount?: number; + application_fee_amount?: number /** @description Whether to immediately capture the charge. Defaults to `true`. When `false`, the charge issues an authorization (or pre-authorization), and will need to be [captured](https://stripe.com/docs/api#capture_charge) later. Uncaptured charges expire after a set number of days (7 by default). For more information, see the [authorizing charges and settling later](https://stripe.com/docs/charges/placing-a-hold) documentation. */ - capture?: boolean; + capture?: boolean /** @description A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js). */ card?: Partial<{ - address_city?: string; - address_country?: string; - address_line1?: string; - address_line2?: string; - address_state?: string; - address_zip?: string; - cvc?: string; - exp_month: number; - exp_year: number; - metadata?: { [key: string]: string }; - name?: string; - number: string; + address_city?: string + address_country?: string + address_line1?: string + address_line2?: string + address_state?: string + address_zip?: string + cvc?: string + exp_month: number + exp_year: number + metadata?: { [key: string]: string } + name?: string + number: string /** @enum {string} */ - object?: "card"; + object?: 'card' }> & - Partial; + Partial /** @description 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?: string; + currency?: string /** @description The ID of an existing customer that will be charged in this request. */ - customer?: string; + customer?: string /** @description An arbitrary string which you can attach to a `Charge` object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the `description` of the charge(s) that they are describing. */ - description?: string; + description?: string destination?: Partial<{ - account: string; - amount?: number; + account: string + amount?: number }> & - Partial; + Partial /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The Stripe account ID for which these funds are intended. Automatically set if you use the `destination` parameter. For details, see [Creating Separate Charges and Transfers](https://stripe.com/docs/connect/charges-transfers#on-behalf-of). */ - on_behalf_of?: string; + on_behalf_of?: string /** @description The email address to which this charge's [receipt](https://stripe.com/docs/dashboard/receipts) will be sent. The receipt will not be sent until the charge is paid, and no receipts will be sent for test mode charges. If this charge is for a [Customer](https://stripe.com/docs/api/customers/object), the email address specified here will override the customer's email address. If `receipt_email` is specified for a charge in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails). */ - receipt_email?: string; + receipt_email?: string /** * optional_fields_shipping * @description Shipping information for the charge. Helps prevent fraud on charges for physical goods. @@ -20356,111 +20163,111 @@ export type operations = { shipping?: { /** optional_fields_address */ address: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - carrier?: string; - name: string; - phone?: string; - tracking_number?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + carrier?: string + name: string + phone?: string + tracking_number?: string + } /** @description A payment source to be charged. This can be the ID of a [card](https://stripe.com/docs/api#cards) (i.e., credit or debit card), a [bank account](https://stripe.com/docs/api#bank_accounts), a [source](https://stripe.com/docs/api#sources), a [token](https://stripe.com/docs/api#tokens), or a [connected account](https://stripe.com/docs/connect/account-debits#charging-a-connected-account). For certain sources---namely, [cards](https://stripe.com/docs/api#cards), [bank accounts](https://stripe.com/docs/api#bank_accounts), and attached [sources](https://stripe.com/docs/api#sources)---you must also pass the ID of the associated customer. */ - source?: string; + source?: string /** @description For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - statement_descriptor_suffix?: string; + statement_descriptor_suffix?: string /** * transfer_data_specs * @description 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?: { - amount?: number; - destination: string; - }; + amount?: number + destination: string + } /** @description A string that identifies this transaction as part of a group. For details, see [Grouping transactions](https://stripe.com/docs/connect/charges-transfers#transfer-options). */ - transfer_group?: string; - }; - }; - }; - }; + transfer_group?: string + } + } + } + } /**

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.

*/ GetChargesCharge: { parameters: { path: { - charge: string; - }; + charge: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["charge"]; - }; - }; + 'application/json': components['schemas']['charge'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostChargesCharge: { parameters: { path: { - charge: string; - }; - }; + charge: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["charge"]; - }; - }; + 'application/json': components['schemas']['charge'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The ID of an existing customer that will be associated with this request. This field may only be updated if there is no existing associated customer with this charge. */ - customer?: string; + customer?: string /** @description An arbitrary string which you can attach to a charge object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the `description` of the charge(s) that they are describing. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * fraud_details * @description A set of key-value pairs you can attach to a charge giving information about its riskiness. If you believe a charge is fraudulent, include a `user_report` key with a value of `fraudulent`. If you believe a charge is safe, include a `user_report` key with a value of `safe`. Stripe will use the information you send to improve our fraud detection algorithms. */ fraud_details?: { /** @enum {string} */ - user_report: "" | "fraudulent" | "safe"; - }; + user_report: '' | 'fraudulent' | 'safe' + } /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description This is the email address that the receipt for this charge will be sent to. If this field is updated, then a new email receipt will be sent to the updated address. */ - receipt_email?: string; + receipt_email?: string /** * optional_fields_shipping * @description Shipping information for the charge. Helps prevent fraud on charges for physical goods. @@ -20468,24 +20275,24 @@ export type operations = { shipping?: { /** optional_fields_address */ address: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - carrier?: string; - name: string; - phone?: string; - tracking_number?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + carrier?: string + name: string + phone?: string + tracking_number?: string + } /** @description A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-options) for details. */ - transfer_group?: string; - }; - }; - }; - }; + transfer_group?: string + } + } + } + } /** *

Capture the payment of an existing, uncaptured, charge. This is the second half of the two-step payment flow, where first you created a charge with the capture option set to false.

* @@ -20494,179 +20301,179 @@ export type operations = { PostChargesChargeCapture: { parameters: { path: { - charge: string; - }; - }; + charge: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["charge"]; - }; - }; + 'application/json': components['schemas']['charge'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The amount to capture, which must be less than or equal to the original amount. Any additional amount will be automatically refunded. */ - amount?: number; + amount?: number /** @description An application fee to add on to this charge. */ - application_fee?: number; + application_fee?: number /** @description An application fee amount to add on to this charge, which must be less than or equal to the original amount. */ - application_fee_amount?: number; + application_fee_amount?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The email address to send this charge's receipt to. This will override the previously-specified email address for this charge, if one was set. Receipts will not be sent in test mode. */ - receipt_email?: string; + receipt_email?: string /** @description For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - statement_descriptor_suffix?: string; + statement_descriptor_suffix?: string /** * transfer_data_specs * @description 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?: { - amount?: number; - }; + amount?: number + } /** @description A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-options) for details. */ - transfer_group?: string; - }; - }; - }; - }; + transfer_group?: string + } + } + } + } /**

Retrieve a dispute for a specified charge.

*/ GetChargesChargeDispute: { parameters: { path: { - charge: string; - }; + charge: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["dispute"]; - }; - }; + 'application/json': components['schemas']['dispute'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } PostChargesChargeDispute: { parameters: { path: { - charge: string; - }; - }; + charge: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["dispute"]; - }; - }; + 'application/json': components['schemas']['dispute'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * dispute_evidence_params * @description Evidence to upload, to respond to a dispute. Updating any field in the hash will submit all fields in the hash for review. The combined character count of all fields is limited to 150,000. */ evidence?: { - access_activity_log?: string; - billing_address?: string; - cancellation_policy?: string; - cancellation_policy_disclosure?: string; - cancellation_rebuttal?: string; - customer_communication?: string; - customer_email_address?: string; - customer_name?: string; - customer_purchase_ip?: string; - customer_signature?: string; - duplicate_charge_documentation?: string; - duplicate_charge_explanation?: string; - duplicate_charge_id?: string; - product_description?: string; - receipt?: string; - refund_policy?: string; - refund_policy_disclosure?: string; - refund_refusal_explanation?: string; - service_date?: string; - service_documentation?: string; - shipping_address?: string; - shipping_carrier?: string; - shipping_date?: string; - shipping_documentation?: string; - shipping_tracking_number?: string; - uncategorized_file?: string; - uncategorized_text?: string; - }; + access_activity_log?: string + billing_address?: string + cancellation_policy?: string + cancellation_policy_disclosure?: string + cancellation_rebuttal?: string + customer_communication?: string + customer_email_address?: string + customer_name?: string + customer_purchase_ip?: string + customer_signature?: string + duplicate_charge_documentation?: string + duplicate_charge_explanation?: string + duplicate_charge_id?: string + product_description?: string + receipt?: string + refund_policy?: string + refund_policy_disclosure?: string + refund_refusal_explanation?: string + service_date?: string + service_documentation?: string + shipping_address?: string + shipping_carrier?: string + shipping_date?: string + shipping_documentation?: string + shipping_tracking_number?: string + uncategorized_file?: string + uncategorized_text?: string + } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Whether to immediately submit evidence to the bank. If `false`, evidence is staged on the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank by making another request with this attribute set to `true` (the default). */ - submit?: boolean; - }; - }; - }; - }; + submit?: boolean + } + } + } + } PostChargesChargeDisputeClose: { parameters: { path: { - charge: string; - }; - }; + charge: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["dispute"]; - }; - }; + 'application/json': components['schemas']['dispute'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /** *

When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.

* @@ -20683,259 +20490,259 @@ export type operations = { PostChargesChargeRefund: { parameters: { path: { - charge: string; - }; - }; + charge: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["charge"]; - }; - }; + 'application/json': components['schemas']['charge'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { - amount?: number; + 'application/x-www-form-urlencoded': { + amount?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - payment_intent?: string; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + payment_intent?: string /** @enum {string} */ - reason?: "duplicate" | "fraudulent" | "requested_by_customer"; - refund_application_fee?: boolean; - reverse_transfer?: boolean; - }; - }; - }; - }; + reason?: 'duplicate' | 'fraudulent' | 'requested_by_customer' + refund_application_fee?: boolean + reverse_transfer?: boolean + } + } + } + } /**

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.

*/ GetChargesChargeRefunds: { parameters: { path: { - charge: string; - }; + charge: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["refund"][]; + data: components['schemas']['refund'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Create a refund.

*/ PostChargesChargeRefunds: { parameters: { path: { - charge: string; - }; - }; + charge: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["refund"]; - }; - }; + 'application/json': components['schemas']['refund'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { - amount?: number; + 'application/x-www-form-urlencoded': { + amount?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - payment_intent?: string; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + payment_intent?: string /** @enum {string} */ - reason?: "duplicate" | "fraudulent" | "requested_by_customer"; - refund_application_fee?: boolean; - reverse_transfer?: boolean; - }; - }; - }; - }; + reason?: 'duplicate' | 'fraudulent' | 'requested_by_customer' + refund_application_fee?: boolean + reverse_transfer?: boolean + } + } + } + } /**

Retrieves the details of an existing refund.

*/ GetChargesChargeRefundsRefund: { parameters: { path: { - charge: string; - refund: string; - }; + charge: string + refund: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["refund"]; - }; - }; + 'application/json': components['schemas']['refund'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Update a specified refund.

*/ PostChargesChargeRefundsRefund: { parameters: { path: { - charge: string; - refund: string; - }; - }; + charge: string + refund: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["refund"]; - }; - }; + 'application/json': components['schemas']['refund'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - metadata?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + expand?: string[] + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Returns a list of Checkout Sessions.

*/ GetCheckoutSessions: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return the Checkout Session for the PaymentIntent specified. */ - payment_intent?: string; + payment_intent?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return the Checkout Session for the subscription specified. */ - subscription?: string; - }; - }; + subscription?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["checkout.session"][]; + 'application/json': { + data: components['schemas']['checkout.session'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a Session object.

*/ PostCheckoutSessions: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["checkout.session"]; - }; - }; + 'application/json': components['schemas']['checkout.session'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * after_expiration_params * @description Configure actions after a Checkout Session has expired. @@ -20943,40 +20750,40 @@ export type operations = { after_expiration?: { /** recovery_params */ recovery?: { - allow_promotion_codes?: boolean; - enabled: boolean; - }; - }; + allow_promotion_codes?: boolean + enabled: boolean + } + } /** @description Enables user redeemable promotion codes. */ - allow_promotion_codes?: boolean; + allow_promotion_codes?: boolean /** * automatic_tax_params * @description Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions. */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** * @description Specify whether Checkout should collect the customer's billing address. * @enum {string} */ - billing_address_collection?: "auto" | "required"; + billing_address_collection?: 'auto' | 'required' /** @description The URL the customer will be directed to if they decide to cancel payment and return to your website. */ - cancel_url: string; + cancel_url: string /** * @description A unique string to reference the Checkout Session. This can be a * customer ID, a cart ID, or similar, and can be used to reconcile the * session with your internal systems. */ - client_reference_id?: string; + client_reference_id?: string /** * consent_collection_params * @description Configure fields for the Checkout Session to gather active consent from customers. */ consent_collection?: { /** @enum {string} */ - promotions?: "auto"; - }; + promotions?: 'auto' + } /** * @description ID of an existing Customer, if one exists. In `payment` mode, the customer’s most recent card * payment method will be used to prefill the email, name, card details, and billing address @@ -20990,7 +20797,7 @@ export type operations = { * * You can set [`payment_intent_data.setup_future_usage`](https://stripe.com/docs/api/checkout/sessions/create#create_checkout_session-payment_intent_data-setup_future_usage) to have Checkout automatically attach the payment method to the Customer you pass in for future reuse. */ - customer?: string; + customer?: string /** * @description Configure whether a Checkout Session creates a [Customer](https://stripe.com/docs/api/customers) during Session confirmation. * @@ -21002,7 +20809,7 @@ export type operations = { * Can only be set in `payment` and `setup` mode. * @enum {string} */ - customer_creation?: "always" | "if_required"; + customer_creation?: 'always' | 'if_required' /** * @description 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. @@ -21010,31 +20817,31 @@ export type operations = { * on file. To access information about the customer once a session is * complete, use the `customer` field. */ - customer_email?: string; + customer_email?: string /** * customer_update_params * @description Controls what fields on Customer can be updated by the Checkout Session. Can only be provided when `customer` is provided. */ customer_update?: { /** @enum {string} */ - address?: "auto" | "never"; + address?: 'auto' | 'never' /** @enum {string} */ - name?: "auto" | "never"; + name?: 'auto' | 'never' /** @enum {string} */ - shipping?: "auto" | "never"; - }; + shipping?: 'auto' | 'never' + } /** @description The coupon or promotion code to apply to this Session. Currently, only up to one may be specified. */ discounts?: { - coupon?: string; - promotion_code?: string; - }[]; + coupon?: string + promotion_code?: string + }[] /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * Format: unix-time * @description The Epoch time in seconds at which the Checkout Session will expire. It can be anywhere from 1 to 24 hours after Checkout Session creation. By default, this value is 24 hours from creation. */ - expires_at?: number; + expires_at?: number /** * @description A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices). * @@ -21045,132 +20852,132 @@ export type operations = { line_items?: { /** adjustable_quantity_params */ adjustable_quantity?: { - enabled: boolean; - maximum?: number; - minimum?: number; - }; - description?: string; - dynamic_tax_rates?: string[]; - price?: string; + enabled: boolean + maximum?: number + minimum?: number + } + description?: string + dynamic_tax_rates?: string[] + price?: string /** price_data_with_product_data */ price_data?: { - currency: string; - product?: string; + currency: string + product?: string /** product_data */ product_data?: { - description?: string; - images?: string[]; - metadata?: { [key: string]: string }; - name: string; - tax_code?: string; - }; + description?: string + images?: string[] + metadata?: { [key: string]: string } + name: string + tax_code?: string + } /** recurring_adhoc */ recurring?: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: string[]; - }[]; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: string[] + }[] /** * @description The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used. * @enum {string} */ locale?: - | "auto" - | "bg" - | "cs" - | "da" - | "de" - | "el" - | "en" - | "en-GB" - | "es" - | "es-419" - | "et" - | "fi" - | "fil" - | "fr" - | "fr-CA" - | "hr" - | "hu" - | "id" - | "it" - | "ja" - | "ko" - | "lt" - | "lv" - | "ms" - | "mt" - | "nb" - | "nl" - | "pl" - | "pt" - | "pt-BR" - | "ro" - | "ru" - | "sk" - | "sl" - | "sv" - | "th" - | "tr" - | "vi" - | "zh" - | "zh-HK" - | "zh-TW"; + | 'auto' + | 'bg' + | 'cs' + | 'da' + | 'de' + | 'el' + | 'en' + | 'en-GB' + | 'es' + | 'es-419' + | 'et' + | 'fi' + | 'fil' + | 'fr' + | 'fr-CA' + | 'hr' + | 'hu' + | 'id' + | 'it' + | 'ja' + | 'ko' + | 'lt' + | 'lv' + | 'ms' + | 'mt' + | 'nb' + | 'nl' + | 'pl' + | 'pt' + | 'pt-BR' + | 'ro' + | 'ru' + | 'sk' + | 'sl' + | 'sv' + | 'th' + | 'tr' + | 'vi' + | 'zh' + | 'zh-HK' + | 'zh-TW' /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * @description The mode of the Checkout Session. Required when using prices or `setup` mode. Pass `subscription` if the Checkout Session includes at least one recurring item. * @enum {string} */ - mode?: "payment" | "setup" | "subscription"; + mode?: 'payment' | 'setup' | 'subscription' /** * payment_intent_data_params * @description A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode. */ payment_intent_data?: { - application_fee_amount?: number; + application_fee_amount?: number /** @enum {string} */ - capture_method?: "automatic" | "manual"; - description?: string; - metadata?: { [key: string]: string }; - on_behalf_of?: string; - receipt_email?: string; + capture_method?: 'automatic' | 'manual' + description?: string + metadata?: { [key: string]: string } + on_behalf_of?: string + receipt_email?: string /** @enum {string} */ - setup_future_usage?: "off_session" | "on_session"; + setup_future_usage?: 'off_session' | 'on_session' /** shipping */ shipping?: { /** address */ address: { - city?: string; - country?: string; - line1: string; - line2?: string; - postal_code?: string; - state?: string; - }; - carrier?: string; - name: string; - phone?: string; - tracking_number?: string; - }; - statement_descriptor?: string; - statement_descriptor_suffix?: string; + city?: string + country?: string + line1: string + line2?: string + postal_code?: string + state?: string + } + carrier?: string + name: string + phone?: string + tracking_number?: string + } + statement_descriptor?: string + statement_descriptor_suffix?: string /** transfer_data_params */ transfer_data?: { - amount?: number; - destination: string; - }; - transfer_group?: string; - }; + amount?: number + destination: string + } + transfer_group?: string + } /** * payment_method_options_param * @description Payment-method-specific configuration. @@ -21179,35 +20986,35 @@ export type operations = { /** payment_method_options_param */ acss_debit?: { /** @enum {string} */ - currency?: "cad" | "usd"; + currency?: 'cad' | 'usd' /** mandate_options_param */ mandate_options?: { - custom_mandate_url?: Partial & Partial<"">; - default_for?: ("invoice" | "subscription")[]; - interval_description?: string; + custom_mandate_url?: Partial & Partial<''> + default_for?: ('invoice' | 'subscription')[] + interval_description?: string /** @enum {string} */ - payment_schedule?: "combined" | "interval" | "sporadic"; + payment_schedule?: 'combined' | 'interval' | 'sporadic' /** @enum {string} */ - transaction_type?: "business" | "personal"; - }; + transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; - }; + verification_method?: 'automatic' | 'instant' | 'microdeposits' + } /** payment_method_options_param */ boleto?: { - expires_after_days?: number; - }; + expires_after_days?: number + } /** payment_method_options_param */ oxxo?: { - expires_after_days?: number; - }; + expires_after_days?: number + } /** payment_method_options_param */ wechat_pay?: { - app_id?: string; + app_id?: string /** @enum {string} */ - client: "android" | "ios" | "web"; - }; - }; + client: 'android' | 'ios' | 'web' + } + } /** * @description A list of the types of payment methods (e.g., `card`) this Checkout Session can accept. * @@ -21219,26 +21026,26 @@ export type operations = { * other characteristics. */ payment_method_types?: ( - | "acss_debit" - | "afterpay_clearpay" - | "alipay" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "eps" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "klarna" - | "oxxo" - | "p24" - | "sepa_debit" - | "sofort" - | "wechat_pay" - )[]; + | 'acss_debit' + | 'afterpay_clearpay' + | 'alipay' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'eps' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'klarna' + | 'oxxo' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' + )[] /** * phone_number_collection_params * @description Controls phone number collection settings for the session. @@ -21247,265 +21054,265 @@ export type operations = { * before using this feature. Learn more about [collecting phone numbers with Checkout](https://stripe.com/docs/payments/checkout/phone-numbers). */ phone_number_collection?: { - enabled: boolean; - }; + enabled: boolean + } /** * setup_intent_data_param * @description A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in `setup` mode. */ setup_intent_data?: { - description?: string; - metadata?: { [key: string]: string }; - on_behalf_of?: string; - }; + description?: string + metadata?: { [key: string]: string } + on_behalf_of?: string + } /** * shipping_address_collection_params * @description When set, provides configuration for Checkout to collect a shipping address from a customer. */ shipping_address_collection?: { allowed_countries: ( - | "AC" - | "AD" - | "AE" - | "AF" - | "AG" - | "AI" - | "AL" - | "AM" - | "AO" - | "AQ" - | "AR" - | "AT" - | "AU" - | "AW" - | "AX" - | "AZ" - | "BA" - | "BB" - | "BD" - | "BE" - | "BF" - | "BG" - | "BH" - | "BI" - | "BJ" - | "BL" - | "BM" - | "BN" - | "BO" - | "BQ" - | "BR" - | "BS" - | "BT" - | "BV" - | "BW" - | "BY" - | "BZ" - | "CA" - | "CD" - | "CF" - | "CG" - | "CH" - | "CI" - | "CK" - | "CL" - | "CM" - | "CN" - | "CO" - | "CR" - | "CV" - | "CW" - | "CY" - | "CZ" - | "DE" - | "DJ" - | "DK" - | "DM" - | "DO" - | "DZ" - | "EC" - | "EE" - | "EG" - | "EH" - | "ER" - | "ES" - | "ET" - | "FI" - | "FJ" - | "FK" - | "FO" - | "FR" - | "GA" - | "GB" - | "GD" - | "GE" - | "GF" - | "GG" - | "GH" - | "GI" - | "GL" - | "GM" - | "GN" - | "GP" - | "GQ" - | "GR" - | "GS" - | "GT" - | "GU" - | "GW" - | "GY" - | "HK" - | "HN" - | "HR" - | "HT" - | "HU" - | "ID" - | "IE" - | "IL" - | "IM" - | "IN" - | "IO" - | "IQ" - | "IS" - | "IT" - | "JE" - | "JM" - | "JO" - | "JP" - | "KE" - | "KG" - | "KH" - | "KI" - | "KM" - | "KN" - | "KR" - | "KW" - | "KY" - | "KZ" - | "LA" - | "LB" - | "LC" - | "LI" - | "LK" - | "LR" - | "LS" - | "LT" - | "LU" - | "LV" - | "LY" - | "MA" - | "MC" - | "MD" - | "ME" - | "MF" - | "MG" - | "MK" - | "ML" - | "MM" - | "MN" - | "MO" - | "MQ" - | "MR" - | "MS" - | "MT" - | "MU" - | "MV" - | "MW" - | "MX" - | "MY" - | "MZ" - | "NA" - | "NC" - | "NE" - | "NG" - | "NI" - | "NL" - | "NO" - | "NP" - | "NR" - | "NU" - | "NZ" - | "OM" - | "PA" - | "PE" - | "PF" - | "PG" - | "PH" - | "PK" - | "PL" - | "PM" - | "PN" - | "PR" - | "PS" - | "PT" - | "PY" - | "QA" - | "RE" - | "RO" - | "RS" - | "RU" - | "RW" - | "SA" - | "SB" - | "SC" - | "SE" - | "SG" - | "SH" - | "SI" - | "SJ" - | "SK" - | "SL" - | "SM" - | "SN" - | "SO" - | "SR" - | "SS" - | "ST" - | "SV" - | "SX" - | "SZ" - | "TA" - | "TC" - | "TD" - | "TF" - | "TG" - | "TH" - | "TJ" - | "TK" - | "TL" - | "TM" - | "TN" - | "TO" - | "TR" - | "TT" - | "TV" - | "TW" - | "TZ" - | "UA" - | "UG" - | "US" - | "UY" - | "UZ" - | "VA" - | "VC" - | "VE" - | "VG" - | "VN" - | "VU" - | "WF" - | "WS" - | "XK" - | "YE" - | "YT" - | "ZA" - | "ZM" - | "ZW" - | "ZZ" - )[]; - }; + | 'AC' + | 'AD' + | 'AE' + | 'AF' + | 'AG' + | 'AI' + | 'AL' + | 'AM' + | 'AO' + | 'AQ' + | 'AR' + | 'AT' + | 'AU' + | 'AW' + | 'AX' + | 'AZ' + | 'BA' + | 'BB' + | 'BD' + | 'BE' + | 'BF' + | 'BG' + | 'BH' + | 'BI' + | 'BJ' + | 'BL' + | 'BM' + | 'BN' + | 'BO' + | 'BQ' + | 'BR' + | 'BS' + | 'BT' + | 'BV' + | 'BW' + | 'BY' + | 'BZ' + | 'CA' + | 'CD' + | 'CF' + | 'CG' + | 'CH' + | 'CI' + | 'CK' + | 'CL' + | 'CM' + | 'CN' + | 'CO' + | 'CR' + | 'CV' + | 'CW' + | 'CY' + | 'CZ' + | 'DE' + | 'DJ' + | 'DK' + | 'DM' + | 'DO' + | 'DZ' + | 'EC' + | 'EE' + | 'EG' + | 'EH' + | 'ER' + | 'ES' + | 'ET' + | 'FI' + | 'FJ' + | 'FK' + | 'FO' + | 'FR' + | 'GA' + | 'GB' + | 'GD' + | 'GE' + | 'GF' + | 'GG' + | 'GH' + | 'GI' + | 'GL' + | 'GM' + | 'GN' + | 'GP' + | 'GQ' + | 'GR' + | 'GS' + | 'GT' + | 'GU' + | 'GW' + | 'GY' + | 'HK' + | 'HN' + | 'HR' + | 'HT' + | 'HU' + | 'ID' + | 'IE' + | 'IL' + | 'IM' + | 'IN' + | 'IO' + | 'IQ' + | 'IS' + | 'IT' + | 'JE' + | 'JM' + | 'JO' + | 'JP' + | 'KE' + | 'KG' + | 'KH' + | 'KI' + | 'KM' + | 'KN' + | 'KR' + | 'KW' + | 'KY' + | 'KZ' + | 'LA' + | 'LB' + | 'LC' + | 'LI' + | 'LK' + | 'LR' + | 'LS' + | 'LT' + | 'LU' + | 'LV' + | 'LY' + | 'MA' + | 'MC' + | 'MD' + | 'ME' + | 'MF' + | 'MG' + | 'MK' + | 'ML' + | 'MM' + | 'MN' + | 'MO' + | 'MQ' + | 'MR' + | 'MS' + | 'MT' + | 'MU' + | 'MV' + | 'MW' + | 'MX' + | 'MY' + | 'MZ' + | 'NA' + | 'NC' + | 'NE' + | 'NG' + | 'NI' + | 'NL' + | 'NO' + | 'NP' + | 'NR' + | 'NU' + | 'NZ' + | 'OM' + | 'PA' + | 'PE' + | 'PF' + | 'PG' + | 'PH' + | 'PK' + | 'PL' + | 'PM' + | 'PN' + | 'PR' + | 'PS' + | 'PT' + | 'PY' + | 'QA' + | 'RE' + | 'RO' + | 'RS' + | 'RU' + | 'RW' + | 'SA' + | 'SB' + | 'SC' + | 'SE' + | 'SG' + | 'SH' + | 'SI' + | 'SJ' + | 'SK' + | 'SL' + | 'SM' + | 'SN' + | 'SO' + | 'SR' + | 'SS' + | 'ST' + | 'SV' + | 'SX' + | 'SZ' + | 'TA' + | 'TC' + | 'TD' + | 'TF' + | 'TG' + | 'TH' + | 'TJ' + | 'TK' + | 'TL' + | 'TM' + | 'TN' + | 'TO' + | 'TR' + | 'TT' + | 'TV' + | 'TW' + | 'TZ' + | 'UA' + | 'UG' + | 'US' + | 'UY' + | 'UZ' + | 'VA' + | 'VC' + | 'VE' + | 'VG' + | 'VN' + | 'VU' + | 'WF' + | 'WS' + | 'XK' + | 'YE' + | 'YT' + | 'ZA' + | 'ZM' + | 'ZW' + | 'ZZ' + )[] + } /** @description The shipping rate options to apply to this Session. */ shipping_options?: { - shipping_rate?: string; + shipping_rate?: string /** method_params */ shipping_rate_data?: { /** delivery_estimate */ @@ -21513,30 +21320,30 @@ export type operations = { /** delivery_estimate_bound */ maximum?: { /** @enum {string} */ - unit: "business_day" | "day" | "hour" | "month" | "week"; - value: number; - }; + unit: 'business_day' | 'day' | 'hour' | 'month' | 'week' + value: number + } /** delivery_estimate_bound */ minimum?: { /** @enum {string} */ - unit: "business_day" | "day" | "hour" | "month" | "week"; - value: number; - }; - }; - display_name: string; + unit: 'business_day' | 'day' | 'hour' | 'month' | 'week' + value: number + } + } + display_name: string /** fixed_amount */ fixed_amount?: { - amount: number; - currency: string; - }; - metadata?: { [key: string]: string }; + amount: number + currency: string + } + metadata?: { [key: string]: string } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - tax_code?: string; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + tax_code?: string /** @enum {string} */ - type?: "fixed_amount"; - }; - }[]; + type?: 'fixed_amount' + } + }[] /** * @description Describes the type of transaction being performed by Checkout in order to customize * relevant text on the page, such as the submit button. `submit_type` can only be @@ -21544,78 +21351,78 @@ export type operations = { * in `subscription` or `setup` mode. * @enum {string} */ - submit_type?: "auto" | "book" | "donate" | "pay"; + submit_type?: 'auto' | 'book' | 'donate' | 'pay' /** * subscription_data_params * @description A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode. */ subscription_data?: { - application_fee_percent?: number; - default_tax_rates?: string[]; + application_fee_percent?: number + default_tax_rates?: string[] items?: { - plan: string; - quantity?: number; - tax_rates?: string[]; - }[]; - metadata?: { [key: string]: string }; + plan: string + quantity?: number + tax_rates?: string[] + }[] + metadata?: { [key: string]: string } /** transfer_data_specs */ transfer_data?: { - amount_percent?: number; - destination: string; - }; + amount_percent?: number + destination: string + } /** Format: unix-time */ - trial_end?: number; - trial_period_days?: number; - }; + trial_end?: number + trial_period_days?: number + } /** * @description The URL to which Stripe should send customers when payment or setup * is complete. * If you’d like to use information from the successful Checkout Session on your page, * read the guide on [customizing your success page](https://stripe.com/docs/payments/checkout/custom-success-page). */ - success_url: string; + success_url: string /** * tax_id_collection_params * @description Controls tax ID collection settings for the session. */ tax_id_collection?: { - enabled: boolean; - }; - }; - }; - }; - }; + enabled: boolean + } + } + } + } + } /**

Retrieves a Session object.

*/ GetCheckoutSessionsSession: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - session: string; - }; - }; + session: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["checkout.session"]; - }; - }; + 'application/json': components['schemas']['checkout.session'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

A Session can be expired when it is in one of these statuses: open

* @@ -21624,210 +21431,210 @@ export type operations = { PostCheckoutSessionsSessionExpire: { parameters: { path: { - session: string; - }; - }; + session: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["checkout.session"]; - }; - }; + 'application/json': components['schemas']['checkout.session'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

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.

*/ GetCheckoutSessionsSessionLineItems: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - session: string; - }; - }; + session: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["item"][]; + data: components['schemas']['item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Lists all Country Spec objects available in the API.

*/ GetCountrySpecs: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["country_spec"][]; + 'application/json': { + data: components['schemas']['country_spec'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a Country Spec for a given Country code.

*/ GetCountrySpecsCountry: { parameters: { path: { - country: string; - }; + country: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["country_spec"]; - }; - }; + 'application/json': components['schemas']['country_spec'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of your coupons.

*/ GetCoupons: { parameters: { query: { /** 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?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["coupon"][]; + 'application/json': { + data: components['schemas']['coupon'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

You can create coupons easily via the coupon management page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.

* @@ -21838,199 +21645,199 @@ export type operations = { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["coupon"]; - }; - }; + 'application/json': components['schemas']['coupon'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed). */ - amount_off?: number; + amount_off?: number /** * applies_to_params * @description A hash containing directions for what this Coupon will apply discounts to. */ applies_to?: { - products?: string[]; - }; + products?: string[] + } /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed). */ - currency?: string; + currency?: string /** * @description Specifies how long the discount will be in effect if used on a subscription. Can be `forever`, `once`, or `repeating`. Defaults to `once`. * @enum {string} */ - duration?: "forever" | "once" | "repeating"; + duration?: 'forever' | 'once' | 'repeating' /** @description Required only if `duration` is `repeating`, in which case it must be a positive integer that specifies the number of months the discount will be in effect. */ - duration_in_months?: number; + duration_in_months?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Unique string of your choice that will be used to identify this coupon when applying it to a customer. If you don't want to specify a particular code, you can leave the ID blank and we'll generate a random code for you. */ - id?: string; + id?: string /** @description A positive integer specifying the number of times the coupon can be redeemed before it's no longer valid. For example, you might have a 50% off coupon that the first 20 readers of your blog can use. */ - max_redemptions?: number; + max_redemptions?: number /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set. */ - name?: string; + name?: string /** @description A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if `amount_off` is not passed). */ - percent_off?: number; + percent_off?: number /** * Format: unix-time * @description Unix timestamp specifying the last time at which the coupon can be redeemed. After the redeem_by date, the coupon can no longer be applied to new customers. */ - redeem_by?: number; - }; - }; - }; - }; + redeem_by?: number + } + } + } + } /**

Retrieves the coupon with the given ID.

*/ GetCouponsCoupon: { parameters: { path: { - coupon: string; - }; + coupon: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["coupon"]; - }; - }; + 'application/json': components['schemas']['coupon'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostCouponsCoupon: { parameters: { path: { - coupon: string; - }; - }; + coupon: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["coupon"]; - }; - }; + 'application/json': components['schemas']['coupon'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set. */ - name?: string; - }; - }; - }; - }; + name?: string + } + } + } + } /**

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.

*/ DeleteCouponsCoupon: { parameters: { path: { - coupon: string; - }; - }; + coupon: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_coupon"]; - }; - }; + 'application/json': components['schemas']['deleted_coupon'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of credit notes.

*/ GetCreditNotes: { parameters: { query: { /** Only return credit notes for the customer specified by this customer ID. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** Only return credit notes for the invoice specified by this invoice ID. */ - invoice?: string; + invoice?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["credit_note"][]; + 'application/json': { + data: components['schemas']['credit_note'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces * its amount_due. For a status=paid invoice, a credit note does not affect its amount_due. Instead, it can result @@ -22052,433 +21859,433 @@ export type operations = { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["credit_note"]; - }; - }; + 'application/json': components['schemas']['credit_note'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The integer amount in %s representing the total amount of the credit note. */ - amount?: number; + amount?: number /** @description The integer amount in %s representing the amount to credit the customer's balance, which will be automatically applied to their next invoice. */ - credit_amount?: number; + credit_amount?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description ID of the invoice. */ - invoice: string; + invoice: string /** @description Line items that make up the credit note. */ lines?: { - amount?: number; - description?: string; - invoice_line_item?: string; - quantity?: number; - tax_rates?: Partial & Partial<"">; + amount?: number + description?: string + invoice_line_item?: string + quantity?: number + tax_rates?: Partial & Partial<''> /** @enum {string} */ - type: "custom_line_item" | "invoice_line_item"; - unit_amount?: number; + type: 'custom_line_item' | 'invoice_line_item' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }[]; + unit_amount_decimal?: string + }[] /** @description The credit note's memo appears on the credit note PDF. */ - memo?: string; + memo?: string /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The integer amount in %s representing the amount that is credited outside of Stripe. */ - out_of_band_amount?: number; + out_of_band_amount?: number /** * @description Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` * @enum {string} */ - reason?: "duplicate" | "fraudulent" | "order_change" | "product_unsatisfactory"; + reason?: 'duplicate' | 'fraudulent' | 'order_change' | 'product_unsatisfactory' /** @description ID of an existing refund to link this credit note to. */ - refund?: string; + refund?: string /** @description The integer amount in %s representing the amount to refund. If set, a refund will be created for the charge associated with the invoice. */ - refund_amount?: number; - }; - }; - }; - }; + refund_amount?: number + } + } + } + } /**

Get a preview of a credit note without creating it.

*/ GetCreditNotesPreview: { parameters: { query: { /** The integer amount in %s representing the total amount of the credit note. */ - amount?: number; + amount?: number /** The integer amount in %s representing the amount to credit the customer's balance, which will be automatically applied to their next invoice. */ - credit_amount?: number; + credit_amount?: number /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** ID of the invoice. */ - invoice: string; + invoice: string /** Line items that make up the credit note. */ lines?: { - amount?: number; - description?: string; - invoice_line_item?: string; - quantity?: number; - tax_rates?: Partial & Partial<"">; + amount?: number + description?: string + invoice_line_item?: string + quantity?: number + tax_rates?: Partial & Partial<''> /** @enum {string} */ - type: "custom_line_item" | "invoice_line_item"; - unit_amount?: number; + type: 'custom_line_item' | 'invoice_line_item' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }[]; + unit_amount_decimal?: string + }[] /** The credit note's memo appears on the credit note PDF. */ - memo?: string; + memo?: string /** 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** The integer amount in %s representing the amount that is credited outside of Stripe. */ - out_of_band_amount?: number; + out_of_band_amount?: number /** Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` */ - reason?: "duplicate" | "fraudulent" | "order_change" | "product_unsatisfactory"; + reason?: 'duplicate' | 'fraudulent' | 'order_change' | 'product_unsatisfactory' /** ID of an existing refund to link this credit note to. */ - refund?: string; + refund?: string /** The integer amount in %s representing the amount to refund. If set, a refund will be created for the charge associated with the invoice. */ - refund_amount?: number; - }; - }; + refund_amount?: number + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["credit_note"]; - }; - }; + 'application/json': components['schemas']['credit_note'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ GetCreditNotesPreviewLines: { parameters: { query: { /** The integer amount in %s representing the total amount of the credit note. */ - amount?: number; + amount?: number /** The integer amount in %s representing the amount to credit the customer's balance, which will be automatically applied to their next invoice. */ - credit_amount?: number; + credit_amount?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** ID of the invoice. */ - invoice: string; + invoice: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Line items that make up the credit note. */ lines?: { - amount?: number; - description?: string; - invoice_line_item?: string; - quantity?: number; - tax_rates?: Partial & Partial<"">; + amount?: number + description?: string + invoice_line_item?: string + quantity?: number + tax_rates?: Partial & Partial<''> /** @enum {string} */ - type: "custom_line_item" | "invoice_line_item"; - unit_amount?: number; + type: 'custom_line_item' | 'invoice_line_item' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }[]; + unit_amount_decimal?: string + }[] /** The credit note's memo appears on the credit note PDF. */ - memo?: string; + memo?: string /** 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** The integer amount in %s representing the amount that is credited outside of Stripe. */ - out_of_band_amount?: number; + out_of_band_amount?: number /** Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` */ - reason?: "duplicate" | "fraudulent" | "order_change" | "product_unsatisfactory"; + reason?: 'duplicate' | 'fraudulent' | 'order_change' | 'product_unsatisfactory' /** ID of an existing refund to link this credit note to. */ - refund?: string; + refund?: string /** The integer amount in %s representing the amount to refund. If set, a refund will be created for the charge associated with the invoice. */ - refund_amount?: number; + refund_amount?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["credit_note_line_item"][]; + data: components['schemas']['credit_note_line_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ GetCreditNotesCreditNoteLines: { parameters: { path: { - credit_note: string; - }; + credit_note: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["credit_note_line_item"][]; + data: components['schemas']['credit_note_line_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves the credit note object with the given identifier.

*/ GetCreditNotesId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["credit_note"]; - }; - }; + 'application/json': components['schemas']['credit_note'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates an existing credit note.

*/ PostCreditNotesId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["credit_note"]; - }; - }; + 'application/json': components['schemas']['credit_note'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Credit note memo. */ - memo?: string; + memo?: string /** @description 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?: { [key: string]: string }; - }; - }; - }; - }; + metadata?: { [key: string]: string } + } + } + } + } /**

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

*/ PostCreditNotesIdVoid: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["credit_note"]; - }; - }; + 'application/json': components['schemas']['credit_note'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

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

*/ GetCustomers: { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A case-sensitive filter on the list based on the customer's `email` field. The value must be a string. */ - email?: string; + email?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["customer"][]; + 'application/json': { + data: components['schemas']['customer'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new customer object.

*/ PostCustomers: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["customer"]; - }; - }; + 'application/json': components['schemas']['customer'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The customer's address. */ address?: Partial<{ - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string }> & - Partial<"">; + Partial<''> /** @description An integer amount in %s that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice. */ - balance?: number; - coupon?: string; + balance?: number + coupon?: string /** @description An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard. */ - description?: string; + description?: string /** @description Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers. */ - invoice_prefix?: string; + invoice_prefix?: string /** * customer_param * @description Default invoice settings for this customer. @@ -22486,139 +22293,138 @@ export type operations = { invoice_settings?: { custom_fields?: Partial< { - name: string; - value: string; + name: string + value: string }[] > & - Partial<"">; - default_payment_method?: string; - footer?: string; - }; + Partial<''> + default_payment_method?: string + footer?: string + } /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The customer's full name or business name. */ - name?: string; + name?: string /** @description The sequence to be used on the customer's next invoice. Defaults to 1. */ - next_invoice_sequence?: number; - payment_method?: string; + next_invoice_sequence?: number + payment_method?: string /** @description The customer's phone number. */ - phone?: string; + phone?: string /** @description Customer's preferred languages, ordered by preference. */ - preferred_locales?: string[]; + preferred_locales?: string[] /** @description The API ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount. */ - promotion_code?: string; + promotion_code?: string /** @description The customer's shipping information. Appears on invoices emailed to this customer. */ shipping?: Partial<{ /** optional_fields_address */ address: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - name: string; - phone?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + name: string + phone?: string }> & - Partial<"">; - source?: string; + Partial<''> + source?: string /** * tax_param * @description Tax details about the customer. */ tax?: { - ip_address?: Partial & Partial<"">; - }; + ip_address?: Partial & Partial<''> + } /** * @description The customer's tax exemption. One of `none`, `exempt`, or `reverse`. * @enum {string} */ - tax_exempt?: "" | "exempt" | "none" | "reverse"; + tax_exempt?: '' | 'exempt' | 'none' | 'reverse' /** @description The customer's tax IDs. */ tax_id_data?: { /** @enum {string} */ type: - | "ae_trn" - | "au_abn" - | "au_arn" - | "br_cnpj" - | "br_cpf" - | "ca_bn" - | "ca_gst_hst" - | "ca_pst_bc" - | "ca_pst_mb" - | "ca_pst_sk" - | "ca_qst" - | "ch_vat" - | "cl_tin" - | "es_cif" - | "eu_vat" - | "gb_vat" - | "ge_vat" - | "hk_br" - | "id_npwp" - | "il_vat" - | "in_gst" - | "is_vat" - | "jp_cn" - | "jp_rn" - | "kr_brn" - | "li_uid" - | "mx_rfc" - | "my_frp" - | "my_itn" - | "my_sst" - | "no_vat" - | "nz_gst" - | "ru_inn" - | "ru_kpp" - | "sa_vat" - | "sg_gst" - | "sg_uen" - | "th_vat" - | "tw_vat" - | "ua_vat" - | "us_ein" - | "za_vat"; - value: string; - }[]; - }; - }; - }; - }; + | 'ae_trn' + | 'au_abn' + | 'au_arn' + | 'br_cnpj' + | 'br_cpf' + | 'ca_bn' + | 'ca_gst_hst' + | 'ca_pst_bc' + | 'ca_pst_mb' + | 'ca_pst_sk' + | 'ca_qst' + | 'ch_vat' + | 'cl_tin' + | 'es_cif' + | 'eu_vat' + | 'gb_vat' + | 'ge_vat' + | 'hk_br' + | 'id_npwp' + | 'il_vat' + | 'in_gst' + | 'is_vat' + | 'jp_cn' + | 'jp_rn' + | 'kr_brn' + | 'li_uid' + | 'mx_rfc' + | 'my_frp' + | 'my_itn' + | 'my_sst' + | 'no_vat' + | 'nz_gst' + | 'ru_inn' + | 'ru_kpp' + | 'sa_vat' + | 'sg_gst' + | 'sg_uen' + | 'th_vat' + | 'tw_vat' + | 'ua_vat' + | 'us_ein' + | 'za_vat' + value: string + }[] + } + } + } + } /**

Retrieves a Customer object.

*/ GetCustomersCustomer: { parameters: { path: { - customer: string; - }; + customer: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": Partial & - Partial; - }; - }; + 'application/json': Partial & Partial + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the source parameter, that becomes the customer’s active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the source parameter: for each of the customer’s current subscriptions, if the subscription bills automatically and is in the past_due state, then the latest open invoice for the subscription with automatic collection enabled will be retried. This retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice. Changing the default_source for a customer will not trigger this behavior.

* @@ -22627,76 +22433,76 @@ export type operations = { PostCustomersCustomer: { parameters: { path: { - customer: string; - }; - }; + customer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["customer"]; - }; - }; + 'application/json': components['schemas']['customer'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The customer's address. */ address?: Partial<{ - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string }> & - Partial<"">; + Partial<''> /** @description An integer amount in %s that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice. */ - balance?: number; + balance?: number /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ bank_account?: Partial<{ - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; - country: string; - currency?: string; + account_holder_type?: 'company' | 'individual' + account_number: string + country: string + currency?: string /** @enum {string} */ - object?: "bank_account"; - routing_number?: string; + object?: 'bank_account' + routing_number?: string }> & - Partial; + Partial /** @description A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js). */ card?: Partial<{ - address_city?: string; - address_country?: string; - address_line1?: string; - address_line2?: string; - address_state?: string; - address_zip?: string; - cvc?: string; - exp_month: number; - exp_year: number; - metadata?: { [key: string]: string }; - name?: string; - number: string; + address_city?: string + address_country?: string + address_line1?: string + address_line2?: string + address_state?: string + address_zip?: string + cvc?: string + exp_month: number + exp_year: number + metadata?: { [key: string]: string } + name?: string + number: string /** @enum {string} */ - object?: "card"; + object?: 'card' }> & - Partial; - coupon?: string; + Partial + coupon?: string /** @description ID of Alipay account to make the customer's new default for invoice payments. */ - default_alipay_account?: string; + default_alipay_account?: string /** @description ID of bank account to make the customer's new default for invoice payments. */ - default_bank_account?: string; + default_bank_account?: string /** @description ID of card to make the customer's new default for invoice payments. */ - default_card?: string; + default_card?: string /** * @description If you are using payment methods created via the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method) parameter. * @@ -22704,15 +22510,15 @@ export type operations = { * * If you want to add a new payment source and make it the default, see the [source](https://stripe.com/docs/api/customers/update#update_customer-source) property. */ - default_source?: string; + default_source?: string /** @description An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard. */ - description?: string; + description?: string /** @description Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers. */ - invoice_prefix?: string; + invoice_prefix?: string /** * customer_param * @description Default invoice settings for this customer. @@ -22720,290 +22526,290 @@ export type operations = { invoice_settings?: { custom_fields?: Partial< { - name: string; - value: string; + name: string + value: string }[] > & - Partial<"">; - default_payment_method?: string; - footer?: string; - }; + Partial<''> + default_payment_method?: string + footer?: string + } /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The customer's full name or business name. */ - name?: string; + name?: string /** @description The sequence to be used on the customer's next invoice. Defaults to 1. */ - next_invoice_sequence?: number; + next_invoice_sequence?: number /** @description The customer's phone number. */ - phone?: string; + phone?: string /** @description Customer's preferred languages, ordered by preference. */ - preferred_locales?: string[]; + preferred_locales?: string[] /** @description The API ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount. */ - promotion_code?: string; + promotion_code?: string /** @description The customer's shipping information. Appears on invoices emailed to this customer. */ shipping?: Partial<{ /** optional_fields_address */ address: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - name: string; - phone?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + name: string + phone?: string }> & - Partial<"">; - source?: string; + Partial<''> + source?: string /** * tax_param * @description Tax details about the customer. */ tax?: { - ip_address?: Partial & Partial<"">; - }; + ip_address?: Partial & Partial<''> + } /** * @description The customer's tax exemption. One of `none`, `exempt`, or `reverse`. * @enum {string} */ - tax_exempt?: "" | "exempt" | "none" | "reverse"; + tax_exempt?: '' | 'exempt' | 'none' | 'reverse' /** @description Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. */ - trial_end?: Partial<"now"> & Partial; - }; - }; - }; - }; + trial_end?: Partial<'now'> & Partial + } + } + } + } /**

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

*/ DeleteCustomersCustomer: { parameters: { path: { - customer: string; - }; - }; + customer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_customer"]; - }; - }; + 'application/json': components['schemas']['deleted_customer'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ GetCustomersCustomerBalanceTransactions: { parameters: { path: { - customer: string; - }; + customer: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["customer_balance_transaction"][]; + data: components['schemas']['customer_balance_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostCustomersCustomerBalanceTransactions: { parameters: { path: { - customer: string; - }; - }; + customer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["customer_balance_transaction"]; - }; - }; + 'application/json': components['schemas']['customer_balance_transaction'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The integer amount in **%s** to apply to the customer's credit balance. */ - amount: number; + amount: number /** @description 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 the customer's [`currency`](https://stripe.com/docs/api/customers/object#customer_object-currency) is set, this value must match it. If the customer's `currency` is not set, it will be updated to this value. */ - currency: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

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

*/ GetCustomersCustomerBalanceTransactionsTransaction: { parameters: { path: { - customer: string; - transaction: string; - }; + customer: string + transaction: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["customer_balance_transaction"]; - }; - }; + 'application/json': components['schemas']['customer_balance_transaction'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostCustomersCustomerBalanceTransactionsTransaction: { parameters: { path: { - customer: string; - transaction: string; - }; - }; + customer: string + transaction: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["customer_balance_transaction"]; - }; - }; + 'application/json': components['schemas']['customer_balance_transaction'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

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.

*/ GetCustomersCustomerBankAccounts: { parameters: { path: { - customer: string; - }; + customer: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["bank_account"][]; + data: components['schemas']['bank_account'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

When you create a new credit card, you must specify a customer or recipient on which to create it.

* @@ -23014,241 +22820,240 @@ export type operations = { PostCustomersCustomerBankAccounts: { parameters: { path: { - customer: string; - }; - }; + customer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_source"]; - }; - }; + 'application/json': components['schemas']['payment_source'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A token returned by [Stripe.js](https://stripe.com/docs/js) representing the user’s Alipay account details. */ - alipay_account?: string; + alipay_account?: string /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ bank_account?: Partial<{ - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; - country: string; - currency?: string; + account_holder_type?: 'company' | 'individual' + account_number: string + country: string + currency?: string /** @enum {string} */ - object?: "bank_account"; - routing_number?: string; + object?: 'bank_account' + routing_number?: string }> & - Partial; + Partial /** @description A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js). */ card?: Partial<{ - address_city?: string; - address_country?: string; - address_line1?: string; - address_line2?: string; - address_state?: string; - address_zip?: string; - cvc?: string; - exp_month: number; - exp_year: number; - metadata?: { [key: string]: string }; - name?: string; - number: string; + address_city?: string + address_country?: string + address_line1?: string + address_line2?: string + address_state?: string + address_zip?: string + cvc?: string + exp_month: number + exp_year: number + metadata?: { [key: string]: string } + name?: string + number: string /** @enum {string} */ - object?: "card"; + object?: 'card' }> & - Partial; + Partial /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - source?: string; - }; - }; - }; - }; + source?: string + } + } + } + } /**

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.

*/ GetCustomersCustomerBankAccountsId: { parameters: { path: { - customer: string; - id: string; - }; + customer: string + id: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["bank_account"]; - }; - }; + 'application/json': components['schemas']['bank_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Update a specified source for a given customer.

*/ PostCustomersCustomerBankAccountsId: { parameters: { path: { - customer: string; - id: string; - }; - }; + customer: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": Partial & - Partial & - Partial; - }; - }; + 'application/json': Partial & + Partial & + Partial + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The name of the person or business that owns the bank account. */ - account_holder_name?: string; + account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - account_holder_type?: "company" | "individual"; + account_holder_type?: 'company' | 'individual' /** @description City/District/Suburb/Town/Village. */ - address_city?: string; + address_city?: string /** @description Billing address country, if provided when creating card. */ - address_country?: string; + address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - address_line1?: string; + address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - address_line2?: string; + address_line2?: string /** @description State/County/Province/Region. */ - address_state?: string; + address_state?: string /** @description ZIP or postal code. */ - address_zip?: string; + address_zip?: string /** @description Two digit number representing the card’s expiration month. */ - exp_month?: string; + exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - exp_year?: string; + exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Cardholder name. */ - name?: string; + name?: string /** owner */ owner?: { /** source_address */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - email?: string; - name?: string; - phone?: string; - }; - }; - }; - }; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + email?: string + name?: string + phone?: string + } + } + } + } + } /**

Delete a specified source for a given customer.

*/ DeleteCustomersCustomerBankAccountsId: { parameters: { path: { - customer: string; - id: string; - }; - }; + customer: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": Partial & - Partial; - }; - }; + 'application/json': Partial & Partial + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Verify a specified bank account for a given customer.

*/ PostCustomersCustomerBankAccountsIdVerify: { parameters: { path: { - customer: string; - id: string; - }; - }; + customer: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["bank_account"]; - }; - }; + 'application/json': components['schemas']['bank_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account. */ - amounts?: number[]; + amounts?: number[] /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /** *

You can see a list of the cards belonging to a customer. * Note that the 10 most recent sources are always available on the Customer object. @@ -23257,50 +23062,50 @@ export type operations = { GetCustomersCustomerCards: { parameters: { path: { - customer: string; - }; + customer: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["card"][]; + 'application/json': { + data: components['schemas']['card'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

When you create a new credit card, you must specify a customer or recipient on which to create it.

* @@ -23311,389 +23116,388 @@ export type operations = { PostCustomersCustomerCards: { parameters: { path: { - customer: string; - }; - }; + customer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_source"]; - }; - }; + 'application/json': components['schemas']['payment_source'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A token returned by [Stripe.js](https://stripe.com/docs/js) representing the user’s Alipay account details. */ - alipay_account?: string; + alipay_account?: string /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ bank_account?: Partial<{ - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; - country: string; - currency?: string; + account_holder_type?: 'company' | 'individual' + account_number: string + country: string + currency?: string /** @enum {string} */ - object?: "bank_account"; - routing_number?: string; + object?: 'bank_account' + routing_number?: string }> & - Partial; + Partial /** @description A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js). */ card?: Partial<{ - address_city?: string; - address_country?: string; - address_line1?: string; - address_line2?: string; - address_state?: string; - address_zip?: string; - cvc?: string; - exp_month: number; - exp_year: number; - metadata?: { [key: string]: string }; - name?: string; - number: string; + address_city?: string + address_country?: string + address_line1?: string + address_line2?: string + address_state?: string + address_zip?: string + cvc?: string + exp_month: number + exp_year: number + metadata?: { [key: string]: string } + name?: string + number: string /** @enum {string} */ - object?: "card"; + object?: 'card' }> & - Partial; + Partial /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - source?: string; - }; - }; - }; - }; + source?: string + } + } + } + } /**

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.

*/ GetCustomersCustomerCardsId: { parameters: { path: { - customer: string; - id: string; - }; + customer: string + id: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["card"]; - }; - }; + 'application/json': components['schemas']['card'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Update a specified source for a given customer.

*/ PostCustomersCustomerCardsId: { parameters: { path: { - customer: string; - id: string; - }; - }; + customer: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": Partial & - Partial & - Partial; - }; - }; + 'application/json': Partial & + Partial & + Partial + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The name of the person or business that owns the bank account. */ - account_holder_name?: string; + account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - account_holder_type?: "company" | "individual"; + account_holder_type?: 'company' | 'individual' /** @description City/District/Suburb/Town/Village. */ - address_city?: string; + address_city?: string /** @description Billing address country, if provided when creating card. */ - address_country?: string; + address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - address_line1?: string; + address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - address_line2?: string; + address_line2?: string /** @description State/County/Province/Region. */ - address_state?: string; + address_state?: string /** @description ZIP or postal code. */ - address_zip?: string; + address_zip?: string /** @description Two digit number representing the card’s expiration month. */ - exp_month?: string; + exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - exp_year?: string; + exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Cardholder name. */ - name?: string; + name?: string /** owner */ owner?: { /** source_address */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - email?: string; - name?: string; - phone?: string; - }; - }; - }; - }; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + email?: string + name?: string + phone?: string + } + } + } + } + } /**

Delete a specified source for a given customer.

*/ DeleteCustomersCustomerCardsId: { parameters: { path: { - customer: string; - id: string; - }; - }; + customer: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": Partial & - Partial; - }; - }; + 'application/json': Partial & Partial + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } GetCustomersCustomerDiscount: { parameters: { path: { - customer: string; - }; + customer: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["discount"]; - }; - }; + 'application/json': components['schemas']['discount'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Removes the currently applied discount on a customer.

*/ DeleteCustomersCustomerDiscount: { parameters: { path: { - customer: string; - }; - }; + customer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_discount"]; - }; - }; + 'application/json': components['schemas']['deleted_discount'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of PaymentMethods for a given Customer

*/ GetCustomersCustomerPaymentMethods: { parameters: { path: { - customer: string; - }; + customer: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** A required filter on the list, based on the object `type` field. */ type: - | "acss_debit" - | "afterpay_clearpay" - | "alipay" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "eps" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "klarna" - | "oxxo" - | "p24" - | "sepa_debit" - | "sofort" - | "wechat_pay"; - }; - }; - responses: { - /** Successful response. */ - 200: { - content: { - "application/json": { - data: components["schemas"]["payment_method"][]; + | 'acss_debit' + | 'afterpay_clearpay' + | 'alipay' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'eps' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'klarna' + | 'oxxo' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' + } + } + responses: { + /** Successful response. */ + 200: { + content: { + 'application/json': { + data: components['schemas']['payment_method'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

List sources for a specified customer.

*/ GetCustomersCustomerSources: { parameters: { path: { - customer: string; - }; + customer: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Filter sources according to a particular object type. */ - object?: string; + object?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: (Partial & - Partial & - Partial & - Partial & - Partial)[]; + data: (Partial & + Partial & + Partial & + Partial & + Partial)[] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

When you create a new credit card, you must specify a customer or recipient on which to create it.

* @@ -23704,410 +23508,409 @@ export type operations = { PostCustomersCustomerSources: { parameters: { path: { - customer: string; - }; - }; + customer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_source"]; - }; - }; + 'application/json': components['schemas']['payment_source'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A token returned by [Stripe.js](https://stripe.com/docs/js) representing the user’s Alipay account details. */ - alipay_account?: string; + alipay_account?: string /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ bank_account?: Partial<{ - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; - country: string; - currency?: string; + account_holder_type?: 'company' | 'individual' + account_number: string + country: string + currency?: string /** @enum {string} */ - object?: "bank_account"; - routing_number?: string; + object?: 'bank_account' + routing_number?: string }> & - Partial; + Partial /** @description A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js). */ card?: Partial<{ - address_city?: string; - address_country?: string; - address_line1?: string; - address_line2?: string; - address_state?: string; - address_zip?: string; - cvc?: string; - exp_month: number; - exp_year: number; - metadata?: { [key: string]: string }; - name?: string; - number: string; + address_city?: string + address_country?: string + address_line1?: string + address_line2?: string + address_state?: string + address_zip?: string + cvc?: string + exp_month: number + exp_year: number + metadata?: { [key: string]: string } + name?: string + number: string /** @enum {string} */ - object?: "card"; + object?: 'card' }> & - Partial; + Partial /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - source?: string; - }; - }; - }; - }; + source?: string + } + } + } + } /**

Retrieve a specified source for a given customer.

*/ GetCustomersCustomerSourcesId: { parameters: { path: { - customer: string; - id: string; - }; + customer: string + id: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_source"]; - }; - }; + 'application/json': components['schemas']['payment_source'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Update a specified source for a given customer.

*/ PostCustomersCustomerSourcesId: { parameters: { path: { - customer: string; - id: string; - }; - }; + customer: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": Partial & - Partial & - Partial; - }; - }; + 'application/json': Partial & + Partial & + Partial + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The name of the person or business that owns the bank account. */ - account_holder_name?: string; + account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - account_holder_type?: "company" | "individual"; + account_holder_type?: 'company' | 'individual' /** @description City/District/Suburb/Town/Village. */ - address_city?: string; + address_city?: string /** @description Billing address country, if provided when creating card. */ - address_country?: string; + address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - address_line1?: string; + address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - address_line2?: string; + address_line2?: string /** @description State/County/Province/Region. */ - address_state?: string; + address_state?: string /** @description ZIP or postal code. */ - address_zip?: string; + address_zip?: string /** @description Two digit number representing the card’s expiration month. */ - exp_month?: string; + exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - exp_year?: string; + exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Cardholder name. */ - name?: string; + name?: string /** owner */ owner?: { /** source_address */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - email?: string; - name?: string; - phone?: string; - }; - }; - }; - }; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + email?: string + name?: string + phone?: string + } + } + } + } + } /**

Delete a specified source for a given customer.

*/ DeleteCustomersCustomerSourcesId: { parameters: { path: { - customer: string; - id: string; - }; - }; + customer: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": Partial & - Partial; - }; - }; + 'application/json': Partial & Partial + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Verify a specified bank account for a given customer.

*/ PostCustomersCustomerSourcesIdVerify: { parameters: { path: { - customer: string; - id: string; - }; - }; + customer: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["bank_account"]; - }; - }; + 'application/json': components['schemas']['bank_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account. */ - amounts?: number[]; + amounts?: number[] /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

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.

*/ GetCustomersCustomerSubscriptions: { parameters: { path: { - customer: string; - }; + customer: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["subscription"][]; + data: components['schemas']['subscription'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new subscription on an existing customer.

*/ PostCustomersCustomerSubscriptions: { parameters: { path: { - customer: string; - }; - }; + customer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription"]; - }; - }; + 'application/json': components['schemas']['subscription'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A list of prices and quantities that will generate invoice items appended to the first invoice for this subscription. You may pass up to 20 items. */ add_invoice_items?: { - price?: string; + price?: string /** one_time_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). */ - application_fee_percent?: number; + application_fee_percent?: number /** * automatic_tax_config * @description Automatic tax settings for this subscription. */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** * Format: unix-time * @description For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor. */ - backdate_start_date?: number; + backdate_start_date?: number /** * Format: unix-time * @description 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. */ - billing_cycle_anchor?: number; + billing_cycle_anchor?: number /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. */ billing_thresholds?: Partial<{ - amount_gte?: number; - reset_billing_cycle_anchor?: boolean; + amount_gte?: number + reset_billing_cycle_anchor?: boolean }> & - Partial<"">; + Partial<''> /** * Format: unix-time * @description 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. */ - cancel_at?: number; + cancel_at?: number /** @description Boolean indicating whether this subscription should cancel at the end of the current period. */ - cancel_at_period_end?: boolean; + cancel_at_period_end?: boolean /** * @description 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. Defaults to `charge_automatically`. * @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' /** @description The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. */ - coupon?: string; + coupon?: string /** @description Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. */ - days_until_due?: number; + days_until_due?: number /** @description 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?: string; + default_payment_method?: string /** @description 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?: string; + default_source?: string /** @description 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?: Partial & Partial<"">; + default_tax_rates?: Partial & Partial<''> /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A list of up to 20 subscription items, each with an attached price. */ items?: { billing_thresholds?: Partial<{ - usage_gte: number; + usage_gte: number }> & - Partial<"">; - metadata?: { [key: string]: string }; - price?: string; + Partial<''> + metadata?: { [key: string]: string } + price?: string /** recurring_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. */ - off_session?: boolean; + off_session?: boolean /** * @description Use `allow_incomplete` to create subscriptions with `status=incomplete` if the first invoice cannot be paid. Creating subscriptions with this status allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * @@ -24118,11 +23921,7 @@ export type operations = { * `pending_if_incomplete` is only used with updates and cannot be passed when creating a subscription. * @enum {string} */ - payment_behavior?: - | "allow_incomplete" - | "default_incomplete" - | "error_if_incomplete" - | "pending_if_incomplete"; + payment_behavior?: 'allow_incomplete' | 'default_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete' /** * payment_settings * @description Payment settings to pass to invoices created by the subscription. @@ -24134,241 +23933,241 @@ export type operations = { /** mandate_options_param */ mandate_options?: { /** @enum {string} */ - transaction_type?: "business" | "personal"; - }; + transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; + verification_method?: 'automatic' | 'instant' | 'microdeposits' }> & - Partial<"">; + Partial<''> bancontact?: Partial<{ /** @enum {string} */ - preferred_language?: "de" | "en" | "fr" | "nl"; + preferred_language?: 'de' | 'en' | 'fr' | 'nl' }> & - Partial<"">; + Partial<''> card?: Partial<{ /** mandate_options_param */ mandate_options?: { - amount?: number; + amount?: number /** @enum {string} */ - amount_type?: "fixed" | "maximum"; - description?: string; - }; + amount_type?: 'fixed' | 'maximum' + description?: string + } /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: 'any' | 'automatic' }> & - Partial<"">; - }; + Partial<''> + } payment_method_types?: Partial< ( - | "ach_credit_transfer" - | "ach_debit" - | "acss_debit" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "sepa_debit" - | "sofort" - | "wechat_pay" + | 'ach_credit_transfer' + | 'ach_debit' + | 'acss_debit' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' )[] > & - Partial<"">; - }; + Partial<''> + } /** @description 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?: Partial<{ /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number }> & - Partial<"">; + Partial<''> /** @description The API ID of a promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. */ - promotion_code?: string; + promotion_code?: string /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) resulting from the `billing_cycle_anchor`. Valid values are `create_prorations` or `none`. * * Passing `create_prorations` will cause proration invoice items to be created when applicable. Prorations can be disabled by passing `none`. If no value is passed, the default is `create_prorations`. * @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** * transfer_data_specs * @description If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. */ transfer_data?: { - amount_percent?: number; - destination: string; - }; + amount_percent?: number + destination: string + } /** @description Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. */ - trial_end?: Partial<"now"> & Partial; + trial_end?: Partial<'now'> & Partial /** @description 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?: boolean; + trial_from_plan?: boolean /** @description Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. */ - trial_period_days?: number; - }; - }; - }; - }; + trial_period_days?: number + } + } + } + } /**

Retrieves the subscription with the given ID.

*/ GetCustomersCustomerSubscriptionsSubscriptionExposedId: { parameters: { path: { - customer: string; - subscription_exposed_id: string; - }; + customer: string + subscription_exposed_id: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription"]; - }; - }; + 'application/json': components['schemas']['subscription'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostCustomersCustomerSubscriptionsSubscriptionExposedId: { parameters: { path: { - customer: string; - subscription_exposed_id: string; - }; - }; + customer: string + subscription_exposed_id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription"]; - }; - }; + 'application/json': components['schemas']['subscription'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A list of prices and quantities that will generate invoice items appended to the first invoice for this subscription. You may pass up to 20 items. */ add_invoice_items?: { - price?: string; + price?: string /** one_time_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). */ - application_fee_percent?: number; + application_fee_percent?: number /** * automatic_tax_config * @description Automatic tax settings for this subscription. */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** * @description Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). * @enum {string} */ - billing_cycle_anchor?: "now" | "unchanged"; + billing_cycle_anchor?: 'now' | 'unchanged' /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. */ billing_thresholds?: Partial<{ - amount_gte?: number; - reset_billing_cycle_anchor?: boolean; + amount_gte?: number + reset_billing_cycle_anchor?: boolean }> & - Partial<"">; + Partial<''> /** @description 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. */ - cancel_at?: Partial & Partial<"">; + cancel_at?: Partial & Partial<''> /** @description Boolean indicating whether this subscription should cancel at the end of the current period. */ - cancel_at_period_end?: boolean; + cancel_at_period_end?: boolean /** * @description 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. Defaults to `charge_automatically`. * @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' /** @description The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. */ - coupon?: string; + coupon?: string /** @description Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. */ - days_until_due?: number; + days_until_due?: number /** @description 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?: string; + default_payment_method?: string /** @description 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?: string; + default_source?: string /** @description 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. Pass an empty string to remove previously-defined tax rates. */ - default_tax_rates?: Partial & Partial<"">; + default_tax_rates?: Partial & Partial<''> /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A list of up to 20 subscription items, each with an attached price. */ items?: { billing_thresholds?: Partial<{ - usage_gte: number; + usage_gte: number }> & - Partial<"">; - clear_usage?: boolean; - deleted?: boolean; - id?: string; - metadata?: Partial<{ [key: string]: string }> & Partial<"">; - price?: string; + Partial<''> + clear_usage?: boolean + deleted?: boolean + id?: string + metadata?: Partial<{ [key: string]: string }> & Partial<''> + price?: string /** recurring_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. */ - off_session?: boolean; + off_session?: boolean /** @description If specified, payment collection for this subscription will be paused. */ pause_collection?: Partial<{ /** @enum {string} */ - behavior: "keep_as_draft" | "mark_uncollectible" | "void"; + behavior: 'keep_as_draft' | 'mark_uncollectible' | 'void' /** Format: unix-time */ - resumes_at?: number; + resumes_at?: number }> & - Partial<"">; + Partial<''> /** * @description Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * @@ -24379,11 +24178,7 @@ export type operations = { * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. * @enum {string} */ - payment_behavior?: - | "allow_incomplete" - | "default_incomplete" - | "error_if_incomplete" - | "pending_if_incomplete"; + payment_behavior?: 'allow_incomplete' | 'default_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete' /** * payment_settings * @description Payment settings to pass to invoices created by the subscription. @@ -24395,60 +24190,60 @@ export type operations = { /** mandate_options_param */ mandate_options?: { /** @enum {string} */ - transaction_type?: "business" | "personal"; - }; + transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; + verification_method?: 'automatic' | 'instant' | 'microdeposits' }> & - Partial<"">; + Partial<''> bancontact?: Partial<{ /** @enum {string} */ - preferred_language?: "de" | "en" | "fr" | "nl"; + preferred_language?: 'de' | 'en' | 'fr' | 'nl' }> & - Partial<"">; + Partial<''> card?: Partial<{ /** mandate_options_param */ mandate_options?: { - amount?: number; + amount?: number /** @enum {string} */ - amount_type?: "fixed" | "maximum"; - description?: string; - }; + amount_type?: 'fixed' | 'maximum' + description?: string + } /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: 'any' | 'automatic' }> & - Partial<"">; - }; + Partial<''> + } payment_method_types?: Partial< ( - | "ach_credit_transfer" - | "ach_debit" - | "acss_debit" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "sepa_debit" - | "sofort" - | "wechat_pay" + | 'ach_credit_transfer' + | 'ach_debit' + | 'acss_debit' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' )[] > & - Partial<"">; - }; + Partial<''> + } /** @description 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?: Partial<{ /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number }> & - Partial<"">; + Partial<''> /** @description The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. */ - promotion_code?: string; + promotion_code?: string /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -24457,26 +24252,26 @@ export type operations = { * Prorations can be disabled by passing `none`. * @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** * Format: unix-time * @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations. */ - proration_date?: number; + proration_date?: number /** @description If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. This will be unset if you POST an empty value. */ transfer_data?: Partial<{ - amount_percent?: number; - destination: string; + amount_percent?: number + destination: string }> & - Partial<"">; + Partial<''> /** @description Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. */ - trial_end?: Partial<"now"> & Partial; + trial_end?: Partial<'now'> & Partial /** @description 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?: boolean; - }; - }; - }; - }; + trial_from_plan?: boolean + } + } + } + } /** *

Cancels a customer’s subscription. If you set the at_period_end parameter to true, the subscription will remain active until the end of the period, at which point it will be canceled and not renewed. Otherwise, with the default false value, the subscription is terminated immediately. In either case, the customer will not be charged again for the subscription.

* @@ -24487,371 +24282,371 @@ export type operations = { DeleteCustomersCustomerSubscriptionsSubscriptionExposedId: { parameters: { path: { - customer: string; - subscription_exposed_id: string; - }; - }; + customer: string + subscription_exposed_id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription"]; - }; - }; + 'application/json': components['schemas']['subscription'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Can be set to `true` if `at_period_end` is not set to `true`. Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items. */ - invoice_now?: boolean; + invoice_now?: boolean /** @description Can be set to `true` if `at_period_end` is not set to `true`. Will generate a proration invoice item that credits remaining unused time until the subscription period end. */ - prorate?: boolean; - }; - }; - }; - }; + prorate?: boolean + } + } + } + } GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount: { parameters: { path: { - customer: string; - subscription_exposed_id: string; - }; + customer: string + subscription_exposed_id: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["discount"]; - }; - }; + 'application/json': components['schemas']['discount'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Removes the currently applied discount on a customer.

*/ DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount: { parameters: { path: { - customer: string; - subscription_exposed_id: string; - }; - }; + customer: string + subscription_exposed_id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_discount"]; - }; - }; + 'application/json': components['schemas']['deleted_discount'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of tax IDs for a customer.

*/ GetCustomersCustomerTaxIds: { parameters: { path: { - customer: string; - }; + customer: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["tax_id"][]; + data: components['schemas']['tax_id'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new TaxID object for a customer.

*/ PostCustomersCustomerTaxIds: { parameters: { path: { - customer: string; - }; - }; + customer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["tax_id"]; - }; - }; + 'application/json': components['schemas']['tax_id'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * @description Type of the tax ID, one of `ae_trn`, `au_abn`, `au_arn`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `es_cif`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `th_vat`, `tw_vat`, `ua_vat`, `us_ein`, or `za_vat` * @enum {string} */ type: - | "ae_trn" - | "au_abn" - | "au_arn" - | "br_cnpj" - | "br_cpf" - | "ca_bn" - | "ca_gst_hst" - | "ca_pst_bc" - | "ca_pst_mb" - | "ca_pst_sk" - | "ca_qst" - | "ch_vat" - | "cl_tin" - | "es_cif" - | "eu_vat" - | "gb_vat" - | "ge_vat" - | "hk_br" - | "id_npwp" - | "il_vat" - | "in_gst" - | "is_vat" - | "jp_cn" - | "jp_rn" - | "kr_brn" - | "li_uid" - | "mx_rfc" - | "my_frp" - | "my_itn" - | "my_sst" - | "no_vat" - | "nz_gst" - | "ru_inn" - | "ru_kpp" - | "sa_vat" - | "sg_gst" - | "sg_uen" - | "th_vat" - | "tw_vat" - | "ua_vat" - | "us_ein" - | "za_vat"; + | 'ae_trn' + | 'au_abn' + | 'au_arn' + | 'br_cnpj' + | 'br_cpf' + | 'ca_bn' + | 'ca_gst_hst' + | 'ca_pst_bc' + | 'ca_pst_mb' + | 'ca_pst_sk' + | 'ca_qst' + | 'ch_vat' + | 'cl_tin' + | 'es_cif' + | 'eu_vat' + | 'gb_vat' + | 'ge_vat' + | 'hk_br' + | 'id_npwp' + | 'il_vat' + | 'in_gst' + | 'is_vat' + | 'jp_cn' + | 'jp_rn' + | 'kr_brn' + | 'li_uid' + | 'mx_rfc' + | 'my_frp' + | 'my_itn' + | 'my_sst' + | 'no_vat' + | 'nz_gst' + | 'ru_inn' + | 'ru_kpp' + | 'sa_vat' + | 'sg_gst' + | 'sg_uen' + | 'th_vat' + | 'tw_vat' + | 'ua_vat' + | 'us_ein' + | 'za_vat' /** @description Value of the tax ID. */ - value: string; - }; - }; - }; - }; + value: string + } + } + } + } /**

Retrieves the TaxID object with the given identifier.

*/ GetCustomersCustomerTaxIdsId: { parameters: { path: { - customer: string; - id: string; - }; + customer: string + id: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["tax_id"]; - }; - }; + 'application/json': components['schemas']['tax_id'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Deletes an existing TaxID object.

*/ DeleteCustomersCustomerTaxIdsId: { parameters: { path: { - customer: string; - id: string; - }; - }; + customer: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_tax_id"]; - }; - }; + 'application/json': components['schemas']['deleted_tax_id'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of your disputes.

*/ GetDisputes: { parameters: { query: { /** Only return disputes associated to the charge specified by this charge ID. */ - charge?: string; + charge?: string created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return disputes associated to the PaymentIntent specified by this PaymentIntent ID. */ - payment_intent?: string; + payment_intent?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["dispute"][]; + 'application/json': { + data: components['schemas']['dispute'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves the dispute with the given ID.

*/ GetDisputesDispute: { parameters: { path: { - dispute: string; - }; + dispute: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["dispute"]; - }; - }; + 'application/json': components['schemas']['dispute'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

When you get a dispute, contacting your customer is always the best first step. If that doesn’t work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your dashboard, but if you prefer, you can use the API to submit evidence programmatically.

* @@ -24860,69 +24655,69 @@ export type operations = { PostDisputesDispute: { parameters: { path: { - dispute: string; - }; - }; + dispute: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["dispute"]; - }; - }; + 'application/json': components['schemas']['dispute'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * dispute_evidence_params * @description Evidence to upload, to respond to a dispute. Updating any field in the hash will submit all fields in the hash for review. The combined character count of all fields is limited to 150,000. */ evidence?: { - access_activity_log?: string; - billing_address?: string; - cancellation_policy?: string; - cancellation_policy_disclosure?: string; - cancellation_rebuttal?: string; - customer_communication?: string; - customer_email_address?: string; - customer_name?: string; - customer_purchase_ip?: string; - customer_signature?: string; - duplicate_charge_documentation?: string; - duplicate_charge_explanation?: string; - duplicate_charge_id?: string; - product_description?: string; - receipt?: string; - refund_policy?: string; - refund_policy_disclosure?: string; - refund_refusal_explanation?: string; - service_date?: string; - service_documentation?: string; - shipping_address?: string; - shipping_carrier?: string; - shipping_date?: string; - shipping_documentation?: string; - shipping_tracking_number?: string; - uncategorized_file?: string; - uncategorized_text?: string; - }; + access_activity_log?: string + billing_address?: string + cancellation_policy?: string + cancellation_policy_disclosure?: string + cancellation_rebuttal?: string + customer_communication?: string + customer_email_address?: string + customer_name?: string + customer_purchase_ip?: string + customer_signature?: string + duplicate_charge_documentation?: string + duplicate_charge_explanation?: string + duplicate_charge_id?: string + product_description?: string + receipt?: string + refund_policy?: string + refund_policy_disclosure?: string + refund_refusal_explanation?: string + service_date?: string + service_documentation?: string + shipping_address?: string + shipping_carrier?: string + shipping_date?: string + shipping_documentation?: string + shipping_tracking_number?: string + uncategorized_file?: string + uncategorized_text?: string + } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Whether to immediately submit evidence to the bank. If `false`, evidence is staged on the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank by making another request with this attribute set to `true` (the default). */ - submit?: boolean; - }; - }; - }; - }; + submit?: boolean + } + } + } + } /** *

Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.

* @@ -24931,479 +24726,479 @@ export type operations = { PostDisputesDisputeClose: { parameters: { path: { - dispute: string; - }; - }; + dispute: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["dispute"]; - }; - }; + 'application/json': components['schemas']['dispute'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

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

*/ PostEphemeralKeys: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["ephemeral_key"]; - }; - }; + 'application/json': components['schemas']['ephemeral_key'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The ID of the Customer you'd like to modify using the resulting ephemeral key. */ - customer?: string; + customer?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The ID of the Issuing Card you'd like to access using the resulting ephemeral key. */ - issuing_card?: string; - }; - }; - }; - }; + issuing_card?: string + } + } + } + } /**

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

*/ DeleteEphemeralKeysKey: { parameters: { path: { - key: string; - }; - }; + key: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["ephemeral_key"]; - }; - }; + 'application/json': components['schemas']['ephemeral_key'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

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).

*/ GetEvents: { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** 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?: boolean; + delivery_success?: boolean /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** 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?: string; + type?: string /** 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?: string[]; - }; - }; + types?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["event"][]; + 'application/json': { + data: components['schemas']['event'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.

*/ GetEventsId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["event"]; - }; - }; + 'application/json': components['schemas']['event'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ GetExchangeRates: { parameters: { query: { /** 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** 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?: number; + limit?: number /** 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["exchange_rate"][]; + 'application/json': { + data: components['schemas']['exchange_rate'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ GetExchangeRatesRateId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - rate_id: string; - }; - }; + rate_id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["exchange_rate"]; - }; - }; + 'application/json': components['schemas']['exchange_rate'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of file links.

*/ GetFileLinks: { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** Filter links by their expiration status. By default, all links are returned. */ - expired?: boolean; + expired?: boolean /** Only return links for the given file. */ - file?: string; + file?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["file_link"][]; + 'application/json': { + data: components['schemas']['file_link'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new file link object.

*/ PostFileLinks: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["file_link"]; - }; - }; + 'application/json': components['schemas']['file_link'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * Format: unix-time * @description A future timestamp after which the link will no longer be usable. */ - expires_at?: number; + expires_at?: number /** @description The ID of the file. The file's `purpose` must be one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `finance_report_run`, `identity_document_downloadable`, `pci_document`, `selfie`, `sigma_scheduled_query`, or `tax_document_user_upload`. */ - file: string; + file: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Retrieves the file link with the given ID.

*/ GetFileLinksLink: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - link: string; - }; - }; + link: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["file_link"]; - }; - }; + 'application/json': components['schemas']['file_link'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostFileLinksLink: { parameters: { path: { - link: string; - }; - }; + link: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["file_link"]; - }; - }; + 'application/json': components['schemas']['file_link'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A future timestamp after which the link will no longer be usable, or `now` to expire the link immediately. */ - expires_at?: Partial<"now"> & Partial & Partial<"">; + expires_at?: Partial<'now'> & Partial & Partial<''> /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Returns a list of the files that your account has access to. The files are returned sorted by creation date, with the most recently created files appearing first.

*/ GetFiles: { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** The file purpose to filter queries by. If none is provided, files will not be filtered by purpose. */ purpose?: - | "account_requirement" - | "additional_verification" - | "business_icon" - | "business_logo" - | "customer_signature" - | "dispute_evidence" - | "document_provider_identity_document" - | "finance_report_run" - | "identity_document" - | "identity_document_downloadable" - | "pci_document" - | "selfie" - | "sigma_scheduled_query" - | "tax_document_user_upload"; + | 'account_requirement' + | 'additional_verification' + | 'business_icon' + | 'business_logo' + | 'customer_signature' + | 'dispute_evidence' + | 'document_provider_identity_document' + | 'finance_report_run' + | 'identity_document' + | 'identity_document_downloadable' + | 'pci_document' + | 'selfie' + | 'sigma_scheduled_query' + | 'tax_document_user_upload' /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["file"][]; + 'application/json': { + data: components['schemas']['file'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

To upload a file to Stripe, you’ll need to send a request of type multipart/form-data. The request should contain the file you would like to upload, as well as the parameters for creating a file.

* @@ -25414,223 +25209,223 @@ export type operations = { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["file"]; - }; - }; + 'application/json': components['schemas']['file'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "multipart/form-data": { + 'multipart/form-data': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A file to upload. The file should follow the specifications of RFC 2388 (which defines file transfers for the `multipart/form-data` protocol). */ - file: string; + file: string /** * file_link_creation_params * @description Optional parameters to automatically create a [file link](https://stripe.com/docs/api#file_links) for the newly created file. */ file_link_data?: { - create: boolean; + create: boolean /** Format: unix-time */ - expires_at?: number; - metadata?: Partial<{ [key: string]: string }> & Partial<"">; - }; + expires_at?: number + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } /** * @description The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file. * @enum {string} */ purpose: - | "account_requirement" - | "additional_verification" - | "business_icon" - | "business_logo" - | "customer_signature" - | "dispute_evidence" - | "identity_document" - | "pci_document" - | "tax_document_user_upload"; - }; - }; - }; - }; + | 'account_requirement' + | 'additional_verification' + | 'business_icon' + | 'business_logo' + | 'customer_signature' + | 'dispute_evidence' + | 'identity_document' + | 'pci_document' + | 'tax_document_user_upload' + } + } + } + } /**

Retrieves the details of an existing file object. Supply the unique file ID from a file, and Stripe will return the corresponding file object. To access file contents, see the File Upload Guide.

*/ GetFilesFile: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - file: string; - }; - }; + file: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["file"]; - }; - }; + 'application/json': components['schemas']['file'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

List all verification reports.

*/ GetIdentityVerificationReports: { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return VerificationReports of this type */ - type?: "document" | "id_number"; + type?: 'document' | 'id_number' /** Only return VerificationReports created by this VerificationSession ID. It is allowed to provide a VerificationIntent ID. */ - verification_session?: string; - }; - }; + verification_session?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["identity.verification_report"][]; + 'application/json': { + data: components['schemas']['identity.verification_report'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves an existing VerificationReport

*/ GetIdentityVerificationReportsReport: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - report: string; - }; - }; + report: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["identity.verification_report"]; - }; - }; + 'application/json': components['schemas']['identity.verification_report'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of VerificationSessions

*/ GetIdentityVerificationSessions: { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return VerificationSessions with this status. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work). */ - status?: "canceled" | "processing" | "requires_input" | "verified"; - }; - }; + status?: 'canceled' | 'processing' | 'requires_input' | 'verified' + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["identity.verification_session"][]; + 'application/json': { + data: components['schemas']['identity.verification_session'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Creates a VerificationSession object.

* @@ -25645,47 +25440,47 @@ export type operations = { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["identity.verification_session"]; - }; - }; + 'application/json': components['schemas']['identity.verification_session'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * session_options_param * @description A set of options for the session’s verification checks. */ options?: { document?: Partial<{ - allowed_types?: ("driving_license" | "id_card" | "passport")[]; - require_id_number?: boolean; - require_live_capture?: boolean; - require_matching_selfie?: boolean; + allowed_types?: ('driving_license' | 'id_card' | 'passport')[] + require_id_number?: boolean + require_live_capture?: boolean + require_matching_selfie?: boolean }> & - Partial<"">; - }; + Partial<''> + } /** @description The URL that the user will be redirected to upon completing the verification flow. */ - return_url?: string; + return_url?: string /** * @description The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. * @enum {string} */ - type: "document" | "id_number"; - }; - }; - }; - }; + type: 'document' | 'id_number' + } + } + } + } /** *

Retrieves the details of a VerificationSession that was previously created.

* @@ -25696,32 +25491,32 @@ export type operations = { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - session: string; - }; - }; + session: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["identity.verification_session"]; - }; - }; + 'application/json': components['schemas']['identity.verification_session'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates a VerificationSession object.

* @@ -25731,52 +25526,52 @@ export type operations = { PostIdentityVerificationSessionsSession: { parameters: { path: { - session: string; - }; - }; + session: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["identity.verification_session"]; - }; - }; + 'application/json': components['schemas']['identity.verification_session'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * session_options_param * @description A set of options for the session’s verification checks. */ options?: { document?: Partial<{ - allowed_types?: ("driving_license" | "id_card" | "passport")[]; - require_id_number?: boolean; - require_live_capture?: boolean; - require_matching_selfie?: boolean; + allowed_types?: ('driving_license' | 'id_card' | 'passport')[] + require_id_number?: boolean + require_live_capture?: boolean + require_matching_selfie?: boolean }> & - Partial<"">; - }; + Partial<''> + } /** * @description The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. * @enum {string} */ - type?: "document" | "id_number"; - }; - }; - }; - }; + type?: 'document' | 'id_number' + } + } + } + } /** *

A VerificationSession object can be canceled when it is in requires_input status.

* @@ -25785,32 +25580,32 @@ export type operations = { PostIdentityVerificationSessionsSessionCancel: { parameters: { path: { - session: string; - }; - }; + session: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["identity.verification_session"]; - }; - }; + 'application/json': components['schemas']['identity.verification_session'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /** *

Redact a VerificationSession to remove all collected information from Stripe. This will redact * the VerificationSession and all objects related to it, including VerificationReports, Events, @@ -25835,460 +25630,460 @@ export type operations = { PostIdentityVerificationSessionsSessionRedact: { parameters: { path: { - session: string; - }; - }; + session: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["identity.verification_session"]; - }; - }; + 'application/json': components['schemas']['identity.verification_session'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

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

*/ GetInvoiceitems: { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** The identifier of the customer whose invoice items to return. If none is provided, all invoice items will be returned. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** 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?: string; + invoice?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** 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?: boolean; + pending?: boolean /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["invoiceitem"][]; + 'application/json': { + data: components['schemas']['invoiceitem'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostInvoiceitems: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoiceitem"]; - }; - }; + 'application/json': components['schemas']['invoiceitem'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The integer amount in %s of the charge to be applied to the upcoming invoice. Passing in a negative `amount` will reduce the `amount_due` on the invoice. */ - amount?: number; + amount?: number /** @description 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?: string; + currency?: string /** @description The ID of the customer who will be billed when this invoice item is billed. */ - customer: string; + customer: string /** @description An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking. */ - description?: string; + description?: string /** @description Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items. */ - discountable?: boolean; + discountable?: boolean /** @description The coupons to redeem into discounts for the invoice item or invoice line item. */ discounts?: Partial< { - coupon?: string; - discount?: string; + coupon?: string + discount?: string }[] > & - Partial<"">; + Partial<''> /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The ID of an existing invoice to add this invoice item to. When left blank, the invoice item will be added to the next upcoming scheduled invoice. This is useful when adding invoice items in response to an invoice.created webhook. You can only add invoice items to draft invoices and there is a maximum of 250 items per invoice. */ - invoice?: string; + invoice?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** * period * @description The period associated with this invoice item. */ period?: { /** Format: unix-time */ - end: number; + end: number /** Format: unix-time */ - start: number; - }; + start: number + } /** @description The ID of the price object. */ - price?: string; + price?: string /** * one_time_price_data * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; + unit_amount_decimal?: string + } /** @description Non-negative integer. The quantity of units for the invoice item. */ - quantity?: number; + quantity?: number /** @description The ID of a subscription to add this invoice item to. When left blank, the invoice item will be be added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription. */ - subscription?: string; + subscription?: string /** @description 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?: string[]; + tax_rates?: string[] /** @description The integer unit amount in %s of the charge to be applied to the upcoming invoice. This `unit_amount` will be multiplied by the quantity to get the full amount. Passing in a negative `unit_amount` will reduce the `amount_due` on the invoice. */ - unit_amount?: number; + unit_amount?: number /** * Format: decimal * @description Same as `unit_amount`, but accepts a decimal value in %s with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. */ - unit_amount_decimal?: string; - }; - }; - }; - }; + unit_amount_decimal?: string + } + } + } + } /**

Retrieves the invoice item with the given ID.

*/ GetInvoiceitemsInvoiceitem: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - invoiceitem: string; - }; - }; + invoiceitem: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoiceitem"]; - }; - }; + 'application/json': components['schemas']['invoiceitem'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostInvoiceitemsInvoiceitem: { parameters: { path: { - invoiceitem: string; - }; - }; + invoiceitem: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoiceitem"]; - }; - }; + 'application/json': components['schemas']['invoiceitem'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The integer amount in %s of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount. */ - amount?: number; + amount?: number /** @description An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking. */ - description?: string; + description?: string /** @description Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items. Cannot be set to true for prorations. */ - discountable?: boolean; + discountable?: boolean /** @description The coupons & existing discounts which apply to the invoice item or invoice line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts. */ discounts?: Partial< { - coupon?: string; - discount?: string; + coupon?: string + discount?: string }[] > & - Partial<"">; + Partial<''> /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** * period * @description The period associated with this invoice item. */ period?: { /** Format: unix-time */ - end: number; + end: number /** Format: unix-time */ - start: number; - }; + start: number + } /** @description The ID of the price object. */ - price?: string; + price?: string /** * one_time_price_data * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; + unit_amount_decimal?: string + } /** @description Non-negative integer. The quantity of units for the invoice item. */ - quantity?: number; + quantity?: number /** @description 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. Pass an empty string to remove previously-defined tax rates. */ - tax_rates?: Partial & Partial<"">; + tax_rates?: Partial & Partial<''> /** @description The integer unit amount in %s of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount. */ - unit_amount?: number; + unit_amount?: number /** * Format: decimal * @description Same as `unit_amount`, but accepts a decimal value in %s with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. */ - unit_amount_decimal?: string; - }; - }; - }; - }; + unit_amount_decimal?: string + } + } + } + } /**

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.

*/ DeleteInvoiceitemsInvoiceitem: { parameters: { path: { - invoiceitem: string; - }; - }; + invoiceitem: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_invoiceitem"]; - }; - }; + 'application/json': components['schemas']['deleted_invoiceitem'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ GetInvoices: { parameters: { query: { /** The collection method of the invoice to retrieve. Either `charge_automatically` or `send_invoice`. */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** Only return invoices for the customer specified by this customer ID. */ - customer?: string; + customer?: string due_date?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** 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?: "draft" | "open" | "paid" | "uncollectible" | "void"; + status?: 'draft' | 'open' | 'paid' | 'uncollectible' | 'void' /** Only return invoices for the subscription specified by this subscription ID. */ - subscription?: string; - }; - }; + subscription?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["invoice"][]; + 'application/json': { + data: components['schemas']['invoice'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

This endpoint creates a draft invoice for a given customer. The draft invoice created pulls in all pending invoice items on that customer, including prorations. The invoice remains a draft until you finalize the invoice, which allows you to pay or send the invoice to your customers.

*/ PostInvoices: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoice"]; - }; - }; + 'application/json': components['schemas']['invoice'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The account tax IDs associated with the invoice. Only editable when the invoice is a draft. */ - account_tax_ids?: Partial & Partial<"">; + account_tax_ids?: Partial & Partial<''> /** @description A fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees). */ - application_fee_amount?: number; + application_fee_amount?: number /** @description Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice. When `false`, the invoice's state will not automatically advance without an explicit action. */ - auto_advance?: boolean; + auto_advance?: boolean /** * automatic_tax_param * @description Settings for automatic tax lookup for this invoice. */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** * @description 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. Defaults to `charge_automatically`. * @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' /** @description A list of up to 4 custom fields to be displayed on the invoice. */ custom_fields?: Partial< { - name: string; - value: string; + name: string + value: string }[] > & - Partial<"">; + Partial<''> /** @description The ID of the customer who will be billed. */ - customer: string; + customer: string /** @description The number of days from when the invoice is created until it is due. Valid only for invoices where `collection_method=send_invoice`. */ - days_until_due?: number; + days_until_due?: number /** @description 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?: string; + default_payment_method?: string /** @description 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?: string; + default_source?: string /** @description The tax rates that will apply to any line item that does not have `tax_rates` set. */ - default_tax_rates?: string[]; + default_tax_rates?: string[] /** @description An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. */ - description?: string; + description?: string /** @description The coupons to redeem into discounts for the invoice. If not specified, inherits the discount from the invoice's customer. Pass an empty string to avoid inheriting any discounts. */ discounts?: Partial< { - coupon?: string; - discount?: string; + coupon?: string + discount?: string }[] > & - Partial<"">; + Partial<''> /** * Format: unix-time * @description The date on which payment for this invoice is due. Valid only for invoices where `collection_method=send_invoice`. */ - due_date?: number; + due_date?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Footer to be displayed on the invoice. */ - footer?: string; + footer?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description 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?: string; + on_behalf_of?: string /** * payment_settings * @description Configuration settings for the PaymentIntent that is generated when the invoice is finalized. @@ -26300,60 +26095,60 @@ export type operations = { /** mandate_options_param */ mandate_options?: { /** @enum {string} */ - transaction_type?: "business" | "personal"; - }; + transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; + verification_method?: 'automatic' | 'instant' | 'microdeposits' }> & - Partial<"">; + Partial<''> bancontact?: Partial<{ /** @enum {string} */ - preferred_language?: "de" | "en" | "fr" | "nl"; + preferred_language?: 'de' | 'en' | 'fr' | 'nl' }> & - Partial<"">; + Partial<''> card?: Partial<{ /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: 'any' | 'automatic' }> & - Partial<"">; - }; + Partial<''> + } payment_method_types?: Partial< ( - | "ach_credit_transfer" - | "ach_debit" - | "acss_debit" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "sepa_debit" - | "sofort" - | "wechat_pay" + | 'ach_credit_transfer' + | 'ach_debit' + | 'acss_debit' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' )[] > & - Partial<"">; - }; + Partial<''> + } /** @description Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description The ID of the subscription to invoice, if any. If not set, the created invoice will include all pending invoice items for the customer. If set, the created invoice will only include pending invoice items for that subscription and pending invoice items not associated with any subscription. The subscription's billing cycle and regular subscription events won't be affected. */ - subscription?: string; + subscription?: string /** * transfer_data_specs * @description If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge. */ transfer_data?: { - amount?: number; - destination: string; - }; - }; - }; - }; - }; + amount?: number + destination: string + } + } + } + } + } /** *

At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.

* @@ -26366,184 +26161,184 @@ export type operations = { query: { /** Settings for automatic tax lookup for this invoice preview. */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** The code of the coupon to apply. If `subscription` or `subscription_items` is provided, the invoice returned will preview updating or creating a subscription with that coupon. Otherwise, it will preview applying that coupon to the customer for the next upcoming invoice from among the customer's subscriptions. The invoice can be previewed without a coupon by passing this value as an empty string. */ - coupon?: string; + coupon?: string /** The identifier of the customer whose upcoming invoice you'd like to retrieve. */ - customer?: string; + customer?: string /** Details about the customer you want to invoice or overrides for an existing customer. */ customer_details?: { address?: Partial<{ - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string }> & - Partial<"">; + Partial<''> shipping?: Partial<{ /** optional_fields_address */ address: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - name: string; - phone?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + name: string + phone?: string }> & - Partial<"">; + Partial<''> /** tax_param */ tax?: { - ip_address?: Partial & Partial<"">; - }; + ip_address?: Partial & Partial<''> + } /** @enum {string} */ - tax_exempt?: "" | "exempt" | "none" | "reverse"; + tax_exempt?: '' | 'exempt' | 'none' | 'reverse' tax_ids?: { /** @enum {string} */ type: - | "ae_trn" - | "au_abn" - | "au_arn" - | "br_cnpj" - | "br_cpf" - | "ca_bn" - | "ca_gst_hst" - | "ca_pst_bc" - | "ca_pst_mb" - | "ca_pst_sk" - | "ca_qst" - | "ch_vat" - | "cl_tin" - | "es_cif" - | "eu_vat" - | "gb_vat" - | "ge_vat" - | "hk_br" - | "id_npwp" - | "il_vat" - | "in_gst" - | "is_vat" - | "jp_cn" - | "jp_rn" - | "kr_brn" - | "li_uid" - | "mx_rfc" - | "my_frp" - | "my_itn" - | "my_sst" - | "no_vat" - | "nz_gst" - | "ru_inn" - | "ru_kpp" - | "sa_vat" - | "sg_gst" - | "sg_uen" - | "th_vat" - | "tw_vat" - | "ua_vat" - | "us_ein" - | "za_vat"; - value: string; - }[]; - }; + | 'ae_trn' + | 'au_abn' + | 'au_arn' + | 'br_cnpj' + | 'br_cpf' + | 'ca_bn' + | 'ca_gst_hst' + | 'ca_pst_bc' + | 'ca_pst_mb' + | 'ca_pst_sk' + | 'ca_qst' + | 'ch_vat' + | 'cl_tin' + | 'es_cif' + | 'eu_vat' + | 'gb_vat' + | 'ge_vat' + | 'hk_br' + | 'id_npwp' + | 'il_vat' + | 'in_gst' + | 'is_vat' + | 'jp_cn' + | 'jp_rn' + | 'kr_brn' + | 'li_uid' + | 'mx_rfc' + | 'my_frp' + | 'my_itn' + | 'my_sst' + | 'no_vat' + | 'nz_gst' + | 'ru_inn' + | 'ru_kpp' + | 'sa_vat' + | 'sg_gst' + | 'sg_uen' + | 'th_vat' + | 'tw_vat' + | 'ua_vat' + | 'us_ein' + | 'za_vat' + value: string + }[] + } /** The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the customer or subscription. This only works for coupons directly applied to the invoice. To apply a coupon to a subscription, you must use the `coupon` parameter instead. Pass an empty string to avoid inheriting any discounts. To preview the upcoming invoice for a subscription that hasn't been created, use `coupon` instead. */ discounts?: Partial< { - coupon?: string; - discount?: string; + coupon?: string + discount?: string }[] > & - Partial<"">; + Partial<''> /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** List of invoice items to add or update in the upcoming invoice preview. */ invoice_items?: { - amount?: number; - currency?: string; - description?: string; - discountable?: boolean; + amount?: number + currency?: string + description?: string + discountable?: boolean discounts?: Partial< { - coupon?: string; - discount?: string; + coupon?: string + discount?: string }[] > & - Partial<"">; - invoiceitem?: string; - metadata?: Partial<{ [key: string]: string }> & Partial<"">; + Partial<''> + invoiceitem?: string + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** period */ period?: { /** Format: unix-time */ - end: number; + end: number /** Format: unix-time */ - start: number; - }; - price?: string; + start: number + } + price?: string /** one_time_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - unit_amount?: number; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }[]; + unit_amount_decimal?: string + }[] /** The identifier of the unstarted schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields. */ - schedule?: string; + schedule?: string /** The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions. */ - subscription?: string; + subscription?: string /** 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`. */ - subscription_billing_cycle_anchor?: Partial<"now" | "unchanged"> & Partial; + subscription_billing_cycle_anchor?: Partial<'now' | 'unchanged'> & Partial /** Timestamp indicating when the subscription should be scheduled to cancel. Will prorate if within the current period and prorations have been enabled using `proration_behavior`. */ - subscription_cancel_at?: Partial & Partial<"">; + subscription_cancel_at?: Partial & Partial<''> /** Boolean indicating whether this subscription should cancel at the end of the current period. */ - subscription_cancel_at_period_end?: boolean; + subscription_cancel_at_period_end?: boolean /** This simulates the subscription being canceled or expired immediately. */ - subscription_cancel_now?: boolean; + subscription_cancel_now?: boolean /** 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. */ - subscription_default_tax_rates?: Partial & Partial<"">; + subscription_default_tax_rates?: Partial & Partial<''> /** A list of up to 20 subscription items, each with an attached price. */ subscription_items?: { billing_thresholds?: Partial<{ - usage_gte: number; + usage_gte: number }> & - Partial<"">; - clear_usage?: boolean; - deleted?: boolean; - id?: string; - metadata?: Partial<{ [key: string]: string }> & Partial<"">; - price?: string; + Partial<''> + clear_usage?: boolean + deleted?: boolean + id?: string + metadata?: Partial<{ [key: string]: string }> & Partial<''> + price?: string /** recurring_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] /** * Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -26551,227 +26346,227 @@ export type operations = { * * Prorations can be disabled by passing `none`. */ - subscription_proration_behavior?: "always_invoice" | "create_prorations" | "none"; + subscription_proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** 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 cannot be before the subscription was on its current plan. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'. */ - subscription_proration_date?: number; + subscription_proration_date?: number /** Date a subscription is intended to start (can be future or past) */ - subscription_start_date?: number; + subscription_start_date?: number /** 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. */ - subscription_trial_end?: Partial<"now"> & Partial; + subscription_trial_end?: Partial<'now'> & Partial /** Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `subscription_trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `subscription_trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. */ - subscription_trial_from_plan?: boolean; - }; - }; + subscription_trial_from_plan?: boolean + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoice"]; - }; - }; + 'application/json': components['schemas']['invoice'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ GetInvoicesUpcomingLines: { parameters: { query: { /** Settings for automatic tax lookup for this invoice preview. */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** The code of the coupon to apply. If `subscription` or `subscription_items` is provided, the invoice returned will preview updating or creating a subscription with that coupon. Otherwise, it will preview applying that coupon to the customer for the next upcoming invoice from among the customer's subscriptions. The invoice can be previewed without a coupon by passing this value as an empty string. */ - coupon?: string; + coupon?: string /** The identifier of the customer whose upcoming invoice you'd like to retrieve. */ - customer?: string; + customer?: string /** Details about the customer you want to invoice or overrides for an existing customer. */ customer_details?: { address?: Partial<{ - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string }> & - Partial<"">; + Partial<''> shipping?: Partial<{ /** optional_fields_address */ address: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - name: string; - phone?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + name: string + phone?: string }> & - Partial<"">; + Partial<''> /** tax_param */ tax?: { - ip_address?: Partial & Partial<"">; - }; + ip_address?: Partial & Partial<''> + } /** @enum {string} */ - tax_exempt?: "" | "exempt" | "none" | "reverse"; + tax_exempt?: '' | 'exempt' | 'none' | 'reverse' tax_ids?: { /** @enum {string} */ type: - | "ae_trn" - | "au_abn" - | "au_arn" - | "br_cnpj" - | "br_cpf" - | "ca_bn" - | "ca_gst_hst" - | "ca_pst_bc" - | "ca_pst_mb" - | "ca_pst_sk" - | "ca_qst" - | "ch_vat" - | "cl_tin" - | "es_cif" - | "eu_vat" - | "gb_vat" - | "ge_vat" - | "hk_br" - | "id_npwp" - | "il_vat" - | "in_gst" - | "is_vat" - | "jp_cn" - | "jp_rn" - | "kr_brn" - | "li_uid" - | "mx_rfc" - | "my_frp" - | "my_itn" - | "my_sst" - | "no_vat" - | "nz_gst" - | "ru_inn" - | "ru_kpp" - | "sa_vat" - | "sg_gst" - | "sg_uen" - | "th_vat" - | "tw_vat" - | "ua_vat" - | "us_ein" - | "za_vat"; - value: string; - }[]; - }; + | 'ae_trn' + | 'au_abn' + | 'au_arn' + | 'br_cnpj' + | 'br_cpf' + | 'ca_bn' + | 'ca_gst_hst' + | 'ca_pst_bc' + | 'ca_pst_mb' + | 'ca_pst_sk' + | 'ca_qst' + | 'ch_vat' + | 'cl_tin' + | 'es_cif' + | 'eu_vat' + | 'gb_vat' + | 'ge_vat' + | 'hk_br' + | 'id_npwp' + | 'il_vat' + | 'in_gst' + | 'is_vat' + | 'jp_cn' + | 'jp_rn' + | 'kr_brn' + | 'li_uid' + | 'mx_rfc' + | 'my_frp' + | 'my_itn' + | 'my_sst' + | 'no_vat' + | 'nz_gst' + | 'ru_inn' + | 'ru_kpp' + | 'sa_vat' + | 'sg_gst' + | 'sg_uen' + | 'th_vat' + | 'tw_vat' + | 'ua_vat' + | 'us_ein' + | 'za_vat' + value: string + }[] + } /** The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the customer or subscription. This only works for coupons directly applied to the invoice. To apply a coupon to a subscription, you must use the `coupon` parameter instead. Pass an empty string to avoid inheriting any discounts. To preview the upcoming invoice for a subscription that hasn't been created, use `coupon` instead. */ discounts?: Partial< { - coupon?: string; - discount?: string; + coupon?: string + discount?: string }[] > & - Partial<"">; + Partial<''> /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** List of invoice items to add or update in the upcoming invoice preview. */ invoice_items?: { - amount?: number; - currency?: string; - description?: string; - discountable?: boolean; + amount?: number + currency?: string + description?: string + discountable?: boolean discounts?: Partial< { - coupon?: string; - discount?: string; + coupon?: string + discount?: string }[] > & - Partial<"">; - invoiceitem?: string; - metadata?: Partial<{ [key: string]: string }> & Partial<"">; + Partial<''> + invoiceitem?: string + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** period */ period?: { /** Format: unix-time */ - end: number; + end: number /** Format: unix-time */ - start: number; - }; - price?: string; + start: number + } + price?: string /** one_time_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - unit_amount?: number; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }[]; + unit_amount_decimal?: string + }[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** The identifier of the unstarted schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields. */ - schedule?: string; + schedule?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions. */ - subscription?: string; + subscription?: string /** 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`. */ - subscription_billing_cycle_anchor?: Partial<"now" | "unchanged"> & Partial; + subscription_billing_cycle_anchor?: Partial<'now' | 'unchanged'> & Partial /** Timestamp indicating when the subscription should be scheduled to cancel. Will prorate if within the current period and prorations have been enabled using `proration_behavior`. */ - subscription_cancel_at?: Partial & Partial<"">; + subscription_cancel_at?: Partial & Partial<''> /** Boolean indicating whether this subscription should cancel at the end of the current period. */ - subscription_cancel_at_period_end?: boolean; + subscription_cancel_at_period_end?: boolean /** This simulates the subscription being canceled or expired immediately. */ - subscription_cancel_now?: boolean; + subscription_cancel_now?: boolean /** 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. */ - subscription_default_tax_rates?: Partial & Partial<"">; + subscription_default_tax_rates?: Partial & Partial<''> /** A list of up to 20 subscription items, each with an attached price. */ subscription_items?: { billing_thresholds?: Partial<{ - usage_gte: number; + usage_gte: number }> & - Partial<"">; - clear_usage?: boolean; - deleted?: boolean; - id?: string; - metadata?: Partial<{ [key: string]: string }> & Partial<"">; - price?: string; + Partial<''> + clear_usage?: boolean + deleted?: boolean + id?: string + metadata?: Partial<{ [key: string]: string }> & Partial<''> + price?: string /** recurring_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] /** * Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -26779,80 +26574,80 @@ export type operations = { * * Prorations can be disabled by passing `none`. */ - subscription_proration_behavior?: "always_invoice" | "create_prorations" | "none"; + subscription_proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** 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 cannot be before the subscription was on its current plan. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'. */ - subscription_proration_date?: number; + subscription_proration_date?: number /** Date a subscription is intended to start (can be future or past) */ - subscription_start_date?: number; + subscription_start_date?: number /** 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. */ - subscription_trial_end?: Partial<"now"> & Partial; + subscription_trial_end?: Partial<'now'> & Partial /** Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `subscription_trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `subscription_trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. */ - subscription_trial_from_plan?: boolean; - }; - }; + subscription_trial_from_plan?: boolean + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["line_item"][]; + data: components['schemas']['line_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves the invoice with the given ID.

*/ GetInvoicesInvoice: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - invoice: string; - }; - }; + invoice: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoice"]; - }; - }; + 'application/json': components['schemas']['invoice'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Draft invoices are fully editable. Once an invoice is finalized, * monetary values, as well as collection_method, become uneditable.

@@ -26864,83 +26659,83 @@ export type operations = { PostInvoicesInvoice: { parameters: { path: { - invoice: string; - }; - }; + invoice: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoice"]; - }; - }; + 'application/json': components['schemas']['invoice'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The account tax IDs associated with the invoice. Only editable when the invoice is a draft. */ - account_tax_ids?: Partial & Partial<"">; + account_tax_ids?: Partial & Partial<''> /** @description A fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees). */ - application_fee_amount?: number; + application_fee_amount?: number /** @description Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice. */ - auto_advance?: boolean; + auto_advance?: boolean /** * automatic_tax_param * @description Settings for automatic tax lookup for this invoice. */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** * @description Either `charge_automatically` or `send_invoice`. This field can be updated only on `draft` invoices. * @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' /** @description A list of up to 4 custom fields to be displayed on the invoice. If a value for `custom_fields` is specified, the list specified will replace the existing custom field list on this invoice. Pass an empty string to remove previously-defined fields. */ custom_fields?: Partial< { - name: string; - value: string; + name: string + value: string }[] > & - Partial<"">; + Partial<''> /** @description The number of days from which the invoice is created until it is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices. */ - days_until_due?: number; + days_until_due?: number /** @description 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?: string; + default_payment_method?: string /** @description 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?: string; + default_source?: string /** @description The tax rates that will apply to any line item that does not have `tax_rates` set. Pass an empty string to remove previously-defined tax rates. */ - default_tax_rates?: Partial & Partial<"">; + default_tax_rates?: Partial & Partial<''> /** @description An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. */ - description?: string; + description?: string /** @description The discounts that will apply to the invoice. Pass an empty string to remove previously-defined discounts. */ discounts?: Partial< { - coupon?: string; - discount?: string; + coupon?: string + discount?: string }[] > & - Partial<"">; + Partial<''> /** * Format: unix-time * @description The date on which payment for this invoice is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices. */ - due_date?: number; + due_date?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Footer to be displayed on the invoice. */ - footer?: string; + footer?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description 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?: Partial & Partial<"">; + on_behalf_of?: Partial & Partial<''> /** * payment_settings * @description Configuration settings for the PaymentIntent that is generated when the invoice is finalized. @@ -26952,238 +26747,238 @@ export type operations = { /** mandate_options_param */ mandate_options?: { /** @enum {string} */ - transaction_type?: "business" | "personal"; - }; + transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; + verification_method?: 'automatic' | 'instant' | 'microdeposits' }> & - Partial<"">; + Partial<''> bancontact?: Partial<{ /** @enum {string} */ - preferred_language?: "de" | "en" | "fr" | "nl"; + preferred_language?: 'de' | 'en' | 'fr' | 'nl' }> & - Partial<"">; + Partial<''> card?: Partial<{ /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: 'any' | 'automatic' }> & - Partial<"">; - }; + Partial<''> + } payment_method_types?: Partial< ( - | "ach_credit_transfer" - | "ach_debit" - | "acss_debit" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "sepa_debit" - | "sofort" - | "wechat_pay" + | 'ach_credit_transfer' + | 'ach_debit' + | 'acss_debit' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' )[] > & - Partial<"">; - }; + Partial<''> + } /** @description Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge. This will be unset if you POST an empty value. */ transfer_data?: Partial<{ - amount?: number; - destination: string; + amount?: number + destination: string }> & - Partial<"">; - }; - }; - }; - }; + Partial<''> + } + } + } + } /**

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.

*/ DeleteInvoicesInvoice: { parameters: { path: { - invoice: string; - }; - }; + invoice: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_invoice"]; - }; - }; + 'application/json': components['schemas']['deleted_invoice'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostInvoicesInvoiceFinalize: { parameters: { path: { - invoice: string; - }; - }; + invoice: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoice"]; - }; - }; + 'application/json': components['schemas']['invoice'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/invoicing/automatic-charging) of the invoice. When `false`, the invoice's state will not automatically advance without an explicit action. */ - auto_advance?: boolean; + auto_advance?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

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.

*/ GetInvoicesInvoiceLines: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - invoice: string; - }; - }; + invoice: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["line_item"][]; + data: components['schemas']['line_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostInvoicesInvoiceMarkUncollectible: { parameters: { path: { - invoice: string; - }; - }; + invoice: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoice"]; - }; - }; + 'application/json': components['schemas']['invoice'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

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.

*/ PostInvoicesInvoicePay: { parameters: { path: { - invoice: string; - }; - }; + invoice: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoice"]; - }; - }; + 'application/json': components['schemas']['invoice'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * @description In cases where the source used to pay the invoice has insufficient funds, passing `forgive=true` controls whether a charge should be attempted for the full amount available on the source, up to the amount to fully pay the invoice. This effectively forgives the difference between the amount available on the source and the amount due. * * Passing `forgive=false` will fail the charge if the source hasn't been pre-funded with the right amount. An example for this case is with ACH Credit Transfers and wires: if the amount wired is less than the amount due by a small amount, you might want to forgive the difference. Defaults to `false`. */ - forgive?: boolean; + forgive?: boolean /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `true` (off-session). */ - off_session?: boolean; + off_session?: boolean /** @description Boolean representing whether an invoice is paid outside of Stripe. This will result in no charge being made. Defaults to `false`. */ - paid_out_of_band?: boolean; + paid_out_of_band?: boolean /** @description A PaymentMethod to be charged. The PaymentMethod must be the ID of a PaymentMethod belonging to the customer associated with the invoice being paid. */ - payment_method?: string; + payment_method?: string /** @description A payment source to be charged. The source must be the ID of a source belonging to the customer associated with the invoice being paid. */ - source?: string; - }; - }; - }; - }; + source?: string + } + } + } + } /** *

Stripe will automatically send invoices to customers according to your subscriptions settings. However, if you’d like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.

* @@ -27192,109 +26987,109 @@ export type operations = { PostInvoicesInvoiceSend: { parameters: { path: { - invoice: string; - }; - }; + invoice: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoice"]; - }; - }; + 'application/json': components['schemas']['invoice'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.

*/ PostInvoicesInvoiceVoid: { parameters: { path: { - invoice: string; - }; - }; + invoice: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoice"]; - }; - }; + 'application/json': components['schemas']['invoice'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Returns a list of issuer fraud records.

*/ GetIssuerFraudRecords: { parameters: { query: { /** Only return issuer fraud records for the charge specified by this charge ID. */ - charge?: string; + charge?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["issuer_fraud_record"][]; + 'application/json': { + data: components['schemas']['issuer_fraud_record'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Retrieves the details of an issuer fraud record that has previously been created.

* @@ -27304,300 +27099,300 @@ export type operations = { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - issuer_fraud_record: string; - }; - }; + issuer_fraud_record: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuer_fraud_record"]; - }; - }; + 'application/json': components['schemas']['issuer_fraud_record'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ GetIssuingAuthorizations: { parameters: { query: { /** Only return authorizations that belong to the given card. */ - card?: string; + card?: string /** Only return authorizations that belong to the given cardholder. */ - cardholder?: string; + cardholder?: string /** Only return authorizations that were created during the given date interval. */ created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return authorizations with the given status. One of `pending`, `closed`, or `reversed`. */ - status?: "closed" | "pending" | "reversed"; - }; - }; + status?: 'closed' | 'pending' | 'reversed' + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["issuing.authorization"][]; + 'application/json': { + data: components['schemas']['issuing.authorization'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves an Issuing Authorization object.

*/ GetIssuingAuthorizationsAuthorization: { parameters: { path: { - authorization: string; - }; + authorization: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.authorization"]; - }; - }; + 'application/json': components['schemas']['issuing.authorization'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostIssuingAuthorizationsAuthorization: { parameters: { path: { - authorization: string; - }; - }; + authorization: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.authorization"]; - }; - }; + 'application/json': components['schemas']['issuing.authorization'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Approves a pending Issuing Authorization object. This request should be made within the timeout window of the real-time authorization flow.

*/ PostIssuingAuthorizationsAuthorizationApprove: { parameters: { path: { - authorization: string; - }; - }; + authorization: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.authorization"]; - }; - }; + 'application/json': components['schemas']['issuing.authorization'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description If the authorization's `pending_request.is_amount_controllable` property is `true`, you may provide this value to control how much to hold for the authorization. Must be positive (use [`decline`](https://stripe.com/docs/api/issuing/authorizations/decline) to decline an authorization request). */ - amount?: number; + amount?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Declines a pending Issuing Authorization object. This request should be made within the timeout window of the real time authorization flow.

*/ PostIssuingAuthorizationsAuthorizationDecline: { parameters: { path: { - authorization: string; - }; - }; + authorization: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.authorization"]; - }; - }; + 'application/json': components['schemas']['issuing.authorization'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

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

*/ GetIssuingCardholders: { parameters: { query: { /** Only return cardholders that were created during the given date interval. */ created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** Only return cardholders that have the given email address. */ - email?: string; + email?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return cardholders that have the given phone number. */ - phone_number?: string; + phone_number?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return cardholders that have the given status. One of `active`, `inactive`, or `blocked`. */ - status?: "active" | "blocked" | "inactive"; + status?: 'active' | 'blocked' | 'inactive' /** Only return cardholders that have the given type. One of `individual` or `company`. */ - type?: "company" | "individual"; - }; - }; + type?: 'company' | 'individual' + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["issuing.cardholder"][]; + 'application/json': { + data: components['schemas']['issuing.cardholder'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostIssuingCardholders: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.cardholder"]; - }; - }; + 'application/json': components['schemas']['issuing.cardholder'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * billing_specs * @description The cardholder's billing address. @@ -27605,25 +27400,25 @@ export type operations = { billing: { /** required_address */ address: { - city: string; - country: string; - line1: string; - line2?: string; - postal_code: string; - state?: string; - }; - }; + city: string + country: string + line1: string + line2?: string + postal_code: string + state?: string + } + } /** * company_param * @description Additional information about a `company` cardholder. */ company?: { - tax_id?: string; - }; + tax_id?: string + } /** @description The cardholder's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * individual_param * @description Additional information about an `individual` cardholder. @@ -27631,978 +27426,978 @@ export type operations = { individual?: { /** date_of_birth_specs */ dob?: { - day: number; - month: number; - year: number; - }; - first_name: string; - last_name: string; + day: number + month: number + year: number + } + first_name: string + last_name: string /** person_verification_param */ verification?: { /** person_verification_document_param */ document?: { - back?: string; - front?: string; - }; - }; - }; + back?: string + front?: string + } + } + } /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The cardholder's name. This will be printed on cards issued to them. The maximum length of this field is 24 characters. */ - name: string; + name: string /** @description The cardholder's phone number. This will be transformed to [E.164](https://en.wikipedia.org/wiki/E.164) if it is not provided in that format already. 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?: string; + phone_number?: string /** * authorization_controls_param_v2 * @description 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?: { allowed_categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] blocked_categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] spending_limits?: { - amount: number; + amount: number categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] /** @enum {string} */ - interval: "all_time" | "daily" | "monthly" | "per_authorization" | "weekly" | "yearly"; - }[]; - spending_limits_currency?: string; - }; + interval: 'all_time' | 'daily' | 'monthly' | 'per_authorization' | 'weekly' | 'yearly' + }[] + spending_limits_currency?: string + } /** * @description Specifies whether to permit authorizations on this cardholder's cards. Defaults to `active`. * @enum {string} */ - status?: "active" | "inactive"; + status?: 'active' | 'inactive' /** * @description One of `individual` or `company`. * @enum {string} */ - type: "company" | "individual"; - }; - }; - }; - }; + type: 'company' | 'individual' + } + } + } + } /**

Retrieves an Issuing Cardholder object.

*/ GetIssuingCardholdersCardholder: { parameters: { path: { - cardholder: string; - }; + cardholder: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.cardholder"]; - }; - }; + 'application/json': components['schemas']['issuing.cardholder'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostIssuingCardholdersCardholder: { parameters: { path: { - cardholder: string; - }; - }; + cardholder: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.cardholder"]; - }; - }; + 'application/json': components['schemas']['issuing.cardholder'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * billing_specs * @description The cardholder's billing address. @@ -28610,25 +28405,25 @@ export type operations = { billing?: { /** required_address */ address: { - city: string; - country: string; - line1: string; - line2?: string; - postal_code: string; - state?: string; - }; - }; + city: string + country: string + line1: string + line2?: string + postal_code: string + state?: string + } + } /** * company_param * @description Additional information about a `company` cardholder. */ company?: { - tax_id?: string; - }; + tax_id?: string + } /** @description The cardholder's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * individual_param * @description Additional information about an `individual` cardholder. @@ -28636,1015 +28431,1015 @@ export type operations = { individual?: { /** date_of_birth_specs */ dob?: { - day: number; - month: number; - year: number; - }; - first_name: string; - last_name: string; + day: number + month: number + year: number + } + first_name: string + last_name: string /** person_verification_param */ verification?: { /** person_verification_document_param */ document?: { - back?: string; - front?: string; - }; - }; - }; + back?: string + front?: string + } + } + } /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description 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) for more details. */ - phone_number?: string; + phone_number?: string /** * authorization_controls_param_v2 * @description 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?: { allowed_categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] blocked_categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] spending_limits?: { - amount: number; + amount: number categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] /** @enum {string} */ - interval: "all_time" | "daily" | "monthly" | "per_authorization" | "weekly" | "yearly"; - }[]; - spending_limits_currency?: string; - }; + interval: 'all_time' | 'daily' | 'monthly' | 'per_authorization' | 'weekly' | 'yearly' + }[] + spending_limits_currency?: string + } /** * @description Specifies whether to permit authorizations on this cardholder's cards. * @enum {string} */ - status?: "active" | "inactive"; - }; - }; - }; - }; + status?: 'active' | 'inactive' + } + } + } + } /**

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

*/ GetIssuingCards: { parameters: { query: { /** Only return cards belonging to the Cardholder with the provided ID. */ - cardholder?: string; + cardholder?: string /** Only return cards that were issued during the given date interval. */ created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Only return cards that have the given expiration month. */ - exp_month?: number; + exp_month?: number /** Only return cards that have the given expiration year. */ - exp_year?: number; + exp_year?: number /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** Only return cards that have the given last four digits. */ - last4?: string; + last4?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return cards that have the given status. One of `active`, `inactive`, or `canceled`. */ - status?: "active" | "canceled" | "inactive"; + status?: 'active' | 'canceled' | 'inactive' /** Only return cards that have the given type. One of `virtual` or `physical`. */ - type?: "physical" | "virtual"; - }; - }; + type?: 'physical' | 'virtual' + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["issuing.card"][]; + 'application/json': { + data: components['schemas']['issuing.card'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates an Issuing Card object.

*/ PostIssuingCards: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.card"]; - }; - }; + 'application/json': components['schemas']['issuing.card'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The [Cardholder](https://stripe.com/docs/api#issuing_cardholder_object) object with which the card will be associated. */ - cardholder?: string; + cardholder?: string /** @description The currency for the card. */ - currency: string; + currency: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The card this is meant to be a replacement for (if any). */ - replacement_for?: string; + replacement_for?: string /** * @description If `replacement_for` is specified, this should indicate why that card is being replaced. * @enum {string} */ - replacement_reason?: "damaged" | "expired" | "lost" | "stolen"; + replacement_reason?: 'damaged' | 'expired' | 'lost' | 'stolen' /** * shipping_specs * @description The address where the card will be shipped. @@ -29652,2702 +29447,2688 @@ export type operations = { shipping?: { /** required_address */ address: { - city: string; - country: string; - line1: string; - line2?: string; - postal_code: string; - state?: string; - }; - name: string; + city: string + country: string + line1: string + line2?: string + postal_code: string + state?: string + } + name: string /** @enum {string} */ - service?: "express" | "priority" | "standard"; + service?: 'express' | 'priority' | 'standard' /** @enum {string} */ - type?: "bulk" | "individual"; - }; + type?: 'bulk' | 'individual' + } /** * authorization_controls_param * @description Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details. */ spending_controls?: { allowed_categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] blocked_categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] spending_limits?: { - amount: number; + amount: number categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] /** @enum {string} */ - interval: "all_time" | "daily" | "monthly" | "per_authorization" | "weekly" | "yearly"; - }[]; - }; + interval: 'all_time' | 'daily' | 'monthly' | 'per_authorization' | 'weekly' | 'yearly' + }[] + } /** * @description Whether authorizations can be approved on this card. Defaults to `inactive`. * @enum {string} */ - status?: "active" | "inactive"; + status?: 'active' | 'inactive' /** * @description The type of card to issue. Possible values are `physical` or `virtual`. * @enum {string} */ - type: "physical" | "virtual"; - }; - }; - }; - }; + type: 'physical' | 'virtual' + } + } + } + } /**

Retrieves an Issuing Card object.

*/ GetIssuingCardsCard: { parameters: { path: { - card: string; - }; + card: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.card"]; - }; - }; + 'application/json': components['schemas']['issuing.card'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostIssuingCardsCard: { parameters: { path: { - card: string; - }; - }; + card: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.card"]; - }; - }; + 'application/json': components['schemas']['issuing.card'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * @description Reason why the `status` of this card is `canceled`. * @enum {string} */ - cancellation_reason?: "lost" | "stolen"; + cancellation_reason?: 'lost' | 'stolen' /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** * encrypted_pin_param * @description The desired new PIN for this card. */ pin?: { - encrypted_number?: string; - }; + encrypted_number?: string + } /** * authorization_controls_param * @description Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details. */ spending_controls?: { allowed_categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] blocked_categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] spending_limits?: { - amount: number; + amount: number categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] /** @enum {string} */ - interval: "all_time" | "daily" | "monthly" | "per_authorization" | "weekly" | "yearly"; - }[]; - }; + interval: 'all_time' | 'daily' | 'monthly' | 'per_authorization' | 'weekly' | 'yearly' + }[] + } /** * @description Dictates whether authorizations can be approved on this card. If this card is being canceled because it was lost or stolen, this information should be provided as `cancellation_reason`. * @enum {string} */ - status?: "active" | "canceled" | "inactive"; - }; - }; - }; - }; + status?: 'active' | 'canceled' | 'inactive' + } + } + } + } /**

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

*/ GetIssuingDisputes: { parameters: { query: { /** Select Issuing disputes that were created during the given date interval. */ created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Select Issuing disputes with the given status. */ - status?: "expired" | "lost" | "submitted" | "unsubmitted" | "won"; + status?: 'expired' | 'lost' | 'submitted' | 'unsubmitted' | 'won' /** Select the Issuing dispute for the given transaction. */ - transaction?: string; - }; - }; + transaction?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["issuing.dispute"][]; + 'application/json': { + data: components['schemas']['issuing.dispute'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostIssuingDisputes: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.dispute"]; - }; - }; + 'application/json': components['schemas']['issuing.dispute'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * evidence_param * @description Evidence provided for the dispute. */ evidence?: { canceled?: Partial<{ - additional_documentation?: Partial & Partial<"">; - canceled_at?: Partial & Partial<"">; - cancellation_policy_provided?: Partial & Partial<"">; - cancellation_reason?: string; - expected_at?: Partial & Partial<"">; - explanation?: string; - product_description?: string; + additional_documentation?: Partial & Partial<''> + canceled_at?: Partial & Partial<''> + cancellation_policy_provided?: Partial & Partial<''> + cancellation_reason?: string + expected_at?: Partial & Partial<''> + explanation?: string + product_description?: string /** @enum {string} */ - product_type?: "" | "merchandise" | "service"; + product_type?: '' | 'merchandise' | 'service' /** @enum {string} */ - return_status?: "" | "merchant_rejected" | "successful"; - returned_at?: Partial & Partial<"">; + return_status?: '' | 'merchant_rejected' | 'successful' + returned_at?: Partial & Partial<''> }> & - Partial<"">; + Partial<''> duplicate?: Partial<{ - additional_documentation?: Partial & Partial<"">; - card_statement?: Partial & Partial<"">; - cash_receipt?: Partial & Partial<"">; - check_image?: Partial & Partial<"">; - explanation?: string; - original_transaction?: string; + additional_documentation?: Partial & Partial<''> + card_statement?: Partial & Partial<''> + cash_receipt?: Partial & Partial<''> + check_image?: Partial & Partial<''> + explanation?: string + original_transaction?: string }> & - Partial<"">; + Partial<''> fraudulent?: Partial<{ - additional_documentation?: Partial & Partial<"">; - explanation?: string; + additional_documentation?: Partial & Partial<''> + explanation?: string }> & - Partial<"">; + Partial<''> merchandise_not_as_described?: Partial<{ - additional_documentation?: Partial & Partial<"">; - explanation?: string; - received_at?: Partial & Partial<"">; - return_description?: string; + additional_documentation?: Partial & Partial<''> + explanation?: string + received_at?: Partial & Partial<''> + return_description?: string /** @enum {string} */ - return_status?: "" | "merchant_rejected" | "successful"; - returned_at?: Partial & Partial<"">; + return_status?: '' | 'merchant_rejected' | 'successful' + returned_at?: Partial & Partial<''> }> & - Partial<"">; + Partial<''> not_received?: Partial<{ - additional_documentation?: Partial & Partial<"">; - expected_at?: Partial & Partial<"">; - explanation?: string; - product_description?: string; + additional_documentation?: Partial & Partial<''> + expected_at?: Partial & Partial<''> + explanation?: string + product_description?: string /** @enum {string} */ - product_type?: "" | "merchandise" | "service"; + product_type?: '' | 'merchandise' | 'service' }> & - Partial<"">; + Partial<''> other?: Partial<{ - additional_documentation?: Partial & Partial<"">; - explanation?: string; - product_description?: string; + additional_documentation?: Partial & Partial<''> + explanation?: string + product_description?: string /** @enum {string} */ - product_type?: "" | "merchandise" | "service"; + product_type?: '' | 'merchandise' | 'service' }> & - Partial<"">; + Partial<''> /** @enum {string} */ - reason?: - | "canceled" - | "duplicate" - | "fraudulent" - | "merchandise_not_as_described" - | "not_received" - | "other" - | "service_not_as_described"; + reason?: 'canceled' | 'duplicate' | 'fraudulent' | 'merchandise_not_as_described' | 'not_received' | 'other' | 'service_not_as_described' service_not_as_described?: Partial<{ - additional_documentation?: Partial & Partial<"">; - canceled_at?: Partial & Partial<"">; - cancellation_reason?: string; - explanation?: string; - received_at?: Partial & Partial<"">; + additional_documentation?: Partial & Partial<''> + canceled_at?: Partial & Partial<''> + cancellation_reason?: string + explanation?: string + received_at?: Partial & Partial<''> }> & - Partial<"">; - }; + Partial<''> + } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The ID of the issuing transaction to create a dispute for. */ - transaction: string; - }; - }; - }; - }; + transaction: string + } + } + } + } /**

Retrieves an Issuing Dispute object.

*/ GetIssuingDisputesDispute: { parameters: { path: { - dispute: string; - }; + dispute: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.dispute"]; - }; - }; + 'application/json': components['schemas']['issuing.dispute'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostIssuingDisputesDispute: { parameters: { path: { - dispute: string; - }; - }; + dispute: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.dispute"]; - }; - }; + 'application/json': components['schemas']['issuing.dispute'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * evidence_param * @description Evidence provided for the dispute. */ evidence?: { canceled?: Partial<{ - additional_documentation?: Partial & Partial<"">; - canceled_at?: Partial & Partial<"">; - cancellation_policy_provided?: Partial & Partial<"">; - cancellation_reason?: string; - expected_at?: Partial & Partial<"">; - explanation?: string; - product_description?: string; + additional_documentation?: Partial & Partial<''> + canceled_at?: Partial & Partial<''> + cancellation_policy_provided?: Partial & Partial<''> + cancellation_reason?: string + expected_at?: Partial & Partial<''> + explanation?: string + product_description?: string /** @enum {string} */ - product_type?: "" | "merchandise" | "service"; + product_type?: '' | 'merchandise' | 'service' /** @enum {string} */ - return_status?: "" | "merchant_rejected" | "successful"; - returned_at?: Partial & Partial<"">; + return_status?: '' | 'merchant_rejected' | 'successful' + returned_at?: Partial & Partial<''> }> & - Partial<"">; + Partial<''> duplicate?: Partial<{ - additional_documentation?: Partial & Partial<"">; - card_statement?: Partial & Partial<"">; - cash_receipt?: Partial & Partial<"">; - check_image?: Partial & Partial<"">; - explanation?: string; - original_transaction?: string; + additional_documentation?: Partial & Partial<''> + card_statement?: Partial & Partial<''> + cash_receipt?: Partial & Partial<''> + check_image?: Partial & Partial<''> + explanation?: string + original_transaction?: string }> & - Partial<"">; + Partial<''> fraudulent?: Partial<{ - additional_documentation?: Partial & Partial<"">; - explanation?: string; + additional_documentation?: Partial & Partial<''> + explanation?: string }> & - Partial<"">; + Partial<''> merchandise_not_as_described?: Partial<{ - additional_documentation?: Partial & Partial<"">; - explanation?: string; - received_at?: Partial & Partial<"">; - return_description?: string; + additional_documentation?: Partial & Partial<''> + explanation?: string + received_at?: Partial & Partial<''> + return_description?: string /** @enum {string} */ - return_status?: "" | "merchant_rejected" | "successful"; - returned_at?: Partial & Partial<"">; + return_status?: '' | 'merchant_rejected' | 'successful' + returned_at?: Partial & Partial<''> }> & - Partial<"">; + Partial<''> not_received?: Partial<{ - additional_documentation?: Partial & Partial<"">; - expected_at?: Partial & Partial<"">; - explanation?: string; - product_description?: string; + additional_documentation?: Partial & Partial<''> + expected_at?: Partial & Partial<''> + explanation?: string + product_description?: string /** @enum {string} */ - product_type?: "" | "merchandise" | "service"; + product_type?: '' | 'merchandise' | 'service' }> & - Partial<"">; + Partial<''> other?: Partial<{ - additional_documentation?: Partial & Partial<"">; - explanation?: string; - product_description?: string; + additional_documentation?: Partial & Partial<''> + explanation?: string + product_description?: string /** @enum {string} */ - product_type?: "" | "merchandise" | "service"; + product_type?: '' | 'merchandise' | 'service' }> & - Partial<"">; + Partial<''> /** @enum {string} */ - reason?: - | "canceled" - | "duplicate" - | "fraudulent" - | "merchandise_not_as_described" - | "not_received" - | "other" - | "service_not_as_described"; + reason?: 'canceled' | 'duplicate' | 'fraudulent' | 'merchandise_not_as_described' | 'not_received' | 'other' | 'service_not_as_described' service_not_as_described?: Partial<{ - additional_documentation?: Partial & Partial<"">; - canceled_at?: Partial & Partial<"">; - cancellation_reason?: string; - explanation?: string; - received_at?: Partial & Partial<"">; + additional_documentation?: Partial & Partial<''> + canceled_at?: Partial & Partial<''> + cancellation_reason?: string + explanation?: string + received_at?: Partial & Partial<''> }> & - Partial<"">; - }; + Partial<''> + } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

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.

*/ PostIssuingDisputesDisputeSubmit: { parameters: { path: { - dispute: string; - }; - }; + dispute: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.dispute"]; - }; - }; + 'application/json': components['schemas']['issuing.dispute'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

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

*/ GetIssuingSettlements: { parameters: { query: { /** Only return issuing settlements that were created during the given date interval. */ created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["issuing.settlement"][]; + 'application/json': { + data: components['schemas']['issuing.settlement'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves an Issuing Settlement object.

*/ GetIssuingSettlementsSettlement: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - settlement: string; - }; - }; + settlement: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.settlement"]; - }; - }; + 'application/json': components['schemas']['issuing.settlement'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostIssuingSettlementsSettlement: { parameters: { path: { - settlement: string; - }; - }; + settlement: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.settlement"]; - }; - }; + 'application/json': components['schemas']['issuing.settlement'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; - }; - }; - }; - }; + metadata?: { [key: string]: string } + } + } + } + } /**

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.

*/ GetIssuingTransactions: { parameters: { query: { /** Only return transactions that belong to the given card. */ - card?: string; + card?: string /** Only return transactions that belong to the given cardholder. */ - cardholder?: string; + cardholder?: string /** Only return transactions that were created during the given date interval. */ created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return transactions that have the given type. One of `capture` or `refund`. */ - type?: "capture" | "refund"; - }; - }; + type?: 'capture' | 'refund' + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["issuing.transaction"][]; + 'application/json': { + data: components['schemas']['issuing.transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves an Issuing Transaction object.

*/ GetIssuingTransactionsTransaction: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - transaction: string; - }; - }; + transaction: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.transaction"]; - }; - }; + 'application/json': components['schemas']['issuing.transaction'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostIssuingTransactionsTransaction: { parameters: { path: { - transaction: string; - }; - }; + transaction: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.transaction"]; - }; - }; + 'application/json': components['schemas']['issuing.transaction'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Retrieves a Mandate object.

*/ GetMandatesMandate: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - mandate: string; - }; - }; + mandate: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["mandate"]; - }; - }; + 'application/json': components['schemas']['mandate'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ GetOrderReturns: { parameters: { query: { /** Date this return was created. */ created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** The order to retrieve returns for. */ - order?: string; + order?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["order_return"][]; + 'application/json': { + data: components['schemas']['order_return'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ GetOrderReturnsId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["order_return"]; - }; - }; + 'application/json': components['schemas']['order_return'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ GetOrders: { parameters: { query: { /** Date this order was created. */ created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** Only return orders for the given customer. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** Only return orders with the given IDs. */ - ids?: string[]; + ids?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return orders that have the given status. One of `created`, `paid`, `fulfilled`, or `refunded`. */ - status?: string; + status?: string /** Filter orders based on when they were paid, fulfilled, canceled, or returned. */ status_transitions?: { canceled?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial fulfilled?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial paid?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial returned?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; - }; + Partial + } /** Only return orders with the given upstream order IDs. */ - upstream_ids?: string[]; - }; - }; + upstream_ids?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["order"][]; + 'application/json': { + data: components['schemas']['order'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new order object.

*/ PostOrders: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["order"]; - }; - }; + 'application/json': components['schemas']['order'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A coupon code that represents a discount to be applied to this order. Must be one-time duration and in same currency as the order. An order can have multiple coupons. */ - coupon?: string; + coupon?: string /** @description 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: string; + currency: string /** @description The ID of an existing customer to use for this order. If provided, the customer email and shipping address will be used to create the order. Subsequently, the customer will also be charged to pay the order. If `email` or `shipping` are also provided, they will override the values retrieved from the customer object. */ - customer?: string; + customer?: string /** @description The email address of the customer placing the order. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description List of items constituting the order. An order can have up to 25 items. */ items?: { - amount?: number; - currency?: string; - description?: string; - parent?: string; - quantity?: number; + amount?: number + currency?: string + description?: string + parent?: string + quantity?: number /** @enum {string} */ - type?: "discount" | "shipping" | "sku" | "tax"; - }[]; + type?: 'discount' | 'shipping' | 'sku' | 'tax' + }[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * customer_shipping * @description Shipping address for the order. Required if any of the SKUs are for products that have `shippable` set to true. @@ -32355,237 +32136,237 @@ export type operations = { shipping?: { /** optional_fields_address */ address: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - name: string; - phone?: string; - }; - }; - }; - }; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + name: string + phone?: string + } + } + } + } + } /**

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

*/ GetOrdersId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["order"]; - }; - }; + 'application/json': components['schemas']['order'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostOrdersId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["order"]; - }; - }; + 'application/json': components['schemas']['order'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A coupon code that represents a discount to be applied to this order. Must be one-time duration and in same currency as the order. An order can have multiple coupons. */ - coupon?: string; + coupon?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The shipping method to select for fulfilling this order. If specified, must be one of the `id`s of a shipping method in the `shipping_methods` array. If specified, will overwrite the existing selected shipping method, updating `items` as necessary. */ - selected_shipping_method?: string; + selected_shipping_method?: string /** * shipping_tracking_params * @description Tracking information once the order has been fulfilled. */ shipping?: { - carrier: string; - tracking_number: string; - }; + carrier: string + tracking_number: string + } /** * @description Current order status. One of `created`, `paid`, `canceled`, `fulfilled`, or `returned`. More detail in the [Orders Guide](https://stripe.com/docs/orders/guide#understanding-order-statuses). * @enum {string} */ - status?: "canceled" | "created" | "fulfilled" | "paid" | "returned"; - }; - }; - }; - }; + status?: 'canceled' | 'created' | 'fulfilled' | 'paid' | 'returned' + } + } + } + } /**

Pay an order by providing a source to create a payment.

*/ PostOrdersIdPay: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["order"]; - }; - }; + 'application/json': components['schemas']['order'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A fee in %s that will be applied to the order and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the `Stripe-Account` header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees). */ - application_fee?: number; + application_fee?: number /** @description The ID of an existing customer that will be charged for this order. If no customer was attached to the order at creation, either `source` or `customer` is required. Otherwise, the specified customer will be charged instead of the one attached to the order. */ - customer?: string; + customer?: string /** @description The email address of the customer placing the order. Required if not previously specified for the order. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description A [Token](https://stripe.com/docs/api#tokens)'s or a [Source](https://stripe.com/docs/api#sources)'s ID, as returned by [Elements](https://stripe.com/docs/elements). If no customer was attached to the order at creation, either `source` or `customer` is required. Otherwise, the specified source will be charged intead of the customer attached to the order. */ - source?: string; - }; - }; - }; - }; + source?: string + } + } + } + } /**

Return all or part of an order. The order must have a status of paid or fulfilled before it can be returned. Once all items have been returned, the order will become canceled or returned depending on which status the order started in.

*/ PostOrdersIdReturns: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["order_return"]; - }; - }; + 'application/json': components['schemas']['order_return'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description List of items to return. */ items?: Partial< { - amount?: number; - description?: string; - parent?: string; - quantity?: number; + amount?: number + description?: string + parent?: string + quantity?: number /** @enum {string} */ - type?: "discount" | "shipping" | "sku" | "tax"; + type?: 'discount' | 'shipping' | 'sku' | 'tax' }[] > & - Partial<"">; - }; - }; - }; - }; + Partial<''> + } + } + } + } /**

Returns a list of PaymentIntents.

*/ GetPaymentIntents: { parameters: { query: { /** 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?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** Only return PaymentIntents for the customer specified by this customer ID. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["payment_intent"][]; + 'application/json': { + data: components['schemas']['payment_intent'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Creates a PaymentIntent object.

* @@ -32603,41 +32384,41 @@ export type operations = { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_intent"]; - }; - }; + 'application/json': components['schemas']['payment_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description 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: number; + amount: number /** @description 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?: number; + application_fee_amount?: number /** * automatic_payment_methods_param * @description When enabled, this PaymentIntent will accept payment methods that you have enabled in the Dashboard and are compatible with this PaymentIntent's other parameters. */ automatic_payment_methods?: { - enabled: boolean; - }; + enabled: boolean + } /** * @description Controls when the funds will be captured from the customer's account. * @enum {string} */ - capture_method?: "automatic" | "manual"; + capture_method?: 'automatic' | 'manual' /** @description Set to `true` to attempt to [confirm](https://stripe.com/docs/api/payment_intents/confirm) this PaymentIntent immediately. This parameter defaults to `false`. When creating and confirming a PaymentIntent at the same time, parameters available in the [confirm](https://stripe.com/docs/api/payment_intents/confirm) API may also be provided. */ - confirm?: boolean; + confirm?: boolean /** @enum {string} */ - confirmation_method?: "automatic" | "manual"; + confirmation_method?: 'automatic' | 'manual' /** @description 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: string; + currency: string /** * @description ID of the Customer this PaymentIntent belongs to, if one exists. * @@ -32645,15 +32426,15 @@ export type operations = { * * If present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. */ - customer?: string; + customer?: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. This parameter is intended for simpler integrations that do not handle customer actions, like [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). */ - error_on_requires_action?: boolean; + error_on_requires_action?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description ID of the mandate to be used for this payment. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). */ - mandate?: string; + mandate?: string /** * secret_key_param * @description This hash contains details about the Mandate to create. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). @@ -32662,30 +32443,30 @@ export type operations = { /** customer_acceptance_param */ customer_acceptance: { /** Format: unix-time */ - accepted_at?: number; + accepted_at?: number /** offline_param */ - offline?: { [key: string]: unknown }; + offline?: { [key: string]: unknown } /** online_param */ online?: { - ip_address: string; - user_agent: string; - }; + ip_address: string + user_agent: string + } /** @enum {string} */ - type: "offline" | "online"; - }; - }; + type: 'offline' | 'online' + } + } /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description Set to `true` to indicate that the customer is not in your checkout flow during this payment attempt, and therefore is unable to authenticate. This parameter is intended for scenarios where you collect card details and [charge them later](https://stripe.com/docs/payments/cards/charging-saved-cards). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). */ - off_session?: Partial & Partial<"one_off" | "recurring">; + off_session?: Partial & Partial<'one_off' | 'recurring'> /** @description The Stripe account ID for which these funds are intended. For details, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ - on_behalf_of?: string; + on_behalf_of?: string /** * @description ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. * * If this parameter is omitted with `confirm=true`, `customer.default_source` will be attached as this PaymentIntent's payment instrument to improve the migration experience for users of the Charges API. We recommend that you explicitly provide the `payment_method` going forward. */ - payment_method?: string; + payment_method?: string /** * payment_method_data_params * @description If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear @@ -32695,201 +32476,201 @@ export type operations = { payment_method_data?: { /** payment_method_param */ acss_debit?: { - account_number: string; - institution_number: string; - transit_number: string; - }; + account_number: string + institution_number: string + transit_number: string + } /** param */ - afterpay_clearpay?: { [key: string]: unknown }; + afterpay_clearpay?: { [key: string]: unknown } /** param */ - alipay?: { [key: string]: unknown }; + alipay?: { [key: string]: unknown } /** param */ au_becs_debit?: { - account_number: string; - bsb_number: string; - }; + account_number: string + bsb_number: string + } /** param */ bacs_debit?: { - account_number?: string; - sort_code?: string; - }; + account_number?: string + sort_code?: string + } /** param */ - bancontact?: { [key: string]: unknown }; + bancontact?: { [key: string]: unknown } /** billing_details_inner_params */ billing_details?: { address?: Partial<{ - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string }> & - Partial<"">; - email?: Partial & Partial<"">; - name?: string; - phone?: string; - }; + Partial<''> + email?: Partial & Partial<''> + name?: string + phone?: string + } /** param */ boleto?: { - tax_id: string; - }; + tax_id: string + } /** param */ eps?: { /** @enum {string} */ bank?: - | "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" - | "dolomitenbank" - | "easybank_ag" - | "erste_bank_und_sparkassen" - | "hypo_alpeadriabank_international_ag" - | "hypo_bank_burgenland_aktiengesellschaft" - | "hypo_noe_lb_fur_niederosterreich_u_wien" - | "hypo_oberosterreich_salzburg_steiermark" - | "hypo_tirol_bank_ag" - | "hypo_vorarlberg_bank_ag" - | "marchfelder_bank" - | "oberbank_ag" - | "raiffeisen_bankengruppe_osterreich" - | "schoellerbank_ag" - | "sparda_bank_wien" - | "volksbank_gruppe" - | "volkskreditbank_ag" - | "vr_bank_braunau"; - }; + | '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' + | 'dolomitenbank' + | 'easybank_ag' + | 'erste_bank_und_sparkassen' + | 'hypo_alpeadriabank_international_ag' + | 'hypo_bank_burgenland_aktiengesellschaft' + | 'hypo_noe_lb_fur_niederosterreich_u_wien' + | 'hypo_oberosterreich_salzburg_steiermark' + | 'hypo_tirol_bank_ag' + | 'hypo_vorarlberg_bank_ag' + | 'marchfelder_bank' + | 'oberbank_ag' + | 'raiffeisen_bankengruppe_osterreich' + | 'schoellerbank_ag' + | 'sparda_bank_wien' + | 'volksbank_gruppe' + | 'volkskreditbank_ag' + | 'vr_bank_braunau' + } /** param */ fpx?: { /** @enum {string} */ bank: - | "affin_bank" - | "agrobank" - | "alliance_bank" - | "ambank" - | "bank_islam" - | "bank_muamalat" - | "bank_rakyat" - | "bsn" - | "cimb" - | "deutsche_bank" - | "hong_leong_bank" - | "hsbc" - | "kfh" - | "maybank2e" - | "maybank2u" - | "ocbc" - | "pb_enterprise" - | "public_bank" - | "rhb" - | "standard_chartered" - | "uob"; - }; + | 'affin_bank' + | 'agrobank' + | 'alliance_bank' + | 'ambank' + | 'bank_islam' + | 'bank_muamalat' + | 'bank_rakyat' + | 'bsn' + | 'cimb' + | 'deutsche_bank' + | 'hong_leong_bank' + | 'hsbc' + | 'kfh' + | 'maybank2e' + | 'maybank2u' + | 'ocbc' + | 'pb_enterprise' + | 'public_bank' + | 'rhb' + | 'standard_chartered' + | 'uob' + } /** param */ - giropay?: { [key: string]: unknown }; + giropay?: { [key: string]: unknown } /** param */ - grabpay?: { [key: string]: unknown }; + grabpay?: { [key: string]: unknown } /** param */ ideal?: { /** @enum {string} */ bank?: - | "abn_amro" - | "asn_bank" - | "bunq" - | "handelsbanken" - | "ing" - | "knab" - | "moneyou" - | "rabobank" - | "regiobank" - | "revolut" - | "sns_bank" - | "triodos_bank" - | "van_lanschot"; - }; + | 'abn_amro' + | 'asn_bank' + | 'bunq' + | 'handelsbanken' + | 'ing' + | 'knab' + | 'moneyou' + | 'rabobank' + | 'regiobank' + | 'revolut' + | 'sns_bank' + | 'triodos_bank' + | 'van_lanschot' + } /** param */ - interac_present?: { [key: string]: unknown }; + interac_present?: { [key: string]: unknown } /** param */ klarna?: { /** date_of_birth */ dob?: { - day: number; - month: number; - year: number; - }; - }; - metadata?: { [key: string]: string }; + day: number + month: number + year: number + } + } + metadata?: { [key: string]: string } /** param */ - oxxo?: { [key: string]: unknown }; + oxxo?: { [key: string]: unknown } /** param */ p24?: { /** @enum {string} */ bank?: - | "alior_bank" - | "bank_millennium" - | "bank_nowy_bfg_sa" - | "bank_pekao_sa" - | "banki_spbdzielcze" - | "blik" - | "bnp_paribas" - | "boz" - | "citi_handlowy" - | "credit_agricole" - | "envelobank" - | "etransfer_pocztowy24" - | "getin_bank" - | "ideabank" - | "ing" - | "inteligo" - | "mbank_mtransfer" - | "nest_przelew" - | "noble_pay" - | "pbac_z_ipko" - | "plus_bank" - | "santander_przelew24" - | "tmobile_usbugi_bankowe" - | "toyota_bank" - | "volkswagen_bank"; - }; + | 'alior_bank' + | 'bank_millennium' + | 'bank_nowy_bfg_sa' + | 'bank_pekao_sa' + | 'banki_spbdzielcze' + | 'blik' + | 'bnp_paribas' + | 'boz' + | 'citi_handlowy' + | 'credit_agricole' + | 'envelobank' + | 'etransfer_pocztowy24' + | 'getin_bank' + | 'ideabank' + | 'ing' + | 'inteligo' + | 'mbank_mtransfer' + | 'nest_przelew' + | 'noble_pay' + | 'pbac_z_ipko' + | 'plus_bank' + | 'santander_przelew24' + | 'tmobile_usbugi_bankowe' + | 'toyota_bank' + | 'volkswagen_bank' + } /** param */ sepa_debit?: { - iban: string; - }; + iban: string + } /** param */ sofort?: { /** @enum {string} */ - country: "AT" | "BE" | "DE" | "ES" | "IT" | "NL"; - }; + country: 'AT' | 'BE' | 'DE' | 'ES' | 'IT' | 'NL' + } /** @enum {string} */ type: - | "acss_debit" - | "afterpay_clearpay" - | "alipay" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "eps" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "klarna" - | "oxxo" - | "p24" - | "sepa_debit" - | "sofort" - | "wechat_pay"; + | 'acss_debit' + | 'afterpay_clearpay' + | 'alipay' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'eps' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'klarna' + | 'oxxo' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' /** param */ - wechat_pay?: { [key: string]: unknown }; - }; + wechat_pay?: { [key: string]: unknown } + } /** * payment_method_options_param * @description Payment-method-specific configuration for this PaymentIntent. @@ -32898,136 +32679,126 @@ export type operations = { acss_debit?: Partial<{ /** payment_intent_payment_method_options_mandate_options_param */ mandate_options?: { - custom_mandate_url?: Partial & Partial<"">; - interval_description?: string; + custom_mandate_url?: Partial & Partial<''> + interval_description?: string /** @enum {string} */ - payment_schedule?: "combined" | "interval" | "sporadic"; + payment_schedule?: 'combined' | 'interval' | 'sporadic' /** @enum {string} */ - transaction_type?: "business" | "personal"; - }; + transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; + verification_method?: 'automatic' | 'instant' | 'microdeposits' }> & - Partial<"">; + Partial<''> afterpay_clearpay?: Partial<{ - reference?: string; + reference?: string }> & - Partial<"">; - alipay?: Partial<{ [key: string]: unknown }> & Partial<"">; - au_becs_debit?: Partial<{ [key: string]: unknown }> & Partial<"">; - bacs_debit?: Partial<{ [key: string]: unknown }> & Partial<"">; + Partial<''> + alipay?: Partial<{ [key: string]: unknown }> & Partial<''> + au_becs_debit?: Partial<{ [key: string]: unknown }> & Partial<''> + bacs_debit?: Partial<{ [key: string]: unknown }> & Partial<''> bancontact?: Partial<{ /** @enum {string} */ - preferred_language?: "de" | "en" | "fr" | "nl"; + preferred_language?: 'de' | 'en' | 'fr' | 'nl' }> & - Partial<"">; + Partial<''> boleto?: Partial<{ - expires_after_days?: number; + expires_after_days?: number }> & - Partial<"">; + Partial<''> card?: Partial<{ - cvc_token?: string; + cvc_token?: string /** installments_param */ installments?: { - enabled?: boolean; + enabled?: boolean plan?: Partial<{ - count: number; + count: number /** @enum {string} */ - interval: "month"; + interval: 'month' /** @enum {string} */ - type: "fixed_count"; + type: 'fixed_count' }> & - Partial<"">; - }; + Partial<''> + } /** @enum {string} */ - network?: - | "amex" - | "cartes_bancaires" - | "diners" - | "discover" - | "interac" - | "jcb" - | "mastercard" - | "unionpay" - | "unknown" - | "visa"; + network?: 'amex' | 'cartes_bancaires' | 'diners' | 'discover' | 'interac' | 'jcb' | 'mastercard' | 'unionpay' | 'unknown' | 'visa' /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: 'any' | 'automatic' /** @enum {string} */ - setup_future_usage?: "" | "none" | "off_session" | "on_session"; + setup_future_usage?: '' | 'none' | 'off_session' | 'on_session' }> & - Partial<"">; - card_present?: Partial<{ [key: string]: unknown }> & Partial<"">; - eps?: Partial<{ [key: string]: unknown }> & Partial<"">; - fpx?: Partial<{ [key: string]: unknown }> & Partial<"">; - giropay?: Partial<{ [key: string]: unknown }> & Partial<"">; - grabpay?: Partial<{ [key: string]: unknown }> & Partial<"">; - ideal?: Partial<{ [key: string]: unknown }> & Partial<"">; - interac_present?: Partial<{ [key: string]: unknown }> & Partial<"">; + Partial<''> + card_present?: Partial<{ [key: string]: unknown }> & Partial<''> + eps?: Partial<{ [key: string]: unknown }> & Partial<''> + fpx?: Partial<{ [key: string]: unknown }> & Partial<''> + giropay?: Partial<{ [key: string]: unknown }> & Partial<''> + grabpay?: Partial<{ [key: string]: unknown }> & Partial<''> + ideal?: Partial<{ [key: string]: unknown }> & Partial<''> + interac_present?: Partial<{ [key: string]: unknown }> & Partial<''> klarna?: Partial<{ /** @enum {string} */ preferred_locale?: - | "da-DK" - | "de-AT" - | "de-DE" - | "en-AT" - | "en-BE" - | "en-DE" - | "en-DK" - | "en-ES" - | "en-FI" - | "en-FR" - | "en-GB" - | "en-IE" - | "en-IT" - | "en-NL" - | "en-NO" - | "en-SE" - | "en-US" - | "es-ES" - | "es-US" - | "fi-FI" - | "fr-BE" - | "fr-FR" - | "it-IT" - | "nb-NO" - | "nl-BE" - | "nl-NL" - | "sv-FI" - | "sv-SE"; + | 'da-DK' + | 'de-AT' + | 'de-DE' + | 'en-AT' + | 'en-BE' + | 'en-DE' + | 'en-DK' + | 'en-ES' + | 'en-FI' + | 'en-FR' + | 'en-GB' + | 'en-IE' + | 'en-IT' + | 'en-NL' + | 'en-NO' + | 'en-SE' + | 'en-US' + | 'es-ES' + | 'es-US' + | 'fi-FI' + | 'fr-BE' + | 'fr-FR' + | 'it-IT' + | 'nb-NO' + | 'nl-BE' + | 'nl-NL' + | 'sv-FI' + | 'sv-SE' }> & - Partial<"">; + Partial<''> oxxo?: Partial<{ - expires_after_days?: number; + expires_after_days?: number }> & - Partial<"">; + Partial<''> p24?: Partial<{ - tos_shown_and_accepted?: boolean; + tos_shown_and_accepted?: boolean }> & - Partial<"">; + Partial<''> sepa_debit?: Partial<{ /** payment_method_options_mandate_options_param */ - mandate_options?: { [key: string]: unknown }; + mandate_options?: { [key: string]: unknown } }> & - Partial<"">; + Partial<''> sofort?: Partial<{ /** @enum {string} */ - preferred_language?: "" | "de" | "en" | "es" | "fr" | "it" | "nl" | "pl"; + preferred_language?: '' | 'de' | 'en' | 'es' | 'fr' | 'it' | 'nl' | 'pl' }> & - Partial<"">; + Partial<''> wechat_pay?: Partial<{ - app_id?: string; + app_id?: string /** @enum {string} */ - client: "android" | "ios" | "web"; + client: 'android' | 'ios' | 'web' }> & - Partial<"">; - }; + Partial<''> + } /** @description The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. If this is not provided, defaults to ["card"]. */ - payment_method_types?: string[]; + payment_method_types?: string[] /** @description 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?: string; + receipt_email?: string /** @description The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). */ - return_url?: string; + return_url?: string /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * @@ -33036,7 +32807,7 @@ export type operations = { * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ - setup_future_usage?: "off_session" | "on_session"; + setup_future_usage?: 'off_session' | 'on_session' /** * optional_fields_shipping * @description Shipping information for this PaymentIntent. @@ -33044,39 +32815,39 @@ export type operations = { shipping?: { /** optional_fields_address */ address: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - carrier?: string; - name: string; - phone?: string; - tracking_number?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + carrier?: string + name: string + phone?: string + tracking_number?: string + } /** @description For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - statement_descriptor_suffix?: string; + statement_descriptor_suffix?: string /** * transfer_data_creation_params * @description The parameters used to automatically create a Transfer when the payment succeeds. * For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ transfer_data?: { - amount?: number; - destination: string; - }; + amount?: number + destination: string + } /** @description A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. */ - transfer_group?: string; + transfer_group?: string /** @description Set to `true` only when using manual confirmation and the iOS or Android SDKs to handle additional authentication steps. */ - use_stripe_sdk?: boolean; - }; - }; - }; - }; + use_stripe_sdk?: boolean + } + } + } + } /** *

Retrieves the details of a PaymentIntent that has previously been created.

* @@ -33088,34 +32859,34 @@ export type operations = { parameters: { query: { /** The client secret of the PaymentIntent. Required if a publishable key is used to retrieve the source. */ - client_secret?: string; + client_secret?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - intent: string; - }; - }; + intent: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_intent"]; - }; - }; + 'application/json': components['schemas']['payment_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates properties on a PaymentIntent object without confirming.

* @@ -33128,32 +32899,32 @@ export type operations = { PostPaymentIntentsIntent: { parameters: { path: { - intent: string; - }; - }; + intent: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_intent"]; - }; - }; + 'application/json': components['schemas']['payment_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description 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?: number; + amount?: number /** @description 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?: Partial & Partial<"">; + application_fee_amount?: Partial & Partial<''> /** @description 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?: string; + currency?: string /** * @description ID of the Customer this PaymentIntent belongs to, if one exists. * @@ -33161,15 +32932,15 @@ export type operations = { * * If present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. */ - customer?: string; + customer?: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. */ - payment_method?: string; + payment_method?: string /** * payment_method_data_params * @description If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear @@ -33179,201 +32950,201 @@ export type operations = { payment_method_data?: { /** payment_method_param */ acss_debit?: { - account_number: string; - institution_number: string; - transit_number: string; - }; + account_number: string + institution_number: string + transit_number: string + } /** param */ - afterpay_clearpay?: { [key: string]: unknown }; + afterpay_clearpay?: { [key: string]: unknown } /** param */ - alipay?: { [key: string]: unknown }; + alipay?: { [key: string]: unknown } /** param */ au_becs_debit?: { - account_number: string; - bsb_number: string; - }; + account_number: string + bsb_number: string + } /** param */ bacs_debit?: { - account_number?: string; - sort_code?: string; - }; + account_number?: string + sort_code?: string + } /** param */ - bancontact?: { [key: string]: unknown }; + bancontact?: { [key: string]: unknown } /** billing_details_inner_params */ billing_details?: { address?: Partial<{ - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string }> & - Partial<"">; - email?: Partial & Partial<"">; - name?: string; - phone?: string; - }; + Partial<''> + email?: Partial & Partial<''> + name?: string + phone?: string + } /** param */ boleto?: { - tax_id: string; - }; + tax_id: string + } /** param */ eps?: { /** @enum {string} */ bank?: - | "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" - | "dolomitenbank" - | "easybank_ag" - | "erste_bank_und_sparkassen" - | "hypo_alpeadriabank_international_ag" - | "hypo_bank_burgenland_aktiengesellschaft" - | "hypo_noe_lb_fur_niederosterreich_u_wien" - | "hypo_oberosterreich_salzburg_steiermark" - | "hypo_tirol_bank_ag" - | "hypo_vorarlberg_bank_ag" - | "marchfelder_bank" - | "oberbank_ag" - | "raiffeisen_bankengruppe_osterreich" - | "schoellerbank_ag" - | "sparda_bank_wien" - | "volksbank_gruppe" - | "volkskreditbank_ag" - | "vr_bank_braunau"; - }; + | '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' + | 'dolomitenbank' + | 'easybank_ag' + | 'erste_bank_und_sparkassen' + | 'hypo_alpeadriabank_international_ag' + | 'hypo_bank_burgenland_aktiengesellschaft' + | 'hypo_noe_lb_fur_niederosterreich_u_wien' + | 'hypo_oberosterreich_salzburg_steiermark' + | 'hypo_tirol_bank_ag' + | 'hypo_vorarlberg_bank_ag' + | 'marchfelder_bank' + | 'oberbank_ag' + | 'raiffeisen_bankengruppe_osterreich' + | 'schoellerbank_ag' + | 'sparda_bank_wien' + | 'volksbank_gruppe' + | 'volkskreditbank_ag' + | 'vr_bank_braunau' + } /** param */ fpx?: { /** @enum {string} */ bank: - | "affin_bank" - | "agrobank" - | "alliance_bank" - | "ambank" - | "bank_islam" - | "bank_muamalat" - | "bank_rakyat" - | "bsn" - | "cimb" - | "deutsche_bank" - | "hong_leong_bank" - | "hsbc" - | "kfh" - | "maybank2e" - | "maybank2u" - | "ocbc" - | "pb_enterprise" - | "public_bank" - | "rhb" - | "standard_chartered" - | "uob"; - }; + | 'affin_bank' + | 'agrobank' + | 'alliance_bank' + | 'ambank' + | 'bank_islam' + | 'bank_muamalat' + | 'bank_rakyat' + | 'bsn' + | 'cimb' + | 'deutsche_bank' + | 'hong_leong_bank' + | 'hsbc' + | 'kfh' + | 'maybank2e' + | 'maybank2u' + | 'ocbc' + | 'pb_enterprise' + | 'public_bank' + | 'rhb' + | 'standard_chartered' + | 'uob' + } /** param */ - giropay?: { [key: string]: unknown }; + giropay?: { [key: string]: unknown } /** param */ - grabpay?: { [key: string]: unknown }; + grabpay?: { [key: string]: unknown } /** param */ ideal?: { /** @enum {string} */ bank?: - | "abn_amro" - | "asn_bank" - | "bunq" - | "handelsbanken" - | "ing" - | "knab" - | "moneyou" - | "rabobank" - | "regiobank" - | "revolut" - | "sns_bank" - | "triodos_bank" - | "van_lanschot"; - }; + | 'abn_amro' + | 'asn_bank' + | 'bunq' + | 'handelsbanken' + | 'ing' + | 'knab' + | 'moneyou' + | 'rabobank' + | 'regiobank' + | 'revolut' + | 'sns_bank' + | 'triodos_bank' + | 'van_lanschot' + } /** param */ - interac_present?: { [key: string]: unknown }; + interac_present?: { [key: string]: unknown } /** param */ klarna?: { /** date_of_birth */ dob?: { - day: number; - month: number; - year: number; - }; - }; - metadata?: { [key: string]: string }; + day: number + month: number + year: number + } + } + metadata?: { [key: string]: string } /** param */ - oxxo?: { [key: string]: unknown }; + oxxo?: { [key: string]: unknown } /** param */ p24?: { /** @enum {string} */ bank?: - | "alior_bank" - | "bank_millennium" - | "bank_nowy_bfg_sa" - | "bank_pekao_sa" - | "banki_spbdzielcze" - | "blik" - | "bnp_paribas" - | "boz" - | "citi_handlowy" - | "credit_agricole" - | "envelobank" - | "etransfer_pocztowy24" - | "getin_bank" - | "ideabank" - | "ing" - | "inteligo" - | "mbank_mtransfer" - | "nest_przelew" - | "noble_pay" - | "pbac_z_ipko" - | "plus_bank" - | "santander_przelew24" - | "tmobile_usbugi_bankowe" - | "toyota_bank" - | "volkswagen_bank"; - }; + | 'alior_bank' + | 'bank_millennium' + | 'bank_nowy_bfg_sa' + | 'bank_pekao_sa' + | 'banki_spbdzielcze' + | 'blik' + | 'bnp_paribas' + | 'boz' + | 'citi_handlowy' + | 'credit_agricole' + | 'envelobank' + | 'etransfer_pocztowy24' + | 'getin_bank' + | 'ideabank' + | 'ing' + | 'inteligo' + | 'mbank_mtransfer' + | 'nest_przelew' + | 'noble_pay' + | 'pbac_z_ipko' + | 'plus_bank' + | 'santander_przelew24' + | 'tmobile_usbugi_bankowe' + | 'toyota_bank' + | 'volkswagen_bank' + } /** param */ sepa_debit?: { - iban: string; - }; + iban: string + } /** param */ sofort?: { /** @enum {string} */ - country: "AT" | "BE" | "DE" | "ES" | "IT" | "NL"; - }; + country: 'AT' | 'BE' | 'DE' | 'ES' | 'IT' | 'NL' + } /** @enum {string} */ type: - | "acss_debit" - | "afterpay_clearpay" - | "alipay" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "eps" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "klarna" - | "oxxo" - | "p24" - | "sepa_debit" - | "sofort" - | "wechat_pay"; + | 'acss_debit' + | 'afterpay_clearpay' + | 'alipay' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'eps' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'klarna' + | 'oxxo' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' /** param */ - wechat_pay?: { [key: string]: unknown }; - }; + wechat_pay?: { [key: string]: unknown } + } /** * payment_method_options_param * @description Payment-method-specific configuration for this PaymentIntent. @@ -33382,134 +33153,124 @@ export type operations = { acss_debit?: Partial<{ /** payment_intent_payment_method_options_mandate_options_param */ mandate_options?: { - custom_mandate_url?: Partial & Partial<"">; - interval_description?: string; + custom_mandate_url?: Partial & Partial<''> + interval_description?: string /** @enum {string} */ - payment_schedule?: "combined" | "interval" | "sporadic"; + payment_schedule?: 'combined' | 'interval' | 'sporadic' /** @enum {string} */ - transaction_type?: "business" | "personal"; - }; + transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; + verification_method?: 'automatic' | 'instant' | 'microdeposits' }> & - Partial<"">; + Partial<''> afterpay_clearpay?: Partial<{ - reference?: string; + reference?: string }> & - Partial<"">; - alipay?: Partial<{ [key: string]: unknown }> & Partial<"">; - au_becs_debit?: Partial<{ [key: string]: unknown }> & Partial<"">; - bacs_debit?: Partial<{ [key: string]: unknown }> & Partial<"">; + Partial<''> + alipay?: Partial<{ [key: string]: unknown }> & Partial<''> + au_becs_debit?: Partial<{ [key: string]: unknown }> & Partial<''> + bacs_debit?: Partial<{ [key: string]: unknown }> & Partial<''> bancontact?: Partial<{ /** @enum {string} */ - preferred_language?: "de" | "en" | "fr" | "nl"; + preferred_language?: 'de' | 'en' | 'fr' | 'nl' }> & - Partial<"">; + Partial<''> boleto?: Partial<{ - expires_after_days?: number; + expires_after_days?: number }> & - Partial<"">; + Partial<''> card?: Partial<{ - cvc_token?: string; + cvc_token?: string /** installments_param */ installments?: { - enabled?: boolean; + enabled?: boolean plan?: Partial<{ - count: number; + count: number /** @enum {string} */ - interval: "month"; + interval: 'month' /** @enum {string} */ - type: "fixed_count"; + type: 'fixed_count' }> & - Partial<"">; - }; + Partial<''> + } /** @enum {string} */ - network?: - | "amex" - | "cartes_bancaires" - | "diners" - | "discover" - | "interac" - | "jcb" - | "mastercard" - | "unionpay" - | "unknown" - | "visa"; + network?: 'amex' | 'cartes_bancaires' | 'diners' | 'discover' | 'interac' | 'jcb' | 'mastercard' | 'unionpay' | 'unknown' | 'visa' /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: 'any' | 'automatic' /** @enum {string} */ - setup_future_usage?: "" | "none" | "off_session" | "on_session"; + setup_future_usage?: '' | 'none' | 'off_session' | 'on_session' }> & - Partial<"">; - card_present?: Partial<{ [key: string]: unknown }> & Partial<"">; - eps?: Partial<{ [key: string]: unknown }> & Partial<"">; - fpx?: Partial<{ [key: string]: unknown }> & Partial<"">; - giropay?: Partial<{ [key: string]: unknown }> & Partial<"">; - grabpay?: Partial<{ [key: string]: unknown }> & Partial<"">; - ideal?: Partial<{ [key: string]: unknown }> & Partial<"">; - interac_present?: Partial<{ [key: string]: unknown }> & Partial<"">; + Partial<''> + card_present?: Partial<{ [key: string]: unknown }> & Partial<''> + eps?: Partial<{ [key: string]: unknown }> & Partial<''> + fpx?: Partial<{ [key: string]: unknown }> & Partial<''> + giropay?: Partial<{ [key: string]: unknown }> & Partial<''> + grabpay?: Partial<{ [key: string]: unknown }> & Partial<''> + ideal?: Partial<{ [key: string]: unknown }> & Partial<''> + interac_present?: Partial<{ [key: string]: unknown }> & Partial<''> klarna?: Partial<{ /** @enum {string} */ preferred_locale?: - | "da-DK" - | "de-AT" - | "de-DE" - | "en-AT" - | "en-BE" - | "en-DE" - | "en-DK" - | "en-ES" - | "en-FI" - | "en-FR" - | "en-GB" - | "en-IE" - | "en-IT" - | "en-NL" - | "en-NO" - | "en-SE" - | "en-US" - | "es-ES" - | "es-US" - | "fi-FI" - | "fr-BE" - | "fr-FR" - | "it-IT" - | "nb-NO" - | "nl-BE" - | "nl-NL" - | "sv-FI" - | "sv-SE"; + | 'da-DK' + | 'de-AT' + | 'de-DE' + | 'en-AT' + | 'en-BE' + | 'en-DE' + | 'en-DK' + | 'en-ES' + | 'en-FI' + | 'en-FR' + | 'en-GB' + | 'en-IE' + | 'en-IT' + | 'en-NL' + | 'en-NO' + | 'en-SE' + | 'en-US' + | 'es-ES' + | 'es-US' + | 'fi-FI' + | 'fr-BE' + | 'fr-FR' + | 'it-IT' + | 'nb-NO' + | 'nl-BE' + | 'nl-NL' + | 'sv-FI' + | 'sv-SE' }> & - Partial<"">; + Partial<''> oxxo?: Partial<{ - expires_after_days?: number; + expires_after_days?: number }> & - Partial<"">; + Partial<''> p24?: Partial<{ - tos_shown_and_accepted?: boolean; + tos_shown_and_accepted?: boolean }> & - Partial<"">; + Partial<''> sepa_debit?: Partial<{ /** payment_method_options_mandate_options_param */ - mandate_options?: { [key: string]: unknown }; + mandate_options?: { [key: string]: unknown } }> & - Partial<"">; + Partial<''> sofort?: Partial<{ /** @enum {string} */ - preferred_language?: "" | "de" | "en" | "es" | "fr" | "it" | "nl" | "pl"; + preferred_language?: '' | 'de' | 'en' | 'es' | 'fr' | 'it' | 'nl' | 'pl' }> & - Partial<"">; + Partial<''> wechat_pay?: Partial<{ - app_id?: string; + app_id?: string /** @enum {string} */ - client: "android" | "ios" | "web"; + client: 'android' | 'ios' | 'web' }> & - Partial<"">; - }; + Partial<''> + } /** @description The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. */ - payment_method_types?: string[]; + payment_method_types?: string[] /** @description 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?: Partial & Partial<"">; + receipt_email?: Partial & Partial<''> /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * @@ -33520,41 +33281,41 @@ export type operations = { * If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. * @enum {string} */ - setup_future_usage?: "" | "off_session" | "on_session"; + setup_future_usage?: '' | 'off_session' | 'on_session' /** @description Shipping information for this PaymentIntent. */ shipping?: Partial<{ /** optional_fields_address */ address: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - carrier?: string; - name: string; - phone?: string; - tracking_number?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + carrier?: string + name: string + phone?: string + tracking_number?: string }> & - Partial<"">; + Partial<''> /** @description For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - statement_descriptor_suffix?: string; + statement_descriptor_suffix?: string /** * transfer_data_update_params * @description The parameters used to automatically create a Transfer when the payment succeeds. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ transfer_data?: { - amount?: number; - }; + amount?: number + } /** @description A string that identifies the resulting payment as part of a group. `transfer_group` may only be provided if it has not been set. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. */ - transfer_group?: string; - }; - }; - }; - }; + transfer_group?: string + } + } + } + } /** *

A PaymentIntent object can be canceled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action, or processing.

* @@ -33563,37 +33324,37 @@ export type operations = { PostPaymentIntentsIntentCancel: { parameters: { path: { - intent: string; - }; - }; + intent: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_intent"]; - }; - }; + 'application/json': components['schemas']['payment_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * @description Reason for canceling this PaymentIntent. Possible values are `duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned` * @enum {string} */ - cancellation_reason?: "abandoned" | "duplicate" | "fraudulent" | "requested_by_customer"; + cancellation_reason?: 'abandoned' | 'duplicate' | 'fraudulent' | 'requested_by_customer' /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /** *

Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.

* @@ -33604,48 +33365,48 @@ export type operations = { PostPaymentIntentsIntentCapture: { parameters: { path: { - intent: string; - }; - }; + intent: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_intent"]; - }; - }; + 'application/json': components['schemas']['payment_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The amount to capture from the PaymentIntent, which must be less than or equal to the original amount. Any additional amount will be automatically refunded. Defaults to the full `amount_capturable` if not provided. */ - amount_to_capture?: number; + amount_to_capture?: number /** @description 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?: number; + application_fee_amount?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - statement_descriptor_suffix?: string; + statement_descriptor_suffix?: string /** * transfer_data_update_params * @description The parameters used to automatically create a Transfer when the payment * is captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ transfer_data?: { - amount?: number; - }; - }; - }; - }; - }; + amount?: number + } + } + } + } + } /** *

Confirm that your customer intends to pay with current or provided * payment method. Upon confirmation, the PaymentIntent will attempt to initiate @@ -33676,67 +33437,67 @@ export type operations = { PostPaymentIntentsIntentConfirm: { parameters: { path: { - intent: string; - }; - }; + intent: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_intent"]; - }; - }; + 'application/json': components['schemas']['payment_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The client secret of the PaymentIntent. */ - client_secret?: string; + client_secret?: string /** @description Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. This parameter is intended for simpler integrations that do not handle customer actions, like [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication). */ - error_on_requires_action?: boolean; + error_on_requires_action?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description ID of the mandate to be used for this payment. */ - mandate?: string; + mandate?: string /** @description This hash contains details about the Mandate to create */ mandate_data?: Partial<{ /** customer_acceptance_param */ customer_acceptance: { /** Format: unix-time */ - accepted_at?: number; + accepted_at?: number /** offline_param */ - offline?: { [key: string]: unknown }; + offline?: { [key: string]: unknown } /** online_param */ online?: { - ip_address: string; - user_agent: string; - }; + ip_address: string + user_agent: string + } /** @enum {string} */ - type: "offline" | "online"; - }; + type: 'offline' | 'online' + } }> & Partial<{ /** customer_acceptance_param */ customer_acceptance: { /** online_param */ online: { - ip_address?: string; - user_agent?: string; - }; + ip_address?: string + user_agent?: string + } /** @enum {string} */ - type: "online"; - }; - }>; + type: 'online' + } + }> /** @description Set to `true` to indicate that the customer is not in your checkout flow during this payment attempt, and therefore is unable to authenticate. This parameter is intended for scenarios where you collect card details and [charge them later](https://stripe.com/docs/payments/cards/charging-saved-cards). */ - off_session?: Partial & Partial<"one_off" | "recurring">; + off_session?: Partial & Partial<'one_off' | 'recurring'> /** @description ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. */ - payment_method?: string; + payment_method?: string /** * payment_method_data_params * @description If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear @@ -33746,201 +33507,201 @@ export type operations = { payment_method_data?: { /** payment_method_param */ acss_debit?: { - account_number: string; - institution_number: string; - transit_number: string; - }; + account_number: string + institution_number: string + transit_number: string + } /** param */ - afterpay_clearpay?: { [key: string]: unknown }; + afterpay_clearpay?: { [key: string]: unknown } /** param */ - alipay?: { [key: string]: unknown }; + alipay?: { [key: string]: unknown } /** param */ au_becs_debit?: { - account_number: string; - bsb_number: string; - }; + account_number: string + bsb_number: string + } /** param */ bacs_debit?: { - account_number?: string; - sort_code?: string; - }; + account_number?: string + sort_code?: string + } /** param */ - bancontact?: { [key: string]: unknown }; + bancontact?: { [key: string]: unknown } /** billing_details_inner_params */ billing_details?: { address?: Partial<{ - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string }> & - Partial<"">; - email?: Partial & Partial<"">; - name?: string; - phone?: string; - }; + Partial<''> + email?: Partial & Partial<''> + name?: string + phone?: string + } /** param */ boleto?: { - tax_id: string; - }; + tax_id: string + } /** param */ eps?: { /** @enum {string} */ bank?: - | "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" - | "dolomitenbank" - | "easybank_ag" - | "erste_bank_und_sparkassen" - | "hypo_alpeadriabank_international_ag" - | "hypo_bank_burgenland_aktiengesellschaft" - | "hypo_noe_lb_fur_niederosterreich_u_wien" - | "hypo_oberosterreich_salzburg_steiermark" - | "hypo_tirol_bank_ag" - | "hypo_vorarlberg_bank_ag" - | "marchfelder_bank" - | "oberbank_ag" - | "raiffeisen_bankengruppe_osterreich" - | "schoellerbank_ag" - | "sparda_bank_wien" - | "volksbank_gruppe" - | "volkskreditbank_ag" - | "vr_bank_braunau"; - }; + | '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' + | 'dolomitenbank' + | 'easybank_ag' + | 'erste_bank_und_sparkassen' + | 'hypo_alpeadriabank_international_ag' + | 'hypo_bank_burgenland_aktiengesellschaft' + | 'hypo_noe_lb_fur_niederosterreich_u_wien' + | 'hypo_oberosterreich_salzburg_steiermark' + | 'hypo_tirol_bank_ag' + | 'hypo_vorarlberg_bank_ag' + | 'marchfelder_bank' + | 'oberbank_ag' + | 'raiffeisen_bankengruppe_osterreich' + | 'schoellerbank_ag' + | 'sparda_bank_wien' + | 'volksbank_gruppe' + | 'volkskreditbank_ag' + | 'vr_bank_braunau' + } /** param */ fpx?: { /** @enum {string} */ bank: - | "affin_bank" - | "agrobank" - | "alliance_bank" - | "ambank" - | "bank_islam" - | "bank_muamalat" - | "bank_rakyat" - | "bsn" - | "cimb" - | "deutsche_bank" - | "hong_leong_bank" - | "hsbc" - | "kfh" - | "maybank2e" - | "maybank2u" - | "ocbc" - | "pb_enterprise" - | "public_bank" - | "rhb" - | "standard_chartered" - | "uob"; - }; + | 'affin_bank' + | 'agrobank' + | 'alliance_bank' + | 'ambank' + | 'bank_islam' + | 'bank_muamalat' + | 'bank_rakyat' + | 'bsn' + | 'cimb' + | 'deutsche_bank' + | 'hong_leong_bank' + | 'hsbc' + | 'kfh' + | 'maybank2e' + | 'maybank2u' + | 'ocbc' + | 'pb_enterprise' + | 'public_bank' + | 'rhb' + | 'standard_chartered' + | 'uob' + } /** param */ - giropay?: { [key: string]: unknown }; + giropay?: { [key: string]: unknown } /** param */ - grabpay?: { [key: string]: unknown }; + grabpay?: { [key: string]: unknown } /** param */ ideal?: { /** @enum {string} */ bank?: - | "abn_amro" - | "asn_bank" - | "bunq" - | "handelsbanken" - | "ing" - | "knab" - | "moneyou" - | "rabobank" - | "regiobank" - | "revolut" - | "sns_bank" - | "triodos_bank" - | "van_lanschot"; - }; + | 'abn_amro' + | 'asn_bank' + | 'bunq' + | 'handelsbanken' + | 'ing' + | 'knab' + | 'moneyou' + | 'rabobank' + | 'regiobank' + | 'revolut' + | 'sns_bank' + | 'triodos_bank' + | 'van_lanschot' + } /** param */ - interac_present?: { [key: string]: unknown }; + interac_present?: { [key: string]: unknown } /** param */ klarna?: { /** date_of_birth */ dob?: { - day: number; - month: number; - year: number; - }; - }; - metadata?: { [key: string]: string }; + day: number + month: number + year: number + } + } + metadata?: { [key: string]: string } /** param */ - oxxo?: { [key: string]: unknown }; + oxxo?: { [key: string]: unknown } /** param */ p24?: { /** @enum {string} */ bank?: - | "alior_bank" - | "bank_millennium" - | "bank_nowy_bfg_sa" - | "bank_pekao_sa" - | "banki_spbdzielcze" - | "blik" - | "bnp_paribas" - | "boz" - | "citi_handlowy" - | "credit_agricole" - | "envelobank" - | "etransfer_pocztowy24" - | "getin_bank" - | "ideabank" - | "ing" - | "inteligo" - | "mbank_mtransfer" - | "nest_przelew" - | "noble_pay" - | "pbac_z_ipko" - | "plus_bank" - | "santander_przelew24" - | "tmobile_usbugi_bankowe" - | "toyota_bank" - | "volkswagen_bank"; - }; + | 'alior_bank' + | 'bank_millennium' + | 'bank_nowy_bfg_sa' + | 'bank_pekao_sa' + | 'banki_spbdzielcze' + | 'blik' + | 'bnp_paribas' + | 'boz' + | 'citi_handlowy' + | 'credit_agricole' + | 'envelobank' + | 'etransfer_pocztowy24' + | 'getin_bank' + | 'ideabank' + | 'ing' + | 'inteligo' + | 'mbank_mtransfer' + | 'nest_przelew' + | 'noble_pay' + | 'pbac_z_ipko' + | 'plus_bank' + | 'santander_przelew24' + | 'tmobile_usbugi_bankowe' + | 'toyota_bank' + | 'volkswagen_bank' + } /** param */ sepa_debit?: { - iban: string; - }; + iban: string + } /** param */ sofort?: { /** @enum {string} */ - country: "AT" | "BE" | "DE" | "ES" | "IT" | "NL"; - }; + country: 'AT' | 'BE' | 'DE' | 'ES' | 'IT' | 'NL' + } /** @enum {string} */ type: - | "acss_debit" - | "afterpay_clearpay" - | "alipay" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "eps" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "klarna" - | "oxxo" - | "p24" - | "sepa_debit" - | "sofort" - | "wechat_pay"; + | 'acss_debit' + | 'afterpay_clearpay' + | 'alipay' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'eps' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'klarna' + | 'oxxo' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' /** param */ - wechat_pay?: { [key: string]: unknown }; - }; + wechat_pay?: { [key: string]: unknown } + } /** * payment_method_options_param * @description Payment-method-specific configuration for this PaymentIntent. @@ -33949,140 +33710,130 @@ export type operations = { acss_debit?: Partial<{ /** payment_intent_payment_method_options_mandate_options_param */ mandate_options?: { - custom_mandate_url?: Partial & Partial<"">; - interval_description?: string; + custom_mandate_url?: Partial & Partial<''> + interval_description?: string /** @enum {string} */ - payment_schedule?: "combined" | "interval" | "sporadic"; + payment_schedule?: 'combined' | 'interval' | 'sporadic' /** @enum {string} */ - transaction_type?: "business" | "personal"; - }; + transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; + verification_method?: 'automatic' | 'instant' | 'microdeposits' }> & - Partial<"">; + Partial<''> afterpay_clearpay?: Partial<{ - reference?: string; + reference?: string }> & - Partial<"">; - alipay?: Partial<{ [key: string]: unknown }> & Partial<"">; - au_becs_debit?: Partial<{ [key: string]: unknown }> & Partial<"">; - bacs_debit?: Partial<{ [key: string]: unknown }> & Partial<"">; + Partial<''> + alipay?: Partial<{ [key: string]: unknown }> & Partial<''> + au_becs_debit?: Partial<{ [key: string]: unknown }> & Partial<''> + bacs_debit?: Partial<{ [key: string]: unknown }> & Partial<''> bancontact?: Partial<{ /** @enum {string} */ - preferred_language?: "de" | "en" | "fr" | "nl"; + preferred_language?: 'de' | 'en' | 'fr' | 'nl' }> & - Partial<"">; + Partial<''> boleto?: Partial<{ - expires_after_days?: number; + expires_after_days?: number }> & - Partial<"">; + Partial<''> card?: Partial<{ - cvc_token?: string; + cvc_token?: string /** installments_param */ installments?: { - enabled?: boolean; + enabled?: boolean plan?: Partial<{ - count: number; + count: number /** @enum {string} */ - interval: "month"; + interval: 'month' /** @enum {string} */ - type: "fixed_count"; + type: 'fixed_count' }> & - Partial<"">; - }; + Partial<''> + } /** @enum {string} */ - network?: - | "amex" - | "cartes_bancaires" - | "diners" - | "discover" - | "interac" - | "jcb" - | "mastercard" - | "unionpay" - | "unknown" - | "visa"; + network?: 'amex' | 'cartes_bancaires' | 'diners' | 'discover' | 'interac' | 'jcb' | 'mastercard' | 'unionpay' | 'unknown' | 'visa' /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: 'any' | 'automatic' /** @enum {string} */ - setup_future_usage?: "" | "none" | "off_session" | "on_session"; + setup_future_usage?: '' | 'none' | 'off_session' | 'on_session' }> & - Partial<"">; - card_present?: Partial<{ [key: string]: unknown }> & Partial<"">; - eps?: Partial<{ [key: string]: unknown }> & Partial<"">; - fpx?: Partial<{ [key: string]: unknown }> & Partial<"">; - giropay?: Partial<{ [key: string]: unknown }> & Partial<"">; - grabpay?: Partial<{ [key: string]: unknown }> & Partial<"">; - ideal?: Partial<{ [key: string]: unknown }> & Partial<"">; - interac_present?: Partial<{ [key: string]: unknown }> & Partial<"">; + Partial<''> + card_present?: Partial<{ [key: string]: unknown }> & Partial<''> + eps?: Partial<{ [key: string]: unknown }> & Partial<''> + fpx?: Partial<{ [key: string]: unknown }> & Partial<''> + giropay?: Partial<{ [key: string]: unknown }> & Partial<''> + grabpay?: Partial<{ [key: string]: unknown }> & Partial<''> + ideal?: Partial<{ [key: string]: unknown }> & Partial<''> + interac_present?: Partial<{ [key: string]: unknown }> & Partial<''> klarna?: Partial<{ /** @enum {string} */ preferred_locale?: - | "da-DK" - | "de-AT" - | "de-DE" - | "en-AT" - | "en-BE" - | "en-DE" - | "en-DK" - | "en-ES" - | "en-FI" - | "en-FR" - | "en-GB" - | "en-IE" - | "en-IT" - | "en-NL" - | "en-NO" - | "en-SE" - | "en-US" - | "es-ES" - | "es-US" - | "fi-FI" - | "fr-BE" - | "fr-FR" - | "it-IT" - | "nb-NO" - | "nl-BE" - | "nl-NL" - | "sv-FI" - | "sv-SE"; + | 'da-DK' + | 'de-AT' + | 'de-DE' + | 'en-AT' + | 'en-BE' + | 'en-DE' + | 'en-DK' + | 'en-ES' + | 'en-FI' + | 'en-FR' + | 'en-GB' + | 'en-IE' + | 'en-IT' + | 'en-NL' + | 'en-NO' + | 'en-SE' + | 'en-US' + | 'es-ES' + | 'es-US' + | 'fi-FI' + | 'fr-BE' + | 'fr-FR' + | 'it-IT' + | 'nb-NO' + | 'nl-BE' + | 'nl-NL' + | 'sv-FI' + | 'sv-SE' }> & - Partial<"">; + Partial<''> oxxo?: Partial<{ - expires_after_days?: number; + expires_after_days?: number }> & - Partial<"">; + Partial<''> p24?: Partial<{ - tos_shown_and_accepted?: boolean; + tos_shown_and_accepted?: boolean }> & - Partial<"">; + Partial<''> sepa_debit?: Partial<{ /** payment_method_options_mandate_options_param */ - mandate_options?: { [key: string]: unknown }; + mandate_options?: { [key: string]: unknown } }> & - Partial<"">; + Partial<''> sofort?: Partial<{ /** @enum {string} */ - preferred_language?: "" | "de" | "en" | "es" | "fr" | "it" | "nl" | "pl"; + preferred_language?: '' | 'de' | 'en' | 'es' | 'fr' | 'it' | 'nl' | 'pl' }> & - Partial<"">; + Partial<''> wechat_pay?: Partial<{ - app_id?: string; + app_id?: string /** @enum {string} */ - client: "android" | "ios" | "web"; + client: 'android' | 'ios' | 'web' }> & - Partial<"">; - }; + Partial<''> + } /** @description The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. */ - payment_method_types?: string[]; + payment_method_types?: string[] /** @description 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?: Partial & Partial<"">; + receipt_email?: Partial & Partial<''> /** * @description The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. * If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. * This parameter is only used for cards and other redirect-based payment methods. */ - return_url?: string; + return_url?: string /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * @@ -34093,130 +33844,130 @@ export type operations = { * If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. * @enum {string} */ - setup_future_usage?: "" | "off_session" | "on_session"; + setup_future_usage?: '' | 'off_session' | 'on_session' /** @description Shipping information for this PaymentIntent. */ shipping?: Partial<{ /** optional_fields_address */ address: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - carrier?: string; - name: string; - phone?: string; - tracking_number?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + carrier?: string + name: string + phone?: string + tracking_number?: string }> & - Partial<"">; + Partial<''> /** @description Set to `true` only when using manual confirmation and the iOS or Android SDKs to handle additional authentication steps. */ - use_stripe_sdk?: boolean; - }; - }; - }; - }; + use_stripe_sdk?: boolean + } + } + } + } /**

Verifies microdeposits on a PaymentIntent object.

*/ PostPaymentIntentsIntentVerifyMicrodeposits: { parameters: { path: { - intent: string; - }; - }; + intent: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_intent"]; - }; - }; + 'application/json': components['schemas']['payment_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account. */ - amounts?: number[]; + amounts?: number[] /** @description The client secret of the PaymentIntent. */ - client_secret?: string; + client_secret?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Returns a list of your payment links.

*/ GetPaymentLinks: { parameters: { query: { /** Only return payment links that are active or inactive (e.g., pass `false` to list all inactive payment links). */ - active?: boolean; + active?: boolean /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["payment_link"][]; + 'application/json': { + data: components['schemas']['payment_link'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a payment link.

*/ PostPaymentLinks: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_link"]; - }; - }; + 'application/json': components['schemas']['payment_link'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * after_completion_params * @description Behavior after the purchase is complete. @@ -34224,52 +33975,52 @@ export type operations = { after_completion?: { /** after_completion_confirmation_page_params */ hosted_confirmation?: { - custom_message?: string; - }; + custom_message?: string + } /** after_completion_redirect_params */ redirect?: { - url: string; - }; + url: string + } /** @enum {string} */ - type: "hosted_confirmation" | "redirect"; - }; + type: 'hosted_confirmation' | 'redirect' + } /** @description Enables user redeemable promotion codes. */ - allow_promotion_codes?: boolean; + allow_promotion_codes?: boolean /** @description 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. Can only be applied when there are no line items with recurring prices. */ - application_fee_amount?: number; + application_fee_amount?: number /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field. */ - application_fee_percent?: number; + application_fee_percent?: number /** * automatic_tax_params * @description Configuration for automatic tax collection. */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** * @description Configuration for collecting the customer's billing address. * @enum {string} */ - billing_address_collection?: "auto" | "required"; + billing_address_collection?: 'auto' | 'required' /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported. */ line_items?: { /** adjustable_quantity_params */ adjustable_quantity?: { - enabled: boolean; - maximum?: number; - minimum?: number; - }; - price: string; - quantity: number; - }[]; + enabled: boolean + maximum?: number + minimum?: number + } + price: string + quantity: number + }[] /** @description 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 associated with this Payment Link will automatically be copied to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link. */ - metadata?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The account on behalf of which to charge. */ - on_behalf_of?: string; + on_behalf_of?: string /** @description The list of payment method types that customers can use. Only `card` is supported. If no value is passed, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods) (20+ payment methods [supported](https://stripe.com/docs/payments/payment-methods/integration-options#payment-method-product-support)). */ - payment_method_types?: "card"[]; + payment_method_types?: 'card'[] /** * phone_number_collection_params * @description Controls phone number collection settings during checkout. @@ -34277,329 +34028,329 @@ export type operations = { * We recommend that you review your privacy policy and check with your legal contacts. */ phone_number_collection?: { - enabled: boolean; - }; + enabled: boolean + } /** * shipping_address_collection_params * @description Configuration for collecting the customer's shipping address. */ shipping_address_collection?: { allowed_countries: ( - | "AC" - | "AD" - | "AE" - | "AF" - | "AG" - | "AI" - | "AL" - | "AM" - | "AO" - | "AQ" - | "AR" - | "AT" - | "AU" - | "AW" - | "AX" - | "AZ" - | "BA" - | "BB" - | "BD" - | "BE" - | "BF" - | "BG" - | "BH" - | "BI" - | "BJ" - | "BL" - | "BM" - | "BN" - | "BO" - | "BQ" - | "BR" - | "BS" - | "BT" - | "BV" - | "BW" - | "BY" - | "BZ" - | "CA" - | "CD" - | "CF" - | "CG" - | "CH" - | "CI" - | "CK" - | "CL" - | "CM" - | "CN" - | "CO" - | "CR" - | "CV" - | "CW" - | "CY" - | "CZ" - | "DE" - | "DJ" - | "DK" - | "DM" - | "DO" - | "DZ" - | "EC" - | "EE" - | "EG" - | "EH" - | "ER" - | "ES" - | "ET" - | "FI" - | "FJ" - | "FK" - | "FO" - | "FR" - | "GA" - | "GB" - | "GD" - | "GE" - | "GF" - | "GG" - | "GH" - | "GI" - | "GL" - | "GM" - | "GN" - | "GP" - | "GQ" - | "GR" - | "GS" - | "GT" - | "GU" - | "GW" - | "GY" - | "HK" - | "HN" - | "HR" - | "HT" - | "HU" - | "ID" - | "IE" - | "IL" - | "IM" - | "IN" - | "IO" - | "IQ" - | "IS" - | "IT" - | "JE" - | "JM" - | "JO" - | "JP" - | "KE" - | "KG" - | "KH" - | "KI" - | "KM" - | "KN" - | "KR" - | "KW" - | "KY" - | "KZ" - | "LA" - | "LB" - | "LC" - | "LI" - | "LK" - | "LR" - | "LS" - | "LT" - | "LU" - | "LV" - | "LY" - | "MA" - | "MC" - | "MD" - | "ME" - | "MF" - | "MG" - | "MK" - | "ML" - | "MM" - | "MN" - | "MO" - | "MQ" - | "MR" - | "MS" - | "MT" - | "MU" - | "MV" - | "MW" - | "MX" - | "MY" - | "MZ" - | "NA" - | "NC" - | "NE" - | "NG" - | "NI" - | "NL" - | "NO" - | "NP" - | "NR" - | "NU" - | "NZ" - | "OM" - | "PA" - | "PE" - | "PF" - | "PG" - | "PH" - | "PK" - | "PL" - | "PM" - | "PN" - | "PR" - | "PS" - | "PT" - | "PY" - | "QA" - | "RE" - | "RO" - | "RS" - | "RU" - | "RW" - | "SA" - | "SB" - | "SC" - | "SE" - | "SG" - | "SH" - | "SI" - | "SJ" - | "SK" - | "SL" - | "SM" - | "SN" - | "SO" - | "SR" - | "SS" - | "ST" - | "SV" - | "SX" - | "SZ" - | "TA" - | "TC" - | "TD" - | "TF" - | "TG" - | "TH" - | "TJ" - | "TK" - | "TL" - | "TM" - | "TN" - | "TO" - | "TR" - | "TT" - | "TV" - | "TW" - | "TZ" - | "UA" - | "UG" - | "US" - | "UY" - | "UZ" - | "VA" - | "VC" - | "VE" - | "VG" - | "VN" - | "VU" - | "WF" - | "WS" - | "XK" - | "YE" - | "YT" - | "ZA" - | "ZM" - | "ZW" - | "ZZ" - )[]; - }; + | 'AC' + | 'AD' + | 'AE' + | 'AF' + | 'AG' + | 'AI' + | 'AL' + | 'AM' + | 'AO' + | 'AQ' + | 'AR' + | 'AT' + | 'AU' + | 'AW' + | 'AX' + | 'AZ' + | 'BA' + | 'BB' + | 'BD' + | 'BE' + | 'BF' + | 'BG' + | 'BH' + | 'BI' + | 'BJ' + | 'BL' + | 'BM' + | 'BN' + | 'BO' + | 'BQ' + | 'BR' + | 'BS' + | 'BT' + | 'BV' + | 'BW' + | 'BY' + | 'BZ' + | 'CA' + | 'CD' + | 'CF' + | 'CG' + | 'CH' + | 'CI' + | 'CK' + | 'CL' + | 'CM' + | 'CN' + | 'CO' + | 'CR' + | 'CV' + | 'CW' + | 'CY' + | 'CZ' + | 'DE' + | 'DJ' + | 'DK' + | 'DM' + | 'DO' + | 'DZ' + | 'EC' + | 'EE' + | 'EG' + | 'EH' + | 'ER' + | 'ES' + | 'ET' + | 'FI' + | 'FJ' + | 'FK' + | 'FO' + | 'FR' + | 'GA' + | 'GB' + | 'GD' + | 'GE' + | 'GF' + | 'GG' + | 'GH' + | 'GI' + | 'GL' + | 'GM' + | 'GN' + | 'GP' + | 'GQ' + | 'GR' + | 'GS' + | 'GT' + | 'GU' + | 'GW' + | 'GY' + | 'HK' + | 'HN' + | 'HR' + | 'HT' + | 'HU' + | 'ID' + | 'IE' + | 'IL' + | 'IM' + | 'IN' + | 'IO' + | 'IQ' + | 'IS' + | 'IT' + | 'JE' + | 'JM' + | 'JO' + | 'JP' + | 'KE' + | 'KG' + | 'KH' + | 'KI' + | 'KM' + | 'KN' + | 'KR' + | 'KW' + | 'KY' + | 'KZ' + | 'LA' + | 'LB' + | 'LC' + | 'LI' + | 'LK' + | 'LR' + | 'LS' + | 'LT' + | 'LU' + | 'LV' + | 'LY' + | 'MA' + | 'MC' + | 'MD' + | 'ME' + | 'MF' + | 'MG' + | 'MK' + | 'ML' + | 'MM' + | 'MN' + | 'MO' + | 'MQ' + | 'MR' + | 'MS' + | 'MT' + | 'MU' + | 'MV' + | 'MW' + | 'MX' + | 'MY' + | 'MZ' + | 'NA' + | 'NC' + | 'NE' + | 'NG' + | 'NI' + | 'NL' + | 'NO' + | 'NP' + | 'NR' + | 'NU' + | 'NZ' + | 'OM' + | 'PA' + | 'PE' + | 'PF' + | 'PG' + | 'PH' + | 'PK' + | 'PL' + | 'PM' + | 'PN' + | 'PR' + | 'PS' + | 'PT' + | 'PY' + | 'QA' + | 'RE' + | 'RO' + | 'RS' + | 'RU' + | 'RW' + | 'SA' + | 'SB' + | 'SC' + | 'SE' + | 'SG' + | 'SH' + | 'SI' + | 'SJ' + | 'SK' + | 'SL' + | 'SM' + | 'SN' + | 'SO' + | 'SR' + | 'SS' + | 'ST' + | 'SV' + | 'SX' + | 'SZ' + | 'TA' + | 'TC' + | 'TD' + | 'TF' + | 'TG' + | 'TH' + | 'TJ' + | 'TK' + | 'TL' + | 'TM' + | 'TN' + | 'TO' + | 'TR' + | 'TT' + | 'TV' + | 'TW' + | 'TZ' + | 'UA' + | 'UG' + | 'US' + | 'UY' + | 'UZ' + | 'VA' + | 'VC' + | 'VE' + | 'VG' + | 'VN' + | 'VU' + | 'WF' + | 'WS' + | 'XK' + | 'YE' + | 'YT' + | 'ZA' + | 'ZM' + | 'ZW' + | 'ZZ' + )[] + } /** * subscription_data_params * @description 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?: { - trial_period_days?: number; - }; + trial_period_days?: number + } /** * transfer_data_params * @description 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?: { - amount?: number; - destination: string; - }; - }; - }; - }; - }; + amount?: number + destination: string + } + } + } + } + } /**

Retrieve a payment link.

*/ GetPaymentLinksPaymentLink: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - payment_link: string; - }; - }; + payment_link: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_link"]; - }; - }; + 'application/json': components['schemas']['payment_link'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates a payment link.

*/ PostPaymentLinksPaymentLink: { parameters: { path: { - payment_link: string; - }; - }; + payment_link: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_link"]; - }; - }; + 'application/json': components['schemas']['payment_link'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description 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?: boolean; + active?: boolean /** * after_completion_params * @description Behavior after the purchase is complete. @@ -34607,410 +34358,410 @@ export type operations = { after_completion?: { /** after_completion_confirmation_page_params */ hosted_confirmation?: { - custom_message?: string; - }; + custom_message?: string + } /** after_completion_redirect_params */ redirect?: { - url: string; - }; + url: string + } /** @enum {string} */ - type: "hosted_confirmation" | "redirect"; - }; + type: 'hosted_confirmation' | 'redirect' + } /** @description Enables user redeemable promotion codes. */ - allow_promotion_codes?: boolean; + allow_promotion_codes?: boolean /** * automatic_tax_params * @description Configuration for automatic tax collection. */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** * @description Configuration for collecting the customer's billing address. * @enum {string} */ - billing_address_collection?: "auto" | "required"; + billing_address_collection?: 'auto' | 'required' /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported. */ line_items?: { /** adjustable_quantity_params */ adjustable_quantity?: { - enabled: boolean; - maximum?: number; - minimum?: number; - }; - id: string; - quantity?: number; - }[]; + enabled: boolean + maximum?: number + minimum?: number + } + id: string + quantity?: number + }[] /** @description 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 associated with this Payment Link will automatically be copied to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link. */ - metadata?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The list of payment method types that customers can use. Only `card` is supported. Pass an empty string to enable automatic payment methods that use your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). */ - payment_method_types?: Partial<"card"[]> & Partial<"">; + payment_method_types?: Partial<'card'[]> & Partial<''> /** @description Configuration for collecting the customer's shipping address. */ shipping_address_collection?: Partial<{ allowed_countries: ( - | "AC" - | "AD" - | "AE" - | "AF" - | "AG" - | "AI" - | "AL" - | "AM" - | "AO" - | "AQ" - | "AR" - | "AT" - | "AU" - | "AW" - | "AX" - | "AZ" - | "BA" - | "BB" - | "BD" - | "BE" - | "BF" - | "BG" - | "BH" - | "BI" - | "BJ" - | "BL" - | "BM" - | "BN" - | "BO" - | "BQ" - | "BR" - | "BS" - | "BT" - | "BV" - | "BW" - | "BY" - | "BZ" - | "CA" - | "CD" - | "CF" - | "CG" - | "CH" - | "CI" - | "CK" - | "CL" - | "CM" - | "CN" - | "CO" - | "CR" - | "CV" - | "CW" - | "CY" - | "CZ" - | "DE" - | "DJ" - | "DK" - | "DM" - | "DO" - | "DZ" - | "EC" - | "EE" - | "EG" - | "EH" - | "ER" - | "ES" - | "ET" - | "FI" - | "FJ" - | "FK" - | "FO" - | "FR" - | "GA" - | "GB" - | "GD" - | "GE" - | "GF" - | "GG" - | "GH" - | "GI" - | "GL" - | "GM" - | "GN" - | "GP" - | "GQ" - | "GR" - | "GS" - | "GT" - | "GU" - | "GW" - | "GY" - | "HK" - | "HN" - | "HR" - | "HT" - | "HU" - | "ID" - | "IE" - | "IL" - | "IM" - | "IN" - | "IO" - | "IQ" - | "IS" - | "IT" - | "JE" - | "JM" - | "JO" - | "JP" - | "KE" - | "KG" - | "KH" - | "KI" - | "KM" - | "KN" - | "KR" - | "KW" - | "KY" - | "KZ" - | "LA" - | "LB" - | "LC" - | "LI" - | "LK" - | "LR" - | "LS" - | "LT" - | "LU" - | "LV" - | "LY" - | "MA" - | "MC" - | "MD" - | "ME" - | "MF" - | "MG" - | "MK" - | "ML" - | "MM" - | "MN" - | "MO" - | "MQ" - | "MR" - | "MS" - | "MT" - | "MU" - | "MV" - | "MW" - | "MX" - | "MY" - | "MZ" - | "NA" - | "NC" - | "NE" - | "NG" - | "NI" - | "NL" - | "NO" - | "NP" - | "NR" - | "NU" - | "NZ" - | "OM" - | "PA" - | "PE" - | "PF" - | "PG" - | "PH" - | "PK" - | "PL" - | "PM" - | "PN" - | "PR" - | "PS" - | "PT" - | "PY" - | "QA" - | "RE" - | "RO" - | "RS" - | "RU" - | "RW" - | "SA" - | "SB" - | "SC" - | "SE" - | "SG" - | "SH" - | "SI" - | "SJ" - | "SK" - | "SL" - | "SM" - | "SN" - | "SO" - | "SR" - | "SS" - | "ST" - | "SV" - | "SX" - | "SZ" - | "TA" - | "TC" - | "TD" - | "TF" - | "TG" - | "TH" - | "TJ" - | "TK" - | "TL" - | "TM" - | "TN" - | "TO" - | "TR" - | "TT" - | "TV" - | "TW" - | "TZ" - | "UA" - | "UG" - | "US" - | "UY" - | "UZ" - | "VA" - | "VC" - | "VE" - | "VG" - | "VN" - | "VU" - | "WF" - | "WS" - | "XK" - | "YE" - | "YT" - | "ZA" - | "ZM" - | "ZW" - | "ZZ" - )[]; + | 'AC' + | 'AD' + | 'AE' + | 'AF' + | 'AG' + | 'AI' + | 'AL' + | 'AM' + | 'AO' + | 'AQ' + | 'AR' + | 'AT' + | 'AU' + | 'AW' + | 'AX' + | 'AZ' + | 'BA' + | 'BB' + | 'BD' + | 'BE' + | 'BF' + | 'BG' + | 'BH' + | 'BI' + | 'BJ' + | 'BL' + | 'BM' + | 'BN' + | 'BO' + | 'BQ' + | 'BR' + | 'BS' + | 'BT' + | 'BV' + | 'BW' + | 'BY' + | 'BZ' + | 'CA' + | 'CD' + | 'CF' + | 'CG' + | 'CH' + | 'CI' + | 'CK' + | 'CL' + | 'CM' + | 'CN' + | 'CO' + | 'CR' + | 'CV' + | 'CW' + | 'CY' + | 'CZ' + | 'DE' + | 'DJ' + | 'DK' + | 'DM' + | 'DO' + | 'DZ' + | 'EC' + | 'EE' + | 'EG' + | 'EH' + | 'ER' + | 'ES' + | 'ET' + | 'FI' + | 'FJ' + | 'FK' + | 'FO' + | 'FR' + | 'GA' + | 'GB' + | 'GD' + | 'GE' + | 'GF' + | 'GG' + | 'GH' + | 'GI' + | 'GL' + | 'GM' + | 'GN' + | 'GP' + | 'GQ' + | 'GR' + | 'GS' + | 'GT' + | 'GU' + | 'GW' + | 'GY' + | 'HK' + | 'HN' + | 'HR' + | 'HT' + | 'HU' + | 'ID' + | 'IE' + | 'IL' + | 'IM' + | 'IN' + | 'IO' + | 'IQ' + | 'IS' + | 'IT' + | 'JE' + | 'JM' + | 'JO' + | 'JP' + | 'KE' + | 'KG' + | 'KH' + | 'KI' + | 'KM' + | 'KN' + | 'KR' + | 'KW' + | 'KY' + | 'KZ' + | 'LA' + | 'LB' + | 'LC' + | 'LI' + | 'LK' + | 'LR' + | 'LS' + | 'LT' + | 'LU' + | 'LV' + | 'LY' + | 'MA' + | 'MC' + | 'MD' + | 'ME' + | 'MF' + | 'MG' + | 'MK' + | 'ML' + | 'MM' + | 'MN' + | 'MO' + | 'MQ' + | 'MR' + | 'MS' + | 'MT' + | 'MU' + | 'MV' + | 'MW' + | 'MX' + | 'MY' + | 'MZ' + | 'NA' + | 'NC' + | 'NE' + | 'NG' + | 'NI' + | 'NL' + | 'NO' + | 'NP' + | 'NR' + | 'NU' + | 'NZ' + | 'OM' + | 'PA' + | 'PE' + | 'PF' + | 'PG' + | 'PH' + | 'PK' + | 'PL' + | 'PM' + | 'PN' + | 'PR' + | 'PS' + | 'PT' + | 'PY' + | 'QA' + | 'RE' + | 'RO' + | 'RS' + | 'RU' + | 'RW' + | 'SA' + | 'SB' + | 'SC' + | 'SE' + | 'SG' + | 'SH' + | 'SI' + | 'SJ' + | 'SK' + | 'SL' + | 'SM' + | 'SN' + | 'SO' + | 'SR' + | 'SS' + | 'ST' + | 'SV' + | 'SX' + | 'SZ' + | 'TA' + | 'TC' + | 'TD' + | 'TF' + | 'TG' + | 'TH' + | 'TJ' + | 'TK' + | 'TL' + | 'TM' + | 'TN' + | 'TO' + | 'TR' + | 'TT' + | 'TV' + | 'TW' + | 'TZ' + | 'UA' + | 'UG' + | 'US' + | 'UY' + | 'UZ' + | 'VA' + | 'VC' + | 'VE' + | 'VG' + | 'VN' + | 'VU' + | 'WF' + | 'WS' + | 'XK' + | 'YE' + | 'YT' + | 'ZA' + | 'ZM' + | 'ZW' + | 'ZZ' + )[] }> & - Partial<"">; - }; - }; - }; - }; + Partial<''> + } + } + } + } /**

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.

*/ GetPaymentLinksPaymentLinkLineItems: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - payment_link: string; - }; - }; + payment_link: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["item"][]; + data: components['schemas']['item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of PaymentMethods. For listing a customer’s payment methods, you should use List a Customer’s PaymentMethods

*/ GetPaymentMethods: { parameters: { query: { /** The ID of the customer whose PaymentMethods will be retrieved. If not provided, the response list will be empty. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** A required filter on the list, based on the object `type` field. */ type: - | "acss_debit" - | "afterpay_clearpay" - | "alipay" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "eps" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "klarna" - | "oxxo" - | "p24" - | "sepa_debit" - | "sofort" - | "wechat_pay"; - }; - }; - responses: { - /** Successful response. */ - 200: { - content: { - "application/json": { - data: components["schemas"]["payment_method"][]; + | 'acss_debit' + | 'afterpay_clearpay' + | 'alipay' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'eps' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'klarna' + | 'oxxo' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' + } + } + responses: { + /** Successful response. */ + 200: { + content: { + 'application/json': { + data: components['schemas']['payment_method'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Creates a PaymentMethod object. Read the Stripe.js reference to learn how to create PaymentMethods via Stripe.js.

* @@ -35021,96 +34772,96 @@ export type operations = { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_method"]; - }; - }; + 'application/json': components['schemas']['payment_method'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * payment_method_param * @description If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. */ acss_debit?: { - account_number: string; - institution_number: string; - transit_number: string; - }; + account_number: string + institution_number: string + transit_number: string + } /** * param * @description If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method. */ - afterpay_clearpay?: { [key: string]: unknown }; + afterpay_clearpay?: { [key: string]: unknown } /** * param * @description If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method. */ - alipay?: { [key: string]: unknown }; + alipay?: { [key: string]: unknown } /** * param * @description If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account. */ au_becs_debit?: { - account_number: string; - bsb_number: string; - }; + account_number: string + bsb_number: string + } /** * param * @description If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account. */ bacs_debit?: { - account_number?: string; - sort_code?: string; - }; + account_number?: string + sort_code?: string + } /** * param * @description If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method. */ - bancontact?: { [key: string]: unknown }; + bancontact?: { [key: string]: unknown } /** * billing_details_inner_params * @description Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods. */ billing_details?: { address?: Partial<{ - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string }> & - Partial<"">; - email?: Partial & Partial<"">; - name?: string; - phone?: string; - }; + Partial<''> + email?: Partial & Partial<''> + name?: string + phone?: string + } /** * param * @description If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method. */ boleto?: { - tax_id: string; - }; + tax_id: string + } /** @description If this is a `card` PaymentMethod, this hash contains the user's card details. For backwards compatibility, you can alternatively provide a Stripe token (e.g., for Apple Pay, Amex Express Checkout, or legacy Checkout) into the card hash with format `card: {token: "tok_visa"}`. When providing a card number, you must meet the requirements for [PCI compliance](https://stripe.com/docs/security#validating-pci-compliance). We strongly recommend using Stripe.js instead of interacting with this API directly. */ card?: Partial<{ - cvc?: string; - exp_month: number; - exp_year: number; - number: string; + cvc?: string + exp_month: number + exp_year: number + number: string }> & Partial<{ - token: string; - }>; + token: string + }> /** @description The `Customer` to whom the original PaymentMethod is attached. */ - customer?: string; + customer?: string /** * param * @description If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method. @@ -35118,36 +34869,36 @@ export type operations = { eps?: { /** @enum {string} */ bank?: - | "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" - | "dolomitenbank" - | "easybank_ag" - | "erste_bank_und_sparkassen" - | "hypo_alpeadriabank_international_ag" - | "hypo_bank_burgenland_aktiengesellschaft" - | "hypo_noe_lb_fur_niederosterreich_u_wien" - | "hypo_oberosterreich_salzburg_steiermark" - | "hypo_tirol_bank_ag" - | "hypo_vorarlberg_bank_ag" - | "marchfelder_bank" - | "oberbank_ag" - | "raiffeisen_bankengruppe_osterreich" - | "schoellerbank_ag" - | "sparda_bank_wien" - | "volksbank_gruppe" - | "volkskreditbank_ag" - | "vr_bank_braunau"; - }; + | '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' + | 'dolomitenbank' + | 'easybank_ag' + | 'erste_bank_und_sparkassen' + | 'hypo_alpeadriabank_international_ag' + | 'hypo_bank_burgenland_aktiengesellschaft' + | 'hypo_noe_lb_fur_niederosterreich_u_wien' + | 'hypo_oberosterreich_salzburg_steiermark' + | 'hypo_tirol_bank_ag' + | 'hypo_vorarlberg_bank_ag' + | 'marchfelder_bank' + | 'oberbank_ag' + | 'raiffeisen_bankengruppe_osterreich' + | 'schoellerbank_ag' + | 'sparda_bank_wien' + | 'volksbank_gruppe' + | 'volkskreditbank_ag' + | 'vr_bank_braunau' + } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * param * @description If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method. @@ -35155,38 +34906,38 @@ export type operations = { fpx?: { /** @enum {string} */ bank: - | "affin_bank" - | "agrobank" - | "alliance_bank" - | "ambank" - | "bank_islam" - | "bank_muamalat" - | "bank_rakyat" - | "bsn" - | "cimb" - | "deutsche_bank" - | "hong_leong_bank" - | "hsbc" - | "kfh" - | "maybank2e" - | "maybank2u" - | "ocbc" - | "pb_enterprise" - | "public_bank" - | "rhb" - | "standard_chartered" - | "uob"; - }; + | 'affin_bank' + | 'agrobank' + | 'alliance_bank' + | 'ambank' + | 'bank_islam' + | 'bank_muamalat' + | 'bank_rakyat' + | 'bsn' + | 'cimb' + | 'deutsche_bank' + | 'hong_leong_bank' + | 'hsbc' + | 'kfh' + | 'maybank2e' + | 'maybank2u' + | 'ocbc' + | 'pb_enterprise' + | 'public_bank' + | 'rhb' + | 'standard_chartered' + | 'uob' + } /** * param * @description If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method. */ - giropay?: { [key: string]: unknown }; + giropay?: { [key: string]: unknown } /** * param * @description If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method. */ - grabpay?: { [key: string]: unknown }; + grabpay?: { [key: string]: unknown } /** * param * @description If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method. @@ -35194,25 +34945,25 @@ export type operations = { ideal?: { /** @enum {string} */ bank?: - | "abn_amro" - | "asn_bank" - | "bunq" - | "handelsbanken" - | "ing" - | "knab" - | "moneyou" - | "rabobank" - | "regiobank" - | "revolut" - | "sns_bank" - | "triodos_bank" - | "van_lanschot"; - }; + | 'abn_amro' + | 'asn_bank' + | 'bunq' + | 'handelsbanken' + | 'ing' + | 'knab' + | 'moneyou' + | 'rabobank' + | 'regiobank' + | 'revolut' + | 'sns_bank' + | 'triodos_bank' + | 'van_lanschot' + } /** * param * @description If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method. */ - interac_present?: { [key: string]: unknown }; + interac_present?: { [key: string]: unknown } /** * param * @description If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method. @@ -35220,18 +34971,18 @@ export type operations = { klarna?: { /** date_of_birth */ dob?: { - day: number; - month: number; - year: number; - }; - }; + day: number + month: number + year: number + } + } /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * param * @description If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method. */ - oxxo?: { [key: string]: unknown }; + oxxo?: { [key: string]: unknown } /** * param * @description If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method. @@ -35239,171 +34990,171 @@ export type operations = { p24?: { /** @enum {string} */ bank?: - | "alior_bank" - | "bank_millennium" - | "bank_nowy_bfg_sa" - | "bank_pekao_sa" - | "banki_spbdzielcze" - | "blik" - | "bnp_paribas" - | "boz" - | "citi_handlowy" - | "credit_agricole" - | "envelobank" - | "etransfer_pocztowy24" - | "getin_bank" - | "ideabank" - | "ing" - | "inteligo" - | "mbank_mtransfer" - | "nest_przelew" - | "noble_pay" - | "pbac_z_ipko" - | "plus_bank" - | "santander_przelew24" - | "tmobile_usbugi_bankowe" - | "toyota_bank" - | "volkswagen_bank"; - }; + | 'alior_bank' + | 'bank_millennium' + | 'bank_nowy_bfg_sa' + | 'bank_pekao_sa' + | 'banki_spbdzielcze' + | 'blik' + | 'bnp_paribas' + | 'boz' + | 'citi_handlowy' + | 'credit_agricole' + | 'envelobank' + | 'etransfer_pocztowy24' + | 'getin_bank' + | 'ideabank' + | 'ing' + | 'inteligo' + | 'mbank_mtransfer' + | 'nest_przelew' + | 'noble_pay' + | 'pbac_z_ipko' + | 'plus_bank' + | 'santander_przelew24' + | 'tmobile_usbugi_bankowe' + | 'toyota_bank' + | 'volkswagen_bank' + } /** @description The PaymentMethod to share. */ - payment_method?: string; + payment_method?: string /** * param * @description If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account. */ sepa_debit?: { - iban: string; - }; + iban: string + } /** * param * @description If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method. */ sofort?: { /** @enum {string} */ - country: "AT" | "BE" | "DE" | "ES" | "IT" | "NL"; - }; + country: 'AT' | 'BE' | 'DE' | 'ES' | 'IT' | 'NL' + } /** * @description 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. * @enum {string} */ type?: - | "acss_debit" - | "afterpay_clearpay" - | "alipay" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "eps" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "klarna" - | "oxxo" - | "p24" - | "sepa_debit" - | "sofort" - | "wechat_pay"; + | 'acss_debit' + | 'afterpay_clearpay' + | 'alipay' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'eps' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'klarna' + | 'oxxo' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' /** * param * @description If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method. */ - wechat_pay?: { [key: string]: unknown }; - }; - }; - }; - }; + wechat_pay?: { [key: string]: unknown } + } + } + } + } /**

Retrieves a PaymentMethod object.

*/ GetPaymentMethodsPaymentMethod: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - payment_method: string; - }; - }; + payment_method: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_method"]; - }; - }; + 'application/json': components['schemas']['payment_method'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostPaymentMethodsPaymentMethod: { parameters: { path: { - payment_method: string; - }; - }; + payment_method: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_method"]; - }; - }; + 'application/json': components['schemas']['payment_method'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * billing_details_inner_params * @description Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods. */ billing_details?: { address?: Partial<{ - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string }> & - Partial<"">; - email?: Partial & Partial<"">; - name?: string; - phone?: string; - }; + Partial<''> + email?: Partial & Partial<''> + name?: string + phone?: string + } /** * update_api_param * @description If this is a `card` PaymentMethod, this hash contains the user's card details. */ card?: { - exp_month?: number; - exp_year?: number; - }; + exp_month?: number + exp_year?: number + } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /** *

Attaches a PaymentMethod object to a Customer.

* @@ -35420,127 +35171,127 @@ export type operations = { PostPaymentMethodsPaymentMethodAttach: { parameters: { path: { - payment_method: string; - }; - }; + payment_method: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_method"]; - }; - }; + 'application/json': components['schemas']['payment_method'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The ID of the customer to which to attach the PaymentMethod. */ - customer: string; + customer: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Detaches a PaymentMethod object from a Customer.

*/ PostPaymentMethodsPaymentMethodDetach: { parameters: { path: { - payment_method: string; - }; - }; + payment_method: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_method"]; - }; - }; + 'application/json': components['schemas']['payment_method'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Returns a list of existing payouts sent to third-party bank accounts or that Stripe has sent you. The payouts are returned in sorted order, with the most recently created payouts appearing first.

*/ GetPayouts: { parameters: { query: { arrival_date?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** The ID of an external account - only return payouts sent to this external account. */ - destination?: string; + destination?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return payouts that have the given status: `pending`, `paid`, `failed`, or `canceled`. */ - status?: string; - }; - }; + status?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["payout"][]; + 'application/json': { + data: components['schemas']['payout'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

To send funds to your own bank account, you create a new payout object. Your Stripe balance must be able to cover the payout amount, or you’ll receive an “Insufficient Funds” error.

* @@ -35553,140 +35304,140 @@ export type operations = { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payout"]; - }; - }; + 'application/json': components['schemas']['payout'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A positive integer in cents representing how much to payout. */ - amount: number; + amount: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description The ID of a bank account or a card to send the payout to. If no destination is supplied, the default external account for the specified currency will be used. */ - destination?: string; + destination?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * @description The method used to send this payout, which can be `standard` or `instant`. `instant` is only supported for payouts to debit cards. (See [Instant payouts for marketplaces for more information](https://stripe.com/blog/instant-payouts-for-marketplaces).) * @enum {string} */ - method?: "instant" | "standard"; + method?: 'instant' | 'standard' /** * @description The balance type of your Stripe balance to draw this payout from. Balances for different payment sources are kept separately. You can find the amounts with the balances API. One of `bank_account`, `card`, or `fpx`. * @enum {string} */ - source_type?: "bank_account" | "card" | "fpx"; + source_type?: 'bank_account' | 'card' | 'fpx' /** @description A string to be displayed on the recipient's bank or card statement. This may be at most 22 characters. Attempting to use a `statement_descriptor` longer than 22 characters will return an error. Note: Most banks will truncate this information and/or display it inconsistently. Some may not display it at all. */ - statement_descriptor?: string; - }; - }; - }; - }; + statement_descriptor?: string + } + } + } + } /**

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

*/ GetPayoutsPayout: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - payout: string; - }; - }; + payout: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payout"]; - }; - }; + 'application/json': components['schemas']['payout'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates the specified payout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request accepts only the metadata as arguments.

*/ PostPayoutsPayout: { parameters: { path: { - payout: string; - }; - }; + payout: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payout"]; - }; - }; + 'application/json': components['schemas']['payout'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

A previously created payout can be canceled if it has not yet been paid out. Funds will be refunded to your available balance. You may not cancel automatic Stripe payouts.

*/ PostPayoutsPayoutCancel: { parameters: { path: { - payout: string; - }; - }; + payout: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payout"]; - }; - }; + 'application/json': components['schemas']['payout'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /** *

Reverses a payout by debiting the destination bank account. Only payouts for connected accounts to US bank accounts may be reversed at this time. If the payout is in the pending status, /v1/payouts/:id/cancel should be used instead.

* @@ -35695,1556 +35446,1556 @@ export type operations = { PostPayoutsPayoutReverse: { parameters: { path: { - payout: string; - }; - }; + payout: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payout"]; - }; - }; + 'application/json': components['schemas']['payout'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; - }; - }; - }; - }; + metadata?: { [key: string]: string } + } + } + } + } /**

Returns a list of your plans.

*/ GetPlans: { parameters: { query: { /** Only return plans that are active or inactive (e.g., pass `false` to list all inactive plans). */ - active?: boolean; + active?: boolean /** 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?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return plans for the given product. */ - product?: string; + product?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["plan"][]; + data: components['schemas']['plan'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostPlans: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["plan"]; - }; - }; + 'application/json': components['schemas']['plan'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether the plan is currently available for new subscriptions. Defaults to `true`. */ - active?: boolean; + active?: boolean /** * @description 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`. * @enum {string} */ - aggregate_usage?: "last_during_period" | "last_ever" | "max" | "sum"; + aggregate_usage?: 'last_during_period' | 'last_ever' | 'max' | 'sum' /** @description A positive integer in %s (or 0 for a free plan) representing how much to charge on a recurring basis. */ - amount?: number; + amount?: number /** * Format: decimal * @description Same as `amount`, but accepts a decimal value with at most 12 decimal places. Only one of `amount` and `amount_decimal` can be set. */ - amount_decimal?: string; + amount_decimal?: string /** * @description 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. * @enum {string} */ - billing_scheme?: "per_unit" | "tiered"; + billing_scheme?: 'per_unit' | 'tiered' /** @description 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: string; + currency: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description An identifier randomly generated by Stripe. Used to identify this plan when subscribing a customer. You can optionally override this ID, but the ID must be unique across all plans in your Stripe account. You can, however, use the same plan ID in both live and test modes. */ - id?: string; + id?: string /** * @description Specifies billing frequency. Either `day`, `week`, `month` or `year`. * @enum {string} */ - interval: "day" | "month" | "week" | "year"; + interval: 'day' | 'month' | 'week' | 'year' /** @description The number of intervals between subscription billings. 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?: number; + interval_count?: number /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description A brief description of the plan, hidden from customers. */ - nickname?: string; + nickname?: string product?: Partial<{ - active?: boolean; - id?: string; - metadata?: { [key: string]: string }; - name: string; - statement_descriptor?: string; - tax_code?: string; - unit_label?: string; + active?: boolean + id?: string + metadata?: { [key: string]: string } + name: string + statement_descriptor?: string + tax_code?: string + unit_label?: string }> & - Partial; + Partial /** @description Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. */ tiers?: { - flat_amount?: number; + flat_amount?: number /** Format: decimal */ - flat_amount_decimal?: string; - unit_amount?: number; + flat_amount_decimal?: string + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - up_to: Partial<"inf"> & Partial; - }[]; + unit_amount_decimal?: string + up_to: Partial<'inf'> & Partial + }[] /** * @description 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 successively change as the quantity grows. * @enum {string} */ - tiers_mode?: "graduated" | "volume"; + tiers_mode?: 'graduated' | 'volume' /** * transform_usage_param * @description Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`. */ transform_usage?: { - divide_by: number; + divide_by: number /** @enum {string} */ - round: "down" | "up"; - }; + round: 'down' | 'up' + } /** @description 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?: number; + trial_period_days?: number /** * @description 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`. * @enum {string} */ - usage_type?: "licensed" | "metered"; - }; - }; - }; - }; + usage_type?: 'licensed' | 'metered' + } + } + } + } /**

Retrieves the plan with the given ID.

*/ GetPlansPlan: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - plan: string; - }; - }; + plan: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["plan"]; - }; - }; + 'application/json': components['schemas']['plan'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostPlansPlan: { parameters: { path: { - plan: string; - }; - }; + plan: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["plan"]; - }; - }; + 'application/json': components['schemas']['plan'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether the plan is currently available for new subscriptions. */ - active?: boolean; + active?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description A brief description of the plan, hidden from customers. */ - nickname?: string; + nickname?: string /** @description The product the plan belongs to. This cannot be changed once it has been used in a subscription or subscription schedule. */ - product?: string; + product?: string /** @description 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?: number; - }; - }; - }; - }; + trial_period_days?: number + } + } + } + } /**

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

*/ DeletePlansPlan: { parameters: { path: { - plan: string; - }; - }; + plan: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_plan"]; - }; - }; + 'application/json': components['schemas']['deleted_plan'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of your prices.

*/ GetPrices: { parameters: { query: { /** Only return prices that are active or inactive (e.g., pass `false` to list all inactive prices). */ - active?: boolean; + active?: boolean /** 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?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** Only return prices for the given currency. */ - currency?: string; + currency?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return the price with these lookup_keys, if any exist. */ - lookup_keys?: string[]; + lookup_keys?: string[] /** Only return prices for the given product. */ - product?: string; + product?: string /** Only return prices with these recurring fields. */ recurring?: { /** @enum {string} */ - interval?: "day" | "month" | "week" | "year"; + interval?: 'day' | 'month' | 'week' | 'year' /** @enum {string} */ - usage_type?: "licensed" | "metered"; - }; + usage_type?: 'licensed' | 'metered' + } /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return prices of type `recurring` or `one_time`. */ - type?: "one_time" | "recurring"; - }; - }; + type?: 'one_time' | 'recurring' + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["price"][]; + data: components['schemas']['price'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostPrices: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["price"]; - }; - }; + 'application/json': components['schemas']['price'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether the price can be used for new purchases. Defaults to `true`. */ - active?: boolean; + active?: boolean /** * @description 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. * @enum {string} */ - billing_scheme?: "per_unit" | "tiered"; + billing_scheme?: 'per_unit' | 'tiered' /** @description 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: string; + currency: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters. */ - lookup_key?: string; + lookup_key?: string /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description A brief description of the price, hidden from customers. */ - nickname?: string; + nickname?: string /** @description The ID of the product that this price will belong to. */ - product?: string; + product?: string /** * inline_product_params * @description These fields can be used to create a new product that this price will belong to. */ product_data?: { - active?: boolean; - id?: string; - metadata?: { [key: string]: string }; - name: string; - statement_descriptor?: string; - tax_code?: string; - unit_label?: string; - }; + active?: boolean + id?: string + metadata?: { [key: string]: string } + name: string + statement_descriptor?: string + tax_code?: string + unit_label?: string + } /** * recurring * @description The recurring components of a price such as `interval` and `usage_type`. */ recurring?: { /** @enum {string} */ - aggregate_usage?: "last_during_period" | "last_ever" | "max" | "sum"; + aggregate_usage?: 'last_during_period' | 'last_ever' | 'max' | 'sum' /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number /** @enum {string} */ - usage_type?: "licensed" | "metered"; - }; + usage_type?: 'licensed' | 'metered' + } /** * @description 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. * @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' /** @description Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. */ tiers?: { - flat_amount?: number; + flat_amount?: number /** Format: decimal */ - flat_amount_decimal?: string; - unit_amount?: number; + flat_amount_decimal?: string + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - up_to: Partial<"inf"> & Partial; - }[]; + unit_amount_decimal?: string + up_to: Partial<'inf'> & Partial + }[] /** * @description 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 successively change as the quantity grows. * @enum {string} */ - tiers_mode?: "graduated" | "volume"; + tiers_mode?: 'graduated' | 'volume' /** @description If set to true, will atomically remove the lookup key from the existing price, and assign it to this price. */ - transfer_lookup_key?: boolean; + transfer_lookup_key?: boolean /** * transform_usage_param * @description Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`. */ transform_quantity?: { - divide_by: number; + divide_by: number /** @enum {string} */ - round: "down" | "up"; - }; + round: 'down' | 'up' + } /** @description A positive integer in %s (or 0 for a free price) representing how much to charge. */ - unit_amount?: number; + unit_amount?: number /** * Format: decimal * @description Same as `unit_amount`, but accepts a decimal value in %s with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. */ - unit_amount_decimal?: string; - }; - }; - }; - }; + unit_amount_decimal?: string + } + } + } + } /**

Retrieves the price with the given ID.

*/ GetPricesPrice: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - price: string; - }; - }; + price: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["price"]; - }; - }; + 'application/json': components['schemas']['price'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostPricesPrice: { parameters: { path: { - price: string; - }; - }; + price: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["price"]; - }; - }; + 'application/json': components['schemas']['price'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether the price can be used for new purchases. Defaults to `true`. */ - active?: boolean; + active?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters. */ - lookup_key?: string; + lookup_key?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description A brief description of the price, hidden from customers. */ - nickname?: string; + nickname?: string /** * @description 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. * @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' /** @description If set to true, will atomically remove the lookup key from the existing price, and assign it to this price. */ - transfer_lookup_key?: boolean; - }; - }; - }; - }; + transfer_lookup_key?: boolean + } + } + } + } /**

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

*/ GetProducts: { parameters: { query: { /** Only return products that are active or inactive (e.g., pass `false` to list all inactive products). */ - active?: boolean; + active?: boolean /** Only return products that were created during the given date interval. */ created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** Only return products with the given IDs. */ - ids?: string[]; + ids?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return products that can be shipped (i.e., physical, not digital products). */ - shippable?: boolean; + shippable?: boolean /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return products with the given url. */ - url?: string; - }; - }; + url?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["product"][]; + data: components['schemas']['product'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new product object.

*/ PostProducts: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["product"]; - }; - }; + 'application/json': components['schemas']['product'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether the product is currently available for purchase. Defaults to `true`. */ - active?: boolean; + active?: boolean /** @description 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?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description An identifier will be randomly generated by Stripe. You can optionally override this ID, but the ID must be unique across all products in your Stripe account. */ - id?: string; + id?: string /** @description A list of up to 8 URLs of images for this product, meant to be displayable to the customer. */ - images?: string[]; + images?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The product's name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions. */ - name: string; + name: string /** * package_dimensions_specs * @description The dimensions of this product for shipping purposes. */ package_dimensions?: { - height: number; - length: number; - weight: number; - width: number; - }; + height: number + length: number + weight: number + width: number + } /** @description Whether this product is shipped (i.e., physical goods). */ - shippable?: boolean; + shippable?: boolean /** * @description An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all. * * This may be up to 22 characters. The statement description may not include `<`, `>`, `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. * It must contain at least one letter. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description A [tax code](https://stripe.com/docs/tax/tax-codes) ID. */ - tax_code?: string; + tax_code?: string /** @description A label that represents units of this product in Stripe and on customers’ receipts and invoices. When set, this will be included in associated invoice line item descriptions. */ - unit_label?: string; + unit_label?: string /** @description A URL of a publicly-accessible webpage for this product. */ - url?: string; - }; - }; - }; - }; + url?: string + } + } + } + } /**

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.

*/ GetProductsId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["product"]; - }; - }; + 'application/json': components['schemas']['product'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostProductsId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["product"]; - }; - }; + 'application/json': components['schemas']['product'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether the product is available for purchase. */ - active?: boolean; + active?: boolean /** @description 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?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A list of up to 8 URLs of images for this product, meant to be displayable to the customer. */ - images?: Partial & Partial<"">; + images?: Partial & Partial<''> /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The product's name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions. */ - name?: string; + name?: string /** @description The dimensions of this product for shipping purposes. */ package_dimensions?: Partial<{ - height: number; - length: number; - weight: number; - width: number; + height: number + length: number + weight: number + width: number }> & - Partial<"">; + Partial<''> /** @description Whether this product is shipped (i.e., physical goods). */ - shippable?: boolean; + shippable?: boolean /** * @description An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all. * * This may be up to 22 characters. The statement description may not include `<`, `>`, `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. * It must contain at least one letter. May only be set if `type=service`. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description A [tax code](https://stripe.com/docs/tax/tax-codes) ID. */ - tax_code?: Partial & Partial<"">; + tax_code?: Partial & Partial<''> /** @description A label that represents units of this product in Stripe and on customers’ receipts and invoices. When set, this will be included in associated invoice line item descriptions. May only be set if `type=service`. */ - unit_label?: string; + unit_label?: string /** @description A URL of a publicly-accessible webpage for this product. */ - url?: string; - }; - }; - }; - }; + url?: string + } + } + } + } /**

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.

*/ DeleteProductsId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_product"]; - }; - }; + 'application/json': components['schemas']['deleted_product'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of your promotion codes.

*/ GetPromotionCodes: { parameters: { query: { /** Filter promotion codes by whether they are active. */ - active?: boolean; + active?: boolean /** Only return promotion codes that have this case-insensitive code. */ - code?: string; + code?: string /** Only return promotion codes for this coupon. */ - coupon?: string; + coupon?: string /** 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?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** Only return promotion codes that are restricted to this customer. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["promotion_code"][]; + 'application/json': { + data: components['schemas']['promotion_code'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostPromotionCodes: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["promotion_code"]; - }; - }; + 'application/json': components['schemas']['promotion_code'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether the promotion code is currently active. */ - active?: boolean; + active?: boolean /** @description The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for a specific customer. If left blank, we will generate one automatically. */ - code?: string; + code?: string /** @description The coupon for this promotion code. */ - coupon: string; + coupon: string /** @description The customer that this promotion code can be used by. If not set, the promotion code can be used by all customers. */ - customer?: string; + customer?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * Format: unix-time * @description The timestamp at which this promotion code will expire. If the coupon has specified a `redeems_by`, then this value cannot be after the coupon's `redeems_by`. */ - expires_at?: number; + expires_at?: number /** @description A positive integer specifying the number of times the promotion code can be redeemed. If the coupon has specified a `max_redemptions`, then this value cannot be greater than the coupon's `max_redemptions`. */ - max_redemptions?: number; + max_redemptions?: number /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * restrictions_params * @description Settings that restrict the redemption of the promotion code. */ restrictions?: { - first_time_transaction?: boolean; - minimum_amount?: number; - minimum_amount_currency?: string; - }; - }; - }; - }; - }; + first_time_transaction?: boolean + minimum_amount?: number + minimum_amount_currency?: string + } + } + } + } + } /**

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.

*/ GetPromotionCodesPromotionCode: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - promotion_code: string; - }; - }; + promotion_code: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["promotion_code"]; - }; - }; + 'application/json': components['schemas']['promotion_code'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostPromotionCodesPromotionCode: { parameters: { path: { - promotion_code: string; - }; - }; + promotion_code: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["promotion_code"]; - }; - }; + 'application/json': components['schemas']['promotion_code'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether the promotion code is currently active. A promotion code can only be reactivated when the coupon is still valid and the promotion code is otherwise redeemable. */ - active?: boolean; + active?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Returns a list of your quotes.

*/ GetQuotes: { parameters: { query: { /** The ID of the customer whose quotes will be retrieved. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** The status of the quote. */ - status?: "accepted" | "canceled" | "draft" | "open"; - }; - }; + status?: 'accepted' | 'canceled' | 'draft' | 'open' + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["quote"][]; + 'application/json': { + data: components['schemas']['quote'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostQuotes: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["quote"]; - }; - }; + 'application/json': components['schemas']['quote'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description 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. There cannot be any line items with recurring prices when using this field. */ - application_fee_amount?: Partial & Partial<"">; + application_fee_amount?: Partial & Partial<''> /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field. */ - application_fee_percent?: Partial & Partial<"">; + application_fee_percent?: Partial & Partial<''> /** * automatic_tax_param * @description Settings for automatic tax lookup for this quote and resulting invoices and subscriptions. */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** * @description Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice 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. Defaults to `charge_automatically`. * @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' /** @description The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed. */ - customer?: string; + customer?: string /** @description The tax rates that will apply to any line item that does not have `tax_rates` set. */ - default_tax_rates?: Partial & Partial<"">; + default_tax_rates?: Partial & Partial<''> /** @description A description that will be displayed on the quote PDF. If no value is passed, the default description configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used. */ - description?: string; + description?: string /** @description The discounts applied to the quote. You can only set up to one discount. */ discounts?: Partial< { - coupon?: string; - discount?: string; + coupon?: string + discount?: string }[] > & - Partial<"">; + Partial<''> /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * Format: unix-time * @description A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. If no value is passed, the default expiration date configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used. */ - expires_at?: number; + expires_at?: number /** @description A footer that will be displayed on the quote PDF. If no value is passed, the default footer configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used. */ - footer?: string; + footer?: string /** * from_quote_params * @description Clone an existing quote. The new quote will be created in `status=draft`. When using this parameter, you cannot specify any other parameters except for `expires_at`. */ from_quote?: { - is_revision?: boolean; - quote: string; - }; + is_revision?: boolean + quote: string + } /** @description A header that will be displayed on the quote PDF. If no value is passed, the default header configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used. */ - header?: string; + header?: string /** * quote_param * @description All invoices will be billed using the specified settings. */ invoice_settings?: { - days_until_due?: number; - }; + days_until_due?: number + } /** @description A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost. */ line_items?: { - price?: string; + price?: string /** price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring?: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The account on behalf of which to charge. */ - on_behalf_of?: Partial & Partial<"">; + on_behalf_of?: Partial & Partial<''> /** * subscription_data_create_params * @description When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if `subscription_data[effective_date]` is present and in the future, otherwise a subscription is created. */ subscription_data?: { - effective_date?: Partial<"current_period_end"> & Partial & Partial<"">; - trial_period_days?: Partial & Partial<"">; - }; + effective_date?: Partial<'current_period_end'> & Partial & Partial<''> + trial_period_days?: Partial & Partial<''> + } /** @description The data with which to automatically create a Transfer for each of the invoices. */ transfer_data?: Partial<{ - amount?: number; - amount_percent?: number; - destination: string; + amount?: number + amount_percent?: number + destination: string }> & - Partial<"">; - }; - }; - }; - }; + Partial<''> + } + } + } + } /**

Retrieves the quote with the given ID.

*/ GetQuotesQuote: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - quote: string; - }; - }; + quote: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["quote"]; - }; - }; + 'application/json': components['schemas']['quote'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

A quote models prices and services for a customer.

*/ PostQuotesQuote: { parameters: { path: { - quote: string; - }; - }; + quote: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["quote"]; - }; - }; + 'application/json': components['schemas']['quote'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description 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. There cannot be any line items with recurring prices when using this field. */ - application_fee_amount?: Partial & Partial<"">; + application_fee_amount?: Partial & Partial<''> /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field. */ - application_fee_percent?: Partial & Partial<"">; + application_fee_percent?: Partial & Partial<''> /** * automatic_tax_param * @description Settings for automatic tax lookup for this quote and resulting invoices and subscriptions. */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** * @description Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice 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. Defaults to `charge_automatically`. * @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' /** @description The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed. */ - customer?: string; + customer?: string /** @description The tax rates that will apply to any line item that does not have `tax_rates` set. */ - default_tax_rates?: Partial & Partial<"">; + default_tax_rates?: Partial & Partial<''> /** @description A description that will be displayed on the quote PDF. */ - description?: string; + description?: string /** @description The discounts applied to the quote. You can only set up to one discount. */ discounts?: Partial< { - coupon?: string; - discount?: string; + coupon?: string + discount?: string }[] > & - Partial<"">; + Partial<''> /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * Format: unix-time * @description A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. */ - expires_at?: number; + expires_at?: number /** @description A footer that will be displayed on the quote PDF. */ - footer?: string; + footer?: string /** @description A header that will be displayed on the quote PDF. */ - header?: string; + header?: string /** * quote_param * @description All invoices will be billed using the specified settings. */ invoice_settings?: { - days_until_due?: number; - }; + days_until_due?: number + } /** @description A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost. */ line_items?: { - id?: string; - price?: string; + id?: string + price?: string /** price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring?: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The account on behalf of which to charge. */ - on_behalf_of?: Partial & Partial<"">; + on_behalf_of?: Partial & Partial<''> /** * subscription_data_update_params * @description When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if `subscription_data[effective_date]` is present and in the future, otherwise a subscription is created. */ subscription_data?: { - effective_date?: Partial<"current_period_end"> & Partial & Partial<"">; - trial_period_days?: Partial & Partial<"">; - }; + effective_date?: Partial<'current_period_end'> & Partial & Partial<''> + trial_period_days?: Partial & Partial<''> + } /** @description The data with which to automatically create a Transfer for each of the invoices. */ transfer_data?: Partial<{ - amount?: number; - amount_percent?: number; - destination: string; + amount?: number + amount_percent?: number + destination: string }> & - Partial<"">; - }; - }; - }; - }; + Partial<''> + } + } + } + } /**

Accepts the specified quote.

*/ PostQuotesQuoteAccept: { parameters: { path: { - quote: string; - }; - }; + quote: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["quote"]; - }; - }; + 'application/json': components['schemas']['quote'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Cancels the quote.

*/ PostQuotesQuoteCancel: { parameters: { path: { - quote: string; - }; - }; + quote: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["quote"]; - }; - }; + 'application/json': components['schemas']['quote'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

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.

*/ GetQuotesQuoteComputedUpfrontLineItems: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - quote: string; - }; - }; + quote: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["item"][]; + data: components['schemas']['item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Finalizes the quote.

*/ PostQuotesQuoteFinalize: { parameters: { path: { - quote: string; - }; - }; + quote: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["quote"]; - }; - }; + 'application/json': components['schemas']['quote'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * Format: unix-time * @description A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. */ - expires_at?: number; - }; - }; - }; - }; + expires_at?: number + } + } + } + } /**

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.

*/ GetQuotesQuoteLineItems: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - quote: string; - }; - }; + quote: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["item"][]; + data: components['schemas']['item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Download the PDF for a finalized quote

*/ GetQuotesQuotePdf: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - quote: string; - }; - }; + quote: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/pdf": string; - }; - }; + 'application/pdf': string + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of early fraud warnings.

*/ GetRadarEarlyFraudWarnings: { parameters: { query: { /** Only return early fraud warnings for the charge specified by this charge ID. */ - charge?: string; + charge?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return early fraud warnings for charges that were created by the PaymentIntent specified by this PaymentIntent ID. */ - payment_intent?: string; + payment_intent?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["radar.early_fraud_warning"][]; + 'application/json': { + data: components['schemas']['radar.early_fraud_warning'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Retrieves the details of an early fraud warning that has previously been created.

* @@ -37253,425 +37004,417 @@ export type operations = { GetRadarEarlyFraudWarningsEarlyFraudWarning: { parameters: { path: { - early_fraud_warning: string; - }; + early_fraud_warning: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["radar.early_fraud_warning"]; - }; - }; + 'application/json': components['schemas']['radar.early_fraud_warning'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ GetRadarValueListItems: { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Return items belonging to the parent list whose value matches the specified value (using an "is like" match). */ - value?: string; + value?: string /** Identifier for the parent value list this item belongs to. */ - value_list: string; - }; - }; + value_list: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["radar.value_list_item"][]; + 'application/json': { + data: components['schemas']['radar.value_list_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostRadarValueListItems: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["radar.value_list_item"]; - }; - }; + 'application/json': components['schemas']['radar.value_list_item'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The value of the item (whose type must match the type of the parent value list). */ - value: string; + value: string /** @description The identifier of the value list which the created item will be added to. */ - value_list: string; - }; - }; - }; - }; + value_list: string + } + } + } + } /**

Retrieves a ValueListItem object.

*/ GetRadarValueListItemsItem: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - item: string; - }; - }; + item: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["radar.value_list_item"]; - }; - }; + 'application/json': components['schemas']['radar.value_list_item'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ DeleteRadarValueListItemsItem: { parameters: { path: { - item: string; - }; - }; + item: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_radar.value_list_item"]; - }; - }; + 'application/json': components['schemas']['deleted_radar.value_list_item'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ GetRadarValueLists: { parameters: { query: { /** The alias used to reference the value list when writing rules. */ - alias?: string; + alias?: string /** A value contained within a value list - returns all value lists containing this value. */ - contains?: string; + contains?: string created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["radar.value_list"][]; + 'application/json': { + data: components['schemas']['radar.value_list'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostRadarValueLists: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["radar.value_list"]; - }; - }; + 'application/json': components['schemas']['radar.value_list'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The name of the value list for use in rules. */ - alias: string; + alias: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * @description Type of the items in the value list. One of `card_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, `case_sensitive_string`, or `customer_id`. Use `string` if the item type is unknown or mixed. * @enum {string} */ - item_type?: - | "card_bin" - | "card_fingerprint" - | "case_sensitive_string" - | "country" - | "customer_id" - | "email" - | "ip_address" - | "string"; + item_type?: 'card_bin' | 'card_fingerprint' | 'case_sensitive_string' | 'country' | 'customer_id' | 'email' | 'ip_address' | 'string' /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The human-readable name of the value list. */ - name: string; - }; - }; - }; - }; + name: string + } + } + } + } /**

Retrieves a ValueList object.

*/ GetRadarValueListsValueList: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - value_list: string; - }; - }; + value_list: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["radar.value_list"]; - }; - }; + 'application/json': components['schemas']['radar.value_list'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostRadarValueListsValueList: { parameters: { path: { - value_list: string; - }; - }; + value_list: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["radar.value_list"]; - }; - }; + 'application/json': components['schemas']['radar.value_list'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The name of the value list for use in rules. */ - alias?: string; + alias?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The human-readable name of the value list. */ - name?: string; - }; - }; - }; - }; + name?: string + } + } + } + } /**

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.

*/ DeleteRadarValueListsValueList: { parameters: { path: { - value_list: string; - }; - }; + value_list: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_radar.value_list"]; - }; - }; + 'application/json': components['schemas']['deleted_radar.value_list'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ GetRecipients: { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - type?: "corporation" | "individual"; + starting_after?: string + type?: 'corporation' | 'individual' /** Only return recipients that are verified or unverified. */ - verified?: boolean; - }; - }; + verified?: boolean + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["recipient"][]; + 'application/json': { + data: components['schemas']['recipient'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Creates a new Recipient object and verifies the recipient’s identity. * Also verifies the recipient’s bank account information or debit card, if either is provided.

@@ -37681,73 +37424,72 @@ export type operations = { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["recipient"]; - }; - }; + 'application/json': components['schemas']['recipient'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A bank account to attach to the recipient. You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details, with the options described below. */ - bank_account?: string; + bank_account?: string /** @description A U.S. Visa or MasterCard debit card (_not_ prepaid) to attach to the recipient. If the debit card is not valid, recipient creation will fail. You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's debit card details, with the options described below. Although not all information is required, the extra info helps prevent fraud. */ - card?: string; + card?: string /** @description An arbitrary string which you can attach to a `Recipient` object. It is displayed alongside the recipient in the web interface. */ - description?: string; + description?: string /** @description The recipient's email address. It is displayed alongside the recipient in the web interface, and can be useful for searching and tracking. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The recipient's full, legal name. For type `individual`, should be in the format `First Last`, `First Middle Last`, or `First M Last` (no prefixes or suffixes). For `corporation`, the full, incorporated name. */ - name: string; + name: string /** @description The recipient's tax ID, as a string. For type `individual`, the full SSN; for type `corporation`, the full EIN. */ - tax_id?: string; + tax_id?: string /** @description Type of the recipient: either `individual` or `corporation`. */ - type: string; - }; - }; - }; - }; + type: string + } + } + } + } /**

Retrieves the details of an existing recipient. You need only supply the unique recipient identifier that was returned upon recipient creation.

*/ GetRecipientsId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": Partial & - Partial; - }; - }; + 'application/json': Partial & Partial + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

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

@@ -37758,196 +37500,196 @@ export type operations = { PostRecipientsId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["recipient"]; - }; - }; + 'application/json': components['schemas']['recipient'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A bank account to attach to the recipient. You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details, with the options described below. */ - bank_account?: string; + bank_account?: string /** @description A U.S. Visa or MasterCard debit card (not prepaid) to attach to the recipient. You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's debit card details, with the options described below. Passing `card` will create a new card, make it the new recipient default card, and delete the old recipient default (if one exists). If you want to add additional debit cards instead of replacing the existing default, use the [card creation API](https://stripe.com/docs/api#create_card). Whenever you attach a card to a recipient, Stripe will automatically validate the debit card. */ - card?: string; + card?: string /** @description ID of the card to set as the recipient's new default for payouts. */ - default_card?: string; + default_card?: string /** @description An arbitrary string which you can attach to a `Recipient` object. It is displayed alongside the recipient in the web interface. */ - description?: string; + description?: string /** @description The recipient's email address. It is displayed alongside the recipient in the web interface, and can be useful for searching and tracking. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The recipient's full, legal name. For type `individual`, should be in the format `First Last`, `First Middle Last`, or `First M Last` (no prefixes or suffixes). For `corporation`, the full, incorporated name. */ - name?: string; + name?: string /** @description The recipient's tax ID, as a string. For type `individual`, the full SSN; for type `corporation`, the full EIN. */ - tax_id?: string; - }; - }; - }; - }; + tax_id?: string + } + } + } + } /**

Permanently deletes a recipient. It cannot be undone.

*/ DeleteRecipientsId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_recipient"]; - }; - }; + 'application/json': components['schemas']['deleted_recipient'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of all refunds you’ve previously created. The refunds are returned in sorted order, with the most recent refunds appearing first. For convenience, the 10 most recent refunds are always available by default on the charge object.

*/ GetRefunds: { parameters: { query: { /** Only return refunds for the charge specified by this charge ID. */ - charge?: string; + charge?: string created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return refunds for the PaymentIntent specified by this ID. */ - payment_intent?: string; + payment_intent?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["refund"][]; + 'application/json': { + data: components['schemas']['refund'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Create a refund.

*/ PostRefunds: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["refund"]; - }; - }; + 'application/json': components['schemas']['refund'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { - amount?: number; - charge?: string; + 'application/x-www-form-urlencoded': { + amount?: number + charge?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - payment_intent?: string; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + payment_intent?: string /** @enum {string} */ - reason?: "duplicate" | "fraudulent" | "requested_by_customer"; - refund_application_fee?: boolean; - reverse_transfer?: boolean; - }; - }; - }; - }; + reason?: 'duplicate' | 'fraudulent' | 'requested_by_customer' + refund_application_fee?: boolean + reverse_transfer?: boolean + } + } + } + } /**

Retrieves the details of an existing refund.

*/ GetRefundsRefund: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - refund: string; - }; - }; + refund: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["refund"]; - }; - }; + 'application/json': components['schemas']['refund'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

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

* @@ -37956,973 +37698,973 @@ export type operations = { PostRefundsRefund: { parameters: { path: { - refund: string; - }; - }; + refund: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["refund"]; - }; - }; + 'application/json': components['schemas']['refund'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

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

*/ GetReportingReportRuns: { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["reporting.report_run"][]; + 'application/json': { + data: components['schemas']['reporting.report_run'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostReportingReportRuns: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["reporting.report_run"]; - }; - }; + 'application/json': components['schemas']['reporting.report_run'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * run_parameter_specs * @description Parameters specifying how the report should be run. Different Report Types have different required and optional parameters, listed in the [API Access to Reports](https://stripe.com/docs/reporting/statements/api) documentation. */ parameters?: { - columns?: string[]; - connected_account?: string; - currency?: string; + columns?: string[] + connected_account?: string + currency?: string /** Format: unix-time */ - interval_end?: number; + interval_end?: number /** Format: unix-time */ - interval_start?: number; - payout?: string; + interval_start?: number + payout?: string /** @enum {string} */ reporting_category?: - | "advance" - | "advance_funding" - | "anticipation_repayment" - | "charge" - | "charge_failure" - | "connect_collection_transfer" - | "connect_reserved_funds" - | "contribution" - | "dispute" - | "dispute_reversal" - | "fee" - | "financing_paydown" - | "financing_paydown_reversal" - | "financing_payout" - | "financing_payout_reversal" - | "issuing_authorization_hold" - | "issuing_authorization_release" - | "issuing_dispute" - | "issuing_transaction" - | "network_cost" - | "other_adjustment" - | "partial_capture_reversal" - | "payout" - | "payout_reversal" - | "platform_earning" - | "platform_earning_refund" - | "refund" - | "refund_failure" - | "risk_reserved_funds" - | "tax" - | "topup" - | "topup_reversal" - | "transfer" - | "transfer_reversal"; + | 'advance' + | 'advance_funding' + | 'anticipation_repayment' + | 'charge' + | 'charge_failure' + | 'connect_collection_transfer' + | 'connect_reserved_funds' + | 'contribution' + | 'dispute' + | 'dispute_reversal' + | 'fee' + | 'financing_paydown' + | 'financing_paydown_reversal' + | 'financing_payout' + | 'financing_payout_reversal' + | 'issuing_authorization_hold' + | 'issuing_authorization_release' + | 'issuing_dispute' + | 'issuing_transaction' + | 'network_cost' + | 'other_adjustment' + | 'partial_capture_reversal' + | 'payout' + | 'payout_reversal' + | 'platform_earning' + | 'platform_earning_refund' + | 'refund' + | 'refund_failure' + | 'risk_reserved_funds' + | 'tax' + | 'topup' + | 'topup_reversal' + | 'transfer' + | 'transfer_reversal' /** @enum {string} */ timezone?: - | "Africa/Abidjan" - | "Africa/Accra" - | "Africa/Addis_Ababa" - | "Africa/Algiers" - | "Africa/Asmara" - | "Africa/Asmera" - | "Africa/Bamako" - | "Africa/Bangui" - | "Africa/Banjul" - | "Africa/Bissau" - | "Africa/Blantyre" - | "Africa/Brazzaville" - | "Africa/Bujumbura" - | "Africa/Cairo" - | "Africa/Casablanca" - | "Africa/Ceuta" - | "Africa/Conakry" - | "Africa/Dakar" - | "Africa/Dar_es_Salaam" - | "Africa/Djibouti" - | "Africa/Douala" - | "Africa/El_Aaiun" - | "Africa/Freetown" - | "Africa/Gaborone" - | "Africa/Harare" - | "Africa/Johannesburg" - | "Africa/Juba" - | "Africa/Kampala" - | "Africa/Khartoum" - | "Africa/Kigali" - | "Africa/Kinshasa" - | "Africa/Lagos" - | "Africa/Libreville" - | "Africa/Lome" - | "Africa/Luanda" - | "Africa/Lubumbashi" - | "Africa/Lusaka" - | "Africa/Malabo" - | "Africa/Maputo" - | "Africa/Maseru" - | "Africa/Mbabane" - | "Africa/Mogadishu" - | "Africa/Monrovia" - | "Africa/Nairobi" - | "Africa/Ndjamena" - | "Africa/Niamey" - | "Africa/Nouakchott" - | "Africa/Ouagadougou" - | "Africa/Porto-Novo" - | "Africa/Sao_Tome" - | "Africa/Timbuktu" - | "Africa/Tripoli" - | "Africa/Tunis" - | "Africa/Windhoek" - | "America/Adak" - | "America/Anchorage" - | "America/Anguilla" - | "America/Antigua" - | "America/Araguaina" - | "America/Argentina/Buenos_Aires" - | "America/Argentina/Catamarca" - | "America/Argentina/ComodRivadavia" - | "America/Argentina/Cordoba" - | "America/Argentina/Jujuy" - | "America/Argentina/La_Rioja" - | "America/Argentina/Mendoza" - | "America/Argentina/Rio_Gallegos" - | "America/Argentina/Salta" - | "America/Argentina/San_Juan" - | "America/Argentina/San_Luis" - | "America/Argentina/Tucuman" - | "America/Argentina/Ushuaia" - | "America/Aruba" - | "America/Asuncion" - | "America/Atikokan" - | "America/Atka" - | "America/Bahia" - | "America/Bahia_Banderas" - | "America/Barbados" - | "America/Belem" - | "America/Belize" - | "America/Blanc-Sablon" - | "America/Boa_Vista" - | "America/Bogota" - | "America/Boise" - | "America/Buenos_Aires" - | "America/Cambridge_Bay" - | "America/Campo_Grande" - | "America/Cancun" - | "America/Caracas" - | "America/Catamarca" - | "America/Cayenne" - | "America/Cayman" - | "America/Chicago" - | "America/Chihuahua" - | "America/Coral_Harbour" - | "America/Cordoba" - | "America/Costa_Rica" - | "America/Creston" - | "America/Cuiaba" - | "America/Curacao" - | "America/Danmarkshavn" - | "America/Dawson" - | "America/Dawson_Creek" - | "America/Denver" - | "America/Detroit" - | "America/Dominica" - | "America/Edmonton" - | "America/Eirunepe" - | "America/El_Salvador" - | "America/Ensenada" - | "America/Fort_Nelson" - | "America/Fort_Wayne" - | "America/Fortaleza" - | "America/Glace_Bay" - | "America/Godthab" - | "America/Goose_Bay" - | "America/Grand_Turk" - | "America/Grenada" - | "America/Guadeloupe" - | "America/Guatemala" - | "America/Guayaquil" - | "America/Guyana" - | "America/Halifax" - | "America/Havana" - | "America/Hermosillo" - | "America/Indiana/Indianapolis" - | "America/Indiana/Knox" - | "America/Indiana/Marengo" - | "America/Indiana/Petersburg" - | "America/Indiana/Tell_City" - | "America/Indiana/Vevay" - | "America/Indiana/Vincennes" - | "America/Indiana/Winamac" - | "America/Indianapolis" - | "America/Inuvik" - | "America/Iqaluit" - | "America/Jamaica" - | "America/Jujuy" - | "America/Juneau" - | "America/Kentucky/Louisville" - | "America/Kentucky/Monticello" - | "America/Knox_IN" - | "America/Kralendijk" - | "America/La_Paz" - | "America/Lima" - | "America/Los_Angeles" - | "America/Louisville" - | "America/Lower_Princes" - | "America/Maceio" - | "America/Managua" - | "America/Manaus" - | "America/Marigot" - | "America/Martinique" - | "America/Matamoros" - | "America/Mazatlan" - | "America/Mendoza" - | "America/Menominee" - | "America/Merida" - | "America/Metlakatla" - | "America/Mexico_City" - | "America/Miquelon" - | "America/Moncton" - | "America/Monterrey" - | "America/Montevideo" - | "America/Montreal" - | "America/Montserrat" - | "America/Nassau" - | "America/New_York" - | "America/Nipigon" - | "America/Nome" - | "America/Noronha" - | "America/North_Dakota/Beulah" - | "America/North_Dakota/Center" - | "America/North_Dakota/New_Salem" - | "America/Ojinaga" - | "America/Panama" - | "America/Pangnirtung" - | "America/Paramaribo" - | "America/Phoenix" - | "America/Port-au-Prince" - | "America/Port_of_Spain" - | "America/Porto_Acre" - | "America/Porto_Velho" - | "America/Puerto_Rico" - | "America/Punta_Arenas" - | "America/Rainy_River" - | "America/Rankin_Inlet" - | "America/Recife" - | "America/Regina" - | "America/Resolute" - | "America/Rio_Branco" - | "America/Rosario" - | "America/Santa_Isabel" - | "America/Santarem" - | "America/Santiago" - | "America/Santo_Domingo" - | "America/Sao_Paulo" - | "America/Scoresbysund" - | "America/Shiprock" - | "America/Sitka" - | "America/St_Barthelemy" - | "America/St_Johns" - | "America/St_Kitts" - | "America/St_Lucia" - | "America/St_Thomas" - | "America/St_Vincent" - | "America/Swift_Current" - | "America/Tegucigalpa" - | "America/Thule" - | "America/Thunder_Bay" - | "America/Tijuana" - | "America/Toronto" - | "America/Tortola" - | "America/Vancouver" - | "America/Virgin" - | "America/Whitehorse" - | "America/Winnipeg" - | "America/Yakutat" - | "America/Yellowknife" - | "Antarctica/Casey" - | "Antarctica/Davis" - | "Antarctica/DumontDUrville" - | "Antarctica/Macquarie" - | "Antarctica/Mawson" - | "Antarctica/McMurdo" - | "Antarctica/Palmer" - | "Antarctica/Rothera" - | "Antarctica/South_Pole" - | "Antarctica/Syowa" - | "Antarctica/Troll" - | "Antarctica/Vostok" - | "Arctic/Longyearbyen" - | "Asia/Aden" - | "Asia/Almaty" - | "Asia/Amman" - | "Asia/Anadyr" - | "Asia/Aqtau" - | "Asia/Aqtobe" - | "Asia/Ashgabat" - | "Asia/Ashkhabad" - | "Asia/Atyrau" - | "Asia/Baghdad" - | "Asia/Bahrain" - | "Asia/Baku" - | "Asia/Bangkok" - | "Asia/Barnaul" - | "Asia/Beirut" - | "Asia/Bishkek" - | "Asia/Brunei" - | "Asia/Calcutta" - | "Asia/Chita" - | "Asia/Choibalsan" - | "Asia/Chongqing" - | "Asia/Chungking" - | "Asia/Colombo" - | "Asia/Dacca" - | "Asia/Damascus" - | "Asia/Dhaka" - | "Asia/Dili" - | "Asia/Dubai" - | "Asia/Dushanbe" - | "Asia/Famagusta" - | "Asia/Gaza" - | "Asia/Harbin" - | "Asia/Hebron" - | "Asia/Ho_Chi_Minh" - | "Asia/Hong_Kong" - | "Asia/Hovd" - | "Asia/Irkutsk" - | "Asia/Istanbul" - | "Asia/Jakarta" - | "Asia/Jayapura" - | "Asia/Jerusalem" - | "Asia/Kabul" - | "Asia/Kamchatka" - | "Asia/Karachi" - | "Asia/Kashgar" - | "Asia/Kathmandu" - | "Asia/Katmandu" - | "Asia/Khandyga" - | "Asia/Kolkata" - | "Asia/Krasnoyarsk" - | "Asia/Kuala_Lumpur" - | "Asia/Kuching" - | "Asia/Kuwait" - | "Asia/Macao" - | "Asia/Macau" - | "Asia/Magadan" - | "Asia/Makassar" - | "Asia/Manila" - | "Asia/Muscat" - | "Asia/Nicosia" - | "Asia/Novokuznetsk" - | "Asia/Novosibirsk" - | "Asia/Omsk" - | "Asia/Oral" - | "Asia/Phnom_Penh" - | "Asia/Pontianak" - | "Asia/Pyongyang" - | "Asia/Qatar" - | "Asia/Qostanay" - | "Asia/Qyzylorda" - | "Asia/Rangoon" - | "Asia/Riyadh" - | "Asia/Saigon" - | "Asia/Sakhalin" - | "Asia/Samarkand" - | "Asia/Seoul" - | "Asia/Shanghai" - | "Asia/Singapore" - | "Asia/Srednekolymsk" - | "Asia/Taipei" - | "Asia/Tashkent" - | "Asia/Tbilisi" - | "Asia/Tehran" - | "Asia/Tel_Aviv" - | "Asia/Thimbu" - | "Asia/Thimphu" - | "Asia/Tokyo" - | "Asia/Tomsk" - | "Asia/Ujung_Pandang" - | "Asia/Ulaanbaatar" - | "Asia/Ulan_Bator" - | "Asia/Urumqi" - | "Asia/Ust-Nera" - | "Asia/Vientiane" - | "Asia/Vladivostok" - | "Asia/Yakutsk" - | "Asia/Yangon" - | "Asia/Yekaterinburg" - | "Asia/Yerevan" - | "Atlantic/Azores" - | "Atlantic/Bermuda" - | "Atlantic/Canary" - | "Atlantic/Cape_Verde" - | "Atlantic/Faeroe" - | "Atlantic/Faroe" - | "Atlantic/Jan_Mayen" - | "Atlantic/Madeira" - | "Atlantic/Reykjavik" - | "Atlantic/South_Georgia" - | "Atlantic/St_Helena" - | "Atlantic/Stanley" - | "Australia/ACT" - | "Australia/Adelaide" - | "Australia/Brisbane" - | "Australia/Broken_Hill" - | "Australia/Canberra" - | "Australia/Currie" - | "Australia/Darwin" - | "Australia/Eucla" - | "Australia/Hobart" - | "Australia/LHI" - | "Australia/Lindeman" - | "Australia/Lord_Howe" - | "Australia/Melbourne" - | "Australia/NSW" - | "Australia/North" - | "Australia/Perth" - | "Australia/Queensland" - | "Australia/South" - | "Australia/Sydney" - | "Australia/Tasmania" - | "Australia/Victoria" - | "Australia/West" - | "Australia/Yancowinna" - | "Brazil/Acre" - | "Brazil/DeNoronha" - | "Brazil/East" - | "Brazil/West" - | "CET" - | "CST6CDT" - | "Canada/Atlantic" - | "Canada/Central" - | "Canada/Eastern" - | "Canada/Mountain" - | "Canada/Newfoundland" - | "Canada/Pacific" - | "Canada/Saskatchewan" - | "Canada/Yukon" - | "Chile/Continental" - | "Chile/EasterIsland" - | "Cuba" - | "EET" - | "EST" - | "EST5EDT" - | "Egypt" - | "Eire" - | "Etc/GMT" - | "Etc/GMT+0" - | "Etc/GMT+1" - | "Etc/GMT+10" - | "Etc/GMT+11" - | "Etc/GMT+12" - | "Etc/GMT+2" - | "Etc/GMT+3" - | "Etc/GMT+4" - | "Etc/GMT+5" - | "Etc/GMT+6" - | "Etc/GMT+7" - | "Etc/GMT+8" - | "Etc/GMT+9" - | "Etc/GMT-0" - | "Etc/GMT-1" - | "Etc/GMT-10" - | "Etc/GMT-11" - | "Etc/GMT-12" - | "Etc/GMT-13" - | "Etc/GMT-14" - | "Etc/GMT-2" - | "Etc/GMT-3" - | "Etc/GMT-4" - | "Etc/GMT-5" - | "Etc/GMT-6" - | "Etc/GMT-7" - | "Etc/GMT-8" - | "Etc/GMT-9" - | "Etc/GMT0" - | "Etc/Greenwich" - | "Etc/UCT" - | "Etc/UTC" - | "Etc/Universal" - | "Etc/Zulu" - | "Europe/Amsterdam" - | "Europe/Andorra" - | "Europe/Astrakhan" - | "Europe/Athens" - | "Europe/Belfast" - | "Europe/Belgrade" - | "Europe/Berlin" - | "Europe/Bratislava" - | "Europe/Brussels" - | "Europe/Bucharest" - | "Europe/Budapest" - | "Europe/Busingen" - | "Europe/Chisinau" - | "Europe/Copenhagen" - | "Europe/Dublin" - | "Europe/Gibraltar" - | "Europe/Guernsey" - | "Europe/Helsinki" - | "Europe/Isle_of_Man" - | "Europe/Istanbul" - | "Europe/Jersey" - | "Europe/Kaliningrad" - | "Europe/Kiev" - | "Europe/Kirov" - | "Europe/Lisbon" - | "Europe/Ljubljana" - | "Europe/London" - | "Europe/Luxembourg" - | "Europe/Madrid" - | "Europe/Malta" - | "Europe/Mariehamn" - | "Europe/Minsk" - | "Europe/Monaco" - | "Europe/Moscow" - | "Europe/Nicosia" - | "Europe/Oslo" - | "Europe/Paris" - | "Europe/Podgorica" - | "Europe/Prague" - | "Europe/Riga" - | "Europe/Rome" - | "Europe/Samara" - | "Europe/San_Marino" - | "Europe/Sarajevo" - | "Europe/Saratov" - | "Europe/Simferopol" - | "Europe/Skopje" - | "Europe/Sofia" - | "Europe/Stockholm" - | "Europe/Tallinn" - | "Europe/Tirane" - | "Europe/Tiraspol" - | "Europe/Ulyanovsk" - | "Europe/Uzhgorod" - | "Europe/Vaduz" - | "Europe/Vatican" - | "Europe/Vienna" - | "Europe/Vilnius" - | "Europe/Volgograd" - | "Europe/Warsaw" - | "Europe/Zagreb" - | "Europe/Zaporozhye" - | "Europe/Zurich" - | "Factory" - | "GB" - | "GB-Eire" - | "GMT" - | "GMT+0" - | "GMT-0" - | "GMT0" - | "Greenwich" - | "HST" - | "Hongkong" - | "Iceland" - | "Indian/Antananarivo" - | "Indian/Chagos" - | "Indian/Christmas" - | "Indian/Cocos" - | "Indian/Comoro" - | "Indian/Kerguelen" - | "Indian/Mahe" - | "Indian/Maldives" - | "Indian/Mauritius" - | "Indian/Mayotte" - | "Indian/Reunion" - | "Iran" - | "Israel" - | "Jamaica" - | "Japan" - | "Kwajalein" - | "Libya" - | "MET" - | "MST" - | "MST7MDT" - | "Mexico/BajaNorte" - | "Mexico/BajaSur" - | "Mexico/General" - | "NZ" - | "NZ-CHAT" - | "Navajo" - | "PRC" - | "PST8PDT" - | "Pacific/Apia" - | "Pacific/Auckland" - | "Pacific/Bougainville" - | "Pacific/Chatham" - | "Pacific/Chuuk" - | "Pacific/Easter" - | "Pacific/Efate" - | "Pacific/Enderbury" - | "Pacific/Fakaofo" - | "Pacific/Fiji" - | "Pacific/Funafuti" - | "Pacific/Galapagos" - | "Pacific/Gambier" - | "Pacific/Guadalcanal" - | "Pacific/Guam" - | "Pacific/Honolulu" - | "Pacific/Johnston" - | "Pacific/Kiritimati" - | "Pacific/Kosrae" - | "Pacific/Kwajalein" - | "Pacific/Majuro" - | "Pacific/Marquesas" - | "Pacific/Midway" - | "Pacific/Nauru" - | "Pacific/Niue" - | "Pacific/Norfolk" - | "Pacific/Noumea" - | "Pacific/Pago_Pago" - | "Pacific/Palau" - | "Pacific/Pitcairn" - | "Pacific/Pohnpei" - | "Pacific/Ponape" - | "Pacific/Port_Moresby" - | "Pacific/Rarotonga" - | "Pacific/Saipan" - | "Pacific/Samoa" - | "Pacific/Tahiti" - | "Pacific/Tarawa" - | "Pacific/Tongatapu" - | "Pacific/Truk" - | "Pacific/Wake" - | "Pacific/Wallis" - | "Pacific/Yap" - | "Poland" - | "Portugal" - | "ROC" - | "ROK" - | "Singapore" - | "Turkey" - | "UCT" - | "US/Alaska" - | "US/Aleutian" - | "US/Arizona" - | "US/Central" - | "US/East-Indiana" - | "US/Eastern" - | "US/Hawaii" - | "US/Indiana-Starke" - | "US/Michigan" - | "US/Mountain" - | "US/Pacific" - | "US/Pacific-New" - | "US/Samoa" - | "UTC" - | "Universal" - | "W-SU" - | "WET" - | "Zulu"; - }; + | 'Africa/Abidjan' + | 'Africa/Accra' + | 'Africa/Addis_Ababa' + | 'Africa/Algiers' + | 'Africa/Asmara' + | 'Africa/Asmera' + | 'Africa/Bamako' + | 'Africa/Bangui' + | 'Africa/Banjul' + | 'Africa/Bissau' + | 'Africa/Blantyre' + | 'Africa/Brazzaville' + | 'Africa/Bujumbura' + | 'Africa/Cairo' + | 'Africa/Casablanca' + | 'Africa/Ceuta' + | 'Africa/Conakry' + | 'Africa/Dakar' + | 'Africa/Dar_es_Salaam' + | 'Africa/Djibouti' + | 'Africa/Douala' + | 'Africa/El_Aaiun' + | 'Africa/Freetown' + | 'Africa/Gaborone' + | 'Africa/Harare' + | 'Africa/Johannesburg' + | 'Africa/Juba' + | 'Africa/Kampala' + | 'Africa/Khartoum' + | 'Africa/Kigali' + | 'Africa/Kinshasa' + | 'Africa/Lagos' + | 'Africa/Libreville' + | 'Africa/Lome' + | 'Africa/Luanda' + | 'Africa/Lubumbashi' + | 'Africa/Lusaka' + | 'Africa/Malabo' + | 'Africa/Maputo' + | 'Africa/Maseru' + | 'Africa/Mbabane' + | 'Africa/Mogadishu' + | 'Africa/Monrovia' + | 'Africa/Nairobi' + | 'Africa/Ndjamena' + | 'Africa/Niamey' + | 'Africa/Nouakchott' + | 'Africa/Ouagadougou' + | 'Africa/Porto-Novo' + | 'Africa/Sao_Tome' + | 'Africa/Timbuktu' + | 'Africa/Tripoli' + | 'Africa/Tunis' + | 'Africa/Windhoek' + | 'America/Adak' + | 'America/Anchorage' + | 'America/Anguilla' + | 'America/Antigua' + | 'America/Araguaina' + | 'America/Argentina/Buenos_Aires' + | 'America/Argentina/Catamarca' + | 'America/Argentina/ComodRivadavia' + | 'America/Argentina/Cordoba' + | 'America/Argentina/Jujuy' + | 'America/Argentina/La_Rioja' + | 'America/Argentina/Mendoza' + | 'America/Argentina/Rio_Gallegos' + | 'America/Argentina/Salta' + | 'America/Argentina/San_Juan' + | 'America/Argentina/San_Luis' + | 'America/Argentina/Tucuman' + | 'America/Argentina/Ushuaia' + | 'America/Aruba' + | 'America/Asuncion' + | 'America/Atikokan' + | 'America/Atka' + | 'America/Bahia' + | 'America/Bahia_Banderas' + | 'America/Barbados' + | 'America/Belem' + | 'America/Belize' + | 'America/Blanc-Sablon' + | 'America/Boa_Vista' + | 'America/Bogota' + | 'America/Boise' + | 'America/Buenos_Aires' + | 'America/Cambridge_Bay' + | 'America/Campo_Grande' + | 'America/Cancun' + | 'America/Caracas' + | 'America/Catamarca' + | 'America/Cayenne' + | 'America/Cayman' + | 'America/Chicago' + | 'America/Chihuahua' + | 'America/Coral_Harbour' + | 'America/Cordoba' + | 'America/Costa_Rica' + | 'America/Creston' + | 'America/Cuiaba' + | 'America/Curacao' + | 'America/Danmarkshavn' + | 'America/Dawson' + | 'America/Dawson_Creek' + | 'America/Denver' + | 'America/Detroit' + | 'America/Dominica' + | 'America/Edmonton' + | 'America/Eirunepe' + | 'America/El_Salvador' + | 'America/Ensenada' + | 'America/Fort_Nelson' + | 'America/Fort_Wayne' + | 'America/Fortaleza' + | 'America/Glace_Bay' + | 'America/Godthab' + | 'America/Goose_Bay' + | 'America/Grand_Turk' + | 'America/Grenada' + | 'America/Guadeloupe' + | 'America/Guatemala' + | 'America/Guayaquil' + | 'America/Guyana' + | 'America/Halifax' + | 'America/Havana' + | 'America/Hermosillo' + | 'America/Indiana/Indianapolis' + | 'America/Indiana/Knox' + | 'America/Indiana/Marengo' + | 'America/Indiana/Petersburg' + | 'America/Indiana/Tell_City' + | 'America/Indiana/Vevay' + | 'America/Indiana/Vincennes' + | 'America/Indiana/Winamac' + | 'America/Indianapolis' + | 'America/Inuvik' + | 'America/Iqaluit' + | 'America/Jamaica' + | 'America/Jujuy' + | 'America/Juneau' + | 'America/Kentucky/Louisville' + | 'America/Kentucky/Monticello' + | 'America/Knox_IN' + | 'America/Kralendijk' + | 'America/La_Paz' + | 'America/Lima' + | 'America/Los_Angeles' + | 'America/Louisville' + | 'America/Lower_Princes' + | 'America/Maceio' + | 'America/Managua' + | 'America/Manaus' + | 'America/Marigot' + | 'America/Martinique' + | 'America/Matamoros' + | 'America/Mazatlan' + | 'America/Mendoza' + | 'America/Menominee' + | 'America/Merida' + | 'America/Metlakatla' + | 'America/Mexico_City' + | 'America/Miquelon' + | 'America/Moncton' + | 'America/Monterrey' + | 'America/Montevideo' + | 'America/Montreal' + | 'America/Montserrat' + | 'America/Nassau' + | 'America/New_York' + | 'America/Nipigon' + | 'America/Nome' + | 'America/Noronha' + | 'America/North_Dakota/Beulah' + | 'America/North_Dakota/Center' + | 'America/North_Dakota/New_Salem' + | 'America/Ojinaga' + | 'America/Panama' + | 'America/Pangnirtung' + | 'America/Paramaribo' + | 'America/Phoenix' + | 'America/Port-au-Prince' + | 'America/Port_of_Spain' + | 'America/Porto_Acre' + | 'America/Porto_Velho' + | 'America/Puerto_Rico' + | 'America/Punta_Arenas' + | 'America/Rainy_River' + | 'America/Rankin_Inlet' + | 'America/Recife' + | 'America/Regina' + | 'America/Resolute' + | 'America/Rio_Branco' + | 'America/Rosario' + | 'America/Santa_Isabel' + | 'America/Santarem' + | 'America/Santiago' + | 'America/Santo_Domingo' + | 'America/Sao_Paulo' + | 'America/Scoresbysund' + | 'America/Shiprock' + | 'America/Sitka' + | 'America/St_Barthelemy' + | 'America/St_Johns' + | 'America/St_Kitts' + | 'America/St_Lucia' + | 'America/St_Thomas' + | 'America/St_Vincent' + | 'America/Swift_Current' + | 'America/Tegucigalpa' + | 'America/Thule' + | 'America/Thunder_Bay' + | 'America/Tijuana' + | 'America/Toronto' + | 'America/Tortola' + | 'America/Vancouver' + | 'America/Virgin' + | 'America/Whitehorse' + | 'America/Winnipeg' + | 'America/Yakutat' + | 'America/Yellowknife' + | 'Antarctica/Casey' + | 'Antarctica/Davis' + | 'Antarctica/DumontDUrville' + | 'Antarctica/Macquarie' + | 'Antarctica/Mawson' + | 'Antarctica/McMurdo' + | 'Antarctica/Palmer' + | 'Antarctica/Rothera' + | 'Antarctica/South_Pole' + | 'Antarctica/Syowa' + | 'Antarctica/Troll' + | 'Antarctica/Vostok' + | 'Arctic/Longyearbyen' + | 'Asia/Aden' + | 'Asia/Almaty' + | 'Asia/Amman' + | 'Asia/Anadyr' + | 'Asia/Aqtau' + | 'Asia/Aqtobe' + | 'Asia/Ashgabat' + | 'Asia/Ashkhabad' + | 'Asia/Atyrau' + | 'Asia/Baghdad' + | 'Asia/Bahrain' + | 'Asia/Baku' + | 'Asia/Bangkok' + | 'Asia/Barnaul' + | 'Asia/Beirut' + | 'Asia/Bishkek' + | 'Asia/Brunei' + | 'Asia/Calcutta' + | 'Asia/Chita' + | 'Asia/Choibalsan' + | 'Asia/Chongqing' + | 'Asia/Chungking' + | 'Asia/Colombo' + | 'Asia/Dacca' + | 'Asia/Damascus' + | 'Asia/Dhaka' + | 'Asia/Dili' + | 'Asia/Dubai' + | 'Asia/Dushanbe' + | 'Asia/Famagusta' + | 'Asia/Gaza' + | 'Asia/Harbin' + | 'Asia/Hebron' + | 'Asia/Ho_Chi_Minh' + | 'Asia/Hong_Kong' + | 'Asia/Hovd' + | 'Asia/Irkutsk' + | 'Asia/Istanbul' + | 'Asia/Jakarta' + | 'Asia/Jayapura' + | 'Asia/Jerusalem' + | 'Asia/Kabul' + | 'Asia/Kamchatka' + | 'Asia/Karachi' + | 'Asia/Kashgar' + | 'Asia/Kathmandu' + | 'Asia/Katmandu' + | 'Asia/Khandyga' + | 'Asia/Kolkata' + | 'Asia/Krasnoyarsk' + | 'Asia/Kuala_Lumpur' + | 'Asia/Kuching' + | 'Asia/Kuwait' + | 'Asia/Macao' + | 'Asia/Macau' + | 'Asia/Magadan' + | 'Asia/Makassar' + | 'Asia/Manila' + | 'Asia/Muscat' + | 'Asia/Nicosia' + | 'Asia/Novokuznetsk' + | 'Asia/Novosibirsk' + | 'Asia/Omsk' + | 'Asia/Oral' + | 'Asia/Phnom_Penh' + | 'Asia/Pontianak' + | 'Asia/Pyongyang' + | 'Asia/Qatar' + | 'Asia/Qostanay' + | 'Asia/Qyzylorda' + | 'Asia/Rangoon' + | 'Asia/Riyadh' + | 'Asia/Saigon' + | 'Asia/Sakhalin' + | 'Asia/Samarkand' + | 'Asia/Seoul' + | 'Asia/Shanghai' + | 'Asia/Singapore' + | 'Asia/Srednekolymsk' + | 'Asia/Taipei' + | 'Asia/Tashkent' + | 'Asia/Tbilisi' + | 'Asia/Tehran' + | 'Asia/Tel_Aviv' + | 'Asia/Thimbu' + | 'Asia/Thimphu' + | 'Asia/Tokyo' + | 'Asia/Tomsk' + | 'Asia/Ujung_Pandang' + | 'Asia/Ulaanbaatar' + | 'Asia/Ulan_Bator' + | 'Asia/Urumqi' + | 'Asia/Ust-Nera' + | 'Asia/Vientiane' + | 'Asia/Vladivostok' + | 'Asia/Yakutsk' + | 'Asia/Yangon' + | 'Asia/Yekaterinburg' + | 'Asia/Yerevan' + | 'Atlantic/Azores' + | 'Atlantic/Bermuda' + | 'Atlantic/Canary' + | 'Atlantic/Cape_Verde' + | 'Atlantic/Faeroe' + | 'Atlantic/Faroe' + | 'Atlantic/Jan_Mayen' + | 'Atlantic/Madeira' + | 'Atlantic/Reykjavik' + | 'Atlantic/South_Georgia' + | 'Atlantic/St_Helena' + | 'Atlantic/Stanley' + | 'Australia/ACT' + | 'Australia/Adelaide' + | 'Australia/Brisbane' + | 'Australia/Broken_Hill' + | 'Australia/Canberra' + | 'Australia/Currie' + | 'Australia/Darwin' + | 'Australia/Eucla' + | 'Australia/Hobart' + | 'Australia/LHI' + | 'Australia/Lindeman' + | 'Australia/Lord_Howe' + | 'Australia/Melbourne' + | 'Australia/NSW' + | 'Australia/North' + | 'Australia/Perth' + | 'Australia/Queensland' + | 'Australia/South' + | 'Australia/Sydney' + | 'Australia/Tasmania' + | 'Australia/Victoria' + | 'Australia/West' + | 'Australia/Yancowinna' + | 'Brazil/Acre' + | 'Brazil/DeNoronha' + | 'Brazil/East' + | 'Brazil/West' + | 'CET' + | 'CST6CDT' + | 'Canada/Atlantic' + | 'Canada/Central' + | 'Canada/Eastern' + | 'Canada/Mountain' + | 'Canada/Newfoundland' + | 'Canada/Pacific' + | 'Canada/Saskatchewan' + | 'Canada/Yukon' + | 'Chile/Continental' + | 'Chile/EasterIsland' + | 'Cuba' + | 'EET' + | 'EST' + | 'EST5EDT' + | 'Egypt' + | 'Eire' + | 'Etc/GMT' + | 'Etc/GMT+0' + | 'Etc/GMT+1' + | 'Etc/GMT+10' + | 'Etc/GMT+11' + | 'Etc/GMT+12' + | 'Etc/GMT+2' + | 'Etc/GMT+3' + | 'Etc/GMT+4' + | 'Etc/GMT+5' + | 'Etc/GMT+6' + | 'Etc/GMT+7' + | 'Etc/GMT+8' + | 'Etc/GMT+9' + | 'Etc/GMT-0' + | 'Etc/GMT-1' + | 'Etc/GMT-10' + | 'Etc/GMT-11' + | 'Etc/GMT-12' + | 'Etc/GMT-13' + | 'Etc/GMT-14' + | 'Etc/GMT-2' + | 'Etc/GMT-3' + | 'Etc/GMT-4' + | 'Etc/GMT-5' + | 'Etc/GMT-6' + | 'Etc/GMT-7' + | 'Etc/GMT-8' + | 'Etc/GMT-9' + | 'Etc/GMT0' + | 'Etc/Greenwich' + | 'Etc/UCT' + | 'Etc/UTC' + | 'Etc/Universal' + | 'Etc/Zulu' + | 'Europe/Amsterdam' + | 'Europe/Andorra' + | 'Europe/Astrakhan' + | 'Europe/Athens' + | 'Europe/Belfast' + | 'Europe/Belgrade' + | 'Europe/Berlin' + | 'Europe/Bratislava' + | 'Europe/Brussels' + | 'Europe/Bucharest' + | 'Europe/Budapest' + | 'Europe/Busingen' + | 'Europe/Chisinau' + | 'Europe/Copenhagen' + | 'Europe/Dublin' + | 'Europe/Gibraltar' + | 'Europe/Guernsey' + | 'Europe/Helsinki' + | 'Europe/Isle_of_Man' + | 'Europe/Istanbul' + | 'Europe/Jersey' + | 'Europe/Kaliningrad' + | 'Europe/Kiev' + | 'Europe/Kirov' + | 'Europe/Lisbon' + | 'Europe/Ljubljana' + | 'Europe/London' + | 'Europe/Luxembourg' + | 'Europe/Madrid' + | 'Europe/Malta' + | 'Europe/Mariehamn' + | 'Europe/Minsk' + | 'Europe/Monaco' + | 'Europe/Moscow' + | 'Europe/Nicosia' + | 'Europe/Oslo' + | 'Europe/Paris' + | 'Europe/Podgorica' + | 'Europe/Prague' + | 'Europe/Riga' + | 'Europe/Rome' + | 'Europe/Samara' + | 'Europe/San_Marino' + | 'Europe/Sarajevo' + | 'Europe/Saratov' + | 'Europe/Simferopol' + | 'Europe/Skopje' + | 'Europe/Sofia' + | 'Europe/Stockholm' + | 'Europe/Tallinn' + | 'Europe/Tirane' + | 'Europe/Tiraspol' + | 'Europe/Ulyanovsk' + | 'Europe/Uzhgorod' + | 'Europe/Vaduz' + | 'Europe/Vatican' + | 'Europe/Vienna' + | 'Europe/Vilnius' + | 'Europe/Volgograd' + | 'Europe/Warsaw' + | 'Europe/Zagreb' + | 'Europe/Zaporozhye' + | 'Europe/Zurich' + | 'Factory' + | 'GB' + | 'GB-Eire' + | 'GMT' + | 'GMT+0' + | 'GMT-0' + | 'GMT0' + | 'Greenwich' + | 'HST' + | 'Hongkong' + | 'Iceland' + | 'Indian/Antananarivo' + | 'Indian/Chagos' + | 'Indian/Christmas' + | 'Indian/Cocos' + | 'Indian/Comoro' + | 'Indian/Kerguelen' + | 'Indian/Mahe' + | 'Indian/Maldives' + | 'Indian/Mauritius' + | 'Indian/Mayotte' + | 'Indian/Reunion' + | 'Iran' + | 'Israel' + | 'Jamaica' + | 'Japan' + | 'Kwajalein' + | 'Libya' + | 'MET' + | 'MST' + | 'MST7MDT' + | 'Mexico/BajaNorte' + | 'Mexico/BajaSur' + | 'Mexico/General' + | 'NZ' + | 'NZ-CHAT' + | 'Navajo' + | 'PRC' + | 'PST8PDT' + | 'Pacific/Apia' + | 'Pacific/Auckland' + | 'Pacific/Bougainville' + | 'Pacific/Chatham' + | 'Pacific/Chuuk' + | 'Pacific/Easter' + | 'Pacific/Efate' + | 'Pacific/Enderbury' + | 'Pacific/Fakaofo' + | 'Pacific/Fiji' + | 'Pacific/Funafuti' + | 'Pacific/Galapagos' + | 'Pacific/Gambier' + | 'Pacific/Guadalcanal' + | 'Pacific/Guam' + | 'Pacific/Honolulu' + | 'Pacific/Johnston' + | 'Pacific/Kiritimati' + | 'Pacific/Kosrae' + | 'Pacific/Kwajalein' + | 'Pacific/Majuro' + | 'Pacific/Marquesas' + | 'Pacific/Midway' + | 'Pacific/Nauru' + | 'Pacific/Niue' + | 'Pacific/Norfolk' + | 'Pacific/Noumea' + | 'Pacific/Pago_Pago' + | 'Pacific/Palau' + | 'Pacific/Pitcairn' + | 'Pacific/Pohnpei' + | 'Pacific/Ponape' + | 'Pacific/Port_Moresby' + | 'Pacific/Rarotonga' + | 'Pacific/Saipan' + | 'Pacific/Samoa' + | 'Pacific/Tahiti' + | 'Pacific/Tarawa' + | 'Pacific/Tongatapu' + | 'Pacific/Truk' + | 'Pacific/Wake' + | 'Pacific/Wallis' + | 'Pacific/Yap' + | 'Poland' + | 'Portugal' + | 'ROC' + | 'ROK' + | 'Singapore' + | 'Turkey' + | 'UCT' + | 'US/Alaska' + | 'US/Aleutian' + | 'US/Arizona' + | 'US/Central' + | 'US/East-Indiana' + | 'US/Eastern' + | 'US/Hawaii' + | 'US/Indiana-Starke' + | 'US/Michigan' + | 'US/Mountain' + | 'US/Pacific' + | 'US/Pacific-New' + | 'US/Samoa' + | 'UTC' + | 'Universal' + | 'W-SU' + | 'WET' + | 'Zulu' + } /** @description The ID of the [report type](https://stripe.com/docs/reporting/statements/api#report-types) to run, such as `"balance.summary.1"`. */ - report_type: string; - }; - }; - }; - }; + report_type: string + } + } + } + } /**

Retrieves the details of an existing Report Run.

*/ GetReportingReportRunsReportRun: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - report_run: string; - }; - }; + report_run: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["reporting.report_run"]; - }; - }; + 'application/json': components['schemas']['reporting.report_run'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a full list of Report Types.

*/ GetReportingReportTypes: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["reporting.report_type"][]; + 'application/json': { + data: components['schemas']['reporting.report_type'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ GetReportingReportTypesReportType: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - report_type: string; - }; - }; + report_type: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["reporting.report_type"]; - }; - }; + 'application/json': components['schemas']['reporting.report_type'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ GetReviews: { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["review"][]; + 'application/json': { + data: components['schemas']['review'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves a Review object.

*/ GetReviewsReview: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - review: string; - }; - }; + review: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["review"]; - }; - }; + 'application/json': components['schemas']['review'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ PostReviewsReviewApprove: { parameters: { path: { - review: string; - }; - }; + review: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["review"]; - }; - }; + 'application/json': components['schemas']['review'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Returns a list of SetupAttempts associated with a provided SetupIntent.

*/ GetSetupAttempts: { parameters: { @@ -38933,115 +38675,115 @@ export type operations = { * dictionary with a number of different query options. */ created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** * Only return SetupAttempts created by the SetupIntent specified by * this ID. */ - setup_intent: string; + setup_intent: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["setup_attempt"][]; + 'application/json': { + data: components['schemas']['setup_attempt'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of SetupIntents.

*/ GetSetupIntents: { parameters: { query: { /** 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?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** Only return SetupIntents for the customer specified by this customer ID. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return SetupIntents associated with the specified payment method. */ - payment_method?: string; + payment_method?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["setup_intent"][]; + 'application/json': { + data: components['schemas']['setup_intent'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Creates a SetupIntent object.

* @@ -39053,31 +38795,31 @@ export type operations = { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["setup_intent"]; - }; - }; + 'application/json': components['schemas']['setup_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Set to `true` to attempt to confirm this SetupIntent immediately. This parameter defaults to `false`. If the payment method attached is a card, a return_url may be provided in case additional authentication is required. */ - confirm?: boolean; + confirm?: boolean /** * @description ID of the Customer this SetupIntent belongs to, if one exists. * * If 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. */ - customer?: string; + customer?: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * secret_key_param * @description This hash contains details about the Mandate to create. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm). @@ -39086,24 +38828,24 @@ export type operations = { /** customer_acceptance_param */ customer_acceptance: { /** Format: unix-time */ - accepted_at?: number; + accepted_at?: number /** offline_param */ - offline?: { [key: string]: unknown }; + offline?: { [key: string]: unknown } /** online_param */ online?: { - ip_address: string; - user_agent: string; - }; + ip_address: string + user_agent: string + } /** @enum {string} */ - type: "offline" | "online"; - }; - }; + type: 'offline' | 'online' + } + } /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The Stripe account ID for which this SetupIntent is created. */ - on_behalf_of?: string; + on_behalf_of?: string /** @description ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. */ - payment_method?: string; + payment_method?: string /** * payment_method_options_param * @description Payment-method-specific configuration for this SetupIntent. @@ -39112,52 +38854,52 @@ export type operations = { /** setup_intent_payment_method_options_param */ acss_debit?: { /** @enum {string} */ - currency?: "cad" | "usd"; + currency?: 'cad' | 'usd' /** setup_intent_payment_method_options_mandate_options_param */ mandate_options?: { - custom_mandate_url?: Partial & Partial<"">; - default_for?: ("invoice" | "subscription")[]; - interval_description?: string; + custom_mandate_url?: Partial & Partial<''> + default_for?: ('invoice' | 'subscription')[] + interval_description?: string /** @enum {string} */ - payment_schedule?: "combined" | "interval" | "sporadic"; + payment_schedule?: 'combined' | 'interval' | 'sporadic' /** @enum {string} */ - transaction_type?: "business" | "personal"; - }; + transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; - }; + verification_method?: 'automatic' | 'instant' | 'microdeposits' + } /** setup_intent_param */ card?: { /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; - }; + request_three_d_secure?: 'any' | 'automatic' + } /** setup_intent_payment_method_options_param */ sepa_debit?: { /** payment_method_options_mandate_options_param */ - mandate_options?: { [key: string]: unknown }; - }; - }; + mandate_options?: { [key: string]: unknown } + } + } /** @description The list of payment method types (e.g. card) that this SetupIntent is allowed to use. If this is not provided, defaults to ["card"]. */ - payment_method_types?: string[]; + payment_method_types?: string[] /** @description The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm). */ - return_url?: string; + return_url?: string /** * setup_intent_single_use_params * @description If this hash is populated, this SetupIntent will generate a single_use Mandate on success. */ single_use?: { - amount: number; - currency: string; - }; + amount: number + currency: string + } /** * @description Indicates how the payment method is intended to be used in the future. If not provided, this value defaults to `off_session`. * @enum {string} */ - usage?: "off_session" | "on_session"; - }; - }; - }; - }; + usage?: 'off_session' | 'on_session' + } + } + } + } /** *

Retrieves the details of a SetupIntent that has previously been created.

* @@ -39169,72 +38911,72 @@ export type operations = { parameters: { query: { /** The client secret of the SetupIntent. Required if a publishable key is used to retrieve the SetupIntent. */ - client_secret?: string; + client_secret?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - intent: string; - }; - }; + intent: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["setup_intent"]; - }; - }; + 'application/json': components['schemas']['setup_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates a SetupIntent object.

*/ PostSetupIntentsIntent: { parameters: { path: { - intent: string; - }; - }; + intent: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["setup_intent"]; - }; - }; + 'application/json': components['schemas']['setup_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * @description ID of the Customer this SetupIntent belongs to, if one exists. * * If 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. */ - customer?: string; + customer?: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. */ - payment_method?: string; + payment_method?: string /** * payment_method_options_param * @description Payment-method-specific configuration for this SetupIntent. @@ -39243,37 +38985,37 @@ export type operations = { /** setup_intent_payment_method_options_param */ acss_debit?: { /** @enum {string} */ - currency?: "cad" | "usd"; + currency?: 'cad' | 'usd' /** setup_intent_payment_method_options_mandate_options_param */ mandate_options?: { - custom_mandate_url?: Partial & Partial<"">; - default_for?: ("invoice" | "subscription")[]; - interval_description?: string; + custom_mandate_url?: Partial & Partial<''> + default_for?: ('invoice' | 'subscription')[] + interval_description?: string /** @enum {string} */ - payment_schedule?: "combined" | "interval" | "sporadic"; + payment_schedule?: 'combined' | 'interval' | 'sporadic' /** @enum {string} */ - transaction_type?: "business" | "personal"; - }; + transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; - }; + verification_method?: 'automatic' | 'instant' | 'microdeposits' + } /** setup_intent_param */ card?: { /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; - }; + request_three_d_secure?: 'any' | 'automatic' + } /** setup_intent_payment_method_options_param */ sepa_debit?: { /** payment_method_options_mandate_options_param */ - mandate_options?: { [key: string]: unknown }; - }; - }; + mandate_options?: { [key: string]: unknown } + } + } /** @description The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. If this is not provided, defaults to ["card"]. */ - payment_method_types?: string[]; - }; - }; - }; - }; + payment_method_types?: string[] + } + } + } + } /** *

A SetupIntent object can be canceled when it is in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.

* @@ -39282,37 +39024,37 @@ export type operations = { PostSetupIntentsIntentCancel: { parameters: { path: { - intent: string; - }; - }; + intent: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["setup_intent"]; - }; - }; + 'application/json': components['schemas']['setup_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * @description Reason for canceling this SetupIntent. Possible values are `abandoned`, `requested_by_customer`, or `duplicate` * @enum {string} */ - cancellation_reason?: "abandoned" | "duplicate" | "requested_by_customer"; + cancellation_reason?: 'abandoned' | 'duplicate' | 'requested_by_customer' /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /** *

Confirm that your customer intends to set up the current or * provided payment method. For example, you would confirm a SetupIntent @@ -39331,61 +39073,61 @@ export type operations = { PostSetupIntentsIntentConfirm: { parameters: { path: { - intent: string; - }; - }; + intent: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["setup_intent"]; - }; - }; + 'application/json': components['schemas']['setup_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The client secret of the SetupIntent. */ - client_secret?: string; + client_secret?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description This hash contains details about the Mandate to create */ mandate_data?: Partial<{ /** customer_acceptance_param */ customer_acceptance: { /** Format: unix-time */ - accepted_at?: number; + accepted_at?: number /** offline_param */ - offline?: { [key: string]: unknown }; + offline?: { [key: string]: unknown } /** online_param */ online?: { - ip_address: string; - user_agent: string; - }; + ip_address: string + user_agent: string + } /** @enum {string} */ - type: "offline" | "online"; - }; + type: 'offline' | 'online' + } }> & Partial<{ /** customer_acceptance_param */ customer_acceptance: { /** online_param */ online: { - ip_address?: string; - user_agent?: string; - }; + ip_address?: string + user_agent?: string + } /** @enum {string} */ - type: "online"; - }; - }>; + type: 'online' + } + }> /** @description ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. */ - payment_method?: string; + payment_method?: string /** * payment_method_options_param * @description Payment-method-specific configuration for this SetupIntent. @@ -39394,151 +39136,151 @@ export type operations = { /** setup_intent_payment_method_options_param */ acss_debit?: { /** @enum {string} */ - currency?: "cad" | "usd"; + currency?: 'cad' | 'usd' /** setup_intent_payment_method_options_mandate_options_param */ mandate_options?: { - custom_mandate_url?: Partial & Partial<"">; - default_for?: ("invoice" | "subscription")[]; - interval_description?: string; + custom_mandate_url?: Partial & Partial<''> + default_for?: ('invoice' | 'subscription')[] + interval_description?: string /** @enum {string} */ - payment_schedule?: "combined" | "interval" | "sporadic"; + payment_schedule?: 'combined' | 'interval' | 'sporadic' /** @enum {string} */ - transaction_type?: "business" | "personal"; - }; + transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; - }; + verification_method?: 'automatic' | 'instant' | 'microdeposits' + } /** setup_intent_param */ card?: { /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; - }; + request_three_d_secure?: 'any' | 'automatic' + } /** setup_intent_payment_method_options_param */ sepa_debit?: { /** payment_method_options_mandate_options_param */ - mandate_options?: { [key: string]: unknown }; - }; - }; + mandate_options?: { [key: string]: unknown } + } + } /** * @description The URL to redirect your customer back to after they authenticate on the payment method's app or site. * If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. * This parameter is only used for cards and other redirect-based payment methods. */ - return_url?: string; - }; - }; - }; - }; + return_url?: string + } + } + } + } /**

Verifies microdeposits on a SetupIntent object.

*/ PostSetupIntentsIntentVerifyMicrodeposits: { parameters: { path: { - intent: string; - }; - }; + intent: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["setup_intent"]; - }; - }; + 'application/json': components['schemas']['setup_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account. */ - amounts?: number[]; + amounts?: number[] /** @description The client secret of the SetupIntent. */ - client_secret?: string; + client_secret?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Returns a list of your shipping rates.

*/ GetShippingRates: { parameters: { query: { /** Only return shipping rates that are active or inactive. */ - active?: boolean; + active?: boolean /** 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?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** Only return shipping rates for the given currency. */ - currency?: string; + currency?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["shipping_rate"][]; + 'application/json': { + data: components['schemas']['shipping_rate'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new shipping rate object.

*/ PostShippingRates: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["shipping_rate"]; - }; - }; + 'application/json': components['schemas']['shipping_rate'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * delivery_estimate * @description The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions. @@ -39547,335 +39289,335 @@ export type operations = { /** delivery_estimate_bound */ maximum?: { /** @enum {string} */ - unit: "business_day" | "day" | "hour" | "month" | "week"; - value: number; - }; + unit: 'business_day' | 'day' | 'hour' | 'month' | 'week' + value: number + } /** delivery_estimate_bound */ minimum?: { /** @enum {string} */ - unit: "business_day" | "day" | "hour" | "month" | "week"; - value: number; - }; - }; + unit: 'business_day' | 'day' | 'hour' | 'month' | 'week' + value: number + } + } /** @description The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions. */ - display_name: string; + display_name: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * fixed_amount * @description Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`. */ fixed_amount?: { - amount: number; - currency: string; - }; + amount: number + currency: string + } /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * @description Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. * @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' /** @description A [tax code](https://stripe.com/docs/tax/tax-codes) ID. The Shipping tax code is `txcd_92010001`. */ - tax_code?: string; + tax_code?: string /** * @description The type of calculation to use on the shipping rate. Can only be `fixed_amount` for now. * @enum {string} */ - type?: "fixed_amount"; - }; - }; - }; - }; + type?: 'fixed_amount' + } + } + } + } /**

Returns the shipping rate object with the given ID.

*/ GetShippingRatesShippingRateToken: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - shipping_rate_token: string; - }; - }; + shipping_rate_token: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["shipping_rate"]; - }; - }; + 'application/json': components['schemas']['shipping_rate'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates an existing shipping rate object.

*/ PostShippingRatesShippingRateToken: { parameters: { path: { - shipping_rate_token: string; - }; - }; + shipping_rate_token: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["shipping_rate"]; - }; - }; + 'application/json': components['schemas']['shipping_rate'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether the shipping rate can be used for new purchases. Defaults to `true`. */ - active?: boolean; + active?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Returns a list of scheduled query runs.

*/ GetSigmaScheduledQueryRuns: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["scheduled_query_run"][]; + 'application/json': { + data: components['schemas']['scheduled_query_run'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves the details of an scheduled query run.

*/ GetSigmaScheduledQueryRunsScheduledQueryRun: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - scheduled_query_run: string; - }; - }; + scheduled_query_run: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["scheduled_query_run"]; - }; - }; + 'application/json': components['schemas']['scheduled_query_run'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ GetSkus: { parameters: { query: { /** Only return SKUs that are active or inactive (e.g., pass `false` to list all inactive products). */ - active?: boolean; + active?: boolean /** Only return SKUs that have the specified key-value pairs in this partially constructed dictionary. Can be specified only if `product` is also supplied. For instance, if the associated product has attributes `["color", "size"]`, passing in `attributes[color]=red` returns all the SKUs for this product that have `color` set to `red`. */ - attributes?: { [key: string]: string }; + attributes?: { [key: string]: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** Only return SKUs with the given IDs. */ - ids?: string[]; + ids?: string[] /** Only return SKUs that are either in stock or out of stock (e.g., pass `false` to list all SKUs that are out of stock). If no value is provided, all SKUs are returned. */ - in_stock?: boolean; + in_stock?: boolean /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** The ID of the product whose SKUs will be retrieved. Must be a product with type `good`. */ - product?: string; + product?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["sku"][]; + 'application/json': { + data: components['schemas']['sku'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new SKU associated with a product.

*/ PostSkus: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["sku"]; - }; - }; + 'application/json': components['schemas']['sku'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether the SKU is available for purchase. Default to `true`. */ - active?: boolean; + active?: boolean /** @description A dictionary of attributes and values for the attributes defined by the product. If, for example, a product's attributes are `["size", "gender"]`, a valid SKU has the following dictionary of attributes: `{"size": "Medium", "gender": "Unisex"}`. */ - attributes?: { [key: string]: string }; + attributes?: { [key: string]: string } /** @description 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: string; + currency: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The identifier for the SKU. Must be unique. If not provided, an identifier will be randomly generated. */ - id?: string; + id?: string /** @description The URL of an image for this SKU, meant to be displayable to the customer. */ - image?: string; + image?: string /** * inventory_create_specs * @description Description of the SKU's inventory. */ inventory: { - quantity?: number; + quantity?: number /** @enum {string} */ - type: "bucket" | "finite" | "infinite"; + type: 'bucket' | 'finite' | 'infinite' /** @enum {string} */ - value?: "" | "in_stock" | "limited" | "out_of_stock"; - }; + value?: '' | 'in_stock' | 'limited' | 'out_of_stock' + } /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * package_dimensions_specs * @description The dimensions of this SKU for shipping purposes. */ package_dimensions?: { - height: number; - length: number; - weight: number; - width: number; - }; + height: number + length: number + weight: number + width: number + } /** @description The cost of the item as a nonnegative integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a zero-decimal currency). */ - price: number; + price: number /** @description The ID of the product this SKU is associated with. Must be a product with type `good`. */ - product: string; - }; - }; - }; - }; + product: string + } + } + } + } /**

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

*/ GetSkusId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": Partial & Partial; - }; - }; + 'application/json': Partial & Partial + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

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

* @@ -39884,124 +39626,124 @@ export type operations = { PostSkusId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["sku"]; - }; - }; + 'application/json': components['schemas']['sku'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether this SKU is available for purchase. */ - active?: boolean; + active?: boolean /** @description A dictionary of attributes and values for the attributes defined by the product. When specified, `attributes` will partially update the existing attributes dictionary on the product, with the postcondition that a value must be present for each attribute key on the product. */ - attributes?: { [key: string]: string }; + attributes?: { [key: string]: string } /** @description 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?: string; + currency?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The URL of an image for this SKU, meant to be displayable to the customer. */ - image?: string; + image?: string /** * inventory_update_specs * @description Description of the SKU's inventory. */ inventory?: { - quantity?: number; + quantity?: number /** @enum {string} */ - type?: "bucket" | "finite" | "infinite"; + type?: 'bucket' | 'finite' | 'infinite' /** @enum {string} */ - value?: "" | "in_stock" | "limited" | "out_of_stock"; - }; + value?: '' | 'in_stock' | 'limited' | 'out_of_stock' + } /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The dimensions of this SKU for shipping purposes. */ package_dimensions?: Partial<{ - height: number; - length: number; - weight: number; - width: number; + height: number + length: number + weight: number + width: number }> & - Partial<"">; + Partial<''> /** @description The cost of the item as a positive integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a zero-decimal currency). */ - price?: number; + price?: number /** @description The ID of the product that this SKU should belong to. The product must exist, have the same set of attribute names as the SKU's current product, and be of type `good`. */ - product?: string; - }; - }; - }; - }; + product?: string + } + } + } + } /**

Delete a SKU. Deleting a SKU is only possible until it has been used in an order.

*/ DeleteSkusId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_sku"]; - }; - }; + 'application/json': components['schemas']['deleted_sku'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new source object.

*/ PostSources: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["source"]; - }; - }; + 'application/json': components['schemas']['source'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources. Not supported for `receiver` type sources, where charge amount may not be specified until funds land. */ - amount?: number; + amount?: number /** @description 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. */ - currency?: string; + currency?: string /** @description The `Customer` to whom the original source is attached to. Must be set when the original source is not a `Source` (e.g., `Card`). */ - customer?: string; + customer?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * @description The authentication `flow` of the source to create. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`. It is generally inferred unless a type supports multiple flows. * @enum {string} */ - flow?: "code_verification" | "none" | "receiver" | "redirect"; + flow?: 'code_verification' | 'none' | 'receiver' | 'redirect' /** * mandate_params * @description Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status. @@ -40010,35 +39752,35 @@ export type operations = { /** mandate_acceptance_params */ acceptance?: { /** Format: unix-time */ - date?: number; - ip?: string; + date?: number + ip?: string /** mandate_offline_acceptance_params */ offline?: { - contact_email: string; - }; + contact_email: string + } /** mandate_online_acceptance_params */ online?: { /** Format: unix-time */ - date?: number; - ip?: string; - user_agent?: string; - }; + date?: number + ip?: string + user_agent?: string + } /** @enum {string} */ - status: "accepted" | "pending" | "refused" | "revoked"; + status: 'accepted' | 'pending' | 'refused' | 'revoked' /** @enum {string} */ - type?: "offline" | "online"; - user_agent?: string; - }; - amount?: Partial & Partial<"">; - currency?: string; + type?: 'offline' | 'online' + user_agent?: string + } + amount?: Partial & Partial<''> + currency?: string /** @enum {string} */ - interval?: "one_time" | "scheduled" | "variable"; + interval?: 'one_time' | 'scheduled' | 'variable' /** @enum {string} */ - notification_method?: "deprecated_none" | "email" | "manual" | "none" | "stripe_email"; - }; - metadata?: { [key: string]: string }; + notification_method?: 'deprecated_none' | 'email' | 'manual' | 'none' | 'stripe_email' + } + metadata?: { [key: string]: string } /** @description The source to share. */ - original_source?: string; + original_source?: string /** * owner * @description Information about the owner of the payment instrument that may be used or required by particular source types. @@ -40046,108 +39788,108 @@ export type operations = { owner?: { /** source_address */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - email?: string; - name?: string; - phone?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + email?: string + name?: string + phone?: string + } /** * receiver_params * @description Optional parameters for the receiver flow. Can be set only if the source is a receiver (`flow` is `receiver`). */ receiver?: { /** @enum {string} */ - refund_attributes_method?: "email" | "manual" | "none"; - }; + refund_attributes_method?: 'email' | 'manual' | 'none' + } /** * redirect_params * @description Parameters required for the redirect flow. Required if the source is authenticated by a redirect (`flow` is `redirect`). */ redirect?: { - return_url: string; - }; + return_url: string + } /** * shallow_order_specs * @description Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it. */ source_order?: { items?: { - amount?: number; - currency?: string; - description?: string; - parent?: string; - quantity?: number; + amount?: number + currency?: string + description?: string + parent?: string + quantity?: number /** @enum {string} */ - type?: "discount" | "shipping" | "sku" | "tax"; - }[]; + type?: 'discount' | 'shipping' | 'sku' | 'tax' + }[] /** order_shipping */ shipping?: { /** address */ address: { - city?: string; - country?: string; - line1: string; - line2?: string; - postal_code?: string; - state?: string; - }; - carrier?: string; - name?: string; - phone?: string; - tracking_number?: string; - }; - }; + city?: string + country?: string + line1: string + line2?: string + postal_code?: string + state?: string + } + carrier?: string + name?: string + phone?: string + tracking_number?: string + } + } /** @description An arbitrary string to be displayed on your customer's statement. As an example, if your website is `RunClub` and the item you're charging for is a race ticket, you may want to specify a `statement_descriptor` of `RunClub 5K race ticket.` While many payment types will display this information, some may not display it at all. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description An optional token used to create the source. When passed, token properties will override source parameters. */ - token?: string; + token?: string /** @description The `type` of the source to create. Required unless `customer` and `original_source` are specified (see the [Cloning card Sources](https://stripe.com/docs/sources/connect#cloning-card-sources) guide) */ - type?: string; + type?: string /** @enum {string} */ - usage?: "reusable" | "single_use"; - }; - }; - }; - }; + usage?: 'reusable' | 'single_use' + } + } + } + } /**

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.

*/ GetSourcesSource: { parameters: { query: { /** The client secret of the source. Required if a publishable key is used to retrieve the source. */ - client_secret?: string; + client_secret?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - source: string; - }; - }; + source: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["source"]; - }; - }; + 'application/json': components['schemas']['source'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

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

* @@ -40156,30 +39898,30 @@ export type operations = { PostSourcesSource: { parameters: { path: { - source: string; - }; - }; + source: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["source"]; - }; - }; + 'application/json': components['schemas']['source'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Amount associated with the source. */ - amount?: number; + amount?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * mandate_params * @description Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status. @@ -40188,34 +39930,34 @@ export type operations = { /** mandate_acceptance_params */ acceptance?: { /** Format: unix-time */ - date?: number; - ip?: string; + date?: number + ip?: string /** mandate_offline_acceptance_params */ offline?: { - contact_email: string; - }; + contact_email: string + } /** mandate_online_acceptance_params */ online?: { /** Format: unix-time */ - date?: number; - ip?: string; - user_agent?: string; - }; + date?: number + ip?: string + user_agent?: string + } /** @enum {string} */ - status: "accepted" | "pending" | "refused" | "revoked"; + status: 'accepted' | 'pending' | 'refused' | 'revoked' /** @enum {string} */ - type?: "offline" | "online"; - user_agent?: string; - }; - amount?: Partial & Partial<"">; - currency?: string; + type?: 'offline' | 'online' + user_agent?: string + } + amount?: Partial & Partial<''> + currency?: string /** @enum {string} */ - interval?: "one_time" | "scheduled" | "variable"; + interval?: 'one_time' | 'scheduled' | 'variable' /** @enum {string} */ - notification_method?: "deprecated_none" | "email" | "manual" | "none" | "stripe_email"; - }; + notification_method?: 'deprecated_none' | 'email' | 'manual' | 'none' | 'stripe_email' + } /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** * owner * @description Information about the owner of the payment instrument that may be used or required by particular source types. @@ -40223,271 +39965,271 @@ export type operations = { owner?: { /** source_address */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - email?: string; - name?: string; - phone?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + email?: string + name?: string + phone?: string + } /** * order_params * @description Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it. */ source_order?: { items?: { - amount?: number; - currency?: string; - description?: string; - parent?: string; - quantity?: number; + amount?: number + currency?: string + description?: string + parent?: string + quantity?: number /** @enum {string} */ - type?: "discount" | "shipping" | "sku" | "tax"; - }[]; + type?: 'discount' | 'shipping' | 'sku' | 'tax' + }[] /** order_shipping */ shipping?: { /** address */ address: { - city?: string; - country?: string; - line1: string; - line2?: string; - postal_code?: string; - state?: string; - }; - carrier?: string; - name?: string; - phone?: string; - tracking_number?: string; - }; - }; - }; - }; - }; - }; + city?: string + country?: string + line1: string + line2?: string + postal_code?: string + state?: string + } + carrier?: string + name?: string + phone?: string + tracking_number?: string + } + } + } + } + } + } /**

Retrieves a new Source MandateNotification.

*/ GetSourcesSourceMandateNotificationsMandateNotification: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - mandate_notification: string; - source: string; - }; - }; + mandate_notification: string + source: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["source_mandate_notification"]; - }; - }; + 'application/json': components['schemas']['source_mandate_notification'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

List source transactions for a given source.

*/ GetSourcesSourceSourceTransactions: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - source: string; - }; - }; + source: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["source_transaction"][]; + 'application/json': { + data: components['schemas']['source_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ GetSourcesSourceSourceTransactionsSourceTransaction: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - source: string; - source_transaction: string; - }; - }; + source: string + source_transaction: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["source_transaction"]; - }; - }; + 'application/json': components['schemas']['source_transaction'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Verify a given source.

*/ PostSourcesSourceVerify: { parameters: { path: { - source: string; - }; - }; + source: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["source"]; - }; - }; + 'application/json': components['schemas']['source'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The values needed to verify the source. */ - values: string[]; - }; - }; - }; - }; + values: string[] + } + } + } + } /**

Returns a list of your subscription items for a given subscription.

*/ GetSubscriptionItems: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** The ID of the subscription whose items will be retrieved. */ - subscription: string; - }; - }; + subscription: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["subscription_item"][]; + 'application/json': { + data: components['schemas']['subscription_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Adds a new item to an existing subscription. No existing items will be changed or replaced.

*/ PostSubscriptionItems: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription_item"]; - }; - }; + 'application/json': components['schemas']['subscription_item'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. */ billing_thresholds?: Partial<{ - usage_gte: number; + usage_gte: number }> & - Partial<"">; + Partial<''> /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * @description Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * @@ -40498,32 +40240,28 @@ export type operations = { * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. * @enum {string} */ - payment_behavior?: - | "allow_incomplete" - | "default_incomplete" - | "error_if_incomplete" - | "pending_if_incomplete"; + payment_behavior?: 'allow_incomplete' | 'default_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete' /** @description The ID of the price object. */ - price?: string; + price?: string /** * recurring_price_data * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; + unit_amount_decimal?: string + } /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -40532,88 +40270,88 @@ export type operations = { * Prorations can be disabled by passing `none`. * @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** * Format: unix-time * @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. */ - proration_date?: number; + proration_date?: number /** @description The quantity you'd like to apply to the subscription item you're creating. */ - quantity?: number; + quantity?: number /** @description The identifier of the subscription to modify. */ - subscription: string; + subscription: string /** @description A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. */ - tax_rates?: Partial & Partial<"">; - }; - }; - }; - }; + tax_rates?: Partial & Partial<''> + } + } + } + } /**

Retrieves the subscription item with the given ID.

*/ GetSubscriptionItemsItem: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - item: string; - }; - }; + item: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription_item"]; - }; - }; + 'application/json': components['schemas']['subscription_item'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates the plan or quantity of an item on a current subscription.

*/ PostSubscriptionItemsItem: { parameters: { path: { - item: string; - }; - }; + item: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription_item"]; - }; - }; + 'application/json': components['schemas']['subscription_item'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. */ billing_thresholds?: Partial<{ - usage_gte: number; + usage_gte: number }> & - Partial<"">; + Partial<''> /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. */ - off_session?: boolean; + off_session?: boolean /** * @description Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * @@ -40624,32 +40362,28 @@ export type operations = { * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. * @enum {string} */ - payment_behavior?: - | "allow_incomplete" - | "default_incomplete" - | "error_if_incomplete" - | "pending_if_incomplete"; + payment_behavior?: 'allow_incomplete' | 'default_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete' /** @description The ID of the price object. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided. */ - price?: string; + price?: string /** * recurring_price_data * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; + unit_amount_decimal?: string + } /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -40658,46 +40392,46 @@ export type operations = { * Prorations can be disabled by passing `none`. * @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** * Format: unix-time * @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. */ - proration_date?: number; + proration_date?: number /** @description The quantity you'd like to apply to the subscription item you're creating. */ - quantity?: number; + quantity?: number /** @description A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. */ - tax_rates?: Partial & Partial<"">; - }; - }; - }; - }; + tax_rates?: Partial & Partial<''> + } + } + } + } /**

Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.

*/ DeleteSubscriptionItemsItem: { parameters: { path: { - item: string; - }; - }; + item: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_subscription_item"]; - }; - }; + 'application/json': components['schemas']['deleted_subscription_item'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Delete all usage for the given subscription item. Allowed only when the current plan's `usage_type` is `metered`. */ - clear_usage?: boolean; + clear_usage?: boolean /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -40706,16 +40440,16 @@ export type operations = { * Prorations can be disabled by passing `none`. * @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** * Format: unix-time * @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. */ - proration_date?: number; - }; - }; - }; - }; + proration_date?: number + } + } + } + } /** *

For the specified subscription item, returns a list of summary objects. Each object in the list provides usage information that’s been summarized from multiple usage records and over a subscription billing period (e.g., 15 usage records in the month of September).

* @@ -40725,49 +40459,49 @@ export type operations = { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - subscription_item: string; - }; - }; + subscription_item: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["usage_record_summary"][]; + 'application/json': { + data: components['schemas']['usage_record_summary'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Creates a usage record for a specified subscription item and date, and fills it with a quantity.

* @@ -40780,712 +40514,703 @@ export type operations = { PostSubscriptionItemsSubscriptionItemUsageRecords: { parameters: { path: { - subscription_item: string; - }; - }; + subscription_item: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["usage_record"]; - }; - }; + 'application/json': components['schemas']['usage_record'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * @description Valid values are `increment` (default) or `set`. When using `increment` the specified `quantity` will be added to the usage at the specified timestamp. The `set` action will overwrite the usage quantity at that timestamp. If the subscription has [billing thresholds](https://stripe.com/docs/api/subscriptions/object#subscription_object-billing_thresholds), `increment` is the only allowed value. * @enum {string} */ - action?: "increment" | "set"; + action?: 'increment' | 'set' /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The usage quantity for the specified timestamp. */ - quantity: number; + quantity: number /** @description The timestamp for the usage event. This timestamp must be within the current billing period of the subscription of the provided `subscription_item`, and must not be in the future. When passing `"now"`, Stripe records usage for the current time. Default is `"now"` if a value is not provided. */ - timestamp?: Partial<"now"> & Partial; - }; - }; - }; - }; + timestamp?: Partial<'now'> & Partial + } + } + } + } /**

Retrieves the list of your subscription schedules.

*/ GetSubscriptionSchedules: { parameters: { query: { /** Only return subscription schedules that were created canceled the given date interval. */ canceled_at?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** Only return subscription schedules that completed during the given date interval. */ completed_at?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** Only return subscription schedules that were created during the given date interval. */ created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** Only return subscription schedules for the given customer. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return subscription schedules that were released during the given date interval. */ released_at?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** Only return subscription schedules that have not started yet. */ - scheduled?: boolean; + scheduled?: boolean /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["subscription_schedule"][]; + 'application/json': { + data: components['schemas']['subscription_schedule'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.

*/ PostSubscriptionSchedules: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription_schedule"]; - }; - }; + 'application/json': components['schemas']['subscription_schedule'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The identifier of the customer to create the subscription schedule for. */ - customer?: string; + customer?: string /** * default_settings_params * @description Object representing the subscription schedule's default settings. */ default_settings?: { - application_fee_percent?: number; + application_fee_percent?: number /** automatic_tax_config */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** @enum {string} */ - billing_cycle_anchor?: "automatic" | "phase_start"; + billing_cycle_anchor?: 'automatic' | 'phase_start' billing_thresholds?: Partial<{ - amount_gte?: number; - reset_billing_cycle_anchor?: boolean; + amount_gte?: number + reset_billing_cycle_anchor?: boolean }> & - Partial<"">; + Partial<''> /** @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; - default_payment_method?: string; + collection_method?: 'charge_automatically' | 'send_invoice' + default_payment_method?: string /** subscription_schedules_param */ invoice_settings?: { - days_until_due?: number; - }; + days_until_due?: number + } transfer_data?: Partial<{ - amount_percent?: number; - destination: string; + amount_percent?: number + destination: string }> & - Partial<"">; - }; + Partial<''> + } /** * @description Configures how the subscription schedule behaves 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. * @enum {string} */ - end_behavior?: "cancel" | "none" | "release" | "renew"; + end_behavior?: 'cancel' | 'none' | 'release' | 'renew' /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls. */ - from_subscription?: string; + from_subscription?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. */ phases?: { add_invoice_items?: { - price?: string; + price?: string /** one_time_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; - application_fee_percent?: number; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] + application_fee_percent?: number /** automatic_tax_config */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** @enum {string} */ - billing_cycle_anchor?: "automatic" | "phase_start"; + billing_cycle_anchor?: 'automatic' | 'phase_start' billing_thresholds?: Partial<{ - amount_gte?: number; - reset_billing_cycle_anchor?: boolean; + amount_gte?: number + reset_billing_cycle_anchor?: boolean }> & - Partial<"">; + Partial<''> /** @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; - coupon?: string; - default_payment_method?: string; - default_tax_rates?: Partial & Partial<"">; + collection_method?: 'charge_automatically' | 'send_invoice' + coupon?: string + default_payment_method?: string + default_tax_rates?: Partial & Partial<''> /** Format: unix-time */ - end_date?: number; + end_date?: number /** subscription_schedules_param */ invoice_settings?: { - days_until_due?: number; - }; + days_until_due?: number + } items: { billing_thresholds?: Partial<{ - usage_gte: number; + usage_gte: number }> & - Partial<"">; - price?: string; + Partial<''> + price?: string /** recurring_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; - iterations?: number; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] + iterations?: number /** @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** transfer_data_specs */ transfer_data?: { - amount_percent?: number; - destination: string; - }; - trial?: boolean; + amount_percent?: number + destination: string + } + trial?: boolean /** Format: unix-time */ - trial_end?: number; - }[]; + trial_end?: number + }[] /** @description When the subscription schedule starts. We recommend using `now` so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on. */ - start_date?: Partial & Partial<"now">; - }; - }; - }; - }; + start_date?: Partial & Partial<'now'> + } + } + } + } /**

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.

*/ GetSubscriptionSchedulesSchedule: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - schedule: string; - }; - }; + schedule: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription_schedule"]; - }; - }; + 'application/json': components['schemas']['subscription_schedule'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates an existing subscription schedule.

*/ PostSubscriptionSchedulesSchedule: { parameters: { path: { - schedule: string; - }; - }; + schedule: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription_schedule"]; - }; - }; + 'application/json': components['schemas']['subscription_schedule'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * default_settings_params * @description Object representing the subscription schedule's default settings. */ default_settings?: { - application_fee_percent?: number; + application_fee_percent?: number /** automatic_tax_config */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** @enum {string} */ - billing_cycle_anchor?: "automatic" | "phase_start"; + billing_cycle_anchor?: 'automatic' | 'phase_start' billing_thresholds?: Partial<{ - amount_gte?: number; - reset_billing_cycle_anchor?: boolean; + amount_gte?: number + reset_billing_cycle_anchor?: boolean }> & - Partial<"">; + Partial<''> /** @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; - default_payment_method?: string; + collection_method?: 'charge_automatically' | 'send_invoice' + default_payment_method?: string /** subscription_schedules_param */ invoice_settings?: { - days_until_due?: number; - }; + days_until_due?: number + } transfer_data?: Partial<{ - amount_percent?: number; - destination: string; + amount_percent?: number + destination: string }> & - Partial<"">; - }; + Partial<''> + } /** * @description Configures how the subscription schedule behaves 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. * @enum {string} */ - end_behavior?: "cancel" | "none" | "release" | "renew"; + end_behavior?: 'cancel' | 'none' | 'release' | 'renew' /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. Note that past phases can be omitted. */ phases?: { add_invoice_items?: { - price?: string; + price?: string /** one_time_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; - application_fee_percent?: number; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] + application_fee_percent?: number /** automatic_tax_config */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** @enum {string} */ - billing_cycle_anchor?: "automatic" | "phase_start"; + billing_cycle_anchor?: 'automatic' | 'phase_start' billing_thresholds?: Partial<{ - amount_gte?: number; - reset_billing_cycle_anchor?: boolean; + amount_gte?: number + reset_billing_cycle_anchor?: boolean }> & - Partial<"">; + Partial<''> /** @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; - coupon?: string; - default_payment_method?: string; - default_tax_rates?: Partial & Partial<"">; - end_date?: Partial & Partial<"now">; + collection_method?: 'charge_automatically' | 'send_invoice' + coupon?: string + default_payment_method?: string + default_tax_rates?: Partial & Partial<''> + end_date?: Partial & Partial<'now'> /** subscription_schedules_param */ invoice_settings?: { - days_until_due?: number; - }; + days_until_due?: number + } items: { billing_thresholds?: Partial<{ - usage_gte: number; + usage_gte: number }> & - Partial<"">; - price?: string; + Partial<''> + price?: string /** recurring_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; - iterations?: number; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] + iterations?: number /** @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; - start_date?: Partial & Partial<"now">; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' + start_date?: Partial & Partial<'now'> /** transfer_data_specs */ transfer_data?: { - amount_percent?: number; - destination: string; - }; - trial?: boolean; - trial_end?: Partial & Partial<"now">; - }[]; + amount_percent?: number + destination: string + } + trial?: boolean + trial_end?: Partial & Partial<'now'> + }[] /** * @description If the update changes the current phase, indicates if the changes should be prorated. Possible values are `create_prorations` or `none`, and the default value is `create_prorations`. * @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; - }; - }; - }; - }; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' + } + } + } + } /**

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.

*/ PostSubscriptionSchedulesScheduleCancel: { parameters: { path: { - schedule: string; - }; - }; + schedule: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription_schedule"]; - }; - }; + 'application/json': components['schemas']['subscription_schedule'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Defaults to `true`. */ - invoice_now?: boolean; + invoice_now?: boolean /** @description If the subscription schedule is `active`, indicates if the cancellation should be prorated. Defaults to `true`. */ - prorate?: boolean; - }; - }; - }; - }; + prorate?: boolean + } + } + } + } /**

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.

*/ PostSubscriptionSchedulesScheduleRelease: { parameters: { path: { - schedule: string; - }; - }; + schedule: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription_schedule"]; - }; - }; + 'application/json': components['schemas']['subscription_schedule'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Keep any cancellation on the subscription that the schedule has set */ - preserve_cancel_date?: boolean; - }; - }; - }; - }; + preserve_cancel_date?: boolean + } + } + } + } /**

By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.

*/ GetSubscriptions: { parameters: { query: { /** The collection method of the subscriptions to retrieve. Either `charge_automatically` or `send_invoice`. */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial current_period_end?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial current_period_start?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** The ID of the customer whose subscriptions will be retrieved. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Filter for subscriptions that contain this recurring price ID. */ - price?: string; + price?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** 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?: - | "active" - | "all" - | "canceled" - | "ended" - | "incomplete" - | "incomplete_expired" - | "past_due" - | "trialing" - | "unpaid"; - }; - }; + status?: 'active' | 'all' | 'canceled' | 'ended' | 'incomplete' | 'incomplete_expired' | 'past_due' | 'trialing' | 'unpaid' + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["subscription"][]; + 'application/json': { + data: components['schemas']['subscription'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.

*/ PostSubscriptions: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription"]; - }; - }; + 'application/json': components['schemas']['subscription'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A list of prices and quantities that will generate invoice items appended to the first invoice for this subscription. You may pass up to 20 items. */ add_invoice_items?: { - price?: string; + price?: string /** one_time_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). */ - application_fee_percent?: number; + application_fee_percent?: number /** * automatic_tax_config * @description Automatic tax settings for this subscription. */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** * Format: unix-time * @description For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor. */ - backdate_start_date?: number; + backdate_start_date?: number /** * Format: unix-time * @description 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. */ - billing_cycle_anchor?: number; + billing_cycle_anchor?: number /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. */ billing_thresholds?: Partial<{ - amount_gte?: number; - reset_billing_cycle_anchor?: boolean; + amount_gte?: number + reset_billing_cycle_anchor?: boolean }> & - Partial<"">; + Partial<''> /** * Format: unix-time * @description 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. */ - cancel_at?: number; + cancel_at?: number /** @description Boolean indicating whether this subscription should cancel at the end of the current period. */ - cancel_at_period_end?: boolean; + cancel_at_period_end?: boolean /** * @description 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. Defaults to `charge_automatically`. * @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' /** @description The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. */ - coupon?: string; + coupon?: string /** @description The identifier of the customer to subscribe. */ - customer: string; + customer: string /** @description Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. */ - days_until_due?: number; + days_until_due?: number /** @description 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?: string; + default_payment_method?: string /** @description 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?: string; + default_source?: string /** @description 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?: Partial & Partial<"">; + default_tax_rates?: Partial & Partial<''> /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A list of up to 20 subscription items, each with an attached price. */ items?: { billing_thresholds?: Partial<{ - usage_gte: number; + usage_gte: number }> & - Partial<"">; - metadata?: { [key: string]: string }; - price?: string; + Partial<''> + metadata?: { [key: string]: string } + price?: string /** recurring_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. */ - off_session?: boolean; + off_session?: boolean /** * @description Use `allow_incomplete` to create subscriptions with `status=incomplete` if the first invoice cannot be paid. Creating subscriptions with this status allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * @@ -41496,11 +41221,7 @@ export type operations = { * `pending_if_incomplete` is only used with updates and cannot be passed when creating a subscription. * @enum {string} */ - payment_behavior?: - | "allow_incomplete" - | "default_incomplete" - | "error_if_incomplete" - | "pending_if_incomplete"; + payment_behavior?: 'allow_incomplete' | 'default_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete' /** * payment_settings * @description Payment settings to pass to invoices created by the subscription. @@ -41512,239 +41233,239 @@ export type operations = { /** mandate_options_param */ mandate_options?: { /** @enum {string} */ - transaction_type?: "business" | "personal"; - }; + transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; + verification_method?: 'automatic' | 'instant' | 'microdeposits' }> & - Partial<"">; + Partial<''> bancontact?: Partial<{ /** @enum {string} */ - preferred_language?: "de" | "en" | "fr" | "nl"; + preferred_language?: 'de' | 'en' | 'fr' | 'nl' }> & - Partial<"">; + Partial<''> card?: Partial<{ /** mandate_options_param */ mandate_options?: { - amount?: number; + amount?: number /** @enum {string} */ - amount_type?: "fixed" | "maximum"; - description?: string; - }; + amount_type?: 'fixed' | 'maximum' + description?: string + } /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: 'any' | 'automatic' }> & - Partial<"">; - }; + Partial<''> + } payment_method_types?: Partial< ( - | "ach_credit_transfer" - | "ach_debit" - | "acss_debit" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "sepa_debit" - | "sofort" - | "wechat_pay" + | 'ach_credit_transfer' + | 'ach_debit' + | 'acss_debit' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' )[] > & - Partial<"">; - }; + Partial<''> + } /** @description 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?: Partial<{ /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number }> & - Partial<"">; + Partial<''> /** @description The API ID of a promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. */ - promotion_code?: string; + promotion_code?: string /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) resulting from the `billing_cycle_anchor`. Valid values are `create_prorations` or `none`. * * Passing `create_prorations` will cause proration invoice items to be created when applicable. Prorations can be disabled by passing `none`. If no value is passed, the default is `create_prorations`. * @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** * transfer_data_specs * @description If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. */ transfer_data?: { - amount_percent?: number; - destination: string; - }; + amount_percent?: number + destination: string + } /** @description Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. */ - trial_end?: Partial<"now"> & Partial; + trial_end?: Partial<'now'> & Partial /** @description 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?: boolean; + trial_from_plan?: boolean /** @description Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. */ - trial_period_days?: number; - }; - }; - }; - }; + trial_period_days?: number + } + } + } + } /**

Retrieves the subscription with the given ID.

*/ GetSubscriptionsSubscriptionExposedId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - subscription_exposed_id: string; - }; - }; + subscription_exposed_id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription"]; - }; - }; + 'application/json': components['schemas']['subscription'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostSubscriptionsSubscriptionExposedId: { parameters: { path: { - subscription_exposed_id: string; - }; - }; + subscription_exposed_id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription"]; - }; - }; + 'application/json': components['schemas']['subscription'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A list of prices and quantities that will generate invoice items appended to the first invoice for this subscription. You may pass up to 20 items. */ add_invoice_items?: { - price?: string; + price?: string /** one_time_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). */ - application_fee_percent?: number; + application_fee_percent?: number /** * automatic_tax_config * @description Automatic tax settings for this subscription. */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** * @description Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). * @enum {string} */ - billing_cycle_anchor?: "now" | "unchanged"; + billing_cycle_anchor?: 'now' | 'unchanged' /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. */ billing_thresholds?: Partial<{ - amount_gte?: number; - reset_billing_cycle_anchor?: boolean; + amount_gte?: number + reset_billing_cycle_anchor?: boolean }> & - Partial<"">; + Partial<''> /** @description 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. */ - cancel_at?: Partial & Partial<"">; + cancel_at?: Partial & Partial<''> /** @description Boolean indicating whether this subscription should cancel at the end of the current period. */ - cancel_at_period_end?: boolean; + cancel_at_period_end?: boolean /** * @description 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. Defaults to `charge_automatically`. * @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' /** @description The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. */ - coupon?: string; + coupon?: string /** @description Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. */ - days_until_due?: number; + days_until_due?: number /** @description 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?: string; + default_payment_method?: string /** @description 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?: string; + default_source?: string /** @description 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. Pass an empty string to remove previously-defined tax rates. */ - default_tax_rates?: Partial & Partial<"">; + default_tax_rates?: Partial & Partial<''> /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A list of up to 20 subscription items, each with an attached price. */ items?: { billing_thresholds?: Partial<{ - usage_gte: number; + usage_gte: number }> & - Partial<"">; - clear_usage?: boolean; - deleted?: boolean; - id?: string; - metadata?: Partial<{ [key: string]: string }> & Partial<"">; - price?: string; + Partial<''> + clear_usage?: boolean + deleted?: boolean + id?: string + metadata?: Partial<{ [key: string]: string }> & Partial<''> + price?: string /** recurring_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. */ - off_session?: boolean; + off_session?: boolean /** @description If specified, payment collection for this subscription will be paused. */ pause_collection?: Partial<{ /** @enum {string} */ - behavior: "keep_as_draft" | "mark_uncollectible" | "void"; + behavior: 'keep_as_draft' | 'mark_uncollectible' | 'void' /** Format: unix-time */ - resumes_at?: number; + resumes_at?: number }> & - Partial<"">; + Partial<''> /** * @description Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * @@ -41755,11 +41476,7 @@ export type operations = { * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. * @enum {string} */ - payment_behavior?: - | "allow_incomplete" - | "default_incomplete" - | "error_if_incomplete" - | "pending_if_incomplete"; + payment_behavior?: 'allow_incomplete' | 'default_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete' /** * payment_settings * @description Payment settings to pass to invoices created by the subscription. @@ -41771,60 +41488,60 @@ export type operations = { /** mandate_options_param */ mandate_options?: { /** @enum {string} */ - transaction_type?: "business" | "personal"; - }; + transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; + verification_method?: 'automatic' | 'instant' | 'microdeposits' }> & - Partial<"">; + Partial<''> bancontact?: Partial<{ /** @enum {string} */ - preferred_language?: "de" | "en" | "fr" | "nl"; + preferred_language?: 'de' | 'en' | 'fr' | 'nl' }> & - Partial<"">; + Partial<''> card?: Partial<{ /** mandate_options_param */ mandate_options?: { - amount?: number; + amount?: number /** @enum {string} */ - amount_type?: "fixed" | "maximum"; - description?: string; - }; + amount_type?: 'fixed' | 'maximum' + description?: string + } /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: 'any' | 'automatic' }> & - Partial<"">; - }; + Partial<''> + } payment_method_types?: Partial< ( - | "ach_credit_transfer" - | "ach_debit" - | "acss_debit" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "sepa_debit" - | "sofort" - | "wechat_pay" + | 'ach_credit_transfer' + | 'ach_debit' + | 'acss_debit' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' )[] > & - Partial<"">; - }; + Partial<''> + } /** @description 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?: Partial<{ /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number }> & - Partial<"">; + Partial<''> /** @description The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. */ - promotion_code?: string; + promotion_code?: string /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -41833,26 +41550,26 @@ export type operations = { * Prorations can be disabled by passing `none`. * @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** * Format: unix-time * @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations. */ - proration_date?: number; + proration_date?: number /** @description If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. This will be unset if you POST an empty value. */ transfer_data?: Partial<{ - amount_percent?: number; - destination: string; + amount_percent?: number + destination: string }> & - Partial<"">; + Partial<''> /** @description Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. */ - trial_end?: Partial<"now"> & Partial; + trial_end?: Partial<'now'> & Partial /** @description 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?: boolean; - }; - }; - }; - }; + trial_from_plan?: boolean + } + } + } + } /** *

Cancels a customer’s subscription immediately. The customer will not be charged again for the subscription.

* @@ -41863,396 +41580,396 @@ export type operations = { DeleteSubscriptionsSubscriptionExposedId: { parameters: { path: { - subscription_exposed_id: string; - }; - }; + subscription_exposed_id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription"]; - }; - }; + 'application/json': components['schemas']['subscription'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items. */ - invoice_now?: boolean; + invoice_now?: boolean /** @description Will generate a proration invoice item that credits remaining unused time until the subscription period end. */ - prorate?: boolean; - }; - }; - }; - }; + prorate?: boolean + } + } + } + } /**

Removes the currently applied discount on a subscription.

*/ DeleteSubscriptionsSubscriptionExposedIdDiscount: { parameters: { path: { - subscription_exposed_id: string; - }; - }; + subscription_exposed_id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_discount"]; - }; - }; + 'application/json': components['schemas']['deleted_discount'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

A list of all tax codes available to add to Products in order to allow specific tax calculations.

*/ GetTaxCodes: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["tax_code"][]; + 'application/json': { + data: components['schemas']['tax_code'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves the details of an existing tax code. Supply the unique tax code ID and Stripe will return the corresponding tax code information.

*/ GetTaxCodesId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["tax_code"]; - }; - }; + 'application/json': components['schemas']['tax_code'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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

*/ GetTaxRates: { parameters: { query: { /** Optional flag to filter by tax rates that are either active or inactive (archived). */ - active?: boolean; + active?: boolean /** Optional range for filtering created date. */ created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** Optional flag to filter by tax rates that are inclusive (or those that are not inclusive). */ - inclusive?: boolean; + inclusive?: boolean /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["tax_rate"][]; + 'application/json': { + data: components['schemas']['tax_rate'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new tax rate.

*/ PostTaxRates: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["tax_rate"]; - }; - }; + 'application/json': components['schemas']['tax_rate'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Flag determining whether the tax rate is active or inactive (archived). Inactive tax rates cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set. */ - active?: boolean; + active?: boolean /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ - country?: string; + country?: string /** @description An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. */ - description?: string; + description?: string /** @description The display name of the tax rate, which will be shown to users. */ - display_name: string; + display_name: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description This specifies if the tax rate is inclusive or exclusive. */ - inclusive: boolean; + inclusive: boolean /** @description 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?: string; + jurisdiction?: string /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description This represents the tax rate percent out of 100. */ - percentage: number; + percentage: number /** @description [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States. */ - state?: string; + state?: string /** * @description The high-level tax type, such as `vat` or `sales_tax`. * @enum {string} */ - tax_type?: "gst" | "hst" | "jct" | "pst" | "qst" | "rst" | "sales_tax" | "vat"; - }; - }; - }; - }; + tax_type?: 'gst' | 'hst' | 'jct' | 'pst' | 'qst' | 'rst' | 'sales_tax' | 'vat' + } + } + } + } /**

Retrieves a tax rate with the given ID

*/ GetTaxRatesTaxRate: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - tax_rate: string; - }; - }; + tax_rate: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["tax_rate"]; - }; - }; + 'application/json': components['schemas']['tax_rate'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates an existing tax rate.

*/ PostTaxRatesTaxRate: { parameters: { path: { - tax_rate: string; - }; - }; + tax_rate: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["tax_rate"]; - }; - }; + 'application/json': components['schemas']['tax_rate'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Flag determining whether the tax rate is active or inactive (archived). Inactive tax rates cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set. */ - active?: boolean; + active?: boolean /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ - country?: string; + country?: string /** @description An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. */ - description?: string; + description?: string /** @description The display name of the tax rate, which will be shown to users. */ - display_name?: string; + display_name?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: string; + jurisdiction?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States. */ - state?: string; + state?: string /** * @description The high-level tax type, such as `vat` or `sales_tax`. * @enum {string} */ - tax_type?: "gst" | "hst" | "jct" | "pst" | "qst" | "rst" | "sales_tax" | "vat"; - }; - }; - }; - }; + tax_type?: 'gst' | 'hst' | 'jct' | 'pst' | 'qst' | 'rst' | 'sales_tax' | 'vat' + } + } + } + } /**

To connect to a reader the Stripe Terminal SDK needs to retrieve a short-lived connection token from Stripe, proxied through your server. On your backend, add an endpoint that creates and returns a connection token.

*/ PostTerminalConnectionTokens: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["terminal.connection_token"]; - }; - }; + 'application/json': components['schemas']['terminal.connection_token'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The id of the location that this connection token is scoped to. If specified the connection token will only be usable with readers assigned to that location, otherwise the connection token will be usable with all readers. Note that location scoping only applies to internet-connected readers. For more details, see [the docs on scoping connection tokens](https://stripe.com/docs/terminal/fleet/locations#connection-tokens). */ - location?: string; - }; - }; - }; - }; + location?: string + } + } + } + } /**

Returns a list of Location objects.

*/ GetTerminalLocations: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["terminal.location"][]; + 'application/json': { + data: components['schemas']['terminal.location'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Creates a new Location object. * For further details, including which address fields are required in each country, see the Manage locations guide.

@@ -42262,324 +41979,322 @@ export type operations = { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["terminal.location"]; - }; - }; + 'application/json': components['schemas']['terminal.location'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * create_location_address_param * @description The full address of the location. */ address: { - city?: string; - country: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** @description A name for the location. */ - display_name: string; + display_name: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Retrieves a Location object.

*/ GetTerminalLocationsLocation: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - location: string; - }; - }; + location: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["terminal.location"]; - }; - }; + 'application/json': components['schemas']['terminal.location'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates a Location object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ PostTerminalLocationsLocation: { parameters: { path: { - location: string; - }; - }; + location: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["terminal.location"]; - }; - }; + 'application/json': components['schemas']['terminal.location'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * optional_fields_address * @description The full address of the location. */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** @description A name for the location. */ - display_name?: string; + display_name?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Deletes a Location object.

*/ DeleteTerminalLocationsLocation: { parameters: { path: { - location: string; - }; - }; + location: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_terminal.location"]; - }; - }; + 'application/json': components['schemas']['deleted_terminal.location'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of Reader objects.

*/ GetTerminalReaders: { parameters: { query: { /** Filters readers by device type */ - device_type?: "bbpos_chipper2x" | "bbpos_wisepos_e" | "verifone_P400"; + device_type?: 'bbpos_chipper2x' | 'bbpos_wisepos_e' | 'verifone_P400' /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A location ID to filter the response list to only readers at the specific location */ - location?: string; + location?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** A status filter to filter readers to only offline or online readers */ - status?: "offline" | "online"; - }; - }; + status?: 'offline' | 'online' + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description A list of readers */ - data: components["schemas"]["terminal.reader"][]; + data: components['schemas']['terminal.reader'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new Reader object.

*/ PostTerminalReaders: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["terminal.reader"]; - }; - }; + 'application/json': components['schemas']['terminal.reader'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Custom label given to the reader for easier identification. If no label is specified, the registration code will be used. */ - label?: string; + label?: string /** @description The location to assign the reader to. */ - location?: string; + location?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description A code generated by the reader used for registering to an account. */ - registration_code: string; - }; - }; - }; - }; + registration_code: string + } + } + } + } /**

Retrieves a Reader object.

*/ GetTerminalReadersReader: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - reader: string; - }; - }; + reader: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": Partial & - Partial; - }; - }; + 'application/json': Partial & Partial + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ PostTerminalReadersReader: { parameters: { path: { - reader: string; - }; - }; + reader: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": Partial & - Partial; - }; - }; + 'application/json': Partial & Partial + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The new label of the reader. */ - label?: string; + label?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Deletes a Reader object.

*/ DeleteTerminalReadersReader: { parameters: { path: { - reader: string; - }; - }; + reader: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_terminal.reader"]; - }; - }; + 'application/json': components['schemas']['deleted_terminal.reader'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Creates a single-use token that represents a bank account’s details. * This token can be used with any API method in place of a bank account dictionary. This token can be used only once, by attaching it to a Custom account.

@@ -42589,218 +42304,218 @@ export type operations = { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["token"]; - }; - }; + 'application/json': components['schemas']['token'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * connect_js_account_token_specs * @description Information for the account this token will represent. */ account?: { /** @enum {string} */ - business_type?: "company" | "government_entity" | "individual" | "non_profit"; + business_type?: 'company' | 'government_entity' | 'individual' | 'non_profit' /** connect_js_account_token_company_specs */ company?: { /** address_specs */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** japan_address_kana_specs */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** japan_address_kanji_specs */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; - directors_provided?: boolean; - executives_provided?: boolean; - name?: string; - name_kana?: string; - name_kanji?: string; - owners_provided?: boolean; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } + directors_provided?: boolean + executives_provided?: boolean + name?: string + name_kana?: string + name_kanji?: string + owners_provided?: boolean /** company_ownership_declaration */ ownership_declaration?: { /** Format: unix-time */ - date?: number; - ip?: string; - user_agent?: string; - }; - ownership_declaration_shown_and_signed?: boolean; - phone?: string; - registration_number?: string; + date?: number + ip?: string + user_agent?: string + } + ownership_declaration_shown_and_signed?: boolean + phone?: string + registration_number?: string /** @enum {string} */ structure?: - | "" - | "free_zone_establishment" - | "free_zone_llc" - | "government_instrumentality" - | "governmental_unit" - | "incorporated_non_profit" - | "limited_liability_partnership" - | "llc" - | "multi_member_llc" - | "private_company" - | "private_corporation" - | "private_partnership" - | "public_company" - | "public_corporation" - | "public_partnership" - | "single_member_llc" - | "sole_establishment" - | "sole_proprietorship" - | "tax_exempt_government_instrumentality" - | "unincorporated_association" - | "unincorporated_non_profit"; - tax_id?: string; - tax_id_registrar?: string; - vat_id?: string; + | '' + | 'free_zone_establishment' + | 'free_zone_llc' + | 'government_instrumentality' + | 'governmental_unit' + | 'incorporated_non_profit' + | 'limited_liability_partnership' + | 'llc' + | 'multi_member_llc' + | 'private_company' + | 'private_corporation' + | 'private_partnership' + | 'public_company' + | 'public_corporation' + | 'public_partnership' + | 'single_member_llc' + | 'sole_establishment' + | 'sole_proprietorship' + | 'tax_exempt_government_instrumentality' + | 'unincorporated_association' + | 'unincorporated_non_profit' + tax_id?: string + tax_id_registrar?: string + vat_id?: string /** verification_specs */ verification?: { /** verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; + back?: string + front?: string + } + } + } /** individual_specs */ individual?: { /** address_specs */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** japan_address_kana_specs */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** japan_address_kanji_specs */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } dob?: Partial<{ - day: number; - month: number; - year: number; + day: number + month: number + year: number }> & - Partial<"">; - email?: string; - first_name?: string; - first_name_kana?: string; - first_name_kanji?: string; - full_name_aliases?: Partial & Partial<"">; - gender?: string; - id_number?: string; - last_name?: string; - last_name_kana?: string; - last_name_kanji?: string; - maiden_name?: string; - metadata?: Partial<{ [key: string]: string }> & Partial<"">; - phone?: string; + Partial<''> + email?: string + first_name?: string + first_name_kana?: string + first_name_kanji?: string + full_name_aliases?: Partial & Partial<''> + gender?: string + id_number?: string + last_name?: string + last_name_kana?: string + last_name_kanji?: string + maiden_name?: string + metadata?: Partial<{ [key: string]: string }> & Partial<''> + phone?: string /** @enum {string} */ - political_exposure?: "existing" | "none"; - ssn_last_4?: string; + political_exposure?: 'existing' | 'none' + ssn_last_4?: string /** person_verification_specs */ verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; - tos_shown_and_accepted?: boolean; - }; + back?: string + front?: string + } + } + } + tos_shown_and_accepted?: boolean + } /** * token_create_bank_account * @description The bank account this token will represent. */ bank_account?: { - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; + account_holder_type?: 'company' | 'individual' + account_number: string /** @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; - country: string; - currency?: string; - routing_number?: string; - }; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' + country: string + currency?: string + routing_number?: string + } card?: Partial<{ - address_city?: string; - address_country?: string; - address_line1?: string; - address_line2?: string; - address_state?: string; - address_zip?: string; - currency?: string; - cvc?: string; - exp_month: string; - exp_year: string; - name?: string; - number: string; + address_city?: string + address_country?: string + address_line1?: string + address_line2?: string + address_state?: string + address_zip?: string + currency?: string + cvc?: string + exp_month: string + exp_year: string + name?: string + number: string }> & - Partial; + Partial /** @description The customer (owned by the application's account) for which to create a token. This can be used only with an [OAuth access token](https://stripe.com/docs/connect/standard-accounts) or [Stripe-Account header](https://stripe.com/docs/connect/authentication). For more details, see [Cloning Saved Payment Methods](https://stripe.com/docs/connect/cloning-saved-payment-methods). */ - customer?: string; + customer?: string /** * cvc_params * @description The updated CVC value this token will represent. */ cvc_update?: { - cvc: string; - }; + cvc: string + } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * person_token_specs * @description Information for the person this token will represent. @@ -42808,482 +42523,482 @@ export type operations = { person?: { /** address_specs */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** japan_address_kana_specs */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** japan_address_kanji_specs */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } dob?: Partial<{ - day: number; - month: number; - year: number; + day: number + month: number + year: number }> & - Partial<"">; + Partial<''> /** person_documents_specs */ documents?: { /** documents_param */ company_authorization?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ passport?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ visa?: { - files?: string[]; - }; - }; - email?: string; - first_name?: string; - first_name_kana?: string; - first_name_kanji?: string; - full_name_aliases?: Partial & Partial<"">; - gender?: string; - id_number?: string; - last_name?: string; - last_name_kana?: string; - last_name_kanji?: string; - maiden_name?: string; - metadata?: Partial<{ [key: string]: string }> & Partial<"">; - nationality?: string; - phone?: string; - political_exposure?: string; + files?: string[] + } + } + email?: string + first_name?: string + first_name_kana?: string + first_name_kanji?: string + full_name_aliases?: Partial & Partial<''> + gender?: string + id_number?: string + last_name?: string + last_name_kana?: string + last_name_kanji?: string + maiden_name?: string + metadata?: Partial<{ [key: string]: string }> & Partial<''> + nationality?: string + phone?: string + political_exposure?: string /** relationship_specs */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - percent_ownership?: Partial & Partial<"">; - representative?: boolean; - title?: string; - }; - ssn_last_4?: string; + director?: boolean + executive?: boolean + owner?: boolean + percent_ownership?: Partial & Partial<''> + representative?: boolean + title?: string + } + ssn_last_4?: string /** person_verification_specs */ verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; + back?: string + front?: string + } + } + } /** * pii_token_specs * @description The PII this token will represent. */ pii?: { - id_number?: string; - }; - }; - }; - }; - }; + id_number?: string + } + } + } + } + } /**

Retrieves the token with the given ID.

*/ GetTokensToken: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - token: string; - }; - }; + token: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["token"]; - }; - }; + 'application/json': components['schemas']['token'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of top-ups.

*/ GetTopups: { parameters: { query: { /** A positive integer representing how much to transfer. */ amount?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** 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?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return top-ups that have the given status. One of `canceled`, `failed`, `pending` or `succeeded`. */ - status?: "canceled" | "failed" | "pending" | "succeeded"; - }; - }; + status?: 'canceled' | 'failed' | 'pending' | 'succeeded' + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["topup"][]; + 'application/json': { + data: components['schemas']['topup'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Top up the balance of an account

*/ PostTopups: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["topup"]; - }; - }; + 'application/json': components['schemas']['topup'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A positive integer representing how much to transfer. */ - amount: number; + amount: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The ID of a source to transfer funds from. For most users, this should be left unspecified which will use the bank account that was set up in the dashboard for the specified currency. In test mode, this can be a test bank token (see [Testing Top-ups](https://stripe.com/docs/connect/testing#testing-top-ups)). */ - source?: string; + source?: string /** @description Extra information about a top-up for the source's bank statement. Limited to 15 ASCII characters. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description A string that identifies this top-up as part of a group. */ - transfer_group?: string; - }; - }; - }; - }; + transfer_group?: string + } + } + } + } /**

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.

*/ GetTopupsTopup: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - topup: string; - }; - }; + topup: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["topup"]; - }; - }; + 'application/json': components['schemas']['topup'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates the metadata of a top-up. Other top-up details are not editable by design.

*/ PostTopupsTopup: { parameters: { path: { - topup: string; - }; - }; + topup: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["topup"]; - }; - }; + 'application/json': components['schemas']['topup'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Cancels a top-up. Only pending top-ups can be canceled.

*/ PostTopupsTopupCancel: { parameters: { path: { - topup: string; - }; - }; + topup: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["topup"]; - }; - }; + 'application/json': components['schemas']['topup'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

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.

*/ GetTransfers: { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** Only return transfers for the destination specified by this account ID. */ - destination?: string; + destination?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return transfers with the specified transfer group. */ - transfer_group?: string; - }; - }; + transfer_group?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["transfer"][]; + data: components['schemas']['transfer'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostTransfers: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["transfer"]; - }; - }; + 'application/json': components['schemas']['transfer'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A positive integer in %s representing how much to transfer. */ - amount?: number; + amount?: number /** @description 3-letter [ISO code for currency](https://stripe.com/docs/payouts). */ - currency: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description The ID of a connected Stripe account. See the Connect documentation for details. */ - destination: string; + destination: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description You can use this parameter to transfer funds from a charge before they are added to your available balance. A pending balance will transfer immediately but the funds will not become available until the original charge becomes available. [See the Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-availability) for details. */ - source_transaction?: string; + source_transaction?: string /** * @description The source balance to use for this transfer. One of `bank_account`, `card`, or `fpx`. For most users, this will default to `card`. * @enum {string} */ - source_type?: "bank_account" | "card" | "fpx"; + source_type?: 'bank_account' | 'card' | 'fpx' /** @description A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-options) for details. */ - transfer_group?: string; - }; - }; - }; - }; + transfer_group?: string + } + } + } + } /**

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.

*/ GetTransfersIdReversals: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["transfer_reversal"][]; + data: components['schemas']['transfer_reversal'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

When you create a new reversal, you must specify a transfer to create it on.

* @@ -43294,71 +43009,71 @@ export type operations = { PostTransfersIdReversals: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["transfer_reversal"]; - }; - }; + 'application/json': components['schemas']['transfer_reversal'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A positive integer in %s representing how much of this transfer to reverse. Can only reverse up to the unreversed amount remaining of the transfer. Partial transfer reversals are only allowed for transfers to Stripe Accounts. Defaults to the entire transfer amount. */ - amount?: number; + amount?: number /** @description An arbitrary string which you can attach to a reversal object. It is displayed alongside the reversal in the Dashboard. This will be unset if you POST an empty value. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Boolean indicating whether the application fee should be refunded when reversing this transfer. If a full transfer reversal is given, the full application fee will be refunded. Otherwise, the application fee will be refunded with an amount proportional to the amount of the transfer reversed. */ - refund_application_fee?: boolean; - }; - }; - }; - }; + refund_application_fee?: boolean + } + } + } + } /**

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.

*/ GetTransfersTransfer: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - transfer: string; - }; - }; + transfer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["transfer"]; - }; - }; + 'application/json': components['schemas']['transfer'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

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

* @@ -43367,68 +43082,68 @@ export type operations = { PostTransfersTransfer: { parameters: { path: { - transfer: string; - }; - }; + transfer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["transfer"]; - }; - }; + 'application/json': components['schemas']['transfer'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

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.

*/ GetTransfersTransferReversalsId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - transfer: string; - }; - }; + id: string + transfer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["transfer_reversal"]; - }; - }; + 'application/json': components['schemas']['transfer_reversal'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

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

* @@ -43437,676 +43152,676 @@ export type operations = { PostTransfersTransferReversalsId: { parameters: { path: { - id: string; - transfer: string; - }; - }; + id: string + transfer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["transfer_reversal"]; - }; - }; + 'application/json': components['schemas']['transfer_reversal'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Returns a list of your webhook endpoints.

*/ GetWebhookEndpoints: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["webhook_endpoint"][]; + 'application/json': { + data: components['schemas']['webhook_endpoint'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostWebhookEndpoints: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["webhook_endpoint"]; - }; - }; + 'application/json': components['schemas']['webhook_endpoint'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * @description Events sent to this endpoint will be generated with this Stripe Version instead of your account's default Stripe Version. * @enum {string} */ api_version?: - | "2011-01-01" - | "2011-06-21" - | "2011-06-28" - | "2011-08-01" - | "2011-09-15" - | "2011-11-17" - | "2012-02-23" - | "2012-03-25" - | "2012-06-18" - | "2012-06-28" - | "2012-07-09" - | "2012-09-24" - | "2012-10-26" - | "2012-11-07" - | "2013-02-11" - | "2013-02-13" - | "2013-07-05" - | "2013-08-12" - | "2013-08-13" - | "2013-10-29" - | "2013-12-03" - | "2014-01-31" - | "2014-03-13" - | "2014-03-28" - | "2014-05-19" - | "2014-06-13" - | "2014-06-17" - | "2014-07-22" - | "2014-07-26" - | "2014-08-04" - | "2014-08-20" - | "2014-09-08" - | "2014-10-07" - | "2014-11-05" - | "2014-11-20" - | "2014-12-08" - | "2014-12-17" - | "2014-12-22" - | "2015-01-11" - | "2015-01-26" - | "2015-02-10" - | "2015-02-16" - | "2015-02-18" - | "2015-03-24" - | "2015-04-07" - | "2015-06-15" - | "2015-07-07" - | "2015-07-13" - | "2015-07-28" - | "2015-08-07" - | "2015-08-19" - | "2015-09-03" - | "2015-09-08" - | "2015-09-23" - | "2015-10-01" - | "2015-10-12" - | "2015-10-16" - | "2016-02-03" - | "2016-02-19" - | "2016-02-22" - | "2016-02-23" - | "2016-02-29" - | "2016-03-07" - | "2016-06-15" - | "2016-07-06" - | "2016-10-19" - | "2017-01-27" - | "2017-02-14" - | "2017-04-06" - | "2017-05-25" - | "2017-06-05" - | "2017-08-15" - | "2017-12-14" - | "2018-01-23" - | "2018-02-05" - | "2018-02-06" - | "2018-02-28" - | "2018-05-21" - | "2018-07-27" - | "2018-08-23" - | "2018-09-06" - | "2018-09-24" - | "2018-10-31" - | "2018-11-08" - | "2019-02-11" - | "2019-02-19" - | "2019-03-14" - | "2019-05-16" - | "2019-08-14" - | "2019-09-09" - | "2019-10-08" - | "2019-10-17" - | "2019-11-05" - | "2019-12-03" - | "2020-03-02" - | "2020-08-27"; + | '2011-01-01' + | '2011-06-21' + | '2011-06-28' + | '2011-08-01' + | '2011-09-15' + | '2011-11-17' + | '2012-02-23' + | '2012-03-25' + | '2012-06-18' + | '2012-06-28' + | '2012-07-09' + | '2012-09-24' + | '2012-10-26' + | '2012-11-07' + | '2013-02-11' + | '2013-02-13' + | '2013-07-05' + | '2013-08-12' + | '2013-08-13' + | '2013-10-29' + | '2013-12-03' + | '2014-01-31' + | '2014-03-13' + | '2014-03-28' + | '2014-05-19' + | '2014-06-13' + | '2014-06-17' + | '2014-07-22' + | '2014-07-26' + | '2014-08-04' + | '2014-08-20' + | '2014-09-08' + | '2014-10-07' + | '2014-11-05' + | '2014-11-20' + | '2014-12-08' + | '2014-12-17' + | '2014-12-22' + | '2015-01-11' + | '2015-01-26' + | '2015-02-10' + | '2015-02-16' + | '2015-02-18' + | '2015-03-24' + | '2015-04-07' + | '2015-06-15' + | '2015-07-07' + | '2015-07-13' + | '2015-07-28' + | '2015-08-07' + | '2015-08-19' + | '2015-09-03' + | '2015-09-08' + | '2015-09-23' + | '2015-10-01' + | '2015-10-12' + | '2015-10-16' + | '2016-02-03' + | '2016-02-19' + | '2016-02-22' + | '2016-02-23' + | '2016-02-29' + | '2016-03-07' + | '2016-06-15' + | '2016-07-06' + | '2016-10-19' + | '2017-01-27' + | '2017-02-14' + | '2017-04-06' + | '2017-05-25' + | '2017-06-05' + | '2017-08-15' + | '2017-12-14' + | '2018-01-23' + | '2018-02-05' + | '2018-02-06' + | '2018-02-28' + | '2018-05-21' + | '2018-07-27' + | '2018-08-23' + | '2018-09-06' + | '2018-09-24' + | '2018-10-31' + | '2018-11-08' + | '2019-02-11' + | '2019-02-19' + | '2019-03-14' + | '2019-05-16' + | '2019-08-14' + | '2019-09-09' + | '2019-10-08' + | '2019-10-17' + | '2019-11-05' + | '2019-12-03' + | '2020-03-02' + | '2020-08-27' /** @description Whether this endpoint should receive events from connected accounts (`true`), or from your account (`false`). Defaults to `false`. */ - connect?: boolean; + connect?: boolean /** @description An optional description of what the webhook is used for. */ - description?: string; + description?: string /** @description The list of events to enable for this endpoint. You may specify `['*']` to enable all events, except those that require explicit selection. */ enabled_events: ( - | "*" - | "account.application.authorized" - | "account.application.deauthorized" - | "account.external_account.created" - | "account.external_account.deleted" - | "account.external_account.updated" - | "account.updated" - | "application_fee.created" - | "application_fee.refund.updated" - | "application_fee.refunded" - | "balance.available" - | "billing_portal.configuration.created" - | "billing_portal.configuration.updated" - | "capability.updated" - | "charge.captured" - | "charge.dispute.closed" - | "charge.dispute.created" - | "charge.dispute.funds_reinstated" - | "charge.dispute.funds_withdrawn" - | "charge.dispute.updated" - | "charge.expired" - | "charge.failed" - | "charge.pending" - | "charge.refund.updated" - | "charge.refunded" - | "charge.succeeded" - | "charge.updated" - | "checkout.session.async_payment_failed" - | "checkout.session.async_payment_succeeded" - | "checkout.session.completed" - | "checkout.session.expired" - | "coupon.created" - | "coupon.deleted" - | "coupon.updated" - | "credit_note.created" - | "credit_note.updated" - | "credit_note.voided" - | "customer.created" - | "customer.deleted" - | "customer.discount.created" - | "customer.discount.deleted" - | "customer.discount.updated" - | "customer.source.created" - | "customer.source.deleted" - | "customer.source.expiring" - | "customer.source.updated" - | "customer.subscription.created" - | "customer.subscription.deleted" - | "customer.subscription.pending_update_applied" - | "customer.subscription.pending_update_expired" - | "customer.subscription.trial_will_end" - | "customer.subscription.updated" - | "customer.tax_id.created" - | "customer.tax_id.deleted" - | "customer.tax_id.updated" - | "customer.updated" - | "file.created" - | "identity.verification_session.canceled" - | "identity.verification_session.created" - | "identity.verification_session.processing" - | "identity.verification_session.redacted" - | "identity.verification_session.requires_input" - | "identity.verification_session.verified" - | "invoice.created" - | "invoice.deleted" - | "invoice.finalization_failed" - | "invoice.finalized" - | "invoice.marked_uncollectible" - | "invoice.paid" - | "invoice.payment_action_required" - | "invoice.payment_failed" - | "invoice.payment_succeeded" - | "invoice.sent" - | "invoice.upcoming" - | "invoice.updated" - | "invoice.voided" - | "invoiceitem.created" - | "invoiceitem.deleted" - | "invoiceitem.updated" - | "issuing_authorization.created" - | "issuing_authorization.request" - | "issuing_authorization.updated" - | "issuing_card.created" - | "issuing_card.updated" - | "issuing_cardholder.created" - | "issuing_cardholder.updated" - | "issuing_dispute.closed" - | "issuing_dispute.created" - | "issuing_dispute.funds_reinstated" - | "issuing_dispute.submitted" - | "issuing_dispute.updated" - | "issuing_transaction.created" - | "issuing_transaction.updated" - | "mandate.updated" - | "order.created" - | "order.payment_failed" - | "order.payment_succeeded" - | "order.updated" - | "order_return.created" - | "payment_intent.amount_capturable_updated" - | "payment_intent.canceled" - | "payment_intent.created" - | "payment_intent.payment_failed" - | "payment_intent.processing" - | "payment_intent.requires_action" - | "payment_intent.succeeded" - | "payment_link.created" - | "payment_link.updated" - | "payment_method.attached" - | "payment_method.automatically_updated" - | "payment_method.detached" - | "payment_method.updated" - | "payout.canceled" - | "payout.created" - | "payout.failed" - | "payout.paid" - | "payout.updated" - | "person.created" - | "person.deleted" - | "person.updated" - | "plan.created" - | "plan.deleted" - | "plan.updated" - | "price.created" - | "price.deleted" - | "price.updated" - | "product.created" - | "product.deleted" - | "product.updated" - | "promotion_code.created" - | "promotion_code.updated" - | "quote.accepted" - | "quote.canceled" - | "quote.created" - | "quote.finalized" - | "radar.early_fraud_warning.created" - | "radar.early_fraud_warning.updated" - | "recipient.created" - | "recipient.deleted" - | "recipient.updated" - | "reporting.report_run.failed" - | "reporting.report_run.succeeded" - | "reporting.report_type.updated" - | "review.closed" - | "review.opened" - | "setup_intent.canceled" - | "setup_intent.created" - | "setup_intent.requires_action" - | "setup_intent.setup_failed" - | "setup_intent.succeeded" - | "sigma.scheduled_query_run.created" - | "sku.created" - | "sku.deleted" - | "sku.updated" - | "source.canceled" - | "source.chargeable" - | "source.failed" - | "source.mandate_notification" - | "source.refund_attributes_required" - | "source.transaction.created" - | "source.transaction.updated" - | "subscription_schedule.aborted" - | "subscription_schedule.canceled" - | "subscription_schedule.completed" - | "subscription_schedule.created" - | "subscription_schedule.expiring" - | "subscription_schedule.released" - | "subscription_schedule.updated" - | "tax_rate.created" - | "tax_rate.updated" - | "topup.canceled" - | "topup.created" - | "topup.failed" - | "topup.reversed" - | "topup.succeeded" - | "transfer.created" - | "transfer.failed" - | "transfer.paid" - | "transfer.reversed" - | "transfer.updated" - )[]; + | '*' + | 'account.application.authorized' + | 'account.application.deauthorized' + | 'account.external_account.created' + | 'account.external_account.deleted' + | 'account.external_account.updated' + | 'account.updated' + | 'application_fee.created' + | 'application_fee.refund.updated' + | 'application_fee.refunded' + | 'balance.available' + | 'billing_portal.configuration.created' + | 'billing_portal.configuration.updated' + | 'capability.updated' + | 'charge.captured' + | 'charge.dispute.closed' + | 'charge.dispute.created' + | 'charge.dispute.funds_reinstated' + | 'charge.dispute.funds_withdrawn' + | 'charge.dispute.updated' + | 'charge.expired' + | 'charge.failed' + | 'charge.pending' + | 'charge.refund.updated' + | 'charge.refunded' + | 'charge.succeeded' + | 'charge.updated' + | 'checkout.session.async_payment_failed' + | 'checkout.session.async_payment_succeeded' + | 'checkout.session.completed' + | 'checkout.session.expired' + | 'coupon.created' + | 'coupon.deleted' + | 'coupon.updated' + | 'credit_note.created' + | 'credit_note.updated' + | 'credit_note.voided' + | 'customer.created' + | 'customer.deleted' + | 'customer.discount.created' + | 'customer.discount.deleted' + | 'customer.discount.updated' + | 'customer.source.created' + | 'customer.source.deleted' + | 'customer.source.expiring' + | 'customer.source.updated' + | 'customer.subscription.created' + | 'customer.subscription.deleted' + | 'customer.subscription.pending_update_applied' + | 'customer.subscription.pending_update_expired' + | 'customer.subscription.trial_will_end' + | 'customer.subscription.updated' + | 'customer.tax_id.created' + | 'customer.tax_id.deleted' + | 'customer.tax_id.updated' + | 'customer.updated' + | 'file.created' + | 'identity.verification_session.canceled' + | 'identity.verification_session.created' + | 'identity.verification_session.processing' + | 'identity.verification_session.redacted' + | 'identity.verification_session.requires_input' + | 'identity.verification_session.verified' + | 'invoice.created' + | 'invoice.deleted' + | 'invoice.finalization_failed' + | 'invoice.finalized' + | 'invoice.marked_uncollectible' + | 'invoice.paid' + | 'invoice.payment_action_required' + | 'invoice.payment_failed' + | 'invoice.payment_succeeded' + | 'invoice.sent' + | 'invoice.upcoming' + | 'invoice.updated' + | 'invoice.voided' + | 'invoiceitem.created' + | 'invoiceitem.deleted' + | 'invoiceitem.updated' + | 'issuing_authorization.created' + | 'issuing_authorization.request' + | 'issuing_authorization.updated' + | 'issuing_card.created' + | 'issuing_card.updated' + | 'issuing_cardholder.created' + | 'issuing_cardholder.updated' + | 'issuing_dispute.closed' + | 'issuing_dispute.created' + | 'issuing_dispute.funds_reinstated' + | 'issuing_dispute.submitted' + | 'issuing_dispute.updated' + | 'issuing_transaction.created' + | 'issuing_transaction.updated' + | 'mandate.updated' + | 'order.created' + | 'order.payment_failed' + | 'order.payment_succeeded' + | 'order.updated' + | 'order_return.created' + | 'payment_intent.amount_capturable_updated' + | 'payment_intent.canceled' + | 'payment_intent.created' + | 'payment_intent.payment_failed' + | 'payment_intent.processing' + | 'payment_intent.requires_action' + | 'payment_intent.succeeded' + | 'payment_link.created' + | 'payment_link.updated' + | 'payment_method.attached' + | 'payment_method.automatically_updated' + | 'payment_method.detached' + | 'payment_method.updated' + | 'payout.canceled' + | 'payout.created' + | 'payout.failed' + | 'payout.paid' + | 'payout.updated' + | 'person.created' + | 'person.deleted' + | 'person.updated' + | 'plan.created' + | 'plan.deleted' + | 'plan.updated' + | 'price.created' + | 'price.deleted' + | 'price.updated' + | 'product.created' + | 'product.deleted' + | 'product.updated' + | 'promotion_code.created' + | 'promotion_code.updated' + | 'quote.accepted' + | 'quote.canceled' + | 'quote.created' + | 'quote.finalized' + | 'radar.early_fraud_warning.created' + | 'radar.early_fraud_warning.updated' + | 'recipient.created' + | 'recipient.deleted' + | 'recipient.updated' + | 'reporting.report_run.failed' + | 'reporting.report_run.succeeded' + | 'reporting.report_type.updated' + | 'review.closed' + | 'review.opened' + | 'setup_intent.canceled' + | 'setup_intent.created' + | 'setup_intent.requires_action' + | 'setup_intent.setup_failed' + | 'setup_intent.succeeded' + | 'sigma.scheduled_query_run.created' + | 'sku.created' + | 'sku.deleted' + | 'sku.updated' + | 'source.canceled' + | 'source.chargeable' + | 'source.failed' + | 'source.mandate_notification' + | 'source.refund_attributes_required' + | 'source.transaction.created' + | 'source.transaction.updated' + | 'subscription_schedule.aborted' + | 'subscription_schedule.canceled' + | 'subscription_schedule.completed' + | 'subscription_schedule.created' + | 'subscription_schedule.expiring' + | 'subscription_schedule.released' + | 'subscription_schedule.updated' + | 'tax_rate.created' + | 'tax_rate.updated' + | 'topup.canceled' + | 'topup.created' + | 'topup.failed' + | 'topup.reversed' + | 'topup.succeeded' + | 'transfer.created' + | 'transfer.failed' + | 'transfer.paid' + | 'transfer.reversed' + | 'transfer.updated' + )[] /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The URL of the webhook endpoint. */ - url: string; - }; - }; - }; - }; + url: string + } + } + } + } /**

Retrieves the webhook endpoint with the given ID.

*/ GetWebhookEndpointsWebhookEndpoint: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - webhook_endpoint: string; - }; - }; + webhook_endpoint: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["webhook_endpoint"]; - }; - }; + 'application/json': components['schemas']['webhook_endpoint'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.

*/ PostWebhookEndpointsWebhookEndpoint: { parameters: { path: { - webhook_endpoint: string; - }; - }; + webhook_endpoint: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["webhook_endpoint"]; - }; - }; + 'application/json': components['schemas']['webhook_endpoint'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description An optional description of what the webhook is used for. */ - description?: string; + description?: string /** @description Disable the webhook endpoint if set to true. */ - disabled?: boolean; + disabled?: boolean /** @description The list of events to enable for this endpoint. You may specify `['*']` to enable all events, except those that require explicit selection. */ enabled_events?: ( - | "*" - | "account.application.authorized" - | "account.application.deauthorized" - | "account.external_account.created" - | "account.external_account.deleted" - | "account.external_account.updated" - | "account.updated" - | "application_fee.created" - | "application_fee.refund.updated" - | "application_fee.refunded" - | "balance.available" - | "billing_portal.configuration.created" - | "billing_portal.configuration.updated" - | "capability.updated" - | "charge.captured" - | "charge.dispute.closed" - | "charge.dispute.created" - | "charge.dispute.funds_reinstated" - | "charge.dispute.funds_withdrawn" - | "charge.dispute.updated" - | "charge.expired" - | "charge.failed" - | "charge.pending" - | "charge.refund.updated" - | "charge.refunded" - | "charge.succeeded" - | "charge.updated" - | "checkout.session.async_payment_failed" - | "checkout.session.async_payment_succeeded" - | "checkout.session.completed" - | "checkout.session.expired" - | "coupon.created" - | "coupon.deleted" - | "coupon.updated" - | "credit_note.created" - | "credit_note.updated" - | "credit_note.voided" - | "customer.created" - | "customer.deleted" - | "customer.discount.created" - | "customer.discount.deleted" - | "customer.discount.updated" - | "customer.source.created" - | "customer.source.deleted" - | "customer.source.expiring" - | "customer.source.updated" - | "customer.subscription.created" - | "customer.subscription.deleted" - | "customer.subscription.pending_update_applied" - | "customer.subscription.pending_update_expired" - | "customer.subscription.trial_will_end" - | "customer.subscription.updated" - | "customer.tax_id.created" - | "customer.tax_id.deleted" - | "customer.tax_id.updated" - | "customer.updated" - | "file.created" - | "identity.verification_session.canceled" - | "identity.verification_session.created" - | "identity.verification_session.processing" - | "identity.verification_session.redacted" - | "identity.verification_session.requires_input" - | "identity.verification_session.verified" - | "invoice.created" - | "invoice.deleted" - | "invoice.finalization_failed" - | "invoice.finalized" - | "invoice.marked_uncollectible" - | "invoice.paid" - | "invoice.payment_action_required" - | "invoice.payment_failed" - | "invoice.payment_succeeded" - | "invoice.sent" - | "invoice.upcoming" - | "invoice.updated" - | "invoice.voided" - | "invoiceitem.created" - | "invoiceitem.deleted" - | "invoiceitem.updated" - | "issuing_authorization.created" - | "issuing_authorization.request" - | "issuing_authorization.updated" - | "issuing_card.created" - | "issuing_card.updated" - | "issuing_cardholder.created" - | "issuing_cardholder.updated" - | "issuing_dispute.closed" - | "issuing_dispute.created" - | "issuing_dispute.funds_reinstated" - | "issuing_dispute.submitted" - | "issuing_dispute.updated" - | "issuing_transaction.created" - | "issuing_transaction.updated" - | "mandate.updated" - | "order.created" - | "order.payment_failed" - | "order.payment_succeeded" - | "order.updated" - | "order_return.created" - | "payment_intent.amount_capturable_updated" - | "payment_intent.canceled" - | "payment_intent.created" - | "payment_intent.payment_failed" - | "payment_intent.processing" - | "payment_intent.requires_action" - | "payment_intent.succeeded" - | "payment_link.created" - | "payment_link.updated" - | "payment_method.attached" - | "payment_method.automatically_updated" - | "payment_method.detached" - | "payment_method.updated" - | "payout.canceled" - | "payout.created" - | "payout.failed" - | "payout.paid" - | "payout.updated" - | "person.created" - | "person.deleted" - | "person.updated" - | "plan.created" - | "plan.deleted" - | "plan.updated" - | "price.created" - | "price.deleted" - | "price.updated" - | "product.created" - | "product.deleted" - | "product.updated" - | "promotion_code.created" - | "promotion_code.updated" - | "quote.accepted" - | "quote.canceled" - | "quote.created" - | "quote.finalized" - | "radar.early_fraud_warning.created" - | "radar.early_fraud_warning.updated" - | "recipient.created" - | "recipient.deleted" - | "recipient.updated" - | "reporting.report_run.failed" - | "reporting.report_run.succeeded" - | "reporting.report_type.updated" - | "review.closed" - | "review.opened" - | "setup_intent.canceled" - | "setup_intent.created" - | "setup_intent.requires_action" - | "setup_intent.setup_failed" - | "setup_intent.succeeded" - | "sigma.scheduled_query_run.created" - | "sku.created" - | "sku.deleted" - | "sku.updated" - | "source.canceled" - | "source.chargeable" - | "source.failed" - | "source.mandate_notification" - | "source.refund_attributes_required" - | "source.transaction.created" - | "source.transaction.updated" - | "subscription_schedule.aborted" - | "subscription_schedule.canceled" - | "subscription_schedule.completed" - | "subscription_schedule.created" - | "subscription_schedule.expiring" - | "subscription_schedule.released" - | "subscription_schedule.updated" - | "tax_rate.created" - | "tax_rate.updated" - | "topup.canceled" - | "topup.created" - | "topup.failed" - | "topup.reversed" - | "topup.succeeded" - | "transfer.created" - | "transfer.failed" - | "transfer.paid" - | "transfer.reversed" - | "transfer.updated" - )[]; + | '*' + | 'account.application.authorized' + | 'account.application.deauthorized' + | 'account.external_account.created' + | 'account.external_account.deleted' + | 'account.external_account.updated' + | 'account.updated' + | 'application_fee.created' + | 'application_fee.refund.updated' + | 'application_fee.refunded' + | 'balance.available' + | 'billing_portal.configuration.created' + | 'billing_portal.configuration.updated' + | 'capability.updated' + | 'charge.captured' + | 'charge.dispute.closed' + | 'charge.dispute.created' + | 'charge.dispute.funds_reinstated' + | 'charge.dispute.funds_withdrawn' + | 'charge.dispute.updated' + | 'charge.expired' + | 'charge.failed' + | 'charge.pending' + | 'charge.refund.updated' + | 'charge.refunded' + | 'charge.succeeded' + | 'charge.updated' + | 'checkout.session.async_payment_failed' + | 'checkout.session.async_payment_succeeded' + | 'checkout.session.completed' + | 'checkout.session.expired' + | 'coupon.created' + | 'coupon.deleted' + | 'coupon.updated' + | 'credit_note.created' + | 'credit_note.updated' + | 'credit_note.voided' + | 'customer.created' + | 'customer.deleted' + | 'customer.discount.created' + | 'customer.discount.deleted' + | 'customer.discount.updated' + | 'customer.source.created' + | 'customer.source.deleted' + | 'customer.source.expiring' + | 'customer.source.updated' + | 'customer.subscription.created' + | 'customer.subscription.deleted' + | 'customer.subscription.pending_update_applied' + | 'customer.subscription.pending_update_expired' + | 'customer.subscription.trial_will_end' + | 'customer.subscription.updated' + | 'customer.tax_id.created' + | 'customer.tax_id.deleted' + | 'customer.tax_id.updated' + | 'customer.updated' + | 'file.created' + | 'identity.verification_session.canceled' + | 'identity.verification_session.created' + | 'identity.verification_session.processing' + | 'identity.verification_session.redacted' + | 'identity.verification_session.requires_input' + | 'identity.verification_session.verified' + | 'invoice.created' + | 'invoice.deleted' + | 'invoice.finalization_failed' + | 'invoice.finalized' + | 'invoice.marked_uncollectible' + | 'invoice.paid' + | 'invoice.payment_action_required' + | 'invoice.payment_failed' + | 'invoice.payment_succeeded' + | 'invoice.sent' + | 'invoice.upcoming' + | 'invoice.updated' + | 'invoice.voided' + | 'invoiceitem.created' + | 'invoiceitem.deleted' + | 'invoiceitem.updated' + | 'issuing_authorization.created' + | 'issuing_authorization.request' + | 'issuing_authorization.updated' + | 'issuing_card.created' + | 'issuing_card.updated' + | 'issuing_cardholder.created' + | 'issuing_cardholder.updated' + | 'issuing_dispute.closed' + | 'issuing_dispute.created' + | 'issuing_dispute.funds_reinstated' + | 'issuing_dispute.submitted' + | 'issuing_dispute.updated' + | 'issuing_transaction.created' + | 'issuing_transaction.updated' + | 'mandate.updated' + | 'order.created' + | 'order.payment_failed' + | 'order.payment_succeeded' + | 'order.updated' + | 'order_return.created' + | 'payment_intent.amount_capturable_updated' + | 'payment_intent.canceled' + | 'payment_intent.created' + | 'payment_intent.payment_failed' + | 'payment_intent.processing' + | 'payment_intent.requires_action' + | 'payment_intent.succeeded' + | 'payment_link.created' + | 'payment_link.updated' + | 'payment_method.attached' + | 'payment_method.automatically_updated' + | 'payment_method.detached' + | 'payment_method.updated' + | 'payout.canceled' + | 'payout.created' + | 'payout.failed' + | 'payout.paid' + | 'payout.updated' + | 'person.created' + | 'person.deleted' + | 'person.updated' + | 'plan.created' + | 'plan.deleted' + | 'plan.updated' + | 'price.created' + | 'price.deleted' + | 'price.updated' + | 'product.created' + | 'product.deleted' + | 'product.updated' + | 'promotion_code.created' + | 'promotion_code.updated' + | 'quote.accepted' + | 'quote.canceled' + | 'quote.created' + | 'quote.finalized' + | 'radar.early_fraud_warning.created' + | 'radar.early_fraud_warning.updated' + | 'recipient.created' + | 'recipient.deleted' + | 'recipient.updated' + | 'reporting.report_run.failed' + | 'reporting.report_run.succeeded' + | 'reporting.report_type.updated' + | 'review.closed' + | 'review.opened' + | 'setup_intent.canceled' + | 'setup_intent.created' + | 'setup_intent.requires_action' + | 'setup_intent.setup_failed' + | 'setup_intent.succeeded' + | 'sigma.scheduled_query_run.created' + | 'sku.created' + | 'sku.deleted' + | 'sku.updated' + | 'source.canceled' + | 'source.chargeable' + | 'source.failed' + | 'source.mandate_notification' + | 'source.refund_attributes_required' + | 'source.transaction.created' + | 'source.transaction.updated' + | 'subscription_schedule.aborted' + | 'subscription_schedule.canceled' + | 'subscription_schedule.completed' + | 'subscription_schedule.created' + | 'subscription_schedule.expiring' + | 'subscription_schedule.released' + | 'subscription_schedule.updated' + | 'tax_rate.created' + | 'tax_rate.updated' + | 'topup.canceled' + | 'topup.created' + | 'topup.failed' + | 'topup.reversed' + | 'topup.succeeded' + | 'transfer.created' + | 'transfer.failed' + | 'transfer.paid' + | 'transfer.reversed' + | 'transfer.updated' + )[] /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The URL of the webhook endpoint. */ - url?: string; - }; - }; - }; - }; + url?: string + } + } + } + } /**

You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.

*/ DeleteWebhookEndpointsWebhookEndpoint: { parameters: { path: { - webhook_endpoint: string; - }; - }; + webhook_endpoint: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_webhook_endpoint"]; - }; - }; + 'application/json': components['schemas']['deleted_webhook_endpoint'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; -}; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } +} -export type external = {}; +export type external = {} diff --git a/test/v3/expected/stripe.immutable.ts b/test/v3/expected/stripe.immutable.ts index d1d43f332..c5f12ce73 100644 --- a/test/v3/expected/stripe.immutable.ts +++ b/test/v3/expected/stripe.immutable.ts @@ -4,23 +4,23 @@ */ export interface paths { - readonly "/v1/3d_secure": { + readonly '/v1/3d_secure': { /**

Initiate 3D Secure authentication.

*/ - readonly post: operations["Post3dSecure"]; - }; - readonly "/v1/3d_secure/{three_d_secure}": { + readonly post: operations['Post3dSecure'] + } + readonly '/v1/3d_secure/{three_d_secure}': { /**

Retrieves a 3D Secure object.

*/ - readonly get: operations["Get3dSecureThreeDSecure"]; - }; - readonly "/v1/account": { + readonly get: operations['Get3dSecureThreeDSecure'] + } + readonly '/v1/account': { /**

Retrieves the details of an account.

*/ - readonly get: operations["GetAccount"]; + readonly get: operations['GetAccount'] /** *

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged. Most parameters can be changed only for Custom accounts. (These are marked Custom Only below.) Parameters marked Custom and Express are not supported for Standard accounts.

* *

To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.

*/ - readonly post: operations["PostAccount"]; + readonly post: operations['PostAccount'] /** *

With Connect, you can delete accounts you manage.

* @@ -28,110 +28,110 @@ export interface paths { * *

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

*/ - readonly delete: operations["DeleteAccount"]; - }; - readonly "/v1/account/bank_accounts": { + readonly delete: operations['DeleteAccount'] + } + readonly '/v1/account/bank_accounts': { /**

Create an external account for a given account.

*/ - readonly post: operations["PostAccountBankAccounts"]; - }; - readonly "/v1/account/bank_accounts/{id}": { + readonly post: operations['PostAccountBankAccounts'] + } + readonly '/v1/account/bank_accounts/{id}': { /**

Retrieve a specified external account for a given account.

*/ - readonly get: operations["GetAccountBankAccountsId"]; + readonly get: operations['GetAccountBankAccountsId'] /** *

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

* *

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

*/ - readonly post: operations["PostAccountBankAccountsId"]; + readonly post: operations['PostAccountBankAccountsId'] /**

Delete a specified external account for a given account.

*/ - readonly delete: operations["DeleteAccountBankAccountsId"]; - }; - readonly "/v1/account/capabilities": { + readonly delete: operations['DeleteAccountBankAccountsId'] + } + readonly '/v1/account/capabilities': { /**

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

*/ - readonly get: operations["GetAccountCapabilities"]; - }; - readonly "/v1/account/capabilities/{capability}": { + readonly get: operations['GetAccountCapabilities'] + } + readonly '/v1/account/capabilities/{capability}': { /**

Retrieves information about the specified Account Capability.

*/ - readonly get: operations["GetAccountCapabilitiesCapability"]; + readonly get: operations['GetAccountCapabilitiesCapability'] /**

Updates an existing Account Capability.

*/ - readonly post: operations["PostAccountCapabilitiesCapability"]; - }; - readonly "/v1/account/external_accounts": { + readonly post: operations['PostAccountCapabilitiesCapability'] + } + readonly '/v1/account/external_accounts': { /**

List external accounts for an account.

*/ - readonly get: operations["GetAccountExternalAccounts"]; + readonly get: operations['GetAccountExternalAccounts'] /**

Create an external account for a given account.

*/ - readonly post: operations["PostAccountExternalAccounts"]; - }; - readonly "/v1/account/external_accounts/{id}": { + readonly post: operations['PostAccountExternalAccounts'] + } + readonly '/v1/account/external_accounts/{id}': { /**

Retrieve a specified external account for a given account.

*/ - readonly get: operations["GetAccountExternalAccountsId"]; + readonly get: operations['GetAccountExternalAccountsId'] /** *

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

* *

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

*/ - readonly post: operations["PostAccountExternalAccountsId"]; + readonly post: operations['PostAccountExternalAccountsId'] /**

Delete a specified external account for a given account.

*/ - readonly delete: operations["DeleteAccountExternalAccountsId"]; - }; - readonly "/v1/account/login_links": { + readonly delete: operations['DeleteAccountExternalAccountsId'] + } + readonly '/v1/account/login_links': { /** *

Creates a single-use login link for an Express account to access their Stripe dashboard.

* *

You may only create login links for Express accounts connected to your platform.

*/ - readonly post: operations["PostAccountLoginLinks"]; - }; - readonly "/v1/account/people": { + readonly post: operations['PostAccountLoginLinks'] + } + readonly '/v1/account/people': { /**

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.

*/ - readonly get: operations["GetAccountPeople"]; + readonly get: operations['GetAccountPeople'] /**

Creates a new person.

*/ - readonly post: operations["PostAccountPeople"]; - }; - readonly "/v1/account/people/{person}": { + readonly post: operations['PostAccountPeople'] + } + readonly '/v1/account/people/{person}': { /**

Retrieves an existing person.

*/ - readonly get: operations["GetAccountPeoplePerson"]; + readonly get: operations['GetAccountPeoplePerson'] /**

Updates an existing person.

*/ - readonly post: operations["PostAccountPeoplePerson"]; + readonly post: operations['PostAccountPeoplePerson'] /**

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.

*/ - readonly delete: operations["DeleteAccountPeoplePerson"]; - }; - readonly "/v1/account/persons": { + readonly delete: operations['DeleteAccountPeoplePerson'] + } + readonly '/v1/account/persons': { /**

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.

*/ - readonly get: operations["GetAccountPersons"]; + readonly get: operations['GetAccountPersons'] /**

Creates a new person.

*/ - readonly post: operations["PostAccountPersons"]; - }; - readonly "/v1/account/persons/{person}": { + readonly post: operations['PostAccountPersons'] + } + readonly '/v1/account/persons/{person}': { /**

Retrieves an existing person.

*/ - readonly get: operations["GetAccountPersonsPerson"]; + readonly get: operations['GetAccountPersonsPerson'] /**

Updates an existing person.

*/ - readonly post: operations["PostAccountPersonsPerson"]; + readonly post: operations['PostAccountPersonsPerson'] /**

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.

*/ - readonly delete: operations["DeleteAccountPersonsPerson"]; - }; - readonly "/v1/account_links": { + readonly delete: operations['DeleteAccountPersonsPerson'] + } + readonly '/v1/account_links': { /**

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.

*/ - readonly post: operations["PostAccountLinks"]; - }; - readonly "/v1/accounts": { + readonly post: operations['PostAccountLinks'] + } + readonly '/v1/accounts': { /**

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

*/ - readonly get: operations["GetAccounts"]; + readonly get: operations['GetAccounts'] /** *

With Connect, you can create Stripe accounts for your users. * To do this, you’ll first need to register your platform.

*/ - readonly post: operations["PostAccounts"]; - }; - readonly "/v1/accounts/{account}": { + readonly post: operations['PostAccounts'] + } + readonly '/v1/accounts/{account}': { /**

Retrieves the details of an account.

*/ - readonly get: operations["GetAccountsAccount"]; + readonly get: operations['GetAccountsAccount'] /** *

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged. Most parameters can be changed only for Custom accounts. (These are marked Custom Only below.) Parameters marked Custom and Express are not supported for Standard accounts.

* *

To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.

*/ - readonly post: operations["PostAccountsAccount"]; + readonly post: operations['PostAccountsAccount'] /** *

With Connect, you can delete accounts you manage.

* @@ -139,132 +139,132 @@ export interface paths { * *

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

*/ - readonly delete: operations["DeleteAccountsAccount"]; - }; - readonly "/v1/accounts/{account}/bank_accounts": { + readonly delete: operations['DeleteAccountsAccount'] + } + readonly '/v1/accounts/{account}/bank_accounts': { /**

Create an external account for a given account.

*/ - readonly post: operations["PostAccountsAccountBankAccounts"]; - }; - readonly "/v1/accounts/{account}/bank_accounts/{id}": { + readonly post: operations['PostAccountsAccountBankAccounts'] + } + readonly '/v1/accounts/{account}/bank_accounts/{id}': { /**

Retrieve a specified external account for a given account.

*/ - readonly get: operations["GetAccountsAccountBankAccountsId"]; + readonly get: operations['GetAccountsAccountBankAccountsId'] /** *

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

* *

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

*/ - readonly post: operations["PostAccountsAccountBankAccountsId"]; + readonly post: operations['PostAccountsAccountBankAccountsId'] /**

Delete a specified external account for a given account.

*/ - readonly delete: operations["DeleteAccountsAccountBankAccountsId"]; - }; - readonly "/v1/accounts/{account}/capabilities": { + readonly delete: operations['DeleteAccountsAccountBankAccountsId'] + } + readonly '/v1/accounts/{account}/capabilities': { /**

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

*/ - readonly get: operations["GetAccountsAccountCapabilities"]; - }; - readonly "/v1/accounts/{account}/capabilities/{capability}": { + readonly get: operations['GetAccountsAccountCapabilities'] + } + readonly '/v1/accounts/{account}/capabilities/{capability}': { /**

Retrieves information about the specified Account Capability.

*/ - readonly get: operations["GetAccountsAccountCapabilitiesCapability"]; + readonly get: operations['GetAccountsAccountCapabilitiesCapability'] /**

Updates an existing Account Capability.

*/ - readonly post: operations["PostAccountsAccountCapabilitiesCapability"]; - }; - readonly "/v1/accounts/{account}/external_accounts": { + readonly post: operations['PostAccountsAccountCapabilitiesCapability'] + } + readonly '/v1/accounts/{account}/external_accounts': { /**

List external accounts for an account.

*/ - readonly get: operations["GetAccountsAccountExternalAccounts"]; + readonly get: operations['GetAccountsAccountExternalAccounts'] /**

Create an external account for a given account.

*/ - readonly post: operations["PostAccountsAccountExternalAccounts"]; - }; - readonly "/v1/accounts/{account}/external_accounts/{id}": { + readonly post: operations['PostAccountsAccountExternalAccounts'] + } + readonly '/v1/accounts/{account}/external_accounts/{id}': { /**

Retrieve a specified external account for a given account.

*/ - readonly get: operations["GetAccountsAccountExternalAccountsId"]; + readonly get: operations['GetAccountsAccountExternalAccountsId'] /** *

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

* *

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

*/ - readonly post: operations["PostAccountsAccountExternalAccountsId"]; + readonly post: operations['PostAccountsAccountExternalAccountsId'] /**

Delete a specified external account for a given account.

*/ - readonly delete: operations["DeleteAccountsAccountExternalAccountsId"]; - }; - readonly "/v1/accounts/{account}/login_links": { + readonly delete: operations['DeleteAccountsAccountExternalAccountsId'] + } + readonly '/v1/accounts/{account}/login_links': { /** *

Creates a single-use login link for an Express account to access their Stripe dashboard.

* *

You may only create login links for Express accounts connected to your platform.

*/ - readonly post: operations["PostAccountsAccountLoginLinks"]; - }; - readonly "/v1/accounts/{account}/people": { + readonly post: operations['PostAccountsAccountLoginLinks'] + } + readonly '/v1/accounts/{account}/people': { /**

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.

*/ - readonly get: operations["GetAccountsAccountPeople"]; + readonly get: operations['GetAccountsAccountPeople'] /**

Creates a new person.

*/ - readonly post: operations["PostAccountsAccountPeople"]; - }; - readonly "/v1/accounts/{account}/people/{person}": { + readonly post: operations['PostAccountsAccountPeople'] + } + readonly '/v1/accounts/{account}/people/{person}': { /**

Retrieves an existing person.

*/ - readonly get: operations["GetAccountsAccountPeoplePerson"]; + readonly get: operations['GetAccountsAccountPeoplePerson'] /**

Updates an existing person.

*/ - readonly post: operations["PostAccountsAccountPeoplePerson"]; + readonly post: operations['PostAccountsAccountPeoplePerson'] /**

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.

*/ - readonly delete: operations["DeleteAccountsAccountPeoplePerson"]; - }; - readonly "/v1/accounts/{account}/persons": { + readonly delete: operations['DeleteAccountsAccountPeoplePerson'] + } + readonly '/v1/accounts/{account}/persons': { /**

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.

*/ - readonly get: operations["GetAccountsAccountPersons"]; + readonly get: operations['GetAccountsAccountPersons'] /**

Creates a new person.

*/ - readonly post: operations["PostAccountsAccountPersons"]; - }; - readonly "/v1/accounts/{account}/persons/{person}": { + readonly post: operations['PostAccountsAccountPersons'] + } + readonly '/v1/accounts/{account}/persons/{person}': { /**

Retrieves an existing person.

*/ - readonly get: operations["GetAccountsAccountPersonsPerson"]; + readonly get: operations['GetAccountsAccountPersonsPerson'] /**

Updates an existing person.

*/ - readonly post: operations["PostAccountsAccountPersonsPerson"]; + readonly post: operations['PostAccountsAccountPersonsPerson'] /**

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.

*/ - readonly delete: operations["DeleteAccountsAccountPersonsPerson"]; - }; - readonly "/v1/accounts/{account}/reject": { + readonly delete: operations['DeleteAccountsAccountPersonsPerson'] + } + readonly '/v1/accounts/{account}/reject': { /** *

With Connect, you may flag accounts as suspicious.

* *

Test-mode Custom and Express accounts can be rejected at any time. Accounts created using live-mode keys may only be rejected once all balances are zero.

*/ - readonly post: operations["PostAccountsAccountReject"]; - }; - readonly "/v1/apple_pay/domains": { + readonly post: operations['PostAccountsAccountReject'] + } + readonly '/v1/apple_pay/domains': { /**

List apple pay domains.

*/ - readonly get: operations["GetApplePayDomains"]; + readonly get: operations['GetApplePayDomains'] /**

Create an apple pay domain.

*/ - readonly post: operations["PostApplePayDomains"]; - }; - readonly "/v1/apple_pay/domains/{domain}": { + readonly post: operations['PostApplePayDomains'] + } + readonly '/v1/apple_pay/domains/{domain}': { /**

Retrieve an apple pay domain.

*/ - readonly get: operations["GetApplePayDomainsDomain"]; + readonly get: operations['GetApplePayDomainsDomain'] /**

Delete an apple pay domain.

*/ - readonly delete: operations["DeleteApplePayDomainsDomain"]; - }; - readonly "/v1/application_fees": { + readonly delete: operations['DeleteApplePayDomainsDomain'] + } + readonly '/v1/application_fees': { /**

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.

*/ - readonly get: operations["GetApplicationFees"]; - }; - readonly "/v1/application_fees/{fee}/refunds/{id}": { + readonly get: operations['GetApplicationFees'] + } + readonly '/v1/application_fees/{fee}/refunds/{id}': { /**

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.

*/ - readonly get: operations["GetApplicationFeesFeeRefundsId"]; + readonly get: operations['GetApplicationFeesFeeRefundsId'] /** *

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

* *

This request only accepts metadata as an argument.

*/ - readonly post: operations["PostApplicationFeesFeeRefundsId"]; - }; - readonly "/v1/application_fees/{id}": { + readonly post: operations['PostApplicationFeesFeeRefundsId'] + } + readonly '/v1/application_fees/{id}': { /**

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

*/ - readonly get: operations["GetApplicationFeesId"]; - }; - readonly "/v1/application_fees/{id}/refund": { - readonly post: operations["PostApplicationFeesIdRefund"]; - }; - readonly "/v1/application_fees/{id}/refunds": { + readonly get: operations['GetApplicationFeesId'] + } + readonly '/v1/application_fees/{id}/refund': { + readonly post: operations['PostApplicationFeesIdRefund'] + } + readonly '/v1/application_fees/{id}/refunds': { /**

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.

*/ - readonly get: operations["GetApplicationFeesIdRefunds"]; + readonly get: operations['GetApplicationFeesIdRefunds'] /** *

Refunds an application fee that has previously been collected but not yet refunded. * Funds will be refunded to the Stripe account from which the fee was originally collected.

@@ -276,108 +276,108 @@ export interface paths { * This method will raise an error when called on an already-refunded application fee, * or when trying to refund more money than is left on an application fee.

*/ - readonly post: operations["PostApplicationFeesIdRefunds"]; - }; - readonly "/v1/balance": { + readonly post: operations['PostApplicationFeesIdRefunds'] + } + readonly '/v1/balance': { /** *

Retrieves the current account balance, based on the authentication that was used to make the request. * For a sample request, see Accounting for negative balances.

*/ - readonly get: operations["GetBalance"]; - }; - readonly "/v1/balance/history": { + readonly get: operations['GetBalance'] + } + readonly '/v1/balance/history': { /** *

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

* *

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

*/ - readonly get: operations["GetBalanceHistory"]; - }; - readonly "/v1/balance/history/{id}": { + readonly get: operations['GetBalanceHistory'] + } + readonly '/v1/balance/history/{id}': { /** *

Retrieves the balance transaction with the given ID.

* *

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

*/ - readonly get: operations["GetBalanceHistoryId"]; - }; - readonly "/v1/balance_transactions": { + readonly get: operations['GetBalanceHistoryId'] + } + readonly '/v1/balance_transactions': { /** *

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

* *

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

*/ - readonly get: operations["GetBalanceTransactions"]; - }; - readonly "/v1/balance_transactions/{id}": { + readonly get: operations['GetBalanceTransactions'] + } + readonly '/v1/balance_transactions/{id}': { /** *

Retrieves the balance transaction with the given ID.

* *

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

*/ - readonly get: operations["GetBalanceTransactionsId"]; - }; - readonly "/v1/billing_portal/configurations": { + readonly get: operations['GetBalanceTransactionsId'] + } + readonly '/v1/billing_portal/configurations': { /**

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

*/ - readonly get: operations["GetBillingPortalConfigurations"]; + readonly get: operations['GetBillingPortalConfigurations'] /**

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

*/ - readonly post: operations["PostBillingPortalConfigurations"]; - }; - readonly "/v1/billing_portal/configurations/{configuration}": { + readonly post: operations['PostBillingPortalConfigurations'] + } + readonly '/v1/billing_portal/configurations/{configuration}': { /**

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

*/ - readonly get: operations["GetBillingPortalConfigurationsConfiguration"]; + readonly get: operations['GetBillingPortalConfigurationsConfiguration'] /**

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

*/ - readonly post: operations["PostBillingPortalConfigurationsConfiguration"]; - }; - readonly "/v1/billing_portal/sessions": { + readonly post: operations['PostBillingPortalConfigurationsConfiguration'] + } + readonly '/v1/billing_portal/sessions': { /**

Creates a session of the customer portal.

*/ - readonly post: operations["PostBillingPortalSessions"]; - }; - readonly "/v1/bitcoin/receivers": { + readonly post: operations['PostBillingPortalSessions'] + } + readonly '/v1/bitcoin/receivers': { /**

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

*/ - readonly get: operations["GetBitcoinReceivers"]; - }; - readonly "/v1/bitcoin/receivers/{id}": { + readonly get: operations['GetBitcoinReceivers'] + } + readonly '/v1/bitcoin/receivers/{id}': { /**

Retrieves the Bitcoin receiver with the given ID.

*/ - readonly get: operations["GetBitcoinReceiversId"]; - }; - readonly "/v1/bitcoin/receivers/{receiver}/transactions": { + readonly get: operations['GetBitcoinReceiversId'] + } + readonly '/v1/bitcoin/receivers/{receiver}/transactions': { /**

List bitcoin transacitons for a given receiver.

*/ - readonly get: operations["GetBitcoinReceiversReceiverTransactions"]; - }; - readonly "/v1/bitcoin/transactions": { + readonly get: operations['GetBitcoinReceiversReceiverTransactions'] + } + readonly '/v1/bitcoin/transactions': { /**

List bitcoin transacitons for a given receiver.

*/ - readonly get: operations["GetBitcoinTransactions"]; - }; - readonly "/v1/charges": { + readonly get: operations['GetBitcoinTransactions'] + } + readonly '/v1/charges': { /**

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

*/ - readonly get: operations["GetCharges"]; + readonly get: operations['GetCharges'] /**

To charge a credit card or other payment source, you create a Charge object. If your API key is in test mode, the supplied payment source (e.g., card) won’t actually be charged, although everything else will occur as if in live mode. (Stripe assumes that the charge would have completed successfully).

*/ - readonly post: operations["PostCharges"]; - }; - readonly "/v1/charges/{charge}": { + readonly post: operations['PostCharges'] + } + readonly '/v1/charges/{charge}': { /**

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.

*/ - readonly get: operations["GetChargesCharge"]; + readonly get: operations['GetChargesCharge'] /**

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

*/ - readonly post: operations["PostChargesCharge"]; - }; - readonly "/v1/charges/{charge}/capture": { + readonly post: operations['PostChargesCharge'] + } + readonly '/v1/charges/{charge}/capture': { /** *

Capture the payment of an existing, uncaptured, charge. This is the second half of the two-step payment flow, where first you created a charge with the capture option set to false.

* *

Uncaptured payments expire a set number of days after they are created (7 by default). If they are not captured by that point in time, they will be marked as refunded and will no longer be capturable.

*/ - readonly post: operations["PostChargesChargeCapture"]; - }; - readonly "/v1/charges/{charge}/dispute": { + readonly post: operations['PostChargesChargeCapture'] + } + readonly '/v1/charges/{charge}/dispute': { /**

Retrieve a dispute for a specified charge.

*/ - readonly get: operations["GetChargesChargeDispute"]; - readonly post: operations["PostChargesChargeDispute"]; - }; - readonly "/v1/charges/{charge}/dispute/close": { - readonly post: operations["PostChargesChargeDisputeClose"]; - }; - readonly "/v1/charges/{charge}/refund": { + readonly get: operations['GetChargesChargeDispute'] + readonly post: operations['PostChargesChargeDispute'] + } + readonly '/v1/charges/{charge}/dispute/close': { + readonly post: operations['PostChargesChargeDisputeClose'] + } + readonly '/v1/charges/{charge}/refund': { /** *

When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.

* @@ -391,71 +391,71 @@ export interface paths { * 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.

*/ - readonly post: operations["PostChargesChargeRefund"]; - }; - readonly "/v1/charges/{charge}/refunds": { + readonly post: operations['PostChargesChargeRefund'] + } + readonly '/v1/charges/{charge}/refunds': { /**

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.

*/ - readonly get: operations["GetChargesChargeRefunds"]; + readonly get: operations['GetChargesChargeRefunds'] /**

Create a refund.

*/ - readonly post: operations["PostChargesChargeRefunds"]; - }; - readonly "/v1/charges/{charge}/refunds/{refund}": { + readonly post: operations['PostChargesChargeRefunds'] + } + readonly '/v1/charges/{charge}/refunds/{refund}': { /**

Retrieves the details of an existing refund.

*/ - readonly get: operations["GetChargesChargeRefundsRefund"]; + readonly get: operations['GetChargesChargeRefundsRefund'] /**

Update a specified refund.

*/ - readonly post: operations["PostChargesChargeRefundsRefund"]; - }; - readonly "/v1/checkout/sessions": { + readonly post: operations['PostChargesChargeRefundsRefund'] + } + readonly '/v1/checkout/sessions': { /**

Returns a list of Checkout Sessions.

*/ - readonly get: operations["GetCheckoutSessions"]; + readonly get: operations['GetCheckoutSessions'] /**

Creates a Session object.

*/ - readonly post: operations["PostCheckoutSessions"]; - }; - readonly "/v1/checkout/sessions/{session}": { + readonly post: operations['PostCheckoutSessions'] + } + readonly '/v1/checkout/sessions/{session}': { /**

Retrieves a Session object.

*/ - readonly get: operations["GetCheckoutSessionsSession"]; - }; - readonly "/v1/checkout/sessions/{session}/expire": { + readonly get: operations['GetCheckoutSessionsSession'] + } + readonly '/v1/checkout/sessions/{session}/expire': { /** *

A Session can be expired when it is in one of these statuses: open

* *

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

*/ - readonly post: operations["PostCheckoutSessionsSessionExpire"]; - }; - readonly "/v1/checkout/sessions/{session}/line_items": { + readonly post: operations['PostCheckoutSessionsSessionExpire'] + } + readonly '/v1/checkout/sessions/{session}/line_items': { /**

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.

*/ - readonly get: operations["GetCheckoutSessionsSessionLineItems"]; - }; - readonly "/v1/country_specs": { + readonly get: operations['GetCheckoutSessionsSessionLineItems'] + } + readonly '/v1/country_specs': { /**

Lists all Country Spec objects available in the API.

*/ - readonly get: operations["GetCountrySpecs"]; - }; - readonly "/v1/country_specs/{country}": { + readonly get: operations['GetCountrySpecs'] + } + readonly '/v1/country_specs/{country}': { /**

Returns a Country Spec for a given Country code.

*/ - readonly get: operations["GetCountrySpecsCountry"]; - }; - readonly "/v1/coupons": { + readonly get: operations['GetCountrySpecsCountry'] + } + readonly '/v1/coupons': { /**

Returns a list of your coupons.

*/ - readonly get: operations["GetCoupons"]; + readonly get: operations['GetCoupons'] /** *

You can create coupons easily via the coupon management page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.

* *

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.

*/ - readonly post: operations["PostCoupons"]; - }; - readonly "/v1/coupons/{coupon}": { + readonly post: operations['PostCoupons'] + } + readonly '/v1/coupons/{coupon}': { /**

Retrieves the coupon with the given ID.

*/ - readonly get: operations["GetCouponsCoupon"]; + readonly get: operations['GetCouponsCoupon'] /**

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

*/ - readonly post: operations["PostCouponsCoupon"]; + readonly post: operations['PostCouponsCoupon'] /**

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.

*/ - readonly delete: operations["DeleteCouponsCoupon"]; - }; - readonly "/v1/credit_notes": { + readonly delete: operations['DeleteCouponsCoupon'] + } + readonly '/v1/credit_notes': { /**

Returns a list of credit notes.

*/ - readonly get: operations["GetCreditNotes"]; + readonly get: operations['GetCreditNotes'] /** *

Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces * its amount_due. For a status=paid invoice, a credit note does not affect its amount_due. Instead, it can result @@ -472,63 +472,63 @@ export interface paths { *

You may issue multiple credit notes for an invoice. Each credit note will increment the invoice’s pre_payment_credit_notes_amount * or post_payment_credit_notes_amount depending on its status at the time of credit note creation.

*/ - readonly post: operations["PostCreditNotes"]; - }; - readonly "/v1/credit_notes/preview": { + readonly post: operations['PostCreditNotes'] + } + readonly '/v1/credit_notes/preview': { /**

Get a preview of a credit note without creating it.

*/ - readonly get: operations["GetCreditNotesPreview"]; - }; - readonly "/v1/credit_notes/preview/lines": { + readonly get: operations['GetCreditNotesPreview'] + } + readonly '/v1/credit_notes/preview/lines': { /**

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.

*/ - readonly get: operations["GetCreditNotesPreviewLines"]; - }; - readonly "/v1/credit_notes/{credit_note}/lines": { + readonly get: operations['GetCreditNotesPreviewLines'] + } + readonly '/v1/credit_notes/{credit_note}/lines': { /**

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

*/ - readonly get: operations["GetCreditNotesCreditNoteLines"]; - }; - readonly "/v1/credit_notes/{id}": { + readonly get: operations['GetCreditNotesCreditNoteLines'] + } + readonly '/v1/credit_notes/{id}': { /**

Retrieves the credit note object with the given identifier.

*/ - readonly get: operations["GetCreditNotesId"]; + readonly get: operations['GetCreditNotesId'] /**

Updates an existing credit note.

*/ - readonly post: operations["PostCreditNotesId"]; - }; - readonly "/v1/credit_notes/{id}/void": { + readonly post: operations['PostCreditNotesId'] + } + readonly '/v1/credit_notes/{id}/void': { /**

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

*/ - readonly post: operations["PostCreditNotesIdVoid"]; - }; - readonly "/v1/customers": { + readonly post: operations['PostCreditNotesIdVoid'] + } + readonly '/v1/customers': { /**

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

*/ - readonly get: operations["GetCustomers"]; + readonly get: operations['GetCustomers'] /**

Creates a new customer object.

*/ - readonly post: operations["PostCustomers"]; - }; - readonly "/v1/customers/{customer}": { + readonly post: operations['PostCustomers'] + } + readonly '/v1/customers/{customer}': { /**

Retrieves a Customer object.

*/ - readonly get: operations["GetCustomersCustomer"]; + readonly get: operations['GetCustomersCustomer'] /** *

Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the source parameter, that becomes the customer’s active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the source parameter: for each of the customer’s current subscriptions, if the subscription bills automatically and is in the past_due state, then the latest open invoice for the subscription with automatic collection enabled will be retried. This retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice. Changing the default_source for a customer will not trigger this behavior.

* *

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

*/ - readonly post: operations["PostCustomersCustomer"]; + readonly post: operations['PostCustomersCustomer'] /**

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

*/ - readonly delete: operations["DeleteCustomersCustomer"]; - }; - readonly "/v1/customers/{customer}/balance_transactions": { + readonly delete: operations['DeleteCustomersCustomer'] + } + readonly '/v1/customers/{customer}/balance_transactions': { /**

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

*/ - readonly get: operations["GetCustomersCustomerBalanceTransactions"]; + readonly get: operations['GetCustomersCustomerBalanceTransactions'] /**

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

*/ - readonly post: operations["PostCustomersCustomerBalanceTransactions"]; - }; - readonly "/v1/customers/{customer}/balance_transactions/{transaction}": { + readonly post: operations['PostCustomersCustomerBalanceTransactions'] + } + readonly '/v1/customers/{customer}/balance_transactions/{transaction}': { /**

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

*/ - readonly get: operations["GetCustomersCustomerBalanceTransactionsTransaction"]; + readonly get: operations['GetCustomersCustomerBalanceTransactionsTransaction'] /**

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

*/ - readonly post: operations["PostCustomersCustomerBalanceTransactionsTransaction"]; - }; - readonly "/v1/customers/{customer}/bank_accounts": { + readonly post: operations['PostCustomersCustomerBalanceTransactionsTransaction'] + } + readonly '/v1/customers/{customer}/bank_accounts': { /**

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.

*/ - readonly get: operations["GetCustomersCustomerBankAccounts"]; + readonly get: operations['GetCustomersCustomerBankAccounts'] /** *

When you create a new credit card, you must specify a customer or recipient on which to create it.

* @@ -536,27 +536,27 @@ export interface paths { * 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.

*/ - readonly post: operations["PostCustomersCustomerBankAccounts"]; - }; - readonly "/v1/customers/{customer}/bank_accounts/{id}": { + readonly post: operations['PostCustomersCustomerBankAccounts'] + } + readonly '/v1/customers/{customer}/bank_accounts/{id}': { /**

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.

*/ - readonly get: operations["GetCustomersCustomerBankAccountsId"]; + readonly get: operations['GetCustomersCustomerBankAccountsId'] /**

Update a specified source for a given customer.

*/ - readonly post: operations["PostCustomersCustomerBankAccountsId"]; + readonly post: operations['PostCustomersCustomerBankAccountsId'] /**

Delete a specified source for a given customer.

*/ - readonly delete: operations["DeleteCustomersCustomerBankAccountsId"]; - }; - readonly "/v1/customers/{customer}/bank_accounts/{id}/verify": { + readonly delete: operations['DeleteCustomersCustomerBankAccountsId'] + } + readonly '/v1/customers/{customer}/bank_accounts/{id}/verify': { /**

Verify a specified bank account for a given customer.

*/ - readonly post: operations["PostCustomersCustomerBankAccountsIdVerify"]; - }; - readonly "/v1/customers/{customer}/cards": { + readonly post: operations['PostCustomersCustomerBankAccountsIdVerify'] + } + readonly '/v1/customers/{customer}/cards': { /** *

You can see a list of the cards belonging to a customer. * Note that the 10 most recent sources are always available on the Customer 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 cards.

*/ - readonly get: operations["GetCustomersCustomerCards"]; + readonly get: operations['GetCustomersCustomerCards'] /** *

When you create a new credit card, you must specify a customer or recipient on which to create it.

* @@ -564,28 +564,28 @@ export interface paths { * 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.

*/ - readonly post: operations["PostCustomersCustomerCards"]; - }; - readonly "/v1/customers/{customer}/cards/{id}": { + readonly post: operations['PostCustomersCustomerCards'] + } + readonly '/v1/customers/{customer}/cards/{id}': { /**

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.

*/ - readonly get: operations["GetCustomersCustomerCardsId"]; + readonly get: operations['GetCustomersCustomerCardsId'] /**

Update a specified source for a given customer.

*/ - readonly post: operations["PostCustomersCustomerCardsId"]; + readonly post: operations['PostCustomersCustomerCardsId'] /**

Delete a specified source for a given customer.

*/ - readonly delete: operations["DeleteCustomersCustomerCardsId"]; - }; - readonly "/v1/customers/{customer}/discount": { - readonly get: operations["GetCustomersCustomerDiscount"]; + readonly delete: operations['DeleteCustomersCustomerCardsId'] + } + readonly '/v1/customers/{customer}/discount': { + readonly get: operations['GetCustomersCustomerDiscount'] /**

Removes the currently applied discount on a customer.

*/ - readonly delete: operations["DeleteCustomersCustomerDiscount"]; - }; - readonly "/v1/customers/{customer}/payment_methods": { + readonly delete: operations['DeleteCustomersCustomerDiscount'] + } + readonly '/v1/customers/{customer}/payment_methods': { /**

Returns a list of PaymentMethods for a given Customer

*/ - readonly get: operations["GetCustomersCustomerPaymentMethods"]; - }; - readonly "/v1/customers/{customer}/sources": { + readonly get: operations['GetCustomersCustomerPaymentMethods'] + } + readonly '/v1/customers/{customer}/sources': { /**

List sources for a specified customer.

*/ - readonly get: operations["GetCustomersCustomerSources"]; + readonly get: operations['GetCustomersCustomerSources'] /** *

When you create a new credit card, you must specify a customer or recipient on which to create it.

* @@ -593,31 +593,31 @@ export interface paths { * 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.

*/ - readonly post: operations["PostCustomersCustomerSources"]; - }; - readonly "/v1/customers/{customer}/sources/{id}": { + readonly post: operations['PostCustomersCustomerSources'] + } + readonly '/v1/customers/{customer}/sources/{id}': { /**

Retrieve a specified source for a given customer.

*/ - readonly get: operations["GetCustomersCustomerSourcesId"]; + readonly get: operations['GetCustomersCustomerSourcesId'] /**

Update a specified source for a given customer.

*/ - readonly post: operations["PostCustomersCustomerSourcesId"]; + readonly post: operations['PostCustomersCustomerSourcesId'] /**

Delete a specified source for a given customer.

*/ - readonly delete: operations["DeleteCustomersCustomerSourcesId"]; - }; - readonly "/v1/customers/{customer}/sources/{id}/verify": { + readonly delete: operations['DeleteCustomersCustomerSourcesId'] + } + readonly '/v1/customers/{customer}/sources/{id}/verify': { /**

Verify a specified bank account for a given customer.

*/ - readonly post: operations["PostCustomersCustomerSourcesIdVerify"]; - }; - readonly "/v1/customers/{customer}/subscriptions": { + readonly post: operations['PostCustomersCustomerSourcesIdVerify'] + } + readonly '/v1/customers/{customer}/subscriptions': { /**

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.

*/ - readonly get: operations["GetCustomersCustomerSubscriptions"]; + readonly get: operations['GetCustomersCustomerSubscriptions'] /**

Creates a new subscription on an existing customer.

*/ - readonly post: operations["PostCustomersCustomerSubscriptions"]; - }; - readonly "/v1/customers/{customer}/subscriptions/{subscription_exposed_id}": { + readonly post: operations['PostCustomersCustomerSubscriptions'] + } + readonly '/v1/customers/{customer}/subscriptions/{subscription_exposed_id}': { /**

Retrieves the subscription with the given ID.

*/ - readonly get: operations["GetCustomersCustomerSubscriptionsSubscriptionExposedId"]; + readonly get: operations['GetCustomersCustomerSubscriptionsSubscriptionExposedId'] /**

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.

*/ - readonly post: operations["PostCustomersCustomerSubscriptionsSubscriptionExposedId"]; + readonly post: operations['PostCustomersCustomerSubscriptionsSubscriptionExposedId'] /** *

Cancels a customer’s subscription. If you set the at_period_end parameter to true, the subscription will remain active until the end of the period, at which point it will be canceled and not renewed. Otherwise, with the default false value, the subscription is terminated immediately. In either case, the customer will not be charged again for the subscription.

* @@ -625,108 +625,108 @@ export interface paths { * *

By default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.

*/ - readonly delete: operations["DeleteCustomersCustomerSubscriptionsSubscriptionExposedId"]; - }; - readonly "/v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discount": { - readonly get: operations["GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount"]; + readonly delete: operations['DeleteCustomersCustomerSubscriptionsSubscriptionExposedId'] + } + readonly '/v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discount': { + readonly get: operations['GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount'] /**

Removes the currently applied discount on a customer.

*/ - readonly delete: operations["DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount"]; - }; - readonly "/v1/customers/{customer}/tax_ids": { + readonly delete: operations['DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount'] + } + readonly '/v1/customers/{customer}/tax_ids': { /**

Returns a list of tax IDs for a customer.

*/ - readonly get: operations["GetCustomersCustomerTaxIds"]; + readonly get: operations['GetCustomersCustomerTaxIds'] /**

Creates a new TaxID object for a customer.

*/ - readonly post: operations["PostCustomersCustomerTaxIds"]; - }; - readonly "/v1/customers/{customer}/tax_ids/{id}": { + readonly post: operations['PostCustomersCustomerTaxIds'] + } + readonly '/v1/customers/{customer}/tax_ids/{id}': { /**

Retrieves the TaxID object with the given identifier.

*/ - readonly get: operations["GetCustomersCustomerTaxIdsId"]; + readonly get: operations['GetCustomersCustomerTaxIdsId'] /**

Deletes an existing TaxID object.

*/ - readonly delete: operations["DeleteCustomersCustomerTaxIdsId"]; - }; - readonly "/v1/disputes": { + readonly delete: operations['DeleteCustomersCustomerTaxIdsId'] + } + readonly '/v1/disputes': { /**

Returns a list of your disputes.

*/ - readonly get: operations["GetDisputes"]; - }; - readonly "/v1/disputes/{dispute}": { + readonly get: operations['GetDisputes'] + } + readonly '/v1/disputes/{dispute}': { /**

Retrieves the dispute with the given ID.

*/ - readonly get: operations["GetDisputesDispute"]; + readonly get: operations['GetDisputesDispute'] /** *

When you get a dispute, contacting your customer is always the best first step. If that doesn’t work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your dashboard, but if you prefer, you can use the API to submit evidence programmatically.

* *

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.

*/ - readonly post: operations["PostDisputesDispute"]; - }; - readonly "/v1/disputes/{dispute}/close": { + readonly post: operations['PostDisputesDispute'] + } + readonly '/v1/disputes/{dispute}/close': { /** *

Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.

* *

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

*/ - readonly post: operations["PostDisputesDisputeClose"]; - }; - readonly "/v1/ephemeral_keys": { + readonly post: operations['PostDisputesDisputeClose'] + } + readonly '/v1/ephemeral_keys': { /**

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

*/ - readonly post: operations["PostEphemeralKeys"]; - }; - readonly "/v1/ephemeral_keys/{key}": { + readonly post: operations['PostEphemeralKeys'] + } + readonly '/v1/ephemeral_keys/{key}': { /**

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

*/ - readonly delete: operations["DeleteEphemeralKeysKey"]; - }; - readonly "/v1/events": { + readonly delete: operations['DeleteEphemeralKeysKey'] + } + readonly '/v1/events': { /**

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).

*/ - readonly get: operations["GetEvents"]; - }; - readonly "/v1/events/{id}": { + readonly get: operations['GetEvents'] + } + readonly '/v1/events/{id}': { /**

Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.

*/ - readonly get: operations["GetEventsId"]; - }; - readonly "/v1/exchange_rates": { + readonly get: operations['GetEventsId'] + } + readonly '/v1/exchange_rates': { /**

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.

*/ - readonly get: operations["GetExchangeRates"]; - }; - readonly "/v1/exchange_rates/{rate_id}": { + readonly get: operations['GetExchangeRates'] + } + readonly '/v1/exchange_rates/{rate_id}': { /**

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

*/ - readonly get: operations["GetExchangeRatesRateId"]; - }; - readonly "/v1/file_links": { + readonly get: operations['GetExchangeRatesRateId'] + } + readonly '/v1/file_links': { /**

Returns a list of file links.

*/ - readonly get: operations["GetFileLinks"]; + readonly get: operations['GetFileLinks'] /**

Creates a new file link object.

*/ - readonly post: operations["PostFileLinks"]; - }; - readonly "/v1/file_links/{link}": { + readonly post: operations['PostFileLinks'] + } + readonly '/v1/file_links/{link}': { /**

Retrieves the file link with the given ID.

*/ - readonly get: operations["GetFileLinksLink"]; + readonly get: operations['GetFileLinksLink'] /**

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

*/ - readonly post: operations["PostFileLinksLink"]; - }; - readonly "/v1/files": { + readonly post: operations['PostFileLinksLink'] + } + readonly '/v1/files': { /**

Returns a list of the files that your account has access to. The files are returned sorted by creation date, with the most recently created files appearing first.

*/ - readonly get: operations["GetFiles"]; + readonly get: operations['GetFiles'] /** *

To upload a file to Stripe, you’ll need to send a request of type multipart/form-data. The request should contain the file you would like to upload, as well as the parameters for creating a file.

* *

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

*/ - readonly post: operations["PostFiles"]; - }; - readonly "/v1/files/{file}": { + readonly post: operations['PostFiles'] + } + readonly '/v1/files/{file}': { /**

Retrieves the details of an existing file object. Supply the unique file ID from a file, and Stripe will return the corresponding file object. To access file contents, see the File Upload Guide.

*/ - readonly get: operations["GetFilesFile"]; - }; - readonly "/v1/identity/verification_reports": { + readonly get: operations['GetFilesFile'] + } + readonly '/v1/identity/verification_reports': { /**

List all verification reports.

*/ - readonly get: operations["GetIdentityVerificationReports"]; - }; - readonly "/v1/identity/verification_reports/{report}": { + readonly get: operations['GetIdentityVerificationReports'] + } + readonly '/v1/identity/verification_reports/{report}': { /**

Retrieves an existing VerificationReport

*/ - readonly get: operations["GetIdentityVerificationReportsReport"]; - }; - readonly "/v1/identity/verification_sessions": { + readonly get: operations['GetIdentityVerificationReportsReport'] + } + readonly '/v1/identity/verification_sessions': { /**

Returns a list of VerificationSessions

*/ - readonly get: operations["GetIdentityVerificationSessions"]; + readonly get: operations['GetIdentityVerificationSessions'] /** *

Creates a VerificationSession object.

* @@ -736,33 +736,33 @@ export interface paths { * *

Related guide: Verify your users’ identity documents.

*/ - readonly post: operations["PostIdentityVerificationSessions"]; - }; - readonly "/v1/identity/verification_sessions/{session}": { + readonly post: operations['PostIdentityVerificationSessions'] + } + readonly '/v1/identity/verification_sessions/{session}': { /** *

Retrieves the details of a VerificationSession that was previously created.

* *

When the session status is requires_input, you can use this method to retrieve a valid * client_secret or url to allow re-submission.

*/ - readonly get: operations["GetIdentityVerificationSessionsSession"]; + readonly get: operations['GetIdentityVerificationSessionsSession'] /** *

Updates a VerificationSession object.

* *

When the session status is requires_input, you can use this method to update the * verification check and options.

*/ - readonly post: operations["PostIdentityVerificationSessionsSession"]; - }; - readonly "/v1/identity/verification_sessions/{session}/cancel": { + readonly post: operations['PostIdentityVerificationSessionsSession'] + } + readonly '/v1/identity/verification_sessions/{session}/cancel': { /** *

A VerificationSession object can be canceled when it is in requires_input status.

* *

Once canceled, future submission attempts are disabled. This cannot be undone. Learn more.

*/ - readonly post: operations["PostIdentityVerificationSessionsSessionCancel"]; - }; - readonly "/v1/identity/verification_sessions/{session}/redact": { + readonly post: operations['PostIdentityVerificationSessionsSessionCancel'] + } + readonly '/v1/identity/verification_sessions/{session}/redact': { /** *

Redact a VerificationSession to remove all collected information from Stripe. This will redact * the VerificationSession and all objects related to it, including VerificationReports, Events, @@ -784,29 +784,29 @@ export interface paths { * *

Learn more.

*/ - readonly post: operations["PostIdentityVerificationSessionsSessionRedact"]; - }; - readonly "/v1/invoiceitems": { + readonly post: operations['PostIdentityVerificationSessionsSessionRedact'] + } + readonly '/v1/invoiceitems': { /**

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

*/ - readonly get: operations["GetInvoiceitems"]; + readonly get: operations['GetInvoiceitems'] /**

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.

*/ - readonly post: operations["PostInvoiceitems"]; - }; - readonly "/v1/invoiceitems/{invoiceitem}": { + readonly post: operations['PostInvoiceitems'] + } + readonly '/v1/invoiceitems/{invoiceitem}': { /**

Retrieves the invoice item with the given ID.

*/ - readonly get: operations["GetInvoiceitemsInvoiceitem"]; + readonly get: operations['GetInvoiceitemsInvoiceitem'] /**

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.

*/ - readonly post: operations["PostInvoiceitemsInvoiceitem"]; + readonly post: operations['PostInvoiceitemsInvoiceitem'] /**

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.

*/ - readonly delete: operations["DeleteInvoiceitemsInvoiceitem"]; - }; - readonly "/v1/invoices": { + readonly delete: operations['DeleteInvoiceitemsInvoiceitem'] + } + readonly '/v1/invoices': { /**

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.

*/ - readonly get: operations["GetInvoices"]; + readonly get: operations['GetInvoices'] /**

This endpoint creates a draft invoice for a given customer. The draft invoice created pulls in all pending invoice items on that customer, including prorations. The invoice remains a draft until you finalize the invoice, which allows you to pay or send the invoice to your customers.

*/ - readonly post: operations["PostInvoices"]; - }; - readonly "/v1/invoices/upcoming": { + readonly post: operations['PostInvoices'] + } + readonly '/v1/invoices/upcoming': { /** *

At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.

* @@ -814,15 +814,15 @@ export interface paths { * *

You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass a proration_date parameter when doing the actual subscription update. The value passed in should be the same as the subscription_proration_date returned on the upcoming invoice resource. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_proration_date on the upcoming invoice resource.

*/ - readonly get: operations["GetInvoicesUpcoming"]; - }; - readonly "/v1/invoices/upcoming/lines": { + readonly get: operations['GetInvoicesUpcoming'] + } + readonly '/v1/invoices/upcoming/lines': { /**

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.

*/ - readonly get: operations["GetInvoicesUpcomingLines"]; - }; - readonly "/v1/invoices/{invoice}": { + readonly get: operations['GetInvoicesUpcomingLines'] + } + readonly '/v1/invoices/{invoice}': { /**

Retrieves the invoice with the given ID.

*/ - readonly get: operations["GetInvoicesInvoice"]; + readonly get: operations['GetInvoicesInvoice'] /** *

Draft invoices are fully editable. Once an invoice is finalized, * monetary values, as well as collection_method, become uneditable.

@@ -831,163 +831,163 @@ export interface paths { * sending reminders for, or automatically reconciling invoices, pass * auto_advance=false.

*/ - readonly post: operations["PostInvoicesInvoice"]; + readonly post: operations['PostInvoicesInvoice'] /**

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.

*/ - readonly delete: operations["DeleteInvoicesInvoice"]; - }; - readonly "/v1/invoices/{invoice}/finalize": { + readonly delete: operations['DeleteInvoicesInvoice'] + } + readonly '/v1/invoices/{invoice}/finalize': { /**

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.

*/ - readonly post: operations["PostInvoicesInvoiceFinalize"]; - }; - readonly "/v1/invoices/{invoice}/lines": { + readonly post: operations['PostInvoicesInvoiceFinalize'] + } + readonly '/v1/invoices/{invoice}/lines': { /**

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.

*/ - readonly get: operations["GetInvoicesInvoiceLines"]; - }; - readonly "/v1/invoices/{invoice}/mark_uncollectible": { + readonly get: operations['GetInvoicesInvoiceLines'] + } + readonly '/v1/invoices/{invoice}/mark_uncollectible': { /**

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

*/ - readonly post: operations["PostInvoicesInvoiceMarkUncollectible"]; - }; - readonly "/v1/invoices/{invoice}/pay": { + readonly post: operations['PostInvoicesInvoiceMarkUncollectible'] + } + readonly '/v1/invoices/{invoice}/pay': { /**

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.

*/ - readonly post: operations["PostInvoicesInvoicePay"]; - }; - readonly "/v1/invoices/{invoice}/send": { + readonly post: operations['PostInvoicesInvoicePay'] + } + readonly '/v1/invoices/{invoice}/send': { /** *

Stripe will automatically send invoices to customers according to your subscriptions settings. However, if you’d like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.

* *

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

*/ - readonly post: operations["PostInvoicesInvoiceSend"]; - }; - readonly "/v1/invoices/{invoice}/void": { + readonly post: operations['PostInvoicesInvoiceSend'] + } + readonly '/v1/invoices/{invoice}/void': { /**

Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.

*/ - readonly post: operations["PostInvoicesInvoiceVoid"]; - }; - readonly "/v1/issuer_fraud_records": { + readonly post: operations['PostInvoicesInvoiceVoid'] + } + readonly '/v1/issuer_fraud_records': { /**

Returns a list of issuer fraud records.

*/ - readonly get: operations["GetIssuerFraudRecords"]; - }; - readonly "/v1/issuer_fraud_records/{issuer_fraud_record}": { + readonly get: operations['GetIssuerFraudRecords'] + } + readonly '/v1/issuer_fraud_records/{issuer_fraud_record}': { /** *

Retrieves the details of an issuer fraud record that has previously been created.

* *

Please refer to the issuer fraud record object reference for more details.

*/ - readonly get: operations["GetIssuerFraudRecordsIssuerFraudRecord"]; - }; - readonly "/v1/issuing/authorizations": { + readonly get: operations['GetIssuerFraudRecordsIssuerFraudRecord'] + } + readonly '/v1/issuing/authorizations': { /**

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.

*/ - readonly get: operations["GetIssuingAuthorizations"]; - }; - readonly "/v1/issuing/authorizations/{authorization}": { + readonly get: operations['GetIssuingAuthorizations'] + } + readonly '/v1/issuing/authorizations/{authorization}': { /**

Retrieves an Issuing Authorization object.

*/ - readonly get: operations["GetIssuingAuthorizationsAuthorization"]; + readonly get: operations['GetIssuingAuthorizationsAuthorization'] /**

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

*/ - readonly post: operations["PostIssuingAuthorizationsAuthorization"]; - }; - readonly "/v1/issuing/authorizations/{authorization}/approve": { + readonly post: operations['PostIssuingAuthorizationsAuthorization'] + } + readonly '/v1/issuing/authorizations/{authorization}/approve': { /**

Approves a pending Issuing Authorization object. This request should be made within the timeout window of the real-time authorization flow.

*/ - readonly post: operations["PostIssuingAuthorizationsAuthorizationApprove"]; - }; - readonly "/v1/issuing/authorizations/{authorization}/decline": { + readonly post: operations['PostIssuingAuthorizationsAuthorizationApprove'] + } + readonly '/v1/issuing/authorizations/{authorization}/decline': { /**

Declines a pending Issuing Authorization object. This request should be made within the timeout window of the real time authorization flow.

*/ - readonly post: operations["PostIssuingAuthorizationsAuthorizationDecline"]; - }; - readonly "/v1/issuing/cardholders": { + readonly post: operations['PostIssuingAuthorizationsAuthorizationDecline'] + } + readonly '/v1/issuing/cardholders': { /**

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

*/ - readonly get: operations["GetIssuingCardholders"]; + readonly get: operations['GetIssuingCardholders'] /**

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

*/ - readonly post: operations["PostIssuingCardholders"]; - }; - readonly "/v1/issuing/cardholders/{cardholder}": { + readonly post: operations['PostIssuingCardholders'] + } + readonly '/v1/issuing/cardholders/{cardholder}': { /**

Retrieves an Issuing Cardholder object.

*/ - readonly get: operations["GetIssuingCardholdersCardholder"]; + readonly get: operations['GetIssuingCardholdersCardholder'] /**

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

*/ - readonly post: operations["PostIssuingCardholdersCardholder"]; - }; - readonly "/v1/issuing/cards": { + readonly post: operations['PostIssuingCardholdersCardholder'] + } + readonly '/v1/issuing/cards': { /**

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

*/ - readonly get: operations["GetIssuingCards"]; + readonly get: operations['GetIssuingCards'] /**

Creates an Issuing Card object.

*/ - readonly post: operations["PostIssuingCards"]; - }; - readonly "/v1/issuing/cards/{card}": { + readonly post: operations['PostIssuingCards'] + } + readonly '/v1/issuing/cards/{card}': { /**

Retrieves an Issuing Card object.

*/ - readonly get: operations["GetIssuingCardsCard"]; + readonly get: operations['GetIssuingCardsCard'] /**

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

*/ - readonly post: operations["PostIssuingCardsCard"]; - }; - readonly "/v1/issuing/disputes": { + readonly post: operations['PostIssuingCardsCard'] + } + readonly '/v1/issuing/disputes': { /**

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

*/ - readonly get: operations["GetIssuingDisputes"]; + readonly get: operations['GetIssuingDisputes'] /**

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.

*/ - readonly post: operations["PostIssuingDisputes"]; - }; - readonly "/v1/issuing/disputes/{dispute}": { + readonly post: operations['PostIssuingDisputes'] + } + readonly '/v1/issuing/disputes/{dispute}': { /**

Retrieves an Issuing Dispute object.

*/ - readonly get: operations["GetIssuingDisputesDispute"]; + readonly get: operations['GetIssuingDisputesDispute'] /**

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.

*/ - readonly post: operations["PostIssuingDisputesDispute"]; - }; - readonly "/v1/issuing/disputes/{dispute}/submit": { + readonly post: operations['PostIssuingDisputesDispute'] + } + readonly '/v1/issuing/disputes/{dispute}/submit': { /**

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.

*/ - readonly post: operations["PostIssuingDisputesDisputeSubmit"]; - }; - readonly "/v1/issuing/settlements": { + readonly post: operations['PostIssuingDisputesDisputeSubmit'] + } + readonly '/v1/issuing/settlements': { /**

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

*/ - readonly get: operations["GetIssuingSettlements"]; - }; - readonly "/v1/issuing/settlements/{settlement}": { + readonly get: operations['GetIssuingSettlements'] + } + readonly '/v1/issuing/settlements/{settlement}': { /**

Retrieves an Issuing Settlement object.

*/ - readonly get: operations["GetIssuingSettlementsSettlement"]; + readonly get: operations['GetIssuingSettlementsSettlement'] /**

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

*/ - readonly post: operations["PostIssuingSettlementsSettlement"]; - }; - readonly "/v1/issuing/transactions": { + readonly post: operations['PostIssuingSettlementsSettlement'] + } + readonly '/v1/issuing/transactions': { /**

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.

*/ - readonly get: operations["GetIssuingTransactions"]; - }; - readonly "/v1/issuing/transactions/{transaction}": { + readonly get: operations['GetIssuingTransactions'] + } + readonly '/v1/issuing/transactions/{transaction}': { /**

Retrieves an Issuing Transaction object.

*/ - readonly get: operations["GetIssuingTransactionsTransaction"]; + readonly get: operations['GetIssuingTransactionsTransaction'] /**

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

*/ - readonly post: operations["PostIssuingTransactionsTransaction"]; - }; - readonly "/v1/mandates/{mandate}": { + readonly post: operations['PostIssuingTransactionsTransaction'] + } + readonly '/v1/mandates/{mandate}': { /**

Retrieves a Mandate object.

*/ - readonly get: operations["GetMandatesMandate"]; - }; - readonly "/v1/order_returns": { + readonly get: operations['GetMandatesMandate'] + } + readonly '/v1/order_returns': { /**

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

*/ - readonly get: operations["GetOrderReturns"]; - }; - readonly "/v1/order_returns/{id}": { + readonly get: operations['GetOrderReturns'] + } + readonly '/v1/order_returns/{id}': { /**

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

*/ - readonly get: operations["GetOrderReturnsId"]; - }; - readonly "/v1/orders": { + readonly get: operations['GetOrderReturnsId'] + } + readonly '/v1/orders': { /**

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

*/ - readonly get: operations["GetOrders"]; + readonly get: operations['GetOrders'] /**

Creates a new order object.

*/ - readonly post: operations["PostOrders"]; - }; - readonly "/v1/orders/{id}": { + readonly post: operations['PostOrders'] + } + readonly '/v1/orders/{id}': { /**

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

*/ - readonly get: operations["GetOrdersId"]; + readonly get: operations['GetOrdersId'] /**

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

*/ - readonly post: operations["PostOrdersId"]; - }; - readonly "/v1/orders/{id}/pay": { + readonly post: operations['PostOrdersId'] + } + readonly '/v1/orders/{id}/pay': { /**

Pay an order by providing a source to create a payment.

*/ - readonly post: operations["PostOrdersIdPay"]; - }; - readonly "/v1/orders/{id}/returns": { + readonly post: operations['PostOrdersIdPay'] + } + readonly '/v1/orders/{id}/returns': { /**

Return all or part of an order. The order must have a status of paid or fulfilled before it can be returned. Once all items have been returned, the order will become canceled or returned depending on which status the order started in.

*/ - readonly post: operations["PostOrdersIdReturns"]; - }; - readonly "/v1/payment_intents": { + readonly post: operations['PostOrdersIdReturns'] + } + readonly '/v1/payment_intents': { /**

Returns a list of PaymentIntents.

*/ - readonly get: operations["GetPaymentIntents"]; + readonly get: operations['GetPaymentIntents'] /** *

Creates a PaymentIntent object.

* @@ -1000,9 +1000,9 @@ export interface paths { * available in the confirm API when confirm=true * is supplied.

*/ - readonly post: operations["PostPaymentIntents"]; - }; - readonly "/v1/payment_intents/{intent}": { + readonly post: operations['PostPaymentIntents'] + } + readonly '/v1/payment_intents/{intent}': { /** *

Retrieves the details of a PaymentIntent that has previously been created.

* @@ -1010,7 +1010,7 @@ export interface paths { * *

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

*/ - readonly get: operations["GetPaymentIntentsIntent"]; + readonly get: operations['GetPaymentIntentsIntent'] /** *

Updates properties on a PaymentIntent object without confirming.

* @@ -1020,17 +1020,17 @@ export interface paths { * update and confirm at the same time, we recommend updating properties via * the confirm API instead.

*/ - readonly post: operations["PostPaymentIntentsIntent"]; - }; - readonly "/v1/payment_intents/{intent}/cancel": { + readonly post: operations['PostPaymentIntentsIntent'] + } + readonly '/v1/payment_intents/{intent}/cancel': { /** *

A PaymentIntent object can be canceled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action, or processing.

* *

Once canceled, no additional charges will be made by the PaymentIntent and any operations on the PaymentIntent will fail with an error. For PaymentIntents with status=’requires_capture’, the remaining amount_capturable will automatically be refunded.

*/ - readonly post: operations["PostPaymentIntentsIntentCancel"]; - }; - readonly "/v1/payment_intents/{intent}/capture": { + readonly post: operations['PostPaymentIntentsIntentCancel'] + } + readonly '/v1/payment_intents/{intent}/capture': { /** *

Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.

* @@ -1038,9 +1038,9 @@ export interface paths { * *

Learn more about separate authorization and capture.

*/ - readonly post: operations["PostPaymentIntentsIntentCapture"]; - }; - readonly "/v1/payment_intents/{intent}/confirm": { + readonly post: operations['PostPaymentIntentsIntentCapture'] + } + readonly '/v1/payment_intents/{intent}/confirm': { /** *

Confirm that your customer intends to pay with current or provided * payment method. Upon confirmation, the PaymentIntent will attempt to initiate @@ -1068,45 +1068,45 @@ export interface paths { * attempt. Read the expanded documentation * to learn more about manual confirmation.

*/ - readonly post: operations["PostPaymentIntentsIntentConfirm"]; - }; - readonly "/v1/payment_intents/{intent}/verify_microdeposits": { + readonly post: operations['PostPaymentIntentsIntentConfirm'] + } + readonly '/v1/payment_intents/{intent}/verify_microdeposits': { /**

Verifies microdeposits on a PaymentIntent object.

*/ - readonly post: operations["PostPaymentIntentsIntentVerifyMicrodeposits"]; - }; - readonly "/v1/payment_links": { + readonly post: operations['PostPaymentIntentsIntentVerifyMicrodeposits'] + } + readonly '/v1/payment_links': { /**

Returns a list of your payment links.

*/ - readonly get: operations["GetPaymentLinks"]; + readonly get: operations['GetPaymentLinks'] /**

Creates a payment link.

*/ - readonly post: operations["PostPaymentLinks"]; - }; - readonly "/v1/payment_links/{payment_link}": { + readonly post: operations['PostPaymentLinks'] + } + readonly '/v1/payment_links/{payment_link}': { /**

Retrieve a payment link.

*/ - readonly get: operations["GetPaymentLinksPaymentLink"]; + readonly get: operations['GetPaymentLinksPaymentLink'] /**

Updates a payment link.

*/ - readonly post: operations["PostPaymentLinksPaymentLink"]; - }; - readonly "/v1/payment_links/{payment_link}/line_items": { + readonly post: operations['PostPaymentLinksPaymentLink'] + } + readonly '/v1/payment_links/{payment_link}/line_items': { /**

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.

*/ - readonly get: operations["GetPaymentLinksPaymentLinkLineItems"]; - }; - readonly "/v1/payment_methods": { + readonly get: operations['GetPaymentLinksPaymentLinkLineItems'] + } + readonly '/v1/payment_methods': { /**

Returns a list of PaymentMethods. For listing a customer’s payment methods, you should use List a Customer’s PaymentMethods

*/ - readonly get: operations["GetPaymentMethods"]; + readonly get: operations['GetPaymentMethods'] /** *

Creates a PaymentMethod object. Read the Stripe.js reference to learn how to create PaymentMethods via Stripe.js.

* *

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.

*/ - readonly post: operations["PostPaymentMethods"]; - }; - readonly "/v1/payment_methods/{payment_method}": { + readonly post: operations['PostPaymentMethods'] + } + readonly '/v1/payment_methods/{payment_method}': { /**

Retrieves a PaymentMethod object.

*/ - readonly get: operations["GetPaymentMethodsPaymentMethod"]; + readonly get: operations['GetPaymentMethodsPaymentMethod'] /**

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

*/ - readonly post: operations["PostPaymentMethodsPaymentMethod"]; - }; - readonly "/v1/payment_methods/{payment_method}/attach": { + readonly post: operations['PostPaymentMethodsPaymentMethod'] + } + readonly '/v1/payment_methods/{payment_method}/attach': { /** *

Attaches a PaymentMethod object to a Customer.

* @@ -1120,15 +1120,15 @@ export interface paths { * set invoice_settings.default_payment_method, * on the Customer to the PaymentMethod’s ID.

*/ - readonly post: operations["PostPaymentMethodsPaymentMethodAttach"]; - }; - readonly "/v1/payment_methods/{payment_method}/detach": { + readonly post: operations['PostPaymentMethodsPaymentMethodAttach'] + } + readonly '/v1/payment_methods/{payment_method}/detach': { /**

Detaches a PaymentMethod object from a Customer.

*/ - readonly post: operations["PostPaymentMethodsPaymentMethodDetach"]; - }; - readonly "/v1/payouts": { + readonly post: operations['PostPaymentMethodsPaymentMethodDetach'] + } + readonly '/v1/payouts': { /**

Returns a list of existing payouts sent to third-party bank accounts or that Stripe has sent you. The payouts are returned in sorted order, with the most recently created payouts appearing first.

*/ - readonly get: operations["GetPayouts"]; + readonly get: operations['GetPayouts'] /** *

To send funds to your own bank account, you create a new payout object. Your Stripe balance must be able to cover the payout amount, or you’ll receive an “Insufficient Funds” error.

* @@ -1136,164 +1136,164 @@ export interface paths { * *

If you are creating a manual payout on a Stripe account that uses multiple payment source types, you’ll need to specify the source type balance that the payout should draw from. The balance object details available and pending amounts by source type.

*/ - readonly post: operations["PostPayouts"]; - }; - readonly "/v1/payouts/{payout}": { + readonly post: operations['PostPayouts'] + } + readonly '/v1/payouts/{payout}': { /**

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

*/ - readonly get: operations["GetPayoutsPayout"]; + readonly get: operations['GetPayoutsPayout'] /**

Updates the specified payout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request accepts only the metadata as arguments.

*/ - readonly post: operations["PostPayoutsPayout"]; - }; - readonly "/v1/payouts/{payout}/cancel": { + readonly post: operations['PostPayoutsPayout'] + } + readonly '/v1/payouts/{payout}/cancel': { /**

A previously created payout can be canceled if it has not yet been paid out. Funds will be refunded to your available balance. You may not cancel automatic Stripe payouts.

*/ - readonly post: operations["PostPayoutsPayoutCancel"]; - }; - readonly "/v1/payouts/{payout}/reverse": { + readonly post: operations['PostPayoutsPayoutCancel'] + } + readonly '/v1/payouts/{payout}/reverse': { /** *

Reverses a payout by debiting the destination bank account. Only payouts for connected accounts to US bank accounts may be reversed at this time. If the payout is in the pending status, /v1/payouts/:id/cancel should be used instead.

* *

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

*/ - readonly post: operations["PostPayoutsPayoutReverse"]; - }; - readonly "/v1/plans": { + readonly post: operations['PostPayoutsPayoutReverse'] + } + readonly '/v1/plans': { /**

Returns a list of your plans.

*/ - readonly get: operations["GetPlans"]; + readonly get: operations['GetPlans'] /**

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

*/ - readonly post: operations["PostPlans"]; - }; - readonly "/v1/plans/{plan}": { + readonly post: operations['PostPlans'] + } + readonly '/v1/plans/{plan}': { /**

Retrieves the plan with the given ID.

*/ - readonly get: operations["GetPlansPlan"]; + readonly get: operations['GetPlansPlan'] /**

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.

*/ - readonly post: operations["PostPlansPlan"]; + readonly post: operations['PostPlansPlan'] /**

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

*/ - readonly delete: operations["DeletePlansPlan"]; - }; - readonly "/v1/prices": { + readonly delete: operations['DeletePlansPlan'] + } + readonly '/v1/prices': { /**

Returns a list of your prices.

*/ - readonly get: operations["GetPrices"]; + readonly get: operations['GetPrices'] /**

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

*/ - readonly post: operations["PostPrices"]; - }; - readonly "/v1/prices/{price}": { + readonly post: operations['PostPrices'] + } + readonly '/v1/prices/{price}': { /**

Retrieves the price with the given ID.

*/ - readonly get: operations["GetPricesPrice"]; + readonly get: operations['GetPricesPrice'] /**

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

*/ - readonly post: operations["PostPricesPrice"]; - }; - readonly "/v1/products": { + readonly post: operations['PostPricesPrice'] + } + readonly '/v1/products': { /**

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

*/ - readonly get: operations["GetProducts"]; + readonly get: operations['GetProducts'] /**

Creates a new product object.

*/ - readonly post: operations["PostProducts"]; - }; - readonly "/v1/products/{id}": { + readonly post: operations['PostProducts'] + } + readonly '/v1/products/{id}': { /**

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.

*/ - readonly get: operations["GetProductsId"]; + readonly get: operations['GetProductsId'] /**

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

*/ - readonly post: operations["PostProductsId"]; + readonly post: operations['PostProductsId'] /**

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.

*/ - readonly delete: operations["DeleteProductsId"]; - }; - readonly "/v1/promotion_codes": { + readonly delete: operations['DeleteProductsId'] + } + readonly '/v1/promotion_codes': { /**

Returns a list of your promotion codes.

*/ - readonly get: operations["GetPromotionCodes"]; + readonly get: operations['GetPromotionCodes'] /**

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

*/ - readonly post: operations["PostPromotionCodes"]; - }; - readonly "/v1/promotion_codes/{promotion_code}": { + readonly post: operations['PostPromotionCodes'] + } + readonly '/v1/promotion_codes/{promotion_code}': { /**

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.

*/ - readonly get: operations["GetPromotionCodesPromotionCode"]; + readonly get: operations['GetPromotionCodesPromotionCode'] /**

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

*/ - readonly post: operations["PostPromotionCodesPromotionCode"]; - }; - readonly "/v1/quotes": { + readonly post: operations['PostPromotionCodesPromotionCode'] + } + readonly '/v1/quotes': { /**

Returns a list of your quotes.

*/ - readonly get: operations["GetQuotes"]; + readonly get: operations['GetQuotes'] /**

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.

*/ - readonly post: operations["PostQuotes"]; - }; - readonly "/v1/quotes/{quote}": { + readonly post: operations['PostQuotes'] + } + readonly '/v1/quotes/{quote}': { /**

Retrieves the quote with the given ID.

*/ - readonly get: operations["GetQuotesQuote"]; + readonly get: operations['GetQuotesQuote'] /**

A quote models prices and services for a customer.

*/ - readonly post: operations["PostQuotesQuote"]; - }; - readonly "/v1/quotes/{quote}/accept": { + readonly post: operations['PostQuotesQuote'] + } + readonly '/v1/quotes/{quote}/accept': { /**

Accepts the specified quote.

*/ - readonly post: operations["PostQuotesQuoteAccept"]; - }; - readonly "/v1/quotes/{quote}/cancel": { + readonly post: operations['PostQuotesQuoteAccept'] + } + readonly '/v1/quotes/{quote}/cancel': { /**

Cancels the quote.

*/ - readonly post: operations["PostQuotesQuoteCancel"]; - }; - readonly "/v1/quotes/{quote}/computed_upfront_line_items": { + readonly post: operations['PostQuotesQuoteCancel'] + } + readonly '/v1/quotes/{quote}/computed_upfront_line_items': { /**

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.

*/ - readonly get: operations["GetQuotesQuoteComputedUpfrontLineItems"]; - }; - readonly "/v1/quotes/{quote}/finalize": { + readonly get: operations['GetQuotesQuoteComputedUpfrontLineItems'] + } + readonly '/v1/quotes/{quote}/finalize': { /**

Finalizes the quote.

*/ - readonly post: operations["PostQuotesQuoteFinalize"]; - }; - readonly "/v1/quotes/{quote}/line_items": { + readonly post: operations['PostQuotesQuoteFinalize'] + } + readonly '/v1/quotes/{quote}/line_items': { /**

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.

*/ - readonly get: operations["GetQuotesQuoteLineItems"]; - }; - readonly "/v1/quotes/{quote}/pdf": { + readonly get: operations['GetQuotesQuoteLineItems'] + } + readonly '/v1/quotes/{quote}/pdf': { /**

Download the PDF for a finalized quote

*/ - readonly get: operations["GetQuotesQuotePdf"]; - }; - readonly "/v1/radar/early_fraud_warnings": { + readonly get: operations['GetQuotesQuotePdf'] + } + readonly '/v1/radar/early_fraud_warnings': { /**

Returns a list of early fraud warnings.

*/ - readonly get: operations["GetRadarEarlyFraudWarnings"]; - }; - readonly "/v1/radar/early_fraud_warnings/{early_fraud_warning}": { + readonly get: operations['GetRadarEarlyFraudWarnings'] + } + readonly '/v1/radar/early_fraud_warnings/{early_fraud_warning}': { /** *

Retrieves the details of an early fraud warning that has previously been created.

* *

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

*/ - readonly get: operations["GetRadarEarlyFraudWarningsEarlyFraudWarning"]; - }; - readonly "/v1/radar/value_list_items": { + readonly get: operations['GetRadarEarlyFraudWarningsEarlyFraudWarning'] + } + readonly '/v1/radar/value_list_items': { /**

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

*/ - readonly get: operations["GetRadarValueListItems"]; + readonly get: operations['GetRadarValueListItems'] /**

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

*/ - readonly post: operations["PostRadarValueListItems"]; - }; - readonly "/v1/radar/value_list_items/{item}": { + readonly post: operations['PostRadarValueListItems'] + } + readonly '/v1/radar/value_list_items/{item}': { /**

Retrieves a ValueListItem object.

*/ - readonly get: operations["GetRadarValueListItemsItem"]; + readonly get: operations['GetRadarValueListItemsItem'] /**

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

*/ - readonly delete: operations["DeleteRadarValueListItemsItem"]; - }; - readonly "/v1/radar/value_lists": { + readonly delete: operations['DeleteRadarValueListItemsItem'] + } + readonly '/v1/radar/value_lists': { /**

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

*/ - readonly get: operations["GetRadarValueLists"]; + readonly get: operations['GetRadarValueLists'] /**

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

*/ - readonly post: operations["PostRadarValueLists"]; - }; - readonly "/v1/radar/value_lists/{value_list}": { + readonly post: operations['PostRadarValueLists'] + } + readonly '/v1/radar/value_lists/{value_list}': { /**

Retrieves a ValueList object.

*/ - readonly get: operations["GetRadarValueListsValueList"]; + readonly get: operations['GetRadarValueListsValueList'] /**

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.

*/ - readonly post: operations["PostRadarValueListsValueList"]; + readonly post: operations['PostRadarValueListsValueList'] /**

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.

*/ - readonly delete: operations["DeleteRadarValueListsValueList"]; - }; - readonly "/v1/recipients": { + readonly delete: operations['DeleteRadarValueListsValueList'] + } + readonly '/v1/recipients': { /**

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

*/ - readonly get: operations["GetRecipients"]; + readonly get: operations['GetRecipients'] /** *

Creates a new Recipient object and verifies the recipient’s identity. * Also verifies the recipient’s bank account information or debit card, if either is provided.

*/ - readonly post: operations["PostRecipients"]; - }; - readonly "/v1/recipients/{id}": { + readonly post: operations['PostRecipients'] + } + readonly '/v1/recipients/{id}': { /**

Retrieves the details of an existing recipient. You need only supply the unique recipient identifier that was returned upon recipient creation.

*/ - readonly get: operations["GetRecipientsId"]; + readonly get: operations['GetRecipientsId'] /** *

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

@@ -1301,72 +1301,72 @@ export interface paths { *

If you update the name or tax ID, the identity verification will automatically be rerun. * If you update the bank account, the bank account validation will automatically be rerun.

*/ - readonly post: operations["PostRecipientsId"]; + readonly post: operations['PostRecipientsId'] /**

Permanently deletes a recipient. It cannot be undone.

*/ - readonly delete: operations["DeleteRecipientsId"]; - }; - readonly "/v1/refunds": { + readonly delete: operations['DeleteRecipientsId'] + } + readonly '/v1/refunds': { /**

Returns a list of all refunds you’ve previously created. The refunds are returned in sorted order, with the most recent refunds appearing first. For convenience, the 10 most recent refunds are always available by default on the charge object.

*/ - readonly get: operations["GetRefunds"]; + readonly get: operations['GetRefunds'] /**

Create a refund.

*/ - readonly post: operations["PostRefunds"]; - }; - readonly "/v1/refunds/{refund}": { + readonly post: operations['PostRefunds'] + } + readonly '/v1/refunds/{refund}': { /**

Retrieves the details of an existing refund.

*/ - readonly get: operations["GetRefundsRefund"]; + readonly get: operations['GetRefundsRefund'] /** *

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

* *

This request only accepts metadata as an argument.

*/ - readonly post: operations["PostRefundsRefund"]; - }; - readonly "/v1/reporting/report_runs": { + readonly post: operations['PostRefundsRefund'] + } + readonly '/v1/reporting/report_runs': { /**

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

*/ - readonly get: operations["GetReportingReportRuns"]; + readonly get: operations['GetReportingReportRuns'] /**

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

*/ - readonly post: operations["PostReportingReportRuns"]; - }; - readonly "/v1/reporting/report_runs/{report_run}": { + readonly post: operations['PostReportingReportRuns'] + } + readonly '/v1/reporting/report_runs/{report_run}': { /**

Retrieves the details of an existing Report Run.

*/ - readonly get: operations["GetReportingReportRunsReportRun"]; - }; - readonly "/v1/reporting/report_types": { + readonly get: operations['GetReportingReportRunsReportRun'] + } + readonly '/v1/reporting/report_types': { /**

Returns a full list of Report Types.

*/ - readonly get: operations["GetReportingReportTypes"]; - }; - readonly "/v1/reporting/report_types/{report_type}": { + readonly get: operations['GetReportingReportTypes'] + } + readonly '/v1/reporting/report_types/{report_type}': { /**

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

*/ - readonly get: operations["GetReportingReportTypesReportType"]; - }; - readonly "/v1/reviews": { + readonly get: operations['GetReportingReportTypesReportType'] + } + readonly '/v1/reviews': { /**

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.

*/ - readonly get: operations["GetReviews"]; - }; - readonly "/v1/reviews/{review}": { + readonly get: operations['GetReviews'] + } + readonly '/v1/reviews/{review}': { /**

Retrieves a Review object.

*/ - readonly get: operations["GetReviewsReview"]; - }; - readonly "/v1/reviews/{review}/approve": { + readonly get: operations['GetReviewsReview'] + } + readonly '/v1/reviews/{review}/approve': { /**

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

*/ - readonly post: operations["PostReviewsReviewApprove"]; - }; - readonly "/v1/setup_attempts": { + readonly post: operations['PostReviewsReviewApprove'] + } + readonly '/v1/setup_attempts': { /**

Returns a list of SetupAttempts associated with a provided SetupIntent.

*/ - readonly get: operations["GetSetupAttempts"]; - }; - readonly "/v1/setup_intents": { + readonly get: operations['GetSetupAttempts'] + } + readonly '/v1/setup_intents': { /**

Returns a list of SetupIntents.

*/ - readonly get: operations["GetSetupIntents"]; + readonly get: operations['GetSetupIntents'] /** *

Creates a SetupIntent object.

* *

After the SetupIntent is created, attach a payment method and confirm * to collect any required permissions to charge the payment method later.

*/ - readonly post: operations["PostSetupIntents"]; - }; - readonly "/v1/setup_intents/{intent}": { + readonly post: operations['PostSetupIntents'] + } + readonly '/v1/setup_intents/{intent}': { /** *

Retrieves the details of a SetupIntent that has previously been created.

* @@ -1374,19 +1374,19 @@ export interface paths { * *

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

*/ - readonly get: operations["GetSetupIntentsIntent"]; + readonly get: operations['GetSetupIntentsIntent'] /**

Updates a SetupIntent object.

*/ - readonly post: operations["PostSetupIntentsIntent"]; - }; - readonly "/v1/setup_intents/{intent}/cancel": { + readonly post: operations['PostSetupIntentsIntent'] + } + readonly '/v1/setup_intents/{intent}/cancel': { /** *

A SetupIntent object can be canceled when it is in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.

* *

Once canceled, setup is abandoned and any operations on the SetupIntent will fail with an error.

*/ - readonly post: operations["PostSetupIntentsIntentCancel"]; - }; - readonly "/v1/setup_intents/{intent}/confirm": { + readonly post: operations['PostSetupIntentsIntentCancel'] + } + readonly '/v1/setup_intents/{intent}/confirm': { /** *

Confirm that your customer intends to set up the current or * provided payment method. For example, you would confirm a SetupIntent @@ -1402,103 +1402,103 @@ export interface paths { * the SetupIntent will transition to the * requires_payment_method status.

*/ - readonly post: operations["PostSetupIntentsIntentConfirm"]; - }; - readonly "/v1/setup_intents/{intent}/verify_microdeposits": { + readonly post: operations['PostSetupIntentsIntentConfirm'] + } + readonly '/v1/setup_intents/{intent}/verify_microdeposits': { /**

Verifies microdeposits on a SetupIntent object.

*/ - readonly post: operations["PostSetupIntentsIntentVerifyMicrodeposits"]; - }; - readonly "/v1/shipping_rates": { + readonly post: operations['PostSetupIntentsIntentVerifyMicrodeposits'] + } + readonly '/v1/shipping_rates': { /**

Returns a list of your shipping rates.

*/ - readonly get: operations["GetShippingRates"]; + readonly get: operations['GetShippingRates'] /**

Creates a new shipping rate object.

*/ - readonly post: operations["PostShippingRates"]; - }; - readonly "/v1/shipping_rates/{shipping_rate_token}": { + readonly post: operations['PostShippingRates'] + } + readonly '/v1/shipping_rates/{shipping_rate_token}': { /**

Returns the shipping rate object with the given ID.

*/ - readonly get: operations["GetShippingRatesShippingRateToken"]; + readonly get: operations['GetShippingRatesShippingRateToken'] /**

Updates an existing shipping rate object.

*/ - readonly post: operations["PostShippingRatesShippingRateToken"]; - }; - readonly "/v1/sigma/scheduled_query_runs": { + readonly post: operations['PostShippingRatesShippingRateToken'] + } + readonly '/v1/sigma/scheduled_query_runs': { /**

Returns a list of scheduled query runs.

*/ - readonly get: operations["GetSigmaScheduledQueryRuns"]; - }; - readonly "/v1/sigma/scheduled_query_runs/{scheduled_query_run}": { + readonly get: operations['GetSigmaScheduledQueryRuns'] + } + readonly '/v1/sigma/scheduled_query_runs/{scheduled_query_run}': { /**

Retrieves the details of an scheduled query run.

*/ - readonly get: operations["GetSigmaScheduledQueryRunsScheduledQueryRun"]; - }; - readonly "/v1/skus": { + readonly get: operations['GetSigmaScheduledQueryRunsScheduledQueryRun'] + } + readonly '/v1/skus': { /**

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

*/ - readonly get: operations["GetSkus"]; + readonly get: operations['GetSkus'] /**

Creates a new SKU associated with a product.

*/ - readonly post: operations["PostSkus"]; - }; - readonly "/v1/skus/{id}": { + readonly post: operations['PostSkus'] + } + readonly '/v1/skus/{id}': { /**

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

*/ - readonly get: operations["GetSkusId"]; + readonly get: operations['GetSkusId'] /** *

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

* *

Note that a SKU’s attributes are not editable. Instead, you would need to deactivate the existing SKU and create a new one with the new attribute values.

*/ - readonly post: operations["PostSkusId"]; + readonly post: operations['PostSkusId'] /**

Delete a SKU. Deleting a SKU is only possible until it has been used in an order.

*/ - readonly delete: operations["DeleteSkusId"]; - }; - readonly "/v1/sources": { + readonly delete: operations['DeleteSkusId'] + } + readonly '/v1/sources': { /**

Creates a new source object.

*/ - readonly post: operations["PostSources"]; - }; - readonly "/v1/sources/{source}": { + readonly post: operations['PostSources'] + } + readonly '/v1/sources/{source}': { /**

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.

*/ - readonly get: operations["GetSourcesSource"]; + readonly get: operations['GetSourcesSource'] /** *

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

* *

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.

*/ - readonly post: operations["PostSourcesSource"]; - }; - readonly "/v1/sources/{source}/mandate_notifications/{mandate_notification}": { + readonly post: operations['PostSourcesSource'] + } + readonly '/v1/sources/{source}/mandate_notifications/{mandate_notification}': { /**

Retrieves a new Source MandateNotification.

*/ - readonly get: operations["GetSourcesSourceMandateNotificationsMandateNotification"]; - }; - readonly "/v1/sources/{source}/source_transactions": { + readonly get: operations['GetSourcesSourceMandateNotificationsMandateNotification'] + } + readonly '/v1/sources/{source}/source_transactions': { /**

List source transactions for a given source.

*/ - readonly get: operations["GetSourcesSourceSourceTransactions"]; - }; - readonly "/v1/sources/{source}/source_transactions/{source_transaction}": { + readonly get: operations['GetSourcesSourceSourceTransactions'] + } + readonly '/v1/sources/{source}/source_transactions/{source_transaction}': { /**

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.

*/ - readonly get: operations["GetSourcesSourceSourceTransactionsSourceTransaction"]; - }; - readonly "/v1/sources/{source}/verify": { + readonly get: operations['GetSourcesSourceSourceTransactionsSourceTransaction'] + } + readonly '/v1/sources/{source}/verify': { /**

Verify a given source.

*/ - readonly post: operations["PostSourcesSourceVerify"]; - }; - readonly "/v1/subscription_items": { + readonly post: operations['PostSourcesSourceVerify'] + } + readonly '/v1/subscription_items': { /**

Returns a list of your subscription items for a given subscription.

*/ - readonly get: operations["GetSubscriptionItems"]; + readonly get: operations['GetSubscriptionItems'] /**

Adds a new item to an existing subscription. No existing items will be changed or replaced.

*/ - readonly post: operations["PostSubscriptionItems"]; - }; - readonly "/v1/subscription_items/{item}": { + readonly post: operations['PostSubscriptionItems'] + } + readonly '/v1/subscription_items/{item}': { /**

Retrieves the subscription item with the given ID.

*/ - readonly get: operations["GetSubscriptionItemsItem"]; + readonly get: operations['GetSubscriptionItemsItem'] /**

Updates the plan or quantity of an item on a current subscription.

*/ - readonly post: operations["PostSubscriptionItemsItem"]; + readonly post: operations['PostSubscriptionItemsItem'] /**

Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.

*/ - readonly delete: operations["DeleteSubscriptionItemsItem"]; - }; - readonly "/v1/subscription_items/{subscription_item}/usage_record_summaries": { + readonly delete: operations['DeleteSubscriptionItemsItem'] + } + readonly '/v1/subscription_items/{subscription_item}/usage_record_summaries': { /** *

For the specified subscription item, returns a list of summary objects. Each object in the list provides usage information that’s been summarized from multiple usage records and over a subscription billing period (e.g., 15 usage records in the month of September).

* *

The list is sorted in reverse-chronological order (newest first). The first list item represents the most current usage period that hasn’t ended yet. Since new usage records can still be added, the returned summary information for the subscription item’s ID should be seen as unstable until the subscription billing period ends.

*/ - readonly get: operations["GetSubscriptionItemsSubscriptionItemUsageRecordSummaries"]; - }; - readonly "/v1/subscription_items/{subscription_item}/usage_records": { + readonly get: operations['GetSubscriptionItemsSubscriptionItemUsageRecordSummaries'] + } + readonly '/v1/subscription_items/{subscription_item}/usage_records': { /** *

Creates a usage record for a specified subscription item and date, and fills it with a quantity.

* @@ -1508,39 +1508,39 @@ export interface paths { * *

The default pricing model for metered billing is per-unit pricing. For finer granularity, you can configure metered billing to have a tiered pricing model.

*/ - readonly post: operations["PostSubscriptionItemsSubscriptionItemUsageRecords"]; - }; - readonly "/v1/subscription_schedules": { + readonly post: operations['PostSubscriptionItemsSubscriptionItemUsageRecords'] + } + readonly '/v1/subscription_schedules': { /**

Retrieves the list of your subscription schedules.

*/ - readonly get: operations["GetSubscriptionSchedules"]; + readonly get: operations['GetSubscriptionSchedules'] /**

Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.

*/ - readonly post: operations["PostSubscriptionSchedules"]; - }; - readonly "/v1/subscription_schedules/{schedule}": { + readonly post: operations['PostSubscriptionSchedules'] + } + readonly '/v1/subscription_schedules/{schedule}': { /**

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.

*/ - readonly get: operations["GetSubscriptionSchedulesSchedule"]; + readonly get: operations['GetSubscriptionSchedulesSchedule'] /**

Updates an existing subscription schedule.

*/ - readonly post: operations["PostSubscriptionSchedulesSchedule"]; - }; - readonly "/v1/subscription_schedules/{schedule}/cancel": { + readonly post: operations['PostSubscriptionSchedulesSchedule'] + } + readonly '/v1/subscription_schedules/{schedule}/cancel': { /**

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.

*/ - readonly post: operations["PostSubscriptionSchedulesScheduleCancel"]; - }; - readonly "/v1/subscription_schedules/{schedule}/release": { + readonly post: operations['PostSubscriptionSchedulesScheduleCancel'] + } + readonly '/v1/subscription_schedules/{schedule}/release': { /**

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.

*/ - readonly post: operations["PostSubscriptionSchedulesScheduleRelease"]; - }; - readonly "/v1/subscriptions": { + readonly post: operations['PostSubscriptionSchedulesScheduleRelease'] + } + readonly '/v1/subscriptions': { /**

By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.

*/ - readonly get: operations["GetSubscriptions"]; + readonly get: operations['GetSubscriptions'] /**

Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.

*/ - readonly post: operations["PostSubscriptions"]; - }; - readonly "/v1/subscriptions/{subscription_exposed_id}": { + readonly post: operations['PostSubscriptions'] + } + readonly '/v1/subscriptions/{subscription_exposed_id}': { /**

Retrieves the subscription with the given ID.

*/ - readonly get: operations["GetSubscriptionsSubscriptionExposedId"]; + readonly get: operations['GetSubscriptionsSubscriptionExposedId'] /**

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.

*/ - readonly post: operations["PostSubscriptionsSubscriptionExposedId"]; + readonly post: operations['PostSubscriptionsSubscriptionExposedId'] /** *

Cancels a customer’s subscription immediately. The customer will not be charged again for the subscription.

* @@ -1548,103 +1548,103 @@ export interface paths { * *

By default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.

*/ - readonly delete: operations["DeleteSubscriptionsSubscriptionExposedId"]; - }; - readonly "/v1/subscriptions/{subscription_exposed_id}/discount": { + readonly delete: operations['DeleteSubscriptionsSubscriptionExposedId'] + } + readonly '/v1/subscriptions/{subscription_exposed_id}/discount': { /**

Removes the currently applied discount on a subscription.

*/ - readonly delete: operations["DeleteSubscriptionsSubscriptionExposedIdDiscount"]; - }; - readonly "/v1/tax_codes": { + readonly delete: operations['DeleteSubscriptionsSubscriptionExposedIdDiscount'] + } + readonly '/v1/tax_codes': { /**

A list of all tax codes available to add to Products in order to allow specific tax calculations.

*/ - readonly get: operations["GetTaxCodes"]; - }; - readonly "/v1/tax_codes/{id}": { + readonly get: operations['GetTaxCodes'] + } + readonly '/v1/tax_codes/{id}': { /**

Retrieves the details of an existing tax code. Supply the unique tax code ID and Stripe will return the corresponding tax code information.

*/ - readonly get: operations["GetTaxCodesId"]; - }; - readonly "/v1/tax_rates": { + readonly get: operations['GetTaxCodesId'] + } + readonly '/v1/tax_rates': { /**

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

*/ - readonly get: operations["GetTaxRates"]; + readonly get: operations['GetTaxRates'] /**

Creates a new tax rate.

*/ - readonly post: operations["PostTaxRates"]; - }; - readonly "/v1/tax_rates/{tax_rate}": { + readonly post: operations['PostTaxRates'] + } + readonly '/v1/tax_rates/{tax_rate}': { /**

Retrieves a tax rate with the given ID

*/ - readonly get: operations["GetTaxRatesTaxRate"]; + readonly get: operations['GetTaxRatesTaxRate'] /**

Updates an existing tax rate.

*/ - readonly post: operations["PostTaxRatesTaxRate"]; - }; - readonly "/v1/terminal/connection_tokens": { + readonly post: operations['PostTaxRatesTaxRate'] + } + readonly '/v1/terminal/connection_tokens': { /**

To connect to a reader the Stripe Terminal SDK needs to retrieve a short-lived connection token from Stripe, proxied through your server. On your backend, add an endpoint that creates and returns a connection token.

*/ - readonly post: operations["PostTerminalConnectionTokens"]; - }; - readonly "/v1/terminal/locations": { + readonly post: operations['PostTerminalConnectionTokens'] + } + readonly '/v1/terminal/locations': { /**

Returns a list of Location objects.

*/ - readonly get: operations["GetTerminalLocations"]; + readonly get: operations['GetTerminalLocations'] /** *

Creates a new Location object. * For further details, including which address fields are required in each country, see the Manage locations guide.

*/ - readonly post: operations["PostTerminalLocations"]; - }; - readonly "/v1/terminal/locations/{location}": { + readonly post: operations['PostTerminalLocations'] + } + readonly '/v1/terminal/locations/{location}': { /**

Retrieves a Location object.

*/ - readonly get: operations["GetTerminalLocationsLocation"]; + readonly get: operations['GetTerminalLocationsLocation'] /**

Updates a Location object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ - readonly post: operations["PostTerminalLocationsLocation"]; + readonly post: operations['PostTerminalLocationsLocation'] /**

Deletes a Location object.

*/ - readonly delete: operations["DeleteTerminalLocationsLocation"]; - }; - readonly "/v1/terminal/readers": { + readonly delete: operations['DeleteTerminalLocationsLocation'] + } + readonly '/v1/terminal/readers': { /**

Returns a list of Reader objects.

*/ - readonly get: operations["GetTerminalReaders"]; + readonly get: operations['GetTerminalReaders'] /**

Creates a new Reader object.

*/ - readonly post: operations["PostTerminalReaders"]; - }; - readonly "/v1/terminal/readers/{reader}": { + readonly post: operations['PostTerminalReaders'] + } + readonly '/v1/terminal/readers/{reader}': { /**

Retrieves a Reader object.

*/ - readonly get: operations["GetTerminalReadersReader"]; + readonly get: operations['GetTerminalReadersReader'] /**

Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ - readonly post: operations["PostTerminalReadersReader"]; + readonly post: operations['PostTerminalReadersReader'] /**

Deletes a Reader object.

*/ - readonly delete: operations["DeleteTerminalReadersReader"]; - }; - readonly "/v1/tokens": { + readonly delete: operations['DeleteTerminalReadersReader'] + } + readonly '/v1/tokens': { /** *

Creates a single-use token that represents a bank account’s details. * This token can be used with any API method in place of a bank account dictionary. This token can be used only once, by attaching it to a Custom account.

*/ - readonly post: operations["PostTokens"]; - }; - readonly "/v1/tokens/{token}": { + readonly post: operations['PostTokens'] + } + readonly '/v1/tokens/{token}': { /**

Retrieves the token with the given ID.

*/ - readonly get: operations["GetTokensToken"]; - }; - readonly "/v1/topups": { + readonly get: operations['GetTokensToken'] + } + readonly '/v1/topups': { /**

Returns a list of top-ups.

*/ - readonly get: operations["GetTopups"]; + readonly get: operations['GetTopups'] /**

Top up the balance of an account

*/ - readonly post: operations["PostTopups"]; - }; - readonly "/v1/topups/{topup}": { + readonly post: operations['PostTopups'] + } + readonly '/v1/topups/{topup}': { /**

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.

*/ - readonly get: operations["GetTopupsTopup"]; + readonly get: operations['GetTopupsTopup'] /**

Updates the metadata of a top-up. Other top-up details are not editable by design.

*/ - readonly post: operations["PostTopupsTopup"]; - }; - readonly "/v1/topups/{topup}/cancel": { + readonly post: operations['PostTopupsTopup'] + } + readonly '/v1/topups/{topup}/cancel': { /**

Cancels a top-up. Only pending top-ups can be canceled.

*/ - readonly post: operations["PostTopupsTopupCancel"]; - }; - readonly "/v1/transfers": { + readonly post: operations['PostTopupsTopupCancel'] + } + readonly '/v1/transfers': { /**

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.

*/ - readonly get: operations["GetTransfers"]; + readonly get: operations['GetTransfers'] /**

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.

*/ - readonly post: operations["PostTransfers"]; - }; - readonly "/v1/transfers/{id}/reversals": { + readonly post: operations['PostTransfers'] + } + readonly '/v1/transfers/{id}/reversals': { /**

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.

*/ - readonly get: operations["GetTransfersIdReversals"]; + readonly get: operations['GetTransfersIdReversals'] /** *

When you create a new reversal, you must specify a transfer to create it on.

* @@ -1652,42 +1652,42 @@ export interface paths { * *

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.

*/ - readonly post: operations["PostTransfersIdReversals"]; - }; - readonly "/v1/transfers/{transfer}": { + readonly post: operations['PostTransfersIdReversals'] + } + readonly '/v1/transfers/{transfer}': { /**

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.

*/ - readonly get: operations["GetTransfersTransfer"]; + readonly get: operations['GetTransfersTransfer'] /** *

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

* *

This request accepts only metadata as an argument.

*/ - readonly post: operations["PostTransfersTransfer"]; - }; - readonly "/v1/transfers/{transfer}/reversals/{id}": { + readonly post: operations['PostTransfersTransfer'] + } + readonly '/v1/transfers/{transfer}/reversals/{id}': { /**

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.

*/ - readonly get: operations["GetTransfersTransferReversalsId"]; + readonly get: operations['GetTransfersTransferReversalsId'] /** *

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

* *

This request only accepts metadata and description as arguments.

*/ - readonly post: operations["PostTransfersTransferReversalsId"]; - }; - readonly "/v1/webhook_endpoints": { + readonly post: operations['PostTransfersTransferReversalsId'] + } + readonly '/v1/webhook_endpoints': { /**

Returns a list of your webhook endpoints.

*/ - readonly get: operations["GetWebhookEndpoints"]; + readonly get: operations['GetWebhookEndpoints'] /**

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.

*/ - readonly post: operations["PostWebhookEndpoints"]; - }; - readonly "/v1/webhook_endpoints/{webhook_endpoint}": { + readonly post: operations['PostWebhookEndpoints'] + } + readonly '/v1/webhook_endpoints/{webhook_endpoint}': { /**

Retrieves the webhook endpoint with the given ID.

*/ - readonly get: operations["GetWebhookEndpointsWebhookEndpoint"]; + readonly get: operations['GetWebhookEndpointsWebhookEndpoint'] /**

Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.

*/ - readonly post: operations["PostWebhookEndpointsWebhookEndpoint"]; + readonly post: operations['PostWebhookEndpointsWebhookEndpoint'] /**

You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.

*/ - readonly delete: operations["DeleteWebhookEndpointsWebhookEndpoint"]; - }; + readonly delete: operations['DeleteWebhookEndpointsWebhookEndpoint'] + } } export interface components { @@ -1703,262 +1703,261 @@ export interface components { */ readonly account: { /** @description Business information about the account. */ - readonly business_profile?: Partial | null; + readonly business_profile?: Partial | null /** * @description The business type. * @enum {string|null} */ - readonly business_type?: ("company" | "government_entity" | "individual" | "non_profit") | null; - readonly capabilities?: components["schemas"]["account_capabilities"]; + readonly business_type?: ('company' | 'government_entity' | 'individual' | 'non_profit') | null + readonly capabilities?: components['schemas']['account_capabilities'] /** @description Whether the account can create live charges. */ - readonly charges_enabled?: boolean; - readonly company?: components["schemas"]["legal_entity_company"]; - readonly controller?: components["schemas"]["account_unification_account_controller"]; + readonly charges_enabled?: boolean + readonly company?: components['schemas']['legal_entity_company'] + readonly controller?: components['schemas']['account_unification_account_controller'] /** @description The account's country. */ - readonly country?: string; + readonly country?: string /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created?: number; + readonly created?: number /** @description 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). */ - readonly default_currency?: string; + readonly default_currency?: string /** @description Whether account details have been submitted. Standard accounts cannot receive payouts before this is true. */ - readonly details_submitted?: boolean; + readonly details_submitted?: boolean /** @description An email address associated with the account. You can treat this as metadata: it is not used for authentication or messaging account holders. */ - readonly email?: string | null; + readonly email?: string | null /** * ExternalAccountList * @description External accounts (bank accounts and debit cards) currently attached to this account */ readonly external_accounts?: { /** @description The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards. */ - readonly data: readonly (Partial & - Partial)[]; + readonly data: readonly (Partial & Partial)[] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - readonly future_requirements?: components["schemas"]["account_future_requirements"]; + readonly url: string + } + readonly future_requirements?: components['schemas']['account_future_requirements'] /** @description Unique identifier for the object. */ - readonly id: string; - readonly individual?: components["schemas"]["person"]; + readonly id: string + readonly individual?: components['schemas']['person'] /** @description 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. */ - readonly metadata?: { readonly [key: string]: string }; + readonly metadata?: { readonly [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "account"; + readonly object: 'account' /** @description Whether Stripe can send payouts to this account. */ - readonly payouts_enabled?: boolean; - readonly requirements?: components["schemas"]["account_requirements"]; + readonly payouts_enabled?: boolean + readonly requirements?: components['schemas']['account_requirements'] /** @description Options for customizing how the account functions within Stripe. */ - readonly settings?: Partial | null; - readonly tos_acceptance?: components["schemas"]["account_tos_acceptance"]; + readonly settings?: Partial | null + readonly tos_acceptance?: components['schemas']['account_tos_acceptance'] /** * @description The Stripe account type. Can be `standard`, `express`, or `custom`. * @enum {string} */ - readonly type?: "custom" | "express" | "standard"; - }; + readonly type?: 'custom' | 'express' | 'standard' + } /** AccountBacsDebitPaymentsSettings */ readonly account_bacs_debit_payments_settings: { /** @description The Bacs Direct Debit Display Name for this account. For payments made with Bacs Direct Debit, this will appear on the mandate, and as the statement descriptor. */ - readonly display_name?: string; - }; + readonly display_name?: string + } /** AccountBrandingSettings */ readonly account_branding_settings: { /** @description (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. */ - readonly icon?: (Partial & Partial) | null; + readonly icon?: (Partial & Partial) | null /** @description (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. */ - readonly logo?: (Partial & Partial) | null; + readonly logo?: (Partial & Partial) | null /** @description A CSS hex color value representing the primary branding color for this account */ - readonly primary_color?: string | null; + readonly primary_color?: string | null /** @description A CSS hex color value representing the secondary branding color for this account */ - readonly secondary_color?: string | null; - }; + readonly secondary_color?: string | null + } /** AccountBusinessProfile */ readonly account_business_profile: { /** @description [The merchant category code for the account](https://stripe.com/docs/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide. */ - readonly mcc?: string | null; + readonly mcc?: string | null /** @description The customer-facing business name. */ - readonly name?: string | null; + readonly name?: string | null /** @description Internal-only description of the product sold or service provided by the business. It's used by Stripe for risk and underwriting purposes. */ - readonly product_description?: string | null; + readonly product_description?: string | null /** @description A publicly available mailing address for sending support issues to. */ - readonly support_address?: Partial | null; + readonly support_address?: Partial | null /** @description A publicly available email address for sending support issues to. */ - readonly support_email?: string | null; + readonly support_email?: string | null /** @description A publicly available phone number to call with support issues. */ - readonly support_phone?: string | null; + readonly support_phone?: string | null /** @description A publicly available website for handling support issues. */ - readonly support_url?: string | null; + readonly support_url?: string | null /** @description The business's publicly available website. */ - readonly url?: string | null; - }; + readonly url?: string | null + } /** AccountCapabilities */ readonly account_capabilities: { /** * @description 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. * @enum {string} */ - readonly acss_debit_payments?: "active" | "inactive" | "pending"; + readonly acss_debit_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the Afterpay Clearpay capability of the account, or whether the account can directly process Afterpay Clearpay charges. * @enum {string} */ - readonly afterpay_clearpay_payments?: "active" | "inactive" | "pending"; + readonly afterpay_clearpay_payments?: 'active' | 'inactive' | 'pending' /** * @description 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. * @enum {string} */ - readonly au_becs_debit_payments?: "active" | "inactive" | "pending"; + readonly au_becs_debit_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the Bacs Direct Debits payments capability of the account, or whether the account can directly process Bacs Direct Debits charges. * @enum {string} */ - readonly bacs_debit_payments?: "active" | "inactive" | "pending"; + readonly bacs_debit_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the Bancontact payments capability of the account, or whether the account can directly process Bancontact charges. * @enum {string} */ - readonly bancontact_payments?: "active" | "inactive" | "pending"; + readonly bancontact_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the boleto payments capability of the account, or whether the account can directly process boleto charges. * @enum {string} */ - readonly boleto_payments?: "active" | "inactive" | "pending"; + readonly boleto_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the card issuing capability of the account, or whether you can use Issuing to distribute funds on cards * @enum {string} */ - readonly card_issuing?: "active" | "inactive" | "pending"; + readonly card_issuing?: 'active' | 'inactive' | 'pending' /** * @description The status of the card payments capability of the account, or whether the account can directly process credit and debit card charges. * @enum {string} */ - readonly card_payments?: "active" | "inactive" | "pending"; + readonly card_payments?: 'active' | 'inactive' | 'pending' /** * @description 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. * @enum {string} */ - readonly cartes_bancaires_payments?: "active" | "inactive" | "pending"; + readonly cartes_bancaires_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the EPS payments capability of the account, or whether the account can directly process EPS charges. * @enum {string} */ - readonly eps_payments?: "active" | "inactive" | "pending"; + readonly eps_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the FPX payments capability of the account, or whether the account can directly process FPX charges. * @enum {string} */ - readonly fpx_payments?: "active" | "inactive" | "pending"; + readonly fpx_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the giropay payments capability of the account, or whether the account can directly process giropay charges. * @enum {string} */ - readonly giropay_payments?: "active" | "inactive" | "pending"; + readonly giropay_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the GrabPay payments capability of the account, or whether the account can directly process GrabPay charges. * @enum {string} */ - readonly grabpay_payments?: "active" | "inactive" | "pending"; + readonly grabpay_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the iDEAL payments capability of the account, or whether the account can directly process iDEAL charges. * @enum {string} */ - readonly ideal_payments?: "active" | "inactive" | "pending"; + readonly ideal_payments?: 'active' | 'inactive' | 'pending' /** * @description 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. * @enum {string} */ - readonly jcb_payments?: "active" | "inactive" | "pending"; + readonly jcb_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the Klarna payments capability of the account, or whether the account can directly process Klarna charges. * @enum {string} */ - readonly klarna_payments?: "active" | "inactive" | "pending"; + readonly klarna_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the legacy payments capability of the account. * @enum {string} */ - readonly legacy_payments?: "active" | "inactive" | "pending"; + readonly legacy_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the OXXO payments capability of the account, or whether the account can directly process OXXO charges. * @enum {string} */ - readonly oxxo_payments?: "active" | "inactive" | "pending"; + readonly oxxo_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the P24 payments capability of the account, or whether the account can directly process P24 charges. * @enum {string} */ - readonly p24_payments?: "active" | "inactive" | "pending"; + readonly p24_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the SEPA Direct Debits payments capability of the account, or whether the account can directly process SEPA Direct Debits charges. * @enum {string} */ - readonly sepa_debit_payments?: "active" | "inactive" | "pending"; + readonly sepa_debit_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the Sofort payments capability of the account, or whether the account can directly process Sofort charges. * @enum {string} */ - readonly sofort_payments?: "active" | "inactive" | "pending"; + readonly sofort_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the tax reporting 1099-K (US) capability of the account. * @enum {string} */ - readonly tax_reporting_us_1099_k?: "active" | "inactive" | "pending"; + readonly tax_reporting_us_1099_k?: 'active' | 'inactive' | 'pending' /** * @description The status of the tax reporting 1099-MISC (US) capability of the account. * @enum {string} */ - readonly tax_reporting_us_1099_misc?: "active" | "inactive" | "pending"; + readonly tax_reporting_us_1099_misc?: 'active' | 'inactive' | 'pending' /** * @description The status of the transfers capability of the account, or whether your platform can transfer funds to the account. * @enum {string} */ - readonly transfers?: "active" | "inactive" | "pending"; - }; + readonly transfers?: 'active' | 'inactive' | 'pending' + } /** AccountCapabilityFutureRequirements */ readonly account_capability_future_requirements: { /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ - readonly alternatives?: readonly components["schemas"]["account_requirements_alternative"][] | null; + readonly alternatives?: readonly components['schemas']['account_requirements_alternative'][] | null /** * Format: unix-time * @description Date on which `future_requirements` merges with 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. */ - readonly current_deadline?: number | null; + readonly current_deadline?: number | null /** @description 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. */ - readonly currently_due: readonly string[]; + readonly currently_due: readonly string[] /** @description This is typed as a string for consistency with `requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is empty because fields in `future_requirements` will never disable the account. */ - readonly disabled_reason?: string | null; + readonly disabled_reason?: string | null /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ - readonly errors: readonly components["schemas"]["account_requirements_error"][]; + readonly errors: readonly components['schemas']['account_requirements_error'][] /** @description Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well. */ - readonly eventually_due: readonly string[]; + readonly eventually_due: readonly string[] /** @description 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`. */ - readonly past_due: readonly string[]; + readonly past_due: readonly string[] /** @description Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. */ - readonly pending_verification: readonly string[]; - }; + readonly pending_verification: readonly string[] + } /** AccountCapabilityRequirements */ readonly account_capability_requirements: { /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ - readonly alternatives?: readonly components["schemas"]["account_requirements_alternative"][] | null; + readonly alternatives?: readonly components['schemas']['account_requirements_alternative'][] | null /** * Format: unix-time * @description 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. */ - readonly current_deadline?: number | null; + readonly current_deadline?: number | null /** @description 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. */ - readonly currently_due: readonly string[]; + readonly currently_due: readonly string[] /** * @description If the capability is disabled, this string describes why. Can be `requirements.past_due`, `requirements.pending_verification`, `listed`, `platform_paused`, `rejected.fraud`, `rejected.listed`, `rejected.terms_of_service`, `rejected.other`, `under_review`, or `other`. * @@ -1968,62 +1967,62 @@ export interface components { * * If you believe that the rejection is in error, please contact support at https://support.stripe.com/contact/ for assistance. */ - readonly disabled_reason?: string | null; + readonly disabled_reason?: string | null /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ - readonly errors: readonly components["schemas"]["account_requirements_error"][]; + readonly errors: readonly components['schemas']['account_requirements_error'][] /** @description Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set. */ - readonly eventually_due: readonly string[]; + readonly eventually_due: readonly string[] /** @description Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the capability on the account. */ - readonly past_due: readonly string[]; + readonly past_due: readonly string[] /** @description Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. */ - readonly pending_verification: readonly string[]; - }; + readonly pending_verification: readonly string[] + } /** AccountCardIssuingSettings */ readonly account_card_issuing_settings: { - readonly tos_acceptance?: components["schemas"]["card_issuing_account_terms_of_service"]; - }; + readonly tos_acceptance?: components['schemas']['card_issuing_account_terms_of_service'] + } /** AccountCardPaymentsSettings */ readonly account_card_payments_settings: { - readonly decline_on?: components["schemas"]["account_decline_charge_on"]; + readonly decline_on?: components['schemas']['account_decline_charge_on'] /** @description 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. */ - readonly statement_descriptor_prefix?: string | null; - }; + readonly statement_descriptor_prefix?: string | null + } /** AccountDashboardSettings */ readonly account_dashboard_settings: { /** @description The display name for this account. This is used on the Stripe Dashboard to differentiate between accounts. */ - readonly display_name?: string | null; + readonly display_name?: string | null /** @description 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). */ - readonly timezone?: string | null; - }; + readonly timezone?: string | null + } /** AccountDeclineChargeOn */ readonly account_decline_charge_on: { /** @description 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. */ - readonly avs_failure: boolean; + readonly avs_failure: boolean /** @description Whether Stripe automatically declines charges with an incorrect CVC. This setting only applies when a CVC is provided and it fails bank verification. */ - readonly cvc_failure: boolean; - }; + readonly cvc_failure: boolean + } /** AccountFutureRequirements */ readonly account_future_requirements: { /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ - readonly alternatives?: readonly components["schemas"]["account_requirements_alternative"][] | null; + readonly alternatives?: readonly components['schemas']['account_requirements_alternative'][] | null /** * Format: unix-time * @description Date on which `future_requirements` merges with 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. */ - readonly current_deadline?: number | null; + readonly current_deadline?: number | null /** @description 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. */ - readonly currently_due?: readonly string[] | null; + readonly currently_due?: readonly string[] | null /** @description This is typed as a string for consistency with `requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is empty because fields in `future_requirements` will never disable the account. */ - readonly disabled_reason?: string | null; + readonly disabled_reason?: string | null /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ - readonly errors?: readonly components["schemas"]["account_requirements_error"][] | null; + readonly errors?: readonly components['schemas']['account_requirements_error'][] | null /** @description Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well. */ - readonly eventually_due?: readonly string[] | null; + readonly eventually_due?: readonly string[] | null /** @description 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`. */ - readonly past_due?: readonly string[] | null; + readonly past_due?: readonly string[] | null /** @description Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. */ - readonly pending_verification?: readonly string[] | null; - }; + readonly pending_verification?: readonly string[] | null + } /** * AccountLink * @description Account Links are the means by which a Connect platform grants a connected account permission to access @@ -2036,66 +2035,66 @@ export interface components { * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** * Format: unix-time * @description The timestamp at which this account link will expire. */ - readonly expires_at: number; + readonly expires_at: number /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "account_link"; + readonly object: 'account_link' /** @description The URL for the account link. */ - readonly url: string; - }; + readonly url: string + } /** AccountPaymentsSettings */ readonly account_payments_settings: { /** @description 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. */ - readonly statement_descriptor?: string | null; + readonly statement_descriptor?: string | null /** @description The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only) */ - readonly statement_descriptor_kana?: string | null; + readonly statement_descriptor_kana?: string | null /** @description The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only) */ - readonly statement_descriptor_kanji?: string | null; - }; + readonly statement_descriptor_kanji?: string | null + } /** AccountPayoutSettings */ readonly account_payout_settings: { /** @description A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See our [Understanding Connect Account Balances](https://stripe.com/docs/connect/account-balances) documentation for details. Default value is `false` for Custom accounts, otherwise `true`. */ - readonly debit_negative_balances: boolean; - readonly schedule: components["schemas"]["transfer_schedule"]; + readonly debit_negative_balances: boolean + readonly schedule: components['schemas']['transfer_schedule'] /** @description 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. */ - readonly statement_descriptor?: string | null; - }; + readonly statement_descriptor?: string | null + } /** AccountRequirements */ readonly account_requirements: { /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ - readonly alternatives?: readonly components["schemas"]["account_requirements_alternative"][] | null; + readonly alternatives?: readonly components['schemas']['account_requirements_alternative'][] | null /** * Format: unix-time * @description 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. */ - readonly current_deadline?: number | null; + readonly current_deadline?: number | null /** @description 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. */ - readonly currently_due?: readonly string[] | null; + readonly currently_due?: readonly string[] | null /** @description If the account is disabled, this string describes why. Can be `requirements.past_due`, `requirements.pending_verification`, `listed`, `platform_paused`, `rejected.fraud`, `rejected.listed`, `rejected.terms_of_service`, `rejected.other`, `under_review`, or `other`. */ - readonly disabled_reason?: string | null; + readonly disabled_reason?: string | null /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ - readonly errors?: readonly components["schemas"]["account_requirements_error"][] | null; + readonly errors?: readonly components['schemas']['account_requirements_error'][] | null /** @description Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set. */ - readonly eventually_due?: readonly string[] | null; + readonly eventually_due?: readonly string[] | null /** @description Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the account. */ - readonly past_due?: readonly string[] | null; + readonly past_due?: readonly string[] | null /** @description Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. */ - readonly pending_verification?: readonly string[] | null; - }; + readonly pending_verification?: readonly string[] | null + } /** AccountRequirementsAlternative */ readonly account_requirements_alternative: { /** @description Fields that can be provided to satisfy all fields in `original_fields_due`. */ - readonly alternative_fields_due: readonly string[]; + readonly alternative_fields_due: readonly string[] /** @description Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`. */ - readonly original_fields_due: readonly string[]; - }; + readonly original_fields_due: readonly string[] + } /** AccountRequirementsError */ readonly account_requirements_error: { /** @@ -2103,269 +2102,265 @@ export interface components { * @enum {string} */ readonly code: - | "invalid_address_city_state_postal_code" - | "invalid_street_address" - | "invalid_value_other" - | "verification_document_address_mismatch" - | "verification_document_address_missing" - | "verification_document_corrupt" - | "verification_document_country_not_supported" - | "verification_document_dob_mismatch" - | "verification_document_duplicate_type" - | "verification_document_expired" - | "verification_document_failed_copy" - | "verification_document_failed_greyscale" - | "verification_document_failed_other" - | "verification_document_failed_test_mode" - | "verification_document_fraudulent" - | "verification_document_id_number_mismatch" - | "verification_document_id_number_missing" - | "verification_document_incomplete" - | "verification_document_invalid" - | "verification_document_issue_or_expiry_date_missing" - | "verification_document_manipulated" - | "verification_document_missing_back" - | "verification_document_missing_front" - | "verification_document_name_mismatch" - | "verification_document_name_missing" - | "verification_document_nationality_mismatch" - | "verification_document_not_readable" - | "verification_document_not_signed" - | "verification_document_not_uploaded" - | "verification_document_photo_mismatch" - | "verification_document_too_large" - | "verification_document_type_not_supported" - | "verification_failed_address_match" - | "verification_failed_business_iec_number" - | "verification_failed_document_match" - | "verification_failed_id_number_match" - | "verification_failed_keyed_identity" - | "verification_failed_keyed_match" - | "verification_failed_name_match" - | "verification_failed_other" - | "verification_failed_tax_id_match" - | "verification_failed_tax_id_not_issued" - | "verification_missing_executives" - | "verification_missing_owners" - | "verification_requires_additional_memorandum_of_associations"; + | 'invalid_address_city_state_postal_code' + | 'invalid_street_address' + | 'invalid_value_other' + | 'verification_document_address_mismatch' + | 'verification_document_address_missing' + | 'verification_document_corrupt' + | 'verification_document_country_not_supported' + | 'verification_document_dob_mismatch' + | 'verification_document_duplicate_type' + | 'verification_document_expired' + | 'verification_document_failed_copy' + | 'verification_document_failed_greyscale' + | 'verification_document_failed_other' + | 'verification_document_failed_test_mode' + | 'verification_document_fraudulent' + | 'verification_document_id_number_mismatch' + | 'verification_document_id_number_missing' + | 'verification_document_incomplete' + | 'verification_document_invalid' + | 'verification_document_issue_or_expiry_date_missing' + | 'verification_document_manipulated' + | 'verification_document_missing_back' + | 'verification_document_missing_front' + | 'verification_document_name_mismatch' + | 'verification_document_name_missing' + | 'verification_document_nationality_mismatch' + | 'verification_document_not_readable' + | 'verification_document_not_signed' + | 'verification_document_not_uploaded' + | 'verification_document_photo_mismatch' + | 'verification_document_too_large' + | 'verification_document_type_not_supported' + | 'verification_failed_address_match' + | 'verification_failed_business_iec_number' + | 'verification_failed_document_match' + | 'verification_failed_id_number_match' + | 'verification_failed_keyed_identity' + | 'verification_failed_keyed_match' + | 'verification_failed_name_match' + | 'verification_failed_other' + | 'verification_failed_tax_id_match' + | 'verification_failed_tax_id_not_issued' + | 'verification_missing_executives' + | 'verification_missing_owners' + | 'verification_requires_additional_memorandum_of_associations' /** @description An informative message that indicates the error type and provides additional details about the error. */ - readonly reason: string; + readonly reason: string /** @description The specific user onboarding requirement field (in the requirements hash) that needs to be resolved. */ - readonly requirement: string; - }; + readonly requirement: string + } /** AccountSepaDebitPaymentsSettings */ readonly account_sepa_debit_payments_settings: { /** @description SEPA creditor identifier that identifies the company making the payment. */ - readonly creditor_id?: string; - }; + readonly creditor_id?: string + } /** AccountSettings */ readonly account_settings: { - readonly bacs_debit_payments?: components["schemas"]["account_bacs_debit_payments_settings"]; - readonly branding: components["schemas"]["account_branding_settings"]; - readonly card_issuing?: components["schemas"]["account_card_issuing_settings"]; - readonly card_payments: components["schemas"]["account_card_payments_settings"]; - readonly dashboard: components["schemas"]["account_dashboard_settings"]; - readonly payments: components["schemas"]["account_payments_settings"]; - readonly payouts?: components["schemas"]["account_payout_settings"]; - readonly sepa_debit_payments?: components["schemas"]["account_sepa_debit_payments_settings"]; - }; + readonly bacs_debit_payments?: components['schemas']['account_bacs_debit_payments_settings'] + readonly branding: components['schemas']['account_branding_settings'] + readonly card_issuing?: components['schemas']['account_card_issuing_settings'] + readonly card_payments: components['schemas']['account_card_payments_settings'] + readonly dashboard: components['schemas']['account_dashboard_settings'] + readonly payments: components['schemas']['account_payments_settings'] + readonly payouts?: components['schemas']['account_payout_settings'] + readonly sepa_debit_payments?: components['schemas']['account_sepa_debit_payments_settings'] + } /** AccountTOSAcceptance */ readonly account_tos_acceptance: { /** * Format: unix-time * @description The Unix timestamp marking when the account representative accepted their service agreement */ - readonly date?: number | null; + readonly date?: number | null /** @description The IP address from which the account representative accepted their service agreement */ - readonly ip?: string | null; + readonly ip?: string | null /** @description The user's service agreement type */ - readonly service_agreement?: string; + readonly service_agreement?: string /** @description The user agent of the browser from which the account representative accepted their service agreement */ - readonly user_agent?: string | null; - }; + readonly user_agent?: string | null + } /** AccountUnificationAccountController */ readonly account_unification_account_controller: { /** @description `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. */ - readonly is_controller?: boolean; + readonly is_controller?: boolean /** * @description The controller type. Can be `application`, if a Connect application controls the account, or `account`, if the account controls itself. * @enum {string} */ - readonly type: "account" | "application"; - }; + readonly type: 'account' | 'application' + } /** Address */ readonly address: { /** @description City, district, suburb, town, or village. */ - readonly city?: string | null; + readonly city?: string | null /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ - readonly country?: string | null; + readonly country?: string | null /** @description Address line 1 (e.g., street, PO Box, or company name). */ - readonly line1?: string | null; + readonly line1?: string | null /** @description Address line 2 (e.g., apartment, suite, unit, or building). */ - readonly line2?: string | null; + readonly line2?: string | null /** @description ZIP or postal code. */ - readonly postal_code?: string | null; + readonly postal_code?: string | null /** @description State, county, province, or region. */ - readonly state?: string | null; - }; + readonly state?: string | null + } /** AlipayAccount */ readonly alipay_account: { /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description The ID of the customer associated with this Alipay Account. */ - readonly customer?: - | (Partial & - Partial & - Partial) - | null; + readonly customer?: (Partial & Partial & Partial) | null /** @description Uniquely identifies the account and will be the same across all Alipay account objects that are linked to the same Alipay account. */ - readonly fingerprint: string; + readonly fingerprint: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata?: { readonly [key: string]: string }; + readonly metadata?: { readonly [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "alipay_account"; + readonly object: 'alipay_account' /** @description If the Alipay account object is not reusable, the exact amount that you can create a charge for. */ - readonly payment_amount?: number | null; + readonly payment_amount?: number | null /** @description If the Alipay account object is not reusable, the exact currency that you can create a charge for. */ - readonly payment_currency?: string | null; + readonly payment_currency?: string | null /** @description True if you can create multiple payments using this account. If the account is reusable, then you can freely choose the amount of each payment. */ - readonly reusable: boolean; + readonly reusable: boolean /** @description Whether this Alipay account object has ever been used for a payment. */ - readonly used: boolean; + readonly used: boolean /** @description The username for the Alipay account. */ - readonly username: string; - }; + readonly username: string + } /** APIErrors */ readonly api_errors: { /** @description For card errors, the ID of the failed charge. */ - readonly charge?: string; + readonly charge?: string /** @description For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported. */ - readonly code?: string; + readonly code?: string /** @description 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. */ - readonly decline_code?: string; + readonly decline_code?: string /** @description A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported. */ - readonly doc_url?: string; + readonly doc_url?: string /** @description A human-readable message providing more details about the error. For card errors, these messages can be shown to your users. */ - readonly message?: string; + readonly message?: string /** @description 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. */ - readonly param?: string; - readonly payment_intent?: components["schemas"]["payment_intent"]; - readonly payment_method?: components["schemas"]["payment_method"]; + readonly param?: string + readonly payment_intent?: components['schemas']['payment_intent'] + readonly payment_method?: components['schemas']['payment_method'] /** @description 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. */ - readonly payment_method_type?: string; - readonly setup_intent?: components["schemas"]["setup_intent"]; + readonly payment_method_type?: string + readonly setup_intent?: components['schemas']['setup_intent'] /** @description The source object for errors returned on a request involving a source. */ - readonly source?: Partial & - Partial & - Partial; + readonly source?: Partial & + Partial & + Partial /** * @description The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error` * @enum {string} */ - readonly type: "api_error" | "card_error" | "idempotency_error" | "invalid_request_error"; - }; + readonly type: 'api_error' | 'card_error' | 'idempotency_error' | 'invalid_request_error' + } /** ApplePayDomain */ readonly apple_pay_domain: { /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; - readonly domain_name: string; + readonly created: number + readonly domain_name: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "apple_pay_domain"; - }; + readonly object: 'apple_pay_domain' + } /** Application */ readonly application: { /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description The name of the application. */ - readonly name?: string | null; + readonly name?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "application"; - }; + readonly object: 'application' + } /** PlatformFee */ readonly application_fee: { /** @description ID of the Stripe account this fee was taken from. */ - readonly account: Partial & Partial; + readonly account: Partial & Partial /** @description Amount earned, in %s. */ - readonly amount: number; + readonly amount: number /** @description Amount in %s refunded (can be less than the amount attribute on the fee if a partial refund was issued) */ - readonly amount_refunded: number; + readonly amount_refunded: number /** @description ID of the Connect application that earned the fee. */ - readonly application: Partial & Partial; + readonly application: Partial & Partial /** @description Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds). */ - readonly balance_transaction?: (Partial & Partial) | null; + readonly balance_transaction?: (Partial & Partial) | null /** @description ID of the charge that the application fee was taken from. */ - readonly charge: Partial & Partial; + readonly charge: Partial & Partial /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "application_fee"; + readonly object: 'application_fee' /** @description ID of the corresponding charge on the platform account, if this fee was the result of a charge using the `destination` parameter. */ - readonly originating_transaction?: (Partial & Partial) | null; + readonly originating_transaction?: (Partial & Partial) | null /** @description Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false. */ - readonly refunded: boolean; + readonly refunded: boolean /** * FeeRefundList * @description A list of refunds that have been applied to the fee. */ readonly refunds: { /** @description Details about each object. */ - readonly data: readonly components["schemas"]["fee_refund"][]; + readonly data: readonly components['schemas']['fee_refund'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** AutomaticTax */ readonly automatic_tax: { /** @description Whether Stripe automatically computes tax on this invoice. */ - readonly enabled: boolean; + readonly enabled: boolean /** * @description The status of the most recent automated tax calculation for this invoice. * @enum {string|null} */ - readonly status?: ("complete" | "failed" | "requires_location_inputs") | null; - }; + readonly status?: ('complete' | 'failed' | 'requires_location_inputs') | null + } /** * Balance * @description This is an object representing your Stripe balance. You can retrieve it to see @@ -2382,44 +2377,44 @@ export interface components { */ readonly balance: { /** @description Funds that are available to be transferred or paid out, whether automatically by Stripe or explicitly via the [Transfers API](https://stripe.com/docs/api#transfers) or [Payouts API](https://stripe.com/docs/api#payouts). The available balance for each currency and payment type can be found in the `source_types` property. */ - readonly available: readonly components["schemas"]["balance_amount"][]; + readonly available: readonly components['schemas']['balance_amount'][] /** @description Funds held due to negative balances on connected Custom accounts. The connect reserve balance for each currency and payment type can be found in the `source_types` property. */ - readonly connect_reserved?: readonly components["schemas"]["balance_amount"][]; + readonly connect_reserved?: readonly components['schemas']['balance_amount'][] /** @description Funds that can be paid out using Instant Payouts. */ - readonly instant_available?: readonly components["schemas"]["balance_amount"][]; - readonly issuing?: components["schemas"]["balance_detail"]; + readonly instant_available?: readonly components['schemas']['balance_amount'][] + readonly issuing?: components['schemas']['balance_detail'] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "balance"; + readonly object: 'balance' /** @description Funds that are not yet available in the balance, due to the 7-day rolling pay cycle. The pending balance for each currency, and for each payment type, can be found in the `source_types` property. */ - readonly pending: readonly components["schemas"]["balance_amount"][]; - }; + readonly pending: readonly components['schemas']['balance_amount'][] + } /** BalanceAmount */ readonly balance_amount: { /** @description Balance amount. */ - readonly amount: number; + readonly amount: number /** @description 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). */ - readonly currency: string; - readonly source_types?: components["schemas"]["balance_amount_by_source_type"]; - }; + readonly currency: string + readonly source_types?: components['schemas']['balance_amount_by_source_type'] + } /** BalanceAmountBySourceType */ readonly balance_amount_by_source_type: { /** @description Amount for bank account. */ - readonly bank_account?: number; + readonly bank_account?: number /** @description Amount for card. */ - readonly card?: number; + readonly card?: number /** @description Amount for FPX. */ - readonly fpx?: number; - }; + readonly fpx?: number + } /** BalanceDetail */ readonly balance_detail: { /** @description Funds that are available for use. */ - readonly available: readonly components["schemas"]["balance_amount"][]; - }; + readonly available: readonly components['schemas']['balance_amount'][] + } /** * BalanceTransaction * @description Balance transactions represent funds moving through your Stripe account. @@ -2429,98 +2424,98 @@ export interface components { */ readonly balance_transaction: { /** @description Gross amount of the transaction, in %s. */ - readonly amount: number; + readonly amount: number /** * Format: unix-time * @description The date the transaction's net funds will become available in the Stripe balance. */ - readonly available_on: number; + readonly available_on: number /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string | null; + readonly description?: string | null /** @description The exchange rate used, if applicable, for this transaction. Specifically, if money was converted from currency A to currency B, then the `amount` in currency A, times `exchange_rate`, would be the `amount` in currency B. For example, suppose you charged a customer 10.00 EUR. Then the PaymentIntent's `amount` would be `1000` and `currency` would be `eur`. Suppose this was converted into 12.34 USD in your Stripe account. Then the BalanceTransaction's `amount` would be `1234`, `currency` would be `usd`, and `exchange_rate` would be `1.234`. */ - readonly exchange_rate?: number | null; + readonly exchange_rate?: number | null /** @description Fees (in %s) paid for this transaction. */ - readonly fee: number; + readonly fee: number /** @description Detailed breakdown of fees (in %s) paid for this transaction. */ - readonly fee_details: readonly components["schemas"]["fee"][]; + readonly fee_details: readonly components['schemas']['fee'][] /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Net amount of the transaction, in %s. */ - readonly net: number; + readonly net: number /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "balance_transaction"; + readonly object: 'balance_transaction' /** @description [Learn more](https://stripe.com/docs/reports/reporting-categories) about how reporting categories can help you understand balance transactions from an accounting perspective. */ - readonly reporting_category: string; + readonly reporting_category: string /** @description The Stripe object to which this transaction is related. */ readonly source?: | (Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial) - | null; + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial) + | null /** @description If the transaction's net funds are available in the Stripe balance yet. Either `available` or `pending`. */ - readonly status: string; + readonly status: string /** * @description Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `payment`, `payment_failure_refund`, `payment_refund`, `payout`, `payout_cancel`, `payout_failure`, `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](https://stripe.com/docs/reports/balance-transaction-types) about balance transaction types and what they represent. If you are looking to classify transactions for accounting purposes, you might want to consider `reporting_category` instead. * @enum {string} */ readonly type: - | "adjustment" - | "advance" - | "advance_funding" - | "anticipation_repayment" - | "application_fee" - | "application_fee_refund" - | "charge" - | "connect_collection_transfer" - | "contribution" - | "issuing_authorization_hold" - | "issuing_authorization_release" - | "issuing_dispute" - | "issuing_transaction" - | "payment" - | "payment_failure_refund" - | "payment_refund" - | "payout" - | "payout_cancel" - | "payout_failure" - | "refund" - | "refund_failure" - | "reserve_transaction" - | "reserved_funds" - | "stripe_fee" - | "stripe_fx_fee" - | "tax_fee" - | "topup" - | "topup_reversal" - | "transfer" - | "transfer_cancel" - | "transfer_failure" - | "transfer_refund"; - }; + | 'adjustment' + | 'advance' + | 'advance_funding' + | 'anticipation_repayment' + | 'application_fee' + | 'application_fee_refund' + | 'charge' + | 'connect_collection_transfer' + | 'contribution' + | 'issuing_authorization_hold' + | 'issuing_authorization_release' + | 'issuing_dispute' + | 'issuing_transaction' + | 'payment' + | 'payment_failure_refund' + | 'payment_refund' + | 'payout' + | 'payout_cancel' + | 'payout_failure' + | 'refund' + | 'refund_failure' + | 'reserve_transaction' + | 'reserved_funds' + | 'stripe_fee' + | 'stripe_fx_fee' + | 'tax_fee' + | 'topup' + | 'topup_reversal' + | 'transfer' + | 'transfer_cancel' + | 'transfer_failure' + | 'transfer_refund' + } /** * BankAccount * @description These bank accounts are payment methods on `Customer` objects. @@ -2533,99 +2528,95 @@ export interface components { */ readonly bank_account: { /** @description The ID of the account that the bank account is associated with. */ - readonly account?: (Partial & Partial) | null; + readonly account?: (Partial & Partial) | null /** @description The name of the person or business that owns the bank account. */ - readonly account_holder_name?: string | null; + readonly account_holder_name?: string | null /** @description The type of entity that holds the account. This can be either `individual` or `company`. */ - readonly account_holder_type?: string | null; + readonly account_holder_type?: string | null /** @description The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`. */ - readonly account_type?: string | null; + readonly account_type?: string | null /** @description 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. */ - readonly available_payout_methods?: readonly ("instant" | "standard")[] | null; + readonly available_payout_methods?: readonly ('instant' | 'standard')[] | null /** @description Name of the bank associated with the routing number (e.g., `WELLS FARGO`). */ - readonly bank_name?: string | null; + readonly bank_name?: string | null /** @description Two-letter ISO code representing the country the bank account is located in. */ - readonly country: string; + readonly country: string /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. */ - readonly currency: string; + readonly currency: string /** @description The ID of the customer that the bank account is associated with. */ - readonly customer?: - | (Partial & - Partial & - Partial) - | null; + readonly customer?: (Partial & Partial & Partial) | null /** @description Whether this bank account is the default external account for its currency. */ - readonly default_for_currency?: boolean | null; + readonly default_for_currency?: boolean | null /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - readonly fingerprint?: string | null; + readonly fingerprint?: string | null /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description The last four digits of the bank account number. */ - readonly last4: string; + readonly last4: string /** @description 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. */ - readonly metadata?: { readonly [key: string]: string } | null; + readonly metadata?: { readonly [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "bank_account"; + readonly object: 'bank_account' /** @description The routing transit number for the bank account. */ - readonly routing_number?: string | null; + readonly routing_number?: string | null /** * @description For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a transfer sent to this bank account fails, we'll set the status to `errored` and will not continue to send transfers until the bank details are updated. * * For external accounts, possible values are `new` and `errored`. Validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply. If a transfer fails, the status is set to `errored` and transfers are stopped until account details are updated. */ - readonly status: string; - }; + readonly status: string + } /** billing_details */ readonly billing_details: { /** @description Billing address. */ - readonly address?: Partial | null; + readonly address?: Partial | null /** @description Email address. */ - readonly email?: string | null; + readonly email?: string | null /** @description Full name. */ - readonly name?: string | null; + readonly name?: string | null /** @description Billing phone number (including extension). */ - readonly phone?: string | null; - }; + readonly phone?: string | null + } /** * PortalConfiguration * @description A portal configuration describes the functionality and behavior of a portal session. */ - readonly "billing_portal.configuration": { + readonly 'billing_portal.configuration': { /** @description Whether the configuration is active and can be used to create portal sessions. */ - readonly active: boolean; + readonly active: boolean /** @description ID of the Connect Application that created the configuration. */ - readonly application?: string | null; - readonly business_profile: components["schemas"]["portal_business_profile"]; + readonly application?: string | null + readonly business_profile: components['schemas']['portal_business_profile'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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. */ - readonly default_return_url?: string | null; - readonly features: components["schemas"]["portal_features"]; + readonly default_return_url?: string | null + readonly features: components['schemas']['portal_features'] /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description 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. */ - readonly is_default: boolean; + readonly is_default: boolean /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata?: { readonly [key: string]: string } | null; + readonly metadata?: { readonly [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "billing_portal.configuration"; + readonly object: 'billing_portal.configuration' /** * Format: unix-time * @description Time at which the object was last updated. Measured in seconds since the Unix epoch. */ - readonly updated: number; - }; + readonly updated: number + } /** * PortalSession * @description The Billing customer portal is a Stripe-hosted UI for subscription and @@ -2643,178 +2634,178 @@ export interface components { * * Learn more in the [integration guide](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal). */ - readonly "billing_portal.session": { + readonly 'billing_portal.session': { /** @description The configuration used by this session, describing the features available. */ - readonly configuration: Partial & Partial; + readonly configuration: Partial & Partial /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description The ID of the customer for this session. */ - readonly customer: string; + readonly customer: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description 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. * @enum {string|null} */ readonly locale?: | ( - | "auto" - | "bg" - | "cs" - | "da" - | "de" - | "el" - | "en" - | "en-AU" - | "en-CA" - | "en-GB" - | "en-IE" - | "en-IN" - | "en-NZ" - | "en-SG" - | "es" - | "es-419" - | "et" - | "fi" - | "fil" - | "fr" - | "fr-CA" - | "hr" - | "hu" - | "id" - | "it" - | "ja" - | "ko" - | "lt" - | "lv" - | "ms" - | "mt" - | "nb" - | "nl" - | "pl" - | "pt" - | "pt-BR" - | "ro" - | "ru" - | "sk" - | "sl" - | "sv" - | "th" - | "tr" - | "vi" - | "zh" - | "zh-HK" - | "zh-TW" + | 'auto' + | 'bg' + | 'cs' + | 'da' + | 'de' + | 'el' + | 'en' + | 'en-AU' + | 'en-CA' + | 'en-GB' + | 'en-IE' + | 'en-IN' + | 'en-NZ' + | 'en-SG' + | 'es' + | 'es-419' + | 'et' + | 'fi' + | 'fil' + | 'fr' + | 'fr-CA' + | 'hr' + | 'hu' + | 'id' + | 'it' + | 'ja' + | 'ko' + | 'lt' + | 'lv' + | 'ms' + | 'mt' + | 'nb' + | 'nl' + | 'pl' + | 'pt' + | 'pt-BR' + | 'ro' + | 'ru' + | 'sk' + | 'sl' + | 'sv' + | 'th' + | 'tr' + | 'vi' + | 'zh' + | 'zh-HK' + | 'zh-TW' ) - | null; + | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "billing_portal.session"; + readonly object: 'billing_portal.session' /** @description 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/charges-transfers#on-behalf-of). 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. */ - readonly on_behalf_of?: string | null; + readonly on_behalf_of?: string | null /** @description The URL to redirect customers to when they click on the portal's link to return to your website. */ - readonly return_url: string; + readonly return_url: string /** @description The short-lived URL of the session that gives customers access to the customer portal. */ - readonly url: string; - }; + readonly url: string + } /** BitcoinReceiver */ readonly bitcoin_receiver: { /** @description True when this bitcoin receiver has received a non-zero amount of bitcoin. */ - readonly active: boolean; + readonly active: boolean /** @description The amount of `currency` that you are collecting as payment. */ - readonly amount: number; + readonly amount: number /** @description The amount of `currency` to which `bitcoin_amount_received` has been converted. */ - readonly amount_received: number; + readonly amount_received: number /** @description The amount of bitcoin that the customer should send to fill the receiver. The `bitcoin_amount` is denominated in Satoshi: there are 10^8 Satoshi in one bitcoin. */ - readonly bitcoin_amount: number; + readonly bitcoin_amount: number /** @description The amount of bitcoin that has been sent by the customer to this receiver. */ - readonly bitcoin_amount_received: number; + readonly bitcoin_amount_received: number /** @description This URI can be displayed to the customer as a clickable link (to activate their bitcoin client) or as a QR code (for mobile wallets). */ - readonly bitcoin_uri: string; + readonly bitcoin_uri: string /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) to which the bitcoin will be converted. */ - readonly currency: string; + readonly currency: string /** @description The customer ID of the bitcoin receiver. */ - readonly customer?: string | null; + readonly customer?: string | null /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string | null; + readonly description?: string | null /** @description The customer's email address, set by the API call that creates the receiver. */ - readonly email?: string | null; + readonly email?: string | null /** @description This flag is initially false and updates to true when the customer sends the `bitcoin_amount` to this receiver. */ - readonly filled: boolean; + readonly filled: boolean /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description A bitcoin address that is specific to this receiver. The customer can send bitcoin to this address to fill the receiver. */ - readonly inbound_address: string; + readonly inbound_address: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata?: { readonly [key: string]: string } | null; + readonly metadata?: { readonly [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "bitcoin_receiver"; + readonly object: 'bitcoin_receiver' /** @description The ID of the payment created from the receiver, if any. Hidden when viewing the receiver with a publishable key. */ - readonly payment?: string | null; + readonly payment?: string | null /** @description The refund address of this bitcoin receiver. */ - readonly refund_address?: string | null; + readonly refund_address?: string | null /** * BitcoinTransactionList * @description A list with one entry for each time that the customer sent bitcoin to the receiver. Hidden when viewing the receiver with a publishable key. */ readonly transactions?: { /** @description Details about each object. */ - readonly data: readonly components["schemas"]["bitcoin_transaction"][]; + readonly data: readonly components['schemas']['bitcoin_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; + readonly url: string + } /** @description This receiver contains uncaptured funds that can be used for a payment or refunded. */ - readonly uncaptured_funds: boolean; + readonly uncaptured_funds: boolean /** @description Indicate if this source is used for payment. */ - readonly used_for_payment?: boolean | null; - }; + readonly used_for_payment?: boolean | null + } /** BitcoinTransaction */ readonly bitcoin_transaction: { /** @description The amount of `currency` that the transaction was converted to in real-time. */ - readonly amount: number; + readonly amount: number /** @description The amount of bitcoin contained in the transaction. */ - readonly bitcoin_amount: number; + readonly bitcoin_amount: number /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) to which this transaction was converted. */ - readonly currency: string; + readonly currency: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "bitcoin_transaction"; + readonly object: 'bitcoin_transaction' /** @description The receiver to which this transaction was sent. */ - readonly receiver: string; - }; + readonly receiver: string + } /** * AccountCapability * @description This is an object representing a capability for a Stripe account. @@ -2823,29 +2814,29 @@ export interface components { */ readonly capability: { /** @description The account for which the capability enables functionality. */ - readonly account: Partial & Partial; - readonly future_requirements?: components["schemas"]["account_capability_future_requirements"]; + readonly account: Partial & Partial + readonly future_requirements?: components['schemas']['account_capability_future_requirements'] /** @description The identifier for the capability. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "capability"; + readonly object: 'capability' /** @description Whether the capability has been requested. */ - readonly requested: boolean; + readonly requested: boolean /** * Format: unix-time * @description Time at which the capability was requested. Measured in seconds since the Unix epoch. */ - readonly requested_at?: number | null; - readonly requirements?: components["schemas"]["account_capability_requirements"]; + readonly requested_at?: number | null + readonly requirements?: components['schemas']['account_capability_requirements'] /** * @description The status of the capability. Can be `active`, `inactive`, `pending`, or `unrequested`. * @enum {string} */ - readonly status: "active" | "disabled" | "inactive" | "pending" | "unrequested"; - }; + readonly status: 'active' | 'disabled' | 'inactive' | 'pending' | 'unrequested' + } /** * Card * @description You can store multiple cards on a customer in order to charge the customer @@ -2856,90 +2847,86 @@ export interface components { */ readonly card: { /** @description 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. */ - readonly account?: (Partial & Partial) | null; + readonly account?: (Partial & Partial) | null /** @description City/District/Suburb/Town/Village. */ - readonly address_city?: string | null; + readonly address_city?: string | null /** @description Billing address country, if provided when creating card. */ - readonly address_country?: string | null; + readonly address_country?: string | null /** @description Address line 1 (Street address/PO Box/Company name). */ - readonly address_line1?: string | null; + readonly address_line1?: string | null /** @description If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. */ - readonly address_line1_check?: string | null; + readonly address_line1_check?: string | null /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - readonly address_line2?: string | null; + readonly address_line2?: string | null /** @description State/County/Province/Region. */ - readonly address_state?: string | null; + readonly address_state?: string | null /** @description ZIP or postal code. */ - readonly address_zip?: string | null; + readonly address_zip?: string | null /** @description If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. */ - readonly address_zip_check?: string | null; + readonly address_zip_check?: string | null /** @description A set of available payout methods for this card. Only values from this set should be passed as the `method` when creating a payout. */ - readonly available_payout_methods?: readonly ("instant" | "standard")[] | null; + readonly available_payout_methods?: readonly ('instant' | 'standard')[] | null /** @description Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`. */ - readonly brand: string; + readonly brand: string /** @description 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. */ - readonly country?: string | null; + readonly country?: string | null /** @description Three-letter [ISO code for currency](https://stripe.com/docs/payouts). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. */ - readonly currency?: string | null; + readonly currency?: string | null /** @description 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. */ - readonly customer?: - | (Partial & - Partial & - Partial) - | null; + readonly customer?: (Partial & Partial & Partial) | null /** @description 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). */ - readonly cvc_check?: string | null; + readonly cvc_check?: string | null /** @description Whether this card is the default external account for its currency. */ - readonly default_for_currency?: boolean | null; + readonly default_for_currency?: boolean | null /** @description (For tokenized numbers only.) The last four digits of the device account number. */ - readonly dynamic_last4?: string | null; + readonly dynamic_last4?: string | null /** @description Two-digit number representing the card's expiration month. */ - readonly exp_month: number; + readonly exp_month: number /** @description Four-digit number representing the card's expiration year. */ - readonly exp_year: number; + readonly exp_year: number /** * @description 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. * * *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.* */ - readonly fingerprint?: string | null; + readonly fingerprint?: string | null /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ - readonly funding: string; + readonly funding: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description The last four digits of the card. */ - readonly last4: string; + readonly last4: string /** @description 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. */ - readonly metadata?: { readonly [key: string]: string } | null; + readonly metadata?: { readonly [key: string]: string } | null /** @description Cardholder name. */ - readonly name?: string | null; + readonly name?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "card"; + readonly object: 'card' /** @description The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead. */ - readonly recipient?: (Partial & Partial) | null; + readonly recipient?: (Partial & Partial) | null /** @description 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. */ - readonly tokenization_method?: string | null; - }; + readonly tokenization_method?: string | null + } /** card_generated_from_payment_method_details */ readonly card_generated_from_payment_method_details: { - readonly card_present?: components["schemas"]["payment_method_details_card_present"]; + readonly card_present?: components['schemas']['payment_method_details_card_present'] /** @description The type of payment method transaction-specific details from the transaction that generated this `card` payment method. Always `card_present`. */ - readonly type: string; - }; + readonly type: string + } /** CardIssuingAccountTermsOfService */ readonly card_issuing_account_terms_of_service: { /** @description The Unix timestamp marking when the account representative accepted the service agreement. */ - readonly date?: number | null; + readonly date?: number | null /** @description The IP address from which the account representative accepted the service agreement. */ - readonly ip?: string | null; + readonly ip?: string | null /** @description The user agent of the browser from which the account representative accepted the service agreement. */ - readonly user_agent?: string; - }; + readonly user_agent?: string + } /** card_mandate_payment_method_details */ - readonly card_mandate_payment_method_details: { readonly [key: string]: unknown }; + readonly card_mandate_payment_method_details: { readonly [key: string]: unknown } /** * Charge * @description To charge a credit or a debit card, you create a `Charge` object. You can @@ -2950,152 +2937,148 @@ export interface components { */ readonly charge: { /** @description 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). */ - readonly amount: number; + readonly amount: number /** @description Amount in %s captured (can be less than the amount attribute on the charge if a partial capture was made). */ - readonly amount_captured: number; + readonly amount_captured: number /** @description Amount in %s refunded (can be less than the amount attribute on the charge if a partial refund was issued). */ - readonly amount_refunded: number; + readonly amount_refunded: number /** @description ID of the Connect application that created the charge. */ - readonly application?: (Partial & Partial) | null; + readonly application?: (Partial & Partial) | null /** @description The application fee (if any) for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees) for details. */ - readonly application_fee?: (Partial & Partial) | null; + readonly application_fee?: (Partial & Partial) | null /** @description The amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees) for details. */ - readonly application_fee_amount?: number | null; + readonly application_fee_amount?: number | null /** @description ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes). */ - readonly balance_transaction?: (Partial & Partial) | null; - readonly billing_details: components["schemas"]["billing_details"]; + readonly balance_transaction?: (Partial & Partial) | null + readonly billing_details: components['schemas']['billing_details'] /** @description 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. */ - readonly calculated_statement_descriptor?: string | null; + readonly calculated_statement_descriptor?: string | null /** @description If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured. */ - readonly captured: boolean; + readonly captured: boolean /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description ID of the customer this charge is for if one exists. */ - readonly customer?: - | (Partial & - Partial & - Partial) - | null; + readonly customer?: (Partial & Partial & Partial) | null /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string | null; + readonly description?: string | null /** @description Whether the charge has been disputed. */ - readonly disputed: boolean; + readonly disputed: boolean /** @description Error code explaining reason for charge failure if available (see [the errors section](https://stripe.com/docs/api#errors) for a list of codes). */ - readonly failure_code?: string | null; + readonly failure_code?: string | null /** @description Message to user further explaining reason for charge failure if available. */ - readonly failure_message?: string | null; + readonly failure_message?: string | null /** @description Information on fraud assessments for the charge. */ - readonly fraud_details?: Partial | null; + readonly fraud_details?: Partial | null /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description ID of the invoice this charge is for if one exists. */ - readonly invoice?: (Partial & Partial) | null; + readonly invoice?: (Partial & Partial) | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata: { readonly [key: string]: string }; + readonly metadata: { readonly [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "charge"; + readonly object: 'charge' /** @description 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/charges-transfers) for details. */ - readonly on_behalf_of?: (Partial & Partial) | null; + readonly on_behalf_of?: (Partial & Partial) | null /** @description ID of the order this charge is for if one exists. */ - readonly order?: (Partial & Partial) | null; + readonly order?: (Partial & Partial) | null /** @description Details about whether the payment was accepted, and why. See [understanding declines](https://stripe.com/docs/declines) for details. */ - readonly outcome?: Partial | null; + readonly outcome?: Partial | null /** @description `true` if the charge succeeded, or was successfully authorized for later capture. */ - readonly paid: boolean; + readonly paid: boolean /** @description ID of the PaymentIntent associated with this charge, if one exists. */ - readonly payment_intent?: (Partial & Partial) | null; + readonly payment_intent?: (Partial & Partial) | null /** @description ID of the payment method used in this charge. */ - readonly payment_method?: string | null; + readonly payment_method?: string | null /** @description Details about the payment method at the time of the transaction. */ - readonly payment_method_details?: Partial | null; + readonly payment_method_details?: Partial | null /** @description This is the email address that the receipt for this charge was sent to. */ - readonly receipt_email?: string | null; + readonly receipt_email?: string | null /** @description 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. */ - readonly receipt_number?: string | null; + readonly receipt_number?: string | null /** @description 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. */ - readonly receipt_url?: string | null; + readonly receipt_url?: string | null /** @description Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false. */ - readonly refunded: boolean; + readonly refunded: boolean /** * RefundList * @description A list of refunds that have been applied to the charge. */ readonly refunds: { /** @description Details about each object. */ - readonly data: readonly components["schemas"]["refund"][]; + readonly data: readonly components['schemas']['refund'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; + readonly url: string + } /** @description ID of the review associated with this charge if one exists. */ - readonly review?: (Partial & Partial) | null; + readonly review?: (Partial & Partial) | null /** @description Shipping information for the charge. */ - readonly shipping?: Partial | null; + readonly shipping?: Partial | null /** @description The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details. */ - readonly source_transfer?: (Partial & Partial) | null; + readonly source_transfer?: (Partial & Partial) | null /** @description For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - readonly statement_descriptor?: string | null; + readonly statement_descriptor?: string | null /** @description Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - readonly statement_descriptor_suffix?: string | null; + readonly statement_descriptor_suffix?: string | null /** * @description The status of the payment is either `succeeded`, `pending`, or `failed`. * @enum {string} */ - readonly status: "failed" | "pending" | "succeeded"; + readonly status: 'failed' | 'pending' | 'succeeded' /** @description ID of the transfer to the `destination` account (only applicable if the charge was created using the `destination` parameter). */ - readonly transfer?: Partial & Partial; + readonly transfer?: Partial & Partial /** @description 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. */ - readonly transfer_data?: Partial | null; + readonly transfer_data?: Partial | null /** @description A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-options) for details. */ - readonly transfer_group?: string | null; - }; + readonly transfer_group?: string | null + } /** ChargeFraudDetails */ readonly charge_fraud_details: { /** @description Assessments from Stripe. If set, the value is `fraudulent`. */ - readonly stripe_report?: string; + readonly stripe_report?: string /** @description Assessments reported by you. If set, possible values of are `safe` and `fraudulent`. */ - readonly user_report?: string; - }; + readonly user_report?: string + } /** ChargeOutcome */ readonly charge_outcome: { /** @description 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. */ - readonly network_status?: string | null; + readonly network_status?: string | null /** @description 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. */ - readonly reason?: string | null; + readonly reason?: string | null /** @description 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. */ - readonly risk_level?: string; + readonly risk_level?: string /** @description 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. */ - readonly risk_score?: number; + readonly risk_score?: number /** @description The ID of the Radar rule that matched the payment, if applicable. */ - readonly rule?: Partial & Partial; + readonly rule?: Partial & Partial /** @description A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer. */ - readonly seller_message?: string | null; + readonly seller_message?: string | null /** @description 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. */ - readonly type: string; - }; + readonly type: string + } /** ChargeTransferData */ readonly charge_transfer_data: { /** @description The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account. */ - readonly amount?: number | null; + readonly amount?: number | null /** @description ID of an existing, connected Stripe account to transfer funds to if `transfer_data` was specified in the charge request. */ - readonly destination: Partial & Partial; - }; + readonly destination: Partial & Partial + } /** * Session * @description A Checkout Session represents your customer's session as they pay for @@ -3113,39 +3096,35 @@ export interface components { * * Related guide: [Checkout Server Quickstart](https://stripe.com/docs/payments/checkout/api). */ - readonly "checkout.session": { + readonly 'checkout.session': { /** @description When set, provides configuration for actions to take if this Checkout Session expires. */ - readonly after_expiration?: Partial< - components["schemas"]["payment_pages_checkout_session_after_expiration"] - > | null; + readonly after_expiration?: Partial | null /** @description Enables user redeemable promotion codes. */ - readonly allow_promotion_codes?: boolean | null; + readonly allow_promotion_codes?: boolean | null /** @description Total of all items before discounts or taxes are applied. */ - readonly amount_subtotal?: number | null; + readonly amount_subtotal?: number | null /** @description Total of all items after discounts and taxes are applied. */ - readonly amount_total?: number | null; - readonly automatic_tax: components["schemas"]["payment_pages_checkout_session_automatic_tax"]; + readonly amount_total?: number | null + readonly automatic_tax: components['schemas']['payment_pages_checkout_session_automatic_tax'] /** * @description Describes whether Checkout should collect the customer's billing address. * @enum {string|null} */ - readonly billing_address_collection?: ("auto" | "required") | null; + readonly billing_address_collection?: ('auto' | 'required') | null /** @description The URL the customer will be directed to if they decide to cancel payment and return to your website. */ - readonly cancel_url: string; + readonly cancel_url: string /** * @description A unique string to reference the Checkout Session. This can be a * customer ID, a cart ID, or similar, and can be used to reconcile the * Session with your internal systems. */ - readonly client_reference_id?: string | null; + readonly client_reference_id?: string | null /** @description Results of `consent_collection` for this session. */ - readonly consent?: Partial | null; + readonly consent?: Partial | null /** @description When set, provides configuration for the Checkout Session to gather active consent from customers. */ - readonly consent_collection?: Partial< - components["schemas"]["payment_pages_checkout_session_consent_collection"] - > | null; + readonly consent_collection?: Partial | null /** @description 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). */ - readonly currency?: string | null; + readonly currency?: string | null /** * @description The ID of the customer for this Session. * For Checkout Sessions in `payment` or `subscription` mode, Checkout @@ -3153,20 +3132,14 @@ export interface components { * during the payment flow unless an existing customer was provided when * the Session was created. */ - readonly customer?: - | (Partial & - Partial & - Partial) - | null; + readonly customer?: (Partial & Partial & Partial) | null /** * @description Configure whether a Checkout Session creates a Customer when the Checkout Session completes. * @enum {string|null} */ - readonly customer_creation?: ("always" | "if_required") | null; + readonly customer_creation?: ('always' | 'if_required') | null /** @description The customer details including the customer's tax exempt status and the customer's tax IDs. Only present on Sessions in `payment` or `subscription` mode. */ - readonly customer_details?: Partial< - components["schemas"]["payment_pages_checkout_session_customer_details"] - > | null; + readonly customer_details?: Partial | null /** * @description 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. @@ -3174,136 +3147,132 @@ export interface components { * on file. To access information about the customer once the payment flow is * complete, use the `customer` attribute. */ - readonly customer_email?: string | null; + readonly customer_email?: string | null /** * Format: unix-time * @description The timestamp at which the Checkout Session will expire. */ - readonly expires_at: number; + readonly expires_at: number /** * @description Unique identifier for the object. Used to pass to `redirectToCheckout` * in Stripe.js. */ - readonly id: string; + readonly id: string /** * PaymentPagesCheckoutSessionListLineItems * @description The line items purchased by the customer. */ readonly line_items?: { /** @description Details about each object. */ - readonly data: readonly components["schemas"]["item"][]; + readonly data: readonly components['schemas']['item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; + readonly url: string + } /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used. * @enum {string|null} */ readonly locale?: | ( - | "auto" - | "bg" - | "cs" - | "da" - | "de" - | "el" - | "en" - | "en-GB" - | "es" - | "es-419" - | "et" - | "fi" - | "fil" - | "fr" - | "fr-CA" - | "hr" - | "hu" - | "id" - | "it" - | "ja" - | "ko" - | "lt" - | "lv" - | "ms" - | "mt" - | "nb" - | "nl" - | "pl" - | "pt" - | "pt-BR" - | "ro" - | "ru" - | "sk" - | "sl" - | "sv" - | "th" - | "tr" - | "vi" - | "zh" - | "zh-HK" - | "zh-TW" + | 'auto' + | 'bg' + | 'cs' + | 'da' + | 'de' + | 'el' + | 'en' + | 'en-GB' + | 'es' + | 'es-419' + | 'et' + | 'fi' + | 'fil' + | 'fr' + | 'fr-CA' + | 'hr' + | 'hu' + | 'id' + | 'it' + | 'ja' + | 'ko' + | 'lt' + | 'lv' + | 'ms' + | 'mt' + | 'nb' + | 'nl' + | 'pl' + | 'pt' + | 'pt-BR' + | 'ro' + | 'ru' + | 'sk' + | 'sl' + | 'sv' + | 'th' + | 'tr' + | 'vi' + | 'zh' + | 'zh-HK' + | 'zh-TW' ) - | null; + | null /** @description 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. */ - readonly metadata?: { readonly [key: string]: string } | null; + readonly metadata?: { readonly [key: string]: string } | null /** * @description The mode of the Checkout Session. * @enum {string} */ - readonly mode: "payment" | "setup" | "subscription"; + readonly mode: 'payment' | 'setup' | 'subscription' /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "checkout.session"; + readonly object: 'checkout.session' /** @description The ID of the PaymentIntent for Checkout Sessions in `payment` mode. */ - readonly payment_intent?: (Partial & Partial) | null; + readonly payment_intent?: (Partial & Partial) | null /** @description The ID of the Payment Link that created this Session. */ - readonly payment_link?: (Partial & Partial) | null; + readonly payment_link?: (Partial & Partial) | null /** @description Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession. */ - readonly payment_method_options?: Partial< - components["schemas"]["checkout_session_payment_method_options"] - > | null; + readonly payment_method_options?: Partial | null /** * @description A list of the types of payment methods (e.g. card) this Checkout * Session is allowed to accept. */ - readonly payment_method_types: readonly string[]; + readonly payment_method_types: readonly string[] /** * @description The payment status of the Checkout Session, one of `paid`, `unpaid`, or `no_payment_required`. * You can use this value to decide when to fulfill your customer's order. * @enum {string} */ - readonly payment_status: "no_payment_required" | "paid" | "unpaid"; - readonly phone_number_collection?: components["schemas"]["payment_pages_checkout_session_phone_number_collection"]; + readonly payment_status: 'no_payment_required' | 'paid' | 'unpaid' + readonly phone_number_collection?: components['schemas']['payment_pages_checkout_session_phone_number_collection'] /** @description The ID of the original expired Checkout Session that triggered the recovery flow. */ - readonly recovered_from?: string | null; + readonly recovered_from?: string | null /** @description The ID of the SetupIntent for Checkout Sessions in `setup` mode. */ - readonly setup_intent?: (Partial & Partial) | null; + readonly setup_intent?: (Partial & Partial) | null /** @description Shipping information for this Checkout Session. */ - readonly shipping?: Partial | null; + readonly shipping?: Partial | null /** @description When set, provides configuration for Checkout to collect a shipping address from a customer. */ - readonly shipping_address_collection?: Partial< - components["schemas"]["payment_pages_checkout_session_shipping_address_collection"] - > | null; + readonly shipping_address_collection?: Partial | null /** @description The shipping rate options applied to this Session. */ - readonly shipping_options: readonly components["schemas"]["payment_pages_checkout_session_shipping_option"][]; + readonly shipping_options: readonly components['schemas']['payment_pages_checkout_session_shipping_option'][] /** @description The ID of the ShippingRate for Checkout Sessions in `payment` mode. */ - readonly shipping_rate?: (Partial & Partial) | null; + readonly shipping_rate?: (Partial & Partial) | null /** * @description The status of the Checkout Session, one of `open`, `complete`, or `expired`. * @enum {string|null} */ - readonly status?: ("complete" | "expired" | "open") | null; + readonly status?: ('complete' | 'expired' | 'open') | null /** * @description Describes the type of transaction being performed by Checkout in order to customize * relevant text on the page, such as the submit button. `submit_type` can only be @@ -3311,87 +3280,87 @@ export interface components { * in `subscription` or `setup` mode. * @enum {string|null} */ - readonly submit_type?: ("auto" | "book" | "donate" | "pay") | null; + readonly submit_type?: ('auto' | 'book' | 'donate' | 'pay') | null /** @description The ID of the subscription for Checkout Sessions in `subscription` mode. */ - readonly subscription?: (Partial & Partial) | null; + readonly subscription?: (Partial & Partial) | null /** * @description The URL the customer will be directed to after the payment or * subscription creation is successful. */ - readonly success_url: string; - readonly tax_id_collection?: components["schemas"]["payment_pages_checkout_session_tax_id_collection"]; + readonly success_url: string + readonly tax_id_collection?: components['schemas']['payment_pages_checkout_session_tax_id_collection'] /** @description Tax and discount details for the computed total amount. */ - readonly total_details?: Partial | null; + readonly total_details?: Partial | null /** @description The URL to the Checkout Session. */ - readonly url?: string | null; - }; + readonly url?: string | null + } /** CheckoutAcssDebitMandateOptions */ readonly checkout_acss_debit_mandate_options: { /** @description A URL for custom mandate text */ - readonly custom_mandate_url?: string; + readonly custom_mandate_url?: string /** @description List of Stripe products where this mandate can be selected automatically. Returned when the Session is in `setup` mode. */ - readonly default_for?: readonly ("invoice" | "subscription")[]; + readonly default_for?: readonly ('invoice' | 'subscription')[] /** @description Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. */ - readonly interval_description?: string | null; + readonly interval_description?: string | null /** * @description Payment schedule for the mandate. * @enum {string|null} */ - readonly payment_schedule?: ("combined" | "interval" | "sporadic") | null; + readonly payment_schedule?: ('combined' | 'interval' | 'sporadic') | null /** * @description Transaction type of the mandate. * @enum {string|null} */ - readonly transaction_type?: ("business" | "personal") | null; - }; + readonly transaction_type?: ('business' | 'personal') | null + } /** CheckoutAcssDebitPaymentMethodOptions */ readonly checkout_acss_debit_payment_method_options: { /** * @description Currency supported by the bank account. Returned when the Session is in `setup` mode. * @enum {string} */ - readonly currency?: "cad" | "usd"; - readonly mandate_options?: components["schemas"]["checkout_acss_debit_mandate_options"]; + readonly currency?: 'cad' | 'usd' + readonly mandate_options?: components['schemas']['checkout_acss_debit_mandate_options'] /** * @description Bank account verification method. * @enum {string} */ - readonly verification_method?: "automatic" | "instant" | "microdeposits"; - }; + readonly verification_method?: 'automatic' | 'instant' | 'microdeposits' + } /** CheckoutBoletoPaymentMethodOptions */ readonly checkout_boleto_payment_method_options: { /** @description 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. */ - readonly expires_after_days: number; - }; + readonly expires_after_days: number + } /** CheckoutOxxoPaymentMethodOptions */ readonly checkout_oxxo_payment_method_options: { /** @description 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. */ - readonly expires_after_days: number; - }; + readonly expires_after_days: number + } /** CheckoutSessionPaymentMethodOptions */ readonly checkout_session_payment_method_options: { - readonly acss_debit?: components["schemas"]["checkout_acss_debit_payment_method_options"]; - readonly boleto?: components["schemas"]["checkout_boleto_payment_method_options"]; - readonly oxxo?: components["schemas"]["checkout_oxxo_payment_method_options"]; - }; + readonly acss_debit?: components['schemas']['checkout_acss_debit_payment_method_options'] + readonly boleto?: components['schemas']['checkout_boleto_payment_method_options'] + readonly oxxo?: components['schemas']['checkout_oxxo_payment_method_options'] + } /** ConnectCollectionTransfer */ readonly connect_collection_transfer: { /** @description Amount transferred, in %s. */ - readonly amount: number; + readonly amount: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description ID of the account that funds are being collected for. */ - readonly destination: Partial & Partial; + readonly destination: Partial & Partial /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "connect_collection_transfer"; - }; + readonly object: 'connect_collection_transfer' + } /** * CountrySpec * @description Stripe needs to collect certain pieces of information about each account @@ -3403,36 +3372,36 @@ export interface components { */ readonly country_spec: { /** @description The default currency for this country. This applies to both payment methods and bank accounts. */ - readonly default_currency: string; + readonly default_currency: string /** @description Unique identifier for the object. Represented as the ISO country code for this country. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "country_spec"; + readonly object: 'country_spec' /** @description Currencies that can be accepted in the specific country (for transfers). */ - readonly supported_bank_account_currencies: { readonly [key: string]: readonly string[] }; + readonly supported_bank_account_currencies: { readonly [key: string]: readonly string[] } /** @description Currencies that can be accepted in the specified country (for payments). */ - readonly supported_payment_currencies: readonly string[]; + readonly supported_payment_currencies: readonly string[] /** @description 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). */ - readonly supported_payment_methods: readonly string[]; + readonly supported_payment_methods: readonly string[] /** @description Countries that can accept transfers from the specified country. */ - readonly supported_transfer_countries: readonly string[]; - readonly verification_fields: components["schemas"]["country_spec_verification_fields"]; - }; + readonly supported_transfer_countries: readonly string[] + readonly verification_fields: components['schemas']['country_spec_verification_fields'] + } /** CountrySpecVerificationFieldDetails */ readonly country_spec_verification_field_details: { /** @description Additional fields which are only required for some users. */ - readonly additional: readonly string[]; + readonly additional: readonly string[] /** @description Fields which every account must eventually provide. */ - readonly minimum: readonly string[]; - }; + readonly minimum: readonly string[] + } /** CountrySpecVerificationFields */ readonly country_spec_verification_fields: { - readonly company: components["schemas"]["country_spec_verification_field_details"]; - readonly individual: components["schemas"]["country_spec_verification_field_details"]; - }; + readonly company: components['schemas']['country_spec_verification_field_details'] + readonly individual: components['schemas']['country_spec_verification_field_details'] + } /** * Coupon * @description A coupon contains information about a percent-off or amount-off discount you @@ -3441,54 +3410,54 @@ export interface components { */ readonly coupon: { /** @description Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer. */ - readonly amount_off?: number | null; - readonly applies_to?: components["schemas"]["coupon_applies_to"]; + readonly amount_off?: number | null + readonly applies_to?: components['schemas']['coupon_applies_to'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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. */ - readonly currency?: string | null; + readonly currency?: string | null /** * @description One of `forever`, `once`, and `repeating`. Describes how long a customer who applies this coupon will get the discount. * @enum {string} */ - readonly duration: "forever" | "once" | "repeating"; + readonly duration: 'forever' | 'once' | 'repeating' /** @description If `duration` is `repeating`, the number of months the coupon applies. Null if coupon `duration` is `forever` or `once`. */ - readonly duration_in_months?: number | null; + readonly duration_in_months?: number | null /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid. */ - readonly max_redemptions?: number | null; + readonly max_redemptions?: number | null /** @description 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. */ - readonly metadata?: { readonly [key: string]: string } | null; + readonly metadata?: { readonly [key: string]: string } | null /** @description Name of the coupon displayed to customers on for instance invoices or receipts. */ - readonly name?: string | null; + readonly name?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "coupon"; + readonly object: 'coupon' /** @description 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 %s100 invoice %s50 instead. */ - readonly percent_off?: number | null; + readonly percent_off?: number | null /** * Format: unix-time * @description Date after which the coupon can no longer be redeemed. */ - readonly redeem_by?: number | null; + readonly redeem_by?: number | null /** @description Number of times this coupon has been applied to a customer. */ - readonly times_redeemed: number; + readonly times_redeemed: number /** @description Taking account of the above properties, whether this coupon can still be applied to a customer. */ - readonly valid: boolean; - }; + readonly valid: boolean + } /** CouponAppliesTo */ readonly coupon_applies_to: { /** @description A list of product IDs this coupon applies to */ - readonly products: readonly string[]; - }; + readonly products: readonly string[] + } /** * CreditNote * @description Issue a credit note to adjust an invoice's amount after the invoice is finalized. @@ -3497,142 +3466,138 @@ export interface components { */ readonly credit_note: { /** @description The integer amount in %s representing the total amount of the credit note, including tax. */ - readonly amount: number; + readonly amount: number /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description ID of the customer. */ - readonly customer: Partial & - Partial & - Partial; + readonly customer: Partial & Partial & Partial /** @description Customer balance transaction related to this credit note. */ - readonly customer_balance_transaction?: - | (Partial & Partial) - | null; + readonly customer_balance_transaction?: (Partial & Partial) | null /** @description The integer amount in %s representing the total amount of discount that was credited. */ - readonly discount_amount: number; + readonly discount_amount: number /** @description The aggregate amounts calculated per discount for all line items. */ - readonly discount_amounts: readonly components["schemas"]["discounts_resource_discount_amount"][]; + readonly discount_amounts: readonly components['schemas']['discounts_resource_discount_amount'][] /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description ID of the invoice. */ - readonly invoice: Partial & Partial; + readonly invoice: Partial & Partial /** * CreditNoteLinesList * @description Line items that make up the credit note */ readonly lines: { /** @description Details about each object. */ - readonly data: readonly components["schemas"]["credit_note_line_item"][]; + readonly data: readonly components['schemas']['credit_note_line_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; + readonly url: string + } /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description Customer-facing text that appears on the credit note PDF. */ - readonly memo?: string | null; + readonly memo?: string | null /** @description 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. */ - readonly metadata?: { readonly [key: string]: string } | null; + readonly metadata?: { readonly [key: string]: string } | null /** @description A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice. */ - readonly number: string; + readonly number: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "credit_note"; + readonly object: 'credit_note' /** @description Amount that was credited outside of Stripe. */ - readonly out_of_band_amount?: number | null; + readonly out_of_band_amount?: number | null /** @description The link to download the PDF of the credit note. */ - readonly pdf: string; + readonly pdf: string /** * @description Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` * @enum {string|null} */ - readonly reason?: ("duplicate" | "fraudulent" | "order_change" | "product_unsatisfactory") | null; + readonly reason?: ('duplicate' | 'fraudulent' | 'order_change' | 'product_unsatisfactory') | null /** @description Refund related to this credit note. */ - readonly refund?: (Partial & Partial) | null; + readonly refund?: (Partial & Partial) | null /** * @description 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). * @enum {string} */ - readonly status: "issued" | "void"; + readonly status: 'issued' | 'void' /** @description The integer amount in %s representing the amount of the credit note, excluding tax and invoice level discounts. */ - readonly subtotal: number; + readonly subtotal: number /** @description The aggregate amounts calculated per tax rate for all line items. */ - readonly tax_amounts: readonly components["schemas"]["credit_note_tax_amount"][]; + readonly tax_amounts: readonly components['schemas']['credit_note_tax_amount'][] /** @description The integer amount in %s representing the total amount of the credit note, including tax and all discount. */ - readonly total: number; + readonly total: number /** * @description 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. * @enum {string} */ - readonly type: "post_payment" | "pre_payment"; + readonly type: 'post_payment' | 'pre_payment' /** * Format: unix-time * @description The time that the credit note was voided. */ - readonly voided_at?: number | null; - }; + readonly voided_at?: number | null + } /** CreditNoteLineItem */ readonly credit_note_line_item: { /** @description The integer amount in %s representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts. */ - readonly amount: number; + readonly amount: number /** @description Description of the item being credited. */ - readonly description?: string | null; + readonly description?: string | null /** @description The integer amount in %s representing the discount being credited for this line item. */ - readonly discount_amount: number; + readonly discount_amount: number /** @description The amount of discount calculated per discount for this line item */ - readonly discount_amounts: readonly components["schemas"]["discounts_resource_discount_amount"][]; + readonly discount_amounts: readonly components['schemas']['discounts_resource_discount_amount'][] /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description ID of the invoice line item being credited */ - readonly invoice_line_item?: string; + readonly invoice_line_item?: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "credit_note_line_item"; + readonly object: 'credit_note_line_item' /** @description The number of units of product being credited. */ - readonly quantity?: number | null; + readonly quantity?: number | null /** @description The amount of tax calculated per tax rate for this line item */ - readonly tax_amounts: readonly components["schemas"]["credit_note_tax_amount"][]; + readonly tax_amounts: readonly components['schemas']['credit_note_tax_amount'][] /** @description The tax rates which apply to the line item. */ - readonly tax_rates: readonly components["schemas"]["tax_rate"][]; + readonly tax_rates: readonly components['schemas']['tax_rate'][] /** * @description 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. * @enum {string} */ - readonly type: "custom_line_item" | "invoice_line_item"; + readonly type: 'custom_line_item' | 'invoice_line_item' /** @description The cost of each unit of product being credited. */ - readonly unit_amount?: number | null; + readonly unit_amount?: number | null /** * Format: decimal * @description Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. */ - readonly unit_amount_decimal?: string | null; - }; + readonly unit_amount_decimal?: string | null + } /** CreditNoteTaxAmount */ readonly credit_note_tax_amount: { /** @description The amount, in %s, of the tax. */ - readonly amount: number; + readonly amount: number /** @description Whether this tax amount is inclusive or exclusive. */ - readonly inclusive: boolean; + readonly inclusive: boolean /** @description The tax rate that was applied to get this tax amount. */ - readonly tax_rate: Partial & Partial; - }; + readonly tax_rate: Partial & Partial + } /** * Customer * @description This object represents a customer of your business. It lets you create recurring charges and track payments that belong to the same customer. @@ -3641,16 +3606,16 @@ export interface components { */ readonly customer: { /** @description The customer's address. */ - readonly address?: Partial | null; + readonly address?: Partial | null /** @description Current balance, if any, being 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 will be added to their next invoice. The balance does not refer to any unpaid invoices; it solely takes into account amounts that have yet to be successfully applied to any invoice. This balance is only taken into account as invoices are finalized. */ - readonly balance?: number; + readonly balance?: number /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes. */ - readonly currency?: string | null; + readonly currency?: string | null /** * @description ID of the default payment source for the customer. * @@ -3658,125 +3623,125 @@ export interface components { */ readonly default_source?: | (Partial & - Partial & - Partial & - Partial & - Partial & - Partial) - | null; + Partial & + Partial & + Partial & + Partial & + Partial) + | null /** * @description When the customer's latest invoice is billed by charging automatically, `delinquent` is `true` if the invoice's latest charge failed. When the customer's latest invoice is billed by sending an invoice, `delinquent` is `true` if the invoice isn't paid by its due date. * * If an invoice is marked uncollectible by [dunning](https://stripe.com/docs/billing/automatic-collection), `delinquent` doesn't get reset to `false`. */ - readonly delinquent?: boolean | null; + readonly delinquent?: boolean | null /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string | null; + readonly description?: string | null /** @description Describes the current discount active on the customer, if there is one. */ - readonly discount?: Partial | null; + readonly discount?: Partial | null /** @description The customer's email address. */ - readonly email?: string | null; + readonly email?: string | null /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description The prefix for the customer used to generate unique invoice numbers. */ - readonly invoice_prefix?: string | null; - readonly invoice_settings?: components["schemas"]["invoice_setting_customer_setting"]; + readonly invoice_prefix?: string | null + readonly invoice_settings?: components['schemas']['invoice_setting_customer_setting'] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata?: { readonly [key: string]: string }; + readonly metadata?: { readonly [key: string]: string } /** @description The customer's full name or business name. */ - readonly name?: string | null; + readonly name?: string | null /** @description The suffix of the customer's next invoice number, e.g., 0001. */ - readonly next_invoice_sequence?: number; + readonly next_invoice_sequence?: number /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "customer"; + readonly object: 'customer' /** @description The customer's phone number. */ - readonly phone?: string | null; + readonly phone?: string | null /** @description The customer's preferred locales (languages), ordered by preference. */ - readonly preferred_locales?: readonly string[] | null; + readonly preferred_locales?: readonly string[] | null /** @description Mailing and shipping address for the customer. Appears on invoices emailed to this customer. */ - readonly shipping?: Partial | null; + readonly shipping?: Partial | null /** * ApmsSourcesSourceList * @description The customer's payment sources, if any. */ readonly sources?: { /** @description Details about each object. */ - readonly data: readonly (Partial & - Partial & - Partial & - Partial & - Partial)[]; + readonly data: readonly (Partial & + Partial & + Partial & + Partial & + Partial)[] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; + readonly url: string + } /** * SubscriptionList * @description The customer's current subscriptions, if any. */ readonly subscriptions?: { /** @description Details about each object. */ - readonly data: readonly components["schemas"]["subscription"][]; + readonly data: readonly components['schemas']['subscription'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - readonly tax?: components["schemas"]["customer_tax"]; + readonly url: string + } + readonly tax?: components['schemas']['customer_tax'] /** * @description Describes the customer's tax exemption status. One of `none`, `exempt`, or `reverse`. When set to `reverse`, invoice and receipt PDFs include the text **"Reverse charge"**. * @enum {string|null} */ - readonly tax_exempt?: ("exempt" | "none" | "reverse") | null; + readonly tax_exempt?: ('exempt' | 'none' | 'reverse') | null /** * TaxIDsList * @description The customer's tax IDs. */ readonly tax_ids?: { /** @description Details about each object. */ - readonly data: readonly components["schemas"]["tax_id"][]; + readonly data: readonly components['schemas']['tax_id'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; + readonly url: string + } + } /** customer_acceptance */ readonly customer_acceptance: { /** * Format: unix-time * @description The time at which the customer accepted the Mandate. */ - readonly accepted_at?: number | null; - readonly offline?: components["schemas"]["offline_acceptance"]; - readonly online?: components["schemas"]["online_acceptance"]; + readonly accepted_at?: number | null + readonly offline?: components['schemas']['offline_acceptance'] + readonly online?: components['schemas']['online_acceptance'] /** * @description The type of customer acceptance information included with the Mandate. One of `online` or `offline`. * @enum {string} */ - readonly type: "offline" | "online"; - }; + readonly type: 'offline' | 'online' + } /** * CustomerBalanceTransaction * @description Each customer has a [`balance`](https://stripe.com/docs/api/customers/object#customer_object-balance) value, @@ -3788,479 +3753,474 @@ export interface components { */ readonly customer_balance_transaction: { /** @description 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`. */ - readonly amount: number; + readonly amount: number /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description The ID of the credit note (if any) related to the transaction. */ - readonly credit_note?: (Partial & Partial) | null; + readonly credit_note?: (Partial & Partial) | null /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description The ID of the customer the transaction belongs to. */ - readonly customer: Partial & Partial; + readonly customer: Partial & Partial /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string | null; + readonly description?: string | null /** @description 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. */ - readonly ending_balance: number; + readonly ending_balance: number /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description The ID of the invoice (if any) related to the transaction. */ - readonly invoice?: (Partial & Partial) | null; + readonly invoice?: (Partial & Partial) | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata?: { readonly [key: string]: string } | null; + readonly metadata?: { readonly [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "customer_balance_transaction"; + readonly object: 'customer_balance_transaction' /** * @description Transaction type: `adjustment`, `applied_to_invoice`, `credit_note`, `initial`, `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. * @enum {string} */ readonly type: - | "adjustment" - | "applied_to_invoice" - | "credit_note" - | "initial" - | "invoice_too_large" - | "invoice_too_small" - | "migration" - | "unapplied_from_invoice" - | "unspent_receiver_credit"; - }; + | 'adjustment' + | 'applied_to_invoice' + | 'credit_note' + | 'initial' + | 'invoice_too_large' + | 'invoice_too_small' + | 'migration' + | 'unapplied_from_invoice' + | 'unspent_receiver_credit' + } /** CustomerTax */ readonly customer_tax: { /** * @description Surfaces if automatic tax computation is possible given the current customer location information. * @enum {string} */ - readonly automatic_tax: "failed" | "not_collecting" | "supported" | "unrecognized_location"; + readonly automatic_tax: 'failed' | 'not_collecting' | 'supported' | 'unrecognized_location' /** @description A recent IP address of the customer used for tax reporting and tax location inference. */ - readonly ip_address?: string | null; + readonly ip_address?: string | null /** @description The customer's location as identified by Stripe Tax. */ - readonly location?: Partial | null; - }; + readonly location?: Partial | null + } /** CustomerTaxLocation */ readonly customer_tax_location: { /** @description The customer's country as identified by Stripe Tax. */ - readonly country: string; + readonly country: string /** * @description The data source used to infer the customer's location. * @enum {string} */ - readonly source: "billing_address" | "ip_address" | "payment_method" | "shipping_destination"; + readonly source: 'billing_address' | 'ip_address' | 'payment_method' | 'shipping_destination' /** @description The customer's state, county, province, or region as identified by Stripe Tax. */ - readonly state?: string | null; - }; + readonly state?: string | null + } /** DeletedAccount */ readonly deleted_account: { /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "account"; - }; + readonly object: 'account' + } /** AlipayDeletedAccount */ readonly deleted_alipay_account: { /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "alipay_account"; - }; + readonly object: 'alipay_account' + } /** DeletedApplePayDomain */ readonly deleted_apple_pay_domain: { /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "apple_pay_domain"; - }; + readonly object: 'apple_pay_domain' + } /** DeletedBankAccount */ readonly deleted_bank_account: { /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. */ - readonly currency?: string | null; + readonly currency?: string | null /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "bank_account"; - }; + readonly object: 'bank_account' + } /** BitcoinDeletedReceiver */ readonly deleted_bitcoin_receiver: { /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "bitcoin_receiver"; - }; + readonly object: 'bitcoin_receiver' + } /** DeletedCard */ readonly deleted_card: { /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. */ - readonly currency?: string | null; + readonly currency?: string | null /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "card"; - }; + readonly object: 'card' + } /** DeletedCoupon */ readonly deleted_coupon: { /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "coupon"; - }; + readonly object: 'coupon' + } /** DeletedCustomer */ readonly deleted_customer: { /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "customer"; - }; + readonly object: 'customer' + } /** DeletedDiscount */ readonly deleted_discount: { /** @description 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. */ - readonly checkout_session?: string | null; - readonly coupon: components["schemas"]["coupon"]; + readonly checkout_session?: string | null + readonly coupon: components['schemas']['coupon'] /** @description The ID of the customer associated with this discount. */ - readonly customer?: - | (Partial & - Partial & - Partial) - | null; + readonly customer?: (Partial & Partial & Partial) | null /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description 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. */ - readonly id: string; + readonly id: string /** @description The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice. */ - readonly invoice?: string | null; + readonly invoice?: string | null /** @description 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. */ - readonly invoice_item?: string | null; + readonly invoice_item?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "discount"; + readonly object: 'discount' /** @description The promotion code applied to create this discount. */ - readonly promotion_code?: (Partial & Partial) | null; + readonly promotion_code?: (Partial & Partial) | null /** * Format: unix-time * @description Date that the coupon was applied. */ - readonly start: number; + readonly start: number /** @description The subscription that this coupon is applied to, if it is applied to a particular subscription. */ - readonly subscription?: string | null; - }; + readonly subscription?: string | null + } /** Polymorphic */ - readonly deleted_external_account: Partial & - Partial; + readonly deleted_external_account: Partial & Partial /** DeletedInvoice */ readonly deleted_invoice: { /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "invoice"; - }; + readonly object: 'invoice' + } /** DeletedInvoiceItem */ readonly deleted_invoiceitem: { /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "invoiceitem"; - }; + readonly object: 'invoiceitem' + } /** Polymorphic */ - readonly deleted_payment_source: Partial & - Partial & - Partial & - Partial; + readonly deleted_payment_source: Partial & + Partial & + Partial & + Partial /** DeletedPerson */ readonly deleted_person: { /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "person"; - }; + readonly object: 'person' + } /** DeletedPlan */ readonly deleted_plan: { /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "plan"; - }; + readonly object: 'plan' + } /** DeletedPrice */ readonly deleted_price: { /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "price"; - }; + readonly object: 'price' + } /** DeletedProduct */ readonly deleted_product: { /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "product"; - }; + readonly object: 'product' + } /** RadarListDeletedList */ - readonly "deleted_radar.value_list": { + readonly 'deleted_radar.value_list': { /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "radar.value_list"; - }; + readonly object: 'radar.value_list' + } /** RadarListDeletedListItem */ - readonly "deleted_radar.value_list_item": { + readonly 'deleted_radar.value_list_item': { /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "radar.value_list_item"; - }; + readonly object: 'radar.value_list_item' + } /** DeletedTransferRecipient */ readonly deleted_recipient: { /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "recipient"; - }; + readonly object: 'recipient' + } /** DeletedSku */ readonly deleted_sku: { /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "sku"; - }; + readonly object: 'sku' + } /** DeletedSubscriptionItem */ readonly deleted_subscription_item: { /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "subscription_item"; - }; + readonly object: 'subscription_item' + } /** deleted_tax_id */ readonly deleted_tax_id: { /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "tax_id"; - }; + readonly object: 'tax_id' + } /** TerminalLocationDeletedLocation */ - readonly "deleted_terminal.location": { + readonly 'deleted_terminal.location': { /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "terminal.location"; - }; + readonly object: 'terminal.location' + } /** TerminalReaderDeletedReader */ - readonly "deleted_terminal.reader": { + readonly 'deleted_terminal.reader': { /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "terminal.reader"; - }; + readonly object: 'terminal.reader' + } /** NotificationWebhookEndpointDeleted */ readonly deleted_webhook_endpoint: { /** * @description Always true for a deleted object * @enum {boolean} */ - readonly deleted: true; + readonly deleted: true /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "webhook_endpoint"; - }; + readonly object: 'webhook_endpoint' + } /** DeliveryEstimate */ readonly delivery_estimate: { /** @description If `type` is `"exact"`, `date` will be the expected delivery date in the format YYYY-MM-DD. */ - readonly date?: string; + readonly date?: string /** @description If `type` is `"range"`, `earliest` will be be the earliest delivery date in the format YYYY-MM-DD. */ - readonly earliest?: string; + readonly earliest?: string /** @description If `type` is `"range"`, `latest` will be the latest delivery date in the format YYYY-MM-DD. */ - readonly latest?: string; + readonly latest?: string /** @description The type of estimate. Must be either `"range"` or `"exact"`. */ - readonly type: string; - }; + readonly type: string + } /** * Discount * @description A discount represents the actual application of a coupon to a particular @@ -4271,49 +4231,43 @@ export interface components { */ readonly discount: { /** @description 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. */ - readonly checkout_session?: string | null; - readonly coupon: components["schemas"]["coupon"]; + readonly checkout_session?: string | null + readonly coupon: components['schemas']['coupon'] /** @description The ID of the customer associated with this discount. */ - readonly customer?: - | (Partial & - Partial & - Partial) - | null; + readonly customer?: (Partial & Partial & Partial) | null /** * Format: unix-time * @description 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. */ - readonly end?: number | null; + readonly end?: number | null /** @description 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. */ - readonly id: string; + readonly id: string /** @description The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice. */ - readonly invoice?: string | null; + readonly invoice?: string | null /** @description 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. */ - readonly invoice_item?: string | null; + readonly invoice_item?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "discount"; + readonly object: 'discount' /** @description The promotion code applied to create this discount. */ - readonly promotion_code?: (Partial & Partial) | null; + readonly promotion_code?: (Partial & Partial) | null /** * Format: unix-time * @description Date that the coupon was applied. */ - readonly start: number; + readonly start: number /** @description The subscription that this coupon is applied to, if it is applied to a particular subscription. */ - readonly subscription?: string | null; - }; + readonly subscription?: string | null + } /** DiscountsResourceDiscountAmount */ readonly discounts_resource_discount_amount: { /** @description The amount, in %s, of the discount. */ - readonly amount: number; + readonly amount: number /** @description The discount that was applied to get this discount amount. */ - readonly discount: Partial & - Partial & - Partial; - }; + readonly discount: Partial & Partial & Partial + } /** * Dispute * @description A dispute occurs when a customer questions your charge with their card issuer. @@ -4326,150 +4280,150 @@ export interface components { */ readonly dispute: { /** @description Disputed amount. Usually the amount of the charge, but can differ (usually because of currency fluctuation or because only part of the order is disputed). */ - readonly amount: number; + readonly amount: number /** @description List of zero, one, or two balance transactions that show funds withdrawn and reinstated to your Stripe account as a result of this dispute. */ - readonly balance_transactions: readonly components["schemas"]["balance_transaction"][]; + readonly balance_transactions: readonly components['schemas']['balance_transaction'][] /** @description ID of the charge that was disputed. */ - readonly charge: Partial & Partial; + readonly charge: Partial & Partial /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; - readonly evidence: components["schemas"]["dispute_evidence"]; - readonly evidence_details: components["schemas"]["dispute_evidence_details"]; + readonly currency: string + readonly evidence: components['schemas']['dispute_evidence'] + readonly evidence_details: components['schemas']['dispute_evidence_details'] /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description If true, it is still possible to refund the disputed payment. Once the payment has been fully refunded, no further funds will be withdrawn from your Stripe account as a result of this dispute. */ - readonly is_charge_refundable: boolean; + readonly is_charge_refundable: boolean /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata: { readonly [key: string]: string }; + readonly metadata: { readonly [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "dispute"; + readonly object: 'dispute' /** @description ID of the PaymentIntent that was disputed. */ - readonly payment_intent?: (Partial & Partial) | null; + readonly payment_intent?: (Partial & Partial) | null /** @description 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`. Read more about [dispute reasons](https://stripe.com/docs/disputes/categories). */ - readonly reason: string; + readonly reason: string /** * @description Current status of dispute. Possible values are `warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `charge_refunded`, `won`, or `lost`. * @enum {string} */ readonly status: - | "charge_refunded" - | "lost" - | "needs_response" - | "under_review" - | "warning_closed" - | "warning_needs_response" - | "warning_under_review" - | "won"; - }; + | 'charge_refunded' + | 'lost' + | 'needs_response' + | 'under_review' + | 'warning_closed' + | 'warning_needs_response' + | 'warning_under_review' + | 'won' + } /** DisputeEvidence */ readonly dispute_evidence: { /** @description 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. */ - readonly access_activity_log?: string | null; + readonly access_activity_log?: string | null /** @description The billing address provided by the customer. */ - readonly billing_address?: string | null; + readonly billing_address?: string | null /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your subscription cancellation policy, as shown to the customer. */ - readonly cancellation_policy?: (Partial & Partial) | null; + readonly cancellation_policy?: (Partial & Partial) | null /** @description An explanation of how and when the customer was shown your refund policy prior to purchase. */ - readonly cancellation_policy_disclosure?: string | null; + readonly cancellation_policy_disclosure?: string | null /** @description A justification for why the customer's subscription was not canceled. */ - readonly cancellation_rebuttal?: string | null; + readonly cancellation_rebuttal?: string | null /** @description (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. */ - readonly customer_communication?: (Partial & Partial) | null; + readonly customer_communication?: (Partial & Partial) | null /** @description The email address of the customer. */ - readonly customer_email_address?: string | null; + readonly customer_email_address?: string | null /** @description The name of the customer. */ - readonly customer_name?: string | null; + readonly customer_name?: string | null /** @description The IP address that the customer used when making the purchase. */ - readonly customer_purchase_ip?: string | null; + readonly customer_purchase_ip?: string | null /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A relevant document or contract showing the customer's signature. */ - readonly customer_signature?: (Partial & Partial) | null; + readonly customer_signature?: (Partial & Partial) | null /** @description (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. */ - readonly duplicate_charge_documentation?: (Partial & Partial) | null; + readonly duplicate_charge_documentation?: (Partial & Partial) | null /** @description An explanation of the difference between the disputed charge versus the prior charge that appears to be a duplicate. */ - readonly duplicate_charge_explanation?: string | null; + readonly duplicate_charge_explanation?: string | null /** @description The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge. */ - readonly duplicate_charge_id?: string | null; + readonly duplicate_charge_id?: string | null /** @description A description of the product or service that was sold. */ - readonly product_description?: string | null; + readonly product_description?: string | null /** @description (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. */ - readonly receipt?: (Partial & Partial) | null; + readonly receipt?: (Partial & Partial) | null /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your refund policy, as shown to the customer. */ - readonly refund_policy?: (Partial & Partial) | null; + readonly refund_policy?: (Partial & Partial) | null /** @description Documentation demonstrating that the customer was shown your refund policy prior to purchase. */ - readonly refund_policy_disclosure?: string | null; + readonly refund_policy_disclosure?: string | null /** @description A justification for why the customer is not entitled to a refund. */ - readonly refund_refusal_explanation?: string | null; + readonly refund_refusal_explanation?: string | null /** @description The date on which the customer received or began receiving the purchased service, in a clear human-readable format. */ - readonly service_date?: string | null; + readonly service_date?: string | null /** @description (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. */ - readonly service_documentation?: (Partial & Partial) | null; + readonly service_documentation?: (Partial & Partial) | null /** @description The address to which a physical product was shipped. You should try to include as complete address information as possible. */ - readonly shipping_address?: string | null; + readonly shipping_address?: string | null /** @description 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. */ - readonly shipping_carrier?: string | null; + readonly shipping_carrier?: string | null /** @description The date on which a physical product began its route to the shipping address, in a clear human-readable format. */ - readonly shipping_date?: string | null; + readonly shipping_date?: string | null /** @description (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. */ - readonly shipping_documentation?: (Partial & Partial) | null; + readonly shipping_documentation?: (Partial & Partial) | null /** @description 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. */ - readonly shipping_tracking_number?: string | null; + readonly shipping_tracking_number?: string | null /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any additional evidence or statements. */ - readonly uncategorized_file?: (Partial & Partial) | null; + readonly uncategorized_file?: (Partial & Partial) | null /** @description Any additional evidence or statements. */ - readonly uncategorized_text?: string | null; - }; + readonly uncategorized_text?: string | null + } /** DisputeEvidenceDetails */ readonly dispute_evidence_details: { /** * Format: unix-time * @description Date by which evidence must be submitted in order to successfully challenge dispute. Will be null if the customer's bank or credit card company doesn't allow a response for this particular dispute. */ - readonly due_by?: number | null; + readonly due_by?: number | null /** @description Whether evidence has been staged for this dispute. */ - readonly has_evidence: boolean; + readonly has_evidence: boolean /** @description 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. */ - readonly past_due: boolean; + readonly past_due: boolean /** @description The number of times evidence has been submitted. Typically, you may only submit evidence once. */ - readonly submission_count: number; - }; + readonly submission_count: number + } /** EphemeralKey */ readonly ephemeral_key: { /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** * Format: unix-time * @description Time at which the key will expire. Measured in seconds since the Unix epoch. */ - readonly expires: number; + readonly expires: number /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "ephemeral_key"; + readonly object: 'ephemeral_key' /** @description The key's secret. You can use this value to make authorized requests to the Stripe API. */ - readonly secret?: string; - }; + readonly secret?: string + } /** @description An error response from the Stripe API */ readonly error: { - readonly error: components["schemas"]["api_errors"]; - }; + readonly error: components['schemas']['api_errors'] + } /** * NotificationEvent * @description Events are our way of letting you know when something interesting happens in @@ -4504,31 +4458,31 @@ export interface components { */ readonly event: { /** @description The connected account that originated the event. */ - readonly account?: string; + readonly account?: string /** @description The Stripe API version used to render `data`. *Note: This property is populated only for events on or after October 31, 2014*. */ - readonly api_version?: string | null; + readonly api_version?: string | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; - readonly data: components["schemas"]["notification_event_data"]; + readonly created: number + readonly data: components['schemas']['notification_event_data'] /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "event"; + readonly object: 'event' /** @description Number of webhooks that have yet to be successfully delivered (i.e., to return a 20x response) to the URLs you've specified. */ - readonly pending_webhooks: number; + readonly pending_webhooks: number /** @description Information on the API request that instigated the event. */ - readonly request?: Partial | null; + readonly request?: Partial | null /** @description Description of the event (e.g., `invoice.created` or `charge.refunded`). */ - readonly type: string; - }; + readonly type: string + } /** * ExchangeRate * @description `Exchange Rate` objects allow you to determine the rates that Stripe is @@ -4545,30 +4499,30 @@ export interface components { */ readonly exchange_rate: { /** @description Unique identifier for the object. Represented as the three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "exchange_rate"; + readonly object: 'exchange_rate' /** @description 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. */ - readonly rates: { readonly [key: string]: number }; - }; + readonly rates: { readonly [key: string]: number } + } /** Polymorphic */ - readonly external_account: Partial & Partial; + readonly external_account: Partial & Partial /** Fee */ readonly fee: { /** @description Amount of the fee, in cents. */ - readonly amount: number; + readonly amount: number /** @description ID of the Connect application that earned the fee. */ - readonly application?: string | null; + readonly application?: string | null /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string | null; + readonly description?: string | null /** @description Type of the fee, one of: `application_fee`, `stripe_fee` or `tax`. */ - readonly type: string; - }; + readonly type: string + } /** * FeeRefund * @description `Application Fee Refund` objects allow you to refund an application fee that @@ -4579,28 +4533,28 @@ export interface components { */ readonly fee_refund: { /** @description Amount, in %s. */ - readonly amount: number; + readonly amount: number /** @description Balance transaction that describes the impact on your account balance. */ - readonly balance_transaction?: (Partial & Partial) | null; + readonly balance_transaction?: (Partial & Partial) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description ID of the application fee that was refunded. */ - readonly fee: Partial & Partial; + readonly fee: Partial & Partial /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description 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. */ - readonly metadata?: { readonly [key: string]: string } | null; + readonly metadata?: { readonly [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "fee_refund"; - }; + readonly object: 'fee_refund' + } /** * File * @description This is an object representing a file hosted on Stripe's servers. The @@ -4616,66 +4570,66 @@ export interface components { * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** * Format: unix-time * @description The time at which the file expires and is no longer available in epoch seconds. */ - readonly expires_at?: number | null; + readonly expires_at?: number | null /** @description A filename for the file, suitable for saving to a filesystem. */ - readonly filename?: string | null; + readonly filename?: string | null /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * FileFileLinkList * @description A list of [file links](https://stripe.com/docs/api#file_links) that point at this file. */ readonly links?: { /** @description Details about each object. */ - readonly data: readonly components["schemas"]["file_link"][]; + readonly data: readonly components['schemas']['file_link'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - } | null; + readonly url: string + } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "file"; + readonly object: 'file' /** * @description The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file. * @enum {string} */ readonly purpose: - | "account_requirement" - | "additional_verification" - | "business_icon" - | "business_logo" - | "customer_signature" - | "dispute_evidence" - | "document_provider_identity_document" - | "finance_report_run" - | "identity_document" - | "identity_document_downloadable" - | "pci_document" - | "selfie" - | "sigma_scheduled_query" - | "tax_document_user_upload"; + | 'account_requirement' + | 'additional_verification' + | 'business_icon' + | 'business_logo' + | 'customer_signature' + | 'dispute_evidence' + | 'document_provider_identity_document' + | 'finance_report_run' + | 'identity_document' + | 'identity_document_downloadable' + | 'pci_document' + | 'selfie' + | 'sigma_scheduled_query' + | 'tax_document_user_upload' /** @description The size in bytes of the file object. */ - readonly size: number; + readonly size: number /** @description A user friendly title for the document. */ - readonly title?: string | null; + readonly title?: string | null /** @description The type of the file returned (e.g., `csv`, `pdf`, `jpg`, or `png`). */ - readonly type?: string | null; + readonly type?: string | null /** @description The URL from which the file can be downloaded using your live secret API key. */ - readonly url?: string | null; - }; + readonly url?: string | null + } /** * FileLink * @description To share the contents of a `File` object with non-Stripe users, you can @@ -4687,254 +4641,250 @@ export interface components { * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description Whether this link is already expired. */ - readonly expired: boolean; + readonly expired: boolean /** * Format: unix-time * @description Time at which the link expires. */ - readonly expires_at?: number | null; + readonly expires_at?: number | null /** @description The file object this link points to. */ - readonly file: Partial & Partial; + readonly file: Partial & Partial /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata: { readonly [key: string]: string }; + readonly metadata: { readonly [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "file_link"; + readonly object: 'file_link' /** @description The publicly accessible URL to download the file. */ - readonly url?: string | null; - }; + readonly url?: string | null + } /** FinancialReportingFinanceReportRunRunParameters */ readonly financial_reporting_finance_report_run_run_parameters: { /** @description The set of output columns requested for inclusion in the report run. */ - readonly columns?: readonly string[]; + readonly columns?: readonly string[] /** @description Connected account ID by which to filter the report run. */ - readonly connected_account?: string; + readonly connected_account?: string /** @description Currency of objects to be included in the report run. */ - readonly currency?: string; + readonly currency?: string /** * Format: unix-time * @description Ending timestamp of data to be included in the report run (exclusive). */ - readonly interval_end?: number; + readonly interval_end?: number /** * Format: unix-time * @description Starting timestamp of data to be included in the report run. */ - readonly interval_start?: number; + readonly interval_start?: number /** @description Payout ID by which to filter the report run. */ - readonly payout?: string; + readonly payout?: string /** @description Category of balance transactions to be included in the report run. */ - readonly reporting_category?: string; + readonly reporting_category?: string /** @description 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`. */ - readonly timezone?: string; - }; + readonly timezone?: string + } /** * GelatoDataDocumentReportDateOfBirth * @description Point in Time */ readonly gelato_data_document_report_date_of_birth: { /** @description Numerical day between 1 and 31. */ - readonly day?: number | null; + readonly day?: number | null /** @description Numerical month between 1 and 12. */ - readonly month?: number | null; + readonly month?: number | null /** @description The four-digit year. */ - readonly year?: number | null; - }; + readonly year?: number | null + } /** * GelatoDataDocumentReportExpirationDate * @description Point in Time */ readonly gelato_data_document_report_expiration_date: { /** @description Numerical day between 1 and 31. */ - readonly day?: number | null; + readonly day?: number | null /** @description Numerical month between 1 and 12. */ - readonly month?: number | null; + readonly month?: number | null /** @description The four-digit year. */ - readonly year?: number | null; - }; + readonly year?: number | null + } /** * GelatoDataDocumentReportIssuedDate * @description Point in Time */ readonly gelato_data_document_report_issued_date: { /** @description Numerical day between 1 and 31. */ - readonly day?: number | null; + readonly day?: number | null /** @description Numerical month between 1 and 12. */ - readonly month?: number | null; + readonly month?: number | null /** @description The four-digit year. */ - readonly year?: number | null; - }; + readonly year?: number | null + } /** * GelatoDataIdNumberReportDate * @description Point in Time */ readonly gelato_data_id_number_report_date: { /** @description Numerical day between 1 and 31. */ - readonly day?: number | null; + readonly day?: number | null /** @description Numerical month between 1 and 12. */ - readonly month?: number | null; + readonly month?: number | null /** @description The four-digit year. */ - readonly year?: number | null; - }; + readonly year?: number | null + } /** * GelatoDataVerifiedOutputsDate * @description Point in Time */ readonly gelato_data_verified_outputs_date: { /** @description Numerical day between 1 and 31. */ - readonly day?: number | null; + readonly day?: number | null /** @description Numerical month between 1 and 12. */ - readonly month?: number | null; + readonly month?: number | null /** @description The four-digit year. */ - readonly year?: number | null; - }; + readonly year?: number | null + } /** * GelatoDocumentReport * @description Result from a document check */ readonly gelato_document_report: { /** @description Address as it appears in the document. */ - readonly address?: Partial | null; + readonly address?: Partial | null /** @description Date of birth as it appears in the document. */ - readonly dob?: Partial | null; + readonly dob?: Partial | null /** @description Details on the verification error. Present when status is `unverified`. */ - readonly error?: Partial | null; + readonly error?: Partial | null /** @description Expiration date of the document. */ - readonly expiration_date?: Partial | null; + readonly expiration_date?: Partial | null /** @description Array of [File](https://stripe.com/docs/api/files) ids containing images for this document. */ - readonly files?: readonly string[] | null; + readonly files?: readonly string[] | null /** @description First name as it appears in the document. */ - readonly first_name?: string | null; + readonly first_name?: string | null /** @description Issued date of the document. */ - readonly issued_date?: Partial | null; + readonly issued_date?: Partial | null /** @description Issuing country of the document. */ - readonly issuing_country?: string | null; + readonly issuing_country?: string | null /** @description Last name as it appears in the document. */ - readonly last_name?: string | null; + readonly last_name?: string | null /** @description Document ID number. */ - readonly number?: string | null; + readonly number?: string | null /** * @description Status of this `document` check. * @enum {string} */ - readonly status: "unverified" | "verified"; + readonly status: 'unverified' | 'verified' /** * @description Type of the document. * @enum {string|null} */ - readonly type?: ("driving_license" | "id_card" | "passport") | null; - }; + readonly type?: ('driving_license' | 'id_card' | 'passport') | null + } /** GelatoDocumentReportError */ readonly gelato_document_report_error: { /** * @description A short machine-readable string giving the reason for the verification failure. * @enum {string|null} */ - readonly code?: ("document_expired" | "document_type_not_supported" | "document_unverified_other") | null; + readonly code?: ('document_expired' | 'document_type_not_supported' | 'document_unverified_other') | null /** @description A human-readable message giving the reason for the failure. These messages can be shown to your users. */ - readonly reason?: string | null; - }; + readonly reason?: string | null + } /** * GelatoIdNumberReport * @description Result from an id_number check */ readonly gelato_id_number_report: { /** @description Date of birth. */ - readonly dob?: Partial | null; + readonly dob?: Partial | null /** @description Details on the verification error. Present when status is `unverified`. */ - readonly error?: Partial | null; + readonly error?: Partial | null /** @description First name. */ - readonly first_name?: string | null; + readonly first_name?: string | null /** @description ID number. */ - readonly id_number?: string | null; + readonly id_number?: string | null /** * @description Type of ID number. * @enum {string|null} */ - readonly id_number_type?: ("br_cpf" | "sg_nric" | "us_ssn") | null; + readonly id_number_type?: ('br_cpf' | 'sg_nric' | 'us_ssn') | null /** @description Last name. */ - readonly last_name?: string | null; + readonly last_name?: string | null /** * @description Status of this `id_number` check. * @enum {string} */ - readonly status: "unverified" | "verified"; - }; + readonly status: 'unverified' | 'verified' + } /** GelatoIdNumberReportError */ readonly gelato_id_number_report_error: { /** * @description A short machine-readable string giving the reason for the verification failure. * @enum {string|null} */ - readonly code?: - | ("id_number_insufficient_document_data" | "id_number_mismatch" | "id_number_unverified_other") - | null; + readonly code?: ('id_number_insufficient_document_data' | 'id_number_mismatch' | 'id_number_unverified_other') | null /** @description A human-readable message giving the reason for the failure. These messages can be shown to your users. */ - readonly reason?: string | null; - }; + readonly reason?: string | null + } /** GelatoReportDocumentOptions */ readonly gelato_report_document_options: { /** @description 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. */ - readonly allowed_types?: readonly ("driving_license" | "id_card" | "passport")[]; + readonly allowed_types?: readonly ('driving_license' | 'id_card' | 'passport')[] /** @description 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. */ - readonly require_id_number?: boolean; + readonly require_id_number?: boolean /** @description Disable image uploads, identity document images have to be captured using the device’s camera. */ - readonly require_live_capture?: boolean; + readonly require_live_capture?: boolean /** @description 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). */ - readonly require_matching_selfie?: boolean; - }; + readonly require_matching_selfie?: boolean + } /** GelatoReportIdNumberOptions */ - readonly gelato_report_id_number_options: { readonly [key: string]: unknown }; + readonly gelato_report_id_number_options: { readonly [key: string]: unknown } /** * GelatoSelfieReport * @description Result from a selfie check */ readonly gelato_selfie_report: { /** @description ID of the [File](https://stripe.com/docs/api/files) holding the image of the identity document used in this check. */ - readonly document?: string | null; + readonly document?: string | null /** @description Details on the verification error. Present when status is `unverified`. */ - readonly error?: Partial | null; + readonly error?: Partial | null /** @description ID of the [File](https://stripe.com/docs/api/files) holding the image of the selfie used in this check. */ - readonly selfie?: string | null; + readonly selfie?: string | null /** * @description Status of this `selfie` check. * @enum {string} */ - readonly status: "unverified" | "verified"; - }; + readonly status: 'unverified' | 'verified' + } /** GelatoSelfieReportError */ readonly gelato_selfie_report_error: { /** * @description A short machine-readable string giving the reason for the verification failure. * @enum {string|null} */ - readonly code?: - | ("selfie_document_missing_photo" | "selfie_face_mismatch" | "selfie_manipulated" | "selfie_unverified_other") - | null; + readonly code?: ('selfie_document_missing_photo' | 'selfie_face_mismatch' | 'selfie_manipulated' | 'selfie_unverified_other') | null /** @description A human-readable message giving the reason for the failure. These messages can be shown to your users. */ - readonly reason?: string | null; - }; + readonly reason?: string | null + } /** GelatoSessionDocumentOptions */ readonly gelato_session_document_options: { /** @description 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. */ - readonly allowed_types?: readonly ("driving_license" | "id_card" | "passport")[]; + readonly allowed_types?: readonly ('driving_license' | 'id_card' | 'passport')[] /** @description 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. */ - readonly require_id_number?: boolean; + readonly require_id_number?: boolean /** @description Disable image uploads, identity document images have to be captured using the device’s camera. */ - readonly require_live_capture?: boolean; + readonly require_live_capture?: boolean /** @description 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). */ - readonly require_matching_selfie?: boolean; - }; + readonly require_matching_selfie?: boolean + } /** GelatoSessionIdNumberOptions */ - readonly gelato_session_id_number_options: { readonly [key: string]: unknown }; + readonly gelato_session_id_number_options: { readonly [key: string]: unknown } /** * GelatoSessionLastError * @description Shows last VerificationSession error @@ -4946,54 +4896,54 @@ export interface components { */ readonly code?: | ( - | "abandoned" - | "consent_declined" - | "country_not_supported" - | "device_not_supported" - | "document_expired" - | "document_type_not_supported" - | "document_unverified_other" - | "id_number_insufficient_document_data" - | "id_number_mismatch" - | "id_number_unverified_other" - | "selfie_document_missing_photo" - | "selfie_face_mismatch" - | "selfie_manipulated" - | "selfie_unverified_other" - | "under_supported_age" + | 'abandoned' + | 'consent_declined' + | 'country_not_supported' + | 'device_not_supported' + | 'document_expired' + | 'document_type_not_supported' + | 'document_unverified_other' + | 'id_number_insufficient_document_data' + | 'id_number_mismatch' + | 'id_number_unverified_other' + | 'selfie_document_missing_photo' + | 'selfie_face_mismatch' + | 'selfie_manipulated' + | 'selfie_unverified_other' + | 'under_supported_age' ) - | null; + | null /** @description A message that explains the reason for verification or user-session failure. */ - readonly reason?: string | null; - }; + readonly reason?: string | null + } /** GelatoVerificationReportOptions */ readonly gelato_verification_report_options: { - readonly document?: components["schemas"]["gelato_report_document_options"]; - readonly id_number?: components["schemas"]["gelato_report_id_number_options"]; - }; + readonly document?: components['schemas']['gelato_report_document_options'] + readonly id_number?: components['schemas']['gelato_report_id_number_options'] + } /** GelatoVerificationSessionOptions */ readonly gelato_verification_session_options: { - readonly document?: components["schemas"]["gelato_session_document_options"]; - readonly id_number?: components["schemas"]["gelato_session_id_number_options"]; - }; + readonly document?: components['schemas']['gelato_session_document_options'] + readonly id_number?: components['schemas']['gelato_session_id_number_options'] + } /** GelatoVerifiedOutputs */ readonly gelato_verified_outputs: { /** @description The user's verified address. */ - readonly address?: Partial | null; + readonly address?: Partial | null /** @description The user’s verified date of birth. */ - readonly dob?: Partial | null; + readonly dob?: Partial | null /** @description The user's verified first name. */ - readonly first_name?: string | null; + readonly first_name?: string | null /** @description The user's verified id number. */ - readonly id_number?: string | null; + readonly id_number?: string | null /** * @description The user's verified id number type. * @enum {string|null} */ - readonly id_number_type?: ("br_cpf" | "sg_nric" | "us_ssn") | null; + readonly id_number_type?: ('br_cpf' | 'sg_nric' | 'us_ssn') | null /** @description The user's verified last name. */ - readonly last_name?: string | null; - }; + readonly last_name?: string | null + } /** * GelatoVerificationReport * @description A VerificationReport is the result of an attempt to collect and verify data from a user. @@ -5008,33 +4958,33 @@ export interface components { * * Related guides: [Accessing verification results](https://stripe.com/docs/identity/verification-sessions#results). */ - readonly "identity.verification_report": { + readonly 'identity.verification_report': { /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; - readonly document?: components["schemas"]["gelato_document_report"]; + readonly created: number + readonly document?: components['schemas']['gelato_document_report'] /** @description Unique identifier for the object. */ - readonly id: string; - readonly id_number?: components["schemas"]["gelato_id_number_report"]; + readonly id: string + readonly id_number?: components['schemas']['gelato_id_number_report'] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "identity.verification_report"; - readonly options: components["schemas"]["gelato_verification_report_options"]; - readonly selfie?: components["schemas"]["gelato_selfie_report"]; + readonly object: 'identity.verification_report' + readonly options: components['schemas']['gelato_verification_report_options'] + readonly selfie?: components['schemas']['gelato_selfie_report'] /** * @description Type of report. * @enum {string} */ - readonly type: "document" | "id_number"; + readonly type: 'document' | 'id_number' /** @description ID of the VerificationSession that created this report. */ - readonly verification_session?: string | null; - }; + readonly verification_session?: string | null + } /** * GelatoVerificationSession * @description A VerificationSession guides you through the process of collecting and verifying the identities @@ -5049,49 +4999,47 @@ export interface components { * * Related guide: [The Verification Sessions API](https://stripe.com/docs/identity/verification-sessions) */ - readonly "identity.verification_session": { + readonly 'identity.verification_session': { /** @description 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. */ - readonly client_secret?: string | null; + readonly client_secret?: string | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description If present, this property tells you the last error encountered when processing the verification. */ - readonly last_error?: Partial | null; + readonly last_error?: Partial | null /** @description ID of the most recent VerificationReport. [Learn more about accessing detailed verification results.](https://stripe.com/docs/identity/verification-sessions#results) */ - readonly last_verification_report?: - | (Partial & Partial) - | null; + readonly last_verification_report?: (Partial & Partial) | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata: { readonly [key: string]: string }; + readonly metadata: { readonly [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "identity.verification_session"; - readonly options: components["schemas"]["gelato_verification_session_options"]; + readonly object: 'identity.verification_session' + readonly options: components['schemas']['gelato_verification_session_options'] /** @description Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null. */ - readonly redaction?: Partial | null; + readonly redaction?: Partial | null /** * @description Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work). * @enum {string} */ - readonly status: "canceled" | "processing" | "requires_input" | "verified"; + readonly status: 'canceled' | 'processing' | 'requires_input' | 'verified' /** * @description The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. * @enum {string} */ - readonly type: "document" | "id_number"; + readonly type: 'document' | 'id_number' /** @description 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. */ - readonly url?: string | null; + readonly url?: string | null /** @description The user’s verified data. */ - readonly verified_outputs?: Partial | null; - }; + readonly verified_outputs?: Partial | null + } /** * Invoice * @description Invoices are statements of amounts owed by a customer, and are either @@ -5129,333 +5077,325 @@ export interface components { */ readonly invoice: { /** @description The country of the business associated with this invoice, most often the business creating the invoice. */ - readonly account_country?: string | null; + readonly account_country?: string | null /** @description The public name of the business associated with this invoice, most often the business creating the invoice. */ - readonly account_name?: string | null; + readonly account_name?: string | null /** @description The account tax IDs associated with the invoice. Only editable when the invoice is a draft. */ readonly account_tax_ids?: - | readonly (Partial & - Partial & - Partial)[] - | null; + | readonly (Partial & Partial & Partial)[] + | null /** @description 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`. */ - readonly amount_due: number; + readonly amount_due: number /** @description The amount, in %s, that was paid. */ - readonly amount_paid: number; + readonly amount_paid: number /** @description The amount remaining, in %s, that is due. */ - readonly amount_remaining: number; + readonly amount_remaining: number /** @description The fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account when the invoice is paid. */ - readonly application_fee_amount?: number | null; + readonly application_fee_amount?: number | null /** @description 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. */ - readonly attempt_count: number; + readonly attempt_count: number /** @description 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. */ - readonly attempted: boolean; + readonly attempted: boolean /** @description Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice. When `false`, the invoice's state will not automatically advance without an explicit action. */ - readonly auto_advance?: boolean; - readonly automatic_tax: components["schemas"]["automatic_tax"]; + readonly auto_advance?: boolean + readonly automatic_tax: components['schemas']['automatic_tax'] /** * @description Indicates the reason why the invoice was created. `subscription_cycle` indicates an invoice created by a subscription advancing into a new period. `subscription_create` indicates an invoice created due to creating a subscription. `subscription_update` indicates an invoice created due to updating a subscription. `subscription` is set for all old invoices to indicate either a change to a subscription or a period advancement. `manual` is set for all invoices unrelated to a subscription (for example: created via the invoice editor). The `upcoming` value is reserved for simulated invoices per the upcoming invoice endpoint. `subscription_threshold` indicates an invoice created due to a billing threshold being reached. * @enum {string|null} */ readonly billing_reason?: | ( - | "automatic_pending_invoice_item_invoice" - | "manual" - | "quote_accept" - | "subscription" - | "subscription_create" - | "subscription_cycle" - | "subscription_threshold" - | "subscription_update" - | "upcoming" + | 'automatic_pending_invoice_item_invoice' + | 'manual' + | 'quote_accept' + | 'subscription' + | 'subscription_create' + | 'subscription_cycle' + | 'subscription_threshold' + | 'subscription_update' + | 'upcoming' ) - | null; + | null /** @description ID of the latest charge generated for this invoice, if any. */ - readonly charge?: (Partial & Partial) | null; + readonly charge?: (Partial & Partial) | null /** * @description 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. * @enum {string} */ - readonly collection_method: "charge_automatically" | "send_invoice"; + readonly collection_method: 'charge_automatically' | 'send_invoice' /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description Custom fields displayed on the invoice. */ - readonly custom_fields?: readonly components["schemas"]["invoice_setting_custom_field"][] | null; + readonly custom_fields?: readonly components['schemas']['invoice_setting_custom_field'][] | null /** @description The ID of the customer who will be billed. */ - readonly customer?: - | (Partial & - Partial & - Partial) - | null; + readonly customer?: (Partial & Partial & Partial) | null /** @description 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. */ - readonly customer_address?: Partial | null; + readonly customer_address?: Partial | null /** @description 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. */ - readonly customer_email?: string | null; + readonly customer_email?: string | null /** @description 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. */ - readonly customer_name?: string | null; + readonly customer_name?: string | null /** @description 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. */ - readonly customer_phone?: string | null; + readonly customer_phone?: string | null /** @description 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. */ - readonly customer_shipping?: Partial | null; + readonly customer_shipping?: Partial | null /** * @description 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. * @enum {string|null} */ - readonly customer_tax_exempt?: ("exempt" | "none" | "reverse") | null; + readonly customer_tax_exempt?: ('exempt' | 'none' | 'reverse') | null /** @description 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. */ - readonly customer_tax_ids?: readonly components["schemas"]["invoices_resource_invoice_tax_id"][] | null; + readonly customer_tax_ids?: readonly components['schemas']['invoices_resource_invoice_tax_id'][] | null /** @description 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. */ - readonly default_payment_method?: (Partial & Partial) | null; + readonly default_payment_method?: (Partial & Partial) | null /** @description 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. */ readonly default_source?: | (Partial & - Partial & - Partial & - Partial & - Partial & - Partial) - | null; + Partial & + Partial & + Partial & + Partial & + Partial) + | null /** @description The tax rates applied to this invoice, if any. */ - readonly default_tax_rates: readonly components["schemas"]["tax_rate"][]; + readonly default_tax_rates: readonly components['schemas']['tax_rate'][] /** @description An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. */ - readonly description?: string | null; + readonly description?: string | null /** @description Describes the current discount applied to this invoice, if there is one. Not populated if there are multiple discounts. */ - readonly discount?: Partial | null; + readonly discount?: Partial | null /** @description The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount. */ readonly discounts?: - | readonly (Partial & - Partial & - Partial)[] - | null; + | readonly (Partial & Partial & Partial)[] + | null /** * Format: unix-time * @description The date on which payment for this invoice is due. This value will be `null` for invoices where `collection_method=charge_automatically`. */ - readonly due_date?: number | null; + readonly due_date?: number | null /** @description 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. */ - readonly ending_balance?: number | null; + readonly ending_balance?: number | null /** @description Footer displayed on the invoice. */ - readonly footer?: string | null; + readonly footer?: string | null /** @description 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. */ - readonly hosted_invoice_url?: string | null; + readonly hosted_invoice_url?: string | null /** @description Unique identifier for the object. */ - readonly id?: string; + readonly id?: string /** @description The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null. */ - readonly invoice_pdf?: string | null; + readonly invoice_pdf?: string | null /** @description The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized. */ - readonly last_finalization_error?: Partial | null; + readonly last_finalization_error?: Partial | null /** * InvoiceLinesList * @description The individual line items that make up the invoice. `lines` is sorted as follows: invoice items in reverse chronological order, followed by the subscription, if any. */ readonly lines: { /** @description Details about each object. */ - readonly data: readonly components["schemas"]["line_item"][]; + readonly data: readonly components['schemas']['line_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; + readonly url: string + } /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata?: { readonly [key: string]: string } | null; + readonly metadata?: { readonly [key: string]: string } | null /** * Format: unix-time * @description The time at which payment will next be attempted. This value will be `null` for invoices where `collection_method=send_invoice`. */ - readonly next_payment_attempt?: number | null; + readonly next_payment_attempt?: number | null /** @description 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. */ - readonly number?: string | null; + readonly number?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "invoice"; + readonly object: 'invoice' /** @description 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. */ - readonly on_behalf_of?: (Partial & Partial) | null; + readonly on_behalf_of?: (Partial & Partial) | null /** @description 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. */ - readonly paid: boolean; + readonly paid: boolean /** @description Returns true if the invoice was manually marked paid, returns false if the invoice hasn't been paid yet or was paid on Stripe. */ - readonly paid_out_of_band: boolean; + readonly paid_out_of_band: boolean /** @description 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. */ - readonly payment_intent?: (Partial & Partial) | null; - readonly payment_settings: components["schemas"]["invoices_payment_settings"]; + readonly payment_intent?: (Partial & Partial) | null + readonly payment_settings: components['schemas']['invoices_payment_settings'] /** * Format: unix-time * @description End of the usage period during which invoice items were added to this invoice. */ - readonly period_end: number; + readonly period_end: number /** * Format: unix-time * @description Start of the usage period during which invoice items were added to this invoice. */ - readonly period_start: number; + readonly period_start: number /** @description Total amount of all post-payment credit notes issued for this invoice. */ - readonly post_payment_credit_notes_amount: number; + readonly post_payment_credit_notes_amount: number /** @description Total amount of all pre-payment credit notes issued for this invoice. */ - readonly pre_payment_credit_notes_amount: number; + readonly pre_payment_credit_notes_amount: number /** @description The quote this invoice was generated from. */ - readonly quote?: (Partial & Partial) | null; + readonly quote?: (Partial & Partial) | null /** @description This is the transaction number that appears on email receipts sent for this invoice. */ - readonly receipt_number?: string | null; + readonly receipt_number?: string | null /** @description Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. */ - readonly starting_balance: number; + readonly starting_balance: number /** @description Extra information about an invoice for the customer's credit card statement. */ - readonly statement_descriptor?: string | null; + readonly statement_descriptor?: string | null /** * @description The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview) * @enum {string|null} */ - readonly status?: ("deleted" | "draft" | "open" | "paid" | "uncollectible" | "void") | null; - readonly status_transitions: components["schemas"]["invoices_status_transitions"]; + readonly status?: ('deleted' | 'draft' | 'open' | 'paid' | 'uncollectible' | 'void') | null + readonly status_transitions: components['schemas']['invoices_status_transitions'] /** @description The subscription that this invoice was prepared for, if any. */ - readonly subscription?: (Partial & Partial) | null; + readonly subscription?: (Partial & Partial) | null /** @description Only set for upcoming invoices that preview prorations. The time used to calculate prorations. */ - readonly subscription_proration_date?: number; + readonly subscription_proration_date?: number /** @description Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated */ - readonly subtotal: number; + readonly subtotal: number /** @description The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice. */ - readonly tax?: number | null; - readonly threshold_reason?: components["schemas"]["invoice_threshold_reason"]; + readonly tax?: number | null + readonly threshold_reason?: components['schemas']['invoice_threshold_reason'] /** @description Total after discounts and taxes. */ - readonly total: number; + readonly total: number /** @description The aggregate amounts calculated per discount across all line items. */ - readonly total_discount_amounts?: readonly components["schemas"]["discounts_resource_discount_amount"][] | null; + readonly total_discount_amounts?: readonly components['schemas']['discounts_resource_discount_amount'][] | null /** @description The aggregate amounts calculated per tax rate for all line items. */ - readonly total_tax_amounts: readonly components["schemas"]["invoice_tax_amount"][]; + readonly total_tax_amounts: readonly components['schemas']['invoice_tax_amount'][] /** @description 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. */ - readonly transfer_data?: Partial | null; + readonly transfer_data?: Partial | null /** * Format: unix-time * @description 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. */ - readonly webhooks_delivered_at?: number | null; - }; + readonly webhooks_delivered_at?: number | null + } /** InvoiceItemThresholdReason */ readonly invoice_item_threshold_reason: { /** @description The IDs of the line items that triggered the threshold invoice. */ - readonly line_item_ids: readonly string[]; + readonly line_item_ids: readonly string[] /** @description The quantity threshold boundary that applied to the given line item. */ - readonly usage_gte: number; - }; + readonly usage_gte: number + } /** InvoiceLineItemPeriod */ readonly invoice_line_item_period: { /** * Format: unix-time * @description End of the line item's billing period */ - readonly end: number; + readonly end: number /** * Format: unix-time * @description Start of the line item's billing period */ - readonly start: number; - }; + readonly start: number + } /** invoice_mandate_options_card */ readonly invoice_mandate_options_card: { /** @description Amount to be charged for future payments. */ - readonly amount?: number | null; + readonly amount?: number | null /** * @description 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. * @enum {string|null} */ - readonly amount_type?: ("fixed" | "maximum") | null; + readonly amount_type?: ('fixed' | 'maximum') | null /** @description A description of the mandate or subscription that is meant to be displayed to the customer. */ - readonly description?: string | null; - }; + readonly description?: string | null + } /** invoice_payment_method_options_acss_debit */ readonly invoice_payment_method_options_acss_debit: { - readonly mandate_options?: components["schemas"]["invoice_payment_method_options_acss_debit_mandate_options"]; + readonly mandate_options?: components['schemas']['invoice_payment_method_options_acss_debit_mandate_options'] /** * @description Bank account verification method. * @enum {string} */ - readonly verification_method?: "automatic" | "instant" | "microdeposits"; - }; + readonly verification_method?: 'automatic' | 'instant' | 'microdeposits' + } /** invoice_payment_method_options_acss_debit_mandate_options */ readonly invoice_payment_method_options_acss_debit_mandate_options: { /** * @description Transaction type of the mandate. * @enum {string|null} */ - readonly transaction_type?: ("business" | "personal") | null; - }; + readonly transaction_type?: ('business' | 'personal') | null + } /** invoice_payment_method_options_bancontact */ readonly invoice_payment_method_options_bancontact: { /** * @description Preferred language of the Bancontact authorization page that the customer is redirected to. * @enum {string} */ - readonly preferred_language: "de" | "en" | "fr" | "nl"; - }; + readonly preferred_language: 'de' | 'en' | 'fr' | 'nl' + } /** invoice_payment_method_options_card */ readonly invoice_payment_method_options_card: { /** * @description 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#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. * @enum {string|null} */ - readonly request_three_d_secure?: ("any" | "automatic") | null; - }; + readonly request_three_d_secure?: ('any' | 'automatic') | null + } /** InvoiceSettingCustomField */ readonly invoice_setting_custom_field: { /** @description The name of the custom field. */ - readonly name: string; + readonly name: string /** @description The value of the custom field. */ - readonly value: string; - }; + readonly value: string + } /** InvoiceSettingCustomerSetting */ readonly invoice_setting_customer_setting: { /** @description Default custom fields to be displayed on invoices for this customer. */ - readonly custom_fields?: readonly components["schemas"]["invoice_setting_custom_field"][] | null; + readonly custom_fields?: readonly components['schemas']['invoice_setting_custom_field'][] | null /** @description 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. */ - readonly default_payment_method?: (Partial & Partial) | null; + readonly default_payment_method?: (Partial & Partial) | null /** @description Default footer to be displayed on invoices for this customer. */ - readonly footer?: string | null; - }; + readonly footer?: string | null + } /** InvoiceSettingQuoteSetting */ readonly invoice_setting_quote_setting: { /** @description 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`. */ - readonly days_until_due?: number | null; - }; + readonly days_until_due?: number | null + } /** InvoiceSettingSubscriptionScheduleSetting */ readonly invoice_setting_subscription_schedule_setting: { /** @description 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`. */ - readonly days_until_due?: number | null; - }; + readonly days_until_due?: number | null + } /** InvoiceTaxAmount */ readonly invoice_tax_amount: { /** @description The amount, in %s, of the tax. */ - readonly amount: number; + readonly amount: number /** @description Whether this tax amount is inclusive or exclusive. */ - readonly inclusive: boolean; + readonly inclusive: boolean /** @description The tax rate that was applied to get this tax amount. */ - readonly tax_rate: Partial & Partial; - }; + readonly tax_rate: Partial & Partial + } /** InvoiceThresholdReason */ readonly invoice_threshold_reason: { /** @description The total invoice amount threshold boundary if it triggered the threshold invoice. */ - readonly amount_gte?: number | null; + readonly amount_gte?: number | null /** @description Indicates which line items triggered a threshold invoice. */ - readonly item_reasons: readonly components["schemas"]["invoice_item_threshold_reason"][]; - }; + readonly item_reasons: readonly components['schemas']['invoice_item_threshold_reason'][] + } /** InvoiceTransferData */ readonly invoice_transfer_data: { /** @description The amount in %s that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination. */ - readonly amount?: number | null; + readonly amount?: number | null /** @description The account where funds from the payment will be transferred to upon payment success. */ - readonly destination: Partial & Partial; - }; + readonly destination: Partial & Partial + } /** * InvoiceItem * @description Sometimes you want to add a charge or credit to a customer, but actually @@ -5468,92 +5408,90 @@ export interface components { */ readonly invoiceitem: { /** @description Amount (in the `currency` specified) of the invoice item. This should always be equal to `unit_amount * quantity`. */ - readonly amount: number; + readonly amount: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description The ID of the customer who will be billed when this invoice item is billed. */ - readonly customer: Partial & - Partial & - Partial; + readonly customer: Partial & Partial & Partial /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly date: number; + readonly date: number /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string | null; + readonly description?: string | null /** @description If true, discounts will apply to this invoice item. Always false for prorations. */ - readonly discountable: boolean; + readonly discountable: boolean /** @description The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount. */ - readonly discounts?: readonly (Partial & Partial)[] | null; + readonly discounts?: readonly (Partial & Partial)[] | null /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description The ID of the invoice this invoice item belongs to. */ - readonly invoice?: (Partial & Partial) | null; + readonly invoice?: (Partial & Partial) | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata?: { readonly [key: string]: string } | null; + readonly metadata?: { readonly [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "invoiceitem"; - readonly period: components["schemas"]["invoice_line_item_period"]; + readonly object: 'invoiceitem' + readonly period: components['schemas']['invoice_line_item_period'] /** @description The price of the invoice item. */ - readonly price?: Partial | null; + readonly price?: Partial | null /** @description Whether the invoice item was created automatically as a proration adjustment when the customer switched plans. */ - readonly proration: boolean; + readonly proration: boolean /** @description 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. */ - readonly quantity: number; + readonly quantity: number /** @description The subscription that this invoice item has been created for, if any. */ - readonly subscription?: (Partial & Partial) | null; + readonly subscription?: (Partial & Partial) | null /** @description The subscription item that this invoice item has been created for, if any. */ - readonly subscription_item?: string; + readonly subscription_item?: string /** @description 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. */ - readonly tax_rates?: readonly components["schemas"]["tax_rate"][] | null; + readonly tax_rates?: readonly components['schemas']['tax_rate'][] | null /** @description Unit amount (in the `currency` specified) of the invoice item. */ - readonly unit_amount?: number | null; + readonly unit_amount?: number | null /** * Format: decimal * @description Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. */ - readonly unit_amount_decimal?: string | null; - }; + readonly unit_amount_decimal?: string | null + } /** InvoicesPaymentMethodOptions */ readonly invoices_payment_method_options: { /** @description 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. */ - readonly acss_debit?: Partial | null; + readonly acss_debit?: Partial | null /** @description If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent. */ - readonly bancontact?: Partial | null; + readonly bancontact?: Partial | null /** @description If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent. */ - readonly card?: Partial | null; - }; + readonly card?: Partial | null + } /** InvoicesPaymentSettings */ readonly invoices_payment_settings: { /** @description Payment-method-specific configuration to provide to the invoice’s PaymentIntent. */ - readonly payment_method_options?: Partial | null; + readonly payment_method_options?: Partial | null /** @description 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). */ readonly payment_method_types?: | readonly ( - | "ach_credit_transfer" - | "ach_debit" - | "acss_debit" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "sepa_debit" - | "sofort" - | "wechat_pay" + | 'ach_credit_transfer' + | 'ach_debit' + | 'acss_debit' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' )[] - | null; - }; + | null + } /** InvoicesResourceInvoiceTaxID */ readonly invoices_resource_invoice_tax_id: { /** @@ -5561,75 +5499,75 @@ export interface components { * @enum {string} */ readonly type: - | "ae_trn" - | "au_abn" - | "au_arn" - | "br_cnpj" - | "br_cpf" - | "ca_bn" - | "ca_gst_hst" - | "ca_pst_bc" - | "ca_pst_mb" - | "ca_pst_sk" - | "ca_qst" - | "ch_vat" - | "cl_tin" - | "es_cif" - | "eu_vat" - | "gb_vat" - | "ge_vat" - | "hk_br" - | "id_npwp" - | "il_vat" - | "in_gst" - | "is_vat" - | "jp_cn" - | "jp_rn" - | "kr_brn" - | "li_uid" - | "mx_rfc" - | "my_frp" - | "my_itn" - | "my_sst" - | "no_vat" - | "nz_gst" - | "ru_inn" - | "ru_kpp" - | "sa_vat" - | "sg_gst" - | "sg_uen" - | "th_vat" - | "tw_vat" - | "ua_vat" - | "unknown" - | "us_ein" - | "za_vat"; + | 'ae_trn' + | 'au_abn' + | 'au_arn' + | 'br_cnpj' + | 'br_cpf' + | 'ca_bn' + | 'ca_gst_hst' + | 'ca_pst_bc' + | 'ca_pst_mb' + | 'ca_pst_sk' + | 'ca_qst' + | 'ch_vat' + | 'cl_tin' + | 'es_cif' + | 'eu_vat' + | 'gb_vat' + | 'ge_vat' + | 'hk_br' + | 'id_npwp' + | 'il_vat' + | 'in_gst' + | 'is_vat' + | 'jp_cn' + | 'jp_rn' + | 'kr_brn' + | 'li_uid' + | 'mx_rfc' + | 'my_frp' + | 'my_itn' + | 'my_sst' + | 'no_vat' + | 'nz_gst' + | 'ru_inn' + | 'ru_kpp' + | 'sa_vat' + | 'sg_gst' + | 'sg_uen' + | 'th_vat' + | 'tw_vat' + | 'ua_vat' + | 'unknown' + | 'us_ein' + | 'za_vat' /** @description The value of the tax ID. */ - readonly value?: string | null; - }; + readonly value?: string | null + } /** InvoicesStatusTransitions */ readonly invoices_status_transitions: { /** * Format: unix-time * @description The time that the invoice draft was finalized. */ - readonly finalized_at?: number | null; + readonly finalized_at?: number | null /** * Format: unix-time * @description The time that the invoice was marked uncollectible. */ - readonly marked_uncollectible_at?: number | null; + readonly marked_uncollectible_at?: number | null /** * Format: unix-time * @description The time that the invoice was paid. */ - readonly paid_at?: number | null; + readonly paid_at?: number | null /** * Format: unix-time * @description The time that the invoice was voided. */ - readonly voided_at?: number | null; - }; + readonly voided_at?: number | null + } /** * IssuerFraudRecord * @description This resource has been renamed to [Early Fraud @@ -5638,30 +5576,30 @@ export interface components { */ readonly issuer_fraud_record: { /** @description An IFR 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 IFR, in order to avoid receiving a dispute later. */ - readonly actionable: boolean; + readonly actionable: boolean /** @description ID of the charge this issuer fraud record is for, optionally expanded. */ - readonly charge: Partial & Partial; + readonly charge: Partial & Partial /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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`. */ - readonly fraud_type: string; + readonly fraud_type: string /** @description If true, the associated charge is subject to [liability shift](https://stripe.com/docs/payments/3d-secure#disputed-payments). */ - readonly has_liability_shift: boolean; + readonly has_liability_shift: boolean /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "issuer_fraud_record"; + readonly object: 'issuer_fraud_record' /** @description The timestamp at which the card issuer posted the issuer fraud record. */ - readonly post_date: number; - }; + readonly post_date: number + } /** * IssuingAuthorization * @description When an [issued card](https://stripe.com/docs/issuing) is used to make a purchase, an Issuing `Authorization` @@ -5670,260 +5608,260 @@ export interface components { * * Related guide: [Issued Card Authorizations](https://stripe.com/docs/issuing/purchases/authorizations). */ - readonly "issuing.authorization": { + readonly 'issuing.authorization': { /** @description The total amount that was authorized or rejected. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ - readonly amount: number; + readonly amount: number /** @description Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ - readonly amount_details?: Partial | null; + readonly amount_details?: Partial | null /** @description Whether the authorization has been approved. */ - readonly approved: boolean; + readonly approved: boolean /** * @description How the card details were provided. * @enum {string} */ - readonly authorization_method: "chip" | "contactless" | "keyed_in" | "online" | "swipe"; + readonly authorization_method: 'chip' | 'contactless' | 'keyed_in' | 'online' | 'swipe' /** @description List of balance transactions associated with this authorization. */ - readonly balance_transactions: readonly components["schemas"]["balance_transaction"][]; - readonly card: components["schemas"]["issuing.card"]; + readonly balance_transactions: readonly components['schemas']['balance_transaction'][] + readonly card: components['schemas']['issuing.card'] /** @description The cardholder to whom this authorization belongs. */ - readonly cardholder?: (Partial & Partial) | null; + readonly cardholder?: (Partial & Partial) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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). */ - readonly merchant_amount: number; + readonly merchant_amount: number /** @description The currency that was 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). */ - readonly merchant_currency: string; - readonly merchant_data: components["schemas"]["issuing_authorization_merchant_data"]; + readonly merchant_currency: string + readonly merchant_data: components['schemas']['issuing_authorization_merchant_data'] /** @description 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. */ - readonly metadata: { readonly [key: string]: string }; + readonly metadata: { readonly [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "issuing.authorization"; + readonly object: 'issuing.authorization' /** @description The pending authorization request. This field will only be non-null during an `issuing_authorization.request` webhook. */ - readonly pending_request?: Partial | null; + readonly pending_request?: Partial | null /** @description History of every time `pending_request` was approved/denied, 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](https://stripe.com/docs/issuing/purchases/authorizations), you can look at this field to see the previous requests for the authorization. */ - readonly request_history: readonly components["schemas"]["issuing_authorization_request"][]; + readonly request_history: readonly components['schemas']['issuing_authorization_request'][] /** * @description The current status of the authorization in its lifecycle. * @enum {string} */ - readonly status: "closed" | "pending" | "reversed"; + readonly status: 'closed' | 'pending' | 'reversed' /** @description List of [transactions](https://stripe.com/docs/api/issuing/transactions) associated with this authorization. */ - readonly transactions: readonly components["schemas"]["issuing.transaction"][]; - readonly verification_data: components["schemas"]["issuing_authorization_verification_data"]; + readonly transactions: readonly components['schemas']['issuing.transaction'][] + readonly verification_data: components['schemas']['issuing_authorization_verification_data'] /** @description The digital wallet used for this authorization. One of `apple_pay`, `google_pay`, or `samsung_pay`. */ - readonly wallet?: string | null; - }; + readonly wallet?: string | null + } /** * IssuingCard * @description You can [create physical or virtual cards](https://stripe.com/docs/issuing/cards) that are issued to cardholders. */ - readonly "issuing.card": { + readonly 'issuing.card': { /** @description The brand of the card. */ - readonly brand: string; + readonly brand: string /** * @description The reason why the card was canceled. * @enum {string|null} */ - readonly cancellation_reason?: ("lost" | "stolen") | null; - readonly cardholder: components["schemas"]["issuing.cardholder"]; + readonly cancellation_reason?: ('lost' | 'stolen') | null + readonly cardholder: components['schemas']['issuing.cardholder'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description 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. */ - readonly cvc?: string; + readonly cvc?: string /** @description The expiration month of the card. */ - readonly exp_month: number; + readonly exp_month: number /** @description The expiration year of the card. */ - readonly exp_year: number; + readonly exp_year: number /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description The last 4 digits of the card number. */ - readonly last4: string; + readonly last4: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata: { readonly [key: string]: string }; + readonly metadata: { readonly [key: string]: string } /** @description 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. */ - readonly number?: string; + readonly number?: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "issuing.card"; + readonly object: 'issuing.card' /** @description The latest card that replaces this card, if any. */ - readonly replaced_by?: (Partial & Partial) | null; + readonly replaced_by?: (Partial & Partial) | null /** @description The card this card replaces, if any. */ - readonly replacement_for?: (Partial & Partial) | null; + readonly replacement_for?: (Partial & Partial) | null /** * @description The reason why the previous card needed to be replaced. * @enum {string|null} */ - readonly replacement_reason?: ("damaged" | "expired" | "lost" | "stolen") | null; + readonly replacement_reason?: ('damaged' | 'expired' | 'lost' | 'stolen') | null /** @description Where and how the card will be shipped. */ - readonly shipping?: Partial | null; - readonly spending_controls: components["schemas"]["issuing_card_authorization_controls"]; + readonly shipping?: Partial | null + readonly spending_controls: components['schemas']['issuing_card_authorization_controls'] /** * @description Whether authorizations can be approved on this card. * @enum {string} */ - readonly status: "active" | "canceled" | "inactive"; + readonly status: 'active' | 'canceled' | 'inactive' /** * @description The type of the card. * @enum {string} */ - readonly type: "physical" | "virtual"; + readonly type: 'physical' | 'virtual' /** @description Information relating to digital wallets (like Apple Pay and Google Pay). */ - readonly wallets?: Partial | null; - }; + readonly wallets?: Partial | null + } /** * IssuingCardholder * @description An Issuing `Cardholder` object represents an individual or business entity who is [issued](https://stripe.com/docs/issuing) cards. * * Related guide: [How to create a Cardholder](https://stripe.com/docs/issuing/cards#create-cardholder) */ - readonly "issuing.cardholder": { - readonly billing: components["schemas"]["issuing_cardholder_address"]; + readonly 'issuing.cardholder': { + readonly billing: components['schemas']['issuing_cardholder_address'] /** @description Additional information about a `company` cardholder. */ - readonly company?: Partial | null; + readonly company?: Partial | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description The cardholder's email address. */ - readonly email?: string | null; + readonly email?: string | null /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Additional information about an `individual` cardholder. */ - readonly individual?: Partial | null; + readonly individual?: Partial | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata: { readonly [key: string]: string }; + readonly metadata: { readonly [key: string]: string } /** @description The cardholder's name. This will be printed on cards issued to them. */ - readonly name: string; + readonly name: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "issuing.cardholder"; + readonly object: 'issuing.cardholder' /** @description 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. */ - readonly phone_number?: string | null; - readonly requirements: components["schemas"]["issuing_cardholder_requirements"]; + readonly phone_number?: string | null + readonly requirements: components['schemas']['issuing_cardholder_requirements'] /** @description Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details. */ - readonly spending_controls?: Partial | null; + readonly spending_controls?: Partial | null /** * @description Specifies whether to permit authorizations on this cardholder's cards. * @enum {string} */ - readonly status: "active" | "blocked" | "inactive"; + readonly status: 'active' | 'blocked' | 'inactive' /** * @description One of `individual` or `company`. * @enum {string} */ - readonly type: "company" | "individual"; - }; + readonly type: 'company' | 'individual' + } /** * IssuingDispute * @description 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. * * Related guide: [Disputing Transactions](https://stripe.com/docs/issuing/purchases/disputes) */ - readonly "issuing.dispute": { + readonly 'issuing.dispute': { /** @description Disputed amount. Usually the amount of the `transaction`, but can differ (usually because of currency fluctuation). */ - readonly amount: number; + readonly amount: number /** @description List of balance transactions associated with the dispute. */ - readonly balance_transactions?: readonly components["schemas"]["balance_transaction"][] | null; + readonly balance_transactions?: readonly components['schemas']['balance_transaction'][] | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description The currency the `transaction` was made in. */ - readonly currency: string; - readonly evidence: components["schemas"]["issuing_dispute_evidence"]; + readonly currency: string + readonly evidence: components['schemas']['issuing_dispute_evidence'] /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata: { readonly [key: string]: string }; + readonly metadata: { readonly [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "issuing.dispute"; + readonly object: 'issuing.dispute' /** * @description Current status of the dispute. * @enum {string} */ - readonly status: "expired" | "lost" | "submitted" | "unsubmitted" | "won"; + readonly status: 'expired' | 'lost' | 'submitted' | 'unsubmitted' | 'won' /** @description The transaction being disputed. */ - readonly transaction: Partial & Partial; - }; + readonly transaction: Partial & Partial + } /** * IssuingSettlement * @description 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. */ - readonly "issuing.settlement": { + readonly 'issuing.settlement': { /** @description The Bank Identification Number reflecting this settlement record. */ - readonly bin: string; + readonly bin: string /** @description The date that the transactions are cleared and posted to user's accounts. */ - readonly clearing_date: number; + readonly clearing_date: number /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description The total interchange received as reimbursement for the transactions. */ - readonly interchange_fees: number; + readonly interchange_fees: number /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata: { readonly [key: string]: string }; + readonly metadata: { readonly [key: string]: string } /** @description The total net amount required to settle with the network. */ - readonly net_total: number; + readonly net_total: number /** * @description The card network for this settlement report. One of ["visa"] * @enum {string} */ - readonly network: "visa"; + readonly network: 'visa' /** @description The total amount of fees owed to the network. */ - readonly network_fees: number; + readonly network_fees: number /** @description The Settlement Identification Number assigned by the network. */ - readonly network_settlement_identifier: string; + readonly network_settlement_identifier: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "issuing.settlement"; + readonly object: 'issuing.settlement' /** @description One of `international` or `uk_national_net`. */ - readonly settlement_service: string; + readonly settlement_service: string /** @description The total number of transactions reflected in this settlement. */ - readonly transaction_count: number; + readonly transaction_count: number /** @description The total transaction amount reflected in this settlement. */ - readonly transaction_volume: number; - }; + readonly transaction_volume: number + } /** * IssuingTransaction * @description Any use of an [issued card](https://stripe.com/docs/issuing) that results in funds entering or leaving @@ -5932,2669 +5870,2669 @@ export interface components { * * Related guide: [Issued Card Transactions](https://stripe.com/docs/issuing/purchases/transactions). */ - readonly "issuing.transaction": { + readonly 'issuing.transaction': { /** @description 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). */ - readonly amount: number; + readonly amount: number /** @description Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ - readonly amount_details?: Partial | null; + readonly amount_details?: Partial | null /** @description The `Authorization` object that led to this transaction. */ - readonly authorization?: (Partial & Partial) | null; + readonly authorization?: (Partial & Partial) | null /** @description ID of the [balance transaction](https://stripe.com/docs/api/balance_transactions) associated with this transaction. */ - readonly balance_transaction?: (Partial & Partial) | null; + readonly balance_transaction?: (Partial & Partial) | null /** @description The card used to make this transaction. */ - readonly card: Partial & Partial; + readonly card: Partial & Partial /** @description The cardholder to whom this transaction belongs. */ - readonly cardholder?: (Partial & Partial) | null; + readonly cardholder?: (Partial & Partial) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description If you've disputed the transaction, the ID of the dispute. */ - readonly dispute?: (Partial & Partial) | null; + readonly dispute?: (Partial & Partial) | null /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly merchant_amount: number; + readonly merchant_amount: number /** @description The currency with which the merchant is taking payment. */ - readonly merchant_currency: string; - readonly merchant_data: components["schemas"]["issuing_authorization_merchant_data"]; + readonly merchant_currency: string + readonly merchant_data: components['schemas']['issuing_authorization_merchant_data'] /** @description 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. */ - readonly metadata: { readonly [key: string]: string }; + readonly metadata: { readonly [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "issuing.transaction"; + readonly object: 'issuing.transaction' /** @description Additional purchase information that is optionally provided by the merchant. */ - readonly purchase_details?: Partial | null; + readonly purchase_details?: Partial | null /** * @description The nature of the transaction. * @enum {string} */ - readonly type: "capture" | "refund"; + readonly type: 'capture' | 'refund' /** * @description The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. * @enum {string|null} */ - readonly wallet?: ("apple_pay" | "google_pay" | "samsung_pay") | null; - }; + readonly wallet?: ('apple_pay' | 'google_pay' | 'samsung_pay') | null + } /** IssuingAuthorizationAmountDetails */ readonly issuing_authorization_amount_details: { /** @description The fee charged by the ATM for the cash withdrawal. */ - readonly atm_fee?: number | null; - }; + readonly atm_fee?: number | null + } /** IssuingAuthorizationMerchantData */ readonly issuing_authorization_merchant_data: { /** @description 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. */ - readonly category: string; + readonly category: string /** @description The merchant category code for the seller’s business */ - readonly category_code: string; + readonly category_code: string /** @description City where the seller is located */ - readonly city?: string | null; + readonly city?: string | null /** @description Country where the seller is located */ - readonly country?: string | null; + readonly country?: string | null /** @description Name of the seller */ - readonly name?: string | null; + readonly name?: string | null /** @description Identifier assigned to the seller by the card brand */ - readonly network_id: string; + readonly network_id: string /** @description Postal code where the seller is located */ - readonly postal_code?: string | null; + readonly postal_code?: string | null /** @description State where the seller is located */ - readonly state?: string | null; - }; + readonly state?: string | null + } /** IssuingAuthorizationPendingRequest */ readonly issuing_authorization_pending_request: { /** @description 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). */ - readonly amount: number; + readonly amount: number /** @description Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ - readonly amount_details?: Partial | null; + readonly amount_details?: Partial | null /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description 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. */ - readonly is_amount_controllable: boolean; + readonly is_amount_controllable: boolean /** @description 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). */ - readonly merchant_amount: number; + readonly merchant_amount: number /** @description The local currency the merchant is requesting to authorize. */ - readonly merchant_currency: string; - }; + readonly merchant_currency: string + } /** IssuingAuthorizationRequest */ readonly issuing_authorization_request: { /** @description 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. */ - readonly amount: number; + readonly amount: number /** @description Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ - readonly amount_details?: Partial | null; + readonly amount_details?: Partial | null /** @description Whether this request was approved. */ - readonly approved: boolean; + readonly approved: boolean /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description 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). */ - readonly merchant_amount: number; + readonly merchant_amount: number /** @description 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). */ - readonly merchant_currency: string; + readonly merchant_currency: string /** * @description The reason for the approval or decline. * @enum {string} */ readonly reason: - | "account_disabled" - | "card_active" - | "card_inactive" - | "cardholder_inactive" - | "cardholder_verification_required" - | "insufficient_funds" - | "not_allowed" - | "spending_controls" - | "suspected_fraud" - | "verification_failed" - | "webhook_approved" - | "webhook_declined" - | "webhook_timeout"; - }; + | 'account_disabled' + | 'card_active' + | 'card_inactive' + | 'cardholder_inactive' + | 'cardholder_verification_required' + | 'insufficient_funds' + | 'not_allowed' + | 'spending_controls' + | 'suspected_fraud' + | 'verification_failed' + | 'webhook_approved' + | 'webhook_declined' + | 'webhook_timeout' + } /** IssuingAuthorizationVerificationData */ readonly issuing_authorization_verification_data: { /** * @description Whether the cardholder provided an address first line and if it matched the cardholder’s `billing.address.line1`. * @enum {string} */ - readonly address_line1_check: "match" | "mismatch" | "not_provided"; + readonly address_line1_check: 'match' | 'mismatch' | 'not_provided' /** * @description Whether the cardholder provided a postal code and if it matched the cardholder’s `billing.address.postal_code`. * @enum {string} */ - readonly address_postal_code_check: "match" | "mismatch" | "not_provided"; + readonly address_postal_code_check: 'match' | 'mismatch' | 'not_provided' /** * @description Whether the cardholder provided a CVC and if it matched Stripe’s record. * @enum {string} */ - readonly cvc_check: "match" | "mismatch" | "not_provided"; + readonly cvc_check: 'match' | 'mismatch' | 'not_provided' /** * @description Whether the cardholder provided an expiry date and if it matched Stripe’s record. * @enum {string} */ - readonly expiry_check: "match" | "mismatch" | "not_provided"; - }; + readonly expiry_check: 'match' | 'mismatch' | 'not_provided' + } /** IssuingCardApplePay */ readonly issuing_card_apple_pay: { /** @description Apple Pay Eligibility */ - readonly eligible: boolean; + readonly eligible: boolean /** * @description Reason the card is ineligible for Apple Pay * @enum {string|null} */ - readonly ineligible_reason?: ("missing_agreement" | "missing_cardholder_contact" | "unsupported_region") | null; - }; + readonly ineligible_reason?: ('missing_agreement' | 'missing_cardholder_contact' | 'unsupported_region') | null + } /** IssuingCardAuthorizationControls */ readonly issuing_card_authorization_controls: { /** @description 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`. */ readonly allowed_categories?: | readonly ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' )[] - | null; + | null /** @description 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`. */ readonly blocked_categories?: | readonly ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' )[] - | null; + | null /** @description 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). */ - readonly spending_limits?: readonly components["schemas"]["issuing_card_spending_limit"][] | null; + readonly spending_limits?: readonly components['schemas']['issuing_card_spending_limit'][] | null /** @description Currency of the amounts within `spending_limits`. Always the same as the currency of the card. */ - readonly spending_limits_currency?: string | null; - }; + readonly spending_limits_currency?: string | null + } /** IssuingCardGooglePay */ readonly issuing_card_google_pay: { /** @description Google Pay Eligibility */ - readonly eligible: boolean; + readonly eligible: boolean /** * @description Reason the card is ineligible for Google Pay * @enum {string|null} */ - readonly ineligible_reason?: ("missing_agreement" | "missing_cardholder_contact" | "unsupported_region") | null; - }; + readonly ineligible_reason?: ('missing_agreement' | 'missing_cardholder_contact' | 'unsupported_region') | null + } /** IssuingCardShipping */ readonly issuing_card_shipping: { - readonly address: components["schemas"]["address"]; + readonly address: components['schemas']['address'] /** * @description The delivery company that shipped a card. * @enum {string|null} */ - readonly carrier?: ("dhl" | "fedex" | "royal_mail" | "usps") | null; + readonly carrier?: ('dhl' | 'fedex' | 'royal_mail' | 'usps') | null /** * Format: unix-time * @description A unix timestamp representing a best estimate of when the card will be delivered. */ - readonly eta?: number | null; + readonly eta?: number | null /** @description Recipient name. */ - readonly name: string; + readonly name: string /** * @description Shipment service, such as `standard` or `express`. * @enum {string} */ - readonly service: "express" | "priority" | "standard"; + readonly service: 'express' | 'priority' | 'standard' /** * @description The delivery status of the card. * @enum {string|null} */ - readonly status?: ("canceled" | "delivered" | "failure" | "pending" | "returned" | "shipped") | null; + readonly status?: ('canceled' | 'delivered' | 'failure' | 'pending' | 'returned' | 'shipped') | null /** @description A tracking number for a card shipment. */ - readonly tracking_number?: string | null; + readonly tracking_number?: string | null /** @description A link to the shipping carrier's site where you can view detailed information about a card shipment. */ - readonly tracking_url?: string | null; + readonly tracking_url?: string | null /** * @description Packaging options. * @enum {string} */ - readonly type: "bulk" | "individual"; - }; + readonly type: 'bulk' | 'individual' + } /** IssuingCardSpendingLimit */ readonly issuing_card_spending_limit: { /** @description Maximum amount allowed to spend per interval. */ - readonly amount: number; + readonly amount: number /** @description 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. */ readonly categories?: | readonly ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' )[] - | null; + | null /** * @description Interval (or event) to which the amount applies. * @enum {string} */ - readonly interval: "all_time" | "daily" | "monthly" | "per_authorization" | "weekly" | "yearly"; - }; + readonly interval: 'all_time' | 'daily' | 'monthly' | 'per_authorization' | 'weekly' | 'yearly' + } /** IssuingCardWallets */ readonly issuing_card_wallets: { - readonly apple_pay: components["schemas"]["issuing_card_apple_pay"]; - readonly google_pay: components["schemas"]["issuing_card_google_pay"]; + readonly apple_pay: components['schemas']['issuing_card_apple_pay'] + readonly google_pay: components['schemas']['issuing_card_google_pay'] /** @description Unique identifier for a card used with digital wallets */ - readonly primary_account_identifier?: string | null; - }; + readonly primary_account_identifier?: string | null + } /** IssuingCardholderAddress */ readonly issuing_cardholder_address: { - readonly address: components["schemas"]["address"]; - }; + readonly address: components['schemas']['address'] + } /** IssuingCardholderAuthorizationControls */ readonly issuing_cardholder_authorization_controls: { /** @description 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`. */ readonly allowed_categories?: | readonly ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' )[] - | null; + | null /** @description 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`. */ readonly blocked_categories?: | readonly ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' )[] - | null; + | null /** @description Limit spending with amount-based rules that apply across this cardholder's cards. */ - readonly spending_limits?: readonly components["schemas"]["issuing_cardholder_spending_limit"][] | null; + readonly spending_limits?: readonly components['schemas']['issuing_cardholder_spending_limit'][] | null /** @description Currency of the amounts within `spending_limits`. */ - readonly spending_limits_currency?: string | null; - }; + readonly spending_limits_currency?: string | null + } /** IssuingCardholderCompany */ readonly issuing_cardholder_company: { /** @description Whether the company's business ID number was provided. */ - readonly tax_id_provided: boolean; - }; + readonly tax_id_provided: boolean + } /** IssuingCardholderIdDocument */ readonly issuing_cardholder_id_document: { /** @description The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. */ - readonly back?: (Partial & Partial) | null; + readonly back?: (Partial & Partial) | null /** @description The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. */ - readonly front?: (Partial & Partial) | null; - }; + readonly front?: (Partial & Partial) | null + } /** IssuingCardholderIndividual */ readonly issuing_cardholder_individual: { /** @description The date of birth of this cardholder. */ - readonly dob?: Partial | null; + readonly dob?: Partial | null /** @description The first name of this cardholder. */ - readonly first_name: string; + readonly first_name: string /** @description The last name of this cardholder. */ - readonly last_name: string; + readonly last_name: string /** @description Government-issued ID document for this cardholder. */ - readonly verification?: Partial | null; - }; + readonly verification?: Partial | null + } /** IssuingCardholderIndividualDOB */ readonly issuing_cardholder_individual_dob: { /** @description The day of birth, between 1 and 31. */ - readonly day?: number | null; + readonly day?: number | null /** @description The month of birth, between 1 and 12. */ - readonly month?: number | null; + readonly month?: number | null /** @description The four-digit year of birth. */ - readonly year?: number | null; - }; + readonly year?: number | null + } /** IssuingCardholderRequirements */ readonly issuing_cardholder_requirements: { /** * @description If `disabled_reason` is present, all cards will decline authorizations with `cardholder_verification_required` reason. * @enum {string|null} */ - readonly disabled_reason?: ("listed" | "rejected.listed" | "under_review") | null; + readonly disabled_reason?: ('listed' | 'rejected.listed' | 'under_review') | null /** @description Array of fields that need to be collected in order to verify and re-enable the cardholder. */ readonly past_due?: | readonly ( - | "company.tax_id" - | "individual.dob.day" - | "individual.dob.month" - | "individual.dob.year" - | "individual.first_name" - | "individual.last_name" - | "individual.verification.document" + | 'company.tax_id' + | 'individual.dob.day' + | 'individual.dob.month' + | 'individual.dob.year' + | 'individual.first_name' + | 'individual.last_name' + | 'individual.verification.document' )[] - | null; - }; + | null + } /** IssuingCardholderSpendingLimit */ readonly issuing_cardholder_spending_limit: { /** @description Maximum amount allowed to spend per interval. */ - readonly amount: number; + readonly amount: number /** @description 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. */ readonly categories?: | readonly ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' )[] - | null; + | null /** * @description Interval (or event) to which the amount applies. * @enum {string} */ - readonly interval: "all_time" | "daily" | "monthly" | "per_authorization" | "weekly" | "yearly"; - }; + readonly interval: 'all_time' | 'daily' | 'monthly' | 'per_authorization' | 'weekly' | 'yearly' + } /** IssuingCardholderVerification */ readonly issuing_cardholder_verification: { /** @description An identifying document, either a passport or local ID card. */ - readonly document?: Partial | null; - }; + readonly document?: Partial | null + } /** IssuingDisputeCanceledEvidence */ readonly issuing_dispute_canceled_evidence: { /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ - readonly additional_documentation?: (Partial & Partial) | null; + readonly additional_documentation?: (Partial & Partial) | null /** * Format: unix-time * @description Date when order was canceled. */ - readonly canceled_at?: number | null; + readonly canceled_at?: number | null /** @description Whether the cardholder was provided with a cancellation policy. */ - readonly cancellation_policy_provided?: boolean | null; + readonly cancellation_policy_provided?: boolean | null /** @description Reason for canceling the order. */ - readonly cancellation_reason?: string | null; + readonly cancellation_reason?: string | null /** * Format: unix-time * @description Date when the cardholder expected to receive the product. */ - readonly expected_at?: number | null; + readonly expected_at?: number | null /** @description Explanation of why the cardholder is disputing this transaction. */ - readonly explanation?: string | null; + readonly explanation?: string | null /** @description Description of the merchandise or service that was purchased. */ - readonly product_description?: string | null; + readonly product_description?: string | null /** * @description Whether the product was a merchandise or service. * @enum {string|null} */ - readonly product_type?: ("merchandise" | "service") | null; + readonly product_type?: ('merchandise' | 'service') | null /** * @description Result of cardholder's attempt to return the product. * @enum {string|null} */ - readonly return_status?: ("merchant_rejected" | "successful") | null; + readonly return_status?: ('merchant_rejected' | 'successful') | null /** * Format: unix-time * @description Date when the product was returned or attempted to be returned. */ - readonly returned_at?: number | null; - }; + readonly returned_at?: number | null + } /** IssuingDisputeDuplicateEvidence */ readonly issuing_dispute_duplicate_evidence: { /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ - readonly additional_documentation?: (Partial & Partial) | null; + readonly additional_documentation?: (Partial & Partial) | null /** @description (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. */ - readonly card_statement?: (Partial & Partial) | null; + readonly card_statement?: (Partial & Partial) | null /** @description (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. */ - readonly cash_receipt?: (Partial & Partial) | null; + readonly cash_receipt?: (Partial & Partial) | null /** @description (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. */ - readonly check_image?: (Partial & Partial) | null; + readonly check_image?: (Partial & Partial) | null /** @description Explanation of why the cardholder is disputing this transaction. */ - readonly explanation?: string | null; + readonly explanation?: string | null /** @description 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. */ - readonly original_transaction?: string | null; - }; + readonly original_transaction?: string | null + } /** IssuingDisputeEvidence */ readonly issuing_dispute_evidence: { - readonly canceled?: components["schemas"]["issuing_dispute_canceled_evidence"]; - readonly duplicate?: components["schemas"]["issuing_dispute_duplicate_evidence"]; - readonly fraudulent?: components["schemas"]["issuing_dispute_fraudulent_evidence"]; - readonly merchandise_not_as_described?: components["schemas"]["issuing_dispute_merchandise_not_as_described_evidence"]; - readonly not_received?: components["schemas"]["issuing_dispute_not_received_evidence"]; - readonly other?: components["schemas"]["issuing_dispute_other_evidence"]; + readonly canceled?: components['schemas']['issuing_dispute_canceled_evidence'] + readonly duplicate?: components['schemas']['issuing_dispute_duplicate_evidence'] + readonly fraudulent?: components['schemas']['issuing_dispute_fraudulent_evidence'] + readonly merchandise_not_as_described?: components['schemas']['issuing_dispute_merchandise_not_as_described_evidence'] + readonly not_received?: components['schemas']['issuing_dispute_not_received_evidence'] + readonly other?: components['schemas']['issuing_dispute_other_evidence'] /** * @description The reason for filing the dispute. Its value will match the field containing the evidence. * @enum {string} */ readonly reason: - | "canceled" - | "duplicate" - | "fraudulent" - | "merchandise_not_as_described" - | "not_received" - | "other" - | "service_not_as_described"; - readonly service_not_as_described?: components["schemas"]["issuing_dispute_service_not_as_described_evidence"]; - }; + | 'canceled' + | 'duplicate' + | 'fraudulent' + | 'merchandise_not_as_described' + | 'not_received' + | 'other' + | 'service_not_as_described' + readonly service_not_as_described?: components['schemas']['issuing_dispute_service_not_as_described_evidence'] + } /** IssuingDisputeFraudulentEvidence */ readonly issuing_dispute_fraudulent_evidence: { /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ - readonly additional_documentation?: (Partial & Partial) | null; + readonly additional_documentation?: (Partial & Partial) | null /** @description Explanation of why the cardholder is disputing this transaction. */ - readonly explanation?: string | null; - }; + readonly explanation?: string | null + } /** IssuingDisputeMerchandiseNotAsDescribedEvidence */ readonly issuing_dispute_merchandise_not_as_described_evidence: { /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ - readonly additional_documentation?: (Partial & Partial) | null; + readonly additional_documentation?: (Partial & Partial) | null /** @description Explanation of why the cardholder is disputing this transaction. */ - readonly explanation?: string | null; + readonly explanation?: string | null /** * Format: unix-time * @description Date when the product was received. */ - readonly received_at?: number | null; + readonly received_at?: number | null /** @description Description of the cardholder's attempt to return the product. */ - readonly return_description?: string | null; + readonly return_description?: string | null /** * @description Result of cardholder's attempt to return the product. * @enum {string|null} */ - readonly return_status?: ("merchant_rejected" | "successful") | null; + readonly return_status?: ('merchant_rejected' | 'successful') | null /** * Format: unix-time * @description Date when the product was returned or attempted to be returned. */ - readonly returned_at?: number | null; - }; + readonly returned_at?: number | null + } /** IssuingDisputeNotReceivedEvidence */ readonly issuing_dispute_not_received_evidence: { /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ - readonly additional_documentation?: (Partial & Partial) | null; + readonly additional_documentation?: (Partial & Partial) | null /** * Format: unix-time * @description Date when the cardholder expected to receive the product. */ - readonly expected_at?: number | null; + readonly expected_at?: number | null /** @description Explanation of why the cardholder is disputing this transaction. */ - readonly explanation?: string | null; + readonly explanation?: string | null /** @description Description of the merchandise or service that was purchased. */ - readonly product_description?: string | null; + readonly product_description?: string | null /** * @description Whether the product was a merchandise or service. * @enum {string|null} */ - readonly product_type?: ("merchandise" | "service") | null; - }; + readonly product_type?: ('merchandise' | 'service') | null + } /** IssuingDisputeOtherEvidence */ readonly issuing_dispute_other_evidence: { /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ - readonly additional_documentation?: (Partial & Partial) | null; + readonly additional_documentation?: (Partial & Partial) | null /** @description Explanation of why the cardholder is disputing this transaction. */ - readonly explanation?: string | null; + readonly explanation?: string | null /** @description Description of the merchandise or service that was purchased. */ - readonly product_description?: string | null; + readonly product_description?: string | null /** * @description Whether the product was a merchandise or service. * @enum {string|null} */ - readonly product_type?: ("merchandise" | "service") | null; - }; + readonly product_type?: ('merchandise' | 'service') | null + } /** IssuingDisputeServiceNotAsDescribedEvidence */ readonly issuing_dispute_service_not_as_described_evidence: { /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ - readonly additional_documentation?: (Partial & Partial) | null; + readonly additional_documentation?: (Partial & Partial) | null /** * Format: unix-time * @description Date when order was canceled. */ - readonly canceled_at?: number | null; + readonly canceled_at?: number | null /** @description Reason for canceling the order. */ - readonly cancellation_reason?: string | null; + readonly cancellation_reason?: string | null /** @description Explanation of why the cardholder is disputing this transaction. */ - readonly explanation?: string | null; + readonly explanation?: string | null /** * Format: unix-time * @description Date when the product was received. */ - readonly received_at?: number | null; - }; + readonly received_at?: number | null + } /** IssuingTransactionAmountDetails */ readonly issuing_transaction_amount_details: { /** @description The fee charged by the ATM for the cash withdrawal. */ - readonly atm_fee?: number | null; - }; + readonly atm_fee?: number | null + } /** IssuingTransactionFlightData */ readonly issuing_transaction_flight_data: { /** @description The time that the flight departed. */ - readonly departure_at?: number | null; + readonly departure_at?: number | null /** @description The name of the passenger. */ - readonly passenger_name?: string | null; + readonly passenger_name?: string | null /** @description Whether the ticket is refundable. */ - readonly refundable?: boolean | null; + readonly refundable?: boolean | null /** @description The legs of the trip. */ - readonly segments?: readonly components["schemas"]["issuing_transaction_flight_data_leg"][] | null; + readonly segments?: readonly components['schemas']['issuing_transaction_flight_data_leg'][] | null /** @description The travel agency that issued the ticket. */ - readonly travel_agency?: string | null; - }; + readonly travel_agency?: string | null + } /** IssuingTransactionFlightDataLeg */ readonly issuing_transaction_flight_data_leg: { /** @description The three-letter IATA airport code of the flight's destination. */ - readonly arrival_airport_code?: string | null; + readonly arrival_airport_code?: string | null /** @description The airline carrier code. */ - readonly carrier?: string | null; + readonly carrier?: string | null /** @description The three-letter IATA airport code that the flight departed from. */ - readonly departure_airport_code?: string | null; + readonly departure_airport_code?: string | null /** @description The flight number. */ - readonly flight_number?: string | null; + readonly flight_number?: string | null /** @description The flight's service class. */ - readonly service_class?: string | null; + readonly service_class?: string | null /** @description Whether a stopover is allowed on this flight. */ - readonly stopover_allowed?: boolean | null; - }; + readonly stopover_allowed?: boolean | null + } /** IssuingTransactionFuelData */ readonly issuing_transaction_fuel_data: { /** @description The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`. */ - readonly type: string; + readonly type: string /** @description The units for `volume_decimal`. One of `us_gallon` or `liter`. */ - readonly unit: string; + readonly unit: string /** * Format: decimal * @description The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places. */ - readonly unit_cost_decimal: string; + readonly unit_cost_decimal: string /** * Format: decimal * @description The volume of the fuel that was pumped, represented as a decimal string with at most 12 decimal places. */ - readonly volume_decimal?: string | null; - }; + readonly volume_decimal?: string | null + } /** IssuingTransactionLodgingData */ readonly issuing_transaction_lodging_data: { /** @description The time of checking into the lodging. */ - readonly check_in_at?: number | null; + readonly check_in_at?: number | null /** @description The number of nights stayed at the lodging. */ - readonly nights?: number | null; - }; + readonly nights?: number | null + } /** IssuingTransactionPurchaseDetails */ readonly issuing_transaction_purchase_details: { /** @description Information about the flight that was purchased with this transaction. */ - readonly flight?: Partial | null; + readonly flight?: Partial | null /** @description Information about fuel that was purchased with this transaction. */ - readonly fuel?: Partial | null; + readonly fuel?: Partial | null /** @description Information about lodging that was purchased with this transaction. */ - readonly lodging?: Partial | null; + readonly lodging?: Partial | null /** @description The line items in the purchase. */ - readonly receipt?: readonly components["schemas"]["issuing_transaction_receipt_data"][] | null; + readonly receipt?: readonly components['schemas']['issuing_transaction_receipt_data'][] | null /** @description A merchant-specific order number. */ - readonly reference?: string | null; - }; + readonly reference?: string | null + } /** IssuingTransactionReceiptData */ readonly issuing_transaction_receipt_data: { /** @description The description of the item. The maximum length of this field is 26 characters. */ - readonly description?: string | null; + readonly description?: string | null /** @description The quantity of the item. */ - readonly quantity?: number | null; + readonly quantity?: number | null /** @description The total for this line item in cents. */ - readonly total?: number | null; + readonly total?: number | null /** @description The unit cost of the item in cents. */ - readonly unit_cost?: number | null; - }; + readonly unit_cost?: number | null + } /** * LineItem * @description A line item. */ readonly item: { /** @description Total before any discounts or taxes are applied. */ - readonly amount_subtotal: number; + readonly amount_subtotal: number /** @description Total after discounts and taxes. */ - readonly amount_total: number; + readonly amount_total: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name. */ - readonly description: string; + readonly description: string /** @description The discounts applied to the line item. */ - readonly discounts?: readonly components["schemas"]["line_items_discount_amount"][]; + readonly discounts?: readonly components['schemas']['line_items_discount_amount'][] /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "item"; + readonly object: 'item' /** @description The price used to generate the line item. */ - readonly price?: Partial | null; + readonly price?: Partial | null /** @description The quantity of products being purchased. */ - readonly quantity?: number | null; + readonly quantity?: number | null /** @description The taxes applied to the line item. */ - readonly taxes?: readonly components["schemas"]["line_items_tax_amount"][]; - }; + readonly taxes?: readonly components['schemas']['line_items_tax_amount'][] + } /** LegalEntityCompany */ readonly legal_entity_company: { - readonly address?: components["schemas"]["address"]; + readonly address?: components['schemas']['address'] /** @description The Kana variation of the company's primary address (Japan only). */ - readonly address_kana?: Partial | null; + readonly address_kana?: Partial | null /** @description The Kanji variation of the company's primary address (Japan only). */ - readonly address_kanji?: Partial | null; + readonly address_kanji?: Partial | null /** @description 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). */ - readonly directors_provided?: boolean; + readonly directors_provided?: boolean /** @description 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. */ - readonly executives_provided?: boolean; + readonly executives_provided?: boolean /** @description The company's legal name. */ - readonly name?: string | null; + readonly name?: string | null /** @description The Kana variation of the company's legal name (Japan only). */ - readonly name_kana?: string | null; + readonly name_kana?: string | null /** @description The Kanji variation of the company's legal name (Japan only). */ - readonly name_kanji?: string | null; + readonly name_kanji?: string | null /** @description 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). */ - readonly owners_provided?: boolean; + readonly owners_provided?: boolean /** @description This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct. */ - readonly ownership_declaration?: Partial | null; + readonly ownership_declaration?: Partial | null /** @description The company's phone number (used for verification). */ - readonly phone?: string | null; + readonly phone?: string | null /** * @description 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. * @enum {string} */ readonly structure?: - | "free_zone_establishment" - | "free_zone_llc" - | "government_instrumentality" - | "governmental_unit" - | "incorporated_non_profit" - | "limited_liability_partnership" - | "llc" - | "multi_member_llc" - | "private_company" - | "private_corporation" - | "private_partnership" - | "public_company" - | "public_corporation" - | "public_partnership" - | "single_member_llc" - | "sole_establishment" - | "sole_proprietorship" - | "tax_exempt_government_instrumentality" - | "unincorporated_association" - | "unincorporated_non_profit"; + | 'free_zone_establishment' + | 'free_zone_llc' + | 'government_instrumentality' + | 'governmental_unit' + | 'incorporated_non_profit' + | 'limited_liability_partnership' + | 'llc' + | 'multi_member_llc' + | 'private_company' + | 'private_corporation' + | 'private_partnership' + | 'public_company' + | 'public_corporation' + | 'public_partnership' + | 'single_member_llc' + | 'sole_establishment' + | 'sole_proprietorship' + | 'tax_exempt_government_instrumentality' + | 'unincorporated_association' + | 'unincorporated_non_profit' /** @description Whether the company's business ID number was provided. */ - readonly tax_id_provided?: boolean; + readonly tax_id_provided?: boolean /** @description The jurisdiction in which the `tax_id` is registered (Germany-based companies only). */ - readonly tax_id_registrar?: string; + readonly tax_id_registrar?: string /** @description Whether the company's business VAT number was provided. */ - readonly vat_id_provided?: boolean; + readonly vat_id_provided?: boolean /** @description Information on the verification state of the company. */ - readonly verification?: Partial | null; - }; + readonly verification?: Partial | null + } /** LegalEntityCompanyVerification */ readonly legal_entity_company_verification: { - readonly document: components["schemas"]["legal_entity_company_verification_document"]; - }; + readonly document: components['schemas']['legal_entity_company_verification_document'] + } /** LegalEntityCompanyVerificationDocument */ readonly legal_entity_company_verification_document: { /** @description The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. */ - readonly back?: (Partial & Partial) | null; + readonly back?: (Partial & Partial) | null /** @description A user-displayable string describing the verification state of this document. */ - readonly details?: string | null; + readonly details?: string | null /** @description 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. */ - readonly details_code?: string | null; + readonly details_code?: string | null /** @description The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. */ - readonly front?: (Partial & Partial) | null; - }; + readonly front?: (Partial & Partial) | null + } /** LegalEntityDOB */ readonly legal_entity_dob: { /** @description The day of birth, between 1 and 31. */ - readonly day?: number | null; + readonly day?: number | null /** @description The month of birth, between 1 and 12. */ - readonly month?: number | null; + readonly month?: number | null /** @description The four-digit year of birth. */ - readonly year?: number | null; - }; + readonly year?: number | null + } /** LegalEntityJapanAddress */ readonly legal_entity_japan_address: { /** @description City/Ward. */ - readonly city?: string | null; + readonly city?: string | null /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ - readonly country?: string | null; + readonly country?: string | null /** @description Block/Building number. */ - readonly line1?: string | null; + readonly line1?: string | null /** @description Building details. */ - readonly line2?: string | null; + readonly line2?: string | null /** @description ZIP or postal code. */ - readonly postal_code?: string | null; + readonly postal_code?: string | null /** @description Prefecture. */ - readonly state?: string | null; + readonly state?: string | null /** @description Town/cho-me. */ - readonly town?: string | null; - }; + readonly town?: string | null + } /** LegalEntityPersonVerification */ readonly legal_entity_person_verification: { /** @description A document showing address, either a passport, local ID card, or utility bill from a well-known utility company. */ - readonly additional_document?: Partial | null; + readonly additional_document?: Partial | null /** @description A user-displayable string describing the verification state for the person. For example, this may say "Provided identity information could not be verified". */ - readonly details?: string | null; + readonly details?: string | null /** @description 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. */ - readonly details_code?: string | null; - readonly document?: components["schemas"]["legal_entity_person_verification_document"]; + readonly details_code?: string | null + readonly document?: components['schemas']['legal_entity_person_verification_document'] /** @description The state of verification for the person. Possible values are `unverified`, `pending`, or `verified`. */ - readonly status: string; - }; + readonly status: string + } /** LegalEntityPersonVerificationDocument */ readonly legal_entity_person_verification_document: { /** @description The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. */ - readonly back?: (Partial & Partial) | null; + readonly back?: (Partial & Partial) | null /** @description 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". */ - readonly details?: string | null; + readonly details?: string | null /** @description 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. */ - readonly details_code?: string | null; + readonly details_code?: string | null /** @description The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. */ - readonly front?: (Partial & Partial) | null; - }; + readonly front?: (Partial & Partial) | null + } /** LegalEntityUBODeclaration */ readonly legal_entity_ubo_declaration: { /** * Format: unix-time * @description The Unix timestamp marking when the beneficial owner attestation was made. */ - readonly date?: number | null; + readonly date?: number | null /** @description The IP address from which the beneficial owner attestation was made. */ - readonly ip?: string | null; + readonly ip?: string | null /** @description The user-agent string from the browser where the beneficial owner attestation was made. */ - readonly user_agent?: string | null; - }; + readonly user_agent?: string | null + } /** InvoiceLineItem */ readonly line_item: { /** @description The amount, in %s. */ - readonly amount: number; + readonly amount: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string | null; + readonly description?: string | null /** @description The amount of discount calculated per discount for this line item. */ - readonly discount_amounts?: readonly components["schemas"]["discounts_resource_discount_amount"][] | null; + readonly discount_amounts?: readonly components['schemas']['discounts_resource_discount_amount'][] | null /** @description If true, discounts will apply to this line item. Always false for prorations. */ - readonly discountable: boolean; + readonly discountable: boolean /** @description The discounts applied to the invoice line item. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount. */ - readonly discounts?: readonly (Partial & Partial)[] | null; + readonly discounts?: readonly (Partial & Partial)[] | null /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description The ID of the [invoice item](https://stripe.com/docs/api/invoiceitems) associated with this line item if any. */ - readonly invoice_item?: string; + readonly invoice_item?: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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` this will reflect the metadata of the subscription that caused the line item to be created. */ - readonly metadata: { readonly [key: string]: string }; + readonly metadata: { readonly [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "line_item"; - readonly period: components["schemas"]["invoice_line_item_period"]; + readonly object: 'line_item' + readonly period: components['schemas']['invoice_line_item_period'] /** @description The price of the line item. */ - readonly price?: Partial | null; + readonly price?: Partial | null /** @description Whether this is a proration. */ - readonly proration: boolean; + readonly proration: boolean /** @description The quantity of the subscription, if the line item is a subscription or a proration. */ - readonly quantity?: number | null; + readonly quantity?: number | null /** @description The subscription that the invoice item pertains to, if any. */ - readonly subscription?: string | null; + readonly subscription?: string | null /** @description The subscription item that generated this invoice item. Left empty if the line item is not an explicit result of a subscription. */ - readonly subscription_item?: string; + readonly subscription_item?: string /** @description The amount of tax calculated per tax rate for this line item */ - readonly tax_amounts?: readonly components["schemas"]["invoice_tax_amount"][]; + readonly tax_amounts?: readonly components['schemas']['invoice_tax_amount'][] /** @description The tax rates which apply to the line item. */ - readonly tax_rates?: readonly components["schemas"]["tax_rate"][]; + readonly tax_rates?: readonly components['schemas']['tax_rate'][] /** * @description A string identifying the type of the source of this line item, either an `invoiceitem` or a `subscription`. * @enum {string} */ - readonly type: "invoiceitem" | "subscription"; - }; + readonly type: 'invoiceitem' | 'subscription' + } /** LineItemsDiscountAmount */ readonly line_items_discount_amount: { /** @description The amount discounted. */ - readonly amount: number; - readonly discount: components["schemas"]["discount"]; - }; + readonly amount: number + readonly discount: components['schemas']['discount'] + } /** LineItemsTaxAmount */ readonly line_items_tax_amount: { /** @description Amount of tax applied for this rate. */ - readonly amount: number; - readonly rate: components["schemas"]["tax_rate"]; - }; + readonly amount: number + readonly rate: components['schemas']['tax_rate'] + } /** LoginLink */ readonly login_link: { /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "login_link"; + readonly object: 'login_link' /** @description The URL for the login link. */ - readonly url: string; - }; + readonly url: string + } /** * Mandate * @description A Mandate is a record of the permission a customer has given you to debit their payment method. */ readonly mandate: { - readonly customer_acceptance: components["schemas"]["customer_acceptance"]; + readonly customer_acceptance: components['schemas']['customer_acceptance'] /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; - readonly multi_use?: components["schemas"]["mandate_multi_use"]; + readonly livemode: boolean + readonly multi_use?: components['schemas']['mandate_multi_use'] /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "mandate"; + readonly object: 'mandate' /** @description ID of the payment method associated with this mandate. */ - readonly payment_method: Partial & Partial; - readonly payment_method_details: components["schemas"]["mandate_payment_method_details"]; - readonly single_use?: components["schemas"]["mandate_single_use"]; + readonly payment_method: Partial & Partial + readonly payment_method_details: components['schemas']['mandate_payment_method_details'] + readonly single_use?: components['schemas']['mandate_single_use'] /** * @description The status of the mandate, which indicates whether it can be used to initiate a payment. * @enum {string} */ - readonly status: "active" | "inactive" | "pending"; + readonly status: 'active' | 'inactive' | 'pending' /** * @description The type of the mandate. * @enum {string} */ - readonly type: "multi_use" | "single_use"; - }; + readonly type: 'multi_use' | 'single_use' + } /** mandate_acss_debit */ readonly mandate_acss_debit: { /** @description List of Stripe products where this mandate can be selected automatically. */ - readonly default_for?: readonly ("invoice" | "subscription")[]; + readonly default_for?: readonly ('invoice' | 'subscription')[] /** @description Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. */ - readonly interval_description?: string | null; + readonly interval_description?: string | null /** * @description Payment schedule for the mandate. * @enum {string} */ - readonly payment_schedule: "combined" | "interval" | "sporadic"; + readonly payment_schedule: 'combined' | 'interval' | 'sporadic' /** * @description Transaction type of the mandate. * @enum {string} */ - readonly transaction_type: "business" | "personal"; - }; + readonly transaction_type: 'business' | 'personal' + } /** mandate_au_becs_debit */ readonly mandate_au_becs_debit: { /** @description The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively. */ - readonly url: string; - }; + readonly url: string + } /** mandate_bacs_debit */ readonly mandate_bacs_debit: { /** * @description The status of the mandate on the Bacs network. Can be one of `pending`, `revoked`, `refused`, or `accepted`. * @enum {string} */ - readonly network_status: "accepted" | "pending" | "refused" | "revoked"; + readonly network_status: 'accepted' | 'pending' | 'refused' | 'revoked' /** @description The unique reference identifying the mandate on the Bacs network. */ - readonly reference: string; + readonly reference: string /** @description The URL that will contain the mandate that the customer has signed. */ - readonly url: string; - }; + readonly url: string + } /** mandate_multi_use */ - readonly mandate_multi_use: { readonly [key: string]: unknown }; + readonly mandate_multi_use: { readonly [key: string]: unknown } /** mandate_payment_method_details */ readonly mandate_payment_method_details: { - readonly acss_debit?: components["schemas"]["mandate_acss_debit"]; - readonly au_becs_debit?: components["schemas"]["mandate_au_becs_debit"]; - readonly bacs_debit?: components["schemas"]["mandate_bacs_debit"]; - readonly card?: components["schemas"]["card_mandate_payment_method_details"]; - readonly sepa_debit?: components["schemas"]["mandate_sepa_debit"]; + readonly acss_debit?: components['schemas']['mandate_acss_debit'] + readonly au_becs_debit?: components['schemas']['mandate_au_becs_debit'] + readonly bacs_debit?: components['schemas']['mandate_bacs_debit'] + readonly card?: components['schemas']['card_mandate_payment_method_details'] + readonly sepa_debit?: components['schemas']['mandate_sepa_debit'] /** @description The type of the payment method associated with this mandate. An additional hash is included on `payment_method_details` with a name matching this value. It contains mandate information specific to the payment method. */ - readonly type: string; - }; + readonly type: string + } /** mandate_sepa_debit */ readonly mandate_sepa_debit: { /** @description The unique reference of the mandate. */ - readonly reference: string; + readonly reference: string /** @description The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively. */ - readonly url: string; - }; + readonly url: string + } /** mandate_single_use */ readonly mandate_single_use: { /** @description On a single use mandate, the amount of the payment. */ - readonly amount: number; + readonly amount: number /** @description On a single use mandate, the currency of the payment. */ - readonly currency: string; - }; + readonly currency: string + } /** networks */ readonly networks: { /** @description All available networks for the card. */ - readonly available: readonly string[]; + readonly available: readonly string[] /** @description The preferred network for the card. */ - readonly preferred?: string | null; - }; + readonly preferred?: string | null + } /** NotificationEventData */ readonly notification_event_data: { /** @description 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. */ - readonly object: { readonly [key: string]: unknown }; + readonly object: { readonly [key: string]: unknown } /** @description Object containing the names of the attributes that have changed, and their previous values (sent along only with *.updated events). */ - readonly previous_attributes?: { readonly [key: string]: unknown }; - }; + readonly previous_attributes?: { readonly [key: string]: unknown } + } /** NotificationEventRequest */ readonly notification_event_request: { /** @description 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. */ - readonly id?: string | null; + readonly id?: string | null /** @description The idempotency key transmitted during the request, if any. *Note: This property is populated only for events on or after May 23, 2017*. */ - readonly idempotency_key?: string | null; - }; + readonly idempotency_key?: string | null + } /** offline_acceptance */ - readonly offline_acceptance: { readonly [key: string]: unknown }; + readonly offline_acceptance: { readonly [key: string]: unknown } /** online_acceptance */ readonly online_acceptance: { /** @description The IP address from which the Mandate was accepted by the customer. */ - readonly ip_address?: string | null; + readonly ip_address?: string | null /** @description The user agent of the browser from which the Mandate was accepted by the customer. */ - readonly user_agent?: string | null; - }; + readonly user_agent?: string | null + } /** * Order * @description Order objects are created to handle end customers' purchases of previously @@ -8605,80 +8543,76 @@ export interface components { */ readonly order: { /** @description 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. */ - readonly amount: number; + readonly amount: number /** @description The total amount that was returned to the customer. */ - readonly amount_returned?: number | null; + readonly amount_returned?: number | null /** @description ID of the Connect Application that created the order. */ - readonly application?: string | null; + readonly application?: string | null /** @description A fee in cents that will be applied to the order and transferred to the application owner’s Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees documentation. */ - readonly application_fee?: number | null; + readonly application_fee?: number | null /** @description The ID of the payment used to pay for the order. Present if the order status is `paid`, `fulfilled`, or `refunded`. */ - readonly charge?: (Partial & Partial) | null; + readonly charge?: (Partial & Partial) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description The customer used for the order. */ - readonly customer?: - | (Partial & - Partial & - Partial) - | null; + readonly customer?: (Partial & Partial & Partial) | null /** @description The email address of the customer placing the order. */ - readonly email?: string | null; + readonly email?: string | null /** @description External coupon code to load for this order. */ - readonly external_coupon_code?: string; + readonly external_coupon_code?: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description List of items constituting the order. An order can have up to 25 items. */ - readonly items: readonly components["schemas"]["order_item"][]; + readonly items: readonly components['schemas']['order_item'][] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata?: { readonly [key: string]: string } | null; + readonly metadata?: { readonly [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "order"; + readonly object: 'order' /** * OrdersResourceOrderReturnList * @description A list of returns that have taken place for this order. */ readonly returns?: { /** @description Details about each object. */ - readonly data: readonly components["schemas"]["order_return"][]; + readonly data: readonly components['schemas']['order_return'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - } | null; + readonly url: string + } | null /** @description The shipping method that is currently selected for this order, if any. If present, it is equal to one of the `id`s of shipping methods in the `shipping_methods` array. At order creation time, if there are multiple shipping methods, Stripe will automatically selected the first method. */ - readonly selected_shipping_method?: string | null; + readonly selected_shipping_method?: string | null /** @description The shipping address for the order. Present if the order is for goods to be shipped. */ - readonly shipping?: Partial | null; + readonly shipping?: Partial | null /** @description A list of supported shipping methods for this order. The desired shipping method can be specified either by updating the order, or when paying it. */ - readonly shipping_methods?: readonly components["schemas"]["shipping_method"][] | null; + readonly shipping_methods?: readonly components['schemas']['shipping_method'][] | null /** @description Current order status. One of `created`, `paid`, `canceled`, `fulfilled`, or `returned`. More details in the [Orders Guide](https://stripe.com/docs/orders/guide#understanding-order-statuses). */ - readonly status: string; + readonly status: string /** @description The timestamps at which the order status was updated. */ - readonly status_transitions?: Partial | null; + readonly status_transitions?: Partial | null /** * Format: unix-time * @description Time at which the object was last updated. Measured in seconds since the Unix epoch. */ - readonly updated?: number | null; + readonly updated?: number | null /** @description The user's order ID if it is different from the Stripe order ID. */ - readonly upstream_id?: string; - }; + readonly upstream_id?: string + } /** * OrderItem * @description A representation of the constituent items of any given order. Can be used to @@ -8688,23 +8622,23 @@ export interface components { */ readonly order_item: { /** @description 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 line item. */ - readonly amount: number; + readonly amount: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description Description of the line item, meant to be displayable to the user (e.g., `"Express shipping"`). */ - readonly description: string; + readonly description: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "order_item"; + readonly object: 'order_item' /** @description The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a SKU). */ - readonly parent?: (Partial & Partial) | null; + readonly parent?: (Partial & Partial) | null /** @description A positive integer representing the number of instances of `parent` that are included in this order item. Applicable/present only if `type` is `sku`. */ - readonly quantity?: number | null; + readonly quantity?: number | null /** @description The type of line item. One of `sku`, `tax`, `shipping`, or `discount`. */ - readonly type: string; - }; + readonly type: string + } /** * OrderReturn * @description A return represents the full or partial return of a number of [order items](https://stripe.com/docs/api#order_items). @@ -8714,66 +8648,66 @@ export interface components { */ readonly order_return: { /** @description 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 returned line item. */ - readonly amount: number; + readonly amount: number /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description The items included in this order return. */ - readonly items: readonly components["schemas"]["order_item"][]; + readonly items: readonly components['schemas']['order_item'][] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "order_return"; + readonly object: 'order_return' /** @description The order that this return includes items from. */ - readonly order?: (Partial & Partial) | null; + readonly order?: (Partial & Partial) | null /** @description The ID of the refund issued for this return. */ - readonly refund?: (Partial & Partial) | null; - }; + readonly refund?: (Partial & Partial) | null + } /** PackageDimensions */ readonly package_dimensions: { /** @description Height, in inches. */ - readonly height: number; + readonly height: number /** @description Length, in inches. */ - readonly length: number; + readonly length: number /** @description Weight, in ounces. */ - readonly weight: number; + readonly weight: number /** @description Width, in inches. */ - readonly width: number; - }; + readonly width: number + } /** PaymentFlowsAutomaticPaymentMethodsPaymentIntent */ readonly payment_flows_automatic_payment_methods_payment_intent: { /** @description Automatically calculates compatible payment methods */ - readonly enabled: boolean; - }; + readonly enabled: boolean + } /** PaymentFlowsPrivatePaymentMethodsAlipay */ - readonly payment_flows_private_payment_methods_alipay: { readonly [key: string]: unknown }; + readonly payment_flows_private_payment_methods_alipay: { readonly [key: string]: unknown } /** PaymentFlowsPrivatePaymentMethodsAlipayDetails */ readonly payment_flows_private_payment_methods_alipay_details: { /** @description Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same. */ - readonly buyer_id?: string; + readonly buyer_id?: string /** @description Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same. */ - readonly fingerprint?: string | null; + readonly fingerprint?: string | null /** @description Transaction ID of this particular Alipay transaction. */ - readonly transaction_id?: string | null; - }; + readonly transaction_id?: string | null + } /** PaymentFlowsPrivatePaymentMethodsKlarnaDOB */ readonly payment_flows_private_payment_methods_klarna_dob: { /** @description The day of birth, between 1 and 31. */ - readonly day?: number | null; + readonly day?: number | null /** @description The month of birth, between 1 and 12. */ - readonly month?: number | null; + readonly month?: number | null /** @description The four-digit year of birth. */ - readonly year?: number | null; - }; + readonly year?: number | null + } /** * PaymentIntent * @description A PaymentIntent guides you through the process of collecting a payment from your customer. @@ -8790,61 +8724,51 @@ export interface components { */ readonly payment_intent: { /** @description 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). */ - readonly amount: number; + readonly amount: number /** @description Amount that can be captured from this PaymentIntent. */ - readonly amount_capturable?: number; + readonly amount_capturable?: number /** @description Amount that was collected by this PaymentIntent. */ - readonly amount_received?: number; + readonly amount_received?: number /** @description ID of the Connect application that created the PaymentIntent. */ - readonly application?: (Partial & Partial) | null; + readonly application?: (Partial & Partial) | null /** @description 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). */ - readonly application_fee_amount?: number | null; + readonly application_fee_amount?: number | null /** @description Settings to configure compatible payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods) */ - readonly automatic_payment_methods?: Partial< - components["schemas"]["payment_flows_automatic_payment_methods_payment_intent"] - > | null; + readonly automatic_payment_methods?: Partial | null /** * Format: unix-time * @description Populated when `status` is `canceled`, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch. */ - readonly canceled_at?: number | null; + readonly canceled_at?: number | null /** * @description 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`). * @enum {string|null} */ readonly cancellation_reason?: - | ( - | "abandoned" - | "automatic" - | "duplicate" - | "failed_invoice" - | "fraudulent" - | "requested_by_customer" - | "void_invoice" - ) - | null; + | ('abandoned' | 'automatic' | 'duplicate' | 'failed_invoice' | 'fraudulent' | 'requested_by_customer' | 'void_invoice') + | null /** * @description Controls when the funds will be captured from the customer's account. * @enum {string} */ - readonly capture_method: "automatic" | "manual"; + readonly capture_method: 'automatic' | 'manual' /** * PaymentFlowsPaymentIntentResourceChargeList * @description Charges that were created by this PaymentIntent, if any. */ readonly charges?: { /** @description This list only contains the latest charge, even if there were previously multiple unsuccessful charges. To view all previous charges for a PaymentIntent, you can filter the charges list using the `payment_intent` [parameter](https://stripe.com/docs/api/charges/list#list_charges-payment_intent). */ - readonly data: readonly components["schemas"]["charge"][]; + readonly data: readonly components['schemas']['charge'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; + readonly url: string + } /** * @description The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key. * @@ -8852,16 +8776,16 @@ export interface components { * * Refer to our docs to [accept a payment](https://stripe.com/docs/payments/accept-a-payment?integration=elements) and learn about how `client_secret` should be handled. */ - readonly client_secret?: string | null; + readonly client_secret?: string | null /** @enum {string} */ - readonly confirmation_method: "automatic" | "manual"; + readonly confirmation_method: 'automatic' | 'manual' /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** * @description ID of the Customer this PaymentIntent belongs to, if one exists. * @@ -8869,44 +8793,40 @@ export interface components { * * If present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. */ - readonly customer?: - | (Partial & - Partial & - Partial) - | null; + readonly customer?: (Partial & Partial & Partial) | null /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string | null; + readonly description?: string | null /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description ID of the invoice that created this PaymentIntent, if it exists. */ - readonly invoice?: (Partial & Partial) | null; + readonly invoice?: (Partial & Partial) | null /** @description The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason. */ - readonly last_payment_error?: Partial | null; + readonly last_payment_error?: Partial | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. For more information, see the [documentation](https://stripe.com/docs/payments/payment-intents/creating-payment-intents#storing-information-in-metadata). */ - readonly metadata?: { readonly [key: string]: string }; + readonly metadata?: { readonly [key: string]: string } /** @description 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. */ - readonly next_action?: Partial | null; + readonly next_action?: Partial | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "payment_intent"; + readonly object: 'payment_intent' /** @description 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. */ - readonly on_behalf_of?: (Partial & Partial) | null; + readonly on_behalf_of?: (Partial & Partial) | null /** @description ID of the payment method used in this PaymentIntent. */ - readonly payment_method?: (Partial & Partial) | null; + readonly payment_method?: (Partial & Partial) | null /** @description Payment-method-specific configuration for this PaymentIntent. */ - readonly payment_method_options?: Partial | null; + readonly payment_method_options?: Partial | null /** @description The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. */ - readonly payment_method_types: readonly string[]; + readonly payment_method_types: readonly string[] /** @description If present, this property tells you about the processing state of the payment. */ - readonly processing?: Partial | null; + readonly processing?: Partial | null /** @description 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). */ - readonly receipt_email?: string | null; + readonly receipt_email?: string | null /** @description ID of the review associated with this PaymentIntent, if any. */ - readonly review?: (Partial & Partial) | null; + readonly review?: (Partial & Partial) | null /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * @@ -8915,190 +8835,190 @@ export interface components { * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string|null} */ - readonly setup_future_usage?: ("off_session" | "on_session") | null; + readonly setup_future_usage?: ('off_session' | 'on_session') | null /** @description Shipping information for this PaymentIntent. */ - readonly shipping?: Partial | null; + readonly shipping?: Partial | null /** @description For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - readonly statement_descriptor?: string | null; + readonly statement_descriptor?: string | null /** @description Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - readonly statement_descriptor_suffix?: string | null; + readonly statement_descriptor_suffix?: string | null /** * @description 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). * @enum {string} */ readonly status: - | "canceled" - | "processing" - | "requires_action" - | "requires_capture" - | "requires_confirmation" - | "requires_payment_method" - | "succeeded"; + | 'canceled' + | 'processing' + | 'requires_action' + | 'requires_capture' + | 'requires_confirmation' + | 'requires_payment_method' + | 'succeeded' /** @description The data with which to automatically create a Transfer when the payment is finalized. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. */ - readonly transfer_data?: Partial | null; + readonly transfer_data?: Partial | null /** @description A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. */ - readonly transfer_group?: string | null; - }; + readonly transfer_group?: string | null + } /** PaymentIntentCardProcessing */ - readonly payment_intent_card_processing: { readonly [key: string]: unknown }; + readonly payment_intent_card_processing: { readonly [key: string]: unknown } /** PaymentIntentNextAction */ readonly payment_intent_next_action: { - readonly alipay_handle_redirect?: components["schemas"]["payment_intent_next_action_alipay_handle_redirect"]; - readonly boleto_display_details?: components["schemas"]["payment_intent_next_action_boleto"]; - readonly oxxo_display_details?: components["schemas"]["payment_intent_next_action_display_oxxo_details"]; - readonly redirect_to_url?: components["schemas"]["payment_intent_next_action_redirect_to_url"]; + readonly alipay_handle_redirect?: components['schemas']['payment_intent_next_action_alipay_handle_redirect'] + readonly boleto_display_details?: components['schemas']['payment_intent_next_action_boleto'] + readonly oxxo_display_details?: components['schemas']['payment_intent_next_action_display_oxxo_details'] + readonly redirect_to_url?: components['schemas']['payment_intent_next_action_redirect_to_url'] /** @description 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`. */ - readonly type: string; + readonly type: string /** @description 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. */ - readonly use_stripe_sdk?: { readonly [key: string]: unknown }; - readonly verify_with_microdeposits?: components["schemas"]["payment_intent_next_action_verify_with_microdeposits"]; - readonly wechat_pay_display_qr_code?: components["schemas"]["payment_intent_next_action_wechat_pay_display_qr_code"]; - readonly wechat_pay_redirect_to_android_app?: components["schemas"]["payment_intent_next_action_wechat_pay_redirect_to_android_app"]; - readonly wechat_pay_redirect_to_ios_app?: components["schemas"]["payment_intent_next_action_wechat_pay_redirect_to_ios_app"]; - }; + readonly use_stripe_sdk?: { readonly [key: string]: unknown } + readonly verify_with_microdeposits?: components['schemas']['payment_intent_next_action_verify_with_microdeposits'] + readonly wechat_pay_display_qr_code?: components['schemas']['payment_intent_next_action_wechat_pay_display_qr_code'] + readonly wechat_pay_redirect_to_android_app?: components['schemas']['payment_intent_next_action_wechat_pay_redirect_to_android_app'] + readonly wechat_pay_redirect_to_ios_app?: components['schemas']['payment_intent_next_action_wechat_pay_redirect_to_ios_app'] + } /** PaymentIntentNextActionAlipayHandleRedirect */ readonly payment_intent_next_action_alipay_handle_redirect: { /** @description 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. */ - readonly native_data?: string | null; + readonly native_data?: string | null /** @description The native URL you must redirect your customer to in order to authenticate the payment in an iOS App. */ - readonly native_url?: string | null; + readonly native_url?: string | null /** @description If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion. */ - readonly return_url?: string | null; + readonly return_url?: string | null /** @description The URL you must redirect your customer to in order to authenticate the payment. */ - readonly url?: string | null; - }; + readonly url?: string | null + } /** payment_intent_next_action_boleto */ readonly payment_intent_next_action_boleto: { /** * Format: unix-time * @description The timestamp after which the boleto expires. */ - readonly expires_at?: number | null; + readonly expires_at?: number | null /** @description The URL to the hosted boleto voucher page, which allows customers to view the boleto voucher. */ - readonly hosted_voucher_url?: string | null; + readonly hosted_voucher_url?: string | null /** @description The boleto number. */ - readonly number?: string | null; + readonly number?: string | null /** @description The URL to the downloadable boleto voucher PDF. */ - readonly pdf?: string | null; - }; + readonly pdf?: string | null + } /** PaymentIntentNextActionDisplayOxxoDetails */ readonly payment_intent_next_action_display_oxxo_details: { /** * Format: unix-time * @description The timestamp after which the OXXO voucher expires. */ - readonly expires_after?: number | null; + readonly expires_after?: number | null /** @description The URL for the hosted OXXO voucher page, which allows customers to view and print an OXXO voucher. */ - readonly hosted_voucher_url?: string | null; + readonly hosted_voucher_url?: string | null /** @description OXXO reference number. */ - readonly number?: string | null; - }; + readonly number?: string | null + } /** PaymentIntentNextActionRedirectToUrl */ readonly payment_intent_next_action_redirect_to_url: { /** @description If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion. */ - readonly return_url?: string | null; + readonly return_url?: string | null /** @description The URL you must redirect your customer to in order to authenticate the payment. */ - readonly url?: string | null; - }; + readonly url?: string | null + } /** PaymentIntentNextActionVerifyWithMicrodeposits */ readonly payment_intent_next_action_verify_with_microdeposits: { /** * Format: unix-time * @description The timestamp when the microdeposits are expected to land. */ - readonly arrival_date: number; + readonly arrival_date: number /** @description The URL for the hosted verification page, which allows customers to verify their bank account. */ - readonly hosted_verification_url: string; - }; + readonly hosted_verification_url: string + } /** PaymentIntentNextActionWechatPayDisplayQrCode */ readonly payment_intent_next_action_wechat_pay_display_qr_code: { /** @description The data being used to generate QR code */ - readonly data: string; + readonly data: string /** @description The base64 image data for a pre-generated QR code */ - readonly image_data_url: string; + readonly image_data_url: string /** @description The image_url_png string used to render QR code */ - readonly image_url_png: string; + readonly image_url_png: string /** @description The image_url_svg string used to render QR code */ - readonly image_url_svg: string; - }; + readonly image_url_svg: string + } /** PaymentIntentNextActionWechatPayRedirectToAndroidApp */ readonly payment_intent_next_action_wechat_pay_redirect_to_android_app: { /** @description app_id is the APP ID registered on WeChat open platform */ - readonly app_id: string; + readonly app_id: string /** @description nonce_str is a random string */ - readonly nonce_str: string; + readonly nonce_str: string /** @description package is static value */ - readonly package: string; + readonly package: string /** @description an unique merchant ID assigned by Wechat Pay */ - readonly partner_id: string; + readonly partner_id: string /** @description an unique trading ID assigned by Wechat Pay */ - readonly prepay_id: string; + readonly prepay_id: string /** @description A signature */ - readonly sign: string; + readonly sign: string /** @description Specifies the current time in epoch format */ - readonly timestamp: string; - }; + readonly timestamp: string + } /** PaymentIntentNextActionWechatPayRedirectToIOSApp */ readonly payment_intent_next_action_wechat_pay_redirect_to_ios_app: { /** @description An universal link that redirect to Wechat Pay APP */ - readonly native_url: string; - }; + readonly native_url: string + } /** PaymentIntentPaymentMethodOptions */ readonly payment_intent_payment_method_options: { - readonly acss_debit?: Partial & - Partial; - readonly afterpay_clearpay?: Partial & - Partial; - readonly alipay?: Partial & - Partial; - readonly au_becs_debit?: Partial & - Partial; - readonly bacs_debit?: Partial & - Partial; - readonly bancontact?: Partial & - Partial; - readonly boleto?: Partial & - Partial; - readonly card?: Partial & - Partial; - readonly card_present?: Partial & - Partial; - readonly eps?: Partial & - Partial; - readonly fpx?: Partial & - Partial; - readonly giropay?: Partial & - Partial; - readonly grabpay?: Partial & - Partial; - readonly ideal?: Partial & - Partial; - readonly interac_present?: Partial & - Partial; - readonly klarna?: Partial & - Partial; - readonly oxxo?: Partial & - Partial; - readonly p24?: Partial & - Partial; - readonly sepa_debit?: Partial & - Partial; - readonly sofort?: Partial & - Partial; - readonly wechat_pay?: Partial & - Partial; - }; + readonly acss_debit?: Partial & + Partial + readonly afterpay_clearpay?: Partial & + Partial + readonly alipay?: Partial & + Partial + readonly au_becs_debit?: Partial & + Partial + readonly bacs_debit?: Partial & + Partial + readonly bancontact?: Partial & + Partial + readonly boleto?: Partial & + Partial + readonly card?: Partial & + Partial + readonly card_present?: Partial & + Partial + readonly eps?: Partial & + Partial + readonly fpx?: Partial & + Partial + readonly giropay?: Partial & + Partial + readonly grabpay?: Partial & + Partial + readonly ideal?: Partial & + Partial + readonly interac_present?: Partial & + Partial + readonly klarna?: Partial & + Partial + readonly oxxo?: Partial & + Partial + readonly p24?: Partial & + Partial + readonly sepa_debit?: Partial & + Partial + readonly sofort?: Partial & + Partial + readonly wechat_pay?: Partial & + Partial + } /** payment_intent_payment_method_options_acss_debit */ readonly payment_intent_payment_method_options_acss_debit: { - readonly mandate_options?: components["schemas"]["payment_intent_payment_method_options_mandate_options_acss_debit"]; + readonly mandate_options?: components['schemas']['payment_intent_payment_method_options_mandate_options_acss_debit'] /** * @description Bank account verification method. * @enum {string} */ - readonly verification_method?: "automatic" | "instant" | "microdeposits"; - }; + readonly verification_method?: 'automatic' | 'instant' | 'microdeposits' + } /** payment_intent_payment_method_options_au_becs_debit */ - readonly payment_intent_payment_method_options_au_becs_debit: { readonly [key: string]: unknown }; + readonly payment_intent_payment_method_options_au_becs_debit: { readonly [key: string]: unknown } /** payment_intent_payment_method_options_card */ readonly payment_intent_payment_method_options_card: { /** @@ -9106,30 +9026,19 @@ export interface components { * * For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments). */ - readonly installments?: Partial | null; + readonly installments?: Partial | null /** * @description 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. * @enum {string|null} */ readonly network?: - | ( - | "amex" - | "cartes_bancaires" - | "diners" - | "discover" - | "interac" - | "jcb" - | "mastercard" - | "unionpay" - | "unknown" - | "visa" - ) - | null; + | ('amex' | 'cartes_bancaires' | 'diners' | 'discover' | 'interac' | 'jcb' | 'mastercard' | 'unionpay' | 'unknown' | 'visa') + | null /** * @description 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. Permitted values include: `automatic` or `any`. If not provided, defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. * @enum {string|null} */ - readonly request_three_d_secure?: ("any" | "automatic" | "challenge_only") | null; + readonly request_three_d_secure?: ('any' | 'automatic' | 'challenge_only') | null /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * @@ -9138,42 +9047,42 @@ export interface components { * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ - readonly setup_future_usage?: "none" | "off_session" | "on_session"; - }; + readonly setup_future_usage?: 'none' | 'off_session' | 'on_session' + } /** payment_intent_payment_method_options_eps */ - readonly payment_intent_payment_method_options_eps: { readonly [key: string]: unknown }; + readonly payment_intent_payment_method_options_eps: { readonly [key: string]: unknown } /** payment_intent_payment_method_options_mandate_options_acss_debit */ readonly payment_intent_payment_method_options_mandate_options_acss_debit: { /** @description A URL for custom mandate text */ - readonly custom_mandate_url?: string; + readonly custom_mandate_url?: string /** @description Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. */ - readonly interval_description?: string | null; + readonly interval_description?: string | null /** * @description Payment schedule for the mandate. * @enum {string|null} */ - readonly payment_schedule?: ("combined" | "interval" | "sporadic") | null; + readonly payment_schedule?: ('combined' | 'interval' | 'sporadic') | null /** * @description Transaction type of the mandate. * @enum {string|null} */ - readonly transaction_type?: ("business" | "personal") | null; - }; + readonly transaction_type?: ('business' | 'personal') | null + } /** payment_intent_payment_method_options_mandate_options_sepa_debit */ - readonly payment_intent_payment_method_options_mandate_options_sepa_debit: { readonly [key: string]: unknown }; + readonly payment_intent_payment_method_options_mandate_options_sepa_debit: { readonly [key: string]: unknown } /** payment_intent_payment_method_options_sepa_debit */ readonly payment_intent_payment_method_options_sepa_debit: { - readonly mandate_options?: components["schemas"]["payment_intent_payment_method_options_mandate_options_sepa_debit"]; - }; + readonly mandate_options?: components['schemas']['payment_intent_payment_method_options_mandate_options_sepa_debit'] + } /** PaymentIntentProcessing */ readonly payment_intent_processing: { - readonly card?: components["schemas"]["payment_intent_card_processing"]; + readonly card?: components['schemas']['payment_intent_card_processing'] /** * @description Type of the payment method for which payment is in `processing` state, one of `card`. * @enum {string} */ - readonly type: "card"; - }; + readonly type: 'card' + } /** PaymentIntentTypeSpecificPaymentMethodOptionsClient */ readonly payment_intent_type_specific_payment_method_options_client: { /** @@ -9184,8 +9093,8 @@ export interface components { * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ - readonly setup_future_usage?: "none" | "off_session" | "on_session"; - }; + readonly setup_future_usage?: 'none' | 'off_session' | 'on_session' + } /** * PaymentLink * @description A payment link is a shareable URL that will take your customers to a hosted payment page. A payment link can be shared and used multiple times. @@ -9196,349 +9105,347 @@ export interface components { */ readonly payment_link: { /** @description 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. */ - readonly active: boolean; - readonly after_completion: components["schemas"]["payment_links_resource_after_completion"]; + readonly active: boolean + readonly after_completion: components['schemas']['payment_links_resource_after_completion'] /** @description Whether user redeemable promotion codes are enabled. */ - readonly allow_promotion_codes: boolean; + readonly allow_promotion_codes: boolean /** @description 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. */ - readonly application_fee_amount?: number | null; + readonly application_fee_amount?: number | null /** @description This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. */ - readonly application_fee_percent?: number | null; - readonly automatic_tax: components["schemas"]["payment_links_resource_automatic_tax"]; + readonly application_fee_percent?: number | null + readonly automatic_tax: components['schemas']['payment_links_resource_automatic_tax'] /** * @description Configuration for collecting the customer's billing address. * @enum {string} */ - readonly billing_address_collection: "auto" | "required"; + readonly billing_address_collection: 'auto' | 'required' /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * PaymentLinksResourceListLineItems * @description The line items representing what is being sold. */ readonly line_items?: { /** @description Details about each object. */ - readonly data: readonly components["schemas"]["item"][]; + readonly data: readonly components['schemas']['item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; + readonly url: string + } /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata: { readonly [key: string]: string }; + readonly metadata: { readonly [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "payment_link"; + readonly object: 'payment_link' /** @description 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. */ - readonly on_behalf_of?: (Partial & Partial) | null; + readonly on_behalf_of?: (Partial & Partial) | null /** @description 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). */ - readonly payment_method_types?: readonly "card"[] | null; - readonly phone_number_collection: components["schemas"]["payment_links_resource_phone_number_collection"]; + readonly payment_method_types?: readonly 'card'[] | null + readonly phone_number_collection: components['schemas']['payment_links_resource_phone_number_collection'] /** @description Configuration for collecting the customer's shipping address. */ - readonly shipping_address_collection?: Partial< - components["schemas"]["payment_links_resource_shipping_address_collection"] - > | null; + readonly shipping_address_collection?: Partial | null /** @description 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`. */ - readonly subscription_data?: Partial | null; + readonly subscription_data?: Partial | null /** @description The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to. */ - readonly transfer_data?: Partial | null; + readonly transfer_data?: Partial | null /** @description The public URL that can be shared with customers. */ - readonly url: string; - }; + readonly url: string + } /** PaymentLinksResourceAfterCompletion */ readonly payment_links_resource_after_completion: { - readonly hosted_confirmation?: components["schemas"]["payment_links_resource_completion_behavior_confirmation_page"]; - readonly redirect?: components["schemas"]["payment_links_resource_completion_behavior_redirect"]; + readonly hosted_confirmation?: components['schemas']['payment_links_resource_completion_behavior_confirmation_page'] + readonly redirect?: components['schemas']['payment_links_resource_completion_behavior_redirect'] /** * @description The specified behavior after the purchase is complete. * @enum {string} */ - readonly type: "hosted_confirmation" | "redirect"; - }; + readonly type: 'hosted_confirmation' | 'redirect' + } /** PaymentLinksResourceAutomaticTax */ readonly payment_links_resource_automatic_tax: { /** @description If `true`, tax will be calculated automatically using the customer's location. */ - readonly enabled: boolean; - }; + readonly enabled: boolean + } /** PaymentLinksResourceCompletionBehaviorConfirmationPage */ readonly payment_links_resource_completion_behavior_confirmation_page: { /** @description The custom message that is displayed to the customer after the purchase is complete. */ - readonly custom_message?: string | null; - }; + readonly custom_message?: string | null + } /** PaymentLinksResourceCompletionBehaviorRedirect */ readonly payment_links_resource_completion_behavior_redirect: { /** @description The URL the customer will be redirected to after the purchase is complete. */ - readonly url: string; - }; + readonly url: string + } /** PaymentLinksResourcePhoneNumberCollection */ readonly payment_links_resource_phone_number_collection: { /** @description If `true`, a phone number will be collected during checkout. */ - readonly enabled: boolean; - }; + readonly enabled: boolean + } /** PaymentLinksResourceShippingAddressCollection */ readonly payment_links_resource_shipping_address_collection: { /** @description 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`. */ readonly allowed_countries: readonly ( - | "AC" - | "AD" - | "AE" - | "AF" - | "AG" - | "AI" - | "AL" - | "AM" - | "AO" - | "AQ" - | "AR" - | "AT" - | "AU" - | "AW" - | "AX" - | "AZ" - | "BA" - | "BB" - | "BD" - | "BE" - | "BF" - | "BG" - | "BH" - | "BI" - | "BJ" - | "BL" - | "BM" - | "BN" - | "BO" - | "BQ" - | "BR" - | "BS" - | "BT" - | "BV" - | "BW" - | "BY" - | "BZ" - | "CA" - | "CD" - | "CF" - | "CG" - | "CH" - | "CI" - | "CK" - | "CL" - | "CM" - | "CN" - | "CO" - | "CR" - | "CV" - | "CW" - | "CY" - | "CZ" - | "DE" - | "DJ" - | "DK" - | "DM" - | "DO" - | "DZ" - | "EC" - | "EE" - | "EG" - | "EH" - | "ER" - | "ES" - | "ET" - | "FI" - | "FJ" - | "FK" - | "FO" - | "FR" - | "GA" - | "GB" - | "GD" - | "GE" - | "GF" - | "GG" - | "GH" - | "GI" - | "GL" - | "GM" - | "GN" - | "GP" - | "GQ" - | "GR" - | "GS" - | "GT" - | "GU" - | "GW" - | "GY" - | "HK" - | "HN" - | "HR" - | "HT" - | "HU" - | "ID" - | "IE" - | "IL" - | "IM" - | "IN" - | "IO" - | "IQ" - | "IS" - | "IT" - | "JE" - | "JM" - | "JO" - | "JP" - | "KE" - | "KG" - | "KH" - | "KI" - | "KM" - | "KN" - | "KR" - | "KW" - | "KY" - | "KZ" - | "LA" - | "LB" - | "LC" - | "LI" - | "LK" - | "LR" - | "LS" - | "LT" - | "LU" - | "LV" - | "LY" - | "MA" - | "MC" - | "MD" - | "ME" - | "MF" - | "MG" - | "MK" - | "ML" - | "MM" - | "MN" - | "MO" - | "MQ" - | "MR" - | "MS" - | "MT" - | "MU" - | "MV" - | "MW" - | "MX" - | "MY" - | "MZ" - | "NA" - | "NC" - | "NE" - | "NG" - | "NI" - | "NL" - | "NO" - | "NP" - | "NR" - | "NU" - | "NZ" - | "OM" - | "PA" - | "PE" - | "PF" - | "PG" - | "PH" - | "PK" - | "PL" - | "PM" - | "PN" - | "PR" - | "PS" - | "PT" - | "PY" - | "QA" - | "RE" - | "RO" - | "RS" - | "RU" - | "RW" - | "SA" - | "SB" - | "SC" - | "SE" - | "SG" - | "SH" - | "SI" - | "SJ" - | "SK" - | "SL" - | "SM" - | "SN" - | "SO" - | "SR" - | "SS" - | "ST" - | "SV" - | "SX" - | "SZ" - | "TA" - | "TC" - | "TD" - | "TF" - | "TG" - | "TH" - | "TJ" - | "TK" - | "TL" - | "TM" - | "TN" - | "TO" - | "TR" - | "TT" - | "TV" - | "TW" - | "TZ" - | "UA" - | "UG" - | "US" - | "UY" - | "UZ" - | "VA" - | "VC" - | "VE" - | "VG" - | "VN" - | "VU" - | "WF" - | "WS" - | "XK" - | "YE" - | "YT" - | "ZA" - | "ZM" - | "ZW" - | "ZZ" - )[]; - }; + | 'AC' + | 'AD' + | 'AE' + | 'AF' + | 'AG' + | 'AI' + | 'AL' + | 'AM' + | 'AO' + | 'AQ' + | 'AR' + | 'AT' + | 'AU' + | 'AW' + | 'AX' + | 'AZ' + | 'BA' + | 'BB' + | 'BD' + | 'BE' + | 'BF' + | 'BG' + | 'BH' + | 'BI' + | 'BJ' + | 'BL' + | 'BM' + | 'BN' + | 'BO' + | 'BQ' + | 'BR' + | 'BS' + | 'BT' + | 'BV' + | 'BW' + | 'BY' + | 'BZ' + | 'CA' + | 'CD' + | 'CF' + | 'CG' + | 'CH' + | 'CI' + | 'CK' + | 'CL' + | 'CM' + | 'CN' + | 'CO' + | 'CR' + | 'CV' + | 'CW' + | 'CY' + | 'CZ' + | 'DE' + | 'DJ' + | 'DK' + | 'DM' + | 'DO' + | 'DZ' + | 'EC' + | 'EE' + | 'EG' + | 'EH' + | 'ER' + | 'ES' + | 'ET' + | 'FI' + | 'FJ' + | 'FK' + | 'FO' + | 'FR' + | 'GA' + | 'GB' + | 'GD' + | 'GE' + | 'GF' + | 'GG' + | 'GH' + | 'GI' + | 'GL' + | 'GM' + | 'GN' + | 'GP' + | 'GQ' + | 'GR' + | 'GS' + | 'GT' + | 'GU' + | 'GW' + | 'GY' + | 'HK' + | 'HN' + | 'HR' + | 'HT' + | 'HU' + | 'ID' + | 'IE' + | 'IL' + | 'IM' + | 'IN' + | 'IO' + | 'IQ' + | 'IS' + | 'IT' + | 'JE' + | 'JM' + | 'JO' + | 'JP' + | 'KE' + | 'KG' + | 'KH' + | 'KI' + | 'KM' + | 'KN' + | 'KR' + | 'KW' + | 'KY' + | 'KZ' + | 'LA' + | 'LB' + | 'LC' + | 'LI' + | 'LK' + | 'LR' + | 'LS' + | 'LT' + | 'LU' + | 'LV' + | 'LY' + | 'MA' + | 'MC' + | 'MD' + | 'ME' + | 'MF' + | 'MG' + | 'MK' + | 'ML' + | 'MM' + | 'MN' + | 'MO' + | 'MQ' + | 'MR' + | 'MS' + | 'MT' + | 'MU' + | 'MV' + | 'MW' + | 'MX' + | 'MY' + | 'MZ' + | 'NA' + | 'NC' + | 'NE' + | 'NG' + | 'NI' + | 'NL' + | 'NO' + | 'NP' + | 'NR' + | 'NU' + | 'NZ' + | 'OM' + | 'PA' + | 'PE' + | 'PF' + | 'PG' + | 'PH' + | 'PK' + | 'PL' + | 'PM' + | 'PN' + | 'PR' + | 'PS' + | 'PT' + | 'PY' + | 'QA' + | 'RE' + | 'RO' + | 'RS' + | 'RU' + | 'RW' + | 'SA' + | 'SB' + | 'SC' + | 'SE' + | 'SG' + | 'SH' + | 'SI' + | 'SJ' + | 'SK' + | 'SL' + | 'SM' + | 'SN' + | 'SO' + | 'SR' + | 'SS' + | 'ST' + | 'SV' + | 'SX' + | 'SZ' + | 'TA' + | 'TC' + | 'TD' + | 'TF' + | 'TG' + | 'TH' + | 'TJ' + | 'TK' + | 'TL' + | 'TM' + | 'TN' + | 'TO' + | 'TR' + | 'TT' + | 'TV' + | 'TW' + | 'TZ' + | 'UA' + | 'UG' + | 'US' + | 'UY' + | 'UZ' + | 'VA' + | 'VC' + | 'VE' + | 'VG' + | 'VN' + | 'VU' + | 'WF' + | 'WS' + | 'XK' + | 'YE' + | 'YT' + | 'ZA' + | 'ZM' + | 'ZW' + | 'ZZ' + )[] + } /** PaymentLinksResourceSubscriptionData */ readonly payment_links_resource_subscription_data: { /** @description Integer representing the number of trial period days before the customer is charged for the first time. */ - readonly trial_period_days?: number | null; - }; + readonly trial_period_days?: number | null + } /** PaymentLinksResourceTransferData */ readonly payment_links_resource_transfer_data: { /** @description The amount in %s that will be transferred to the destination account. By default, the entire amount is transferred to the destination. */ - readonly amount?: number | null; + readonly amount?: number | null /** @description The connected account receiving the transfer. */ - readonly destination: Partial & Partial; - }; + readonly destination: Partial & Partial + } /** * PaymentMethod * @description PaymentMethod objects represent your customer's payment instruments. @@ -9548,544 +9455,524 @@ export interface components { * Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios). */ readonly payment_method: { - readonly acss_debit?: components["schemas"]["payment_method_acss_debit"]; - readonly afterpay_clearpay?: components["schemas"]["payment_method_afterpay_clearpay"]; - readonly alipay?: components["schemas"]["payment_flows_private_payment_methods_alipay"]; - readonly au_becs_debit?: components["schemas"]["payment_method_au_becs_debit"]; - readonly bacs_debit?: components["schemas"]["payment_method_bacs_debit"]; - readonly bancontact?: components["schemas"]["payment_method_bancontact"]; - readonly billing_details: components["schemas"]["billing_details"]; - readonly boleto?: components["schemas"]["payment_method_boleto"]; - readonly card?: components["schemas"]["payment_method_card"]; - readonly card_present?: components["schemas"]["payment_method_card_present"]; + readonly acss_debit?: components['schemas']['payment_method_acss_debit'] + readonly afterpay_clearpay?: components['schemas']['payment_method_afterpay_clearpay'] + readonly alipay?: components['schemas']['payment_flows_private_payment_methods_alipay'] + readonly au_becs_debit?: components['schemas']['payment_method_au_becs_debit'] + readonly bacs_debit?: components['schemas']['payment_method_bacs_debit'] + readonly bancontact?: components['schemas']['payment_method_bancontact'] + readonly billing_details: components['schemas']['billing_details'] + readonly boleto?: components['schemas']['payment_method_boleto'] + readonly card?: components['schemas']['payment_method_card'] + readonly card_present?: components['schemas']['payment_method_card_present'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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. */ - readonly customer?: (Partial & Partial) | null; - readonly eps?: components["schemas"]["payment_method_eps"]; - readonly fpx?: components["schemas"]["payment_method_fpx"]; - readonly giropay?: components["schemas"]["payment_method_giropay"]; - readonly grabpay?: components["schemas"]["payment_method_grabpay"]; + readonly customer?: (Partial & Partial) | null + readonly eps?: components['schemas']['payment_method_eps'] + readonly fpx?: components['schemas']['payment_method_fpx'] + readonly giropay?: components['schemas']['payment_method_giropay'] + readonly grabpay?: components['schemas']['payment_method_grabpay'] /** @description Unique identifier for the object. */ - readonly id: string; - readonly ideal?: components["schemas"]["payment_method_ideal"]; - readonly interac_present?: components["schemas"]["payment_method_interac_present"]; - readonly klarna?: components["schemas"]["payment_method_klarna"]; + readonly id: string + readonly ideal?: components['schemas']['payment_method_ideal'] + readonly interac_present?: components['schemas']['payment_method_interac_present'] + readonly klarna?: components['schemas']['payment_method_klarna'] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata?: { readonly [key: string]: string } | null; + readonly metadata?: { readonly [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "payment_method"; - readonly oxxo?: components["schemas"]["payment_method_oxxo"]; - readonly p24?: components["schemas"]["payment_method_p24"]; - readonly sepa_debit?: components["schemas"]["payment_method_sepa_debit"]; - readonly sofort?: components["schemas"]["payment_method_sofort"]; + readonly object: 'payment_method' + readonly oxxo?: components['schemas']['payment_method_oxxo'] + readonly p24?: components['schemas']['payment_method_p24'] + readonly sepa_debit?: components['schemas']['payment_method_sepa_debit'] + readonly sofort?: components['schemas']['payment_method_sofort'] /** * @description 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. * @enum {string} */ readonly type: - | "acss_debit" - | "afterpay_clearpay" - | "alipay" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "card_present" - | "eps" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "interac_present" - | "klarna" - | "oxxo" - | "p24" - | "sepa_debit" - | "sofort" - | "wechat_pay"; - readonly wechat_pay?: components["schemas"]["payment_method_wechat_pay"]; - }; + | 'acss_debit' + | 'afterpay_clearpay' + | 'alipay' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'card_present' + | 'eps' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'interac_present' + | 'klarna' + | 'oxxo' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' + readonly wechat_pay?: components['schemas']['payment_method_wechat_pay'] + } /** payment_method_acss_debit */ readonly payment_method_acss_debit: { /** @description Name of the bank associated with the bank account. */ - readonly bank_name?: string | null; + readonly bank_name?: string | null /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - readonly fingerprint?: string | null; + readonly fingerprint?: string | null /** @description Institution number of the bank account. */ - readonly institution_number?: string | null; + readonly institution_number?: string | null /** @description Last four digits of the bank account number. */ - readonly last4?: string | null; + readonly last4?: string | null /** @description Transit number of the bank account. */ - readonly transit_number?: string | null; - }; + readonly transit_number?: string | null + } /** payment_method_afterpay_clearpay */ - readonly payment_method_afterpay_clearpay: { readonly [key: string]: unknown }; + readonly payment_method_afterpay_clearpay: { readonly [key: string]: unknown } /** payment_method_au_becs_debit */ readonly payment_method_au_becs_debit: { /** @description Six-digit number identifying bank and branch associated with this bank account. */ - readonly bsb_number?: string | null; + readonly bsb_number?: string | null /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - readonly fingerprint?: string | null; + readonly fingerprint?: string | null /** @description Last four digits of the bank account number. */ - readonly last4?: string | null; - }; + readonly last4?: string | null + } /** payment_method_bacs_debit */ readonly payment_method_bacs_debit: { /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - readonly fingerprint?: string | null; + readonly fingerprint?: string | null /** @description Last four digits of the bank account number. */ - readonly last4?: string | null; + readonly last4?: string | null /** @description Sort code of the bank account. (e.g., `10-20-30`) */ - readonly sort_code?: string | null; - }; + readonly sort_code?: string | null + } /** payment_method_bancontact */ - readonly payment_method_bancontact: { readonly [key: string]: unknown }; + readonly payment_method_bancontact: { readonly [key: string]: unknown } /** payment_method_boleto */ readonly payment_method_boleto: { /** @description Uniquely identifies the customer tax id (CNPJ or CPF) */ - readonly tax_id: string; - }; + readonly tax_id: string + } /** payment_method_card */ readonly payment_method_card: { /** @description Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ - readonly brand: string; + readonly brand: string /** @description Checks on Card address and CVC if provided. */ - readonly checks?: Partial | null; + readonly checks?: Partial | null /** @description 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. */ - readonly country?: string | null; + readonly country?: string | null /** @description Two-digit number representing the card's expiration month. */ - readonly exp_month: number; + readonly exp_month: number /** @description Four-digit number representing the card's expiration year. */ - readonly exp_year: number; + readonly exp_year: number /** * @description 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. * * *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.* */ - readonly fingerprint?: string | null; + readonly fingerprint?: string | null /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ - readonly funding: string; + readonly funding: string /** @description Details of the original PaymentMethod that created this object. */ - readonly generated_from?: Partial | null; + readonly generated_from?: Partial | null /** @description The last four digits of the card. */ - readonly last4: string; + readonly last4: string /** @description Contains information about card networks that can be used to process the payment. */ - readonly networks?: Partial | null; + readonly networks?: Partial | null /** @description Contains details on how this Card maybe be used for 3D Secure authentication. */ - readonly three_d_secure_usage?: Partial | null; + readonly three_d_secure_usage?: Partial | null /** @description If this Card is part of a card wallet, this contains the details of the card wallet. */ - readonly wallet?: Partial | null; - }; + readonly wallet?: Partial | null + } /** payment_method_card_checks */ readonly payment_method_card_checks: { /** @description If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ - readonly address_line1_check?: string | null; + readonly address_line1_check?: string | null /** @description If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ - readonly address_postal_code_check?: string | null; + readonly address_postal_code_check?: string | null /** @description If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ - readonly cvc_check?: string | null; - }; + readonly cvc_check?: string | null + } /** payment_method_card_generated_card */ readonly payment_method_card_generated_card: { /** @description The charge that created this object. */ - readonly charge?: string | null; + readonly charge?: string | null /** @description Transaction-specific details of the payment method used in the payment. */ - readonly payment_method_details?: Partial< - components["schemas"]["card_generated_from_payment_method_details"] - > | null; + readonly payment_method_details?: Partial | null /** @description The ID of the SetupAttempt that generated this PaymentMethod, if any. */ - readonly setup_attempt?: (Partial & Partial) | null; - }; + readonly setup_attempt?: (Partial & Partial) | null + } /** payment_method_card_present */ - readonly payment_method_card_present: { readonly [key: string]: unknown }; + readonly payment_method_card_present: { readonly [key: string]: unknown } /** payment_method_card_wallet */ readonly payment_method_card_wallet: { - readonly amex_express_checkout?: components["schemas"]["payment_method_card_wallet_amex_express_checkout"]; - readonly apple_pay?: components["schemas"]["payment_method_card_wallet_apple_pay"]; + readonly amex_express_checkout?: components['schemas']['payment_method_card_wallet_amex_express_checkout'] + readonly apple_pay?: components['schemas']['payment_method_card_wallet_apple_pay'] /** @description (For tokenized numbers only.) The last four digits of the device account number. */ - readonly dynamic_last4?: string | null; - readonly google_pay?: components["schemas"]["payment_method_card_wallet_google_pay"]; - readonly masterpass?: components["schemas"]["payment_method_card_wallet_masterpass"]; - readonly samsung_pay?: components["schemas"]["payment_method_card_wallet_samsung_pay"]; + readonly dynamic_last4?: string | null + readonly google_pay?: components['schemas']['payment_method_card_wallet_google_pay'] + readonly masterpass?: components['schemas']['payment_method_card_wallet_masterpass'] + readonly samsung_pay?: components['schemas']['payment_method_card_wallet_samsung_pay'] /** * @description The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, or `visa_checkout`. 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. * @enum {string} */ - readonly type: - | "amex_express_checkout" - | "apple_pay" - | "google_pay" - | "masterpass" - | "samsung_pay" - | "visa_checkout"; - readonly visa_checkout?: components["schemas"]["payment_method_card_wallet_visa_checkout"]; - }; + readonly type: 'amex_express_checkout' | 'apple_pay' | 'google_pay' | 'masterpass' | 'samsung_pay' | 'visa_checkout' + readonly visa_checkout?: components['schemas']['payment_method_card_wallet_visa_checkout'] + } /** payment_method_card_wallet_amex_express_checkout */ - readonly payment_method_card_wallet_amex_express_checkout: { readonly [key: string]: unknown }; + readonly payment_method_card_wallet_amex_express_checkout: { readonly [key: string]: unknown } /** payment_method_card_wallet_apple_pay */ - readonly payment_method_card_wallet_apple_pay: { readonly [key: string]: unknown }; + readonly payment_method_card_wallet_apple_pay: { readonly [key: string]: unknown } /** payment_method_card_wallet_google_pay */ - readonly payment_method_card_wallet_google_pay: { readonly [key: string]: unknown }; + readonly payment_method_card_wallet_google_pay: { readonly [key: string]: unknown } /** payment_method_card_wallet_masterpass */ readonly payment_method_card_wallet_masterpass: { /** @description 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. */ - readonly billing_address?: Partial | null; + readonly billing_address?: Partial | null /** @description 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. */ - readonly email?: string | null; + readonly email?: string | null /** @description 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. */ - readonly name?: string | null; + readonly name?: string | null /** @description 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. */ - readonly shipping_address?: Partial | null; - }; + readonly shipping_address?: Partial | null + } /** payment_method_card_wallet_samsung_pay */ - readonly payment_method_card_wallet_samsung_pay: { readonly [key: string]: unknown }; + readonly payment_method_card_wallet_samsung_pay: { readonly [key: string]: unknown } /** payment_method_card_wallet_visa_checkout */ readonly payment_method_card_wallet_visa_checkout: { /** @description 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. */ - readonly billing_address?: Partial | null; + readonly billing_address?: Partial | null /** @description 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. */ - readonly email?: string | null; + readonly email?: string | null /** @description 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. */ - readonly name?: string | null; + readonly name?: string | null /** @description 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. */ - readonly shipping_address?: Partial | null; - }; + readonly shipping_address?: Partial | null + } /** payment_method_details */ readonly payment_method_details: { - readonly ach_credit_transfer?: components["schemas"]["payment_method_details_ach_credit_transfer"]; - readonly ach_debit?: components["schemas"]["payment_method_details_ach_debit"]; - readonly acss_debit?: components["schemas"]["payment_method_details_acss_debit"]; - readonly afterpay_clearpay?: components["schemas"]["payment_method_details_afterpay_clearpay"]; - readonly alipay?: components["schemas"]["payment_flows_private_payment_methods_alipay_details"]; - readonly au_becs_debit?: components["schemas"]["payment_method_details_au_becs_debit"]; - readonly bacs_debit?: components["schemas"]["payment_method_details_bacs_debit"]; - readonly bancontact?: components["schemas"]["payment_method_details_bancontact"]; - readonly boleto?: components["schemas"]["payment_method_details_boleto"]; - readonly card?: components["schemas"]["payment_method_details_card"]; - readonly card_present?: components["schemas"]["payment_method_details_card_present"]; - readonly eps?: components["schemas"]["payment_method_details_eps"]; - readonly fpx?: components["schemas"]["payment_method_details_fpx"]; - readonly giropay?: components["schemas"]["payment_method_details_giropay"]; - readonly grabpay?: components["schemas"]["payment_method_details_grabpay"]; - readonly ideal?: components["schemas"]["payment_method_details_ideal"]; - readonly interac_present?: components["schemas"]["payment_method_details_interac_present"]; - readonly klarna?: components["schemas"]["payment_method_details_klarna"]; - readonly multibanco?: components["schemas"]["payment_method_details_multibanco"]; - readonly oxxo?: components["schemas"]["payment_method_details_oxxo"]; - readonly p24?: components["schemas"]["payment_method_details_p24"]; - readonly sepa_debit?: components["schemas"]["payment_method_details_sepa_debit"]; - readonly sofort?: components["schemas"]["payment_method_details_sofort"]; - readonly stripe_account?: components["schemas"]["payment_method_details_stripe_account"]; + readonly ach_credit_transfer?: components['schemas']['payment_method_details_ach_credit_transfer'] + readonly ach_debit?: components['schemas']['payment_method_details_ach_debit'] + readonly acss_debit?: components['schemas']['payment_method_details_acss_debit'] + readonly afterpay_clearpay?: components['schemas']['payment_method_details_afterpay_clearpay'] + readonly alipay?: components['schemas']['payment_flows_private_payment_methods_alipay_details'] + readonly au_becs_debit?: components['schemas']['payment_method_details_au_becs_debit'] + readonly bacs_debit?: components['schemas']['payment_method_details_bacs_debit'] + readonly bancontact?: components['schemas']['payment_method_details_bancontact'] + readonly boleto?: components['schemas']['payment_method_details_boleto'] + readonly card?: components['schemas']['payment_method_details_card'] + readonly card_present?: components['schemas']['payment_method_details_card_present'] + readonly eps?: components['schemas']['payment_method_details_eps'] + readonly fpx?: components['schemas']['payment_method_details_fpx'] + readonly giropay?: components['schemas']['payment_method_details_giropay'] + readonly grabpay?: components['schemas']['payment_method_details_grabpay'] + readonly ideal?: components['schemas']['payment_method_details_ideal'] + readonly interac_present?: components['schemas']['payment_method_details_interac_present'] + readonly klarna?: components['schemas']['payment_method_details_klarna'] + readonly multibanco?: components['schemas']['payment_method_details_multibanco'] + readonly oxxo?: components['schemas']['payment_method_details_oxxo'] + readonly p24?: components['schemas']['payment_method_details_p24'] + readonly sepa_debit?: components['schemas']['payment_method_details_sepa_debit'] + readonly sofort?: components['schemas']['payment_method_details_sofort'] + readonly stripe_account?: components['schemas']['payment_method_details_stripe_account'] /** * @description The type of transaction-specific details of the payment method used in the payment, one of `ach_credit_transfer`, `ach_debit`, `acss_debit`, `alipay`, `au_becs_debit`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `klarna`, `multibanco`, `p24`, `sepa_debit`, `sofort`, `stripe_account`, or `wechat`. * An additional hash is included on `payment_method_details` with a name matching this value. * It contains information specific to the payment method. */ - readonly type: string; - readonly wechat?: components["schemas"]["payment_method_details_wechat"]; - readonly wechat_pay?: components["schemas"]["payment_method_details_wechat_pay"]; - }; + readonly type: string + readonly wechat?: components['schemas']['payment_method_details_wechat'] + readonly wechat_pay?: components['schemas']['payment_method_details_wechat_pay'] + } /** payment_method_details_ach_credit_transfer */ readonly payment_method_details_ach_credit_transfer: { /** @description Account number to transfer funds to. */ - readonly account_number?: string | null; + readonly account_number?: string | null /** @description Name of the bank associated with the routing number. */ - readonly bank_name?: string | null; + readonly bank_name?: string | null /** @description Routing transit number for the bank account to transfer funds to. */ - readonly routing_number?: string | null; + readonly routing_number?: string | null /** @description SWIFT code of the bank associated with the routing number. */ - readonly swift_code?: string | null; - }; + readonly swift_code?: string | null + } /** payment_method_details_ach_debit */ readonly payment_method_details_ach_debit: { /** * @description Type of entity that holds the account. This can be either `individual` or `company`. * @enum {string|null} */ - readonly account_holder_type?: ("company" | "individual") | null; + readonly account_holder_type?: ('company' | 'individual') | null /** @description Name of the bank associated with the bank account. */ - readonly bank_name?: string | null; + readonly bank_name?: string | null /** @description Two-letter ISO code representing the country the bank account is located in. */ - readonly country?: string | null; + readonly country?: string | null /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - readonly fingerprint?: string | null; + readonly fingerprint?: string | null /** @description Last four digits of the bank account number. */ - readonly last4?: string | null; + readonly last4?: string | null /** @description Routing transit number of the bank account. */ - readonly routing_number?: string | null; - }; + readonly routing_number?: string | null + } /** payment_method_details_acss_debit */ readonly payment_method_details_acss_debit: { /** @description Name of the bank associated with the bank account. */ - readonly bank_name?: string | null; + readonly bank_name?: string | null /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - readonly fingerprint?: string | null; + readonly fingerprint?: string | null /** @description Institution number of the bank account */ - readonly institution_number?: string | null; + readonly institution_number?: string | null /** @description Last four digits of the bank account number. */ - readonly last4?: string | null; + readonly last4?: string | null /** @description ID of the mandate used to make this payment. */ - readonly mandate?: string; + readonly mandate?: string /** @description Transit number of the bank account. */ - readonly transit_number?: string | null; - }; + readonly transit_number?: string | null + } /** payment_method_details_afterpay_clearpay */ readonly payment_method_details_afterpay_clearpay: { /** @description Order identifier shown to the merchant in Afterpay’s online portal. */ - readonly reference?: string | null; - }; + readonly reference?: string | null + } /** payment_method_details_au_becs_debit */ readonly payment_method_details_au_becs_debit: { /** @description Bank-State-Branch number of the bank account. */ - readonly bsb_number?: string | null; + readonly bsb_number?: string | null /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - readonly fingerprint?: string | null; + readonly fingerprint?: string | null /** @description Last four digits of the bank account number. */ - readonly last4?: string | null; + readonly last4?: string | null /** @description ID of the mandate used to make this payment. */ - readonly mandate?: string; - }; + readonly mandate?: string + } /** payment_method_details_bacs_debit */ readonly payment_method_details_bacs_debit: { /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - readonly fingerprint?: string | null; + readonly fingerprint?: string | null /** @description Last four digits of the bank account number. */ - readonly last4?: string | null; + readonly last4?: string | null /** @description ID of the mandate used to make this payment. */ - readonly mandate?: string | null; + readonly mandate?: string | null /** @description Sort code of the bank account. (e.g., `10-20-30`) */ - readonly sort_code?: string | null; - }; + readonly sort_code?: string | null + } /** payment_method_details_bancontact */ readonly payment_method_details_bancontact: { /** @description Bank code of bank associated with the bank account. */ - readonly bank_code?: string | null; + readonly bank_code?: string | null /** @description Name of the bank associated with the bank account. */ - readonly bank_name?: string | null; + readonly bank_name?: string | null /** @description Bank Identifier Code of the bank associated with the bank account. */ - readonly bic?: string | null; + readonly bic?: string | null /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ - readonly generated_sepa_debit?: (Partial & Partial) | null; + readonly generated_sepa_debit?: (Partial & Partial) | null /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ - readonly generated_sepa_debit_mandate?: (Partial & Partial) | null; + readonly generated_sepa_debit_mandate?: (Partial & Partial) | null /** @description Last four characters of the IBAN. */ - readonly iban_last4?: string | null; + readonly iban_last4?: string | null /** * @description Preferred language of the Bancontact authorization page that the customer is redirected to. * Can be one of `en`, `de`, `fr`, or `nl` * @enum {string|null} */ - readonly preferred_language?: ("de" | "en" | "fr" | "nl") | null; + readonly preferred_language?: ('de' | 'en' | 'fr' | 'nl') | null /** * @description Owner's verified full name. Values are verified or provided by Bancontact directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - readonly verified_name?: string | null; - }; + readonly verified_name?: string | null + } /** payment_method_details_boleto */ readonly payment_method_details_boleto: { /** @description The tax ID of the customer (CPF for individuals consumers or CNPJ for businesses consumers) */ - readonly tax_id: string; - }; + readonly tax_id: string + } /** payment_method_details_card */ readonly payment_method_details_card: { /** @description Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ - readonly brand?: string | null; + readonly brand?: string | null /** @description Check results by Card networks on Card address and CVC at time of payment. */ - readonly checks?: Partial | null; + readonly checks?: Partial | null /** @description 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. */ - readonly country?: string | null; + readonly country?: string | null /** @description Two-digit number representing the card's expiration month. */ - readonly exp_month: number; + readonly exp_month: number /** @description Four-digit number representing the card's expiration year. */ - readonly exp_year: number; + readonly exp_year: number /** * @description 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. * * *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.* */ - readonly fingerprint?: string | null; + readonly fingerprint?: string | null /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ - readonly funding?: string | null; + readonly funding?: string | null /** * @description Installment details for this payment (Mexico only). * * For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments). */ - readonly installments?: Partial | null; + readonly installments?: Partial | null /** @description The last four digits of the card. */ - readonly last4?: string | null; + readonly last4?: string | null /** @description Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ - readonly network?: string | null; + readonly network?: string | null /** @description Populated if this transaction used 3D Secure authentication. */ - readonly three_d_secure?: Partial | null; + readonly three_d_secure?: Partial | null /** @description If this Card is part of a card wallet, this contains the details of the card wallet. */ - readonly wallet?: Partial | null; - }; + readonly wallet?: Partial | null + } /** payment_method_details_card_checks */ readonly payment_method_details_card_checks: { /** @description If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ - readonly address_line1_check?: string | null; + readonly address_line1_check?: string | null /** @description If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ - readonly address_postal_code_check?: string | null; + readonly address_postal_code_check?: string | null /** @description If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ - readonly cvc_check?: string | null; - }; + readonly cvc_check?: string | null + } /** payment_method_details_card_installments */ readonly payment_method_details_card_installments: { /** @description Installment plan selected for the payment. */ - readonly plan?: Partial | null; - }; + readonly plan?: Partial | null + } /** payment_method_details_card_installments_plan */ readonly payment_method_details_card_installments_plan: { /** @description For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card. */ - readonly count?: number | null; + readonly count?: number | null /** * @description For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card. * One of `month`. * @enum {string|null} */ - readonly interval?: "month" | null; + readonly interval?: 'month' | null /** * @description Type of installment plan, one of `fixed_count`. * @enum {string} */ - readonly type: "fixed_count"; - }; + readonly type: 'fixed_count' + } /** payment_method_details_card_present */ readonly payment_method_details_card_present: { /** @description The authorized amount */ - readonly amount_authorized?: number | null; + readonly amount_authorized?: number | null /** @description Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ - readonly brand?: string | null; + readonly brand?: string | null /** @description 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. */ - readonly cardholder_name?: string | null; + readonly cardholder_name?: string | null /** @description 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. */ - readonly country?: string | null; + readonly country?: string | null /** @description Authorization response cryptogram. */ - readonly emv_auth_data?: string | null; + readonly emv_auth_data?: string | null /** @description Two-digit number representing the card's expiration month. */ - readonly exp_month: number; + readonly exp_month: number /** @description Four-digit number representing the card's expiration year. */ - readonly exp_year: number; + readonly exp_year: number /** * @description 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. * * *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.* */ - readonly fingerprint?: string | null; + readonly fingerprint?: string | null /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ - readonly funding?: string | null; + readonly funding?: string | null /** @description 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. */ - readonly generated_card?: string | null; + readonly generated_card?: string | null /** @description The last four digits of the card. */ - readonly last4?: string | null; + readonly last4?: string | null /** @description Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ - readonly network?: string | null; + readonly network?: string | null /** @description Defines whether the authorized amount can be over-captured or not */ - readonly overcapture_supported?: boolean | null; + readonly overcapture_supported?: boolean | null /** * @description How card details were read in this transaction. * @enum {string|null} */ readonly read_method?: - | ( - | "contact_emv" - | "contactless_emv" - | "contactless_magstripe_mode" - | "magnetic_stripe_fallback" - | "magnetic_stripe_track2" - ) - | null; + | ('contact_emv' | 'contactless_emv' | 'contactless_magstripe_mode' | 'magnetic_stripe_fallback' | 'magnetic_stripe_track2') + | null /** @description A collection of fields required to be displayed on receipts. Only required for EMV transactions. */ - readonly receipt?: Partial | null; - }; + readonly receipt?: Partial | null + } /** payment_method_details_card_present_receipt */ readonly payment_method_details_card_present_receipt: { /** * @description The type of account being debited or credited * @enum {string} */ - readonly account_type?: "checking" | "credit" | "prepaid" | "unknown"; + readonly account_type?: 'checking' | 'credit' | 'prepaid' | 'unknown' /** @description EMV tag 9F26, cryptogram generated by the integrated circuit chip. */ - readonly application_cryptogram?: string | null; + readonly application_cryptogram?: string | null /** @description Mnenomic of the Application Identifier. */ - readonly application_preferred_name?: string | null; + readonly application_preferred_name?: string | null /** @description Identifier for this transaction. */ - readonly authorization_code?: string | null; + readonly authorization_code?: string | null /** @description EMV tag 8A. A code returned by the card issuer. */ - readonly authorization_response_code?: string | null; + readonly authorization_response_code?: string | null /** @description How the cardholder verified ownership of the card. */ - readonly cardholder_verification_method?: string | null; + readonly cardholder_verification_method?: string | null /** @description EMV tag 84. Similar to the application identifier stored on the integrated circuit chip. */ - readonly dedicated_file_name?: string | null; + readonly dedicated_file_name?: string | null /** @description The outcome of a series of EMV functions performed by the card reader. */ - readonly terminal_verification_results?: string | null; + readonly terminal_verification_results?: string | null /** @description An indication of various EMV functions performed during the transaction. */ - readonly transaction_status_information?: string | null; - }; + readonly transaction_status_information?: string | null + } /** payment_method_details_card_wallet */ readonly payment_method_details_card_wallet: { - readonly amex_express_checkout?: components["schemas"]["payment_method_details_card_wallet_amex_express_checkout"]; - readonly apple_pay?: components["schemas"]["payment_method_details_card_wallet_apple_pay"]; + readonly amex_express_checkout?: components['schemas']['payment_method_details_card_wallet_amex_express_checkout'] + readonly apple_pay?: components['schemas']['payment_method_details_card_wallet_apple_pay'] /** @description (For tokenized numbers only.) The last four digits of the device account number. */ - readonly dynamic_last4?: string | null; - readonly google_pay?: components["schemas"]["payment_method_details_card_wallet_google_pay"]; - readonly masterpass?: components["schemas"]["payment_method_details_card_wallet_masterpass"]; - readonly samsung_pay?: components["schemas"]["payment_method_details_card_wallet_samsung_pay"]; + readonly dynamic_last4?: string | null + readonly google_pay?: components['schemas']['payment_method_details_card_wallet_google_pay'] + readonly masterpass?: components['schemas']['payment_method_details_card_wallet_masterpass'] + readonly samsung_pay?: components['schemas']['payment_method_details_card_wallet_samsung_pay'] /** * @description The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, or `visa_checkout`. 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. * @enum {string} */ - readonly type: - | "amex_express_checkout" - | "apple_pay" - | "google_pay" - | "masterpass" - | "samsung_pay" - | "visa_checkout"; - readonly visa_checkout?: components["schemas"]["payment_method_details_card_wallet_visa_checkout"]; - }; + readonly type: 'amex_express_checkout' | 'apple_pay' | 'google_pay' | 'masterpass' | 'samsung_pay' | 'visa_checkout' + readonly visa_checkout?: components['schemas']['payment_method_details_card_wallet_visa_checkout'] + } /** payment_method_details_card_wallet_amex_express_checkout */ - readonly payment_method_details_card_wallet_amex_express_checkout: { readonly [key: string]: unknown }; + readonly payment_method_details_card_wallet_amex_express_checkout: { readonly [key: string]: unknown } /** payment_method_details_card_wallet_apple_pay */ - readonly payment_method_details_card_wallet_apple_pay: { readonly [key: string]: unknown }; + readonly payment_method_details_card_wallet_apple_pay: { readonly [key: string]: unknown } /** payment_method_details_card_wallet_google_pay */ - readonly payment_method_details_card_wallet_google_pay: { readonly [key: string]: unknown }; + readonly payment_method_details_card_wallet_google_pay: { readonly [key: string]: unknown } /** payment_method_details_card_wallet_masterpass */ readonly payment_method_details_card_wallet_masterpass: { /** @description 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. */ - readonly billing_address?: Partial | null; + readonly billing_address?: Partial | null /** @description 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. */ - readonly email?: string | null; + readonly email?: string | null /** @description 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. */ - readonly name?: string | null; + readonly name?: string | null /** @description 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. */ - readonly shipping_address?: Partial | null; - }; + readonly shipping_address?: Partial | null + } /** payment_method_details_card_wallet_samsung_pay */ - readonly payment_method_details_card_wallet_samsung_pay: { readonly [key: string]: unknown }; + readonly payment_method_details_card_wallet_samsung_pay: { readonly [key: string]: unknown } /** payment_method_details_card_wallet_visa_checkout */ readonly payment_method_details_card_wallet_visa_checkout: { /** @description 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. */ - readonly billing_address?: Partial | null; + readonly billing_address?: Partial | null /** @description 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. */ - readonly email?: string | null; + readonly email?: string | null /** @description 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. */ - readonly name?: string | null; + readonly name?: string | null /** @description 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. */ - readonly shipping_address?: Partial | null; - }; + readonly shipping_address?: Partial | null + } /** payment_method_details_eps */ readonly payment_method_details_eps: { /** @@ -10094,42 +9981,42 @@ export interface components { */ readonly bank?: | ( - | "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" - | "dolomitenbank" - | "easybank_ag" - | "erste_bank_und_sparkassen" - | "hypo_alpeadriabank_international_ag" - | "hypo_bank_burgenland_aktiengesellschaft" - | "hypo_noe_lb_fur_niederosterreich_u_wien" - | "hypo_oberosterreich_salzburg_steiermark" - | "hypo_tirol_bank_ag" - | "hypo_vorarlberg_bank_ag" - | "marchfelder_bank" - | "oberbank_ag" - | "raiffeisen_bankengruppe_osterreich" - | "schoellerbank_ag" - | "sparda_bank_wien" - | "volksbank_gruppe" - | "volkskreditbank_ag" - | "vr_bank_braunau" + | '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' + | 'dolomitenbank' + | 'easybank_ag' + | 'erste_bank_und_sparkassen' + | 'hypo_alpeadriabank_international_ag' + | 'hypo_bank_burgenland_aktiengesellschaft' + | 'hypo_noe_lb_fur_niederosterreich_u_wien' + | 'hypo_oberosterreich_salzburg_steiermark' + | 'hypo_tirol_bank_ag' + | 'hypo_vorarlberg_bank_ag' + | 'marchfelder_bank' + | 'oberbank_ag' + | 'raiffeisen_bankengruppe_osterreich' + | 'schoellerbank_ag' + | 'sparda_bank_wien' + | 'volksbank_gruppe' + | 'volkskreditbank_ag' + | 'vr_bank_braunau' ) - | null; + | null /** * @description Owner's verified full name. Values are verified or provided by EPS directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. * EPS rarely provides this information so the attribute is usually empty. */ - readonly verified_name?: string | null; - }; + readonly verified_name?: string | null + } /** payment_method_details_fpx */ readonly payment_method_details_fpx: { /** @@ -10137,50 +10024,50 @@ export interface components { * @enum {string} */ readonly bank: - | "affin_bank" - | "agrobank" - | "alliance_bank" - | "ambank" - | "bank_islam" - | "bank_muamalat" - | "bank_rakyat" - | "bsn" - | "cimb" - | "deutsche_bank" - | "hong_leong_bank" - | "hsbc" - | "kfh" - | "maybank2e" - | "maybank2u" - | "ocbc" - | "pb_enterprise" - | "public_bank" - | "rhb" - | "standard_chartered" - | "uob"; + | 'affin_bank' + | 'agrobank' + | 'alliance_bank' + | 'ambank' + | 'bank_islam' + | 'bank_muamalat' + | 'bank_rakyat' + | 'bsn' + | 'cimb' + | 'deutsche_bank' + | 'hong_leong_bank' + | 'hsbc' + | 'kfh' + | 'maybank2e' + | 'maybank2u' + | 'ocbc' + | 'pb_enterprise' + | 'public_bank' + | 'rhb' + | 'standard_chartered' + | 'uob' /** @description Unique transaction id generated by FPX for every request from the merchant */ - readonly transaction_id?: string | null; - }; + readonly transaction_id?: string | null + } /** payment_method_details_giropay */ readonly payment_method_details_giropay: { /** @description Bank code of bank associated with the bank account. */ - readonly bank_code?: string | null; + readonly bank_code?: string | null /** @description Name of the bank associated with the bank account. */ - readonly bank_name?: string | null; + readonly bank_name?: string | null /** @description Bank Identifier Code of the bank associated with the bank account. */ - readonly bic?: string | null; + readonly bic?: string | null /** * @description Owner's verified full name. Values are verified or provided by Giropay directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. * Giropay rarely provides this information so the attribute is usually empty. */ - readonly verified_name?: string | null; - }; + readonly verified_name?: string | null + } /** payment_method_details_grabpay */ readonly payment_method_details_grabpay: { /** @description Unique transaction id generated by GrabPay */ - readonly transaction_id?: string | null; - }; + readonly transaction_id?: string | null + } /** payment_method_details_ideal */ readonly payment_method_details_ideal: { /** @@ -10189,149 +10076,143 @@ export interface components { */ readonly bank?: | ( - | "abn_amro" - | "asn_bank" - | "bunq" - | "handelsbanken" - | "ing" - | "knab" - | "moneyou" - | "rabobank" - | "regiobank" - | "revolut" - | "sns_bank" - | "triodos_bank" - | "van_lanschot" + | 'abn_amro' + | 'asn_bank' + | 'bunq' + | 'handelsbanken' + | 'ing' + | 'knab' + | 'moneyou' + | 'rabobank' + | 'regiobank' + | 'revolut' + | 'sns_bank' + | 'triodos_bank' + | 'van_lanschot' ) - | null; + | null /** * @description The Bank Identifier Code of the customer's bank. * @enum {string|null} */ readonly bic?: | ( - | "ABNANL2A" - | "ASNBNL21" - | "BUNQNL2A" - | "FVLBNL22" - | "HANDNL2A" - | "INGBNL2A" - | "KNABNL2H" - | "MOYONL21" - | "RABONL2U" - | "RBRBNL21" - | "REVOLT21" - | "SNSBNL2A" - | "TRIONL2U" + | 'ABNANL2A' + | 'ASNBNL21' + | 'BUNQNL2A' + | 'FVLBNL22' + | 'HANDNL2A' + | 'INGBNL2A' + | 'KNABNL2H' + | 'MOYONL21' + | 'RABONL2U' + | 'RBRBNL21' + | 'REVOLT21' + | 'SNSBNL2A' + | 'TRIONL2U' ) - | null; + | null /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ - readonly generated_sepa_debit?: (Partial & Partial) | null; + readonly generated_sepa_debit?: (Partial & Partial) | null /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ - readonly generated_sepa_debit_mandate?: (Partial & Partial) | null; + readonly generated_sepa_debit_mandate?: (Partial & Partial) | null /** @description Last four characters of the IBAN. */ - readonly iban_last4?: string | null; + readonly iban_last4?: string | null /** * @description Owner's verified full name. Values are verified or provided by iDEAL directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - readonly verified_name?: string | null; - }; + readonly verified_name?: string | null + } /** payment_method_details_interac_present */ readonly payment_method_details_interac_present: { /** @description Card brand. Can be `interac`, `mastercard` or `visa`. */ - readonly brand?: string | null; + readonly brand?: string | null /** @description 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. */ - readonly cardholder_name?: string | null; + readonly cardholder_name?: string | null /** @description 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. */ - readonly country?: string | null; + readonly country?: string | null /** @description Authorization response cryptogram. */ - readonly emv_auth_data?: string | null; + readonly emv_auth_data?: string | null /** @description Two-digit number representing the card's expiration month. */ - readonly exp_month: number; + readonly exp_month: number /** @description Four-digit number representing the card's expiration year. */ - readonly exp_year: number; + readonly exp_year: number /** * @description 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. * * *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.* */ - readonly fingerprint?: string | null; + readonly fingerprint?: string | null /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ - readonly funding?: string | null; + readonly funding?: string | null /** @description 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. */ - readonly generated_card?: string | null; + readonly generated_card?: string | null /** @description The last four digits of the card. */ - readonly last4?: string | null; + readonly last4?: string | null /** @description Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ - readonly network?: string | null; + readonly network?: string | null /** @description EMV tag 5F2D. Preferred languages specified by the integrated circuit chip. */ - readonly preferred_locales?: readonly string[] | null; + readonly preferred_locales?: readonly string[] | null /** * @description How card details were read in this transaction. * @enum {string|null} */ readonly read_method?: - | ( - | "contact_emv" - | "contactless_emv" - | "contactless_magstripe_mode" - | "magnetic_stripe_fallback" - | "magnetic_stripe_track2" - ) - | null; + | ('contact_emv' | 'contactless_emv' | 'contactless_magstripe_mode' | 'magnetic_stripe_fallback' | 'magnetic_stripe_track2') + | null /** @description A collection of fields required to be displayed on receipts. Only required for EMV transactions. */ - readonly receipt?: Partial | null; - }; + readonly receipt?: Partial | null + } /** payment_method_details_interac_present_receipt */ readonly payment_method_details_interac_present_receipt: { /** * @description The type of account being debited or credited * @enum {string} */ - readonly account_type?: "checking" | "savings" | "unknown"; + readonly account_type?: 'checking' | 'savings' | 'unknown' /** @description EMV tag 9F26, cryptogram generated by the integrated circuit chip. */ - readonly application_cryptogram?: string | null; + readonly application_cryptogram?: string | null /** @description Mnenomic of the Application Identifier. */ - readonly application_preferred_name?: string | null; + readonly application_preferred_name?: string | null /** @description Identifier for this transaction. */ - readonly authorization_code?: string | null; + readonly authorization_code?: string | null /** @description EMV tag 8A. A code returned by the card issuer. */ - readonly authorization_response_code?: string | null; + readonly authorization_response_code?: string | null /** @description How the cardholder verified ownership of the card. */ - readonly cardholder_verification_method?: string | null; + readonly cardholder_verification_method?: string | null /** @description EMV tag 84. Similar to the application identifier stored on the integrated circuit chip. */ - readonly dedicated_file_name?: string | null; + readonly dedicated_file_name?: string | null /** @description The outcome of a series of EMV functions performed by the card reader. */ - readonly terminal_verification_results?: string | null; + readonly terminal_verification_results?: string | null /** @description An indication of various EMV functions performed during the transaction. */ - readonly transaction_status_information?: string | null; - }; + readonly transaction_status_information?: string | null + } /** payment_method_details_klarna */ readonly payment_method_details_klarna: { /** * @description The Klarna payment method used for this transaction. * Can be one of `pay_later`, `pay_now`, `pay_with_financing`, or `pay_in_installments` */ - readonly payment_method_category?: string | null; + readonly payment_method_category?: string | null /** * @description Preferred language of the Klarna authorization page that the customer is redirected to. * Can 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`, or `en-FR` */ - readonly preferred_locale?: string | null; - }; + readonly preferred_locale?: string | null + } /** payment_method_details_multibanco */ readonly payment_method_details_multibanco: { /** @description Entity number associated with this Multibanco payment. */ - readonly entity?: string | null; + readonly entity?: string | null /** @description Reference number associated with this Multibanco payment. */ - readonly reference?: string | null; - }; + readonly reference?: string | null + } /** payment_method_details_oxxo */ readonly payment_method_details_oxxo: { /** @description OXXO reference number */ - readonly number?: string | null; - }; + readonly number?: string | null + } /** payment_method_details_p24 */ readonly payment_method_details_p24: { /** @@ -10340,96 +10221,96 @@ export interface components { */ readonly bank?: | ( - | "alior_bank" - | "bank_millennium" - | "bank_nowy_bfg_sa" - | "bank_pekao_sa" - | "banki_spbdzielcze" - | "blik" - | "bnp_paribas" - | "boz" - | "citi_handlowy" - | "credit_agricole" - | "envelobank" - | "etransfer_pocztowy24" - | "getin_bank" - | "ideabank" - | "ing" - | "inteligo" - | "mbank_mtransfer" - | "nest_przelew" - | "noble_pay" - | "pbac_z_ipko" - | "plus_bank" - | "santander_przelew24" - | "tmobile_usbugi_bankowe" - | "toyota_bank" - | "volkswagen_bank" + | 'alior_bank' + | 'bank_millennium' + | 'bank_nowy_bfg_sa' + | 'bank_pekao_sa' + | 'banki_spbdzielcze' + | 'blik' + | 'bnp_paribas' + | 'boz' + | 'citi_handlowy' + | 'credit_agricole' + | 'envelobank' + | 'etransfer_pocztowy24' + | 'getin_bank' + | 'ideabank' + | 'ing' + | 'inteligo' + | 'mbank_mtransfer' + | 'nest_przelew' + | 'noble_pay' + | 'pbac_z_ipko' + | 'plus_bank' + | 'santander_przelew24' + | 'tmobile_usbugi_bankowe' + | 'toyota_bank' + | 'volkswagen_bank' ) - | null; + | null /** @description Unique reference for this Przelewy24 payment. */ - readonly reference?: string | null; + readonly reference?: string | null /** * @description Owner's verified full name. Values are verified or provided by Przelewy24 directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. * Przelewy24 rarely provides this information so the attribute is usually empty. */ - readonly verified_name?: string | null; - }; + readonly verified_name?: string | null + } /** payment_method_details_sepa_debit */ readonly payment_method_details_sepa_debit: { /** @description Bank code of bank associated with the bank account. */ - readonly bank_code?: string | null; + readonly bank_code?: string | null /** @description Branch code of bank associated with the bank account. */ - readonly branch_code?: string | null; + readonly branch_code?: string | null /** @description Two-letter ISO code representing the country the bank account is located in. */ - readonly country?: string | null; + readonly country?: string | null /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - readonly fingerprint?: string | null; + readonly fingerprint?: string | null /** @description Last four characters of the IBAN. */ - readonly last4?: string | null; + readonly last4?: string | null /** @description ID of the mandate used to make this payment. */ - readonly mandate?: string | null; - }; + readonly mandate?: string | null + } /** payment_method_details_sofort */ readonly payment_method_details_sofort: { /** @description Bank code of bank associated with the bank account. */ - readonly bank_code?: string | null; + readonly bank_code?: string | null /** @description Name of the bank associated with the bank account. */ - readonly bank_name?: string | null; + readonly bank_name?: string | null /** @description Bank Identifier Code of the bank associated with the bank account. */ - readonly bic?: string | null; + readonly bic?: string | null /** @description Two-letter ISO code representing the country the bank account is located in. */ - readonly country?: string | null; + readonly country?: string | null /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ - readonly generated_sepa_debit?: (Partial & Partial) | null; + readonly generated_sepa_debit?: (Partial & Partial) | null /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ - readonly generated_sepa_debit_mandate?: (Partial & Partial) | null; + readonly generated_sepa_debit_mandate?: (Partial & Partial) | null /** @description Last four characters of the IBAN. */ - readonly iban_last4?: string | null; + readonly iban_last4?: string | null /** * @description Preferred language of the SOFORT authorization page that the customer is redirected to. * Can be one of `de`, `en`, `es`, `fr`, `it`, `nl`, or `pl` * @enum {string|null} */ - readonly preferred_language?: ("de" | "en" | "es" | "fr" | "it" | "nl" | "pl") | null; + readonly preferred_language?: ('de' | 'en' | 'es' | 'fr' | 'it' | 'nl' | 'pl') | null /** * @description Owner's verified full name. Values are verified or provided by SOFORT directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - readonly verified_name?: string | null; - }; + readonly verified_name?: string | null + } /** payment_method_details_stripe_account */ - readonly payment_method_details_stripe_account: { readonly [key: string]: unknown }; + readonly payment_method_details_stripe_account: { readonly [key: string]: unknown } /** payment_method_details_wechat */ - readonly payment_method_details_wechat: { readonly [key: string]: unknown }; + readonly payment_method_details_wechat: { readonly [key: string]: unknown } /** payment_method_details_wechat_pay */ readonly payment_method_details_wechat_pay: { /** @description Uniquely identifies this particular WeChat Pay account. You can use this attribute to check whether two WeChat accounts are the same. */ - readonly fingerprint?: string | null; + readonly fingerprint?: string | null /** @description Transaction ID of this particular WeChat Pay transaction. */ - readonly transaction_id?: string | null; - }; + readonly transaction_id?: string | null + } /** payment_method_eps */ readonly payment_method_eps: { /** @@ -10438,36 +10319,36 @@ export interface components { */ readonly bank?: | ( - | "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" - | "dolomitenbank" - | "easybank_ag" - | "erste_bank_und_sparkassen" - | "hypo_alpeadriabank_international_ag" - | "hypo_bank_burgenland_aktiengesellschaft" - | "hypo_noe_lb_fur_niederosterreich_u_wien" - | "hypo_oberosterreich_salzburg_steiermark" - | "hypo_tirol_bank_ag" - | "hypo_vorarlberg_bank_ag" - | "marchfelder_bank" - | "oberbank_ag" - | "raiffeisen_bankengruppe_osterreich" - | "schoellerbank_ag" - | "sparda_bank_wien" - | "volksbank_gruppe" - | "volkskreditbank_ag" - | "vr_bank_braunau" + | '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' + | 'dolomitenbank' + | 'easybank_ag' + | 'erste_bank_und_sparkassen' + | 'hypo_alpeadriabank_international_ag' + | 'hypo_bank_burgenland_aktiengesellschaft' + | 'hypo_noe_lb_fur_niederosterreich_u_wien' + | 'hypo_oberosterreich_salzburg_steiermark' + | 'hypo_tirol_bank_ag' + | 'hypo_vorarlberg_bank_ag' + | 'marchfelder_bank' + | 'oberbank_ag' + | 'raiffeisen_bankengruppe_osterreich' + | 'schoellerbank_ag' + | 'sparda_bank_wien' + | 'volksbank_gruppe' + | 'volkskreditbank_ag' + | 'vr_bank_braunau' ) - | null; - }; + | null + } /** payment_method_fpx */ readonly payment_method_fpx: { /** @@ -10475,32 +10356,32 @@ export interface components { * @enum {string} */ readonly bank: - | "affin_bank" - | "agrobank" - | "alliance_bank" - | "ambank" - | "bank_islam" - | "bank_muamalat" - | "bank_rakyat" - | "bsn" - | "cimb" - | "deutsche_bank" - | "hong_leong_bank" - | "hsbc" - | "kfh" - | "maybank2e" - | "maybank2u" - | "ocbc" - | "pb_enterprise" - | "public_bank" - | "rhb" - | "standard_chartered" - | "uob"; - }; + | 'affin_bank' + | 'agrobank' + | 'alliance_bank' + | 'ambank' + | 'bank_islam' + | 'bank_muamalat' + | 'bank_rakyat' + | 'bsn' + | 'cimb' + | 'deutsche_bank' + | 'hong_leong_bank' + | 'hsbc' + | 'kfh' + | 'maybank2e' + | 'maybank2u' + | 'ocbc' + | 'pb_enterprise' + | 'public_bank' + | 'rhb' + | 'standard_chartered' + | 'uob' + } /** payment_method_giropay */ - readonly payment_method_giropay: { readonly [key: string]: unknown }; + readonly payment_method_giropay: { readonly [key: string]: unknown } /** payment_method_grabpay */ - readonly payment_method_grabpay: { readonly [key: string]: unknown }; + readonly payment_method_grabpay: { readonly [key: string]: unknown } /** payment_method_ideal */ readonly payment_method_ideal: { /** @@ -10509,130 +10390,128 @@ export interface components { */ readonly bank?: | ( - | "abn_amro" - | "asn_bank" - | "bunq" - | "handelsbanken" - | "ing" - | "knab" - | "moneyou" - | "rabobank" - | "regiobank" - | "revolut" - | "sns_bank" - | "triodos_bank" - | "van_lanschot" + | 'abn_amro' + | 'asn_bank' + | 'bunq' + | 'handelsbanken' + | 'ing' + | 'knab' + | 'moneyou' + | 'rabobank' + | 'regiobank' + | 'revolut' + | 'sns_bank' + | 'triodos_bank' + | 'van_lanschot' ) - | null; + | null /** * @description The Bank Identifier Code of the customer's bank, if the bank was provided. * @enum {string|null} */ readonly bic?: | ( - | "ABNANL2A" - | "ASNBNL21" - | "BUNQNL2A" - | "FVLBNL22" - | "HANDNL2A" - | "INGBNL2A" - | "KNABNL2H" - | "MOYONL21" - | "RABONL2U" - | "RBRBNL21" - | "REVOLT21" - | "SNSBNL2A" - | "TRIONL2U" + | 'ABNANL2A' + | 'ASNBNL21' + | 'BUNQNL2A' + | 'FVLBNL22' + | 'HANDNL2A' + | 'INGBNL2A' + | 'KNABNL2H' + | 'MOYONL21' + | 'RABONL2U' + | 'RBRBNL21' + | 'REVOLT21' + | 'SNSBNL2A' + | 'TRIONL2U' ) - | null; - }; + | null + } /** payment_method_interac_present */ - readonly payment_method_interac_present: { readonly [key: string]: unknown }; + readonly payment_method_interac_present: { readonly [key: string]: unknown } /** payment_method_klarna */ readonly payment_method_klarna: { /** @description The customer's date of birth, if provided. */ - readonly dob?: Partial | null; - }; + readonly dob?: Partial | null + } /** payment_method_options_afterpay_clearpay */ readonly payment_method_options_afterpay_clearpay: { /** * @description Order identifier shown to the merchant in Afterpay’s online portal. We recommend using a value that helps you answer any questions a customer might have about * the payment. The identifier is limited to 128 characters and may contain only letters, digits, underscores, backslashes and dashes. */ - readonly reference?: string | null; - }; + readonly reference?: string | null + } /** payment_method_options_alipay */ - readonly payment_method_options_alipay: { readonly [key: string]: unknown }; + readonly payment_method_options_alipay: { readonly [key: string]: unknown } /** payment_method_options_bacs_debit */ - readonly payment_method_options_bacs_debit: { readonly [key: string]: unknown }; + readonly payment_method_options_bacs_debit: { readonly [key: string]: unknown } /** payment_method_options_bancontact */ readonly payment_method_options_bancontact: { /** * @description Preferred language of the Bancontact authorization page that the customer is redirected to. * @enum {string} */ - readonly preferred_language: "de" | "en" | "fr" | "nl"; - }; + readonly preferred_language: 'de' | 'en' | 'fr' | 'nl' + } /** payment_method_options_boleto */ readonly payment_method_options_boleto: { /** @description 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. */ - readonly expires_after_days: number; - }; + readonly expires_after_days: number + } /** payment_method_options_card_installments */ readonly payment_method_options_card_installments: { /** @description Installment plans that may be selected for this PaymentIntent. */ - readonly available_plans?: - | readonly components["schemas"]["payment_method_details_card_installments_plan"][] - | null; + readonly available_plans?: readonly components['schemas']['payment_method_details_card_installments_plan'][] | null /** @description Whether Installments are enabled for this PaymentIntent. */ - readonly enabled: boolean; + readonly enabled: boolean /** @description Installment plan selected for this PaymentIntent. */ - readonly plan?: Partial | null; - }; + readonly plan?: Partial | null + } /** payment_method_options_card_present */ - readonly payment_method_options_card_present: { readonly [key: string]: unknown }; + readonly payment_method_options_card_present: { readonly [key: string]: unknown } /** payment_method_options_fpx */ - readonly payment_method_options_fpx: { readonly [key: string]: unknown }; + readonly payment_method_options_fpx: { readonly [key: string]: unknown } /** payment_method_options_giropay */ - readonly payment_method_options_giropay: { readonly [key: string]: unknown }; + readonly payment_method_options_giropay: { readonly [key: string]: unknown } /** payment_method_options_grabpay */ - readonly payment_method_options_grabpay: { readonly [key: string]: unknown }; + readonly payment_method_options_grabpay: { readonly [key: string]: unknown } /** payment_method_options_ideal */ - readonly payment_method_options_ideal: { readonly [key: string]: unknown }; + readonly payment_method_options_ideal: { readonly [key: string]: unknown } /** payment_method_options_interac_present */ - readonly payment_method_options_interac_present: { readonly [key: string]: unknown }; + readonly payment_method_options_interac_present: { readonly [key: string]: unknown } /** payment_method_options_klarna */ readonly payment_method_options_klarna: { /** @description Preferred locale of the Klarna checkout page that the customer is redirected to. */ - readonly preferred_locale?: string | null; - }; + readonly preferred_locale?: string | null + } /** payment_method_options_oxxo */ readonly payment_method_options_oxxo: { /** @description 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. */ - readonly expires_after_days: number; - }; + readonly expires_after_days: number + } /** payment_method_options_p24 */ - readonly payment_method_options_p24: { readonly [key: string]: unknown }; + readonly payment_method_options_p24: { readonly [key: string]: unknown } /** payment_method_options_sofort */ readonly payment_method_options_sofort: { /** * @description Preferred language of the SOFORT authorization page that the customer is redirected to. * @enum {string|null} */ - readonly preferred_language?: ("de" | "en" | "es" | "fr" | "it" | "nl" | "pl") | null; - }; + readonly preferred_language?: ('de' | 'en' | 'es' | 'fr' | 'it' | 'nl' | 'pl') | null + } /** payment_method_options_wechat_pay */ readonly payment_method_options_wechat_pay: { /** @description The app ID registered with WeChat Pay. Only required when client is ios or android. */ - readonly app_id?: string | null; + readonly app_id?: string | null /** * @description The client type that the end customer will pay from * @enum {string|null} */ - readonly client?: ("android" | "ios" | "web") | null; - }; + readonly client?: ('android' | 'ios' | 'web') | null + } /** payment_method_oxxo */ - readonly payment_method_oxxo: { readonly [key: string]: unknown }; + readonly payment_method_oxxo: { readonly [key: string]: unknown } /** payment_method_p24 */ readonly payment_method_p24: { /** @@ -10641,91 +10520,89 @@ export interface components { */ readonly bank?: | ( - | "alior_bank" - | "bank_millennium" - | "bank_nowy_bfg_sa" - | "bank_pekao_sa" - | "banki_spbdzielcze" - | "blik" - | "bnp_paribas" - | "boz" - | "citi_handlowy" - | "credit_agricole" - | "envelobank" - | "etransfer_pocztowy24" - | "getin_bank" - | "ideabank" - | "ing" - | "inteligo" - | "mbank_mtransfer" - | "nest_przelew" - | "noble_pay" - | "pbac_z_ipko" - | "plus_bank" - | "santander_przelew24" - | "tmobile_usbugi_bankowe" - | "toyota_bank" - | "volkswagen_bank" + | 'alior_bank' + | 'bank_millennium' + | 'bank_nowy_bfg_sa' + | 'bank_pekao_sa' + | 'banki_spbdzielcze' + | 'blik' + | 'bnp_paribas' + | 'boz' + | 'citi_handlowy' + | 'credit_agricole' + | 'envelobank' + | 'etransfer_pocztowy24' + | 'getin_bank' + | 'ideabank' + | 'ing' + | 'inteligo' + | 'mbank_mtransfer' + | 'nest_przelew' + | 'noble_pay' + | 'pbac_z_ipko' + | 'plus_bank' + | 'santander_przelew24' + | 'tmobile_usbugi_bankowe' + | 'toyota_bank' + | 'volkswagen_bank' ) - | null; - }; + | null + } /** payment_method_sepa_debit */ readonly payment_method_sepa_debit: { /** @description Bank code of bank associated with the bank account. */ - readonly bank_code?: string | null; + readonly bank_code?: string | null /** @description Branch code of bank associated with the bank account. */ - readonly branch_code?: string | null; + readonly branch_code?: string | null /** @description Two-letter ISO code representing the country the bank account is located in. */ - readonly country?: string | null; + readonly country?: string | null /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - readonly fingerprint?: string | null; + readonly fingerprint?: string | null /** @description Information about the object that generated this PaymentMethod. */ - readonly generated_from?: Partial | null; + readonly generated_from?: Partial | null /** @description Last four characters of the IBAN. */ - readonly last4?: string | null; - }; + readonly last4?: string | null + } /** payment_method_sofort */ readonly payment_method_sofort: { /** @description Two-letter ISO code representing the country the bank account is located in. */ - readonly country?: string | null; - }; + readonly country?: string | null + } /** payment_method_wechat_pay */ - readonly payment_method_wechat_pay: { readonly [key: string]: unknown }; + readonly payment_method_wechat_pay: { readonly [key: string]: unknown } /** PaymentPagesCheckoutSessionAfterExpiration */ readonly payment_pages_checkout_session_after_expiration: { /** @description When set, configuration used to recover the Checkout Session on expiry. */ - readonly recovery?: Partial< - components["schemas"]["payment_pages_checkout_session_after_expiration_recovery"] - > | null; - }; + readonly recovery?: Partial | null + } /** PaymentPagesCheckoutSessionAfterExpirationRecovery */ readonly payment_pages_checkout_session_after_expiration_recovery: { /** @description Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to `false` */ - readonly allow_promotion_codes: boolean; + readonly allow_promotion_codes: boolean /** * @description If `true`, a recovery url will be generated to recover this Checkout Session if it * expires before a transaction is completed. It will be attached to the * Checkout Session object upon expiration. */ - readonly enabled: boolean; + readonly enabled: boolean /** * Format: unix-time * @description The timestamp at which the recovery URL will expire. */ - readonly expires_at?: number | null; + readonly expires_at?: number | null /** @description URL that creates a new Checkout Session when clicked that is a copy of this expired Checkout Session */ - readonly url?: string | null; - }; + readonly url?: string | null + } /** PaymentPagesCheckoutSessionAutomaticTax */ readonly payment_pages_checkout_session_automatic_tax: { /** @description Indicates whether automatic tax is enabled for the session */ - readonly enabled: boolean; + readonly enabled: boolean /** * @description The status of the most recent automated tax calculation for this session. * @enum {string|null} */ - readonly status?: ("complete" | "failed" | "requires_location_inputs") | null; - }; + readonly status?: ('complete' | 'failed' | 'requires_location_inputs') | null + } /** PaymentPagesCheckoutSessionConsent */ readonly payment_pages_checkout_session_consent: { /** @@ -10733,8 +10610,8 @@ export interface components { * from the merchant about this Checkout Session. * @enum {string|null} */ - readonly promotions?: ("opt_in" | "opt_out") | null; - }; + readonly promotions?: ('opt_in' | 'opt_out') | null + } /** PaymentPagesCheckoutSessionConsentCollection */ readonly payment_pages_checkout_session_consent_collection: { /** @@ -10743,30 +10620,30 @@ export interface components { * from the merchant depending on the customer's locale. Only available to US merchants. * @enum {string|null} */ - readonly promotions?: "auto" | null; - }; + readonly promotions?: 'auto' | null + } /** PaymentPagesCheckoutSessionCustomerDetails */ readonly payment_pages_checkout_session_customer_details: { /** * @description The email associated with the Customer, if one exists, on the Checkout Session at the time of checkout 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. */ - readonly email?: string | null; + readonly email?: string | null /** @description The customer's phone number at the time of checkout */ - readonly phone?: string | null; + readonly phone?: string | null /** * @description The customer’s tax exempt status at time of checkout. * @enum {string|null} */ - readonly tax_exempt?: ("exempt" | "none" | "reverse") | null; + readonly tax_exempt?: ('exempt' | 'none' | 'reverse') | null /** @description The customer’s tax IDs at time of checkout. */ - readonly tax_ids?: readonly components["schemas"]["payment_pages_checkout_session_tax_id"][] | null; - }; + readonly tax_ids?: readonly components['schemas']['payment_pages_checkout_session_tax_id'][] | null + } /** PaymentPagesCheckoutSessionPhoneNumberCollection */ readonly payment_pages_checkout_session_phone_number_collection: { /** @description Indicates whether phone number collection is enabled for the session */ - readonly enabled: boolean; - }; + readonly enabled: boolean + } /** PaymentPagesCheckoutSessionShippingAddressCollection */ readonly payment_pages_checkout_session_shipping_address_collection: { /** @@ -10774,252 +10651,252 @@ export interface components { * shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI`. */ readonly allowed_countries: readonly ( - | "AC" - | "AD" - | "AE" - | "AF" - | "AG" - | "AI" - | "AL" - | "AM" - | "AO" - | "AQ" - | "AR" - | "AT" - | "AU" - | "AW" - | "AX" - | "AZ" - | "BA" - | "BB" - | "BD" - | "BE" - | "BF" - | "BG" - | "BH" - | "BI" - | "BJ" - | "BL" - | "BM" - | "BN" - | "BO" - | "BQ" - | "BR" - | "BS" - | "BT" - | "BV" - | "BW" - | "BY" - | "BZ" - | "CA" - | "CD" - | "CF" - | "CG" - | "CH" - | "CI" - | "CK" - | "CL" - | "CM" - | "CN" - | "CO" - | "CR" - | "CV" - | "CW" - | "CY" - | "CZ" - | "DE" - | "DJ" - | "DK" - | "DM" - | "DO" - | "DZ" - | "EC" - | "EE" - | "EG" - | "EH" - | "ER" - | "ES" - | "ET" - | "FI" - | "FJ" - | "FK" - | "FO" - | "FR" - | "GA" - | "GB" - | "GD" - | "GE" - | "GF" - | "GG" - | "GH" - | "GI" - | "GL" - | "GM" - | "GN" - | "GP" - | "GQ" - | "GR" - | "GS" - | "GT" - | "GU" - | "GW" - | "GY" - | "HK" - | "HN" - | "HR" - | "HT" - | "HU" - | "ID" - | "IE" - | "IL" - | "IM" - | "IN" - | "IO" - | "IQ" - | "IS" - | "IT" - | "JE" - | "JM" - | "JO" - | "JP" - | "KE" - | "KG" - | "KH" - | "KI" - | "KM" - | "KN" - | "KR" - | "KW" - | "KY" - | "KZ" - | "LA" - | "LB" - | "LC" - | "LI" - | "LK" - | "LR" - | "LS" - | "LT" - | "LU" - | "LV" - | "LY" - | "MA" - | "MC" - | "MD" - | "ME" - | "MF" - | "MG" - | "MK" - | "ML" - | "MM" - | "MN" - | "MO" - | "MQ" - | "MR" - | "MS" - | "MT" - | "MU" - | "MV" - | "MW" - | "MX" - | "MY" - | "MZ" - | "NA" - | "NC" - | "NE" - | "NG" - | "NI" - | "NL" - | "NO" - | "NP" - | "NR" - | "NU" - | "NZ" - | "OM" - | "PA" - | "PE" - | "PF" - | "PG" - | "PH" - | "PK" - | "PL" - | "PM" - | "PN" - | "PR" - | "PS" - | "PT" - | "PY" - | "QA" - | "RE" - | "RO" - | "RS" - | "RU" - | "RW" - | "SA" - | "SB" - | "SC" - | "SE" - | "SG" - | "SH" - | "SI" - | "SJ" - | "SK" - | "SL" - | "SM" - | "SN" - | "SO" - | "SR" - | "SS" - | "ST" - | "SV" - | "SX" - | "SZ" - | "TA" - | "TC" - | "TD" - | "TF" - | "TG" - | "TH" - | "TJ" - | "TK" - | "TL" - | "TM" - | "TN" - | "TO" - | "TR" - | "TT" - | "TV" - | "TW" - | "TZ" - | "UA" - | "UG" - | "US" - | "UY" - | "UZ" - | "VA" - | "VC" - | "VE" - | "VG" - | "VN" - | "VU" - | "WF" - | "WS" - | "XK" - | "YE" - | "YT" - | "ZA" - | "ZM" - | "ZW" - | "ZZ" - )[]; - }; + | 'AC' + | 'AD' + | 'AE' + | 'AF' + | 'AG' + | 'AI' + | 'AL' + | 'AM' + | 'AO' + | 'AQ' + | 'AR' + | 'AT' + | 'AU' + | 'AW' + | 'AX' + | 'AZ' + | 'BA' + | 'BB' + | 'BD' + | 'BE' + | 'BF' + | 'BG' + | 'BH' + | 'BI' + | 'BJ' + | 'BL' + | 'BM' + | 'BN' + | 'BO' + | 'BQ' + | 'BR' + | 'BS' + | 'BT' + | 'BV' + | 'BW' + | 'BY' + | 'BZ' + | 'CA' + | 'CD' + | 'CF' + | 'CG' + | 'CH' + | 'CI' + | 'CK' + | 'CL' + | 'CM' + | 'CN' + | 'CO' + | 'CR' + | 'CV' + | 'CW' + | 'CY' + | 'CZ' + | 'DE' + | 'DJ' + | 'DK' + | 'DM' + | 'DO' + | 'DZ' + | 'EC' + | 'EE' + | 'EG' + | 'EH' + | 'ER' + | 'ES' + | 'ET' + | 'FI' + | 'FJ' + | 'FK' + | 'FO' + | 'FR' + | 'GA' + | 'GB' + | 'GD' + | 'GE' + | 'GF' + | 'GG' + | 'GH' + | 'GI' + | 'GL' + | 'GM' + | 'GN' + | 'GP' + | 'GQ' + | 'GR' + | 'GS' + | 'GT' + | 'GU' + | 'GW' + | 'GY' + | 'HK' + | 'HN' + | 'HR' + | 'HT' + | 'HU' + | 'ID' + | 'IE' + | 'IL' + | 'IM' + | 'IN' + | 'IO' + | 'IQ' + | 'IS' + | 'IT' + | 'JE' + | 'JM' + | 'JO' + | 'JP' + | 'KE' + | 'KG' + | 'KH' + | 'KI' + | 'KM' + | 'KN' + | 'KR' + | 'KW' + | 'KY' + | 'KZ' + | 'LA' + | 'LB' + | 'LC' + | 'LI' + | 'LK' + | 'LR' + | 'LS' + | 'LT' + | 'LU' + | 'LV' + | 'LY' + | 'MA' + | 'MC' + | 'MD' + | 'ME' + | 'MF' + | 'MG' + | 'MK' + | 'ML' + | 'MM' + | 'MN' + | 'MO' + | 'MQ' + | 'MR' + | 'MS' + | 'MT' + | 'MU' + | 'MV' + | 'MW' + | 'MX' + | 'MY' + | 'MZ' + | 'NA' + | 'NC' + | 'NE' + | 'NG' + | 'NI' + | 'NL' + | 'NO' + | 'NP' + | 'NR' + | 'NU' + | 'NZ' + | 'OM' + | 'PA' + | 'PE' + | 'PF' + | 'PG' + | 'PH' + | 'PK' + | 'PL' + | 'PM' + | 'PN' + | 'PR' + | 'PS' + | 'PT' + | 'PY' + | 'QA' + | 'RE' + | 'RO' + | 'RS' + | 'RU' + | 'RW' + | 'SA' + | 'SB' + | 'SC' + | 'SE' + | 'SG' + | 'SH' + | 'SI' + | 'SJ' + | 'SK' + | 'SL' + | 'SM' + | 'SN' + | 'SO' + | 'SR' + | 'SS' + | 'ST' + | 'SV' + | 'SX' + | 'SZ' + | 'TA' + | 'TC' + | 'TD' + | 'TF' + | 'TG' + | 'TH' + | 'TJ' + | 'TK' + | 'TL' + | 'TM' + | 'TN' + | 'TO' + | 'TR' + | 'TT' + | 'TV' + | 'TW' + | 'TZ' + | 'UA' + | 'UG' + | 'US' + | 'UY' + | 'UZ' + | 'VA' + | 'VC' + | 'VE' + | 'VG' + | 'VN' + | 'VU' + | 'WF' + | 'WS' + | 'XK' + | 'YE' + | 'YT' + | 'ZA' + | 'ZM' + | 'ZW' + | 'ZZ' + )[] + } /** PaymentPagesCheckoutSessionShippingOption */ readonly payment_pages_checkout_session_shipping_option: { /** @description A non-negative integer in cents representing how much to charge. */ - readonly shipping_amount: number; + readonly shipping_amount: number /** @description The shipping rate. */ - readonly shipping_rate: Partial & Partial; - }; + readonly shipping_rate: Partial & Partial + } /** PaymentPagesCheckoutSessionTaxID */ readonly payment_pages_checkout_session_tax_id: { /** @@ -11027,81 +10904,81 @@ export interface components { * @enum {string} */ readonly type: - | "ae_trn" - | "au_abn" - | "au_arn" - | "br_cnpj" - | "br_cpf" - | "ca_bn" - | "ca_gst_hst" - | "ca_pst_bc" - | "ca_pst_mb" - | "ca_pst_sk" - | "ca_qst" - | "ch_vat" - | "cl_tin" - | "es_cif" - | "eu_vat" - | "gb_vat" - | "ge_vat" - | "hk_br" - | "id_npwp" - | "il_vat" - | "in_gst" - | "is_vat" - | "jp_cn" - | "jp_rn" - | "kr_brn" - | "li_uid" - | "mx_rfc" - | "my_frp" - | "my_itn" - | "my_sst" - | "no_vat" - | "nz_gst" - | "ru_inn" - | "ru_kpp" - | "sa_vat" - | "sg_gst" - | "sg_uen" - | "th_vat" - | "tw_vat" - | "ua_vat" - | "unknown" - | "us_ein" - | "za_vat"; + | 'ae_trn' + | 'au_abn' + | 'au_arn' + | 'br_cnpj' + | 'br_cpf' + | 'ca_bn' + | 'ca_gst_hst' + | 'ca_pst_bc' + | 'ca_pst_mb' + | 'ca_pst_sk' + | 'ca_qst' + | 'ch_vat' + | 'cl_tin' + | 'es_cif' + | 'eu_vat' + | 'gb_vat' + | 'ge_vat' + | 'hk_br' + | 'id_npwp' + | 'il_vat' + | 'in_gst' + | 'is_vat' + | 'jp_cn' + | 'jp_rn' + | 'kr_brn' + | 'li_uid' + | 'mx_rfc' + | 'my_frp' + | 'my_itn' + | 'my_sst' + | 'no_vat' + | 'nz_gst' + | 'ru_inn' + | 'ru_kpp' + | 'sa_vat' + | 'sg_gst' + | 'sg_uen' + | 'th_vat' + | 'tw_vat' + | 'ua_vat' + | 'unknown' + | 'us_ein' + | 'za_vat' /** @description The value of the tax ID. */ - readonly value?: string | null; - }; + readonly value?: string | null + } /** PaymentPagesCheckoutSessionTaxIDCollection */ readonly payment_pages_checkout_session_tax_id_collection: { /** @description Indicates whether tax ID collection is enabled for the session */ - readonly enabled: boolean; - }; + readonly enabled: boolean + } /** PaymentPagesCheckoutSessionTotalDetails */ readonly payment_pages_checkout_session_total_details: { /** @description This is the sum of all the line item discounts. */ - readonly amount_discount: number; + readonly amount_discount: number /** @description This is the sum of all the line item shipping amounts. */ - readonly amount_shipping?: number | null; + readonly amount_shipping?: number | null /** @description This is the sum of all the line item tax amounts. */ - readonly amount_tax: number; - readonly breakdown?: components["schemas"]["payment_pages_checkout_session_total_details_resource_breakdown"]; - }; + readonly amount_tax: number + readonly breakdown?: components['schemas']['payment_pages_checkout_session_total_details_resource_breakdown'] + } /** PaymentPagesCheckoutSessionTotalDetailsResourceBreakdown */ readonly payment_pages_checkout_session_total_details_resource_breakdown: { /** @description The aggregated line item discounts. */ - readonly discounts: readonly components["schemas"]["line_items_discount_amount"][]; + readonly discounts: readonly components['schemas']['line_items_discount_amount'][] /** @description The aggregated line item tax amounts by rate. */ - readonly taxes: readonly components["schemas"]["line_items_tax_amount"][]; - }; + readonly taxes: readonly components['schemas']['line_items_tax_amount'][] + } /** Polymorphic */ - readonly payment_source: Partial & - Partial & - Partial & - Partial & - Partial & - Partial; + readonly payment_source: Partial & + Partial & + Partial & + Partial & + Partial & + Partial /** * Payout * @description A `Payout` object is created when you receive funds from Stripe, or when you @@ -11115,83 +10992,81 @@ export interface components { */ readonly payout: { /** @description Amount (in %s) to be transferred to your bank account or debit card. */ - readonly amount: number; + readonly amount: number /** * Format: unix-time * @description Date the payout is expected to arrive in the bank. This factors in delays like weekends or bank holidays. */ - readonly arrival_date: number; + readonly arrival_date: number /** @description Returns `true` if the payout was created by an [automated payout schedule](https://stripe.com/docs/payouts#payout-schedule), and `false` if it was [requested manually](https://stripe.com/docs/payouts#manual-payouts). */ - readonly automatic: boolean; + readonly automatic: boolean /** @description ID of the balance transaction that describes the impact of this payout on your account balance. */ - readonly balance_transaction?: (Partial & Partial) | null; + readonly balance_transaction?: (Partial & Partial) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string | null; + readonly description?: string | null /** @description ID of the bank account or card the payout was sent to. */ readonly destination?: | (Partial & - Partial & - Partial & - Partial & - Partial) - | null; + Partial & + Partial & + Partial & + Partial) + | null /** @description If the payout failed or was canceled, this will be the ID of the balance transaction that reversed the initial balance transaction, and puts the funds from the failed payout back in your balance. */ - readonly failure_balance_transaction?: - | (Partial & Partial) - | null; + readonly failure_balance_transaction?: (Partial & Partial) | null /** @description Error code explaining reason for payout failure if available. See [Types of payout failures](https://stripe.com/docs/api#payout_failures) for a list of failure codes. */ - readonly failure_code?: string | null; + readonly failure_code?: string | null /** @description Message to user further explaining reason for payout failure if available. */ - readonly failure_message?: string | null; + readonly failure_message?: string | null /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata?: { readonly [key: string]: string } | null; + readonly metadata?: { readonly [key: string]: string } | null /** @description The method used to send this payout, which can be `standard` or `instant`. `instant` is only supported for payouts to debit cards. (See [Instant payouts for marketplaces](https://stripe.com/blog/instant-payouts-for-marketplaces) for more information.) */ - readonly method: string; + readonly method: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "payout"; + readonly object: 'payout' /** @description If the payout reverses another, this is the ID of the original payout. */ - readonly original_payout?: (Partial & Partial) | null; + readonly original_payout?: (Partial & Partial) | null /** @description If the payout was reversed, this is the ID of the payout that reverses this payout. */ - readonly reversed_by?: (Partial & Partial) | null; + readonly reversed_by?: (Partial & Partial) | null /** @description The source balance this payout came from. One of `card`, `fpx`, or `bank_account`. */ - readonly source_type: string; + readonly source_type: string /** @description Extra information about a payout to be displayed on the user's bank statement. */ - readonly statement_descriptor?: string | null; + readonly statement_descriptor?: string | null /** @description Current status of the payout: `paid`, `pending`, `in_transit`, `canceled` or `failed`. A payout is `pending` until it is submitted to the bank, when it becomes `in_transit`. The status then changes to `paid` if the transaction goes through, or to `failed` or `canceled` (within 5 business days). Some failed payouts may initially show as `paid` but then change to `failed`. */ - readonly status: string; + readonly status: string /** * @description Can be `bank_account` or `card`. * @enum {string} */ - readonly type: "bank_account" | "card"; - }; + readonly type: 'bank_account' | 'card' + } /** Period */ readonly period: { /** * Format: unix-time * @description The end date of this usage period. All usage up to and including this point in time is included. */ - readonly end?: number | null; + readonly end?: number | null /** * Format: unix-time * @description The start date of this usage period. All usage after this point in time is included. */ - readonly start?: number | null; - }; + readonly start?: number | null + } /** * Person * @description This is an object representing a person associated with a Stripe account. @@ -11203,108 +11078,108 @@ export interface components { */ readonly person: { /** @description The account the person is associated with. */ - readonly account: string; - readonly address?: components["schemas"]["address"]; - readonly address_kana?: Partial | null; - readonly address_kanji?: Partial | null; + readonly account: string + readonly address?: components['schemas']['address'] + readonly address_kana?: Partial | null + readonly address_kanji?: Partial | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; - readonly dob?: components["schemas"]["legal_entity_dob"]; + readonly created: number + readonly dob?: components['schemas']['legal_entity_dob'] /** @description The person's email address. */ - readonly email?: string | null; + readonly email?: string | null /** @description The person's first name. */ - readonly first_name?: string | null; + readonly first_name?: string | null /** @description The Kana variation of the person's first name (Japan only). */ - readonly first_name_kana?: string | null; + readonly first_name_kana?: string | null /** @description The Kanji variation of the person's first name (Japan only). */ - readonly first_name_kanji?: string | null; + readonly first_name_kanji?: string | null /** @description A list of alternate names or aliases that the person is known by. */ - readonly full_name_aliases?: readonly string[]; - readonly future_requirements?: Partial | null; + readonly full_name_aliases?: readonly string[] + readonly future_requirements?: Partial | null /** @description The person's gender (International regulations require either "male" or "female"). */ - readonly gender?: string | null; + readonly gender?: string | null /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Whether the person's `id_number` was provided. */ - readonly id_number_provided?: boolean; + readonly id_number_provided?: boolean /** @description The person's last name. */ - readonly last_name?: string | null; + readonly last_name?: string | null /** @description The Kana variation of the person's last name (Japan only). */ - readonly last_name_kana?: string | null; + readonly last_name_kana?: string | null /** @description The Kanji variation of the person's last name (Japan only). */ - readonly last_name_kanji?: string | null; + readonly last_name_kanji?: string | null /** @description The person's maiden name. */ - readonly maiden_name?: string | null; + readonly maiden_name?: string | null /** @description 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. */ - readonly metadata?: { readonly [key: string]: string }; + readonly metadata?: { readonly [key: string]: string } /** @description The country where the person is a national. */ - readonly nationality?: string | null; + readonly nationality?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "person"; + readonly object: 'person' /** @description The person's phone number. */ - readonly phone?: string | null; + readonly phone?: string | null /** * @description 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. * @enum {string} */ - readonly political_exposure?: "existing" | "none"; - readonly relationship?: components["schemas"]["person_relationship"]; - readonly requirements?: Partial | null; + readonly political_exposure?: 'existing' | 'none' + readonly relationship?: components['schemas']['person_relationship'] + readonly requirements?: Partial | null /** @description Whether the last four digits of the person's Social Security number have been provided (U.S. only). */ - readonly ssn_last_4_provided?: boolean; - readonly verification?: components["schemas"]["legal_entity_person_verification"]; - }; + readonly ssn_last_4_provided?: boolean + readonly verification?: components['schemas']['legal_entity_person_verification'] + } /** PersonFutureRequirements */ readonly person_future_requirements: { /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ - readonly alternatives?: readonly components["schemas"]["account_requirements_alternative"][] | null; + readonly alternatives?: readonly components['schemas']['account_requirements_alternative'][] | null /** @description 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. */ - readonly currently_due: readonly string[]; + readonly currently_due: readonly string[] /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ - readonly errors: readonly components["schemas"]["account_requirements_error"][]; + readonly errors: readonly components['schemas']['account_requirements_error'][] /** @description Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `future_requirements[current_deadline]` becomes set. */ - readonly eventually_due: readonly string[]; + readonly eventually_due: readonly string[] /** @description 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`. */ - readonly past_due: readonly string[]; + readonly past_due: readonly string[] /** @description Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. */ - readonly pending_verification: readonly string[]; - }; + readonly pending_verification: readonly string[] + } /** PersonRelationship */ readonly person_relationship: { /** @description 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. */ - readonly director?: boolean | null; + readonly director?: boolean | null /** @description Whether the person has significant responsibility to control, manage, or direct the organization. */ - readonly executive?: boolean | null; + readonly executive?: boolean | null /** @description Whether the person is an owner of the account’s legal entity. */ - readonly owner?: boolean | null; + readonly owner?: boolean | null /** @description The percent owned by the person of the account's legal entity. */ - readonly percent_ownership?: number | null; + readonly percent_ownership?: number | null /** @description 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. */ - readonly representative?: boolean | null; + readonly representative?: boolean | null /** @description The person's title (e.g., CEO, Support Engineer). */ - readonly title?: string | null; - }; + readonly title?: string | null + } /** PersonRequirements */ readonly person_requirements: { /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ - readonly alternatives?: readonly components["schemas"]["account_requirements_alternative"][] | null; + readonly alternatives?: readonly components['schemas']['account_requirements_alternative'][] | null /** @description 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. */ - readonly currently_due: readonly string[]; + readonly currently_due: readonly string[] /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ - readonly errors: readonly components["schemas"]["account_requirements_error"][]; + readonly errors: readonly components['schemas']['account_requirements_error'][] /** @description Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `current_deadline` becomes set. */ - readonly eventually_due: readonly string[]; + readonly eventually_due: readonly string[] /** @description Fields that weren't collected by the account's `current_deadline`. These fields need to be collected to enable the person's account. */ - readonly past_due: readonly string[]; + readonly past_due: readonly string[] /** @description Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. */ - readonly pending_verification: readonly string[]; - }; + readonly pending_verification: readonly string[] + } /** * Plan * @description You can now model subscriptions more flexibly using the [Prices API](https://stripe.com/docs/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration. @@ -11318,202 +11193,198 @@ export interface components { */ readonly plan: { /** @description Whether the plan can be used for new purchases. */ - readonly active: boolean; + readonly active: boolean /** * @description 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`. * @enum {string|null} */ - readonly aggregate_usage?: ("last_during_period" | "last_ever" | "max" | "sum") | null; + readonly aggregate_usage?: ('last_during_period' | 'last_ever' | 'max' | 'sum') | null /** @description The unit amount in %s to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. */ - readonly amount?: number | null; + readonly amount?: number | null /** * Format: decimal * @description The unit amount in %s to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`. */ - readonly amount_decimal?: string | null; + readonly amount_decimal?: string | null /** * @description 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. * @enum {string} */ - readonly billing_scheme: "per_unit" | "tiered"; + readonly billing_scheme: 'per_unit' | 'tiered' /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`. * @enum {string} */ - readonly interval: "day" | "month" | "week" | "year"; + readonly interval: 'day' | 'month' | 'week' | 'year' /** @description The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. */ - readonly interval_count: number; + readonly interval_count: number /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata?: { readonly [key: string]: string } | null; + readonly metadata?: { readonly [key: string]: string } | null /** @description A brief description of the plan, hidden from customers. */ - readonly nickname?: string | null; + readonly nickname?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "plan"; + readonly object: 'plan' /** @description The product whose pricing this plan determines. */ - readonly product?: - | (Partial & - Partial & - Partial) - | null; + readonly product?: (Partial & Partial & Partial) | null /** @description Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. */ - readonly tiers?: readonly components["schemas"]["plan_tier"][]; + readonly tiers?: readonly components['schemas']['plan_tier'][] /** * @description 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. * @enum {string|null} */ - readonly tiers_mode?: ("graduated" | "volume") | null; + readonly tiers_mode?: ('graduated' | 'volume') | null /** @description Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`. */ - readonly transform_usage?: Partial | null; + readonly transform_usage?: Partial | null /** @description 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). */ - readonly trial_period_days?: number | null; + readonly trial_period_days?: number | null /** * @description 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`. * @enum {string} */ - readonly usage_type: "licensed" | "metered"; - }; + readonly usage_type: 'licensed' | 'metered' + } /** PlanTier */ readonly plan_tier: { /** @description Price for the entire tier. */ - readonly flat_amount?: number | null; + readonly flat_amount?: number | null /** * Format: decimal * @description Same as `flat_amount`, but contains a decimal value with at most 12 decimal places. */ - readonly flat_amount_decimal?: string | null; + readonly flat_amount_decimal?: string | null /** @description Per unit price for units relevant to the tier. */ - readonly unit_amount?: number | null; + readonly unit_amount?: number | null /** * Format: decimal * @description Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. */ - readonly unit_amount_decimal?: string | null; + readonly unit_amount_decimal?: string | null /** @description Up to and including to this quantity will be contained in the tier. */ - readonly up_to?: number | null; - }; + readonly up_to?: number | null + } /** PlatformTax */ readonly platform_tax_fee: { /** @description The Connected account that incurred this charge. */ - readonly account: string; + readonly account: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "platform_tax_fee"; + readonly object: 'platform_tax_fee' /** @description The payment object that caused this tax to be inflicted. */ - readonly source_transaction: string; + readonly source_transaction: string /** @description The type of tax (VAT). */ - readonly type: string; - }; + readonly type: string + } /** PortalBusinessProfile */ readonly portal_business_profile: { /** @description The messaging shown to customers in the portal. */ - readonly headline?: string | null; + readonly headline?: string | null /** @description A link to the business’s publicly available privacy policy. */ - readonly privacy_policy_url: string; + readonly privacy_policy_url: string /** @description A link to the business’s publicly available terms of service. */ - readonly terms_of_service_url: string; - }; + readonly terms_of_service_url: string + } /** PortalCustomerUpdate */ readonly portal_customer_update: { /** @description The types of customer updates that are supported. When empty, customers are not updateable. */ - readonly allowed_updates: readonly ("address" | "email" | "phone" | "shipping" | "tax_id")[]; + readonly allowed_updates: readonly ('address' | 'email' | 'phone' | 'shipping' | 'tax_id')[] /** @description Whether the feature is enabled. */ - readonly enabled: boolean; - }; + readonly enabled: boolean + } /** PortalFeatures */ readonly portal_features: { - readonly customer_update: components["schemas"]["portal_customer_update"]; - readonly invoice_history: components["schemas"]["portal_invoice_list"]; - readonly payment_method_update: components["schemas"]["portal_payment_method_update"]; - readonly subscription_cancel: components["schemas"]["portal_subscription_cancel"]; - readonly subscription_pause: components["schemas"]["portal_subscription_pause"]; - readonly subscription_update: components["schemas"]["portal_subscription_update"]; - }; + readonly customer_update: components['schemas']['portal_customer_update'] + readonly invoice_history: components['schemas']['portal_invoice_list'] + readonly payment_method_update: components['schemas']['portal_payment_method_update'] + readonly subscription_cancel: components['schemas']['portal_subscription_cancel'] + readonly subscription_pause: components['schemas']['portal_subscription_pause'] + readonly subscription_update: components['schemas']['portal_subscription_update'] + } /** PortalInvoiceList */ readonly portal_invoice_list: { /** @description Whether the feature is enabled. */ - readonly enabled: boolean; - }; + readonly enabled: boolean + } /** PortalPaymentMethodUpdate */ readonly portal_payment_method_update: { /** @description Whether the feature is enabled. */ - readonly enabled: boolean; - }; + readonly enabled: boolean + } /** PortalSubscriptionCancel */ readonly portal_subscription_cancel: { - readonly cancellation_reason: components["schemas"]["portal_subscription_cancellation_reason"]; + readonly cancellation_reason: components['schemas']['portal_subscription_cancellation_reason'] /** @description Whether the feature is enabled. */ - readonly enabled: boolean; + readonly enabled: boolean /** * @description Whether to cancel subscriptions immediately or at the end of the billing period. * @enum {string} */ - readonly mode: "at_period_end" | "immediately"; + readonly mode: 'at_period_end' | 'immediately' /** * @description Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`. * @enum {string} */ - readonly proration_behavior: "always_invoice" | "create_prorations" | "none"; - }; + readonly proration_behavior: 'always_invoice' | 'create_prorations' | 'none' + } /** PortalSubscriptionCancellationReason */ readonly portal_subscription_cancellation_reason: { /** @description Whether the feature is enabled. */ - readonly enabled: boolean; + readonly enabled: boolean /** @description Which cancellation reasons will be given as options to the customer. */ readonly options: readonly ( - | "customer_service" - | "low_quality" - | "missing_features" - | "other" - | "switched_service" - | "too_complex" - | "too_expensive" - | "unused" - )[]; - }; + | 'customer_service' + | 'low_quality' + | 'missing_features' + | 'other' + | 'switched_service' + | 'too_complex' + | 'too_expensive' + | 'unused' + )[] + } /** PortalSubscriptionPause */ readonly portal_subscription_pause: { /** @description Whether the feature is enabled. */ - readonly enabled: boolean; - }; + readonly enabled: boolean + } /** PortalSubscriptionUpdate */ readonly portal_subscription_update: { /** @description The types of subscription updates that are supported for items listed in the `products` attribute. When empty, subscriptions are not updateable. */ - readonly default_allowed_updates: readonly ("price" | "promotion_code" | "quantity")[]; + readonly default_allowed_updates: readonly ('price' | 'promotion_code' | 'quantity')[] /** @description Whether the feature is enabled. */ - readonly enabled: boolean; + readonly enabled: boolean /** @description The list of products that support subscription updates. */ - readonly products?: readonly components["schemas"]["portal_subscription_update_product"][] | null; + readonly products?: readonly components['schemas']['portal_subscription_update_product'][] | null /** * @description Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`. * @enum {string} */ - readonly proration_behavior: "always_invoice" | "create_prorations" | "none"; - }; + readonly proration_behavior: 'always_invoice' | 'create_prorations' | 'none' + } /** PortalSubscriptionUpdateProduct */ readonly portal_subscription_update_product: { /** @description The list of price IDs which, when subscribed to, a subscription can be updated. */ - readonly prices: readonly string[]; + readonly prices: readonly string[] /** @description The product ID. */ - readonly product: string; - }; + readonly product: string + } /** * Price * @description Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. @@ -11525,86 +11396,84 @@ export interface components { */ readonly price: { /** @description Whether the price can be used for new purchases. */ - readonly active: boolean; + readonly active: boolean /** * @description 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. * @enum {string} */ - readonly billing_scheme: "per_unit" | "tiered"; + readonly billing_scheme: 'per_unit' | 'tiered' /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters. */ - readonly lookup_key?: string | null; + readonly lookup_key?: string | null /** @description 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. */ - readonly metadata: { readonly [key: string]: string }; + readonly metadata: { readonly [key: string]: string } /** @description A brief description of the price, hidden from customers. */ - readonly nickname?: string | null; + readonly nickname?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "price"; + readonly object: 'price' /** @description The ID of the product this price is associated with. */ - readonly product: Partial & - Partial & - Partial; + readonly product: Partial & Partial & Partial /** @description The recurring components of a price such as `interval` and `usage_type`. */ - readonly recurring?: Partial | null; + readonly recurring?: Partial | null /** * @description 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. * @enum {string|null} */ - readonly tax_behavior?: ("exclusive" | "inclusive" | "unspecified") | null; + readonly tax_behavior?: ('exclusive' | 'inclusive' | 'unspecified') | null /** @description Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. */ - readonly tiers?: readonly components["schemas"]["price_tier"][]; + readonly tiers?: readonly components['schemas']['price_tier'][] /** * @description 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. * @enum {string|null} */ - readonly tiers_mode?: ("graduated" | "volume") | null; + readonly tiers_mode?: ('graduated' | 'volume') | null /** @description Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`. */ - readonly transform_quantity?: Partial | null; + readonly transform_quantity?: Partial | null /** * @description One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase. * @enum {string} */ - readonly type: "one_time" | "recurring"; + readonly type: 'one_time' | 'recurring' /** @description The unit amount in %s to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. */ - readonly unit_amount?: number | null; + readonly unit_amount?: number | null /** * Format: decimal * @description The unit amount in %s to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`. */ - readonly unit_amount_decimal?: string | null; - }; + readonly unit_amount_decimal?: string | null + } /** PriceTier */ readonly price_tier: { /** @description Price for the entire tier. */ - readonly flat_amount?: number | null; + readonly flat_amount?: number | null /** * Format: decimal * @description Same as `flat_amount`, but contains a decimal value with at most 12 decimal places. */ - readonly flat_amount_decimal?: string | null; + readonly flat_amount_decimal?: string | null /** @description Per unit price for units relevant to the tier. */ - readonly unit_amount?: number | null; + readonly unit_amount?: number | null /** * Format: decimal * @description Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. */ - readonly unit_amount_decimal?: string | null; + readonly unit_amount_decimal?: string | null /** @description Up to and including to this quantity will be contained in the tier. */ - readonly up_to?: number | null; - }; + readonly up_to?: number | null + } /** * Product * @description Products describe the specific goods or services you offer to your customers. @@ -11618,47 +11487,47 @@ export interface components { */ readonly product: { /** @description Whether the product is currently available for purchase. */ - readonly active: boolean; + readonly active: boolean /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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. */ - readonly description?: string | null; + readonly description?: string | null /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description A list of up to 8 URLs of images for this product, meant to be displayable to the customer. */ - readonly images: readonly string[]; + readonly images: readonly string[] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata: { readonly [key: string]: string }; + readonly metadata: { readonly [key: string]: string } /** @description The product's name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions. */ - readonly name: string; + readonly name: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "product"; + readonly object: 'product' /** @description The dimensions of this product for shipping purposes. */ - readonly package_dimensions?: Partial | null; + readonly package_dimensions?: Partial | null /** @description Whether this product is shipped (i.e., physical goods). */ - readonly shippable?: boolean | null; + readonly shippable?: boolean | null /** @description 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. */ - readonly statement_descriptor?: string | null; + readonly statement_descriptor?: string | null /** @description A [tax code](https://stripe.com/docs/tax/tax-codes) ID. */ - readonly tax_code?: (Partial & Partial) | null; + readonly tax_code?: (Partial & Partial) | null /** @description A label that represents units of this product in Stripe and on customers’ receipts and invoices. When set, this will be included in associated invoice line item descriptions. */ - readonly unit_label?: string | null; + readonly unit_label?: string | null /** * Format: unix-time * @description Time at which the object was last updated. Measured in seconds since the Unix epoch. */ - readonly updated: number; + readonly updated: number /** @description A URL of a publicly-accessible webpage for this product. */ - readonly url?: string | null; - }; + readonly url?: string | null + } /** * PromotionCode * @description A Promotion Code represents a customer-redeemable code for a coupon. It can be used to @@ -11666,52 +11535,48 @@ export interface components { */ readonly promotion_code: { /** @description Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid. */ - readonly active: boolean; + readonly active: boolean /** @description The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. */ - readonly code: string; - readonly coupon: components["schemas"]["coupon"]; + readonly code: string + readonly coupon: components['schemas']['coupon'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description The customer that this promotion code can be used by. */ - readonly customer?: - | (Partial & - Partial & - Partial) - | null; + readonly customer?: (Partial & Partial & Partial) | null /** * Format: unix-time * @description Date at which the promotion code can no longer be redeemed. */ - readonly expires_at?: number | null; + readonly expires_at?: number | null /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description Maximum number of times this promotion code can be redeemed. */ - readonly max_redemptions?: number | null; + readonly max_redemptions?: number | null /** @description 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. */ - readonly metadata?: { readonly [key: string]: string } | null; + readonly metadata?: { readonly [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "promotion_code"; - readonly restrictions: components["schemas"]["promotion_codes_resource_restrictions"]; + readonly object: 'promotion_code' + readonly restrictions: components['schemas']['promotion_codes_resource_restrictions'] /** @description Number of times this promotion code has been used. */ - readonly times_redeemed: number; - }; + readonly times_redeemed: number + } /** PromotionCodesResourceRestrictions */ readonly promotion_codes_resource_restrictions: { /** @description A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices */ - readonly first_time_transaction: boolean; + readonly first_time_transaction: boolean /** @description Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work). */ - readonly minimum_amount?: number | null; + readonly minimum_amount?: number | null /** @description Three-letter [ISO code](https://stripe.com/docs/currencies) for minimum_amount */ - readonly minimum_amount_currency?: string | null; - }; + readonly minimum_amount_currency?: string | null + } /** * Quote * @description A Quote is a way to model prices that you'd like to provide to a customer. @@ -11719,224 +11584,214 @@ export interface components { */ readonly quote: { /** @description Total before any discounts or taxes are applied. */ - readonly amount_subtotal: number; + readonly amount_subtotal: number /** @description Total after discounts and taxes are applied. */ - readonly amount_total: number; + readonly amount_total: number /** @description 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. */ - readonly application_fee_amount?: number | null; + readonly application_fee_amount?: number | null /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. Only applicable if there are line items with recurring prices on the quote. */ - readonly application_fee_percent?: number | null; - readonly automatic_tax: components["schemas"]["quotes_resource_automatic_tax"]; + readonly application_fee_percent?: number | null + readonly automatic_tax: components['schemas']['quotes_resource_automatic_tax'] /** * @description 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. Defaults to `charge_automatically`. * @enum {string} */ - readonly collection_method: "charge_automatically" | "send_invoice"; - readonly computed: components["schemas"]["quotes_resource_computed"]; + readonly collection_method: 'charge_automatically' | 'send_invoice' + readonly computed: components['schemas']['quotes_resource_computed'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency?: string | null; + readonly currency?: string | null /** @description The customer which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed. */ - readonly customer?: - | (Partial & - Partial & - Partial) - | null; + readonly customer?: (Partial & Partial & Partial) | null /** @description The tax rates applied to this quote. */ - readonly default_tax_rates?: readonly (Partial & Partial)[]; + readonly default_tax_rates?: readonly (Partial & Partial)[] /** @description A description that will be displayed on the quote PDF. */ - readonly description?: string | null; + readonly description?: string | null /** @description The discounts applied to this quote. */ - readonly discounts: readonly (Partial & Partial)[]; + readonly discounts: readonly (Partial & Partial)[] /** * Format: unix-time * @description The date on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. */ - readonly expires_at: number; + readonly expires_at: number /** @description A footer that will be displayed on the quote PDF. */ - readonly footer?: string | null; + readonly footer?: string | null /** @description Details of the quote that was cloned. See the [cloning documentation](https://stripe.com/docs/quotes/clone) for more details. */ - readonly from_quote?: Partial | null; + readonly from_quote?: Partial | null /** @description A header that will be displayed on the quote PDF. */ - readonly header?: string | null; + readonly header?: string | null /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description The invoice that was created from this quote. */ - readonly invoice?: - | (Partial & - Partial & - Partial) - | null; + readonly invoice?: (Partial & Partial & Partial) | null /** @description All invoices will be billed using the specified settings. */ - readonly invoice_settings?: Partial | null; + readonly invoice_settings?: Partial | null /** * QuotesResourceListLineItems * @description A list of items the customer is being quoted for. */ readonly line_items?: { /** @description Details about each object. */ - readonly data: readonly components["schemas"]["item"][]; + readonly data: readonly components['schemas']['item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; + readonly url: string + } /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata: { readonly [key: string]: string }; + readonly metadata: { readonly [key: string]: string } /** @description A unique number that identifies this particular quote. This number is assigned once the quote is [finalized](https://stripe.com/docs/quotes/overview#finalize). */ - readonly number?: string | null; + readonly number?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "quote"; + readonly object: 'quote' /** @description 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. */ - readonly on_behalf_of?: (Partial & Partial) | null; + readonly on_behalf_of?: (Partial & Partial) | null /** * @description The status of the quote. * @enum {string} */ - readonly status: "accepted" | "canceled" | "draft" | "open"; - readonly status_transitions: components["schemas"]["quotes_resource_status_transitions"]; + readonly status: 'accepted' | 'canceled' | 'draft' | 'open' + readonly status_transitions: components['schemas']['quotes_resource_status_transitions'] /** @description The subscription that was created or updated from this quote. */ - readonly subscription?: (Partial & Partial) | null; - readonly subscription_data: components["schemas"]["quotes_resource_subscription_data"]; + readonly subscription?: (Partial & Partial) | null + readonly subscription_data: components['schemas']['quotes_resource_subscription_data'] /** @description The subscription schedule that was created or updated from this quote. */ - readonly subscription_schedule?: - | (Partial & Partial) - | null; - readonly total_details: components["schemas"]["quotes_resource_total_details"]; + readonly subscription_schedule?: (Partial & Partial) | null + readonly total_details: components['schemas']['quotes_resource_total_details'] /** @description 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. */ - readonly transfer_data?: Partial | null; - }; + readonly transfer_data?: Partial | null + } /** QuotesResourceAutomaticTax */ readonly quotes_resource_automatic_tax: { /** @description Automatically calculate taxes */ - readonly enabled: boolean; + readonly enabled: boolean /** * @description The status of the most recent automated tax calculation for this quote. * @enum {string|null} */ - readonly status?: ("complete" | "failed" | "requires_location_inputs") | null; - }; + readonly status?: ('complete' | 'failed' | 'requires_location_inputs') | null + } /** QuotesResourceComputed */ readonly quotes_resource_computed: { /** @description 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. */ - readonly recurring?: Partial | null; - readonly upfront: components["schemas"]["quotes_resource_upfront"]; - }; + readonly recurring?: Partial | null + readonly upfront: components['schemas']['quotes_resource_upfront'] + } /** QuotesResourceFromQuote */ readonly quotes_resource_from_quote: { /** @description Whether this quote is a revision of a different quote. */ - readonly is_revision: boolean; + readonly is_revision: boolean /** @description The quote that was cloned. */ - readonly quote: Partial & Partial; - }; + readonly quote: Partial & Partial + } /** QuotesResourceRecurring */ readonly quotes_resource_recurring: { /** @description Total before any discounts or taxes are applied. */ - readonly amount_subtotal: number; + readonly amount_subtotal: number /** @description Total after discounts and taxes are applied. */ - readonly amount_total: number; + readonly amount_total: number /** * @description The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`. * @enum {string} */ - readonly interval: "day" | "month" | "week" | "year"; + readonly interval: 'day' | 'month' | 'week' | 'year' /** @description The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. */ - readonly interval_count: number; - readonly total_details: components["schemas"]["quotes_resource_total_details"]; - }; + readonly interval_count: number + readonly total_details: components['schemas']['quotes_resource_total_details'] + } /** QuotesResourceStatusTransitions */ readonly quotes_resource_status_transitions: { /** * Format: unix-time * @description The time that the quote was accepted. Measured in seconds since Unix epoch. */ - readonly accepted_at?: number | null; + readonly accepted_at?: number | null /** * Format: unix-time * @description The time that the quote was canceled. Measured in seconds since Unix epoch. */ - readonly canceled_at?: number | null; + readonly canceled_at?: number | null /** * Format: unix-time * @description The time that the quote was finalized. Measured in seconds since Unix epoch. */ - readonly finalized_at?: number | null; - }; + readonly finalized_at?: number | null + } /** QuotesResourceSubscriptionData */ readonly quotes_resource_subscription_data: { /** * Format: unix-time * @description 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. */ - readonly effective_date?: number | null; + readonly effective_date?: number | null /** @description Integer representing the number of trial period days before the customer is charged for the first time. */ - readonly trial_period_days?: number | null; - }; + readonly trial_period_days?: number | null + } /** QuotesResourceTotalDetails */ readonly quotes_resource_total_details: { /** @description This is the sum of all the line item discounts. */ - readonly amount_discount: number; + readonly amount_discount: number /** @description This is the sum of all the line item shipping amounts. */ - readonly amount_shipping?: number | null; + readonly amount_shipping?: number | null /** @description This is the sum of all the line item tax amounts. */ - readonly amount_tax: number; - readonly breakdown?: components["schemas"]["quotes_resource_total_details_resource_breakdown"]; - }; + readonly amount_tax: number + readonly breakdown?: components['schemas']['quotes_resource_total_details_resource_breakdown'] + } /** QuotesResourceTotalDetailsResourceBreakdown */ readonly quotes_resource_total_details_resource_breakdown: { /** @description The aggregated line item discounts. */ - readonly discounts: readonly components["schemas"]["line_items_discount_amount"][]; + readonly discounts: readonly components['schemas']['line_items_discount_amount'][] /** @description The aggregated line item tax amounts by rate. */ - readonly taxes: readonly components["schemas"]["line_items_tax_amount"][]; - }; + readonly taxes: readonly components['schemas']['line_items_tax_amount'][] + } /** QuotesResourceTransferData */ readonly quotes_resource_transfer_data: { /** @description The amount in %s that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination. */ - readonly amount?: number | null; + readonly amount?: number | null /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the destination account. By default, the entire amount will be transferred to the destination. */ - readonly amount_percent?: number | null; + readonly amount_percent?: number | null /** @description The account where funds from the payment will be transferred to upon payment success. */ - readonly destination: Partial & Partial; - }; + readonly destination: Partial & Partial + } /** QuotesResourceUpfront */ readonly quotes_resource_upfront: { /** @description Total before any discounts or taxes are applied. */ - readonly amount_subtotal: number; + readonly amount_subtotal: number /** @description Total after discounts and taxes are applied. */ - readonly amount_total: number; + readonly amount_total: number /** * QuotesResourceListLineItems * @description 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. */ readonly line_items?: { /** @description Details about each object. */ - readonly data: readonly components["schemas"]["item"][]; + readonly data: readonly components['schemas']['item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - readonly total_details: components["schemas"]["quotes_resource_total_details"]; - }; + readonly url: string + } + readonly total_details: components['schemas']['quotes_resource_total_details'] + } /** * RadarEarlyFraudWarning * @description An early fraud warning indicates that the card issuer has notified us that a @@ -11944,142 +11799,134 @@ export interface components { * * Related guide: [Early Fraud Warnings](https://stripe.com/docs/disputes/measuring#early-fraud-warnings). */ - readonly "radar.early_fraud_warning": { + readonly 'radar.early_fraud_warning': { /** @description 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. */ - readonly actionable: boolean; + readonly actionable: boolean /** @description ID of the charge this early fraud warning is for, optionally expanded. */ - readonly charge: Partial & Partial; + readonly charge: Partial & Partial /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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`. */ - readonly fraud_type: string; + readonly fraud_type: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "radar.early_fraud_warning"; + readonly object: 'radar.early_fraud_warning' /** @description ID of the Payment Intent this early fraud warning is for, optionally expanded. */ - readonly payment_intent?: Partial & Partial; - }; + readonly payment_intent?: Partial & Partial + } /** * RadarListList * @description Value lists allow you to group values together which can then be referenced in rules. * * Related guide: [Default Stripe Lists](https://stripe.com/docs/radar/lists#managing-list-items). */ - readonly "radar.value_list": { + readonly 'radar.value_list': { /** @description The name of the value list for use in rules. */ - readonly alias: string; + readonly alias: string /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description The name or email address of the user who created this value list. */ - readonly created_by: string; + readonly created_by: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description The type of items in the value list. One of `card_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, `case_sensitive_string`, or `customer_id`. * @enum {string} */ - readonly item_type: - | "card_bin" - | "card_fingerprint" - | "case_sensitive_string" - | "country" - | "customer_id" - | "email" - | "ip_address" - | "string"; + readonly item_type: 'card_bin' | 'card_fingerprint' | 'case_sensitive_string' | 'country' | 'customer_id' | 'email' | 'ip_address' | 'string' /** * RadarListListItemList * @description List of items contained within this value list. */ readonly list_items: { /** @description Details about each object. */ - readonly data: readonly components["schemas"]["radar.value_list_item"][]; + readonly data: readonly components['schemas']['radar.value_list_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; + readonly url: string + } /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata: { readonly [key: string]: string }; + readonly metadata: { readonly [key: string]: string } /** @description The name of the value list. */ - readonly name: string; + readonly name: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "radar.value_list"; - }; + readonly object: 'radar.value_list' + } /** * RadarListListItem * @description Value list items allow you to add specific values to a given Radar value list, which can then be used in rules. * * Related guide: [Managing List Items](https://stripe.com/docs/radar/lists#managing-list-items). */ - readonly "radar.value_list_item": { + readonly 'radar.value_list_item': { /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description The name or email address of the user who added this item to the value list. */ - readonly created_by: string; + readonly created_by: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "radar.value_list_item"; + readonly object: 'radar.value_list_item' /** @description The value of the item. */ - readonly value: string; + readonly value: string /** @description The identifier of the value list this item belongs to. */ - readonly value_list: string; - }; + readonly value_list: string + } /** RadarReviewResourceLocation */ readonly radar_review_resource_location: { /** @description The city where the payment originated. */ - readonly city?: string | null; + readonly city?: string | null /** @description Two-letter ISO code representing the country where the payment originated. */ - readonly country?: string | null; + readonly country?: string | null /** @description The geographic latitude where the payment originated. */ - readonly latitude?: number | null; + readonly latitude?: number | null /** @description The geographic longitude where the payment originated. */ - readonly longitude?: number | null; + readonly longitude?: number | null /** @description The state/county/province/region where the payment originated. */ - readonly region?: string | null; - }; + readonly region?: string | null + } /** RadarReviewResourceSession */ readonly radar_review_resource_session: { /** @description The browser used in this browser session (e.g., `Chrome`). */ - readonly browser?: string | null; + readonly browser?: string | null /** @description Information about the device used for the browser session (e.g., `Samsung SM-G930T`). */ - readonly device?: string | null; + readonly device?: string | null /** @description The platform for the browser session (e.g., `Macintosh`). */ - readonly platform?: string | null; + readonly platform?: string | null /** @description The version for the browser session (e.g., `61.0.3163.100`). */ - readonly version?: string | null; - }; + readonly version?: string | null + } /** * TransferRecipient * @description With `Recipient` objects, you can transfer money from your Stripe account to a @@ -12095,69 +11942,69 @@ export interface components { */ readonly recipient: { /** @description Hash describing the current account on the recipient, if there is one. */ - readonly active_account?: Partial | null; + readonly active_account?: Partial | null /** CardList */ readonly cards?: { - readonly data: readonly components["schemas"]["card"][]; + readonly data: readonly components['schemas']['card'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - } | null; + readonly url: string + } | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description The default card to use for creating transfers to this recipient. */ - readonly default_card?: (Partial & Partial) | null; + readonly default_card?: (Partial & Partial) | null /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string | null; - readonly email?: string | null; + readonly description?: string | null + readonly email?: string | null /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata: { readonly [key: string]: string }; + readonly metadata: { readonly [key: string]: string } /** @description The ID of the [Custom account](https://stripe.com/docs/connect/custom-accounts) this recipient was migrated to. If set, the recipient can no longer be updated, nor can transfers be made to it: use the Custom account instead. */ - readonly migrated_to?: (Partial & Partial) | null; + readonly migrated_to?: (Partial & Partial) | null /** @description Full, legal name of the recipient. */ - readonly name?: string | null; + readonly name?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "recipient"; - readonly rolled_back_from?: Partial & Partial; + readonly object: 'recipient' + readonly rolled_back_from?: Partial & Partial /** @description Type of the recipient, one of `individual` or `corporation`. */ - readonly type: string; - }; + readonly type: string + } /** Recurring */ readonly recurring: { /** * @description Specifies a usage aggregation strategy for prices 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`. * @enum {string|null} */ - readonly aggregate_usage?: ("last_during_period" | "last_ever" | "max" | "sum") | null; + readonly aggregate_usage?: ('last_during_period' | 'last_ever' | 'max' | 'sum') | null /** * @description The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`. * @enum {string} */ - readonly interval: "day" | "month" | "week" | "year"; + readonly interval: 'day' | 'month' | 'week' | 'year' /** @description The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. */ - readonly interval_count: number; + readonly interval_count: number /** * @description 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`. * @enum {string} */ - readonly usage_type: "licensed" | "metered"; - }; + readonly usage_type: 'licensed' | 'metered' + } /** * Refund * @description `Refund` objects allow you to refund a charge that has previously been created @@ -12168,51 +12015,49 @@ export interface components { */ readonly refund: { /** @description Amount, in %s. */ - readonly amount: number; + readonly amount: number /** @description Balance transaction that describes the impact on your account balance. */ - readonly balance_transaction?: (Partial & Partial) | null; + readonly balance_transaction?: (Partial & Partial) | null /** @description ID of the charge that was refunded. */ - readonly charge?: (Partial & Partial) | null; + readonly charge?: (Partial & Partial) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. (Available on non-card refunds only) */ - readonly description?: string; + readonly description?: string /** @description If the refund failed, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction. */ - readonly failure_balance_transaction?: Partial & Partial; + readonly failure_balance_transaction?: Partial & Partial /** @description If the refund failed, the reason for refund failure if known. Possible values are `lost_or_stolen_card`, `expired_or_canceled_card`, or `unknown`. */ - readonly failure_reason?: string; + readonly failure_reason?: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description 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. */ - readonly metadata?: { readonly [key: string]: string } | null; + readonly metadata?: { readonly [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "refund"; + readonly object: 'refund' /** @description ID of the PaymentIntent that was refunded. */ - readonly payment_intent?: (Partial & Partial) | null; + readonly payment_intent?: (Partial & Partial) | null /** * @description Reason for the refund, either user-provided (`duplicate`, `fraudulent`, or `requested_by_customer`) or generated by Stripe internally (`expired_uncaptured_charge`). * @enum {string|null} */ - readonly reason?: ("duplicate" | "expired_uncaptured_charge" | "fraudulent" | "requested_by_customer") | null; + readonly reason?: ('duplicate' | 'expired_uncaptured_charge' | 'fraudulent' | 'requested_by_customer') | null /** @description This is the transaction number that appears on email receipts sent for this refund. */ - readonly receipt_number?: string | null; + readonly receipt_number?: string | null /** @description The transfer reversal that is associated with the refund. Only present if the charge came from another Stripe account. See the Connect documentation for details. */ - readonly source_transfer_reversal?: - | (Partial & Partial) - | null; + readonly source_transfer_reversal?: (Partial & Partial) | null /** @description Status of the refund. For credit card refunds, this can be `pending`, `succeeded`, or `failed`. For other types of refunds, it can be `pending`, `succeeded`, `failed`, or `canceled`. Refer to our [refunds](https://stripe.com/docs/refunds#failed-refunds) documentation for more details. */ - readonly status?: string | null; + readonly status?: string | null /** @description If the accompanying transfer was reversed, the transfer reversal object. Only applicable if the charge was created using the destination parameter. */ - readonly transfer_reversal?: (Partial & Partial) | null; - }; + readonly transfer_reversal?: (Partial & Partial) | null + } /** * reporting_report_run * @description The Report Run object represents an instance of a report type generated with @@ -12224,47 +12069,47 @@ export interface components { * Note that certain report types can only be run based on your live-mode data (not test-mode * data), and will error when queried without a [live-mode API key](https://stripe.com/docs/keys#test-live-modes). */ - readonly "reporting.report_run": { + readonly 'reporting.report_run': { /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** * @description If something should go wrong during the run, a message about the failure (populated when * `status=failed`). */ - readonly error?: string | null; + readonly error?: string | null /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description `true` if the report is run on live mode data and `false` if it is run on test mode data. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "reporting.report_run"; - readonly parameters: components["schemas"]["financial_reporting_finance_report_run_run_parameters"]; + readonly object: 'reporting.report_run' + readonly parameters: components['schemas']['financial_reporting_finance_report_run_run_parameters'] /** @description The ID of the [report type](https://stripe.com/docs/reports/report-types) to run, such as `"balance.summary.1"`. */ - readonly report_type: string; + readonly report_type: string /** * @description The file object representing the result of the report run (populated when * `status=succeeded`). */ - readonly result?: Partial | null; + readonly result?: Partial | null /** * @description 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. * Rarely, we may encounter an error, at which point this will be set to `failed` and the `error` field will be populated. */ - readonly status: string; + readonly status: string /** * Format: unix-time * @description Timestamp at which this run successfully finished (populated when * `status=succeeded`). Measured in seconds since the Unix epoch. */ - readonly succeeded_at?: number | null; - }; + readonly succeeded_at?: number | null + } /** * reporting_report_type * @description The Report Type resource corresponds to a particular type of report, such as @@ -12276,53 +12121,53 @@ export interface components { * Note that certain report types can only be run based on your live-mode data (not test-mode * data), and will error when queried without a [live-mode API key](https://stripe.com/docs/keys#test-live-modes). */ - readonly "reporting.report_type": { + readonly 'reporting.report_type': { /** * Format: unix-time * @description Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch. */ - readonly data_available_end: number; + readonly data_available_end: number /** * Format: unix-time * @description Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch. */ - readonly data_available_start: number; + readonly data_available_start: number /** @description 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.) */ - readonly default_columns?: readonly string[] | null; + readonly default_columns?: readonly string[] | null /** @description The [ID of the Report Type](https://stripe.com/docs/reporting/statements/api#available-report-types), such as `balance.summary.1`. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description Human-readable name of the Report Type */ - readonly name: string; + readonly name: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "reporting.report_type"; + readonly object: 'reporting.report_type' /** * Format: unix-time * @description When this Report Type was latest updated. Measured in seconds since the Unix epoch. */ - readonly updated: number; + readonly updated: number /** @description 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. */ - readonly version: number; - }; + readonly version: number + } /** ReserveTransaction */ readonly reserve_transaction: { - readonly amount: number; + readonly amount: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string | null; + readonly description?: string | null /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "reserve_transaction"; - }; + readonly object: 'reserve_transaction' + } /** * RadarReview * @description Reviews can be used to supplement automated fraud detection with human expertise. @@ -12332,55 +12177,55 @@ export interface components { */ readonly review: { /** @description The ZIP or postal code of the card used, if applicable. */ - readonly billing_zip?: string | null; + readonly billing_zip?: string | null /** @description The charge associated with this review. */ - readonly charge?: (Partial & Partial) | null; + readonly charge?: (Partial & Partial) | null /** * @description 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`. * @enum {string|null} */ - readonly closed_reason?: ("approved" | "disputed" | "redacted" | "refunded" | "refunded_as_fraud") | null; + readonly closed_reason?: ('approved' | 'disputed' | 'redacted' | 'refunded' | 'refunded_as_fraud') | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description The IP address where the payment originated. */ - readonly ip_address?: string | null; + readonly ip_address?: string | null /** @description 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. */ - readonly ip_address_location?: Partial | null; + readonly ip_address_location?: Partial | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "review"; + readonly object: 'review' /** @description If `true`, the review needs action. */ - readonly open: boolean; + readonly open: boolean /** * @description The reason the review was opened. One of `rule` or `manual`. * @enum {string} */ - readonly opened_reason: "manual" | "rule"; + readonly opened_reason: 'manual' | 'rule' /** @description The PaymentIntent ID associated with this review, if one exists. */ - readonly payment_intent?: Partial & Partial; + readonly payment_intent?: Partial & Partial /** @description The reason the review is currently open or closed. One of `rule`, `manual`, `approved`, `refunded`, `refunded_as_fraud`, `disputed`, or `redacted`. */ - readonly reason: string; + readonly reason: string /** @description Information related to the browsing session of the user who initiated the payment. */ - readonly session?: Partial | null; - }; + readonly session?: Partial | null + } /** RadarRule */ readonly rule: { /** @description The action taken on the payment. */ - readonly action: string; + readonly action: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description The predicate to evaluate the payment against. */ - readonly predicate: string; - }; + readonly predicate: string + } /** * ScheduledQueryRun * @description If you have [scheduled a Sigma query](https://stripe.com/docs/sigma/scheduled-queries), you'll @@ -12393,48 +12238,48 @@ export interface components { * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** * Format: unix-time * @description When the query was run, Sigma contained a snapshot of your Stripe data at this time. */ - readonly data_load_time: number; - readonly error?: components["schemas"]["sigma_scheduled_query_run_error"]; + readonly data_load_time: number + readonly error?: components['schemas']['sigma_scheduled_query_run_error'] /** @description The file object representing the results of the query. */ - readonly file?: Partial | null; + readonly file?: Partial | null /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "scheduled_query_run"; + readonly object: 'scheduled_query_run' /** * Format: unix-time * @description Time at which the result expires and is no longer available for download. */ - readonly result_available_until: number; + readonly result_available_until: number /** @description SQL for the query. */ - readonly sql: string; + readonly sql: string /** @description The query's execution status, which will be `completed` for successful runs, and `canceled`, `failed`, or `timed_out` otherwise. */ - readonly status: string; + readonly status: string /** @description Title of the query. */ - readonly title: string; - }; + readonly title: string + } /** SchedulesPhaseAutomaticTax */ readonly schedules_phase_automatic_tax: { /** @description Whether Stripe automatically computes tax on invoices created during this phase. */ - readonly enabled: boolean; - }; + readonly enabled: boolean + } /** sepa_debit_generated_from */ readonly sepa_debit_generated_from: { /** @description The ID of the Charge that generated this PaymentMethod, if any. */ - readonly charge?: (Partial & Partial) | null; + readonly charge?: (Partial & Partial) | null /** @description The ID of the SetupAttempt that generated this PaymentMethod, if any. */ - readonly setup_attempt?: (Partial & Partial) | null; - }; + readonly setup_attempt?: (Partial & Partial) | null + } /** * PaymentFlowsSetupIntentSetupAttempt * @description A SetupAttempt describes one attempted confirmation of a SetupIntent, @@ -12444,100 +12289,96 @@ export interface components { */ readonly setup_attempt: { /** @description 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. */ - readonly application?: (Partial & Partial) | null; + readonly application?: (Partial & Partial) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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. */ - readonly customer?: - | (Partial & - Partial & - Partial) - | null; + readonly customer?: (Partial & Partial & Partial) | null /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "setup_attempt"; + readonly object: 'setup_attempt' /** @description 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. */ - readonly on_behalf_of?: (Partial & Partial) | null; + readonly on_behalf_of?: (Partial & Partial) | null /** @description ID of the payment method used with this SetupAttempt. */ - readonly payment_method: Partial & Partial; - readonly payment_method_details: components["schemas"]["setup_attempt_payment_method_details"]; + readonly payment_method: Partial & Partial + readonly payment_method_details: components['schemas']['setup_attempt_payment_method_details'] /** @description The error encountered during this attempt to confirm the SetupIntent, if any. */ - readonly setup_error?: Partial | null; + readonly setup_error?: Partial | null /** @description ID of the SetupIntent that this attempt belongs to. */ - readonly setup_intent: Partial & Partial; + readonly setup_intent: Partial & Partial /** @description Status of this SetupAttempt, one of `requires_confirmation`, `requires_action`, `processing`, `succeeded`, `failed`, or `abandoned`. */ - readonly status: string; + readonly status: string /** @description 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`. */ - readonly usage: string; - }; + readonly usage: string + } /** SetupAttemptPaymentMethodDetails */ readonly setup_attempt_payment_method_details: { - readonly acss_debit?: components["schemas"]["setup_attempt_payment_method_details_acss_debit"]; - readonly au_becs_debit?: components["schemas"]["setup_attempt_payment_method_details_au_becs_debit"]; - readonly bacs_debit?: components["schemas"]["setup_attempt_payment_method_details_bacs_debit"]; - readonly bancontact?: components["schemas"]["setup_attempt_payment_method_details_bancontact"]; - readonly boleto?: components["schemas"]["setup_attempt_payment_method_details_boleto"]; - readonly card?: components["schemas"]["setup_attempt_payment_method_details_card"]; - readonly card_present?: components["schemas"]["setup_attempt_payment_method_details_card_present"]; - readonly ideal?: components["schemas"]["setup_attempt_payment_method_details_ideal"]; - readonly sepa_debit?: components["schemas"]["setup_attempt_payment_method_details_sepa_debit"]; - readonly sofort?: components["schemas"]["setup_attempt_payment_method_details_sofort"]; + readonly acss_debit?: components['schemas']['setup_attempt_payment_method_details_acss_debit'] + readonly au_becs_debit?: components['schemas']['setup_attempt_payment_method_details_au_becs_debit'] + readonly bacs_debit?: components['schemas']['setup_attempt_payment_method_details_bacs_debit'] + readonly bancontact?: components['schemas']['setup_attempt_payment_method_details_bancontact'] + readonly boleto?: components['schemas']['setup_attempt_payment_method_details_boleto'] + readonly card?: components['schemas']['setup_attempt_payment_method_details_card'] + readonly card_present?: components['schemas']['setup_attempt_payment_method_details_card_present'] + readonly ideal?: components['schemas']['setup_attempt_payment_method_details_ideal'] + readonly sepa_debit?: components['schemas']['setup_attempt_payment_method_details_sepa_debit'] + readonly sofort?: components['schemas']['setup_attempt_payment_method_details_sofort'] /** @description 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. */ - readonly type: string; - }; + readonly type: string + } /** setup_attempt_payment_method_details_acss_debit */ - readonly setup_attempt_payment_method_details_acss_debit: { readonly [key: string]: unknown }; + readonly setup_attempt_payment_method_details_acss_debit: { readonly [key: string]: unknown } /** setup_attempt_payment_method_details_au_becs_debit */ - readonly setup_attempt_payment_method_details_au_becs_debit: { readonly [key: string]: unknown }; + readonly setup_attempt_payment_method_details_au_becs_debit: { readonly [key: string]: unknown } /** setup_attempt_payment_method_details_bacs_debit */ - readonly setup_attempt_payment_method_details_bacs_debit: { readonly [key: string]: unknown }; + readonly setup_attempt_payment_method_details_bacs_debit: { readonly [key: string]: unknown } /** setup_attempt_payment_method_details_bancontact */ readonly setup_attempt_payment_method_details_bancontact: { /** @description Bank code of bank associated with the bank account. */ - readonly bank_code?: string | null; + readonly bank_code?: string | null /** @description Name of the bank associated with the bank account. */ - readonly bank_name?: string | null; + readonly bank_name?: string | null /** @description Bank Identifier Code of the bank associated with the bank account. */ - readonly bic?: string | null; + readonly bic?: string | null /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ - readonly generated_sepa_debit?: (Partial & Partial) | null; + readonly generated_sepa_debit?: (Partial & Partial) | null /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ - readonly generated_sepa_debit_mandate?: (Partial & Partial) | null; + readonly generated_sepa_debit_mandate?: (Partial & Partial) | null /** @description Last four characters of the IBAN. */ - readonly iban_last4?: string | null; + readonly iban_last4?: string | null /** * @description Preferred language of the Bancontact authorization page that the customer is redirected to. * Can be one of `en`, `de`, `fr`, or `nl` * @enum {string|null} */ - readonly preferred_language?: ("de" | "en" | "fr" | "nl") | null; + readonly preferred_language?: ('de' | 'en' | 'fr' | 'nl') | null /** * @description Owner's verified full name. Values are verified or provided by Bancontact directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - readonly verified_name?: string | null; - }; + readonly verified_name?: string | null + } /** setup_attempt_payment_method_details_boleto */ - readonly setup_attempt_payment_method_details_boleto: { readonly [key: string]: unknown }; + readonly setup_attempt_payment_method_details_boleto: { readonly [key: string]: unknown } /** setup_attempt_payment_method_details_card */ readonly setup_attempt_payment_method_details_card: { /** @description Populated if this authorization used 3D Secure authentication. */ - readonly three_d_secure?: Partial | null; - }; + readonly three_d_secure?: Partial | null + } /** setup_attempt_payment_method_details_card_present */ readonly setup_attempt_payment_method_details_card_present: { /** @description The ID of the Card PaymentMethod which was generated by this SetupAttempt. */ - readonly generated_card?: (Partial & Partial) | null; - }; + readonly generated_card?: (Partial & Partial) | null + } /** setup_attempt_payment_method_details_ideal */ readonly setup_attempt_payment_method_details_ideal: { /** @@ -12546,82 +12387,82 @@ export interface components { */ readonly bank?: | ( - | "abn_amro" - | "asn_bank" - | "bunq" - | "handelsbanken" - | "ing" - | "knab" - | "moneyou" - | "rabobank" - | "regiobank" - | "revolut" - | "sns_bank" - | "triodos_bank" - | "van_lanschot" + | 'abn_amro' + | 'asn_bank' + | 'bunq' + | 'handelsbanken' + | 'ing' + | 'knab' + | 'moneyou' + | 'rabobank' + | 'regiobank' + | 'revolut' + | 'sns_bank' + | 'triodos_bank' + | 'van_lanschot' ) - | null; + | null /** * @description The Bank Identifier Code of the customer's bank. * @enum {string|null} */ readonly bic?: | ( - | "ABNANL2A" - | "ASNBNL21" - | "BUNQNL2A" - | "FVLBNL22" - | "HANDNL2A" - | "INGBNL2A" - | "KNABNL2H" - | "MOYONL21" - | "RABONL2U" - | "RBRBNL21" - | "REVOLT21" - | "SNSBNL2A" - | "TRIONL2U" + | 'ABNANL2A' + | 'ASNBNL21' + | 'BUNQNL2A' + | 'FVLBNL22' + | 'HANDNL2A' + | 'INGBNL2A' + | 'KNABNL2H' + | 'MOYONL21' + | 'RABONL2U' + | 'RBRBNL21' + | 'REVOLT21' + | 'SNSBNL2A' + | 'TRIONL2U' ) - | null; + | null /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ - readonly generated_sepa_debit?: (Partial & Partial) | null; + readonly generated_sepa_debit?: (Partial & Partial) | null /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ - readonly generated_sepa_debit_mandate?: (Partial & Partial) | null; + readonly generated_sepa_debit_mandate?: (Partial & Partial) | null /** @description Last four characters of the IBAN. */ - readonly iban_last4?: string | null; + readonly iban_last4?: string | null /** * @description Owner's verified full name. Values are verified or provided by iDEAL directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - readonly verified_name?: string | null; - }; + readonly verified_name?: string | null + } /** setup_attempt_payment_method_details_sepa_debit */ - readonly setup_attempt_payment_method_details_sepa_debit: { readonly [key: string]: unknown }; + readonly setup_attempt_payment_method_details_sepa_debit: { readonly [key: string]: unknown } /** setup_attempt_payment_method_details_sofort */ readonly setup_attempt_payment_method_details_sofort: { /** @description Bank code of bank associated with the bank account. */ - readonly bank_code?: string | null; + readonly bank_code?: string | null /** @description Name of the bank associated with the bank account. */ - readonly bank_name?: string | null; + readonly bank_name?: string | null /** @description Bank Identifier Code of the bank associated with the bank account. */ - readonly bic?: string | null; + readonly bic?: string | null /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ - readonly generated_sepa_debit?: (Partial & Partial) | null; + readonly generated_sepa_debit?: (Partial & Partial) | null /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ - readonly generated_sepa_debit_mandate?: (Partial & Partial) | null; + readonly generated_sepa_debit_mandate?: (Partial & Partial) | null /** @description Last four characters of the IBAN. */ - readonly iban_last4?: string | null; + readonly iban_last4?: string | null /** * @description Preferred language of the Sofort authorization page that the customer is redirected to. * Can be one of `en`, `de`, `fr`, or `nl` * @enum {string|null} */ - readonly preferred_language?: ("de" | "en" | "fr" | "nl") | null; + readonly preferred_language?: ('de' | 'en' | 'fr' | 'nl') | null /** * @description Owner's verified full name. Values are verified or provided by Sofort directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - readonly verified_name?: string | null; - }; + readonly verified_name?: string | null + } /** * SetupIntent * @description A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. @@ -12649,186 +12490,176 @@ export interface components { */ readonly setup_intent: { /** @description ID of the Connect application that created the SetupIntent. */ - readonly application?: (Partial & Partial) | null; + readonly application?: (Partial & Partial) | null /** * @description Reason for cancellation of this SetupIntent, one of `abandoned`, `requested_by_customer`, or `duplicate`. * @enum {string|null} */ - readonly cancellation_reason?: ("abandoned" | "duplicate" | "requested_by_customer") | null; + readonly cancellation_reason?: ('abandoned' | 'duplicate' | 'requested_by_customer') | null /** * @description The client secret of this SetupIntent. Used for client-side retrieval using a publishable key. * * The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, embedded in URLs, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret. */ - readonly client_secret?: string | null; + readonly client_secret?: string | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** * @description ID of the Customer this SetupIntent belongs to, if one exists. * * If 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. */ - readonly customer?: - | (Partial & - Partial & - Partial) - | null; + readonly customer?: (Partial & Partial & Partial) | null /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string | null; + readonly description?: string | null /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description The error encountered in the previous SetupIntent confirmation. */ - readonly last_setup_error?: Partial | null; + readonly last_setup_error?: Partial | null /** @description The most recent SetupAttempt for this SetupIntent. */ - readonly latest_attempt?: (Partial & Partial) | null; + readonly latest_attempt?: (Partial & Partial) | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description ID of the multi use Mandate generated by the SetupIntent. */ - readonly mandate?: (Partial & Partial) | null; + readonly mandate?: (Partial & Partial) | null /** @description 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. */ - readonly metadata?: { readonly [key: string]: string } | null; + readonly metadata?: { readonly [key: string]: string } | null /** @description If present, this property tells you what actions you need to take in order for your customer to continue payment setup. */ - readonly next_action?: Partial | null; + readonly next_action?: Partial | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "setup_intent"; + readonly object: 'setup_intent' /** @description The account (if any) for which the setup is intended. */ - readonly on_behalf_of?: (Partial & Partial) | null; + readonly on_behalf_of?: (Partial & Partial) | null /** @description ID of the payment method used with this SetupIntent. */ - readonly payment_method?: (Partial & Partial) | null; + readonly payment_method?: (Partial & Partial) | null /** @description Payment-method-specific configuration for this SetupIntent. */ - readonly payment_method_options?: Partial | null; + readonly payment_method_options?: Partial | null /** @description The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. */ - readonly payment_method_types: readonly string[]; + readonly payment_method_types: readonly string[] /** @description ID of the single_use Mandate generated by the SetupIntent. */ - readonly single_use_mandate?: (Partial & Partial) | null; + readonly single_use_mandate?: (Partial & Partial) | null /** * @description [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`. * @enum {string} */ - readonly status: - | "canceled" - | "processing" - | "requires_action" - | "requires_confirmation" - | "requires_payment_method" - | "succeeded"; + readonly status: 'canceled' | 'processing' | 'requires_action' | 'requires_confirmation' | 'requires_payment_method' | 'succeeded' /** * @description Indicates how the payment method is intended to be used in the future. * * Use `on_session` if you intend to only reuse the payment method when the customer is in your checkout flow. Use `off_session` if your customer may or may not be in your checkout flow. If not provided, this value defaults to `off_session`. */ - readonly usage: string; - }; + readonly usage: string + } /** SetupIntentNextAction */ readonly setup_intent_next_action: { - readonly redirect_to_url?: components["schemas"]["setup_intent_next_action_redirect_to_url"]; + readonly redirect_to_url?: components['schemas']['setup_intent_next_action_redirect_to_url'] /** @description 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`. */ - readonly type: string; + readonly type: string /** @description 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. */ - readonly use_stripe_sdk?: { readonly [key: string]: unknown }; - readonly verify_with_microdeposits?: components["schemas"]["setup_intent_next_action_verify_with_microdeposits"]; - }; + readonly use_stripe_sdk?: { readonly [key: string]: unknown } + readonly verify_with_microdeposits?: components['schemas']['setup_intent_next_action_verify_with_microdeposits'] + } /** SetupIntentNextActionRedirectToUrl */ readonly setup_intent_next_action_redirect_to_url: { /** @description If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion. */ - readonly return_url?: string | null; + readonly return_url?: string | null /** @description The URL you must redirect your customer to in order to authenticate. */ - readonly url?: string | null; - }; + readonly url?: string | null + } /** SetupIntentNextActionVerifyWithMicrodeposits */ readonly setup_intent_next_action_verify_with_microdeposits: { /** * Format: unix-time * @description The timestamp when the microdeposits are expected to land. */ - readonly arrival_date: number; + readonly arrival_date: number /** @description The URL for the hosted verification page, which allows customers to verify their bank account. */ - readonly hosted_verification_url: string; - }; + readonly hosted_verification_url: string + } /** SetupIntentPaymentMethodOptions */ readonly setup_intent_payment_method_options: { - readonly acss_debit?: components["schemas"]["setup_intent_payment_method_options_acss_debit"]; - readonly card?: components["schemas"]["setup_intent_payment_method_options_card"]; - readonly sepa_debit?: components["schemas"]["setup_intent_payment_method_options_sepa_debit"]; - }; + readonly acss_debit?: components['schemas']['setup_intent_payment_method_options_acss_debit'] + readonly card?: components['schemas']['setup_intent_payment_method_options_card'] + readonly sepa_debit?: components['schemas']['setup_intent_payment_method_options_sepa_debit'] + } /** setup_intent_payment_method_options_acss_debit */ readonly setup_intent_payment_method_options_acss_debit: { /** * @description Currency supported by the bank account * @enum {string|null} */ - readonly currency?: ("cad" | "usd") | null; - readonly mandate_options?: components["schemas"]["setup_intent_payment_method_options_mandate_options_acss_debit"]; + readonly currency?: ('cad' | 'usd') | null + readonly mandate_options?: components['schemas']['setup_intent_payment_method_options_mandate_options_acss_debit'] /** * @description Bank account verification method. * @enum {string} */ - readonly verification_method?: "automatic" | "instant" | "microdeposits"; - }; + readonly verification_method?: 'automatic' | 'instant' | 'microdeposits' + } /** setup_intent_payment_method_options_card */ readonly setup_intent_payment_method_options_card: { /** * @description 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. Permitted values include: `automatic` or `any`. If not provided, defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. * @enum {string|null} */ - readonly request_three_d_secure?: ("any" | "automatic" | "challenge_only") | null; - }; + readonly request_three_d_secure?: ('any' | 'automatic' | 'challenge_only') | null + } /** setup_intent_payment_method_options_mandate_options_acss_debit */ readonly setup_intent_payment_method_options_mandate_options_acss_debit: { /** @description A URL for custom mandate text */ - readonly custom_mandate_url?: string; + readonly custom_mandate_url?: string /** @description List of Stripe products where this mandate can be selected automatically. */ - readonly default_for?: readonly ("invoice" | "subscription")[]; + readonly default_for?: readonly ('invoice' | 'subscription')[] /** @description Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. */ - readonly interval_description?: string | null; + readonly interval_description?: string | null /** * @description Payment schedule for the mandate. * @enum {string|null} */ - readonly payment_schedule?: ("combined" | "interval" | "sporadic") | null; + readonly payment_schedule?: ('combined' | 'interval' | 'sporadic') | null /** * @description Transaction type of the mandate. * @enum {string|null} */ - readonly transaction_type?: ("business" | "personal") | null; - }; + readonly transaction_type?: ('business' | 'personal') | null + } /** setup_intent_payment_method_options_mandate_options_sepa_debit */ - readonly setup_intent_payment_method_options_mandate_options_sepa_debit: { readonly [key: string]: unknown }; + readonly setup_intent_payment_method_options_mandate_options_sepa_debit: { readonly [key: string]: unknown } /** setup_intent_payment_method_options_sepa_debit */ readonly setup_intent_payment_method_options_sepa_debit: { - readonly mandate_options?: components["schemas"]["setup_intent_payment_method_options_mandate_options_sepa_debit"]; - }; + readonly mandate_options?: components['schemas']['setup_intent_payment_method_options_mandate_options_sepa_debit'] + } /** Shipping */ readonly shipping: { - readonly address?: components["schemas"]["address"]; + readonly address?: components['schemas']['address'] /** @description The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. */ - readonly carrier?: string | null; + readonly carrier?: string | null /** @description Recipient name. */ - readonly name?: string | null; + readonly name?: string | null /** @description Recipient phone (including extension). */ - readonly phone?: string | null; + readonly phone?: string | null /** @description 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. */ - readonly tracking_number?: string | null; - }; + readonly tracking_number?: string | null + } /** ShippingMethod */ readonly shipping_method: { /** @description 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 line item. */ - readonly amount: number; + readonly amount: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description The estimated delivery date for the given shipping method. Can be either a specific date or a range. */ - readonly delivery_estimate?: Partial | null; + readonly delivery_estimate?: Partial | null /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description: string; + readonly description: string /** @description Unique identifier for the object. */ - readonly id: string; - }; + readonly id: string + } /** * ShippingRate * @description Shipping rates describe the price of shipping presented to your customers and can be @@ -12836,70 +12667,70 @@ export interface components { */ readonly shipping_rate: { /** @description Whether the shipping rate can be used for new purchases. Defaults to `true`. */ - readonly active: boolean; + readonly active: boolean /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions. */ - readonly delivery_estimate?: Partial | null; + readonly delivery_estimate?: Partial | null /** @description The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions. */ - readonly display_name?: string | null; - readonly fixed_amount?: components["schemas"]["shipping_rate_fixed_amount"]; + readonly display_name?: string | null + readonly fixed_amount?: components['schemas']['shipping_rate_fixed_amount'] /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata: { readonly [key: string]: string }; + readonly metadata: { readonly [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "shipping_rate"; + readonly object: 'shipping_rate' /** * @description Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. * @enum {string|null} */ - readonly tax_behavior?: ("exclusive" | "inclusive" | "unspecified") | null; + readonly tax_behavior?: ('exclusive' | 'inclusive' | 'unspecified') | null /** @description A [tax code](https://stripe.com/docs/tax/tax-codes) ID. The Shipping tax code is `txcd_92010001`. */ - readonly tax_code?: (Partial & Partial) | null; + readonly tax_code?: (Partial & Partial) | null /** * @description The type of calculation to use on the shipping rate. Can only be `fixed_amount` for now. * @enum {string} */ - readonly type: "fixed_amount"; - }; + readonly type: 'fixed_amount' + } /** ShippingRateDeliveryEstimate */ readonly shipping_rate_delivery_estimate: { /** @description The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite. */ - readonly maximum?: Partial | null; + readonly maximum?: Partial | null /** @description The lower bound of the estimated range. If empty, represents no lower bound. */ - readonly minimum?: Partial | null; - }; + readonly minimum?: Partial | null + } /** ShippingRateDeliveryEstimateBound */ readonly shipping_rate_delivery_estimate_bound: { /** * @description A unit of time. * @enum {string} */ - readonly unit: "business_day" | "day" | "hour" | "month" | "week"; + readonly unit: 'business_day' | 'day' | 'hour' | 'month' | 'week' /** @description Must be greater than 0. */ - readonly value: number; - }; + readonly value: number + } /** ShippingRateFixedAmount */ readonly shipping_rate_fixed_amount: { /** @description A non-negative integer in cents representing how much to charge. */ - readonly amount: number; + readonly amount: number /** @description 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). */ - readonly currency: string; - }; + readonly currency: string + } /** SigmaScheduledQueryRunError */ readonly sigma_scheduled_query_run_error: { /** @description Information about the run failure. */ - readonly message: string; - }; + readonly message: string + } /** * Sku * @description Stores representations of [stock keeping units](http://en.wikipedia.org/wiki/Stock_keeping_unit). @@ -12913,51 +12744,51 @@ export interface components { */ readonly sku: { /** @description Whether the SKU is available for purchase. */ - readonly active: boolean; + readonly active: boolean /** @description A dictionary of attributes and values for the attributes defined by the product. If, for example, a product's attributes are `["size", "gender"]`, a valid SKU has the following dictionary of attributes: `{"size": "Medium", "gender": "Unisex"}`. */ - readonly attributes: { readonly [key: string]: string }; + readonly attributes: { readonly [key: string]: string } /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description The URL of an image for this SKU, meant to be displayable to the customer. */ - readonly image?: string | null; - readonly inventory: components["schemas"]["sku_inventory"]; + readonly image?: string | null + readonly inventory: components['schemas']['sku_inventory'] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata: { readonly [key: string]: string }; + readonly metadata: { readonly [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "sku"; + readonly object: 'sku' /** @description The dimensions of this SKU for shipping purposes. */ - readonly package_dimensions?: Partial | null; + readonly package_dimensions?: Partial | null /** @description The cost of the item as a positive integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a zero-decimal currency). */ - readonly price: number; + readonly price: number /** @description The ID of the product this SKU is associated with. The product must be currently active. */ - readonly product: Partial & Partial; + readonly product: Partial & Partial /** * Format: unix-time * @description Time at which the object was last updated. Measured in seconds since the Unix epoch. */ - readonly updated: number; - }; + readonly updated: number + } /** SKUInventory */ readonly sku_inventory: { /** @description The count of inventory available. Will be present if and only if `type` is `finite`. */ - readonly quantity?: number | null; + readonly quantity?: number | null /** @description Inventory type. Possible values are `finite`, `bucket` (not quantified), and `infinite`. */ - readonly type: string; + readonly type: string /** @description An indicator of the inventory available. Possible values are `in_stock`, `limited`, and `out_of_stock`. Will be present if and only if `type` is `bucket`. */ - readonly value?: string | null; - }; + readonly value?: string | null + } /** * Source * @description `Source` objects allow you to accept a variety of payment methods. They @@ -12968,93 +12799,93 @@ export interface components { * Related guides: [Sources API](https://stripe.com/docs/sources) and [Sources & Customers](https://stripe.com/docs/sources/customers). */ readonly source: { - readonly ach_credit_transfer?: components["schemas"]["source_type_ach_credit_transfer"]; - readonly ach_debit?: components["schemas"]["source_type_ach_debit"]; - readonly acss_debit?: components["schemas"]["source_type_acss_debit"]; - readonly alipay?: components["schemas"]["source_type_alipay"]; + readonly ach_credit_transfer?: components['schemas']['source_type_ach_credit_transfer'] + readonly ach_debit?: components['schemas']['source_type_ach_debit'] + readonly acss_debit?: components['schemas']['source_type_acss_debit'] + readonly alipay?: components['schemas']['source_type_alipay'] /** @description 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. */ - readonly amount?: number | null; - readonly au_becs_debit?: components["schemas"]["source_type_au_becs_debit"]; - readonly bancontact?: components["schemas"]["source_type_bancontact"]; - readonly card?: components["schemas"]["source_type_card"]; - readonly card_present?: components["schemas"]["source_type_card_present"]; + readonly amount?: number | null + readonly au_becs_debit?: components['schemas']['source_type_au_becs_debit'] + readonly bancontact?: components['schemas']['source_type_bancontact'] + readonly card?: components['schemas']['source_type_card'] + readonly card_present?: components['schemas']['source_type_card_present'] /** @description The client secret of the source. Used for client-side retrieval using a publishable key. */ - readonly client_secret: string; - readonly code_verification?: components["schemas"]["source_code_verification_flow"]; + readonly client_secret: string + readonly code_verification?: components['schemas']['source_code_verification_flow'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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. */ - readonly currency?: string | null; + readonly currency?: string | null /** @description 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. */ - readonly customer?: string; - readonly eps?: components["schemas"]["source_type_eps"]; + readonly customer?: string + readonly eps?: components['schemas']['source_type_eps'] /** @description The authentication `flow` of the source. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`. */ - readonly flow: string; - readonly giropay?: components["schemas"]["source_type_giropay"]; + readonly flow: string + readonly giropay?: components['schemas']['source_type_giropay'] /** @description Unique identifier for the object. */ - readonly id: string; - readonly ideal?: components["schemas"]["source_type_ideal"]; - readonly klarna?: components["schemas"]["source_type_klarna"]; + readonly id: string + readonly ideal?: components['schemas']['source_type_ideal'] + readonly klarna?: components['schemas']['source_type_klarna'] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata?: { readonly [key: string]: string } | null; - readonly multibanco?: components["schemas"]["source_type_multibanco"]; + readonly metadata?: { readonly [key: string]: string } | null + readonly multibanco?: components['schemas']['source_type_multibanco'] /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "source"; + readonly object: 'source' /** @description Information about the owner of the payment instrument that may be used or required by particular source types. */ - readonly owner?: Partial | null; - readonly p24?: components["schemas"]["source_type_p24"]; - readonly receiver?: components["schemas"]["source_receiver_flow"]; - readonly redirect?: components["schemas"]["source_redirect_flow"]; - readonly sepa_debit?: components["schemas"]["source_type_sepa_debit"]; - readonly sofort?: components["schemas"]["source_type_sofort"]; - readonly source_order?: components["schemas"]["source_order"]; + readonly owner?: Partial | null + readonly p24?: components['schemas']['source_type_p24'] + readonly receiver?: components['schemas']['source_receiver_flow'] + readonly redirect?: components['schemas']['source_redirect_flow'] + readonly sepa_debit?: components['schemas']['source_type_sepa_debit'] + readonly sofort?: components['schemas']['source_type_sofort'] + readonly source_order?: components['schemas']['source_order'] /** @description Extra information about a source. This will appear on your customer's statement every time you charge the source. */ - readonly statement_descriptor?: string | null; + readonly statement_descriptor?: string | null /** @description The status of the source, one of `canceled`, `chargeable`, `consumed`, `failed`, or `pending`. Only `chargeable` sources can be used to create a charge. */ - readonly status: string; - readonly three_d_secure?: components["schemas"]["source_type_three_d_secure"]; + readonly status: string + readonly three_d_secure?: components['schemas']['source_type_three_d_secure'] /** * @description 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. * @enum {string} */ readonly type: - | "ach_credit_transfer" - | "ach_debit" - | "acss_debit" - | "alipay" - | "au_becs_debit" - | "bancontact" - | "card" - | "card_present" - | "eps" - | "giropay" - | "ideal" - | "klarna" - | "multibanco" - | "p24" - | "sepa_debit" - | "sofort" - | "three_d_secure" - | "wechat"; + | 'ach_credit_transfer' + | 'ach_debit' + | 'acss_debit' + | 'alipay' + | 'au_becs_debit' + | 'bancontact' + | 'card' + | 'card_present' + | 'eps' + | 'giropay' + | 'ideal' + | 'klarna' + | 'multibanco' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'three_d_secure' + | 'wechat' /** @description 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. */ - readonly usage?: string | null; - readonly wechat?: components["schemas"]["source_type_wechat"]; - }; + readonly usage?: string | null + readonly wechat?: components['schemas']['source_type_wechat'] + } /** SourceCodeVerificationFlow */ readonly source_code_verification_flow: { /** @description The number of attempts remaining to authenticate the source object with a verification code. */ - readonly attempts_remaining: number; + readonly attempts_remaining: number /** @description 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). */ - readonly status: string; - }; + readonly status: string + } /** * SourceMandateNotification * @description Source mandate notifications should be created when a notification related to @@ -13062,124 +12893,124 @@ export interface components { * deliver an email to the customer. */ readonly source_mandate_notification: { - readonly acss_debit?: components["schemas"]["source_mandate_notification_acss_debit_data"]; + readonly acss_debit?: components['schemas']['source_mandate_notification_acss_debit_data'] /** @description 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`. */ - readonly amount?: number | null; - readonly bacs_debit?: components["schemas"]["source_mandate_notification_bacs_debit_data"]; + readonly amount?: number | null + readonly bacs_debit?: components['schemas']['source_mandate_notification_bacs_debit_data'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "source_mandate_notification"; + readonly object: 'source_mandate_notification' /** @description The reason of the mandate notification. Valid reasons are `mandate_confirmed` or `debit_initiated`. */ - readonly reason: string; - readonly sepa_debit?: components["schemas"]["source_mandate_notification_sepa_debit_data"]; - readonly source: components["schemas"]["source"]; + readonly reason: string + readonly sepa_debit?: components['schemas']['source_mandate_notification_sepa_debit_data'] + readonly source: components['schemas']['source'] /** @description The status of the mandate notification. Valid statuses are `pending` or `submitted`. */ - readonly status: string; + readonly status: string /** @description 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`. */ - readonly type: string; - }; + readonly type: string + } /** SourceMandateNotificationAcssDebitData */ readonly source_mandate_notification_acss_debit_data: { /** @description The statement descriptor associate with the debit. */ - readonly statement_descriptor?: string; - }; + readonly statement_descriptor?: string + } /** SourceMandateNotificationBacsDebitData */ readonly source_mandate_notification_bacs_debit_data: { /** @description Last 4 digits of the account number associated with the debit. */ - readonly last4?: string; - }; + readonly last4?: string + } /** SourceMandateNotificationSepaDebitData */ readonly source_mandate_notification_sepa_debit_data: { /** @description SEPA creditor ID. */ - readonly creditor_identifier?: string; + readonly creditor_identifier?: string /** @description Last 4 digits of the account number associated with the debit. */ - readonly last4?: string; + readonly last4?: string /** @description Mandate reference associated with the debit. */ - readonly mandate_reference?: string; - }; + readonly mandate_reference?: string + } /** SourceOrder */ readonly source_order: { /** @description 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. */ - readonly amount: number; + readonly amount: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description The email address of the customer placing the order. */ - readonly email?: string; + readonly email?: string /** @description List of items constituting the order. */ - readonly items?: readonly components["schemas"]["source_order_item"][] | null; - readonly shipping?: components["schemas"]["shipping"]; - }; + readonly items?: readonly components['schemas']['source_order_item'][] | null + readonly shipping?: components['schemas']['shipping'] + } /** SourceOrderItem */ readonly source_order_item: { /** @description The amount (price) for this order item. */ - readonly amount?: number | null; + readonly amount?: number | null /** @description This currency of this order item. Required when `amount` is present. */ - readonly currency?: string | null; + readonly currency?: string | null /** @description Human-readable description for this order item. */ - readonly description?: string | null; + readonly description?: string | null /** @description The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a SKU). */ - readonly parent?: string | null; + readonly parent?: string | null /** @description The quantity of this order item. When type is `sku`, this is the number of instances of the SKU to be ordered. */ - readonly quantity?: number; + readonly quantity?: number /** @description The type of this order item. Must be `sku`, `tax`, or `shipping`. */ - readonly type?: string | null; - }; + readonly type?: string | null + } /** SourceOwner */ readonly source_owner: { /** @description Owner's address. */ - readonly address?: Partial | null; + readonly address?: Partial | null /** @description Owner's email address. */ - readonly email?: string | null; + readonly email?: string | null /** @description Owner's full name. */ - readonly name?: string | null; + readonly name?: string | null /** @description Owner's phone number (including extension). */ - readonly phone?: string | null; + readonly phone?: string | null /** @description 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. */ - readonly verified_address?: Partial | null; + readonly verified_address?: Partial | null /** @description 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. */ - readonly verified_email?: string | null; + readonly verified_email?: string | null /** @description 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. */ - readonly verified_name?: string | null; + readonly verified_name?: string | null /** @description 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. */ - readonly verified_phone?: string | null; - }; + readonly verified_phone?: string | null + } /** SourceReceiverFlow */ readonly source_receiver_flow: { /** @description The address of the receiver source. This is the value that should be communicated to the customer to send their funds to. */ - readonly address?: string | null; + readonly address?: string | null /** @description 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. */ - readonly amount_charged: number; + readonly amount_charged: number /** @description 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. */ - readonly amount_received: number; + readonly amount_received: number /** @description The total amount that was returned to the customer. The amount returned is expressed in the source's currency. */ - readonly amount_returned: number; + readonly amount_returned: number /** @description Type of refund attribute method, one of `email`, `manual`, or `none`. */ - readonly refund_attributes_method: string; + readonly refund_attributes_method: string /** @description Type of refund attribute status, one of `missing`, `requested`, or `available`. */ - readonly refund_attributes_status: string; - }; + readonly refund_attributes_status: string + } /** SourceRedirectFlow */ readonly source_redirect_flow: { /** @description 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`. */ - readonly failure_reason?: string | null; + readonly failure_reason?: string | null /** @description The URL you provide to redirect the customer to after they authenticated their payment. */ - readonly return_url: string; + readonly return_url: string /** @description 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). */ - readonly status: string; + readonly status: string /** @description The URL provided to you to redirect a customer to as part of a `redirect` authentication flow. */ - readonly url: string; - }; + readonly url: string + } /** * SourceTransaction * @description Some payment methods have no required amount that a customer must send. @@ -13188,325 +13019,325 @@ export interface components { * transactions. */ readonly source_transaction: { - readonly ach_credit_transfer?: components["schemas"]["source_transaction_ach_credit_transfer_data"]; + readonly ach_credit_transfer?: components['schemas']['source_transaction_ach_credit_transfer_data'] /** @description 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. */ - readonly amount: number; - readonly chf_credit_transfer?: components["schemas"]["source_transaction_chf_credit_transfer_data"]; + readonly amount: number + readonly chf_credit_transfer?: components['schemas']['source_transaction_chf_credit_transfer_data'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; - readonly gbp_credit_transfer?: components["schemas"]["source_transaction_gbp_credit_transfer_data"]; + readonly currency: string + readonly gbp_credit_transfer?: components['schemas']['source_transaction_gbp_credit_transfer_data'] /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "source_transaction"; - readonly paper_check?: components["schemas"]["source_transaction_paper_check_data"]; - readonly sepa_credit_transfer?: components["schemas"]["source_transaction_sepa_credit_transfer_data"]; + readonly object: 'source_transaction' + readonly paper_check?: components['schemas']['source_transaction_paper_check_data'] + readonly sepa_credit_transfer?: components['schemas']['source_transaction_sepa_credit_transfer_data'] /** @description The ID of the source this transaction is attached to. */ - readonly source: string; + readonly source: string /** @description The status of the transaction, one of `succeeded`, `pending`, or `failed`. */ - readonly status: string; + readonly status: string /** * @description The type of source this transaction is attached to. * @enum {string} */ readonly type: - | "ach_credit_transfer" - | "ach_debit" - | "alipay" - | "bancontact" - | "card" - | "card_present" - | "eps" - | "giropay" - | "ideal" - | "klarna" - | "multibanco" - | "p24" - | "sepa_debit" - | "sofort" - | "three_d_secure" - | "wechat"; - }; + | 'ach_credit_transfer' + | 'ach_debit' + | 'alipay' + | 'bancontact' + | 'card' + | 'card_present' + | 'eps' + | 'giropay' + | 'ideal' + | 'klarna' + | 'multibanco' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'three_d_secure' + | 'wechat' + } /** SourceTransactionAchCreditTransferData */ readonly source_transaction_ach_credit_transfer_data: { /** @description Customer data associated with the transfer. */ - readonly customer_data?: string; + readonly customer_data?: string /** @description Bank account fingerprint associated with the transfer. */ - readonly fingerprint?: string; + readonly fingerprint?: string /** @description Last 4 digits of the account number associated with the transfer. */ - readonly last4?: string; + readonly last4?: string /** @description Routing number associated with the transfer. */ - readonly routing_number?: string; - }; + readonly routing_number?: string + } /** SourceTransactionChfCreditTransferData */ readonly source_transaction_chf_credit_transfer_data: { /** @description Reference associated with the transfer. */ - readonly reference?: string; + readonly reference?: string /** @description Sender's country address. */ - readonly sender_address_country?: string; + readonly sender_address_country?: string /** @description Sender's line 1 address. */ - readonly sender_address_line1?: string; + readonly sender_address_line1?: string /** @description Sender's bank account IBAN. */ - readonly sender_iban?: string; + readonly sender_iban?: string /** @description Sender's name. */ - readonly sender_name?: string; - }; + readonly sender_name?: string + } /** SourceTransactionGbpCreditTransferData */ readonly source_transaction_gbp_credit_transfer_data: { /** @description Bank account fingerprint associated with the Stripe owned bank account receiving the transfer. */ - readonly fingerprint?: string; + readonly fingerprint?: string /** @description 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. */ - readonly funding_method?: string; + readonly funding_method?: string /** @description Last 4 digits of sender account number associated with the transfer. */ - readonly last4?: string; + readonly last4?: string /** @description Sender entered arbitrary information about the transfer. */ - readonly reference?: string; + readonly reference?: string /** @description Sender account number associated with the transfer. */ - readonly sender_account_number?: string; + readonly sender_account_number?: string /** @description Sender name associated with the transfer. */ - readonly sender_name?: string; + readonly sender_name?: string /** @description Sender sort code associated with the transfer. */ - readonly sender_sort_code?: string; - }; + readonly sender_sort_code?: string + } /** SourceTransactionPaperCheckData */ readonly source_transaction_paper_check_data: { /** @description Time at which the deposited funds will be available for use. Measured in seconds since the Unix epoch. */ - readonly available_at?: string; + readonly available_at?: string /** @description Comma-separated list of invoice IDs associated with the paper check. */ - readonly invoices?: string; - }; + readonly invoices?: string + } /** SourceTransactionSepaCreditTransferData */ readonly source_transaction_sepa_credit_transfer_data: { /** @description Reference associated with the transfer. */ - readonly reference?: string; + readonly reference?: string /** @description Sender's bank account IBAN. */ - readonly sender_iban?: string; + readonly sender_iban?: string /** @description Sender's name. */ - readonly sender_name?: string; - }; + readonly sender_name?: string + } readonly source_type_ach_credit_transfer: { - readonly account_number?: string | null; - readonly bank_name?: string | null; - readonly fingerprint?: string | null; - readonly refund_account_holder_name?: string | null; - readonly refund_account_holder_type?: string | null; - readonly refund_routing_number?: string | null; - readonly routing_number?: string | null; - readonly swift_code?: string | null; - }; + readonly account_number?: string | null + readonly bank_name?: string | null + readonly fingerprint?: string | null + readonly refund_account_holder_name?: string | null + readonly refund_account_holder_type?: string | null + readonly refund_routing_number?: string | null + readonly routing_number?: string | null + readonly swift_code?: string | null + } readonly source_type_ach_debit: { - readonly bank_name?: string | null; - readonly country?: string | null; - readonly fingerprint?: string | null; - readonly last4?: string | null; - readonly routing_number?: string | null; - readonly type?: string | null; - }; + readonly bank_name?: string | null + readonly country?: string | null + readonly fingerprint?: string | null + readonly last4?: string | null + readonly routing_number?: string | null + readonly type?: string | null + } readonly source_type_acss_debit: { - readonly bank_address_city?: string | null; - readonly bank_address_line_1?: string | null; - readonly bank_address_line_2?: string | null; - readonly bank_address_postal_code?: string | null; - readonly bank_name?: string | null; - readonly category?: string | null; - readonly country?: string | null; - readonly fingerprint?: string | null; - readonly last4?: string | null; - readonly routing_number?: string | null; - }; + readonly bank_address_city?: string | null + readonly bank_address_line_1?: string | null + readonly bank_address_line_2?: string | null + readonly bank_address_postal_code?: string | null + readonly bank_name?: string | null + readonly category?: string | null + readonly country?: string | null + readonly fingerprint?: string | null + readonly last4?: string | null + readonly routing_number?: string | null + } readonly source_type_alipay: { - readonly data_string?: string | null; - readonly native_url?: string | null; - readonly statement_descriptor?: string | null; - }; + readonly data_string?: string | null + readonly native_url?: string | null + readonly statement_descriptor?: string | null + } readonly source_type_au_becs_debit: { - readonly bsb_number?: string | null; - readonly fingerprint?: string | null; - readonly last4?: string | null; - }; + readonly bsb_number?: string | null + readonly fingerprint?: string | null + readonly last4?: string | null + } readonly source_type_bancontact: { - readonly bank_code?: string | null; - readonly bank_name?: string | null; - readonly bic?: string | null; - readonly iban_last4?: string | null; - readonly preferred_language?: string | null; - readonly statement_descriptor?: string | null; - }; + readonly bank_code?: string | null + readonly bank_name?: string | null + readonly bic?: string | null + readonly iban_last4?: string | null + readonly preferred_language?: string | null + readonly statement_descriptor?: string | null + } readonly source_type_card: { - readonly address_line1_check?: string | null; - readonly address_zip_check?: string | null; - readonly brand?: string | null; - readonly country?: string | null; - readonly cvc_check?: string | null; - readonly dynamic_last4?: string | null; - readonly exp_month?: number | null; - readonly exp_year?: number | null; - readonly fingerprint?: string; - readonly funding?: string | null; - readonly last4?: string | null; - readonly name?: string | null; - readonly three_d_secure?: string; - readonly tokenization_method?: string | null; - }; + readonly address_line1_check?: string | null + readonly address_zip_check?: string | null + readonly brand?: string | null + readonly country?: string | null + readonly cvc_check?: string | null + readonly dynamic_last4?: string | null + readonly exp_month?: number | null + readonly exp_year?: number | null + readonly fingerprint?: string + readonly funding?: string | null + readonly last4?: string | null + readonly name?: string | null + readonly three_d_secure?: string + readonly tokenization_method?: string | null + } readonly source_type_card_present: { - readonly application_cryptogram?: string; - readonly application_preferred_name?: string; - readonly authorization_code?: string | null; - readonly authorization_response_code?: string; - readonly brand?: string | null; - readonly country?: string | null; - readonly cvm_type?: string; - readonly data_type?: string | null; - readonly dedicated_file_name?: string; - readonly emv_auth_data?: string; - readonly evidence_customer_signature?: string | null; - readonly evidence_transaction_certificate?: string | null; - readonly exp_month?: number | null; - readonly exp_year?: number | null; - readonly fingerprint?: string; - readonly funding?: string | null; - readonly last4?: string | null; - readonly pos_device_id?: string | null; - readonly pos_entry_mode?: string; - readonly read_method?: string | null; - readonly reader?: string | null; - readonly terminal_verification_results?: string; - readonly transaction_status_information?: string; - }; + readonly application_cryptogram?: string + readonly application_preferred_name?: string + readonly authorization_code?: string | null + readonly authorization_response_code?: string + readonly brand?: string | null + readonly country?: string | null + readonly cvm_type?: string + readonly data_type?: string | null + readonly dedicated_file_name?: string + readonly emv_auth_data?: string + readonly evidence_customer_signature?: string | null + readonly evidence_transaction_certificate?: string | null + readonly exp_month?: number | null + readonly exp_year?: number | null + readonly fingerprint?: string + readonly funding?: string | null + readonly last4?: string | null + readonly pos_device_id?: string | null + readonly pos_entry_mode?: string + readonly read_method?: string | null + readonly reader?: string | null + readonly terminal_verification_results?: string + readonly transaction_status_information?: string + } readonly source_type_eps: { - readonly reference?: string | null; - readonly statement_descriptor?: string | null; - }; + readonly reference?: string | null + readonly statement_descriptor?: string | null + } readonly source_type_giropay: { - readonly bank_code?: string | null; - readonly bank_name?: string | null; - readonly bic?: string | null; - readonly statement_descriptor?: string | null; - }; + readonly bank_code?: string | null + readonly bank_name?: string | null + readonly bic?: string | null + readonly statement_descriptor?: string | null + } readonly source_type_ideal: { - readonly bank?: string | null; - readonly bic?: string | null; - readonly iban_last4?: string | null; - readonly statement_descriptor?: string | null; - }; + readonly bank?: string | null + readonly bic?: string | null + readonly iban_last4?: string | null + readonly statement_descriptor?: string | null + } readonly source_type_klarna: { - readonly background_image_url?: string; - readonly client_token?: string | null; - readonly first_name?: string; - readonly last_name?: string; - readonly locale?: string; - readonly logo_url?: string; - readonly page_title?: string; - readonly pay_later_asset_urls_descriptive?: string; - readonly pay_later_asset_urls_standard?: string; - readonly pay_later_name?: string; - readonly pay_later_redirect_url?: string; - readonly pay_now_asset_urls_descriptive?: string; - readonly pay_now_asset_urls_standard?: string; - readonly pay_now_name?: string; - readonly pay_now_redirect_url?: string; - readonly pay_over_time_asset_urls_descriptive?: string; - readonly pay_over_time_asset_urls_standard?: string; - readonly pay_over_time_name?: string; - readonly pay_over_time_redirect_url?: string; - readonly payment_method_categories?: string; - readonly purchase_country?: string; - readonly purchase_type?: string; - readonly redirect_url?: string; - readonly shipping_delay?: number; - readonly shipping_first_name?: string; - readonly shipping_last_name?: string; - }; + readonly background_image_url?: string + readonly client_token?: string | null + readonly first_name?: string + readonly last_name?: string + readonly locale?: string + readonly logo_url?: string + readonly page_title?: string + readonly pay_later_asset_urls_descriptive?: string + readonly pay_later_asset_urls_standard?: string + readonly pay_later_name?: string + readonly pay_later_redirect_url?: string + readonly pay_now_asset_urls_descriptive?: string + readonly pay_now_asset_urls_standard?: string + readonly pay_now_name?: string + readonly pay_now_redirect_url?: string + readonly pay_over_time_asset_urls_descriptive?: string + readonly pay_over_time_asset_urls_standard?: string + readonly pay_over_time_name?: string + readonly pay_over_time_redirect_url?: string + readonly payment_method_categories?: string + readonly purchase_country?: string + readonly purchase_type?: string + readonly redirect_url?: string + readonly shipping_delay?: number + readonly shipping_first_name?: string + readonly shipping_last_name?: string + } readonly source_type_multibanco: { - readonly entity?: string | null; - readonly reference?: string | null; - readonly refund_account_holder_address_city?: string | null; - readonly refund_account_holder_address_country?: string | null; - readonly refund_account_holder_address_line1?: string | null; - readonly refund_account_holder_address_line2?: string | null; - readonly refund_account_holder_address_postal_code?: string | null; - readonly refund_account_holder_address_state?: string | null; - readonly refund_account_holder_name?: string | null; - readonly refund_iban?: string | null; - }; + readonly entity?: string | null + readonly reference?: string | null + readonly refund_account_holder_address_city?: string | null + readonly refund_account_holder_address_country?: string | null + readonly refund_account_holder_address_line1?: string | null + readonly refund_account_holder_address_line2?: string | null + readonly refund_account_holder_address_postal_code?: string | null + readonly refund_account_holder_address_state?: string | null + readonly refund_account_holder_name?: string | null + readonly refund_iban?: string | null + } readonly source_type_p24: { - readonly reference?: string | null; - }; + readonly reference?: string | null + } readonly source_type_sepa_debit: { - readonly bank_code?: string | null; - readonly branch_code?: string | null; - readonly country?: string | null; - readonly fingerprint?: string | null; - readonly last4?: string | null; - readonly mandate_reference?: string | null; - readonly mandate_url?: string | null; - }; + readonly bank_code?: string | null + readonly branch_code?: string | null + readonly country?: string | null + readonly fingerprint?: string | null + readonly last4?: string | null + readonly mandate_reference?: string | null + readonly mandate_url?: string | null + } readonly source_type_sofort: { - readonly bank_code?: string | null; - readonly bank_name?: string | null; - readonly bic?: string | null; - readonly country?: string | null; - readonly iban_last4?: string | null; - readonly preferred_language?: string | null; - readonly statement_descriptor?: string | null; - }; + readonly bank_code?: string | null + readonly bank_name?: string | null + readonly bic?: string | null + readonly country?: string | null + readonly iban_last4?: string | null + readonly preferred_language?: string | null + readonly statement_descriptor?: string | null + } readonly source_type_three_d_secure: { - readonly address_line1_check?: string | null; - readonly address_zip_check?: string | null; - readonly authenticated?: boolean | null; - readonly brand?: string | null; - readonly card?: string | null; - readonly country?: string | null; - readonly customer?: string | null; - readonly cvc_check?: string | null; - readonly dynamic_last4?: string | null; - readonly exp_month?: number | null; - readonly exp_year?: number | null; - readonly fingerprint?: string; - readonly funding?: string | null; - readonly last4?: string | null; - readonly name?: string | null; - readonly three_d_secure?: string; - readonly tokenization_method?: string | null; - }; + readonly address_line1_check?: string | null + readonly address_zip_check?: string | null + readonly authenticated?: boolean | null + readonly brand?: string | null + readonly card?: string | null + readonly country?: string | null + readonly customer?: string | null + readonly cvc_check?: string | null + readonly dynamic_last4?: string | null + readonly exp_month?: number | null + readonly exp_year?: number | null + readonly fingerprint?: string + readonly funding?: string | null + readonly last4?: string | null + readonly name?: string | null + readonly three_d_secure?: string + readonly tokenization_method?: string | null + } readonly source_type_wechat: { - readonly prepay_id?: string; - readonly qr_code_url?: string | null; - readonly statement_descriptor?: string; - }; + readonly prepay_id?: string + readonly qr_code_url?: string | null + readonly statement_descriptor?: string + } /** StatusTransitions */ readonly status_transitions: { /** * Format: unix-time * @description The time that the order was canceled. */ - readonly canceled?: number | null; + readonly canceled?: number | null /** * Format: unix-time * @description The time that the order was fulfilled. */ - readonly fulfiled?: number | null; + readonly fulfiled?: number | null /** * Format: unix-time * @description The time that the order was paid. */ - readonly paid?: number | null; + readonly paid?: number | null /** * Format: unix-time * @description The time that the order was returned. */ - readonly returned?: number | null; - }; + readonly returned?: number | null + } /** * Subscription * @description Subscriptions allow you to charge a customer on a recurring basis. @@ -13515,127 +13346,123 @@ export interface components { */ readonly subscription: { /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. */ - readonly application_fee_percent?: number | null; - readonly automatic_tax: components["schemas"]["subscription_automatic_tax"]; + readonly application_fee_percent?: number | null + readonly automatic_tax: components['schemas']['subscription_automatic_tax'] /** * Format: unix-time * @description Determines the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. */ - readonly billing_cycle_anchor: number; + readonly billing_cycle_anchor: number /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period */ - readonly billing_thresholds?: Partial | null; + readonly billing_thresholds?: Partial | null /** * Format: unix-time * @description A date in the future at which the subscription will automatically get canceled */ - readonly cancel_at?: number | null; + readonly cancel_at?: number | null /** @description If the subscription has been canceled with the `at_period_end` flag set to `true`, `cancel_at_period_end` on the subscription will be true. You can use this attribute to determine whether a subscription that has a status of active is scheduled to be canceled at the end of the current period. */ - readonly cancel_at_period_end: boolean; + readonly cancel_at_period_end: boolean /** * Format: unix-time * @description 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. */ - readonly canceled_at?: number | null; + readonly canceled_at?: number | null /** * @description 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. * @enum {string} */ - readonly collection_method: "charge_automatically" | "send_invoice"; + readonly collection_method: 'charge_automatically' | 'send_invoice' /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** * Format: unix-time * @description End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created. */ - readonly current_period_end: number; + readonly current_period_end: number /** * Format: unix-time * @description Start of the current period that the subscription has been invoiced for. */ - readonly current_period_start: number; + readonly current_period_start: number /** @description ID of the customer who owns the subscription. */ - readonly customer: Partial & - Partial & - Partial; + readonly customer: Partial & Partial & Partial /** @description 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`. */ - readonly days_until_due?: number | null; + readonly days_until_due?: number | null /** @description 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). */ - readonly default_payment_method?: (Partial & Partial) | null; + readonly default_payment_method?: (Partial & Partial) | null /** @description 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). */ readonly default_source?: | (Partial & - Partial & - Partial & - Partial & - Partial & - Partial) - | null; + Partial & + Partial & + Partial & + Partial & + Partial) + | null /** @description 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. */ - readonly default_tax_rates?: readonly components["schemas"]["tax_rate"][] | null; + readonly default_tax_rates?: readonly components['schemas']['tax_rate'][] | null /** @description 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. */ - readonly discount?: Partial | null; + readonly discount?: Partial | null /** * Format: unix-time * @description If the subscription has ended, the date the subscription ended. */ - readonly ended_at?: number | null; + readonly ended_at?: number | null /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * SubscriptionItemList * @description List of subscription items, each with an attached price. */ readonly items: { /** @description Details about each object. */ - readonly data: readonly components["schemas"]["subscription_item"][]; + readonly data: readonly components['schemas']['subscription_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; + readonly url: string + } /** @description The most recent invoice this subscription has generated. */ - readonly latest_invoice?: (Partial & Partial) | null; + readonly latest_invoice?: (Partial & Partial) | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata: { readonly [key: string]: string }; + readonly metadata: { readonly [key: string]: string } /** * Format: unix-time * @description Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at `pending_invoice_item_interval`. */ - readonly next_pending_invoice_item_invoice?: number | null; + readonly next_pending_invoice_item_invoice?: number | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "subscription"; + readonly object: 'subscription' /** @description If specified, payment collection for this subscription will be paused. */ - readonly pause_collection?: Partial | null; + readonly pause_collection?: Partial | null /** @description Payment settings passed on to invoices created by the subscription. */ - readonly payment_settings?: Partial | null; + readonly payment_settings?: Partial | null /** @description 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. */ - readonly pending_invoice_item_interval?: Partial< - components["schemas"]["subscription_pending_invoice_item_interval"] - > | null; + readonly pending_invoice_item_interval?: Partial | null /** @description 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). */ - readonly pending_setup_intent?: (Partial & Partial) | null; + readonly pending_setup_intent?: (Partial & Partial) | null /** @description 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. */ - readonly pending_update?: Partial | null; + readonly pending_update?: Partial | null /** @description The schedule attached to the subscription */ - readonly schedule?: (Partial & Partial) | null; + readonly schedule?: (Partial & Partial) | null /** * Format: unix-time * @description Date when the subscription was first created. The date might differ from the `created` date due to backdating. */ - readonly start_date: number; + readonly start_date: number /** * @description Possible values are `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `canceled`, or `unpaid`. * @@ -13648,32 +13475,32 @@ export interface components { * If 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. * @enum {string} */ - readonly status: "active" | "canceled" | "incomplete" | "incomplete_expired" | "past_due" | "trialing" | "unpaid"; + readonly status: 'active' | 'canceled' | 'incomplete' | 'incomplete_expired' | 'past_due' | 'trialing' | 'unpaid' /** @description 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. */ - readonly transfer_data?: Partial | null; + readonly transfer_data?: Partial | null /** * Format: unix-time * @description If the subscription has a trial, the end of that trial. */ - readonly trial_end?: number | null; + readonly trial_end?: number | null /** * Format: unix-time * @description If the subscription has a trial, the beginning of that trial. */ - readonly trial_start?: number | null; - }; + readonly trial_start?: number | null + } /** SubscriptionAutomaticTax */ readonly subscription_automatic_tax: { /** @description Whether Stripe automatically computes tax on this subscription. */ - readonly enabled: boolean; - }; + readonly enabled: boolean + } /** SubscriptionBillingThresholds */ readonly subscription_billing_thresholds: { /** @description Monetary threshold that triggers the subscription to create an invoice */ - readonly amount_gte?: number | null; + readonly amount_gte?: number | null /** @description 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`. */ - readonly reset_billing_cycle_anchor?: boolean | null; - }; + readonly reset_billing_cycle_anchor?: boolean | null + } /** * SubscriptionItem * @description Subscription items allow you to create customer subscriptions with more than @@ -13681,50 +13508,50 @@ export interface components { */ readonly subscription_item: { /** @description Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period */ - readonly billing_thresholds?: Partial | null; + readonly billing_thresholds?: Partial | null /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description 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. */ - readonly metadata: { readonly [key: string]: string }; + readonly metadata: { readonly [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "subscription_item"; - readonly price: components["schemas"]["price"]; + readonly object: 'subscription_item' + readonly price: components['schemas']['price'] /** @description The [quantity](https://stripe.com/docs/subscriptions/quantities) of the plan to which the customer should be subscribed. */ - readonly quantity?: number; + readonly quantity?: number /** @description The `subscription` this `subscription_item` belongs to. */ - readonly subscription: string; + readonly subscription: string /** @description 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`. */ - readonly tax_rates?: readonly components["schemas"]["tax_rate"][] | null; - }; + readonly tax_rates?: readonly components['schemas']['tax_rate'][] | null + } /** SubscriptionItemBillingThresholds */ readonly subscription_item_billing_thresholds: { /** @description Usage threshold that triggers the subscription to create an invoice */ - readonly usage_gte?: number | null; - }; + readonly usage_gte?: number | null + } /** subscription_payment_method_options_card */ readonly subscription_payment_method_options_card: { - readonly mandate_options?: components["schemas"]["invoice_mandate_options_card"]; + readonly mandate_options?: components['schemas']['invoice_mandate_options_card'] /** * @description 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#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. * @enum {string|null} */ - readonly request_three_d_secure?: ("any" | "automatic") | null; - }; + readonly request_three_d_secure?: ('any' | 'automatic') | null + } /** SubscriptionPendingInvoiceItemInterval */ readonly subscription_pending_invoice_item_interval: { /** * @description Specifies invoicing frequency. Either `day`, `week`, `month` or `year`. * @enum {string} */ - readonly interval: "day" | "month" | "week" | "year"; + readonly interval: 'day' | 'month' | 'week' | 'year' /** @description 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). */ - readonly interval_count: number; - }; + readonly interval_count: number + } /** * SubscriptionSchedule * @description A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes. @@ -13736,199 +13563,185 @@ export interface components { * Format: unix-time * @description Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch. */ - readonly canceled_at?: number | null; + readonly canceled_at?: number | null /** * Format: unix-time * @description Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch. */ - readonly completed_at?: number | null; + readonly completed_at?: number | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description Object representing the start and end dates for the current phase of the subscription schedule, if it is `active`. */ - readonly current_phase?: Partial | null; + readonly current_phase?: Partial | null /** @description ID of the customer who owns the subscription schedule. */ - readonly customer: Partial & - Partial & - Partial; - readonly default_settings: components["schemas"]["subscription_schedules_resource_default_settings"]; + readonly customer: Partial & Partial & Partial + readonly default_settings: components['schemas']['subscription_schedules_resource_default_settings'] /** * @description Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` and `cancel`. * @enum {string} */ - readonly end_behavior: "cancel" | "none" | "release" | "renew"; + readonly end_behavior: 'cancel' | 'none' | 'release' | 'renew' /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata?: { readonly [key: string]: string } | null; + readonly metadata?: { readonly [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "subscription_schedule"; + readonly object: 'subscription_schedule' /** @description Configuration for the subscription schedule's phases. */ - readonly phases: readonly components["schemas"]["subscription_schedule_phase_configuration"][]; + readonly phases: readonly components['schemas']['subscription_schedule_phase_configuration'][] /** * Format: unix-time * @description Time at which the subscription schedule was released. Measured in seconds since the Unix epoch. */ - readonly released_at?: number | null; + readonly released_at?: number | null /** @description ID of the subscription once managed by the subscription schedule (if it is released). */ - readonly released_subscription?: string | null; + readonly released_subscription?: string | null /** * @description 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). * @enum {string} */ - readonly status: "active" | "canceled" | "completed" | "not_started" | "released"; + readonly status: 'active' | 'canceled' | 'completed' | 'not_started' | 'released' /** @description ID of the subscription managed by the subscription schedule. */ - readonly subscription?: (Partial & Partial) | null; - }; + readonly subscription?: (Partial & Partial) | null + } /** * SubscriptionScheduleAddInvoiceItem * @description An Add Invoice Item describes the prices and quantities that will be added as pending invoice items when entering a phase. */ readonly subscription_schedule_add_invoice_item: { /** @description ID of the price used to generate the invoice item. */ - readonly price: Partial & - Partial & - Partial; + readonly price: Partial & Partial & Partial /** @description The quantity of the invoice item. */ - readonly quantity?: number | null; + readonly quantity?: number | null /** @description The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item. */ - readonly tax_rates?: readonly components["schemas"]["tax_rate"][] | null; - }; + readonly tax_rates?: readonly components['schemas']['tax_rate'][] | null + } /** * SubscriptionScheduleConfigurationItem * @description A phase item describes the price and quantity of a phase. */ readonly subscription_schedule_configuration_item: { /** @description Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period */ - readonly billing_thresholds?: Partial | null; + readonly billing_thresholds?: Partial | null /** @description ID of the price to which the customer should be subscribed. */ - readonly price: Partial & - Partial & - Partial; + readonly price: Partial & Partial & Partial /** @description Quantity of the plan to which the customer should be subscribed. */ - readonly quantity?: number; + readonly quantity?: number /** @description 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`. */ - readonly tax_rates?: readonly components["schemas"]["tax_rate"][] | null; - }; + readonly tax_rates?: readonly components['schemas']['tax_rate'][] | null + } /** SubscriptionScheduleCurrentPhase */ readonly subscription_schedule_current_phase: { /** * Format: unix-time * @description The end of this phase of the subscription schedule. */ - readonly end_date: number; + readonly end_date: number /** * Format: unix-time * @description The start of this phase of the subscription schedule. */ - readonly start_date: number; - }; + readonly start_date: number + } /** * SubscriptionSchedulePhaseConfiguration * @description A phase describes the plans, coupon, and trialing status of a subscription for a predefined time period. */ readonly subscription_schedule_phase_configuration: { /** @description A list of prices and quantities that will generate invoice items appended to the first invoice for this phase. */ - readonly add_invoice_items: readonly components["schemas"]["subscription_schedule_add_invoice_item"][]; + readonly add_invoice_items: readonly components['schemas']['subscription_schedule_add_invoice_item'][] /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account during this phase of the schedule. */ - readonly application_fee_percent?: number | null; - readonly automatic_tax?: components["schemas"]["schedules_phase_automatic_tax"]; + readonly application_fee_percent?: number | null + readonly automatic_tax?: components['schemas']['schedules_phase_automatic_tax'] /** * @description 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). * @enum {string|null} */ - readonly billing_cycle_anchor?: ("automatic" | "phase_start") | null; + readonly billing_cycle_anchor?: ('automatic' | 'phase_start') | null /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period */ - readonly billing_thresholds?: Partial | null; + readonly billing_thresholds?: Partial | null /** * @description 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. * @enum {string|null} */ - readonly collection_method?: ("charge_automatically" | "send_invoice") | null; + readonly collection_method?: ('charge_automatically' | 'send_invoice') | null /** @description ID of the coupon to use during this phase of the subscription schedule. */ - readonly coupon?: - | (Partial & - Partial & - Partial) - | null; + readonly coupon?: (Partial & Partial & Partial) | null /** @description 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. */ - readonly default_payment_method?: (Partial & Partial) | null; + readonly default_payment_method?: (Partial & Partial) | null /** @description The default tax rates to apply to the subscription during this phase of the subscription schedule. */ - readonly default_tax_rates?: readonly components["schemas"]["tax_rate"][] | null; + readonly default_tax_rates?: readonly components['schemas']['tax_rate'][] | null /** * Format: unix-time * @description The end of this phase of the subscription schedule. */ - readonly end_date: number; + readonly end_date: number /** @description The invoice settings applicable during this phase. */ - readonly invoice_settings?: Partial< - components["schemas"]["invoice_setting_subscription_schedule_setting"] - > | null; + readonly invoice_settings?: Partial | null /** @description Subscription items to configure the subscription to during this phase of the subscription schedule. */ - readonly items: readonly components["schemas"]["subscription_schedule_configuration_item"][]; + readonly items: readonly components['schemas']['subscription_schedule_configuration_item'][] /** * @description If the subscription schedule will prorate when transitioning to this phase. Possible values are `create_prorations` and `none`. * @enum {string} */ - readonly proration_behavior: "always_invoice" | "create_prorations" | "none"; + readonly proration_behavior: 'always_invoice' | 'create_prorations' | 'none' /** * Format: unix-time * @description The start of this phase of the subscription schedule. */ - readonly start_date: number; + readonly start_date: number /** @description 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. */ - readonly transfer_data?: Partial | null; + readonly transfer_data?: Partial | null /** * Format: unix-time * @description When the trial ends within the phase. */ - readonly trial_end?: number | null; - }; + readonly trial_end?: number | null + } /** SubscriptionSchedulesResourceDefaultSettings */ readonly subscription_schedules_resource_default_settings: { /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account during this phase of the schedule. */ - readonly application_fee_percent?: number | null; - readonly automatic_tax?: components["schemas"]["subscription_schedules_resource_default_settings_automatic_tax"]; + readonly application_fee_percent?: number | null + readonly automatic_tax?: components['schemas']['subscription_schedules_resource_default_settings_automatic_tax'] /** * @description 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). * @enum {string} */ - readonly billing_cycle_anchor: "automatic" | "phase_start"; + readonly billing_cycle_anchor: 'automatic' | 'phase_start' /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period */ - readonly billing_thresholds?: Partial | null; + readonly billing_thresholds?: Partial | null /** * @description 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. * @enum {string|null} */ - readonly collection_method?: ("charge_automatically" | "send_invoice") | null; + readonly collection_method?: ('charge_automatically' | 'send_invoice') | null /** @description 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. */ - readonly default_payment_method?: (Partial & Partial) | null; + readonly default_payment_method?: (Partial & Partial) | null /** @description The subscription schedule's default invoice settings. */ - readonly invoice_settings?: Partial< - components["schemas"]["invoice_setting_subscription_schedule_setting"] - > | null; + readonly invoice_settings?: Partial | null /** @description 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. */ - readonly transfer_data?: Partial | null; - }; + readonly transfer_data?: Partial | null + } /** SubscriptionSchedulesResourceDefaultSettingsAutomaticTax */ readonly subscription_schedules_resource_default_settings_automatic_tax: { /** @description Whether Stripe automatically computes tax on invoices created during this phase. */ - readonly enabled: boolean; - }; + readonly enabled: boolean + } /** SubscriptionTransferData */ readonly subscription_transfer_data: { /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the destination account. By default, the entire amount is transferred to the destination. */ - readonly amount_percent?: number | null; + readonly amount_percent?: number | null /** @description The account where funds from the payment will be transferred to upon payment success. */ - readonly destination: Partial & Partial; - }; + readonly destination: Partial & Partial + } /** * SubscriptionsResourcePauseCollection * @description The Pause Collection settings determine how we will pause collection for this subscription and for how long the subscription @@ -13939,49 +13752,47 @@ export interface components { * @description The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`. * @enum {string} */ - readonly behavior: "keep_as_draft" | "mark_uncollectible" | "void"; + readonly behavior: 'keep_as_draft' | 'mark_uncollectible' | 'void' /** * Format: unix-time * @description The time after which the subscription will resume collecting payments. */ - readonly resumes_at?: number | null; - }; + readonly resumes_at?: number | null + } /** SubscriptionsResourcePaymentMethodOptions */ readonly subscriptions_resource_payment_method_options: { /** @description This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to invoices created by the subscription. */ - readonly acss_debit?: Partial | null; + readonly acss_debit?: Partial | null /** @description This sub-hash contains details about the Bancontact payment method options to pass to invoices created by the subscription. */ - readonly bancontact?: Partial | null; + readonly bancontact?: Partial | null /** @description This sub-hash contains details about the Card payment method options to pass to invoices created by the subscription. */ - readonly card?: Partial | null; - }; + readonly card?: Partial | null + } /** SubscriptionsResourcePaymentSettings */ readonly subscriptions_resource_payment_settings: { /** @description Payment-method-specific configuration to provide to invoices created by the subscription. */ - readonly payment_method_options?: Partial< - components["schemas"]["subscriptions_resource_payment_method_options"] - > | null; + readonly payment_method_options?: Partial | null /** @description 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). */ readonly payment_method_types?: | readonly ( - | "ach_credit_transfer" - | "ach_debit" - | "acss_debit" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "sepa_debit" - | "sofort" - | "wechat_pay" + | 'ach_credit_transfer' + | 'ach_debit' + | 'acss_debit' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' )[] - | null; - }; + | null + } /** * SubscriptionsResourcePendingUpdate * @description Pending Updates store the changes pending from a previous update that will be applied @@ -13992,61 +13803,61 @@ export interface components { * Format: unix-time * @description 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. */ - readonly billing_cycle_anchor?: number | null; + readonly billing_cycle_anchor?: number | null /** * Format: unix-time * @description The point after which the changes reflected by this update will be discarded and no longer applied. */ - readonly expires_at: number; + readonly expires_at: number /** @description List of subscription items, each with an attached plan, that will be set if the update is applied. */ - readonly subscription_items?: readonly components["schemas"]["subscription_item"][] | null; + readonly subscription_items?: readonly components['schemas']['subscription_item'][] | null /** * Format: unix-time * @description 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. */ - readonly trial_end?: number | null; + readonly trial_end?: number | null /** @description 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. */ - readonly trial_from_plan?: boolean | null; - }; + readonly trial_from_plan?: boolean | null + } /** * TaxProductResourceTaxCode * @description [Tax codes](https://stripe.com/docs/tax/tax-codes) classify goods and services for tax purposes. */ readonly tax_code: { /** @description A detailed description of which types of products the tax code represents. */ - readonly description: string; + readonly description: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description A short name for the tax code. */ - readonly name: string; + readonly name: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "tax_code"; - }; + readonly object: 'tax_code' + } /** TaxDeductedAtSource */ readonly tax_deducted_at_source: { /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "tax_deducted_at_source"; + readonly object: 'tax_deducted_at_source' /** * Format: unix-time * @description The end of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period. */ - readonly period_end: number; + readonly period_end: number /** * Format: unix-time * @description The start of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period. */ - readonly period_start: number; + readonly period_start: number /** @description The TAN that was supplied to Stripe when TDS was assessed */ - readonly tax_deduction_account_number: string; - }; + readonly tax_deduction_account_number: string + } /** * tax_id * @description You can add one or multiple tax IDs to a [customer](https://stripe.com/docs/api/customers). @@ -14056,88 +13867,88 @@ export interface components { */ readonly tax_id: { /** @description Two-letter ISO code representing the country of the tax ID. */ - readonly country?: string | null; + readonly country?: string | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description ID of the customer. */ - readonly customer?: (Partial & Partial) | null; + readonly customer?: (Partial & Partial) | null /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "tax_id"; + readonly object: 'tax_id' /** * @description Type of the tax ID, one of `ae_trn`, `au_abn`, `au_arn`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `es_cif`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `th_vat`, `tw_vat`, `ua_vat`, `us_ein`, or `za_vat`. Note that some legacy tax IDs have type `unknown` * @enum {string} */ readonly type: - | "ae_trn" - | "au_abn" - | "au_arn" - | "br_cnpj" - | "br_cpf" - | "ca_bn" - | "ca_gst_hst" - | "ca_pst_bc" - | "ca_pst_mb" - | "ca_pst_sk" - | "ca_qst" - | "ch_vat" - | "cl_tin" - | "es_cif" - | "eu_vat" - | "gb_vat" - | "ge_vat" - | "hk_br" - | "id_npwp" - | "il_vat" - | "in_gst" - | "is_vat" - | "jp_cn" - | "jp_rn" - | "kr_brn" - | "li_uid" - | "mx_rfc" - | "my_frp" - | "my_itn" - | "my_sst" - | "no_vat" - | "nz_gst" - | "ru_inn" - | "ru_kpp" - | "sa_vat" - | "sg_gst" - | "sg_uen" - | "th_vat" - | "tw_vat" - | "ua_vat" - | "unknown" - | "us_ein" - | "za_vat"; + | 'ae_trn' + | 'au_abn' + | 'au_arn' + | 'br_cnpj' + | 'br_cpf' + | 'ca_bn' + | 'ca_gst_hst' + | 'ca_pst_bc' + | 'ca_pst_mb' + | 'ca_pst_sk' + | 'ca_qst' + | 'ch_vat' + | 'cl_tin' + | 'es_cif' + | 'eu_vat' + | 'gb_vat' + | 'ge_vat' + | 'hk_br' + | 'id_npwp' + | 'il_vat' + | 'in_gst' + | 'is_vat' + | 'jp_cn' + | 'jp_rn' + | 'kr_brn' + | 'li_uid' + | 'mx_rfc' + | 'my_frp' + | 'my_itn' + | 'my_sst' + | 'no_vat' + | 'nz_gst' + | 'ru_inn' + | 'ru_kpp' + | 'sa_vat' + | 'sg_gst' + | 'sg_uen' + | 'th_vat' + | 'tw_vat' + | 'ua_vat' + | 'unknown' + | 'us_ein' + | 'za_vat' /** @description Value of the tax ID. */ - readonly value: string; + readonly value: string /** @description Tax ID verification information. */ - readonly verification?: Partial | null; - }; + readonly verification?: Partial | null + } /** tax_id_verification */ readonly tax_id_verification: { /** * @description Verification status, one of `pending`, `verified`, `unverified`, or `unavailable`. * @enum {string} */ - readonly status: "pending" | "unavailable" | "unverified" | "verified"; + readonly status: 'pending' | 'unavailable' | 'unverified' | 'verified' /** @description Verified address. */ - readonly verified_address?: string | null; + readonly verified_address?: string | null /** @description Verified name. */ - readonly verified_name?: string | null; - }; + readonly verified_name?: string | null + } /** * TaxRate * @description Tax rates can be applied to [invoices](https://stripe.com/docs/billing/invoices/tax-rates), [subscriptions](https://stripe.com/docs/billing/subscriptions/taxes) and [Checkout Sessions](https://stripe.com/docs/payments/checkout/set-up-a-subscription#tax-rates) to collect tax. @@ -14146,118 +13957,118 @@ export interface components { */ readonly tax_rate: { /** @description 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. */ - readonly active: boolean; + readonly active: boolean /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ - readonly country?: string | null; + readonly country?: string | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. */ - readonly description?: string | null; + readonly description?: string | null /** @description The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page. */ - readonly display_name: string; + readonly display_name: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description This specifies if the tax rate is inclusive or exclusive. */ - readonly inclusive: boolean; + readonly inclusive: boolean /** @description The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice. */ - readonly jurisdiction?: string | null; + readonly jurisdiction?: string | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata?: { readonly [key: string]: string } | null; + readonly metadata?: { readonly [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "tax_rate"; + readonly object: 'tax_rate' /** @description This represents the tax rate percent out of 100. */ - readonly percentage: number; + readonly percentage: number /** @description [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States. */ - readonly state?: string | null; + readonly state?: string | null /** * @description The high-level tax type, such as `vat` or `sales_tax`. * @enum {string|null} */ - readonly tax_type?: ("gst" | "hst" | "jct" | "pst" | "qst" | "rst" | "sales_tax" | "vat") | null; - }; + readonly tax_type?: ('gst' | 'hst' | 'jct' | 'pst' | 'qst' | 'rst' | 'sales_tax' | 'vat') | null + } /** * TerminalConnectionToken * @description A Connection Token is used by the Stripe Terminal SDK to connect to a reader. * * Related guide: [Fleet Management](https://stripe.com/docs/terminal/fleet/locations). */ - readonly "terminal.connection_token": { + readonly 'terminal.connection_token': { /** @description 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://stripe.com/docs/terminal/fleet/locations#connection-tokens). */ - readonly location?: string; + readonly location?: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "terminal.connection_token"; + readonly object: 'terminal.connection_token' /** @description Your application should pass this token to the Stripe Terminal SDK. */ - readonly secret: string; - }; + readonly secret: string + } /** * TerminalLocationLocation * @description A Location represents a grouping of readers. * * Related guide: [Fleet Management](https://stripe.com/docs/terminal/fleet/locations). */ - readonly "terminal.location": { - readonly address: components["schemas"]["address"]; + readonly 'terminal.location': { + readonly address: components['schemas']['address'] /** @description The display name of the location. */ - readonly display_name: string; + readonly display_name: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata: { readonly [key: string]: string }; + readonly metadata: { readonly [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "terminal.location"; - }; + readonly object: 'terminal.location' + } /** * TerminalReaderReader * @description A Reader represents a physical device for accepting payment details. * * Related guide: [Connecting to a Reader](https://stripe.com/docs/terminal/payments/connect-reader). */ - readonly "terminal.reader": { + readonly 'terminal.reader': { /** @description The current software version of the reader. */ - readonly device_sw_version?: string | null; + readonly device_sw_version?: string | null /** * @description Type of reader, one of `bbpos_chipper2x`, `bbpos_wisepos_e`, or `verifone_P400`. * @enum {string} */ - readonly device_type: "bbpos_chipper2x" | "bbpos_wisepos_e" | "verifone_P400"; + readonly device_type: 'bbpos_chipper2x' | 'bbpos_wisepos_e' | 'verifone_P400' /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description The local IP address of the reader. */ - readonly ip_address?: string | null; + readonly ip_address?: string | null /** @description Custom label given to the reader for easier identification. */ - readonly label: string; + readonly label: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description The location identifier of the reader. */ - readonly location?: (Partial & Partial) | null; + readonly location?: (Partial & Partial) | null /** @description 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. */ - readonly metadata: { readonly [key: string]: string }; + readonly metadata: { readonly [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "terminal.reader"; + readonly object: 'terminal.reader' /** @description Serial number of the reader. */ - readonly serial_number: string; + readonly serial_number: string /** @description The networking status of the reader. */ - readonly status?: string | null; - }; + readonly status?: string | null + } /** * ThreeDSecure * @description Cardholder authentication via 3D Secure is initiated by creating a `3D Secure` @@ -14266,31 +14077,31 @@ export interface components { */ readonly three_d_secure: { /** @description Amount of the charge that you will create when authentication completes. */ - readonly amount: number; + readonly amount: number /** @description True if the cardholder went through the authentication flow and their bank indicated that authentication succeeded. */ - readonly authenticated: boolean; - readonly card: components["schemas"]["card"]; + readonly authenticated: boolean + readonly card: components['schemas']['card'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "three_d_secure"; + readonly object: 'three_d_secure' /** @description If present, this is the URL that you should send the cardholder to for authentication. If you are going to use Stripe.js to display the authentication page in an iframe, you should use the value "_callback". */ - readonly redirect_url?: string | null; + readonly redirect_url?: string | null /** @description Possible values are `redirect_pending`, `succeeded`, or `failed`. When the cardholder can be authenticated, the object starts with status `redirect_pending`. When liability will be shifted to the cardholder's bank (either because the cardholder was successfully authenticated, or because the bank has not implemented 3D Secure, the object wlil be in status `succeeded`. `failed` indicates that authentication was attempted unsuccessfully. */ - readonly status: string; - }; + readonly status: string + } /** three_d_secure_details */ readonly three_d_secure_details: { /** @@ -14298,41 +14109,31 @@ export interface components { * the issuing bank. * @enum {string|null} */ - readonly authentication_flow?: ("challenge" | "frictionless") | null; + readonly authentication_flow?: ('challenge' | 'frictionless') | null /** * @description Indicates the outcome of 3D Secure authentication. * @enum {string|null} */ - readonly result?: - | ("attempt_acknowledged" | "authenticated" | "failed" | "not_supported" | "processing_error") - | null; + readonly result?: ('attempt_acknowledged' | 'authenticated' | 'failed' | 'not_supported' | 'processing_error') | null /** * @description Additional information about why 3D Secure succeeded or failed based * on the `result`. * @enum {string|null} */ readonly result_reason?: - | ( - | "abandoned" - | "bypassed" - | "canceled" - | "card_not_enrolled" - | "network_not_supported" - | "protocol_error" - | "rejected" - ) - | null; + | ('abandoned' | 'bypassed' | 'canceled' | 'card_not_enrolled' | 'network_not_supported' | 'protocol_error' | 'rejected') + | null /** * @description The version of 3D Secure that was used. * @enum {string|null} */ - readonly version?: ("1.0.2" | "2.1.0" | "2.2.0") | null; - }; + readonly version?: ('1.0.2' | '2.1.0' | '2.2.0') | null + } /** three_d_secure_usage */ readonly three_d_secure_usage: { /** @description Whether 3D Secure is supported on this card. */ - readonly supported: boolean; - }; + readonly supported: boolean + } /** * Token * @description Tokenization is the process Stripe uses to collect sensitive card or bank @@ -14359,29 +14160,29 @@ export interface components { * Related guide: [Accept a payment](https://stripe.com/docs/payments/accept-a-payment-charges#web-create-token) */ readonly token: { - readonly bank_account?: components["schemas"]["bank_account"]; - readonly card?: components["schemas"]["card"]; + readonly bank_account?: components['schemas']['bank_account'] + readonly card?: components['schemas']['card'] /** @description IP address of the client that generated the token. */ - readonly client_ip?: string | null; + readonly client_ip?: string | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "token"; + readonly object: 'token' /** @description Type of the token: `account`, `bank_account`, `card`, or `pii`. */ - readonly type: string; + readonly type: string /** @description Whether this token has already been used (tokens can be used only once). */ - readonly used: boolean; - }; + readonly used: boolean + } /** * Topup * @description To top up your Stripe balance, you create a top-up object. You can retrieve @@ -14392,46 +14193,46 @@ export interface components { */ readonly topup: { /** @description Amount transferred. */ - readonly amount: number; + readonly amount: number /** @description 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. */ - readonly balance_transaction?: (Partial & Partial) | null; + readonly balance_transaction?: (Partial & Partial) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string | null; + readonly description?: string | null /** @description 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. */ - readonly expected_availability_date?: number | null; + readonly expected_availability_date?: number | null /** @description 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). */ - readonly failure_code?: string | null; + readonly failure_code?: string | null /** @description Message to user further explaining reason for top-up failure if available. */ - readonly failure_message?: string | null; + readonly failure_message?: string | null /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata: { readonly [key: string]: string }; + readonly metadata: { readonly [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "topup"; - readonly source: components["schemas"]["source"]; + readonly object: 'topup' + readonly source: components['schemas']['source'] /** @description Extra information about a top-up. This will appear on your source's bank statement. It must contain at least one letter. */ - readonly statement_descriptor?: string | null; + readonly statement_descriptor?: string | null /** * @description The status of the top-up is either `canceled`, `failed`, `pending`, `reversed`, or `succeeded`. * @enum {string} */ - readonly status: "canceled" | "failed" | "pending" | "reversed" | "succeeded"; + readonly status: 'canceled' | 'failed' | 'pending' | 'reversed' | 'succeeded' /** @description A string that identifies this top-up as part of a group. */ - readonly transfer_group?: string | null; - }; + readonly transfer_group?: string | null + } /** * Transfer * @description A `Transfer` object is created when you move funds between Stripe accounts as @@ -14447,72 +14248,72 @@ export interface components { */ readonly transfer: { /** @description Amount in %s to be transferred. */ - readonly amount: number; + readonly amount: number /** @description Amount in %s reversed (can be less than the amount attribute on the transfer if a partial reversal was issued). */ - readonly amount_reversed: number; + readonly amount_reversed: number /** @description Balance transaction that describes the impact of this transfer on your account balance. */ - readonly balance_transaction?: (Partial & Partial) | null; + readonly balance_transaction?: (Partial & Partial) | null /** * Format: unix-time * @description Time that this record of the transfer was first created. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string | null; + readonly description?: string | null /** @description ID of the Stripe account the transfer was sent to. */ - readonly destination?: (Partial & Partial) | null; + readonly destination?: (Partial & Partial) | null /** @description If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer. */ - readonly destination_payment?: Partial & Partial; + readonly destination_payment?: Partial & Partial /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata: { readonly [key: string]: string }; + readonly metadata: { readonly [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "transfer"; + readonly object: 'transfer' /** * TransferReversalList * @description A list of reversals that have been applied to the transfer. */ readonly reversals: { /** @description Details about each object. */ - readonly data: readonly components["schemas"]["transfer_reversal"][]; + readonly data: readonly components['schemas']['transfer_reversal'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; + readonly url: string + } /** @description Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false. */ - readonly reversed: boolean; + readonly reversed: boolean /** @description ID of the charge or payment that was used to fund the transfer. If null, the transfer was funded from the available balance. */ - readonly source_transaction?: (Partial & Partial) | null; + readonly source_transaction?: (Partial & Partial) | null /** @description The source balance this transfer came from. One of `card`, `fpx`, or `bank_account`. */ - readonly source_type?: string | null; + readonly source_type?: string | null /** @description A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-options) for details. */ - readonly transfer_group?: string | null; - }; + readonly transfer_group?: string | null + } /** transfer_data */ readonly transfer_data: { /** @description 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). */ - readonly amount?: number; + readonly amount?: number /** * @description The account (if any) the payment will be attributed to for tax * reporting, and where funds from the payment will be transferred to upon * payment success. */ - readonly destination: Partial & Partial; - }; + readonly destination: Partial & Partial + } /** * TransferReversal * @description [Stripe Connect](https://stripe.com/docs/connect) platforms can reverse transfers made to a @@ -14531,63 +14332,63 @@ export interface components { */ readonly transfer_reversal: { /** @description Amount, in %s. */ - readonly amount: number; + readonly amount: number /** @description Balance transaction that describes the impact on your account balance. */ - readonly balance_transaction?: (Partial & Partial) | null; + readonly balance_transaction?: (Partial & Partial) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description Linked payment refund for the transfer reversal. */ - readonly destination_payment_refund?: (Partial & Partial) | null; + readonly destination_payment_refund?: (Partial & Partial) | null /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description 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. */ - readonly metadata?: { readonly [key: string]: string } | null; + readonly metadata?: { readonly [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "transfer_reversal"; + readonly object: 'transfer_reversal' /** @description ID of the refund responsible for the transfer reversal. */ - readonly source_refund?: (Partial & Partial) | null; + readonly source_refund?: (Partial & Partial) | null /** @description ID of the transfer that was reversed. */ - readonly transfer: Partial & Partial; - }; + readonly transfer: Partial & Partial + } /** TransferSchedule */ readonly transfer_schedule: { /** @description The number of days charges for the account will be held before being paid out. */ - readonly delay_days: number; + readonly delay_days: number /** @description How frequently funds will be paid out. One of `manual` (payouts only created via API call), `daily`, `weekly`, or `monthly`. */ - readonly interval: string; + readonly interval: string /** @description 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. */ - readonly monthly_anchor?: number; + readonly monthly_anchor?: number /** @description The day of the week funds will be paid out, of the style 'monday', 'tuesday', etc. Only shown if `interval` is weekly. */ - readonly weekly_anchor?: string; - }; + readonly weekly_anchor?: string + } /** TransformQuantity */ readonly transform_quantity: { /** @description Divide usage by this number. */ - readonly divide_by: number; + readonly divide_by: number /** * @description After division, either round the result `up` or `down`. * @enum {string} */ - readonly round: "down" | "up"; - }; + readonly round: 'down' | 'up' + } /** TransformUsage */ readonly transform_usage: { /** @description Divide usage by this number. */ - readonly divide_by: number; + readonly divide_by: number /** * @description After division, either round the result `up` or `down`. * @enum {string} */ - readonly round: "down" | "up"; - }; + readonly round: 'down' | 'up' + } /** * UsageRecord * @description Usage records allow you to report customer usage and metrics to Stripe for @@ -14597,51 +14398,51 @@ export interface components { */ readonly usage_record: { /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "usage_record"; + readonly object: 'usage_record' /** @description The usage quantity for the specified date. */ - readonly quantity: number; + readonly quantity: number /** @description The ID of the subscription item this usage record contains data for. */ - readonly subscription_item: string; + readonly subscription_item: string /** * Format: unix-time * @description The timestamp when this usage occurred. */ - readonly timestamp: number; - }; + readonly timestamp: number + } /** UsageRecordSummary */ readonly usage_record_summary: { /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description The invoice in which this usage period has been billed for. */ - readonly invoice?: string | null; + readonly invoice?: string | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "usage_record_summary"; - readonly period: components["schemas"]["period"]; + readonly object: 'usage_record_summary' + readonly period: components['schemas']['period'] /** @description The ID of the subscription item this summary is describing. */ - readonly subscription_item: string; + readonly subscription_item: string /** @description The total usage within this usage period. */ - readonly total_usage: number; - }; + readonly total_usage: number + } /** verification_session_redaction */ readonly verification_session_redaction: { /** * @description Indicates whether this object and its related objects have been redacted or not. * @enum {string} */ - readonly status: "processing" | "redacted"; - }; + readonly status: 'processing' | 'redacted' + } /** * NotificationWebhookEndpoint * @description You can configure [webhook endpoints](https://stripe.com/docs/webhooks/) via the API to be @@ -14654,37 +14455,37 @@ export interface components { */ readonly webhook_endpoint: { /** @description The API version events are rendered as for this webhook endpoint. */ - readonly api_version?: string | null; + readonly api_version?: string | null /** @description The ID of the associated Connect application. */ - readonly application?: string | null; + readonly application?: string | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - readonly created: number; + readonly created: number /** @description An optional description of what the webhook is used for. */ - readonly description?: string | null; + readonly description?: string | null /** @description The list of events to enable for this endpoint. `['*']` indicates that all events are enabled, except those that require explicit selection. */ - readonly enabled_events: readonly string[]; + readonly enabled_events: readonly string[] /** @description Unique identifier for the object. */ - readonly id: string; + readonly id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - readonly livemode: boolean; + readonly livemode: boolean /** @description 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. */ - readonly metadata: { readonly [key: string]: string }; + readonly metadata: { readonly [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - readonly object: "webhook_endpoint"; + readonly object: 'webhook_endpoint' /** @description The endpoint's secret, used to generate [webhook signatures](https://stripe.com/docs/webhooks/signatures). Only returned at creation. */ - readonly secret?: string; + readonly secret?: string /** @description The status of the webhook. It can be `enabled` or `disabled`. */ - readonly status: string; + readonly status: string /** @description The URL of the webhook endpoint. */ - readonly url: string; - }; - }; + readonly url: string + } + } } export interface operations { @@ -14694,94 +14495,94 @@ export interface operations { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["three_d_secure"]; - }; - }; + readonly 'application/json': components['schemas']['three_d_secure'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Amount of the charge that you will create when authentication completes. */ - readonly amount: number; + readonly amount: number /** @description The ID of a card token, or the ID of a card belonging to the given customer. */ - readonly card?: string; + readonly card?: string /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description The customer associated with this 3D secure authentication. */ - readonly customer?: string; + readonly customer?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The URL that the cardholder's browser will be returned to when authentication completes. */ - readonly return_url: string; - }; - }; - }; - }; + readonly return_url: string + } + } + } + } /**

Retrieves a 3D Secure object.

*/ readonly Get3dSecureThreeDSecure: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly three_d_secure: string; - }; - }; + readonly three_d_secure: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["three_d_secure"]; - }; - }; + readonly 'application/json': components['schemas']['three_d_secure'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Retrieves the details of an account.

*/ readonly GetAccount: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; + readonly expand?: readonly string[] + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["account"]; - }; - }; + readonly 'application/json': components['schemas']['account'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /** *

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged. Most parameters can be changed only for Custom accounts. (These are marked Custom Only below.) Parameters marked Custom and Express are not supported for Standard accounts.

* @@ -14792,63 +14593,63 @@ export interface operations { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["account"]; - }; - }; + readonly 'application/json': components['schemas']['account'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account. */ - readonly account_token?: string; + readonly account_token?: string /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ readonly bank_account?: Partial<{ - readonly account_holder_name?: string; + readonly account_holder_name?: string /** @enum {string} */ - readonly account_holder_type?: "company" | "individual"; - readonly account_number: string; + readonly account_holder_type?: 'company' | 'individual' + readonly account_number: string /** @enum {string} */ - readonly account_type?: "checking" | "futsu" | "savings" | "toza"; - readonly country: string; - readonly currency?: string; + readonly account_type?: 'checking' | 'futsu' | 'savings' | 'toza' + readonly country: string + readonly currency?: string /** @enum {string} */ - readonly object?: "bank_account"; - readonly routing_number?: string; + readonly object?: 'bank_account' + readonly routing_number?: string }> & - Partial; + Partial /** * business_profile_specs * @description Business information about the account. */ readonly business_profile?: { - readonly mcc?: string; - readonly name?: string; - readonly product_description?: string; + readonly mcc?: string + readonly name?: string + readonly product_description?: string /** address_specs */ readonly support_address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; - readonly support_email?: string; - readonly support_phone?: string; - readonly support_url?: Partial & Partial<"">; - readonly url?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } + readonly support_email?: string + readonly support_phone?: string + readonly support_url?: Partial & Partial<''> + readonly url?: string + } /** * @description The business type. * @enum {string} */ - readonly business_type?: "company" | "government_entity" | "individual" | "non_profit"; + readonly business_type?: 'company' | 'government_entity' | 'individual' | 'non_profit' /** * capabilities_param * @description Each key of the dictionary represents a capability, and each capability maps to its settings (e.g. whether it has been requested or not). Each capability will be inactive until you have provided its specific requirements and Stripe has verified them. An account may have some of its requested capabilities be active and some be inactive. @@ -14856,101 +14657,101 @@ export interface operations { readonly capabilities?: { /** capability_param */ readonly acss_debit_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly afterpay_clearpay_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly au_becs_debit_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly bacs_debit_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly bancontact_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly boleto_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly card_issuing?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly card_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly cartes_bancaires_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly eps_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly fpx_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly giropay_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly grabpay_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly ideal_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly jcb_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly klarna_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly legacy_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly oxxo_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly p24_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly sepa_debit_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly sofort_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly tax_reporting_us_1099_k?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly tax_reporting_us_1099_misc?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly transfers?: { - readonly requested?: boolean; - }; - }; + readonly requested?: boolean + } + } /** * company_specs * @description Information about the company or business. This field is available for any `business_type`. @@ -14958,85 +14759,85 @@ export interface operations { readonly company?: { /** address_specs */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } /** japan_address_kana_specs */ readonly address_kana?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** japan_address_kanji_specs */ readonly address_kanji?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; - readonly directors_provided?: boolean; - readonly executives_provided?: boolean; - readonly name?: string; - readonly name_kana?: string; - readonly name_kanji?: string; - readonly owners_provided?: boolean; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } + readonly directors_provided?: boolean + readonly executives_provided?: boolean + readonly name?: string + readonly name_kana?: string + readonly name_kanji?: string + readonly owners_provided?: boolean /** company_ownership_declaration */ readonly ownership_declaration?: { /** Format: unix-time */ - readonly date?: number; - readonly ip?: string; - readonly user_agent?: string; - }; - readonly phone?: string; - readonly registration_number?: string; + readonly date?: number + readonly ip?: string + readonly user_agent?: string + } + readonly phone?: string + readonly registration_number?: string /** @enum {string} */ readonly structure?: - | "" - | "free_zone_establishment" - | "free_zone_llc" - | "government_instrumentality" - | "governmental_unit" - | "incorporated_non_profit" - | "limited_liability_partnership" - | "llc" - | "multi_member_llc" - | "private_company" - | "private_corporation" - | "private_partnership" - | "public_company" - | "public_corporation" - | "public_partnership" - | "single_member_llc" - | "sole_establishment" - | "sole_proprietorship" - | "tax_exempt_government_instrumentality" - | "unincorporated_association" - | "unincorporated_non_profit"; - readonly tax_id?: string; - readonly tax_id_registrar?: string; - readonly vat_id?: string; + | '' + | 'free_zone_establishment' + | 'free_zone_llc' + | 'government_instrumentality' + | 'governmental_unit' + | 'incorporated_non_profit' + | 'limited_liability_partnership' + | 'llc' + | 'multi_member_llc' + | 'private_company' + | 'private_corporation' + | 'private_partnership' + | 'public_company' + | 'public_corporation' + | 'public_partnership' + | 'single_member_llc' + | 'sole_establishment' + | 'sole_proprietorship' + | 'tax_exempt_government_instrumentality' + | 'unincorporated_association' + | 'unincorporated_non_profit' + readonly tax_id?: string + readonly tax_id_registrar?: string + readonly vat_id?: string /** verification_specs */ readonly verification?: { /** verification_document_specs */ readonly document?: { - readonly back?: string; - readonly front?: string; - }; - }; - }; + readonly back?: string + readonly front?: string + } + } + } /** @description 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). */ - readonly default_currency?: string; + readonly default_currency?: string /** * documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -15044,39 +14845,39 @@ export interface operations { readonly documents?: { /** documents_param */ readonly bank_account_ownership_verification?: { - readonly files?: readonly string[]; - }; + readonly files?: readonly string[] + } /** documents_param */ readonly company_license?: { - readonly files?: readonly string[]; - }; + readonly files?: readonly string[] + } /** documents_param */ readonly company_memorandum_of_association?: { - readonly files?: readonly string[]; - }; + readonly files?: readonly string[] + } /** documents_param */ readonly company_ministerial_decree?: { - readonly files?: readonly string[]; - }; + readonly files?: readonly string[] + } /** documents_param */ readonly company_registration_verification?: { - readonly files?: readonly string[]; - }; + readonly files?: readonly string[] + } /** documents_param */ readonly company_tax_id_verification?: { - readonly files?: readonly string[]; - }; + readonly files?: readonly string[] + } /** documents_param */ readonly proof_of_registration?: { - readonly files?: readonly string[]; - }; - }; + readonly files?: readonly string[] + } + } /** @description The email address of the account holder. This is only to make the account easier to identify to you. Stripe only emails Custom accounts with your consent. */ - readonly email?: string; + readonly email?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description A card or bank account to attach to the account for receiving [payouts](https://stripe.com/docs/connect/bank-debit-card-payouts) (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://stripe.com/docs/api#account_create_bank_account) creation.

By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the bank account or card creation API. */ - readonly external_account?: string; + readonly external_account?: string /** * individual_specs * @description Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. @@ -15084,71 +14885,71 @@ export interface operations { readonly individual?: { /** address_specs */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } /** japan_address_kana_specs */ readonly address_kana?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** japan_address_kanji_specs */ readonly address_kanji?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } readonly dob?: Partial<{ - readonly day: number; - readonly month: number; - readonly year: number; + readonly day: number + readonly month: number + readonly year: number }> & - Partial<"">; - readonly email?: string; - readonly first_name?: string; - readonly first_name_kana?: string; - readonly first_name_kanji?: string; - readonly full_name_aliases?: Partial & Partial<"">; - readonly gender?: string; - readonly id_number?: string; - readonly last_name?: string; - readonly last_name_kana?: string; - readonly last_name_kanji?: string; - readonly maiden_name?: string; - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; - readonly phone?: string; + Partial<''> + readonly email?: string + readonly first_name?: string + readonly first_name_kana?: string + readonly first_name_kanji?: string + readonly full_name_aliases?: Partial & Partial<''> + readonly gender?: string + readonly id_number?: string + readonly last_name?: string + readonly last_name_kana?: string + readonly last_name_kanji?: string + readonly maiden_name?: string + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> + readonly phone?: string /** @enum {string} */ - readonly political_exposure?: "existing" | "none"; - readonly ssn_last_4?: string; + readonly political_exposure?: 'existing' | 'none' + readonly ssn_last_4?: string /** person_verification_specs */ readonly verification?: { /** person_verification_document_specs */ readonly additional_document?: { - readonly back?: string; - readonly front?: string; - }; + readonly back?: string + readonly front?: string + } /** person_verification_document_specs */ readonly document?: { - readonly back?: string; - readonly front?: string; - }; - }; - }; + readonly back?: string + readonly front?: string + } + } + } /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** * settings_specs_update * @description Options for customizing how the account functions within Stripe. @@ -15156,73 +14957,66 @@ export interface operations { readonly settings?: { /** branding_settings_specs */ readonly branding?: { - readonly icon?: string; - readonly logo?: string; - readonly primary_color?: string; - readonly secondary_color?: string; - }; + readonly icon?: string + readonly logo?: string + readonly primary_color?: string + readonly secondary_color?: string + } /** card_issuing_settings_specs */ readonly card_issuing?: { /** settings_terms_of_service_specs */ readonly tos_acceptance?: { /** Format: unix-time */ - readonly date?: number; - readonly ip?: string; - readonly user_agent?: string; - }; - }; + readonly date?: number + readonly ip?: string + readonly user_agent?: string + } + } /** card_payments_settings_specs */ readonly card_payments?: { /** decline_charge_on_specs */ readonly decline_on?: { - readonly avs_failure?: boolean; - readonly cvc_failure?: boolean; - }; - readonly statement_descriptor_prefix?: string; - }; + readonly avs_failure?: boolean + readonly cvc_failure?: boolean + } + readonly statement_descriptor_prefix?: string + } /** payments_settings_specs */ readonly payments?: { - readonly statement_descriptor?: string; - readonly statement_descriptor_kana?: string; - readonly statement_descriptor_kanji?: string; - }; + readonly statement_descriptor?: string + readonly statement_descriptor_kana?: string + readonly statement_descriptor_kanji?: string + } /** payout_settings_specs */ readonly payouts?: { - readonly debit_negative_balances?: boolean; + readonly debit_negative_balances?: boolean /** transfer_schedule_specs */ readonly schedule?: { - readonly delay_days?: Partial<"minimum"> & Partial; + readonly delay_days?: Partial<'minimum'> & Partial /** @enum {string} */ - readonly interval?: "daily" | "manual" | "monthly" | "weekly"; - readonly monthly_anchor?: number; + readonly interval?: 'daily' | 'manual' | 'monthly' | 'weekly' + readonly monthly_anchor?: number /** @enum {string} */ - readonly weekly_anchor?: - | "friday" - | "monday" - | "saturday" - | "sunday" - | "thursday" - | "tuesday" - | "wednesday"; - }; - readonly statement_descriptor?: string; - }; - }; + readonly weekly_anchor?: 'friday' | 'monday' | 'saturday' | 'sunday' | 'thursday' | 'tuesday' | 'wednesday' + } + readonly statement_descriptor?: string + } + } /** * tos_acceptance_specs * @description Details on the account's acceptance of the [Stripe Services Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance). */ readonly tos_acceptance?: { /** Format: unix-time */ - readonly date?: number; - readonly ip?: string; - readonly service_agreement?: string; - readonly user_agent?: string; - }; - }; - }; - }; - }; + readonly date?: number + readonly ip?: string + readonly service_agreement?: string + readonly user_agent?: string + } + } + } + } + } /** *

With Connect, you can delete accounts you manage.

* @@ -15235,101 +15029,101 @@ export interface operations { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["deleted_account"]; - }; - }; + readonly 'application/json': components['schemas']['deleted_account'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { - readonly account?: string; - }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { + readonly account?: string + } + } + } + } /**

Create an external account for a given account.

*/ readonly PostAccountBankAccounts: { readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["external_account"]; - }; - }; + readonly 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ readonly bank_account?: Partial<{ - readonly account_holder_name?: string; + readonly account_holder_name?: string /** @enum {string} */ - readonly account_holder_type?: "company" | "individual"; - readonly account_number: string; + readonly account_holder_type?: 'company' | 'individual' + readonly account_number: string /** @enum {string} */ - readonly account_type?: "checking" | "futsu" | "savings" | "toza"; - readonly country: string; - readonly currency?: string; + readonly account_type?: 'checking' | 'futsu' | 'savings' | 'toza' + readonly country: string + readonly currency?: string /** @enum {string} */ - readonly object?: "bank_account"; - readonly routing_number?: string; + readonly object?: 'bank_account' + readonly routing_number?: string }> & - Partial; + Partial /** @description When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency. */ - readonly default_for_currency?: boolean; + readonly default_for_currency?: boolean /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - readonly external_account?: string; + readonly external_account?: string /** @description 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`. */ - readonly metadata?: { readonly [key: string]: string }; - }; - }; - }; - }; + readonly metadata?: { readonly [key: string]: string } + } + } + } + } /**

Retrieve a specified external account for a given account.

*/ readonly GetAccountBankAccountsId: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["external_account"]; - }; - }; + readonly 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /** *

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

* @@ -15338,319 +15132,318 @@ export interface operations { readonly PostAccountBankAccountsId: { readonly parameters: { readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["external_account"]; - }; - }; + readonly 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description The name of the person or business that owns the bank account. */ - readonly account_holder_name?: string; + readonly account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - readonly account_holder_type?: "" | "company" | "individual"; + readonly account_holder_type?: '' | 'company' | 'individual' /** * @description The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`. * @enum {string} */ - readonly account_type?: "checking" | "futsu" | "savings" | "toza"; + readonly account_type?: 'checking' | 'futsu' | 'savings' | 'toza' /** @description City/District/Suburb/Town/Village. */ - readonly address_city?: string; + readonly address_city?: string /** @description Billing address country, if provided when creating card. */ - readonly address_country?: string; + readonly address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - readonly address_line1?: string; + readonly address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - readonly address_line2?: string; + readonly address_line2?: string /** @description State/County/Province/Region. */ - readonly address_state?: string; + readonly address_state?: string /** @description ZIP or postal code. */ - readonly address_zip?: string; + readonly address_zip?: string /** @description When set to true, this becomes the default external account for its currency. */ - readonly default_for_currency?: boolean; + readonly default_for_currency?: boolean /** @description Two digit number representing the card’s expiration month. */ - readonly exp_month?: string; + readonly exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - readonly exp_year?: string; + readonly exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description Cardholder name. */ - readonly name?: string; - }; - }; - }; - }; + readonly name?: string + } + } + } + } /**

Delete a specified external account for a given account.

*/ readonly DeleteAccountBankAccountsId: { readonly parameters: { readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["deleted_external_account"]; - }; - }; + readonly 'application/json': components['schemas']['deleted_external_account'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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

*/ readonly GetAccountCapabilities: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; + readonly expand?: readonly string[] + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["capability"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['capability'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Retrieves information about the specified Account Capability.

*/ readonly GetAccountCapabilitiesCapability: { readonly parameters: { readonly path: { - readonly capability: string; - }; + readonly capability: string + } readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; + readonly expand?: readonly string[] + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["capability"]; - }; - }; + readonly 'application/json': components['schemas']['capability'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Updates an existing Account Capability.

*/ readonly PostAccountCapabilitiesCapability: { readonly parameters: { readonly path: { - readonly capability: string; - }; - }; + readonly capability: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["capability"]; - }; - }; + readonly 'application/json': components['schemas']['capability'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. */ - readonly requested?: boolean; - }; - }; - }; - }; + readonly requested?: boolean + } + } + } + } /**

List external accounts for an account.

*/ readonly GetAccountExternalAccounts: { readonly parameters: { readonly query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards. */ - readonly data: readonly (Partial & - Partial)[]; + readonly data: readonly (Partial & Partial)[] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Create an external account for a given account.

*/ readonly PostAccountExternalAccounts: { readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["external_account"]; - }; - }; + readonly 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ readonly bank_account?: Partial<{ - readonly account_holder_name?: string; + readonly account_holder_name?: string /** @enum {string} */ - readonly account_holder_type?: "company" | "individual"; - readonly account_number: string; + readonly account_holder_type?: 'company' | 'individual' + readonly account_number: string /** @enum {string} */ - readonly account_type?: "checking" | "futsu" | "savings" | "toza"; - readonly country: string; - readonly currency?: string; + readonly account_type?: 'checking' | 'futsu' | 'savings' | 'toza' + readonly country: string + readonly currency?: string /** @enum {string} */ - readonly object?: "bank_account"; - readonly routing_number?: string; + readonly object?: 'bank_account' + readonly routing_number?: string }> & - Partial; + Partial /** @description When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency. */ - readonly default_for_currency?: boolean; + readonly default_for_currency?: boolean /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - readonly external_account?: string; + readonly external_account?: string /** @description 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`. */ - readonly metadata?: { readonly [key: string]: string }; - }; - }; - }; - }; + readonly metadata?: { readonly [key: string]: string } + } + } + } + } /**

Retrieve a specified external account for a given account.

*/ readonly GetAccountExternalAccountsId: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["external_account"]; - }; - }; + readonly 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /** *

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

* @@ -15659,93 +15452,93 @@ export interface operations { readonly PostAccountExternalAccountsId: { readonly parameters: { readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["external_account"]; - }; - }; + readonly 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description The name of the person or business that owns the bank account. */ - readonly account_holder_name?: string; + readonly account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - readonly account_holder_type?: "" | "company" | "individual"; + readonly account_holder_type?: '' | 'company' | 'individual' /** * @description The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`. * @enum {string} */ - readonly account_type?: "checking" | "futsu" | "savings" | "toza"; + readonly account_type?: 'checking' | 'futsu' | 'savings' | 'toza' /** @description City/District/Suburb/Town/Village. */ - readonly address_city?: string; + readonly address_city?: string /** @description Billing address country, if provided when creating card. */ - readonly address_country?: string; + readonly address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - readonly address_line1?: string; + readonly address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - readonly address_line2?: string; + readonly address_line2?: string /** @description State/County/Province/Region. */ - readonly address_state?: string; + readonly address_state?: string /** @description ZIP or postal code. */ - readonly address_zip?: string; + readonly address_zip?: string /** @description When set to true, this becomes the default external account for its currency. */ - readonly default_for_currency?: boolean; + readonly default_for_currency?: boolean /** @description Two digit number representing the card’s expiration month. */ - readonly exp_month?: string; + readonly exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - readonly exp_year?: string; + readonly exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description Cardholder name. */ - readonly name?: string; - }; - }; - }; - }; + readonly name?: string + } + } + } + } /**

Delete a specified external account for a given account.

*/ readonly DeleteAccountExternalAccountsId: { readonly parameters: { readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["deleted_external_account"]; - }; - }; + readonly 'application/json': components['schemas']['deleted_external_account'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /** *

Creates a single-use login link for an Express account to access their Stripe dashboard.

* @@ -15756,145 +15549,145 @@ export interface operations { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["login_link"]; - }; - }; + readonly 'application/json': components['schemas']['login_link'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { - readonly account: string; + readonly 'application/x-www-form-urlencoded': { + readonly account: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description Where to redirect the user after they log out of their dashboard. */ - readonly redirect_url?: string; - }; - }; - }; - }; + readonly redirect_url?: string + } + } + } + } /**

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.

*/ readonly GetAccountPeople: { readonly parameters: { readonly query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** Filters on the list of people returned based on the person's relationship to the account's company. */ readonly relationship?: { - readonly director?: boolean; - readonly executive?: boolean; - readonly owner?: boolean; - readonly representative?: boolean; - }; + readonly director?: boolean + readonly executive?: boolean + readonly owner?: boolean + readonly representative?: boolean + } /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["person"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['person'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Creates a new person.

*/ readonly PostAccountPeople: { readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["person"]; - }; - }; + readonly 'application/json': components['schemas']['person'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { - readonly account?: string; + readonly 'application/x-www-form-urlencoded': { + readonly account?: string /** * address_specs * @description The person's address. */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ readonly address_kana?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ readonly address_kanji?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** @description The person's date of birth. */ readonly dob?: Partial<{ - readonly day: number; - readonly month: number; - readonly year: number; + readonly day: number + readonly month: number + readonly year: number }> & - Partial<"">; + Partial<''> /** * person_documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -15902,65 +15695,65 @@ export interface operations { readonly documents?: { /** documents_param */ readonly company_authorization?: { - readonly files?: readonly string[]; - }; + readonly files?: readonly string[] + } /** documents_param */ readonly passport?: { - readonly files?: readonly string[]; - }; + readonly files?: readonly string[] + } /** documents_param */ readonly visa?: { - readonly files?: readonly string[]; - }; - }; + readonly files?: readonly string[] + } + } /** @description The person's email address. */ - readonly email?: string; + readonly email?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The person's first name. */ - readonly first_name?: string; + readonly first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - readonly first_name_kana?: string; + readonly first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - readonly first_name_kanji?: string; + readonly first_name_kanji?: string /** @description A list of alternate names or aliases that the person is known by. */ - readonly full_name_aliases?: Partial & Partial<"">; + readonly full_name_aliases?: Partial & Partial<''> /** @description The person's gender (International regulations require either "male" or "female"). */ - readonly gender?: string; + readonly gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ - readonly id_number?: string; + readonly id_number?: string /** @description The person's last name. */ - readonly last_name?: string; + readonly last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - readonly last_name_kana?: string; + readonly last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - readonly last_name_kanji?: string; + readonly last_name_kanji?: string /** @description The person's maiden name. */ - readonly maiden_name?: string; + readonly maiden_name?: string /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ - readonly nationality?: string; + readonly nationality?: string /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - readonly person_token?: string; + readonly person_token?: string /** @description The person's phone number. */ - readonly phone?: string; + readonly phone?: string /** @description 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. */ - readonly political_exposure?: string; + readonly political_exposure?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ readonly relationship?: { - readonly director?: boolean; - readonly executive?: boolean; - readonly owner?: boolean; - readonly percent_ownership?: Partial & Partial<"">; - readonly representative?: boolean; - readonly title?: string; - }; + readonly director?: boolean + readonly executive?: boolean + readonly owner?: boolean + readonly percent_ownership?: Partial & Partial<''> + readonly representative?: boolean + readonly title?: string + } /** @description The last four digits of the person's Social Security number (U.S. only). */ - readonly ssn_last_4?: string; + readonly ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -15968,120 +15761,120 @@ export interface operations { readonly verification?: { /** person_verification_document_specs */ readonly additional_document?: { - readonly back?: string; - readonly front?: string; - }; + readonly back?: string + readonly front?: string + } /** person_verification_document_specs */ readonly document?: { - readonly back?: string; - readonly front?: string; - }; - }; - }; - }; - }; - }; + readonly back?: string + readonly front?: string + } + } + } + } + } + } /**

Retrieves an existing person.

*/ readonly GetAccountPeoplePerson: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly person: string; - }; - }; + readonly person: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["person"]; - }; - }; + readonly 'application/json': components['schemas']['person'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Updates an existing person.

*/ readonly PostAccountPeoplePerson: { readonly parameters: { readonly path: { - readonly person: string; - }; - }; + readonly person: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["person"]; - }; - }; + readonly 'application/json': components['schemas']['person'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { - readonly account?: string; + readonly 'application/x-www-form-urlencoded': { + readonly account?: string /** * address_specs * @description The person's address. */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ readonly address_kana?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ readonly address_kanji?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** @description The person's date of birth. */ readonly dob?: Partial<{ - readonly day: number; - readonly month: number; - readonly year: number; + readonly day: number + readonly month: number + readonly year: number }> & - Partial<"">; + Partial<''> /** * person_documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -16089,65 +15882,65 @@ export interface operations { readonly documents?: { /** documents_param */ readonly company_authorization?: { - readonly files?: readonly string[]; - }; + readonly files?: readonly string[] + } /** documents_param */ readonly passport?: { - readonly files?: readonly string[]; - }; + readonly files?: readonly string[] + } /** documents_param */ readonly visa?: { - readonly files?: readonly string[]; - }; - }; + readonly files?: readonly string[] + } + } /** @description The person's email address. */ - readonly email?: string; + readonly email?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The person's first name. */ - readonly first_name?: string; + readonly first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - readonly first_name_kana?: string; + readonly first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - readonly first_name_kanji?: string; + readonly first_name_kanji?: string /** @description A list of alternate names or aliases that the person is known by. */ - readonly full_name_aliases?: Partial & Partial<"">; + readonly full_name_aliases?: Partial & Partial<''> /** @description The person's gender (International regulations require either "male" or "female"). */ - readonly gender?: string; + readonly gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ - readonly id_number?: string; + readonly id_number?: string /** @description The person's last name. */ - readonly last_name?: string; + readonly last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - readonly last_name_kana?: string; + readonly last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - readonly last_name_kanji?: string; + readonly last_name_kanji?: string /** @description The person's maiden name. */ - readonly maiden_name?: string; + readonly maiden_name?: string /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ - readonly nationality?: string; + readonly nationality?: string /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - readonly person_token?: string; + readonly person_token?: string /** @description The person's phone number. */ - readonly phone?: string; + readonly phone?: string /** @description 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. */ - readonly political_exposure?: string; + readonly political_exposure?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ readonly relationship?: { - readonly director?: boolean; - readonly executive?: boolean; - readonly owner?: boolean; - readonly percent_ownership?: Partial & Partial<"">; - readonly representative?: boolean; - readonly title?: string; - }; + readonly director?: boolean + readonly executive?: boolean + readonly owner?: boolean + readonly percent_ownership?: Partial & Partial<''> + readonly representative?: boolean + readonly title?: string + } /** @description The last four digits of the person's Social Security number (U.S. only). */ - readonly ssn_last_4?: string; + readonly ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -16155,163 +15948,163 @@ export interface operations { readonly verification?: { /** person_verification_document_specs */ readonly additional_document?: { - readonly back?: string; - readonly front?: string; - }; + readonly back?: string + readonly front?: string + } /** person_verification_document_specs */ readonly document?: { - readonly back?: string; - readonly front?: string; - }; - }; - }; - }; - }; - }; + readonly back?: string + readonly front?: string + } + } + } + } + } + } /**

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.

*/ readonly DeleteAccountPeoplePerson: { readonly parameters: { readonly path: { - readonly person: string; - }; - }; + readonly person: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["deleted_person"]; - }; - }; + readonly 'application/json': components['schemas']['deleted_person'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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.

*/ readonly GetAccountPersons: { readonly parameters: { readonly query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** Filters on the list of people returned based on the person's relationship to the account's company. */ readonly relationship?: { - readonly director?: boolean; - readonly executive?: boolean; - readonly owner?: boolean; - readonly representative?: boolean; - }; + readonly director?: boolean + readonly executive?: boolean + readonly owner?: boolean + readonly representative?: boolean + } /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["person"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['person'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Creates a new person.

*/ readonly PostAccountPersons: { readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["person"]; - }; - }; + readonly 'application/json': components['schemas']['person'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { - readonly account?: string; + readonly 'application/x-www-form-urlencoded': { + readonly account?: string /** * address_specs * @description The person's address. */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ readonly address_kana?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ readonly address_kanji?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** @description The person's date of birth. */ readonly dob?: Partial<{ - readonly day: number; - readonly month: number; - readonly year: number; + readonly day: number + readonly month: number + readonly year: number }> & - Partial<"">; + Partial<''> /** * person_documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -16319,65 +16112,65 @@ export interface operations { readonly documents?: { /** documents_param */ readonly company_authorization?: { - readonly files?: readonly string[]; - }; + readonly files?: readonly string[] + } /** documents_param */ readonly passport?: { - readonly files?: readonly string[]; - }; + readonly files?: readonly string[] + } /** documents_param */ readonly visa?: { - readonly files?: readonly string[]; - }; - }; + readonly files?: readonly string[] + } + } /** @description The person's email address. */ - readonly email?: string; + readonly email?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The person's first name. */ - readonly first_name?: string; + readonly first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - readonly first_name_kana?: string; + readonly first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - readonly first_name_kanji?: string; + readonly first_name_kanji?: string /** @description A list of alternate names or aliases that the person is known by. */ - readonly full_name_aliases?: Partial & Partial<"">; + readonly full_name_aliases?: Partial & Partial<''> /** @description The person's gender (International regulations require either "male" or "female"). */ - readonly gender?: string; + readonly gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ - readonly id_number?: string; + readonly id_number?: string /** @description The person's last name. */ - readonly last_name?: string; + readonly last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - readonly last_name_kana?: string; + readonly last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - readonly last_name_kanji?: string; + readonly last_name_kanji?: string /** @description The person's maiden name. */ - readonly maiden_name?: string; + readonly maiden_name?: string /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ - readonly nationality?: string; + readonly nationality?: string /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - readonly person_token?: string; + readonly person_token?: string /** @description The person's phone number. */ - readonly phone?: string; + readonly phone?: string /** @description 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. */ - readonly political_exposure?: string; + readonly political_exposure?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ readonly relationship?: { - readonly director?: boolean; - readonly executive?: boolean; - readonly owner?: boolean; - readonly percent_ownership?: Partial & Partial<"">; - readonly representative?: boolean; - readonly title?: string; - }; + readonly director?: boolean + readonly executive?: boolean + readonly owner?: boolean + readonly percent_ownership?: Partial & Partial<''> + readonly representative?: boolean + readonly title?: string + } /** @description The last four digits of the person's Social Security number (U.S. only). */ - readonly ssn_last_4?: string; + readonly ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -16385,120 +16178,120 @@ export interface operations { readonly verification?: { /** person_verification_document_specs */ readonly additional_document?: { - readonly back?: string; - readonly front?: string; - }; + readonly back?: string + readonly front?: string + } /** person_verification_document_specs */ readonly document?: { - readonly back?: string; - readonly front?: string; - }; - }; - }; - }; - }; - }; + readonly back?: string + readonly front?: string + } + } + } + } + } + } /**

Retrieves an existing person.

*/ readonly GetAccountPersonsPerson: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly person: string; - }; - }; + readonly person: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["person"]; - }; - }; + readonly 'application/json': components['schemas']['person'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Updates an existing person.

*/ readonly PostAccountPersonsPerson: { readonly parameters: { readonly path: { - readonly person: string; - }; - }; + readonly person: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["person"]; - }; - }; + readonly 'application/json': components['schemas']['person'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { - readonly account?: string; + readonly 'application/x-www-form-urlencoded': { + readonly account?: string /** * address_specs * @description The person's address. */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ readonly address_kana?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ readonly address_kanji?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** @description The person's date of birth. */ readonly dob?: Partial<{ - readonly day: number; - readonly month: number; - readonly year: number; + readonly day: number + readonly month: number + readonly year: number }> & - Partial<"">; + Partial<''> /** * person_documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -16506,65 +16299,65 @@ export interface operations { readonly documents?: { /** documents_param */ readonly company_authorization?: { - readonly files?: readonly string[]; - }; + readonly files?: readonly string[] + } /** documents_param */ readonly passport?: { - readonly files?: readonly string[]; - }; + readonly files?: readonly string[] + } /** documents_param */ readonly visa?: { - readonly files?: readonly string[]; - }; - }; + readonly files?: readonly string[] + } + } /** @description The person's email address. */ - readonly email?: string; + readonly email?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The person's first name. */ - readonly first_name?: string; + readonly first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - readonly first_name_kana?: string; + readonly first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - readonly first_name_kanji?: string; + readonly first_name_kanji?: string /** @description A list of alternate names or aliases that the person is known by. */ - readonly full_name_aliases?: Partial & Partial<"">; + readonly full_name_aliases?: Partial & Partial<''> /** @description The person's gender (International regulations require either "male" or "female"). */ - readonly gender?: string; + readonly gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ - readonly id_number?: string; + readonly id_number?: string /** @description The person's last name. */ - readonly last_name?: string; + readonly last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - readonly last_name_kana?: string; + readonly last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - readonly last_name_kanji?: string; + readonly last_name_kanji?: string /** @description The person's maiden name. */ - readonly maiden_name?: string; + readonly maiden_name?: string /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ - readonly nationality?: string; + readonly nationality?: string /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - readonly person_token?: string; + readonly person_token?: string /** @description The person's phone number. */ - readonly phone?: string; + readonly phone?: string /** @description 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. */ - readonly political_exposure?: string; + readonly political_exposure?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ readonly relationship?: { - readonly director?: boolean; - readonly executive?: boolean; - readonly owner?: boolean; - readonly percent_ownership?: Partial & Partial<"">; - readonly representative?: boolean; - readonly title?: string; - }; + readonly director?: boolean + readonly executive?: boolean + readonly owner?: boolean + readonly percent_ownership?: Partial & Partial<''> + readonly representative?: boolean + readonly title?: string + } /** @description The last four digits of the person's Social Security number (U.S. only). */ - readonly ssn_last_4?: string; + readonly ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -16572,139 +16365,139 @@ export interface operations { readonly verification?: { /** person_verification_document_specs */ readonly additional_document?: { - readonly back?: string; - readonly front?: string; - }; + readonly back?: string + readonly front?: string + } /** person_verification_document_specs */ readonly document?: { - readonly back?: string; - readonly front?: string; - }; - }; - }; - }; - }; - }; + readonly back?: string + readonly front?: string + } + } + } + } + } + } /**

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.

*/ readonly DeleteAccountPersonsPerson: { readonly parameters: { readonly path: { - readonly person: string; - }; - }; + readonly person: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["deleted_person"]; - }; - }; + readonly 'application/json': components['schemas']['deleted_person'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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.

*/ readonly PostAccountLinks: { readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["account_link"]; - }; - }; + readonly 'application/json': components['schemas']['account_link'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description The identifier of the account to create an account link for. */ - readonly account: string; + readonly account: string /** * @description Which information the platform needs to collect from the user. One of `currently_due` or `eventually_due`. Default is `currently_due`. * @enum {string} */ - readonly collect?: "currently_due" | "eventually_due"; + readonly collect?: 'currently_due' | 'eventually_due' /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The URL the user will be redirected to if the account link is expired, has been previously-visited, or is otherwise invalid. The URL you specify should attempt to generate a new account link with the same parameters used to create the original account link, then redirect the user to the new account link's URL so they can continue with Connect Onboarding. If a new account link cannot be generated or the redirect fails you should display a useful error to the user. */ - readonly refresh_url?: string; + readonly refresh_url?: string /** @description The URL that the user will be redirected to upon leaving or completing the linked flow. */ - readonly return_url?: string; + readonly return_url?: string /** * @description The type of account link the user is requesting. Possible values are `account_onboarding` or `account_update`. * @enum {string} */ - readonly type: "account_onboarding" | "account_update"; - }; - }; - }; - }; + readonly type: 'account_onboarding' | 'account_update' + } + } + } + } /**

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

*/ readonly GetAccounts: { readonly parameters: { readonly query: { readonly created?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["account"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['account'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /** *

With Connect, you can create Stripe accounts for your users. * To do this, you’ll first need to register your platform.

@@ -16714,63 +16507,63 @@ export interface operations { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["account"]; - }; - }; + readonly 'application/json': components['schemas']['account'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account. */ - readonly account_token?: string; + readonly account_token?: string /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ readonly bank_account?: Partial<{ - readonly account_holder_name?: string; + readonly account_holder_name?: string /** @enum {string} */ - readonly account_holder_type?: "company" | "individual"; - readonly account_number: string; + readonly account_holder_type?: 'company' | 'individual' + readonly account_number: string /** @enum {string} */ - readonly account_type?: "checking" | "futsu" | "savings" | "toza"; - readonly country: string; - readonly currency?: string; + readonly account_type?: 'checking' | 'futsu' | 'savings' | 'toza' + readonly country: string + readonly currency?: string /** @enum {string} */ - readonly object?: "bank_account"; - readonly routing_number?: string; + readonly object?: 'bank_account' + readonly routing_number?: string }> & - Partial; + Partial /** * business_profile_specs * @description Business information about the account. */ readonly business_profile?: { - readonly mcc?: string; - readonly name?: string; - readonly product_description?: string; + readonly mcc?: string + readonly name?: string + readonly product_description?: string /** address_specs */ readonly support_address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; - readonly support_email?: string; - readonly support_phone?: string; - readonly support_url?: Partial & Partial<"">; - readonly url?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } + readonly support_email?: string + readonly support_phone?: string + readonly support_url?: Partial & Partial<''> + readonly url?: string + } /** * @description The business type. * @enum {string} */ - readonly business_type?: "company" | "government_entity" | "individual" | "non_profit"; + readonly business_type?: 'company' | 'government_entity' | 'individual' | 'non_profit' /** * capabilities_param * @description Each key of the dictionary represents a capability, and each capability maps to its settings (e.g. whether it has been requested or not). Each capability will be inactive until you have provided its specific requirements and Stripe has verified them. An account may have some of its requested capabilities be active and some be inactive. @@ -16778,101 +16571,101 @@ export interface operations { readonly capabilities?: { /** capability_param */ readonly acss_debit_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly afterpay_clearpay_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly au_becs_debit_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly bacs_debit_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly bancontact_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly boleto_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly card_issuing?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly card_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly cartes_bancaires_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly eps_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly fpx_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly giropay_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly grabpay_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly ideal_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly jcb_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly klarna_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly legacy_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly oxxo_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly p24_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly sepa_debit_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly sofort_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly tax_reporting_us_1099_k?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly tax_reporting_us_1099_misc?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly transfers?: { - readonly requested?: boolean; - }; - }; + readonly requested?: boolean + } + } /** * company_specs * @description Information about the company or business. This field is available for any `business_type`. @@ -16880,87 +16673,87 @@ export interface operations { readonly company?: { /** address_specs */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } /** japan_address_kana_specs */ readonly address_kana?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** japan_address_kanji_specs */ readonly address_kanji?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; - readonly directors_provided?: boolean; - readonly executives_provided?: boolean; - readonly name?: string; - readonly name_kana?: string; - readonly name_kanji?: string; - readonly owners_provided?: boolean; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } + readonly directors_provided?: boolean + readonly executives_provided?: boolean + readonly name?: string + readonly name_kana?: string + readonly name_kanji?: string + readonly owners_provided?: boolean /** company_ownership_declaration */ readonly ownership_declaration?: { /** Format: unix-time */ - readonly date?: number; - readonly ip?: string; - readonly user_agent?: string; - }; - readonly phone?: string; - readonly registration_number?: string; + readonly date?: number + readonly ip?: string + readonly user_agent?: string + } + readonly phone?: string + readonly registration_number?: string /** @enum {string} */ readonly structure?: - | "" - | "free_zone_establishment" - | "free_zone_llc" - | "government_instrumentality" - | "governmental_unit" - | "incorporated_non_profit" - | "limited_liability_partnership" - | "llc" - | "multi_member_llc" - | "private_company" - | "private_corporation" - | "private_partnership" - | "public_company" - | "public_corporation" - | "public_partnership" - | "single_member_llc" - | "sole_establishment" - | "sole_proprietorship" - | "tax_exempt_government_instrumentality" - | "unincorporated_association" - | "unincorporated_non_profit"; - readonly tax_id?: string; - readonly tax_id_registrar?: string; - readonly vat_id?: string; + | '' + | 'free_zone_establishment' + | 'free_zone_llc' + | 'government_instrumentality' + | 'governmental_unit' + | 'incorporated_non_profit' + | 'limited_liability_partnership' + | 'llc' + | 'multi_member_llc' + | 'private_company' + | 'private_corporation' + | 'private_partnership' + | 'public_company' + | 'public_corporation' + | 'public_partnership' + | 'single_member_llc' + | 'sole_establishment' + | 'sole_proprietorship' + | 'tax_exempt_government_instrumentality' + | 'unincorporated_association' + | 'unincorporated_non_profit' + readonly tax_id?: string + readonly tax_id_registrar?: string + readonly vat_id?: string /** verification_specs */ readonly verification?: { /** verification_document_specs */ readonly document?: { - readonly back?: string; - readonly front?: string; - }; - }; - }; + readonly back?: string + readonly front?: string + } + } + } /** @description The country in which the account holder resides, or in which the business is legally established. This should be an ISO 3166-1 alpha-2 country code. For example, if you are in the United States and the business for which you're creating an account is legally represented in Canada, you would use `CA` as the country for the account being created. */ - readonly country?: string; + readonly country?: string /** @description 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). */ - readonly default_currency?: string; + readonly default_currency?: string /** * documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -16968,39 +16761,39 @@ export interface operations { readonly documents?: { /** documents_param */ readonly bank_account_ownership_verification?: { - readonly files?: readonly string[]; - }; + readonly files?: readonly string[] + } /** documents_param */ readonly company_license?: { - readonly files?: readonly string[]; - }; + readonly files?: readonly string[] + } /** documents_param */ readonly company_memorandum_of_association?: { - readonly files?: readonly string[]; - }; + readonly files?: readonly string[] + } /** documents_param */ readonly company_ministerial_decree?: { - readonly files?: readonly string[]; - }; + readonly files?: readonly string[] + } /** documents_param */ readonly company_registration_verification?: { - readonly files?: readonly string[]; - }; + readonly files?: readonly string[] + } /** documents_param */ readonly company_tax_id_verification?: { - readonly files?: readonly string[]; - }; + readonly files?: readonly string[] + } /** documents_param */ readonly proof_of_registration?: { - readonly files?: readonly string[]; - }; - }; + readonly files?: readonly string[] + } + } /** @description The email address of the account holder. This is only to make the account easier to identify to you. Stripe only emails Custom accounts with your consent. */ - readonly email?: string; + readonly email?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description A card or bank account to attach to the account for receiving [payouts](https://stripe.com/docs/connect/bank-debit-card-payouts) (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://stripe.com/docs/api#account_create_bank_account) creation.

By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the bank account or card creation API. */ - readonly external_account?: string; + readonly external_account?: string /** * individual_specs * @description Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. @@ -17008,71 +16801,71 @@ export interface operations { readonly individual?: { /** address_specs */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } /** japan_address_kana_specs */ readonly address_kana?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** japan_address_kanji_specs */ readonly address_kanji?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } readonly dob?: Partial<{ - readonly day: number; - readonly month: number; - readonly year: number; + readonly day: number + readonly month: number + readonly year: number }> & - Partial<"">; - readonly email?: string; - readonly first_name?: string; - readonly first_name_kana?: string; - readonly first_name_kanji?: string; - readonly full_name_aliases?: Partial & Partial<"">; - readonly gender?: string; - readonly id_number?: string; - readonly last_name?: string; - readonly last_name_kana?: string; - readonly last_name_kanji?: string; - readonly maiden_name?: string; - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; - readonly phone?: string; + Partial<''> + readonly email?: string + readonly first_name?: string + readonly first_name_kana?: string + readonly first_name_kanji?: string + readonly full_name_aliases?: Partial & Partial<''> + readonly gender?: string + readonly id_number?: string + readonly last_name?: string + readonly last_name_kana?: string + readonly last_name_kanji?: string + readonly maiden_name?: string + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> + readonly phone?: string /** @enum {string} */ - readonly political_exposure?: "existing" | "none"; - readonly ssn_last_4?: string; + readonly political_exposure?: 'existing' | 'none' + readonly ssn_last_4?: string /** person_verification_specs */ readonly verification?: { /** person_verification_document_specs */ readonly additional_document?: { - readonly back?: string; - readonly front?: string; - }; + readonly back?: string + readonly front?: string + } /** person_verification_document_specs */ readonly document?: { - readonly back?: string; - readonly front?: string; - }; - }; - }; + readonly back?: string + readonly front?: string + } + } + } /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** * settings_specs * @description Options for customizing how the account functions within Stripe. @@ -17080,109 +16873,102 @@ export interface operations { readonly settings?: { /** branding_settings_specs */ readonly branding?: { - readonly icon?: string; - readonly logo?: string; - readonly primary_color?: string; - readonly secondary_color?: string; - }; + readonly icon?: string + readonly logo?: string + readonly primary_color?: string + readonly secondary_color?: string + } /** card_issuing_settings_specs */ readonly card_issuing?: { /** settings_terms_of_service_specs */ readonly tos_acceptance?: { /** Format: unix-time */ - readonly date?: number; - readonly ip?: string; - readonly user_agent?: string; - }; - }; + readonly date?: number + readonly ip?: string + readonly user_agent?: string + } + } /** card_payments_settings_specs */ readonly card_payments?: { /** decline_charge_on_specs */ readonly decline_on?: { - readonly avs_failure?: boolean; - readonly cvc_failure?: boolean; - }; - readonly statement_descriptor_prefix?: string; - }; + readonly avs_failure?: boolean + readonly cvc_failure?: boolean + } + readonly statement_descriptor_prefix?: string + } /** payments_settings_specs */ readonly payments?: { - readonly statement_descriptor?: string; - readonly statement_descriptor_kana?: string; - readonly statement_descriptor_kanji?: string; - }; + readonly statement_descriptor?: string + readonly statement_descriptor_kana?: string + readonly statement_descriptor_kanji?: string + } /** payout_settings_specs */ readonly payouts?: { - readonly debit_negative_balances?: boolean; + readonly debit_negative_balances?: boolean /** transfer_schedule_specs */ readonly schedule?: { - readonly delay_days?: Partial<"minimum"> & Partial; + readonly delay_days?: Partial<'minimum'> & Partial /** @enum {string} */ - readonly interval?: "daily" | "manual" | "monthly" | "weekly"; - readonly monthly_anchor?: number; + readonly interval?: 'daily' | 'manual' | 'monthly' | 'weekly' + readonly monthly_anchor?: number /** @enum {string} */ - readonly weekly_anchor?: - | "friday" - | "monday" - | "saturday" - | "sunday" - | "thursday" - | "tuesday" - | "wednesday"; - }; - readonly statement_descriptor?: string; - }; - }; + readonly weekly_anchor?: 'friday' | 'monday' | 'saturday' | 'sunday' | 'thursday' | 'tuesday' | 'wednesday' + } + readonly statement_descriptor?: string + } + } /** * tos_acceptance_specs * @description Details on the account's acceptance of the [Stripe Services Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance). */ readonly tos_acceptance?: { /** Format: unix-time */ - readonly date?: number; - readonly ip?: string; - readonly service_agreement?: string; - readonly user_agent?: string; - }; + readonly date?: number + readonly ip?: string + readonly service_agreement?: string + readonly user_agent?: string + } /** * @description The type of Stripe account to create. May be one of `custom`, `express` or `standard`. * @enum {string} */ - readonly type?: "custom" | "express" | "standard"; - }; - }; - }; - }; + readonly type?: 'custom' | 'express' | 'standard' + } + } + } + } /**

Retrieves the details of an account.

*/ readonly GetAccountsAccount: { readonly parameters: { readonly path: { - readonly account: string; - }; + readonly account: string + } readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; + readonly expand?: readonly string[] + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["account"]; - }; - }; + readonly 'application/json': components['schemas']['account'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /** *

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged. Most parameters can be changed only for Custom accounts. (These are marked Custom Only below.) Parameters marked Custom and Express are not supported for Standard accounts.

* @@ -17191,70 +16977,70 @@ export interface operations { readonly PostAccountsAccount: { readonly parameters: { readonly path: { - readonly account: string; - }; - }; + readonly account: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["account"]; - }; - }; + readonly 'application/json': components['schemas']['account'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account. */ - readonly account_token?: string; + readonly account_token?: string /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ readonly bank_account?: Partial<{ - readonly account_holder_name?: string; + readonly account_holder_name?: string /** @enum {string} */ - readonly account_holder_type?: "company" | "individual"; - readonly account_number: string; + readonly account_holder_type?: 'company' | 'individual' + readonly account_number: string /** @enum {string} */ - readonly account_type?: "checking" | "futsu" | "savings" | "toza"; - readonly country: string; - readonly currency?: string; + readonly account_type?: 'checking' | 'futsu' | 'savings' | 'toza' + readonly country: string + readonly currency?: string /** @enum {string} */ - readonly object?: "bank_account"; - readonly routing_number?: string; + readonly object?: 'bank_account' + readonly routing_number?: string }> & - Partial; + Partial /** * business_profile_specs * @description Business information about the account. */ readonly business_profile?: { - readonly mcc?: string; - readonly name?: string; - readonly product_description?: string; + readonly mcc?: string + readonly name?: string + readonly product_description?: string /** address_specs */ readonly support_address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; - readonly support_email?: string; - readonly support_phone?: string; - readonly support_url?: Partial & Partial<"">; - readonly url?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } + readonly support_email?: string + readonly support_phone?: string + readonly support_url?: Partial & Partial<''> + readonly url?: string + } /** * @description The business type. * @enum {string} */ - readonly business_type?: "company" | "government_entity" | "individual" | "non_profit"; + readonly business_type?: 'company' | 'government_entity' | 'individual' | 'non_profit' /** * capabilities_param * @description Each key of the dictionary represents a capability, and each capability maps to its settings (e.g. whether it has been requested or not). Each capability will be inactive until you have provided its specific requirements and Stripe has verified them. An account may have some of its requested capabilities be active and some be inactive. @@ -17262,101 +17048,101 @@ export interface operations { readonly capabilities?: { /** capability_param */ readonly acss_debit_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly afterpay_clearpay_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly au_becs_debit_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly bacs_debit_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly bancontact_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly boleto_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly card_issuing?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly card_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly cartes_bancaires_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly eps_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly fpx_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly giropay_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly grabpay_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly ideal_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly jcb_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly klarna_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly legacy_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly oxxo_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly p24_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly sepa_debit_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly sofort_payments?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly tax_reporting_us_1099_k?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly tax_reporting_us_1099_misc?: { - readonly requested?: boolean; - }; + readonly requested?: boolean + } /** capability_param */ readonly transfers?: { - readonly requested?: boolean; - }; - }; + readonly requested?: boolean + } + } /** * company_specs * @description Information about the company or business. This field is available for any `business_type`. @@ -17364,85 +17150,85 @@ export interface operations { readonly company?: { /** address_specs */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } /** japan_address_kana_specs */ readonly address_kana?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** japan_address_kanji_specs */ readonly address_kanji?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; - readonly directors_provided?: boolean; - readonly executives_provided?: boolean; - readonly name?: string; - readonly name_kana?: string; - readonly name_kanji?: string; - readonly owners_provided?: boolean; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } + readonly directors_provided?: boolean + readonly executives_provided?: boolean + readonly name?: string + readonly name_kana?: string + readonly name_kanji?: string + readonly owners_provided?: boolean /** company_ownership_declaration */ readonly ownership_declaration?: { /** Format: unix-time */ - readonly date?: number; - readonly ip?: string; - readonly user_agent?: string; - }; - readonly phone?: string; - readonly registration_number?: string; + readonly date?: number + readonly ip?: string + readonly user_agent?: string + } + readonly phone?: string + readonly registration_number?: string /** @enum {string} */ readonly structure?: - | "" - | "free_zone_establishment" - | "free_zone_llc" - | "government_instrumentality" - | "governmental_unit" - | "incorporated_non_profit" - | "limited_liability_partnership" - | "llc" - | "multi_member_llc" - | "private_company" - | "private_corporation" - | "private_partnership" - | "public_company" - | "public_corporation" - | "public_partnership" - | "single_member_llc" - | "sole_establishment" - | "sole_proprietorship" - | "tax_exempt_government_instrumentality" - | "unincorporated_association" - | "unincorporated_non_profit"; - readonly tax_id?: string; - readonly tax_id_registrar?: string; - readonly vat_id?: string; + | '' + | 'free_zone_establishment' + | 'free_zone_llc' + | 'government_instrumentality' + | 'governmental_unit' + | 'incorporated_non_profit' + | 'limited_liability_partnership' + | 'llc' + | 'multi_member_llc' + | 'private_company' + | 'private_corporation' + | 'private_partnership' + | 'public_company' + | 'public_corporation' + | 'public_partnership' + | 'single_member_llc' + | 'sole_establishment' + | 'sole_proprietorship' + | 'tax_exempt_government_instrumentality' + | 'unincorporated_association' + | 'unincorporated_non_profit' + readonly tax_id?: string + readonly tax_id_registrar?: string + readonly vat_id?: string /** verification_specs */ readonly verification?: { /** verification_document_specs */ readonly document?: { - readonly back?: string; - readonly front?: string; - }; - }; - }; + readonly back?: string + readonly front?: string + } + } + } /** @description 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). */ - readonly default_currency?: string; + readonly default_currency?: string /** * documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -17450,39 +17236,39 @@ export interface operations { readonly documents?: { /** documents_param */ readonly bank_account_ownership_verification?: { - readonly files?: readonly string[]; - }; + readonly files?: readonly string[] + } /** documents_param */ readonly company_license?: { - readonly files?: readonly string[]; - }; + readonly files?: readonly string[] + } /** documents_param */ readonly company_memorandum_of_association?: { - readonly files?: readonly string[]; - }; + readonly files?: readonly string[] + } /** documents_param */ readonly company_ministerial_decree?: { - readonly files?: readonly string[]; - }; + readonly files?: readonly string[] + } /** documents_param */ readonly company_registration_verification?: { - readonly files?: readonly string[]; - }; + readonly files?: readonly string[] + } /** documents_param */ readonly company_tax_id_verification?: { - readonly files?: readonly string[]; - }; + readonly files?: readonly string[] + } /** documents_param */ readonly proof_of_registration?: { - readonly files?: readonly string[]; - }; - }; + readonly files?: readonly string[] + } + } /** @description The email address of the account holder. This is only to make the account easier to identify to you. Stripe only emails Custom accounts with your consent. */ - readonly email?: string; + readonly email?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description A card or bank account to attach to the account for receiving [payouts](https://stripe.com/docs/connect/bank-debit-card-payouts) (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://stripe.com/docs/api#account_create_bank_account) creation.

By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the bank account or card creation API. */ - readonly external_account?: string; + readonly external_account?: string /** * individual_specs * @description Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. @@ -17490,71 +17276,71 @@ export interface operations { readonly individual?: { /** address_specs */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } /** japan_address_kana_specs */ readonly address_kana?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** japan_address_kanji_specs */ readonly address_kanji?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } readonly dob?: Partial<{ - readonly day: number; - readonly month: number; - readonly year: number; + readonly day: number + readonly month: number + readonly year: number }> & - Partial<"">; - readonly email?: string; - readonly first_name?: string; - readonly first_name_kana?: string; - readonly first_name_kanji?: string; - readonly full_name_aliases?: Partial & Partial<"">; - readonly gender?: string; - readonly id_number?: string; - readonly last_name?: string; - readonly last_name_kana?: string; - readonly last_name_kanji?: string; - readonly maiden_name?: string; - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; - readonly phone?: string; + Partial<''> + readonly email?: string + readonly first_name?: string + readonly first_name_kana?: string + readonly first_name_kanji?: string + readonly full_name_aliases?: Partial & Partial<''> + readonly gender?: string + readonly id_number?: string + readonly last_name?: string + readonly last_name_kana?: string + readonly last_name_kanji?: string + readonly maiden_name?: string + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> + readonly phone?: string /** @enum {string} */ - readonly political_exposure?: "existing" | "none"; - readonly ssn_last_4?: string; + readonly political_exposure?: 'existing' | 'none' + readonly ssn_last_4?: string /** person_verification_specs */ readonly verification?: { /** person_verification_document_specs */ readonly additional_document?: { - readonly back?: string; - readonly front?: string; - }; + readonly back?: string + readonly front?: string + } /** person_verification_document_specs */ readonly document?: { - readonly back?: string; - readonly front?: string; - }; - }; - }; + readonly back?: string + readonly front?: string + } + } + } /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** * settings_specs_update * @description Options for customizing how the account functions within Stripe. @@ -17562,73 +17348,66 @@ export interface operations { readonly settings?: { /** branding_settings_specs */ readonly branding?: { - readonly icon?: string; - readonly logo?: string; - readonly primary_color?: string; - readonly secondary_color?: string; - }; + readonly icon?: string + readonly logo?: string + readonly primary_color?: string + readonly secondary_color?: string + } /** card_issuing_settings_specs */ readonly card_issuing?: { /** settings_terms_of_service_specs */ readonly tos_acceptance?: { /** Format: unix-time */ - readonly date?: number; - readonly ip?: string; - readonly user_agent?: string; - }; - }; + readonly date?: number + readonly ip?: string + readonly user_agent?: string + } + } /** card_payments_settings_specs */ readonly card_payments?: { /** decline_charge_on_specs */ readonly decline_on?: { - readonly avs_failure?: boolean; - readonly cvc_failure?: boolean; - }; - readonly statement_descriptor_prefix?: string; - }; + readonly avs_failure?: boolean + readonly cvc_failure?: boolean + } + readonly statement_descriptor_prefix?: string + } /** payments_settings_specs */ readonly payments?: { - readonly statement_descriptor?: string; - readonly statement_descriptor_kana?: string; - readonly statement_descriptor_kanji?: string; - }; + readonly statement_descriptor?: string + readonly statement_descriptor_kana?: string + readonly statement_descriptor_kanji?: string + } /** payout_settings_specs */ readonly payouts?: { - readonly debit_negative_balances?: boolean; + readonly debit_negative_balances?: boolean /** transfer_schedule_specs */ readonly schedule?: { - readonly delay_days?: Partial<"minimum"> & Partial; + readonly delay_days?: Partial<'minimum'> & Partial /** @enum {string} */ - readonly interval?: "daily" | "manual" | "monthly" | "weekly"; - readonly monthly_anchor?: number; + readonly interval?: 'daily' | 'manual' | 'monthly' | 'weekly' + readonly monthly_anchor?: number /** @enum {string} */ - readonly weekly_anchor?: - | "friday" - | "monday" - | "saturday" - | "sunday" - | "thursday" - | "tuesday" - | "wednesday"; - }; - readonly statement_descriptor?: string; - }; - }; + readonly weekly_anchor?: 'friday' | 'monday' | 'saturday' | 'sunday' | 'thursday' | 'tuesday' | 'wednesday' + } + readonly statement_descriptor?: string + } + } /** * tos_acceptance_specs * @description Details on the account's acceptance of the [Stripe Services Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance). */ readonly tos_acceptance?: { /** Format: unix-time */ - readonly date?: number; - readonly ip?: string; - readonly service_agreement?: string; - readonly user_agent?: string; - }; - }; - }; - }; - }; + readonly date?: number + readonly ip?: string + readonly service_agreement?: string + readonly user_agent?: string + } + } + } + } + } /** *

With Connect, you can delete accounts you manage.

* @@ -17639,112 +17418,112 @@ export interface operations { readonly DeleteAccountsAccount: { readonly parameters: { readonly path: { - readonly account: string; - }; - }; + readonly account: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["deleted_account"]; - }; - }; + readonly 'application/json': components['schemas']['deleted_account'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Create an external account for a given account.

*/ readonly PostAccountsAccountBankAccounts: { readonly parameters: { readonly path: { - readonly account: string; - }; - }; + readonly account: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["external_account"]; - }; - }; + readonly 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ readonly bank_account?: Partial<{ - readonly account_holder_name?: string; + readonly account_holder_name?: string /** @enum {string} */ - readonly account_holder_type?: "company" | "individual"; - readonly account_number: string; + readonly account_holder_type?: 'company' | 'individual' + readonly account_number: string /** @enum {string} */ - readonly account_type?: "checking" | "futsu" | "savings" | "toza"; - readonly country: string; - readonly currency?: string; + readonly account_type?: 'checking' | 'futsu' | 'savings' | 'toza' + readonly country: string + readonly currency?: string /** @enum {string} */ - readonly object?: "bank_account"; - readonly routing_number?: string; + readonly object?: 'bank_account' + readonly routing_number?: string }> & - Partial; + Partial /** @description When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency. */ - readonly default_for_currency?: boolean; + readonly default_for_currency?: boolean /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - readonly external_account?: string; + readonly external_account?: string /** @description 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`. */ - readonly metadata?: { readonly [key: string]: string }; - }; - }; - }; - }; + readonly metadata?: { readonly [key: string]: string } + } + } + } + } /**

Retrieve a specified external account for a given account.

*/ readonly GetAccountsAccountBankAccountsId: { readonly parameters: { readonly path: { - readonly account: string; - readonly id: string; - }; + readonly account: string + readonly id: string + } readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; + readonly expand?: readonly string[] + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["external_account"]; - }; - }; + readonly 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /** *

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

* @@ -17753,335 +17532,334 @@ export interface operations { readonly PostAccountsAccountBankAccountsId: { readonly parameters: { readonly path: { - readonly account: string; - readonly id: string; - }; - }; + readonly account: string + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["external_account"]; - }; - }; + readonly 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description The name of the person or business that owns the bank account. */ - readonly account_holder_name?: string; + readonly account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - readonly account_holder_type?: "" | "company" | "individual"; + readonly account_holder_type?: '' | 'company' | 'individual' /** * @description The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`. * @enum {string} */ - readonly account_type?: "checking" | "futsu" | "savings" | "toza"; + readonly account_type?: 'checking' | 'futsu' | 'savings' | 'toza' /** @description City/District/Suburb/Town/Village. */ - readonly address_city?: string; + readonly address_city?: string /** @description Billing address country, if provided when creating card. */ - readonly address_country?: string; + readonly address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - readonly address_line1?: string; + readonly address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - readonly address_line2?: string; + readonly address_line2?: string /** @description State/County/Province/Region. */ - readonly address_state?: string; + readonly address_state?: string /** @description ZIP or postal code. */ - readonly address_zip?: string; + readonly address_zip?: string /** @description When set to true, this becomes the default external account for its currency. */ - readonly default_for_currency?: boolean; + readonly default_for_currency?: boolean /** @description Two digit number representing the card’s expiration month. */ - readonly exp_month?: string; + readonly exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - readonly exp_year?: string; + readonly exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description Cardholder name. */ - readonly name?: string; - }; - }; - }; - }; + readonly name?: string + } + } + } + } /**

Delete a specified external account for a given account.

*/ readonly DeleteAccountsAccountBankAccountsId: { readonly parameters: { readonly path: { - readonly account: string; - readonly id: string; - }; - }; + readonly account: string + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["deleted_external_account"]; - }; - }; + readonly 'application/json': components['schemas']['deleted_external_account'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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

*/ readonly GetAccountsAccountCapabilities: { readonly parameters: { readonly path: { - readonly account: string; - }; + readonly account: string + } readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; + readonly expand?: readonly string[] + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["capability"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['capability'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Retrieves information about the specified Account Capability.

*/ readonly GetAccountsAccountCapabilitiesCapability: { readonly parameters: { readonly path: { - readonly account: string; - readonly capability: string; - }; + readonly account: string + readonly capability: string + } readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; + readonly expand?: readonly string[] + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["capability"]; - }; - }; + readonly 'application/json': components['schemas']['capability'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Updates an existing Account Capability.

*/ readonly PostAccountsAccountCapabilitiesCapability: { readonly parameters: { readonly path: { - readonly account: string; - readonly capability: string; - }; - }; + readonly account: string + readonly capability: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["capability"]; - }; - }; + readonly 'application/json': components['schemas']['capability'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. */ - readonly requested?: boolean; - }; - }; - }; - }; + readonly requested?: boolean + } + } + } + } /**

List external accounts for an account.

*/ readonly GetAccountsAccountExternalAccounts: { readonly parameters: { readonly path: { - readonly account: string; - }; + readonly account: string + } readonly query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards. */ - readonly data: readonly (Partial & - Partial)[]; + readonly data: readonly (Partial & Partial)[] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Create an external account for a given account.

*/ readonly PostAccountsAccountExternalAccounts: { readonly parameters: { readonly path: { - readonly account: string; - }; - }; + readonly account: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["external_account"]; - }; - }; + readonly 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ readonly bank_account?: Partial<{ - readonly account_holder_name?: string; + readonly account_holder_name?: string /** @enum {string} */ - readonly account_holder_type?: "company" | "individual"; - readonly account_number: string; + readonly account_holder_type?: 'company' | 'individual' + readonly account_number: string /** @enum {string} */ - readonly account_type?: "checking" | "futsu" | "savings" | "toza"; - readonly country: string; - readonly currency?: string; + readonly account_type?: 'checking' | 'futsu' | 'savings' | 'toza' + readonly country: string + readonly currency?: string /** @enum {string} */ - readonly object?: "bank_account"; - readonly routing_number?: string; + readonly object?: 'bank_account' + readonly routing_number?: string }> & - Partial; + Partial /** @description When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency. */ - readonly default_for_currency?: boolean; + readonly default_for_currency?: boolean /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - readonly external_account?: string; + readonly external_account?: string /** @description 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`. */ - readonly metadata?: { readonly [key: string]: string }; - }; - }; - }; - }; + readonly metadata?: { readonly [key: string]: string } + } + } + } + } /**

Retrieve a specified external account for a given account.

*/ readonly GetAccountsAccountExternalAccountsId: { readonly parameters: { readonly path: { - readonly account: string; - readonly id: string; - }; + readonly account: string + readonly id: string + } readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; + readonly expand?: readonly string[] + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["external_account"]; - }; - }; + readonly 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /** *

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

* @@ -18090,95 +17868,95 @@ export interface operations { readonly PostAccountsAccountExternalAccountsId: { readonly parameters: { readonly path: { - readonly account: string; - readonly id: string; - }; - }; + readonly account: string + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["external_account"]; - }; - }; + readonly 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description The name of the person or business that owns the bank account. */ - readonly account_holder_name?: string; + readonly account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - readonly account_holder_type?: "" | "company" | "individual"; + readonly account_holder_type?: '' | 'company' | 'individual' /** * @description The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`. * @enum {string} */ - readonly account_type?: "checking" | "futsu" | "savings" | "toza"; + readonly account_type?: 'checking' | 'futsu' | 'savings' | 'toza' /** @description City/District/Suburb/Town/Village. */ - readonly address_city?: string; + readonly address_city?: string /** @description Billing address country, if provided when creating card. */ - readonly address_country?: string; + readonly address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - readonly address_line1?: string; + readonly address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - readonly address_line2?: string; + readonly address_line2?: string /** @description State/County/Province/Region. */ - readonly address_state?: string; + readonly address_state?: string /** @description ZIP or postal code. */ - readonly address_zip?: string; + readonly address_zip?: string /** @description When set to true, this becomes the default external account for its currency. */ - readonly default_for_currency?: boolean; + readonly default_for_currency?: boolean /** @description Two digit number representing the card’s expiration month. */ - readonly exp_month?: string; + readonly exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - readonly exp_year?: string; + readonly exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description Cardholder name. */ - readonly name?: string; - }; - }; - }; - }; + readonly name?: string + } + } + } + } /**

Delete a specified external account for a given account.

*/ readonly DeleteAccountsAccountExternalAccountsId: { readonly parameters: { readonly path: { - readonly account: string; - readonly id: string; - }; - }; + readonly account: string + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["deleted_external_account"]; - }; - }; + readonly 'application/json': components['schemas']['deleted_external_account'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /** *

Creates a single-use login link for an Express account to access their Stripe dashboard.

* @@ -18187,158 +17965,158 @@ export interface operations { readonly PostAccountsAccountLoginLinks: { readonly parameters: { readonly path: { - readonly account: string; - }; - }; + readonly account: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["login_link"]; - }; - }; + readonly 'application/json': components['schemas']['login_link'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description Where to redirect the user after they log out of their dashboard. */ - readonly redirect_url?: string; - }; - }; - }; - }; + readonly redirect_url?: string + } + } + } + } /**

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.

*/ readonly GetAccountsAccountPeople: { readonly parameters: { readonly path: { - readonly account: string; - }; + readonly account: string + } readonly query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** Filters on the list of people returned based on the person's relationship to the account's company. */ readonly relationship?: { - readonly director?: boolean; - readonly executive?: boolean; - readonly owner?: boolean; - readonly representative?: boolean; - }; + readonly director?: boolean + readonly executive?: boolean + readonly owner?: boolean + readonly representative?: boolean + } /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["person"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['person'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Creates a new person.

*/ readonly PostAccountsAccountPeople: { readonly parameters: { readonly path: { - readonly account: string; - }; - }; + readonly account: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["person"]; - }; - }; + readonly 'application/json': components['schemas']['person'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** * address_specs * @description The person's address. */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ readonly address_kana?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ readonly address_kanji?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** @description The person's date of birth. */ readonly dob?: Partial<{ - readonly day: number; - readonly month: number; - readonly year: number; + readonly day: number + readonly month: number + readonly year: number }> & - Partial<"">; + Partial<''> /** * person_documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -18346,65 +18124,65 @@ export interface operations { readonly documents?: { /** documents_param */ readonly company_authorization?: { - readonly files?: readonly string[]; - }; + readonly files?: readonly string[] + } /** documents_param */ readonly passport?: { - readonly files?: readonly string[]; - }; + readonly files?: readonly string[] + } /** documents_param */ readonly visa?: { - readonly files?: readonly string[]; - }; - }; + readonly files?: readonly string[] + } + } /** @description The person's email address. */ - readonly email?: string; + readonly email?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The person's first name. */ - readonly first_name?: string; + readonly first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - readonly first_name_kana?: string; + readonly first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - readonly first_name_kanji?: string; + readonly first_name_kanji?: string /** @description A list of alternate names or aliases that the person is known by. */ - readonly full_name_aliases?: Partial & Partial<"">; + readonly full_name_aliases?: Partial & Partial<''> /** @description The person's gender (International regulations require either "male" or "female"). */ - readonly gender?: string; + readonly gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ - readonly id_number?: string; + readonly id_number?: string /** @description The person's last name. */ - readonly last_name?: string; + readonly last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - readonly last_name_kana?: string; + readonly last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - readonly last_name_kanji?: string; + readonly last_name_kanji?: string /** @description The person's maiden name. */ - readonly maiden_name?: string; + readonly maiden_name?: string /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ - readonly nationality?: string; + readonly nationality?: string /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - readonly person_token?: string; + readonly person_token?: string /** @description The person's phone number. */ - readonly phone?: string; + readonly phone?: string /** @description 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. */ - readonly political_exposure?: string; + readonly political_exposure?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ readonly relationship?: { - readonly director?: boolean; - readonly executive?: boolean; - readonly owner?: boolean; - readonly percent_ownership?: Partial & Partial<"">; - readonly representative?: boolean; - readonly title?: string; - }; + readonly director?: boolean + readonly executive?: boolean + readonly owner?: boolean + readonly percent_ownership?: Partial & Partial<''> + readonly representative?: boolean + readonly title?: string + } /** @description The last four digits of the person's Social Security number (U.S. only). */ - readonly ssn_last_4?: string; + readonly ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -18412,121 +18190,121 @@ export interface operations { readonly verification?: { /** person_verification_document_specs */ readonly additional_document?: { - readonly back?: string; - readonly front?: string; - }; + readonly back?: string + readonly front?: string + } /** person_verification_document_specs */ readonly document?: { - readonly back?: string; - readonly front?: string; - }; - }; - }; - }; - }; - }; + readonly back?: string + readonly front?: string + } + } + } + } + } + } /**

Retrieves an existing person.

*/ readonly GetAccountsAccountPeoplePerson: { readonly parameters: { readonly path: { - readonly account: string; - readonly person: string; - }; + readonly account: string + readonly person: string + } readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; + readonly expand?: readonly string[] + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["person"]; - }; - }; + readonly 'application/json': components['schemas']['person'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Updates an existing person.

*/ readonly PostAccountsAccountPeoplePerson: { readonly parameters: { readonly path: { - readonly account: string; - readonly person: string; - }; - }; + readonly account: string + readonly person: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["person"]; - }; - }; + readonly 'application/json': components['schemas']['person'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** * address_specs * @description The person's address. */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ readonly address_kana?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ readonly address_kanji?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** @description The person's date of birth. */ readonly dob?: Partial<{ - readonly day: number; - readonly month: number; - readonly year: number; + readonly day: number + readonly month: number + readonly year: number }> & - Partial<"">; + Partial<''> /** * person_documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -18534,65 +18312,65 @@ export interface operations { readonly documents?: { /** documents_param */ readonly company_authorization?: { - readonly files?: readonly string[]; - }; + readonly files?: readonly string[] + } /** documents_param */ readonly passport?: { - readonly files?: readonly string[]; - }; + readonly files?: readonly string[] + } /** documents_param */ readonly visa?: { - readonly files?: readonly string[]; - }; - }; + readonly files?: readonly string[] + } + } /** @description The person's email address. */ - readonly email?: string; + readonly email?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The person's first name. */ - readonly first_name?: string; + readonly first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - readonly first_name_kana?: string; + readonly first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - readonly first_name_kanji?: string; + readonly first_name_kanji?: string /** @description A list of alternate names or aliases that the person is known by. */ - readonly full_name_aliases?: Partial & Partial<"">; + readonly full_name_aliases?: Partial & Partial<''> /** @description The person's gender (International regulations require either "male" or "female"). */ - readonly gender?: string; + readonly gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ - readonly id_number?: string; + readonly id_number?: string /** @description The person's last name. */ - readonly last_name?: string; + readonly last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - readonly last_name_kana?: string; + readonly last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - readonly last_name_kanji?: string; + readonly last_name_kanji?: string /** @description The person's maiden name. */ - readonly maiden_name?: string; + readonly maiden_name?: string /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ - readonly nationality?: string; + readonly nationality?: string /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - readonly person_token?: string; + readonly person_token?: string /** @description The person's phone number. */ - readonly phone?: string; + readonly phone?: string /** @description 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. */ - readonly political_exposure?: string; + readonly political_exposure?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ readonly relationship?: { - readonly director?: boolean; - readonly executive?: boolean; - readonly owner?: boolean; - readonly percent_ownership?: Partial & Partial<"">; - readonly representative?: boolean; - readonly title?: string; - }; + readonly director?: boolean + readonly executive?: boolean + readonly owner?: boolean + readonly percent_ownership?: Partial & Partial<''> + readonly representative?: boolean + readonly title?: string + } /** @description The last four digits of the person's Social Security number (U.S. only). */ - readonly ssn_last_4?: string; + readonly ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -18600,171 +18378,171 @@ export interface operations { readonly verification?: { /** person_verification_document_specs */ readonly additional_document?: { - readonly back?: string; - readonly front?: string; - }; + readonly back?: string + readonly front?: string + } /** person_verification_document_specs */ readonly document?: { - readonly back?: string; - readonly front?: string; - }; - }; - }; - }; - }; - }; + readonly back?: string + readonly front?: string + } + } + } + } + } + } /**

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.

*/ readonly DeleteAccountsAccountPeoplePerson: { readonly parameters: { readonly path: { - readonly account: string; - readonly person: string; - }; - }; + readonly account: string + readonly person: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["deleted_person"]; - }; - }; + readonly 'application/json': components['schemas']['deleted_person'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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.

*/ readonly GetAccountsAccountPersons: { readonly parameters: { readonly path: { - readonly account: string; - }; + readonly account: string + } readonly query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** Filters on the list of people returned based on the person's relationship to the account's company. */ readonly relationship?: { - readonly director?: boolean; - readonly executive?: boolean; - readonly owner?: boolean; - readonly representative?: boolean; - }; + readonly director?: boolean + readonly executive?: boolean + readonly owner?: boolean + readonly representative?: boolean + } /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["person"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['person'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Creates a new person.

*/ readonly PostAccountsAccountPersons: { readonly parameters: { readonly path: { - readonly account: string; - }; - }; + readonly account: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["person"]; - }; - }; + readonly 'application/json': components['schemas']['person'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** * address_specs * @description The person's address. */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ readonly address_kana?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ readonly address_kanji?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** @description The person's date of birth. */ readonly dob?: Partial<{ - readonly day: number; - readonly month: number; - readonly year: number; + readonly day: number + readonly month: number + readonly year: number }> & - Partial<"">; + Partial<''> /** * person_documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -18772,65 +18550,65 @@ export interface operations { readonly documents?: { /** documents_param */ readonly company_authorization?: { - readonly files?: readonly string[]; - }; + readonly files?: readonly string[] + } /** documents_param */ readonly passport?: { - readonly files?: readonly string[]; - }; + readonly files?: readonly string[] + } /** documents_param */ readonly visa?: { - readonly files?: readonly string[]; - }; - }; + readonly files?: readonly string[] + } + } /** @description The person's email address. */ - readonly email?: string; + readonly email?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The person's first name. */ - readonly first_name?: string; + readonly first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - readonly first_name_kana?: string; + readonly first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - readonly first_name_kanji?: string; + readonly first_name_kanji?: string /** @description A list of alternate names or aliases that the person is known by. */ - readonly full_name_aliases?: Partial & Partial<"">; + readonly full_name_aliases?: Partial & Partial<''> /** @description The person's gender (International regulations require either "male" or "female"). */ - readonly gender?: string; + readonly gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ - readonly id_number?: string; + readonly id_number?: string /** @description The person's last name. */ - readonly last_name?: string; + readonly last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - readonly last_name_kana?: string; + readonly last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - readonly last_name_kanji?: string; + readonly last_name_kanji?: string /** @description The person's maiden name. */ - readonly maiden_name?: string; + readonly maiden_name?: string /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ - readonly nationality?: string; + readonly nationality?: string /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - readonly person_token?: string; + readonly person_token?: string /** @description The person's phone number. */ - readonly phone?: string; + readonly phone?: string /** @description 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. */ - readonly political_exposure?: string; + readonly political_exposure?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ readonly relationship?: { - readonly director?: boolean; - readonly executive?: boolean; - readonly owner?: boolean; - readonly percent_ownership?: Partial & Partial<"">; - readonly representative?: boolean; - readonly title?: string; - }; + readonly director?: boolean + readonly executive?: boolean + readonly owner?: boolean + readonly percent_ownership?: Partial & Partial<''> + readonly representative?: boolean + readonly title?: string + } /** @description The last four digits of the person's Social Security number (U.S. only). */ - readonly ssn_last_4?: string; + readonly ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -18838,121 +18616,121 @@ export interface operations { readonly verification?: { /** person_verification_document_specs */ readonly additional_document?: { - readonly back?: string; - readonly front?: string; - }; + readonly back?: string + readonly front?: string + } /** person_verification_document_specs */ readonly document?: { - readonly back?: string; - readonly front?: string; - }; - }; - }; - }; - }; - }; + readonly back?: string + readonly front?: string + } + } + } + } + } + } /**

Retrieves an existing person.

*/ readonly GetAccountsAccountPersonsPerson: { readonly parameters: { readonly path: { - readonly account: string; - readonly person: string; - }; + readonly account: string + readonly person: string + } readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; + readonly expand?: readonly string[] + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["person"]; - }; - }; + readonly 'application/json': components['schemas']['person'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Updates an existing person.

*/ readonly PostAccountsAccountPersonsPerson: { readonly parameters: { readonly path: { - readonly account: string; - readonly person: string; - }; - }; + readonly account: string + readonly person: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["person"]; - }; - }; + readonly 'application/json': components['schemas']['person'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** * address_specs * @description The person's address. */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ readonly address_kana?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ readonly address_kanji?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** @description The person's date of birth. */ readonly dob?: Partial<{ - readonly day: number; - readonly month: number; - readonly year: number; + readonly day: number + readonly month: number + readonly year: number }> & - Partial<"">; + Partial<''> /** * person_documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -18960,65 +18738,65 @@ export interface operations { readonly documents?: { /** documents_param */ readonly company_authorization?: { - readonly files?: readonly string[]; - }; + readonly files?: readonly string[] + } /** documents_param */ readonly passport?: { - readonly files?: readonly string[]; - }; + readonly files?: readonly string[] + } /** documents_param */ readonly visa?: { - readonly files?: readonly string[]; - }; - }; + readonly files?: readonly string[] + } + } /** @description The person's email address. */ - readonly email?: string; + readonly email?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The person's first name. */ - readonly first_name?: string; + readonly first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - readonly first_name_kana?: string; + readonly first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - readonly first_name_kanji?: string; + readonly first_name_kanji?: string /** @description A list of alternate names or aliases that the person is known by. */ - readonly full_name_aliases?: Partial & Partial<"">; + readonly full_name_aliases?: Partial & Partial<''> /** @description The person's gender (International regulations require either "male" or "female"). */ - readonly gender?: string; + readonly gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ - readonly id_number?: string; + readonly id_number?: string /** @description The person's last name. */ - readonly last_name?: string; + readonly last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - readonly last_name_kana?: string; + readonly last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - readonly last_name_kanji?: string; + readonly last_name_kanji?: string /** @description The person's maiden name. */ - readonly maiden_name?: string; + readonly maiden_name?: string /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ - readonly nationality?: string; + readonly nationality?: string /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - readonly person_token?: string; + readonly person_token?: string /** @description The person's phone number. */ - readonly phone?: string; + readonly phone?: string /** @description 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. */ - readonly political_exposure?: string; + readonly political_exposure?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ readonly relationship?: { - readonly director?: boolean; - readonly executive?: boolean; - readonly owner?: boolean; - readonly percent_ownership?: Partial & Partial<"">; - readonly representative?: boolean; - readonly title?: string; - }; + readonly director?: boolean + readonly executive?: boolean + readonly owner?: boolean + readonly percent_ownership?: Partial & Partial<''> + readonly representative?: boolean + readonly title?: string + } /** @description The last four digits of the person's Social Security number (U.S. only). */ - readonly ssn_last_4?: string; + readonly ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -19026,47 +18804,47 @@ export interface operations { readonly verification?: { /** person_verification_document_specs */ readonly additional_document?: { - readonly back?: string; - readonly front?: string; - }; + readonly back?: string + readonly front?: string + } /** person_verification_document_specs */ readonly document?: { - readonly back?: string; - readonly front?: string; - }; - }; - }; - }; - }; - }; + readonly back?: string + readonly front?: string + } + } + } + } + } + } /**

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.

*/ readonly DeleteAccountsAccountPersonsPerson: { readonly parameters: { readonly path: { - readonly account: string; - readonly person: string; - }; - }; + readonly account: string + readonly person: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["deleted_person"]; - }; - }; + readonly 'application/json': components['schemas']['deleted_person'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /** *

With Connect, you may flag accounts as suspicious.

* @@ -19075,250 +18853,250 @@ export interface operations { readonly PostAccountsAccountReject: { readonly parameters: { readonly path: { - readonly account: string; - }; - }; + readonly account: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["account"]; - }; - }; + readonly 'application/json': components['schemas']['account'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The reason for rejecting the account. Can be `fraud`, `terms_of_service`, or `other`. */ - readonly reason: string; - }; - }; - }; - }; + readonly reason: string + } + } + } + } /**

List apple pay domains.

*/ readonly GetApplePayDomains: { readonly parameters: { readonly query: { - readonly domain_name?: string; + readonly domain_name?: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["apple_pay_domain"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['apple_pay_domain'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Create an apple pay domain.

*/ readonly PostApplePayDomains: { readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["apple_pay_domain"]; - }; - }; + readonly 'application/json': components['schemas']['apple_pay_domain'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { - readonly domain_name: string; + readonly 'application/x-www-form-urlencoded': { + readonly domain_name: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } + } /**

Retrieve an apple pay domain.

*/ readonly GetApplePayDomainsDomain: { readonly parameters: { readonly path: { - readonly domain: string; - }; + readonly domain: string + } readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; + readonly expand?: readonly string[] + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["apple_pay_domain"]; - }; - }; + readonly 'application/json': components['schemas']['apple_pay_domain'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Delete an apple pay domain.

*/ readonly DeleteApplePayDomainsDomain: { readonly parameters: { readonly path: { - readonly domain: string; - }; - }; + readonly domain: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["deleted_apple_pay_domain"]; - }; - }; + readonly 'application/json': components['schemas']['deleted_apple_pay_domain'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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.

*/ readonly GetApplicationFees: { readonly parameters: { readonly query: { /** Only return application fees for the charge specified by this charge ID. */ - readonly charge?: string; + readonly charge?: string readonly created?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["application_fee"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['application_fee'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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.

*/ readonly GetApplicationFeesFeeRefundsId: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly fee: string; - readonly id: string; - }; - }; + readonly fee: string + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["fee_refund"]; - }; - }; + readonly 'application/json': components['schemas']['fee_refund'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /** *

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

* @@ -19327,146 +19105,146 @@ export interface operations { readonly PostApplicationFeesFeeRefundsId: { readonly parameters: { readonly path: { - readonly fee: string; - readonly id: string; - }; - }; + readonly fee: string + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["fee_refund"]; - }; - }; + readonly 'application/json': components['schemas']['fee_refund'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> + } + } + } + } /**

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

*/ readonly GetApplicationFeesId: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["application_fee"]; - }; - }; + readonly 'application/json': components['schemas']['application_fee'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } readonly PostApplicationFeesIdRefund: { readonly parameters: { readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["application_fee"]; - }; - }; + readonly 'application/json': components['schemas']['application_fee'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { - readonly amount?: number; - readonly directive?: string; + readonly 'application/x-www-form-urlencoded': { + readonly amount?: number + readonly directive?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } + } /**

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.

*/ readonly GetApplicationFeesIdRefunds: { readonly parameters: { readonly query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; + readonly starting_after?: string + } readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Details about each object. */ - readonly data: readonly components["schemas"]["fee_refund"][]; + readonly data: readonly components['schemas']['fee_refund'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /** *

Refunds an application fee that has previously been collected but not yet refunded. * Funds will be refunded to the Stripe account from which the fee was originally collected.

@@ -19481,36 +19259,36 @@ export interface operations { readonly PostApplicationFeesIdRefunds: { readonly parameters: { readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["fee_refund"]; - }; - }; + readonly 'application/json': components['schemas']['fee_refund'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description A positive integer, in _%s_, representing how much of this fee to refund. Can refund only up to the remaining unrefunded amount of the fee. */ - readonly amount?: number; + readonly amount?: number /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: { readonly [key: string]: string }; - }; - }; - }; - }; + readonly metadata?: { readonly [key: string]: string } + } + } + } + } /** *

Retrieves the current account balance, based on the authentication that was used to make the request. * For a sample request, see Accounting for negative balances.

@@ -19519,29 +19297,29 @@ export interface operations { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; + readonly expand?: readonly string[] + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["balance"]; - }; - }; + readonly 'application/json': components['schemas']['balance'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /** *

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

* @@ -19551,61 +19329,61 @@ export interface operations { readonly parameters: { readonly query: { readonly created?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** 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). */ - readonly currency?: string; + readonly currency?: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID. */ - readonly payout?: string; + readonly payout?: string /** Only returns the original transaction. */ - readonly source?: string; + readonly source?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `payment`, `payment_failure_refund`, `payment_refund`, `payout`, `payout_cancel`, `payout_failure`, `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`. */ - readonly type?: string; - }; - }; + readonly type?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["balance_transaction"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['balance_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /** *

Retrieves the balance transaction with the given ID.

* @@ -19615,32 +19393,32 @@ export interface operations { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["balance_transaction"]; - }; - }; + readonly 'application/json': components['schemas']['balance_transaction'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /** *

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

* @@ -19650,61 +19428,61 @@ export interface operations { readonly parameters: { readonly query: { readonly created?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** 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). */ - readonly currency?: string; + readonly currency?: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID. */ - readonly payout?: string; + readonly payout?: string /** Only returns the original transaction. */ - readonly source?: string; + readonly source?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `payment`, `payment_failure_refund`, `payment_refund`, `payout`, `payout_cancel`, `payout_failure`, `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`. */ - readonly type?: string; - }; - }; + readonly type?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["balance_transaction"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['balance_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /** *

Retrieves the balance transaction with the given ID.

* @@ -19714,113 +19492,113 @@ export interface operations { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["balance_transaction"]; - }; - }; + readonly 'application/json': components['schemas']['balance_transaction'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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

*/ readonly GetBillingPortalConfigurations: { readonly parameters: { readonly query: { /** Only return configurations that are active or inactive (e.g., pass `true` to only list active configurations). */ - readonly active?: boolean; + readonly active?: boolean /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** Only return the default or non-default configurations (e.g., pass `true` to only list the default configuration). */ - readonly is_default?: boolean; + readonly is_default?: boolean /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["billing_portal.configuration"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['billing_portal.configuration'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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

*/ readonly PostBillingPortalConfigurations: { readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["billing_portal.configuration"]; - }; - }; + readonly 'application/json': components['schemas']['billing_portal.configuration'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** * business_profile_create_param * @description The business information shown to customers in the portal. */ readonly business_profile: { - readonly headline?: string; - readonly privacy_policy_url: string; - readonly terms_of_service_url: string; - }; + readonly headline?: string + readonly privacy_policy_url: string + readonly terms_of_service_url: string + } /** @description 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. */ - readonly default_return_url?: Partial & Partial<"">; + readonly default_return_url?: Partial & Partial<''> /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** * features_creation_param * @description Information about the features available in the portal. @@ -19828,139 +19606,137 @@ export interface operations { readonly features: { /** customer_update_creation_param */ readonly customer_update?: { - readonly allowed_updates: Partial & - Partial<"">; - readonly enabled: boolean; - }; + readonly allowed_updates: Partial & Partial<''> + readonly enabled: boolean + } /** invoice_list_param */ readonly invoice_history?: { - readonly enabled: boolean; - }; + readonly enabled: boolean + } /** payment_method_update_param */ readonly payment_method_update?: { - readonly enabled: boolean; - }; + readonly enabled: boolean + } /** subscription_cancel_creation_param */ readonly subscription_cancel?: { /** subscription_cancellation_reason_creation_param */ readonly cancellation_reason?: { - readonly enabled: boolean; + readonly enabled: boolean readonly options: Partial< readonly ( - | "customer_service" - | "low_quality" - | "missing_features" - | "other" - | "switched_service" - | "too_complex" - | "too_expensive" - | "unused" + | 'customer_service' + | 'low_quality' + | 'missing_features' + | 'other' + | 'switched_service' + | 'too_complex' + | 'too_expensive' + | 'unused' )[] > & - Partial<"">; - }; - readonly enabled: boolean; + Partial<''> + } + readonly enabled: boolean /** @enum {string} */ - readonly mode?: "at_period_end" | "immediately"; + readonly mode?: 'at_period_end' | 'immediately' /** @enum {string} */ - readonly proration_behavior?: "always_invoice" | "create_prorations" | "none"; - }; + readonly proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' + } /** subscription_pause_param */ readonly subscription_pause?: { - readonly enabled?: boolean; - }; + readonly enabled?: boolean + } /** subscription_update_creation_param */ readonly subscription_update?: { - readonly default_allowed_updates: Partial & - Partial<"">; - readonly enabled: boolean; + readonly default_allowed_updates: Partial & Partial<''> + readonly enabled: boolean readonly products: Partial< readonly { - readonly prices: readonly string[]; - readonly product: string; + readonly prices: readonly string[] + readonly product: string }[] > & - Partial<"">; + Partial<''> /** @enum {string} */ - readonly proration_behavior?: "always_invoice" | "create_prorations" | "none"; - }; - }; + readonly proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' + } + } /** @description 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`. */ - readonly metadata?: { readonly [key: string]: string }; - }; - }; - }; - }; + readonly metadata?: { readonly [key: string]: string } + } + } + } + } /**

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

*/ readonly GetBillingPortalConfigurationsConfiguration: { readonly parameters: { readonly path: { - readonly configuration: string; - }; + readonly configuration: string + } readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; + readonly expand?: readonly string[] + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["billing_portal.configuration"]; - }; - }; + readonly 'application/json': components['schemas']['billing_portal.configuration'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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

*/ readonly PostBillingPortalConfigurationsConfiguration: { readonly parameters: { readonly path: { - readonly configuration: string; - }; - }; + readonly configuration: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["billing_portal.configuration"]; - }; - }; + readonly 'application/json': components['schemas']['billing_portal.configuration'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Whether the configuration is active and can be used to create portal sessions. */ - readonly active?: boolean; + readonly active?: boolean /** * business_profile_update_param * @description The business information shown to customers in the portal. */ readonly business_profile?: { - readonly headline?: string; - readonly privacy_policy_url?: string; - readonly terms_of_service_url?: string; - }; + readonly headline?: string + readonly privacy_policy_url?: string + readonly terms_of_service_url?: string + } /** @description 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. */ - readonly default_return_url?: Partial & Partial<"">; + readonly default_return_url?: Partial & Partial<''> /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** * features_updating_param * @description Information about the features available in the portal. @@ -19968,457 +19744,455 @@ export interface operations { readonly features?: { /** customer_update_updating_param */ readonly customer_update?: { - readonly allowed_updates?: Partial & - Partial<"">; - readonly enabled?: boolean; - }; + readonly allowed_updates?: Partial & Partial<''> + readonly enabled?: boolean + } /** invoice_list_param */ readonly invoice_history?: { - readonly enabled: boolean; - }; + readonly enabled: boolean + } /** payment_method_update_param */ readonly payment_method_update?: { - readonly enabled: boolean; - }; + readonly enabled: boolean + } /** subscription_cancel_updating_param */ readonly subscription_cancel?: { /** subscription_cancellation_reason_updating_param */ readonly cancellation_reason?: { - readonly enabled: boolean; + readonly enabled: boolean readonly options?: Partial< readonly ( - | "customer_service" - | "low_quality" - | "missing_features" - | "other" - | "switched_service" - | "too_complex" - | "too_expensive" - | "unused" + | 'customer_service' + | 'low_quality' + | 'missing_features' + | 'other' + | 'switched_service' + | 'too_complex' + | 'too_expensive' + | 'unused' )[] > & - Partial<"">; - }; - readonly enabled?: boolean; + Partial<''> + } + readonly enabled?: boolean /** @enum {string} */ - readonly mode?: "at_period_end" | "immediately"; + readonly mode?: 'at_period_end' | 'immediately' /** @enum {string} */ - readonly proration_behavior?: "always_invoice" | "create_prorations" | "none"; - }; + readonly proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' + } /** subscription_pause_param */ readonly subscription_pause?: { - readonly enabled?: boolean; - }; + readonly enabled?: boolean + } /** subscription_update_updating_param */ readonly subscription_update?: { - readonly default_allowed_updates?: Partial & - Partial<"">; - readonly enabled?: boolean; + readonly default_allowed_updates?: Partial & Partial<''> + readonly enabled?: boolean readonly products?: Partial< readonly { - readonly prices: readonly string[]; - readonly product: string; + readonly prices: readonly string[] + readonly product: string }[] > & - Partial<"">; + Partial<''> /** @enum {string} */ - readonly proration_behavior?: "always_invoice" | "create_prorations" | "none"; - }; - }; + readonly proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' + } + } /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> + } + } + } + } /**

Creates a session of the customer portal.

*/ readonly PostBillingPortalSessions: { readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["billing_portal.session"]; - }; - }; + readonly 'application/json': components['schemas']['billing_portal.session'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description The ID of an existing [configuration](https://stripe.com/docs/api/customer_portal/configuration) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration. */ - readonly configuration?: string; + readonly configuration?: string /** @description The ID of an existing customer. */ - readonly customer: string; + readonly customer: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** * @description 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. * @enum {string} */ readonly locale?: - | "auto" - | "bg" - | "cs" - | "da" - | "de" - | "el" - | "en" - | "en-AU" - | "en-CA" - | "en-GB" - | "en-IE" - | "en-IN" - | "en-NZ" - | "en-SG" - | "es" - | "es-419" - | "et" - | "fi" - | "fil" - | "fr" - | "fr-CA" - | "hr" - | "hu" - | "id" - | "it" - | "ja" - | "ko" - | "lt" - | "lv" - | "ms" - | "mt" - | "nb" - | "nl" - | "pl" - | "pt" - | "pt-BR" - | "ro" - | "ru" - | "sk" - | "sl" - | "sv" - | "th" - | "tr" - | "vi" - | "zh" - | "zh-HK" - | "zh-TW"; + | 'auto' + | 'bg' + | 'cs' + | 'da' + | 'de' + | 'el' + | 'en' + | 'en-AU' + | 'en-CA' + | 'en-GB' + | 'en-IE' + | 'en-IN' + | 'en-NZ' + | 'en-SG' + | 'es' + | 'es-419' + | 'et' + | 'fi' + | 'fil' + | 'fr' + | 'fr-CA' + | 'hr' + | 'hu' + | 'id' + | 'it' + | 'ja' + | 'ko' + | 'lt' + | 'lv' + | 'ms' + | 'mt' + | 'nb' + | 'nl' + | 'pl' + | 'pt' + | 'pt-BR' + | 'ro' + | 'ru' + | 'sk' + | 'sl' + | 'sv' + | 'th' + | 'tr' + | 'vi' + | 'zh' + | 'zh-HK' + | 'zh-TW' /** @description The `on_behalf_of` account to use for this session. 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/charges-transfers#on-behalf-of). 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. */ - readonly on_behalf_of?: string; + readonly on_behalf_of?: string /** @description The default URL to redirect customers to when they click on the portal's link to return to your website. */ - readonly return_url?: string; - }; - }; - }; - }; + readonly return_url?: string + } + } + } + } /**

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

*/ readonly GetBitcoinReceivers: { readonly parameters: { readonly query: { /** Filter for active receivers. */ - readonly active?: boolean; + readonly active?: boolean /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** Filter for filled receivers. */ - readonly filled?: boolean; + readonly filled?: boolean /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** Filter for receivers with uncaptured funds. */ - readonly uncaptured_funds?: boolean; - }; - }; + readonly uncaptured_funds?: boolean + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["bitcoin_receiver"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['bitcoin_receiver'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Retrieves the Bitcoin receiver with the given ID.

*/ readonly GetBitcoinReceiversId: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["bitcoin_receiver"]; - }; - }; + readonly 'application/json': components['schemas']['bitcoin_receiver'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

List bitcoin transacitons for a given receiver.

*/ readonly GetBitcoinReceiversReceiverTransactions: { readonly parameters: { readonly query: { /** Only return transactions for the customer specified by this customer ID. */ - readonly customer?: string; + readonly customer?: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; + readonly starting_after?: string + } readonly path: { - readonly receiver: string; - }; - }; + readonly receiver: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Details about each object. */ - readonly data: readonly components["schemas"]["bitcoin_transaction"][]; + readonly data: readonly components['schemas']['bitcoin_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

List bitcoin transacitons for a given receiver.

*/ readonly GetBitcoinTransactions: { readonly parameters: { readonly query: { /** Only return transactions for the customer specified by this customer ID. */ - readonly customer?: string; + readonly customer?: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; - readonly receiver?: string; + readonly limit?: number + readonly receiver?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Details about each object. */ - readonly data: readonly components["schemas"]["bitcoin_transaction"][]; + readonly data: readonly components['schemas']['bitcoin_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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

*/ readonly GetCharges: { readonly parameters: { readonly query: { readonly created?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** Only return charges for the customer specified by this customer ID. */ - readonly customer?: string; + readonly customer?: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** Only return charges that were created by the PaymentIntent specified by this PaymentIntent ID. */ - readonly payment_intent?: string; + readonly payment_intent?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** Only return charges for this transfer group. */ - readonly transfer_group?: string; - }; - }; + readonly transfer_group?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["charge"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['charge'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

To charge a credit card or other payment source, you create a Charge object. If your API key is in test mode, the supplied payment source (e.g., card) won’t actually be charged, although everything else will occur as if in live mode. (Stripe assumes that the charge would have completed successfully).

*/ readonly PostCharges: { readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["charge"]; - }; - }; + readonly 'application/json': components['schemas']['charge'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description 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). */ - readonly amount?: number; - readonly application_fee?: number; + readonly amount?: number + readonly application_fee?: number /** @description A fee in %s that will be applied to the charge and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the `Stripe-Account` header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees). */ - readonly application_fee_amount?: number; + readonly application_fee_amount?: number /** @description Whether to immediately capture the charge. Defaults to `true`. When `false`, the charge issues an authorization (or pre-authorization), and will need to be [captured](https://stripe.com/docs/api#capture_charge) later. Uncaptured charges expire after a set number of days (7 by default). For more information, see the [authorizing charges and settling later](https://stripe.com/docs/charges/placing-a-hold) documentation. */ - readonly capture?: boolean; + readonly capture?: boolean /** @description A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js). */ readonly card?: Partial<{ - readonly address_city?: string; - readonly address_country?: string; - readonly address_line1?: string; - readonly address_line2?: string; - readonly address_state?: string; - readonly address_zip?: string; - readonly cvc?: string; - readonly exp_month: number; - readonly exp_year: number; - readonly metadata?: { readonly [key: string]: string }; - readonly name?: string; - readonly number: string; + readonly address_city?: string + readonly address_country?: string + readonly address_line1?: string + readonly address_line2?: string + readonly address_state?: string + readonly address_zip?: string + readonly cvc?: string + readonly exp_month: number + readonly exp_year: number + readonly metadata?: { readonly [key: string]: string } + readonly name?: string + readonly number: string /** @enum {string} */ - readonly object?: "card"; + readonly object?: 'card' }> & - Partial; + Partial /** @description 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). */ - readonly currency?: string; + readonly currency?: string /** @description The ID of an existing customer that will be charged in this request. */ - readonly customer?: string; + readonly customer?: string /** @description An arbitrary string which you can attach to a `Charge` object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the `description` of the charge(s) that they are describing. */ - readonly description?: string; + readonly description?: string readonly destination?: Partial<{ - readonly account: string; - readonly amount?: number; + readonly account: string + readonly amount?: number }> & - Partial; + Partial /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description The Stripe account ID for which these funds are intended. Automatically set if you use the `destination` parameter. For details, see [Creating Separate Charges and Transfers](https://stripe.com/docs/connect/charges-transfers#on-behalf-of). */ - readonly on_behalf_of?: string; + readonly on_behalf_of?: string /** @description The email address to which this charge's [receipt](https://stripe.com/docs/dashboard/receipts) will be sent. The receipt will not be sent until the charge is paid, and no receipts will be sent for test mode charges. If this charge is for a [Customer](https://stripe.com/docs/api/customers/object), the email address specified here will override the customer's email address. If `receipt_email` is specified for a charge in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails). */ - readonly receipt_email?: string; + readonly receipt_email?: string /** * optional_fields_shipping * @description Shipping information for the charge. Helps prevent fraud on charges for physical goods. @@ -20426,111 +20200,111 @@ export interface operations { readonly shipping?: { /** optional_fields_address */ readonly address: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; - readonly carrier?: string; - readonly name: string; - readonly phone?: string; - readonly tracking_number?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } + readonly carrier?: string + readonly name: string + readonly phone?: string + readonly tracking_number?: string + } /** @description A payment source to be charged. This can be the ID of a [card](https://stripe.com/docs/api#cards) (i.e., credit or debit card), a [bank account](https://stripe.com/docs/api#bank_accounts), a [source](https://stripe.com/docs/api#sources), a [token](https://stripe.com/docs/api#tokens), or a [connected account](https://stripe.com/docs/connect/account-debits#charging-a-connected-account). For certain sources---namely, [cards](https://stripe.com/docs/api#cards), [bank accounts](https://stripe.com/docs/api#bank_accounts), and attached [sources](https://stripe.com/docs/api#sources)---you must also pass the ID of the associated customer. */ - readonly source?: string; + readonly source?: string /** @description For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - readonly statement_descriptor?: string; + readonly statement_descriptor?: string /** @description Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - readonly statement_descriptor_suffix?: string; + readonly statement_descriptor_suffix?: string /** * transfer_data_specs * @description 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. */ readonly transfer_data?: { - readonly amount?: number; - readonly destination: string; - }; + readonly amount?: number + readonly destination: string + } /** @description A string that identifies this transaction as part of a group. For details, see [Grouping transactions](https://stripe.com/docs/connect/charges-transfers#transfer-options). */ - readonly transfer_group?: string; - }; - }; - }; - }; + readonly transfer_group?: string + } + } + } + } /**

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.

*/ readonly GetChargesCharge: { readonly parameters: { readonly path: { - readonly charge: string; - }; + readonly charge: string + } readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; + readonly expand?: readonly string[] + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["charge"]; - }; - }; + readonly 'application/json': components['schemas']['charge'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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

*/ readonly PostChargesCharge: { readonly parameters: { readonly path: { - readonly charge: string; - }; - }; + readonly charge: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["charge"]; - }; - }; + readonly 'application/json': components['schemas']['charge'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description The ID of an existing customer that will be associated with this request. This field may only be updated if there is no existing associated customer with this charge. */ - readonly customer?: string; + readonly customer?: string /** @description An arbitrary string which you can attach to a charge object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the `description` of the charge(s) that they are describing. */ - readonly description?: string; + readonly description?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** * fraud_details * @description A set of key-value pairs you can attach to a charge giving information about its riskiness. If you believe a charge is fraudulent, include a `user_report` key with a value of `fraudulent`. If you believe a charge is safe, include a `user_report` key with a value of `safe`. Stripe will use the information you send to improve our fraud detection algorithms. */ readonly fraud_details?: { /** @enum {string} */ - readonly user_report: "" | "fraudulent" | "safe"; - }; + readonly user_report: '' | 'fraudulent' | 'safe' + } /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description This is the email address that the receipt for this charge will be sent to. If this field is updated, then a new email receipt will be sent to the updated address. */ - readonly receipt_email?: string; + readonly receipt_email?: string /** * optional_fields_shipping * @description Shipping information for the charge. Helps prevent fraud on charges for physical goods. @@ -20538,24 +20312,24 @@ export interface operations { readonly shipping?: { /** optional_fields_address */ readonly address: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; - readonly carrier?: string; - readonly name: string; - readonly phone?: string; - readonly tracking_number?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } + readonly carrier?: string + readonly name: string + readonly phone?: string + readonly tracking_number?: string + } /** @description A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-options) for details. */ - readonly transfer_group?: string; - }; - }; - }; - }; + readonly transfer_group?: string + } + } + } + } /** *

Capture the payment of an existing, uncaptured, charge. This is the second half of the two-step payment flow, where first you created a charge with the capture option set to false.

* @@ -20564,179 +20338,179 @@ export interface operations { readonly PostChargesChargeCapture: { readonly parameters: { readonly path: { - readonly charge: string; - }; - }; + readonly charge: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["charge"]; - }; - }; + readonly 'application/json': components['schemas']['charge'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description The amount to capture, which must be less than or equal to the original amount. Any additional amount will be automatically refunded. */ - readonly amount?: number; + readonly amount?: number /** @description An application fee to add on to this charge. */ - readonly application_fee?: number; + readonly application_fee?: number /** @description An application fee amount to add on to this charge, which must be less than or equal to the original amount. */ - readonly application_fee_amount?: number; + readonly application_fee_amount?: number /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The email address to send this charge's receipt to. This will override the previously-specified email address for this charge, if one was set. Receipts will not be sent in test mode. */ - readonly receipt_email?: string; + readonly receipt_email?: string /** @description For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - readonly statement_descriptor?: string; + readonly statement_descriptor?: string /** @description Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - readonly statement_descriptor_suffix?: string; + readonly statement_descriptor_suffix?: string /** * transfer_data_specs * @description 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. */ readonly transfer_data?: { - readonly amount?: number; - }; + readonly amount?: number + } /** @description A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-options) for details. */ - readonly transfer_group?: string; - }; - }; - }; - }; + readonly transfer_group?: string + } + } + } + } /**

Retrieve a dispute for a specified charge.

*/ readonly GetChargesChargeDispute: { readonly parameters: { readonly path: { - readonly charge: string; - }; + readonly charge: string + } readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; + readonly expand?: readonly string[] + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["dispute"]; - }; - }; + readonly 'application/json': components['schemas']['dispute'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } readonly PostChargesChargeDispute: { readonly parameters: { readonly path: { - readonly charge: string; - }; - }; + readonly charge: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["dispute"]; - }; - }; + readonly 'application/json': components['schemas']['dispute'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** * dispute_evidence_params * @description Evidence to upload, to respond to a dispute. Updating any field in the hash will submit all fields in the hash for review. The combined character count of all fields is limited to 150,000. */ readonly evidence?: { - readonly access_activity_log?: string; - readonly billing_address?: string; - readonly cancellation_policy?: string; - readonly cancellation_policy_disclosure?: string; - readonly cancellation_rebuttal?: string; - readonly customer_communication?: string; - readonly customer_email_address?: string; - readonly customer_name?: string; - readonly customer_purchase_ip?: string; - readonly customer_signature?: string; - readonly duplicate_charge_documentation?: string; - readonly duplicate_charge_explanation?: string; - readonly duplicate_charge_id?: string; - readonly product_description?: string; - readonly receipt?: string; - readonly refund_policy?: string; - readonly refund_policy_disclosure?: string; - readonly refund_refusal_explanation?: string; - readonly service_date?: string; - readonly service_documentation?: string; - readonly shipping_address?: string; - readonly shipping_carrier?: string; - readonly shipping_date?: string; - readonly shipping_documentation?: string; - readonly shipping_tracking_number?: string; - readonly uncategorized_file?: string; - readonly uncategorized_text?: string; - }; + readonly access_activity_log?: string + readonly billing_address?: string + readonly cancellation_policy?: string + readonly cancellation_policy_disclosure?: string + readonly cancellation_rebuttal?: string + readonly customer_communication?: string + readonly customer_email_address?: string + readonly customer_name?: string + readonly customer_purchase_ip?: string + readonly customer_signature?: string + readonly duplicate_charge_documentation?: string + readonly duplicate_charge_explanation?: string + readonly duplicate_charge_id?: string + readonly product_description?: string + readonly receipt?: string + readonly refund_policy?: string + readonly refund_policy_disclosure?: string + readonly refund_refusal_explanation?: string + readonly service_date?: string + readonly service_documentation?: string + readonly shipping_address?: string + readonly shipping_carrier?: string + readonly shipping_date?: string + readonly shipping_documentation?: string + readonly shipping_tracking_number?: string + readonly uncategorized_file?: string + readonly uncategorized_text?: string + } /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description Whether to immediately submit evidence to the bank. If `false`, evidence is staged on the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank by making another request with this attribute set to `true` (the default). */ - readonly submit?: boolean; - }; - }; - }; - }; + readonly submit?: boolean + } + } + } + } readonly PostChargesChargeDisputeClose: { readonly parameters: { readonly path: { - readonly charge: string; - }; - }; + readonly charge: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["dispute"]; - }; - }; + readonly 'application/json': components['schemas']['dispute'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } + } /** *

When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.

* @@ -20753,259 +20527,259 @@ export interface operations { readonly PostChargesChargeRefund: { readonly parameters: { readonly path: { - readonly charge: string; - }; - }; + readonly charge: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["charge"]; - }; - }; + readonly 'application/json': components['schemas']['charge'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { - readonly amount?: number; + readonly 'application/x-www-form-urlencoded': { + readonly amount?: number /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; - readonly payment_intent?: string; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> + readonly payment_intent?: string /** @enum {string} */ - readonly reason?: "duplicate" | "fraudulent" | "requested_by_customer"; - readonly refund_application_fee?: boolean; - readonly reverse_transfer?: boolean; - }; - }; - }; - }; + readonly reason?: 'duplicate' | 'fraudulent' | 'requested_by_customer' + readonly refund_application_fee?: boolean + readonly reverse_transfer?: boolean + } + } + } + } /**

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.

*/ readonly GetChargesChargeRefunds: { readonly parameters: { readonly path: { - readonly charge: string; - }; + readonly charge: string + } readonly query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Details about each object. */ - readonly data: readonly components["schemas"]["refund"][]; + readonly data: readonly components['schemas']['refund'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Create a refund.

*/ readonly PostChargesChargeRefunds: { readonly parameters: { readonly path: { - readonly charge: string; - }; - }; + readonly charge: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["refund"]; - }; - }; + readonly 'application/json': components['schemas']['refund'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { - readonly amount?: number; + readonly 'application/x-www-form-urlencoded': { + readonly amount?: number /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; - readonly payment_intent?: string; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> + readonly payment_intent?: string /** @enum {string} */ - readonly reason?: "duplicate" | "fraudulent" | "requested_by_customer"; - readonly refund_application_fee?: boolean; - readonly reverse_transfer?: boolean; - }; - }; - }; - }; + readonly reason?: 'duplicate' | 'fraudulent' | 'requested_by_customer' + readonly refund_application_fee?: boolean + readonly reverse_transfer?: boolean + } + } + } + } /**

Retrieves the details of an existing refund.

*/ readonly GetChargesChargeRefundsRefund: { readonly parameters: { readonly path: { - readonly charge: string; - readonly refund: string; - }; + readonly charge: string + readonly refund: string + } readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; + readonly expand?: readonly string[] + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["refund"]; - }; - }; + readonly 'application/json': components['schemas']['refund'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Update a specified refund.

*/ readonly PostChargesChargeRefundsRefund: { readonly parameters: { readonly path: { - readonly charge: string; - readonly refund: string; - }; - }; + readonly charge: string + readonly refund: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["refund"]; - }; - }; + readonly 'application/json': components['schemas']['refund'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + readonly expand?: readonly string[] + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> + } + } + } + } /**

Returns a list of Checkout Sessions.

*/ readonly GetCheckoutSessions: { readonly parameters: { readonly query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** Only return the Checkout Session for the PaymentIntent specified. */ - readonly payment_intent?: string; + readonly payment_intent?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** Only return the Checkout Session for the subscription specified. */ - readonly subscription?: string; - }; - }; + readonly subscription?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["checkout.session"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['checkout.session'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Creates a Session object.

*/ readonly PostCheckoutSessions: { readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["checkout.session"]; - }; - }; + readonly 'application/json': components['schemas']['checkout.session'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** * after_expiration_params * @description Configure actions after a Checkout Session has expired. @@ -21013,40 +20787,40 @@ export interface operations { readonly after_expiration?: { /** recovery_params */ readonly recovery?: { - readonly allow_promotion_codes?: boolean; - readonly enabled: boolean; - }; - }; + readonly allow_promotion_codes?: boolean + readonly enabled: boolean + } + } /** @description Enables user redeemable promotion codes. */ - readonly allow_promotion_codes?: boolean; + readonly allow_promotion_codes?: boolean /** * automatic_tax_params * @description Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions. */ readonly automatic_tax?: { - readonly enabled: boolean; - }; + readonly enabled: boolean + } /** * @description Specify whether Checkout should collect the customer's billing address. * @enum {string} */ - readonly billing_address_collection?: "auto" | "required"; + readonly billing_address_collection?: 'auto' | 'required' /** @description The URL the customer will be directed to if they decide to cancel payment and return to your website. */ - readonly cancel_url: string; + readonly cancel_url: string /** * @description A unique string to reference the Checkout Session. This can be a * customer ID, a cart ID, or similar, and can be used to reconcile the * session with your internal systems. */ - readonly client_reference_id?: string; + readonly client_reference_id?: string /** * consent_collection_params * @description Configure fields for the Checkout Session to gather active consent from customers. */ readonly consent_collection?: { /** @enum {string} */ - readonly promotions?: "auto"; - }; + readonly promotions?: 'auto' + } /** * @description ID of an existing Customer, if one exists. In `payment` mode, the customer’s most recent card * payment method will be used to prefill the email, name, card details, and billing address @@ -21060,7 +20834,7 @@ export interface operations { * * You can set [`payment_intent_data.setup_future_usage`](https://stripe.com/docs/api/checkout/sessions/create#create_checkout_session-payment_intent_data-setup_future_usage) to have Checkout automatically attach the payment method to the Customer you pass in for future reuse. */ - readonly customer?: string; + readonly customer?: string /** * @description Configure whether a Checkout Session creates a [Customer](https://stripe.com/docs/api/customers) during Session confirmation. * @@ -21072,7 +20846,7 @@ export interface operations { * Can only be set in `payment` and `setup` mode. * @enum {string} */ - readonly customer_creation?: "always" | "if_required"; + readonly customer_creation?: 'always' | 'if_required' /** * @description 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. @@ -21080,31 +20854,31 @@ export interface operations { * on file. To access information about the customer once a session is * complete, use the `customer` field. */ - readonly customer_email?: string; + readonly customer_email?: string /** * customer_update_params * @description Controls what fields on Customer can be updated by the Checkout Session. Can only be provided when `customer` is provided. */ readonly customer_update?: { /** @enum {string} */ - readonly address?: "auto" | "never"; + readonly address?: 'auto' | 'never' /** @enum {string} */ - readonly name?: "auto" | "never"; + readonly name?: 'auto' | 'never' /** @enum {string} */ - readonly shipping?: "auto" | "never"; - }; + readonly shipping?: 'auto' | 'never' + } /** @description The coupon or promotion code to apply to this Session. Currently, only up to one may be specified. */ readonly discounts?: readonly { - readonly coupon?: string; - readonly promotion_code?: string; - }[]; + readonly coupon?: string + readonly promotion_code?: string + }[] /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** * Format: unix-time * @description The Epoch time in seconds at which the Checkout Session will expire. It can be anywhere from 1 to 24 hours after Checkout Session creation. By default, this value is 24 hours from creation. */ - readonly expires_at?: number; + readonly expires_at?: number /** * @description A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices). * @@ -21115,132 +20889,132 @@ export interface operations { readonly line_items?: readonly { /** adjustable_quantity_params */ readonly adjustable_quantity?: { - readonly enabled: boolean; - readonly maximum?: number; - readonly minimum?: number; - }; - readonly description?: string; - readonly dynamic_tax_rates?: readonly string[]; - readonly price?: string; + readonly enabled: boolean + readonly maximum?: number + readonly minimum?: number + } + readonly description?: string + readonly dynamic_tax_rates?: readonly string[] + readonly price?: string /** price_data_with_product_data */ readonly price_data?: { - readonly currency: string; - readonly product?: string; + readonly currency: string + readonly product?: string /** product_data */ readonly product_data?: { - readonly description?: string; - readonly images?: readonly string[]; - readonly metadata?: { readonly [key: string]: string }; - readonly name: string; - readonly tax_code?: string; - }; + readonly description?: string + readonly images?: readonly string[] + readonly metadata?: { readonly [key: string]: string } + readonly name: string + readonly tax_code?: string + } /** recurring_adhoc */ readonly recurring?: { /** @enum {string} */ - readonly interval: "day" | "month" | "week" | "year"; - readonly interval_count?: number; - }; + readonly interval: 'day' | 'month' | 'week' | 'year' + readonly interval_count?: number + } /** @enum {string} */ - readonly tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - readonly unit_amount?: number; + readonly tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + readonly unit_amount?: number /** Format: decimal */ - readonly unit_amount_decimal?: string; - }; - readonly quantity?: number; - readonly tax_rates?: readonly string[]; - }[]; + readonly unit_amount_decimal?: string + } + readonly quantity?: number + readonly tax_rates?: readonly string[] + }[] /** * @description The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used. * @enum {string} */ readonly locale?: - | "auto" - | "bg" - | "cs" - | "da" - | "de" - | "el" - | "en" - | "en-GB" - | "es" - | "es-419" - | "et" - | "fi" - | "fil" - | "fr" - | "fr-CA" - | "hr" - | "hu" - | "id" - | "it" - | "ja" - | "ko" - | "lt" - | "lv" - | "ms" - | "mt" - | "nb" - | "nl" - | "pl" - | "pt" - | "pt-BR" - | "ro" - | "ru" - | "sk" - | "sl" - | "sv" - | "th" - | "tr" - | "vi" - | "zh" - | "zh-HK" - | "zh-TW"; + | 'auto' + | 'bg' + | 'cs' + | 'da' + | 'de' + | 'el' + | 'en' + | 'en-GB' + | 'es' + | 'es-419' + | 'et' + | 'fi' + | 'fil' + | 'fr' + | 'fr-CA' + | 'hr' + | 'hu' + | 'id' + | 'it' + | 'ja' + | 'ko' + | 'lt' + | 'lv' + | 'ms' + | 'mt' + | 'nb' + | 'nl' + | 'pl' + | 'pt' + | 'pt-BR' + | 'ro' + | 'ru' + | 'sk' + | 'sl' + | 'sv' + | 'th' + | 'tr' + | 'vi' + | 'zh' + | 'zh-HK' + | 'zh-TW' /** @description 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`. */ - readonly metadata?: { readonly [key: string]: string }; + readonly metadata?: { readonly [key: string]: string } /** * @description The mode of the Checkout Session. Required when using prices or `setup` mode. Pass `subscription` if the Checkout Session includes at least one recurring item. * @enum {string} */ - readonly mode?: "payment" | "setup" | "subscription"; + readonly mode?: 'payment' | 'setup' | 'subscription' /** * payment_intent_data_params * @description A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode. */ readonly payment_intent_data?: { - readonly application_fee_amount?: number; + readonly application_fee_amount?: number /** @enum {string} */ - readonly capture_method?: "automatic" | "manual"; - readonly description?: string; - readonly metadata?: { readonly [key: string]: string }; - readonly on_behalf_of?: string; - readonly receipt_email?: string; + readonly capture_method?: 'automatic' | 'manual' + readonly description?: string + readonly metadata?: { readonly [key: string]: string } + readonly on_behalf_of?: string + readonly receipt_email?: string /** @enum {string} */ - readonly setup_future_usage?: "off_session" | "on_session"; + readonly setup_future_usage?: 'off_session' | 'on_session' /** shipping */ readonly shipping?: { /** address */ readonly address: { - readonly city?: string; - readonly country?: string; - readonly line1: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; - readonly carrier?: string; - readonly name: string; - readonly phone?: string; - readonly tracking_number?: string; - }; - readonly statement_descriptor?: string; - readonly statement_descriptor_suffix?: string; + readonly city?: string + readonly country?: string + readonly line1: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } + readonly carrier?: string + readonly name: string + readonly phone?: string + readonly tracking_number?: string + } + readonly statement_descriptor?: string + readonly statement_descriptor_suffix?: string /** transfer_data_params */ readonly transfer_data?: { - readonly amount?: number; - readonly destination: string; - }; - readonly transfer_group?: string; - }; + readonly amount?: number + readonly destination: string + } + readonly transfer_group?: string + } /** * payment_method_options_param * @description Payment-method-specific configuration. @@ -21249,35 +21023,35 @@ export interface operations { /** payment_method_options_param */ readonly acss_debit?: { /** @enum {string} */ - readonly currency?: "cad" | "usd"; + readonly currency?: 'cad' | 'usd' /** mandate_options_param */ readonly mandate_options?: { - readonly custom_mandate_url?: Partial & Partial<"">; - readonly default_for?: readonly ("invoice" | "subscription")[]; - readonly interval_description?: string; + readonly custom_mandate_url?: Partial & Partial<''> + readonly default_for?: readonly ('invoice' | 'subscription')[] + readonly interval_description?: string /** @enum {string} */ - readonly payment_schedule?: "combined" | "interval" | "sporadic"; + readonly payment_schedule?: 'combined' | 'interval' | 'sporadic' /** @enum {string} */ - readonly transaction_type?: "business" | "personal"; - }; + readonly transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - readonly verification_method?: "automatic" | "instant" | "microdeposits"; - }; + readonly verification_method?: 'automatic' | 'instant' | 'microdeposits' + } /** payment_method_options_param */ readonly boleto?: { - readonly expires_after_days?: number; - }; + readonly expires_after_days?: number + } /** payment_method_options_param */ readonly oxxo?: { - readonly expires_after_days?: number; - }; + readonly expires_after_days?: number + } /** payment_method_options_param */ readonly wechat_pay?: { - readonly app_id?: string; + readonly app_id?: string /** @enum {string} */ - readonly client: "android" | "ios" | "web"; - }; - }; + readonly client: 'android' | 'ios' | 'web' + } + } /** * @description A list of the types of payment methods (e.g., `card`) this Checkout Session can accept. * @@ -21289,26 +21063,26 @@ export interface operations { * other characteristics. */ readonly payment_method_types?: readonly ( - | "acss_debit" - | "afterpay_clearpay" - | "alipay" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "eps" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "klarna" - | "oxxo" - | "p24" - | "sepa_debit" - | "sofort" - | "wechat_pay" - )[]; + | 'acss_debit' + | 'afterpay_clearpay' + | 'alipay' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'eps' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'klarna' + | 'oxxo' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' + )[] /** * phone_number_collection_params * @description Controls phone number collection settings for the session. @@ -21317,265 +21091,265 @@ export interface operations { * before using this feature. Learn more about [collecting phone numbers with Checkout](https://stripe.com/docs/payments/checkout/phone-numbers). */ readonly phone_number_collection?: { - readonly enabled: boolean; - }; + readonly enabled: boolean + } /** * setup_intent_data_param * @description A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in `setup` mode. */ readonly setup_intent_data?: { - readonly description?: string; - readonly metadata?: { readonly [key: string]: string }; - readonly on_behalf_of?: string; - }; + readonly description?: string + readonly metadata?: { readonly [key: string]: string } + readonly on_behalf_of?: string + } /** * shipping_address_collection_params * @description When set, provides configuration for Checkout to collect a shipping address from a customer. */ readonly shipping_address_collection?: { readonly allowed_countries: readonly ( - | "AC" - | "AD" - | "AE" - | "AF" - | "AG" - | "AI" - | "AL" - | "AM" - | "AO" - | "AQ" - | "AR" - | "AT" - | "AU" - | "AW" - | "AX" - | "AZ" - | "BA" - | "BB" - | "BD" - | "BE" - | "BF" - | "BG" - | "BH" - | "BI" - | "BJ" - | "BL" - | "BM" - | "BN" - | "BO" - | "BQ" - | "BR" - | "BS" - | "BT" - | "BV" - | "BW" - | "BY" - | "BZ" - | "CA" - | "CD" - | "CF" - | "CG" - | "CH" - | "CI" - | "CK" - | "CL" - | "CM" - | "CN" - | "CO" - | "CR" - | "CV" - | "CW" - | "CY" - | "CZ" - | "DE" - | "DJ" - | "DK" - | "DM" - | "DO" - | "DZ" - | "EC" - | "EE" - | "EG" - | "EH" - | "ER" - | "ES" - | "ET" - | "FI" - | "FJ" - | "FK" - | "FO" - | "FR" - | "GA" - | "GB" - | "GD" - | "GE" - | "GF" - | "GG" - | "GH" - | "GI" - | "GL" - | "GM" - | "GN" - | "GP" - | "GQ" - | "GR" - | "GS" - | "GT" - | "GU" - | "GW" - | "GY" - | "HK" - | "HN" - | "HR" - | "HT" - | "HU" - | "ID" - | "IE" - | "IL" - | "IM" - | "IN" - | "IO" - | "IQ" - | "IS" - | "IT" - | "JE" - | "JM" - | "JO" - | "JP" - | "KE" - | "KG" - | "KH" - | "KI" - | "KM" - | "KN" - | "KR" - | "KW" - | "KY" - | "KZ" - | "LA" - | "LB" - | "LC" - | "LI" - | "LK" - | "LR" - | "LS" - | "LT" - | "LU" - | "LV" - | "LY" - | "MA" - | "MC" - | "MD" - | "ME" - | "MF" - | "MG" - | "MK" - | "ML" - | "MM" - | "MN" - | "MO" - | "MQ" - | "MR" - | "MS" - | "MT" - | "MU" - | "MV" - | "MW" - | "MX" - | "MY" - | "MZ" - | "NA" - | "NC" - | "NE" - | "NG" - | "NI" - | "NL" - | "NO" - | "NP" - | "NR" - | "NU" - | "NZ" - | "OM" - | "PA" - | "PE" - | "PF" - | "PG" - | "PH" - | "PK" - | "PL" - | "PM" - | "PN" - | "PR" - | "PS" - | "PT" - | "PY" - | "QA" - | "RE" - | "RO" - | "RS" - | "RU" - | "RW" - | "SA" - | "SB" - | "SC" - | "SE" - | "SG" - | "SH" - | "SI" - | "SJ" - | "SK" - | "SL" - | "SM" - | "SN" - | "SO" - | "SR" - | "SS" - | "ST" - | "SV" - | "SX" - | "SZ" - | "TA" - | "TC" - | "TD" - | "TF" - | "TG" - | "TH" - | "TJ" - | "TK" - | "TL" - | "TM" - | "TN" - | "TO" - | "TR" - | "TT" - | "TV" - | "TW" - | "TZ" - | "UA" - | "UG" - | "US" - | "UY" - | "UZ" - | "VA" - | "VC" - | "VE" - | "VG" - | "VN" - | "VU" - | "WF" - | "WS" - | "XK" - | "YE" - | "YT" - | "ZA" - | "ZM" - | "ZW" - | "ZZ" - )[]; - }; + | 'AC' + | 'AD' + | 'AE' + | 'AF' + | 'AG' + | 'AI' + | 'AL' + | 'AM' + | 'AO' + | 'AQ' + | 'AR' + | 'AT' + | 'AU' + | 'AW' + | 'AX' + | 'AZ' + | 'BA' + | 'BB' + | 'BD' + | 'BE' + | 'BF' + | 'BG' + | 'BH' + | 'BI' + | 'BJ' + | 'BL' + | 'BM' + | 'BN' + | 'BO' + | 'BQ' + | 'BR' + | 'BS' + | 'BT' + | 'BV' + | 'BW' + | 'BY' + | 'BZ' + | 'CA' + | 'CD' + | 'CF' + | 'CG' + | 'CH' + | 'CI' + | 'CK' + | 'CL' + | 'CM' + | 'CN' + | 'CO' + | 'CR' + | 'CV' + | 'CW' + | 'CY' + | 'CZ' + | 'DE' + | 'DJ' + | 'DK' + | 'DM' + | 'DO' + | 'DZ' + | 'EC' + | 'EE' + | 'EG' + | 'EH' + | 'ER' + | 'ES' + | 'ET' + | 'FI' + | 'FJ' + | 'FK' + | 'FO' + | 'FR' + | 'GA' + | 'GB' + | 'GD' + | 'GE' + | 'GF' + | 'GG' + | 'GH' + | 'GI' + | 'GL' + | 'GM' + | 'GN' + | 'GP' + | 'GQ' + | 'GR' + | 'GS' + | 'GT' + | 'GU' + | 'GW' + | 'GY' + | 'HK' + | 'HN' + | 'HR' + | 'HT' + | 'HU' + | 'ID' + | 'IE' + | 'IL' + | 'IM' + | 'IN' + | 'IO' + | 'IQ' + | 'IS' + | 'IT' + | 'JE' + | 'JM' + | 'JO' + | 'JP' + | 'KE' + | 'KG' + | 'KH' + | 'KI' + | 'KM' + | 'KN' + | 'KR' + | 'KW' + | 'KY' + | 'KZ' + | 'LA' + | 'LB' + | 'LC' + | 'LI' + | 'LK' + | 'LR' + | 'LS' + | 'LT' + | 'LU' + | 'LV' + | 'LY' + | 'MA' + | 'MC' + | 'MD' + | 'ME' + | 'MF' + | 'MG' + | 'MK' + | 'ML' + | 'MM' + | 'MN' + | 'MO' + | 'MQ' + | 'MR' + | 'MS' + | 'MT' + | 'MU' + | 'MV' + | 'MW' + | 'MX' + | 'MY' + | 'MZ' + | 'NA' + | 'NC' + | 'NE' + | 'NG' + | 'NI' + | 'NL' + | 'NO' + | 'NP' + | 'NR' + | 'NU' + | 'NZ' + | 'OM' + | 'PA' + | 'PE' + | 'PF' + | 'PG' + | 'PH' + | 'PK' + | 'PL' + | 'PM' + | 'PN' + | 'PR' + | 'PS' + | 'PT' + | 'PY' + | 'QA' + | 'RE' + | 'RO' + | 'RS' + | 'RU' + | 'RW' + | 'SA' + | 'SB' + | 'SC' + | 'SE' + | 'SG' + | 'SH' + | 'SI' + | 'SJ' + | 'SK' + | 'SL' + | 'SM' + | 'SN' + | 'SO' + | 'SR' + | 'SS' + | 'ST' + | 'SV' + | 'SX' + | 'SZ' + | 'TA' + | 'TC' + | 'TD' + | 'TF' + | 'TG' + | 'TH' + | 'TJ' + | 'TK' + | 'TL' + | 'TM' + | 'TN' + | 'TO' + | 'TR' + | 'TT' + | 'TV' + | 'TW' + | 'TZ' + | 'UA' + | 'UG' + | 'US' + | 'UY' + | 'UZ' + | 'VA' + | 'VC' + | 'VE' + | 'VG' + | 'VN' + | 'VU' + | 'WF' + | 'WS' + | 'XK' + | 'YE' + | 'YT' + | 'ZA' + | 'ZM' + | 'ZW' + | 'ZZ' + )[] + } /** @description The shipping rate options to apply to this Session. */ readonly shipping_options?: readonly { - readonly shipping_rate?: string; + readonly shipping_rate?: string /** method_params */ readonly shipping_rate_data?: { /** delivery_estimate */ @@ -21583,30 +21357,30 @@ export interface operations { /** delivery_estimate_bound */ readonly maximum?: { /** @enum {string} */ - readonly unit: "business_day" | "day" | "hour" | "month" | "week"; - readonly value: number; - }; + readonly unit: 'business_day' | 'day' | 'hour' | 'month' | 'week' + readonly value: number + } /** delivery_estimate_bound */ readonly minimum?: { /** @enum {string} */ - readonly unit: "business_day" | "day" | "hour" | "month" | "week"; - readonly value: number; - }; - }; - readonly display_name: string; + readonly unit: 'business_day' | 'day' | 'hour' | 'month' | 'week' + readonly value: number + } + } + readonly display_name: string /** fixed_amount */ readonly fixed_amount?: { - readonly amount: number; - readonly currency: string; - }; - readonly metadata?: { readonly [key: string]: string }; + readonly amount: number + readonly currency: string + } + readonly metadata?: { readonly [key: string]: string } /** @enum {string} */ - readonly tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - readonly tax_code?: string; + readonly tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + readonly tax_code?: string /** @enum {string} */ - readonly type?: "fixed_amount"; - }; - }[]; + readonly type?: 'fixed_amount' + } + }[] /** * @description Describes the type of transaction being performed by Checkout in order to customize * relevant text on the page, such as the submit button. `submit_type` can only be @@ -21614,78 +21388,78 @@ export interface operations { * in `subscription` or `setup` mode. * @enum {string} */ - readonly submit_type?: "auto" | "book" | "donate" | "pay"; + readonly submit_type?: 'auto' | 'book' | 'donate' | 'pay' /** * subscription_data_params * @description A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode. */ readonly subscription_data?: { - readonly application_fee_percent?: number; - readonly default_tax_rates?: readonly string[]; + readonly application_fee_percent?: number + readonly default_tax_rates?: readonly string[] readonly items?: readonly { - readonly plan: string; - readonly quantity?: number; - readonly tax_rates?: readonly string[]; - }[]; - readonly metadata?: { readonly [key: string]: string }; + readonly plan: string + readonly quantity?: number + readonly tax_rates?: readonly string[] + }[] + readonly metadata?: { readonly [key: string]: string } /** transfer_data_specs */ readonly transfer_data?: { - readonly amount_percent?: number; - readonly destination: string; - }; + readonly amount_percent?: number + readonly destination: string + } /** Format: unix-time */ - readonly trial_end?: number; - readonly trial_period_days?: number; - }; + readonly trial_end?: number + readonly trial_period_days?: number + } /** * @description The URL to which Stripe should send customers when payment or setup * is complete. * If you’d like to use information from the successful Checkout Session on your page, * read the guide on [customizing your success page](https://stripe.com/docs/payments/checkout/custom-success-page). */ - readonly success_url: string; + readonly success_url: string /** * tax_id_collection_params * @description Controls tax ID collection settings for the session. */ readonly tax_id_collection?: { - readonly enabled: boolean; - }; - }; - }; - }; - }; + readonly enabled: boolean + } + } + } + } + } /**

Retrieves a Session object.

*/ readonly GetCheckoutSessionsSession: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly session: string; - }; - }; + readonly session: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["checkout.session"]; - }; - }; + readonly 'application/json': components['schemas']['checkout.session'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /** *

A Session can be expired when it is in one of these statuses: open

* @@ -21694,210 +21468,210 @@ export interface operations { readonly PostCheckoutSessionsSessionExpire: { readonly parameters: { readonly path: { - readonly session: string; - }; - }; + readonly session: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["checkout.session"]; - }; - }; + readonly 'application/json': components['schemas']['checkout.session'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } + } /**

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.

*/ readonly GetCheckoutSessionsSessionLineItems: { readonly parameters: { readonly query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; + readonly starting_after?: string + } readonly path: { - readonly session: string; - }; - }; + readonly session: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Details about each object. */ - readonly data: readonly components["schemas"]["item"][]; + readonly data: readonly components['schemas']['item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Lists all Country Spec objects available in the API.

*/ readonly GetCountrySpecs: { readonly parameters: { readonly query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["country_spec"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['country_spec'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Returns a Country Spec for a given Country code.

*/ readonly GetCountrySpecsCountry: { readonly parameters: { readonly path: { - readonly country: string; - }; + readonly country: string + } readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; + readonly expand?: readonly string[] + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["country_spec"]; - }; - }; + readonly 'application/json': components['schemas']['country_spec'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Returns a list of your coupons.

*/ readonly GetCoupons: { readonly parameters: { readonly query: { /** 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. */ readonly created?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["coupon"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['coupon'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /** *

You can create coupons easily via the coupon management page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.

* @@ -21908,199 +21682,199 @@ export interface operations { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["coupon"]; - }; - }; + readonly 'application/json': components['schemas']['coupon'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed). */ - readonly amount_off?: number; + readonly amount_off?: number /** * applies_to_params * @description A hash containing directions for what this Coupon will apply discounts to. */ readonly applies_to?: { - readonly products?: readonly string[]; - }; + readonly products?: readonly string[] + } /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed). */ - readonly currency?: string; + readonly currency?: string /** * @description Specifies how long the discount will be in effect if used on a subscription. Can be `forever`, `once`, or `repeating`. Defaults to `once`. * @enum {string} */ - readonly duration?: "forever" | "once" | "repeating"; + readonly duration?: 'forever' | 'once' | 'repeating' /** @description Required only if `duration` is `repeating`, in which case it must be a positive integer that specifies the number of months the discount will be in effect. */ - readonly duration_in_months?: number; + readonly duration_in_months?: number /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description Unique string of your choice that will be used to identify this coupon when applying it to a customer. If you don't want to specify a particular code, you can leave the ID blank and we'll generate a random code for you. */ - readonly id?: string; + readonly id?: string /** @description A positive integer specifying the number of times the coupon can be redeemed before it's no longer valid. For example, you might have a 50% off coupon that the first 20 readers of your blog can use. */ - readonly max_redemptions?: number; + readonly max_redemptions?: number /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set. */ - readonly name?: string; + readonly name?: string /** @description A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if `amount_off` is not passed). */ - readonly percent_off?: number; + readonly percent_off?: number /** * Format: unix-time * @description Unix timestamp specifying the last time at which the coupon can be redeemed. After the redeem_by date, the coupon can no longer be applied to new customers. */ - readonly redeem_by?: number; - }; - }; - }; - }; + readonly redeem_by?: number + } + } + } + } /**

Retrieves the coupon with the given ID.

*/ readonly GetCouponsCoupon: { readonly parameters: { readonly path: { - readonly coupon: string; - }; + readonly coupon: string + } readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; + readonly expand?: readonly string[] + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["coupon"]; - }; - }; + readonly 'application/json': components['schemas']['coupon'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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

*/ readonly PostCouponsCoupon: { readonly parameters: { readonly path: { - readonly coupon: string; - }; - }; + readonly coupon: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["coupon"]; - }; - }; + readonly 'application/json': components['schemas']['coupon'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set. */ - readonly name?: string; - }; - }; - }; - }; + readonly name?: string + } + } + } + } /**

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.

*/ readonly DeleteCouponsCoupon: { readonly parameters: { readonly path: { - readonly coupon: string; - }; - }; + readonly coupon: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["deleted_coupon"]; - }; - }; + readonly 'application/json': components['schemas']['deleted_coupon'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Returns a list of credit notes.

*/ readonly GetCreditNotes: { readonly parameters: { readonly query: { /** Only return credit notes for the customer specified by this customer ID. */ - readonly customer?: string; + readonly customer?: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** Only return credit notes for the invoice specified by this invoice ID. */ - readonly invoice?: string; + readonly invoice?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["credit_note"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['credit_note'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /** *

Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces * its amount_due. For a status=paid invoice, a credit note does not affect its amount_due. Instead, it can result @@ -22122,433 +21896,433 @@ export interface operations { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["credit_note"]; - }; - }; + readonly 'application/json': components['schemas']['credit_note'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description The integer amount in %s representing the total amount of the credit note. */ - readonly amount?: number; + readonly amount?: number /** @description The integer amount in %s representing the amount to credit the customer's balance, which will be automatically applied to their next invoice. */ - readonly credit_amount?: number; + readonly credit_amount?: number /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description ID of the invoice. */ - readonly invoice: string; + readonly invoice: string /** @description Line items that make up the credit note. */ readonly lines?: readonly { - readonly amount?: number; - readonly description?: string; - readonly invoice_line_item?: string; - readonly quantity?: number; - readonly tax_rates?: Partial & Partial<"">; + readonly amount?: number + readonly description?: string + readonly invoice_line_item?: string + readonly quantity?: number + readonly tax_rates?: Partial & Partial<''> /** @enum {string} */ - readonly type: "custom_line_item" | "invoice_line_item"; - readonly unit_amount?: number; + readonly type: 'custom_line_item' | 'invoice_line_item' + readonly unit_amount?: number /** Format: decimal */ - readonly unit_amount_decimal?: string; - }[]; + readonly unit_amount_decimal?: string + }[] /** @description The credit note's memo appears on the credit note PDF. */ - readonly memo?: string; + readonly memo?: string /** @description 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`. */ - readonly metadata?: { readonly [key: string]: string }; + readonly metadata?: { readonly [key: string]: string } /** @description The integer amount in %s representing the amount that is credited outside of Stripe. */ - readonly out_of_band_amount?: number; + readonly out_of_band_amount?: number /** * @description Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` * @enum {string} */ - readonly reason?: "duplicate" | "fraudulent" | "order_change" | "product_unsatisfactory"; + readonly reason?: 'duplicate' | 'fraudulent' | 'order_change' | 'product_unsatisfactory' /** @description ID of an existing refund to link this credit note to. */ - readonly refund?: string; + readonly refund?: string /** @description The integer amount in %s representing the amount to refund. If set, a refund will be created for the charge associated with the invoice. */ - readonly refund_amount?: number; - }; - }; - }; - }; + readonly refund_amount?: number + } + } + } + } /**

Get a preview of a credit note without creating it.

*/ readonly GetCreditNotesPreview: { readonly parameters: { readonly query: { /** The integer amount in %s representing the total amount of the credit note. */ - readonly amount?: number; + readonly amount?: number /** The integer amount in %s representing the amount to credit the customer's balance, which will be automatically applied to their next invoice. */ - readonly credit_amount?: number; + readonly credit_amount?: number /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** ID of the invoice. */ - readonly invoice: string; + readonly invoice: string /** Line items that make up the credit note. */ readonly lines?: readonly { - readonly amount?: number; - readonly description?: string; - readonly invoice_line_item?: string; - readonly quantity?: number; - readonly tax_rates?: Partial & Partial<"">; + readonly amount?: number + readonly description?: string + readonly invoice_line_item?: string + readonly quantity?: number + readonly tax_rates?: Partial & Partial<''> /** @enum {string} */ - readonly type: "custom_line_item" | "invoice_line_item"; - readonly unit_amount?: number; + readonly type: 'custom_line_item' | 'invoice_line_item' + readonly unit_amount?: number /** Format: decimal */ - readonly unit_amount_decimal?: string; - }[]; + readonly unit_amount_decimal?: string + }[] /** The credit note's memo appears on the credit note PDF. */ - readonly memo?: string; + readonly memo?: string /** 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`. */ - readonly metadata?: { readonly [key: string]: string }; + readonly metadata?: { readonly [key: string]: string } /** The integer amount in %s representing the amount that is credited outside of Stripe. */ - readonly out_of_band_amount?: number; + readonly out_of_band_amount?: number /** Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` */ - readonly reason?: "duplicate" | "fraudulent" | "order_change" | "product_unsatisfactory"; + readonly reason?: 'duplicate' | 'fraudulent' | 'order_change' | 'product_unsatisfactory' /** ID of an existing refund to link this credit note to. */ - readonly refund?: string; + readonly refund?: string /** The integer amount in %s representing the amount to refund. If set, a refund will be created for the charge associated with the invoice. */ - readonly refund_amount?: number; - }; - }; + readonly refund_amount?: number + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["credit_note"]; - }; - }; + readonly 'application/json': components['schemas']['credit_note'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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.

*/ readonly GetCreditNotesPreviewLines: { readonly parameters: { readonly query: { /** The integer amount in %s representing the total amount of the credit note. */ - readonly amount?: number; + readonly amount?: number /** The integer amount in %s representing the amount to credit the customer's balance, which will be automatically applied to their next invoice. */ - readonly credit_amount?: number; + readonly credit_amount?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** ID of the invoice. */ - readonly invoice: string; + readonly invoice: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** Line items that make up the credit note. */ readonly lines?: readonly { - readonly amount?: number; - readonly description?: string; - readonly invoice_line_item?: string; - readonly quantity?: number; - readonly tax_rates?: Partial & Partial<"">; + readonly amount?: number + readonly description?: string + readonly invoice_line_item?: string + readonly quantity?: number + readonly tax_rates?: Partial & Partial<''> /** @enum {string} */ - readonly type: "custom_line_item" | "invoice_line_item"; - readonly unit_amount?: number; + readonly type: 'custom_line_item' | 'invoice_line_item' + readonly unit_amount?: number /** Format: decimal */ - readonly unit_amount_decimal?: string; - }[]; + readonly unit_amount_decimal?: string + }[] /** The credit note's memo appears on the credit note PDF. */ - readonly memo?: string; + readonly memo?: string /** 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`. */ - readonly metadata?: { readonly [key: string]: string }; + readonly metadata?: { readonly [key: string]: string } /** The integer amount in %s representing the amount that is credited outside of Stripe. */ - readonly out_of_band_amount?: number; + readonly out_of_band_amount?: number /** Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` */ - readonly reason?: "duplicate" | "fraudulent" | "order_change" | "product_unsatisfactory"; + readonly reason?: 'duplicate' | 'fraudulent' | 'order_change' | 'product_unsatisfactory' /** ID of an existing refund to link this credit note to. */ - readonly refund?: string; + readonly refund?: string /** The integer amount in %s representing the amount to refund. If set, a refund will be created for the charge associated with the invoice. */ - readonly refund_amount?: number; + readonly refund_amount?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Details about each object. */ - readonly data: readonly components["schemas"]["credit_note_line_item"][]; + readonly data: readonly components['schemas']['credit_note_line_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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

*/ readonly GetCreditNotesCreditNoteLines: { readonly parameters: { readonly path: { - readonly credit_note: string; - }; + readonly credit_note: string + } readonly query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Details about each object. */ - readonly data: readonly components["schemas"]["credit_note_line_item"][]; + readonly data: readonly components['schemas']['credit_note_line_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Retrieves the credit note object with the given identifier.

*/ readonly GetCreditNotesId: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["credit_note"]; - }; - }; + readonly 'application/json': components['schemas']['credit_note'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Updates an existing credit note.

*/ readonly PostCreditNotesId: { readonly parameters: { readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["credit_note"]; - }; - }; + readonly 'application/json': components['schemas']['credit_note'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description Credit note memo. */ - readonly memo?: string; + readonly memo?: string /** @description 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`. */ - readonly metadata?: { readonly [key: string]: string }; - }; - }; - }; - }; + readonly metadata?: { readonly [key: string]: string } + } + } + } + } /**

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

*/ readonly PostCreditNotesIdVoid: { readonly parameters: { readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["credit_note"]; - }; - }; + readonly 'application/json': components['schemas']['credit_note'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } + } /**

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

*/ readonly GetCustomers: { readonly parameters: { readonly query: { readonly created?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** A case-sensitive filter on the list based on the customer's `email` field. The value must be a string. */ - readonly email?: string; + readonly email?: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["customer"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['customer'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Creates a new customer object.

*/ readonly PostCustomers: { readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["customer"]; - }; - }; + readonly 'application/json': components['schemas']['customer'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description The customer's address. */ readonly address?: Partial<{ - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string }> & - Partial<"">; + Partial<''> /** @description An integer amount in %s that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice. */ - readonly balance?: number; - readonly coupon?: string; + readonly balance?: number + readonly coupon?: string /** @description An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard. */ - readonly description?: string; + readonly description?: string /** @description Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*. */ - readonly email?: string; + readonly email?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers. */ - readonly invoice_prefix?: string; + readonly invoice_prefix?: string /** * customer_param * @description Default invoice settings for this customer. @@ -22556,139 +22330,138 @@ export interface operations { readonly invoice_settings?: { readonly custom_fields?: Partial< readonly { - readonly name: string; - readonly value: string; + readonly name: string + readonly value: string }[] > & - Partial<"">; - readonly default_payment_method?: string; - readonly footer?: string; - }; + Partial<''> + readonly default_payment_method?: string + readonly footer?: string + } /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description The customer's full name or business name. */ - readonly name?: string; + readonly name?: string /** @description The sequence to be used on the customer's next invoice. Defaults to 1. */ - readonly next_invoice_sequence?: number; - readonly payment_method?: string; + readonly next_invoice_sequence?: number + readonly payment_method?: string /** @description The customer's phone number. */ - readonly phone?: string; + readonly phone?: string /** @description Customer's preferred languages, ordered by preference. */ - readonly preferred_locales?: readonly string[]; + readonly preferred_locales?: readonly string[] /** @description The API ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount. */ - readonly promotion_code?: string; + readonly promotion_code?: string /** @description The customer's shipping information. Appears on invoices emailed to this customer. */ readonly shipping?: Partial<{ /** optional_fields_address */ readonly address: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; - readonly name: string; - readonly phone?: string; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } + readonly name: string + readonly phone?: string }> & - Partial<"">; - readonly source?: string; + Partial<''> + readonly source?: string /** * tax_param * @description Tax details about the customer. */ readonly tax?: { - readonly ip_address?: Partial & Partial<"">; - }; + readonly ip_address?: Partial & Partial<''> + } /** * @description The customer's tax exemption. One of `none`, `exempt`, or `reverse`. * @enum {string} */ - readonly tax_exempt?: "" | "exempt" | "none" | "reverse"; + readonly tax_exempt?: '' | 'exempt' | 'none' | 'reverse' /** @description The customer's tax IDs. */ readonly tax_id_data?: readonly { /** @enum {string} */ readonly type: - | "ae_trn" - | "au_abn" - | "au_arn" - | "br_cnpj" - | "br_cpf" - | "ca_bn" - | "ca_gst_hst" - | "ca_pst_bc" - | "ca_pst_mb" - | "ca_pst_sk" - | "ca_qst" - | "ch_vat" - | "cl_tin" - | "es_cif" - | "eu_vat" - | "gb_vat" - | "ge_vat" - | "hk_br" - | "id_npwp" - | "il_vat" - | "in_gst" - | "is_vat" - | "jp_cn" - | "jp_rn" - | "kr_brn" - | "li_uid" - | "mx_rfc" - | "my_frp" - | "my_itn" - | "my_sst" - | "no_vat" - | "nz_gst" - | "ru_inn" - | "ru_kpp" - | "sa_vat" - | "sg_gst" - | "sg_uen" - | "th_vat" - | "tw_vat" - | "ua_vat" - | "us_ein" - | "za_vat"; - readonly value: string; - }[]; - }; - }; - }; - }; + | 'ae_trn' + | 'au_abn' + | 'au_arn' + | 'br_cnpj' + | 'br_cpf' + | 'ca_bn' + | 'ca_gst_hst' + | 'ca_pst_bc' + | 'ca_pst_mb' + | 'ca_pst_sk' + | 'ca_qst' + | 'ch_vat' + | 'cl_tin' + | 'es_cif' + | 'eu_vat' + | 'gb_vat' + | 'ge_vat' + | 'hk_br' + | 'id_npwp' + | 'il_vat' + | 'in_gst' + | 'is_vat' + | 'jp_cn' + | 'jp_rn' + | 'kr_brn' + | 'li_uid' + | 'mx_rfc' + | 'my_frp' + | 'my_itn' + | 'my_sst' + | 'no_vat' + | 'nz_gst' + | 'ru_inn' + | 'ru_kpp' + | 'sa_vat' + | 'sg_gst' + | 'sg_uen' + | 'th_vat' + | 'tw_vat' + | 'ua_vat' + | 'us_ein' + | 'za_vat' + readonly value: string + }[] + } + } + } + } /**

Retrieves a Customer object.

*/ readonly GetCustomersCustomer: { readonly parameters: { readonly path: { - readonly customer: string; - }; + readonly customer: string + } readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; + readonly expand?: readonly string[] + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": Partial & - Partial; - }; - }; + readonly 'application/json': Partial & Partial + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /** *

Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the source parameter, that becomes the customer’s active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the source parameter: for each of the customer’s current subscriptions, if the subscription bills automatically and is in the past_due state, then the latest open invoice for the subscription with automatic collection enabled will be retried. This retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice. Changing the default_source for a customer will not trigger this behavior.

* @@ -22697,76 +22470,76 @@ export interface operations { readonly PostCustomersCustomer: { readonly parameters: { readonly path: { - readonly customer: string; - }; - }; + readonly customer: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["customer"]; - }; - }; + readonly 'application/json': components['schemas']['customer'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description The customer's address. */ readonly address?: Partial<{ - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string }> & - Partial<"">; + Partial<''> /** @description An integer amount in %s that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice. */ - readonly balance?: number; + readonly balance?: number /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ readonly bank_account?: Partial<{ - readonly account_holder_name?: string; + readonly account_holder_name?: string /** @enum {string} */ - readonly account_holder_type?: "company" | "individual"; - readonly account_number: string; - readonly country: string; - readonly currency?: string; + readonly account_holder_type?: 'company' | 'individual' + readonly account_number: string + readonly country: string + readonly currency?: string /** @enum {string} */ - readonly object?: "bank_account"; - readonly routing_number?: string; + readonly object?: 'bank_account' + readonly routing_number?: string }> & - Partial; + Partial /** @description A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js). */ readonly card?: Partial<{ - readonly address_city?: string; - readonly address_country?: string; - readonly address_line1?: string; - readonly address_line2?: string; - readonly address_state?: string; - readonly address_zip?: string; - readonly cvc?: string; - readonly exp_month: number; - readonly exp_year: number; - readonly metadata?: { readonly [key: string]: string }; - readonly name?: string; - readonly number: string; + readonly address_city?: string + readonly address_country?: string + readonly address_line1?: string + readonly address_line2?: string + readonly address_state?: string + readonly address_zip?: string + readonly cvc?: string + readonly exp_month: number + readonly exp_year: number + readonly metadata?: { readonly [key: string]: string } + readonly name?: string + readonly number: string /** @enum {string} */ - readonly object?: "card"; + readonly object?: 'card' }> & - Partial; - readonly coupon?: string; + Partial + readonly coupon?: string /** @description ID of Alipay account to make the customer's new default for invoice payments. */ - readonly default_alipay_account?: string; + readonly default_alipay_account?: string /** @description ID of bank account to make the customer's new default for invoice payments. */ - readonly default_bank_account?: string; + readonly default_bank_account?: string /** @description ID of card to make the customer's new default for invoice payments. */ - readonly default_card?: string; + readonly default_card?: string /** * @description If you are using payment methods created via the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method) parameter. * @@ -22774,15 +22547,15 @@ export interface operations { * * If you want to add a new payment source and make it the default, see the [source](https://stripe.com/docs/api/customers/update#update_customer-source) property. */ - readonly default_source?: string; + readonly default_source?: string /** @description An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard. */ - readonly description?: string; + readonly description?: string /** @description Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*. */ - readonly email?: string; + readonly email?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers. */ - readonly invoice_prefix?: string; + readonly invoice_prefix?: string /** * customer_param * @description Default invoice settings for this customer. @@ -22790,290 +22563,290 @@ export interface operations { readonly invoice_settings?: { readonly custom_fields?: Partial< readonly { - readonly name: string; - readonly value: string; + readonly name: string + readonly value: string }[] > & - Partial<"">; - readonly default_payment_method?: string; - readonly footer?: string; - }; + Partial<''> + readonly default_payment_method?: string + readonly footer?: string + } /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description The customer's full name or business name. */ - readonly name?: string; + readonly name?: string /** @description The sequence to be used on the customer's next invoice. Defaults to 1. */ - readonly next_invoice_sequence?: number; + readonly next_invoice_sequence?: number /** @description The customer's phone number. */ - readonly phone?: string; + readonly phone?: string /** @description Customer's preferred languages, ordered by preference. */ - readonly preferred_locales?: readonly string[]; + readonly preferred_locales?: readonly string[] /** @description The API ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount. */ - readonly promotion_code?: string; + readonly promotion_code?: string /** @description The customer's shipping information. Appears on invoices emailed to this customer. */ readonly shipping?: Partial<{ /** optional_fields_address */ readonly address: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; - readonly name: string; - readonly phone?: string; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } + readonly name: string + readonly phone?: string }> & - Partial<"">; - readonly source?: string; + Partial<''> + readonly source?: string /** * tax_param * @description Tax details about the customer. */ readonly tax?: { - readonly ip_address?: Partial & Partial<"">; - }; + readonly ip_address?: Partial & Partial<''> + } /** * @description The customer's tax exemption. One of `none`, `exempt`, or `reverse`. * @enum {string} */ - readonly tax_exempt?: "" | "exempt" | "none" | "reverse"; + readonly tax_exempt?: '' | 'exempt' | 'none' | 'reverse' /** @description Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. */ - readonly trial_end?: Partial<"now"> & Partial; - }; - }; - }; - }; + readonly trial_end?: Partial<'now'> & Partial + } + } + } + } /**

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

*/ readonly DeleteCustomersCustomer: { readonly parameters: { readonly path: { - readonly customer: string; - }; - }; + readonly customer: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["deleted_customer"]; - }; - }; + readonly 'application/json': components['schemas']['deleted_customer'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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

*/ readonly GetCustomersCustomerBalanceTransactions: { readonly parameters: { readonly path: { - readonly customer: string; - }; + readonly customer: string + } readonly query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Details about each object. */ - readonly data: readonly components["schemas"]["customer_balance_transaction"][]; + readonly data: readonly components['schemas']['customer_balance_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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

*/ readonly PostCustomersCustomerBalanceTransactions: { readonly parameters: { readonly path: { - readonly customer: string; - }; - }; + readonly customer: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["customer_balance_transaction"]; - }; - }; + readonly 'application/json': components['schemas']['customer_balance_transaction'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description The integer amount in **%s** to apply to the customer's credit balance. */ - readonly amount: number; + readonly amount: number /** @description 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 the customer's [`currency`](https://stripe.com/docs/api/customers/object#customer_object-currency) is set, this value must match it. If the customer's `currency` is not set, it will be updated to this value. */ - readonly currency: string; + readonly currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string; + readonly description?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> + } + } + } + } /**

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

*/ readonly GetCustomersCustomerBalanceTransactionsTransaction: { readonly parameters: { readonly path: { - readonly customer: string; - readonly transaction: string; - }; + readonly customer: string + readonly transaction: string + } readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; + readonly expand?: readonly string[] + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["customer_balance_transaction"]; - }; - }; + readonly 'application/json': components['schemas']['customer_balance_transaction'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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

*/ readonly PostCustomersCustomerBalanceTransactionsTransaction: { readonly parameters: { readonly path: { - readonly customer: string; - readonly transaction: string; - }; - }; + readonly customer: string + readonly transaction: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["customer_balance_transaction"]; - }; - }; + readonly 'application/json': components['schemas']['customer_balance_transaction'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string; + readonly description?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> + } + } + } + } /**

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.

*/ readonly GetCustomersCustomerBankAccounts: { readonly parameters: { readonly path: { - readonly customer: string; - }; + readonly customer: string + } readonly query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Details about each object. */ - readonly data: readonly components["schemas"]["bank_account"][]; + readonly data: readonly components['schemas']['bank_account'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /** *

When you create a new credit card, you must specify a customer or recipient on which to create it.

* @@ -23084,241 +22857,240 @@ export interface operations { readonly PostCustomersCustomerBankAccounts: { readonly parameters: { readonly path: { - readonly customer: string; - }; - }; + readonly customer: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["payment_source"]; - }; - }; + readonly 'application/json': components['schemas']['payment_source'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description A token returned by [Stripe.js](https://stripe.com/docs/js) representing the user’s Alipay account details. */ - readonly alipay_account?: string; + readonly alipay_account?: string /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ readonly bank_account?: Partial<{ - readonly account_holder_name?: string; + readonly account_holder_name?: string /** @enum {string} */ - readonly account_holder_type?: "company" | "individual"; - readonly account_number: string; - readonly country: string; - readonly currency?: string; + readonly account_holder_type?: 'company' | 'individual' + readonly account_number: string + readonly country: string + readonly currency?: string /** @enum {string} */ - readonly object?: "bank_account"; - readonly routing_number?: string; + readonly object?: 'bank_account' + readonly routing_number?: string }> & - Partial; + Partial /** @description A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js). */ readonly card?: Partial<{ - readonly address_city?: string; - readonly address_country?: string; - readonly address_line1?: string; - readonly address_line2?: string; - readonly address_state?: string; - readonly address_zip?: string; - readonly cvc?: string; - readonly exp_month: number; - readonly exp_year: number; - readonly metadata?: { readonly [key: string]: string }; - readonly name?: string; - readonly number: string; + readonly address_city?: string + readonly address_country?: string + readonly address_line1?: string + readonly address_line2?: string + readonly address_state?: string + readonly address_zip?: string + readonly cvc?: string + readonly exp_month: number + readonly exp_year: number + readonly metadata?: { readonly [key: string]: string } + readonly name?: string + readonly number: string /** @enum {string} */ - readonly object?: "card"; + readonly object?: 'card' }> & - Partial; + Partial /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: { readonly [key: string]: string }; + readonly metadata?: { readonly [key: string]: string } /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - readonly source?: string; - }; - }; - }; - }; + readonly source?: string + } + } + } + } /**

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.

*/ readonly GetCustomersCustomerBankAccountsId: { readonly parameters: { readonly path: { - readonly customer: string; - readonly id: string; - }; + readonly customer: string + readonly id: string + } readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; + readonly expand?: readonly string[] + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["bank_account"]; - }; - }; + readonly 'application/json': components['schemas']['bank_account'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Update a specified source for a given customer.

*/ readonly PostCustomersCustomerBankAccountsId: { readonly parameters: { readonly path: { - readonly customer: string; - readonly id: string; - }; - }; + readonly customer: string + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": Partial & - Partial & - Partial; - }; - }; + readonly 'application/json': Partial & + Partial & + Partial + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description The name of the person or business that owns the bank account. */ - readonly account_holder_name?: string; + readonly account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - readonly account_holder_type?: "company" | "individual"; + readonly account_holder_type?: 'company' | 'individual' /** @description City/District/Suburb/Town/Village. */ - readonly address_city?: string; + readonly address_city?: string /** @description Billing address country, if provided when creating card. */ - readonly address_country?: string; + readonly address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - readonly address_line1?: string; + readonly address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - readonly address_line2?: string; + readonly address_line2?: string /** @description State/County/Province/Region. */ - readonly address_state?: string; + readonly address_state?: string /** @description ZIP or postal code. */ - readonly address_zip?: string; + readonly address_zip?: string /** @description Two digit number representing the card’s expiration month. */ - readonly exp_month?: string; + readonly exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - readonly exp_year?: string; + readonly exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description Cardholder name. */ - readonly name?: string; + readonly name?: string /** owner */ readonly owner?: { /** source_address */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; - readonly email?: string; - readonly name?: string; - readonly phone?: string; - }; - }; - }; - }; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } + readonly email?: string + readonly name?: string + readonly phone?: string + } + } + } + } + } /**

Delete a specified source for a given customer.

*/ readonly DeleteCustomersCustomerBankAccountsId: { readonly parameters: { readonly path: { - readonly customer: string; - readonly id: string; - }; - }; + readonly customer: string + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": Partial & - Partial; - }; - }; + readonly 'application/json': Partial & Partial + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } + } /**

Verify a specified bank account for a given customer.

*/ readonly PostCustomersCustomerBankAccountsIdVerify: { readonly parameters: { readonly path: { - readonly customer: string; - readonly id: string; - }; - }; + readonly customer: string + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["bank_account"]; - }; - }; + readonly 'application/json': components['schemas']['bank_account'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account. */ - readonly amounts?: readonly number[]; + readonly amounts?: readonly number[] /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } + } /** *

You can see a list of the cards belonging to a customer. * Note that the 10 most recent sources are always available on the Customer object. @@ -23327,50 +23099,50 @@ export interface operations { readonly GetCustomersCustomerCards: { readonly parameters: { readonly path: { - readonly customer: string; - }; + readonly customer: string + } readonly query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["card"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['card'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /** *

When you create a new credit card, you must specify a customer or recipient on which to create it.

* @@ -23381,389 +23153,388 @@ export interface operations { readonly PostCustomersCustomerCards: { readonly parameters: { readonly path: { - readonly customer: string; - }; - }; + readonly customer: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["payment_source"]; - }; - }; + readonly 'application/json': components['schemas']['payment_source'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description A token returned by [Stripe.js](https://stripe.com/docs/js) representing the user’s Alipay account details. */ - readonly alipay_account?: string; + readonly alipay_account?: string /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ readonly bank_account?: Partial<{ - readonly account_holder_name?: string; + readonly account_holder_name?: string /** @enum {string} */ - readonly account_holder_type?: "company" | "individual"; - readonly account_number: string; - readonly country: string; - readonly currency?: string; + readonly account_holder_type?: 'company' | 'individual' + readonly account_number: string + readonly country: string + readonly currency?: string /** @enum {string} */ - readonly object?: "bank_account"; - readonly routing_number?: string; + readonly object?: 'bank_account' + readonly routing_number?: string }> & - Partial; + Partial /** @description A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js). */ readonly card?: Partial<{ - readonly address_city?: string; - readonly address_country?: string; - readonly address_line1?: string; - readonly address_line2?: string; - readonly address_state?: string; - readonly address_zip?: string; - readonly cvc?: string; - readonly exp_month: number; - readonly exp_year: number; - readonly metadata?: { readonly [key: string]: string }; - readonly name?: string; - readonly number: string; + readonly address_city?: string + readonly address_country?: string + readonly address_line1?: string + readonly address_line2?: string + readonly address_state?: string + readonly address_zip?: string + readonly cvc?: string + readonly exp_month: number + readonly exp_year: number + readonly metadata?: { readonly [key: string]: string } + readonly name?: string + readonly number: string /** @enum {string} */ - readonly object?: "card"; + readonly object?: 'card' }> & - Partial; + Partial /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: { readonly [key: string]: string }; + readonly metadata?: { readonly [key: string]: string } /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - readonly source?: string; - }; - }; - }; - }; + readonly source?: string + } + } + } + } /**

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.

*/ readonly GetCustomersCustomerCardsId: { readonly parameters: { readonly path: { - readonly customer: string; - readonly id: string; - }; + readonly customer: string + readonly id: string + } readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; + readonly expand?: readonly string[] + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["card"]; - }; - }; + readonly 'application/json': components['schemas']['card'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Update a specified source for a given customer.

*/ readonly PostCustomersCustomerCardsId: { readonly parameters: { readonly path: { - readonly customer: string; - readonly id: string; - }; - }; + readonly customer: string + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": Partial & - Partial & - Partial; - }; - }; + readonly 'application/json': Partial & + Partial & + Partial + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description The name of the person or business that owns the bank account. */ - readonly account_holder_name?: string; + readonly account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - readonly account_holder_type?: "company" | "individual"; + readonly account_holder_type?: 'company' | 'individual' /** @description City/District/Suburb/Town/Village. */ - readonly address_city?: string; + readonly address_city?: string /** @description Billing address country, if provided when creating card. */ - readonly address_country?: string; + readonly address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - readonly address_line1?: string; + readonly address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - readonly address_line2?: string; + readonly address_line2?: string /** @description State/County/Province/Region. */ - readonly address_state?: string; + readonly address_state?: string /** @description ZIP or postal code. */ - readonly address_zip?: string; + readonly address_zip?: string /** @description Two digit number representing the card’s expiration month. */ - readonly exp_month?: string; + readonly exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - readonly exp_year?: string; + readonly exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description Cardholder name. */ - readonly name?: string; + readonly name?: string /** owner */ readonly owner?: { /** source_address */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; - readonly email?: string; - readonly name?: string; - readonly phone?: string; - }; - }; - }; - }; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } + readonly email?: string + readonly name?: string + readonly phone?: string + } + } + } + } + } /**

Delete a specified source for a given customer.

*/ readonly DeleteCustomersCustomerCardsId: { readonly parameters: { readonly path: { - readonly customer: string; - readonly id: string; - }; - }; + readonly customer: string + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": Partial & - Partial; - }; - }; + readonly 'application/json': Partial & Partial + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } + } readonly GetCustomersCustomerDiscount: { readonly parameters: { readonly path: { - readonly customer: string; - }; + readonly customer: string + } readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; + readonly expand?: readonly string[] + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["discount"]; - }; - }; + readonly 'application/json': components['schemas']['discount'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Removes the currently applied discount on a customer.

*/ readonly DeleteCustomersCustomerDiscount: { readonly parameters: { readonly path: { - readonly customer: string; - }; - }; + readonly customer: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["deleted_discount"]; - }; - }; + readonly 'application/json': components['schemas']['deleted_discount'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Returns a list of PaymentMethods for a given Customer

*/ readonly GetCustomersCustomerPaymentMethods: { readonly parameters: { readonly path: { - readonly customer: string; - }; + readonly customer: string + } readonly query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** A required filter on the list, based on the object `type` field. */ readonly type: - | "acss_debit" - | "afterpay_clearpay" - | "alipay" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "eps" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "klarna" - | "oxxo" - | "p24" - | "sepa_debit" - | "sofort" - | "wechat_pay"; - }; - }; - readonly responses: { - /** Successful response. */ - readonly 200: { - readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["payment_method"][]; + | 'acss_debit' + | 'afterpay_clearpay' + | 'alipay' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'eps' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'klarna' + | 'oxxo' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' + } + } + readonly responses: { + /** Successful response. */ + readonly 200: { + readonly content: { + readonly 'application/json': { + readonly data: readonly components['schemas']['payment_method'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

List sources for a specified customer.

*/ readonly GetCustomersCustomerSources: { readonly parameters: { readonly path: { - readonly customer: string; - }; + readonly customer: string + } readonly query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** Filter sources according to a particular object type. */ - readonly object?: string; + readonly object?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Details about each object. */ - readonly data: readonly (Partial & - Partial & - Partial & - Partial & - Partial)[]; + readonly data: readonly (Partial & + Partial & + Partial & + Partial & + Partial)[] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /** *

When you create a new credit card, you must specify a customer or recipient on which to create it.

* @@ -23774,410 +23545,409 @@ export interface operations { readonly PostCustomersCustomerSources: { readonly parameters: { readonly path: { - readonly customer: string; - }; - }; + readonly customer: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["payment_source"]; - }; - }; + readonly 'application/json': components['schemas']['payment_source'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description A token returned by [Stripe.js](https://stripe.com/docs/js) representing the user’s Alipay account details. */ - readonly alipay_account?: string; + readonly alipay_account?: string /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ readonly bank_account?: Partial<{ - readonly account_holder_name?: string; + readonly account_holder_name?: string /** @enum {string} */ - readonly account_holder_type?: "company" | "individual"; - readonly account_number: string; - readonly country: string; - readonly currency?: string; + readonly account_holder_type?: 'company' | 'individual' + readonly account_number: string + readonly country: string + readonly currency?: string /** @enum {string} */ - readonly object?: "bank_account"; - readonly routing_number?: string; + readonly object?: 'bank_account' + readonly routing_number?: string }> & - Partial; + Partial /** @description A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js). */ readonly card?: Partial<{ - readonly address_city?: string; - readonly address_country?: string; - readonly address_line1?: string; - readonly address_line2?: string; - readonly address_state?: string; - readonly address_zip?: string; - readonly cvc?: string; - readonly exp_month: number; - readonly exp_year: number; - readonly metadata?: { readonly [key: string]: string }; - readonly name?: string; - readonly number: string; + readonly address_city?: string + readonly address_country?: string + readonly address_line1?: string + readonly address_line2?: string + readonly address_state?: string + readonly address_zip?: string + readonly cvc?: string + readonly exp_month: number + readonly exp_year: number + readonly metadata?: { readonly [key: string]: string } + readonly name?: string + readonly number: string /** @enum {string} */ - readonly object?: "card"; + readonly object?: 'card' }> & - Partial; + Partial /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: { readonly [key: string]: string }; + readonly metadata?: { readonly [key: string]: string } /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - readonly source?: string; - }; - }; - }; - }; + readonly source?: string + } + } + } + } /**

Retrieve a specified source for a given customer.

*/ readonly GetCustomersCustomerSourcesId: { readonly parameters: { readonly path: { - readonly customer: string; - readonly id: string; - }; + readonly customer: string + readonly id: string + } readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; + readonly expand?: readonly string[] + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["payment_source"]; - }; - }; + readonly 'application/json': components['schemas']['payment_source'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Update a specified source for a given customer.

*/ readonly PostCustomersCustomerSourcesId: { readonly parameters: { readonly path: { - readonly customer: string; - readonly id: string; - }; - }; + readonly customer: string + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": Partial & - Partial & - Partial; - }; - }; + readonly 'application/json': Partial & + Partial & + Partial + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description The name of the person or business that owns the bank account. */ - readonly account_holder_name?: string; + readonly account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - readonly account_holder_type?: "company" | "individual"; + readonly account_holder_type?: 'company' | 'individual' /** @description City/District/Suburb/Town/Village. */ - readonly address_city?: string; + readonly address_city?: string /** @description Billing address country, if provided when creating card. */ - readonly address_country?: string; + readonly address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - readonly address_line1?: string; + readonly address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - readonly address_line2?: string; + readonly address_line2?: string /** @description State/County/Province/Region. */ - readonly address_state?: string; + readonly address_state?: string /** @description ZIP or postal code. */ - readonly address_zip?: string; + readonly address_zip?: string /** @description Two digit number representing the card’s expiration month. */ - readonly exp_month?: string; + readonly exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - readonly exp_year?: string; + readonly exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description Cardholder name. */ - readonly name?: string; + readonly name?: string /** owner */ readonly owner?: { /** source_address */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; - readonly email?: string; - readonly name?: string; - readonly phone?: string; - }; - }; - }; - }; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } + readonly email?: string + readonly name?: string + readonly phone?: string + } + } + } + } + } /**

Delete a specified source for a given customer.

*/ readonly DeleteCustomersCustomerSourcesId: { readonly parameters: { readonly path: { - readonly customer: string; - readonly id: string; - }; - }; + readonly customer: string + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": Partial & - Partial; - }; - }; + readonly 'application/json': Partial & Partial + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } + } /**

Verify a specified bank account for a given customer.

*/ readonly PostCustomersCustomerSourcesIdVerify: { readonly parameters: { readonly path: { - readonly customer: string; - readonly id: string; - }; - }; + readonly customer: string + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["bank_account"]; - }; - }; + readonly 'application/json': components['schemas']['bank_account'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account. */ - readonly amounts?: readonly number[]; + readonly amounts?: readonly number[] /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } + } /**

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.

*/ readonly GetCustomersCustomerSubscriptions: { readonly parameters: { readonly path: { - readonly customer: string; - }; + readonly customer: string + } readonly query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Details about each object. */ - readonly data: readonly components["schemas"]["subscription"][]; + readonly data: readonly components['schemas']['subscription'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Creates a new subscription on an existing customer.

*/ readonly PostCustomersCustomerSubscriptions: { readonly parameters: { readonly path: { - readonly customer: string; - }; - }; + readonly customer: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["subscription"]; - }; - }; + readonly 'application/json': components['schemas']['subscription'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description A list of prices and quantities that will generate invoice items appended to the first invoice for this subscription. You may pass up to 20 items. */ readonly add_invoice_items?: readonly { - readonly price?: string; + readonly price?: string /** one_time_price_data */ readonly price_data?: { - readonly currency: string; - readonly product: string; + readonly currency: string + readonly product: string /** @enum {string} */ - readonly tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - readonly unit_amount?: number; + readonly tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + readonly unit_amount?: number /** Format: decimal */ - readonly unit_amount_decimal?: string; - }; - readonly quantity?: number; - readonly tax_rates?: Partial & Partial<"">; - }[]; + readonly unit_amount_decimal?: string + } + readonly quantity?: number + readonly tax_rates?: Partial & Partial<''> + }[] /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). */ - readonly application_fee_percent?: number; + readonly application_fee_percent?: number /** * automatic_tax_config * @description Automatic tax settings for this subscription. */ readonly automatic_tax?: { - readonly enabled: boolean; - }; + readonly enabled: boolean + } /** * Format: unix-time * @description For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor. */ - readonly backdate_start_date?: number; + readonly backdate_start_date?: number /** * Format: unix-time * @description 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. */ - readonly billing_cycle_anchor?: number; + readonly billing_cycle_anchor?: number /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. */ readonly billing_thresholds?: Partial<{ - readonly amount_gte?: number; - readonly reset_billing_cycle_anchor?: boolean; + readonly amount_gte?: number + readonly reset_billing_cycle_anchor?: boolean }> & - Partial<"">; + Partial<''> /** * Format: unix-time * @description 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. */ - readonly cancel_at?: number; + readonly cancel_at?: number /** @description Boolean indicating whether this subscription should cancel at the end of the current period. */ - readonly cancel_at_period_end?: boolean; + readonly cancel_at_period_end?: boolean /** * @description 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. Defaults to `charge_automatically`. * @enum {string} */ - readonly collection_method?: "charge_automatically" | "send_invoice"; + readonly collection_method?: 'charge_automatically' | 'send_invoice' /** @description The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. */ - readonly coupon?: string; + readonly coupon?: string /** @description Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. */ - readonly days_until_due?: number; + readonly days_until_due?: number /** @description 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). */ - readonly default_payment_method?: string; + readonly default_payment_method?: string /** @description 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). */ - readonly default_source?: string; + readonly default_source?: string /** @description 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. */ - readonly default_tax_rates?: Partial & Partial<"">; + readonly default_tax_rates?: Partial & Partial<''> /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description A list of up to 20 subscription items, each with an attached price. */ readonly items?: readonly { readonly billing_thresholds?: Partial<{ - readonly usage_gte: number; + readonly usage_gte: number }> & - Partial<"">; - readonly metadata?: { readonly [key: string]: string }; - readonly price?: string; + Partial<''> + readonly metadata?: { readonly [key: string]: string } + readonly price?: string /** recurring_price_data */ readonly price_data?: { - readonly currency: string; - readonly product: string; + readonly currency: string + readonly product: string /** recurring_adhoc */ readonly recurring: { /** @enum {string} */ - readonly interval: "day" | "month" | "week" | "year"; - readonly interval_count?: number; - }; + readonly interval: 'day' | 'month' | 'week' | 'year' + readonly interval_count?: number + } /** @enum {string} */ - readonly tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - readonly unit_amount?: number; + readonly tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + readonly unit_amount?: number /** Format: decimal */ - readonly unit_amount_decimal?: string; - }; - readonly quantity?: number; - readonly tax_rates?: Partial & Partial<"">; - }[]; + readonly unit_amount_decimal?: string + } + readonly quantity?: number + readonly tax_rates?: Partial & Partial<''> + }[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. */ - readonly off_session?: boolean; + readonly off_session?: boolean /** * @description Use `allow_incomplete` to create subscriptions with `status=incomplete` if the first invoice cannot be paid. Creating subscriptions with this status allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * @@ -24188,11 +23958,7 @@ export interface operations { * `pending_if_incomplete` is only used with updates and cannot be passed when creating a subscription. * @enum {string} */ - readonly payment_behavior?: - | "allow_incomplete" - | "default_incomplete" - | "error_if_incomplete" - | "pending_if_incomplete"; + readonly payment_behavior?: 'allow_incomplete' | 'default_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete' /** * payment_settings * @description Payment settings to pass to invoices created by the subscription. @@ -24204,241 +23970,241 @@ export interface operations { /** mandate_options_param */ readonly mandate_options?: { /** @enum {string} */ - readonly transaction_type?: "business" | "personal"; - }; + readonly transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - readonly verification_method?: "automatic" | "instant" | "microdeposits"; + readonly verification_method?: 'automatic' | 'instant' | 'microdeposits' }> & - Partial<"">; + Partial<''> readonly bancontact?: Partial<{ /** @enum {string} */ - readonly preferred_language?: "de" | "en" | "fr" | "nl"; + readonly preferred_language?: 'de' | 'en' | 'fr' | 'nl' }> & - Partial<"">; + Partial<''> readonly card?: Partial<{ /** mandate_options_param */ readonly mandate_options?: { - readonly amount?: number; + readonly amount?: number /** @enum {string} */ - readonly amount_type?: "fixed" | "maximum"; - readonly description?: string; - }; + readonly amount_type?: 'fixed' | 'maximum' + readonly description?: string + } /** @enum {string} */ - readonly request_three_d_secure?: "any" | "automatic"; + readonly request_three_d_secure?: 'any' | 'automatic' }> & - Partial<"">; - }; + Partial<''> + } readonly payment_method_types?: Partial< readonly ( - | "ach_credit_transfer" - | "ach_debit" - | "acss_debit" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "sepa_debit" - | "sofort" - | "wechat_pay" + | 'ach_credit_transfer' + | 'ach_debit' + | 'acss_debit' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' )[] > & - Partial<"">; - }; + Partial<''> + } /** @description 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. */ readonly pending_invoice_item_interval?: Partial<{ /** @enum {string} */ - readonly interval: "day" | "month" | "week" | "year"; - readonly interval_count?: number; + readonly interval: 'day' | 'month' | 'week' | 'year' + readonly interval_count?: number }> & - Partial<"">; + Partial<''> /** @description The API ID of a promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. */ - readonly promotion_code?: string; + readonly promotion_code?: string /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) resulting from the `billing_cycle_anchor`. Valid values are `create_prorations` or `none`. * * Passing `create_prorations` will cause proration invoice items to be created when applicable. Prorations can be disabled by passing `none`. If no value is passed, the default is `create_prorations`. * @enum {string} */ - readonly proration_behavior?: "always_invoice" | "create_prorations" | "none"; + readonly proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** * transfer_data_specs * @description If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. */ readonly transfer_data?: { - readonly amount_percent?: number; - readonly destination: string; - }; + readonly amount_percent?: number + readonly destination: string + } /** @description Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. */ - readonly trial_end?: Partial<"now"> & Partial; + readonly trial_end?: Partial<'now'> & Partial /** @description 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. */ - readonly trial_from_plan?: boolean; + readonly trial_from_plan?: boolean /** @description Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. */ - readonly trial_period_days?: number; - }; - }; - }; - }; + readonly trial_period_days?: number + } + } + } + } /**

Retrieves the subscription with the given ID.

*/ readonly GetCustomersCustomerSubscriptionsSubscriptionExposedId: { readonly parameters: { readonly path: { - readonly customer: string; - readonly subscription_exposed_id: string; - }; + readonly customer: string + readonly subscription_exposed_id: string + } readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; + readonly expand?: readonly string[] + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["subscription"]; - }; - }; + readonly 'application/json': components['schemas']['subscription'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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.

*/ readonly PostCustomersCustomerSubscriptionsSubscriptionExposedId: { readonly parameters: { readonly path: { - readonly customer: string; - readonly subscription_exposed_id: string; - }; - }; + readonly customer: string + readonly subscription_exposed_id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["subscription"]; - }; - }; + readonly 'application/json': components['schemas']['subscription'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description A list of prices and quantities that will generate invoice items appended to the first invoice for this subscription. You may pass up to 20 items. */ readonly add_invoice_items?: readonly { - readonly price?: string; + readonly price?: string /** one_time_price_data */ readonly price_data?: { - readonly currency: string; - readonly product: string; + readonly currency: string + readonly product: string /** @enum {string} */ - readonly tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - readonly unit_amount?: number; + readonly tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + readonly unit_amount?: number /** Format: decimal */ - readonly unit_amount_decimal?: string; - }; - readonly quantity?: number; - readonly tax_rates?: Partial & Partial<"">; - }[]; + readonly unit_amount_decimal?: string + } + readonly quantity?: number + readonly tax_rates?: Partial & Partial<''> + }[] /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). */ - readonly application_fee_percent?: number; + readonly application_fee_percent?: number /** * automatic_tax_config * @description Automatic tax settings for this subscription. */ readonly automatic_tax?: { - readonly enabled: boolean; - }; + readonly enabled: boolean + } /** * @description Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). * @enum {string} */ - readonly billing_cycle_anchor?: "now" | "unchanged"; + readonly billing_cycle_anchor?: 'now' | 'unchanged' /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. */ readonly billing_thresholds?: Partial<{ - readonly amount_gte?: number; - readonly reset_billing_cycle_anchor?: boolean; + readonly amount_gte?: number + readonly reset_billing_cycle_anchor?: boolean }> & - Partial<"">; + Partial<''> /** @description 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. */ - readonly cancel_at?: Partial & Partial<"">; + readonly cancel_at?: Partial & Partial<''> /** @description Boolean indicating whether this subscription should cancel at the end of the current period. */ - readonly cancel_at_period_end?: boolean; + readonly cancel_at_period_end?: boolean /** * @description 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. Defaults to `charge_automatically`. * @enum {string} */ - readonly collection_method?: "charge_automatically" | "send_invoice"; + readonly collection_method?: 'charge_automatically' | 'send_invoice' /** @description The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. */ - readonly coupon?: string; + readonly coupon?: string /** @description Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. */ - readonly days_until_due?: number; + readonly days_until_due?: number /** @description 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). */ - readonly default_payment_method?: string; + readonly default_payment_method?: string /** @description 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). */ - readonly default_source?: string; + readonly default_source?: string /** @description 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. Pass an empty string to remove previously-defined tax rates. */ - readonly default_tax_rates?: Partial & Partial<"">; + readonly default_tax_rates?: Partial & Partial<''> /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description A list of up to 20 subscription items, each with an attached price. */ readonly items?: readonly { readonly billing_thresholds?: Partial<{ - readonly usage_gte: number; + readonly usage_gte: number }> & - Partial<"">; - readonly clear_usage?: boolean; - readonly deleted?: boolean; - readonly id?: string; - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; - readonly price?: string; + Partial<''> + readonly clear_usage?: boolean + readonly deleted?: boolean + readonly id?: string + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> + readonly price?: string /** recurring_price_data */ readonly price_data?: { - readonly currency: string; - readonly product: string; + readonly currency: string + readonly product: string /** recurring_adhoc */ readonly recurring: { /** @enum {string} */ - readonly interval: "day" | "month" | "week" | "year"; - readonly interval_count?: number; - }; + readonly interval: 'day' | 'month' | 'week' | 'year' + readonly interval_count?: number + } /** @enum {string} */ - readonly tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - readonly unit_amount?: number; + readonly tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + readonly unit_amount?: number /** Format: decimal */ - readonly unit_amount_decimal?: string; - }; - readonly quantity?: number; - readonly tax_rates?: Partial & Partial<"">; - }[]; + readonly unit_amount_decimal?: string + } + readonly quantity?: number + readonly tax_rates?: Partial & Partial<''> + }[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. */ - readonly off_session?: boolean; + readonly off_session?: boolean /** @description If specified, payment collection for this subscription will be paused. */ readonly pause_collection?: Partial<{ /** @enum {string} */ - readonly behavior: "keep_as_draft" | "mark_uncollectible" | "void"; + readonly behavior: 'keep_as_draft' | 'mark_uncollectible' | 'void' /** Format: unix-time */ - readonly resumes_at?: number; + readonly resumes_at?: number }> & - Partial<"">; + Partial<''> /** * @description Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * @@ -24449,11 +24215,7 @@ export interface operations { * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. * @enum {string} */ - readonly payment_behavior?: - | "allow_incomplete" - | "default_incomplete" - | "error_if_incomplete" - | "pending_if_incomplete"; + readonly payment_behavior?: 'allow_incomplete' | 'default_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete' /** * payment_settings * @description Payment settings to pass to invoices created by the subscription. @@ -24465,60 +24227,60 @@ export interface operations { /** mandate_options_param */ readonly mandate_options?: { /** @enum {string} */ - readonly transaction_type?: "business" | "personal"; - }; + readonly transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - readonly verification_method?: "automatic" | "instant" | "microdeposits"; + readonly verification_method?: 'automatic' | 'instant' | 'microdeposits' }> & - Partial<"">; + Partial<''> readonly bancontact?: Partial<{ /** @enum {string} */ - readonly preferred_language?: "de" | "en" | "fr" | "nl"; + readonly preferred_language?: 'de' | 'en' | 'fr' | 'nl' }> & - Partial<"">; + Partial<''> readonly card?: Partial<{ /** mandate_options_param */ readonly mandate_options?: { - readonly amount?: number; + readonly amount?: number /** @enum {string} */ - readonly amount_type?: "fixed" | "maximum"; - readonly description?: string; - }; + readonly amount_type?: 'fixed' | 'maximum' + readonly description?: string + } /** @enum {string} */ - readonly request_three_d_secure?: "any" | "automatic"; + readonly request_three_d_secure?: 'any' | 'automatic' }> & - Partial<"">; - }; + Partial<''> + } readonly payment_method_types?: Partial< readonly ( - | "ach_credit_transfer" - | "ach_debit" - | "acss_debit" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "sepa_debit" - | "sofort" - | "wechat_pay" + | 'ach_credit_transfer' + | 'ach_debit' + | 'acss_debit' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' )[] > & - Partial<"">; - }; + Partial<''> + } /** @description 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. */ readonly pending_invoice_item_interval?: Partial<{ /** @enum {string} */ - readonly interval: "day" | "month" | "week" | "year"; - readonly interval_count?: number; + readonly interval: 'day' | 'month' | 'week' | 'year' + readonly interval_count?: number }> & - Partial<"">; + Partial<''> /** @description The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. */ - readonly promotion_code?: string; + readonly promotion_code?: string /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -24527,26 +24289,26 @@ export interface operations { * Prorations can be disabled by passing `none`. * @enum {string} */ - readonly proration_behavior?: "always_invoice" | "create_prorations" | "none"; + readonly proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** * Format: unix-time * @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations. */ - readonly proration_date?: number; + readonly proration_date?: number /** @description If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. This will be unset if you POST an empty value. */ readonly transfer_data?: Partial<{ - readonly amount_percent?: number; - readonly destination: string; + readonly amount_percent?: number + readonly destination: string }> & - Partial<"">; + Partial<''> /** @description Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. */ - readonly trial_end?: Partial<"now"> & Partial; + readonly trial_end?: Partial<'now'> & Partial /** @description 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. */ - readonly trial_from_plan?: boolean; - }; - }; - }; - }; + readonly trial_from_plan?: boolean + } + } + } + } /** *

Cancels a customer’s subscription. If you set the at_period_end parameter to true, the subscription will remain active until the end of the period, at which point it will be canceled and not renewed. Otherwise, with the default false value, the subscription is terminated immediately. In either case, the customer will not be charged again for the subscription.

* @@ -24557,371 +24319,371 @@ export interface operations { readonly DeleteCustomersCustomerSubscriptionsSubscriptionExposedId: { readonly parameters: { readonly path: { - readonly customer: string; - readonly subscription_exposed_id: string; - }; - }; + readonly customer: string + readonly subscription_exposed_id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["subscription"]; - }; - }; + readonly 'application/json': components['schemas']['subscription'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description Can be set to `true` if `at_period_end` is not set to `true`. Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items. */ - readonly invoice_now?: boolean; + readonly invoice_now?: boolean /** @description Can be set to `true` if `at_period_end` is not set to `true`. Will generate a proration invoice item that credits remaining unused time until the subscription period end. */ - readonly prorate?: boolean; - }; - }; - }; - }; + readonly prorate?: boolean + } + } + } + } readonly GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount: { readonly parameters: { readonly path: { - readonly customer: string; - readonly subscription_exposed_id: string; - }; + readonly customer: string + readonly subscription_exposed_id: string + } readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; + readonly expand?: readonly string[] + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["discount"]; - }; - }; + readonly 'application/json': components['schemas']['discount'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Removes the currently applied discount on a customer.

*/ readonly DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount: { readonly parameters: { readonly path: { - readonly customer: string; - readonly subscription_exposed_id: string; - }; - }; + readonly customer: string + readonly subscription_exposed_id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["deleted_discount"]; - }; - }; + readonly 'application/json': components['schemas']['deleted_discount'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Returns a list of tax IDs for a customer.

*/ readonly GetCustomersCustomerTaxIds: { readonly parameters: { readonly path: { - readonly customer: string; - }; + readonly customer: string + } readonly query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Details about each object. */ - readonly data: readonly components["schemas"]["tax_id"][]; + readonly data: readonly components['schemas']['tax_id'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Creates a new TaxID object for a customer.

*/ readonly PostCustomersCustomerTaxIds: { readonly parameters: { readonly path: { - readonly customer: string; - }; - }; + readonly customer: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["tax_id"]; - }; - }; + readonly 'application/json': components['schemas']['tax_id'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** * @description Type of the tax ID, one of `ae_trn`, `au_abn`, `au_arn`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `es_cif`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `th_vat`, `tw_vat`, `ua_vat`, `us_ein`, or `za_vat` * @enum {string} */ readonly type: - | "ae_trn" - | "au_abn" - | "au_arn" - | "br_cnpj" - | "br_cpf" - | "ca_bn" - | "ca_gst_hst" - | "ca_pst_bc" - | "ca_pst_mb" - | "ca_pst_sk" - | "ca_qst" - | "ch_vat" - | "cl_tin" - | "es_cif" - | "eu_vat" - | "gb_vat" - | "ge_vat" - | "hk_br" - | "id_npwp" - | "il_vat" - | "in_gst" - | "is_vat" - | "jp_cn" - | "jp_rn" - | "kr_brn" - | "li_uid" - | "mx_rfc" - | "my_frp" - | "my_itn" - | "my_sst" - | "no_vat" - | "nz_gst" - | "ru_inn" - | "ru_kpp" - | "sa_vat" - | "sg_gst" - | "sg_uen" - | "th_vat" - | "tw_vat" - | "ua_vat" - | "us_ein" - | "za_vat"; + | 'ae_trn' + | 'au_abn' + | 'au_arn' + | 'br_cnpj' + | 'br_cpf' + | 'ca_bn' + | 'ca_gst_hst' + | 'ca_pst_bc' + | 'ca_pst_mb' + | 'ca_pst_sk' + | 'ca_qst' + | 'ch_vat' + | 'cl_tin' + | 'es_cif' + | 'eu_vat' + | 'gb_vat' + | 'ge_vat' + | 'hk_br' + | 'id_npwp' + | 'il_vat' + | 'in_gst' + | 'is_vat' + | 'jp_cn' + | 'jp_rn' + | 'kr_brn' + | 'li_uid' + | 'mx_rfc' + | 'my_frp' + | 'my_itn' + | 'my_sst' + | 'no_vat' + | 'nz_gst' + | 'ru_inn' + | 'ru_kpp' + | 'sa_vat' + | 'sg_gst' + | 'sg_uen' + | 'th_vat' + | 'tw_vat' + | 'ua_vat' + | 'us_ein' + | 'za_vat' /** @description Value of the tax ID. */ - readonly value: string; - }; - }; - }; - }; + readonly value: string + } + } + } + } /**

Retrieves the TaxID object with the given identifier.

*/ readonly GetCustomersCustomerTaxIdsId: { readonly parameters: { readonly path: { - readonly customer: string; - readonly id: string; - }; + readonly customer: string + readonly id: string + } readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; + readonly expand?: readonly string[] + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["tax_id"]; - }; - }; + readonly 'application/json': components['schemas']['tax_id'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Deletes an existing TaxID object.

*/ readonly DeleteCustomersCustomerTaxIdsId: { readonly parameters: { readonly path: { - readonly customer: string; - readonly id: string; - }; - }; + readonly customer: string + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["deleted_tax_id"]; - }; - }; + readonly 'application/json': components['schemas']['deleted_tax_id'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Returns a list of your disputes.

*/ readonly GetDisputes: { readonly parameters: { readonly query: { /** Only return disputes associated to the charge specified by this charge ID. */ - readonly charge?: string; + readonly charge?: string readonly created?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** Only return disputes associated to the PaymentIntent specified by this PaymentIntent ID. */ - readonly payment_intent?: string; + readonly payment_intent?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["dispute"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['dispute'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Retrieves the dispute with the given ID.

*/ readonly GetDisputesDispute: { readonly parameters: { readonly path: { - readonly dispute: string; - }; + readonly dispute: string + } readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; + readonly expand?: readonly string[] + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["dispute"]; - }; - }; + readonly 'application/json': components['schemas']['dispute'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /** *

When you get a dispute, contacting your customer is always the best first step. If that doesn’t work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your dashboard, but if you prefer, you can use the API to submit evidence programmatically.

* @@ -24930,69 +24692,69 @@ export interface operations { readonly PostDisputesDispute: { readonly parameters: { readonly path: { - readonly dispute: string; - }; - }; + readonly dispute: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["dispute"]; - }; - }; + readonly 'application/json': components['schemas']['dispute'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** * dispute_evidence_params * @description Evidence to upload, to respond to a dispute. Updating any field in the hash will submit all fields in the hash for review. The combined character count of all fields is limited to 150,000. */ readonly evidence?: { - readonly access_activity_log?: string; - readonly billing_address?: string; - readonly cancellation_policy?: string; - readonly cancellation_policy_disclosure?: string; - readonly cancellation_rebuttal?: string; - readonly customer_communication?: string; - readonly customer_email_address?: string; - readonly customer_name?: string; - readonly customer_purchase_ip?: string; - readonly customer_signature?: string; - readonly duplicate_charge_documentation?: string; - readonly duplicate_charge_explanation?: string; - readonly duplicate_charge_id?: string; - readonly product_description?: string; - readonly receipt?: string; - readonly refund_policy?: string; - readonly refund_policy_disclosure?: string; - readonly refund_refusal_explanation?: string; - readonly service_date?: string; - readonly service_documentation?: string; - readonly shipping_address?: string; - readonly shipping_carrier?: string; - readonly shipping_date?: string; - readonly shipping_documentation?: string; - readonly shipping_tracking_number?: string; - readonly uncategorized_file?: string; - readonly uncategorized_text?: string; - }; + readonly access_activity_log?: string + readonly billing_address?: string + readonly cancellation_policy?: string + readonly cancellation_policy_disclosure?: string + readonly cancellation_rebuttal?: string + readonly customer_communication?: string + readonly customer_email_address?: string + readonly customer_name?: string + readonly customer_purchase_ip?: string + readonly customer_signature?: string + readonly duplicate_charge_documentation?: string + readonly duplicate_charge_explanation?: string + readonly duplicate_charge_id?: string + readonly product_description?: string + readonly receipt?: string + readonly refund_policy?: string + readonly refund_policy_disclosure?: string + readonly refund_refusal_explanation?: string + readonly service_date?: string + readonly service_documentation?: string + readonly shipping_address?: string + readonly shipping_carrier?: string + readonly shipping_date?: string + readonly shipping_documentation?: string + readonly shipping_tracking_number?: string + readonly uncategorized_file?: string + readonly uncategorized_text?: string + } /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description Whether to immediately submit evidence to the bank. If `false`, evidence is staged on the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank by making another request with this attribute set to `true` (the default). */ - readonly submit?: boolean; - }; - }; - }; - }; + readonly submit?: boolean + } + } + } + } /** *

Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.

* @@ -25001,479 +24763,479 @@ export interface operations { readonly PostDisputesDisputeClose: { readonly parameters: { readonly path: { - readonly dispute: string; - }; - }; + readonly dispute: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["dispute"]; - }; - }; + readonly 'application/json': components['schemas']['dispute'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } + } /**

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

*/ readonly PostEphemeralKeys: { readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["ephemeral_key"]; - }; - }; + readonly 'application/json': components['schemas']['ephemeral_key'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description The ID of the Customer you'd like to modify using the resulting ephemeral key. */ - readonly customer?: string; + readonly customer?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The ID of the Issuing Card you'd like to access using the resulting ephemeral key. */ - readonly issuing_card?: string; - }; - }; - }; - }; + readonly issuing_card?: string + } + } + } + } /**

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

*/ readonly DeleteEphemeralKeysKey: { readonly parameters: { readonly path: { - readonly key: string; - }; - }; + readonly key: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["ephemeral_key"]; - }; - }; + readonly 'application/json': components['schemas']['ephemeral_key'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } + } /**

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).

*/ readonly GetEvents: { readonly parameters: { readonly query: { readonly created?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** 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. */ - readonly delivery_success?: boolean; + readonly delivery_success?: boolean /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** 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. */ - readonly type?: string; + readonly type?: string /** 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. */ - readonly types?: readonly string[]; - }; - }; + readonly types?: readonly string[] + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["event"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['event'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.

*/ readonly GetEventsId: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["event"]; - }; - }; + readonly 'application/json': components['schemas']['event'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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.

*/ readonly GetExchangeRates: { readonly parameters: { readonly query: { /** 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** 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. */ - readonly limit?: number; + readonly limit?: number /** 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. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["exchange_rate"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['exchange_rate'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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

*/ readonly GetExchangeRatesRateId: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly rate_id: string; - }; - }; + readonly rate_id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["exchange_rate"]; - }; - }; + readonly 'application/json': components['schemas']['exchange_rate'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Returns a list of file links.

*/ readonly GetFileLinks: { readonly parameters: { readonly query: { readonly created?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** Filter links by their expiration status. By default, all links are returned. */ - readonly expired?: boolean; + readonly expired?: boolean /** Only return links for the given file. */ - readonly file?: string; + readonly file?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["file_link"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['file_link'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Creates a new file link object.

*/ readonly PostFileLinks: { readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["file_link"]; - }; - }; + readonly 'application/json': components['schemas']['file_link'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** * Format: unix-time * @description A future timestamp after which the link will no longer be usable. */ - readonly expires_at?: number; + readonly expires_at?: number /** @description The ID of the file. The file's `purpose` must be one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `finance_report_run`, `identity_document_downloadable`, `pci_document`, `selfie`, `sigma_scheduled_query`, or `tax_document_user_upload`. */ - readonly file: string; + readonly file: string /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> + } + } + } + } /**

Retrieves the file link with the given ID.

*/ readonly GetFileLinksLink: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly link: string; - }; - }; + readonly link: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["file_link"]; - }; - }; + readonly 'application/json': components['schemas']['file_link'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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

*/ readonly PostFileLinksLink: { readonly parameters: { readonly path: { - readonly link: string; - }; - }; + readonly link: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["file_link"]; - }; - }; + readonly 'application/json': components['schemas']['file_link'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description A future timestamp after which the link will no longer be usable, or `now` to expire the link immediately. */ - readonly expires_at?: Partial<"now"> & Partial & Partial<"">; + readonly expires_at?: Partial<'now'> & Partial & Partial<''> /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> + } + } + } + } /**

Returns a list of the files that your account has access to. The files are returned sorted by creation date, with the most recently created files appearing first.

*/ readonly GetFiles: { readonly parameters: { readonly query: { readonly created?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** The file purpose to filter queries by. If none is provided, files will not be filtered by purpose. */ readonly purpose?: - | "account_requirement" - | "additional_verification" - | "business_icon" - | "business_logo" - | "customer_signature" - | "dispute_evidence" - | "document_provider_identity_document" - | "finance_report_run" - | "identity_document" - | "identity_document_downloadable" - | "pci_document" - | "selfie" - | "sigma_scheduled_query" - | "tax_document_user_upload"; + | 'account_requirement' + | 'additional_verification' + | 'business_icon' + | 'business_logo' + | 'customer_signature' + | 'dispute_evidence' + | 'document_provider_identity_document' + | 'finance_report_run' + | 'identity_document' + | 'identity_document_downloadable' + | 'pci_document' + | 'selfie' + | 'sigma_scheduled_query' + | 'tax_document_user_upload' /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["file"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['file'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /** *

To upload a file to Stripe, you’ll need to send a request of type multipart/form-data. The request should contain the file you would like to upload, as well as the parameters for creating a file.

* @@ -25484,223 +25246,223 @@ export interface operations { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["file"]; - }; - }; + readonly 'application/json': components['schemas']['file'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "multipart/form-data": { + readonly 'multipart/form-data': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description A file to upload. The file should follow the specifications of RFC 2388 (which defines file transfers for the `multipart/form-data` protocol). */ - readonly file: string; + readonly file: string /** * file_link_creation_params * @description Optional parameters to automatically create a [file link](https://stripe.com/docs/api#file_links) for the newly created file. */ readonly file_link_data?: { - readonly create: boolean; + readonly create: boolean /** Format: unix-time */ - readonly expires_at?: number; - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; - }; + readonly expires_at?: number + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> + } /** * @description The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file. * @enum {string} */ readonly purpose: - | "account_requirement" - | "additional_verification" - | "business_icon" - | "business_logo" - | "customer_signature" - | "dispute_evidence" - | "identity_document" - | "pci_document" - | "tax_document_user_upload"; - }; - }; - }; - }; + | 'account_requirement' + | 'additional_verification' + | 'business_icon' + | 'business_logo' + | 'customer_signature' + | 'dispute_evidence' + | 'identity_document' + | 'pci_document' + | 'tax_document_user_upload' + } + } + } + } /**

Retrieves the details of an existing file object. Supply the unique file ID from a file, and Stripe will return the corresponding file object. To access file contents, see the File Upload Guide.

*/ readonly GetFilesFile: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly file: string; - }; - }; + readonly file: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["file"]; - }; - }; + readonly 'application/json': components['schemas']['file'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

List all verification reports.

*/ readonly GetIdentityVerificationReports: { readonly parameters: { readonly query: { readonly created?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** Only return VerificationReports of this type */ - readonly type?: "document" | "id_number"; + readonly type?: 'document' | 'id_number' /** Only return VerificationReports created by this VerificationSession ID. It is allowed to provide a VerificationIntent ID. */ - readonly verification_session?: string; - }; - }; + readonly verification_session?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["identity.verification_report"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['identity.verification_report'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Retrieves an existing VerificationReport

*/ readonly GetIdentityVerificationReportsReport: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly report: string; - }; - }; + readonly report: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["identity.verification_report"]; - }; - }; + readonly 'application/json': components['schemas']['identity.verification_report'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Returns a list of VerificationSessions

*/ readonly GetIdentityVerificationSessions: { readonly parameters: { readonly query: { readonly created?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** Only return VerificationSessions with this status. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work). */ - readonly status?: "canceled" | "processing" | "requires_input" | "verified"; - }; - }; + readonly status?: 'canceled' | 'processing' | 'requires_input' | 'verified' + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["identity.verification_session"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['identity.verification_session'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /** *

Creates a VerificationSession object.

* @@ -25715,47 +25477,47 @@ export interface operations { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["identity.verification_session"]; - }; - }; + readonly 'application/json': components['schemas']['identity.verification_session'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: { readonly [key: string]: string }; + readonly metadata?: { readonly [key: string]: string } /** * session_options_param * @description A set of options for the session’s verification checks. */ readonly options?: { readonly document?: Partial<{ - readonly allowed_types?: readonly ("driving_license" | "id_card" | "passport")[]; - readonly require_id_number?: boolean; - readonly require_live_capture?: boolean; - readonly require_matching_selfie?: boolean; + readonly allowed_types?: readonly ('driving_license' | 'id_card' | 'passport')[] + readonly require_id_number?: boolean + readonly require_live_capture?: boolean + readonly require_matching_selfie?: boolean }> & - Partial<"">; - }; + Partial<''> + } /** @description The URL that the user will be redirected to upon completing the verification flow. */ - readonly return_url?: string; + readonly return_url?: string /** * @description The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. * @enum {string} */ - readonly type: "document" | "id_number"; - }; - }; - }; - }; + readonly type: 'document' | 'id_number' + } + } + } + } /** *

Retrieves the details of a VerificationSession that was previously created.

* @@ -25766,32 +25528,32 @@ export interface operations { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly session: string; - }; - }; + readonly session: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["identity.verification_session"]; - }; - }; + readonly 'application/json': components['schemas']['identity.verification_session'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /** *

Updates a VerificationSession object.

* @@ -25801,52 +25563,52 @@ export interface operations { readonly PostIdentityVerificationSessionsSession: { readonly parameters: { readonly path: { - readonly session: string; - }; - }; + readonly session: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["identity.verification_session"]; - }; - }; + readonly 'application/json': components['schemas']['identity.verification_session'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: { readonly [key: string]: string }; + readonly metadata?: { readonly [key: string]: string } /** * session_options_param * @description A set of options for the session’s verification checks. */ readonly options?: { readonly document?: Partial<{ - readonly allowed_types?: readonly ("driving_license" | "id_card" | "passport")[]; - readonly require_id_number?: boolean; - readonly require_live_capture?: boolean; - readonly require_matching_selfie?: boolean; + readonly allowed_types?: readonly ('driving_license' | 'id_card' | 'passport')[] + readonly require_id_number?: boolean + readonly require_live_capture?: boolean + readonly require_matching_selfie?: boolean }> & - Partial<"">; - }; + Partial<''> + } /** * @description The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. * @enum {string} */ - readonly type?: "document" | "id_number"; - }; - }; - }; - }; + readonly type?: 'document' | 'id_number' + } + } + } + } /** *

A VerificationSession object can be canceled when it is in requires_input status.

* @@ -25855,32 +25617,32 @@ export interface operations { readonly PostIdentityVerificationSessionsSessionCancel: { readonly parameters: { readonly path: { - readonly session: string; - }; - }; + readonly session: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["identity.verification_session"]; - }; - }; + readonly 'application/json': components['schemas']['identity.verification_session'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } + } /** *

Redact a VerificationSession to remove all collected information from Stripe. This will redact * the VerificationSession and all objects related to it, including VerificationReports, Events, @@ -25905,460 +25667,460 @@ export interface operations { readonly PostIdentityVerificationSessionsSessionRedact: { readonly parameters: { readonly path: { - readonly session: string; - }; - }; + readonly session: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["identity.verification_session"]; - }; - }; + readonly 'application/json': components['schemas']['identity.verification_session'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } + } /**

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

*/ readonly GetInvoiceitems: { readonly parameters: { readonly query: { readonly created?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** The identifier of the customer whose invoice items to return. If none is provided, all invoice items will be returned. */ - readonly customer?: string; + readonly customer?: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** 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. */ - readonly invoice?: string; + readonly invoice?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** 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. */ - readonly pending?: boolean; + readonly pending?: boolean /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["invoiceitem"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['invoiceitem'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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.

*/ readonly PostInvoiceitems: { readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["invoiceitem"]; - }; - }; + readonly 'application/json': components['schemas']['invoiceitem'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description The integer amount in %s of the charge to be applied to the upcoming invoice. Passing in a negative `amount` will reduce the `amount_due` on the invoice. */ - readonly amount?: number; + readonly amount?: number /** @description 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). */ - readonly currency?: string; + readonly currency?: string /** @description The ID of the customer who will be billed when this invoice item is billed. */ - readonly customer: string; + readonly customer: string /** @description An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking. */ - readonly description?: string; + readonly description?: string /** @description Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items. */ - readonly discountable?: boolean; + readonly discountable?: boolean /** @description The coupons to redeem into discounts for the invoice item or invoice line item. */ readonly discounts?: Partial< readonly { - readonly coupon?: string; - readonly discount?: string; + readonly coupon?: string + readonly discount?: string }[] > & - Partial<"">; + Partial<''> /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The ID of an existing invoice to add this invoice item to. When left blank, the invoice item will be added to the next upcoming scheduled invoice. This is useful when adding invoice items in response to an invoice.created webhook. You can only add invoice items to draft invoices and there is a maximum of 250 items per invoice. */ - readonly invoice?: string; + readonly invoice?: string /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** * period * @description The period associated with this invoice item. */ readonly period?: { /** Format: unix-time */ - readonly end: number; + readonly end: number /** Format: unix-time */ - readonly start: number; - }; + readonly start: number + } /** @description The ID of the price object. */ - readonly price?: string; + readonly price?: string /** * one_time_price_data * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. */ readonly price_data?: { - readonly currency: string; - readonly product: string; + readonly currency: string + readonly product: string /** @enum {string} */ - readonly tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - readonly unit_amount?: number; + readonly tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + readonly unit_amount?: number /** Format: decimal */ - readonly unit_amount_decimal?: string; - }; + readonly unit_amount_decimal?: string + } /** @description Non-negative integer. The quantity of units for the invoice item. */ - readonly quantity?: number; + readonly quantity?: number /** @description The ID of a subscription to add this invoice item to. When left blank, the invoice item will be be added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription. */ - readonly subscription?: string; + readonly subscription?: string /** @description 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. */ - readonly tax_rates?: readonly string[]; + readonly tax_rates?: readonly string[] /** @description The integer unit amount in %s of the charge to be applied to the upcoming invoice. This `unit_amount` will be multiplied by the quantity to get the full amount. Passing in a negative `unit_amount` will reduce the `amount_due` on the invoice. */ - readonly unit_amount?: number; + readonly unit_amount?: number /** * Format: decimal * @description Same as `unit_amount`, but accepts a decimal value in %s with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. */ - readonly unit_amount_decimal?: string; - }; - }; - }; - }; + readonly unit_amount_decimal?: string + } + } + } + } /**

Retrieves the invoice item with the given ID.

*/ readonly GetInvoiceitemsInvoiceitem: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly invoiceitem: string; - }; - }; + readonly invoiceitem: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["invoiceitem"]; - }; - }; + readonly 'application/json': components['schemas']['invoiceitem'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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.

*/ readonly PostInvoiceitemsInvoiceitem: { readonly parameters: { readonly path: { - readonly invoiceitem: string; - }; - }; + readonly invoiceitem: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["invoiceitem"]; - }; - }; + readonly 'application/json': components['schemas']['invoiceitem'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description The integer amount in %s of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount. */ - readonly amount?: number; + readonly amount?: number /** @description An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking. */ - readonly description?: string; + readonly description?: string /** @description Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items. Cannot be set to true for prorations. */ - readonly discountable?: boolean; + readonly discountable?: boolean /** @description The coupons & existing discounts which apply to the invoice item or invoice line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts. */ readonly discounts?: Partial< readonly { - readonly coupon?: string; - readonly discount?: string; + readonly coupon?: string + readonly discount?: string }[] > & - Partial<"">; + Partial<''> /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** * period * @description The period associated with this invoice item. */ readonly period?: { /** Format: unix-time */ - readonly end: number; + readonly end: number /** Format: unix-time */ - readonly start: number; - }; + readonly start: number + } /** @description The ID of the price object. */ - readonly price?: string; + readonly price?: string /** * one_time_price_data * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. */ readonly price_data?: { - readonly currency: string; - readonly product: string; + readonly currency: string + readonly product: string /** @enum {string} */ - readonly tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - readonly unit_amount?: number; + readonly tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + readonly unit_amount?: number /** Format: decimal */ - readonly unit_amount_decimal?: string; - }; + readonly unit_amount_decimal?: string + } /** @description Non-negative integer. The quantity of units for the invoice item. */ - readonly quantity?: number; + readonly quantity?: number /** @description 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. Pass an empty string to remove previously-defined tax rates. */ - readonly tax_rates?: Partial & Partial<"">; + readonly tax_rates?: Partial & Partial<''> /** @description The integer unit amount in %s of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount. */ - readonly unit_amount?: number; + readonly unit_amount?: number /** * Format: decimal * @description Same as `unit_amount`, but accepts a decimal value in %s with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. */ - readonly unit_amount_decimal?: string; - }; - }; - }; - }; + readonly unit_amount_decimal?: string + } + } + } + } /**

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.

*/ readonly DeleteInvoiceitemsInvoiceitem: { readonly parameters: { readonly path: { - readonly invoiceitem: string; - }; - }; + readonly invoiceitem: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["deleted_invoiceitem"]; - }; - }; + readonly 'application/json': components['schemas']['deleted_invoiceitem'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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.

*/ readonly GetInvoices: { readonly parameters: { readonly query: { /** The collection method of the invoice to retrieve. Either `charge_automatically` or `send_invoice`. */ - readonly collection_method?: "charge_automatically" | "send_invoice"; + readonly collection_method?: 'charge_automatically' | 'send_invoice' readonly created?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** Only return invoices for the customer specified by this customer ID. */ - readonly customer?: string; + readonly customer?: string readonly due_date?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview) */ - readonly status?: "draft" | "open" | "paid" | "uncollectible" | "void"; + readonly status?: 'draft' | 'open' | 'paid' | 'uncollectible' | 'void' /** Only return invoices for the subscription specified by this subscription ID. */ - readonly subscription?: string; - }; - }; + readonly subscription?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["invoice"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['invoice'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

This endpoint creates a draft invoice for a given customer. The draft invoice created pulls in all pending invoice items on that customer, including prorations. The invoice remains a draft until you finalize the invoice, which allows you to pay or send the invoice to your customers.

*/ readonly PostInvoices: { readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["invoice"]; - }; - }; + readonly 'application/json': components['schemas']['invoice'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description The account tax IDs associated with the invoice. Only editable when the invoice is a draft. */ - readonly account_tax_ids?: Partial & Partial<"">; + readonly account_tax_ids?: Partial & Partial<''> /** @description A fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees). */ - readonly application_fee_amount?: number; + readonly application_fee_amount?: number /** @description Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice. When `false`, the invoice's state will not automatically advance without an explicit action. */ - readonly auto_advance?: boolean; + readonly auto_advance?: boolean /** * automatic_tax_param * @description Settings for automatic tax lookup for this invoice. */ readonly automatic_tax?: { - readonly enabled: boolean; - }; + readonly enabled: boolean + } /** * @description 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. Defaults to `charge_automatically`. * @enum {string} */ - readonly collection_method?: "charge_automatically" | "send_invoice"; + readonly collection_method?: 'charge_automatically' | 'send_invoice' /** @description A list of up to 4 custom fields to be displayed on the invoice. */ readonly custom_fields?: Partial< readonly { - readonly name: string; - readonly value: string; + readonly name: string + readonly value: string }[] > & - Partial<"">; + Partial<''> /** @description The ID of the customer who will be billed. */ - readonly customer: string; + readonly customer: string /** @description The number of days from when the invoice is created until it is due. Valid only for invoices where `collection_method=send_invoice`. */ - readonly days_until_due?: number; + readonly days_until_due?: number /** @description 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. */ - readonly default_payment_method?: string; + readonly default_payment_method?: string /** @description 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. */ - readonly default_source?: string; + readonly default_source?: string /** @description The tax rates that will apply to any line item that does not have `tax_rates` set. */ - readonly default_tax_rates?: readonly string[]; + readonly default_tax_rates?: readonly string[] /** @description An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. */ - readonly description?: string; + readonly description?: string /** @description The coupons to redeem into discounts for the invoice. If not specified, inherits the discount from the invoice's customer. Pass an empty string to avoid inheriting any discounts. */ readonly discounts?: Partial< readonly { - readonly coupon?: string; - readonly discount?: string; + readonly coupon?: string + readonly discount?: string }[] > & - Partial<"">; + Partial<''> /** * Format: unix-time * @description The date on which payment for this invoice is due. Valid only for invoices where `collection_method=send_invoice`. */ - readonly due_date?: number; + readonly due_date?: number /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description Footer to be displayed on the invoice. */ - readonly footer?: string; + readonly footer?: string /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description 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. */ - readonly on_behalf_of?: string; + readonly on_behalf_of?: string /** * payment_settings * @description Configuration settings for the PaymentIntent that is generated when the invoice is finalized. @@ -26370,60 +26132,60 @@ export interface operations { /** mandate_options_param */ readonly mandate_options?: { /** @enum {string} */ - readonly transaction_type?: "business" | "personal"; - }; + readonly transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - readonly verification_method?: "automatic" | "instant" | "microdeposits"; + readonly verification_method?: 'automatic' | 'instant' | 'microdeposits' }> & - Partial<"">; + Partial<''> readonly bancontact?: Partial<{ /** @enum {string} */ - readonly preferred_language?: "de" | "en" | "fr" | "nl"; + readonly preferred_language?: 'de' | 'en' | 'fr' | 'nl' }> & - Partial<"">; + Partial<''> readonly card?: Partial<{ /** @enum {string} */ - readonly request_three_d_secure?: "any" | "automatic"; + readonly request_three_d_secure?: 'any' | 'automatic' }> & - Partial<"">; - }; + Partial<''> + } readonly payment_method_types?: Partial< readonly ( - | "ach_credit_transfer" - | "ach_debit" - | "acss_debit" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "sepa_debit" - | "sofort" - | "wechat_pay" + | 'ach_credit_transfer' + | 'ach_debit' + | 'acss_debit' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' )[] > & - Partial<"">; - }; + Partial<''> + } /** @description Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`. */ - readonly statement_descriptor?: string; + readonly statement_descriptor?: string /** @description The ID of the subscription to invoice, if any. If not set, the created invoice will include all pending invoice items for the customer. If set, the created invoice will only include pending invoice items for that subscription and pending invoice items not associated with any subscription. The subscription's billing cycle and regular subscription events won't be affected. */ - readonly subscription?: string; + readonly subscription?: string /** * transfer_data_specs * @description If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge. */ readonly transfer_data?: { - readonly amount?: number; - readonly destination: string; - }; - }; - }; - }; - }; + readonly amount?: number + readonly destination: string + } + } + } + } + } /** *

At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.

* @@ -26436,184 +26198,184 @@ export interface operations { readonly query: { /** Settings for automatic tax lookup for this invoice preview. */ readonly automatic_tax?: { - readonly enabled: boolean; - }; + readonly enabled: boolean + } /** The code of the coupon to apply. If `subscription` or `subscription_items` is provided, the invoice returned will preview updating or creating a subscription with that coupon. Otherwise, it will preview applying that coupon to the customer for the next upcoming invoice from among the customer's subscriptions. The invoice can be previewed without a coupon by passing this value as an empty string. */ - readonly coupon?: string; + readonly coupon?: string /** The identifier of the customer whose upcoming invoice you'd like to retrieve. */ - readonly customer?: string; + readonly customer?: string /** Details about the customer you want to invoice or overrides for an existing customer. */ readonly customer_details?: { readonly address?: Partial<{ - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string }> & - Partial<"">; + Partial<''> readonly shipping?: Partial<{ /** optional_fields_address */ readonly address: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; - readonly name: string; - readonly phone?: string; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } + readonly name: string + readonly phone?: string }> & - Partial<"">; + Partial<''> /** tax_param */ readonly tax?: { - readonly ip_address?: Partial & Partial<"">; - }; + readonly ip_address?: Partial & Partial<''> + } /** @enum {string} */ - readonly tax_exempt?: "" | "exempt" | "none" | "reverse"; + readonly tax_exempt?: '' | 'exempt' | 'none' | 'reverse' readonly tax_ids?: readonly { /** @enum {string} */ readonly type: - | "ae_trn" - | "au_abn" - | "au_arn" - | "br_cnpj" - | "br_cpf" - | "ca_bn" - | "ca_gst_hst" - | "ca_pst_bc" - | "ca_pst_mb" - | "ca_pst_sk" - | "ca_qst" - | "ch_vat" - | "cl_tin" - | "es_cif" - | "eu_vat" - | "gb_vat" - | "ge_vat" - | "hk_br" - | "id_npwp" - | "il_vat" - | "in_gst" - | "is_vat" - | "jp_cn" - | "jp_rn" - | "kr_brn" - | "li_uid" - | "mx_rfc" - | "my_frp" - | "my_itn" - | "my_sst" - | "no_vat" - | "nz_gst" - | "ru_inn" - | "ru_kpp" - | "sa_vat" - | "sg_gst" - | "sg_uen" - | "th_vat" - | "tw_vat" - | "ua_vat" - | "us_ein" - | "za_vat"; - readonly value: string; - }[]; - }; + | 'ae_trn' + | 'au_abn' + | 'au_arn' + | 'br_cnpj' + | 'br_cpf' + | 'ca_bn' + | 'ca_gst_hst' + | 'ca_pst_bc' + | 'ca_pst_mb' + | 'ca_pst_sk' + | 'ca_qst' + | 'ch_vat' + | 'cl_tin' + | 'es_cif' + | 'eu_vat' + | 'gb_vat' + | 'ge_vat' + | 'hk_br' + | 'id_npwp' + | 'il_vat' + | 'in_gst' + | 'is_vat' + | 'jp_cn' + | 'jp_rn' + | 'kr_brn' + | 'li_uid' + | 'mx_rfc' + | 'my_frp' + | 'my_itn' + | 'my_sst' + | 'no_vat' + | 'nz_gst' + | 'ru_inn' + | 'ru_kpp' + | 'sa_vat' + | 'sg_gst' + | 'sg_uen' + | 'th_vat' + | 'tw_vat' + | 'ua_vat' + | 'us_ein' + | 'za_vat' + readonly value: string + }[] + } /** The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the customer or subscription. This only works for coupons directly applied to the invoice. To apply a coupon to a subscription, you must use the `coupon` parameter instead. Pass an empty string to avoid inheriting any discounts. To preview the upcoming invoice for a subscription that hasn't been created, use `coupon` instead. */ readonly discounts?: Partial< readonly { - readonly coupon?: string; - readonly discount?: string; + readonly coupon?: string + readonly discount?: string }[] > & - Partial<"">; + Partial<''> /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** List of invoice items to add or update in the upcoming invoice preview. */ readonly invoice_items?: readonly { - readonly amount?: number; - readonly currency?: string; - readonly description?: string; - readonly discountable?: boolean; + readonly amount?: number + readonly currency?: string + readonly description?: string + readonly discountable?: boolean readonly discounts?: Partial< readonly { - readonly coupon?: string; - readonly discount?: string; + readonly coupon?: string + readonly discount?: string }[] > & - Partial<"">; - readonly invoiceitem?: string; - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + Partial<''> + readonly invoiceitem?: string + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** period */ readonly period?: { /** Format: unix-time */ - readonly end: number; + readonly end: number /** Format: unix-time */ - readonly start: number; - }; - readonly price?: string; + readonly start: number + } + readonly price?: string /** one_time_price_data */ readonly price_data?: { - readonly currency: string; - readonly product: string; + readonly currency: string + readonly product: string /** @enum {string} */ - readonly tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - readonly unit_amount?: number; + readonly tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + readonly unit_amount?: number /** Format: decimal */ - readonly unit_amount_decimal?: string; - }; - readonly quantity?: number; - readonly tax_rates?: Partial & Partial<"">; - readonly unit_amount?: number; + readonly unit_amount_decimal?: string + } + readonly quantity?: number + readonly tax_rates?: Partial & Partial<''> + readonly unit_amount?: number /** Format: decimal */ - readonly unit_amount_decimal?: string; - }[]; + readonly unit_amount_decimal?: string + }[] /** The identifier of the unstarted schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields. */ - readonly schedule?: string; + readonly schedule?: string /** The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions. */ - readonly subscription?: string; + readonly subscription?: string /** 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`. */ - readonly subscription_billing_cycle_anchor?: Partial<"now" | "unchanged"> & Partial; + readonly subscription_billing_cycle_anchor?: Partial<'now' | 'unchanged'> & Partial /** Timestamp indicating when the subscription should be scheduled to cancel. Will prorate if within the current period and prorations have been enabled using `proration_behavior`. */ - readonly subscription_cancel_at?: Partial & Partial<"">; + readonly subscription_cancel_at?: Partial & Partial<''> /** Boolean indicating whether this subscription should cancel at the end of the current period. */ - readonly subscription_cancel_at_period_end?: boolean; + readonly subscription_cancel_at_period_end?: boolean /** This simulates the subscription being canceled or expired immediately. */ - readonly subscription_cancel_now?: boolean; + readonly subscription_cancel_now?: boolean /** 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. */ - readonly subscription_default_tax_rates?: Partial & Partial<"">; + readonly subscription_default_tax_rates?: Partial & Partial<''> /** A list of up to 20 subscription items, each with an attached price. */ readonly subscription_items?: readonly { readonly billing_thresholds?: Partial<{ - readonly usage_gte: number; + readonly usage_gte: number }> & - Partial<"">; - readonly clear_usage?: boolean; - readonly deleted?: boolean; - readonly id?: string; - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; - readonly price?: string; + Partial<''> + readonly clear_usage?: boolean + readonly deleted?: boolean + readonly id?: string + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> + readonly price?: string /** recurring_price_data */ readonly price_data?: { - readonly currency: string; - readonly product: string; + readonly currency: string + readonly product: string /** recurring_adhoc */ readonly recurring: { /** @enum {string} */ - readonly interval: "day" | "month" | "week" | "year"; - readonly interval_count?: number; - }; + readonly interval: 'day' | 'month' | 'week' | 'year' + readonly interval_count?: number + } /** @enum {string} */ - readonly tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - readonly unit_amount?: number; + readonly tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + readonly unit_amount?: number /** Format: decimal */ - readonly unit_amount_decimal?: string; - }; - readonly quantity?: number; - readonly tax_rates?: Partial & Partial<"">; - }[]; + readonly unit_amount_decimal?: string + } + readonly quantity?: number + readonly tax_rates?: Partial & Partial<''> + }[] /** * Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -26621,227 +26383,227 @@ export interface operations { * * Prorations can be disabled by passing `none`. */ - readonly subscription_proration_behavior?: "always_invoice" | "create_prorations" | "none"; + readonly subscription_proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** 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 cannot be before the subscription was on its current plan. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'. */ - readonly subscription_proration_date?: number; + readonly subscription_proration_date?: number /** Date a subscription is intended to start (can be future or past) */ - readonly subscription_start_date?: number; + readonly subscription_start_date?: number /** 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. */ - readonly subscription_trial_end?: Partial<"now"> & Partial; + readonly subscription_trial_end?: Partial<'now'> & Partial /** Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `subscription_trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `subscription_trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. */ - readonly subscription_trial_from_plan?: boolean; - }; - }; + readonly subscription_trial_from_plan?: boolean + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["invoice"]; - }; - }; + readonly 'application/json': components['schemas']['invoice'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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.

*/ readonly GetInvoicesUpcomingLines: { readonly parameters: { readonly query: { /** Settings for automatic tax lookup for this invoice preview. */ readonly automatic_tax?: { - readonly enabled: boolean; - }; + readonly enabled: boolean + } /** The code of the coupon to apply. If `subscription` or `subscription_items` is provided, the invoice returned will preview updating or creating a subscription with that coupon. Otherwise, it will preview applying that coupon to the customer for the next upcoming invoice from among the customer's subscriptions. The invoice can be previewed without a coupon by passing this value as an empty string. */ - readonly coupon?: string; + readonly coupon?: string /** The identifier of the customer whose upcoming invoice you'd like to retrieve. */ - readonly customer?: string; + readonly customer?: string /** Details about the customer you want to invoice or overrides for an existing customer. */ readonly customer_details?: { readonly address?: Partial<{ - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string }> & - Partial<"">; + Partial<''> readonly shipping?: Partial<{ /** optional_fields_address */ readonly address: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; - readonly name: string; - readonly phone?: string; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } + readonly name: string + readonly phone?: string }> & - Partial<"">; + Partial<''> /** tax_param */ readonly tax?: { - readonly ip_address?: Partial & Partial<"">; - }; + readonly ip_address?: Partial & Partial<''> + } /** @enum {string} */ - readonly tax_exempt?: "" | "exempt" | "none" | "reverse"; + readonly tax_exempt?: '' | 'exempt' | 'none' | 'reverse' readonly tax_ids?: readonly { /** @enum {string} */ readonly type: - | "ae_trn" - | "au_abn" - | "au_arn" - | "br_cnpj" - | "br_cpf" - | "ca_bn" - | "ca_gst_hst" - | "ca_pst_bc" - | "ca_pst_mb" - | "ca_pst_sk" - | "ca_qst" - | "ch_vat" - | "cl_tin" - | "es_cif" - | "eu_vat" - | "gb_vat" - | "ge_vat" - | "hk_br" - | "id_npwp" - | "il_vat" - | "in_gst" - | "is_vat" - | "jp_cn" - | "jp_rn" - | "kr_brn" - | "li_uid" - | "mx_rfc" - | "my_frp" - | "my_itn" - | "my_sst" - | "no_vat" - | "nz_gst" - | "ru_inn" - | "ru_kpp" - | "sa_vat" - | "sg_gst" - | "sg_uen" - | "th_vat" - | "tw_vat" - | "ua_vat" - | "us_ein" - | "za_vat"; - readonly value: string; - }[]; - }; + | 'ae_trn' + | 'au_abn' + | 'au_arn' + | 'br_cnpj' + | 'br_cpf' + | 'ca_bn' + | 'ca_gst_hst' + | 'ca_pst_bc' + | 'ca_pst_mb' + | 'ca_pst_sk' + | 'ca_qst' + | 'ch_vat' + | 'cl_tin' + | 'es_cif' + | 'eu_vat' + | 'gb_vat' + | 'ge_vat' + | 'hk_br' + | 'id_npwp' + | 'il_vat' + | 'in_gst' + | 'is_vat' + | 'jp_cn' + | 'jp_rn' + | 'kr_brn' + | 'li_uid' + | 'mx_rfc' + | 'my_frp' + | 'my_itn' + | 'my_sst' + | 'no_vat' + | 'nz_gst' + | 'ru_inn' + | 'ru_kpp' + | 'sa_vat' + | 'sg_gst' + | 'sg_uen' + | 'th_vat' + | 'tw_vat' + | 'ua_vat' + | 'us_ein' + | 'za_vat' + readonly value: string + }[] + } /** The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the customer or subscription. This only works for coupons directly applied to the invoice. To apply a coupon to a subscription, you must use the `coupon` parameter instead. Pass an empty string to avoid inheriting any discounts. To preview the upcoming invoice for a subscription that hasn't been created, use `coupon` instead. */ readonly discounts?: Partial< readonly { - readonly coupon?: string; - readonly discount?: string; + readonly coupon?: string + readonly discount?: string }[] > & - Partial<"">; + Partial<''> /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** List of invoice items to add or update in the upcoming invoice preview. */ readonly invoice_items?: readonly { - readonly amount?: number; - readonly currency?: string; - readonly description?: string; - readonly discountable?: boolean; + readonly amount?: number + readonly currency?: string + readonly description?: string + readonly discountable?: boolean readonly discounts?: Partial< readonly { - readonly coupon?: string; - readonly discount?: string; + readonly coupon?: string + readonly discount?: string }[] > & - Partial<"">; - readonly invoiceitem?: string; - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + Partial<''> + readonly invoiceitem?: string + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** period */ readonly period?: { /** Format: unix-time */ - readonly end: number; + readonly end: number /** Format: unix-time */ - readonly start: number; - }; - readonly price?: string; + readonly start: number + } + readonly price?: string /** one_time_price_data */ readonly price_data?: { - readonly currency: string; - readonly product: string; + readonly currency: string + readonly product: string /** @enum {string} */ - readonly tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - readonly unit_amount?: number; + readonly tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + readonly unit_amount?: number /** Format: decimal */ - readonly unit_amount_decimal?: string; - }; - readonly quantity?: number; - readonly tax_rates?: Partial & Partial<"">; - readonly unit_amount?: number; + readonly unit_amount_decimal?: string + } + readonly quantity?: number + readonly tax_rates?: Partial & Partial<''> + readonly unit_amount?: number /** Format: decimal */ - readonly unit_amount_decimal?: string; - }[]; + readonly unit_amount_decimal?: string + }[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** The identifier of the unstarted schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields. */ - readonly schedule?: string; + readonly schedule?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions. */ - readonly subscription?: string; + readonly subscription?: string /** 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`. */ - readonly subscription_billing_cycle_anchor?: Partial<"now" | "unchanged"> & Partial; + readonly subscription_billing_cycle_anchor?: Partial<'now' | 'unchanged'> & Partial /** Timestamp indicating when the subscription should be scheduled to cancel. Will prorate if within the current period and prorations have been enabled using `proration_behavior`. */ - readonly subscription_cancel_at?: Partial & Partial<"">; + readonly subscription_cancel_at?: Partial & Partial<''> /** Boolean indicating whether this subscription should cancel at the end of the current period. */ - readonly subscription_cancel_at_period_end?: boolean; + readonly subscription_cancel_at_period_end?: boolean /** This simulates the subscription being canceled or expired immediately. */ - readonly subscription_cancel_now?: boolean; + readonly subscription_cancel_now?: boolean /** 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. */ - readonly subscription_default_tax_rates?: Partial & Partial<"">; + readonly subscription_default_tax_rates?: Partial & Partial<''> /** A list of up to 20 subscription items, each with an attached price. */ readonly subscription_items?: readonly { readonly billing_thresholds?: Partial<{ - readonly usage_gte: number; + readonly usage_gte: number }> & - Partial<"">; - readonly clear_usage?: boolean; - readonly deleted?: boolean; - readonly id?: string; - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; - readonly price?: string; + Partial<''> + readonly clear_usage?: boolean + readonly deleted?: boolean + readonly id?: string + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> + readonly price?: string /** recurring_price_data */ readonly price_data?: { - readonly currency: string; - readonly product: string; + readonly currency: string + readonly product: string /** recurring_adhoc */ readonly recurring: { /** @enum {string} */ - readonly interval: "day" | "month" | "week" | "year"; - readonly interval_count?: number; - }; + readonly interval: 'day' | 'month' | 'week' | 'year' + readonly interval_count?: number + } /** @enum {string} */ - readonly tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - readonly unit_amount?: number; + readonly tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + readonly unit_amount?: number /** Format: decimal */ - readonly unit_amount_decimal?: string; - }; - readonly quantity?: number; - readonly tax_rates?: Partial & Partial<"">; - }[]; + readonly unit_amount_decimal?: string + } + readonly quantity?: number + readonly tax_rates?: Partial & Partial<''> + }[] /** * Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -26849,80 +26611,80 @@ export interface operations { * * Prorations can be disabled by passing `none`. */ - readonly subscription_proration_behavior?: "always_invoice" | "create_prorations" | "none"; + readonly subscription_proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** 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 cannot be before the subscription was on its current plan. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'. */ - readonly subscription_proration_date?: number; + readonly subscription_proration_date?: number /** Date a subscription is intended to start (can be future or past) */ - readonly subscription_start_date?: number; + readonly subscription_start_date?: number /** 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. */ - readonly subscription_trial_end?: Partial<"now"> & Partial; + readonly subscription_trial_end?: Partial<'now'> & Partial /** Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `subscription_trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `subscription_trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. */ - readonly subscription_trial_from_plan?: boolean; - }; - }; + readonly subscription_trial_from_plan?: boolean + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Details about each object. */ - readonly data: readonly components["schemas"]["line_item"][]; + readonly data: readonly components['schemas']['line_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Retrieves the invoice with the given ID.

*/ readonly GetInvoicesInvoice: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly invoice: string; - }; - }; + readonly invoice: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["invoice"]; - }; - }; + readonly 'application/json': components['schemas']['invoice'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /** *

Draft invoices are fully editable. Once an invoice is finalized, * monetary values, as well as collection_method, become uneditable.

@@ -26934,83 +26696,83 @@ export interface operations { readonly PostInvoicesInvoice: { readonly parameters: { readonly path: { - readonly invoice: string; - }; - }; + readonly invoice: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["invoice"]; - }; - }; + readonly 'application/json': components['schemas']['invoice'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description The account tax IDs associated with the invoice. Only editable when the invoice is a draft. */ - readonly account_tax_ids?: Partial & Partial<"">; + readonly account_tax_ids?: Partial & Partial<''> /** @description A fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees). */ - readonly application_fee_amount?: number; + readonly application_fee_amount?: number /** @description Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice. */ - readonly auto_advance?: boolean; + readonly auto_advance?: boolean /** * automatic_tax_param * @description Settings for automatic tax lookup for this invoice. */ readonly automatic_tax?: { - readonly enabled: boolean; - }; + readonly enabled: boolean + } /** * @description Either `charge_automatically` or `send_invoice`. This field can be updated only on `draft` invoices. * @enum {string} */ - readonly collection_method?: "charge_automatically" | "send_invoice"; + readonly collection_method?: 'charge_automatically' | 'send_invoice' /** @description A list of up to 4 custom fields to be displayed on the invoice. If a value for `custom_fields` is specified, the list specified will replace the existing custom field list on this invoice. Pass an empty string to remove previously-defined fields. */ readonly custom_fields?: Partial< readonly { - readonly name: string; - readonly value: string; + readonly name: string + readonly value: string }[] > & - Partial<"">; + Partial<''> /** @description The number of days from which the invoice is created until it is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices. */ - readonly days_until_due?: number; + readonly days_until_due?: number /** @description 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. */ - readonly default_payment_method?: string; + readonly default_payment_method?: string /** @description 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. */ - readonly default_source?: string; + readonly default_source?: string /** @description The tax rates that will apply to any line item that does not have `tax_rates` set. Pass an empty string to remove previously-defined tax rates. */ - readonly default_tax_rates?: Partial & Partial<"">; + readonly default_tax_rates?: Partial & Partial<''> /** @description An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. */ - readonly description?: string; + readonly description?: string /** @description The discounts that will apply to the invoice. Pass an empty string to remove previously-defined discounts. */ readonly discounts?: Partial< readonly { - readonly coupon?: string; - readonly discount?: string; + readonly coupon?: string + readonly discount?: string }[] > & - Partial<"">; + Partial<''> /** * Format: unix-time * @description The date on which payment for this invoice is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices. */ - readonly due_date?: number; + readonly due_date?: number /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description Footer to be displayed on the invoice. */ - readonly footer?: string; + readonly footer?: string /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description 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. */ - readonly on_behalf_of?: Partial & Partial<"">; + readonly on_behalf_of?: Partial & Partial<''> /** * payment_settings * @description Configuration settings for the PaymentIntent that is generated when the invoice is finalized. @@ -27022,238 +26784,238 @@ export interface operations { /** mandate_options_param */ readonly mandate_options?: { /** @enum {string} */ - readonly transaction_type?: "business" | "personal"; - }; + readonly transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - readonly verification_method?: "automatic" | "instant" | "microdeposits"; + readonly verification_method?: 'automatic' | 'instant' | 'microdeposits' }> & - Partial<"">; + Partial<''> readonly bancontact?: Partial<{ /** @enum {string} */ - readonly preferred_language?: "de" | "en" | "fr" | "nl"; + readonly preferred_language?: 'de' | 'en' | 'fr' | 'nl' }> & - Partial<"">; + Partial<''> readonly card?: Partial<{ /** @enum {string} */ - readonly request_three_d_secure?: "any" | "automatic"; + readonly request_three_d_secure?: 'any' | 'automatic' }> & - Partial<"">; - }; + Partial<''> + } readonly payment_method_types?: Partial< readonly ( - | "ach_credit_transfer" - | "ach_debit" - | "acss_debit" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "sepa_debit" - | "sofort" - | "wechat_pay" + | 'ach_credit_transfer' + | 'ach_debit' + | 'acss_debit' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' )[] > & - Partial<"">; - }; + Partial<''> + } /** @description Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`. */ - readonly statement_descriptor?: string; + readonly statement_descriptor?: string /** @description If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge. This will be unset if you POST an empty value. */ readonly transfer_data?: Partial<{ - readonly amount?: number; - readonly destination: string; + readonly amount?: number + readonly destination: string }> & - Partial<"">; - }; - }; - }; - }; + Partial<''> + } + } + } + } /**

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.

*/ readonly DeleteInvoicesInvoice: { readonly parameters: { readonly path: { - readonly invoice: string; - }; - }; + readonly invoice: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["deleted_invoice"]; - }; - }; + readonly 'application/json': components['schemas']['deleted_invoice'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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.

*/ readonly PostInvoicesInvoiceFinalize: { readonly parameters: { readonly path: { - readonly invoice: string; - }; - }; + readonly invoice: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["invoice"]; - }; - }; + readonly 'application/json': components['schemas']['invoice'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/invoicing/automatic-charging) of the invoice. When `false`, the invoice's state will not automatically advance without an explicit action. */ - readonly auto_advance?: boolean; + readonly auto_advance?: boolean /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } + } /**

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.

*/ readonly GetInvoicesInvoiceLines: { readonly parameters: { readonly query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; + readonly starting_after?: string + } readonly path: { - readonly invoice: string; - }; - }; + readonly invoice: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Details about each object. */ - readonly data: readonly components["schemas"]["line_item"][]; + readonly data: readonly components['schemas']['line_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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

*/ readonly PostInvoicesInvoiceMarkUncollectible: { readonly parameters: { readonly path: { - readonly invoice: string; - }; - }; + readonly invoice: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["invoice"]; - }; - }; + readonly 'application/json': components['schemas']['invoice'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } + } /**

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.

*/ readonly PostInvoicesInvoicePay: { readonly parameters: { readonly path: { - readonly invoice: string; - }; - }; + readonly invoice: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["invoice"]; - }; - }; + readonly 'application/json': components['schemas']['invoice'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** * @description In cases where the source used to pay the invoice has insufficient funds, passing `forgive=true` controls whether a charge should be attempted for the full amount available on the source, up to the amount to fully pay the invoice. This effectively forgives the difference between the amount available on the source and the amount due. * * Passing `forgive=false` will fail the charge if the source hasn't been pre-funded with the right amount. An example for this case is with ACH Credit Transfers and wires: if the amount wired is less than the amount due by a small amount, you might want to forgive the difference. Defaults to `false`. */ - readonly forgive?: boolean; + readonly forgive?: boolean /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `true` (off-session). */ - readonly off_session?: boolean; + readonly off_session?: boolean /** @description Boolean representing whether an invoice is paid outside of Stripe. This will result in no charge being made. Defaults to `false`. */ - readonly paid_out_of_band?: boolean; + readonly paid_out_of_band?: boolean /** @description A PaymentMethod to be charged. The PaymentMethod must be the ID of a PaymentMethod belonging to the customer associated with the invoice being paid. */ - readonly payment_method?: string; + readonly payment_method?: string /** @description A payment source to be charged. The source must be the ID of a source belonging to the customer associated with the invoice being paid. */ - readonly source?: string; - }; - }; - }; - }; + readonly source?: string + } + } + } + } /** *

Stripe will automatically send invoices to customers according to your subscriptions settings. However, if you’d like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.

* @@ -27262,109 +27024,109 @@ export interface operations { readonly PostInvoicesInvoiceSend: { readonly parameters: { readonly path: { - readonly invoice: string; - }; - }; + readonly invoice: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["invoice"]; - }; - }; + readonly 'application/json': components['schemas']['invoice'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } + } /**

Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.

*/ readonly PostInvoicesInvoiceVoid: { readonly parameters: { readonly path: { - readonly invoice: string; - }; - }; + readonly invoice: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["invoice"]; - }; - }; + readonly 'application/json': components['schemas']['invoice'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } + } /**

Returns a list of issuer fraud records.

*/ readonly GetIssuerFraudRecords: { readonly parameters: { readonly query: { /** Only return issuer fraud records for the charge specified by this charge ID. */ - readonly charge?: string; + readonly charge?: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["issuer_fraud_record"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['issuer_fraud_record'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /** *

Retrieves the details of an issuer fraud record that has previously been created.

* @@ -27374,300 +27136,300 @@ export interface operations { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly issuer_fraud_record: string; - }; - }; + readonly issuer_fraud_record: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["issuer_fraud_record"]; - }; - }; + readonly 'application/json': components['schemas']['issuer_fraud_record'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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.

*/ readonly GetIssuingAuthorizations: { readonly parameters: { readonly query: { /** Only return authorizations that belong to the given card. */ - readonly card?: string; + readonly card?: string /** Only return authorizations that belong to the given cardholder. */ - readonly cardholder?: string; + readonly cardholder?: string /** Only return authorizations that were created during the given date interval. */ readonly created?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** Only return authorizations with the given status. One of `pending`, `closed`, or `reversed`. */ - readonly status?: "closed" | "pending" | "reversed"; - }; - }; + readonly status?: 'closed' | 'pending' | 'reversed' + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["issuing.authorization"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['issuing.authorization'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Retrieves an Issuing Authorization object.

*/ readonly GetIssuingAuthorizationsAuthorization: { readonly parameters: { readonly path: { - readonly authorization: string; - }; + readonly authorization: string + } readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; + readonly expand?: readonly string[] + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["issuing.authorization"]; - }; - }; + readonly 'application/json': components['schemas']['issuing.authorization'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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

*/ readonly PostIssuingAuthorizationsAuthorization: { readonly parameters: { readonly path: { - readonly authorization: string; - }; - }; + readonly authorization: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["issuing.authorization"]; - }; - }; + readonly 'application/json': components['schemas']['issuing.authorization'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> + } + } + } + } /**

Approves a pending Issuing Authorization object. This request should be made within the timeout window of the real-time authorization flow.

*/ readonly PostIssuingAuthorizationsAuthorizationApprove: { readonly parameters: { readonly path: { - readonly authorization: string; - }; - }; + readonly authorization: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["issuing.authorization"]; - }; - }; + readonly 'application/json': components['schemas']['issuing.authorization'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description If the authorization's `pending_request.is_amount_controllable` property is `true`, you may provide this value to control how much to hold for the authorization. Must be positive (use [`decline`](https://stripe.com/docs/api/issuing/authorizations/decline) to decline an authorization request). */ - readonly amount?: number; + readonly amount?: number /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> + } + } + } + } /**

Declines a pending Issuing Authorization object. This request should be made within the timeout window of the real time authorization flow.

*/ readonly PostIssuingAuthorizationsAuthorizationDecline: { readonly parameters: { readonly path: { - readonly authorization: string; - }; - }; + readonly authorization: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["issuing.authorization"]; - }; - }; + readonly 'application/json': components['schemas']['issuing.authorization'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> + } + } + } + } /**

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

*/ readonly GetIssuingCardholders: { readonly parameters: { readonly query: { /** Only return cardholders that were created during the given date interval. */ readonly created?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** Only return cardholders that have the given email address. */ - readonly email?: string; + readonly email?: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** Only return cardholders that have the given phone number. */ - readonly phone_number?: string; + readonly phone_number?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** Only return cardholders that have the given status. One of `active`, `inactive`, or `blocked`. */ - readonly status?: "active" | "blocked" | "inactive"; + readonly status?: 'active' | 'blocked' | 'inactive' /** Only return cardholders that have the given type. One of `individual` or `company`. */ - readonly type?: "company" | "individual"; - }; - }; + readonly type?: 'company' | 'individual' + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["issuing.cardholder"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['issuing.cardholder'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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

*/ readonly PostIssuingCardholders: { readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["issuing.cardholder"]; - }; - }; + readonly 'application/json': components['schemas']['issuing.cardholder'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** * billing_specs * @description The cardholder's billing address. @@ -27675,25 +27437,25 @@ export interface operations { readonly billing: { /** required_address */ readonly address: { - readonly city: string; - readonly country: string; - readonly line1: string; - readonly line2?: string; - readonly postal_code: string; - readonly state?: string; - }; - }; + readonly city: string + readonly country: string + readonly line1: string + readonly line2?: string + readonly postal_code: string + readonly state?: string + } + } /** * company_param * @description Additional information about a `company` cardholder. */ readonly company?: { - readonly tax_id?: string; - }; + readonly tax_id?: string + } /** @description The cardholder's email address. */ - readonly email?: string; + readonly email?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** * individual_param * @description Additional information about an `individual` cardholder. @@ -27701,978 +27463,978 @@ export interface operations { readonly individual?: { /** date_of_birth_specs */ readonly dob?: { - readonly day: number; - readonly month: number; - readonly year: number; - }; - readonly first_name: string; - readonly last_name: string; + readonly day: number + readonly month: number + readonly year: number + } + readonly first_name: string + readonly last_name: string /** person_verification_param */ readonly verification?: { /** person_verification_document_param */ readonly document?: { - readonly back?: string; - readonly front?: string; - }; - }; - }; + readonly back?: string + readonly front?: string + } + } + } /** @description 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`. */ - readonly metadata?: { readonly [key: string]: string }; + readonly metadata?: { readonly [key: string]: string } /** @description The cardholder's name. This will be printed on cards issued to them. The maximum length of this field is 24 characters. */ - readonly name: string; + readonly name: string /** @description The cardholder's phone number. This will be transformed to [E.164](https://en.wikipedia.org/wiki/E.164) if it is not provided in that format already. 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. */ - readonly phone_number?: string; + readonly phone_number?: string /** * authorization_controls_param_v2 * @description Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details. */ readonly spending_controls?: { readonly allowed_categories?: readonly ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] readonly blocked_categories?: readonly ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] readonly spending_limits?: readonly { - readonly amount: number; + readonly amount: number readonly categories?: readonly ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] /** @enum {string} */ - readonly interval: "all_time" | "daily" | "monthly" | "per_authorization" | "weekly" | "yearly"; - }[]; - readonly spending_limits_currency?: string; - }; + readonly interval: 'all_time' | 'daily' | 'monthly' | 'per_authorization' | 'weekly' | 'yearly' + }[] + readonly spending_limits_currency?: string + } /** * @description Specifies whether to permit authorizations on this cardholder's cards. Defaults to `active`. * @enum {string} */ - readonly status?: "active" | "inactive"; + readonly status?: 'active' | 'inactive' /** * @description One of `individual` or `company`. * @enum {string} */ - readonly type: "company" | "individual"; - }; - }; - }; - }; + readonly type: 'company' | 'individual' + } + } + } + } /**

Retrieves an Issuing Cardholder object.

*/ readonly GetIssuingCardholdersCardholder: { readonly parameters: { readonly path: { - readonly cardholder: string; - }; + readonly cardholder: string + } readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; + readonly expand?: readonly string[] + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["issuing.cardholder"]; - }; - }; + readonly 'application/json': components['schemas']['issuing.cardholder'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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

*/ readonly PostIssuingCardholdersCardholder: { readonly parameters: { readonly path: { - readonly cardholder: string; - }; - }; + readonly cardholder: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["issuing.cardholder"]; - }; - }; + readonly 'application/json': components['schemas']['issuing.cardholder'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** * billing_specs * @description The cardholder's billing address. @@ -28680,25 +28442,25 @@ export interface operations { readonly billing?: { /** required_address */ readonly address: { - readonly city: string; - readonly country: string; - readonly line1: string; - readonly line2?: string; - readonly postal_code: string; - readonly state?: string; - }; - }; + readonly city: string + readonly country: string + readonly line1: string + readonly line2?: string + readonly postal_code: string + readonly state?: string + } + } /** * company_param * @description Additional information about a `company` cardholder. */ readonly company?: { - readonly tax_id?: string; - }; + readonly tax_id?: string + } /** @description The cardholder's email address. */ - readonly email?: string; + readonly email?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** * individual_param * @description Additional information about an `individual` cardholder. @@ -28706,1015 +28468,1015 @@ export interface operations { readonly individual?: { /** date_of_birth_specs */ readonly dob?: { - readonly day: number; - readonly month: number; - readonly year: number; - }; - readonly first_name: string; - readonly last_name: string; + readonly day: number + readonly month: number + readonly year: number + } + readonly first_name: string + readonly last_name: string /** person_verification_param */ readonly verification?: { /** person_verification_document_param */ readonly document?: { - readonly back?: string; - readonly front?: string; - }; - }; - }; + readonly back?: string + readonly front?: string + } + } + } /** @description 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`. */ - readonly metadata?: { readonly [key: string]: string }; + readonly metadata?: { readonly [key: string]: string } /** @description 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) for more details. */ - readonly phone_number?: string; + readonly phone_number?: string /** * authorization_controls_param_v2 * @description Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details. */ readonly spending_controls?: { readonly allowed_categories?: readonly ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] readonly blocked_categories?: readonly ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] readonly spending_limits?: readonly { - readonly amount: number; + readonly amount: number readonly categories?: readonly ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] /** @enum {string} */ - readonly interval: "all_time" | "daily" | "monthly" | "per_authorization" | "weekly" | "yearly"; - }[]; - readonly spending_limits_currency?: string; - }; + readonly interval: 'all_time' | 'daily' | 'monthly' | 'per_authorization' | 'weekly' | 'yearly' + }[] + readonly spending_limits_currency?: string + } /** * @description Specifies whether to permit authorizations on this cardholder's cards. * @enum {string} */ - readonly status?: "active" | "inactive"; - }; - }; - }; - }; + readonly status?: 'active' | 'inactive' + } + } + } + } /**

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

*/ readonly GetIssuingCards: { readonly parameters: { readonly query: { /** Only return cards belonging to the Cardholder with the provided ID. */ - readonly cardholder?: string; + readonly cardholder?: string /** Only return cards that were issued during the given date interval. */ readonly created?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Only return cards that have the given expiration month. */ - readonly exp_month?: number; + readonly exp_month?: number /** Only return cards that have the given expiration year. */ - readonly exp_year?: number; + readonly exp_year?: number /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** Only return cards that have the given last four digits. */ - readonly last4?: string; + readonly last4?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** Only return cards that have the given status. One of `active`, `inactive`, or `canceled`. */ - readonly status?: "active" | "canceled" | "inactive"; + readonly status?: 'active' | 'canceled' | 'inactive' /** Only return cards that have the given type. One of `virtual` or `physical`. */ - readonly type?: "physical" | "virtual"; - }; - }; + readonly type?: 'physical' | 'virtual' + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["issuing.card"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['issuing.card'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Creates an Issuing Card object.

*/ readonly PostIssuingCards: { readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["issuing.card"]; - }; - }; + readonly 'application/json': components['schemas']['issuing.card'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description The [Cardholder](https://stripe.com/docs/api#issuing_cardholder_object) object with which the card will be associated. */ - readonly cardholder?: string; + readonly cardholder?: string /** @description The currency for the card. */ - readonly currency: string; + readonly currency: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: { readonly [key: string]: string }; + readonly metadata?: { readonly [key: string]: string } /** @description The card this is meant to be a replacement for (if any). */ - readonly replacement_for?: string; + readonly replacement_for?: string /** * @description If `replacement_for` is specified, this should indicate why that card is being replaced. * @enum {string} */ - readonly replacement_reason?: "damaged" | "expired" | "lost" | "stolen"; + readonly replacement_reason?: 'damaged' | 'expired' | 'lost' | 'stolen' /** * shipping_specs * @description The address where the card will be shipped. @@ -29722,2702 +29484,2702 @@ export interface operations { readonly shipping?: { /** required_address */ readonly address: { - readonly city: string; - readonly country: string; - readonly line1: string; - readonly line2?: string; - readonly postal_code: string; - readonly state?: string; - }; - readonly name: string; + readonly city: string + readonly country: string + readonly line1: string + readonly line2?: string + readonly postal_code: string + readonly state?: string + } + readonly name: string /** @enum {string} */ - readonly service?: "express" | "priority" | "standard"; + readonly service?: 'express' | 'priority' | 'standard' /** @enum {string} */ - readonly type?: "bulk" | "individual"; - }; + readonly type?: 'bulk' | 'individual' + } /** * authorization_controls_param * @description Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details. */ readonly spending_controls?: { readonly allowed_categories?: readonly ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] readonly blocked_categories?: readonly ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] readonly spending_limits?: readonly { - readonly amount: number; + readonly amount: number readonly categories?: readonly ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] /** @enum {string} */ - readonly interval: "all_time" | "daily" | "monthly" | "per_authorization" | "weekly" | "yearly"; - }[]; - }; + readonly interval: 'all_time' | 'daily' | 'monthly' | 'per_authorization' | 'weekly' | 'yearly' + }[] + } /** * @description Whether authorizations can be approved on this card. Defaults to `inactive`. * @enum {string} */ - readonly status?: "active" | "inactive"; + readonly status?: 'active' | 'inactive' /** * @description The type of card to issue. Possible values are `physical` or `virtual`. * @enum {string} */ - readonly type: "physical" | "virtual"; - }; - }; - }; - }; + readonly type: 'physical' | 'virtual' + } + } + } + } /**

Retrieves an Issuing Card object.

*/ readonly GetIssuingCardsCard: { readonly parameters: { readonly path: { - readonly card: string; - }; + readonly card: string + } readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; + readonly expand?: readonly string[] + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["issuing.card"]; - }; - }; + readonly 'application/json': components['schemas']['issuing.card'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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

*/ readonly PostIssuingCardsCard: { readonly parameters: { readonly path: { - readonly card: string; - }; - }; + readonly card: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["issuing.card"]; - }; - }; + readonly 'application/json': components['schemas']['issuing.card'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** * @description Reason why the `status` of this card is `canceled`. * @enum {string} */ - readonly cancellation_reason?: "lost" | "stolen"; + readonly cancellation_reason?: 'lost' | 'stolen' /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** * encrypted_pin_param * @description The desired new PIN for this card. */ readonly pin?: { - readonly encrypted_number?: string; - }; + readonly encrypted_number?: string + } /** * authorization_controls_param * @description Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details. */ readonly spending_controls?: { readonly allowed_categories?: readonly ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] readonly blocked_categories?: readonly ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] readonly spending_limits?: readonly { - readonly amount: number; + readonly amount: number readonly categories?: readonly ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] /** @enum {string} */ - readonly interval: "all_time" | "daily" | "monthly" | "per_authorization" | "weekly" | "yearly"; - }[]; - }; + readonly interval: 'all_time' | 'daily' | 'monthly' | 'per_authorization' | 'weekly' | 'yearly' + }[] + } /** * @description Dictates whether authorizations can be approved on this card. If this card is being canceled because it was lost or stolen, this information should be provided as `cancellation_reason`. * @enum {string} */ - readonly status?: "active" | "canceled" | "inactive"; - }; - }; - }; - }; + readonly status?: 'active' | 'canceled' | 'inactive' + } + } + } + } /**

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

*/ readonly GetIssuingDisputes: { readonly parameters: { readonly query: { /** Select Issuing disputes that were created during the given date interval. */ readonly created?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** Select Issuing disputes with the given status. */ - readonly status?: "expired" | "lost" | "submitted" | "unsubmitted" | "won"; + readonly status?: 'expired' | 'lost' | 'submitted' | 'unsubmitted' | 'won' /** Select the Issuing dispute for the given transaction. */ - readonly transaction?: string; - }; - }; + readonly transaction?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["issuing.dispute"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['issuing.dispute'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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.

*/ readonly PostIssuingDisputes: { readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["issuing.dispute"]; - }; - }; + readonly 'application/json': components['schemas']['issuing.dispute'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** * evidence_param * @description Evidence provided for the dispute. */ readonly evidence?: { readonly canceled?: Partial<{ - readonly additional_documentation?: Partial & Partial<"">; - readonly canceled_at?: Partial & Partial<"">; - readonly cancellation_policy_provided?: Partial & Partial<"">; - readonly cancellation_reason?: string; - readonly expected_at?: Partial & Partial<"">; - readonly explanation?: string; - readonly product_description?: string; + readonly additional_documentation?: Partial & Partial<''> + readonly canceled_at?: Partial & Partial<''> + readonly cancellation_policy_provided?: Partial & Partial<''> + readonly cancellation_reason?: string + readonly expected_at?: Partial & Partial<''> + readonly explanation?: string + readonly product_description?: string /** @enum {string} */ - readonly product_type?: "" | "merchandise" | "service"; + readonly product_type?: '' | 'merchandise' | 'service' /** @enum {string} */ - readonly return_status?: "" | "merchant_rejected" | "successful"; - readonly returned_at?: Partial & Partial<"">; + readonly return_status?: '' | 'merchant_rejected' | 'successful' + readonly returned_at?: Partial & Partial<''> }> & - Partial<"">; + Partial<''> readonly duplicate?: Partial<{ - readonly additional_documentation?: Partial & Partial<"">; - readonly card_statement?: Partial & Partial<"">; - readonly cash_receipt?: Partial & Partial<"">; - readonly check_image?: Partial & Partial<"">; - readonly explanation?: string; - readonly original_transaction?: string; + readonly additional_documentation?: Partial & Partial<''> + readonly card_statement?: Partial & Partial<''> + readonly cash_receipt?: Partial & Partial<''> + readonly check_image?: Partial & Partial<''> + readonly explanation?: string + readonly original_transaction?: string }> & - Partial<"">; + Partial<''> readonly fraudulent?: Partial<{ - readonly additional_documentation?: Partial & Partial<"">; - readonly explanation?: string; + readonly additional_documentation?: Partial & Partial<''> + readonly explanation?: string }> & - Partial<"">; + Partial<''> readonly merchandise_not_as_described?: Partial<{ - readonly additional_documentation?: Partial & Partial<"">; - readonly explanation?: string; - readonly received_at?: Partial & Partial<"">; - readonly return_description?: string; + readonly additional_documentation?: Partial & Partial<''> + readonly explanation?: string + readonly received_at?: Partial & Partial<''> + readonly return_description?: string /** @enum {string} */ - readonly return_status?: "" | "merchant_rejected" | "successful"; - readonly returned_at?: Partial & Partial<"">; + readonly return_status?: '' | 'merchant_rejected' | 'successful' + readonly returned_at?: Partial & Partial<''> }> & - Partial<"">; + Partial<''> readonly not_received?: Partial<{ - readonly additional_documentation?: Partial & Partial<"">; - readonly expected_at?: Partial & Partial<"">; - readonly explanation?: string; - readonly product_description?: string; + readonly additional_documentation?: Partial & Partial<''> + readonly expected_at?: Partial & Partial<''> + readonly explanation?: string + readonly product_description?: string /** @enum {string} */ - readonly product_type?: "" | "merchandise" | "service"; + readonly product_type?: '' | 'merchandise' | 'service' }> & - Partial<"">; + Partial<''> readonly other?: Partial<{ - readonly additional_documentation?: Partial & Partial<"">; - readonly explanation?: string; - readonly product_description?: string; + readonly additional_documentation?: Partial & Partial<''> + readonly explanation?: string + readonly product_description?: string /** @enum {string} */ - readonly product_type?: "" | "merchandise" | "service"; + readonly product_type?: '' | 'merchandise' | 'service' }> & - Partial<"">; + Partial<''> /** @enum {string} */ readonly reason?: - | "canceled" - | "duplicate" - | "fraudulent" - | "merchandise_not_as_described" - | "not_received" - | "other" - | "service_not_as_described"; + | 'canceled' + | 'duplicate' + | 'fraudulent' + | 'merchandise_not_as_described' + | 'not_received' + | 'other' + | 'service_not_as_described' readonly service_not_as_described?: Partial<{ - readonly additional_documentation?: Partial & Partial<"">; - readonly canceled_at?: Partial & Partial<"">; - readonly cancellation_reason?: string; - readonly explanation?: string; - readonly received_at?: Partial & Partial<"">; + readonly additional_documentation?: Partial & Partial<''> + readonly canceled_at?: Partial & Partial<''> + readonly cancellation_reason?: string + readonly explanation?: string + readonly received_at?: Partial & Partial<''> }> & - Partial<"">; - }; + Partial<''> + } /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: { readonly [key: string]: string }; + readonly metadata?: { readonly [key: string]: string } /** @description The ID of the issuing transaction to create a dispute for. */ - readonly transaction: string; - }; - }; - }; - }; + readonly transaction: string + } + } + } + } /**

Retrieves an Issuing Dispute object.

*/ readonly GetIssuingDisputesDispute: { readonly parameters: { readonly path: { - readonly dispute: string; - }; + readonly dispute: string + } readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; + readonly expand?: readonly string[] + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["issuing.dispute"]; - }; - }; + readonly 'application/json': components['schemas']['issuing.dispute'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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.

*/ readonly PostIssuingDisputesDispute: { readonly parameters: { readonly path: { - readonly dispute: string; - }; - }; + readonly dispute: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["issuing.dispute"]; - }; - }; + readonly 'application/json': components['schemas']['issuing.dispute'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** * evidence_param * @description Evidence provided for the dispute. */ readonly evidence?: { readonly canceled?: Partial<{ - readonly additional_documentation?: Partial & Partial<"">; - readonly canceled_at?: Partial & Partial<"">; - readonly cancellation_policy_provided?: Partial & Partial<"">; - readonly cancellation_reason?: string; - readonly expected_at?: Partial & Partial<"">; - readonly explanation?: string; - readonly product_description?: string; + readonly additional_documentation?: Partial & Partial<''> + readonly canceled_at?: Partial & Partial<''> + readonly cancellation_policy_provided?: Partial & Partial<''> + readonly cancellation_reason?: string + readonly expected_at?: Partial & Partial<''> + readonly explanation?: string + readonly product_description?: string /** @enum {string} */ - readonly product_type?: "" | "merchandise" | "service"; + readonly product_type?: '' | 'merchandise' | 'service' /** @enum {string} */ - readonly return_status?: "" | "merchant_rejected" | "successful"; - readonly returned_at?: Partial & Partial<"">; + readonly return_status?: '' | 'merchant_rejected' | 'successful' + readonly returned_at?: Partial & Partial<''> }> & - Partial<"">; + Partial<''> readonly duplicate?: Partial<{ - readonly additional_documentation?: Partial & Partial<"">; - readonly card_statement?: Partial & Partial<"">; - readonly cash_receipt?: Partial & Partial<"">; - readonly check_image?: Partial & Partial<"">; - readonly explanation?: string; - readonly original_transaction?: string; + readonly additional_documentation?: Partial & Partial<''> + readonly card_statement?: Partial & Partial<''> + readonly cash_receipt?: Partial & Partial<''> + readonly check_image?: Partial & Partial<''> + readonly explanation?: string + readonly original_transaction?: string }> & - Partial<"">; + Partial<''> readonly fraudulent?: Partial<{ - readonly additional_documentation?: Partial & Partial<"">; - readonly explanation?: string; + readonly additional_documentation?: Partial & Partial<''> + readonly explanation?: string }> & - Partial<"">; + Partial<''> readonly merchandise_not_as_described?: Partial<{ - readonly additional_documentation?: Partial & Partial<"">; - readonly explanation?: string; - readonly received_at?: Partial & Partial<"">; - readonly return_description?: string; + readonly additional_documentation?: Partial & Partial<''> + readonly explanation?: string + readonly received_at?: Partial & Partial<''> + readonly return_description?: string /** @enum {string} */ - readonly return_status?: "" | "merchant_rejected" | "successful"; - readonly returned_at?: Partial & Partial<"">; + readonly return_status?: '' | 'merchant_rejected' | 'successful' + readonly returned_at?: Partial & Partial<''> }> & - Partial<"">; + Partial<''> readonly not_received?: Partial<{ - readonly additional_documentation?: Partial & Partial<"">; - readonly expected_at?: Partial & Partial<"">; - readonly explanation?: string; - readonly product_description?: string; + readonly additional_documentation?: Partial & Partial<''> + readonly expected_at?: Partial & Partial<''> + readonly explanation?: string + readonly product_description?: string /** @enum {string} */ - readonly product_type?: "" | "merchandise" | "service"; + readonly product_type?: '' | 'merchandise' | 'service' }> & - Partial<"">; + Partial<''> readonly other?: Partial<{ - readonly additional_documentation?: Partial & Partial<"">; - readonly explanation?: string; - readonly product_description?: string; + readonly additional_documentation?: Partial & Partial<''> + readonly explanation?: string + readonly product_description?: string /** @enum {string} */ - readonly product_type?: "" | "merchandise" | "service"; + readonly product_type?: '' | 'merchandise' | 'service' }> & - Partial<"">; + Partial<''> /** @enum {string} */ readonly reason?: - | "canceled" - | "duplicate" - | "fraudulent" - | "merchandise_not_as_described" - | "not_received" - | "other" - | "service_not_as_described"; + | 'canceled' + | 'duplicate' + | 'fraudulent' + | 'merchandise_not_as_described' + | 'not_received' + | 'other' + | 'service_not_as_described' readonly service_not_as_described?: Partial<{ - readonly additional_documentation?: Partial & Partial<"">; - readonly canceled_at?: Partial & Partial<"">; - readonly cancellation_reason?: string; - readonly explanation?: string; - readonly received_at?: Partial & Partial<"">; + readonly additional_documentation?: Partial & Partial<''> + readonly canceled_at?: Partial & Partial<''> + readonly cancellation_reason?: string + readonly explanation?: string + readonly received_at?: Partial & Partial<''> }> & - Partial<"">; - }; + Partial<''> + } /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> + } + } + } + } /**

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.

*/ readonly PostIssuingDisputesDisputeSubmit: { readonly parameters: { readonly path: { - readonly dispute: string; - }; - }; + readonly dispute: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["issuing.dispute"]; - }; - }; + readonly 'application/json': components['schemas']['issuing.dispute'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> + } + } + } + } /**

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

*/ readonly GetIssuingSettlements: { readonly parameters: { readonly query: { /** Only return issuing settlements that were created during the given date interval. */ readonly created?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["issuing.settlement"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['issuing.settlement'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Retrieves an Issuing Settlement object.

*/ readonly GetIssuingSettlementsSettlement: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly settlement: string; - }; - }; + readonly settlement: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["issuing.settlement"]; - }; - }; + readonly 'application/json': components['schemas']['issuing.settlement'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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

*/ readonly PostIssuingSettlementsSettlement: { readonly parameters: { readonly path: { - readonly settlement: string; - }; - }; + readonly settlement: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["issuing.settlement"]; - }; - }; + readonly 'application/json': components['schemas']['issuing.settlement'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: { readonly [key: string]: string }; - }; - }; - }; - }; + readonly metadata?: { readonly [key: string]: string } + } + } + } + } /**

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.

*/ readonly GetIssuingTransactions: { readonly parameters: { readonly query: { /** Only return transactions that belong to the given card. */ - readonly card?: string; + readonly card?: string /** Only return transactions that belong to the given cardholder. */ - readonly cardholder?: string; + readonly cardholder?: string /** Only return transactions that were created during the given date interval. */ readonly created?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** Only return transactions that have the given type. One of `capture` or `refund`. */ - readonly type?: "capture" | "refund"; - }; - }; + readonly type?: 'capture' | 'refund' + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["issuing.transaction"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['issuing.transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Retrieves an Issuing Transaction object.

*/ readonly GetIssuingTransactionsTransaction: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly transaction: string; - }; - }; + readonly transaction: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["issuing.transaction"]; - }; - }; + readonly 'application/json': components['schemas']['issuing.transaction'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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

*/ readonly PostIssuingTransactionsTransaction: { readonly parameters: { readonly path: { - readonly transaction: string; - }; - }; + readonly transaction: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["issuing.transaction"]; - }; - }; + readonly 'application/json': components['schemas']['issuing.transaction'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> + } + } + } + } /**

Retrieves a Mandate object.

*/ readonly GetMandatesMandate: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly mandate: string; - }; - }; + readonly mandate: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["mandate"]; - }; - }; + readonly 'application/json': components['schemas']['mandate'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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

*/ readonly GetOrderReturns: { readonly parameters: { readonly query: { /** Date this return was created. */ readonly created?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** The order to retrieve returns for. */ - readonly order?: string; + readonly order?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["order_return"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['order_return'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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

*/ readonly GetOrderReturnsId: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["order_return"]; - }; - }; + readonly 'application/json': components['schemas']['order_return'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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

*/ readonly GetOrders: { readonly parameters: { readonly query: { /** Date this order was created. */ readonly created?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** Only return orders for the given customer. */ - readonly customer?: string; + readonly customer?: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** Only return orders with the given IDs. */ - readonly ids?: readonly string[]; + readonly ids?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** Only return orders that have the given status. One of `created`, `paid`, `fulfilled`, or `refunded`. */ - readonly status?: string; + readonly status?: string /** Filter orders based on when they were paid, fulfilled, canceled, or returned. */ readonly status_transitions?: { readonly canceled?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial readonly fulfilled?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial readonly paid?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial readonly returned?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; - }; + Partial + } /** Only return orders with the given upstream order IDs. */ - readonly upstream_ids?: readonly string[]; - }; - }; + readonly upstream_ids?: readonly string[] + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["order"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['order'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Creates a new order object.

*/ readonly PostOrders: { readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["order"]; - }; - }; + readonly 'application/json': components['schemas']['order'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description A coupon code that represents a discount to be applied to this order. Must be one-time duration and in same currency as the order. An order can have multiple coupons. */ - readonly coupon?: string; + readonly coupon?: string /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description The ID of an existing customer to use for this order. If provided, the customer email and shipping address will be used to create the order. Subsequently, the customer will also be charged to pay the order. If `email` or `shipping` are also provided, they will override the values retrieved from the customer object. */ - readonly customer?: string; + readonly customer?: string /** @description The email address of the customer placing the order. */ - readonly email?: string; + readonly email?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description List of items constituting the order. An order can have up to 25 items. */ readonly items?: readonly { - readonly amount?: number; - readonly currency?: string; - readonly description?: string; - readonly parent?: string; - readonly quantity?: number; + readonly amount?: number + readonly currency?: string + readonly description?: string + readonly parent?: string + readonly quantity?: number /** @enum {string} */ - readonly type?: "discount" | "shipping" | "sku" | "tax"; - }[]; + readonly type?: 'discount' | 'shipping' | 'sku' | 'tax' + }[] /** @description 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`. */ - readonly metadata?: { readonly [key: string]: string }; + readonly metadata?: { readonly [key: string]: string } /** * customer_shipping * @description Shipping address for the order. Required if any of the SKUs are for products that have `shippable` set to true. @@ -32425,237 +32187,237 @@ export interface operations { readonly shipping?: { /** optional_fields_address */ readonly address: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; - readonly name: string; - readonly phone?: string; - }; - }; - }; - }; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } + readonly name: string + readonly phone?: string + } + } + } + } + } /**

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

*/ readonly GetOrdersId: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["order"]; - }; - }; + readonly 'application/json': components['schemas']['order'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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

*/ readonly PostOrdersId: { readonly parameters: { readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["order"]; - }; - }; + readonly 'application/json': components['schemas']['order'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description A coupon code that represents a discount to be applied to this order. Must be one-time duration and in same currency as the order. An order can have multiple coupons. */ - readonly coupon?: string; + readonly coupon?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description The shipping method to select for fulfilling this order. If specified, must be one of the `id`s of a shipping method in the `shipping_methods` array. If specified, will overwrite the existing selected shipping method, updating `items` as necessary. */ - readonly selected_shipping_method?: string; + readonly selected_shipping_method?: string /** * shipping_tracking_params * @description Tracking information once the order has been fulfilled. */ readonly shipping?: { - readonly carrier: string; - readonly tracking_number: string; - }; + readonly carrier: string + readonly tracking_number: string + } /** * @description Current order status. One of `created`, `paid`, `canceled`, `fulfilled`, or `returned`. More detail in the [Orders Guide](https://stripe.com/docs/orders/guide#understanding-order-statuses). * @enum {string} */ - readonly status?: "canceled" | "created" | "fulfilled" | "paid" | "returned"; - }; - }; - }; - }; + readonly status?: 'canceled' | 'created' | 'fulfilled' | 'paid' | 'returned' + } + } + } + } /**

Pay an order by providing a source to create a payment.

*/ readonly PostOrdersIdPay: { readonly parameters: { readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["order"]; - }; - }; + readonly 'application/json': components['schemas']['order'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description A fee in %s that will be applied to the order and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the `Stripe-Account` header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees). */ - readonly application_fee?: number; + readonly application_fee?: number /** @description The ID of an existing customer that will be charged for this order. If no customer was attached to the order at creation, either `source` or `customer` is required. Otherwise, the specified customer will be charged instead of the one attached to the order. */ - readonly customer?: string; + readonly customer?: string /** @description The email address of the customer placing the order. Required if not previously specified for the order. */ - readonly email?: string; + readonly email?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: { readonly [key: string]: string }; + readonly metadata?: { readonly [key: string]: string } /** @description A [Token](https://stripe.com/docs/api#tokens)'s or a [Source](https://stripe.com/docs/api#sources)'s ID, as returned by [Elements](https://stripe.com/docs/elements). If no customer was attached to the order at creation, either `source` or `customer` is required. Otherwise, the specified source will be charged intead of the customer attached to the order. */ - readonly source?: string; - }; - }; - }; - }; + readonly source?: string + } + } + } + } /**

Return all or part of an order. The order must have a status of paid or fulfilled before it can be returned. Once all items have been returned, the order will become canceled or returned depending on which status the order started in.

*/ readonly PostOrdersIdReturns: { readonly parameters: { readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["order_return"]; - }; - }; + readonly 'application/json': components['schemas']['order_return'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description List of items to return. */ readonly items?: Partial< readonly { - readonly amount?: number; - readonly description?: string; - readonly parent?: string; - readonly quantity?: number; + readonly amount?: number + readonly description?: string + readonly parent?: string + readonly quantity?: number /** @enum {string} */ - readonly type?: "discount" | "shipping" | "sku" | "tax"; + readonly type?: 'discount' | 'shipping' | 'sku' | 'tax' }[] > & - Partial<"">; - }; - }; - }; - }; + Partial<''> + } + } + } + } /**

Returns a list of PaymentIntents.

*/ readonly GetPaymentIntents: { readonly parameters: { readonly query: { /** 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. */ readonly created?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** Only return PaymentIntents for the customer specified by this customer ID. */ - readonly customer?: string; + readonly customer?: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["payment_intent"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['payment_intent'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /** *

Creates a PaymentIntent object.

* @@ -32673,41 +32435,41 @@ export interface operations { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["payment_intent"]; - }; - }; + readonly 'application/json': components['schemas']['payment_intent'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description 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). */ - readonly amount: number; + readonly amount: number /** @description 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). */ - readonly application_fee_amount?: number; + readonly application_fee_amount?: number /** * automatic_payment_methods_param * @description When enabled, this PaymentIntent will accept payment methods that you have enabled in the Dashboard and are compatible with this PaymentIntent's other parameters. */ readonly automatic_payment_methods?: { - readonly enabled: boolean; - }; + readonly enabled: boolean + } /** * @description Controls when the funds will be captured from the customer's account. * @enum {string} */ - readonly capture_method?: "automatic" | "manual"; + readonly capture_method?: 'automatic' | 'manual' /** @description Set to `true` to attempt to [confirm](https://stripe.com/docs/api/payment_intents/confirm) this PaymentIntent immediately. This parameter defaults to `false`. When creating and confirming a PaymentIntent at the same time, parameters available in the [confirm](https://stripe.com/docs/api/payment_intents/confirm) API may also be provided. */ - readonly confirm?: boolean; + readonly confirm?: boolean /** @enum {string} */ - readonly confirmation_method?: "automatic" | "manual"; + readonly confirmation_method?: 'automatic' | 'manual' /** @description 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). */ - readonly currency: string; + readonly currency: string /** * @description ID of the Customer this PaymentIntent belongs to, if one exists. * @@ -32715,15 +32477,15 @@ export interface operations { * * If present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. */ - readonly customer?: string; + readonly customer?: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string; + readonly description?: string /** @description Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. This parameter is intended for simpler integrations that do not handle customer actions, like [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). */ - readonly error_on_requires_action?: boolean; + readonly error_on_requires_action?: boolean /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description ID of the mandate to be used for this payment. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). */ - readonly mandate?: string; + readonly mandate?: string /** * secret_key_param * @description This hash contains details about the Mandate to create. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). @@ -32732,30 +32494,30 @@ export interface operations { /** customer_acceptance_param */ readonly customer_acceptance: { /** Format: unix-time */ - readonly accepted_at?: number; + readonly accepted_at?: number /** offline_param */ - readonly offline?: { readonly [key: string]: unknown }; + readonly offline?: { readonly [key: string]: unknown } /** online_param */ readonly online?: { - readonly ip_address: string; - readonly user_agent: string; - }; + readonly ip_address: string + readonly user_agent: string + } /** @enum {string} */ - readonly type: "offline" | "online"; - }; - }; + readonly type: 'offline' | 'online' + } + } /** @description 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`. */ - readonly metadata?: { readonly [key: string]: string }; + readonly metadata?: { readonly [key: string]: string } /** @description Set to `true` to indicate that the customer is not in your checkout flow during this payment attempt, and therefore is unable to authenticate. This parameter is intended for scenarios where you collect card details and [charge them later](https://stripe.com/docs/payments/cards/charging-saved-cards). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). */ - readonly off_session?: Partial & Partial<"one_off" | "recurring">; + readonly off_session?: Partial & Partial<'one_off' | 'recurring'> /** @description The Stripe account ID for which these funds are intended. For details, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ - readonly on_behalf_of?: string; + readonly on_behalf_of?: string /** * @description ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. * * If this parameter is omitted with `confirm=true`, `customer.default_source` will be attached as this PaymentIntent's payment instrument to improve the migration experience for users of the Charges API. We recommend that you explicitly provide the `payment_method` going forward. */ - readonly payment_method?: string; + readonly payment_method?: string /** * payment_method_data_params * @description If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear @@ -32765,201 +32527,201 @@ export interface operations { readonly payment_method_data?: { /** payment_method_param */ readonly acss_debit?: { - readonly account_number: string; - readonly institution_number: string; - readonly transit_number: string; - }; + readonly account_number: string + readonly institution_number: string + readonly transit_number: string + } /** param */ - readonly afterpay_clearpay?: { readonly [key: string]: unknown }; + readonly afterpay_clearpay?: { readonly [key: string]: unknown } /** param */ - readonly alipay?: { readonly [key: string]: unknown }; + readonly alipay?: { readonly [key: string]: unknown } /** param */ readonly au_becs_debit?: { - readonly account_number: string; - readonly bsb_number: string; - }; + readonly account_number: string + readonly bsb_number: string + } /** param */ readonly bacs_debit?: { - readonly account_number?: string; - readonly sort_code?: string; - }; + readonly account_number?: string + readonly sort_code?: string + } /** param */ - readonly bancontact?: { readonly [key: string]: unknown }; + readonly bancontact?: { readonly [key: string]: unknown } /** billing_details_inner_params */ readonly billing_details?: { readonly address?: Partial<{ - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string }> & - Partial<"">; - readonly email?: Partial & Partial<"">; - readonly name?: string; - readonly phone?: string; - }; + Partial<''> + readonly email?: Partial & Partial<''> + readonly name?: string + readonly phone?: string + } /** param */ readonly boleto?: { - readonly tax_id: string; - }; + readonly tax_id: string + } /** param */ readonly eps?: { /** @enum {string} */ readonly bank?: - | "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" - | "dolomitenbank" - | "easybank_ag" - | "erste_bank_und_sparkassen" - | "hypo_alpeadriabank_international_ag" - | "hypo_bank_burgenland_aktiengesellschaft" - | "hypo_noe_lb_fur_niederosterreich_u_wien" - | "hypo_oberosterreich_salzburg_steiermark" - | "hypo_tirol_bank_ag" - | "hypo_vorarlberg_bank_ag" - | "marchfelder_bank" - | "oberbank_ag" - | "raiffeisen_bankengruppe_osterreich" - | "schoellerbank_ag" - | "sparda_bank_wien" - | "volksbank_gruppe" - | "volkskreditbank_ag" - | "vr_bank_braunau"; - }; + | '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' + | 'dolomitenbank' + | 'easybank_ag' + | 'erste_bank_und_sparkassen' + | 'hypo_alpeadriabank_international_ag' + | 'hypo_bank_burgenland_aktiengesellschaft' + | 'hypo_noe_lb_fur_niederosterreich_u_wien' + | 'hypo_oberosterreich_salzburg_steiermark' + | 'hypo_tirol_bank_ag' + | 'hypo_vorarlberg_bank_ag' + | 'marchfelder_bank' + | 'oberbank_ag' + | 'raiffeisen_bankengruppe_osterreich' + | 'schoellerbank_ag' + | 'sparda_bank_wien' + | 'volksbank_gruppe' + | 'volkskreditbank_ag' + | 'vr_bank_braunau' + } /** param */ readonly fpx?: { /** @enum {string} */ readonly bank: - | "affin_bank" - | "agrobank" - | "alliance_bank" - | "ambank" - | "bank_islam" - | "bank_muamalat" - | "bank_rakyat" - | "bsn" - | "cimb" - | "deutsche_bank" - | "hong_leong_bank" - | "hsbc" - | "kfh" - | "maybank2e" - | "maybank2u" - | "ocbc" - | "pb_enterprise" - | "public_bank" - | "rhb" - | "standard_chartered" - | "uob"; - }; + | 'affin_bank' + | 'agrobank' + | 'alliance_bank' + | 'ambank' + | 'bank_islam' + | 'bank_muamalat' + | 'bank_rakyat' + | 'bsn' + | 'cimb' + | 'deutsche_bank' + | 'hong_leong_bank' + | 'hsbc' + | 'kfh' + | 'maybank2e' + | 'maybank2u' + | 'ocbc' + | 'pb_enterprise' + | 'public_bank' + | 'rhb' + | 'standard_chartered' + | 'uob' + } /** param */ - readonly giropay?: { readonly [key: string]: unknown }; + readonly giropay?: { readonly [key: string]: unknown } /** param */ - readonly grabpay?: { readonly [key: string]: unknown }; + readonly grabpay?: { readonly [key: string]: unknown } /** param */ readonly ideal?: { /** @enum {string} */ readonly bank?: - | "abn_amro" - | "asn_bank" - | "bunq" - | "handelsbanken" - | "ing" - | "knab" - | "moneyou" - | "rabobank" - | "regiobank" - | "revolut" - | "sns_bank" - | "triodos_bank" - | "van_lanschot"; - }; + | 'abn_amro' + | 'asn_bank' + | 'bunq' + | 'handelsbanken' + | 'ing' + | 'knab' + | 'moneyou' + | 'rabobank' + | 'regiobank' + | 'revolut' + | 'sns_bank' + | 'triodos_bank' + | 'van_lanschot' + } /** param */ - readonly interac_present?: { readonly [key: string]: unknown }; + readonly interac_present?: { readonly [key: string]: unknown } /** param */ readonly klarna?: { /** date_of_birth */ readonly dob?: { - readonly day: number; - readonly month: number; - readonly year: number; - }; - }; - readonly metadata?: { readonly [key: string]: string }; + readonly day: number + readonly month: number + readonly year: number + } + } + readonly metadata?: { readonly [key: string]: string } /** param */ - readonly oxxo?: { readonly [key: string]: unknown }; + readonly oxxo?: { readonly [key: string]: unknown } /** param */ readonly p24?: { /** @enum {string} */ readonly bank?: - | "alior_bank" - | "bank_millennium" - | "bank_nowy_bfg_sa" - | "bank_pekao_sa" - | "banki_spbdzielcze" - | "blik" - | "bnp_paribas" - | "boz" - | "citi_handlowy" - | "credit_agricole" - | "envelobank" - | "etransfer_pocztowy24" - | "getin_bank" - | "ideabank" - | "ing" - | "inteligo" - | "mbank_mtransfer" - | "nest_przelew" - | "noble_pay" - | "pbac_z_ipko" - | "plus_bank" - | "santander_przelew24" - | "tmobile_usbugi_bankowe" - | "toyota_bank" - | "volkswagen_bank"; - }; + | 'alior_bank' + | 'bank_millennium' + | 'bank_nowy_bfg_sa' + | 'bank_pekao_sa' + | 'banki_spbdzielcze' + | 'blik' + | 'bnp_paribas' + | 'boz' + | 'citi_handlowy' + | 'credit_agricole' + | 'envelobank' + | 'etransfer_pocztowy24' + | 'getin_bank' + | 'ideabank' + | 'ing' + | 'inteligo' + | 'mbank_mtransfer' + | 'nest_przelew' + | 'noble_pay' + | 'pbac_z_ipko' + | 'plus_bank' + | 'santander_przelew24' + | 'tmobile_usbugi_bankowe' + | 'toyota_bank' + | 'volkswagen_bank' + } /** param */ readonly sepa_debit?: { - readonly iban: string; - }; + readonly iban: string + } /** param */ readonly sofort?: { /** @enum {string} */ - readonly country: "AT" | "BE" | "DE" | "ES" | "IT" | "NL"; - }; + readonly country: 'AT' | 'BE' | 'DE' | 'ES' | 'IT' | 'NL' + } /** @enum {string} */ readonly type: - | "acss_debit" - | "afterpay_clearpay" - | "alipay" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "eps" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "klarna" - | "oxxo" - | "p24" - | "sepa_debit" - | "sofort" - | "wechat_pay"; + | 'acss_debit' + | 'afterpay_clearpay' + | 'alipay' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'eps' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'klarna' + | 'oxxo' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' /** param */ - readonly wechat_pay?: { readonly [key: string]: unknown }; - }; + readonly wechat_pay?: { readonly [key: string]: unknown } + } /** * payment_method_options_param * @description Payment-method-specific configuration for this PaymentIntent. @@ -32968,136 +32730,136 @@ export interface operations { readonly acss_debit?: Partial<{ /** payment_intent_payment_method_options_mandate_options_param */ readonly mandate_options?: { - readonly custom_mandate_url?: Partial & Partial<"">; - readonly interval_description?: string; + readonly custom_mandate_url?: Partial & Partial<''> + readonly interval_description?: string /** @enum {string} */ - readonly payment_schedule?: "combined" | "interval" | "sporadic"; + readonly payment_schedule?: 'combined' | 'interval' | 'sporadic' /** @enum {string} */ - readonly transaction_type?: "business" | "personal"; - }; + readonly transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - readonly verification_method?: "automatic" | "instant" | "microdeposits"; + readonly verification_method?: 'automatic' | 'instant' | 'microdeposits' }> & - Partial<"">; + Partial<''> readonly afterpay_clearpay?: Partial<{ - readonly reference?: string; + readonly reference?: string }> & - Partial<"">; - readonly alipay?: Partial<{ readonly [key: string]: unknown }> & Partial<"">; - readonly au_becs_debit?: Partial<{ readonly [key: string]: unknown }> & Partial<"">; - readonly bacs_debit?: Partial<{ readonly [key: string]: unknown }> & Partial<"">; + Partial<''> + readonly alipay?: Partial<{ readonly [key: string]: unknown }> & Partial<''> + readonly au_becs_debit?: Partial<{ readonly [key: string]: unknown }> & Partial<''> + readonly bacs_debit?: Partial<{ readonly [key: string]: unknown }> & Partial<''> readonly bancontact?: Partial<{ /** @enum {string} */ - readonly preferred_language?: "de" | "en" | "fr" | "nl"; + readonly preferred_language?: 'de' | 'en' | 'fr' | 'nl' }> & - Partial<"">; + Partial<''> readonly boleto?: Partial<{ - readonly expires_after_days?: number; + readonly expires_after_days?: number }> & - Partial<"">; + Partial<''> readonly card?: Partial<{ - readonly cvc_token?: string; + readonly cvc_token?: string /** installments_param */ readonly installments?: { - readonly enabled?: boolean; + readonly enabled?: boolean readonly plan?: Partial<{ - readonly count: number; + readonly count: number /** @enum {string} */ - readonly interval: "month"; + readonly interval: 'month' /** @enum {string} */ - readonly type: "fixed_count"; + readonly type: 'fixed_count' }> & - Partial<"">; - }; + Partial<''> + } /** @enum {string} */ readonly network?: - | "amex" - | "cartes_bancaires" - | "diners" - | "discover" - | "interac" - | "jcb" - | "mastercard" - | "unionpay" - | "unknown" - | "visa"; + | 'amex' + | 'cartes_bancaires' + | 'diners' + | 'discover' + | 'interac' + | 'jcb' + | 'mastercard' + | 'unionpay' + | 'unknown' + | 'visa' /** @enum {string} */ - readonly request_three_d_secure?: "any" | "automatic"; + readonly request_three_d_secure?: 'any' | 'automatic' /** @enum {string} */ - readonly setup_future_usage?: "" | "none" | "off_session" | "on_session"; + readonly setup_future_usage?: '' | 'none' | 'off_session' | 'on_session' }> & - Partial<"">; - readonly card_present?: Partial<{ readonly [key: string]: unknown }> & Partial<"">; - readonly eps?: Partial<{ readonly [key: string]: unknown }> & Partial<"">; - readonly fpx?: Partial<{ readonly [key: string]: unknown }> & Partial<"">; - readonly giropay?: Partial<{ readonly [key: string]: unknown }> & Partial<"">; - readonly grabpay?: Partial<{ readonly [key: string]: unknown }> & Partial<"">; - readonly ideal?: Partial<{ readonly [key: string]: unknown }> & Partial<"">; - readonly interac_present?: Partial<{ readonly [key: string]: unknown }> & Partial<"">; + Partial<''> + readonly card_present?: Partial<{ readonly [key: string]: unknown }> & Partial<''> + readonly eps?: Partial<{ readonly [key: string]: unknown }> & Partial<''> + readonly fpx?: Partial<{ readonly [key: string]: unknown }> & Partial<''> + readonly giropay?: Partial<{ readonly [key: string]: unknown }> & Partial<''> + readonly grabpay?: Partial<{ readonly [key: string]: unknown }> & Partial<''> + readonly ideal?: Partial<{ readonly [key: string]: unknown }> & Partial<''> + readonly interac_present?: Partial<{ readonly [key: string]: unknown }> & Partial<''> readonly klarna?: Partial<{ /** @enum {string} */ readonly preferred_locale?: - | "da-DK" - | "de-AT" - | "de-DE" - | "en-AT" - | "en-BE" - | "en-DE" - | "en-DK" - | "en-ES" - | "en-FI" - | "en-FR" - | "en-GB" - | "en-IE" - | "en-IT" - | "en-NL" - | "en-NO" - | "en-SE" - | "en-US" - | "es-ES" - | "es-US" - | "fi-FI" - | "fr-BE" - | "fr-FR" - | "it-IT" - | "nb-NO" - | "nl-BE" - | "nl-NL" - | "sv-FI" - | "sv-SE"; + | 'da-DK' + | 'de-AT' + | 'de-DE' + | 'en-AT' + | 'en-BE' + | 'en-DE' + | 'en-DK' + | 'en-ES' + | 'en-FI' + | 'en-FR' + | 'en-GB' + | 'en-IE' + | 'en-IT' + | 'en-NL' + | 'en-NO' + | 'en-SE' + | 'en-US' + | 'es-ES' + | 'es-US' + | 'fi-FI' + | 'fr-BE' + | 'fr-FR' + | 'it-IT' + | 'nb-NO' + | 'nl-BE' + | 'nl-NL' + | 'sv-FI' + | 'sv-SE' }> & - Partial<"">; + Partial<''> readonly oxxo?: Partial<{ - readonly expires_after_days?: number; + readonly expires_after_days?: number }> & - Partial<"">; + Partial<''> readonly p24?: Partial<{ - readonly tos_shown_and_accepted?: boolean; + readonly tos_shown_and_accepted?: boolean }> & - Partial<"">; + Partial<''> readonly sepa_debit?: Partial<{ /** payment_method_options_mandate_options_param */ - readonly mandate_options?: { readonly [key: string]: unknown }; + readonly mandate_options?: { readonly [key: string]: unknown } }> & - Partial<"">; + Partial<''> readonly sofort?: Partial<{ /** @enum {string} */ - readonly preferred_language?: "" | "de" | "en" | "es" | "fr" | "it" | "nl" | "pl"; + readonly preferred_language?: '' | 'de' | 'en' | 'es' | 'fr' | 'it' | 'nl' | 'pl' }> & - Partial<"">; + Partial<''> readonly wechat_pay?: Partial<{ - readonly app_id?: string; + readonly app_id?: string /** @enum {string} */ - readonly client: "android" | "ios" | "web"; + readonly client: 'android' | 'ios' | 'web' }> & - Partial<"">; - }; + Partial<''> + } /** @description The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. If this is not provided, defaults to ["card"]. */ - readonly payment_method_types?: readonly string[]; + readonly payment_method_types?: readonly string[] /** @description 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). */ - readonly receipt_email?: string; + readonly receipt_email?: string /** @description The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). */ - readonly return_url?: string; + readonly return_url?: string /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * @@ -33106,7 +32868,7 @@ export interface operations { * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ - readonly setup_future_usage?: "off_session" | "on_session"; + readonly setup_future_usage?: 'off_session' | 'on_session' /** * optional_fields_shipping * @description Shipping information for this PaymentIntent. @@ -33114,39 +32876,39 @@ export interface operations { readonly shipping?: { /** optional_fields_address */ readonly address: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; - readonly carrier?: string; - readonly name: string; - readonly phone?: string; - readonly tracking_number?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } + readonly carrier?: string + readonly name: string + readonly phone?: string + readonly tracking_number?: string + } /** @description For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - readonly statement_descriptor?: string; + readonly statement_descriptor?: string /** @description Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - readonly statement_descriptor_suffix?: string; + readonly statement_descriptor_suffix?: string /** * transfer_data_creation_params * @description The parameters used to automatically create a Transfer when the payment succeeds. * For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ readonly transfer_data?: { - readonly amount?: number; - readonly destination: string; - }; + readonly amount?: number + readonly destination: string + } /** @description A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. */ - readonly transfer_group?: string; + readonly transfer_group?: string /** @description Set to `true` only when using manual confirmation and the iOS or Android SDKs to handle additional authentication steps. */ - readonly use_stripe_sdk?: boolean; - }; - }; - }; - }; + readonly use_stripe_sdk?: boolean + } + } + } + } /** *

Retrieves the details of a PaymentIntent that has previously been created.

* @@ -33158,34 +32920,34 @@ export interface operations { readonly parameters: { readonly query: { /** The client secret of the PaymentIntent. Required if a publishable key is used to retrieve the source. */ - readonly client_secret?: string; + readonly client_secret?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly intent: string; - }; - }; + readonly intent: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["payment_intent"]; - }; - }; + readonly 'application/json': components['schemas']['payment_intent'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /** *

Updates properties on a PaymentIntent object without confirming.

* @@ -33198,32 +32960,32 @@ export interface operations { readonly PostPaymentIntentsIntent: { readonly parameters: { readonly path: { - readonly intent: string; - }; - }; + readonly intent: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["payment_intent"]; - }; - }; + readonly 'application/json': components['schemas']['payment_intent'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description 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). */ - readonly amount?: number; + readonly amount?: number /** @description 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). */ - readonly application_fee_amount?: Partial & Partial<"">; + readonly application_fee_amount?: Partial & Partial<''> /** @description 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). */ - readonly currency?: string; + readonly currency?: string /** * @description ID of the Customer this PaymentIntent belongs to, if one exists. * @@ -33231,15 +32993,15 @@ export interface operations { * * If present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. */ - readonly customer?: string; + readonly customer?: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string; + readonly description?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. */ - readonly payment_method?: string; + readonly payment_method?: string /** * payment_method_data_params * @description If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear @@ -33249,201 +33011,201 @@ export interface operations { readonly payment_method_data?: { /** payment_method_param */ readonly acss_debit?: { - readonly account_number: string; - readonly institution_number: string; - readonly transit_number: string; - }; + readonly account_number: string + readonly institution_number: string + readonly transit_number: string + } /** param */ - readonly afterpay_clearpay?: { readonly [key: string]: unknown }; + readonly afterpay_clearpay?: { readonly [key: string]: unknown } /** param */ - readonly alipay?: { readonly [key: string]: unknown }; + readonly alipay?: { readonly [key: string]: unknown } /** param */ readonly au_becs_debit?: { - readonly account_number: string; - readonly bsb_number: string; - }; + readonly account_number: string + readonly bsb_number: string + } /** param */ readonly bacs_debit?: { - readonly account_number?: string; - readonly sort_code?: string; - }; + readonly account_number?: string + readonly sort_code?: string + } /** param */ - readonly bancontact?: { readonly [key: string]: unknown }; + readonly bancontact?: { readonly [key: string]: unknown } /** billing_details_inner_params */ readonly billing_details?: { readonly address?: Partial<{ - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string }> & - Partial<"">; - readonly email?: Partial & Partial<"">; - readonly name?: string; - readonly phone?: string; - }; + Partial<''> + readonly email?: Partial & Partial<''> + readonly name?: string + readonly phone?: string + } /** param */ readonly boleto?: { - readonly tax_id: string; - }; + readonly tax_id: string + } /** param */ readonly eps?: { /** @enum {string} */ readonly bank?: - | "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" - | "dolomitenbank" - | "easybank_ag" - | "erste_bank_und_sparkassen" - | "hypo_alpeadriabank_international_ag" - | "hypo_bank_burgenland_aktiengesellschaft" - | "hypo_noe_lb_fur_niederosterreich_u_wien" - | "hypo_oberosterreich_salzburg_steiermark" - | "hypo_tirol_bank_ag" - | "hypo_vorarlberg_bank_ag" - | "marchfelder_bank" - | "oberbank_ag" - | "raiffeisen_bankengruppe_osterreich" - | "schoellerbank_ag" - | "sparda_bank_wien" - | "volksbank_gruppe" - | "volkskreditbank_ag" - | "vr_bank_braunau"; - }; + | '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' + | 'dolomitenbank' + | 'easybank_ag' + | 'erste_bank_und_sparkassen' + | 'hypo_alpeadriabank_international_ag' + | 'hypo_bank_burgenland_aktiengesellschaft' + | 'hypo_noe_lb_fur_niederosterreich_u_wien' + | 'hypo_oberosterreich_salzburg_steiermark' + | 'hypo_tirol_bank_ag' + | 'hypo_vorarlberg_bank_ag' + | 'marchfelder_bank' + | 'oberbank_ag' + | 'raiffeisen_bankengruppe_osterreich' + | 'schoellerbank_ag' + | 'sparda_bank_wien' + | 'volksbank_gruppe' + | 'volkskreditbank_ag' + | 'vr_bank_braunau' + } /** param */ readonly fpx?: { /** @enum {string} */ readonly bank: - | "affin_bank" - | "agrobank" - | "alliance_bank" - | "ambank" - | "bank_islam" - | "bank_muamalat" - | "bank_rakyat" - | "bsn" - | "cimb" - | "deutsche_bank" - | "hong_leong_bank" - | "hsbc" - | "kfh" - | "maybank2e" - | "maybank2u" - | "ocbc" - | "pb_enterprise" - | "public_bank" - | "rhb" - | "standard_chartered" - | "uob"; - }; + | 'affin_bank' + | 'agrobank' + | 'alliance_bank' + | 'ambank' + | 'bank_islam' + | 'bank_muamalat' + | 'bank_rakyat' + | 'bsn' + | 'cimb' + | 'deutsche_bank' + | 'hong_leong_bank' + | 'hsbc' + | 'kfh' + | 'maybank2e' + | 'maybank2u' + | 'ocbc' + | 'pb_enterprise' + | 'public_bank' + | 'rhb' + | 'standard_chartered' + | 'uob' + } /** param */ - readonly giropay?: { readonly [key: string]: unknown }; + readonly giropay?: { readonly [key: string]: unknown } /** param */ - readonly grabpay?: { readonly [key: string]: unknown }; + readonly grabpay?: { readonly [key: string]: unknown } /** param */ readonly ideal?: { /** @enum {string} */ readonly bank?: - | "abn_amro" - | "asn_bank" - | "bunq" - | "handelsbanken" - | "ing" - | "knab" - | "moneyou" - | "rabobank" - | "regiobank" - | "revolut" - | "sns_bank" - | "triodos_bank" - | "van_lanschot"; - }; + | 'abn_amro' + | 'asn_bank' + | 'bunq' + | 'handelsbanken' + | 'ing' + | 'knab' + | 'moneyou' + | 'rabobank' + | 'regiobank' + | 'revolut' + | 'sns_bank' + | 'triodos_bank' + | 'van_lanschot' + } /** param */ - readonly interac_present?: { readonly [key: string]: unknown }; + readonly interac_present?: { readonly [key: string]: unknown } /** param */ readonly klarna?: { /** date_of_birth */ readonly dob?: { - readonly day: number; - readonly month: number; - readonly year: number; - }; - }; - readonly metadata?: { readonly [key: string]: string }; + readonly day: number + readonly month: number + readonly year: number + } + } + readonly metadata?: { readonly [key: string]: string } /** param */ - readonly oxxo?: { readonly [key: string]: unknown }; + readonly oxxo?: { readonly [key: string]: unknown } /** param */ readonly p24?: { /** @enum {string} */ readonly bank?: - | "alior_bank" - | "bank_millennium" - | "bank_nowy_bfg_sa" - | "bank_pekao_sa" - | "banki_spbdzielcze" - | "blik" - | "bnp_paribas" - | "boz" - | "citi_handlowy" - | "credit_agricole" - | "envelobank" - | "etransfer_pocztowy24" - | "getin_bank" - | "ideabank" - | "ing" - | "inteligo" - | "mbank_mtransfer" - | "nest_przelew" - | "noble_pay" - | "pbac_z_ipko" - | "plus_bank" - | "santander_przelew24" - | "tmobile_usbugi_bankowe" - | "toyota_bank" - | "volkswagen_bank"; - }; + | 'alior_bank' + | 'bank_millennium' + | 'bank_nowy_bfg_sa' + | 'bank_pekao_sa' + | 'banki_spbdzielcze' + | 'blik' + | 'bnp_paribas' + | 'boz' + | 'citi_handlowy' + | 'credit_agricole' + | 'envelobank' + | 'etransfer_pocztowy24' + | 'getin_bank' + | 'ideabank' + | 'ing' + | 'inteligo' + | 'mbank_mtransfer' + | 'nest_przelew' + | 'noble_pay' + | 'pbac_z_ipko' + | 'plus_bank' + | 'santander_przelew24' + | 'tmobile_usbugi_bankowe' + | 'toyota_bank' + | 'volkswagen_bank' + } /** param */ readonly sepa_debit?: { - readonly iban: string; - }; + readonly iban: string + } /** param */ readonly sofort?: { /** @enum {string} */ - readonly country: "AT" | "BE" | "DE" | "ES" | "IT" | "NL"; - }; + readonly country: 'AT' | 'BE' | 'DE' | 'ES' | 'IT' | 'NL' + } /** @enum {string} */ readonly type: - | "acss_debit" - | "afterpay_clearpay" - | "alipay" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "eps" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "klarna" - | "oxxo" - | "p24" - | "sepa_debit" - | "sofort" - | "wechat_pay"; + | 'acss_debit' + | 'afterpay_clearpay' + | 'alipay' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'eps' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'klarna' + | 'oxxo' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' /** param */ - readonly wechat_pay?: { readonly [key: string]: unknown }; - }; + readonly wechat_pay?: { readonly [key: string]: unknown } + } /** * payment_method_options_param * @description Payment-method-specific configuration for this PaymentIntent. @@ -33452,134 +33214,134 @@ export interface operations { readonly acss_debit?: Partial<{ /** payment_intent_payment_method_options_mandate_options_param */ readonly mandate_options?: { - readonly custom_mandate_url?: Partial & Partial<"">; - readonly interval_description?: string; + readonly custom_mandate_url?: Partial & Partial<''> + readonly interval_description?: string /** @enum {string} */ - readonly payment_schedule?: "combined" | "interval" | "sporadic"; + readonly payment_schedule?: 'combined' | 'interval' | 'sporadic' /** @enum {string} */ - readonly transaction_type?: "business" | "personal"; - }; + readonly transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - readonly verification_method?: "automatic" | "instant" | "microdeposits"; + readonly verification_method?: 'automatic' | 'instant' | 'microdeposits' }> & - Partial<"">; + Partial<''> readonly afterpay_clearpay?: Partial<{ - readonly reference?: string; + readonly reference?: string }> & - Partial<"">; - readonly alipay?: Partial<{ readonly [key: string]: unknown }> & Partial<"">; - readonly au_becs_debit?: Partial<{ readonly [key: string]: unknown }> & Partial<"">; - readonly bacs_debit?: Partial<{ readonly [key: string]: unknown }> & Partial<"">; + Partial<''> + readonly alipay?: Partial<{ readonly [key: string]: unknown }> & Partial<''> + readonly au_becs_debit?: Partial<{ readonly [key: string]: unknown }> & Partial<''> + readonly bacs_debit?: Partial<{ readonly [key: string]: unknown }> & Partial<''> readonly bancontact?: Partial<{ /** @enum {string} */ - readonly preferred_language?: "de" | "en" | "fr" | "nl"; + readonly preferred_language?: 'de' | 'en' | 'fr' | 'nl' }> & - Partial<"">; + Partial<''> readonly boleto?: Partial<{ - readonly expires_after_days?: number; + readonly expires_after_days?: number }> & - Partial<"">; + Partial<''> readonly card?: Partial<{ - readonly cvc_token?: string; + readonly cvc_token?: string /** installments_param */ readonly installments?: { - readonly enabled?: boolean; + readonly enabled?: boolean readonly plan?: Partial<{ - readonly count: number; + readonly count: number /** @enum {string} */ - readonly interval: "month"; + readonly interval: 'month' /** @enum {string} */ - readonly type: "fixed_count"; + readonly type: 'fixed_count' }> & - Partial<"">; - }; + Partial<''> + } /** @enum {string} */ readonly network?: - | "amex" - | "cartes_bancaires" - | "diners" - | "discover" - | "interac" - | "jcb" - | "mastercard" - | "unionpay" - | "unknown" - | "visa"; + | 'amex' + | 'cartes_bancaires' + | 'diners' + | 'discover' + | 'interac' + | 'jcb' + | 'mastercard' + | 'unionpay' + | 'unknown' + | 'visa' /** @enum {string} */ - readonly request_three_d_secure?: "any" | "automatic"; + readonly request_three_d_secure?: 'any' | 'automatic' /** @enum {string} */ - readonly setup_future_usage?: "" | "none" | "off_session" | "on_session"; + readonly setup_future_usage?: '' | 'none' | 'off_session' | 'on_session' }> & - Partial<"">; - readonly card_present?: Partial<{ readonly [key: string]: unknown }> & Partial<"">; - readonly eps?: Partial<{ readonly [key: string]: unknown }> & Partial<"">; - readonly fpx?: Partial<{ readonly [key: string]: unknown }> & Partial<"">; - readonly giropay?: Partial<{ readonly [key: string]: unknown }> & Partial<"">; - readonly grabpay?: Partial<{ readonly [key: string]: unknown }> & Partial<"">; - readonly ideal?: Partial<{ readonly [key: string]: unknown }> & Partial<"">; - readonly interac_present?: Partial<{ readonly [key: string]: unknown }> & Partial<"">; + Partial<''> + readonly card_present?: Partial<{ readonly [key: string]: unknown }> & Partial<''> + readonly eps?: Partial<{ readonly [key: string]: unknown }> & Partial<''> + readonly fpx?: Partial<{ readonly [key: string]: unknown }> & Partial<''> + readonly giropay?: Partial<{ readonly [key: string]: unknown }> & Partial<''> + readonly grabpay?: Partial<{ readonly [key: string]: unknown }> & Partial<''> + readonly ideal?: Partial<{ readonly [key: string]: unknown }> & Partial<''> + readonly interac_present?: Partial<{ readonly [key: string]: unknown }> & Partial<''> readonly klarna?: Partial<{ /** @enum {string} */ readonly preferred_locale?: - | "da-DK" - | "de-AT" - | "de-DE" - | "en-AT" - | "en-BE" - | "en-DE" - | "en-DK" - | "en-ES" - | "en-FI" - | "en-FR" - | "en-GB" - | "en-IE" - | "en-IT" - | "en-NL" - | "en-NO" - | "en-SE" - | "en-US" - | "es-ES" - | "es-US" - | "fi-FI" - | "fr-BE" - | "fr-FR" - | "it-IT" - | "nb-NO" - | "nl-BE" - | "nl-NL" - | "sv-FI" - | "sv-SE"; + | 'da-DK' + | 'de-AT' + | 'de-DE' + | 'en-AT' + | 'en-BE' + | 'en-DE' + | 'en-DK' + | 'en-ES' + | 'en-FI' + | 'en-FR' + | 'en-GB' + | 'en-IE' + | 'en-IT' + | 'en-NL' + | 'en-NO' + | 'en-SE' + | 'en-US' + | 'es-ES' + | 'es-US' + | 'fi-FI' + | 'fr-BE' + | 'fr-FR' + | 'it-IT' + | 'nb-NO' + | 'nl-BE' + | 'nl-NL' + | 'sv-FI' + | 'sv-SE' }> & - Partial<"">; + Partial<''> readonly oxxo?: Partial<{ - readonly expires_after_days?: number; + readonly expires_after_days?: number }> & - Partial<"">; + Partial<''> readonly p24?: Partial<{ - readonly tos_shown_and_accepted?: boolean; + readonly tos_shown_and_accepted?: boolean }> & - Partial<"">; + Partial<''> readonly sepa_debit?: Partial<{ /** payment_method_options_mandate_options_param */ - readonly mandate_options?: { readonly [key: string]: unknown }; + readonly mandate_options?: { readonly [key: string]: unknown } }> & - Partial<"">; + Partial<''> readonly sofort?: Partial<{ /** @enum {string} */ - readonly preferred_language?: "" | "de" | "en" | "es" | "fr" | "it" | "nl" | "pl"; + readonly preferred_language?: '' | 'de' | 'en' | 'es' | 'fr' | 'it' | 'nl' | 'pl' }> & - Partial<"">; + Partial<''> readonly wechat_pay?: Partial<{ - readonly app_id?: string; + readonly app_id?: string /** @enum {string} */ - readonly client: "android" | "ios" | "web"; + readonly client: 'android' | 'ios' | 'web' }> & - Partial<"">; - }; + Partial<''> + } /** @description The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. */ - readonly payment_method_types?: readonly string[]; + readonly payment_method_types?: readonly string[] /** @description 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). */ - readonly receipt_email?: Partial & Partial<"">; + readonly receipt_email?: Partial & Partial<''> /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * @@ -33590,41 +33352,41 @@ export interface operations { * If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. * @enum {string} */ - readonly setup_future_usage?: "" | "off_session" | "on_session"; + readonly setup_future_usage?: '' | 'off_session' | 'on_session' /** @description Shipping information for this PaymentIntent. */ readonly shipping?: Partial<{ /** optional_fields_address */ readonly address: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; - readonly carrier?: string; - readonly name: string; - readonly phone?: string; - readonly tracking_number?: string; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } + readonly carrier?: string + readonly name: string + readonly phone?: string + readonly tracking_number?: string }> & - Partial<"">; + Partial<''> /** @description For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - readonly statement_descriptor?: string; + readonly statement_descriptor?: string /** @description Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - readonly statement_descriptor_suffix?: string; + readonly statement_descriptor_suffix?: string /** * transfer_data_update_params * @description The parameters used to automatically create a Transfer when the payment succeeds. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ readonly transfer_data?: { - readonly amount?: number; - }; + readonly amount?: number + } /** @description A string that identifies the resulting payment as part of a group. `transfer_group` may only be provided if it has not been set. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. */ - readonly transfer_group?: string; - }; - }; - }; - }; + readonly transfer_group?: string + } + } + } + } /** *

A PaymentIntent object can be canceled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action, or processing.

* @@ -33633,37 +33395,37 @@ export interface operations { readonly PostPaymentIntentsIntentCancel: { readonly parameters: { readonly path: { - readonly intent: string; - }; - }; + readonly intent: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["payment_intent"]; - }; - }; + readonly 'application/json': components['schemas']['payment_intent'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** * @description Reason for canceling this PaymentIntent. Possible values are `duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned` * @enum {string} */ - readonly cancellation_reason?: "abandoned" | "duplicate" | "fraudulent" | "requested_by_customer"; + readonly cancellation_reason?: 'abandoned' | 'duplicate' | 'fraudulent' | 'requested_by_customer' /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } + } /** *

Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.

* @@ -33674,48 +33436,48 @@ export interface operations { readonly PostPaymentIntentsIntentCapture: { readonly parameters: { readonly path: { - readonly intent: string; - }; - }; + readonly intent: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["payment_intent"]; - }; - }; + readonly 'application/json': components['schemas']['payment_intent'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description The amount to capture from the PaymentIntent, which must be less than or equal to the original amount. Any additional amount will be automatically refunded. Defaults to the full `amount_capturable` if not provided. */ - readonly amount_to_capture?: number; + readonly amount_to_capture?: number /** @description 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). */ - readonly application_fee_amount?: number; + readonly application_fee_amount?: number /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - readonly statement_descriptor?: string; + readonly statement_descriptor?: string /** @description Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - readonly statement_descriptor_suffix?: string; + readonly statement_descriptor_suffix?: string /** * transfer_data_update_params * @description The parameters used to automatically create a Transfer when the payment * is captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ readonly transfer_data?: { - readonly amount?: number; - }; - }; - }; - }; - }; + readonly amount?: number + } + } + } + } + } /** *

Confirm that your customer intends to pay with current or provided * payment method. Upon confirmation, the PaymentIntent will attempt to initiate @@ -33746,67 +33508,67 @@ export interface operations { readonly PostPaymentIntentsIntentConfirm: { readonly parameters: { readonly path: { - readonly intent: string; - }; - }; + readonly intent: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["payment_intent"]; - }; - }; + readonly 'application/json': components['schemas']['payment_intent'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description The client secret of the PaymentIntent. */ - readonly client_secret?: string; + readonly client_secret?: string /** @description Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. This parameter is intended for simpler integrations that do not handle customer actions, like [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication). */ - readonly error_on_requires_action?: boolean; + readonly error_on_requires_action?: boolean /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description ID of the mandate to be used for this payment. */ - readonly mandate?: string; + readonly mandate?: string /** @description This hash contains details about the Mandate to create */ readonly mandate_data?: Partial<{ /** customer_acceptance_param */ readonly customer_acceptance: { /** Format: unix-time */ - readonly accepted_at?: number; + readonly accepted_at?: number /** offline_param */ - readonly offline?: { readonly [key: string]: unknown }; + readonly offline?: { readonly [key: string]: unknown } /** online_param */ readonly online?: { - readonly ip_address: string; - readonly user_agent: string; - }; + readonly ip_address: string + readonly user_agent: string + } /** @enum {string} */ - readonly type: "offline" | "online"; - }; + readonly type: 'offline' | 'online' + } }> & Partial<{ /** customer_acceptance_param */ readonly customer_acceptance: { /** online_param */ readonly online: { - readonly ip_address?: string; - readonly user_agent?: string; - }; + readonly ip_address?: string + readonly user_agent?: string + } /** @enum {string} */ - readonly type: "online"; - }; - }>; + readonly type: 'online' + } + }> /** @description Set to `true` to indicate that the customer is not in your checkout flow during this payment attempt, and therefore is unable to authenticate. This parameter is intended for scenarios where you collect card details and [charge them later](https://stripe.com/docs/payments/cards/charging-saved-cards). */ - readonly off_session?: Partial & Partial<"one_off" | "recurring">; + readonly off_session?: Partial & Partial<'one_off' | 'recurring'> /** @description ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. */ - readonly payment_method?: string; + readonly payment_method?: string /** * payment_method_data_params * @description If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear @@ -33816,201 +33578,201 @@ export interface operations { readonly payment_method_data?: { /** payment_method_param */ readonly acss_debit?: { - readonly account_number: string; - readonly institution_number: string; - readonly transit_number: string; - }; + readonly account_number: string + readonly institution_number: string + readonly transit_number: string + } /** param */ - readonly afterpay_clearpay?: { readonly [key: string]: unknown }; + readonly afterpay_clearpay?: { readonly [key: string]: unknown } /** param */ - readonly alipay?: { readonly [key: string]: unknown }; + readonly alipay?: { readonly [key: string]: unknown } /** param */ readonly au_becs_debit?: { - readonly account_number: string; - readonly bsb_number: string; - }; + readonly account_number: string + readonly bsb_number: string + } /** param */ readonly bacs_debit?: { - readonly account_number?: string; - readonly sort_code?: string; - }; + readonly account_number?: string + readonly sort_code?: string + } /** param */ - readonly bancontact?: { readonly [key: string]: unknown }; + readonly bancontact?: { readonly [key: string]: unknown } /** billing_details_inner_params */ readonly billing_details?: { readonly address?: Partial<{ - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string }> & - Partial<"">; - readonly email?: Partial & Partial<"">; - readonly name?: string; - readonly phone?: string; - }; + Partial<''> + readonly email?: Partial & Partial<''> + readonly name?: string + readonly phone?: string + } /** param */ readonly boleto?: { - readonly tax_id: string; - }; + readonly tax_id: string + } /** param */ readonly eps?: { /** @enum {string} */ readonly bank?: - | "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" - | "dolomitenbank" - | "easybank_ag" - | "erste_bank_und_sparkassen" - | "hypo_alpeadriabank_international_ag" - | "hypo_bank_burgenland_aktiengesellschaft" - | "hypo_noe_lb_fur_niederosterreich_u_wien" - | "hypo_oberosterreich_salzburg_steiermark" - | "hypo_tirol_bank_ag" - | "hypo_vorarlberg_bank_ag" - | "marchfelder_bank" - | "oberbank_ag" - | "raiffeisen_bankengruppe_osterreich" - | "schoellerbank_ag" - | "sparda_bank_wien" - | "volksbank_gruppe" - | "volkskreditbank_ag" - | "vr_bank_braunau"; - }; + | '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' + | 'dolomitenbank' + | 'easybank_ag' + | 'erste_bank_und_sparkassen' + | 'hypo_alpeadriabank_international_ag' + | 'hypo_bank_burgenland_aktiengesellschaft' + | 'hypo_noe_lb_fur_niederosterreich_u_wien' + | 'hypo_oberosterreich_salzburg_steiermark' + | 'hypo_tirol_bank_ag' + | 'hypo_vorarlberg_bank_ag' + | 'marchfelder_bank' + | 'oberbank_ag' + | 'raiffeisen_bankengruppe_osterreich' + | 'schoellerbank_ag' + | 'sparda_bank_wien' + | 'volksbank_gruppe' + | 'volkskreditbank_ag' + | 'vr_bank_braunau' + } /** param */ readonly fpx?: { /** @enum {string} */ readonly bank: - | "affin_bank" - | "agrobank" - | "alliance_bank" - | "ambank" - | "bank_islam" - | "bank_muamalat" - | "bank_rakyat" - | "bsn" - | "cimb" - | "deutsche_bank" - | "hong_leong_bank" - | "hsbc" - | "kfh" - | "maybank2e" - | "maybank2u" - | "ocbc" - | "pb_enterprise" - | "public_bank" - | "rhb" - | "standard_chartered" - | "uob"; - }; + | 'affin_bank' + | 'agrobank' + | 'alliance_bank' + | 'ambank' + | 'bank_islam' + | 'bank_muamalat' + | 'bank_rakyat' + | 'bsn' + | 'cimb' + | 'deutsche_bank' + | 'hong_leong_bank' + | 'hsbc' + | 'kfh' + | 'maybank2e' + | 'maybank2u' + | 'ocbc' + | 'pb_enterprise' + | 'public_bank' + | 'rhb' + | 'standard_chartered' + | 'uob' + } /** param */ - readonly giropay?: { readonly [key: string]: unknown }; + readonly giropay?: { readonly [key: string]: unknown } /** param */ - readonly grabpay?: { readonly [key: string]: unknown }; + readonly grabpay?: { readonly [key: string]: unknown } /** param */ readonly ideal?: { /** @enum {string} */ readonly bank?: - | "abn_amro" - | "asn_bank" - | "bunq" - | "handelsbanken" - | "ing" - | "knab" - | "moneyou" - | "rabobank" - | "regiobank" - | "revolut" - | "sns_bank" - | "triodos_bank" - | "van_lanschot"; - }; + | 'abn_amro' + | 'asn_bank' + | 'bunq' + | 'handelsbanken' + | 'ing' + | 'knab' + | 'moneyou' + | 'rabobank' + | 'regiobank' + | 'revolut' + | 'sns_bank' + | 'triodos_bank' + | 'van_lanschot' + } /** param */ - readonly interac_present?: { readonly [key: string]: unknown }; + readonly interac_present?: { readonly [key: string]: unknown } /** param */ readonly klarna?: { /** date_of_birth */ readonly dob?: { - readonly day: number; - readonly month: number; - readonly year: number; - }; - }; - readonly metadata?: { readonly [key: string]: string }; + readonly day: number + readonly month: number + readonly year: number + } + } + readonly metadata?: { readonly [key: string]: string } /** param */ - readonly oxxo?: { readonly [key: string]: unknown }; + readonly oxxo?: { readonly [key: string]: unknown } /** param */ readonly p24?: { /** @enum {string} */ readonly bank?: - | "alior_bank" - | "bank_millennium" - | "bank_nowy_bfg_sa" - | "bank_pekao_sa" - | "banki_spbdzielcze" - | "blik" - | "bnp_paribas" - | "boz" - | "citi_handlowy" - | "credit_agricole" - | "envelobank" - | "etransfer_pocztowy24" - | "getin_bank" - | "ideabank" - | "ing" - | "inteligo" - | "mbank_mtransfer" - | "nest_przelew" - | "noble_pay" - | "pbac_z_ipko" - | "plus_bank" - | "santander_przelew24" - | "tmobile_usbugi_bankowe" - | "toyota_bank" - | "volkswagen_bank"; - }; + | 'alior_bank' + | 'bank_millennium' + | 'bank_nowy_bfg_sa' + | 'bank_pekao_sa' + | 'banki_spbdzielcze' + | 'blik' + | 'bnp_paribas' + | 'boz' + | 'citi_handlowy' + | 'credit_agricole' + | 'envelobank' + | 'etransfer_pocztowy24' + | 'getin_bank' + | 'ideabank' + | 'ing' + | 'inteligo' + | 'mbank_mtransfer' + | 'nest_przelew' + | 'noble_pay' + | 'pbac_z_ipko' + | 'plus_bank' + | 'santander_przelew24' + | 'tmobile_usbugi_bankowe' + | 'toyota_bank' + | 'volkswagen_bank' + } /** param */ readonly sepa_debit?: { - readonly iban: string; - }; + readonly iban: string + } /** param */ readonly sofort?: { /** @enum {string} */ - readonly country: "AT" | "BE" | "DE" | "ES" | "IT" | "NL"; - }; + readonly country: 'AT' | 'BE' | 'DE' | 'ES' | 'IT' | 'NL' + } /** @enum {string} */ readonly type: - | "acss_debit" - | "afterpay_clearpay" - | "alipay" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "eps" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "klarna" - | "oxxo" - | "p24" - | "sepa_debit" - | "sofort" - | "wechat_pay"; + | 'acss_debit' + | 'afterpay_clearpay' + | 'alipay' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'eps' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'klarna' + | 'oxxo' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' /** param */ - readonly wechat_pay?: { readonly [key: string]: unknown }; - }; + readonly wechat_pay?: { readonly [key: string]: unknown } + } /** * payment_method_options_param * @description Payment-method-specific configuration for this PaymentIntent. @@ -34019,140 +33781,140 @@ export interface operations { readonly acss_debit?: Partial<{ /** payment_intent_payment_method_options_mandate_options_param */ readonly mandate_options?: { - readonly custom_mandate_url?: Partial & Partial<"">; - readonly interval_description?: string; + readonly custom_mandate_url?: Partial & Partial<''> + readonly interval_description?: string /** @enum {string} */ - readonly payment_schedule?: "combined" | "interval" | "sporadic"; + readonly payment_schedule?: 'combined' | 'interval' | 'sporadic' /** @enum {string} */ - readonly transaction_type?: "business" | "personal"; - }; + readonly transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - readonly verification_method?: "automatic" | "instant" | "microdeposits"; + readonly verification_method?: 'automatic' | 'instant' | 'microdeposits' }> & - Partial<"">; + Partial<''> readonly afterpay_clearpay?: Partial<{ - readonly reference?: string; + readonly reference?: string }> & - Partial<"">; - readonly alipay?: Partial<{ readonly [key: string]: unknown }> & Partial<"">; - readonly au_becs_debit?: Partial<{ readonly [key: string]: unknown }> & Partial<"">; - readonly bacs_debit?: Partial<{ readonly [key: string]: unknown }> & Partial<"">; + Partial<''> + readonly alipay?: Partial<{ readonly [key: string]: unknown }> & Partial<''> + readonly au_becs_debit?: Partial<{ readonly [key: string]: unknown }> & Partial<''> + readonly bacs_debit?: Partial<{ readonly [key: string]: unknown }> & Partial<''> readonly bancontact?: Partial<{ /** @enum {string} */ - readonly preferred_language?: "de" | "en" | "fr" | "nl"; + readonly preferred_language?: 'de' | 'en' | 'fr' | 'nl' }> & - Partial<"">; + Partial<''> readonly boleto?: Partial<{ - readonly expires_after_days?: number; + readonly expires_after_days?: number }> & - Partial<"">; + Partial<''> readonly card?: Partial<{ - readonly cvc_token?: string; + readonly cvc_token?: string /** installments_param */ readonly installments?: { - readonly enabled?: boolean; + readonly enabled?: boolean readonly plan?: Partial<{ - readonly count: number; + readonly count: number /** @enum {string} */ - readonly interval: "month"; + readonly interval: 'month' /** @enum {string} */ - readonly type: "fixed_count"; + readonly type: 'fixed_count' }> & - Partial<"">; - }; + Partial<''> + } /** @enum {string} */ readonly network?: - | "amex" - | "cartes_bancaires" - | "diners" - | "discover" - | "interac" - | "jcb" - | "mastercard" - | "unionpay" - | "unknown" - | "visa"; + | 'amex' + | 'cartes_bancaires' + | 'diners' + | 'discover' + | 'interac' + | 'jcb' + | 'mastercard' + | 'unionpay' + | 'unknown' + | 'visa' /** @enum {string} */ - readonly request_three_d_secure?: "any" | "automatic"; + readonly request_three_d_secure?: 'any' | 'automatic' /** @enum {string} */ - readonly setup_future_usage?: "" | "none" | "off_session" | "on_session"; + readonly setup_future_usage?: '' | 'none' | 'off_session' | 'on_session' }> & - Partial<"">; - readonly card_present?: Partial<{ readonly [key: string]: unknown }> & Partial<"">; - readonly eps?: Partial<{ readonly [key: string]: unknown }> & Partial<"">; - readonly fpx?: Partial<{ readonly [key: string]: unknown }> & Partial<"">; - readonly giropay?: Partial<{ readonly [key: string]: unknown }> & Partial<"">; - readonly grabpay?: Partial<{ readonly [key: string]: unknown }> & Partial<"">; - readonly ideal?: Partial<{ readonly [key: string]: unknown }> & Partial<"">; - readonly interac_present?: Partial<{ readonly [key: string]: unknown }> & Partial<"">; + Partial<''> + readonly card_present?: Partial<{ readonly [key: string]: unknown }> & Partial<''> + readonly eps?: Partial<{ readonly [key: string]: unknown }> & Partial<''> + readonly fpx?: Partial<{ readonly [key: string]: unknown }> & Partial<''> + readonly giropay?: Partial<{ readonly [key: string]: unknown }> & Partial<''> + readonly grabpay?: Partial<{ readonly [key: string]: unknown }> & Partial<''> + readonly ideal?: Partial<{ readonly [key: string]: unknown }> & Partial<''> + readonly interac_present?: Partial<{ readonly [key: string]: unknown }> & Partial<''> readonly klarna?: Partial<{ /** @enum {string} */ readonly preferred_locale?: - | "da-DK" - | "de-AT" - | "de-DE" - | "en-AT" - | "en-BE" - | "en-DE" - | "en-DK" - | "en-ES" - | "en-FI" - | "en-FR" - | "en-GB" - | "en-IE" - | "en-IT" - | "en-NL" - | "en-NO" - | "en-SE" - | "en-US" - | "es-ES" - | "es-US" - | "fi-FI" - | "fr-BE" - | "fr-FR" - | "it-IT" - | "nb-NO" - | "nl-BE" - | "nl-NL" - | "sv-FI" - | "sv-SE"; + | 'da-DK' + | 'de-AT' + | 'de-DE' + | 'en-AT' + | 'en-BE' + | 'en-DE' + | 'en-DK' + | 'en-ES' + | 'en-FI' + | 'en-FR' + | 'en-GB' + | 'en-IE' + | 'en-IT' + | 'en-NL' + | 'en-NO' + | 'en-SE' + | 'en-US' + | 'es-ES' + | 'es-US' + | 'fi-FI' + | 'fr-BE' + | 'fr-FR' + | 'it-IT' + | 'nb-NO' + | 'nl-BE' + | 'nl-NL' + | 'sv-FI' + | 'sv-SE' }> & - Partial<"">; + Partial<''> readonly oxxo?: Partial<{ - readonly expires_after_days?: number; + readonly expires_after_days?: number }> & - Partial<"">; + Partial<''> readonly p24?: Partial<{ - readonly tos_shown_and_accepted?: boolean; + readonly tos_shown_and_accepted?: boolean }> & - Partial<"">; + Partial<''> readonly sepa_debit?: Partial<{ /** payment_method_options_mandate_options_param */ - readonly mandate_options?: { readonly [key: string]: unknown }; + readonly mandate_options?: { readonly [key: string]: unknown } }> & - Partial<"">; + Partial<''> readonly sofort?: Partial<{ /** @enum {string} */ - readonly preferred_language?: "" | "de" | "en" | "es" | "fr" | "it" | "nl" | "pl"; + readonly preferred_language?: '' | 'de' | 'en' | 'es' | 'fr' | 'it' | 'nl' | 'pl' }> & - Partial<"">; + Partial<''> readonly wechat_pay?: Partial<{ - readonly app_id?: string; + readonly app_id?: string /** @enum {string} */ - readonly client: "android" | "ios" | "web"; + readonly client: 'android' | 'ios' | 'web' }> & - Partial<"">; - }; + Partial<''> + } /** @description The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. */ - readonly payment_method_types?: readonly string[]; + readonly payment_method_types?: readonly string[] /** @description 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). */ - readonly receipt_email?: Partial & Partial<"">; + readonly receipt_email?: Partial & Partial<''> /** * @description The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. * If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. * This parameter is only used for cards and other redirect-based payment methods. */ - readonly return_url?: string; + readonly return_url?: string /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * @@ -34163,130 +33925,130 @@ export interface operations { * If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. * @enum {string} */ - readonly setup_future_usage?: "" | "off_session" | "on_session"; + readonly setup_future_usage?: '' | 'off_session' | 'on_session' /** @description Shipping information for this PaymentIntent. */ readonly shipping?: Partial<{ /** optional_fields_address */ readonly address: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; - readonly carrier?: string; - readonly name: string; - readonly phone?: string; - readonly tracking_number?: string; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } + readonly carrier?: string + readonly name: string + readonly phone?: string + readonly tracking_number?: string }> & - Partial<"">; + Partial<''> /** @description Set to `true` only when using manual confirmation and the iOS or Android SDKs to handle additional authentication steps. */ - readonly use_stripe_sdk?: boolean; - }; - }; - }; - }; + readonly use_stripe_sdk?: boolean + } + } + } + } /**

Verifies microdeposits on a PaymentIntent object.

*/ readonly PostPaymentIntentsIntentVerifyMicrodeposits: { readonly parameters: { readonly path: { - readonly intent: string; - }; - }; + readonly intent: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["payment_intent"]; - }; - }; + readonly 'application/json': components['schemas']['payment_intent'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account. */ - readonly amounts?: readonly number[]; + readonly amounts?: readonly number[] /** @description The client secret of the PaymentIntent. */ - readonly client_secret?: string; + readonly client_secret?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } + } /**

Returns a list of your payment links.

*/ readonly GetPaymentLinks: { readonly parameters: { readonly query: { /** Only return payment links that are active or inactive (e.g., pass `false` to list all inactive payment links). */ - readonly active?: boolean; + readonly active?: boolean /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["payment_link"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['payment_link'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Creates a payment link.

*/ readonly PostPaymentLinks: { readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["payment_link"]; - }; - }; + readonly 'application/json': components['schemas']['payment_link'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** * after_completion_params * @description Behavior after the purchase is complete. @@ -34294,52 +34056,52 @@ export interface operations { readonly after_completion?: { /** after_completion_confirmation_page_params */ readonly hosted_confirmation?: { - readonly custom_message?: string; - }; + readonly custom_message?: string + } /** after_completion_redirect_params */ readonly redirect?: { - readonly url: string; - }; + readonly url: string + } /** @enum {string} */ - readonly type: "hosted_confirmation" | "redirect"; - }; + readonly type: 'hosted_confirmation' | 'redirect' + } /** @description Enables user redeemable promotion codes. */ - readonly allow_promotion_codes?: boolean; + readonly allow_promotion_codes?: boolean /** @description 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. Can only be applied when there are no line items with recurring prices. */ - readonly application_fee_amount?: number; + readonly application_fee_amount?: number /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field. */ - readonly application_fee_percent?: number; + readonly application_fee_percent?: number /** * automatic_tax_params * @description Configuration for automatic tax collection. */ readonly automatic_tax?: { - readonly enabled: boolean; - }; + readonly enabled: boolean + } /** * @description Configuration for collecting the customer's billing address. * @enum {string} */ - readonly billing_address_collection?: "auto" | "required"; + readonly billing_address_collection?: 'auto' | 'required' /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported. */ readonly line_items?: readonly { /** adjustable_quantity_params */ readonly adjustable_quantity?: { - readonly enabled: boolean; - readonly maximum?: number; - readonly minimum?: number; - }; - readonly price: string; - readonly quantity: number; - }[]; + readonly enabled: boolean + readonly maximum?: number + readonly minimum?: number + } + readonly price: string + readonly quantity: number + }[] /** @description 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 associated with this Payment Link will automatically be copied to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link. */ - readonly metadata?: { readonly [key: string]: string }; + readonly metadata?: { readonly [key: string]: string } /** @description The account on behalf of which to charge. */ - readonly on_behalf_of?: string; + readonly on_behalf_of?: string /** @description The list of payment method types that customers can use. Only `card` is supported. If no value is passed, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods) (20+ payment methods [supported](https://stripe.com/docs/payments/payment-methods/integration-options#payment-method-product-support)). */ - readonly payment_method_types?: readonly "card"[]; + readonly payment_method_types?: readonly 'card'[] /** * phone_number_collection_params * @description Controls phone number collection settings during checkout. @@ -34347,329 +34109,329 @@ export interface operations { * We recommend that you review your privacy policy and check with your legal contacts. */ readonly phone_number_collection?: { - readonly enabled: boolean; - }; + readonly enabled: boolean + } /** * shipping_address_collection_params * @description Configuration for collecting the customer's shipping address. */ readonly shipping_address_collection?: { readonly allowed_countries: readonly ( - | "AC" - | "AD" - | "AE" - | "AF" - | "AG" - | "AI" - | "AL" - | "AM" - | "AO" - | "AQ" - | "AR" - | "AT" - | "AU" - | "AW" - | "AX" - | "AZ" - | "BA" - | "BB" - | "BD" - | "BE" - | "BF" - | "BG" - | "BH" - | "BI" - | "BJ" - | "BL" - | "BM" - | "BN" - | "BO" - | "BQ" - | "BR" - | "BS" - | "BT" - | "BV" - | "BW" - | "BY" - | "BZ" - | "CA" - | "CD" - | "CF" - | "CG" - | "CH" - | "CI" - | "CK" - | "CL" - | "CM" - | "CN" - | "CO" - | "CR" - | "CV" - | "CW" - | "CY" - | "CZ" - | "DE" - | "DJ" - | "DK" - | "DM" - | "DO" - | "DZ" - | "EC" - | "EE" - | "EG" - | "EH" - | "ER" - | "ES" - | "ET" - | "FI" - | "FJ" - | "FK" - | "FO" - | "FR" - | "GA" - | "GB" - | "GD" - | "GE" - | "GF" - | "GG" - | "GH" - | "GI" - | "GL" - | "GM" - | "GN" - | "GP" - | "GQ" - | "GR" - | "GS" - | "GT" - | "GU" - | "GW" - | "GY" - | "HK" - | "HN" - | "HR" - | "HT" - | "HU" - | "ID" - | "IE" - | "IL" - | "IM" - | "IN" - | "IO" - | "IQ" - | "IS" - | "IT" - | "JE" - | "JM" - | "JO" - | "JP" - | "KE" - | "KG" - | "KH" - | "KI" - | "KM" - | "KN" - | "KR" - | "KW" - | "KY" - | "KZ" - | "LA" - | "LB" - | "LC" - | "LI" - | "LK" - | "LR" - | "LS" - | "LT" - | "LU" - | "LV" - | "LY" - | "MA" - | "MC" - | "MD" - | "ME" - | "MF" - | "MG" - | "MK" - | "ML" - | "MM" - | "MN" - | "MO" - | "MQ" - | "MR" - | "MS" - | "MT" - | "MU" - | "MV" - | "MW" - | "MX" - | "MY" - | "MZ" - | "NA" - | "NC" - | "NE" - | "NG" - | "NI" - | "NL" - | "NO" - | "NP" - | "NR" - | "NU" - | "NZ" - | "OM" - | "PA" - | "PE" - | "PF" - | "PG" - | "PH" - | "PK" - | "PL" - | "PM" - | "PN" - | "PR" - | "PS" - | "PT" - | "PY" - | "QA" - | "RE" - | "RO" - | "RS" - | "RU" - | "RW" - | "SA" - | "SB" - | "SC" - | "SE" - | "SG" - | "SH" - | "SI" - | "SJ" - | "SK" - | "SL" - | "SM" - | "SN" - | "SO" - | "SR" - | "SS" - | "ST" - | "SV" - | "SX" - | "SZ" - | "TA" - | "TC" - | "TD" - | "TF" - | "TG" - | "TH" - | "TJ" - | "TK" - | "TL" - | "TM" - | "TN" - | "TO" - | "TR" - | "TT" - | "TV" - | "TW" - | "TZ" - | "UA" - | "UG" - | "US" - | "UY" - | "UZ" - | "VA" - | "VC" - | "VE" - | "VG" - | "VN" - | "VU" - | "WF" - | "WS" - | "XK" - | "YE" - | "YT" - | "ZA" - | "ZM" - | "ZW" - | "ZZ" - )[]; - }; + | 'AC' + | 'AD' + | 'AE' + | 'AF' + | 'AG' + | 'AI' + | 'AL' + | 'AM' + | 'AO' + | 'AQ' + | 'AR' + | 'AT' + | 'AU' + | 'AW' + | 'AX' + | 'AZ' + | 'BA' + | 'BB' + | 'BD' + | 'BE' + | 'BF' + | 'BG' + | 'BH' + | 'BI' + | 'BJ' + | 'BL' + | 'BM' + | 'BN' + | 'BO' + | 'BQ' + | 'BR' + | 'BS' + | 'BT' + | 'BV' + | 'BW' + | 'BY' + | 'BZ' + | 'CA' + | 'CD' + | 'CF' + | 'CG' + | 'CH' + | 'CI' + | 'CK' + | 'CL' + | 'CM' + | 'CN' + | 'CO' + | 'CR' + | 'CV' + | 'CW' + | 'CY' + | 'CZ' + | 'DE' + | 'DJ' + | 'DK' + | 'DM' + | 'DO' + | 'DZ' + | 'EC' + | 'EE' + | 'EG' + | 'EH' + | 'ER' + | 'ES' + | 'ET' + | 'FI' + | 'FJ' + | 'FK' + | 'FO' + | 'FR' + | 'GA' + | 'GB' + | 'GD' + | 'GE' + | 'GF' + | 'GG' + | 'GH' + | 'GI' + | 'GL' + | 'GM' + | 'GN' + | 'GP' + | 'GQ' + | 'GR' + | 'GS' + | 'GT' + | 'GU' + | 'GW' + | 'GY' + | 'HK' + | 'HN' + | 'HR' + | 'HT' + | 'HU' + | 'ID' + | 'IE' + | 'IL' + | 'IM' + | 'IN' + | 'IO' + | 'IQ' + | 'IS' + | 'IT' + | 'JE' + | 'JM' + | 'JO' + | 'JP' + | 'KE' + | 'KG' + | 'KH' + | 'KI' + | 'KM' + | 'KN' + | 'KR' + | 'KW' + | 'KY' + | 'KZ' + | 'LA' + | 'LB' + | 'LC' + | 'LI' + | 'LK' + | 'LR' + | 'LS' + | 'LT' + | 'LU' + | 'LV' + | 'LY' + | 'MA' + | 'MC' + | 'MD' + | 'ME' + | 'MF' + | 'MG' + | 'MK' + | 'ML' + | 'MM' + | 'MN' + | 'MO' + | 'MQ' + | 'MR' + | 'MS' + | 'MT' + | 'MU' + | 'MV' + | 'MW' + | 'MX' + | 'MY' + | 'MZ' + | 'NA' + | 'NC' + | 'NE' + | 'NG' + | 'NI' + | 'NL' + | 'NO' + | 'NP' + | 'NR' + | 'NU' + | 'NZ' + | 'OM' + | 'PA' + | 'PE' + | 'PF' + | 'PG' + | 'PH' + | 'PK' + | 'PL' + | 'PM' + | 'PN' + | 'PR' + | 'PS' + | 'PT' + | 'PY' + | 'QA' + | 'RE' + | 'RO' + | 'RS' + | 'RU' + | 'RW' + | 'SA' + | 'SB' + | 'SC' + | 'SE' + | 'SG' + | 'SH' + | 'SI' + | 'SJ' + | 'SK' + | 'SL' + | 'SM' + | 'SN' + | 'SO' + | 'SR' + | 'SS' + | 'ST' + | 'SV' + | 'SX' + | 'SZ' + | 'TA' + | 'TC' + | 'TD' + | 'TF' + | 'TG' + | 'TH' + | 'TJ' + | 'TK' + | 'TL' + | 'TM' + | 'TN' + | 'TO' + | 'TR' + | 'TT' + | 'TV' + | 'TW' + | 'TZ' + | 'UA' + | 'UG' + | 'US' + | 'UY' + | 'UZ' + | 'VA' + | 'VC' + | 'VE' + | 'VG' + | 'VN' + | 'VU' + | 'WF' + | 'WS' + | 'XK' + | 'YE' + | 'YT' + | 'ZA' + | 'ZM' + | 'ZW' + | 'ZZ' + )[] + } /** * subscription_data_params * @description 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`. */ readonly subscription_data?: { - readonly trial_period_days?: number; - }; + readonly trial_period_days?: number + } /** * transfer_data_params * @description The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to. */ readonly transfer_data?: { - readonly amount?: number; - readonly destination: string; - }; - }; - }; - }; - }; + readonly amount?: number + readonly destination: string + } + } + } + } + } /**

Retrieve a payment link.

*/ readonly GetPaymentLinksPaymentLink: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly payment_link: string; - }; - }; + readonly payment_link: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["payment_link"]; - }; - }; + readonly 'application/json': components['schemas']['payment_link'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Updates a payment link.

*/ readonly PostPaymentLinksPaymentLink: { readonly parameters: { readonly path: { - readonly payment_link: string; - }; - }; + readonly payment_link: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["payment_link"]; - }; - }; + readonly 'application/json': components['schemas']['payment_link'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description 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. */ - readonly active?: boolean; + readonly active?: boolean /** * after_completion_params * @description Behavior after the purchase is complete. @@ -34677,410 +34439,410 @@ export interface operations { readonly after_completion?: { /** after_completion_confirmation_page_params */ readonly hosted_confirmation?: { - readonly custom_message?: string; - }; + readonly custom_message?: string + } /** after_completion_redirect_params */ readonly redirect?: { - readonly url: string; - }; + readonly url: string + } /** @enum {string} */ - readonly type: "hosted_confirmation" | "redirect"; - }; + readonly type: 'hosted_confirmation' | 'redirect' + } /** @description Enables user redeemable promotion codes. */ - readonly allow_promotion_codes?: boolean; + readonly allow_promotion_codes?: boolean /** * automatic_tax_params * @description Configuration for automatic tax collection. */ readonly automatic_tax?: { - readonly enabled: boolean; - }; + readonly enabled: boolean + } /** * @description Configuration for collecting the customer's billing address. * @enum {string} */ - readonly billing_address_collection?: "auto" | "required"; + readonly billing_address_collection?: 'auto' | 'required' /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported. */ readonly line_items?: readonly { /** adjustable_quantity_params */ readonly adjustable_quantity?: { - readonly enabled: boolean; - readonly maximum?: number; - readonly minimum?: number; - }; - readonly id: string; - readonly quantity?: number; - }[]; + readonly enabled: boolean + readonly maximum?: number + readonly minimum?: number + } + readonly id: string + readonly quantity?: number + }[] /** @description 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 associated with this Payment Link will automatically be copied to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link. */ - readonly metadata?: { readonly [key: string]: string }; + readonly metadata?: { readonly [key: string]: string } /** @description The list of payment method types that customers can use. Only `card` is supported. Pass an empty string to enable automatic payment methods that use your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). */ - readonly payment_method_types?: Partial & Partial<"">; + readonly payment_method_types?: Partial & Partial<''> /** @description Configuration for collecting the customer's shipping address. */ readonly shipping_address_collection?: Partial<{ readonly allowed_countries: readonly ( - | "AC" - | "AD" - | "AE" - | "AF" - | "AG" - | "AI" - | "AL" - | "AM" - | "AO" - | "AQ" - | "AR" - | "AT" - | "AU" - | "AW" - | "AX" - | "AZ" - | "BA" - | "BB" - | "BD" - | "BE" - | "BF" - | "BG" - | "BH" - | "BI" - | "BJ" - | "BL" - | "BM" - | "BN" - | "BO" - | "BQ" - | "BR" - | "BS" - | "BT" - | "BV" - | "BW" - | "BY" - | "BZ" - | "CA" - | "CD" - | "CF" - | "CG" - | "CH" - | "CI" - | "CK" - | "CL" - | "CM" - | "CN" - | "CO" - | "CR" - | "CV" - | "CW" - | "CY" - | "CZ" - | "DE" - | "DJ" - | "DK" - | "DM" - | "DO" - | "DZ" - | "EC" - | "EE" - | "EG" - | "EH" - | "ER" - | "ES" - | "ET" - | "FI" - | "FJ" - | "FK" - | "FO" - | "FR" - | "GA" - | "GB" - | "GD" - | "GE" - | "GF" - | "GG" - | "GH" - | "GI" - | "GL" - | "GM" - | "GN" - | "GP" - | "GQ" - | "GR" - | "GS" - | "GT" - | "GU" - | "GW" - | "GY" - | "HK" - | "HN" - | "HR" - | "HT" - | "HU" - | "ID" - | "IE" - | "IL" - | "IM" - | "IN" - | "IO" - | "IQ" - | "IS" - | "IT" - | "JE" - | "JM" - | "JO" - | "JP" - | "KE" - | "KG" - | "KH" - | "KI" - | "KM" - | "KN" - | "KR" - | "KW" - | "KY" - | "KZ" - | "LA" - | "LB" - | "LC" - | "LI" - | "LK" - | "LR" - | "LS" - | "LT" - | "LU" - | "LV" - | "LY" - | "MA" - | "MC" - | "MD" - | "ME" - | "MF" - | "MG" - | "MK" - | "ML" - | "MM" - | "MN" - | "MO" - | "MQ" - | "MR" - | "MS" - | "MT" - | "MU" - | "MV" - | "MW" - | "MX" - | "MY" - | "MZ" - | "NA" - | "NC" - | "NE" - | "NG" - | "NI" - | "NL" - | "NO" - | "NP" - | "NR" - | "NU" - | "NZ" - | "OM" - | "PA" - | "PE" - | "PF" - | "PG" - | "PH" - | "PK" - | "PL" - | "PM" - | "PN" - | "PR" - | "PS" - | "PT" - | "PY" - | "QA" - | "RE" - | "RO" - | "RS" - | "RU" - | "RW" - | "SA" - | "SB" - | "SC" - | "SE" - | "SG" - | "SH" - | "SI" - | "SJ" - | "SK" - | "SL" - | "SM" - | "SN" - | "SO" - | "SR" - | "SS" - | "ST" - | "SV" - | "SX" - | "SZ" - | "TA" - | "TC" - | "TD" - | "TF" - | "TG" - | "TH" - | "TJ" - | "TK" - | "TL" - | "TM" - | "TN" - | "TO" - | "TR" - | "TT" - | "TV" - | "TW" - | "TZ" - | "UA" - | "UG" - | "US" - | "UY" - | "UZ" - | "VA" - | "VC" - | "VE" - | "VG" - | "VN" - | "VU" - | "WF" - | "WS" - | "XK" - | "YE" - | "YT" - | "ZA" - | "ZM" - | "ZW" - | "ZZ" - )[]; + | 'AC' + | 'AD' + | 'AE' + | 'AF' + | 'AG' + | 'AI' + | 'AL' + | 'AM' + | 'AO' + | 'AQ' + | 'AR' + | 'AT' + | 'AU' + | 'AW' + | 'AX' + | 'AZ' + | 'BA' + | 'BB' + | 'BD' + | 'BE' + | 'BF' + | 'BG' + | 'BH' + | 'BI' + | 'BJ' + | 'BL' + | 'BM' + | 'BN' + | 'BO' + | 'BQ' + | 'BR' + | 'BS' + | 'BT' + | 'BV' + | 'BW' + | 'BY' + | 'BZ' + | 'CA' + | 'CD' + | 'CF' + | 'CG' + | 'CH' + | 'CI' + | 'CK' + | 'CL' + | 'CM' + | 'CN' + | 'CO' + | 'CR' + | 'CV' + | 'CW' + | 'CY' + | 'CZ' + | 'DE' + | 'DJ' + | 'DK' + | 'DM' + | 'DO' + | 'DZ' + | 'EC' + | 'EE' + | 'EG' + | 'EH' + | 'ER' + | 'ES' + | 'ET' + | 'FI' + | 'FJ' + | 'FK' + | 'FO' + | 'FR' + | 'GA' + | 'GB' + | 'GD' + | 'GE' + | 'GF' + | 'GG' + | 'GH' + | 'GI' + | 'GL' + | 'GM' + | 'GN' + | 'GP' + | 'GQ' + | 'GR' + | 'GS' + | 'GT' + | 'GU' + | 'GW' + | 'GY' + | 'HK' + | 'HN' + | 'HR' + | 'HT' + | 'HU' + | 'ID' + | 'IE' + | 'IL' + | 'IM' + | 'IN' + | 'IO' + | 'IQ' + | 'IS' + | 'IT' + | 'JE' + | 'JM' + | 'JO' + | 'JP' + | 'KE' + | 'KG' + | 'KH' + | 'KI' + | 'KM' + | 'KN' + | 'KR' + | 'KW' + | 'KY' + | 'KZ' + | 'LA' + | 'LB' + | 'LC' + | 'LI' + | 'LK' + | 'LR' + | 'LS' + | 'LT' + | 'LU' + | 'LV' + | 'LY' + | 'MA' + | 'MC' + | 'MD' + | 'ME' + | 'MF' + | 'MG' + | 'MK' + | 'ML' + | 'MM' + | 'MN' + | 'MO' + | 'MQ' + | 'MR' + | 'MS' + | 'MT' + | 'MU' + | 'MV' + | 'MW' + | 'MX' + | 'MY' + | 'MZ' + | 'NA' + | 'NC' + | 'NE' + | 'NG' + | 'NI' + | 'NL' + | 'NO' + | 'NP' + | 'NR' + | 'NU' + | 'NZ' + | 'OM' + | 'PA' + | 'PE' + | 'PF' + | 'PG' + | 'PH' + | 'PK' + | 'PL' + | 'PM' + | 'PN' + | 'PR' + | 'PS' + | 'PT' + | 'PY' + | 'QA' + | 'RE' + | 'RO' + | 'RS' + | 'RU' + | 'RW' + | 'SA' + | 'SB' + | 'SC' + | 'SE' + | 'SG' + | 'SH' + | 'SI' + | 'SJ' + | 'SK' + | 'SL' + | 'SM' + | 'SN' + | 'SO' + | 'SR' + | 'SS' + | 'ST' + | 'SV' + | 'SX' + | 'SZ' + | 'TA' + | 'TC' + | 'TD' + | 'TF' + | 'TG' + | 'TH' + | 'TJ' + | 'TK' + | 'TL' + | 'TM' + | 'TN' + | 'TO' + | 'TR' + | 'TT' + | 'TV' + | 'TW' + | 'TZ' + | 'UA' + | 'UG' + | 'US' + | 'UY' + | 'UZ' + | 'VA' + | 'VC' + | 'VE' + | 'VG' + | 'VN' + | 'VU' + | 'WF' + | 'WS' + | 'XK' + | 'YE' + | 'YT' + | 'ZA' + | 'ZM' + | 'ZW' + | 'ZZ' + )[] }> & - Partial<"">; - }; - }; - }; - }; + Partial<''> + } + } + } + } /**

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.

*/ readonly GetPaymentLinksPaymentLinkLineItems: { readonly parameters: { readonly query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; + readonly starting_after?: string + } readonly path: { - readonly payment_link: string; - }; - }; + readonly payment_link: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Details about each object. */ - readonly data: readonly components["schemas"]["item"][]; + readonly data: readonly components['schemas']['item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Returns a list of PaymentMethods. For listing a customer’s payment methods, you should use List a Customer’s PaymentMethods

*/ readonly GetPaymentMethods: { readonly parameters: { readonly query: { /** The ID of the customer whose PaymentMethods will be retrieved. If not provided, the response list will be empty. */ - readonly customer?: string; + readonly customer?: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** A required filter on the list, based on the object `type` field. */ readonly type: - | "acss_debit" - | "afterpay_clearpay" - | "alipay" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "eps" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "klarna" - | "oxxo" - | "p24" - | "sepa_debit" - | "sofort" - | "wechat_pay"; - }; - }; - readonly responses: { - /** Successful response. */ - readonly 200: { - readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["payment_method"][]; + | 'acss_debit' + | 'afterpay_clearpay' + | 'alipay' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'eps' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'klarna' + | 'oxxo' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' + } + } + readonly responses: { + /** Successful response. */ + readonly 200: { + readonly content: { + readonly 'application/json': { + readonly data: readonly components['schemas']['payment_method'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /** *

Creates a PaymentMethod object. Read the Stripe.js reference to learn how to create PaymentMethods via Stripe.js.

* @@ -35091,96 +34853,96 @@ export interface operations { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["payment_method"]; - }; - }; + readonly 'application/json': components['schemas']['payment_method'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** * payment_method_param * @description If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. */ readonly acss_debit?: { - readonly account_number: string; - readonly institution_number: string; - readonly transit_number: string; - }; + readonly account_number: string + readonly institution_number: string + readonly transit_number: string + } /** * param * @description If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method. */ - readonly afterpay_clearpay?: { readonly [key: string]: unknown }; + readonly afterpay_clearpay?: { readonly [key: string]: unknown } /** * param * @description If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method. */ - readonly alipay?: { readonly [key: string]: unknown }; + readonly alipay?: { readonly [key: string]: unknown } /** * param * @description If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account. */ readonly au_becs_debit?: { - readonly account_number: string; - readonly bsb_number: string; - }; + readonly account_number: string + readonly bsb_number: string + } /** * param * @description If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account. */ readonly bacs_debit?: { - readonly account_number?: string; - readonly sort_code?: string; - }; + readonly account_number?: string + readonly sort_code?: string + } /** * param * @description If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method. */ - readonly bancontact?: { readonly [key: string]: unknown }; + readonly bancontact?: { readonly [key: string]: unknown } /** * billing_details_inner_params * @description Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods. */ readonly billing_details?: { readonly address?: Partial<{ - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string }> & - Partial<"">; - readonly email?: Partial & Partial<"">; - readonly name?: string; - readonly phone?: string; - }; + Partial<''> + readonly email?: Partial & Partial<''> + readonly name?: string + readonly phone?: string + } /** * param * @description If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method. */ readonly boleto?: { - readonly tax_id: string; - }; + readonly tax_id: string + } /** @description If this is a `card` PaymentMethod, this hash contains the user's card details. For backwards compatibility, you can alternatively provide a Stripe token (e.g., for Apple Pay, Amex Express Checkout, or legacy Checkout) into the card hash with format `card: {token: "tok_visa"}`. When providing a card number, you must meet the requirements for [PCI compliance](https://stripe.com/docs/security#validating-pci-compliance). We strongly recommend using Stripe.js instead of interacting with this API directly. */ readonly card?: Partial<{ - readonly cvc?: string; - readonly exp_month: number; - readonly exp_year: number; - readonly number: string; + readonly cvc?: string + readonly exp_month: number + readonly exp_year: number + readonly number: string }> & Partial<{ - readonly token: string; - }>; + readonly token: string + }> /** @description The `Customer` to whom the original PaymentMethod is attached. */ - readonly customer?: string; + readonly customer?: string /** * param * @description If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method. @@ -35188,36 +34950,36 @@ export interface operations { readonly eps?: { /** @enum {string} */ readonly bank?: - | "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" - | "dolomitenbank" - | "easybank_ag" - | "erste_bank_und_sparkassen" - | "hypo_alpeadriabank_international_ag" - | "hypo_bank_burgenland_aktiengesellschaft" - | "hypo_noe_lb_fur_niederosterreich_u_wien" - | "hypo_oberosterreich_salzburg_steiermark" - | "hypo_tirol_bank_ag" - | "hypo_vorarlberg_bank_ag" - | "marchfelder_bank" - | "oberbank_ag" - | "raiffeisen_bankengruppe_osterreich" - | "schoellerbank_ag" - | "sparda_bank_wien" - | "volksbank_gruppe" - | "volkskreditbank_ag" - | "vr_bank_braunau"; - }; + | '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' + | 'dolomitenbank' + | 'easybank_ag' + | 'erste_bank_und_sparkassen' + | 'hypo_alpeadriabank_international_ag' + | 'hypo_bank_burgenland_aktiengesellschaft' + | 'hypo_noe_lb_fur_niederosterreich_u_wien' + | 'hypo_oberosterreich_salzburg_steiermark' + | 'hypo_tirol_bank_ag' + | 'hypo_vorarlberg_bank_ag' + | 'marchfelder_bank' + | 'oberbank_ag' + | 'raiffeisen_bankengruppe_osterreich' + | 'schoellerbank_ag' + | 'sparda_bank_wien' + | 'volksbank_gruppe' + | 'volkskreditbank_ag' + | 'vr_bank_braunau' + } /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** * param * @description If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method. @@ -35225,38 +34987,38 @@ export interface operations { readonly fpx?: { /** @enum {string} */ readonly bank: - | "affin_bank" - | "agrobank" - | "alliance_bank" - | "ambank" - | "bank_islam" - | "bank_muamalat" - | "bank_rakyat" - | "bsn" - | "cimb" - | "deutsche_bank" - | "hong_leong_bank" - | "hsbc" - | "kfh" - | "maybank2e" - | "maybank2u" - | "ocbc" - | "pb_enterprise" - | "public_bank" - | "rhb" - | "standard_chartered" - | "uob"; - }; + | 'affin_bank' + | 'agrobank' + | 'alliance_bank' + | 'ambank' + | 'bank_islam' + | 'bank_muamalat' + | 'bank_rakyat' + | 'bsn' + | 'cimb' + | 'deutsche_bank' + | 'hong_leong_bank' + | 'hsbc' + | 'kfh' + | 'maybank2e' + | 'maybank2u' + | 'ocbc' + | 'pb_enterprise' + | 'public_bank' + | 'rhb' + | 'standard_chartered' + | 'uob' + } /** * param * @description If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method. */ - readonly giropay?: { readonly [key: string]: unknown }; + readonly giropay?: { readonly [key: string]: unknown } /** * param * @description If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method. */ - readonly grabpay?: { readonly [key: string]: unknown }; + readonly grabpay?: { readonly [key: string]: unknown } /** * param * @description If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method. @@ -35264,25 +35026,25 @@ export interface operations { readonly ideal?: { /** @enum {string} */ readonly bank?: - | "abn_amro" - | "asn_bank" - | "bunq" - | "handelsbanken" - | "ing" - | "knab" - | "moneyou" - | "rabobank" - | "regiobank" - | "revolut" - | "sns_bank" - | "triodos_bank" - | "van_lanschot"; - }; + | 'abn_amro' + | 'asn_bank' + | 'bunq' + | 'handelsbanken' + | 'ing' + | 'knab' + | 'moneyou' + | 'rabobank' + | 'regiobank' + | 'revolut' + | 'sns_bank' + | 'triodos_bank' + | 'van_lanschot' + } /** * param * @description If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method. */ - readonly interac_present?: { readonly [key: string]: unknown }; + readonly interac_present?: { readonly [key: string]: unknown } /** * param * @description If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method. @@ -35290,18 +35052,18 @@ export interface operations { readonly klarna?: { /** date_of_birth */ readonly dob?: { - readonly day: number; - readonly month: number; - readonly year: number; - }; - }; + readonly day: number + readonly month: number + readonly year: number + } + } /** @description 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`. */ - readonly metadata?: { readonly [key: string]: string }; + readonly metadata?: { readonly [key: string]: string } /** * param * @description If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method. */ - readonly oxxo?: { readonly [key: string]: unknown }; + readonly oxxo?: { readonly [key: string]: unknown } /** * param * @description If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method. @@ -35309,171 +35071,171 @@ export interface operations { readonly p24?: { /** @enum {string} */ readonly bank?: - | "alior_bank" - | "bank_millennium" - | "bank_nowy_bfg_sa" - | "bank_pekao_sa" - | "banki_spbdzielcze" - | "blik" - | "bnp_paribas" - | "boz" - | "citi_handlowy" - | "credit_agricole" - | "envelobank" - | "etransfer_pocztowy24" - | "getin_bank" - | "ideabank" - | "ing" - | "inteligo" - | "mbank_mtransfer" - | "nest_przelew" - | "noble_pay" - | "pbac_z_ipko" - | "plus_bank" - | "santander_przelew24" - | "tmobile_usbugi_bankowe" - | "toyota_bank" - | "volkswagen_bank"; - }; + | 'alior_bank' + | 'bank_millennium' + | 'bank_nowy_bfg_sa' + | 'bank_pekao_sa' + | 'banki_spbdzielcze' + | 'blik' + | 'bnp_paribas' + | 'boz' + | 'citi_handlowy' + | 'credit_agricole' + | 'envelobank' + | 'etransfer_pocztowy24' + | 'getin_bank' + | 'ideabank' + | 'ing' + | 'inteligo' + | 'mbank_mtransfer' + | 'nest_przelew' + | 'noble_pay' + | 'pbac_z_ipko' + | 'plus_bank' + | 'santander_przelew24' + | 'tmobile_usbugi_bankowe' + | 'toyota_bank' + | 'volkswagen_bank' + } /** @description The PaymentMethod to share. */ - readonly payment_method?: string; + readonly payment_method?: string /** * param * @description If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account. */ readonly sepa_debit?: { - readonly iban: string; - }; + readonly iban: string + } /** * param * @description If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method. */ readonly sofort?: { /** @enum {string} */ - readonly country: "AT" | "BE" | "DE" | "ES" | "IT" | "NL"; - }; + readonly country: 'AT' | 'BE' | 'DE' | 'ES' | 'IT' | 'NL' + } /** * @description 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. * @enum {string} */ readonly type?: - | "acss_debit" - | "afterpay_clearpay" - | "alipay" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "eps" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "klarna" - | "oxxo" - | "p24" - | "sepa_debit" - | "sofort" - | "wechat_pay"; + | 'acss_debit' + | 'afterpay_clearpay' + | 'alipay' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'eps' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'klarna' + | 'oxxo' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' /** * param * @description If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method. */ - readonly wechat_pay?: { readonly [key: string]: unknown }; - }; - }; - }; - }; + readonly wechat_pay?: { readonly [key: string]: unknown } + } + } + } + } /**

Retrieves a PaymentMethod object.

*/ readonly GetPaymentMethodsPaymentMethod: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly payment_method: string; - }; - }; + readonly payment_method: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["payment_method"]; - }; - }; + readonly 'application/json': components['schemas']['payment_method'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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

*/ readonly PostPaymentMethodsPaymentMethod: { readonly parameters: { readonly path: { - readonly payment_method: string; - }; - }; + readonly payment_method: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["payment_method"]; - }; - }; + readonly 'application/json': components['schemas']['payment_method'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** * billing_details_inner_params * @description Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods. */ readonly billing_details?: { readonly address?: Partial<{ - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string }> & - Partial<"">; - readonly email?: Partial & Partial<"">; - readonly name?: string; - readonly phone?: string; - }; + Partial<''> + readonly email?: Partial & Partial<''> + readonly name?: string + readonly phone?: string + } /** * update_api_param * @description If this is a `card` PaymentMethod, this hash contains the user's card details. */ readonly card?: { - readonly exp_month?: number; - readonly exp_year?: number; - }; + readonly exp_month?: number + readonly exp_year?: number + } /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> + } + } + } + } /** *

Attaches a PaymentMethod object to a Customer.

* @@ -35490,127 +35252,127 @@ export interface operations { readonly PostPaymentMethodsPaymentMethodAttach: { readonly parameters: { readonly path: { - readonly payment_method: string; - }; - }; + readonly payment_method: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["payment_method"]; - }; - }; + readonly 'application/json': components['schemas']['payment_method'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description The ID of the customer to which to attach the PaymentMethod. */ - readonly customer: string; + readonly customer: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } + } /**

Detaches a PaymentMethod object from a Customer.

*/ readonly PostPaymentMethodsPaymentMethodDetach: { readonly parameters: { readonly path: { - readonly payment_method: string; - }; - }; + readonly payment_method: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["payment_method"]; - }; - }; + readonly 'application/json': components['schemas']['payment_method'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } + } /**

Returns a list of existing payouts sent to third-party bank accounts or that Stripe has sent you. The payouts are returned in sorted order, with the most recently created payouts appearing first.

*/ readonly GetPayouts: { readonly parameters: { readonly query: { readonly arrival_date?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial readonly created?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** The ID of an external account - only return payouts sent to this external account. */ - readonly destination?: string; + readonly destination?: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** Only return payouts that have the given status: `pending`, `paid`, `failed`, or `canceled`. */ - readonly status?: string; - }; - }; + readonly status?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["payout"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['payout'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /** *

To send funds to your own bank account, you create a new payout object. Your Stripe balance must be able to cover the payout amount, or you’ll receive an “Insufficient Funds” error.

* @@ -35623,140 +35385,140 @@ export interface operations { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["payout"]; - }; - }; + readonly 'application/json': components['schemas']['payout'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description A positive integer in cents representing how much to payout. */ - readonly amount: number; + readonly amount: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string; + readonly description?: string /** @description The ID of a bank account or a card to send the payout to. If no destination is supplied, the default external account for the specified currency will be used. */ - readonly destination?: string; + readonly destination?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: { readonly [key: string]: string }; + readonly metadata?: { readonly [key: string]: string } /** * @description The method used to send this payout, which can be `standard` or `instant`. `instant` is only supported for payouts to debit cards. (See [Instant payouts for marketplaces for more information](https://stripe.com/blog/instant-payouts-for-marketplaces).) * @enum {string} */ - readonly method?: "instant" | "standard"; + readonly method?: 'instant' | 'standard' /** * @description The balance type of your Stripe balance to draw this payout from. Balances for different payment sources are kept separately. You can find the amounts with the balances API. One of `bank_account`, `card`, or `fpx`. * @enum {string} */ - readonly source_type?: "bank_account" | "card" | "fpx"; + readonly source_type?: 'bank_account' | 'card' | 'fpx' /** @description A string to be displayed on the recipient's bank or card statement. This may be at most 22 characters. Attempting to use a `statement_descriptor` longer than 22 characters will return an error. Note: Most banks will truncate this information and/or display it inconsistently. Some may not display it at all. */ - readonly statement_descriptor?: string; - }; - }; - }; - }; + readonly statement_descriptor?: string + } + } + } + } /**

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

*/ readonly GetPayoutsPayout: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly payout: string; - }; - }; + readonly payout: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["payout"]; - }; - }; + readonly 'application/json': components['schemas']['payout'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Updates the specified payout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request accepts only the metadata as arguments.

*/ readonly PostPayoutsPayout: { readonly parameters: { readonly path: { - readonly payout: string; - }; - }; + readonly payout: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["payout"]; - }; - }; + readonly 'application/json': components['schemas']['payout'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> + } + } + } + } /**

A previously created payout can be canceled if it has not yet been paid out. Funds will be refunded to your available balance. You may not cancel automatic Stripe payouts.

*/ readonly PostPayoutsPayoutCancel: { readonly parameters: { readonly path: { - readonly payout: string; - }; - }; + readonly payout: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["payout"]; - }; - }; + readonly 'application/json': components['schemas']['payout'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } + } /** *

Reverses a payout by debiting the destination bank account. Only payouts for connected accounts to US bank accounts may be reversed at this time. If the payout is in the pending status, /v1/payouts/:id/cancel should be used instead.

* @@ -35765,1556 +35527,1556 @@ export interface operations { readonly PostPayoutsPayoutReverse: { readonly parameters: { readonly path: { - readonly payout: string; - }; - }; + readonly payout: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["payout"]; - }; - }; + readonly 'application/json': components['schemas']['payout'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: { readonly [key: string]: string }; - }; - }; - }; - }; + readonly metadata?: { readonly [key: string]: string } + } + } + } + } /**

Returns a list of your plans.

*/ readonly GetPlans: { readonly parameters: { readonly query: { /** Only return plans that are active or inactive (e.g., pass `false` to list all inactive plans). */ - readonly active?: boolean; + readonly active?: boolean /** 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. */ readonly created?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** Only return plans for the given product. */ - readonly product?: string; + readonly product?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Details about each object. */ - readonly data: readonly components["schemas"]["plan"][]; + readonly data: readonly components['schemas']['plan'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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

*/ readonly PostPlans: { readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["plan"]; - }; - }; + readonly 'application/json': components['schemas']['plan'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Whether the plan is currently available for new subscriptions. Defaults to `true`. */ - readonly active?: boolean; + readonly active?: boolean /** * @description 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`. * @enum {string} */ - readonly aggregate_usage?: "last_during_period" | "last_ever" | "max" | "sum"; + readonly aggregate_usage?: 'last_during_period' | 'last_ever' | 'max' | 'sum' /** @description A positive integer in %s (or 0 for a free plan) representing how much to charge on a recurring basis. */ - readonly amount?: number; + readonly amount?: number /** * Format: decimal * @description Same as `amount`, but accepts a decimal value with at most 12 decimal places. Only one of `amount` and `amount_decimal` can be set. */ - readonly amount_decimal?: string; + readonly amount_decimal?: string /** * @description 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. * @enum {string} */ - readonly billing_scheme?: "per_unit" | "tiered"; + readonly billing_scheme?: 'per_unit' | 'tiered' /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description An identifier randomly generated by Stripe. Used to identify this plan when subscribing a customer. You can optionally override this ID, but the ID must be unique across all plans in your Stripe account. You can, however, use the same plan ID in both live and test modes. */ - readonly id?: string; + readonly id?: string /** * @description Specifies billing frequency. Either `day`, `week`, `month` or `year`. * @enum {string} */ - readonly interval: "day" | "month" | "week" | "year"; + readonly interval: 'day' | 'month' | 'week' | 'year' /** @description The number of intervals between subscription billings. 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). */ - readonly interval_count?: number; + readonly interval_count?: number /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description A brief description of the plan, hidden from customers. */ - readonly nickname?: string; + readonly nickname?: string readonly product?: Partial<{ - readonly active?: boolean; - readonly id?: string; - readonly metadata?: { readonly [key: string]: string }; - readonly name: string; - readonly statement_descriptor?: string; - readonly tax_code?: string; - readonly unit_label?: string; + readonly active?: boolean + readonly id?: string + readonly metadata?: { readonly [key: string]: string } + readonly name: string + readonly statement_descriptor?: string + readonly tax_code?: string + readonly unit_label?: string }> & - Partial; + Partial /** @description Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. */ readonly tiers?: readonly { - readonly flat_amount?: number; + readonly flat_amount?: number /** Format: decimal */ - readonly flat_amount_decimal?: string; - readonly unit_amount?: number; + readonly flat_amount_decimal?: string + readonly unit_amount?: number /** Format: decimal */ - readonly unit_amount_decimal?: string; - readonly up_to: Partial<"inf"> & Partial; - }[]; + readonly unit_amount_decimal?: string + readonly up_to: Partial<'inf'> & Partial + }[] /** * @description 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 successively change as the quantity grows. * @enum {string} */ - readonly tiers_mode?: "graduated" | "volume"; + readonly tiers_mode?: 'graduated' | 'volume' /** * transform_usage_param * @description Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`. */ readonly transform_usage?: { - readonly divide_by: number; + readonly divide_by: number /** @enum {string} */ - readonly round: "down" | "up"; - }; + readonly round: 'down' | 'up' + } /** @description 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). */ - readonly trial_period_days?: number; + readonly trial_period_days?: number /** * @description 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`. * @enum {string} */ - readonly usage_type?: "licensed" | "metered"; - }; - }; - }; - }; + readonly usage_type?: 'licensed' | 'metered' + } + } + } + } /**

Retrieves the plan with the given ID.

*/ readonly GetPlansPlan: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly plan: string; - }; - }; + readonly plan: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["plan"]; - }; - }; + readonly 'application/json': components['schemas']['plan'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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.

*/ readonly PostPlansPlan: { readonly parameters: { readonly path: { - readonly plan: string; - }; - }; + readonly plan: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["plan"]; - }; - }; + readonly 'application/json': components['schemas']['plan'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Whether the plan is currently available for new subscriptions. */ - readonly active?: boolean; + readonly active?: boolean /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description A brief description of the plan, hidden from customers. */ - readonly nickname?: string; + readonly nickname?: string /** @description The product the plan belongs to. This cannot be changed once it has been used in a subscription or subscription schedule. */ - readonly product?: string; + readonly product?: string /** @description 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). */ - readonly trial_period_days?: number; - }; - }; - }; - }; + readonly trial_period_days?: number + } + } + } + } /**

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

*/ readonly DeletePlansPlan: { readonly parameters: { readonly path: { - readonly plan: string; - }; - }; + readonly plan: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["deleted_plan"]; - }; - }; + readonly 'application/json': components['schemas']['deleted_plan'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Returns a list of your prices.

*/ readonly GetPrices: { readonly parameters: { readonly query: { /** Only return prices that are active or inactive (e.g., pass `false` to list all inactive prices). */ - readonly active?: boolean; + readonly active?: boolean /** 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. */ readonly created?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** Only return prices for the given currency. */ - readonly currency?: string; + readonly currency?: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** Only return the price with these lookup_keys, if any exist. */ - readonly lookup_keys?: readonly string[]; + readonly lookup_keys?: readonly string[] /** Only return prices for the given product. */ - readonly product?: string; + readonly product?: string /** Only return prices with these recurring fields. */ readonly recurring?: { /** @enum {string} */ - readonly interval?: "day" | "month" | "week" | "year"; + readonly interval?: 'day' | 'month' | 'week' | 'year' /** @enum {string} */ - readonly usage_type?: "licensed" | "metered"; - }; + readonly usage_type?: 'licensed' | 'metered' + } /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** Only return prices of type `recurring` or `one_time`. */ - readonly type?: "one_time" | "recurring"; - }; - }; + readonly type?: 'one_time' | 'recurring' + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Details about each object. */ - readonly data: readonly components["schemas"]["price"][]; + readonly data: readonly components['schemas']['price'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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

*/ readonly PostPrices: { readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["price"]; - }; - }; + readonly 'application/json': components['schemas']['price'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Whether the price can be used for new purchases. Defaults to `true`. */ - readonly active?: boolean; + readonly active?: boolean /** * @description 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. * @enum {string} */ - readonly billing_scheme?: "per_unit" | "tiered"; + readonly billing_scheme?: 'per_unit' | 'tiered' /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters. */ - readonly lookup_key?: string; + readonly lookup_key?: string /** @description 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`. */ - readonly metadata?: { readonly [key: string]: string }; + readonly metadata?: { readonly [key: string]: string } /** @description A brief description of the price, hidden from customers. */ - readonly nickname?: string; + readonly nickname?: string /** @description The ID of the product that this price will belong to. */ - readonly product?: string; + readonly product?: string /** * inline_product_params * @description These fields can be used to create a new product that this price will belong to. */ readonly product_data?: { - readonly active?: boolean; - readonly id?: string; - readonly metadata?: { readonly [key: string]: string }; - readonly name: string; - readonly statement_descriptor?: string; - readonly tax_code?: string; - readonly unit_label?: string; - }; + readonly active?: boolean + readonly id?: string + readonly metadata?: { readonly [key: string]: string } + readonly name: string + readonly statement_descriptor?: string + readonly tax_code?: string + readonly unit_label?: string + } /** * recurring * @description The recurring components of a price such as `interval` and `usage_type`. */ readonly recurring?: { /** @enum {string} */ - readonly aggregate_usage?: "last_during_period" | "last_ever" | "max" | "sum"; + readonly aggregate_usage?: 'last_during_period' | 'last_ever' | 'max' | 'sum' /** @enum {string} */ - readonly interval: "day" | "month" | "week" | "year"; - readonly interval_count?: number; + readonly interval: 'day' | 'month' | 'week' | 'year' + readonly interval_count?: number /** @enum {string} */ - readonly usage_type?: "licensed" | "metered"; - }; + readonly usage_type?: 'licensed' | 'metered' + } /** * @description 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. * @enum {string} */ - readonly tax_behavior?: "exclusive" | "inclusive" | "unspecified"; + readonly tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' /** @description Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. */ readonly tiers?: readonly { - readonly flat_amount?: number; + readonly flat_amount?: number /** Format: decimal */ - readonly flat_amount_decimal?: string; - readonly unit_amount?: number; + readonly flat_amount_decimal?: string + readonly unit_amount?: number /** Format: decimal */ - readonly unit_amount_decimal?: string; - readonly up_to: Partial<"inf"> & Partial; - }[]; + readonly unit_amount_decimal?: string + readonly up_to: Partial<'inf'> & Partial + }[] /** * @description 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 successively change as the quantity grows. * @enum {string} */ - readonly tiers_mode?: "graduated" | "volume"; + readonly tiers_mode?: 'graduated' | 'volume' /** @description If set to true, will atomically remove the lookup key from the existing price, and assign it to this price. */ - readonly transfer_lookup_key?: boolean; + readonly transfer_lookup_key?: boolean /** * transform_usage_param * @description Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`. */ readonly transform_quantity?: { - readonly divide_by: number; + readonly divide_by: number /** @enum {string} */ - readonly round: "down" | "up"; - }; + readonly round: 'down' | 'up' + } /** @description A positive integer in %s (or 0 for a free price) representing how much to charge. */ - readonly unit_amount?: number; + readonly unit_amount?: number /** * Format: decimal * @description Same as `unit_amount`, but accepts a decimal value in %s with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. */ - readonly unit_amount_decimal?: string; - }; - }; - }; - }; + readonly unit_amount_decimal?: string + } + } + } + } /**

Retrieves the price with the given ID.

*/ readonly GetPricesPrice: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly price: string; - }; - }; + readonly price: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["price"]; - }; - }; + readonly 'application/json': components['schemas']['price'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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

*/ readonly PostPricesPrice: { readonly parameters: { readonly path: { - readonly price: string; - }; - }; + readonly price: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["price"]; - }; - }; + readonly 'application/json': components['schemas']['price'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Whether the price can be used for new purchases. Defaults to `true`. */ - readonly active?: boolean; + readonly active?: boolean /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters. */ - readonly lookup_key?: string; + readonly lookup_key?: string /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description A brief description of the price, hidden from customers. */ - readonly nickname?: string; + readonly nickname?: string /** * @description 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. * @enum {string} */ - readonly tax_behavior?: "exclusive" | "inclusive" | "unspecified"; + readonly tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' /** @description If set to true, will atomically remove the lookup key from the existing price, and assign it to this price. */ - readonly transfer_lookup_key?: boolean; - }; - }; - }; - }; + readonly transfer_lookup_key?: boolean + } + } + } + } /**

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

*/ readonly GetProducts: { readonly parameters: { readonly query: { /** Only return products that are active or inactive (e.g., pass `false` to list all inactive products). */ - readonly active?: boolean; + readonly active?: boolean /** Only return products that were created during the given date interval. */ readonly created?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** Only return products with the given IDs. */ - readonly ids?: readonly string[]; + readonly ids?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** Only return products that can be shipped (i.e., physical, not digital products). */ - readonly shippable?: boolean; + readonly shippable?: boolean /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** Only return products with the given url. */ - readonly url?: string; - }; - }; + readonly url?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Details about each object. */ - readonly data: readonly components["schemas"]["product"][]; + readonly data: readonly components['schemas']['product'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Creates a new product object.

*/ readonly PostProducts: { readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["product"]; - }; - }; + readonly 'application/json': components['schemas']['product'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Whether the product is currently available for purchase. Defaults to `true`. */ - readonly active?: boolean; + readonly active?: boolean /** @description 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. */ - readonly description?: string; + readonly description?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description An identifier will be randomly generated by Stripe. You can optionally override this ID, but the ID must be unique across all products in your Stripe account. */ - readonly id?: string; + readonly id?: string /** @description A list of up to 8 URLs of images for this product, meant to be displayable to the customer. */ - readonly images?: readonly string[]; + readonly images?: readonly string[] /** @description 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`. */ - readonly metadata?: { readonly [key: string]: string }; + readonly metadata?: { readonly [key: string]: string } /** @description The product's name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions. */ - readonly name: string; + readonly name: string /** * package_dimensions_specs * @description The dimensions of this product for shipping purposes. */ readonly package_dimensions?: { - readonly height: number; - readonly length: number; - readonly weight: number; - readonly width: number; - }; + readonly height: number + readonly length: number + readonly weight: number + readonly width: number + } /** @description Whether this product is shipped (i.e., physical goods). */ - readonly shippable?: boolean; + readonly shippable?: boolean /** * @description An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all. * * This may be up to 22 characters. The statement description may not include `<`, `>`, `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. * It must contain at least one letter. */ - readonly statement_descriptor?: string; + readonly statement_descriptor?: string /** @description A [tax code](https://stripe.com/docs/tax/tax-codes) ID. */ - readonly tax_code?: string; + readonly tax_code?: string /** @description A label that represents units of this product in Stripe and on customers’ receipts and invoices. When set, this will be included in associated invoice line item descriptions. */ - readonly unit_label?: string; + readonly unit_label?: string /** @description A URL of a publicly-accessible webpage for this product. */ - readonly url?: string; - }; - }; - }; - }; + readonly url?: string + } + } + } + } /**

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.

*/ readonly GetProductsId: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["product"]; - }; - }; + readonly 'application/json': components['schemas']['product'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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

*/ readonly PostProductsId: { readonly parameters: { readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["product"]; - }; - }; + readonly 'application/json': components['schemas']['product'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Whether the product is available for purchase. */ - readonly active?: boolean; + readonly active?: boolean /** @description 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. */ - readonly description?: string; + readonly description?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description A list of up to 8 URLs of images for this product, meant to be displayable to the customer. */ - readonly images?: Partial & Partial<"">; + readonly images?: Partial & Partial<''> /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description The product's name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions. */ - readonly name?: string; + readonly name?: string /** @description The dimensions of this product for shipping purposes. */ readonly package_dimensions?: Partial<{ - readonly height: number; - readonly length: number; - readonly weight: number; - readonly width: number; + readonly height: number + readonly length: number + readonly weight: number + readonly width: number }> & - Partial<"">; + Partial<''> /** @description Whether this product is shipped (i.e., physical goods). */ - readonly shippable?: boolean; + readonly shippable?: boolean /** * @description An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all. * * This may be up to 22 characters. The statement description may not include `<`, `>`, `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. * It must contain at least one letter. May only be set if `type=service`. */ - readonly statement_descriptor?: string; + readonly statement_descriptor?: string /** @description A [tax code](https://stripe.com/docs/tax/tax-codes) ID. */ - readonly tax_code?: Partial & Partial<"">; + readonly tax_code?: Partial & Partial<''> /** @description A label that represents units of this product in Stripe and on customers’ receipts and invoices. When set, this will be included in associated invoice line item descriptions. May only be set if `type=service`. */ - readonly unit_label?: string; + readonly unit_label?: string /** @description A URL of a publicly-accessible webpage for this product. */ - readonly url?: string; - }; - }; - }; - }; + readonly url?: string + } + } + } + } /**

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.

*/ readonly DeleteProductsId: { readonly parameters: { readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["deleted_product"]; - }; - }; + readonly 'application/json': components['schemas']['deleted_product'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Returns a list of your promotion codes.

*/ readonly GetPromotionCodes: { readonly parameters: { readonly query: { /** Filter promotion codes by whether they are active. */ - readonly active?: boolean; + readonly active?: boolean /** Only return promotion codes that have this case-insensitive code. */ - readonly code?: string; + readonly code?: string /** Only return promotion codes for this coupon. */ - readonly coupon?: string; + readonly coupon?: string /** 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. */ readonly created?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** Only return promotion codes that are restricted to this customer. */ - readonly customer?: string; + readonly customer?: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["promotion_code"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['promotion_code'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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

*/ readonly PostPromotionCodes: { readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["promotion_code"]; - }; - }; + readonly 'application/json': components['schemas']['promotion_code'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Whether the promotion code is currently active. */ - readonly active?: boolean; + readonly active?: boolean /** @description The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for a specific customer. If left blank, we will generate one automatically. */ - readonly code?: string; + readonly code?: string /** @description The coupon for this promotion code. */ - readonly coupon: string; + readonly coupon: string /** @description The customer that this promotion code can be used by. If not set, the promotion code can be used by all customers. */ - readonly customer?: string; + readonly customer?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** * Format: unix-time * @description The timestamp at which this promotion code will expire. If the coupon has specified a `redeems_by`, then this value cannot be after the coupon's `redeems_by`. */ - readonly expires_at?: number; + readonly expires_at?: number /** @description A positive integer specifying the number of times the promotion code can be redeemed. If the coupon has specified a `max_redemptions`, then this value cannot be greater than the coupon's `max_redemptions`. */ - readonly max_redemptions?: number; + readonly max_redemptions?: number /** @description 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`. */ - readonly metadata?: { readonly [key: string]: string }; + readonly metadata?: { readonly [key: string]: string } /** * restrictions_params * @description Settings that restrict the redemption of the promotion code. */ readonly restrictions?: { - readonly first_time_transaction?: boolean; - readonly minimum_amount?: number; - readonly minimum_amount_currency?: string; - }; - }; - }; - }; - }; + readonly first_time_transaction?: boolean + readonly minimum_amount?: number + readonly minimum_amount_currency?: string + } + } + } + } + } /**

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.

*/ readonly GetPromotionCodesPromotionCode: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly promotion_code: string; - }; - }; + readonly promotion_code: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["promotion_code"]; - }; - }; + readonly 'application/json': components['schemas']['promotion_code'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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

*/ readonly PostPromotionCodesPromotionCode: { readonly parameters: { readonly path: { - readonly promotion_code: string; - }; - }; + readonly promotion_code: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["promotion_code"]; - }; - }; + readonly 'application/json': components['schemas']['promotion_code'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Whether the promotion code is currently active. A promotion code can only be reactivated when the coupon is still valid and the promotion code is otherwise redeemable. */ - readonly active?: boolean; + readonly active?: boolean /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> + } + } + } + } /**

Returns a list of your quotes.

*/ readonly GetQuotes: { readonly parameters: { readonly query: { /** The ID of the customer whose quotes will be retrieved. */ - readonly customer?: string; + readonly customer?: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** The status of the quote. */ - readonly status?: "accepted" | "canceled" | "draft" | "open"; - }; - }; + readonly status?: 'accepted' | 'canceled' | 'draft' | 'open' + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["quote"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['quote'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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.

*/ readonly PostQuotes: { readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["quote"]; - }; - }; + readonly 'application/json': components['schemas']['quote'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description 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. There cannot be any line items with recurring prices when using this field. */ - readonly application_fee_amount?: Partial & Partial<"">; + readonly application_fee_amount?: Partial & Partial<''> /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field. */ - readonly application_fee_percent?: Partial & Partial<"">; + readonly application_fee_percent?: Partial & Partial<''> /** * automatic_tax_param * @description Settings for automatic tax lookup for this quote and resulting invoices and subscriptions. */ readonly automatic_tax?: { - readonly enabled: boolean; - }; + readonly enabled: boolean + } /** * @description Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice 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. Defaults to `charge_automatically`. * @enum {string} */ - readonly collection_method?: "charge_automatically" | "send_invoice"; + readonly collection_method?: 'charge_automatically' | 'send_invoice' /** @description The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed. */ - readonly customer?: string; + readonly customer?: string /** @description The tax rates that will apply to any line item that does not have `tax_rates` set. */ - readonly default_tax_rates?: Partial & Partial<"">; + readonly default_tax_rates?: Partial & Partial<''> /** @description A description that will be displayed on the quote PDF. If no value is passed, the default description configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used. */ - readonly description?: string; + readonly description?: string /** @description The discounts applied to the quote. You can only set up to one discount. */ readonly discounts?: Partial< readonly { - readonly coupon?: string; - readonly discount?: string; + readonly coupon?: string + readonly discount?: string }[] > & - Partial<"">; + Partial<''> /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** * Format: unix-time * @description A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. If no value is passed, the default expiration date configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used. */ - readonly expires_at?: number; + readonly expires_at?: number /** @description A footer that will be displayed on the quote PDF. If no value is passed, the default footer configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used. */ - readonly footer?: string; + readonly footer?: string /** * from_quote_params * @description Clone an existing quote. The new quote will be created in `status=draft`. When using this parameter, you cannot specify any other parameters except for `expires_at`. */ readonly from_quote?: { - readonly is_revision?: boolean; - readonly quote: string; - }; + readonly is_revision?: boolean + readonly quote: string + } /** @description A header that will be displayed on the quote PDF. If no value is passed, the default header configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used. */ - readonly header?: string; + readonly header?: string /** * quote_param * @description All invoices will be billed using the specified settings. */ readonly invoice_settings?: { - readonly days_until_due?: number; - }; + readonly days_until_due?: number + } /** @description A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost. */ readonly line_items?: readonly { - readonly price?: string; + readonly price?: string /** price_data */ readonly price_data?: { - readonly currency: string; - readonly product: string; + readonly currency: string + readonly product: string /** recurring_adhoc */ readonly recurring?: { /** @enum {string} */ - readonly interval: "day" | "month" | "week" | "year"; - readonly interval_count?: number; - }; + readonly interval: 'day' | 'month' | 'week' | 'year' + readonly interval_count?: number + } /** @enum {string} */ - readonly tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - readonly unit_amount?: number; + readonly tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + readonly unit_amount?: number /** Format: decimal */ - readonly unit_amount_decimal?: string; - }; - readonly quantity?: number; - readonly tax_rates?: Partial & Partial<"">; - }[]; + readonly unit_amount_decimal?: string + } + readonly quantity?: number + readonly tax_rates?: Partial & Partial<''> + }[] /** @description 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`. */ - readonly metadata?: { readonly [key: string]: string }; + readonly metadata?: { readonly [key: string]: string } /** @description The account on behalf of which to charge. */ - readonly on_behalf_of?: Partial & Partial<"">; + readonly on_behalf_of?: Partial & Partial<''> /** * subscription_data_create_params * @description When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if `subscription_data[effective_date]` is present and in the future, otherwise a subscription is created. */ readonly subscription_data?: { - readonly effective_date?: Partial<"current_period_end"> & Partial & Partial<"">; - readonly trial_period_days?: Partial & Partial<"">; - }; + readonly effective_date?: Partial<'current_period_end'> & Partial & Partial<''> + readonly trial_period_days?: Partial & Partial<''> + } /** @description The data with which to automatically create a Transfer for each of the invoices. */ readonly transfer_data?: Partial<{ - readonly amount?: number; - readonly amount_percent?: number; - readonly destination: string; + readonly amount?: number + readonly amount_percent?: number + readonly destination: string }> & - Partial<"">; - }; - }; - }; - }; + Partial<''> + } + } + } + } /**

Retrieves the quote with the given ID.

*/ readonly GetQuotesQuote: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly quote: string; - }; - }; + readonly quote: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["quote"]; - }; - }; + readonly 'application/json': components['schemas']['quote'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

A quote models prices and services for a customer.

*/ readonly PostQuotesQuote: { readonly parameters: { readonly path: { - readonly quote: string; - }; - }; + readonly quote: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["quote"]; - }; - }; + readonly 'application/json': components['schemas']['quote'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description 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. There cannot be any line items with recurring prices when using this field. */ - readonly application_fee_amount?: Partial & Partial<"">; + readonly application_fee_amount?: Partial & Partial<''> /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field. */ - readonly application_fee_percent?: Partial & Partial<"">; + readonly application_fee_percent?: Partial & Partial<''> /** * automatic_tax_param * @description Settings for automatic tax lookup for this quote and resulting invoices and subscriptions. */ readonly automatic_tax?: { - readonly enabled: boolean; - }; + readonly enabled: boolean + } /** * @description Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice 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. Defaults to `charge_automatically`. * @enum {string} */ - readonly collection_method?: "charge_automatically" | "send_invoice"; + readonly collection_method?: 'charge_automatically' | 'send_invoice' /** @description The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed. */ - readonly customer?: string; + readonly customer?: string /** @description The tax rates that will apply to any line item that does not have `tax_rates` set. */ - readonly default_tax_rates?: Partial & Partial<"">; + readonly default_tax_rates?: Partial & Partial<''> /** @description A description that will be displayed on the quote PDF. */ - readonly description?: string; + readonly description?: string /** @description The discounts applied to the quote. You can only set up to one discount. */ readonly discounts?: Partial< readonly { - readonly coupon?: string; - readonly discount?: string; + readonly coupon?: string + readonly discount?: string }[] > & - Partial<"">; + Partial<''> /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** * Format: unix-time * @description A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. */ - readonly expires_at?: number; + readonly expires_at?: number /** @description A footer that will be displayed on the quote PDF. */ - readonly footer?: string; + readonly footer?: string /** @description A header that will be displayed on the quote PDF. */ - readonly header?: string; + readonly header?: string /** * quote_param * @description All invoices will be billed using the specified settings. */ readonly invoice_settings?: { - readonly days_until_due?: number; - }; + readonly days_until_due?: number + } /** @description A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost. */ readonly line_items?: readonly { - readonly id?: string; - readonly price?: string; + readonly id?: string + readonly price?: string /** price_data */ readonly price_data?: { - readonly currency: string; - readonly product: string; + readonly currency: string + readonly product: string /** recurring_adhoc */ readonly recurring?: { /** @enum {string} */ - readonly interval: "day" | "month" | "week" | "year"; - readonly interval_count?: number; - }; + readonly interval: 'day' | 'month' | 'week' | 'year' + readonly interval_count?: number + } /** @enum {string} */ - readonly tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - readonly unit_amount?: number; + readonly tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + readonly unit_amount?: number /** Format: decimal */ - readonly unit_amount_decimal?: string; - }; - readonly quantity?: number; - readonly tax_rates?: Partial & Partial<"">; - }[]; + readonly unit_amount_decimal?: string + } + readonly quantity?: number + readonly tax_rates?: Partial & Partial<''> + }[] /** @description 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`. */ - readonly metadata?: { readonly [key: string]: string }; + readonly metadata?: { readonly [key: string]: string } /** @description The account on behalf of which to charge. */ - readonly on_behalf_of?: Partial & Partial<"">; + readonly on_behalf_of?: Partial & Partial<''> /** * subscription_data_update_params * @description When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if `subscription_data[effective_date]` is present and in the future, otherwise a subscription is created. */ readonly subscription_data?: { - readonly effective_date?: Partial<"current_period_end"> & Partial & Partial<"">; - readonly trial_period_days?: Partial & Partial<"">; - }; + readonly effective_date?: Partial<'current_period_end'> & Partial & Partial<''> + readonly trial_period_days?: Partial & Partial<''> + } /** @description The data with which to automatically create a Transfer for each of the invoices. */ readonly transfer_data?: Partial<{ - readonly amount?: number; - readonly amount_percent?: number; - readonly destination: string; + readonly amount?: number + readonly amount_percent?: number + readonly destination: string }> & - Partial<"">; - }; - }; - }; - }; + Partial<''> + } + } + } + } /**

Accepts the specified quote.

*/ readonly PostQuotesQuoteAccept: { readonly parameters: { readonly path: { - readonly quote: string; - }; - }; + readonly quote: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["quote"]; - }; - }; + readonly 'application/json': components['schemas']['quote'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } + } /**

Cancels the quote.

*/ readonly PostQuotesQuoteCancel: { readonly parameters: { readonly path: { - readonly quote: string; - }; - }; + readonly quote: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["quote"]; - }; - }; + readonly 'application/json': components['schemas']['quote'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } + } /**

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.

*/ readonly GetQuotesQuoteComputedUpfrontLineItems: { readonly parameters: { readonly query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; + readonly starting_after?: string + } readonly path: { - readonly quote: string; - }; - }; + readonly quote: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Details about each object. */ - readonly data: readonly components["schemas"]["item"][]; + readonly data: readonly components['schemas']['item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Finalizes the quote.

*/ readonly PostQuotesQuoteFinalize: { readonly parameters: { readonly path: { - readonly quote: string; - }; - }; + readonly quote: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["quote"]; - }; - }; + readonly 'application/json': components['schemas']['quote'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** * Format: unix-time * @description A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. */ - readonly expires_at?: number; - }; - }; - }; - }; + readonly expires_at?: number + } + } + } + } /**

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.

*/ readonly GetQuotesQuoteLineItems: { readonly parameters: { readonly query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; + readonly starting_after?: string + } readonly path: { - readonly quote: string; - }; - }; + readonly quote: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Details about each object. */ - readonly data: readonly components["schemas"]["item"][]; + readonly data: readonly components['schemas']['item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Download the PDF for a finalized quote

*/ readonly GetQuotesQuotePdf: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly quote: string; - }; - }; + readonly quote: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/pdf": string; - }; - }; + readonly 'application/pdf': string + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Returns a list of early fraud warnings.

*/ readonly GetRadarEarlyFraudWarnings: { readonly parameters: { readonly query: { /** Only return early fraud warnings for the charge specified by this charge ID. */ - readonly charge?: string; + readonly charge?: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** Only return early fraud warnings for charges that were created by the PaymentIntent specified by this PaymentIntent ID. */ - readonly payment_intent?: string; + readonly payment_intent?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["radar.early_fraud_warning"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['radar.early_fraud_warning'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /** *

Retrieves the details of an early fraud warning that has previously been created.

* @@ -37323,425 +37085,425 @@ export interface operations { readonly GetRadarEarlyFraudWarningsEarlyFraudWarning: { readonly parameters: { readonly path: { - readonly early_fraud_warning: string; - }; + readonly early_fraud_warning: string + } readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; + readonly expand?: readonly string[] + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["radar.early_fraud_warning"]; - }; - }; + readonly 'application/json': components['schemas']['radar.early_fraud_warning'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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

*/ readonly GetRadarValueListItems: { readonly parameters: { readonly query: { readonly created?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** Return items belonging to the parent list whose value matches the specified value (using an "is like" match). */ - readonly value?: string; + readonly value?: string /** Identifier for the parent value list this item belongs to. */ - readonly value_list: string; - }; - }; + readonly value_list: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["radar.value_list_item"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['radar.value_list_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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

*/ readonly PostRadarValueListItems: { readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["radar.value_list_item"]; - }; - }; + readonly 'application/json': components['schemas']['radar.value_list_item'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The value of the item (whose type must match the type of the parent value list). */ - readonly value: string; + readonly value: string /** @description The identifier of the value list which the created item will be added to. */ - readonly value_list: string; - }; - }; - }; - }; + readonly value_list: string + } + } + } + } /**

Retrieves a ValueListItem object.

*/ readonly GetRadarValueListItemsItem: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly item: string; - }; - }; + readonly item: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["radar.value_list_item"]; - }; - }; + readonly 'application/json': components['schemas']['radar.value_list_item'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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

*/ readonly DeleteRadarValueListItemsItem: { readonly parameters: { readonly path: { - readonly item: string; - }; - }; + readonly item: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["deleted_radar.value_list_item"]; - }; - }; + readonly 'application/json': components['schemas']['deleted_radar.value_list_item'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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

*/ readonly GetRadarValueLists: { readonly parameters: { readonly query: { /** The alias used to reference the value list when writing rules. */ - readonly alias?: string; + readonly alias?: string /** A value contained within a value list - returns all value lists containing this value. */ - readonly contains?: string; + readonly contains?: string readonly created?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["radar.value_list"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['radar.value_list'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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

*/ readonly PostRadarValueLists: { readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["radar.value_list"]; - }; - }; + readonly 'application/json': components['schemas']['radar.value_list'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description The name of the value list for use in rules. */ - readonly alias: string; + readonly alias: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** * @description Type of the items in the value list. One of `card_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, `case_sensitive_string`, or `customer_id`. Use `string` if the item type is unknown or mixed. * @enum {string} */ readonly item_type?: - | "card_bin" - | "card_fingerprint" - | "case_sensitive_string" - | "country" - | "customer_id" - | "email" - | "ip_address" - | "string"; + | 'card_bin' + | 'card_fingerprint' + | 'case_sensitive_string' + | 'country' + | 'customer_id' + | 'email' + | 'ip_address' + | 'string' /** @description 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`. */ - readonly metadata?: { readonly [key: string]: string }; + readonly metadata?: { readonly [key: string]: string } /** @description The human-readable name of the value list. */ - readonly name: string; - }; - }; - }; - }; + readonly name: string + } + } + } + } /**

Retrieves a ValueList object.

*/ readonly GetRadarValueListsValueList: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly value_list: string; - }; - }; + readonly value_list: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["radar.value_list"]; - }; - }; + readonly 'application/json': components['schemas']['radar.value_list'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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.

*/ readonly PostRadarValueListsValueList: { readonly parameters: { readonly path: { - readonly value_list: string; - }; - }; + readonly value_list: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["radar.value_list"]; - }; - }; + readonly 'application/json': components['schemas']['radar.value_list'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description The name of the value list for use in rules. */ - readonly alias?: string; + readonly alias?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: { readonly [key: string]: string }; + readonly metadata?: { readonly [key: string]: string } /** @description The human-readable name of the value list. */ - readonly name?: string; - }; - }; - }; - }; + readonly name?: string + } + } + } + } /**

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.

*/ readonly DeleteRadarValueListsValueList: { readonly parameters: { readonly path: { - readonly value_list: string; - }; - }; + readonly value_list: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["deleted_radar.value_list"]; - }; - }; + readonly 'application/json': components['schemas']['deleted_radar.value_list'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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

*/ readonly GetRecipients: { readonly parameters: { readonly query: { readonly created?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - readonly type?: "corporation" | "individual"; + readonly starting_after?: string + readonly type?: 'corporation' | 'individual' /** Only return recipients that are verified or unverified. */ - readonly verified?: boolean; - }; - }; + readonly verified?: boolean + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["recipient"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['recipient'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /** *

Creates a new Recipient object and verifies the recipient’s identity. * Also verifies the recipient’s bank account information or debit card, if either is provided.

@@ -37751,73 +37513,72 @@ export interface operations { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["recipient"]; - }; - }; + readonly 'application/json': components['schemas']['recipient'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description A bank account to attach to the recipient. You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details, with the options described below. */ - readonly bank_account?: string; + readonly bank_account?: string /** @description A U.S. Visa or MasterCard debit card (_not_ prepaid) to attach to the recipient. If the debit card is not valid, recipient creation will fail. You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's debit card details, with the options described below. Although not all information is required, the extra info helps prevent fraud. */ - readonly card?: string; + readonly card?: string /** @description An arbitrary string which you can attach to a `Recipient` object. It is displayed alongside the recipient in the web interface. */ - readonly description?: string; + readonly description?: string /** @description The recipient's email address. It is displayed alongside the recipient in the web interface, and can be useful for searching and tracking. */ - readonly email?: string; + readonly email?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description The recipient's full, legal name. For type `individual`, should be in the format `First Last`, `First Middle Last`, or `First M Last` (no prefixes or suffixes). For `corporation`, the full, incorporated name. */ - readonly name: string; + readonly name: string /** @description The recipient's tax ID, as a string. For type `individual`, the full SSN; for type `corporation`, the full EIN. */ - readonly tax_id?: string; + readonly tax_id?: string /** @description Type of the recipient: either `individual` or `corporation`. */ - readonly type: string; - }; - }; - }; - }; + readonly type: string + } + } + } + } /**

Retrieves the details of an existing recipient. You need only supply the unique recipient identifier that was returned upon recipient creation.

*/ readonly GetRecipientsId: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": Partial & - Partial; - }; - }; + readonly 'application/json': Partial & Partial + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /** *

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

@@ -37828,196 +37589,196 @@ export interface operations { readonly PostRecipientsId: { readonly parameters: { readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["recipient"]; - }; - }; + readonly 'application/json': components['schemas']['recipient'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description A bank account to attach to the recipient. You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details, with the options described below. */ - readonly bank_account?: string; + readonly bank_account?: string /** @description A U.S. Visa or MasterCard debit card (not prepaid) to attach to the recipient. You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's debit card details, with the options described below. Passing `card` will create a new card, make it the new recipient default card, and delete the old recipient default (if one exists). If you want to add additional debit cards instead of replacing the existing default, use the [card creation API](https://stripe.com/docs/api#create_card). Whenever you attach a card to a recipient, Stripe will automatically validate the debit card. */ - readonly card?: string; + readonly card?: string /** @description ID of the card to set as the recipient's new default for payouts. */ - readonly default_card?: string; + readonly default_card?: string /** @description An arbitrary string which you can attach to a `Recipient` object. It is displayed alongside the recipient in the web interface. */ - readonly description?: string; + readonly description?: string /** @description The recipient's email address. It is displayed alongside the recipient in the web interface, and can be useful for searching and tracking. */ - readonly email?: string; + readonly email?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description The recipient's full, legal name. For type `individual`, should be in the format `First Last`, `First Middle Last`, or `First M Last` (no prefixes or suffixes). For `corporation`, the full, incorporated name. */ - readonly name?: string; + readonly name?: string /** @description The recipient's tax ID, as a string. For type `individual`, the full SSN; for type `corporation`, the full EIN. */ - readonly tax_id?: string; - }; - }; - }; - }; + readonly tax_id?: string + } + } + } + } /**

Permanently deletes a recipient. It cannot be undone.

*/ readonly DeleteRecipientsId: { readonly parameters: { readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["deleted_recipient"]; - }; - }; + readonly 'application/json': components['schemas']['deleted_recipient'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Returns a list of all refunds you’ve previously created. The refunds are returned in sorted order, with the most recent refunds appearing first. For convenience, the 10 most recent refunds are always available by default on the charge object.

*/ readonly GetRefunds: { readonly parameters: { readonly query: { /** Only return refunds for the charge specified by this charge ID. */ - readonly charge?: string; + readonly charge?: string readonly created?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** Only return refunds for the PaymentIntent specified by this ID. */ - readonly payment_intent?: string; + readonly payment_intent?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["refund"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['refund'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Create a refund.

*/ readonly PostRefunds: { readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["refund"]; - }; - }; + readonly 'application/json': components['schemas']['refund'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { - readonly amount?: number; - readonly charge?: string; + readonly 'application/x-www-form-urlencoded': { + readonly amount?: number + readonly charge?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; - readonly payment_intent?: string; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> + readonly payment_intent?: string /** @enum {string} */ - readonly reason?: "duplicate" | "fraudulent" | "requested_by_customer"; - readonly refund_application_fee?: boolean; - readonly reverse_transfer?: boolean; - }; - }; - }; - }; + readonly reason?: 'duplicate' | 'fraudulent' | 'requested_by_customer' + readonly refund_application_fee?: boolean + readonly reverse_transfer?: boolean + } + } + } + } /**

Retrieves the details of an existing refund.

*/ readonly GetRefundsRefund: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly refund: string; - }; - }; + readonly refund: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["refund"]; - }; - }; + readonly 'application/json': components['schemas']['refund'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /** *

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

* @@ -38026,973 +37787,973 @@ export interface operations { readonly PostRefundsRefund: { readonly parameters: { readonly path: { - readonly refund: string; - }; - }; + readonly refund: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["refund"]; - }; - }; + readonly 'application/json': components['schemas']['refund'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> + } + } + } + } /**

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

*/ readonly GetReportingReportRuns: { readonly parameters: { readonly query: { readonly created?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["reporting.report_run"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['reporting.report_run'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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

*/ readonly PostReportingReportRuns: { readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["reporting.report_run"]; - }; - }; + readonly 'application/json': components['schemas']['reporting.report_run'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** * run_parameter_specs * @description Parameters specifying how the report should be run. Different Report Types have different required and optional parameters, listed in the [API Access to Reports](https://stripe.com/docs/reporting/statements/api) documentation. */ readonly parameters?: { - readonly columns?: readonly string[]; - readonly connected_account?: string; - readonly currency?: string; + readonly columns?: readonly string[] + readonly connected_account?: string + readonly currency?: string /** Format: unix-time */ - readonly interval_end?: number; + readonly interval_end?: number /** Format: unix-time */ - readonly interval_start?: number; - readonly payout?: string; + readonly interval_start?: number + readonly payout?: string /** @enum {string} */ readonly reporting_category?: - | "advance" - | "advance_funding" - | "anticipation_repayment" - | "charge" - | "charge_failure" - | "connect_collection_transfer" - | "connect_reserved_funds" - | "contribution" - | "dispute" - | "dispute_reversal" - | "fee" - | "financing_paydown" - | "financing_paydown_reversal" - | "financing_payout" - | "financing_payout_reversal" - | "issuing_authorization_hold" - | "issuing_authorization_release" - | "issuing_dispute" - | "issuing_transaction" - | "network_cost" - | "other_adjustment" - | "partial_capture_reversal" - | "payout" - | "payout_reversal" - | "platform_earning" - | "platform_earning_refund" - | "refund" - | "refund_failure" - | "risk_reserved_funds" - | "tax" - | "topup" - | "topup_reversal" - | "transfer" - | "transfer_reversal"; + | 'advance' + | 'advance_funding' + | 'anticipation_repayment' + | 'charge' + | 'charge_failure' + | 'connect_collection_transfer' + | 'connect_reserved_funds' + | 'contribution' + | 'dispute' + | 'dispute_reversal' + | 'fee' + | 'financing_paydown' + | 'financing_paydown_reversal' + | 'financing_payout' + | 'financing_payout_reversal' + | 'issuing_authorization_hold' + | 'issuing_authorization_release' + | 'issuing_dispute' + | 'issuing_transaction' + | 'network_cost' + | 'other_adjustment' + | 'partial_capture_reversal' + | 'payout' + | 'payout_reversal' + | 'platform_earning' + | 'platform_earning_refund' + | 'refund' + | 'refund_failure' + | 'risk_reserved_funds' + | 'tax' + | 'topup' + | 'topup_reversal' + | 'transfer' + | 'transfer_reversal' /** @enum {string} */ readonly timezone?: - | "Africa/Abidjan" - | "Africa/Accra" - | "Africa/Addis_Ababa" - | "Africa/Algiers" - | "Africa/Asmara" - | "Africa/Asmera" - | "Africa/Bamako" - | "Africa/Bangui" - | "Africa/Banjul" - | "Africa/Bissau" - | "Africa/Blantyre" - | "Africa/Brazzaville" - | "Africa/Bujumbura" - | "Africa/Cairo" - | "Africa/Casablanca" - | "Africa/Ceuta" - | "Africa/Conakry" - | "Africa/Dakar" - | "Africa/Dar_es_Salaam" - | "Africa/Djibouti" - | "Africa/Douala" - | "Africa/El_Aaiun" - | "Africa/Freetown" - | "Africa/Gaborone" - | "Africa/Harare" - | "Africa/Johannesburg" - | "Africa/Juba" - | "Africa/Kampala" - | "Africa/Khartoum" - | "Africa/Kigali" - | "Africa/Kinshasa" - | "Africa/Lagos" - | "Africa/Libreville" - | "Africa/Lome" - | "Africa/Luanda" - | "Africa/Lubumbashi" - | "Africa/Lusaka" - | "Africa/Malabo" - | "Africa/Maputo" - | "Africa/Maseru" - | "Africa/Mbabane" - | "Africa/Mogadishu" - | "Africa/Monrovia" - | "Africa/Nairobi" - | "Africa/Ndjamena" - | "Africa/Niamey" - | "Africa/Nouakchott" - | "Africa/Ouagadougou" - | "Africa/Porto-Novo" - | "Africa/Sao_Tome" - | "Africa/Timbuktu" - | "Africa/Tripoli" - | "Africa/Tunis" - | "Africa/Windhoek" - | "America/Adak" - | "America/Anchorage" - | "America/Anguilla" - | "America/Antigua" - | "America/Araguaina" - | "America/Argentina/Buenos_Aires" - | "America/Argentina/Catamarca" - | "America/Argentina/ComodRivadavia" - | "America/Argentina/Cordoba" - | "America/Argentina/Jujuy" - | "America/Argentina/La_Rioja" - | "America/Argentina/Mendoza" - | "America/Argentina/Rio_Gallegos" - | "America/Argentina/Salta" - | "America/Argentina/San_Juan" - | "America/Argentina/San_Luis" - | "America/Argentina/Tucuman" - | "America/Argentina/Ushuaia" - | "America/Aruba" - | "America/Asuncion" - | "America/Atikokan" - | "America/Atka" - | "America/Bahia" - | "America/Bahia_Banderas" - | "America/Barbados" - | "America/Belem" - | "America/Belize" - | "America/Blanc-Sablon" - | "America/Boa_Vista" - | "America/Bogota" - | "America/Boise" - | "America/Buenos_Aires" - | "America/Cambridge_Bay" - | "America/Campo_Grande" - | "America/Cancun" - | "America/Caracas" - | "America/Catamarca" - | "America/Cayenne" - | "America/Cayman" - | "America/Chicago" - | "America/Chihuahua" - | "America/Coral_Harbour" - | "America/Cordoba" - | "America/Costa_Rica" - | "America/Creston" - | "America/Cuiaba" - | "America/Curacao" - | "America/Danmarkshavn" - | "America/Dawson" - | "America/Dawson_Creek" - | "America/Denver" - | "America/Detroit" - | "America/Dominica" - | "America/Edmonton" - | "America/Eirunepe" - | "America/El_Salvador" - | "America/Ensenada" - | "America/Fort_Nelson" - | "America/Fort_Wayne" - | "America/Fortaleza" - | "America/Glace_Bay" - | "America/Godthab" - | "America/Goose_Bay" - | "America/Grand_Turk" - | "America/Grenada" - | "America/Guadeloupe" - | "America/Guatemala" - | "America/Guayaquil" - | "America/Guyana" - | "America/Halifax" - | "America/Havana" - | "America/Hermosillo" - | "America/Indiana/Indianapolis" - | "America/Indiana/Knox" - | "America/Indiana/Marengo" - | "America/Indiana/Petersburg" - | "America/Indiana/Tell_City" - | "America/Indiana/Vevay" - | "America/Indiana/Vincennes" - | "America/Indiana/Winamac" - | "America/Indianapolis" - | "America/Inuvik" - | "America/Iqaluit" - | "America/Jamaica" - | "America/Jujuy" - | "America/Juneau" - | "America/Kentucky/Louisville" - | "America/Kentucky/Monticello" - | "America/Knox_IN" - | "America/Kralendijk" - | "America/La_Paz" - | "America/Lima" - | "America/Los_Angeles" - | "America/Louisville" - | "America/Lower_Princes" - | "America/Maceio" - | "America/Managua" - | "America/Manaus" - | "America/Marigot" - | "America/Martinique" - | "America/Matamoros" - | "America/Mazatlan" - | "America/Mendoza" - | "America/Menominee" - | "America/Merida" - | "America/Metlakatla" - | "America/Mexico_City" - | "America/Miquelon" - | "America/Moncton" - | "America/Monterrey" - | "America/Montevideo" - | "America/Montreal" - | "America/Montserrat" - | "America/Nassau" - | "America/New_York" - | "America/Nipigon" - | "America/Nome" - | "America/Noronha" - | "America/North_Dakota/Beulah" - | "America/North_Dakota/Center" - | "America/North_Dakota/New_Salem" - | "America/Ojinaga" - | "America/Panama" - | "America/Pangnirtung" - | "America/Paramaribo" - | "America/Phoenix" - | "America/Port-au-Prince" - | "America/Port_of_Spain" - | "America/Porto_Acre" - | "America/Porto_Velho" - | "America/Puerto_Rico" - | "America/Punta_Arenas" - | "America/Rainy_River" - | "America/Rankin_Inlet" - | "America/Recife" - | "America/Regina" - | "America/Resolute" - | "America/Rio_Branco" - | "America/Rosario" - | "America/Santa_Isabel" - | "America/Santarem" - | "America/Santiago" - | "America/Santo_Domingo" - | "America/Sao_Paulo" - | "America/Scoresbysund" - | "America/Shiprock" - | "America/Sitka" - | "America/St_Barthelemy" - | "America/St_Johns" - | "America/St_Kitts" - | "America/St_Lucia" - | "America/St_Thomas" - | "America/St_Vincent" - | "America/Swift_Current" - | "America/Tegucigalpa" - | "America/Thule" - | "America/Thunder_Bay" - | "America/Tijuana" - | "America/Toronto" - | "America/Tortola" - | "America/Vancouver" - | "America/Virgin" - | "America/Whitehorse" - | "America/Winnipeg" - | "America/Yakutat" - | "America/Yellowknife" - | "Antarctica/Casey" - | "Antarctica/Davis" - | "Antarctica/DumontDUrville" - | "Antarctica/Macquarie" - | "Antarctica/Mawson" - | "Antarctica/McMurdo" - | "Antarctica/Palmer" - | "Antarctica/Rothera" - | "Antarctica/South_Pole" - | "Antarctica/Syowa" - | "Antarctica/Troll" - | "Antarctica/Vostok" - | "Arctic/Longyearbyen" - | "Asia/Aden" - | "Asia/Almaty" - | "Asia/Amman" - | "Asia/Anadyr" - | "Asia/Aqtau" - | "Asia/Aqtobe" - | "Asia/Ashgabat" - | "Asia/Ashkhabad" - | "Asia/Atyrau" - | "Asia/Baghdad" - | "Asia/Bahrain" - | "Asia/Baku" - | "Asia/Bangkok" - | "Asia/Barnaul" - | "Asia/Beirut" - | "Asia/Bishkek" - | "Asia/Brunei" - | "Asia/Calcutta" - | "Asia/Chita" - | "Asia/Choibalsan" - | "Asia/Chongqing" - | "Asia/Chungking" - | "Asia/Colombo" - | "Asia/Dacca" - | "Asia/Damascus" - | "Asia/Dhaka" - | "Asia/Dili" - | "Asia/Dubai" - | "Asia/Dushanbe" - | "Asia/Famagusta" - | "Asia/Gaza" - | "Asia/Harbin" - | "Asia/Hebron" - | "Asia/Ho_Chi_Minh" - | "Asia/Hong_Kong" - | "Asia/Hovd" - | "Asia/Irkutsk" - | "Asia/Istanbul" - | "Asia/Jakarta" - | "Asia/Jayapura" - | "Asia/Jerusalem" - | "Asia/Kabul" - | "Asia/Kamchatka" - | "Asia/Karachi" - | "Asia/Kashgar" - | "Asia/Kathmandu" - | "Asia/Katmandu" - | "Asia/Khandyga" - | "Asia/Kolkata" - | "Asia/Krasnoyarsk" - | "Asia/Kuala_Lumpur" - | "Asia/Kuching" - | "Asia/Kuwait" - | "Asia/Macao" - | "Asia/Macau" - | "Asia/Magadan" - | "Asia/Makassar" - | "Asia/Manila" - | "Asia/Muscat" - | "Asia/Nicosia" - | "Asia/Novokuznetsk" - | "Asia/Novosibirsk" - | "Asia/Omsk" - | "Asia/Oral" - | "Asia/Phnom_Penh" - | "Asia/Pontianak" - | "Asia/Pyongyang" - | "Asia/Qatar" - | "Asia/Qostanay" - | "Asia/Qyzylorda" - | "Asia/Rangoon" - | "Asia/Riyadh" - | "Asia/Saigon" - | "Asia/Sakhalin" - | "Asia/Samarkand" - | "Asia/Seoul" - | "Asia/Shanghai" - | "Asia/Singapore" - | "Asia/Srednekolymsk" - | "Asia/Taipei" - | "Asia/Tashkent" - | "Asia/Tbilisi" - | "Asia/Tehran" - | "Asia/Tel_Aviv" - | "Asia/Thimbu" - | "Asia/Thimphu" - | "Asia/Tokyo" - | "Asia/Tomsk" - | "Asia/Ujung_Pandang" - | "Asia/Ulaanbaatar" - | "Asia/Ulan_Bator" - | "Asia/Urumqi" - | "Asia/Ust-Nera" - | "Asia/Vientiane" - | "Asia/Vladivostok" - | "Asia/Yakutsk" - | "Asia/Yangon" - | "Asia/Yekaterinburg" - | "Asia/Yerevan" - | "Atlantic/Azores" - | "Atlantic/Bermuda" - | "Atlantic/Canary" - | "Atlantic/Cape_Verde" - | "Atlantic/Faeroe" - | "Atlantic/Faroe" - | "Atlantic/Jan_Mayen" - | "Atlantic/Madeira" - | "Atlantic/Reykjavik" - | "Atlantic/South_Georgia" - | "Atlantic/St_Helena" - | "Atlantic/Stanley" - | "Australia/ACT" - | "Australia/Adelaide" - | "Australia/Brisbane" - | "Australia/Broken_Hill" - | "Australia/Canberra" - | "Australia/Currie" - | "Australia/Darwin" - | "Australia/Eucla" - | "Australia/Hobart" - | "Australia/LHI" - | "Australia/Lindeman" - | "Australia/Lord_Howe" - | "Australia/Melbourne" - | "Australia/NSW" - | "Australia/North" - | "Australia/Perth" - | "Australia/Queensland" - | "Australia/South" - | "Australia/Sydney" - | "Australia/Tasmania" - | "Australia/Victoria" - | "Australia/West" - | "Australia/Yancowinna" - | "Brazil/Acre" - | "Brazil/DeNoronha" - | "Brazil/East" - | "Brazil/West" - | "CET" - | "CST6CDT" - | "Canada/Atlantic" - | "Canada/Central" - | "Canada/Eastern" - | "Canada/Mountain" - | "Canada/Newfoundland" - | "Canada/Pacific" - | "Canada/Saskatchewan" - | "Canada/Yukon" - | "Chile/Continental" - | "Chile/EasterIsland" - | "Cuba" - | "EET" - | "EST" - | "EST5EDT" - | "Egypt" - | "Eire" - | "Etc/GMT" - | "Etc/GMT+0" - | "Etc/GMT+1" - | "Etc/GMT+10" - | "Etc/GMT+11" - | "Etc/GMT+12" - | "Etc/GMT+2" - | "Etc/GMT+3" - | "Etc/GMT+4" - | "Etc/GMT+5" - | "Etc/GMT+6" - | "Etc/GMT+7" - | "Etc/GMT+8" - | "Etc/GMT+9" - | "Etc/GMT-0" - | "Etc/GMT-1" - | "Etc/GMT-10" - | "Etc/GMT-11" - | "Etc/GMT-12" - | "Etc/GMT-13" - | "Etc/GMT-14" - | "Etc/GMT-2" - | "Etc/GMT-3" - | "Etc/GMT-4" - | "Etc/GMT-5" - | "Etc/GMT-6" - | "Etc/GMT-7" - | "Etc/GMT-8" - | "Etc/GMT-9" - | "Etc/GMT0" - | "Etc/Greenwich" - | "Etc/UCT" - | "Etc/UTC" - | "Etc/Universal" - | "Etc/Zulu" - | "Europe/Amsterdam" - | "Europe/Andorra" - | "Europe/Astrakhan" - | "Europe/Athens" - | "Europe/Belfast" - | "Europe/Belgrade" - | "Europe/Berlin" - | "Europe/Bratislava" - | "Europe/Brussels" - | "Europe/Bucharest" - | "Europe/Budapest" - | "Europe/Busingen" - | "Europe/Chisinau" - | "Europe/Copenhagen" - | "Europe/Dublin" - | "Europe/Gibraltar" - | "Europe/Guernsey" - | "Europe/Helsinki" - | "Europe/Isle_of_Man" - | "Europe/Istanbul" - | "Europe/Jersey" - | "Europe/Kaliningrad" - | "Europe/Kiev" - | "Europe/Kirov" - | "Europe/Lisbon" - | "Europe/Ljubljana" - | "Europe/London" - | "Europe/Luxembourg" - | "Europe/Madrid" - | "Europe/Malta" - | "Europe/Mariehamn" - | "Europe/Minsk" - | "Europe/Monaco" - | "Europe/Moscow" - | "Europe/Nicosia" - | "Europe/Oslo" - | "Europe/Paris" - | "Europe/Podgorica" - | "Europe/Prague" - | "Europe/Riga" - | "Europe/Rome" - | "Europe/Samara" - | "Europe/San_Marino" - | "Europe/Sarajevo" - | "Europe/Saratov" - | "Europe/Simferopol" - | "Europe/Skopje" - | "Europe/Sofia" - | "Europe/Stockholm" - | "Europe/Tallinn" - | "Europe/Tirane" - | "Europe/Tiraspol" - | "Europe/Ulyanovsk" - | "Europe/Uzhgorod" - | "Europe/Vaduz" - | "Europe/Vatican" - | "Europe/Vienna" - | "Europe/Vilnius" - | "Europe/Volgograd" - | "Europe/Warsaw" - | "Europe/Zagreb" - | "Europe/Zaporozhye" - | "Europe/Zurich" - | "Factory" - | "GB" - | "GB-Eire" - | "GMT" - | "GMT+0" - | "GMT-0" - | "GMT0" - | "Greenwich" - | "HST" - | "Hongkong" - | "Iceland" - | "Indian/Antananarivo" - | "Indian/Chagos" - | "Indian/Christmas" - | "Indian/Cocos" - | "Indian/Comoro" - | "Indian/Kerguelen" - | "Indian/Mahe" - | "Indian/Maldives" - | "Indian/Mauritius" - | "Indian/Mayotte" - | "Indian/Reunion" - | "Iran" - | "Israel" - | "Jamaica" - | "Japan" - | "Kwajalein" - | "Libya" - | "MET" - | "MST" - | "MST7MDT" - | "Mexico/BajaNorte" - | "Mexico/BajaSur" - | "Mexico/General" - | "NZ" - | "NZ-CHAT" - | "Navajo" - | "PRC" - | "PST8PDT" - | "Pacific/Apia" - | "Pacific/Auckland" - | "Pacific/Bougainville" - | "Pacific/Chatham" - | "Pacific/Chuuk" - | "Pacific/Easter" - | "Pacific/Efate" - | "Pacific/Enderbury" - | "Pacific/Fakaofo" - | "Pacific/Fiji" - | "Pacific/Funafuti" - | "Pacific/Galapagos" - | "Pacific/Gambier" - | "Pacific/Guadalcanal" - | "Pacific/Guam" - | "Pacific/Honolulu" - | "Pacific/Johnston" - | "Pacific/Kiritimati" - | "Pacific/Kosrae" - | "Pacific/Kwajalein" - | "Pacific/Majuro" - | "Pacific/Marquesas" - | "Pacific/Midway" - | "Pacific/Nauru" - | "Pacific/Niue" - | "Pacific/Norfolk" - | "Pacific/Noumea" - | "Pacific/Pago_Pago" - | "Pacific/Palau" - | "Pacific/Pitcairn" - | "Pacific/Pohnpei" - | "Pacific/Ponape" - | "Pacific/Port_Moresby" - | "Pacific/Rarotonga" - | "Pacific/Saipan" - | "Pacific/Samoa" - | "Pacific/Tahiti" - | "Pacific/Tarawa" - | "Pacific/Tongatapu" - | "Pacific/Truk" - | "Pacific/Wake" - | "Pacific/Wallis" - | "Pacific/Yap" - | "Poland" - | "Portugal" - | "ROC" - | "ROK" - | "Singapore" - | "Turkey" - | "UCT" - | "US/Alaska" - | "US/Aleutian" - | "US/Arizona" - | "US/Central" - | "US/East-Indiana" - | "US/Eastern" - | "US/Hawaii" - | "US/Indiana-Starke" - | "US/Michigan" - | "US/Mountain" - | "US/Pacific" - | "US/Pacific-New" - | "US/Samoa" - | "UTC" - | "Universal" - | "W-SU" - | "WET" - | "Zulu"; - }; + | 'Africa/Abidjan' + | 'Africa/Accra' + | 'Africa/Addis_Ababa' + | 'Africa/Algiers' + | 'Africa/Asmara' + | 'Africa/Asmera' + | 'Africa/Bamako' + | 'Africa/Bangui' + | 'Africa/Banjul' + | 'Africa/Bissau' + | 'Africa/Blantyre' + | 'Africa/Brazzaville' + | 'Africa/Bujumbura' + | 'Africa/Cairo' + | 'Africa/Casablanca' + | 'Africa/Ceuta' + | 'Africa/Conakry' + | 'Africa/Dakar' + | 'Africa/Dar_es_Salaam' + | 'Africa/Djibouti' + | 'Africa/Douala' + | 'Africa/El_Aaiun' + | 'Africa/Freetown' + | 'Africa/Gaborone' + | 'Africa/Harare' + | 'Africa/Johannesburg' + | 'Africa/Juba' + | 'Africa/Kampala' + | 'Africa/Khartoum' + | 'Africa/Kigali' + | 'Africa/Kinshasa' + | 'Africa/Lagos' + | 'Africa/Libreville' + | 'Africa/Lome' + | 'Africa/Luanda' + | 'Africa/Lubumbashi' + | 'Africa/Lusaka' + | 'Africa/Malabo' + | 'Africa/Maputo' + | 'Africa/Maseru' + | 'Africa/Mbabane' + | 'Africa/Mogadishu' + | 'Africa/Monrovia' + | 'Africa/Nairobi' + | 'Africa/Ndjamena' + | 'Africa/Niamey' + | 'Africa/Nouakchott' + | 'Africa/Ouagadougou' + | 'Africa/Porto-Novo' + | 'Africa/Sao_Tome' + | 'Africa/Timbuktu' + | 'Africa/Tripoli' + | 'Africa/Tunis' + | 'Africa/Windhoek' + | 'America/Adak' + | 'America/Anchorage' + | 'America/Anguilla' + | 'America/Antigua' + | 'America/Araguaina' + | 'America/Argentina/Buenos_Aires' + | 'America/Argentina/Catamarca' + | 'America/Argentina/ComodRivadavia' + | 'America/Argentina/Cordoba' + | 'America/Argentina/Jujuy' + | 'America/Argentina/La_Rioja' + | 'America/Argentina/Mendoza' + | 'America/Argentina/Rio_Gallegos' + | 'America/Argentina/Salta' + | 'America/Argentina/San_Juan' + | 'America/Argentina/San_Luis' + | 'America/Argentina/Tucuman' + | 'America/Argentina/Ushuaia' + | 'America/Aruba' + | 'America/Asuncion' + | 'America/Atikokan' + | 'America/Atka' + | 'America/Bahia' + | 'America/Bahia_Banderas' + | 'America/Barbados' + | 'America/Belem' + | 'America/Belize' + | 'America/Blanc-Sablon' + | 'America/Boa_Vista' + | 'America/Bogota' + | 'America/Boise' + | 'America/Buenos_Aires' + | 'America/Cambridge_Bay' + | 'America/Campo_Grande' + | 'America/Cancun' + | 'America/Caracas' + | 'America/Catamarca' + | 'America/Cayenne' + | 'America/Cayman' + | 'America/Chicago' + | 'America/Chihuahua' + | 'America/Coral_Harbour' + | 'America/Cordoba' + | 'America/Costa_Rica' + | 'America/Creston' + | 'America/Cuiaba' + | 'America/Curacao' + | 'America/Danmarkshavn' + | 'America/Dawson' + | 'America/Dawson_Creek' + | 'America/Denver' + | 'America/Detroit' + | 'America/Dominica' + | 'America/Edmonton' + | 'America/Eirunepe' + | 'America/El_Salvador' + | 'America/Ensenada' + | 'America/Fort_Nelson' + | 'America/Fort_Wayne' + | 'America/Fortaleza' + | 'America/Glace_Bay' + | 'America/Godthab' + | 'America/Goose_Bay' + | 'America/Grand_Turk' + | 'America/Grenada' + | 'America/Guadeloupe' + | 'America/Guatemala' + | 'America/Guayaquil' + | 'America/Guyana' + | 'America/Halifax' + | 'America/Havana' + | 'America/Hermosillo' + | 'America/Indiana/Indianapolis' + | 'America/Indiana/Knox' + | 'America/Indiana/Marengo' + | 'America/Indiana/Petersburg' + | 'America/Indiana/Tell_City' + | 'America/Indiana/Vevay' + | 'America/Indiana/Vincennes' + | 'America/Indiana/Winamac' + | 'America/Indianapolis' + | 'America/Inuvik' + | 'America/Iqaluit' + | 'America/Jamaica' + | 'America/Jujuy' + | 'America/Juneau' + | 'America/Kentucky/Louisville' + | 'America/Kentucky/Monticello' + | 'America/Knox_IN' + | 'America/Kralendijk' + | 'America/La_Paz' + | 'America/Lima' + | 'America/Los_Angeles' + | 'America/Louisville' + | 'America/Lower_Princes' + | 'America/Maceio' + | 'America/Managua' + | 'America/Manaus' + | 'America/Marigot' + | 'America/Martinique' + | 'America/Matamoros' + | 'America/Mazatlan' + | 'America/Mendoza' + | 'America/Menominee' + | 'America/Merida' + | 'America/Metlakatla' + | 'America/Mexico_City' + | 'America/Miquelon' + | 'America/Moncton' + | 'America/Monterrey' + | 'America/Montevideo' + | 'America/Montreal' + | 'America/Montserrat' + | 'America/Nassau' + | 'America/New_York' + | 'America/Nipigon' + | 'America/Nome' + | 'America/Noronha' + | 'America/North_Dakota/Beulah' + | 'America/North_Dakota/Center' + | 'America/North_Dakota/New_Salem' + | 'America/Ojinaga' + | 'America/Panama' + | 'America/Pangnirtung' + | 'America/Paramaribo' + | 'America/Phoenix' + | 'America/Port-au-Prince' + | 'America/Port_of_Spain' + | 'America/Porto_Acre' + | 'America/Porto_Velho' + | 'America/Puerto_Rico' + | 'America/Punta_Arenas' + | 'America/Rainy_River' + | 'America/Rankin_Inlet' + | 'America/Recife' + | 'America/Regina' + | 'America/Resolute' + | 'America/Rio_Branco' + | 'America/Rosario' + | 'America/Santa_Isabel' + | 'America/Santarem' + | 'America/Santiago' + | 'America/Santo_Domingo' + | 'America/Sao_Paulo' + | 'America/Scoresbysund' + | 'America/Shiprock' + | 'America/Sitka' + | 'America/St_Barthelemy' + | 'America/St_Johns' + | 'America/St_Kitts' + | 'America/St_Lucia' + | 'America/St_Thomas' + | 'America/St_Vincent' + | 'America/Swift_Current' + | 'America/Tegucigalpa' + | 'America/Thule' + | 'America/Thunder_Bay' + | 'America/Tijuana' + | 'America/Toronto' + | 'America/Tortola' + | 'America/Vancouver' + | 'America/Virgin' + | 'America/Whitehorse' + | 'America/Winnipeg' + | 'America/Yakutat' + | 'America/Yellowknife' + | 'Antarctica/Casey' + | 'Antarctica/Davis' + | 'Antarctica/DumontDUrville' + | 'Antarctica/Macquarie' + | 'Antarctica/Mawson' + | 'Antarctica/McMurdo' + | 'Antarctica/Palmer' + | 'Antarctica/Rothera' + | 'Antarctica/South_Pole' + | 'Antarctica/Syowa' + | 'Antarctica/Troll' + | 'Antarctica/Vostok' + | 'Arctic/Longyearbyen' + | 'Asia/Aden' + | 'Asia/Almaty' + | 'Asia/Amman' + | 'Asia/Anadyr' + | 'Asia/Aqtau' + | 'Asia/Aqtobe' + | 'Asia/Ashgabat' + | 'Asia/Ashkhabad' + | 'Asia/Atyrau' + | 'Asia/Baghdad' + | 'Asia/Bahrain' + | 'Asia/Baku' + | 'Asia/Bangkok' + | 'Asia/Barnaul' + | 'Asia/Beirut' + | 'Asia/Bishkek' + | 'Asia/Brunei' + | 'Asia/Calcutta' + | 'Asia/Chita' + | 'Asia/Choibalsan' + | 'Asia/Chongqing' + | 'Asia/Chungking' + | 'Asia/Colombo' + | 'Asia/Dacca' + | 'Asia/Damascus' + | 'Asia/Dhaka' + | 'Asia/Dili' + | 'Asia/Dubai' + | 'Asia/Dushanbe' + | 'Asia/Famagusta' + | 'Asia/Gaza' + | 'Asia/Harbin' + | 'Asia/Hebron' + | 'Asia/Ho_Chi_Minh' + | 'Asia/Hong_Kong' + | 'Asia/Hovd' + | 'Asia/Irkutsk' + | 'Asia/Istanbul' + | 'Asia/Jakarta' + | 'Asia/Jayapura' + | 'Asia/Jerusalem' + | 'Asia/Kabul' + | 'Asia/Kamchatka' + | 'Asia/Karachi' + | 'Asia/Kashgar' + | 'Asia/Kathmandu' + | 'Asia/Katmandu' + | 'Asia/Khandyga' + | 'Asia/Kolkata' + | 'Asia/Krasnoyarsk' + | 'Asia/Kuala_Lumpur' + | 'Asia/Kuching' + | 'Asia/Kuwait' + | 'Asia/Macao' + | 'Asia/Macau' + | 'Asia/Magadan' + | 'Asia/Makassar' + | 'Asia/Manila' + | 'Asia/Muscat' + | 'Asia/Nicosia' + | 'Asia/Novokuznetsk' + | 'Asia/Novosibirsk' + | 'Asia/Omsk' + | 'Asia/Oral' + | 'Asia/Phnom_Penh' + | 'Asia/Pontianak' + | 'Asia/Pyongyang' + | 'Asia/Qatar' + | 'Asia/Qostanay' + | 'Asia/Qyzylorda' + | 'Asia/Rangoon' + | 'Asia/Riyadh' + | 'Asia/Saigon' + | 'Asia/Sakhalin' + | 'Asia/Samarkand' + | 'Asia/Seoul' + | 'Asia/Shanghai' + | 'Asia/Singapore' + | 'Asia/Srednekolymsk' + | 'Asia/Taipei' + | 'Asia/Tashkent' + | 'Asia/Tbilisi' + | 'Asia/Tehran' + | 'Asia/Tel_Aviv' + | 'Asia/Thimbu' + | 'Asia/Thimphu' + | 'Asia/Tokyo' + | 'Asia/Tomsk' + | 'Asia/Ujung_Pandang' + | 'Asia/Ulaanbaatar' + | 'Asia/Ulan_Bator' + | 'Asia/Urumqi' + | 'Asia/Ust-Nera' + | 'Asia/Vientiane' + | 'Asia/Vladivostok' + | 'Asia/Yakutsk' + | 'Asia/Yangon' + | 'Asia/Yekaterinburg' + | 'Asia/Yerevan' + | 'Atlantic/Azores' + | 'Atlantic/Bermuda' + | 'Atlantic/Canary' + | 'Atlantic/Cape_Verde' + | 'Atlantic/Faeroe' + | 'Atlantic/Faroe' + | 'Atlantic/Jan_Mayen' + | 'Atlantic/Madeira' + | 'Atlantic/Reykjavik' + | 'Atlantic/South_Georgia' + | 'Atlantic/St_Helena' + | 'Atlantic/Stanley' + | 'Australia/ACT' + | 'Australia/Adelaide' + | 'Australia/Brisbane' + | 'Australia/Broken_Hill' + | 'Australia/Canberra' + | 'Australia/Currie' + | 'Australia/Darwin' + | 'Australia/Eucla' + | 'Australia/Hobart' + | 'Australia/LHI' + | 'Australia/Lindeman' + | 'Australia/Lord_Howe' + | 'Australia/Melbourne' + | 'Australia/NSW' + | 'Australia/North' + | 'Australia/Perth' + | 'Australia/Queensland' + | 'Australia/South' + | 'Australia/Sydney' + | 'Australia/Tasmania' + | 'Australia/Victoria' + | 'Australia/West' + | 'Australia/Yancowinna' + | 'Brazil/Acre' + | 'Brazil/DeNoronha' + | 'Brazil/East' + | 'Brazil/West' + | 'CET' + | 'CST6CDT' + | 'Canada/Atlantic' + | 'Canada/Central' + | 'Canada/Eastern' + | 'Canada/Mountain' + | 'Canada/Newfoundland' + | 'Canada/Pacific' + | 'Canada/Saskatchewan' + | 'Canada/Yukon' + | 'Chile/Continental' + | 'Chile/EasterIsland' + | 'Cuba' + | 'EET' + | 'EST' + | 'EST5EDT' + | 'Egypt' + | 'Eire' + | 'Etc/GMT' + | 'Etc/GMT+0' + | 'Etc/GMT+1' + | 'Etc/GMT+10' + | 'Etc/GMT+11' + | 'Etc/GMT+12' + | 'Etc/GMT+2' + | 'Etc/GMT+3' + | 'Etc/GMT+4' + | 'Etc/GMT+5' + | 'Etc/GMT+6' + | 'Etc/GMT+7' + | 'Etc/GMT+8' + | 'Etc/GMT+9' + | 'Etc/GMT-0' + | 'Etc/GMT-1' + | 'Etc/GMT-10' + | 'Etc/GMT-11' + | 'Etc/GMT-12' + | 'Etc/GMT-13' + | 'Etc/GMT-14' + | 'Etc/GMT-2' + | 'Etc/GMT-3' + | 'Etc/GMT-4' + | 'Etc/GMT-5' + | 'Etc/GMT-6' + | 'Etc/GMT-7' + | 'Etc/GMT-8' + | 'Etc/GMT-9' + | 'Etc/GMT0' + | 'Etc/Greenwich' + | 'Etc/UCT' + | 'Etc/UTC' + | 'Etc/Universal' + | 'Etc/Zulu' + | 'Europe/Amsterdam' + | 'Europe/Andorra' + | 'Europe/Astrakhan' + | 'Europe/Athens' + | 'Europe/Belfast' + | 'Europe/Belgrade' + | 'Europe/Berlin' + | 'Europe/Bratislava' + | 'Europe/Brussels' + | 'Europe/Bucharest' + | 'Europe/Budapest' + | 'Europe/Busingen' + | 'Europe/Chisinau' + | 'Europe/Copenhagen' + | 'Europe/Dublin' + | 'Europe/Gibraltar' + | 'Europe/Guernsey' + | 'Europe/Helsinki' + | 'Europe/Isle_of_Man' + | 'Europe/Istanbul' + | 'Europe/Jersey' + | 'Europe/Kaliningrad' + | 'Europe/Kiev' + | 'Europe/Kirov' + | 'Europe/Lisbon' + | 'Europe/Ljubljana' + | 'Europe/London' + | 'Europe/Luxembourg' + | 'Europe/Madrid' + | 'Europe/Malta' + | 'Europe/Mariehamn' + | 'Europe/Minsk' + | 'Europe/Monaco' + | 'Europe/Moscow' + | 'Europe/Nicosia' + | 'Europe/Oslo' + | 'Europe/Paris' + | 'Europe/Podgorica' + | 'Europe/Prague' + | 'Europe/Riga' + | 'Europe/Rome' + | 'Europe/Samara' + | 'Europe/San_Marino' + | 'Europe/Sarajevo' + | 'Europe/Saratov' + | 'Europe/Simferopol' + | 'Europe/Skopje' + | 'Europe/Sofia' + | 'Europe/Stockholm' + | 'Europe/Tallinn' + | 'Europe/Tirane' + | 'Europe/Tiraspol' + | 'Europe/Ulyanovsk' + | 'Europe/Uzhgorod' + | 'Europe/Vaduz' + | 'Europe/Vatican' + | 'Europe/Vienna' + | 'Europe/Vilnius' + | 'Europe/Volgograd' + | 'Europe/Warsaw' + | 'Europe/Zagreb' + | 'Europe/Zaporozhye' + | 'Europe/Zurich' + | 'Factory' + | 'GB' + | 'GB-Eire' + | 'GMT' + | 'GMT+0' + | 'GMT-0' + | 'GMT0' + | 'Greenwich' + | 'HST' + | 'Hongkong' + | 'Iceland' + | 'Indian/Antananarivo' + | 'Indian/Chagos' + | 'Indian/Christmas' + | 'Indian/Cocos' + | 'Indian/Comoro' + | 'Indian/Kerguelen' + | 'Indian/Mahe' + | 'Indian/Maldives' + | 'Indian/Mauritius' + | 'Indian/Mayotte' + | 'Indian/Reunion' + | 'Iran' + | 'Israel' + | 'Jamaica' + | 'Japan' + | 'Kwajalein' + | 'Libya' + | 'MET' + | 'MST' + | 'MST7MDT' + | 'Mexico/BajaNorte' + | 'Mexico/BajaSur' + | 'Mexico/General' + | 'NZ' + | 'NZ-CHAT' + | 'Navajo' + | 'PRC' + | 'PST8PDT' + | 'Pacific/Apia' + | 'Pacific/Auckland' + | 'Pacific/Bougainville' + | 'Pacific/Chatham' + | 'Pacific/Chuuk' + | 'Pacific/Easter' + | 'Pacific/Efate' + | 'Pacific/Enderbury' + | 'Pacific/Fakaofo' + | 'Pacific/Fiji' + | 'Pacific/Funafuti' + | 'Pacific/Galapagos' + | 'Pacific/Gambier' + | 'Pacific/Guadalcanal' + | 'Pacific/Guam' + | 'Pacific/Honolulu' + | 'Pacific/Johnston' + | 'Pacific/Kiritimati' + | 'Pacific/Kosrae' + | 'Pacific/Kwajalein' + | 'Pacific/Majuro' + | 'Pacific/Marquesas' + | 'Pacific/Midway' + | 'Pacific/Nauru' + | 'Pacific/Niue' + | 'Pacific/Norfolk' + | 'Pacific/Noumea' + | 'Pacific/Pago_Pago' + | 'Pacific/Palau' + | 'Pacific/Pitcairn' + | 'Pacific/Pohnpei' + | 'Pacific/Ponape' + | 'Pacific/Port_Moresby' + | 'Pacific/Rarotonga' + | 'Pacific/Saipan' + | 'Pacific/Samoa' + | 'Pacific/Tahiti' + | 'Pacific/Tarawa' + | 'Pacific/Tongatapu' + | 'Pacific/Truk' + | 'Pacific/Wake' + | 'Pacific/Wallis' + | 'Pacific/Yap' + | 'Poland' + | 'Portugal' + | 'ROC' + | 'ROK' + | 'Singapore' + | 'Turkey' + | 'UCT' + | 'US/Alaska' + | 'US/Aleutian' + | 'US/Arizona' + | 'US/Central' + | 'US/East-Indiana' + | 'US/Eastern' + | 'US/Hawaii' + | 'US/Indiana-Starke' + | 'US/Michigan' + | 'US/Mountain' + | 'US/Pacific' + | 'US/Pacific-New' + | 'US/Samoa' + | 'UTC' + | 'Universal' + | 'W-SU' + | 'WET' + | 'Zulu' + } /** @description The ID of the [report type](https://stripe.com/docs/reporting/statements/api#report-types) to run, such as `"balance.summary.1"`. */ - readonly report_type: string; - }; - }; - }; - }; + readonly report_type: string + } + } + } + } /**

Retrieves the details of an existing Report Run.

*/ readonly GetReportingReportRunsReportRun: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly report_run: string; - }; - }; + readonly report_run: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["reporting.report_run"]; - }; - }; + readonly 'application/json': components['schemas']['reporting.report_run'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Returns a full list of Report Types.

*/ readonly GetReportingReportTypes: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; + readonly expand?: readonly string[] + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["reporting.report_type"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['reporting.report_type'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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

*/ readonly GetReportingReportTypesReportType: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly report_type: string; - }; - }; + readonly report_type: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["reporting.report_type"]; - }; - }; + readonly 'application/json': components['schemas']['reporting.report_type'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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.

*/ readonly GetReviews: { readonly parameters: { readonly query: { readonly created?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["review"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['review'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Retrieves a Review object.

*/ readonly GetReviewsReview: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly review: string; - }; - }; + readonly review: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["review"]; - }; - }; + readonly 'application/json': components['schemas']['review'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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

*/ readonly PostReviewsReviewApprove: { readonly parameters: { readonly path: { - readonly review: string; - }; - }; + readonly review: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["review"]; - }; - }; + readonly 'application/json': components['schemas']['review'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } + } /**

Returns a list of SetupAttempts associated with a provided SetupIntent.

*/ readonly GetSetupAttempts: { readonly parameters: { @@ -39003,115 +38764,115 @@ export interface operations { * dictionary with a number of different query options. */ readonly created?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** * Only return SetupAttempts created by the SetupIntent specified by * this ID. */ - readonly setup_intent: string; + readonly setup_intent: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["setup_attempt"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['setup_attempt'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Returns a list of SetupIntents.

*/ readonly GetSetupIntents: { readonly parameters: { readonly query: { /** 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. */ readonly created?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** Only return SetupIntents for the customer specified by this customer ID. */ - readonly customer?: string; + readonly customer?: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** Only return SetupIntents associated with the specified payment method. */ - readonly payment_method?: string; + readonly payment_method?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["setup_intent"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['setup_intent'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /** *

Creates a SetupIntent object.

* @@ -39123,31 +38884,31 @@ export interface operations { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["setup_intent"]; - }; - }; + readonly 'application/json': components['schemas']['setup_intent'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Set to `true` to attempt to confirm this SetupIntent immediately. This parameter defaults to `false`. If the payment method attached is a card, a return_url may be provided in case additional authentication is required. */ - readonly confirm?: boolean; + readonly confirm?: boolean /** * @description ID of the Customer this SetupIntent belongs to, if one exists. * * If 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. */ - readonly customer?: string; + readonly customer?: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string; + readonly description?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** * secret_key_param * @description This hash contains details about the Mandate to create. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm). @@ -39156,24 +38917,24 @@ export interface operations { /** customer_acceptance_param */ readonly customer_acceptance: { /** Format: unix-time */ - readonly accepted_at?: number; + readonly accepted_at?: number /** offline_param */ - readonly offline?: { readonly [key: string]: unknown }; + readonly offline?: { readonly [key: string]: unknown } /** online_param */ readonly online?: { - readonly ip_address: string; - readonly user_agent: string; - }; + readonly ip_address: string + readonly user_agent: string + } /** @enum {string} */ - readonly type: "offline" | "online"; - }; - }; + readonly type: 'offline' | 'online' + } + } /** @description 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`. */ - readonly metadata?: { readonly [key: string]: string }; + readonly metadata?: { readonly [key: string]: string } /** @description The Stripe account ID for which this SetupIntent is created. */ - readonly on_behalf_of?: string; + readonly on_behalf_of?: string /** @description ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. */ - readonly payment_method?: string; + readonly payment_method?: string /** * payment_method_options_param * @description Payment-method-specific configuration for this SetupIntent. @@ -39182,52 +38943,52 @@ export interface operations { /** setup_intent_payment_method_options_param */ readonly acss_debit?: { /** @enum {string} */ - readonly currency?: "cad" | "usd"; + readonly currency?: 'cad' | 'usd' /** setup_intent_payment_method_options_mandate_options_param */ readonly mandate_options?: { - readonly custom_mandate_url?: Partial & Partial<"">; - readonly default_for?: readonly ("invoice" | "subscription")[]; - readonly interval_description?: string; + readonly custom_mandate_url?: Partial & Partial<''> + readonly default_for?: readonly ('invoice' | 'subscription')[] + readonly interval_description?: string /** @enum {string} */ - readonly payment_schedule?: "combined" | "interval" | "sporadic"; + readonly payment_schedule?: 'combined' | 'interval' | 'sporadic' /** @enum {string} */ - readonly transaction_type?: "business" | "personal"; - }; + readonly transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - readonly verification_method?: "automatic" | "instant" | "microdeposits"; - }; + readonly verification_method?: 'automatic' | 'instant' | 'microdeposits' + } /** setup_intent_param */ readonly card?: { /** @enum {string} */ - readonly request_three_d_secure?: "any" | "automatic"; - }; + readonly request_three_d_secure?: 'any' | 'automatic' + } /** setup_intent_payment_method_options_param */ readonly sepa_debit?: { /** payment_method_options_mandate_options_param */ - readonly mandate_options?: { readonly [key: string]: unknown }; - }; - }; + readonly mandate_options?: { readonly [key: string]: unknown } + } + } /** @description The list of payment method types (e.g. card) that this SetupIntent is allowed to use. If this is not provided, defaults to ["card"]. */ - readonly payment_method_types?: readonly string[]; + readonly payment_method_types?: readonly string[] /** @description The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm). */ - readonly return_url?: string; + readonly return_url?: string /** * setup_intent_single_use_params * @description If this hash is populated, this SetupIntent will generate a single_use Mandate on success. */ readonly single_use?: { - readonly amount: number; - readonly currency: string; - }; + readonly amount: number + readonly currency: string + } /** * @description Indicates how the payment method is intended to be used in the future. If not provided, this value defaults to `off_session`. * @enum {string} */ - readonly usage?: "off_session" | "on_session"; - }; - }; - }; - }; + readonly usage?: 'off_session' | 'on_session' + } + } + } + } /** *

Retrieves the details of a SetupIntent that has previously been created.

* @@ -39239,72 +39000,72 @@ export interface operations { readonly parameters: { readonly query: { /** The client secret of the SetupIntent. Required if a publishable key is used to retrieve the SetupIntent. */ - readonly client_secret?: string; + readonly client_secret?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly intent: string; - }; - }; + readonly intent: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["setup_intent"]; - }; - }; + readonly 'application/json': components['schemas']['setup_intent'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Updates a SetupIntent object.

*/ readonly PostSetupIntentsIntent: { readonly parameters: { readonly path: { - readonly intent: string; - }; - }; + readonly intent: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["setup_intent"]; - }; - }; + readonly 'application/json': components['schemas']['setup_intent'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** * @description ID of the Customer this SetupIntent belongs to, if one exists. * * If 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. */ - readonly customer?: string; + readonly customer?: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string; + readonly description?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. */ - readonly payment_method?: string; + readonly payment_method?: string /** * payment_method_options_param * @description Payment-method-specific configuration for this SetupIntent. @@ -39313,37 +39074,37 @@ export interface operations { /** setup_intent_payment_method_options_param */ readonly acss_debit?: { /** @enum {string} */ - readonly currency?: "cad" | "usd"; + readonly currency?: 'cad' | 'usd' /** setup_intent_payment_method_options_mandate_options_param */ readonly mandate_options?: { - readonly custom_mandate_url?: Partial & Partial<"">; - readonly default_for?: readonly ("invoice" | "subscription")[]; - readonly interval_description?: string; + readonly custom_mandate_url?: Partial & Partial<''> + readonly default_for?: readonly ('invoice' | 'subscription')[] + readonly interval_description?: string /** @enum {string} */ - readonly payment_schedule?: "combined" | "interval" | "sporadic"; + readonly payment_schedule?: 'combined' | 'interval' | 'sporadic' /** @enum {string} */ - readonly transaction_type?: "business" | "personal"; - }; + readonly transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - readonly verification_method?: "automatic" | "instant" | "microdeposits"; - }; + readonly verification_method?: 'automatic' | 'instant' | 'microdeposits' + } /** setup_intent_param */ readonly card?: { /** @enum {string} */ - readonly request_three_d_secure?: "any" | "automatic"; - }; + readonly request_three_d_secure?: 'any' | 'automatic' + } /** setup_intent_payment_method_options_param */ readonly sepa_debit?: { /** payment_method_options_mandate_options_param */ - readonly mandate_options?: { readonly [key: string]: unknown }; - }; - }; + readonly mandate_options?: { readonly [key: string]: unknown } + } + } /** @description The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. If this is not provided, defaults to ["card"]. */ - readonly payment_method_types?: readonly string[]; - }; - }; - }; - }; + readonly payment_method_types?: readonly string[] + } + } + } + } /** *

A SetupIntent object can be canceled when it is in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.

* @@ -39352,37 +39113,37 @@ export interface operations { readonly PostSetupIntentsIntentCancel: { readonly parameters: { readonly path: { - readonly intent: string; - }; - }; + readonly intent: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["setup_intent"]; - }; - }; + readonly 'application/json': components['schemas']['setup_intent'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** * @description Reason for canceling this SetupIntent. Possible values are `abandoned`, `requested_by_customer`, or `duplicate` * @enum {string} */ - readonly cancellation_reason?: "abandoned" | "duplicate" | "requested_by_customer"; + readonly cancellation_reason?: 'abandoned' | 'duplicate' | 'requested_by_customer' /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } + } /** *

Confirm that your customer intends to set up the current or * provided payment method. For example, you would confirm a SetupIntent @@ -39401,61 +39162,61 @@ export interface operations { readonly PostSetupIntentsIntentConfirm: { readonly parameters: { readonly path: { - readonly intent: string; - }; - }; + readonly intent: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["setup_intent"]; - }; - }; + readonly 'application/json': components['schemas']['setup_intent'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description The client secret of the SetupIntent. */ - readonly client_secret?: string; + readonly client_secret?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description This hash contains details about the Mandate to create */ readonly mandate_data?: Partial<{ /** customer_acceptance_param */ readonly customer_acceptance: { /** Format: unix-time */ - readonly accepted_at?: number; + readonly accepted_at?: number /** offline_param */ - readonly offline?: { readonly [key: string]: unknown }; + readonly offline?: { readonly [key: string]: unknown } /** online_param */ readonly online?: { - readonly ip_address: string; - readonly user_agent: string; - }; + readonly ip_address: string + readonly user_agent: string + } /** @enum {string} */ - readonly type: "offline" | "online"; - }; + readonly type: 'offline' | 'online' + } }> & Partial<{ /** customer_acceptance_param */ readonly customer_acceptance: { /** online_param */ readonly online: { - readonly ip_address?: string; - readonly user_agent?: string; - }; + readonly ip_address?: string + readonly user_agent?: string + } /** @enum {string} */ - readonly type: "online"; - }; - }>; + readonly type: 'online' + } + }> /** @description ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. */ - readonly payment_method?: string; + readonly payment_method?: string /** * payment_method_options_param * @description Payment-method-specific configuration for this SetupIntent. @@ -39464,151 +39225,151 @@ export interface operations { /** setup_intent_payment_method_options_param */ readonly acss_debit?: { /** @enum {string} */ - readonly currency?: "cad" | "usd"; + readonly currency?: 'cad' | 'usd' /** setup_intent_payment_method_options_mandate_options_param */ readonly mandate_options?: { - readonly custom_mandate_url?: Partial & Partial<"">; - readonly default_for?: readonly ("invoice" | "subscription")[]; - readonly interval_description?: string; + readonly custom_mandate_url?: Partial & Partial<''> + readonly default_for?: readonly ('invoice' | 'subscription')[] + readonly interval_description?: string /** @enum {string} */ - readonly payment_schedule?: "combined" | "interval" | "sporadic"; + readonly payment_schedule?: 'combined' | 'interval' | 'sporadic' /** @enum {string} */ - readonly transaction_type?: "business" | "personal"; - }; + readonly transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - readonly verification_method?: "automatic" | "instant" | "microdeposits"; - }; + readonly verification_method?: 'automatic' | 'instant' | 'microdeposits' + } /** setup_intent_param */ readonly card?: { /** @enum {string} */ - readonly request_three_d_secure?: "any" | "automatic"; - }; + readonly request_three_d_secure?: 'any' | 'automatic' + } /** setup_intent_payment_method_options_param */ readonly sepa_debit?: { /** payment_method_options_mandate_options_param */ - readonly mandate_options?: { readonly [key: string]: unknown }; - }; - }; + readonly mandate_options?: { readonly [key: string]: unknown } + } + } /** * @description The URL to redirect your customer back to after they authenticate on the payment method's app or site. * If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. * This parameter is only used for cards and other redirect-based payment methods. */ - readonly return_url?: string; - }; - }; - }; - }; + readonly return_url?: string + } + } + } + } /**

Verifies microdeposits on a SetupIntent object.

*/ readonly PostSetupIntentsIntentVerifyMicrodeposits: { readonly parameters: { readonly path: { - readonly intent: string; - }; - }; + readonly intent: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["setup_intent"]; - }; - }; + readonly 'application/json': components['schemas']['setup_intent'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account. */ - readonly amounts?: readonly number[]; + readonly amounts?: readonly number[] /** @description The client secret of the SetupIntent. */ - readonly client_secret?: string; + readonly client_secret?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } + } /**

Returns a list of your shipping rates.

*/ readonly GetShippingRates: { readonly parameters: { readonly query: { /** Only return shipping rates that are active or inactive. */ - readonly active?: boolean; + readonly active?: boolean /** 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. */ readonly created?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** Only return shipping rates for the given currency. */ - readonly currency?: string; + readonly currency?: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["shipping_rate"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['shipping_rate'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Creates a new shipping rate object.

*/ readonly PostShippingRates: { readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["shipping_rate"]; - }; - }; + readonly 'application/json': components['schemas']['shipping_rate'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** * delivery_estimate * @description The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions. @@ -39617,336 +39378,335 @@ export interface operations { /** delivery_estimate_bound */ readonly maximum?: { /** @enum {string} */ - readonly unit: "business_day" | "day" | "hour" | "month" | "week"; - readonly value: number; - }; + readonly unit: 'business_day' | 'day' | 'hour' | 'month' | 'week' + readonly value: number + } /** delivery_estimate_bound */ readonly minimum?: { /** @enum {string} */ - readonly unit: "business_day" | "day" | "hour" | "month" | "week"; - readonly value: number; - }; - }; + readonly unit: 'business_day' | 'day' | 'hour' | 'month' | 'week' + readonly value: number + } + } /** @description The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions. */ - readonly display_name: string; + readonly display_name: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** * fixed_amount * @description Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`. */ readonly fixed_amount?: { - readonly amount: number; - readonly currency: string; - }; + readonly amount: number + readonly currency: string + } /** @description 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`. */ - readonly metadata?: { readonly [key: string]: string }; + readonly metadata?: { readonly [key: string]: string } /** * @description Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. * @enum {string} */ - readonly tax_behavior?: "exclusive" | "inclusive" | "unspecified"; + readonly tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' /** @description A [tax code](https://stripe.com/docs/tax/tax-codes) ID. The Shipping tax code is `txcd_92010001`. */ - readonly tax_code?: string; + readonly tax_code?: string /** * @description The type of calculation to use on the shipping rate. Can only be `fixed_amount` for now. * @enum {string} */ - readonly type?: "fixed_amount"; - }; - }; - }; - }; + readonly type?: 'fixed_amount' + } + } + } + } /**

Returns the shipping rate object with the given ID.

*/ readonly GetShippingRatesShippingRateToken: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly shipping_rate_token: string; - }; - }; + readonly shipping_rate_token: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["shipping_rate"]; - }; - }; + readonly 'application/json': components['schemas']['shipping_rate'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Updates an existing shipping rate object.

*/ readonly PostShippingRatesShippingRateToken: { readonly parameters: { readonly path: { - readonly shipping_rate_token: string; - }; - }; + readonly shipping_rate_token: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["shipping_rate"]; - }; - }; + readonly 'application/json': components['schemas']['shipping_rate'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Whether the shipping rate can be used for new purchases. Defaults to `true`. */ - readonly active?: boolean; + readonly active?: boolean /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> + } + } + } + } /**

Returns a list of scheduled query runs.

*/ readonly GetSigmaScheduledQueryRuns: { readonly parameters: { readonly query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["scheduled_query_run"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['scheduled_query_run'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Retrieves the details of an scheduled query run.

*/ readonly GetSigmaScheduledQueryRunsScheduledQueryRun: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly scheduled_query_run: string; - }; - }; + readonly scheduled_query_run: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["scheduled_query_run"]; - }; - }; + readonly 'application/json': components['schemas']['scheduled_query_run'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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

*/ readonly GetSkus: { readonly parameters: { readonly query: { /** Only return SKUs that are active or inactive (e.g., pass `false` to list all inactive products). */ - readonly active?: boolean; + readonly active?: boolean /** Only return SKUs that have the specified key-value pairs in this partially constructed dictionary. Can be specified only if `product` is also supplied. For instance, if the associated product has attributes `["color", "size"]`, passing in `attributes[color]=red` returns all the SKUs for this product that have `color` set to `red`. */ - readonly attributes?: { readonly [key: string]: string }; + readonly attributes?: { readonly [key: string]: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** Only return SKUs with the given IDs. */ - readonly ids?: readonly string[]; + readonly ids?: readonly string[] /** Only return SKUs that are either in stock or out of stock (e.g., pass `false` to list all SKUs that are out of stock). If no value is provided, all SKUs are returned. */ - readonly in_stock?: boolean; + readonly in_stock?: boolean /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** The ID of the product whose SKUs will be retrieved. Must be a product with type `good`. */ - readonly product?: string; + readonly product?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["sku"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['sku'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Creates a new SKU associated with a product.

*/ readonly PostSkus: { readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["sku"]; - }; - }; + readonly 'application/json': components['schemas']['sku'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Whether the SKU is available for purchase. Default to `true`. */ - readonly active?: boolean; + readonly active?: boolean /** @description A dictionary of attributes and values for the attributes defined by the product. If, for example, a product's attributes are `["size", "gender"]`, a valid SKU has the following dictionary of attributes: `{"size": "Medium", "gender": "Unisex"}`. */ - readonly attributes?: { readonly [key: string]: string }; + readonly attributes?: { readonly [key: string]: string } /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The identifier for the SKU. Must be unique. If not provided, an identifier will be randomly generated. */ - readonly id?: string; + readonly id?: string /** @description The URL of an image for this SKU, meant to be displayable to the customer. */ - readonly image?: string; + readonly image?: string /** * inventory_create_specs * @description Description of the SKU's inventory. */ readonly inventory: { - readonly quantity?: number; + readonly quantity?: number /** @enum {string} */ - readonly type: "bucket" | "finite" | "infinite"; + readonly type: 'bucket' | 'finite' | 'infinite' /** @enum {string} */ - readonly value?: "" | "in_stock" | "limited" | "out_of_stock"; - }; + readonly value?: '' | 'in_stock' | 'limited' | 'out_of_stock' + } /** @description 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`. */ - readonly metadata?: { readonly [key: string]: string }; + readonly metadata?: { readonly [key: string]: string } /** * package_dimensions_specs * @description The dimensions of this SKU for shipping purposes. */ readonly package_dimensions?: { - readonly height: number; - readonly length: number; - readonly weight: number; - readonly width: number; - }; + readonly height: number + readonly length: number + readonly weight: number + readonly width: number + } /** @description The cost of the item as a nonnegative integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a zero-decimal currency). */ - readonly price: number; + readonly price: number /** @description The ID of the product this SKU is associated with. Must be a product with type `good`. */ - readonly product: string; - }; - }; - }; - }; + readonly product: string + } + } + } + } /**

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

*/ readonly GetSkusId: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": Partial & - Partial; - }; - }; + readonly 'application/json': Partial & Partial + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /** *

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

* @@ -39955,124 +39715,124 @@ export interface operations { readonly PostSkusId: { readonly parameters: { readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["sku"]; - }; - }; + readonly 'application/json': components['schemas']['sku'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Whether this SKU is available for purchase. */ - readonly active?: boolean; + readonly active?: boolean /** @description A dictionary of attributes and values for the attributes defined by the product. When specified, `attributes` will partially update the existing attributes dictionary on the product, with the postcondition that a value must be present for each attribute key on the product. */ - readonly attributes?: { readonly [key: string]: string }; + readonly attributes?: { readonly [key: string]: string } /** @description 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). */ - readonly currency?: string; + readonly currency?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The URL of an image for this SKU, meant to be displayable to the customer. */ - readonly image?: string; + readonly image?: string /** * inventory_update_specs * @description Description of the SKU's inventory. */ readonly inventory?: { - readonly quantity?: number; + readonly quantity?: number /** @enum {string} */ - readonly type?: "bucket" | "finite" | "infinite"; + readonly type?: 'bucket' | 'finite' | 'infinite' /** @enum {string} */ - readonly value?: "" | "in_stock" | "limited" | "out_of_stock"; - }; + readonly value?: '' | 'in_stock' | 'limited' | 'out_of_stock' + } /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description The dimensions of this SKU for shipping purposes. */ readonly package_dimensions?: Partial<{ - readonly height: number; - readonly length: number; - readonly weight: number; - readonly width: number; + readonly height: number + readonly length: number + readonly weight: number + readonly width: number }> & - Partial<"">; + Partial<''> /** @description The cost of the item as a positive integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a zero-decimal currency). */ - readonly price?: number; + readonly price?: number /** @description The ID of the product that this SKU should belong to. The product must exist, have the same set of attribute names as the SKU's current product, and be of type `good`. */ - readonly product?: string; - }; - }; - }; - }; + readonly product?: string + } + } + } + } /**

Delete a SKU. Deleting a SKU is only possible until it has been used in an order.

*/ readonly DeleteSkusId: { readonly parameters: { readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["deleted_sku"]; - }; - }; + readonly 'application/json': components['schemas']['deleted_sku'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Creates a new source object.

*/ readonly PostSources: { readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["source"]; - }; - }; + readonly 'application/json': components['schemas']['source'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources. Not supported for `receiver` type sources, where charge amount may not be specified until funds land. */ - readonly amount?: number; + readonly amount?: number /** @description 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. */ - readonly currency?: string; + readonly currency?: string /** @description The `Customer` to whom the original source is attached to. Must be set when the original source is not a `Source` (e.g., `Card`). */ - readonly customer?: string; + readonly customer?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** * @description The authentication `flow` of the source to create. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`. It is generally inferred unless a type supports multiple flows. * @enum {string} */ - readonly flow?: "code_verification" | "none" | "receiver" | "redirect"; + readonly flow?: 'code_verification' | 'none' | 'receiver' | 'redirect' /** * mandate_params * @description Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status. @@ -40081,35 +39841,35 @@ export interface operations { /** mandate_acceptance_params */ readonly acceptance?: { /** Format: unix-time */ - readonly date?: number; - readonly ip?: string; + readonly date?: number + readonly ip?: string /** mandate_offline_acceptance_params */ readonly offline?: { - readonly contact_email: string; - }; + readonly contact_email: string + } /** mandate_online_acceptance_params */ readonly online?: { /** Format: unix-time */ - readonly date?: number; - readonly ip?: string; - readonly user_agent?: string; - }; + readonly date?: number + readonly ip?: string + readonly user_agent?: string + } /** @enum {string} */ - readonly status: "accepted" | "pending" | "refused" | "revoked"; + readonly status: 'accepted' | 'pending' | 'refused' | 'revoked' /** @enum {string} */ - readonly type?: "offline" | "online"; - readonly user_agent?: string; - }; - readonly amount?: Partial & Partial<"">; - readonly currency?: string; + readonly type?: 'offline' | 'online' + readonly user_agent?: string + } + readonly amount?: Partial & Partial<''> + readonly currency?: string /** @enum {string} */ - readonly interval?: "one_time" | "scheduled" | "variable"; + readonly interval?: 'one_time' | 'scheduled' | 'variable' /** @enum {string} */ - readonly notification_method?: "deprecated_none" | "email" | "manual" | "none" | "stripe_email"; - }; - readonly metadata?: { readonly [key: string]: string }; + readonly notification_method?: 'deprecated_none' | 'email' | 'manual' | 'none' | 'stripe_email' + } + readonly metadata?: { readonly [key: string]: string } /** @description The source to share. */ - readonly original_source?: string; + readonly original_source?: string /** * owner * @description Information about the owner of the payment instrument that may be used or required by particular source types. @@ -40117,108 +39877,108 @@ export interface operations { readonly owner?: { /** source_address */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; - readonly email?: string; - readonly name?: string; - readonly phone?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } + readonly email?: string + readonly name?: string + readonly phone?: string + } /** * receiver_params * @description Optional parameters for the receiver flow. Can be set only if the source is a receiver (`flow` is `receiver`). */ readonly receiver?: { /** @enum {string} */ - readonly refund_attributes_method?: "email" | "manual" | "none"; - }; + readonly refund_attributes_method?: 'email' | 'manual' | 'none' + } /** * redirect_params * @description Parameters required for the redirect flow. Required if the source is authenticated by a redirect (`flow` is `redirect`). */ readonly redirect?: { - readonly return_url: string; - }; + readonly return_url: string + } /** * shallow_order_specs * @description Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it. */ readonly source_order?: { readonly items?: readonly { - readonly amount?: number; - readonly currency?: string; - readonly description?: string; - readonly parent?: string; - readonly quantity?: number; + readonly amount?: number + readonly currency?: string + readonly description?: string + readonly parent?: string + readonly quantity?: number /** @enum {string} */ - readonly type?: "discount" | "shipping" | "sku" | "tax"; - }[]; + readonly type?: 'discount' | 'shipping' | 'sku' | 'tax' + }[] /** order_shipping */ readonly shipping?: { /** address */ readonly address: { - readonly city?: string; - readonly country?: string; - readonly line1: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; - readonly carrier?: string; - readonly name?: string; - readonly phone?: string; - readonly tracking_number?: string; - }; - }; + readonly city?: string + readonly country?: string + readonly line1: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } + readonly carrier?: string + readonly name?: string + readonly phone?: string + readonly tracking_number?: string + } + } /** @description An arbitrary string to be displayed on your customer's statement. As an example, if your website is `RunClub` and the item you're charging for is a race ticket, you may want to specify a `statement_descriptor` of `RunClub 5K race ticket.` While many payment types will display this information, some may not display it at all. */ - readonly statement_descriptor?: string; + readonly statement_descriptor?: string /** @description An optional token used to create the source. When passed, token properties will override source parameters. */ - readonly token?: string; + readonly token?: string /** @description The `type` of the source to create. Required unless `customer` and `original_source` are specified (see the [Cloning card Sources](https://stripe.com/docs/sources/connect#cloning-card-sources) guide) */ - readonly type?: string; + readonly type?: string /** @enum {string} */ - readonly usage?: "reusable" | "single_use"; - }; - }; - }; - }; + readonly usage?: 'reusable' | 'single_use' + } + } + } + } /**

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.

*/ readonly GetSourcesSource: { readonly parameters: { readonly query: { /** The client secret of the source. Required if a publishable key is used to retrieve the source. */ - readonly client_secret?: string; + readonly client_secret?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly source: string; - }; - }; + readonly source: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["source"]; - }; - }; + readonly 'application/json': components['schemas']['source'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /** *

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

* @@ -40227,30 +39987,30 @@ export interface operations { readonly PostSourcesSource: { readonly parameters: { readonly path: { - readonly source: string; - }; - }; + readonly source: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["source"]; - }; - }; + readonly 'application/json': components['schemas']['source'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Amount associated with the source. */ - readonly amount?: number; + readonly amount?: number /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** * mandate_params * @description Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status. @@ -40259,34 +40019,34 @@ export interface operations { /** mandate_acceptance_params */ readonly acceptance?: { /** Format: unix-time */ - readonly date?: number; - readonly ip?: string; + readonly date?: number + readonly ip?: string /** mandate_offline_acceptance_params */ readonly offline?: { - readonly contact_email: string; - }; + readonly contact_email: string + } /** mandate_online_acceptance_params */ readonly online?: { /** Format: unix-time */ - readonly date?: number; - readonly ip?: string; - readonly user_agent?: string; - }; + readonly date?: number + readonly ip?: string + readonly user_agent?: string + } /** @enum {string} */ - readonly status: "accepted" | "pending" | "refused" | "revoked"; + readonly status: 'accepted' | 'pending' | 'refused' | 'revoked' /** @enum {string} */ - readonly type?: "offline" | "online"; - readonly user_agent?: string; - }; - readonly amount?: Partial & Partial<"">; - readonly currency?: string; + readonly type?: 'offline' | 'online' + readonly user_agent?: string + } + readonly amount?: Partial & Partial<''> + readonly currency?: string /** @enum {string} */ - readonly interval?: "one_time" | "scheduled" | "variable"; + readonly interval?: 'one_time' | 'scheduled' | 'variable' /** @enum {string} */ - readonly notification_method?: "deprecated_none" | "email" | "manual" | "none" | "stripe_email"; - }; + readonly notification_method?: 'deprecated_none' | 'email' | 'manual' | 'none' | 'stripe_email' + } /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** * owner * @description Information about the owner of the payment instrument that may be used or required by particular source types. @@ -40294,271 +40054,271 @@ export interface operations { readonly owner?: { /** source_address */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; - readonly email?: string; - readonly name?: string; - readonly phone?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } + readonly email?: string + readonly name?: string + readonly phone?: string + } /** * order_params * @description Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it. */ readonly source_order?: { readonly items?: readonly { - readonly amount?: number; - readonly currency?: string; - readonly description?: string; - readonly parent?: string; - readonly quantity?: number; + readonly amount?: number + readonly currency?: string + readonly description?: string + readonly parent?: string + readonly quantity?: number /** @enum {string} */ - readonly type?: "discount" | "shipping" | "sku" | "tax"; - }[]; + readonly type?: 'discount' | 'shipping' | 'sku' | 'tax' + }[] /** order_shipping */ readonly shipping?: { /** address */ readonly address: { - readonly city?: string; - readonly country?: string; - readonly line1: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; - readonly carrier?: string; - readonly name?: string; - readonly phone?: string; - readonly tracking_number?: string; - }; - }; - }; - }; - }; - }; + readonly city?: string + readonly country?: string + readonly line1: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } + readonly carrier?: string + readonly name?: string + readonly phone?: string + readonly tracking_number?: string + } + } + } + } + } + } /**

Retrieves a new Source MandateNotification.

*/ readonly GetSourcesSourceMandateNotificationsMandateNotification: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly mandate_notification: string; - readonly source: string; - }; - }; + readonly mandate_notification: string + readonly source: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["source_mandate_notification"]; - }; - }; + readonly 'application/json': components['schemas']['source_mandate_notification'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

List source transactions for a given source.

*/ readonly GetSourcesSourceSourceTransactions: { readonly parameters: { readonly query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; + readonly starting_after?: string + } readonly path: { - readonly source: string; - }; - }; + readonly source: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["source_transaction"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['source_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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.

*/ readonly GetSourcesSourceSourceTransactionsSourceTransaction: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly source: string; - readonly source_transaction: string; - }; - }; + readonly source: string + readonly source_transaction: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["source_transaction"]; - }; - }; + readonly 'application/json': components['schemas']['source_transaction'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Verify a given source.

*/ readonly PostSourcesSourceVerify: { readonly parameters: { readonly path: { - readonly source: string; - }; - }; + readonly source: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["source"]; - }; - }; + readonly 'application/json': components['schemas']['source'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The values needed to verify the source. */ - readonly values: readonly string[]; - }; - }; - }; - }; + readonly values: readonly string[] + } + } + } + } /**

Returns a list of your subscription items for a given subscription.

*/ readonly GetSubscriptionItems: { readonly parameters: { readonly query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** The ID of the subscription whose items will be retrieved. */ - readonly subscription: string; - }; - }; + readonly subscription: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["subscription_item"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['subscription_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Adds a new item to an existing subscription. No existing items will be changed or replaced.

*/ readonly PostSubscriptionItems: { readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["subscription_item"]; - }; - }; + readonly 'application/json': components['schemas']['subscription_item'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. */ readonly billing_thresholds?: Partial<{ - readonly usage_gte: number; + readonly usage_gte: number }> & - Partial<"">; + Partial<''> /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: { readonly [key: string]: string }; + readonly metadata?: { readonly [key: string]: string } /** * @description Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * @@ -40569,32 +40329,28 @@ export interface operations { * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. * @enum {string} */ - readonly payment_behavior?: - | "allow_incomplete" - | "default_incomplete" - | "error_if_incomplete" - | "pending_if_incomplete"; + readonly payment_behavior?: 'allow_incomplete' | 'default_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete' /** @description The ID of the price object. */ - readonly price?: string; + readonly price?: string /** * recurring_price_data * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. */ readonly price_data?: { - readonly currency: string; - readonly product: string; + readonly currency: string + readonly product: string /** recurring_adhoc */ readonly recurring: { /** @enum {string} */ - readonly interval: "day" | "month" | "week" | "year"; - readonly interval_count?: number; - }; + readonly interval: 'day' | 'month' | 'week' | 'year' + readonly interval_count?: number + } /** @enum {string} */ - readonly tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - readonly unit_amount?: number; + readonly tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + readonly unit_amount?: number /** Format: decimal */ - readonly unit_amount_decimal?: string; - }; + readonly unit_amount_decimal?: string + } /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -40603,88 +40359,88 @@ export interface operations { * Prorations can be disabled by passing `none`. * @enum {string} */ - readonly proration_behavior?: "always_invoice" | "create_prorations" | "none"; + readonly proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** * Format: unix-time * @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. */ - readonly proration_date?: number; + readonly proration_date?: number /** @description The quantity you'd like to apply to the subscription item you're creating. */ - readonly quantity?: number; + readonly quantity?: number /** @description The identifier of the subscription to modify. */ - readonly subscription: string; + readonly subscription: string /** @description A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. */ - readonly tax_rates?: Partial & Partial<"">; - }; - }; - }; - }; + readonly tax_rates?: Partial & Partial<''> + } + } + } + } /**

Retrieves the subscription item with the given ID.

*/ readonly GetSubscriptionItemsItem: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly item: string; - }; - }; + readonly item: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["subscription_item"]; - }; - }; + readonly 'application/json': components['schemas']['subscription_item'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Updates the plan or quantity of an item on a current subscription.

*/ readonly PostSubscriptionItemsItem: { readonly parameters: { readonly path: { - readonly item: string; - }; - }; + readonly item: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["subscription_item"]; - }; - }; + readonly 'application/json': components['schemas']['subscription_item'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. */ readonly billing_thresholds?: Partial<{ - readonly usage_gte: number; + readonly usage_gte: number }> & - Partial<"">; + Partial<''> /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. */ - readonly off_session?: boolean; + readonly off_session?: boolean /** * @description Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * @@ -40695,32 +40451,28 @@ export interface operations { * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. * @enum {string} */ - readonly payment_behavior?: - | "allow_incomplete" - | "default_incomplete" - | "error_if_incomplete" - | "pending_if_incomplete"; + readonly payment_behavior?: 'allow_incomplete' | 'default_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete' /** @description The ID of the price object. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided. */ - readonly price?: string; + readonly price?: string /** * recurring_price_data * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. */ readonly price_data?: { - readonly currency: string; - readonly product: string; + readonly currency: string + readonly product: string /** recurring_adhoc */ readonly recurring: { /** @enum {string} */ - readonly interval: "day" | "month" | "week" | "year"; - readonly interval_count?: number; - }; + readonly interval: 'day' | 'month' | 'week' | 'year' + readonly interval_count?: number + } /** @enum {string} */ - readonly tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - readonly unit_amount?: number; + readonly tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + readonly unit_amount?: number /** Format: decimal */ - readonly unit_amount_decimal?: string; - }; + readonly unit_amount_decimal?: string + } /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -40729,46 +40481,46 @@ export interface operations { * Prorations can be disabled by passing `none`. * @enum {string} */ - readonly proration_behavior?: "always_invoice" | "create_prorations" | "none"; + readonly proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** * Format: unix-time * @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. */ - readonly proration_date?: number; + readonly proration_date?: number /** @description The quantity you'd like to apply to the subscription item you're creating. */ - readonly quantity?: number; + readonly quantity?: number /** @description A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. */ - readonly tax_rates?: Partial & Partial<"">; - }; - }; - }; - }; + readonly tax_rates?: Partial & Partial<''> + } + } + } + } /**

Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.

*/ readonly DeleteSubscriptionItemsItem: { readonly parameters: { readonly path: { - readonly item: string; - }; - }; + readonly item: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["deleted_subscription_item"]; - }; - }; + readonly 'application/json': components['schemas']['deleted_subscription_item'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Delete all usage for the given subscription item. Allowed only when the current plan's `usage_type` is `metered`. */ - readonly clear_usage?: boolean; + readonly clear_usage?: boolean /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -40777,16 +40529,16 @@ export interface operations { * Prorations can be disabled by passing `none`. * @enum {string} */ - readonly proration_behavior?: "always_invoice" | "create_prorations" | "none"; + readonly proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** * Format: unix-time * @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. */ - readonly proration_date?: number; - }; - }; - }; - }; + readonly proration_date?: number + } + } + } + } /** *

For the specified subscription item, returns a list of summary objects. Each object in the list provides usage information that’s been summarized from multiple usage records and over a subscription billing period (e.g., 15 usage records in the month of September).

* @@ -40796,49 +40548,49 @@ export interface operations { readonly parameters: { readonly query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; + readonly starting_after?: string + } readonly path: { - readonly subscription_item: string; - }; - }; + readonly subscription_item: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["usage_record_summary"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['usage_record_summary'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /** *

Creates a usage record for a specified subscription item and date, and fills it with a quantity.

* @@ -40851,712 +40603,703 @@ export interface operations { readonly PostSubscriptionItemsSubscriptionItemUsageRecords: { readonly parameters: { readonly path: { - readonly subscription_item: string; - }; - }; + readonly subscription_item: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["usage_record"]; - }; - }; + readonly 'application/json': components['schemas']['usage_record'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** * @description Valid values are `increment` (default) or `set`. When using `increment` the specified `quantity` will be added to the usage at the specified timestamp. The `set` action will overwrite the usage quantity at that timestamp. If the subscription has [billing thresholds](https://stripe.com/docs/api/subscriptions/object#subscription_object-billing_thresholds), `increment` is the only allowed value. * @enum {string} */ - readonly action?: "increment" | "set"; + readonly action?: 'increment' | 'set' /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The usage quantity for the specified timestamp. */ - readonly quantity: number; + readonly quantity: number /** @description The timestamp for the usage event. This timestamp must be within the current billing period of the subscription of the provided `subscription_item`, and must not be in the future. When passing `"now"`, Stripe records usage for the current time. Default is `"now"` if a value is not provided. */ - readonly timestamp?: Partial<"now"> & Partial; - }; - }; - }; - }; + readonly timestamp?: Partial<'now'> & Partial + } + } + } + } /**

Retrieves the list of your subscription schedules.

*/ readonly GetSubscriptionSchedules: { readonly parameters: { readonly query: { /** Only return subscription schedules that were created canceled the given date interval. */ readonly canceled_at?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** Only return subscription schedules that completed during the given date interval. */ readonly completed_at?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** Only return subscription schedules that were created during the given date interval. */ readonly created?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** Only return subscription schedules for the given customer. */ - readonly customer?: string; + readonly customer?: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** Only return subscription schedules that were released during the given date interval. */ readonly released_at?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** Only return subscription schedules that have not started yet. */ - readonly scheduled?: boolean; + readonly scheduled?: boolean /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["subscription_schedule"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['subscription_schedule'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.

*/ readonly PostSubscriptionSchedules: { readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["subscription_schedule"]; - }; - }; + readonly 'application/json': components['schemas']['subscription_schedule'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description The identifier of the customer to create the subscription schedule for. */ - readonly customer?: string; + readonly customer?: string /** * default_settings_params * @description Object representing the subscription schedule's default settings. */ readonly default_settings?: { - readonly application_fee_percent?: number; + readonly application_fee_percent?: number /** automatic_tax_config */ readonly automatic_tax?: { - readonly enabled: boolean; - }; + readonly enabled: boolean + } /** @enum {string} */ - readonly billing_cycle_anchor?: "automatic" | "phase_start"; + readonly billing_cycle_anchor?: 'automatic' | 'phase_start' readonly billing_thresholds?: Partial<{ - readonly amount_gte?: number; - readonly reset_billing_cycle_anchor?: boolean; + readonly amount_gte?: number + readonly reset_billing_cycle_anchor?: boolean }> & - Partial<"">; + Partial<''> /** @enum {string} */ - readonly collection_method?: "charge_automatically" | "send_invoice"; - readonly default_payment_method?: string; + readonly collection_method?: 'charge_automatically' | 'send_invoice' + readonly default_payment_method?: string /** subscription_schedules_param */ readonly invoice_settings?: { - readonly days_until_due?: number; - }; + readonly days_until_due?: number + } readonly transfer_data?: Partial<{ - readonly amount_percent?: number; - readonly destination: string; + readonly amount_percent?: number + readonly destination: string }> & - Partial<"">; - }; + Partial<''> + } /** * @description Configures how the subscription schedule behaves 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. * @enum {string} */ - readonly end_behavior?: "cancel" | "none" | "release" | "renew"; + readonly end_behavior?: 'cancel' | 'none' | 'release' | 'renew' /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls. */ - readonly from_subscription?: string; + readonly from_subscription?: string /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. */ readonly phases?: readonly { readonly add_invoice_items?: readonly { - readonly price?: string; + readonly price?: string /** one_time_price_data */ readonly price_data?: { - readonly currency: string; - readonly product: string; + readonly currency: string + readonly product: string /** @enum {string} */ - readonly tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - readonly unit_amount?: number; + readonly tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + readonly unit_amount?: number /** Format: decimal */ - readonly unit_amount_decimal?: string; - }; - readonly quantity?: number; - readonly tax_rates?: Partial & Partial<"">; - }[]; - readonly application_fee_percent?: number; + readonly unit_amount_decimal?: string + } + readonly quantity?: number + readonly tax_rates?: Partial & Partial<''> + }[] + readonly application_fee_percent?: number /** automatic_tax_config */ readonly automatic_tax?: { - readonly enabled: boolean; - }; + readonly enabled: boolean + } /** @enum {string} */ - readonly billing_cycle_anchor?: "automatic" | "phase_start"; + readonly billing_cycle_anchor?: 'automatic' | 'phase_start' readonly billing_thresholds?: Partial<{ - readonly amount_gte?: number; - readonly reset_billing_cycle_anchor?: boolean; + readonly amount_gte?: number + readonly reset_billing_cycle_anchor?: boolean }> & - Partial<"">; + Partial<''> /** @enum {string} */ - readonly collection_method?: "charge_automatically" | "send_invoice"; - readonly coupon?: string; - readonly default_payment_method?: string; - readonly default_tax_rates?: Partial & Partial<"">; + readonly collection_method?: 'charge_automatically' | 'send_invoice' + readonly coupon?: string + readonly default_payment_method?: string + readonly default_tax_rates?: Partial & Partial<''> /** Format: unix-time */ - readonly end_date?: number; + readonly end_date?: number /** subscription_schedules_param */ readonly invoice_settings?: { - readonly days_until_due?: number; - }; + readonly days_until_due?: number + } readonly items: readonly { readonly billing_thresholds?: Partial<{ - readonly usage_gte: number; + readonly usage_gte: number }> & - Partial<"">; - readonly price?: string; + Partial<''> + readonly price?: string /** recurring_price_data */ readonly price_data?: { - readonly currency: string; - readonly product: string; + readonly currency: string + readonly product: string /** recurring_adhoc */ readonly recurring: { /** @enum {string} */ - readonly interval: "day" | "month" | "week" | "year"; - readonly interval_count?: number; - }; + readonly interval: 'day' | 'month' | 'week' | 'year' + readonly interval_count?: number + } /** @enum {string} */ - readonly tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - readonly unit_amount?: number; + readonly tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + readonly unit_amount?: number /** Format: decimal */ - readonly unit_amount_decimal?: string; - }; - readonly quantity?: number; - readonly tax_rates?: Partial & Partial<"">; - }[]; - readonly iterations?: number; + readonly unit_amount_decimal?: string + } + readonly quantity?: number + readonly tax_rates?: Partial & Partial<''> + }[] + readonly iterations?: number /** @enum {string} */ - readonly proration_behavior?: "always_invoice" | "create_prorations" | "none"; + readonly proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** transfer_data_specs */ readonly transfer_data?: { - readonly amount_percent?: number; - readonly destination: string; - }; - readonly trial?: boolean; + readonly amount_percent?: number + readonly destination: string + } + readonly trial?: boolean /** Format: unix-time */ - readonly trial_end?: number; - }[]; + readonly trial_end?: number + }[] /** @description When the subscription schedule starts. We recommend using `now` so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on. */ - readonly start_date?: Partial & Partial<"now">; - }; - }; - }; - }; + readonly start_date?: Partial & Partial<'now'> + } + } + } + } /**

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.

*/ readonly GetSubscriptionSchedulesSchedule: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly schedule: string; - }; - }; + readonly schedule: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["subscription_schedule"]; - }; - }; + readonly 'application/json': components['schemas']['subscription_schedule'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Updates an existing subscription schedule.

*/ readonly PostSubscriptionSchedulesSchedule: { readonly parameters: { readonly path: { - readonly schedule: string; - }; - }; + readonly schedule: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["subscription_schedule"]; - }; - }; + readonly 'application/json': components['schemas']['subscription_schedule'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** * default_settings_params * @description Object representing the subscription schedule's default settings. */ readonly default_settings?: { - readonly application_fee_percent?: number; + readonly application_fee_percent?: number /** automatic_tax_config */ readonly automatic_tax?: { - readonly enabled: boolean; - }; + readonly enabled: boolean + } /** @enum {string} */ - readonly billing_cycle_anchor?: "automatic" | "phase_start"; + readonly billing_cycle_anchor?: 'automatic' | 'phase_start' readonly billing_thresholds?: Partial<{ - readonly amount_gte?: number; - readonly reset_billing_cycle_anchor?: boolean; + readonly amount_gte?: number + readonly reset_billing_cycle_anchor?: boolean }> & - Partial<"">; + Partial<''> /** @enum {string} */ - readonly collection_method?: "charge_automatically" | "send_invoice"; - readonly default_payment_method?: string; + readonly collection_method?: 'charge_automatically' | 'send_invoice' + readonly default_payment_method?: string /** subscription_schedules_param */ readonly invoice_settings?: { - readonly days_until_due?: number; - }; + readonly days_until_due?: number + } readonly transfer_data?: Partial<{ - readonly amount_percent?: number; - readonly destination: string; + readonly amount_percent?: number + readonly destination: string }> & - Partial<"">; - }; + Partial<''> + } /** * @description Configures how the subscription schedule behaves 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. * @enum {string} */ - readonly end_behavior?: "cancel" | "none" | "release" | "renew"; + readonly end_behavior?: 'cancel' | 'none' | 'release' | 'renew' /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. Note that past phases can be omitted. */ readonly phases?: readonly { readonly add_invoice_items?: readonly { - readonly price?: string; + readonly price?: string /** one_time_price_data */ readonly price_data?: { - readonly currency: string; - readonly product: string; + readonly currency: string + readonly product: string /** @enum {string} */ - readonly tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - readonly unit_amount?: number; + readonly tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + readonly unit_amount?: number /** Format: decimal */ - readonly unit_amount_decimal?: string; - }; - readonly quantity?: number; - readonly tax_rates?: Partial & Partial<"">; - }[]; - readonly application_fee_percent?: number; + readonly unit_amount_decimal?: string + } + readonly quantity?: number + readonly tax_rates?: Partial & Partial<''> + }[] + readonly application_fee_percent?: number /** automatic_tax_config */ readonly automatic_tax?: { - readonly enabled: boolean; - }; + readonly enabled: boolean + } /** @enum {string} */ - readonly billing_cycle_anchor?: "automatic" | "phase_start"; + readonly billing_cycle_anchor?: 'automatic' | 'phase_start' readonly billing_thresholds?: Partial<{ - readonly amount_gte?: number; - readonly reset_billing_cycle_anchor?: boolean; + readonly amount_gte?: number + readonly reset_billing_cycle_anchor?: boolean }> & - Partial<"">; + Partial<''> /** @enum {string} */ - readonly collection_method?: "charge_automatically" | "send_invoice"; - readonly coupon?: string; - readonly default_payment_method?: string; - readonly default_tax_rates?: Partial & Partial<"">; - readonly end_date?: Partial & Partial<"now">; + readonly collection_method?: 'charge_automatically' | 'send_invoice' + readonly coupon?: string + readonly default_payment_method?: string + readonly default_tax_rates?: Partial & Partial<''> + readonly end_date?: Partial & Partial<'now'> /** subscription_schedules_param */ readonly invoice_settings?: { - readonly days_until_due?: number; - }; + readonly days_until_due?: number + } readonly items: readonly { readonly billing_thresholds?: Partial<{ - readonly usage_gte: number; + readonly usage_gte: number }> & - Partial<"">; - readonly price?: string; + Partial<''> + readonly price?: string /** recurring_price_data */ readonly price_data?: { - readonly currency: string; - readonly product: string; + readonly currency: string + readonly product: string /** recurring_adhoc */ readonly recurring: { /** @enum {string} */ - readonly interval: "day" | "month" | "week" | "year"; - readonly interval_count?: number; - }; + readonly interval: 'day' | 'month' | 'week' | 'year' + readonly interval_count?: number + } /** @enum {string} */ - readonly tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - readonly unit_amount?: number; + readonly tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + readonly unit_amount?: number /** Format: decimal */ - readonly unit_amount_decimal?: string; - }; - readonly quantity?: number; - readonly tax_rates?: Partial & Partial<"">; - }[]; - readonly iterations?: number; + readonly unit_amount_decimal?: string + } + readonly quantity?: number + readonly tax_rates?: Partial & Partial<''> + }[] + readonly iterations?: number /** @enum {string} */ - readonly proration_behavior?: "always_invoice" | "create_prorations" | "none"; - readonly start_date?: Partial & Partial<"now">; + readonly proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' + readonly start_date?: Partial & Partial<'now'> /** transfer_data_specs */ readonly transfer_data?: { - readonly amount_percent?: number; - readonly destination: string; - }; - readonly trial?: boolean; - readonly trial_end?: Partial & Partial<"now">; - }[]; + readonly amount_percent?: number + readonly destination: string + } + readonly trial?: boolean + readonly trial_end?: Partial & Partial<'now'> + }[] /** * @description If the update changes the current phase, indicates if the changes should be prorated. Possible values are `create_prorations` or `none`, and the default value is `create_prorations`. * @enum {string} */ - readonly proration_behavior?: "always_invoice" | "create_prorations" | "none"; - }; - }; - }; - }; + readonly proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' + } + } + } + } /**

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.

*/ readonly PostSubscriptionSchedulesScheduleCancel: { readonly parameters: { readonly path: { - readonly schedule: string; - }; - }; + readonly schedule: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["subscription_schedule"]; - }; - }; + readonly 'application/json': components['schemas']['subscription_schedule'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Defaults to `true`. */ - readonly invoice_now?: boolean; + readonly invoice_now?: boolean /** @description If the subscription schedule is `active`, indicates if the cancellation should be prorated. Defaults to `true`. */ - readonly prorate?: boolean; - }; - }; - }; - }; + readonly prorate?: boolean + } + } + } + } /**

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.

*/ readonly PostSubscriptionSchedulesScheduleRelease: { readonly parameters: { readonly path: { - readonly schedule: string; - }; - }; + readonly schedule: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["subscription_schedule"]; - }; - }; + readonly 'application/json': components['schemas']['subscription_schedule'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description Keep any cancellation on the subscription that the schedule has set */ - readonly preserve_cancel_date?: boolean; - }; - }; - }; - }; + readonly preserve_cancel_date?: boolean + } + } + } + } /**

By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.

*/ readonly GetSubscriptions: { readonly parameters: { readonly query: { /** The collection method of the subscriptions to retrieve. Either `charge_automatically` or `send_invoice`. */ - readonly collection_method?: "charge_automatically" | "send_invoice"; + readonly collection_method?: 'charge_automatically' | 'send_invoice' readonly created?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial readonly current_period_end?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial readonly current_period_start?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** The ID of the customer whose subscriptions will be retrieved. */ - readonly customer?: string; + readonly customer?: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** Filter for subscriptions that contain this recurring price ID. */ - readonly price?: string; + readonly price?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** 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. */ - readonly status?: - | "active" - | "all" - | "canceled" - | "ended" - | "incomplete" - | "incomplete_expired" - | "past_due" - | "trialing" - | "unpaid"; - }; - }; + readonly status?: 'active' | 'all' | 'canceled' | 'ended' | 'incomplete' | 'incomplete_expired' | 'past_due' | 'trialing' | 'unpaid' + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["subscription"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['subscription'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.

*/ readonly PostSubscriptions: { readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["subscription"]; - }; - }; + readonly 'application/json': components['schemas']['subscription'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description A list of prices and quantities that will generate invoice items appended to the first invoice for this subscription. You may pass up to 20 items. */ readonly add_invoice_items?: readonly { - readonly price?: string; + readonly price?: string /** one_time_price_data */ readonly price_data?: { - readonly currency: string; - readonly product: string; + readonly currency: string + readonly product: string /** @enum {string} */ - readonly tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - readonly unit_amount?: number; + readonly tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + readonly unit_amount?: number /** Format: decimal */ - readonly unit_amount_decimal?: string; - }; - readonly quantity?: number; - readonly tax_rates?: Partial & Partial<"">; - }[]; + readonly unit_amount_decimal?: string + } + readonly quantity?: number + readonly tax_rates?: Partial & Partial<''> + }[] /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). */ - readonly application_fee_percent?: number; + readonly application_fee_percent?: number /** * automatic_tax_config * @description Automatic tax settings for this subscription. */ readonly automatic_tax?: { - readonly enabled: boolean; - }; + readonly enabled: boolean + } /** * Format: unix-time * @description For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor. */ - readonly backdate_start_date?: number; + readonly backdate_start_date?: number /** * Format: unix-time * @description 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. */ - readonly billing_cycle_anchor?: number; + readonly billing_cycle_anchor?: number /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. */ readonly billing_thresholds?: Partial<{ - readonly amount_gte?: number; - readonly reset_billing_cycle_anchor?: boolean; + readonly amount_gte?: number + readonly reset_billing_cycle_anchor?: boolean }> & - Partial<"">; + Partial<''> /** * Format: unix-time * @description 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. */ - readonly cancel_at?: number; + readonly cancel_at?: number /** @description Boolean indicating whether this subscription should cancel at the end of the current period. */ - readonly cancel_at_period_end?: boolean; + readonly cancel_at_period_end?: boolean /** * @description 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. Defaults to `charge_automatically`. * @enum {string} */ - readonly collection_method?: "charge_automatically" | "send_invoice"; + readonly collection_method?: 'charge_automatically' | 'send_invoice' /** @description The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. */ - readonly coupon?: string; + readonly coupon?: string /** @description The identifier of the customer to subscribe. */ - readonly customer: string; + readonly customer: string /** @description Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. */ - readonly days_until_due?: number; + readonly days_until_due?: number /** @description 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). */ - readonly default_payment_method?: string; + readonly default_payment_method?: string /** @description 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). */ - readonly default_source?: string; + readonly default_source?: string /** @description 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. */ - readonly default_tax_rates?: Partial & Partial<"">; + readonly default_tax_rates?: Partial & Partial<''> /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description A list of up to 20 subscription items, each with an attached price. */ readonly items?: readonly { readonly billing_thresholds?: Partial<{ - readonly usage_gte: number; + readonly usage_gte: number }> & - Partial<"">; - readonly metadata?: { readonly [key: string]: string }; - readonly price?: string; + Partial<''> + readonly metadata?: { readonly [key: string]: string } + readonly price?: string /** recurring_price_data */ readonly price_data?: { - readonly currency: string; - readonly product: string; + readonly currency: string + readonly product: string /** recurring_adhoc */ readonly recurring: { /** @enum {string} */ - readonly interval: "day" | "month" | "week" | "year"; - readonly interval_count?: number; - }; + readonly interval: 'day' | 'month' | 'week' | 'year' + readonly interval_count?: number + } /** @enum {string} */ - readonly tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - readonly unit_amount?: number; + readonly tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + readonly unit_amount?: number /** Format: decimal */ - readonly unit_amount_decimal?: string; - }; - readonly quantity?: number; - readonly tax_rates?: Partial & Partial<"">; - }[]; + readonly unit_amount_decimal?: string + } + readonly quantity?: number + readonly tax_rates?: Partial & Partial<''> + }[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. */ - readonly off_session?: boolean; + readonly off_session?: boolean /** * @description Use `allow_incomplete` to create subscriptions with `status=incomplete` if the first invoice cannot be paid. Creating subscriptions with this status allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * @@ -41567,11 +41310,7 @@ export interface operations { * `pending_if_incomplete` is only used with updates and cannot be passed when creating a subscription. * @enum {string} */ - readonly payment_behavior?: - | "allow_incomplete" - | "default_incomplete" - | "error_if_incomplete" - | "pending_if_incomplete"; + readonly payment_behavior?: 'allow_incomplete' | 'default_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete' /** * payment_settings * @description Payment settings to pass to invoices created by the subscription. @@ -41583,239 +41322,239 @@ export interface operations { /** mandate_options_param */ readonly mandate_options?: { /** @enum {string} */ - readonly transaction_type?: "business" | "personal"; - }; + readonly transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - readonly verification_method?: "automatic" | "instant" | "microdeposits"; + readonly verification_method?: 'automatic' | 'instant' | 'microdeposits' }> & - Partial<"">; + Partial<''> readonly bancontact?: Partial<{ /** @enum {string} */ - readonly preferred_language?: "de" | "en" | "fr" | "nl"; + readonly preferred_language?: 'de' | 'en' | 'fr' | 'nl' }> & - Partial<"">; + Partial<''> readonly card?: Partial<{ /** mandate_options_param */ readonly mandate_options?: { - readonly amount?: number; + readonly amount?: number /** @enum {string} */ - readonly amount_type?: "fixed" | "maximum"; - readonly description?: string; - }; + readonly amount_type?: 'fixed' | 'maximum' + readonly description?: string + } /** @enum {string} */ - readonly request_three_d_secure?: "any" | "automatic"; + readonly request_three_d_secure?: 'any' | 'automatic' }> & - Partial<"">; - }; + Partial<''> + } readonly payment_method_types?: Partial< readonly ( - | "ach_credit_transfer" - | "ach_debit" - | "acss_debit" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "sepa_debit" - | "sofort" - | "wechat_pay" + | 'ach_credit_transfer' + | 'ach_debit' + | 'acss_debit' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' )[] > & - Partial<"">; - }; + Partial<''> + } /** @description 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. */ readonly pending_invoice_item_interval?: Partial<{ /** @enum {string} */ - readonly interval: "day" | "month" | "week" | "year"; - readonly interval_count?: number; + readonly interval: 'day' | 'month' | 'week' | 'year' + readonly interval_count?: number }> & - Partial<"">; + Partial<''> /** @description The API ID of a promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. */ - readonly promotion_code?: string; + readonly promotion_code?: string /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) resulting from the `billing_cycle_anchor`. Valid values are `create_prorations` or `none`. * * Passing `create_prorations` will cause proration invoice items to be created when applicable. Prorations can be disabled by passing `none`. If no value is passed, the default is `create_prorations`. * @enum {string} */ - readonly proration_behavior?: "always_invoice" | "create_prorations" | "none"; + readonly proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** * transfer_data_specs * @description If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. */ readonly transfer_data?: { - readonly amount_percent?: number; - readonly destination: string; - }; + readonly amount_percent?: number + readonly destination: string + } /** @description Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. */ - readonly trial_end?: Partial<"now"> & Partial; + readonly trial_end?: Partial<'now'> & Partial /** @description 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. */ - readonly trial_from_plan?: boolean; + readonly trial_from_plan?: boolean /** @description Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. */ - readonly trial_period_days?: number; - }; - }; - }; - }; + readonly trial_period_days?: number + } + } + } + } /**

Retrieves the subscription with the given ID.

*/ readonly GetSubscriptionsSubscriptionExposedId: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly subscription_exposed_id: string; - }; - }; + readonly subscription_exposed_id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["subscription"]; - }; - }; + readonly 'application/json': components['schemas']['subscription'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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.

*/ readonly PostSubscriptionsSubscriptionExposedId: { readonly parameters: { readonly path: { - readonly subscription_exposed_id: string; - }; - }; + readonly subscription_exposed_id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["subscription"]; - }; - }; + readonly 'application/json': components['schemas']['subscription'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description A list of prices and quantities that will generate invoice items appended to the first invoice for this subscription. You may pass up to 20 items. */ readonly add_invoice_items?: readonly { - readonly price?: string; + readonly price?: string /** one_time_price_data */ readonly price_data?: { - readonly currency: string; - readonly product: string; + readonly currency: string + readonly product: string /** @enum {string} */ - readonly tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - readonly unit_amount?: number; + readonly tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + readonly unit_amount?: number /** Format: decimal */ - readonly unit_amount_decimal?: string; - }; - readonly quantity?: number; - readonly tax_rates?: Partial & Partial<"">; - }[]; + readonly unit_amount_decimal?: string + } + readonly quantity?: number + readonly tax_rates?: Partial & Partial<''> + }[] /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). */ - readonly application_fee_percent?: number; + readonly application_fee_percent?: number /** * automatic_tax_config * @description Automatic tax settings for this subscription. */ readonly automatic_tax?: { - readonly enabled: boolean; - }; + readonly enabled: boolean + } /** * @description Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). * @enum {string} */ - readonly billing_cycle_anchor?: "now" | "unchanged"; + readonly billing_cycle_anchor?: 'now' | 'unchanged' /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. */ readonly billing_thresholds?: Partial<{ - readonly amount_gte?: number; - readonly reset_billing_cycle_anchor?: boolean; + readonly amount_gte?: number + readonly reset_billing_cycle_anchor?: boolean }> & - Partial<"">; + Partial<''> /** @description 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. */ - readonly cancel_at?: Partial & Partial<"">; + readonly cancel_at?: Partial & Partial<''> /** @description Boolean indicating whether this subscription should cancel at the end of the current period. */ - readonly cancel_at_period_end?: boolean; + readonly cancel_at_period_end?: boolean /** * @description 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. Defaults to `charge_automatically`. * @enum {string} */ - readonly collection_method?: "charge_automatically" | "send_invoice"; + readonly collection_method?: 'charge_automatically' | 'send_invoice' /** @description The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. */ - readonly coupon?: string; + readonly coupon?: string /** @description Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. */ - readonly days_until_due?: number; + readonly days_until_due?: number /** @description 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). */ - readonly default_payment_method?: string; + readonly default_payment_method?: string /** @description 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). */ - readonly default_source?: string; + readonly default_source?: string /** @description 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. Pass an empty string to remove previously-defined tax rates. */ - readonly default_tax_rates?: Partial & Partial<"">; + readonly default_tax_rates?: Partial & Partial<''> /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description A list of up to 20 subscription items, each with an attached price. */ readonly items?: readonly { readonly billing_thresholds?: Partial<{ - readonly usage_gte: number; + readonly usage_gte: number }> & - Partial<"">; - readonly clear_usage?: boolean; - readonly deleted?: boolean; - readonly id?: string; - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; - readonly price?: string; + Partial<''> + readonly clear_usage?: boolean + readonly deleted?: boolean + readonly id?: string + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> + readonly price?: string /** recurring_price_data */ readonly price_data?: { - readonly currency: string; - readonly product: string; + readonly currency: string + readonly product: string /** recurring_adhoc */ readonly recurring: { /** @enum {string} */ - readonly interval: "day" | "month" | "week" | "year"; - readonly interval_count?: number; - }; + readonly interval: 'day' | 'month' | 'week' | 'year' + readonly interval_count?: number + } /** @enum {string} */ - readonly tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - readonly unit_amount?: number; + readonly tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + readonly unit_amount?: number /** Format: decimal */ - readonly unit_amount_decimal?: string; - }; - readonly quantity?: number; - readonly tax_rates?: Partial & Partial<"">; - }[]; + readonly unit_amount_decimal?: string + } + readonly quantity?: number + readonly tax_rates?: Partial & Partial<''> + }[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. */ - readonly off_session?: boolean; + readonly off_session?: boolean /** @description If specified, payment collection for this subscription will be paused. */ readonly pause_collection?: Partial<{ /** @enum {string} */ - readonly behavior: "keep_as_draft" | "mark_uncollectible" | "void"; + readonly behavior: 'keep_as_draft' | 'mark_uncollectible' | 'void' /** Format: unix-time */ - readonly resumes_at?: number; + readonly resumes_at?: number }> & - Partial<"">; + Partial<''> /** * @description Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * @@ -41826,11 +41565,7 @@ export interface operations { * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. * @enum {string} */ - readonly payment_behavior?: - | "allow_incomplete" - | "default_incomplete" - | "error_if_incomplete" - | "pending_if_incomplete"; + readonly payment_behavior?: 'allow_incomplete' | 'default_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete' /** * payment_settings * @description Payment settings to pass to invoices created by the subscription. @@ -41842,60 +41577,60 @@ export interface operations { /** mandate_options_param */ readonly mandate_options?: { /** @enum {string} */ - readonly transaction_type?: "business" | "personal"; - }; + readonly transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - readonly verification_method?: "automatic" | "instant" | "microdeposits"; + readonly verification_method?: 'automatic' | 'instant' | 'microdeposits' }> & - Partial<"">; + Partial<''> readonly bancontact?: Partial<{ /** @enum {string} */ - readonly preferred_language?: "de" | "en" | "fr" | "nl"; + readonly preferred_language?: 'de' | 'en' | 'fr' | 'nl' }> & - Partial<"">; + Partial<''> readonly card?: Partial<{ /** mandate_options_param */ readonly mandate_options?: { - readonly amount?: number; + readonly amount?: number /** @enum {string} */ - readonly amount_type?: "fixed" | "maximum"; - readonly description?: string; - }; + readonly amount_type?: 'fixed' | 'maximum' + readonly description?: string + } /** @enum {string} */ - readonly request_three_d_secure?: "any" | "automatic"; + readonly request_three_d_secure?: 'any' | 'automatic' }> & - Partial<"">; - }; + Partial<''> + } readonly payment_method_types?: Partial< readonly ( - | "ach_credit_transfer" - | "ach_debit" - | "acss_debit" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "sepa_debit" - | "sofort" - | "wechat_pay" + | 'ach_credit_transfer' + | 'ach_debit' + | 'acss_debit' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' )[] > & - Partial<"">; - }; + Partial<''> + } /** @description 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. */ readonly pending_invoice_item_interval?: Partial<{ /** @enum {string} */ - readonly interval: "day" | "month" | "week" | "year"; - readonly interval_count?: number; + readonly interval: 'day' | 'month' | 'week' | 'year' + readonly interval_count?: number }> & - Partial<"">; + Partial<''> /** @description The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. */ - readonly promotion_code?: string; + readonly promotion_code?: string /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -41904,26 +41639,26 @@ export interface operations { * Prorations can be disabled by passing `none`. * @enum {string} */ - readonly proration_behavior?: "always_invoice" | "create_prorations" | "none"; + readonly proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** * Format: unix-time * @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations. */ - readonly proration_date?: number; + readonly proration_date?: number /** @description If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. This will be unset if you POST an empty value. */ readonly transfer_data?: Partial<{ - readonly amount_percent?: number; - readonly destination: string; + readonly amount_percent?: number + readonly destination: string }> & - Partial<"">; + Partial<''> /** @description Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. */ - readonly trial_end?: Partial<"now"> & Partial; + readonly trial_end?: Partial<'now'> & Partial /** @description 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. */ - readonly trial_from_plan?: boolean; - }; - }; - }; - }; + readonly trial_from_plan?: boolean + } + } + } + } /** *

Cancels a customer’s subscription immediately. The customer will not be charged again for the subscription.

* @@ -41934,396 +41669,396 @@ export interface operations { readonly DeleteSubscriptionsSubscriptionExposedId: { readonly parameters: { readonly path: { - readonly subscription_exposed_id: string; - }; - }; + readonly subscription_exposed_id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["subscription"]; - }; - }; + readonly 'application/json': components['schemas']['subscription'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items. */ - readonly invoice_now?: boolean; + readonly invoice_now?: boolean /** @description Will generate a proration invoice item that credits remaining unused time until the subscription period end. */ - readonly prorate?: boolean; - }; - }; - }; - }; + readonly prorate?: boolean + } + } + } + } /**

Removes the currently applied discount on a subscription.

*/ readonly DeleteSubscriptionsSubscriptionExposedIdDiscount: { readonly parameters: { readonly path: { - readonly subscription_exposed_id: string; - }; - }; + readonly subscription_exposed_id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["deleted_discount"]; - }; - }; + readonly 'application/json': components['schemas']['deleted_discount'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

A list of all tax codes available to add to Products in order to allow specific tax calculations.

*/ readonly GetTaxCodes: { readonly parameters: { readonly query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["tax_code"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['tax_code'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Retrieves the details of an existing tax code. Supply the unique tax code ID and Stripe will return the corresponding tax code information.

*/ readonly GetTaxCodesId: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["tax_code"]; - }; - }; + readonly 'application/json': components['schemas']['tax_code'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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

*/ readonly GetTaxRates: { readonly parameters: { readonly query: { /** Optional flag to filter by tax rates that are either active or inactive (archived). */ - readonly active?: boolean; + readonly active?: boolean /** Optional range for filtering created date. */ readonly created?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** Optional flag to filter by tax rates that are inclusive (or those that are not inclusive). */ - readonly inclusive?: boolean; + readonly inclusive?: boolean /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["tax_rate"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['tax_rate'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Creates a new tax rate.

*/ readonly PostTaxRates: { readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["tax_rate"]; - }; - }; + readonly 'application/json': components['schemas']['tax_rate'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Flag determining whether the tax rate is active or inactive (archived). Inactive tax rates cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set. */ - readonly active?: boolean; + readonly active?: boolean /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ - readonly country?: string; + readonly country?: string /** @description An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. */ - readonly description?: string; + readonly description?: string /** @description The display name of the tax rate, which will be shown to users. */ - readonly display_name: string; + readonly display_name: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description This specifies if the tax rate is inclusive or exclusive. */ - readonly inclusive: boolean; + readonly inclusive: boolean /** @description The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice. */ - readonly jurisdiction?: string; + readonly jurisdiction?: string /** @description 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`. */ - readonly metadata?: { readonly [key: string]: string }; + readonly metadata?: { readonly [key: string]: string } /** @description This represents the tax rate percent out of 100. */ - readonly percentage: number; + readonly percentage: number /** @description [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States. */ - readonly state?: string; + readonly state?: string /** * @description The high-level tax type, such as `vat` or `sales_tax`. * @enum {string} */ - readonly tax_type?: "gst" | "hst" | "jct" | "pst" | "qst" | "rst" | "sales_tax" | "vat"; - }; - }; - }; - }; + readonly tax_type?: 'gst' | 'hst' | 'jct' | 'pst' | 'qst' | 'rst' | 'sales_tax' | 'vat' + } + } + } + } /**

Retrieves a tax rate with the given ID

*/ readonly GetTaxRatesTaxRate: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly tax_rate: string; - }; - }; + readonly tax_rate: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["tax_rate"]; - }; - }; + readonly 'application/json': components['schemas']['tax_rate'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Updates an existing tax rate.

*/ readonly PostTaxRatesTaxRate: { readonly parameters: { readonly path: { - readonly tax_rate: string; - }; - }; + readonly tax_rate: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["tax_rate"]; - }; - }; + readonly 'application/json': components['schemas']['tax_rate'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Flag determining whether the tax rate is active or inactive (archived). Inactive tax rates cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set. */ - readonly active?: boolean; + readonly active?: boolean /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ - readonly country?: string; + readonly country?: string /** @description An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. */ - readonly description?: string; + readonly description?: string /** @description The display name of the tax rate, which will be shown to users. */ - readonly display_name?: string; + readonly display_name?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice. */ - readonly jurisdiction?: string; + readonly jurisdiction?: string /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States. */ - readonly state?: string; + readonly state?: string /** * @description The high-level tax type, such as `vat` or `sales_tax`. * @enum {string} */ - readonly tax_type?: "gst" | "hst" | "jct" | "pst" | "qst" | "rst" | "sales_tax" | "vat"; - }; - }; - }; - }; + readonly tax_type?: 'gst' | 'hst' | 'jct' | 'pst' | 'qst' | 'rst' | 'sales_tax' | 'vat' + } + } + } + } /**

To connect to a reader the Stripe Terminal SDK needs to retrieve a short-lived connection token from Stripe, proxied through your server. On your backend, add an endpoint that creates and returns a connection token.

*/ readonly PostTerminalConnectionTokens: { readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["terminal.connection_token"]; - }; - }; + readonly 'application/json': components['schemas']['terminal.connection_token'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The id of the location that this connection token is scoped to. If specified the connection token will only be usable with readers assigned to that location, otherwise the connection token will be usable with all readers. Note that location scoping only applies to internet-connected readers. For more details, see [the docs on scoping connection tokens](https://stripe.com/docs/terminal/fleet/locations#connection-tokens). */ - readonly location?: string; - }; - }; - }; - }; + readonly location?: string + } + } + } + } /**

Returns a list of Location objects.

*/ readonly GetTerminalLocations: { readonly parameters: { readonly query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["terminal.location"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['terminal.location'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /** *

Creates a new Location object. * For further details, including which address fields are required in each country, see the Manage locations guide.

@@ -42333,324 +42068,322 @@ export interface operations { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["terminal.location"]; - }; - }; + readonly 'application/json': components['schemas']['terminal.location'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** * create_location_address_param * @description The full address of the location. */ readonly address: { - readonly city?: string; - readonly country: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; + readonly city?: string + readonly country: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } /** @description A name for the location. */ - readonly display_name: string; + readonly display_name: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> + } + } + } + } /**

Retrieves a Location object.

*/ readonly GetTerminalLocationsLocation: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly location: string; - }; - }; + readonly location: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["terminal.location"]; - }; - }; + readonly 'application/json': components['schemas']['terminal.location'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Updates a Location object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ readonly PostTerminalLocationsLocation: { readonly parameters: { readonly path: { - readonly location: string; - }; - }; + readonly location: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["terminal.location"]; - }; - }; + readonly 'application/json': components['schemas']['terminal.location'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** * optional_fields_address * @description The full address of the location. */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } /** @description A name for the location. */ - readonly display_name?: string; + readonly display_name?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> + } + } + } + } /**

Deletes a Location object.

*/ readonly DeleteTerminalLocationsLocation: { readonly parameters: { readonly path: { - readonly location: string; - }; - }; + readonly location: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["deleted_terminal.location"]; - }; - }; + readonly 'application/json': components['schemas']['deleted_terminal.location'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Returns a list of Reader objects.

*/ readonly GetTerminalReaders: { readonly parameters: { readonly query: { /** Filters readers by device type */ - readonly device_type?: "bbpos_chipper2x" | "bbpos_wisepos_e" | "verifone_P400"; + readonly device_type?: 'bbpos_chipper2x' | 'bbpos_wisepos_e' | 'verifone_P400' /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A location ID to filter the response list to only readers at the specific location */ - readonly location?: string; + readonly location?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** A status filter to filter readers to only offline or online readers */ - readonly status?: "offline" | "online"; - }; - }; + readonly status?: 'offline' | 'online' + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description A list of readers */ - readonly data: readonly components["schemas"]["terminal.reader"][]; + readonly data: readonly components['schemas']['terminal.reader'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Creates a new Reader object.

*/ readonly PostTerminalReaders: { readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["terminal.reader"]; - }; - }; + readonly 'application/json': components['schemas']['terminal.reader'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description Custom label given to the reader for easier identification. If no label is specified, the registration code will be used. */ - readonly label?: string; + readonly label?: string /** @description The location to assign the reader to. */ - readonly location?: string; + readonly location?: string /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description A code generated by the reader used for registering to an account. */ - readonly registration_code: string; - }; - }; - }; - }; + readonly registration_code: string + } + } + } + } /**

Retrieves a Reader object.

*/ readonly GetTerminalReadersReader: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly reader: string; - }; - }; + readonly reader: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": Partial & - Partial; - }; - }; + readonly 'application/json': Partial & Partial + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ readonly PostTerminalReadersReader: { readonly parameters: { readonly path: { - readonly reader: string; - }; - }; + readonly reader: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": Partial & - Partial; - }; - }; + readonly 'application/json': Partial & Partial + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description The new label of the reader. */ - readonly label?: string; + readonly label?: string /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> + } + } + } + } /**

Deletes a Reader object.

*/ readonly DeleteTerminalReadersReader: { readonly parameters: { readonly path: { - readonly reader: string; - }; - }; + readonly reader: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["deleted_terminal.reader"]; - }; - }; + readonly 'application/json': components['schemas']['deleted_terminal.reader'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /** *

Creates a single-use token that represents a bank account’s details. * This token can be used with any API method in place of a bank account dictionary. This token can be used only once, by attaching it to a Custom account.

@@ -42660,218 +42393,218 @@ export interface operations { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["token"]; - }; - }; + readonly 'application/json': components['schemas']['token'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** * connect_js_account_token_specs * @description Information for the account this token will represent. */ readonly account?: { /** @enum {string} */ - readonly business_type?: "company" | "government_entity" | "individual" | "non_profit"; + readonly business_type?: 'company' | 'government_entity' | 'individual' | 'non_profit' /** connect_js_account_token_company_specs */ readonly company?: { /** address_specs */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } /** japan_address_kana_specs */ readonly address_kana?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** japan_address_kanji_specs */ readonly address_kanji?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; - readonly directors_provided?: boolean; - readonly executives_provided?: boolean; - readonly name?: string; - readonly name_kana?: string; - readonly name_kanji?: string; - readonly owners_provided?: boolean; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } + readonly directors_provided?: boolean + readonly executives_provided?: boolean + readonly name?: string + readonly name_kana?: string + readonly name_kanji?: string + readonly owners_provided?: boolean /** company_ownership_declaration */ readonly ownership_declaration?: { /** Format: unix-time */ - readonly date?: number; - readonly ip?: string; - readonly user_agent?: string; - }; - readonly ownership_declaration_shown_and_signed?: boolean; - readonly phone?: string; - readonly registration_number?: string; + readonly date?: number + readonly ip?: string + readonly user_agent?: string + } + readonly ownership_declaration_shown_and_signed?: boolean + readonly phone?: string + readonly registration_number?: string /** @enum {string} */ readonly structure?: - | "" - | "free_zone_establishment" - | "free_zone_llc" - | "government_instrumentality" - | "governmental_unit" - | "incorporated_non_profit" - | "limited_liability_partnership" - | "llc" - | "multi_member_llc" - | "private_company" - | "private_corporation" - | "private_partnership" - | "public_company" - | "public_corporation" - | "public_partnership" - | "single_member_llc" - | "sole_establishment" - | "sole_proprietorship" - | "tax_exempt_government_instrumentality" - | "unincorporated_association" - | "unincorporated_non_profit"; - readonly tax_id?: string; - readonly tax_id_registrar?: string; - readonly vat_id?: string; + | '' + | 'free_zone_establishment' + | 'free_zone_llc' + | 'government_instrumentality' + | 'governmental_unit' + | 'incorporated_non_profit' + | 'limited_liability_partnership' + | 'llc' + | 'multi_member_llc' + | 'private_company' + | 'private_corporation' + | 'private_partnership' + | 'public_company' + | 'public_corporation' + | 'public_partnership' + | 'single_member_llc' + | 'sole_establishment' + | 'sole_proprietorship' + | 'tax_exempt_government_instrumentality' + | 'unincorporated_association' + | 'unincorporated_non_profit' + readonly tax_id?: string + readonly tax_id_registrar?: string + readonly vat_id?: string /** verification_specs */ readonly verification?: { /** verification_document_specs */ readonly document?: { - readonly back?: string; - readonly front?: string; - }; - }; - }; + readonly back?: string + readonly front?: string + } + } + } /** individual_specs */ readonly individual?: { /** address_specs */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } /** japan_address_kana_specs */ readonly address_kana?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** japan_address_kanji_specs */ readonly address_kanji?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } readonly dob?: Partial<{ - readonly day: number; - readonly month: number; - readonly year: number; + readonly day: number + readonly month: number + readonly year: number }> & - Partial<"">; - readonly email?: string; - readonly first_name?: string; - readonly first_name_kana?: string; - readonly first_name_kanji?: string; - readonly full_name_aliases?: Partial & Partial<"">; - readonly gender?: string; - readonly id_number?: string; - readonly last_name?: string; - readonly last_name_kana?: string; - readonly last_name_kanji?: string; - readonly maiden_name?: string; - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; - readonly phone?: string; + Partial<''> + readonly email?: string + readonly first_name?: string + readonly first_name_kana?: string + readonly first_name_kanji?: string + readonly full_name_aliases?: Partial & Partial<''> + readonly gender?: string + readonly id_number?: string + readonly last_name?: string + readonly last_name_kana?: string + readonly last_name_kanji?: string + readonly maiden_name?: string + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> + readonly phone?: string /** @enum {string} */ - readonly political_exposure?: "existing" | "none"; - readonly ssn_last_4?: string; + readonly political_exposure?: 'existing' | 'none' + readonly ssn_last_4?: string /** person_verification_specs */ readonly verification?: { /** person_verification_document_specs */ readonly additional_document?: { - readonly back?: string; - readonly front?: string; - }; + readonly back?: string + readonly front?: string + } /** person_verification_document_specs */ readonly document?: { - readonly back?: string; - readonly front?: string; - }; - }; - }; - readonly tos_shown_and_accepted?: boolean; - }; + readonly back?: string + readonly front?: string + } + } + } + readonly tos_shown_and_accepted?: boolean + } /** * token_create_bank_account * @description The bank account this token will represent. */ readonly bank_account?: { - readonly account_holder_name?: string; + readonly account_holder_name?: string /** @enum {string} */ - readonly account_holder_type?: "company" | "individual"; - readonly account_number: string; + readonly account_holder_type?: 'company' | 'individual' + readonly account_number: string /** @enum {string} */ - readonly account_type?: "checking" | "futsu" | "savings" | "toza"; - readonly country: string; - readonly currency?: string; - readonly routing_number?: string; - }; + readonly account_type?: 'checking' | 'futsu' | 'savings' | 'toza' + readonly country: string + readonly currency?: string + readonly routing_number?: string + } readonly card?: Partial<{ - readonly address_city?: string; - readonly address_country?: string; - readonly address_line1?: string; - readonly address_line2?: string; - readonly address_state?: string; - readonly address_zip?: string; - readonly currency?: string; - readonly cvc?: string; - readonly exp_month: string; - readonly exp_year: string; - readonly name?: string; - readonly number: string; + readonly address_city?: string + readonly address_country?: string + readonly address_line1?: string + readonly address_line2?: string + readonly address_state?: string + readonly address_zip?: string + readonly currency?: string + readonly cvc?: string + readonly exp_month: string + readonly exp_year: string + readonly name?: string + readonly number: string }> & - Partial; + Partial /** @description The customer (owned by the application's account) for which to create a token. This can be used only with an [OAuth access token](https://stripe.com/docs/connect/standard-accounts) or [Stripe-Account header](https://stripe.com/docs/connect/authentication). For more details, see [Cloning Saved Payment Methods](https://stripe.com/docs/connect/cloning-saved-payment-methods). */ - readonly customer?: string; + readonly customer?: string /** * cvc_params * @description The updated CVC value this token will represent. */ readonly cvc_update?: { - readonly cvc: string; - }; + readonly cvc: string + } /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** * person_token_specs * @description Information for the person this token will represent. @@ -42879,482 +42612,482 @@ export interface operations { readonly person?: { /** address_specs */ readonly address?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + } /** japan_address_kana_specs */ readonly address_kana?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } /** japan_address_kanji_specs */ readonly address_kanji?: { - readonly city?: string; - readonly country?: string; - readonly line1?: string; - readonly line2?: string; - readonly postal_code?: string; - readonly state?: string; - readonly town?: string; - }; + readonly city?: string + readonly country?: string + readonly line1?: string + readonly line2?: string + readonly postal_code?: string + readonly state?: string + readonly town?: string + } readonly dob?: Partial<{ - readonly day: number; - readonly month: number; - readonly year: number; + readonly day: number + readonly month: number + readonly year: number }> & - Partial<"">; + Partial<''> /** person_documents_specs */ readonly documents?: { /** documents_param */ readonly company_authorization?: { - readonly files?: readonly string[]; - }; + readonly files?: readonly string[] + } /** documents_param */ readonly passport?: { - readonly files?: readonly string[]; - }; + readonly files?: readonly string[] + } /** documents_param */ readonly visa?: { - readonly files?: readonly string[]; - }; - }; - readonly email?: string; - readonly first_name?: string; - readonly first_name_kana?: string; - readonly first_name_kanji?: string; - readonly full_name_aliases?: Partial & Partial<"">; - readonly gender?: string; - readonly id_number?: string; - readonly last_name?: string; - readonly last_name_kana?: string; - readonly last_name_kanji?: string; - readonly maiden_name?: string; - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; - readonly nationality?: string; - readonly phone?: string; - readonly political_exposure?: string; + readonly files?: readonly string[] + } + } + readonly email?: string + readonly first_name?: string + readonly first_name_kana?: string + readonly first_name_kanji?: string + readonly full_name_aliases?: Partial & Partial<''> + readonly gender?: string + readonly id_number?: string + readonly last_name?: string + readonly last_name_kana?: string + readonly last_name_kanji?: string + readonly maiden_name?: string + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> + readonly nationality?: string + readonly phone?: string + readonly political_exposure?: string /** relationship_specs */ readonly relationship?: { - readonly director?: boolean; - readonly executive?: boolean; - readonly owner?: boolean; - readonly percent_ownership?: Partial & Partial<"">; - readonly representative?: boolean; - readonly title?: string; - }; - readonly ssn_last_4?: string; + readonly director?: boolean + readonly executive?: boolean + readonly owner?: boolean + readonly percent_ownership?: Partial & Partial<''> + readonly representative?: boolean + readonly title?: string + } + readonly ssn_last_4?: string /** person_verification_specs */ readonly verification?: { /** person_verification_document_specs */ readonly additional_document?: { - readonly back?: string; - readonly front?: string; - }; + readonly back?: string + readonly front?: string + } /** person_verification_document_specs */ readonly document?: { - readonly back?: string; - readonly front?: string; - }; - }; - }; + readonly back?: string + readonly front?: string + } + } + } /** * pii_token_specs * @description The PII this token will represent. */ readonly pii?: { - readonly id_number?: string; - }; - }; - }; - }; - }; + readonly id_number?: string + } + } + } + } + } /**

Retrieves the token with the given ID.

*/ readonly GetTokensToken: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly token: string; - }; - }; + readonly token: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["token"]; - }; - }; + readonly 'application/json': components['schemas']['token'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Returns a list of top-ups.

*/ readonly GetTopups: { readonly parameters: { readonly query: { /** A positive integer representing how much to transfer. */ readonly amount?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** 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. */ readonly created?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** Only return top-ups that have the given status. One of `canceled`, `failed`, `pending` or `succeeded`. */ - readonly status?: "canceled" | "failed" | "pending" | "succeeded"; - }; - }; + readonly status?: 'canceled' | 'failed' | 'pending' | 'succeeded' + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["topup"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['topup'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Top up the balance of an account

*/ readonly PostTopups: { readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["topup"]; - }; - }; + readonly 'application/json': components['schemas']['topup'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description A positive integer representing how much to transfer. */ - readonly amount: number; + readonly amount: number /** @description 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). */ - readonly currency: string; + readonly currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string; + readonly description?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description The ID of a source to transfer funds from. For most users, this should be left unspecified which will use the bank account that was set up in the dashboard for the specified currency. In test mode, this can be a test bank token (see [Testing Top-ups](https://stripe.com/docs/connect/testing#testing-top-ups)). */ - readonly source?: string; + readonly source?: string /** @description Extra information about a top-up for the source's bank statement. Limited to 15 ASCII characters. */ - readonly statement_descriptor?: string; + readonly statement_descriptor?: string /** @description A string that identifies this top-up as part of a group. */ - readonly transfer_group?: string; - }; - }; - }; - }; + readonly transfer_group?: string + } + } + } + } /**

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.

*/ readonly GetTopupsTopup: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly topup: string; - }; - }; + readonly topup: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["topup"]; - }; - }; + readonly 'application/json': components['schemas']['topup'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Updates the metadata of a top-up. Other top-up details are not editable by design.

*/ readonly PostTopupsTopup: { readonly parameters: { readonly path: { - readonly topup: string; - }; - }; + readonly topup: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["topup"]; - }; - }; + readonly 'application/json': components['schemas']['topup'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string; + readonly description?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> + } + } + } + } /**

Cancels a top-up. Only pending top-ups can be canceled.

*/ readonly PostTopupsTopupCancel: { readonly parameters: { readonly path: { - readonly topup: string; - }; - }; + readonly topup: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["topup"]; - }; - }; + readonly 'application/json': components['schemas']['topup'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; - }; - }; - }; + readonly expand?: readonly string[] + } + } + } + } /**

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.

*/ readonly GetTransfers: { readonly parameters: { readonly query: { readonly created?: Partial<{ - readonly gt?: number; - readonly gte?: number; - readonly lt?: number; - readonly lte?: number; + readonly gt?: number + readonly gte?: number + readonly lt?: number + readonly lte?: number }> & - Partial; + Partial /** Only return transfers for the destination specified by this account ID. */ - readonly destination?: string; + readonly destination?: 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. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; + readonly starting_after?: string /** Only return transfers with the specified transfer group. */ - readonly transfer_group?: string; - }; - }; + readonly transfer_group?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Details about each object. */ - readonly data: readonly components["schemas"]["transfer"][]; + readonly data: readonly components['schemas']['transfer'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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.

*/ readonly PostTransfers: { readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["transfer"]; - }; - }; + readonly 'application/json': components['schemas']['transfer'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description A positive integer in %s representing how much to transfer. */ - readonly amount?: number; + readonly amount?: number /** @description 3-letter [ISO code for currency](https://stripe.com/docs/payouts). */ - readonly currency: string; + readonly currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string; + readonly description?: string /** @description The ID of a connected Stripe account. See the Connect documentation for details. */ - readonly destination: string; + readonly destination: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: { readonly [key: string]: string }; + readonly metadata?: { readonly [key: string]: string } /** @description You can use this parameter to transfer funds from a charge before they are added to your available balance. A pending balance will transfer immediately but the funds will not become available until the original charge becomes available. [See the Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-availability) for details. */ - readonly source_transaction?: string; + readonly source_transaction?: string /** * @description The source balance to use for this transfer. One of `bank_account`, `card`, or `fpx`. For most users, this will default to `card`. * @enum {string} */ - readonly source_type?: "bank_account" | "card" | "fpx"; + readonly source_type?: 'bank_account' | 'card' | 'fpx' /** @description A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-options) for details. */ - readonly transfer_group?: string; - }; - }; - }; - }; + readonly transfer_group?: string + } + } + } + } /**

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.

*/ readonly GetTransfersIdReversals: { readonly parameters: { readonly query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; + readonly starting_after?: string + } readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { + readonly 'application/json': { /** @description Details about each object. */ - readonly data: readonly components["schemas"]["transfer_reversal"][]; + readonly data: readonly components['schemas']['transfer_reversal'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /** *

When you create a new reversal, you must specify a transfer to create it on.

* @@ -43365,71 +43098,71 @@ export interface operations { readonly PostTransfersIdReversals: { readonly parameters: { readonly path: { - readonly id: string; - }; - }; + readonly id: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["transfer_reversal"]; - }; - }; + readonly 'application/json': components['schemas']['transfer_reversal'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description A positive integer in %s representing how much of this transfer to reverse. Can only reverse up to the unreversed amount remaining of the transfer. Partial transfer reversals are only allowed for transfers to Stripe Accounts. Defaults to the entire transfer amount. */ - readonly amount?: number; + readonly amount?: number /** @description An arbitrary string which you can attach to a reversal object. It is displayed alongside the reversal in the Dashboard. This will be unset if you POST an empty value. */ - readonly description?: string; + readonly description?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description Boolean indicating whether the application fee should be refunded when reversing this transfer. If a full transfer reversal is given, the full application fee will be refunded. Otherwise, the application fee will be refunded with an amount proportional to the amount of the transfer reversed. */ - readonly refund_application_fee?: boolean; - }; - }; - }; - }; + readonly refund_application_fee?: boolean + } + } + } + } /**

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.

*/ readonly GetTransfersTransfer: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly transfer: string; - }; - }; + readonly transfer: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["transfer"]; - }; - }; + readonly 'application/json': components['schemas']['transfer'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /** *

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

* @@ -43438,68 +43171,68 @@ export interface operations { readonly PostTransfersTransfer: { readonly parameters: { readonly path: { - readonly transfer: string; - }; - }; + readonly transfer: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["transfer"]; - }; - }; + readonly 'application/json': components['schemas']['transfer'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - readonly description?: string; + readonly description?: string /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> + } + } + } + } /**

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.

*/ readonly GetTransfersTransferReversalsId: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly id: string; - readonly transfer: string; - }; - }; + readonly id: string + readonly transfer: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["transfer_reversal"]; - }; - }; + readonly 'application/json': components['schemas']['transfer_reversal'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /** *

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

* @@ -43508,676 +43241,676 @@ export interface operations { readonly PostTransfersTransferReversalsId: { readonly parameters: { readonly path: { - readonly id: string; - readonly transfer: string; - }; - }; + readonly id: string + readonly transfer: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["transfer_reversal"]; - }; - }; + readonly 'application/json': components['schemas']['transfer_reversal'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> + } + } + } + } /**

Returns a list of your webhook endpoints.

*/ readonly GetWebhookEndpoints: { readonly parameters: { readonly query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - readonly ending_before?: string; + readonly ending_before?: string /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - readonly limit?: number; + readonly limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ - readonly starting_after?: string; - }; - }; + readonly starting_after?: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": { - readonly data: readonly components["schemas"]["webhook_endpoint"][]; + readonly 'application/json': { + readonly data: readonly components['schemas']['webhook_endpoint'][] /** @description True if this list has another page of items after this one that can be fetched. */ - readonly has_more: boolean; + readonly has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - readonly object: "list"; + readonly object: 'list' /** @description The URL where this list can be accessed. */ - readonly url: string; - }; - }; - }; + readonly url: string + } + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

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.

*/ readonly PostWebhookEndpoints: { readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["webhook_endpoint"]; - }; - }; + readonly 'application/json': components['schemas']['webhook_endpoint'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** * @description Events sent to this endpoint will be generated with this Stripe Version instead of your account's default Stripe Version. * @enum {string} */ readonly api_version?: - | "2011-01-01" - | "2011-06-21" - | "2011-06-28" - | "2011-08-01" - | "2011-09-15" - | "2011-11-17" - | "2012-02-23" - | "2012-03-25" - | "2012-06-18" - | "2012-06-28" - | "2012-07-09" - | "2012-09-24" - | "2012-10-26" - | "2012-11-07" - | "2013-02-11" - | "2013-02-13" - | "2013-07-05" - | "2013-08-12" - | "2013-08-13" - | "2013-10-29" - | "2013-12-03" - | "2014-01-31" - | "2014-03-13" - | "2014-03-28" - | "2014-05-19" - | "2014-06-13" - | "2014-06-17" - | "2014-07-22" - | "2014-07-26" - | "2014-08-04" - | "2014-08-20" - | "2014-09-08" - | "2014-10-07" - | "2014-11-05" - | "2014-11-20" - | "2014-12-08" - | "2014-12-17" - | "2014-12-22" - | "2015-01-11" - | "2015-01-26" - | "2015-02-10" - | "2015-02-16" - | "2015-02-18" - | "2015-03-24" - | "2015-04-07" - | "2015-06-15" - | "2015-07-07" - | "2015-07-13" - | "2015-07-28" - | "2015-08-07" - | "2015-08-19" - | "2015-09-03" - | "2015-09-08" - | "2015-09-23" - | "2015-10-01" - | "2015-10-12" - | "2015-10-16" - | "2016-02-03" - | "2016-02-19" - | "2016-02-22" - | "2016-02-23" - | "2016-02-29" - | "2016-03-07" - | "2016-06-15" - | "2016-07-06" - | "2016-10-19" - | "2017-01-27" - | "2017-02-14" - | "2017-04-06" - | "2017-05-25" - | "2017-06-05" - | "2017-08-15" - | "2017-12-14" - | "2018-01-23" - | "2018-02-05" - | "2018-02-06" - | "2018-02-28" - | "2018-05-21" - | "2018-07-27" - | "2018-08-23" - | "2018-09-06" - | "2018-09-24" - | "2018-10-31" - | "2018-11-08" - | "2019-02-11" - | "2019-02-19" - | "2019-03-14" - | "2019-05-16" - | "2019-08-14" - | "2019-09-09" - | "2019-10-08" - | "2019-10-17" - | "2019-11-05" - | "2019-12-03" - | "2020-03-02" - | "2020-08-27"; + | '2011-01-01' + | '2011-06-21' + | '2011-06-28' + | '2011-08-01' + | '2011-09-15' + | '2011-11-17' + | '2012-02-23' + | '2012-03-25' + | '2012-06-18' + | '2012-06-28' + | '2012-07-09' + | '2012-09-24' + | '2012-10-26' + | '2012-11-07' + | '2013-02-11' + | '2013-02-13' + | '2013-07-05' + | '2013-08-12' + | '2013-08-13' + | '2013-10-29' + | '2013-12-03' + | '2014-01-31' + | '2014-03-13' + | '2014-03-28' + | '2014-05-19' + | '2014-06-13' + | '2014-06-17' + | '2014-07-22' + | '2014-07-26' + | '2014-08-04' + | '2014-08-20' + | '2014-09-08' + | '2014-10-07' + | '2014-11-05' + | '2014-11-20' + | '2014-12-08' + | '2014-12-17' + | '2014-12-22' + | '2015-01-11' + | '2015-01-26' + | '2015-02-10' + | '2015-02-16' + | '2015-02-18' + | '2015-03-24' + | '2015-04-07' + | '2015-06-15' + | '2015-07-07' + | '2015-07-13' + | '2015-07-28' + | '2015-08-07' + | '2015-08-19' + | '2015-09-03' + | '2015-09-08' + | '2015-09-23' + | '2015-10-01' + | '2015-10-12' + | '2015-10-16' + | '2016-02-03' + | '2016-02-19' + | '2016-02-22' + | '2016-02-23' + | '2016-02-29' + | '2016-03-07' + | '2016-06-15' + | '2016-07-06' + | '2016-10-19' + | '2017-01-27' + | '2017-02-14' + | '2017-04-06' + | '2017-05-25' + | '2017-06-05' + | '2017-08-15' + | '2017-12-14' + | '2018-01-23' + | '2018-02-05' + | '2018-02-06' + | '2018-02-28' + | '2018-05-21' + | '2018-07-27' + | '2018-08-23' + | '2018-09-06' + | '2018-09-24' + | '2018-10-31' + | '2018-11-08' + | '2019-02-11' + | '2019-02-19' + | '2019-03-14' + | '2019-05-16' + | '2019-08-14' + | '2019-09-09' + | '2019-10-08' + | '2019-10-17' + | '2019-11-05' + | '2019-12-03' + | '2020-03-02' + | '2020-08-27' /** @description Whether this endpoint should receive events from connected accounts (`true`), or from your account (`false`). Defaults to `false`. */ - readonly connect?: boolean; + readonly connect?: boolean /** @description An optional description of what the webhook is used for. */ - readonly description?: string; + readonly description?: string /** @description The list of events to enable for this endpoint. You may specify `['*']` to enable all events, except those that require explicit selection. */ readonly enabled_events: readonly ( - | "*" - | "account.application.authorized" - | "account.application.deauthorized" - | "account.external_account.created" - | "account.external_account.deleted" - | "account.external_account.updated" - | "account.updated" - | "application_fee.created" - | "application_fee.refund.updated" - | "application_fee.refunded" - | "balance.available" - | "billing_portal.configuration.created" - | "billing_portal.configuration.updated" - | "capability.updated" - | "charge.captured" - | "charge.dispute.closed" - | "charge.dispute.created" - | "charge.dispute.funds_reinstated" - | "charge.dispute.funds_withdrawn" - | "charge.dispute.updated" - | "charge.expired" - | "charge.failed" - | "charge.pending" - | "charge.refund.updated" - | "charge.refunded" - | "charge.succeeded" - | "charge.updated" - | "checkout.session.async_payment_failed" - | "checkout.session.async_payment_succeeded" - | "checkout.session.completed" - | "checkout.session.expired" - | "coupon.created" - | "coupon.deleted" - | "coupon.updated" - | "credit_note.created" - | "credit_note.updated" - | "credit_note.voided" - | "customer.created" - | "customer.deleted" - | "customer.discount.created" - | "customer.discount.deleted" - | "customer.discount.updated" - | "customer.source.created" - | "customer.source.deleted" - | "customer.source.expiring" - | "customer.source.updated" - | "customer.subscription.created" - | "customer.subscription.deleted" - | "customer.subscription.pending_update_applied" - | "customer.subscription.pending_update_expired" - | "customer.subscription.trial_will_end" - | "customer.subscription.updated" - | "customer.tax_id.created" - | "customer.tax_id.deleted" - | "customer.tax_id.updated" - | "customer.updated" - | "file.created" - | "identity.verification_session.canceled" - | "identity.verification_session.created" - | "identity.verification_session.processing" - | "identity.verification_session.redacted" - | "identity.verification_session.requires_input" - | "identity.verification_session.verified" - | "invoice.created" - | "invoice.deleted" - | "invoice.finalization_failed" - | "invoice.finalized" - | "invoice.marked_uncollectible" - | "invoice.paid" - | "invoice.payment_action_required" - | "invoice.payment_failed" - | "invoice.payment_succeeded" - | "invoice.sent" - | "invoice.upcoming" - | "invoice.updated" - | "invoice.voided" - | "invoiceitem.created" - | "invoiceitem.deleted" - | "invoiceitem.updated" - | "issuing_authorization.created" - | "issuing_authorization.request" - | "issuing_authorization.updated" - | "issuing_card.created" - | "issuing_card.updated" - | "issuing_cardholder.created" - | "issuing_cardholder.updated" - | "issuing_dispute.closed" - | "issuing_dispute.created" - | "issuing_dispute.funds_reinstated" - | "issuing_dispute.submitted" - | "issuing_dispute.updated" - | "issuing_transaction.created" - | "issuing_transaction.updated" - | "mandate.updated" - | "order.created" - | "order.payment_failed" - | "order.payment_succeeded" - | "order.updated" - | "order_return.created" - | "payment_intent.amount_capturable_updated" - | "payment_intent.canceled" - | "payment_intent.created" - | "payment_intent.payment_failed" - | "payment_intent.processing" - | "payment_intent.requires_action" - | "payment_intent.succeeded" - | "payment_link.created" - | "payment_link.updated" - | "payment_method.attached" - | "payment_method.automatically_updated" - | "payment_method.detached" - | "payment_method.updated" - | "payout.canceled" - | "payout.created" - | "payout.failed" - | "payout.paid" - | "payout.updated" - | "person.created" - | "person.deleted" - | "person.updated" - | "plan.created" - | "plan.deleted" - | "plan.updated" - | "price.created" - | "price.deleted" - | "price.updated" - | "product.created" - | "product.deleted" - | "product.updated" - | "promotion_code.created" - | "promotion_code.updated" - | "quote.accepted" - | "quote.canceled" - | "quote.created" - | "quote.finalized" - | "radar.early_fraud_warning.created" - | "radar.early_fraud_warning.updated" - | "recipient.created" - | "recipient.deleted" - | "recipient.updated" - | "reporting.report_run.failed" - | "reporting.report_run.succeeded" - | "reporting.report_type.updated" - | "review.closed" - | "review.opened" - | "setup_intent.canceled" - | "setup_intent.created" - | "setup_intent.requires_action" - | "setup_intent.setup_failed" - | "setup_intent.succeeded" - | "sigma.scheduled_query_run.created" - | "sku.created" - | "sku.deleted" - | "sku.updated" - | "source.canceled" - | "source.chargeable" - | "source.failed" - | "source.mandate_notification" - | "source.refund_attributes_required" - | "source.transaction.created" - | "source.transaction.updated" - | "subscription_schedule.aborted" - | "subscription_schedule.canceled" - | "subscription_schedule.completed" - | "subscription_schedule.created" - | "subscription_schedule.expiring" - | "subscription_schedule.released" - | "subscription_schedule.updated" - | "tax_rate.created" - | "tax_rate.updated" - | "topup.canceled" - | "topup.created" - | "topup.failed" - | "topup.reversed" - | "topup.succeeded" - | "transfer.created" - | "transfer.failed" - | "transfer.paid" - | "transfer.reversed" - | "transfer.updated" - )[]; + | '*' + | 'account.application.authorized' + | 'account.application.deauthorized' + | 'account.external_account.created' + | 'account.external_account.deleted' + | 'account.external_account.updated' + | 'account.updated' + | 'application_fee.created' + | 'application_fee.refund.updated' + | 'application_fee.refunded' + | 'balance.available' + | 'billing_portal.configuration.created' + | 'billing_portal.configuration.updated' + | 'capability.updated' + | 'charge.captured' + | 'charge.dispute.closed' + | 'charge.dispute.created' + | 'charge.dispute.funds_reinstated' + | 'charge.dispute.funds_withdrawn' + | 'charge.dispute.updated' + | 'charge.expired' + | 'charge.failed' + | 'charge.pending' + | 'charge.refund.updated' + | 'charge.refunded' + | 'charge.succeeded' + | 'charge.updated' + | 'checkout.session.async_payment_failed' + | 'checkout.session.async_payment_succeeded' + | 'checkout.session.completed' + | 'checkout.session.expired' + | 'coupon.created' + | 'coupon.deleted' + | 'coupon.updated' + | 'credit_note.created' + | 'credit_note.updated' + | 'credit_note.voided' + | 'customer.created' + | 'customer.deleted' + | 'customer.discount.created' + | 'customer.discount.deleted' + | 'customer.discount.updated' + | 'customer.source.created' + | 'customer.source.deleted' + | 'customer.source.expiring' + | 'customer.source.updated' + | 'customer.subscription.created' + | 'customer.subscription.deleted' + | 'customer.subscription.pending_update_applied' + | 'customer.subscription.pending_update_expired' + | 'customer.subscription.trial_will_end' + | 'customer.subscription.updated' + | 'customer.tax_id.created' + | 'customer.tax_id.deleted' + | 'customer.tax_id.updated' + | 'customer.updated' + | 'file.created' + | 'identity.verification_session.canceled' + | 'identity.verification_session.created' + | 'identity.verification_session.processing' + | 'identity.verification_session.redacted' + | 'identity.verification_session.requires_input' + | 'identity.verification_session.verified' + | 'invoice.created' + | 'invoice.deleted' + | 'invoice.finalization_failed' + | 'invoice.finalized' + | 'invoice.marked_uncollectible' + | 'invoice.paid' + | 'invoice.payment_action_required' + | 'invoice.payment_failed' + | 'invoice.payment_succeeded' + | 'invoice.sent' + | 'invoice.upcoming' + | 'invoice.updated' + | 'invoice.voided' + | 'invoiceitem.created' + | 'invoiceitem.deleted' + | 'invoiceitem.updated' + | 'issuing_authorization.created' + | 'issuing_authorization.request' + | 'issuing_authorization.updated' + | 'issuing_card.created' + | 'issuing_card.updated' + | 'issuing_cardholder.created' + | 'issuing_cardholder.updated' + | 'issuing_dispute.closed' + | 'issuing_dispute.created' + | 'issuing_dispute.funds_reinstated' + | 'issuing_dispute.submitted' + | 'issuing_dispute.updated' + | 'issuing_transaction.created' + | 'issuing_transaction.updated' + | 'mandate.updated' + | 'order.created' + | 'order.payment_failed' + | 'order.payment_succeeded' + | 'order.updated' + | 'order_return.created' + | 'payment_intent.amount_capturable_updated' + | 'payment_intent.canceled' + | 'payment_intent.created' + | 'payment_intent.payment_failed' + | 'payment_intent.processing' + | 'payment_intent.requires_action' + | 'payment_intent.succeeded' + | 'payment_link.created' + | 'payment_link.updated' + | 'payment_method.attached' + | 'payment_method.automatically_updated' + | 'payment_method.detached' + | 'payment_method.updated' + | 'payout.canceled' + | 'payout.created' + | 'payout.failed' + | 'payout.paid' + | 'payout.updated' + | 'person.created' + | 'person.deleted' + | 'person.updated' + | 'plan.created' + | 'plan.deleted' + | 'plan.updated' + | 'price.created' + | 'price.deleted' + | 'price.updated' + | 'product.created' + | 'product.deleted' + | 'product.updated' + | 'promotion_code.created' + | 'promotion_code.updated' + | 'quote.accepted' + | 'quote.canceled' + | 'quote.created' + | 'quote.finalized' + | 'radar.early_fraud_warning.created' + | 'radar.early_fraud_warning.updated' + | 'recipient.created' + | 'recipient.deleted' + | 'recipient.updated' + | 'reporting.report_run.failed' + | 'reporting.report_run.succeeded' + | 'reporting.report_type.updated' + | 'review.closed' + | 'review.opened' + | 'setup_intent.canceled' + | 'setup_intent.created' + | 'setup_intent.requires_action' + | 'setup_intent.setup_failed' + | 'setup_intent.succeeded' + | 'sigma.scheduled_query_run.created' + | 'sku.created' + | 'sku.deleted' + | 'sku.updated' + | 'source.canceled' + | 'source.chargeable' + | 'source.failed' + | 'source.mandate_notification' + | 'source.refund_attributes_required' + | 'source.transaction.created' + | 'source.transaction.updated' + | 'subscription_schedule.aborted' + | 'subscription_schedule.canceled' + | 'subscription_schedule.completed' + | 'subscription_schedule.created' + | 'subscription_schedule.expiring' + | 'subscription_schedule.released' + | 'subscription_schedule.updated' + | 'tax_rate.created' + | 'tax_rate.updated' + | 'topup.canceled' + | 'topup.created' + | 'topup.failed' + | 'topup.reversed' + | 'topup.succeeded' + | 'transfer.created' + | 'transfer.failed' + | 'transfer.paid' + | 'transfer.reversed' + | 'transfer.updated' + )[] /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description The URL of the webhook endpoint. */ - readonly url: string; - }; - }; - }; - }; + readonly url: string + } + } + } + } /**

Retrieves the webhook endpoint with the given ID.

*/ readonly GetWebhookEndpointsWebhookEndpoint: { readonly parameters: { readonly query: { /** Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; - }; + readonly expand?: readonly string[] + } readonly path: { - readonly webhook_endpoint: string; - }; - }; + readonly webhook_endpoint: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["webhook_endpoint"]; - }; - }; + readonly 'application/json': components['schemas']['webhook_endpoint'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } /**

Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.

*/ readonly PostWebhookEndpointsWebhookEndpoint: { readonly parameters: { readonly path: { - readonly webhook_endpoint: string; - }; - }; + readonly webhook_endpoint: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["webhook_endpoint"]; - }; - }; + readonly 'application/json': components['schemas']['webhook_endpoint'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { + readonly 'application/x-www-form-urlencoded': { /** @description An optional description of what the webhook is used for. */ - readonly description?: string; + readonly description?: string /** @description Disable the webhook endpoint if set to true. */ - readonly disabled?: boolean; + readonly disabled?: boolean /** @description The list of events to enable for this endpoint. You may specify `['*']` to enable all events, except those that require explicit selection. */ readonly enabled_events?: readonly ( - | "*" - | "account.application.authorized" - | "account.application.deauthorized" - | "account.external_account.created" - | "account.external_account.deleted" - | "account.external_account.updated" - | "account.updated" - | "application_fee.created" - | "application_fee.refund.updated" - | "application_fee.refunded" - | "balance.available" - | "billing_portal.configuration.created" - | "billing_portal.configuration.updated" - | "capability.updated" - | "charge.captured" - | "charge.dispute.closed" - | "charge.dispute.created" - | "charge.dispute.funds_reinstated" - | "charge.dispute.funds_withdrawn" - | "charge.dispute.updated" - | "charge.expired" - | "charge.failed" - | "charge.pending" - | "charge.refund.updated" - | "charge.refunded" - | "charge.succeeded" - | "charge.updated" - | "checkout.session.async_payment_failed" - | "checkout.session.async_payment_succeeded" - | "checkout.session.completed" - | "checkout.session.expired" - | "coupon.created" - | "coupon.deleted" - | "coupon.updated" - | "credit_note.created" - | "credit_note.updated" - | "credit_note.voided" - | "customer.created" - | "customer.deleted" - | "customer.discount.created" - | "customer.discount.deleted" - | "customer.discount.updated" - | "customer.source.created" - | "customer.source.deleted" - | "customer.source.expiring" - | "customer.source.updated" - | "customer.subscription.created" - | "customer.subscription.deleted" - | "customer.subscription.pending_update_applied" - | "customer.subscription.pending_update_expired" - | "customer.subscription.trial_will_end" - | "customer.subscription.updated" - | "customer.tax_id.created" - | "customer.tax_id.deleted" - | "customer.tax_id.updated" - | "customer.updated" - | "file.created" - | "identity.verification_session.canceled" - | "identity.verification_session.created" - | "identity.verification_session.processing" - | "identity.verification_session.redacted" - | "identity.verification_session.requires_input" - | "identity.verification_session.verified" - | "invoice.created" - | "invoice.deleted" - | "invoice.finalization_failed" - | "invoice.finalized" - | "invoice.marked_uncollectible" - | "invoice.paid" - | "invoice.payment_action_required" - | "invoice.payment_failed" - | "invoice.payment_succeeded" - | "invoice.sent" - | "invoice.upcoming" - | "invoice.updated" - | "invoice.voided" - | "invoiceitem.created" - | "invoiceitem.deleted" - | "invoiceitem.updated" - | "issuing_authorization.created" - | "issuing_authorization.request" - | "issuing_authorization.updated" - | "issuing_card.created" - | "issuing_card.updated" - | "issuing_cardholder.created" - | "issuing_cardholder.updated" - | "issuing_dispute.closed" - | "issuing_dispute.created" - | "issuing_dispute.funds_reinstated" - | "issuing_dispute.submitted" - | "issuing_dispute.updated" - | "issuing_transaction.created" - | "issuing_transaction.updated" - | "mandate.updated" - | "order.created" - | "order.payment_failed" - | "order.payment_succeeded" - | "order.updated" - | "order_return.created" - | "payment_intent.amount_capturable_updated" - | "payment_intent.canceled" - | "payment_intent.created" - | "payment_intent.payment_failed" - | "payment_intent.processing" - | "payment_intent.requires_action" - | "payment_intent.succeeded" - | "payment_link.created" - | "payment_link.updated" - | "payment_method.attached" - | "payment_method.automatically_updated" - | "payment_method.detached" - | "payment_method.updated" - | "payout.canceled" - | "payout.created" - | "payout.failed" - | "payout.paid" - | "payout.updated" - | "person.created" - | "person.deleted" - | "person.updated" - | "plan.created" - | "plan.deleted" - | "plan.updated" - | "price.created" - | "price.deleted" - | "price.updated" - | "product.created" - | "product.deleted" - | "product.updated" - | "promotion_code.created" - | "promotion_code.updated" - | "quote.accepted" - | "quote.canceled" - | "quote.created" - | "quote.finalized" - | "radar.early_fraud_warning.created" - | "radar.early_fraud_warning.updated" - | "recipient.created" - | "recipient.deleted" - | "recipient.updated" - | "reporting.report_run.failed" - | "reporting.report_run.succeeded" - | "reporting.report_type.updated" - | "review.closed" - | "review.opened" - | "setup_intent.canceled" - | "setup_intent.created" - | "setup_intent.requires_action" - | "setup_intent.setup_failed" - | "setup_intent.succeeded" - | "sigma.scheduled_query_run.created" - | "sku.created" - | "sku.deleted" - | "sku.updated" - | "source.canceled" - | "source.chargeable" - | "source.failed" - | "source.mandate_notification" - | "source.refund_attributes_required" - | "source.transaction.created" - | "source.transaction.updated" - | "subscription_schedule.aborted" - | "subscription_schedule.canceled" - | "subscription_schedule.completed" - | "subscription_schedule.created" - | "subscription_schedule.expiring" - | "subscription_schedule.released" - | "subscription_schedule.updated" - | "tax_rate.created" - | "tax_rate.updated" - | "topup.canceled" - | "topup.created" - | "topup.failed" - | "topup.reversed" - | "topup.succeeded" - | "transfer.created" - | "transfer.failed" - | "transfer.paid" - | "transfer.reversed" - | "transfer.updated" - )[]; + | '*' + | 'account.application.authorized' + | 'account.application.deauthorized' + | 'account.external_account.created' + | 'account.external_account.deleted' + | 'account.external_account.updated' + | 'account.updated' + | 'application_fee.created' + | 'application_fee.refund.updated' + | 'application_fee.refunded' + | 'balance.available' + | 'billing_portal.configuration.created' + | 'billing_portal.configuration.updated' + | 'capability.updated' + | 'charge.captured' + | 'charge.dispute.closed' + | 'charge.dispute.created' + | 'charge.dispute.funds_reinstated' + | 'charge.dispute.funds_withdrawn' + | 'charge.dispute.updated' + | 'charge.expired' + | 'charge.failed' + | 'charge.pending' + | 'charge.refund.updated' + | 'charge.refunded' + | 'charge.succeeded' + | 'charge.updated' + | 'checkout.session.async_payment_failed' + | 'checkout.session.async_payment_succeeded' + | 'checkout.session.completed' + | 'checkout.session.expired' + | 'coupon.created' + | 'coupon.deleted' + | 'coupon.updated' + | 'credit_note.created' + | 'credit_note.updated' + | 'credit_note.voided' + | 'customer.created' + | 'customer.deleted' + | 'customer.discount.created' + | 'customer.discount.deleted' + | 'customer.discount.updated' + | 'customer.source.created' + | 'customer.source.deleted' + | 'customer.source.expiring' + | 'customer.source.updated' + | 'customer.subscription.created' + | 'customer.subscription.deleted' + | 'customer.subscription.pending_update_applied' + | 'customer.subscription.pending_update_expired' + | 'customer.subscription.trial_will_end' + | 'customer.subscription.updated' + | 'customer.tax_id.created' + | 'customer.tax_id.deleted' + | 'customer.tax_id.updated' + | 'customer.updated' + | 'file.created' + | 'identity.verification_session.canceled' + | 'identity.verification_session.created' + | 'identity.verification_session.processing' + | 'identity.verification_session.redacted' + | 'identity.verification_session.requires_input' + | 'identity.verification_session.verified' + | 'invoice.created' + | 'invoice.deleted' + | 'invoice.finalization_failed' + | 'invoice.finalized' + | 'invoice.marked_uncollectible' + | 'invoice.paid' + | 'invoice.payment_action_required' + | 'invoice.payment_failed' + | 'invoice.payment_succeeded' + | 'invoice.sent' + | 'invoice.upcoming' + | 'invoice.updated' + | 'invoice.voided' + | 'invoiceitem.created' + | 'invoiceitem.deleted' + | 'invoiceitem.updated' + | 'issuing_authorization.created' + | 'issuing_authorization.request' + | 'issuing_authorization.updated' + | 'issuing_card.created' + | 'issuing_card.updated' + | 'issuing_cardholder.created' + | 'issuing_cardholder.updated' + | 'issuing_dispute.closed' + | 'issuing_dispute.created' + | 'issuing_dispute.funds_reinstated' + | 'issuing_dispute.submitted' + | 'issuing_dispute.updated' + | 'issuing_transaction.created' + | 'issuing_transaction.updated' + | 'mandate.updated' + | 'order.created' + | 'order.payment_failed' + | 'order.payment_succeeded' + | 'order.updated' + | 'order_return.created' + | 'payment_intent.amount_capturable_updated' + | 'payment_intent.canceled' + | 'payment_intent.created' + | 'payment_intent.payment_failed' + | 'payment_intent.processing' + | 'payment_intent.requires_action' + | 'payment_intent.succeeded' + | 'payment_link.created' + | 'payment_link.updated' + | 'payment_method.attached' + | 'payment_method.automatically_updated' + | 'payment_method.detached' + | 'payment_method.updated' + | 'payout.canceled' + | 'payout.created' + | 'payout.failed' + | 'payout.paid' + | 'payout.updated' + | 'person.created' + | 'person.deleted' + | 'person.updated' + | 'plan.created' + | 'plan.deleted' + | 'plan.updated' + | 'price.created' + | 'price.deleted' + | 'price.updated' + | 'product.created' + | 'product.deleted' + | 'product.updated' + | 'promotion_code.created' + | 'promotion_code.updated' + | 'quote.accepted' + | 'quote.canceled' + | 'quote.created' + | 'quote.finalized' + | 'radar.early_fraud_warning.created' + | 'radar.early_fraud_warning.updated' + | 'recipient.created' + | 'recipient.deleted' + | 'recipient.updated' + | 'reporting.report_run.failed' + | 'reporting.report_run.succeeded' + | 'reporting.report_type.updated' + | 'review.closed' + | 'review.opened' + | 'setup_intent.canceled' + | 'setup_intent.created' + | 'setup_intent.requires_action' + | 'setup_intent.setup_failed' + | 'setup_intent.succeeded' + | 'sigma.scheduled_query_run.created' + | 'sku.created' + | 'sku.deleted' + | 'sku.updated' + | 'source.canceled' + | 'source.chargeable' + | 'source.failed' + | 'source.mandate_notification' + | 'source.refund_attributes_required' + | 'source.transaction.created' + | 'source.transaction.updated' + | 'subscription_schedule.aborted' + | 'subscription_schedule.canceled' + | 'subscription_schedule.completed' + | 'subscription_schedule.created' + | 'subscription_schedule.expiring' + | 'subscription_schedule.released' + | 'subscription_schedule.updated' + | 'tax_rate.created' + | 'tax_rate.updated' + | 'topup.canceled' + | 'topup.created' + | 'topup.failed' + | 'topup.reversed' + | 'topup.succeeded' + | 'transfer.created' + | 'transfer.failed' + | 'transfer.paid' + | 'transfer.reversed' + | 'transfer.updated' + )[] /** @description Specifies which fields in the response should be expanded. */ - readonly expand?: readonly string[]; + readonly expand?: readonly string[] /** @description 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`. */ - readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<"">; + readonly metadata?: Partial<{ readonly [key: string]: string }> & Partial<''> /** @description The URL of the webhook endpoint. */ - readonly url?: string; - }; - }; - }; - }; + readonly url?: string + } + } + } + } /**

You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.

*/ readonly DeleteWebhookEndpointsWebhookEndpoint: { readonly parameters: { readonly path: { - readonly webhook_endpoint: string; - }; - }; + readonly webhook_endpoint: string + } + } readonly responses: { /** Successful response. */ readonly 200: { readonly content: { - readonly "application/json": components["schemas"]["deleted_webhook_endpoint"]; - }; - }; + readonly 'application/json': components['schemas']['deleted_webhook_endpoint'] + } + } /** Error response. */ readonly default: { readonly content: { - readonly "application/json": components["schemas"]["error"]; - }; - }; - }; + readonly 'application/json': components['schemas']['error'] + } + } + } readonly requestBody: { readonly content: { - readonly "application/x-www-form-urlencoded": { readonly [key: string]: unknown }; - }; - }; - }; + readonly 'application/x-www-form-urlencoded': { readonly [key: string]: unknown } + } + } + } } export interface external {} diff --git a/test/v3/expected/stripe.support-array-length.ts b/test/v3/expected/stripe.support-array-length.ts index f1424b67f..bdf2c7f53 100644 --- a/test/v3/expected/stripe.support-array-length.ts +++ b/test/v3/expected/stripe.support-array-length.ts @@ -4,23 +4,23 @@ */ export interface paths { - "/v1/3d_secure": { + '/v1/3d_secure': { /**

Initiate 3D Secure authentication.

*/ - post: operations["Post3dSecure"]; - }; - "/v1/3d_secure/{three_d_secure}": { + post: operations['Post3dSecure'] + } + '/v1/3d_secure/{three_d_secure}': { /**

Retrieves a 3D Secure object.

*/ - get: operations["Get3dSecureThreeDSecure"]; - }; - "/v1/account": { + get: operations['Get3dSecureThreeDSecure'] + } + '/v1/account': { /**

Retrieves the details of an account.

*/ - get: operations["GetAccount"]; + get: operations['GetAccount'] /** *

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged. Most parameters can be changed only for Custom accounts. (These are marked Custom Only below.) Parameters marked Custom and Express are not supported for Standard accounts.

* *

To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.

*/ - post: operations["PostAccount"]; + post: operations['PostAccount'] /** *

With Connect, you can delete accounts you manage.

* @@ -28,110 +28,110 @@ export interface paths { * *

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

*/ - delete: operations["DeleteAccount"]; - }; - "/v1/account/bank_accounts": { + delete: operations['DeleteAccount'] + } + '/v1/account/bank_accounts': { /**

Create an external account for a given account.

*/ - post: operations["PostAccountBankAccounts"]; - }; - "/v1/account/bank_accounts/{id}": { + post: operations['PostAccountBankAccounts'] + } + '/v1/account/bank_accounts/{id}': { /**

Retrieve a specified external account for a given account.

*/ - get: operations["GetAccountBankAccountsId"]; + get: operations['GetAccountBankAccountsId'] /** *

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

* *

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

*/ - post: operations["PostAccountBankAccountsId"]; + post: operations['PostAccountBankAccountsId'] /**

Delete a specified external account for a given account.

*/ - delete: operations["DeleteAccountBankAccountsId"]; - }; - "/v1/account/capabilities": { + delete: operations['DeleteAccountBankAccountsId'] + } + '/v1/account/capabilities': { /**

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

*/ - get: operations["GetAccountCapabilities"]; - }; - "/v1/account/capabilities/{capability}": { + get: operations['GetAccountCapabilities'] + } + '/v1/account/capabilities/{capability}': { /**

Retrieves information about the specified Account Capability.

*/ - get: operations["GetAccountCapabilitiesCapability"]; + get: operations['GetAccountCapabilitiesCapability'] /**

Updates an existing Account Capability.

*/ - post: operations["PostAccountCapabilitiesCapability"]; - }; - "/v1/account/external_accounts": { + post: operations['PostAccountCapabilitiesCapability'] + } + '/v1/account/external_accounts': { /**

List external accounts for an account.

*/ - get: operations["GetAccountExternalAccounts"]; + get: operations['GetAccountExternalAccounts'] /**

Create an external account for a given account.

*/ - post: operations["PostAccountExternalAccounts"]; - }; - "/v1/account/external_accounts/{id}": { + post: operations['PostAccountExternalAccounts'] + } + '/v1/account/external_accounts/{id}': { /**

Retrieve a specified external account for a given account.

*/ - get: operations["GetAccountExternalAccountsId"]; + get: operations['GetAccountExternalAccountsId'] /** *

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

* *

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

*/ - post: operations["PostAccountExternalAccountsId"]; + post: operations['PostAccountExternalAccountsId'] /**

Delete a specified external account for a given account.

*/ - delete: operations["DeleteAccountExternalAccountsId"]; - }; - "/v1/account/login_links": { + delete: operations['DeleteAccountExternalAccountsId'] + } + '/v1/account/login_links': { /** *

Creates a single-use login link for an Express account to access their Stripe dashboard.

* *

You may only create login links for Express accounts connected to your platform.

*/ - post: operations["PostAccountLoginLinks"]; - }; - "/v1/account/people": { + post: operations['PostAccountLoginLinks'] + } + '/v1/account/people': { /**

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.

*/ - get: operations["GetAccountPeople"]; + get: operations['GetAccountPeople'] /**

Creates a new person.

*/ - post: operations["PostAccountPeople"]; - }; - "/v1/account/people/{person}": { + post: operations['PostAccountPeople'] + } + '/v1/account/people/{person}': { /**

Retrieves an existing person.

*/ - get: operations["GetAccountPeoplePerson"]; + get: operations['GetAccountPeoplePerson'] /**

Updates an existing person.

*/ - post: operations["PostAccountPeoplePerson"]; + post: operations['PostAccountPeoplePerson'] /**

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.

*/ - delete: operations["DeleteAccountPeoplePerson"]; - }; - "/v1/account/persons": { + delete: operations['DeleteAccountPeoplePerson'] + } + '/v1/account/persons': { /**

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.

*/ - get: operations["GetAccountPersons"]; + get: operations['GetAccountPersons'] /**

Creates a new person.

*/ - post: operations["PostAccountPersons"]; - }; - "/v1/account/persons/{person}": { + post: operations['PostAccountPersons'] + } + '/v1/account/persons/{person}': { /**

Retrieves an existing person.

*/ - get: operations["GetAccountPersonsPerson"]; + get: operations['GetAccountPersonsPerson'] /**

Updates an existing person.

*/ - post: operations["PostAccountPersonsPerson"]; + post: operations['PostAccountPersonsPerson'] /**

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.

*/ - delete: operations["DeleteAccountPersonsPerson"]; - }; - "/v1/account_links": { + delete: operations['DeleteAccountPersonsPerson'] + } + '/v1/account_links': { /**

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.

*/ - post: operations["PostAccountLinks"]; - }; - "/v1/accounts": { + post: operations['PostAccountLinks'] + } + '/v1/accounts': { /**

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

*/ - get: operations["GetAccounts"]; + get: operations['GetAccounts'] /** *

With Connect, you can create Stripe accounts for your users. * To do this, you’ll first need to register your platform.

*/ - post: operations["PostAccounts"]; - }; - "/v1/accounts/{account}": { + post: operations['PostAccounts'] + } + '/v1/accounts/{account}': { /**

Retrieves the details of an account.

*/ - get: operations["GetAccountsAccount"]; + get: operations['GetAccountsAccount'] /** *

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged. Most parameters can be changed only for Custom accounts. (These are marked Custom Only below.) Parameters marked Custom and Express are not supported for Standard accounts.

* *

To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.

*/ - post: operations["PostAccountsAccount"]; + post: operations['PostAccountsAccount'] /** *

With Connect, you can delete accounts you manage.

* @@ -139,132 +139,132 @@ export interface paths { * *

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

*/ - delete: operations["DeleteAccountsAccount"]; - }; - "/v1/accounts/{account}/bank_accounts": { + delete: operations['DeleteAccountsAccount'] + } + '/v1/accounts/{account}/bank_accounts': { /**

Create an external account for a given account.

*/ - post: operations["PostAccountsAccountBankAccounts"]; - }; - "/v1/accounts/{account}/bank_accounts/{id}": { + post: operations['PostAccountsAccountBankAccounts'] + } + '/v1/accounts/{account}/bank_accounts/{id}': { /**

Retrieve a specified external account for a given account.

*/ - get: operations["GetAccountsAccountBankAccountsId"]; + get: operations['GetAccountsAccountBankAccountsId'] /** *

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

* *

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

*/ - post: operations["PostAccountsAccountBankAccountsId"]; + post: operations['PostAccountsAccountBankAccountsId'] /**

Delete a specified external account for a given account.

*/ - delete: operations["DeleteAccountsAccountBankAccountsId"]; - }; - "/v1/accounts/{account}/capabilities": { + delete: operations['DeleteAccountsAccountBankAccountsId'] + } + '/v1/accounts/{account}/capabilities': { /**

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

*/ - get: operations["GetAccountsAccountCapabilities"]; - }; - "/v1/accounts/{account}/capabilities/{capability}": { + get: operations['GetAccountsAccountCapabilities'] + } + '/v1/accounts/{account}/capabilities/{capability}': { /**

Retrieves information about the specified Account Capability.

*/ - get: operations["GetAccountsAccountCapabilitiesCapability"]; + get: operations['GetAccountsAccountCapabilitiesCapability'] /**

Updates an existing Account Capability.

*/ - post: operations["PostAccountsAccountCapabilitiesCapability"]; - }; - "/v1/accounts/{account}/external_accounts": { + post: operations['PostAccountsAccountCapabilitiesCapability'] + } + '/v1/accounts/{account}/external_accounts': { /**

List external accounts for an account.

*/ - get: operations["GetAccountsAccountExternalAccounts"]; + get: operations['GetAccountsAccountExternalAccounts'] /**

Create an external account for a given account.

*/ - post: operations["PostAccountsAccountExternalAccounts"]; - }; - "/v1/accounts/{account}/external_accounts/{id}": { + post: operations['PostAccountsAccountExternalAccounts'] + } + '/v1/accounts/{account}/external_accounts/{id}': { /**

Retrieve a specified external account for a given account.

*/ - get: operations["GetAccountsAccountExternalAccountsId"]; + get: operations['GetAccountsAccountExternalAccountsId'] /** *

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

* *

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

*/ - post: operations["PostAccountsAccountExternalAccountsId"]; + post: operations['PostAccountsAccountExternalAccountsId'] /**

Delete a specified external account for a given account.

*/ - delete: operations["DeleteAccountsAccountExternalAccountsId"]; - }; - "/v1/accounts/{account}/login_links": { + delete: operations['DeleteAccountsAccountExternalAccountsId'] + } + '/v1/accounts/{account}/login_links': { /** *

Creates a single-use login link for an Express account to access their Stripe dashboard.

* *

You may only create login links for Express accounts connected to your platform.

*/ - post: operations["PostAccountsAccountLoginLinks"]; - }; - "/v1/accounts/{account}/people": { + post: operations['PostAccountsAccountLoginLinks'] + } + '/v1/accounts/{account}/people': { /**

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.

*/ - get: operations["GetAccountsAccountPeople"]; + get: operations['GetAccountsAccountPeople'] /**

Creates a new person.

*/ - post: operations["PostAccountsAccountPeople"]; - }; - "/v1/accounts/{account}/people/{person}": { + post: operations['PostAccountsAccountPeople'] + } + '/v1/accounts/{account}/people/{person}': { /**

Retrieves an existing person.

*/ - get: operations["GetAccountsAccountPeoplePerson"]; + get: operations['GetAccountsAccountPeoplePerson'] /**

Updates an existing person.

*/ - post: operations["PostAccountsAccountPeoplePerson"]; + post: operations['PostAccountsAccountPeoplePerson'] /**

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.

*/ - delete: operations["DeleteAccountsAccountPeoplePerson"]; - }; - "/v1/accounts/{account}/persons": { + delete: operations['DeleteAccountsAccountPeoplePerson'] + } + '/v1/accounts/{account}/persons': { /**

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.

*/ - get: operations["GetAccountsAccountPersons"]; + get: operations['GetAccountsAccountPersons'] /**

Creates a new person.

*/ - post: operations["PostAccountsAccountPersons"]; - }; - "/v1/accounts/{account}/persons/{person}": { + post: operations['PostAccountsAccountPersons'] + } + '/v1/accounts/{account}/persons/{person}': { /**

Retrieves an existing person.

*/ - get: operations["GetAccountsAccountPersonsPerson"]; + get: operations['GetAccountsAccountPersonsPerson'] /**

Updates an existing person.

*/ - post: operations["PostAccountsAccountPersonsPerson"]; + post: operations['PostAccountsAccountPersonsPerson'] /**

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.

*/ - delete: operations["DeleteAccountsAccountPersonsPerson"]; - }; - "/v1/accounts/{account}/reject": { + delete: operations['DeleteAccountsAccountPersonsPerson'] + } + '/v1/accounts/{account}/reject': { /** *

With Connect, you may flag accounts as suspicious.

* *

Test-mode Custom and Express accounts can be rejected at any time. Accounts created using live-mode keys may only be rejected once all balances are zero.

*/ - post: operations["PostAccountsAccountReject"]; - }; - "/v1/apple_pay/domains": { + post: operations['PostAccountsAccountReject'] + } + '/v1/apple_pay/domains': { /**

List apple pay domains.

*/ - get: operations["GetApplePayDomains"]; + get: operations['GetApplePayDomains'] /**

Create an apple pay domain.

*/ - post: operations["PostApplePayDomains"]; - }; - "/v1/apple_pay/domains/{domain}": { + post: operations['PostApplePayDomains'] + } + '/v1/apple_pay/domains/{domain}': { /**

Retrieve an apple pay domain.

*/ - get: operations["GetApplePayDomainsDomain"]; + get: operations['GetApplePayDomainsDomain'] /**

Delete an apple pay domain.

*/ - delete: operations["DeleteApplePayDomainsDomain"]; - }; - "/v1/application_fees": { + delete: operations['DeleteApplePayDomainsDomain'] + } + '/v1/application_fees': { /**

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.

*/ - get: operations["GetApplicationFees"]; - }; - "/v1/application_fees/{fee}/refunds/{id}": { + get: operations['GetApplicationFees'] + } + '/v1/application_fees/{fee}/refunds/{id}': { /**

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.

*/ - get: operations["GetApplicationFeesFeeRefundsId"]; + get: operations['GetApplicationFeesFeeRefundsId'] /** *

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

* *

This request only accepts metadata as an argument.

*/ - post: operations["PostApplicationFeesFeeRefundsId"]; - }; - "/v1/application_fees/{id}": { + post: operations['PostApplicationFeesFeeRefundsId'] + } + '/v1/application_fees/{id}': { /**

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

*/ - get: operations["GetApplicationFeesId"]; - }; - "/v1/application_fees/{id}/refund": { - post: operations["PostApplicationFeesIdRefund"]; - }; - "/v1/application_fees/{id}/refunds": { + get: operations['GetApplicationFeesId'] + } + '/v1/application_fees/{id}/refund': { + post: operations['PostApplicationFeesIdRefund'] + } + '/v1/application_fees/{id}/refunds': { /**

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.

*/ - get: operations["GetApplicationFeesIdRefunds"]; + get: operations['GetApplicationFeesIdRefunds'] /** *

Refunds an application fee that has previously been collected but not yet refunded. * Funds will be refunded to the Stripe account from which the fee was originally collected.

@@ -276,108 +276,108 @@ export interface paths { * This method will raise an error when called on an already-refunded application fee, * or when trying to refund more money than is left on an application fee.

*/ - post: operations["PostApplicationFeesIdRefunds"]; - }; - "/v1/balance": { + post: operations['PostApplicationFeesIdRefunds'] + } + '/v1/balance': { /** *

Retrieves the current account balance, based on the authentication that was used to make the request. * For a sample request, see Accounting for negative balances.

*/ - get: operations["GetBalance"]; - }; - "/v1/balance/history": { + get: operations['GetBalance'] + } + '/v1/balance/history': { /** *

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

* *

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

*/ - get: operations["GetBalanceHistory"]; - }; - "/v1/balance/history/{id}": { + get: operations['GetBalanceHistory'] + } + '/v1/balance/history/{id}': { /** *

Retrieves the balance transaction with the given ID.

* *

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

*/ - get: operations["GetBalanceHistoryId"]; - }; - "/v1/balance_transactions": { + get: operations['GetBalanceHistoryId'] + } + '/v1/balance_transactions': { /** *

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

* *

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

*/ - get: operations["GetBalanceTransactions"]; - }; - "/v1/balance_transactions/{id}": { + get: operations['GetBalanceTransactions'] + } + '/v1/balance_transactions/{id}': { /** *

Retrieves the balance transaction with the given ID.

* *

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

*/ - get: operations["GetBalanceTransactionsId"]; - }; - "/v1/billing_portal/configurations": { + get: operations['GetBalanceTransactionsId'] + } + '/v1/billing_portal/configurations': { /**

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

*/ - get: operations["GetBillingPortalConfigurations"]; + get: operations['GetBillingPortalConfigurations'] /**

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

*/ - post: operations["PostBillingPortalConfigurations"]; - }; - "/v1/billing_portal/configurations/{configuration}": { + post: operations['PostBillingPortalConfigurations'] + } + '/v1/billing_portal/configurations/{configuration}': { /**

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

*/ - get: operations["GetBillingPortalConfigurationsConfiguration"]; + get: operations['GetBillingPortalConfigurationsConfiguration'] /**

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

*/ - post: operations["PostBillingPortalConfigurationsConfiguration"]; - }; - "/v1/billing_portal/sessions": { + post: operations['PostBillingPortalConfigurationsConfiguration'] + } + '/v1/billing_portal/sessions': { /**

Creates a session of the customer portal.

*/ - post: operations["PostBillingPortalSessions"]; - }; - "/v1/bitcoin/receivers": { + post: operations['PostBillingPortalSessions'] + } + '/v1/bitcoin/receivers': { /**

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

*/ - get: operations["GetBitcoinReceivers"]; - }; - "/v1/bitcoin/receivers/{id}": { + get: operations['GetBitcoinReceivers'] + } + '/v1/bitcoin/receivers/{id}': { /**

Retrieves the Bitcoin receiver with the given ID.

*/ - get: operations["GetBitcoinReceiversId"]; - }; - "/v1/bitcoin/receivers/{receiver}/transactions": { + get: operations['GetBitcoinReceiversId'] + } + '/v1/bitcoin/receivers/{receiver}/transactions': { /**

List bitcoin transacitons for a given receiver.

*/ - get: operations["GetBitcoinReceiversReceiverTransactions"]; - }; - "/v1/bitcoin/transactions": { + get: operations['GetBitcoinReceiversReceiverTransactions'] + } + '/v1/bitcoin/transactions': { /**

List bitcoin transacitons for a given receiver.

*/ - get: operations["GetBitcoinTransactions"]; - }; - "/v1/charges": { + get: operations['GetBitcoinTransactions'] + } + '/v1/charges': { /**

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

*/ - get: operations["GetCharges"]; + get: operations['GetCharges'] /**

To charge a credit card or other payment source, you create a Charge object. If your API key is in test mode, the supplied payment source (e.g., card) won’t actually be charged, although everything else will occur as if in live mode. (Stripe assumes that the charge would have completed successfully).

*/ - post: operations["PostCharges"]; - }; - "/v1/charges/{charge}": { + post: operations['PostCharges'] + } + '/v1/charges/{charge}': { /**

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.

*/ - get: operations["GetChargesCharge"]; + get: operations['GetChargesCharge'] /**

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

*/ - post: operations["PostChargesCharge"]; - }; - "/v1/charges/{charge}/capture": { + post: operations['PostChargesCharge'] + } + '/v1/charges/{charge}/capture': { /** *

Capture the payment of an existing, uncaptured, charge. This is the second half of the two-step payment flow, where first you created a charge with the capture option set to false.

* *

Uncaptured payments expire a set number of days after they are created (7 by default). If they are not captured by that point in time, they will be marked as refunded and will no longer be capturable.

*/ - post: operations["PostChargesChargeCapture"]; - }; - "/v1/charges/{charge}/dispute": { + post: operations['PostChargesChargeCapture'] + } + '/v1/charges/{charge}/dispute': { /**

Retrieve a dispute for a specified charge.

*/ - get: operations["GetChargesChargeDispute"]; - post: operations["PostChargesChargeDispute"]; - }; - "/v1/charges/{charge}/dispute/close": { - post: operations["PostChargesChargeDisputeClose"]; - }; - "/v1/charges/{charge}/refund": { + get: operations['GetChargesChargeDispute'] + post: operations['PostChargesChargeDispute'] + } + '/v1/charges/{charge}/dispute/close': { + post: operations['PostChargesChargeDisputeClose'] + } + '/v1/charges/{charge}/refund': { /** *

When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.

* @@ -391,71 +391,71 @@ export interface paths { * 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.

*/ - post: operations["PostChargesChargeRefund"]; - }; - "/v1/charges/{charge}/refunds": { + post: operations['PostChargesChargeRefund'] + } + '/v1/charges/{charge}/refunds': { /**

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.

*/ - get: operations["GetChargesChargeRefunds"]; + get: operations['GetChargesChargeRefunds'] /**

Create a refund.

*/ - post: operations["PostChargesChargeRefunds"]; - }; - "/v1/charges/{charge}/refunds/{refund}": { + post: operations['PostChargesChargeRefunds'] + } + '/v1/charges/{charge}/refunds/{refund}': { /**

Retrieves the details of an existing refund.

*/ - get: operations["GetChargesChargeRefundsRefund"]; + get: operations['GetChargesChargeRefundsRefund'] /**

Update a specified refund.

*/ - post: operations["PostChargesChargeRefundsRefund"]; - }; - "/v1/checkout/sessions": { + post: operations['PostChargesChargeRefundsRefund'] + } + '/v1/checkout/sessions': { /**

Returns a list of Checkout Sessions.

*/ - get: operations["GetCheckoutSessions"]; + get: operations['GetCheckoutSessions'] /**

Creates a Session object.

*/ - post: operations["PostCheckoutSessions"]; - }; - "/v1/checkout/sessions/{session}": { + post: operations['PostCheckoutSessions'] + } + '/v1/checkout/sessions/{session}': { /**

Retrieves a Session object.

*/ - get: operations["GetCheckoutSessionsSession"]; - }; - "/v1/checkout/sessions/{session}/expire": { + get: operations['GetCheckoutSessionsSession'] + } + '/v1/checkout/sessions/{session}/expire': { /** *

A Session can be expired when it is in one of these statuses: open

* *

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

*/ - post: operations["PostCheckoutSessionsSessionExpire"]; - }; - "/v1/checkout/sessions/{session}/line_items": { + post: operations['PostCheckoutSessionsSessionExpire'] + } + '/v1/checkout/sessions/{session}/line_items': { /**

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.

*/ - get: operations["GetCheckoutSessionsSessionLineItems"]; - }; - "/v1/country_specs": { + get: operations['GetCheckoutSessionsSessionLineItems'] + } + '/v1/country_specs': { /**

Lists all Country Spec objects available in the API.

*/ - get: operations["GetCountrySpecs"]; - }; - "/v1/country_specs/{country}": { + get: operations['GetCountrySpecs'] + } + '/v1/country_specs/{country}': { /**

Returns a Country Spec for a given Country code.

*/ - get: operations["GetCountrySpecsCountry"]; - }; - "/v1/coupons": { + get: operations['GetCountrySpecsCountry'] + } + '/v1/coupons': { /**

Returns a list of your coupons.

*/ - get: operations["GetCoupons"]; + get: operations['GetCoupons'] /** *

You can create coupons easily via the coupon management page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.

* *

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.

*/ - post: operations["PostCoupons"]; - }; - "/v1/coupons/{coupon}": { + post: operations['PostCoupons'] + } + '/v1/coupons/{coupon}': { /**

Retrieves the coupon with the given ID.

*/ - get: operations["GetCouponsCoupon"]; + get: operations['GetCouponsCoupon'] /**

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

*/ - post: operations["PostCouponsCoupon"]; + post: operations['PostCouponsCoupon'] /**

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.

*/ - delete: operations["DeleteCouponsCoupon"]; - }; - "/v1/credit_notes": { + delete: operations['DeleteCouponsCoupon'] + } + '/v1/credit_notes': { /**

Returns a list of credit notes.

*/ - get: operations["GetCreditNotes"]; + get: operations['GetCreditNotes'] /** *

Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces * its amount_due. For a status=paid invoice, a credit note does not affect its amount_due. Instead, it can result @@ -472,63 +472,63 @@ export interface paths { *

You may issue multiple credit notes for an invoice. Each credit note will increment the invoice’s pre_payment_credit_notes_amount * or post_payment_credit_notes_amount depending on its status at the time of credit note creation.

*/ - post: operations["PostCreditNotes"]; - }; - "/v1/credit_notes/preview": { + post: operations['PostCreditNotes'] + } + '/v1/credit_notes/preview': { /**

Get a preview of a credit note without creating it.

*/ - get: operations["GetCreditNotesPreview"]; - }; - "/v1/credit_notes/preview/lines": { + get: operations['GetCreditNotesPreview'] + } + '/v1/credit_notes/preview/lines': { /**

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.

*/ - get: operations["GetCreditNotesPreviewLines"]; - }; - "/v1/credit_notes/{credit_note}/lines": { + get: operations['GetCreditNotesPreviewLines'] + } + '/v1/credit_notes/{credit_note}/lines': { /**

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

*/ - get: operations["GetCreditNotesCreditNoteLines"]; - }; - "/v1/credit_notes/{id}": { + get: operations['GetCreditNotesCreditNoteLines'] + } + '/v1/credit_notes/{id}': { /**

Retrieves the credit note object with the given identifier.

*/ - get: operations["GetCreditNotesId"]; + get: operations['GetCreditNotesId'] /**

Updates an existing credit note.

*/ - post: operations["PostCreditNotesId"]; - }; - "/v1/credit_notes/{id}/void": { + post: operations['PostCreditNotesId'] + } + '/v1/credit_notes/{id}/void': { /**

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

*/ - post: operations["PostCreditNotesIdVoid"]; - }; - "/v1/customers": { + post: operations['PostCreditNotesIdVoid'] + } + '/v1/customers': { /**

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

*/ - get: operations["GetCustomers"]; + get: operations['GetCustomers'] /**

Creates a new customer object.

*/ - post: operations["PostCustomers"]; - }; - "/v1/customers/{customer}": { + post: operations['PostCustomers'] + } + '/v1/customers/{customer}': { /**

Retrieves a Customer object.

*/ - get: operations["GetCustomersCustomer"]; + get: operations['GetCustomersCustomer'] /** *

Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the source parameter, that becomes the customer’s active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the source parameter: for each of the customer’s current subscriptions, if the subscription bills automatically and is in the past_due state, then the latest open invoice for the subscription with automatic collection enabled will be retried. This retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice. Changing the default_source for a customer will not trigger this behavior.

* *

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

*/ - post: operations["PostCustomersCustomer"]; + post: operations['PostCustomersCustomer'] /**

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

*/ - delete: operations["DeleteCustomersCustomer"]; - }; - "/v1/customers/{customer}/balance_transactions": { + delete: operations['DeleteCustomersCustomer'] + } + '/v1/customers/{customer}/balance_transactions': { /**

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

*/ - get: operations["GetCustomersCustomerBalanceTransactions"]; + get: operations['GetCustomersCustomerBalanceTransactions'] /**

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

*/ - post: operations["PostCustomersCustomerBalanceTransactions"]; - }; - "/v1/customers/{customer}/balance_transactions/{transaction}": { + post: operations['PostCustomersCustomerBalanceTransactions'] + } + '/v1/customers/{customer}/balance_transactions/{transaction}': { /**

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

*/ - get: operations["GetCustomersCustomerBalanceTransactionsTransaction"]; + get: operations['GetCustomersCustomerBalanceTransactionsTransaction'] /**

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

*/ - post: operations["PostCustomersCustomerBalanceTransactionsTransaction"]; - }; - "/v1/customers/{customer}/bank_accounts": { + post: operations['PostCustomersCustomerBalanceTransactionsTransaction'] + } + '/v1/customers/{customer}/bank_accounts': { /**

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.

*/ - get: operations["GetCustomersCustomerBankAccounts"]; + get: operations['GetCustomersCustomerBankAccounts'] /** *

When you create a new credit card, you must specify a customer or recipient on which to create it.

* @@ -536,27 +536,27 @@ export interface paths { * 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.

*/ - post: operations["PostCustomersCustomerBankAccounts"]; - }; - "/v1/customers/{customer}/bank_accounts/{id}": { + post: operations['PostCustomersCustomerBankAccounts'] + } + '/v1/customers/{customer}/bank_accounts/{id}': { /**

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.

*/ - get: operations["GetCustomersCustomerBankAccountsId"]; + get: operations['GetCustomersCustomerBankAccountsId'] /**

Update a specified source for a given customer.

*/ - post: operations["PostCustomersCustomerBankAccountsId"]; + post: operations['PostCustomersCustomerBankAccountsId'] /**

Delete a specified source for a given customer.

*/ - delete: operations["DeleteCustomersCustomerBankAccountsId"]; - }; - "/v1/customers/{customer}/bank_accounts/{id}/verify": { + delete: operations['DeleteCustomersCustomerBankAccountsId'] + } + '/v1/customers/{customer}/bank_accounts/{id}/verify': { /**

Verify a specified bank account for a given customer.

*/ - post: operations["PostCustomersCustomerBankAccountsIdVerify"]; - }; - "/v1/customers/{customer}/cards": { + post: operations['PostCustomersCustomerBankAccountsIdVerify'] + } + '/v1/customers/{customer}/cards': { /** *

You can see a list of the cards belonging to a customer. * Note that the 10 most recent sources are always available on the Customer 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 cards.

*/ - get: operations["GetCustomersCustomerCards"]; + get: operations['GetCustomersCustomerCards'] /** *

When you create a new credit card, you must specify a customer or recipient on which to create it.

* @@ -564,28 +564,28 @@ export interface paths { * 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.

*/ - post: operations["PostCustomersCustomerCards"]; - }; - "/v1/customers/{customer}/cards/{id}": { + post: operations['PostCustomersCustomerCards'] + } + '/v1/customers/{customer}/cards/{id}': { /**

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.

*/ - get: operations["GetCustomersCustomerCardsId"]; + get: operations['GetCustomersCustomerCardsId'] /**

Update a specified source for a given customer.

*/ - post: operations["PostCustomersCustomerCardsId"]; + post: operations['PostCustomersCustomerCardsId'] /**

Delete a specified source for a given customer.

*/ - delete: operations["DeleteCustomersCustomerCardsId"]; - }; - "/v1/customers/{customer}/discount": { - get: operations["GetCustomersCustomerDiscount"]; + delete: operations['DeleteCustomersCustomerCardsId'] + } + '/v1/customers/{customer}/discount': { + get: operations['GetCustomersCustomerDiscount'] /**

Removes the currently applied discount on a customer.

*/ - delete: operations["DeleteCustomersCustomerDiscount"]; - }; - "/v1/customers/{customer}/payment_methods": { + delete: operations['DeleteCustomersCustomerDiscount'] + } + '/v1/customers/{customer}/payment_methods': { /**

Returns a list of PaymentMethods for a given Customer

*/ - get: operations["GetCustomersCustomerPaymentMethods"]; - }; - "/v1/customers/{customer}/sources": { + get: operations['GetCustomersCustomerPaymentMethods'] + } + '/v1/customers/{customer}/sources': { /**

List sources for a specified customer.

*/ - get: operations["GetCustomersCustomerSources"]; + get: operations['GetCustomersCustomerSources'] /** *

When you create a new credit card, you must specify a customer or recipient on which to create it.

* @@ -593,31 +593,31 @@ export interface paths { * 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.

*/ - post: operations["PostCustomersCustomerSources"]; - }; - "/v1/customers/{customer}/sources/{id}": { + post: operations['PostCustomersCustomerSources'] + } + '/v1/customers/{customer}/sources/{id}': { /**

Retrieve a specified source for a given customer.

*/ - get: operations["GetCustomersCustomerSourcesId"]; + get: operations['GetCustomersCustomerSourcesId'] /**

Update a specified source for a given customer.

*/ - post: operations["PostCustomersCustomerSourcesId"]; + post: operations['PostCustomersCustomerSourcesId'] /**

Delete a specified source for a given customer.

*/ - delete: operations["DeleteCustomersCustomerSourcesId"]; - }; - "/v1/customers/{customer}/sources/{id}/verify": { + delete: operations['DeleteCustomersCustomerSourcesId'] + } + '/v1/customers/{customer}/sources/{id}/verify': { /**

Verify a specified bank account for a given customer.

*/ - post: operations["PostCustomersCustomerSourcesIdVerify"]; - }; - "/v1/customers/{customer}/subscriptions": { + post: operations['PostCustomersCustomerSourcesIdVerify'] + } + '/v1/customers/{customer}/subscriptions': { /**

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.

*/ - get: operations["GetCustomersCustomerSubscriptions"]; + get: operations['GetCustomersCustomerSubscriptions'] /**

Creates a new subscription on an existing customer.

*/ - post: operations["PostCustomersCustomerSubscriptions"]; - }; - "/v1/customers/{customer}/subscriptions/{subscription_exposed_id}": { + post: operations['PostCustomersCustomerSubscriptions'] + } + '/v1/customers/{customer}/subscriptions/{subscription_exposed_id}': { /**

Retrieves the subscription with the given ID.

*/ - get: operations["GetCustomersCustomerSubscriptionsSubscriptionExposedId"]; + get: operations['GetCustomersCustomerSubscriptionsSubscriptionExposedId'] /**

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.

*/ - post: operations["PostCustomersCustomerSubscriptionsSubscriptionExposedId"]; + post: operations['PostCustomersCustomerSubscriptionsSubscriptionExposedId'] /** *

Cancels a customer’s subscription. If you set the at_period_end parameter to true, the subscription will remain active until the end of the period, at which point it will be canceled and not renewed. Otherwise, with the default false value, the subscription is terminated immediately. In either case, the customer will not be charged again for the subscription.

* @@ -625,108 +625,108 @@ export interface paths { * *

By default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.

*/ - delete: operations["DeleteCustomersCustomerSubscriptionsSubscriptionExposedId"]; - }; - "/v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discount": { - get: operations["GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount"]; + delete: operations['DeleteCustomersCustomerSubscriptionsSubscriptionExposedId'] + } + '/v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discount': { + get: operations['GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount'] /**

Removes the currently applied discount on a customer.

*/ - delete: operations["DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount"]; - }; - "/v1/customers/{customer}/tax_ids": { + delete: operations['DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount'] + } + '/v1/customers/{customer}/tax_ids': { /**

Returns a list of tax IDs for a customer.

*/ - get: operations["GetCustomersCustomerTaxIds"]; + get: operations['GetCustomersCustomerTaxIds'] /**

Creates a new TaxID object for a customer.

*/ - post: operations["PostCustomersCustomerTaxIds"]; - }; - "/v1/customers/{customer}/tax_ids/{id}": { + post: operations['PostCustomersCustomerTaxIds'] + } + '/v1/customers/{customer}/tax_ids/{id}': { /**

Retrieves the TaxID object with the given identifier.

*/ - get: operations["GetCustomersCustomerTaxIdsId"]; + get: operations['GetCustomersCustomerTaxIdsId'] /**

Deletes an existing TaxID object.

*/ - delete: operations["DeleteCustomersCustomerTaxIdsId"]; - }; - "/v1/disputes": { + delete: operations['DeleteCustomersCustomerTaxIdsId'] + } + '/v1/disputes': { /**

Returns a list of your disputes.

*/ - get: operations["GetDisputes"]; - }; - "/v1/disputes/{dispute}": { + get: operations['GetDisputes'] + } + '/v1/disputes/{dispute}': { /**

Retrieves the dispute with the given ID.

*/ - get: operations["GetDisputesDispute"]; + get: operations['GetDisputesDispute'] /** *

When you get a dispute, contacting your customer is always the best first step. If that doesn’t work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your dashboard, but if you prefer, you can use the API to submit evidence programmatically.

* *

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.

*/ - post: operations["PostDisputesDispute"]; - }; - "/v1/disputes/{dispute}/close": { + post: operations['PostDisputesDispute'] + } + '/v1/disputes/{dispute}/close': { /** *

Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.

* *

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

*/ - post: operations["PostDisputesDisputeClose"]; - }; - "/v1/ephemeral_keys": { + post: operations['PostDisputesDisputeClose'] + } + '/v1/ephemeral_keys': { /**

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

*/ - post: operations["PostEphemeralKeys"]; - }; - "/v1/ephemeral_keys/{key}": { + post: operations['PostEphemeralKeys'] + } + '/v1/ephemeral_keys/{key}': { /**

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

*/ - delete: operations["DeleteEphemeralKeysKey"]; - }; - "/v1/events": { + delete: operations['DeleteEphemeralKeysKey'] + } + '/v1/events': { /**

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).

*/ - get: operations["GetEvents"]; - }; - "/v1/events/{id}": { + get: operations['GetEvents'] + } + '/v1/events/{id}': { /**

Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.

*/ - get: operations["GetEventsId"]; - }; - "/v1/exchange_rates": { + get: operations['GetEventsId'] + } + '/v1/exchange_rates': { /**

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.

*/ - get: operations["GetExchangeRates"]; - }; - "/v1/exchange_rates/{rate_id}": { + get: operations['GetExchangeRates'] + } + '/v1/exchange_rates/{rate_id}': { /**

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

*/ - get: operations["GetExchangeRatesRateId"]; - }; - "/v1/file_links": { + get: operations['GetExchangeRatesRateId'] + } + '/v1/file_links': { /**

Returns a list of file links.

*/ - get: operations["GetFileLinks"]; + get: operations['GetFileLinks'] /**

Creates a new file link object.

*/ - post: operations["PostFileLinks"]; - }; - "/v1/file_links/{link}": { + post: operations['PostFileLinks'] + } + '/v1/file_links/{link}': { /**

Retrieves the file link with the given ID.

*/ - get: operations["GetFileLinksLink"]; + get: operations['GetFileLinksLink'] /**

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

*/ - post: operations["PostFileLinksLink"]; - }; - "/v1/files": { + post: operations['PostFileLinksLink'] + } + '/v1/files': { /**

Returns a list of the files that your account has access to. The files are returned sorted by creation date, with the most recently created files appearing first.

*/ - get: operations["GetFiles"]; + get: operations['GetFiles'] /** *

To upload a file to Stripe, you’ll need to send a request of type multipart/form-data. The request should contain the file you would like to upload, as well as the parameters for creating a file.

* *

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

*/ - post: operations["PostFiles"]; - }; - "/v1/files/{file}": { + post: operations['PostFiles'] + } + '/v1/files/{file}': { /**

Retrieves the details of an existing file object. Supply the unique file ID from a file, and Stripe will return the corresponding file object. To access file contents, see the File Upload Guide.

*/ - get: operations["GetFilesFile"]; - }; - "/v1/identity/verification_reports": { + get: operations['GetFilesFile'] + } + '/v1/identity/verification_reports': { /**

List all verification reports.

*/ - get: operations["GetIdentityVerificationReports"]; - }; - "/v1/identity/verification_reports/{report}": { + get: operations['GetIdentityVerificationReports'] + } + '/v1/identity/verification_reports/{report}': { /**

Retrieves an existing VerificationReport

*/ - get: operations["GetIdentityVerificationReportsReport"]; - }; - "/v1/identity/verification_sessions": { + get: operations['GetIdentityVerificationReportsReport'] + } + '/v1/identity/verification_sessions': { /**

Returns a list of VerificationSessions

*/ - get: operations["GetIdentityVerificationSessions"]; + get: operations['GetIdentityVerificationSessions'] /** *

Creates a VerificationSession object.

* @@ -736,33 +736,33 @@ export interface paths { * *

Related guide: Verify your users’ identity documents.

*/ - post: operations["PostIdentityVerificationSessions"]; - }; - "/v1/identity/verification_sessions/{session}": { + post: operations['PostIdentityVerificationSessions'] + } + '/v1/identity/verification_sessions/{session}': { /** *

Retrieves the details of a VerificationSession that was previously created.

* *

When the session status is requires_input, you can use this method to retrieve a valid * client_secret or url to allow re-submission.

*/ - get: operations["GetIdentityVerificationSessionsSession"]; + get: operations['GetIdentityVerificationSessionsSession'] /** *

Updates a VerificationSession object.

* *

When the session status is requires_input, you can use this method to update the * verification check and options.

*/ - post: operations["PostIdentityVerificationSessionsSession"]; - }; - "/v1/identity/verification_sessions/{session}/cancel": { + post: operations['PostIdentityVerificationSessionsSession'] + } + '/v1/identity/verification_sessions/{session}/cancel': { /** *

A VerificationSession object can be canceled when it is in requires_input status.

* *

Once canceled, future submission attempts are disabled. This cannot be undone. Learn more.

*/ - post: operations["PostIdentityVerificationSessionsSessionCancel"]; - }; - "/v1/identity/verification_sessions/{session}/redact": { + post: operations['PostIdentityVerificationSessionsSessionCancel'] + } + '/v1/identity/verification_sessions/{session}/redact': { /** *

Redact a VerificationSession to remove all collected information from Stripe. This will redact * the VerificationSession and all objects related to it, including VerificationReports, Events, @@ -784,29 +784,29 @@ export interface paths { * *

Learn more.

*/ - post: operations["PostIdentityVerificationSessionsSessionRedact"]; - }; - "/v1/invoiceitems": { + post: operations['PostIdentityVerificationSessionsSessionRedact'] + } + '/v1/invoiceitems': { /**

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

*/ - get: operations["GetInvoiceitems"]; + get: operations['GetInvoiceitems'] /**

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.

*/ - post: operations["PostInvoiceitems"]; - }; - "/v1/invoiceitems/{invoiceitem}": { + post: operations['PostInvoiceitems'] + } + '/v1/invoiceitems/{invoiceitem}': { /**

Retrieves the invoice item with the given ID.

*/ - get: operations["GetInvoiceitemsInvoiceitem"]; + get: operations['GetInvoiceitemsInvoiceitem'] /**

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.

*/ - post: operations["PostInvoiceitemsInvoiceitem"]; + post: operations['PostInvoiceitemsInvoiceitem'] /**

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.

*/ - delete: operations["DeleteInvoiceitemsInvoiceitem"]; - }; - "/v1/invoices": { + delete: operations['DeleteInvoiceitemsInvoiceitem'] + } + '/v1/invoices': { /**

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.

*/ - get: operations["GetInvoices"]; + get: operations['GetInvoices'] /**

This endpoint creates a draft invoice for a given customer. The draft invoice created pulls in all pending invoice items on that customer, including prorations. The invoice remains a draft until you finalize the invoice, which allows you to pay or send the invoice to your customers.

*/ - post: operations["PostInvoices"]; - }; - "/v1/invoices/upcoming": { + post: operations['PostInvoices'] + } + '/v1/invoices/upcoming': { /** *

At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.

* @@ -814,15 +814,15 @@ export interface paths { * *

You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass a proration_date parameter when doing the actual subscription update. The value passed in should be the same as the subscription_proration_date returned on the upcoming invoice resource. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_proration_date on the upcoming invoice resource.

*/ - get: operations["GetInvoicesUpcoming"]; - }; - "/v1/invoices/upcoming/lines": { + get: operations['GetInvoicesUpcoming'] + } + '/v1/invoices/upcoming/lines': { /**

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.

*/ - get: operations["GetInvoicesUpcomingLines"]; - }; - "/v1/invoices/{invoice}": { + get: operations['GetInvoicesUpcomingLines'] + } + '/v1/invoices/{invoice}': { /**

Retrieves the invoice with the given ID.

*/ - get: operations["GetInvoicesInvoice"]; + get: operations['GetInvoicesInvoice'] /** *

Draft invoices are fully editable. Once an invoice is finalized, * monetary values, as well as collection_method, become uneditable.

@@ -831,163 +831,163 @@ export interface paths { * sending reminders for, or automatically reconciling invoices, pass * auto_advance=false.

*/ - post: operations["PostInvoicesInvoice"]; + post: operations['PostInvoicesInvoice'] /**

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.

*/ - delete: operations["DeleteInvoicesInvoice"]; - }; - "/v1/invoices/{invoice}/finalize": { + delete: operations['DeleteInvoicesInvoice'] + } + '/v1/invoices/{invoice}/finalize': { /**

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.

*/ - post: operations["PostInvoicesInvoiceFinalize"]; - }; - "/v1/invoices/{invoice}/lines": { + post: operations['PostInvoicesInvoiceFinalize'] + } + '/v1/invoices/{invoice}/lines': { /**

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.

*/ - get: operations["GetInvoicesInvoiceLines"]; - }; - "/v1/invoices/{invoice}/mark_uncollectible": { + get: operations['GetInvoicesInvoiceLines'] + } + '/v1/invoices/{invoice}/mark_uncollectible': { /**

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

*/ - post: operations["PostInvoicesInvoiceMarkUncollectible"]; - }; - "/v1/invoices/{invoice}/pay": { + post: operations['PostInvoicesInvoiceMarkUncollectible'] + } + '/v1/invoices/{invoice}/pay': { /**

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.

*/ - post: operations["PostInvoicesInvoicePay"]; - }; - "/v1/invoices/{invoice}/send": { + post: operations['PostInvoicesInvoicePay'] + } + '/v1/invoices/{invoice}/send': { /** *

Stripe will automatically send invoices to customers according to your subscriptions settings. However, if you’d like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.

* *

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

*/ - post: operations["PostInvoicesInvoiceSend"]; - }; - "/v1/invoices/{invoice}/void": { + post: operations['PostInvoicesInvoiceSend'] + } + '/v1/invoices/{invoice}/void': { /**

Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.

*/ - post: operations["PostInvoicesInvoiceVoid"]; - }; - "/v1/issuer_fraud_records": { + post: operations['PostInvoicesInvoiceVoid'] + } + '/v1/issuer_fraud_records': { /**

Returns a list of issuer fraud records.

*/ - get: operations["GetIssuerFraudRecords"]; - }; - "/v1/issuer_fraud_records/{issuer_fraud_record}": { + get: operations['GetIssuerFraudRecords'] + } + '/v1/issuer_fraud_records/{issuer_fraud_record}': { /** *

Retrieves the details of an issuer fraud record that has previously been created.

* *

Please refer to the issuer fraud record object reference for more details.

*/ - get: operations["GetIssuerFraudRecordsIssuerFraudRecord"]; - }; - "/v1/issuing/authorizations": { + get: operations['GetIssuerFraudRecordsIssuerFraudRecord'] + } + '/v1/issuing/authorizations': { /**

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.

*/ - get: operations["GetIssuingAuthorizations"]; - }; - "/v1/issuing/authorizations/{authorization}": { + get: operations['GetIssuingAuthorizations'] + } + '/v1/issuing/authorizations/{authorization}': { /**

Retrieves an Issuing Authorization object.

*/ - get: operations["GetIssuingAuthorizationsAuthorization"]; + get: operations['GetIssuingAuthorizationsAuthorization'] /**

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

*/ - post: operations["PostIssuingAuthorizationsAuthorization"]; - }; - "/v1/issuing/authorizations/{authorization}/approve": { + post: operations['PostIssuingAuthorizationsAuthorization'] + } + '/v1/issuing/authorizations/{authorization}/approve': { /**

Approves a pending Issuing Authorization object. This request should be made within the timeout window of the real-time authorization flow.

*/ - post: operations["PostIssuingAuthorizationsAuthorizationApprove"]; - }; - "/v1/issuing/authorizations/{authorization}/decline": { + post: operations['PostIssuingAuthorizationsAuthorizationApprove'] + } + '/v1/issuing/authorizations/{authorization}/decline': { /**

Declines a pending Issuing Authorization object. This request should be made within the timeout window of the real time authorization flow.

*/ - post: operations["PostIssuingAuthorizationsAuthorizationDecline"]; - }; - "/v1/issuing/cardholders": { + post: operations['PostIssuingAuthorizationsAuthorizationDecline'] + } + '/v1/issuing/cardholders': { /**

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

*/ - get: operations["GetIssuingCardholders"]; + get: operations['GetIssuingCardholders'] /**

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

*/ - post: operations["PostIssuingCardholders"]; - }; - "/v1/issuing/cardholders/{cardholder}": { + post: operations['PostIssuingCardholders'] + } + '/v1/issuing/cardholders/{cardholder}': { /**

Retrieves an Issuing Cardholder object.

*/ - get: operations["GetIssuingCardholdersCardholder"]; + get: operations['GetIssuingCardholdersCardholder'] /**

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

*/ - post: operations["PostIssuingCardholdersCardholder"]; - }; - "/v1/issuing/cards": { + post: operations['PostIssuingCardholdersCardholder'] + } + '/v1/issuing/cards': { /**

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

*/ - get: operations["GetIssuingCards"]; + get: operations['GetIssuingCards'] /**

Creates an Issuing Card object.

*/ - post: operations["PostIssuingCards"]; - }; - "/v1/issuing/cards/{card}": { + post: operations['PostIssuingCards'] + } + '/v1/issuing/cards/{card}': { /**

Retrieves an Issuing Card object.

*/ - get: operations["GetIssuingCardsCard"]; + get: operations['GetIssuingCardsCard'] /**

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

*/ - post: operations["PostIssuingCardsCard"]; - }; - "/v1/issuing/disputes": { + post: operations['PostIssuingCardsCard'] + } + '/v1/issuing/disputes': { /**

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

*/ - get: operations["GetIssuingDisputes"]; + get: operations['GetIssuingDisputes'] /**

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.

*/ - post: operations["PostIssuingDisputes"]; - }; - "/v1/issuing/disputes/{dispute}": { + post: operations['PostIssuingDisputes'] + } + '/v1/issuing/disputes/{dispute}': { /**

Retrieves an Issuing Dispute object.

*/ - get: operations["GetIssuingDisputesDispute"]; + get: operations['GetIssuingDisputesDispute'] /**

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.

*/ - post: operations["PostIssuingDisputesDispute"]; - }; - "/v1/issuing/disputes/{dispute}/submit": { + post: operations['PostIssuingDisputesDispute'] + } + '/v1/issuing/disputes/{dispute}/submit': { /**

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.

*/ - post: operations["PostIssuingDisputesDisputeSubmit"]; - }; - "/v1/issuing/settlements": { + post: operations['PostIssuingDisputesDisputeSubmit'] + } + '/v1/issuing/settlements': { /**

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

*/ - get: operations["GetIssuingSettlements"]; - }; - "/v1/issuing/settlements/{settlement}": { + get: operations['GetIssuingSettlements'] + } + '/v1/issuing/settlements/{settlement}': { /**

Retrieves an Issuing Settlement object.

*/ - get: operations["GetIssuingSettlementsSettlement"]; + get: operations['GetIssuingSettlementsSettlement'] /**

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

*/ - post: operations["PostIssuingSettlementsSettlement"]; - }; - "/v1/issuing/transactions": { + post: operations['PostIssuingSettlementsSettlement'] + } + '/v1/issuing/transactions': { /**

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.

*/ - get: operations["GetIssuingTransactions"]; - }; - "/v1/issuing/transactions/{transaction}": { + get: operations['GetIssuingTransactions'] + } + '/v1/issuing/transactions/{transaction}': { /**

Retrieves an Issuing Transaction object.

*/ - get: operations["GetIssuingTransactionsTransaction"]; + get: operations['GetIssuingTransactionsTransaction'] /**

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

*/ - post: operations["PostIssuingTransactionsTransaction"]; - }; - "/v1/mandates/{mandate}": { + post: operations['PostIssuingTransactionsTransaction'] + } + '/v1/mandates/{mandate}': { /**

Retrieves a Mandate object.

*/ - get: operations["GetMandatesMandate"]; - }; - "/v1/order_returns": { + get: operations['GetMandatesMandate'] + } + '/v1/order_returns': { /**

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

*/ - get: operations["GetOrderReturns"]; - }; - "/v1/order_returns/{id}": { + get: operations['GetOrderReturns'] + } + '/v1/order_returns/{id}': { /**

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

*/ - get: operations["GetOrderReturnsId"]; - }; - "/v1/orders": { + get: operations['GetOrderReturnsId'] + } + '/v1/orders': { /**

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

*/ - get: operations["GetOrders"]; + get: operations['GetOrders'] /**

Creates a new order object.

*/ - post: operations["PostOrders"]; - }; - "/v1/orders/{id}": { + post: operations['PostOrders'] + } + '/v1/orders/{id}': { /**

Retrieves the details of an existing order. Supply the unique order ID from either an order creation request or the order list, and Stripe will return the corresponding order information.

*/ - get: operations["GetOrdersId"]; + get: operations['GetOrdersId'] /**

Updates the specific order by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ - post: operations["PostOrdersId"]; - }; - "/v1/orders/{id}/pay": { + post: operations['PostOrdersId'] + } + '/v1/orders/{id}/pay': { /**

Pay an order by providing a source to create a payment.

*/ - post: operations["PostOrdersIdPay"]; - }; - "/v1/orders/{id}/returns": { + post: operations['PostOrdersIdPay'] + } + '/v1/orders/{id}/returns': { /**

Return all or part of an order. The order must have a status of paid or fulfilled before it can be returned. Once all items have been returned, the order will become canceled or returned depending on which status the order started in.

*/ - post: operations["PostOrdersIdReturns"]; - }; - "/v1/payment_intents": { + post: operations['PostOrdersIdReturns'] + } + '/v1/payment_intents': { /**

Returns a list of PaymentIntents.

*/ - get: operations["GetPaymentIntents"]; + get: operations['GetPaymentIntents'] /** *

Creates a PaymentIntent object.

* @@ -1000,9 +1000,9 @@ export interface paths { * available in the confirm API when confirm=true * is supplied.

*/ - post: operations["PostPaymentIntents"]; - }; - "/v1/payment_intents/{intent}": { + post: operations['PostPaymentIntents'] + } + '/v1/payment_intents/{intent}': { /** *

Retrieves the details of a PaymentIntent that has previously been created.

* @@ -1010,7 +1010,7 @@ export interface paths { * *

When retrieved with a publishable key, only a subset of properties will be returned. Please refer to the payment intent object reference for more details.

*/ - get: operations["GetPaymentIntentsIntent"]; + get: operations['GetPaymentIntentsIntent'] /** *

Updates properties on a PaymentIntent object without confirming.

* @@ -1020,17 +1020,17 @@ export interface paths { * update and confirm at the same time, we recommend updating properties via * the confirm API instead.

*/ - post: operations["PostPaymentIntentsIntent"]; - }; - "/v1/payment_intents/{intent}/cancel": { + post: operations['PostPaymentIntentsIntent'] + } + '/v1/payment_intents/{intent}/cancel': { /** *

A PaymentIntent object can be canceled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action, or processing.

* *

Once canceled, no additional charges will be made by the PaymentIntent and any operations on the PaymentIntent will fail with an error. For PaymentIntents with status=’requires_capture’, the remaining amount_capturable will automatically be refunded.

*/ - post: operations["PostPaymentIntentsIntentCancel"]; - }; - "/v1/payment_intents/{intent}/capture": { + post: operations['PostPaymentIntentsIntentCancel'] + } + '/v1/payment_intents/{intent}/capture': { /** *

Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.

* @@ -1038,9 +1038,9 @@ export interface paths { * *

Learn more about separate authorization and capture.

*/ - post: operations["PostPaymentIntentsIntentCapture"]; - }; - "/v1/payment_intents/{intent}/confirm": { + post: operations['PostPaymentIntentsIntentCapture'] + } + '/v1/payment_intents/{intent}/confirm': { /** *

Confirm that your customer intends to pay with current or provided * payment method. Upon confirmation, the PaymentIntent will attempt to initiate @@ -1068,45 +1068,45 @@ export interface paths { * attempt. Read the expanded documentation * to learn more about manual confirmation.

*/ - post: operations["PostPaymentIntentsIntentConfirm"]; - }; - "/v1/payment_intents/{intent}/verify_microdeposits": { + post: operations['PostPaymentIntentsIntentConfirm'] + } + '/v1/payment_intents/{intent}/verify_microdeposits': { /**

Verifies microdeposits on a PaymentIntent object.

*/ - post: operations["PostPaymentIntentsIntentVerifyMicrodeposits"]; - }; - "/v1/payment_links": { + post: operations['PostPaymentIntentsIntentVerifyMicrodeposits'] + } + '/v1/payment_links': { /**

Returns a list of your payment links.

*/ - get: operations["GetPaymentLinks"]; + get: operations['GetPaymentLinks'] /**

Creates a payment link.

*/ - post: operations["PostPaymentLinks"]; - }; - "/v1/payment_links/{payment_link}": { + post: operations['PostPaymentLinks'] + } + '/v1/payment_links/{payment_link}': { /**

Retrieve a payment link.

*/ - get: operations["GetPaymentLinksPaymentLink"]; + get: operations['GetPaymentLinksPaymentLink'] /**

Updates a payment link.

*/ - post: operations["PostPaymentLinksPaymentLink"]; - }; - "/v1/payment_links/{payment_link}/line_items": { + post: operations['PostPaymentLinksPaymentLink'] + } + '/v1/payment_links/{payment_link}/line_items': { /**

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.

*/ - get: operations["GetPaymentLinksPaymentLinkLineItems"]; - }; - "/v1/payment_methods": { + get: operations['GetPaymentLinksPaymentLinkLineItems'] + } + '/v1/payment_methods': { /**

Returns a list of PaymentMethods. For listing a customer’s payment methods, you should use List a Customer’s PaymentMethods

*/ - get: operations["GetPaymentMethods"]; + get: operations['GetPaymentMethods'] /** *

Creates a PaymentMethod object. Read the Stripe.js reference to learn how to create PaymentMethods via Stripe.js.

* *

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.

*/ - post: operations["PostPaymentMethods"]; - }; - "/v1/payment_methods/{payment_method}": { + post: operations['PostPaymentMethods'] + } + '/v1/payment_methods/{payment_method}': { /**

Retrieves a PaymentMethod object.

*/ - get: operations["GetPaymentMethodsPaymentMethod"]; + get: operations['GetPaymentMethodsPaymentMethod'] /**

Updates a PaymentMethod object. A PaymentMethod must be attached a customer to be updated.

*/ - post: operations["PostPaymentMethodsPaymentMethod"]; - }; - "/v1/payment_methods/{payment_method}/attach": { + post: operations['PostPaymentMethodsPaymentMethod'] + } + '/v1/payment_methods/{payment_method}/attach': { /** *

Attaches a PaymentMethod object to a Customer.

* @@ -1120,15 +1120,15 @@ export interface paths { * set invoice_settings.default_payment_method, * on the Customer to the PaymentMethod’s ID.

*/ - post: operations["PostPaymentMethodsPaymentMethodAttach"]; - }; - "/v1/payment_methods/{payment_method}/detach": { + post: operations['PostPaymentMethodsPaymentMethodAttach'] + } + '/v1/payment_methods/{payment_method}/detach': { /**

Detaches a PaymentMethod object from a Customer.

*/ - post: operations["PostPaymentMethodsPaymentMethodDetach"]; - }; - "/v1/payouts": { + post: operations['PostPaymentMethodsPaymentMethodDetach'] + } + '/v1/payouts': { /**

Returns a list of existing payouts sent to third-party bank accounts or that Stripe has sent you. The payouts are returned in sorted order, with the most recently created payouts appearing first.

*/ - get: operations["GetPayouts"]; + get: operations['GetPayouts'] /** *

To send funds to your own bank account, you create a new payout object. Your Stripe balance must be able to cover the payout amount, or you’ll receive an “Insufficient Funds” error.

* @@ -1136,164 +1136,164 @@ export interface paths { * *

If you are creating a manual payout on a Stripe account that uses multiple payment source types, you’ll need to specify the source type balance that the payout should draw from. The balance object details available and pending amounts by source type.

*/ - post: operations["PostPayouts"]; - }; - "/v1/payouts/{payout}": { + post: operations['PostPayouts'] + } + '/v1/payouts/{payout}': { /**

Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list, and Stripe will return the corresponding payout information.

*/ - get: operations["GetPayoutsPayout"]; + get: operations['GetPayoutsPayout'] /**

Updates the specified payout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request accepts only the metadata as arguments.

*/ - post: operations["PostPayoutsPayout"]; - }; - "/v1/payouts/{payout}/cancel": { + post: operations['PostPayoutsPayout'] + } + '/v1/payouts/{payout}/cancel': { /**

A previously created payout can be canceled if it has not yet been paid out. Funds will be refunded to your available balance. You may not cancel automatic Stripe payouts.

*/ - post: operations["PostPayoutsPayoutCancel"]; - }; - "/v1/payouts/{payout}/reverse": { + post: operations['PostPayoutsPayoutCancel'] + } + '/v1/payouts/{payout}/reverse': { /** *

Reverses a payout by debiting the destination bank account. Only payouts for connected accounts to US bank accounts may be reversed at this time. If the payout is in the pending status, /v1/payouts/:id/cancel should be used instead.

* *

By requesting a reversal via /v1/payouts/:id/reverse, you confirm that the authorized signatory of the selected bank account has authorized the debit on the bank account and that no other authorization is required.

*/ - post: operations["PostPayoutsPayoutReverse"]; - }; - "/v1/plans": { + post: operations['PostPayoutsPayoutReverse'] + } + '/v1/plans': { /**

Returns a list of your plans.

*/ - get: operations["GetPlans"]; + get: operations['GetPlans'] /**

You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.

*/ - post: operations["PostPlans"]; - }; - "/v1/plans/{plan}": { + post: operations['PostPlans'] + } + '/v1/plans/{plan}': { /**

Retrieves the plan with the given ID.

*/ - get: operations["GetPlansPlan"]; + get: operations['GetPlansPlan'] /**

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.

*/ - post: operations["PostPlansPlan"]; + post: operations['PostPlansPlan'] /**

Deleting plans means new subscribers can’t be added. Existing subscribers aren’t affected.

*/ - delete: operations["DeletePlansPlan"]; - }; - "/v1/prices": { + delete: operations['DeletePlansPlan'] + } + '/v1/prices': { /**

Returns a list of your prices.

*/ - get: operations["GetPrices"]; + get: operations['GetPrices'] /**

Creates a new price for an existing product. The price can be recurring or one-time.

*/ - post: operations["PostPrices"]; - }; - "/v1/prices/{price}": { + post: operations['PostPrices'] + } + '/v1/prices/{price}': { /**

Retrieves the price with the given ID.

*/ - get: operations["GetPricesPrice"]; + get: operations['GetPricesPrice'] /**

Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged.

*/ - post: operations["PostPricesPrice"]; - }; - "/v1/products": { + post: operations['PostPricesPrice'] + } + '/v1/products': { /**

Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.

*/ - get: operations["GetProducts"]; + get: operations['GetProducts'] /**

Creates a new product object.

*/ - post: operations["PostProducts"]; - }; - "/v1/products/{id}": { + post: operations['PostProducts'] + } + '/v1/products/{id}': { /**

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.

*/ - get: operations["GetProductsId"]; + get: operations['GetProductsId'] /**

Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ - post: operations["PostProductsId"]; + post: operations['PostProductsId'] /**

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.

*/ - delete: operations["DeleteProductsId"]; - }; - "/v1/promotion_codes": { + delete: operations['DeleteProductsId'] + } + '/v1/promotion_codes': { /**

Returns a list of your promotion codes.

*/ - get: operations["GetPromotionCodes"]; + get: operations['GetPromotionCodes'] /**

A promotion code points to a coupon. You can optionally restrict the code to a specific customer, redemption limit, and expiration date.

*/ - post: operations["PostPromotionCodes"]; - }; - "/v1/promotion_codes/{promotion_code}": { + post: operations['PostPromotionCodes'] + } + '/v1/promotion_codes/{promotion_code}': { /**

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.

*/ - get: operations["GetPromotionCodesPromotionCode"]; + get: operations['GetPromotionCodesPromotionCode'] /**

Updates the specified promotion code by setting the values of the parameters passed. Most fields are, by design, not editable.

*/ - post: operations["PostPromotionCodesPromotionCode"]; - }; - "/v1/quotes": { + post: operations['PostPromotionCodesPromotionCode'] + } + '/v1/quotes': { /**

Returns a list of your quotes.

*/ - get: operations["GetQuotes"]; + get: operations['GetQuotes'] /**

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.

*/ - post: operations["PostQuotes"]; - }; - "/v1/quotes/{quote}": { + post: operations['PostQuotes'] + } + '/v1/quotes/{quote}': { /**

Retrieves the quote with the given ID.

*/ - get: operations["GetQuotesQuote"]; + get: operations['GetQuotesQuote'] /**

A quote models prices and services for a customer.

*/ - post: operations["PostQuotesQuote"]; - }; - "/v1/quotes/{quote}/accept": { + post: operations['PostQuotesQuote'] + } + '/v1/quotes/{quote}/accept': { /**

Accepts the specified quote.

*/ - post: operations["PostQuotesQuoteAccept"]; - }; - "/v1/quotes/{quote}/cancel": { + post: operations['PostQuotesQuoteAccept'] + } + '/v1/quotes/{quote}/cancel': { /**

Cancels the quote.

*/ - post: operations["PostQuotesQuoteCancel"]; - }; - "/v1/quotes/{quote}/computed_upfront_line_items": { + post: operations['PostQuotesQuoteCancel'] + } + '/v1/quotes/{quote}/computed_upfront_line_items': { /**

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.

*/ - get: operations["GetQuotesQuoteComputedUpfrontLineItems"]; - }; - "/v1/quotes/{quote}/finalize": { + get: operations['GetQuotesQuoteComputedUpfrontLineItems'] + } + '/v1/quotes/{quote}/finalize': { /**

Finalizes the quote.

*/ - post: operations["PostQuotesQuoteFinalize"]; - }; - "/v1/quotes/{quote}/line_items": { + post: operations['PostQuotesQuoteFinalize'] + } + '/v1/quotes/{quote}/line_items': { /**

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.

*/ - get: operations["GetQuotesQuoteLineItems"]; - }; - "/v1/quotes/{quote}/pdf": { + get: operations['GetQuotesQuoteLineItems'] + } + '/v1/quotes/{quote}/pdf': { /**

Download the PDF for a finalized quote

*/ - get: operations["GetQuotesQuotePdf"]; - }; - "/v1/radar/early_fraud_warnings": { + get: operations['GetQuotesQuotePdf'] + } + '/v1/radar/early_fraud_warnings': { /**

Returns a list of early fraud warnings.

*/ - get: operations["GetRadarEarlyFraudWarnings"]; - }; - "/v1/radar/early_fraud_warnings/{early_fraud_warning}": { + get: operations['GetRadarEarlyFraudWarnings'] + } + '/v1/radar/early_fraud_warnings/{early_fraud_warning}': { /** *

Retrieves the details of an early fraud warning that has previously been created.

* *

Please refer to the early fraud warning object reference for more details.

*/ - get: operations["GetRadarEarlyFraudWarningsEarlyFraudWarning"]; - }; - "/v1/radar/value_list_items": { + get: operations['GetRadarEarlyFraudWarningsEarlyFraudWarning'] + } + '/v1/radar/value_list_items': { /**

Returns a list of ValueListItem objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

*/ - get: operations["GetRadarValueListItems"]; + get: operations['GetRadarValueListItems'] /**

Creates a new ValueListItem object, which is added to the specified parent value list.

*/ - post: operations["PostRadarValueListItems"]; - }; - "/v1/radar/value_list_items/{item}": { + post: operations['PostRadarValueListItems'] + } + '/v1/radar/value_list_items/{item}': { /**

Retrieves a ValueListItem object.

*/ - get: operations["GetRadarValueListItemsItem"]; + get: operations['GetRadarValueListItemsItem'] /**

Deletes a ValueListItem object, removing it from its parent value list.

*/ - delete: operations["DeleteRadarValueListItemsItem"]; - }; - "/v1/radar/value_lists": { + delete: operations['DeleteRadarValueListItemsItem'] + } + '/v1/radar/value_lists': { /**

Returns a list of ValueList objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

*/ - get: operations["GetRadarValueLists"]; + get: operations['GetRadarValueLists'] /**

Creates a new ValueList object, which can then be referenced in rules.

*/ - post: operations["PostRadarValueLists"]; - }; - "/v1/radar/value_lists/{value_list}": { + post: operations['PostRadarValueLists'] + } + '/v1/radar/value_lists/{value_list}': { /**

Retrieves a ValueList object.

*/ - get: operations["GetRadarValueListsValueList"]; + get: operations['GetRadarValueListsValueList'] /**

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.

*/ - post: operations["PostRadarValueListsValueList"]; + post: operations['PostRadarValueListsValueList'] /**

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.

*/ - delete: operations["DeleteRadarValueListsValueList"]; - }; - "/v1/recipients": { + delete: operations['DeleteRadarValueListsValueList'] + } + '/v1/recipients': { /**

Returns a list of your recipients. The recipients are returned sorted by creation date, with the most recently created recipients appearing first.

*/ - get: operations["GetRecipients"]; + get: operations['GetRecipients'] /** *

Creates a new Recipient object and verifies the recipient’s identity. * Also verifies the recipient’s bank account information or debit card, if either is provided.

*/ - post: operations["PostRecipients"]; - }; - "/v1/recipients/{id}": { + post: operations['PostRecipients'] + } + '/v1/recipients/{id}': { /**

Retrieves the details of an existing recipient. You need only supply the unique recipient identifier that was returned upon recipient creation.

*/ - get: operations["GetRecipientsId"]; + get: operations['GetRecipientsId'] /** *

Updates the specified recipient by setting the values of the parameters passed. * Any parameters not provided will be left unchanged.

@@ -1301,72 +1301,72 @@ export interface paths { *

If you update the name or tax ID, the identity verification will automatically be rerun. * If you update the bank account, the bank account validation will automatically be rerun.

*/ - post: operations["PostRecipientsId"]; + post: operations['PostRecipientsId'] /**

Permanently deletes a recipient. It cannot be undone.

*/ - delete: operations["DeleteRecipientsId"]; - }; - "/v1/refunds": { + delete: operations['DeleteRecipientsId'] + } + '/v1/refunds': { /**

Returns a list of all refunds you’ve previously created. The refunds are returned in sorted order, with the most recent refunds appearing first. For convenience, the 10 most recent refunds are always available by default on the charge object.

*/ - get: operations["GetRefunds"]; + get: operations['GetRefunds'] /**

Create a refund.

*/ - post: operations["PostRefunds"]; - }; - "/v1/refunds/{refund}": { + post: operations['PostRefunds'] + } + '/v1/refunds/{refund}': { /**

Retrieves the details of an existing refund.

*/ - get: operations["GetRefundsRefund"]; + get: operations['GetRefundsRefund'] /** *

Updates the specified refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

* *

This request only accepts metadata as an argument.

*/ - post: operations["PostRefundsRefund"]; - }; - "/v1/reporting/report_runs": { + post: operations['PostRefundsRefund'] + } + '/v1/reporting/report_runs': { /**

Returns a list of Report Runs, with the most recent appearing first.

*/ - get: operations["GetReportingReportRuns"]; + get: operations['GetReportingReportRuns'] /**

Creates a new object and begin running the report. (Certain report types require a live-mode API key.)

*/ - post: operations["PostReportingReportRuns"]; - }; - "/v1/reporting/report_runs/{report_run}": { + post: operations['PostReportingReportRuns'] + } + '/v1/reporting/report_runs/{report_run}': { /**

Retrieves the details of an existing Report Run.

*/ - get: operations["GetReportingReportRunsReportRun"]; - }; - "/v1/reporting/report_types": { + get: operations['GetReportingReportRunsReportRun'] + } + '/v1/reporting/report_types': { /**

Returns a full list of Report Types.

*/ - get: operations["GetReportingReportTypes"]; - }; - "/v1/reporting/report_types/{report_type}": { + get: operations['GetReportingReportTypes'] + } + '/v1/reporting/report_types/{report_type}': { /**

Retrieves the details of a Report Type. (Certain report types require a live-mode API key.)

*/ - get: operations["GetReportingReportTypesReportType"]; - }; - "/v1/reviews": { + get: operations['GetReportingReportTypesReportType'] + } + '/v1/reviews': { /**

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.

*/ - get: operations["GetReviews"]; - }; - "/v1/reviews/{review}": { + get: operations['GetReviews'] + } + '/v1/reviews/{review}': { /**

Retrieves a Review object.

*/ - get: operations["GetReviewsReview"]; - }; - "/v1/reviews/{review}/approve": { + get: operations['GetReviewsReview'] + } + '/v1/reviews/{review}/approve': { /**

Approves a Review object, closing it and removing it from the list of reviews.

*/ - post: operations["PostReviewsReviewApprove"]; - }; - "/v1/setup_attempts": { + post: operations['PostReviewsReviewApprove'] + } + '/v1/setup_attempts': { /**

Returns a list of SetupAttempts associated with a provided SetupIntent.

*/ - get: operations["GetSetupAttempts"]; - }; - "/v1/setup_intents": { + get: operations['GetSetupAttempts'] + } + '/v1/setup_intents': { /**

Returns a list of SetupIntents.

*/ - get: operations["GetSetupIntents"]; + get: operations['GetSetupIntents'] /** *

Creates a SetupIntent object.

* *

After the SetupIntent is created, attach a payment method and confirm * to collect any required permissions to charge the payment method later.

*/ - post: operations["PostSetupIntents"]; - }; - "/v1/setup_intents/{intent}": { + post: operations['PostSetupIntents'] + } + '/v1/setup_intents/{intent}': { /** *

Retrieves the details of a SetupIntent that has previously been created.

* @@ -1374,19 +1374,19 @@ export interface paths { * *

When retrieved with a publishable key, only a subset of properties will be returned. Please refer to the SetupIntent object reference for more details.

*/ - get: operations["GetSetupIntentsIntent"]; + get: operations['GetSetupIntentsIntent'] /**

Updates a SetupIntent object.

*/ - post: operations["PostSetupIntentsIntent"]; - }; - "/v1/setup_intents/{intent}/cancel": { + post: operations['PostSetupIntentsIntent'] + } + '/v1/setup_intents/{intent}/cancel': { /** *

A SetupIntent object can be canceled when it is in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.

* *

Once canceled, setup is abandoned and any operations on the SetupIntent will fail with an error.

*/ - post: operations["PostSetupIntentsIntentCancel"]; - }; - "/v1/setup_intents/{intent}/confirm": { + post: operations['PostSetupIntentsIntentCancel'] + } + '/v1/setup_intents/{intent}/confirm': { /** *

Confirm that your customer intends to set up the current or * provided payment method. For example, you would confirm a SetupIntent @@ -1402,103 +1402,103 @@ export interface paths { * the SetupIntent will transition to the * requires_payment_method status.

*/ - post: operations["PostSetupIntentsIntentConfirm"]; - }; - "/v1/setup_intents/{intent}/verify_microdeposits": { + post: operations['PostSetupIntentsIntentConfirm'] + } + '/v1/setup_intents/{intent}/verify_microdeposits': { /**

Verifies microdeposits on a SetupIntent object.

*/ - post: operations["PostSetupIntentsIntentVerifyMicrodeposits"]; - }; - "/v1/shipping_rates": { + post: operations['PostSetupIntentsIntentVerifyMicrodeposits'] + } + '/v1/shipping_rates': { /**

Returns a list of your shipping rates.

*/ - get: operations["GetShippingRates"]; + get: operations['GetShippingRates'] /**

Creates a new shipping rate object.

*/ - post: operations["PostShippingRates"]; - }; - "/v1/shipping_rates/{shipping_rate_token}": { + post: operations['PostShippingRates'] + } + '/v1/shipping_rates/{shipping_rate_token}': { /**

Returns the shipping rate object with the given ID.

*/ - get: operations["GetShippingRatesShippingRateToken"]; + get: operations['GetShippingRatesShippingRateToken'] /**

Updates an existing shipping rate object.

*/ - post: operations["PostShippingRatesShippingRateToken"]; - }; - "/v1/sigma/scheduled_query_runs": { + post: operations['PostShippingRatesShippingRateToken'] + } + '/v1/sigma/scheduled_query_runs': { /**

Returns a list of scheduled query runs.

*/ - get: operations["GetSigmaScheduledQueryRuns"]; - }; - "/v1/sigma/scheduled_query_runs/{scheduled_query_run}": { + get: operations['GetSigmaScheduledQueryRuns'] + } + '/v1/sigma/scheduled_query_runs/{scheduled_query_run}': { /**

Retrieves the details of an scheduled query run.

*/ - get: operations["GetSigmaScheduledQueryRunsScheduledQueryRun"]; - }; - "/v1/skus": { + get: operations['GetSigmaScheduledQueryRunsScheduledQueryRun'] + } + '/v1/skus': { /**

Returns a list of your SKUs. The SKUs are returned sorted by creation date, with the most recently created SKUs appearing first.

*/ - get: operations["GetSkus"]; + get: operations['GetSkus'] /**

Creates a new SKU associated with a product.

*/ - post: operations["PostSkus"]; - }; - "/v1/skus/{id}": { + post: operations['PostSkus'] + } + '/v1/skus/{id}': { /**

Retrieves the details of an existing SKU. Supply the unique SKU identifier from either a SKU creation request or from the product, and Stripe will return the corresponding SKU information.

*/ - get: operations["GetSkusId"]; + get: operations['GetSkusId'] /** *

Updates the specific SKU by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

* *

Note that a SKU’s attributes are not editable. Instead, you would need to deactivate the existing SKU and create a new one with the new attribute values.

*/ - post: operations["PostSkusId"]; + post: operations['PostSkusId'] /**

Delete a SKU. Deleting a SKU is only possible until it has been used in an order.

*/ - delete: operations["DeleteSkusId"]; - }; - "/v1/sources": { + delete: operations['DeleteSkusId'] + } + '/v1/sources': { /**

Creates a new source object.

*/ - post: operations["PostSources"]; - }; - "/v1/sources/{source}": { + post: operations['PostSources'] + } + '/v1/sources/{source}': { /**

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.

*/ - get: operations["GetSourcesSource"]; + get: operations['GetSourcesSource'] /** *

Updates the specified source by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

* *

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.

*/ - post: operations["PostSourcesSource"]; - }; - "/v1/sources/{source}/mandate_notifications/{mandate_notification}": { + post: operations['PostSourcesSource'] + } + '/v1/sources/{source}/mandate_notifications/{mandate_notification}': { /**

Retrieves a new Source MandateNotification.

*/ - get: operations["GetSourcesSourceMandateNotificationsMandateNotification"]; - }; - "/v1/sources/{source}/source_transactions": { + get: operations['GetSourcesSourceMandateNotificationsMandateNotification'] + } + '/v1/sources/{source}/source_transactions': { /**

List source transactions for a given source.

*/ - get: operations["GetSourcesSourceSourceTransactions"]; - }; - "/v1/sources/{source}/source_transactions/{source_transaction}": { + get: operations['GetSourcesSourceSourceTransactions'] + } + '/v1/sources/{source}/source_transactions/{source_transaction}': { /**

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.

*/ - get: operations["GetSourcesSourceSourceTransactionsSourceTransaction"]; - }; - "/v1/sources/{source}/verify": { + get: operations['GetSourcesSourceSourceTransactionsSourceTransaction'] + } + '/v1/sources/{source}/verify': { /**

Verify a given source.

*/ - post: operations["PostSourcesSourceVerify"]; - }; - "/v1/subscription_items": { + post: operations['PostSourcesSourceVerify'] + } + '/v1/subscription_items': { /**

Returns a list of your subscription items for a given subscription.

*/ - get: operations["GetSubscriptionItems"]; + get: operations['GetSubscriptionItems'] /**

Adds a new item to an existing subscription. No existing items will be changed or replaced.

*/ - post: operations["PostSubscriptionItems"]; - }; - "/v1/subscription_items/{item}": { + post: operations['PostSubscriptionItems'] + } + '/v1/subscription_items/{item}': { /**

Retrieves the subscription item with the given ID.

*/ - get: operations["GetSubscriptionItemsItem"]; + get: operations['GetSubscriptionItemsItem'] /**

Updates the plan or quantity of an item on a current subscription.

*/ - post: operations["PostSubscriptionItemsItem"]; + post: operations['PostSubscriptionItemsItem'] /**

Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.

*/ - delete: operations["DeleteSubscriptionItemsItem"]; - }; - "/v1/subscription_items/{subscription_item}/usage_record_summaries": { + delete: operations['DeleteSubscriptionItemsItem'] + } + '/v1/subscription_items/{subscription_item}/usage_record_summaries': { /** *

For the specified subscription item, returns a list of summary objects. Each object in the list provides usage information that’s been summarized from multiple usage records and over a subscription billing period (e.g., 15 usage records in the month of September).

* *

The list is sorted in reverse-chronological order (newest first). The first list item represents the most current usage period that hasn’t ended yet. Since new usage records can still be added, the returned summary information for the subscription item’s ID should be seen as unstable until the subscription billing period ends.

*/ - get: operations["GetSubscriptionItemsSubscriptionItemUsageRecordSummaries"]; - }; - "/v1/subscription_items/{subscription_item}/usage_records": { + get: operations['GetSubscriptionItemsSubscriptionItemUsageRecordSummaries'] + } + '/v1/subscription_items/{subscription_item}/usage_records': { /** *

Creates a usage record for a specified subscription item and date, and fills it with a quantity.

* @@ -1508,39 +1508,39 @@ export interface paths { * *

The default pricing model for metered billing is per-unit pricing. For finer granularity, you can configure metered billing to have a tiered pricing model.

*/ - post: operations["PostSubscriptionItemsSubscriptionItemUsageRecords"]; - }; - "/v1/subscription_schedules": { + post: operations['PostSubscriptionItemsSubscriptionItemUsageRecords'] + } + '/v1/subscription_schedules': { /**

Retrieves the list of your subscription schedules.

*/ - get: operations["GetSubscriptionSchedules"]; + get: operations['GetSubscriptionSchedules'] /**

Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.

*/ - post: operations["PostSubscriptionSchedules"]; - }; - "/v1/subscription_schedules/{schedule}": { + post: operations['PostSubscriptionSchedules'] + } + '/v1/subscription_schedules/{schedule}': { /**

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.

*/ - get: operations["GetSubscriptionSchedulesSchedule"]; + get: operations['GetSubscriptionSchedulesSchedule'] /**

Updates an existing subscription schedule.

*/ - post: operations["PostSubscriptionSchedulesSchedule"]; - }; - "/v1/subscription_schedules/{schedule}/cancel": { + post: operations['PostSubscriptionSchedulesSchedule'] + } + '/v1/subscription_schedules/{schedule}/cancel': { /**

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.

*/ - post: operations["PostSubscriptionSchedulesScheduleCancel"]; - }; - "/v1/subscription_schedules/{schedule}/release": { + post: operations['PostSubscriptionSchedulesScheduleCancel'] + } + '/v1/subscription_schedules/{schedule}/release': { /**

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.

*/ - post: operations["PostSubscriptionSchedulesScheduleRelease"]; - }; - "/v1/subscriptions": { + post: operations['PostSubscriptionSchedulesScheduleRelease'] + } + '/v1/subscriptions': { /**

By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.

*/ - get: operations["GetSubscriptions"]; + get: operations['GetSubscriptions'] /**

Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.

*/ - post: operations["PostSubscriptions"]; - }; - "/v1/subscriptions/{subscription_exposed_id}": { + post: operations['PostSubscriptions'] + } + '/v1/subscriptions/{subscription_exposed_id}': { /**

Retrieves the subscription with the given ID.

*/ - get: operations["GetSubscriptionsSubscriptionExposedId"]; + get: operations['GetSubscriptionsSubscriptionExposedId'] /**

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.

*/ - post: operations["PostSubscriptionsSubscriptionExposedId"]; + post: operations['PostSubscriptionsSubscriptionExposedId'] /** *

Cancels a customer’s subscription immediately. The customer will not be charged again for the subscription.

* @@ -1548,103 +1548,103 @@ export interface paths { * *

By default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.

*/ - delete: operations["DeleteSubscriptionsSubscriptionExposedId"]; - }; - "/v1/subscriptions/{subscription_exposed_id}/discount": { + delete: operations['DeleteSubscriptionsSubscriptionExposedId'] + } + '/v1/subscriptions/{subscription_exposed_id}/discount': { /**

Removes the currently applied discount on a subscription.

*/ - delete: operations["DeleteSubscriptionsSubscriptionExposedIdDiscount"]; - }; - "/v1/tax_codes": { + delete: operations['DeleteSubscriptionsSubscriptionExposedIdDiscount'] + } + '/v1/tax_codes': { /**

A list of all tax codes available to add to Products in order to allow specific tax calculations.

*/ - get: operations["GetTaxCodes"]; - }; - "/v1/tax_codes/{id}": { + get: operations['GetTaxCodes'] + } + '/v1/tax_codes/{id}': { /**

Retrieves the details of an existing tax code. Supply the unique tax code ID and Stripe will return the corresponding tax code information.

*/ - get: operations["GetTaxCodesId"]; - }; - "/v1/tax_rates": { + get: operations['GetTaxCodesId'] + } + '/v1/tax_rates': { /**

Returns a list of your tax rates. Tax rates are returned sorted by creation date, with the most recently created tax rates appearing first.

*/ - get: operations["GetTaxRates"]; + get: operations['GetTaxRates'] /**

Creates a new tax rate.

*/ - post: operations["PostTaxRates"]; - }; - "/v1/tax_rates/{tax_rate}": { + post: operations['PostTaxRates'] + } + '/v1/tax_rates/{tax_rate}': { /**

Retrieves a tax rate with the given ID

*/ - get: operations["GetTaxRatesTaxRate"]; + get: operations['GetTaxRatesTaxRate'] /**

Updates an existing tax rate.

*/ - post: operations["PostTaxRatesTaxRate"]; - }; - "/v1/terminal/connection_tokens": { + post: operations['PostTaxRatesTaxRate'] + } + '/v1/terminal/connection_tokens': { /**

To connect to a reader the Stripe Terminal SDK needs to retrieve a short-lived connection token from Stripe, proxied through your server. On your backend, add an endpoint that creates and returns a connection token.

*/ - post: operations["PostTerminalConnectionTokens"]; - }; - "/v1/terminal/locations": { + post: operations['PostTerminalConnectionTokens'] + } + '/v1/terminal/locations': { /**

Returns a list of Location objects.

*/ - get: operations["GetTerminalLocations"]; + get: operations['GetTerminalLocations'] /** *

Creates a new Location object. * For further details, including which address fields are required in each country, see the Manage locations guide.

*/ - post: operations["PostTerminalLocations"]; - }; - "/v1/terminal/locations/{location}": { + post: operations['PostTerminalLocations'] + } + '/v1/terminal/locations/{location}': { /**

Retrieves a Location object.

*/ - get: operations["GetTerminalLocationsLocation"]; + get: operations['GetTerminalLocationsLocation'] /**

Updates a Location object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ - post: operations["PostTerminalLocationsLocation"]; + post: operations['PostTerminalLocationsLocation'] /**

Deletes a Location object.

*/ - delete: operations["DeleteTerminalLocationsLocation"]; - }; - "/v1/terminal/readers": { + delete: operations['DeleteTerminalLocationsLocation'] + } + '/v1/terminal/readers': { /**

Returns a list of Reader objects.

*/ - get: operations["GetTerminalReaders"]; + get: operations['GetTerminalReaders'] /**

Creates a new Reader object.

*/ - post: operations["PostTerminalReaders"]; - }; - "/v1/terminal/readers/{reader}": { + post: operations['PostTerminalReaders'] + } + '/v1/terminal/readers/{reader}': { /**

Retrieves a Reader object.

*/ - get: operations["GetTerminalReadersReader"]; + get: operations['GetTerminalReadersReader'] /**

Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ - post: operations["PostTerminalReadersReader"]; + post: operations['PostTerminalReadersReader'] /**

Deletes a Reader object.

*/ - delete: operations["DeleteTerminalReadersReader"]; - }; - "/v1/tokens": { + delete: operations['DeleteTerminalReadersReader'] + } + '/v1/tokens': { /** *

Creates a single-use token that represents a bank account’s details. * This token can be used with any API method in place of a bank account dictionary. This token can be used only once, by attaching it to a Custom account.

*/ - post: operations["PostTokens"]; - }; - "/v1/tokens/{token}": { + post: operations['PostTokens'] + } + '/v1/tokens/{token}': { /**

Retrieves the token with the given ID.

*/ - get: operations["GetTokensToken"]; - }; - "/v1/topups": { + get: operations['GetTokensToken'] + } + '/v1/topups': { /**

Returns a list of top-ups.

*/ - get: operations["GetTopups"]; + get: operations['GetTopups'] /**

Top up the balance of an account

*/ - post: operations["PostTopups"]; - }; - "/v1/topups/{topup}": { + post: operations['PostTopups'] + } + '/v1/topups/{topup}': { /**

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.

*/ - get: operations["GetTopupsTopup"]; + get: operations['GetTopupsTopup'] /**

Updates the metadata of a top-up. Other top-up details are not editable by design.

*/ - post: operations["PostTopupsTopup"]; - }; - "/v1/topups/{topup}/cancel": { + post: operations['PostTopupsTopup'] + } + '/v1/topups/{topup}/cancel': { /**

Cancels a top-up. Only pending top-ups can be canceled.

*/ - post: operations["PostTopupsTopupCancel"]; - }; - "/v1/transfers": { + post: operations['PostTopupsTopupCancel'] + } + '/v1/transfers': { /**

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.

*/ - get: operations["GetTransfers"]; + get: operations['GetTransfers'] /**

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.

*/ - post: operations["PostTransfers"]; - }; - "/v1/transfers/{id}/reversals": { + post: operations['PostTransfers'] + } + '/v1/transfers/{id}/reversals': { /**

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.

*/ - get: operations["GetTransfersIdReversals"]; + get: operations['GetTransfersIdReversals'] /** *

When you create a new reversal, you must specify a transfer to create it on.

* @@ -1652,42 +1652,42 @@ export interface paths { * *

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.

*/ - post: operations["PostTransfersIdReversals"]; - }; - "/v1/transfers/{transfer}": { + post: operations['PostTransfersIdReversals'] + } + '/v1/transfers/{transfer}': { /**

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.

*/ - get: operations["GetTransfersTransfer"]; + get: operations['GetTransfersTransfer'] /** *

Updates the specified transfer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

* *

This request accepts only metadata as an argument.

*/ - post: operations["PostTransfersTransfer"]; - }; - "/v1/transfers/{transfer}/reversals/{id}": { + post: operations['PostTransfersTransfer'] + } + '/v1/transfers/{transfer}/reversals/{id}': { /**

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.

*/ - get: operations["GetTransfersTransferReversalsId"]; + get: operations['GetTransfersTransferReversalsId'] /** *

Updates the specified reversal by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

* *

This request only accepts metadata and description as arguments.

*/ - post: operations["PostTransfersTransferReversalsId"]; - }; - "/v1/webhook_endpoints": { + post: operations['PostTransfersTransferReversalsId'] + } + '/v1/webhook_endpoints': { /**

Returns a list of your webhook endpoints.

*/ - get: operations["GetWebhookEndpoints"]; + get: operations['GetWebhookEndpoints'] /**

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.

*/ - post: operations["PostWebhookEndpoints"]; - }; - "/v1/webhook_endpoints/{webhook_endpoint}": { + post: operations['PostWebhookEndpoints'] + } + '/v1/webhook_endpoints/{webhook_endpoint}': { /**

Retrieves the webhook endpoint with the given ID.

*/ - get: operations["GetWebhookEndpointsWebhookEndpoint"]; + get: operations['GetWebhookEndpointsWebhookEndpoint'] /**

Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.

*/ - post: operations["PostWebhookEndpointsWebhookEndpoint"]; + post: operations['PostWebhookEndpointsWebhookEndpoint'] /**

You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.

*/ - delete: operations["DeleteWebhookEndpointsWebhookEndpoint"]; - }; + delete: operations['DeleteWebhookEndpointsWebhookEndpoint'] + } } export interface components { @@ -1703,261 +1703,261 @@ export interface components { */ account: { /** @description Business information about the account. */ - business_profile?: Partial | null; + business_profile?: Partial | null /** * @description The business type. * @enum {string|null} */ - business_type?: ("company" | "government_entity" | "individual" | "non_profit") | null; - capabilities?: components["schemas"]["account_capabilities"]; + business_type?: ('company' | 'government_entity' | 'individual' | 'non_profit') | null + capabilities?: components['schemas']['account_capabilities'] /** @description Whether the account can create live charges. */ - charges_enabled?: boolean; - company?: components["schemas"]["legal_entity_company"]; - controller?: components["schemas"]["account_unification_account_controller"]; + charges_enabled?: boolean + company?: components['schemas']['legal_entity_company'] + controller?: components['schemas']['account_unification_account_controller'] /** @description The account's country. */ - country?: string; + country?: string /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created?: number; + created?: number /** @description 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?: string; + default_currency?: string /** @description Whether account details have been submitted. Standard accounts cannot receive payouts before this is true. */ - details_submitted?: boolean; + details_submitted?: boolean /** @description An email address associated with the account. You can treat this as metadata: it is not used for authentication or messaging account holders. */ - email?: string | null; + email?: string | null /** * ExternalAccountList * @description External accounts (bank accounts and debit cards) currently attached to this account */ external_accounts?: { /** @description The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards. */ - data: (Partial & Partial)[]; + data: (Partial & Partial)[] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - future_requirements?: components["schemas"]["account_future_requirements"]; + url: string + } + future_requirements?: components['schemas']['account_future_requirements'] /** @description Unique identifier for the object. */ - id: string; - individual?: components["schemas"]["person"]; + id: string + individual?: components['schemas']['person'] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "account"; + object: 'account' /** @description Whether Stripe can send payouts to this account. */ - payouts_enabled?: boolean; - requirements?: components["schemas"]["account_requirements"]; + payouts_enabled?: boolean + requirements?: components['schemas']['account_requirements'] /** @description Options for customizing how the account functions within Stripe. */ - settings?: Partial | null; - tos_acceptance?: components["schemas"]["account_tos_acceptance"]; + settings?: Partial | null + tos_acceptance?: components['schemas']['account_tos_acceptance'] /** * @description The Stripe account type. Can be `standard`, `express`, or `custom`. * @enum {string} */ - type?: "custom" | "express" | "standard"; - }; + type?: 'custom' | 'express' | 'standard' + } /** AccountBacsDebitPaymentsSettings */ account_bacs_debit_payments_settings: { /** @description The Bacs Direct Debit Display Name for this account. For payments made with Bacs Direct Debit, this will appear on the mandate, and as the statement descriptor. */ - display_name?: string; - }; + display_name?: string + } /** AccountBrandingSettings */ account_branding_settings: { /** @description (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?: (Partial & Partial) | null; + icon?: (Partial & Partial) | null /** @description (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?: (Partial & Partial) | null; + logo?: (Partial & Partial) | null /** @description A CSS hex color value representing the primary branding color for this account */ - primary_color?: string | null; + primary_color?: string | null /** @description A CSS hex color value representing the secondary branding color for this account */ - secondary_color?: string | null; - }; + secondary_color?: string | null + } /** AccountBusinessProfile */ account_business_profile: { /** @description [The merchant category code for the account](https://stripe.com/docs/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide. */ - mcc?: string | null; + mcc?: string | null /** @description The customer-facing business name. */ - name?: string | null; + name?: string | null /** @description 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?: string | null; + product_description?: string | null /** @description A publicly available mailing address for sending support issues to. */ - support_address?: Partial | null; + support_address?: Partial | null /** @description A publicly available email address for sending support issues to. */ - support_email?: string | null; + support_email?: string | null /** @description A publicly available phone number to call with support issues. */ - support_phone?: string | null; + support_phone?: string | null /** @description A publicly available website for handling support issues. */ - support_url?: string | null; + support_url?: string | null /** @description The business's publicly available website. */ - url?: string | null; - }; + url?: string | null + } /** AccountCapabilities */ account_capabilities: { /** * @description 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. * @enum {string} */ - acss_debit_payments?: "active" | "inactive" | "pending"; + acss_debit_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the Afterpay Clearpay capability of the account, or whether the account can directly process Afterpay Clearpay charges. * @enum {string} */ - afterpay_clearpay_payments?: "active" | "inactive" | "pending"; + afterpay_clearpay_payments?: 'active' | 'inactive' | 'pending' /** * @description 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. * @enum {string} */ - au_becs_debit_payments?: "active" | "inactive" | "pending"; + au_becs_debit_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the Bacs Direct Debits payments capability of the account, or whether the account can directly process Bacs Direct Debits charges. * @enum {string} */ - bacs_debit_payments?: "active" | "inactive" | "pending"; + bacs_debit_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the Bancontact payments capability of the account, or whether the account can directly process Bancontact charges. * @enum {string} */ - bancontact_payments?: "active" | "inactive" | "pending"; + bancontact_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the boleto payments capability of the account, or whether the account can directly process boleto charges. * @enum {string} */ - boleto_payments?: "active" | "inactive" | "pending"; + boleto_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the card issuing capability of the account, or whether you can use Issuing to distribute funds on cards * @enum {string} */ - card_issuing?: "active" | "inactive" | "pending"; + card_issuing?: 'active' | 'inactive' | 'pending' /** * @description The status of the card payments capability of the account, or whether the account can directly process credit and debit card charges. * @enum {string} */ - card_payments?: "active" | "inactive" | "pending"; + card_payments?: 'active' | 'inactive' | 'pending' /** * @description 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. * @enum {string} */ - cartes_bancaires_payments?: "active" | "inactive" | "pending"; + cartes_bancaires_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the EPS payments capability of the account, or whether the account can directly process EPS charges. * @enum {string} */ - eps_payments?: "active" | "inactive" | "pending"; + eps_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the FPX payments capability of the account, or whether the account can directly process FPX charges. * @enum {string} */ - fpx_payments?: "active" | "inactive" | "pending"; + fpx_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the giropay payments capability of the account, or whether the account can directly process giropay charges. * @enum {string} */ - giropay_payments?: "active" | "inactive" | "pending"; + giropay_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the GrabPay payments capability of the account, or whether the account can directly process GrabPay charges. * @enum {string} */ - grabpay_payments?: "active" | "inactive" | "pending"; + grabpay_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the iDEAL payments capability of the account, or whether the account can directly process iDEAL charges. * @enum {string} */ - ideal_payments?: "active" | "inactive" | "pending"; + ideal_payments?: 'active' | 'inactive' | 'pending' /** * @description 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. * @enum {string} */ - jcb_payments?: "active" | "inactive" | "pending"; + jcb_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the Klarna payments capability of the account, or whether the account can directly process Klarna charges. * @enum {string} */ - klarna_payments?: "active" | "inactive" | "pending"; + klarna_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the legacy payments capability of the account. * @enum {string} */ - legacy_payments?: "active" | "inactive" | "pending"; + legacy_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the OXXO payments capability of the account, or whether the account can directly process OXXO charges. * @enum {string} */ - oxxo_payments?: "active" | "inactive" | "pending"; + oxxo_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the P24 payments capability of the account, or whether the account can directly process P24 charges. * @enum {string} */ - p24_payments?: "active" | "inactive" | "pending"; + p24_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the SEPA Direct Debits payments capability of the account, or whether the account can directly process SEPA Direct Debits charges. * @enum {string} */ - sepa_debit_payments?: "active" | "inactive" | "pending"; + sepa_debit_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the Sofort payments capability of the account, or whether the account can directly process Sofort charges. * @enum {string} */ - sofort_payments?: "active" | "inactive" | "pending"; + sofort_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the tax reporting 1099-K (US) capability of the account. * @enum {string} */ - tax_reporting_us_1099_k?: "active" | "inactive" | "pending"; + tax_reporting_us_1099_k?: 'active' | 'inactive' | 'pending' /** * @description The status of the tax reporting 1099-MISC (US) capability of the account. * @enum {string} */ - tax_reporting_us_1099_misc?: "active" | "inactive" | "pending"; + tax_reporting_us_1099_misc?: 'active' | 'inactive' | 'pending' /** * @description The status of the transfers capability of the account, or whether your platform can transfer funds to the account. * @enum {string} */ - transfers?: "active" | "inactive" | "pending"; - }; + transfers?: 'active' | 'inactive' | 'pending' + } /** AccountCapabilityFutureRequirements */ account_capability_future_requirements: { /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ - alternatives?: components["schemas"]["account_requirements_alternative"][] | null; + alternatives?: components['schemas']['account_requirements_alternative'][] | null /** * Format: unix-time * @description Date on which `future_requirements` merges with 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?: number | null; + current_deadline?: number | null /** @description 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: string[]; + currently_due: string[] /** @description This is typed as a string for consistency with `requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is empty because fields in `future_requirements` will never disable the account. */ - disabled_reason?: string | null; + disabled_reason?: string | null /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ - errors: components["schemas"]["account_requirements_error"][]; + errors: components['schemas']['account_requirements_error'][] /** @description Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well. */ - eventually_due: string[]; + eventually_due: string[] /** @description 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: string[]; + past_due: string[] /** @description Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. */ - pending_verification: string[]; - }; + pending_verification: string[] + } /** AccountCapabilityRequirements */ account_capability_requirements: { /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ - alternatives?: components["schemas"]["account_requirements_alternative"][] | null; + alternatives?: components['schemas']['account_requirements_alternative'][] | null /** * Format: unix-time * @description 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?: number | null; + current_deadline?: number | null /** @description 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: string[]; + currently_due: string[] /** * @description If the capability is disabled, this string describes why. Can be `requirements.past_due`, `requirements.pending_verification`, `listed`, `platform_paused`, `rejected.fraud`, `rejected.listed`, `rejected.terms_of_service`, `rejected.other`, `under_review`, or `other`. * @@ -1967,62 +1967,62 @@ export interface components { * * If you believe that the rejection is in error, please contact support at https://support.stripe.com/contact/ for assistance. */ - disabled_reason?: string | null; + disabled_reason?: string | null /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ - errors: components["schemas"]["account_requirements_error"][]; + errors: components['schemas']['account_requirements_error'][] /** @description Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set. */ - eventually_due: string[]; + eventually_due: string[] /** @description Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the capability on the account. */ - past_due: string[]; + past_due: string[] /** @description Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. */ - pending_verification: string[]; - }; + pending_verification: string[] + } /** AccountCardIssuingSettings */ account_card_issuing_settings: { - tos_acceptance?: components["schemas"]["card_issuing_account_terms_of_service"]; - }; + tos_acceptance?: components['schemas']['card_issuing_account_terms_of_service'] + } /** AccountCardPaymentsSettings */ account_card_payments_settings: { - decline_on?: components["schemas"]["account_decline_charge_on"]; + decline_on?: components['schemas']['account_decline_charge_on'] /** @description 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?: string | null; - }; + statement_descriptor_prefix?: string | null + } /** AccountDashboardSettings */ account_dashboard_settings: { /** @description The display name for this account. This is used on the Stripe Dashboard to differentiate between accounts. */ - display_name?: string | null; + display_name?: string | null /** @description 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?: string | null; - }; + timezone?: string | null + } /** AccountDeclineChargeOn */ account_decline_charge_on: { /** @description 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: boolean; + avs_failure: boolean /** @description 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: boolean; - }; + cvc_failure: boolean + } /** AccountFutureRequirements */ account_future_requirements: { /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ - alternatives?: components["schemas"]["account_requirements_alternative"][] | null; + alternatives?: components['schemas']['account_requirements_alternative'][] | null /** * Format: unix-time * @description Date on which `future_requirements` merges with 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?: number | null; + current_deadline?: number | null /** @description 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?: string[] | null; + currently_due?: string[] | null /** @description This is typed as a string for consistency with `requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is empty because fields in `future_requirements` will never disable the account. */ - disabled_reason?: string | null; + disabled_reason?: string | null /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ - errors?: components["schemas"]["account_requirements_error"][] | null; + errors?: components['schemas']['account_requirements_error'][] | null /** @description Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well. */ - eventually_due?: string[] | null; + eventually_due?: string[] | null /** @description 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?: string[] | null; + past_due?: string[] | null /** @description Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. */ - pending_verification?: string[] | null; - }; + pending_verification?: string[] | null + } /** * AccountLink * @description Account Links are the means by which a Connect platform grants a connected account permission to access @@ -2035,66 +2035,66 @@ export interface components { * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** * Format: unix-time * @description The timestamp at which this account link will expire. */ - expires_at: number; + expires_at: number /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "account_link"; + object: 'account_link' /** @description The URL for the account link. */ - url: string; - }; + url: string + } /** AccountPaymentsSettings */ account_payments_settings: { /** @description 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?: string | null; + statement_descriptor?: string | null /** @description The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only) */ - statement_descriptor_kana?: string | null; + statement_descriptor_kana?: string | null /** @description The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only) */ - statement_descriptor_kanji?: string | null; - }; + statement_descriptor_kanji?: string | null + } /** AccountPayoutSettings */ account_payout_settings: { /** @description A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See our [Understanding Connect Account Balances](https://stripe.com/docs/connect/account-balances) documentation for details. Default value is `false` for Custom accounts, otherwise `true`. */ - debit_negative_balances: boolean; - schedule: components["schemas"]["transfer_schedule"]; + debit_negative_balances: boolean + schedule: components['schemas']['transfer_schedule'] /** @description 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?: string | null; - }; + statement_descriptor?: string | null + } /** AccountRequirements */ account_requirements: { /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ - alternatives?: components["schemas"]["account_requirements_alternative"][] | null; + alternatives?: components['schemas']['account_requirements_alternative'][] | null /** * Format: unix-time * @description 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?: number | null; + current_deadline?: number | null /** @description 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?: string[] | null; + currently_due?: string[] | null /** @description If the account is disabled, this string describes why. Can be `requirements.past_due`, `requirements.pending_verification`, `listed`, `platform_paused`, `rejected.fraud`, `rejected.listed`, `rejected.terms_of_service`, `rejected.other`, `under_review`, or `other`. */ - disabled_reason?: string | null; + disabled_reason?: string | null /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ - errors?: components["schemas"]["account_requirements_error"][] | null; + errors?: components['schemas']['account_requirements_error'][] | null /** @description Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set. */ - eventually_due?: string[] | null; + eventually_due?: string[] | null /** @description Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the account. */ - past_due?: string[] | null; + past_due?: string[] | null /** @description Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. */ - pending_verification?: string[] | null; - }; + pending_verification?: string[] | null + } /** AccountRequirementsAlternative */ account_requirements_alternative: { /** @description Fields that can be provided to satisfy all fields in `original_fields_due`. */ - alternative_fields_due: string[]; + alternative_fields_due: string[] /** @description Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`. */ - original_fields_due: string[]; - }; + original_fields_due: string[] + } /** AccountRequirementsError */ account_requirements_error: { /** @@ -2102,269 +2102,263 @@ export interface components { * @enum {string} */ code: - | "invalid_address_city_state_postal_code" - | "invalid_street_address" - | "invalid_value_other" - | "verification_document_address_mismatch" - | "verification_document_address_missing" - | "verification_document_corrupt" - | "verification_document_country_not_supported" - | "verification_document_dob_mismatch" - | "verification_document_duplicate_type" - | "verification_document_expired" - | "verification_document_failed_copy" - | "verification_document_failed_greyscale" - | "verification_document_failed_other" - | "verification_document_failed_test_mode" - | "verification_document_fraudulent" - | "verification_document_id_number_mismatch" - | "verification_document_id_number_missing" - | "verification_document_incomplete" - | "verification_document_invalid" - | "verification_document_issue_or_expiry_date_missing" - | "verification_document_manipulated" - | "verification_document_missing_back" - | "verification_document_missing_front" - | "verification_document_name_mismatch" - | "verification_document_name_missing" - | "verification_document_nationality_mismatch" - | "verification_document_not_readable" - | "verification_document_not_signed" - | "verification_document_not_uploaded" - | "verification_document_photo_mismatch" - | "verification_document_too_large" - | "verification_document_type_not_supported" - | "verification_failed_address_match" - | "verification_failed_business_iec_number" - | "verification_failed_document_match" - | "verification_failed_id_number_match" - | "verification_failed_keyed_identity" - | "verification_failed_keyed_match" - | "verification_failed_name_match" - | "verification_failed_other" - | "verification_failed_tax_id_match" - | "verification_failed_tax_id_not_issued" - | "verification_missing_executives" - | "verification_missing_owners" - | "verification_requires_additional_memorandum_of_associations"; + | 'invalid_address_city_state_postal_code' + | 'invalid_street_address' + | 'invalid_value_other' + | 'verification_document_address_mismatch' + | 'verification_document_address_missing' + | 'verification_document_corrupt' + | 'verification_document_country_not_supported' + | 'verification_document_dob_mismatch' + | 'verification_document_duplicate_type' + | 'verification_document_expired' + | 'verification_document_failed_copy' + | 'verification_document_failed_greyscale' + | 'verification_document_failed_other' + | 'verification_document_failed_test_mode' + | 'verification_document_fraudulent' + | 'verification_document_id_number_mismatch' + | 'verification_document_id_number_missing' + | 'verification_document_incomplete' + | 'verification_document_invalid' + | 'verification_document_issue_or_expiry_date_missing' + | 'verification_document_manipulated' + | 'verification_document_missing_back' + | 'verification_document_missing_front' + | 'verification_document_name_mismatch' + | 'verification_document_name_missing' + | 'verification_document_nationality_mismatch' + | 'verification_document_not_readable' + | 'verification_document_not_signed' + | 'verification_document_not_uploaded' + | 'verification_document_photo_mismatch' + | 'verification_document_too_large' + | 'verification_document_type_not_supported' + | 'verification_failed_address_match' + | 'verification_failed_business_iec_number' + | 'verification_failed_document_match' + | 'verification_failed_id_number_match' + | 'verification_failed_keyed_identity' + | 'verification_failed_keyed_match' + | 'verification_failed_name_match' + | 'verification_failed_other' + | 'verification_failed_tax_id_match' + | 'verification_failed_tax_id_not_issued' + | 'verification_missing_executives' + | 'verification_missing_owners' + | 'verification_requires_additional_memorandum_of_associations' /** @description An informative message that indicates the error type and provides additional details about the error. */ - reason: string; + reason: string /** @description The specific user onboarding requirement field (in the requirements hash) that needs to be resolved. */ - requirement: string; - }; + requirement: string + } /** AccountSepaDebitPaymentsSettings */ account_sepa_debit_payments_settings: { /** @description SEPA creditor identifier that identifies the company making the payment. */ - creditor_id?: string; - }; + creditor_id?: string + } /** AccountSettings */ account_settings: { - bacs_debit_payments?: components["schemas"]["account_bacs_debit_payments_settings"]; - branding: components["schemas"]["account_branding_settings"]; - card_issuing?: components["schemas"]["account_card_issuing_settings"]; - card_payments: components["schemas"]["account_card_payments_settings"]; - dashboard: components["schemas"]["account_dashboard_settings"]; - payments: components["schemas"]["account_payments_settings"]; - payouts?: components["schemas"]["account_payout_settings"]; - sepa_debit_payments?: components["schemas"]["account_sepa_debit_payments_settings"]; - }; + bacs_debit_payments?: components['schemas']['account_bacs_debit_payments_settings'] + branding: components['schemas']['account_branding_settings'] + card_issuing?: components['schemas']['account_card_issuing_settings'] + card_payments: components['schemas']['account_card_payments_settings'] + dashboard: components['schemas']['account_dashboard_settings'] + payments: components['schemas']['account_payments_settings'] + payouts?: components['schemas']['account_payout_settings'] + sepa_debit_payments?: components['schemas']['account_sepa_debit_payments_settings'] + } /** AccountTOSAcceptance */ account_tos_acceptance: { /** * Format: unix-time * @description The Unix timestamp marking when the account representative accepted their service agreement */ - date?: number | null; + date?: number | null /** @description The IP address from which the account representative accepted their service agreement */ - ip?: string | null; + ip?: string | null /** @description The user's service agreement type */ - service_agreement?: string; + service_agreement?: string /** @description The user agent of the browser from which the account representative accepted their service agreement */ - user_agent?: string | null; - }; + user_agent?: string | null + } /** AccountUnificationAccountController */ account_unification_account_controller: { /** @description `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?: boolean; + is_controller?: boolean /** * @description The controller type. Can be `application`, if a Connect application controls the account, or `account`, if the account controls itself. * @enum {string} */ - type: "account" | "application"; - }; + type: 'account' | 'application' + } /** Address */ address: { /** @description City, district, suburb, town, or village. */ - city?: string | null; + city?: string | null /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ - country?: string | null; + country?: string | null /** @description Address line 1 (e.g., street, PO Box, or company name). */ - line1?: string | null; + line1?: string | null /** @description Address line 2 (e.g., apartment, suite, unit, or building). */ - line2?: string | null; + line2?: string | null /** @description ZIP or postal code. */ - postal_code?: string | null; + postal_code?: string | null /** @description State, county, province, or region. */ - state?: string | null; - }; + state?: string | null + } /** AlipayAccount */ alipay_account: { /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The ID of the customer associated with this Alipay Account. */ - customer?: - | (Partial & - Partial & - Partial) - | null; + customer?: (Partial & Partial & Partial) | null /** @description Uniquely identifies the account and will be the same across all Alipay account objects that are linked to the same Alipay account. */ - fingerprint: string; + fingerprint: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "alipay_account"; + object: 'alipay_account' /** @description If the Alipay account object is not reusable, the exact amount that you can create a charge for. */ - payment_amount?: number | null; + payment_amount?: number | null /** @description If the Alipay account object is not reusable, the exact currency that you can create a charge for. */ - payment_currency?: string | null; + payment_currency?: string | null /** @description True if you can create multiple payments using this account. If the account is reusable, then you can freely choose the amount of each payment. */ - reusable: boolean; + reusable: boolean /** @description Whether this Alipay account object has ever been used for a payment. */ - used: boolean; + used: boolean /** @description The username for the Alipay account. */ - username: string; - }; + username: string + } /** APIErrors */ api_errors: { /** @description For card errors, the ID of the failed charge. */ - charge?: string; + charge?: string /** @description For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported. */ - code?: string; + code?: string /** @description 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?: string; + decline_code?: string /** @description A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported. */ - doc_url?: string; + doc_url?: string /** @description A human-readable message providing more details about the error. For card errors, these messages can be shown to your users. */ - message?: string; + message?: string /** @description 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?: string; - payment_intent?: components["schemas"]["payment_intent"]; - payment_method?: components["schemas"]["payment_method"]; + param?: string + payment_intent?: components['schemas']['payment_intent'] + payment_method?: components['schemas']['payment_method'] /** @description 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?: string; - setup_intent?: components["schemas"]["setup_intent"]; + payment_method_type?: string + setup_intent?: components['schemas']['setup_intent'] /** @description The source object for errors returned on a request involving a source. */ - source?: Partial & - Partial & - Partial; + source?: Partial & Partial & Partial /** * @description The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error` * @enum {string} */ - type: "api_error" | "card_error" | "idempotency_error" | "invalid_request_error"; - }; + type: 'api_error' | 'card_error' | 'idempotency_error' | 'invalid_request_error' + } /** ApplePayDomain */ apple_pay_domain: { /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; - domain_name: string; + created: number + domain_name: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "apple_pay_domain"; - }; + object: 'apple_pay_domain' + } /** Application */ application: { /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The name of the application. */ - name?: string | null; + name?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "application"; - }; + object: 'application' + } /** PlatformFee */ application_fee: { /** @description ID of the Stripe account this fee was taken from. */ - account: Partial & Partial; + account: Partial & Partial /** @description Amount earned, in %s. */ - amount: number; + amount: number /** @description Amount in %s refunded (can be less than the amount attribute on the fee if a partial refund was issued) */ - amount_refunded: number; + amount_refunded: number /** @description ID of the Connect application that earned the fee. */ - application: Partial & Partial; + application: Partial & Partial /** @description Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds). */ - balance_transaction?: (Partial & Partial) | null; + balance_transaction?: (Partial & Partial) | null /** @description ID of the charge that the application fee was taken from. */ - charge: Partial & Partial; + charge: Partial & Partial /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "application_fee"; + object: 'application_fee' /** @description ID of the corresponding charge on the platform account, if this fee was the result of a charge using the `destination` parameter. */ - originating_transaction?: (Partial & Partial) | null; + originating_transaction?: (Partial & Partial) | null /** @description Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false. */ - refunded: boolean; + refunded: boolean /** * FeeRefundList * @description A list of refunds that have been applied to the fee. */ refunds: { /** @description Details about each object. */ - data: components["schemas"]["fee_refund"][]; + data: components['schemas']['fee_refund'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** AutomaticTax */ automatic_tax: { /** @description Whether Stripe automatically computes tax on this invoice. */ - enabled: boolean; + enabled: boolean /** * @description The status of the most recent automated tax calculation for this invoice. * @enum {string|null} */ - status?: ("complete" | "failed" | "requires_location_inputs") | null; - }; + status?: ('complete' | 'failed' | 'requires_location_inputs') | null + } /** * Balance * @description This is an object representing your Stripe balance. You can retrieve it to see @@ -2381,44 +2375,44 @@ export interface components { */ balance: { /** @description Funds that are available to be transferred or paid out, whether automatically by Stripe or explicitly via the [Transfers API](https://stripe.com/docs/api#transfers) or [Payouts API](https://stripe.com/docs/api#payouts). The available balance for each currency and payment type can be found in the `source_types` property. */ - available: components["schemas"]["balance_amount"][]; + available: components['schemas']['balance_amount'][] /** @description Funds held due to negative balances on connected Custom accounts. The connect reserve balance for each currency and payment type can be found in the `source_types` property. */ - connect_reserved?: components["schemas"]["balance_amount"][]; + connect_reserved?: components['schemas']['balance_amount'][] /** @description Funds that can be paid out using Instant Payouts. */ - instant_available?: components["schemas"]["balance_amount"][]; - issuing?: components["schemas"]["balance_detail"]; + instant_available?: components['schemas']['balance_amount'][] + issuing?: components['schemas']['balance_detail'] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "balance"; + object: 'balance' /** @description Funds that are not yet available in the balance, due to the 7-day rolling pay cycle. The pending balance for each currency, and for each payment type, can be found in the `source_types` property. */ - pending: components["schemas"]["balance_amount"][]; - }; + pending: components['schemas']['balance_amount'][] + } /** BalanceAmount */ balance_amount: { /** @description Balance amount. */ - amount: number; + amount: number /** @description 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: string; - source_types?: components["schemas"]["balance_amount_by_source_type"]; - }; + currency: string + source_types?: components['schemas']['balance_amount_by_source_type'] + } /** BalanceAmountBySourceType */ balance_amount_by_source_type: { /** @description Amount for bank account. */ - bank_account?: number; + bank_account?: number /** @description Amount for card. */ - card?: number; + card?: number /** @description Amount for FPX. */ - fpx?: number; - }; + fpx?: number + } /** BalanceDetail */ balance_detail: { /** @description Funds that are available for use. */ - available: components["schemas"]["balance_amount"][]; - }; + available: components['schemas']['balance_amount'][] + } /** * BalanceTransaction * @description Balance transactions represent funds moving through your Stripe account. @@ -2428,98 +2422,98 @@ export interface components { */ balance_transaction: { /** @description Gross amount of the transaction, in %s. */ - amount: number; + amount: number /** * Format: unix-time * @description The date the transaction's net funds will become available in the Stripe balance. */ - available_on: number; + available_on: number /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description The exchange rate used, if applicable, for this transaction. Specifically, if money was converted from currency A to currency B, then the `amount` in currency A, times `exchange_rate`, would be the `amount` in currency B. For example, suppose you charged a customer 10.00 EUR. Then the PaymentIntent's `amount` would be `1000` and `currency` would be `eur`. Suppose this was converted into 12.34 USD in your Stripe account. Then the BalanceTransaction's `amount` would be `1234`, `currency` would be `usd`, and `exchange_rate` would be `1.234`. */ - exchange_rate?: number | null; + exchange_rate?: number | null /** @description Fees (in %s) paid for this transaction. */ - fee: number; + fee: number /** @description Detailed breakdown of fees (in %s) paid for this transaction. */ - fee_details: components["schemas"]["fee"][]; + fee_details: components['schemas']['fee'][] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Net amount of the transaction, in %s. */ - net: number; + net: number /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "balance_transaction"; + object: 'balance_transaction' /** @description [Learn more](https://stripe.com/docs/reports/reporting-categories) about how reporting categories can help you understand balance transactions from an accounting perspective. */ - reporting_category: string; + reporting_category: string /** @description The Stripe object to which this transaction is related. */ source?: | (Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial) - | null; + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial) + | null /** @description If the transaction's net funds are available in the Stripe balance yet. Either `available` or `pending`. */ - status: string; + status: string /** * @description Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `payment`, `payment_failure_refund`, `payment_refund`, `payout`, `payout_cancel`, `payout_failure`, `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](https://stripe.com/docs/reports/balance-transaction-types) about balance transaction types and what they represent. If you are looking to classify transactions for accounting purposes, you might want to consider `reporting_category` instead. * @enum {string} */ type: - | "adjustment" - | "advance" - | "advance_funding" - | "anticipation_repayment" - | "application_fee" - | "application_fee_refund" - | "charge" - | "connect_collection_transfer" - | "contribution" - | "issuing_authorization_hold" - | "issuing_authorization_release" - | "issuing_dispute" - | "issuing_transaction" - | "payment" - | "payment_failure_refund" - | "payment_refund" - | "payout" - | "payout_cancel" - | "payout_failure" - | "refund" - | "refund_failure" - | "reserve_transaction" - | "reserved_funds" - | "stripe_fee" - | "stripe_fx_fee" - | "tax_fee" - | "topup" - | "topup_reversal" - | "transfer" - | "transfer_cancel" - | "transfer_failure" - | "transfer_refund"; - }; + | 'adjustment' + | 'advance' + | 'advance_funding' + | 'anticipation_repayment' + | 'application_fee' + | 'application_fee_refund' + | 'charge' + | 'connect_collection_transfer' + | 'contribution' + | 'issuing_authorization_hold' + | 'issuing_authorization_release' + | 'issuing_dispute' + | 'issuing_transaction' + | 'payment' + | 'payment_failure_refund' + | 'payment_refund' + | 'payout' + | 'payout_cancel' + | 'payout_failure' + | 'refund' + | 'refund_failure' + | 'reserve_transaction' + | 'reserved_funds' + | 'stripe_fee' + | 'stripe_fx_fee' + | 'tax_fee' + | 'topup' + | 'topup_reversal' + | 'transfer' + | 'transfer_cancel' + | 'transfer_failure' + | 'transfer_refund' + } /** * BankAccount * @description These bank accounts are payment methods on `Customer` objects. @@ -2532,99 +2526,95 @@ export interface components { */ bank_account: { /** @description The ID of the account that the bank account is associated with. */ - account?: (Partial & Partial) | null; + account?: (Partial & Partial) | null /** @description The name of the person or business that owns the bank account. */ - account_holder_name?: string | null; + account_holder_name?: string | null /** @description The type of entity that holds the account. This can be either `individual` or `company`. */ - account_holder_type?: string | null; + account_holder_type?: string | null /** @description 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?: string | null; + account_type?: string | null /** @description 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?: ("instant" | "standard")[] | null; + available_payout_methods?: ('instant' | 'standard')[] | null /** @description Name of the bank associated with the routing number (e.g., `WELLS FARGO`). */ - bank_name?: string | null; + bank_name?: string | null /** @description Two-letter ISO code representing the country the bank account is located in. */ - country: string; + country: string /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. */ - currency: string; + currency: string /** @description The ID of the customer that the bank account is associated with. */ - customer?: - | (Partial & - Partial & - Partial) - | null; + customer?: (Partial & Partial & Partial) | null /** @description Whether this bank account is the default external account for its currency. */ - default_for_currency?: boolean | null; + default_for_currency?: boolean | null /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The last four digits of the bank account number. */ - last4: string; + last4: string /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "bank_account"; + object: 'bank_account' /** @description The routing transit number for the bank account. */ - routing_number?: string | null; + routing_number?: string | null /** * @description For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a transfer sent to this bank account fails, we'll set the status to `errored` and will not continue to send transfers until the bank details are updated. * * For external accounts, possible values are `new` and `errored`. Validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply. If a transfer fails, the status is set to `errored` and transfers are stopped until account details are updated. */ - status: string; - }; + status: string + } /** billing_details */ billing_details: { /** @description Billing address. */ - address?: Partial | null; + address?: Partial | null /** @description Email address. */ - email?: string | null; + email?: string | null /** @description Full name. */ - name?: string | null; + name?: string | null /** @description Billing phone number (including extension). */ - phone?: string | null; - }; + phone?: string | null + } /** * PortalConfiguration * @description A portal configuration describes the functionality and behavior of a portal session. */ - "billing_portal.configuration": { + 'billing_portal.configuration': { /** @description Whether the configuration is active and can be used to create portal sessions. */ - active: boolean; + active: boolean /** @description ID of the Connect Application that created the configuration. */ - application?: string | null; - business_profile: components["schemas"]["portal_business_profile"]; + application?: string | null + business_profile: components['schemas']['portal_business_profile'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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?: string | null; - features: components["schemas"]["portal_features"]; + default_return_url?: string | null + features: components['schemas']['portal_features'] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description 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: boolean; + is_default: boolean /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "billing_portal.configuration"; + object: 'billing_portal.configuration' /** * Format: unix-time * @description Time at which the object was last updated. Measured in seconds since the Unix epoch. */ - updated: number; - }; + updated: number + } /** * PortalSession * @description The Billing customer portal is a Stripe-hosted UI for subscription and @@ -2642,178 +2632,178 @@ export interface components { * * Learn more in the [integration guide](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal). */ - "billing_portal.session": { + 'billing_portal.session': { /** @description The configuration used by this session, describing the features available. */ - configuration: Partial & Partial; + configuration: Partial & Partial /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The ID of the customer for this session. */ - customer: string; + customer: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description 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. * @enum {string|null} */ locale?: | ( - | "auto" - | "bg" - | "cs" - | "da" - | "de" - | "el" - | "en" - | "en-AU" - | "en-CA" - | "en-GB" - | "en-IE" - | "en-IN" - | "en-NZ" - | "en-SG" - | "es" - | "es-419" - | "et" - | "fi" - | "fil" - | "fr" - | "fr-CA" - | "hr" - | "hu" - | "id" - | "it" - | "ja" - | "ko" - | "lt" - | "lv" - | "ms" - | "mt" - | "nb" - | "nl" - | "pl" - | "pt" - | "pt-BR" - | "ro" - | "ru" - | "sk" - | "sl" - | "sv" - | "th" - | "tr" - | "vi" - | "zh" - | "zh-HK" - | "zh-TW" + | 'auto' + | 'bg' + | 'cs' + | 'da' + | 'de' + | 'el' + | 'en' + | 'en-AU' + | 'en-CA' + | 'en-GB' + | 'en-IE' + | 'en-IN' + | 'en-NZ' + | 'en-SG' + | 'es' + | 'es-419' + | 'et' + | 'fi' + | 'fil' + | 'fr' + | 'fr-CA' + | 'hr' + | 'hu' + | 'id' + | 'it' + | 'ja' + | 'ko' + | 'lt' + | 'lv' + | 'ms' + | 'mt' + | 'nb' + | 'nl' + | 'pl' + | 'pt' + | 'pt-BR' + | 'ro' + | 'ru' + | 'sk' + | 'sl' + | 'sv' + | 'th' + | 'tr' + | 'vi' + | 'zh' + | 'zh-HK' + | 'zh-TW' ) - | null; + | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "billing_portal.session"; + object: 'billing_portal.session' /** @description 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/charges-transfers#on-behalf-of). 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?: string | null; + on_behalf_of?: string | null /** @description The URL to redirect customers to when they click on the portal's link to return to your website. */ - return_url: string; + return_url: string /** @description The short-lived URL of the session that gives customers access to the customer portal. */ - url: string; - }; + url: string + } /** BitcoinReceiver */ bitcoin_receiver: { /** @description True when this bitcoin receiver has received a non-zero amount of bitcoin. */ - active: boolean; + active: boolean /** @description The amount of `currency` that you are collecting as payment. */ - amount: number; + amount: number /** @description The amount of `currency` to which `bitcoin_amount_received` has been converted. */ - amount_received: number; + amount_received: number /** @description The amount of bitcoin that the customer should send to fill the receiver. The `bitcoin_amount` is denominated in Satoshi: there are 10^8 Satoshi in one bitcoin. */ - bitcoin_amount: number; + bitcoin_amount: number /** @description The amount of bitcoin that has been sent by the customer to this receiver. */ - bitcoin_amount_received: number; + bitcoin_amount_received: number /** @description This URI can be displayed to the customer as a clickable link (to activate their bitcoin client) or as a QR code (for mobile wallets). */ - bitcoin_uri: string; + bitcoin_uri: string /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) to which the bitcoin will be converted. */ - currency: string; + currency: string /** @description The customer ID of the bitcoin receiver. */ - customer?: string | null; + customer?: string | null /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description The customer's email address, set by the API call that creates the receiver. */ - email?: string | null; + email?: string | null /** @description This flag is initially false and updates to true when the customer sends the `bitcoin_amount` to this receiver. */ - filled: boolean; + filled: boolean /** @description Unique identifier for the object. */ - id: string; + id: string /** @description A bitcoin address that is specific to this receiver. The customer can send bitcoin to this address to fill the receiver. */ - inbound_address: string; + inbound_address: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "bitcoin_receiver"; + object: 'bitcoin_receiver' /** @description The ID of the payment created from the receiver, if any. Hidden when viewing the receiver with a publishable key. */ - payment?: string | null; + payment?: string | null /** @description The refund address of this bitcoin receiver. */ - refund_address?: string | null; + refund_address?: string | null /** * BitcoinTransactionList * @description A list with one entry for each time that the customer sent bitcoin to the receiver. Hidden when viewing the receiver with a publishable key. */ transactions?: { /** @description Details about each object. */ - data: components["schemas"]["bitcoin_transaction"][]; + data: components['schemas']['bitcoin_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** @description This receiver contains uncaptured funds that can be used for a payment or refunded. */ - uncaptured_funds: boolean; + uncaptured_funds: boolean /** @description Indicate if this source is used for payment. */ - used_for_payment?: boolean | null; - }; + used_for_payment?: boolean | null + } /** BitcoinTransaction */ bitcoin_transaction: { /** @description The amount of `currency` that the transaction was converted to in real-time. */ - amount: number; + amount: number /** @description The amount of bitcoin contained in the transaction. */ - bitcoin_amount: number; + bitcoin_amount: number /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) to which this transaction was converted. */ - currency: string; + currency: string /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "bitcoin_transaction"; + object: 'bitcoin_transaction' /** @description The receiver to which this transaction was sent. */ - receiver: string; - }; + receiver: string + } /** * AccountCapability * @description This is an object representing a capability for a Stripe account. @@ -2822,29 +2812,29 @@ export interface components { */ capability: { /** @description The account for which the capability enables functionality. */ - account: Partial & Partial; - future_requirements?: components["schemas"]["account_capability_future_requirements"]; + account: Partial & Partial + future_requirements?: components['schemas']['account_capability_future_requirements'] /** @description The identifier for the capability. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "capability"; + object: 'capability' /** @description Whether the capability has been requested. */ - requested: boolean; + requested: boolean /** * Format: unix-time * @description Time at which the capability was requested. Measured in seconds since the Unix epoch. */ - requested_at?: number | null; - requirements?: components["schemas"]["account_capability_requirements"]; + requested_at?: number | null + requirements?: components['schemas']['account_capability_requirements'] /** * @description The status of the capability. Can be `active`, `inactive`, `pending`, or `unrequested`. * @enum {string} */ - status: "active" | "disabled" | "inactive" | "pending" | "unrequested"; - }; + status: 'active' | 'disabled' | 'inactive' | 'pending' | 'unrequested' + } /** * Card * @description You can store multiple cards on a customer in order to charge the customer @@ -2855,90 +2845,86 @@ export interface components { */ card: { /** @description 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. */ - account?: (Partial & Partial) | null; + account?: (Partial & Partial) | null /** @description City/District/Suburb/Town/Village. */ - address_city?: string | null; + address_city?: string | null /** @description Billing address country, if provided when creating card. */ - address_country?: string | null; + address_country?: string | null /** @description Address line 1 (Street address/PO Box/Company name). */ - address_line1?: string | null; + address_line1?: string | null /** @description If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. */ - address_line1_check?: string | null; + address_line1_check?: string | null /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - address_line2?: string | null; + address_line2?: string | null /** @description State/County/Province/Region. */ - address_state?: string | null; + address_state?: string | null /** @description ZIP or postal code. */ - address_zip?: string | null; + address_zip?: string | null /** @description If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. */ - address_zip_check?: string | null; + address_zip_check?: string | null /** @description 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?: ("instant" | "standard")[] | null; + available_payout_methods?: ('instant' | 'standard')[] | null /** @description Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`. */ - brand: string; + brand: string /** @description 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?: string | null; + country?: string | null /** @description Three-letter [ISO code for currency](https://stripe.com/docs/payouts). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. */ - currency?: string | null; + currency?: string | null /** @description 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?: - | (Partial & - Partial & - Partial) - | null; + customer?: (Partial & Partial & Partial) | null /** @description 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?: string | null; + cvc_check?: string | null /** @description Whether this card is the default external account for its currency. */ - default_for_currency?: boolean | null; + default_for_currency?: boolean | null /** @description (For tokenized numbers only.) The last four digits of the device account number. */ - dynamic_last4?: string | null; + dynamic_last4?: string | null /** @description Two-digit number representing the card's expiration month. */ - exp_month: number; + exp_month: number /** @description Four-digit number representing the card's expiration year. */ - exp_year: number; + exp_year: number /** * @description 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. * * *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.* */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ - funding: string; + funding: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The last four digits of the card. */ - last4: string; + last4: string /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** @description Cardholder name. */ - name?: string | null; + name?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "card"; + object: 'card' /** @description The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead. */ - recipient?: (Partial & Partial) | null; + recipient?: (Partial & Partial) | null /** @description 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?: string | null; - }; + tokenization_method?: string | null + } /** card_generated_from_payment_method_details */ card_generated_from_payment_method_details: { - card_present?: components["schemas"]["payment_method_details_card_present"]; + card_present?: components['schemas']['payment_method_details_card_present'] /** @description The type of payment method transaction-specific details from the transaction that generated this `card` payment method. Always `card_present`. */ - type: string; - }; + type: string + } /** CardIssuingAccountTermsOfService */ card_issuing_account_terms_of_service: { /** @description The Unix timestamp marking when the account representative accepted the service agreement. */ - date?: number | null; + date?: number | null /** @description The IP address from which the account representative accepted the service agreement. */ - ip?: string | null; + ip?: string | null /** @description The user agent of the browser from which the account representative accepted the service agreement. */ - user_agent?: string; - }; + user_agent?: string + } /** card_mandate_payment_method_details */ - card_mandate_payment_method_details: { [key: string]: unknown }; + card_mandate_payment_method_details: { [key: string]: unknown } /** * Charge * @description To charge a credit or a debit card, you create a `Charge` object. You can @@ -2949,152 +2935,148 @@ export interface components { */ charge: { /** @description 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: number; + amount: number /** @description Amount in %s captured (can be less than the amount attribute on the charge if a partial capture was made). */ - amount_captured: number; + amount_captured: number /** @description Amount in %s refunded (can be less than the amount attribute on the charge if a partial refund was issued). */ - amount_refunded: number; + amount_refunded: number /** @description ID of the Connect application that created the charge. */ - application?: (Partial & Partial) | null; + application?: (Partial & Partial) | null /** @description The application fee (if any) for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees) for details. */ - application_fee?: (Partial & Partial) | null; + application_fee?: (Partial & Partial) | null /** @description The amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees) for details. */ - application_fee_amount?: number | null; + application_fee_amount?: number | null /** @description ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes). */ - balance_transaction?: (Partial & Partial) | null; - billing_details: components["schemas"]["billing_details"]; + balance_transaction?: (Partial & Partial) | null + billing_details: components['schemas']['billing_details'] /** @description 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. */ - calculated_statement_descriptor?: string | null; + calculated_statement_descriptor?: string | null /** @description If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured. */ - captured: boolean; + captured: boolean /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description ID of the customer this charge is for if one exists. */ - customer?: - | (Partial & - Partial & - Partial) - | null; + customer?: (Partial & Partial & Partial) | null /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description Whether the charge has been disputed. */ - disputed: boolean; + disputed: boolean /** @description Error code explaining reason for charge failure if available (see [the errors section](https://stripe.com/docs/api#errors) for a list of codes). */ - failure_code?: string | null; + failure_code?: string | null /** @description Message to user further explaining reason for charge failure if available. */ - failure_message?: string | null; + failure_message?: string | null /** @description Information on fraud assessments for the charge. */ - fraud_details?: Partial | null; + fraud_details?: Partial | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description ID of the invoice this charge is for if one exists. */ - invoice?: (Partial & Partial) | null; + invoice?: (Partial & Partial) | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "charge"; + object: 'charge' /** @description 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/charges-transfers) for details. */ - on_behalf_of?: (Partial & Partial) | null; + on_behalf_of?: (Partial & Partial) | null /** @description ID of the order this charge is for if one exists. */ - order?: (Partial & Partial) | null; + order?: (Partial & Partial) | null /** @description Details about whether the payment was accepted, and why. See [understanding declines](https://stripe.com/docs/declines) for details. */ - outcome?: Partial | null; + outcome?: Partial | null /** @description `true` if the charge succeeded, or was successfully authorized for later capture. */ - paid: boolean; + paid: boolean /** @description ID of the PaymentIntent associated with this charge, if one exists. */ - payment_intent?: (Partial & Partial) | null; + payment_intent?: (Partial & Partial) | null /** @description ID of the payment method used in this charge. */ - payment_method?: string | null; + payment_method?: string | null /** @description Details about the payment method at the time of the transaction. */ - payment_method_details?: Partial | null; + payment_method_details?: Partial | null /** @description This is the email address that the receipt for this charge was sent to. */ - receipt_email?: string | null; + receipt_email?: string | null /** @description 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?: string | null; + receipt_number?: string | null /** @description 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?: string | null; + receipt_url?: string | null /** @description Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false. */ - refunded: boolean; + refunded: boolean /** * RefundList * @description A list of refunds that have been applied to the charge. */ refunds: { /** @description Details about each object. */ - data: components["schemas"]["refund"][]; + data: components['schemas']['refund'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** @description ID of the review associated with this charge if one exists. */ - review?: (Partial & Partial) | null; + review?: (Partial & Partial) | null /** @description Shipping information for the charge. */ - shipping?: Partial | null; + shipping?: Partial | null /** @description The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details. */ - source_transfer?: (Partial & Partial) | null; + source_transfer?: (Partial & Partial) | null /** @description For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - statement_descriptor?: string | null; + statement_descriptor?: string | null /** @description Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - statement_descriptor_suffix?: string | null; + statement_descriptor_suffix?: string | null /** * @description The status of the payment is either `succeeded`, `pending`, or `failed`. * @enum {string} */ - status: "failed" | "pending" | "succeeded"; + status: 'failed' | 'pending' | 'succeeded' /** @description ID of the transfer to the `destination` account (only applicable if the charge was created using the `destination` parameter). */ - transfer?: Partial & Partial; + transfer?: Partial & Partial /** @description 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?: Partial | null; + transfer_data?: Partial | null /** @description A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-options) for details. */ - transfer_group?: string | null; - }; + transfer_group?: string | null + } /** ChargeFraudDetails */ charge_fraud_details: { /** @description Assessments from Stripe. If set, the value is `fraudulent`. */ - stripe_report?: string; + stripe_report?: string /** @description Assessments reported by you. If set, possible values of are `safe` and `fraudulent`. */ - user_report?: string; - }; + user_report?: string + } /** ChargeOutcome */ charge_outcome: { /** @description 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?: string | null; + network_status?: string | null /** @description 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?: string | null; + reason?: string | null /** @description 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?: string; + risk_level?: string /** @description 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?: number; + risk_score?: number /** @description The ID of the Radar rule that matched the payment, if applicable. */ - rule?: Partial & Partial; + rule?: Partial & Partial /** @description A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer. */ - seller_message?: string | null; + seller_message?: string | null /** @description 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: string; - }; + type: string + } /** ChargeTransferData */ charge_transfer_data: { /** @description The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account. */ - amount?: number | null; + amount?: number | null /** @description ID of an existing, connected Stripe account to transfer funds to if `transfer_data` was specified in the charge request. */ - destination: Partial & Partial; - }; + destination: Partial & Partial + } /** * Session * @description A Checkout Session represents your customer's session as they pay for @@ -3112,35 +3094,35 @@ export interface components { * * Related guide: [Checkout Server Quickstart](https://stripe.com/docs/payments/checkout/api). */ - "checkout.session": { + 'checkout.session': { /** @description When set, provides configuration for actions to take if this Checkout Session expires. */ - after_expiration?: Partial | null; + after_expiration?: Partial | null /** @description Enables user redeemable promotion codes. */ - allow_promotion_codes?: boolean | null; + allow_promotion_codes?: boolean | null /** @description Total of all items before discounts or taxes are applied. */ - amount_subtotal?: number | null; + amount_subtotal?: number | null /** @description Total of all items after discounts and taxes are applied. */ - amount_total?: number | null; - automatic_tax: components["schemas"]["payment_pages_checkout_session_automatic_tax"]; + amount_total?: number | null + automatic_tax: components['schemas']['payment_pages_checkout_session_automatic_tax'] /** * @description Describes whether Checkout should collect the customer's billing address. * @enum {string|null} */ - billing_address_collection?: ("auto" | "required") | null; + billing_address_collection?: ('auto' | 'required') | null /** @description The URL the customer will be directed to if they decide to cancel payment and return to your website. */ - cancel_url: string; + cancel_url: string /** * @description A unique string to reference the Checkout Session. This can be a * customer ID, a cart ID, or similar, and can be used to reconcile the * Session with your internal systems. */ - client_reference_id?: string | null; + client_reference_id?: string | null /** @description Results of `consent_collection` for this session. */ - consent?: Partial | null; + consent?: Partial | null /** @description When set, provides configuration for the Checkout Session to gather active consent from customers. */ - consent_collection?: Partial | null; + consent_collection?: Partial | null /** @description 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?: string | null; + currency?: string | null /** * @description The ID of the customer for this Session. * For Checkout Sessions in `payment` or `subscription` mode, Checkout @@ -3148,18 +3130,14 @@ export interface components { * during the payment flow unless an existing customer was provided when * the Session was created. */ - customer?: - | (Partial & - Partial & - Partial) - | null; + customer?: (Partial & Partial & Partial) | null /** * @description Configure whether a Checkout Session creates a Customer when the Checkout Session completes. * @enum {string|null} */ - customer_creation?: ("always" | "if_required") | null; + customer_creation?: ('always' | 'if_required') | null /** @description The customer details including the customer's tax exempt status and the customer's tax IDs. Only present on Sessions in `payment` or `subscription` mode. */ - customer_details?: Partial | null; + customer_details?: Partial | null /** * @description 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. @@ -3167,134 +3145,132 @@ export interface components { * on file. To access information about the customer once the payment flow is * complete, use the `customer` attribute. */ - customer_email?: string | null; + customer_email?: string | null /** * Format: unix-time * @description The timestamp at which the Checkout Session will expire. */ - expires_at: number; + expires_at: number /** * @description Unique identifier for the object. Used to pass to `redirectToCheckout` * in Stripe.js. */ - id: string; + id: string /** * PaymentPagesCheckoutSessionListLineItems * @description The line items purchased by the customer. */ line_items?: { /** @description Details about each object. */ - data: components["schemas"]["item"][]; + data: components['schemas']['item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used. * @enum {string|null} */ locale?: | ( - | "auto" - | "bg" - | "cs" - | "da" - | "de" - | "el" - | "en" - | "en-GB" - | "es" - | "es-419" - | "et" - | "fi" - | "fil" - | "fr" - | "fr-CA" - | "hr" - | "hu" - | "id" - | "it" - | "ja" - | "ko" - | "lt" - | "lv" - | "ms" - | "mt" - | "nb" - | "nl" - | "pl" - | "pt" - | "pt-BR" - | "ro" - | "ru" - | "sk" - | "sl" - | "sv" - | "th" - | "tr" - | "vi" - | "zh" - | "zh-HK" - | "zh-TW" + | 'auto' + | 'bg' + | 'cs' + | 'da' + | 'de' + | 'el' + | 'en' + | 'en-GB' + | 'es' + | 'es-419' + | 'et' + | 'fi' + | 'fil' + | 'fr' + | 'fr-CA' + | 'hr' + | 'hu' + | 'id' + | 'it' + | 'ja' + | 'ko' + | 'lt' + | 'lv' + | 'ms' + | 'mt' + | 'nb' + | 'nl' + | 'pl' + | 'pt' + | 'pt-BR' + | 'ro' + | 'ru' + | 'sk' + | 'sl' + | 'sv' + | 'th' + | 'tr' + | 'vi' + | 'zh' + | 'zh-HK' + | 'zh-TW' ) - | null; + | null /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description The mode of the Checkout Session. * @enum {string} */ - mode: "payment" | "setup" | "subscription"; + mode: 'payment' | 'setup' | 'subscription' /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "checkout.session"; + object: 'checkout.session' /** @description The ID of the PaymentIntent for Checkout Sessions in `payment` mode. */ - payment_intent?: (Partial & Partial) | null; + payment_intent?: (Partial & Partial) | null /** @description The ID of the Payment Link that created this Session. */ - payment_link?: (Partial & Partial) | null; + payment_link?: (Partial & Partial) | null /** @description Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession. */ - payment_method_options?: Partial | null; + payment_method_options?: Partial | null /** * @description A list of the types of payment methods (e.g. card) this Checkout * Session is allowed to accept. */ - payment_method_types: string[]; + payment_method_types: string[] /** * @description The payment status of the Checkout Session, one of `paid`, `unpaid`, or `no_payment_required`. * You can use this value to decide when to fulfill your customer's order. * @enum {string} */ - payment_status: "no_payment_required" | "paid" | "unpaid"; - phone_number_collection?: components["schemas"]["payment_pages_checkout_session_phone_number_collection"]; + payment_status: 'no_payment_required' | 'paid' | 'unpaid' + phone_number_collection?: components['schemas']['payment_pages_checkout_session_phone_number_collection'] /** @description The ID of the original expired Checkout Session that triggered the recovery flow. */ - recovered_from?: string | null; + recovered_from?: string | null /** @description The ID of the SetupIntent for Checkout Sessions in `setup` mode. */ - setup_intent?: (Partial & Partial) | null; + setup_intent?: (Partial & Partial) | null /** @description Shipping information for this Checkout Session. */ - shipping?: Partial | null; + shipping?: Partial | null /** @description When set, provides configuration for Checkout to collect a shipping address from a customer. */ - shipping_address_collection?: Partial< - components["schemas"]["payment_pages_checkout_session_shipping_address_collection"] - > | null; + shipping_address_collection?: Partial | null /** @description The shipping rate options applied to this Session. */ - shipping_options: components["schemas"]["payment_pages_checkout_session_shipping_option"][]; + shipping_options: components['schemas']['payment_pages_checkout_session_shipping_option'][] /** @description The ID of the ShippingRate for Checkout Sessions in `payment` mode. */ - shipping_rate?: (Partial & Partial) | null; + shipping_rate?: (Partial & Partial) | null /** * @description The status of the Checkout Session, one of `open`, `complete`, or `expired`. * @enum {string|null} */ - status?: ("complete" | "expired" | "open") | null; + status?: ('complete' | 'expired' | 'open') | null /** * @description Describes the type of transaction being performed by Checkout in order to customize * relevant text on the page, such as the submit button. `submit_type` can only be @@ -3302,87 +3278,87 @@ export interface components { * in `subscription` or `setup` mode. * @enum {string|null} */ - submit_type?: ("auto" | "book" | "donate" | "pay") | null; + submit_type?: ('auto' | 'book' | 'donate' | 'pay') | null /** @description The ID of the subscription for Checkout Sessions in `subscription` mode. */ - subscription?: (Partial & Partial) | null; + subscription?: (Partial & Partial) | null /** * @description The URL the customer will be directed to after the payment or * subscription creation is successful. */ - success_url: string; - tax_id_collection?: components["schemas"]["payment_pages_checkout_session_tax_id_collection"]; + success_url: string + tax_id_collection?: components['schemas']['payment_pages_checkout_session_tax_id_collection'] /** @description Tax and discount details for the computed total amount. */ - total_details?: Partial | null; + total_details?: Partial | null /** @description The URL to the Checkout Session. */ - url?: string | null; - }; + url?: string | null + } /** CheckoutAcssDebitMandateOptions */ checkout_acss_debit_mandate_options: { /** @description A URL for custom mandate text */ - custom_mandate_url?: string; + custom_mandate_url?: string /** @description List of Stripe products where this mandate can be selected automatically. Returned when the Session is in `setup` mode. */ - default_for?: ("invoice" | "subscription")[]; + default_for?: ('invoice' | 'subscription')[] /** @description Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. */ - interval_description?: string | null; + interval_description?: string | null /** * @description Payment schedule for the mandate. * @enum {string|null} */ - payment_schedule?: ("combined" | "interval" | "sporadic") | null; + payment_schedule?: ('combined' | 'interval' | 'sporadic') | null /** * @description Transaction type of the mandate. * @enum {string|null} */ - transaction_type?: ("business" | "personal") | null; - }; + transaction_type?: ('business' | 'personal') | null + } /** CheckoutAcssDebitPaymentMethodOptions */ checkout_acss_debit_payment_method_options: { /** * @description Currency supported by the bank account. Returned when the Session is in `setup` mode. * @enum {string} */ - currency?: "cad" | "usd"; - mandate_options?: components["schemas"]["checkout_acss_debit_mandate_options"]; + currency?: 'cad' | 'usd' + mandate_options?: components['schemas']['checkout_acss_debit_mandate_options'] /** * @description Bank account verification method. * @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; - }; + verification_method?: 'automatic' | 'instant' | 'microdeposits' + } /** CheckoutBoletoPaymentMethodOptions */ checkout_boleto_payment_method_options: { /** @description 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: number; - }; + expires_after_days: number + } /** CheckoutOxxoPaymentMethodOptions */ checkout_oxxo_payment_method_options: { /** @description 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: number; - }; + expires_after_days: number + } /** CheckoutSessionPaymentMethodOptions */ checkout_session_payment_method_options: { - acss_debit?: components["schemas"]["checkout_acss_debit_payment_method_options"]; - boleto?: components["schemas"]["checkout_boleto_payment_method_options"]; - oxxo?: components["schemas"]["checkout_oxxo_payment_method_options"]; - }; + acss_debit?: components['schemas']['checkout_acss_debit_payment_method_options'] + boleto?: components['schemas']['checkout_boleto_payment_method_options'] + oxxo?: components['schemas']['checkout_oxxo_payment_method_options'] + } /** ConnectCollectionTransfer */ connect_collection_transfer: { /** @description Amount transferred, in %s. */ - amount: number; + amount: number /** @description 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: string; + currency: string /** @description ID of the account that funds are being collected for. */ - destination: Partial & Partial; + destination: Partial & Partial /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "connect_collection_transfer"; - }; + object: 'connect_collection_transfer' + } /** * CountrySpec * @description Stripe needs to collect certain pieces of information about each account @@ -3394,36 +3370,36 @@ export interface components { */ country_spec: { /** @description The default currency for this country. This applies to both payment methods and bank accounts. */ - default_currency: string; + default_currency: string /** @description Unique identifier for the object. Represented as the ISO country code for this country. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "country_spec"; + object: 'country_spec' /** @description Currencies that can be accepted in the specific country (for transfers). */ - supported_bank_account_currencies: { [key: string]: string[] }; + supported_bank_account_currencies: { [key: string]: string[] } /** @description Currencies that can be accepted in the specified country (for payments). */ - supported_payment_currencies: string[]; + supported_payment_currencies: string[] /** @description 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: string[]; + supported_payment_methods: string[] /** @description Countries that can accept transfers from the specified country. */ - supported_transfer_countries: string[]; - verification_fields: components["schemas"]["country_spec_verification_fields"]; - }; + supported_transfer_countries: string[] + verification_fields: components['schemas']['country_spec_verification_fields'] + } /** CountrySpecVerificationFieldDetails */ country_spec_verification_field_details: { /** @description Additional fields which are only required for some users. */ - additional: string[]; + additional: string[] /** @description Fields which every account must eventually provide. */ - minimum: string[]; - }; + minimum: string[] + } /** CountrySpecVerificationFields */ country_spec_verification_fields: { - company: components["schemas"]["country_spec_verification_field_details"]; - individual: components["schemas"]["country_spec_verification_field_details"]; - }; + company: components['schemas']['country_spec_verification_field_details'] + individual: components['schemas']['country_spec_verification_field_details'] + } /** * Coupon * @description A coupon contains information about a percent-off or amount-off discount you @@ -3432,54 +3408,54 @@ export interface components { */ coupon: { /** @description Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer. */ - amount_off?: number | null; - applies_to?: components["schemas"]["coupon_applies_to"]; + amount_off?: number | null + applies_to?: components['schemas']['coupon_applies_to'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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?: string | null; + currency?: string | null /** * @description One of `forever`, `once`, and `repeating`. Describes how long a customer who applies this coupon will get the discount. * @enum {string} */ - duration: "forever" | "once" | "repeating"; + duration: 'forever' | 'once' | 'repeating' /** @description If `duration` is `repeating`, the number of months the coupon applies. Null if coupon `duration` is `forever` or `once`. */ - duration_in_months?: number | null; + duration_in_months?: number | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid. */ - max_redemptions?: number | null; + max_redemptions?: number | null /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** @description Name of the coupon displayed to customers on for instance invoices or receipts. */ - name?: string | null; + name?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "coupon"; + object: 'coupon' /** @description 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 %s100 invoice %s50 instead. */ - percent_off?: number | null; + percent_off?: number | null /** * Format: unix-time * @description Date after which the coupon can no longer be redeemed. */ - redeem_by?: number | null; + redeem_by?: number | null /** @description Number of times this coupon has been applied to a customer. */ - times_redeemed: number; + times_redeemed: number /** @description Taking account of the above properties, whether this coupon can still be applied to a customer. */ - valid: boolean; - }; + valid: boolean + } /** CouponAppliesTo */ coupon_applies_to: { /** @description A list of product IDs this coupon applies to */ - products: string[]; - }; + products: string[] + } /** * CreditNote * @description Issue a credit note to adjust an invoice's amount after the invoice is finalized. @@ -3488,142 +3464,138 @@ export interface components { */ credit_note: { /** @description The integer amount in %s representing the total amount of the credit note, including tax. */ - amount: number; + amount: number /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description ID of the customer. */ - customer: Partial & - Partial & - Partial; + customer: Partial & Partial & Partial /** @description Customer balance transaction related to this credit note. */ - customer_balance_transaction?: - | (Partial & Partial) - | null; + customer_balance_transaction?: (Partial & Partial) | null /** @description The integer amount in %s representing the total amount of discount that was credited. */ - discount_amount: number; + discount_amount: number /** @description The aggregate amounts calculated per discount for all line items. */ - discount_amounts: components["schemas"]["discounts_resource_discount_amount"][]; + discount_amounts: components['schemas']['discounts_resource_discount_amount'][] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description ID of the invoice. */ - invoice: Partial & Partial; + invoice: Partial & Partial /** * CreditNoteLinesList * @description Line items that make up the credit note */ lines: { /** @description Details about each object. */ - data: components["schemas"]["credit_note_line_item"][]; + data: components['schemas']['credit_note_line_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description Customer-facing text that appears on the credit note PDF. */ - memo?: string | null; + memo?: string | null /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** @description A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice. */ - number: string; + number: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "credit_note"; + object: 'credit_note' /** @description Amount that was credited outside of Stripe. */ - out_of_band_amount?: number | null; + out_of_band_amount?: number | null /** @description The link to download the PDF of the credit note. */ - pdf: string; + pdf: string /** * @description Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` * @enum {string|null} */ - reason?: ("duplicate" | "fraudulent" | "order_change" | "product_unsatisfactory") | null; + reason?: ('duplicate' | 'fraudulent' | 'order_change' | 'product_unsatisfactory') | null /** @description Refund related to this credit note. */ - refund?: (Partial & Partial) | null; + refund?: (Partial & Partial) | null /** * @description 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). * @enum {string} */ - status: "issued" | "void"; + status: 'issued' | 'void' /** @description The integer amount in %s representing the amount of the credit note, excluding tax and invoice level discounts. */ - subtotal: number; + subtotal: number /** @description The aggregate amounts calculated per tax rate for all line items. */ - tax_amounts: components["schemas"]["credit_note_tax_amount"][]; + tax_amounts: components['schemas']['credit_note_tax_amount'][] /** @description The integer amount in %s representing the total amount of the credit note, including tax and all discount. */ - total: number; + total: number /** * @description 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. * @enum {string} */ - type: "post_payment" | "pre_payment"; + type: 'post_payment' | 'pre_payment' /** * Format: unix-time * @description The time that the credit note was voided. */ - voided_at?: number | null; - }; + voided_at?: number | null + } /** CreditNoteLineItem */ credit_note_line_item: { /** @description The integer amount in %s representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts. */ - amount: number; + amount: number /** @description Description of the item being credited. */ - description?: string | null; + description?: string | null /** @description The integer amount in %s representing the discount being credited for this line item. */ - discount_amount: number; + discount_amount: number /** @description The amount of discount calculated per discount for this line item */ - discount_amounts: components["schemas"]["discounts_resource_discount_amount"][]; + discount_amounts: components['schemas']['discounts_resource_discount_amount'][] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description ID of the invoice line item being credited */ - invoice_line_item?: string; + invoice_line_item?: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "credit_note_line_item"; + object: 'credit_note_line_item' /** @description The number of units of product being credited. */ - quantity?: number | null; + quantity?: number | null /** @description The amount of tax calculated per tax rate for this line item */ - tax_amounts: components["schemas"]["credit_note_tax_amount"][]; + tax_amounts: components['schemas']['credit_note_tax_amount'][] /** @description The tax rates which apply to the line item. */ - tax_rates: components["schemas"]["tax_rate"][]; + tax_rates: components['schemas']['tax_rate'][] /** * @description 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. * @enum {string} */ - type: "custom_line_item" | "invoice_line_item"; + type: 'custom_line_item' | 'invoice_line_item' /** @description The cost of each unit of product being credited. */ - unit_amount?: number | null; + unit_amount?: number | null /** * Format: decimal * @description Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. */ - unit_amount_decimal?: string | null; - }; + unit_amount_decimal?: string | null + } /** CreditNoteTaxAmount */ credit_note_tax_amount: { /** @description The amount, in %s, of the tax. */ - amount: number; + amount: number /** @description Whether this tax amount is inclusive or exclusive. */ - inclusive: boolean; + inclusive: boolean /** @description The tax rate that was applied to get this tax amount. */ - tax_rate: Partial & Partial; - }; + tax_rate: Partial & Partial + } /** * Customer * @description This object represents a customer of your business. It lets you create recurring charges and track payments that belong to the same customer. @@ -3632,16 +3604,16 @@ export interface components { */ customer: { /** @description The customer's address. */ - address?: Partial | null; + address?: Partial | null /** @description Current balance, if any, being 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 will be added to their next invoice. The balance does not refer to any unpaid invoices; it solely takes into account amounts that have yet to be successfully applied to any invoice. This balance is only taken into account as invoices are finalized. */ - balance?: number; + balance?: number /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes. */ - currency?: string | null; + currency?: string | null /** * @description ID of the default payment source for the customer. * @@ -3649,125 +3621,125 @@ export interface components { */ default_source?: | (Partial & - Partial & - Partial & - Partial & - Partial & - Partial) - | null; + Partial & + Partial & + Partial & + Partial & + Partial) + | null /** * @description When the customer's latest invoice is billed by charging automatically, `delinquent` is `true` if the invoice's latest charge failed. When the customer's latest invoice is billed by sending an invoice, `delinquent` is `true` if the invoice isn't paid by its due date. * * If an invoice is marked uncollectible by [dunning](https://stripe.com/docs/billing/automatic-collection), `delinquent` doesn't get reset to `false`. */ - delinquent?: boolean | null; + delinquent?: boolean | null /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description Describes the current discount active on the customer, if there is one. */ - discount?: Partial | null; + discount?: Partial | null /** @description The customer's email address. */ - email?: string | null; + email?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The prefix for the customer used to generate unique invoice numbers. */ - invoice_prefix?: string | null; - invoice_settings?: components["schemas"]["invoice_setting_customer_setting"]; + invoice_prefix?: string | null + invoice_settings?: components['schemas']['invoice_setting_customer_setting'] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The customer's full name or business name. */ - name?: string | null; + name?: string | null /** @description The suffix of the customer's next invoice number, e.g., 0001. */ - next_invoice_sequence?: number; + next_invoice_sequence?: number /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "customer"; + object: 'customer' /** @description The customer's phone number. */ - phone?: string | null; + phone?: string | null /** @description The customer's preferred locales (languages), ordered by preference. */ - preferred_locales?: string[] | null; + preferred_locales?: string[] | null /** @description Mailing and shipping address for the customer. Appears on invoices emailed to this customer. */ - shipping?: Partial | null; + shipping?: Partial | null /** * ApmsSourcesSourceList * @description The customer's payment sources, if any. */ sources?: { /** @description Details about each object. */ - data: (Partial & - Partial & - Partial & - Partial & - Partial)[]; + data: (Partial & + Partial & + Partial & + Partial & + Partial)[] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** * SubscriptionList * @description The customer's current subscriptions, if any. */ subscriptions?: { /** @description Details about each object. */ - data: components["schemas"]["subscription"][]; + data: components['schemas']['subscription'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - tax?: components["schemas"]["customer_tax"]; + url: string + } + tax?: components['schemas']['customer_tax'] /** * @description Describes the customer's tax exemption status. One of `none`, `exempt`, or `reverse`. When set to `reverse`, invoice and receipt PDFs include the text **"Reverse charge"**. * @enum {string|null} */ - tax_exempt?: ("exempt" | "none" | "reverse") | null; + tax_exempt?: ('exempt' | 'none' | 'reverse') | null /** * TaxIDsList * @description The customer's tax IDs. */ tax_ids?: { /** @description Details about each object. */ - data: components["schemas"]["tax_id"][]; + data: components['schemas']['tax_id'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** customer_acceptance */ customer_acceptance: { /** * Format: unix-time * @description The time at which the customer accepted the Mandate. */ - accepted_at?: number | null; - offline?: components["schemas"]["offline_acceptance"]; - online?: components["schemas"]["online_acceptance"]; + accepted_at?: number | null + offline?: components['schemas']['offline_acceptance'] + online?: components['schemas']['online_acceptance'] /** * @description The type of customer acceptance information included with the Mandate. One of `online` or `offline`. * @enum {string} */ - type: "offline" | "online"; - }; + type: 'offline' | 'online' + } /** * CustomerBalanceTransaction * @description Each customer has a [`balance`](https://stripe.com/docs/api/customers/object#customer_object-balance) value, @@ -3779,479 +3751,474 @@ export interface components { */ customer_balance_transaction: { /** @description 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: number; + amount: number /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The ID of the credit note (if any) related to the transaction. */ - credit_note?: (Partial & Partial) | null; + credit_note?: (Partial & Partial) | null /** @description 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: string; + currency: string /** @description The ID of the customer the transaction belongs to. */ - customer: Partial & Partial; + customer: Partial & Partial /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description 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: number; + ending_balance: number /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The ID of the invoice (if any) related to the transaction. */ - invoice?: (Partial & Partial) | null; + invoice?: (Partial & Partial) | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "customer_balance_transaction"; + object: 'customer_balance_transaction' /** * @description Transaction type: `adjustment`, `applied_to_invoice`, `credit_note`, `initial`, `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. * @enum {string} */ type: - | "adjustment" - | "applied_to_invoice" - | "credit_note" - | "initial" - | "invoice_too_large" - | "invoice_too_small" - | "migration" - | "unapplied_from_invoice" - | "unspent_receiver_credit"; - }; + | 'adjustment' + | 'applied_to_invoice' + | 'credit_note' + | 'initial' + | 'invoice_too_large' + | 'invoice_too_small' + | 'migration' + | 'unapplied_from_invoice' + | 'unspent_receiver_credit' + } /** CustomerTax */ customer_tax: { /** * @description Surfaces if automatic tax computation is possible given the current customer location information. * @enum {string} */ - automatic_tax: "failed" | "not_collecting" | "supported" | "unrecognized_location"; + automatic_tax: 'failed' | 'not_collecting' | 'supported' | 'unrecognized_location' /** @description A recent IP address of the customer used for tax reporting and tax location inference. */ - ip_address?: string | null; + ip_address?: string | null /** @description The customer's location as identified by Stripe Tax. */ - location?: Partial | null; - }; + location?: Partial | null + } /** CustomerTaxLocation */ customer_tax_location: { /** @description The customer's country as identified by Stripe Tax. */ - country: string; + country: string /** * @description The data source used to infer the customer's location. * @enum {string} */ - source: "billing_address" | "ip_address" | "payment_method" | "shipping_destination"; + source: 'billing_address' | 'ip_address' | 'payment_method' | 'shipping_destination' /** @description The customer's state, county, province, or region as identified by Stripe Tax. */ - state?: string | null; - }; + state?: string | null + } /** DeletedAccount */ deleted_account: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "account"; - }; + object: 'account' + } /** AlipayDeletedAccount */ deleted_alipay_account: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "alipay_account"; - }; + object: 'alipay_account' + } /** DeletedApplePayDomain */ deleted_apple_pay_domain: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "apple_pay_domain"; - }; + object: 'apple_pay_domain' + } /** DeletedBankAccount */ deleted_bank_account: { /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. */ - currency?: string | null; + currency?: string | null /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "bank_account"; - }; + object: 'bank_account' + } /** BitcoinDeletedReceiver */ deleted_bitcoin_receiver: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "bitcoin_receiver"; - }; + object: 'bitcoin_receiver' + } /** DeletedCard */ deleted_card: { /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. */ - currency?: string | null; + currency?: string | null /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "card"; - }; + object: 'card' + } /** DeletedCoupon */ deleted_coupon: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "coupon"; - }; + object: 'coupon' + } /** DeletedCustomer */ deleted_customer: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "customer"; - }; + object: 'customer' + } /** DeletedDiscount */ deleted_discount: { /** @description 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?: string | null; - coupon: components["schemas"]["coupon"]; + checkout_session?: string | null + coupon: components['schemas']['coupon'] /** @description The ID of the customer associated with this discount. */ - customer?: - | (Partial & - Partial & - Partial) - | null; + customer?: (Partial & Partial & Partial) | null /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description 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: string; + id: string /** @description The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice. */ - invoice?: string | null; + invoice?: string | null /** @description 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?: string | null; + invoice_item?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "discount"; + object: 'discount' /** @description The promotion code applied to create this discount. */ - promotion_code?: (Partial & Partial) | null; + promotion_code?: (Partial & Partial) | null /** * Format: unix-time * @description Date that the coupon was applied. */ - start: number; + start: number /** @description The subscription that this coupon is applied to, if it is applied to a particular subscription. */ - subscription?: string | null; - }; + subscription?: string | null + } /** Polymorphic */ - deleted_external_account: Partial & - Partial; + deleted_external_account: Partial & Partial /** DeletedInvoice */ deleted_invoice: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "invoice"; - }; + object: 'invoice' + } /** DeletedInvoiceItem */ deleted_invoiceitem: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "invoiceitem"; - }; + object: 'invoiceitem' + } /** Polymorphic */ - deleted_payment_source: Partial & - Partial & - Partial & - Partial; + deleted_payment_source: Partial & + Partial & + Partial & + Partial /** DeletedPerson */ deleted_person: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "person"; - }; + object: 'person' + } /** DeletedPlan */ deleted_plan: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "plan"; - }; + object: 'plan' + } /** DeletedPrice */ deleted_price: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "price"; - }; + object: 'price' + } /** DeletedProduct */ deleted_product: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "product"; - }; + object: 'product' + } /** RadarListDeletedList */ - "deleted_radar.value_list": { + 'deleted_radar.value_list': { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "radar.value_list"; - }; + object: 'radar.value_list' + } /** RadarListDeletedListItem */ - "deleted_radar.value_list_item": { + 'deleted_radar.value_list_item': { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "radar.value_list_item"; - }; + object: 'radar.value_list_item' + } /** DeletedTransferRecipient */ deleted_recipient: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "recipient"; - }; + object: 'recipient' + } /** DeletedSku */ deleted_sku: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "sku"; - }; + object: 'sku' + } /** DeletedSubscriptionItem */ deleted_subscription_item: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "subscription_item"; - }; + object: 'subscription_item' + } /** deleted_tax_id */ deleted_tax_id: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "tax_id"; - }; + object: 'tax_id' + } /** TerminalLocationDeletedLocation */ - "deleted_terminal.location": { + 'deleted_terminal.location': { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "terminal.location"; - }; + object: 'terminal.location' + } /** TerminalReaderDeletedReader */ - "deleted_terminal.reader": { + 'deleted_terminal.reader': { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "terminal.reader"; - }; + object: 'terminal.reader' + } /** NotificationWebhookEndpointDeleted */ deleted_webhook_endpoint: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "webhook_endpoint"; - }; + object: 'webhook_endpoint' + } /** DeliveryEstimate */ delivery_estimate: { /** @description If `type` is `"exact"`, `date` will be the expected delivery date in the format YYYY-MM-DD. */ - date?: string; + date?: string /** @description If `type` is `"range"`, `earliest` will be be the earliest delivery date in the format YYYY-MM-DD. */ - earliest?: string; + earliest?: string /** @description If `type` is `"range"`, `latest` will be the latest delivery date in the format YYYY-MM-DD. */ - latest?: string; + latest?: string /** @description The type of estimate. Must be either `"range"` or `"exact"`. */ - type: string; - }; + type: string + } /** * Discount * @description A discount represents the actual application of a coupon to a particular @@ -4262,49 +4229,43 @@ export interface components { */ discount: { /** @description 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?: string | null; - coupon: components["schemas"]["coupon"]; + checkout_session?: string | null + coupon: components['schemas']['coupon'] /** @description The ID of the customer associated with this discount. */ - customer?: - | (Partial & - Partial & - Partial) - | null; + customer?: (Partial & Partial & Partial) | null /** * Format: unix-time * @description 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?: number | null; + end?: number | null /** @description 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: string; + id: string /** @description The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice. */ - invoice?: string | null; + invoice?: string | null /** @description 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?: string | null; + invoice_item?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "discount"; + object: 'discount' /** @description The promotion code applied to create this discount. */ - promotion_code?: (Partial & Partial) | null; + promotion_code?: (Partial & Partial) | null /** * Format: unix-time * @description Date that the coupon was applied. */ - start: number; + start: number /** @description The subscription that this coupon is applied to, if it is applied to a particular subscription. */ - subscription?: string | null; - }; + subscription?: string | null + } /** DiscountsResourceDiscountAmount */ discounts_resource_discount_amount: { /** @description The amount, in %s, of the discount. */ - amount: number; + amount: number /** @description The discount that was applied to get this discount amount. */ - discount: Partial & - Partial & - Partial; - }; + discount: Partial & Partial & Partial + } /** * Dispute * @description A dispute occurs when a customer questions your charge with their card issuer. @@ -4317,150 +4278,150 @@ export interface components { */ dispute: { /** @description Disputed amount. Usually the amount of the charge, but can differ (usually because of currency fluctuation or because only part of the order is disputed). */ - amount: number; + amount: number /** @description 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: components["schemas"]["balance_transaction"][]; + balance_transactions: components['schemas']['balance_transaction'][] /** @description ID of the charge that was disputed. */ - charge: Partial & Partial; + charge: Partial & Partial /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; - evidence: components["schemas"]["dispute_evidence"]; - evidence_details: components["schemas"]["dispute_evidence_details"]; + currency: string + evidence: components['schemas']['dispute_evidence'] + evidence_details: components['schemas']['dispute_evidence_details'] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description If true, it is still possible to refund the disputed payment. Once the payment has been fully refunded, no further funds will be withdrawn from your Stripe account as a result of this dispute. */ - is_charge_refundable: boolean; + is_charge_refundable: boolean /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "dispute"; + object: 'dispute' /** @description ID of the PaymentIntent that was disputed. */ - payment_intent?: (Partial & Partial) | null; + payment_intent?: (Partial & Partial) | null /** @description 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`. Read more about [dispute reasons](https://stripe.com/docs/disputes/categories). */ - reason: string; + reason: string /** * @description Current status of dispute. Possible values are `warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `charge_refunded`, `won`, or `lost`. * @enum {string} */ status: - | "charge_refunded" - | "lost" - | "needs_response" - | "under_review" - | "warning_closed" - | "warning_needs_response" - | "warning_under_review" - | "won"; - }; + | 'charge_refunded' + | 'lost' + | 'needs_response' + | 'under_review' + | 'warning_closed' + | 'warning_needs_response' + | 'warning_under_review' + | 'won' + } /** DisputeEvidence */ dispute_evidence: { /** @description 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?: string | null; + access_activity_log?: string | null /** @description The billing address provided by the customer. */ - billing_address?: string | null; + billing_address?: string | null /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your subscription cancellation policy, as shown to the customer. */ - cancellation_policy?: (Partial & Partial) | null; + cancellation_policy?: (Partial & Partial) | null /** @description An explanation of how and when the customer was shown your refund policy prior to purchase. */ - cancellation_policy_disclosure?: string | null; + cancellation_policy_disclosure?: string | null /** @description A justification for why the customer's subscription was not canceled. */ - cancellation_rebuttal?: string | null; + cancellation_rebuttal?: string | null /** @description (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?: (Partial & Partial) | null; + customer_communication?: (Partial & Partial) | null /** @description The email address of the customer. */ - customer_email_address?: string | null; + customer_email_address?: string | null /** @description The name of the customer. */ - customer_name?: string | null; + customer_name?: string | null /** @description The IP address that the customer used when making the purchase. */ - customer_purchase_ip?: string | null; + customer_purchase_ip?: string | null /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A relevant document or contract showing the customer's signature. */ - customer_signature?: (Partial & Partial) | null; + customer_signature?: (Partial & Partial) | null /** @description (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?: (Partial & Partial) | null; + duplicate_charge_documentation?: (Partial & Partial) | null /** @description An explanation of the difference between the disputed charge versus the prior charge that appears to be a duplicate. */ - duplicate_charge_explanation?: string | null; + duplicate_charge_explanation?: string | null /** @description The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge. */ - duplicate_charge_id?: string | null; + duplicate_charge_id?: string | null /** @description A description of the product or service that was sold. */ - product_description?: string | null; + product_description?: string | null /** @description (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?: (Partial & Partial) | null; + receipt?: (Partial & Partial) | null /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your refund policy, as shown to the customer. */ - refund_policy?: (Partial & Partial) | null; + refund_policy?: (Partial & Partial) | null /** @description Documentation demonstrating that the customer was shown your refund policy prior to purchase. */ - refund_policy_disclosure?: string | null; + refund_policy_disclosure?: string | null /** @description A justification for why the customer is not entitled to a refund. */ - refund_refusal_explanation?: string | null; + refund_refusal_explanation?: string | null /** @description The date on which the customer received or began receiving the purchased service, in a clear human-readable format. */ - service_date?: string | null; + service_date?: string | null /** @description (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?: (Partial & Partial) | null; + service_documentation?: (Partial & Partial) | null /** @description The address to which a physical product was shipped. You should try to include as complete address information as possible. */ - shipping_address?: string | null; + shipping_address?: string | null /** @description 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?: string | null; + shipping_carrier?: string | null /** @description The date on which a physical product began its route to the shipping address, in a clear human-readable format. */ - shipping_date?: string | null; + shipping_date?: string | null /** @description (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?: (Partial & Partial) | null; + shipping_documentation?: (Partial & Partial) | null /** @description 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?: string | null; + shipping_tracking_number?: string | null /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any additional evidence or statements. */ - uncategorized_file?: (Partial & Partial) | null; + uncategorized_file?: (Partial & Partial) | null /** @description Any additional evidence or statements. */ - uncategorized_text?: string | null; - }; + uncategorized_text?: string | null + } /** DisputeEvidenceDetails */ dispute_evidence_details: { /** * Format: unix-time * @description Date by which evidence must be submitted in order to successfully challenge dispute. Will be null if the customer's bank or credit card company doesn't allow a response for this particular dispute. */ - due_by?: number | null; + due_by?: number | null /** @description Whether evidence has been staged for this dispute. */ - has_evidence: boolean; + has_evidence: boolean /** @description 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: boolean; + past_due: boolean /** @description The number of times evidence has been submitted. Typically, you may only submit evidence once. */ - submission_count: number; - }; + submission_count: number + } /** EphemeralKey */ ephemeral_key: { /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** * Format: unix-time * @description Time at which the key will expire. Measured in seconds since the Unix epoch. */ - expires: number; + expires: number /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "ephemeral_key"; + object: 'ephemeral_key' /** @description The key's secret. You can use this value to make authorized requests to the Stripe API. */ - secret?: string; - }; + secret?: string + } /** @description An error response from the Stripe API */ error: { - error: components["schemas"]["api_errors"]; - }; + error: components['schemas']['api_errors'] + } /** * NotificationEvent * @description Events are our way of letting you know when something interesting happens in @@ -4495,31 +4456,31 @@ export interface components { */ event: { /** @description The connected account that originated the event. */ - account?: string; + account?: string /** @description The Stripe API version used to render `data`. *Note: This property is populated only for events on or after October 31, 2014*. */ - api_version?: string | null; + api_version?: string | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; - data: components["schemas"]["notification_event_data"]; + created: number + data: components['schemas']['notification_event_data'] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "event"; + object: 'event' /** @description Number of webhooks that have yet to be successfully delivered (i.e., to return a 20x response) to the URLs you've specified. */ - pending_webhooks: number; + pending_webhooks: number /** @description Information on the API request that instigated the event. */ - request?: Partial | null; + request?: Partial | null /** @description Description of the event (e.g., `invoice.created` or `charge.refunded`). */ - type: string; - }; + type: string + } /** * ExchangeRate * @description `Exchange Rate` objects allow you to determine the rates that Stripe is @@ -4536,30 +4497,30 @@ export interface components { */ exchange_rate: { /** @description 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: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "exchange_rate"; + object: 'exchange_rate' /** @description 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: { [key: string]: number }; - }; + rates: { [key: string]: number } + } /** Polymorphic */ - external_account: Partial & Partial; + external_account: Partial & Partial /** Fee */ fee: { /** @description Amount of the fee, in cents. */ - amount: number; + amount: number /** @description ID of the Connect application that earned the fee. */ - application?: string | null; + application?: string | null /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description Type of the fee, one of: `application_fee`, `stripe_fee` or `tax`. */ - type: string; - }; + type: string + } /** * FeeRefund * @description `Application Fee Refund` objects allow you to refund an application fee that @@ -4570,28 +4531,28 @@ export interface components { */ fee_refund: { /** @description Amount, in %s. */ - amount: number; + amount: number /** @description Balance transaction that describes the impact on your account balance. */ - balance_transaction?: (Partial & Partial) | null; + balance_transaction?: (Partial & Partial) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description ID of the application fee that was refunded. */ - fee: Partial & Partial; + fee: Partial & Partial /** @description Unique identifier for the object. */ - id: string; + id: string /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "fee_refund"; - }; + object: 'fee_refund' + } /** * File * @description This is an object representing a file hosted on Stripe's servers. The @@ -4607,66 +4568,66 @@ export interface components { * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** * Format: unix-time * @description The time at which the file expires and is no longer available in epoch seconds. */ - expires_at?: number | null; + expires_at?: number | null /** @description A filename for the file, suitable for saving to a filesystem. */ - filename?: string | null; + filename?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** * FileFileLinkList * @description A list of [file links](https://stripe.com/docs/api#file_links) that point at this file. */ links?: { /** @description Details about each object. */ - data: components["schemas"]["file_link"][]; + data: components['schemas']['file_link'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } | null; + url: string + } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "file"; + object: 'file' /** * @description The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file. * @enum {string} */ purpose: - | "account_requirement" - | "additional_verification" - | "business_icon" - | "business_logo" - | "customer_signature" - | "dispute_evidence" - | "document_provider_identity_document" - | "finance_report_run" - | "identity_document" - | "identity_document_downloadable" - | "pci_document" - | "selfie" - | "sigma_scheduled_query" - | "tax_document_user_upload"; + | 'account_requirement' + | 'additional_verification' + | 'business_icon' + | 'business_logo' + | 'customer_signature' + | 'dispute_evidence' + | 'document_provider_identity_document' + | 'finance_report_run' + | 'identity_document' + | 'identity_document_downloadable' + | 'pci_document' + | 'selfie' + | 'sigma_scheduled_query' + | 'tax_document_user_upload' /** @description The size in bytes of the file object. */ - size: number; + size: number /** @description A user friendly title for the document. */ - title?: string | null; + title?: string | null /** @description The type of the file returned (e.g., `csv`, `pdf`, `jpg`, or `png`). */ - type?: string | null; + type?: string | null /** @description The URL from which the file can be downloaded using your live secret API key. */ - url?: string | null; - }; + url?: string | null + } /** * FileLink * @description To share the contents of a `File` object with non-Stripe users, you can @@ -4678,252 +4639,250 @@ export interface components { * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Whether this link is already expired. */ - expired: boolean; + expired: boolean /** * Format: unix-time * @description Time at which the link expires. */ - expires_at?: number | null; + expires_at?: number | null /** @description The file object this link points to. */ - file: Partial & Partial; + file: Partial & Partial /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "file_link"; + object: 'file_link' /** @description The publicly accessible URL to download the file. */ - url?: string | null; - }; + url?: string | null + } /** FinancialReportingFinanceReportRunRunParameters */ financial_reporting_finance_report_run_run_parameters: { /** @description The set of output columns requested for inclusion in the report run. */ - columns?: string[]; + columns?: string[] /** @description Connected account ID by which to filter the report run. */ - connected_account?: string; + connected_account?: string /** @description Currency of objects to be included in the report run. */ - currency?: string; + currency?: string /** * Format: unix-time * @description Ending timestamp of data to be included in the report run (exclusive). */ - interval_end?: number; + interval_end?: number /** * Format: unix-time * @description Starting timestamp of data to be included in the report run. */ - interval_start?: number; + interval_start?: number /** @description Payout ID by which to filter the report run. */ - payout?: string; + payout?: string /** @description Category of balance transactions to be included in the report run. */ - reporting_category?: string; + reporting_category?: string /** @description 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?: string; - }; + timezone?: string + } /** * GelatoDataDocumentReportDateOfBirth * @description Point in Time */ gelato_data_document_report_date_of_birth: { /** @description Numerical day between 1 and 31. */ - day?: number | null; + day?: number | null /** @description Numerical month between 1 and 12. */ - month?: number | null; + month?: number | null /** @description The four-digit year. */ - year?: number | null; - }; + year?: number | null + } /** * GelatoDataDocumentReportExpirationDate * @description Point in Time */ gelato_data_document_report_expiration_date: { /** @description Numerical day between 1 and 31. */ - day?: number | null; + day?: number | null /** @description Numerical month between 1 and 12. */ - month?: number | null; + month?: number | null /** @description The four-digit year. */ - year?: number | null; - }; + year?: number | null + } /** * GelatoDataDocumentReportIssuedDate * @description Point in Time */ gelato_data_document_report_issued_date: { /** @description Numerical day between 1 and 31. */ - day?: number | null; + day?: number | null /** @description Numerical month between 1 and 12. */ - month?: number | null; + month?: number | null /** @description The four-digit year. */ - year?: number | null; - }; + year?: number | null + } /** * GelatoDataIdNumberReportDate * @description Point in Time */ gelato_data_id_number_report_date: { /** @description Numerical day between 1 and 31. */ - day?: number | null; + day?: number | null /** @description Numerical month between 1 and 12. */ - month?: number | null; + month?: number | null /** @description The four-digit year. */ - year?: number | null; - }; + year?: number | null + } /** * GelatoDataVerifiedOutputsDate * @description Point in Time */ gelato_data_verified_outputs_date: { /** @description Numerical day between 1 and 31. */ - day?: number | null; + day?: number | null /** @description Numerical month between 1 and 12. */ - month?: number | null; + month?: number | null /** @description The four-digit year. */ - year?: number | null; - }; + year?: number | null + } /** * GelatoDocumentReport * @description Result from a document check */ gelato_document_report: { /** @description Address as it appears in the document. */ - address?: Partial | null; + address?: Partial | null /** @description Date of birth as it appears in the document. */ - dob?: Partial | null; + dob?: Partial | null /** @description Details on the verification error. Present when status is `unverified`. */ - error?: Partial | null; + error?: Partial | null /** @description Expiration date of the document. */ - expiration_date?: Partial | null; + expiration_date?: Partial | null /** @description Array of [File](https://stripe.com/docs/api/files) ids containing images for this document. */ - files?: string[] | null; + files?: string[] | null /** @description First name as it appears in the document. */ - first_name?: string | null; + first_name?: string | null /** @description Issued date of the document. */ - issued_date?: Partial | null; + issued_date?: Partial | null /** @description Issuing country of the document. */ - issuing_country?: string | null; + issuing_country?: string | null /** @description Last name as it appears in the document. */ - last_name?: string | null; + last_name?: string | null /** @description Document ID number. */ - number?: string | null; + number?: string | null /** * @description Status of this `document` check. * @enum {string} */ - status: "unverified" | "verified"; + status: 'unverified' | 'verified' /** * @description Type of the document. * @enum {string|null} */ - type?: ("driving_license" | "id_card" | "passport") | null; - }; + type?: ('driving_license' | 'id_card' | 'passport') | null + } /** GelatoDocumentReportError */ gelato_document_report_error: { /** * @description A short machine-readable string giving the reason for the verification failure. * @enum {string|null} */ - code?: ("document_expired" | "document_type_not_supported" | "document_unverified_other") | null; + code?: ('document_expired' | 'document_type_not_supported' | 'document_unverified_other') | null /** @description A human-readable message giving the reason for the failure. These messages can be shown to your users. */ - reason?: string | null; - }; + reason?: string | null + } /** * GelatoIdNumberReport * @description Result from an id_number check */ gelato_id_number_report: { /** @description Date of birth. */ - dob?: Partial | null; + dob?: Partial | null /** @description Details on the verification error. Present when status is `unverified`. */ - error?: Partial | null; + error?: Partial | null /** @description First name. */ - first_name?: string | null; + first_name?: string | null /** @description ID number. */ - id_number?: string | null; + id_number?: string | null /** * @description Type of ID number. * @enum {string|null} */ - id_number_type?: ("br_cpf" | "sg_nric" | "us_ssn") | null; + id_number_type?: ('br_cpf' | 'sg_nric' | 'us_ssn') | null /** @description Last name. */ - last_name?: string | null; + last_name?: string | null /** * @description Status of this `id_number` check. * @enum {string} */ - status: "unverified" | "verified"; - }; + status: 'unverified' | 'verified' + } /** GelatoIdNumberReportError */ gelato_id_number_report_error: { /** * @description A short machine-readable string giving the reason for the verification failure. * @enum {string|null} */ - code?: ("id_number_insufficient_document_data" | "id_number_mismatch" | "id_number_unverified_other") | null; + code?: ('id_number_insufficient_document_data' | 'id_number_mismatch' | 'id_number_unverified_other') | null /** @description A human-readable message giving the reason for the failure. These messages can be shown to your users. */ - reason?: string | null; - }; + reason?: string | null + } /** GelatoReportDocumentOptions */ gelato_report_document_options: { /** @description 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?: ("driving_license" | "id_card" | "passport")[]; + allowed_types?: ('driving_license' | 'id_card' | 'passport')[] /** @description 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?: boolean; + require_id_number?: boolean /** @description Disable image uploads, identity document images have to be captured using the device’s camera. */ - require_live_capture?: boolean; + require_live_capture?: boolean /** @description 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?: boolean; - }; + require_matching_selfie?: boolean + } /** GelatoReportIdNumberOptions */ - gelato_report_id_number_options: { [key: string]: unknown }; + gelato_report_id_number_options: { [key: string]: unknown } /** * GelatoSelfieReport * @description Result from a selfie check */ gelato_selfie_report: { /** @description ID of the [File](https://stripe.com/docs/api/files) holding the image of the identity document used in this check. */ - document?: string | null; + document?: string | null /** @description Details on the verification error. Present when status is `unverified`. */ - error?: Partial | null; + error?: Partial | null /** @description ID of the [File](https://stripe.com/docs/api/files) holding the image of the selfie used in this check. */ - selfie?: string | null; + selfie?: string | null /** * @description Status of this `selfie` check. * @enum {string} */ - status: "unverified" | "verified"; - }; + status: 'unverified' | 'verified' + } /** GelatoSelfieReportError */ gelato_selfie_report_error: { /** * @description A short machine-readable string giving the reason for the verification failure. * @enum {string|null} */ - code?: - | ("selfie_document_missing_photo" | "selfie_face_mismatch" | "selfie_manipulated" | "selfie_unverified_other") - | null; + code?: ('selfie_document_missing_photo' | 'selfie_face_mismatch' | 'selfie_manipulated' | 'selfie_unverified_other') | null /** @description A human-readable message giving the reason for the failure. These messages can be shown to your users. */ - reason?: string | null; - }; + reason?: string | null + } /** GelatoSessionDocumentOptions */ gelato_session_document_options: { /** @description 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?: ("driving_license" | "id_card" | "passport")[]; + allowed_types?: ('driving_license' | 'id_card' | 'passport')[] /** @description 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?: boolean; + require_id_number?: boolean /** @description Disable image uploads, identity document images have to be captured using the device’s camera. */ - require_live_capture?: boolean; + require_live_capture?: boolean /** @description 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?: boolean; - }; + require_matching_selfie?: boolean + } /** GelatoSessionIdNumberOptions */ - gelato_session_id_number_options: { [key: string]: unknown }; + gelato_session_id_number_options: { [key: string]: unknown } /** * GelatoSessionLastError * @description Shows last VerificationSession error @@ -4935,54 +4894,54 @@ export interface components { */ code?: | ( - | "abandoned" - | "consent_declined" - | "country_not_supported" - | "device_not_supported" - | "document_expired" - | "document_type_not_supported" - | "document_unverified_other" - | "id_number_insufficient_document_data" - | "id_number_mismatch" - | "id_number_unverified_other" - | "selfie_document_missing_photo" - | "selfie_face_mismatch" - | "selfie_manipulated" - | "selfie_unverified_other" - | "under_supported_age" + | 'abandoned' + | 'consent_declined' + | 'country_not_supported' + | 'device_not_supported' + | 'document_expired' + | 'document_type_not_supported' + | 'document_unverified_other' + | 'id_number_insufficient_document_data' + | 'id_number_mismatch' + | 'id_number_unverified_other' + | 'selfie_document_missing_photo' + | 'selfie_face_mismatch' + | 'selfie_manipulated' + | 'selfie_unverified_other' + | 'under_supported_age' ) - | null; + | null /** @description A message that explains the reason for verification or user-session failure. */ - reason?: string | null; - }; + reason?: string | null + } /** GelatoVerificationReportOptions */ gelato_verification_report_options: { - document?: components["schemas"]["gelato_report_document_options"]; - id_number?: components["schemas"]["gelato_report_id_number_options"]; - }; + document?: components['schemas']['gelato_report_document_options'] + id_number?: components['schemas']['gelato_report_id_number_options'] + } /** GelatoVerificationSessionOptions */ gelato_verification_session_options: { - document?: components["schemas"]["gelato_session_document_options"]; - id_number?: components["schemas"]["gelato_session_id_number_options"]; - }; + document?: components['schemas']['gelato_session_document_options'] + id_number?: components['schemas']['gelato_session_id_number_options'] + } /** GelatoVerifiedOutputs */ gelato_verified_outputs: { /** @description The user's verified address. */ - address?: Partial | null; + address?: Partial | null /** @description The user’s verified date of birth. */ - dob?: Partial | null; + dob?: Partial | null /** @description The user's verified first name. */ - first_name?: string | null; + first_name?: string | null /** @description The user's verified id number. */ - id_number?: string | null; + id_number?: string | null /** * @description The user's verified id number type. * @enum {string|null} */ - id_number_type?: ("br_cpf" | "sg_nric" | "us_ssn") | null; + id_number_type?: ('br_cpf' | 'sg_nric' | 'us_ssn') | null /** @description The user's verified last name. */ - last_name?: string | null; - }; + last_name?: string | null + } /** * GelatoVerificationReport * @description A VerificationReport is the result of an attempt to collect and verify data from a user. @@ -4997,33 +4956,33 @@ export interface components { * * Related guides: [Accessing verification results](https://stripe.com/docs/identity/verification-sessions#results). */ - "identity.verification_report": { + 'identity.verification_report': { /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; - document?: components["schemas"]["gelato_document_report"]; + created: number + document?: components['schemas']['gelato_document_report'] /** @description Unique identifier for the object. */ - id: string; - id_number?: components["schemas"]["gelato_id_number_report"]; + id: string + id_number?: components['schemas']['gelato_id_number_report'] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "identity.verification_report"; - options: components["schemas"]["gelato_verification_report_options"]; - selfie?: components["schemas"]["gelato_selfie_report"]; + object: 'identity.verification_report' + options: components['schemas']['gelato_verification_report_options'] + selfie?: components['schemas']['gelato_selfie_report'] /** * @description Type of report. * @enum {string} */ - type: "document" | "id_number"; + type: 'document' | 'id_number' /** @description ID of the VerificationSession that created this report. */ - verification_session?: string | null; - }; + verification_session?: string | null + } /** * GelatoVerificationSession * @description A VerificationSession guides you through the process of collecting and verifying the identities @@ -5038,49 +4997,47 @@ export interface components { * * Related guide: [The Verification Sessions API](https://stripe.com/docs/identity/verification-sessions) */ - "identity.verification_session": { + 'identity.verification_session': { /** @description 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?: string | null; + client_secret?: string | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Unique identifier for the object. */ - id: string; + id: string /** @description If present, this property tells you the last error encountered when processing the verification. */ - last_error?: Partial | null; + last_error?: Partial | null /** @description ID of the most recent VerificationReport. [Learn more about accessing detailed verification results.](https://stripe.com/docs/identity/verification-sessions#results) */ - last_verification_report?: - | (Partial & Partial) - | null; + last_verification_report?: (Partial & Partial) | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "identity.verification_session"; - options: components["schemas"]["gelato_verification_session_options"]; + object: 'identity.verification_session' + options: components['schemas']['gelato_verification_session_options'] /** @description Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null. */ - redaction?: Partial | null; + redaction?: Partial | null /** * @description Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work). * @enum {string} */ - status: "canceled" | "processing" | "requires_input" | "verified"; + status: 'canceled' | 'processing' | 'requires_input' | 'verified' /** * @description The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. * @enum {string} */ - type: "document" | "id_number"; + type: 'document' | 'id_number' /** @description 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?: string | null; + url?: string | null /** @description The user’s verified data. */ - verified_outputs?: Partial | null; - }; + verified_outputs?: Partial | null + } /** * Invoice * @description Invoices are statements of amounts owed by a customer, and are either @@ -5118,333 +5075,321 @@ export interface components { */ invoice: { /** @description The country of the business associated with this invoice, most often the business creating the invoice. */ - account_country?: string | null; + account_country?: string | null /** @description The public name of the business associated with this invoice, most often the business creating the invoice. */ - account_name?: string | null; + account_name?: string | null /** @description The account tax IDs associated with the invoice. Only editable when the invoice is a draft. */ - account_tax_ids?: - | (Partial & - Partial & - Partial)[] - | null; + account_tax_ids?: (Partial & Partial & Partial)[] | null /** @description 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: number; + amount_due: number /** @description The amount, in %s, that was paid. */ - amount_paid: number; + amount_paid: number /** @description The amount remaining, in %s, that is due. */ - amount_remaining: number; + amount_remaining: number /** @description The fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account when the invoice is paid. */ - application_fee_amount?: number | null; + application_fee_amount?: number | null /** @description 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. */ - attempt_count: number; + attempt_count: number /** @description 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: boolean; + attempted: boolean /** @description Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice. When `false`, the invoice's state will not automatically advance without an explicit action. */ - auto_advance?: boolean; - automatic_tax: components["schemas"]["automatic_tax"]; + auto_advance?: boolean + automatic_tax: components['schemas']['automatic_tax'] /** * @description Indicates the reason why the invoice was created. `subscription_cycle` indicates an invoice created by a subscription advancing into a new period. `subscription_create` indicates an invoice created due to creating a subscription. `subscription_update` indicates an invoice created due to updating a subscription. `subscription` is set for all old invoices to indicate either a change to a subscription or a period advancement. `manual` is set for all invoices unrelated to a subscription (for example: created via the invoice editor). The `upcoming` value is reserved for simulated invoices per the upcoming invoice endpoint. `subscription_threshold` indicates an invoice created due to a billing threshold being reached. * @enum {string|null} */ billing_reason?: | ( - | "automatic_pending_invoice_item_invoice" - | "manual" - | "quote_accept" - | "subscription" - | "subscription_create" - | "subscription_cycle" - | "subscription_threshold" - | "subscription_update" - | "upcoming" + | 'automatic_pending_invoice_item_invoice' + | 'manual' + | 'quote_accept' + | 'subscription' + | 'subscription_create' + | 'subscription_cycle' + | 'subscription_threshold' + | 'subscription_update' + | 'upcoming' ) - | null; + | null /** @description ID of the latest charge generated for this invoice, if any. */ - charge?: (Partial & Partial) | null; + charge?: (Partial & Partial) | null /** * @description 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. * @enum {string} */ - collection_method: "charge_automatically" | "send_invoice"; + collection_method: 'charge_automatically' | 'send_invoice' /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Custom fields displayed on the invoice. */ - custom_fields?: components["schemas"]["invoice_setting_custom_field"][] | null; + custom_fields?: components['schemas']['invoice_setting_custom_field'][] | null /** @description The ID of the customer who will be billed. */ - customer?: - | (Partial & - Partial & - Partial) - | null; + customer?: (Partial & Partial & Partial) | null /** @description 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?: Partial | null; + customer_address?: Partial | null /** @description 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?: string | null; + customer_email?: string | null /** @description 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?: string | null; + customer_name?: string | null /** @description 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?: string | null; + customer_phone?: string | null /** @description 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?: Partial | null; + customer_shipping?: Partial | null /** * @description 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. * @enum {string|null} */ - customer_tax_exempt?: ("exempt" | "none" | "reverse") | null; + customer_tax_exempt?: ('exempt' | 'none' | 'reverse') | null /** @description 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?: components["schemas"]["invoices_resource_invoice_tax_id"][] | null; + customer_tax_ids?: components['schemas']['invoices_resource_invoice_tax_id'][] | null /** @description 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?: (Partial & Partial) | null; + default_payment_method?: (Partial & Partial) | null /** @description 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?: | (Partial & - Partial & - Partial & - Partial & - Partial & - Partial) - | null; + Partial & + Partial & + Partial & + Partial & + Partial) + | null /** @description The tax rates applied to this invoice, if any. */ - default_tax_rates: components["schemas"]["tax_rate"][]; + default_tax_rates: components['schemas']['tax_rate'][] /** @description An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. */ - description?: string | null; + description?: string | null /** @description Describes the current discount applied to this invoice, if there is one. Not populated if there are multiple discounts. */ - discount?: Partial | null; + discount?: Partial | null /** @description The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount. */ - discounts?: - | (Partial & - Partial & - Partial)[] - | null; + discounts?: (Partial & Partial & Partial)[] | null /** * Format: unix-time * @description The date on which payment for this invoice is due. This value will be `null` for invoices where `collection_method=charge_automatically`. */ - due_date?: number | null; + due_date?: number | null /** @description 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?: number | null; + ending_balance?: number | null /** @description Footer displayed on the invoice. */ - footer?: string | null; + footer?: string | null /** @description 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?: string | null; + hosted_invoice_url?: string | null /** @description Unique identifier for the object. */ - id?: string; + id?: string /** @description The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null. */ - invoice_pdf?: string | null; + invoice_pdf?: string | null /** @description The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized. */ - last_finalization_error?: Partial | null; + last_finalization_error?: Partial | null /** * InvoiceLinesList * @description The individual line items that make up the invoice. `lines` is sorted as follows: invoice items in reverse chronological order, followed by the subscription, if any. */ lines: { /** @description Details about each object. */ - data: components["schemas"]["line_item"][]; + data: components['schemas']['line_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * Format: unix-time * @description The time at which payment will next be attempted. This value will be `null` for invoices where `collection_method=send_invoice`. */ - next_payment_attempt?: number | null; + next_payment_attempt?: number | null /** @description 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?: string | null; + number?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "invoice"; + object: 'invoice' /** @description 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?: (Partial & Partial) | null; + on_behalf_of?: (Partial & Partial) | null /** @description 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: boolean; + paid: boolean /** @description 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: boolean; + paid_out_of_band: boolean /** @description 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?: (Partial & Partial) | null; - payment_settings: components["schemas"]["invoices_payment_settings"]; + payment_intent?: (Partial & Partial) | null + payment_settings: components['schemas']['invoices_payment_settings'] /** * Format: unix-time * @description End of the usage period during which invoice items were added to this invoice. */ - period_end: number; + period_end: number /** * Format: unix-time * @description Start of the usage period during which invoice items were added to this invoice. */ - period_start: number; + period_start: number /** @description Total amount of all post-payment credit notes issued for this invoice. */ - post_payment_credit_notes_amount: number; + post_payment_credit_notes_amount: number /** @description Total amount of all pre-payment credit notes issued for this invoice. */ - pre_payment_credit_notes_amount: number; + pre_payment_credit_notes_amount: number /** @description The quote this invoice was generated from. */ - quote?: (Partial & Partial) | null; + quote?: (Partial & Partial) | null /** @description This is the transaction number that appears on email receipts sent for this invoice. */ - receipt_number?: string | null; + receipt_number?: string | null /** @description Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. */ - starting_balance: number; + starting_balance: number /** @description Extra information about an invoice for the customer's credit card statement. */ - statement_descriptor?: string | null; + statement_descriptor?: string | null /** * @description The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview) * @enum {string|null} */ - status?: ("deleted" | "draft" | "open" | "paid" | "uncollectible" | "void") | null; - status_transitions: components["schemas"]["invoices_status_transitions"]; + status?: ('deleted' | 'draft' | 'open' | 'paid' | 'uncollectible' | 'void') | null + status_transitions: components['schemas']['invoices_status_transitions'] /** @description The subscription that this invoice was prepared for, if any. */ - subscription?: (Partial & Partial) | null; + subscription?: (Partial & Partial) | null /** @description Only set for upcoming invoices that preview prorations. The time used to calculate prorations. */ - subscription_proration_date?: number; + subscription_proration_date?: number /** @description Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated */ - subtotal: number; + subtotal: number /** @description The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice. */ - tax?: number | null; - threshold_reason?: components["schemas"]["invoice_threshold_reason"]; + tax?: number | null + threshold_reason?: components['schemas']['invoice_threshold_reason'] /** @description Total after discounts and taxes. */ - total: number; + total: number /** @description The aggregate amounts calculated per discount across all line items. */ - total_discount_amounts?: components["schemas"]["discounts_resource_discount_amount"][] | null; + total_discount_amounts?: components['schemas']['discounts_resource_discount_amount'][] | null /** @description The aggregate amounts calculated per tax rate for all line items. */ - total_tax_amounts: components["schemas"]["invoice_tax_amount"][]; + total_tax_amounts: components['schemas']['invoice_tax_amount'][] /** @description 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?: Partial | null; + transfer_data?: Partial | null /** * Format: unix-time * @description 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?: number | null; - }; + webhooks_delivered_at?: number | null + } /** InvoiceItemThresholdReason */ invoice_item_threshold_reason: { /** @description The IDs of the line items that triggered the threshold invoice. */ - line_item_ids: string[]; + line_item_ids: string[] /** @description The quantity threshold boundary that applied to the given line item. */ - usage_gte: number; - }; + usage_gte: number + } /** InvoiceLineItemPeriod */ invoice_line_item_period: { /** * Format: unix-time * @description End of the line item's billing period */ - end: number; + end: number /** * Format: unix-time * @description Start of the line item's billing period */ - start: number; - }; + start: number + } /** invoice_mandate_options_card */ invoice_mandate_options_card: { /** @description Amount to be charged for future payments. */ - amount?: number | null; + amount?: number | null /** * @description 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. * @enum {string|null} */ - amount_type?: ("fixed" | "maximum") | null; + amount_type?: ('fixed' | 'maximum') | null /** @description A description of the mandate or subscription that is meant to be displayed to the customer. */ - description?: string | null; - }; + description?: string | null + } /** invoice_payment_method_options_acss_debit */ invoice_payment_method_options_acss_debit: { - mandate_options?: components["schemas"]["invoice_payment_method_options_acss_debit_mandate_options"]; + mandate_options?: components['schemas']['invoice_payment_method_options_acss_debit_mandate_options'] /** * @description Bank account verification method. * @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; - }; + verification_method?: 'automatic' | 'instant' | 'microdeposits' + } /** invoice_payment_method_options_acss_debit_mandate_options */ invoice_payment_method_options_acss_debit_mandate_options: { /** * @description Transaction type of the mandate. * @enum {string|null} */ - transaction_type?: ("business" | "personal") | null; - }; + transaction_type?: ('business' | 'personal') | null + } /** invoice_payment_method_options_bancontact */ invoice_payment_method_options_bancontact: { /** * @description Preferred language of the Bancontact authorization page that the customer is redirected to. * @enum {string} */ - preferred_language: "de" | "en" | "fr" | "nl"; - }; + preferred_language: 'de' | 'en' | 'fr' | 'nl' + } /** invoice_payment_method_options_card */ invoice_payment_method_options_card: { /** * @description 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#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. * @enum {string|null} */ - request_three_d_secure?: ("any" | "automatic") | null; - }; + request_three_d_secure?: ('any' | 'automatic') | null + } /** InvoiceSettingCustomField */ invoice_setting_custom_field: { /** @description The name of the custom field. */ - name: string; + name: string /** @description The value of the custom field. */ - value: string; - }; + value: string + } /** InvoiceSettingCustomerSetting */ invoice_setting_customer_setting: { /** @description Default custom fields to be displayed on invoices for this customer. */ - custom_fields?: components["schemas"]["invoice_setting_custom_field"][] | null; + custom_fields?: components['schemas']['invoice_setting_custom_field'][] | null /** @description 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?: (Partial & Partial) | null; + default_payment_method?: (Partial & Partial) | null /** @description Default footer to be displayed on invoices for this customer. */ - footer?: string | null; - }; + footer?: string | null + } /** InvoiceSettingQuoteSetting */ invoice_setting_quote_setting: { /** @description 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?: number | null; - }; + days_until_due?: number | null + } /** InvoiceSettingSubscriptionScheduleSetting */ invoice_setting_subscription_schedule_setting: { /** @description 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?: number | null; - }; + days_until_due?: number | null + } /** InvoiceTaxAmount */ invoice_tax_amount: { /** @description The amount, in %s, of the tax. */ - amount: number; + amount: number /** @description Whether this tax amount is inclusive or exclusive. */ - inclusive: boolean; + inclusive: boolean /** @description The tax rate that was applied to get this tax amount. */ - tax_rate: Partial & Partial; - }; + tax_rate: Partial & Partial + } /** InvoiceThresholdReason */ invoice_threshold_reason: { /** @description The total invoice amount threshold boundary if it triggered the threshold invoice. */ - amount_gte?: number | null; + amount_gte?: number | null /** @description Indicates which line items triggered a threshold invoice. */ - item_reasons: components["schemas"]["invoice_item_threshold_reason"][]; - }; + item_reasons: components['schemas']['invoice_item_threshold_reason'][] + } /** InvoiceTransferData */ invoice_transfer_data: { /** @description The amount in %s that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination. */ - amount?: number | null; + amount?: number | null /** @description The account where funds from the payment will be transferred to upon payment success. */ - destination: Partial & Partial; - }; + destination: Partial & Partial + } /** * InvoiceItem * @description Sometimes you want to add a charge or credit to a customer, but actually @@ -5457,92 +5402,90 @@ export interface components { */ invoiceitem: { /** @description Amount (in the `currency` specified) of the invoice item. This should always be equal to `unit_amount * quantity`. */ - amount: number; + amount: number /** @description 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: string; + currency: string /** @description The ID of the customer who will be billed when this invoice item is billed. */ - customer: Partial & - Partial & - Partial; + customer: Partial & Partial & Partial /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - date: number; + date: number /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description If true, discounts will apply to this invoice item. Always false for prorations. */ - discountable: boolean; + discountable: boolean /** @description The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount. */ - discounts?: (Partial & Partial)[] | null; + discounts?: (Partial & Partial)[] | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The ID of the invoice this invoice item belongs to. */ - invoice?: (Partial & Partial) | null; + invoice?: (Partial & Partial) | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "invoiceitem"; - period: components["schemas"]["invoice_line_item_period"]; + object: 'invoiceitem' + period: components['schemas']['invoice_line_item_period'] /** @description The price of the invoice item. */ - price?: Partial | null; + price?: Partial | null /** @description Whether the invoice item was created automatically as a proration adjustment when the customer switched plans. */ - proration: boolean; + proration: boolean /** @description 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: number; + quantity: number /** @description The subscription that this invoice item has been created for, if any. */ - subscription?: (Partial & Partial) | null; + subscription?: (Partial & Partial) | null /** @description The subscription item that this invoice item has been created for, if any. */ - subscription_item?: string; + subscription_item?: string /** @description 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?: components["schemas"]["tax_rate"][] | null; + tax_rates?: components['schemas']['tax_rate'][] | null /** @description Unit amount (in the `currency` specified) of the invoice item. */ - unit_amount?: number | null; + unit_amount?: number | null /** * Format: decimal * @description Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. */ - unit_amount_decimal?: string | null; - }; + unit_amount_decimal?: string | null + } /** InvoicesPaymentMethodOptions */ invoices_payment_method_options: { /** @description 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?: Partial | null; + acss_debit?: Partial | null /** @description If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent. */ - bancontact?: Partial | null; + bancontact?: Partial | null /** @description If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent. */ - card?: Partial | null; - }; + card?: Partial | null + } /** InvoicesPaymentSettings */ invoices_payment_settings: { /** @description Payment-method-specific configuration to provide to the invoice’s PaymentIntent. */ - payment_method_options?: Partial | null; + payment_method_options?: Partial | null /** @description 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?: | ( - | "ach_credit_transfer" - | "ach_debit" - | "acss_debit" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "sepa_debit" - | "sofort" - | "wechat_pay" + | 'ach_credit_transfer' + | 'ach_debit' + | 'acss_debit' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' )[] - | null; - }; + | null + } /** InvoicesResourceInvoiceTaxID */ invoices_resource_invoice_tax_id: { /** @@ -5550,75 +5493,75 @@ export interface components { * @enum {string} */ type: - | "ae_trn" - | "au_abn" - | "au_arn" - | "br_cnpj" - | "br_cpf" - | "ca_bn" - | "ca_gst_hst" - | "ca_pst_bc" - | "ca_pst_mb" - | "ca_pst_sk" - | "ca_qst" - | "ch_vat" - | "cl_tin" - | "es_cif" - | "eu_vat" - | "gb_vat" - | "ge_vat" - | "hk_br" - | "id_npwp" - | "il_vat" - | "in_gst" - | "is_vat" - | "jp_cn" - | "jp_rn" - | "kr_brn" - | "li_uid" - | "mx_rfc" - | "my_frp" - | "my_itn" - | "my_sst" - | "no_vat" - | "nz_gst" - | "ru_inn" - | "ru_kpp" - | "sa_vat" - | "sg_gst" - | "sg_uen" - | "th_vat" - | "tw_vat" - | "ua_vat" - | "unknown" - | "us_ein" - | "za_vat"; + | 'ae_trn' + | 'au_abn' + | 'au_arn' + | 'br_cnpj' + | 'br_cpf' + | 'ca_bn' + | 'ca_gst_hst' + | 'ca_pst_bc' + | 'ca_pst_mb' + | 'ca_pst_sk' + | 'ca_qst' + | 'ch_vat' + | 'cl_tin' + | 'es_cif' + | 'eu_vat' + | 'gb_vat' + | 'ge_vat' + | 'hk_br' + | 'id_npwp' + | 'il_vat' + | 'in_gst' + | 'is_vat' + | 'jp_cn' + | 'jp_rn' + | 'kr_brn' + | 'li_uid' + | 'mx_rfc' + | 'my_frp' + | 'my_itn' + | 'my_sst' + | 'no_vat' + | 'nz_gst' + | 'ru_inn' + | 'ru_kpp' + | 'sa_vat' + | 'sg_gst' + | 'sg_uen' + | 'th_vat' + | 'tw_vat' + | 'ua_vat' + | 'unknown' + | 'us_ein' + | 'za_vat' /** @description The value of the tax ID. */ - value?: string | null; - }; + value?: string | null + } /** InvoicesStatusTransitions */ invoices_status_transitions: { /** * Format: unix-time * @description The time that the invoice draft was finalized. */ - finalized_at?: number | null; + finalized_at?: number | null /** * Format: unix-time * @description The time that the invoice was marked uncollectible. */ - marked_uncollectible_at?: number | null; + marked_uncollectible_at?: number | null /** * Format: unix-time * @description The time that the invoice was paid. */ - paid_at?: number | null; + paid_at?: number | null /** * Format: unix-time * @description The time that the invoice was voided. */ - voided_at?: number | null; - }; + voided_at?: number | null + } /** * IssuerFraudRecord * @description This resource has been renamed to [Early Fraud @@ -5627,30 +5570,30 @@ export interface components { */ issuer_fraud_record: { /** @description An IFR 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 IFR, in order to avoid receiving a dispute later. */ - actionable: boolean; + actionable: boolean /** @description ID of the charge this issuer fraud record is for, optionally expanded. */ - charge: Partial & Partial; + charge: Partial & Partial /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + fraud_type: string /** @description If true, the associated charge is subject to [liability shift](https://stripe.com/docs/payments/3d-secure#disputed-payments). */ - has_liability_shift: boolean; + has_liability_shift: boolean /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "issuer_fraud_record"; + object: 'issuer_fraud_record' /** @description The timestamp at which the card issuer posted the issuer fraud record. */ - post_date: number; - }; + post_date: number + } /** * IssuingAuthorization * @description When an [issued card](https://stripe.com/docs/issuing) is used to make a purchase, an Issuing `Authorization` @@ -5659,260 +5602,260 @@ export interface components { * * Related guide: [Issued Card Authorizations](https://stripe.com/docs/issuing/purchases/authorizations). */ - "issuing.authorization": { + 'issuing.authorization': { /** @description The total amount that was authorized or rejected. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ - amount: number; + amount: number /** @description 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?: Partial | null; + amount_details?: Partial | null /** @description Whether the authorization has been approved. */ - approved: boolean; + approved: boolean /** * @description How the card details were provided. * @enum {string} */ - authorization_method: "chip" | "contactless" | "keyed_in" | "online" | "swipe"; + authorization_method: 'chip' | 'contactless' | 'keyed_in' | 'online' | 'swipe' /** @description List of balance transactions associated with this authorization. */ - balance_transactions: components["schemas"]["balance_transaction"][]; - card: components["schemas"]["issuing.card"]; + balance_transactions: components['schemas']['balance_transaction'][] + card: components['schemas']['issuing.card'] /** @description The cardholder to whom this authorization belongs. */ - cardholder?: (Partial & Partial) | null; + cardholder?: (Partial & Partial) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: number; + merchant_amount: number /** @description The currency that was 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: string; - merchant_data: components["schemas"]["issuing_authorization_merchant_data"]; + merchant_currency: string + merchant_data: components['schemas']['issuing_authorization_merchant_data'] /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "issuing.authorization"; + object: 'issuing.authorization' /** @description The pending authorization request. This field will only be non-null during an `issuing_authorization.request` webhook. */ - pending_request?: Partial | null; + pending_request?: Partial | null /** @description History of every time `pending_request` was approved/denied, 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](https://stripe.com/docs/issuing/purchases/authorizations), you can look at this field to see the previous requests for the authorization. */ - request_history: components["schemas"]["issuing_authorization_request"][]; + request_history: components['schemas']['issuing_authorization_request'][] /** * @description The current status of the authorization in its lifecycle. * @enum {string} */ - status: "closed" | "pending" | "reversed"; + status: 'closed' | 'pending' | 'reversed' /** @description List of [transactions](https://stripe.com/docs/api/issuing/transactions) associated with this authorization. */ - transactions: components["schemas"]["issuing.transaction"][]; - verification_data: components["schemas"]["issuing_authorization_verification_data"]; + transactions: components['schemas']['issuing.transaction'][] + verification_data: components['schemas']['issuing_authorization_verification_data'] /** @description The digital wallet used for this authorization. One of `apple_pay`, `google_pay`, or `samsung_pay`. */ - wallet?: string | null; - }; + wallet?: string | null + } /** * IssuingCard * @description You can [create physical or virtual cards](https://stripe.com/docs/issuing/cards) that are issued to cardholders. */ - "issuing.card": { + 'issuing.card': { /** @description The brand of the card. */ - brand: string; + brand: string /** * @description The reason why the card was canceled. * @enum {string|null} */ - cancellation_reason?: ("lost" | "stolen") | null; - cardholder: components["schemas"]["issuing.cardholder"]; + cancellation_reason?: ('lost' | 'stolen') | null + cardholder: components['schemas']['issuing.cardholder'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description 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?: string; + cvc?: string /** @description The expiration month of the card. */ - exp_month: number; + exp_month: number /** @description The expiration year of the card. */ - exp_year: number; + exp_year: number /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The last 4 digits of the card number. */ - last4: string; + last4: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** @description 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?: string; + number?: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "issuing.card"; + object: 'issuing.card' /** @description The latest card that replaces this card, if any. */ - replaced_by?: (Partial & Partial) | null; + replaced_by?: (Partial & Partial) | null /** @description The card this card replaces, if any. */ - replacement_for?: (Partial & Partial) | null; + replacement_for?: (Partial & Partial) | null /** * @description The reason why the previous card needed to be replaced. * @enum {string|null} */ - replacement_reason?: ("damaged" | "expired" | "lost" | "stolen") | null; + replacement_reason?: ('damaged' | 'expired' | 'lost' | 'stolen') | null /** @description Where and how the card will be shipped. */ - shipping?: Partial | null; - spending_controls: components["schemas"]["issuing_card_authorization_controls"]; + shipping?: Partial | null + spending_controls: components['schemas']['issuing_card_authorization_controls'] /** * @description Whether authorizations can be approved on this card. * @enum {string} */ - status: "active" | "canceled" | "inactive"; + status: 'active' | 'canceled' | 'inactive' /** * @description The type of the card. * @enum {string} */ - type: "physical" | "virtual"; + type: 'physical' | 'virtual' /** @description Information relating to digital wallets (like Apple Pay and Google Pay). */ - wallets?: Partial | null; - }; + wallets?: Partial | null + } /** * IssuingCardholder * @description An Issuing `Cardholder` object represents an individual or business entity who is [issued](https://stripe.com/docs/issuing) cards. * * Related guide: [How to create a Cardholder](https://stripe.com/docs/issuing/cards#create-cardholder) */ - "issuing.cardholder": { - billing: components["schemas"]["issuing_cardholder_address"]; + 'issuing.cardholder': { + billing: components['schemas']['issuing_cardholder_address'] /** @description Additional information about a `company` cardholder. */ - company?: Partial | null; + company?: Partial | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The cardholder's email address. */ - email?: string | null; + email?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Additional information about an `individual` cardholder. */ - individual?: Partial | null; + individual?: Partial | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** @description The cardholder's name. This will be printed on cards issued to them. */ - name: string; + name: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "issuing.cardholder"; + object: 'issuing.cardholder' /** @description 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?: string | null; - requirements: components["schemas"]["issuing_cardholder_requirements"]; + phone_number?: string | null + requirements: components['schemas']['issuing_cardholder_requirements'] /** @description 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?: Partial | null; + spending_controls?: Partial | null /** * @description Specifies whether to permit authorizations on this cardholder's cards. * @enum {string} */ - status: "active" | "blocked" | "inactive"; + status: 'active' | 'blocked' | 'inactive' /** * @description One of `individual` or `company`. * @enum {string} */ - type: "company" | "individual"; - }; + type: 'company' | 'individual' + } /** * IssuingDispute * @description 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. * * Related guide: [Disputing Transactions](https://stripe.com/docs/issuing/purchases/disputes) */ - "issuing.dispute": { + 'issuing.dispute': { /** @description Disputed amount. Usually the amount of the `transaction`, but can differ (usually because of currency fluctuation). */ - amount: number; + amount: number /** @description List of balance transactions associated with the dispute. */ - balance_transactions?: components["schemas"]["balance_transaction"][] | null; + balance_transactions?: components['schemas']['balance_transaction'][] | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The currency the `transaction` was made in. */ - currency: string; - evidence: components["schemas"]["issuing_dispute_evidence"]; + currency: string + evidence: components['schemas']['issuing_dispute_evidence'] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "issuing.dispute"; + object: 'issuing.dispute' /** * @description Current status of the dispute. * @enum {string} */ - status: "expired" | "lost" | "submitted" | "unsubmitted" | "won"; + status: 'expired' | 'lost' | 'submitted' | 'unsubmitted' | 'won' /** @description The transaction being disputed. */ - transaction: Partial & Partial; - }; + transaction: Partial & Partial + } /** * IssuingSettlement * @description 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. */ - "issuing.settlement": { + 'issuing.settlement': { /** @description The Bank Identification Number reflecting this settlement record. */ - bin: string; + bin: string /** @description The date that the transactions are cleared and posted to user's accounts. */ - clearing_date: number; + clearing_date: number /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The total interchange received as reimbursement for the transactions. */ - interchange_fees: number; + interchange_fees: number /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** @description The total net amount required to settle with the network. */ - net_total: number; + net_total: number /** * @description The card network for this settlement report. One of ["visa"] * @enum {string} */ - network: "visa"; + network: 'visa' /** @description The total amount of fees owed to the network. */ - network_fees: number; + network_fees: number /** @description The Settlement Identification Number assigned by the network. */ - network_settlement_identifier: string; + network_settlement_identifier: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "issuing.settlement"; + object: 'issuing.settlement' /** @description One of `international` or `uk_national_net`. */ - settlement_service: string; + settlement_service: string /** @description The total number of transactions reflected in this settlement. */ - transaction_count: number; + transaction_count: number /** @description The total transaction amount reflected in this settlement. */ - transaction_volume: number; - }; + transaction_volume: number + } /** * IssuingTransaction * @description Any use of an [issued card](https://stripe.com/docs/issuing) that results in funds entering or leaving @@ -5921,2669 +5864,2662 @@ export interface components { * * Related guide: [Issued Card Transactions](https://stripe.com/docs/issuing/purchases/transactions). */ - "issuing.transaction": { + 'issuing.transaction': { /** @description 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: number; + amount: number /** @description 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?: Partial | null; + amount_details?: Partial | null /** @description The `Authorization` object that led to this transaction. */ - authorization?: (Partial & Partial) | null; + authorization?: (Partial & Partial) | null /** @description ID of the [balance transaction](https://stripe.com/docs/api/balance_transactions) associated with this transaction. */ - balance_transaction?: (Partial & Partial) | null; + balance_transaction?: (Partial & Partial) | null /** @description The card used to make this transaction. */ - card: Partial & Partial; + card: Partial & Partial /** @description The cardholder to whom this transaction belongs. */ - cardholder?: (Partial & Partial) | null; + cardholder?: (Partial & Partial) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description If you've disputed the transaction, the ID of the dispute. */ - dispute?: (Partial & Partial) | null; + dispute?: (Partial & Partial) | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: number; + merchant_amount: number /** @description The currency with which the merchant is taking payment. */ - merchant_currency: string; - merchant_data: components["schemas"]["issuing_authorization_merchant_data"]; + merchant_currency: string + merchant_data: components['schemas']['issuing_authorization_merchant_data'] /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "issuing.transaction"; + object: 'issuing.transaction' /** @description Additional purchase information that is optionally provided by the merchant. */ - purchase_details?: Partial | null; + purchase_details?: Partial | null /** * @description The nature of the transaction. * @enum {string} */ - type: "capture" | "refund"; + type: 'capture' | 'refund' /** * @description The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. * @enum {string|null} */ - wallet?: ("apple_pay" | "google_pay" | "samsung_pay") | null; - }; + wallet?: ('apple_pay' | 'google_pay' | 'samsung_pay') | null + } /** IssuingAuthorizationAmountDetails */ issuing_authorization_amount_details: { /** @description The fee charged by the ATM for the cash withdrawal. */ - atm_fee?: number | null; - }; + atm_fee?: number | null + } /** IssuingAuthorizationMerchantData */ issuing_authorization_merchant_data: { /** @description 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: string; + category: string /** @description The merchant category code for the seller’s business */ - category_code: string; + category_code: string /** @description City where the seller is located */ - city?: string | null; + city?: string | null /** @description Country where the seller is located */ - country?: string | null; + country?: string | null /** @description Name of the seller */ - name?: string | null; + name?: string | null /** @description Identifier assigned to the seller by the card brand */ - network_id: string; + network_id: string /** @description Postal code where the seller is located */ - postal_code?: string | null; + postal_code?: string | null /** @description State where the seller is located */ - state?: string | null; - }; + state?: string | null + } /** IssuingAuthorizationPendingRequest */ issuing_authorization_pending_request: { /** @description 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: number; + amount: number /** @description 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?: Partial | null; + amount_details?: Partial | null /** @description 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: string; + currency: string /** @description 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: boolean; + is_amount_controllable: boolean /** @description 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: number; + merchant_amount: number /** @description The local currency the merchant is requesting to authorize. */ - merchant_currency: string; - }; + merchant_currency: string + } /** IssuingAuthorizationRequest */ issuing_authorization_request: { /** @description 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: number; + amount: number /** @description 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?: Partial | null; + amount_details?: Partial | null /** @description Whether this request was approved. */ - approved: boolean; + approved: boolean /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description 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: number; + merchant_amount: number /** @description 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: string; + merchant_currency: string /** * @description The reason for the approval or decline. * @enum {string} */ reason: - | "account_disabled" - | "card_active" - | "card_inactive" - | "cardholder_inactive" - | "cardholder_verification_required" - | "insufficient_funds" - | "not_allowed" - | "spending_controls" - | "suspected_fraud" - | "verification_failed" - | "webhook_approved" - | "webhook_declined" - | "webhook_timeout"; - }; + | 'account_disabled' + | 'card_active' + | 'card_inactive' + | 'cardholder_inactive' + | 'cardholder_verification_required' + | 'insufficient_funds' + | 'not_allowed' + | 'spending_controls' + | 'suspected_fraud' + | 'verification_failed' + | 'webhook_approved' + | 'webhook_declined' + | 'webhook_timeout' + } /** IssuingAuthorizationVerificationData */ issuing_authorization_verification_data: { /** * @description Whether the cardholder provided an address first line and if it matched the cardholder’s `billing.address.line1`. * @enum {string} */ - address_line1_check: "match" | "mismatch" | "not_provided"; + address_line1_check: 'match' | 'mismatch' | 'not_provided' /** * @description Whether the cardholder provided a postal code and if it matched the cardholder’s `billing.address.postal_code`. * @enum {string} */ - address_postal_code_check: "match" | "mismatch" | "not_provided"; + address_postal_code_check: 'match' | 'mismatch' | 'not_provided' /** * @description Whether the cardholder provided a CVC and if it matched Stripe’s record. * @enum {string} */ - cvc_check: "match" | "mismatch" | "not_provided"; + cvc_check: 'match' | 'mismatch' | 'not_provided' /** * @description Whether the cardholder provided an expiry date and if it matched Stripe’s record. * @enum {string} */ - expiry_check: "match" | "mismatch" | "not_provided"; - }; + expiry_check: 'match' | 'mismatch' | 'not_provided' + } /** IssuingCardApplePay */ issuing_card_apple_pay: { /** @description Apple Pay Eligibility */ - eligible: boolean; + eligible: boolean /** * @description Reason the card is ineligible for Apple Pay * @enum {string|null} */ - ineligible_reason?: ("missing_agreement" | "missing_cardholder_contact" | "unsupported_region") | null; - }; + ineligible_reason?: ('missing_agreement' | 'missing_cardholder_contact' | 'unsupported_region') | null + } /** IssuingCardAuthorizationControls */ issuing_card_authorization_controls: { /** @description 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?: | ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' )[] - | null; + | null /** @description 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?: | ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' )[] - | null; + | null /** @description 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?: components["schemas"]["issuing_card_spending_limit"][] | null; + spending_limits?: components['schemas']['issuing_card_spending_limit'][] | null /** @description Currency of the amounts within `spending_limits`. Always the same as the currency of the card. */ - spending_limits_currency?: string | null; - }; + spending_limits_currency?: string | null + } /** IssuingCardGooglePay */ issuing_card_google_pay: { /** @description Google Pay Eligibility */ - eligible: boolean; + eligible: boolean /** * @description Reason the card is ineligible for Google Pay * @enum {string|null} */ - ineligible_reason?: ("missing_agreement" | "missing_cardholder_contact" | "unsupported_region") | null; - }; + ineligible_reason?: ('missing_agreement' | 'missing_cardholder_contact' | 'unsupported_region') | null + } /** IssuingCardShipping */ issuing_card_shipping: { - address: components["schemas"]["address"]; + address: components['schemas']['address'] /** * @description The delivery company that shipped a card. * @enum {string|null} */ - carrier?: ("dhl" | "fedex" | "royal_mail" | "usps") | null; + carrier?: ('dhl' | 'fedex' | 'royal_mail' | 'usps') | null /** * Format: unix-time * @description A unix timestamp representing a best estimate of when the card will be delivered. */ - eta?: number | null; + eta?: number | null /** @description Recipient name. */ - name: string; + name: string /** * @description Shipment service, such as `standard` or `express`. * @enum {string} */ - service: "express" | "priority" | "standard"; + service: 'express' | 'priority' | 'standard' /** * @description The delivery status of the card. * @enum {string|null} */ - status?: ("canceled" | "delivered" | "failure" | "pending" | "returned" | "shipped") | null; + status?: ('canceled' | 'delivered' | 'failure' | 'pending' | 'returned' | 'shipped') | null /** @description A tracking number for a card shipment. */ - tracking_number?: string | null; + tracking_number?: string | null /** @description A link to the shipping carrier's site where you can view detailed information about a card shipment. */ - tracking_url?: string | null; + tracking_url?: string | null /** * @description Packaging options. * @enum {string} */ - type: "bulk" | "individual"; - }; + type: 'bulk' | 'individual' + } /** IssuingCardSpendingLimit */ issuing_card_spending_limit: { /** @description Maximum amount allowed to spend per interval. */ - amount: number; + amount: number /** @description 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?: | ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' )[] - | null; + | null /** * @description Interval (or event) to which the amount applies. * @enum {string} */ - interval: "all_time" | "daily" | "monthly" | "per_authorization" | "weekly" | "yearly"; - }; + interval: 'all_time' | 'daily' | 'monthly' | 'per_authorization' | 'weekly' | 'yearly' + } /** IssuingCardWallets */ issuing_card_wallets: { - apple_pay: components["schemas"]["issuing_card_apple_pay"]; - google_pay: components["schemas"]["issuing_card_google_pay"]; + apple_pay: components['schemas']['issuing_card_apple_pay'] + google_pay: components['schemas']['issuing_card_google_pay'] /** @description Unique identifier for a card used with digital wallets */ - primary_account_identifier?: string | null; - }; + primary_account_identifier?: string | null + } /** IssuingCardholderAddress */ issuing_cardholder_address: { - address: components["schemas"]["address"]; - }; + address: components['schemas']['address'] + } /** IssuingCardholderAuthorizationControls */ issuing_cardholder_authorization_controls: { /** @description 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?: | ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' )[] - | null; + | null /** @description 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?: | ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' )[] - | null; + | null /** @description Limit spending with amount-based rules that apply across this cardholder's cards. */ - spending_limits?: components["schemas"]["issuing_cardholder_spending_limit"][] | null; + spending_limits?: components['schemas']['issuing_cardholder_spending_limit'][] | null /** @description Currency of the amounts within `spending_limits`. */ - spending_limits_currency?: string | null; - }; + spending_limits_currency?: string | null + } /** IssuingCardholderCompany */ issuing_cardholder_company: { /** @description Whether the company's business ID number was provided. */ - tax_id_provided: boolean; - }; + tax_id_provided: boolean + } /** IssuingCardholderIdDocument */ issuing_cardholder_id_document: { /** @description 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?: (Partial & Partial) | null; + back?: (Partial & Partial) | null /** @description 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?: (Partial & Partial) | null; - }; + front?: (Partial & Partial) | null + } /** IssuingCardholderIndividual */ issuing_cardholder_individual: { /** @description The date of birth of this cardholder. */ - dob?: Partial | null; + dob?: Partial | null /** @description The first name of this cardholder. */ - first_name: string; + first_name: string /** @description The last name of this cardholder. */ - last_name: string; + last_name: string /** @description Government-issued ID document for this cardholder. */ - verification?: Partial | null; - }; + verification?: Partial | null + } /** IssuingCardholderIndividualDOB */ issuing_cardholder_individual_dob: { /** @description The day of birth, between 1 and 31. */ - day?: number | null; + day?: number | null /** @description The month of birth, between 1 and 12. */ - month?: number | null; + month?: number | null /** @description The four-digit year of birth. */ - year?: number | null; - }; + year?: number | null + } /** IssuingCardholderRequirements */ issuing_cardholder_requirements: { /** * @description If `disabled_reason` is present, all cards will decline authorizations with `cardholder_verification_required` reason. * @enum {string|null} */ - disabled_reason?: ("listed" | "rejected.listed" | "under_review") | null; + disabled_reason?: ('listed' | 'rejected.listed' | 'under_review') | null /** @description Array of fields that need to be collected in order to verify and re-enable the cardholder. */ past_due?: | ( - | "company.tax_id" - | "individual.dob.day" - | "individual.dob.month" - | "individual.dob.year" - | "individual.first_name" - | "individual.last_name" - | "individual.verification.document" + | 'company.tax_id' + | 'individual.dob.day' + | 'individual.dob.month' + | 'individual.dob.year' + | 'individual.first_name' + | 'individual.last_name' + | 'individual.verification.document' )[] - | null; - }; + | null + } /** IssuingCardholderSpendingLimit */ issuing_cardholder_spending_limit: { /** @description Maximum amount allowed to spend per interval. */ - amount: number; + amount: number /** @description 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?: | ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' )[] - | null; + | null /** * @description Interval (or event) to which the amount applies. * @enum {string} */ - interval: "all_time" | "daily" | "monthly" | "per_authorization" | "weekly" | "yearly"; - }; + interval: 'all_time' | 'daily' | 'monthly' | 'per_authorization' | 'weekly' | 'yearly' + } /** IssuingCardholderVerification */ issuing_cardholder_verification: { /** @description An identifying document, either a passport or local ID card. */ - document?: Partial | null; - }; + document?: Partial | null + } /** IssuingDisputeCanceledEvidence */ issuing_dispute_canceled_evidence: { /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ - additional_documentation?: (Partial & Partial) | null; + additional_documentation?: (Partial & Partial) | null /** * Format: unix-time * @description Date when order was canceled. */ - canceled_at?: number | null; + canceled_at?: number | null /** @description Whether the cardholder was provided with a cancellation policy. */ - cancellation_policy_provided?: boolean | null; + cancellation_policy_provided?: boolean | null /** @description Reason for canceling the order. */ - cancellation_reason?: string | null; + cancellation_reason?: string | null /** * Format: unix-time * @description Date when the cardholder expected to receive the product. */ - expected_at?: number | null; + expected_at?: number | null /** @description Explanation of why the cardholder is disputing this transaction. */ - explanation?: string | null; + explanation?: string | null /** @description Description of the merchandise or service that was purchased. */ - product_description?: string | null; + product_description?: string | null /** * @description Whether the product was a merchandise or service. * @enum {string|null} */ - product_type?: ("merchandise" | "service") | null; + product_type?: ('merchandise' | 'service') | null /** * @description Result of cardholder's attempt to return the product. * @enum {string|null} */ - return_status?: ("merchant_rejected" | "successful") | null; + return_status?: ('merchant_rejected' | 'successful') | null /** * Format: unix-time * @description Date when the product was returned or attempted to be returned. */ - returned_at?: number | null; - }; + returned_at?: number | null + } /** IssuingDisputeDuplicateEvidence */ issuing_dispute_duplicate_evidence: { /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ - additional_documentation?: (Partial & Partial) | null; + additional_documentation?: (Partial & Partial) | null /** @description (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?: (Partial & Partial) | null; + card_statement?: (Partial & Partial) | null /** @description (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?: (Partial & Partial) | null; + cash_receipt?: (Partial & Partial) | null /** @description (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?: (Partial & Partial) | null; + check_image?: (Partial & Partial) | null /** @description Explanation of why the cardholder is disputing this transaction. */ - explanation?: string | null; + explanation?: string | null /** @description 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?: string | null; - }; + original_transaction?: string | null + } /** IssuingDisputeEvidence */ issuing_dispute_evidence: { - canceled?: components["schemas"]["issuing_dispute_canceled_evidence"]; - duplicate?: components["schemas"]["issuing_dispute_duplicate_evidence"]; - fraudulent?: components["schemas"]["issuing_dispute_fraudulent_evidence"]; - merchandise_not_as_described?: components["schemas"]["issuing_dispute_merchandise_not_as_described_evidence"]; - not_received?: components["schemas"]["issuing_dispute_not_received_evidence"]; - other?: components["schemas"]["issuing_dispute_other_evidence"]; + canceled?: components['schemas']['issuing_dispute_canceled_evidence'] + duplicate?: components['schemas']['issuing_dispute_duplicate_evidence'] + fraudulent?: components['schemas']['issuing_dispute_fraudulent_evidence'] + merchandise_not_as_described?: components['schemas']['issuing_dispute_merchandise_not_as_described_evidence'] + not_received?: components['schemas']['issuing_dispute_not_received_evidence'] + other?: components['schemas']['issuing_dispute_other_evidence'] /** * @description The reason for filing the dispute. Its value will match the field containing the evidence. * @enum {string} */ - reason: - | "canceled" - | "duplicate" - | "fraudulent" - | "merchandise_not_as_described" - | "not_received" - | "other" - | "service_not_as_described"; - service_not_as_described?: components["schemas"]["issuing_dispute_service_not_as_described_evidence"]; - }; + reason: 'canceled' | 'duplicate' | 'fraudulent' | 'merchandise_not_as_described' | 'not_received' | 'other' | 'service_not_as_described' + service_not_as_described?: components['schemas']['issuing_dispute_service_not_as_described_evidence'] + } /** IssuingDisputeFraudulentEvidence */ issuing_dispute_fraudulent_evidence: { /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ - additional_documentation?: (Partial & Partial) | null; + additional_documentation?: (Partial & Partial) | null /** @description Explanation of why the cardholder is disputing this transaction. */ - explanation?: string | null; - }; + explanation?: string | null + } /** IssuingDisputeMerchandiseNotAsDescribedEvidence */ issuing_dispute_merchandise_not_as_described_evidence: { /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ - additional_documentation?: (Partial & Partial) | null; + additional_documentation?: (Partial & Partial) | null /** @description Explanation of why the cardholder is disputing this transaction. */ - explanation?: string | null; + explanation?: string | null /** * Format: unix-time * @description Date when the product was received. */ - received_at?: number | null; + received_at?: number | null /** @description Description of the cardholder's attempt to return the product. */ - return_description?: string | null; + return_description?: string | null /** * @description Result of cardholder's attempt to return the product. * @enum {string|null} */ - return_status?: ("merchant_rejected" | "successful") | null; + return_status?: ('merchant_rejected' | 'successful') | null /** * Format: unix-time * @description Date when the product was returned or attempted to be returned. */ - returned_at?: number | null; - }; + returned_at?: number | null + } /** IssuingDisputeNotReceivedEvidence */ issuing_dispute_not_received_evidence: { /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ - additional_documentation?: (Partial & Partial) | null; + additional_documentation?: (Partial & Partial) | null /** * Format: unix-time * @description Date when the cardholder expected to receive the product. */ - expected_at?: number | null; + expected_at?: number | null /** @description Explanation of why the cardholder is disputing this transaction. */ - explanation?: string | null; + explanation?: string | null /** @description Description of the merchandise or service that was purchased. */ - product_description?: string | null; + product_description?: string | null /** * @description Whether the product was a merchandise or service. * @enum {string|null} */ - product_type?: ("merchandise" | "service") | null; - }; + product_type?: ('merchandise' | 'service') | null + } /** IssuingDisputeOtherEvidence */ issuing_dispute_other_evidence: { /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ - additional_documentation?: (Partial & Partial) | null; + additional_documentation?: (Partial & Partial) | null /** @description Explanation of why the cardholder is disputing this transaction. */ - explanation?: string | null; + explanation?: string | null /** @description Description of the merchandise or service that was purchased. */ - product_description?: string | null; + product_description?: string | null /** * @description Whether the product was a merchandise or service. * @enum {string|null} */ - product_type?: ("merchandise" | "service") | null; - }; + product_type?: ('merchandise' | 'service') | null + } /** IssuingDisputeServiceNotAsDescribedEvidence */ issuing_dispute_service_not_as_described_evidence: { /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ - additional_documentation?: (Partial & Partial) | null; + additional_documentation?: (Partial & Partial) | null /** * Format: unix-time * @description Date when order was canceled. */ - canceled_at?: number | null; + canceled_at?: number | null /** @description Reason for canceling the order. */ - cancellation_reason?: string | null; + cancellation_reason?: string | null /** @description Explanation of why the cardholder is disputing this transaction. */ - explanation?: string | null; + explanation?: string | null /** * Format: unix-time * @description Date when the product was received. */ - received_at?: number | null; - }; + received_at?: number | null + } /** IssuingTransactionAmountDetails */ issuing_transaction_amount_details: { /** @description The fee charged by the ATM for the cash withdrawal. */ - atm_fee?: number | null; - }; + atm_fee?: number | null + } /** IssuingTransactionFlightData */ issuing_transaction_flight_data: { /** @description The time that the flight departed. */ - departure_at?: number | null; + departure_at?: number | null /** @description The name of the passenger. */ - passenger_name?: string | null; + passenger_name?: string | null /** @description Whether the ticket is refundable. */ - refundable?: boolean | null; + refundable?: boolean | null /** @description The legs of the trip. */ - segments?: components["schemas"]["issuing_transaction_flight_data_leg"][] | null; + segments?: components['schemas']['issuing_transaction_flight_data_leg'][] | null /** @description The travel agency that issued the ticket. */ - travel_agency?: string | null; - }; + travel_agency?: string | null + } /** IssuingTransactionFlightDataLeg */ issuing_transaction_flight_data_leg: { /** @description The three-letter IATA airport code of the flight's destination. */ - arrival_airport_code?: string | null; + arrival_airport_code?: string | null /** @description The airline carrier code. */ - carrier?: string | null; + carrier?: string | null /** @description The three-letter IATA airport code that the flight departed from. */ - departure_airport_code?: string | null; + departure_airport_code?: string | null /** @description The flight number. */ - flight_number?: string | null; + flight_number?: string | null /** @description The flight's service class. */ - service_class?: string | null; + service_class?: string | null /** @description Whether a stopover is allowed on this flight. */ - stopover_allowed?: boolean | null; - }; + stopover_allowed?: boolean | null + } /** IssuingTransactionFuelData */ issuing_transaction_fuel_data: { /** @description The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`. */ - type: string; + type: string /** @description The units for `volume_decimal`. One of `us_gallon` or `liter`. */ - unit: string; + unit: string /** * Format: decimal * @description The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places. */ - unit_cost_decimal: string; + unit_cost_decimal: string /** * Format: decimal * @description The volume of the fuel that was pumped, represented as a decimal string with at most 12 decimal places. */ - volume_decimal?: string | null; - }; + volume_decimal?: string | null + } /** IssuingTransactionLodgingData */ issuing_transaction_lodging_data: { /** @description The time of checking into the lodging. */ - check_in_at?: number | null; + check_in_at?: number | null /** @description The number of nights stayed at the lodging. */ - nights?: number | null; - }; + nights?: number | null + } /** IssuingTransactionPurchaseDetails */ issuing_transaction_purchase_details: { /** @description Information about the flight that was purchased with this transaction. */ - flight?: Partial | null; + flight?: Partial | null /** @description Information about fuel that was purchased with this transaction. */ - fuel?: Partial | null; + fuel?: Partial | null /** @description Information about lodging that was purchased with this transaction. */ - lodging?: Partial | null; + lodging?: Partial | null /** @description The line items in the purchase. */ - receipt?: components["schemas"]["issuing_transaction_receipt_data"][] | null; + receipt?: components['schemas']['issuing_transaction_receipt_data'][] | null /** @description A merchant-specific order number. */ - reference?: string | null; - }; + reference?: string | null + } /** IssuingTransactionReceiptData */ issuing_transaction_receipt_data: { /** @description The description of the item. The maximum length of this field is 26 characters. */ - description?: string | null; + description?: string | null /** @description The quantity of the item. */ - quantity?: number | null; + quantity?: number | null /** @description The total for this line item in cents. */ - total?: number | null; + total?: number | null /** @description The unit cost of the item in cents. */ - unit_cost?: number | null; - }; + unit_cost?: number | null + } /** * LineItem * @description A line item. */ item: { /** @description Total before any discounts or taxes are applied. */ - amount_subtotal: number; + amount_subtotal: number /** @description Total after discounts and taxes. */ - amount_total: number; + amount_total: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name. */ - description: string; + description: string /** @description The discounts applied to the line item. */ - discounts?: components["schemas"]["line_items_discount_amount"][]; + discounts?: components['schemas']['line_items_discount_amount'][] /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "item"; + object: 'item' /** @description The price used to generate the line item. */ - price?: Partial | null; + price?: Partial | null /** @description The quantity of products being purchased. */ - quantity?: number | null; + quantity?: number | null /** @description The taxes applied to the line item. */ - taxes?: components["schemas"]["line_items_tax_amount"][]; - }; + taxes?: components['schemas']['line_items_tax_amount'][] + } /** LegalEntityCompany */ legal_entity_company: { - address?: components["schemas"]["address"]; + address?: components['schemas']['address'] /** @description The Kana variation of the company's primary address (Japan only). */ - address_kana?: Partial | null; + address_kana?: Partial | null /** @description The Kanji variation of the company's primary address (Japan only). */ - address_kanji?: Partial | null; + address_kanji?: Partial | null /** @description 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?: boolean; + directors_provided?: boolean /** @description 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?: boolean; + executives_provided?: boolean /** @description The company's legal name. */ - name?: string | null; + name?: string | null /** @description The Kana variation of the company's legal name (Japan only). */ - name_kana?: string | null; + name_kana?: string | null /** @description The Kanji variation of the company's legal name (Japan only). */ - name_kanji?: string | null; + name_kanji?: string | null /** @description 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?: boolean; + owners_provided?: boolean /** @description This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct. */ - ownership_declaration?: Partial | null; + ownership_declaration?: Partial | null /** @description The company's phone number (used for verification). */ - phone?: string | null; + phone?: string | null /** * @description 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. * @enum {string} */ structure?: - | "free_zone_establishment" - | "free_zone_llc" - | "government_instrumentality" - | "governmental_unit" - | "incorporated_non_profit" - | "limited_liability_partnership" - | "llc" - | "multi_member_llc" - | "private_company" - | "private_corporation" - | "private_partnership" - | "public_company" - | "public_corporation" - | "public_partnership" - | "single_member_llc" - | "sole_establishment" - | "sole_proprietorship" - | "tax_exempt_government_instrumentality" - | "unincorporated_association" - | "unincorporated_non_profit"; + | 'free_zone_establishment' + | 'free_zone_llc' + | 'government_instrumentality' + | 'governmental_unit' + | 'incorporated_non_profit' + | 'limited_liability_partnership' + | 'llc' + | 'multi_member_llc' + | 'private_company' + | 'private_corporation' + | 'private_partnership' + | 'public_company' + | 'public_corporation' + | 'public_partnership' + | 'single_member_llc' + | 'sole_establishment' + | 'sole_proprietorship' + | 'tax_exempt_government_instrumentality' + | 'unincorporated_association' + | 'unincorporated_non_profit' /** @description Whether the company's business ID number was provided. */ - tax_id_provided?: boolean; + tax_id_provided?: boolean /** @description The jurisdiction in which the `tax_id` is registered (Germany-based companies only). */ - tax_id_registrar?: string; + tax_id_registrar?: string /** @description Whether the company's business VAT number was provided. */ - vat_id_provided?: boolean; + vat_id_provided?: boolean /** @description Information on the verification state of the company. */ - verification?: Partial | null; - }; + verification?: Partial | null + } /** LegalEntityCompanyVerification */ legal_entity_company_verification: { - document: components["schemas"]["legal_entity_company_verification_document"]; - }; + document: components['schemas']['legal_entity_company_verification_document'] + } /** LegalEntityCompanyVerificationDocument */ legal_entity_company_verification_document: { /** @description 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?: (Partial & Partial) | null; + back?: (Partial & Partial) | null /** @description A user-displayable string describing the verification state of this document. */ - details?: string | null; + details?: string | null /** @description 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?: string | null; + details_code?: string | null /** @description 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?: (Partial & Partial) | null; - }; + front?: (Partial & Partial) | null + } /** LegalEntityDOB */ legal_entity_dob: { /** @description The day of birth, between 1 and 31. */ - day?: number | null; + day?: number | null /** @description The month of birth, between 1 and 12. */ - month?: number | null; + month?: number | null /** @description The four-digit year of birth. */ - year?: number | null; - }; + year?: number | null + } /** LegalEntityJapanAddress */ legal_entity_japan_address: { /** @description City/Ward. */ - city?: string | null; + city?: string | null /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ - country?: string | null; + country?: string | null /** @description Block/Building number. */ - line1?: string | null; + line1?: string | null /** @description Building details. */ - line2?: string | null; + line2?: string | null /** @description ZIP or postal code. */ - postal_code?: string | null; + postal_code?: string | null /** @description Prefecture. */ - state?: string | null; + state?: string | null /** @description Town/cho-me. */ - town?: string | null; - }; + town?: string | null + } /** LegalEntityPersonVerification */ legal_entity_person_verification: { /** @description A document showing address, either a passport, local ID card, or utility bill from a well-known utility company. */ - additional_document?: Partial | null; + additional_document?: Partial | null /** @description A user-displayable string describing the verification state for the person. For example, this may say "Provided identity information could not be verified". */ - details?: string | null; + details?: string | null /** @description 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?: string | null; - document?: components["schemas"]["legal_entity_person_verification_document"]; + details_code?: string | null + document?: components['schemas']['legal_entity_person_verification_document'] /** @description The state of verification for the person. Possible values are `unverified`, `pending`, or `verified`. */ - status: string; - }; + status: string + } /** LegalEntityPersonVerificationDocument */ legal_entity_person_verification_document: { /** @description 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?: (Partial & Partial) | null; + back?: (Partial & Partial) | null /** @description 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?: string | null; + details?: string | null /** @description 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?: string | null; + details_code?: string | null /** @description 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?: (Partial & Partial) | null; - }; + front?: (Partial & Partial) | null + } /** LegalEntityUBODeclaration */ legal_entity_ubo_declaration: { /** * Format: unix-time * @description The Unix timestamp marking when the beneficial owner attestation was made. */ - date?: number | null; + date?: number | null /** @description The IP address from which the beneficial owner attestation was made. */ - ip?: string | null; + ip?: string | null /** @description The user-agent string from the browser where the beneficial owner attestation was made. */ - user_agent?: string | null; - }; + user_agent?: string | null + } /** InvoiceLineItem */ line_item: { /** @description The amount, in %s. */ - amount: number; + amount: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description The amount of discount calculated per discount for this line item. */ - discount_amounts?: components["schemas"]["discounts_resource_discount_amount"][] | null; + discount_amounts?: components['schemas']['discounts_resource_discount_amount'][] | null /** @description If true, discounts will apply to this line item. Always false for prorations. */ - discountable: boolean; + discountable: boolean /** @description The discounts applied to the invoice line item. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount. */ - discounts?: (Partial & Partial)[] | null; + discounts?: (Partial & Partial)[] | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The ID of the [invoice item](https://stripe.com/docs/api/invoiceitems) associated with this line item if any. */ - invoice_item?: string; + invoice_item?: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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` this will reflect the metadata of the subscription that caused the line item to be created. */ - metadata: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "line_item"; - period: components["schemas"]["invoice_line_item_period"]; + object: 'line_item' + period: components['schemas']['invoice_line_item_period'] /** @description The price of the line item. */ - price?: Partial | null; + price?: Partial | null /** @description Whether this is a proration. */ - proration: boolean; + proration: boolean /** @description The quantity of the subscription, if the line item is a subscription or a proration. */ - quantity?: number | null; + quantity?: number | null /** @description The subscription that the invoice item pertains to, if any. */ - subscription?: string | null; + subscription?: string | null /** @description The subscription item that generated this invoice item. Left empty if the line item is not an explicit result of a subscription. */ - subscription_item?: string; + subscription_item?: string /** @description The amount of tax calculated per tax rate for this line item */ - tax_amounts?: components["schemas"]["invoice_tax_amount"][]; + tax_amounts?: components['schemas']['invoice_tax_amount'][] /** @description The tax rates which apply to the line item. */ - tax_rates?: components["schemas"]["tax_rate"][]; + tax_rates?: components['schemas']['tax_rate'][] /** * @description A string identifying the type of the source of this line item, either an `invoiceitem` or a `subscription`. * @enum {string} */ - type: "invoiceitem" | "subscription"; - }; + type: 'invoiceitem' | 'subscription' + } /** LineItemsDiscountAmount */ line_items_discount_amount: { /** @description The amount discounted. */ - amount: number; - discount: components["schemas"]["discount"]; - }; + amount: number + discount: components['schemas']['discount'] + } /** LineItemsTaxAmount */ line_items_tax_amount: { /** @description Amount of tax applied for this rate. */ - amount: number; - rate: components["schemas"]["tax_rate"]; - }; + amount: number + rate: components['schemas']['tax_rate'] + } /** LoginLink */ login_link: { /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "login_link"; + object: 'login_link' /** @description The URL for the login link. */ - url: string; - }; + url: string + } /** * Mandate * @description A Mandate is a record of the permission a customer has given you to debit their payment method. */ mandate: { - customer_acceptance: components["schemas"]["customer_acceptance"]; + customer_acceptance: components['schemas']['customer_acceptance'] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; - multi_use?: components["schemas"]["mandate_multi_use"]; + livemode: boolean + multi_use?: components['schemas']['mandate_multi_use'] /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "mandate"; + object: 'mandate' /** @description ID of the payment method associated with this mandate. */ - payment_method: Partial & Partial; - payment_method_details: components["schemas"]["mandate_payment_method_details"]; - single_use?: components["schemas"]["mandate_single_use"]; + payment_method: Partial & Partial + payment_method_details: components['schemas']['mandate_payment_method_details'] + single_use?: components['schemas']['mandate_single_use'] /** * @description The status of the mandate, which indicates whether it can be used to initiate a payment. * @enum {string} */ - status: "active" | "inactive" | "pending"; + status: 'active' | 'inactive' | 'pending' /** * @description The type of the mandate. * @enum {string} */ - type: "multi_use" | "single_use"; - }; + type: 'multi_use' | 'single_use' + } /** mandate_acss_debit */ mandate_acss_debit: { /** @description List of Stripe products where this mandate can be selected automatically. */ - default_for?: ("invoice" | "subscription")[]; + default_for?: ('invoice' | 'subscription')[] /** @description Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. */ - interval_description?: string | null; + interval_description?: string | null /** * @description Payment schedule for the mandate. * @enum {string} */ - payment_schedule: "combined" | "interval" | "sporadic"; + payment_schedule: 'combined' | 'interval' | 'sporadic' /** * @description Transaction type of the mandate. * @enum {string} */ - transaction_type: "business" | "personal"; - }; + transaction_type: 'business' | 'personal' + } /** mandate_au_becs_debit */ mandate_au_becs_debit: { /** @description The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively. */ - url: string; - }; + url: string + } /** mandate_bacs_debit */ mandate_bacs_debit: { /** * @description The status of the mandate on the Bacs network. Can be one of `pending`, `revoked`, `refused`, or `accepted`. * @enum {string} */ - network_status: "accepted" | "pending" | "refused" | "revoked"; + network_status: 'accepted' | 'pending' | 'refused' | 'revoked' /** @description The unique reference identifying the mandate on the Bacs network. */ - reference: string; + reference: string /** @description The URL that will contain the mandate that the customer has signed. */ - url: string; - }; + url: string + } /** mandate_multi_use */ - mandate_multi_use: { [key: string]: unknown }; + mandate_multi_use: { [key: string]: unknown } /** mandate_payment_method_details */ mandate_payment_method_details: { - acss_debit?: components["schemas"]["mandate_acss_debit"]; - au_becs_debit?: components["schemas"]["mandate_au_becs_debit"]; - bacs_debit?: components["schemas"]["mandate_bacs_debit"]; - card?: components["schemas"]["card_mandate_payment_method_details"]; - sepa_debit?: components["schemas"]["mandate_sepa_debit"]; + acss_debit?: components['schemas']['mandate_acss_debit'] + au_becs_debit?: components['schemas']['mandate_au_becs_debit'] + bacs_debit?: components['schemas']['mandate_bacs_debit'] + card?: components['schemas']['card_mandate_payment_method_details'] + sepa_debit?: components['schemas']['mandate_sepa_debit'] /** @description The type of the payment method associated with this mandate. An additional hash is included on `payment_method_details` with a name matching this value. It contains mandate information specific to the payment method. */ - type: string; - }; + type: string + } /** mandate_sepa_debit */ mandate_sepa_debit: { /** @description The unique reference of the mandate. */ - reference: string; + reference: string /** @description The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively. */ - url: string; - }; + url: string + } /** mandate_single_use */ mandate_single_use: { /** @description On a single use mandate, the amount of the payment. */ - amount: number; + amount: number /** @description On a single use mandate, the currency of the payment. */ - currency: string; - }; + currency: string + } /** networks */ networks: { /** @description All available networks for the card. */ - available: string[]; + available: string[] /** @description The preferred network for the card. */ - preferred?: string | null; - }; + preferred?: string | null + } /** NotificationEventData */ notification_event_data: { /** @description 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: { [key: string]: unknown }; + object: { [key: string]: unknown } /** @description Object containing the names of the attributes that have changed, and their previous values (sent along only with *.updated events). */ - previous_attributes?: { [key: string]: unknown }; - }; + previous_attributes?: { [key: string]: unknown } + } /** NotificationEventRequest */ notification_event_request: { /** @description 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?: string | null; + id?: string | null /** @description 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?: string | null; - }; + idempotency_key?: string | null + } /** offline_acceptance */ - offline_acceptance: { [key: string]: unknown }; + offline_acceptance: { [key: string]: unknown } /** online_acceptance */ online_acceptance: { /** @description The IP address from which the Mandate was accepted by the customer. */ - ip_address?: string | null; + ip_address?: string | null /** @description The user agent of the browser from which the Mandate was accepted by the customer. */ - user_agent?: string | null; - }; + user_agent?: string | null + } /** * Order * @description Order objects are created to handle end customers' purchases of previously @@ -8594,80 +8530,76 @@ export interface components { */ order: { /** @description 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: number; + amount: number /** @description The total amount that was returned to the customer. */ - amount_returned?: number | null; + amount_returned?: number | null /** @description ID of the Connect Application that created the order. */ - application?: string | null; + application?: string | null /** @description A fee in cents that will be applied to the order and transferred to the application owner’s Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees documentation. */ - application_fee?: number | null; + application_fee?: number | null /** @description The ID of the payment used to pay for the order. Present if the order status is `paid`, `fulfilled`, or `refunded`. */ - charge?: (Partial & Partial) | null; + charge?: (Partial & Partial) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description The customer used for the order. */ - customer?: - | (Partial & - Partial & - Partial) - | null; + customer?: (Partial & Partial & Partial) | null /** @description The email address of the customer placing the order. */ - email?: string | null; + email?: string | null /** @description External coupon code to load for this order. */ - external_coupon_code?: string; + external_coupon_code?: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description List of items constituting the order. An order can have up to 25 items. */ - items: components["schemas"]["order_item"][]; + items: components['schemas']['order_item'][] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "order"; + object: 'order' /** * OrdersResourceOrderReturnList * @description A list of returns that have taken place for this order. */ returns?: { /** @description Details about each object. */ - data: components["schemas"]["order_return"][]; + data: components['schemas']['order_return'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } | null; + url: string + } | null /** @description The shipping method that is currently selected for this order, if any. If present, it is equal to one of the `id`s of shipping methods in the `shipping_methods` array. At order creation time, if there are multiple shipping methods, Stripe will automatically selected the first method. */ - selected_shipping_method?: string | null; + selected_shipping_method?: string | null /** @description The shipping address for the order. Present if the order is for goods to be shipped. */ - shipping?: Partial | null; + shipping?: Partial | null /** @description A list of supported shipping methods for this order. The desired shipping method can be specified either by updating the order, or when paying it. */ - shipping_methods?: components["schemas"]["shipping_method"][] | null; + shipping_methods?: components['schemas']['shipping_method'][] | null /** @description Current order status. One of `created`, `paid`, `canceled`, `fulfilled`, or `returned`. More details in the [Orders Guide](https://stripe.com/docs/orders/guide#understanding-order-statuses). */ - status: string; + status: string /** @description The timestamps at which the order status was updated. */ - status_transitions?: Partial | null; + status_transitions?: Partial | null /** * Format: unix-time * @description Time at which the object was last updated. Measured in seconds since the Unix epoch. */ - updated?: number | null; + updated?: number | null /** @description The user's order ID if it is different from the Stripe order ID. */ - upstream_id?: string; - }; + upstream_id?: string + } /** * OrderItem * @description A representation of the constituent items of any given order. Can be used to @@ -8677,23 +8609,23 @@ export interface components { */ order_item: { /** @description 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 line item. */ - amount: number; + amount: number /** @description 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: string; + currency: string /** @description Description of the line item, meant to be displayable to the user (e.g., `"Express shipping"`). */ - description: string; + description: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "order_item"; + object: 'order_item' /** @description The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a SKU). */ - parent?: (Partial & Partial) | null; + parent?: (Partial & Partial) | null /** @description A positive integer representing the number of instances of `parent` that are included in this order item. Applicable/present only if `type` is `sku`. */ - quantity?: number | null; + quantity?: number | null /** @description The type of line item. One of `sku`, `tax`, `shipping`, or `discount`. */ - type: string; - }; + type: string + } /** * OrderReturn * @description A return represents the full or partial return of a number of [order items](https://stripe.com/docs/api#order_items). @@ -8703,66 +8635,66 @@ export interface components { */ order_return: { /** @description 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 returned line item. */ - amount: number; + amount: number /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The items included in this order return. */ - items: components["schemas"]["order_item"][]; + items: components['schemas']['order_item'][] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "order_return"; + object: 'order_return' /** @description The order that this return includes items from. */ - order?: (Partial & Partial) | null; + order?: (Partial & Partial) | null /** @description The ID of the refund issued for this return. */ - refund?: (Partial & Partial) | null; - }; + refund?: (Partial & Partial) | null + } /** PackageDimensions */ package_dimensions: { /** @description Height, in inches. */ - height: number; + height: number /** @description Length, in inches. */ - length: number; + length: number /** @description Weight, in ounces. */ - weight: number; + weight: number /** @description Width, in inches. */ - width: number; - }; + width: number + } /** PaymentFlowsAutomaticPaymentMethodsPaymentIntent */ payment_flows_automatic_payment_methods_payment_intent: { /** @description Automatically calculates compatible payment methods */ - enabled: boolean; - }; + enabled: boolean + } /** PaymentFlowsPrivatePaymentMethodsAlipay */ - payment_flows_private_payment_methods_alipay: { [key: string]: unknown }; + payment_flows_private_payment_methods_alipay: { [key: string]: unknown } /** PaymentFlowsPrivatePaymentMethodsAlipayDetails */ payment_flows_private_payment_methods_alipay_details: { /** @description Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same. */ - buyer_id?: string; + buyer_id?: string /** @description Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Transaction ID of this particular Alipay transaction. */ - transaction_id?: string | null; - }; + transaction_id?: string | null + } /** PaymentFlowsPrivatePaymentMethodsKlarnaDOB */ payment_flows_private_payment_methods_klarna_dob: { /** @description The day of birth, between 1 and 31. */ - day?: number | null; + day?: number | null /** @description The month of birth, between 1 and 12. */ - month?: number | null; + month?: number | null /** @description The four-digit year of birth. */ - year?: number | null; - }; + year?: number | null + } /** * PaymentIntent * @description A PaymentIntent guides you through the process of collecting a payment from your customer. @@ -8779,61 +8711,51 @@ export interface components { */ payment_intent: { /** @description 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: number; + amount: number /** @description Amount that can be captured from this PaymentIntent. */ - amount_capturable?: number; + amount_capturable?: number /** @description Amount that was collected by this PaymentIntent. */ - amount_received?: number; + amount_received?: number /** @description ID of the Connect application that created the PaymentIntent. */ - application?: (Partial & Partial) | null; + application?: (Partial & Partial) | null /** @description 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?: number | null; + application_fee_amount?: number | null /** @description Settings to configure compatible payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods) */ - automatic_payment_methods?: Partial< - components["schemas"]["payment_flows_automatic_payment_methods_payment_intent"] - > | null; + automatic_payment_methods?: Partial | null /** * Format: unix-time * @description Populated when `status` is `canceled`, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch. */ - canceled_at?: number | null; + canceled_at?: number | null /** * @description 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`). * @enum {string|null} */ cancellation_reason?: - | ( - | "abandoned" - | "automatic" - | "duplicate" - | "failed_invoice" - | "fraudulent" - | "requested_by_customer" - | "void_invoice" - ) - | null; + | ('abandoned' | 'automatic' | 'duplicate' | 'failed_invoice' | 'fraudulent' | 'requested_by_customer' | 'void_invoice') + | null /** * @description Controls when the funds will be captured from the customer's account. * @enum {string} */ - capture_method: "automatic" | "manual"; + capture_method: 'automatic' | 'manual' /** * PaymentFlowsPaymentIntentResourceChargeList * @description Charges that were created by this PaymentIntent, if any. */ charges?: { /** @description This list only contains the latest charge, even if there were previously multiple unsuccessful charges. To view all previous charges for a PaymentIntent, you can filter the charges list using the `payment_intent` [parameter](https://stripe.com/docs/api/charges/list#list_charges-payment_intent). */ - data: components["schemas"]["charge"][]; + data: components['schemas']['charge'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** * @description The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key. * @@ -8841,16 +8763,16 @@ export interface components { * * Refer to our docs to [accept a payment](https://stripe.com/docs/payments/accept-a-payment?integration=elements) and learn about how `client_secret` should be handled. */ - client_secret?: string | null; + client_secret?: string | null /** @enum {string} */ - confirmation_method: "automatic" | "manual"; + confirmation_method: 'automatic' | 'manual' /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** * @description ID of the Customer this PaymentIntent belongs to, if one exists. * @@ -8858,44 +8780,40 @@ export interface components { * * If present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. */ - customer?: - | (Partial & - Partial & - Partial) - | null; + customer?: (Partial & Partial & Partial) | null /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description ID of the invoice that created this PaymentIntent, if it exists. */ - invoice?: (Partial & Partial) | null; + invoice?: (Partial & Partial) | null /** @description 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?: Partial | null; + last_payment_error?: Partial | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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. For more information, see the [documentation](https://stripe.com/docs/payments/payment-intents/creating-payment-intents#storing-information-in-metadata). */ - metadata?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description 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?: Partial | null; + next_action?: Partial | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "payment_intent"; + object: 'payment_intent' /** @description 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?: (Partial & Partial) | null; + on_behalf_of?: (Partial & Partial) | null /** @description ID of the payment method used in this PaymentIntent. */ - payment_method?: (Partial & Partial) | null; + payment_method?: (Partial & Partial) | null /** @description Payment-method-specific configuration for this PaymentIntent. */ - payment_method_options?: Partial | null; + payment_method_options?: Partial | null /** @description The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. */ - payment_method_types: string[]; + payment_method_types: string[] /** @description If present, this property tells you about the processing state of the payment. */ - processing?: Partial | null; + processing?: Partial | null /** @description 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?: string | null; + receipt_email?: string | null /** @description ID of the review associated with this PaymentIntent, if any. */ - review?: (Partial & Partial) | null; + review?: (Partial & Partial) | null /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * @@ -8904,190 +8822,183 @@ export interface components { * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string|null} */ - setup_future_usage?: ("off_session" | "on_session") | null; + setup_future_usage?: ('off_session' | 'on_session') | null /** @description Shipping information for this PaymentIntent. */ - shipping?: Partial | null; + shipping?: Partial | null /** @description For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - statement_descriptor?: string | null; + statement_descriptor?: string | null /** @description Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - statement_descriptor_suffix?: string | null; + statement_descriptor_suffix?: string | null /** * @description 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). * @enum {string} */ - status: - | "canceled" - | "processing" - | "requires_action" - | "requires_capture" - | "requires_confirmation" - | "requires_payment_method" - | "succeeded"; + status: 'canceled' | 'processing' | 'requires_action' | 'requires_capture' | 'requires_confirmation' | 'requires_payment_method' | 'succeeded' /** @description The data with which to automatically create a Transfer when the payment is finalized. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. */ - transfer_data?: Partial | null; + transfer_data?: Partial | null /** @description A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. */ - transfer_group?: string | null; - }; + transfer_group?: string | null + } /** PaymentIntentCardProcessing */ - payment_intent_card_processing: { [key: string]: unknown }; + payment_intent_card_processing: { [key: string]: unknown } /** PaymentIntentNextAction */ payment_intent_next_action: { - alipay_handle_redirect?: components["schemas"]["payment_intent_next_action_alipay_handle_redirect"]; - boleto_display_details?: components["schemas"]["payment_intent_next_action_boleto"]; - oxxo_display_details?: components["schemas"]["payment_intent_next_action_display_oxxo_details"]; - redirect_to_url?: components["schemas"]["payment_intent_next_action_redirect_to_url"]; + alipay_handle_redirect?: components['schemas']['payment_intent_next_action_alipay_handle_redirect'] + boleto_display_details?: components['schemas']['payment_intent_next_action_boleto'] + oxxo_display_details?: components['schemas']['payment_intent_next_action_display_oxxo_details'] + redirect_to_url?: components['schemas']['payment_intent_next_action_redirect_to_url'] /** @description 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: string; + type: string /** @description 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?: { [key: string]: unknown }; - verify_with_microdeposits?: components["schemas"]["payment_intent_next_action_verify_with_microdeposits"]; - wechat_pay_display_qr_code?: components["schemas"]["payment_intent_next_action_wechat_pay_display_qr_code"]; - wechat_pay_redirect_to_android_app?: components["schemas"]["payment_intent_next_action_wechat_pay_redirect_to_android_app"]; - wechat_pay_redirect_to_ios_app?: components["schemas"]["payment_intent_next_action_wechat_pay_redirect_to_ios_app"]; - }; + use_stripe_sdk?: { [key: string]: unknown } + verify_with_microdeposits?: components['schemas']['payment_intent_next_action_verify_with_microdeposits'] + wechat_pay_display_qr_code?: components['schemas']['payment_intent_next_action_wechat_pay_display_qr_code'] + wechat_pay_redirect_to_android_app?: components['schemas']['payment_intent_next_action_wechat_pay_redirect_to_android_app'] + wechat_pay_redirect_to_ios_app?: components['schemas']['payment_intent_next_action_wechat_pay_redirect_to_ios_app'] + } /** PaymentIntentNextActionAlipayHandleRedirect */ payment_intent_next_action_alipay_handle_redirect: { /** @description 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?: string | null; + native_data?: string | null /** @description The native URL you must redirect your customer to in order to authenticate the payment in an iOS App. */ - native_url?: string | null; + native_url?: string | null /** @description If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion. */ - return_url?: string | null; + return_url?: string | null /** @description The URL you must redirect your customer to in order to authenticate the payment. */ - url?: string | null; - }; + url?: string | null + } /** payment_intent_next_action_boleto */ payment_intent_next_action_boleto: { /** * Format: unix-time * @description The timestamp after which the boleto expires. */ - expires_at?: number | null; + expires_at?: number | null /** @description The URL to the hosted boleto voucher page, which allows customers to view the boleto voucher. */ - hosted_voucher_url?: string | null; + hosted_voucher_url?: string | null /** @description The boleto number. */ - number?: string | null; + number?: string | null /** @description The URL to the downloadable boleto voucher PDF. */ - pdf?: string | null; - }; + pdf?: string | null + } /** PaymentIntentNextActionDisplayOxxoDetails */ payment_intent_next_action_display_oxxo_details: { /** * Format: unix-time * @description The timestamp after which the OXXO voucher expires. */ - expires_after?: number | null; + expires_after?: number | null /** @description The URL for the hosted OXXO voucher page, which allows customers to view and print an OXXO voucher. */ - hosted_voucher_url?: string | null; + hosted_voucher_url?: string | null /** @description OXXO reference number. */ - number?: string | null; - }; + number?: string | null + } /** PaymentIntentNextActionRedirectToUrl */ payment_intent_next_action_redirect_to_url: { /** @description If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion. */ - return_url?: string | null; + return_url?: string | null /** @description The URL you must redirect your customer to in order to authenticate the payment. */ - url?: string | null; - }; + url?: string | null + } /** PaymentIntentNextActionVerifyWithMicrodeposits */ payment_intent_next_action_verify_with_microdeposits: { /** * Format: unix-time * @description The timestamp when the microdeposits are expected to land. */ - arrival_date: number; + arrival_date: number /** @description The URL for the hosted verification page, which allows customers to verify their bank account. */ - hosted_verification_url: string; - }; + hosted_verification_url: string + } /** PaymentIntentNextActionWechatPayDisplayQrCode */ payment_intent_next_action_wechat_pay_display_qr_code: { /** @description The data being used to generate QR code */ - data: string; + data: string /** @description The base64 image data for a pre-generated QR code */ - image_data_url: string; + image_data_url: string /** @description The image_url_png string used to render QR code */ - image_url_png: string; + image_url_png: string /** @description The image_url_svg string used to render QR code */ - image_url_svg: string; - }; + image_url_svg: string + } /** PaymentIntentNextActionWechatPayRedirectToAndroidApp */ payment_intent_next_action_wechat_pay_redirect_to_android_app: { /** @description app_id is the APP ID registered on WeChat open platform */ - app_id: string; + app_id: string /** @description nonce_str is a random string */ - nonce_str: string; + nonce_str: string /** @description package is static value */ - package: string; + package: string /** @description an unique merchant ID assigned by Wechat Pay */ - partner_id: string; + partner_id: string /** @description an unique trading ID assigned by Wechat Pay */ - prepay_id: string; + prepay_id: string /** @description A signature */ - sign: string; + sign: string /** @description Specifies the current time in epoch format */ - timestamp: string; - }; + timestamp: string + } /** PaymentIntentNextActionWechatPayRedirectToIOSApp */ payment_intent_next_action_wechat_pay_redirect_to_ios_app: { /** @description An universal link that redirect to Wechat Pay APP */ - native_url: string; - }; + native_url: string + } /** PaymentIntentPaymentMethodOptions */ payment_intent_payment_method_options: { - acss_debit?: Partial & - Partial; - afterpay_clearpay?: Partial & - Partial; - alipay?: Partial & - Partial; - au_becs_debit?: Partial & - Partial; - bacs_debit?: Partial & - Partial; - bancontact?: Partial & - Partial; - boleto?: Partial & - Partial; - card?: Partial & - Partial; - card_present?: Partial & - Partial; - eps?: Partial & - Partial; - fpx?: Partial & - Partial; - giropay?: Partial & - Partial; - grabpay?: Partial & - Partial; - ideal?: Partial & - Partial; - interac_present?: Partial & - Partial; - klarna?: Partial & - Partial; - oxxo?: Partial & - Partial; - p24?: Partial & - Partial; - sepa_debit?: Partial & - Partial; - sofort?: Partial & - Partial; - wechat_pay?: Partial & - Partial; - }; + acss_debit?: Partial & + Partial + afterpay_clearpay?: Partial & + Partial + alipay?: Partial & + Partial + au_becs_debit?: Partial & + Partial + bacs_debit?: Partial & + Partial + bancontact?: Partial & + Partial + boleto?: Partial & + Partial + card?: Partial & + Partial + card_present?: Partial & + Partial + eps?: Partial & + Partial + fpx?: Partial & + Partial + giropay?: Partial & + Partial + grabpay?: Partial & + Partial + ideal?: Partial & + Partial + interac_present?: Partial & + Partial + klarna?: Partial & + Partial + oxxo?: Partial & + Partial + p24?: Partial & + Partial + sepa_debit?: Partial & + Partial + sofort?: Partial & + Partial + wechat_pay?: Partial & + Partial + } /** payment_intent_payment_method_options_acss_debit */ payment_intent_payment_method_options_acss_debit: { - mandate_options?: components["schemas"]["payment_intent_payment_method_options_mandate_options_acss_debit"]; + mandate_options?: components['schemas']['payment_intent_payment_method_options_mandate_options_acss_debit'] /** * @description Bank account verification method. * @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; - }; + verification_method?: 'automatic' | 'instant' | 'microdeposits' + } /** payment_intent_payment_method_options_au_becs_debit */ - payment_intent_payment_method_options_au_becs_debit: { [key: string]: unknown }; + payment_intent_payment_method_options_au_becs_debit: { [key: string]: unknown } /** payment_intent_payment_method_options_card */ payment_intent_payment_method_options_card: { /** @@ -9095,30 +9006,17 @@ export interface components { * * For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments). */ - installments?: Partial | null; + installments?: Partial | null /** * @description 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. * @enum {string|null} */ - network?: - | ( - | "amex" - | "cartes_bancaires" - | "diners" - | "discover" - | "interac" - | "jcb" - | "mastercard" - | "unionpay" - | "unknown" - | "visa" - ) - | null; + network?: ('amex' | 'cartes_bancaires' | 'diners' | 'discover' | 'interac' | 'jcb' | 'mastercard' | 'unionpay' | 'unknown' | 'visa') | null /** * @description 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. Permitted values include: `automatic` or `any`. If not provided, defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. * @enum {string|null} */ - request_three_d_secure?: ("any" | "automatic" | "challenge_only") | null; + request_three_d_secure?: ('any' | 'automatic' | 'challenge_only') | null /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * @@ -9127,42 +9025,42 @@ export interface components { * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ - setup_future_usage?: "none" | "off_session" | "on_session"; - }; + setup_future_usage?: 'none' | 'off_session' | 'on_session' + } /** payment_intent_payment_method_options_eps */ - payment_intent_payment_method_options_eps: { [key: string]: unknown }; + payment_intent_payment_method_options_eps: { [key: string]: unknown } /** payment_intent_payment_method_options_mandate_options_acss_debit */ payment_intent_payment_method_options_mandate_options_acss_debit: { /** @description A URL for custom mandate text */ - custom_mandate_url?: string; + custom_mandate_url?: string /** @description Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. */ - interval_description?: string | null; + interval_description?: string | null /** * @description Payment schedule for the mandate. * @enum {string|null} */ - payment_schedule?: ("combined" | "interval" | "sporadic") | null; + payment_schedule?: ('combined' | 'interval' | 'sporadic') | null /** * @description Transaction type of the mandate. * @enum {string|null} */ - transaction_type?: ("business" | "personal") | null; - }; + transaction_type?: ('business' | 'personal') | null + } /** payment_intent_payment_method_options_mandate_options_sepa_debit */ - payment_intent_payment_method_options_mandate_options_sepa_debit: { [key: string]: unknown }; + payment_intent_payment_method_options_mandate_options_sepa_debit: { [key: string]: unknown } /** payment_intent_payment_method_options_sepa_debit */ payment_intent_payment_method_options_sepa_debit: { - mandate_options?: components["schemas"]["payment_intent_payment_method_options_mandate_options_sepa_debit"]; - }; + mandate_options?: components['schemas']['payment_intent_payment_method_options_mandate_options_sepa_debit'] + } /** PaymentIntentProcessing */ payment_intent_processing: { - card?: components["schemas"]["payment_intent_card_processing"]; + card?: components['schemas']['payment_intent_card_processing'] /** * @description Type of the payment method for which payment is in `processing` state, one of `card`. * @enum {string} */ - type: "card"; - }; + type: 'card' + } /** PaymentIntentTypeSpecificPaymentMethodOptionsClient */ payment_intent_type_specific_payment_method_options_client: { /** @@ -9173,8 +9071,8 @@ export interface components { * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ - setup_future_usage?: "none" | "off_session" | "on_session"; - }; + setup_future_usage?: 'none' | 'off_session' | 'on_session' + } /** * PaymentLink * @description A payment link is a shareable URL that will take your customers to a hosted payment page. A payment link can be shared and used multiple times. @@ -9185,349 +9083,347 @@ export interface components { */ payment_link: { /** @description 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: boolean; - after_completion: components["schemas"]["payment_links_resource_after_completion"]; + active: boolean + after_completion: components['schemas']['payment_links_resource_after_completion'] /** @description Whether user redeemable promotion codes are enabled. */ - allow_promotion_codes: boolean; + allow_promotion_codes: boolean /** @description 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?: number | null; + application_fee_amount?: number | null /** @description This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. */ - application_fee_percent?: number | null; - automatic_tax: components["schemas"]["payment_links_resource_automatic_tax"]; + application_fee_percent?: number | null + automatic_tax: components['schemas']['payment_links_resource_automatic_tax'] /** * @description Configuration for collecting the customer's billing address. * @enum {string} */ - billing_address_collection: "auto" | "required"; + billing_address_collection: 'auto' | 'required' /** @description Unique identifier for the object. */ - id: string; + id: string /** * PaymentLinksResourceListLineItems * @description The line items representing what is being sold. */ line_items?: { /** @description Details about each object. */ - data: components["schemas"]["item"][]; + data: components['schemas']['item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "payment_link"; + object: 'payment_link' /** @description 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?: (Partial & Partial) | null; + on_behalf_of?: (Partial & Partial) | null /** @description 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?: "card"[] | null; - phone_number_collection: components["schemas"]["payment_links_resource_phone_number_collection"]; + payment_method_types?: 'card'[] | null + phone_number_collection: components['schemas']['payment_links_resource_phone_number_collection'] /** @description Configuration for collecting the customer's shipping address. */ - shipping_address_collection?: Partial< - components["schemas"]["payment_links_resource_shipping_address_collection"] - > | null; + shipping_address_collection?: Partial | null /** @description 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?: Partial | null; + subscription_data?: Partial | null /** @description 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?: Partial | null; + transfer_data?: Partial | null /** @description The public URL that can be shared with customers. */ - url: string; - }; + url: string + } /** PaymentLinksResourceAfterCompletion */ payment_links_resource_after_completion: { - hosted_confirmation?: components["schemas"]["payment_links_resource_completion_behavior_confirmation_page"]; - redirect?: components["schemas"]["payment_links_resource_completion_behavior_redirect"]; + hosted_confirmation?: components['schemas']['payment_links_resource_completion_behavior_confirmation_page'] + redirect?: components['schemas']['payment_links_resource_completion_behavior_redirect'] /** * @description The specified behavior after the purchase is complete. * @enum {string} */ - type: "hosted_confirmation" | "redirect"; - }; + type: 'hosted_confirmation' | 'redirect' + } /** PaymentLinksResourceAutomaticTax */ payment_links_resource_automatic_tax: { /** @description If `true`, tax will be calculated automatically using the customer's location. */ - enabled: boolean; - }; + enabled: boolean + } /** PaymentLinksResourceCompletionBehaviorConfirmationPage */ payment_links_resource_completion_behavior_confirmation_page: { /** @description The custom message that is displayed to the customer after the purchase is complete. */ - custom_message?: string | null; - }; + custom_message?: string | null + } /** PaymentLinksResourceCompletionBehaviorRedirect */ payment_links_resource_completion_behavior_redirect: { /** @description The URL the customer will be redirected to after the purchase is complete. */ - url: string; - }; + url: string + } /** PaymentLinksResourcePhoneNumberCollection */ payment_links_resource_phone_number_collection: { /** @description If `true`, a phone number will be collected during checkout. */ - enabled: boolean; - }; + enabled: boolean + } /** PaymentLinksResourceShippingAddressCollection */ payment_links_resource_shipping_address_collection: { /** @description 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: ( - | "AC" - | "AD" - | "AE" - | "AF" - | "AG" - | "AI" - | "AL" - | "AM" - | "AO" - | "AQ" - | "AR" - | "AT" - | "AU" - | "AW" - | "AX" - | "AZ" - | "BA" - | "BB" - | "BD" - | "BE" - | "BF" - | "BG" - | "BH" - | "BI" - | "BJ" - | "BL" - | "BM" - | "BN" - | "BO" - | "BQ" - | "BR" - | "BS" - | "BT" - | "BV" - | "BW" - | "BY" - | "BZ" - | "CA" - | "CD" - | "CF" - | "CG" - | "CH" - | "CI" - | "CK" - | "CL" - | "CM" - | "CN" - | "CO" - | "CR" - | "CV" - | "CW" - | "CY" - | "CZ" - | "DE" - | "DJ" - | "DK" - | "DM" - | "DO" - | "DZ" - | "EC" - | "EE" - | "EG" - | "EH" - | "ER" - | "ES" - | "ET" - | "FI" - | "FJ" - | "FK" - | "FO" - | "FR" - | "GA" - | "GB" - | "GD" - | "GE" - | "GF" - | "GG" - | "GH" - | "GI" - | "GL" - | "GM" - | "GN" - | "GP" - | "GQ" - | "GR" - | "GS" - | "GT" - | "GU" - | "GW" - | "GY" - | "HK" - | "HN" - | "HR" - | "HT" - | "HU" - | "ID" - | "IE" - | "IL" - | "IM" - | "IN" - | "IO" - | "IQ" - | "IS" - | "IT" - | "JE" - | "JM" - | "JO" - | "JP" - | "KE" - | "KG" - | "KH" - | "KI" - | "KM" - | "KN" - | "KR" - | "KW" - | "KY" - | "KZ" - | "LA" - | "LB" - | "LC" - | "LI" - | "LK" - | "LR" - | "LS" - | "LT" - | "LU" - | "LV" - | "LY" - | "MA" - | "MC" - | "MD" - | "ME" - | "MF" - | "MG" - | "MK" - | "ML" - | "MM" - | "MN" - | "MO" - | "MQ" - | "MR" - | "MS" - | "MT" - | "MU" - | "MV" - | "MW" - | "MX" - | "MY" - | "MZ" - | "NA" - | "NC" - | "NE" - | "NG" - | "NI" - | "NL" - | "NO" - | "NP" - | "NR" - | "NU" - | "NZ" - | "OM" - | "PA" - | "PE" - | "PF" - | "PG" - | "PH" - | "PK" - | "PL" - | "PM" - | "PN" - | "PR" - | "PS" - | "PT" - | "PY" - | "QA" - | "RE" - | "RO" - | "RS" - | "RU" - | "RW" - | "SA" - | "SB" - | "SC" - | "SE" - | "SG" - | "SH" - | "SI" - | "SJ" - | "SK" - | "SL" - | "SM" - | "SN" - | "SO" - | "SR" - | "SS" - | "ST" - | "SV" - | "SX" - | "SZ" - | "TA" - | "TC" - | "TD" - | "TF" - | "TG" - | "TH" - | "TJ" - | "TK" - | "TL" - | "TM" - | "TN" - | "TO" - | "TR" - | "TT" - | "TV" - | "TW" - | "TZ" - | "UA" - | "UG" - | "US" - | "UY" - | "UZ" - | "VA" - | "VC" - | "VE" - | "VG" - | "VN" - | "VU" - | "WF" - | "WS" - | "XK" - | "YE" - | "YT" - | "ZA" - | "ZM" - | "ZW" - | "ZZ" - )[]; - }; + | 'AC' + | 'AD' + | 'AE' + | 'AF' + | 'AG' + | 'AI' + | 'AL' + | 'AM' + | 'AO' + | 'AQ' + | 'AR' + | 'AT' + | 'AU' + | 'AW' + | 'AX' + | 'AZ' + | 'BA' + | 'BB' + | 'BD' + | 'BE' + | 'BF' + | 'BG' + | 'BH' + | 'BI' + | 'BJ' + | 'BL' + | 'BM' + | 'BN' + | 'BO' + | 'BQ' + | 'BR' + | 'BS' + | 'BT' + | 'BV' + | 'BW' + | 'BY' + | 'BZ' + | 'CA' + | 'CD' + | 'CF' + | 'CG' + | 'CH' + | 'CI' + | 'CK' + | 'CL' + | 'CM' + | 'CN' + | 'CO' + | 'CR' + | 'CV' + | 'CW' + | 'CY' + | 'CZ' + | 'DE' + | 'DJ' + | 'DK' + | 'DM' + | 'DO' + | 'DZ' + | 'EC' + | 'EE' + | 'EG' + | 'EH' + | 'ER' + | 'ES' + | 'ET' + | 'FI' + | 'FJ' + | 'FK' + | 'FO' + | 'FR' + | 'GA' + | 'GB' + | 'GD' + | 'GE' + | 'GF' + | 'GG' + | 'GH' + | 'GI' + | 'GL' + | 'GM' + | 'GN' + | 'GP' + | 'GQ' + | 'GR' + | 'GS' + | 'GT' + | 'GU' + | 'GW' + | 'GY' + | 'HK' + | 'HN' + | 'HR' + | 'HT' + | 'HU' + | 'ID' + | 'IE' + | 'IL' + | 'IM' + | 'IN' + | 'IO' + | 'IQ' + | 'IS' + | 'IT' + | 'JE' + | 'JM' + | 'JO' + | 'JP' + | 'KE' + | 'KG' + | 'KH' + | 'KI' + | 'KM' + | 'KN' + | 'KR' + | 'KW' + | 'KY' + | 'KZ' + | 'LA' + | 'LB' + | 'LC' + | 'LI' + | 'LK' + | 'LR' + | 'LS' + | 'LT' + | 'LU' + | 'LV' + | 'LY' + | 'MA' + | 'MC' + | 'MD' + | 'ME' + | 'MF' + | 'MG' + | 'MK' + | 'ML' + | 'MM' + | 'MN' + | 'MO' + | 'MQ' + | 'MR' + | 'MS' + | 'MT' + | 'MU' + | 'MV' + | 'MW' + | 'MX' + | 'MY' + | 'MZ' + | 'NA' + | 'NC' + | 'NE' + | 'NG' + | 'NI' + | 'NL' + | 'NO' + | 'NP' + | 'NR' + | 'NU' + | 'NZ' + | 'OM' + | 'PA' + | 'PE' + | 'PF' + | 'PG' + | 'PH' + | 'PK' + | 'PL' + | 'PM' + | 'PN' + | 'PR' + | 'PS' + | 'PT' + | 'PY' + | 'QA' + | 'RE' + | 'RO' + | 'RS' + | 'RU' + | 'RW' + | 'SA' + | 'SB' + | 'SC' + | 'SE' + | 'SG' + | 'SH' + | 'SI' + | 'SJ' + | 'SK' + | 'SL' + | 'SM' + | 'SN' + | 'SO' + | 'SR' + | 'SS' + | 'ST' + | 'SV' + | 'SX' + | 'SZ' + | 'TA' + | 'TC' + | 'TD' + | 'TF' + | 'TG' + | 'TH' + | 'TJ' + | 'TK' + | 'TL' + | 'TM' + | 'TN' + | 'TO' + | 'TR' + | 'TT' + | 'TV' + | 'TW' + | 'TZ' + | 'UA' + | 'UG' + | 'US' + | 'UY' + | 'UZ' + | 'VA' + | 'VC' + | 'VE' + | 'VG' + | 'VN' + | 'VU' + | 'WF' + | 'WS' + | 'XK' + | 'YE' + | 'YT' + | 'ZA' + | 'ZM' + | 'ZW' + | 'ZZ' + )[] + } /** PaymentLinksResourceSubscriptionData */ payment_links_resource_subscription_data: { /** @description Integer representing the number of trial period days before the customer is charged for the first time. */ - trial_period_days?: number | null; - }; + trial_period_days?: number | null + } /** PaymentLinksResourceTransferData */ payment_links_resource_transfer_data: { /** @description The amount in %s that will be transferred to the destination account. By default, the entire amount is transferred to the destination. */ - amount?: number | null; + amount?: number | null /** @description The connected account receiving the transfer. */ - destination: Partial & Partial; - }; + destination: Partial & Partial + } /** * PaymentMethod * @description PaymentMethod objects represent your customer's payment instruments. @@ -9537,530 +9433,522 @@ export interface components { * Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios). */ payment_method: { - acss_debit?: components["schemas"]["payment_method_acss_debit"]; - afterpay_clearpay?: components["schemas"]["payment_method_afterpay_clearpay"]; - alipay?: components["schemas"]["payment_flows_private_payment_methods_alipay"]; - au_becs_debit?: components["schemas"]["payment_method_au_becs_debit"]; - bacs_debit?: components["schemas"]["payment_method_bacs_debit"]; - bancontact?: components["schemas"]["payment_method_bancontact"]; - billing_details: components["schemas"]["billing_details"]; - boleto?: components["schemas"]["payment_method_boleto"]; - card?: components["schemas"]["payment_method_card"]; - card_present?: components["schemas"]["payment_method_card_present"]; + acss_debit?: components['schemas']['payment_method_acss_debit'] + afterpay_clearpay?: components['schemas']['payment_method_afterpay_clearpay'] + alipay?: components['schemas']['payment_flows_private_payment_methods_alipay'] + au_becs_debit?: components['schemas']['payment_method_au_becs_debit'] + bacs_debit?: components['schemas']['payment_method_bacs_debit'] + bancontact?: components['schemas']['payment_method_bancontact'] + billing_details: components['schemas']['billing_details'] + boleto?: components['schemas']['payment_method_boleto'] + card?: components['schemas']['payment_method_card'] + card_present?: components['schemas']['payment_method_card_present'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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?: (Partial & Partial) | null; - eps?: components["schemas"]["payment_method_eps"]; - fpx?: components["schemas"]["payment_method_fpx"]; - giropay?: components["schemas"]["payment_method_giropay"]; - grabpay?: components["schemas"]["payment_method_grabpay"]; + customer?: (Partial & Partial) | null + eps?: components['schemas']['payment_method_eps'] + fpx?: components['schemas']['payment_method_fpx'] + giropay?: components['schemas']['payment_method_giropay'] + grabpay?: components['schemas']['payment_method_grabpay'] /** @description Unique identifier for the object. */ - id: string; - ideal?: components["schemas"]["payment_method_ideal"]; - interac_present?: components["schemas"]["payment_method_interac_present"]; - klarna?: components["schemas"]["payment_method_klarna"]; + id: string + ideal?: components['schemas']['payment_method_ideal'] + interac_present?: components['schemas']['payment_method_interac_present'] + klarna?: components['schemas']['payment_method_klarna'] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "payment_method"; - oxxo?: components["schemas"]["payment_method_oxxo"]; - p24?: components["schemas"]["payment_method_p24"]; - sepa_debit?: components["schemas"]["payment_method_sepa_debit"]; - sofort?: components["schemas"]["payment_method_sofort"]; + object: 'payment_method' + oxxo?: components['schemas']['payment_method_oxxo'] + p24?: components['schemas']['payment_method_p24'] + sepa_debit?: components['schemas']['payment_method_sepa_debit'] + sofort?: components['schemas']['payment_method_sofort'] /** * @description 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. * @enum {string} */ type: - | "acss_debit" - | "afterpay_clearpay" - | "alipay" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "card_present" - | "eps" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "interac_present" - | "klarna" - | "oxxo" - | "p24" - | "sepa_debit" - | "sofort" - | "wechat_pay"; - wechat_pay?: components["schemas"]["payment_method_wechat_pay"]; - }; + | 'acss_debit' + | 'afterpay_clearpay' + | 'alipay' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'card_present' + | 'eps' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'interac_present' + | 'klarna' + | 'oxxo' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' + wechat_pay?: components['schemas']['payment_method_wechat_pay'] + } /** payment_method_acss_debit */ payment_method_acss_debit: { /** @description Name of the bank associated with the bank account. */ - bank_name?: string | null; + bank_name?: string | null /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Institution number of the bank account. */ - institution_number?: string | null; + institution_number?: string | null /** @description Last four digits of the bank account number. */ - last4?: string | null; + last4?: string | null /** @description Transit number of the bank account. */ - transit_number?: string | null; - }; + transit_number?: string | null + } /** payment_method_afterpay_clearpay */ - payment_method_afterpay_clearpay: { [key: string]: unknown }; + payment_method_afterpay_clearpay: { [key: string]: unknown } /** payment_method_au_becs_debit */ payment_method_au_becs_debit: { /** @description Six-digit number identifying bank and branch associated with this bank account. */ - bsb_number?: string | null; + bsb_number?: string | null /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Last four digits of the bank account number. */ - last4?: string | null; - }; + last4?: string | null + } /** payment_method_bacs_debit */ payment_method_bacs_debit: { /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Last four digits of the bank account number. */ - last4?: string | null; + last4?: string | null /** @description Sort code of the bank account. (e.g., `10-20-30`) */ - sort_code?: string | null; - }; + sort_code?: string | null + } /** payment_method_bancontact */ - payment_method_bancontact: { [key: string]: unknown }; + payment_method_bancontact: { [key: string]: unknown } /** payment_method_boleto */ payment_method_boleto: { /** @description Uniquely identifies the customer tax id (CNPJ or CPF) */ - tax_id: string; - }; + tax_id: string + } /** payment_method_card */ payment_method_card: { /** @description Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ - brand: string; + brand: string /** @description Checks on Card address and CVC if provided. */ - checks?: Partial | null; + checks?: Partial | null /** @description 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?: string | null; + country?: string | null /** @description Two-digit number representing the card's expiration month. */ - exp_month: number; + exp_month: number /** @description Four-digit number representing the card's expiration year. */ - exp_year: number; + exp_year: number /** * @description 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. * * *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.* */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ - funding: string; + funding: string /** @description Details of the original PaymentMethod that created this object. */ - generated_from?: Partial | null; + generated_from?: Partial | null /** @description The last four digits of the card. */ - last4: string; + last4: string /** @description Contains information about card networks that can be used to process the payment. */ - networks?: Partial | null; + networks?: Partial | null /** @description Contains details on how this Card maybe be used for 3D Secure authentication. */ - three_d_secure_usage?: Partial | null; + three_d_secure_usage?: Partial | null /** @description If this Card is part of a card wallet, this contains the details of the card wallet. */ - wallet?: Partial | null; - }; + wallet?: Partial | null + } /** payment_method_card_checks */ payment_method_card_checks: { /** @description If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ - address_line1_check?: string | null; + address_line1_check?: string | null /** @description If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ - address_postal_code_check?: string | null; + address_postal_code_check?: string | null /** @description If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ - cvc_check?: string | null; - }; + cvc_check?: string | null + } /** payment_method_card_generated_card */ payment_method_card_generated_card: { /** @description The charge that created this object. */ - charge?: string | null; + charge?: string | null /** @description Transaction-specific details of the payment method used in the payment. */ - payment_method_details?: Partial | null; + payment_method_details?: Partial | null /** @description The ID of the SetupAttempt that generated this PaymentMethod, if any. */ - setup_attempt?: (Partial & Partial) | null; - }; + setup_attempt?: (Partial & Partial) | null + } /** payment_method_card_present */ - payment_method_card_present: { [key: string]: unknown }; + payment_method_card_present: { [key: string]: unknown } /** payment_method_card_wallet */ payment_method_card_wallet: { - amex_express_checkout?: components["schemas"]["payment_method_card_wallet_amex_express_checkout"]; - apple_pay?: components["schemas"]["payment_method_card_wallet_apple_pay"]; + amex_express_checkout?: components['schemas']['payment_method_card_wallet_amex_express_checkout'] + apple_pay?: components['schemas']['payment_method_card_wallet_apple_pay'] /** @description (For tokenized numbers only.) The last four digits of the device account number. */ - dynamic_last4?: string | null; - google_pay?: components["schemas"]["payment_method_card_wallet_google_pay"]; - masterpass?: components["schemas"]["payment_method_card_wallet_masterpass"]; - samsung_pay?: components["schemas"]["payment_method_card_wallet_samsung_pay"]; + dynamic_last4?: string | null + google_pay?: components['schemas']['payment_method_card_wallet_google_pay'] + masterpass?: components['schemas']['payment_method_card_wallet_masterpass'] + samsung_pay?: components['schemas']['payment_method_card_wallet_samsung_pay'] /** * @description The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, or `visa_checkout`. 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. * @enum {string} */ - type: "amex_express_checkout" | "apple_pay" | "google_pay" | "masterpass" | "samsung_pay" | "visa_checkout"; - visa_checkout?: components["schemas"]["payment_method_card_wallet_visa_checkout"]; - }; + type: 'amex_express_checkout' | 'apple_pay' | 'google_pay' | 'masterpass' | 'samsung_pay' | 'visa_checkout' + visa_checkout?: components['schemas']['payment_method_card_wallet_visa_checkout'] + } /** payment_method_card_wallet_amex_express_checkout */ - payment_method_card_wallet_amex_express_checkout: { [key: string]: unknown }; + payment_method_card_wallet_amex_express_checkout: { [key: string]: unknown } /** payment_method_card_wallet_apple_pay */ - payment_method_card_wallet_apple_pay: { [key: string]: unknown }; + payment_method_card_wallet_apple_pay: { [key: string]: unknown } /** payment_method_card_wallet_google_pay */ - payment_method_card_wallet_google_pay: { [key: string]: unknown }; + payment_method_card_wallet_google_pay: { [key: string]: unknown } /** payment_method_card_wallet_masterpass */ payment_method_card_wallet_masterpass: { /** @description 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?: Partial | null; + billing_address?: Partial | null /** @description 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?: string | null; + email?: string | null /** @description 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?: string | null; + name?: string | null /** @description 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?: Partial | null; - }; + shipping_address?: Partial | null + } /** payment_method_card_wallet_samsung_pay */ - payment_method_card_wallet_samsung_pay: { [key: string]: unknown }; + payment_method_card_wallet_samsung_pay: { [key: string]: unknown } /** payment_method_card_wallet_visa_checkout */ payment_method_card_wallet_visa_checkout: { /** @description 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?: Partial | null; + billing_address?: Partial | null /** @description 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?: string | null; + email?: string | null /** @description 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?: string | null; + name?: string | null /** @description 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?: Partial | null; - }; + shipping_address?: Partial | null + } /** payment_method_details */ payment_method_details: { - ach_credit_transfer?: components["schemas"]["payment_method_details_ach_credit_transfer"]; - ach_debit?: components["schemas"]["payment_method_details_ach_debit"]; - acss_debit?: components["schemas"]["payment_method_details_acss_debit"]; - afterpay_clearpay?: components["schemas"]["payment_method_details_afterpay_clearpay"]; - alipay?: components["schemas"]["payment_flows_private_payment_methods_alipay_details"]; - au_becs_debit?: components["schemas"]["payment_method_details_au_becs_debit"]; - bacs_debit?: components["schemas"]["payment_method_details_bacs_debit"]; - bancontact?: components["schemas"]["payment_method_details_bancontact"]; - boleto?: components["schemas"]["payment_method_details_boleto"]; - card?: components["schemas"]["payment_method_details_card"]; - card_present?: components["schemas"]["payment_method_details_card_present"]; - eps?: components["schemas"]["payment_method_details_eps"]; - fpx?: components["schemas"]["payment_method_details_fpx"]; - giropay?: components["schemas"]["payment_method_details_giropay"]; - grabpay?: components["schemas"]["payment_method_details_grabpay"]; - ideal?: components["schemas"]["payment_method_details_ideal"]; - interac_present?: components["schemas"]["payment_method_details_interac_present"]; - klarna?: components["schemas"]["payment_method_details_klarna"]; - multibanco?: components["schemas"]["payment_method_details_multibanco"]; - oxxo?: components["schemas"]["payment_method_details_oxxo"]; - p24?: components["schemas"]["payment_method_details_p24"]; - sepa_debit?: components["schemas"]["payment_method_details_sepa_debit"]; - sofort?: components["schemas"]["payment_method_details_sofort"]; - stripe_account?: components["schemas"]["payment_method_details_stripe_account"]; + ach_credit_transfer?: components['schemas']['payment_method_details_ach_credit_transfer'] + ach_debit?: components['schemas']['payment_method_details_ach_debit'] + acss_debit?: components['schemas']['payment_method_details_acss_debit'] + afterpay_clearpay?: components['schemas']['payment_method_details_afterpay_clearpay'] + alipay?: components['schemas']['payment_flows_private_payment_methods_alipay_details'] + au_becs_debit?: components['schemas']['payment_method_details_au_becs_debit'] + bacs_debit?: components['schemas']['payment_method_details_bacs_debit'] + bancontact?: components['schemas']['payment_method_details_bancontact'] + boleto?: components['schemas']['payment_method_details_boleto'] + card?: components['schemas']['payment_method_details_card'] + card_present?: components['schemas']['payment_method_details_card_present'] + eps?: components['schemas']['payment_method_details_eps'] + fpx?: components['schemas']['payment_method_details_fpx'] + giropay?: components['schemas']['payment_method_details_giropay'] + grabpay?: components['schemas']['payment_method_details_grabpay'] + ideal?: components['schemas']['payment_method_details_ideal'] + interac_present?: components['schemas']['payment_method_details_interac_present'] + klarna?: components['schemas']['payment_method_details_klarna'] + multibanco?: components['schemas']['payment_method_details_multibanco'] + oxxo?: components['schemas']['payment_method_details_oxxo'] + p24?: components['schemas']['payment_method_details_p24'] + sepa_debit?: components['schemas']['payment_method_details_sepa_debit'] + sofort?: components['schemas']['payment_method_details_sofort'] + stripe_account?: components['schemas']['payment_method_details_stripe_account'] /** * @description The type of transaction-specific details of the payment method used in the payment, one of `ach_credit_transfer`, `ach_debit`, `acss_debit`, `alipay`, `au_becs_debit`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `klarna`, `multibanco`, `p24`, `sepa_debit`, `sofort`, `stripe_account`, or `wechat`. * An additional hash is included on `payment_method_details` with a name matching this value. * It contains information specific to the payment method. */ - type: string; - wechat?: components["schemas"]["payment_method_details_wechat"]; - wechat_pay?: components["schemas"]["payment_method_details_wechat_pay"]; - }; + type: string + wechat?: components['schemas']['payment_method_details_wechat'] + wechat_pay?: components['schemas']['payment_method_details_wechat_pay'] + } /** payment_method_details_ach_credit_transfer */ payment_method_details_ach_credit_transfer: { /** @description Account number to transfer funds to. */ - account_number?: string | null; + account_number?: string | null /** @description Name of the bank associated with the routing number. */ - bank_name?: string | null; + bank_name?: string | null /** @description Routing transit number for the bank account to transfer funds to. */ - routing_number?: string | null; + routing_number?: string | null /** @description SWIFT code of the bank associated with the routing number. */ - swift_code?: string | null; - }; + swift_code?: string | null + } /** payment_method_details_ach_debit */ payment_method_details_ach_debit: { /** * @description Type of entity that holds the account. This can be either `individual` or `company`. * @enum {string|null} */ - account_holder_type?: ("company" | "individual") | null; + account_holder_type?: ('company' | 'individual') | null /** @description Name of the bank associated with the bank account. */ - bank_name?: string | null; + bank_name?: string | null /** @description Two-letter ISO code representing the country the bank account is located in. */ - country?: string | null; + country?: string | null /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Last four digits of the bank account number. */ - last4?: string | null; + last4?: string | null /** @description Routing transit number of the bank account. */ - routing_number?: string | null; - }; + routing_number?: string | null + } /** payment_method_details_acss_debit */ payment_method_details_acss_debit: { /** @description Name of the bank associated with the bank account. */ - bank_name?: string | null; + bank_name?: string | null /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Institution number of the bank account */ - institution_number?: string | null; + institution_number?: string | null /** @description Last four digits of the bank account number. */ - last4?: string | null; + last4?: string | null /** @description ID of the mandate used to make this payment. */ - mandate?: string; + mandate?: string /** @description Transit number of the bank account. */ - transit_number?: string | null; - }; + transit_number?: string | null + } /** payment_method_details_afterpay_clearpay */ payment_method_details_afterpay_clearpay: { /** @description Order identifier shown to the merchant in Afterpay’s online portal. */ - reference?: string | null; - }; + reference?: string | null + } /** payment_method_details_au_becs_debit */ payment_method_details_au_becs_debit: { /** @description Bank-State-Branch number of the bank account. */ - bsb_number?: string | null; + bsb_number?: string | null /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Last four digits of the bank account number. */ - last4?: string | null; + last4?: string | null /** @description ID of the mandate used to make this payment. */ - mandate?: string; - }; + mandate?: string + } /** payment_method_details_bacs_debit */ payment_method_details_bacs_debit: { /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Last four digits of the bank account number. */ - last4?: string | null; + last4?: string | null /** @description ID of the mandate used to make this payment. */ - mandate?: string | null; + mandate?: string | null /** @description Sort code of the bank account. (e.g., `10-20-30`) */ - sort_code?: string | null; - }; + sort_code?: string | null + } /** payment_method_details_bancontact */ payment_method_details_bancontact: { /** @description Bank code of bank associated with the bank account. */ - bank_code?: string | null; + bank_code?: string | null /** @description Name of the bank associated with the bank account. */ - bank_name?: string | null; + bank_name?: string | null /** @description Bank Identifier Code of the bank associated with the bank account. */ - bic?: string | null; + bic?: string | null /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ - generated_sepa_debit?: (Partial & Partial) | null; + generated_sepa_debit?: (Partial & Partial) | null /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ - generated_sepa_debit_mandate?: (Partial & Partial) | null; + generated_sepa_debit_mandate?: (Partial & Partial) | null /** @description Last four characters of the IBAN. */ - iban_last4?: string | null; + iban_last4?: string | null /** * @description Preferred language of the Bancontact authorization page that the customer is redirected to. * Can be one of `en`, `de`, `fr`, or `nl` * @enum {string|null} */ - preferred_language?: ("de" | "en" | "fr" | "nl") | null; + preferred_language?: ('de' | 'en' | 'fr' | 'nl') | null /** * @description Owner's verified full name. Values are verified or provided by Bancontact directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - verified_name?: string | null; - }; + verified_name?: string | null + } /** payment_method_details_boleto */ payment_method_details_boleto: { /** @description The tax ID of the customer (CPF for individuals consumers or CNPJ for businesses consumers) */ - tax_id: string; - }; + tax_id: string + } /** payment_method_details_card */ payment_method_details_card: { /** @description Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ - brand?: string | null; + brand?: string | null /** @description Check results by Card networks on Card address and CVC at time of payment. */ - checks?: Partial | null; + checks?: Partial | null /** @description 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?: string | null; + country?: string | null /** @description Two-digit number representing the card's expiration month. */ - exp_month: number; + exp_month: number /** @description Four-digit number representing the card's expiration year. */ - exp_year: number; + exp_year: number /** * @description 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. * * *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.* */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ - funding?: string | null; + funding?: string | null /** * @description Installment details for this payment (Mexico only). * * For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments). */ - installments?: Partial | null; + installments?: Partial | null /** @description The last four digits of the card. */ - last4?: string | null; + last4?: string | null /** @description Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ - network?: string | null; + network?: string | null /** @description Populated if this transaction used 3D Secure authentication. */ - three_d_secure?: Partial | null; + three_d_secure?: Partial | null /** @description If this Card is part of a card wallet, this contains the details of the card wallet. */ - wallet?: Partial | null; - }; + wallet?: Partial | null + } /** payment_method_details_card_checks */ payment_method_details_card_checks: { /** @description If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ - address_line1_check?: string | null; + address_line1_check?: string | null /** @description If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ - address_postal_code_check?: string | null; + address_postal_code_check?: string | null /** @description If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ - cvc_check?: string | null; - }; + cvc_check?: string | null + } /** payment_method_details_card_installments */ payment_method_details_card_installments: { /** @description Installment plan selected for the payment. */ - plan?: Partial | null; - }; + plan?: Partial | null + } /** payment_method_details_card_installments_plan */ payment_method_details_card_installments_plan: { /** @description For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card. */ - count?: number | null; + count?: number | null /** * @description For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card. * One of `month`. * @enum {string|null} */ - interval?: "month" | null; + interval?: 'month' | null /** * @description Type of installment plan, one of `fixed_count`. * @enum {string} */ - type: "fixed_count"; - }; + type: 'fixed_count' + } /** payment_method_details_card_present */ payment_method_details_card_present: { /** @description The authorized amount */ - amount_authorized?: number | null; + amount_authorized?: number | null /** @description Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ - brand?: string | null; + brand?: string | null /** @description 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?: string | null; + cardholder_name?: string | null /** @description 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?: string | null; + country?: string | null /** @description Authorization response cryptogram. */ - emv_auth_data?: string | null; + emv_auth_data?: string | null /** @description Two-digit number representing the card's expiration month. */ - exp_month: number; + exp_month: number /** @description Four-digit number representing the card's expiration year. */ - exp_year: number; + exp_year: number /** * @description 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. * * *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.* */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ - funding?: string | null; + funding?: string | null /** @description 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?: string | null; + generated_card?: string | null /** @description The last four digits of the card. */ - last4?: string | null; + last4?: string | null /** @description Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ - network?: string | null; + network?: string | null /** @description Defines whether the authorized amount can be over-captured or not */ - overcapture_supported?: boolean | null; + overcapture_supported?: boolean | null /** * @description How card details were read in this transaction. * @enum {string|null} */ - read_method?: - | ( - | "contact_emv" - | "contactless_emv" - | "contactless_magstripe_mode" - | "magnetic_stripe_fallback" - | "magnetic_stripe_track2" - ) - | null; + read_method?: ('contact_emv' | 'contactless_emv' | 'contactless_magstripe_mode' | 'magnetic_stripe_fallback' | 'magnetic_stripe_track2') | null /** @description A collection of fields required to be displayed on receipts. Only required for EMV transactions. */ - receipt?: Partial | null; - }; + receipt?: Partial | null + } /** payment_method_details_card_present_receipt */ payment_method_details_card_present_receipt: { /** * @description The type of account being debited or credited * @enum {string} */ - account_type?: "checking" | "credit" | "prepaid" | "unknown"; + account_type?: 'checking' | 'credit' | 'prepaid' | 'unknown' /** @description EMV tag 9F26, cryptogram generated by the integrated circuit chip. */ - application_cryptogram?: string | null; + application_cryptogram?: string | null /** @description Mnenomic of the Application Identifier. */ - application_preferred_name?: string | null; + application_preferred_name?: string | null /** @description Identifier for this transaction. */ - authorization_code?: string | null; + authorization_code?: string | null /** @description EMV tag 8A. A code returned by the card issuer. */ - authorization_response_code?: string | null; + authorization_response_code?: string | null /** @description How the cardholder verified ownership of the card. */ - cardholder_verification_method?: string | null; + cardholder_verification_method?: string | null /** @description EMV tag 84. Similar to the application identifier stored on the integrated circuit chip. */ - dedicated_file_name?: string | null; + dedicated_file_name?: string | null /** @description The outcome of a series of EMV functions performed by the card reader. */ - terminal_verification_results?: string | null; + terminal_verification_results?: string | null /** @description An indication of various EMV functions performed during the transaction. */ - transaction_status_information?: string | null; - }; + transaction_status_information?: string | null + } /** payment_method_details_card_wallet */ payment_method_details_card_wallet: { - amex_express_checkout?: components["schemas"]["payment_method_details_card_wallet_amex_express_checkout"]; - apple_pay?: components["schemas"]["payment_method_details_card_wallet_apple_pay"]; + amex_express_checkout?: components['schemas']['payment_method_details_card_wallet_amex_express_checkout'] + apple_pay?: components['schemas']['payment_method_details_card_wallet_apple_pay'] /** @description (For tokenized numbers only.) The last four digits of the device account number. */ - dynamic_last4?: string | null; - google_pay?: components["schemas"]["payment_method_details_card_wallet_google_pay"]; - masterpass?: components["schemas"]["payment_method_details_card_wallet_masterpass"]; - samsung_pay?: components["schemas"]["payment_method_details_card_wallet_samsung_pay"]; + dynamic_last4?: string | null + google_pay?: components['schemas']['payment_method_details_card_wallet_google_pay'] + masterpass?: components['schemas']['payment_method_details_card_wallet_masterpass'] + samsung_pay?: components['schemas']['payment_method_details_card_wallet_samsung_pay'] /** * @description The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, or `visa_checkout`. 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. * @enum {string} */ - type: "amex_express_checkout" | "apple_pay" | "google_pay" | "masterpass" | "samsung_pay" | "visa_checkout"; - visa_checkout?: components["schemas"]["payment_method_details_card_wallet_visa_checkout"]; - }; + type: 'amex_express_checkout' | 'apple_pay' | 'google_pay' | 'masterpass' | 'samsung_pay' | 'visa_checkout' + visa_checkout?: components['schemas']['payment_method_details_card_wallet_visa_checkout'] + } /** payment_method_details_card_wallet_amex_express_checkout */ - payment_method_details_card_wallet_amex_express_checkout: { [key: string]: unknown }; + payment_method_details_card_wallet_amex_express_checkout: { [key: string]: unknown } /** payment_method_details_card_wallet_apple_pay */ - payment_method_details_card_wallet_apple_pay: { [key: string]: unknown }; + payment_method_details_card_wallet_apple_pay: { [key: string]: unknown } /** payment_method_details_card_wallet_google_pay */ - payment_method_details_card_wallet_google_pay: { [key: string]: unknown }; + payment_method_details_card_wallet_google_pay: { [key: string]: unknown } /** payment_method_details_card_wallet_masterpass */ payment_method_details_card_wallet_masterpass: { /** @description 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?: Partial | null; + billing_address?: Partial | null /** @description 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?: string | null; + email?: string | null /** @description 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?: string | null; + name?: string | null /** @description 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?: Partial | null; - }; + shipping_address?: Partial | null + } /** payment_method_details_card_wallet_samsung_pay */ - payment_method_details_card_wallet_samsung_pay: { [key: string]: unknown }; + payment_method_details_card_wallet_samsung_pay: { [key: string]: unknown } /** payment_method_details_card_wallet_visa_checkout */ payment_method_details_card_wallet_visa_checkout: { /** @description 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?: Partial | null; + billing_address?: Partial | null /** @description 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?: string | null; + email?: string | null /** @description 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?: string | null; + name?: string | null /** @description 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?: Partial | null; - }; + shipping_address?: Partial | null + } /** payment_method_details_eps */ payment_method_details_eps: { /** @@ -10069,42 +9957,42 @@ export interface components { */ bank?: | ( - | "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" - | "dolomitenbank" - | "easybank_ag" - | "erste_bank_und_sparkassen" - | "hypo_alpeadriabank_international_ag" - | "hypo_bank_burgenland_aktiengesellschaft" - | "hypo_noe_lb_fur_niederosterreich_u_wien" - | "hypo_oberosterreich_salzburg_steiermark" - | "hypo_tirol_bank_ag" - | "hypo_vorarlberg_bank_ag" - | "marchfelder_bank" - | "oberbank_ag" - | "raiffeisen_bankengruppe_osterreich" - | "schoellerbank_ag" - | "sparda_bank_wien" - | "volksbank_gruppe" - | "volkskreditbank_ag" - | "vr_bank_braunau" + | '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' + | 'dolomitenbank' + | 'easybank_ag' + | 'erste_bank_und_sparkassen' + | 'hypo_alpeadriabank_international_ag' + | 'hypo_bank_burgenland_aktiengesellschaft' + | 'hypo_noe_lb_fur_niederosterreich_u_wien' + | 'hypo_oberosterreich_salzburg_steiermark' + | 'hypo_tirol_bank_ag' + | 'hypo_vorarlberg_bank_ag' + | 'marchfelder_bank' + | 'oberbank_ag' + | 'raiffeisen_bankengruppe_osterreich' + | 'schoellerbank_ag' + | 'sparda_bank_wien' + | 'volksbank_gruppe' + | 'volkskreditbank_ag' + | 'vr_bank_braunau' ) - | null; + | null /** * @description Owner's verified full name. Values are verified or provided by EPS directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. * EPS rarely provides this information so the attribute is usually empty. */ - verified_name?: string | null; - }; + verified_name?: string | null + } /** payment_method_details_fpx */ payment_method_details_fpx: { /** @@ -10112,50 +10000,50 @@ export interface components { * @enum {string} */ bank: - | "affin_bank" - | "agrobank" - | "alliance_bank" - | "ambank" - | "bank_islam" - | "bank_muamalat" - | "bank_rakyat" - | "bsn" - | "cimb" - | "deutsche_bank" - | "hong_leong_bank" - | "hsbc" - | "kfh" - | "maybank2e" - | "maybank2u" - | "ocbc" - | "pb_enterprise" - | "public_bank" - | "rhb" - | "standard_chartered" - | "uob"; + | 'affin_bank' + | 'agrobank' + | 'alliance_bank' + | 'ambank' + | 'bank_islam' + | 'bank_muamalat' + | 'bank_rakyat' + | 'bsn' + | 'cimb' + | 'deutsche_bank' + | 'hong_leong_bank' + | 'hsbc' + | 'kfh' + | 'maybank2e' + | 'maybank2u' + | 'ocbc' + | 'pb_enterprise' + | 'public_bank' + | 'rhb' + | 'standard_chartered' + | 'uob' /** @description Unique transaction id generated by FPX for every request from the merchant */ - transaction_id?: string | null; - }; + transaction_id?: string | null + } /** payment_method_details_giropay */ payment_method_details_giropay: { /** @description Bank code of bank associated with the bank account. */ - bank_code?: string | null; + bank_code?: string | null /** @description Name of the bank associated with the bank account. */ - bank_name?: string | null; + bank_name?: string | null /** @description Bank Identifier Code of the bank associated with the bank account. */ - bic?: string | null; + bic?: string | null /** * @description Owner's verified full name. Values are verified or provided by Giropay directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. * Giropay rarely provides this information so the attribute is usually empty. */ - verified_name?: string | null; - }; + verified_name?: string | null + } /** payment_method_details_grabpay */ payment_method_details_grabpay: { /** @description Unique transaction id generated by GrabPay */ - transaction_id?: string | null; - }; + transaction_id?: string | null + } /** payment_method_details_ideal */ payment_method_details_ideal: { /** @@ -10164,149 +10052,141 @@ export interface components { */ bank?: | ( - | "abn_amro" - | "asn_bank" - | "bunq" - | "handelsbanken" - | "ing" - | "knab" - | "moneyou" - | "rabobank" - | "regiobank" - | "revolut" - | "sns_bank" - | "triodos_bank" - | "van_lanschot" + | 'abn_amro' + | 'asn_bank' + | 'bunq' + | 'handelsbanken' + | 'ing' + | 'knab' + | 'moneyou' + | 'rabobank' + | 'regiobank' + | 'revolut' + | 'sns_bank' + | 'triodos_bank' + | 'van_lanschot' ) - | null; + | null /** * @description The Bank Identifier Code of the customer's bank. * @enum {string|null} */ bic?: | ( - | "ABNANL2A" - | "ASNBNL21" - | "BUNQNL2A" - | "FVLBNL22" - | "HANDNL2A" - | "INGBNL2A" - | "KNABNL2H" - | "MOYONL21" - | "RABONL2U" - | "RBRBNL21" - | "REVOLT21" - | "SNSBNL2A" - | "TRIONL2U" + | 'ABNANL2A' + | 'ASNBNL21' + | 'BUNQNL2A' + | 'FVLBNL22' + | 'HANDNL2A' + | 'INGBNL2A' + | 'KNABNL2H' + | 'MOYONL21' + | 'RABONL2U' + | 'RBRBNL21' + | 'REVOLT21' + | 'SNSBNL2A' + | 'TRIONL2U' ) - | null; + | null /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ - generated_sepa_debit?: (Partial & Partial) | null; + generated_sepa_debit?: (Partial & Partial) | null /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ - generated_sepa_debit_mandate?: (Partial & Partial) | null; + generated_sepa_debit_mandate?: (Partial & Partial) | null /** @description Last four characters of the IBAN. */ - iban_last4?: string | null; + iban_last4?: string | null /** * @description Owner's verified full name. Values are verified or provided by iDEAL directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - verified_name?: string | null; - }; + verified_name?: string | null + } /** payment_method_details_interac_present */ payment_method_details_interac_present: { /** @description Card brand. Can be `interac`, `mastercard` or `visa`. */ - brand?: string | null; + brand?: string | null /** @description 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?: string | null; + cardholder_name?: string | null /** @description 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?: string | null; + country?: string | null /** @description Authorization response cryptogram. */ - emv_auth_data?: string | null; + emv_auth_data?: string | null /** @description Two-digit number representing the card's expiration month. */ - exp_month: number; + exp_month: number /** @description Four-digit number representing the card's expiration year. */ - exp_year: number; + exp_year: number /** * @description 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. * * *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.* */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ - funding?: string | null; + funding?: string | null /** @description 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?: string | null; + generated_card?: string | null /** @description The last four digits of the card. */ - last4?: string | null; + last4?: string | null /** @description Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ - network?: string | null; + network?: string | null /** @description EMV tag 5F2D. Preferred languages specified by the integrated circuit chip. */ - preferred_locales?: string[] | null; + preferred_locales?: string[] | null /** * @description How card details were read in this transaction. * @enum {string|null} */ - read_method?: - | ( - | "contact_emv" - | "contactless_emv" - | "contactless_magstripe_mode" - | "magnetic_stripe_fallback" - | "magnetic_stripe_track2" - ) - | null; + read_method?: ('contact_emv' | 'contactless_emv' | 'contactless_magstripe_mode' | 'magnetic_stripe_fallback' | 'magnetic_stripe_track2') | null /** @description A collection of fields required to be displayed on receipts. Only required for EMV transactions. */ - receipt?: Partial | null; - }; + receipt?: Partial | null + } /** payment_method_details_interac_present_receipt */ payment_method_details_interac_present_receipt: { /** * @description The type of account being debited or credited * @enum {string} */ - account_type?: "checking" | "savings" | "unknown"; + account_type?: 'checking' | 'savings' | 'unknown' /** @description EMV tag 9F26, cryptogram generated by the integrated circuit chip. */ - application_cryptogram?: string | null; + application_cryptogram?: string | null /** @description Mnenomic of the Application Identifier. */ - application_preferred_name?: string | null; + application_preferred_name?: string | null /** @description Identifier for this transaction. */ - authorization_code?: string | null; + authorization_code?: string | null /** @description EMV tag 8A. A code returned by the card issuer. */ - authorization_response_code?: string | null; + authorization_response_code?: string | null /** @description How the cardholder verified ownership of the card. */ - cardholder_verification_method?: string | null; + cardholder_verification_method?: string | null /** @description EMV tag 84. Similar to the application identifier stored on the integrated circuit chip. */ - dedicated_file_name?: string | null; + dedicated_file_name?: string | null /** @description The outcome of a series of EMV functions performed by the card reader. */ - terminal_verification_results?: string | null; + terminal_verification_results?: string | null /** @description An indication of various EMV functions performed during the transaction. */ - transaction_status_information?: string | null; - }; + transaction_status_information?: string | null + } /** payment_method_details_klarna */ payment_method_details_klarna: { /** * @description The Klarna payment method used for this transaction. * Can be one of `pay_later`, `pay_now`, `pay_with_financing`, or `pay_in_installments` */ - payment_method_category?: string | null; + payment_method_category?: string | null /** * @description Preferred language of the Klarna authorization page that the customer is redirected to. * Can 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`, or `en-FR` */ - preferred_locale?: string | null; - }; + preferred_locale?: string | null + } /** payment_method_details_multibanco */ payment_method_details_multibanco: { /** @description Entity number associated with this Multibanco payment. */ - entity?: string | null; + entity?: string | null /** @description Reference number associated with this Multibanco payment. */ - reference?: string | null; - }; + reference?: string | null + } /** payment_method_details_oxxo */ payment_method_details_oxxo: { /** @description OXXO reference number */ - number?: string | null; - }; + number?: string | null + } /** payment_method_details_p24 */ payment_method_details_p24: { /** @@ -10315,96 +10195,96 @@ export interface components { */ bank?: | ( - | "alior_bank" - | "bank_millennium" - | "bank_nowy_bfg_sa" - | "bank_pekao_sa" - | "banki_spbdzielcze" - | "blik" - | "bnp_paribas" - | "boz" - | "citi_handlowy" - | "credit_agricole" - | "envelobank" - | "etransfer_pocztowy24" - | "getin_bank" - | "ideabank" - | "ing" - | "inteligo" - | "mbank_mtransfer" - | "nest_przelew" - | "noble_pay" - | "pbac_z_ipko" - | "plus_bank" - | "santander_przelew24" - | "tmobile_usbugi_bankowe" - | "toyota_bank" - | "volkswagen_bank" + | 'alior_bank' + | 'bank_millennium' + | 'bank_nowy_bfg_sa' + | 'bank_pekao_sa' + | 'banki_spbdzielcze' + | 'blik' + | 'bnp_paribas' + | 'boz' + | 'citi_handlowy' + | 'credit_agricole' + | 'envelobank' + | 'etransfer_pocztowy24' + | 'getin_bank' + | 'ideabank' + | 'ing' + | 'inteligo' + | 'mbank_mtransfer' + | 'nest_przelew' + | 'noble_pay' + | 'pbac_z_ipko' + | 'plus_bank' + | 'santander_przelew24' + | 'tmobile_usbugi_bankowe' + | 'toyota_bank' + | 'volkswagen_bank' ) - | null; + | null /** @description Unique reference for this Przelewy24 payment. */ - reference?: string | null; + reference?: string | null /** * @description Owner's verified full name. Values are verified or provided by Przelewy24 directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. * Przelewy24 rarely provides this information so the attribute is usually empty. */ - verified_name?: string | null; - }; + verified_name?: string | null + } /** payment_method_details_sepa_debit */ payment_method_details_sepa_debit: { /** @description Bank code of bank associated with the bank account. */ - bank_code?: string | null; + bank_code?: string | null /** @description Branch code of bank associated with the bank account. */ - branch_code?: string | null; + branch_code?: string | null /** @description Two-letter ISO code representing the country the bank account is located in. */ - country?: string | null; + country?: string | null /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Last four characters of the IBAN. */ - last4?: string | null; + last4?: string | null /** @description ID of the mandate used to make this payment. */ - mandate?: string | null; - }; + mandate?: string | null + } /** payment_method_details_sofort */ payment_method_details_sofort: { /** @description Bank code of bank associated with the bank account. */ - bank_code?: string | null; + bank_code?: string | null /** @description Name of the bank associated with the bank account. */ - bank_name?: string | null; + bank_name?: string | null /** @description Bank Identifier Code of the bank associated with the bank account. */ - bic?: string | null; + bic?: string | null /** @description Two-letter ISO code representing the country the bank account is located in. */ - country?: string | null; + country?: string | null /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ - generated_sepa_debit?: (Partial & Partial) | null; + generated_sepa_debit?: (Partial & Partial) | null /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ - generated_sepa_debit_mandate?: (Partial & Partial) | null; + generated_sepa_debit_mandate?: (Partial & Partial) | null /** @description Last four characters of the IBAN. */ - iban_last4?: string | null; + iban_last4?: string | null /** * @description Preferred language of the SOFORT authorization page that the customer is redirected to. * Can be one of `de`, `en`, `es`, `fr`, `it`, `nl`, or `pl` * @enum {string|null} */ - preferred_language?: ("de" | "en" | "es" | "fr" | "it" | "nl" | "pl") | null; + preferred_language?: ('de' | 'en' | 'es' | 'fr' | 'it' | 'nl' | 'pl') | null /** * @description Owner's verified full name. Values are verified or provided by SOFORT directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - verified_name?: string | null; - }; + verified_name?: string | null + } /** payment_method_details_stripe_account */ - payment_method_details_stripe_account: { [key: string]: unknown }; + payment_method_details_stripe_account: { [key: string]: unknown } /** payment_method_details_wechat */ - payment_method_details_wechat: { [key: string]: unknown }; + payment_method_details_wechat: { [key: string]: unknown } /** payment_method_details_wechat_pay */ payment_method_details_wechat_pay: { /** @description Uniquely identifies this particular WeChat Pay account. You can use this attribute to check whether two WeChat accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Transaction ID of this particular WeChat Pay transaction. */ - transaction_id?: string | null; - }; + transaction_id?: string | null + } /** payment_method_eps */ payment_method_eps: { /** @@ -10413,36 +10293,36 @@ export interface components { */ bank?: | ( - | "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" - | "dolomitenbank" - | "easybank_ag" - | "erste_bank_und_sparkassen" - | "hypo_alpeadriabank_international_ag" - | "hypo_bank_burgenland_aktiengesellschaft" - | "hypo_noe_lb_fur_niederosterreich_u_wien" - | "hypo_oberosterreich_salzburg_steiermark" - | "hypo_tirol_bank_ag" - | "hypo_vorarlberg_bank_ag" - | "marchfelder_bank" - | "oberbank_ag" - | "raiffeisen_bankengruppe_osterreich" - | "schoellerbank_ag" - | "sparda_bank_wien" - | "volksbank_gruppe" - | "volkskreditbank_ag" - | "vr_bank_braunau" + | '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' + | 'dolomitenbank' + | 'easybank_ag' + | 'erste_bank_und_sparkassen' + | 'hypo_alpeadriabank_international_ag' + | 'hypo_bank_burgenland_aktiengesellschaft' + | 'hypo_noe_lb_fur_niederosterreich_u_wien' + | 'hypo_oberosterreich_salzburg_steiermark' + | 'hypo_tirol_bank_ag' + | 'hypo_vorarlberg_bank_ag' + | 'marchfelder_bank' + | 'oberbank_ag' + | 'raiffeisen_bankengruppe_osterreich' + | 'schoellerbank_ag' + | 'sparda_bank_wien' + | 'volksbank_gruppe' + | 'volkskreditbank_ag' + | 'vr_bank_braunau' ) - | null; - }; + | null + } /** payment_method_fpx */ payment_method_fpx: { /** @@ -10450,32 +10330,32 @@ export interface components { * @enum {string} */ bank: - | "affin_bank" - | "agrobank" - | "alliance_bank" - | "ambank" - | "bank_islam" - | "bank_muamalat" - | "bank_rakyat" - | "bsn" - | "cimb" - | "deutsche_bank" - | "hong_leong_bank" - | "hsbc" - | "kfh" - | "maybank2e" - | "maybank2u" - | "ocbc" - | "pb_enterprise" - | "public_bank" - | "rhb" - | "standard_chartered" - | "uob"; - }; + | 'affin_bank' + | 'agrobank' + | 'alliance_bank' + | 'ambank' + | 'bank_islam' + | 'bank_muamalat' + | 'bank_rakyat' + | 'bsn' + | 'cimb' + | 'deutsche_bank' + | 'hong_leong_bank' + | 'hsbc' + | 'kfh' + | 'maybank2e' + | 'maybank2u' + | 'ocbc' + | 'pb_enterprise' + | 'public_bank' + | 'rhb' + | 'standard_chartered' + | 'uob' + } /** payment_method_giropay */ - payment_method_giropay: { [key: string]: unknown }; + payment_method_giropay: { [key: string]: unknown } /** payment_method_grabpay */ - payment_method_grabpay: { [key: string]: unknown }; + payment_method_grabpay: { [key: string]: unknown } /** payment_method_ideal */ payment_method_ideal: { /** @@ -10484,128 +10364,128 @@ export interface components { */ bank?: | ( - | "abn_amro" - | "asn_bank" - | "bunq" - | "handelsbanken" - | "ing" - | "knab" - | "moneyou" - | "rabobank" - | "regiobank" - | "revolut" - | "sns_bank" - | "triodos_bank" - | "van_lanschot" + | 'abn_amro' + | 'asn_bank' + | 'bunq' + | 'handelsbanken' + | 'ing' + | 'knab' + | 'moneyou' + | 'rabobank' + | 'regiobank' + | 'revolut' + | 'sns_bank' + | 'triodos_bank' + | 'van_lanschot' ) - | null; + | null /** * @description The Bank Identifier Code of the customer's bank, if the bank was provided. * @enum {string|null} */ bic?: | ( - | "ABNANL2A" - | "ASNBNL21" - | "BUNQNL2A" - | "FVLBNL22" - | "HANDNL2A" - | "INGBNL2A" - | "KNABNL2H" - | "MOYONL21" - | "RABONL2U" - | "RBRBNL21" - | "REVOLT21" - | "SNSBNL2A" - | "TRIONL2U" + | 'ABNANL2A' + | 'ASNBNL21' + | 'BUNQNL2A' + | 'FVLBNL22' + | 'HANDNL2A' + | 'INGBNL2A' + | 'KNABNL2H' + | 'MOYONL21' + | 'RABONL2U' + | 'RBRBNL21' + | 'REVOLT21' + | 'SNSBNL2A' + | 'TRIONL2U' ) - | null; - }; + | null + } /** payment_method_interac_present */ - payment_method_interac_present: { [key: string]: unknown }; + payment_method_interac_present: { [key: string]: unknown } /** payment_method_klarna */ payment_method_klarna: { /** @description The customer's date of birth, if provided. */ - dob?: Partial | null; - }; + dob?: Partial | null + } /** payment_method_options_afterpay_clearpay */ payment_method_options_afterpay_clearpay: { /** * @description Order identifier shown to the merchant in Afterpay’s online portal. We recommend using a value that helps you answer any questions a customer might have about * the payment. The identifier is limited to 128 characters and may contain only letters, digits, underscores, backslashes and dashes. */ - reference?: string | null; - }; + reference?: string | null + } /** payment_method_options_alipay */ - payment_method_options_alipay: { [key: string]: unknown }; + payment_method_options_alipay: { [key: string]: unknown } /** payment_method_options_bacs_debit */ - payment_method_options_bacs_debit: { [key: string]: unknown }; + payment_method_options_bacs_debit: { [key: string]: unknown } /** payment_method_options_bancontact */ payment_method_options_bancontact: { /** * @description Preferred language of the Bancontact authorization page that the customer is redirected to. * @enum {string} */ - preferred_language: "de" | "en" | "fr" | "nl"; - }; + preferred_language: 'de' | 'en' | 'fr' | 'nl' + } /** payment_method_options_boleto */ payment_method_options_boleto: { /** @description 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: number; - }; + expires_after_days: number + } /** payment_method_options_card_installments */ payment_method_options_card_installments: { /** @description Installment plans that may be selected for this PaymentIntent. */ - available_plans?: components["schemas"]["payment_method_details_card_installments_plan"][] | null; + available_plans?: components['schemas']['payment_method_details_card_installments_plan'][] | null /** @description Whether Installments are enabled for this PaymentIntent. */ - enabled: boolean; + enabled: boolean /** @description Installment plan selected for this PaymentIntent. */ - plan?: Partial | null; - }; + plan?: Partial | null + } /** payment_method_options_card_present */ - payment_method_options_card_present: { [key: string]: unknown }; + payment_method_options_card_present: { [key: string]: unknown } /** payment_method_options_fpx */ - payment_method_options_fpx: { [key: string]: unknown }; + payment_method_options_fpx: { [key: string]: unknown } /** payment_method_options_giropay */ - payment_method_options_giropay: { [key: string]: unknown }; + payment_method_options_giropay: { [key: string]: unknown } /** payment_method_options_grabpay */ - payment_method_options_grabpay: { [key: string]: unknown }; + payment_method_options_grabpay: { [key: string]: unknown } /** payment_method_options_ideal */ - payment_method_options_ideal: { [key: string]: unknown }; + payment_method_options_ideal: { [key: string]: unknown } /** payment_method_options_interac_present */ - payment_method_options_interac_present: { [key: string]: unknown }; + payment_method_options_interac_present: { [key: string]: unknown } /** payment_method_options_klarna */ payment_method_options_klarna: { /** @description Preferred locale of the Klarna checkout page that the customer is redirected to. */ - preferred_locale?: string | null; - }; + preferred_locale?: string | null + } /** payment_method_options_oxxo */ payment_method_options_oxxo: { /** @description 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: number; - }; + expires_after_days: number + } /** payment_method_options_p24 */ - payment_method_options_p24: { [key: string]: unknown }; + payment_method_options_p24: { [key: string]: unknown } /** payment_method_options_sofort */ payment_method_options_sofort: { /** * @description Preferred language of the SOFORT authorization page that the customer is redirected to. * @enum {string|null} */ - preferred_language?: ("de" | "en" | "es" | "fr" | "it" | "nl" | "pl") | null; - }; + preferred_language?: ('de' | 'en' | 'es' | 'fr' | 'it' | 'nl' | 'pl') | null + } /** payment_method_options_wechat_pay */ payment_method_options_wechat_pay: { /** @description The app ID registered with WeChat Pay. Only required when client is ios or android. */ - app_id?: string | null; + app_id?: string | null /** * @description The client type that the end customer will pay from * @enum {string|null} */ - client?: ("android" | "ios" | "web") | null; - }; + client?: ('android' | 'ios' | 'web') | null + } /** payment_method_oxxo */ - payment_method_oxxo: { [key: string]: unknown }; + payment_method_oxxo: { [key: string]: unknown } /** payment_method_p24 */ payment_method_p24: { /** @@ -10614,89 +10494,89 @@ export interface components { */ bank?: | ( - | "alior_bank" - | "bank_millennium" - | "bank_nowy_bfg_sa" - | "bank_pekao_sa" - | "banki_spbdzielcze" - | "blik" - | "bnp_paribas" - | "boz" - | "citi_handlowy" - | "credit_agricole" - | "envelobank" - | "etransfer_pocztowy24" - | "getin_bank" - | "ideabank" - | "ing" - | "inteligo" - | "mbank_mtransfer" - | "nest_przelew" - | "noble_pay" - | "pbac_z_ipko" - | "plus_bank" - | "santander_przelew24" - | "tmobile_usbugi_bankowe" - | "toyota_bank" - | "volkswagen_bank" + | 'alior_bank' + | 'bank_millennium' + | 'bank_nowy_bfg_sa' + | 'bank_pekao_sa' + | 'banki_spbdzielcze' + | 'blik' + | 'bnp_paribas' + | 'boz' + | 'citi_handlowy' + | 'credit_agricole' + | 'envelobank' + | 'etransfer_pocztowy24' + | 'getin_bank' + | 'ideabank' + | 'ing' + | 'inteligo' + | 'mbank_mtransfer' + | 'nest_przelew' + | 'noble_pay' + | 'pbac_z_ipko' + | 'plus_bank' + | 'santander_przelew24' + | 'tmobile_usbugi_bankowe' + | 'toyota_bank' + | 'volkswagen_bank' ) - | null; - }; + | null + } /** payment_method_sepa_debit */ payment_method_sepa_debit: { /** @description Bank code of bank associated with the bank account. */ - bank_code?: string | null; + bank_code?: string | null /** @description Branch code of bank associated with the bank account. */ - branch_code?: string | null; + branch_code?: string | null /** @description Two-letter ISO code representing the country the bank account is located in. */ - country?: string | null; + country?: string | null /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Information about the object that generated this PaymentMethod. */ - generated_from?: Partial | null; + generated_from?: Partial | null /** @description Last four characters of the IBAN. */ - last4?: string | null; - }; + last4?: string | null + } /** payment_method_sofort */ payment_method_sofort: { /** @description Two-letter ISO code representing the country the bank account is located in. */ - country?: string | null; - }; + country?: string | null + } /** payment_method_wechat_pay */ - payment_method_wechat_pay: { [key: string]: unknown }; + payment_method_wechat_pay: { [key: string]: unknown } /** PaymentPagesCheckoutSessionAfterExpiration */ payment_pages_checkout_session_after_expiration: { /** @description When set, configuration used to recover the Checkout Session on expiry. */ - recovery?: Partial | null; - }; + recovery?: Partial | null + } /** PaymentPagesCheckoutSessionAfterExpirationRecovery */ payment_pages_checkout_session_after_expiration_recovery: { /** @description Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to `false` */ - allow_promotion_codes: boolean; + allow_promotion_codes: boolean /** * @description If `true`, a recovery url will be generated to recover this Checkout Session if it * expires before a transaction is completed. It will be attached to the * Checkout Session object upon expiration. */ - enabled: boolean; + enabled: boolean /** * Format: unix-time * @description The timestamp at which the recovery URL will expire. */ - expires_at?: number | null; + expires_at?: number | null /** @description URL that creates a new Checkout Session when clicked that is a copy of this expired Checkout Session */ - url?: string | null; - }; + url?: string | null + } /** PaymentPagesCheckoutSessionAutomaticTax */ payment_pages_checkout_session_automatic_tax: { /** @description Indicates whether automatic tax is enabled for the session */ - enabled: boolean; + enabled: boolean /** * @description The status of the most recent automated tax calculation for this session. * @enum {string|null} */ - status?: ("complete" | "failed" | "requires_location_inputs") | null; - }; + status?: ('complete' | 'failed' | 'requires_location_inputs') | null + } /** PaymentPagesCheckoutSessionConsent */ payment_pages_checkout_session_consent: { /** @@ -10704,8 +10584,8 @@ export interface components { * from the merchant about this Checkout Session. * @enum {string|null} */ - promotions?: ("opt_in" | "opt_out") | null; - }; + promotions?: ('opt_in' | 'opt_out') | null + } /** PaymentPagesCheckoutSessionConsentCollection */ payment_pages_checkout_session_consent_collection: { /** @@ -10714,30 +10594,30 @@ export interface components { * from the merchant depending on the customer's locale. Only available to US merchants. * @enum {string|null} */ - promotions?: "auto" | null; - }; + promotions?: 'auto' | null + } /** PaymentPagesCheckoutSessionCustomerDetails */ payment_pages_checkout_session_customer_details: { /** * @description The email associated with the Customer, if one exists, on the Checkout Session at the time of checkout 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. */ - email?: string | null; + email?: string | null /** @description The customer's phone number at the time of checkout */ - phone?: string | null; + phone?: string | null /** * @description The customer’s tax exempt status at time of checkout. * @enum {string|null} */ - tax_exempt?: ("exempt" | "none" | "reverse") | null; + tax_exempt?: ('exempt' | 'none' | 'reverse') | null /** @description The customer’s tax IDs at time of checkout. */ - tax_ids?: components["schemas"]["payment_pages_checkout_session_tax_id"][] | null; - }; + tax_ids?: components['schemas']['payment_pages_checkout_session_tax_id'][] | null + } /** PaymentPagesCheckoutSessionPhoneNumberCollection */ payment_pages_checkout_session_phone_number_collection: { /** @description Indicates whether phone number collection is enabled for the session */ - enabled: boolean; - }; + enabled: boolean + } /** PaymentPagesCheckoutSessionShippingAddressCollection */ payment_pages_checkout_session_shipping_address_collection: { /** @@ -10745,252 +10625,252 @@ export interface components { * shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI`. */ allowed_countries: ( - | "AC" - | "AD" - | "AE" - | "AF" - | "AG" - | "AI" - | "AL" - | "AM" - | "AO" - | "AQ" - | "AR" - | "AT" - | "AU" - | "AW" - | "AX" - | "AZ" - | "BA" - | "BB" - | "BD" - | "BE" - | "BF" - | "BG" - | "BH" - | "BI" - | "BJ" - | "BL" - | "BM" - | "BN" - | "BO" - | "BQ" - | "BR" - | "BS" - | "BT" - | "BV" - | "BW" - | "BY" - | "BZ" - | "CA" - | "CD" - | "CF" - | "CG" - | "CH" - | "CI" - | "CK" - | "CL" - | "CM" - | "CN" - | "CO" - | "CR" - | "CV" - | "CW" - | "CY" - | "CZ" - | "DE" - | "DJ" - | "DK" - | "DM" - | "DO" - | "DZ" - | "EC" - | "EE" - | "EG" - | "EH" - | "ER" - | "ES" - | "ET" - | "FI" - | "FJ" - | "FK" - | "FO" - | "FR" - | "GA" - | "GB" - | "GD" - | "GE" - | "GF" - | "GG" - | "GH" - | "GI" - | "GL" - | "GM" - | "GN" - | "GP" - | "GQ" - | "GR" - | "GS" - | "GT" - | "GU" - | "GW" - | "GY" - | "HK" - | "HN" - | "HR" - | "HT" - | "HU" - | "ID" - | "IE" - | "IL" - | "IM" - | "IN" - | "IO" - | "IQ" - | "IS" - | "IT" - | "JE" - | "JM" - | "JO" - | "JP" - | "KE" - | "KG" - | "KH" - | "KI" - | "KM" - | "KN" - | "KR" - | "KW" - | "KY" - | "KZ" - | "LA" - | "LB" - | "LC" - | "LI" - | "LK" - | "LR" - | "LS" - | "LT" - | "LU" - | "LV" - | "LY" - | "MA" - | "MC" - | "MD" - | "ME" - | "MF" - | "MG" - | "MK" - | "ML" - | "MM" - | "MN" - | "MO" - | "MQ" - | "MR" - | "MS" - | "MT" - | "MU" - | "MV" - | "MW" - | "MX" - | "MY" - | "MZ" - | "NA" - | "NC" - | "NE" - | "NG" - | "NI" - | "NL" - | "NO" - | "NP" - | "NR" - | "NU" - | "NZ" - | "OM" - | "PA" - | "PE" - | "PF" - | "PG" - | "PH" - | "PK" - | "PL" - | "PM" - | "PN" - | "PR" - | "PS" - | "PT" - | "PY" - | "QA" - | "RE" - | "RO" - | "RS" - | "RU" - | "RW" - | "SA" - | "SB" - | "SC" - | "SE" - | "SG" - | "SH" - | "SI" - | "SJ" - | "SK" - | "SL" - | "SM" - | "SN" - | "SO" - | "SR" - | "SS" - | "ST" - | "SV" - | "SX" - | "SZ" - | "TA" - | "TC" - | "TD" - | "TF" - | "TG" - | "TH" - | "TJ" - | "TK" - | "TL" - | "TM" - | "TN" - | "TO" - | "TR" - | "TT" - | "TV" - | "TW" - | "TZ" - | "UA" - | "UG" - | "US" - | "UY" - | "UZ" - | "VA" - | "VC" - | "VE" - | "VG" - | "VN" - | "VU" - | "WF" - | "WS" - | "XK" - | "YE" - | "YT" - | "ZA" - | "ZM" - | "ZW" - | "ZZ" - )[]; - }; + | 'AC' + | 'AD' + | 'AE' + | 'AF' + | 'AG' + | 'AI' + | 'AL' + | 'AM' + | 'AO' + | 'AQ' + | 'AR' + | 'AT' + | 'AU' + | 'AW' + | 'AX' + | 'AZ' + | 'BA' + | 'BB' + | 'BD' + | 'BE' + | 'BF' + | 'BG' + | 'BH' + | 'BI' + | 'BJ' + | 'BL' + | 'BM' + | 'BN' + | 'BO' + | 'BQ' + | 'BR' + | 'BS' + | 'BT' + | 'BV' + | 'BW' + | 'BY' + | 'BZ' + | 'CA' + | 'CD' + | 'CF' + | 'CG' + | 'CH' + | 'CI' + | 'CK' + | 'CL' + | 'CM' + | 'CN' + | 'CO' + | 'CR' + | 'CV' + | 'CW' + | 'CY' + | 'CZ' + | 'DE' + | 'DJ' + | 'DK' + | 'DM' + | 'DO' + | 'DZ' + | 'EC' + | 'EE' + | 'EG' + | 'EH' + | 'ER' + | 'ES' + | 'ET' + | 'FI' + | 'FJ' + | 'FK' + | 'FO' + | 'FR' + | 'GA' + | 'GB' + | 'GD' + | 'GE' + | 'GF' + | 'GG' + | 'GH' + | 'GI' + | 'GL' + | 'GM' + | 'GN' + | 'GP' + | 'GQ' + | 'GR' + | 'GS' + | 'GT' + | 'GU' + | 'GW' + | 'GY' + | 'HK' + | 'HN' + | 'HR' + | 'HT' + | 'HU' + | 'ID' + | 'IE' + | 'IL' + | 'IM' + | 'IN' + | 'IO' + | 'IQ' + | 'IS' + | 'IT' + | 'JE' + | 'JM' + | 'JO' + | 'JP' + | 'KE' + | 'KG' + | 'KH' + | 'KI' + | 'KM' + | 'KN' + | 'KR' + | 'KW' + | 'KY' + | 'KZ' + | 'LA' + | 'LB' + | 'LC' + | 'LI' + | 'LK' + | 'LR' + | 'LS' + | 'LT' + | 'LU' + | 'LV' + | 'LY' + | 'MA' + | 'MC' + | 'MD' + | 'ME' + | 'MF' + | 'MG' + | 'MK' + | 'ML' + | 'MM' + | 'MN' + | 'MO' + | 'MQ' + | 'MR' + | 'MS' + | 'MT' + | 'MU' + | 'MV' + | 'MW' + | 'MX' + | 'MY' + | 'MZ' + | 'NA' + | 'NC' + | 'NE' + | 'NG' + | 'NI' + | 'NL' + | 'NO' + | 'NP' + | 'NR' + | 'NU' + | 'NZ' + | 'OM' + | 'PA' + | 'PE' + | 'PF' + | 'PG' + | 'PH' + | 'PK' + | 'PL' + | 'PM' + | 'PN' + | 'PR' + | 'PS' + | 'PT' + | 'PY' + | 'QA' + | 'RE' + | 'RO' + | 'RS' + | 'RU' + | 'RW' + | 'SA' + | 'SB' + | 'SC' + | 'SE' + | 'SG' + | 'SH' + | 'SI' + | 'SJ' + | 'SK' + | 'SL' + | 'SM' + | 'SN' + | 'SO' + | 'SR' + | 'SS' + | 'ST' + | 'SV' + | 'SX' + | 'SZ' + | 'TA' + | 'TC' + | 'TD' + | 'TF' + | 'TG' + | 'TH' + | 'TJ' + | 'TK' + | 'TL' + | 'TM' + | 'TN' + | 'TO' + | 'TR' + | 'TT' + | 'TV' + | 'TW' + | 'TZ' + | 'UA' + | 'UG' + | 'US' + | 'UY' + | 'UZ' + | 'VA' + | 'VC' + | 'VE' + | 'VG' + | 'VN' + | 'VU' + | 'WF' + | 'WS' + | 'XK' + | 'YE' + | 'YT' + | 'ZA' + | 'ZM' + | 'ZW' + | 'ZZ' + )[] + } /** PaymentPagesCheckoutSessionShippingOption */ payment_pages_checkout_session_shipping_option: { /** @description A non-negative integer in cents representing how much to charge. */ - shipping_amount: number; + shipping_amount: number /** @description The shipping rate. */ - shipping_rate: Partial & Partial; - }; + shipping_rate: Partial & Partial + } /** PaymentPagesCheckoutSessionTaxID */ payment_pages_checkout_session_tax_id: { /** @@ -10998,81 +10878,81 @@ export interface components { * @enum {string} */ type: - | "ae_trn" - | "au_abn" - | "au_arn" - | "br_cnpj" - | "br_cpf" - | "ca_bn" - | "ca_gst_hst" - | "ca_pst_bc" - | "ca_pst_mb" - | "ca_pst_sk" - | "ca_qst" - | "ch_vat" - | "cl_tin" - | "es_cif" - | "eu_vat" - | "gb_vat" - | "ge_vat" - | "hk_br" - | "id_npwp" - | "il_vat" - | "in_gst" - | "is_vat" - | "jp_cn" - | "jp_rn" - | "kr_brn" - | "li_uid" - | "mx_rfc" - | "my_frp" - | "my_itn" - | "my_sst" - | "no_vat" - | "nz_gst" - | "ru_inn" - | "ru_kpp" - | "sa_vat" - | "sg_gst" - | "sg_uen" - | "th_vat" - | "tw_vat" - | "ua_vat" - | "unknown" - | "us_ein" - | "za_vat"; + | 'ae_trn' + | 'au_abn' + | 'au_arn' + | 'br_cnpj' + | 'br_cpf' + | 'ca_bn' + | 'ca_gst_hst' + | 'ca_pst_bc' + | 'ca_pst_mb' + | 'ca_pst_sk' + | 'ca_qst' + | 'ch_vat' + | 'cl_tin' + | 'es_cif' + | 'eu_vat' + | 'gb_vat' + | 'ge_vat' + | 'hk_br' + | 'id_npwp' + | 'il_vat' + | 'in_gst' + | 'is_vat' + | 'jp_cn' + | 'jp_rn' + | 'kr_brn' + | 'li_uid' + | 'mx_rfc' + | 'my_frp' + | 'my_itn' + | 'my_sst' + | 'no_vat' + | 'nz_gst' + | 'ru_inn' + | 'ru_kpp' + | 'sa_vat' + | 'sg_gst' + | 'sg_uen' + | 'th_vat' + | 'tw_vat' + | 'ua_vat' + | 'unknown' + | 'us_ein' + | 'za_vat' /** @description The value of the tax ID. */ - value?: string | null; - }; + value?: string | null + } /** PaymentPagesCheckoutSessionTaxIDCollection */ payment_pages_checkout_session_tax_id_collection: { /** @description Indicates whether tax ID collection is enabled for the session */ - enabled: boolean; - }; + enabled: boolean + } /** PaymentPagesCheckoutSessionTotalDetails */ payment_pages_checkout_session_total_details: { /** @description This is the sum of all the line item discounts. */ - amount_discount: number; + amount_discount: number /** @description This is the sum of all the line item shipping amounts. */ - amount_shipping?: number | null; + amount_shipping?: number | null /** @description This is the sum of all the line item tax amounts. */ - amount_tax: number; - breakdown?: components["schemas"]["payment_pages_checkout_session_total_details_resource_breakdown"]; - }; + amount_tax: number + breakdown?: components['schemas']['payment_pages_checkout_session_total_details_resource_breakdown'] + } /** PaymentPagesCheckoutSessionTotalDetailsResourceBreakdown */ payment_pages_checkout_session_total_details_resource_breakdown: { /** @description The aggregated line item discounts. */ - discounts: components["schemas"]["line_items_discount_amount"][]; + discounts: components['schemas']['line_items_discount_amount'][] /** @description The aggregated line item tax amounts by rate. */ - taxes: components["schemas"]["line_items_tax_amount"][]; - }; + taxes: components['schemas']['line_items_tax_amount'][] + } /** Polymorphic */ - payment_source: Partial & - Partial & - Partial & - Partial & - Partial & - Partial; + payment_source: Partial & + Partial & + Partial & + Partial & + Partial & + Partial /** * Payout * @description A `Payout` object is created when you receive funds from Stripe, or when you @@ -11086,81 +10966,81 @@ export interface components { */ payout: { /** @description Amount (in %s) to be transferred to your bank account or debit card. */ - amount: number; + amount: number /** * Format: unix-time * @description Date the payout is expected to arrive in the bank. This factors in delays like weekends or bank holidays. */ - arrival_date: number; + arrival_date: number /** @description Returns `true` if the payout was created by an [automated payout schedule](https://stripe.com/docs/payouts#payout-schedule), and `false` if it was [requested manually](https://stripe.com/docs/payouts#manual-payouts). */ - automatic: boolean; + automatic: boolean /** @description ID of the balance transaction that describes the impact of this payout on your account balance. */ - balance_transaction?: (Partial & Partial) | null; + balance_transaction?: (Partial & Partial) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description ID of the bank account or card the payout was sent to. */ destination?: | (Partial & - Partial & - Partial & - Partial & - Partial) - | null; + Partial & + Partial & + Partial & + Partial) + | null /** @description If the payout failed or was canceled, this will be the ID of the balance transaction that reversed the initial balance transaction, and puts the funds from the failed payout back in your balance. */ - failure_balance_transaction?: (Partial & Partial) | null; + failure_balance_transaction?: (Partial & Partial) | null /** @description Error code explaining reason for payout failure if available. See [Types of payout failures](https://stripe.com/docs/api#payout_failures) for a list of failure codes. */ - failure_code?: string | null; + failure_code?: string | null /** @description Message to user further explaining reason for payout failure if available. */ - failure_message?: string | null; + failure_message?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** @description The method used to send this payout, which can be `standard` or `instant`. `instant` is only supported for payouts to debit cards. (See [Instant payouts for marketplaces](https://stripe.com/blog/instant-payouts-for-marketplaces) for more information.) */ - method: string; + method: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "payout"; + object: 'payout' /** @description If the payout reverses another, this is the ID of the original payout. */ - original_payout?: (Partial & Partial) | null; + original_payout?: (Partial & Partial) | null /** @description If the payout was reversed, this is the ID of the payout that reverses this payout. */ - reversed_by?: (Partial & Partial) | null; + reversed_by?: (Partial & Partial) | null /** @description The source balance this payout came from. One of `card`, `fpx`, or `bank_account`. */ - source_type: string; + source_type: string /** @description Extra information about a payout to be displayed on the user's bank statement. */ - statement_descriptor?: string | null; + statement_descriptor?: string | null /** @description Current status of the payout: `paid`, `pending`, `in_transit`, `canceled` or `failed`. A payout is `pending` until it is submitted to the bank, when it becomes `in_transit`. The status then changes to `paid` if the transaction goes through, or to `failed` or `canceled` (within 5 business days). Some failed payouts may initially show as `paid` but then change to `failed`. */ - status: string; + status: string /** * @description Can be `bank_account` or `card`. * @enum {string} */ - type: "bank_account" | "card"; - }; + type: 'bank_account' | 'card' + } /** Period */ period: { /** * Format: unix-time * @description The end date of this usage period. All usage up to and including this point in time is included. */ - end?: number | null; + end?: number | null /** * Format: unix-time * @description The start date of this usage period. All usage after this point in time is included. */ - start?: number | null; - }; + start?: number | null + } /** * Person * @description This is an object representing a person associated with a Stripe account. @@ -11172,108 +11052,108 @@ export interface components { */ person: { /** @description The account the person is associated with. */ - account: string; - address?: components["schemas"]["address"]; - address_kana?: Partial | null; - address_kanji?: Partial | null; + account: string + address?: components['schemas']['address'] + address_kana?: Partial | null + address_kanji?: Partial | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; - dob?: components["schemas"]["legal_entity_dob"]; + created: number + dob?: components['schemas']['legal_entity_dob'] /** @description The person's email address. */ - email?: string | null; + email?: string | null /** @description The person's first name. */ - first_name?: string | null; + first_name?: string | null /** @description The Kana variation of the person's first name (Japan only). */ - first_name_kana?: string | null; + first_name_kana?: string | null /** @description The Kanji variation of the person's first name (Japan only). */ - first_name_kanji?: string | null; + first_name_kanji?: string | null /** @description A list of alternate names or aliases that the person is known by. */ - full_name_aliases?: string[]; - future_requirements?: Partial | null; + full_name_aliases?: string[] + future_requirements?: Partial | null /** @description The person's gender (International regulations require either "male" or "female"). */ - gender?: string | null; + gender?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Whether the person's `id_number` was provided. */ - id_number_provided?: boolean; + id_number_provided?: boolean /** @description The person's last name. */ - last_name?: string | null; + last_name?: string | null /** @description The Kana variation of the person's last name (Japan only). */ - last_name_kana?: string | null; + last_name_kana?: string | null /** @description The Kanji variation of the person's last name (Japan only). */ - last_name_kanji?: string | null; + last_name_kanji?: string | null /** @description The person's maiden name. */ - maiden_name?: string | null; + maiden_name?: string | null /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The country where the person is a national. */ - nationality?: string | null; + nationality?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "person"; + object: 'person' /** @description The person's phone number. */ - phone?: string | null; + phone?: string | null /** * @description 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. * @enum {string} */ - political_exposure?: "existing" | "none"; - relationship?: components["schemas"]["person_relationship"]; - requirements?: Partial | null; + political_exposure?: 'existing' | 'none' + relationship?: components['schemas']['person_relationship'] + requirements?: Partial | null /** @description Whether the last four digits of the person's Social Security number have been provided (U.S. only). */ - ssn_last_4_provided?: boolean; - verification?: components["schemas"]["legal_entity_person_verification"]; - }; + ssn_last_4_provided?: boolean + verification?: components['schemas']['legal_entity_person_verification'] + } /** PersonFutureRequirements */ person_future_requirements: { /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ - alternatives?: components["schemas"]["account_requirements_alternative"][] | null; + alternatives?: components['schemas']['account_requirements_alternative'][] | null /** @description 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: string[]; + currently_due: string[] /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ - errors: components["schemas"]["account_requirements_error"][]; + errors: components['schemas']['account_requirements_error'][] /** @description Fields that need to be collected assuming all volume 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: string[]; + eventually_due: string[] /** @description 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: string[]; + past_due: string[] /** @description Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. */ - pending_verification: string[]; - }; + pending_verification: string[] + } /** PersonRelationship */ person_relationship: { /** @description 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?: boolean | null; + director?: boolean | null /** @description Whether the person has significant responsibility to control, manage, or direct the organization. */ - executive?: boolean | null; + executive?: boolean | null /** @description Whether the person is an owner of the account’s legal entity. */ - owner?: boolean | null; + owner?: boolean | null /** @description The percent owned by the person of the account's legal entity. */ - percent_ownership?: number | null; + percent_ownership?: number | null /** @description 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?: boolean | null; + representative?: boolean | null /** @description The person's title (e.g., CEO, Support Engineer). */ - title?: string | null; - }; + title?: string | null + } /** PersonRequirements */ person_requirements: { /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ - alternatives?: components["schemas"]["account_requirements_alternative"][] | null; + alternatives?: components['schemas']['account_requirements_alternative'][] | null /** @description 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: string[]; + currently_due: string[] /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ - errors: components["schemas"]["account_requirements_error"][]; + errors: components['schemas']['account_requirements_error'][] /** @description Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `current_deadline` becomes set. */ - eventually_due: string[]; + eventually_due: string[] /** @description 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: string[]; + past_due: string[] /** @description Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. */ - pending_verification: string[]; - }; + pending_verification: string[] + } /** * Plan * @description You can now model subscriptions more flexibly using the [Prices API](https://stripe.com/docs/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration. @@ -11287,202 +11167,189 @@ export interface components { */ plan: { /** @description Whether the plan can be used for new purchases. */ - active: boolean; + active: boolean /** * @description 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`. * @enum {string|null} */ - aggregate_usage?: ("last_during_period" | "last_ever" | "max" | "sum") | null; + aggregate_usage?: ('last_during_period' | 'last_ever' | 'max' | 'sum') | null /** @description The unit amount in %s to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. */ - amount?: number | null; + amount?: number | null /** * Format: decimal * @description The unit amount in %s to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`. */ - amount_decimal?: string | null; + amount_decimal?: string | null /** * @description 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. * @enum {string} */ - billing_scheme: "per_unit" | "tiered"; + billing_scheme: 'per_unit' | 'tiered' /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`. * @enum {string} */ - interval: "day" | "month" | "week" | "year"; + interval: 'day' | 'month' | 'week' | 'year' /** @description 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: number; + interval_count: number /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** @description A brief description of the plan, hidden from customers. */ - nickname?: string | null; + nickname?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "plan"; + object: 'plan' /** @description The product whose pricing this plan determines. */ - product?: - | (Partial & - Partial & - Partial) - | null; + product?: (Partial & Partial & Partial) | null /** @description Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. */ - tiers?: components["schemas"]["plan_tier"][]; + tiers?: components['schemas']['plan_tier'][] /** * @description 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. * @enum {string|null} */ - tiers_mode?: ("graduated" | "volume") | null; + tiers_mode?: ('graduated' | 'volume') | null /** @description Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`. */ - transform_usage?: Partial | null; + transform_usage?: Partial | null /** @description 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?: number | null; + trial_period_days?: number | null /** * @description 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`. * @enum {string} */ - usage_type: "licensed" | "metered"; - }; + usage_type: 'licensed' | 'metered' + } /** PlanTier */ plan_tier: { /** @description Price for the entire tier. */ - flat_amount?: number | null; + flat_amount?: number | null /** * Format: decimal * @description Same as `flat_amount`, but contains a decimal value with at most 12 decimal places. */ - flat_amount_decimal?: string | null; + flat_amount_decimal?: string | null /** @description Per unit price for units relevant to the tier. */ - unit_amount?: number | null; + unit_amount?: number | null /** * Format: decimal * @description Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. */ - unit_amount_decimal?: string | null; + unit_amount_decimal?: string | null /** @description Up to and including to this quantity will be contained in the tier. */ - up_to?: number | null; - }; + up_to?: number | null + } /** PlatformTax */ platform_tax_fee: { /** @description The Connected account that incurred this charge. */ - account: string; + account: string /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "platform_tax_fee"; + object: 'platform_tax_fee' /** @description The payment object that caused this tax to be inflicted. */ - source_transaction: string; + source_transaction: string /** @description The type of tax (VAT). */ - type: string; - }; + type: string + } /** PortalBusinessProfile */ portal_business_profile: { /** @description The messaging shown to customers in the portal. */ - headline?: string | null; + headline?: string | null /** @description A link to the business’s publicly available privacy policy. */ - privacy_policy_url: string; + privacy_policy_url: string /** @description A link to the business’s publicly available terms of service. */ - terms_of_service_url: string; - }; + terms_of_service_url: string + } /** PortalCustomerUpdate */ portal_customer_update: { /** @description The types of customer updates that are supported. When empty, customers are not updateable. */ - allowed_updates: ("address" | "email" | "phone" | "shipping" | "tax_id")[]; + allowed_updates: ('address' | 'email' | 'phone' | 'shipping' | 'tax_id')[] /** @description Whether the feature is enabled. */ - enabled: boolean; - }; + enabled: boolean + } /** PortalFeatures */ portal_features: { - customer_update: components["schemas"]["portal_customer_update"]; - invoice_history: components["schemas"]["portal_invoice_list"]; - payment_method_update: components["schemas"]["portal_payment_method_update"]; - subscription_cancel: components["schemas"]["portal_subscription_cancel"]; - subscription_pause: components["schemas"]["portal_subscription_pause"]; - subscription_update: components["schemas"]["portal_subscription_update"]; - }; + customer_update: components['schemas']['portal_customer_update'] + invoice_history: components['schemas']['portal_invoice_list'] + payment_method_update: components['schemas']['portal_payment_method_update'] + subscription_cancel: components['schemas']['portal_subscription_cancel'] + subscription_pause: components['schemas']['portal_subscription_pause'] + subscription_update: components['schemas']['portal_subscription_update'] + } /** PortalInvoiceList */ portal_invoice_list: { /** @description Whether the feature is enabled. */ - enabled: boolean; - }; + enabled: boolean + } /** PortalPaymentMethodUpdate */ portal_payment_method_update: { /** @description Whether the feature is enabled. */ - enabled: boolean; - }; + enabled: boolean + } /** PortalSubscriptionCancel */ portal_subscription_cancel: { - cancellation_reason: components["schemas"]["portal_subscription_cancellation_reason"]; + cancellation_reason: components['schemas']['portal_subscription_cancellation_reason'] /** @description Whether the feature is enabled. */ - enabled: boolean; + enabled: boolean /** * @description Whether to cancel subscriptions immediately or at the end of the billing period. * @enum {string} */ - mode: "at_period_end" | "immediately"; + mode: 'at_period_end' | 'immediately' /** * @description Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`. * @enum {string} */ - proration_behavior: "always_invoice" | "create_prorations" | "none"; - }; + proration_behavior: 'always_invoice' | 'create_prorations' | 'none' + } /** PortalSubscriptionCancellationReason */ portal_subscription_cancellation_reason: { /** @description Whether the feature is enabled. */ - enabled: boolean; + enabled: boolean /** @description Which cancellation reasons will be given as options to the customer. */ - options: ( - | "customer_service" - | "low_quality" - | "missing_features" - | "other" - | "switched_service" - | "too_complex" - | "too_expensive" - | "unused" - )[]; - }; + options: ('customer_service' | 'low_quality' | 'missing_features' | 'other' | 'switched_service' | 'too_complex' | 'too_expensive' | 'unused')[] + } /** PortalSubscriptionPause */ portal_subscription_pause: { /** @description Whether the feature is enabled. */ - enabled: boolean; - }; + enabled: boolean + } /** PortalSubscriptionUpdate */ portal_subscription_update: { /** @description The types of subscription updates that are supported for items listed in the `products` attribute. When empty, subscriptions are not updateable. */ - default_allowed_updates: ("price" | "promotion_code" | "quantity")[]; + default_allowed_updates: ('price' | 'promotion_code' | 'quantity')[] /** @description Whether the feature is enabled. */ - enabled: boolean; + enabled: boolean /** @description The list of products that support subscription updates. */ - products?: components["schemas"]["portal_subscription_update_product"][] | null; + products?: components['schemas']['portal_subscription_update_product'][] | null /** * @description Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`. * @enum {string} */ - proration_behavior: "always_invoice" | "create_prorations" | "none"; - }; + proration_behavior: 'always_invoice' | 'create_prorations' | 'none' + } /** PortalSubscriptionUpdateProduct */ portal_subscription_update_product: { /** @description The list of price IDs which, when subscribed to, a subscription can be updated. */ - prices: string[]; + prices: string[] /** @description The product ID. */ - product: string; - }; + product: string + } /** * Price * @description Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. @@ -11494,86 +11361,84 @@ export interface components { */ price: { /** @description Whether the price can be used for new purchases. */ - active: boolean; + active: boolean /** * @description 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. * @enum {string} */ - billing_scheme: "per_unit" | "tiered"; + billing_scheme: 'per_unit' | 'tiered' /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters. */ - lookup_key?: string | null; + lookup_key?: string | null /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** @description A brief description of the price, hidden from customers. */ - nickname?: string | null; + nickname?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "price"; + object: 'price' /** @description The ID of the product this price is associated with. */ - product: Partial & - Partial & - Partial; + product: Partial & Partial & Partial /** @description The recurring components of a price such as `interval` and `usage_type`. */ - recurring?: Partial | null; + recurring?: Partial | null /** * @description 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. * @enum {string|null} */ - tax_behavior?: ("exclusive" | "inclusive" | "unspecified") | null; + tax_behavior?: ('exclusive' | 'inclusive' | 'unspecified') | null /** @description Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. */ - tiers?: components["schemas"]["price_tier"][]; + tiers?: components['schemas']['price_tier'][] /** * @description 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. * @enum {string|null} */ - tiers_mode?: ("graduated" | "volume") | null; + tiers_mode?: ('graduated' | 'volume') | null /** @description Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`. */ - transform_quantity?: Partial | null; + transform_quantity?: Partial | null /** * @description One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase. * @enum {string} */ - type: "one_time" | "recurring"; + type: 'one_time' | 'recurring' /** @description The unit amount in %s to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. */ - unit_amount?: number | null; + unit_amount?: number | null /** * Format: decimal * @description The unit amount in %s to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`. */ - unit_amount_decimal?: string | null; - }; + unit_amount_decimal?: string | null + } /** PriceTier */ price_tier: { /** @description Price for the entire tier. */ - flat_amount?: number | null; + flat_amount?: number | null /** * Format: decimal * @description Same as `flat_amount`, but contains a decimal value with at most 12 decimal places. */ - flat_amount_decimal?: string | null; + flat_amount_decimal?: string | null /** @description Per unit price for units relevant to the tier. */ - unit_amount?: number | null; + unit_amount?: number | null /** * Format: decimal * @description Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. */ - unit_amount_decimal?: string | null; + unit_amount_decimal?: string | null /** @description Up to and including to this quantity will be contained in the tier. */ - up_to?: number | null; - }; + up_to?: number | null + } /** * Product * @description Products describe the specific goods or services you offer to your customers. @@ -11587,47 +11452,47 @@ export interface components { */ product: { /** @description Whether the product is currently available for purchase. */ - active: boolean; + active: boolean /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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?: string | null; + description?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description A list of up to 8 URLs of images for this product, meant to be displayable to the customer. */ - images: string[]; + images: string[] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** @description The product's name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions. */ - name: string; + name: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "product"; + object: 'product' /** @description The dimensions of this product for shipping purposes. */ - package_dimensions?: Partial | null; + package_dimensions?: Partial | null /** @description Whether this product is shipped (i.e., physical goods). */ - shippable?: boolean | null; + shippable?: boolean | null /** @description 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. */ - statement_descriptor?: string | null; + statement_descriptor?: string | null /** @description A [tax code](https://stripe.com/docs/tax/tax-codes) ID. */ - tax_code?: (Partial & Partial) | null; + tax_code?: (Partial & Partial) | null /** @description A label that represents units of this product in Stripe and on customers’ receipts and invoices. When set, this will be included in associated invoice line item descriptions. */ - unit_label?: string | null; + unit_label?: string | null /** * Format: unix-time * @description Time at which the object was last updated. Measured in seconds since the Unix epoch. */ - updated: number; + updated: number /** @description A URL of a publicly-accessible webpage for this product. */ - url?: string | null; - }; + url?: string | null + } /** * PromotionCode * @description A Promotion Code represents a customer-redeemable code for a coupon. It can be used to @@ -11635,52 +11500,48 @@ export interface components { */ promotion_code: { /** @description Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid. */ - active: boolean; + active: boolean /** @description The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. */ - code: string; - coupon: components["schemas"]["coupon"]; + code: string + coupon: components['schemas']['coupon'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The customer that this promotion code can be used by. */ - customer?: - | (Partial & - Partial & - Partial) - | null; + customer?: (Partial & Partial & Partial) | null /** * Format: unix-time * @description Date at which the promotion code can no longer be redeemed. */ - expires_at?: number | null; + expires_at?: number | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description Maximum number of times this promotion code can be redeemed. */ - max_redemptions?: number | null; + max_redemptions?: number | null /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "promotion_code"; - restrictions: components["schemas"]["promotion_codes_resource_restrictions"]; + object: 'promotion_code' + restrictions: components['schemas']['promotion_codes_resource_restrictions'] /** @description Number of times this promotion code has been used. */ - times_redeemed: number; - }; + times_redeemed: number + } /** PromotionCodesResourceRestrictions */ promotion_codes_resource_restrictions: { /** @description A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices */ - first_time_transaction: boolean; + first_time_transaction: boolean /** @description Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work). */ - minimum_amount?: number | null; + minimum_amount?: number | null /** @description Three-letter [ISO code](https://stripe.com/docs/currencies) for minimum_amount */ - minimum_amount_currency?: string | null; - }; + minimum_amount_currency?: string | null + } /** * Quote * @description A Quote is a way to model prices that you'd like to provide to a customer. @@ -11688,222 +11549,214 @@ export interface components { */ quote: { /** @description Total before any discounts or taxes are applied. */ - amount_subtotal: number; + amount_subtotal: number /** @description Total after discounts and taxes are applied. */ - amount_total: number; + amount_total: number /** @description 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?: number | null; + application_fee_amount?: number | null /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal 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?: number | null; - automatic_tax: components["schemas"]["quotes_resource_automatic_tax"]; + application_fee_percent?: number | null + automatic_tax: components['schemas']['quotes_resource_automatic_tax'] /** * @description 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. Defaults to `charge_automatically`. * @enum {string} */ - collection_method: "charge_automatically" | "send_invoice"; - computed: components["schemas"]["quotes_resource_computed"]; + collection_method: 'charge_automatically' | 'send_invoice' + computed: components['schemas']['quotes_resource_computed'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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?: string | null; + currency?: string | null /** @description The customer which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed. */ - customer?: - | (Partial & - Partial & - Partial) - | null; + customer?: (Partial & Partial & Partial) | null /** @description The tax rates applied to this quote. */ - default_tax_rates?: (Partial & Partial)[]; + default_tax_rates?: (Partial & Partial)[] /** @description A description that will be displayed on the quote PDF. */ - description?: string | null; + description?: string | null /** @description The discounts applied to this quote. */ - discounts: (Partial & Partial)[]; + discounts: (Partial & Partial)[] /** * Format: unix-time * @description The date on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. */ - expires_at: number; + expires_at: number /** @description A footer that will be displayed on the quote PDF. */ - footer?: string | null; + footer?: string | null /** @description Details of the quote that was cloned. See the [cloning documentation](https://stripe.com/docs/quotes/clone) for more details. */ - from_quote?: Partial | null; + from_quote?: Partial | null /** @description A header that will be displayed on the quote PDF. */ - header?: string | null; + header?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The invoice that was created from this quote. */ - invoice?: - | (Partial & - Partial & - Partial) - | null; + invoice?: (Partial & Partial & Partial) | null /** @description All invoices will be billed using the specified settings. */ - invoice_settings?: Partial | null; + invoice_settings?: Partial | null /** * QuotesResourceListLineItems * @description A list of items the customer is being quoted for. */ line_items?: { /** @description Details about each object. */ - data: components["schemas"]["item"][]; + data: components['schemas']['item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** @description 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?: string | null; + number?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "quote"; + object: 'quote' /** @description 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?: (Partial & Partial) | null; + on_behalf_of?: (Partial & Partial) | null /** * @description The status of the quote. * @enum {string} */ - status: "accepted" | "canceled" | "draft" | "open"; - status_transitions: components["schemas"]["quotes_resource_status_transitions"]; + status: 'accepted' | 'canceled' | 'draft' | 'open' + status_transitions: components['schemas']['quotes_resource_status_transitions'] /** @description The subscription that was created or updated from this quote. */ - subscription?: (Partial & Partial) | null; - subscription_data: components["schemas"]["quotes_resource_subscription_data"]; + subscription?: (Partial & Partial) | null + subscription_data: components['schemas']['quotes_resource_subscription_data'] /** @description The subscription schedule that was created or updated from this quote. */ - subscription_schedule?: (Partial & Partial) | null; - total_details: components["schemas"]["quotes_resource_total_details"]; + subscription_schedule?: (Partial & Partial) | null + total_details: components['schemas']['quotes_resource_total_details'] /** @description 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?: Partial | null; - }; + transfer_data?: Partial | null + } /** QuotesResourceAutomaticTax */ quotes_resource_automatic_tax: { /** @description Automatically calculate taxes */ - enabled: boolean; + enabled: boolean /** * @description The status of the most recent automated tax calculation for this quote. * @enum {string|null} */ - status?: ("complete" | "failed" | "requires_location_inputs") | null; - }; + status?: ('complete' | 'failed' | 'requires_location_inputs') | null + } /** QuotesResourceComputed */ quotes_resource_computed: { /** @description 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?: Partial | null; - upfront: components["schemas"]["quotes_resource_upfront"]; - }; + recurring?: Partial | null + upfront: components['schemas']['quotes_resource_upfront'] + } /** QuotesResourceFromQuote */ quotes_resource_from_quote: { /** @description Whether this quote is a revision of a different quote. */ - is_revision: boolean; + is_revision: boolean /** @description The quote that was cloned. */ - quote: Partial & Partial; - }; + quote: Partial & Partial + } /** QuotesResourceRecurring */ quotes_resource_recurring: { /** @description Total before any discounts or taxes are applied. */ - amount_subtotal: number; + amount_subtotal: number /** @description Total after discounts and taxes are applied. */ - amount_total: number; + amount_total: number /** * @description The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`. * @enum {string} */ - interval: "day" | "month" | "week" | "year"; + interval: 'day' | 'month' | 'week' | 'year' /** @description 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: number; - total_details: components["schemas"]["quotes_resource_total_details"]; - }; + interval_count: number + total_details: components['schemas']['quotes_resource_total_details'] + } /** QuotesResourceStatusTransitions */ quotes_resource_status_transitions: { /** * Format: unix-time * @description The time that the quote was accepted. Measured in seconds since Unix epoch. */ - accepted_at?: number | null; + accepted_at?: number | null /** * Format: unix-time * @description The time that the quote was canceled. Measured in seconds since Unix epoch. */ - canceled_at?: number | null; + canceled_at?: number | null /** * Format: unix-time * @description The time that the quote was finalized. Measured in seconds since Unix epoch. */ - finalized_at?: number | null; - }; + finalized_at?: number | null + } /** QuotesResourceSubscriptionData */ quotes_resource_subscription_data: { /** * Format: unix-time * @description 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?: number | null; + effective_date?: number | null /** @description Integer representing the number of trial period days before the customer is charged for the first time. */ - trial_period_days?: number | null; - }; + trial_period_days?: number | null + } /** QuotesResourceTotalDetails */ quotes_resource_total_details: { /** @description This is the sum of all the line item discounts. */ - amount_discount: number; + amount_discount: number /** @description This is the sum of all the line item shipping amounts. */ - amount_shipping?: number | null; + amount_shipping?: number | null /** @description This is the sum of all the line item tax amounts. */ - amount_tax: number; - breakdown?: components["schemas"]["quotes_resource_total_details_resource_breakdown"]; - }; + amount_tax: number + breakdown?: components['schemas']['quotes_resource_total_details_resource_breakdown'] + } /** QuotesResourceTotalDetailsResourceBreakdown */ quotes_resource_total_details_resource_breakdown: { /** @description The aggregated line item discounts. */ - discounts: components["schemas"]["line_items_discount_amount"][]; + discounts: components['schemas']['line_items_discount_amount'][] /** @description The aggregated line item tax amounts by rate. */ - taxes: components["schemas"]["line_items_tax_amount"][]; - }; + taxes: components['schemas']['line_items_tax_amount'][] + } /** QuotesResourceTransferData */ quotes_resource_transfer_data: { /** @description The amount in %s that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination. */ - amount?: number | null; + amount?: number | null /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the destination account. By default, the entire amount will be transferred to the destination. */ - amount_percent?: number | null; + amount_percent?: number | null /** @description The account where funds from the payment will be transferred to upon payment success. */ - destination: Partial & Partial; - }; + destination: Partial & Partial + } /** QuotesResourceUpfront */ quotes_resource_upfront: { /** @description Total before any discounts or taxes are applied. */ - amount_subtotal: number; + amount_subtotal: number /** @description Total after discounts and taxes are applied. */ - amount_total: number; + amount_total: number /** * QuotesResourceListLineItems * @description 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?: { /** @description Details about each object. */ - data: components["schemas"]["item"][]; + data: components['schemas']['item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - total_details: components["schemas"]["quotes_resource_total_details"]; - }; + url: string + } + total_details: components['schemas']['quotes_resource_total_details'] + } /** * RadarEarlyFraudWarning * @description An early fraud warning indicates that the card issuer has notified us that a @@ -11911,142 +11764,134 @@ export interface components { * * Related guide: [Early Fraud Warnings](https://stripe.com/docs/disputes/measuring#early-fraud-warnings). */ - "radar.early_fraud_warning": { + 'radar.early_fraud_warning': { /** @description 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: boolean; + actionable: boolean /** @description ID of the charge this early fraud warning is for, optionally expanded. */ - charge: Partial & Partial; + charge: Partial & Partial /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + fraud_type: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "radar.early_fraud_warning"; + object: 'radar.early_fraud_warning' /** @description ID of the Payment Intent this early fraud warning is for, optionally expanded. */ - payment_intent?: Partial & Partial; - }; + payment_intent?: Partial & Partial + } /** * RadarListList * @description Value lists allow you to group values together which can then be referenced in rules. * * Related guide: [Default Stripe Lists](https://stripe.com/docs/radar/lists#managing-list-items). */ - "radar.value_list": { + 'radar.value_list': { /** @description The name of the value list for use in rules. */ - alias: string; + alias: string /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The name or email address of the user who created this value list. */ - created_by: string; + created_by: string /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description The type of items in the value list. One of `card_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, `case_sensitive_string`, or `customer_id`. * @enum {string} */ - item_type: - | "card_bin" - | "card_fingerprint" - | "case_sensitive_string" - | "country" - | "customer_id" - | "email" - | "ip_address" - | "string"; + item_type: 'card_bin' | 'card_fingerprint' | 'case_sensitive_string' | 'country' | 'customer_id' | 'email' | 'ip_address' | 'string' /** * RadarListListItemList * @description List of items contained within this value list. */ list_items: { /** @description Details about each object. */ - data: components["schemas"]["radar.value_list_item"][]; + data: components['schemas']['radar.value_list_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** @description The name of the value list. */ - name: string; + name: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "radar.value_list"; - }; + object: 'radar.value_list' + } /** * RadarListListItem * @description Value list items allow you to add specific values to a given Radar value list, which can then be used in rules. * * Related guide: [Managing List Items](https://stripe.com/docs/radar/lists#managing-list-items). */ - "radar.value_list_item": { + 'radar.value_list_item': { /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The name or email address of the user who added this item to the value list. */ - created_by: string; + created_by: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "radar.value_list_item"; + object: 'radar.value_list_item' /** @description The value of the item. */ - value: string; + value: string /** @description The identifier of the value list this item belongs to. */ - value_list: string; - }; + value_list: string + } /** RadarReviewResourceLocation */ radar_review_resource_location: { /** @description The city where the payment originated. */ - city?: string | null; + city?: string | null /** @description Two-letter ISO code representing the country where the payment originated. */ - country?: string | null; + country?: string | null /** @description The geographic latitude where the payment originated. */ - latitude?: number | null; + latitude?: number | null /** @description The geographic longitude where the payment originated. */ - longitude?: number | null; + longitude?: number | null /** @description The state/county/province/region where the payment originated. */ - region?: string | null; - }; + region?: string | null + } /** RadarReviewResourceSession */ radar_review_resource_session: { /** @description The browser used in this browser session (e.g., `Chrome`). */ - browser?: string | null; + browser?: string | null /** @description Information about the device used for the browser session (e.g., `Samsung SM-G930T`). */ - device?: string | null; + device?: string | null /** @description The platform for the browser session (e.g., `Macintosh`). */ - platform?: string | null; + platform?: string | null /** @description The version for the browser session (e.g., `61.0.3163.100`). */ - version?: string | null; - }; + version?: string | null + } /** * TransferRecipient * @description With `Recipient` objects, you can transfer money from your Stripe account to a @@ -12062,69 +11907,69 @@ export interface components { */ recipient: { /** @description Hash describing the current account on the recipient, if there is one. */ - active_account?: Partial | null; + active_account?: Partial | null /** CardList */ cards?: { - data: components["schemas"]["card"][]; + data: components['schemas']['card'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } | null; + url: string + } | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The default card to use for creating transfers to this recipient. */ - default_card?: (Partial & Partial) | null; + default_card?: (Partial & Partial) | null /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; - email?: string | null; + description?: string | null + email?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** @description The ID of the [Custom account](https://stripe.com/docs/connect/custom-accounts) this recipient was migrated to. If set, the recipient can no longer be updated, nor can transfers be made to it: use the Custom account instead. */ - migrated_to?: (Partial & Partial) | null; + migrated_to?: (Partial & Partial) | null /** @description Full, legal name of the recipient. */ - name?: string | null; + name?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "recipient"; - rolled_back_from?: Partial & Partial; + object: 'recipient' + rolled_back_from?: Partial & Partial /** @description Type of the recipient, one of `individual` or `corporation`. */ - type: string; - }; + type: string + } /** Recurring */ recurring: { /** * @description Specifies a usage aggregation strategy for prices 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`. * @enum {string|null} */ - aggregate_usage?: ("last_during_period" | "last_ever" | "max" | "sum") | null; + aggregate_usage?: ('last_during_period' | 'last_ever' | 'max' | 'sum') | null /** * @description The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`. * @enum {string} */ - interval: "day" | "month" | "week" | "year"; + interval: 'day' | 'month' | 'week' | 'year' /** @description 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: number; + interval_count: number /** * @description 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`. * @enum {string} */ - usage_type: "licensed" | "metered"; - }; + usage_type: 'licensed' | 'metered' + } /** * Refund * @description `Refund` objects allow you to refund a charge that has previously been created @@ -12135,49 +11980,49 @@ export interface components { */ refund: { /** @description Amount, in %s. */ - amount: number; + amount: number /** @description Balance transaction that describes the impact on your account balance. */ - balance_transaction?: (Partial & Partial) | null; + balance_transaction?: (Partial & Partial) | null /** @description ID of the charge that was refunded. */ - charge?: (Partial & Partial) | null; + charge?: (Partial & Partial) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. (Available on non-card refunds only) */ - description?: string; + description?: string /** @description If the refund failed, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction. */ - failure_balance_transaction?: Partial & Partial; + failure_balance_transaction?: Partial & Partial /** @description If the refund failed, the reason for refund failure if known. Possible values are `lost_or_stolen_card`, `expired_or_canceled_card`, or `unknown`. */ - failure_reason?: string; + failure_reason?: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "refund"; + object: 'refund' /** @description ID of the PaymentIntent that was refunded. */ - payment_intent?: (Partial & Partial) | null; + payment_intent?: (Partial & Partial) | null /** * @description Reason for the refund, either user-provided (`duplicate`, `fraudulent`, or `requested_by_customer`) or generated by Stripe internally (`expired_uncaptured_charge`). * @enum {string|null} */ - reason?: ("duplicate" | "expired_uncaptured_charge" | "fraudulent" | "requested_by_customer") | null; + reason?: ('duplicate' | 'expired_uncaptured_charge' | 'fraudulent' | 'requested_by_customer') | null /** @description This is the transaction number that appears on email receipts sent for this refund. */ - receipt_number?: string | null; + receipt_number?: string | null /** @description The transfer reversal that is associated with the refund. Only present if the charge came from another Stripe account. See the Connect documentation for details. */ - source_transfer_reversal?: (Partial & Partial) | null; + source_transfer_reversal?: (Partial & Partial) | null /** @description Status of the refund. For credit card refunds, this can be `pending`, `succeeded`, or `failed`. For other types of refunds, it can be `pending`, `succeeded`, `failed`, or `canceled`. Refer to our [refunds](https://stripe.com/docs/refunds#failed-refunds) documentation for more details. */ - status?: string | null; + status?: string | null /** @description If the accompanying transfer was reversed, the transfer reversal object. Only applicable if the charge was created using the destination parameter. */ - transfer_reversal?: (Partial & Partial) | null; - }; + transfer_reversal?: (Partial & Partial) | null + } /** * reporting_report_run * @description The Report Run object represents an instance of a report type generated with @@ -12189,47 +12034,47 @@ export interface components { * Note that certain report types can only be run based on your live-mode data (not test-mode * data), and will error when queried without a [live-mode API key](https://stripe.com/docs/keys#test-live-modes). */ - "reporting.report_run": { + 'reporting.report_run': { /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** * @description If something should go wrong during the run, a message about the failure (populated when * `status=failed`). */ - error?: string | null; + error?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description `true` if the report is run on live mode data and `false` if it is run on test mode data. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "reporting.report_run"; - parameters: components["schemas"]["financial_reporting_finance_report_run_run_parameters"]; + object: 'reporting.report_run' + parameters: components['schemas']['financial_reporting_finance_report_run_run_parameters'] /** @description The ID of the [report type](https://stripe.com/docs/reports/report-types) to run, such as `"balance.summary.1"`. */ - report_type: string; + report_type: string /** * @description The file object representing the result of the report run (populated when * `status=succeeded`). */ - result?: Partial | null; + result?: Partial | null /** * @description 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. * Rarely, we may encounter an error, at which point this will be set to `failed` and the `error` field will be populated. */ - status: string; + status: string /** * Format: unix-time * @description Timestamp at which this run successfully finished (populated when * `status=succeeded`). Measured in seconds since the Unix epoch. */ - succeeded_at?: number | null; - }; + succeeded_at?: number | null + } /** * reporting_report_type * @description The Report Type resource corresponds to a particular type of report, such as @@ -12241,53 +12086,53 @@ export interface components { * Note that certain report types can only be run based on your live-mode data (not test-mode * data), and will error when queried without a [live-mode API key](https://stripe.com/docs/keys#test-live-modes). */ - "reporting.report_type": { + 'reporting.report_type': { /** * Format: unix-time * @description Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch. */ - data_available_end: number; + data_available_end: number /** * Format: unix-time * @description Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch. */ - data_available_start: number; + data_available_start: number /** @description 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?: string[] | null; + default_columns?: string[] | null /** @description The [ID of the Report Type](https://stripe.com/docs/reporting/statements/api#available-report-types), such as `balance.summary.1`. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description Human-readable name of the Report Type */ - name: string; + name: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "reporting.report_type"; + object: 'reporting.report_type' /** * Format: unix-time * @description When this Report Type was latest updated. Measured in seconds since the Unix epoch. */ - updated: number; + updated: number /** @description 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: number; - }; + version: number + } /** ReserveTransaction */ reserve_transaction: { - amount: number; + amount: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "reserve_transaction"; - }; + object: 'reserve_transaction' + } /** * RadarReview * @description Reviews can be used to supplement automated fraud detection with human expertise. @@ -12297,55 +12142,55 @@ export interface components { */ review: { /** @description The ZIP or postal code of the card used, if applicable. */ - billing_zip?: string | null; + billing_zip?: string | null /** @description The charge associated with this review. */ - charge?: (Partial & Partial) | null; + charge?: (Partial & Partial) | null /** * @description 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`. * @enum {string|null} */ - closed_reason?: ("approved" | "disputed" | "redacted" | "refunded" | "refunded_as_fraud") | null; + closed_reason?: ('approved' | 'disputed' | 'redacted' | 'refunded' | 'refunded_as_fraud') | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The IP address where the payment originated. */ - ip_address?: string | null; + ip_address?: string | null /** @description 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?: Partial | null; + ip_address_location?: Partial | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "review"; + object: 'review' /** @description If `true`, the review needs action. */ - open: boolean; + open: boolean /** * @description The reason the review was opened. One of `rule` or `manual`. * @enum {string} */ - opened_reason: "manual" | "rule"; + opened_reason: 'manual' | 'rule' /** @description The PaymentIntent ID associated with this review, if one exists. */ - payment_intent?: Partial & Partial; + payment_intent?: Partial & Partial /** @description The reason the review is currently open or closed. One of `rule`, `manual`, `approved`, `refunded`, `refunded_as_fraud`, `disputed`, or `redacted`. */ - reason: string; + reason: string /** @description Information related to the browsing session of the user who initiated the payment. */ - session?: Partial | null; - }; + session?: Partial | null + } /** RadarRule */ rule: { /** @description The action taken on the payment. */ - action: string; + action: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The predicate to evaluate the payment against. */ - predicate: string; - }; + predicate: string + } /** * ScheduledQueryRun * @description If you have [scheduled a Sigma query](https://stripe.com/docs/sigma/scheduled-queries), you'll @@ -12358,48 +12203,48 @@ export interface components { * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** * Format: unix-time * @description When the query was run, Sigma contained a snapshot of your Stripe data at this time. */ - data_load_time: number; - error?: components["schemas"]["sigma_scheduled_query_run_error"]; + data_load_time: number + error?: components['schemas']['sigma_scheduled_query_run_error'] /** @description The file object representing the results of the query. */ - file?: Partial | null; + file?: Partial | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "scheduled_query_run"; + object: 'scheduled_query_run' /** * Format: unix-time * @description Time at which the result expires and is no longer available for download. */ - result_available_until: number; + result_available_until: number /** @description SQL for the query. */ - sql: string; + sql: string /** @description The query's execution status, which will be `completed` for successful runs, and `canceled`, `failed`, or `timed_out` otherwise. */ - status: string; + status: string /** @description Title of the query. */ - title: string; - }; + title: string + } /** SchedulesPhaseAutomaticTax */ schedules_phase_automatic_tax: { /** @description Whether Stripe automatically computes tax on invoices created during this phase. */ - enabled: boolean; - }; + enabled: boolean + } /** sepa_debit_generated_from */ sepa_debit_generated_from: { /** @description The ID of the Charge that generated this PaymentMethod, if any. */ - charge?: (Partial & Partial) | null; + charge?: (Partial & Partial) | null /** @description The ID of the SetupAttempt that generated this PaymentMethod, if any. */ - setup_attempt?: (Partial & Partial) | null; - }; + setup_attempt?: (Partial & Partial) | null + } /** * PaymentFlowsSetupIntentSetupAttempt * @description A SetupAttempt describes one attempted confirmation of a SetupIntent, @@ -12409,100 +12254,96 @@ export interface components { */ setup_attempt: { /** @description 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?: (Partial & Partial) | null; + application?: (Partial & Partial) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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?: - | (Partial & - Partial & - Partial) - | null; + customer?: (Partial & Partial & Partial) | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "setup_attempt"; + object: 'setup_attempt' /** @description 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?: (Partial & Partial) | null; + on_behalf_of?: (Partial & Partial) | null /** @description ID of the payment method used with this SetupAttempt. */ - payment_method: Partial & Partial; - payment_method_details: components["schemas"]["setup_attempt_payment_method_details"]; + payment_method: Partial & Partial + payment_method_details: components['schemas']['setup_attempt_payment_method_details'] /** @description The error encountered during this attempt to confirm the SetupIntent, if any. */ - setup_error?: Partial | null; + setup_error?: Partial | null /** @description ID of the SetupIntent that this attempt belongs to. */ - setup_intent: Partial & Partial; + setup_intent: Partial & Partial /** @description Status of this SetupAttempt, one of `requires_confirmation`, `requires_action`, `processing`, `succeeded`, `failed`, or `abandoned`. */ - status: string; + status: string /** @description 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: string; - }; + usage: string + } /** SetupAttemptPaymentMethodDetails */ setup_attempt_payment_method_details: { - acss_debit?: components["schemas"]["setup_attempt_payment_method_details_acss_debit"]; - au_becs_debit?: components["schemas"]["setup_attempt_payment_method_details_au_becs_debit"]; - bacs_debit?: components["schemas"]["setup_attempt_payment_method_details_bacs_debit"]; - bancontact?: components["schemas"]["setup_attempt_payment_method_details_bancontact"]; - boleto?: components["schemas"]["setup_attempt_payment_method_details_boleto"]; - card?: components["schemas"]["setup_attempt_payment_method_details_card"]; - card_present?: components["schemas"]["setup_attempt_payment_method_details_card_present"]; - ideal?: components["schemas"]["setup_attempt_payment_method_details_ideal"]; - sepa_debit?: components["schemas"]["setup_attempt_payment_method_details_sepa_debit"]; - sofort?: components["schemas"]["setup_attempt_payment_method_details_sofort"]; + acss_debit?: components['schemas']['setup_attempt_payment_method_details_acss_debit'] + au_becs_debit?: components['schemas']['setup_attempt_payment_method_details_au_becs_debit'] + bacs_debit?: components['schemas']['setup_attempt_payment_method_details_bacs_debit'] + bancontact?: components['schemas']['setup_attempt_payment_method_details_bancontact'] + boleto?: components['schemas']['setup_attempt_payment_method_details_boleto'] + card?: components['schemas']['setup_attempt_payment_method_details_card'] + card_present?: components['schemas']['setup_attempt_payment_method_details_card_present'] + ideal?: components['schemas']['setup_attempt_payment_method_details_ideal'] + sepa_debit?: components['schemas']['setup_attempt_payment_method_details_sepa_debit'] + sofort?: components['schemas']['setup_attempt_payment_method_details_sofort'] /** @description 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: string; - }; + type: string + } /** setup_attempt_payment_method_details_acss_debit */ - setup_attempt_payment_method_details_acss_debit: { [key: string]: unknown }; + setup_attempt_payment_method_details_acss_debit: { [key: string]: unknown } /** setup_attempt_payment_method_details_au_becs_debit */ - setup_attempt_payment_method_details_au_becs_debit: { [key: string]: unknown }; + setup_attempt_payment_method_details_au_becs_debit: { [key: string]: unknown } /** setup_attempt_payment_method_details_bacs_debit */ - setup_attempt_payment_method_details_bacs_debit: { [key: string]: unknown }; + setup_attempt_payment_method_details_bacs_debit: { [key: string]: unknown } /** setup_attempt_payment_method_details_bancontact */ setup_attempt_payment_method_details_bancontact: { /** @description Bank code of bank associated with the bank account. */ - bank_code?: string | null; + bank_code?: string | null /** @description Name of the bank associated with the bank account. */ - bank_name?: string | null; + bank_name?: string | null /** @description Bank Identifier Code of the bank associated with the bank account. */ - bic?: string | null; + bic?: string | null /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ - generated_sepa_debit?: (Partial & Partial) | null; + generated_sepa_debit?: (Partial & Partial) | null /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ - generated_sepa_debit_mandate?: (Partial & Partial) | null; + generated_sepa_debit_mandate?: (Partial & Partial) | null /** @description Last four characters of the IBAN. */ - iban_last4?: string | null; + iban_last4?: string | null /** * @description Preferred language of the Bancontact authorization page that the customer is redirected to. * Can be one of `en`, `de`, `fr`, or `nl` * @enum {string|null} */ - preferred_language?: ("de" | "en" | "fr" | "nl") | null; + preferred_language?: ('de' | 'en' | 'fr' | 'nl') | null /** * @description Owner's verified full name. Values are verified or provided by Bancontact directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - verified_name?: string | null; - }; + verified_name?: string | null + } /** setup_attempt_payment_method_details_boleto */ - setup_attempt_payment_method_details_boleto: { [key: string]: unknown }; + setup_attempt_payment_method_details_boleto: { [key: string]: unknown } /** setup_attempt_payment_method_details_card */ setup_attempt_payment_method_details_card: { /** @description Populated if this authorization used 3D Secure authentication. */ - three_d_secure?: Partial | null; - }; + three_d_secure?: Partial | null + } /** setup_attempt_payment_method_details_card_present */ setup_attempt_payment_method_details_card_present: { /** @description The ID of the Card PaymentMethod which was generated by this SetupAttempt. */ - generated_card?: (Partial & Partial) | null; - }; + generated_card?: (Partial & Partial) | null + } /** setup_attempt_payment_method_details_ideal */ setup_attempt_payment_method_details_ideal: { /** @@ -12511,82 +12352,82 @@ export interface components { */ bank?: | ( - | "abn_amro" - | "asn_bank" - | "bunq" - | "handelsbanken" - | "ing" - | "knab" - | "moneyou" - | "rabobank" - | "regiobank" - | "revolut" - | "sns_bank" - | "triodos_bank" - | "van_lanschot" + | 'abn_amro' + | 'asn_bank' + | 'bunq' + | 'handelsbanken' + | 'ing' + | 'knab' + | 'moneyou' + | 'rabobank' + | 'regiobank' + | 'revolut' + | 'sns_bank' + | 'triodos_bank' + | 'van_lanschot' ) - | null; + | null /** * @description The Bank Identifier Code of the customer's bank. * @enum {string|null} */ bic?: | ( - | "ABNANL2A" - | "ASNBNL21" - | "BUNQNL2A" - | "FVLBNL22" - | "HANDNL2A" - | "INGBNL2A" - | "KNABNL2H" - | "MOYONL21" - | "RABONL2U" - | "RBRBNL21" - | "REVOLT21" - | "SNSBNL2A" - | "TRIONL2U" + | 'ABNANL2A' + | 'ASNBNL21' + | 'BUNQNL2A' + | 'FVLBNL22' + | 'HANDNL2A' + | 'INGBNL2A' + | 'KNABNL2H' + | 'MOYONL21' + | 'RABONL2U' + | 'RBRBNL21' + | 'REVOLT21' + | 'SNSBNL2A' + | 'TRIONL2U' ) - | null; + | null /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ - generated_sepa_debit?: (Partial & Partial) | null; + generated_sepa_debit?: (Partial & Partial) | null /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ - generated_sepa_debit_mandate?: (Partial & Partial) | null; + generated_sepa_debit_mandate?: (Partial & Partial) | null /** @description Last four characters of the IBAN. */ - iban_last4?: string | null; + iban_last4?: string | null /** * @description Owner's verified full name. Values are verified or provided by iDEAL directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - verified_name?: string | null; - }; + verified_name?: string | null + } /** setup_attempt_payment_method_details_sepa_debit */ - setup_attempt_payment_method_details_sepa_debit: { [key: string]: unknown }; + setup_attempt_payment_method_details_sepa_debit: { [key: string]: unknown } /** setup_attempt_payment_method_details_sofort */ setup_attempt_payment_method_details_sofort: { /** @description Bank code of bank associated with the bank account. */ - bank_code?: string | null; + bank_code?: string | null /** @description Name of the bank associated with the bank account. */ - bank_name?: string | null; + bank_name?: string | null /** @description Bank Identifier Code of the bank associated with the bank account. */ - bic?: string | null; + bic?: string | null /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ - generated_sepa_debit?: (Partial & Partial) | null; + generated_sepa_debit?: (Partial & Partial) | null /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ - generated_sepa_debit_mandate?: (Partial & Partial) | null; + generated_sepa_debit_mandate?: (Partial & Partial) | null /** @description Last four characters of the IBAN. */ - iban_last4?: string | null; + iban_last4?: string | null /** * @description Preferred language of the Sofort authorization page that the customer is redirected to. * Can be one of `en`, `de`, `fr`, or `nl` * @enum {string|null} */ - preferred_language?: ("de" | "en" | "fr" | "nl") | null; + preferred_language?: ('de' | 'en' | 'fr' | 'nl') | null /** * @description Owner's verified full name. Values are verified or provided by Sofort directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - verified_name?: string | null; - }; + verified_name?: string | null + } /** * SetupIntent * @description A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. @@ -12614,186 +12455,176 @@ export interface components { */ setup_intent: { /** @description ID of the Connect application that created the SetupIntent. */ - application?: (Partial & Partial) | null; + application?: (Partial & Partial) | null /** * @description Reason for cancellation of this SetupIntent, one of `abandoned`, `requested_by_customer`, or `duplicate`. * @enum {string|null} */ - cancellation_reason?: ("abandoned" | "duplicate" | "requested_by_customer") | null; + cancellation_reason?: ('abandoned' | 'duplicate' | 'requested_by_customer') | null /** * @description The client secret of this SetupIntent. Used for client-side retrieval using a publishable key. * * The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, embedded in URLs, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret. */ - client_secret?: string | null; + client_secret?: string | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** * @description ID of the Customer this SetupIntent belongs to, if one exists. * * If 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. */ - customer?: - | (Partial & - Partial & - Partial) - | null; + customer?: (Partial & Partial & Partial) | null /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The error encountered in the previous SetupIntent confirmation. */ - last_setup_error?: Partial | null; + last_setup_error?: Partial | null /** @description The most recent SetupAttempt for this SetupIntent. */ - latest_attempt?: (Partial & Partial) | null; + latest_attempt?: (Partial & Partial) | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description ID of the multi use Mandate generated by the SetupIntent. */ - mandate?: (Partial & Partial) | null; + mandate?: (Partial & Partial) | null /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** @description If present, this property tells you what actions you need to take in order for your customer to continue payment setup. */ - next_action?: Partial | null; + next_action?: Partial | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "setup_intent"; + object: 'setup_intent' /** @description The account (if any) for which the setup is intended. */ - on_behalf_of?: (Partial & Partial) | null; + on_behalf_of?: (Partial & Partial) | null /** @description ID of the payment method used with this SetupIntent. */ - payment_method?: (Partial & Partial) | null; + payment_method?: (Partial & Partial) | null /** @description Payment-method-specific configuration for this SetupIntent. */ - payment_method_options?: Partial | null; + payment_method_options?: Partial | null /** @description The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. */ - payment_method_types: string[]; + payment_method_types: string[] /** @description ID of the single_use Mandate generated by the SetupIntent. */ - single_use_mandate?: (Partial & Partial) | null; + single_use_mandate?: (Partial & Partial) | null /** * @description [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`. * @enum {string} */ - status: - | "canceled" - | "processing" - | "requires_action" - | "requires_confirmation" - | "requires_payment_method" - | "succeeded"; + status: 'canceled' | 'processing' | 'requires_action' | 'requires_confirmation' | 'requires_payment_method' | 'succeeded' /** * @description Indicates how the payment method is intended to be used in the future. * * Use `on_session` if you intend to only reuse the payment method when the customer is in your checkout flow. Use `off_session` if your customer may or may not be in your checkout flow. If not provided, this value defaults to `off_session`. */ - usage: string; - }; + usage: string + } /** SetupIntentNextAction */ setup_intent_next_action: { - redirect_to_url?: components["schemas"]["setup_intent_next_action_redirect_to_url"]; + redirect_to_url?: components['schemas']['setup_intent_next_action_redirect_to_url'] /** @description 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: string; + type: string /** @description 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?: { [key: string]: unknown }; - verify_with_microdeposits?: components["schemas"]["setup_intent_next_action_verify_with_microdeposits"]; - }; + use_stripe_sdk?: { [key: string]: unknown } + verify_with_microdeposits?: components['schemas']['setup_intent_next_action_verify_with_microdeposits'] + } /** SetupIntentNextActionRedirectToUrl */ setup_intent_next_action_redirect_to_url: { /** @description If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion. */ - return_url?: string | null; + return_url?: string | null /** @description The URL you must redirect your customer to in order to authenticate. */ - url?: string | null; - }; + url?: string | null + } /** SetupIntentNextActionVerifyWithMicrodeposits */ setup_intent_next_action_verify_with_microdeposits: { /** * Format: unix-time * @description The timestamp when the microdeposits are expected to land. */ - arrival_date: number; + arrival_date: number /** @description The URL for the hosted verification page, which allows customers to verify their bank account. */ - hosted_verification_url: string; - }; + hosted_verification_url: string + } /** SetupIntentPaymentMethodOptions */ setup_intent_payment_method_options: { - acss_debit?: components["schemas"]["setup_intent_payment_method_options_acss_debit"]; - card?: components["schemas"]["setup_intent_payment_method_options_card"]; - sepa_debit?: components["schemas"]["setup_intent_payment_method_options_sepa_debit"]; - }; + acss_debit?: components['schemas']['setup_intent_payment_method_options_acss_debit'] + card?: components['schemas']['setup_intent_payment_method_options_card'] + sepa_debit?: components['schemas']['setup_intent_payment_method_options_sepa_debit'] + } /** setup_intent_payment_method_options_acss_debit */ setup_intent_payment_method_options_acss_debit: { /** * @description Currency supported by the bank account * @enum {string|null} */ - currency?: ("cad" | "usd") | null; - mandate_options?: components["schemas"]["setup_intent_payment_method_options_mandate_options_acss_debit"]; + currency?: ('cad' | 'usd') | null + mandate_options?: components['schemas']['setup_intent_payment_method_options_mandate_options_acss_debit'] /** * @description Bank account verification method. * @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; - }; + verification_method?: 'automatic' | 'instant' | 'microdeposits' + } /** setup_intent_payment_method_options_card */ setup_intent_payment_method_options_card: { /** * @description 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. Permitted values include: `automatic` or `any`. If not provided, defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. * @enum {string|null} */ - request_three_d_secure?: ("any" | "automatic" | "challenge_only") | null; - }; + request_three_d_secure?: ('any' | 'automatic' | 'challenge_only') | null + } /** setup_intent_payment_method_options_mandate_options_acss_debit */ setup_intent_payment_method_options_mandate_options_acss_debit: { /** @description A URL for custom mandate text */ - custom_mandate_url?: string; + custom_mandate_url?: string /** @description List of Stripe products where this mandate can be selected automatically. */ - default_for?: ("invoice" | "subscription")[]; + default_for?: ('invoice' | 'subscription')[] /** @description Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. */ - interval_description?: string | null; + interval_description?: string | null /** * @description Payment schedule for the mandate. * @enum {string|null} */ - payment_schedule?: ("combined" | "interval" | "sporadic") | null; + payment_schedule?: ('combined' | 'interval' | 'sporadic') | null /** * @description Transaction type of the mandate. * @enum {string|null} */ - transaction_type?: ("business" | "personal") | null; - }; + transaction_type?: ('business' | 'personal') | null + } /** setup_intent_payment_method_options_mandate_options_sepa_debit */ - setup_intent_payment_method_options_mandate_options_sepa_debit: { [key: string]: unknown }; + setup_intent_payment_method_options_mandate_options_sepa_debit: { [key: string]: unknown } /** setup_intent_payment_method_options_sepa_debit */ setup_intent_payment_method_options_sepa_debit: { - mandate_options?: components["schemas"]["setup_intent_payment_method_options_mandate_options_sepa_debit"]; - }; + mandate_options?: components['schemas']['setup_intent_payment_method_options_mandate_options_sepa_debit'] + } /** Shipping */ shipping: { - address?: components["schemas"]["address"]; + address?: components['schemas']['address'] /** @description The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. */ - carrier?: string | null; + carrier?: string | null /** @description Recipient name. */ - name?: string | null; + name?: string | null /** @description Recipient phone (including extension). */ - phone?: string | null; + phone?: string | null /** @description 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?: string | null; - }; + tracking_number?: string | null + } /** ShippingMethod */ shipping_method: { /** @description 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 line item. */ - amount: number; + amount: number /** @description 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: string; + currency: string /** @description The estimated delivery date for the given shipping method. Can be either a specific date or a range. */ - delivery_estimate?: Partial | null; + delivery_estimate?: Partial | null /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description: string; + description: string /** @description Unique identifier for the object. */ - id: string; - }; + id: string + } /** * ShippingRate * @description Shipping rates describe the price of shipping presented to your customers and can be @@ -12801,70 +12632,70 @@ export interface components { */ shipping_rate: { /** @description Whether the shipping rate can be used for new purchases. Defaults to `true`. */ - active: boolean; + active: boolean /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions. */ - delivery_estimate?: Partial | null; + delivery_estimate?: Partial | null /** @description The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions. */ - display_name?: string | null; - fixed_amount?: components["schemas"]["shipping_rate_fixed_amount"]; + display_name?: string | null + fixed_amount?: components['schemas']['shipping_rate_fixed_amount'] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "shipping_rate"; + object: 'shipping_rate' /** * @description Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. * @enum {string|null} */ - tax_behavior?: ("exclusive" | "inclusive" | "unspecified") | null; + tax_behavior?: ('exclusive' | 'inclusive' | 'unspecified') | null /** @description A [tax code](https://stripe.com/docs/tax/tax-codes) ID. The Shipping tax code is `txcd_92010001`. */ - tax_code?: (Partial & Partial) | null; + tax_code?: (Partial & Partial) | null /** * @description The type of calculation to use on the shipping rate. Can only be `fixed_amount` for now. * @enum {string} */ - type: "fixed_amount"; - }; + type: 'fixed_amount' + } /** ShippingRateDeliveryEstimate */ shipping_rate_delivery_estimate: { /** @description The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite. */ - maximum?: Partial | null; + maximum?: Partial | null /** @description The lower bound of the estimated range. If empty, represents no lower bound. */ - minimum?: Partial | null; - }; + minimum?: Partial | null + } /** ShippingRateDeliveryEstimateBound */ shipping_rate_delivery_estimate_bound: { /** * @description A unit of time. * @enum {string} */ - unit: "business_day" | "day" | "hour" | "month" | "week"; + unit: 'business_day' | 'day' | 'hour' | 'month' | 'week' /** @description Must be greater than 0. */ - value: number; - }; + value: number + } /** ShippingRateFixedAmount */ shipping_rate_fixed_amount: { /** @description A non-negative integer in cents representing how much to charge. */ - amount: number; + amount: number /** @description 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: string; - }; + currency: string + } /** SigmaScheduledQueryRunError */ sigma_scheduled_query_run_error: { /** @description Information about the run failure. */ - message: string; - }; + message: string + } /** * Sku * @description Stores representations of [stock keeping units](http://en.wikipedia.org/wiki/Stock_keeping_unit). @@ -12878,51 +12709,51 @@ export interface components { */ sku: { /** @description Whether the SKU is available for purchase. */ - active: boolean; + active: boolean /** @description A dictionary of attributes and values for the attributes defined by the product. If, for example, a product's attributes are `["size", "gender"]`, a valid SKU has the following dictionary of attributes: `{"size": "Medium", "gender": "Unisex"}`. */ - attributes: { [key: string]: string }; + attributes: { [key: string]: string } /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The URL of an image for this SKU, meant to be displayable to the customer. */ - image?: string | null; - inventory: components["schemas"]["sku_inventory"]; + image?: string | null + inventory: components['schemas']['sku_inventory'] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "sku"; + object: 'sku' /** @description The dimensions of this SKU for shipping purposes. */ - package_dimensions?: Partial | null; + package_dimensions?: Partial | null /** @description The cost of the item as a positive integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a zero-decimal currency). */ - price: number; + price: number /** @description The ID of the product this SKU is associated with. The product must be currently active. */ - product: Partial & Partial; + product: Partial & Partial /** * Format: unix-time * @description Time at which the object was last updated. Measured in seconds since the Unix epoch. */ - updated: number; - }; + updated: number + } /** SKUInventory */ sku_inventory: { /** @description The count of inventory available. Will be present if and only if `type` is `finite`. */ - quantity?: number | null; + quantity?: number | null /** @description Inventory type. Possible values are `finite`, `bucket` (not quantified), and `infinite`. */ - type: string; + type: string /** @description An indicator of the inventory available. Possible values are `in_stock`, `limited`, and `out_of_stock`. Will be present if and only if `type` is `bucket`. */ - value?: string | null; - }; + value?: string | null + } /** * Source * @description `Source` objects allow you to accept a variety of payment methods. They @@ -12933,93 +12764,93 @@ export interface components { * Related guides: [Sources API](https://stripe.com/docs/sources) and [Sources & Customers](https://stripe.com/docs/sources/customers). */ source: { - ach_credit_transfer?: components["schemas"]["source_type_ach_credit_transfer"]; - ach_debit?: components["schemas"]["source_type_ach_debit"]; - acss_debit?: components["schemas"]["source_type_acss_debit"]; - alipay?: components["schemas"]["source_type_alipay"]; + ach_credit_transfer?: components['schemas']['source_type_ach_credit_transfer'] + ach_debit?: components['schemas']['source_type_ach_debit'] + acss_debit?: components['schemas']['source_type_acss_debit'] + alipay?: components['schemas']['source_type_alipay'] /** @description 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?: number | null; - au_becs_debit?: components["schemas"]["source_type_au_becs_debit"]; - bancontact?: components["schemas"]["source_type_bancontact"]; - card?: components["schemas"]["source_type_card"]; - card_present?: components["schemas"]["source_type_card_present"]; + amount?: number | null + au_becs_debit?: components['schemas']['source_type_au_becs_debit'] + bancontact?: components['schemas']['source_type_bancontact'] + card?: components['schemas']['source_type_card'] + card_present?: components['schemas']['source_type_card_present'] /** @description The client secret of the source. Used for client-side retrieval using a publishable key. */ - client_secret: string; - code_verification?: components["schemas"]["source_code_verification_flow"]; + client_secret: string + code_verification?: components['schemas']['source_code_verification_flow'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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?: string | null; + currency?: string | null /** @description 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?: string; - eps?: components["schemas"]["source_type_eps"]; + customer?: string + eps?: components['schemas']['source_type_eps'] /** @description The authentication `flow` of the source. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`. */ - flow: string; - giropay?: components["schemas"]["source_type_giropay"]; + flow: string + giropay?: components['schemas']['source_type_giropay'] /** @description Unique identifier for the object. */ - id: string; - ideal?: components["schemas"]["source_type_ideal"]; - klarna?: components["schemas"]["source_type_klarna"]; + id: string + ideal?: components['schemas']['source_type_ideal'] + klarna?: components['schemas']['source_type_klarna'] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; - multibanco?: components["schemas"]["source_type_multibanco"]; + metadata?: { [key: string]: string } | null + multibanco?: components['schemas']['source_type_multibanco'] /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "source"; + object: 'source' /** @description Information about the owner of the payment instrument that may be used or required by particular source types. */ - owner?: Partial | null; - p24?: components["schemas"]["source_type_p24"]; - receiver?: components["schemas"]["source_receiver_flow"]; - redirect?: components["schemas"]["source_redirect_flow"]; - sepa_debit?: components["schemas"]["source_type_sepa_debit"]; - sofort?: components["schemas"]["source_type_sofort"]; - source_order?: components["schemas"]["source_order"]; + owner?: Partial | null + p24?: components['schemas']['source_type_p24'] + receiver?: components['schemas']['source_receiver_flow'] + redirect?: components['schemas']['source_redirect_flow'] + sepa_debit?: components['schemas']['source_type_sepa_debit'] + sofort?: components['schemas']['source_type_sofort'] + source_order?: components['schemas']['source_order'] /** @description Extra information about a source. This will appear on your customer's statement every time you charge the source. */ - statement_descriptor?: string | null; + statement_descriptor?: string | null /** @description The status of the source, one of `canceled`, `chargeable`, `consumed`, `failed`, or `pending`. Only `chargeable` sources can be used to create a charge. */ - status: string; - three_d_secure?: components["schemas"]["source_type_three_d_secure"]; + status: string + three_d_secure?: components['schemas']['source_type_three_d_secure'] /** * @description 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. * @enum {string} */ type: - | "ach_credit_transfer" - | "ach_debit" - | "acss_debit" - | "alipay" - | "au_becs_debit" - | "bancontact" - | "card" - | "card_present" - | "eps" - | "giropay" - | "ideal" - | "klarna" - | "multibanco" - | "p24" - | "sepa_debit" - | "sofort" - | "three_d_secure" - | "wechat"; + | 'ach_credit_transfer' + | 'ach_debit' + | 'acss_debit' + | 'alipay' + | 'au_becs_debit' + | 'bancontact' + | 'card' + | 'card_present' + | 'eps' + | 'giropay' + | 'ideal' + | 'klarna' + | 'multibanco' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'three_d_secure' + | 'wechat' /** @description 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?: string | null; - wechat?: components["schemas"]["source_type_wechat"]; - }; + usage?: string | null + wechat?: components['schemas']['source_type_wechat'] + } /** SourceCodeVerificationFlow */ source_code_verification_flow: { /** @description The number of attempts remaining to authenticate the source object with a verification code. */ - attempts_remaining: number; + attempts_remaining: number /** @description 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: string; - }; + status: string + } /** * SourceMandateNotification * @description Source mandate notifications should be created when a notification related to @@ -13027,124 +12858,124 @@ export interface components { * deliver an email to the customer. */ source_mandate_notification: { - acss_debit?: components["schemas"]["source_mandate_notification_acss_debit_data"]; + acss_debit?: components['schemas']['source_mandate_notification_acss_debit_data'] /** @description 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?: number | null; - bacs_debit?: components["schemas"]["source_mandate_notification_bacs_debit_data"]; + amount?: number | null + bacs_debit?: components['schemas']['source_mandate_notification_bacs_debit_data'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "source_mandate_notification"; + object: 'source_mandate_notification' /** @description The reason of the mandate notification. Valid reasons are `mandate_confirmed` or `debit_initiated`. */ - reason: string; - sepa_debit?: components["schemas"]["source_mandate_notification_sepa_debit_data"]; - source: components["schemas"]["source"]; + reason: string + sepa_debit?: components['schemas']['source_mandate_notification_sepa_debit_data'] + source: components['schemas']['source'] /** @description The status of the mandate notification. Valid statuses are `pending` or `submitted`. */ - status: string; + status: string /** @description 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: string; - }; + type: string + } /** SourceMandateNotificationAcssDebitData */ source_mandate_notification_acss_debit_data: { /** @description The statement descriptor associate with the debit. */ - statement_descriptor?: string; - }; + statement_descriptor?: string + } /** SourceMandateNotificationBacsDebitData */ source_mandate_notification_bacs_debit_data: { /** @description Last 4 digits of the account number associated with the debit. */ - last4?: string; - }; + last4?: string + } /** SourceMandateNotificationSepaDebitData */ source_mandate_notification_sepa_debit_data: { /** @description SEPA creditor ID. */ - creditor_identifier?: string; + creditor_identifier?: string /** @description Last 4 digits of the account number associated with the debit. */ - last4?: string; + last4?: string /** @description Mandate reference associated with the debit. */ - mandate_reference?: string; - }; + mandate_reference?: string + } /** SourceOrder */ source_order: { /** @description 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: number; + amount: number /** @description 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: string; + currency: string /** @description The email address of the customer placing the order. */ - email?: string; + email?: string /** @description List of items constituting the order. */ - items?: components["schemas"]["source_order_item"][] | null; - shipping?: components["schemas"]["shipping"]; - }; + items?: components['schemas']['source_order_item'][] | null + shipping?: components['schemas']['shipping'] + } /** SourceOrderItem */ source_order_item: { /** @description The amount (price) for this order item. */ - amount?: number | null; + amount?: number | null /** @description This currency of this order item. Required when `amount` is present. */ - currency?: string | null; + currency?: string | null /** @description Human-readable description for this order item. */ - description?: string | null; + description?: string | null /** @description The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a SKU). */ - parent?: string | null; + parent?: string | null /** @description The quantity of this order item. When type is `sku`, this is the number of instances of the SKU to be ordered. */ - quantity?: number; + quantity?: number /** @description The type of this order item. Must be `sku`, `tax`, or `shipping`. */ - type?: string | null; - }; + type?: string | null + } /** SourceOwner */ source_owner: { /** @description Owner's address. */ - address?: Partial | null; + address?: Partial | null /** @description Owner's email address. */ - email?: string | null; + email?: string | null /** @description Owner's full name. */ - name?: string | null; + name?: string | null /** @description Owner's phone number (including extension). */ - phone?: string | null; + phone?: string | null /** @description 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?: Partial | null; + verified_address?: Partial | null /** @description 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?: string | null; + verified_email?: string | null /** @description 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?: string | null; + verified_name?: string | null /** @description 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?: string | null; - }; + verified_phone?: string | null + } /** SourceReceiverFlow */ source_receiver_flow: { /** @description The address of the receiver source. This is the value that should be communicated to the customer to send their funds to. */ - address?: string | null; + address?: string | null /** @description 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: number; + amount_charged: number /** @description 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: number; + amount_received: number /** @description The total amount that was returned to the customer. The amount returned is expressed in the source's currency. */ - amount_returned: number; + amount_returned: number /** @description Type of refund attribute method, one of `email`, `manual`, or `none`. */ - refund_attributes_method: string; + refund_attributes_method: string /** @description Type of refund attribute status, one of `missing`, `requested`, or `available`. */ - refund_attributes_status: string; - }; + refund_attributes_status: string + } /** SourceRedirectFlow */ source_redirect_flow: { /** @description 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?: string | null; + failure_reason?: string | null /** @description The URL you provide to redirect the customer to after they authenticated their payment. */ - return_url: string; + return_url: string /** @description 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: string; + status: string /** @description The URL provided to you to redirect a customer to as part of a `redirect` authentication flow. */ - url: string; - }; + url: string + } /** * SourceTransaction * @description Some payment methods have no required amount that a customer must send. @@ -13153,325 +12984,325 @@ export interface components { * transactions. */ source_transaction: { - ach_credit_transfer?: components["schemas"]["source_transaction_ach_credit_transfer_data"]; + ach_credit_transfer?: components['schemas']['source_transaction_ach_credit_transfer_data'] /** @description 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: number; - chf_credit_transfer?: components["schemas"]["source_transaction_chf_credit_transfer_data"]; + amount: number + chf_credit_transfer?: components['schemas']['source_transaction_chf_credit_transfer_data'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; - gbp_credit_transfer?: components["schemas"]["source_transaction_gbp_credit_transfer_data"]; + currency: string + gbp_credit_transfer?: components['schemas']['source_transaction_gbp_credit_transfer_data'] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "source_transaction"; - paper_check?: components["schemas"]["source_transaction_paper_check_data"]; - sepa_credit_transfer?: components["schemas"]["source_transaction_sepa_credit_transfer_data"]; + object: 'source_transaction' + paper_check?: components['schemas']['source_transaction_paper_check_data'] + sepa_credit_transfer?: components['schemas']['source_transaction_sepa_credit_transfer_data'] /** @description The ID of the source this transaction is attached to. */ - source: string; + source: string /** @description The status of the transaction, one of `succeeded`, `pending`, or `failed`. */ - status: string; + status: string /** * @description The type of source this transaction is attached to. * @enum {string} */ type: - | "ach_credit_transfer" - | "ach_debit" - | "alipay" - | "bancontact" - | "card" - | "card_present" - | "eps" - | "giropay" - | "ideal" - | "klarna" - | "multibanco" - | "p24" - | "sepa_debit" - | "sofort" - | "three_d_secure" - | "wechat"; - }; + | 'ach_credit_transfer' + | 'ach_debit' + | 'alipay' + | 'bancontact' + | 'card' + | 'card_present' + | 'eps' + | 'giropay' + | 'ideal' + | 'klarna' + | 'multibanco' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'three_d_secure' + | 'wechat' + } /** SourceTransactionAchCreditTransferData */ source_transaction_ach_credit_transfer_data: { /** @description Customer data associated with the transfer. */ - customer_data?: string; + customer_data?: string /** @description Bank account fingerprint associated with the transfer. */ - fingerprint?: string; + fingerprint?: string /** @description Last 4 digits of the account number associated with the transfer. */ - last4?: string; + last4?: string /** @description Routing number associated with the transfer. */ - routing_number?: string; - }; + routing_number?: string + } /** SourceTransactionChfCreditTransferData */ source_transaction_chf_credit_transfer_data: { /** @description Reference associated with the transfer. */ - reference?: string; + reference?: string /** @description Sender's country address. */ - sender_address_country?: string; + sender_address_country?: string /** @description Sender's line 1 address. */ - sender_address_line1?: string; + sender_address_line1?: string /** @description Sender's bank account IBAN. */ - sender_iban?: string; + sender_iban?: string /** @description Sender's name. */ - sender_name?: string; - }; + sender_name?: string + } /** SourceTransactionGbpCreditTransferData */ source_transaction_gbp_credit_transfer_data: { /** @description Bank account fingerprint associated with the Stripe owned bank account receiving the transfer. */ - fingerprint?: string; + fingerprint?: string /** @description 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?: string; + funding_method?: string /** @description Last 4 digits of sender account number associated with the transfer. */ - last4?: string; + last4?: string /** @description Sender entered arbitrary information about the transfer. */ - reference?: string; + reference?: string /** @description Sender account number associated with the transfer. */ - sender_account_number?: string; + sender_account_number?: string /** @description Sender name associated with the transfer. */ - sender_name?: string; + sender_name?: string /** @description Sender sort code associated with the transfer. */ - sender_sort_code?: string; - }; + sender_sort_code?: string + } /** SourceTransactionPaperCheckData */ source_transaction_paper_check_data: { /** @description Time at which the deposited funds will be available for use. Measured in seconds since the Unix epoch. */ - available_at?: string; + available_at?: string /** @description Comma-separated list of invoice IDs associated with the paper check. */ - invoices?: string; - }; + invoices?: string + } /** SourceTransactionSepaCreditTransferData */ source_transaction_sepa_credit_transfer_data: { /** @description Reference associated with the transfer. */ - reference?: string; + reference?: string /** @description Sender's bank account IBAN. */ - sender_iban?: string; + sender_iban?: string /** @description Sender's name. */ - sender_name?: string; - }; + sender_name?: string + } source_type_ach_credit_transfer: { - account_number?: string | null; - bank_name?: string | null; - fingerprint?: string | null; - refund_account_holder_name?: string | null; - refund_account_holder_type?: string | null; - refund_routing_number?: string | null; - routing_number?: string | null; - swift_code?: string | null; - }; + account_number?: string | null + bank_name?: string | null + fingerprint?: string | null + refund_account_holder_name?: string | null + refund_account_holder_type?: string | null + refund_routing_number?: string | null + routing_number?: string | null + swift_code?: string | null + } source_type_ach_debit: { - bank_name?: string | null; - country?: string | null; - fingerprint?: string | null; - last4?: string | null; - routing_number?: string | null; - type?: string | null; - }; + bank_name?: string | null + country?: string | null + fingerprint?: string | null + last4?: string | null + routing_number?: string | null + type?: string | null + } source_type_acss_debit: { - bank_address_city?: string | null; - bank_address_line_1?: string | null; - bank_address_line_2?: string | null; - bank_address_postal_code?: string | null; - bank_name?: string | null; - category?: string | null; - country?: string | null; - fingerprint?: string | null; - last4?: string | null; - routing_number?: string | null; - }; + bank_address_city?: string | null + bank_address_line_1?: string | null + bank_address_line_2?: string | null + bank_address_postal_code?: string | null + bank_name?: string | null + category?: string | null + country?: string | null + fingerprint?: string | null + last4?: string | null + routing_number?: string | null + } source_type_alipay: { - data_string?: string | null; - native_url?: string | null; - statement_descriptor?: string | null; - }; + data_string?: string | null + native_url?: string | null + statement_descriptor?: string | null + } source_type_au_becs_debit: { - bsb_number?: string | null; - fingerprint?: string | null; - last4?: string | null; - }; + bsb_number?: string | null + fingerprint?: string | null + last4?: string | null + } source_type_bancontact: { - bank_code?: string | null; - bank_name?: string | null; - bic?: string | null; - iban_last4?: string | null; - preferred_language?: string | null; - statement_descriptor?: string | null; - }; + bank_code?: string | null + bank_name?: string | null + bic?: string | null + iban_last4?: string | null + preferred_language?: string | null + statement_descriptor?: string | null + } source_type_card: { - address_line1_check?: string | null; - address_zip_check?: string | null; - brand?: string | null; - country?: string | null; - cvc_check?: string | null; - dynamic_last4?: string | null; - exp_month?: number | null; - exp_year?: number | null; - fingerprint?: string; - funding?: string | null; - last4?: string | null; - name?: string | null; - three_d_secure?: string; - tokenization_method?: string | null; - }; + address_line1_check?: string | null + address_zip_check?: string | null + brand?: string | null + country?: string | null + cvc_check?: string | null + dynamic_last4?: string | null + exp_month?: number | null + exp_year?: number | null + fingerprint?: string + funding?: string | null + last4?: string | null + name?: string | null + three_d_secure?: string + tokenization_method?: string | null + } source_type_card_present: { - application_cryptogram?: string; - application_preferred_name?: string; - authorization_code?: string | null; - authorization_response_code?: string; - brand?: string | null; - country?: string | null; - cvm_type?: string; - data_type?: string | null; - dedicated_file_name?: string; - emv_auth_data?: string; - evidence_customer_signature?: string | null; - evidence_transaction_certificate?: string | null; - exp_month?: number | null; - exp_year?: number | null; - fingerprint?: string; - funding?: string | null; - last4?: string | null; - pos_device_id?: string | null; - pos_entry_mode?: string; - read_method?: string | null; - reader?: string | null; - terminal_verification_results?: string; - transaction_status_information?: string; - }; + application_cryptogram?: string + application_preferred_name?: string + authorization_code?: string | null + authorization_response_code?: string + brand?: string | null + country?: string | null + cvm_type?: string + data_type?: string | null + dedicated_file_name?: string + emv_auth_data?: string + evidence_customer_signature?: string | null + evidence_transaction_certificate?: string | null + exp_month?: number | null + exp_year?: number | null + fingerprint?: string + funding?: string | null + last4?: string | null + pos_device_id?: string | null + pos_entry_mode?: string + read_method?: string | null + reader?: string | null + terminal_verification_results?: string + transaction_status_information?: string + } source_type_eps: { - reference?: string | null; - statement_descriptor?: string | null; - }; + reference?: string | null + statement_descriptor?: string | null + } source_type_giropay: { - bank_code?: string | null; - bank_name?: string | null; - bic?: string | null; - statement_descriptor?: string | null; - }; + bank_code?: string | null + bank_name?: string | null + bic?: string | null + statement_descriptor?: string | null + } source_type_ideal: { - bank?: string | null; - bic?: string | null; - iban_last4?: string | null; - statement_descriptor?: string | null; - }; + bank?: string | null + bic?: string | null + iban_last4?: string | null + statement_descriptor?: string | null + } source_type_klarna: { - background_image_url?: string; - client_token?: string | null; - first_name?: string; - last_name?: string; - locale?: string; - logo_url?: string; - page_title?: string; - pay_later_asset_urls_descriptive?: string; - pay_later_asset_urls_standard?: string; - pay_later_name?: string; - pay_later_redirect_url?: string; - pay_now_asset_urls_descriptive?: string; - pay_now_asset_urls_standard?: string; - pay_now_name?: string; - pay_now_redirect_url?: string; - pay_over_time_asset_urls_descriptive?: string; - pay_over_time_asset_urls_standard?: string; - pay_over_time_name?: string; - pay_over_time_redirect_url?: string; - payment_method_categories?: string; - purchase_country?: string; - purchase_type?: string; - redirect_url?: string; - shipping_delay?: number; - shipping_first_name?: string; - shipping_last_name?: string; - }; + background_image_url?: string + client_token?: string | null + first_name?: string + last_name?: string + locale?: string + logo_url?: string + page_title?: string + pay_later_asset_urls_descriptive?: string + pay_later_asset_urls_standard?: string + pay_later_name?: string + pay_later_redirect_url?: string + pay_now_asset_urls_descriptive?: string + pay_now_asset_urls_standard?: string + pay_now_name?: string + pay_now_redirect_url?: string + pay_over_time_asset_urls_descriptive?: string + pay_over_time_asset_urls_standard?: string + pay_over_time_name?: string + pay_over_time_redirect_url?: string + payment_method_categories?: string + purchase_country?: string + purchase_type?: string + redirect_url?: string + shipping_delay?: number + shipping_first_name?: string + shipping_last_name?: string + } source_type_multibanco: { - entity?: string | null; - reference?: string | null; - refund_account_holder_address_city?: string | null; - refund_account_holder_address_country?: string | null; - refund_account_holder_address_line1?: string | null; - refund_account_holder_address_line2?: string | null; - refund_account_holder_address_postal_code?: string | null; - refund_account_holder_address_state?: string | null; - refund_account_holder_name?: string | null; - refund_iban?: string | null; - }; + entity?: string | null + reference?: string | null + refund_account_holder_address_city?: string | null + refund_account_holder_address_country?: string | null + refund_account_holder_address_line1?: string | null + refund_account_holder_address_line2?: string | null + refund_account_holder_address_postal_code?: string | null + refund_account_holder_address_state?: string | null + refund_account_holder_name?: string | null + refund_iban?: string | null + } source_type_p24: { - reference?: string | null; - }; + reference?: string | null + } source_type_sepa_debit: { - bank_code?: string | null; - branch_code?: string | null; - country?: string | null; - fingerprint?: string | null; - last4?: string | null; - mandate_reference?: string | null; - mandate_url?: string | null; - }; + bank_code?: string | null + branch_code?: string | null + country?: string | null + fingerprint?: string | null + last4?: string | null + mandate_reference?: string | null + mandate_url?: string | null + } source_type_sofort: { - bank_code?: string | null; - bank_name?: string | null; - bic?: string | null; - country?: string | null; - iban_last4?: string | null; - preferred_language?: string | null; - statement_descriptor?: string | null; - }; + bank_code?: string | null + bank_name?: string | null + bic?: string | null + country?: string | null + iban_last4?: string | null + preferred_language?: string | null + statement_descriptor?: string | null + } source_type_three_d_secure: { - address_line1_check?: string | null; - address_zip_check?: string | null; - authenticated?: boolean | null; - brand?: string | null; - card?: string | null; - country?: string | null; - customer?: string | null; - cvc_check?: string | null; - dynamic_last4?: string | null; - exp_month?: number | null; - exp_year?: number | null; - fingerprint?: string; - funding?: string | null; - last4?: string | null; - name?: string | null; - three_d_secure?: string; - tokenization_method?: string | null; - }; + address_line1_check?: string | null + address_zip_check?: string | null + authenticated?: boolean | null + brand?: string | null + card?: string | null + country?: string | null + customer?: string | null + cvc_check?: string | null + dynamic_last4?: string | null + exp_month?: number | null + exp_year?: number | null + fingerprint?: string + funding?: string | null + last4?: string | null + name?: string | null + three_d_secure?: string + tokenization_method?: string | null + } source_type_wechat: { - prepay_id?: string; - qr_code_url?: string | null; - statement_descriptor?: string; - }; + prepay_id?: string + qr_code_url?: string | null + statement_descriptor?: string + } /** StatusTransitions */ status_transitions: { /** * Format: unix-time * @description The time that the order was canceled. */ - canceled?: number | null; + canceled?: number | null /** * Format: unix-time * @description The time that the order was fulfilled. */ - fulfiled?: number | null; + fulfiled?: number | null /** * Format: unix-time * @description The time that the order was paid. */ - paid?: number | null; + paid?: number | null /** * Format: unix-time * @description The time that the order was returned. */ - returned?: number | null; - }; + returned?: number | null + } /** * Subscription * @description Subscriptions allow you to charge a customer on a recurring basis. @@ -13480,127 +13311,123 @@ export interface components { */ subscription: { /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. */ - application_fee_percent?: number | null; - automatic_tax: components["schemas"]["subscription_automatic_tax"]; + application_fee_percent?: number | null + automatic_tax: components['schemas']['subscription_automatic_tax'] /** * Format: unix-time * @description Determines the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. */ - billing_cycle_anchor: number; + billing_cycle_anchor: number /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period */ - billing_thresholds?: Partial | null; + billing_thresholds?: Partial | null /** * Format: unix-time * @description A date in the future at which the subscription will automatically get canceled */ - cancel_at?: number | null; + cancel_at?: number | null /** @description If the subscription has been canceled with the `at_period_end` flag set to `true`, `cancel_at_period_end` on the subscription will be true. You can use this attribute to determine whether a subscription that has a status of active is scheduled to be canceled at the end of the current period. */ - cancel_at_period_end: boolean; + cancel_at_period_end: boolean /** * Format: unix-time * @description 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?: number | null; + canceled_at?: number | null /** * @description 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. * @enum {string} */ - collection_method: "charge_automatically" | "send_invoice"; + collection_method: 'charge_automatically' | 'send_invoice' /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** * Format: unix-time * @description 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: number; + current_period_end: number /** * Format: unix-time * @description Start of the current period that the subscription has been invoiced for. */ - current_period_start: number; + current_period_start: number /** @description ID of the customer who owns the subscription. */ - customer: Partial & - Partial & - Partial; + customer: Partial & Partial & Partial /** @description 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?: number | null; + days_until_due?: number | null /** @description 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?: (Partial & Partial) | null; + default_payment_method?: (Partial & Partial) | null /** @description 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?: | (Partial & - Partial & - Partial & - Partial & - Partial & - Partial) - | null; + Partial & + Partial & + Partial & + Partial & + Partial) + | null /** @description 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?: components["schemas"]["tax_rate"][] | null; + default_tax_rates?: components['schemas']['tax_rate'][] | null /** @description 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. */ - discount?: Partial | null; + discount?: Partial | null /** * Format: unix-time * @description If the subscription has ended, the date the subscription ended. */ - ended_at?: number | null; + ended_at?: number | null /** @description Unique identifier for the object. */ - id: string; + id: string /** * SubscriptionItemList * @description List of subscription items, each with an attached price. */ items: { /** @description Details about each object. */ - data: components["schemas"]["subscription_item"][]; + data: components['schemas']['subscription_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** @description The most recent invoice this subscription has generated. */ - latest_invoice?: (Partial & Partial) | null; + latest_invoice?: (Partial & Partial) | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * Format: unix-time * @description 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?: number | null; + next_pending_invoice_item_invoice?: number | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "subscription"; + object: 'subscription' /** @description If specified, payment collection for this subscription will be paused. */ - pause_collection?: Partial | null; + pause_collection?: Partial | null /** @description Payment settings passed on to invoices created by the subscription. */ - payment_settings?: Partial | null; + payment_settings?: Partial | null /** @description 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?: Partial< - components["schemas"]["subscription_pending_invoice_item_interval"] - > | null; + pending_invoice_item_interval?: Partial | null /** @description 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?: (Partial & Partial) | null; + pending_setup_intent?: (Partial & Partial) | null /** @description 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?: Partial | null; + pending_update?: Partial | null /** @description The schedule attached to the subscription */ - schedule?: (Partial & Partial) | null; + schedule?: (Partial & Partial) | null /** * Format: unix-time * @description Date when the subscription was first created. The date might differ from the `created` date due to backdating. */ - start_date: number; + start_date: number /** * @description Possible values are `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `canceled`, or `unpaid`. * @@ -13613,32 +13440,32 @@ export interface components { * If 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. * @enum {string} */ - status: "active" | "canceled" | "incomplete" | "incomplete_expired" | "past_due" | "trialing" | "unpaid"; + status: 'active' | 'canceled' | 'incomplete' | 'incomplete_expired' | 'past_due' | 'trialing' | 'unpaid' /** @description 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?: Partial | null; + transfer_data?: Partial | null /** * Format: unix-time * @description If the subscription has a trial, the end of that trial. */ - trial_end?: number | null; + trial_end?: number | null /** * Format: unix-time * @description If the subscription has a trial, the beginning of that trial. */ - trial_start?: number | null; - }; + trial_start?: number | null + } /** SubscriptionAutomaticTax */ subscription_automatic_tax: { /** @description Whether Stripe automatically computes tax on this subscription. */ - enabled: boolean; - }; + enabled: boolean + } /** SubscriptionBillingThresholds */ subscription_billing_thresholds: { /** @description Monetary threshold that triggers the subscription to create an invoice */ - amount_gte?: number | null; + amount_gte?: number | null /** @description 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?: boolean | null; - }; + reset_billing_cycle_anchor?: boolean | null + } /** * SubscriptionItem * @description Subscription items allow you to create customer subscriptions with more than @@ -13646,50 +13473,50 @@ export interface components { */ subscription_item: { /** @description Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period */ - billing_thresholds?: Partial | null; + billing_thresholds?: Partial | null /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Unique identifier for the object. */ - id: string; + id: string /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "subscription_item"; - price: components["schemas"]["price"]; + object: 'subscription_item' + price: components['schemas']['price'] /** @description The [quantity](https://stripe.com/docs/subscriptions/quantities) of the plan to which the customer should be subscribed. */ - quantity?: number; + quantity?: number /** @description The `subscription` this `subscription_item` belongs to. */ - subscription: string; + subscription: string /** @description 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?: components["schemas"]["tax_rate"][] | null; - }; + tax_rates?: components['schemas']['tax_rate'][] | null + } /** SubscriptionItemBillingThresholds */ subscription_item_billing_thresholds: { /** @description Usage threshold that triggers the subscription to create an invoice */ - usage_gte?: number | null; - }; + usage_gte?: number | null + } /** subscription_payment_method_options_card */ subscription_payment_method_options_card: { - mandate_options?: components["schemas"]["invoice_mandate_options_card"]; + mandate_options?: components['schemas']['invoice_mandate_options_card'] /** * @description 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#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. * @enum {string|null} */ - request_three_d_secure?: ("any" | "automatic") | null; - }; + request_three_d_secure?: ('any' | 'automatic') | null + } /** SubscriptionPendingInvoiceItemInterval */ subscription_pending_invoice_item_interval: { /** * @description Specifies invoicing frequency. Either `day`, `week`, `month` or `year`. * @enum {string} */ - interval: "day" | "month" | "week" | "year"; + interval: 'day' | 'month' | 'week' | 'year' /** @description 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: number; - }; + interval_count: number + } /** * SubscriptionSchedule * @description A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes. @@ -13701,195 +13528,185 @@ export interface components { * Format: unix-time * @description Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch. */ - canceled_at?: number | null; + canceled_at?: number | null /** * Format: unix-time * @description Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch. */ - completed_at?: number | null; + completed_at?: number | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Object representing the start and end dates for the current phase of the subscription schedule, if it is `active`. */ - current_phase?: Partial | null; + current_phase?: Partial | null /** @description ID of the customer who owns the subscription schedule. */ - customer: Partial & - Partial & - Partial; - default_settings: components["schemas"]["subscription_schedules_resource_default_settings"]; + customer: Partial & Partial & Partial + default_settings: components['schemas']['subscription_schedules_resource_default_settings'] /** * @description Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` and `cancel`. * @enum {string} */ - end_behavior: "cancel" | "none" | "release" | "renew"; + end_behavior: 'cancel' | 'none' | 'release' | 'renew' /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "subscription_schedule"; + object: 'subscription_schedule' /** @description Configuration for the subscription schedule's phases. */ - phases: components["schemas"]["subscription_schedule_phase_configuration"][]; + phases: components['schemas']['subscription_schedule_phase_configuration'][] /** * Format: unix-time * @description Time at which the subscription schedule was released. Measured in seconds since the Unix epoch. */ - released_at?: number | null; + released_at?: number | null /** @description ID of the subscription once managed by the subscription schedule (if it is released). */ - released_subscription?: string | null; + released_subscription?: string | null /** * @description 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). * @enum {string} */ - status: "active" | "canceled" | "completed" | "not_started" | "released"; + status: 'active' | 'canceled' | 'completed' | 'not_started' | 'released' /** @description ID of the subscription managed by the subscription schedule. */ - subscription?: (Partial & Partial) | null; - }; + subscription?: (Partial & Partial) | null + } /** * SubscriptionScheduleAddInvoiceItem * @description An Add Invoice Item describes the prices and quantities that will be added as pending invoice items when entering a phase. */ subscription_schedule_add_invoice_item: { /** @description ID of the price used to generate the invoice item. */ - price: Partial & - Partial & - Partial; + price: Partial & Partial & Partial /** @description The quantity of the invoice item. */ - quantity?: number | null; + quantity?: number | null /** @description The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item. */ - tax_rates?: components["schemas"]["tax_rate"][] | null; - }; + tax_rates?: components['schemas']['tax_rate'][] | null + } /** * SubscriptionScheduleConfigurationItem * @description A phase item describes the price and quantity of a phase. */ subscription_schedule_configuration_item: { /** @description Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period */ - billing_thresholds?: Partial | null; + billing_thresholds?: Partial | null /** @description ID of the price to which the customer should be subscribed. */ - price: Partial & - Partial & - Partial; + price: Partial & Partial & Partial /** @description Quantity of the plan to which the customer should be subscribed. */ - quantity?: number; + quantity?: number /** @description 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?: components["schemas"]["tax_rate"][] | null; - }; + tax_rates?: components['schemas']['tax_rate'][] | null + } /** SubscriptionScheduleCurrentPhase */ subscription_schedule_current_phase: { /** * Format: unix-time * @description The end of this phase of the subscription schedule. */ - end_date: number; + end_date: number /** * Format: unix-time * @description The start of this phase of the subscription schedule. */ - start_date: number; - }; + start_date: number + } /** * SubscriptionSchedulePhaseConfiguration * @description A phase describes the plans, coupon, and trialing status of a subscription for a predefined time period. */ subscription_schedule_phase_configuration: { /** @description A list of prices and quantities that will generate invoice items appended to the first invoice for this phase. */ - add_invoice_items: components["schemas"]["subscription_schedule_add_invoice_item"][]; + add_invoice_items: components['schemas']['subscription_schedule_add_invoice_item'][] /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account during this phase of the schedule. */ - application_fee_percent?: number | null; - automatic_tax?: components["schemas"]["schedules_phase_automatic_tax"]; + application_fee_percent?: number | null + automatic_tax?: components['schemas']['schedules_phase_automatic_tax'] /** * @description 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). * @enum {string|null} */ - billing_cycle_anchor?: ("automatic" | "phase_start") | null; + billing_cycle_anchor?: ('automatic' | 'phase_start') | null /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period */ - billing_thresholds?: Partial | null; + billing_thresholds?: Partial | null /** * @description 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. * @enum {string|null} */ - collection_method?: ("charge_automatically" | "send_invoice") | null; + collection_method?: ('charge_automatically' | 'send_invoice') | null /** @description ID of the coupon to use during this phase of the subscription schedule. */ - coupon?: - | (Partial & - Partial & - Partial) - | null; + coupon?: (Partial & Partial & Partial) | null /** @description 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?: (Partial & Partial) | null; + default_payment_method?: (Partial & Partial) | null /** @description The default tax rates to apply to the subscription during this phase of the subscription schedule. */ - default_tax_rates?: components["schemas"]["tax_rate"][] | null; + default_tax_rates?: components['schemas']['tax_rate'][] | null /** * Format: unix-time * @description The end of this phase of the subscription schedule. */ - end_date: number; + end_date: number /** @description The invoice settings applicable during this phase. */ - invoice_settings?: Partial | null; + invoice_settings?: Partial | null /** @description Subscription items to configure the subscription to during this phase of the subscription schedule. */ - items: components["schemas"]["subscription_schedule_configuration_item"][]; + items: components['schemas']['subscription_schedule_configuration_item'][] /** * @description If the subscription schedule will prorate when transitioning to this phase. Possible values are `create_prorations` and `none`. * @enum {string} */ - proration_behavior: "always_invoice" | "create_prorations" | "none"; + proration_behavior: 'always_invoice' | 'create_prorations' | 'none' /** * Format: unix-time * @description The start of this phase of the subscription schedule. */ - start_date: number; + start_date: number /** @description 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?: Partial | null; + transfer_data?: Partial | null /** * Format: unix-time * @description When the trial ends within the phase. */ - trial_end?: number | null; - }; + trial_end?: number | null + } /** SubscriptionSchedulesResourceDefaultSettings */ subscription_schedules_resource_default_settings: { /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account during this phase of the schedule. */ - application_fee_percent?: number | null; - automatic_tax?: components["schemas"]["subscription_schedules_resource_default_settings_automatic_tax"]; + application_fee_percent?: number | null + automatic_tax?: components['schemas']['subscription_schedules_resource_default_settings_automatic_tax'] /** * @description 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). * @enum {string} */ - billing_cycle_anchor: "automatic" | "phase_start"; + billing_cycle_anchor: 'automatic' | 'phase_start' /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period */ - billing_thresholds?: Partial | null; + billing_thresholds?: Partial | null /** * @description 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. * @enum {string|null} */ - collection_method?: ("charge_automatically" | "send_invoice") | null; + collection_method?: ('charge_automatically' | 'send_invoice') | null /** @description 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?: (Partial & Partial) | null; + default_payment_method?: (Partial & Partial) | null /** @description The subscription schedule's default invoice settings. */ - invoice_settings?: Partial | null; + invoice_settings?: Partial | null /** @description 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?: Partial | null; - }; + transfer_data?: Partial | null + } /** SubscriptionSchedulesResourceDefaultSettingsAutomaticTax */ subscription_schedules_resource_default_settings_automatic_tax: { /** @description Whether Stripe automatically computes tax on invoices created during this phase. */ - enabled: boolean; - }; + enabled: boolean + } /** SubscriptionTransferData */ subscription_transfer_data: { /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the destination account. By default, the entire amount is transferred to the destination. */ - amount_percent?: number | null; + amount_percent?: number | null /** @description The account where funds from the payment will be transferred to upon payment success. */ - destination: Partial & Partial; - }; + destination: Partial & Partial + } /** * SubscriptionsResourcePauseCollection * @description The Pause Collection settings determine how we will pause collection for this subscription and for how long the subscription @@ -13900,47 +13717,47 @@ export interface components { * @description The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`. * @enum {string} */ - behavior: "keep_as_draft" | "mark_uncollectible" | "void"; + behavior: 'keep_as_draft' | 'mark_uncollectible' | 'void' /** * Format: unix-time * @description The time after which the subscription will resume collecting payments. */ - resumes_at?: number | null; - }; + resumes_at?: number | null + } /** SubscriptionsResourcePaymentMethodOptions */ subscriptions_resource_payment_method_options: { /** @description This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to invoices created by the subscription. */ - acss_debit?: Partial | null; + acss_debit?: Partial | null /** @description This sub-hash contains details about the Bancontact payment method options to pass to invoices created by the subscription. */ - bancontact?: Partial | null; + bancontact?: Partial | null /** @description This sub-hash contains details about the Card payment method options to pass to invoices created by the subscription. */ - card?: Partial | null; - }; + card?: Partial | null + } /** SubscriptionsResourcePaymentSettings */ subscriptions_resource_payment_settings: { /** @description Payment-method-specific configuration to provide to invoices created by the subscription. */ - payment_method_options?: Partial | null; + payment_method_options?: Partial | null /** @description 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?: | ( - | "ach_credit_transfer" - | "ach_debit" - | "acss_debit" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "sepa_debit" - | "sofort" - | "wechat_pay" + | 'ach_credit_transfer' + | 'ach_debit' + | 'acss_debit' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' )[] - | null; - }; + | null + } /** * SubscriptionsResourcePendingUpdate * @description Pending Updates store the changes pending from a previous update that will be applied @@ -13951,61 +13768,61 @@ export interface components { * Format: unix-time * @description 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. */ - billing_cycle_anchor?: number | null; + billing_cycle_anchor?: number | null /** * Format: unix-time * @description The point after which the changes reflected by this update will be discarded and no longer applied. */ - expires_at: number; + expires_at: number /** @description List of subscription items, each with an attached plan, that will be set if the update is applied. */ - subscription_items?: components["schemas"]["subscription_item"][] | null; + subscription_items?: components['schemas']['subscription_item'][] | null /** * Format: unix-time * @description 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?: number | null; + trial_end?: number | null /** @description 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?: boolean | null; - }; + trial_from_plan?: boolean | null + } /** * TaxProductResourceTaxCode * @description [Tax codes](https://stripe.com/docs/tax/tax-codes) classify goods and services for tax purposes. */ tax_code: { /** @description A detailed description of which types of products the tax code represents. */ - description: string; + description: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description A short name for the tax code. */ - name: string; + name: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "tax_code"; - }; + object: 'tax_code' + } /** TaxDeductedAtSource */ tax_deducted_at_source: { /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "tax_deducted_at_source"; + object: 'tax_deducted_at_source' /** * Format: unix-time * @description The end of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period. */ - period_end: number; + period_end: number /** * Format: unix-time * @description The start of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period. */ - period_start: number; + period_start: number /** @description The TAN that was supplied to Stripe when TDS was assessed */ - tax_deduction_account_number: string; - }; + tax_deduction_account_number: string + } /** * tax_id * @description You can add one or multiple tax IDs to a [customer](https://stripe.com/docs/api/customers). @@ -14015,88 +13832,88 @@ export interface components { */ tax_id: { /** @description Two-letter ISO code representing the country of the tax ID. */ - country?: string | null; + country?: string | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description ID of the customer. */ - customer?: (Partial & Partial) | null; + customer?: (Partial & Partial) | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "tax_id"; + object: 'tax_id' /** * @description Type of the tax ID, one of `ae_trn`, `au_abn`, `au_arn`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `es_cif`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `th_vat`, `tw_vat`, `ua_vat`, `us_ein`, or `za_vat`. Note that some legacy tax IDs have type `unknown` * @enum {string} */ type: - | "ae_trn" - | "au_abn" - | "au_arn" - | "br_cnpj" - | "br_cpf" - | "ca_bn" - | "ca_gst_hst" - | "ca_pst_bc" - | "ca_pst_mb" - | "ca_pst_sk" - | "ca_qst" - | "ch_vat" - | "cl_tin" - | "es_cif" - | "eu_vat" - | "gb_vat" - | "ge_vat" - | "hk_br" - | "id_npwp" - | "il_vat" - | "in_gst" - | "is_vat" - | "jp_cn" - | "jp_rn" - | "kr_brn" - | "li_uid" - | "mx_rfc" - | "my_frp" - | "my_itn" - | "my_sst" - | "no_vat" - | "nz_gst" - | "ru_inn" - | "ru_kpp" - | "sa_vat" - | "sg_gst" - | "sg_uen" - | "th_vat" - | "tw_vat" - | "ua_vat" - | "unknown" - | "us_ein" - | "za_vat"; + | 'ae_trn' + | 'au_abn' + | 'au_arn' + | 'br_cnpj' + | 'br_cpf' + | 'ca_bn' + | 'ca_gst_hst' + | 'ca_pst_bc' + | 'ca_pst_mb' + | 'ca_pst_sk' + | 'ca_qst' + | 'ch_vat' + | 'cl_tin' + | 'es_cif' + | 'eu_vat' + | 'gb_vat' + | 'ge_vat' + | 'hk_br' + | 'id_npwp' + | 'il_vat' + | 'in_gst' + | 'is_vat' + | 'jp_cn' + | 'jp_rn' + | 'kr_brn' + | 'li_uid' + | 'mx_rfc' + | 'my_frp' + | 'my_itn' + | 'my_sst' + | 'no_vat' + | 'nz_gst' + | 'ru_inn' + | 'ru_kpp' + | 'sa_vat' + | 'sg_gst' + | 'sg_uen' + | 'th_vat' + | 'tw_vat' + | 'ua_vat' + | 'unknown' + | 'us_ein' + | 'za_vat' /** @description Value of the tax ID. */ - value: string; + value: string /** @description Tax ID verification information. */ - verification?: Partial | null; - }; + verification?: Partial | null + } /** tax_id_verification */ tax_id_verification: { /** * @description Verification status, one of `pending`, `verified`, `unverified`, or `unavailable`. * @enum {string} */ - status: "pending" | "unavailable" | "unverified" | "verified"; + status: 'pending' | 'unavailable' | 'unverified' | 'verified' /** @description Verified address. */ - verified_address?: string | null; + verified_address?: string | null /** @description Verified name. */ - verified_name?: string | null; - }; + verified_name?: string | null + } /** * TaxRate * @description Tax rates can be applied to [invoices](https://stripe.com/docs/billing/invoices/tax-rates), [subscriptions](https://stripe.com/docs/billing/subscriptions/taxes) and [Checkout Sessions](https://stripe.com/docs/payments/checkout/set-up-a-subscription#tax-rates) to collect tax. @@ -14105,118 +13922,118 @@ export interface components { */ tax_rate: { /** @description 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: boolean; + active: boolean /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ - country?: string | null; + country?: string | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. */ - description?: string | null; + description?: string | null /** @description 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: string; + display_name: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description This specifies if the tax rate is inclusive or exclusive. */ - inclusive: boolean; + inclusive: boolean /** @description 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?: string | null; + jurisdiction?: string | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "tax_rate"; + object: 'tax_rate' /** @description This represents the tax rate percent out of 100. */ - percentage: number; + percentage: number /** @description [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States. */ - state?: string | null; + state?: string | null /** * @description The high-level tax type, such as `vat` or `sales_tax`. * @enum {string|null} */ - tax_type?: ("gst" | "hst" | "jct" | "pst" | "qst" | "rst" | "sales_tax" | "vat") | null; - }; + tax_type?: ('gst' | 'hst' | 'jct' | 'pst' | 'qst' | 'rst' | 'sales_tax' | 'vat') | null + } /** * TerminalConnectionToken * @description A Connection Token is used by the Stripe Terminal SDK to connect to a reader. * * Related guide: [Fleet Management](https://stripe.com/docs/terminal/fleet/locations). */ - "terminal.connection_token": { + 'terminal.connection_token': { /** @description 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://stripe.com/docs/terminal/fleet/locations#connection-tokens). */ - location?: string; + location?: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "terminal.connection_token"; + object: 'terminal.connection_token' /** @description Your application should pass this token to the Stripe Terminal SDK. */ - secret: string; - }; + secret: string + } /** * TerminalLocationLocation * @description A Location represents a grouping of readers. * * Related guide: [Fleet Management](https://stripe.com/docs/terminal/fleet/locations). */ - "terminal.location": { - address: components["schemas"]["address"]; + 'terminal.location': { + address: components['schemas']['address'] /** @description The display name of the location. */ - display_name: string; + display_name: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "terminal.location"; - }; + object: 'terminal.location' + } /** * TerminalReaderReader * @description A Reader represents a physical device for accepting payment details. * * Related guide: [Connecting to a Reader](https://stripe.com/docs/terminal/payments/connect-reader). */ - "terminal.reader": { + 'terminal.reader': { /** @description The current software version of the reader. */ - device_sw_version?: string | null; + device_sw_version?: string | null /** * @description Type of reader, one of `bbpos_chipper2x`, `bbpos_wisepos_e`, or `verifone_P400`. * @enum {string} */ - device_type: "bbpos_chipper2x" | "bbpos_wisepos_e" | "verifone_P400"; + device_type: 'bbpos_chipper2x' | 'bbpos_wisepos_e' | 'verifone_P400' /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The local IP address of the reader. */ - ip_address?: string | null; + ip_address?: string | null /** @description Custom label given to the reader for easier identification. */ - label: string; + label: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description The location identifier of the reader. */ - location?: (Partial & Partial) | null; + location?: (Partial & Partial) | null /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "terminal.reader"; + object: 'terminal.reader' /** @description Serial number of the reader. */ - serial_number: string; + serial_number: string /** @description The networking status of the reader. */ - status?: string | null; - }; + status?: string | null + } /** * ThreeDSecure * @description Cardholder authentication via 3D Secure is initiated by creating a `3D Secure` @@ -14225,31 +14042,31 @@ export interface components { */ three_d_secure: { /** @description Amount of the charge that you will create when authentication completes. */ - amount: number; + amount: number /** @description True if the cardholder went through the authentication flow and their bank indicated that authentication succeeded. */ - authenticated: boolean; - card: components["schemas"]["card"]; + authenticated: boolean + card: components['schemas']['card'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "three_d_secure"; + object: 'three_d_secure' /** @description If present, this is the URL that you should send the cardholder to for authentication. If you are going to use Stripe.js to display the authentication page in an iframe, you should use the value "_callback". */ - redirect_url?: string | null; + redirect_url?: string | null /** @description Possible values are `redirect_pending`, `succeeded`, or `failed`. When the cardholder can be authenticated, the object starts with status `redirect_pending`. When liability will be shifted to the cardholder's bank (either because the cardholder was successfully authenticated, or because the bank has not implemented 3D Secure, the object wlil be in status `succeeded`. `failed` indicates that authentication was attempted unsuccessfully. */ - status: string; - }; + status: string + } /** three_d_secure_details */ three_d_secure_details: { /** @@ -14257,39 +14074,29 @@ export interface components { * the issuing bank. * @enum {string|null} */ - authentication_flow?: ("challenge" | "frictionless") | null; + authentication_flow?: ('challenge' | 'frictionless') | null /** * @description Indicates the outcome of 3D Secure authentication. * @enum {string|null} */ - result?: ("attempt_acknowledged" | "authenticated" | "failed" | "not_supported" | "processing_error") | null; + result?: ('attempt_acknowledged' | 'authenticated' | 'failed' | 'not_supported' | 'processing_error') | null /** * @description Additional information about why 3D Secure succeeded or failed based * on the `result`. * @enum {string|null} */ - result_reason?: - | ( - | "abandoned" - | "bypassed" - | "canceled" - | "card_not_enrolled" - | "network_not_supported" - | "protocol_error" - | "rejected" - ) - | null; + result_reason?: ('abandoned' | 'bypassed' | 'canceled' | 'card_not_enrolled' | 'network_not_supported' | 'protocol_error' | 'rejected') | null /** * @description The version of 3D Secure that was used. * @enum {string|null} */ - version?: ("1.0.2" | "2.1.0" | "2.2.0") | null; - }; + version?: ('1.0.2' | '2.1.0' | '2.2.0') | null + } /** three_d_secure_usage */ three_d_secure_usage: { /** @description Whether 3D Secure is supported on this card. */ - supported: boolean; - }; + supported: boolean + } /** * Token * @description Tokenization is the process Stripe uses to collect sensitive card or bank @@ -14316,29 +14123,29 @@ export interface components { * Related guide: [Accept a payment](https://stripe.com/docs/payments/accept-a-payment-charges#web-create-token) */ token: { - bank_account?: components["schemas"]["bank_account"]; - card?: components["schemas"]["card"]; + bank_account?: components['schemas']['bank_account'] + card?: components['schemas']['card'] /** @description IP address of the client that generated the token. */ - client_ip?: string | null; + client_ip?: string | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "token"; + object: 'token' /** @description Type of the token: `account`, `bank_account`, `card`, or `pii`. */ - type: string; + type: string /** @description Whether this token has already been used (tokens can be used only once). */ - used: boolean; - }; + used: boolean + } /** * Topup * @description To top up your Stripe balance, you create a top-up object. You can retrieve @@ -14349,46 +14156,46 @@ export interface components { */ topup: { /** @description Amount transferred. */ - amount: number; + amount: number /** @description 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?: (Partial & Partial) | null; + balance_transaction?: (Partial & Partial) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description 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?: number | null; + expected_availability_date?: number | null /** @description 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?: string | null; + failure_code?: string | null /** @description Message to user further explaining reason for top-up failure if available. */ - failure_message?: string | null; + failure_message?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "topup"; - source: components["schemas"]["source"]; + object: 'topup' + source: components['schemas']['source'] /** @description Extra information about a top-up. This will appear on your source's bank statement. It must contain at least one letter. */ - statement_descriptor?: string | null; + statement_descriptor?: string | null /** * @description The status of the top-up is either `canceled`, `failed`, `pending`, `reversed`, or `succeeded`. * @enum {string} */ - status: "canceled" | "failed" | "pending" | "reversed" | "succeeded"; + status: 'canceled' | 'failed' | 'pending' | 'reversed' | 'succeeded' /** @description A string that identifies this top-up as part of a group. */ - transfer_group?: string | null; - }; + transfer_group?: string | null + } /** * Transfer * @description A `Transfer` object is created when you move funds between Stripe accounts as @@ -14404,72 +14211,72 @@ export interface components { */ transfer: { /** @description Amount in %s to be transferred. */ - amount: number; + amount: number /** @description Amount in %s reversed (can be less than the amount attribute on the transfer if a partial reversal was issued). */ - amount_reversed: number; + amount_reversed: number /** @description Balance transaction that describes the impact of this transfer on your account balance. */ - balance_transaction?: (Partial & Partial) | null; + balance_transaction?: (Partial & Partial) | null /** * Format: unix-time * @description Time that this record of the transfer was first created. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description ID of the Stripe account the transfer was sent to. */ - destination?: (Partial & Partial) | null; + destination?: (Partial & Partial) | null /** @description 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?: Partial & Partial; + destination_payment?: Partial & Partial /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "transfer"; + object: 'transfer' /** * TransferReversalList * @description A list of reversals that have been applied to the transfer. */ reversals: { /** @description Details about each object. */ - data: components["schemas"]["transfer_reversal"][]; + data: components['schemas']['transfer_reversal'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** @description Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false. */ - reversed: boolean; + reversed: boolean /** @description ID of the charge or payment that was used to fund the transfer. If null, the transfer was funded from the available balance. */ - source_transaction?: (Partial & Partial) | null; + source_transaction?: (Partial & Partial) | null /** @description The source balance this transfer came from. One of `card`, `fpx`, or `bank_account`. */ - source_type?: string | null; + source_type?: string | null /** @description A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-options) for details. */ - transfer_group?: string | null; - }; + transfer_group?: string | null + } /** transfer_data */ transfer_data: { /** @description 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?: number; + amount?: number /** * @description The account (if any) the payment will be attributed to for tax * reporting, and where funds from the payment will be transferred to upon * payment success. */ - destination: Partial & Partial; - }; + destination: Partial & Partial + } /** * TransferReversal * @description [Stripe Connect](https://stripe.com/docs/connect) platforms can reverse transfers made to a @@ -14488,63 +14295,63 @@ export interface components { */ transfer_reversal: { /** @description Amount, in %s. */ - amount: number; + amount: number /** @description Balance transaction that describes the impact on your account balance. */ - balance_transaction?: (Partial & Partial) | null; + balance_transaction?: (Partial & Partial) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Linked payment refund for the transfer reversal. */ - destination_payment_refund?: (Partial & Partial) | null; + destination_payment_refund?: (Partial & Partial) | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "transfer_reversal"; + object: 'transfer_reversal' /** @description ID of the refund responsible for the transfer reversal. */ - source_refund?: (Partial & Partial) | null; + source_refund?: (Partial & Partial) | null /** @description ID of the transfer that was reversed. */ - transfer: Partial & Partial; - }; + transfer: Partial & Partial + } /** TransferSchedule */ transfer_schedule: { /** @description The number of days charges for the account will be held before being paid out. */ - delay_days: number; + delay_days: number /** @description How frequently funds will be paid out. One of `manual` (payouts only created via API call), `daily`, `weekly`, or `monthly`. */ - interval: string; + interval: string /** @description 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?: number; + monthly_anchor?: number /** @description The day of the week funds will be paid out, of the style 'monday', 'tuesday', etc. Only shown if `interval` is weekly. */ - weekly_anchor?: string; - }; + weekly_anchor?: string + } /** TransformQuantity */ transform_quantity: { /** @description Divide usage by this number. */ - divide_by: number; + divide_by: number /** * @description After division, either round the result `up` or `down`. * @enum {string} */ - round: "down" | "up"; - }; + round: 'down' | 'up' + } /** TransformUsage */ transform_usage: { /** @description Divide usage by this number. */ - divide_by: number; + divide_by: number /** * @description After division, either round the result `up` or `down`. * @enum {string} */ - round: "down" | "up"; - }; + round: 'down' | 'up' + } /** * UsageRecord * @description Usage records allow you to report customer usage and metrics to Stripe for @@ -14554,51 +14361,51 @@ export interface components { */ usage_record: { /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "usage_record"; + object: 'usage_record' /** @description The usage quantity for the specified date. */ - quantity: number; + quantity: number /** @description The ID of the subscription item this usage record contains data for. */ - subscription_item: string; + subscription_item: string /** * Format: unix-time * @description The timestamp when this usage occurred. */ - timestamp: number; - }; + timestamp: number + } /** UsageRecordSummary */ usage_record_summary: { /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The invoice in which this usage period has been billed for. */ - invoice?: string | null; + invoice?: string | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "usage_record_summary"; - period: components["schemas"]["period"]; + object: 'usage_record_summary' + period: components['schemas']['period'] /** @description The ID of the subscription item this summary is describing. */ - subscription_item: string; + subscription_item: string /** @description The total usage within this usage period. */ - total_usage: number; - }; + total_usage: number + } /** verification_session_redaction */ verification_session_redaction: { /** * @description Indicates whether this object and its related objects have been redacted or not. * @enum {string} */ - status: "processing" | "redacted"; - }; + status: 'processing' | 'redacted' + } /** * NotificationWebhookEndpoint * @description You can configure [webhook endpoints](https://stripe.com/docs/webhooks/) via the API to be @@ -14611,37 +14418,37 @@ export interface components { */ webhook_endpoint: { /** @description The API version events are rendered as for this webhook endpoint. */ - api_version?: string | null; + api_version?: string | null /** @description The ID of the associated Connect application. */ - application?: string | null; + application?: string | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description An optional description of what the webhook is used for. */ - description?: string | null; + description?: string | null /** @description The list of events to enable for this endpoint. `['*']` indicates that all events are enabled, except those that require explicit selection. */ - enabled_events: string[]; + enabled_events: string[] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "webhook_endpoint"; + object: 'webhook_endpoint' /** @description The endpoint's secret, used to generate [webhook signatures](https://stripe.com/docs/webhooks/signatures). Only returned at creation. */ - secret?: string; + secret?: string /** @description The status of the webhook. It can be `enabled` or `disabled`. */ - status: string; + status: string /** @description The URL of the webhook endpoint. */ - url: string; - }; - }; + url: string + } + } } export interface operations { @@ -14651,94 +14458,94 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["three_d_secure"]; - }; - }; + 'application/json': components['schemas']['three_d_secure'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Amount of the charge that you will create when authentication completes. */ - amount: number; + amount: number /** @description The ID of a card token, or the ID of a card belonging to the given customer. */ - card?: string; + card?: string /** @description 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: string; + currency: string /** @description The customer associated with this 3D secure authentication. */ - customer?: string; + customer?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The URL that the cardholder's browser will be returned to when authentication completes. */ - return_url: string; - }; - }; - }; - }; + return_url: string + } + } + } + } /**

Retrieves a 3D Secure object.

*/ Get3dSecureThreeDSecure: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - three_d_secure: string; - }; - }; + three_d_secure: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["three_d_secure"]; - }; - }; + 'application/json': components['schemas']['three_d_secure'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves the details of an account.

*/ GetAccount: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["account"]; - }; - }; + 'application/json': components['schemas']['account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged. Most parameters can be changed only for Custom accounts. (These are marked Custom Only below.) Parameters marked Custom and Express are not supported for Standard accounts.

* @@ -14749,63 +14556,63 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["account"]; - }; - }; + 'application/json': components['schemas']['account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account. */ - account_token?: string; + account_token?: string /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ bank_account?: Partial<{ - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; + account_holder_type?: 'company' | 'individual' + account_number: string /** @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; - country: string; - currency?: string; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' + country: string + currency?: string /** @enum {string} */ - object?: "bank_account"; - routing_number?: string; + object?: 'bank_account' + routing_number?: string }> & - Partial; + Partial /** * business_profile_specs * @description Business information about the account. */ business_profile?: { - mcc?: string; - name?: string; - product_description?: string; + mcc?: string + name?: string + product_description?: string /** address_specs */ support_address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - support_email?: string; - support_phone?: string; - support_url?: Partial & Partial<"">; - url?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + support_email?: string + support_phone?: string + support_url?: Partial & Partial<''> + url?: string + } /** * @description The business type. * @enum {string} */ - business_type?: "company" | "government_entity" | "individual" | "non_profit"; + business_type?: 'company' | 'government_entity' | 'individual' | 'non_profit' /** * capabilities_param * @description Each key of the dictionary represents a capability, and each capability maps to its settings (e.g. whether it has been requested or not). Each capability will be inactive until you have provided its specific requirements and Stripe has verified them. An account may have some of its requested capabilities be active and some be inactive. @@ -14813,101 +14620,101 @@ export interface operations { capabilities?: { /** capability_param */ acss_debit_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ afterpay_clearpay_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ au_becs_debit_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ bacs_debit_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ bancontact_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ boleto_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ card_issuing?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ card_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ cartes_bancaires_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ eps_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ fpx_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ giropay_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ grabpay_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ ideal_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ jcb_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ klarna_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ legacy_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ oxxo_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ p24_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ sepa_debit_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ sofort_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ tax_reporting_us_1099_k?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ tax_reporting_us_1099_misc?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ transfers?: { - requested?: boolean; - }; - }; + requested?: boolean + } + } /** * company_specs * @description Information about the company or business. This field is available for any `business_type`. @@ -14915,85 +14722,85 @@ export interface operations { company?: { /** address_specs */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** japan_address_kana_specs */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** japan_address_kanji_specs */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; - directors_provided?: boolean; - executives_provided?: boolean; - name?: string; - name_kana?: string; - name_kanji?: string; - owners_provided?: boolean; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } + directors_provided?: boolean + executives_provided?: boolean + name?: string + name_kana?: string + name_kanji?: string + owners_provided?: boolean /** company_ownership_declaration */ ownership_declaration?: { /** Format: unix-time */ - date?: number; - ip?: string; - user_agent?: string; - }; - phone?: string; - registration_number?: string; + date?: number + ip?: string + user_agent?: string + } + phone?: string + registration_number?: string /** @enum {string} */ structure?: - | "" - | "free_zone_establishment" - | "free_zone_llc" - | "government_instrumentality" - | "governmental_unit" - | "incorporated_non_profit" - | "limited_liability_partnership" - | "llc" - | "multi_member_llc" - | "private_company" - | "private_corporation" - | "private_partnership" - | "public_company" - | "public_corporation" - | "public_partnership" - | "single_member_llc" - | "sole_establishment" - | "sole_proprietorship" - | "tax_exempt_government_instrumentality" - | "unincorporated_association" - | "unincorporated_non_profit"; - tax_id?: string; - tax_id_registrar?: string; - vat_id?: string; + | '' + | 'free_zone_establishment' + | 'free_zone_llc' + | 'government_instrumentality' + | 'governmental_unit' + | 'incorporated_non_profit' + | 'limited_liability_partnership' + | 'llc' + | 'multi_member_llc' + | 'private_company' + | 'private_corporation' + | 'private_partnership' + | 'public_company' + | 'public_corporation' + | 'public_partnership' + | 'single_member_llc' + | 'sole_establishment' + | 'sole_proprietorship' + | 'tax_exempt_government_instrumentality' + | 'unincorporated_association' + | 'unincorporated_non_profit' + tax_id?: string + tax_id_registrar?: string + vat_id?: string /** verification_specs */ verification?: { /** verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; + back?: string + front?: string + } + } + } /** @description 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?: string; + default_currency?: string /** * documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -15001,39 +14808,39 @@ export interface operations { documents?: { /** documents_param */ bank_account_ownership_verification?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ company_license?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ company_memorandum_of_association?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ company_ministerial_decree?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ company_registration_verification?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ company_tax_id_verification?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ proof_of_registration?: { - files?: string[]; - }; - }; + files?: string[] + } + } /** @description The email address of the account holder. This is only to make the account easier to identify to you. Stripe only emails Custom accounts with your consent. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A card or bank account to attach to the account for receiving [payouts](https://stripe.com/docs/connect/bank-debit-card-payouts) (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://stripe.com/docs/api#account_create_bank_account) creation.

By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the bank account or card creation API. */ - external_account?: string; + external_account?: string /** * individual_specs * @description Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. @@ -15041,71 +14848,71 @@ export interface operations { individual?: { /** address_specs */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** japan_address_kana_specs */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** japan_address_kanji_specs */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } dob?: Partial<{ - day: number; - month: number; - year: number; + day: number + month: number + year: number }> & - Partial<"">; - email?: string; - first_name?: string; - first_name_kana?: string; - first_name_kanji?: string; - full_name_aliases?: Partial & Partial<"">; - gender?: string; - id_number?: string; - last_name?: string; - last_name_kana?: string; - last_name_kanji?: string; - maiden_name?: string; - metadata?: Partial<{ [key: string]: string }> & Partial<"">; - phone?: string; + Partial<''> + email?: string + first_name?: string + first_name_kana?: string + first_name_kanji?: string + full_name_aliases?: Partial & Partial<''> + gender?: string + id_number?: string + last_name?: string + last_name_kana?: string + last_name_kanji?: string + maiden_name?: string + metadata?: Partial<{ [key: string]: string }> & Partial<''> + phone?: string /** @enum {string} */ - political_exposure?: "existing" | "none"; - ssn_last_4?: string; + political_exposure?: 'existing' | 'none' + ssn_last_4?: string /** person_verification_specs */ verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; + back?: string + front?: string + } + } + } /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** * settings_specs_update * @description Options for customizing how the account functions within Stripe. @@ -15113,66 +14920,66 @@ export interface operations { settings?: { /** branding_settings_specs */ branding?: { - icon?: string; - logo?: string; - primary_color?: string; - secondary_color?: string; - }; + icon?: string + logo?: string + primary_color?: string + secondary_color?: string + } /** card_issuing_settings_specs */ card_issuing?: { /** settings_terms_of_service_specs */ tos_acceptance?: { /** Format: unix-time */ - date?: number; - ip?: string; - user_agent?: string; - }; - }; + date?: number + ip?: string + user_agent?: string + } + } /** card_payments_settings_specs */ card_payments?: { /** decline_charge_on_specs */ decline_on?: { - avs_failure?: boolean; - cvc_failure?: boolean; - }; - statement_descriptor_prefix?: string; - }; + avs_failure?: boolean + cvc_failure?: boolean + } + statement_descriptor_prefix?: string + } /** payments_settings_specs */ payments?: { - statement_descriptor?: string; - statement_descriptor_kana?: string; - statement_descriptor_kanji?: string; - }; + statement_descriptor?: string + statement_descriptor_kana?: string + statement_descriptor_kanji?: string + } /** payout_settings_specs */ payouts?: { - debit_negative_balances?: boolean; + debit_negative_balances?: boolean /** transfer_schedule_specs */ schedule?: { - delay_days?: Partial<"minimum"> & Partial; + delay_days?: Partial<'minimum'> & Partial /** @enum {string} */ - interval?: "daily" | "manual" | "monthly" | "weekly"; - monthly_anchor?: number; + interval?: 'daily' | 'manual' | 'monthly' | 'weekly' + monthly_anchor?: number /** @enum {string} */ - weekly_anchor?: "friday" | "monday" | "saturday" | "sunday" | "thursday" | "tuesday" | "wednesday"; - }; - statement_descriptor?: string; - }; - }; + weekly_anchor?: 'friday' | 'monday' | 'saturday' | 'sunday' | 'thursday' | 'tuesday' | 'wednesday' + } + statement_descriptor?: string + } + } /** * tos_acceptance_specs * @description Details on the account's acceptance of the [Stripe Services Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance). */ tos_acceptance?: { /** Format: unix-time */ - date?: number; - ip?: string; - service_agreement?: string; - user_agent?: string; - }; - }; - }; - }; - }; + date?: number + ip?: string + service_agreement?: string + user_agent?: string + } + } + } + } + } /** *

With Connect, you can delete accounts you manage.

* @@ -15185,101 +14992,101 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_account"]; - }; - }; + 'application/json': components['schemas']['deleted_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { - account?: string; - }; - }; - }; - }; + 'application/x-www-form-urlencoded': { + account?: string + } + } + } + } /**

Create an external account for a given account.

*/ PostAccountBankAccounts: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ bank_account?: Partial<{ - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; + account_holder_type?: 'company' | 'individual' + account_number: string /** @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; - country: string; - currency?: string; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' + country: string + currency?: string /** @enum {string} */ - object?: "bank_account"; - routing_number?: string; + object?: 'bank_account' + routing_number?: string }> & - Partial; + Partial /** @description When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency. */ - default_for_currency?: boolean; + default_for_currency?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - external_account?: string; + external_account?: string /** @description 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?: { [key: string]: string }; - }; - }; - }; - }; + metadata?: { [key: string]: string } + } + } + } + } /**

Retrieve a specified external account for a given account.

*/ GetAccountBankAccountsId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

* @@ -15288,318 +15095,318 @@ export interface operations { PostAccountBankAccountsId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The name of the person or business that owns the bank account. */ - account_holder_name?: string; + account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - account_holder_type?: "" | "company" | "individual"; + account_holder_type?: '' | 'company' | 'individual' /** * @description The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`. * @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' /** @description City/District/Suburb/Town/Village. */ - address_city?: string; + address_city?: string /** @description Billing address country, if provided when creating card. */ - address_country?: string; + address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - address_line1?: string; + address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - address_line2?: string; + address_line2?: string /** @description State/County/Province/Region. */ - address_state?: string; + address_state?: string /** @description ZIP or postal code. */ - address_zip?: string; + address_zip?: string /** @description When set to true, this becomes the default external account for its currency. */ - default_for_currency?: boolean; + default_for_currency?: boolean /** @description Two digit number representing the card’s expiration month. */ - exp_month?: string; + exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - exp_year?: string; + exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Cardholder name. */ - name?: string; - }; - }; - }; - }; + name?: string + } + } + } + } /**

Delete a specified external account for a given account.

*/ DeleteAccountBankAccountsId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_external_account"]; - }; - }; + 'application/json': components['schemas']['deleted_external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.

*/ GetAccountCapabilities: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["capability"][]; + 'application/json': { + data: components['schemas']['capability'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves information about the specified Account Capability.

*/ GetAccountCapabilitiesCapability: { parameters: { path: { - capability: string; - }; + capability: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["capability"]; - }; - }; + 'application/json': components['schemas']['capability'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates an existing Account Capability.

*/ PostAccountCapabilitiesCapability: { parameters: { path: { - capability: string; - }; - }; + capability: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["capability"]; - }; - }; + 'application/json': components['schemas']['capability'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. */ - requested?: boolean; - }; - }; - }; - }; + requested?: boolean + } + } + } + } /**

List external accounts for an account.

*/ GetAccountExternalAccounts: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards. */ - data: (Partial & Partial)[]; + data: (Partial & Partial)[] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Create an external account for a given account.

*/ PostAccountExternalAccounts: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ bank_account?: Partial<{ - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; + account_holder_type?: 'company' | 'individual' + account_number: string /** @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; - country: string; - currency?: string; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' + country: string + currency?: string /** @enum {string} */ - object?: "bank_account"; - routing_number?: string; + object?: 'bank_account' + routing_number?: string }> & - Partial; + Partial /** @description When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency. */ - default_for_currency?: boolean; + default_for_currency?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - external_account?: string; + external_account?: string /** @description 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?: { [key: string]: string }; - }; - }; - }; - }; + metadata?: { [key: string]: string } + } + } + } + } /**

Retrieve a specified external account for a given account.

*/ GetAccountExternalAccountsId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

* @@ -15608,93 +15415,93 @@ export interface operations { PostAccountExternalAccountsId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The name of the person or business that owns the bank account. */ - account_holder_name?: string; + account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - account_holder_type?: "" | "company" | "individual"; + account_holder_type?: '' | 'company' | 'individual' /** * @description The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`. * @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' /** @description City/District/Suburb/Town/Village. */ - address_city?: string; + address_city?: string /** @description Billing address country, if provided when creating card. */ - address_country?: string; + address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - address_line1?: string; + address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - address_line2?: string; + address_line2?: string /** @description State/County/Province/Region. */ - address_state?: string; + address_state?: string /** @description ZIP or postal code. */ - address_zip?: string; + address_zip?: string /** @description When set to true, this becomes the default external account for its currency. */ - default_for_currency?: boolean; + default_for_currency?: boolean /** @description Two digit number representing the card’s expiration month. */ - exp_month?: string; + exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - exp_year?: string; + exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Cardholder name. */ - name?: string; - }; - }; - }; - }; + name?: string + } + } + } + } /**

Delete a specified external account for a given account.

*/ DeleteAccountExternalAccountsId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_external_account"]; - }; - }; + 'application/json': components['schemas']['deleted_external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Creates a single-use login link for an Express account to access their Stripe dashboard.

* @@ -15705,145 +15512,145 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["login_link"]; - }; - }; + 'application/json': components['schemas']['login_link'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { - account: string; + 'application/x-www-form-urlencoded': { + account: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Where to redirect the user after they log out of their dashboard. */ - redirect_url?: string; - }; - }; - }; - }; + redirect_url?: string + } + } + } + } /**

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.

*/ GetAccountPeople: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Filters on the list of people returned based on the person's relationship to the account's company. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - representative?: boolean; - }; + director?: boolean + executive?: boolean + owner?: boolean + representative?: boolean + } /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["person"][]; + 'application/json': { + data: components['schemas']['person'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new person.

*/ PostAccountPeople: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { - account?: string; + 'application/x-www-form-urlencoded': { + account?: string /** * address_specs * @description The person's address. */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** @description The person's date of birth. */ dob?: Partial<{ - day: number; - month: number; - year: number; + day: number + month: number + year: number }> & - Partial<"">; + Partial<''> /** * person_documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -15851,65 +15658,65 @@ export interface operations { documents?: { /** documents_param */ company_authorization?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ passport?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ visa?: { - files?: string[]; - }; - }; + files?: string[] + } + } /** @description The person's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The person's first name. */ - first_name?: string; + first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - first_name_kana?: string; + first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - first_name_kanji?: string; + first_name_kanji?: string /** @description A list of alternate names or aliases that the person is known by. */ - full_name_aliases?: Partial & Partial<"">; + full_name_aliases?: Partial & Partial<''> /** @description The person's gender (International regulations require either "male" or "female"). */ - gender?: string; + gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ - id_number?: string; + id_number?: string /** @description The person's last name. */ - last_name?: string; + last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - last_name_kana?: string; + last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - last_name_kanji?: string; + last_name_kanji?: string /** @description The person's maiden name. */ - maiden_name?: string; + maiden_name?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ - nationality?: string; + nationality?: string /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - person_token?: string; + person_token?: string /** @description The person's phone number. */ - phone?: string; + phone?: string /** @description 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?: string; + political_exposure?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - percent_ownership?: Partial & Partial<"">; - representative?: boolean; - title?: string; - }; + director?: boolean + executive?: boolean + owner?: boolean + percent_ownership?: Partial & Partial<''> + representative?: boolean + title?: string + } /** @description The last four digits of the person's Social Security number (U.S. only). */ - ssn_last_4?: string; + ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -15917,120 +15724,120 @@ export interface operations { verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; - }; - }; - }; + back?: string + front?: string + } + } + } + } + } + } /**

Retrieves an existing person.

*/ GetAccountPeoplePerson: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - person: string; - }; - }; + person: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates an existing person.

*/ PostAccountPeoplePerson: { parameters: { path: { - person: string; - }; - }; + person: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { - account?: string; + 'application/x-www-form-urlencoded': { + account?: string /** * address_specs * @description The person's address. */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** @description The person's date of birth. */ dob?: Partial<{ - day: number; - month: number; - year: number; + day: number + month: number + year: number }> & - Partial<"">; + Partial<''> /** * person_documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -16038,65 +15845,65 @@ export interface operations { documents?: { /** documents_param */ company_authorization?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ passport?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ visa?: { - files?: string[]; - }; - }; + files?: string[] + } + } /** @description The person's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The person's first name. */ - first_name?: string; + first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - first_name_kana?: string; + first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - first_name_kanji?: string; + first_name_kanji?: string /** @description A list of alternate names or aliases that the person is known by. */ - full_name_aliases?: Partial & Partial<"">; + full_name_aliases?: Partial & Partial<''> /** @description The person's gender (International regulations require either "male" or "female"). */ - gender?: string; + gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ - id_number?: string; + id_number?: string /** @description The person's last name. */ - last_name?: string; + last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - last_name_kana?: string; + last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - last_name_kanji?: string; + last_name_kanji?: string /** @description The person's maiden name. */ - maiden_name?: string; + maiden_name?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ - nationality?: string; + nationality?: string /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - person_token?: string; + person_token?: string /** @description The person's phone number. */ - phone?: string; + phone?: string /** @description 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?: string; + political_exposure?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - percent_ownership?: Partial & Partial<"">; - representative?: boolean; - title?: string; - }; + director?: boolean + executive?: boolean + owner?: boolean + percent_ownership?: Partial & Partial<''> + representative?: boolean + title?: string + } /** @description The last four digits of the person's Social Security number (U.S. only). */ - ssn_last_4?: string; + ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -16104,163 +15911,163 @@ export interface operations { verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; - }; - }; - }; + back?: string + front?: string + } + } + } + } + } + } /**

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.

*/ DeleteAccountPeoplePerson: { parameters: { path: { - person: string; - }; - }; + person: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_person"]; - }; - }; + 'application/json': components['schemas']['deleted_person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ GetAccountPersons: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Filters on the list of people returned based on the person's relationship to the account's company. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - representative?: boolean; - }; + director?: boolean + executive?: boolean + owner?: boolean + representative?: boolean + } /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["person"][]; + 'application/json': { + data: components['schemas']['person'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new person.

*/ PostAccountPersons: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { - account?: string; + 'application/x-www-form-urlencoded': { + account?: string /** * address_specs * @description The person's address. */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** @description The person's date of birth. */ dob?: Partial<{ - day: number; - month: number; - year: number; + day: number + month: number + year: number }> & - Partial<"">; + Partial<''> /** * person_documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -16268,65 +16075,65 @@ export interface operations { documents?: { /** documents_param */ company_authorization?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ passport?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ visa?: { - files?: string[]; - }; - }; + files?: string[] + } + } /** @description The person's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The person's first name. */ - first_name?: string; + first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - first_name_kana?: string; + first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - first_name_kanji?: string; + first_name_kanji?: string /** @description A list of alternate names or aliases that the person is known by. */ - full_name_aliases?: Partial & Partial<"">; + full_name_aliases?: Partial & Partial<''> /** @description The person's gender (International regulations require either "male" or "female"). */ - gender?: string; + gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ - id_number?: string; + id_number?: string /** @description The person's last name. */ - last_name?: string; + last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - last_name_kana?: string; + last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - last_name_kanji?: string; + last_name_kanji?: string /** @description The person's maiden name. */ - maiden_name?: string; + maiden_name?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ - nationality?: string; + nationality?: string /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - person_token?: string; + person_token?: string /** @description The person's phone number. */ - phone?: string; + phone?: string /** @description 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?: string; + political_exposure?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - percent_ownership?: Partial & Partial<"">; - representative?: boolean; - title?: string; - }; + director?: boolean + executive?: boolean + owner?: boolean + percent_ownership?: Partial & Partial<''> + representative?: boolean + title?: string + } /** @description The last four digits of the person's Social Security number (U.S. only). */ - ssn_last_4?: string; + ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -16334,120 +16141,120 @@ export interface operations { verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; - }; - }; - }; + back?: string + front?: string + } + } + } + } + } + } /**

Retrieves an existing person.

*/ GetAccountPersonsPerson: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - person: string; - }; - }; + person: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates an existing person.

*/ PostAccountPersonsPerson: { parameters: { path: { - person: string; - }; - }; + person: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { - account?: string; + 'application/x-www-form-urlencoded': { + account?: string /** * address_specs * @description The person's address. */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** @description The person's date of birth. */ dob?: Partial<{ - day: number; - month: number; - year: number; + day: number + month: number + year: number }> & - Partial<"">; + Partial<''> /** * person_documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -16455,65 +16262,65 @@ export interface operations { documents?: { /** documents_param */ company_authorization?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ passport?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ visa?: { - files?: string[]; - }; - }; + files?: string[] + } + } /** @description The person's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The person's first name. */ - first_name?: string; + first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - first_name_kana?: string; + first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - first_name_kanji?: string; + first_name_kanji?: string /** @description A list of alternate names or aliases that the person is known by. */ - full_name_aliases?: Partial & Partial<"">; + full_name_aliases?: Partial & Partial<''> /** @description The person's gender (International regulations require either "male" or "female"). */ - gender?: string; + gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ - id_number?: string; + id_number?: string /** @description The person's last name. */ - last_name?: string; + last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - last_name_kana?: string; + last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - last_name_kanji?: string; + last_name_kanji?: string /** @description The person's maiden name. */ - maiden_name?: string; + maiden_name?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ - nationality?: string; + nationality?: string /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - person_token?: string; + person_token?: string /** @description The person's phone number. */ - phone?: string; + phone?: string /** @description 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?: string; + political_exposure?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - percent_ownership?: Partial & Partial<"">; - representative?: boolean; - title?: string; - }; + director?: boolean + executive?: boolean + owner?: boolean + percent_ownership?: Partial & Partial<''> + representative?: boolean + title?: string + } /** @description The last four digits of the person's Social Security number (U.S. only). */ - ssn_last_4?: string; + ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -16521,139 +16328,139 @@ export interface operations { verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; - }; - }; - }; + back?: string + front?: string + } + } + } + } + } + } /**

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.

*/ DeleteAccountPersonsPerson: { parameters: { path: { - person: string; - }; - }; + person: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_person"]; - }; - }; + 'application/json': components['schemas']['deleted_person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostAccountLinks: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["account_link"]; - }; - }; + 'application/json': components['schemas']['account_link'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The identifier of the account to create an account link for. */ - account: string; + account: string /** * @description Which information the platform needs to collect from the user. One of `currently_due` or `eventually_due`. Default is `currently_due`. * @enum {string} */ - collect?: "currently_due" | "eventually_due"; + collect?: 'currently_due' | 'eventually_due' /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The URL the user will be redirected to if the account link is expired, has been previously-visited, or is otherwise invalid. The URL you specify should attempt to generate a new account link with the same parameters used to create the original account link, then redirect the user to the new account link's URL so they can continue with Connect Onboarding. If a new account link cannot be generated or the redirect fails you should display a useful error to the user. */ - refresh_url?: string; + refresh_url?: string /** @description The URL that the user will be redirected to upon leaving or completing the linked flow. */ - return_url?: string; + return_url?: string /** * @description The type of account link the user is requesting. Possible values are `account_onboarding` or `account_update`. * @enum {string} */ - type: "account_onboarding" | "account_update"; - }; - }; - }; - }; + type: 'account_onboarding' | 'account_update' + } + } + } + } /**

Returns a list of accounts connected to your platform via Connect. If you’re not a platform, the list is empty.

*/ GetAccounts: { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["account"][]; + 'application/json': { + data: components['schemas']['account'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

With Connect, you can create Stripe accounts for your users. * To do this, you’ll first need to register your platform.

@@ -16663,63 +16470,63 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["account"]; - }; - }; + 'application/json': components['schemas']['account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account. */ - account_token?: string; + account_token?: string /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ bank_account?: Partial<{ - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; + account_holder_type?: 'company' | 'individual' + account_number: string /** @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; - country: string; - currency?: string; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' + country: string + currency?: string /** @enum {string} */ - object?: "bank_account"; - routing_number?: string; + object?: 'bank_account' + routing_number?: string }> & - Partial; + Partial /** * business_profile_specs * @description Business information about the account. */ business_profile?: { - mcc?: string; - name?: string; - product_description?: string; + mcc?: string + name?: string + product_description?: string /** address_specs */ support_address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - support_email?: string; - support_phone?: string; - support_url?: Partial & Partial<"">; - url?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + support_email?: string + support_phone?: string + support_url?: Partial & Partial<''> + url?: string + } /** * @description The business type. * @enum {string} */ - business_type?: "company" | "government_entity" | "individual" | "non_profit"; + business_type?: 'company' | 'government_entity' | 'individual' | 'non_profit' /** * capabilities_param * @description Each key of the dictionary represents a capability, and each capability maps to its settings (e.g. whether it has been requested or not). Each capability will be inactive until you have provided its specific requirements and Stripe has verified them. An account may have some of its requested capabilities be active and some be inactive. @@ -16727,101 +16534,101 @@ export interface operations { capabilities?: { /** capability_param */ acss_debit_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ afterpay_clearpay_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ au_becs_debit_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ bacs_debit_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ bancontact_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ boleto_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ card_issuing?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ card_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ cartes_bancaires_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ eps_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ fpx_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ giropay_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ grabpay_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ ideal_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ jcb_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ klarna_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ legacy_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ oxxo_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ p24_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ sepa_debit_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ sofort_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ tax_reporting_us_1099_k?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ tax_reporting_us_1099_misc?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ transfers?: { - requested?: boolean; - }; - }; + requested?: boolean + } + } /** * company_specs * @description Information about the company or business. This field is available for any `business_type`. @@ -16829,87 +16636,87 @@ export interface operations { company?: { /** address_specs */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** japan_address_kana_specs */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** japan_address_kanji_specs */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; - directors_provided?: boolean; - executives_provided?: boolean; - name?: string; - name_kana?: string; - name_kanji?: string; - owners_provided?: boolean; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } + directors_provided?: boolean + executives_provided?: boolean + name?: string + name_kana?: string + name_kanji?: string + owners_provided?: boolean /** company_ownership_declaration */ ownership_declaration?: { /** Format: unix-time */ - date?: number; - ip?: string; - user_agent?: string; - }; - phone?: string; - registration_number?: string; + date?: number + ip?: string + user_agent?: string + } + phone?: string + registration_number?: string /** @enum {string} */ structure?: - | "" - | "free_zone_establishment" - | "free_zone_llc" - | "government_instrumentality" - | "governmental_unit" - | "incorporated_non_profit" - | "limited_liability_partnership" - | "llc" - | "multi_member_llc" - | "private_company" - | "private_corporation" - | "private_partnership" - | "public_company" - | "public_corporation" - | "public_partnership" - | "single_member_llc" - | "sole_establishment" - | "sole_proprietorship" - | "tax_exempt_government_instrumentality" - | "unincorporated_association" - | "unincorporated_non_profit"; - tax_id?: string; - tax_id_registrar?: string; - vat_id?: string; + | '' + | 'free_zone_establishment' + | 'free_zone_llc' + | 'government_instrumentality' + | 'governmental_unit' + | 'incorporated_non_profit' + | 'limited_liability_partnership' + | 'llc' + | 'multi_member_llc' + | 'private_company' + | 'private_corporation' + | 'private_partnership' + | 'public_company' + | 'public_corporation' + | 'public_partnership' + | 'single_member_llc' + | 'sole_establishment' + | 'sole_proprietorship' + | 'tax_exempt_government_instrumentality' + | 'unincorporated_association' + | 'unincorporated_non_profit' + tax_id?: string + tax_id_registrar?: string + vat_id?: string /** verification_specs */ verification?: { /** verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; + back?: string + front?: string + } + } + } /** @description The country in which the account holder resides, or in which the business is legally established. This should be an ISO 3166-1 alpha-2 country code. For example, if you are in the United States and the business for which you're creating an account is legally represented in Canada, you would use `CA` as the country for the account being created. */ - country?: string; + country?: string /** @description 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?: string; + default_currency?: string /** * documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -16917,39 +16724,39 @@ export interface operations { documents?: { /** documents_param */ bank_account_ownership_verification?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ company_license?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ company_memorandum_of_association?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ company_ministerial_decree?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ company_registration_verification?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ company_tax_id_verification?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ proof_of_registration?: { - files?: string[]; - }; - }; + files?: string[] + } + } /** @description The email address of the account holder. This is only to make the account easier to identify to you. Stripe only emails Custom accounts with your consent. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A card or bank account to attach to the account for receiving [payouts](https://stripe.com/docs/connect/bank-debit-card-payouts) (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://stripe.com/docs/api#account_create_bank_account) creation.

By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the bank account or card creation API. */ - external_account?: string; + external_account?: string /** * individual_specs * @description Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. @@ -16957,71 +16764,71 @@ export interface operations { individual?: { /** address_specs */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** japan_address_kana_specs */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** japan_address_kanji_specs */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } dob?: Partial<{ - day: number; - month: number; - year: number; + day: number + month: number + year: number }> & - Partial<"">; - email?: string; - first_name?: string; - first_name_kana?: string; - first_name_kanji?: string; - full_name_aliases?: Partial & Partial<"">; - gender?: string; - id_number?: string; - last_name?: string; - last_name_kana?: string; - last_name_kanji?: string; - maiden_name?: string; - metadata?: Partial<{ [key: string]: string }> & Partial<"">; - phone?: string; + Partial<''> + email?: string + first_name?: string + first_name_kana?: string + first_name_kanji?: string + full_name_aliases?: Partial & Partial<''> + gender?: string + id_number?: string + last_name?: string + last_name_kana?: string + last_name_kanji?: string + maiden_name?: string + metadata?: Partial<{ [key: string]: string }> & Partial<''> + phone?: string /** @enum {string} */ - political_exposure?: "existing" | "none"; - ssn_last_4?: string; + political_exposure?: 'existing' | 'none' + ssn_last_4?: string /** person_verification_specs */ verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; + back?: string + front?: string + } + } + } /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** * settings_specs * @description Options for customizing how the account functions within Stripe. @@ -17029,102 +16836,102 @@ export interface operations { settings?: { /** branding_settings_specs */ branding?: { - icon?: string; - logo?: string; - primary_color?: string; - secondary_color?: string; - }; + icon?: string + logo?: string + primary_color?: string + secondary_color?: string + } /** card_issuing_settings_specs */ card_issuing?: { /** settings_terms_of_service_specs */ tos_acceptance?: { /** Format: unix-time */ - date?: number; - ip?: string; - user_agent?: string; - }; - }; + date?: number + ip?: string + user_agent?: string + } + } /** card_payments_settings_specs */ card_payments?: { /** decline_charge_on_specs */ decline_on?: { - avs_failure?: boolean; - cvc_failure?: boolean; - }; - statement_descriptor_prefix?: string; - }; + avs_failure?: boolean + cvc_failure?: boolean + } + statement_descriptor_prefix?: string + } /** payments_settings_specs */ payments?: { - statement_descriptor?: string; - statement_descriptor_kana?: string; - statement_descriptor_kanji?: string; - }; + statement_descriptor?: string + statement_descriptor_kana?: string + statement_descriptor_kanji?: string + } /** payout_settings_specs */ payouts?: { - debit_negative_balances?: boolean; + debit_negative_balances?: boolean /** transfer_schedule_specs */ schedule?: { - delay_days?: Partial<"minimum"> & Partial; + delay_days?: Partial<'minimum'> & Partial /** @enum {string} */ - interval?: "daily" | "manual" | "monthly" | "weekly"; - monthly_anchor?: number; + interval?: 'daily' | 'manual' | 'monthly' | 'weekly' + monthly_anchor?: number /** @enum {string} */ - weekly_anchor?: "friday" | "monday" | "saturday" | "sunday" | "thursday" | "tuesday" | "wednesday"; - }; - statement_descriptor?: string; - }; - }; + weekly_anchor?: 'friday' | 'monday' | 'saturday' | 'sunday' | 'thursday' | 'tuesday' | 'wednesday' + } + statement_descriptor?: string + } + } /** * tos_acceptance_specs * @description Details on the account's acceptance of the [Stripe Services Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance). */ tos_acceptance?: { /** Format: unix-time */ - date?: number; - ip?: string; - service_agreement?: string; - user_agent?: string; - }; + date?: number + ip?: string + service_agreement?: string + user_agent?: string + } /** * @description The type of Stripe account to create. May be one of `custom`, `express` or `standard`. * @enum {string} */ - type?: "custom" | "express" | "standard"; - }; - }; - }; - }; + type?: 'custom' | 'express' | 'standard' + } + } + } + } /**

Retrieves the details of an account.

*/ GetAccountsAccount: { parameters: { path: { - account: string; - }; + account: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["account"]; - }; - }; + 'application/json': components['schemas']['account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged. Most parameters can be changed only for Custom accounts. (These are marked Custom Only below.) Parameters marked Custom and Express are not supported for Standard accounts.

* @@ -17133,70 +16940,70 @@ export interface operations { PostAccountsAccount: { parameters: { path: { - account: string; - }; - }; + account: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["account"]; - }; - }; + 'application/json': components['schemas']['account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account. */ - account_token?: string; + account_token?: string /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ bank_account?: Partial<{ - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; + account_holder_type?: 'company' | 'individual' + account_number: string /** @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; - country: string; - currency?: string; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' + country: string + currency?: string /** @enum {string} */ - object?: "bank_account"; - routing_number?: string; + object?: 'bank_account' + routing_number?: string }> & - Partial; + Partial /** * business_profile_specs * @description Business information about the account. */ business_profile?: { - mcc?: string; - name?: string; - product_description?: string; + mcc?: string + name?: string + product_description?: string /** address_specs */ support_address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - support_email?: string; - support_phone?: string; - support_url?: Partial & Partial<"">; - url?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + support_email?: string + support_phone?: string + support_url?: Partial & Partial<''> + url?: string + } /** * @description The business type. * @enum {string} */ - business_type?: "company" | "government_entity" | "individual" | "non_profit"; + business_type?: 'company' | 'government_entity' | 'individual' | 'non_profit' /** * capabilities_param * @description Each key of the dictionary represents a capability, and each capability maps to its settings (e.g. whether it has been requested or not). Each capability will be inactive until you have provided its specific requirements and Stripe has verified them. An account may have some of its requested capabilities be active and some be inactive. @@ -17204,101 +17011,101 @@ export interface operations { capabilities?: { /** capability_param */ acss_debit_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ afterpay_clearpay_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ au_becs_debit_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ bacs_debit_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ bancontact_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ boleto_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ card_issuing?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ card_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ cartes_bancaires_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ eps_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ fpx_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ giropay_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ grabpay_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ ideal_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ jcb_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ klarna_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ legacy_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ oxxo_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ p24_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ sepa_debit_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ sofort_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ tax_reporting_us_1099_k?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ tax_reporting_us_1099_misc?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ transfers?: { - requested?: boolean; - }; - }; + requested?: boolean + } + } /** * company_specs * @description Information about the company or business. This field is available for any `business_type`. @@ -17306,85 +17113,85 @@ export interface operations { company?: { /** address_specs */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** japan_address_kana_specs */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** japan_address_kanji_specs */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; - directors_provided?: boolean; - executives_provided?: boolean; - name?: string; - name_kana?: string; - name_kanji?: string; - owners_provided?: boolean; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } + directors_provided?: boolean + executives_provided?: boolean + name?: string + name_kana?: string + name_kanji?: string + owners_provided?: boolean /** company_ownership_declaration */ ownership_declaration?: { /** Format: unix-time */ - date?: number; - ip?: string; - user_agent?: string; - }; - phone?: string; - registration_number?: string; + date?: number + ip?: string + user_agent?: string + } + phone?: string + registration_number?: string /** @enum {string} */ structure?: - | "" - | "free_zone_establishment" - | "free_zone_llc" - | "government_instrumentality" - | "governmental_unit" - | "incorporated_non_profit" - | "limited_liability_partnership" - | "llc" - | "multi_member_llc" - | "private_company" - | "private_corporation" - | "private_partnership" - | "public_company" - | "public_corporation" - | "public_partnership" - | "single_member_llc" - | "sole_establishment" - | "sole_proprietorship" - | "tax_exempt_government_instrumentality" - | "unincorporated_association" - | "unincorporated_non_profit"; - tax_id?: string; - tax_id_registrar?: string; - vat_id?: string; + | '' + | 'free_zone_establishment' + | 'free_zone_llc' + | 'government_instrumentality' + | 'governmental_unit' + | 'incorporated_non_profit' + | 'limited_liability_partnership' + | 'llc' + | 'multi_member_llc' + | 'private_company' + | 'private_corporation' + | 'private_partnership' + | 'public_company' + | 'public_corporation' + | 'public_partnership' + | 'single_member_llc' + | 'sole_establishment' + | 'sole_proprietorship' + | 'tax_exempt_government_instrumentality' + | 'unincorporated_association' + | 'unincorporated_non_profit' + tax_id?: string + tax_id_registrar?: string + vat_id?: string /** verification_specs */ verification?: { /** verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; + back?: string + front?: string + } + } + } /** @description 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?: string; + default_currency?: string /** * documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -17392,39 +17199,39 @@ export interface operations { documents?: { /** documents_param */ bank_account_ownership_verification?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ company_license?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ company_memorandum_of_association?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ company_ministerial_decree?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ company_registration_verification?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ company_tax_id_verification?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ proof_of_registration?: { - files?: string[]; - }; - }; + files?: string[] + } + } /** @description The email address of the account holder. This is only to make the account easier to identify to you. Stripe only emails Custom accounts with your consent. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A card or bank account to attach to the account for receiving [payouts](https://stripe.com/docs/connect/bank-debit-card-payouts) (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://stripe.com/docs/api#account_create_bank_account) creation.

By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the bank account or card creation API. */ - external_account?: string; + external_account?: string /** * individual_specs * @description Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. @@ -17432,71 +17239,71 @@ export interface operations { individual?: { /** address_specs */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** japan_address_kana_specs */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** japan_address_kanji_specs */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } dob?: Partial<{ - day: number; - month: number; - year: number; + day: number + month: number + year: number }> & - Partial<"">; - email?: string; - first_name?: string; - first_name_kana?: string; - first_name_kanji?: string; - full_name_aliases?: Partial & Partial<"">; - gender?: string; - id_number?: string; - last_name?: string; - last_name_kana?: string; - last_name_kanji?: string; - maiden_name?: string; - metadata?: Partial<{ [key: string]: string }> & Partial<"">; - phone?: string; + Partial<''> + email?: string + first_name?: string + first_name_kana?: string + first_name_kanji?: string + full_name_aliases?: Partial & Partial<''> + gender?: string + id_number?: string + last_name?: string + last_name_kana?: string + last_name_kanji?: string + maiden_name?: string + metadata?: Partial<{ [key: string]: string }> & Partial<''> + phone?: string /** @enum {string} */ - political_exposure?: "existing" | "none"; - ssn_last_4?: string; + political_exposure?: 'existing' | 'none' + ssn_last_4?: string /** person_verification_specs */ verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; + back?: string + front?: string + } + } + } /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** * settings_specs_update * @description Options for customizing how the account functions within Stripe. @@ -17504,66 +17311,66 @@ export interface operations { settings?: { /** branding_settings_specs */ branding?: { - icon?: string; - logo?: string; - primary_color?: string; - secondary_color?: string; - }; + icon?: string + logo?: string + primary_color?: string + secondary_color?: string + } /** card_issuing_settings_specs */ card_issuing?: { /** settings_terms_of_service_specs */ tos_acceptance?: { /** Format: unix-time */ - date?: number; - ip?: string; - user_agent?: string; - }; - }; + date?: number + ip?: string + user_agent?: string + } + } /** card_payments_settings_specs */ card_payments?: { /** decline_charge_on_specs */ decline_on?: { - avs_failure?: boolean; - cvc_failure?: boolean; - }; - statement_descriptor_prefix?: string; - }; + avs_failure?: boolean + cvc_failure?: boolean + } + statement_descriptor_prefix?: string + } /** payments_settings_specs */ payments?: { - statement_descriptor?: string; - statement_descriptor_kana?: string; - statement_descriptor_kanji?: string; - }; + statement_descriptor?: string + statement_descriptor_kana?: string + statement_descriptor_kanji?: string + } /** payout_settings_specs */ payouts?: { - debit_negative_balances?: boolean; + debit_negative_balances?: boolean /** transfer_schedule_specs */ schedule?: { - delay_days?: Partial<"minimum"> & Partial; + delay_days?: Partial<'minimum'> & Partial /** @enum {string} */ - interval?: "daily" | "manual" | "monthly" | "weekly"; - monthly_anchor?: number; + interval?: 'daily' | 'manual' | 'monthly' | 'weekly' + monthly_anchor?: number /** @enum {string} */ - weekly_anchor?: "friday" | "monday" | "saturday" | "sunday" | "thursday" | "tuesday" | "wednesday"; - }; - statement_descriptor?: string; - }; - }; + weekly_anchor?: 'friday' | 'monday' | 'saturday' | 'sunday' | 'thursday' | 'tuesday' | 'wednesday' + } + statement_descriptor?: string + } + } /** * tos_acceptance_specs * @description Details on the account's acceptance of the [Stripe Services Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance). */ tos_acceptance?: { /** Format: unix-time */ - date?: number; - ip?: string; - service_agreement?: string; - user_agent?: string; - }; - }; - }; - }; - }; + date?: number + ip?: string + service_agreement?: string + user_agent?: string + } + } + } + } + } /** *

With Connect, you can delete accounts you manage.

* @@ -17574,112 +17381,112 @@ export interface operations { DeleteAccountsAccount: { parameters: { path: { - account: string; - }; - }; + account: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_account"]; - }; - }; + 'application/json': components['schemas']['deleted_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Create an external account for a given account.

*/ PostAccountsAccountBankAccounts: { parameters: { path: { - account: string; - }; - }; + account: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ bank_account?: Partial<{ - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; + account_holder_type?: 'company' | 'individual' + account_number: string /** @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; - country: string; - currency?: string; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' + country: string + currency?: string /** @enum {string} */ - object?: "bank_account"; - routing_number?: string; + object?: 'bank_account' + routing_number?: string }> & - Partial; + Partial /** @description When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency. */ - default_for_currency?: boolean; + default_for_currency?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - external_account?: string; + external_account?: string /** @description 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?: { [key: string]: string }; - }; - }; - }; - }; + metadata?: { [key: string]: string } + } + } + } + } /**

Retrieve a specified external account for a given account.

*/ GetAccountsAccountBankAccountsId: { parameters: { path: { - account: string; - id: string; - }; + account: string + id: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

* @@ -17688,334 +17495,334 @@ export interface operations { PostAccountsAccountBankAccountsId: { parameters: { path: { - account: string; - id: string; - }; - }; + account: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The name of the person or business that owns the bank account. */ - account_holder_name?: string; + account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - account_holder_type?: "" | "company" | "individual"; + account_holder_type?: '' | 'company' | 'individual' /** * @description The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`. * @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' /** @description City/District/Suburb/Town/Village. */ - address_city?: string; + address_city?: string /** @description Billing address country, if provided when creating card. */ - address_country?: string; + address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - address_line1?: string; + address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - address_line2?: string; + address_line2?: string /** @description State/County/Province/Region. */ - address_state?: string; + address_state?: string /** @description ZIP or postal code. */ - address_zip?: string; + address_zip?: string /** @description When set to true, this becomes the default external account for its currency. */ - default_for_currency?: boolean; + default_for_currency?: boolean /** @description Two digit number representing the card’s expiration month. */ - exp_month?: string; + exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - exp_year?: string; + exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Cardholder name. */ - name?: string; - }; - }; - }; - }; + name?: string + } + } + } + } /**

Delete a specified external account for a given account.

*/ DeleteAccountsAccountBankAccountsId: { parameters: { path: { - account: string; - id: string; - }; - }; + account: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_external_account"]; - }; - }; + 'application/json': components['schemas']['deleted_external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.

*/ GetAccountsAccountCapabilities: { parameters: { path: { - account: string; - }; + account: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["capability"][]; + 'application/json': { + data: components['schemas']['capability'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves information about the specified Account Capability.

*/ GetAccountsAccountCapabilitiesCapability: { parameters: { path: { - account: string; - capability: string; - }; + account: string + capability: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["capability"]; - }; - }; + 'application/json': components['schemas']['capability'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates an existing Account Capability.

*/ PostAccountsAccountCapabilitiesCapability: { parameters: { path: { - account: string; - capability: string; - }; - }; + account: string + capability: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["capability"]; - }; - }; + 'application/json': components['schemas']['capability'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. */ - requested?: boolean; - }; - }; - }; - }; + requested?: boolean + } + } + } + } /**

List external accounts for an account.

*/ GetAccountsAccountExternalAccounts: { parameters: { path: { - account: string; - }; + account: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards. */ - data: (Partial & Partial)[]; + data: (Partial & Partial)[] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Create an external account for a given account.

*/ PostAccountsAccountExternalAccounts: { parameters: { path: { - account: string; - }; - }; + account: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ bank_account?: Partial<{ - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; + account_holder_type?: 'company' | 'individual' + account_number: string /** @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; - country: string; - currency?: string; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' + country: string + currency?: string /** @enum {string} */ - object?: "bank_account"; - routing_number?: string; + object?: 'bank_account' + routing_number?: string }> & - Partial; + Partial /** @description When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency. */ - default_for_currency?: boolean; + default_for_currency?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - external_account?: string; + external_account?: string /** @description 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?: { [key: string]: string }; - }; - }; - }; - }; + metadata?: { [key: string]: string } + } + } + } + } /**

Retrieve a specified external account for a given account.

*/ GetAccountsAccountExternalAccountsId: { parameters: { path: { - account: string; - id: string; - }; + account: string + id: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

* @@ -18024,95 +17831,95 @@ export interface operations { PostAccountsAccountExternalAccountsId: { parameters: { path: { - account: string; - id: string; - }; - }; + account: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The name of the person or business that owns the bank account. */ - account_holder_name?: string; + account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - account_holder_type?: "" | "company" | "individual"; + account_holder_type?: '' | 'company' | 'individual' /** * @description The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`. * @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' /** @description City/District/Suburb/Town/Village. */ - address_city?: string; + address_city?: string /** @description Billing address country, if provided when creating card. */ - address_country?: string; + address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - address_line1?: string; + address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - address_line2?: string; + address_line2?: string /** @description State/County/Province/Region. */ - address_state?: string; + address_state?: string /** @description ZIP or postal code. */ - address_zip?: string; + address_zip?: string /** @description When set to true, this becomes the default external account for its currency. */ - default_for_currency?: boolean; + default_for_currency?: boolean /** @description Two digit number representing the card’s expiration month. */ - exp_month?: string; + exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - exp_year?: string; + exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Cardholder name. */ - name?: string; - }; - }; - }; - }; + name?: string + } + } + } + } /**

Delete a specified external account for a given account.

*/ DeleteAccountsAccountExternalAccountsId: { parameters: { path: { - account: string; - id: string; - }; - }; + account: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_external_account"]; - }; - }; + 'application/json': components['schemas']['deleted_external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Creates a single-use login link for an Express account to access their Stripe dashboard.

* @@ -18121,158 +17928,158 @@ export interface operations { PostAccountsAccountLoginLinks: { parameters: { path: { - account: string; - }; - }; + account: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["login_link"]; - }; - }; + 'application/json': components['schemas']['login_link'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Where to redirect the user after they log out of their dashboard. */ - redirect_url?: string; - }; - }; - }; - }; + redirect_url?: string + } + } + } + } /**

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.

*/ GetAccountsAccountPeople: { parameters: { path: { - account: string; - }; + account: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Filters on the list of people returned based on the person's relationship to the account's company. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - representative?: boolean; - }; + director?: boolean + executive?: boolean + owner?: boolean + representative?: boolean + } /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["person"][]; + 'application/json': { + data: components['schemas']['person'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new person.

*/ PostAccountsAccountPeople: { parameters: { path: { - account: string; - }; - }; + account: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * address_specs * @description The person's address. */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** @description The person's date of birth. */ dob?: Partial<{ - day: number; - month: number; - year: number; + day: number + month: number + year: number }> & - Partial<"">; + Partial<''> /** * person_documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -18280,65 +18087,65 @@ export interface operations { documents?: { /** documents_param */ company_authorization?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ passport?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ visa?: { - files?: string[]; - }; - }; + files?: string[] + } + } /** @description The person's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The person's first name. */ - first_name?: string; + first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - first_name_kana?: string; + first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - first_name_kanji?: string; + first_name_kanji?: string /** @description A list of alternate names or aliases that the person is known by. */ - full_name_aliases?: Partial & Partial<"">; + full_name_aliases?: Partial & Partial<''> /** @description The person's gender (International regulations require either "male" or "female"). */ - gender?: string; + gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ - id_number?: string; + id_number?: string /** @description The person's last name. */ - last_name?: string; + last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - last_name_kana?: string; + last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - last_name_kanji?: string; + last_name_kanji?: string /** @description The person's maiden name. */ - maiden_name?: string; + maiden_name?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ - nationality?: string; + nationality?: string /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - person_token?: string; + person_token?: string /** @description The person's phone number. */ - phone?: string; + phone?: string /** @description 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?: string; + political_exposure?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - percent_ownership?: Partial & Partial<"">; - representative?: boolean; - title?: string; - }; + director?: boolean + executive?: boolean + owner?: boolean + percent_ownership?: Partial & Partial<''> + representative?: boolean + title?: string + } /** @description The last four digits of the person's Social Security number (U.S. only). */ - ssn_last_4?: string; + ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -18346,121 +18153,121 @@ export interface operations { verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; - }; - }; - }; + back?: string + front?: string + } + } + } + } + } + } /**

Retrieves an existing person.

*/ GetAccountsAccountPeoplePerson: { parameters: { path: { - account: string; - person: string; - }; + account: string + person: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates an existing person.

*/ PostAccountsAccountPeoplePerson: { parameters: { path: { - account: string; - person: string; - }; - }; + account: string + person: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * address_specs * @description The person's address. */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** @description The person's date of birth. */ dob?: Partial<{ - day: number; - month: number; - year: number; + day: number + month: number + year: number }> & - Partial<"">; + Partial<''> /** * person_documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -18468,65 +18275,65 @@ export interface operations { documents?: { /** documents_param */ company_authorization?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ passport?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ visa?: { - files?: string[]; - }; - }; + files?: string[] + } + } /** @description The person's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The person's first name. */ - first_name?: string; + first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - first_name_kana?: string; + first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - first_name_kanji?: string; + first_name_kanji?: string /** @description A list of alternate names or aliases that the person is known by. */ - full_name_aliases?: Partial & Partial<"">; + full_name_aliases?: Partial & Partial<''> /** @description The person's gender (International regulations require either "male" or "female"). */ - gender?: string; + gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ - id_number?: string; + id_number?: string /** @description The person's last name. */ - last_name?: string; + last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - last_name_kana?: string; + last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - last_name_kanji?: string; + last_name_kanji?: string /** @description The person's maiden name. */ - maiden_name?: string; + maiden_name?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ - nationality?: string; + nationality?: string /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - person_token?: string; + person_token?: string /** @description The person's phone number. */ - phone?: string; + phone?: string /** @description 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?: string; + political_exposure?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - percent_ownership?: Partial & Partial<"">; - representative?: boolean; - title?: string; - }; + director?: boolean + executive?: boolean + owner?: boolean + percent_ownership?: Partial & Partial<''> + representative?: boolean + title?: string + } /** @description The last four digits of the person's Social Security number (U.S. only). */ - ssn_last_4?: string; + ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -18534,171 +18341,171 @@ export interface operations { verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; - }; - }; - }; + back?: string + front?: string + } + } + } + } + } + } /**

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.

*/ DeleteAccountsAccountPeoplePerson: { parameters: { path: { - account: string; - person: string; - }; - }; + account: string + person: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_person"]; - }; - }; + 'application/json': components['schemas']['deleted_person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ GetAccountsAccountPersons: { parameters: { path: { - account: string; - }; + account: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Filters on the list of people returned based on the person's relationship to the account's company. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - representative?: boolean; - }; + director?: boolean + executive?: boolean + owner?: boolean + representative?: boolean + } /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["person"][]; + 'application/json': { + data: components['schemas']['person'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new person.

*/ PostAccountsAccountPersons: { parameters: { path: { - account: string; - }; - }; + account: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * address_specs * @description The person's address. */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** @description The person's date of birth. */ dob?: Partial<{ - day: number; - month: number; - year: number; + day: number + month: number + year: number }> & - Partial<"">; + Partial<''> /** * person_documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -18706,65 +18513,65 @@ export interface operations { documents?: { /** documents_param */ company_authorization?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ passport?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ visa?: { - files?: string[]; - }; - }; + files?: string[] + } + } /** @description The person's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The person's first name. */ - first_name?: string; + first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - first_name_kana?: string; + first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - first_name_kanji?: string; + first_name_kanji?: string /** @description A list of alternate names or aliases that the person is known by. */ - full_name_aliases?: Partial & Partial<"">; + full_name_aliases?: Partial & Partial<''> /** @description The person's gender (International regulations require either "male" or "female"). */ - gender?: string; + gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ - id_number?: string; + id_number?: string /** @description The person's last name. */ - last_name?: string; + last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - last_name_kana?: string; + last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - last_name_kanji?: string; + last_name_kanji?: string /** @description The person's maiden name. */ - maiden_name?: string; + maiden_name?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ - nationality?: string; + nationality?: string /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - person_token?: string; + person_token?: string /** @description The person's phone number. */ - phone?: string; + phone?: string /** @description 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?: string; + political_exposure?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - percent_ownership?: Partial & Partial<"">; - representative?: boolean; - title?: string; - }; + director?: boolean + executive?: boolean + owner?: boolean + percent_ownership?: Partial & Partial<''> + representative?: boolean + title?: string + } /** @description The last four digits of the person's Social Security number (U.S. only). */ - ssn_last_4?: string; + ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -18772,121 +18579,121 @@ export interface operations { verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; - }; - }; - }; + back?: string + front?: string + } + } + } + } + } + } /**

Retrieves an existing person.

*/ GetAccountsAccountPersonsPerson: { parameters: { path: { - account: string; - person: string; - }; + account: string + person: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates an existing person.

*/ PostAccountsAccountPersonsPerson: { parameters: { path: { - account: string; - person: string; - }; - }; + account: string + person: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * address_specs * @description The person's address. */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** @description The person's date of birth. */ dob?: Partial<{ - day: number; - month: number; - year: number; + day: number + month: number + year: number }> & - Partial<"">; + Partial<''> /** * person_documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -18894,65 +18701,65 @@ export interface operations { documents?: { /** documents_param */ company_authorization?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ passport?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ visa?: { - files?: string[]; - }; - }; + files?: string[] + } + } /** @description The person's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The person's first name. */ - first_name?: string; + first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - first_name_kana?: string; + first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - first_name_kanji?: string; + first_name_kanji?: string /** @description A list of alternate names or aliases that the person is known by. */ - full_name_aliases?: Partial & Partial<"">; + full_name_aliases?: Partial & Partial<''> /** @description The person's gender (International regulations require either "male" or "female"). */ - gender?: string; + gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ - id_number?: string; + id_number?: string /** @description The person's last name. */ - last_name?: string; + last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - last_name_kana?: string; + last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - last_name_kanji?: string; + last_name_kanji?: string /** @description The person's maiden name. */ - maiden_name?: string; + maiden_name?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ - nationality?: string; + nationality?: string /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - person_token?: string; + person_token?: string /** @description The person's phone number. */ - phone?: string; + phone?: string /** @description 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?: string; + political_exposure?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - percent_ownership?: Partial & Partial<"">; - representative?: boolean; - title?: string; - }; + director?: boolean + executive?: boolean + owner?: boolean + percent_ownership?: Partial & Partial<''> + representative?: boolean + title?: string + } /** @description The last four digits of the person's Social Security number (U.S. only). */ - ssn_last_4?: string; + ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -18960,47 +18767,47 @@ export interface operations { verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; - }; - }; - }; + back?: string + front?: string + } + } + } + } + } + } /**

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.

*/ DeleteAccountsAccountPersonsPerson: { parameters: { path: { - account: string; - person: string; - }; - }; + account: string + person: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_person"]; - }; - }; + 'application/json': components['schemas']['deleted_person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

With Connect, you may flag accounts as suspicious.

* @@ -19009,250 +18816,250 @@ export interface operations { PostAccountsAccountReject: { parameters: { path: { - account: string; - }; - }; + account: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["account"]; - }; - }; + 'application/json': components['schemas']['account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The reason for rejecting the account. Can be `fraud`, `terms_of_service`, or `other`. */ - reason: string; - }; - }; - }; - }; + reason: string + } + } + } + } /**

List apple pay domains.

*/ GetApplePayDomains: { parameters: { query: { - domain_name?: string; + domain_name?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["apple_pay_domain"][]; + 'application/json': { + data: components['schemas']['apple_pay_domain'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Create an apple pay domain.

*/ PostApplePayDomains: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["apple_pay_domain"]; - }; - }; + 'application/json': components['schemas']['apple_pay_domain'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { - domain_name: string; + 'application/x-www-form-urlencoded': { + domain_name: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Retrieve an apple pay domain.

*/ GetApplePayDomainsDomain: { parameters: { path: { - domain: string; - }; + domain: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["apple_pay_domain"]; - }; - }; + 'application/json': components['schemas']['apple_pay_domain'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Delete an apple pay domain.

*/ DeleteApplePayDomainsDomain: { parameters: { path: { - domain: string; - }; - }; + domain: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_apple_pay_domain"]; - }; - }; + 'application/json': components['schemas']['deleted_apple_pay_domain'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ GetApplicationFees: { parameters: { query: { /** Only return application fees for the charge specified by this charge ID. */ - charge?: string; + charge?: string created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["application_fee"][]; + 'application/json': { + data: components['schemas']['application_fee'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ GetApplicationFeesFeeRefundsId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - fee: string; - id: string; - }; - }; + fee: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["fee_refund"]; - }; - }; + 'application/json': components['schemas']['fee_refund'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates the specified application fee refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

* @@ -19261,146 +19068,146 @@ export interface operations { PostApplicationFeesFeeRefundsId: { parameters: { path: { - fee: string; - id: string; - }; - }; + fee: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["fee_refund"]; - }; - }; + 'application/json': components['schemas']['fee_refund'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Retrieves the details of an application fee that your account has collected. The same information is returned when refunding the application fee.

*/ GetApplicationFeesId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["application_fee"]; - }; - }; + 'application/json': components['schemas']['application_fee'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } PostApplicationFeesIdRefund: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["application_fee"]; - }; - }; + 'application/json': components['schemas']['application_fee'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { - amount?: number; - directive?: string; + 'application/x-www-form-urlencoded': { + amount?: number + directive?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

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.

*/ GetApplicationFeesIdRefunds: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["fee_refund"][]; + data: components['schemas']['fee_refund'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Refunds an application fee that has previously been collected but not yet refunded. * Funds will be refunded to the Stripe account from which the fee was originally collected.

@@ -19415,36 +19222,36 @@ export interface operations { PostApplicationFeesIdRefunds: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["fee_refund"]; - }; - }; + 'application/json': components['schemas']['fee_refund'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A positive integer, in _%s_, representing how much of this fee to refund. Can refund only up to the remaining unrefunded amount of the fee. */ - amount?: number; + amount?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; - }; - }; - }; - }; + metadata?: { [key: string]: string } + } + } + } + } /** *

Retrieves the current account balance, based on the authentication that was used to make the request. * For a sample request, see Accounting for negative balances.

@@ -19453,29 +19260,29 @@ export interface operations { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["balance"]; - }; - }; + 'application/json': components['schemas']['balance'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

* @@ -19485,61 +19292,61 @@ export interface operations { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** 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?: string; + currency?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID. */ - payout?: string; + payout?: string /** Only returns the original transaction. */ - source?: string; + source?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `payment`, `payment_failure_refund`, `payment_refund`, `payout`, `payout_cancel`, `payout_failure`, `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?: string; - }; - }; + type?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["balance_transaction"][]; + 'application/json': { + data: components['schemas']['balance_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Retrieves the balance transaction with the given ID.

* @@ -19549,32 +19356,32 @@ export interface operations { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["balance_transaction"]; - }; - }; + 'application/json': components['schemas']['balance_transaction'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

* @@ -19584,61 +19391,61 @@ export interface operations { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** 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?: string; + currency?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID. */ - payout?: string; + payout?: string /** Only returns the original transaction. */ - source?: string; + source?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `payment`, `payment_failure_refund`, `payment_refund`, `payout`, `payout_cancel`, `payout_failure`, `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?: string; - }; - }; + type?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["balance_transaction"][]; + 'application/json': { + data: components['schemas']['balance_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Retrieves the balance transaction with the given ID.

* @@ -19648,113 +19455,113 @@ export interface operations { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["balance_transaction"]; - }; - }; + 'application/json': components['schemas']['balance_transaction'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of configurations that describe the functionality of the customer portal.

*/ GetBillingPortalConfigurations: { parameters: { query: { /** Only return configurations that are active or inactive (e.g., pass `true` to only list active configurations). */ - active?: boolean; + active?: boolean /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** Only return the default or non-default configurations (e.g., pass `true` to only list the default configuration). */ - is_default?: boolean; + is_default?: boolean /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["billing_portal.configuration"][]; + 'application/json': { + data: components['schemas']['billing_portal.configuration'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a configuration that describes the functionality and behavior of a PortalSession

*/ PostBillingPortalConfigurations: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["billing_portal.configuration"]; - }; - }; + 'application/json': components['schemas']['billing_portal.configuration'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * business_profile_create_param * @description The business information shown to customers in the portal. */ business_profile: { - headline?: string; - privacy_policy_url: string; - terms_of_service_url: string; - }; + headline?: string + privacy_policy_url: string + terms_of_service_url: string + } /** @description 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?: Partial & Partial<"">; + default_return_url?: Partial & Partial<''> /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * features_creation_param * @description Information about the features available in the portal. @@ -19762,137 +19569,137 @@ export interface operations { features: { /** customer_update_creation_param */ customer_update?: { - allowed_updates: Partial<("address" | "email" | "phone" | "shipping" | "tax_id")[]> & Partial<"">; - enabled: boolean; - }; + allowed_updates: Partial<('address' | 'email' | 'phone' | 'shipping' | 'tax_id')[]> & Partial<''> + enabled: boolean + } /** invoice_list_param */ invoice_history?: { - enabled: boolean; - }; + enabled: boolean + } /** payment_method_update_param */ payment_method_update?: { - enabled: boolean; - }; + enabled: boolean + } /** subscription_cancel_creation_param */ subscription_cancel?: { /** subscription_cancellation_reason_creation_param */ cancellation_reason?: { - enabled: boolean; + enabled: boolean options: Partial< ( - | "customer_service" - | "low_quality" - | "missing_features" - | "other" - | "switched_service" - | "too_complex" - | "too_expensive" - | "unused" + | 'customer_service' + | 'low_quality' + | 'missing_features' + | 'other' + | 'switched_service' + | 'too_complex' + | 'too_expensive' + | 'unused' )[] > & - Partial<"">; - }; - enabled: boolean; + Partial<''> + } + enabled: boolean /** @enum {string} */ - mode?: "at_period_end" | "immediately"; + mode?: 'at_period_end' | 'immediately' /** @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; - }; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' + } /** subscription_pause_param */ subscription_pause?: { - enabled?: boolean; - }; + enabled?: boolean + } /** subscription_update_creation_param */ subscription_update?: { - default_allowed_updates: Partial<("price" | "promotion_code" | "quantity")[]> & Partial<"">; - enabled: boolean; + default_allowed_updates: Partial<('price' | 'promotion_code' | 'quantity')[]> & Partial<''> + enabled: boolean products: Partial< { - prices: string[]; - product: string; + prices: string[] + product: string }[] > & - Partial<"">; + Partial<''> /** @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; - }; - }; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' + } + } /** @description 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?: { [key: string]: string }; - }; - }; - }; - }; + metadata?: { [key: string]: string } + } + } + } + } /**

Retrieves a configuration that describes the functionality of the customer portal.

*/ GetBillingPortalConfigurationsConfiguration: { parameters: { path: { - configuration: string; - }; + configuration: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["billing_portal.configuration"]; - }; - }; + 'application/json': components['schemas']['billing_portal.configuration'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates a configuration that describes the functionality of the customer portal.

*/ PostBillingPortalConfigurationsConfiguration: { parameters: { path: { - configuration: string; - }; - }; + configuration: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["billing_portal.configuration"]; - }; - }; + 'application/json': components['schemas']['billing_portal.configuration'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether the configuration is active and can be used to create portal sessions. */ - active?: boolean; + active?: boolean /** * business_profile_update_param * @description The business information shown to customers in the portal. */ business_profile?: { - headline?: string; - privacy_policy_url?: string; - terms_of_service_url?: string; - }; + headline?: string + privacy_policy_url?: string + terms_of_service_url?: string + } /** @description 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?: Partial & Partial<"">; + default_return_url?: Partial & Partial<''> /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * features_updating_param * @description Information about the features available in the portal. @@ -19900,455 +19707,455 @@ export interface operations { features?: { /** customer_update_updating_param */ customer_update?: { - allowed_updates?: Partial<("address" | "email" | "phone" | "shipping" | "tax_id")[]> & Partial<"">; - enabled?: boolean; - }; + allowed_updates?: Partial<('address' | 'email' | 'phone' | 'shipping' | 'tax_id')[]> & Partial<''> + enabled?: boolean + } /** invoice_list_param */ invoice_history?: { - enabled: boolean; - }; + enabled: boolean + } /** payment_method_update_param */ payment_method_update?: { - enabled: boolean; - }; + enabled: boolean + } /** subscription_cancel_updating_param */ subscription_cancel?: { /** subscription_cancellation_reason_updating_param */ cancellation_reason?: { - enabled: boolean; + enabled: boolean options?: Partial< ( - | "customer_service" - | "low_quality" - | "missing_features" - | "other" - | "switched_service" - | "too_complex" - | "too_expensive" - | "unused" + | 'customer_service' + | 'low_quality' + | 'missing_features' + | 'other' + | 'switched_service' + | 'too_complex' + | 'too_expensive' + | 'unused' )[] > & - Partial<"">; - }; - enabled?: boolean; + Partial<''> + } + enabled?: boolean /** @enum {string} */ - mode?: "at_period_end" | "immediately"; + mode?: 'at_period_end' | 'immediately' /** @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; - }; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' + } /** subscription_pause_param */ subscription_pause?: { - enabled?: boolean; - }; + enabled?: boolean + } /** subscription_update_updating_param */ subscription_update?: { - default_allowed_updates?: Partial<("price" | "promotion_code" | "quantity")[]> & Partial<"">; - enabled?: boolean; + default_allowed_updates?: Partial<('price' | 'promotion_code' | 'quantity')[]> & Partial<''> + enabled?: boolean products?: Partial< { - prices: string[]; - product: string; + prices: string[] + product: string }[] > & - Partial<"">; + Partial<''> /** @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; - }; - }; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' + } + } /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Creates a session of the customer portal.

*/ PostBillingPortalSessions: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["billing_portal.session"]; - }; - }; + 'application/json': components['schemas']['billing_portal.session'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The ID of an existing [configuration](https://stripe.com/docs/api/customer_portal/configuration) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration. */ - configuration?: string; + configuration?: string /** @description The ID of an existing customer. */ - customer: string; + customer: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * @description 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. * @enum {string} */ locale?: - | "auto" - | "bg" - | "cs" - | "da" - | "de" - | "el" - | "en" - | "en-AU" - | "en-CA" - | "en-GB" - | "en-IE" - | "en-IN" - | "en-NZ" - | "en-SG" - | "es" - | "es-419" - | "et" - | "fi" - | "fil" - | "fr" - | "fr-CA" - | "hr" - | "hu" - | "id" - | "it" - | "ja" - | "ko" - | "lt" - | "lv" - | "ms" - | "mt" - | "nb" - | "nl" - | "pl" - | "pt" - | "pt-BR" - | "ro" - | "ru" - | "sk" - | "sl" - | "sv" - | "th" - | "tr" - | "vi" - | "zh" - | "zh-HK" - | "zh-TW"; + | 'auto' + | 'bg' + | 'cs' + | 'da' + | 'de' + | 'el' + | 'en' + | 'en-AU' + | 'en-CA' + | 'en-GB' + | 'en-IE' + | 'en-IN' + | 'en-NZ' + | 'en-SG' + | 'es' + | 'es-419' + | 'et' + | 'fi' + | 'fil' + | 'fr' + | 'fr-CA' + | 'hr' + | 'hu' + | 'id' + | 'it' + | 'ja' + | 'ko' + | 'lt' + | 'lv' + | 'ms' + | 'mt' + | 'nb' + | 'nl' + | 'pl' + | 'pt' + | 'pt-BR' + | 'ro' + | 'ru' + | 'sk' + | 'sl' + | 'sv' + | 'th' + | 'tr' + | 'vi' + | 'zh' + | 'zh-HK' + | 'zh-TW' /** @description The `on_behalf_of` account to use for this session. 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/charges-transfers#on-behalf-of). 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?: string; + on_behalf_of?: string /** @description The default URL to redirect customers to when they click on the portal's link to return to your website. */ - return_url?: string; - }; - }; - }; - }; + return_url?: string + } + } + } + } /**

Returns a list of your receivers. Receivers are returned sorted by creation date, with the most recently created receivers appearing first.

*/ GetBitcoinReceivers: { parameters: { query: { /** Filter for active receivers. */ - active?: boolean; + active?: boolean /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** Filter for filled receivers. */ - filled?: boolean; + filled?: boolean /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Filter for receivers with uncaptured funds. */ - uncaptured_funds?: boolean; - }; - }; + uncaptured_funds?: boolean + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["bitcoin_receiver"][]; + 'application/json': { + data: components['schemas']['bitcoin_receiver'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves the Bitcoin receiver with the given ID.

*/ GetBitcoinReceiversId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["bitcoin_receiver"]; - }; - }; + 'application/json': components['schemas']['bitcoin_receiver'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

List bitcoin transacitons for a given receiver.

*/ GetBitcoinReceiversReceiverTransactions: { parameters: { query: { /** Only return transactions for the customer specified by this customer ID. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - receiver: string; - }; - }; + receiver: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["bitcoin_transaction"][]; + data: components['schemas']['bitcoin_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

List bitcoin transacitons for a given receiver.

*/ GetBitcoinTransactions: { parameters: { query: { /** Only return transactions for the customer specified by this customer ID. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; - receiver?: string; + limit?: number + receiver?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["bitcoin_transaction"][]; + data: components['schemas']['bitcoin_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of charges you’ve previously created. The charges are returned in sorted order, with the most recent charges appearing first.

*/ GetCharges: { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** Only return charges for the customer specified by this customer ID. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return charges that were created by the PaymentIntent specified by this PaymentIntent ID. */ - payment_intent?: string; + payment_intent?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return charges for this transfer group. */ - transfer_group?: string; - }; - }; + transfer_group?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["charge"][]; + 'application/json': { + data: components['schemas']['charge'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

To charge a credit card or other payment source, you create a Charge object. If your API key is in test mode, the supplied payment source (e.g., card) won’t actually be charged, although everything else will occur as if in live mode. (Stripe assumes that the charge would have completed successfully).

*/ PostCharges: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["charge"]; - }; - }; + 'application/json': components['schemas']['charge'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description 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?: number; - application_fee?: number; + amount?: number + application_fee?: number /** @description A fee in %s that will be applied to the charge and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the `Stripe-Account` header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees). */ - application_fee_amount?: number; + application_fee_amount?: number /** @description Whether to immediately capture the charge. Defaults to `true`. When `false`, the charge issues an authorization (or pre-authorization), and will need to be [captured](https://stripe.com/docs/api#capture_charge) later. Uncaptured charges expire after a set number of days (7 by default). For more information, see the [authorizing charges and settling later](https://stripe.com/docs/charges/placing-a-hold) documentation. */ - capture?: boolean; + capture?: boolean /** @description A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js). */ card?: Partial<{ - address_city?: string; - address_country?: string; - address_line1?: string; - address_line2?: string; - address_state?: string; - address_zip?: string; - cvc?: string; - exp_month: number; - exp_year: number; - metadata?: { [key: string]: string }; - name?: string; - number: string; + address_city?: string + address_country?: string + address_line1?: string + address_line2?: string + address_state?: string + address_zip?: string + cvc?: string + exp_month: number + exp_year: number + metadata?: { [key: string]: string } + name?: string + number: string /** @enum {string} */ - object?: "card"; + object?: 'card' }> & - Partial; + Partial /** @description 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?: string; + currency?: string /** @description The ID of an existing customer that will be charged in this request. */ - customer?: string; + customer?: string /** @description An arbitrary string which you can attach to a `Charge` object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the `description` of the charge(s) that they are describing. */ - description?: string; + description?: string destination?: Partial<{ - account: string; - amount?: number; + account: string + amount?: number }> & - Partial; + Partial /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The Stripe account ID for which these funds are intended. Automatically set if you use the `destination` parameter. For details, see [Creating Separate Charges and Transfers](https://stripe.com/docs/connect/charges-transfers#on-behalf-of). */ - on_behalf_of?: string; + on_behalf_of?: string /** @description The email address to which this charge's [receipt](https://stripe.com/docs/dashboard/receipts) will be sent. The receipt will not be sent until the charge is paid, and no receipts will be sent for test mode charges. If this charge is for a [Customer](https://stripe.com/docs/api/customers/object), the email address specified here will override the customer's email address. If `receipt_email` is specified for a charge in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails). */ - receipt_email?: string; + receipt_email?: string /** * optional_fields_shipping * @description Shipping information for the charge. Helps prevent fraud on charges for physical goods. @@ -20356,111 +20163,111 @@ export interface operations { shipping?: { /** optional_fields_address */ address: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - carrier?: string; - name: string; - phone?: string; - tracking_number?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + carrier?: string + name: string + phone?: string + tracking_number?: string + } /** @description A payment source to be charged. This can be the ID of a [card](https://stripe.com/docs/api#cards) (i.e., credit or debit card), a [bank account](https://stripe.com/docs/api#bank_accounts), a [source](https://stripe.com/docs/api#sources), a [token](https://stripe.com/docs/api#tokens), or a [connected account](https://stripe.com/docs/connect/account-debits#charging-a-connected-account). For certain sources---namely, [cards](https://stripe.com/docs/api#cards), [bank accounts](https://stripe.com/docs/api#bank_accounts), and attached [sources](https://stripe.com/docs/api#sources)---you must also pass the ID of the associated customer. */ - source?: string; + source?: string /** @description For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - statement_descriptor_suffix?: string; + statement_descriptor_suffix?: string /** * transfer_data_specs * @description 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?: { - amount?: number; - destination: string; - }; + amount?: number + destination: string + } /** @description A string that identifies this transaction as part of a group. For details, see [Grouping transactions](https://stripe.com/docs/connect/charges-transfers#transfer-options). */ - transfer_group?: string; - }; - }; - }; - }; + transfer_group?: string + } + } + } + } /**

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.

*/ GetChargesCharge: { parameters: { path: { - charge: string; - }; + charge: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["charge"]; - }; - }; + 'application/json': components['schemas']['charge'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates the specified charge by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ PostChargesCharge: { parameters: { path: { - charge: string; - }; - }; + charge: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["charge"]; - }; - }; + 'application/json': components['schemas']['charge'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The ID of an existing customer that will be associated with this request. This field may only be updated if there is no existing associated customer with this charge. */ - customer?: string; + customer?: string /** @description An arbitrary string which you can attach to a charge object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the `description` of the charge(s) that they are describing. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * fraud_details * @description A set of key-value pairs you can attach to a charge giving information about its riskiness. If you believe a charge is fraudulent, include a `user_report` key with a value of `fraudulent`. If you believe a charge is safe, include a `user_report` key with a value of `safe`. Stripe will use the information you send to improve our fraud detection algorithms. */ fraud_details?: { /** @enum {string} */ - user_report: "" | "fraudulent" | "safe"; - }; + user_report: '' | 'fraudulent' | 'safe' + } /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description This is the email address that the receipt for this charge will be sent to. If this field is updated, then a new email receipt will be sent to the updated address. */ - receipt_email?: string; + receipt_email?: string /** * optional_fields_shipping * @description Shipping information for the charge. Helps prevent fraud on charges for physical goods. @@ -20468,24 +20275,24 @@ export interface operations { shipping?: { /** optional_fields_address */ address: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - carrier?: string; - name: string; - phone?: string; - tracking_number?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + carrier?: string + name: string + phone?: string + tracking_number?: string + } /** @description A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-options) for details. */ - transfer_group?: string; - }; - }; - }; - }; + transfer_group?: string + } + } + } + } /** *

Capture the payment of an existing, uncaptured, charge. This is the second half of the two-step payment flow, where first you created a charge with the capture option set to false.

* @@ -20494,179 +20301,179 @@ export interface operations { PostChargesChargeCapture: { parameters: { path: { - charge: string; - }; - }; + charge: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["charge"]; - }; - }; + 'application/json': components['schemas']['charge'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The amount to capture, which must be less than or equal to the original amount. Any additional amount will be automatically refunded. */ - amount?: number; + amount?: number /** @description An application fee to add on to this charge. */ - application_fee?: number; + application_fee?: number /** @description An application fee amount to add on to this charge, which must be less than or equal to the original amount. */ - application_fee_amount?: number; + application_fee_amount?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The email address to send this charge's receipt to. This will override the previously-specified email address for this charge, if one was set. Receipts will not be sent in test mode. */ - receipt_email?: string; + receipt_email?: string /** @description For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - statement_descriptor_suffix?: string; + statement_descriptor_suffix?: string /** * transfer_data_specs * @description 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?: { - amount?: number; - }; + amount?: number + } /** @description A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-options) for details. */ - transfer_group?: string; - }; - }; - }; - }; + transfer_group?: string + } + } + } + } /**

Retrieve a dispute for a specified charge.

*/ GetChargesChargeDispute: { parameters: { path: { - charge: string; - }; + charge: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["dispute"]; - }; - }; + 'application/json': components['schemas']['dispute'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } PostChargesChargeDispute: { parameters: { path: { - charge: string; - }; - }; + charge: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["dispute"]; - }; - }; + 'application/json': components['schemas']['dispute'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * dispute_evidence_params * @description Evidence to upload, to respond to a dispute. Updating any field in the hash will submit all fields in the hash for review. The combined character count of all fields is limited to 150,000. */ evidence?: { - access_activity_log?: string; - billing_address?: string; - cancellation_policy?: string; - cancellation_policy_disclosure?: string; - cancellation_rebuttal?: string; - customer_communication?: string; - customer_email_address?: string; - customer_name?: string; - customer_purchase_ip?: string; - customer_signature?: string; - duplicate_charge_documentation?: string; - duplicate_charge_explanation?: string; - duplicate_charge_id?: string; - product_description?: string; - receipt?: string; - refund_policy?: string; - refund_policy_disclosure?: string; - refund_refusal_explanation?: string; - service_date?: string; - service_documentation?: string; - shipping_address?: string; - shipping_carrier?: string; - shipping_date?: string; - shipping_documentation?: string; - shipping_tracking_number?: string; - uncategorized_file?: string; - uncategorized_text?: string; - }; + access_activity_log?: string + billing_address?: string + cancellation_policy?: string + cancellation_policy_disclosure?: string + cancellation_rebuttal?: string + customer_communication?: string + customer_email_address?: string + customer_name?: string + customer_purchase_ip?: string + customer_signature?: string + duplicate_charge_documentation?: string + duplicate_charge_explanation?: string + duplicate_charge_id?: string + product_description?: string + receipt?: string + refund_policy?: string + refund_policy_disclosure?: string + refund_refusal_explanation?: string + service_date?: string + service_documentation?: string + shipping_address?: string + shipping_carrier?: string + shipping_date?: string + shipping_documentation?: string + shipping_tracking_number?: string + uncategorized_file?: string + uncategorized_text?: string + } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Whether to immediately submit evidence to the bank. If `false`, evidence is staged on the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank by making another request with this attribute set to `true` (the default). */ - submit?: boolean; - }; - }; - }; - }; + submit?: boolean + } + } + } + } PostChargesChargeDisputeClose: { parameters: { path: { - charge: string; - }; - }; + charge: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["dispute"]; - }; - }; + 'application/json': components['schemas']['dispute'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /** *

When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.

* @@ -20683,259 +20490,259 @@ export interface operations { PostChargesChargeRefund: { parameters: { path: { - charge: string; - }; - }; + charge: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["charge"]; - }; - }; + 'application/json': components['schemas']['charge'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { - amount?: number; + 'application/x-www-form-urlencoded': { + amount?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - payment_intent?: string; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + payment_intent?: string /** @enum {string} */ - reason?: "duplicate" | "fraudulent" | "requested_by_customer"; - refund_application_fee?: boolean; - reverse_transfer?: boolean; - }; - }; - }; - }; + reason?: 'duplicate' | 'fraudulent' | 'requested_by_customer' + refund_application_fee?: boolean + reverse_transfer?: boolean + } + } + } + } /**

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.

*/ GetChargesChargeRefunds: { parameters: { path: { - charge: string; - }; + charge: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["refund"][]; + data: components['schemas']['refund'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Create a refund.

*/ PostChargesChargeRefunds: { parameters: { path: { - charge: string; - }; - }; + charge: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["refund"]; - }; - }; + 'application/json': components['schemas']['refund'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { - amount?: number; + 'application/x-www-form-urlencoded': { + amount?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - payment_intent?: string; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + payment_intent?: string /** @enum {string} */ - reason?: "duplicate" | "fraudulent" | "requested_by_customer"; - refund_application_fee?: boolean; - reverse_transfer?: boolean; - }; - }; - }; - }; + reason?: 'duplicate' | 'fraudulent' | 'requested_by_customer' + refund_application_fee?: boolean + reverse_transfer?: boolean + } + } + } + } /**

Retrieves the details of an existing refund.

*/ GetChargesChargeRefundsRefund: { parameters: { path: { - charge: string; - refund: string; - }; + charge: string + refund: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["refund"]; - }; - }; + 'application/json': components['schemas']['refund'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Update a specified refund.

*/ PostChargesChargeRefundsRefund: { parameters: { path: { - charge: string; - refund: string; - }; - }; + charge: string + refund: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["refund"]; - }; - }; + 'application/json': components['schemas']['refund'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - metadata?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + expand?: string[] + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Returns a list of Checkout Sessions.

*/ GetCheckoutSessions: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return the Checkout Session for the PaymentIntent specified. */ - payment_intent?: string; + payment_intent?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return the Checkout Session for the subscription specified. */ - subscription?: string; - }; - }; + subscription?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["checkout.session"][]; + 'application/json': { + data: components['schemas']['checkout.session'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a Session object.

*/ PostCheckoutSessions: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["checkout.session"]; - }; - }; + 'application/json': components['schemas']['checkout.session'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * after_expiration_params * @description Configure actions after a Checkout Session has expired. @@ -20943,40 +20750,40 @@ export interface operations { after_expiration?: { /** recovery_params */ recovery?: { - allow_promotion_codes?: boolean; - enabled: boolean; - }; - }; + allow_promotion_codes?: boolean + enabled: boolean + } + } /** @description Enables user redeemable promotion codes. */ - allow_promotion_codes?: boolean; + allow_promotion_codes?: boolean /** * automatic_tax_params * @description Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions. */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** * @description Specify whether Checkout should collect the customer's billing address. * @enum {string} */ - billing_address_collection?: "auto" | "required"; + billing_address_collection?: 'auto' | 'required' /** @description The URL the customer will be directed to if they decide to cancel payment and return to your website. */ - cancel_url: string; + cancel_url: string /** * @description A unique string to reference the Checkout Session. This can be a * customer ID, a cart ID, or similar, and can be used to reconcile the * session with your internal systems. */ - client_reference_id?: string; + client_reference_id?: string /** * consent_collection_params * @description Configure fields for the Checkout Session to gather active consent from customers. */ consent_collection?: { /** @enum {string} */ - promotions?: "auto"; - }; + promotions?: 'auto' + } /** * @description ID of an existing Customer, if one exists. In `payment` mode, the customer’s most recent card * payment method will be used to prefill the email, name, card details, and billing address @@ -20990,7 +20797,7 @@ export interface operations { * * You can set [`payment_intent_data.setup_future_usage`](https://stripe.com/docs/api/checkout/sessions/create#create_checkout_session-payment_intent_data-setup_future_usage) to have Checkout automatically attach the payment method to the Customer you pass in for future reuse. */ - customer?: string; + customer?: string /** * @description Configure whether a Checkout Session creates a [Customer](https://stripe.com/docs/api/customers) during Session confirmation. * @@ -21002,7 +20809,7 @@ export interface operations { * Can only be set in `payment` and `setup` mode. * @enum {string} */ - customer_creation?: "always" | "if_required"; + customer_creation?: 'always' | 'if_required' /** * @description 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. @@ -21010,31 +20817,31 @@ export interface operations { * on file. To access information about the customer once a session is * complete, use the `customer` field. */ - customer_email?: string; + customer_email?: string /** * customer_update_params * @description Controls what fields on Customer can be updated by the Checkout Session. Can only be provided when `customer` is provided. */ customer_update?: { /** @enum {string} */ - address?: "auto" | "never"; + address?: 'auto' | 'never' /** @enum {string} */ - name?: "auto" | "never"; + name?: 'auto' | 'never' /** @enum {string} */ - shipping?: "auto" | "never"; - }; + shipping?: 'auto' | 'never' + } /** @description The coupon or promotion code to apply to this Session. Currently, only up to one may be specified. */ discounts?: { - coupon?: string; - promotion_code?: string; - }[]; + coupon?: string + promotion_code?: string + }[] /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * Format: unix-time * @description The Epoch time in seconds at which the Checkout Session will expire. It can be anywhere from 1 to 24 hours after Checkout Session creation. By default, this value is 24 hours from creation. */ - expires_at?: number; + expires_at?: number /** * @description A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices). * @@ -21045,132 +20852,132 @@ export interface operations { line_items?: { /** adjustable_quantity_params */ adjustable_quantity?: { - enabled: boolean; - maximum?: number; - minimum?: number; - }; - description?: string; - dynamic_tax_rates?: string[]; - price?: string; + enabled: boolean + maximum?: number + minimum?: number + } + description?: string + dynamic_tax_rates?: string[] + price?: string /** price_data_with_product_data */ price_data?: { - currency: string; - product?: string; + currency: string + product?: string /** product_data */ product_data?: { - description?: string; - images?: string[]; - metadata?: { [key: string]: string }; - name: string; - tax_code?: string; - }; + description?: string + images?: string[] + metadata?: { [key: string]: string } + name: string + tax_code?: string + } /** recurring_adhoc */ recurring?: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: string[]; - }[]; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: string[] + }[] /** * @description The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used. * @enum {string} */ locale?: - | "auto" - | "bg" - | "cs" - | "da" - | "de" - | "el" - | "en" - | "en-GB" - | "es" - | "es-419" - | "et" - | "fi" - | "fil" - | "fr" - | "fr-CA" - | "hr" - | "hu" - | "id" - | "it" - | "ja" - | "ko" - | "lt" - | "lv" - | "ms" - | "mt" - | "nb" - | "nl" - | "pl" - | "pt" - | "pt-BR" - | "ro" - | "ru" - | "sk" - | "sl" - | "sv" - | "th" - | "tr" - | "vi" - | "zh" - | "zh-HK" - | "zh-TW"; + | 'auto' + | 'bg' + | 'cs' + | 'da' + | 'de' + | 'el' + | 'en' + | 'en-GB' + | 'es' + | 'es-419' + | 'et' + | 'fi' + | 'fil' + | 'fr' + | 'fr-CA' + | 'hr' + | 'hu' + | 'id' + | 'it' + | 'ja' + | 'ko' + | 'lt' + | 'lv' + | 'ms' + | 'mt' + | 'nb' + | 'nl' + | 'pl' + | 'pt' + | 'pt-BR' + | 'ro' + | 'ru' + | 'sk' + | 'sl' + | 'sv' + | 'th' + | 'tr' + | 'vi' + | 'zh' + | 'zh-HK' + | 'zh-TW' /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * @description The mode of the Checkout Session. Required when using prices or `setup` mode. Pass `subscription` if the Checkout Session includes at least one recurring item. * @enum {string} */ - mode?: "payment" | "setup" | "subscription"; + mode?: 'payment' | 'setup' | 'subscription' /** * payment_intent_data_params * @description A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode. */ payment_intent_data?: { - application_fee_amount?: number; + application_fee_amount?: number /** @enum {string} */ - capture_method?: "automatic" | "manual"; - description?: string; - metadata?: { [key: string]: string }; - on_behalf_of?: string; - receipt_email?: string; + capture_method?: 'automatic' | 'manual' + description?: string + metadata?: { [key: string]: string } + on_behalf_of?: string + receipt_email?: string /** @enum {string} */ - setup_future_usage?: "off_session" | "on_session"; + setup_future_usage?: 'off_session' | 'on_session' /** shipping */ shipping?: { /** address */ address: { - city?: string; - country?: string; - line1: string; - line2?: string; - postal_code?: string; - state?: string; - }; - carrier?: string; - name: string; - phone?: string; - tracking_number?: string; - }; - statement_descriptor?: string; - statement_descriptor_suffix?: string; + city?: string + country?: string + line1: string + line2?: string + postal_code?: string + state?: string + } + carrier?: string + name: string + phone?: string + tracking_number?: string + } + statement_descriptor?: string + statement_descriptor_suffix?: string /** transfer_data_params */ transfer_data?: { - amount?: number; - destination: string; - }; - transfer_group?: string; - }; + amount?: number + destination: string + } + transfer_group?: string + } /** * payment_method_options_param * @description Payment-method-specific configuration. @@ -21179,35 +20986,35 @@ export interface operations { /** payment_method_options_param */ acss_debit?: { /** @enum {string} */ - currency?: "cad" | "usd"; + currency?: 'cad' | 'usd' /** mandate_options_param */ mandate_options?: { - custom_mandate_url?: Partial & Partial<"">; - default_for?: ("invoice" | "subscription")[]; - interval_description?: string; + custom_mandate_url?: Partial & Partial<''> + default_for?: ('invoice' | 'subscription')[] + interval_description?: string /** @enum {string} */ - payment_schedule?: "combined" | "interval" | "sporadic"; + payment_schedule?: 'combined' | 'interval' | 'sporadic' /** @enum {string} */ - transaction_type?: "business" | "personal"; - }; + transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; - }; + verification_method?: 'automatic' | 'instant' | 'microdeposits' + } /** payment_method_options_param */ boleto?: { - expires_after_days?: number; - }; + expires_after_days?: number + } /** payment_method_options_param */ oxxo?: { - expires_after_days?: number; - }; + expires_after_days?: number + } /** payment_method_options_param */ wechat_pay?: { - app_id?: string; + app_id?: string /** @enum {string} */ - client: "android" | "ios" | "web"; - }; - }; + client: 'android' | 'ios' | 'web' + } + } /** * @description A list of the types of payment methods (e.g., `card`) this Checkout Session can accept. * @@ -21219,26 +21026,26 @@ export interface operations { * other characteristics. */ payment_method_types?: ( - | "acss_debit" - | "afterpay_clearpay" - | "alipay" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "eps" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "klarna" - | "oxxo" - | "p24" - | "sepa_debit" - | "sofort" - | "wechat_pay" - )[]; + | 'acss_debit' + | 'afterpay_clearpay' + | 'alipay' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'eps' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'klarna' + | 'oxxo' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' + )[] /** * phone_number_collection_params * @description Controls phone number collection settings for the session. @@ -21247,265 +21054,265 @@ export interface operations { * before using this feature. Learn more about [collecting phone numbers with Checkout](https://stripe.com/docs/payments/checkout/phone-numbers). */ phone_number_collection?: { - enabled: boolean; - }; + enabled: boolean + } /** * setup_intent_data_param * @description A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in `setup` mode. */ setup_intent_data?: { - description?: string; - metadata?: { [key: string]: string }; - on_behalf_of?: string; - }; + description?: string + metadata?: { [key: string]: string } + on_behalf_of?: string + } /** * shipping_address_collection_params * @description When set, provides configuration for Checkout to collect a shipping address from a customer. */ shipping_address_collection?: { allowed_countries: ( - | "AC" - | "AD" - | "AE" - | "AF" - | "AG" - | "AI" - | "AL" - | "AM" - | "AO" - | "AQ" - | "AR" - | "AT" - | "AU" - | "AW" - | "AX" - | "AZ" - | "BA" - | "BB" - | "BD" - | "BE" - | "BF" - | "BG" - | "BH" - | "BI" - | "BJ" - | "BL" - | "BM" - | "BN" - | "BO" - | "BQ" - | "BR" - | "BS" - | "BT" - | "BV" - | "BW" - | "BY" - | "BZ" - | "CA" - | "CD" - | "CF" - | "CG" - | "CH" - | "CI" - | "CK" - | "CL" - | "CM" - | "CN" - | "CO" - | "CR" - | "CV" - | "CW" - | "CY" - | "CZ" - | "DE" - | "DJ" - | "DK" - | "DM" - | "DO" - | "DZ" - | "EC" - | "EE" - | "EG" - | "EH" - | "ER" - | "ES" - | "ET" - | "FI" - | "FJ" - | "FK" - | "FO" - | "FR" - | "GA" - | "GB" - | "GD" - | "GE" - | "GF" - | "GG" - | "GH" - | "GI" - | "GL" - | "GM" - | "GN" - | "GP" - | "GQ" - | "GR" - | "GS" - | "GT" - | "GU" - | "GW" - | "GY" - | "HK" - | "HN" - | "HR" - | "HT" - | "HU" - | "ID" - | "IE" - | "IL" - | "IM" - | "IN" - | "IO" - | "IQ" - | "IS" - | "IT" - | "JE" - | "JM" - | "JO" - | "JP" - | "KE" - | "KG" - | "KH" - | "KI" - | "KM" - | "KN" - | "KR" - | "KW" - | "KY" - | "KZ" - | "LA" - | "LB" - | "LC" - | "LI" - | "LK" - | "LR" - | "LS" - | "LT" - | "LU" - | "LV" - | "LY" - | "MA" - | "MC" - | "MD" - | "ME" - | "MF" - | "MG" - | "MK" - | "ML" - | "MM" - | "MN" - | "MO" - | "MQ" - | "MR" - | "MS" - | "MT" - | "MU" - | "MV" - | "MW" - | "MX" - | "MY" - | "MZ" - | "NA" - | "NC" - | "NE" - | "NG" - | "NI" - | "NL" - | "NO" - | "NP" - | "NR" - | "NU" - | "NZ" - | "OM" - | "PA" - | "PE" - | "PF" - | "PG" - | "PH" - | "PK" - | "PL" - | "PM" - | "PN" - | "PR" - | "PS" - | "PT" - | "PY" - | "QA" - | "RE" - | "RO" - | "RS" - | "RU" - | "RW" - | "SA" - | "SB" - | "SC" - | "SE" - | "SG" - | "SH" - | "SI" - | "SJ" - | "SK" - | "SL" - | "SM" - | "SN" - | "SO" - | "SR" - | "SS" - | "ST" - | "SV" - | "SX" - | "SZ" - | "TA" - | "TC" - | "TD" - | "TF" - | "TG" - | "TH" - | "TJ" - | "TK" - | "TL" - | "TM" - | "TN" - | "TO" - | "TR" - | "TT" - | "TV" - | "TW" - | "TZ" - | "UA" - | "UG" - | "US" - | "UY" - | "UZ" - | "VA" - | "VC" - | "VE" - | "VG" - | "VN" - | "VU" - | "WF" - | "WS" - | "XK" - | "YE" - | "YT" - | "ZA" - | "ZM" - | "ZW" - | "ZZ" - )[]; - }; + | 'AC' + | 'AD' + | 'AE' + | 'AF' + | 'AG' + | 'AI' + | 'AL' + | 'AM' + | 'AO' + | 'AQ' + | 'AR' + | 'AT' + | 'AU' + | 'AW' + | 'AX' + | 'AZ' + | 'BA' + | 'BB' + | 'BD' + | 'BE' + | 'BF' + | 'BG' + | 'BH' + | 'BI' + | 'BJ' + | 'BL' + | 'BM' + | 'BN' + | 'BO' + | 'BQ' + | 'BR' + | 'BS' + | 'BT' + | 'BV' + | 'BW' + | 'BY' + | 'BZ' + | 'CA' + | 'CD' + | 'CF' + | 'CG' + | 'CH' + | 'CI' + | 'CK' + | 'CL' + | 'CM' + | 'CN' + | 'CO' + | 'CR' + | 'CV' + | 'CW' + | 'CY' + | 'CZ' + | 'DE' + | 'DJ' + | 'DK' + | 'DM' + | 'DO' + | 'DZ' + | 'EC' + | 'EE' + | 'EG' + | 'EH' + | 'ER' + | 'ES' + | 'ET' + | 'FI' + | 'FJ' + | 'FK' + | 'FO' + | 'FR' + | 'GA' + | 'GB' + | 'GD' + | 'GE' + | 'GF' + | 'GG' + | 'GH' + | 'GI' + | 'GL' + | 'GM' + | 'GN' + | 'GP' + | 'GQ' + | 'GR' + | 'GS' + | 'GT' + | 'GU' + | 'GW' + | 'GY' + | 'HK' + | 'HN' + | 'HR' + | 'HT' + | 'HU' + | 'ID' + | 'IE' + | 'IL' + | 'IM' + | 'IN' + | 'IO' + | 'IQ' + | 'IS' + | 'IT' + | 'JE' + | 'JM' + | 'JO' + | 'JP' + | 'KE' + | 'KG' + | 'KH' + | 'KI' + | 'KM' + | 'KN' + | 'KR' + | 'KW' + | 'KY' + | 'KZ' + | 'LA' + | 'LB' + | 'LC' + | 'LI' + | 'LK' + | 'LR' + | 'LS' + | 'LT' + | 'LU' + | 'LV' + | 'LY' + | 'MA' + | 'MC' + | 'MD' + | 'ME' + | 'MF' + | 'MG' + | 'MK' + | 'ML' + | 'MM' + | 'MN' + | 'MO' + | 'MQ' + | 'MR' + | 'MS' + | 'MT' + | 'MU' + | 'MV' + | 'MW' + | 'MX' + | 'MY' + | 'MZ' + | 'NA' + | 'NC' + | 'NE' + | 'NG' + | 'NI' + | 'NL' + | 'NO' + | 'NP' + | 'NR' + | 'NU' + | 'NZ' + | 'OM' + | 'PA' + | 'PE' + | 'PF' + | 'PG' + | 'PH' + | 'PK' + | 'PL' + | 'PM' + | 'PN' + | 'PR' + | 'PS' + | 'PT' + | 'PY' + | 'QA' + | 'RE' + | 'RO' + | 'RS' + | 'RU' + | 'RW' + | 'SA' + | 'SB' + | 'SC' + | 'SE' + | 'SG' + | 'SH' + | 'SI' + | 'SJ' + | 'SK' + | 'SL' + | 'SM' + | 'SN' + | 'SO' + | 'SR' + | 'SS' + | 'ST' + | 'SV' + | 'SX' + | 'SZ' + | 'TA' + | 'TC' + | 'TD' + | 'TF' + | 'TG' + | 'TH' + | 'TJ' + | 'TK' + | 'TL' + | 'TM' + | 'TN' + | 'TO' + | 'TR' + | 'TT' + | 'TV' + | 'TW' + | 'TZ' + | 'UA' + | 'UG' + | 'US' + | 'UY' + | 'UZ' + | 'VA' + | 'VC' + | 'VE' + | 'VG' + | 'VN' + | 'VU' + | 'WF' + | 'WS' + | 'XK' + | 'YE' + | 'YT' + | 'ZA' + | 'ZM' + | 'ZW' + | 'ZZ' + )[] + } /** @description The shipping rate options to apply to this Session. */ shipping_options?: { - shipping_rate?: string; + shipping_rate?: string /** method_params */ shipping_rate_data?: { /** delivery_estimate */ @@ -21513,30 +21320,30 @@ export interface operations { /** delivery_estimate_bound */ maximum?: { /** @enum {string} */ - unit: "business_day" | "day" | "hour" | "month" | "week"; - value: number; - }; + unit: 'business_day' | 'day' | 'hour' | 'month' | 'week' + value: number + } /** delivery_estimate_bound */ minimum?: { /** @enum {string} */ - unit: "business_day" | "day" | "hour" | "month" | "week"; - value: number; - }; - }; - display_name: string; + unit: 'business_day' | 'day' | 'hour' | 'month' | 'week' + value: number + } + } + display_name: string /** fixed_amount */ fixed_amount?: { - amount: number; - currency: string; - }; - metadata?: { [key: string]: string }; + amount: number + currency: string + } + metadata?: { [key: string]: string } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - tax_code?: string; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + tax_code?: string /** @enum {string} */ - type?: "fixed_amount"; - }; - }[]; + type?: 'fixed_amount' + } + }[] /** * @description Describes the type of transaction being performed by Checkout in order to customize * relevant text on the page, such as the submit button. `submit_type` can only be @@ -21544,78 +21351,78 @@ export interface operations { * in `subscription` or `setup` mode. * @enum {string} */ - submit_type?: "auto" | "book" | "donate" | "pay"; + submit_type?: 'auto' | 'book' | 'donate' | 'pay' /** * subscription_data_params * @description A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode. */ subscription_data?: { - application_fee_percent?: number; - default_tax_rates?: string[]; + application_fee_percent?: number + default_tax_rates?: string[] items?: { - plan: string; - quantity?: number; - tax_rates?: string[]; - }[]; - metadata?: { [key: string]: string }; + plan: string + quantity?: number + tax_rates?: string[] + }[] + metadata?: { [key: string]: string } /** transfer_data_specs */ transfer_data?: { - amount_percent?: number; - destination: string; - }; + amount_percent?: number + destination: string + } /** Format: unix-time */ - trial_end?: number; - trial_period_days?: number; - }; + trial_end?: number + trial_period_days?: number + } /** * @description The URL to which Stripe should send customers when payment or setup * is complete. * If you’d like to use information from the successful Checkout Session on your page, * read the guide on [customizing your success page](https://stripe.com/docs/payments/checkout/custom-success-page). */ - success_url: string; + success_url: string /** * tax_id_collection_params * @description Controls tax ID collection settings for the session. */ tax_id_collection?: { - enabled: boolean; - }; - }; - }; - }; - }; + enabled: boolean + } + } + } + } + } /**

Retrieves a Session object.

*/ GetCheckoutSessionsSession: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - session: string; - }; - }; + session: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["checkout.session"]; - }; - }; + 'application/json': components['schemas']['checkout.session'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

A Session can be expired when it is in one of these statuses: open

* @@ -21624,210 +21431,210 @@ export interface operations { PostCheckoutSessionsSessionExpire: { parameters: { path: { - session: string; - }; - }; + session: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["checkout.session"]; - }; - }; + 'application/json': components['schemas']['checkout.session'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

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.

*/ GetCheckoutSessionsSessionLineItems: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - session: string; - }; - }; + session: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["item"][]; + data: components['schemas']['item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Lists all Country Spec objects available in the API.

*/ GetCountrySpecs: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["country_spec"][]; + 'application/json': { + data: components['schemas']['country_spec'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a Country Spec for a given Country code.

*/ GetCountrySpecsCountry: { parameters: { path: { - country: string; - }; + country: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["country_spec"]; - }; - }; + 'application/json': components['schemas']['country_spec'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of your coupons.

*/ GetCoupons: { parameters: { query: { /** 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?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["coupon"][]; + 'application/json': { + data: components['schemas']['coupon'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

You can create coupons easily via the coupon management page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.

* @@ -21838,199 +21645,199 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["coupon"]; - }; - }; + 'application/json': components['schemas']['coupon'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed). */ - amount_off?: number; + amount_off?: number /** * applies_to_params * @description A hash containing directions for what this Coupon will apply discounts to. */ applies_to?: { - products?: string[]; - }; + products?: string[] + } /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed). */ - currency?: string; + currency?: string /** * @description Specifies how long the discount will be in effect if used on a subscription. Can be `forever`, `once`, or `repeating`. Defaults to `once`. * @enum {string} */ - duration?: "forever" | "once" | "repeating"; + duration?: 'forever' | 'once' | 'repeating' /** @description Required only if `duration` is `repeating`, in which case it must be a positive integer that specifies the number of months the discount will be in effect. */ - duration_in_months?: number; + duration_in_months?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Unique string of your choice that will be used to identify this coupon when applying it to a customer. If you don't want to specify a particular code, you can leave the ID blank and we'll generate a random code for you. */ - id?: string; + id?: string /** @description A positive integer specifying the number of times the coupon can be redeemed before it's no longer valid. For example, you might have a 50% off coupon that the first 20 readers of your blog can use. */ - max_redemptions?: number; + max_redemptions?: number /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set. */ - name?: string; + name?: string /** @description A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if `amount_off` is not passed). */ - percent_off?: number; + percent_off?: number /** * Format: unix-time * @description Unix timestamp specifying the last time at which the coupon can be redeemed. After the redeem_by date, the coupon can no longer be applied to new customers. */ - redeem_by?: number; - }; - }; - }; - }; + redeem_by?: number + } + } + } + } /**

Retrieves the coupon with the given ID.

*/ GetCouponsCoupon: { parameters: { path: { - coupon: string; - }; + coupon: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["coupon"]; - }; - }; + 'application/json': components['schemas']['coupon'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.

*/ PostCouponsCoupon: { parameters: { path: { - coupon: string; - }; - }; + coupon: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["coupon"]; - }; - }; + 'application/json': components['schemas']['coupon'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set. */ - name?: string; - }; - }; - }; - }; + name?: string + } + } + } + } /**

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.

*/ DeleteCouponsCoupon: { parameters: { path: { - coupon: string; - }; - }; + coupon: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_coupon"]; - }; - }; + 'application/json': components['schemas']['deleted_coupon'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of credit notes.

*/ GetCreditNotes: { parameters: { query: { /** Only return credit notes for the customer specified by this customer ID. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** Only return credit notes for the invoice specified by this invoice ID. */ - invoice?: string; + invoice?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["credit_note"][]; + 'application/json': { + data: components['schemas']['credit_note'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces * its amount_due. For a status=paid invoice, a credit note does not affect its amount_due. Instead, it can result @@ -22052,433 +21859,433 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["credit_note"]; - }; - }; + 'application/json': components['schemas']['credit_note'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The integer amount in %s representing the total amount of the credit note. */ - amount?: number; + amount?: number /** @description The integer amount in %s representing the amount to credit the customer's balance, which will be automatically applied to their next invoice. */ - credit_amount?: number; + credit_amount?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description ID of the invoice. */ - invoice: string; + invoice: string /** @description Line items that make up the credit note. */ lines?: { - amount?: number; - description?: string; - invoice_line_item?: string; - quantity?: number; - tax_rates?: Partial & Partial<"">; + amount?: number + description?: string + invoice_line_item?: string + quantity?: number + tax_rates?: Partial & Partial<''> /** @enum {string} */ - type: "custom_line_item" | "invoice_line_item"; - unit_amount?: number; + type: 'custom_line_item' | 'invoice_line_item' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }[]; + unit_amount_decimal?: string + }[] /** @description The credit note's memo appears on the credit note PDF. */ - memo?: string; + memo?: string /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The integer amount in %s representing the amount that is credited outside of Stripe. */ - out_of_band_amount?: number; + out_of_band_amount?: number /** * @description Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` * @enum {string} */ - reason?: "duplicate" | "fraudulent" | "order_change" | "product_unsatisfactory"; + reason?: 'duplicate' | 'fraudulent' | 'order_change' | 'product_unsatisfactory' /** @description ID of an existing refund to link this credit note to. */ - refund?: string; + refund?: string /** @description The integer amount in %s representing the amount to refund. If set, a refund will be created for the charge associated with the invoice. */ - refund_amount?: number; - }; - }; - }; - }; + refund_amount?: number + } + } + } + } /**

Get a preview of a credit note without creating it.

*/ GetCreditNotesPreview: { parameters: { query: { /** The integer amount in %s representing the total amount of the credit note. */ - amount?: number; + amount?: number /** The integer amount in %s representing the amount to credit the customer's balance, which will be automatically applied to their next invoice. */ - credit_amount?: number; + credit_amount?: number /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** ID of the invoice. */ - invoice: string; + invoice: string /** Line items that make up the credit note. */ lines?: { - amount?: number; - description?: string; - invoice_line_item?: string; - quantity?: number; - tax_rates?: Partial & Partial<"">; + amount?: number + description?: string + invoice_line_item?: string + quantity?: number + tax_rates?: Partial & Partial<''> /** @enum {string} */ - type: "custom_line_item" | "invoice_line_item"; - unit_amount?: number; + type: 'custom_line_item' | 'invoice_line_item' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }[]; + unit_amount_decimal?: string + }[] /** The credit note's memo appears on the credit note PDF. */ - memo?: string; + memo?: string /** 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** The integer amount in %s representing the amount that is credited outside of Stripe. */ - out_of_band_amount?: number; + out_of_band_amount?: number /** Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` */ - reason?: "duplicate" | "fraudulent" | "order_change" | "product_unsatisfactory"; + reason?: 'duplicate' | 'fraudulent' | 'order_change' | 'product_unsatisfactory' /** ID of an existing refund to link this credit note to. */ - refund?: string; + refund?: string /** The integer amount in %s representing the amount to refund. If set, a refund will be created for the charge associated with the invoice. */ - refund_amount?: number; - }; - }; + refund_amount?: number + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["credit_note"]; - }; - }; + 'application/json': components['schemas']['credit_note'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ GetCreditNotesPreviewLines: { parameters: { query: { /** The integer amount in %s representing the total amount of the credit note. */ - amount?: number; + amount?: number /** The integer amount in %s representing the amount to credit the customer's balance, which will be automatically applied to their next invoice. */ - credit_amount?: number; + credit_amount?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** ID of the invoice. */ - invoice: string; + invoice: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Line items that make up the credit note. */ lines?: { - amount?: number; - description?: string; - invoice_line_item?: string; - quantity?: number; - tax_rates?: Partial & Partial<"">; + amount?: number + description?: string + invoice_line_item?: string + quantity?: number + tax_rates?: Partial & Partial<''> /** @enum {string} */ - type: "custom_line_item" | "invoice_line_item"; - unit_amount?: number; + type: 'custom_line_item' | 'invoice_line_item' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }[]; + unit_amount_decimal?: string + }[] /** The credit note's memo appears on the credit note PDF. */ - memo?: string; + memo?: string /** 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** The integer amount in %s representing the amount that is credited outside of Stripe. */ - out_of_band_amount?: number; + out_of_band_amount?: number /** Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` */ - reason?: "duplicate" | "fraudulent" | "order_change" | "product_unsatisfactory"; + reason?: 'duplicate' | 'fraudulent' | 'order_change' | 'product_unsatisfactory' /** ID of an existing refund to link this credit note to. */ - refund?: string; + refund?: string /** The integer amount in %s representing the amount to refund. If set, a refund will be created for the charge associated with the invoice. */ - refund_amount?: number; + refund_amount?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["credit_note_line_item"][]; + data: components['schemas']['credit_note_line_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

When retrieving a credit note, you’ll get a lines property containing the the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

*/ GetCreditNotesCreditNoteLines: { parameters: { path: { - credit_note: string; - }; + credit_note: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["credit_note_line_item"][]; + data: components['schemas']['credit_note_line_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves the credit note object with the given identifier.

*/ GetCreditNotesId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["credit_note"]; - }; - }; + 'application/json': components['schemas']['credit_note'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates an existing credit note.

*/ PostCreditNotesId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["credit_note"]; - }; - }; + 'application/json': components['schemas']['credit_note'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Credit note memo. */ - memo?: string; + memo?: string /** @description 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?: { [key: string]: string }; - }; - }; - }; - }; + metadata?: { [key: string]: string } + } + } + } + } /**

Marks a credit note as void. Learn more about voiding credit notes.

*/ PostCreditNotesIdVoid: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["credit_note"]; - }; - }; + 'application/json': components['schemas']['credit_note'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.

*/ GetCustomers: { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A case-sensitive filter on the list based on the customer's `email` field. The value must be a string. */ - email?: string; + email?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["customer"][]; + 'application/json': { + data: components['schemas']['customer'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new customer object.

*/ PostCustomers: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["customer"]; - }; - }; + 'application/json': components['schemas']['customer'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The customer's address. */ address?: Partial<{ - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string }> & - Partial<"">; + Partial<''> /** @description An integer amount in %s that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice. */ - balance?: number; - coupon?: string; + balance?: number + coupon?: string /** @description An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard. */ - description?: string; + description?: string /** @description Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers. */ - invoice_prefix?: string; + invoice_prefix?: string /** * customer_param * @description Default invoice settings for this customer. @@ -22486,139 +22293,138 @@ export interface operations { invoice_settings?: { custom_fields?: Partial< { - name: string; - value: string; + name: string + value: string }[] > & - Partial<"">; - default_payment_method?: string; - footer?: string; - }; + Partial<''> + default_payment_method?: string + footer?: string + } /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The customer's full name or business name. */ - name?: string; + name?: string /** @description The sequence to be used on the customer's next invoice. Defaults to 1. */ - next_invoice_sequence?: number; - payment_method?: string; + next_invoice_sequence?: number + payment_method?: string /** @description The customer's phone number. */ - phone?: string; + phone?: string /** @description Customer's preferred languages, ordered by preference. */ - preferred_locales?: string[]; + preferred_locales?: string[] /** @description The API ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount. */ - promotion_code?: string; + promotion_code?: string /** @description The customer's shipping information. Appears on invoices emailed to this customer. */ shipping?: Partial<{ /** optional_fields_address */ address: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - name: string; - phone?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + name: string + phone?: string }> & - Partial<"">; - source?: string; + Partial<''> + source?: string /** * tax_param * @description Tax details about the customer. */ tax?: { - ip_address?: Partial & Partial<"">; - }; + ip_address?: Partial & Partial<''> + } /** * @description The customer's tax exemption. One of `none`, `exempt`, or `reverse`. * @enum {string} */ - tax_exempt?: "" | "exempt" | "none" | "reverse"; + tax_exempt?: '' | 'exempt' | 'none' | 'reverse' /** @description The customer's tax IDs. */ tax_id_data?: { /** @enum {string} */ type: - | "ae_trn" - | "au_abn" - | "au_arn" - | "br_cnpj" - | "br_cpf" - | "ca_bn" - | "ca_gst_hst" - | "ca_pst_bc" - | "ca_pst_mb" - | "ca_pst_sk" - | "ca_qst" - | "ch_vat" - | "cl_tin" - | "es_cif" - | "eu_vat" - | "gb_vat" - | "ge_vat" - | "hk_br" - | "id_npwp" - | "il_vat" - | "in_gst" - | "is_vat" - | "jp_cn" - | "jp_rn" - | "kr_brn" - | "li_uid" - | "mx_rfc" - | "my_frp" - | "my_itn" - | "my_sst" - | "no_vat" - | "nz_gst" - | "ru_inn" - | "ru_kpp" - | "sa_vat" - | "sg_gst" - | "sg_uen" - | "th_vat" - | "tw_vat" - | "ua_vat" - | "us_ein" - | "za_vat"; - value: string; - }[]; - }; - }; - }; - }; + | 'ae_trn' + | 'au_abn' + | 'au_arn' + | 'br_cnpj' + | 'br_cpf' + | 'ca_bn' + | 'ca_gst_hst' + | 'ca_pst_bc' + | 'ca_pst_mb' + | 'ca_pst_sk' + | 'ca_qst' + | 'ch_vat' + | 'cl_tin' + | 'es_cif' + | 'eu_vat' + | 'gb_vat' + | 'ge_vat' + | 'hk_br' + | 'id_npwp' + | 'il_vat' + | 'in_gst' + | 'is_vat' + | 'jp_cn' + | 'jp_rn' + | 'kr_brn' + | 'li_uid' + | 'mx_rfc' + | 'my_frp' + | 'my_itn' + | 'my_sst' + | 'no_vat' + | 'nz_gst' + | 'ru_inn' + | 'ru_kpp' + | 'sa_vat' + | 'sg_gst' + | 'sg_uen' + | 'th_vat' + | 'tw_vat' + | 'ua_vat' + | 'us_ein' + | 'za_vat' + value: string + }[] + } + } + } + } /**

Retrieves a Customer object.

*/ GetCustomersCustomer: { parameters: { path: { - customer: string; - }; + customer: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": Partial & - Partial; - }; - }; + 'application/json': Partial & Partial + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the source parameter, that becomes the customer’s active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the source parameter: for each of the customer’s current subscriptions, if the subscription bills automatically and is in the past_due state, then the latest open invoice for the subscription with automatic collection enabled will be retried. This retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice. Changing the default_source for a customer will not trigger this behavior.

* @@ -22627,76 +22433,76 @@ export interface operations { PostCustomersCustomer: { parameters: { path: { - customer: string; - }; - }; + customer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["customer"]; - }; - }; + 'application/json': components['schemas']['customer'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The customer's address. */ address?: Partial<{ - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string }> & - Partial<"">; + Partial<''> /** @description An integer amount in %s that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice. */ - balance?: number; + balance?: number /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ bank_account?: Partial<{ - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; - country: string; - currency?: string; + account_holder_type?: 'company' | 'individual' + account_number: string + country: string + currency?: string /** @enum {string} */ - object?: "bank_account"; - routing_number?: string; + object?: 'bank_account' + routing_number?: string }> & - Partial; + Partial /** @description A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js). */ card?: Partial<{ - address_city?: string; - address_country?: string; - address_line1?: string; - address_line2?: string; - address_state?: string; - address_zip?: string; - cvc?: string; - exp_month: number; - exp_year: number; - metadata?: { [key: string]: string }; - name?: string; - number: string; + address_city?: string + address_country?: string + address_line1?: string + address_line2?: string + address_state?: string + address_zip?: string + cvc?: string + exp_month: number + exp_year: number + metadata?: { [key: string]: string } + name?: string + number: string /** @enum {string} */ - object?: "card"; + object?: 'card' }> & - Partial; - coupon?: string; + Partial + coupon?: string /** @description ID of Alipay account to make the customer's new default for invoice payments. */ - default_alipay_account?: string; + default_alipay_account?: string /** @description ID of bank account to make the customer's new default for invoice payments. */ - default_bank_account?: string; + default_bank_account?: string /** @description ID of card to make the customer's new default for invoice payments. */ - default_card?: string; + default_card?: string /** * @description If you are using payment methods created via the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method) parameter. * @@ -22704,15 +22510,15 @@ export interface operations { * * If you want to add a new payment source and make it the default, see the [source](https://stripe.com/docs/api/customers/update#update_customer-source) property. */ - default_source?: string; + default_source?: string /** @description An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard. */ - description?: string; + description?: string /** @description Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers. */ - invoice_prefix?: string; + invoice_prefix?: string /** * customer_param * @description Default invoice settings for this customer. @@ -22720,290 +22526,290 @@ export interface operations { invoice_settings?: { custom_fields?: Partial< { - name: string; - value: string; + name: string + value: string }[] > & - Partial<"">; - default_payment_method?: string; - footer?: string; - }; + Partial<''> + default_payment_method?: string + footer?: string + } /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The customer's full name or business name. */ - name?: string; + name?: string /** @description The sequence to be used on the customer's next invoice. Defaults to 1. */ - next_invoice_sequence?: number; + next_invoice_sequence?: number /** @description The customer's phone number. */ - phone?: string; + phone?: string /** @description Customer's preferred languages, ordered by preference. */ - preferred_locales?: string[]; + preferred_locales?: string[] /** @description The API ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount. */ - promotion_code?: string; + promotion_code?: string /** @description The customer's shipping information. Appears on invoices emailed to this customer. */ shipping?: Partial<{ /** optional_fields_address */ address: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - name: string; - phone?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + name: string + phone?: string }> & - Partial<"">; - source?: string; + Partial<''> + source?: string /** * tax_param * @description Tax details about the customer. */ tax?: { - ip_address?: Partial & Partial<"">; - }; + ip_address?: Partial & Partial<''> + } /** * @description The customer's tax exemption. One of `none`, `exempt`, or `reverse`. * @enum {string} */ - tax_exempt?: "" | "exempt" | "none" | "reverse"; + tax_exempt?: '' | 'exempt' | 'none' | 'reverse' /** @description Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. */ - trial_end?: Partial<"now"> & Partial; - }; - }; - }; - }; + trial_end?: Partial<'now'> & Partial + } + } + } + } /**

Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.

*/ DeleteCustomersCustomer: { parameters: { path: { - customer: string; - }; - }; + customer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_customer"]; - }; - }; + 'application/json': components['schemas']['deleted_customer'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of transactions that updated the customer’s balances.

*/ GetCustomersCustomerBalanceTransactions: { parameters: { path: { - customer: string; - }; + customer: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["customer_balance_transaction"][]; + data: components['schemas']['customer_balance_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates an immutable transaction that updates the customer’s credit balance.

*/ PostCustomersCustomerBalanceTransactions: { parameters: { path: { - customer: string; - }; - }; + customer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["customer_balance_transaction"]; - }; - }; + 'application/json': components['schemas']['customer_balance_transaction'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The integer amount in **%s** to apply to the customer's credit balance. */ - amount: number; + amount: number /** @description 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 the customer's [`currency`](https://stripe.com/docs/api/customers/object#customer_object-currency) is set, this value must match it. If the customer's `currency` is not set, it will be updated to this value. */ - currency: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Retrieves a specific customer balance transaction that updated the customer’s balances.

*/ GetCustomersCustomerBalanceTransactionsTransaction: { parameters: { path: { - customer: string; - transaction: string; - }; + customer: string + transaction: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["customer_balance_transaction"]; - }; - }; + 'application/json': components['schemas']['customer_balance_transaction'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Most credit balance transaction fields are immutable, but you may update its description and metadata.

*/ PostCustomersCustomerBalanceTransactionsTransaction: { parameters: { path: { - customer: string; - transaction: string; - }; - }; + customer: string + transaction: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["customer_balance_transaction"]; - }; - }; + 'application/json': components['schemas']['customer_balance_transaction'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

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.

*/ GetCustomersCustomerBankAccounts: { parameters: { path: { - customer: string; - }; + customer: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["bank_account"][]; + data: components['schemas']['bank_account'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

When you create a new credit card, you must specify a customer or recipient on which to create it.

* @@ -23014,241 +22820,240 @@ export interface operations { PostCustomersCustomerBankAccounts: { parameters: { path: { - customer: string; - }; - }; + customer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_source"]; - }; - }; + 'application/json': components['schemas']['payment_source'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A token returned by [Stripe.js](https://stripe.com/docs/js) representing the user’s Alipay account details. */ - alipay_account?: string; + alipay_account?: string /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ bank_account?: Partial<{ - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; - country: string; - currency?: string; + account_holder_type?: 'company' | 'individual' + account_number: string + country: string + currency?: string /** @enum {string} */ - object?: "bank_account"; - routing_number?: string; + object?: 'bank_account' + routing_number?: string }> & - Partial; + Partial /** @description A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js). */ card?: Partial<{ - address_city?: string; - address_country?: string; - address_line1?: string; - address_line2?: string; - address_state?: string; - address_zip?: string; - cvc?: string; - exp_month: number; - exp_year: number; - metadata?: { [key: string]: string }; - name?: string; - number: string; + address_city?: string + address_country?: string + address_line1?: string + address_line2?: string + address_state?: string + address_zip?: string + cvc?: string + exp_month: number + exp_year: number + metadata?: { [key: string]: string } + name?: string + number: string /** @enum {string} */ - object?: "card"; + object?: 'card' }> & - Partial; + Partial /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - source?: string; - }; - }; - }; - }; + source?: string + } + } + } + } /**

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.

*/ GetCustomersCustomerBankAccountsId: { parameters: { path: { - customer: string; - id: string; - }; + customer: string + id: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["bank_account"]; - }; - }; + 'application/json': components['schemas']['bank_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Update a specified source for a given customer.

*/ PostCustomersCustomerBankAccountsId: { parameters: { path: { - customer: string; - id: string; - }; - }; + customer: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": Partial & - Partial & - Partial; - }; - }; + 'application/json': Partial & + Partial & + Partial + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The name of the person or business that owns the bank account. */ - account_holder_name?: string; + account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - account_holder_type?: "company" | "individual"; + account_holder_type?: 'company' | 'individual' /** @description City/District/Suburb/Town/Village. */ - address_city?: string; + address_city?: string /** @description Billing address country, if provided when creating card. */ - address_country?: string; + address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - address_line1?: string; + address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - address_line2?: string; + address_line2?: string /** @description State/County/Province/Region. */ - address_state?: string; + address_state?: string /** @description ZIP or postal code. */ - address_zip?: string; + address_zip?: string /** @description Two digit number representing the card’s expiration month. */ - exp_month?: string; + exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - exp_year?: string; + exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Cardholder name. */ - name?: string; + name?: string /** owner */ owner?: { /** source_address */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - email?: string; - name?: string; - phone?: string; - }; - }; - }; - }; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + email?: string + name?: string + phone?: string + } + } + } + } + } /**

Delete a specified source for a given customer.

*/ DeleteCustomersCustomerBankAccountsId: { parameters: { path: { - customer: string; - id: string; - }; - }; + customer: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": Partial & - Partial; - }; - }; + 'application/json': Partial & Partial + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Verify a specified bank account for a given customer.

*/ PostCustomersCustomerBankAccountsIdVerify: { parameters: { path: { - customer: string; - id: string; - }; - }; + customer: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["bank_account"]; - }; - }; + 'application/json': components['schemas']['bank_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account. */ - amounts?: number[]; + amounts?: number[] /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /** *

You can see a list of the cards belonging to a customer. * Note that the 10 most recent sources are always available on the Customer object. @@ -23257,50 +23062,50 @@ export interface operations { GetCustomersCustomerCards: { parameters: { path: { - customer: string; - }; + customer: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["card"][]; + 'application/json': { + data: components['schemas']['card'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

When you create a new credit card, you must specify a customer or recipient on which to create it.

* @@ -23311,389 +23116,388 @@ export interface operations { PostCustomersCustomerCards: { parameters: { path: { - customer: string; - }; - }; + customer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_source"]; - }; - }; + 'application/json': components['schemas']['payment_source'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A token returned by [Stripe.js](https://stripe.com/docs/js) representing the user’s Alipay account details. */ - alipay_account?: string; + alipay_account?: string /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ bank_account?: Partial<{ - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; - country: string; - currency?: string; + account_holder_type?: 'company' | 'individual' + account_number: string + country: string + currency?: string /** @enum {string} */ - object?: "bank_account"; - routing_number?: string; + object?: 'bank_account' + routing_number?: string }> & - Partial; + Partial /** @description A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js). */ card?: Partial<{ - address_city?: string; - address_country?: string; - address_line1?: string; - address_line2?: string; - address_state?: string; - address_zip?: string; - cvc?: string; - exp_month: number; - exp_year: number; - metadata?: { [key: string]: string }; - name?: string; - number: string; + address_city?: string + address_country?: string + address_line1?: string + address_line2?: string + address_state?: string + address_zip?: string + cvc?: string + exp_month: number + exp_year: number + metadata?: { [key: string]: string } + name?: string + number: string /** @enum {string} */ - object?: "card"; + object?: 'card' }> & - Partial; + Partial /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - source?: string; - }; - }; - }; - }; + source?: string + } + } + } + } /**

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.

*/ GetCustomersCustomerCardsId: { parameters: { path: { - customer: string; - id: string; - }; + customer: string + id: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["card"]; - }; - }; + 'application/json': components['schemas']['card'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Update a specified source for a given customer.

*/ PostCustomersCustomerCardsId: { parameters: { path: { - customer: string; - id: string; - }; - }; + customer: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": Partial & - Partial & - Partial; - }; - }; + 'application/json': Partial & + Partial & + Partial + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The name of the person or business that owns the bank account. */ - account_holder_name?: string; + account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - account_holder_type?: "company" | "individual"; + account_holder_type?: 'company' | 'individual' /** @description City/District/Suburb/Town/Village. */ - address_city?: string; + address_city?: string /** @description Billing address country, if provided when creating card. */ - address_country?: string; + address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - address_line1?: string; + address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - address_line2?: string; + address_line2?: string /** @description State/County/Province/Region. */ - address_state?: string; + address_state?: string /** @description ZIP or postal code. */ - address_zip?: string; + address_zip?: string /** @description Two digit number representing the card’s expiration month. */ - exp_month?: string; + exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - exp_year?: string; + exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Cardholder name. */ - name?: string; + name?: string /** owner */ owner?: { /** source_address */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - email?: string; - name?: string; - phone?: string; - }; - }; - }; - }; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + email?: string + name?: string + phone?: string + } + } + } + } + } /**

Delete a specified source for a given customer.

*/ DeleteCustomersCustomerCardsId: { parameters: { path: { - customer: string; - id: string; - }; - }; + customer: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": Partial & - Partial; - }; - }; + 'application/json': Partial & Partial + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } GetCustomersCustomerDiscount: { parameters: { path: { - customer: string; - }; + customer: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["discount"]; - }; - }; + 'application/json': components['schemas']['discount'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Removes the currently applied discount on a customer.

*/ DeleteCustomersCustomerDiscount: { parameters: { path: { - customer: string; - }; - }; + customer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_discount"]; - }; - }; + 'application/json': components['schemas']['deleted_discount'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of PaymentMethods for a given Customer

*/ GetCustomersCustomerPaymentMethods: { parameters: { path: { - customer: string; - }; + customer: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** A required filter on the list, based on the object `type` field. */ type: - | "acss_debit" - | "afterpay_clearpay" - | "alipay" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "eps" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "klarna" - | "oxxo" - | "p24" - | "sepa_debit" - | "sofort" - | "wechat_pay"; - }; - }; - responses: { - /** Successful response. */ - 200: { - content: { - "application/json": { - data: components["schemas"]["payment_method"][]; + | 'acss_debit' + | 'afterpay_clearpay' + | 'alipay' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'eps' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'klarna' + | 'oxxo' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' + } + } + responses: { + /** Successful response. */ + 200: { + content: { + 'application/json': { + data: components['schemas']['payment_method'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

List sources for a specified customer.

*/ GetCustomersCustomerSources: { parameters: { path: { - customer: string; - }; + customer: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Filter sources according to a particular object type. */ - object?: string; + object?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: (Partial & - Partial & - Partial & - Partial & - Partial)[]; + data: (Partial & + Partial & + Partial & + Partial & + Partial)[] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

When you create a new credit card, you must specify a customer or recipient on which to create it.

* @@ -23704,410 +23508,409 @@ export interface operations { PostCustomersCustomerSources: { parameters: { path: { - customer: string; - }; - }; + customer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_source"]; - }; - }; + 'application/json': components['schemas']['payment_source'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A token returned by [Stripe.js](https://stripe.com/docs/js) representing the user’s Alipay account details. */ - alipay_account?: string; + alipay_account?: string /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ bank_account?: Partial<{ - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; - country: string; - currency?: string; + account_holder_type?: 'company' | 'individual' + account_number: string + country: string + currency?: string /** @enum {string} */ - object?: "bank_account"; - routing_number?: string; + object?: 'bank_account' + routing_number?: string }> & - Partial; + Partial /** @description A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js). */ card?: Partial<{ - address_city?: string; - address_country?: string; - address_line1?: string; - address_line2?: string; - address_state?: string; - address_zip?: string; - cvc?: string; - exp_month: number; - exp_year: number; - metadata?: { [key: string]: string }; - name?: string; - number: string; + address_city?: string + address_country?: string + address_line1?: string + address_line2?: string + address_state?: string + address_zip?: string + cvc?: string + exp_month: number + exp_year: number + metadata?: { [key: string]: string } + name?: string + number: string /** @enum {string} */ - object?: "card"; + object?: 'card' }> & - Partial; + Partial /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - source?: string; - }; - }; - }; - }; + source?: string + } + } + } + } /**

Retrieve a specified source for a given customer.

*/ GetCustomersCustomerSourcesId: { parameters: { path: { - customer: string; - id: string; - }; + customer: string + id: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_source"]; - }; - }; + 'application/json': components['schemas']['payment_source'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Update a specified source for a given customer.

*/ PostCustomersCustomerSourcesId: { parameters: { path: { - customer: string; - id: string; - }; - }; + customer: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": Partial & - Partial & - Partial; - }; - }; + 'application/json': Partial & + Partial & + Partial + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The name of the person or business that owns the bank account. */ - account_holder_name?: string; + account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - account_holder_type?: "company" | "individual"; + account_holder_type?: 'company' | 'individual' /** @description City/District/Suburb/Town/Village. */ - address_city?: string; + address_city?: string /** @description Billing address country, if provided when creating card. */ - address_country?: string; + address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - address_line1?: string; + address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - address_line2?: string; + address_line2?: string /** @description State/County/Province/Region. */ - address_state?: string; + address_state?: string /** @description ZIP or postal code. */ - address_zip?: string; + address_zip?: string /** @description Two digit number representing the card’s expiration month. */ - exp_month?: string; + exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - exp_year?: string; + exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Cardholder name. */ - name?: string; + name?: string /** owner */ owner?: { /** source_address */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - email?: string; - name?: string; - phone?: string; - }; - }; - }; - }; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + email?: string + name?: string + phone?: string + } + } + } + } + } /**

Delete a specified source for a given customer.

*/ DeleteCustomersCustomerSourcesId: { parameters: { path: { - customer: string; - id: string; - }; - }; + customer: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": Partial & - Partial; - }; - }; + 'application/json': Partial & Partial + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Verify a specified bank account for a given customer.

*/ PostCustomersCustomerSourcesIdVerify: { parameters: { path: { - customer: string; - id: string; - }; - }; + customer: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["bank_account"]; - }; - }; + 'application/json': components['schemas']['bank_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account. */ - amounts?: number[]; + amounts?: number[] /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

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.

*/ GetCustomersCustomerSubscriptions: { parameters: { path: { - customer: string; - }; + customer: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["subscription"][]; + data: components['schemas']['subscription'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new subscription on an existing customer.

*/ PostCustomersCustomerSubscriptions: { parameters: { path: { - customer: string; - }; - }; + customer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription"]; - }; - }; + 'application/json': components['schemas']['subscription'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A list of prices and quantities that will generate invoice items appended to the first invoice for this subscription. You may pass up to 20 items. */ add_invoice_items?: { - price?: string; + price?: string /** one_time_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). */ - application_fee_percent?: number; + application_fee_percent?: number /** * automatic_tax_config * @description Automatic tax settings for this subscription. */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** * Format: unix-time * @description For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor. */ - backdate_start_date?: number; + backdate_start_date?: number /** * Format: unix-time * @description 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. */ - billing_cycle_anchor?: number; + billing_cycle_anchor?: number /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. */ billing_thresholds?: Partial<{ - amount_gte?: number; - reset_billing_cycle_anchor?: boolean; + amount_gte?: number + reset_billing_cycle_anchor?: boolean }> & - Partial<"">; + Partial<''> /** * Format: unix-time * @description 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. */ - cancel_at?: number; + cancel_at?: number /** @description Boolean indicating whether this subscription should cancel at the end of the current period. */ - cancel_at_period_end?: boolean; + cancel_at_period_end?: boolean /** * @description 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. Defaults to `charge_automatically`. * @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' /** @description The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. */ - coupon?: string; + coupon?: string /** @description Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. */ - days_until_due?: number; + days_until_due?: number /** @description 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?: string; + default_payment_method?: string /** @description 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?: string; + default_source?: string /** @description 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?: Partial & Partial<"">; + default_tax_rates?: Partial & Partial<''> /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A list of up to 20 subscription items, each with an attached price. */ items?: { billing_thresholds?: Partial<{ - usage_gte: number; + usage_gte: number }> & - Partial<"">; - metadata?: { [key: string]: string }; - price?: string; + Partial<''> + metadata?: { [key: string]: string } + price?: string /** recurring_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. */ - off_session?: boolean; + off_session?: boolean /** * @description Use `allow_incomplete` to create subscriptions with `status=incomplete` if the first invoice cannot be paid. Creating subscriptions with this status allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * @@ -24118,11 +23921,7 @@ export interface operations { * `pending_if_incomplete` is only used with updates and cannot be passed when creating a subscription. * @enum {string} */ - payment_behavior?: - | "allow_incomplete" - | "default_incomplete" - | "error_if_incomplete" - | "pending_if_incomplete"; + payment_behavior?: 'allow_incomplete' | 'default_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete' /** * payment_settings * @description Payment settings to pass to invoices created by the subscription. @@ -24134,241 +23933,241 @@ export interface operations { /** mandate_options_param */ mandate_options?: { /** @enum {string} */ - transaction_type?: "business" | "personal"; - }; + transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; + verification_method?: 'automatic' | 'instant' | 'microdeposits' }> & - Partial<"">; + Partial<''> bancontact?: Partial<{ /** @enum {string} */ - preferred_language?: "de" | "en" | "fr" | "nl"; + preferred_language?: 'de' | 'en' | 'fr' | 'nl' }> & - Partial<"">; + Partial<''> card?: Partial<{ /** mandate_options_param */ mandate_options?: { - amount?: number; + amount?: number /** @enum {string} */ - amount_type?: "fixed" | "maximum"; - description?: string; - }; + amount_type?: 'fixed' | 'maximum' + description?: string + } /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: 'any' | 'automatic' }> & - Partial<"">; - }; + Partial<''> + } payment_method_types?: Partial< ( - | "ach_credit_transfer" - | "ach_debit" - | "acss_debit" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "sepa_debit" - | "sofort" - | "wechat_pay" + | 'ach_credit_transfer' + | 'ach_debit' + | 'acss_debit' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' )[] > & - Partial<"">; - }; + Partial<''> + } /** @description 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?: Partial<{ /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number }> & - Partial<"">; + Partial<''> /** @description The API ID of a promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. */ - promotion_code?: string; + promotion_code?: string /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) resulting from the `billing_cycle_anchor`. Valid values are `create_prorations` or `none`. * * Passing `create_prorations` will cause proration invoice items to be created when applicable. Prorations can be disabled by passing `none`. If no value is passed, the default is `create_prorations`. * @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** * transfer_data_specs * @description If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. */ transfer_data?: { - amount_percent?: number; - destination: string; - }; + amount_percent?: number + destination: string + } /** @description Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. */ - trial_end?: Partial<"now"> & Partial; + trial_end?: Partial<'now'> & Partial /** @description 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?: boolean; + trial_from_plan?: boolean /** @description Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. */ - trial_period_days?: number; - }; - }; - }; - }; + trial_period_days?: number + } + } + } + } /**

Retrieves the subscription with the given ID.

*/ GetCustomersCustomerSubscriptionsSubscriptionExposedId: { parameters: { path: { - customer: string; - subscription_exposed_id: string; - }; + customer: string + subscription_exposed_id: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription"]; - }; - }; + 'application/json': components['schemas']['subscription'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostCustomersCustomerSubscriptionsSubscriptionExposedId: { parameters: { path: { - customer: string; - subscription_exposed_id: string; - }; - }; + customer: string + subscription_exposed_id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription"]; - }; - }; + 'application/json': components['schemas']['subscription'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A list of prices and quantities that will generate invoice items appended to the first invoice for this subscription. You may pass up to 20 items. */ add_invoice_items?: { - price?: string; + price?: string /** one_time_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). */ - application_fee_percent?: number; + application_fee_percent?: number /** * automatic_tax_config * @description Automatic tax settings for this subscription. */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** * @description Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). * @enum {string} */ - billing_cycle_anchor?: "now" | "unchanged"; + billing_cycle_anchor?: 'now' | 'unchanged' /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. */ billing_thresholds?: Partial<{ - amount_gte?: number; - reset_billing_cycle_anchor?: boolean; + amount_gte?: number + reset_billing_cycle_anchor?: boolean }> & - Partial<"">; + Partial<''> /** @description 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. */ - cancel_at?: Partial & Partial<"">; + cancel_at?: Partial & Partial<''> /** @description Boolean indicating whether this subscription should cancel at the end of the current period. */ - cancel_at_period_end?: boolean; + cancel_at_period_end?: boolean /** * @description 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. Defaults to `charge_automatically`. * @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' /** @description The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. */ - coupon?: string; + coupon?: string /** @description Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. */ - days_until_due?: number; + days_until_due?: number /** @description 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?: string; + default_payment_method?: string /** @description 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?: string; + default_source?: string /** @description 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. Pass an empty string to remove previously-defined tax rates. */ - default_tax_rates?: Partial & Partial<"">; + default_tax_rates?: Partial & Partial<''> /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A list of up to 20 subscription items, each with an attached price. */ items?: { billing_thresholds?: Partial<{ - usage_gte: number; + usage_gte: number }> & - Partial<"">; - clear_usage?: boolean; - deleted?: boolean; - id?: string; - metadata?: Partial<{ [key: string]: string }> & Partial<"">; - price?: string; + Partial<''> + clear_usage?: boolean + deleted?: boolean + id?: string + metadata?: Partial<{ [key: string]: string }> & Partial<''> + price?: string /** recurring_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. */ - off_session?: boolean; + off_session?: boolean /** @description If specified, payment collection for this subscription will be paused. */ pause_collection?: Partial<{ /** @enum {string} */ - behavior: "keep_as_draft" | "mark_uncollectible" | "void"; + behavior: 'keep_as_draft' | 'mark_uncollectible' | 'void' /** Format: unix-time */ - resumes_at?: number; + resumes_at?: number }> & - Partial<"">; + Partial<''> /** * @description Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * @@ -24379,11 +24178,7 @@ export interface operations { * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. * @enum {string} */ - payment_behavior?: - | "allow_incomplete" - | "default_incomplete" - | "error_if_incomplete" - | "pending_if_incomplete"; + payment_behavior?: 'allow_incomplete' | 'default_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete' /** * payment_settings * @description Payment settings to pass to invoices created by the subscription. @@ -24395,60 +24190,60 @@ export interface operations { /** mandate_options_param */ mandate_options?: { /** @enum {string} */ - transaction_type?: "business" | "personal"; - }; + transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; + verification_method?: 'automatic' | 'instant' | 'microdeposits' }> & - Partial<"">; + Partial<''> bancontact?: Partial<{ /** @enum {string} */ - preferred_language?: "de" | "en" | "fr" | "nl"; + preferred_language?: 'de' | 'en' | 'fr' | 'nl' }> & - Partial<"">; + Partial<''> card?: Partial<{ /** mandate_options_param */ mandate_options?: { - amount?: number; + amount?: number /** @enum {string} */ - amount_type?: "fixed" | "maximum"; - description?: string; - }; + amount_type?: 'fixed' | 'maximum' + description?: string + } /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: 'any' | 'automatic' }> & - Partial<"">; - }; + Partial<''> + } payment_method_types?: Partial< ( - | "ach_credit_transfer" - | "ach_debit" - | "acss_debit" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "sepa_debit" - | "sofort" - | "wechat_pay" + | 'ach_credit_transfer' + | 'ach_debit' + | 'acss_debit' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' )[] > & - Partial<"">; - }; + Partial<''> + } /** @description 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?: Partial<{ /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number }> & - Partial<"">; + Partial<''> /** @description The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. */ - promotion_code?: string; + promotion_code?: string /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -24457,26 +24252,26 @@ export interface operations { * Prorations can be disabled by passing `none`. * @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** * Format: unix-time * @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations. */ - proration_date?: number; + proration_date?: number /** @description If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. This will be unset if you POST an empty value. */ transfer_data?: Partial<{ - amount_percent?: number; - destination: string; + amount_percent?: number + destination: string }> & - Partial<"">; + Partial<''> /** @description Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. */ - trial_end?: Partial<"now"> & Partial; + trial_end?: Partial<'now'> & Partial /** @description 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?: boolean; - }; - }; - }; - }; + trial_from_plan?: boolean + } + } + } + } /** *

Cancels a customer’s subscription. If you set the at_period_end parameter to true, the subscription will remain active until the end of the period, at which point it will be canceled and not renewed. Otherwise, with the default false value, the subscription is terminated immediately. In either case, the customer will not be charged again for the subscription.

* @@ -24487,371 +24282,371 @@ export interface operations { DeleteCustomersCustomerSubscriptionsSubscriptionExposedId: { parameters: { path: { - customer: string; - subscription_exposed_id: string; - }; - }; + customer: string + subscription_exposed_id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription"]; - }; - }; + 'application/json': components['schemas']['subscription'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Can be set to `true` if `at_period_end` is not set to `true`. Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items. */ - invoice_now?: boolean; + invoice_now?: boolean /** @description Can be set to `true` if `at_period_end` is not set to `true`. Will generate a proration invoice item that credits remaining unused time until the subscription period end. */ - prorate?: boolean; - }; - }; - }; - }; + prorate?: boolean + } + } + } + } GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount: { parameters: { path: { - customer: string; - subscription_exposed_id: string; - }; + customer: string + subscription_exposed_id: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["discount"]; - }; - }; + 'application/json': components['schemas']['discount'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Removes the currently applied discount on a customer.

*/ DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount: { parameters: { path: { - customer: string; - subscription_exposed_id: string; - }; - }; + customer: string + subscription_exposed_id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_discount"]; - }; - }; + 'application/json': components['schemas']['deleted_discount'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of tax IDs for a customer.

*/ GetCustomersCustomerTaxIds: { parameters: { path: { - customer: string; - }; + customer: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["tax_id"][]; + data: components['schemas']['tax_id'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new TaxID object for a customer.

*/ PostCustomersCustomerTaxIds: { parameters: { path: { - customer: string; - }; - }; + customer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["tax_id"]; - }; - }; + 'application/json': components['schemas']['tax_id'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * @description Type of the tax ID, one of `ae_trn`, `au_abn`, `au_arn`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `es_cif`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `th_vat`, `tw_vat`, `ua_vat`, `us_ein`, or `za_vat` * @enum {string} */ type: - | "ae_trn" - | "au_abn" - | "au_arn" - | "br_cnpj" - | "br_cpf" - | "ca_bn" - | "ca_gst_hst" - | "ca_pst_bc" - | "ca_pst_mb" - | "ca_pst_sk" - | "ca_qst" - | "ch_vat" - | "cl_tin" - | "es_cif" - | "eu_vat" - | "gb_vat" - | "ge_vat" - | "hk_br" - | "id_npwp" - | "il_vat" - | "in_gst" - | "is_vat" - | "jp_cn" - | "jp_rn" - | "kr_brn" - | "li_uid" - | "mx_rfc" - | "my_frp" - | "my_itn" - | "my_sst" - | "no_vat" - | "nz_gst" - | "ru_inn" - | "ru_kpp" - | "sa_vat" - | "sg_gst" - | "sg_uen" - | "th_vat" - | "tw_vat" - | "ua_vat" - | "us_ein" - | "za_vat"; + | 'ae_trn' + | 'au_abn' + | 'au_arn' + | 'br_cnpj' + | 'br_cpf' + | 'ca_bn' + | 'ca_gst_hst' + | 'ca_pst_bc' + | 'ca_pst_mb' + | 'ca_pst_sk' + | 'ca_qst' + | 'ch_vat' + | 'cl_tin' + | 'es_cif' + | 'eu_vat' + | 'gb_vat' + | 'ge_vat' + | 'hk_br' + | 'id_npwp' + | 'il_vat' + | 'in_gst' + | 'is_vat' + | 'jp_cn' + | 'jp_rn' + | 'kr_brn' + | 'li_uid' + | 'mx_rfc' + | 'my_frp' + | 'my_itn' + | 'my_sst' + | 'no_vat' + | 'nz_gst' + | 'ru_inn' + | 'ru_kpp' + | 'sa_vat' + | 'sg_gst' + | 'sg_uen' + | 'th_vat' + | 'tw_vat' + | 'ua_vat' + | 'us_ein' + | 'za_vat' /** @description Value of the tax ID. */ - value: string; - }; - }; - }; - }; + value: string + } + } + } + } /**

Retrieves the TaxID object with the given identifier.

*/ GetCustomersCustomerTaxIdsId: { parameters: { path: { - customer: string; - id: string; - }; + customer: string + id: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["tax_id"]; - }; - }; + 'application/json': components['schemas']['tax_id'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Deletes an existing TaxID object.

*/ DeleteCustomersCustomerTaxIdsId: { parameters: { path: { - customer: string; - id: string; - }; - }; + customer: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_tax_id"]; - }; - }; + 'application/json': components['schemas']['deleted_tax_id'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of your disputes.

*/ GetDisputes: { parameters: { query: { /** Only return disputes associated to the charge specified by this charge ID. */ - charge?: string; + charge?: string created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return disputes associated to the PaymentIntent specified by this PaymentIntent ID. */ - payment_intent?: string; + payment_intent?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["dispute"][]; + 'application/json': { + data: components['schemas']['dispute'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves the dispute with the given ID.

*/ GetDisputesDispute: { parameters: { path: { - dispute: string; - }; + dispute: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["dispute"]; - }; - }; + 'application/json': components['schemas']['dispute'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

When you get a dispute, contacting your customer is always the best first step. If that doesn’t work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your dashboard, but if you prefer, you can use the API to submit evidence programmatically.

* @@ -24860,69 +24655,69 @@ export interface operations { PostDisputesDispute: { parameters: { path: { - dispute: string; - }; - }; + dispute: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["dispute"]; - }; - }; + 'application/json': components['schemas']['dispute'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * dispute_evidence_params * @description Evidence to upload, to respond to a dispute. Updating any field in the hash will submit all fields in the hash for review. The combined character count of all fields is limited to 150,000. */ evidence?: { - access_activity_log?: string; - billing_address?: string; - cancellation_policy?: string; - cancellation_policy_disclosure?: string; - cancellation_rebuttal?: string; - customer_communication?: string; - customer_email_address?: string; - customer_name?: string; - customer_purchase_ip?: string; - customer_signature?: string; - duplicate_charge_documentation?: string; - duplicate_charge_explanation?: string; - duplicate_charge_id?: string; - product_description?: string; - receipt?: string; - refund_policy?: string; - refund_policy_disclosure?: string; - refund_refusal_explanation?: string; - service_date?: string; - service_documentation?: string; - shipping_address?: string; - shipping_carrier?: string; - shipping_date?: string; - shipping_documentation?: string; - shipping_tracking_number?: string; - uncategorized_file?: string; - uncategorized_text?: string; - }; + access_activity_log?: string + billing_address?: string + cancellation_policy?: string + cancellation_policy_disclosure?: string + cancellation_rebuttal?: string + customer_communication?: string + customer_email_address?: string + customer_name?: string + customer_purchase_ip?: string + customer_signature?: string + duplicate_charge_documentation?: string + duplicate_charge_explanation?: string + duplicate_charge_id?: string + product_description?: string + receipt?: string + refund_policy?: string + refund_policy_disclosure?: string + refund_refusal_explanation?: string + service_date?: string + service_documentation?: string + shipping_address?: string + shipping_carrier?: string + shipping_date?: string + shipping_documentation?: string + shipping_tracking_number?: string + uncategorized_file?: string + uncategorized_text?: string + } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Whether to immediately submit evidence to the bank. If `false`, evidence is staged on the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank by making another request with this attribute set to `true` (the default). */ - submit?: boolean; - }; - }; - }; - }; + submit?: boolean + } + } + } + } /** *

Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.

* @@ -24931,479 +24726,479 @@ export interface operations { PostDisputesDisputeClose: { parameters: { path: { - dispute: string; - }; - }; + dispute: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["dispute"]; - }; - }; + 'application/json': components['schemas']['dispute'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Creates a short-lived API key for a given resource.

*/ PostEphemeralKeys: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["ephemeral_key"]; - }; - }; + 'application/json': components['schemas']['ephemeral_key'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The ID of the Customer you'd like to modify using the resulting ephemeral key. */ - customer?: string; + customer?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The ID of the Issuing Card you'd like to access using the resulting ephemeral key. */ - issuing_card?: string; - }; - }; - }; - }; + issuing_card?: string + } + } + } + } /**

Invalidates a short-lived API key for a given resource.

*/ DeleteEphemeralKeysKey: { parameters: { path: { - key: string; - }; - }; + key: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["ephemeral_key"]; - }; - }; + 'application/json': components['schemas']['ephemeral_key'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

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).

*/ GetEvents: { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** 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?: boolean; + delivery_success?: boolean /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** 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?: string; + type?: string /** 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?: string[]; - }; - }; + types?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["event"][]; + 'application/json': { + data: components['schemas']['event'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.

*/ GetEventsId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["event"]; - }; - }; + 'application/json': components['schemas']['event'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ GetExchangeRates: { parameters: { query: { /** 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** 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?: number; + limit?: number /** 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["exchange_rate"][]; + 'application/json': { + data: components['schemas']['exchange_rate'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves the exchange rates from the given currency to every supported currency.

*/ GetExchangeRatesRateId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - rate_id: string; - }; - }; + rate_id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["exchange_rate"]; - }; - }; + 'application/json': components['schemas']['exchange_rate'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of file links.

*/ GetFileLinks: { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** Filter links by their expiration status. By default, all links are returned. */ - expired?: boolean; + expired?: boolean /** Only return links for the given file. */ - file?: string; + file?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["file_link"][]; + 'application/json': { + data: components['schemas']['file_link'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new file link object.

*/ PostFileLinks: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["file_link"]; - }; - }; + 'application/json': components['schemas']['file_link'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * Format: unix-time * @description A future timestamp after which the link will no longer be usable. */ - expires_at?: number; + expires_at?: number /** @description The ID of the file. The file's `purpose` must be one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `finance_report_run`, `identity_document_downloadable`, `pci_document`, `selfie`, `sigma_scheduled_query`, or `tax_document_user_upload`. */ - file: string; + file: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Retrieves the file link with the given ID.

*/ GetFileLinksLink: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - link: string; - }; - }; + link: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["file_link"]; - }; - }; + 'application/json': components['schemas']['file_link'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates an existing file link object. Expired links can no longer be updated.

*/ PostFileLinksLink: { parameters: { path: { - link: string; - }; - }; + link: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["file_link"]; - }; - }; + 'application/json': components['schemas']['file_link'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A future timestamp after which the link will no longer be usable, or `now` to expire the link immediately. */ - expires_at?: Partial<"now"> & Partial & Partial<"">; + expires_at?: Partial<'now'> & Partial & Partial<''> /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Returns a list of the files that your account has access to. The files are returned sorted by creation date, with the most recently created files appearing first.

*/ GetFiles: { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** The file purpose to filter queries by. If none is provided, files will not be filtered by purpose. */ purpose?: - | "account_requirement" - | "additional_verification" - | "business_icon" - | "business_logo" - | "customer_signature" - | "dispute_evidence" - | "document_provider_identity_document" - | "finance_report_run" - | "identity_document" - | "identity_document_downloadable" - | "pci_document" - | "selfie" - | "sigma_scheduled_query" - | "tax_document_user_upload"; + | 'account_requirement' + | 'additional_verification' + | 'business_icon' + | 'business_logo' + | 'customer_signature' + | 'dispute_evidence' + | 'document_provider_identity_document' + | 'finance_report_run' + | 'identity_document' + | 'identity_document_downloadable' + | 'pci_document' + | 'selfie' + | 'sigma_scheduled_query' + | 'tax_document_user_upload' /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["file"][]; + 'application/json': { + data: components['schemas']['file'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

To upload a file to Stripe, you’ll need to send a request of type multipart/form-data. The request should contain the file you would like to upload, as well as the parameters for creating a file.

* @@ -25414,223 +25209,223 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["file"]; - }; - }; + 'application/json': components['schemas']['file'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "multipart/form-data": { + 'multipart/form-data': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A file to upload. The file should follow the specifications of RFC 2388 (which defines file transfers for the `multipart/form-data` protocol). */ - file: string; + file: string /** * file_link_creation_params * @description Optional parameters to automatically create a [file link](https://stripe.com/docs/api#file_links) for the newly created file. */ file_link_data?: { - create: boolean; + create: boolean /** Format: unix-time */ - expires_at?: number; - metadata?: Partial<{ [key: string]: string }> & Partial<"">; - }; + expires_at?: number + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } /** * @description The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file. * @enum {string} */ purpose: - | "account_requirement" - | "additional_verification" - | "business_icon" - | "business_logo" - | "customer_signature" - | "dispute_evidence" - | "identity_document" - | "pci_document" - | "tax_document_user_upload"; - }; - }; - }; - }; + | 'account_requirement' + | 'additional_verification' + | 'business_icon' + | 'business_logo' + | 'customer_signature' + | 'dispute_evidence' + | 'identity_document' + | 'pci_document' + | 'tax_document_user_upload' + } + } + } + } /**

Retrieves the details of an existing file object. Supply the unique file ID from a file, and Stripe will return the corresponding file object. To access file contents, see the File Upload Guide.

*/ GetFilesFile: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - file: string; - }; - }; + file: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["file"]; - }; - }; + 'application/json': components['schemas']['file'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

List all verification reports.

*/ GetIdentityVerificationReports: { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return VerificationReports of this type */ - type?: "document" | "id_number"; + type?: 'document' | 'id_number' /** Only return VerificationReports created by this VerificationSession ID. It is allowed to provide a VerificationIntent ID. */ - verification_session?: string; - }; - }; + verification_session?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["identity.verification_report"][]; + 'application/json': { + data: components['schemas']['identity.verification_report'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves an existing VerificationReport

*/ GetIdentityVerificationReportsReport: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - report: string; - }; - }; + report: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["identity.verification_report"]; - }; - }; + 'application/json': components['schemas']['identity.verification_report'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of VerificationSessions

*/ GetIdentityVerificationSessions: { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return VerificationSessions with this status. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work). */ - status?: "canceled" | "processing" | "requires_input" | "verified"; - }; - }; + status?: 'canceled' | 'processing' | 'requires_input' | 'verified' + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["identity.verification_session"][]; + 'application/json': { + data: components['schemas']['identity.verification_session'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Creates a VerificationSession object.

* @@ -25645,47 +25440,47 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["identity.verification_session"]; - }; - }; + 'application/json': components['schemas']['identity.verification_session'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * session_options_param * @description A set of options for the session’s verification checks. */ options?: { document?: Partial<{ - allowed_types?: ("driving_license" | "id_card" | "passport")[]; - require_id_number?: boolean; - require_live_capture?: boolean; - require_matching_selfie?: boolean; + allowed_types?: ('driving_license' | 'id_card' | 'passport')[] + require_id_number?: boolean + require_live_capture?: boolean + require_matching_selfie?: boolean }> & - Partial<"">; - }; + Partial<''> + } /** @description The URL that the user will be redirected to upon completing the verification flow. */ - return_url?: string; + return_url?: string /** * @description The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. * @enum {string} */ - type: "document" | "id_number"; - }; - }; - }; - }; + type: 'document' | 'id_number' + } + } + } + } /** *

Retrieves the details of a VerificationSession that was previously created.

* @@ -25696,32 +25491,32 @@ export interface operations { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - session: string; - }; - }; + session: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["identity.verification_session"]; - }; - }; + 'application/json': components['schemas']['identity.verification_session'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates a VerificationSession object.

* @@ -25731,52 +25526,52 @@ export interface operations { PostIdentityVerificationSessionsSession: { parameters: { path: { - session: string; - }; - }; + session: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["identity.verification_session"]; - }; - }; + 'application/json': components['schemas']['identity.verification_session'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * session_options_param * @description A set of options for the session’s verification checks. */ options?: { document?: Partial<{ - allowed_types?: ("driving_license" | "id_card" | "passport")[]; - require_id_number?: boolean; - require_live_capture?: boolean; - require_matching_selfie?: boolean; + allowed_types?: ('driving_license' | 'id_card' | 'passport')[] + require_id_number?: boolean + require_live_capture?: boolean + require_matching_selfie?: boolean }> & - Partial<"">; - }; + Partial<''> + } /** * @description The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. * @enum {string} */ - type?: "document" | "id_number"; - }; - }; - }; - }; + type?: 'document' | 'id_number' + } + } + } + } /** *

A VerificationSession object can be canceled when it is in requires_input status.

* @@ -25785,32 +25580,32 @@ export interface operations { PostIdentityVerificationSessionsSessionCancel: { parameters: { path: { - session: string; - }; - }; + session: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["identity.verification_session"]; - }; - }; + 'application/json': components['schemas']['identity.verification_session'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /** *

Redact a VerificationSession to remove all collected information from Stripe. This will redact * the VerificationSession and all objects related to it, including VerificationReports, Events, @@ -25835,460 +25630,460 @@ export interface operations { PostIdentityVerificationSessionsSessionRedact: { parameters: { path: { - session: string; - }; - }; + session: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["identity.verification_session"]; - }; - }; + 'application/json': components['schemas']['identity.verification_session'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first.

*/ GetInvoiceitems: { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** The identifier of the customer whose invoice items to return. If none is provided, all invoice items will be returned. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** 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?: string; + invoice?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** 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?: boolean; + pending?: boolean /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["invoiceitem"][]; + 'application/json': { + data: components['schemas']['invoiceitem'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostInvoiceitems: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoiceitem"]; - }; - }; + 'application/json': components['schemas']['invoiceitem'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The integer amount in %s of the charge to be applied to the upcoming invoice. Passing in a negative `amount` will reduce the `amount_due` on the invoice. */ - amount?: number; + amount?: number /** @description 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?: string; + currency?: string /** @description The ID of the customer who will be billed when this invoice item is billed. */ - customer: string; + customer: string /** @description An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking. */ - description?: string; + description?: string /** @description Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items. */ - discountable?: boolean; + discountable?: boolean /** @description The coupons to redeem into discounts for the invoice item or invoice line item. */ discounts?: Partial< { - coupon?: string; - discount?: string; + coupon?: string + discount?: string }[] > & - Partial<"">; + Partial<''> /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The ID of an existing invoice to add this invoice item to. When left blank, the invoice item will be added to the next upcoming scheduled invoice. This is useful when adding invoice items in response to an invoice.created webhook. You can only add invoice items to draft invoices and there is a maximum of 250 items per invoice. */ - invoice?: string; + invoice?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** * period * @description The period associated with this invoice item. */ period?: { /** Format: unix-time */ - end: number; + end: number /** Format: unix-time */ - start: number; - }; + start: number + } /** @description The ID of the price object. */ - price?: string; + price?: string /** * one_time_price_data * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; + unit_amount_decimal?: string + } /** @description Non-negative integer. The quantity of units for the invoice item. */ - quantity?: number; + quantity?: number /** @description The ID of a subscription to add this invoice item to. When left blank, the invoice item will be be added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription. */ - subscription?: string; + subscription?: string /** @description 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?: string[]; + tax_rates?: string[] /** @description The integer unit amount in %s of the charge to be applied to the upcoming invoice. This `unit_amount` will be multiplied by the quantity to get the full amount. Passing in a negative `unit_amount` will reduce the `amount_due` on the invoice. */ - unit_amount?: number; + unit_amount?: number /** * Format: decimal * @description Same as `unit_amount`, but accepts a decimal value in %s with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. */ - unit_amount_decimal?: string; - }; - }; - }; - }; + unit_amount_decimal?: string + } + } + } + } /**

Retrieves the invoice item with the given ID.

*/ GetInvoiceitemsInvoiceitem: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - invoiceitem: string; - }; - }; + invoiceitem: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoiceitem"]; - }; - }; + 'application/json': components['schemas']['invoiceitem'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostInvoiceitemsInvoiceitem: { parameters: { path: { - invoiceitem: string; - }; - }; + invoiceitem: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoiceitem"]; - }; - }; + 'application/json': components['schemas']['invoiceitem'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The integer amount in %s of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount. */ - amount?: number; + amount?: number /** @description An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking. */ - description?: string; + description?: string /** @description Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items. Cannot be set to true for prorations. */ - discountable?: boolean; + discountable?: boolean /** @description The coupons & existing discounts which apply to the invoice item or invoice line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts. */ discounts?: Partial< { - coupon?: string; - discount?: string; + coupon?: string + discount?: string }[] > & - Partial<"">; + Partial<''> /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** * period * @description The period associated with this invoice item. */ period?: { /** Format: unix-time */ - end: number; + end: number /** Format: unix-time */ - start: number; - }; + start: number + } /** @description The ID of the price object. */ - price?: string; + price?: string /** * one_time_price_data * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; + unit_amount_decimal?: string + } /** @description Non-negative integer. The quantity of units for the invoice item. */ - quantity?: number; + quantity?: number /** @description 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. Pass an empty string to remove previously-defined tax rates. */ - tax_rates?: Partial & Partial<"">; + tax_rates?: Partial & Partial<''> /** @description The integer unit amount in %s of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount. */ - unit_amount?: number; + unit_amount?: number /** * Format: decimal * @description Same as `unit_amount`, but accepts a decimal value in %s with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. */ - unit_amount_decimal?: string; - }; - }; - }; - }; + unit_amount_decimal?: string + } + } + } + } /**

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.

*/ DeleteInvoiceitemsInvoiceitem: { parameters: { path: { - invoiceitem: string; - }; - }; + invoiceitem: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_invoiceitem"]; - }; - }; + 'application/json': components['schemas']['deleted_invoiceitem'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ GetInvoices: { parameters: { query: { /** The collection method of the invoice to retrieve. Either `charge_automatically` or `send_invoice`. */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** Only return invoices for the customer specified by this customer ID. */ - customer?: string; + customer?: string due_date?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** 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?: "draft" | "open" | "paid" | "uncollectible" | "void"; + status?: 'draft' | 'open' | 'paid' | 'uncollectible' | 'void' /** Only return invoices for the subscription specified by this subscription ID. */ - subscription?: string; - }; - }; + subscription?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["invoice"][]; + 'application/json': { + data: components['schemas']['invoice'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

This endpoint creates a draft invoice for a given customer. The draft invoice created pulls in all pending invoice items on that customer, including prorations. The invoice remains a draft until you finalize the invoice, which allows you to pay or send the invoice to your customers.

*/ PostInvoices: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoice"]; - }; - }; + 'application/json': components['schemas']['invoice'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The account tax IDs associated with the invoice. Only editable when the invoice is a draft. */ - account_tax_ids?: Partial & Partial<"">; + account_tax_ids?: Partial & Partial<''> /** @description A fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees). */ - application_fee_amount?: number; + application_fee_amount?: number /** @description Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice. When `false`, the invoice's state will not automatically advance without an explicit action. */ - auto_advance?: boolean; + auto_advance?: boolean /** * automatic_tax_param * @description Settings for automatic tax lookup for this invoice. */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** * @description 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. Defaults to `charge_automatically`. * @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' /** @description A list of up to 4 custom fields to be displayed on the invoice. */ custom_fields?: Partial< { - name: string; - value: string; + name: string + value: string }[] > & - Partial<"">; + Partial<''> /** @description The ID of the customer who will be billed. */ - customer: string; + customer: string /** @description The number of days from when the invoice is created until it is due. Valid only for invoices where `collection_method=send_invoice`. */ - days_until_due?: number; + days_until_due?: number /** @description 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?: string; + default_payment_method?: string /** @description 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?: string; + default_source?: string /** @description The tax rates that will apply to any line item that does not have `tax_rates` set. */ - default_tax_rates?: string[]; + default_tax_rates?: string[] /** @description An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. */ - description?: string; + description?: string /** @description The coupons to redeem into discounts for the invoice. If not specified, inherits the discount from the invoice's customer. Pass an empty string to avoid inheriting any discounts. */ discounts?: Partial< { - coupon?: string; - discount?: string; + coupon?: string + discount?: string }[] > & - Partial<"">; + Partial<''> /** * Format: unix-time * @description The date on which payment for this invoice is due. Valid only for invoices where `collection_method=send_invoice`. */ - due_date?: number; + due_date?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Footer to be displayed on the invoice. */ - footer?: string; + footer?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description 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?: string; + on_behalf_of?: string /** * payment_settings * @description Configuration settings for the PaymentIntent that is generated when the invoice is finalized. @@ -26300,60 +26095,60 @@ export interface operations { /** mandate_options_param */ mandate_options?: { /** @enum {string} */ - transaction_type?: "business" | "personal"; - }; + transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; + verification_method?: 'automatic' | 'instant' | 'microdeposits' }> & - Partial<"">; + Partial<''> bancontact?: Partial<{ /** @enum {string} */ - preferred_language?: "de" | "en" | "fr" | "nl"; + preferred_language?: 'de' | 'en' | 'fr' | 'nl' }> & - Partial<"">; + Partial<''> card?: Partial<{ /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: 'any' | 'automatic' }> & - Partial<"">; - }; + Partial<''> + } payment_method_types?: Partial< ( - | "ach_credit_transfer" - | "ach_debit" - | "acss_debit" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "sepa_debit" - | "sofort" - | "wechat_pay" + | 'ach_credit_transfer' + | 'ach_debit' + | 'acss_debit' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' )[] > & - Partial<"">; - }; + Partial<''> + } /** @description Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description The ID of the subscription to invoice, if any. If not set, the created invoice will include all pending invoice items for the customer. If set, the created invoice will only include pending invoice items for that subscription and pending invoice items not associated with any subscription. The subscription's billing cycle and regular subscription events won't be affected. */ - subscription?: string; + subscription?: string /** * transfer_data_specs * @description If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge. */ transfer_data?: { - amount?: number; - destination: string; - }; - }; - }; - }; - }; + amount?: number + destination: string + } + } + } + } + } /** *

At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.

* @@ -26366,184 +26161,184 @@ export interface operations { query: { /** Settings for automatic tax lookup for this invoice preview. */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** The code of the coupon to apply. If `subscription` or `subscription_items` is provided, the invoice returned will preview updating or creating a subscription with that coupon. Otherwise, it will preview applying that coupon to the customer for the next upcoming invoice from among the customer's subscriptions. The invoice can be previewed without a coupon by passing this value as an empty string. */ - coupon?: string; + coupon?: string /** The identifier of the customer whose upcoming invoice you'd like to retrieve. */ - customer?: string; + customer?: string /** Details about the customer you want to invoice or overrides for an existing customer. */ customer_details?: { address?: Partial<{ - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string }> & - Partial<"">; + Partial<''> shipping?: Partial<{ /** optional_fields_address */ address: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - name: string; - phone?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + name: string + phone?: string }> & - Partial<"">; + Partial<''> /** tax_param */ tax?: { - ip_address?: Partial & Partial<"">; - }; + ip_address?: Partial & Partial<''> + } /** @enum {string} */ - tax_exempt?: "" | "exempt" | "none" | "reverse"; + tax_exempt?: '' | 'exempt' | 'none' | 'reverse' tax_ids?: { /** @enum {string} */ type: - | "ae_trn" - | "au_abn" - | "au_arn" - | "br_cnpj" - | "br_cpf" - | "ca_bn" - | "ca_gst_hst" - | "ca_pst_bc" - | "ca_pst_mb" - | "ca_pst_sk" - | "ca_qst" - | "ch_vat" - | "cl_tin" - | "es_cif" - | "eu_vat" - | "gb_vat" - | "ge_vat" - | "hk_br" - | "id_npwp" - | "il_vat" - | "in_gst" - | "is_vat" - | "jp_cn" - | "jp_rn" - | "kr_brn" - | "li_uid" - | "mx_rfc" - | "my_frp" - | "my_itn" - | "my_sst" - | "no_vat" - | "nz_gst" - | "ru_inn" - | "ru_kpp" - | "sa_vat" - | "sg_gst" - | "sg_uen" - | "th_vat" - | "tw_vat" - | "ua_vat" - | "us_ein" - | "za_vat"; - value: string; - }[]; - }; + | 'ae_trn' + | 'au_abn' + | 'au_arn' + | 'br_cnpj' + | 'br_cpf' + | 'ca_bn' + | 'ca_gst_hst' + | 'ca_pst_bc' + | 'ca_pst_mb' + | 'ca_pst_sk' + | 'ca_qst' + | 'ch_vat' + | 'cl_tin' + | 'es_cif' + | 'eu_vat' + | 'gb_vat' + | 'ge_vat' + | 'hk_br' + | 'id_npwp' + | 'il_vat' + | 'in_gst' + | 'is_vat' + | 'jp_cn' + | 'jp_rn' + | 'kr_brn' + | 'li_uid' + | 'mx_rfc' + | 'my_frp' + | 'my_itn' + | 'my_sst' + | 'no_vat' + | 'nz_gst' + | 'ru_inn' + | 'ru_kpp' + | 'sa_vat' + | 'sg_gst' + | 'sg_uen' + | 'th_vat' + | 'tw_vat' + | 'ua_vat' + | 'us_ein' + | 'za_vat' + value: string + }[] + } /** The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the customer or subscription. This only works for coupons directly applied to the invoice. To apply a coupon to a subscription, you must use the `coupon` parameter instead. Pass an empty string to avoid inheriting any discounts. To preview the upcoming invoice for a subscription that hasn't been created, use `coupon` instead. */ discounts?: Partial< { - coupon?: string; - discount?: string; + coupon?: string + discount?: string }[] > & - Partial<"">; + Partial<''> /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** List of invoice items to add or update in the upcoming invoice preview. */ invoice_items?: { - amount?: number; - currency?: string; - description?: string; - discountable?: boolean; + amount?: number + currency?: string + description?: string + discountable?: boolean discounts?: Partial< { - coupon?: string; - discount?: string; + coupon?: string + discount?: string }[] > & - Partial<"">; - invoiceitem?: string; - metadata?: Partial<{ [key: string]: string }> & Partial<"">; + Partial<''> + invoiceitem?: string + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** period */ period?: { /** Format: unix-time */ - end: number; + end: number /** Format: unix-time */ - start: number; - }; - price?: string; + start: number + } + price?: string /** one_time_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - unit_amount?: number; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }[]; + unit_amount_decimal?: string + }[] /** The identifier of the unstarted schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields. */ - schedule?: string; + schedule?: string /** The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions. */ - subscription?: string; + subscription?: string /** 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`. */ - subscription_billing_cycle_anchor?: Partial<"now" | "unchanged"> & Partial; + subscription_billing_cycle_anchor?: Partial<'now' | 'unchanged'> & Partial /** Timestamp indicating when the subscription should be scheduled to cancel. Will prorate if within the current period and prorations have been enabled using `proration_behavior`. */ - subscription_cancel_at?: Partial & Partial<"">; + subscription_cancel_at?: Partial & Partial<''> /** Boolean indicating whether this subscription should cancel at the end of the current period. */ - subscription_cancel_at_period_end?: boolean; + subscription_cancel_at_period_end?: boolean /** This simulates the subscription being canceled or expired immediately. */ - subscription_cancel_now?: boolean; + subscription_cancel_now?: boolean /** 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. */ - subscription_default_tax_rates?: Partial & Partial<"">; + subscription_default_tax_rates?: Partial & Partial<''> /** A list of up to 20 subscription items, each with an attached price. */ subscription_items?: { billing_thresholds?: Partial<{ - usage_gte: number; + usage_gte: number }> & - Partial<"">; - clear_usage?: boolean; - deleted?: boolean; - id?: string; - metadata?: Partial<{ [key: string]: string }> & Partial<"">; - price?: string; + Partial<''> + clear_usage?: boolean + deleted?: boolean + id?: string + metadata?: Partial<{ [key: string]: string }> & Partial<''> + price?: string /** recurring_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] /** * Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -26551,227 +26346,227 @@ export interface operations { * * Prorations can be disabled by passing `none`. */ - subscription_proration_behavior?: "always_invoice" | "create_prorations" | "none"; + subscription_proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** 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 cannot be before the subscription was on its current plan. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'. */ - subscription_proration_date?: number; + subscription_proration_date?: number /** Date a subscription is intended to start (can be future or past) */ - subscription_start_date?: number; + subscription_start_date?: number /** 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. */ - subscription_trial_end?: Partial<"now"> & Partial; + subscription_trial_end?: Partial<'now'> & Partial /** Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `subscription_trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `subscription_trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. */ - subscription_trial_from_plan?: boolean; - }; - }; + subscription_trial_from_plan?: boolean + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoice"]; - }; - }; + 'application/json': components['schemas']['invoice'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ GetInvoicesUpcomingLines: { parameters: { query: { /** Settings for automatic tax lookup for this invoice preview. */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** The code of the coupon to apply. If `subscription` or `subscription_items` is provided, the invoice returned will preview updating or creating a subscription with that coupon. Otherwise, it will preview applying that coupon to the customer for the next upcoming invoice from among the customer's subscriptions. The invoice can be previewed without a coupon by passing this value as an empty string. */ - coupon?: string; + coupon?: string /** The identifier of the customer whose upcoming invoice you'd like to retrieve. */ - customer?: string; + customer?: string /** Details about the customer you want to invoice or overrides for an existing customer. */ customer_details?: { address?: Partial<{ - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string }> & - Partial<"">; + Partial<''> shipping?: Partial<{ /** optional_fields_address */ address: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - name: string; - phone?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + name: string + phone?: string }> & - Partial<"">; + Partial<''> /** tax_param */ tax?: { - ip_address?: Partial & Partial<"">; - }; + ip_address?: Partial & Partial<''> + } /** @enum {string} */ - tax_exempt?: "" | "exempt" | "none" | "reverse"; + tax_exempt?: '' | 'exempt' | 'none' | 'reverse' tax_ids?: { /** @enum {string} */ type: - | "ae_trn" - | "au_abn" - | "au_arn" - | "br_cnpj" - | "br_cpf" - | "ca_bn" - | "ca_gst_hst" - | "ca_pst_bc" - | "ca_pst_mb" - | "ca_pst_sk" - | "ca_qst" - | "ch_vat" - | "cl_tin" - | "es_cif" - | "eu_vat" - | "gb_vat" - | "ge_vat" - | "hk_br" - | "id_npwp" - | "il_vat" - | "in_gst" - | "is_vat" - | "jp_cn" - | "jp_rn" - | "kr_brn" - | "li_uid" - | "mx_rfc" - | "my_frp" - | "my_itn" - | "my_sst" - | "no_vat" - | "nz_gst" - | "ru_inn" - | "ru_kpp" - | "sa_vat" - | "sg_gst" - | "sg_uen" - | "th_vat" - | "tw_vat" - | "ua_vat" - | "us_ein" - | "za_vat"; - value: string; - }[]; - }; + | 'ae_trn' + | 'au_abn' + | 'au_arn' + | 'br_cnpj' + | 'br_cpf' + | 'ca_bn' + | 'ca_gst_hst' + | 'ca_pst_bc' + | 'ca_pst_mb' + | 'ca_pst_sk' + | 'ca_qst' + | 'ch_vat' + | 'cl_tin' + | 'es_cif' + | 'eu_vat' + | 'gb_vat' + | 'ge_vat' + | 'hk_br' + | 'id_npwp' + | 'il_vat' + | 'in_gst' + | 'is_vat' + | 'jp_cn' + | 'jp_rn' + | 'kr_brn' + | 'li_uid' + | 'mx_rfc' + | 'my_frp' + | 'my_itn' + | 'my_sst' + | 'no_vat' + | 'nz_gst' + | 'ru_inn' + | 'ru_kpp' + | 'sa_vat' + | 'sg_gst' + | 'sg_uen' + | 'th_vat' + | 'tw_vat' + | 'ua_vat' + | 'us_ein' + | 'za_vat' + value: string + }[] + } /** The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the customer or subscription. This only works for coupons directly applied to the invoice. To apply a coupon to a subscription, you must use the `coupon` parameter instead. Pass an empty string to avoid inheriting any discounts. To preview the upcoming invoice for a subscription that hasn't been created, use `coupon` instead. */ discounts?: Partial< { - coupon?: string; - discount?: string; + coupon?: string + discount?: string }[] > & - Partial<"">; + Partial<''> /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** List of invoice items to add or update in the upcoming invoice preview. */ invoice_items?: { - amount?: number; - currency?: string; - description?: string; - discountable?: boolean; + amount?: number + currency?: string + description?: string + discountable?: boolean discounts?: Partial< { - coupon?: string; - discount?: string; + coupon?: string + discount?: string }[] > & - Partial<"">; - invoiceitem?: string; - metadata?: Partial<{ [key: string]: string }> & Partial<"">; + Partial<''> + invoiceitem?: string + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** period */ period?: { /** Format: unix-time */ - end: number; + end: number /** Format: unix-time */ - start: number; - }; - price?: string; + start: number + } + price?: string /** one_time_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - unit_amount?: number; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }[]; + unit_amount_decimal?: string + }[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** The identifier of the unstarted schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields. */ - schedule?: string; + schedule?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions. */ - subscription?: string; + subscription?: string /** 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`. */ - subscription_billing_cycle_anchor?: Partial<"now" | "unchanged"> & Partial; + subscription_billing_cycle_anchor?: Partial<'now' | 'unchanged'> & Partial /** Timestamp indicating when the subscription should be scheduled to cancel. Will prorate if within the current period and prorations have been enabled using `proration_behavior`. */ - subscription_cancel_at?: Partial & Partial<"">; + subscription_cancel_at?: Partial & Partial<''> /** Boolean indicating whether this subscription should cancel at the end of the current period. */ - subscription_cancel_at_period_end?: boolean; + subscription_cancel_at_period_end?: boolean /** This simulates the subscription being canceled or expired immediately. */ - subscription_cancel_now?: boolean; + subscription_cancel_now?: boolean /** 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. */ - subscription_default_tax_rates?: Partial & Partial<"">; + subscription_default_tax_rates?: Partial & Partial<''> /** A list of up to 20 subscription items, each with an attached price. */ subscription_items?: { billing_thresholds?: Partial<{ - usage_gte: number; + usage_gte: number }> & - Partial<"">; - clear_usage?: boolean; - deleted?: boolean; - id?: string; - metadata?: Partial<{ [key: string]: string }> & Partial<"">; - price?: string; + Partial<''> + clear_usage?: boolean + deleted?: boolean + id?: string + metadata?: Partial<{ [key: string]: string }> & Partial<''> + price?: string /** recurring_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] /** * Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -26779,80 +26574,80 @@ export interface operations { * * Prorations can be disabled by passing `none`. */ - subscription_proration_behavior?: "always_invoice" | "create_prorations" | "none"; + subscription_proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** 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 cannot be before the subscription was on its current plan. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'. */ - subscription_proration_date?: number; + subscription_proration_date?: number /** Date a subscription is intended to start (can be future or past) */ - subscription_start_date?: number; + subscription_start_date?: number /** 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. */ - subscription_trial_end?: Partial<"now"> & Partial; + subscription_trial_end?: Partial<'now'> & Partial /** Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `subscription_trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `subscription_trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. */ - subscription_trial_from_plan?: boolean; - }; - }; + subscription_trial_from_plan?: boolean + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["line_item"][]; + data: components['schemas']['line_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves the invoice with the given ID.

*/ GetInvoicesInvoice: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - invoice: string; - }; - }; + invoice: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoice"]; - }; - }; + 'application/json': components['schemas']['invoice'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Draft invoices are fully editable. Once an invoice is finalized, * monetary values, as well as collection_method, become uneditable.

@@ -26864,83 +26659,83 @@ export interface operations { PostInvoicesInvoice: { parameters: { path: { - invoice: string; - }; - }; + invoice: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoice"]; - }; - }; + 'application/json': components['schemas']['invoice'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The account tax IDs associated with the invoice. Only editable when the invoice is a draft. */ - account_tax_ids?: Partial & Partial<"">; + account_tax_ids?: Partial & Partial<''> /** @description A fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees). */ - application_fee_amount?: number; + application_fee_amount?: number /** @description Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice. */ - auto_advance?: boolean; + auto_advance?: boolean /** * automatic_tax_param * @description Settings for automatic tax lookup for this invoice. */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** * @description Either `charge_automatically` or `send_invoice`. This field can be updated only on `draft` invoices. * @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' /** @description A list of up to 4 custom fields to be displayed on the invoice. If a value for `custom_fields` is specified, the list specified will replace the existing custom field list on this invoice. Pass an empty string to remove previously-defined fields. */ custom_fields?: Partial< { - name: string; - value: string; + name: string + value: string }[] > & - Partial<"">; + Partial<''> /** @description The number of days from which the invoice is created until it is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices. */ - days_until_due?: number; + days_until_due?: number /** @description 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?: string; + default_payment_method?: string /** @description 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?: string; + default_source?: string /** @description The tax rates that will apply to any line item that does not have `tax_rates` set. Pass an empty string to remove previously-defined tax rates. */ - default_tax_rates?: Partial & Partial<"">; + default_tax_rates?: Partial & Partial<''> /** @description An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. */ - description?: string; + description?: string /** @description The discounts that will apply to the invoice. Pass an empty string to remove previously-defined discounts. */ discounts?: Partial< { - coupon?: string; - discount?: string; + coupon?: string + discount?: string }[] > & - Partial<"">; + Partial<''> /** * Format: unix-time * @description The date on which payment for this invoice is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices. */ - due_date?: number; + due_date?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Footer to be displayed on the invoice. */ - footer?: string; + footer?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description 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?: Partial & Partial<"">; + on_behalf_of?: Partial & Partial<''> /** * payment_settings * @description Configuration settings for the PaymentIntent that is generated when the invoice is finalized. @@ -26952,238 +26747,238 @@ export interface operations { /** mandate_options_param */ mandate_options?: { /** @enum {string} */ - transaction_type?: "business" | "personal"; - }; + transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; + verification_method?: 'automatic' | 'instant' | 'microdeposits' }> & - Partial<"">; + Partial<''> bancontact?: Partial<{ /** @enum {string} */ - preferred_language?: "de" | "en" | "fr" | "nl"; + preferred_language?: 'de' | 'en' | 'fr' | 'nl' }> & - Partial<"">; + Partial<''> card?: Partial<{ /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: 'any' | 'automatic' }> & - Partial<"">; - }; + Partial<''> + } payment_method_types?: Partial< ( - | "ach_credit_transfer" - | "ach_debit" - | "acss_debit" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "sepa_debit" - | "sofort" - | "wechat_pay" + | 'ach_credit_transfer' + | 'ach_debit' + | 'acss_debit' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' )[] > & - Partial<"">; - }; + Partial<''> + } /** @description Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge. This will be unset if you POST an empty value. */ transfer_data?: Partial<{ - amount?: number; - destination: string; + amount?: number + destination: string }> & - Partial<"">; - }; - }; - }; - }; + Partial<''> + } + } + } + } /**

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.

*/ DeleteInvoicesInvoice: { parameters: { path: { - invoice: string; - }; - }; + invoice: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_invoice"]; - }; - }; + 'application/json': components['schemas']['deleted_invoice'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostInvoicesInvoiceFinalize: { parameters: { path: { - invoice: string; - }; - }; + invoice: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoice"]; - }; - }; + 'application/json': components['schemas']['invoice'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/invoicing/automatic-charging) of the invoice. When `false`, the invoice's state will not automatically advance without an explicit action. */ - auto_advance?: boolean; + auto_advance?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

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.

*/ GetInvoicesInvoiceLines: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - invoice: string; - }; - }; + invoice: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["line_item"][]; + data: components['schemas']['line_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.

*/ PostInvoicesInvoiceMarkUncollectible: { parameters: { path: { - invoice: string; - }; - }; + invoice: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoice"]; - }; - }; + 'application/json': components['schemas']['invoice'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

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.

*/ PostInvoicesInvoicePay: { parameters: { path: { - invoice: string; - }; - }; + invoice: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoice"]; - }; - }; + 'application/json': components['schemas']['invoice'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * @description In cases where the source used to pay the invoice has insufficient funds, passing `forgive=true` controls whether a charge should be attempted for the full amount available on the source, up to the amount to fully pay the invoice. This effectively forgives the difference between the amount available on the source and the amount due. * * Passing `forgive=false` will fail the charge if the source hasn't been pre-funded with the right amount. An example for this case is with ACH Credit Transfers and wires: if the amount wired is less than the amount due by a small amount, you might want to forgive the difference. Defaults to `false`. */ - forgive?: boolean; + forgive?: boolean /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `true` (off-session). */ - off_session?: boolean; + off_session?: boolean /** @description Boolean representing whether an invoice is paid outside of Stripe. This will result in no charge being made. Defaults to `false`. */ - paid_out_of_band?: boolean; + paid_out_of_band?: boolean /** @description A PaymentMethod to be charged. The PaymentMethod must be the ID of a PaymentMethod belonging to the customer associated with the invoice being paid. */ - payment_method?: string; + payment_method?: string /** @description A payment source to be charged. The source must be the ID of a source belonging to the customer associated with the invoice being paid. */ - source?: string; - }; - }; - }; - }; + source?: string + } + } + } + } /** *

Stripe will automatically send invoices to customers according to your subscriptions settings. However, if you’d like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.

* @@ -27192,109 +26987,109 @@ export interface operations { PostInvoicesInvoiceSend: { parameters: { path: { - invoice: string; - }; - }; + invoice: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoice"]; - }; - }; + 'application/json': components['schemas']['invoice'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.

*/ PostInvoicesInvoiceVoid: { parameters: { path: { - invoice: string; - }; - }; + invoice: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoice"]; - }; - }; + 'application/json': components['schemas']['invoice'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Returns a list of issuer fraud records.

*/ GetIssuerFraudRecords: { parameters: { query: { /** Only return issuer fraud records for the charge specified by this charge ID. */ - charge?: string; + charge?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["issuer_fraud_record"][]; + 'application/json': { + data: components['schemas']['issuer_fraud_record'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Retrieves the details of an issuer fraud record that has previously been created.

* @@ -27304,300 +27099,300 @@ export interface operations { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - issuer_fraud_record: string; - }; - }; + issuer_fraud_record: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuer_fraud_record"]; - }; - }; + 'application/json': components['schemas']['issuer_fraud_record'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ GetIssuingAuthorizations: { parameters: { query: { /** Only return authorizations that belong to the given card. */ - card?: string; + card?: string /** Only return authorizations that belong to the given cardholder. */ - cardholder?: string; + cardholder?: string /** Only return authorizations that were created during the given date interval. */ created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return authorizations with the given status. One of `pending`, `closed`, or `reversed`. */ - status?: "closed" | "pending" | "reversed"; - }; - }; + status?: 'closed' | 'pending' | 'reversed' + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["issuing.authorization"][]; + 'application/json': { + data: components['schemas']['issuing.authorization'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves an Issuing Authorization object.

*/ GetIssuingAuthorizationsAuthorization: { parameters: { path: { - authorization: string; - }; + authorization: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.authorization"]; - }; - }; + 'application/json': components['schemas']['issuing.authorization'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates the specified Issuing Authorization object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ PostIssuingAuthorizationsAuthorization: { parameters: { path: { - authorization: string; - }; - }; + authorization: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.authorization"]; - }; - }; + 'application/json': components['schemas']['issuing.authorization'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Approves a pending Issuing Authorization object. This request should be made within the timeout window of the real-time authorization flow.

*/ PostIssuingAuthorizationsAuthorizationApprove: { parameters: { path: { - authorization: string; - }; - }; + authorization: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.authorization"]; - }; - }; + 'application/json': components['schemas']['issuing.authorization'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description If the authorization's `pending_request.is_amount_controllable` property is `true`, you may provide this value to control how much to hold for the authorization. Must be positive (use [`decline`](https://stripe.com/docs/api/issuing/authorizations/decline) to decline an authorization request). */ - amount?: number; + amount?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Declines a pending Issuing Authorization object. This request should be made within the timeout window of the real time authorization flow.

*/ PostIssuingAuthorizationsAuthorizationDecline: { parameters: { path: { - authorization: string; - }; - }; + authorization: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.authorization"]; - }; - }; + 'application/json': components['schemas']['issuing.authorization'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Returns a list of Issuing Cardholder objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

*/ GetIssuingCardholders: { parameters: { query: { /** Only return cardholders that were created during the given date interval. */ created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** Only return cardholders that have the given email address. */ - email?: string; + email?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return cardholders that have the given phone number. */ - phone_number?: string; + phone_number?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return cardholders that have the given status. One of `active`, `inactive`, or `blocked`. */ - status?: "active" | "blocked" | "inactive"; + status?: 'active' | 'blocked' | 'inactive' /** Only return cardholders that have the given type. One of `individual` or `company`. */ - type?: "company" | "individual"; - }; - }; + type?: 'company' | 'individual' + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["issuing.cardholder"][]; + 'application/json': { + data: components['schemas']['issuing.cardholder'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new Issuing Cardholder object that can be issued cards.

*/ PostIssuingCardholders: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.cardholder"]; - }; - }; + 'application/json': components['schemas']['issuing.cardholder'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * billing_specs * @description The cardholder's billing address. @@ -27605,25 +27400,25 @@ export interface operations { billing: { /** required_address */ address: { - city: string; - country: string; - line1: string; - line2?: string; - postal_code: string; - state?: string; - }; - }; + city: string + country: string + line1: string + line2?: string + postal_code: string + state?: string + } + } /** * company_param * @description Additional information about a `company` cardholder. */ company?: { - tax_id?: string; - }; + tax_id?: string + } /** @description The cardholder's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * individual_param * @description Additional information about an `individual` cardholder. @@ -27631,978 +27426,978 @@ export interface operations { individual?: { /** date_of_birth_specs */ dob?: { - day: number; - month: number; - year: number; - }; - first_name: string; - last_name: string; + day: number + month: number + year: number + } + first_name: string + last_name: string /** person_verification_param */ verification?: { /** person_verification_document_param */ document?: { - back?: string; - front?: string; - }; - }; - }; + back?: string + front?: string + } + } + } /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The cardholder's name. This will be printed on cards issued to them. The maximum length of this field is 24 characters. */ - name: string; + name: string /** @description The cardholder's phone number. This will be transformed to [E.164](https://en.wikipedia.org/wiki/E.164) if it is not provided in that format already. 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?: string; + phone_number?: string /** * authorization_controls_param_v2 * @description 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?: { allowed_categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] blocked_categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] spending_limits?: { - amount: number; + amount: number categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] /** @enum {string} */ - interval: "all_time" | "daily" | "monthly" | "per_authorization" | "weekly" | "yearly"; - }[]; - spending_limits_currency?: string; - }; + interval: 'all_time' | 'daily' | 'monthly' | 'per_authorization' | 'weekly' | 'yearly' + }[] + spending_limits_currency?: string + } /** * @description Specifies whether to permit authorizations on this cardholder's cards. Defaults to `active`. * @enum {string} */ - status?: "active" | "inactive"; + status?: 'active' | 'inactive' /** * @description One of `individual` or `company`. * @enum {string} */ - type: "company" | "individual"; - }; - }; - }; - }; + type: 'company' | 'individual' + } + } + } + } /**

Retrieves an Issuing Cardholder object.

*/ GetIssuingCardholdersCardholder: { parameters: { path: { - cardholder: string; - }; + cardholder: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.cardholder"]; - }; - }; + 'application/json': components['schemas']['issuing.cardholder'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates the specified Issuing Cardholder object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ PostIssuingCardholdersCardholder: { parameters: { path: { - cardholder: string; - }; - }; + cardholder: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.cardholder"]; - }; - }; + 'application/json': components['schemas']['issuing.cardholder'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * billing_specs * @description The cardholder's billing address. @@ -28610,25 +28405,25 @@ export interface operations { billing?: { /** required_address */ address: { - city: string; - country: string; - line1: string; - line2?: string; - postal_code: string; - state?: string; - }; - }; + city: string + country: string + line1: string + line2?: string + postal_code: string + state?: string + } + } /** * company_param * @description Additional information about a `company` cardholder. */ company?: { - tax_id?: string; - }; + tax_id?: string + } /** @description The cardholder's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * individual_param * @description Additional information about an `individual` cardholder. @@ -28636,1015 +28431,1015 @@ export interface operations { individual?: { /** date_of_birth_specs */ dob?: { - day: number; - month: number; - year: number; - }; - first_name: string; - last_name: string; + day: number + month: number + year: number + } + first_name: string + last_name: string /** person_verification_param */ verification?: { /** person_verification_document_param */ document?: { - back?: string; - front?: string; - }; - }; - }; + back?: string + front?: string + } + } + } /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description 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) for more details. */ - phone_number?: string; + phone_number?: string /** * authorization_controls_param_v2 * @description 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?: { allowed_categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] blocked_categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] spending_limits?: { - amount: number; + amount: number categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] /** @enum {string} */ - interval: "all_time" | "daily" | "monthly" | "per_authorization" | "weekly" | "yearly"; - }[]; - spending_limits_currency?: string; - }; + interval: 'all_time' | 'daily' | 'monthly' | 'per_authorization' | 'weekly' | 'yearly' + }[] + spending_limits_currency?: string + } /** * @description Specifies whether to permit authorizations on this cardholder's cards. * @enum {string} */ - status?: "active" | "inactive"; - }; - }; - }; - }; + status?: 'active' | 'inactive' + } + } + } + } /**

Returns a list of Issuing Card objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

*/ GetIssuingCards: { parameters: { query: { /** Only return cards belonging to the Cardholder with the provided ID. */ - cardholder?: string; + cardholder?: string /** Only return cards that were issued during the given date interval. */ created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Only return cards that have the given expiration month. */ - exp_month?: number; + exp_month?: number /** Only return cards that have the given expiration year. */ - exp_year?: number; + exp_year?: number /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** Only return cards that have the given last four digits. */ - last4?: string; + last4?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return cards that have the given status. One of `active`, `inactive`, or `canceled`. */ - status?: "active" | "canceled" | "inactive"; + status?: 'active' | 'canceled' | 'inactive' /** Only return cards that have the given type. One of `virtual` or `physical`. */ - type?: "physical" | "virtual"; - }; - }; + type?: 'physical' | 'virtual' + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["issuing.card"][]; + 'application/json': { + data: components['schemas']['issuing.card'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates an Issuing Card object.

*/ PostIssuingCards: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.card"]; - }; - }; + 'application/json': components['schemas']['issuing.card'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The [Cardholder](https://stripe.com/docs/api#issuing_cardholder_object) object with which the card will be associated. */ - cardholder?: string; + cardholder?: string /** @description The currency for the card. */ - currency: string; + currency: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The card this is meant to be a replacement for (if any). */ - replacement_for?: string; + replacement_for?: string /** * @description If `replacement_for` is specified, this should indicate why that card is being replaced. * @enum {string} */ - replacement_reason?: "damaged" | "expired" | "lost" | "stolen"; + replacement_reason?: 'damaged' | 'expired' | 'lost' | 'stolen' /** * shipping_specs * @description The address where the card will be shipped. @@ -29652,2702 +29447,2688 @@ export interface operations { shipping?: { /** required_address */ address: { - city: string; - country: string; - line1: string; - line2?: string; - postal_code: string; - state?: string; - }; - name: string; + city: string + country: string + line1: string + line2?: string + postal_code: string + state?: string + } + name: string /** @enum {string} */ - service?: "express" | "priority" | "standard"; + service?: 'express' | 'priority' | 'standard' /** @enum {string} */ - type?: "bulk" | "individual"; - }; + type?: 'bulk' | 'individual' + } /** * authorization_controls_param * @description Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details. */ spending_controls?: { allowed_categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] blocked_categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] spending_limits?: { - amount: number; + amount: number categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] /** @enum {string} */ - interval: "all_time" | "daily" | "monthly" | "per_authorization" | "weekly" | "yearly"; - }[]; - }; + interval: 'all_time' | 'daily' | 'monthly' | 'per_authorization' | 'weekly' | 'yearly' + }[] + } /** * @description Whether authorizations can be approved on this card. Defaults to `inactive`. * @enum {string} */ - status?: "active" | "inactive"; + status?: 'active' | 'inactive' /** * @description The type of card to issue. Possible values are `physical` or `virtual`. * @enum {string} */ - type: "physical" | "virtual"; - }; - }; - }; - }; + type: 'physical' | 'virtual' + } + } + } + } /**

Retrieves an Issuing Card object.

*/ GetIssuingCardsCard: { parameters: { path: { - card: string; - }; + card: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.card"]; - }; - }; + 'application/json': components['schemas']['issuing.card'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates the specified Issuing Card object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ PostIssuingCardsCard: { parameters: { path: { - card: string; - }; - }; + card: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.card"]; - }; - }; + 'application/json': components['schemas']['issuing.card'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * @description Reason why the `status` of this card is `canceled`. * @enum {string} */ - cancellation_reason?: "lost" | "stolen"; + cancellation_reason?: 'lost' | 'stolen' /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** * encrypted_pin_param * @description The desired new PIN for this card. */ pin?: { - encrypted_number?: string; - }; + encrypted_number?: string + } /** * authorization_controls_param * @description Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details. */ spending_controls?: { allowed_categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] blocked_categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] spending_limits?: { - amount: number; + amount: number categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] /** @enum {string} */ - interval: "all_time" | "daily" | "monthly" | "per_authorization" | "weekly" | "yearly"; - }[]; - }; + interval: 'all_time' | 'daily' | 'monthly' | 'per_authorization' | 'weekly' | 'yearly' + }[] + } /** * @description Dictates whether authorizations can be approved on this card. If this card is being canceled because it was lost or stolen, this information should be provided as `cancellation_reason`. * @enum {string} */ - status?: "active" | "canceled" | "inactive"; - }; - }; - }; - }; + status?: 'active' | 'canceled' | 'inactive' + } + } + } + } /**

Returns a list of Issuing Dispute objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

*/ GetIssuingDisputes: { parameters: { query: { /** Select Issuing disputes that were created during the given date interval. */ created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Select Issuing disputes with the given status. */ - status?: "expired" | "lost" | "submitted" | "unsubmitted" | "won"; + status?: 'expired' | 'lost' | 'submitted' | 'unsubmitted' | 'won' /** Select the Issuing dispute for the given transaction. */ - transaction?: string; - }; - }; + transaction?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["issuing.dispute"][]; + 'application/json': { + data: components['schemas']['issuing.dispute'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostIssuingDisputes: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.dispute"]; - }; - }; + 'application/json': components['schemas']['issuing.dispute'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * evidence_param * @description Evidence provided for the dispute. */ evidence?: { canceled?: Partial<{ - additional_documentation?: Partial & Partial<"">; - canceled_at?: Partial & Partial<"">; - cancellation_policy_provided?: Partial & Partial<"">; - cancellation_reason?: string; - expected_at?: Partial & Partial<"">; - explanation?: string; - product_description?: string; + additional_documentation?: Partial & Partial<''> + canceled_at?: Partial & Partial<''> + cancellation_policy_provided?: Partial & Partial<''> + cancellation_reason?: string + expected_at?: Partial & Partial<''> + explanation?: string + product_description?: string /** @enum {string} */ - product_type?: "" | "merchandise" | "service"; + product_type?: '' | 'merchandise' | 'service' /** @enum {string} */ - return_status?: "" | "merchant_rejected" | "successful"; - returned_at?: Partial & Partial<"">; + return_status?: '' | 'merchant_rejected' | 'successful' + returned_at?: Partial & Partial<''> }> & - Partial<"">; + Partial<''> duplicate?: Partial<{ - additional_documentation?: Partial & Partial<"">; - card_statement?: Partial & Partial<"">; - cash_receipt?: Partial & Partial<"">; - check_image?: Partial & Partial<"">; - explanation?: string; - original_transaction?: string; + additional_documentation?: Partial & Partial<''> + card_statement?: Partial & Partial<''> + cash_receipt?: Partial & Partial<''> + check_image?: Partial & Partial<''> + explanation?: string + original_transaction?: string }> & - Partial<"">; + Partial<''> fraudulent?: Partial<{ - additional_documentation?: Partial & Partial<"">; - explanation?: string; + additional_documentation?: Partial & Partial<''> + explanation?: string }> & - Partial<"">; + Partial<''> merchandise_not_as_described?: Partial<{ - additional_documentation?: Partial & Partial<"">; - explanation?: string; - received_at?: Partial & Partial<"">; - return_description?: string; + additional_documentation?: Partial & Partial<''> + explanation?: string + received_at?: Partial & Partial<''> + return_description?: string /** @enum {string} */ - return_status?: "" | "merchant_rejected" | "successful"; - returned_at?: Partial & Partial<"">; + return_status?: '' | 'merchant_rejected' | 'successful' + returned_at?: Partial & Partial<''> }> & - Partial<"">; + Partial<''> not_received?: Partial<{ - additional_documentation?: Partial & Partial<"">; - expected_at?: Partial & Partial<"">; - explanation?: string; - product_description?: string; + additional_documentation?: Partial & Partial<''> + expected_at?: Partial & Partial<''> + explanation?: string + product_description?: string /** @enum {string} */ - product_type?: "" | "merchandise" | "service"; + product_type?: '' | 'merchandise' | 'service' }> & - Partial<"">; + Partial<''> other?: Partial<{ - additional_documentation?: Partial & Partial<"">; - explanation?: string; - product_description?: string; + additional_documentation?: Partial & Partial<''> + explanation?: string + product_description?: string /** @enum {string} */ - product_type?: "" | "merchandise" | "service"; + product_type?: '' | 'merchandise' | 'service' }> & - Partial<"">; + Partial<''> /** @enum {string} */ - reason?: - | "canceled" - | "duplicate" - | "fraudulent" - | "merchandise_not_as_described" - | "not_received" - | "other" - | "service_not_as_described"; + reason?: 'canceled' | 'duplicate' | 'fraudulent' | 'merchandise_not_as_described' | 'not_received' | 'other' | 'service_not_as_described' service_not_as_described?: Partial<{ - additional_documentation?: Partial & Partial<"">; - canceled_at?: Partial & Partial<"">; - cancellation_reason?: string; - explanation?: string; - received_at?: Partial & Partial<"">; + additional_documentation?: Partial & Partial<''> + canceled_at?: Partial & Partial<''> + cancellation_reason?: string + explanation?: string + received_at?: Partial & Partial<''> }> & - Partial<"">; - }; + Partial<''> + } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The ID of the issuing transaction to create a dispute for. */ - transaction: string; - }; - }; - }; - }; + transaction: string + } + } + } + } /**

Retrieves an Issuing Dispute object.

*/ GetIssuingDisputesDispute: { parameters: { path: { - dispute: string; - }; + dispute: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.dispute"]; - }; - }; + 'application/json': components['schemas']['issuing.dispute'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostIssuingDisputesDispute: { parameters: { path: { - dispute: string; - }; - }; + dispute: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.dispute"]; - }; - }; + 'application/json': components['schemas']['issuing.dispute'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * evidence_param * @description Evidence provided for the dispute. */ evidence?: { canceled?: Partial<{ - additional_documentation?: Partial & Partial<"">; - canceled_at?: Partial & Partial<"">; - cancellation_policy_provided?: Partial & Partial<"">; - cancellation_reason?: string; - expected_at?: Partial & Partial<"">; - explanation?: string; - product_description?: string; + additional_documentation?: Partial & Partial<''> + canceled_at?: Partial & Partial<''> + cancellation_policy_provided?: Partial & Partial<''> + cancellation_reason?: string + expected_at?: Partial & Partial<''> + explanation?: string + product_description?: string /** @enum {string} */ - product_type?: "" | "merchandise" | "service"; + product_type?: '' | 'merchandise' | 'service' /** @enum {string} */ - return_status?: "" | "merchant_rejected" | "successful"; - returned_at?: Partial & Partial<"">; + return_status?: '' | 'merchant_rejected' | 'successful' + returned_at?: Partial & Partial<''> }> & - Partial<"">; + Partial<''> duplicate?: Partial<{ - additional_documentation?: Partial & Partial<"">; - card_statement?: Partial & Partial<"">; - cash_receipt?: Partial & Partial<"">; - check_image?: Partial & Partial<"">; - explanation?: string; - original_transaction?: string; + additional_documentation?: Partial & Partial<''> + card_statement?: Partial & Partial<''> + cash_receipt?: Partial & Partial<''> + check_image?: Partial & Partial<''> + explanation?: string + original_transaction?: string }> & - Partial<"">; + Partial<''> fraudulent?: Partial<{ - additional_documentation?: Partial & Partial<"">; - explanation?: string; + additional_documentation?: Partial & Partial<''> + explanation?: string }> & - Partial<"">; + Partial<''> merchandise_not_as_described?: Partial<{ - additional_documentation?: Partial & Partial<"">; - explanation?: string; - received_at?: Partial & Partial<"">; - return_description?: string; + additional_documentation?: Partial & Partial<''> + explanation?: string + received_at?: Partial & Partial<''> + return_description?: string /** @enum {string} */ - return_status?: "" | "merchant_rejected" | "successful"; - returned_at?: Partial & Partial<"">; + return_status?: '' | 'merchant_rejected' | 'successful' + returned_at?: Partial & Partial<''> }> & - Partial<"">; + Partial<''> not_received?: Partial<{ - additional_documentation?: Partial & Partial<"">; - expected_at?: Partial & Partial<"">; - explanation?: string; - product_description?: string; + additional_documentation?: Partial & Partial<''> + expected_at?: Partial & Partial<''> + explanation?: string + product_description?: string /** @enum {string} */ - product_type?: "" | "merchandise" | "service"; + product_type?: '' | 'merchandise' | 'service' }> & - Partial<"">; + Partial<''> other?: Partial<{ - additional_documentation?: Partial & Partial<"">; - explanation?: string; - product_description?: string; + additional_documentation?: Partial & Partial<''> + explanation?: string + product_description?: string /** @enum {string} */ - product_type?: "" | "merchandise" | "service"; + product_type?: '' | 'merchandise' | 'service' }> & - Partial<"">; + Partial<''> /** @enum {string} */ - reason?: - | "canceled" - | "duplicate" - | "fraudulent" - | "merchandise_not_as_described" - | "not_received" - | "other" - | "service_not_as_described"; + reason?: 'canceled' | 'duplicate' | 'fraudulent' | 'merchandise_not_as_described' | 'not_received' | 'other' | 'service_not_as_described' service_not_as_described?: Partial<{ - additional_documentation?: Partial & Partial<"">; - canceled_at?: Partial & Partial<"">; - cancellation_reason?: string; - explanation?: string; - received_at?: Partial & Partial<"">; + additional_documentation?: Partial & Partial<''> + canceled_at?: Partial & Partial<''> + cancellation_reason?: string + explanation?: string + received_at?: Partial & Partial<''> }> & - Partial<"">; - }; + Partial<''> + } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

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.

*/ PostIssuingDisputesDisputeSubmit: { parameters: { path: { - dispute: string; - }; - }; + dispute: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.dispute"]; - }; - }; + 'application/json': components['schemas']['issuing.dispute'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Returns a list of Issuing Settlement objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

*/ GetIssuingSettlements: { parameters: { query: { /** Only return issuing settlements that were created during the given date interval. */ created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["issuing.settlement"][]; + 'application/json': { + data: components['schemas']['issuing.settlement'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves an Issuing Settlement object.

*/ GetIssuingSettlementsSettlement: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - settlement: string; - }; - }; + settlement: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.settlement"]; - }; - }; + 'application/json': components['schemas']['issuing.settlement'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates the specified Issuing Settlement object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ PostIssuingSettlementsSettlement: { parameters: { path: { - settlement: string; - }; - }; + settlement: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.settlement"]; - }; - }; + 'application/json': components['schemas']['issuing.settlement'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; - }; - }; - }; - }; + metadata?: { [key: string]: string } + } + } + } + } /**

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.

*/ GetIssuingTransactions: { parameters: { query: { /** Only return transactions that belong to the given card. */ - card?: string; + card?: string /** Only return transactions that belong to the given cardholder. */ - cardholder?: string; + cardholder?: string /** Only return transactions that were created during the given date interval. */ created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return transactions that have the given type. One of `capture` or `refund`. */ - type?: "capture" | "refund"; - }; - }; + type?: 'capture' | 'refund' + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["issuing.transaction"][]; + 'application/json': { + data: components['schemas']['issuing.transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves an Issuing Transaction object.

*/ GetIssuingTransactionsTransaction: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - transaction: string; - }; - }; + transaction: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.transaction"]; - }; - }; + 'application/json': components['schemas']['issuing.transaction'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates the specified Issuing Transaction object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ PostIssuingTransactionsTransaction: { parameters: { path: { - transaction: string; - }; - }; + transaction: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.transaction"]; - }; - }; + 'application/json': components['schemas']['issuing.transaction'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Retrieves a Mandate object.

*/ GetMandatesMandate: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - mandate: string; - }; - }; + mandate: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["mandate"]; - }; - }; + 'application/json': components['schemas']['mandate'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of your order returns. The returns are returned sorted by creation date, with the most recently created return appearing first.

*/ GetOrderReturns: { parameters: { query: { /** Date this return was created. */ created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** The order to retrieve returns for. */ - order?: string; + order?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["order_return"][]; + 'application/json': { + data: components['schemas']['order_return'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves the details of an existing order return. Supply the unique order ID from either an order return creation request or the order return list, and Stripe will return the corresponding order information.

*/ GetOrderReturnsId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["order_return"]; - }; - }; + 'application/json': components['schemas']['order_return'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of your orders. The orders are returned sorted by creation date, with the most recently created orders appearing first.

*/ GetOrders: { parameters: { query: { /** Date this order was created. */ created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** Only return orders for the given customer. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** Only return orders with the given IDs. */ - ids?: string[]; + ids?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return orders that have the given status. One of `created`, `paid`, `fulfilled`, or `refunded`. */ - status?: string; + status?: string /** Filter orders based on when they were paid, fulfilled, canceled, or returned. */ status_transitions?: { canceled?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial fulfilled?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial paid?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial returned?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; - }; + Partial + } /** Only return orders with the given upstream order IDs. */ - upstream_ids?: string[]; - }; - }; + upstream_ids?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["order"][]; + 'application/json': { + data: components['schemas']['order'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new order object.

*/ PostOrders: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["order"]; - }; - }; + 'application/json': components['schemas']['order'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A coupon code that represents a discount to be applied to this order. Must be one-time duration and in same currency as the order. An order can have multiple coupons. */ - coupon?: string; + coupon?: string /** @description 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: string; + currency: string /** @description The ID of an existing customer to use for this order. If provided, the customer email and shipping address will be used to create the order. Subsequently, the customer will also be charged to pay the order. If `email` or `shipping` are also provided, they will override the values retrieved from the customer object. */ - customer?: string; + customer?: string /** @description The email address of the customer placing the order. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description List of items constituting the order. An order can have up to 25 items. */ items?: { - amount?: number; - currency?: string; - description?: string; - parent?: string; - quantity?: number; + amount?: number + currency?: string + description?: string + parent?: string + quantity?: number /** @enum {string} */ - type?: "discount" | "shipping" | "sku" | "tax"; - }[]; + type?: 'discount' | 'shipping' | 'sku' | 'tax' + }[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * customer_shipping * @description Shipping address for the order. Required if any of the SKUs are for products that have `shippable` set to true. @@ -32355,237 +32136,237 @@ export interface operations { shipping?: { /** optional_fields_address */ address: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - name: string; - phone?: string; - }; - }; - }; - }; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + name: string + phone?: string + } + } + } + } + } /**

Retrieves the details of an existing order. Supply the unique order ID from either an order creation request or the order list, and Stripe will return the corresponding order information.

*/ GetOrdersId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["order"]; - }; - }; + 'application/json': components['schemas']['order'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates the specific order by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ PostOrdersId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["order"]; - }; - }; + 'application/json': components['schemas']['order'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A coupon code that represents a discount to be applied to this order. Must be one-time duration and in same currency as the order. An order can have multiple coupons. */ - coupon?: string; + coupon?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The shipping method to select for fulfilling this order. If specified, must be one of the `id`s of a shipping method in the `shipping_methods` array. If specified, will overwrite the existing selected shipping method, updating `items` as necessary. */ - selected_shipping_method?: string; + selected_shipping_method?: string /** * shipping_tracking_params * @description Tracking information once the order has been fulfilled. */ shipping?: { - carrier: string; - tracking_number: string; - }; + carrier: string + tracking_number: string + } /** * @description Current order status. One of `created`, `paid`, `canceled`, `fulfilled`, or `returned`. More detail in the [Orders Guide](https://stripe.com/docs/orders/guide#understanding-order-statuses). * @enum {string} */ - status?: "canceled" | "created" | "fulfilled" | "paid" | "returned"; - }; - }; - }; - }; + status?: 'canceled' | 'created' | 'fulfilled' | 'paid' | 'returned' + } + } + } + } /**

Pay an order by providing a source to create a payment.

*/ PostOrdersIdPay: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["order"]; - }; - }; + 'application/json': components['schemas']['order'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A fee in %s that will be applied to the order and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the `Stripe-Account` header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees). */ - application_fee?: number; + application_fee?: number /** @description The ID of an existing customer that will be charged for this order. If no customer was attached to the order at creation, either `source` or `customer` is required. Otherwise, the specified customer will be charged instead of the one attached to the order. */ - customer?: string; + customer?: string /** @description The email address of the customer placing the order. Required if not previously specified for the order. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description A [Token](https://stripe.com/docs/api#tokens)'s or a [Source](https://stripe.com/docs/api#sources)'s ID, as returned by [Elements](https://stripe.com/docs/elements). If no customer was attached to the order at creation, either `source` or `customer` is required. Otherwise, the specified source will be charged intead of the customer attached to the order. */ - source?: string; - }; - }; - }; - }; + source?: string + } + } + } + } /**

Return all or part of an order. The order must have a status of paid or fulfilled before it can be returned. Once all items have been returned, the order will become canceled or returned depending on which status the order started in.

*/ PostOrdersIdReturns: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["order_return"]; - }; - }; + 'application/json': components['schemas']['order_return'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description List of items to return. */ items?: Partial< { - amount?: number; - description?: string; - parent?: string; - quantity?: number; + amount?: number + description?: string + parent?: string + quantity?: number /** @enum {string} */ - type?: "discount" | "shipping" | "sku" | "tax"; + type?: 'discount' | 'shipping' | 'sku' | 'tax' }[] > & - Partial<"">; - }; - }; - }; - }; + Partial<''> + } + } + } + } /**

Returns a list of PaymentIntents.

*/ GetPaymentIntents: { parameters: { query: { /** 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?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** Only return PaymentIntents for the customer specified by this customer ID. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["payment_intent"][]; + 'application/json': { + data: components['schemas']['payment_intent'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Creates a PaymentIntent object.

* @@ -32603,41 +32384,41 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_intent"]; - }; - }; + 'application/json': components['schemas']['payment_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description 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: number; + amount: number /** @description 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?: number; + application_fee_amount?: number /** * automatic_payment_methods_param * @description When enabled, this PaymentIntent will accept payment methods that you have enabled in the Dashboard and are compatible with this PaymentIntent's other parameters. */ automatic_payment_methods?: { - enabled: boolean; - }; + enabled: boolean + } /** * @description Controls when the funds will be captured from the customer's account. * @enum {string} */ - capture_method?: "automatic" | "manual"; + capture_method?: 'automatic' | 'manual' /** @description Set to `true` to attempt to [confirm](https://stripe.com/docs/api/payment_intents/confirm) this PaymentIntent immediately. This parameter defaults to `false`. When creating and confirming a PaymentIntent at the same time, parameters available in the [confirm](https://stripe.com/docs/api/payment_intents/confirm) API may also be provided. */ - confirm?: boolean; + confirm?: boolean /** @enum {string} */ - confirmation_method?: "automatic" | "manual"; + confirmation_method?: 'automatic' | 'manual' /** @description 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: string; + currency: string /** * @description ID of the Customer this PaymentIntent belongs to, if one exists. * @@ -32645,15 +32426,15 @@ export interface operations { * * If present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. */ - customer?: string; + customer?: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. This parameter is intended for simpler integrations that do not handle customer actions, like [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). */ - error_on_requires_action?: boolean; + error_on_requires_action?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description ID of the mandate to be used for this payment. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). */ - mandate?: string; + mandate?: string /** * secret_key_param * @description This hash contains details about the Mandate to create. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). @@ -32662,30 +32443,30 @@ export interface operations { /** customer_acceptance_param */ customer_acceptance: { /** Format: unix-time */ - accepted_at?: number; + accepted_at?: number /** offline_param */ - offline?: { [key: string]: unknown }; + offline?: { [key: string]: unknown } /** online_param */ online?: { - ip_address: string; - user_agent: string; - }; + ip_address: string + user_agent: string + } /** @enum {string} */ - type: "offline" | "online"; - }; - }; + type: 'offline' | 'online' + } + } /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description Set to `true` to indicate that the customer is not in your checkout flow during this payment attempt, and therefore is unable to authenticate. This parameter is intended for scenarios where you collect card details and [charge them later](https://stripe.com/docs/payments/cards/charging-saved-cards). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). */ - off_session?: Partial & Partial<"one_off" | "recurring">; + off_session?: Partial & Partial<'one_off' | 'recurring'> /** @description The Stripe account ID for which these funds are intended. For details, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ - on_behalf_of?: string; + on_behalf_of?: string /** * @description ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. * * If this parameter is omitted with `confirm=true`, `customer.default_source` will be attached as this PaymentIntent's payment instrument to improve the migration experience for users of the Charges API. We recommend that you explicitly provide the `payment_method` going forward. */ - payment_method?: string; + payment_method?: string /** * payment_method_data_params * @description If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear @@ -32695,201 +32476,201 @@ export interface operations { payment_method_data?: { /** payment_method_param */ acss_debit?: { - account_number: string; - institution_number: string; - transit_number: string; - }; + account_number: string + institution_number: string + transit_number: string + } /** param */ - afterpay_clearpay?: { [key: string]: unknown }; + afterpay_clearpay?: { [key: string]: unknown } /** param */ - alipay?: { [key: string]: unknown }; + alipay?: { [key: string]: unknown } /** param */ au_becs_debit?: { - account_number: string; - bsb_number: string; - }; + account_number: string + bsb_number: string + } /** param */ bacs_debit?: { - account_number?: string; - sort_code?: string; - }; + account_number?: string + sort_code?: string + } /** param */ - bancontact?: { [key: string]: unknown }; + bancontact?: { [key: string]: unknown } /** billing_details_inner_params */ billing_details?: { address?: Partial<{ - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string }> & - Partial<"">; - email?: Partial & Partial<"">; - name?: string; - phone?: string; - }; + Partial<''> + email?: Partial & Partial<''> + name?: string + phone?: string + } /** param */ boleto?: { - tax_id: string; - }; + tax_id: string + } /** param */ eps?: { /** @enum {string} */ bank?: - | "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" - | "dolomitenbank" - | "easybank_ag" - | "erste_bank_und_sparkassen" - | "hypo_alpeadriabank_international_ag" - | "hypo_bank_burgenland_aktiengesellschaft" - | "hypo_noe_lb_fur_niederosterreich_u_wien" - | "hypo_oberosterreich_salzburg_steiermark" - | "hypo_tirol_bank_ag" - | "hypo_vorarlberg_bank_ag" - | "marchfelder_bank" - | "oberbank_ag" - | "raiffeisen_bankengruppe_osterreich" - | "schoellerbank_ag" - | "sparda_bank_wien" - | "volksbank_gruppe" - | "volkskreditbank_ag" - | "vr_bank_braunau"; - }; + | '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' + | 'dolomitenbank' + | 'easybank_ag' + | 'erste_bank_und_sparkassen' + | 'hypo_alpeadriabank_international_ag' + | 'hypo_bank_burgenland_aktiengesellschaft' + | 'hypo_noe_lb_fur_niederosterreich_u_wien' + | 'hypo_oberosterreich_salzburg_steiermark' + | 'hypo_tirol_bank_ag' + | 'hypo_vorarlberg_bank_ag' + | 'marchfelder_bank' + | 'oberbank_ag' + | 'raiffeisen_bankengruppe_osterreich' + | 'schoellerbank_ag' + | 'sparda_bank_wien' + | 'volksbank_gruppe' + | 'volkskreditbank_ag' + | 'vr_bank_braunau' + } /** param */ fpx?: { /** @enum {string} */ bank: - | "affin_bank" - | "agrobank" - | "alliance_bank" - | "ambank" - | "bank_islam" - | "bank_muamalat" - | "bank_rakyat" - | "bsn" - | "cimb" - | "deutsche_bank" - | "hong_leong_bank" - | "hsbc" - | "kfh" - | "maybank2e" - | "maybank2u" - | "ocbc" - | "pb_enterprise" - | "public_bank" - | "rhb" - | "standard_chartered" - | "uob"; - }; + | 'affin_bank' + | 'agrobank' + | 'alliance_bank' + | 'ambank' + | 'bank_islam' + | 'bank_muamalat' + | 'bank_rakyat' + | 'bsn' + | 'cimb' + | 'deutsche_bank' + | 'hong_leong_bank' + | 'hsbc' + | 'kfh' + | 'maybank2e' + | 'maybank2u' + | 'ocbc' + | 'pb_enterprise' + | 'public_bank' + | 'rhb' + | 'standard_chartered' + | 'uob' + } /** param */ - giropay?: { [key: string]: unknown }; + giropay?: { [key: string]: unknown } /** param */ - grabpay?: { [key: string]: unknown }; + grabpay?: { [key: string]: unknown } /** param */ ideal?: { /** @enum {string} */ bank?: - | "abn_amro" - | "asn_bank" - | "bunq" - | "handelsbanken" - | "ing" - | "knab" - | "moneyou" - | "rabobank" - | "regiobank" - | "revolut" - | "sns_bank" - | "triodos_bank" - | "van_lanschot"; - }; + | 'abn_amro' + | 'asn_bank' + | 'bunq' + | 'handelsbanken' + | 'ing' + | 'knab' + | 'moneyou' + | 'rabobank' + | 'regiobank' + | 'revolut' + | 'sns_bank' + | 'triodos_bank' + | 'van_lanschot' + } /** param */ - interac_present?: { [key: string]: unknown }; + interac_present?: { [key: string]: unknown } /** param */ klarna?: { /** date_of_birth */ dob?: { - day: number; - month: number; - year: number; - }; - }; - metadata?: { [key: string]: string }; + day: number + month: number + year: number + } + } + metadata?: { [key: string]: string } /** param */ - oxxo?: { [key: string]: unknown }; + oxxo?: { [key: string]: unknown } /** param */ p24?: { /** @enum {string} */ bank?: - | "alior_bank" - | "bank_millennium" - | "bank_nowy_bfg_sa" - | "bank_pekao_sa" - | "banki_spbdzielcze" - | "blik" - | "bnp_paribas" - | "boz" - | "citi_handlowy" - | "credit_agricole" - | "envelobank" - | "etransfer_pocztowy24" - | "getin_bank" - | "ideabank" - | "ing" - | "inteligo" - | "mbank_mtransfer" - | "nest_przelew" - | "noble_pay" - | "pbac_z_ipko" - | "plus_bank" - | "santander_przelew24" - | "tmobile_usbugi_bankowe" - | "toyota_bank" - | "volkswagen_bank"; - }; + | 'alior_bank' + | 'bank_millennium' + | 'bank_nowy_bfg_sa' + | 'bank_pekao_sa' + | 'banki_spbdzielcze' + | 'blik' + | 'bnp_paribas' + | 'boz' + | 'citi_handlowy' + | 'credit_agricole' + | 'envelobank' + | 'etransfer_pocztowy24' + | 'getin_bank' + | 'ideabank' + | 'ing' + | 'inteligo' + | 'mbank_mtransfer' + | 'nest_przelew' + | 'noble_pay' + | 'pbac_z_ipko' + | 'plus_bank' + | 'santander_przelew24' + | 'tmobile_usbugi_bankowe' + | 'toyota_bank' + | 'volkswagen_bank' + } /** param */ sepa_debit?: { - iban: string; - }; + iban: string + } /** param */ sofort?: { /** @enum {string} */ - country: "AT" | "BE" | "DE" | "ES" | "IT" | "NL"; - }; + country: 'AT' | 'BE' | 'DE' | 'ES' | 'IT' | 'NL' + } /** @enum {string} */ type: - | "acss_debit" - | "afterpay_clearpay" - | "alipay" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "eps" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "klarna" - | "oxxo" - | "p24" - | "sepa_debit" - | "sofort" - | "wechat_pay"; + | 'acss_debit' + | 'afterpay_clearpay' + | 'alipay' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'eps' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'klarna' + | 'oxxo' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' /** param */ - wechat_pay?: { [key: string]: unknown }; - }; + wechat_pay?: { [key: string]: unknown } + } /** * payment_method_options_param * @description Payment-method-specific configuration for this PaymentIntent. @@ -32898,136 +32679,126 @@ export interface operations { acss_debit?: Partial<{ /** payment_intent_payment_method_options_mandate_options_param */ mandate_options?: { - custom_mandate_url?: Partial & Partial<"">; - interval_description?: string; + custom_mandate_url?: Partial & Partial<''> + interval_description?: string /** @enum {string} */ - payment_schedule?: "combined" | "interval" | "sporadic"; + payment_schedule?: 'combined' | 'interval' | 'sporadic' /** @enum {string} */ - transaction_type?: "business" | "personal"; - }; + transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; + verification_method?: 'automatic' | 'instant' | 'microdeposits' }> & - Partial<"">; + Partial<''> afterpay_clearpay?: Partial<{ - reference?: string; + reference?: string }> & - Partial<"">; - alipay?: Partial<{ [key: string]: unknown }> & Partial<"">; - au_becs_debit?: Partial<{ [key: string]: unknown }> & Partial<"">; - bacs_debit?: Partial<{ [key: string]: unknown }> & Partial<"">; + Partial<''> + alipay?: Partial<{ [key: string]: unknown }> & Partial<''> + au_becs_debit?: Partial<{ [key: string]: unknown }> & Partial<''> + bacs_debit?: Partial<{ [key: string]: unknown }> & Partial<''> bancontact?: Partial<{ /** @enum {string} */ - preferred_language?: "de" | "en" | "fr" | "nl"; + preferred_language?: 'de' | 'en' | 'fr' | 'nl' }> & - Partial<"">; + Partial<''> boleto?: Partial<{ - expires_after_days?: number; + expires_after_days?: number }> & - Partial<"">; + Partial<''> card?: Partial<{ - cvc_token?: string; + cvc_token?: string /** installments_param */ installments?: { - enabled?: boolean; + enabled?: boolean plan?: Partial<{ - count: number; + count: number /** @enum {string} */ - interval: "month"; + interval: 'month' /** @enum {string} */ - type: "fixed_count"; + type: 'fixed_count' }> & - Partial<"">; - }; + Partial<''> + } /** @enum {string} */ - network?: - | "amex" - | "cartes_bancaires" - | "diners" - | "discover" - | "interac" - | "jcb" - | "mastercard" - | "unionpay" - | "unknown" - | "visa"; + network?: 'amex' | 'cartes_bancaires' | 'diners' | 'discover' | 'interac' | 'jcb' | 'mastercard' | 'unionpay' | 'unknown' | 'visa' /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: 'any' | 'automatic' /** @enum {string} */ - setup_future_usage?: "" | "none" | "off_session" | "on_session"; + setup_future_usage?: '' | 'none' | 'off_session' | 'on_session' }> & - Partial<"">; - card_present?: Partial<{ [key: string]: unknown }> & Partial<"">; - eps?: Partial<{ [key: string]: unknown }> & Partial<"">; - fpx?: Partial<{ [key: string]: unknown }> & Partial<"">; - giropay?: Partial<{ [key: string]: unknown }> & Partial<"">; - grabpay?: Partial<{ [key: string]: unknown }> & Partial<"">; - ideal?: Partial<{ [key: string]: unknown }> & Partial<"">; - interac_present?: Partial<{ [key: string]: unknown }> & Partial<"">; + Partial<''> + card_present?: Partial<{ [key: string]: unknown }> & Partial<''> + eps?: Partial<{ [key: string]: unknown }> & Partial<''> + fpx?: Partial<{ [key: string]: unknown }> & Partial<''> + giropay?: Partial<{ [key: string]: unknown }> & Partial<''> + grabpay?: Partial<{ [key: string]: unknown }> & Partial<''> + ideal?: Partial<{ [key: string]: unknown }> & Partial<''> + interac_present?: Partial<{ [key: string]: unknown }> & Partial<''> klarna?: Partial<{ /** @enum {string} */ preferred_locale?: - | "da-DK" - | "de-AT" - | "de-DE" - | "en-AT" - | "en-BE" - | "en-DE" - | "en-DK" - | "en-ES" - | "en-FI" - | "en-FR" - | "en-GB" - | "en-IE" - | "en-IT" - | "en-NL" - | "en-NO" - | "en-SE" - | "en-US" - | "es-ES" - | "es-US" - | "fi-FI" - | "fr-BE" - | "fr-FR" - | "it-IT" - | "nb-NO" - | "nl-BE" - | "nl-NL" - | "sv-FI" - | "sv-SE"; + | 'da-DK' + | 'de-AT' + | 'de-DE' + | 'en-AT' + | 'en-BE' + | 'en-DE' + | 'en-DK' + | 'en-ES' + | 'en-FI' + | 'en-FR' + | 'en-GB' + | 'en-IE' + | 'en-IT' + | 'en-NL' + | 'en-NO' + | 'en-SE' + | 'en-US' + | 'es-ES' + | 'es-US' + | 'fi-FI' + | 'fr-BE' + | 'fr-FR' + | 'it-IT' + | 'nb-NO' + | 'nl-BE' + | 'nl-NL' + | 'sv-FI' + | 'sv-SE' }> & - Partial<"">; + Partial<''> oxxo?: Partial<{ - expires_after_days?: number; + expires_after_days?: number }> & - Partial<"">; + Partial<''> p24?: Partial<{ - tos_shown_and_accepted?: boolean; + tos_shown_and_accepted?: boolean }> & - Partial<"">; + Partial<''> sepa_debit?: Partial<{ /** payment_method_options_mandate_options_param */ - mandate_options?: { [key: string]: unknown }; + mandate_options?: { [key: string]: unknown } }> & - Partial<"">; + Partial<''> sofort?: Partial<{ /** @enum {string} */ - preferred_language?: "" | "de" | "en" | "es" | "fr" | "it" | "nl" | "pl"; + preferred_language?: '' | 'de' | 'en' | 'es' | 'fr' | 'it' | 'nl' | 'pl' }> & - Partial<"">; + Partial<''> wechat_pay?: Partial<{ - app_id?: string; + app_id?: string /** @enum {string} */ - client: "android" | "ios" | "web"; + client: 'android' | 'ios' | 'web' }> & - Partial<"">; - }; + Partial<''> + } /** @description The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. If this is not provided, defaults to ["card"]. */ - payment_method_types?: string[]; + payment_method_types?: string[] /** @description 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?: string; + receipt_email?: string /** @description The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). */ - return_url?: string; + return_url?: string /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * @@ -33036,7 +32807,7 @@ export interface operations { * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ - setup_future_usage?: "off_session" | "on_session"; + setup_future_usage?: 'off_session' | 'on_session' /** * optional_fields_shipping * @description Shipping information for this PaymentIntent. @@ -33044,39 +32815,39 @@ export interface operations { shipping?: { /** optional_fields_address */ address: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - carrier?: string; - name: string; - phone?: string; - tracking_number?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + carrier?: string + name: string + phone?: string + tracking_number?: string + } /** @description For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - statement_descriptor_suffix?: string; + statement_descriptor_suffix?: string /** * transfer_data_creation_params * @description The parameters used to automatically create a Transfer when the payment succeeds. * For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ transfer_data?: { - amount?: number; - destination: string; - }; + amount?: number + destination: string + } /** @description A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. */ - transfer_group?: string; + transfer_group?: string /** @description Set to `true` only when using manual confirmation and the iOS or Android SDKs to handle additional authentication steps. */ - use_stripe_sdk?: boolean; - }; - }; - }; - }; + use_stripe_sdk?: boolean + } + } + } + } /** *

Retrieves the details of a PaymentIntent that has previously been created.

* @@ -33088,34 +32859,34 @@ export interface operations { parameters: { query: { /** The client secret of the PaymentIntent. Required if a publishable key is used to retrieve the source. */ - client_secret?: string; + client_secret?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - intent: string; - }; - }; + intent: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_intent"]; - }; - }; + 'application/json': components['schemas']['payment_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates properties on a PaymentIntent object without confirming.

* @@ -33128,32 +32899,32 @@ export interface operations { PostPaymentIntentsIntent: { parameters: { path: { - intent: string; - }; - }; + intent: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_intent"]; - }; - }; + 'application/json': components['schemas']['payment_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description 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?: number; + amount?: number /** @description 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?: Partial & Partial<"">; + application_fee_amount?: Partial & Partial<''> /** @description 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?: string; + currency?: string /** * @description ID of the Customer this PaymentIntent belongs to, if one exists. * @@ -33161,15 +32932,15 @@ export interface operations { * * If present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. */ - customer?: string; + customer?: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. */ - payment_method?: string; + payment_method?: string /** * payment_method_data_params * @description If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear @@ -33179,201 +32950,201 @@ export interface operations { payment_method_data?: { /** payment_method_param */ acss_debit?: { - account_number: string; - institution_number: string; - transit_number: string; - }; + account_number: string + institution_number: string + transit_number: string + } /** param */ - afterpay_clearpay?: { [key: string]: unknown }; + afterpay_clearpay?: { [key: string]: unknown } /** param */ - alipay?: { [key: string]: unknown }; + alipay?: { [key: string]: unknown } /** param */ au_becs_debit?: { - account_number: string; - bsb_number: string; - }; + account_number: string + bsb_number: string + } /** param */ bacs_debit?: { - account_number?: string; - sort_code?: string; - }; + account_number?: string + sort_code?: string + } /** param */ - bancontact?: { [key: string]: unknown }; + bancontact?: { [key: string]: unknown } /** billing_details_inner_params */ billing_details?: { address?: Partial<{ - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string }> & - Partial<"">; - email?: Partial & Partial<"">; - name?: string; - phone?: string; - }; + Partial<''> + email?: Partial & Partial<''> + name?: string + phone?: string + } /** param */ boleto?: { - tax_id: string; - }; + tax_id: string + } /** param */ eps?: { /** @enum {string} */ bank?: - | "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" - | "dolomitenbank" - | "easybank_ag" - | "erste_bank_und_sparkassen" - | "hypo_alpeadriabank_international_ag" - | "hypo_bank_burgenland_aktiengesellschaft" - | "hypo_noe_lb_fur_niederosterreich_u_wien" - | "hypo_oberosterreich_salzburg_steiermark" - | "hypo_tirol_bank_ag" - | "hypo_vorarlberg_bank_ag" - | "marchfelder_bank" - | "oberbank_ag" - | "raiffeisen_bankengruppe_osterreich" - | "schoellerbank_ag" - | "sparda_bank_wien" - | "volksbank_gruppe" - | "volkskreditbank_ag" - | "vr_bank_braunau"; - }; + | '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' + | 'dolomitenbank' + | 'easybank_ag' + | 'erste_bank_und_sparkassen' + | 'hypo_alpeadriabank_international_ag' + | 'hypo_bank_burgenland_aktiengesellschaft' + | 'hypo_noe_lb_fur_niederosterreich_u_wien' + | 'hypo_oberosterreich_salzburg_steiermark' + | 'hypo_tirol_bank_ag' + | 'hypo_vorarlberg_bank_ag' + | 'marchfelder_bank' + | 'oberbank_ag' + | 'raiffeisen_bankengruppe_osterreich' + | 'schoellerbank_ag' + | 'sparda_bank_wien' + | 'volksbank_gruppe' + | 'volkskreditbank_ag' + | 'vr_bank_braunau' + } /** param */ fpx?: { /** @enum {string} */ bank: - | "affin_bank" - | "agrobank" - | "alliance_bank" - | "ambank" - | "bank_islam" - | "bank_muamalat" - | "bank_rakyat" - | "bsn" - | "cimb" - | "deutsche_bank" - | "hong_leong_bank" - | "hsbc" - | "kfh" - | "maybank2e" - | "maybank2u" - | "ocbc" - | "pb_enterprise" - | "public_bank" - | "rhb" - | "standard_chartered" - | "uob"; - }; + | 'affin_bank' + | 'agrobank' + | 'alliance_bank' + | 'ambank' + | 'bank_islam' + | 'bank_muamalat' + | 'bank_rakyat' + | 'bsn' + | 'cimb' + | 'deutsche_bank' + | 'hong_leong_bank' + | 'hsbc' + | 'kfh' + | 'maybank2e' + | 'maybank2u' + | 'ocbc' + | 'pb_enterprise' + | 'public_bank' + | 'rhb' + | 'standard_chartered' + | 'uob' + } /** param */ - giropay?: { [key: string]: unknown }; + giropay?: { [key: string]: unknown } /** param */ - grabpay?: { [key: string]: unknown }; + grabpay?: { [key: string]: unknown } /** param */ ideal?: { /** @enum {string} */ bank?: - | "abn_amro" - | "asn_bank" - | "bunq" - | "handelsbanken" - | "ing" - | "knab" - | "moneyou" - | "rabobank" - | "regiobank" - | "revolut" - | "sns_bank" - | "triodos_bank" - | "van_lanschot"; - }; + | 'abn_amro' + | 'asn_bank' + | 'bunq' + | 'handelsbanken' + | 'ing' + | 'knab' + | 'moneyou' + | 'rabobank' + | 'regiobank' + | 'revolut' + | 'sns_bank' + | 'triodos_bank' + | 'van_lanschot' + } /** param */ - interac_present?: { [key: string]: unknown }; + interac_present?: { [key: string]: unknown } /** param */ klarna?: { /** date_of_birth */ dob?: { - day: number; - month: number; - year: number; - }; - }; - metadata?: { [key: string]: string }; + day: number + month: number + year: number + } + } + metadata?: { [key: string]: string } /** param */ - oxxo?: { [key: string]: unknown }; + oxxo?: { [key: string]: unknown } /** param */ p24?: { /** @enum {string} */ bank?: - | "alior_bank" - | "bank_millennium" - | "bank_nowy_bfg_sa" - | "bank_pekao_sa" - | "banki_spbdzielcze" - | "blik" - | "bnp_paribas" - | "boz" - | "citi_handlowy" - | "credit_agricole" - | "envelobank" - | "etransfer_pocztowy24" - | "getin_bank" - | "ideabank" - | "ing" - | "inteligo" - | "mbank_mtransfer" - | "nest_przelew" - | "noble_pay" - | "pbac_z_ipko" - | "plus_bank" - | "santander_przelew24" - | "tmobile_usbugi_bankowe" - | "toyota_bank" - | "volkswagen_bank"; - }; + | 'alior_bank' + | 'bank_millennium' + | 'bank_nowy_bfg_sa' + | 'bank_pekao_sa' + | 'banki_spbdzielcze' + | 'blik' + | 'bnp_paribas' + | 'boz' + | 'citi_handlowy' + | 'credit_agricole' + | 'envelobank' + | 'etransfer_pocztowy24' + | 'getin_bank' + | 'ideabank' + | 'ing' + | 'inteligo' + | 'mbank_mtransfer' + | 'nest_przelew' + | 'noble_pay' + | 'pbac_z_ipko' + | 'plus_bank' + | 'santander_przelew24' + | 'tmobile_usbugi_bankowe' + | 'toyota_bank' + | 'volkswagen_bank' + } /** param */ sepa_debit?: { - iban: string; - }; + iban: string + } /** param */ sofort?: { /** @enum {string} */ - country: "AT" | "BE" | "DE" | "ES" | "IT" | "NL"; - }; + country: 'AT' | 'BE' | 'DE' | 'ES' | 'IT' | 'NL' + } /** @enum {string} */ type: - | "acss_debit" - | "afterpay_clearpay" - | "alipay" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "eps" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "klarna" - | "oxxo" - | "p24" - | "sepa_debit" - | "sofort" - | "wechat_pay"; + | 'acss_debit' + | 'afterpay_clearpay' + | 'alipay' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'eps' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'klarna' + | 'oxxo' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' /** param */ - wechat_pay?: { [key: string]: unknown }; - }; + wechat_pay?: { [key: string]: unknown } + } /** * payment_method_options_param * @description Payment-method-specific configuration for this PaymentIntent. @@ -33382,134 +33153,124 @@ export interface operations { acss_debit?: Partial<{ /** payment_intent_payment_method_options_mandate_options_param */ mandate_options?: { - custom_mandate_url?: Partial & Partial<"">; - interval_description?: string; + custom_mandate_url?: Partial & Partial<''> + interval_description?: string /** @enum {string} */ - payment_schedule?: "combined" | "interval" | "sporadic"; + payment_schedule?: 'combined' | 'interval' | 'sporadic' /** @enum {string} */ - transaction_type?: "business" | "personal"; - }; + transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; + verification_method?: 'automatic' | 'instant' | 'microdeposits' }> & - Partial<"">; + Partial<''> afterpay_clearpay?: Partial<{ - reference?: string; + reference?: string }> & - Partial<"">; - alipay?: Partial<{ [key: string]: unknown }> & Partial<"">; - au_becs_debit?: Partial<{ [key: string]: unknown }> & Partial<"">; - bacs_debit?: Partial<{ [key: string]: unknown }> & Partial<"">; + Partial<''> + alipay?: Partial<{ [key: string]: unknown }> & Partial<''> + au_becs_debit?: Partial<{ [key: string]: unknown }> & Partial<''> + bacs_debit?: Partial<{ [key: string]: unknown }> & Partial<''> bancontact?: Partial<{ /** @enum {string} */ - preferred_language?: "de" | "en" | "fr" | "nl"; + preferred_language?: 'de' | 'en' | 'fr' | 'nl' }> & - Partial<"">; + Partial<''> boleto?: Partial<{ - expires_after_days?: number; + expires_after_days?: number }> & - Partial<"">; + Partial<''> card?: Partial<{ - cvc_token?: string; + cvc_token?: string /** installments_param */ installments?: { - enabled?: boolean; + enabled?: boolean plan?: Partial<{ - count: number; + count: number /** @enum {string} */ - interval: "month"; + interval: 'month' /** @enum {string} */ - type: "fixed_count"; + type: 'fixed_count' }> & - Partial<"">; - }; + Partial<''> + } /** @enum {string} */ - network?: - | "amex" - | "cartes_bancaires" - | "diners" - | "discover" - | "interac" - | "jcb" - | "mastercard" - | "unionpay" - | "unknown" - | "visa"; + network?: 'amex' | 'cartes_bancaires' | 'diners' | 'discover' | 'interac' | 'jcb' | 'mastercard' | 'unionpay' | 'unknown' | 'visa' /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: 'any' | 'automatic' /** @enum {string} */ - setup_future_usage?: "" | "none" | "off_session" | "on_session"; + setup_future_usage?: '' | 'none' | 'off_session' | 'on_session' }> & - Partial<"">; - card_present?: Partial<{ [key: string]: unknown }> & Partial<"">; - eps?: Partial<{ [key: string]: unknown }> & Partial<"">; - fpx?: Partial<{ [key: string]: unknown }> & Partial<"">; - giropay?: Partial<{ [key: string]: unknown }> & Partial<"">; - grabpay?: Partial<{ [key: string]: unknown }> & Partial<"">; - ideal?: Partial<{ [key: string]: unknown }> & Partial<"">; - interac_present?: Partial<{ [key: string]: unknown }> & Partial<"">; + Partial<''> + card_present?: Partial<{ [key: string]: unknown }> & Partial<''> + eps?: Partial<{ [key: string]: unknown }> & Partial<''> + fpx?: Partial<{ [key: string]: unknown }> & Partial<''> + giropay?: Partial<{ [key: string]: unknown }> & Partial<''> + grabpay?: Partial<{ [key: string]: unknown }> & Partial<''> + ideal?: Partial<{ [key: string]: unknown }> & Partial<''> + interac_present?: Partial<{ [key: string]: unknown }> & Partial<''> klarna?: Partial<{ /** @enum {string} */ preferred_locale?: - | "da-DK" - | "de-AT" - | "de-DE" - | "en-AT" - | "en-BE" - | "en-DE" - | "en-DK" - | "en-ES" - | "en-FI" - | "en-FR" - | "en-GB" - | "en-IE" - | "en-IT" - | "en-NL" - | "en-NO" - | "en-SE" - | "en-US" - | "es-ES" - | "es-US" - | "fi-FI" - | "fr-BE" - | "fr-FR" - | "it-IT" - | "nb-NO" - | "nl-BE" - | "nl-NL" - | "sv-FI" - | "sv-SE"; + | 'da-DK' + | 'de-AT' + | 'de-DE' + | 'en-AT' + | 'en-BE' + | 'en-DE' + | 'en-DK' + | 'en-ES' + | 'en-FI' + | 'en-FR' + | 'en-GB' + | 'en-IE' + | 'en-IT' + | 'en-NL' + | 'en-NO' + | 'en-SE' + | 'en-US' + | 'es-ES' + | 'es-US' + | 'fi-FI' + | 'fr-BE' + | 'fr-FR' + | 'it-IT' + | 'nb-NO' + | 'nl-BE' + | 'nl-NL' + | 'sv-FI' + | 'sv-SE' }> & - Partial<"">; + Partial<''> oxxo?: Partial<{ - expires_after_days?: number; + expires_after_days?: number }> & - Partial<"">; + Partial<''> p24?: Partial<{ - tos_shown_and_accepted?: boolean; + tos_shown_and_accepted?: boolean }> & - Partial<"">; + Partial<''> sepa_debit?: Partial<{ /** payment_method_options_mandate_options_param */ - mandate_options?: { [key: string]: unknown }; + mandate_options?: { [key: string]: unknown } }> & - Partial<"">; + Partial<''> sofort?: Partial<{ /** @enum {string} */ - preferred_language?: "" | "de" | "en" | "es" | "fr" | "it" | "nl" | "pl"; + preferred_language?: '' | 'de' | 'en' | 'es' | 'fr' | 'it' | 'nl' | 'pl' }> & - Partial<"">; + Partial<''> wechat_pay?: Partial<{ - app_id?: string; + app_id?: string /** @enum {string} */ - client: "android" | "ios" | "web"; + client: 'android' | 'ios' | 'web' }> & - Partial<"">; - }; + Partial<''> + } /** @description The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. */ - payment_method_types?: string[]; + payment_method_types?: string[] /** @description 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?: Partial & Partial<"">; + receipt_email?: Partial & Partial<''> /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * @@ -33520,41 +33281,41 @@ export interface operations { * If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. * @enum {string} */ - setup_future_usage?: "" | "off_session" | "on_session"; + setup_future_usage?: '' | 'off_session' | 'on_session' /** @description Shipping information for this PaymentIntent. */ shipping?: Partial<{ /** optional_fields_address */ address: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - carrier?: string; - name: string; - phone?: string; - tracking_number?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + carrier?: string + name: string + phone?: string + tracking_number?: string }> & - Partial<"">; + Partial<''> /** @description For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - statement_descriptor_suffix?: string; + statement_descriptor_suffix?: string /** * transfer_data_update_params * @description The parameters used to automatically create a Transfer when the payment succeeds. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ transfer_data?: { - amount?: number; - }; + amount?: number + } /** @description A string that identifies the resulting payment as part of a group. `transfer_group` may only be provided if it has not been set. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. */ - transfer_group?: string; - }; - }; - }; - }; + transfer_group?: string + } + } + } + } /** *

A PaymentIntent object can be canceled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action, or processing.

* @@ -33563,37 +33324,37 @@ export interface operations { PostPaymentIntentsIntentCancel: { parameters: { path: { - intent: string; - }; - }; + intent: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_intent"]; - }; - }; + 'application/json': components['schemas']['payment_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * @description Reason for canceling this PaymentIntent. Possible values are `duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned` * @enum {string} */ - cancellation_reason?: "abandoned" | "duplicate" | "fraudulent" | "requested_by_customer"; + cancellation_reason?: 'abandoned' | 'duplicate' | 'fraudulent' | 'requested_by_customer' /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /** *

Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.

* @@ -33604,48 +33365,48 @@ export interface operations { PostPaymentIntentsIntentCapture: { parameters: { path: { - intent: string; - }; - }; + intent: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_intent"]; - }; - }; + 'application/json': components['schemas']['payment_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The amount to capture from the PaymentIntent, which must be less than or equal to the original amount. Any additional amount will be automatically refunded. Defaults to the full `amount_capturable` if not provided. */ - amount_to_capture?: number; + amount_to_capture?: number /** @description 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?: number; + application_fee_amount?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - statement_descriptor_suffix?: string; + statement_descriptor_suffix?: string /** * transfer_data_update_params * @description The parameters used to automatically create a Transfer when the payment * is captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ transfer_data?: { - amount?: number; - }; - }; - }; - }; - }; + amount?: number + } + } + } + } + } /** *

Confirm that your customer intends to pay with current or provided * payment method. Upon confirmation, the PaymentIntent will attempt to initiate @@ -33676,67 +33437,67 @@ export interface operations { PostPaymentIntentsIntentConfirm: { parameters: { path: { - intent: string; - }; - }; + intent: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_intent"]; - }; - }; + 'application/json': components['schemas']['payment_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The client secret of the PaymentIntent. */ - client_secret?: string; + client_secret?: string /** @description Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. This parameter is intended for simpler integrations that do not handle customer actions, like [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication). */ - error_on_requires_action?: boolean; + error_on_requires_action?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description ID of the mandate to be used for this payment. */ - mandate?: string; + mandate?: string /** @description This hash contains details about the Mandate to create */ mandate_data?: Partial<{ /** customer_acceptance_param */ customer_acceptance: { /** Format: unix-time */ - accepted_at?: number; + accepted_at?: number /** offline_param */ - offline?: { [key: string]: unknown }; + offline?: { [key: string]: unknown } /** online_param */ online?: { - ip_address: string; - user_agent: string; - }; + ip_address: string + user_agent: string + } /** @enum {string} */ - type: "offline" | "online"; - }; + type: 'offline' | 'online' + } }> & Partial<{ /** customer_acceptance_param */ customer_acceptance: { /** online_param */ online: { - ip_address?: string; - user_agent?: string; - }; + ip_address?: string + user_agent?: string + } /** @enum {string} */ - type: "online"; - }; - }>; + type: 'online' + } + }> /** @description Set to `true` to indicate that the customer is not in your checkout flow during this payment attempt, and therefore is unable to authenticate. This parameter is intended for scenarios where you collect card details and [charge them later](https://stripe.com/docs/payments/cards/charging-saved-cards). */ - off_session?: Partial & Partial<"one_off" | "recurring">; + off_session?: Partial & Partial<'one_off' | 'recurring'> /** @description ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. */ - payment_method?: string; + payment_method?: string /** * payment_method_data_params * @description If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear @@ -33746,201 +33507,201 @@ export interface operations { payment_method_data?: { /** payment_method_param */ acss_debit?: { - account_number: string; - institution_number: string; - transit_number: string; - }; + account_number: string + institution_number: string + transit_number: string + } /** param */ - afterpay_clearpay?: { [key: string]: unknown }; + afterpay_clearpay?: { [key: string]: unknown } /** param */ - alipay?: { [key: string]: unknown }; + alipay?: { [key: string]: unknown } /** param */ au_becs_debit?: { - account_number: string; - bsb_number: string; - }; + account_number: string + bsb_number: string + } /** param */ bacs_debit?: { - account_number?: string; - sort_code?: string; - }; + account_number?: string + sort_code?: string + } /** param */ - bancontact?: { [key: string]: unknown }; + bancontact?: { [key: string]: unknown } /** billing_details_inner_params */ billing_details?: { address?: Partial<{ - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string }> & - Partial<"">; - email?: Partial & Partial<"">; - name?: string; - phone?: string; - }; + Partial<''> + email?: Partial & Partial<''> + name?: string + phone?: string + } /** param */ boleto?: { - tax_id: string; - }; + tax_id: string + } /** param */ eps?: { /** @enum {string} */ bank?: - | "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" - | "dolomitenbank" - | "easybank_ag" - | "erste_bank_und_sparkassen" - | "hypo_alpeadriabank_international_ag" - | "hypo_bank_burgenland_aktiengesellschaft" - | "hypo_noe_lb_fur_niederosterreich_u_wien" - | "hypo_oberosterreich_salzburg_steiermark" - | "hypo_tirol_bank_ag" - | "hypo_vorarlberg_bank_ag" - | "marchfelder_bank" - | "oberbank_ag" - | "raiffeisen_bankengruppe_osterreich" - | "schoellerbank_ag" - | "sparda_bank_wien" - | "volksbank_gruppe" - | "volkskreditbank_ag" - | "vr_bank_braunau"; - }; + | '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' + | 'dolomitenbank' + | 'easybank_ag' + | 'erste_bank_und_sparkassen' + | 'hypo_alpeadriabank_international_ag' + | 'hypo_bank_burgenland_aktiengesellschaft' + | 'hypo_noe_lb_fur_niederosterreich_u_wien' + | 'hypo_oberosterreich_salzburg_steiermark' + | 'hypo_tirol_bank_ag' + | 'hypo_vorarlberg_bank_ag' + | 'marchfelder_bank' + | 'oberbank_ag' + | 'raiffeisen_bankengruppe_osterreich' + | 'schoellerbank_ag' + | 'sparda_bank_wien' + | 'volksbank_gruppe' + | 'volkskreditbank_ag' + | 'vr_bank_braunau' + } /** param */ fpx?: { /** @enum {string} */ bank: - | "affin_bank" - | "agrobank" - | "alliance_bank" - | "ambank" - | "bank_islam" - | "bank_muamalat" - | "bank_rakyat" - | "bsn" - | "cimb" - | "deutsche_bank" - | "hong_leong_bank" - | "hsbc" - | "kfh" - | "maybank2e" - | "maybank2u" - | "ocbc" - | "pb_enterprise" - | "public_bank" - | "rhb" - | "standard_chartered" - | "uob"; - }; + | 'affin_bank' + | 'agrobank' + | 'alliance_bank' + | 'ambank' + | 'bank_islam' + | 'bank_muamalat' + | 'bank_rakyat' + | 'bsn' + | 'cimb' + | 'deutsche_bank' + | 'hong_leong_bank' + | 'hsbc' + | 'kfh' + | 'maybank2e' + | 'maybank2u' + | 'ocbc' + | 'pb_enterprise' + | 'public_bank' + | 'rhb' + | 'standard_chartered' + | 'uob' + } /** param */ - giropay?: { [key: string]: unknown }; + giropay?: { [key: string]: unknown } /** param */ - grabpay?: { [key: string]: unknown }; + grabpay?: { [key: string]: unknown } /** param */ ideal?: { /** @enum {string} */ bank?: - | "abn_amro" - | "asn_bank" - | "bunq" - | "handelsbanken" - | "ing" - | "knab" - | "moneyou" - | "rabobank" - | "regiobank" - | "revolut" - | "sns_bank" - | "triodos_bank" - | "van_lanschot"; - }; + | 'abn_amro' + | 'asn_bank' + | 'bunq' + | 'handelsbanken' + | 'ing' + | 'knab' + | 'moneyou' + | 'rabobank' + | 'regiobank' + | 'revolut' + | 'sns_bank' + | 'triodos_bank' + | 'van_lanschot' + } /** param */ - interac_present?: { [key: string]: unknown }; + interac_present?: { [key: string]: unknown } /** param */ klarna?: { /** date_of_birth */ dob?: { - day: number; - month: number; - year: number; - }; - }; - metadata?: { [key: string]: string }; + day: number + month: number + year: number + } + } + metadata?: { [key: string]: string } /** param */ - oxxo?: { [key: string]: unknown }; + oxxo?: { [key: string]: unknown } /** param */ p24?: { /** @enum {string} */ bank?: - | "alior_bank" - | "bank_millennium" - | "bank_nowy_bfg_sa" - | "bank_pekao_sa" - | "banki_spbdzielcze" - | "blik" - | "bnp_paribas" - | "boz" - | "citi_handlowy" - | "credit_agricole" - | "envelobank" - | "etransfer_pocztowy24" - | "getin_bank" - | "ideabank" - | "ing" - | "inteligo" - | "mbank_mtransfer" - | "nest_przelew" - | "noble_pay" - | "pbac_z_ipko" - | "plus_bank" - | "santander_przelew24" - | "tmobile_usbugi_bankowe" - | "toyota_bank" - | "volkswagen_bank"; - }; + | 'alior_bank' + | 'bank_millennium' + | 'bank_nowy_bfg_sa' + | 'bank_pekao_sa' + | 'banki_spbdzielcze' + | 'blik' + | 'bnp_paribas' + | 'boz' + | 'citi_handlowy' + | 'credit_agricole' + | 'envelobank' + | 'etransfer_pocztowy24' + | 'getin_bank' + | 'ideabank' + | 'ing' + | 'inteligo' + | 'mbank_mtransfer' + | 'nest_przelew' + | 'noble_pay' + | 'pbac_z_ipko' + | 'plus_bank' + | 'santander_przelew24' + | 'tmobile_usbugi_bankowe' + | 'toyota_bank' + | 'volkswagen_bank' + } /** param */ sepa_debit?: { - iban: string; - }; + iban: string + } /** param */ sofort?: { /** @enum {string} */ - country: "AT" | "BE" | "DE" | "ES" | "IT" | "NL"; - }; + country: 'AT' | 'BE' | 'DE' | 'ES' | 'IT' | 'NL' + } /** @enum {string} */ type: - | "acss_debit" - | "afterpay_clearpay" - | "alipay" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "eps" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "klarna" - | "oxxo" - | "p24" - | "sepa_debit" - | "sofort" - | "wechat_pay"; + | 'acss_debit' + | 'afterpay_clearpay' + | 'alipay' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'eps' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'klarna' + | 'oxxo' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' /** param */ - wechat_pay?: { [key: string]: unknown }; - }; + wechat_pay?: { [key: string]: unknown } + } /** * payment_method_options_param * @description Payment-method-specific configuration for this PaymentIntent. @@ -33949,140 +33710,130 @@ export interface operations { acss_debit?: Partial<{ /** payment_intent_payment_method_options_mandate_options_param */ mandate_options?: { - custom_mandate_url?: Partial & Partial<"">; - interval_description?: string; + custom_mandate_url?: Partial & Partial<''> + interval_description?: string /** @enum {string} */ - payment_schedule?: "combined" | "interval" | "sporadic"; + payment_schedule?: 'combined' | 'interval' | 'sporadic' /** @enum {string} */ - transaction_type?: "business" | "personal"; - }; + transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; + verification_method?: 'automatic' | 'instant' | 'microdeposits' }> & - Partial<"">; + Partial<''> afterpay_clearpay?: Partial<{ - reference?: string; + reference?: string }> & - Partial<"">; - alipay?: Partial<{ [key: string]: unknown }> & Partial<"">; - au_becs_debit?: Partial<{ [key: string]: unknown }> & Partial<"">; - bacs_debit?: Partial<{ [key: string]: unknown }> & Partial<"">; + Partial<''> + alipay?: Partial<{ [key: string]: unknown }> & Partial<''> + au_becs_debit?: Partial<{ [key: string]: unknown }> & Partial<''> + bacs_debit?: Partial<{ [key: string]: unknown }> & Partial<''> bancontact?: Partial<{ /** @enum {string} */ - preferred_language?: "de" | "en" | "fr" | "nl"; + preferred_language?: 'de' | 'en' | 'fr' | 'nl' }> & - Partial<"">; + Partial<''> boleto?: Partial<{ - expires_after_days?: number; + expires_after_days?: number }> & - Partial<"">; + Partial<''> card?: Partial<{ - cvc_token?: string; + cvc_token?: string /** installments_param */ installments?: { - enabled?: boolean; + enabled?: boolean plan?: Partial<{ - count: number; + count: number /** @enum {string} */ - interval: "month"; + interval: 'month' /** @enum {string} */ - type: "fixed_count"; + type: 'fixed_count' }> & - Partial<"">; - }; + Partial<''> + } /** @enum {string} */ - network?: - | "amex" - | "cartes_bancaires" - | "diners" - | "discover" - | "interac" - | "jcb" - | "mastercard" - | "unionpay" - | "unknown" - | "visa"; + network?: 'amex' | 'cartes_bancaires' | 'diners' | 'discover' | 'interac' | 'jcb' | 'mastercard' | 'unionpay' | 'unknown' | 'visa' /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: 'any' | 'automatic' /** @enum {string} */ - setup_future_usage?: "" | "none" | "off_session" | "on_session"; + setup_future_usage?: '' | 'none' | 'off_session' | 'on_session' }> & - Partial<"">; - card_present?: Partial<{ [key: string]: unknown }> & Partial<"">; - eps?: Partial<{ [key: string]: unknown }> & Partial<"">; - fpx?: Partial<{ [key: string]: unknown }> & Partial<"">; - giropay?: Partial<{ [key: string]: unknown }> & Partial<"">; - grabpay?: Partial<{ [key: string]: unknown }> & Partial<"">; - ideal?: Partial<{ [key: string]: unknown }> & Partial<"">; - interac_present?: Partial<{ [key: string]: unknown }> & Partial<"">; + Partial<''> + card_present?: Partial<{ [key: string]: unknown }> & Partial<''> + eps?: Partial<{ [key: string]: unknown }> & Partial<''> + fpx?: Partial<{ [key: string]: unknown }> & Partial<''> + giropay?: Partial<{ [key: string]: unknown }> & Partial<''> + grabpay?: Partial<{ [key: string]: unknown }> & Partial<''> + ideal?: Partial<{ [key: string]: unknown }> & Partial<''> + interac_present?: Partial<{ [key: string]: unknown }> & Partial<''> klarna?: Partial<{ /** @enum {string} */ preferred_locale?: - | "da-DK" - | "de-AT" - | "de-DE" - | "en-AT" - | "en-BE" - | "en-DE" - | "en-DK" - | "en-ES" - | "en-FI" - | "en-FR" - | "en-GB" - | "en-IE" - | "en-IT" - | "en-NL" - | "en-NO" - | "en-SE" - | "en-US" - | "es-ES" - | "es-US" - | "fi-FI" - | "fr-BE" - | "fr-FR" - | "it-IT" - | "nb-NO" - | "nl-BE" - | "nl-NL" - | "sv-FI" - | "sv-SE"; + | 'da-DK' + | 'de-AT' + | 'de-DE' + | 'en-AT' + | 'en-BE' + | 'en-DE' + | 'en-DK' + | 'en-ES' + | 'en-FI' + | 'en-FR' + | 'en-GB' + | 'en-IE' + | 'en-IT' + | 'en-NL' + | 'en-NO' + | 'en-SE' + | 'en-US' + | 'es-ES' + | 'es-US' + | 'fi-FI' + | 'fr-BE' + | 'fr-FR' + | 'it-IT' + | 'nb-NO' + | 'nl-BE' + | 'nl-NL' + | 'sv-FI' + | 'sv-SE' }> & - Partial<"">; + Partial<''> oxxo?: Partial<{ - expires_after_days?: number; + expires_after_days?: number }> & - Partial<"">; + Partial<''> p24?: Partial<{ - tos_shown_and_accepted?: boolean; + tos_shown_and_accepted?: boolean }> & - Partial<"">; + Partial<''> sepa_debit?: Partial<{ /** payment_method_options_mandate_options_param */ - mandate_options?: { [key: string]: unknown }; + mandate_options?: { [key: string]: unknown } }> & - Partial<"">; + Partial<''> sofort?: Partial<{ /** @enum {string} */ - preferred_language?: "" | "de" | "en" | "es" | "fr" | "it" | "nl" | "pl"; + preferred_language?: '' | 'de' | 'en' | 'es' | 'fr' | 'it' | 'nl' | 'pl' }> & - Partial<"">; + Partial<''> wechat_pay?: Partial<{ - app_id?: string; + app_id?: string /** @enum {string} */ - client: "android" | "ios" | "web"; + client: 'android' | 'ios' | 'web' }> & - Partial<"">; - }; + Partial<''> + } /** @description The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. */ - payment_method_types?: string[]; + payment_method_types?: string[] /** @description 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?: Partial & Partial<"">; + receipt_email?: Partial & Partial<''> /** * @description The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. * If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. * This parameter is only used for cards and other redirect-based payment methods. */ - return_url?: string; + return_url?: string /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * @@ -34093,130 +33844,130 @@ export interface operations { * If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. * @enum {string} */ - setup_future_usage?: "" | "off_session" | "on_session"; + setup_future_usage?: '' | 'off_session' | 'on_session' /** @description Shipping information for this PaymentIntent. */ shipping?: Partial<{ /** optional_fields_address */ address: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - carrier?: string; - name: string; - phone?: string; - tracking_number?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + carrier?: string + name: string + phone?: string + tracking_number?: string }> & - Partial<"">; + Partial<''> /** @description Set to `true` only when using manual confirmation and the iOS or Android SDKs to handle additional authentication steps. */ - use_stripe_sdk?: boolean; - }; - }; - }; - }; + use_stripe_sdk?: boolean + } + } + } + } /**

Verifies microdeposits on a PaymentIntent object.

*/ PostPaymentIntentsIntentVerifyMicrodeposits: { parameters: { path: { - intent: string; - }; - }; + intent: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_intent"]; - }; - }; + 'application/json': components['schemas']['payment_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account. */ - amounts?: number[]; + amounts?: number[] /** @description The client secret of the PaymentIntent. */ - client_secret?: string; + client_secret?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Returns a list of your payment links.

*/ GetPaymentLinks: { parameters: { query: { /** Only return payment links that are active or inactive (e.g., pass `false` to list all inactive payment links). */ - active?: boolean; + active?: boolean /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["payment_link"][]; + 'application/json': { + data: components['schemas']['payment_link'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a payment link.

*/ PostPaymentLinks: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_link"]; - }; - }; + 'application/json': components['schemas']['payment_link'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * after_completion_params * @description Behavior after the purchase is complete. @@ -34224,52 +33975,52 @@ export interface operations { after_completion?: { /** after_completion_confirmation_page_params */ hosted_confirmation?: { - custom_message?: string; - }; + custom_message?: string + } /** after_completion_redirect_params */ redirect?: { - url: string; - }; + url: string + } /** @enum {string} */ - type: "hosted_confirmation" | "redirect"; - }; + type: 'hosted_confirmation' | 'redirect' + } /** @description Enables user redeemable promotion codes. */ - allow_promotion_codes?: boolean; + allow_promotion_codes?: boolean /** @description 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. Can only be applied when there are no line items with recurring prices. */ - application_fee_amount?: number; + application_fee_amount?: number /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field. */ - application_fee_percent?: number; + application_fee_percent?: number /** * automatic_tax_params * @description Configuration for automatic tax collection. */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** * @description Configuration for collecting the customer's billing address. * @enum {string} */ - billing_address_collection?: "auto" | "required"; + billing_address_collection?: 'auto' | 'required' /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported. */ line_items?: { /** adjustable_quantity_params */ adjustable_quantity?: { - enabled: boolean; - maximum?: number; - minimum?: number; - }; - price: string; - quantity: number; - }[]; + enabled: boolean + maximum?: number + minimum?: number + } + price: string + quantity: number + }[] /** @description 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 associated with this Payment Link will automatically be copied to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link. */ - metadata?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The account on behalf of which to charge. */ - on_behalf_of?: string; + on_behalf_of?: string /** @description The list of payment method types that customers can use. Only `card` is supported. If no value is passed, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods) (20+ payment methods [supported](https://stripe.com/docs/payments/payment-methods/integration-options#payment-method-product-support)). */ - payment_method_types?: "card"[]; + payment_method_types?: 'card'[] /** * phone_number_collection_params * @description Controls phone number collection settings during checkout. @@ -34277,329 +34028,329 @@ export interface operations { * We recommend that you review your privacy policy and check with your legal contacts. */ phone_number_collection?: { - enabled: boolean; - }; + enabled: boolean + } /** * shipping_address_collection_params * @description Configuration for collecting the customer's shipping address. */ shipping_address_collection?: { allowed_countries: ( - | "AC" - | "AD" - | "AE" - | "AF" - | "AG" - | "AI" - | "AL" - | "AM" - | "AO" - | "AQ" - | "AR" - | "AT" - | "AU" - | "AW" - | "AX" - | "AZ" - | "BA" - | "BB" - | "BD" - | "BE" - | "BF" - | "BG" - | "BH" - | "BI" - | "BJ" - | "BL" - | "BM" - | "BN" - | "BO" - | "BQ" - | "BR" - | "BS" - | "BT" - | "BV" - | "BW" - | "BY" - | "BZ" - | "CA" - | "CD" - | "CF" - | "CG" - | "CH" - | "CI" - | "CK" - | "CL" - | "CM" - | "CN" - | "CO" - | "CR" - | "CV" - | "CW" - | "CY" - | "CZ" - | "DE" - | "DJ" - | "DK" - | "DM" - | "DO" - | "DZ" - | "EC" - | "EE" - | "EG" - | "EH" - | "ER" - | "ES" - | "ET" - | "FI" - | "FJ" - | "FK" - | "FO" - | "FR" - | "GA" - | "GB" - | "GD" - | "GE" - | "GF" - | "GG" - | "GH" - | "GI" - | "GL" - | "GM" - | "GN" - | "GP" - | "GQ" - | "GR" - | "GS" - | "GT" - | "GU" - | "GW" - | "GY" - | "HK" - | "HN" - | "HR" - | "HT" - | "HU" - | "ID" - | "IE" - | "IL" - | "IM" - | "IN" - | "IO" - | "IQ" - | "IS" - | "IT" - | "JE" - | "JM" - | "JO" - | "JP" - | "KE" - | "KG" - | "KH" - | "KI" - | "KM" - | "KN" - | "KR" - | "KW" - | "KY" - | "KZ" - | "LA" - | "LB" - | "LC" - | "LI" - | "LK" - | "LR" - | "LS" - | "LT" - | "LU" - | "LV" - | "LY" - | "MA" - | "MC" - | "MD" - | "ME" - | "MF" - | "MG" - | "MK" - | "ML" - | "MM" - | "MN" - | "MO" - | "MQ" - | "MR" - | "MS" - | "MT" - | "MU" - | "MV" - | "MW" - | "MX" - | "MY" - | "MZ" - | "NA" - | "NC" - | "NE" - | "NG" - | "NI" - | "NL" - | "NO" - | "NP" - | "NR" - | "NU" - | "NZ" - | "OM" - | "PA" - | "PE" - | "PF" - | "PG" - | "PH" - | "PK" - | "PL" - | "PM" - | "PN" - | "PR" - | "PS" - | "PT" - | "PY" - | "QA" - | "RE" - | "RO" - | "RS" - | "RU" - | "RW" - | "SA" - | "SB" - | "SC" - | "SE" - | "SG" - | "SH" - | "SI" - | "SJ" - | "SK" - | "SL" - | "SM" - | "SN" - | "SO" - | "SR" - | "SS" - | "ST" - | "SV" - | "SX" - | "SZ" - | "TA" - | "TC" - | "TD" - | "TF" - | "TG" - | "TH" - | "TJ" - | "TK" - | "TL" - | "TM" - | "TN" - | "TO" - | "TR" - | "TT" - | "TV" - | "TW" - | "TZ" - | "UA" - | "UG" - | "US" - | "UY" - | "UZ" - | "VA" - | "VC" - | "VE" - | "VG" - | "VN" - | "VU" - | "WF" - | "WS" - | "XK" - | "YE" - | "YT" - | "ZA" - | "ZM" - | "ZW" - | "ZZ" - )[]; - }; + | 'AC' + | 'AD' + | 'AE' + | 'AF' + | 'AG' + | 'AI' + | 'AL' + | 'AM' + | 'AO' + | 'AQ' + | 'AR' + | 'AT' + | 'AU' + | 'AW' + | 'AX' + | 'AZ' + | 'BA' + | 'BB' + | 'BD' + | 'BE' + | 'BF' + | 'BG' + | 'BH' + | 'BI' + | 'BJ' + | 'BL' + | 'BM' + | 'BN' + | 'BO' + | 'BQ' + | 'BR' + | 'BS' + | 'BT' + | 'BV' + | 'BW' + | 'BY' + | 'BZ' + | 'CA' + | 'CD' + | 'CF' + | 'CG' + | 'CH' + | 'CI' + | 'CK' + | 'CL' + | 'CM' + | 'CN' + | 'CO' + | 'CR' + | 'CV' + | 'CW' + | 'CY' + | 'CZ' + | 'DE' + | 'DJ' + | 'DK' + | 'DM' + | 'DO' + | 'DZ' + | 'EC' + | 'EE' + | 'EG' + | 'EH' + | 'ER' + | 'ES' + | 'ET' + | 'FI' + | 'FJ' + | 'FK' + | 'FO' + | 'FR' + | 'GA' + | 'GB' + | 'GD' + | 'GE' + | 'GF' + | 'GG' + | 'GH' + | 'GI' + | 'GL' + | 'GM' + | 'GN' + | 'GP' + | 'GQ' + | 'GR' + | 'GS' + | 'GT' + | 'GU' + | 'GW' + | 'GY' + | 'HK' + | 'HN' + | 'HR' + | 'HT' + | 'HU' + | 'ID' + | 'IE' + | 'IL' + | 'IM' + | 'IN' + | 'IO' + | 'IQ' + | 'IS' + | 'IT' + | 'JE' + | 'JM' + | 'JO' + | 'JP' + | 'KE' + | 'KG' + | 'KH' + | 'KI' + | 'KM' + | 'KN' + | 'KR' + | 'KW' + | 'KY' + | 'KZ' + | 'LA' + | 'LB' + | 'LC' + | 'LI' + | 'LK' + | 'LR' + | 'LS' + | 'LT' + | 'LU' + | 'LV' + | 'LY' + | 'MA' + | 'MC' + | 'MD' + | 'ME' + | 'MF' + | 'MG' + | 'MK' + | 'ML' + | 'MM' + | 'MN' + | 'MO' + | 'MQ' + | 'MR' + | 'MS' + | 'MT' + | 'MU' + | 'MV' + | 'MW' + | 'MX' + | 'MY' + | 'MZ' + | 'NA' + | 'NC' + | 'NE' + | 'NG' + | 'NI' + | 'NL' + | 'NO' + | 'NP' + | 'NR' + | 'NU' + | 'NZ' + | 'OM' + | 'PA' + | 'PE' + | 'PF' + | 'PG' + | 'PH' + | 'PK' + | 'PL' + | 'PM' + | 'PN' + | 'PR' + | 'PS' + | 'PT' + | 'PY' + | 'QA' + | 'RE' + | 'RO' + | 'RS' + | 'RU' + | 'RW' + | 'SA' + | 'SB' + | 'SC' + | 'SE' + | 'SG' + | 'SH' + | 'SI' + | 'SJ' + | 'SK' + | 'SL' + | 'SM' + | 'SN' + | 'SO' + | 'SR' + | 'SS' + | 'ST' + | 'SV' + | 'SX' + | 'SZ' + | 'TA' + | 'TC' + | 'TD' + | 'TF' + | 'TG' + | 'TH' + | 'TJ' + | 'TK' + | 'TL' + | 'TM' + | 'TN' + | 'TO' + | 'TR' + | 'TT' + | 'TV' + | 'TW' + | 'TZ' + | 'UA' + | 'UG' + | 'US' + | 'UY' + | 'UZ' + | 'VA' + | 'VC' + | 'VE' + | 'VG' + | 'VN' + | 'VU' + | 'WF' + | 'WS' + | 'XK' + | 'YE' + | 'YT' + | 'ZA' + | 'ZM' + | 'ZW' + | 'ZZ' + )[] + } /** * subscription_data_params * @description 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?: { - trial_period_days?: number; - }; + trial_period_days?: number + } /** * transfer_data_params * @description 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?: { - amount?: number; - destination: string; - }; - }; - }; - }; - }; + amount?: number + destination: string + } + } + } + } + } /**

Retrieve a payment link.

*/ GetPaymentLinksPaymentLink: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - payment_link: string; - }; - }; + payment_link: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_link"]; - }; - }; + 'application/json': components['schemas']['payment_link'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates a payment link.

*/ PostPaymentLinksPaymentLink: { parameters: { path: { - payment_link: string; - }; - }; + payment_link: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_link"]; - }; - }; + 'application/json': components['schemas']['payment_link'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description 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?: boolean; + active?: boolean /** * after_completion_params * @description Behavior after the purchase is complete. @@ -34607,410 +34358,410 @@ export interface operations { after_completion?: { /** after_completion_confirmation_page_params */ hosted_confirmation?: { - custom_message?: string; - }; + custom_message?: string + } /** after_completion_redirect_params */ redirect?: { - url: string; - }; + url: string + } /** @enum {string} */ - type: "hosted_confirmation" | "redirect"; - }; + type: 'hosted_confirmation' | 'redirect' + } /** @description Enables user redeemable promotion codes. */ - allow_promotion_codes?: boolean; + allow_promotion_codes?: boolean /** * automatic_tax_params * @description Configuration for automatic tax collection. */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** * @description Configuration for collecting the customer's billing address. * @enum {string} */ - billing_address_collection?: "auto" | "required"; + billing_address_collection?: 'auto' | 'required' /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported. */ line_items?: { /** adjustable_quantity_params */ adjustable_quantity?: { - enabled: boolean; - maximum?: number; - minimum?: number; - }; - id: string; - quantity?: number; - }[]; + enabled: boolean + maximum?: number + minimum?: number + } + id: string + quantity?: number + }[] /** @description 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 associated with this Payment Link will automatically be copied to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link. */ - metadata?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The list of payment method types that customers can use. Only `card` is supported. Pass an empty string to enable automatic payment methods that use your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). */ - payment_method_types?: Partial<"card"[]> & Partial<"">; + payment_method_types?: Partial<'card'[]> & Partial<''> /** @description Configuration for collecting the customer's shipping address. */ shipping_address_collection?: Partial<{ allowed_countries: ( - | "AC" - | "AD" - | "AE" - | "AF" - | "AG" - | "AI" - | "AL" - | "AM" - | "AO" - | "AQ" - | "AR" - | "AT" - | "AU" - | "AW" - | "AX" - | "AZ" - | "BA" - | "BB" - | "BD" - | "BE" - | "BF" - | "BG" - | "BH" - | "BI" - | "BJ" - | "BL" - | "BM" - | "BN" - | "BO" - | "BQ" - | "BR" - | "BS" - | "BT" - | "BV" - | "BW" - | "BY" - | "BZ" - | "CA" - | "CD" - | "CF" - | "CG" - | "CH" - | "CI" - | "CK" - | "CL" - | "CM" - | "CN" - | "CO" - | "CR" - | "CV" - | "CW" - | "CY" - | "CZ" - | "DE" - | "DJ" - | "DK" - | "DM" - | "DO" - | "DZ" - | "EC" - | "EE" - | "EG" - | "EH" - | "ER" - | "ES" - | "ET" - | "FI" - | "FJ" - | "FK" - | "FO" - | "FR" - | "GA" - | "GB" - | "GD" - | "GE" - | "GF" - | "GG" - | "GH" - | "GI" - | "GL" - | "GM" - | "GN" - | "GP" - | "GQ" - | "GR" - | "GS" - | "GT" - | "GU" - | "GW" - | "GY" - | "HK" - | "HN" - | "HR" - | "HT" - | "HU" - | "ID" - | "IE" - | "IL" - | "IM" - | "IN" - | "IO" - | "IQ" - | "IS" - | "IT" - | "JE" - | "JM" - | "JO" - | "JP" - | "KE" - | "KG" - | "KH" - | "KI" - | "KM" - | "KN" - | "KR" - | "KW" - | "KY" - | "KZ" - | "LA" - | "LB" - | "LC" - | "LI" - | "LK" - | "LR" - | "LS" - | "LT" - | "LU" - | "LV" - | "LY" - | "MA" - | "MC" - | "MD" - | "ME" - | "MF" - | "MG" - | "MK" - | "ML" - | "MM" - | "MN" - | "MO" - | "MQ" - | "MR" - | "MS" - | "MT" - | "MU" - | "MV" - | "MW" - | "MX" - | "MY" - | "MZ" - | "NA" - | "NC" - | "NE" - | "NG" - | "NI" - | "NL" - | "NO" - | "NP" - | "NR" - | "NU" - | "NZ" - | "OM" - | "PA" - | "PE" - | "PF" - | "PG" - | "PH" - | "PK" - | "PL" - | "PM" - | "PN" - | "PR" - | "PS" - | "PT" - | "PY" - | "QA" - | "RE" - | "RO" - | "RS" - | "RU" - | "RW" - | "SA" - | "SB" - | "SC" - | "SE" - | "SG" - | "SH" - | "SI" - | "SJ" - | "SK" - | "SL" - | "SM" - | "SN" - | "SO" - | "SR" - | "SS" - | "ST" - | "SV" - | "SX" - | "SZ" - | "TA" - | "TC" - | "TD" - | "TF" - | "TG" - | "TH" - | "TJ" - | "TK" - | "TL" - | "TM" - | "TN" - | "TO" - | "TR" - | "TT" - | "TV" - | "TW" - | "TZ" - | "UA" - | "UG" - | "US" - | "UY" - | "UZ" - | "VA" - | "VC" - | "VE" - | "VG" - | "VN" - | "VU" - | "WF" - | "WS" - | "XK" - | "YE" - | "YT" - | "ZA" - | "ZM" - | "ZW" - | "ZZ" - )[]; + | 'AC' + | 'AD' + | 'AE' + | 'AF' + | 'AG' + | 'AI' + | 'AL' + | 'AM' + | 'AO' + | 'AQ' + | 'AR' + | 'AT' + | 'AU' + | 'AW' + | 'AX' + | 'AZ' + | 'BA' + | 'BB' + | 'BD' + | 'BE' + | 'BF' + | 'BG' + | 'BH' + | 'BI' + | 'BJ' + | 'BL' + | 'BM' + | 'BN' + | 'BO' + | 'BQ' + | 'BR' + | 'BS' + | 'BT' + | 'BV' + | 'BW' + | 'BY' + | 'BZ' + | 'CA' + | 'CD' + | 'CF' + | 'CG' + | 'CH' + | 'CI' + | 'CK' + | 'CL' + | 'CM' + | 'CN' + | 'CO' + | 'CR' + | 'CV' + | 'CW' + | 'CY' + | 'CZ' + | 'DE' + | 'DJ' + | 'DK' + | 'DM' + | 'DO' + | 'DZ' + | 'EC' + | 'EE' + | 'EG' + | 'EH' + | 'ER' + | 'ES' + | 'ET' + | 'FI' + | 'FJ' + | 'FK' + | 'FO' + | 'FR' + | 'GA' + | 'GB' + | 'GD' + | 'GE' + | 'GF' + | 'GG' + | 'GH' + | 'GI' + | 'GL' + | 'GM' + | 'GN' + | 'GP' + | 'GQ' + | 'GR' + | 'GS' + | 'GT' + | 'GU' + | 'GW' + | 'GY' + | 'HK' + | 'HN' + | 'HR' + | 'HT' + | 'HU' + | 'ID' + | 'IE' + | 'IL' + | 'IM' + | 'IN' + | 'IO' + | 'IQ' + | 'IS' + | 'IT' + | 'JE' + | 'JM' + | 'JO' + | 'JP' + | 'KE' + | 'KG' + | 'KH' + | 'KI' + | 'KM' + | 'KN' + | 'KR' + | 'KW' + | 'KY' + | 'KZ' + | 'LA' + | 'LB' + | 'LC' + | 'LI' + | 'LK' + | 'LR' + | 'LS' + | 'LT' + | 'LU' + | 'LV' + | 'LY' + | 'MA' + | 'MC' + | 'MD' + | 'ME' + | 'MF' + | 'MG' + | 'MK' + | 'ML' + | 'MM' + | 'MN' + | 'MO' + | 'MQ' + | 'MR' + | 'MS' + | 'MT' + | 'MU' + | 'MV' + | 'MW' + | 'MX' + | 'MY' + | 'MZ' + | 'NA' + | 'NC' + | 'NE' + | 'NG' + | 'NI' + | 'NL' + | 'NO' + | 'NP' + | 'NR' + | 'NU' + | 'NZ' + | 'OM' + | 'PA' + | 'PE' + | 'PF' + | 'PG' + | 'PH' + | 'PK' + | 'PL' + | 'PM' + | 'PN' + | 'PR' + | 'PS' + | 'PT' + | 'PY' + | 'QA' + | 'RE' + | 'RO' + | 'RS' + | 'RU' + | 'RW' + | 'SA' + | 'SB' + | 'SC' + | 'SE' + | 'SG' + | 'SH' + | 'SI' + | 'SJ' + | 'SK' + | 'SL' + | 'SM' + | 'SN' + | 'SO' + | 'SR' + | 'SS' + | 'ST' + | 'SV' + | 'SX' + | 'SZ' + | 'TA' + | 'TC' + | 'TD' + | 'TF' + | 'TG' + | 'TH' + | 'TJ' + | 'TK' + | 'TL' + | 'TM' + | 'TN' + | 'TO' + | 'TR' + | 'TT' + | 'TV' + | 'TW' + | 'TZ' + | 'UA' + | 'UG' + | 'US' + | 'UY' + | 'UZ' + | 'VA' + | 'VC' + | 'VE' + | 'VG' + | 'VN' + | 'VU' + | 'WF' + | 'WS' + | 'XK' + | 'YE' + | 'YT' + | 'ZA' + | 'ZM' + | 'ZW' + | 'ZZ' + )[] }> & - Partial<"">; - }; - }; - }; - }; + Partial<''> + } + } + } + } /**

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.

*/ GetPaymentLinksPaymentLinkLineItems: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - payment_link: string; - }; - }; + payment_link: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["item"][]; + data: components['schemas']['item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of PaymentMethods. For listing a customer’s payment methods, you should use List a Customer’s PaymentMethods

*/ GetPaymentMethods: { parameters: { query: { /** The ID of the customer whose PaymentMethods will be retrieved. If not provided, the response list will be empty. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** A required filter on the list, based on the object `type` field. */ type: - | "acss_debit" - | "afterpay_clearpay" - | "alipay" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "eps" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "klarna" - | "oxxo" - | "p24" - | "sepa_debit" - | "sofort" - | "wechat_pay"; - }; - }; - responses: { - /** Successful response. */ - 200: { - content: { - "application/json": { - data: components["schemas"]["payment_method"][]; + | 'acss_debit' + | 'afterpay_clearpay' + | 'alipay' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'eps' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'klarna' + | 'oxxo' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' + } + } + responses: { + /** Successful response. */ + 200: { + content: { + 'application/json': { + data: components['schemas']['payment_method'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Creates a PaymentMethod object. Read the Stripe.js reference to learn how to create PaymentMethods via Stripe.js.

* @@ -35021,96 +34772,96 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_method"]; - }; - }; + 'application/json': components['schemas']['payment_method'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * payment_method_param * @description If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. */ acss_debit?: { - account_number: string; - institution_number: string; - transit_number: string; - }; + account_number: string + institution_number: string + transit_number: string + } /** * param * @description If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method. */ - afterpay_clearpay?: { [key: string]: unknown }; + afterpay_clearpay?: { [key: string]: unknown } /** * param * @description If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method. */ - alipay?: { [key: string]: unknown }; + alipay?: { [key: string]: unknown } /** * param * @description If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account. */ au_becs_debit?: { - account_number: string; - bsb_number: string; - }; + account_number: string + bsb_number: string + } /** * param * @description If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account. */ bacs_debit?: { - account_number?: string; - sort_code?: string; - }; + account_number?: string + sort_code?: string + } /** * param * @description If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method. */ - bancontact?: { [key: string]: unknown }; + bancontact?: { [key: string]: unknown } /** * billing_details_inner_params * @description Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods. */ billing_details?: { address?: Partial<{ - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string }> & - Partial<"">; - email?: Partial & Partial<"">; - name?: string; - phone?: string; - }; + Partial<''> + email?: Partial & Partial<''> + name?: string + phone?: string + } /** * param * @description If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method. */ boleto?: { - tax_id: string; - }; + tax_id: string + } /** @description If this is a `card` PaymentMethod, this hash contains the user's card details. For backwards compatibility, you can alternatively provide a Stripe token (e.g., for Apple Pay, Amex Express Checkout, or legacy Checkout) into the card hash with format `card: {token: "tok_visa"}`. When providing a card number, you must meet the requirements for [PCI compliance](https://stripe.com/docs/security#validating-pci-compliance). We strongly recommend using Stripe.js instead of interacting with this API directly. */ card?: Partial<{ - cvc?: string; - exp_month: number; - exp_year: number; - number: string; + cvc?: string + exp_month: number + exp_year: number + number: string }> & Partial<{ - token: string; - }>; + token: string + }> /** @description The `Customer` to whom the original PaymentMethod is attached. */ - customer?: string; + customer?: string /** * param * @description If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method. @@ -35118,36 +34869,36 @@ export interface operations { eps?: { /** @enum {string} */ bank?: - | "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" - | "dolomitenbank" - | "easybank_ag" - | "erste_bank_und_sparkassen" - | "hypo_alpeadriabank_international_ag" - | "hypo_bank_burgenland_aktiengesellschaft" - | "hypo_noe_lb_fur_niederosterreich_u_wien" - | "hypo_oberosterreich_salzburg_steiermark" - | "hypo_tirol_bank_ag" - | "hypo_vorarlberg_bank_ag" - | "marchfelder_bank" - | "oberbank_ag" - | "raiffeisen_bankengruppe_osterreich" - | "schoellerbank_ag" - | "sparda_bank_wien" - | "volksbank_gruppe" - | "volkskreditbank_ag" - | "vr_bank_braunau"; - }; + | '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' + | 'dolomitenbank' + | 'easybank_ag' + | 'erste_bank_und_sparkassen' + | 'hypo_alpeadriabank_international_ag' + | 'hypo_bank_burgenland_aktiengesellschaft' + | 'hypo_noe_lb_fur_niederosterreich_u_wien' + | 'hypo_oberosterreich_salzburg_steiermark' + | 'hypo_tirol_bank_ag' + | 'hypo_vorarlberg_bank_ag' + | 'marchfelder_bank' + | 'oberbank_ag' + | 'raiffeisen_bankengruppe_osterreich' + | 'schoellerbank_ag' + | 'sparda_bank_wien' + | 'volksbank_gruppe' + | 'volkskreditbank_ag' + | 'vr_bank_braunau' + } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * param * @description If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method. @@ -35155,38 +34906,38 @@ export interface operations { fpx?: { /** @enum {string} */ bank: - | "affin_bank" - | "agrobank" - | "alliance_bank" - | "ambank" - | "bank_islam" - | "bank_muamalat" - | "bank_rakyat" - | "bsn" - | "cimb" - | "deutsche_bank" - | "hong_leong_bank" - | "hsbc" - | "kfh" - | "maybank2e" - | "maybank2u" - | "ocbc" - | "pb_enterprise" - | "public_bank" - | "rhb" - | "standard_chartered" - | "uob"; - }; + | 'affin_bank' + | 'agrobank' + | 'alliance_bank' + | 'ambank' + | 'bank_islam' + | 'bank_muamalat' + | 'bank_rakyat' + | 'bsn' + | 'cimb' + | 'deutsche_bank' + | 'hong_leong_bank' + | 'hsbc' + | 'kfh' + | 'maybank2e' + | 'maybank2u' + | 'ocbc' + | 'pb_enterprise' + | 'public_bank' + | 'rhb' + | 'standard_chartered' + | 'uob' + } /** * param * @description If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method. */ - giropay?: { [key: string]: unknown }; + giropay?: { [key: string]: unknown } /** * param * @description If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method. */ - grabpay?: { [key: string]: unknown }; + grabpay?: { [key: string]: unknown } /** * param * @description If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method. @@ -35194,25 +34945,25 @@ export interface operations { ideal?: { /** @enum {string} */ bank?: - | "abn_amro" - | "asn_bank" - | "bunq" - | "handelsbanken" - | "ing" - | "knab" - | "moneyou" - | "rabobank" - | "regiobank" - | "revolut" - | "sns_bank" - | "triodos_bank" - | "van_lanschot"; - }; + | 'abn_amro' + | 'asn_bank' + | 'bunq' + | 'handelsbanken' + | 'ing' + | 'knab' + | 'moneyou' + | 'rabobank' + | 'regiobank' + | 'revolut' + | 'sns_bank' + | 'triodos_bank' + | 'van_lanschot' + } /** * param * @description If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method. */ - interac_present?: { [key: string]: unknown }; + interac_present?: { [key: string]: unknown } /** * param * @description If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method. @@ -35220,18 +34971,18 @@ export interface operations { klarna?: { /** date_of_birth */ dob?: { - day: number; - month: number; - year: number; - }; - }; + day: number + month: number + year: number + } + } /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * param * @description If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method. */ - oxxo?: { [key: string]: unknown }; + oxxo?: { [key: string]: unknown } /** * param * @description If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method. @@ -35239,171 +34990,171 @@ export interface operations { p24?: { /** @enum {string} */ bank?: - | "alior_bank" - | "bank_millennium" - | "bank_nowy_bfg_sa" - | "bank_pekao_sa" - | "banki_spbdzielcze" - | "blik" - | "bnp_paribas" - | "boz" - | "citi_handlowy" - | "credit_agricole" - | "envelobank" - | "etransfer_pocztowy24" - | "getin_bank" - | "ideabank" - | "ing" - | "inteligo" - | "mbank_mtransfer" - | "nest_przelew" - | "noble_pay" - | "pbac_z_ipko" - | "plus_bank" - | "santander_przelew24" - | "tmobile_usbugi_bankowe" - | "toyota_bank" - | "volkswagen_bank"; - }; + | 'alior_bank' + | 'bank_millennium' + | 'bank_nowy_bfg_sa' + | 'bank_pekao_sa' + | 'banki_spbdzielcze' + | 'blik' + | 'bnp_paribas' + | 'boz' + | 'citi_handlowy' + | 'credit_agricole' + | 'envelobank' + | 'etransfer_pocztowy24' + | 'getin_bank' + | 'ideabank' + | 'ing' + | 'inteligo' + | 'mbank_mtransfer' + | 'nest_przelew' + | 'noble_pay' + | 'pbac_z_ipko' + | 'plus_bank' + | 'santander_przelew24' + | 'tmobile_usbugi_bankowe' + | 'toyota_bank' + | 'volkswagen_bank' + } /** @description The PaymentMethod to share. */ - payment_method?: string; + payment_method?: string /** * param * @description If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account. */ sepa_debit?: { - iban: string; - }; + iban: string + } /** * param * @description If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method. */ sofort?: { /** @enum {string} */ - country: "AT" | "BE" | "DE" | "ES" | "IT" | "NL"; - }; + country: 'AT' | 'BE' | 'DE' | 'ES' | 'IT' | 'NL' + } /** * @description 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. * @enum {string} */ type?: - | "acss_debit" - | "afterpay_clearpay" - | "alipay" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "eps" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "klarna" - | "oxxo" - | "p24" - | "sepa_debit" - | "sofort" - | "wechat_pay"; + | 'acss_debit' + | 'afterpay_clearpay' + | 'alipay' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'eps' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'klarna' + | 'oxxo' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' /** * param * @description If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method. */ - wechat_pay?: { [key: string]: unknown }; - }; - }; - }; - }; + wechat_pay?: { [key: string]: unknown } + } + } + } + } /**

Retrieves a PaymentMethod object.

*/ GetPaymentMethodsPaymentMethod: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - payment_method: string; - }; - }; + payment_method: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_method"]; - }; - }; + 'application/json': components['schemas']['payment_method'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates a PaymentMethod object. A PaymentMethod must be attached a customer to be updated.

*/ PostPaymentMethodsPaymentMethod: { parameters: { path: { - payment_method: string; - }; - }; + payment_method: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_method"]; - }; - }; + 'application/json': components['schemas']['payment_method'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * billing_details_inner_params * @description Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods. */ billing_details?: { address?: Partial<{ - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string }> & - Partial<"">; - email?: Partial & Partial<"">; - name?: string; - phone?: string; - }; + Partial<''> + email?: Partial & Partial<''> + name?: string + phone?: string + } /** * update_api_param * @description If this is a `card` PaymentMethod, this hash contains the user's card details. */ card?: { - exp_month?: number; - exp_year?: number; - }; + exp_month?: number + exp_year?: number + } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /** *

Attaches a PaymentMethod object to a Customer.

* @@ -35420,127 +35171,127 @@ export interface operations { PostPaymentMethodsPaymentMethodAttach: { parameters: { path: { - payment_method: string; - }; - }; + payment_method: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_method"]; - }; - }; + 'application/json': components['schemas']['payment_method'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The ID of the customer to which to attach the PaymentMethod. */ - customer: string; + customer: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Detaches a PaymentMethod object from a Customer.

*/ PostPaymentMethodsPaymentMethodDetach: { parameters: { path: { - payment_method: string; - }; - }; + payment_method: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_method"]; - }; - }; + 'application/json': components['schemas']['payment_method'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Returns a list of existing payouts sent to third-party bank accounts or that Stripe has sent you. The payouts are returned in sorted order, with the most recently created payouts appearing first.

*/ GetPayouts: { parameters: { query: { arrival_date?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** The ID of an external account - only return payouts sent to this external account. */ - destination?: string; + destination?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return payouts that have the given status: `pending`, `paid`, `failed`, or `canceled`. */ - status?: string; - }; - }; + status?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["payout"][]; + 'application/json': { + data: components['schemas']['payout'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

To send funds to your own bank account, you create a new payout object. Your Stripe balance must be able to cover the payout amount, or you’ll receive an “Insufficient Funds” error.

* @@ -35553,140 +35304,140 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payout"]; - }; - }; + 'application/json': components['schemas']['payout'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A positive integer in cents representing how much to payout. */ - amount: number; + amount: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description The ID of a bank account or a card to send the payout to. If no destination is supplied, the default external account for the specified currency will be used. */ - destination?: string; + destination?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * @description The method used to send this payout, which can be `standard` or `instant`. `instant` is only supported for payouts to debit cards. (See [Instant payouts for marketplaces for more information](https://stripe.com/blog/instant-payouts-for-marketplaces).) * @enum {string} */ - method?: "instant" | "standard"; + method?: 'instant' | 'standard' /** * @description The balance type of your Stripe balance to draw this payout from. Balances for different payment sources are kept separately. You can find the amounts with the balances API. One of `bank_account`, `card`, or `fpx`. * @enum {string} */ - source_type?: "bank_account" | "card" | "fpx"; + source_type?: 'bank_account' | 'card' | 'fpx' /** @description A string to be displayed on the recipient's bank or card statement. This may be at most 22 characters. Attempting to use a `statement_descriptor` longer than 22 characters will return an error. Note: Most banks will truncate this information and/or display it inconsistently. Some may not display it at all. */ - statement_descriptor?: string; - }; - }; - }; - }; + statement_descriptor?: string + } + } + } + } /**

Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list, and Stripe will return the corresponding payout information.

*/ GetPayoutsPayout: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - payout: string; - }; - }; + payout: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payout"]; - }; - }; + 'application/json': components['schemas']['payout'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates the specified payout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request accepts only the metadata as arguments.

*/ PostPayoutsPayout: { parameters: { path: { - payout: string; - }; - }; + payout: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payout"]; - }; - }; + 'application/json': components['schemas']['payout'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

A previously created payout can be canceled if it has not yet been paid out. Funds will be refunded to your available balance. You may not cancel automatic Stripe payouts.

*/ PostPayoutsPayoutCancel: { parameters: { path: { - payout: string; - }; - }; + payout: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payout"]; - }; - }; + 'application/json': components['schemas']['payout'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /** *

Reverses a payout by debiting the destination bank account. Only payouts for connected accounts to US bank accounts may be reversed at this time. If the payout is in the pending status, /v1/payouts/:id/cancel should be used instead.

* @@ -35695,1556 +35446,1556 @@ export interface operations { PostPayoutsPayoutReverse: { parameters: { path: { - payout: string; - }; - }; + payout: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payout"]; - }; - }; + 'application/json': components['schemas']['payout'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; - }; - }; - }; - }; + metadata?: { [key: string]: string } + } + } + } + } /**

Returns a list of your plans.

*/ GetPlans: { parameters: { query: { /** Only return plans that are active or inactive (e.g., pass `false` to list all inactive plans). */ - active?: boolean; + active?: boolean /** 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?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return plans for the given product. */ - product?: string; + product?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["plan"][]; + data: components['schemas']['plan'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.

*/ PostPlans: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["plan"]; - }; - }; + 'application/json': components['schemas']['plan'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether the plan is currently available for new subscriptions. Defaults to `true`. */ - active?: boolean; + active?: boolean /** * @description 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`. * @enum {string} */ - aggregate_usage?: "last_during_period" | "last_ever" | "max" | "sum"; + aggregate_usage?: 'last_during_period' | 'last_ever' | 'max' | 'sum' /** @description A positive integer in %s (or 0 for a free plan) representing how much to charge on a recurring basis. */ - amount?: number; + amount?: number /** * Format: decimal * @description Same as `amount`, but accepts a decimal value with at most 12 decimal places. Only one of `amount` and `amount_decimal` can be set. */ - amount_decimal?: string; + amount_decimal?: string /** * @description 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. * @enum {string} */ - billing_scheme?: "per_unit" | "tiered"; + billing_scheme?: 'per_unit' | 'tiered' /** @description 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: string; + currency: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description An identifier randomly generated by Stripe. Used to identify this plan when subscribing a customer. You can optionally override this ID, but the ID must be unique across all plans in your Stripe account. You can, however, use the same plan ID in both live and test modes. */ - id?: string; + id?: string /** * @description Specifies billing frequency. Either `day`, `week`, `month` or `year`. * @enum {string} */ - interval: "day" | "month" | "week" | "year"; + interval: 'day' | 'month' | 'week' | 'year' /** @description The number of intervals between subscription billings. 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?: number; + interval_count?: number /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description A brief description of the plan, hidden from customers. */ - nickname?: string; + nickname?: string product?: Partial<{ - active?: boolean; - id?: string; - metadata?: { [key: string]: string }; - name: string; - statement_descriptor?: string; - tax_code?: string; - unit_label?: string; + active?: boolean + id?: string + metadata?: { [key: string]: string } + name: string + statement_descriptor?: string + tax_code?: string + unit_label?: string }> & - Partial; + Partial /** @description Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. */ tiers?: { - flat_amount?: number; + flat_amount?: number /** Format: decimal */ - flat_amount_decimal?: string; - unit_amount?: number; + flat_amount_decimal?: string + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - up_to: Partial<"inf"> & Partial; - }[]; + unit_amount_decimal?: string + up_to: Partial<'inf'> & Partial + }[] /** * @description 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 successively change as the quantity grows. * @enum {string} */ - tiers_mode?: "graduated" | "volume"; + tiers_mode?: 'graduated' | 'volume' /** * transform_usage_param * @description Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`. */ transform_usage?: { - divide_by: number; + divide_by: number /** @enum {string} */ - round: "down" | "up"; - }; + round: 'down' | 'up' + } /** @description 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?: number; + trial_period_days?: number /** * @description 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`. * @enum {string} */ - usage_type?: "licensed" | "metered"; - }; - }; - }; - }; + usage_type?: 'licensed' | 'metered' + } + } + } + } /**

Retrieves the plan with the given ID.

*/ GetPlansPlan: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - plan: string; - }; - }; + plan: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["plan"]; - }; - }; + 'application/json': components['schemas']['plan'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostPlansPlan: { parameters: { path: { - plan: string; - }; - }; + plan: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["plan"]; - }; - }; + 'application/json': components['schemas']['plan'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether the plan is currently available for new subscriptions. */ - active?: boolean; + active?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description A brief description of the plan, hidden from customers. */ - nickname?: string; + nickname?: string /** @description The product the plan belongs to. This cannot be changed once it has been used in a subscription or subscription schedule. */ - product?: string; + product?: string /** @description 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?: number; - }; - }; - }; - }; + trial_period_days?: number + } + } + } + } /**

Deleting plans means new subscribers can’t be added. Existing subscribers aren’t affected.

*/ DeletePlansPlan: { parameters: { path: { - plan: string; - }; - }; + plan: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_plan"]; - }; - }; + 'application/json': components['schemas']['deleted_plan'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of your prices.

*/ GetPrices: { parameters: { query: { /** Only return prices that are active or inactive (e.g., pass `false` to list all inactive prices). */ - active?: boolean; + active?: boolean /** 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?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** Only return prices for the given currency. */ - currency?: string; + currency?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return the price with these lookup_keys, if any exist. */ - lookup_keys?: string[]; + lookup_keys?: string[] /** Only return prices for the given product. */ - product?: string; + product?: string /** Only return prices with these recurring fields. */ recurring?: { /** @enum {string} */ - interval?: "day" | "month" | "week" | "year"; + interval?: 'day' | 'month' | 'week' | 'year' /** @enum {string} */ - usage_type?: "licensed" | "metered"; - }; + usage_type?: 'licensed' | 'metered' + } /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return prices of type `recurring` or `one_time`. */ - type?: "one_time" | "recurring"; - }; - }; + type?: 'one_time' | 'recurring' + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["price"][]; + data: components['schemas']['price'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new price for an existing product. The price can be recurring or one-time.

*/ PostPrices: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["price"]; - }; - }; + 'application/json': components['schemas']['price'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether the price can be used for new purchases. Defaults to `true`. */ - active?: boolean; + active?: boolean /** * @description 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. * @enum {string} */ - billing_scheme?: "per_unit" | "tiered"; + billing_scheme?: 'per_unit' | 'tiered' /** @description 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: string; + currency: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters. */ - lookup_key?: string; + lookup_key?: string /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description A brief description of the price, hidden from customers. */ - nickname?: string; + nickname?: string /** @description The ID of the product that this price will belong to. */ - product?: string; + product?: string /** * inline_product_params * @description These fields can be used to create a new product that this price will belong to. */ product_data?: { - active?: boolean; - id?: string; - metadata?: { [key: string]: string }; - name: string; - statement_descriptor?: string; - tax_code?: string; - unit_label?: string; - }; + active?: boolean + id?: string + metadata?: { [key: string]: string } + name: string + statement_descriptor?: string + tax_code?: string + unit_label?: string + } /** * recurring * @description The recurring components of a price such as `interval` and `usage_type`. */ recurring?: { /** @enum {string} */ - aggregate_usage?: "last_during_period" | "last_ever" | "max" | "sum"; + aggregate_usage?: 'last_during_period' | 'last_ever' | 'max' | 'sum' /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number /** @enum {string} */ - usage_type?: "licensed" | "metered"; - }; + usage_type?: 'licensed' | 'metered' + } /** * @description 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. * @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' /** @description Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. */ tiers?: { - flat_amount?: number; + flat_amount?: number /** Format: decimal */ - flat_amount_decimal?: string; - unit_amount?: number; + flat_amount_decimal?: string + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - up_to: Partial<"inf"> & Partial; - }[]; + unit_amount_decimal?: string + up_to: Partial<'inf'> & Partial + }[] /** * @description 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 successively change as the quantity grows. * @enum {string} */ - tiers_mode?: "graduated" | "volume"; + tiers_mode?: 'graduated' | 'volume' /** @description If set to true, will atomically remove the lookup key from the existing price, and assign it to this price. */ - transfer_lookup_key?: boolean; + transfer_lookup_key?: boolean /** * transform_usage_param * @description Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`. */ transform_quantity?: { - divide_by: number; + divide_by: number /** @enum {string} */ - round: "down" | "up"; - }; + round: 'down' | 'up' + } /** @description A positive integer in %s (or 0 for a free price) representing how much to charge. */ - unit_amount?: number; + unit_amount?: number /** * Format: decimal * @description Same as `unit_amount`, but accepts a decimal value in %s with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. */ - unit_amount_decimal?: string; - }; - }; - }; - }; + unit_amount_decimal?: string + } + } + } + } /**

Retrieves the price with the given ID.

*/ GetPricesPrice: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - price: string; - }; - }; + price: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["price"]; - }; - }; + 'application/json': components['schemas']['price'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged.

*/ PostPricesPrice: { parameters: { path: { - price: string; - }; - }; + price: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["price"]; - }; - }; + 'application/json': components['schemas']['price'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether the price can be used for new purchases. Defaults to `true`. */ - active?: boolean; + active?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters. */ - lookup_key?: string; + lookup_key?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description A brief description of the price, hidden from customers. */ - nickname?: string; + nickname?: string /** * @description 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. * @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' /** @description If set to true, will atomically remove the lookup key from the existing price, and assign it to this price. */ - transfer_lookup_key?: boolean; - }; - }; - }; - }; + transfer_lookup_key?: boolean + } + } + } + } /**

Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.

*/ GetProducts: { parameters: { query: { /** Only return products that are active or inactive (e.g., pass `false` to list all inactive products). */ - active?: boolean; + active?: boolean /** Only return products that were created during the given date interval. */ created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** Only return products with the given IDs. */ - ids?: string[]; + ids?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return products that can be shipped (i.e., physical, not digital products). */ - shippable?: boolean; + shippable?: boolean /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return products with the given url. */ - url?: string; - }; - }; + url?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["product"][]; + data: components['schemas']['product'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new product object.

*/ PostProducts: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["product"]; - }; - }; + 'application/json': components['schemas']['product'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether the product is currently available for purchase. Defaults to `true`. */ - active?: boolean; + active?: boolean /** @description 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?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description An identifier will be randomly generated by Stripe. You can optionally override this ID, but the ID must be unique across all products in your Stripe account. */ - id?: string; + id?: string /** @description A list of up to 8 URLs of images for this product, meant to be displayable to the customer. */ - images?: string[]; + images?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The product's name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions. */ - name: string; + name: string /** * package_dimensions_specs * @description The dimensions of this product for shipping purposes. */ package_dimensions?: { - height: number; - length: number; - weight: number; - width: number; - }; + height: number + length: number + weight: number + width: number + } /** @description Whether this product is shipped (i.e., physical goods). */ - shippable?: boolean; + shippable?: boolean /** * @description An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all. * * This may be up to 22 characters. The statement description may not include `<`, `>`, `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. * It must contain at least one letter. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description A [tax code](https://stripe.com/docs/tax/tax-codes) ID. */ - tax_code?: string; + tax_code?: string /** @description A label that represents units of this product in Stripe and on customers’ receipts and invoices. When set, this will be included in associated invoice line item descriptions. */ - unit_label?: string; + unit_label?: string /** @description A URL of a publicly-accessible webpage for this product. */ - url?: string; - }; - }; - }; - }; + url?: string + } + } + } + } /**

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.

*/ GetProductsId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["product"]; - }; - }; + 'application/json': components['schemas']['product'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ PostProductsId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["product"]; - }; - }; + 'application/json': components['schemas']['product'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether the product is available for purchase. */ - active?: boolean; + active?: boolean /** @description 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?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A list of up to 8 URLs of images for this product, meant to be displayable to the customer. */ - images?: Partial & Partial<"">; + images?: Partial & Partial<''> /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The product's name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions. */ - name?: string; + name?: string /** @description The dimensions of this product for shipping purposes. */ package_dimensions?: Partial<{ - height: number; - length: number; - weight: number; - width: number; + height: number + length: number + weight: number + width: number }> & - Partial<"">; + Partial<''> /** @description Whether this product is shipped (i.e., physical goods). */ - shippable?: boolean; + shippable?: boolean /** * @description An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all. * * This may be up to 22 characters. The statement description may not include `<`, `>`, `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. * It must contain at least one letter. May only be set if `type=service`. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description A [tax code](https://stripe.com/docs/tax/tax-codes) ID. */ - tax_code?: Partial & Partial<"">; + tax_code?: Partial & Partial<''> /** @description A label that represents units of this product in Stripe and on customers’ receipts and invoices. When set, this will be included in associated invoice line item descriptions. May only be set if `type=service`. */ - unit_label?: string; + unit_label?: string /** @description A URL of a publicly-accessible webpage for this product. */ - url?: string; - }; - }; - }; - }; + url?: string + } + } + } + } /**

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.

*/ DeleteProductsId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_product"]; - }; - }; + 'application/json': components['schemas']['deleted_product'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of your promotion codes.

*/ GetPromotionCodes: { parameters: { query: { /** Filter promotion codes by whether they are active. */ - active?: boolean; + active?: boolean /** Only return promotion codes that have this case-insensitive code. */ - code?: string; + code?: string /** Only return promotion codes for this coupon. */ - coupon?: string; + coupon?: string /** 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?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** Only return promotion codes that are restricted to this customer. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["promotion_code"][]; + 'application/json': { + data: components['schemas']['promotion_code'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

A promotion code points to a coupon. You can optionally restrict the code to a specific customer, redemption limit, and expiration date.

*/ PostPromotionCodes: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["promotion_code"]; - }; - }; + 'application/json': components['schemas']['promotion_code'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether the promotion code is currently active. */ - active?: boolean; + active?: boolean /** @description The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for a specific customer. If left blank, we will generate one automatically. */ - code?: string; + code?: string /** @description The coupon for this promotion code. */ - coupon: string; + coupon: string /** @description The customer that this promotion code can be used by. If not set, the promotion code can be used by all customers. */ - customer?: string; + customer?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * Format: unix-time * @description The timestamp at which this promotion code will expire. If the coupon has specified a `redeems_by`, then this value cannot be after the coupon's `redeems_by`. */ - expires_at?: number; + expires_at?: number /** @description A positive integer specifying the number of times the promotion code can be redeemed. If the coupon has specified a `max_redemptions`, then this value cannot be greater than the coupon's `max_redemptions`. */ - max_redemptions?: number; + max_redemptions?: number /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * restrictions_params * @description Settings that restrict the redemption of the promotion code. */ restrictions?: { - first_time_transaction?: boolean; - minimum_amount?: number; - minimum_amount_currency?: string; - }; - }; - }; - }; - }; + first_time_transaction?: boolean + minimum_amount?: number + minimum_amount_currency?: string + } + } + } + } + } /**

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.

*/ GetPromotionCodesPromotionCode: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - promotion_code: string; - }; - }; + promotion_code: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["promotion_code"]; - }; - }; + 'application/json': components['schemas']['promotion_code'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates the specified promotion code by setting the values of the parameters passed. Most fields are, by design, not editable.

*/ PostPromotionCodesPromotionCode: { parameters: { path: { - promotion_code: string; - }; - }; + promotion_code: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["promotion_code"]; - }; - }; + 'application/json': components['schemas']['promotion_code'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether the promotion code is currently active. A promotion code can only be reactivated when the coupon is still valid and the promotion code is otherwise redeemable. */ - active?: boolean; + active?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Returns a list of your quotes.

*/ GetQuotes: { parameters: { query: { /** The ID of the customer whose quotes will be retrieved. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** The status of the quote. */ - status?: "accepted" | "canceled" | "draft" | "open"; - }; - }; + status?: 'accepted' | 'canceled' | 'draft' | 'open' + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["quote"][]; + 'application/json': { + data: components['schemas']['quote'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostQuotes: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["quote"]; - }; - }; + 'application/json': components['schemas']['quote'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description 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. There cannot be any line items with recurring prices when using this field. */ - application_fee_amount?: Partial & Partial<"">; + application_fee_amount?: Partial & Partial<''> /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field. */ - application_fee_percent?: Partial & Partial<"">; + application_fee_percent?: Partial & Partial<''> /** * automatic_tax_param * @description Settings for automatic tax lookup for this quote and resulting invoices and subscriptions. */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** * @description Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice 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. Defaults to `charge_automatically`. * @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' /** @description The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed. */ - customer?: string; + customer?: string /** @description The tax rates that will apply to any line item that does not have `tax_rates` set. */ - default_tax_rates?: Partial & Partial<"">; + default_tax_rates?: Partial & Partial<''> /** @description A description that will be displayed on the quote PDF. If no value is passed, the default description configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used. */ - description?: string; + description?: string /** @description The discounts applied to the quote. You can only set up to one discount. */ discounts?: Partial< { - coupon?: string; - discount?: string; + coupon?: string + discount?: string }[] > & - Partial<"">; + Partial<''> /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * Format: unix-time * @description A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. If no value is passed, the default expiration date configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used. */ - expires_at?: number; + expires_at?: number /** @description A footer that will be displayed on the quote PDF. If no value is passed, the default footer configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used. */ - footer?: string; + footer?: string /** * from_quote_params * @description Clone an existing quote. The new quote will be created in `status=draft`. When using this parameter, you cannot specify any other parameters except for `expires_at`. */ from_quote?: { - is_revision?: boolean; - quote: string; - }; + is_revision?: boolean + quote: string + } /** @description A header that will be displayed on the quote PDF. If no value is passed, the default header configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used. */ - header?: string; + header?: string /** * quote_param * @description All invoices will be billed using the specified settings. */ invoice_settings?: { - days_until_due?: number; - }; + days_until_due?: number + } /** @description A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost. */ line_items?: { - price?: string; + price?: string /** price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring?: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The account on behalf of which to charge. */ - on_behalf_of?: Partial & Partial<"">; + on_behalf_of?: Partial & Partial<''> /** * subscription_data_create_params * @description When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if `subscription_data[effective_date]` is present and in the future, otherwise a subscription is created. */ subscription_data?: { - effective_date?: Partial<"current_period_end"> & Partial & Partial<"">; - trial_period_days?: Partial & Partial<"">; - }; + effective_date?: Partial<'current_period_end'> & Partial & Partial<''> + trial_period_days?: Partial & Partial<''> + } /** @description The data with which to automatically create a Transfer for each of the invoices. */ transfer_data?: Partial<{ - amount?: number; - amount_percent?: number; - destination: string; + amount?: number + amount_percent?: number + destination: string }> & - Partial<"">; - }; - }; - }; - }; + Partial<''> + } + } + } + } /**

Retrieves the quote with the given ID.

*/ GetQuotesQuote: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - quote: string; - }; - }; + quote: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["quote"]; - }; - }; + 'application/json': components['schemas']['quote'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

A quote models prices and services for a customer.

*/ PostQuotesQuote: { parameters: { path: { - quote: string; - }; - }; + quote: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["quote"]; - }; - }; + 'application/json': components['schemas']['quote'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description 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. There cannot be any line items with recurring prices when using this field. */ - application_fee_amount?: Partial & Partial<"">; + application_fee_amount?: Partial & Partial<''> /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field. */ - application_fee_percent?: Partial & Partial<"">; + application_fee_percent?: Partial & Partial<''> /** * automatic_tax_param * @description Settings for automatic tax lookup for this quote and resulting invoices and subscriptions. */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** * @description Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice 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. Defaults to `charge_automatically`. * @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' /** @description The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed. */ - customer?: string; + customer?: string /** @description The tax rates that will apply to any line item that does not have `tax_rates` set. */ - default_tax_rates?: Partial & Partial<"">; + default_tax_rates?: Partial & Partial<''> /** @description A description that will be displayed on the quote PDF. */ - description?: string; + description?: string /** @description The discounts applied to the quote. You can only set up to one discount. */ discounts?: Partial< { - coupon?: string; - discount?: string; + coupon?: string + discount?: string }[] > & - Partial<"">; + Partial<''> /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * Format: unix-time * @description A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. */ - expires_at?: number; + expires_at?: number /** @description A footer that will be displayed on the quote PDF. */ - footer?: string; + footer?: string /** @description A header that will be displayed on the quote PDF. */ - header?: string; + header?: string /** * quote_param * @description All invoices will be billed using the specified settings. */ invoice_settings?: { - days_until_due?: number; - }; + days_until_due?: number + } /** @description A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost. */ line_items?: { - id?: string; - price?: string; + id?: string + price?: string /** price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring?: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The account on behalf of which to charge. */ - on_behalf_of?: Partial & Partial<"">; + on_behalf_of?: Partial & Partial<''> /** * subscription_data_update_params * @description When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if `subscription_data[effective_date]` is present and in the future, otherwise a subscription is created. */ subscription_data?: { - effective_date?: Partial<"current_period_end"> & Partial & Partial<"">; - trial_period_days?: Partial & Partial<"">; - }; + effective_date?: Partial<'current_period_end'> & Partial & Partial<''> + trial_period_days?: Partial & Partial<''> + } /** @description The data with which to automatically create a Transfer for each of the invoices. */ transfer_data?: Partial<{ - amount?: number; - amount_percent?: number; - destination: string; + amount?: number + amount_percent?: number + destination: string }> & - Partial<"">; - }; - }; - }; - }; + Partial<''> + } + } + } + } /**

Accepts the specified quote.

*/ PostQuotesQuoteAccept: { parameters: { path: { - quote: string; - }; - }; + quote: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["quote"]; - }; - }; + 'application/json': components['schemas']['quote'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Cancels the quote.

*/ PostQuotesQuoteCancel: { parameters: { path: { - quote: string; - }; - }; + quote: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["quote"]; - }; - }; + 'application/json': components['schemas']['quote'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

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.

*/ GetQuotesQuoteComputedUpfrontLineItems: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - quote: string; - }; - }; + quote: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["item"][]; + data: components['schemas']['item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Finalizes the quote.

*/ PostQuotesQuoteFinalize: { parameters: { path: { - quote: string; - }; - }; + quote: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["quote"]; - }; - }; + 'application/json': components['schemas']['quote'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * Format: unix-time * @description A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. */ - expires_at?: number; - }; - }; - }; - }; + expires_at?: number + } + } + } + } /**

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.

*/ GetQuotesQuoteLineItems: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - quote: string; - }; - }; + quote: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["item"][]; + data: components['schemas']['item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Download the PDF for a finalized quote

*/ GetQuotesQuotePdf: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - quote: string; - }; - }; + quote: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/pdf": string; - }; - }; + 'application/pdf': string + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of early fraud warnings.

*/ GetRadarEarlyFraudWarnings: { parameters: { query: { /** Only return early fraud warnings for the charge specified by this charge ID. */ - charge?: string; + charge?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return early fraud warnings for charges that were created by the PaymentIntent specified by this PaymentIntent ID. */ - payment_intent?: string; + payment_intent?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["radar.early_fraud_warning"][]; + 'application/json': { + data: components['schemas']['radar.early_fraud_warning'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Retrieves the details of an early fraud warning that has previously been created.

* @@ -37253,425 +37004,417 @@ export interface operations { GetRadarEarlyFraudWarningsEarlyFraudWarning: { parameters: { path: { - early_fraud_warning: string; - }; + early_fraud_warning: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["radar.early_fraud_warning"]; - }; - }; + 'application/json': components['schemas']['radar.early_fraud_warning'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of ValueListItem objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

*/ GetRadarValueListItems: { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Return items belonging to the parent list whose value matches the specified value (using an "is like" match). */ - value?: string; + value?: string /** Identifier for the parent value list this item belongs to. */ - value_list: string; - }; - }; + value_list: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["radar.value_list_item"][]; + 'application/json': { + data: components['schemas']['radar.value_list_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new ValueListItem object, which is added to the specified parent value list.

*/ PostRadarValueListItems: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["radar.value_list_item"]; - }; - }; + 'application/json': components['schemas']['radar.value_list_item'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The value of the item (whose type must match the type of the parent value list). */ - value: string; + value: string /** @description The identifier of the value list which the created item will be added to. */ - value_list: string; - }; - }; - }; - }; + value_list: string + } + } + } + } /**

Retrieves a ValueListItem object.

*/ GetRadarValueListItemsItem: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - item: string; - }; - }; + item: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["radar.value_list_item"]; - }; - }; + 'application/json': components['schemas']['radar.value_list_item'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Deletes a ValueListItem object, removing it from its parent value list.

*/ DeleteRadarValueListItemsItem: { parameters: { path: { - item: string; - }; - }; + item: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_radar.value_list_item"]; - }; - }; + 'application/json': components['schemas']['deleted_radar.value_list_item'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of ValueList objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

*/ GetRadarValueLists: { parameters: { query: { /** The alias used to reference the value list when writing rules. */ - alias?: string; + alias?: string /** A value contained within a value list - returns all value lists containing this value. */ - contains?: string; + contains?: string created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["radar.value_list"][]; + 'application/json': { + data: components['schemas']['radar.value_list'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new ValueList object, which can then be referenced in rules.

*/ PostRadarValueLists: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["radar.value_list"]; - }; - }; + 'application/json': components['schemas']['radar.value_list'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The name of the value list for use in rules. */ - alias: string; + alias: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * @description Type of the items in the value list. One of `card_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, `case_sensitive_string`, or `customer_id`. Use `string` if the item type is unknown or mixed. * @enum {string} */ - item_type?: - | "card_bin" - | "card_fingerprint" - | "case_sensitive_string" - | "country" - | "customer_id" - | "email" - | "ip_address" - | "string"; + item_type?: 'card_bin' | 'card_fingerprint' | 'case_sensitive_string' | 'country' | 'customer_id' | 'email' | 'ip_address' | 'string' /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The human-readable name of the value list. */ - name: string; - }; - }; - }; - }; + name: string + } + } + } + } /**

Retrieves a ValueList object.

*/ GetRadarValueListsValueList: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - value_list: string; - }; - }; + value_list: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["radar.value_list"]; - }; - }; + 'application/json': components['schemas']['radar.value_list'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostRadarValueListsValueList: { parameters: { path: { - value_list: string; - }; - }; + value_list: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["radar.value_list"]; - }; - }; + 'application/json': components['schemas']['radar.value_list'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The name of the value list for use in rules. */ - alias?: string; + alias?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The human-readable name of the value list. */ - name?: string; - }; - }; - }; - }; + name?: string + } + } + } + } /**

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.

*/ DeleteRadarValueListsValueList: { parameters: { path: { - value_list: string; - }; - }; + value_list: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_radar.value_list"]; - }; - }; + 'application/json': components['schemas']['deleted_radar.value_list'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of your recipients. The recipients are returned sorted by creation date, with the most recently created recipients appearing first.

*/ GetRecipients: { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - type?: "corporation" | "individual"; + starting_after?: string + type?: 'corporation' | 'individual' /** Only return recipients that are verified or unverified. */ - verified?: boolean; - }; - }; + verified?: boolean + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["recipient"][]; + 'application/json': { + data: components['schemas']['recipient'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Creates a new Recipient object and verifies the recipient’s identity. * Also verifies the recipient’s bank account information or debit card, if either is provided.

@@ -37681,73 +37424,72 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["recipient"]; - }; - }; + 'application/json': components['schemas']['recipient'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A bank account to attach to the recipient. You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details, with the options described below. */ - bank_account?: string; + bank_account?: string /** @description A U.S. Visa or MasterCard debit card (_not_ prepaid) to attach to the recipient. If the debit card is not valid, recipient creation will fail. You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's debit card details, with the options described below. Although not all information is required, the extra info helps prevent fraud. */ - card?: string; + card?: string /** @description An arbitrary string which you can attach to a `Recipient` object. It is displayed alongside the recipient in the web interface. */ - description?: string; + description?: string /** @description The recipient's email address. It is displayed alongside the recipient in the web interface, and can be useful for searching and tracking. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The recipient's full, legal name. For type `individual`, should be in the format `First Last`, `First Middle Last`, or `First M Last` (no prefixes or suffixes). For `corporation`, the full, incorporated name. */ - name: string; + name: string /** @description The recipient's tax ID, as a string. For type `individual`, the full SSN; for type `corporation`, the full EIN. */ - tax_id?: string; + tax_id?: string /** @description Type of the recipient: either `individual` or `corporation`. */ - type: string; - }; - }; - }; - }; + type: string + } + } + } + } /**

Retrieves the details of an existing recipient. You need only supply the unique recipient identifier that was returned upon recipient creation.

*/ GetRecipientsId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": Partial & - Partial; - }; - }; + 'application/json': Partial & Partial + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates the specified recipient by setting the values of the parameters passed. * Any parameters not provided will be left unchanged.

@@ -37758,196 +37500,196 @@ export interface operations { PostRecipientsId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["recipient"]; - }; - }; + 'application/json': components['schemas']['recipient'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A bank account to attach to the recipient. You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details, with the options described below. */ - bank_account?: string; + bank_account?: string /** @description A U.S. Visa or MasterCard debit card (not prepaid) to attach to the recipient. You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's debit card details, with the options described below. Passing `card` will create a new card, make it the new recipient default card, and delete the old recipient default (if one exists). If you want to add additional debit cards instead of replacing the existing default, use the [card creation API](https://stripe.com/docs/api#create_card). Whenever you attach a card to a recipient, Stripe will automatically validate the debit card. */ - card?: string; + card?: string /** @description ID of the card to set as the recipient's new default for payouts. */ - default_card?: string; + default_card?: string /** @description An arbitrary string which you can attach to a `Recipient` object. It is displayed alongside the recipient in the web interface. */ - description?: string; + description?: string /** @description The recipient's email address. It is displayed alongside the recipient in the web interface, and can be useful for searching and tracking. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The recipient's full, legal name. For type `individual`, should be in the format `First Last`, `First Middle Last`, or `First M Last` (no prefixes or suffixes). For `corporation`, the full, incorporated name. */ - name?: string; + name?: string /** @description The recipient's tax ID, as a string. For type `individual`, the full SSN; for type `corporation`, the full EIN. */ - tax_id?: string; - }; - }; - }; - }; + tax_id?: string + } + } + } + } /**

Permanently deletes a recipient. It cannot be undone.

*/ DeleteRecipientsId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_recipient"]; - }; - }; + 'application/json': components['schemas']['deleted_recipient'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of all refunds you’ve previously created. The refunds are returned in sorted order, with the most recent refunds appearing first. For convenience, the 10 most recent refunds are always available by default on the charge object.

*/ GetRefunds: { parameters: { query: { /** Only return refunds for the charge specified by this charge ID. */ - charge?: string; + charge?: string created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return refunds for the PaymentIntent specified by this ID. */ - payment_intent?: string; + payment_intent?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["refund"][]; + 'application/json': { + data: components['schemas']['refund'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Create a refund.

*/ PostRefunds: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["refund"]; - }; - }; + 'application/json': components['schemas']['refund'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { - amount?: number; - charge?: string; + 'application/x-www-form-urlencoded': { + amount?: number + charge?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - payment_intent?: string; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + payment_intent?: string /** @enum {string} */ - reason?: "duplicate" | "fraudulent" | "requested_by_customer"; - refund_application_fee?: boolean; - reverse_transfer?: boolean; - }; - }; - }; - }; + reason?: 'duplicate' | 'fraudulent' | 'requested_by_customer' + refund_application_fee?: boolean + reverse_transfer?: boolean + } + } + } + } /**

Retrieves the details of an existing refund.

*/ GetRefundsRefund: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - refund: string; - }; - }; + refund: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["refund"]; - }; - }; + 'application/json': components['schemas']['refund'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates the specified refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

* @@ -37956,973 +37698,973 @@ export interface operations { PostRefundsRefund: { parameters: { path: { - refund: string; - }; - }; + refund: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["refund"]; - }; - }; + 'application/json': components['schemas']['refund'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Returns a list of Report Runs, with the most recent appearing first.

*/ GetReportingReportRuns: { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["reporting.report_run"][]; + 'application/json': { + data: components['schemas']['reporting.report_run'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new object and begin running the report. (Certain report types require a live-mode API key.)

*/ PostReportingReportRuns: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["reporting.report_run"]; - }; - }; + 'application/json': components['schemas']['reporting.report_run'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * run_parameter_specs * @description Parameters specifying how the report should be run. Different Report Types have different required and optional parameters, listed in the [API Access to Reports](https://stripe.com/docs/reporting/statements/api) documentation. */ parameters?: { - columns?: string[]; - connected_account?: string; - currency?: string; + columns?: string[] + connected_account?: string + currency?: string /** Format: unix-time */ - interval_end?: number; + interval_end?: number /** Format: unix-time */ - interval_start?: number; - payout?: string; + interval_start?: number + payout?: string /** @enum {string} */ reporting_category?: - | "advance" - | "advance_funding" - | "anticipation_repayment" - | "charge" - | "charge_failure" - | "connect_collection_transfer" - | "connect_reserved_funds" - | "contribution" - | "dispute" - | "dispute_reversal" - | "fee" - | "financing_paydown" - | "financing_paydown_reversal" - | "financing_payout" - | "financing_payout_reversal" - | "issuing_authorization_hold" - | "issuing_authorization_release" - | "issuing_dispute" - | "issuing_transaction" - | "network_cost" - | "other_adjustment" - | "partial_capture_reversal" - | "payout" - | "payout_reversal" - | "platform_earning" - | "platform_earning_refund" - | "refund" - | "refund_failure" - | "risk_reserved_funds" - | "tax" - | "topup" - | "topup_reversal" - | "transfer" - | "transfer_reversal"; + | 'advance' + | 'advance_funding' + | 'anticipation_repayment' + | 'charge' + | 'charge_failure' + | 'connect_collection_transfer' + | 'connect_reserved_funds' + | 'contribution' + | 'dispute' + | 'dispute_reversal' + | 'fee' + | 'financing_paydown' + | 'financing_paydown_reversal' + | 'financing_payout' + | 'financing_payout_reversal' + | 'issuing_authorization_hold' + | 'issuing_authorization_release' + | 'issuing_dispute' + | 'issuing_transaction' + | 'network_cost' + | 'other_adjustment' + | 'partial_capture_reversal' + | 'payout' + | 'payout_reversal' + | 'platform_earning' + | 'platform_earning_refund' + | 'refund' + | 'refund_failure' + | 'risk_reserved_funds' + | 'tax' + | 'topup' + | 'topup_reversal' + | 'transfer' + | 'transfer_reversal' /** @enum {string} */ timezone?: - | "Africa/Abidjan" - | "Africa/Accra" - | "Africa/Addis_Ababa" - | "Africa/Algiers" - | "Africa/Asmara" - | "Africa/Asmera" - | "Africa/Bamako" - | "Africa/Bangui" - | "Africa/Banjul" - | "Africa/Bissau" - | "Africa/Blantyre" - | "Africa/Brazzaville" - | "Africa/Bujumbura" - | "Africa/Cairo" - | "Africa/Casablanca" - | "Africa/Ceuta" - | "Africa/Conakry" - | "Africa/Dakar" - | "Africa/Dar_es_Salaam" - | "Africa/Djibouti" - | "Africa/Douala" - | "Africa/El_Aaiun" - | "Africa/Freetown" - | "Africa/Gaborone" - | "Africa/Harare" - | "Africa/Johannesburg" - | "Africa/Juba" - | "Africa/Kampala" - | "Africa/Khartoum" - | "Africa/Kigali" - | "Africa/Kinshasa" - | "Africa/Lagos" - | "Africa/Libreville" - | "Africa/Lome" - | "Africa/Luanda" - | "Africa/Lubumbashi" - | "Africa/Lusaka" - | "Africa/Malabo" - | "Africa/Maputo" - | "Africa/Maseru" - | "Africa/Mbabane" - | "Africa/Mogadishu" - | "Africa/Monrovia" - | "Africa/Nairobi" - | "Africa/Ndjamena" - | "Africa/Niamey" - | "Africa/Nouakchott" - | "Africa/Ouagadougou" - | "Africa/Porto-Novo" - | "Africa/Sao_Tome" - | "Africa/Timbuktu" - | "Africa/Tripoli" - | "Africa/Tunis" - | "Africa/Windhoek" - | "America/Adak" - | "America/Anchorage" - | "America/Anguilla" - | "America/Antigua" - | "America/Araguaina" - | "America/Argentina/Buenos_Aires" - | "America/Argentina/Catamarca" - | "America/Argentina/ComodRivadavia" - | "America/Argentina/Cordoba" - | "America/Argentina/Jujuy" - | "America/Argentina/La_Rioja" - | "America/Argentina/Mendoza" - | "America/Argentina/Rio_Gallegos" - | "America/Argentina/Salta" - | "America/Argentina/San_Juan" - | "America/Argentina/San_Luis" - | "America/Argentina/Tucuman" - | "America/Argentina/Ushuaia" - | "America/Aruba" - | "America/Asuncion" - | "America/Atikokan" - | "America/Atka" - | "America/Bahia" - | "America/Bahia_Banderas" - | "America/Barbados" - | "America/Belem" - | "America/Belize" - | "America/Blanc-Sablon" - | "America/Boa_Vista" - | "America/Bogota" - | "America/Boise" - | "America/Buenos_Aires" - | "America/Cambridge_Bay" - | "America/Campo_Grande" - | "America/Cancun" - | "America/Caracas" - | "America/Catamarca" - | "America/Cayenne" - | "America/Cayman" - | "America/Chicago" - | "America/Chihuahua" - | "America/Coral_Harbour" - | "America/Cordoba" - | "America/Costa_Rica" - | "America/Creston" - | "America/Cuiaba" - | "America/Curacao" - | "America/Danmarkshavn" - | "America/Dawson" - | "America/Dawson_Creek" - | "America/Denver" - | "America/Detroit" - | "America/Dominica" - | "America/Edmonton" - | "America/Eirunepe" - | "America/El_Salvador" - | "America/Ensenada" - | "America/Fort_Nelson" - | "America/Fort_Wayne" - | "America/Fortaleza" - | "America/Glace_Bay" - | "America/Godthab" - | "America/Goose_Bay" - | "America/Grand_Turk" - | "America/Grenada" - | "America/Guadeloupe" - | "America/Guatemala" - | "America/Guayaquil" - | "America/Guyana" - | "America/Halifax" - | "America/Havana" - | "America/Hermosillo" - | "America/Indiana/Indianapolis" - | "America/Indiana/Knox" - | "America/Indiana/Marengo" - | "America/Indiana/Petersburg" - | "America/Indiana/Tell_City" - | "America/Indiana/Vevay" - | "America/Indiana/Vincennes" - | "America/Indiana/Winamac" - | "America/Indianapolis" - | "America/Inuvik" - | "America/Iqaluit" - | "America/Jamaica" - | "America/Jujuy" - | "America/Juneau" - | "America/Kentucky/Louisville" - | "America/Kentucky/Monticello" - | "America/Knox_IN" - | "America/Kralendijk" - | "America/La_Paz" - | "America/Lima" - | "America/Los_Angeles" - | "America/Louisville" - | "America/Lower_Princes" - | "America/Maceio" - | "America/Managua" - | "America/Manaus" - | "America/Marigot" - | "America/Martinique" - | "America/Matamoros" - | "America/Mazatlan" - | "America/Mendoza" - | "America/Menominee" - | "America/Merida" - | "America/Metlakatla" - | "America/Mexico_City" - | "America/Miquelon" - | "America/Moncton" - | "America/Monterrey" - | "America/Montevideo" - | "America/Montreal" - | "America/Montserrat" - | "America/Nassau" - | "America/New_York" - | "America/Nipigon" - | "America/Nome" - | "America/Noronha" - | "America/North_Dakota/Beulah" - | "America/North_Dakota/Center" - | "America/North_Dakota/New_Salem" - | "America/Ojinaga" - | "America/Panama" - | "America/Pangnirtung" - | "America/Paramaribo" - | "America/Phoenix" - | "America/Port-au-Prince" - | "America/Port_of_Spain" - | "America/Porto_Acre" - | "America/Porto_Velho" - | "America/Puerto_Rico" - | "America/Punta_Arenas" - | "America/Rainy_River" - | "America/Rankin_Inlet" - | "America/Recife" - | "America/Regina" - | "America/Resolute" - | "America/Rio_Branco" - | "America/Rosario" - | "America/Santa_Isabel" - | "America/Santarem" - | "America/Santiago" - | "America/Santo_Domingo" - | "America/Sao_Paulo" - | "America/Scoresbysund" - | "America/Shiprock" - | "America/Sitka" - | "America/St_Barthelemy" - | "America/St_Johns" - | "America/St_Kitts" - | "America/St_Lucia" - | "America/St_Thomas" - | "America/St_Vincent" - | "America/Swift_Current" - | "America/Tegucigalpa" - | "America/Thule" - | "America/Thunder_Bay" - | "America/Tijuana" - | "America/Toronto" - | "America/Tortola" - | "America/Vancouver" - | "America/Virgin" - | "America/Whitehorse" - | "America/Winnipeg" - | "America/Yakutat" - | "America/Yellowknife" - | "Antarctica/Casey" - | "Antarctica/Davis" - | "Antarctica/DumontDUrville" - | "Antarctica/Macquarie" - | "Antarctica/Mawson" - | "Antarctica/McMurdo" - | "Antarctica/Palmer" - | "Antarctica/Rothera" - | "Antarctica/South_Pole" - | "Antarctica/Syowa" - | "Antarctica/Troll" - | "Antarctica/Vostok" - | "Arctic/Longyearbyen" - | "Asia/Aden" - | "Asia/Almaty" - | "Asia/Amman" - | "Asia/Anadyr" - | "Asia/Aqtau" - | "Asia/Aqtobe" - | "Asia/Ashgabat" - | "Asia/Ashkhabad" - | "Asia/Atyrau" - | "Asia/Baghdad" - | "Asia/Bahrain" - | "Asia/Baku" - | "Asia/Bangkok" - | "Asia/Barnaul" - | "Asia/Beirut" - | "Asia/Bishkek" - | "Asia/Brunei" - | "Asia/Calcutta" - | "Asia/Chita" - | "Asia/Choibalsan" - | "Asia/Chongqing" - | "Asia/Chungking" - | "Asia/Colombo" - | "Asia/Dacca" - | "Asia/Damascus" - | "Asia/Dhaka" - | "Asia/Dili" - | "Asia/Dubai" - | "Asia/Dushanbe" - | "Asia/Famagusta" - | "Asia/Gaza" - | "Asia/Harbin" - | "Asia/Hebron" - | "Asia/Ho_Chi_Minh" - | "Asia/Hong_Kong" - | "Asia/Hovd" - | "Asia/Irkutsk" - | "Asia/Istanbul" - | "Asia/Jakarta" - | "Asia/Jayapura" - | "Asia/Jerusalem" - | "Asia/Kabul" - | "Asia/Kamchatka" - | "Asia/Karachi" - | "Asia/Kashgar" - | "Asia/Kathmandu" - | "Asia/Katmandu" - | "Asia/Khandyga" - | "Asia/Kolkata" - | "Asia/Krasnoyarsk" - | "Asia/Kuala_Lumpur" - | "Asia/Kuching" - | "Asia/Kuwait" - | "Asia/Macao" - | "Asia/Macau" - | "Asia/Magadan" - | "Asia/Makassar" - | "Asia/Manila" - | "Asia/Muscat" - | "Asia/Nicosia" - | "Asia/Novokuznetsk" - | "Asia/Novosibirsk" - | "Asia/Omsk" - | "Asia/Oral" - | "Asia/Phnom_Penh" - | "Asia/Pontianak" - | "Asia/Pyongyang" - | "Asia/Qatar" - | "Asia/Qostanay" - | "Asia/Qyzylorda" - | "Asia/Rangoon" - | "Asia/Riyadh" - | "Asia/Saigon" - | "Asia/Sakhalin" - | "Asia/Samarkand" - | "Asia/Seoul" - | "Asia/Shanghai" - | "Asia/Singapore" - | "Asia/Srednekolymsk" - | "Asia/Taipei" - | "Asia/Tashkent" - | "Asia/Tbilisi" - | "Asia/Tehran" - | "Asia/Tel_Aviv" - | "Asia/Thimbu" - | "Asia/Thimphu" - | "Asia/Tokyo" - | "Asia/Tomsk" - | "Asia/Ujung_Pandang" - | "Asia/Ulaanbaatar" - | "Asia/Ulan_Bator" - | "Asia/Urumqi" - | "Asia/Ust-Nera" - | "Asia/Vientiane" - | "Asia/Vladivostok" - | "Asia/Yakutsk" - | "Asia/Yangon" - | "Asia/Yekaterinburg" - | "Asia/Yerevan" - | "Atlantic/Azores" - | "Atlantic/Bermuda" - | "Atlantic/Canary" - | "Atlantic/Cape_Verde" - | "Atlantic/Faeroe" - | "Atlantic/Faroe" - | "Atlantic/Jan_Mayen" - | "Atlantic/Madeira" - | "Atlantic/Reykjavik" - | "Atlantic/South_Georgia" - | "Atlantic/St_Helena" - | "Atlantic/Stanley" - | "Australia/ACT" - | "Australia/Adelaide" - | "Australia/Brisbane" - | "Australia/Broken_Hill" - | "Australia/Canberra" - | "Australia/Currie" - | "Australia/Darwin" - | "Australia/Eucla" - | "Australia/Hobart" - | "Australia/LHI" - | "Australia/Lindeman" - | "Australia/Lord_Howe" - | "Australia/Melbourne" - | "Australia/NSW" - | "Australia/North" - | "Australia/Perth" - | "Australia/Queensland" - | "Australia/South" - | "Australia/Sydney" - | "Australia/Tasmania" - | "Australia/Victoria" - | "Australia/West" - | "Australia/Yancowinna" - | "Brazil/Acre" - | "Brazil/DeNoronha" - | "Brazil/East" - | "Brazil/West" - | "CET" - | "CST6CDT" - | "Canada/Atlantic" - | "Canada/Central" - | "Canada/Eastern" - | "Canada/Mountain" - | "Canada/Newfoundland" - | "Canada/Pacific" - | "Canada/Saskatchewan" - | "Canada/Yukon" - | "Chile/Continental" - | "Chile/EasterIsland" - | "Cuba" - | "EET" - | "EST" - | "EST5EDT" - | "Egypt" - | "Eire" - | "Etc/GMT" - | "Etc/GMT+0" - | "Etc/GMT+1" - | "Etc/GMT+10" - | "Etc/GMT+11" - | "Etc/GMT+12" - | "Etc/GMT+2" - | "Etc/GMT+3" - | "Etc/GMT+4" - | "Etc/GMT+5" - | "Etc/GMT+6" - | "Etc/GMT+7" - | "Etc/GMT+8" - | "Etc/GMT+9" - | "Etc/GMT-0" - | "Etc/GMT-1" - | "Etc/GMT-10" - | "Etc/GMT-11" - | "Etc/GMT-12" - | "Etc/GMT-13" - | "Etc/GMT-14" - | "Etc/GMT-2" - | "Etc/GMT-3" - | "Etc/GMT-4" - | "Etc/GMT-5" - | "Etc/GMT-6" - | "Etc/GMT-7" - | "Etc/GMT-8" - | "Etc/GMT-9" - | "Etc/GMT0" - | "Etc/Greenwich" - | "Etc/UCT" - | "Etc/UTC" - | "Etc/Universal" - | "Etc/Zulu" - | "Europe/Amsterdam" - | "Europe/Andorra" - | "Europe/Astrakhan" - | "Europe/Athens" - | "Europe/Belfast" - | "Europe/Belgrade" - | "Europe/Berlin" - | "Europe/Bratislava" - | "Europe/Brussels" - | "Europe/Bucharest" - | "Europe/Budapest" - | "Europe/Busingen" - | "Europe/Chisinau" - | "Europe/Copenhagen" - | "Europe/Dublin" - | "Europe/Gibraltar" - | "Europe/Guernsey" - | "Europe/Helsinki" - | "Europe/Isle_of_Man" - | "Europe/Istanbul" - | "Europe/Jersey" - | "Europe/Kaliningrad" - | "Europe/Kiev" - | "Europe/Kirov" - | "Europe/Lisbon" - | "Europe/Ljubljana" - | "Europe/London" - | "Europe/Luxembourg" - | "Europe/Madrid" - | "Europe/Malta" - | "Europe/Mariehamn" - | "Europe/Minsk" - | "Europe/Monaco" - | "Europe/Moscow" - | "Europe/Nicosia" - | "Europe/Oslo" - | "Europe/Paris" - | "Europe/Podgorica" - | "Europe/Prague" - | "Europe/Riga" - | "Europe/Rome" - | "Europe/Samara" - | "Europe/San_Marino" - | "Europe/Sarajevo" - | "Europe/Saratov" - | "Europe/Simferopol" - | "Europe/Skopje" - | "Europe/Sofia" - | "Europe/Stockholm" - | "Europe/Tallinn" - | "Europe/Tirane" - | "Europe/Tiraspol" - | "Europe/Ulyanovsk" - | "Europe/Uzhgorod" - | "Europe/Vaduz" - | "Europe/Vatican" - | "Europe/Vienna" - | "Europe/Vilnius" - | "Europe/Volgograd" - | "Europe/Warsaw" - | "Europe/Zagreb" - | "Europe/Zaporozhye" - | "Europe/Zurich" - | "Factory" - | "GB" - | "GB-Eire" - | "GMT" - | "GMT+0" - | "GMT-0" - | "GMT0" - | "Greenwich" - | "HST" - | "Hongkong" - | "Iceland" - | "Indian/Antananarivo" - | "Indian/Chagos" - | "Indian/Christmas" - | "Indian/Cocos" - | "Indian/Comoro" - | "Indian/Kerguelen" - | "Indian/Mahe" - | "Indian/Maldives" - | "Indian/Mauritius" - | "Indian/Mayotte" - | "Indian/Reunion" - | "Iran" - | "Israel" - | "Jamaica" - | "Japan" - | "Kwajalein" - | "Libya" - | "MET" - | "MST" - | "MST7MDT" - | "Mexico/BajaNorte" - | "Mexico/BajaSur" - | "Mexico/General" - | "NZ" - | "NZ-CHAT" - | "Navajo" - | "PRC" - | "PST8PDT" - | "Pacific/Apia" - | "Pacific/Auckland" - | "Pacific/Bougainville" - | "Pacific/Chatham" - | "Pacific/Chuuk" - | "Pacific/Easter" - | "Pacific/Efate" - | "Pacific/Enderbury" - | "Pacific/Fakaofo" - | "Pacific/Fiji" - | "Pacific/Funafuti" - | "Pacific/Galapagos" - | "Pacific/Gambier" - | "Pacific/Guadalcanal" - | "Pacific/Guam" - | "Pacific/Honolulu" - | "Pacific/Johnston" - | "Pacific/Kiritimati" - | "Pacific/Kosrae" - | "Pacific/Kwajalein" - | "Pacific/Majuro" - | "Pacific/Marquesas" - | "Pacific/Midway" - | "Pacific/Nauru" - | "Pacific/Niue" - | "Pacific/Norfolk" - | "Pacific/Noumea" - | "Pacific/Pago_Pago" - | "Pacific/Palau" - | "Pacific/Pitcairn" - | "Pacific/Pohnpei" - | "Pacific/Ponape" - | "Pacific/Port_Moresby" - | "Pacific/Rarotonga" - | "Pacific/Saipan" - | "Pacific/Samoa" - | "Pacific/Tahiti" - | "Pacific/Tarawa" - | "Pacific/Tongatapu" - | "Pacific/Truk" - | "Pacific/Wake" - | "Pacific/Wallis" - | "Pacific/Yap" - | "Poland" - | "Portugal" - | "ROC" - | "ROK" - | "Singapore" - | "Turkey" - | "UCT" - | "US/Alaska" - | "US/Aleutian" - | "US/Arizona" - | "US/Central" - | "US/East-Indiana" - | "US/Eastern" - | "US/Hawaii" - | "US/Indiana-Starke" - | "US/Michigan" - | "US/Mountain" - | "US/Pacific" - | "US/Pacific-New" - | "US/Samoa" - | "UTC" - | "Universal" - | "W-SU" - | "WET" - | "Zulu"; - }; + | 'Africa/Abidjan' + | 'Africa/Accra' + | 'Africa/Addis_Ababa' + | 'Africa/Algiers' + | 'Africa/Asmara' + | 'Africa/Asmera' + | 'Africa/Bamako' + | 'Africa/Bangui' + | 'Africa/Banjul' + | 'Africa/Bissau' + | 'Africa/Blantyre' + | 'Africa/Brazzaville' + | 'Africa/Bujumbura' + | 'Africa/Cairo' + | 'Africa/Casablanca' + | 'Africa/Ceuta' + | 'Africa/Conakry' + | 'Africa/Dakar' + | 'Africa/Dar_es_Salaam' + | 'Africa/Djibouti' + | 'Africa/Douala' + | 'Africa/El_Aaiun' + | 'Africa/Freetown' + | 'Africa/Gaborone' + | 'Africa/Harare' + | 'Africa/Johannesburg' + | 'Africa/Juba' + | 'Africa/Kampala' + | 'Africa/Khartoum' + | 'Africa/Kigali' + | 'Africa/Kinshasa' + | 'Africa/Lagos' + | 'Africa/Libreville' + | 'Africa/Lome' + | 'Africa/Luanda' + | 'Africa/Lubumbashi' + | 'Africa/Lusaka' + | 'Africa/Malabo' + | 'Africa/Maputo' + | 'Africa/Maseru' + | 'Africa/Mbabane' + | 'Africa/Mogadishu' + | 'Africa/Monrovia' + | 'Africa/Nairobi' + | 'Africa/Ndjamena' + | 'Africa/Niamey' + | 'Africa/Nouakchott' + | 'Africa/Ouagadougou' + | 'Africa/Porto-Novo' + | 'Africa/Sao_Tome' + | 'Africa/Timbuktu' + | 'Africa/Tripoli' + | 'Africa/Tunis' + | 'Africa/Windhoek' + | 'America/Adak' + | 'America/Anchorage' + | 'America/Anguilla' + | 'America/Antigua' + | 'America/Araguaina' + | 'America/Argentina/Buenos_Aires' + | 'America/Argentina/Catamarca' + | 'America/Argentina/ComodRivadavia' + | 'America/Argentina/Cordoba' + | 'America/Argentina/Jujuy' + | 'America/Argentina/La_Rioja' + | 'America/Argentina/Mendoza' + | 'America/Argentina/Rio_Gallegos' + | 'America/Argentina/Salta' + | 'America/Argentina/San_Juan' + | 'America/Argentina/San_Luis' + | 'America/Argentina/Tucuman' + | 'America/Argentina/Ushuaia' + | 'America/Aruba' + | 'America/Asuncion' + | 'America/Atikokan' + | 'America/Atka' + | 'America/Bahia' + | 'America/Bahia_Banderas' + | 'America/Barbados' + | 'America/Belem' + | 'America/Belize' + | 'America/Blanc-Sablon' + | 'America/Boa_Vista' + | 'America/Bogota' + | 'America/Boise' + | 'America/Buenos_Aires' + | 'America/Cambridge_Bay' + | 'America/Campo_Grande' + | 'America/Cancun' + | 'America/Caracas' + | 'America/Catamarca' + | 'America/Cayenne' + | 'America/Cayman' + | 'America/Chicago' + | 'America/Chihuahua' + | 'America/Coral_Harbour' + | 'America/Cordoba' + | 'America/Costa_Rica' + | 'America/Creston' + | 'America/Cuiaba' + | 'America/Curacao' + | 'America/Danmarkshavn' + | 'America/Dawson' + | 'America/Dawson_Creek' + | 'America/Denver' + | 'America/Detroit' + | 'America/Dominica' + | 'America/Edmonton' + | 'America/Eirunepe' + | 'America/El_Salvador' + | 'America/Ensenada' + | 'America/Fort_Nelson' + | 'America/Fort_Wayne' + | 'America/Fortaleza' + | 'America/Glace_Bay' + | 'America/Godthab' + | 'America/Goose_Bay' + | 'America/Grand_Turk' + | 'America/Grenada' + | 'America/Guadeloupe' + | 'America/Guatemala' + | 'America/Guayaquil' + | 'America/Guyana' + | 'America/Halifax' + | 'America/Havana' + | 'America/Hermosillo' + | 'America/Indiana/Indianapolis' + | 'America/Indiana/Knox' + | 'America/Indiana/Marengo' + | 'America/Indiana/Petersburg' + | 'America/Indiana/Tell_City' + | 'America/Indiana/Vevay' + | 'America/Indiana/Vincennes' + | 'America/Indiana/Winamac' + | 'America/Indianapolis' + | 'America/Inuvik' + | 'America/Iqaluit' + | 'America/Jamaica' + | 'America/Jujuy' + | 'America/Juneau' + | 'America/Kentucky/Louisville' + | 'America/Kentucky/Monticello' + | 'America/Knox_IN' + | 'America/Kralendijk' + | 'America/La_Paz' + | 'America/Lima' + | 'America/Los_Angeles' + | 'America/Louisville' + | 'America/Lower_Princes' + | 'America/Maceio' + | 'America/Managua' + | 'America/Manaus' + | 'America/Marigot' + | 'America/Martinique' + | 'America/Matamoros' + | 'America/Mazatlan' + | 'America/Mendoza' + | 'America/Menominee' + | 'America/Merida' + | 'America/Metlakatla' + | 'America/Mexico_City' + | 'America/Miquelon' + | 'America/Moncton' + | 'America/Monterrey' + | 'America/Montevideo' + | 'America/Montreal' + | 'America/Montserrat' + | 'America/Nassau' + | 'America/New_York' + | 'America/Nipigon' + | 'America/Nome' + | 'America/Noronha' + | 'America/North_Dakota/Beulah' + | 'America/North_Dakota/Center' + | 'America/North_Dakota/New_Salem' + | 'America/Ojinaga' + | 'America/Panama' + | 'America/Pangnirtung' + | 'America/Paramaribo' + | 'America/Phoenix' + | 'America/Port-au-Prince' + | 'America/Port_of_Spain' + | 'America/Porto_Acre' + | 'America/Porto_Velho' + | 'America/Puerto_Rico' + | 'America/Punta_Arenas' + | 'America/Rainy_River' + | 'America/Rankin_Inlet' + | 'America/Recife' + | 'America/Regina' + | 'America/Resolute' + | 'America/Rio_Branco' + | 'America/Rosario' + | 'America/Santa_Isabel' + | 'America/Santarem' + | 'America/Santiago' + | 'America/Santo_Domingo' + | 'America/Sao_Paulo' + | 'America/Scoresbysund' + | 'America/Shiprock' + | 'America/Sitka' + | 'America/St_Barthelemy' + | 'America/St_Johns' + | 'America/St_Kitts' + | 'America/St_Lucia' + | 'America/St_Thomas' + | 'America/St_Vincent' + | 'America/Swift_Current' + | 'America/Tegucigalpa' + | 'America/Thule' + | 'America/Thunder_Bay' + | 'America/Tijuana' + | 'America/Toronto' + | 'America/Tortola' + | 'America/Vancouver' + | 'America/Virgin' + | 'America/Whitehorse' + | 'America/Winnipeg' + | 'America/Yakutat' + | 'America/Yellowknife' + | 'Antarctica/Casey' + | 'Antarctica/Davis' + | 'Antarctica/DumontDUrville' + | 'Antarctica/Macquarie' + | 'Antarctica/Mawson' + | 'Antarctica/McMurdo' + | 'Antarctica/Palmer' + | 'Antarctica/Rothera' + | 'Antarctica/South_Pole' + | 'Antarctica/Syowa' + | 'Antarctica/Troll' + | 'Antarctica/Vostok' + | 'Arctic/Longyearbyen' + | 'Asia/Aden' + | 'Asia/Almaty' + | 'Asia/Amman' + | 'Asia/Anadyr' + | 'Asia/Aqtau' + | 'Asia/Aqtobe' + | 'Asia/Ashgabat' + | 'Asia/Ashkhabad' + | 'Asia/Atyrau' + | 'Asia/Baghdad' + | 'Asia/Bahrain' + | 'Asia/Baku' + | 'Asia/Bangkok' + | 'Asia/Barnaul' + | 'Asia/Beirut' + | 'Asia/Bishkek' + | 'Asia/Brunei' + | 'Asia/Calcutta' + | 'Asia/Chita' + | 'Asia/Choibalsan' + | 'Asia/Chongqing' + | 'Asia/Chungking' + | 'Asia/Colombo' + | 'Asia/Dacca' + | 'Asia/Damascus' + | 'Asia/Dhaka' + | 'Asia/Dili' + | 'Asia/Dubai' + | 'Asia/Dushanbe' + | 'Asia/Famagusta' + | 'Asia/Gaza' + | 'Asia/Harbin' + | 'Asia/Hebron' + | 'Asia/Ho_Chi_Minh' + | 'Asia/Hong_Kong' + | 'Asia/Hovd' + | 'Asia/Irkutsk' + | 'Asia/Istanbul' + | 'Asia/Jakarta' + | 'Asia/Jayapura' + | 'Asia/Jerusalem' + | 'Asia/Kabul' + | 'Asia/Kamchatka' + | 'Asia/Karachi' + | 'Asia/Kashgar' + | 'Asia/Kathmandu' + | 'Asia/Katmandu' + | 'Asia/Khandyga' + | 'Asia/Kolkata' + | 'Asia/Krasnoyarsk' + | 'Asia/Kuala_Lumpur' + | 'Asia/Kuching' + | 'Asia/Kuwait' + | 'Asia/Macao' + | 'Asia/Macau' + | 'Asia/Magadan' + | 'Asia/Makassar' + | 'Asia/Manila' + | 'Asia/Muscat' + | 'Asia/Nicosia' + | 'Asia/Novokuznetsk' + | 'Asia/Novosibirsk' + | 'Asia/Omsk' + | 'Asia/Oral' + | 'Asia/Phnom_Penh' + | 'Asia/Pontianak' + | 'Asia/Pyongyang' + | 'Asia/Qatar' + | 'Asia/Qostanay' + | 'Asia/Qyzylorda' + | 'Asia/Rangoon' + | 'Asia/Riyadh' + | 'Asia/Saigon' + | 'Asia/Sakhalin' + | 'Asia/Samarkand' + | 'Asia/Seoul' + | 'Asia/Shanghai' + | 'Asia/Singapore' + | 'Asia/Srednekolymsk' + | 'Asia/Taipei' + | 'Asia/Tashkent' + | 'Asia/Tbilisi' + | 'Asia/Tehran' + | 'Asia/Tel_Aviv' + | 'Asia/Thimbu' + | 'Asia/Thimphu' + | 'Asia/Tokyo' + | 'Asia/Tomsk' + | 'Asia/Ujung_Pandang' + | 'Asia/Ulaanbaatar' + | 'Asia/Ulan_Bator' + | 'Asia/Urumqi' + | 'Asia/Ust-Nera' + | 'Asia/Vientiane' + | 'Asia/Vladivostok' + | 'Asia/Yakutsk' + | 'Asia/Yangon' + | 'Asia/Yekaterinburg' + | 'Asia/Yerevan' + | 'Atlantic/Azores' + | 'Atlantic/Bermuda' + | 'Atlantic/Canary' + | 'Atlantic/Cape_Verde' + | 'Atlantic/Faeroe' + | 'Atlantic/Faroe' + | 'Atlantic/Jan_Mayen' + | 'Atlantic/Madeira' + | 'Atlantic/Reykjavik' + | 'Atlantic/South_Georgia' + | 'Atlantic/St_Helena' + | 'Atlantic/Stanley' + | 'Australia/ACT' + | 'Australia/Adelaide' + | 'Australia/Brisbane' + | 'Australia/Broken_Hill' + | 'Australia/Canberra' + | 'Australia/Currie' + | 'Australia/Darwin' + | 'Australia/Eucla' + | 'Australia/Hobart' + | 'Australia/LHI' + | 'Australia/Lindeman' + | 'Australia/Lord_Howe' + | 'Australia/Melbourne' + | 'Australia/NSW' + | 'Australia/North' + | 'Australia/Perth' + | 'Australia/Queensland' + | 'Australia/South' + | 'Australia/Sydney' + | 'Australia/Tasmania' + | 'Australia/Victoria' + | 'Australia/West' + | 'Australia/Yancowinna' + | 'Brazil/Acre' + | 'Brazil/DeNoronha' + | 'Brazil/East' + | 'Brazil/West' + | 'CET' + | 'CST6CDT' + | 'Canada/Atlantic' + | 'Canada/Central' + | 'Canada/Eastern' + | 'Canada/Mountain' + | 'Canada/Newfoundland' + | 'Canada/Pacific' + | 'Canada/Saskatchewan' + | 'Canada/Yukon' + | 'Chile/Continental' + | 'Chile/EasterIsland' + | 'Cuba' + | 'EET' + | 'EST' + | 'EST5EDT' + | 'Egypt' + | 'Eire' + | 'Etc/GMT' + | 'Etc/GMT+0' + | 'Etc/GMT+1' + | 'Etc/GMT+10' + | 'Etc/GMT+11' + | 'Etc/GMT+12' + | 'Etc/GMT+2' + | 'Etc/GMT+3' + | 'Etc/GMT+4' + | 'Etc/GMT+5' + | 'Etc/GMT+6' + | 'Etc/GMT+7' + | 'Etc/GMT+8' + | 'Etc/GMT+9' + | 'Etc/GMT-0' + | 'Etc/GMT-1' + | 'Etc/GMT-10' + | 'Etc/GMT-11' + | 'Etc/GMT-12' + | 'Etc/GMT-13' + | 'Etc/GMT-14' + | 'Etc/GMT-2' + | 'Etc/GMT-3' + | 'Etc/GMT-4' + | 'Etc/GMT-5' + | 'Etc/GMT-6' + | 'Etc/GMT-7' + | 'Etc/GMT-8' + | 'Etc/GMT-9' + | 'Etc/GMT0' + | 'Etc/Greenwich' + | 'Etc/UCT' + | 'Etc/UTC' + | 'Etc/Universal' + | 'Etc/Zulu' + | 'Europe/Amsterdam' + | 'Europe/Andorra' + | 'Europe/Astrakhan' + | 'Europe/Athens' + | 'Europe/Belfast' + | 'Europe/Belgrade' + | 'Europe/Berlin' + | 'Europe/Bratislava' + | 'Europe/Brussels' + | 'Europe/Bucharest' + | 'Europe/Budapest' + | 'Europe/Busingen' + | 'Europe/Chisinau' + | 'Europe/Copenhagen' + | 'Europe/Dublin' + | 'Europe/Gibraltar' + | 'Europe/Guernsey' + | 'Europe/Helsinki' + | 'Europe/Isle_of_Man' + | 'Europe/Istanbul' + | 'Europe/Jersey' + | 'Europe/Kaliningrad' + | 'Europe/Kiev' + | 'Europe/Kirov' + | 'Europe/Lisbon' + | 'Europe/Ljubljana' + | 'Europe/London' + | 'Europe/Luxembourg' + | 'Europe/Madrid' + | 'Europe/Malta' + | 'Europe/Mariehamn' + | 'Europe/Minsk' + | 'Europe/Monaco' + | 'Europe/Moscow' + | 'Europe/Nicosia' + | 'Europe/Oslo' + | 'Europe/Paris' + | 'Europe/Podgorica' + | 'Europe/Prague' + | 'Europe/Riga' + | 'Europe/Rome' + | 'Europe/Samara' + | 'Europe/San_Marino' + | 'Europe/Sarajevo' + | 'Europe/Saratov' + | 'Europe/Simferopol' + | 'Europe/Skopje' + | 'Europe/Sofia' + | 'Europe/Stockholm' + | 'Europe/Tallinn' + | 'Europe/Tirane' + | 'Europe/Tiraspol' + | 'Europe/Ulyanovsk' + | 'Europe/Uzhgorod' + | 'Europe/Vaduz' + | 'Europe/Vatican' + | 'Europe/Vienna' + | 'Europe/Vilnius' + | 'Europe/Volgograd' + | 'Europe/Warsaw' + | 'Europe/Zagreb' + | 'Europe/Zaporozhye' + | 'Europe/Zurich' + | 'Factory' + | 'GB' + | 'GB-Eire' + | 'GMT' + | 'GMT+0' + | 'GMT-0' + | 'GMT0' + | 'Greenwich' + | 'HST' + | 'Hongkong' + | 'Iceland' + | 'Indian/Antananarivo' + | 'Indian/Chagos' + | 'Indian/Christmas' + | 'Indian/Cocos' + | 'Indian/Comoro' + | 'Indian/Kerguelen' + | 'Indian/Mahe' + | 'Indian/Maldives' + | 'Indian/Mauritius' + | 'Indian/Mayotte' + | 'Indian/Reunion' + | 'Iran' + | 'Israel' + | 'Jamaica' + | 'Japan' + | 'Kwajalein' + | 'Libya' + | 'MET' + | 'MST' + | 'MST7MDT' + | 'Mexico/BajaNorte' + | 'Mexico/BajaSur' + | 'Mexico/General' + | 'NZ' + | 'NZ-CHAT' + | 'Navajo' + | 'PRC' + | 'PST8PDT' + | 'Pacific/Apia' + | 'Pacific/Auckland' + | 'Pacific/Bougainville' + | 'Pacific/Chatham' + | 'Pacific/Chuuk' + | 'Pacific/Easter' + | 'Pacific/Efate' + | 'Pacific/Enderbury' + | 'Pacific/Fakaofo' + | 'Pacific/Fiji' + | 'Pacific/Funafuti' + | 'Pacific/Galapagos' + | 'Pacific/Gambier' + | 'Pacific/Guadalcanal' + | 'Pacific/Guam' + | 'Pacific/Honolulu' + | 'Pacific/Johnston' + | 'Pacific/Kiritimati' + | 'Pacific/Kosrae' + | 'Pacific/Kwajalein' + | 'Pacific/Majuro' + | 'Pacific/Marquesas' + | 'Pacific/Midway' + | 'Pacific/Nauru' + | 'Pacific/Niue' + | 'Pacific/Norfolk' + | 'Pacific/Noumea' + | 'Pacific/Pago_Pago' + | 'Pacific/Palau' + | 'Pacific/Pitcairn' + | 'Pacific/Pohnpei' + | 'Pacific/Ponape' + | 'Pacific/Port_Moresby' + | 'Pacific/Rarotonga' + | 'Pacific/Saipan' + | 'Pacific/Samoa' + | 'Pacific/Tahiti' + | 'Pacific/Tarawa' + | 'Pacific/Tongatapu' + | 'Pacific/Truk' + | 'Pacific/Wake' + | 'Pacific/Wallis' + | 'Pacific/Yap' + | 'Poland' + | 'Portugal' + | 'ROC' + | 'ROK' + | 'Singapore' + | 'Turkey' + | 'UCT' + | 'US/Alaska' + | 'US/Aleutian' + | 'US/Arizona' + | 'US/Central' + | 'US/East-Indiana' + | 'US/Eastern' + | 'US/Hawaii' + | 'US/Indiana-Starke' + | 'US/Michigan' + | 'US/Mountain' + | 'US/Pacific' + | 'US/Pacific-New' + | 'US/Samoa' + | 'UTC' + | 'Universal' + | 'W-SU' + | 'WET' + | 'Zulu' + } /** @description The ID of the [report type](https://stripe.com/docs/reporting/statements/api#report-types) to run, such as `"balance.summary.1"`. */ - report_type: string; - }; - }; - }; - }; + report_type: string + } + } + } + } /**

Retrieves the details of an existing Report Run.

*/ GetReportingReportRunsReportRun: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - report_run: string; - }; - }; + report_run: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["reporting.report_run"]; - }; - }; + 'application/json': components['schemas']['reporting.report_run'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a full list of Report Types.

*/ GetReportingReportTypes: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["reporting.report_type"][]; + 'application/json': { + data: components['schemas']['reporting.report_type'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves the details of a Report Type. (Certain report types require a live-mode API key.)

*/ GetReportingReportTypesReportType: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - report_type: string; - }; - }; + report_type: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["reporting.report_type"]; - }; - }; + 'application/json': components['schemas']['reporting.report_type'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ GetReviews: { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["review"][]; + 'application/json': { + data: components['schemas']['review'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves a Review object.

*/ GetReviewsReview: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - review: string; - }; - }; + review: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["review"]; - }; - }; + 'application/json': components['schemas']['review'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Approves a Review object, closing it and removing it from the list of reviews.

*/ PostReviewsReviewApprove: { parameters: { path: { - review: string; - }; - }; + review: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["review"]; - }; - }; + 'application/json': components['schemas']['review'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Returns a list of SetupAttempts associated with a provided SetupIntent.

*/ GetSetupAttempts: { parameters: { @@ -38933,115 +38675,115 @@ export interface operations { * dictionary with a number of different query options. */ created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** * Only return SetupAttempts created by the SetupIntent specified by * this ID. */ - setup_intent: string; + setup_intent: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["setup_attempt"][]; + 'application/json': { + data: components['schemas']['setup_attempt'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of SetupIntents.

*/ GetSetupIntents: { parameters: { query: { /** 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?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** Only return SetupIntents for the customer specified by this customer ID. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return SetupIntents associated with the specified payment method. */ - payment_method?: string; + payment_method?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["setup_intent"][]; + 'application/json': { + data: components['schemas']['setup_intent'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Creates a SetupIntent object.

* @@ -39053,31 +38795,31 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["setup_intent"]; - }; - }; + 'application/json': components['schemas']['setup_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Set to `true` to attempt to confirm this SetupIntent immediately. This parameter defaults to `false`. If the payment method attached is a card, a return_url may be provided in case additional authentication is required. */ - confirm?: boolean; + confirm?: boolean /** * @description ID of the Customer this SetupIntent belongs to, if one exists. * * If 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. */ - customer?: string; + customer?: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * secret_key_param * @description This hash contains details about the Mandate to create. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm). @@ -39086,24 +38828,24 @@ export interface operations { /** customer_acceptance_param */ customer_acceptance: { /** Format: unix-time */ - accepted_at?: number; + accepted_at?: number /** offline_param */ - offline?: { [key: string]: unknown }; + offline?: { [key: string]: unknown } /** online_param */ online?: { - ip_address: string; - user_agent: string; - }; + ip_address: string + user_agent: string + } /** @enum {string} */ - type: "offline" | "online"; - }; - }; + type: 'offline' | 'online' + } + } /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The Stripe account ID for which this SetupIntent is created. */ - on_behalf_of?: string; + on_behalf_of?: string /** @description ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. */ - payment_method?: string; + payment_method?: string /** * payment_method_options_param * @description Payment-method-specific configuration for this SetupIntent. @@ -39112,52 +38854,52 @@ export interface operations { /** setup_intent_payment_method_options_param */ acss_debit?: { /** @enum {string} */ - currency?: "cad" | "usd"; + currency?: 'cad' | 'usd' /** setup_intent_payment_method_options_mandate_options_param */ mandate_options?: { - custom_mandate_url?: Partial & Partial<"">; - default_for?: ("invoice" | "subscription")[]; - interval_description?: string; + custom_mandate_url?: Partial & Partial<''> + default_for?: ('invoice' | 'subscription')[] + interval_description?: string /** @enum {string} */ - payment_schedule?: "combined" | "interval" | "sporadic"; + payment_schedule?: 'combined' | 'interval' | 'sporadic' /** @enum {string} */ - transaction_type?: "business" | "personal"; - }; + transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; - }; + verification_method?: 'automatic' | 'instant' | 'microdeposits' + } /** setup_intent_param */ card?: { /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; - }; + request_three_d_secure?: 'any' | 'automatic' + } /** setup_intent_payment_method_options_param */ sepa_debit?: { /** payment_method_options_mandate_options_param */ - mandate_options?: { [key: string]: unknown }; - }; - }; + mandate_options?: { [key: string]: unknown } + } + } /** @description The list of payment method types (e.g. card) that this SetupIntent is allowed to use. If this is not provided, defaults to ["card"]. */ - payment_method_types?: string[]; + payment_method_types?: string[] /** @description The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm). */ - return_url?: string; + return_url?: string /** * setup_intent_single_use_params * @description If this hash is populated, this SetupIntent will generate a single_use Mandate on success. */ single_use?: { - amount: number; - currency: string; - }; + amount: number + currency: string + } /** * @description Indicates how the payment method is intended to be used in the future. If not provided, this value defaults to `off_session`. * @enum {string} */ - usage?: "off_session" | "on_session"; - }; - }; - }; - }; + usage?: 'off_session' | 'on_session' + } + } + } + } /** *

Retrieves the details of a SetupIntent that has previously been created.

* @@ -39169,72 +38911,72 @@ export interface operations { parameters: { query: { /** The client secret of the SetupIntent. Required if a publishable key is used to retrieve the SetupIntent. */ - client_secret?: string; + client_secret?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - intent: string; - }; - }; + intent: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["setup_intent"]; - }; - }; + 'application/json': components['schemas']['setup_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates a SetupIntent object.

*/ PostSetupIntentsIntent: { parameters: { path: { - intent: string; - }; - }; + intent: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["setup_intent"]; - }; - }; + 'application/json': components['schemas']['setup_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * @description ID of the Customer this SetupIntent belongs to, if one exists. * * If 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. */ - customer?: string; + customer?: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. */ - payment_method?: string; + payment_method?: string /** * payment_method_options_param * @description Payment-method-specific configuration for this SetupIntent. @@ -39243,37 +38985,37 @@ export interface operations { /** setup_intent_payment_method_options_param */ acss_debit?: { /** @enum {string} */ - currency?: "cad" | "usd"; + currency?: 'cad' | 'usd' /** setup_intent_payment_method_options_mandate_options_param */ mandate_options?: { - custom_mandate_url?: Partial & Partial<"">; - default_for?: ("invoice" | "subscription")[]; - interval_description?: string; + custom_mandate_url?: Partial & Partial<''> + default_for?: ('invoice' | 'subscription')[] + interval_description?: string /** @enum {string} */ - payment_schedule?: "combined" | "interval" | "sporadic"; + payment_schedule?: 'combined' | 'interval' | 'sporadic' /** @enum {string} */ - transaction_type?: "business" | "personal"; - }; + transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; - }; + verification_method?: 'automatic' | 'instant' | 'microdeposits' + } /** setup_intent_param */ card?: { /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; - }; + request_three_d_secure?: 'any' | 'automatic' + } /** setup_intent_payment_method_options_param */ sepa_debit?: { /** payment_method_options_mandate_options_param */ - mandate_options?: { [key: string]: unknown }; - }; - }; + mandate_options?: { [key: string]: unknown } + } + } /** @description The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. If this is not provided, defaults to ["card"]. */ - payment_method_types?: string[]; - }; - }; - }; - }; + payment_method_types?: string[] + } + } + } + } /** *

A SetupIntent object can be canceled when it is in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.

* @@ -39282,37 +39024,37 @@ export interface operations { PostSetupIntentsIntentCancel: { parameters: { path: { - intent: string; - }; - }; + intent: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["setup_intent"]; - }; - }; + 'application/json': components['schemas']['setup_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * @description Reason for canceling this SetupIntent. Possible values are `abandoned`, `requested_by_customer`, or `duplicate` * @enum {string} */ - cancellation_reason?: "abandoned" | "duplicate" | "requested_by_customer"; + cancellation_reason?: 'abandoned' | 'duplicate' | 'requested_by_customer' /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /** *

Confirm that your customer intends to set up the current or * provided payment method. For example, you would confirm a SetupIntent @@ -39331,61 +39073,61 @@ export interface operations { PostSetupIntentsIntentConfirm: { parameters: { path: { - intent: string; - }; - }; + intent: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["setup_intent"]; - }; - }; + 'application/json': components['schemas']['setup_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The client secret of the SetupIntent. */ - client_secret?: string; + client_secret?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description This hash contains details about the Mandate to create */ mandate_data?: Partial<{ /** customer_acceptance_param */ customer_acceptance: { /** Format: unix-time */ - accepted_at?: number; + accepted_at?: number /** offline_param */ - offline?: { [key: string]: unknown }; + offline?: { [key: string]: unknown } /** online_param */ online?: { - ip_address: string; - user_agent: string; - }; + ip_address: string + user_agent: string + } /** @enum {string} */ - type: "offline" | "online"; - }; + type: 'offline' | 'online' + } }> & Partial<{ /** customer_acceptance_param */ customer_acceptance: { /** online_param */ online: { - ip_address?: string; - user_agent?: string; - }; + ip_address?: string + user_agent?: string + } /** @enum {string} */ - type: "online"; - }; - }>; + type: 'online' + } + }> /** @description ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. */ - payment_method?: string; + payment_method?: string /** * payment_method_options_param * @description Payment-method-specific configuration for this SetupIntent. @@ -39394,151 +39136,151 @@ export interface operations { /** setup_intent_payment_method_options_param */ acss_debit?: { /** @enum {string} */ - currency?: "cad" | "usd"; + currency?: 'cad' | 'usd' /** setup_intent_payment_method_options_mandate_options_param */ mandate_options?: { - custom_mandate_url?: Partial & Partial<"">; - default_for?: ("invoice" | "subscription")[]; - interval_description?: string; + custom_mandate_url?: Partial & Partial<''> + default_for?: ('invoice' | 'subscription')[] + interval_description?: string /** @enum {string} */ - payment_schedule?: "combined" | "interval" | "sporadic"; + payment_schedule?: 'combined' | 'interval' | 'sporadic' /** @enum {string} */ - transaction_type?: "business" | "personal"; - }; + transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; - }; + verification_method?: 'automatic' | 'instant' | 'microdeposits' + } /** setup_intent_param */ card?: { /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; - }; + request_three_d_secure?: 'any' | 'automatic' + } /** setup_intent_payment_method_options_param */ sepa_debit?: { /** payment_method_options_mandate_options_param */ - mandate_options?: { [key: string]: unknown }; - }; - }; + mandate_options?: { [key: string]: unknown } + } + } /** * @description The URL to redirect your customer back to after they authenticate on the payment method's app or site. * If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. * This parameter is only used for cards and other redirect-based payment methods. */ - return_url?: string; - }; - }; - }; - }; + return_url?: string + } + } + } + } /**

Verifies microdeposits on a SetupIntent object.

*/ PostSetupIntentsIntentVerifyMicrodeposits: { parameters: { path: { - intent: string; - }; - }; + intent: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["setup_intent"]; - }; - }; + 'application/json': components['schemas']['setup_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account. */ - amounts?: number[]; + amounts?: number[] /** @description The client secret of the SetupIntent. */ - client_secret?: string; + client_secret?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Returns a list of your shipping rates.

*/ GetShippingRates: { parameters: { query: { /** Only return shipping rates that are active or inactive. */ - active?: boolean; + active?: boolean /** 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?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** Only return shipping rates for the given currency. */ - currency?: string; + currency?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["shipping_rate"][]; + 'application/json': { + data: components['schemas']['shipping_rate'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new shipping rate object.

*/ PostShippingRates: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["shipping_rate"]; - }; - }; + 'application/json': components['schemas']['shipping_rate'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * delivery_estimate * @description The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions. @@ -39547,335 +39289,335 @@ export interface operations { /** delivery_estimate_bound */ maximum?: { /** @enum {string} */ - unit: "business_day" | "day" | "hour" | "month" | "week"; - value: number; - }; + unit: 'business_day' | 'day' | 'hour' | 'month' | 'week' + value: number + } /** delivery_estimate_bound */ minimum?: { /** @enum {string} */ - unit: "business_day" | "day" | "hour" | "month" | "week"; - value: number; - }; - }; + unit: 'business_day' | 'day' | 'hour' | 'month' | 'week' + value: number + } + } /** @description The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions. */ - display_name: string; + display_name: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * fixed_amount * @description Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`. */ fixed_amount?: { - amount: number; - currency: string; - }; + amount: number + currency: string + } /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * @description Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. * @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' /** @description A [tax code](https://stripe.com/docs/tax/tax-codes) ID. The Shipping tax code is `txcd_92010001`. */ - tax_code?: string; + tax_code?: string /** * @description The type of calculation to use on the shipping rate. Can only be `fixed_amount` for now. * @enum {string} */ - type?: "fixed_amount"; - }; - }; - }; - }; + type?: 'fixed_amount' + } + } + } + } /**

Returns the shipping rate object with the given ID.

*/ GetShippingRatesShippingRateToken: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - shipping_rate_token: string; - }; - }; + shipping_rate_token: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["shipping_rate"]; - }; - }; + 'application/json': components['schemas']['shipping_rate'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates an existing shipping rate object.

*/ PostShippingRatesShippingRateToken: { parameters: { path: { - shipping_rate_token: string; - }; - }; + shipping_rate_token: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["shipping_rate"]; - }; - }; + 'application/json': components['schemas']['shipping_rate'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether the shipping rate can be used for new purchases. Defaults to `true`. */ - active?: boolean; + active?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Returns a list of scheduled query runs.

*/ GetSigmaScheduledQueryRuns: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["scheduled_query_run"][]; + 'application/json': { + data: components['schemas']['scheduled_query_run'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves the details of an scheduled query run.

*/ GetSigmaScheduledQueryRunsScheduledQueryRun: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - scheduled_query_run: string; - }; - }; + scheduled_query_run: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["scheduled_query_run"]; - }; - }; + 'application/json': components['schemas']['scheduled_query_run'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of your SKUs. The SKUs are returned sorted by creation date, with the most recently created SKUs appearing first.

*/ GetSkus: { parameters: { query: { /** Only return SKUs that are active or inactive (e.g., pass `false` to list all inactive products). */ - active?: boolean; + active?: boolean /** Only return SKUs that have the specified key-value pairs in this partially constructed dictionary. Can be specified only if `product` is also supplied. For instance, if the associated product has attributes `["color", "size"]`, passing in `attributes[color]=red` returns all the SKUs for this product that have `color` set to `red`. */ - attributes?: { [key: string]: string }; + attributes?: { [key: string]: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** Only return SKUs with the given IDs. */ - ids?: string[]; + ids?: string[] /** Only return SKUs that are either in stock or out of stock (e.g., pass `false` to list all SKUs that are out of stock). If no value is provided, all SKUs are returned. */ - in_stock?: boolean; + in_stock?: boolean /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** The ID of the product whose SKUs will be retrieved. Must be a product with type `good`. */ - product?: string; + product?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["sku"][]; + 'application/json': { + data: components['schemas']['sku'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new SKU associated with a product.

*/ PostSkus: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["sku"]; - }; - }; + 'application/json': components['schemas']['sku'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether the SKU is available for purchase. Default to `true`. */ - active?: boolean; + active?: boolean /** @description A dictionary of attributes and values for the attributes defined by the product. If, for example, a product's attributes are `["size", "gender"]`, a valid SKU has the following dictionary of attributes: `{"size": "Medium", "gender": "Unisex"}`. */ - attributes?: { [key: string]: string }; + attributes?: { [key: string]: string } /** @description 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: string; + currency: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The identifier for the SKU. Must be unique. If not provided, an identifier will be randomly generated. */ - id?: string; + id?: string /** @description The URL of an image for this SKU, meant to be displayable to the customer. */ - image?: string; + image?: string /** * inventory_create_specs * @description Description of the SKU's inventory. */ inventory: { - quantity?: number; + quantity?: number /** @enum {string} */ - type: "bucket" | "finite" | "infinite"; + type: 'bucket' | 'finite' | 'infinite' /** @enum {string} */ - value?: "" | "in_stock" | "limited" | "out_of_stock"; - }; + value?: '' | 'in_stock' | 'limited' | 'out_of_stock' + } /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * package_dimensions_specs * @description The dimensions of this SKU for shipping purposes. */ package_dimensions?: { - height: number; - length: number; - weight: number; - width: number; - }; + height: number + length: number + weight: number + width: number + } /** @description The cost of the item as a nonnegative integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a zero-decimal currency). */ - price: number; + price: number /** @description The ID of the product this SKU is associated with. Must be a product with type `good`. */ - product: string; - }; - }; - }; - }; + product: string + } + } + } + } /**

Retrieves the details of an existing SKU. Supply the unique SKU identifier from either a SKU creation request or from the product, and Stripe will return the corresponding SKU information.

*/ GetSkusId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": Partial & Partial; - }; - }; + 'application/json': Partial & Partial + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates the specific SKU by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

* @@ -39884,124 +39626,124 @@ export interface operations { PostSkusId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["sku"]; - }; - }; + 'application/json': components['schemas']['sku'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether this SKU is available for purchase. */ - active?: boolean; + active?: boolean /** @description A dictionary of attributes and values for the attributes defined by the product. When specified, `attributes` will partially update the existing attributes dictionary on the product, with the postcondition that a value must be present for each attribute key on the product. */ - attributes?: { [key: string]: string }; + attributes?: { [key: string]: string } /** @description 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?: string; + currency?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The URL of an image for this SKU, meant to be displayable to the customer. */ - image?: string; + image?: string /** * inventory_update_specs * @description Description of the SKU's inventory. */ inventory?: { - quantity?: number; + quantity?: number /** @enum {string} */ - type?: "bucket" | "finite" | "infinite"; + type?: 'bucket' | 'finite' | 'infinite' /** @enum {string} */ - value?: "" | "in_stock" | "limited" | "out_of_stock"; - }; + value?: '' | 'in_stock' | 'limited' | 'out_of_stock' + } /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The dimensions of this SKU for shipping purposes. */ package_dimensions?: Partial<{ - height: number; - length: number; - weight: number; - width: number; + height: number + length: number + weight: number + width: number }> & - Partial<"">; + Partial<''> /** @description The cost of the item as a positive integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a zero-decimal currency). */ - price?: number; + price?: number /** @description The ID of the product that this SKU should belong to. The product must exist, have the same set of attribute names as the SKU's current product, and be of type `good`. */ - product?: string; - }; - }; - }; - }; + product?: string + } + } + } + } /**

Delete a SKU. Deleting a SKU is only possible until it has been used in an order.

*/ DeleteSkusId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_sku"]; - }; - }; + 'application/json': components['schemas']['deleted_sku'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new source object.

*/ PostSources: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["source"]; - }; - }; + 'application/json': components['schemas']['source'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources. Not supported for `receiver` type sources, where charge amount may not be specified until funds land. */ - amount?: number; + amount?: number /** @description 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. */ - currency?: string; + currency?: string /** @description The `Customer` to whom the original source is attached to. Must be set when the original source is not a `Source` (e.g., `Card`). */ - customer?: string; + customer?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * @description The authentication `flow` of the source to create. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`. It is generally inferred unless a type supports multiple flows. * @enum {string} */ - flow?: "code_verification" | "none" | "receiver" | "redirect"; + flow?: 'code_verification' | 'none' | 'receiver' | 'redirect' /** * mandate_params * @description Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status. @@ -40010,35 +39752,35 @@ export interface operations { /** mandate_acceptance_params */ acceptance?: { /** Format: unix-time */ - date?: number; - ip?: string; + date?: number + ip?: string /** mandate_offline_acceptance_params */ offline?: { - contact_email: string; - }; + contact_email: string + } /** mandate_online_acceptance_params */ online?: { /** Format: unix-time */ - date?: number; - ip?: string; - user_agent?: string; - }; + date?: number + ip?: string + user_agent?: string + } /** @enum {string} */ - status: "accepted" | "pending" | "refused" | "revoked"; + status: 'accepted' | 'pending' | 'refused' | 'revoked' /** @enum {string} */ - type?: "offline" | "online"; - user_agent?: string; - }; - amount?: Partial & Partial<"">; - currency?: string; + type?: 'offline' | 'online' + user_agent?: string + } + amount?: Partial & Partial<''> + currency?: string /** @enum {string} */ - interval?: "one_time" | "scheduled" | "variable"; + interval?: 'one_time' | 'scheduled' | 'variable' /** @enum {string} */ - notification_method?: "deprecated_none" | "email" | "manual" | "none" | "stripe_email"; - }; - metadata?: { [key: string]: string }; + notification_method?: 'deprecated_none' | 'email' | 'manual' | 'none' | 'stripe_email' + } + metadata?: { [key: string]: string } /** @description The source to share. */ - original_source?: string; + original_source?: string /** * owner * @description Information about the owner of the payment instrument that may be used or required by particular source types. @@ -40046,108 +39788,108 @@ export interface operations { owner?: { /** source_address */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - email?: string; - name?: string; - phone?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + email?: string + name?: string + phone?: string + } /** * receiver_params * @description Optional parameters for the receiver flow. Can be set only if the source is a receiver (`flow` is `receiver`). */ receiver?: { /** @enum {string} */ - refund_attributes_method?: "email" | "manual" | "none"; - }; + refund_attributes_method?: 'email' | 'manual' | 'none' + } /** * redirect_params * @description Parameters required for the redirect flow. Required if the source is authenticated by a redirect (`flow` is `redirect`). */ redirect?: { - return_url: string; - }; + return_url: string + } /** * shallow_order_specs * @description Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it. */ source_order?: { items?: { - amount?: number; - currency?: string; - description?: string; - parent?: string; - quantity?: number; + amount?: number + currency?: string + description?: string + parent?: string + quantity?: number /** @enum {string} */ - type?: "discount" | "shipping" | "sku" | "tax"; - }[]; + type?: 'discount' | 'shipping' | 'sku' | 'tax' + }[] /** order_shipping */ shipping?: { /** address */ address: { - city?: string; - country?: string; - line1: string; - line2?: string; - postal_code?: string; - state?: string; - }; - carrier?: string; - name?: string; - phone?: string; - tracking_number?: string; - }; - }; + city?: string + country?: string + line1: string + line2?: string + postal_code?: string + state?: string + } + carrier?: string + name?: string + phone?: string + tracking_number?: string + } + } /** @description An arbitrary string to be displayed on your customer's statement. As an example, if your website is `RunClub` and the item you're charging for is a race ticket, you may want to specify a `statement_descriptor` of `RunClub 5K race ticket.` While many payment types will display this information, some may not display it at all. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description An optional token used to create the source. When passed, token properties will override source parameters. */ - token?: string; + token?: string /** @description The `type` of the source to create. Required unless `customer` and `original_source` are specified (see the [Cloning card Sources](https://stripe.com/docs/sources/connect#cloning-card-sources) guide) */ - type?: string; + type?: string /** @enum {string} */ - usage?: "reusable" | "single_use"; - }; - }; - }; - }; + usage?: 'reusable' | 'single_use' + } + } + } + } /**

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.

*/ GetSourcesSource: { parameters: { query: { /** The client secret of the source. Required if a publishable key is used to retrieve the source. */ - client_secret?: string; + client_secret?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - source: string; - }; - }; + source: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["source"]; - }; - }; + 'application/json': components['schemas']['source'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates the specified source by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

* @@ -40156,30 +39898,30 @@ export interface operations { PostSourcesSource: { parameters: { path: { - source: string; - }; - }; + source: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["source"]; - }; - }; + 'application/json': components['schemas']['source'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Amount associated with the source. */ - amount?: number; + amount?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * mandate_params * @description Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status. @@ -40188,34 +39930,34 @@ export interface operations { /** mandate_acceptance_params */ acceptance?: { /** Format: unix-time */ - date?: number; - ip?: string; + date?: number + ip?: string /** mandate_offline_acceptance_params */ offline?: { - contact_email: string; - }; + contact_email: string + } /** mandate_online_acceptance_params */ online?: { /** Format: unix-time */ - date?: number; - ip?: string; - user_agent?: string; - }; + date?: number + ip?: string + user_agent?: string + } /** @enum {string} */ - status: "accepted" | "pending" | "refused" | "revoked"; + status: 'accepted' | 'pending' | 'refused' | 'revoked' /** @enum {string} */ - type?: "offline" | "online"; - user_agent?: string; - }; - amount?: Partial & Partial<"">; - currency?: string; + type?: 'offline' | 'online' + user_agent?: string + } + amount?: Partial & Partial<''> + currency?: string /** @enum {string} */ - interval?: "one_time" | "scheduled" | "variable"; + interval?: 'one_time' | 'scheduled' | 'variable' /** @enum {string} */ - notification_method?: "deprecated_none" | "email" | "manual" | "none" | "stripe_email"; - }; + notification_method?: 'deprecated_none' | 'email' | 'manual' | 'none' | 'stripe_email' + } /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** * owner * @description Information about the owner of the payment instrument that may be used or required by particular source types. @@ -40223,271 +39965,271 @@ export interface operations { owner?: { /** source_address */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - email?: string; - name?: string; - phone?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + email?: string + name?: string + phone?: string + } /** * order_params * @description Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it. */ source_order?: { items?: { - amount?: number; - currency?: string; - description?: string; - parent?: string; - quantity?: number; + amount?: number + currency?: string + description?: string + parent?: string + quantity?: number /** @enum {string} */ - type?: "discount" | "shipping" | "sku" | "tax"; - }[]; + type?: 'discount' | 'shipping' | 'sku' | 'tax' + }[] /** order_shipping */ shipping?: { /** address */ address: { - city?: string; - country?: string; - line1: string; - line2?: string; - postal_code?: string; - state?: string; - }; - carrier?: string; - name?: string; - phone?: string; - tracking_number?: string; - }; - }; - }; - }; - }; - }; + city?: string + country?: string + line1: string + line2?: string + postal_code?: string + state?: string + } + carrier?: string + name?: string + phone?: string + tracking_number?: string + } + } + } + } + } + } /**

Retrieves a new Source MandateNotification.

*/ GetSourcesSourceMandateNotificationsMandateNotification: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - mandate_notification: string; - source: string; - }; - }; + mandate_notification: string + source: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["source_mandate_notification"]; - }; - }; + 'application/json': components['schemas']['source_mandate_notification'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

List source transactions for a given source.

*/ GetSourcesSourceSourceTransactions: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - source: string; - }; - }; + source: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["source_transaction"][]; + 'application/json': { + data: components['schemas']['source_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ GetSourcesSourceSourceTransactionsSourceTransaction: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - source: string; - source_transaction: string; - }; - }; + source: string + source_transaction: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["source_transaction"]; - }; - }; + 'application/json': components['schemas']['source_transaction'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Verify a given source.

*/ PostSourcesSourceVerify: { parameters: { path: { - source: string; - }; - }; + source: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["source"]; - }; - }; + 'application/json': components['schemas']['source'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The values needed to verify the source. */ - values: string[]; - }; - }; - }; - }; + values: string[] + } + } + } + } /**

Returns a list of your subscription items for a given subscription.

*/ GetSubscriptionItems: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** The ID of the subscription whose items will be retrieved. */ - subscription: string; - }; - }; + subscription: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["subscription_item"][]; + 'application/json': { + data: components['schemas']['subscription_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Adds a new item to an existing subscription. No existing items will be changed or replaced.

*/ PostSubscriptionItems: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription_item"]; - }; - }; + 'application/json': components['schemas']['subscription_item'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. */ billing_thresholds?: Partial<{ - usage_gte: number; + usage_gte: number }> & - Partial<"">; + Partial<''> /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * @description Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * @@ -40498,32 +40240,28 @@ export interface operations { * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. * @enum {string} */ - payment_behavior?: - | "allow_incomplete" - | "default_incomplete" - | "error_if_incomplete" - | "pending_if_incomplete"; + payment_behavior?: 'allow_incomplete' | 'default_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete' /** @description The ID of the price object. */ - price?: string; + price?: string /** * recurring_price_data * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; + unit_amount_decimal?: string + } /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -40532,88 +40270,88 @@ export interface operations { * Prorations can be disabled by passing `none`. * @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** * Format: unix-time * @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. */ - proration_date?: number; + proration_date?: number /** @description The quantity you'd like to apply to the subscription item you're creating. */ - quantity?: number; + quantity?: number /** @description The identifier of the subscription to modify. */ - subscription: string; + subscription: string /** @description A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. */ - tax_rates?: Partial & Partial<"">; - }; - }; - }; - }; + tax_rates?: Partial & Partial<''> + } + } + } + } /**

Retrieves the subscription item with the given ID.

*/ GetSubscriptionItemsItem: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - item: string; - }; - }; + item: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription_item"]; - }; - }; + 'application/json': components['schemas']['subscription_item'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates the plan or quantity of an item on a current subscription.

*/ PostSubscriptionItemsItem: { parameters: { path: { - item: string; - }; - }; + item: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription_item"]; - }; - }; + 'application/json': components['schemas']['subscription_item'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. */ billing_thresholds?: Partial<{ - usage_gte: number; + usage_gte: number }> & - Partial<"">; + Partial<''> /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. */ - off_session?: boolean; + off_session?: boolean /** * @description Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * @@ -40624,32 +40362,28 @@ export interface operations { * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. * @enum {string} */ - payment_behavior?: - | "allow_incomplete" - | "default_incomplete" - | "error_if_incomplete" - | "pending_if_incomplete"; + payment_behavior?: 'allow_incomplete' | 'default_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete' /** @description The ID of the price object. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided. */ - price?: string; + price?: string /** * recurring_price_data * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; + unit_amount_decimal?: string + } /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -40658,46 +40392,46 @@ export interface operations { * Prorations can be disabled by passing `none`. * @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** * Format: unix-time * @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. */ - proration_date?: number; + proration_date?: number /** @description The quantity you'd like to apply to the subscription item you're creating. */ - quantity?: number; + quantity?: number /** @description A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. */ - tax_rates?: Partial & Partial<"">; - }; - }; - }; - }; + tax_rates?: Partial & Partial<''> + } + } + } + } /**

Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.

*/ DeleteSubscriptionItemsItem: { parameters: { path: { - item: string; - }; - }; + item: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_subscription_item"]; - }; - }; + 'application/json': components['schemas']['deleted_subscription_item'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Delete all usage for the given subscription item. Allowed only when the current plan's `usage_type` is `metered`. */ - clear_usage?: boolean; + clear_usage?: boolean /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -40706,16 +40440,16 @@ export interface operations { * Prorations can be disabled by passing `none`. * @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** * Format: unix-time * @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. */ - proration_date?: number; - }; - }; - }; - }; + proration_date?: number + } + } + } + } /** *

For the specified subscription item, returns a list of summary objects. Each object in the list provides usage information that’s been summarized from multiple usage records and over a subscription billing period (e.g., 15 usage records in the month of September).

* @@ -40725,49 +40459,49 @@ export interface operations { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - subscription_item: string; - }; - }; + subscription_item: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["usage_record_summary"][]; + 'application/json': { + data: components['schemas']['usage_record_summary'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Creates a usage record for a specified subscription item and date, and fills it with a quantity.

* @@ -40780,712 +40514,703 @@ export interface operations { PostSubscriptionItemsSubscriptionItemUsageRecords: { parameters: { path: { - subscription_item: string; - }; - }; + subscription_item: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["usage_record"]; - }; - }; + 'application/json': components['schemas']['usage_record'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * @description Valid values are `increment` (default) or `set`. When using `increment` the specified `quantity` will be added to the usage at the specified timestamp. The `set` action will overwrite the usage quantity at that timestamp. If the subscription has [billing thresholds](https://stripe.com/docs/api/subscriptions/object#subscription_object-billing_thresholds), `increment` is the only allowed value. * @enum {string} */ - action?: "increment" | "set"; + action?: 'increment' | 'set' /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The usage quantity for the specified timestamp. */ - quantity: number; + quantity: number /** @description The timestamp for the usage event. This timestamp must be within the current billing period of the subscription of the provided `subscription_item`, and must not be in the future. When passing `"now"`, Stripe records usage for the current time. Default is `"now"` if a value is not provided. */ - timestamp?: Partial<"now"> & Partial; - }; - }; - }; - }; + timestamp?: Partial<'now'> & Partial + } + } + } + } /**

Retrieves the list of your subscription schedules.

*/ GetSubscriptionSchedules: { parameters: { query: { /** Only return subscription schedules that were created canceled the given date interval. */ canceled_at?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** Only return subscription schedules that completed during the given date interval. */ completed_at?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** Only return subscription schedules that were created during the given date interval. */ created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** Only return subscription schedules for the given customer. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return subscription schedules that were released during the given date interval. */ released_at?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** Only return subscription schedules that have not started yet. */ - scheduled?: boolean; + scheduled?: boolean /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["subscription_schedule"][]; + 'application/json': { + data: components['schemas']['subscription_schedule'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.

*/ PostSubscriptionSchedules: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription_schedule"]; - }; - }; + 'application/json': components['schemas']['subscription_schedule'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The identifier of the customer to create the subscription schedule for. */ - customer?: string; + customer?: string /** * default_settings_params * @description Object representing the subscription schedule's default settings. */ default_settings?: { - application_fee_percent?: number; + application_fee_percent?: number /** automatic_tax_config */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** @enum {string} */ - billing_cycle_anchor?: "automatic" | "phase_start"; + billing_cycle_anchor?: 'automatic' | 'phase_start' billing_thresholds?: Partial<{ - amount_gte?: number; - reset_billing_cycle_anchor?: boolean; + amount_gte?: number + reset_billing_cycle_anchor?: boolean }> & - Partial<"">; + Partial<''> /** @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; - default_payment_method?: string; + collection_method?: 'charge_automatically' | 'send_invoice' + default_payment_method?: string /** subscription_schedules_param */ invoice_settings?: { - days_until_due?: number; - }; + days_until_due?: number + } transfer_data?: Partial<{ - amount_percent?: number; - destination: string; + amount_percent?: number + destination: string }> & - Partial<"">; - }; + Partial<''> + } /** * @description Configures how the subscription schedule behaves 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. * @enum {string} */ - end_behavior?: "cancel" | "none" | "release" | "renew"; + end_behavior?: 'cancel' | 'none' | 'release' | 'renew' /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls. */ - from_subscription?: string; + from_subscription?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. */ phases?: { add_invoice_items?: { - price?: string; + price?: string /** one_time_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; - application_fee_percent?: number; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] + application_fee_percent?: number /** automatic_tax_config */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** @enum {string} */ - billing_cycle_anchor?: "automatic" | "phase_start"; + billing_cycle_anchor?: 'automatic' | 'phase_start' billing_thresholds?: Partial<{ - amount_gte?: number; - reset_billing_cycle_anchor?: boolean; + amount_gte?: number + reset_billing_cycle_anchor?: boolean }> & - Partial<"">; + Partial<''> /** @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; - coupon?: string; - default_payment_method?: string; - default_tax_rates?: Partial & Partial<"">; + collection_method?: 'charge_automatically' | 'send_invoice' + coupon?: string + default_payment_method?: string + default_tax_rates?: Partial & Partial<''> /** Format: unix-time */ - end_date?: number; + end_date?: number /** subscription_schedules_param */ invoice_settings?: { - days_until_due?: number; - }; + days_until_due?: number + } items: { billing_thresholds?: Partial<{ - usage_gte: number; + usage_gte: number }> & - Partial<"">; - price?: string; + Partial<''> + price?: string /** recurring_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; - iterations?: number; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] + iterations?: number /** @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** transfer_data_specs */ transfer_data?: { - amount_percent?: number; - destination: string; - }; - trial?: boolean; + amount_percent?: number + destination: string + } + trial?: boolean /** Format: unix-time */ - trial_end?: number; - }[]; + trial_end?: number + }[] /** @description When the subscription schedule starts. We recommend using `now` so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on. */ - start_date?: Partial & Partial<"now">; - }; - }; - }; - }; + start_date?: Partial & Partial<'now'> + } + } + } + } /**

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.

*/ GetSubscriptionSchedulesSchedule: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - schedule: string; - }; - }; + schedule: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription_schedule"]; - }; - }; + 'application/json': components['schemas']['subscription_schedule'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates an existing subscription schedule.

*/ PostSubscriptionSchedulesSchedule: { parameters: { path: { - schedule: string; - }; - }; + schedule: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription_schedule"]; - }; - }; + 'application/json': components['schemas']['subscription_schedule'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * default_settings_params * @description Object representing the subscription schedule's default settings. */ default_settings?: { - application_fee_percent?: number; + application_fee_percent?: number /** automatic_tax_config */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** @enum {string} */ - billing_cycle_anchor?: "automatic" | "phase_start"; + billing_cycle_anchor?: 'automatic' | 'phase_start' billing_thresholds?: Partial<{ - amount_gte?: number; - reset_billing_cycle_anchor?: boolean; + amount_gte?: number + reset_billing_cycle_anchor?: boolean }> & - Partial<"">; + Partial<''> /** @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; - default_payment_method?: string; + collection_method?: 'charge_automatically' | 'send_invoice' + default_payment_method?: string /** subscription_schedules_param */ invoice_settings?: { - days_until_due?: number; - }; + days_until_due?: number + } transfer_data?: Partial<{ - amount_percent?: number; - destination: string; + amount_percent?: number + destination: string }> & - Partial<"">; - }; + Partial<''> + } /** * @description Configures how the subscription schedule behaves 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. * @enum {string} */ - end_behavior?: "cancel" | "none" | "release" | "renew"; + end_behavior?: 'cancel' | 'none' | 'release' | 'renew' /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. Note that past phases can be omitted. */ phases?: { add_invoice_items?: { - price?: string; + price?: string /** one_time_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; - application_fee_percent?: number; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] + application_fee_percent?: number /** automatic_tax_config */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** @enum {string} */ - billing_cycle_anchor?: "automatic" | "phase_start"; + billing_cycle_anchor?: 'automatic' | 'phase_start' billing_thresholds?: Partial<{ - amount_gte?: number; - reset_billing_cycle_anchor?: boolean; + amount_gte?: number + reset_billing_cycle_anchor?: boolean }> & - Partial<"">; + Partial<''> /** @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; - coupon?: string; - default_payment_method?: string; - default_tax_rates?: Partial & Partial<"">; - end_date?: Partial & Partial<"now">; + collection_method?: 'charge_automatically' | 'send_invoice' + coupon?: string + default_payment_method?: string + default_tax_rates?: Partial & Partial<''> + end_date?: Partial & Partial<'now'> /** subscription_schedules_param */ invoice_settings?: { - days_until_due?: number; - }; + days_until_due?: number + } items: { billing_thresholds?: Partial<{ - usage_gte: number; + usage_gte: number }> & - Partial<"">; - price?: string; + Partial<''> + price?: string /** recurring_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; - iterations?: number; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] + iterations?: number /** @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; - start_date?: Partial & Partial<"now">; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' + start_date?: Partial & Partial<'now'> /** transfer_data_specs */ transfer_data?: { - amount_percent?: number; - destination: string; - }; - trial?: boolean; - trial_end?: Partial & Partial<"now">; - }[]; + amount_percent?: number + destination: string + } + trial?: boolean + trial_end?: Partial & Partial<'now'> + }[] /** * @description If the update changes the current phase, indicates if the changes should be prorated. Possible values are `create_prorations` or `none`, and the default value is `create_prorations`. * @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; - }; - }; - }; - }; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' + } + } + } + } /**

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.

*/ PostSubscriptionSchedulesScheduleCancel: { parameters: { path: { - schedule: string; - }; - }; + schedule: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription_schedule"]; - }; - }; + 'application/json': components['schemas']['subscription_schedule'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Defaults to `true`. */ - invoice_now?: boolean; + invoice_now?: boolean /** @description If the subscription schedule is `active`, indicates if the cancellation should be prorated. Defaults to `true`. */ - prorate?: boolean; - }; - }; - }; - }; + prorate?: boolean + } + } + } + } /**

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.

*/ PostSubscriptionSchedulesScheduleRelease: { parameters: { path: { - schedule: string; - }; - }; + schedule: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription_schedule"]; - }; - }; + 'application/json': components['schemas']['subscription_schedule'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Keep any cancellation on the subscription that the schedule has set */ - preserve_cancel_date?: boolean; - }; - }; - }; - }; + preserve_cancel_date?: boolean + } + } + } + } /**

By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.

*/ GetSubscriptions: { parameters: { query: { /** The collection method of the subscriptions to retrieve. Either `charge_automatically` or `send_invoice`. */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial current_period_end?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial current_period_start?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** The ID of the customer whose subscriptions will be retrieved. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Filter for subscriptions that contain this recurring price ID. */ - price?: string; + price?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** 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?: - | "active" - | "all" - | "canceled" - | "ended" - | "incomplete" - | "incomplete_expired" - | "past_due" - | "trialing" - | "unpaid"; - }; - }; + status?: 'active' | 'all' | 'canceled' | 'ended' | 'incomplete' | 'incomplete_expired' | 'past_due' | 'trialing' | 'unpaid' + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["subscription"][]; + 'application/json': { + data: components['schemas']['subscription'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.

*/ PostSubscriptions: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription"]; - }; - }; + 'application/json': components['schemas']['subscription'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A list of prices and quantities that will generate invoice items appended to the first invoice for this subscription. You may pass up to 20 items. */ add_invoice_items?: { - price?: string; + price?: string /** one_time_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). */ - application_fee_percent?: number; + application_fee_percent?: number /** * automatic_tax_config * @description Automatic tax settings for this subscription. */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** * Format: unix-time * @description For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor. */ - backdate_start_date?: number; + backdate_start_date?: number /** * Format: unix-time * @description 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. */ - billing_cycle_anchor?: number; + billing_cycle_anchor?: number /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. */ billing_thresholds?: Partial<{ - amount_gte?: number; - reset_billing_cycle_anchor?: boolean; + amount_gte?: number + reset_billing_cycle_anchor?: boolean }> & - Partial<"">; + Partial<''> /** * Format: unix-time * @description 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. */ - cancel_at?: number; + cancel_at?: number /** @description Boolean indicating whether this subscription should cancel at the end of the current period. */ - cancel_at_period_end?: boolean; + cancel_at_period_end?: boolean /** * @description 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. Defaults to `charge_automatically`. * @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' /** @description The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. */ - coupon?: string; + coupon?: string /** @description The identifier of the customer to subscribe. */ - customer: string; + customer: string /** @description Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. */ - days_until_due?: number; + days_until_due?: number /** @description 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?: string; + default_payment_method?: string /** @description 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?: string; + default_source?: string /** @description 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?: Partial & Partial<"">; + default_tax_rates?: Partial & Partial<''> /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A list of up to 20 subscription items, each with an attached price. */ items?: { billing_thresholds?: Partial<{ - usage_gte: number; + usage_gte: number }> & - Partial<"">; - metadata?: { [key: string]: string }; - price?: string; + Partial<''> + metadata?: { [key: string]: string } + price?: string /** recurring_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. */ - off_session?: boolean; + off_session?: boolean /** * @description Use `allow_incomplete` to create subscriptions with `status=incomplete` if the first invoice cannot be paid. Creating subscriptions with this status allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * @@ -41496,11 +41221,7 @@ export interface operations { * `pending_if_incomplete` is only used with updates and cannot be passed when creating a subscription. * @enum {string} */ - payment_behavior?: - | "allow_incomplete" - | "default_incomplete" - | "error_if_incomplete" - | "pending_if_incomplete"; + payment_behavior?: 'allow_incomplete' | 'default_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete' /** * payment_settings * @description Payment settings to pass to invoices created by the subscription. @@ -41512,239 +41233,239 @@ export interface operations { /** mandate_options_param */ mandate_options?: { /** @enum {string} */ - transaction_type?: "business" | "personal"; - }; + transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; + verification_method?: 'automatic' | 'instant' | 'microdeposits' }> & - Partial<"">; + Partial<''> bancontact?: Partial<{ /** @enum {string} */ - preferred_language?: "de" | "en" | "fr" | "nl"; + preferred_language?: 'de' | 'en' | 'fr' | 'nl' }> & - Partial<"">; + Partial<''> card?: Partial<{ /** mandate_options_param */ mandate_options?: { - amount?: number; + amount?: number /** @enum {string} */ - amount_type?: "fixed" | "maximum"; - description?: string; - }; + amount_type?: 'fixed' | 'maximum' + description?: string + } /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: 'any' | 'automatic' }> & - Partial<"">; - }; + Partial<''> + } payment_method_types?: Partial< ( - | "ach_credit_transfer" - | "ach_debit" - | "acss_debit" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "sepa_debit" - | "sofort" - | "wechat_pay" + | 'ach_credit_transfer' + | 'ach_debit' + | 'acss_debit' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' )[] > & - Partial<"">; - }; + Partial<''> + } /** @description 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?: Partial<{ /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number }> & - Partial<"">; + Partial<''> /** @description The API ID of a promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. */ - promotion_code?: string; + promotion_code?: string /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) resulting from the `billing_cycle_anchor`. Valid values are `create_prorations` or `none`. * * Passing `create_prorations` will cause proration invoice items to be created when applicable. Prorations can be disabled by passing `none`. If no value is passed, the default is `create_prorations`. * @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** * transfer_data_specs * @description If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. */ transfer_data?: { - amount_percent?: number; - destination: string; - }; + amount_percent?: number + destination: string + } /** @description Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. */ - trial_end?: Partial<"now"> & Partial; + trial_end?: Partial<'now'> & Partial /** @description 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?: boolean; + trial_from_plan?: boolean /** @description Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. */ - trial_period_days?: number; - }; - }; - }; - }; + trial_period_days?: number + } + } + } + } /**

Retrieves the subscription with the given ID.

*/ GetSubscriptionsSubscriptionExposedId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - subscription_exposed_id: string; - }; - }; + subscription_exposed_id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription"]; - }; - }; + 'application/json': components['schemas']['subscription'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostSubscriptionsSubscriptionExposedId: { parameters: { path: { - subscription_exposed_id: string; - }; - }; + subscription_exposed_id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription"]; - }; - }; + 'application/json': components['schemas']['subscription'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A list of prices and quantities that will generate invoice items appended to the first invoice for this subscription. You may pass up to 20 items. */ add_invoice_items?: { - price?: string; + price?: string /** one_time_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). */ - application_fee_percent?: number; + application_fee_percent?: number /** * automatic_tax_config * @description Automatic tax settings for this subscription. */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** * @description Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). * @enum {string} */ - billing_cycle_anchor?: "now" | "unchanged"; + billing_cycle_anchor?: 'now' | 'unchanged' /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. */ billing_thresholds?: Partial<{ - amount_gte?: number; - reset_billing_cycle_anchor?: boolean; + amount_gte?: number + reset_billing_cycle_anchor?: boolean }> & - Partial<"">; + Partial<''> /** @description 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. */ - cancel_at?: Partial & Partial<"">; + cancel_at?: Partial & Partial<''> /** @description Boolean indicating whether this subscription should cancel at the end of the current period. */ - cancel_at_period_end?: boolean; + cancel_at_period_end?: boolean /** * @description 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. Defaults to `charge_automatically`. * @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' /** @description The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. */ - coupon?: string; + coupon?: string /** @description Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. */ - days_until_due?: number; + days_until_due?: number /** @description 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?: string; + default_payment_method?: string /** @description 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?: string; + default_source?: string /** @description 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. Pass an empty string to remove previously-defined tax rates. */ - default_tax_rates?: Partial & Partial<"">; + default_tax_rates?: Partial & Partial<''> /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A list of up to 20 subscription items, each with an attached price. */ items?: { billing_thresholds?: Partial<{ - usage_gte: number; + usage_gte: number }> & - Partial<"">; - clear_usage?: boolean; - deleted?: boolean; - id?: string; - metadata?: Partial<{ [key: string]: string }> & Partial<"">; - price?: string; + Partial<''> + clear_usage?: boolean + deleted?: boolean + id?: string + metadata?: Partial<{ [key: string]: string }> & Partial<''> + price?: string /** recurring_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. */ - off_session?: boolean; + off_session?: boolean /** @description If specified, payment collection for this subscription will be paused. */ pause_collection?: Partial<{ /** @enum {string} */ - behavior: "keep_as_draft" | "mark_uncollectible" | "void"; + behavior: 'keep_as_draft' | 'mark_uncollectible' | 'void' /** Format: unix-time */ - resumes_at?: number; + resumes_at?: number }> & - Partial<"">; + Partial<''> /** * @description Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * @@ -41755,11 +41476,7 @@ export interface operations { * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. * @enum {string} */ - payment_behavior?: - | "allow_incomplete" - | "default_incomplete" - | "error_if_incomplete" - | "pending_if_incomplete"; + payment_behavior?: 'allow_incomplete' | 'default_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete' /** * payment_settings * @description Payment settings to pass to invoices created by the subscription. @@ -41771,60 +41488,60 @@ export interface operations { /** mandate_options_param */ mandate_options?: { /** @enum {string} */ - transaction_type?: "business" | "personal"; - }; + transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; + verification_method?: 'automatic' | 'instant' | 'microdeposits' }> & - Partial<"">; + Partial<''> bancontact?: Partial<{ /** @enum {string} */ - preferred_language?: "de" | "en" | "fr" | "nl"; + preferred_language?: 'de' | 'en' | 'fr' | 'nl' }> & - Partial<"">; + Partial<''> card?: Partial<{ /** mandate_options_param */ mandate_options?: { - amount?: number; + amount?: number /** @enum {string} */ - amount_type?: "fixed" | "maximum"; - description?: string; - }; + amount_type?: 'fixed' | 'maximum' + description?: string + } /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: 'any' | 'automatic' }> & - Partial<"">; - }; + Partial<''> + } payment_method_types?: Partial< ( - | "ach_credit_transfer" - | "ach_debit" - | "acss_debit" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "sepa_debit" - | "sofort" - | "wechat_pay" + | 'ach_credit_transfer' + | 'ach_debit' + | 'acss_debit' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' )[] > & - Partial<"">; - }; + Partial<''> + } /** @description 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?: Partial<{ /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number }> & - Partial<"">; + Partial<''> /** @description The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. */ - promotion_code?: string; + promotion_code?: string /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -41833,26 +41550,26 @@ export interface operations { * Prorations can be disabled by passing `none`. * @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** * Format: unix-time * @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations. */ - proration_date?: number; + proration_date?: number /** @description If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. This will be unset if you POST an empty value. */ transfer_data?: Partial<{ - amount_percent?: number; - destination: string; + amount_percent?: number + destination: string }> & - Partial<"">; + Partial<''> /** @description Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. */ - trial_end?: Partial<"now"> & Partial; + trial_end?: Partial<'now'> & Partial /** @description 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?: boolean; - }; - }; - }; - }; + trial_from_plan?: boolean + } + } + } + } /** *

Cancels a customer’s subscription immediately. The customer will not be charged again for the subscription.

* @@ -41863,396 +41580,396 @@ export interface operations { DeleteSubscriptionsSubscriptionExposedId: { parameters: { path: { - subscription_exposed_id: string; - }; - }; + subscription_exposed_id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription"]; - }; - }; + 'application/json': components['schemas']['subscription'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items. */ - invoice_now?: boolean; + invoice_now?: boolean /** @description Will generate a proration invoice item that credits remaining unused time until the subscription period end. */ - prorate?: boolean; - }; - }; - }; - }; + prorate?: boolean + } + } + } + } /**

Removes the currently applied discount on a subscription.

*/ DeleteSubscriptionsSubscriptionExposedIdDiscount: { parameters: { path: { - subscription_exposed_id: string; - }; - }; + subscription_exposed_id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_discount"]; - }; - }; + 'application/json': components['schemas']['deleted_discount'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

A list of all tax codes available to add to Products in order to allow specific tax calculations.

*/ GetTaxCodes: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["tax_code"][]; + 'application/json': { + data: components['schemas']['tax_code'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves the details of an existing tax code. Supply the unique tax code ID and Stripe will return the corresponding tax code information.

*/ GetTaxCodesId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["tax_code"]; - }; - }; + 'application/json': components['schemas']['tax_code'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of your tax rates. Tax rates are returned sorted by creation date, with the most recently created tax rates appearing first.

*/ GetTaxRates: { parameters: { query: { /** Optional flag to filter by tax rates that are either active or inactive (archived). */ - active?: boolean; + active?: boolean /** Optional range for filtering created date. */ created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** Optional flag to filter by tax rates that are inclusive (or those that are not inclusive). */ - inclusive?: boolean; + inclusive?: boolean /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["tax_rate"][]; + 'application/json': { + data: components['schemas']['tax_rate'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new tax rate.

*/ PostTaxRates: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["tax_rate"]; - }; - }; + 'application/json': components['schemas']['tax_rate'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Flag determining whether the tax rate is active or inactive (archived). Inactive tax rates cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set. */ - active?: boolean; + active?: boolean /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ - country?: string; + country?: string /** @description An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. */ - description?: string; + description?: string /** @description The display name of the tax rate, which will be shown to users. */ - display_name: string; + display_name: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description This specifies if the tax rate is inclusive or exclusive. */ - inclusive: boolean; + inclusive: boolean /** @description 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?: string; + jurisdiction?: string /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description This represents the tax rate percent out of 100. */ - percentage: number; + percentage: number /** @description [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States. */ - state?: string; + state?: string /** * @description The high-level tax type, such as `vat` or `sales_tax`. * @enum {string} */ - tax_type?: "gst" | "hst" | "jct" | "pst" | "qst" | "rst" | "sales_tax" | "vat"; - }; - }; - }; - }; + tax_type?: 'gst' | 'hst' | 'jct' | 'pst' | 'qst' | 'rst' | 'sales_tax' | 'vat' + } + } + } + } /**

Retrieves a tax rate with the given ID

*/ GetTaxRatesTaxRate: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - tax_rate: string; - }; - }; + tax_rate: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["tax_rate"]; - }; - }; + 'application/json': components['schemas']['tax_rate'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates an existing tax rate.

*/ PostTaxRatesTaxRate: { parameters: { path: { - tax_rate: string; - }; - }; + tax_rate: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["tax_rate"]; - }; - }; + 'application/json': components['schemas']['tax_rate'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Flag determining whether the tax rate is active or inactive (archived). Inactive tax rates cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set. */ - active?: boolean; + active?: boolean /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ - country?: string; + country?: string /** @description An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. */ - description?: string; + description?: string /** @description The display name of the tax rate, which will be shown to users. */ - display_name?: string; + display_name?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: string; + jurisdiction?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States. */ - state?: string; + state?: string /** * @description The high-level tax type, such as `vat` or `sales_tax`. * @enum {string} */ - tax_type?: "gst" | "hst" | "jct" | "pst" | "qst" | "rst" | "sales_tax" | "vat"; - }; - }; - }; - }; + tax_type?: 'gst' | 'hst' | 'jct' | 'pst' | 'qst' | 'rst' | 'sales_tax' | 'vat' + } + } + } + } /**

To connect to a reader the Stripe Terminal SDK needs to retrieve a short-lived connection token from Stripe, proxied through your server. On your backend, add an endpoint that creates and returns a connection token.

*/ PostTerminalConnectionTokens: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["terminal.connection_token"]; - }; - }; + 'application/json': components['schemas']['terminal.connection_token'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The id of the location that this connection token is scoped to. If specified the connection token will only be usable with readers assigned to that location, otherwise the connection token will be usable with all readers. Note that location scoping only applies to internet-connected readers. For more details, see [the docs on scoping connection tokens](https://stripe.com/docs/terminal/fleet/locations#connection-tokens). */ - location?: string; - }; - }; - }; - }; + location?: string + } + } + } + } /**

Returns a list of Location objects.

*/ GetTerminalLocations: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["terminal.location"][]; + 'application/json': { + data: components['schemas']['terminal.location'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Creates a new Location object. * For further details, including which address fields are required in each country, see the Manage locations guide.

@@ -42262,324 +41979,322 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["terminal.location"]; - }; - }; + 'application/json': components['schemas']['terminal.location'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * create_location_address_param * @description The full address of the location. */ address: { - city?: string; - country: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** @description A name for the location. */ - display_name: string; + display_name: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Retrieves a Location object.

*/ GetTerminalLocationsLocation: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - location: string; - }; - }; + location: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["terminal.location"]; - }; - }; + 'application/json': components['schemas']['terminal.location'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates a Location object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ PostTerminalLocationsLocation: { parameters: { path: { - location: string; - }; - }; + location: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["terminal.location"]; - }; - }; + 'application/json': components['schemas']['terminal.location'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * optional_fields_address * @description The full address of the location. */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** @description A name for the location. */ - display_name?: string; + display_name?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Deletes a Location object.

*/ DeleteTerminalLocationsLocation: { parameters: { path: { - location: string; - }; - }; + location: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_terminal.location"]; - }; - }; + 'application/json': components['schemas']['deleted_terminal.location'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of Reader objects.

*/ GetTerminalReaders: { parameters: { query: { /** Filters readers by device type */ - device_type?: "bbpos_chipper2x" | "bbpos_wisepos_e" | "verifone_P400"; + device_type?: 'bbpos_chipper2x' | 'bbpos_wisepos_e' | 'verifone_P400' /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A location ID to filter the response list to only readers at the specific location */ - location?: string; + location?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** A status filter to filter readers to only offline or online readers */ - status?: "offline" | "online"; - }; - }; + status?: 'offline' | 'online' + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description A list of readers */ - data: components["schemas"]["terminal.reader"][]; + data: components['schemas']['terminal.reader'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new Reader object.

*/ PostTerminalReaders: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["terminal.reader"]; - }; - }; + 'application/json': components['schemas']['terminal.reader'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Custom label given to the reader for easier identification. If no label is specified, the registration code will be used. */ - label?: string; + label?: string /** @description The location to assign the reader to. */ - location?: string; + location?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description A code generated by the reader used for registering to an account. */ - registration_code: string; - }; - }; - }; - }; + registration_code: string + } + } + } + } /**

Retrieves a Reader object.

*/ GetTerminalReadersReader: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - reader: string; - }; - }; + reader: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": Partial & - Partial; - }; - }; + 'application/json': Partial & Partial + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ PostTerminalReadersReader: { parameters: { path: { - reader: string; - }; - }; + reader: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": Partial & - Partial; - }; - }; + 'application/json': Partial & Partial + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The new label of the reader. */ - label?: string; + label?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Deletes a Reader object.

*/ DeleteTerminalReadersReader: { parameters: { path: { - reader: string; - }; - }; + reader: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_terminal.reader"]; - }; - }; + 'application/json': components['schemas']['deleted_terminal.reader'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Creates a single-use token that represents a bank account’s details. * This token can be used with any API method in place of a bank account dictionary. This token can be used only once, by attaching it to a Custom account.

@@ -42589,218 +42304,218 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["token"]; - }; - }; + 'application/json': components['schemas']['token'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * connect_js_account_token_specs * @description Information for the account this token will represent. */ account?: { /** @enum {string} */ - business_type?: "company" | "government_entity" | "individual" | "non_profit"; + business_type?: 'company' | 'government_entity' | 'individual' | 'non_profit' /** connect_js_account_token_company_specs */ company?: { /** address_specs */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** japan_address_kana_specs */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** japan_address_kanji_specs */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; - directors_provided?: boolean; - executives_provided?: boolean; - name?: string; - name_kana?: string; - name_kanji?: string; - owners_provided?: boolean; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } + directors_provided?: boolean + executives_provided?: boolean + name?: string + name_kana?: string + name_kanji?: string + owners_provided?: boolean /** company_ownership_declaration */ ownership_declaration?: { /** Format: unix-time */ - date?: number; - ip?: string; - user_agent?: string; - }; - ownership_declaration_shown_and_signed?: boolean; - phone?: string; - registration_number?: string; + date?: number + ip?: string + user_agent?: string + } + ownership_declaration_shown_and_signed?: boolean + phone?: string + registration_number?: string /** @enum {string} */ structure?: - | "" - | "free_zone_establishment" - | "free_zone_llc" - | "government_instrumentality" - | "governmental_unit" - | "incorporated_non_profit" - | "limited_liability_partnership" - | "llc" - | "multi_member_llc" - | "private_company" - | "private_corporation" - | "private_partnership" - | "public_company" - | "public_corporation" - | "public_partnership" - | "single_member_llc" - | "sole_establishment" - | "sole_proprietorship" - | "tax_exempt_government_instrumentality" - | "unincorporated_association" - | "unincorporated_non_profit"; - tax_id?: string; - tax_id_registrar?: string; - vat_id?: string; + | '' + | 'free_zone_establishment' + | 'free_zone_llc' + | 'government_instrumentality' + | 'governmental_unit' + | 'incorporated_non_profit' + | 'limited_liability_partnership' + | 'llc' + | 'multi_member_llc' + | 'private_company' + | 'private_corporation' + | 'private_partnership' + | 'public_company' + | 'public_corporation' + | 'public_partnership' + | 'single_member_llc' + | 'sole_establishment' + | 'sole_proprietorship' + | 'tax_exempt_government_instrumentality' + | 'unincorporated_association' + | 'unincorporated_non_profit' + tax_id?: string + tax_id_registrar?: string + vat_id?: string /** verification_specs */ verification?: { /** verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; + back?: string + front?: string + } + } + } /** individual_specs */ individual?: { /** address_specs */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** japan_address_kana_specs */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** japan_address_kanji_specs */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } dob?: Partial<{ - day: number; - month: number; - year: number; + day: number + month: number + year: number }> & - Partial<"">; - email?: string; - first_name?: string; - first_name_kana?: string; - first_name_kanji?: string; - full_name_aliases?: Partial & Partial<"">; - gender?: string; - id_number?: string; - last_name?: string; - last_name_kana?: string; - last_name_kanji?: string; - maiden_name?: string; - metadata?: Partial<{ [key: string]: string }> & Partial<"">; - phone?: string; + Partial<''> + email?: string + first_name?: string + first_name_kana?: string + first_name_kanji?: string + full_name_aliases?: Partial & Partial<''> + gender?: string + id_number?: string + last_name?: string + last_name_kana?: string + last_name_kanji?: string + maiden_name?: string + metadata?: Partial<{ [key: string]: string }> & Partial<''> + phone?: string /** @enum {string} */ - political_exposure?: "existing" | "none"; - ssn_last_4?: string; + political_exposure?: 'existing' | 'none' + ssn_last_4?: string /** person_verification_specs */ verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; - tos_shown_and_accepted?: boolean; - }; + back?: string + front?: string + } + } + } + tos_shown_and_accepted?: boolean + } /** * token_create_bank_account * @description The bank account this token will represent. */ bank_account?: { - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; + account_holder_type?: 'company' | 'individual' + account_number: string /** @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; - country: string; - currency?: string; - routing_number?: string; - }; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' + country: string + currency?: string + routing_number?: string + } card?: Partial<{ - address_city?: string; - address_country?: string; - address_line1?: string; - address_line2?: string; - address_state?: string; - address_zip?: string; - currency?: string; - cvc?: string; - exp_month: string; - exp_year: string; - name?: string; - number: string; + address_city?: string + address_country?: string + address_line1?: string + address_line2?: string + address_state?: string + address_zip?: string + currency?: string + cvc?: string + exp_month: string + exp_year: string + name?: string + number: string }> & - Partial; + Partial /** @description The customer (owned by the application's account) for which to create a token. This can be used only with an [OAuth access token](https://stripe.com/docs/connect/standard-accounts) or [Stripe-Account header](https://stripe.com/docs/connect/authentication). For more details, see [Cloning Saved Payment Methods](https://stripe.com/docs/connect/cloning-saved-payment-methods). */ - customer?: string; + customer?: string /** * cvc_params * @description The updated CVC value this token will represent. */ cvc_update?: { - cvc: string; - }; + cvc: string + } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * person_token_specs * @description Information for the person this token will represent. @@ -42808,482 +42523,482 @@ export interface operations { person?: { /** address_specs */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** japan_address_kana_specs */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** japan_address_kanji_specs */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } dob?: Partial<{ - day: number; - month: number; - year: number; + day: number + month: number + year: number }> & - Partial<"">; + Partial<''> /** person_documents_specs */ documents?: { /** documents_param */ company_authorization?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ passport?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ visa?: { - files?: string[]; - }; - }; - email?: string; - first_name?: string; - first_name_kana?: string; - first_name_kanji?: string; - full_name_aliases?: Partial & Partial<"">; - gender?: string; - id_number?: string; - last_name?: string; - last_name_kana?: string; - last_name_kanji?: string; - maiden_name?: string; - metadata?: Partial<{ [key: string]: string }> & Partial<"">; - nationality?: string; - phone?: string; - political_exposure?: string; + files?: string[] + } + } + email?: string + first_name?: string + first_name_kana?: string + first_name_kanji?: string + full_name_aliases?: Partial & Partial<''> + gender?: string + id_number?: string + last_name?: string + last_name_kana?: string + last_name_kanji?: string + maiden_name?: string + metadata?: Partial<{ [key: string]: string }> & Partial<''> + nationality?: string + phone?: string + political_exposure?: string /** relationship_specs */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - percent_ownership?: Partial & Partial<"">; - representative?: boolean; - title?: string; - }; - ssn_last_4?: string; + director?: boolean + executive?: boolean + owner?: boolean + percent_ownership?: Partial & Partial<''> + representative?: boolean + title?: string + } + ssn_last_4?: string /** person_verification_specs */ verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; + back?: string + front?: string + } + } + } /** * pii_token_specs * @description The PII this token will represent. */ pii?: { - id_number?: string; - }; - }; - }; - }; - }; + id_number?: string + } + } + } + } + } /**

Retrieves the token with the given ID.

*/ GetTokensToken: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - token: string; - }; - }; + token: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["token"]; - }; - }; + 'application/json': components['schemas']['token'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of top-ups.

*/ GetTopups: { parameters: { query: { /** A positive integer representing how much to transfer. */ amount?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** 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?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return top-ups that have the given status. One of `canceled`, `failed`, `pending` or `succeeded`. */ - status?: "canceled" | "failed" | "pending" | "succeeded"; - }; - }; + status?: 'canceled' | 'failed' | 'pending' | 'succeeded' + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["topup"][]; + 'application/json': { + data: components['schemas']['topup'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Top up the balance of an account

*/ PostTopups: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["topup"]; - }; - }; + 'application/json': components['schemas']['topup'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A positive integer representing how much to transfer. */ - amount: number; + amount: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The ID of a source to transfer funds from. For most users, this should be left unspecified which will use the bank account that was set up in the dashboard for the specified currency. In test mode, this can be a test bank token (see [Testing Top-ups](https://stripe.com/docs/connect/testing#testing-top-ups)). */ - source?: string; + source?: string /** @description Extra information about a top-up for the source's bank statement. Limited to 15 ASCII characters. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description A string that identifies this top-up as part of a group. */ - transfer_group?: string; - }; - }; - }; - }; + transfer_group?: string + } + } + } + } /**

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.

*/ GetTopupsTopup: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - topup: string; - }; - }; + topup: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["topup"]; - }; - }; + 'application/json': components['schemas']['topup'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates the metadata of a top-up. Other top-up details are not editable by design.

*/ PostTopupsTopup: { parameters: { path: { - topup: string; - }; - }; + topup: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["topup"]; - }; - }; + 'application/json': components['schemas']['topup'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Cancels a top-up. Only pending top-ups can be canceled.

*/ PostTopupsTopupCancel: { parameters: { path: { - topup: string; - }; - }; + topup: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["topup"]; - }; - }; + 'application/json': components['schemas']['topup'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

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.

*/ GetTransfers: { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** Only return transfers for the destination specified by this account ID. */ - destination?: string; + destination?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return transfers with the specified transfer group. */ - transfer_group?: string; - }; - }; + transfer_group?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["transfer"][]; + data: components['schemas']['transfer'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostTransfers: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["transfer"]; - }; - }; + 'application/json': components['schemas']['transfer'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A positive integer in %s representing how much to transfer. */ - amount?: number; + amount?: number /** @description 3-letter [ISO code for currency](https://stripe.com/docs/payouts). */ - currency: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description The ID of a connected Stripe account. See the Connect documentation for details. */ - destination: string; + destination: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description You can use this parameter to transfer funds from a charge before they are added to your available balance. A pending balance will transfer immediately but the funds will not become available until the original charge becomes available. [See the Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-availability) for details. */ - source_transaction?: string; + source_transaction?: string /** * @description The source balance to use for this transfer. One of `bank_account`, `card`, or `fpx`. For most users, this will default to `card`. * @enum {string} */ - source_type?: "bank_account" | "card" | "fpx"; + source_type?: 'bank_account' | 'card' | 'fpx' /** @description A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-options) for details. */ - transfer_group?: string; - }; - }; - }; - }; + transfer_group?: string + } + } + } + } /**

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.

*/ GetTransfersIdReversals: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["transfer_reversal"][]; + data: components['schemas']['transfer_reversal'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

When you create a new reversal, you must specify a transfer to create it on.

* @@ -43294,71 +43009,71 @@ export interface operations { PostTransfersIdReversals: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["transfer_reversal"]; - }; - }; + 'application/json': components['schemas']['transfer_reversal'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A positive integer in %s representing how much of this transfer to reverse. Can only reverse up to the unreversed amount remaining of the transfer. Partial transfer reversals are only allowed for transfers to Stripe Accounts. Defaults to the entire transfer amount. */ - amount?: number; + amount?: number /** @description An arbitrary string which you can attach to a reversal object. It is displayed alongside the reversal in the Dashboard. This will be unset if you POST an empty value. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Boolean indicating whether the application fee should be refunded when reversing this transfer. If a full transfer reversal is given, the full application fee will be refunded. Otherwise, the application fee will be refunded with an amount proportional to the amount of the transfer reversed. */ - refund_application_fee?: boolean; - }; - }; - }; - }; + refund_application_fee?: boolean + } + } + } + } /**

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.

*/ GetTransfersTransfer: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - transfer: string; - }; - }; + transfer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["transfer"]; - }; - }; + 'application/json': components['schemas']['transfer'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates the specified transfer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

* @@ -43367,68 +43082,68 @@ export interface operations { PostTransfersTransfer: { parameters: { path: { - transfer: string; - }; - }; + transfer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["transfer"]; - }; - }; + 'application/json': components['schemas']['transfer'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

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.

*/ GetTransfersTransferReversalsId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - transfer: string; - }; - }; + id: string + transfer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["transfer_reversal"]; - }; - }; + 'application/json': components['schemas']['transfer_reversal'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates the specified reversal by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

* @@ -43437,676 +43152,676 @@ export interface operations { PostTransfersTransferReversalsId: { parameters: { path: { - id: string; - transfer: string; - }; - }; + id: string + transfer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["transfer_reversal"]; - }; - }; + 'application/json': components['schemas']['transfer_reversal'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Returns a list of your webhook endpoints.

*/ GetWebhookEndpoints: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["webhook_endpoint"][]; + 'application/json': { + data: components['schemas']['webhook_endpoint'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostWebhookEndpoints: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["webhook_endpoint"]; - }; - }; + 'application/json': components['schemas']['webhook_endpoint'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * @description Events sent to this endpoint will be generated with this Stripe Version instead of your account's default Stripe Version. * @enum {string} */ api_version?: - | "2011-01-01" - | "2011-06-21" - | "2011-06-28" - | "2011-08-01" - | "2011-09-15" - | "2011-11-17" - | "2012-02-23" - | "2012-03-25" - | "2012-06-18" - | "2012-06-28" - | "2012-07-09" - | "2012-09-24" - | "2012-10-26" - | "2012-11-07" - | "2013-02-11" - | "2013-02-13" - | "2013-07-05" - | "2013-08-12" - | "2013-08-13" - | "2013-10-29" - | "2013-12-03" - | "2014-01-31" - | "2014-03-13" - | "2014-03-28" - | "2014-05-19" - | "2014-06-13" - | "2014-06-17" - | "2014-07-22" - | "2014-07-26" - | "2014-08-04" - | "2014-08-20" - | "2014-09-08" - | "2014-10-07" - | "2014-11-05" - | "2014-11-20" - | "2014-12-08" - | "2014-12-17" - | "2014-12-22" - | "2015-01-11" - | "2015-01-26" - | "2015-02-10" - | "2015-02-16" - | "2015-02-18" - | "2015-03-24" - | "2015-04-07" - | "2015-06-15" - | "2015-07-07" - | "2015-07-13" - | "2015-07-28" - | "2015-08-07" - | "2015-08-19" - | "2015-09-03" - | "2015-09-08" - | "2015-09-23" - | "2015-10-01" - | "2015-10-12" - | "2015-10-16" - | "2016-02-03" - | "2016-02-19" - | "2016-02-22" - | "2016-02-23" - | "2016-02-29" - | "2016-03-07" - | "2016-06-15" - | "2016-07-06" - | "2016-10-19" - | "2017-01-27" - | "2017-02-14" - | "2017-04-06" - | "2017-05-25" - | "2017-06-05" - | "2017-08-15" - | "2017-12-14" - | "2018-01-23" - | "2018-02-05" - | "2018-02-06" - | "2018-02-28" - | "2018-05-21" - | "2018-07-27" - | "2018-08-23" - | "2018-09-06" - | "2018-09-24" - | "2018-10-31" - | "2018-11-08" - | "2019-02-11" - | "2019-02-19" - | "2019-03-14" - | "2019-05-16" - | "2019-08-14" - | "2019-09-09" - | "2019-10-08" - | "2019-10-17" - | "2019-11-05" - | "2019-12-03" - | "2020-03-02" - | "2020-08-27"; + | '2011-01-01' + | '2011-06-21' + | '2011-06-28' + | '2011-08-01' + | '2011-09-15' + | '2011-11-17' + | '2012-02-23' + | '2012-03-25' + | '2012-06-18' + | '2012-06-28' + | '2012-07-09' + | '2012-09-24' + | '2012-10-26' + | '2012-11-07' + | '2013-02-11' + | '2013-02-13' + | '2013-07-05' + | '2013-08-12' + | '2013-08-13' + | '2013-10-29' + | '2013-12-03' + | '2014-01-31' + | '2014-03-13' + | '2014-03-28' + | '2014-05-19' + | '2014-06-13' + | '2014-06-17' + | '2014-07-22' + | '2014-07-26' + | '2014-08-04' + | '2014-08-20' + | '2014-09-08' + | '2014-10-07' + | '2014-11-05' + | '2014-11-20' + | '2014-12-08' + | '2014-12-17' + | '2014-12-22' + | '2015-01-11' + | '2015-01-26' + | '2015-02-10' + | '2015-02-16' + | '2015-02-18' + | '2015-03-24' + | '2015-04-07' + | '2015-06-15' + | '2015-07-07' + | '2015-07-13' + | '2015-07-28' + | '2015-08-07' + | '2015-08-19' + | '2015-09-03' + | '2015-09-08' + | '2015-09-23' + | '2015-10-01' + | '2015-10-12' + | '2015-10-16' + | '2016-02-03' + | '2016-02-19' + | '2016-02-22' + | '2016-02-23' + | '2016-02-29' + | '2016-03-07' + | '2016-06-15' + | '2016-07-06' + | '2016-10-19' + | '2017-01-27' + | '2017-02-14' + | '2017-04-06' + | '2017-05-25' + | '2017-06-05' + | '2017-08-15' + | '2017-12-14' + | '2018-01-23' + | '2018-02-05' + | '2018-02-06' + | '2018-02-28' + | '2018-05-21' + | '2018-07-27' + | '2018-08-23' + | '2018-09-06' + | '2018-09-24' + | '2018-10-31' + | '2018-11-08' + | '2019-02-11' + | '2019-02-19' + | '2019-03-14' + | '2019-05-16' + | '2019-08-14' + | '2019-09-09' + | '2019-10-08' + | '2019-10-17' + | '2019-11-05' + | '2019-12-03' + | '2020-03-02' + | '2020-08-27' /** @description Whether this endpoint should receive events from connected accounts (`true`), or from your account (`false`). Defaults to `false`. */ - connect?: boolean; + connect?: boolean /** @description An optional description of what the webhook is used for. */ - description?: string; + description?: string /** @description The list of events to enable for this endpoint. You may specify `['*']` to enable all events, except those that require explicit selection. */ enabled_events: ( - | "*" - | "account.application.authorized" - | "account.application.deauthorized" - | "account.external_account.created" - | "account.external_account.deleted" - | "account.external_account.updated" - | "account.updated" - | "application_fee.created" - | "application_fee.refund.updated" - | "application_fee.refunded" - | "balance.available" - | "billing_portal.configuration.created" - | "billing_portal.configuration.updated" - | "capability.updated" - | "charge.captured" - | "charge.dispute.closed" - | "charge.dispute.created" - | "charge.dispute.funds_reinstated" - | "charge.dispute.funds_withdrawn" - | "charge.dispute.updated" - | "charge.expired" - | "charge.failed" - | "charge.pending" - | "charge.refund.updated" - | "charge.refunded" - | "charge.succeeded" - | "charge.updated" - | "checkout.session.async_payment_failed" - | "checkout.session.async_payment_succeeded" - | "checkout.session.completed" - | "checkout.session.expired" - | "coupon.created" - | "coupon.deleted" - | "coupon.updated" - | "credit_note.created" - | "credit_note.updated" - | "credit_note.voided" - | "customer.created" - | "customer.deleted" - | "customer.discount.created" - | "customer.discount.deleted" - | "customer.discount.updated" - | "customer.source.created" - | "customer.source.deleted" - | "customer.source.expiring" - | "customer.source.updated" - | "customer.subscription.created" - | "customer.subscription.deleted" - | "customer.subscription.pending_update_applied" - | "customer.subscription.pending_update_expired" - | "customer.subscription.trial_will_end" - | "customer.subscription.updated" - | "customer.tax_id.created" - | "customer.tax_id.deleted" - | "customer.tax_id.updated" - | "customer.updated" - | "file.created" - | "identity.verification_session.canceled" - | "identity.verification_session.created" - | "identity.verification_session.processing" - | "identity.verification_session.redacted" - | "identity.verification_session.requires_input" - | "identity.verification_session.verified" - | "invoice.created" - | "invoice.deleted" - | "invoice.finalization_failed" - | "invoice.finalized" - | "invoice.marked_uncollectible" - | "invoice.paid" - | "invoice.payment_action_required" - | "invoice.payment_failed" - | "invoice.payment_succeeded" - | "invoice.sent" - | "invoice.upcoming" - | "invoice.updated" - | "invoice.voided" - | "invoiceitem.created" - | "invoiceitem.deleted" - | "invoiceitem.updated" - | "issuing_authorization.created" - | "issuing_authorization.request" - | "issuing_authorization.updated" - | "issuing_card.created" - | "issuing_card.updated" - | "issuing_cardholder.created" - | "issuing_cardholder.updated" - | "issuing_dispute.closed" - | "issuing_dispute.created" - | "issuing_dispute.funds_reinstated" - | "issuing_dispute.submitted" - | "issuing_dispute.updated" - | "issuing_transaction.created" - | "issuing_transaction.updated" - | "mandate.updated" - | "order.created" - | "order.payment_failed" - | "order.payment_succeeded" - | "order.updated" - | "order_return.created" - | "payment_intent.amount_capturable_updated" - | "payment_intent.canceled" - | "payment_intent.created" - | "payment_intent.payment_failed" - | "payment_intent.processing" - | "payment_intent.requires_action" - | "payment_intent.succeeded" - | "payment_link.created" - | "payment_link.updated" - | "payment_method.attached" - | "payment_method.automatically_updated" - | "payment_method.detached" - | "payment_method.updated" - | "payout.canceled" - | "payout.created" - | "payout.failed" - | "payout.paid" - | "payout.updated" - | "person.created" - | "person.deleted" - | "person.updated" - | "plan.created" - | "plan.deleted" - | "plan.updated" - | "price.created" - | "price.deleted" - | "price.updated" - | "product.created" - | "product.deleted" - | "product.updated" - | "promotion_code.created" - | "promotion_code.updated" - | "quote.accepted" - | "quote.canceled" - | "quote.created" - | "quote.finalized" - | "radar.early_fraud_warning.created" - | "radar.early_fraud_warning.updated" - | "recipient.created" - | "recipient.deleted" - | "recipient.updated" - | "reporting.report_run.failed" - | "reporting.report_run.succeeded" - | "reporting.report_type.updated" - | "review.closed" - | "review.opened" - | "setup_intent.canceled" - | "setup_intent.created" - | "setup_intent.requires_action" - | "setup_intent.setup_failed" - | "setup_intent.succeeded" - | "sigma.scheduled_query_run.created" - | "sku.created" - | "sku.deleted" - | "sku.updated" - | "source.canceled" - | "source.chargeable" - | "source.failed" - | "source.mandate_notification" - | "source.refund_attributes_required" - | "source.transaction.created" - | "source.transaction.updated" - | "subscription_schedule.aborted" - | "subscription_schedule.canceled" - | "subscription_schedule.completed" - | "subscription_schedule.created" - | "subscription_schedule.expiring" - | "subscription_schedule.released" - | "subscription_schedule.updated" - | "tax_rate.created" - | "tax_rate.updated" - | "topup.canceled" - | "topup.created" - | "topup.failed" - | "topup.reversed" - | "topup.succeeded" - | "transfer.created" - | "transfer.failed" - | "transfer.paid" - | "transfer.reversed" - | "transfer.updated" - )[]; + | '*' + | 'account.application.authorized' + | 'account.application.deauthorized' + | 'account.external_account.created' + | 'account.external_account.deleted' + | 'account.external_account.updated' + | 'account.updated' + | 'application_fee.created' + | 'application_fee.refund.updated' + | 'application_fee.refunded' + | 'balance.available' + | 'billing_portal.configuration.created' + | 'billing_portal.configuration.updated' + | 'capability.updated' + | 'charge.captured' + | 'charge.dispute.closed' + | 'charge.dispute.created' + | 'charge.dispute.funds_reinstated' + | 'charge.dispute.funds_withdrawn' + | 'charge.dispute.updated' + | 'charge.expired' + | 'charge.failed' + | 'charge.pending' + | 'charge.refund.updated' + | 'charge.refunded' + | 'charge.succeeded' + | 'charge.updated' + | 'checkout.session.async_payment_failed' + | 'checkout.session.async_payment_succeeded' + | 'checkout.session.completed' + | 'checkout.session.expired' + | 'coupon.created' + | 'coupon.deleted' + | 'coupon.updated' + | 'credit_note.created' + | 'credit_note.updated' + | 'credit_note.voided' + | 'customer.created' + | 'customer.deleted' + | 'customer.discount.created' + | 'customer.discount.deleted' + | 'customer.discount.updated' + | 'customer.source.created' + | 'customer.source.deleted' + | 'customer.source.expiring' + | 'customer.source.updated' + | 'customer.subscription.created' + | 'customer.subscription.deleted' + | 'customer.subscription.pending_update_applied' + | 'customer.subscription.pending_update_expired' + | 'customer.subscription.trial_will_end' + | 'customer.subscription.updated' + | 'customer.tax_id.created' + | 'customer.tax_id.deleted' + | 'customer.tax_id.updated' + | 'customer.updated' + | 'file.created' + | 'identity.verification_session.canceled' + | 'identity.verification_session.created' + | 'identity.verification_session.processing' + | 'identity.verification_session.redacted' + | 'identity.verification_session.requires_input' + | 'identity.verification_session.verified' + | 'invoice.created' + | 'invoice.deleted' + | 'invoice.finalization_failed' + | 'invoice.finalized' + | 'invoice.marked_uncollectible' + | 'invoice.paid' + | 'invoice.payment_action_required' + | 'invoice.payment_failed' + | 'invoice.payment_succeeded' + | 'invoice.sent' + | 'invoice.upcoming' + | 'invoice.updated' + | 'invoice.voided' + | 'invoiceitem.created' + | 'invoiceitem.deleted' + | 'invoiceitem.updated' + | 'issuing_authorization.created' + | 'issuing_authorization.request' + | 'issuing_authorization.updated' + | 'issuing_card.created' + | 'issuing_card.updated' + | 'issuing_cardholder.created' + | 'issuing_cardholder.updated' + | 'issuing_dispute.closed' + | 'issuing_dispute.created' + | 'issuing_dispute.funds_reinstated' + | 'issuing_dispute.submitted' + | 'issuing_dispute.updated' + | 'issuing_transaction.created' + | 'issuing_transaction.updated' + | 'mandate.updated' + | 'order.created' + | 'order.payment_failed' + | 'order.payment_succeeded' + | 'order.updated' + | 'order_return.created' + | 'payment_intent.amount_capturable_updated' + | 'payment_intent.canceled' + | 'payment_intent.created' + | 'payment_intent.payment_failed' + | 'payment_intent.processing' + | 'payment_intent.requires_action' + | 'payment_intent.succeeded' + | 'payment_link.created' + | 'payment_link.updated' + | 'payment_method.attached' + | 'payment_method.automatically_updated' + | 'payment_method.detached' + | 'payment_method.updated' + | 'payout.canceled' + | 'payout.created' + | 'payout.failed' + | 'payout.paid' + | 'payout.updated' + | 'person.created' + | 'person.deleted' + | 'person.updated' + | 'plan.created' + | 'plan.deleted' + | 'plan.updated' + | 'price.created' + | 'price.deleted' + | 'price.updated' + | 'product.created' + | 'product.deleted' + | 'product.updated' + | 'promotion_code.created' + | 'promotion_code.updated' + | 'quote.accepted' + | 'quote.canceled' + | 'quote.created' + | 'quote.finalized' + | 'radar.early_fraud_warning.created' + | 'radar.early_fraud_warning.updated' + | 'recipient.created' + | 'recipient.deleted' + | 'recipient.updated' + | 'reporting.report_run.failed' + | 'reporting.report_run.succeeded' + | 'reporting.report_type.updated' + | 'review.closed' + | 'review.opened' + | 'setup_intent.canceled' + | 'setup_intent.created' + | 'setup_intent.requires_action' + | 'setup_intent.setup_failed' + | 'setup_intent.succeeded' + | 'sigma.scheduled_query_run.created' + | 'sku.created' + | 'sku.deleted' + | 'sku.updated' + | 'source.canceled' + | 'source.chargeable' + | 'source.failed' + | 'source.mandate_notification' + | 'source.refund_attributes_required' + | 'source.transaction.created' + | 'source.transaction.updated' + | 'subscription_schedule.aborted' + | 'subscription_schedule.canceled' + | 'subscription_schedule.completed' + | 'subscription_schedule.created' + | 'subscription_schedule.expiring' + | 'subscription_schedule.released' + | 'subscription_schedule.updated' + | 'tax_rate.created' + | 'tax_rate.updated' + | 'topup.canceled' + | 'topup.created' + | 'topup.failed' + | 'topup.reversed' + | 'topup.succeeded' + | 'transfer.created' + | 'transfer.failed' + | 'transfer.paid' + | 'transfer.reversed' + | 'transfer.updated' + )[] /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The URL of the webhook endpoint. */ - url: string; - }; - }; - }; - }; + url: string + } + } + } + } /**

Retrieves the webhook endpoint with the given ID.

*/ GetWebhookEndpointsWebhookEndpoint: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - webhook_endpoint: string; - }; - }; + webhook_endpoint: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["webhook_endpoint"]; - }; - }; + 'application/json': components['schemas']['webhook_endpoint'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.

*/ PostWebhookEndpointsWebhookEndpoint: { parameters: { path: { - webhook_endpoint: string; - }; - }; + webhook_endpoint: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["webhook_endpoint"]; - }; - }; + 'application/json': components['schemas']['webhook_endpoint'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description An optional description of what the webhook is used for. */ - description?: string; + description?: string /** @description Disable the webhook endpoint if set to true. */ - disabled?: boolean; + disabled?: boolean /** @description The list of events to enable for this endpoint. You may specify `['*']` to enable all events, except those that require explicit selection. */ enabled_events?: ( - | "*" - | "account.application.authorized" - | "account.application.deauthorized" - | "account.external_account.created" - | "account.external_account.deleted" - | "account.external_account.updated" - | "account.updated" - | "application_fee.created" - | "application_fee.refund.updated" - | "application_fee.refunded" - | "balance.available" - | "billing_portal.configuration.created" - | "billing_portal.configuration.updated" - | "capability.updated" - | "charge.captured" - | "charge.dispute.closed" - | "charge.dispute.created" - | "charge.dispute.funds_reinstated" - | "charge.dispute.funds_withdrawn" - | "charge.dispute.updated" - | "charge.expired" - | "charge.failed" - | "charge.pending" - | "charge.refund.updated" - | "charge.refunded" - | "charge.succeeded" - | "charge.updated" - | "checkout.session.async_payment_failed" - | "checkout.session.async_payment_succeeded" - | "checkout.session.completed" - | "checkout.session.expired" - | "coupon.created" - | "coupon.deleted" - | "coupon.updated" - | "credit_note.created" - | "credit_note.updated" - | "credit_note.voided" - | "customer.created" - | "customer.deleted" - | "customer.discount.created" - | "customer.discount.deleted" - | "customer.discount.updated" - | "customer.source.created" - | "customer.source.deleted" - | "customer.source.expiring" - | "customer.source.updated" - | "customer.subscription.created" - | "customer.subscription.deleted" - | "customer.subscription.pending_update_applied" - | "customer.subscription.pending_update_expired" - | "customer.subscription.trial_will_end" - | "customer.subscription.updated" - | "customer.tax_id.created" - | "customer.tax_id.deleted" - | "customer.tax_id.updated" - | "customer.updated" - | "file.created" - | "identity.verification_session.canceled" - | "identity.verification_session.created" - | "identity.verification_session.processing" - | "identity.verification_session.redacted" - | "identity.verification_session.requires_input" - | "identity.verification_session.verified" - | "invoice.created" - | "invoice.deleted" - | "invoice.finalization_failed" - | "invoice.finalized" - | "invoice.marked_uncollectible" - | "invoice.paid" - | "invoice.payment_action_required" - | "invoice.payment_failed" - | "invoice.payment_succeeded" - | "invoice.sent" - | "invoice.upcoming" - | "invoice.updated" - | "invoice.voided" - | "invoiceitem.created" - | "invoiceitem.deleted" - | "invoiceitem.updated" - | "issuing_authorization.created" - | "issuing_authorization.request" - | "issuing_authorization.updated" - | "issuing_card.created" - | "issuing_card.updated" - | "issuing_cardholder.created" - | "issuing_cardholder.updated" - | "issuing_dispute.closed" - | "issuing_dispute.created" - | "issuing_dispute.funds_reinstated" - | "issuing_dispute.submitted" - | "issuing_dispute.updated" - | "issuing_transaction.created" - | "issuing_transaction.updated" - | "mandate.updated" - | "order.created" - | "order.payment_failed" - | "order.payment_succeeded" - | "order.updated" - | "order_return.created" - | "payment_intent.amount_capturable_updated" - | "payment_intent.canceled" - | "payment_intent.created" - | "payment_intent.payment_failed" - | "payment_intent.processing" - | "payment_intent.requires_action" - | "payment_intent.succeeded" - | "payment_link.created" - | "payment_link.updated" - | "payment_method.attached" - | "payment_method.automatically_updated" - | "payment_method.detached" - | "payment_method.updated" - | "payout.canceled" - | "payout.created" - | "payout.failed" - | "payout.paid" - | "payout.updated" - | "person.created" - | "person.deleted" - | "person.updated" - | "plan.created" - | "plan.deleted" - | "plan.updated" - | "price.created" - | "price.deleted" - | "price.updated" - | "product.created" - | "product.deleted" - | "product.updated" - | "promotion_code.created" - | "promotion_code.updated" - | "quote.accepted" - | "quote.canceled" - | "quote.created" - | "quote.finalized" - | "radar.early_fraud_warning.created" - | "radar.early_fraud_warning.updated" - | "recipient.created" - | "recipient.deleted" - | "recipient.updated" - | "reporting.report_run.failed" - | "reporting.report_run.succeeded" - | "reporting.report_type.updated" - | "review.closed" - | "review.opened" - | "setup_intent.canceled" - | "setup_intent.created" - | "setup_intent.requires_action" - | "setup_intent.setup_failed" - | "setup_intent.succeeded" - | "sigma.scheduled_query_run.created" - | "sku.created" - | "sku.deleted" - | "sku.updated" - | "source.canceled" - | "source.chargeable" - | "source.failed" - | "source.mandate_notification" - | "source.refund_attributes_required" - | "source.transaction.created" - | "source.transaction.updated" - | "subscription_schedule.aborted" - | "subscription_schedule.canceled" - | "subscription_schedule.completed" - | "subscription_schedule.created" - | "subscription_schedule.expiring" - | "subscription_schedule.released" - | "subscription_schedule.updated" - | "tax_rate.created" - | "tax_rate.updated" - | "topup.canceled" - | "topup.created" - | "topup.failed" - | "topup.reversed" - | "topup.succeeded" - | "transfer.created" - | "transfer.failed" - | "transfer.paid" - | "transfer.reversed" - | "transfer.updated" - )[]; + | '*' + | 'account.application.authorized' + | 'account.application.deauthorized' + | 'account.external_account.created' + | 'account.external_account.deleted' + | 'account.external_account.updated' + | 'account.updated' + | 'application_fee.created' + | 'application_fee.refund.updated' + | 'application_fee.refunded' + | 'balance.available' + | 'billing_portal.configuration.created' + | 'billing_portal.configuration.updated' + | 'capability.updated' + | 'charge.captured' + | 'charge.dispute.closed' + | 'charge.dispute.created' + | 'charge.dispute.funds_reinstated' + | 'charge.dispute.funds_withdrawn' + | 'charge.dispute.updated' + | 'charge.expired' + | 'charge.failed' + | 'charge.pending' + | 'charge.refund.updated' + | 'charge.refunded' + | 'charge.succeeded' + | 'charge.updated' + | 'checkout.session.async_payment_failed' + | 'checkout.session.async_payment_succeeded' + | 'checkout.session.completed' + | 'checkout.session.expired' + | 'coupon.created' + | 'coupon.deleted' + | 'coupon.updated' + | 'credit_note.created' + | 'credit_note.updated' + | 'credit_note.voided' + | 'customer.created' + | 'customer.deleted' + | 'customer.discount.created' + | 'customer.discount.deleted' + | 'customer.discount.updated' + | 'customer.source.created' + | 'customer.source.deleted' + | 'customer.source.expiring' + | 'customer.source.updated' + | 'customer.subscription.created' + | 'customer.subscription.deleted' + | 'customer.subscription.pending_update_applied' + | 'customer.subscription.pending_update_expired' + | 'customer.subscription.trial_will_end' + | 'customer.subscription.updated' + | 'customer.tax_id.created' + | 'customer.tax_id.deleted' + | 'customer.tax_id.updated' + | 'customer.updated' + | 'file.created' + | 'identity.verification_session.canceled' + | 'identity.verification_session.created' + | 'identity.verification_session.processing' + | 'identity.verification_session.redacted' + | 'identity.verification_session.requires_input' + | 'identity.verification_session.verified' + | 'invoice.created' + | 'invoice.deleted' + | 'invoice.finalization_failed' + | 'invoice.finalized' + | 'invoice.marked_uncollectible' + | 'invoice.paid' + | 'invoice.payment_action_required' + | 'invoice.payment_failed' + | 'invoice.payment_succeeded' + | 'invoice.sent' + | 'invoice.upcoming' + | 'invoice.updated' + | 'invoice.voided' + | 'invoiceitem.created' + | 'invoiceitem.deleted' + | 'invoiceitem.updated' + | 'issuing_authorization.created' + | 'issuing_authorization.request' + | 'issuing_authorization.updated' + | 'issuing_card.created' + | 'issuing_card.updated' + | 'issuing_cardholder.created' + | 'issuing_cardholder.updated' + | 'issuing_dispute.closed' + | 'issuing_dispute.created' + | 'issuing_dispute.funds_reinstated' + | 'issuing_dispute.submitted' + | 'issuing_dispute.updated' + | 'issuing_transaction.created' + | 'issuing_transaction.updated' + | 'mandate.updated' + | 'order.created' + | 'order.payment_failed' + | 'order.payment_succeeded' + | 'order.updated' + | 'order_return.created' + | 'payment_intent.amount_capturable_updated' + | 'payment_intent.canceled' + | 'payment_intent.created' + | 'payment_intent.payment_failed' + | 'payment_intent.processing' + | 'payment_intent.requires_action' + | 'payment_intent.succeeded' + | 'payment_link.created' + | 'payment_link.updated' + | 'payment_method.attached' + | 'payment_method.automatically_updated' + | 'payment_method.detached' + | 'payment_method.updated' + | 'payout.canceled' + | 'payout.created' + | 'payout.failed' + | 'payout.paid' + | 'payout.updated' + | 'person.created' + | 'person.deleted' + | 'person.updated' + | 'plan.created' + | 'plan.deleted' + | 'plan.updated' + | 'price.created' + | 'price.deleted' + | 'price.updated' + | 'product.created' + | 'product.deleted' + | 'product.updated' + | 'promotion_code.created' + | 'promotion_code.updated' + | 'quote.accepted' + | 'quote.canceled' + | 'quote.created' + | 'quote.finalized' + | 'radar.early_fraud_warning.created' + | 'radar.early_fraud_warning.updated' + | 'recipient.created' + | 'recipient.deleted' + | 'recipient.updated' + | 'reporting.report_run.failed' + | 'reporting.report_run.succeeded' + | 'reporting.report_type.updated' + | 'review.closed' + | 'review.opened' + | 'setup_intent.canceled' + | 'setup_intent.created' + | 'setup_intent.requires_action' + | 'setup_intent.setup_failed' + | 'setup_intent.succeeded' + | 'sigma.scheduled_query_run.created' + | 'sku.created' + | 'sku.deleted' + | 'sku.updated' + | 'source.canceled' + | 'source.chargeable' + | 'source.failed' + | 'source.mandate_notification' + | 'source.refund_attributes_required' + | 'source.transaction.created' + | 'source.transaction.updated' + | 'subscription_schedule.aborted' + | 'subscription_schedule.canceled' + | 'subscription_schedule.completed' + | 'subscription_schedule.created' + | 'subscription_schedule.expiring' + | 'subscription_schedule.released' + | 'subscription_schedule.updated' + | 'tax_rate.created' + | 'tax_rate.updated' + | 'topup.canceled' + | 'topup.created' + | 'topup.failed' + | 'topup.reversed' + | 'topup.succeeded' + | 'transfer.created' + | 'transfer.failed' + | 'transfer.paid' + | 'transfer.reversed' + | 'transfer.updated' + )[] /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The URL of the webhook endpoint. */ - url?: string; - }; - }; - }; - }; + url?: string + } + } + } + } /**

You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.

*/ DeleteWebhookEndpointsWebhookEndpoint: { parameters: { path: { - webhook_endpoint: string; - }; - }; + webhook_endpoint: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_webhook_endpoint"]; - }; - }; + 'application/json': components['schemas']['deleted_webhook_endpoint'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } } export interface external {} diff --git a/test/v3/expected/stripe.ts b/test/v3/expected/stripe.ts index f1424b67f..bdf2c7f53 100644 --- a/test/v3/expected/stripe.ts +++ b/test/v3/expected/stripe.ts @@ -4,23 +4,23 @@ */ export interface paths { - "/v1/3d_secure": { + '/v1/3d_secure': { /**

Initiate 3D Secure authentication.

*/ - post: operations["Post3dSecure"]; - }; - "/v1/3d_secure/{three_d_secure}": { + post: operations['Post3dSecure'] + } + '/v1/3d_secure/{three_d_secure}': { /**

Retrieves a 3D Secure object.

*/ - get: operations["Get3dSecureThreeDSecure"]; - }; - "/v1/account": { + get: operations['Get3dSecureThreeDSecure'] + } + '/v1/account': { /**

Retrieves the details of an account.

*/ - get: operations["GetAccount"]; + get: operations['GetAccount'] /** *

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged. Most parameters can be changed only for Custom accounts. (These are marked Custom Only below.) Parameters marked Custom and Express are not supported for Standard accounts.

* *

To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.

*/ - post: operations["PostAccount"]; + post: operations['PostAccount'] /** *

With Connect, you can delete accounts you manage.

* @@ -28,110 +28,110 @@ export interface paths { * *

If you want to delete your own account, use the account information tab in your account settings instead.

*/ - delete: operations["DeleteAccount"]; - }; - "/v1/account/bank_accounts": { + delete: operations['DeleteAccount'] + } + '/v1/account/bank_accounts': { /**

Create an external account for a given account.

*/ - post: operations["PostAccountBankAccounts"]; - }; - "/v1/account/bank_accounts/{id}": { + post: operations['PostAccountBankAccounts'] + } + '/v1/account/bank_accounts/{id}': { /**

Retrieve a specified external account for a given account.

*/ - get: operations["GetAccountBankAccountsId"]; + get: operations['GetAccountBankAccountsId'] /** *

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

* *

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

*/ - post: operations["PostAccountBankAccountsId"]; + post: operations['PostAccountBankAccountsId'] /**

Delete a specified external account for a given account.

*/ - delete: operations["DeleteAccountBankAccountsId"]; - }; - "/v1/account/capabilities": { + delete: operations['DeleteAccountBankAccountsId'] + } + '/v1/account/capabilities': { /**

Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.

*/ - get: operations["GetAccountCapabilities"]; - }; - "/v1/account/capabilities/{capability}": { + get: operations['GetAccountCapabilities'] + } + '/v1/account/capabilities/{capability}': { /**

Retrieves information about the specified Account Capability.

*/ - get: operations["GetAccountCapabilitiesCapability"]; + get: operations['GetAccountCapabilitiesCapability'] /**

Updates an existing Account Capability.

*/ - post: operations["PostAccountCapabilitiesCapability"]; - }; - "/v1/account/external_accounts": { + post: operations['PostAccountCapabilitiesCapability'] + } + '/v1/account/external_accounts': { /**

List external accounts for an account.

*/ - get: operations["GetAccountExternalAccounts"]; + get: operations['GetAccountExternalAccounts'] /**

Create an external account for a given account.

*/ - post: operations["PostAccountExternalAccounts"]; - }; - "/v1/account/external_accounts/{id}": { + post: operations['PostAccountExternalAccounts'] + } + '/v1/account/external_accounts/{id}': { /**

Retrieve a specified external account for a given account.

*/ - get: operations["GetAccountExternalAccountsId"]; + get: operations['GetAccountExternalAccountsId'] /** *

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

* *

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

*/ - post: operations["PostAccountExternalAccountsId"]; + post: operations['PostAccountExternalAccountsId'] /**

Delete a specified external account for a given account.

*/ - delete: operations["DeleteAccountExternalAccountsId"]; - }; - "/v1/account/login_links": { + delete: operations['DeleteAccountExternalAccountsId'] + } + '/v1/account/login_links': { /** *

Creates a single-use login link for an Express account to access their Stripe dashboard.

* *

You may only create login links for Express accounts connected to your platform.

*/ - post: operations["PostAccountLoginLinks"]; - }; - "/v1/account/people": { + post: operations['PostAccountLoginLinks'] + } + '/v1/account/people': { /**

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.

*/ - get: operations["GetAccountPeople"]; + get: operations['GetAccountPeople'] /**

Creates a new person.

*/ - post: operations["PostAccountPeople"]; - }; - "/v1/account/people/{person}": { + post: operations['PostAccountPeople'] + } + '/v1/account/people/{person}': { /**

Retrieves an existing person.

*/ - get: operations["GetAccountPeoplePerson"]; + get: operations['GetAccountPeoplePerson'] /**

Updates an existing person.

*/ - post: operations["PostAccountPeoplePerson"]; + post: operations['PostAccountPeoplePerson'] /**

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.

*/ - delete: operations["DeleteAccountPeoplePerson"]; - }; - "/v1/account/persons": { + delete: operations['DeleteAccountPeoplePerson'] + } + '/v1/account/persons': { /**

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.

*/ - get: operations["GetAccountPersons"]; + get: operations['GetAccountPersons'] /**

Creates a new person.

*/ - post: operations["PostAccountPersons"]; - }; - "/v1/account/persons/{person}": { + post: operations['PostAccountPersons'] + } + '/v1/account/persons/{person}': { /**

Retrieves an existing person.

*/ - get: operations["GetAccountPersonsPerson"]; + get: operations['GetAccountPersonsPerson'] /**

Updates an existing person.

*/ - post: operations["PostAccountPersonsPerson"]; + post: operations['PostAccountPersonsPerson'] /**

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.

*/ - delete: operations["DeleteAccountPersonsPerson"]; - }; - "/v1/account_links": { + delete: operations['DeleteAccountPersonsPerson'] + } + '/v1/account_links': { /**

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.

*/ - post: operations["PostAccountLinks"]; - }; - "/v1/accounts": { + post: operations['PostAccountLinks'] + } + '/v1/accounts': { /**

Returns a list of accounts connected to your platform via Connect. If you’re not a platform, the list is empty.

*/ - get: operations["GetAccounts"]; + get: operations['GetAccounts'] /** *

With Connect, you can create Stripe accounts for your users. * To do this, you’ll first need to register your platform.

*/ - post: operations["PostAccounts"]; - }; - "/v1/accounts/{account}": { + post: operations['PostAccounts'] + } + '/v1/accounts/{account}': { /**

Retrieves the details of an account.

*/ - get: operations["GetAccountsAccount"]; + get: operations['GetAccountsAccount'] /** *

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged. Most parameters can be changed only for Custom accounts. (These are marked Custom Only below.) Parameters marked Custom and Express are not supported for Standard accounts.

* *

To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.

*/ - post: operations["PostAccountsAccount"]; + post: operations['PostAccountsAccount'] /** *

With Connect, you can delete accounts you manage.

* @@ -139,132 +139,132 @@ export interface paths { * *

If you want to delete your own account, use the account information tab in your account settings instead.

*/ - delete: operations["DeleteAccountsAccount"]; - }; - "/v1/accounts/{account}/bank_accounts": { + delete: operations['DeleteAccountsAccount'] + } + '/v1/accounts/{account}/bank_accounts': { /**

Create an external account for a given account.

*/ - post: operations["PostAccountsAccountBankAccounts"]; - }; - "/v1/accounts/{account}/bank_accounts/{id}": { + post: operations['PostAccountsAccountBankAccounts'] + } + '/v1/accounts/{account}/bank_accounts/{id}': { /**

Retrieve a specified external account for a given account.

*/ - get: operations["GetAccountsAccountBankAccountsId"]; + get: operations['GetAccountsAccountBankAccountsId'] /** *

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

* *

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

*/ - post: operations["PostAccountsAccountBankAccountsId"]; + post: operations['PostAccountsAccountBankAccountsId'] /**

Delete a specified external account for a given account.

*/ - delete: operations["DeleteAccountsAccountBankAccountsId"]; - }; - "/v1/accounts/{account}/capabilities": { + delete: operations['DeleteAccountsAccountBankAccountsId'] + } + '/v1/accounts/{account}/capabilities': { /**

Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.

*/ - get: operations["GetAccountsAccountCapabilities"]; - }; - "/v1/accounts/{account}/capabilities/{capability}": { + get: operations['GetAccountsAccountCapabilities'] + } + '/v1/accounts/{account}/capabilities/{capability}': { /**

Retrieves information about the specified Account Capability.

*/ - get: operations["GetAccountsAccountCapabilitiesCapability"]; + get: operations['GetAccountsAccountCapabilitiesCapability'] /**

Updates an existing Account Capability.

*/ - post: operations["PostAccountsAccountCapabilitiesCapability"]; - }; - "/v1/accounts/{account}/external_accounts": { + post: operations['PostAccountsAccountCapabilitiesCapability'] + } + '/v1/accounts/{account}/external_accounts': { /**

List external accounts for an account.

*/ - get: operations["GetAccountsAccountExternalAccounts"]; + get: operations['GetAccountsAccountExternalAccounts'] /**

Create an external account for a given account.

*/ - post: operations["PostAccountsAccountExternalAccounts"]; - }; - "/v1/accounts/{account}/external_accounts/{id}": { + post: operations['PostAccountsAccountExternalAccounts'] + } + '/v1/accounts/{account}/external_accounts/{id}': { /**

Retrieve a specified external account for a given account.

*/ - get: operations["GetAccountsAccountExternalAccountsId"]; + get: operations['GetAccountsAccountExternalAccountsId'] /** *

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

* *

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

*/ - post: operations["PostAccountsAccountExternalAccountsId"]; + post: operations['PostAccountsAccountExternalAccountsId'] /**

Delete a specified external account for a given account.

*/ - delete: operations["DeleteAccountsAccountExternalAccountsId"]; - }; - "/v1/accounts/{account}/login_links": { + delete: operations['DeleteAccountsAccountExternalAccountsId'] + } + '/v1/accounts/{account}/login_links': { /** *

Creates a single-use login link for an Express account to access their Stripe dashboard.

* *

You may only create login links for Express accounts connected to your platform.

*/ - post: operations["PostAccountsAccountLoginLinks"]; - }; - "/v1/accounts/{account}/people": { + post: operations['PostAccountsAccountLoginLinks'] + } + '/v1/accounts/{account}/people': { /**

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.

*/ - get: operations["GetAccountsAccountPeople"]; + get: operations['GetAccountsAccountPeople'] /**

Creates a new person.

*/ - post: operations["PostAccountsAccountPeople"]; - }; - "/v1/accounts/{account}/people/{person}": { + post: operations['PostAccountsAccountPeople'] + } + '/v1/accounts/{account}/people/{person}': { /**

Retrieves an existing person.

*/ - get: operations["GetAccountsAccountPeoplePerson"]; + get: operations['GetAccountsAccountPeoplePerson'] /**

Updates an existing person.

*/ - post: operations["PostAccountsAccountPeoplePerson"]; + post: operations['PostAccountsAccountPeoplePerson'] /**

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.

*/ - delete: operations["DeleteAccountsAccountPeoplePerson"]; - }; - "/v1/accounts/{account}/persons": { + delete: operations['DeleteAccountsAccountPeoplePerson'] + } + '/v1/accounts/{account}/persons': { /**

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.

*/ - get: operations["GetAccountsAccountPersons"]; + get: operations['GetAccountsAccountPersons'] /**

Creates a new person.

*/ - post: operations["PostAccountsAccountPersons"]; - }; - "/v1/accounts/{account}/persons/{person}": { + post: operations['PostAccountsAccountPersons'] + } + '/v1/accounts/{account}/persons/{person}': { /**

Retrieves an existing person.

*/ - get: operations["GetAccountsAccountPersonsPerson"]; + get: operations['GetAccountsAccountPersonsPerson'] /**

Updates an existing person.

*/ - post: operations["PostAccountsAccountPersonsPerson"]; + post: operations['PostAccountsAccountPersonsPerson'] /**

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.

*/ - delete: operations["DeleteAccountsAccountPersonsPerson"]; - }; - "/v1/accounts/{account}/reject": { + delete: operations['DeleteAccountsAccountPersonsPerson'] + } + '/v1/accounts/{account}/reject': { /** *

With Connect, you may flag accounts as suspicious.

* *

Test-mode Custom and Express accounts can be rejected at any time. Accounts created using live-mode keys may only be rejected once all balances are zero.

*/ - post: operations["PostAccountsAccountReject"]; - }; - "/v1/apple_pay/domains": { + post: operations['PostAccountsAccountReject'] + } + '/v1/apple_pay/domains': { /**

List apple pay domains.

*/ - get: operations["GetApplePayDomains"]; + get: operations['GetApplePayDomains'] /**

Create an apple pay domain.

*/ - post: operations["PostApplePayDomains"]; - }; - "/v1/apple_pay/domains/{domain}": { + post: operations['PostApplePayDomains'] + } + '/v1/apple_pay/domains/{domain}': { /**

Retrieve an apple pay domain.

*/ - get: operations["GetApplePayDomainsDomain"]; + get: operations['GetApplePayDomainsDomain'] /**

Delete an apple pay domain.

*/ - delete: operations["DeleteApplePayDomainsDomain"]; - }; - "/v1/application_fees": { + delete: operations['DeleteApplePayDomainsDomain'] + } + '/v1/application_fees': { /**

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.

*/ - get: operations["GetApplicationFees"]; - }; - "/v1/application_fees/{fee}/refunds/{id}": { + get: operations['GetApplicationFees'] + } + '/v1/application_fees/{fee}/refunds/{id}': { /**

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.

*/ - get: operations["GetApplicationFeesFeeRefundsId"]; + get: operations['GetApplicationFeesFeeRefundsId'] /** *

Updates the specified application fee refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

* *

This request only accepts metadata as an argument.

*/ - post: operations["PostApplicationFeesFeeRefundsId"]; - }; - "/v1/application_fees/{id}": { + post: operations['PostApplicationFeesFeeRefundsId'] + } + '/v1/application_fees/{id}': { /**

Retrieves the details of an application fee that your account has collected. The same information is returned when refunding the application fee.

*/ - get: operations["GetApplicationFeesId"]; - }; - "/v1/application_fees/{id}/refund": { - post: operations["PostApplicationFeesIdRefund"]; - }; - "/v1/application_fees/{id}/refunds": { + get: operations['GetApplicationFeesId'] + } + '/v1/application_fees/{id}/refund': { + post: operations['PostApplicationFeesIdRefund'] + } + '/v1/application_fees/{id}/refunds': { /**

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.

*/ - get: operations["GetApplicationFeesIdRefunds"]; + get: operations['GetApplicationFeesIdRefunds'] /** *

Refunds an application fee that has previously been collected but not yet refunded. * Funds will be refunded to the Stripe account from which the fee was originally collected.

@@ -276,108 +276,108 @@ export interface paths { * This method will raise an error when called on an already-refunded application fee, * or when trying to refund more money than is left on an application fee.

*/ - post: operations["PostApplicationFeesIdRefunds"]; - }; - "/v1/balance": { + post: operations['PostApplicationFeesIdRefunds'] + } + '/v1/balance': { /** *

Retrieves the current account balance, based on the authentication that was used to make the request. * For a sample request, see Accounting for negative balances.

*/ - get: operations["GetBalance"]; - }; - "/v1/balance/history": { + get: operations['GetBalance'] + } + '/v1/balance/history': { /** *

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

* *

Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.

*/ - get: operations["GetBalanceHistory"]; - }; - "/v1/balance/history/{id}": { + get: operations['GetBalanceHistory'] + } + '/v1/balance/history/{id}': { /** *

Retrieves the balance transaction with the given ID.

* *

Note that this endpoint previously used the path /v1/balance/history/:id.

*/ - get: operations["GetBalanceHistoryId"]; - }; - "/v1/balance_transactions": { + get: operations['GetBalanceHistoryId'] + } + '/v1/balance_transactions': { /** *

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

* *

Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.

*/ - get: operations["GetBalanceTransactions"]; - }; - "/v1/balance_transactions/{id}": { + get: operations['GetBalanceTransactions'] + } + '/v1/balance_transactions/{id}': { /** *

Retrieves the balance transaction with the given ID.

* *

Note that this endpoint previously used the path /v1/balance/history/:id.

*/ - get: operations["GetBalanceTransactionsId"]; - }; - "/v1/billing_portal/configurations": { + get: operations['GetBalanceTransactionsId'] + } + '/v1/billing_portal/configurations': { /**

Returns a list of configurations that describe the functionality of the customer portal.

*/ - get: operations["GetBillingPortalConfigurations"]; + get: operations['GetBillingPortalConfigurations'] /**

Creates a configuration that describes the functionality and behavior of a PortalSession

*/ - post: operations["PostBillingPortalConfigurations"]; - }; - "/v1/billing_portal/configurations/{configuration}": { + post: operations['PostBillingPortalConfigurations'] + } + '/v1/billing_portal/configurations/{configuration}': { /**

Retrieves a configuration that describes the functionality of the customer portal.

*/ - get: operations["GetBillingPortalConfigurationsConfiguration"]; + get: operations['GetBillingPortalConfigurationsConfiguration'] /**

Updates a configuration that describes the functionality of the customer portal.

*/ - post: operations["PostBillingPortalConfigurationsConfiguration"]; - }; - "/v1/billing_portal/sessions": { + post: operations['PostBillingPortalConfigurationsConfiguration'] + } + '/v1/billing_portal/sessions': { /**

Creates a session of the customer portal.

*/ - post: operations["PostBillingPortalSessions"]; - }; - "/v1/bitcoin/receivers": { + post: operations['PostBillingPortalSessions'] + } + '/v1/bitcoin/receivers': { /**

Returns a list of your receivers. Receivers are returned sorted by creation date, with the most recently created receivers appearing first.

*/ - get: operations["GetBitcoinReceivers"]; - }; - "/v1/bitcoin/receivers/{id}": { + get: operations['GetBitcoinReceivers'] + } + '/v1/bitcoin/receivers/{id}': { /**

Retrieves the Bitcoin receiver with the given ID.

*/ - get: operations["GetBitcoinReceiversId"]; - }; - "/v1/bitcoin/receivers/{receiver}/transactions": { + get: operations['GetBitcoinReceiversId'] + } + '/v1/bitcoin/receivers/{receiver}/transactions': { /**

List bitcoin transacitons for a given receiver.

*/ - get: operations["GetBitcoinReceiversReceiverTransactions"]; - }; - "/v1/bitcoin/transactions": { + get: operations['GetBitcoinReceiversReceiverTransactions'] + } + '/v1/bitcoin/transactions': { /**

List bitcoin transacitons for a given receiver.

*/ - get: operations["GetBitcoinTransactions"]; - }; - "/v1/charges": { + get: operations['GetBitcoinTransactions'] + } + '/v1/charges': { /**

Returns a list of charges you’ve previously created. The charges are returned in sorted order, with the most recent charges appearing first.

*/ - get: operations["GetCharges"]; + get: operations['GetCharges'] /**

To charge a credit card or other payment source, you create a Charge object. If your API key is in test mode, the supplied payment source (e.g., card) won’t actually be charged, although everything else will occur as if in live mode. (Stripe assumes that the charge would have completed successfully).

*/ - post: operations["PostCharges"]; - }; - "/v1/charges/{charge}": { + post: operations['PostCharges'] + } + '/v1/charges/{charge}': { /**

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.

*/ - get: operations["GetChargesCharge"]; + get: operations['GetChargesCharge'] /**

Updates the specified charge by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ - post: operations["PostChargesCharge"]; - }; - "/v1/charges/{charge}/capture": { + post: operations['PostChargesCharge'] + } + '/v1/charges/{charge}/capture': { /** *

Capture the payment of an existing, uncaptured, charge. This is the second half of the two-step payment flow, where first you created a charge with the capture option set to false.

* *

Uncaptured payments expire a set number of days after they are created (7 by default). If they are not captured by that point in time, they will be marked as refunded and will no longer be capturable.

*/ - post: operations["PostChargesChargeCapture"]; - }; - "/v1/charges/{charge}/dispute": { + post: operations['PostChargesChargeCapture'] + } + '/v1/charges/{charge}/dispute': { /**

Retrieve a dispute for a specified charge.

*/ - get: operations["GetChargesChargeDispute"]; - post: operations["PostChargesChargeDispute"]; - }; - "/v1/charges/{charge}/dispute/close": { - post: operations["PostChargesChargeDisputeClose"]; - }; - "/v1/charges/{charge}/refund": { + get: operations['GetChargesChargeDispute'] + post: operations['PostChargesChargeDispute'] + } + '/v1/charges/{charge}/dispute/close': { + post: operations['PostChargesChargeDisputeClose'] + } + '/v1/charges/{charge}/refund': { /** *

When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.

* @@ -391,71 +391,71 @@ export interface paths { * 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.

*/ - post: operations["PostChargesChargeRefund"]; - }; - "/v1/charges/{charge}/refunds": { + post: operations['PostChargesChargeRefund'] + } + '/v1/charges/{charge}/refunds': { /**

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.

*/ - get: operations["GetChargesChargeRefunds"]; + get: operations['GetChargesChargeRefunds'] /**

Create a refund.

*/ - post: operations["PostChargesChargeRefunds"]; - }; - "/v1/charges/{charge}/refunds/{refund}": { + post: operations['PostChargesChargeRefunds'] + } + '/v1/charges/{charge}/refunds/{refund}': { /**

Retrieves the details of an existing refund.

*/ - get: operations["GetChargesChargeRefundsRefund"]; + get: operations['GetChargesChargeRefundsRefund'] /**

Update a specified refund.

*/ - post: operations["PostChargesChargeRefundsRefund"]; - }; - "/v1/checkout/sessions": { + post: operations['PostChargesChargeRefundsRefund'] + } + '/v1/checkout/sessions': { /**

Returns a list of Checkout Sessions.

*/ - get: operations["GetCheckoutSessions"]; + get: operations['GetCheckoutSessions'] /**

Creates a Session object.

*/ - post: operations["PostCheckoutSessions"]; - }; - "/v1/checkout/sessions/{session}": { + post: operations['PostCheckoutSessions'] + } + '/v1/checkout/sessions/{session}': { /**

Retrieves a Session object.

*/ - get: operations["GetCheckoutSessionsSession"]; - }; - "/v1/checkout/sessions/{session}/expire": { + get: operations['GetCheckoutSessionsSession'] + } + '/v1/checkout/sessions/{session}/expire': { /** *

A Session can be expired when it is in one of these statuses: open

* *

After it expires, a customer can’t complete a Session and customers loading the Session see a message saying the Session is expired.

*/ - post: operations["PostCheckoutSessionsSessionExpire"]; - }; - "/v1/checkout/sessions/{session}/line_items": { + post: operations['PostCheckoutSessionsSessionExpire'] + } + '/v1/checkout/sessions/{session}/line_items': { /**

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.

*/ - get: operations["GetCheckoutSessionsSessionLineItems"]; - }; - "/v1/country_specs": { + get: operations['GetCheckoutSessionsSessionLineItems'] + } + '/v1/country_specs': { /**

Lists all Country Spec objects available in the API.

*/ - get: operations["GetCountrySpecs"]; - }; - "/v1/country_specs/{country}": { + get: operations['GetCountrySpecs'] + } + '/v1/country_specs/{country}': { /**

Returns a Country Spec for a given Country code.

*/ - get: operations["GetCountrySpecsCountry"]; - }; - "/v1/coupons": { + get: operations['GetCountrySpecsCountry'] + } + '/v1/coupons': { /**

Returns a list of your coupons.

*/ - get: operations["GetCoupons"]; + get: operations['GetCoupons'] /** *

You can create coupons easily via the coupon management page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.

* *

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.

*/ - post: operations["PostCoupons"]; - }; - "/v1/coupons/{coupon}": { + post: operations['PostCoupons'] + } + '/v1/coupons/{coupon}': { /**

Retrieves the coupon with the given ID.

*/ - get: operations["GetCouponsCoupon"]; + get: operations['GetCouponsCoupon'] /**

Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.

*/ - post: operations["PostCouponsCoupon"]; + post: operations['PostCouponsCoupon'] /**

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.

*/ - delete: operations["DeleteCouponsCoupon"]; - }; - "/v1/credit_notes": { + delete: operations['DeleteCouponsCoupon'] + } + '/v1/credit_notes': { /**

Returns a list of credit notes.

*/ - get: operations["GetCreditNotes"]; + get: operations['GetCreditNotes'] /** *

Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces * its amount_due. For a status=paid invoice, a credit note does not affect its amount_due. Instead, it can result @@ -472,63 +472,63 @@ export interface paths { *

You may issue multiple credit notes for an invoice. Each credit note will increment the invoice’s pre_payment_credit_notes_amount * or post_payment_credit_notes_amount depending on its status at the time of credit note creation.

*/ - post: operations["PostCreditNotes"]; - }; - "/v1/credit_notes/preview": { + post: operations['PostCreditNotes'] + } + '/v1/credit_notes/preview': { /**

Get a preview of a credit note without creating it.

*/ - get: operations["GetCreditNotesPreview"]; - }; - "/v1/credit_notes/preview/lines": { + get: operations['GetCreditNotesPreview'] + } + '/v1/credit_notes/preview/lines': { /**

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.

*/ - get: operations["GetCreditNotesPreviewLines"]; - }; - "/v1/credit_notes/{credit_note}/lines": { + get: operations['GetCreditNotesPreviewLines'] + } + '/v1/credit_notes/{credit_note}/lines': { /**

When retrieving a credit note, you’ll get a lines property containing the the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

*/ - get: operations["GetCreditNotesCreditNoteLines"]; - }; - "/v1/credit_notes/{id}": { + get: operations['GetCreditNotesCreditNoteLines'] + } + '/v1/credit_notes/{id}': { /**

Retrieves the credit note object with the given identifier.

*/ - get: operations["GetCreditNotesId"]; + get: operations['GetCreditNotesId'] /**

Updates an existing credit note.

*/ - post: operations["PostCreditNotesId"]; - }; - "/v1/credit_notes/{id}/void": { + post: operations['PostCreditNotesId'] + } + '/v1/credit_notes/{id}/void': { /**

Marks a credit note as void. Learn more about voiding credit notes.

*/ - post: operations["PostCreditNotesIdVoid"]; - }; - "/v1/customers": { + post: operations['PostCreditNotesIdVoid'] + } + '/v1/customers': { /**

Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.

*/ - get: operations["GetCustomers"]; + get: operations['GetCustomers'] /**

Creates a new customer object.

*/ - post: operations["PostCustomers"]; - }; - "/v1/customers/{customer}": { + post: operations['PostCustomers'] + } + '/v1/customers/{customer}': { /**

Retrieves a Customer object.

*/ - get: operations["GetCustomersCustomer"]; + get: operations['GetCustomersCustomer'] /** *

Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the source parameter, that becomes the customer’s active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the source parameter: for each of the customer’s current subscriptions, if the subscription bills automatically and is in the past_due state, then the latest open invoice for the subscription with automatic collection enabled will be retried. This retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice. Changing the default_source for a customer will not trigger this behavior.

* *

This request accepts mostly the same arguments as the customer creation call.

*/ - post: operations["PostCustomersCustomer"]; + post: operations['PostCustomersCustomer'] /**

Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.

*/ - delete: operations["DeleteCustomersCustomer"]; - }; - "/v1/customers/{customer}/balance_transactions": { + delete: operations['DeleteCustomersCustomer'] + } + '/v1/customers/{customer}/balance_transactions': { /**

Returns a list of transactions that updated the customer’s balances.

*/ - get: operations["GetCustomersCustomerBalanceTransactions"]; + get: operations['GetCustomersCustomerBalanceTransactions'] /**

Creates an immutable transaction that updates the customer’s credit balance.

*/ - post: operations["PostCustomersCustomerBalanceTransactions"]; - }; - "/v1/customers/{customer}/balance_transactions/{transaction}": { + post: operations['PostCustomersCustomerBalanceTransactions'] + } + '/v1/customers/{customer}/balance_transactions/{transaction}': { /**

Retrieves a specific customer balance transaction that updated the customer’s balances.

*/ - get: operations["GetCustomersCustomerBalanceTransactionsTransaction"]; + get: operations['GetCustomersCustomerBalanceTransactionsTransaction'] /**

Most credit balance transaction fields are immutable, but you may update its description and metadata.

*/ - post: operations["PostCustomersCustomerBalanceTransactionsTransaction"]; - }; - "/v1/customers/{customer}/bank_accounts": { + post: operations['PostCustomersCustomerBalanceTransactionsTransaction'] + } + '/v1/customers/{customer}/bank_accounts': { /**

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.

*/ - get: operations["GetCustomersCustomerBankAccounts"]; + get: operations['GetCustomersCustomerBankAccounts'] /** *

When you create a new credit card, you must specify a customer or recipient on which to create it.

* @@ -536,27 +536,27 @@ export interface paths { * 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.

*/ - post: operations["PostCustomersCustomerBankAccounts"]; - }; - "/v1/customers/{customer}/bank_accounts/{id}": { + post: operations['PostCustomersCustomerBankAccounts'] + } + '/v1/customers/{customer}/bank_accounts/{id}': { /**

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.

*/ - get: operations["GetCustomersCustomerBankAccountsId"]; + get: operations['GetCustomersCustomerBankAccountsId'] /**

Update a specified source for a given customer.

*/ - post: operations["PostCustomersCustomerBankAccountsId"]; + post: operations['PostCustomersCustomerBankAccountsId'] /**

Delete a specified source for a given customer.

*/ - delete: operations["DeleteCustomersCustomerBankAccountsId"]; - }; - "/v1/customers/{customer}/bank_accounts/{id}/verify": { + delete: operations['DeleteCustomersCustomerBankAccountsId'] + } + '/v1/customers/{customer}/bank_accounts/{id}/verify': { /**

Verify a specified bank account for a given customer.

*/ - post: operations["PostCustomersCustomerBankAccountsIdVerify"]; - }; - "/v1/customers/{customer}/cards": { + post: operations['PostCustomersCustomerBankAccountsIdVerify'] + } + '/v1/customers/{customer}/cards': { /** *

You can see a list of the cards belonging to a customer. * Note that the 10 most recent sources are always available on the Customer 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 cards.

*/ - get: operations["GetCustomersCustomerCards"]; + get: operations['GetCustomersCustomerCards'] /** *

When you create a new credit card, you must specify a customer or recipient on which to create it.

* @@ -564,28 +564,28 @@ export interface paths { * 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.

*/ - post: operations["PostCustomersCustomerCards"]; - }; - "/v1/customers/{customer}/cards/{id}": { + post: operations['PostCustomersCustomerCards'] + } + '/v1/customers/{customer}/cards/{id}': { /**

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.

*/ - get: operations["GetCustomersCustomerCardsId"]; + get: operations['GetCustomersCustomerCardsId'] /**

Update a specified source for a given customer.

*/ - post: operations["PostCustomersCustomerCardsId"]; + post: operations['PostCustomersCustomerCardsId'] /**

Delete a specified source for a given customer.

*/ - delete: operations["DeleteCustomersCustomerCardsId"]; - }; - "/v1/customers/{customer}/discount": { - get: operations["GetCustomersCustomerDiscount"]; + delete: operations['DeleteCustomersCustomerCardsId'] + } + '/v1/customers/{customer}/discount': { + get: operations['GetCustomersCustomerDiscount'] /**

Removes the currently applied discount on a customer.

*/ - delete: operations["DeleteCustomersCustomerDiscount"]; - }; - "/v1/customers/{customer}/payment_methods": { + delete: operations['DeleteCustomersCustomerDiscount'] + } + '/v1/customers/{customer}/payment_methods': { /**

Returns a list of PaymentMethods for a given Customer

*/ - get: operations["GetCustomersCustomerPaymentMethods"]; - }; - "/v1/customers/{customer}/sources": { + get: operations['GetCustomersCustomerPaymentMethods'] + } + '/v1/customers/{customer}/sources': { /**

List sources for a specified customer.

*/ - get: operations["GetCustomersCustomerSources"]; + get: operations['GetCustomersCustomerSources'] /** *

When you create a new credit card, you must specify a customer or recipient on which to create it.

* @@ -593,31 +593,31 @@ export interface paths { * 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.

*/ - post: operations["PostCustomersCustomerSources"]; - }; - "/v1/customers/{customer}/sources/{id}": { + post: operations['PostCustomersCustomerSources'] + } + '/v1/customers/{customer}/sources/{id}': { /**

Retrieve a specified source for a given customer.

*/ - get: operations["GetCustomersCustomerSourcesId"]; + get: operations['GetCustomersCustomerSourcesId'] /**

Update a specified source for a given customer.

*/ - post: operations["PostCustomersCustomerSourcesId"]; + post: operations['PostCustomersCustomerSourcesId'] /**

Delete a specified source for a given customer.

*/ - delete: operations["DeleteCustomersCustomerSourcesId"]; - }; - "/v1/customers/{customer}/sources/{id}/verify": { + delete: operations['DeleteCustomersCustomerSourcesId'] + } + '/v1/customers/{customer}/sources/{id}/verify': { /**

Verify a specified bank account for a given customer.

*/ - post: operations["PostCustomersCustomerSourcesIdVerify"]; - }; - "/v1/customers/{customer}/subscriptions": { + post: operations['PostCustomersCustomerSourcesIdVerify'] + } + '/v1/customers/{customer}/subscriptions': { /**

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.

*/ - get: operations["GetCustomersCustomerSubscriptions"]; + get: operations['GetCustomersCustomerSubscriptions'] /**

Creates a new subscription on an existing customer.

*/ - post: operations["PostCustomersCustomerSubscriptions"]; - }; - "/v1/customers/{customer}/subscriptions/{subscription_exposed_id}": { + post: operations['PostCustomersCustomerSubscriptions'] + } + '/v1/customers/{customer}/subscriptions/{subscription_exposed_id}': { /**

Retrieves the subscription with the given ID.

*/ - get: operations["GetCustomersCustomerSubscriptionsSubscriptionExposedId"]; + get: operations['GetCustomersCustomerSubscriptionsSubscriptionExposedId'] /**

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.

*/ - post: operations["PostCustomersCustomerSubscriptionsSubscriptionExposedId"]; + post: operations['PostCustomersCustomerSubscriptionsSubscriptionExposedId'] /** *

Cancels a customer’s subscription. If you set the at_period_end parameter to true, the subscription will remain active until the end of the period, at which point it will be canceled and not renewed. Otherwise, with the default false value, the subscription is terminated immediately. In either case, the customer will not be charged again for the subscription.

* @@ -625,108 +625,108 @@ export interface paths { * *

By default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.

*/ - delete: operations["DeleteCustomersCustomerSubscriptionsSubscriptionExposedId"]; - }; - "/v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discount": { - get: operations["GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount"]; + delete: operations['DeleteCustomersCustomerSubscriptionsSubscriptionExposedId'] + } + '/v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discount': { + get: operations['GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount'] /**

Removes the currently applied discount on a customer.

*/ - delete: operations["DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount"]; - }; - "/v1/customers/{customer}/tax_ids": { + delete: operations['DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount'] + } + '/v1/customers/{customer}/tax_ids': { /**

Returns a list of tax IDs for a customer.

*/ - get: operations["GetCustomersCustomerTaxIds"]; + get: operations['GetCustomersCustomerTaxIds'] /**

Creates a new TaxID object for a customer.

*/ - post: operations["PostCustomersCustomerTaxIds"]; - }; - "/v1/customers/{customer}/tax_ids/{id}": { + post: operations['PostCustomersCustomerTaxIds'] + } + '/v1/customers/{customer}/tax_ids/{id}': { /**

Retrieves the TaxID object with the given identifier.

*/ - get: operations["GetCustomersCustomerTaxIdsId"]; + get: operations['GetCustomersCustomerTaxIdsId'] /**

Deletes an existing TaxID object.

*/ - delete: operations["DeleteCustomersCustomerTaxIdsId"]; - }; - "/v1/disputes": { + delete: operations['DeleteCustomersCustomerTaxIdsId'] + } + '/v1/disputes': { /**

Returns a list of your disputes.

*/ - get: operations["GetDisputes"]; - }; - "/v1/disputes/{dispute}": { + get: operations['GetDisputes'] + } + '/v1/disputes/{dispute}': { /**

Retrieves the dispute with the given ID.

*/ - get: operations["GetDisputesDispute"]; + get: operations['GetDisputesDispute'] /** *

When you get a dispute, contacting your customer is always the best first step. If that doesn’t work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your dashboard, but if you prefer, you can use the API to submit evidence programmatically.

* *

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.

*/ - post: operations["PostDisputesDispute"]; - }; - "/v1/disputes/{dispute}/close": { + post: operations['PostDisputesDispute'] + } + '/v1/disputes/{dispute}/close': { /** *

Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.

* *

The status of the dispute will change from needs_response to lost. Closing a dispute is irreversible.

*/ - post: operations["PostDisputesDisputeClose"]; - }; - "/v1/ephemeral_keys": { + post: operations['PostDisputesDisputeClose'] + } + '/v1/ephemeral_keys': { /**

Creates a short-lived API key for a given resource.

*/ - post: operations["PostEphemeralKeys"]; - }; - "/v1/ephemeral_keys/{key}": { + post: operations['PostEphemeralKeys'] + } + '/v1/ephemeral_keys/{key}': { /**

Invalidates a short-lived API key for a given resource.

*/ - delete: operations["DeleteEphemeralKeysKey"]; - }; - "/v1/events": { + delete: operations['DeleteEphemeralKeysKey'] + } + '/v1/events': { /**

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).

*/ - get: operations["GetEvents"]; - }; - "/v1/events/{id}": { + get: operations['GetEvents'] + } + '/v1/events/{id}': { /**

Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.

*/ - get: operations["GetEventsId"]; - }; - "/v1/exchange_rates": { + get: operations['GetEventsId'] + } + '/v1/exchange_rates': { /**

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.

*/ - get: operations["GetExchangeRates"]; - }; - "/v1/exchange_rates/{rate_id}": { + get: operations['GetExchangeRates'] + } + '/v1/exchange_rates/{rate_id}': { /**

Retrieves the exchange rates from the given currency to every supported currency.

*/ - get: operations["GetExchangeRatesRateId"]; - }; - "/v1/file_links": { + get: operations['GetExchangeRatesRateId'] + } + '/v1/file_links': { /**

Returns a list of file links.

*/ - get: operations["GetFileLinks"]; + get: operations['GetFileLinks'] /**

Creates a new file link object.

*/ - post: operations["PostFileLinks"]; - }; - "/v1/file_links/{link}": { + post: operations['PostFileLinks'] + } + '/v1/file_links/{link}': { /**

Retrieves the file link with the given ID.

*/ - get: operations["GetFileLinksLink"]; + get: operations['GetFileLinksLink'] /**

Updates an existing file link object. Expired links can no longer be updated.

*/ - post: operations["PostFileLinksLink"]; - }; - "/v1/files": { + post: operations['PostFileLinksLink'] + } + '/v1/files': { /**

Returns a list of the files that your account has access to. The files are returned sorted by creation date, with the most recently created files appearing first.

*/ - get: operations["GetFiles"]; + get: operations['GetFiles'] /** *

To upload a file to Stripe, you’ll need to send a request of type multipart/form-data. The request should contain the file you would like to upload, as well as the parameters for creating a file.

* *

All of Stripe’s officially supported Client libraries should have support for sending multipart/form-data.

*/ - post: operations["PostFiles"]; - }; - "/v1/files/{file}": { + post: operations['PostFiles'] + } + '/v1/files/{file}': { /**

Retrieves the details of an existing file object. Supply the unique file ID from a file, and Stripe will return the corresponding file object. To access file contents, see the File Upload Guide.

*/ - get: operations["GetFilesFile"]; - }; - "/v1/identity/verification_reports": { + get: operations['GetFilesFile'] + } + '/v1/identity/verification_reports': { /**

List all verification reports.

*/ - get: operations["GetIdentityVerificationReports"]; - }; - "/v1/identity/verification_reports/{report}": { + get: operations['GetIdentityVerificationReports'] + } + '/v1/identity/verification_reports/{report}': { /**

Retrieves an existing VerificationReport

*/ - get: operations["GetIdentityVerificationReportsReport"]; - }; - "/v1/identity/verification_sessions": { + get: operations['GetIdentityVerificationReportsReport'] + } + '/v1/identity/verification_sessions': { /**

Returns a list of VerificationSessions

*/ - get: operations["GetIdentityVerificationSessions"]; + get: operations['GetIdentityVerificationSessions'] /** *

Creates a VerificationSession object.

* @@ -736,33 +736,33 @@ export interface paths { * *

Related guide: Verify your users’ identity documents.

*/ - post: operations["PostIdentityVerificationSessions"]; - }; - "/v1/identity/verification_sessions/{session}": { + post: operations['PostIdentityVerificationSessions'] + } + '/v1/identity/verification_sessions/{session}': { /** *

Retrieves the details of a VerificationSession that was previously created.

* *

When the session status is requires_input, you can use this method to retrieve a valid * client_secret or url to allow re-submission.

*/ - get: operations["GetIdentityVerificationSessionsSession"]; + get: operations['GetIdentityVerificationSessionsSession'] /** *

Updates a VerificationSession object.

* *

When the session status is requires_input, you can use this method to update the * verification check and options.

*/ - post: operations["PostIdentityVerificationSessionsSession"]; - }; - "/v1/identity/verification_sessions/{session}/cancel": { + post: operations['PostIdentityVerificationSessionsSession'] + } + '/v1/identity/verification_sessions/{session}/cancel': { /** *

A VerificationSession object can be canceled when it is in requires_input status.

* *

Once canceled, future submission attempts are disabled. This cannot be undone. Learn more.

*/ - post: operations["PostIdentityVerificationSessionsSessionCancel"]; - }; - "/v1/identity/verification_sessions/{session}/redact": { + post: operations['PostIdentityVerificationSessionsSessionCancel'] + } + '/v1/identity/verification_sessions/{session}/redact': { /** *

Redact a VerificationSession to remove all collected information from Stripe. This will redact * the VerificationSession and all objects related to it, including VerificationReports, Events, @@ -784,29 +784,29 @@ export interface paths { * *

Learn more.

*/ - post: operations["PostIdentityVerificationSessionsSessionRedact"]; - }; - "/v1/invoiceitems": { + post: operations['PostIdentityVerificationSessionsSessionRedact'] + } + '/v1/invoiceitems': { /**

Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first.

*/ - get: operations["GetInvoiceitems"]; + get: operations['GetInvoiceitems'] /**

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.

*/ - post: operations["PostInvoiceitems"]; - }; - "/v1/invoiceitems/{invoiceitem}": { + post: operations['PostInvoiceitems'] + } + '/v1/invoiceitems/{invoiceitem}': { /**

Retrieves the invoice item with the given ID.

*/ - get: operations["GetInvoiceitemsInvoiceitem"]; + get: operations['GetInvoiceitemsInvoiceitem'] /**

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.

*/ - post: operations["PostInvoiceitemsInvoiceitem"]; + post: operations['PostInvoiceitemsInvoiceitem'] /**

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.

*/ - delete: operations["DeleteInvoiceitemsInvoiceitem"]; - }; - "/v1/invoices": { + delete: operations['DeleteInvoiceitemsInvoiceitem'] + } + '/v1/invoices': { /**

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.

*/ - get: operations["GetInvoices"]; + get: operations['GetInvoices'] /**

This endpoint creates a draft invoice for a given customer. The draft invoice created pulls in all pending invoice items on that customer, including prorations. The invoice remains a draft until you finalize the invoice, which allows you to pay or send the invoice to your customers.

*/ - post: operations["PostInvoices"]; - }; - "/v1/invoices/upcoming": { + post: operations['PostInvoices'] + } + '/v1/invoices/upcoming': { /** *

At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.

* @@ -814,15 +814,15 @@ export interface paths { * *

You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass a proration_date parameter when doing the actual subscription update. The value passed in should be the same as the subscription_proration_date returned on the upcoming invoice resource. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_proration_date on the upcoming invoice resource.

*/ - get: operations["GetInvoicesUpcoming"]; - }; - "/v1/invoices/upcoming/lines": { + get: operations['GetInvoicesUpcoming'] + } + '/v1/invoices/upcoming/lines': { /**

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.

*/ - get: operations["GetInvoicesUpcomingLines"]; - }; - "/v1/invoices/{invoice}": { + get: operations['GetInvoicesUpcomingLines'] + } + '/v1/invoices/{invoice}': { /**

Retrieves the invoice with the given ID.

*/ - get: operations["GetInvoicesInvoice"]; + get: operations['GetInvoicesInvoice'] /** *

Draft invoices are fully editable. Once an invoice is finalized, * monetary values, as well as collection_method, become uneditable.

@@ -831,163 +831,163 @@ export interface paths { * sending reminders for, or automatically reconciling invoices, pass * auto_advance=false.

*/ - post: operations["PostInvoicesInvoice"]; + post: operations['PostInvoicesInvoice'] /**

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.

*/ - delete: operations["DeleteInvoicesInvoice"]; - }; - "/v1/invoices/{invoice}/finalize": { + delete: operations['DeleteInvoicesInvoice'] + } + '/v1/invoices/{invoice}/finalize': { /**

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.

*/ - post: operations["PostInvoicesInvoiceFinalize"]; - }; - "/v1/invoices/{invoice}/lines": { + post: operations['PostInvoicesInvoiceFinalize'] + } + '/v1/invoices/{invoice}/lines': { /**

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.

*/ - get: operations["GetInvoicesInvoiceLines"]; - }; - "/v1/invoices/{invoice}/mark_uncollectible": { + get: operations['GetInvoicesInvoiceLines'] + } + '/v1/invoices/{invoice}/mark_uncollectible': { /**

Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.

*/ - post: operations["PostInvoicesInvoiceMarkUncollectible"]; - }; - "/v1/invoices/{invoice}/pay": { + post: operations['PostInvoicesInvoiceMarkUncollectible'] + } + '/v1/invoices/{invoice}/pay': { /**

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.

*/ - post: operations["PostInvoicesInvoicePay"]; - }; - "/v1/invoices/{invoice}/send": { + post: operations['PostInvoicesInvoicePay'] + } + '/v1/invoices/{invoice}/send': { /** *

Stripe will automatically send invoices to customers according to your subscriptions settings. However, if you’d like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.

* *

Requests made in test-mode result in no emails being sent, despite sending an invoice.sent event.

*/ - post: operations["PostInvoicesInvoiceSend"]; - }; - "/v1/invoices/{invoice}/void": { + post: operations['PostInvoicesInvoiceSend'] + } + '/v1/invoices/{invoice}/void': { /**

Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.

*/ - post: operations["PostInvoicesInvoiceVoid"]; - }; - "/v1/issuer_fraud_records": { + post: operations['PostInvoicesInvoiceVoid'] + } + '/v1/issuer_fraud_records': { /**

Returns a list of issuer fraud records.

*/ - get: operations["GetIssuerFraudRecords"]; - }; - "/v1/issuer_fraud_records/{issuer_fraud_record}": { + get: operations['GetIssuerFraudRecords'] + } + '/v1/issuer_fraud_records/{issuer_fraud_record}': { /** *

Retrieves the details of an issuer fraud record that has previously been created.

* *

Please refer to the issuer fraud record object reference for more details.

*/ - get: operations["GetIssuerFraudRecordsIssuerFraudRecord"]; - }; - "/v1/issuing/authorizations": { + get: operations['GetIssuerFraudRecordsIssuerFraudRecord'] + } + '/v1/issuing/authorizations': { /**

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.

*/ - get: operations["GetIssuingAuthorizations"]; - }; - "/v1/issuing/authorizations/{authorization}": { + get: operations['GetIssuingAuthorizations'] + } + '/v1/issuing/authorizations/{authorization}': { /**

Retrieves an Issuing Authorization object.

*/ - get: operations["GetIssuingAuthorizationsAuthorization"]; + get: operations['GetIssuingAuthorizationsAuthorization'] /**

Updates the specified Issuing Authorization object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ - post: operations["PostIssuingAuthorizationsAuthorization"]; - }; - "/v1/issuing/authorizations/{authorization}/approve": { + post: operations['PostIssuingAuthorizationsAuthorization'] + } + '/v1/issuing/authorizations/{authorization}/approve': { /**

Approves a pending Issuing Authorization object. This request should be made within the timeout window of the real-time authorization flow.

*/ - post: operations["PostIssuingAuthorizationsAuthorizationApprove"]; - }; - "/v1/issuing/authorizations/{authorization}/decline": { + post: operations['PostIssuingAuthorizationsAuthorizationApprove'] + } + '/v1/issuing/authorizations/{authorization}/decline': { /**

Declines a pending Issuing Authorization object. This request should be made within the timeout window of the real time authorization flow.

*/ - post: operations["PostIssuingAuthorizationsAuthorizationDecline"]; - }; - "/v1/issuing/cardholders": { + post: operations['PostIssuingAuthorizationsAuthorizationDecline'] + } + '/v1/issuing/cardholders': { /**

Returns a list of Issuing Cardholder objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

*/ - get: operations["GetIssuingCardholders"]; + get: operations['GetIssuingCardholders'] /**

Creates a new Issuing Cardholder object that can be issued cards.

*/ - post: operations["PostIssuingCardholders"]; - }; - "/v1/issuing/cardholders/{cardholder}": { + post: operations['PostIssuingCardholders'] + } + '/v1/issuing/cardholders/{cardholder}': { /**

Retrieves an Issuing Cardholder object.

*/ - get: operations["GetIssuingCardholdersCardholder"]; + get: operations['GetIssuingCardholdersCardholder'] /**

Updates the specified Issuing Cardholder object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ - post: operations["PostIssuingCardholdersCardholder"]; - }; - "/v1/issuing/cards": { + post: operations['PostIssuingCardholdersCardholder'] + } + '/v1/issuing/cards': { /**

Returns a list of Issuing Card objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

*/ - get: operations["GetIssuingCards"]; + get: operations['GetIssuingCards'] /**

Creates an Issuing Card object.

*/ - post: operations["PostIssuingCards"]; - }; - "/v1/issuing/cards/{card}": { + post: operations['PostIssuingCards'] + } + '/v1/issuing/cards/{card}': { /**

Retrieves an Issuing Card object.

*/ - get: operations["GetIssuingCardsCard"]; + get: operations['GetIssuingCardsCard'] /**

Updates the specified Issuing Card object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ - post: operations["PostIssuingCardsCard"]; - }; - "/v1/issuing/disputes": { + post: operations['PostIssuingCardsCard'] + } + '/v1/issuing/disputes': { /**

Returns a list of Issuing Dispute objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

*/ - get: operations["GetIssuingDisputes"]; + get: operations['GetIssuingDisputes'] /**

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.

*/ - post: operations["PostIssuingDisputes"]; - }; - "/v1/issuing/disputes/{dispute}": { + post: operations['PostIssuingDisputes'] + } + '/v1/issuing/disputes/{dispute}': { /**

Retrieves an Issuing Dispute object.

*/ - get: operations["GetIssuingDisputesDispute"]; + get: operations['GetIssuingDisputesDispute'] /**

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.

*/ - post: operations["PostIssuingDisputesDispute"]; - }; - "/v1/issuing/disputes/{dispute}/submit": { + post: operations['PostIssuingDisputesDispute'] + } + '/v1/issuing/disputes/{dispute}/submit': { /**

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.

*/ - post: operations["PostIssuingDisputesDisputeSubmit"]; - }; - "/v1/issuing/settlements": { + post: operations['PostIssuingDisputesDisputeSubmit'] + } + '/v1/issuing/settlements': { /**

Returns a list of Issuing Settlement objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

*/ - get: operations["GetIssuingSettlements"]; - }; - "/v1/issuing/settlements/{settlement}": { + get: operations['GetIssuingSettlements'] + } + '/v1/issuing/settlements/{settlement}': { /**

Retrieves an Issuing Settlement object.

*/ - get: operations["GetIssuingSettlementsSettlement"]; + get: operations['GetIssuingSettlementsSettlement'] /**

Updates the specified Issuing Settlement object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ - post: operations["PostIssuingSettlementsSettlement"]; - }; - "/v1/issuing/transactions": { + post: operations['PostIssuingSettlementsSettlement'] + } + '/v1/issuing/transactions': { /**

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.

*/ - get: operations["GetIssuingTransactions"]; - }; - "/v1/issuing/transactions/{transaction}": { + get: operations['GetIssuingTransactions'] + } + '/v1/issuing/transactions/{transaction}': { /**

Retrieves an Issuing Transaction object.

*/ - get: operations["GetIssuingTransactionsTransaction"]; + get: operations['GetIssuingTransactionsTransaction'] /**

Updates the specified Issuing Transaction object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ - post: operations["PostIssuingTransactionsTransaction"]; - }; - "/v1/mandates/{mandate}": { + post: operations['PostIssuingTransactionsTransaction'] + } + '/v1/mandates/{mandate}': { /**

Retrieves a Mandate object.

*/ - get: operations["GetMandatesMandate"]; - }; - "/v1/order_returns": { + get: operations['GetMandatesMandate'] + } + '/v1/order_returns': { /**

Returns a list of your order returns. The returns are returned sorted by creation date, with the most recently created return appearing first.

*/ - get: operations["GetOrderReturns"]; - }; - "/v1/order_returns/{id}": { + get: operations['GetOrderReturns'] + } + '/v1/order_returns/{id}': { /**

Retrieves the details of an existing order return. Supply the unique order ID from either an order return creation request or the order return list, and Stripe will return the corresponding order information.

*/ - get: operations["GetOrderReturnsId"]; - }; - "/v1/orders": { + get: operations['GetOrderReturnsId'] + } + '/v1/orders': { /**

Returns a list of your orders. The orders are returned sorted by creation date, with the most recently created orders appearing first.

*/ - get: operations["GetOrders"]; + get: operations['GetOrders'] /**

Creates a new order object.

*/ - post: operations["PostOrders"]; - }; - "/v1/orders/{id}": { + post: operations['PostOrders'] + } + '/v1/orders/{id}': { /**

Retrieves the details of an existing order. Supply the unique order ID from either an order creation request or the order list, and Stripe will return the corresponding order information.

*/ - get: operations["GetOrdersId"]; + get: operations['GetOrdersId'] /**

Updates the specific order by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ - post: operations["PostOrdersId"]; - }; - "/v1/orders/{id}/pay": { + post: operations['PostOrdersId'] + } + '/v1/orders/{id}/pay': { /**

Pay an order by providing a source to create a payment.

*/ - post: operations["PostOrdersIdPay"]; - }; - "/v1/orders/{id}/returns": { + post: operations['PostOrdersIdPay'] + } + '/v1/orders/{id}/returns': { /**

Return all or part of an order. The order must have a status of paid or fulfilled before it can be returned. Once all items have been returned, the order will become canceled or returned depending on which status the order started in.

*/ - post: operations["PostOrdersIdReturns"]; - }; - "/v1/payment_intents": { + post: operations['PostOrdersIdReturns'] + } + '/v1/payment_intents': { /**

Returns a list of PaymentIntents.

*/ - get: operations["GetPaymentIntents"]; + get: operations['GetPaymentIntents'] /** *

Creates a PaymentIntent object.

* @@ -1000,9 +1000,9 @@ export interface paths { * available in the confirm API when confirm=true * is supplied.

*/ - post: operations["PostPaymentIntents"]; - }; - "/v1/payment_intents/{intent}": { + post: operations['PostPaymentIntents'] + } + '/v1/payment_intents/{intent}': { /** *

Retrieves the details of a PaymentIntent that has previously been created.

* @@ -1010,7 +1010,7 @@ export interface paths { * *

When retrieved with a publishable key, only a subset of properties will be returned. Please refer to the payment intent object reference for more details.

*/ - get: operations["GetPaymentIntentsIntent"]; + get: operations['GetPaymentIntentsIntent'] /** *

Updates properties on a PaymentIntent object without confirming.

* @@ -1020,17 +1020,17 @@ export interface paths { * update and confirm at the same time, we recommend updating properties via * the confirm API instead.

*/ - post: operations["PostPaymentIntentsIntent"]; - }; - "/v1/payment_intents/{intent}/cancel": { + post: operations['PostPaymentIntentsIntent'] + } + '/v1/payment_intents/{intent}/cancel': { /** *

A PaymentIntent object can be canceled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action, or processing.

* *

Once canceled, no additional charges will be made by the PaymentIntent and any operations on the PaymentIntent will fail with an error. For PaymentIntents with status=’requires_capture’, the remaining amount_capturable will automatically be refunded.

*/ - post: operations["PostPaymentIntentsIntentCancel"]; - }; - "/v1/payment_intents/{intent}/capture": { + post: operations['PostPaymentIntentsIntentCancel'] + } + '/v1/payment_intents/{intent}/capture': { /** *

Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.

* @@ -1038,9 +1038,9 @@ export interface paths { * *

Learn more about separate authorization and capture.

*/ - post: operations["PostPaymentIntentsIntentCapture"]; - }; - "/v1/payment_intents/{intent}/confirm": { + post: operations['PostPaymentIntentsIntentCapture'] + } + '/v1/payment_intents/{intent}/confirm': { /** *

Confirm that your customer intends to pay with current or provided * payment method. Upon confirmation, the PaymentIntent will attempt to initiate @@ -1068,45 +1068,45 @@ export interface paths { * attempt. Read the expanded documentation * to learn more about manual confirmation.

*/ - post: operations["PostPaymentIntentsIntentConfirm"]; - }; - "/v1/payment_intents/{intent}/verify_microdeposits": { + post: operations['PostPaymentIntentsIntentConfirm'] + } + '/v1/payment_intents/{intent}/verify_microdeposits': { /**

Verifies microdeposits on a PaymentIntent object.

*/ - post: operations["PostPaymentIntentsIntentVerifyMicrodeposits"]; - }; - "/v1/payment_links": { + post: operations['PostPaymentIntentsIntentVerifyMicrodeposits'] + } + '/v1/payment_links': { /**

Returns a list of your payment links.

*/ - get: operations["GetPaymentLinks"]; + get: operations['GetPaymentLinks'] /**

Creates a payment link.

*/ - post: operations["PostPaymentLinks"]; - }; - "/v1/payment_links/{payment_link}": { + post: operations['PostPaymentLinks'] + } + '/v1/payment_links/{payment_link}': { /**

Retrieve a payment link.

*/ - get: operations["GetPaymentLinksPaymentLink"]; + get: operations['GetPaymentLinksPaymentLink'] /**

Updates a payment link.

*/ - post: operations["PostPaymentLinksPaymentLink"]; - }; - "/v1/payment_links/{payment_link}/line_items": { + post: operations['PostPaymentLinksPaymentLink'] + } + '/v1/payment_links/{payment_link}/line_items': { /**

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.

*/ - get: operations["GetPaymentLinksPaymentLinkLineItems"]; - }; - "/v1/payment_methods": { + get: operations['GetPaymentLinksPaymentLinkLineItems'] + } + '/v1/payment_methods': { /**

Returns a list of PaymentMethods. For listing a customer’s payment methods, you should use List a Customer’s PaymentMethods

*/ - get: operations["GetPaymentMethods"]; + get: operations['GetPaymentMethods'] /** *

Creates a PaymentMethod object. Read the Stripe.js reference to learn how to create PaymentMethods via Stripe.js.

* *

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.

*/ - post: operations["PostPaymentMethods"]; - }; - "/v1/payment_methods/{payment_method}": { + post: operations['PostPaymentMethods'] + } + '/v1/payment_methods/{payment_method}': { /**

Retrieves a PaymentMethod object.

*/ - get: operations["GetPaymentMethodsPaymentMethod"]; + get: operations['GetPaymentMethodsPaymentMethod'] /**

Updates a PaymentMethod object. A PaymentMethod must be attached a customer to be updated.

*/ - post: operations["PostPaymentMethodsPaymentMethod"]; - }; - "/v1/payment_methods/{payment_method}/attach": { + post: operations['PostPaymentMethodsPaymentMethod'] + } + '/v1/payment_methods/{payment_method}/attach': { /** *

Attaches a PaymentMethod object to a Customer.

* @@ -1120,15 +1120,15 @@ export interface paths { * set invoice_settings.default_payment_method, * on the Customer to the PaymentMethod’s ID.

*/ - post: operations["PostPaymentMethodsPaymentMethodAttach"]; - }; - "/v1/payment_methods/{payment_method}/detach": { + post: operations['PostPaymentMethodsPaymentMethodAttach'] + } + '/v1/payment_methods/{payment_method}/detach': { /**

Detaches a PaymentMethod object from a Customer.

*/ - post: operations["PostPaymentMethodsPaymentMethodDetach"]; - }; - "/v1/payouts": { + post: operations['PostPaymentMethodsPaymentMethodDetach'] + } + '/v1/payouts': { /**

Returns a list of existing payouts sent to third-party bank accounts or that Stripe has sent you. The payouts are returned in sorted order, with the most recently created payouts appearing first.

*/ - get: operations["GetPayouts"]; + get: operations['GetPayouts'] /** *

To send funds to your own bank account, you create a new payout object. Your Stripe balance must be able to cover the payout amount, or you’ll receive an “Insufficient Funds” error.

* @@ -1136,164 +1136,164 @@ export interface paths { * *

If you are creating a manual payout on a Stripe account that uses multiple payment source types, you’ll need to specify the source type balance that the payout should draw from. The balance object details available and pending amounts by source type.

*/ - post: operations["PostPayouts"]; - }; - "/v1/payouts/{payout}": { + post: operations['PostPayouts'] + } + '/v1/payouts/{payout}': { /**

Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list, and Stripe will return the corresponding payout information.

*/ - get: operations["GetPayoutsPayout"]; + get: operations['GetPayoutsPayout'] /**

Updates the specified payout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request accepts only the metadata as arguments.

*/ - post: operations["PostPayoutsPayout"]; - }; - "/v1/payouts/{payout}/cancel": { + post: operations['PostPayoutsPayout'] + } + '/v1/payouts/{payout}/cancel': { /**

A previously created payout can be canceled if it has not yet been paid out. Funds will be refunded to your available balance. You may not cancel automatic Stripe payouts.

*/ - post: operations["PostPayoutsPayoutCancel"]; - }; - "/v1/payouts/{payout}/reverse": { + post: operations['PostPayoutsPayoutCancel'] + } + '/v1/payouts/{payout}/reverse': { /** *

Reverses a payout by debiting the destination bank account. Only payouts for connected accounts to US bank accounts may be reversed at this time. If the payout is in the pending status, /v1/payouts/:id/cancel should be used instead.

* *

By requesting a reversal via /v1/payouts/:id/reverse, you confirm that the authorized signatory of the selected bank account has authorized the debit on the bank account and that no other authorization is required.

*/ - post: operations["PostPayoutsPayoutReverse"]; - }; - "/v1/plans": { + post: operations['PostPayoutsPayoutReverse'] + } + '/v1/plans': { /**

Returns a list of your plans.

*/ - get: operations["GetPlans"]; + get: operations['GetPlans'] /**

You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.

*/ - post: operations["PostPlans"]; - }; - "/v1/plans/{plan}": { + post: operations['PostPlans'] + } + '/v1/plans/{plan}': { /**

Retrieves the plan with the given ID.

*/ - get: operations["GetPlansPlan"]; + get: operations['GetPlansPlan'] /**

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.

*/ - post: operations["PostPlansPlan"]; + post: operations['PostPlansPlan'] /**

Deleting plans means new subscribers can’t be added. Existing subscribers aren’t affected.

*/ - delete: operations["DeletePlansPlan"]; - }; - "/v1/prices": { + delete: operations['DeletePlansPlan'] + } + '/v1/prices': { /**

Returns a list of your prices.

*/ - get: operations["GetPrices"]; + get: operations['GetPrices'] /**

Creates a new price for an existing product. The price can be recurring or one-time.

*/ - post: operations["PostPrices"]; - }; - "/v1/prices/{price}": { + post: operations['PostPrices'] + } + '/v1/prices/{price}': { /**

Retrieves the price with the given ID.

*/ - get: operations["GetPricesPrice"]; + get: operations['GetPricesPrice'] /**

Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged.

*/ - post: operations["PostPricesPrice"]; - }; - "/v1/products": { + post: operations['PostPricesPrice'] + } + '/v1/products': { /**

Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.

*/ - get: operations["GetProducts"]; + get: operations['GetProducts'] /**

Creates a new product object.

*/ - post: operations["PostProducts"]; - }; - "/v1/products/{id}": { + post: operations['PostProducts'] + } + '/v1/products/{id}': { /**

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.

*/ - get: operations["GetProductsId"]; + get: operations['GetProductsId'] /**

Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ - post: operations["PostProductsId"]; + post: operations['PostProductsId'] /**

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.

*/ - delete: operations["DeleteProductsId"]; - }; - "/v1/promotion_codes": { + delete: operations['DeleteProductsId'] + } + '/v1/promotion_codes': { /**

Returns a list of your promotion codes.

*/ - get: operations["GetPromotionCodes"]; + get: operations['GetPromotionCodes'] /**

A promotion code points to a coupon. You can optionally restrict the code to a specific customer, redemption limit, and expiration date.

*/ - post: operations["PostPromotionCodes"]; - }; - "/v1/promotion_codes/{promotion_code}": { + post: operations['PostPromotionCodes'] + } + '/v1/promotion_codes/{promotion_code}': { /**

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.

*/ - get: operations["GetPromotionCodesPromotionCode"]; + get: operations['GetPromotionCodesPromotionCode'] /**

Updates the specified promotion code by setting the values of the parameters passed. Most fields are, by design, not editable.

*/ - post: operations["PostPromotionCodesPromotionCode"]; - }; - "/v1/quotes": { + post: operations['PostPromotionCodesPromotionCode'] + } + '/v1/quotes': { /**

Returns a list of your quotes.

*/ - get: operations["GetQuotes"]; + get: operations['GetQuotes'] /**

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.

*/ - post: operations["PostQuotes"]; - }; - "/v1/quotes/{quote}": { + post: operations['PostQuotes'] + } + '/v1/quotes/{quote}': { /**

Retrieves the quote with the given ID.

*/ - get: operations["GetQuotesQuote"]; + get: operations['GetQuotesQuote'] /**

A quote models prices and services for a customer.

*/ - post: operations["PostQuotesQuote"]; - }; - "/v1/quotes/{quote}/accept": { + post: operations['PostQuotesQuote'] + } + '/v1/quotes/{quote}/accept': { /**

Accepts the specified quote.

*/ - post: operations["PostQuotesQuoteAccept"]; - }; - "/v1/quotes/{quote}/cancel": { + post: operations['PostQuotesQuoteAccept'] + } + '/v1/quotes/{quote}/cancel': { /**

Cancels the quote.

*/ - post: operations["PostQuotesQuoteCancel"]; - }; - "/v1/quotes/{quote}/computed_upfront_line_items": { + post: operations['PostQuotesQuoteCancel'] + } + '/v1/quotes/{quote}/computed_upfront_line_items': { /**

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.

*/ - get: operations["GetQuotesQuoteComputedUpfrontLineItems"]; - }; - "/v1/quotes/{quote}/finalize": { + get: operations['GetQuotesQuoteComputedUpfrontLineItems'] + } + '/v1/quotes/{quote}/finalize': { /**

Finalizes the quote.

*/ - post: operations["PostQuotesQuoteFinalize"]; - }; - "/v1/quotes/{quote}/line_items": { + post: operations['PostQuotesQuoteFinalize'] + } + '/v1/quotes/{quote}/line_items': { /**

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.

*/ - get: operations["GetQuotesQuoteLineItems"]; - }; - "/v1/quotes/{quote}/pdf": { + get: operations['GetQuotesQuoteLineItems'] + } + '/v1/quotes/{quote}/pdf': { /**

Download the PDF for a finalized quote

*/ - get: operations["GetQuotesQuotePdf"]; - }; - "/v1/radar/early_fraud_warnings": { + get: operations['GetQuotesQuotePdf'] + } + '/v1/radar/early_fraud_warnings': { /**

Returns a list of early fraud warnings.

*/ - get: operations["GetRadarEarlyFraudWarnings"]; - }; - "/v1/radar/early_fraud_warnings/{early_fraud_warning}": { + get: operations['GetRadarEarlyFraudWarnings'] + } + '/v1/radar/early_fraud_warnings/{early_fraud_warning}': { /** *

Retrieves the details of an early fraud warning that has previously been created.

* *

Please refer to the early fraud warning object reference for more details.

*/ - get: operations["GetRadarEarlyFraudWarningsEarlyFraudWarning"]; - }; - "/v1/radar/value_list_items": { + get: operations['GetRadarEarlyFraudWarningsEarlyFraudWarning'] + } + '/v1/radar/value_list_items': { /**

Returns a list of ValueListItem objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

*/ - get: operations["GetRadarValueListItems"]; + get: operations['GetRadarValueListItems'] /**

Creates a new ValueListItem object, which is added to the specified parent value list.

*/ - post: operations["PostRadarValueListItems"]; - }; - "/v1/radar/value_list_items/{item}": { + post: operations['PostRadarValueListItems'] + } + '/v1/radar/value_list_items/{item}': { /**

Retrieves a ValueListItem object.

*/ - get: operations["GetRadarValueListItemsItem"]; + get: operations['GetRadarValueListItemsItem'] /**

Deletes a ValueListItem object, removing it from its parent value list.

*/ - delete: operations["DeleteRadarValueListItemsItem"]; - }; - "/v1/radar/value_lists": { + delete: operations['DeleteRadarValueListItemsItem'] + } + '/v1/radar/value_lists': { /**

Returns a list of ValueList objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

*/ - get: operations["GetRadarValueLists"]; + get: operations['GetRadarValueLists'] /**

Creates a new ValueList object, which can then be referenced in rules.

*/ - post: operations["PostRadarValueLists"]; - }; - "/v1/radar/value_lists/{value_list}": { + post: operations['PostRadarValueLists'] + } + '/v1/radar/value_lists/{value_list}': { /**

Retrieves a ValueList object.

*/ - get: operations["GetRadarValueListsValueList"]; + get: operations['GetRadarValueListsValueList'] /**

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.

*/ - post: operations["PostRadarValueListsValueList"]; + post: operations['PostRadarValueListsValueList'] /**

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.

*/ - delete: operations["DeleteRadarValueListsValueList"]; - }; - "/v1/recipients": { + delete: operations['DeleteRadarValueListsValueList'] + } + '/v1/recipients': { /**

Returns a list of your recipients. The recipients are returned sorted by creation date, with the most recently created recipients appearing first.

*/ - get: operations["GetRecipients"]; + get: operations['GetRecipients'] /** *

Creates a new Recipient object and verifies the recipient’s identity. * Also verifies the recipient’s bank account information or debit card, if either is provided.

*/ - post: operations["PostRecipients"]; - }; - "/v1/recipients/{id}": { + post: operations['PostRecipients'] + } + '/v1/recipients/{id}': { /**

Retrieves the details of an existing recipient. You need only supply the unique recipient identifier that was returned upon recipient creation.

*/ - get: operations["GetRecipientsId"]; + get: operations['GetRecipientsId'] /** *

Updates the specified recipient by setting the values of the parameters passed. * Any parameters not provided will be left unchanged.

@@ -1301,72 +1301,72 @@ export interface paths { *

If you update the name or tax ID, the identity verification will automatically be rerun. * If you update the bank account, the bank account validation will automatically be rerun.

*/ - post: operations["PostRecipientsId"]; + post: operations['PostRecipientsId'] /**

Permanently deletes a recipient. It cannot be undone.

*/ - delete: operations["DeleteRecipientsId"]; - }; - "/v1/refunds": { + delete: operations['DeleteRecipientsId'] + } + '/v1/refunds': { /**

Returns a list of all refunds you’ve previously created. The refunds are returned in sorted order, with the most recent refunds appearing first. For convenience, the 10 most recent refunds are always available by default on the charge object.

*/ - get: operations["GetRefunds"]; + get: operations['GetRefunds'] /**

Create a refund.

*/ - post: operations["PostRefunds"]; - }; - "/v1/refunds/{refund}": { + post: operations['PostRefunds'] + } + '/v1/refunds/{refund}': { /**

Retrieves the details of an existing refund.

*/ - get: operations["GetRefundsRefund"]; + get: operations['GetRefundsRefund'] /** *

Updates the specified refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

* *

This request only accepts metadata as an argument.

*/ - post: operations["PostRefundsRefund"]; - }; - "/v1/reporting/report_runs": { + post: operations['PostRefundsRefund'] + } + '/v1/reporting/report_runs': { /**

Returns a list of Report Runs, with the most recent appearing first.

*/ - get: operations["GetReportingReportRuns"]; + get: operations['GetReportingReportRuns'] /**

Creates a new object and begin running the report. (Certain report types require a live-mode API key.)

*/ - post: operations["PostReportingReportRuns"]; - }; - "/v1/reporting/report_runs/{report_run}": { + post: operations['PostReportingReportRuns'] + } + '/v1/reporting/report_runs/{report_run}': { /**

Retrieves the details of an existing Report Run.

*/ - get: operations["GetReportingReportRunsReportRun"]; - }; - "/v1/reporting/report_types": { + get: operations['GetReportingReportRunsReportRun'] + } + '/v1/reporting/report_types': { /**

Returns a full list of Report Types.

*/ - get: operations["GetReportingReportTypes"]; - }; - "/v1/reporting/report_types/{report_type}": { + get: operations['GetReportingReportTypes'] + } + '/v1/reporting/report_types/{report_type}': { /**

Retrieves the details of a Report Type. (Certain report types require a live-mode API key.)

*/ - get: operations["GetReportingReportTypesReportType"]; - }; - "/v1/reviews": { + get: operations['GetReportingReportTypesReportType'] + } + '/v1/reviews': { /**

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.

*/ - get: operations["GetReviews"]; - }; - "/v1/reviews/{review}": { + get: operations['GetReviews'] + } + '/v1/reviews/{review}': { /**

Retrieves a Review object.

*/ - get: operations["GetReviewsReview"]; - }; - "/v1/reviews/{review}/approve": { + get: operations['GetReviewsReview'] + } + '/v1/reviews/{review}/approve': { /**

Approves a Review object, closing it and removing it from the list of reviews.

*/ - post: operations["PostReviewsReviewApprove"]; - }; - "/v1/setup_attempts": { + post: operations['PostReviewsReviewApprove'] + } + '/v1/setup_attempts': { /**

Returns a list of SetupAttempts associated with a provided SetupIntent.

*/ - get: operations["GetSetupAttempts"]; - }; - "/v1/setup_intents": { + get: operations['GetSetupAttempts'] + } + '/v1/setup_intents': { /**

Returns a list of SetupIntents.

*/ - get: operations["GetSetupIntents"]; + get: operations['GetSetupIntents'] /** *

Creates a SetupIntent object.

* *

After the SetupIntent is created, attach a payment method and confirm * to collect any required permissions to charge the payment method later.

*/ - post: operations["PostSetupIntents"]; - }; - "/v1/setup_intents/{intent}": { + post: operations['PostSetupIntents'] + } + '/v1/setup_intents/{intent}': { /** *

Retrieves the details of a SetupIntent that has previously been created.

* @@ -1374,19 +1374,19 @@ export interface paths { * *

When retrieved with a publishable key, only a subset of properties will be returned. Please refer to the SetupIntent object reference for more details.

*/ - get: operations["GetSetupIntentsIntent"]; + get: operations['GetSetupIntentsIntent'] /**

Updates a SetupIntent object.

*/ - post: operations["PostSetupIntentsIntent"]; - }; - "/v1/setup_intents/{intent}/cancel": { + post: operations['PostSetupIntentsIntent'] + } + '/v1/setup_intents/{intent}/cancel': { /** *

A SetupIntent object can be canceled when it is in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.

* *

Once canceled, setup is abandoned and any operations on the SetupIntent will fail with an error.

*/ - post: operations["PostSetupIntentsIntentCancel"]; - }; - "/v1/setup_intents/{intent}/confirm": { + post: operations['PostSetupIntentsIntentCancel'] + } + '/v1/setup_intents/{intent}/confirm': { /** *

Confirm that your customer intends to set up the current or * provided payment method. For example, you would confirm a SetupIntent @@ -1402,103 +1402,103 @@ export interface paths { * the SetupIntent will transition to the * requires_payment_method status.

*/ - post: operations["PostSetupIntentsIntentConfirm"]; - }; - "/v1/setup_intents/{intent}/verify_microdeposits": { + post: operations['PostSetupIntentsIntentConfirm'] + } + '/v1/setup_intents/{intent}/verify_microdeposits': { /**

Verifies microdeposits on a SetupIntent object.

*/ - post: operations["PostSetupIntentsIntentVerifyMicrodeposits"]; - }; - "/v1/shipping_rates": { + post: operations['PostSetupIntentsIntentVerifyMicrodeposits'] + } + '/v1/shipping_rates': { /**

Returns a list of your shipping rates.

*/ - get: operations["GetShippingRates"]; + get: operations['GetShippingRates'] /**

Creates a new shipping rate object.

*/ - post: operations["PostShippingRates"]; - }; - "/v1/shipping_rates/{shipping_rate_token}": { + post: operations['PostShippingRates'] + } + '/v1/shipping_rates/{shipping_rate_token}': { /**

Returns the shipping rate object with the given ID.

*/ - get: operations["GetShippingRatesShippingRateToken"]; + get: operations['GetShippingRatesShippingRateToken'] /**

Updates an existing shipping rate object.

*/ - post: operations["PostShippingRatesShippingRateToken"]; - }; - "/v1/sigma/scheduled_query_runs": { + post: operations['PostShippingRatesShippingRateToken'] + } + '/v1/sigma/scheduled_query_runs': { /**

Returns a list of scheduled query runs.

*/ - get: operations["GetSigmaScheduledQueryRuns"]; - }; - "/v1/sigma/scheduled_query_runs/{scheduled_query_run}": { + get: operations['GetSigmaScheduledQueryRuns'] + } + '/v1/sigma/scheduled_query_runs/{scheduled_query_run}': { /**

Retrieves the details of an scheduled query run.

*/ - get: operations["GetSigmaScheduledQueryRunsScheduledQueryRun"]; - }; - "/v1/skus": { + get: operations['GetSigmaScheduledQueryRunsScheduledQueryRun'] + } + '/v1/skus': { /**

Returns a list of your SKUs. The SKUs are returned sorted by creation date, with the most recently created SKUs appearing first.

*/ - get: operations["GetSkus"]; + get: operations['GetSkus'] /**

Creates a new SKU associated with a product.

*/ - post: operations["PostSkus"]; - }; - "/v1/skus/{id}": { + post: operations['PostSkus'] + } + '/v1/skus/{id}': { /**

Retrieves the details of an existing SKU. Supply the unique SKU identifier from either a SKU creation request or from the product, and Stripe will return the corresponding SKU information.

*/ - get: operations["GetSkusId"]; + get: operations['GetSkusId'] /** *

Updates the specific SKU by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

* *

Note that a SKU’s attributes are not editable. Instead, you would need to deactivate the existing SKU and create a new one with the new attribute values.

*/ - post: operations["PostSkusId"]; + post: operations['PostSkusId'] /**

Delete a SKU. Deleting a SKU is only possible until it has been used in an order.

*/ - delete: operations["DeleteSkusId"]; - }; - "/v1/sources": { + delete: operations['DeleteSkusId'] + } + '/v1/sources': { /**

Creates a new source object.

*/ - post: operations["PostSources"]; - }; - "/v1/sources/{source}": { + post: operations['PostSources'] + } + '/v1/sources/{source}': { /**

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.

*/ - get: operations["GetSourcesSource"]; + get: operations['GetSourcesSource'] /** *

Updates the specified source by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

* *

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.

*/ - post: operations["PostSourcesSource"]; - }; - "/v1/sources/{source}/mandate_notifications/{mandate_notification}": { + post: operations['PostSourcesSource'] + } + '/v1/sources/{source}/mandate_notifications/{mandate_notification}': { /**

Retrieves a new Source MandateNotification.

*/ - get: operations["GetSourcesSourceMandateNotificationsMandateNotification"]; - }; - "/v1/sources/{source}/source_transactions": { + get: operations['GetSourcesSourceMandateNotificationsMandateNotification'] + } + '/v1/sources/{source}/source_transactions': { /**

List source transactions for a given source.

*/ - get: operations["GetSourcesSourceSourceTransactions"]; - }; - "/v1/sources/{source}/source_transactions/{source_transaction}": { + get: operations['GetSourcesSourceSourceTransactions'] + } + '/v1/sources/{source}/source_transactions/{source_transaction}': { /**

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.

*/ - get: operations["GetSourcesSourceSourceTransactionsSourceTransaction"]; - }; - "/v1/sources/{source}/verify": { + get: operations['GetSourcesSourceSourceTransactionsSourceTransaction'] + } + '/v1/sources/{source}/verify': { /**

Verify a given source.

*/ - post: operations["PostSourcesSourceVerify"]; - }; - "/v1/subscription_items": { + post: operations['PostSourcesSourceVerify'] + } + '/v1/subscription_items': { /**

Returns a list of your subscription items for a given subscription.

*/ - get: operations["GetSubscriptionItems"]; + get: operations['GetSubscriptionItems'] /**

Adds a new item to an existing subscription. No existing items will be changed or replaced.

*/ - post: operations["PostSubscriptionItems"]; - }; - "/v1/subscription_items/{item}": { + post: operations['PostSubscriptionItems'] + } + '/v1/subscription_items/{item}': { /**

Retrieves the subscription item with the given ID.

*/ - get: operations["GetSubscriptionItemsItem"]; + get: operations['GetSubscriptionItemsItem'] /**

Updates the plan or quantity of an item on a current subscription.

*/ - post: operations["PostSubscriptionItemsItem"]; + post: operations['PostSubscriptionItemsItem'] /**

Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.

*/ - delete: operations["DeleteSubscriptionItemsItem"]; - }; - "/v1/subscription_items/{subscription_item}/usage_record_summaries": { + delete: operations['DeleteSubscriptionItemsItem'] + } + '/v1/subscription_items/{subscription_item}/usage_record_summaries': { /** *

For the specified subscription item, returns a list of summary objects. Each object in the list provides usage information that’s been summarized from multiple usage records and over a subscription billing period (e.g., 15 usage records in the month of September).

* *

The list is sorted in reverse-chronological order (newest first). The first list item represents the most current usage period that hasn’t ended yet. Since new usage records can still be added, the returned summary information for the subscription item’s ID should be seen as unstable until the subscription billing period ends.

*/ - get: operations["GetSubscriptionItemsSubscriptionItemUsageRecordSummaries"]; - }; - "/v1/subscription_items/{subscription_item}/usage_records": { + get: operations['GetSubscriptionItemsSubscriptionItemUsageRecordSummaries'] + } + '/v1/subscription_items/{subscription_item}/usage_records': { /** *

Creates a usage record for a specified subscription item and date, and fills it with a quantity.

* @@ -1508,39 +1508,39 @@ export interface paths { * *

The default pricing model for metered billing is per-unit pricing. For finer granularity, you can configure metered billing to have a tiered pricing model.

*/ - post: operations["PostSubscriptionItemsSubscriptionItemUsageRecords"]; - }; - "/v1/subscription_schedules": { + post: operations['PostSubscriptionItemsSubscriptionItemUsageRecords'] + } + '/v1/subscription_schedules': { /**

Retrieves the list of your subscription schedules.

*/ - get: operations["GetSubscriptionSchedules"]; + get: operations['GetSubscriptionSchedules'] /**

Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.

*/ - post: operations["PostSubscriptionSchedules"]; - }; - "/v1/subscription_schedules/{schedule}": { + post: operations['PostSubscriptionSchedules'] + } + '/v1/subscription_schedules/{schedule}': { /**

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.

*/ - get: operations["GetSubscriptionSchedulesSchedule"]; + get: operations['GetSubscriptionSchedulesSchedule'] /**

Updates an existing subscription schedule.

*/ - post: operations["PostSubscriptionSchedulesSchedule"]; - }; - "/v1/subscription_schedules/{schedule}/cancel": { + post: operations['PostSubscriptionSchedulesSchedule'] + } + '/v1/subscription_schedules/{schedule}/cancel': { /**

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.

*/ - post: operations["PostSubscriptionSchedulesScheduleCancel"]; - }; - "/v1/subscription_schedules/{schedule}/release": { + post: operations['PostSubscriptionSchedulesScheduleCancel'] + } + '/v1/subscription_schedules/{schedule}/release': { /**

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.

*/ - post: operations["PostSubscriptionSchedulesScheduleRelease"]; - }; - "/v1/subscriptions": { + post: operations['PostSubscriptionSchedulesScheduleRelease'] + } + '/v1/subscriptions': { /**

By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.

*/ - get: operations["GetSubscriptions"]; + get: operations['GetSubscriptions'] /**

Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.

*/ - post: operations["PostSubscriptions"]; - }; - "/v1/subscriptions/{subscription_exposed_id}": { + post: operations['PostSubscriptions'] + } + '/v1/subscriptions/{subscription_exposed_id}': { /**

Retrieves the subscription with the given ID.

*/ - get: operations["GetSubscriptionsSubscriptionExposedId"]; + get: operations['GetSubscriptionsSubscriptionExposedId'] /**

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.

*/ - post: operations["PostSubscriptionsSubscriptionExposedId"]; + post: operations['PostSubscriptionsSubscriptionExposedId'] /** *

Cancels a customer’s subscription immediately. The customer will not be charged again for the subscription.

* @@ -1548,103 +1548,103 @@ export interface paths { * *

By default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.

*/ - delete: operations["DeleteSubscriptionsSubscriptionExposedId"]; - }; - "/v1/subscriptions/{subscription_exposed_id}/discount": { + delete: operations['DeleteSubscriptionsSubscriptionExposedId'] + } + '/v1/subscriptions/{subscription_exposed_id}/discount': { /**

Removes the currently applied discount on a subscription.

*/ - delete: operations["DeleteSubscriptionsSubscriptionExposedIdDiscount"]; - }; - "/v1/tax_codes": { + delete: operations['DeleteSubscriptionsSubscriptionExposedIdDiscount'] + } + '/v1/tax_codes': { /**

A list of all tax codes available to add to Products in order to allow specific tax calculations.

*/ - get: operations["GetTaxCodes"]; - }; - "/v1/tax_codes/{id}": { + get: operations['GetTaxCodes'] + } + '/v1/tax_codes/{id}': { /**

Retrieves the details of an existing tax code. Supply the unique tax code ID and Stripe will return the corresponding tax code information.

*/ - get: operations["GetTaxCodesId"]; - }; - "/v1/tax_rates": { + get: operations['GetTaxCodesId'] + } + '/v1/tax_rates': { /**

Returns a list of your tax rates. Tax rates are returned sorted by creation date, with the most recently created tax rates appearing first.

*/ - get: operations["GetTaxRates"]; + get: operations['GetTaxRates'] /**

Creates a new tax rate.

*/ - post: operations["PostTaxRates"]; - }; - "/v1/tax_rates/{tax_rate}": { + post: operations['PostTaxRates'] + } + '/v1/tax_rates/{tax_rate}': { /**

Retrieves a tax rate with the given ID

*/ - get: operations["GetTaxRatesTaxRate"]; + get: operations['GetTaxRatesTaxRate'] /**

Updates an existing tax rate.

*/ - post: operations["PostTaxRatesTaxRate"]; - }; - "/v1/terminal/connection_tokens": { + post: operations['PostTaxRatesTaxRate'] + } + '/v1/terminal/connection_tokens': { /**

To connect to a reader the Stripe Terminal SDK needs to retrieve a short-lived connection token from Stripe, proxied through your server. On your backend, add an endpoint that creates and returns a connection token.

*/ - post: operations["PostTerminalConnectionTokens"]; - }; - "/v1/terminal/locations": { + post: operations['PostTerminalConnectionTokens'] + } + '/v1/terminal/locations': { /**

Returns a list of Location objects.

*/ - get: operations["GetTerminalLocations"]; + get: operations['GetTerminalLocations'] /** *

Creates a new Location object. * For further details, including which address fields are required in each country, see the Manage locations guide.

*/ - post: operations["PostTerminalLocations"]; - }; - "/v1/terminal/locations/{location}": { + post: operations['PostTerminalLocations'] + } + '/v1/terminal/locations/{location}': { /**

Retrieves a Location object.

*/ - get: operations["GetTerminalLocationsLocation"]; + get: operations['GetTerminalLocationsLocation'] /**

Updates a Location object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ - post: operations["PostTerminalLocationsLocation"]; + post: operations['PostTerminalLocationsLocation'] /**

Deletes a Location object.

*/ - delete: operations["DeleteTerminalLocationsLocation"]; - }; - "/v1/terminal/readers": { + delete: operations['DeleteTerminalLocationsLocation'] + } + '/v1/terminal/readers': { /**

Returns a list of Reader objects.

*/ - get: operations["GetTerminalReaders"]; + get: operations['GetTerminalReaders'] /**

Creates a new Reader object.

*/ - post: operations["PostTerminalReaders"]; - }; - "/v1/terminal/readers/{reader}": { + post: operations['PostTerminalReaders'] + } + '/v1/terminal/readers/{reader}': { /**

Retrieves a Reader object.

*/ - get: operations["GetTerminalReadersReader"]; + get: operations['GetTerminalReadersReader'] /**

Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ - post: operations["PostTerminalReadersReader"]; + post: operations['PostTerminalReadersReader'] /**

Deletes a Reader object.

*/ - delete: operations["DeleteTerminalReadersReader"]; - }; - "/v1/tokens": { + delete: operations['DeleteTerminalReadersReader'] + } + '/v1/tokens': { /** *

Creates a single-use token that represents a bank account’s details. * This token can be used with any API method in place of a bank account dictionary. This token can be used only once, by attaching it to a Custom account.

*/ - post: operations["PostTokens"]; - }; - "/v1/tokens/{token}": { + post: operations['PostTokens'] + } + '/v1/tokens/{token}': { /**

Retrieves the token with the given ID.

*/ - get: operations["GetTokensToken"]; - }; - "/v1/topups": { + get: operations['GetTokensToken'] + } + '/v1/topups': { /**

Returns a list of top-ups.

*/ - get: operations["GetTopups"]; + get: operations['GetTopups'] /**

Top up the balance of an account

*/ - post: operations["PostTopups"]; - }; - "/v1/topups/{topup}": { + post: operations['PostTopups'] + } + '/v1/topups/{topup}': { /**

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.

*/ - get: operations["GetTopupsTopup"]; + get: operations['GetTopupsTopup'] /**

Updates the metadata of a top-up. Other top-up details are not editable by design.

*/ - post: operations["PostTopupsTopup"]; - }; - "/v1/topups/{topup}/cancel": { + post: operations['PostTopupsTopup'] + } + '/v1/topups/{topup}/cancel': { /**

Cancels a top-up. Only pending top-ups can be canceled.

*/ - post: operations["PostTopupsTopupCancel"]; - }; - "/v1/transfers": { + post: operations['PostTopupsTopupCancel'] + } + '/v1/transfers': { /**

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.

*/ - get: operations["GetTransfers"]; + get: operations['GetTransfers'] /**

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.

*/ - post: operations["PostTransfers"]; - }; - "/v1/transfers/{id}/reversals": { + post: operations['PostTransfers'] + } + '/v1/transfers/{id}/reversals': { /**

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.

*/ - get: operations["GetTransfersIdReversals"]; + get: operations['GetTransfersIdReversals'] /** *

When you create a new reversal, you must specify a transfer to create it on.

* @@ -1652,42 +1652,42 @@ export interface paths { * *

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.

*/ - post: operations["PostTransfersIdReversals"]; - }; - "/v1/transfers/{transfer}": { + post: operations['PostTransfersIdReversals'] + } + '/v1/transfers/{transfer}': { /**

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.

*/ - get: operations["GetTransfersTransfer"]; + get: operations['GetTransfersTransfer'] /** *

Updates the specified transfer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

* *

This request accepts only metadata as an argument.

*/ - post: operations["PostTransfersTransfer"]; - }; - "/v1/transfers/{transfer}/reversals/{id}": { + post: operations['PostTransfersTransfer'] + } + '/v1/transfers/{transfer}/reversals/{id}': { /**

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.

*/ - get: operations["GetTransfersTransferReversalsId"]; + get: operations['GetTransfersTransferReversalsId'] /** *

Updates the specified reversal by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

* *

This request only accepts metadata and description as arguments.

*/ - post: operations["PostTransfersTransferReversalsId"]; - }; - "/v1/webhook_endpoints": { + post: operations['PostTransfersTransferReversalsId'] + } + '/v1/webhook_endpoints': { /**

Returns a list of your webhook endpoints.

*/ - get: operations["GetWebhookEndpoints"]; + get: operations['GetWebhookEndpoints'] /**

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.

*/ - post: operations["PostWebhookEndpoints"]; - }; - "/v1/webhook_endpoints/{webhook_endpoint}": { + post: operations['PostWebhookEndpoints'] + } + '/v1/webhook_endpoints/{webhook_endpoint}': { /**

Retrieves the webhook endpoint with the given ID.

*/ - get: operations["GetWebhookEndpointsWebhookEndpoint"]; + get: operations['GetWebhookEndpointsWebhookEndpoint'] /**

Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.

*/ - post: operations["PostWebhookEndpointsWebhookEndpoint"]; + post: operations['PostWebhookEndpointsWebhookEndpoint'] /**

You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.

*/ - delete: operations["DeleteWebhookEndpointsWebhookEndpoint"]; - }; + delete: operations['DeleteWebhookEndpointsWebhookEndpoint'] + } } export interface components { @@ -1703,261 +1703,261 @@ export interface components { */ account: { /** @description Business information about the account. */ - business_profile?: Partial | null; + business_profile?: Partial | null /** * @description The business type. * @enum {string|null} */ - business_type?: ("company" | "government_entity" | "individual" | "non_profit") | null; - capabilities?: components["schemas"]["account_capabilities"]; + business_type?: ('company' | 'government_entity' | 'individual' | 'non_profit') | null + capabilities?: components['schemas']['account_capabilities'] /** @description Whether the account can create live charges. */ - charges_enabled?: boolean; - company?: components["schemas"]["legal_entity_company"]; - controller?: components["schemas"]["account_unification_account_controller"]; + charges_enabled?: boolean + company?: components['schemas']['legal_entity_company'] + controller?: components['schemas']['account_unification_account_controller'] /** @description The account's country. */ - country?: string; + country?: string /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created?: number; + created?: number /** @description 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?: string; + default_currency?: string /** @description Whether account details have been submitted. Standard accounts cannot receive payouts before this is true. */ - details_submitted?: boolean; + details_submitted?: boolean /** @description An email address associated with the account. You can treat this as metadata: it is not used for authentication or messaging account holders. */ - email?: string | null; + email?: string | null /** * ExternalAccountList * @description External accounts (bank accounts and debit cards) currently attached to this account */ external_accounts?: { /** @description The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards. */ - data: (Partial & Partial)[]; + data: (Partial & Partial)[] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - future_requirements?: components["schemas"]["account_future_requirements"]; + url: string + } + future_requirements?: components['schemas']['account_future_requirements'] /** @description Unique identifier for the object. */ - id: string; - individual?: components["schemas"]["person"]; + id: string + individual?: components['schemas']['person'] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "account"; + object: 'account' /** @description Whether Stripe can send payouts to this account. */ - payouts_enabled?: boolean; - requirements?: components["schemas"]["account_requirements"]; + payouts_enabled?: boolean + requirements?: components['schemas']['account_requirements'] /** @description Options for customizing how the account functions within Stripe. */ - settings?: Partial | null; - tos_acceptance?: components["schemas"]["account_tos_acceptance"]; + settings?: Partial | null + tos_acceptance?: components['schemas']['account_tos_acceptance'] /** * @description The Stripe account type. Can be `standard`, `express`, or `custom`. * @enum {string} */ - type?: "custom" | "express" | "standard"; - }; + type?: 'custom' | 'express' | 'standard' + } /** AccountBacsDebitPaymentsSettings */ account_bacs_debit_payments_settings: { /** @description The Bacs Direct Debit Display Name for this account. For payments made with Bacs Direct Debit, this will appear on the mandate, and as the statement descriptor. */ - display_name?: string; - }; + display_name?: string + } /** AccountBrandingSettings */ account_branding_settings: { /** @description (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?: (Partial & Partial) | null; + icon?: (Partial & Partial) | null /** @description (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?: (Partial & Partial) | null; + logo?: (Partial & Partial) | null /** @description A CSS hex color value representing the primary branding color for this account */ - primary_color?: string | null; + primary_color?: string | null /** @description A CSS hex color value representing the secondary branding color for this account */ - secondary_color?: string | null; - }; + secondary_color?: string | null + } /** AccountBusinessProfile */ account_business_profile: { /** @description [The merchant category code for the account](https://stripe.com/docs/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide. */ - mcc?: string | null; + mcc?: string | null /** @description The customer-facing business name. */ - name?: string | null; + name?: string | null /** @description 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?: string | null; + product_description?: string | null /** @description A publicly available mailing address for sending support issues to. */ - support_address?: Partial | null; + support_address?: Partial | null /** @description A publicly available email address for sending support issues to. */ - support_email?: string | null; + support_email?: string | null /** @description A publicly available phone number to call with support issues. */ - support_phone?: string | null; + support_phone?: string | null /** @description A publicly available website for handling support issues. */ - support_url?: string | null; + support_url?: string | null /** @description The business's publicly available website. */ - url?: string | null; - }; + url?: string | null + } /** AccountCapabilities */ account_capabilities: { /** * @description 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. * @enum {string} */ - acss_debit_payments?: "active" | "inactive" | "pending"; + acss_debit_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the Afterpay Clearpay capability of the account, or whether the account can directly process Afterpay Clearpay charges. * @enum {string} */ - afterpay_clearpay_payments?: "active" | "inactive" | "pending"; + afterpay_clearpay_payments?: 'active' | 'inactive' | 'pending' /** * @description 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. * @enum {string} */ - au_becs_debit_payments?: "active" | "inactive" | "pending"; + au_becs_debit_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the Bacs Direct Debits payments capability of the account, or whether the account can directly process Bacs Direct Debits charges. * @enum {string} */ - bacs_debit_payments?: "active" | "inactive" | "pending"; + bacs_debit_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the Bancontact payments capability of the account, or whether the account can directly process Bancontact charges. * @enum {string} */ - bancontact_payments?: "active" | "inactive" | "pending"; + bancontact_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the boleto payments capability of the account, or whether the account can directly process boleto charges. * @enum {string} */ - boleto_payments?: "active" | "inactive" | "pending"; + boleto_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the card issuing capability of the account, or whether you can use Issuing to distribute funds on cards * @enum {string} */ - card_issuing?: "active" | "inactive" | "pending"; + card_issuing?: 'active' | 'inactive' | 'pending' /** * @description The status of the card payments capability of the account, or whether the account can directly process credit and debit card charges. * @enum {string} */ - card_payments?: "active" | "inactive" | "pending"; + card_payments?: 'active' | 'inactive' | 'pending' /** * @description 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. * @enum {string} */ - cartes_bancaires_payments?: "active" | "inactive" | "pending"; + cartes_bancaires_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the EPS payments capability of the account, or whether the account can directly process EPS charges. * @enum {string} */ - eps_payments?: "active" | "inactive" | "pending"; + eps_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the FPX payments capability of the account, or whether the account can directly process FPX charges. * @enum {string} */ - fpx_payments?: "active" | "inactive" | "pending"; + fpx_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the giropay payments capability of the account, or whether the account can directly process giropay charges. * @enum {string} */ - giropay_payments?: "active" | "inactive" | "pending"; + giropay_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the GrabPay payments capability of the account, or whether the account can directly process GrabPay charges. * @enum {string} */ - grabpay_payments?: "active" | "inactive" | "pending"; + grabpay_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the iDEAL payments capability of the account, or whether the account can directly process iDEAL charges. * @enum {string} */ - ideal_payments?: "active" | "inactive" | "pending"; + ideal_payments?: 'active' | 'inactive' | 'pending' /** * @description 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. * @enum {string} */ - jcb_payments?: "active" | "inactive" | "pending"; + jcb_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the Klarna payments capability of the account, or whether the account can directly process Klarna charges. * @enum {string} */ - klarna_payments?: "active" | "inactive" | "pending"; + klarna_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the legacy payments capability of the account. * @enum {string} */ - legacy_payments?: "active" | "inactive" | "pending"; + legacy_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the OXXO payments capability of the account, or whether the account can directly process OXXO charges. * @enum {string} */ - oxxo_payments?: "active" | "inactive" | "pending"; + oxxo_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the P24 payments capability of the account, or whether the account can directly process P24 charges. * @enum {string} */ - p24_payments?: "active" | "inactive" | "pending"; + p24_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the SEPA Direct Debits payments capability of the account, or whether the account can directly process SEPA Direct Debits charges. * @enum {string} */ - sepa_debit_payments?: "active" | "inactive" | "pending"; + sepa_debit_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the Sofort payments capability of the account, or whether the account can directly process Sofort charges. * @enum {string} */ - sofort_payments?: "active" | "inactive" | "pending"; + sofort_payments?: 'active' | 'inactive' | 'pending' /** * @description The status of the tax reporting 1099-K (US) capability of the account. * @enum {string} */ - tax_reporting_us_1099_k?: "active" | "inactive" | "pending"; + tax_reporting_us_1099_k?: 'active' | 'inactive' | 'pending' /** * @description The status of the tax reporting 1099-MISC (US) capability of the account. * @enum {string} */ - tax_reporting_us_1099_misc?: "active" | "inactive" | "pending"; + tax_reporting_us_1099_misc?: 'active' | 'inactive' | 'pending' /** * @description The status of the transfers capability of the account, or whether your platform can transfer funds to the account. * @enum {string} */ - transfers?: "active" | "inactive" | "pending"; - }; + transfers?: 'active' | 'inactive' | 'pending' + } /** AccountCapabilityFutureRequirements */ account_capability_future_requirements: { /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ - alternatives?: components["schemas"]["account_requirements_alternative"][] | null; + alternatives?: components['schemas']['account_requirements_alternative'][] | null /** * Format: unix-time * @description Date on which `future_requirements` merges with 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?: number | null; + current_deadline?: number | null /** @description 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: string[]; + currently_due: string[] /** @description This is typed as a string for consistency with `requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is empty because fields in `future_requirements` will never disable the account. */ - disabled_reason?: string | null; + disabled_reason?: string | null /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ - errors: components["schemas"]["account_requirements_error"][]; + errors: components['schemas']['account_requirements_error'][] /** @description Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well. */ - eventually_due: string[]; + eventually_due: string[] /** @description 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: string[]; + past_due: string[] /** @description Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. */ - pending_verification: string[]; - }; + pending_verification: string[] + } /** AccountCapabilityRequirements */ account_capability_requirements: { /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ - alternatives?: components["schemas"]["account_requirements_alternative"][] | null; + alternatives?: components['schemas']['account_requirements_alternative'][] | null /** * Format: unix-time * @description 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?: number | null; + current_deadline?: number | null /** @description 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: string[]; + currently_due: string[] /** * @description If the capability is disabled, this string describes why. Can be `requirements.past_due`, `requirements.pending_verification`, `listed`, `platform_paused`, `rejected.fraud`, `rejected.listed`, `rejected.terms_of_service`, `rejected.other`, `under_review`, or `other`. * @@ -1967,62 +1967,62 @@ export interface components { * * If you believe that the rejection is in error, please contact support at https://support.stripe.com/contact/ for assistance. */ - disabled_reason?: string | null; + disabled_reason?: string | null /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ - errors: components["schemas"]["account_requirements_error"][]; + errors: components['schemas']['account_requirements_error'][] /** @description Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set. */ - eventually_due: string[]; + eventually_due: string[] /** @description Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the capability on the account. */ - past_due: string[]; + past_due: string[] /** @description Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. */ - pending_verification: string[]; - }; + pending_verification: string[] + } /** AccountCardIssuingSettings */ account_card_issuing_settings: { - tos_acceptance?: components["schemas"]["card_issuing_account_terms_of_service"]; - }; + tos_acceptance?: components['schemas']['card_issuing_account_terms_of_service'] + } /** AccountCardPaymentsSettings */ account_card_payments_settings: { - decline_on?: components["schemas"]["account_decline_charge_on"]; + decline_on?: components['schemas']['account_decline_charge_on'] /** @description 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?: string | null; - }; + statement_descriptor_prefix?: string | null + } /** AccountDashboardSettings */ account_dashboard_settings: { /** @description The display name for this account. This is used on the Stripe Dashboard to differentiate between accounts. */ - display_name?: string | null; + display_name?: string | null /** @description 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?: string | null; - }; + timezone?: string | null + } /** AccountDeclineChargeOn */ account_decline_charge_on: { /** @description 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: boolean; + avs_failure: boolean /** @description 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: boolean; - }; + cvc_failure: boolean + } /** AccountFutureRequirements */ account_future_requirements: { /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ - alternatives?: components["schemas"]["account_requirements_alternative"][] | null; + alternatives?: components['schemas']['account_requirements_alternative'][] | null /** * Format: unix-time * @description Date on which `future_requirements` merges with 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?: number | null; + current_deadline?: number | null /** @description 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?: string[] | null; + currently_due?: string[] | null /** @description This is typed as a string for consistency with `requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is empty because fields in `future_requirements` will never disable the account. */ - disabled_reason?: string | null; + disabled_reason?: string | null /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ - errors?: components["schemas"]["account_requirements_error"][] | null; + errors?: components['schemas']['account_requirements_error'][] | null /** @description Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well. */ - eventually_due?: string[] | null; + eventually_due?: string[] | null /** @description 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?: string[] | null; + past_due?: string[] | null /** @description Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. */ - pending_verification?: string[] | null; - }; + pending_verification?: string[] | null + } /** * AccountLink * @description Account Links are the means by which a Connect platform grants a connected account permission to access @@ -2035,66 +2035,66 @@ export interface components { * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** * Format: unix-time * @description The timestamp at which this account link will expire. */ - expires_at: number; + expires_at: number /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "account_link"; + object: 'account_link' /** @description The URL for the account link. */ - url: string; - }; + url: string + } /** AccountPaymentsSettings */ account_payments_settings: { /** @description 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?: string | null; + statement_descriptor?: string | null /** @description The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only) */ - statement_descriptor_kana?: string | null; + statement_descriptor_kana?: string | null /** @description The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only) */ - statement_descriptor_kanji?: string | null; - }; + statement_descriptor_kanji?: string | null + } /** AccountPayoutSettings */ account_payout_settings: { /** @description A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See our [Understanding Connect Account Balances](https://stripe.com/docs/connect/account-balances) documentation for details. Default value is `false` for Custom accounts, otherwise `true`. */ - debit_negative_balances: boolean; - schedule: components["schemas"]["transfer_schedule"]; + debit_negative_balances: boolean + schedule: components['schemas']['transfer_schedule'] /** @description 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?: string | null; - }; + statement_descriptor?: string | null + } /** AccountRequirements */ account_requirements: { /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ - alternatives?: components["schemas"]["account_requirements_alternative"][] | null; + alternatives?: components['schemas']['account_requirements_alternative'][] | null /** * Format: unix-time * @description 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?: number | null; + current_deadline?: number | null /** @description 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?: string[] | null; + currently_due?: string[] | null /** @description If the account is disabled, this string describes why. Can be `requirements.past_due`, `requirements.pending_verification`, `listed`, `platform_paused`, `rejected.fraud`, `rejected.listed`, `rejected.terms_of_service`, `rejected.other`, `under_review`, or `other`. */ - disabled_reason?: string | null; + disabled_reason?: string | null /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ - errors?: components["schemas"]["account_requirements_error"][] | null; + errors?: components['schemas']['account_requirements_error'][] | null /** @description Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set. */ - eventually_due?: string[] | null; + eventually_due?: string[] | null /** @description Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the account. */ - past_due?: string[] | null; + past_due?: string[] | null /** @description Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. */ - pending_verification?: string[] | null; - }; + pending_verification?: string[] | null + } /** AccountRequirementsAlternative */ account_requirements_alternative: { /** @description Fields that can be provided to satisfy all fields in `original_fields_due`. */ - alternative_fields_due: string[]; + alternative_fields_due: string[] /** @description Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`. */ - original_fields_due: string[]; - }; + original_fields_due: string[] + } /** AccountRequirementsError */ account_requirements_error: { /** @@ -2102,269 +2102,263 @@ export interface components { * @enum {string} */ code: - | "invalid_address_city_state_postal_code" - | "invalid_street_address" - | "invalid_value_other" - | "verification_document_address_mismatch" - | "verification_document_address_missing" - | "verification_document_corrupt" - | "verification_document_country_not_supported" - | "verification_document_dob_mismatch" - | "verification_document_duplicate_type" - | "verification_document_expired" - | "verification_document_failed_copy" - | "verification_document_failed_greyscale" - | "verification_document_failed_other" - | "verification_document_failed_test_mode" - | "verification_document_fraudulent" - | "verification_document_id_number_mismatch" - | "verification_document_id_number_missing" - | "verification_document_incomplete" - | "verification_document_invalid" - | "verification_document_issue_or_expiry_date_missing" - | "verification_document_manipulated" - | "verification_document_missing_back" - | "verification_document_missing_front" - | "verification_document_name_mismatch" - | "verification_document_name_missing" - | "verification_document_nationality_mismatch" - | "verification_document_not_readable" - | "verification_document_not_signed" - | "verification_document_not_uploaded" - | "verification_document_photo_mismatch" - | "verification_document_too_large" - | "verification_document_type_not_supported" - | "verification_failed_address_match" - | "verification_failed_business_iec_number" - | "verification_failed_document_match" - | "verification_failed_id_number_match" - | "verification_failed_keyed_identity" - | "verification_failed_keyed_match" - | "verification_failed_name_match" - | "verification_failed_other" - | "verification_failed_tax_id_match" - | "verification_failed_tax_id_not_issued" - | "verification_missing_executives" - | "verification_missing_owners" - | "verification_requires_additional_memorandum_of_associations"; + | 'invalid_address_city_state_postal_code' + | 'invalid_street_address' + | 'invalid_value_other' + | 'verification_document_address_mismatch' + | 'verification_document_address_missing' + | 'verification_document_corrupt' + | 'verification_document_country_not_supported' + | 'verification_document_dob_mismatch' + | 'verification_document_duplicate_type' + | 'verification_document_expired' + | 'verification_document_failed_copy' + | 'verification_document_failed_greyscale' + | 'verification_document_failed_other' + | 'verification_document_failed_test_mode' + | 'verification_document_fraudulent' + | 'verification_document_id_number_mismatch' + | 'verification_document_id_number_missing' + | 'verification_document_incomplete' + | 'verification_document_invalid' + | 'verification_document_issue_or_expiry_date_missing' + | 'verification_document_manipulated' + | 'verification_document_missing_back' + | 'verification_document_missing_front' + | 'verification_document_name_mismatch' + | 'verification_document_name_missing' + | 'verification_document_nationality_mismatch' + | 'verification_document_not_readable' + | 'verification_document_not_signed' + | 'verification_document_not_uploaded' + | 'verification_document_photo_mismatch' + | 'verification_document_too_large' + | 'verification_document_type_not_supported' + | 'verification_failed_address_match' + | 'verification_failed_business_iec_number' + | 'verification_failed_document_match' + | 'verification_failed_id_number_match' + | 'verification_failed_keyed_identity' + | 'verification_failed_keyed_match' + | 'verification_failed_name_match' + | 'verification_failed_other' + | 'verification_failed_tax_id_match' + | 'verification_failed_tax_id_not_issued' + | 'verification_missing_executives' + | 'verification_missing_owners' + | 'verification_requires_additional_memorandum_of_associations' /** @description An informative message that indicates the error type and provides additional details about the error. */ - reason: string; + reason: string /** @description The specific user onboarding requirement field (in the requirements hash) that needs to be resolved. */ - requirement: string; - }; + requirement: string + } /** AccountSepaDebitPaymentsSettings */ account_sepa_debit_payments_settings: { /** @description SEPA creditor identifier that identifies the company making the payment. */ - creditor_id?: string; - }; + creditor_id?: string + } /** AccountSettings */ account_settings: { - bacs_debit_payments?: components["schemas"]["account_bacs_debit_payments_settings"]; - branding: components["schemas"]["account_branding_settings"]; - card_issuing?: components["schemas"]["account_card_issuing_settings"]; - card_payments: components["schemas"]["account_card_payments_settings"]; - dashboard: components["schemas"]["account_dashboard_settings"]; - payments: components["schemas"]["account_payments_settings"]; - payouts?: components["schemas"]["account_payout_settings"]; - sepa_debit_payments?: components["schemas"]["account_sepa_debit_payments_settings"]; - }; + bacs_debit_payments?: components['schemas']['account_bacs_debit_payments_settings'] + branding: components['schemas']['account_branding_settings'] + card_issuing?: components['schemas']['account_card_issuing_settings'] + card_payments: components['schemas']['account_card_payments_settings'] + dashboard: components['schemas']['account_dashboard_settings'] + payments: components['schemas']['account_payments_settings'] + payouts?: components['schemas']['account_payout_settings'] + sepa_debit_payments?: components['schemas']['account_sepa_debit_payments_settings'] + } /** AccountTOSAcceptance */ account_tos_acceptance: { /** * Format: unix-time * @description The Unix timestamp marking when the account representative accepted their service agreement */ - date?: number | null; + date?: number | null /** @description The IP address from which the account representative accepted their service agreement */ - ip?: string | null; + ip?: string | null /** @description The user's service agreement type */ - service_agreement?: string; + service_agreement?: string /** @description The user agent of the browser from which the account representative accepted their service agreement */ - user_agent?: string | null; - }; + user_agent?: string | null + } /** AccountUnificationAccountController */ account_unification_account_controller: { /** @description `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?: boolean; + is_controller?: boolean /** * @description The controller type. Can be `application`, if a Connect application controls the account, or `account`, if the account controls itself. * @enum {string} */ - type: "account" | "application"; - }; + type: 'account' | 'application' + } /** Address */ address: { /** @description City, district, suburb, town, or village. */ - city?: string | null; + city?: string | null /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ - country?: string | null; + country?: string | null /** @description Address line 1 (e.g., street, PO Box, or company name). */ - line1?: string | null; + line1?: string | null /** @description Address line 2 (e.g., apartment, suite, unit, or building). */ - line2?: string | null; + line2?: string | null /** @description ZIP or postal code. */ - postal_code?: string | null; + postal_code?: string | null /** @description State, county, province, or region. */ - state?: string | null; - }; + state?: string | null + } /** AlipayAccount */ alipay_account: { /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The ID of the customer associated with this Alipay Account. */ - customer?: - | (Partial & - Partial & - Partial) - | null; + customer?: (Partial & Partial & Partial) | null /** @description Uniquely identifies the account and will be the same across all Alipay account objects that are linked to the same Alipay account. */ - fingerprint: string; + fingerprint: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "alipay_account"; + object: 'alipay_account' /** @description If the Alipay account object is not reusable, the exact amount that you can create a charge for. */ - payment_amount?: number | null; + payment_amount?: number | null /** @description If the Alipay account object is not reusable, the exact currency that you can create a charge for. */ - payment_currency?: string | null; + payment_currency?: string | null /** @description True if you can create multiple payments using this account. If the account is reusable, then you can freely choose the amount of each payment. */ - reusable: boolean; + reusable: boolean /** @description Whether this Alipay account object has ever been used for a payment. */ - used: boolean; + used: boolean /** @description The username for the Alipay account. */ - username: string; - }; + username: string + } /** APIErrors */ api_errors: { /** @description For card errors, the ID of the failed charge. */ - charge?: string; + charge?: string /** @description For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported. */ - code?: string; + code?: string /** @description 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?: string; + decline_code?: string /** @description A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported. */ - doc_url?: string; + doc_url?: string /** @description A human-readable message providing more details about the error. For card errors, these messages can be shown to your users. */ - message?: string; + message?: string /** @description 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?: string; - payment_intent?: components["schemas"]["payment_intent"]; - payment_method?: components["schemas"]["payment_method"]; + param?: string + payment_intent?: components['schemas']['payment_intent'] + payment_method?: components['schemas']['payment_method'] /** @description 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?: string; - setup_intent?: components["schemas"]["setup_intent"]; + payment_method_type?: string + setup_intent?: components['schemas']['setup_intent'] /** @description The source object for errors returned on a request involving a source. */ - source?: Partial & - Partial & - Partial; + source?: Partial & Partial & Partial /** * @description The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error` * @enum {string} */ - type: "api_error" | "card_error" | "idempotency_error" | "invalid_request_error"; - }; + type: 'api_error' | 'card_error' | 'idempotency_error' | 'invalid_request_error' + } /** ApplePayDomain */ apple_pay_domain: { /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; - domain_name: string; + created: number + domain_name: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "apple_pay_domain"; - }; + object: 'apple_pay_domain' + } /** Application */ application: { /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The name of the application. */ - name?: string | null; + name?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "application"; - }; + object: 'application' + } /** PlatformFee */ application_fee: { /** @description ID of the Stripe account this fee was taken from. */ - account: Partial & Partial; + account: Partial & Partial /** @description Amount earned, in %s. */ - amount: number; + amount: number /** @description Amount in %s refunded (can be less than the amount attribute on the fee if a partial refund was issued) */ - amount_refunded: number; + amount_refunded: number /** @description ID of the Connect application that earned the fee. */ - application: Partial & Partial; + application: Partial & Partial /** @description Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds). */ - balance_transaction?: (Partial & Partial) | null; + balance_transaction?: (Partial & Partial) | null /** @description ID of the charge that the application fee was taken from. */ - charge: Partial & Partial; + charge: Partial & Partial /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "application_fee"; + object: 'application_fee' /** @description ID of the corresponding charge on the platform account, if this fee was the result of a charge using the `destination` parameter. */ - originating_transaction?: (Partial & Partial) | null; + originating_transaction?: (Partial & Partial) | null /** @description Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false. */ - refunded: boolean; + refunded: boolean /** * FeeRefundList * @description A list of refunds that have been applied to the fee. */ refunds: { /** @description Details about each object. */ - data: components["schemas"]["fee_refund"][]; + data: components['schemas']['fee_refund'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** AutomaticTax */ automatic_tax: { /** @description Whether Stripe automatically computes tax on this invoice. */ - enabled: boolean; + enabled: boolean /** * @description The status of the most recent automated tax calculation for this invoice. * @enum {string|null} */ - status?: ("complete" | "failed" | "requires_location_inputs") | null; - }; + status?: ('complete' | 'failed' | 'requires_location_inputs') | null + } /** * Balance * @description This is an object representing your Stripe balance. You can retrieve it to see @@ -2381,44 +2375,44 @@ export interface components { */ balance: { /** @description Funds that are available to be transferred or paid out, whether automatically by Stripe or explicitly via the [Transfers API](https://stripe.com/docs/api#transfers) or [Payouts API](https://stripe.com/docs/api#payouts). The available balance for each currency and payment type can be found in the `source_types` property. */ - available: components["schemas"]["balance_amount"][]; + available: components['schemas']['balance_amount'][] /** @description Funds held due to negative balances on connected Custom accounts. The connect reserve balance for each currency and payment type can be found in the `source_types` property. */ - connect_reserved?: components["schemas"]["balance_amount"][]; + connect_reserved?: components['schemas']['balance_amount'][] /** @description Funds that can be paid out using Instant Payouts. */ - instant_available?: components["schemas"]["balance_amount"][]; - issuing?: components["schemas"]["balance_detail"]; + instant_available?: components['schemas']['balance_amount'][] + issuing?: components['schemas']['balance_detail'] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "balance"; + object: 'balance' /** @description Funds that are not yet available in the balance, due to the 7-day rolling pay cycle. The pending balance for each currency, and for each payment type, can be found in the `source_types` property. */ - pending: components["schemas"]["balance_amount"][]; - }; + pending: components['schemas']['balance_amount'][] + } /** BalanceAmount */ balance_amount: { /** @description Balance amount. */ - amount: number; + amount: number /** @description 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: string; - source_types?: components["schemas"]["balance_amount_by_source_type"]; - }; + currency: string + source_types?: components['schemas']['balance_amount_by_source_type'] + } /** BalanceAmountBySourceType */ balance_amount_by_source_type: { /** @description Amount for bank account. */ - bank_account?: number; + bank_account?: number /** @description Amount for card. */ - card?: number; + card?: number /** @description Amount for FPX. */ - fpx?: number; - }; + fpx?: number + } /** BalanceDetail */ balance_detail: { /** @description Funds that are available for use. */ - available: components["schemas"]["balance_amount"][]; - }; + available: components['schemas']['balance_amount'][] + } /** * BalanceTransaction * @description Balance transactions represent funds moving through your Stripe account. @@ -2428,98 +2422,98 @@ export interface components { */ balance_transaction: { /** @description Gross amount of the transaction, in %s. */ - amount: number; + amount: number /** * Format: unix-time * @description The date the transaction's net funds will become available in the Stripe balance. */ - available_on: number; + available_on: number /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description The exchange rate used, if applicable, for this transaction. Specifically, if money was converted from currency A to currency B, then the `amount` in currency A, times `exchange_rate`, would be the `amount` in currency B. For example, suppose you charged a customer 10.00 EUR. Then the PaymentIntent's `amount` would be `1000` and `currency` would be `eur`. Suppose this was converted into 12.34 USD in your Stripe account. Then the BalanceTransaction's `amount` would be `1234`, `currency` would be `usd`, and `exchange_rate` would be `1.234`. */ - exchange_rate?: number | null; + exchange_rate?: number | null /** @description Fees (in %s) paid for this transaction. */ - fee: number; + fee: number /** @description Detailed breakdown of fees (in %s) paid for this transaction. */ - fee_details: components["schemas"]["fee"][]; + fee_details: components['schemas']['fee'][] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Net amount of the transaction, in %s. */ - net: number; + net: number /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "balance_transaction"; + object: 'balance_transaction' /** @description [Learn more](https://stripe.com/docs/reports/reporting-categories) about how reporting categories can help you understand balance transactions from an accounting perspective. */ - reporting_category: string; + reporting_category: string /** @description The Stripe object to which this transaction is related. */ source?: | (Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial & - Partial) - | null; + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial & + Partial) + | null /** @description If the transaction's net funds are available in the Stripe balance yet. Either `available` or `pending`. */ - status: string; + status: string /** * @description Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `payment`, `payment_failure_refund`, `payment_refund`, `payout`, `payout_cancel`, `payout_failure`, `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](https://stripe.com/docs/reports/balance-transaction-types) about balance transaction types and what they represent. If you are looking to classify transactions for accounting purposes, you might want to consider `reporting_category` instead. * @enum {string} */ type: - | "adjustment" - | "advance" - | "advance_funding" - | "anticipation_repayment" - | "application_fee" - | "application_fee_refund" - | "charge" - | "connect_collection_transfer" - | "contribution" - | "issuing_authorization_hold" - | "issuing_authorization_release" - | "issuing_dispute" - | "issuing_transaction" - | "payment" - | "payment_failure_refund" - | "payment_refund" - | "payout" - | "payout_cancel" - | "payout_failure" - | "refund" - | "refund_failure" - | "reserve_transaction" - | "reserved_funds" - | "stripe_fee" - | "stripe_fx_fee" - | "tax_fee" - | "topup" - | "topup_reversal" - | "transfer" - | "transfer_cancel" - | "transfer_failure" - | "transfer_refund"; - }; + | 'adjustment' + | 'advance' + | 'advance_funding' + | 'anticipation_repayment' + | 'application_fee' + | 'application_fee_refund' + | 'charge' + | 'connect_collection_transfer' + | 'contribution' + | 'issuing_authorization_hold' + | 'issuing_authorization_release' + | 'issuing_dispute' + | 'issuing_transaction' + | 'payment' + | 'payment_failure_refund' + | 'payment_refund' + | 'payout' + | 'payout_cancel' + | 'payout_failure' + | 'refund' + | 'refund_failure' + | 'reserve_transaction' + | 'reserved_funds' + | 'stripe_fee' + | 'stripe_fx_fee' + | 'tax_fee' + | 'topup' + | 'topup_reversal' + | 'transfer' + | 'transfer_cancel' + | 'transfer_failure' + | 'transfer_refund' + } /** * BankAccount * @description These bank accounts are payment methods on `Customer` objects. @@ -2532,99 +2526,95 @@ export interface components { */ bank_account: { /** @description The ID of the account that the bank account is associated with. */ - account?: (Partial & Partial) | null; + account?: (Partial & Partial) | null /** @description The name of the person or business that owns the bank account. */ - account_holder_name?: string | null; + account_holder_name?: string | null /** @description The type of entity that holds the account. This can be either `individual` or `company`. */ - account_holder_type?: string | null; + account_holder_type?: string | null /** @description 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?: string | null; + account_type?: string | null /** @description 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?: ("instant" | "standard")[] | null; + available_payout_methods?: ('instant' | 'standard')[] | null /** @description Name of the bank associated with the routing number (e.g., `WELLS FARGO`). */ - bank_name?: string | null; + bank_name?: string | null /** @description Two-letter ISO code representing the country the bank account is located in. */ - country: string; + country: string /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. */ - currency: string; + currency: string /** @description The ID of the customer that the bank account is associated with. */ - customer?: - | (Partial & - Partial & - Partial) - | null; + customer?: (Partial & Partial & Partial) | null /** @description Whether this bank account is the default external account for its currency. */ - default_for_currency?: boolean | null; + default_for_currency?: boolean | null /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The last four digits of the bank account number. */ - last4: string; + last4: string /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "bank_account"; + object: 'bank_account' /** @description The routing transit number for the bank account. */ - routing_number?: string | null; + routing_number?: string | null /** * @description For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a transfer sent to this bank account fails, we'll set the status to `errored` and will not continue to send transfers until the bank details are updated. * * For external accounts, possible values are `new` and `errored`. Validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply. If a transfer fails, the status is set to `errored` and transfers are stopped until account details are updated. */ - status: string; - }; + status: string + } /** billing_details */ billing_details: { /** @description Billing address. */ - address?: Partial | null; + address?: Partial | null /** @description Email address. */ - email?: string | null; + email?: string | null /** @description Full name. */ - name?: string | null; + name?: string | null /** @description Billing phone number (including extension). */ - phone?: string | null; - }; + phone?: string | null + } /** * PortalConfiguration * @description A portal configuration describes the functionality and behavior of a portal session. */ - "billing_portal.configuration": { + 'billing_portal.configuration': { /** @description Whether the configuration is active and can be used to create portal sessions. */ - active: boolean; + active: boolean /** @description ID of the Connect Application that created the configuration. */ - application?: string | null; - business_profile: components["schemas"]["portal_business_profile"]; + application?: string | null + business_profile: components['schemas']['portal_business_profile'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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?: string | null; - features: components["schemas"]["portal_features"]; + default_return_url?: string | null + features: components['schemas']['portal_features'] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description 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: boolean; + is_default: boolean /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "billing_portal.configuration"; + object: 'billing_portal.configuration' /** * Format: unix-time * @description Time at which the object was last updated. Measured in seconds since the Unix epoch. */ - updated: number; - }; + updated: number + } /** * PortalSession * @description The Billing customer portal is a Stripe-hosted UI for subscription and @@ -2642,178 +2632,178 @@ export interface components { * * Learn more in the [integration guide](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal). */ - "billing_portal.session": { + 'billing_portal.session': { /** @description The configuration used by this session, describing the features available. */ - configuration: Partial & Partial; + configuration: Partial & Partial /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The ID of the customer for this session. */ - customer: string; + customer: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description 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. * @enum {string|null} */ locale?: | ( - | "auto" - | "bg" - | "cs" - | "da" - | "de" - | "el" - | "en" - | "en-AU" - | "en-CA" - | "en-GB" - | "en-IE" - | "en-IN" - | "en-NZ" - | "en-SG" - | "es" - | "es-419" - | "et" - | "fi" - | "fil" - | "fr" - | "fr-CA" - | "hr" - | "hu" - | "id" - | "it" - | "ja" - | "ko" - | "lt" - | "lv" - | "ms" - | "mt" - | "nb" - | "nl" - | "pl" - | "pt" - | "pt-BR" - | "ro" - | "ru" - | "sk" - | "sl" - | "sv" - | "th" - | "tr" - | "vi" - | "zh" - | "zh-HK" - | "zh-TW" + | 'auto' + | 'bg' + | 'cs' + | 'da' + | 'de' + | 'el' + | 'en' + | 'en-AU' + | 'en-CA' + | 'en-GB' + | 'en-IE' + | 'en-IN' + | 'en-NZ' + | 'en-SG' + | 'es' + | 'es-419' + | 'et' + | 'fi' + | 'fil' + | 'fr' + | 'fr-CA' + | 'hr' + | 'hu' + | 'id' + | 'it' + | 'ja' + | 'ko' + | 'lt' + | 'lv' + | 'ms' + | 'mt' + | 'nb' + | 'nl' + | 'pl' + | 'pt' + | 'pt-BR' + | 'ro' + | 'ru' + | 'sk' + | 'sl' + | 'sv' + | 'th' + | 'tr' + | 'vi' + | 'zh' + | 'zh-HK' + | 'zh-TW' ) - | null; + | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "billing_portal.session"; + object: 'billing_portal.session' /** @description 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/charges-transfers#on-behalf-of). 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?: string | null; + on_behalf_of?: string | null /** @description The URL to redirect customers to when they click on the portal's link to return to your website. */ - return_url: string; + return_url: string /** @description The short-lived URL of the session that gives customers access to the customer portal. */ - url: string; - }; + url: string + } /** BitcoinReceiver */ bitcoin_receiver: { /** @description True when this bitcoin receiver has received a non-zero amount of bitcoin. */ - active: boolean; + active: boolean /** @description The amount of `currency` that you are collecting as payment. */ - amount: number; + amount: number /** @description The amount of `currency` to which `bitcoin_amount_received` has been converted. */ - amount_received: number; + amount_received: number /** @description The amount of bitcoin that the customer should send to fill the receiver. The `bitcoin_amount` is denominated in Satoshi: there are 10^8 Satoshi in one bitcoin. */ - bitcoin_amount: number; + bitcoin_amount: number /** @description The amount of bitcoin that has been sent by the customer to this receiver. */ - bitcoin_amount_received: number; + bitcoin_amount_received: number /** @description This URI can be displayed to the customer as a clickable link (to activate their bitcoin client) or as a QR code (for mobile wallets). */ - bitcoin_uri: string; + bitcoin_uri: string /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) to which the bitcoin will be converted. */ - currency: string; + currency: string /** @description The customer ID of the bitcoin receiver. */ - customer?: string | null; + customer?: string | null /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description The customer's email address, set by the API call that creates the receiver. */ - email?: string | null; + email?: string | null /** @description This flag is initially false and updates to true when the customer sends the `bitcoin_amount` to this receiver. */ - filled: boolean; + filled: boolean /** @description Unique identifier for the object. */ - id: string; + id: string /** @description A bitcoin address that is specific to this receiver. The customer can send bitcoin to this address to fill the receiver. */ - inbound_address: string; + inbound_address: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "bitcoin_receiver"; + object: 'bitcoin_receiver' /** @description The ID of the payment created from the receiver, if any. Hidden when viewing the receiver with a publishable key. */ - payment?: string | null; + payment?: string | null /** @description The refund address of this bitcoin receiver. */ - refund_address?: string | null; + refund_address?: string | null /** * BitcoinTransactionList * @description A list with one entry for each time that the customer sent bitcoin to the receiver. Hidden when viewing the receiver with a publishable key. */ transactions?: { /** @description Details about each object. */ - data: components["schemas"]["bitcoin_transaction"][]; + data: components['schemas']['bitcoin_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** @description This receiver contains uncaptured funds that can be used for a payment or refunded. */ - uncaptured_funds: boolean; + uncaptured_funds: boolean /** @description Indicate if this source is used for payment. */ - used_for_payment?: boolean | null; - }; + used_for_payment?: boolean | null + } /** BitcoinTransaction */ bitcoin_transaction: { /** @description The amount of `currency` that the transaction was converted to in real-time. */ - amount: number; + amount: number /** @description The amount of bitcoin contained in the transaction. */ - bitcoin_amount: number; + bitcoin_amount: number /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) to which this transaction was converted. */ - currency: string; + currency: string /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "bitcoin_transaction"; + object: 'bitcoin_transaction' /** @description The receiver to which this transaction was sent. */ - receiver: string; - }; + receiver: string + } /** * AccountCapability * @description This is an object representing a capability for a Stripe account. @@ -2822,29 +2812,29 @@ export interface components { */ capability: { /** @description The account for which the capability enables functionality. */ - account: Partial & Partial; - future_requirements?: components["schemas"]["account_capability_future_requirements"]; + account: Partial & Partial + future_requirements?: components['schemas']['account_capability_future_requirements'] /** @description The identifier for the capability. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "capability"; + object: 'capability' /** @description Whether the capability has been requested. */ - requested: boolean; + requested: boolean /** * Format: unix-time * @description Time at which the capability was requested. Measured in seconds since the Unix epoch. */ - requested_at?: number | null; - requirements?: components["schemas"]["account_capability_requirements"]; + requested_at?: number | null + requirements?: components['schemas']['account_capability_requirements'] /** * @description The status of the capability. Can be `active`, `inactive`, `pending`, or `unrequested`. * @enum {string} */ - status: "active" | "disabled" | "inactive" | "pending" | "unrequested"; - }; + status: 'active' | 'disabled' | 'inactive' | 'pending' | 'unrequested' + } /** * Card * @description You can store multiple cards on a customer in order to charge the customer @@ -2855,90 +2845,86 @@ export interface components { */ card: { /** @description 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. */ - account?: (Partial & Partial) | null; + account?: (Partial & Partial) | null /** @description City/District/Suburb/Town/Village. */ - address_city?: string | null; + address_city?: string | null /** @description Billing address country, if provided when creating card. */ - address_country?: string | null; + address_country?: string | null /** @description Address line 1 (Street address/PO Box/Company name). */ - address_line1?: string | null; + address_line1?: string | null /** @description If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. */ - address_line1_check?: string | null; + address_line1_check?: string | null /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - address_line2?: string | null; + address_line2?: string | null /** @description State/County/Province/Region. */ - address_state?: string | null; + address_state?: string | null /** @description ZIP or postal code. */ - address_zip?: string | null; + address_zip?: string | null /** @description If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. */ - address_zip_check?: string | null; + address_zip_check?: string | null /** @description 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?: ("instant" | "standard")[] | null; + available_payout_methods?: ('instant' | 'standard')[] | null /** @description Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`. */ - brand: string; + brand: string /** @description 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?: string | null; + country?: string | null /** @description Three-letter [ISO code for currency](https://stripe.com/docs/payouts). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. */ - currency?: string | null; + currency?: string | null /** @description 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?: - | (Partial & - Partial & - Partial) - | null; + customer?: (Partial & Partial & Partial) | null /** @description 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?: string | null; + cvc_check?: string | null /** @description Whether this card is the default external account for its currency. */ - default_for_currency?: boolean | null; + default_for_currency?: boolean | null /** @description (For tokenized numbers only.) The last four digits of the device account number. */ - dynamic_last4?: string | null; + dynamic_last4?: string | null /** @description Two-digit number representing the card's expiration month. */ - exp_month: number; + exp_month: number /** @description Four-digit number representing the card's expiration year. */ - exp_year: number; + exp_year: number /** * @description 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. * * *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.* */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ - funding: string; + funding: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The last four digits of the card. */ - last4: string; + last4: string /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** @description Cardholder name. */ - name?: string | null; + name?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "card"; + object: 'card' /** @description The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead. */ - recipient?: (Partial & Partial) | null; + recipient?: (Partial & Partial) | null /** @description 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?: string | null; - }; + tokenization_method?: string | null + } /** card_generated_from_payment_method_details */ card_generated_from_payment_method_details: { - card_present?: components["schemas"]["payment_method_details_card_present"]; + card_present?: components['schemas']['payment_method_details_card_present'] /** @description The type of payment method transaction-specific details from the transaction that generated this `card` payment method. Always `card_present`. */ - type: string; - }; + type: string + } /** CardIssuingAccountTermsOfService */ card_issuing_account_terms_of_service: { /** @description The Unix timestamp marking when the account representative accepted the service agreement. */ - date?: number | null; + date?: number | null /** @description The IP address from which the account representative accepted the service agreement. */ - ip?: string | null; + ip?: string | null /** @description The user agent of the browser from which the account representative accepted the service agreement. */ - user_agent?: string; - }; + user_agent?: string + } /** card_mandate_payment_method_details */ - card_mandate_payment_method_details: { [key: string]: unknown }; + card_mandate_payment_method_details: { [key: string]: unknown } /** * Charge * @description To charge a credit or a debit card, you create a `Charge` object. You can @@ -2949,152 +2935,148 @@ export interface components { */ charge: { /** @description 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: number; + amount: number /** @description Amount in %s captured (can be less than the amount attribute on the charge if a partial capture was made). */ - amount_captured: number; + amount_captured: number /** @description Amount in %s refunded (can be less than the amount attribute on the charge if a partial refund was issued). */ - amount_refunded: number; + amount_refunded: number /** @description ID of the Connect application that created the charge. */ - application?: (Partial & Partial) | null; + application?: (Partial & Partial) | null /** @description The application fee (if any) for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees) for details. */ - application_fee?: (Partial & Partial) | null; + application_fee?: (Partial & Partial) | null /** @description The amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees) for details. */ - application_fee_amount?: number | null; + application_fee_amount?: number | null /** @description ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes). */ - balance_transaction?: (Partial & Partial) | null; - billing_details: components["schemas"]["billing_details"]; + balance_transaction?: (Partial & Partial) | null + billing_details: components['schemas']['billing_details'] /** @description 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. */ - calculated_statement_descriptor?: string | null; + calculated_statement_descriptor?: string | null /** @description If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured. */ - captured: boolean; + captured: boolean /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description ID of the customer this charge is for if one exists. */ - customer?: - | (Partial & - Partial & - Partial) - | null; + customer?: (Partial & Partial & Partial) | null /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description Whether the charge has been disputed. */ - disputed: boolean; + disputed: boolean /** @description Error code explaining reason for charge failure if available (see [the errors section](https://stripe.com/docs/api#errors) for a list of codes). */ - failure_code?: string | null; + failure_code?: string | null /** @description Message to user further explaining reason for charge failure if available. */ - failure_message?: string | null; + failure_message?: string | null /** @description Information on fraud assessments for the charge. */ - fraud_details?: Partial | null; + fraud_details?: Partial | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description ID of the invoice this charge is for if one exists. */ - invoice?: (Partial & Partial) | null; + invoice?: (Partial & Partial) | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "charge"; + object: 'charge' /** @description 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/charges-transfers) for details. */ - on_behalf_of?: (Partial & Partial) | null; + on_behalf_of?: (Partial & Partial) | null /** @description ID of the order this charge is for if one exists. */ - order?: (Partial & Partial) | null; + order?: (Partial & Partial) | null /** @description Details about whether the payment was accepted, and why. See [understanding declines](https://stripe.com/docs/declines) for details. */ - outcome?: Partial | null; + outcome?: Partial | null /** @description `true` if the charge succeeded, or was successfully authorized for later capture. */ - paid: boolean; + paid: boolean /** @description ID of the PaymentIntent associated with this charge, if one exists. */ - payment_intent?: (Partial & Partial) | null; + payment_intent?: (Partial & Partial) | null /** @description ID of the payment method used in this charge. */ - payment_method?: string | null; + payment_method?: string | null /** @description Details about the payment method at the time of the transaction. */ - payment_method_details?: Partial | null; + payment_method_details?: Partial | null /** @description This is the email address that the receipt for this charge was sent to. */ - receipt_email?: string | null; + receipt_email?: string | null /** @description 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?: string | null; + receipt_number?: string | null /** @description 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?: string | null; + receipt_url?: string | null /** @description Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false. */ - refunded: boolean; + refunded: boolean /** * RefundList * @description A list of refunds that have been applied to the charge. */ refunds: { /** @description Details about each object. */ - data: components["schemas"]["refund"][]; + data: components['schemas']['refund'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** @description ID of the review associated with this charge if one exists. */ - review?: (Partial & Partial) | null; + review?: (Partial & Partial) | null /** @description Shipping information for the charge. */ - shipping?: Partial | null; + shipping?: Partial | null /** @description The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details. */ - source_transfer?: (Partial & Partial) | null; + source_transfer?: (Partial & Partial) | null /** @description For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - statement_descriptor?: string | null; + statement_descriptor?: string | null /** @description Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - statement_descriptor_suffix?: string | null; + statement_descriptor_suffix?: string | null /** * @description The status of the payment is either `succeeded`, `pending`, or `failed`. * @enum {string} */ - status: "failed" | "pending" | "succeeded"; + status: 'failed' | 'pending' | 'succeeded' /** @description ID of the transfer to the `destination` account (only applicable if the charge was created using the `destination` parameter). */ - transfer?: Partial & Partial; + transfer?: Partial & Partial /** @description 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?: Partial | null; + transfer_data?: Partial | null /** @description A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-options) for details. */ - transfer_group?: string | null; - }; + transfer_group?: string | null + } /** ChargeFraudDetails */ charge_fraud_details: { /** @description Assessments from Stripe. If set, the value is `fraudulent`. */ - stripe_report?: string; + stripe_report?: string /** @description Assessments reported by you. If set, possible values of are `safe` and `fraudulent`. */ - user_report?: string; - }; + user_report?: string + } /** ChargeOutcome */ charge_outcome: { /** @description 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?: string | null; + network_status?: string | null /** @description 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?: string | null; + reason?: string | null /** @description 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?: string; + risk_level?: string /** @description 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?: number; + risk_score?: number /** @description The ID of the Radar rule that matched the payment, if applicable. */ - rule?: Partial & Partial; + rule?: Partial & Partial /** @description A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer. */ - seller_message?: string | null; + seller_message?: string | null /** @description 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: string; - }; + type: string + } /** ChargeTransferData */ charge_transfer_data: { /** @description The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account. */ - amount?: number | null; + amount?: number | null /** @description ID of an existing, connected Stripe account to transfer funds to if `transfer_data` was specified in the charge request. */ - destination: Partial & Partial; - }; + destination: Partial & Partial + } /** * Session * @description A Checkout Session represents your customer's session as they pay for @@ -3112,35 +3094,35 @@ export interface components { * * Related guide: [Checkout Server Quickstart](https://stripe.com/docs/payments/checkout/api). */ - "checkout.session": { + 'checkout.session': { /** @description When set, provides configuration for actions to take if this Checkout Session expires. */ - after_expiration?: Partial | null; + after_expiration?: Partial | null /** @description Enables user redeemable promotion codes. */ - allow_promotion_codes?: boolean | null; + allow_promotion_codes?: boolean | null /** @description Total of all items before discounts or taxes are applied. */ - amount_subtotal?: number | null; + amount_subtotal?: number | null /** @description Total of all items after discounts and taxes are applied. */ - amount_total?: number | null; - automatic_tax: components["schemas"]["payment_pages_checkout_session_automatic_tax"]; + amount_total?: number | null + automatic_tax: components['schemas']['payment_pages_checkout_session_automatic_tax'] /** * @description Describes whether Checkout should collect the customer's billing address. * @enum {string|null} */ - billing_address_collection?: ("auto" | "required") | null; + billing_address_collection?: ('auto' | 'required') | null /** @description The URL the customer will be directed to if they decide to cancel payment and return to your website. */ - cancel_url: string; + cancel_url: string /** * @description A unique string to reference the Checkout Session. This can be a * customer ID, a cart ID, or similar, and can be used to reconcile the * Session with your internal systems. */ - client_reference_id?: string | null; + client_reference_id?: string | null /** @description Results of `consent_collection` for this session. */ - consent?: Partial | null; + consent?: Partial | null /** @description When set, provides configuration for the Checkout Session to gather active consent from customers. */ - consent_collection?: Partial | null; + consent_collection?: Partial | null /** @description 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?: string | null; + currency?: string | null /** * @description The ID of the customer for this Session. * For Checkout Sessions in `payment` or `subscription` mode, Checkout @@ -3148,18 +3130,14 @@ export interface components { * during the payment flow unless an existing customer was provided when * the Session was created. */ - customer?: - | (Partial & - Partial & - Partial) - | null; + customer?: (Partial & Partial & Partial) | null /** * @description Configure whether a Checkout Session creates a Customer when the Checkout Session completes. * @enum {string|null} */ - customer_creation?: ("always" | "if_required") | null; + customer_creation?: ('always' | 'if_required') | null /** @description The customer details including the customer's tax exempt status and the customer's tax IDs. Only present on Sessions in `payment` or `subscription` mode. */ - customer_details?: Partial | null; + customer_details?: Partial | null /** * @description 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. @@ -3167,134 +3145,132 @@ export interface components { * on file. To access information about the customer once the payment flow is * complete, use the `customer` attribute. */ - customer_email?: string | null; + customer_email?: string | null /** * Format: unix-time * @description The timestamp at which the Checkout Session will expire. */ - expires_at: number; + expires_at: number /** * @description Unique identifier for the object. Used to pass to `redirectToCheckout` * in Stripe.js. */ - id: string; + id: string /** * PaymentPagesCheckoutSessionListLineItems * @description The line items purchased by the customer. */ line_items?: { /** @description Details about each object. */ - data: components["schemas"]["item"][]; + data: components['schemas']['item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used. * @enum {string|null} */ locale?: | ( - | "auto" - | "bg" - | "cs" - | "da" - | "de" - | "el" - | "en" - | "en-GB" - | "es" - | "es-419" - | "et" - | "fi" - | "fil" - | "fr" - | "fr-CA" - | "hr" - | "hu" - | "id" - | "it" - | "ja" - | "ko" - | "lt" - | "lv" - | "ms" - | "mt" - | "nb" - | "nl" - | "pl" - | "pt" - | "pt-BR" - | "ro" - | "ru" - | "sk" - | "sl" - | "sv" - | "th" - | "tr" - | "vi" - | "zh" - | "zh-HK" - | "zh-TW" + | 'auto' + | 'bg' + | 'cs' + | 'da' + | 'de' + | 'el' + | 'en' + | 'en-GB' + | 'es' + | 'es-419' + | 'et' + | 'fi' + | 'fil' + | 'fr' + | 'fr-CA' + | 'hr' + | 'hu' + | 'id' + | 'it' + | 'ja' + | 'ko' + | 'lt' + | 'lv' + | 'ms' + | 'mt' + | 'nb' + | 'nl' + | 'pl' + | 'pt' + | 'pt-BR' + | 'ro' + | 'ru' + | 'sk' + | 'sl' + | 'sv' + | 'th' + | 'tr' + | 'vi' + | 'zh' + | 'zh-HK' + | 'zh-TW' ) - | null; + | null /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description The mode of the Checkout Session. * @enum {string} */ - mode: "payment" | "setup" | "subscription"; + mode: 'payment' | 'setup' | 'subscription' /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "checkout.session"; + object: 'checkout.session' /** @description The ID of the PaymentIntent for Checkout Sessions in `payment` mode. */ - payment_intent?: (Partial & Partial) | null; + payment_intent?: (Partial & Partial) | null /** @description The ID of the Payment Link that created this Session. */ - payment_link?: (Partial & Partial) | null; + payment_link?: (Partial & Partial) | null /** @description Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession. */ - payment_method_options?: Partial | null; + payment_method_options?: Partial | null /** * @description A list of the types of payment methods (e.g. card) this Checkout * Session is allowed to accept. */ - payment_method_types: string[]; + payment_method_types: string[] /** * @description The payment status of the Checkout Session, one of `paid`, `unpaid`, or `no_payment_required`. * You can use this value to decide when to fulfill your customer's order. * @enum {string} */ - payment_status: "no_payment_required" | "paid" | "unpaid"; - phone_number_collection?: components["schemas"]["payment_pages_checkout_session_phone_number_collection"]; + payment_status: 'no_payment_required' | 'paid' | 'unpaid' + phone_number_collection?: components['schemas']['payment_pages_checkout_session_phone_number_collection'] /** @description The ID of the original expired Checkout Session that triggered the recovery flow. */ - recovered_from?: string | null; + recovered_from?: string | null /** @description The ID of the SetupIntent for Checkout Sessions in `setup` mode. */ - setup_intent?: (Partial & Partial) | null; + setup_intent?: (Partial & Partial) | null /** @description Shipping information for this Checkout Session. */ - shipping?: Partial | null; + shipping?: Partial | null /** @description When set, provides configuration for Checkout to collect a shipping address from a customer. */ - shipping_address_collection?: Partial< - components["schemas"]["payment_pages_checkout_session_shipping_address_collection"] - > | null; + shipping_address_collection?: Partial | null /** @description The shipping rate options applied to this Session. */ - shipping_options: components["schemas"]["payment_pages_checkout_session_shipping_option"][]; + shipping_options: components['schemas']['payment_pages_checkout_session_shipping_option'][] /** @description The ID of the ShippingRate for Checkout Sessions in `payment` mode. */ - shipping_rate?: (Partial & Partial) | null; + shipping_rate?: (Partial & Partial) | null /** * @description The status of the Checkout Session, one of `open`, `complete`, or `expired`. * @enum {string|null} */ - status?: ("complete" | "expired" | "open") | null; + status?: ('complete' | 'expired' | 'open') | null /** * @description Describes the type of transaction being performed by Checkout in order to customize * relevant text on the page, such as the submit button. `submit_type` can only be @@ -3302,87 +3278,87 @@ export interface components { * in `subscription` or `setup` mode. * @enum {string|null} */ - submit_type?: ("auto" | "book" | "donate" | "pay") | null; + submit_type?: ('auto' | 'book' | 'donate' | 'pay') | null /** @description The ID of the subscription for Checkout Sessions in `subscription` mode. */ - subscription?: (Partial & Partial) | null; + subscription?: (Partial & Partial) | null /** * @description The URL the customer will be directed to after the payment or * subscription creation is successful. */ - success_url: string; - tax_id_collection?: components["schemas"]["payment_pages_checkout_session_tax_id_collection"]; + success_url: string + tax_id_collection?: components['schemas']['payment_pages_checkout_session_tax_id_collection'] /** @description Tax and discount details for the computed total amount. */ - total_details?: Partial | null; + total_details?: Partial | null /** @description The URL to the Checkout Session. */ - url?: string | null; - }; + url?: string | null + } /** CheckoutAcssDebitMandateOptions */ checkout_acss_debit_mandate_options: { /** @description A URL for custom mandate text */ - custom_mandate_url?: string; + custom_mandate_url?: string /** @description List of Stripe products where this mandate can be selected automatically. Returned when the Session is in `setup` mode. */ - default_for?: ("invoice" | "subscription")[]; + default_for?: ('invoice' | 'subscription')[] /** @description Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. */ - interval_description?: string | null; + interval_description?: string | null /** * @description Payment schedule for the mandate. * @enum {string|null} */ - payment_schedule?: ("combined" | "interval" | "sporadic") | null; + payment_schedule?: ('combined' | 'interval' | 'sporadic') | null /** * @description Transaction type of the mandate. * @enum {string|null} */ - transaction_type?: ("business" | "personal") | null; - }; + transaction_type?: ('business' | 'personal') | null + } /** CheckoutAcssDebitPaymentMethodOptions */ checkout_acss_debit_payment_method_options: { /** * @description Currency supported by the bank account. Returned when the Session is in `setup` mode. * @enum {string} */ - currency?: "cad" | "usd"; - mandate_options?: components["schemas"]["checkout_acss_debit_mandate_options"]; + currency?: 'cad' | 'usd' + mandate_options?: components['schemas']['checkout_acss_debit_mandate_options'] /** * @description Bank account verification method. * @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; - }; + verification_method?: 'automatic' | 'instant' | 'microdeposits' + } /** CheckoutBoletoPaymentMethodOptions */ checkout_boleto_payment_method_options: { /** @description 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: number; - }; + expires_after_days: number + } /** CheckoutOxxoPaymentMethodOptions */ checkout_oxxo_payment_method_options: { /** @description 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: number; - }; + expires_after_days: number + } /** CheckoutSessionPaymentMethodOptions */ checkout_session_payment_method_options: { - acss_debit?: components["schemas"]["checkout_acss_debit_payment_method_options"]; - boleto?: components["schemas"]["checkout_boleto_payment_method_options"]; - oxxo?: components["schemas"]["checkout_oxxo_payment_method_options"]; - }; + acss_debit?: components['schemas']['checkout_acss_debit_payment_method_options'] + boleto?: components['schemas']['checkout_boleto_payment_method_options'] + oxxo?: components['schemas']['checkout_oxxo_payment_method_options'] + } /** ConnectCollectionTransfer */ connect_collection_transfer: { /** @description Amount transferred, in %s. */ - amount: number; + amount: number /** @description 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: string; + currency: string /** @description ID of the account that funds are being collected for. */ - destination: Partial & Partial; + destination: Partial & Partial /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "connect_collection_transfer"; - }; + object: 'connect_collection_transfer' + } /** * CountrySpec * @description Stripe needs to collect certain pieces of information about each account @@ -3394,36 +3370,36 @@ export interface components { */ country_spec: { /** @description The default currency for this country. This applies to both payment methods and bank accounts. */ - default_currency: string; + default_currency: string /** @description Unique identifier for the object. Represented as the ISO country code for this country. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "country_spec"; + object: 'country_spec' /** @description Currencies that can be accepted in the specific country (for transfers). */ - supported_bank_account_currencies: { [key: string]: string[] }; + supported_bank_account_currencies: { [key: string]: string[] } /** @description Currencies that can be accepted in the specified country (for payments). */ - supported_payment_currencies: string[]; + supported_payment_currencies: string[] /** @description 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: string[]; + supported_payment_methods: string[] /** @description Countries that can accept transfers from the specified country. */ - supported_transfer_countries: string[]; - verification_fields: components["schemas"]["country_spec_verification_fields"]; - }; + supported_transfer_countries: string[] + verification_fields: components['schemas']['country_spec_verification_fields'] + } /** CountrySpecVerificationFieldDetails */ country_spec_verification_field_details: { /** @description Additional fields which are only required for some users. */ - additional: string[]; + additional: string[] /** @description Fields which every account must eventually provide. */ - minimum: string[]; - }; + minimum: string[] + } /** CountrySpecVerificationFields */ country_spec_verification_fields: { - company: components["schemas"]["country_spec_verification_field_details"]; - individual: components["schemas"]["country_spec_verification_field_details"]; - }; + company: components['schemas']['country_spec_verification_field_details'] + individual: components['schemas']['country_spec_verification_field_details'] + } /** * Coupon * @description A coupon contains information about a percent-off or amount-off discount you @@ -3432,54 +3408,54 @@ export interface components { */ coupon: { /** @description Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer. */ - amount_off?: number | null; - applies_to?: components["schemas"]["coupon_applies_to"]; + amount_off?: number | null + applies_to?: components['schemas']['coupon_applies_to'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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?: string | null; + currency?: string | null /** * @description One of `forever`, `once`, and `repeating`. Describes how long a customer who applies this coupon will get the discount. * @enum {string} */ - duration: "forever" | "once" | "repeating"; + duration: 'forever' | 'once' | 'repeating' /** @description If `duration` is `repeating`, the number of months the coupon applies. Null if coupon `duration` is `forever` or `once`. */ - duration_in_months?: number | null; + duration_in_months?: number | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid. */ - max_redemptions?: number | null; + max_redemptions?: number | null /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** @description Name of the coupon displayed to customers on for instance invoices or receipts. */ - name?: string | null; + name?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "coupon"; + object: 'coupon' /** @description 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 %s100 invoice %s50 instead. */ - percent_off?: number | null; + percent_off?: number | null /** * Format: unix-time * @description Date after which the coupon can no longer be redeemed. */ - redeem_by?: number | null; + redeem_by?: number | null /** @description Number of times this coupon has been applied to a customer. */ - times_redeemed: number; + times_redeemed: number /** @description Taking account of the above properties, whether this coupon can still be applied to a customer. */ - valid: boolean; - }; + valid: boolean + } /** CouponAppliesTo */ coupon_applies_to: { /** @description A list of product IDs this coupon applies to */ - products: string[]; - }; + products: string[] + } /** * CreditNote * @description Issue a credit note to adjust an invoice's amount after the invoice is finalized. @@ -3488,142 +3464,138 @@ export interface components { */ credit_note: { /** @description The integer amount in %s representing the total amount of the credit note, including tax. */ - amount: number; + amount: number /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description ID of the customer. */ - customer: Partial & - Partial & - Partial; + customer: Partial & Partial & Partial /** @description Customer balance transaction related to this credit note. */ - customer_balance_transaction?: - | (Partial & Partial) - | null; + customer_balance_transaction?: (Partial & Partial) | null /** @description The integer amount in %s representing the total amount of discount that was credited. */ - discount_amount: number; + discount_amount: number /** @description The aggregate amounts calculated per discount for all line items. */ - discount_amounts: components["schemas"]["discounts_resource_discount_amount"][]; + discount_amounts: components['schemas']['discounts_resource_discount_amount'][] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description ID of the invoice. */ - invoice: Partial & Partial; + invoice: Partial & Partial /** * CreditNoteLinesList * @description Line items that make up the credit note */ lines: { /** @description Details about each object. */ - data: components["schemas"]["credit_note_line_item"][]; + data: components['schemas']['credit_note_line_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description Customer-facing text that appears on the credit note PDF. */ - memo?: string | null; + memo?: string | null /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** @description A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice. */ - number: string; + number: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "credit_note"; + object: 'credit_note' /** @description Amount that was credited outside of Stripe. */ - out_of_band_amount?: number | null; + out_of_band_amount?: number | null /** @description The link to download the PDF of the credit note. */ - pdf: string; + pdf: string /** * @description Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` * @enum {string|null} */ - reason?: ("duplicate" | "fraudulent" | "order_change" | "product_unsatisfactory") | null; + reason?: ('duplicate' | 'fraudulent' | 'order_change' | 'product_unsatisfactory') | null /** @description Refund related to this credit note. */ - refund?: (Partial & Partial) | null; + refund?: (Partial & Partial) | null /** * @description 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). * @enum {string} */ - status: "issued" | "void"; + status: 'issued' | 'void' /** @description The integer amount in %s representing the amount of the credit note, excluding tax and invoice level discounts. */ - subtotal: number; + subtotal: number /** @description The aggregate amounts calculated per tax rate for all line items. */ - tax_amounts: components["schemas"]["credit_note_tax_amount"][]; + tax_amounts: components['schemas']['credit_note_tax_amount'][] /** @description The integer amount in %s representing the total amount of the credit note, including tax and all discount. */ - total: number; + total: number /** * @description 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. * @enum {string} */ - type: "post_payment" | "pre_payment"; + type: 'post_payment' | 'pre_payment' /** * Format: unix-time * @description The time that the credit note was voided. */ - voided_at?: number | null; - }; + voided_at?: number | null + } /** CreditNoteLineItem */ credit_note_line_item: { /** @description The integer amount in %s representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts. */ - amount: number; + amount: number /** @description Description of the item being credited. */ - description?: string | null; + description?: string | null /** @description The integer amount in %s representing the discount being credited for this line item. */ - discount_amount: number; + discount_amount: number /** @description The amount of discount calculated per discount for this line item */ - discount_amounts: components["schemas"]["discounts_resource_discount_amount"][]; + discount_amounts: components['schemas']['discounts_resource_discount_amount'][] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description ID of the invoice line item being credited */ - invoice_line_item?: string; + invoice_line_item?: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "credit_note_line_item"; + object: 'credit_note_line_item' /** @description The number of units of product being credited. */ - quantity?: number | null; + quantity?: number | null /** @description The amount of tax calculated per tax rate for this line item */ - tax_amounts: components["schemas"]["credit_note_tax_amount"][]; + tax_amounts: components['schemas']['credit_note_tax_amount'][] /** @description The tax rates which apply to the line item. */ - tax_rates: components["schemas"]["tax_rate"][]; + tax_rates: components['schemas']['tax_rate'][] /** * @description 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. * @enum {string} */ - type: "custom_line_item" | "invoice_line_item"; + type: 'custom_line_item' | 'invoice_line_item' /** @description The cost of each unit of product being credited. */ - unit_amount?: number | null; + unit_amount?: number | null /** * Format: decimal * @description Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. */ - unit_amount_decimal?: string | null; - }; + unit_amount_decimal?: string | null + } /** CreditNoteTaxAmount */ credit_note_tax_amount: { /** @description The amount, in %s, of the tax. */ - amount: number; + amount: number /** @description Whether this tax amount is inclusive or exclusive. */ - inclusive: boolean; + inclusive: boolean /** @description The tax rate that was applied to get this tax amount. */ - tax_rate: Partial & Partial; - }; + tax_rate: Partial & Partial + } /** * Customer * @description This object represents a customer of your business. It lets you create recurring charges and track payments that belong to the same customer. @@ -3632,16 +3604,16 @@ export interface components { */ customer: { /** @description The customer's address. */ - address?: Partial | null; + address?: Partial | null /** @description Current balance, if any, being 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 will be added to their next invoice. The balance does not refer to any unpaid invoices; it solely takes into account amounts that have yet to be successfully applied to any invoice. This balance is only taken into account as invoices are finalized. */ - balance?: number; + balance?: number /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes. */ - currency?: string | null; + currency?: string | null /** * @description ID of the default payment source for the customer. * @@ -3649,125 +3621,125 @@ export interface components { */ default_source?: | (Partial & - Partial & - Partial & - Partial & - Partial & - Partial) - | null; + Partial & + Partial & + Partial & + Partial & + Partial) + | null /** * @description When the customer's latest invoice is billed by charging automatically, `delinquent` is `true` if the invoice's latest charge failed. When the customer's latest invoice is billed by sending an invoice, `delinquent` is `true` if the invoice isn't paid by its due date. * * If an invoice is marked uncollectible by [dunning](https://stripe.com/docs/billing/automatic-collection), `delinquent` doesn't get reset to `false`. */ - delinquent?: boolean | null; + delinquent?: boolean | null /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description Describes the current discount active on the customer, if there is one. */ - discount?: Partial | null; + discount?: Partial | null /** @description The customer's email address. */ - email?: string | null; + email?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The prefix for the customer used to generate unique invoice numbers. */ - invoice_prefix?: string | null; - invoice_settings?: components["schemas"]["invoice_setting_customer_setting"]; + invoice_prefix?: string | null + invoice_settings?: components['schemas']['invoice_setting_customer_setting'] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The customer's full name or business name. */ - name?: string | null; + name?: string | null /** @description The suffix of the customer's next invoice number, e.g., 0001. */ - next_invoice_sequence?: number; + next_invoice_sequence?: number /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "customer"; + object: 'customer' /** @description The customer's phone number. */ - phone?: string | null; + phone?: string | null /** @description The customer's preferred locales (languages), ordered by preference. */ - preferred_locales?: string[] | null; + preferred_locales?: string[] | null /** @description Mailing and shipping address for the customer. Appears on invoices emailed to this customer. */ - shipping?: Partial | null; + shipping?: Partial | null /** * ApmsSourcesSourceList * @description The customer's payment sources, if any. */ sources?: { /** @description Details about each object. */ - data: (Partial & - Partial & - Partial & - Partial & - Partial)[]; + data: (Partial & + Partial & + Partial & + Partial & + Partial)[] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** * SubscriptionList * @description The customer's current subscriptions, if any. */ subscriptions?: { /** @description Details about each object. */ - data: components["schemas"]["subscription"][]; + data: components['schemas']['subscription'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - tax?: components["schemas"]["customer_tax"]; + url: string + } + tax?: components['schemas']['customer_tax'] /** * @description Describes the customer's tax exemption status. One of `none`, `exempt`, or `reverse`. When set to `reverse`, invoice and receipt PDFs include the text **"Reverse charge"**. * @enum {string|null} */ - tax_exempt?: ("exempt" | "none" | "reverse") | null; + tax_exempt?: ('exempt' | 'none' | 'reverse') | null /** * TaxIDsList * @description The customer's tax IDs. */ tax_ids?: { /** @description Details about each object. */ - data: components["schemas"]["tax_id"][]; + data: components['schemas']['tax_id'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; + url: string + } + } /** customer_acceptance */ customer_acceptance: { /** * Format: unix-time * @description The time at which the customer accepted the Mandate. */ - accepted_at?: number | null; - offline?: components["schemas"]["offline_acceptance"]; - online?: components["schemas"]["online_acceptance"]; + accepted_at?: number | null + offline?: components['schemas']['offline_acceptance'] + online?: components['schemas']['online_acceptance'] /** * @description The type of customer acceptance information included with the Mandate. One of `online` or `offline`. * @enum {string} */ - type: "offline" | "online"; - }; + type: 'offline' | 'online' + } /** * CustomerBalanceTransaction * @description Each customer has a [`balance`](https://stripe.com/docs/api/customers/object#customer_object-balance) value, @@ -3779,479 +3751,474 @@ export interface components { */ customer_balance_transaction: { /** @description 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: number; + amount: number /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The ID of the credit note (if any) related to the transaction. */ - credit_note?: (Partial & Partial) | null; + credit_note?: (Partial & Partial) | null /** @description 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: string; + currency: string /** @description The ID of the customer the transaction belongs to. */ - customer: Partial & Partial; + customer: Partial & Partial /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description 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: number; + ending_balance: number /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The ID of the invoice (if any) related to the transaction. */ - invoice?: (Partial & Partial) | null; + invoice?: (Partial & Partial) | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "customer_balance_transaction"; + object: 'customer_balance_transaction' /** * @description Transaction type: `adjustment`, `applied_to_invoice`, `credit_note`, `initial`, `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. * @enum {string} */ type: - | "adjustment" - | "applied_to_invoice" - | "credit_note" - | "initial" - | "invoice_too_large" - | "invoice_too_small" - | "migration" - | "unapplied_from_invoice" - | "unspent_receiver_credit"; - }; + | 'adjustment' + | 'applied_to_invoice' + | 'credit_note' + | 'initial' + | 'invoice_too_large' + | 'invoice_too_small' + | 'migration' + | 'unapplied_from_invoice' + | 'unspent_receiver_credit' + } /** CustomerTax */ customer_tax: { /** * @description Surfaces if automatic tax computation is possible given the current customer location information. * @enum {string} */ - automatic_tax: "failed" | "not_collecting" | "supported" | "unrecognized_location"; + automatic_tax: 'failed' | 'not_collecting' | 'supported' | 'unrecognized_location' /** @description A recent IP address of the customer used for tax reporting and tax location inference. */ - ip_address?: string | null; + ip_address?: string | null /** @description The customer's location as identified by Stripe Tax. */ - location?: Partial | null; - }; + location?: Partial | null + } /** CustomerTaxLocation */ customer_tax_location: { /** @description The customer's country as identified by Stripe Tax. */ - country: string; + country: string /** * @description The data source used to infer the customer's location. * @enum {string} */ - source: "billing_address" | "ip_address" | "payment_method" | "shipping_destination"; + source: 'billing_address' | 'ip_address' | 'payment_method' | 'shipping_destination' /** @description The customer's state, county, province, or region as identified by Stripe Tax. */ - state?: string | null; - }; + state?: string | null + } /** DeletedAccount */ deleted_account: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "account"; - }; + object: 'account' + } /** AlipayDeletedAccount */ deleted_alipay_account: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "alipay_account"; - }; + object: 'alipay_account' + } /** DeletedApplePayDomain */ deleted_apple_pay_domain: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "apple_pay_domain"; - }; + object: 'apple_pay_domain' + } /** DeletedBankAccount */ deleted_bank_account: { /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. */ - currency?: string | null; + currency?: string | null /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "bank_account"; - }; + object: 'bank_account' + } /** BitcoinDeletedReceiver */ deleted_bitcoin_receiver: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "bitcoin_receiver"; - }; + object: 'bitcoin_receiver' + } /** DeletedCard */ deleted_card: { /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. */ - currency?: string | null; + currency?: string | null /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "card"; - }; + object: 'card' + } /** DeletedCoupon */ deleted_coupon: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "coupon"; - }; + object: 'coupon' + } /** DeletedCustomer */ deleted_customer: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "customer"; - }; + object: 'customer' + } /** DeletedDiscount */ deleted_discount: { /** @description 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?: string | null; - coupon: components["schemas"]["coupon"]; + checkout_session?: string | null + coupon: components['schemas']['coupon'] /** @description The ID of the customer associated with this discount. */ - customer?: - | (Partial & - Partial & - Partial) - | null; + customer?: (Partial & Partial & Partial) | null /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description 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: string; + id: string /** @description The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice. */ - invoice?: string | null; + invoice?: string | null /** @description 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?: string | null; + invoice_item?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "discount"; + object: 'discount' /** @description The promotion code applied to create this discount. */ - promotion_code?: (Partial & Partial) | null; + promotion_code?: (Partial & Partial) | null /** * Format: unix-time * @description Date that the coupon was applied. */ - start: number; + start: number /** @description The subscription that this coupon is applied to, if it is applied to a particular subscription. */ - subscription?: string | null; - }; + subscription?: string | null + } /** Polymorphic */ - deleted_external_account: Partial & - Partial; + deleted_external_account: Partial & Partial /** DeletedInvoice */ deleted_invoice: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "invoice"; - }; + object: 'invoice' + } /** DeletedInvoiceItem */ deleted_invoiceitem: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "invoiceitem"; - }; + object: 'invoiceitem' + } /** Polymorphic */ - deleted_payment_source: Partial & - Partial & - Partial & - Partial; + deleted_payment_source: Partial & + Partial & + Partial & + Partial /** DeletedPerson */ deleted_person: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "person"; - }; + object: 'person' + } /** DeletedPlan */ deleted_plan: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "plan"; - }; + object: 'plan' + } /** DeletedPrice */ deleted_price: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "price"; - }; + object: 'price' + } /** DeletedProduct */ deleted_product: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "product"; - }; + object: 'product' + } /** RadarListDeletedList */ - "deleted_radar.value_list": { + 'deleted_radar.value_list': { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "radar.value_list"; - }; + object: 'radar.value_list' + } /** RadarListDeletedListItem */ - "deleted_radar.value_list_item": { + 'deleted_radar.value_list_item': { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "radar.value_list_item"; - }; + object: 'radar.value_list_item' + } /** DeletedTransferRecipient */ deleted_recipient: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "recipient"; - }; + object: 'recipient' + } /** DeletedSku */ deleted_sku: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "sku"; - }; + object: 'sku' + } /** DeletedSubscriptionItem */ deleted_subscription_item: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "subscription_item"; - }; + object: 'subscription_item' + } /** deleted_tax_id */ deleted_tax_id: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "tax_id"; - }; + object: 'tax_id' + } /** TerminalLocationDeletedLocation */ - "deleted_terminal.location": { + 'deleted_terminal.location': { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "terminal.location"; - }; + object: 'terminal.location' + } /** TerminalReaderDeletedReader */ - "deleted_terminal.reader": { + 'deleted_terminal.reader': { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "terminal.reader"; - }; + object: 'terminal.reader' + } /** NotificationWebhookEndpointDeleted */ deleted_webhook_endpoint: { /** * @description Always true for a deleted object * @enum {boolean} */ - deleted: true; + deleted: true /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "webhook_endpoint"; - }; + object: 'webhook_endpoint' + } /** DeliveryEstimate */ delivery_estimate: { /** @description If `type` is `"exact"`, `date` will be the expected delivery date in the format YYYY-MM-DD. */ - date?: string; + date?: string /** @description If `type` is `"range"`, `earliest` will be be the earliest delivery date in the format YYYY-MM-DD. */ - earliest?: string; + earliest?: string /** @description If `type` is `"range"`, `latest` will be the latest delivery date in the format YYYY-MM-DD. */ - latest?: string; + latest?: string /** @description The type of estimate. Must be either `"range"` or `"exact"`. */ - type: string; - }; + type: string + } /** * Discount * @description A discount represents the actual application of a coupon to a particular @@ -4262,49 +4229,43 @@ export interface components { */ discount: { /** @description 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?: string | null; - coupon: components["schemas"]["coupon"]; + checkout_session?: string | null + coupon: components['schemas']['coupon'] /** @description The ID of the customer associated with this discount. */ - customer?: - | (Partial & - Partial & - Partial) - | null; + customer?: (Partial & Partial & Partial) | null /** * Format: unix-time * @description 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?: number | null; + end?: number | null /** @description 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: string; + id: string /** @description The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice. */ - invoice?: string | null; + invoice?: string | null /** @description 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?: string | null; + invoice_item?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "discount"; + object: 'discount' /** @description The promotion code applied to create this discount. */ - promotion_code?: (Partial & Partial) | null; + promotion_code?: (Partial & Partial) | null /** * Format: unix-time * @description Date that the coupon was applied. */ - start: number; + start: number /** @description The subscription that this coupon is applied to, if it is applied to a particular subscription. */ - subscription?: string | null; - }; + subscription?: string | null + } /** DiscountsResourceDiscountAmount */ discounts_resource_discount_amount: { /** @description The amount, in %s, of the discount. */ - amount: number; + amount: number /** @description The discount that was applied to get this discount amount. */ - discount: Partial & - Partial & - Partial; - }; + discount: Partial & Partial & Partial + } /** * Dispute * @description A dispute occurs when a customer questions your charge with their card issuer. @@ -4317,150 +4278,150 @@ export interface components { */ dispute: { /** @description Disputed amount. Usually the amount of the charge, but can differ (usually because of currency fluctuation or because only part of the order is disputed). */ - amount: number; + amount: number /** @description 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: components["schemas"]["balance_transaction"][]; + balance_transactions: components['schemas']['balance_transaction'][] /** @description ID of the charge that was disputed. */ - charge: Partial & Partial; + charge: Partial & Partial /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; - evidence: components["schemas"]["dispute_evidence"]; - evidence_details: components["schemas"]["dispute_evidence_details"]; + currency: string + evidence: components['schemas']['dispute_evidence'] + evidence_details: components['schemas']['dispute_evidence_details'] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description If true, it is still possible to refund the disputed payment. Once the payment has been fully refunded, no further funds will be withdrawn from your Stripe account as a result of this dispute. */ - is_charge_refundable: boolean; + is_charge_refundable: boolean /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "dispute"; + object: 'dispute' /** @description ID of the PaymentIntent that was disputed. */ - payment_intent?: (Partial & Partial) | null; + payment_intent?: (Partial & Partial) | null /** @description 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`. Read more about [dispute reasons](https://stripe.com/docs/disputes/categories). */ - reason: string; + reason: string /** * @description Current status of dispute. Possible values are `warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `charge_refunded`, `won`, or `lost`. * @enum {string} */ status: - | "charge_refunded" - | "lost" - | "needs_response" - | "under_review" - | "warning_closed" - | "warning_needs_response" - | "warning_under_review" - | "won"; - }; + | 'charge_refunded' + | 'lost' + | 'needs_response' + | 'under_review' + | 'warning_closed' + | 'warning_needs_response' + | 'warning_under_review' + | 'won' + } /** DisputeEvidence */ dispute_evidence: { /** @description 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?: string | null; + access_activity_log?: string | null /** @description The billing address provided by the customer. */ - billing_address?: string | null; + billing_address?: string | null /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your subscription cancellation policy, as shown to the customer. */ - cancellation_policy?: (Partial & Partial) | null; + cancellation_policy?: (Partial & Partial) | null /** @description An explanation of how and when the customer was shown your refund policy prior to purchase. */ - cancellation_policy_disclosure?: string | null; + cancellation_policy_disclosure?: string | null /** @description A justification for why the customer's subscription was not canceled. */ - cancellation_rebuttal?: string | null; + cancellation_rebuttal?: string | null /** @description (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?: (Partial & Partial) | null; + customer_communication?: (Partial & Partial) | null /** @description The email address of the customer. */ - customer_email_address?: string | null; + customer_email_address?: string | null /** @description The name of the customer. */ - customer_name?: string | null; + customer_name?: string | null /** @description The IP address that the customer used when making the purchase. */ - customer_purchase_ip?: string | null; + customer_purchase_ip?: string | null /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A relevant document or contract showing the customer's signature. */ - customer_signature?: (Partial & Partial) | null; + customer_signature?: (Partial & Partial) | null /** @description (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?: (Partial & Partial) | null; + duplicate_charge_documentation?: (Partial & Partial) | null /** @description An explanation of the difference between the disputed charge versus the prior charge that appears to be a duplicate. */ - duplicate_charge_explanation?: string | null; + duplicate_charge_explanation?: string | null /** @description The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge. */ - duplicate_charge_id?: string | null; + duplicate_charge_id?: string | null /** @description A description of the product or service that was sold. */ - product_description?: string | null; + product_description?: string | null /** @description (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?: (Partial & Partial) | null; + receipt?: (Partial & Partial) | null /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your refund policy, as shown to the customer. */ - refund_policy?: (Partial & Partial) | null; + refund_policy?: (Partial & Partial) | null /** @description Documentation demonstrating that the customer was shown your refund policy prior to purchase. */ - refund_policy_disclosure?: string | null; + refund_policy_disclosure?: string | null /** @description A justification for why the customer is not entitled to a refund. */ - refund_refusal_explanation?: string | null; + refund_refusal_explanation?: string | null /** @description The date on which the customer received or began receiving the purchased service, in a clear human-readable format. */ - service_date?: string | null; + service_date?: string | null /** @description (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?: (Partial & Partial) | null; + service_documentation?: (Partial & Partial) | null /** @description The address to which a physical product was shipped. You should try to include as complete address information as possible. */ - shipping_address?: string | null; + shipping_address?: string | null /** @description 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?: string | null; + shipping_carrier?: string | null /** @description The date on which a physical product began its route to the shipping address, in a clear human-readable format. */ - shipping_date?: string | null; + shipping_date?: string | null /** @description (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?: (Partial & Partial) | null; + shipping_documentation?: (Partial & Partial) | null /** @description 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?: string | null; + shipping_tracking_number?: string | null /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any additional evidence or statements. */ - uncategorized_file?: (Partial & Partial) | null; + uncategorized_file?: (Partial & Partial) | null /** @description Any additional evidence or statements. */ - uncategorized_text?: string | null; - }; + uncategorized_text?: string | null + } /** DisputeEvidenceDetails */ dispute_evidence_details: { /** * Format: unix-time * @description Date by which evidence must be submitted in order to successfully challenge dispute. Will be null if the customer's bank or credit card company doesn't allow a response for this particular dispute. */ - due_by?: number | null; + due_by?: number | null /** @description Whether evidence has been staged for this dispute. */ - has_evidence: boolean; + has_evidence: boolean /** @description 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: boolean; + past_due: boolean /** @description The number of times evidence has been submitted. Typically, you may only submit evidence once. */ - submission_count: number; - }; + submission_count: number + } /** EphemeralKey */ ephemeral_key: { /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** * Format: unix-time * @description Time at which the key will expire. Measured in seconds since the Unix epoch. */ - expires: number; + expires: number /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "ephemeral_key"; + object: 'ephemeral_key' /** @description The key's secret. You can use this value to make authorized requests to the Stripe API. */ - secret?: string; - }; + secret?: string + } /** @description An error response from the Stripe API */ error: { - error: components["schemas"]["api_errors"]; - }; + error: components['schemas']['api_errors'] + } /** * NotificationEvent * @description Events are our way of letting you know when something interesting happens in @@ -4495,31 +4456,31 @@ export interface components { */ event: { /** @description The connected account that originated the event. */ - account?: string; + account?: string /** @description The Stripe API version used to render `data`. *Note: This property is populated only for events on or after October 31, 2014*. */ - api_version?: string | null; + api_version?: string | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; - data: components["schemas"]["notification_event_data"]; + created: number + data: components['schemas']['notification_event_data'] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "event"; + object: 'event' /** @description Number of webhooks that have yet to be successfully delivered (i.e., to return a 20x response) to the URLs you've specified. */ - pending_webhooks: number; + pending_webhooks: number /** @description Information on the API request that instigated the event. */ - request?: Partial | null; + request?: Partial | null /** @description Description of the event (e.g., `invoice.created` or `charge.refunded`). */ - type: string; - }; + type: string + } /** * ExchangeRate * @description `Exchange Rate` objects allow you to determine the rates that Stripe is @@ -4536,30 +4497,30 @@ export interface components { */ exchange_rate: { /** @description 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: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "exchange_rate"; + object: 'exchange_rate' /** @description 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: { [key: string]: number }; - }; + rates: { [key: string]: number } + } /** Polymorphic */ - external_account: Partial & Partial; + external_account: Partial & Partial /** Fee */ fee: { /** @description Amount of the fee, in cents. */ - amount: number; + amount: number /** @description ID of the Connect application that earned the fee. */ - application?: string | null; + application?: string | null /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description Type of the fee, one of: `application_fee`, `stripe_fee` or `tax`. */ - type: string; - }; + type: string + } /** * FeeRefund * @description `Application Fee Refund` objects allow you to refund an application fee that @@ -4570,28 +4531,28 @@ export interface components { */ fee_refund: { /** @description Amount, in %s. */ - amount: number; + amount: number /** @description Balance transaction that describes the impact on your account balance. */ - balance_transaction?: (Partial & Partial) | null; + balance_transaction?: (Partial & Partial) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description ID of the application fee that was refunded. */ - fee: Partial & Partial; + fee: Partial & Partial /** @description Unique identifier for the object. */ - id: string; + id: string /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "fee_refund"; - }; + object: 'fee_refund' + } /** * File * @description This is an object representing a file hosted on Stripe's servers. The @@ -4607,66 +4568,66 @@ export interface components { * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** * Format: unix-time * @description The time at which the file expires and is no longer available in epoch seconds. */ - expires_at?: number | null; + expires_at?: number | null /** @description A filename for the file, suitable for saving to a filesystem. */ - filename?: string | null; + filename?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** * FileFileLinkList * @description A list of [file links](https://stripe.com/docs/api#file_links) that point at this file. */ links?: { /** @description Details about each object. */ - data: components["schemas"]["file_link"][]; + data: components['schemas']['file_link'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } | null; + url: string + } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "file"; + object: 'file' /** * @description The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file. * @enum {string} */ purpose: - | "account_requirement" - | "additional_verification" - | "business_icon" - | "business_logo" - | "customer_signature" - | "dispute_evidence" - | "document_provider_identity_document" - | "finance_report_run" - | "identity_document" - | "identity_document_downloadable" - | "pci_document" - | "selfie" - | "sigma_scheduled_query" - | "tax_document_user_upload"; + | 'account_requirement' + | 'additional_verification' + | 'business_icon' + | 'business_logo' + | 'customer_signature' + | 'dispute_evidence' + | 'document_provider_identity_document' + | 'finance_report_run' + | 'identity_document' + | 'identity_document_downloadable' + | 'pci_document' + | 'selfie' + | 'sigma_scheduled_query' + | 'tax_document_user_upload' /** @description The size in bytes of the file object. */ - size: number; + size: number /** @description A user friendly title for the document. */ - title?: string | null; + title?: string | null /** @description The type of the file returned (e.g., `csv`, `pdf`, `jpg`, or `png`). */ - type?: string | null; + type?: string | null /** @description The URL from which the file can be downloaded using your live secret API key. */ - url?: string | null; - }; + url?: string | null + } /** * FileLink * @description To share the contents of a `File` object with non-Stripe users, you can @@ -4678,252 +4639,250 @@ export interface components { * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Whether this link is already expired. */ - expired: boolean; + expired: boolean /** * Format: unix-time * @description Time at which the link expires. */ - expires_at?: number | null; + expires_at?: number | null /** @description The file object this link points to. */ - file: Partial & Partial; + file: Partial & Partial /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "file_link"; + object: 'file_link' /** @description The publicly accessible URL to download the file. */ - url?: string | null; - }; + url?: string | null + } /** FinancialReportingFinanceReportRunRunParameters */ financial_reporting_finance_report_run_run_parameters: { /** @description The set of output columns requested for inclusion in the report run. */ - columns?: string[]; + columns?: string[] /** @description Connected account ID by which to filter the report run. */ - connected_account?: string; + connected_account?: string /** @description Currency of objects to be included in the report run. */ - currency?: string; + currency?: string /** * Format: unix-time * @description Ending timestamp of data to be included in the report run (exclusive). */ - interval_end?: number; + interval_end?: number /** * Format: unix-time * @description Starting timestamp of data to be included in the report run. */ - interval_start?: number; + interval_start?: number /** @description Payout ID by which to filter the report run. */ - payout?: string; + payout?: string /** @description Category of balance transactions to be included in the report run. */ - reporting_category?: string; + reporting_category?: string /** @description 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?: string; - }; + timezone?: string + } /** * GelatoDataDocumentReportDateOfBirth * @description Point in Time */ gelato_data_document_report_date_of_birth: { /** @description Numerical day between 1 and 31. */ - day?: number | null; + day?: number | null /** @description Numerical month between 1 and 12. */ - month?: number | null; + month?: number | null /** @description The four-digit year. */ - year?: number | null; - }; + year?: number | null + } /** * GelatoDataDocumentReportExpirationDate * @description Point in Time */ gelato_data_document_report_expiration_date: { /** @description Numerical day between 1 and 31. */ - day?: number | null; + day?: number | null /** @description Numerical month between 1 and 12. */ - month?: number | null; + month?: number | null /** @description The four-digit year. */ - year?: number | null; - }; + year?: number | null + } /** * GelatoDataDocumentReportIssuedDate * @description Point in Time */ gelato_data_document_report_issued_date: { /** @description Numerical day between 1 and 31. */ - day?: number | null; + day?: number | null /** @description Numerical month between 1 and 12. */ - month?: number | null; + month?: number | null /** @description The four-digit year. */ - year?: number | null; - }; + year?: number | null + } /** * GelatoDataIdNumberReportDate * @description Point in Time */ gelato_data_id_number_report_date: { /** @description Numerical day between 1 and 31. */ - day?: number | null; + day?: number | null /** @description Numerical month between 1 and 12. */ - month?: number | null; + month?: number | null /** @description The four-digit year. */ - year?: number | null; - }; + year?: number | null + } /** * GelatoDataVerifiedOutputsDate * @description Point in Time */ gelato_data_verified_outputs_date: { /** @description Numerical day between 1 and 31. */ - day?: number | null; + day?: number | null /** @description Numerical month between 1 and 12. */ - month?: number | null; + month?: number | null /** @description The four-digit year. */ - year?: number | null; - }; + year?: number | null + } /** * GelatoDocumentReport * @description Result from a document check */ gelato_document_report: { /** @description Address as it appears in the document. */ - address?: Partial | null; + address?: Partial | null /** @description Date of birth as it appears in the document. */ - dob?: Partial | null; + dob?: Partial | null /** @description Details on the verification error. Present when status is `unverified`. */ - error?: Partial | null; + error?: Partial | null /** @description Expiration date of the document. */ - expiration_date?: Partial | null; + expiration_date?: Partial | null /** @description Array of [File](https://stripe.com/docs/api/files) ids containing images for this document. */ - files?: string[] | null; + files?: string[] | null /** @description First name as it appears in the document. */ - first_name?: string | null; + first_name?: string | null /** @description Issued date of the document. */ - issued_date?: Partial | null; + issued_date?: Partial | null /** @description Issuing country of the document. */ - issuing_country?: string | null; + issuing_country?: string | null /** @description Last name as it appears in the document. */ - last_name?: string | null; + last_name?: string | null /** @description Document ID number. */ - number?: string | null; + number?: string | null /** * @description Status of this `document` check. * @enum {string} */ - status: "unverified" | "verified"; + status: 'unverified' | 'verified' /** * @description Type of the document. * @enum {string|null} */ - type?: ("driving_license" | "id_card" | "passport") | null; - }; + type?: ('driving_license' | 'id_card' | 'passport') | null + } /** GelatoDocumentReportError */ gelato_document_report_error: { /** * @description A short machine-readable string giving the reason for the verification failure. * @enum {string|null} */ - code?: ("document_expired" | "document_type_not_supported" | "document_unverified_other") | null; + code?: ('document_expired' | 'document_type_not_supported' | 'document_unverified_other') | null /** @description A human-readable message giving the reason for the failure. These messages can be shown to your users. */ - reason?: string | null; - }; + reason?: string | null + } /** * GelatoIdNumberReport * @description Result from an id_number check */ gelato_id_number_report: { /** @description Date of birth. */ - dob?: Partial | null; + dob?: Partial | null /** @description Details on the verification error. Present when status is `unverified`. */ - error?: Partial | null; + error?: Partial | null /** @description First name. */ - first_name?: string | null; + first_name?: string | null /** @description ID number. */ - id_number?: string | null; + id_number?: string | null /** * @description Type of ID number. * @enum {string|null} */ - id_number_type?: ("br_cpf" | "sg_nric" | "us_ssn") | null; + id_number_type?: ('br_cpf' | 'sg_nric' | 'us_ssn') | null /** @description Last name. */ - last_name?: string | null; + last_name?: string | null /** * @description Status of this `id_number` check. * @enum {string} */ - status: "unverified" | "verified"; - }; + status: 'unverified' | 'verified' + } /** GelatoIdNumberReportError */ gelato_id_number_report_error: { /** * @description A short machine-readable string giving the reason for the verification failure. * @enum {string|null} */ - code?: ("id_number_insufficient_document_data" | "id_number_mismatch" | "id_number_unverified_other") | null; + code?: ('id_number_insufficient_document_data' | 'id_number_mismatch' | 'id_number_unverified_other') | null /** @description A human-readable message giving the reason for the failure. These messages can be shown to your users. */ - reason?: string | null; - }; + reason?: string | null + } /** GelatoReportDocumentOptions */ gelato_report_document_options: { /** @description 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?: ("driving_license" | "id_card" | "passport")[]; + allowed_types?: ('driving_license' | 'id_card' | 'passport')[] /** @description 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?: boolean; + require_id_number?: boolean /** @description Disable image uploads, identity document images have to be captured using the device’s camera. */ - require_live_capture?: boolean; + require_live_capture?: boolean /** @description 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?: boolean; - }; + require_matching_selfie?: boolean + } /** GelatoReportIdNumberOptions */ - gelato_report_id_number_options: { [key: string]: unknown }; + gelato_report_id_number_options: { [key: string]: unknown } /** * GelatoSelfieReport * @description Result from a selfie check */ gelato_selfie_report: { /** @description ID of the [File](https://stripe.com/docs/api/files) holding the image of the identity document used in this check. */ - document?: string | null; + document?: string | null /** @description Details on the verification error. Present when status is `unverified`. */ - error?: Partial | null; + error?: Partial | null /** @description ID of the [File](https://stripe.com/docs/api/files) holding the image of the selfie used in this check. */ - selfie?: string | null; + selfie?: string | null /** * @description Status of this `selfie` check. * @enum {string} */ - status: "unverified" | "verified"; - }; + status: 'unverified' | 'verified' + } /** GelatoSelfieReportError */ gelato_selfie_report_error: { /** * @description A short machine-readable string giving the reason for the verification failure. * @enum {string|null} */ - code?: - | ("selfie_document_missing_photo" | "selfie_face_mismatch" | "selfie_manipulated" | "selfie_unverified_other") - | null; + code?: ('selfie_document_missing_photo' | 'selfie_face_mismatch' | 'selfie_manipulated' | 'selfie_unverified_other') | null /** @description A human-readable message giving the reason for the failure. These messages can be shown to your users. */ - reason?: string | null; - }; + reason?: string | null + } /** GelatoSessionDocumentOptions */ gelato_session_document_options: { /** @description 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?: ("driving_license" | "id_card" | "passport")[]; + allowed_types?: ('driving_license' | 'id_card' | 'passport')[] /** @description 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?: boolean; + require_id_number?: boolean /** @description Disable image uploads, identity document images have to be captured using the device’s camera. */ - require_live_capture?: boolean; + require_live_capture?: boolean /** @description 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?: boolean; - }; + require_matching_selfie?: boolean + } /** GelatoSessionIdNumberOptions */ - gelato_session_id_number_options: { [key: string]: unknown }; + gelato_session_id_number_options: { [key: string]: unknown } /** * GelatoSessionLastError * @description Shows last VerificationSession error @@ -4935,54 +4894,54 @@ export interface components { */ code?: | ( - | "abandoned" - | "consent_declined" - | "country_not_supported" - | "device_not_supported" - | "document_expired" - | "document_type_not_supported" - | "document_unverified_other" - | "id_number_insufficient_document_data" - | "id_number_mismatch" - | "id_number_unverified_other" - | "selfie_document_missing_photo" - | "selfie_face_mismatch" - | "selfie_manipulated" - | "selfie_unverified_other" - | "under_supported_age" + | 'abandoned' + | 'consent_declined' + | 'country_not_supported' + | 'device_not_supported' + | 'document_expired' + | 'document_type_not_supported' + | 'document_unverified_other' + | 'id_number_insufficient_document_data' + | 'id_number_mismatch' + | 'id_number_unverified_other' + | 'selfie_document_missing_photo' + | 'selfie_face_mismatch' + | 'selfie_manipulated' + | 'selfie_unverified_other' + | 'under_supported_age' ) - | null; + | null /** @description A message that explains the reason for verification or user-session failure. */ - reason?: string | null; - }; + reason?: string | null + } /** GelatoVerificationReportOptions */ gelato_verification_report_options: { - document?: components["schemas"]["gelato_report_document_options"]; - id_number?: components["schemas"]["gelato_report_id_number_options"]; - }; + document?: components['schemas']['gelato_report_document_options'] + id_number?: components['schemas']['gelato_report_id_number_options'] + } /** GelatoVerificationSessionOptions */ gelato_verification_session_options: { - document?: components["schemas"]["gelato_session_document_options"]; - id_number?: components["schemas"]["gelato_session_id_number_options"]; - }; + document?: components['schemas']['gelato_session_document_options'] + id_number?: components['schemas']['gelato_session_id_number_options'] + } /** GelatoVerifiedOutputs */ gelato_verified_outputs: { /** @description The user's verified address. */ - address?: Partial | null; + address?: Partial | null /** @description The user’s verified date of birth. */ - dob?: Partial | null; + dob?: Partial | null /** @description The user's verified first name. */ - first_name?: string | null; + first_name?: string | null /** @description The user's verified id number. */ - id_number?: string | null; + id_number?: string | null /** * @description The user's verified id number type. * @enum {string|null} */ - id_number_type?: ("br_cpf" | "sg_nric" | "us_ssn") | null; + id_number_type?: ('br_cpf' | 'sg_nric' | 'us_ssn') | null /** @description The user's verified last name. */ - last_name?: string | null; - }; + last_name?: string | null + } /** * GelatoVerificationReport * @description A VerificationReport is the result of an attempt to collect and verify data from a user. @@ -4997,33 +4956,33 @@ export interface components { * * Related guides: [Accessing verification results](https://stripe.com/docs/identity/verification-sessions#results). */ - "identity.verification_report": { + 'identity.verification_report': { /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; - document?: components["schemas"]["gelato_document_report"]; + created: number + document?: components['schemas']['gelato_document_report'] /** @description Unique identifier for the object. */ - id: string; - id_number?: components["schemas"]["gelato_id_number_report"]; + id: string + id_number?: components['schemas']['gelato_id_number_report'] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "identity.verification_report"; - options: components["schemas"]["gelato_verification_report_options"]; - selfie?: components["schemas"]["gelato_selfie_report"]; + object: 'identity.verification_report' + options: components['schemas']['gelato_verification_report_options'] + selfie?: components['schemas']['gelato_selfie_report'] /** * @description Type of report. * @enum {string} */ - type: "document" | "id_number"; + type: 'document' | 'id_number' /** @description ID of the VerificationSession that created this report. */ - verification_session?: string | null; - }; + verification_session?: string | null + } /** * GelatoVerificationSession * @description A VerificationSession guides you through the process of collecting and verifying the identities @@ -5038,49 +4997,47 @@ export interface components { * * Related guide: [The Verification Sessions API](https://stripe.com/docs/identity/verification-sessions) */ - "identity.verification_session": { + 'identity.verification_session': { /** @description 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?: string | null; + client_secret?: string | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Unique identifier for the object. */ - id: string; + id: string /** @description If present, this property tells you the last error encountered when processing the verification. */ - last_error?: Partial | null; + last_error?: Partial | null /** @description ID of the most recent VerificationReport. [Learn more about accessing detailed verification results.](https://stripe.com/docs/identity/verification-sessions#results) */ - last_verification_report?: - | (Partial & Partial) - | null; + last_verification_report?: (Partial & Partial) | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "identity.verification_session"; - options: components["schemas"]["gelato_verification_session_options"]; + object: 'identity.verification_session' + options: components['schemas']['gelato_verification_session_options'] /** @description Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null. */ - redaction?: Partial | null; + redaction?: Partial | null /** * @description Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work). * @enum {string} */ - status: "canceled" | "processing" | "requires_input" | "verified"; + status: 'canceled' | 'processing' | 'requires_input' | 'verified' /** * @description The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. * @enum {string} */ - type: "document" | "id_number"; + type: 'document' | 'id_number' /** @description 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?: string | null; + url?: string | null /** @description The user’s verified data. */ - verified_outputs?: Partial | null; - }; + verified_outputs?: Partial | null + } /** * Invoice * @description Invoices are statements of amounts owed by a customer, and are either @@ -5118,333 +5075,321 @@ export interface components { */ invoice: { /** @description The country of the business associated with this invoice, most often the business creating the invoice. */ - account_country?: string | null; + account_country?: string | null /** @description The public name of the business associated with this invoice, most often the business creating the invoice. */ - account_name?: string | null; + account_name?: string | null /** @description The account tax IDs associated with the invoice. Only editable when the invoice is a draft. */ - account_tax_ids?: - | (Partial & - Partial & - Partial)[] - | null; + account_tax_ids?: (Partial & Partial & Partial)[] | null /** @description 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: number; + amount_due: number /** @description The amount, in %s, that was paid. */ - amount_paid: number; + amount_paid: number /** @description The amount remaining, in %s, that is due. */ - amount_remaining: number; + amount_remaining: number /** @description The fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account when the invoice is paid. */ - application_fee_amount?: number | null; + application_fee_amount?: number | null /** @description 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. */ - attempt_count: number; + attempt_count: number /** @description 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: boolean; + attempted: boolean /** @description Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice. When `false`, the invoice's state will not automatically advance without an explicit action. */ - auto_advance?: boolean; - automatic_tax: components["schemas"]["automatic_tax"]; + auto_advance?: boolean + automatic_tax: components['schemas']['automatic_tax'] /** * @description Indicates the reason why the invoice was created. `subscription_cycle` indicates an invoice created by a subscription advancing into a new period. `subscription_create` indicates an invoice created due to creating a subscription. `subscription_update` indicates an invoice created due to updating a subscription. `subscription` is set for all old invoices to indicate either a change to a subscription or a period advancement. `manual` is set for all invoices unrelated to a subscription (for example: created via the invoice editor). The `upcoming` value is reserved for simulated invoices per the upcoming invoice endpoint. `subscription_threshold` indicates an invoice created due to a billing threshold being reached. * @enum {string|null} */ billing_reason?: | ( - | "automatic_pending_invoice_item_invoice" - | "manual" - | "quote_accept" - | "subscription" - | "subscription_create" - | "subscription_cycle" - | "subscription_threshold" - | "subscription_update" - | "upcoming" + | 'automatic_pending_invoice_item_invoice' + | 'manual' + | 'quote_accept' + | 'subscription' + | 'subscription_create' + | 'subscription_cycle' + | 'subscription_threshold' + | 'subscription_update' + | 'upcoming' ) - | null; + | null /** @description ID of the latest charge generated for this invoice, if any. */ - charge?: (Partial & Partial) | null; + charge?: (Partial & Partial) | null /** * @description 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. * @enum {string} */ - collection_method: "charge_automatically" | "send_invoice"; + collection_method: 'charge_automatically' | 'send_invoice' /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Custom fields displayed on the invoice. */ - custom_fields?: components["schemas"]["invoice_setting_custom_field"][] | null; + custom_fields?: components['schemas']['invoice_setting_custom_field'][] | null /** @description The ID of the customer who will be billed. */ - customer?: - | (Partial & - Partial & - Partial) - | null; + customer?: (Partial & Partial & Partial) | null /** @description 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?: Partial | null; + customer_address?: Partial | null /** @description 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?: string | null; + customer_email?: string | null /** @description 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?: string | null; + customer_name?: string | null /** @description 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?: string | null; + customer_phone?: string | null /** @description 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?: Partial | null; + customer_shipping?: Partial | null /** * @description 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. * @enum {string|null} */ - customer_tax_exempt?: ("exempt" | "none" | "reverse") | null; + customer_tax_exempt?: ('exempt' | 'none' | 'reverse') | null /** @description 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?: components["schemas"]["invoices_resource_invoice_tax_id"][] | null; + customer_tax_ids?: components['schemas']['invoices_resource_invoice_tax_id'][] | null /** @description 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?: (Partial & Partial) | null; + default_payment_method?: (Partial & Partial) | null /** @description 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?: | (Partial & - Partial & - Partial & - Partial & - Partial & - Partial) - | null; + Partial & + Partial & + Partial & + Partial & + Partial) + | null /** @description The tax rates applied to this invoice, if any. */ - default_tax_rates: components["schemas"]["tax_rate"][]; + default_tax_rates: components['schemas']['tax_rate'][] /** @description An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. */ - description?: string | null; + description?: string | null /** @description Describes the current discount applied to this invoice, if there is one. Not populated if there are multiple discounts. */ - discount?: Partial | null; + discount?: Partial | null /** @description The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount. */ - discounts?: - | (Partial & - Partial & - Partial)[] - | null; + discounts?: (Partial & Partial & Partial)[] | null /** * Format: unix-time * @description The date on which payment for this invoice is due. This value will be `null` for invoices where `collection_method=charge_automatically`. */ - due_date?: number | null; + due_date?: number | null /** @description 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?: number | null; + ending_balance?: number | null /** @description Footer displayed on the invoice. */ - footer?: string | null; + footer?: string | null /** @description 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?: string | null; + hosted_invoice_url?: string | null /** @description Unique identifier for the object. */ - id?: string; + id?: string /** @description The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null. */ - invoice_pdf?: string | null; + invoice_pdf?: string | null /** @description The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized. */ - last_finalization_error?: Partial | null; + last_finalization_error?: Partial | null /** * InvoiceLinesList * @description The individual line items that make up the invoice. `lines` is sorted as follows: invoice items in reverse chronological order, followed by the subscription, if any. */ lines: { /** @description Details about each object. */ - data: components["schemas"]["line_item"][]; + data: components['schemas']['line_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * Format: unix-time * @description The time at which payment will next be attempted. This value will be `null` for invoices where `collection_method=send_invoice`. */ - next_payment_attempt?: number | null; + next_payment_attempt?: number | null /** @description 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?: string | null; + number?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "invoice"; + object: 'invoice' /** @description 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?: (Partial & Partial) | null; + on_behalf_of?: (Partial & Partial) | null /** @description 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: boolean; + paid: boolean /** @description 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: boolean; + paid_out_of_band: boolean /** @description 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?: (Partial & Partial) | null; - payment_settings: components["schemas"]["invoices_payment_settings"]; + payment_intent?: (Partial & Partial) | null + payment_settings: components['schemas']['invoices_payment_settings'] /** * Format: unix-time * @description End of the usage period during which invoice items were added to this invoice. */ - period_end: number; + period_end: number /** * Format: unix-time * @description Start of the usage period during which invoice items were added to this invoice. */ - period_start: number; + period_start: number /** @description Total amount of all post-payment credit notes issued for this invoice. */ - post_payment_credit_notes_amount: number; + post_payment_credit_notes_amount: number /** @description Total amount of all pre-payment credit notes issued for this invoice. */ - pre_payment_credit_notes_amount: number; + pre_payment_credit_notes_amount: number /** @description The quote this invoice was generated from. */ - quote?: (Partial & Partial) | null; + quote?: (Partial & Partial) | null /** @description This is the transaction number that appears on email receipts sent for this invoice. */ - receipt_number?: string | null; + receipt_number?: string | null /** @description Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. */ - starting_balance: number; + starting_balance: number /** @description Extra information about an invoice for the customer's credit card statement. */ - statement_descriptor?: string | null; + statement_descriptor?: string | null /** * @description The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview) * @enum {string|null} */ - status?: ("deleted" | "draft" | "open" | "paid" | "uncollectible" | "void") | null; - status_transitions: components["schemas"]["invoices_status_transitions"]; + status?: ('deleted' | 'draft' | 'open' | 'paid' | 'uncollectible' | 'void') | null + status_transitions: components['schemas']['invoices_status_transitions'] /** @description The subscription that this invoice was prepared for, if any. */ - subscription?: (Partial & Partial) | null; + subscription?: (Partial & Partial) | null /** @description Only set for upcoming invoices that preview prorations. The time used to calculate prorations. */ - subscription_proration_date?: number; + subscription_proration_date?: number /** @description Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated */ - subtotal: number; + subtotal: number /** @description The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice. */ - tax?: number | null; - threshold_reason?: components["schemas"]["invoice_threshold_reason"]; + tax?: number | null + threshold_reason?: components['schemas']['invoice_threshold_reason'] /** @description Total after discounts and taxes. */ - total: number; + total: number /** @description The aggregate amounts calculated per discount across all line items. */ - total_discount_amounts?: components["schemas"]["discounts_resource_discount_amount"][] | null; + total_discount_amounts?: components['schemas']['discounts_resource_discount_amount'][] | null /** @description The aggregate amounts calculated per tax rate for all line items. */ - total_tax_amounts: components["schemas"]["invoice_tax_amount"][]; + total_tax_amounts: components['schemas']['invoice_tax_amount'][] /** @description 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?: Partial | null; + transfer_data?: Partial | null /** * Format: unix-time * @description 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?: number | null; - }; + webhooks_delivered_at?: number | null + } /** InvoiceItemThresholdReason */ invoice_item_threshold_reason: { /** @description The IDs of the line items that triggered the threshold invoice. */ - line_item_ids: string[]; + line_item_ids: string[] /** @description The quantity threshold boundary that applied to the given line item. */ - usage_gte: number; - }; + usage_gte: number + } /** InvoiceLineItemPeriod */ invoice_line_item_period: { /** * Format: unix-time * @description End of the line item's billing period */ - end: number; + end: number /** * Format: unix-time * @description Start of the line item's billing period */ - start: number; - }; + start: number + } /** invoice_mandate_options_card */ invoice_mandate_options_card: { /** @description Amount to be charged for future payments. */ - amount?: number | null; + amount?: number | null /** * @description 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. * @enum {string|null} */ - amount_type?: ("fixed" | "maximum") | null; + amount_type?: ('fixed' | 'maximum') | null /** @description A description of the mandate or subscription that is meant to be displayed to the customer. */ - description?: string | null; - }; + description?: string | null + } /** invoice_payment_method_options_acss_debit */ invoice_payment_method_options_acss_debit: { - mandate_options?: components["schemas"]["invoice_payment_method_options_acss_debit_mandate_options"]; + mandate_options?: components['schemas']['invoice_payment_method_options_acss_debit_mandate_options'] /** * @description Bank account verification method. * @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; - }; + verification_method?: 'automatic' | 'instant' | 'microdeposits' + } /** invoice_payment_method_options_acss_debit_mandate_options */ invoice_payment_method_options_acss_debit_mandate_options: { /** * @description Transaction type of the mandate. * @enum {string|null} */ - transaction_type?: ("business" | "personal") | null; - }; + transaction_type?: ('business' | 'personal') | null + } /** invoice_payment_method_options_bancontact */ invoice_payment_method_options_bancontact: { /** * @description Preferred language of the Bancontact authorization page that the customer is redirected to. * @enum {string} */ - preferred_language: "de" | "en" | "fr" | "nl"; - }; + preferred_language: 'de' | 'en' | 'fr' | 'nl' + } /** invoice_payment_method_options_card */ invoice_payment_method_options_card: { /** * @description 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#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. * @enum {string|null} */ - request_three_d_secure?: ("any" | "automatic") | null; - }; + request_three_d_secure?: ('any' | 'automatic') | null + } /** InvoiceSettingCustomField */ invoice_setting_custom_field: { /** @description The name of the custom field. */ - name: string; + name: string /** @description The value of the custom field. */ - value: string; - }; + value: string + } /** InvoiceSettingCustomerSetting */ invoice_setting_customer_setting: { /** @description Default custom fields to be displayed on invoices for this customer. */ - custom_fields?: components["schemas"]["invoice_setting_custom_field"][] | null; + custom_fields?: components['schemas']['invoice_setting_custom_field'][] | null /** @description 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?: (Partial & Partial) | null; + default_payment_method?: (Partial & Partial) | null /** @description Default footer to be displayed on invoices for this customer. */ - footer?: string | null; - }; + footer?: string | null + } /** InvoiceSettingQuoteSetting */ invoice_setting_quote_setting: { /** @description 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?: number | null; - }; + days_until_due?: number | null + } /** InvoiceSettingSubscriptionScheduleSetting */ invoice_setting_subscription_schedule_setting: { /** @description 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?: number | null; - }; + days_until_due?: number | null + } /** InvoiceTaxAmount */ invoice_tax_amount: { /** @description The amount, in %s, of the tax. */ - amount: number; + amount: number /** @description Whether this tax amount is inclusive or exclusive. */ - inclusive: boolean; + inclusive: boolean /** @description The tax rate that was applied to get this tax amount. */ - tax_rate: Partial & Partial; - }; + tax_rate: Partial & Partial + } /** InvoiceThresholdReason */ invoice_threshold_reason: { /** @description The total invoice amount threshold boundary if it triggered the threshold invoice. */ - amount_gte?: number | null; + amount_gte?: number | null /** @description Indicates which line items triggered a threshold invoice. */ - item_reasons: components["schemas"]["invoice_item_threshold_reason"][]; - }; + item_reasons: components['schemas']['invoice_item_threshold_reason'][] + } /** InvoiceTransferData */ invoice_transfer_data: { /** @description The amount in %s that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination. */ - amount?: number | null; + amount?: number | null /** @description The account where funds from the payment will be transferred to upon payment success. */ - destination: Partial & Partial; - }; + destination: Partial & Partial + } /** * InvoiceItem * @description Sometimes you want to add a charge or credit to a customer, but actually @@ -5457,92 +5402,90 @@ export interface components { */ invoiceitem: { /** @description Amount (in the `currency` specified) of the invoice item. This should always be equal to `unit_amount * quantity`. */ - amount: number; + amount: number /** @description 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: string; + currency: string /** @description The ID of the customer who will be billed when this invoice item is billed. */ - customer: Partial & - Partial & - Partial; + customer: Partial & Partial & Partial /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - date: number; + date: number /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description If true, discounts will apply to this invoice item. Always false for prorations. */ - discountable: boolean; + discountable: boolean /** @description The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount. */ - discounts?: (Partial & Partial)[] | null; + discounts?: (Partial & Partial)[] | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The ID of the invoice this invoice item belongs to. */ - invoice?: (Partial & Partial) | null; + invoice?: (Partial & Partial) | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "invoiceitem"; - period: components["schemas"]["invoice_line_item_period"]; + object: 'invoiceitem' + period: components['schemas']['invoice_line_item_period'] /** @description The price of the invoice item. */ - price?: Partial | null; + price?: Partial | null /** @description Whether the invoice item was created automatically as a proration adjustment when the customer switched plans. */ - proration: boolean; + proration: boolean /** @description 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: number; + quantity: number /** @description The subscription that this invoice item has been created for, if any. */ - subscription?: (Partial & Partial) | null; + subscription?: (Partial & Partial) | null /** @description The subscription item that this invoice item has been created for, if any. */ - subscription_item?: string; + subscription_item?: string /** @description 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?: components["schemas"]["tax_rate"][] | null; + tax_rates?: components['schemas']['tax_rate'][] | null /** @description Unit amount (in the `currency` specified) of the invoice item. */ - unit_amount?: number | null; + unit_amount?: number | null /** * Format: decimal * @description Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. */ - unit_amount_decimal?: string | null; - }; + unit_amount_decimal?: string | null + } /** InvoicesPaymentMethodOptions */ invoices_payment_method_options: { /** @description 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?: Partial | null; + acss_debit?: Partial | null /** @description If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent. */ - bancontact?: Partial | null; + bancontact?: Partial | null /** @description If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent. */ - card?: Partial | null; - }; + card?: Partial | null + } /** InvoicesPaymentSettings */ invoices_payment_settings: { /** @description Payment-method-specific configuration to provide to the invoice’s PaymentIntent. */ - payment_method_options?: Partial | null; + payment_method_options?: Partial | null /** @description 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?: | ( - | "ach_credit_transfer" - | "ach_debit" - | "acss_debit" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "sepa_debit" - | "sofort" - | "wechat_pay" + | 'ach_credit_transfer' + | 'ach_debit' + | 'acss_debit' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' )[] - | null; - }; + | null + } /** InvoicesResourceInvoiceTaxID */ invoices_resource_invoice_tax_id: { /** @@ -5550,75 +5493,75 @@ export interface components { * @enum {string} */ type: - | "ae_trn" - | "au_abn" - | "au_arn" - | "br_cnpj" - | "br_cpf" - | "ca_bn" - | "ca_gst_hst" - | "ca_pst_bc" - | "ca_pst_mb" - | "ca_pst_sk" - | "ca_qst" - | "ch_vat" - | "cl_tin" - | "es_cif" - | "eu_vat" - | "gb_vat" - | "ge_vat" - | "hk_br" - | "id_npwp" - | "il_vat" - | "in_gst" - | "is_vat" - | "jp_cn" - | "jp_rn" - | "kr_brn" - | "li_uid" - | "mx_rfc" - | "my_frp" - | "my_itn" - | "my_sst" - | "no_vat" - | "nz_gst" - | "ru_inn" - | "ru_kpp" - | "sa_vat" - | "sg_gst" - | "sg_uen" - | "th_vat" - | "tw_vat" - | "ua_vat" - | "unknown" - | "us_ein" - | "za_vat"; + | 'ae_trn' + | 'au_abn' + | 'au_arn' + | 'br_cnpj' + | 'br_cpf' + | 'ca_bn' + | 'ca_gst_hst' + | 'ca_pst_bc' + | 'ca_pst_mb' + | 'ca_pst_sk' + | 'ca_qst' + | 'ch_vat' + | 'cl_tin' + | 'es_cif' + | 'eu_vat' + | 'gb_vat' + | 'ge_vat' + | 'hk_br' + | 'id_npwp' + | 'il_vat' + | 'in_gst' + | 'is_vat' + | 'jp_cn' + | 'jp_rn' + | 'kr_brn' + | 'li_uid' + | 'mx_rfc' + | 'my_frp' + | 'my_itn' + | 'my_sst' + | 'no_vat' + | 'nz_gst' + | 'ru_inn' + | 'ru_kpp' + | 'sa_vat' + | 'sg_gst' + | 'sg_uen' + | 'th_vat' + | 'tw_vat' + | 'ua_vat' + | 'unknown' + | 'us_ein' + | 'za_vat' /** @description The value of the tax ID. */ - value?: string | null; - }; + value?: string | null + } /** InvoicesStatusTransitions */ invoices_status_transitions: { /** * Format: unix-time * @description The time that the invoice draft was finalized. */ - finalized_at?: number | null; + finalized_at?: number | null /** * Format: unix-time * @description The time that the invoice was marked uncollectible. */ - marked_uncollectible_at?: number | null; + marked_uncollectible_at?: number | null /** * Format: unix-time * @description The time that the invoice was paid. */ - paid_at?: number | null; + paid_at?: number | null /** * Format: unix-time * @description The time that the invoice was voided. */ - voided_at?: number | null; - }; + voided_at?: number | null + } /** * IssuerFraudRecord * @description This resource has been renamed to [Early Fraud @@ -5627,30 +5570,30 @@ export interface components { */ issuer_fraud_record: { /** @description An IFR 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 IFR, in order to avoid receiving a dispute later. */ - actionable: boolean; + actionable: boolean /** @description ID of the charge this issuer fraud record is for, optionally expanded. */ - charge: Partial & Partial; + charge: Partial & Partial /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + fraud_type: string /** @description If true, the associated charge is subject to [liability shift](https://stripe.com/docs/payments/3d-secure#disputed-payments). */ - has_liability_shift: boolean; + has_liability_shift: boolean /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "issuer_fraud_record"; + object: 'issuer_fraud_record' /** @description The timestamp at which the card issuer posted the issuer fraud record. */ - post_date: number; - }; + post_date: number + } /** * IssuingAuthorization * @description When an [issued card](https://stripe.com/docs/issuing) is used to make a purchase, an Issuing `Authorization` @@ -5659,260 +5602,260 @@ export interface components { * * Related guide: [Issued Card Authorizations](https://stripe.com/docs/issuing/purchases/authorizations). */ - "issuing.authorization": { + 'issuing.authorization': { /** @description The total amount that was authorized or rejected. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ - amount: number; + amount: number /** @description 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?: Partial | null; + amount_details?: Partial | null /** @description Whether the authorization has been approved. */ - approved: boolean; + approved: boolean /** * @description How the card details were provided. * @enum {string} */ - authorization_method: "chip" | "contactless" | "keyed_in" | "online" | "swipe"; + authorization_method: 'chip' | 'contactless' | 'keyed_in' | 'online' | 'swipe' /** @description List of balance transactions associated with this authorization. */ - balance_transactions: components["schemas"]["balance_transaction"][]; - card: components["schemas"]["issuing.card"]; + balance_transactions: components['schemas']['balance_transaction'][] + card: components['schemas']['issuing.card'] /** @description The cardholder to whom this authorization belongs. */ - cardholder?: (Partial & Partial) | null; + cardholder?: (Partial & Partial) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: number; + merchant_amount: number /** @description The currency that was 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: string; - merchant_data: components["schemas"]["issuing_authorization_merchant_data"]; + merchant_currency: string + merchant_data: components['schemas']['issuing_authorization_merchant_data'] /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "issuing.authorization"; + object: 'issuing.authorization' /** @description The pending authorization request. This field will only be non-null during an `issuing_authorization.request` webhook. */ - pending_request?: Partial | null; + pending_request?: Partial | null /** @description History of every time `pending_request` was approved/denied, 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](https://stripe.com/docs/issuing/purchases/authorizations), you can look at this field to see the previous requests for the authorization. */ - request_history: components["schemas"]["issuing_authorization_request"][]; + request_history: components['schemas']['issuing_authorization_request'][] /** * @description The current status of the authorization in its lifecycle. * @enum {string} */ - status: "closed" | "pending" | "reversed"; + status: 'closed' | 'pending' | 'reversed' /** @description List of [transactions](https://stripe.com/docs/api/issuing/transactions) associated with this authorization. */ - transactions: components["schemas"]["issuing.transaction"][]; - verification_data: components["schemas"]["issuing_authorization_verification_data"]; + transactions: components['schemas']['issuing.transaction'][] + verification_data: components['schemas']['issuing_authorization_verification_data'] /** @description The digital wallet used for this authorization. One of `apple_pay`, `google_pay`, or `samsung_pay`. */ - wallet?: string | null; - }; + wallet?: string | null + } /** * IssuingCard * @description You can [create physical or virtual cards](https://stripe.com/docs/issuing/cards) that are issued to cardholders. */ - "issuing.card": { + 'issuing.card': { /** @description The brand of the card. */ - brand: string; + brand: string /** * @description The reason why the card was canceled. * @enum {string|null} */ - cancellation_reason?: ("lost" | "stolen") | null; - cardholder: components["schemas"]["issuing.cardholder"]; + cancellation_reason?: ('lost' | 'stolen') | null + cardholder: components['schemas']['issuing.cardholder'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description 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?: string; + cvc?: string /** @description The expiration month of the card. */ - exp_month: number; + exp_month: number /** @description The expiration year of the card. */ - exp_year: number; + exp_year: number /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The last 4 digits of the card number. */ - last4: string; + last4: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** @description 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?: string; + number?: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "issuing.card"; + object: 'issuing.card' /** @description The latest card that replaces this card, if any. */ - replaced_by?: (Partial & Partial) | null; + replaced_by?: (Partial & Partial) | null /** @description The card this card replaces, if any. */ - replacement_for?: (Partial & Partial) | null; + replacement_for?: (Partial & Partial) | null /** * @description The reason why the previous card needed to be replaced. * @enum {string|null} */ - replacement_reason?: ("damaged" | "expired" | "lost" | "stolen") | null; + replacement_reason?: ('damaged' | 'expired' | 'lost' | 'stolen') | null /** @description Where and how the card will be shipped. */ - shipping?: Partial | null; - spending_controls: components["schemas"]["issuing_card_authorization_controls"]; + shipping?: Partial | null + spending_controls: components['schemas']['issuing_card_authorization_controls'] /** * @description Whether authorizations can be approved on this card. * @enum {string} */ - status: "active" | "canceled" | "inactive"; + status: 'active' | 'canceled' | 'inactive' /** * @description The type of the card. * @enum {string} */ - type: "physical" | "virtual"; + type: 'physical' | 'virtual' /** @description Information relating to digital wallets (like Apple Pay and Google Pay). */ - wallets?: Partial | null; - }; + wallets?: Partial | null + } /** * IssuingCardholder * @description An Issuing `Cardholder` object represents an individual or business entity who is [issued](https://stripe.com/docs/issuing) cards. * * Related guide: [How to create a Cardholder](https://stripe.com/docs/issuing/cards#create-cardholder) */ - "issuing.cardholder": { - billing: components["schemas"]["issuing_cardholder_address"]; + 'issuing.cardholder': { + billing: components['schemas']['issuing_cardholder_address'] /** @description Additional information about a `company` cardholder. */ - company?: Partial | null; + company?: Partial | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The cardholder's email address. */ - email?: string | null; + email?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Additional information about an `individual` cardholder. */ - individual?: Partial | null; + individual?: Partial | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** @description The cardholder's name. This will be printed on cards issued to them. */ - name: string; + name: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "issuing.cardholder"; + object: 'issuing.cardholder' /** @description 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?: string | null; - requirements: components["schemas"]["issuing_cardholder_requirements"]; + phone_number?: string | null + requirements: components['schemas']['issuing_cardholder_requirements'] /** @description 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?: Partial | null; + spending_controls?: Partial | null /** * @description Specifies whether to permit authorizations on this cardholder's cards. * @enum {string} */ - status: "active" | "blocked" | "inactive"; + status: 'active' | 'blocked' | 'inactive' /** * @description One of `individual` or `company`. * @enum {string} */ - type: "company" | "individual"; - }; + type: 'company' | 'individual' + } /** * IssuingDispute * @description 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. * * Related guide: [Disputing Transactions](https://stripe.com/docs/issuing/purchases/disputes) */ - "issuing.dispute": { + 'issuing.dispute': { /** @description Disputed amount. Usually the amount of the `transaction`, but can differ (usually because of currency fluctuation). */ - amount: number; + amount: number /** @description List of balance transactions associated with the dispute. */ - balance_transactions?: components["schemas"]["balance_transaction"][] | null; + balance_transactions?: components['schemas']['balance_transaction'][] | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The currency the `transaction` was made in. */ - currency: string; - evidence: components["schemas"]["issuing_dispute_evidence"]; + currency: string + evidence: components['schemas']['issuing_dispute_evidence'] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "issuing.dispute"; + object: 'issuing.dispute' /** * @description Current status of the dispute. * @enum {string} */ - status: "expired" | "lost" | "submitted" | "unsubmitted" | "won"; + status: 'expired' | 'lost' | 'submitted' | 'unsubmitted' | 'won' /** @description The transaction being disputed. */ - transaction: Partial & Partial; - }; + transaction: Partial & Partial + } /** * IssuingSettlement * @description 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. */ - "issuing.settlement": { + 'issuing.settlement': { /** @description The Bank Identification Number reflecting this settlement record. */ - bin: string; + bin: string /** @description The date that the transactions are cleared and posted to user's accounts. */ - clearing_date: number; + clearing_date: number /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The total interchange received as reimbursement for the transactions. */ - interchange_fees: number; + interchange_fees: number /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** @description The total net amount required to settle with the network. */ - net_total: number; + net_total: number /** * @description The card network for this settlement report. One of ["visa"] * @enum {string} */ - network: "visa"; + network: 'visa' /** @description The total amount of fees owed to the network. */ - network_fees: number; + network_fees: number /** @description The Settlement Identification Number assigned by the network. */ - network_settlement_identifier: string; + network_settlement_identifier: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "issuing.settlement"; + object: 'issuing.settlement' /** @description One of `international` or `uk_national_net`. */ - settlement_service: string; + settlement_service: string /** @description The total number of transactions reflected in this settlement. */ - transaction_count: number; + transaction_count: number /** @description The total transaction amount reflected in this settlement. */ - transaction_volume: number; - }; + transaction_volume: number + } /** * IssuingTransaction * @description Any use of an [issued card](https://stripe.com/docs/issuing) that results in funds entering or leaving @@ -5921,2669 +5864,2662 @@ export interface components { * * Related guide: [Issued Card Transactions](https://stripe.com/docs/issuing/purchases/transactions). */ - "issuing.transaction": { + 'issuing.transaction': { /** @description 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: number; + amount: number /** @description 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?: Partial | null; + amount_details?: Partial | null /** @description The `Authorization` object that led to this transaction. */ - authorization?: (Partial & Partial) | null; + authorization?: (Partial & Partial) | null /** @description ID of the [balance transaction](https://stripe.com/docs/api/balance_transactions) associated with this transaction. */ - balance_transaction?: (Partial & Partial) | null; + balance_transaction?: (Partial & Partial) | null /** @description The card used to make this transaction. */ - card: Partial & Partial; + card: Partial & Partial /** @description The cardholder to whom this transaction belongs. */ - cardholder?: (Partial & Partial) | null; + cardholder?: (Partial & Partial) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description If you've disputed the transaction, the ID of the dispute. */ - dispute?: (Partial & Partial) | null; + dispute?: (Partial & Partial) | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: number; + merchant_amount: number /** @description The currency with which the merchant is taking payment. */ - merchant_currency: string; - merchant_data: components["schemas"]["issuing_authorization_merchant_data"]; + merchant_currency: string + merchant_data: components['schemas']['issuing_authorization_merchant_data'] /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "issuing.transaction"; + object: 'issuing.transaction' /** @description Additional purchase information that is optionally provided by the merchant. */ - purchase_details?: Partial | null; + purchase_details?: Partial | null /** * @description The nature of the transaction. * @enum {string} */ - type: "capture" | "refund"; + type: 'capture' | 'refund' /** * @description The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. * @enum {string|null} */ - wallet?: ("apple_pay" | "google_pay" | "samsung_pay") | null; - }; + wallet?: ('apple_pay' | 'google_pay' | 'samsung_pay') | null + } /** IssuingAuthorizationAmountDetails */ issuing_authorization_amount_details: { /** @description The fee charged by the ATM for the cash withdrawal. */ - atm_fee?: number | null; - }; + atm_fee?: number | null + } /** IssuingAuthorizationMerchantData */ issuing_authorization_merchant_data: { /** @description 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: string; + category: string /** @description The merchant category code for the seller’s business */ - category_code: string; + category_code: string /** @description City where the seller is located */ - city?: string | null; + city?: string | null /** @description Country where the seller is located */ - country?: string | null; + country?: string | null /** @description Name of the seller */ - name?: string | null; + name?: string | null /** @description Identifier assigned to the seller by the card brand */ - network_id: string; + network_id: string /** @description Postal code where the seller is located */ - postal_code?: string | null; + postal_code?: string | null /** @description State where the seller is located */ - state?: string | null; - }; + state?: string | null + } /** IssuingAuthorizationPendingRequest */ issuing_authorization_pending_request: { /** @description 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: number; + amount: number /** @description 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?: Partial | null; + amount_details?: Partial | null /** @description 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: string; + currency: string /** @description 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: boolean; + is_amount_controllable: boolean /** @description 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: number; + merchant_amount: number /** @description The local currency the merchant is requesting to authorize. */ - merchant_currency: string; - }; + merchant_currency: string + } /** IssuingAuthorizationRequest */ issuing_authorization_request: { /** @description 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: number; + amount: number /** @description 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?: Partial | null; + amount_details?: Partial | null /** @description Whether this request was approved. */ - approved: boolean; + approved: boolean /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description 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: number; + merchant_amount: number /** @description 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: string; + merchant_currency: string /** * @description The reason for the approval or decline. * @enum {string} */ reason: - | "account_disabled" - | "card_active" - | "card_inactive" - | "cardholder_inactive" - | "cardholder_verification_required" - | "insufficient_funds" - | "not_allowed" - | "spending_controls" - | "suspected_fraud" - | "verification_failed" - | "webhook_approved" - | "webhook_declined" - | "webhook_timeout"; - }; + | 'account_disabled' + | 'card_active' + | 'card_inactive' + | 'cardholder_inactive' + | 'cardholder_verification_required' + | 'insufficient_funds' + | 'not_allowed' + | 'spending_controls' + | 'suspected_fraud' + | 'verification_failed' + | 'webhook_approved' + | 'webhook_declined' + | 'webhook_timeout' + } /** IssuingAuthorizationVerificationData */ issuing_authorization_verification_data: { /** * @description Whether the cardholder provided an address first line and if it matched the cardholder’s `billing.address.line1`. * @enum {string} */ - address_line1_check: "match" | "mismatch" | "not_provided"; + address_line1_check: 'match' | 'mismatch' | 'not_provided' /** * @description Whether the cardholder provided a postal code and if it matched the cardholder’s `billing.address.postal_code`. * @enum {string} */ - address_postal_code_check: "match" | "mismatch" | "not_provided"; + address_postal_code_check: 'match' | 'mismatch' | 'not_provided' /** * @description Whether the cardholder provided a CVC and if it matched Stripe’s record. * @enum {string} */ - cvc_check: "match" | "mismatch" | "not_provided"; + cvc_check: 'match' | 'mismatch' | 'not_provided' /** * @description Whether the cardholder provided an expiry date and if it matched Stripe’s record. * @enum {string} */ - expiry_check: "match" | "mismatch" | "not_provided"; - }; + expiry_check: 'match' | 'mismatch' | 'not_provided' + } /** IssuingCardApplePay */ issuing_card_apple_pay: { /** @description Apple Pay Eligibility */ - eligible: boolean; + eligible: boolean /** * @description Reason the card is ineligible for Apple Pay * @enum {string|null} */ - ineligible_reason?: ("missing_agreement" | "missing_cardholder_contact" | "unsupported_region") | null; - }; + ineligible_reason?: ('missing_agreement' | 'missing_cardholder_contact' | 'unsupported_region') | null + } /** IssuingCardAuthorizationControls */ issuing_card_authorization_controls: { /** @description 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?: | ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' )[] - | null; + | null /** @description 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?: | ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' )[] - | null; + | null /** @description 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?: components["schemas"]["issuing_card_spending_limit"][] | null; + spending_limits?: components['schemas']['issuing_card_spending_limit'][] | null /** @description Currency of the amounts within `spending_limits`. Always the same as the currency of the card. */ - spending_limits_currency?: string | null; - }; + spending_limits_currency?: string | null + } /** IssuingCardGooglePay */ issuing_card_google_pay: { /** @description Google Pay Eligibility */ - eligible: boolean; + eligible: boolean /** * @description Reason the card is ineligible for Google Pay * @enum {string|null} */ - ineligible_reason?: ("missing_agreement" | "missing_cardholder_contact" | "unsupported_region") | null; - }; + ineligible_reason?: ('missing_agreement' | 'missing_cardholder_contact' | 'unsupported_region') | null + } /** IssuingCardShipping */ issuing_card_shipping: { - address: components["schemas"]["address"]; + address: components['schemas']['address'] /** * @description The delivery company that shipped a card. * @enum {string|null} */ - carrier?: ("dhl" | "fedex" | "royal_mail" | "usps") | null; + carrier?: ('dhl' | 'fedex' | 'royal_mail' | 'usps') | null /** * Format: unix-time * @description A unix timestamp representing a best estimate of when the card will be delivered. */ - eta?: number | null; + eta?: number | null /** @description Recipient name. */ - name: string; + name: string /** * @description Shipment service, such as `standard` or `express`. * @enum {string} */ - service: "express" | "priority" | "standard"; + service: 'express' | 'priority' | 'standard' /** * @description The delivery status of the card. * @enum {string|null} */ - status?: ("canceled" | "delivered" | "failure" | "pending" | "returned" | "shipped") | null; + status?: ('canceled' | 'delivered' | 'failure' | 'pending' | 'returned' | 'shipped') | null /** @description A tracking number for a card shipment. */ - tracking_number?: string | null; + tracking_number?: string | null /** @description A link to the shipping carrier's site where you can view detailed information about a card shipment. */ - tracking_url?: string | null; + tracking_url?: string | null /** * @description Packaging options. * @enum {string} */ - type: "bulk" | "individual"; - }; + type: 'bulk' | 'individual' + } /** IssuingCardSpendingLimit */ issuing_card_spending_limit: { /** @description Maximum amount allowed to spend per interval. */ - amount: number; + amount: number /** @description 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?: | ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' )[] - | null; + | null /** * @description Interval (or event) to which the amount applies. * @enum {string} */ - interval: "all_time" | "daily" | "monthly" | "per_authorization" | "weekly" | "yearly"; - }; + interval: 'all_time' | 'daily' | 'monthly' | 'per_authorization' | 'weekly' | 'yearly' + } /** IssuingCardWallets */ issuing_card_wallets: { - apple_pay: components["schemas"]["issuing_card_apple_pay"]; - google_pay: components["schemas"]["issuing_card_google_pay"]; + apple_pay: components['schemas']['issuing_card_apple_pay'] + google_pay: components['schemas']['issuing_card_google_pay'] /** @description Unique identifier for a card used with digital wallets */ - primary_account_identifier?: string | null; - }; + primary_account_identifier?: string | null + } /** IssuingCardholderAddress */ issuing_cardholder_address: { - address: components["schemas"]["address"]; - }; + address: components['schemas']['address'] + } /** IssuingCardholderAuthorizationControls */ issuing_cardholder_authorization_controls: { /** @description 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?: | ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' )[] - | null; + | null /** @description 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?: | ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' )[] - | null; + | null /** @description Limit spending with amount-based rules that apply across this cardholder's cards. */ - spending_limits?: components["schemas"]["issuing_cardholder_spending_limit"][] | null; + spending_limits?: components['schemas']['issuing_cardholder_spending_limit'][] | null /** @description Currency of the amounts within `spending_limits`. */ - spending_limits_currency?: string | null; - }; + spending_limits_currency?: string | null + } /** IssuingCardholderCompany */ issuing_cardholder_company: { /** @description Whether the company's business ID number was provided. */ - tax_id_provided: boolean; - }; + tax_id_provided: boolean + } /** IssuingCardholderIdDocument */ issuing_cardholder_id_document: { /** @description 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?: (Partial & Partial) | null; + back?: (Partial & Partial) | null /** @description 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?: (Partial & Partial) | null; - }; + front?: (Partial & Partial) | null + } /** IssuingCardholderIndividual */ issuing_cardholder_individual: { /** @description The date of birth of this cardholder. */ - dob?: Partial | null; + dob?: Partial | null /** @description The first name of this cardholder. */ - first_name: string; + first_name: string /** @description The last name of this cardholder. */ - last_name: string; + last_name: string /** @description Government-issued ID document for this cardholder. */ - verification?: Partial | null; - }; + verification?: Partial | null + } /** IssuingCardholderIndividualDOB */ issuing_cardholder_individual_dob: { /** @description The day of birth, between 1 and 31. */ - day?: number | null; + day?: number | null /** @description The month of birth, between 1 and 12. */ - month?: number | null; + month?: number | null /** @description The four-digit year of birth. */ - year?: number | null; - }; + year?: number | null + } /** IssuingCardholderRequirements */ issuing_cardholder_requirements: { /** * @description If `disabled_reason` is present, all cards will decline authorizations with `cardholder_verification_required` reason. * @enum {string|null} */ - disabled_reason?: ("listed" | "rejected.listed" | "under_review") | null; + disabled_reason?: ('listed' | 'rejected.listed' | 'under_review') | null /** @description Array of fields that need to be collected in order to verify and re-enable the cardholder. */ past_due?: | ( - | "company.tax_id" - | "individual.dob.day" - | "individual.dob.month" - | "individual.dob.year" - | "individual.first_name" - | "individual.last_name" - | "individual.verification.document" + | 'company.tax_id' + | 'individual.dob.day' + | 'individual.dob.month' + | 'individual.dob.year' + | 'individual.first_name' + | 'individual.last_name' + | 'individual.verification.document' )[] - | null; - }; + | null + } /** IssuingCardholderSpendingLimit */ issuing_cardholder_spending_limit: { /** @description Maximum amount allowed to spend per interval. */ - amount: number; + amount: number /** @description 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?: | ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' )[] - | null; + | null /** * @description Interval (or event) to which the amount applies. * @enum {string} */ - interval: "all_time" | "daily" | "monthly" | "per_authorization" | "weekly" | "yearly"; - }; + interval: 'all_time' | 'daily' | 'monthly' | 'per_authorization' | 'weekly' | 'yearly' + } /** IssuingCardholderVerification */ issuing_cardholder_verification: { /** @description An identifying document, either a passport or local ID card. */ - document?: Partial | null; - }; + document?: Partial | null + } /** IssuingDisputeCanceledEvidence */ issuing_dispute_canceled_evidence: { /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ - additional_documentation?: (Partial & Partial) | null; + additional_documentation?: (Partial & Partial) | null /** * Format: unix-time * @description Date when order was canceled. */ - canceled_at?: number | null; + canceled_at?: number | null /** @description Whether the cardholder was provided with a cancellation policy. */ - cancellation_policy_provided?: boolean | null; + cancellation_policy_provided?: boolean | null /** @description Reason for canceling the order. */ - cancellation_reason?: string | null; + cancellation_reason?: string | null /** * Format: unix-time * @description Date when the cardholder expected to receive the product. */ - expected_at?: number | null; + expected_at?: number | null /** @description Explanation of why the cardholder is disputing this transaction. */ - explanation?: string | null; + explanation?: string | null /** @description Description of the merchandise or service that was purchased. */ - product_description?: string | null; + product_description?: string | null /** * @description Whether the product was a merchandise or service. * @enum {string|null} */ - product_type?: ("merchandise" | "service") | null; + product_type?: ('merchandise' | 'service') | null /** * @description Result of cardholder's attempt to return the product. * @enum {string|null} */ - return_status?: ("merchant_rejected" | "successful") | null; + return_status?: ('merchant_rejected' | 'successful') | null /** * Format: unix-time * @description Date when the product was returned or attempted to be returned. */ - returned_at?: number | null; - }; + returned_at?: number | null + } /** IssuingDisputeDuplicateEvidence */ issuing_dispute_duplicate_evidence: { /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ - additional_documentation?: (Partial & Partial) | null; + additional_documentation?: (Partial & Partial) | null /** @description (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?: (Partial & Partial) | null; + card_statement?: (Partial & Partial) | null /** @description (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?: (Partial & Partial) | null; + cash_receipt?: (Partial & Partial) | null /** @description (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?: (Partial & Partial) | null; + check_image?: (Partial & Partial) | null /** @description Explanation of why the cardholder is disputing this transaction. */ - explanation?: string | null; + explanation?: string | null /** @description 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?: string | null; - }; + original_transaction?: string | null + } /** IssuingDisputeEvidence */ issuing_dispute_evidence: { - canceled?: components["schemas"]["issuing_dispute_canceled_evidence"]; - duplicate?: components["schemas"]["issuing_dispute_duplicate_evidence"]; - fraudulent?: components["schemas"]["issuing_dispute_fraudulent_evidence"]; - merchandise_not_as_described?: components["schemas"]["issuing_dispute_merchandise_not_as_described_evidence"]; - not_received?: components["schemas"]["issuing_dispute_not_received_evidence"]; - other?: components["schemas"]["issuing_dispute_other_evidence"]; + canceled?: components['schemas']['issuing_dispute_canceled_evidence'] + duplicate?: components['schemas']['issuing_dispute_duplicate_evidence'] + fraudulent?: components['schemas']['issuing_dispute_fraudulent_evidence'] + merchandise_not_as_described?: components['schemas']['issuing_dispute_merchandise_not_as_described_evidence'] + not_received?: components['schemas']['issuing_dispute_not_received_evidence'] + other?: components['schemas']['issuing_dispute_other_evidence'] /** * @description The reason for filing the dispute. Its value will match the field containing the evidence. * @enum {string} */ - reason: - | "canceled" - | "duplicate" - | "fraudulent" - | "merchandise_not_as_described" - | "not_received" - | "other" - | "service_not_as_described"; - service_not_as_described?: components["schemas"]["issuing_dispute_service_not_as_described_evidence"]; - }; + reason: 'canceled' | 'duplicate' | 'fraudulent' | 'merchandise_not_as_described' | 'not_received' | 'other' | 'service_not_as_described' + service_not_as_described?: components['schemas']['issuing_dispute_service_not_as_described_evidence'] + } /** IssuingDisputeFraudulentEvidence */ issuing_dispute_fraudulent_evidence: { /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ - additional_documentation?: (Partial & Partial) | null; + additional_documentation?: (Partial & Partial) | null /** @description Explanation of why the cardholder is disputing this transaction. */ - explanation?: string | null; - }; + explanation?: string | null + } /** IssuingDisputeMerchandiseNotAsDescribedEvidence */ issuing_dispute_merchandise_not_as_described_evidence: { /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ - additional_documentation?: (Partial & Partial) | null; + additional_documentation?: (Partial & Partial) | null /** @description Explanation of why the cardholder is disputing this transaction. */ - explanation?: string | null; + explanation?: string | null /** * Format: unix-time * @description Date when the product was received. */ - received_at?: number | null; + received_at?: number | null /** @description Description of the cardholder's attempt to return the product. */ - return_description?: string | null; + return_description?: string | null /** * @description Result of cardholder's attempt to return the product. * @enum {string|null} */ - return_status?: ("merchant_rejected" | "successful") | null; + return_status?: ('merchant_rejected' | 'successful') | null /** * Format: unix-time * @description Date when the product was returned or attempted to be returned. */ - returned_at?: number | null; - }; + returned_at?: number | null + } /** IssuingDisputeNotReceivedEvidence */ issuing_dispute_not_received_evidence: { /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ - additional_documentation?: (Partial & Partial) | null; + additional_documentation?: (Partial & Partial) | null /** * Format: unix-time * @description Date when the cardholder expected to receive the product. */ - expected_at?: number | null; + expected_at?: number | null /** @description Explanation of why the cardholder is disputing this transaction. */ - explanation?: string | null; + explanation?: string | null /** @description Description of the merchandise or service that was purchased. */ - product_description?: string | null; + product_description?: string | null /** * @description Whether the product was a merchandise or service. * @enum {string|null} */ - product_type?: ("merchandise" | "service") | null; - }; + product_type?: ('merchandise' | 'service') | null + } /** IssuingDisputeOtherEvidence */ issuing_dispute_other_evidence: { /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ - additional_documentation?: (Partial & Partial) | null; + additional_documentation?: (Partial & Partial) | null /** @description Explanation of why the cardholder is disputing this transaction. */ - explanation?: string | null; + explanation?: string | null /** @description Description of the merchandise or service that was purchased. */ - product_description?: string | null; + product_description?: string | null /** * @description Whether the product was a merchandise or service. * @enum {string|null} */ - product_type?: ("merchandise" | "service") | null; - }; + product_type?: ('merchandise' | 'service') | null + } /** IssuingDisputeServiceNotAsDescribedEvidence */ issuing_dispute_service_not_as_described_evidence: { /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ - additional_documentation?: (Partial & Partial) | null; + additional_documentation?: (Partial & Partial) | null /** * Format: unix-time * @description Date when order was canceled. */ - canceled_at?: number | null; + canceled_at?: number | null /** @description Reason for canceling the order. */ - cancellation_reason?: string | null; + cancellation_reason?: string | null /** @description Explanation of why the cardholder is disputing this transaction. */ - explanation?: string | null; + explanation?: string | null /** * Format: unix-time * @description Date when the product was received. */ - received_at?: number | null; - }; + received_at?: number | null + } /** IssuingTransactionAmountDetails */ issuing_transaction_amount_details: { /** @description The fee charged by the ATM for the cash withdrawal. */ - atm_fee?: number | null; - }; + atm_fee?: number | null + } /** IssuingTransactionFlightData */ issuing_transaction_flight_data: { /** @description The time that the flight departed. */ - departure_at?: number | null; + departure_at?: number | null /** @description The name of the passenger. */ - passenger_name?: string | null; + passenger_name?: string | null /** @description Whether the ticket is refundable. */ - refundable?: boolean | null; + refundable?: boolean | null /** @description The legs of the trip. */ - segments?: components["schemas"]["issuing_transaction_flight_data_leg"][] | null; + segments?: components['schemas']['issuing_transaction_flight_data_leg'][] | null /** @description The travel agency that issued the ticket. */ - travel_agency?: string | null; - }; + travel_agency?: string | null + } /** IssuingTransactionFlightDataLeg */ issuing_transaction_flight_data_leg: { /** @description The three-letter IATA airport code of the flight's destination. */ - arrival_airport_code?: string | null; + arrival_airport_code?: string | null /** @description The airline carrier code. */ - carrier?: string | null; + carrier?: string | null /** @description The three-letter IATA airport code that the flight departed from. */ - departure_airport_code?: string | null; + departure_airport_code?: string | null /** @description The flight number. */ - flight_number?: string | null; + flight_number?: string | null /** @description The flight's service class. */ - service_class?: string | null; + service_class?: string | null /** @description Whether a stopover is allowed on this flight. */ - stopover_allowed?: boolean | null; - }; + stopover_allowed?: boolean | null + } /** IssuingTransactionFuelData */ issuing_transaction_fuel_data: { /** @description The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`. */ - type: string; + type: string /** @description The units for `volume_decimal`. One of `us_gallon` or `liter`. */ - unit: string; + unit: string /** * Format: decimal * @description The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places. */ - unit_cost_decimal: string; + unit_cost_decimal: string /** * Format: decimal * @description The volume of the fuel that was pumped, represented as a decimal string with at most 12 decimal places. */ - volume_decimal?: string | null; - }; + volume_decimal?: string | null + } /** IssuingTransactionLodgingData */ issuing_transaction_lodging_data: { /** @description The time of checking into the lodging. */ - check_in_at?: number | null; + check_in_at?: number | null /** @description The number of nights stayed at the lodging. */ - nights?: number | null; - }; + nights?: number | null + } /** IssuingTransactionPurchaseDetails */ issuing_transaction_purchase_details: { /** @description Information about the flight that was purchased with this transaction. */ - flight?: Partial | null; + flight?: Partial | null /** @description Information about fuel that was purchased with this transaction. */ - fuel?: Partial | null; + fuel?: Partial | null /** @description Information about lodging that was purchased with this transaction. */ - lodging?: Partial | null; + lodging?: Partial | null /** @description The line items in the purchase. */ - receipt?: components["schemas"]["issuing_transaction_receipt_data"][] | null; + receipt?: components['schemas']['issuing_transaction_receipt_data'][] | null /** @description A merchant-specific order number. */ - reference?: string | null; - }; + reference?: string | null + } /** IssuingTransactionReceiptData */ issuing_transaction_receipt_data: { /** @description The description of the item. The maximum length of this field is 26 characters. */ - description?: string | null; + description?: string | null /** @description The quantity of the item. */ - quantity?: number | null; + quantity?: number | null /** @description The total for this line item in cents. */ - total?: number | null; + total?: number | null /** @description The unit cost of the item in cents. */ - unit_cost?: number | null; - }; + unit_cost?: number | null + } /** * LineItem * @description A line item. */ item: { /** @description Total before any discounts or taxes are applied. */ - amount_subtotal: number; + amount_subtotal: number /** @description Total after discounts and taxes. */ - amount_total: number; + amount_total: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name. */ - description: string; + description: string /** @description The discounts applied to the line item. */ - discounts?: components["schemas"]["line_items_discount_amount"][]; + discounts?: components['schemas']['line_items_discount_amount'][] /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "item"; + object: 'item' /** @description The price used to generate the line item. */ - price?: Partial | null; + price?: Partial | null /** @description The quantity of products being purchased. */ - quantity?: number | null; + quantity?: number | null /** @description The taxes applied to the line item. */ - taxes?: components["schemas"]["line_items_tax_amount"][]; - }; + taxes?: components['schemas']['line_items_tax_amount'][] + } /** LegalEntityCompany */ legal_entity_company: { - address?: components["schemas"]["address"]; + address?: components['schemas']['address'] /** @description The Kana variation of the company's primary address (Japan only). */ - address_kana?: Partial | null; + address_kana?: Partial | null /** @description The Kanji variation of the company's primary address (Japan only). */ - address_kanji?: Partial | null; + address_kanji?: Partial | null /** @description 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?: boolean; + directors_provided?: boolean /** @description 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?: boolean; + executives_provided?: boolean /** @description The company's legal name. */ - name?: string | null; + name?: string | null /** @description The Kana variation of the company's legal name (Japan only). */ - name_kana?: string | null; + name_kana?: string | null /** @description The Kanji variation of the company's legal name (Japan only). */ - name_kanji?: string | null; + name_kanji?: string | null /** @description 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?: boolean; + owners_provided?: boolean /** @description This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct. */ - ownership_declaration?: Partial | null; + ownership_declaration?: Partial | null /** @description The company's phone number (used for verification). */ - phone?: string | null; + phone?: string | null /** * @description 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. * @enum {string} */ structure?: - | "free_zone_establishment" - | "free_zone_llc" - | "government_instrumentality" - | "governmental_unit" - | "incorporated_non_profit" - | "limited_liability_partnership" - | "llc" - | "multi_member_llc" - | "private_company" - | "private_corporation" - | "private_partnership" - | "public_company" - | "public_corporation" - | "public_partnership" - | "single_member_llc" - | "sole_establishment" - | "sole_proprietorship" - | "tax_exempt_government_instrumentality" - | "unincorporated_association" - | "unincorporated_non_profit"; + | 'free_zone_establishment' + | 'free_zone_llc' + | 'government_instrumentality' + | 'governmental_unit' + | 'incorporated_non_profit' + | 'limited_liability_partnership' + | 'llc' + | 'multi_member_llc' + | 'private_company' + | 'private_corporation' + | 'private_partnership' + | 'public_company' + | 'public_corporation' + | 'public_partnership' + | 'single_member_llc' + | 'sole_establishment' + | 'sole_proprietorship' + | 'tax_exempt_government_instrumentality' + | 'unincorporated_association' + | 'unincorporated_non_profit' /** @description Whether the company's business ID number was provided. */ - tax_id_provided?: boolean; + tax_id_provided?: boolean /** @description The jurisdiction in which the `tax_id` is registered (Germany-based companies only). */ - tax_id_registrar?: string; + tax_id_registrar?: string /** @description Whether the company's business VAT number was provided. */ - vat_id_provided?: boolean; + vat_id_provided?: boolean /** @description Information on the verification state of the company. */ - verification?: Partial | null; - }; + verification?: Partial | null + } /** LegalEntityCompanyVerification */ legal_entity_company_verification: { - document: components["schemas"]["legal_entity_company_verification_document"]; - }; + document: components['schemas']['legal_entity_company_verification_document'] + } /** LegalEntityCompanyVerificationDocument */ legal_entity_company_verification_document: { /** @description 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?: (Partial & Partial) | null; + back?: (Partial & Partial) | null /** @description A user-displayable string describing the verification state of this document. */ - details?: string | null; + details?: string | null /** @description 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?: string | null; + details_code?: string | null /** @description 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?: (Partial & Partial) | null; - }; + front?: (Partial & Partial) | null + } /** LegalEntityDOB */ legal_entity_dob: { /** @description The day of birth, between 1 and 31. */ - day?: number | null; + day?: number | null /** @description The month of birth, between 1 and 12. */ - month?: number | null; + month?: number | null /** @description The four-digit year of birth. */ - year?: number | null; - }; + year?: number | null + } /** LegalEntityJapanAddress */ legal_entity_japan_address: { /** @description City/Ward. */ - city?: string | null; + city?: string | null /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ - country?: string | null; + country?: string | null /** @description Block/Building number. */ - line1?: string | null; + line1?: string | null /** @description Building details. */ - line2?: string | null; + line2?: string | null /** @description ZIP or postal code. */ - postal_code?: string | null; + postal_code?: string | null /** @description Prefecture. */ - state?: string | null; + state?: string | null /** @description Town/cho-me. */ - town?: string | null; - }; + town?: string | null + } /** LegalEntityPersonVerification */ legal_entity_person_verification: { /** @description A document showing address, either a passport, local ID card, or utility bill from a well-known utility company. */ - additional_document?: Partial | null; + additional_document?: Partial | null /** @description A user-displayable string describing the verification state for the person. For example, this may say "Provided identity information could not be verified". */ - details?: string | null; + details?: string | null /** @description 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?: string | null; - document?: components["schemas"]["legal_entity_person_verification_document"]; + details_code?: string | null + document?: components['schemas']['legal_entity_person_verification_document'] /** @description The state of verification for the person. Possible values are `unverified`, `pending`, or `verified`. */ - status: string; - }; + status: string + } /** LegalEntityPersonVerificationDocument */ legal_entity_person_verification_document: { /** @description 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?: (Partial & Partial) | null; + back?: (Partial & Partial) | null /** @description 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?: string | null; + details?: string | null /** @description 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?: string | null; + details_code?: string | null /** @description 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?: (Partial & Partial) | null; - }; + front?: (Partial & Partial) | null + } /** LegalEntityUBODeclaration */ legal_entity_ubo_declaration: { /** * Format: unix-time * @description The Unix timestamp marking when the beneficial owner attestation was made. */ - date?: number | null; + date?: number | null /** @description The IP address from which the beneficial owner attestation was made. */ - ip?: string | null; + ip?: string | null /** @description The user-agent string from the browser where the beneficial owner attestation was made. */ - user_agent?: string | null; - }; + user_agent?: string | null + } /** InvoiceLineItem */ line_item: { /** @description The amount, in %s. */ - amount: number; + amount: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description The amount of discount calculated per discount for this line item. */ - discount_amounts?: components["schemas"]["discounts_resource_discount_amount"][] | null; + discount_amounts?: components['schemas']['discounts_resource_discount_amount'][] | null /** @description If true, discounts will apply to this line item. Always false for prorations. */ - discountable: boolean; + discountable: boolean /** @description The discounts applied to the invoice line item. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount. */ - discounts?: (Partial & Partial)[] | null; + discounts?: (Partial & Partial)[] | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The ID of the [invoice item](https://stripe.com/docs/api/invoiceitems) associated with this line item if any. */ - invoice_item?: string; + invoice_item?: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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` this will reflect the metadata of the subscription that caused the line item to be created. */ - metadata: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "line_item"; - period: components["schemas"]["invoice_line_item_period"]; + object: 'line_item' + period: components['schemas']['invoice_line_item_period'] /** @description The price of the line item. */ - price?: Partial | null; + price?: Partial | null /** @description Whether this is a proration. */ - proration: boolean; + proration: boolean /** @description The quantity of the subscription, if the line item is a subscription or a proration. */ - quantity?: number | null; + quantity?: number | null /** @description The subscription that the invoice item pertains to, if any. */ - subscription?: string | null; + subscription?: string | null /** @description The subscription item that generated this invoice item. Left empty if the line item is not an explicit result of a subscription. */ - subscription_item?: string; + subscription_item?: string /** @description The amount of tax calculated per tax rate for this line item */ - tax_amounts?: components["schemas"]["invoice_tax_amount"][]; + tax_amounts?: components['schemas']['invoice_tax_amount'][] /** @description The tax rates which apply to the line item. */ - tax_rates?: components["schemas"]["tax_rate"][]; + tax_rates?: components['schemas']['tax_rate'][] /** * @description A string identifying the type of the source of this line item, either an `invoiceitem` or a `subscription`. * @enum {string} */ - type: "invoiceitem" | "subscription"; - }; + type: 'invoiceitem' | 'subscription' + } /** LineItemsDiscountAmount */ line_items_discount_amount: { /** @description The amount discounted. */ - amount: number; - discount: components["schemas"]["discount"]; - }; + amount: number + discount: components['schemas']['discount'] + } /** LineItemsTaxAmount */ line_items_tax_amount: { /** @description Amount of tax applied for this rate. */ - amount: number; - rate: components["schemas"]["tax_rate"]; - }; + amount: number + rate: components['schemas']['tax_rate'] + } /** LoginLink */ login_link: { /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "login_link"; + object: 'login_link' /** @description The URL for the login link. */ - url: string; - }; + url: string + } /** * Mandate * @description A Mandate is a record of the permission a customer has given you to debit their payment method. */ mandate: { - customer_acceptance: components["schemas"]["customer_acceptance"]; + customer_acceptance: components['schemas']['customer_acceptance'] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; - multi_use?: components["schemas"]["mandate_multi_use"]; + livemode: boolean + multi_use?: components['schemas']['mandate_multi_use'] /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "mandate"; + object: 'mandate' /** @description ID of the payment method associated with this mandate. */ - payment_method: Partial & Partial; - payment_method_details: components["schemas"]["mandate_payment_method_details"]; - single_use?: components["schemas"]["mandate_single_use"]; + payment_method: Partial & Partial + payment_method_details: components['schemas']['mandate_payment_method_details'] + single_use?: components['schemas']['mandate_single_use'] /** * @description The status of the mandate, which indicates whether it can be used to initiate a payment. * @enum {string} */ - status: "active" | "inactive" | "pending"; + status: 'active' | 'inactive' | 'pending' /** * @description The type of the mandate. * @enum {string} */ - type: "multi_use" | "single_use"; - }; + type: 'multi_use' | 'single_use' + } /** mandate_acss_debit */ mandate_acss_debit: { /** @description List of Stripe products where this mandate can be selected automatically. */ - default_for?: ("invoice" | "subscription")[]; + default_for?: ('invoice' | 'subscription')[] /** @description Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. */ - interval_description?: string | null; + interval_description?: string | null /** * @description Payment schedule for the mandate. * @enum {string} */ - payment_schedule: "combined" | "interval" | "sporadic"; + payment_schedule: 'combined' | 'interval' | 'sporadic' /** * @description Transaction type of the mandate. * @enum {string} */ - transaction_type: "business" | "personal"; - }; + transaction_type: 'business' | 'personal' + } /** mandate_au_becs_debit */ mandate_au_becs_debit: { /** @description The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively. */ - url: string; - }; + url: string + } /** mandate_bacs_debit */ mandate_bacs_debit: { /** * @description The status of the mandate on the Bacs network. Can be one of `pending`, `revoked`, `refused`, or `accepted`. * @enum {string} */ - network_status: "accepted" | "pending" | "refused" | "revoked"; + network_status: 'accepted' | 'pending' | 'refused' | 'revoked' /** @description The unique reference identifying the mandate on the Bacs network. */ - reference: string; + reference: string /** @description The URL that will contain the mandate that the customer has signed. */ - url: string; - }; + url: string + } /** mandate_multi_use */ - mandate_multi_use: { [key: string]: unknown }; + mandate_multi_use: { [key: string]: unknown } /** mandate_payment_method_details */ mandate_payment_method_details: { - acss_debit?: components["schemas"]["mandate_acss_debit"]; - au_becs_debit?: components["schemas"]["mandate_au_becs_debit"]; - bacs_debit?: components["schemas"]["mandate_bacs_debit"]; - card?: components["schemas"]["card_mandate_payment_method_details"]; - sepa_debit?: components["schemas"]["mandate_sepa_debit"]; + acss_debit?: components['schemas']['mandate_acss_debit'] + au_becs_debit?: components['schemas']['mandate_au_becs_debit'] + bacs_debit?: components['schemas']['mandate_bacs_debit'] + card?: components['schemas']['card_mandate_payment_method_details'] + sepa_debit?: components['schemas']['mandate_sepa_debit'] /** @description The type of the payment method associated with this mandate. An additional hash is included on `payment_method_details` with a name matching this value. It contains mandate information specific to the payment method. */ - type: string; - }; + type: string + } /** mandate_sepa_debit */ mandate_sepa_debit: { /** @description The unique reference of the mandate. */ - reference: string; + reference: string /** @description The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively. */ - url: string; - }; + url: string + } /** mandate_single_use */ mandate_single_use: { /** @description On a single use mandate, the amount of the payment. */ - amount: number; + amount: number /** @description On a single use mandate, the currency of the payment. */ - currency: string; - }; + currency: string + } /** networks */ networks: { /** @description All available networks for the card. */ - available: string[]; + available: string[] /** @description The preferred network for the card. */ - preferred?: string | null; - }; + preferred?: string | null + } /** NotificationEventData */ notification_event_data: { /** @description 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: { [key: string]: unknown }; + object: { [key: string]: unknown } /** @description Object containing the names of the attributes that have changed, and their previous values (sent along only with *.updated events). */ - previous_attributes?: { [key: string]: unknown }; - }; + previous_attributes?: { [key: string]: unknown } + } /** NotificationEventRequest */ notification_event_request: { /** @description 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?: string | null; + id?: string | null /** @description 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?: string | null; - }; + idempotency_key?: string | null + } /** offline_acceptance */ - offline_acceptance: { [key: string]: unknown }; + offline_acceptance: { [key: string]: unknown } /** online_acceptance */ online_acceptance: { /** @description The IP address from which the Mandate was accepted by the customer. */ - ip_address?: string | null; + ip_address?: string | null /** @description The user agent of the browser from which the Mandate was accepted by the customer. */ - user_agent?: string | null; - }; + user_agent?: string | null + } /** * Order * @description Order objects are created to handle end customers' purchases of previously @@ -8594,80 +8530,76 @@ export interface components { */ order: { /** @description 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: number; + amount: number /** @description The total amount that was returned to the customer. */ - amount_returned?: number | null; + amount_returned?: number | null /** @description ID of the Connect Application that created the order. */ - application?: string | null; + application?: string | null /** @description A fee in cents that will be applied to the order and transferred to the application owner’s Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees documentation. */ - application_fee?: number | null; + application_fee?: number | null /** @description The ID of the payment used to pay for the order. Present if the order status is `paid`, `fulfilled`, or `refunded`. */ - charge?: (Partial & Partial) | null; + charge?: (Partial & Partial) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description The customer used for the order. */ - customer?: - | (Partial & - Partial & - Partial) - | null; + customer?: (Partial & Partial & Partial) | null /** @description The email address of the customer placing the order. */ - email?: string | null; + email?: string | null /** @description External coupon code to load for this order. */ - external_coupon_code?: string; + external_coupon_code?: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description List of items constituting the order. An order can have up to 25 items. */ - items: components["schemas"]["order_item"][]; + items: components['schemas']['order_item'][] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "order"; + object: 'order' /** * OrdersResourceOrderReturnList * @description A list of returns that have taken place for this order. */ returns?: { /** @description Details about each object. */ - data: components["schemas"]["order_return"][]; + data: components['schemas']['order_return'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } | null; + url: string + } | null /** @description The shipping method that is currently selected for this order, if any. If present, it is equal to one of the `id`s of shipping methods in the `shipping_methods` array. At order creation time, if there are multiple shipping methods, Stripe will automatically selected the first method. */ - selected_shipping_method?: string | null; + selected_shipping_method?: string | null /** @description The shipping address for the order. Present if the order is for goods to be shipped. */ - shipping?: Partial | null; + shipping?: Partial | null /** @description A list of supported shipping methods for this order. The desired shipping method can be specified either by updating the order, or when paying it. */ - shipping_methods?: components["schemas"]["shipping_method"][] | null; + shipping_methods?: components['schemas']['shipping_method'][] | null /** @description Current order status. One of `created`, `paid`, `canceled`, `fulfilled`, or `returned`. More details in the [Orders Guide](https://stripe.com/docs/orders/guide#understanding-order-statuses). */ - status: string; + status: string /** @description The timestamps at which the order status was updated. */ - status_transitions?: Partial | null; + status_transitions?: Partial | null /** * Format: unix-time * @description Time at which the object was last updated. Measured in seconds since the Unix epoch. */ - updated?: number | null; + updated?: number | null /** @description The user's order ID if it is different from the Stripe order ID. */ - upstream_id?: string; - }; + upstream_id?: string + } /** * OrderItem * @description A representation of the constituent items of any given order. Can be used to @@ -8677,23 +8609,23 @@ export interface components { */ order_item: { /** @description 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 line item. */ - amount: number; + amount: number /** @description 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: string; + currency: string /** @description Description of the line item, meant to be displayable to the user (e.g., `"Express shipping"`). */ - description: string; + description: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "order_item"; + object: 'order_item' /** @description The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a SKU). */ - parent?: (Partial & Partial) | null; + parent?: (Partial & Partial) | null /** @description A positive integer representing the number of instances of `parent` that are included in this order item. Applicable/present only if `type` is `sku`. */ - quantity?: number | null; + quantity?: number | null /** @description The type of line item. One of `sku`, `tax`, `shipping`, or `discount`. */ - type: string; - }; + type: string + } /** * OrderReturn * @description A return represents the full or partial return of a number of [order items](https://stripe.com/docs/api#order_items). @@ -8703,66 +8635,66 @@ export interface components { */ order_return: { /** @description 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 returned line item. */ - amount: number; + amount: number /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The items included in this order return. */ - items: components["schemas"]["order_item"][]; + items: components['schemas']['order_item'][] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "order_return"; + object: 'order_return' /** @description The order that this return includes items from. */ - order?: (Partial & Partial) | null; + order?: (Partial & Partial) | null /** @description The ID of the refund issued for this return. */ - refund?: (Partial & Partial) | null; - }; + refund?: (Partial & Partial) | null + } /** PackageDimensions */ package_dimensions: { /** @description Height, in inches. */ - height: number; + height: number /** @description Length, in inches. */ - length: number; + length: number /** @description Weight, in ounces. */ - weight: number; + weight: number /** @description Width, in inches. */ - width: number; - }; + width: number + } /** PaymentFlowsAutomaticPaymentMethodsPaymentIntent */ payment_flows_automatic_payment_methods_payment_intent: { /** @description Automatically calculates compatible payment methods */ - enabled: boolean; - }; + enabled: boolean + } /** PaymentFlowsPrivatePaymentMethodsAlipay */ - payment_flows_private_payment_methods_alipay: { [key: string]: unknown }; + payment_flows_private_payment_methods_alipay: { [key: string]: unknown } /** PaymentFlowsPrivatePaymentMethodsAlipayDetails */ payment_flows_private_payment_methods_alipay_details: { /** @description Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same. */ - buyer_id?: string; + buyer_id?: string /** @description Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Transaction ID of this particular Alipay transaction. */ - transaction_id?: string | null; - }; + transaction_id?: string | null + } /** PaymentFlowsPrivatePaymentMethodsKlarnaDOB */ payment_flows_private_payment_methods_klarna_dob: { /** @description The day of birth, between 1 and 31. */ - day?: number | null; + day?: number | null /** @description The month of birth, between 1 and 12. */ - month?: number | null; + month?: number | null /** @description The four-digit year of birth. */ - year?: number | null; - }; + year?: number | null + } /** * PaymentIntent * @description A PaymentIntent guides you through the process of collecting a payment from your customer. @@ -8779,61 +8711,51 @@ export interface components { */ payment_intent: { /** @description 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: number; + amount: number /** @description Amount that can be captured from this PaymentIntent. */ - amount_capturable?: number; + amount_capturable?: number /** @description Amount that was collected by this PaymentIntent. */ - amount_received?: number; + amount_received?: number /** @description ID of the Connect application that created the PaymentIntent. */ - application?: (Partial & Partial) | null; + application?: (Partial & Partial) | null /** @description 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?: number | null; + application_fee_amount?: number | null /** @description Settings to configure compatible payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods) */ - automatic_payment_methods?: Partial< - components["schemas"]["payment_flows_automatic_payment_methods_payment_intent"] - > | null; + automatic_payment_methods?: Partial | null /** * Format: unix-time * @description Populated when `status` is `canceled`, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch. */ - canceled_at?: number | null; + canceled_at?: number | null /** * @description 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`). * @enum {string|null} */ cancellation_reason?: - | ( - | "abandoned" - | "automatic" - | "duplicate" - | "failed_invoice" - | "fraudulent" - | "requested_by_customer" - | "void_invoice" - ) - | null; + | ('abandoned' | 'automatic' | 'duplicate' | 'failed_invoice' | 'fraudulent' | 'requested_by_customer' | 'void_invoice') + | null /** * @description Controls when the funds will be captured from the customer's account. * @enum {string} */ - capture_method: "automatic" | "manual"; + capture_method: 'automatic' | 'manual' /** * PaymentFlowsPaymentIntentResourceChargeList * @description Charges that were created by this PaymentIntent, if any. */ charges?: { /** @description This list only contains the latest charge, even if there were previously multiple unsuccessful charges. To view all previous charges for a PaymentIntent, you can filter the charges list using the `payment_intent` [parameter](https://stripe.com/docs/api/charges/list#list_charges-payment_intent). */ - data: components["schemas"]["charge"][]; + data: components['schemas']['charge'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** * @description The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key. * @@ -8841,16 +8763,16 @@ export interface components { * * Refer to our docs to [accept a payment](https://stripe.com/docs/payments/accept-a-payment?integration=elements) and learn about how `client_secret` should be handled. */ - client_secret?: string | null; + client_secret?: string | null /** @enum {string} */ - confirmation_method: "automatic" | "manual"; + confirmation_method: 'automatic' | 'manual' /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** * @description ID of the Customer this PaymentIntent belongs to, if one exists. * @@ -8858,44 +8780,40 @@ export interface components { * * If present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. */ - customer?: - | (Partial & - Partial & - Partial) - | null; + customer?: (Partial & Partial & Partial) | null /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description ID of the invoice that created this PaymentIntent, if it exists. */ - invoice?: (Partial & Partial) | null; + invoice?: (Partial & Partial) | null /** @description 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?: Partial | null; + last_payment_error?: Partial | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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. For more information, see the [documentation](https://stripe.com/docs/payments/payment-intents/creating-payment-intents#storing-information-in-metadata). */ - metadata?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description 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?: Partial | null; + next_action?: Partial | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "payment_intent"; + object: 'payment_intent' /** @description 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?: (Partial & Partial) | null; + on_behalf_of?: (Partial & Partial) | null /** @description ID of the payment method used in this PaymentIntent. */ - payment_method?: (Partial & Partial) | null; + payment_method?: (Partial & Partial) | null /** @description Payment-method-specific configuration for this PaymentIntent. */ - payment_method_options?: Partial | null; + payment_method_options?: Partial | null /** @description The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. */ - payment_method_types: string[]; + payment_method_types: string[] /** @description If present, this property tells you about the processing state of the payment. */ - processing?: Partial | null; + processing?: Partial | null /** @description 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?: string | null; + receipt_email?: string | null /** @description ID of the review associated with this PaymentIntent, if any. */ - review?: (Partial & Partial) | null; + review?: (Partial & Partial) | null /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * @@ -8904,190 +8822,183 @@ export interface components { * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string|null} */ - setup_future_usage?: ("off_session" | "on_session") | null; + setup_future_usage?: ('off_session' | 'on_session') | null /** @description Shipping information for this PaymentIntent. */ - shipping?: Partial | null; + shipping?: Partial | null /** @description For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - statement_descriptor?: string | null; + statement_descriptor?: string | null /** @description Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - statement_descriptor_suffix?: string | null; + statement_descriptor_suffix?: string | null /** * @description 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). * @enum {string} */ - status: - | "canceled" - | "processing" - | "requires_action" - | "requires_capture" - | "requires_confirmation" - | "requires_payment_method" - | "succeeded"; + status: 'canceled' | 'processing' | 'requires_action' | 'requires_capture' | 'requires_confirmation' | 'requires_payment_method' | 'succeeded' /** @description The data with which to automatically create a Transfer when the payment is finalized. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. */ - transfer_data?: Partial | null; + transfer_data?: Partial | null /** @description A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. */ - transfer_group?: string | null; - }; + transfer_group?: string | null + } /** PaymentIntentCardProcessing */ - payment_intent_card_processing: { [key: string]: unknown }; + payment_intent_card_processing: { [key: string]: unknown } /** PaymentIntentNextAction */ payment_intent_next_action: { - alipay_handle_redirect?: components["schemas"]["payment_intent_next_action_alipay_handle_redirect"]; - boleto_display_details?: components["schemas"]["payment_intent_next_action_boleto"]; - oxxo_display_details?: components["schemas"]["payment_intent_next_action_display_oxxo_details"]; - redirect_to_url?: components["schemas"]["payment_intent_next_action_redirect_to_url"]; + alipay_handle_redirect?: components['schemas']['payment_intent_next_action_alipay_handle_redirect'] + boleto_display_details?: components['schemas']['payment_intent_next_action_boleto'] + oxxo_display_details?: components['schemas']['payment_intent_next_action_display_oxxo_details'] + redirect_to_url?: components['schemas']['payment_intent_next_action_redirect_to_url'] /** @description 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: string; + type: string /** @description 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?: { [key: string]: unknown }; - verify_with_microdeposits?: components["schemas"]["payment_intent_next_action_verify_with_microdeposits"]; - wechat_pay_display_qr_code?: components["schemas"]["payment_intent_next_action_wechat_pay_display_qr_code"]; - wechat_pay_redirect_to_android_app?: components["schemas"]["payment_intent_next_action_wechat_pay_redirect_to_android_app"]; - wechat_pay_redirect_to_ios_app?: components["schemas"]["payment_intent_next_action_wechat_pay_redirect_to_ios_app"]; - }; + use_stripe_sdk?: { [key: string]: unknown } + verify_with_microdeposits?: components['schemas']['payment_intent_next_action_verify_with_microdeposits'] + wechat_pay_display_qr_code?: components['schemas']['payment_intent_next_action_wechat_pay_display_qr_code'] + wechat_pay_redirect_to_android_app?: components['schemas']['payment_intent_next_action_wechat_pay_redirect_to_android_app'] + wechat_pay_redirect_to_ios_app?: components['schemas']['payment_intent_next_action_wechat_pay_redirect_to_ios_app'] + } /** PaymentIntentNextActionAlipayHandleRedirect */ payment_intent_next_action_alipay_handle_redirect: { /** @description 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?: string | null; + native_data?: string | null /** @description The native URL you must redirect your customer to in order to authenticate the payment in an iOS App. */ - native_url?: string | null; + native_url?: string | null /** @description If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion. */ - return_url?: string | null; + return_url?: string | null /** @description The URL you must redirect your customer to in order to authenticate the payment. */ - url?: string | null; - }; + url?: string | null + } /** payment_intent_next_action_boleto */ payment_intent_next_action_boleto: { /** * Format: unix-time * @description The timestamp after which the boleto expires. */ - expires_at?: number | null; + expires_at?: number | null /** @description The URL to the hosted boleto voucher page, which allows customers to view the boleto voucher. */ - hosted_voucher_url?: string | null; + hosted_voucher_url?: string | null /** @description The boleto number. */ - number?: string | null; + number?: string | null /** @description The URL to the downloadable boleto voucher PDF. */ - pdf?: string | null; - }; + pdf?: string | null + } /** PaymentIntentNextActionDisplayOxxoDetails */ payment_intent_next_action_display_oxxo_details: { /** * Format: unix-time * @description The timestamp after which the OXXO voucher expires. */ - expires_after?: number | null; + expires_after?: number | null /** @description The URL for the hosted OXXO voucher page, which allows customers to view and print an OXXO voucher. */ - hosted_voucher_url?: string | null; + hosted_voucher_url?: string | null /** @description OXXO reference number. */ - number?: string | null; - }; + number?: string | null + } /** PaymentIntentNextActionRedirectToUrl */ payment_intent_next_action_redirect_to_url: { /** @description If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion. */ - return_url?: string | null; + return_url?: string | null /** @description The URL you must redirect your customer to in order to authenticate the payment. */ - url?: string | null; - }; + url?: string | null + } /** PaymentIntentNextActionVerifyWithMicrodeposits */ payment_intent_next_action_verify_with_microdeposits: { /** * Format: unix-time * @description The timestamp when the microdeposits are expected to land. */ - arrival_date: number; + arrival_date: number /** @description The URL for the hosted verification page, which allows customers to verify their bank account. */ - hosted_verification_url: string; - }; + hosted_verification_url: string + } /** PaymentIntentNextActionWechatPayDisplayQrCode */ payment_intent_next_action_wechat_pay_display_qr_code: { /** @description The data being used to generate QR code */ - data: string; + data: string /** @description The base64 image data for a pre-generated QR code */ - image_data_url: string; + image_data_url: string /** @description The image_url_png string used to render QR code */ - image_url_png: string; + image_url_png: string /** @description The image_url_svg string used to render QR code */ - image_url_svg: string; - }; + image_url_svg: string + } /** PaymentIntentNextActionWechatPayRedirectToAndroidApp */ payment_intent_next_action_wechat_pay_redirect_to_android_app: { /** @description app_id is the APP ID registered on WeChat open platform */ - app_id: string; + app_id: string /** @description nonce_str is a random string */ - nonce_str: string; + nonce_str: string /** @description package is static value */ - package: string; + package: string /** @description an unique merchant ID assigned by Wechat Pay */ - partner_id: string; + partner_id: string /** @description an unique trading ID assigned by Wechat Pay */ - prepay_id: string; + prepay_id: string /** @description A signature */ - sign: string; + sign: string /** @description Specifies the current time in epoch format */ - timestamp: string; - }; + timestamp: string + } /** PaymentIntentNextActionWechatPayRedirectToIOSApp */ payment_intent_next_action_wechat_pay_redirect_to_ios_app: { /** @description An universal link that redirect to Wechat Pay APP */ - native_url: string; - }; + native_url: string + } /** PaymentIntentPaymentMethodOptions */ payment_intent_payment_method_options: { - acss_debit?: Partial & - Partial; - afterpay_clearpay?: Partial & - Partial; - alipay?: Partial & - Partial; - au_becs_debit?: Partial & - Partial; - bacs_debit?: Partial & - Partial; - bancontact?: Partial & - Partial; - boleto?: Partial & - Partial; - card?: Partial & - Partial; - card_present?: Partial & - Partial; - eps?: Partial & - Partial; - fpx?: Partial & - Partial; - giropay?: Partial & - Partial; - grabpay?: Partial & - Partial; - ideal?: Partial & - Partial; - interac_present?: Partial & - Partial; - klarna?: Partial & - Partial; - oxxo?: Partial & - Partial; - p24?: Partial & - Partial; - sepa_debit?: Partial & - Partial; - sofort?: Partial & - Partial; - wechat_pay?: Partial & - Partial; - }; + acss_debit?: Partial & + Partial + afterpay_clearpay?: Partial & + Partial + alipay?: Partial & + Partial + au_becs_debit?: Partial & + Partial + bacs_debit?: Partial & + Partial + bancontact?: Partial & + Partial + boleto?: Partial & + Partial + card?: Partial & + Partial + card_present?: Partial & + Partial + eps?: Partial & + Partial + fpx?: Partial & + Partial + giropay?: Partial & + Partial + grabpay?: Partial & + Partial + ideal?: Partial & + Partial + interac_present?: Partial & + Partial + klarna?: Partial & + Partial + oxxo?: Partial & + Partial + p24?: Partial & + Partial + sepa_debit?: Partial & + Partial + sofort?: Partial & + Partial + wechat_pay?: Partial & + Partial + } /** payment_intent_payment_method_options_acss_debit */ payment_intent_payment_method_options_acss_debit: { - mandate_options?: components["schemas"]["payment_intent_payment_method_options_mandate_options_acss_debit"]; + mandate_options?: components['schemas']['payment_intent_payment_method_options_mandate_options_acss_debit'] /** * @description Bank account verification method. * @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; - }; + verification_method?: 'automatic' | 'instant' | 'microdeposits' + } /** payment_intent_payment_method_options_au_becs_debit */ - payment_intent_payment_method_options_au_becs_debit: { [key: string]: unknown }; + payment_intent_payment_method_options_au_becs_debit: { [key: string]: unknown } /** payment_intent_payment_method_options_card */ payment_intent_payment_method_options_card: { /** @@ -9095,30 +9006,17 @@ export interface components { * * For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments). */ - installments?: Partial | null; + installments?: Partial | null /** * @description 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. * @enum {string|null} */ - network?: - | ( - | "amex" - | "cartes_bancaires" - | "diners" - | "discover" - | "interac" - | "jcb" - | "mastercard" - | "unionpay" - | "unknown" - | "visa" - ) - | null; + network?: ('amex' | 'cartes_bancaires' | 'diners' | 'discover' | 'interac' | 'jcb' | 'mastercard' | 'unionpay' | 'unknown' | 'visa') | null /** * @description 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. Permitted values include: `automatic` or `any`. If not provided, defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. * @enum {string|null} */ - request_three_d_secure?: ("any" | "automatic" | "challenge_only") | null; + request_three_d_secure?: ('any' | 'automatic' | 'challenge_only') | null /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * @@ -9127,42 +9025,42 @@ export interface components { * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ - setup_future_usage?: "none" | "off_session" | "on_session"; - }; + setup_future_usage?: 'none' | 'off_session' | 'on_session' + } /** payment_intent_payment_method_options_eps */ - payment_intent_payment_method_options_eps: { [key: string]: unknown }; + payment_intent_payment_method_options_eps: { [key: string]: unknown } /** payment_intent_payment_method_options_mandate_options_acss_debit */ payment_intent_payment_method_options_mandate_options_acss_debit: { /** @description A URL for custom mandate text */ - custom_mandate_url?: string; + custom_mandate_url?: string /** @description Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. */ - interval_description?: string | null; + interval_description?: string | null /** * @description Payment schedule for the mandate. * @enum {string|null} */ - payment_schedule?: ("combined" | "interval" | "sporadic") | null; + payment_schedule?: ('combined' | 'interval' | 'sporadic') | null /** * @description Transaction type of the mandate. * @enum {string|null} */ - transaction_type?: ("business" | "personal") | null; - }; + transaction_type?: ('business' | 'personal') | null + } /** payment_intent_payment_method_options_mandate_options_sepa_debit */ - payment_intent_payment_method_options_mandate_options_sepa_debit: { [key: string]: unknown }; + payment_intent_payment_method_options_mandate_options_sepa_debit: { [key: string]: unknown } /** payment_intent_payment_method_options_sepa_debit */ payment_intent_payment_method_options_sepa_debit: { - mandate_options?: components["schemas"]["payment_intent_payment_method_options_mandate_options_sepa_debit"]; - }; + mandate_options?: components['schemas']['payment_intent_payment_method_options_mandate_options_sepa_debit'] + } /** PaymentIntentProcessing */ payment_intent_processing: { - card?: components["schemas"]["payment_intent_card_processing"]; + card?: components['schemas']['payment_intent_card_processing'] /** * @description Type of the payment method for which payment is in `processing` state, one of `card`. * @enum {string} */ - type: "card"; - }; + type: 'card' + } /** PaymentIntentTypeSpecificPaymentMethodOptionsClient */ payment_intent_type_specific_payment_method_options_client: { /** @@ -9173,8 +9071,8 @@ export interface components { * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ - setup_future_usage?: "none" | "off_session" | "on_session"; - }; + setup_future_usage?: 'none' | 'off_session' | 'on_session' + } /** * PaymentLink * @description A payment link is a shareable URL that will take your customers to a hosted payment page. A payment link can be shared and used multiple times. @@ -9185,349 +9083,347 @@ export interface components { */ payment_link: { /** @description 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: boolean; - after_completion: components["schemas"]["payment_links_resource_after_completion"]; + active: boolean + after_completion: components['schemas']['payment_links_resource_after_completion'] /** @description Whether user redeemable promotion codes are enabled. */ - allow_promotion_codes: boolean; + allow_promotion_codes: boolean /** @description 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?: number | null; + application_fee_amount?: number | null /** @description This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. */ - application_fee_percent?: number | null; - automatic_tax: components["schemas"]["payment_links_resource_automatic_tax"]; + application_fee_percent?: number | null + automatic_tax: components['schemas']['payment_links_resource_automatic_tax'] /** * @description Configuration for collecting the customer's billing address. * @enum {string} */ - billing_address_collection: "auto" | "required"; + billing_address_collection: 'auto' | 'required' /** @description Unique identifier for the object. */ - id: string; + id: string /** * PaymentLinksResourceListLineItems * @description The line items representing what is being sold. */ line_items?: { /** @description Details about each object. */ - data: components["schemas"]["item"][]; + data: components['schemas']['item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "payment_link"; + object: 'payment_link' /** @description 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?: (Partial & Partial) | null; + on_behalf_of?: (Partial & Partial) | null /** @description 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?: "card"[] | null; - phone_number_collection: components["schemas"]["payment_links_resource_phone_number_collection"]; + payment_method_types?: 'card'[] | null + phone_number_collection: components['schemas']['payment_links_resource_phone_number_collection'] /** @description Configuration for collecting the customer's shipping address. */ - shipping_address_collection?: Partial< - components["schemas"]["payment_links_resource_shipping_address_collection"] - > | null; + shipping_address_collection?: Partial | null /** @description 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?: Partial | null; + subscription_data?: Partial | null /** @description 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?: Partial | null; + transfer_data?: Partial | null /** @description The public URL that can be shared with customers. */ - url: string; - }; + url: string + } /** PaymentLinksResourceAfterCompletion */ payment_links_resource_after_completion: { - hosted_confirmation?: components["schemas"]["payment_links_resource_completion_behavior_confirmation_page"]; - redirect?: components["schemas"]["payment_links_resource_completion_behavior_redirect"]; + hosted_confirmation?: components['schemas']['payment_links_resource_completion_behavior_confirmation_page'] + redirect?: components['schemas']['payment_links_resource_completion_behavior_redirect'] /** * @description The specified behavior after the purchase is complete. * @enum {string} */ - type: "hosted_confirmation" | "redirect"; - }; + type: 'hosted_confirmation' | 'redirect' + } /** PaymentLinksResourceAutomaticTax */ payment_links_resource_automatic_tax: { /** @description If `true`, tax will be calculated automatically using the customer's location. */ - enabled: boolean; - }; + enabled: boolean + } /** PaymentLinksResourceCompletionBehaviorConfirmationPage */ payment_links_resource_completion_behavior_confirmation_page: { /** @description The custom message that is displayed to the customer after the purchase is complete. */ - custom_message?: string | null; - }; + custom_message?: string | null + } /** PaymentLinksResourceCompletionBehaviorRedirect */ payment_links_resource_completion_behavior_redirect: { /** @description The URL the customer will be redirected to after the purchase is complete. */ - url: string; - }; + url: string + } /** PaymentLinksResourcePhoneNumberCollection */ payment_links_resource_phone_number_collection: { /** @description If `true`, a phone number will be collected during checkout. */ - enabled: boolean; - }; + enabled: boolean + } /** PaymentLinksResourceShippingAddressCollection */ payment_links_resource_shipping_address_collection: { /** @description 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: ( - | "AC" - | "AD" - | "AE" - | "AF" - | "AG" - | "AI" - | "AL" - | "AM" - | "AO" - | "AQ" - | "AR" - | "AT" - | "AU" - | "AW" - | "AX" - | "AZ" - | "BA" - | "BB" - | "BD" - | "BE" - | "BF" - | "BG" - | "BH" - | "BI" - | "BJ" - | "BL" - | "BM" - | "BN" - | "BO" - | "BQ" - | "BR" - | "BS" - | "BT" - | "BV" - | "BW" - | "BY" - | "BZ" - | "CA" - | "CD" - | "CF" - | "CG" - | "CH" - | "CI" - | "CK" - | "CL" - | "CM" - | "CN" - | "CO" - | "CR" - | "CV" - | "CW" - | "CY" - | "CZ" - | "DE" - | "DJ" - | "DK" - | "DM" - | "DO" - | "DZ" - | "EC" - | "EE" - | "EG" - | "EH" - | "ER" - | "ES" - | "ET" - | "FI" - | "FJ" - | "FK" - | "FO" - | "FR" - | "GA" - | "GB" - | "GD" - | "GE" - | "GF" - | "GG" - | "GH" - | "GI" - | "GL" - | "GM" - | "GN" - | "GP" - | "GQ" - | "GR" - | "GS" - | "GT" - | "GU" - | "GW" - | "GY" - | "HK" - | "HN" - | "HR" - | "HT" - | "HU" - | "ID" - | "IE" - | "IL" - | "IM" - | "IN" - | "IO" - | "IQ" - | "IS" - | "IT" - | "JE" - | "JM" - | "JO" - | "JP" - | "KE" - | "KG" - | "KH" - | "KI" - | "KM" - | "KN" - | "KR" - | "KW" - | "KY" - | "KZ" - | "LA" - | "LB" - | "LC" - | "LI" - | "LK" - | "LR" - | "LS" - | "LT" - | "LU" - | "LV" - | "LY" - | "MA" - | "MC" - | "MD" - | "ME" - | "MF" - | "MG" - | "MK" - | "ML" - | "MM" - | "MN" - | "MO" - | "MQ" - | "MR" - | "MS" - | "MT" - | "MU" - | "MV" - | "MW" - | "MX" - | "MY" - | "MZ" - | "NA" - | "NC" - | "NE" - | "NG" - | "NI" - | "NL" - | "NO" - | "NP" - | "NR" - | "NU" - | "NZ" - | "OM" - | "PA" - | "PE" - | "PF" - | "PG" - | "PH" - | "PK" - | "PL" - | "PM" - | "PN" - | "PR" - | "PS" - | "PT" - | "PY" - | "QA" - | "RE" - | "RO" - | "RS" - | "RU" - | "RW" - | "SA" - | "SB" - | "SC" - | "SE" - | "SG" - | "SH" - | "SI" - | "SJ" - | "SK" - | "SL" - | "SM" - | "SN" - | "SO" - | "SR" - | "SS" - | "ST" - | "SV" - | "SX" - | "SZ" - | "TA" - | "TC" - | "TD" - | "TF" - | "TG" - | "TH" - | "TJ" - | "TK" - | "TL" - | "TM" - | "TN" - | "TO" - | "TR" - | "TT" - | "TV" - | "TW" - | "TZ" - | "UA" - | "UG" - | "US" - | "UY" - | "UZ" - | "VA" - | "VC" - | "VE" - | "VG" - | "VN" - | "VU" - | "WF" - | "WS" - | "XK" - | "YE" - | "YT" - | "ZA" - | "ZM" - | "ZW" - | "ZZ" - )[]; - }; + | 'AC' + | 'AD' + | 'AE' + | 'AF' + | 'AG' + | 'AI' + | 'AL' + | 'AM' + | 'AO' + | 'AQ' + | 'AR' + | 'AT' + | 'AU' + | 'AW' + | 'AX' + | 'AZ' + | 'BA' + | 'BB' + | 'BD' + | 'BE' + | 'BF' + | 'BG' + | 'BH' + | 'BI' + | 'BJ' + | 'BL' + | 'BM' + | 'BN' + | 'BO' + | 'BQ' + | 'BR' + | 'BS' + | 'BT' + | 'BV' + | 'BW' + | 'BY' + | 'BZ' + | 'CA' + | 'CD' + | 'CF' + | 'CG' + | 'CH' + | 'CI' + | 'CK' + | 'CL' + | 'CM' + | 'CN' + | 'CO' + | 'CR' + | 'CV' + | 'CW' + | 'CY' + | 'CZ' + | 'DE' + | 'DJ' + | 'DK' + | 'DM' + | 'DO' + | 'DZ' + | 'EC' + | 'EE' + | 'EG' + | 'EH' + | 'ER' + | 'ES' + | 'ET' + | 'FI' + | 'FJ' + | 'FK' + | 'FO' + | 'FR' + | 'GA' + | 'GB' + | 'GD' + | 'GE' + | 'GF' + | 'GG' + | 'GH' + | 'GI' + | 'GL' + | 'GM' + | 'GN' + | 'GP' + | 'GQ' + | 'GR' + | 'GS' + | 'GT' + | 'GU' + | 'GW' + | 'GY' + | 'HK' + | 'HN' + | 'HR' + | 'HT' + | 'HU' + | 'ID' + | 'IE' + | 'IL' + | 'IM' + | 'IN' + | 'IO' + | 'IQ' + | 'IS' + | 'IT' + | 'JE' + | 'JM' + | 'JO' + | 'JP' + | 'KE' + | 'KG' + | 'KH' + | 'KI' + | 'KM' + | 'KN' + | 'KR' + | 'KW' + | 'KY' + | 'KZ' + | 'LA' + | 'LB' + | 'LC' + | 'LI' + | 'LK' + | 'LR' + | 'LS' + | 'LT' + | 'LU' + | 'LV' + | 'LY' + | 'MA' + | 'MC' + | 'MD' + | 'ME' + | 'MF' + | 'MG' + | 'MK' + | 'ML' + | 'MM' + | 'MN' + | 'MO' + | 'MQ' + | 'MR' + | 'MS' + | 'MT' + | 'MU' + | 'MV' + | 'MW' + | 'MX' + | 'MY' + | 'MZ' + | 'NA' + | 'NC' + | 'NE' + | 'NG' + | 'NI' + | 'NL' + | 'NO' + | 'NP' + | 'NR' + | 'NU' + | 'NZ' + | 'OM' + | 'PA' + | 'PE' + | 'PF' + | 'PG' + | 'PH' + | 'PK' + | 'PL' + | 'PM' + | 'PN' + | 'PR' + | 'PS' + | 'PT' + | 'PY' + | 'QA' + | 'RE' + | 'RO' + | 'RS' + | 'RU' + | 'RW' + | 'SA' + | 'SB' + | 'SC' + | 'SE' + | 'SG' + | 'SH' + | 'SI' + | 'SJ' + | 'SK' + | 'SL' + | 'SM' + | 'SN' + | 'SO' + | 'SR' + | 'SS' + | 'ST' + | 'SV' + | 'SX' + | 'SZ' + | 'TA' + | 'TC' + | 'TD' + | 'TF' + | 'TG' + | 'TH' + | 'TJ' + | 'TK' + | 'TL' + | 'TM' + | 'TN' + | 'TO' + | 'TR' + | 'TT' + | 'TV' + | 'TW' + | 'TZ' + | 'UA' + | 'UG' + | 'US' + | 'UY' + | 'UZ' + | 'VA' + | 'VC' + | 'VE' + | 'VG' + | 'VN' + | 'VU' + | 'WF' + | 'WS' + | 'XK' + | 'YE' + | 'YT' + | 'ZA' + | 'ZM' + | 'ZW' + | 'ZZ' + )[] + } /** PaymentLinksResourceSubscriptionData */ payment_links_resource_subscription_data: { /** @description Integer representing the number of trial period days before the customer is charged for the first time. */ - trial_period_days?: number | null; - }; + trial_period_days?: number | null + } /** PaymentLinksResourceTransferData */ payment_links_resource_transfer_data: { /** @description The amount in %s that will be transferred to the destination account. By default, the entire amount is transferred to the destination. */ - amount?: number | null; + amount?: number | null /** @description The connected account receiving the transfer. */ - destination: Partial & Partial; - }; + destination: Partial & Partial + } /** * PaymentMethod * @description PaymentMethod objects represent your customer's payment instruments. @@ -9537,530 +9433,522 @@ export interface components { * Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios). */ payment_method: { - acss_debit?: components["schemas"]["payment_method_acss_debit"]; - afterpay_clearpay?: components["schemas"]["payment_method_afterpay_clearpay"]; - alipay?: components["schemas"]["payment_flows_private_payment_methods_alipay"]; - au_becs_debit?: components["schemas"]["payment_method_au_becs_debit"]; - bacs_debit?: components["schemas"]["payment_method_bacs_debit"]; - bancontact?: components["schemas"]["payment_method_bancontact"]; - billing_details: components["schemas"]["billing_details"]; - boleto?: components["schemas"]["payment_method_boleto"]; - card?: components["schemas"]["payment_method_card"]; - card_present?: components["schemas"]["payment_method_card_present"]; + acss_debit?: components['schemas']['payment_method_acss_debit'] + afterpay_clearpay?: components['schemas']['payment_method_afterpay_clearpay'] + alipay?: components['schemas']['payment_flows_private_payment_methods_alipay'] + au_becs_debit?: components['schemas']['payment_method_au_becs_debit'] + bacs_debit?: components['schemas']['payment_method_bacs_debit'] + bancontact?: components['schemas']['payment_method_bancontact'] + billing_details: components['schemas']['billing_details'] + boleto?: components['schemas']['payment_method_boleto'] + card?: components['schemas']['payment_method_card'] + card_present?: components['schemas']['payment_method_card_present'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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?: (Partial & Partial) | null; - eps?: components["schemas"]["payment_method_eps"]; - fpx?: components["schemas"]["payment_method_fpx"]; - giropay?: components["schemas"]["payment_method_giropay"]; - grabpay?: components["schemas"]["payment_method_grabpay"]; + customer?: (Partial & Partial) | null + eps?: components['schemas']['payment_method_eps'] + fpx?: components['schemas']['payment_method_fpx'] + giropay?: components['schemas']['payment_method_giropay'] + grabpay?: components['schemas']['payment_method_grabpay'] /** @description Unique identifier for the object. */ - id: string; - ideal?: components["schemas"]["payment_method_ideal"]; - interac_present?: components["schemas"]["payment_method_interac_present"]; - klarna?: components["schemas"]["payment_method_klarna"]; + id: string + ideal?: components['schemas']['payment_method_ideal'] + interac_present?: components['schemas']['payment_method_interac_present'] + klarna?: components['schemas']['payment_method_klarna'] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "payment_method"; - oxxo?: components["schemas"]["payment_method_oxxo"]; - p24?: components["schemas"]["payment_method_p24"]; - sepa_debit?: components["schemas"]["payment_method_sepa_debit"]; - sofort?: components["schemas"]["payment_method_sofort"]; + object: 'payment_method' + oxxo?: components['schemas']['payment_method_oxxo'] + p24?: components['schemas']['payment_method_p24'] + sepa_debit?: components['schemas']['payment_method_sepa_debit'] + sofort?: components['schemas']['payment_method_sofort'] /** * @description 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. * @enum {string} */ type: - | "acss_debit" - | "afterpay_clearpay" - | "alipay" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "card_present" - | "eps" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "interac_present" - | "klarna" - | "oxxo" - | "p24" - | "sepa_debit" - | "sofort" - | "wechat_pay"; - wechat_pay?: components["schemas"]["payment_method_wechat_pay"]; - }; + | 'acss_debit' + | 'afterpay_clearpay' + | 'alipay' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'card_present' + | 'eps' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'interac_present' + | 'klarna' + | 'oxxo' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' + wechat_pay?: components['schemas']['payment_method_wechat_pay'] + } /** payment_method_acss_debit */ payment_method_acss_debit: { /** @description Name of the bank associated with the bank account. */ - bank_name?: string | null; + bank_name?: string | null /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Institution number of the bank account. */ - institution_number?: string | null; + institution_number?: string | null /** @description Last four digits of the bank account number. */ - last4?: string | null; + last4?: string | null /** @description Transit number of the bank account. */ - transit_number?: string | null; - }; + transit_number?: string | null + } /** payment_method_afterpay_clearpay */ - payment_method_afterpay_clearpay: { [key: string]: unknown }; + payment_method_afterpay_clearpay: { [key: string]: unknown } /** payment_method_au_becs_debit */ payment_method_au_becs_debit: { /** @description Six-digit number identifying bank and branch associated with this bank account. */ - bsb_number?: string | null; + bsb_number?: string | null /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Last four digits of the bank account number. */ - last4?: string | null; - }; + last4?: string | null + } /** payment_method_bacs_debit */ payment_method_bacs_debit: { /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Last four digits of the bank account number. */ - last4?: string | null; + last4?: string | null /** @description Sort code of the bank account. (e.g., `10-20-30`) */ - sort_code?: string | null; - }; + sort_code?: string | null + } /** payment_method_bancontact */ - payment_method_bancontact: { [key: string]: unknown }; + payment_method_bancontact: { [key: string]: unknown } /** payment_method_boleto */ payment_method_boleto: { /** @description Uniquely identifies the customer tax id (CNPJ or CPF) */ - tax_id: string; - }; + tax_id: string + } /** payment_method_card */ payment_method_card: { /** @description Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ - brand: string; + brand: string /** @description Checks on Card address and CVC if provided. */ - checks?: Partial | null; + checks?: Partial | null /** @description 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?: string | null; + country?: string | null /** @description Two-digit number representing the card's expiration month. */ - exp_month: number; + exp_month: number /** @description Four-digit number representing the card's expiration year. */ - exp_year: number; + exp_year: number /** * @description 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. * * *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.* */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ - funding: string; + funding: string /** @description Details of the original PaymentMethod that created this object. */ - generated_from?: Partial | null; + generated_from?: Partial | null /** @description The last four digits of the card. */ - last4: string; + last4: string /** @description Contains information about card networks that can be used to process the payment. */ - networks?: Partial | null; + networks?: Partial | null /** @description Contains details on how this Card maybe be used for 3D Secure authentication. */ - three_d_secure_usage?: Partial | null; + three_d_secure_usage?: Partial | null /** @description If this Card is part of a card wallet, this contains the details of the card wallet. */ - wallet?: Partial | null; - }; + wallet?: Partial | null + } /** payment_method_card_checks */ payment_method_card_checks: { /** @description If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ - address_line1_check?: string | null; + address_line1_check?: string | null /** @description If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ - address_postal_code_check?: string | null; + address_postal_code_check?: string | null /** @description If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ - cvc_check?: string | null; - }; + cvc_check?: string | null + } /** payment_method_card_generated_card */ payment_method_card_generated_card: { /** @description The charge that created this object. */ - charge?: string | null; + charge?: string | null /** @description Transaction-specific details of the payment method used in the payment. */ - payment_method_details?: Partial | null; + payment_method_details?: Partial | null /** @description The ID of the SetupAttempt that generated this PaymentMethod, if any. */ - setup_attempt?: (Partial & Partial) | null; - }; + setup_attempt?: (Partial & Partial) | null + } /** payment_method_card_present */ - payment_method_card_present: { [key: string]: unknown }; + payment_method_card_present: { [key: string]: unknown } /** payment_method_card_wallet */ payment_method_card_wallet: { - amex_express_checkout?: components["schemas"]["payment_method_card_wallet_amex_express_checkout"]; - apple_pay?: components["schemas"]["payment_method_card_wallet_apple_pay"]; + amex_express_checkout?: components['schemas']['payment_method_card_wallet_amex_express_checkout'] + apple_pay?: components['schemas']['payment_method_card_wallet_apple_pay'] /** @description (For tokenized numbers only.) The last four digits of the device account number. */ - dynamic_last4?: string | null; - google_pay?: components["schemas"]["payment_method_card_wallet_google_pay"]; - masterpass?: components["schemas"]["payment_method_card_wallet_masterpass"]; - samsung_pay?: components["schemas"]["payment_method_card_wallet_samsung_pay"]; + dynamic_last4?: string | null + google_pay?: components['schemas']['payment_method_card_wallet_google_pay'] + masterpass?: components['schemas']['payment_method_card_wallet_masterpass'] + samsung_pay?: components['schemas']['payment_method_card_wallet_samsung_pay'] /** * @description The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, or `visa_checkout`. 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. * @enum {string} */ - type: "amex_express_checkout" | "apple_pay" | "google_pay" | "masterpass" | "samsung_pay" | "visa_checkout"; - visa_checkout?: components["schemas"]["payment_method_card_wallet_visa_checkout"]; - }; + type: 'amex_express_checkout' | 'apple_pay' | 'google_pay' | 'masterpass' | 'samsung_pay' | 'visa_checkout' + visa_checkout?: components['schemas']['payment_method_card_wallet_visa_checkout'] + } /** payment_method_card_wallet_amex_express_checkout */ - payment_method_card_wallet_amex_express_checkout: { [key: string]: unknown }; + payment_method_card_wallet_amex_express_checkout: { [key: string]: unknown } /** payment_method_card_wallet_apple_pay */ - payment_method_card_wallet_apple_pay: { [key: string]: unknown }; + payment_method_card_wallet_apple_pay: { [key: string]: unknown } /** payment_method_card_wallet_google_pay */ - payment_method_card_wallet_google_pay: { [key: string]: unknown }; + payment_method_card_wallet_google_pay: { [key: string]: unknown } /** payment_method_card_wallet_masterpass */ payment_method_card_wallet_masterpass: { /** @description 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?: Partial | null; + billing_address?: Partial | null /** @description 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?: string | null; + email?: string | null /** @description 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?: string | null; + name?: string | null /** @description 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?: Partial | null; - }; + shipping_address?: Partial | null + } /** payment_method_card_wallet_samsung_pay */ - payment_method_card_wallet_samsung_pay: { [key: string]: unknown }; + payment_method_card_wallet_samsung_pay: { [key: string]: unknown } /** payment_method_card_wallet_visa_checkout */ payment_method_card_wallet_visa_checkout: { /** @description 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?: Partial | null; + billing_address?: Partial | null /** @description 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?: string | null; + email?: string | null /** @description 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?: string | null; + name?: string | null /** @description 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?: Partial | null; - }; + shipping_address?: Partial | null + } /** payment_method_details */ payment_method_details: { - ach_credit_transfer?: components["schemas"]["payment_method_details_ach_credit_transfer"]; - ach_debit?: components["schemas"]["payment_method_details_ach_debit"]; - acss_debit?: components["schemas"]["payment_method_details_acss_debit"]; - afterpay_clearpay?: components["schemas"]["payment_method_details_afterpay_clearpay"]; - alipay?: components["schemas"]["payment_flows_private_payment_methods_alipay_details"]; - au_becs_debit?: components["schemas"]["payment_method_details_au_becs_debit"]; - bacs_debit?: components["schemas"]["payment_method_details_bacs_debit"]; - bancontact?: components["schemas"]["payment_method_details_bancontact"]; - boleto?: components["schemas"]["payment_method_details_boleto"]; - card?: components["schemas"]["payment_method_details_card"]; - card_present?: components["schemas"]["payment_method_details_card_present"]; - eps?: components["schemas"]["payment_method_details_eps"]; - fpx?: components["schemas"]["payment_method_details_fpx"]; - giropay?: components["schemas"]["payment_method_details_giropay"]; - grabpay?: components["schemas"]["payment_method_details_grabpay"]; - ideal?: components["schemas"]["payment_method_details_ideal"]; - interac_present?: components["schemas"]["payment_method_details_interac_present"]; - klarna?: components["schemas"]["payment_method_details_klarna"]; - multibanco?: components["schemas"]["payment_method_details_multibanco"]; - oxxo?: components["schemas"]["payment_method_details_oxxo"]; - p24?: components["schemas"]["payment_method_details_p24"]; - sepa_debit?: components["schemas"]["payment_method_details_sepa_debit"]; - sofort?: components["schemas"]["payment_method_details_sofort"]; - stripe_account?: components["schemas"]["payment_method_details_stripe_account"]; + ach_credit_transfer?: components['schemas']['payment_method_details_ach_credit_transfer'] + ach_debit?: components['schemas']['payment_method_details_ach_debit'] + acss_debit?: components['schemas']['payment_method_details_acss_debit'] + afterpay_clearpay?: components['schemas']['payment_method_details_afterpay_clearpay'] + alipay?: components['schemas']['payment_flows_private_payment_methods_alipay_details'] + au_becs_debit?: components['schemas']['payment_method_details_au_becs_debit'] + bacs_debit?: components['schemas']['payment_method_details_bacs_debit'] + bancontact?: components['schemas']['payment_method_details_bancontact'] + boleto?: components['schemas']['payment_method_details_boleto'] + card?: components['schemas']['payment_method_details_card'] + card_present?: components['schemas']['payment_method_details_card_present'] + eps?: components['schemas']['payment_method_details_eps'] + fpx?: components['schemas']['payment_method_details_fpx'] + giropay?: components['schemas']['payment_method_details_giropay'] + grabpay?: components['schemas']['payment_method_details_grabpay'] + ideal?: components['schemas']['payment_method_details_ideal'] + interac_present?: components['schemas']['payment_method_details_interac_present'] + klarna?: components['schemas']['payment_method_details_klarna'] + multibanco?: components['schemas']['payment_method_details_multibanco'] + oxxo?: components['schemas']['payment_method_details_oxxo'] + p24?: components['schemas']['payment_method_details_p24'] + sepa_debit?: components['schemas']['payment_method_details_sepa_debit'] + sofort?: components['schemas']['payment_method_details_sofort'] + stripe_account?: components['schemas']['payment_method_details_stripe_account'] /** * @description The type of transaction-specific details of the payment method used in the payment, one of `ach_credit_transfer`, `ach_debit`, `acss_debit`, `alipay`, `au_becs_debit`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `klarna`, `multibanco`, `p24`, `sepa_debit`, `sofort`, `stripe_account`, or `wechat`. * An additional hash is included on `payment_method_details` with a name matching this value. * It contains information specific to the payment method. */ - type: string; - wechat?: components["schemas"]["payment_method_details_wechat"]; - wechat_pay?: components["schemas"]["payment_method_details_wechat_pay"]; - }; + type: string + wechat?: components['schemas']['payment_method_details_wechat'] + wechat_pay?: components['schemas']['payment_method_details_wechat_pay'] + } /** payment_method_details_ach_credit_transfer */ payment_method_details_ach_credit_transfer: { /** @description Account number to transfer funds to. */ - account_number?: string | null; + account_number?: string | null /** @description Name of the bank associated with the routing number. */ - bank_name?: string | null; + bank_name?: string | null /** @description Routing transit number for the bank account to transfer funds to. */ - routing_number?: string | null; + routing_number?: string | null /** @description SWIFT code of the bank associated with the routing number. */ - swift_code?: string | null; - }; + swift_code?: string | null + } /** payment_method_details_ach_debit */ payment_method_details_ach_debit: { /** * @description Type of entity that holds the account. This can be either `individual` or `company`. * @enum {string|null} */ - account_holder_type?: ("company" | "individual") | null; + account_holder_type?: ('company' | 'individual') | null /** @description Name of the bank associated with the bank account. */ - bank_name?: string | null; + bank_name?: string | null /** @description Two-letter ISO code representing the country the bank account is located in. */ - country?: string | null; + country?: string | null /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Last four digits of the bank account number. */ - last4?: string | null; + last4?: string | null /** @description Routing transit number of the bank account. */ - routing_number?: string | null; - }; + routing_number?: string | null + } /** payment_method_details_acss_debit */ payment_method_details_acss_debit: { /** @description Name of the bank associated with the bank account. */ - bank_name?: string | null; + bank_name?: string | null /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Institution number of the bank account */ - institution_number?: string | null; + institution_number?: string | null /** @description Last four digits of the bank account number. */ - last4?: string | null; + last4?: string | null /** @description ID of the mandate used to make this payment. */ - mandate?: string; + mandate?: string /** @description Transit number of the bank account. */ - transit_number?: string | null; - }; + transit_number?: string | null + } /** payment_method_details_afterpay_clearpay */ payment_method_details_afterpay_clearpay: { /** @description Order identifier shown to the merchant in Afterpay’s online portal. */ - reference?: string | null; - }; + reference?: string | null + } /** payment_method_details_au_becs_debit */ payment_method_details_au_becs_debit: { /** @description Bank-State-Branch number of the bank account. */ - bsb_number?: string | null; + bsb_number?: string | null /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Last four digits of the bank account number. */ - last4?: string | null; + last4?: string | null /** @description ID of the mandate used to make this payment. */ - mandate?: string; - }; + mandate?: string + } /** payment_method_details_bacs_debit */ payment_method_details_bacs_debit: { /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Last four digits of the bank account number. */ - last4?: string | null; + last4?: string | null /** @description ID of the mandate used to make this payment. */ - mandate?: string | null; + mandate?: string | null /** @description Sort code of the bank account. (e.g., `10-20-30`) */ - sort_code?: string | null; - }; + sort_code?: string | null + } /** payment_method_details_bancontact */ payment_method_details_bancontact: { /** @description Bank code of bank associated with the bank account. */ - bank_code?: string | null; + bank_code?: string | null /** @description Name of the bank associated with the bank account. */ - bank_name?: string | null; + bank_name?: string | null /** @description Bank Identifier Code of the bank associated with the bank account. */ - bic?: string | null; + bic?: string | null /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ - generated_sepa_debit?: (Partial & Partial) | null; + generated_sepa_debit?: (Partial & Partial) | null /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ - generated_sepa_debit_mandate?: (Partial & Partial) | null; + generated_sepa_debit_mandate?: (Partial & Partial) | null /** @description Last four characters of the IBAN. */ - iban_last4?: string | null; + iban_last4?: string | null /** * @description Preferred language of the Bancontact authorization page that the customer is redirected to. * Can be one of `en`, `de`, `fr`, or `nl` * @enum {string|null} */ - preferred_language?: ("de" | "en" | "fr" | "nl") | null; + preferred_language?: ('de' | 'en' | 'fr' | 'nl') | null /** * @description Owner's verified full name. Values are verified or provided by Bancontact directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - verified_name?: string | null; - }; + verified_name?: string | null + } /** payment_method_details_boleto */ payment_method_details_boleto: { /** @description The tax ID of the customer (CPF for individuals consumers or CNPJ for businesses consumers) */ - tax_id: string; - }; + tax_id: string + } /** payment_method_details_card */ payment_method_details_card: { /** @description Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ - brand?: string | null; + brand?: string | null /** @description Check results by Card networks on Card address and CVC at time of payment. */ - checks?: Partial | null; + checks?: Partial | null /** @description 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?: string | null; + country?: string | null /** @description Two-digit number representing the card's expiration month. */ - exp_month: number; + exp_month: number /** @description Four-digit number representing the card's expiration year. */ - exp_year: number; + exp_year: number /** * @description 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. * * *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.* */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ - funding?: string | null; + funding?: string | null /** * @description Installment details for this payment (Mexico only). * * For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments). */ - installments?: Partial | null; + installments?: Partial | null /** @description The last four digits of the card. */ - last4?: string | null; + last4?: string | null /** @description Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ - network?: string | null; + network?: string | null /** @description Populated if this transaction used 3D Secure authentication. */ - three_d_secure?: Partial | null; + three_d_secure?: Partial | null /** @description If this Card is part of a card wallet, this contains the details of the card wallet. */ - wallet?: Partial | null; - }; + wallet?: Partial | null + } /** payment_method_details_card_checks */ payment_method_details_card_checks: { /** @description If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ - address_line1_check?: string | null; + address_line1_check?: string | null /** @description If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ - address_postal_code_check?: string | null; + address_postal_code_check?: string | null /** @description If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ - cvc_check?: string | null; - }; + cvc_check?: string | null + } /** payment_method_details_card_installments */ payment_method_details_card_installments: { /** @description Installment plan selected for the payment. */ - plan?: Partial | null; - }; + plan?: Partial | null + } /** payment_method_details_card_installments_plan */ payment_method_details_card_installments_plan: { /** @description For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card. */ - count?: number | null; + count?: number | null /** * @description For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card. * One of `month`. * @enum {string|null} */ - interval?: "month" | null; + interval?: 'month' | null /** * @description Type of installment plan, one of `fixed_count`. * @enum {string} */ - type: "fixed_count"; - }; + type: 'fixed_count' + } /** payment_method_details_card_present */ payment_method_details_card_present: { /** @description The authorized amount */ - amount_authorized?: number | null; + amount_authorized?: number | null /** @description Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ - brand?: string | null; + brand?: string | null /** @description 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?: string | null; + cardholder_name?: string | null /** @description 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?: string | null; + country?: string | null /** @description Authorization response cryptogram. */ - emv_auth_data?: string | null; + emv_auth_data?: string | null /** @description Two-digit number representing the card's expiration month. */ - exp_month: number; + exp_month: number /** @description Four-digit number representing the card's expiration year. */ - exp_year: number; + exp_year: number /** * @description 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. * * *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.* */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ - funding?: string | null; + funding?: string | null /** @description 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?: string | null; + generated_card?: string | null /** @description The last four digits of the card. */ - last4?: string | null; + last4?: string | null /** @description Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ - network?: string | null; + network?: string | null /** @description Defines whether the authorized amount can be over-captured or not */ - overcapture_supported?: boolean | null; + overcapture_supported?: boolean | null /** * @description How card details were read in this transaction. * @enum {string|null} */ - read_method?: - | ( - | "contact_emv" - | "contactless_emv" - | "contactless_magstripe_mode" - | "magnetic_stripe_fallback" - | "magnetic_stripe_track2" - ) - | null; + read_method?: ('contact_emv' | 'contactless_emv' | 'contactless_magstripe_mode' | 'magnetic_stripe_fallback' | 'magnetic_stripe_track2') | null /** @description A collection of fields required to be displayed on receipts. Only required for EMV transactions. */ - receipt?: Partial | null; - }; + receipt?: Partial | null + } /** payment_method_details_card_present_receipt */ payment_method_details_card_present_receipt: { /** * @description The type of account being debited or credited * @enum {string} */ - account_type?: "checking" | "credit" | "prepaid" | "unknown"; + account_type?: 'checking' | 'credit' | 'prepaid' | 'unknown' /** @description EMV tag 9F26, cryptogram generated by the integrated circuit chip. */ - application_cryptogram?: string | null; + application_cryptogram?: string | null /** @description Mnenomic of the Application Identifier. */ - application_preferred_name?: string | null; + application_preferred_name?: string | null /** @description Identifier for this transaction. */ - authorization_code?: string | null; + authorization_code?: string | null /** @description EMV tag 8A. A code returned by the card issuer. */ - authorization_response_code?: string | null; + authorization_response_code?: string | null /** @description How the cardholder verified ownership of the card. */ - cardholder_verification_method?: string | null; + cardholder_verification_method?: string | null /** @description EMV tag 84. Similar to the application identifier stored on the integrated circuit chip. */ - dedicated_file_name?: string | null; + dedicated_file_name?: string | null /** @description The outcome of a series of EMV functions performed by the card reader. */ - terminal_verification_results?: string | null; + terminal_verification_results?: string | null /** @description An indication of various EMV functions performed during the transaction. */ - transaction_status_information?: string | null; - }; + transaction_status_information?: string | null + } /** payment_method_details_card_wallet */ payment_method_details_card_wallet: { - amex_express_checkout?: components["schemas"]["payment_method_details_card_wallet_amex_express_checkout"]; - apple_pay?: components["schemas"]["payment_method_details_card_wallet_apple_pay"]; + amex_express_checkout?: components['schemas']['payment_method_details_card_wallet_amex_express_checkout'] + apple_pay?: components['schemas']['payment_method_details_card_wallet_apple_pay'] /** @description (For tokenized numbers only.) The last four digits of the device account number. */ - dynamic_last4?: string | null; - google_pay?: components["schemas"]["payment_method_details_card_wallet_google_pay"]; - masterpass?: components["schemas"]["payment_method_details_card_wallet_masterpass"]; - samsung_pay?: components["schemas"]["payment_method_details_card_wallet_samsung_pay"]; + dynamic_last4?: string | null + google_pay?: components['schemas']['payment_method_details_card_wallet_google_pay'] + masterpass?: components['schemas']['payment_method_details_card_wallet_masterpass'] + samsung_pay?: components['schemas']['payment_method_details_card_wallet_samsung_pay'] /** * @description The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, or `visa_checkout`. 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. * @enum {string} */ - type: "amex_express_checkout" | "apple_pay" | "google_pay" | "masterpass" | "samsung_pay" | "visa_checkout"; - visa_checkout?: components["schemas"]["payment_method_details_card_wallet_visa_checkout"]; - }; + type: 'amex_express_checkout' | 'apple_pay' | 'google_pay' | 'masterpass' | 'samsung_pay' | 'visa_checkout' + visa_checkout?: components['schemas']['payment_method_details_card_wallet_visa_checkout'] + } /** payment_method_details_card_wallet_amex_express_checkout */ - payment_method_details_card_wallet_amex_express_checkout: { [key: string]: unknown }; + payment_method_details_card_wallet_amex_express_checkout: { [key: string]: unknown } /** payment_method_details_card_wallet_apple_pay */ - payment_method_details_card_wallet_apple_pay: { [key: string]: unknown }; + payment_method_details_card_wallet_apple_pay: { [key: string]: unknown } /** payment_method_details_card_wallet_google_pay */ - payment_method_details_card_wallet_google_pay: { [key: string]: unknown }; + payment_method_details_card_wallet_google_pay: { [key: string]: unknown } /** payment_method_details_card_wallet_masterpass */ payment_method_details_card_wallet_masterpass: { /** @description 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?: Partial | null; + billing_address?: Partial | null /** @description 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?: string | null; + email?: string | null /** @description 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?: string | null; + name?: string | null /** @description 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?: Partial | null; - }; + shipping_address?: Partial | null + } /** payment_method_details_card_wallet_samsung_pay */ - payment_method_details_card_wallet_samsung_pay: { [key: string]: unknown }; + payment_method_details_card_wallet_samsung_pay: { [key: string]: unknown } /** payment_method_details_card_wallet_visa_checkout */ payment_method_details_card_wallet_visa_checkout: { /** @description 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?: Partial | null; + billing_address?: Partial | null /** @description 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?: string | null; + email?: string | null /** @description 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?: string | null; + name?: string | null /** @description 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?: Partial | null; - }; + shipping_address?: Partial | null + } /** payment_method_details_eps */ payment_method_details_eps: { /** @@ -10069,42 +9957,42 @@ export interface components { */ bank?: | ( - | "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" - | "dolomitenbank" - | "easybank_ag" - | "erste_bank_und_sparkassen" - | "hypo_alpeadriabank_international_ag" - | "hypo_bank_burgenland_aktiengesellschaft" - | "hypo_noe_lb_fur_niederosterreich_u_wien" - | "hypo_oberosterreich_salzburg_steiermark" - | "hypo_tirol_bank_ag" - | "hypo_vorarlberg_bank_ag" - | "marchfelder_bank" - | "oberbank_ag" - | "raiffeisen_bankengruppe_osterreich" - | "schoellerbank_ag" - | "sparda_bank_wien" - | "volksbank_gruppe" - | "volkskreditbank_ag" - | "vr_bank_braunau" + | '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' + | 'dolomitenbank' + | 'easybank_ag' + | 'erste_bank_und_sparkassen' + | 'hypo_alpeadriabank_international_ag' + | 'hypo_bank_burgenland_aktiengesellschaft' + | 'hypo_noe_lb_fur_niederosterreich_u_wien' + | 'hypo_oberosterreich_salzburg_steiermark' + | 'hypo_tirol_bank_ag' + | 'hypo_vorarlberg_bank_ag' + | 'marchfelder_bank' + | 'oberbank_ag' + | 'raiffeisen_bankengruppe_osterreich' + | 'schoellerbank_ag' + | 'sparda_bank_wien' + | 'volksbank_gruppe' + | 'volkskreditbank_ag' + | 'vr_bank_braunau' ) - | null; + | null /** * @description Owner's verified full name. Values are verified or provided by EPS directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. * EPS rarely provides this information so the attribute is usually empty. */ - verified_name?: string | null; - }; + verified_name?: string | null + } /** payment_method_details_fpx */ payment_method_details_fpx: { /** @@ -10112,50 +10000,50 @@ export interface components { * @enum {string} */ bank: - | "affin_bank" - | "agrobank" - | "alliance_bank" - | "ambank" - | "bank_islam" - | "bank_muamalat" - | "bank_rakyat" - | "bsn" - | "cimb" - | "deutsche_bank" - | "hong_leong_bank" - | "hsbc" - | "kfh" - | "maybank2e" - | "maybank2u" - | "ocbc" - | "pb_enterprise" - | "public_bank" - | "rhb" - | "standard_chartered" - | "uob"; + | 'affin_bank' + | 'agrobank' + | 'alliance_bank' + | 'ambank' + | 'bank_islam' + | 'bank_muamalat' + | 'bank_rakyat' + | 'bsn' + | 'cimb' + | 'deutsche_bank' + | 'hong_leong_bank' + | 'hsbc' + | 'kfh' + | 'maybank2e' + | 'maybank2u' + | 'ocbc' + | 'pb_enterprise' + | 'public_bank' + | 'rhb' + | 'standard_chartered' + | 'uob' /** @description Unique transaction id generated by FPX for every request from the merchant */ - transaction_id?: string | null; - }; + transaction_id?: string | null + } /** payment_method_details_giropay */ payment_method_details_giropay: { /** @description Bank code of bank associated with the bank account. */ - bank_code?: string | null; + bank_code?: string | null /** @description Name of the bank associated with the bank account. */ - bank_name?: string | null; + bank_name?: string | null /** @description Bank Identifier Code of the bank associated with the bank account. */ - bic?: string | null; + bic?: string | null /** * @description Owner's verified full name. Values are verified or provided by Giropay directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. * Giropay rarely provides this information so the attribute is usually empty. */ - verified_name?: string | null; - }; + verified_name?: string | null + } /** payment_method_details_grabpay */ payment_method_details_grabpay: { /** @description Unique transaction id generated by GrabPay */ - transaction_id?: string | null; - }; + transaction_id?: string | null + } /** payment_method_details_ideal */ payment_method_details_ideal: { /** @@ -10164,149 +10052,141 @@ export interface components { */ bank?: | ( - | "abn_amro" - | "asn_bank" - | "bunq" - | "handelsbanken" - | "ing" - | "knab" - | "moneyou" - | "rabobank" - | "regiobank" - | "revolut" - | "sns_bank" - | "triodos_bank" - | "van_lanschot" + | 'abn_amro' + | 'asn_bank' + | 'bunq' + | 'handelsbanken' + | 'ing' + | 'knab' + | 'moneyou' + | 'rabobank' + | 'regiobank' + | 'revolut' + | 'sns_bank' + | 'triodos_bank' + | 'van_lanschot' ) - | null; + | null /** * @description The Bank Identifier Code of the customer's bank. * @enum {string|null} */ bic?: | ( - | "ABNANL2A" - | "ASNBNL21" - | "BUNQNL2A" - | "FVLBNL22" - | "HANDNL2A" - | "INGBNL2A" - | "KNABNL2H" - | "MOYONL21" - | "RABONL2U" - | "RBRBNL21" - | "REVOLT21" - | "SNSBNL2A" - | "TRIONL2U" + | 'ABNANL2A' + | 'ASNBNL21' + | 'BUNQNL2A' + | 'FVLBNL22' + | 'HANDNL2A' + | 'INGBNL2A' + | 'KNABNL2H' + | 'MOYONL21' + | 'RABONL2U' + | 'RBRBNL21' + | 'REVOLT21' + | 'SNSBNL2A' + | 'TRIONL2U' ) - | null; + | null /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ - generated_sepa_debit?: (Partial & Partial) | null; + generated_sepa_debit?: (Partial & Partial) | null /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ - generated_sepa_debit_mandate?: (Partial & Partial) | null; + generated_sepa_debit_mandate?: (Partial & Partial) | null /** @description Last four characters of the IBAN. */ - iban_last4?: string | null; + iban_last4?: string | null /** * @description Owner's verified full name. Values are verified or provided by iDEAL directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - verified_name?: string | null; - }; + verified_name?: string | null + } /** payment_method_details_interac_present */ payment_method_details_interac_present: { /** @description Card brand. Can be `interac`, `mastercard` or `visa`. */ - brand?: string | null; + brand?: string | null /** @description 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?: string | null; + cardholder_name?: string | null /** @description 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?: string | null; + country?: string | null /** @description Authorization response cryptogram. */ - emv_auth_data?: string | null; + emv_auth_data?: string | null /** @description Two-digit number representing the card's expiration month. */ - exp_month: number; + exp_month: number /** @description Four-digit number representing the card's expiration year. */ - exp_year: number; + exp_year: number /** * @description 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. * * *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.* */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ - funding?: string | null; + funding?: string | null /** @description 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?: string | null; + generated_card?: string | null /** @description The last four digits of the card. */ - last4?: string | null; + last4?: string | null /** @description Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ - network?: string | null; + network?: string | null /** @description EMV tag 5F2D. Preferred languages specified by the integrated circuit chip. */ - preferred_locales?: string[] | null; + preferred_locales?: string[] | null /** * @description How card details were read in this transaction. * @enum {string|null} */ - read_method?: - | ( - | "contact_emv" - | "contactless_emv" - | "contactless_magstripe_mode" - | "magnetic_stripe_fallback" - | "magnetic_stripe_track2" - ) - | null; + read_method?: ('contact_emv' | 'contactless_emv' | 'contactless_magstripe_mode' | 'magnetic_stripe_fallback' | 'magnetic_stripe_track2') | null /** @description A collection of fields required to be displayed on receipts. Only required for EMV transactions. */ - receipt?: Partial | null; - }; + receipt?: Partial | null + } /** payment_method_details_interac_present_receipt */ payment_method_details_interac_present_receipt: { /** * @description The type of account being debited or credited * @enum {string} */ - account_type?: "checking" | "savings" | "unknown"; + account_type?: 'checking' | 'savings' | 'unknown' /** @description EMV tag 9F26, cryptogram generated by the integrated circuit chip. */ - application_cryptogram?: string | null; + application_cryptogram?: string | null /** @description Mnenomic of the Application Identifier. */ - application_preferred_name?: string | null; + application_preferred_name?: string | null /** @description Identifier for this transaction. */ - authorization_code?: string | null; + authorization_code?: string | null /** @description EMV tag 8A. A code returned by the card issuer. */ - authorization_response_code?: string | null; + authorization_response_code?: string | null /** @description How the cardholder verified ownership of the card. */ - cardholder_verification_method?: string | null; + cardholder_verification_method?: string | null /** @description EMV tag 84. Similar to the application identifier stored on the integrated circuit chip. */ - dedicated_file_name?: string | null; + dedicated_file_name?: string | null /** @description The outcome of a series of EMV functions performed by the card reader. */ - terminal_verification_results?: string | null; + terminal_verification_results?: string | null /** @description An indication of various EMV functions performed during the transaction. */ - transaction_status_information?: string | null; - }; + transaction_status_information?: string | null + } /** payment_method_details_klarna */ payment_method_details_klarna: { /** * @description The Klarna payment method used for this transaction. * Can be one of `pay_later`, `pay_now`, `pay_with_financing`, or `pay_in_installments` */ - payment_method_category?: string | null; + payment_method_category?: string | null /** * @description Preferred language of the Klarna authorization page that the customer is redirected to. * Can 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`, or `en-FR` */ - preferred_locale?: string | null; - }; + preferred_locale?: string | null + } /** payment_method_details_multibanco */ payment_method_details_multibanco: { /** @description Entity number associated with this Multibanco payment. */ - entity?: string | null; + entity?: string | null /** @description Reference number associated with this Multibanco payment. */ - reference?: string | null; - }; + reference?: string | null + } /** payment_method_details_oxxo */ payment_method_details_oxxo: { /** @description OXXO reference number */ - number?: string | null; - }; + number?: string | null + } /** payment_method_details_p24 */ payment_method_details_p24: { /** @@ -10315,96 +10195,96 @@ export interface components { */ bank?: | ( - | "alior_bank" - | "bank_millennium" - | "bank_nowy_bfg_sa" - | "bank_pekao_sa" - | "banki_spbdzielcze" - | "blik" - | "bnp_paribas" - | "boz" - | "citi_handlowy" - | "credit_agricole" - | "envelobank" - | "etransfer_pocztowy24" - | "getin_bank" - | "ideabank" - | "ing" - | "inteligo" - | "mbank_mtransfer" - | "nest_przelew" - | "noble_pay" - | "pbac_z_ipko" - | "plus_bank" - | "santander_przelew24" - | "tmobile_usbugi_bankowe" - | "toyota_bank" - | "volkswagen_bank" + | 'alior_bank' + | 'bank_millennium' + | 'bank_nowy_bfg_sa' + | 'bank_pekao_sa' + | 'banki_spbdzielcze' + | 'blik' + | 'bnp_paribas' + | 'boz' + | 'citi_handlowy' + | 'credit_agricole' + | 'envelobank' + | 'etransfer_pocztowy24' + | 'getin_bank' + | 'ideabank' + | 'ing' + | 'inteligo' + | 'mbank_mtransfer' + | 'nest_przelew' + | 'noble_pay' + | 'pbac_z_ipko' + | 'plus_bank' + | 'santander_przelew24' + | 'tmobile_usbugi_bankowe' + | 'toyota_bank' + | 'volkswagen_bank' ) - | null; + | null /** @description Unique reference for this Przelewy24 payment. */ - reference?: string | null; + reference?: string | null /** * @description Owner's verified full name. Values are verified or provided by Przelewy24 directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. * Przelewy24 rarely provides this information so the attribute is usually empty. */ - verified_name?: string | null; - }; + verified_name?: string | null + } /** payment_method_details_sepa_debit */ payment_method_details_sepa_debit: { /** @description Bank code of bank associated with the bank account. */ - bank_code?: string | null; + bank_code?: string | null /** @description Branch code of bank associated with the bank account. */ - branch_code?: string | null; + branch_code?: string | null /** @description Two-letter ISO code representing the country the bank account is located in. */ - country?: string | null; + country?: string | null /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Last four characters of the IBAN. */ - last4?: string | null; + last4?: string | null /** @description ID of the mandate used to make this payment. */ - mandate?: string | null; - }; + mandate?: string | null + } /** payment_method_details_sofort */ payment_method_details_sofort: { /** @description Bank code of bank associated with the bank account. */ - bank_code?: string | null; + bank_code?: string | null /** @description Name of the bank associated with the bank account. */ - bank_name?: string | null; + bank_name?: string | null /** @description Bank Identifier Code of the bank associated with the bank account. */ - bic?: string | null; + bic?: string | null /** @description Two-letter ISO code representing the country the bank account is located in. */ - country?: string | null; + country?: string | null /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ - generated_sepa_debit?: (Partial & Partial) | null; + generated_sepa_debit?: (Partial & Partial) | null /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ - generated_sepa_debit_mandate?: (Partial & Partial) | null; + generated_sepa_debit_mandate?: (Partial & Partial) | null /** @description Last four characters of the IBAN. */ - iban_last4?: string | null; + iban_last4?: string | null /** * @description Preferred language of the SOFORT authorization page that the customer is redirected to. * Can be one of `de`, `en`, `es`, `fr`, `it`, `nl`, or `pl` * @enum {string|null} */ - preferred_language?: ("de" | "en" | "es" | "fr" | "it" | "nl" | "pl") | null; + preferred_language?: ('de' | 'en' | 'es' | 'fr' | 'it' | 'nl' | 'pl') | null /** * @description Owner's verified full name. Values are verified or provided by SOFORT directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - verified_name?: string | null; - }; + verified_name?: string | null + } /** payment_method_details_stripe_account */ - payment_method_details_stripe_account: { [key: string]: unknown }; + payment_method_details_stripe_account: { [key: string]: unknown } /** payment_method_details_wechat */ - payment_method_details_wechat: { [key: string]: unknown }; + payment_method_details_wechat: { [key: string]: unknown } /** payment_method_details_wechat_pay */ payment_method_details_wechat_pay: { /** @description Uniquely identifies this particular WeChat Pay account. You can use this attribute to check whether two WeChat accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Transaction ID of this particular WeChat Pay transaction. */ - transaction_id?: string | null; - }; + transaction_id?: string | null + } /** payment_method_eps */ payment_method_eps: { /** @@ -10413,36 +10293,36 @@ export interface components { */ bank?: | ( - | "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" - | "dolomitenbank" - | "easybank_ag" - | "erste_bank_und_sparkassen" - | "hypo_alpeadriabank_international_ag" - | "hypo_bank_burgenland_aktiengesellschaft" - | "hypo_noe_lb_fur_niederosterreich_u_wien" - | "hypo_oberosterreich_salzburg_steiermark" - | "hypo_tirol_bank_ag" - | "hypo_vorarlberg_bank_ag" - | "marchfelder_bank" - | "oberbank_ag" - | "raiffeisen_bankengruppe_osterreich" - | "schoellerbank_ag" - | "sparda_bank_wien" - | "volksbank_gruppe" - | "volkskreditbank_ag" - | "vr_bank_braunau" + | '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' + | 'dolomitenbank' + | 'easybank_ag' + | 'erste_bank_und_sparkassen' + | 'hypo_alpeadriabank_international_ag' + | 'hypo_bank_burgenland_aktiengesellschaft' + | 'hypo_noe_lb_fur_niederosterreich_u_wien' + | 'hypo_oberosterreich_salzburg_steiermark' + | 'hypo_tirol_bank_ag' + | 'hypo_vorarlberg_bank_ag' + | 'marchfelder_bank' + | 'oberbank_ag' + | 'raiffeisen_bankengruppe_osterreich' + | 'schoellerbank_ag' + | 'sparda_bank_wien' + | 'volksbank_gruppe' + | 'volkskreditbank_ag' + | 'vr_bank_braunau' ) - | null; - }; + | null + } /** payment_method_fpx */ payment_method_fpx: { /** @@ -10450,32 +10330,32 @@ export interface components { * @enum {string} */ bank: - | "affin_bank" - | "agrobank" - | "alliance_bank" - | "ambank" - | "bank_islam" - | "bank_muamalat" - | "bank_rakyat" - | "bsn" - | "cimb" - | "deutsche_bank" - | "hong_leong_bank" - | "hsbc" - | "kfh" - | "maybank2e" - | "maybank2u" - | "ocbc" - | "pb_enterprise" - | "public_bank" - | "rhb" - | "standard_chartered" - | "uob"; - }; + | 'affin_bank' + | 'agrobank' + | 'alliance_bank' + | 'ambank' + | 'bank_islam' + | 'bank_muamalat' + | 'bank_rakyat' + | 'bsn' + | 'cimb' + | 'deutsche_bank' + | 'hong_leong_bank' + | 'hsbc' + | 'kfh' + | 'maybank2e' + | 'maybank2u' + | 'ocbc' + | 'pb_enterprise' + | 'public_bank' + | 'rhb' + | 'standard_chartered' + | 'uob' + } /** payment_method_giropay */ - payment_method_giropay: { [key: string]: unknown }; + payment_method_giropay: { [key: string]: unknown } /** payment_method_grabpay */ - payment_method_grabpay: { [key: string]: unknown }; + payment_method_grabpay: { [key: string]: unknown } /** payment_method_ideal */ payment_method_ideal: { /** @@ -10484,128 +10364,128 @@ export interface components { */ bank?: | ( - | "abn_amro" - | "asn_bank" - | "bunq" - | "handelsbanken" - | "ing" - | "knab" - | "moneyou" - | "rabobank" - | "regiobank" - | "revolut" - | "sns_bank" - | "triodos_bank" - | "van_lanschot" + | 'abn_amro' + | 'asn_bank' + | 'bunq' + | 'handelsbanken' + | 'ing' + | 'knab' + | 'moneyou' + | 'rabobank' + | 'regiobank' + | 'revolut' + | 'sns_bank' + | 'triodos_bank' + | 'van_lanschot' ) - | null; + | null /** * @description The Bank Identifier Code of the customer's bank, if the bank was provided. * @enum {string|null} */ bic?: | ( - | "ABNANL2A" - | "ASNBNL21" - | "BUNQNL2A" - | "FVLBNL22" - | "HANDNL2A" - | "INGBNL2A" - | "KNABNL2H" - | "MOYONL21" - | "RABONL2U" - | "RBRBNL21" - | "REVOLT21" - | "SNSBNL2A" - | "TRIONL2U" + | 'ABNANL2A' + | 'ASNBNL21' + | 'BUNQNL2A' + | 'FVLBNL22' + | 'HANDNL2A' + | 'INGBNL2A' + | 'KNABNL2H' + | 'MOYONL21' + | 'RABONL2U' + | 'RBRBNL21' + | 'REVOLT21' + | 'SNSBNL2A' + | 'TRIONL2U' ) - | null; - }; + | null + } /** payment_method_interac_present */ - payment_method_interac_present: { [key: string]: unknown }; + payment_method_interac_present: { [key: string]: unknown } /** payment_method_klarna */ payment_method_klarna: { /** @description The customer's date of birth, if provided. */ - dob?: Partial | null; - }; + dob?: Partial | null + } /** payment_method_options_afterpay_clearpay */ payment_method_options_afterpay_clearpay: { /** * @description Order identifier shown to the merchant in Afterpay’s online portal. We recommend using a value that helps you answer any questions a customer might have about * the payment. The identifier is limited to 128 characters and may contain only letters, digits, underscores, backslashes and dashes. */ - reference?: string | null; - }; + reference?: string | null + } /** payment_method_options_alipay */ - payment_method_options_alipay: { [key: string]: unknown }; + payment_method_options_alipay: { [key: string]: unknown } /** payment_method_options_bacs_debit */ - payment_method_options_bacs_debit: { [key: string]: unknown }; + payment_method_options_bacs_debit: { [key: string]: unknown } /** payment_method_options_bancontact */ payment_method_options_bancontact: { /** * @description Preferred language of the Bancontact authorization page that the customer is redirected to. * @enum {string} */ - preferred_language: "de" | "en" | "fr" | "nl"; - }; + preferred_language: 'de' | 'en' | 'fr' | 'nl' + } /** payment_method_options_boleto */ payment_method_options_boleto: { /** @description 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: number; - }; + expires_after_days: number + } /** payment_method_options_card_installments */ payment_method_options_card_installments: { /** @description Installment plans that may be selected for this PaymentIntent. */ - available_plans?: components["schemas"]["payment_method_details_card_installments_plan"][] | null; + available_plans?: components['schemas']['payment_method_details_card_installments_plan'][] | null /** @description Whether Installments are enabled for this PaymentIntent. */ - enabled: boolean; + enabled: boolean /** @description Installment plan selected for this PaymentIntent. */ - plan?: Partial | null; - }; + plan?: Partial | null + } /** payment_method_options_card_present */ - payment_method_options_card_present: { [key: string]: unknown }; + payment_method_options_card_present: { [key: string]: unknown } /** payment_method_options_fpx */ - payment_method_options_fpx: { [key: string]: unknown }; + payment_method_options_fpx: { [key: string]: unknown } /** payment_method_options_giropay */ - payment_method_options_giropay: { [key: string]: unknown }; + payment_method_options_giropay: { [key: string]: unknown } /** payment_method_options_grabpay */ - payment_method_options_grabpay: { [key: string]: unknown }; + payment_method_options_grabpay: { [key: string]: unknown } /** payment_method_options_ideal */ - payment_method_options_ideal: { [key: string]: unknown }; + payment_method_options_ideal: { [key: string]: unknown } /** payment_method_options_interac_present */ - payment_method_options_interac_present: { [key: string]: unknown }; + payment_method_options_interac_present: { [key: string]: unknown } /** payment_method_options_klarna */ payment_method_options_klarna: { /** @description Preferred locale of the Klarna checkout page that the customer is redirected to. */ - preferred_locale?: string | null; - }; + preferred_locale?: string | null + } /** payment_method_options_oxxo */ payment_method_options_oxxo: { /** @description 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: number; - }; + expires_after_days: number + } /** payment_method_options_p24 */ - payment_method_options_p24: { [key: string]: unknown }; + payment_method_options_p24: { [key: string]: unknown } /** payment_method_options_sofort */ payment_method_options_sofort: { /** * @description Preferred language of the SOFORT authorization page that the customer is redirected to. * @enum {string|null} */ - preferred_language?: ("de" | "en" | "es" | "fr" | "it" | "nl" | "pl") | null; - }; + preferred_language?: ('de' | 'en' | 'es' | 'fr' | 'it' | 'nl' | 'pl') | null + } /** payment_method_options_wechat_pay */ payment_method_options_wechat_pay: { /** @description The app ID registered with WeChat Pay. Only required when client is ios or android. */ - app_id?: string | null; + app_id?: string | null /** * @description The client type that the end customer will pay from * @enum {string|null} */ - client?: ("android" | "ios" | "web") | null; - }; + client?: ('android' | 'ios' | 'web') | null + } /** payment_method_oxxo */ - payment_method_oxxo: { [key: string]: unknown }; + payment_method_oxxo: { [key: string]: unknown } /** payment_method_p24 */ payment_method_p24: { /** @@ -10614,89 +10494,89 @@ export interface components { */ bank?: | ( - | "alior_bank" - | "bank_millennium" - | "bank_nowy_bfg_sa" - | "bank_pekao_sa" - | "banki_spbdzielcze" - | "blik" - | "bnp_paribas" - | "boz" - | "citi_handlowy" - | "credit_agricole" - | "envelobank" - | "etransfer_pocztowy24" - | "getin_bank" - | "ideabank" - | "ing" - | "inteligo" - | "mbank_mtransfer" - | "nest_przelew" - | "noble_pay" - | "pbac_z_ipko" - | "plus_bank" - | "santander_przelew24" - | "tmobile_usbugi_bankowe" - | "toyota_bank" - | "volkswagen_bank" + | 'alior_bank' + | 'bank_millennium' + | 'bank_nowy_bfg_sa' + | 'bank_pekao_sa' + | 'banki_spbdzielcze' + | 'blik' + | 'bnp_paribas' + | 'boz' + | 'citi_handlowy' + | 'credit_agricole' + | 'envelobank' + | 'etransfer_pocztowy24' + | 'getin_bank' + | 'ideabank' + | 'ing' + | 'inteligo' + | 'mbank_mtransfer' + | 'nest_przelew' + | 'noble_pay' + | 'pbac_z_ipko' + | 'plus_bank' + | 'santander_przelew24' + | 'tmobile_usbugi_bankowe' + | 'toyota_bank' + | 'volkswagen_bank' ) - | null; - }; + | null + } /** payment_method_sepa_debit */ payment_method_sepa_debit: { /** @description Bank code of bank associated with the bank account. */ - bank_code?: string | null; + bank_code?: string | null /** @description Branch code of bank associated with the bank account. */ - branch_code?: string | null; + branch_code?: string | null /** @description Two-letter ISO code representing the country the bank account is located in. */ - country?: string | null; + country?: string | null /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ - fingerprint?: string | null; + fingerprint?: string | null /** @description Information about the object that generated this PaymentMethod. */ - generated_from?: Partial | null; + generated_from?: Partial | null /** @description Last four characters of the IBAN. */ - last4?: string | null; - }; + last4?: string | null + } /** payment_method_sofort */ payment_method_sofort: { /** @description Two-letter ISO code representing the country the bank account is located in. */ - country?: string | null; - }; + country?: string | null + } /** payment_method_wechat_pay */ - payment_method_wechat_pay: { [key: string]: unknown }; + payment_method_wechat_pay: { [key: string]: unknown } /** PaymentPagesCheckoutSessionAfterExpiration */ payment_pages_checkout_session_after_expiration: { /** @description When set, configuration used to recover the Checkout Session on expiry. */ - recovery?: Partial | null; - }; + recovery?: Partial | null + } /** PaymentPagesCheckoutSessionAfterExpirationRecovery */ payment_pages_checkout_session_after_expiration_recovery: { /** @description Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to `false` */ - allow_promotion_codes: boolean; + allow_promotion_codes: boolean /** * @description If `true`, a recovery url will be generated to recover this Checkout Session if it * expires before a transaction is completed. It will be attached to the * Checkout Session object upon expiration. */ - enabled: boolean; + enabled: boolean /** * Format: unix-time * @description The timestamp at which the recovery URL will expire. */ - expires_at?: number | null; + expires_at?: number | null /** @description URL that creates a new Checkout Session when clicked that is a copy of this expired Checkout Session */ - url?: string | null; - }; + url?: string | null + } /** PaymentPagesCheckoutSessionAutomaticTax */ payment_pages_checkout_session_automatic_tax: { /** @description Indicates whether automatic tax is enabled for the session */ - enabled: boolean; + enabled: boolean /** * @description The status of the most recent automated tax calculation for this session. * @enum {string|null} */ - status?: ("complete" | "failed" | "requires_location_inputs") | null; - }; + status?: ('complete' | 'failed' | 'requires_location_inputs') | null + } /** PaymentPagesCheckoutSessionConsent */ payment_pages_checkout_session_consent: { /** @@ -10704,8 +10584,8 @@ export interface components { * from the merchant about this Checkout Session. * @enum {string|null} */ - promotions?: ("opt_in" | "opt_out") | null; - }; + promotions?: ('opt_in' | 'opt_out') | null + } /** PaymentPagesCheckoutSessionConsentCollection */ payment_pages_checkout_session_consent_collection: { /** @@ -10714,30 +10594,30 @@ export interface components { * from the merchant depending on the customer's locale. Only available to US merchants. * @enum {string|null} */ - promotions?: "auto" | null; - }; + promotions?: 'auto' | null + } /** PaymentPagesCheckoutSessionCustomerDetails */ payment_pages_checkout_session_customer_details: { /** * @description The email associated with the Customer, if one exists, on the Checkout Session at the time of checkout 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. */ - email?: string | null; + email?: string | null /** @description The customer's phone number at the time of checkout */ - phone?: string | null; + phone?: string | null /** * @description The customer’s tax exempt status at time of checkout. * @enum {string|null} */ - tax_exempt?: ("exempt" | "none" | "reverse") | null; + tax_exempt?: ('exempt' | 'none' | 'reverse') | null /** @description The customer’s tax IDs at time of checkout. */ - tax_ids?: components["schemas"]["payment_pages_checkout_session_tax_id"][] | null; - }; + tax_ids?: components['schemas']['payment_pages_checkout_session_tax_id'][] | null + } /** PaymentPagesCheckoutSessionPhoneNumberCollection */ payment_pages_checkout_session_phone_number_collection: { /** @description Indicates whether phone number collection is enabled for the session */ - enabled: boolean; - }; + enabled: boolean + } /** PaymentPagesCheckoutSessionShippingAddressCollection */ payment_pages_checkout_session_shipping_address_collection: { /** @@ -10745,252 +10625,252 @@ export interface components { * shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI`. */ allowed_countries: ( - | "AC" - | "AD" - | "AE" - | "AF" - | "AG" - | "AI" - | "AL" - | "AM" - | "AO" - | "AQ" - | "AR" - | "AT" - | "AU" - | "AW" - | "AX" - | "AZ" - | "BA" - | "BB" - | "BD" - | "BE" - | "BF" - | "BG" - | "BH" - | "BI" - | "BJ" - | "BL" - | "BM" - | "BN" - | "BO" - | "BQ" - | "BR" - | "BS" - | "BT" - | "BV" - | "BW" - | "BY" - | "BZ" - | "CA" - | "CD" - | "CF" - | "CG" - | "CH" - | "CI" - | "CK" - | "CL" - | "CM" - | "CN" - | "CO" - | "CR" - | "CV" - | "CW" - | "CY" - | "CZ" - | "DE" - | "DJ" - | "DK" - | "DM" - | "DO" - | "DZ" - | "EC" - | "EE" - | "EG" - | "EH" - | "ER" - | "ES" - | "ET" - | "FI" - | "FJ" - | "FK" - | "FO" - | "FR" - | "GA" - | "GB" - | "GD" - | "GE" - | "GF" - | "GG" - | "GH" - | "GI" - | "GL" - | "GM" - | "GN" - | "GP" - | "GQ" - | "GR" - | "GS" - | "GT" - | "GU" - | "GW" - | "GY" - | "HK" - | "HN" - | "HR" - | "HT" - | "HU" - | "ID" - | "IE" - | "IL" - | "IM" - | "IN" - | "IO" - | "IQ" - | "IS" - | "IT" - | "JE" - | "JM" - | "JO" - | "JP" - | "KE" - | "KG" - | "KH" - | "KI" - | "KM" - | "KN" - | "KR" - | "KW" - | "KY" - | "KZ" - | "LA" - | "LB" - | "LC" - | "LI" - | "LK" - | "LR" - | "LS" - | "LT" - | "LU" - | "LV" - | "LY" - | "MA" - | "MC" - | "MD" - | "ME" - | "MF" - | "MG" - | "MK" - | "ML" - | "MM" - | "MN" - | "MO" - | "MQ" - | "MR" - | "MS" - | "MT" - | "MU" - | "MV" - | "MW" - | "MX" - | "MY" - | "MZ" - | "NA" - | "NC" - | "NE" - | "NG" - | "NI" - | "NL" - | "NO" - | "NP" - | "NR" - | "NU" - | "NZ" - | "OM" - | "PA" - | "PE" - | "PF" - | "PG" - | "PH" - | "PK" - | "PL" - | "PM" - | "PN" - | "PR" - | "PS" - | "PT" - | "PY" - | "QA" - | "RE" - | "RO" - | "RS" - | "RU" - | "RW" - | "SA" - | "SB" - | "SC" - | "SE" - | "SG" - | "SH" - | "SI" - | "SJ" - | "SK" - | "SL" - | "SM" - | "SN" - | "SO" - | "SR" - | "SS" - | "ST" - | "SV" - | "SX" - | "SZ" - | "TA" - | "TC" - | "TD" - | "TF" - | "TG" - | "TH" - | "TJ" - | "TK" - | "TL" - | "TM" - | "TN" - | "TO" - | "TR" - | "TT" - | "TV" - | "TW" - | "TZ" - | "UA" - | "UG" - | "US" - | "UY" - | "UZ" - | "VA" - | "VC" - | "VE" - | "VG" - | "VN" - | "VU" - | "WF" - | "WS" - | "XK" - | "YE" - | "YT" - | "ZA" - | "ZM" - | "ZW" - | "ZZ" - )[]; - }; + | 'AC' + | 'AD' + | 'AE' + | 'AF' + | 'AG' + | 'AI' + | 'AL' + | 'AM' + | 'AO' + | 'AQ' + | 'AR' + | 'AT' + | 'AU' + | 'AW' + | 'AX' + | 'AZ' + | 'BA' + | 'BB' + | 'BD' + | 'BE' + | 'BF' + | 'BG' + | 'BH' + | 'BI' + | 'BJ' + | 'BL' + | 'BM' + | 'BN' + | 'BO' + | 'BQ' + | 'BR' + | 'BS' + | 'BT' + | 'BV' + | 'BW' + | 'BY' + | 'BZ' + | 'CA' + | 'CD' + | 'CF' + | 'CG' + | 'CH' + | 'CI' + | 'CK' + | 'CL' + | 'CM' + | 'CN' + | 'CO' + | 'CR' + | 'CV' + | 'CW' + | 'CY' + | 'CZ' + | 'DE' + | 'DJ' + | 'DK' + | 'DM' + | 'DO' + | 'DZ' + | 'EC' + | 'EE' + | 'EG' + | 'EH' + | 'ER' + | 'ES' + | 'ET' + | 'FI' + | 'FJ' + | 'FK' + | 'FO' + | 'FR' + | 'GA' + | 'GB' + | 'GD' + | 'GE' + | 'GF' + | 'GG' + | 'GH' + | 'GI' + | 'GL' + | 'GM' + | 'GN' + | 'GP' + | 'GQ' + | 'GR' + | 'GS' + | 'GT' + | 'GU' + | 'GW' + | 'GY' + | 'HK' + | 'HN' + | 'HR' + | 'HT' + | 'HU' + | 'ID' + | 'IE' + | 'IL' + | 'IM' + | 'IN' + | 'IO' + | 'IQ' + | 'IS' + | 'IT' + | 'JE' + | 'JM' + | 'JO' + | 'JP' + | 'KE' + | 'KG' + | 'KH' + | 'KI' + | 'KM' + | 'KN' + | 'KR' + | 'KW' + | 'KY' + | 'KZ' + | 'LA' + | 'LB' + | 'LC' + | 'LI' + | 'LK' + | 'LR' + | 'LS' + | 'LT' + | 'LU' + | 'LV' + | 'LY' + | 'MA' + | 'MC' + | 'MD' + | 'ME' + | 'MF' + | 'MG' + | 'MK' + | 'ML' + | 'MM' + | 'MN' + | 'MO' + | 'MQ' + | 'MR' + | 'MS' + | 'MT' + | 'MU' + | 'MV' + | 'MW' + | 'MX' + | 'MY' + | 'MZ' + | 'NA' + | 'NC' + | 'NE' + | 'NG' + | 'NI' + | 'NL' + | 'NO' + | 'NP' + | 'NR' + | 'NU' + | 'NZ' + | 'OM' + | 'PA' + | 'PE' + | 'PF' + | 'PG' + | 'PH' + | 'PK' + | 'PL' + | 'PM' + | 'PN' + | 'PR' + | 'PS' + | 'PT' + | 'PY' + | 'QA' + | 'RE' + | 'RO' + | 'RS' + | 'RU' + | 'RW' + | 'SA' + | 'SB' + | 'SC' + | 'SE' + | 'SG' + | 'SH' + | 'SI' + | 'SJ' + | 'SK' + | 'SL' + | 'SM' + | 'SN' + | 'SO' + | 'SR' + | 'SS' + | 'ST' + | 'SV' + | 'SX' + | 'SZ' + | 'TA' + | 'TC' + | 'TD' + | 'TF' + | 'TG' + | 'TH' + | 'TJ' + | 'TK' + | 'TL' + | 'TM' + | 'TN' + | 'TO' + | 'TR' + | 'TT' + | 'TV' + | 'TW' + | 'TZ' + | 'UA' + | 'UG' + | 'US' + | 'UY' + | 'UZ' + | 'VA' + | 'VC' + | 'VE' + | 'VG' + | 'VN' + | 'VU' + | 'WF' + | 'WS' + | 'XK' + | 'YE' + | 'YT' + | 'ZA' + | 'ZM' + | 'ZW' + | 'ZZ' + )[] + } /** PaymentPagesCheckoutSessionShippingOption */ payment_pages_checkout_session_shipping_option: { /** @description A non-negative integer in cents representing how much to charge. */ - shipping_amount: number; + shipping_amount: number /** @description The shipping rate. */ - shipping_rate: Partial & Partial; - }; + shipping_rate: Partial & Partial + } /** PaymentPagesCheckoutSessionTaxID */ payment_pages_checkout_session_tax_id: { /** @@ -10998,81 +10878,81 @@ export interface components { * @enum {string} */ type: - | "ae_trn" - | "au_abn" - | "au_arn" - | "br_cnpj" - | "br_cpf" - | "ca_bn" - | "ca_gst_hst" - | "ca_pst_bc" - | "ca_pst_mb" - | "ca_pst_sk" - | "ca_qst" - | "ch_vat" - | "cl_tin" - | "es_cif" - | "eu_vat" - | "gb_vat" - | "ge_vat" - | "hk_br" - | "id_npwp" - | "il_vat" - | "in_gst" - | "is_vat" - | "jp_cn" - | "jp_rn" - | "kr_brn" - | "li_uid" - | "mx_rfc" - | "my_frp" - | "my_itn" - | "my_sst" - | "no_vat" - | "nz_gst" - | "ru_inn" - | "ru_kpp" - | "sa_vat" - | "sg_gst" - | "sg_uen" - | "th_vat" - | "tw_vat" - | "ua_vat" - | "unknown" - | "us_ein" - | "za_vat"; + | 'ae_trn' + | 'au_abn' + | 'au_arn' + | 'br_cnpj' + | 'br_cpf' + | 'ca_bn' + | 'ca_gst_hst' + | 'ca_pst_bc' + | 'ca_pst_mb' + | 'ca_pst_sk' + | 'ca_qst' + | 'ch_vat' + | 'cl_tin' + | 'es_cif' + | 'eu_vat' + | 'gb_vat' + | 'ge_vat' + | 'hk_br' + | 'id_npwp' + | 'il_vat' + | 'in_gst' + | 'is_vat' + | 'jp_cn' + | 'jp_rn' + | 'kr_brn' + | 'li_uid' + | 'mx_rfc' + | 'my_frp' + | 'my_itn' + | 'my_sst' + | 'no_vat' + | 'nz_gst' + | 'ru_inn' + | 'ru_kpp' + | 'sa_vat' + | 'sg_gst' + | 'sg_uen' + | 'th_vat' + | 'tw_vat' + | 'ua_vat' + | 'unknown' + | 'us_ein' + | 'za_vat' /** @description The value of the tax ID. */ - value?: string | null; - }; + value?: string | null + } /** PaymentPagesCheckoutSessionTaxIDCollection */ payment_pages_checkout_session_tax_id_collection: { /** @description Indicates whether tax ID collection is enabled for the session */ - enabled: boolean; - }; + enabled: boolean + } /** PaymentPagesCheckoutSessionTotalDetails */ payment_pages_checkout_session_total_details: { /** @description This is the sum of all the line item discounts. */ - amount_discount: number; + amount_discount: number /** @description This is the sum of all the line item shipping amounts. */ - amount_shipping?: number | null; + amount_shipping?: number | null /** @description This is the sum of all the line item tax amounts. */ - amount_tax: number; - breakdown?: components["schemas"]["payment_pages_checkout_session_total_details_resource_breakdown"]; - }; + amount_tax: number + breakdown?: components['schemas']['payment_pages_checkout_session_total_details_resource_breakdown'] + } /** PaymentPagesCheckoutSessionTotalDetailsResourceBreakdown */ payment_pages_checkout_session_total_details_resource_breakdown: { /** @description The aggregated line item discounts. */ - discounts: components["schemas"]["line_items_discount_amount"][]; + discounts: components['schemas']['line_items_discount_amount'][] /** @description The aggregated line item tax amounts by rate. */ - taxes: components["schemas"]["line_items_tax_amount"][]; - }; + taxes: components['schemas']['line_items_tax_amount'][] + } /** Polymorphic */ - payment_source: Partial & - Partial & - Partial & - Partial & - Partial & - Partial; + payment_source: Partial & + Partial & + Partial & + Partial & + Partial & + Partial /** * Payout * @description A `Payout` object is created when you receive funds from Stripe, or when you @@ -11086,81 +10966,81 @@ export interface components { */ payout: { /** @description Amount (in %s) to be transferred to your bank account or debit card. */ - amount: number; + amount: number /** * Format: unix-time * @description Date the payout is expected to arrive in the bank. This factors in delays like weekends or bank holidays. */ - arrival_date: number; + arrival_date: number /** @description Returns `true` if the payout was created by an [automated payout schedule](https://stripe.com/docs/payouts#payout-schedule), and `false` if it was [requested manually](https://stripe.com/docs/payouts#manual-payouts). */ - automatic: boolean; + automatic: boolean /** @description ID of the balance transaction that describes the impact of this payout on your account balance. */ - balance_transaction?: (Partial & Partial) | null; + balance_transaction?: (Partial & Partial) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description ID of the bank account or card the payout was sent to. */ destination?: | (Partial & - Partial & - Partial & - Partial & - Partial) - | null; + Partial & + Partial & + Partial & + Partial) + | null /** @description If the payout failed or was canceled, this will be the ID of the balance transaction that reversed the initial balance transaction, and puts the funds from the failed payout back in your balance. */ - failure_balance_transaction?: (Partial & Partial) | null; + failure_balance_transaction?: (Partial & Partial) | null /** @description Error code explaining reason for payout failure if available. See [Types of payout failures](https://stripe.com/docs/api#payout_failures) for a list of failure codes. */ - failure_code?: string | null; + failure_code?: string | null /** @description Message to user further explaining reason for payout failure if available. */ - failure_message?: string | null; + failure_message?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** @description The method used to send this payout, which can be `standard` or `instant`. `instant` is only supported for payouts to debit cards. (See [Instant payouts for marketplaces](https://stripe.com/blog/instant-payouts-for-marketplaces) for more information.) */ - method: string; + method: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "payout"; + object: 'payout' /** @description If the payout reverses another, this is the ID of the original payout. */ - original_payout?: (Partial & Partial) | null; + original_payout?: (Partial & Partial) | null /** @description If the payout was reversed, this is the ID of the payout that reverses this payout. */ - reversed_by?: (Partial & Partial) | null; + reversed_by?: (Partial & Partial) | null /** @description The source balance this payout came from. One of `card`, `fpx`, or `bank_account`. */ - source_type: string; + source_type: string /** @description Extra information about a payout to be displayed on the user's bank statement. */ - statement_descriptor?: string | null; + statement_descriptor?: string | null /** @description Current status of the payout: `paid`, `pending`, `in_transit`, `canceled` or `failed`. A payout is `pending` until it is submitted to the bank, when it becomes `in_transit`. The status then changes to `paid` if the transaction goes through, or to `failed` or `canceled` (within 5 business days). Some failed payouts may initially show as `paid` but then change to `failed`. */ - status: string; + status: string /** * @description Can be `bank_account` or `card`. * @enum {string} */ - type: "bank_account" | "card"; - }; + type: 'bank_account' | 'card' + } /** Period */ period: { /** * Format: unix-time * @description The end date of this usage period. All usage up to and including this point in time is included. */ - end?: number | null; + end?: number | null /** * Format: unix-time * @description The start date of this usage period. All usage after this point in time is included. */ - start?: number | null; - }; + start?: number | null + } /** * Person * @description This is an object representing a person associated with a Stripe account. @@ -11172,108 +11052,108 @@ export interface components { */ person: { /** @description The account the person is associated with. */ - account: string; - address?: components["schemas"]["address"]; - address_kana?: Partial | null; - address_kanji?: Partial | null; + account: string + address?: components['schemas']['address'] + address_kana?: Partial | null + address_kanji?: Partial | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; - dob?: components["schemas"]["legal_entity_dob"]; + created: number + dob?: components['schemas']['legal_entity_dob'] /** @description The person's email address. */ - email?: string | null; + email?: string | null /** @description The person's first name. */ - first_name?: string | null; + first_name?: string | null /** @description The Kana variation of the person's first name (Japan only). */ - first_name_kana?: string | null; + first_name_kana?: string | null /** @description The Kanji variation of the person's first name (Japan only). */ - first_name_kanji?: string | null; + first_name_kanji?: string | null /** @description A list of alternate names or aliases that the person is known by. */ - full_name_aliases?: string[]; - future_requirements?: Partial | null; + full_name_aliases?: string[] + future_requirements?: Partial | null /** @description The person's gender (International regulations require either "male" or "female"). */ - gender?: string | null; + gender?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Whether the person's `id_number` was provided. */ - id_number_provided?: boolean; + id_number_provided?: boolean /** @description The person's last name. */ - last_name?: string | null; + last_name?: string | null /** @description The Kana variation of the person's last name (Japan only). */ - last_name_kana?: string | null; + last_name_kana?: string | null /** @description The Kanji variation of the person's last name (Japan only). */ - last_name_kanji?: string | null; + last_name_kanji?: string | null /** @description The person's maiden name. */ - maiden_name?: string | null; + maiden_name?: string | null /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The country where the person is a national. */ - nationality?: string | null; + nationality?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "person"; + object: 'person' /** @description The person's phone number. */ - phone?: string | null; + phone?: string | null /** * @description 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. * @enum {string} */ - political_exposure?: "existing" | "none"; - relationship?: components["schemas"]["person_relationship"]; - requirements?: Partial | null; + political_exposure?: 'existing' | 'none' + relationship?: components['schemas']['person_relationship'] + requirements?: Partial | null /** @description Whether the last four digits of the person's Social Security number have been provided (U.S. only). */ - ssn_last_4_provided?: boolean; - verification?: components["schemas"]["legal_entity_person_verification"]; - }; + ssn_last_4_provided?: boolean + verification?: components['schemas']['legal_entity_person_verification'] + } /** PersonFutureRequirements */ person_future_requirements: { /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ - alternatives?: components["schemas"]["account_requirements_alternative"][] | null; + alternatives?: components['schemas']['account_requirements_alternative'][] | null /** @description 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: string[]; + currently_due: string[] /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ - errors: components["schemas"]["account_requirements_error"][]; + errors: components['schemas']['account_requirements_error'][] /** @description Fields that need to be collected assuming all volume 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: string[]; + eventually_due: string[] /** @description 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: string[]; + past_due: string[] /** @description Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. */ - pending_verification: string[]; - }; + pending_verification: string[] + } /** PersonRelationship */ person_relationship: { /** @description 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?: boolean | null; + director?: boolean | null /** @description Whether the person has significant responsibility to control, manage, or direct the organization. */ - executive?: boolean | null; + executive?: boolean | null /** @description Whether the person is an owner of the account’s legal entity. */ - owner?: boolean | null; + owner?: boolean | null /** @description The percent owned by the person of the account's legal entity. */ - percent_ownership?: number | null; + percent_ownership?: number | null /** @description 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?: boolean | null; + representative?: boolean | null /** @description The person's title (e.g., CEO, Support Engineer). */ - title?: string | null; - }; + title?: string | null + } /** PersonRequirements */ person_requirements: { /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ - alternatives?: components["schemas"]["account_requirements_alternative"][] | null; + alternatives?: components['schemas']['account_requirements_alternative'][] | null /** @description 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: string[]; + currently_due: string[] /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ - errors: components["schemas"]["account_requirements_error"][]; + errors: components['schemas']['account_requirements_error'][] /** @description Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `current_deadline` becomes set. */ - eventually_due: string[]; + eventually_due: string[] /** @description 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: string[]; + past_due: string[] /** @description Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. */ - pending_verification: string[]; - }; + pending_verification: string[] + } /** * Plan * @description You can now model subscriptions more flexibly using the [Prices API](https://stripe.com/docs/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration. @@ -11287,202 +11167,189 @@ export interface components { */ plan: { /** @description Whether the plan can be used for new purchases. */ - active: boolean; + active: boolean /** * @description 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`. * @enum {string|null} */ - aggregate_usage?: ("last_during_period" | "last_ever" | "max" | "sum") | null; + aggregate_usage?: ('last_during_period' | 'last_ever' | 'max' | 'sum') | null /** @description The unit amount in %s to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. */ - amount?: number | null; + amount?: number | null /** * Format: decimal * @description The unit amount in %s to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`. */ - amount_decimal?: string | null; + amount_decimal?: string | null /** * @description 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. * @enum {string} */ - billing_scheme: "per_unit" | "tiered"; + billing_scheme: 'per_unit' | 'tiered' /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`. * @enum {string} */ - interval: "day" | "month" | "week" | "year"; + interval: 'day' | 'month' | 'week' | 'year' /** @description 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: number; + interval_count: number /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** @description A brief description of the plan, hidden from customers. */ - nickname?: string | null; + nickname?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "plan"; + object: 'plan' /** @description The product whose pricing this plan determines. */ - product?: - | (Partial & - Partial & - Partial) - | null; + product?: (Partial & Partial & Partial) | null /** @description Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. */ - tiers?: components["schemas"]["plan_tier"][]; + tiers?: components['schemas']['plan_tier'][] /** * @description 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. * @enum {string|null} */ - tiers_mode?: ("graduated" | "volume") | null; + tiers_mode?: ('graduated' | 'volume') | null /** @description Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`. */ - transform_usage?: Partial | null; + transform_usage?: Partial | null /** @description 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?: number | null; + trial_period_days?: number | null /** * @description 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`. * @enum {string} */ - usage_type: "licensed" | "metered"; - }; + usage_type: 'licensed' | 'metered' + } /** PlanTier */ plan_tier: { /** @description Price for the entire tier. */ - flat_amount?: number | null; + flat_amount?: number | null /** * Format: decimal * @description Same as `flat_amount`, but contains a decimal value with at most 12 decimal places. */ - flat_amount_decimal?: string | null; + flat_amount_decimal?: string | null /** @description Per unit price for units relevant to the tier. */ - unit_amount?: number | null; + unit_amount?: number | null /** * Format: decimal * @description Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. */ - unit_amount_decimal?: string | null; + unit_amount_decimal?: string | null /** @description Up to and including to this quantity will be contained in the tier. */ - up_to?: number | null; - }; + up_to?: number | null + } /** PlatformTax */ platform_tax_fee: { /** @description The Connected account that incurred this charge. */ - account: string; + account: string /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "platform_tax_fee"; + object: 'platform_tax_fee' /** @description The payment object that caused this tax to be inflicted. */ - source_transaction: string; + source_transaction: string /** @description The type of tax (VAT). */ - type: string; - }; + type: string + } /** PortalBusinessProfile */ portal_business_profile: { /** @description The messaging shown to customers in the portal. */ - headline?: string | null; + headline?: string | null /** @description A link to the business’s publicly available privacy policy. */ - privacy_policy_url: string; + privacy_policy_url: string /** @description A link to the business’s publicly available terms of service. */ - terms_of_service_url: string; - }; + terms_of_service_url: string + } /** PortalCustomerUpdate */ portal_customer_update: { /** @description The types of customer updates that are supported. When empty, customers are not updateable. */ - allowed_updates: ("address" | "email" | "phone" | "shipping" | "tax_id")[]; + allowed_updates: ('address' | 'email' | 'phone' | 'shipping' | 'tax_id')[] /** @description Whether the feature is enabled. */ - enabled: boolean; - }; + enabled: boolean + } /** PortalFeatures */ portal_features: { - customer_update: components["schemas"]["portal_customer_update"]; - invoice_history: components["schemas"]["portal_invoice_list"]; - payment_method_update: components["schemas"]["portal_payment_method_update"]; - subscription_cancel: components["schemas"]["portal_subscription_cancel"]; - subscription_pause: components["schemas"]["portal_subscription_pause"]; - subscription_update: components["schemas"]["portal_subscription_update"]; - }; + customer_update: components['schemas']['portal_customer_update'] + invoice_history: components['schemas']['portal_invoice_list'] + payment_method_update: components['schemas']['portal_payment_method_update'] + subscription_cancel: components['schemas']['portal_subscription_cancel'] + subscription_pause: components['schemas']['portal_subscription_pause'] + subscription_update: components['schemas']['portal_subscription_update'] + } /** PortalInvoiceList */ portal_invoice_list: { /** @description Whether the feature is enabled. */ - enabled: boolean; - }; + enabled: boolean + } /** PortalPaymentMethodUpdate */ portal_payment_method_update: { /** @description Whether the feature is enabled. */ - enabled: boolean; - }; + enabled: boolean + } /** PortalSubscriptionCancel */ portal_subscription_cancel: { - cancellation_reason: components["schemas"]["portal_subscription_cancellation_reason"]; + cancellation_reason: components['schemas']['portal_subscription_cancellation_reason'] /** @description Whether the feature is enabled. */ - enabled: boolean; + enabled: boolean /** * @description Whether to cancel subscriptions immediately or at the end of the billing period. * @enum {string} */ - mode: "at_period_end" | "immediately"; + mode: 'at_period_end' | 'immediately' /** * @description Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`. * @enum {string} */ - proration_behavior: "always_invoice" | "create_prorations" | "none"; - }; + proration_behavior: 'always_invoice' | 'create_prorations' | 'none' + } /** PortalSubscriptionCancellationReason */ portal_subscription_cancellation_reason: { /** @description Whether the feature is enabled. */ - enabled: boolean; + enabled: boolean /** @description Which cancellation reasons will be given as options to the customer. */ - options: ( - | "customer_service" - | "low_quality" - | "missing_features" - | "other" - | "switched_service" - | "too_complex" - | "too_expensive" - | "unused" - )[]; - }; + options: ('customer_service' | 'low_quality' | 'missing_features' | 'other' | 'switched_service' | 'too_complex' | 'too_expensive' | 'unused')[] + } /** PortalSubscriptionPause */ portal_subscription_pause: { /** @description Whether the feature is enabled. */ - enabled: boolean; - }; + enabled: boolean + } /** PortalSubscriptionUpdate */ portal_subscription_update: { /** @description The types of subscription updates that are supported for items listed in the `products` attribute. When empty, subscriptions are not updateable. */ - default_allowed_updates: ("price" | "promotion_code" | "quantity")[]; + default_allowed_updates: ('price' | 'promotion_code' | 'quantity')[] /** @description Whether the feature is enabled. */ - enabled: boolean; + enabled: boolean /** @description The list of products that support subscription updates. */ - products?: components["schemas"]["portal_subscription_update_product"][] | null; + products?: components['schemas']['portal_subscription_update_product'][] | null /** * @description Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`. * @enum {string} */ - proration_behavior: "always_invoice" | "create_prorations" | "none"; - }; + proration_behavior: 'always_invoice' | 'create_prorations' | 'none' + } /** PortalSubscriptionUpdateProduct */ portal_subscription_update_product: { /** @description The list of price IDs which, when subscribed to, a subscription can be updated. */ - prices: string[]; + prices: string[] /** @description The product ID. */ - product: string; - }; + product: string + } /** * Price * @description Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. @@ -11494,86 +11361,84 @@ export interface components { */ price: { /** @description Whether the price can be used for new purchases. */ - active: boolean; + active: boolean /** * @description 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. * @enum {string} */ - billing_scheme: "per_unit" | "tiered"; + billing_scheme: 'per_unit' | 'tiered' /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters. */ - lookup_key?: string | null; + lookup_key?: string | null /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** @description A brief description of the price, hidden from customers. */ - nickname?: string | null; + nickname?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "price"; + object: 'price' /** @description The ID of the product this price is associated with. */ - product: Partial & - Partial & - Partial; + product: Partial & Partial & Partial /** @description The recurring components of a price such as `interval` and `usage_type`. */ - recurring?: Partial | null; + recurring?: Partial | null /** * @description 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. * @enum {string|null} */ - tax_behavior?: ("exclusive" | "inclusive" | "unspecified") | null; + tax_behavior?: ('exclusive' | 'inclusive' | 'unspecified') | null /** @description Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. */ - tiers?: components["schemas"]["price_tier"][]; + tiers?: components['schemas']['price_tier'][] /** * @description 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. * @enum {string|null} */ - tiers_mode?: ("graduated" | "volume") | null; + tiers_mode?: ('graduated' | 'volume') | null /** @description Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`. */ - transform_quantity?: Partial | null; + transform_quantity?: Partial | null /** * @description One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase. * @enum {string} */ - type: "one_time" | "recurring"; + type: 'one_time' | 'recurring' /** @description The unit amount in %s to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. */ - unit_amount?: number | null; + unit_amount?: number | null /** * Format: decimal * @description The unit amount in %s to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`. */ - unit_amount_decimal?: string | null; - }; + unit_amount_decimal?: string | null + } /** PriceTier */ price_tier: { /** @description Price for the entire tier. */ - flat_amount?: number | null; + flat_amount?: number | null /** * Format: decimal * @description Same as `flat_amount`, but contains a decimal value with at most 12 decimal places. */ - flat_amount_decimal?: string | null; + flat_amount_decimal?: string | null /** @description Per unit price for units relevant to the tier. */ - unit_amount?: number | null; + unit_amount?: number | null /** * Format: decimal * @description Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. */ - unit_amount_decimal?: string | null; + unit_amount_decimal?: string | null /** @description Up to and including to this quantity will be contained in the tier. */ - up_to?: number | null; - }; + up_to?: number | null + } /** * Product * @description Products describe the specific goods or services you offer to your customers. @@ -11587,47 +11452,47 @@ export interface components { */ product: { /** @description Whether the product is currently available for purchase. */ - active: boolean; + active: boolean /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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?: string | null; + description?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description A list of up to 8 URLs of images for this product, meant to be displayable to the customer. */ - images: string[]; + images: string[] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** @description The product's name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions. */ - name: string; + name: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "product"; + object: 'product' /** @description The dimensions of this product for shipping purposes. */ - package_dimensions?: Partial | null; + package_dimensions?: Partial | null /** @description Whether this product is shipped (i.e., physical goods). */ - shippable?: boolean | null; + shippable?: boolean | null /** @description 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. */ - statement_descriptor?: string | null; + statement_descriptor?: string | null /** @description A [tax code](https://stripe.com/docs/tax/tax-codes) ID. */ - tax_code?: (Partial & Partial) | null; + tax_code?: (Partial & Partial) | null /** @description A label that represents units of this product in Stripe and on customers’ receipts and invoices. When set, this will be included in associated invoice line item descriptions. */ - unit_label?: string | null; + unit_label?: string | null /** * Format: unix-time * @description Time at which the object was last updated. Measured in seconds since the Unix epoch. */ - updated: number; + updated: number /** @description A URL of a publicly-accessible webpage for this product. */ - url?: string | null; - }; + url?: string | null + } /** * PromotionCode * @description A Promotion Code represents a customer-redeemable code for a coupon. It can be used to @@ -11635,52 +11500,48 @@ export interface components { */ promotion_code: { /** @description Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid. */ - active: boolean; + active: boolean /** @description The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. */ - code: string; - coupon: components["schemas"]["coupon"]; + code: string + coupon: components['schemas']['coupon'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The customer that this promotion code can be used by. */ - customer?: - | (Partial & - Partial & - Partial) - | null; + customer?: (Partial & Partial & Partial) | null /** * Format: unix-time * @description Date at which the promotion code can no longer be redeemed. */ - expires_at?: number | null; + expires_at?: number | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description Maximum number of times this promotion code can be redeemed. */ - max_redemptions?: number | null; + max_redemptions?: number | null /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "promotion_code"; - restrictions: components["schemas"]["promotion_codes_resource_restrictions"]; + object: 'promotion_code' + restrictions: components['schemas']['promotion_codes_resource_restrictions'] /** @description Number of times this promotion code has been used. */ - times_redeemed: number; - }; + times_redeemed: number + } /** PromotionCodesResourceRestrictions */ promotion_codes_resource_restrictions: { /** @description A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices */ - first_time_transaction: boolean; + first_time_transaction: boolean /** @description Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work). */ - minimum_amount?: number | null; + minimum_amount?: number | null /** @description Three-letter [ISO code](https://stripe.com/docs/currencies) for minimum_amount */ - minimum_amount_currency?: string | null; - }; + minimum_amount_currency?: string | null + } /** * Quote * @description A Quote is a way to model prices that you'd like to provide to a customer. @@ -11688,222 +11549,214 @@ export interface components { */ quote: { /** @description Total before any discounts or taxes are applied. */ - amount_subtotal: number; + amount_subtotal: number /** @description Total after discounts and taxes are applied. */ - amount_total: number; + amount_total: number /** @description 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?: number | null; + application_fee_amount?: number | null /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal 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?: number | null; - automatic_tax: components["schemas"]["quotes_resource_automatic_tax"]; + application_fee_percent?: number | null + automatic_tax: components['schemas']['quotes_resource_automatic_tax'] /** * @description 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. Defaults to `charge_automatically`. * @enum {string} */ - collection_method: "charge_automatically" | "send_invoice"; - computed: components["schemas"]["quotes_resource_computed"]; + collection_method: 'charge_automatically' | 'send_invoice' + computed: components['schemas']['quotes_resource_computed'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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?: string | null; + currency?: string | null /** @description The customer which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed. */ - customer?: - | (Partial & - Partial & - Partial) - | null; + customer?: (Partial & Partial & Partial) | null /** @description The tax rates applied to this quote. */ - default_tax_rates?: (Partial & Partial)[]; + default_tax_rates?: (Partial & Partial)[] /** @description A description that will be displayed on the quote PDF. */ - description?: string | null; + description?: string | null /** @description The discounts applied to this quote. */ - discounts: (Partial & Partial)[]; + discounts: (Partial & Partial)[] /** * Format: unix-time * @description The date on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. */ - expires_at: number; + expires_at: number /** @description A footer that will be displayed on the quote PDF. */ - footer?: string | null; + footer?: string | null /** @description Details of the quote that was cloned. See the [cloning documentation](https://stripe.com/docs/quotes/clone) for more details. */ - from_quote?: Partial | null; + from_quote?: Partial | null /** @description A header that will be displayed on the quote PDF. */ - header?: string | null; + header?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The invoice that was created from this quote. */ - invoice?: - | (Partial & - Partial & - Partial) - | null; + invoice?: (Partial & Partial & Partial) | null /** @description All invoices will be billed using the specified settings. */ - invoice_settings?: Partial | null; + invoice_settings?: Partial | null /** * QuotesResourceListLineItems * @description A list of items the customer is being quoted for. */ line_items?: { /** @description Details about each object. */ - data: components["schemas"]["item"][]; + data: components['schemas']['item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** @description 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?: string | null; + number?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "quote"; + object: 'quote' /** @description 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?: (Partial & Partial) | null; + on_behalf_of?: (Partial & Partial) | null /** * @description The status of the quote. * @enum {string} */ - status: "accepted" | "canceled" | "draft" | "open"; - status_transitions: components["schemas"]["quotes_resource_status_transitions"]; + status: 'accepted' | 'canceled' | 'draft' | 'open' + status_transitions: components['schemas']['quotes_resource_status_transitions'] /** @description The subscription that was created or updated from this quote. */ - subscription?: (Partial & Partial) | null; - subscription_data: components["schemas"]["quotes_resource_subscription_data"]; + subscription?: (Partial & Partial) | null + subscription_data: components['schemas']['quotes_resource_subscription_data'] /** @description The subscription schedule that was created or updated from this quote. */ - subscription_schedule?: (Partial & Partial) | null; - total_details: components["schemas"]["quotes_resource_total_details"]; + subscription_schedule?: (Partial & Partial) | null + total_details: components['schemas']['quotes_resource_total_details'] /** @description 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?: Partial | null; - }; + transfer_data?: Partial | null + } /** QuotesResourceAutomaticTax */ quotes_resource_automatic_tax: { /** @description Automatically calculate taxes */ - enabled: boolean; + enabled: boolean /** * @description The status of the most recent automated tax calculation for this quote. * @enum {string|null} */ - status?: ("complete" | "failed" | "requires_location_inputs") | null; - }; + status?: ('complete' | 'failed' | 'requires_location_inputs') | null + } /** QuotesResourceComputed */ quotes_resource_computed: { /** @description 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?: Partial | null; - upfront: components["schemas"]["quotes_resource_upfront"]; - }; + recurring?: Partial | null + upfront: components['schemas']['quotes_resource_upfront'] + } /** QuotesResourceFromQuote */ quotes_resource_from_quote: { /** @description Whether this quote is a revision of a different quote. */ - is_revision: boolean; + is_revision: boolean /** @description The quote that was cloned. */ - quote: Partial & Partial; - }; + quote: Partial & Partial + } /** QuotesResourceRecurring */ quotes_resource_recurring: { /** @description Total before any discounts or taxes are applied. */ - amount_subtotal: number; + amount_subtotal: number /** @description Total after discounts and taxes are applied. */ - amount_total: number; + amount_total: number /** * @description The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`. * @enum {string} */ - interval: "day" | "month" | "week" | "year"; + interval: 'day' | 'month' | 'week' | 'year' /** @description 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: number; - total_details: components["schemas"]["quotes_resource_total_details"]; - }; + interval_count: number + total_details: components['schemas']['quotes_resource_total_details'] + } /** QuotesResourceStatusTransitions */ quotes_resource_status_transitions: { /** * Format: unix-time * @description The time that the quote was accepted. Measured in seconds since Unix epoch. */ - accepted_at?: number | null; + accepted_at?: number | null /** * Format: unix-time * @description The time that the quote was canceled. Measured in seconds since Unix epoch. */ - canceled_at?: number | null; + canceled_at?: number | null /** * Format: unix-time * @description The time that the quote was finalized. Measured in seconds since Unix epoch. */ - finalized_at?: number | null; - }; + finalized_at?: number | null + } /** QuotesResourceSubscriptionData */ quotes_resource_subscription_data: { /** * Format: unix-time * @description 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?: number | null; + effective_date?: number | null /** @description Integer representing the number of trial period days before the customer is charged for the first time. */ - trial_period_days?: number | null; - }; + trial_period_days?: number | null + } /** QuotesResourceTotalDetails */ quotes_resource_total_details: { /** @description This is the sum of all the line item discounts. */ - amount_discount: number; + amount_discount: number /** @description This is the sum of all the line item shipping amounts. */ - amount_shipping?: number | null; + amount_shipping?: number | null /** @description This is the sum of all the line item tax amounts. */ - amount_tax: number; - breakdown?: components["schemas"]["quotes_resource_total_details_resource_breakdown"]; - }; + amount_tax: number + breakdown?: components['schemas']['quotes_resource_total_details_resource_breakdown'] + } /** QuotesResourceTotalDetailsResourceBreakdown */ quotes_resource_total_details_resource_breakdown: { /** @description The aggregated line item discounts. */ - discounts: components["schemas"]["line_items_discount_amount"][]; + discounts: components['schemas']['line_items_discount_amount'][] /** @description The aggregated line item tax amounts by rate. */ - taxes: components["schemas"]["line_items_tax_amount"][]; - }; + taxes: components['schemas']['line_items_tax_amount'][] + } /** QuotesResourceTransferData */ quotes_resource_transfer_data: { /** @description The amount in %s that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination. */ - amount?: number | null; + amount?: number | null /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the destination account. By default, the entire amount will be transferred to the destination. */ - amount_percent?: number | null; + amount_percent?: number | null /** @description The account where funds from the payment will be transferred to upon payment success. */ - destination: Partial & Partial; - }; + destination: Partial & Partial + } /** QuotesResourceUpfront */ quotes_resource_upfront: { /** @description Total before any discounts or taxes are applied. */ - amount_subtotal: number; + amount_subtotal: number /** @description Total after discounts and taxes are applied. */ - amount_total: number; + amount_total: number /** * QuotesResourceListLineItems * @description 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?: { /** @description Details about each object. */ - data: components["schemas"]["item"][]; + data: components['schemas']['item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - total_details: components["schemas"]["quotes_resource_total_details"]; - }; + url: string + } + total_details: components['schemas']['quotes_resource_total_details'] + } /** * RadarEarlyFraudWarning * @description An early fraud warning indicates that the card issuer has notified us that a @@ -11911,142 +11764,134 @@ export interface components { * * Related guide: [Early Fraud Warnings](https://stripe.com/docs/disputes/measuring#early-fraud-warnings). */ - "radar.early_fraud_warning": { + 'radar.early_fraud_warning': { /** @description 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: boolean; + actionable: boolean /** @description ID of the charge this early fraud warning is for, optionally expanded. */ - charge: Partial & Partial; + charge: Partial & Partial /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + fraud_type: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "radar.early_fraud_warning"; + object: 'radar.early_fraud_warning' /** @description ID of the Payment Intent this early fraud warning is for, optionally expanded. */ - payment_intent?: Partial & Partial; - }; + payment_intent?: Partial & Partial + } /** * RadarListList * @description Value lists allow you to group values together which can then be referenced in rules. * * Related guide: [Default Stripe Lists](https://stripe.com/docs/radar/lists#managing-list-items). */ - "radar.value_list": { + 'radar.value_list': { /** @description The name of the value list for use in rules. */ - alias: string; + alias: string /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The name or email address of the user who created this value list. */ - created_by: string; + created_by: string /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description The type of items in the value list. One of `card_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, `case_sensitive_string`, or `customer_id`. * @enum {string} */ - item_type: - | "card_bin" - | "card_fingerprint" - | "case_sensitive_string" - | "country" - | "customer_id" - | "email" - | "ip_address" - | "string"; + item_type: 'card_bin' | 'card_fingerprint' | 'case_sensitive_string' | 'country' | 'customer_id' | 'email' | 'ip_address' | 'string' /** * RadarListListItemList * @description List of items contained within this value list. */ list_items: { /** @description Details about each object. */ - data: components["schemas"]["radar.value_list_item"][]; + data: components['schemas']['radar.value_list_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** @description The name of the value list. */ - name: string; + name: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "radar.value_list"; - }; + object: 'radar.value_list' + } /** * RadarListListItem * @description Value list items allow you to add specific values to a given Radar value list, which can then be used in rules. * * Related guide: [Managing List Items](https://stripe.com/docs/radar/lists#managing-list-items). */ - "radar.value_list_item": { + 'radar.value_list_item': { /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The name or email address of the user who added this item to the value list. */ - created_by: string; + created_by: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "radar.value_list_item"; + object: 'radar.value_list_item' /** @description The value of the item. */ - value: string; + value: string /** @description The identifier of the value list this item belongs to. */ - value_list: string; - }; + value_list: string + } /** RadarReviewResourceLocation */ radar_review_resource_location: { /** @description The city where the payment originated. */ - city?: string | null; + city?: string | null /** @description Two-letter ISO code representing the country where the payment originated. */ - country?: string | null; + country?: string | null /** @description The geographic latitude where the payment originated. */ - latitude?: number | null; + latitude?: number | null /** @description The geographic longitude where the payment originated. */ - longitude?: number | null; + longitude?: number | null /** @description The state/county/province/region where the payment originated. */ - region?: string | null; - }; + region?: string | null + } /** RadarReviewResourceSession */ radar_review_resource_session: { /** @description The browser used in this browser session (e.g., `Chrome`). */ - browser?: string | null; + browser?: string | null /** @description Information about the device used for the browser session (e.g., `Samsung SM-G930T`). */ - device?: string | null; + device?: string | null /** @description The platform for the browser session (e.g., `Macintosh`). */ - platform?: string | null; + platform?: string | null /** @description The version for the browser session (e.g., `61.0.3163.100`). */ - version?: string | null; - }; + version?: string | null + } /** * TransferRecipient * @description With `Recipient` objects, you can transfer money from your Stripe account to a @@ -12062,69 +11907,69 @@ export interface components { */ recipient: { /** @description Hash describing the current account on the recipient, if there is one. */ - active_account?: Partial | null; + active_account?: Partial | null /** CardList */ cards?: { - data: components["schemas"]["card"][]; + data: components['schemas']['card'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - } | null; + url: string + } | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The default card to use for creating transfers to this recipient. */ - default_card?: (Partial & Partial) | null; + default_card?: (Partial & Partial) | null /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; - email?: string | null; + description?: string | null + email?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** @description The ID of the [Custom account](https://stripe.com/docs/connect/custom-accounts) this recipient was migrated to. If set, the recipient can no longer be updated, nor can transfers be made to it: use the Custom account instead. */ - migrated_to?: (Partial & Partial) | null; + migrated_to?: (Partial & Partial) | null /** @description Full, legal name of the recipient. */ - name?: string | null; + name?: string | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "recipient"; - rolled_back_from?: Partial & Partial; + object: 'recipient' + rolled_back_from?: Partial & Partial /** @description Type of the recipient, one of `individual` or `corporation`. */ - type: string; - }; + type: string + } /** Recurring */ recurring: { /** * @description Specifies a usage aggregation strategy for prices 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`. * @enum {string|null} */ - aggregate_usage?: ("last_during_period" | "last_ever" | "max" | "sum") | null; + aggregate_usage?: ('last_during_period' | 'last_ever' | 'max' | 'sum') | null /** * @description The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`. * @enum {string} */ - interval: "day" | "month" | "week" | "year"; + interval: 'day' | 'month' | 'week' | 'year' /** @description 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: number; + interval_count: number /** * @description 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`. * @enum {string} */ - usage_type: "licensed" | "metered"; - }; + usage_type: 'licensed' | 'metered' + } /** * Refund * @description `Refund` objects allow you to refund a charge that has previously been created @@ -12135,49 +11980,49 @@ export interface components { */ refund: { /** @description Amount, in %s. */ - amount: number; + amount: number /** @description Balance transaction that describes the impact on your account balance. */ - balance_transaction?: (Partial & Partial) | null; + balance_transaction?: (Partial & Partial) | null /** @description ID of the charge that was refunded. */ - charge?: (Partial & Partial) | null; + charge?: (Partial & Partial) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. (Available on non-card refunds only) */ - description?: string; + description?: string /** @description If the refund failed, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction. */ - failure_balance_transaction?: Partial & Partial; + failure_balance_transaction?: Partial & Partial /** @description If the refund failed, the reason for refund failure if known. Possible values are `lost_or_stolen_card`, `expired_or_canceled_card`, or `unknown`. */ - failure_reason?: string; + failure_reason?: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "refund"; + object: 'refund' /** @description ID of the PaymentIntent that was refunded. */ - payment_intent?: (Partial & Partial) | null; + payment_intent?: (Partial & Partial) | null /** * @description Reason for the refund, either user-provided (`duplicate`, `fraudulent`, or `requested_by_customer`) or generated by Stripe internally (`expired_uncaptured_charge`). * @enum {string|null} */ - reason?: ("duplicate" | "expired_uncaptured_charge" | "fraudulent" | "requested_by_customer") | null; + reason?: ('duplicate' | 'expired_uncaptured_charge' | 'fraudulent' | 'requested_by_customer') | null /** @description This is the transaction number that appears on email receipts sent for this refund. */ - receipt_number?: string | null; + receipt_number?: string | null /** @description The transfer reversal that is associated with the refund. Only present if the charge came from another Stripe account. See the Connect documentation for details. */ - source_transfer_reversal?: (Partial & Partial) | null; + source_transfer_reversal?: (Partial & Partial) | null /** @description Status of the refund. For credit card refunds, this can be `pending`, `succeeded`, or `failed`. For other types of refunds, it can be `pending`, `succeeded`, `failed`, or `canceled`. Refer to our [refunds](https://stripe.com/docs/refunds#failed-refunds) documentation for more details. */ - status?: string | null; + status?: string | null /** @description If the accompanying transfer was reversed, the transfer reversal object. Only applicable if the charge was created using the destination parameter. */ - transfer_reversal?: (Partial & Partial) | null; - }; + transfer_reversal?: (Partial & Partial) | null + } /** * reporting_report_run * @description The Report Run object represents an instance of a report type generated with @@ -12189,47 +12034,47 @@ export interface components { * Note that certain report types can only be run based on your live-mode data (not test-mode * data), and will error when queried without a [live-mode API key](https://stripe.com/docs/keys#test-live-modes). */ - "reporting.report_run": { + 'reporting.report_run': { /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** * @description If something should go wrong during the run, a message about the failure (populated when * `status=failed`). */ - error?: string | null; + error?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description `true` if the report is run on live mode data and `false` if it is run on test mode data. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "reporting.report_run"; - parameters: components["schemas"]["financial_reporting_finance_report_run_run_parameters"]; + object: 'reporting.report_run' + parameters: components['schemas']['financial_reporting_finance_report_run_run_parameters'] /** @description The ID of the [report type](https://stripe.com/docs/reports/report-types) to run, such as `"balance.summary.1"`. */ - report_type: string; + report_type: string /** * @description The file object representing the result of the report run (populated when * `status=succeeded`). */ - result?: Partial | null; + result?: Partial | null /** * @description 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. * Rarely, we may encounter an error, at which point this will be set to `failed` and the `error` field will be populated. */ - status: string; + status: string /** * Format: unix-time * @description Timestamp at which this run successfully finished (populated when * `status=succeeded`). Measured in seconds since the Unix epoch. */ - succeeded_at?: number | null; - }; + succeeded_at?: number | null + } /** * reporting_report_type * @description The Report Type resource corresponds to a particular type of report, such as @@ -12241,53 +12086,53 @@ export interface components { * Note that certain report types can only be run based on your live-mode data (not test-mode * data), and will error when queried without a [live-mode API key](https://stripe.com/docs/keys#test-live-modes). */ - "reporting.report_type": { + 'reporting.report_type': { /** * Format: unix-time * @description Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch. */ - data_available_end: number; + data_available_end: number /** * Format: unix-time * @description Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch. */ - data_available_start: number; + data_available_start: number /** @description 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?: string[] | null; + default_columns?: string[] | null /** @description The [ID of the Report Type](https://stripe.com/docs/reporting/statements/api#available-report-types), such as `balance.summary.1`. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description Human-readable name of the Report Type */ - name: string; + name: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "reporting.report_type"; + object: 'reporting.report_type' /** * Format: unix-time * @description When this Report Type was latest updated. Measured in seconds since the Unix epoch. */ - updated: number; + updated: number /** @description 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: number; - }; + version: number + } /** ReserveTransaction */ reserve_transaction: { - amount: number; + amount: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "reserve_transaction"; - }; + object: 'reserve_transaction' + } /** * RadarReview * @description Reviews can be used to supplement automated fraud detection with human expertise. @@ -12297,55 +12142,55 @@ export interface components { */ review: { /** @description The ZIP or postal code of the card used, if applicable. */ - billing_zip?: string | null; + billing_zip?: string | null /** @description The charge associated with this review. */ - charge?: (Partial & Partial) | null; + charge?: (Partial & Partial) | null /** * @description 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`. * @enum {string|null} */ - closed_reason?: ("approved" | "disputed" | "redacted" | "refunded" | "refunded_as_fraud") | null; + closed_reason?: ('approved' | 'disputed' | 'redacted' | 'refunded' | 'refunded_as_fraud') | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The IP address where the payment originated. */ - ip_address?: string | null; + ip_address?: string | null /** @description 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?: Partial | null; + ip_address_location?: Partial | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "review"; + object: 'review' /** @description If `true`, the review needs action. */ - open: boolean; + open: boolean /** * @description The reason the review was opened. One of `rule` or `manual`. * @enum {string} */ - opened_reason: "manual" | "rule"; + opened_reason: 'manual' | 'rule' /** @description The PaymentIntent ID associated with this review, if one exists. */ - payment_intent?: Partial & Partial; + payment_intent?: Partial & Partial /** @description The reason the review is currently open or closed. One of `rule`, `manual`, `approved`, `refunded`, `refunded_as_fraud`, `disputed`, or `redacted`. */ - reason: string; + reason: string /** @description Information related to the browsing session of the user who initiated the payment. */ - session?: Partial | null; - }; + session?: Partial | null + } /** RadarRule */ rule: { /** @description The action taken on the payment. */ - action: string; + action: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The predicate to evaluate the payment against. */ - predicate: string; - }; + predicate: string + } /** * ScheduledQueryRun * @description If you have [scheduled a Sigma query](https://stripe.com/docs/sigma/scheduled-queries), you'll @@ -12358,48 +12203,48 @@ export interface components { * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** * Format: unix-time * @description When the query was run, Sigma contained a snapshot of your Stripe data at this time. */ - data_load_time: number; - error?: components["schemas"]["sigma_scheduled_query_run_error"]; + data_load_time: number + error?: components['schemas']['sigma_scheduled_query_run_error'] /** @description The file object representing the results of the query. */ - file?: Partial | null; + file?: Partial | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "scheduled_query_run"; + object: 'scheduled_query_run' /** * Format: unix-time * @description Time at which the result expires and is no longer available for download. */ - result_available_until: number; + result_available_until: number /** @description SQL for the query. */ - sql: string; + sql: string /** @description The query's execution status, which will be `completed` for successful runs, and `canceled`, `failed`, or `timed_out` otherwise. */ - status: string; + status: string /** @description Title of the query. */ - title: string; - }; + title: string + } /** SchedulesPhaseAutomaticTax */ schedules_phase_automatic_tax: { /** @description Whether Stripe automatically computes tax on invoices created during this phase. */ - enabled: boolean; - }; + enabled: boolean + } /** sepa_debit_generated_from */ sepa_debit_generated_from: { /** @description The ID of the Charge that generated this PaymentMethod, if any. */ - charge?: (Partial & Partial) | null; + charge?: (Partial & Partial) | null /** @description The ID of the SetupAttempt that generated this PaymentMethod, if any. */ - setup_attempt?: (Partial & Partial) | null; - }; + setup_attempt?: (Partial & Partial) | null + } /** * PaymentFlowsSetupIntentSetupAttempt * @description A SetupAttempt describes one attempted confirmation of a SetupIntent, @@ -12409,100 +12254,96 @@ export interface components { */ setup_attempt: { /** @description 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?: (Partial & Partial) | null; + application?: (Partial & Partial) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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?: - | (Partial & - Partial & - Partial) - | null; + customer?: (Partial & Partial & Partial) | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "setup_attempt"; + object: 'setup_attempt' /** @description 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?: (Partial & Partial) | null; + on_behalf_of?: (Partial & Partial) | null /** @description ID of the payment method used with this SetupAttempt. */ - payment_method: Partial & Partial; - payment_method_details: components["schemas"]["setup_attempt_payment_method_details"]; + payment_method: Partial & Partial + payment_method_details: components['schemas']['setup_attempt_payment_method_details'] /** @description The error encountered during this attempt to confirm the SetupIntent, if any. */ - setup_error?: Partial | null; + setup_error?: Partial | null /** @description ID of the SetupIntent that this attempt belongs to. */ - setup_intent: Partial & Partial; + setup_intent: Partial & Partial /** @description Status of this SetupAttempt, one of `requires_confirmation`, `requires_action`, `processing`, `succeeded`, `failed`, or `abandoned`. */ - status: string; + status: string /** @description 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: string; - }; + usage: string + } /** SetupAttemptPaymentMethodDetails */ setup_attempt_payment_method_details: { - acss_debit?: components["schemas"]["setup_attempt_payment_method_details_acss_debit"]; - au_becs_debit?: components["schemas"]["setup_attempt_payment_method_details_au_becs_debit"]; - bacs_debit?: components["schemas"]["setup_attempt_payment_method_details_bacs_debit"]; - bancontact?: components["schemas"]["setup_attempt_payment_method_details_bancontact"]; - boleto?: components["schemas"]["setup_attempt_payment_method_details_boleto"]; - card?: components["schemas"]["setup_attempt_payment_method_details_card"]; - card_present?: components["schemas"]["setup_attempt_payment_method_details_card_present"]; - ideal?: components["schemas"]["setup_attempt_payment_method_details_ideal"]; - sepa_debit?: components["schemas"]["setup_attempt_payment_method_details_sepa_debit"]; - sofort?: components["schemas"]["setup_attempt_payment_method_details_sofort"]; + acss_debit?: components['schemas']['setup_attempt_payment_method_details_acss_debit'] + au_becs_debit?: components['schemas']['setup_attempt_payment_method_details_au_becs_debit'] + bacs_debit?: components['schemas']['setup_attempt_payment_method_details_bacs_debit'] + bancontact?: components['schemas']['setup_attempt_payment_method_details_bancontact'] + boleto?: components['schemas']['setup_attempt_payment_method_details_boleto'] + card?: components['schemas']['setup_attempt_payment_method_details_card'] + card_present?: components['schemas']['setup_attempt_payment_method_details_card_present'] + ideal?: components['schemas']['setup_attempt_payment_method_details_ideal'] + sepa_debit?: components['schemas']['setup_attempt_payment_method_details_sepa_debit'] + sofort?: components['schemas']['setup_attempt_payment_method_details_sofort'] /** @description 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: string; - }; + type: string + } /** setup_attempt_payment_method_details_acss_debit */ - setup_attempt_payment_method_details_acss_debit: { [key: string]: unknown }; + setup_attempt_payment_method_details_acss_debit: { [key: string]: unknown } /** setup_attempt_payment_method_details_au_becs_debit */ - setup_attempt_payment_method_details_au_becs_debit: { [key: string]: unknown }; + setup_attempt_payment_method_details_au_becs_debit: { [key: string]: unknown } /** setup_attempt_payment_method_details_bacs_debit */ - setup_attempt_payment_method_details_bacs_debit: { [key: string]: unknown }; + setup_attempt_payment_method_details_bacs_debit: { [key: string]: unknown } /** setup_attempt_payment_method_details_bancontact */ setup_attempt_payment_method_details_bancontact: { /** @description Bank code of bank associated with the bank account. */ - bank_code?: string | null; + bank_code?: string | null /** @description Name of the bank associated with the bank account. */ - bank_name?: string | null; + bank_name?: string | null /** @description Bank Identifier Code of the bank associated with the bank account. */ - bic?: string | null; + bic?: string | null /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ - generated_sepa_debit?: (Partial & Partial) | null; + generated_sepa_debit?: (Partial & Partial) | null /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ - generated_sepa_debit_mandate?: (Partial & Partial) | null; + generated_sepa_debit_mandate?: (Partial & Partial) | null /** @description Last four characters of the IBAN. */ - iban_last4?: string | null; + iban_last4?: string | null /** * @description Preferred language of the Bancontact authorization page that the customer is redirected to. * Can be one of `en`, `de`, `fr`, or `nl` * @enum {string|null} */ - preferred_language?: ("de" | "en" | "fr" | "nl") | null; + preferred_language?: ('de' | 'en' | 'fr' | 'nl') | null /** * @description Owner's verified full name. Values are verified or provided by Bancontact directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - verified_name?: string | null; - }; + verified_name?: string | null + } /** setup_attempt_payment_method_details_boleto */ - setup_attempt_payment_method_details_boleto: { [key: string]: unknown }; + setup_attempt_payment_method_details_boleto: { [key: string]: unknown } /** setup_attempt_payment_method_details_card */ setup_attempt_payment_method_details_card: { /** @description Populated if this authorization used 3D Secure authentication. */ - three_d_secure?: Partial | null; - }; + three_d_secure?: Partial | null + } /** setup_attempt_payment_method_details_card_present */ setup_attempt_payment_method_details_card_present: { /** @description The ID of the Card PaymentMethod which was generated by this SetupAttempt. */ - generated_card?: (Partial & Partial) | null; - }; + generated_card?: (Partial & Partial) | null + } /** setup_attempt_payment_method_details_ideal */ setup_attempt_payment_method_details_ideal: { /** @@ -12511,82 +12352,82 @@ export interface components { */ bank?: | ( - | "abn_amro" - | "asn_bank" - | "bunq" - | "handelsbanken" - | "ing" - | "knab" - | "moneyou" - | "rabobank" - | "regiobank" - | "revolut" - | "sns_bank" - | "triodos_bank" - | "van_lanschot" + | 'abn_amro' + | 'asn_bank' + | 'bunq' + | 'handelsbanken' + | 'ing' + | 'knab' + | 'moneyou' + | 'rabobank' + | 'regiobank' + | 'revolut' + | 'sns_bank' + | 'triodos_bank' + | 'van_lanschot' ) - | null; + | null /** * @description The Bank Identifier Code of the customer's bank. * @enum {string|null} */ bic?: | ( - | "ABNANL2A" - | "ASNBNL21" - | "BUNQNL2A" - | "FVLBNL22" - | "HANDNL2A" - | "INGBNL2A" - | "KNABNL2H" - | "MOYONL21" - | "RABONL2U" - | "RBRBNL21" - | "REVOLT21" - | "SNSBNL2A" - | "TRIONL2U" + | 'ABNANL2A' + | 'ASNBNL21' + | 'BUNQNL2A' + | 'FVLBNL22' + | 'HANDNL2A' + | 'INGBNL2A' + | 'KNABNL2H' + | 'MOYONL21' + | 'RABONL2U' + | 'RBRBNL21' + | 'REVOLT21' + | 'SNSBNL2A' + | 'TRIONL2U' ) - | null; + | null /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ - generated_sepa_debit?: (Partial & Partial) | null; + generated_sepa_debit?: (Partial & Partial) | null /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ - generated_sepa_debit_mandate?: (Partial & Partial) | null; + generated_sepa_debit_mandate?: (Partial & Partial) | null /** @description Last four characters of the IBAN. */ - iban_last4?: string | null; + iban_last4?: string | null /** * @description Owner's verified full name. Values are verified or provided by iDEAL directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - verified_name?: string | null; - }; + verified_name?: string | null + } /** setup_attempt_payment_method_details_sepa_debit */ - setup_attempt_payment_method_details_sepa_debit: { [key: string]: unknown }; + setup_attempt_payment_method_details_sepa_debit: { [key: string]: unknown } /** setup_attempt_payment_method_details_sofort */ setup_attempt_payment_method_details_sofort: { /** @description Bank code of bank associated with the bank account. */ - bank_code?: string | null; + bank_code?: string | null /** @description Name of the bank associated with the bank account. */ - bank_name?: string | null; + bank_name?: string | null /** @description Bank Identifier Code of the bank associated with the bank account. */ - bic?: string | null; + bic?: string | null /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ - generated_sepa_debit?: (Partial & Partial) | null; + generated_sepa_debit?: (Partial & Partial) | null /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ - generated_sepa_debit_mandate?: (Partial & Partial) | null; + generated_sepa_debit_mandate?: (Partial & Partial) | null /** @description Last four characters of the IBAN. */ - iban_last4?: string | null; + iban_last4?: string | null /** * @description Preferred language of the Sofort authorization page that the customer is redirected to. * Can be one of `en`, `de`, `fr`, or `nl` * @enum {string|null} */ - preferred_language?: ("de" | "en" | "fr" | "nl") | null; + preferred_language?: ('de' | 'en' | 'fr' | 'nl') | null /** * @description Owner's verified full name. Values are verified or provided by Sofort directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - verified_name?: string | null; - }; + verified_name?: string | null + } /** * SetupIntent * @description A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. @@ -12614,186 +12455,176 @@ export interface components { */ setup_intent: { /** @description ID of the Connect application that created the SetupIntent. */ - application?: (Partial & Partial) | null; + application?: (Partial & Partial) | null /** * @description Reason for cancellation of this SetupIntent, one of `abandoned`, `requested_by_customer`, or `duplicate`. * @enum {string|null} */ - cancellation_reason?: ("abandoned" | "duplicate" | "requested_by_customer") | null; + cancellation_reason?: ('abandoned' | 'duplicate' | 'requested_by_customer') | null /** * @description The client secret of this SetupIntent. Used for client-side retrieval using a publishable key. * * The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, embedded in URLs, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret. */ - client_secret?: string | null; + client_secret?: string | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** * @description ID of the Customer this SetupIntent belongs to, if one exists. * * If 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. */ - customer?: - | (Partial & - Partial & - Partial) - | null; + customer?: (Partial & Partial & Partial) | null /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The error encountered in the previous SetupIntent confirmation. */ - last_setup_error?: Partial | null; + last_setup_error?: Partial | null /** @description The most recent SetupAttempt for this SetupIntent. */ - latest_attempt?: (Partial & Partial) | null; + latest_attempt?: (Partial & Partial) | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description ID of the multi use Mandate generated by the SetupIntent. */ - mandate?: (Partial & Partial) | null; + mandate?: (Partial & Partial) | null /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** @description If present, this property tells you what actions you need to take in order for your customer to continue payment setup. */ - next_action?: Partial | null; + next_action?: Partial | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "setup_intent"; + object: 'setup_intent' /** @description The account (if any) for which the setup is intended. */ - on_behalf_of?: (Partial & Partial) | null; + on_behalf_of?: (Partial & Partial) | null /** @description ID of the payment method used with this SetupIntent. */ - payment_method?: (Partial & Partial) | null; + payment_method?: (Partial & Partial) | null /** @description Payment-method-specific configuration for this SetupIntent. */ - payment_method_options?: Partial | null; + payment_method_options?: Partial | null /** @description The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. */ - payment_method_types: string[]; + payment_method_types: string[] /** @description ID of the single_use Mandate generated by the SetupIntent. */ - single_use_mandate?: (Partial & Partial) | null; + single_use_mandate?: (Partial & Partial) | null /** * @description [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`. * @enum {string} */ - status: - | "canceled" - | "processing" - | "requires_action" - | "requires_confirmation" - | "requires_payment_method" - | "succeeded"; + status: 'canceled' | 'processing' | 'requires_action' | 'requires_confirmation' | 'requires_payment_method' | 'succeeded' /** * @description Indicates how the payment method is intended to be used in the future. * * Use `on_session` if you intend to only reuse the payment method when the customer is in your checkout flow. Use `off_session` if your customer may or may not be in your checkout flow. If not provided, this value defaults to `off_session`. */ - usage: string; - }; + usage: string + } /** SetupIntentNextAction */ setup_intent_next_action: { - redirect_to_url?: components["schemas"]["setup_intent_next_action_redirect_to_url"]; + redirect_to_url?: components['schemas']['setup_intent_next_action_redirect_to_url'] /** @description 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: string; + type: string /** @description 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?: { [key: string]: unknown }; - verify_with_microdeposits?: components["schemas"]["setup_intent_next_action_verify_with_microdeposits"]; - }; + use_stripe_sdk?: { [key: string]: unknown } + verify_with_microdeposits?: components['schemas']['setup_intent_next_action_verify_with_microdeposits'] + } /** SetupIntentNextActionRedirectToUrl */ setup_intent_next_action_redirect_to_url: { /** @description If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion. */ - return_url?: string | null; + return_url?: string | null /** @description The URL you must redirect your customer to in order to authenticate. */ - url?: string | null; - }; + url?: string | null + } /** SetupIntentNextActionVerifyWithMicrodeposits */ setup_intent_next_action_verify_with_microdeposits: { /** * Format: unix-time * @description The timestamp when the microdeposits are expected to land. */ - arrival_date: number; + arrival_date: number /** @description The URL for the hosted verification page, which allows customers to verify their bank account. */ - hosted_verification_url: string; - }; + hosted_verification_url: string + } /** SetupIntentPaymentMethodOptions */ setup_intent_payment_method_options: { - acss_debit?: components["schemas"]["setup_intent_payment_method_options_acss_debit"]; - card?: components["schemas"]["setup_intent_payment_method_options_card"]; - sepa_debit?: components["schemas"]["setup_intent_payment_method_options_sepa_debit"]; - }; + acss_debit?: components['schemas']['setup_intent_payment_method_options_acss_debit'] + card?: components['schemas']['setup_intent_payment_method_options_card'] + sepa_debit?: components['schemas']['setup_intent_payment_method_options_sepa_debit'] + } /** setup_intent_payment_method_options_acss_debit */ setup_intent_payment_method_options_acss_debit: { /** * @description Currency supported by the bank account * @enum {string|null} */ - currency?: ("cad" | "usd") | null; - mandate_options?: components["schemas"]["setup_intent_payment_method_options_mandate_options_acss_debit"]; + currency?: ('cad' | 'usd') | null + mandate_options?: components['schemas']['setup_intent_payment_method_options_mandate_options_acss_debit'] /** * @description Bank account verification method. * @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; - }; + verification_method?: 'automatic' | 'instant' | 'microdeposits' + } /** setup_intent_payment_method_options_card */ setup_intent_payment_method_options_card: { /** * @description 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. Permitted values include: `automatic` or `any`. If not provided, defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. * @enum {string|null} */ - request_three_d_secure?: ("any" | "automatic" | "challenge_only") | null; - }; + request_three_d_secure?: ('any' | 'automatic' | 'challenge_only') | null + } /** setup_intent_payment_method_options_mandate_options_acss_debit */ setup_intent_payment_method_options_mandate_options_acss_debit: { /** @description A URL for custom mandate text */ - custom_mandate_url?: string; + custom_mandate_url?: string /** @description List of Stripe products where this mandate can be selected automatically. */ - default_for?: ("invoice" | "subscription")[]; + default_for?: ('invoice' | 'subscription')[] /** @description Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. */ - interval_description?: string | null; + interval_description?: string | null /** * @description Payment schedule for the mandate. * @enum {string|null} */ - payment_schedule?: ("combined" | "interval" | "sporadic") | null; + payment_schedule?: ('combined' | 'interval' | 'sporadic') | null /** * @description Transaction type of the mandate. * @enum {string|null} */ - transaction_type?: ("business" | "personal") | null; - }; + transaction_type?: ('business' | 'personal') | null + } /** setup_intent_payment_method_options_mandate_options_sepa_debit */ - setup_intent_payment_method_options_mandate_options_sepa_debit: { [key: string]: unknown }; + setup_intent_payment_method_options_mandate_options_sepa_debit: { [key: string]: unknown } /** setup_intent_payment_method_options_sepa_debit */ setup_intent_payment_method_options_sepa_debit: { - mandate_options?: components["schemas"]["setup_intent_payment_method_options_mandate_options_sepa_debit"]; - }; + mandate_options?: components['schemas']['setup_intent_payment_method_options_mandate_options_sepa_debit'] + } /** Shipping */ shipping: { - address?: components["schemas"]["address"]; + address?: components['schemas']['address'] /** @description The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. */ - carrier?: string | null; + carrier?: string | null /** @description Recipient name. */ - name?: string | null; + name?: string | null /** @description Recipient phone (including extension). */ - phone?: string | null; + phone?: string | null /** @description 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?: string | null; - }; + tracking_number?: string | null + } /** ShippingMethod */ shipping_method: { /** @description 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 line item. */ - amount: number; + amount: number /** @description 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: string; + currency: string /** @description The estimated delivery date for the given shipping method. Can be either a specific date or a range. */ - delivery_estimate?: Partial | null; + delivery_estimate?: Partial | null /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description: string; + description: string /** @description Unique identifier for the object. */ - id: string; - }; + id: string + } /** * ShippingRate * @description Shipping rates describe the price of shipping presented to your customers and can be @@ -12801,70 +12632,70 @@ export interface components { */ shipping_rate: { /** @description Whether the shipping rate can be used for new purchases. Defaults to `true`. */ - active: boolean; + active: boolean /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions. */ - delivery_estimate?: Partial | null; + delivery_estimate?: Partial | null /** @description The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions. */ - display_name?: string | null; - fixed_amount?: components["schemas"]["shipping_rate_fixed_amount"]; + display_name?: string | null + fixed_amount?: components['schemas']['shipping_rate_fixed_amount'] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "shipping_rate"; + object: 'shipping_rate' /** * @description Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. * @enum {string|null} */ - tax_behavior?: ("exclusive" | "inclusive" | "unspecified") | null; + tax_behavior?: ('exclusive' | 'inclusive' | 'unspecified') | null /** @description A [tax code](https://stripe.com/docs/tax/tax-codes) ID. The Shipping tax code is `txcd_92010001`. */ - tax_code?: (Partial & Partial) | null; + tax_code?: (Partial & Partial) | null /** * @description The type of calculation to use on the shipping rate. Can only be `fixed_amount` for now. * @enum {string} */ - type: "fixed_amount"; - }; + type: 'fixed_amount' + } /** ShippingRateDeliveryEstimate */ shipping_rate_delivery_estimate: { /** @description The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite. */ - maximum?: Partial | null; + maximum?: Partial | null /** @description The lower bound of the estimated range. If empty, represents no lower bound. */ - minimum?: Partial | null; - }; + minimum?: Partial | null + } /** ShippingRateDeliveryEstimateBound */ shipping_rate_delivery_estimate_bound: { /** * @description A unit of time. * @enum {string} */ - unit: "business_day" | "day" | "hour" | "month" | "week"; + unit: 'business_day' | 'day' | 'hour' | 'month' | 'week' /** @description Must be greater than 0. */ - value: number; - }; + value: number + } /** ShippingRateFixedAmount */ shipping_rate_fixed_amount: { /** @description A non-negative integer in cents representing how much to charge. */ - amount: number; + amount: number /** @description 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: string; - }; + currency: string + } /** SigmaScheduledQueryRunError */ sigma_scheduled_query_run_error: { /** @description Information about the run failure. */ - message: string; - }; + message: string + } /** * Sku * @description Stores representations of [stock keeping units](http://en.wikipedia.org/wiki/Stock_keeping_unit). @@ -12878,51 +12709,51 @@ export interface components { */ sku: { /** @description Whether the SKU is available for purchase. */ - active: boolean; + active: boolean /** @description A dictionary of attributes and values for the attributes defined by the product. If, for example, a product's attributes are `["size", "gender"]`, a valid SKU has the following dictionary of attributes: `{"size": "Medium", "gender": "Unisex"}`. */ - attributes: { [key: string]: string }; + attributes: { [key: string]: string } /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The URL of an image for this SKU, meant to be displayable to the customer. */ - image?: string | null; - inventory: components["schemas"]["sku_inventory"]; + image?: string | null + inventory: components['schemas']['sku_inventory'] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "sku"; + object: 'sku' /** @description The dimensions of this SKU for shipping purposes. */ - package_dimensions?: Partial | null; + package_dimensions?: Partial | null /** @description The cost of the item as a positive integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a zero-decimal currency). */ - price: number; + price: number /** @description The ID of the product this SKU is associated with. The product must be currently active. */ - product: Partial & Partial; + product: Partial & Partial /** * Format: unix-time * @description Time at which the object was last updated. Measured in seconds since the Unix epoch. */ - updated: number; - }; + updated: number + } /** SKUInventory */ sku_inventory: { /** @description The count of inventory available. Will be present if and only if `type` is `finite`. */ - quantity?: number | null; + quantity?: number | null /** @description Inventory type. Possible values are `finite`, `bucket` (not quantified), and `infinite`. */ - type: string; + type: string /** @description An indicator of the inventory available. Possible values are `in_stock`, `limited`, and `out_of_stock`. Will be present if and only if `type` is `bucket`. */ - value?: string | null; - }; + value?: string | null + } /** * Source * @description `Source` objects allow you to accept a variety of payment methods. They @@ -12933,93 +12764,93 @@ export interface components { * Related guides: [Sources API](https://stripe.com/docs/sources) and [Sources & Customers](https://stripe.com/docs/sources/customers). */ source: { - ach_credit_transfer?: components["schemas"]["source_type_ach_credit_transfer"]; - ach_debit?: components["schemas"]["source_type_ach_debit"]; - acss_debit?: components["schemas"]["source_type_acss_debit"]; - alipay?: components["schemas"]["source_type_alipay"]; + ach_credit_transfer?: components['schemas']['source_type_ach_credit_transfer'] + ach_debit?: components['schemas']['source_type_ach_debit'] + acss_debit?: components['schemas']['source_type_acss_debit'] + alipay?: components['schemas']['source_type_alipay'] /** @description 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?: number | null; - au_becs_debit?: components["schemas"]["source_type_au_becs_debit"]; - bancontact?: components["schemas"]["source_type_bancontact"]; - card?: components["schemas"]["source_type_card"]; - card_present?: components["schemas"]["source_type_card_present"]; + amount?: number | null + au_becs_debit?: components['schemas']['source_type_au_becs_debit'] + bancontact?: components['schemas']['source_type_bancontact'] + card?: components['schemas']['source_type_card'] + card_present?: components['schemas']['source_type_card_present'] /** @description The client secret of the source. Used for client-side retrieval using a publishable key. */ - client_secret: string; - code_verification?: components["schemas"]["source_code_verification_flow"]; + client_secret: string + code_verification?: components['schemas']['source_code_verification_flow'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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?: string | null; + currency?: string | null /** @description 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?: string; - eps?: components["schemas"]["source_type_eps"]; + customer?: string + eps?: components['schemas']['source_type_eps'] /** @description The authentication `flow` of the source. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`. */ - flow: string; - giropay?: components["schemas"]["source_type_giropay"]; + flow: string + giropay?: components['schemas']['source_type_giropay'] /** @description Unique identifier for the object. */ - id: string; - ideal?: components["schemas"]["source_type_ideal"]; - klarna?: components["schemas"]["source_type_klarna"]; + id: string + ideal?: components['schemas']['source_type_ideal'] + klarna?: components['schemas']['source_type_klarna'] /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; - multibanco?: components["schemas"]["source_type_multibanco"]; + metadata?: { [key: string]: string } | null + multibanco?: components['schemas']['source_type_multibanco'] /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "source"; + object: 'source' /** @description Information about the owner of the payment instrument that may be used or required by particular source types. */ - owner?: Partial | null; - p24?: components["schemas"]["source_type_p24"]; - receiver?: components["schemas"]["source_receiver_flow"]; - redirect?: components["schemas"]["source_redirect_flow"]; - sepa_debit?: components["schemas"]["source_type_sepa_debit"]; - sofort?: components["schemas"]["source_type_sofort"]; - source_order?: components["schemas"]["source_order"]; + owner?: Partial | null + p24?: components['schemas']['source_type_p24'] + receiver?: components['schemas']['source_receiver_flow'] + redirect?: components['schemas']['source_redirect_flow'] + sepa_debit?: components['schemas']['source_type_sepa_debit'] + sofort?: components['schemas']['source_type_sofort'] + source_order?: components['schemas']['source_order'] /** @description Extra information about a source. This will appear on your customer's statement every time you charge the source. */ - statement_descriptor?: string | null; + statement_descriptor?: string | null /** @description The status of the source, one of `canceled`, `chargeable`, `consumed`, `failed`, or `pending`. Only `chargeable` sources can be used to create a charge. */ - status: string; - three_d_secure?: components["schemas"]["source_type_three_d_secure"]; + status: string + three_d_secure?: components['schemas']['source_type_three_d_secure'] /** * @description 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. * @enum {string} */ type: - | "ach_credit_transfer" - | "ach_debit" - | "acss_debit" - | "alipay" - | "au_becs_debit" - | "bancontact" - | "card" - | "card_present" - | "eps" - | "giropay" - | "ideal" - | "klarna" - | "multibanco" - | "p24" - | "sepa_debit" - | "sofort" - | "three_d_secure" - | "wechat"; + | 'ach_credit_transfer' + | 'ach_debit' + | 'acss_debit' + | 'alipay' + | 'au_becs_debit' + | 'bancontact' + | 'card' + | 'card_present' + | 'eps' + | 'giropay' + | 'ideal' + | 'klarna' + | 'multibanco' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'three_d_secure' + | 'wechat' /** @description 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?: string | null; - wechat?: components["schemas"]["source_type_wechat"]; - }; + usage?: string | null + wechat?: components['schemas']['source_type_wechat'] + } /** SourceCodeVerificationFlow */ source_code_verification_flow: { /** @description The number of attempts remaining to authenticate the source object with a verification code. */ - attempts_remaining: number; + attempts_remaining: number /** @description 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: string; - }; + status: string + } /** * SourceMandateNotification * @description Source mandate notifications should be created when a notification related to @@ -13027,124 +12858,124 @@ export interface components { * deliver an email to the customer. */ source_mandate_notification: { - acss_debit?: components["schemas"]["source_mandate_notification_acss_debit_data"]; + acss_debit?: components['schemas']['source_mandate_notification_acss_debit_data'] /** @description 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?: number | null; - bacs_debit?: components["schemas"]["source_mandate_notification_bacs_debit_data"]; + amount?: number | null + bacs_debit?: components['schemas']['source_mandate_notification_bacs_debit_data'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "source_mandate_notification"; + object: 'source_mandate_notification' /** @description The reason of the mandate notification. Valid reasons are `mandate_confirmed` or `debit_initiated`. */ - reason: string; - sepa_debit?: components["schemas"]["source_mandate_notification_sepa_debit_data"]; - source: components["schemas"]["source"]; + reason: string + sepa_debit?: components['schemas']['source_mandate_notification_sepa_debit_data'] + source: components['schemas']['source'] /** @description The status of the mandate notification. Valid statuses are `pending` or `submitted`. */ - status: string; + status: string /** @description 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: string; - }; + type: string + } /** SourceMandateNotificationAcssDebitData */ source_mandate_notification_acss_debit_data: { /** @description The statement descriptor associate with the debit. */ - statement_descriptor?: string; - }; + statement_descriptor?: string + } /** SourceMandateNotificationBacsDebitData */ source_mandate_notification_bacs_debit_data: { /** @description Last 4 digits of the account number associated with the debit. */ - last4?: string; - }; + last4?: string + } /** SourceMandateNotificationSepaDebitData */ source_mandate_notification_sepa_debit_data: { /** @description SEPA creditor ID. */ - creditor_identifier?: string; + creditor_identifier?: string /** @description Last 4 digits of the account number associated with the debit. */ - last4?: string; + last4?: string /** @description Mandate reference associated with the debit. */ - mandate_reference?: string; - }; + mandate_reference?: string + } /** SourceOrder */ source_order: { /** @description 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: number; + amount: number /** @description 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: string; + currency: string /** @description The email address of the customer placing the order. */ - email?: string; + email?: string /** @description List of items constituting the order. */ - items?: components["schemas"]["source_order_item"][] | null; - shipping?: components["schemas"]["shipping"]; - }; + items?: components['schemas']['source_order_item'][] | null + shipping?: components['schemas']['shipping'] + } /** SourceOrderItem */ source_order_item: { /** @description The amount (price) for this order item. */ - amount?: number | null; + amount?: number | null /** @description This currency of this order item. Required when `amount` is present. */ - currency?: string | null; + currency?: string | null /** @description Human-readable description for this order item. */ - description?: string | null; + description?: string | null /** @description The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a SKU). */ - parent?: string | null; + parent?: string | null /** @description The quantity of this order item. When type is `sku`, this is the number of instances of the SKU to be ordered. */ - quantity?: number; + quantity?: number /** @description The type of this order item. Must be `sku`, `tax`, or `shipping`. */ - type?: string | null; - }; + type?: string | null + } /** SourceOwner */ source_owner: { /** @description Owner's address. */ - address?: Partial | null; + address?: Partial | null /** @description Owner's email address. */ - email?: string | null; + email?: string | null /** @description Owner's full name. */ - name?: string | null; + name?: string | null /** @description Owner's phone number (including extension). */ - phone?: string | null; + phone?: string | null /** @description 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?: Partial | null; + verified_address?: Partial | null /** @description 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?: string | null; + verified_email?: string | null /** @description 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?: string | null; + verified_name?: string | null /** @description 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?: string | null; - }; + verified_phone?: string | null + } /** SourceReceiverFlow */ source_receiver_flow: { /** @description The address of the receiver source. This is the value that should be communicated to the customer to send their funds to. */ - address?: string | null; + address?: string | null /** @description 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: number; + amount_charged: number /** @description 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: number; + amount_received: number /** @description The total amount that was returned to the customer. The amount returned is expressed in the source's currency. */ - amount_returned: number; + amount_returned: number /** @description Type of refund attribute method, one of `email`, `manual`, or `none`. */ - refund_attributes_method: string; + refund_attributes_method: string /** @description Type of refund attribute status, one of `missing`, `requested`, or `available`. */ - refund_attributes_status: string; - }; + refund_attributes_status: string + } /** SourceRedirectFlow */ source_redirect_flow: { /** @description 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?: string | null; + failure_reason?: string | null /** @description The URL you provide to redirect the customer to after they authenticated their payment. */ - return_url: string; + return_url: string /** @description 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: string; + status: string /** @description The URL provided to you to redirect a customer to as part of a `redirect` authentication flow. */ - url: string; - }; + url: string + } /** * SourceTransaction * @description Some payment methods have no required amount that a customer must send. @@ -13153,325 +12984,325 @@ export interface components { * transactions. */ source_transaction: { - ach_credit_transfer?: components["schemas"]["source_transaction_ach_credit_transfer_data"]; + ach_credit_transfer?: components['schemas']['source_transaction_ach_credit_transfer_data'] /** @description 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: number; - chf_credit_transfer?: components["schemas"]["source_transaction_chf_credit_transfer_data"]; + amount: number + chf_credit_transfer?: components['schemas']['source_transaction_chf_credit_transfer_data'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; - gbp_credit_transfer?: components["schemas"]["source_transaction_gbp_credit_transfer_data"]; + currency: string + gbp_credit_transfer?: components['schemas']['source_transaction_gbp_credit_transfer_data'] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "source_transaction"; - paper_check?: components["schemas"]["source_transaction_paper_check_data"]; - sepa_credit_transfer?: components["schemas"]["source_transaction_sepa_credit_transfer_data"]; + object: 'source_transaction' + paper_check?: components['schemas']['source_transaction_paper_check_data'] + sepa_credit_transfer?: components['schemas']['source_transaction_sepa_credit_transfer_data'] /** @description The ID of the source this transaction is attached to. */ - source: string; + source: string /** @description The status of the transaction, one of `succeeded`, `pending`, or `failed`. */ - status: string; + status: string /** * @description The type of source this transaction is attached to. * @enum {string} */ type: - | "ach_credit_transfer" - | "ach_debit" - | "alipay" - | "bancontact" - | "card" - | "card_present" - | "eps" - | "giropay" - | "ideal" - | "klarna" - | "multibanco" - | "p24" - | "sepa_debit" - | "sofort" - | "three_d_secure" - | "wechat"; - }; + | 'ach_credit_transfer' + | 'ach_debit' + | 'alipay' + | 'bancontact' + | 'card' + | 'card_present' + | 'eps' + | 'giropay' + | 'ideal' + | 'klarna' + | 'multibanco' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'three_d_secure' + | 'wechat' + } /** SourceTransactionAchCreditTransferData */ source_transaction_ach_credit_transfer_data: { /** @description Customer data associated with the transfer. */ - customer_data?: string; + customer_data?: string /** @description Bank account fingerprint associated with the transfer. */ - fingerprint?: string; + fingerprint?: string /** @description Last 4 digits of the account number associated with the transfer. */ - last4?: string; + last4?: string /** @description Routing number associated with the transfer. */ - routing_number?: string; - }; + routing_number?: string + } /** SourceTransactionChfCreditTransferData */ source_transaction_chf_credit_transfer_data: { /** @description Reference associated with the transfer. */ - reference?: string; + reference?: string /** @description Sender's country address. */ - sender_address_country?: string; + sender_address_country?: string /** @description Sender's line 1 address. */ - sender_address_line1?: string; + sender_address_line1?: string /** @description Sender's bank account IBAN. */ - sender_iban?: string; + sender_iban?: string /** @description Sender's name. */ - sender_name?: string; - }; + sender_name?: string + } /** SourceTransactionGbpCreditTransferData */ source_transaction_gbp_credit_transfer_data: { /** @description Bank account fingerprint associated with the Stripe owned bank account receiving the transfer. */ - fingerprint?: string; + fingerprint?: string /** @description 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?: string; + funding_method?: string /** @description Last 4 digits of sender account number associated with the transfer. */ - last4?: string; + last4?: string /** @description Sender entered arbitrary information about the transfer. */ - reference?: string; + reference?: string /** @description Sender account number associated with the transfer. */ - sender_account_number?: string; + sender_account_number?: string /** @description Sender name associated with the transfer. */ - sender_name?: string; + sender_name?: string /** @description Sender sort code associated with the transfer. */ - sender_sort_code?: string; - }; + sender_sort_code?: string + } /** SourceTransactionPaperCheckData */ source_transaction_paper_check_data: { /** @description Time at which the deposited funds will be available for use. Measured in seconds since the Unix epoch. */ - available_at?: string; + available_at?: string /** @description Comma-separated list of invoice IDs associated with the paper check. */ - invoices?: string; - }; + invoices?: string + } /** SourceTransactionSepaCreditTransferData */ source_transaction_sepa_credit_transfer_data: { /** @description Reference associated with the transfer. */ - reference?: string; + reference?: string /** @description Sender's bank account IBAN. */ - sender_iban?: string; + sender_iban?: string /** @description Sender's name. */ - sender_name?: string; - }; + sender_name?: string + } source_type_ach_credit_transfer: { - account_number?: string | null; - bank_name?: string | null; - fingerprint?: string | null; - refund_account_holder_name?: string | null; - refund_account_holder_type?: string | null; - refund_routing_number?: string | null; - routing_number?: string | null; - swift_code?: string | null; - }; + account_number?: string | null + bank_name?: string | null + fingerprint?: string | null + refund_account_holder_name?: string | null + refund_account_holder_type?: string | null + refund_routing_number?: string | null + routing_number?: string | null + swift_code?: string | null + } source_type_ach_debit: { - bank_name?: string | null; - country?: string | null; - fingerprint?: string | null; - last4?: string | null; - routing_number?: string | null; - type?: string | null; - }; + bank_name?: string | null + country?: string | null + fingerprint?: string | null + last4?: string | null + routing_number?: string | null + type?: string | null + } source_type_acss_debit: { - bank_address_city?: string | null; - bank_address_line_1?: string | null; - bank_address_line_2?: string | null; - bank_address_postal_code?: string | null; - bank_name?: string | null; - category?: string | null; - country?: string | null; - fingerprint?: string | null; - last4?: string | null; - routing_number?: string | null; - }; + bank_address_city?: string | null + bank_address_line_1?: string | null + bank_address_line_2?: string | null + bank_address_postal_code?: string | null + bank_name?: string | null + category?: string | null + country?: string | null + fingerprint?: string | null + last4?: string | null + routing_number?: string | null + } source_type_alipay: { - data_string?: string | null; - native_url?: string | null; - statement_descriptor?: string | null; - }; + data_string?: string | null + native_url?: string | null + statement_descriptor?: string | null + } source_type_au_becs_debit: { - bsb_number?: string | null; - fingerprint?: string | null; - last4?: string | null; - }; + bsb_number?: string | null + fingerprint?: string | null + last4?: string | null + } source_type_bancontact: { - bank_code?: string | null; - bank_name?: string | null; - bic?: string | null; - iban_last4?: string | null; - preferred_language?: string | null; - statement_descriptor?: string | null; - }; + bank_code?: string | null + bank_name?: string | null + bic?: string | null + iban_last4?: string | null + preferred_language?: string | null + statement_descriptor?: string | null + } source_type_card: { - address_line1_check?: string | null; - address_zip_check?: string | null; - brand?: string | null; - country?: string | null; - cvc_check?: string | null; - dynamic_last4?: string | null; - exp_month?: number | null; - exp_year?: number | null; - fingerprint?: string; - funding?: string | null; - last4?: string | null; - name?: string | null; - three_d_secure?: string; - tokenization_method?: string | null; - }; + address_line1_check?: string | null + address_zip_check?: string | null + brand?: string | null + country?: string | null + cvc_check?: string | null + dynamic_last4?: string | null + exp_month?: number | null + exp_year?: number | null + fingerprint?: string + funding?: string | null + last4?: string | null + name?: string | null + three_d_secure?: string + tokenization_method?: string | null + } source_type_card_present: { - application_cryptogram?: string; - application_preferred_name?: string; - authorization_code?: string | null; - authorization_response_code?: string; - brand?: string | null; - country?: string | null; - cvm_type?: string; - data_type?: string | null; - dedicated_file_name?: string; - emv_auth_data?: string; - evidence_customer_signature?: string | null; - evidence_transaction_certificate?: string | null; - exp_month?: number | null; - exp_year?: number | null; - fingerprint?: string; - funding?: string | null; - last4?: string | null; - pos_device_id?: string | null; - pos_entry_mode?: string; - read_method?: string | null; - reader?: string | null; - terminal_verification_results?: string; - transaction_status_information?: string; - }; + application_cryptogram?: string + application_preferred_name?: string + authorization_code?: string | null + authorization_response_code?: string + brand?: string | null + country?: string | null + cvm_type?: string + data_type?: string | null + dedicated_file_name?: string + emv_auth_data?: string + evidence_customer_signature?: string | null + evidence_transaction_certificate?: string | null + exp_month?: number | null + exp_year?: number | null + fingerprint?: string + funding?: string | null + last4?: string | null + pos_device_id?: string | null + pos_entry_mode?: string + read_method?: string | null + reader?: string | null + terminal_verification_results?: string + transaction_status_information?: string + } source_type_eps: { - reference?: string | null; - statement_descriptor?: string | null; - }; + reference?: string | null + statement_descriptor?: string | null + } source_type_giropay: { - bank_code?: string | null; - bank_name?: string | null; - bic?: string | null; - statement_descriptor?: string | null; - }; + bank_code?: string | null + bank_name?: string | null + bic?: string | null + statement_descriptor?: string | null + } source_type_ideal: { - bank?: string | null; - bic?: string | null; - iban_last4?: string | null; - statement_descriptor?: string | null; - }; + bank?: string | null + bic?: string | null + iban_last4?: string | null + statement_descriptor?: string | null + } source_type_klarna: { - background_image_url?: string; - client_token?: string | null; - first_name?: string; - last_name?: string; - locale?: string; - logo_url?: string; - page_title?: string; - pay_later_asset_urls_descriptive?: string; - pay_later_asset_urls_standard?: string; - pay_later_name?: string; - pay_later_redirect_url?: string; - pay_now_asset_urls_descriptive?: string; - pay_now_asset_urls_standard?: string; - pay_now_name?: string; - pay_now_redirect_url?: string; - pay_over_time_asset_urls_descriptive?: string; - pay_over_time_asset_urls_standard?: string; - pay_over_time_name?: string; - pay_over_time_redirect_url?: string; - payment_method_categories?: string; - purchase_country?: string; - purchase_type?: string; - redirect_url?: string; - shipping_delay?: number; - shipping_first_name?: string; - shipping_last_name?: string; - }; + background_image_url?: string + client_token?: string | null + first_name?: string + last_name?: string + locale?: string + logo_url?: string + page_title?: string + pay_later_asset_urls_descriptive?: string + pay_later_asset_urls_standard?: string + pay_later_name?: string + pay_later_redirect_url?: string + pay_now_asset_urls_descriptive?: string + pay_now_asset_urls_standard?: string + pay_now_name?: string + pay_now_redirect_url?: string + pay_over_time_asset_urls_descriptive?: string + pay_over_time_asset_urls_standard?: string + pay_over_time_name?: string + pay_over_time_redirect_url?: string + payment_method_categories?: string + purchase_country?: string + purchase_type?: string + redirect_url?: string + shipping_delay?: number + shipping_first_name?: string + shipping_last_name?: string + } source_type_multibanco: { - entity?: string | null; - reference?: string | null; - refund_account_holder_address_city?: string | null; - refund_account_holder_address_country?: string | null; - refund_account_holder_address_line1?: string | null; - refund_account_holder_address_line2?: string | null; - refund_account_holder_address_postal_code?: string | null; - refund_account_holder_address_state?: string | null; - refund_account_holder_name?: string | null; - refund_iban?: string | null; - }; + entity?: string | null + reference?: string | null + refund_account_holder_address_city?: string | null + refund_account_holder_address_country?: string | null + refund_account_holder_address_line1?: string | null + refund_account_holder_address_line2?: string | null + refund_account_holder_address_postal_code?: string | null + refund_account_holder_address_state?: string | null + refund_account_holder_name?: string | null + refund_iban?: string | null + } source_type_p24: { - reference?: string | null; - }; + reference?: string | null + } source_type_sepa_debit: { - bank_code?: string | null; - branch_code?: string | null; - country?: string | null; - fingerprint?: string | null; - last4?: string | null; - mandate_reference?: string | null; - mandate_url?: string | null; - }; + bank_code?: string | null + branch_code?: string | null + country?: string | null + fingerprint?: string | null + last4?: string | null + mandate_reference?: string | null + mandate_url?: string | null + } source_type_sofort: { - bank_code?: string | null; - bank_name?: string | null; - bic?: string | null; - country?: string | null; - iban_last4?: string | null; - preferred_language?: string | null; - statement_descriptor?: string | null; - }; + bank_code?: string | null + bank_name?: string | null + bic?: string | null + country?: string | null + iban_last4?: string | null + preferred_language?: string | null + statement_descriptor?: string | null + } source_type_three_d_secure: { - address_line1_check?: string | null; - address_zip_check?: string | null; - authenticated?: boolean | null; - brand?: string | null; - card?: string | null; - country?: string | null; - customer?: string | null; - cvc_check?: string | null; - dynamic_last4?: string | null; - exp_month?: number | null; - exp_year?: number | null; - fingerprint?: string; - funding?: string | null; - last4?: string | null; - name?: string | null; - three_d_secure?: string; - tokenization_method?: string | null; - }; + address_line1_check?: string | null + address_zip_check?: string | null + authenticated?: boolean | null + brand?: string | null + card?: string | null + country?: string | null + customer?: string | null + cvc_check?: string | null + dynamic_last4?: string | null + exp_month?: number | null + exp_year?: number | null + fingerprint?: string + funding?: string | null + last4?: string | null + name?: string | null + three_d_secure?: string + tokenization_method?: string | null + } source_type_wechat: { - prepay_id?: string; - qr_code_url?: string | null; - statement_descriptor?: string; - }; + prepay_id?: string + qr_code_url?: string | null + statement_descriptor?: string + } /** StatusTransitions */ status_transitions: { /** * Format: unix-time * @description The time that the order was canceled. */ - canceled?: number | null; + canceled?: number | null /** * Format: unix-time * @description The time that the order was fulfilled. */ - fulfiled?: number | null; + fulfiled?: number | null /** * Format: unix-time * @description The time that the order was paid. */ - paid?: number | null; + paid?: number | null /** * Format: unix-time * @description The time that the order was returned. */ - returned?: number | null; - }; + returned?: number | null + } /** * Subscription * @description Subscriptions allow you to charge a customer on a recurring basis. @@ -13480,127 +13311,123 @@ export interface components { */ subscription: { /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. */ - application_fee_percent?: number | null; - automatic_tax: components["schemas"]["subscription_automatic_tax"]; + application_fee_percent?: number | null + automatic_tax: components['schemas']['subscription_automatic_tax'] /** * Format: unix-time * @description Determines the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. */ - billing_cycle_anchor: number; + billing_cycle_anchor: number /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period */ - billing_thresholds?: Partial | null; + billing_thresholds?: Partial | null /** * Format: unix-time * @description A date in the future at which the subscription will automatically get canceled */ - cancel_at?: number | null; + cancel_at?: number | null /** @description If the subscription has been canceled with the `at_period_end` flag set to `true`, `cancel_at_period_end` on the subscription will be true. You can use this attribute to determine whether a subscription that has a status of active is scheduled to be canceled at the end of the current period. */ - cancel_at_period_end: boolean; + cancel_at_period_end: boolean /** * Format: unix-time * @description 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?: number | null; + canceled_at?: number | null /** * @description 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. * @enum {string} */ - collection_method: "charge_automatically" | "send_invoice"; + collection_method: 'charge_automatically' | 'send_invoice' /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** * Format: unix-time * @description 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: number; + current_period_end: number /** * Format: unix-time * @description Start of the current period that the subscription has been invoiced for. */ - current_period_start: number; + current_period_start: number /** @description ID of the customer who owns the subscription. */ - customer: Partial & - Partial & - Partial; + customer: Partial & Partial & Partial /** @description 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?: number | null; + days_until_due?: number | null /** @description 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?: (Partial & Partial) | null; + default_payment_method?: (Partial & Partial) | null /** @description 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?: | (Partial & - Partial & - Partial & - Partial & - Partial & - Partial) - | null; + Partial & + Partial & + Partial & + Partial & + Partial) + | null /** @description 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?: components["schemas"]["tax_rate"][] | null; + default_tax_rates?: components['schemas']['tax_rate'][] | null /** @description 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. */ - discount?: Partial | null; + discount?: Partial | null /** * Format: unix-time * @description If the subscription has ended, the date the subscription ended. */ - ended_at?: number | null; + ended_at?: number | null /** @description Unique identifier for the object. */ - id: string; + id: string /** * SubscriptionItemList * @description List of subscription items, each with an attached price. */ items: { /** @description Details about each object. */ - data: components["schemas"]["subscription_item"][]; + data: components['schemas']['subscription_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** @description The most recent invoice this subscription has generated. */ - latest_invoice?: (Partial & Partial) | null; + latest_invoice?: (Partial & Partial) | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * Format: unix-time * @description 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?: number | null; + next_pending_invoice_item_invoice?: number | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "subscription"; + object: 'subscription' /** @description If specified, payment collection for this subscription will be paused. */ - pause_collection?: Partial | null; + pause_collection?: Partial | null /** @description Payment settings passed on to invoices created by the subscription. */ - payment_settings?: Partial | null; + payment_settings?: Partial | null /** @description 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?: Partial< - components["schemas"]["subscription_pending_invoice_item_interval"] - > | null; + pending_invoice_item_interval?: Partial | null /** @description 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?: (Partial & Partial) | null; + pending_setup_intent?: (Partial & Partial) | null /** @description 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?: Partial | null; + pending_update?: Partial | null /** @description The schedule attached to the subscription */ - schedule?: (Partial & Partial) | null; + schedule?: (Partial & Partial) | null /** * Format: unix-time * @description Date when the subscription was first created. The date might differ from the `created` date due to backdating. */ - start_date: number; + start_date: number /** * @description Possible values are `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `canceled`, or `unpaid`. * @@ -13613,32 +13440,32 @@ export interface components { * If 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. * @enum {string} */ - status: "active" | "canceled" | "incomplete" | "incomplete_expired" | "past_due" | "trialing" | "unpaid"; + status: 'active' | 'canceled' | 'incomplete' | 'incomplete_expired' | 'past_due' | 'trialing' | 'unpaid' /** @description 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?: Partial | null; + transfer_data?: Partial | null /** * Format: unix-time * @description If the subscription has a trial, the end of that trial. */ - trial_end?: number | null; + trial_end?: number | null /** * Format: unix-time * @description If the subscription has a trial, the beginning of that trial. */ - trial_start?: number | null; - }; + trial_start?: number | null + } /** SubscriptionAutomaticTax */ subscription_automatic_tax: { /** @description Whether Stripe automatically computes tax on this subscription. */ - enabled: boolean; - }; + enabled: boolean + } /** SubscriptionBillingThresholds */ subscription_billing_thresholds: { /** @description Monetary threshold that triggers the subscription to create an invoice */ - amount_gte?: number | null; + amount_gte?: number | null /** @description 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?: boolean | null; - }; + reset_billing_cycle_anchor?: boolean | null + } /** * SubscriptionItem * @description Subscription items allow you to create customer subscriptions with more than @@ -13646,50 +13473,50 @@ export interface components { */ subscription_item: { /** @description Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period */ - billing_thresholds?: Partial | null; + billing_thresholds?: Partial | null /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Unique identifier for the object. */ - id: string; + id: string /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "subscription_item"; - price: components["schemas"]["price"]; + object: 'subscription_item' + price: components['schemas']['price'] /** @description The [quantity](https://stripe.com/docs/subscriptions/quantities) of the plan to which the customer should be subscribed. */ - quantity?: number; + quantity?: number /** @description The `subscription` this `subscription_item` belongs to. */ - subscription: string; + subscription: string /** @description 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?: components["schemas"]["tax_rate"][] | null; - }; + tax_rates?: components['schemas']['tax_rate'][] | null + } /** SubscriptionItemBillingThresholds */ subscription_item_billing_thresholds: { /** @description Usage threshold that triggers the subscription to create an invoice */ - usage_gte?: number | null; - }; + usage_gte?: number | null + } /** subscription_payment_method_options_card */ subscription_payment_method_options_card: { - mandate_options?: components["schemas"]["invoice_mandate_options_card"]; + mandate_options?: components['schemas']['invoice_mandate_options_card'] /** * @description 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#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. * @enum {string|null} */ - request_three_d_secure?: ("any" | "automatic") | null; - }; + request_three_d_secure?: ('any' | 'automatic') | null + } /** SubscriptionPendingInvoiceItemInterval */ subscription_pending_invoice_item_interval: { /** * @description Specifies invoicing frequency. Either `day`, `week`, `month` or `year`. * @enum {string} */ - interval: "day" | "month" | "week" | "year"; + interval: 'day' | 'month' | 'week' | 'year' /** @description 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: number; - }; + interval_count: number + } /** * SubscriptionSchedule * @description A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes. @@ -13701,195 +13528,185 @@ export interface components { * Format: unix-time * @description Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch. */ - canceled_at?: number | null; + canceled_at?: number | null /** * Format: unix-time * @description Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch. */ - completed_at?: number | null; + completed_at?: number | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Object representing the start and end dates for the current phase of the subscription schedule, if it is `active`. */ - current_phase?: Partial | null; + current_phase?: Partial | null /** @description ID of the customer who owns the subscription schedule. */ - customer: Partial & - Partial & - Partial; - default_settings: components["schemas"]["subscription_schedules_resource_default_settings"]; + customer: Partial & Partial & Partial + default_settings: components['schemas']['subscription_schedules_resource_default_settings'] /** * @description Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` and `cancel`. * @enum {string} */ - end_behavior: "cancel" | "none" | "release" | "renew"; + end_behavior: 'cancel' | 'none' | 'release' | 'renew' /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "subscription_schedule"; + object: 'subscription_schedule' /** @description Configuration for the subscription schedule's phases. */ - phases: components["schemas"]["subscription_schedule_phase_configuration"][]; + phases: components['schemas']['subscription_schedule_phase_configuration'][] /** * Format: unix-time * @description Time at which the subscription schedule was released. Measured in seconds since the Unix epoch. */ - released_at?: number | null; + released_at?: number | null /** @description ID of the subscription once managed by the subscription schedule (if it is released). */ - released_subscription?: string | null; + released_subscription?: string | null /** * @description 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). * @enum {string} */ - status: "active" | "canceled" | "completed" | "not_started" | "released"; + status: 'active' | 'canceled' | 'completed' | 'not_started' | 'released' /** @description ID of the subscription managed by the subscription schedule. */ - subscription?: (Partial & Partial) | null; - }; + subscription?: (Partial & Partial) | null + } /** * SubscriptionScheduleAddInvoiceItem * @description An Add Invoice Item describes the prices and quantities that will be added as pending invoice items when entering a phase. */ subscription_schedule_add_invoice_item: { /** @description ID of the price used to generate the invoice item. */ - price: Partial & - Partial & - Partial; + price: Partial & Partial & Partial /** @description The quantity of the invoice item. */ - quantity?: number | null; + quantity?: number | null /** @description The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item. */ - tax_rates?: components["schemas"]["tax_rate"][] | null; - }; + tax_rates?: components['schemas']['tax_rate'][] | null + } /** * SubscriptionScheduleConfigurationItem * @description A phase item describes the price and quantity of a phase. */ subscription_schedule_configuration_item: { /** @description Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period */ - billing_thresholds?: Partial | null; + billing_thresholds?: Partial | null /** @description ID of the price to which the customer should be subscribed. */ - price: Partial & - Partial & - Partial; + price: Partial & Partial & Partial /** @description Quantity of the plan to which the customer should be subscribed. */ - quantity?: number; + quantity?: number /** @description 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?: components["schemas"]["tax_rate"][] | null; - }; + tax_rates?: components['schemas']['tax_rate'][] | null + } /** SubscriptionScheduleCurrentPhase */ subscription_schedule_current_phase: { /** * Format: unix-time * @description The end of this phase of the subscription schedule. */ - end_date: number; + end_date: number /** * Format: unix-time * @description The start of this phase of the subscription schedule. */ - start_date: number; - }; + start_date: number + } /** * SubscriptionSchedulePhaseConfiguration * @description A phase describes the plans, coupon, and trialing status of a subscription for a predefined time period. */ subscription_schedule_phase_configuration: { /** @description A list of prices and quantities that will generate invoice items appended to the first invoice for this phase. */ - add_invoice_items: components["schemas"]["subscription_schedule_add_invoice_item"][]; + add_invoice_items: components['schemas']['subscription_schedule_add_invoice_item'][] /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account during this phase of the schedule. */ - application_fee_percent?: number | null; - automatic_tax?: components["schemas"]["schedules_phase_automatic_tax"]; + application_fee_percent?: number | null + automatic_tax?: components['schemas']['schedules_phase_automatic_tax'] /** * @description 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). * @enum {string|null} */ - billing_cycle_anchor?: ("automatic" | "phase_start") | null; + billing_cycle_anchor?: ('automatic' | 'phase_start') | null /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period */ - billing_thresholds?: Partial | null; + billing_thresholds?: Partial | null /** * @description 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. * @enum {string|null} */ - collection_method?: ("charge_automatically" | "send_invoice") | null; + collection_method?: ('charge_automatically' | 'send_invoice') | null /** @description ID of the coupon to use during this phase of the subscription schedule. */ - coupon?: - | (Partial & - Partial & - Partial) - | null; + coupon?: (Partial & Partial & Partial) | null /** @description 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?: (Partial & Partial) | null; + default_payment_method?: (Partial & Partial) | null /** @description The default tax rates to apply to the subscription during this phase of the subscription schedule. */ - default_tax_rates?: components["schemas"]["tax_rate"][] | null; + default_tax_rates?: components['schemas']['tax_rate'][] | null /** * Format: unix-time * @description The end of this phase of the subscription schedule. */ - end_date: number; + end_date: number /** @description The invoice settings applicable during this phase. */ - invoice_settings?: Partial | null; + invoice_settings?: Partial | null /** @description Subscription items to configure the subscription to during this phase of the subscription schedule. */ - items: components["schemas"]["subscription_schedule_configuration_item"][]; + items: components['schemas']['subscription_schedule_configuration_item'][] /** * @description If the subscription schedule will prorate when transitioning to this phase. Possible values are `create_prorations` and `none`. * @enum {string} */ - proration_behavior: "always_invoice" | "create_prorations" | "none"; + proration_behavior: 'always_invoice' | 'create_prorations' | 'none' /** * Format: unix-time * @description The start of this phase of the subscription schedule. */ - start_date: number; + start_date: number /** @description 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?: Partial | null; + transfer_data?: Partial | null /** * Format: unix-time * @description When the trial ends within the phase. */ - trial_end?: number | null; - }; + trial_end?: number | null + } /** SubscriptionSchedulesResourceDefaultSettings */ subscription_schedules_resource_default_settings: { /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account during this phase of the schedule. */ - application_fee_percent?: number | null; - automatic_tax?: components["schemas"]["subscription_schedules_resource_default_settings_automatic_tax"]; + application_fee_percent?: number | null + automatic_tax?: components['schemas']['subscription_schedules_resource_default_settings_automatic_tax'] /** * @description 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). * @enum {string} */ - billing_cycle_anchor: "automatic" | "phase_start"; + billing_cycle_anchor: 'automatic' | 'phase_start' /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period */ - billing_thresholds?: Partial | null; + billing_thresholds?: Partial | null /** * @description 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. * @enum {string|null} */ - collection_method?: ("charge_automatically" | "send_invoice") | null; + collection_method?: ('charge_automatically' | 'send_invoice') | null /** @description 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?: (Partial & Partial) | null; + default_payment_method?: (Partial & Partial) | null /** @description The subscription schedule's default invoice settings. */ - invoice_settings?: Partial | null; + invoice_settings?: Partial | null /** @description 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?: Partial | null; - }; + transfer_data?: Partial | null + } /** SubscriptionSchedulesResourceDefaultSettingsAutomaticTax */ subscription_schedules_resource_default_settings_automatic_tax: { /** @description Whether Stripe automatically computes tax on invoices created during this phase. */ - enabled: boolean; - }; + enabled: boolean + } /** SubscriptionTransferData */ subscription_transfer_data: { /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the destination account. By default, the entire amount is transferred to the destination. */ - amount_percent?: number | null; + amount_percent?: number | null /** @description The account where funds from the payment will be transferred to upon payment success. */ - destination: Partial & Partial; - }; + destination: Partial & Partial + } /** * SubscriptionsResourcePauseCollection * @description The Pause Collection settings determine how we will pause collection for this subscription and for how long the subscription @@ -13900,47 +13717,47 @@ export interface components { * @description The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`. * @enum {string} */ - behavior: "keep_as_draft" | "mark_uncollectible" | "void"; + behavior: 'keep_as_draft' | 'mark_uncollectible' | 'void' /** * Format: unix-time * @description The time after which the subscription will resume collecting payments. */ - resumes_at?: number | null; - }; + resumes_at?: number | null + } /** SubscriptionsResourcePaymentMethodOptions */ subscriptions_resource_payment_method_options: { /** @description This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to invoices created by the subscription. */ - acss_debit?: Partial | null; + acss_debit?: Partial | null /** @description This sub-hash contains details about the Bancontact payment method options to pass to invoices created by the subscription. */ - bancontact?: Partial | null; + bancontact?: Partial | null /** @description This sub-hash contains details about the Card payment method options to pass to invoices created by the subscription. */ - card?: Partial | null; - }; + card?: Partial | null + } /** SubscriptionsResourcePaymentSettings */ subscriptions_resource_payment_settings: { /** @description Payment-method-specific configuration to provide to invoices created by the subscription. */ - payment_method_options?: Partial | null; + payment_method_options?: Partial | null /** @description 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?: | ( - | "ach_credit_transfer" - | "ach_debit" - | "acss_debit" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "sepa_debit" - | "sofort" - | "wechat_pay" + | 'ach_credit_transfer' + | 'ach_debit' + | 'acss_debit' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' )[] - | null; - }; + | null + } /** * SubscriptionsResourcePendingUpdate * @description Pending Updates store the changes pending from a previous update that will be applied @@ -13951,61 +13768,61 @@ export interface components { * Format: unix-time * @description 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. */ - billing_cycle_anchor?: number | null; + billing_cycle_anchor?: number | null /** * Format: unix-time * @description The point after which the changes reflected by this update will be discarded and no longer applied. */ - expires_at: number; + expires_at: number /** @description List of subscription items, each with an attached plan, that will be set if the update is applied. */ - subscription_items?: components["schemas"]["subscription_item"][] | null; + subscription_items?: components['schemas']['subscription_item'][] | null /** * Format: unix-time * @description 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?: number | null; + trial_end?: number | null /** @description 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?: boolean | null; - }; + trial_from_plan?: boolean | null + } /** * TaxProductResourceTaxCode * @description [Tax codes](https://stripe.com/docs/tax/tax-codes) classify goods and services for tax purposes. */ tax_code: { /** @description A detailed description of which types of products the tax code represents. */ - description: string; + description: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description A short name for the tax code. */ - name: string; + name: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "tax_code"; - }; + object: 'tax_code' + } /** TaxDeductedAtSource */ tax_deducted_at_source: { /** @description Unique identifier for the object. */ - id: string; + id: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "tax_deducted_at_source"; + object: 'tax_deducted_at_source' /** * Format: unix-time * @description The end of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period. */ - period_end: number; + period_end: number /** * Format: unix-time * @description The start of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period. */ - period_start: number; + period_start: number /** @description The TAN that was supplied to Stripe when TDS was assessed */ - tax_deduction_account_number: string; - }; + tax_deduction_account_number: string + } /** * tax_id * @description You can add one or multiple tax IDs to a [customer](https://stripe.com/docs/api/customers). @@ -14015,88 +13832,88 @@ export interface components { */ tax_id: { /** @description Two-letter ISO code representing the country of the tax ID. */ - country?: string | null; + country?: string | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description ID of the customer. */ - customer?: (Partial & Partial) | null; + customer?: (Partial & Partial) | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "tax_id"; + object: 'tax_id' /** * @description Type of the tax ID, one of `ae_trn`, `au_abn`, `au_arn`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `es_cif`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `th_vat`, `tw_vat`, `ua_vat`, `us_ein`, or `za_vat`. Note that some legacy tax IDs have type `unknown` * @enum {string} */ type: - | "ae_trn" - | "au_abn" - | "au_arn" - | "br_cnpj" - | "br_cpf" - | "ca_bn" - | "ca_gst_hst" - | "ca_pst_bc" - | "ca_pst_mb" - | "ca_pst_sk" - | "ca_qst" - | "ch_vat" - | "cl_tin" - | "es_cif" - | "eu_vat" - | "gb_vat" - | "ge_vat" - | "hk_br" - | "id_npwp" - | "il_vat" - | "in_gst" - | "is_vat" - | "jp_cn" - | "jp_rn" - | "kr_brn" - | "li_uid" - | "mx_rfc" - | "my_frp" - | "my_itn" - | "my_sst" - | "no_vat" - | "nz_gst" - | "ru_inn" - | "ru_kpp" - | "sa_vat" - | "sg_gst" - | "sg_uen" - | "th_vat" - | "tw_vat" - | "ua_vat" - | "unknown" - | "us_ein" - | "za_vat"; + | 'ae_trn' + | 'au_abn' + | 'au_arn' + | 'br_cnpj' + | 'br_cpf' + | 'ca_bn' + | 'ca_gst_hst' + | 'ca_pst_bc' + | 'ca_pst_mb' + | 'ca_pst_sk' + | 'ca_qst' + | 'ch_vat' + | 'cl_tin' + | 'es_cif' + | 'eu_vat' + | 'gb_vat' + | 'ge_vat' + | 'hk_br' + | 'id_npwp' + | 'il_vat' + | 'in_gst' + | 'is_vat' + | 'jp_cn' + | 'jp_rn' + | 'kr_brn' + | 'li_uid' + | 'mx_rfc' + | 'my_frp' + | 'my_itn' + | 'my_sst' + | 'no_vat' + | 'nz_gst' + | 'ru_inn' + | 'ru_kpp' + | 'sa_vat' + | 'sg_gst' + | 'sg_uen' + | 'th_vat' + | 'tw_vat' + | 'ua_vat' + | 'unknown' + | 'us_ein' + | 'za_vat' /** @description Value of the tax ID. */ - value: string; + value: string /** @description Tax ID verification information. */ - verification?: Partial | null; - }; + verification?: Partial | null + } /** tax_id_verification */ tax_id_verification: { /** * @description Verification status, one of `pending`, `verified`, `unverified`, or `unavailable`. * @enum {string} */ - status: "pending" | "unavailable" | "unverified" | "verified"; + status: 'pending' | 'unavailable' | 'unverified' | 'verified' /** @description Verified address. */ - verified_address?: string | null; + verified_address?: string | null /** @description Verified name. */ - verified_name?: string | null; - }; + verified_name?: string | null + } /** * TaxRate * @description Tax rates can be applied to [invoices](https://stripe.com/docs/billing/invoices/tax-rates), [subscriptions](https://stripe.com/docs/billing/subscriptions/taxes) and [Checkout Sessions](https://stripe.com/docs/payments/checkout/set-up-a-subscription#tax-rates) to collect tax. @@ -14105,118 +13922,118 @@ export interface components { */ tax_rate: { /** @description 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: boolean; + active: boolean /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ - country?: string | null; + country?: string | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. */ - description?: string | null; + description?: string | null /** @description 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: string; + display_name: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description This specifies if the tax rate is inclusive or exclusive. */ - inclusive: boolean; + inclusive: boolean /** @description 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?: string | null; + jurisdiction?: string | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "tax_rate"; + object: 'tax_rate' /** @description This represents the tax rate percent out of 100. */ - percentage: number; + percentage: number /** @description [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States. */ - state?: string | null; + state?: string | null /** * @description The high-level tax type, such as `vat` or `sales_tax`. * @enum {string|null} */ - tax_type?: ("gst" | "hst" | "jct" | "pst" | "qst" | "rst" | "sales_tax" | "vat") | null; - }; + tax_type?: ('gst' | 'hst' | 'jct' | 'pst' | 'qst' | 'rst' | 'sales_tax' | 'vat') | null + } /** * TerminalConnectionToken * @description A Connection Token is used by the Stripe Terminal SDK to connect to a reader. * * Related guide: [Fleet Management](https://stripe.com/docs/terminal/fleet/locations). */ - "terminal.connection_token": { + 'terminal.connection_token': { /** @description 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://stripe.com/docs/terminal/fleet/locations#connection-tokens). */ - location?: string; + location?: string /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "terminal.connection_token"; + object: 'terminal.connection_token' /** @description Your application should pass this token to the Stripe Terminal SDK. */ - secret: string; - }; + secret: string + } /** * TerminalLocationLocation * @description A Location represents a grouping of readers. * * Related guide: [Fleet Management](https://stripe.com/docs/terminal/fleet/locations). */ - "terminal.location": { - address: components["schemas"]["address"]; + 'terminal.location': { + address: components['schemas']['address'] /** @description The display name of the location. */ - display_name: string; + display_name: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "terminal.location"; - }; + object: 'terminal.location' + } /** * TerminalReaderReader * @description A Reader represents a physical device for accepting payment details. * * Related guide: [Connecting to a Reader](https://stripe.com/docs/terminal/payments/connect-reader). */ - "terminal.reader": { + 'terminal.reader': { /** @description The current software version of the reader. */ - device_sw_version?: string | null; + device_sw_version?: string | null /** * @description Type of reader, one of `bbpos_chipper2x`, `bbpos_wisepos_e`, or `verifone_P400`. * @enum {string} */ - device_type: "bbpos_chipper2x" | "bbpos_wisepos_e" | "verifone_P400"; + device_type: 'bbpos_chipper2x' | 'bbpos_wisepos_e' | 'verifone_P400' /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The local IP address of the reader. */ - ip_address?: string | null; + ip_address?: string | null /** @description Custom label given to the reader for easier identification. */ - label: string; + label: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description The location identifier of the reader. */ - location?: (Partial & Partial) | null; + location?: (Partial & Partial) | null /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "terminal.reader"; + object: 'terminal.reader' /** @description Serial number of the reader. */ - serial_number: string; + serial_number: string /** @description The networking status of the reader. */ - status?: string | null; - }; + status?: string | null + } /** * ThreeDSecure * @description Cardholder authentication via 3D Secure is initiated by creating a `3D Secure` @@ -14225,31 +14042,31 @@ export interface components { */ three_d_secure: { /** @description Amount of the charge that you will create when authentication completes. */ - amount: number; + amount: number /** @description True if the cardholder went through the authentication flow and their bank indicated that authentication succeeded. */ - authenticated: boolean; - card: components["schemas"]["card"]; + authenticated: boolean + card: components['schemas']['card'] /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "three_d_secure"; + object: 'three_d_secure' /** @description If present, this is the URL that you should send the cardholder to for authentication. If you are going to use Stripe.js to display the authentication page in an iframe, you should use the value "_callback". */ - redirect_url?: string | null; + redirect_url?: string | null /** @description Possible values are `redirect_pending`, `succeeded`, or `failed`. When the cardholder can be authenticated, the object starts with status `redirect_pending`. When liability will be shifted to the cardholder's bank (either because the cardholder was successfully authenticated, or because the bank has not implemented 3D Secure, the object wlil be in status `succeeded`. `failed` indicates that authentication was attempted unsuccessfully. */ - status: string; - }; + status: string + } /** three_d_secure_details */ three_d_secure_details: { /** @@ -14257,39 +14074,29 @@ export interface components { * the issuing bank. * @enum {string|null} */ - authentication_flow?: ("challenge" | "frictionless") | null; + authentication_flow?: ('challenge' | 'frictionless') | null /** * @description Indicates the outcome of 3D Secure authentication. * @enum {string|null} */ - result?: ("attempt_acknowledged" | "authenticated" | "failed" | "not_supported" | "processing_error") | null; + result?: ('attempt_acknowledged' | 'authenticated' | 'failed' | 'not_supported' | 'processing_error') | null /** * @description Additional information about why 3D Secure succeeded or failed based * on the `result`. * @enum {string|null} */ - result_reason?: - | ( - | "abandoned" - | "bypassed" - | "canceled" - | "card_not_enrolled" - | "network_not_supported" - | "protocol_error" - | "rejected" - ) - | null; + result_reason?: ('abandoned' | 'bypassed' | 'canceled' | 'card_not_enrolled' | 'network_not_supported' | 'protocol_error' | 'rejected') | null /** * @description The version of 3D Secure that was used. * @enum {string|null} */ - version?: ("1.0.2" | "2.1.0" | "2.2.0") | null; - }; + version?: ('1.0.2' | '2.1.0' | '2.2.0') | null + } /** three_d_secure_usage */ three_d_secure_usage: { /** @description Whether 3D Secure is supported on this card. */ - supported: boolean; - }; + supported: boolean + } /** * Token * @description Tokenization is the process Stripe uses to collect sensitive card or bank @@ -14316,29 +14123,29 @@ export interface components { * Related guide: [Accept a payment](https://stripe.com/docs/payments/accept-a-payment-charges#web-create-token) */ token: { - bank_account?: components["schemas"]["bank_account"]; - card?: components["schemas"]["card"]; + bank_account?: components['schemas']['bank_account'] + card?: components['schemas']['card'] /** @description IP address of the client that generated the token. */ - client_ip?: string | null; + client_ip?: string | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "token"; + object: 'token' /** @description Type of the token: `account`, `bank_account`, `card`, or `pii`. */ - type: string; + type: string /** @description Whether this token has already been used (tokens can be used only once). */ - used: boolean; - }; + used: boolean + } /** * Topup * @description To top up your Stripe balance, you create a top-up object. You can retrieve @@ -14349,46 +14156,46 @@ export interface components { */ topup: { /** @description Amount transferred. */ - amount: number; + amount: number /** @description 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?: (Partial & Partial) | null; + balance_transaction?: (Partial & Partial) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description 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?: number | null; + expected_availability_date?: number | null /** @description 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?: string | null; + failure_code?: string | null /** @description Message to user further explaining reason for top-up failure if available. */ - failure_message?: string | null; + failure_message?: string | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "topup"; - source: components["schemas"]["source"]; + object: 'topup' + source: components['schemas']['source'] /** @description Extra information about a top-up. This will appear on your source's bank statement. It must contain at least one letter. */ - statement_descriptor?: string | null; + statement_descriptor?: string | null /** * @description The status of the top-up is either `canceled`, `failed`, `pending`, `reversed`, or `succeeded`. * @enum {string} */ - status: "canceled" | "failed" | "pending" | "reversed" | "succeeded"; + status: 'canceled' | 'failed' | 'pending' | 'reversed' | 'succeeded' /** @description A string that identifies this top-up as part of a group. */ - transfer_group?: string | null; - }; + transfer_group?: string | null + } /** * Transfer * @description A `Transfer` object is created when you move funds between Stripe accounts as @@ -14404,72 +14211,72 @@ export interface components { */ transfer: { /** @description Amount in %s to be transferred. */ - amount: number; + amount: number /** @description Amount in %s reversed (can be less than the amount attribute on the transfer if a partial reversal was issued). */ - amount_reversed: number; + amount_reversed: number /** @description Balance transaction that describes the impact of this transfer on your account balance. */ - balance_transaction?: (Partial & Partial) | null; + balance_transaction?: (Partial & Partial) | null /** * Format: unix-time * @description Time that this record of the transfer was first created. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string | null; + description?: string | null /** @description ID of the Stripe account the transfer was sent to. */ - destination?: (Partial & Partial) | null; + destination?: (Partial & Partial) | null /** @description 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?: Partial & Partial; + destination_payment?: Partial & Partial /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "transfer"; + object: 'transfer' /** * TransferReversalList * @description A list of reversals that have been applied to the transfer. */ reversals: { /** @description Details about each object. */ - data: components["schemas"]["transfer_reversal"][]; + data: components['schemas']['transfer_reversal'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; + url: string + } /** @description Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false. */ - reversed: boolean; + reversed: boolean /** @description ID of the charge or payment that was used to fund the transfer. If null, the transfer was funded from the available balance. */ - source_transaction?: (Partial & Partial) | null; + source_transaction?: (Partial & Partial) | null /** @description The source balance this transfer came from. One of `card`, `fpx`, or `bank_account`. */ - source_type?: string | null; + source_type?: string | null /** @description A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-options) for details. */ - transfer_group?: string | null; - }; + transfer_group?: string | null + } /** transfer_data */ transfer_data: { /** @description 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?: number; + amount?: number /** * @description The account (if any) the payment will be attributed to for tax * reporting, and where funds from the payment will be transferred to upon * payment success. */ - destination: Partial & Partial; - }; + destination: Partial & Partial + } /** * TransferReversal * @description [Stripe Connect](https://stripe.com/docs/connect) platforms can reverse transfers made to a @@ -14488,63 +14295,63 @@ export interface components { */ transfer_reversal: { /** @description Amount, in %s. */ - amount: number; + amount: number /** @description Balance transaction that describes the impact on your account balance. */ - balance_transaction?: (Partial & Partial) | null; + balance_transaction?: (Partial & Partial) | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description 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: string; + currency: string /** @description Linked payment refund for the transfer reversal. */ - destination_payment_refund?: (Partial & Partial) | null; + destination_payment_refund?: (Partial & Partial) | null /** @description Unique identifier for the object. */ - id: string; + id: string /** @description 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?: { [key: string]: string } | null; + metadata?: { [key: string]: string } | null /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "transfer_reversal"; + object: 'transfer_reversal' /** @description ID of the refund responsible for the transfer reversal. */ - source_refund?: (Partial & Partial) | null; + source_refund?: (Partial & Partial) | null /** @description ID of the transfer that was reversed. */ - transfer: Partial & Partial; - }; + transfer: Partial & Partial + } /** TransferSchedule */ transfer_schedule: { /** @description The number of days charges for the account will be held before being paid out. */ - delay_days: number; + delay_days: number /** @description How frequently funds will be paid out. One of `manual` (payouts only created via API call), `daily`, `weekly`, or `monthly`. */ - interval: string; + interval: string /** @description 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?: number; + monthly_anchor?: number /** @description The day of the week funds will be paid out, of the style 'monday', 'tuesday', etc. Only shown if `interval` is weekly. */ - weekly_anchor?: string; - }; + weekly_anchor?: string + } /** TransformQuantity */ transform_quantity: { /** @description Divide usage by this number. */ - divide_by: number; + divide_by: number /** * @description After division, either round the result `up` or `down`. * @enum {string} */ - round: "down" | "up"; - }; + round: 'down' | 'up' + } /** TransformUsage */ transform_usage: { /** @description Divide usage by this number. */ - divide_by: number; + divide_by: number /** * @description After division, either round the result `up` or `down`. * @enum {string} */ - round: "down" | "up"; - }; + round: 'down' | 'up' + } /** * UsageRecord * @description Usage records allow you to report customer usage and metrics to Stripe for @@ -14554,51 +14361,51 @@ export interface components { */ usage_record: { /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "usage_record"; + object: 'usage_record' /** @description The usage quantity for the specified date. */ - quantity: number; + quantity: number /** @description The ID of the subscription item this usage record contains data for. */ - subscription_item: string; + subscription_item: string /** * Format: unix-time * @description The timestamp when this usage occurred. */ - timestamp: number; - }; + timestamp: number + } /** UsageRecordSummary */ usage_record_summary: { /** @description Unique identifier for the object. */ - id: string; + id: string /** @description The invoice in which this usage period has been billed for. */ - invoice?: string | null; + invoice?: string | null /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "usage_record_summary"; - period: components["schemas"]["period"]; + object: 'usage_record_summary' + period: components['schemas']['period'] /** @description The ID of the subscription item this summary is describing. */ - subscription_item: string; + subscription_item: string /** @description The total usage within this usage period. */ - total_usage: number; - }; + total_usage: number + } /** verification_session_redaction */ verification_session_redaction: { /** * @description Indicates whether this object and its related objects have been redacted or not. * @enum {string} */ - status: "processing" | "redacted"; - }; + status: 'processing' | 'redacted' + } /** * NotificationWebhookEndpoint * @description You can configure [webhook endpoints](https://stripe.com/docs/webhooks/) via the API to be @@ -14611,37 +14418,37 @@ export interface components { */ webhook_endpoint: { /** @description The API version events are rendered as for this webhook endpoint. */ - api_version?: string | null; + api_version?: string | null /** @description The ID of the associated Connect application. */ - application?: string | null; + application?: string | null /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ - created: number; + created: number /** @description An optional description of what the webhook is used for. */ - description?: string | null; + description?: string | null /** @description The list of events to enable for this endpoint. `['*']` indicates that all events are enabled, except those that require explicit selection. */ - enabled_events: string[]; + enabled_events: string[] /** @description Unique identifier for the object. */ - id: string; + id: string /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ - livemode: boolean; + livemode: boolean /** @description 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: { [key: string]: string }; + metadata: { [key: string]: string } /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ - object: "webhook_endpoint"; + object: 'webhook_endpoint' /** @description The endpoint's secret, used to generate [webhook signatures](https://stripe.com/docs/webhooks/signatures). Only returned at creation. */ - secret?: string; + secret?: string /** @description The status of the webhook. It can be `enabled` or `disabled`. */ - status: string; + status: string /** @description The URL of the webhook endpoint. */ - url: string; - }; - }; + url: string + } + } } export interface operations { @@ -14651,94 +14458,94 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["three_d_secure"]; - }; - }; + 'application/json': components['schemas']['three_d_secure'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Amount of the charge that you will create when authentication completes. */ - amount: number; + amount: number /** @description The ID of a card token, or the ID of a card belonging to the given customer. */ - card?: string; + card?: string /** @description 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: string; + currency: string /** @description The customer associated with this 3D secure authentication. */ - customer?: string; + customer?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The URL that the cardholder's browser will be returned to when authentication completes. */ - return_url: string; - }; - }; - }; - }; + return_url: string + } + } + } + } /**

Retrieves a 3D Secure object.

*/ Get3dSecureThreeDSecure: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - three_d_secure: string; - }; - }; + three_d_secure: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["three_d_secure"]; - }; - }; + 'application/json': components['schemas']['three_d_secure'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves the details of an account.

*/ GetAccount: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["account"]; - }; - }; + 'application/json': components['schemas']['account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged. Most parameters can be changed only for Custom accounts. (These are marked Custom Only below.) Parameters marked Custom and Express are not supported for Standard accounts.

* @@ -14749,63 +14556,63 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["account"]; - }; - }; + 'application/json': components['schemas']['account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account. */ - account_token?: string; + account_token?: string /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ bank_account?: Partial<{ - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; + account_holder_type?: 'company' | 'individual' + account_number: string /** @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; - country: string; - currency?: string; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' + country: string + currency?: string /** @enum {string} */ - object?: "bank_account"; - routing_number?: string; + object?: 'bank_account' + routing_number?: string }> & - Partial; + Partial /** * business_profile_specs * @description Business information about the account. */ business_profile?: { - mcc?: string; - name?: string; - product_description?: string; + mcc?: string + name?: string + product_description?: string /** address_specs */ support_address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - support_email?: string; - support_phone?: string; - support_url?: Partial & Partial<"">; - url?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + support_email?: string + support_phone?: string + support_url?: Partial & Partial<''> + url?: string + } /** * @description The business type. * @enum {string} */ - business_type?: "company" | "government_entity" | "individual" | "non_profit"; + business_type?: 'company' | 'government_entity' | 'individual' | 'non_profit' /** * capabilities_param * @description Each key of the dictionary represents a capability, and each capability maps to its settings (e.g. whether it has been requested or not). Each capability will be inactive until you have provided its specific requirements and Stripe has verified them. An account may have some of its requested capabilities be active and some be inactive. @@ -14813,101 +14620,101 @@ export interface operations { capabilities?: { /** capability_param */ acss_debit_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ afterpay_clearpay_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ au_becs_debit_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ bacs_debit_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ bancontact_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ boleto_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ card_issuing?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ card_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ cartes_bancaires_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ eps_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ fpx_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ giropay_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ grabpay_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ ideal_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ jcb_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ klarna_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ legacy_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ oxxo_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ p24_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ sepa_debit_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ sofort_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ tax_reporting_us_1099_k?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ tax_reporting_us_1099_misc?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ transfers?: { - requested?: boolean; - }; - }; + requested?: boolean + } + } /** * company_specs * @description Information about the company or business. This field is available for any `business_type`. @@ -14915,85 +14722,85 @@ export interface operations { company?: { /** address_specs */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** japan_address_kana_specs */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** japan_address_kanji_specs */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; - directors_provided?: boolean; - executives_provided?: boolean; - name?: string; - name_kana?: string; - name_kanji?: string; - owners_provided?: boolean; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } + directors_provided?: boolean + executives_provided?: boolean + name?: string + name_kana?: string + name_kanji?: string + owners_provided?: boolean /** company_ownership_declaration */ ownership_declaration?: { /** Format: unix-time */ - date?: number; - ip?: string; - user_agent?: string; - }; - phone?: string; - registration_number?: string; + date?: number + ip?: string + user_agent?: string + } + phone?: string + registration_number?: string /** @enum {string} */ structure?: - | "" - | "free_zone_establishment" - | "free_zone_llc" - | "government_instrumentality" - | "governmental_unit" - | "incorporated_non_profit" - | "limited_liability_partnership" - | "llc" - | "multi_member_llc" - | "private_company" - | "private_corporation" - | "private_partnership" - | "public_company" - | "public_corporation" - | "public_partnership" - | "single_member_llc" - | "sole_establishment" - | "sole_proprietorship" - | "tax_exempt_government_instrumentality" - | "unincorporated_association" - | "unincorporated_non_profit"; - tax_id?: string; - tax_id_registrar?: string; - vat_id?: string; + | '' + | 'free_zone_establishment' + | 'free_zone_llc' + | 'government_instrumentality' + | 'governmental_unit' + | 'incorporated_non_profit' + | 'limited_liability_partnership' + | 'llc' + | 'multi_member_llc' + | 'private_company' + | 'private_corporation' + | 'private_partnership' + | 'public_company' + | 'public_corporation' + | 'public_partnership' + | 'single_member_llc' + | 'sole_establishment' + | 'sole_proprietorship' + | 'tax_exempt_government_instrumentality' + | 'unincorporated_association' + | 'unincorporated_non_profit' + tax_id?: string + tax_id_registrar?: string + vat_id?: string /** verification_specs */ verification?: { /** verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; + back?: string + front?: string + } + } + } /** @description 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?: string; + default_currency?: string /** * documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -15001,39 +14808,39 @@ export interface operations { documents?: { /** documents_param */ bank_account_ownership_verification?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ company_license?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ company_memorandum_of_association?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ company_ministerial_decree?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ company_registration_verification?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ company_tax_id_verification?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ proof_of_registration?: { - files?: string[]; - }; - }; + files?: string[] + } + } /** @description The email address of the account holder. This is only to make the account easier to identify to you. Stripe only emails Custom accounts with your consent. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A card or bank account to attach to the account for receiving [payouts](https://stripe.com/docs/connect/bank-debit-card-payouts) (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://stripe.com/docs/api#account_create_bank_account) creation.

By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the bank account or card creation API. */ - external_account?: string; + external_account?: string /** * individual_specs * @description Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. @@ -15041,71 +14848,71 @@ export interface operations { individual?: { /** address_specs */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** japan_address_kana_specs */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** japan_address_kanji_specs */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } dob?: Partial<{ - day: number; - month: number; - year: number; + day: number + month: number + year: number }> & - Partial<"">; - email?: string; - first_name?: string; - first_name_kana?: string; - first_name_kanji?: string; - full_name_aliases?: Partial & Partial<"">; - gender?: string; - id_number?: string; - last_name?: string; - last_name_kana?: string; - last_name_kanji?: string; - maiden_name?: string; - metadata?: Partial<{ [key: string]: string }> & Partial<"">; - phone?: string; + Partial<''> + email?: string + first_name?: string + first_name_kana?: string + first_name_kanji?: string + full_name_aliases?: Partial & Partial<''> + gender?: string + id_number?: string + last_name?: string + last_name_kana?: string + last_name_kanji?: string + maiden_name?: string + metadata?: Partial<{ [key: string]: string }> & Partial<''> + phone?: string /** @enum {string} */ - political_exposure?: "existing" | "none"; - ssn_last_4?: string; + political_exposure?: 'existing' | 'none' + ssn_last_4?: string /** person_verification_specs */ verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; + back?: string + front?: string + } + } + } /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** * settings_specs_update * @description Options for customizing how the account functions within Stripe. @@ -15113,66 +14920,66 @@ export interface operations { settings?: { /** branding_settings_specs */ branding?: { - icon?: string; - logo?: string; - primary_color?: string; - secondary_color?: string; - }; + icon?: string + logo?: string + primary_color?: string + secondary_color?: string + } /** card_issuing_settings_specs */ card_issuing?: { /** settings_terms_of_service_specs */ tos_acceptance?: { /** Format: unix-time */ - date?: number; - ip?: string; - user_agent?: string; - }; - }; + date?: number + ip?: string + user_agent?: string + } + } /** card_payments_settings_specs */ card_payments?: { /** decline_charge_on_specs */ decline_on?: { - avs_failure?: boolean; - cvc_failure?: boolean; - }; - statement_descriptor_prefix?: string; - }; + avs_failure?: boolean + cvc_failure?: boolean + } + statement_descriptor_prefix?: string + } /** payments_settings_specs */ payments?: { - statement_descriptor?: string; - statement_descriptor_kana?: string; - statement_descriptor_kanji?: string; - }; + statement_descriptor?: string + statement_descriptor_kana?: string + statement_descriptor_kanji?: string + } /** payout_settings_specs */ payouts?: { - debit_negative_balances?: boolean; + debit_negative_balances?: boolean /** transfer_schedule_specs */ schedule?: { - delay_days?: Partial<"minimum"> & Partial; + delay_days?: Partial<'minimum'> & Partial /** @enum {string} */ - interval?: "daily" | "manual" | "monthly" | "weekly"; - monthly_anchor?: number; + interval?: 'daily' | 'manual' | 'monthly' | 'weekly' + monthly_anchor?: number /** @enum {string} */ - weekly_anchor?: "friday" | "monday" | "saturday" | "sunday" | "thursday" | "tuesday" | "wednesday"; - }; - statement_descriptor?: string; - }; - }; + weekly_anchor?: 'friday' | 'monday' | 'saturday' | 'sunday' | 'thursday' | 'tuesday' | 'wednesday' + } + statement_descriptor?: string + } + } /** * tos_acceptance_specs * @description Details on the account's acceptance of the [Stripe Services Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance). */ tos_acceptance?: { /** Format: unix-time */ - date?: number; - ip?: string; - service_agreement?: string; - user_agent?: string; - }; - }; - }; - }; - }; + date?: number + ip?: string + service_agreement?: string + user_agent?: string + } + } + } + } + } /** *

With Connect, you can delete accounts you manage.

* @@ -15185,101 +14992,101 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_account"]; - }; - }; + 'application/json': components['schemas']['deleted_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { - account?: string; - }; - }; - }; - }; + 'application/x-www-form-urlencoded': { + account?: string + } + } + } + } /**

Create an external account for a given account.

*/ PostAccountBankAccounts: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ bank_account?: Partial<{ - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; + account_holder_type?: 'company' | 'individual' + account_number: string /** @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; - country: string; - currency?: string; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' + country: string + currency?: string /** @enum {string} */ - object?: "bank_account"; - routing_number?: string; + object?: 'bank_account' + routing_number?: string }> & - Partial; + Partial /** @description When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency. */ - default_for_currency?: boolean; + default_for_currency?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - external_account?: string; + external_account?: string /** @description 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?: { [key: string]: string }; - }; - }; - }; - }; + metadata?: { [key: string]: string } + } + } + } + } /**

Retrieve a specified external account for a given account.

*/ GetAccountBankAccountsId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

* @@ -15288,318 +15095,318 @@ export interface operations { PostAccountBankAccountsId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The name of the person or business that owns the bank account. */ - account_holder_name?: string; + account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - account_holder_type?: "" | "company" | "individual"; + account_holder_type?: '' | 'company' | 'individual' /** * @description The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`. * @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' /** @description City/District/Suburb/Town/Village. */ - address_city?: string; + address_city?: string /** @description Billing address country, if provided when creating card. */ - address_country?: string; + address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - address_line1?: string; + address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - address_line2?: string; + address_line2?: string /** @description State/County/Province/Region. */ - address_state?: string; + address_state?: string /** @description ZIP or postal code. */ - address_zip?: string; + address_zip?: string /** @description When set to true, this becomes the default external account for its currency. */ - default_for_currency?: boolean; + default_for_currency?: boolean /** @description Two digit number representing the card’s expiration month. */ - exp_month?: string; + exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - exp_year?: string; + exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Cardholder name. */ - name?: string; - }; - }; - }; - }; + name?: string + } + } + } + } /**

Delete a specified external account for a given account.

*/ DeleteAccountBankAccountsId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_external_account"]; - }; - }; + 'application/json': components['schemas']['deleted_external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.

*/ GetAccountCapabilities: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["capability"][]; + 'application/json': { + data: components['schemas']['capability'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves information about the specified Account Capability.

*/ GetAccountCapabilitiesCapability: { parameters: { path: { - capability: string; - }; + capability: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["capability"]; - }; - }; + 'application/json': components['schemas']['capability'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates an existing Account Capability.

*/ PostAccountCapabilitiesCapability: { parameters: { path: { - capability: string; - }; - }; + capability: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["capability"]; - }; - }; + 'application/json': components['schemas']['capability'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. */ - requested?: boolean; - }; - }; - }; - }; + requested?: boolean + } + } + } + } /**

List external accounts for an account.

*/ GetAccountExternalAccounts: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards. */ - data: (Partial & Partial)[]; + data: (Partial & Partial)[] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Create an external account for a given account.

*/ PostAccountExternalAccounts: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ bank_account?: Partial<{ - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; + account_holder_type?: 'company' | 'individual' + account_number: string /** @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; - country: string; - currency?: string; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' + country: string + currency?: string /** @enum {string} */ - object?: "bank_account"; - routing_number?: string; + object?: 'bank_account' + routing_number?: string }> & - Partial; + Partial /** @description When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency. */ - default_for_currency?: boolean; + default_for_currency?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - external_account?: string; + external_account?: string /** @description 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?: { [key: string]: string }; - }; - }; - }; - }; + metadata?: { [key: string]: string } + } + } + } + } /**

Retrieve a specified external account for a given account.

*/ GetAccountExternalAccountsId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

* @@ -15608,93 +15415,93 @@ export interface operations { PostAccountExternalAccountsId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The name of the person or business that owns the bank account. */ - account_holder_name?: string; + account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - account_holder_type?: "" | "company" | "individual"; + account_holder_type?: '' | 'company' | 'individual' /** * @description The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`. * @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' /** @description City/District/Suburb/Town/Village. */ - address_city?: string; + address_city?: string /** @description Billing address country, if provided when creating card. */ - address_country?: string; + address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - address_line1?: string; + address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - address_line2?: string; + address_line2?: string /** @description State/County/Province/Region. */ - address_state?: string; + address_state?: string /** @description ZIP or postal code. */ - address_zip?: string; + address_zip?: string /** @description When set to true, this becomes the default external account for its currency. */ - default_for_currency?: boolean; + default_for_currency?: boolean /** @description Two digit number representing the card’s expiration month. */ - exp_month?: string; + exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - exp_year?: string; + exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Cardholder name. */ - name?: string; - }; - }; - }; - }; + name?: string + } + } + } + } /**

Delete a specified external account for a given account.

*/ DeleteAccountExternalAccountsId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_external_account"]; - }; - }; + 'application/json': components['schemas']['deleted_external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Creates a single-use login link for an Express account to access their Stripe dashboard.

* @@ -15705,145 +15512,145 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["login_link"]; - }; - }; + 'application/json': components['schemas']['login_link'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { - account: string; + 'application/x-www-form-urlencoded': { + account: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Where to redirect the user after they log out of their dashboard. */ - redirect_url?: string; - }; - }; - }; - }; + redirect_url?: string + } + } + } + } /**

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.

*/ GetAccountPeople: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Filters on the list of people returned based on the person's relationship to the account's company. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - representative?: boolean; - }; + director?: boolean + executive?: boolean + owner?: boolean + representative?: boolean + } /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["person"][]; + 'application/json': { + data: components['schemas']['person'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new person.

*/ PostAccountPeople: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { - account?: string; + 'application/x-www-form-urlencoded': { + account?: string /** * address_specs * @description The person's address. */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** @description The person's date of birth. */ dob?: Partial<{ - day: number; - month: number; - year: number; + day: number + month: number + year: number }> & - Partial<"">; + Partial<''> /** * person_documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -15851,65 +15658,65 @@ export interface operations { documents?: { /** documents_param */ company_authorization?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ passport?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ visa?: { - files?: string[]; - }; - }; + files?: string[] + } + } /** @description The person's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The person's first name. */ - first_name?: string; + first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - first_name_kana?: string; + first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - first_name_kanji?: string; + first_name_kanji?: string /** @description A list of alternate names or aliases that the person is known by. */ - full_name_aliases?: Partial & Partial<"">; + full_name_aliases?: Partial & Partial<''> /** @description The person's gender (International regulations require either "male" or "female"). */ - gender?: string; + gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ - id_number?: string; + id_number?: string /** @description The person's last name. */ - last_name?: string; + last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - last_name_kana?: string; + last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - last_name_kanji?: string; + last_name_kanji?: string /** @description The person's maiden name. */ - maiden_name?: string; + maiden_name?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ - nationality?: string; + nationality?: string /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - person_token?: string; + person_token?: string /** @description The person's phone number. */ - phone?: string; + phone?: string /** @description 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?: string; + political_exposure?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - percent_ownership?: Partial & Partial<"">; - representative?: boolean; - title?: string; - }; + director?: boolean + executive?: boolean + owner?: boolean + percent_ownership?: Partial & Partial<''> + representative?: boolean + title?: string + } /** @description The last four digits of the person's Social Security number (U.S. only). */ - ssn_last_4?: string; + ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -15917,120 +15724,120 @@ export interface operations { verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; - }; - }; - }; + back?: string + front?: string + } + } + } + } + } + } /**

Retrieves an existing person.

*/ GetAccountPeoplePerson: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - person: string; - }; - }; + person: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates an existing person.

*/ PostAccountPeoplePerson: { parameters: { path: { - person: string; - }; - }; + person: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { - account?: string; + 'application/x-www-form-urlencoded': { + account?: string /** * address_specs * @description The person's address. */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** @description The person's date of birth. */ dob?: Partial<{ - day: number; - month: number; - year: number; + day: number + month: number + year: number }> & - Partial<"">; + Partial<''> /** * person_documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -16038,65 +15845,65 @@ export interface operations { documents?: { /** documents_param */ company_authorization?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ passport?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ visa?: { - files?: string[]; - }; - }; + files?: string[] + } + } /** @description The person's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The person's first name. */ - first_name?: string; + first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - first_name_kana?: string; + first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - first_name_kanji?: string; + first_name_kanji?: string /** @description A list of alternate names or aliases that the person is known by. */ - full_name_aliases?: Partial & Partial<"">; + full_name_aliases?: Partial & Partial<''> /** @description The person's gender (International regulations require either "male" or "female"). */ - gender?: string; + gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ - id_number?: string; + id_number?: string /** @description The person's last name. */ - last_name?: string; + last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - last_name_kana?: string; + last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - last_name_kanji?: string; + last_name_kanji?: string /** @description The person's maiden name. */ - maiden_name?: string; + maiden_name?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ - nationality?: string; + nationality?: string /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - person_token?: string; + person_token?: string /** @description The person's phone number. */ - phone?: string; + phone?: string /** @description 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?: string; + political_exposure?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - percent_ownership?: Partial & Partial<"">; - representative?: boolean; - title?: string; - }; + director?: boolean + executive?: boolean + owner?: boolean + percent_ownership?: Partial & Partial<''> + representative?: boolean + title?: string + } /** @description The last four digits of the person's Social Security number (U.S. only). */ - ssn_last_4?: string; + ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -16104,163 +15911,163 @@ export interface operations { verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; - }; - }; - }; + back?: string + front?: string + } + } + } + } + } + } /**

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.

*/ DeleteAccountPeoplePerson: { parameters: { path: { - person: string; - }; - }; + person: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_person"]; - }; - }; + 'application/json': components['schemas']['deleted_person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ GetAccountPersons: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Filters on the list of people returned based on the person's relationship to the account's company. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - representative?: boolean; - }; + director?: boolean + executive?: boolean + owner?: boolean + representative?: boolean + } /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["person"][]; + 'application/json': { + data: components['schemas']['person'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new person.

*/ PostAccountPersons: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { - account?: string; + 'application/x-www-form-urlencoded': { + account?: string /** * address_specs * @description The person's address. */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** @description The person's date of birth. */ dob?: Partial<{ - day: number; - month: number; - year: number; + day: number + month: number + year: number }> & - Partial<"">; + Partial<''> /** * person_documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -16268,65 +16075,65 @@ export interface operations { documents?: { /** documents_param */ company_authorization?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ passport?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ visa?: { - files?: string[]; - }; - }; + files?: string[] + } + } /** @description The person's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The person's first name. */ - first_name?: string; + first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - first_name_kana?: string; + first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - first_name_kanji?: string; + first_name_kanji?: string /** @description A list of alternate names or aliases that the person is known by. */ - full_name_aliases?: Partial & Partial<"">; + full_name_aliases?: Partial & Partial<''> /** @description The person's gender (International regulations require either "male" or "female"). */ - gender?: string; + gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ - id_number?: string; + id_number?: string /** @description The person's last name. */ - last_name?: string; + last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - last_name_kana?: string; + last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - last_name_kanji?: string; + last_name_kanji?: string /** @description The person's maiden name. */ - maiden_name?: string; + maiden_name?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ - nationality?: string; + nationality?: string /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - person_token?: string; + person_token?: string /** @description The person's phone number. */ - phone?: string; + phone?: string /** @description 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?: string; + political_exposure?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - percent_ownership?: Partial & Partial<"">; - representative?: boolean; - title?: string; - }; + director?: boolean + executive?: boolean + owner?: boolean + percent_ownership?: Partial & Partial<''> + representative?: boolean + title?: string + } /** @description The last four digits of the person's Social Security number (U.S. only). */ - ssn_last_4?: string; + ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -16334,120 +16141,120 @@ export interface operations { verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; - }; - }; - }; + back?: string + front?: string + } + } + } + } + } + } /**

Retrieves an existing person.

*/ GetAccountPersonsPerson: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - person: string; - }; - }; + person: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates an existing person.

*/ PostAccountPersonsPerson: { parameters: { path: { - person: string; - }; - }; + person: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { - account?: string; + 'application/x-www-form-urlencoded': { + account?: string /** * address_specs * @description The person's address. */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** @description The person's date of birth. */ dob?: Partial<{ - day: number; - month: number; - year: number; + day: number + month: number + year: number }> & - Partial<"">; + Partial<''> /** * person_documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -16455,65 +16262,65 @@ export interface operations { documents?: { /** documents_param */ company_authorization?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ passport?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ visa?: { - files?: string[]; - }; - }; + files?: string[] + } + } /** @description The person's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The person's first name. */ - first_name?: string; + first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - first_name_kana?: string; + first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - first_name_kanji?: string; + first_name_kanji?: string /** @description A list of alternate names or aliases that the person is known by. */ - full_name_aliases?: Partial & Partial<"">; + full_name_aliases?: Partial & Partial<''> /** @description The person's gender (International regulations require either "male" or "female"). */ - gender?: string; + gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ - id_number?: string; + id_number?: string /** @description The person's last name. */ - last_name?: string; + last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - last_name_kana?: string; + last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - last_name_kanji?: string; + last_name_kanji?: string /** @description The person's maiden name. */ - maiden_name?: string; + maiden_name?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ - nationality?: string; + nationality?: string /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - person_token?: string; + person_token?: string /** @description The person's phone number. */ - phone?: string; + phone?: string /** @description 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?: string; + political_exposure?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - percent_ownership?: Partial & Partial<"">; - representative?: boolean; - title?: string; - }; + director?: boolean + executive?: boolean + owner?: boolean + percent_ownership?: Partial & Partial<''> + representative?: boolean + title?: string + } /** @description The last four digits of the person's Social Security number (U.S. only). */ - ssn_last_4?: string; + ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -16521,139 +16328,139 @@ export interface operations { verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; - }; - }; - }; + back?: string + front?: string + } + } + } + } + } + } /**

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.

*/ DeleteAccountPersonsPerson: { parameters: { path: { - person: string; - }; - }; + person: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_person"]; - }; - }; + 'application/json': components['schemas']['deleted_person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostAccountLinks: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["account_link"]; - }; - }; + 'application/json': components['schemas']['account_link'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The identifier of the account to create an account link for. */ - account: string; + account: string /** * @description Which information the platform needs to collect from the user. One of `currently_due` or `eventually_due`. Default is `currently_due`. * @enum {string} */ - collect?: "currently_due" | "eventually_due"; + collect?: 'currently_due' | 'eventually_due' /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The URL the user will be redirected to if the account link is expired, has been previously-visited, or is otherwise invalid. The URL you specify should attempt to generate a new account link with the same parameters used to create the original account link, then redirect the user to the new account link's URL so they can continue with Connect Onboarding. If a new account link cannot be generated or the redirect fails you should display a useful error to the user. */ - refresh_url?: string; + refresh_url?: string /** @description The URL that the user will be redirected to upon leaving or completing the linked flow. */ - return_url?: string; + return_url?: string /** * @description The type of account link the user is requesting. Possible values are `account_onboarding` or `account_update`. * @enum {string} */ - type: "account_onboarding" | "account_update"; - }; - }; - }; - }; + type: 'account_onboarding' | 'account_update' + } + } + } + } /**

Returns a list of accounts connected to your platform via Connect. If you’re not a platform, the list is empty.

*/ GetAccounts: { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["account"][]; + 'application/json': { + data: components['schemas']['account'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

With Connect, you can create Stripe accounts for your users. * To do this, you’ll first need to register your platform.

@@ -16663,63 +16470,63 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["account"]; - }; - }; + 'application/json': components['schemas']['account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account. */ - account_token?: string; + account_token?: string /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ bank_account?: Partial<{ - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; + account_holder_type?: 'company' | 'individual' + account_number: string /** @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; - country: string; - currency?: string; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' + country: string + currency?: string /** @enum {string} */ - object?: "bank_account"; - routing_number?: string; + object?: 'bank_account' + routing_number?: string }> & - Partial; + Partial /** * business_profile_specs * @description Business information about the account. */ business_profile?: { - mcc?: string; - name?: string; - product_description?: string; + mcc?: string + name?: string + product_description?: string /** address_specs */ support_address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - support_email?: string; - support_phone?: string; - support_url?: Partial & Partial<"">; - url?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + support_email?: string + support_phone?: string + support_url?: Partial & Partial<''> + url?: string + } /** * @description The business type. * @enum {string} */ - business_type?: "company" | "government_entity" | "individual" | "non_profit"; + business_type?: 'company' | 'government_entity' | 'individual' | 'non_profit' /** * capabilities_param * @description Each key of the dictionary represents a capability, and each capability maps to its settings (e.g. whether it has been requested or not). Each capability will be inactive until you have provided its specific requirements and Stripe has verified them. An account may have some of its requested capabilities be active and some be inactive. @@ -16727,101 +16534,101 @@ export interface operations { capabilities?: { /** capability_param */ acss_debit_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ afterpay_clearpay_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ au_becs_debit_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ bacs_debit_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ bancontact_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ boleto_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ card_issuing?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ card_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ cartes_bancaires_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ eps_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ fpx_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ giropay_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ grabpay_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ ideal_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ jcb_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ klarna_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ legacy_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ oxxo_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ p24_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ sepa_debit_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ sofort_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ tax_reporting_us_1099_k?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ tax_reporting_us_1099_misc?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ transfers?: { - requested?: boolean; - }; - }; + requested?: boolean + } + } /** * company_specs * @description Information about the company or business. This field is available for any `business_type`. @@ -16829,87 +16636,87 @@ export interface operations { company?: { /** address_specs */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** japan_address_kana_specs */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** japan_address_kanji_specs */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; - directors_provided?: boolean; - executives_provided?: boolean; - name?: string; - name_kana?: string; - name_kanji?: string; - owners_provided?: boolean; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } + directors_provided?: boolean + executives_provided?: boolean + name?: string + name_kana?: string + name_kanji?: string + owners_provided?: boolean /** company_ownership_declaration */ ownership_declaration?: { /** Format: unix-time */ - date?: number; - ip?: string; - user_agent?: string; - }; - phone?: string; - registration_number?: string; + date?: number + ip?: string + user_agent?: string + } + phone?: string + registration_number?: string /** @enum {string} */ structure?: - | "" - | "free_zone_establishment" - | "free_zone_llc" - | "government_instrumentality" - | "governmental_unit" - | "incorporated_non_profit" - | "limited_liability_partnership" - | "llc" - | "multi_member_llc" - | "private_company" - | "private_corporation" - | "private_partnership" - | "public_company" - | "public_corporation" - | "public_partnership" - | "single_member_llc" - | "sole_establishment" - | "sole_proprietorship" - | "tax_exempt_government_instrumentality" - | "unincorporated_association" - | "unincorporated_non_profit"; - tax_id?: string; - tax_id_registrar?: string; - vat_id?: string; + | '' + | 'free_zone_establishment' + | 'free_zone_llc' + | 'government_instrumentality' + | 'governmental_unit' + | 'incorporated_non_profit' + | 'limited_liability_partnership' + | 'llc' + | 'multi_member_llc' + | 'private_company' + | 'private_corporation' + | 'private_partnership' + | 'public_company' + | 'public_corporation' + | 'public_partnership' + | 'single_member_llc' + | 'sole_establishment' + | 'sole_proprietorship' + | 'tax_exempt_government_instrumentality' + | 'unincorporated_association' + | 'unincorporated_non_profit' + tax_id?: string + tax_id_registrar?: string + vat_id?: string /** verification_specs */ verification?: { /** verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; + back?: string + front?: string + } + } + } /** @description The country in which the account holder resides, or in which the business is legally established. This should be an ISO 3166-1 alpha-2 country code. For example, if you are in the United States and the business for which you're creating an account is legally represented in Canada, you would use `CA` as the country for the account being created. */ - country?: string; + country?: string /** @description 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?: string; + default_currency?: string /** * documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -16917,39 +16724,39 @@ export interface operations { documents?: { /** documents_param */ bank_account_ownership_verification?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ company_license?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ company_memorandum_of_association?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ company_ministerial_decree?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ company_registration_verification?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ company_tax_id_verification?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ proof_of_registration?: { - files?: string[]; - }; - }; + files?: string[] + } + } /** @description The email address of the account holder. This is only to make the account easier to identify to you. Stripe only emails Custom accounts with your consent. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A card or bank account to attach to the account for receiving [payouts](https://stripe.com/docs/connect/bank-debit-card-payouts) (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://stripe.com/docs/api#account_create_bank_account) creation.

By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the bank account or card creation API. */ - external_account?: string; + external_account?: string /** * individual_specs * @description Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. @@ -16957,71 +16764,71 @@ export interface operations { individual?: { /** address_specs */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** japan_address_kana_specs */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** japan_address_kanji_specs */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } dob?: Partial<{ - day: number; - month: number; - year: number; + day: number + month: number + year: number }> & - Partial<"">; - email?: string; - first_name?: string; - first_name_kana?: string; - first_name_kanji?: string; - full_name_aliases?: Partial & Partial<"">; - gender?: string; - id_number?: string; - last_name?: string; - last_name_kana?: string; - last_name_kanji?: string; - maiden_name?: string; - metadata?: Partial<{ [key: string]: string }> & Partial<"">; - phone?: string; + Partial<''> + email?: string + first_name?: string + first_name_kana?: string + first_name_kanji?: string + full_name_aliases?: Partial & Partial<''> + gender?: string + id_number?: string + last_name?: string + last_name_kana?: string + last_name_kanji?: string + maiden_name?: string + metadata?: Partial<{ [key: string]: string }> & Partial<''> + phone?: string /** @enum {string} */ - political_exposure?: "existing" | "none"; - ssn_last_4?: string; + political_exposure?: 'existing' | 'none' + ssn_last_4?: string /** person_verification_specs */ verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; + back?: string + front?: string + } + } + } /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** * settings_specs * @description Options for customizing how the account functions within Stripe. @@ -17029,102 +16836,102 @@ export interface operations { settings?: { /** branding_settings_specs */ branding?: { - icon?: string; - logo?: string; - primary_color?: string; - secondary_color?: string; - }; + icon?: string + logo?: string + primary_color?: string + secondary_color?: string + } /** card_issuing_settings_specs */ card_issuing?: { /** settings_terms_of_service_specs */ tos_acceptance?: { /** Format: unix-time */ - date?: number; - ip?: string; - user_agent?: string; - }; - }; + date?: number + ip?: string + user_agent?: string + } + } /** card_payments_settings_specs */ card_payments?: { /** decline_charge_on_specs */ decline_on?: { - avs_failure?: boolean; - cvc_failure?: boolean; - }; - statement_descriptor_prefix?: string; - }; + avs_failure?: boolean + cvc_failure?: boolean + } + statement_descriptor_prefix?: string + } /** payments_settings_specs */ payments?: { - statement_descriptor?: string; - statement_descriptor_kana?: string; - statement_descriptor_kanji?: string; - }; + statement_descriptor?: string + statement_descriptor_kana?: string + statement_descriptor_kanji?: string + } /** payout_settings_specs */ payouts?: { - debit_negative_balances?: boolean; + debit_negative_balances?: boolean /** transfer_schedule_specs */ schedule?: { - delay_days?: Partial<"minimum"> & Partial; + delay_days?: Partial<'minimum'> & Partial /** @enum {string} */ - interval?: "daily" | "manual" | "monthly" | "weekly"; - monthly_anchor?: number; + interval?: 'daily' | 'manual' | 'monthly' | 'weekly' + monthly_anchor?: number /** @enum {string} */ - weekly_anchor?: "friday" | "monday" | "saturday" | "sunday" | "thursday" | "tuesday" | "wednesday"; - }; - statement_descriptor?: string; - }; - }; + weekly_anchor?: 'friday' | 'monday' | 'saturday' | 'sunday' | 'thursday' | 'tuesday' | 'wednesday' + } + statement_descriptor?: string + } + } /** * tos_acceptance_specs * @description Details on the account's acceptance of the [Stripe Services Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance). */ tos_acceptance?: { /** Format: unix-time */ - date?: number; - ip?: string; - service_agreement?: string; - user_agent?: string; - }; + date?: number + ip?: string + service_agreement?: string + user_agent?: string + } /** * @description The type of Stripe account to create. May be one of `custom`, `express` or `standard`. * @enum {string} */ - type?: "custom" | "express" | "standard"; - }; - }; - }; - }; + type?: 'custom' | 'express' | 'standard' + } + } + } + } /**

Retrieves the details of an account.

*/ GetAccountsAccount: { parameters: { path: { - account: string; - }; + account: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["account"]; - }; - }; + 'application/json': components['schemas']['account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged. Most parameters can be changed only for Custom accounts. (These are marked Custom Only below.) Parameters marked Custom and Express are not supported for Standard accounts.

* @@ -17133,70 +16940,70 @@ export interface operations { PostAccountsAccount: { parameters: { path: { - account: string; - }; - }; + account: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["account"]; - }; - }; + 'application/json': components['schemas']['account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account. */ - account_token?: string; + account_token?: string /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ bank_account?: Partial<{ - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; + account_holder_type?: 'company' | 'individual' + account_number: string /** @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; - country: string; - currency?: string; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' + country: string + currency?: string /** @enum {string} */ - object?: "bank_account"; - routing_number?: string; + object?: 'bank_account' + routing_number?: string }> & - Partial; + Partial /** * business_profile_specs * @description Business information about the account. */ business_profile?: { - mcc?: string; - name?: string; - product_description?: string; + mcc?: string + name?: string + product_description?: string /** address_specs */ support_address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - support_email?: string; - support_phone?: string; - support_url?: Partial & Partial<"">; - url?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + support_email?: string + support_phone?: string + support_url?: Partial & Partial<''> + url?: string + } /** * @description The business type. * @enum {string} */ - business_type?: "company" | "government_entity" | "individual" | "non_profit"; + business_type?: 'company' | 'government_entity' | 'individual' | 'non_profit' /** * capabilities_param * @description Each key of the dictionary represents a capability, and each capability maps to its settings (e.g. whether it has been requested or not). Each capability will be inactive until you have provided its specific requirements and Stripe has verified them. An account may have some of its requested capabilities be active and some be inactive. @@ -17204,101 +17011,101 @@ export interface operations { capabilities?: { /** capability_param */ acss_debit_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ afterpay_clearpay_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ au_becs_debit_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ bacs_debit_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ bancontact_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ boleto_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ card_issuing?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ card_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ cartes_bancaires_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ eps_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ fpx_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ giropay_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ grabpay_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ ideal_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ jcb_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ klarna_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ legacy_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ oxxo_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ p24_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ sepa_debit_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ sofort_payments?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ tax_reporting_us_1099_k?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ tax_reporting_us_1099_misc?: { - requested?: boolean; - }; + requested?: boolean + } /** capability_param */ transfers?: { - requested?: boolean; - }; - }; + requested?: boolean + } + } /** * company_specs * @description Information about the company or business. This field is available for any `business_type`. @@ -17306,85 +17113,85 @@ export interface operations { company?: { /** address_specs */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** japan_address_kana_specs */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** japan_address_kanji_specs */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; - directors_provided?: boolean; - executives_provided?: boolean; - name?: string; - name_kana?: string; - name_kanji?: string; - owners_provided?: boolean; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } + directors_provided?: boolean + executives_provided?: boolean + name?: string + name_kana?: string + name_kanji?: string + owners_provided?: boolean /** company_ownership_declaration */ ownership_declaration?: { /** Format: unix-time */ - date?: number; - ip?: string; - user_agent?: string; - }; - phone?: string; - registration_number?: string; + date?: number + ip?: string + user_agent?: string + } + phone?: string + registration_number?: string /** @enum {string} */ structure?: - | "" - | "free_zone_establishment" - | "free_zone_llc" - | "government_instrumentality" - | "governmental_unit" - | "incorporated_non_profit" - | "limited_liability_partnership" - | "llc" - | "multi_member_llc" - | "private_company" - | "private_corporation" - | "private_partnership" - | "public_company" - | "public_corporation" - | "public_partnership" - | "single_member_llc" - | "sole_establishment" - | "sole_proprietorship" - | "tax_exempt_government_instrumentality" - | "unincorporated_association" - | "unincorporated_non_profit"; - tax_id?: string; - tax_id_registrar?: string; - vat_id?: string; + | '' + | 'free_zone_establishment' + | 'free_zone_llc' + | 'government_instrumentality' + | 'governmental_unit' + | 'incorporated_non_profit' + | 'limited_liability_partnership' + | 'llc' + | 'multi_member_llc' + | 'private_company' + | 'private_corporation' + | 'private_partnership' + | 'public_company' + | 'public_corporation' + | 'public_partnership' + | 'single_member_llc' + | 'sole_establishment' + | 'sole_proprietorship' + | 'tax_exempt_government_instrumentality' + | 'unincorporated_association' + | 'unincorporated_non_profit' + tax_id?: string + tax_id_registrar?: string + vat_id?: string /** verification_specs */ verification?: { /** verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; + back?: string + front?: string + } + } + } /** @description 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?: string; + default_currency?: string /** * documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -17392,39 +17199,39 @@ export interface operations { documents?: { /** documents_param */ bank_account_ownership_verification?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ company_license?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ company_memorandum_of_association?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ company_ministerial_decree?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ company_registration_verification?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ company_tax_id_verification?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ proof_of_registration?: { - files?: string[]; - }; - }; + files?: string[] + } + } /** @description The email address of the account holder. This is only to make the account easier to identify to you. Stripe only emails Custom accounts with your consent. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A card or bank account to attach to the account for receiving [payouts](https://stripe.com/docs/connect/bank-debit-card-payouts) (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://stripe.com/docs/api#account_create_bank_account) creation.

By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the bank account or card creation API. */ - external_account?: string; + external_account?: string /** * individual_specs * @description Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. @@ -17432,71 +17239,71 @@ export interface operations { individual?: { /** address_specs */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** japan_address_kana_specs */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** japan_address_kanji_specs */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } dob?: Partial<{ - day: number; - month: number; - year: number; + day: number + month: number + year: number }> & - Partial<"">; - email?: string; - first_name?: string; - first_name_kana?: string; - first_name_kanji?: string; - full_name_aliases?: Partial & Partial<"">; - gender?: string; - id_number?: string; - last_name?: string; - last_name_kana?: string; - last_name_kanji?: string; - maiden_name?: string; - metadata?: Partial<{ [key: string]: string }> & Partial<"">; - phone?: string; + Partial<''> + email?: string + first_name?: string + first_name_kana?: string + first_name_kanji?: string + full_name_aliases?: Partial & Partial<''> + gender?: string + id_number?: string + last_name?: string + last_name_kana?: string + last_name_kanji?: string + maiden_name?: string + metadata?: Partial<{ [key: string]: string }> & Partial<''> + phone?: string /** @enum {string} */ - political_exposure?: "existing" | "none"; - ssn_last_4?: string; + political_exposure?: 'existing' | 'none' + ssn_last_4?: string /** person_verification_specs */ verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; + back?: string + front?: string + } + } + } /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** * settings_specs_update * @description Options for customizing how the account functions within Stripe. @@ -17504,66 +17311,66 @@ export interface operations { settings?: { /** branding_settings_specs */ branding?: { - icon?: string; - logo?: string; - primary_color?: string; - secondary_color?: string; - }; + icon?: string + logo?: string + primary_color?: string + secondary_color?: string + } /** card_issuing_settings_specs */ card_issuing?: { /** settings_terms_of_service_specs */ tos_acceptance?: { /** Format: unix-time */ - date?: number; - ip?: string; - user_agent?: string; - }; - }; + date?: number + ip?: string + user_agent?: string + } + } /** card_payments_settings_specs */ card_payments?: { /** decline_charge_on_specs */ decline_on?: { - avs_failure?: boolean; - cvc_failure?: boolean; - }; - statement_descriptor_prefix?: string; - }; + avs_failure?: boolean + cvc_failure?: boolean + } + statement_descriptor_prefix?: string + } /** payments_settings_specs */ payments?: { - statement_descriptor?: string; - statement_descriptor_kana?: string; - statement_descriptor_kanji?: string; - }; + statement_descriptor?: string + statement_descriptor_kana?: string + statement_descriptor_kanji?: string + } /** payout_settings_specs */ payouts?: { - debit_negative_balances?: boolean; + debit_negative_balances?: boolean /** transfer_schedule_specs */ schedule?: { - delay_days?: Partial<"minimum"> & Partial; + delay_days?: Partial<'minimum'> & Partial /** @enum {string} */ - interval?: "daily" | "manual" | "monthly" | "weekly"; - monthly_anchor?: number; + interval?: 'daily' | 'manual' | 'monthly' | 'weekly' + monthly_anchor?: number /** @enum {string} */ - weekly_anchor?: "friday" | "monday" | "saturday" | "sunday" | "thursday" | "tuesday" | "wednesday"; - }; - statement_descriptor?: string; - }; - }; + weekly_anchor?: 'friday' | 'monday' | 'saturday' | 'sunday' | 'thursday' | 'tuesday' | 'wednesday' + } + statement_descriptor?: string + } + } /** * tos_acceptance_specs * @description Details on the account's acceptance of the [Stripe Services Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance). */ tos_acceptance?: { /** Format: unix-time */ - date?: number; - ip?: string; - service_agreement?: string; - user_agent?: string; - }; - }; - }; - }; - }; + date?: number + ip?: string + service_agreement?: string + user_agent?: string + } + } + } + } + } /** *

With Connect, you can delete accounts you manage.

* @@ -17574,112 +17381,112 @@ export interface operations { DeleteAccountsAccount: { parameters: { path: { - account: string; - }; - }; + account: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_account"]; - }; - }; + 'application/json': components['schemas']['deleted_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Create an external account for a given account.

*/ PostAccountsAccountBankAccounts: { parameters: { path: { - account: string; - }; - }; + account: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ bank_account?: Partial<{ - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; + account_holder_type?: 'company' | 'individual' + account_number: string /** @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; - country: string; - currency?: string; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' + country: string + currency?: string /** @enum {string} */ - object?: "bank_account"; - routing_number?: string; + object?: 'bank_account' + routing_number?: string }> & - Partial; + Partial /** @description When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency. */ - default_for_currency?: boolean; + default_for_currency?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - external_account?: string; + external_account?: string /** @description 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?: { [key: string]: string }; - }; - }; - }; - }; + metadata?: { [key: string]: string } + } + } + } + } /**

Retrieve a specified external account for a given account.

*/ GetAccountsAccountBankAccountsId: { parameters: { path: { - account: string; - id: string; - }; + account: string + id: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

* @@ -17688,334 +17495,334 @@ export interface operations { PostAccountsAccountBankAccountsId: { parameters: { path: { - account: string; - id: string; - }; - }; + account: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The name of the person or business that owns the bank account. */ - account_holder_name?: string; + account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - account_holder_type?: "" | "company" | "individual"; + account_holder_type?: '' | 'company' | 'individual' /** * @description The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`. * @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' /** @description City/District/Suburb/Town/Village. */ - address_city?: string; + address_city?: string /** @description Billing address country, if provided when creating card. */ - address_country?: string; + address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - address_line1?: string; + address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - address_line2?: string; + address_line2?: string /** @description State/County/Province/Region. */ - address_state?: string; + address_state?: string /** @description ZIP or postal code. */ - address_zip?: string; + address_zip?: string /** @description When set to true, this becomes the default external account for its currency. */ - default_for_currency?: boolean; + default_for_currency?: boolean /** @description Two digit number representing the card’s expiration month. */ - exp_month?: string; + exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - exp_year?: string; + exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Cardholder name. */ - name?: string; - }; - }; - }; - }; + name?: string + } + } + } + } /**

Delete a specified external account for a given account.

*/ DeleteAccountsAccountBankAccountsId: { parameters: { path: { - account: string; - id: string; - }; - }; + account: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_external_account"]; - }; - }; + 'application/json': components['schemas']['deleted_external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.

*/ GetAccountsAccountCapabilities: { parameters: { path: { - account: string; - }; + account: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["capability"][]; + 'application/json': { + data: components['schemas']['capability'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves information about the specified Account Capability.

*/ GetAccountsAccountCapabilitiesCapability: { parameters: { path: { - account: string; - capability: string; - }; + account: string + capability: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["capability"]; - }; - }; + 'application/json': components['schemas']['capability'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates an existing Account Capability.

*/ PostAccountsAccountCapabilitiesCapability: { parameters: { path: { - account: string; - capability: string; - }; - }; + account: string + capability: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["capability"]; - }; - }; + 'application/json': components['schemas']['capability'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. */ - requested?: boolean; - }; - }; - }; - }; + requested?: boolean + } + } + } + } /**

List external accounts for an account.

*/ GetAccountsAccountExternalAccounts: { parameters: { path: { - account: string; - }; + account: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards. */ - data: (Partial & Partial)[]; + data: (Partial & Partial)[] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Create an external account for a given account.

*/ PostAccountsAccountExternalAccounts: { parameters: { path: { - account: string; - }; - }; + account: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ bank_account?: Partial<{ - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; + account_holder_type?: 'company' | 'individual' + account_number: string /** @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; - country: string; - currency?: string; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' + country: string + currency?: string /** @enum {string} */ - object?: "bank_account"; - routing_number?: string; + object?: 'bank_account' + routing_number?: string }> & - Partial; + Partial /** @description When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency. */ - default_for_currency?: boolean; + default_for_currency?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - external_account?: string; + external_account?: string /** @description 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?: { [key: string]: string }; - }; - }; - }; - }; + metadata?: { [key: string]: string } + } + } + } + } /**

Retrieve a specified external account for a given account.

*/ GetAccountsAccountExternalAccountsId: { parameters: { path: { - account: string; - id: string; - }; + account: string + id: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

* @@ -18024,95 +17831,95 @@ export interface operations { PostAccountsAccountExternalAccountsId: { parameters: { path: { - account: string; - id: string; - }; - }; + account: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["external_account"]; - }; - }; + 'application/json': components['schemas']['external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The name of the person or business that owns the bank account. */ - account_holder_name?: string; + account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - account_holder_type?: "" | "company" | "individual"; + account_holder_type?: '' | 'company' | 'individual' /** * @description The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`. * @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' /** @description City/District/Suburb/Town/Village. */ - address_city?: string; + address_city?: string /** @description Billing address country, if provided when creating card. */ - address_country?: string; + address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - address_line1?: string; + address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - address_line2?: string; + address_line2?: string /** @description State/County/Province/Region. */ - address_state?: string; + address_state?: string /** @description ZIP or postal code. */ - address_zip?: string; + address_zip?: string /** @description When set to true, this becomes the default external account for its currency. */ - default_for_currency?: boolean; + default_for_currency?: boolean /** @description Two digit number representing the card’s expiration month. */ - exp_month?: string; + exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - exp_year?: string; + exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Cardholder name. */ - name?: string; - }; - }; - }; - }; + name?: string + } + } + } + } /**

Delete a specified external account for a given account.

*/ DeleteAccountsAccountExternalAccountsId: { parameters: { path: { - account: string; - id: string; - }; - }; + account: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_external_account"]; - }; - }; + 'application/json': components['schemas']['deleted_external_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Creates a single-use login link for an Express account to access their Stripe dashboard.

* @@ -18121,158 +17928,158 @@ export interface operations { PostAccountsAccountLoginLinks: { parameters: { path: { - account: string; - }; - }; + account: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["login_link"]; - }; - }; + 'application/json': components['schemas']['login_link'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Where to redirect the user after they log out of their dashboard. */ - redirect_url?: string; - }; - }; - }; - }; + redirect_url?: string + } + } + } + } /**

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.

*/ GetAccountsAccountPeople: { parameters: { path: { - account: string; - }; + account: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Filters on the list of people returned based on the person's relationship to the account's company. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - representative?: boolean; - }; + director?: boolean + executive?: boolean + owner?: boolean + representative?: boolean + } /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["person"][]; + 'application/json': { + data: components['schemas']['person'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new person.

*/ PostAccountsAccountPeople: { parameters: { path: { - account: string; - }; - }; + account: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * address_specs * @description The person's address. */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** @description The person's date of birth. */ dob?: Partial<{ - day: number; - month: number; - year: number; + day: number + month: number + year: number }> & - Partial<"">; + Partial<''> /** * person_documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -18280,65 +18087,65 @@ export interface operations { documents?: { /** documents_param */ company_authorization?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ passport?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ visa?: { - files?: string[]; - }; - }; + files?: string[] + } + } /** @description The person's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The person's first name. */ - first_name?: string; + first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - first_name_kana?: string; + first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - first_name_kanji?: string; + first_name_kanji?: string /** @description A list of alternate names or aliases that the person is known by. */ - full_name_aliases?: Partial & Partial<"">; + full_name_aliases?: Partial & Partial<''> /** @description The person's gender (International regulations require either "male" or "female"). */ - gender?: string; + gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ - id_number?: string; + id_number?: string /** @description The person's last name. */ - last_name?: string; + last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - last_name_kana?: string; + last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - last_name_kanji?: string; + last_name_kanji?: string /** @description The person's maiden name. */ - maiden_name?: string; + maiden_name?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ - nationality?: string; + nationality?: string /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - person_token?: string; + person_token?: string /** @description The person's phone number. */ - phone?: string; + phone?: string /** @description 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?: string; + political_exposure?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - percent_ownership?: Partial & Partial<"">; - representative?: boolean; - title?: string; - }; + director?: boolean + executive?: boolean + owner?: boolean + percent_ownership?: Partial & Partial<''> + representative?: boolean + title?: string + } /** @description The last four digits of the person's Social Security number (U.S. only). */ - ssn_last_4?: string; + ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -18346,121 +18153,121 @@ export interface operations { verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; - }; - }; - }; + back?: string + front?: string + } + } + } + } + } + } /**

Retrieves an existing person.

*/ GetAccountsAccountPeoplePerson: { parameters: { path: { - account: string; - person: string; - }; + account: string + person: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates an existing person.

*/ PostAccountsAccountPeoplePerson: { parameters: { path: { - account: string; - person: string; - }; - }; + account: string + person: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * address_specs * @description The person's address. */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** @description The person's date of birth. */ dob?: Partial<{ - day: number; - month: number; - year: number; + day: number + month: number + year: number }> & - Partial<"">; + Partial<''> /** * person_documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -18468,65 +18275,65 @@ export interface operations { documents?: { /** documents_param */ company_authorization?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ passport?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ visa?: { - files?: string[]; - }; - }; + files?: string[] + } + } /** @description The person's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The person's first name. */ - first_name?: string; + first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - first_name_kana?: string; + first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - first_name_kanji?: string; + first_name_kanji?: string /** @description A list of alternate names or aliases that the person is known by. */ - full_name_aliases?: Partial & Partial<"">; + full_name_aliases?: Partial & Partial<''> /** @description The person's gender (International regulations require either "male" or "female"). */ - gender?: string; + gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ - id_number?: string; + id_number?: string /** @description The person's last name. */ - last_name?: string; + last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - last_name_kana?: string; + last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - last_name_kanji?: string; + last_name_kanji?: string /** @description The person's maiden name. */ - maiden_name?: string; + maiden_name?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ - nationality?: string; + nationality?: string /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - person_token?: string; + person_token?: string /** @description The person's phone number. */ - phone?: string; + phone?: string /** @description 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?: string; + political_exposure?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - percent_ownership?: Partial & Partial<"">; - representative?: boolean; - title?: string; - }; + director?: boolean + executive?: boolean + owner?: boolean + percent_ownership?: Partial & Partial<''> + representative?: boolean + title?: string + } /** @description The last four digits of the person's Social Security number (U.S. only). */ - ssn_last_4?: string; + ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -18534,171 +18341,171 @@ export interface operations { verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; - }; - }; - }; + back?: string + front?: string + } + } + } + } + } + } /**

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.

*/ DeleteAccountsAccountPeoplePerson: { parameters: { path: { - account: string; - person: string; - }; - }; + account: string + person: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_person"]; - }; - }; + 'application/json': components['schemas']['deleted_person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ GetAccountsAccountPersons: { parameters: { path: { - account: string; - }; + account: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Filters on the list of people returned based on the person's relationship to the account's company. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - representative?: boolean; - }; + director?: boolean + executive?: boolean + owner?: boolean + representative?: boolean + } /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["person"][]; + 'application/json': { + data: components['schemas']['person'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new person.

*/ PostAccountsAccountPersons: { parameters: { path: { - account: string; - }; - }; + account: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * address_specs * @description The person's address. */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** @description The person's date of birth. */ dob?: Partial<{ - day: number; - month: number; - year: number; + day: number + month: number + year: number }> & - Partial<"">; + Partial<''> /** * person_documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -18706,65 +18513,65 @@ export interface operations { documents?: { /** documents_param */ company_authorization?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ passport?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ visa?: { - files?: string[]; - }; - }; + files?: string[] + } + } /** @description The person's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The person's first name. */ - first_name?: string; + first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - first_name_kana?: string; + first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - first_name_kanji?: string; + first_name_kanji?: string /** @description A list of alternate names or aliases that the person is known by. */ - full_name_aliases?: Partial & Partial<"">; + full_name_aliases?: Partial & Partial<''> /** @description The person's gender (International regulations require either "male" or "female"). */ - gender?: string; + gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ - id_number?: string; + id_number?: string /** @description The person's last name. */ - last_name?: string; + last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - last_name_kana?: string; + last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - last_name_kanji?: string; + last_name_kanji?: string /** @description The person's maiden name. */ - maiden_name?: string; + maiden_name?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ - nationality?: string; + nationality?: string /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - person_token?: string; + person_token?: string /** @description The person's phone number. */ - phone?: string; + phone?: string /** @description 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?: string; + political_exposure?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - percent_ownership?: Partial & Partial<"">; - representative?: boolean; - title?: string; - }; + director?: boolean + executive?: boolean + owner?: boolean + percent_ownership?: Partial & Partial<''> + representative?: boolean + title?: string + } /** @description The last four digits of the person's Social Security number (U.S. only). */ - ssn_last_4?: string; + ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -18772,121 +18579,121 @@ export interface operations { verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; - }; - }; - }; + back?: string + front?: string + } + } + } + } + } + } /**

Retrieves an existing person.

*/ GetAccountsAccountPersonsPerson: { parameters: { path: { - account: string; - person: string; - }; + account: string + person: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates an existing person.

*/ PostAccountsAccountPersonsPerson: { parameters: { path: { - account: string; - person: string; - }; - }; + account: string + person: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["person"]; - }; - }; + 'application/json': components['schemas']['person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * address_specs * @description The person's address. */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** * japan_address_kana_specs * @description The Kana variation of the person's address (Japan only). */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** * japan_address_kanji_specs * @description The Kanji variation of the person's address (Japan only). */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** @description The person's date of birth. */ dob?: Partial<{ - day: number; - month: number; - year: number; + day: number + month: number + year: number }> & - Partial<"">; + Partial<''> /** * person_documents_specs * @description Documents that may be submitted to satisfy various informational requests. @@ -18894,65 +18701,65 @@ export interface operations { documents?: { /** documents_param */ company_authorization?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ passport?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ visa?: { - files?: string[]; - }; - }; + files?: string[] + } + } /** @description The person's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The person's first name. */ - first_name?: string; + first_name?: string /** @description The Kana variation of the person's first name (Japan only). */ - first_name_kana?: string; + first_name_kana?: string /** @description The Kanji variation of the person's first name (Japan only). */ - first_name_kanji?: string; + first_name_kanji?: string /** @description A list of alternate names or aliases that the person is known by. */ - full_name_aliases?: Partial & Partial<"">; + full_name_aliases?: Partial & Partial<''> /** @description The person's gender (International regulations require either "male" or "female"). */ - gender?: string; + gender?: string /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ - id_number?: string; + id_number?: string /** @description The person's last name. */ - last_name?: string; + last_name?: string /** @description The Kana variation of the person's last name (Japan only). */ - last_name_kana?: string; + last_name_kana?: string /** @description The Kanji variation of the person's last name (Japan only). */ - last_name_kanji?: string; + last_name_kanji?: string /** @description The person's maiden name. */ - maiden_name?: string; + maiden_name?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ - nationality?: string; + nationality?: string /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ - person_token?: string; + person_token?: string /** @description The person's phone number. */ - phone?: string; + phone?: string /** @description 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?: string; + political_exposure?: string /** * relationship_specs * @description The relationship that this person has with the account's legal entity. */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - percent_ownership?: Partial & Partial<"">; - representative?: boolean; - title?: string; - }; + director?: boolean + executive?: boolean + owner?: boolean + percent_ownership?: Partial & Partial<''> + representative?: boolean + title?: string + } /** @description The last four digits of the person's Social Security number (U.S. only). */ - ssn_last_4?: string; + ssn_last_4?: string /** * person_verification_specs * @description The person's verification status. @@ -18960,47 +18767,47 @@ export interface operations { verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; - }; - }; - }; + back?: string + front?: string + } + } + } + } + } + } /**

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.

*/ DeleteAccountsAccountPersonsPerson: { parameters: { path: { - account: string; - person: string; - }; - }; + account: string + person: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_person"]; - }; - }; + 'application/json': components['schemas']['deleted_person'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

With Connect, you may flag accounts as suspicious.

* @@ -19009,250 +18816,250 @@ export interface operations { PostAccountsAccountReject: { parameters: { path: { - account: string; - }; - }; + account: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["account"]; - }; - }; + 'application/json': components['schemas']['account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The reason for rejecting the account. Can be `fraud`, `terms_of_service`, or `other`. */ - reason: string; - }; - }; - }; - }; + reason: string + } + } + } + } /**

List apple pay domains.

*/ GetApplePayDomains: { parameters: { query: { - domain_name?: string; + domain_name?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["apple_pay_domain"][]; + 'application/json': { + data: components['schemas']['apple_pay_domain'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Create an apple pay domain.

*/ PostApplePayDomains: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["apple_pay_domain"]; - }; - }; + 'application/json': components['schemas']['apple_pay_domain'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { - domain_name: string; + 'application/x-www-form-urlencoded': { + domain_name: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Retrieve an apple pay domain.

*/ GetApplePayDomainsDomain: { parameters: { path: { - domain: string; - }; + domain: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["apple_pay_domain"]; - }; - }; + 'application/json': components['schemas']['apple_pay_domain'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Delete an apple pay domain.

*/ DeleteApplePayDomainsDomain: { parameters: { path: { - domain: string; - }; - }; + domain: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_apple_pay_domain"]; - }; - }; + 'application/json': components['schemas']['deleted_apple_pay_domain'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ GetApplicationFees: { parameters: { query: { /** Only return application fees for the charge specified by this charge ID. */ - charge?: string; + charge?: string created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["application_fee"][]; + 'application/json': { + data: components['schemas']['application_fee'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ GetApplicationFeesFeeRefundsId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - fee: string; - id: string; - }; - }; + fee: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["fee_refund"]; - }; - }; + 'application/json': components['schemas']['fee_refund'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates the specified application fee refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

* @@ -19261,146 +19068,146 @@ export interface operations { PostApplicationFeesFeeRefundsId: { parameters: { path: { - fee: string; - id: string; - }; - }; + fee: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["fee_refund"]; - }; - }; + 'application/json': components['schemas']['fee_refund'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Retrieves the details of an application fee that your account has collected. The same information is returned when refunding the application fee.

*/ GetApplicationFeesId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["application_fee"]; - }; - }; + 'application/json': components['schemas']['application_fee'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } PostApplicationFeesIdRefund: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["application_fee"]; - }; - }; + 'application/json': components['schemas']['application_fee'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { - amount?: number; - directive?: string; + 'application/x-www-form-urlencoded': { + amount?: number + directive?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

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.

*/ GetApplicationFeesIdRefunds: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["fee_refund"][]; + data: components['schemas']['fee_refund'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Refunds an application fee that has previously been collected but not yet refunded. * Funds will be refunded to the Stripe account from which the fee was originally collected.

@@ -19415,36 +19222,36 @@ export interface operations { PostApplicationFeesIdRefunds: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["fee_refund"]; - }; - }; + 'application/json': components['schemas']['fee_refund'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A positive integer, in _%s_, representing how much of this fee to refund. Can refund only up to the remaining unrefunded amount of the fee. */ - amount?: number; + amount?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; - }; - }; - }; - }; + metadata?: { [key: string]: string } + } + } + } + } /** *

Retrieves the current account balance, based on the authentication that was used to make the request. * For a sample request, see Accounting for negative balances.

@@ -19453,29 +19260,29 @@ export interface operations { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["balance"]; - }; - }; + 'application/json': components['schemas']['balance'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

* @@ -19485,61 +19292,61 @@ export interface operations { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** 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?: string; + currency?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID. */ - payout?: string; + payout?: string /** Only returns the original transaction. */ - source?: string; + source?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `payment`, `payment_failure_refund`, `payment_refund`, `payout`, `payout_cancel`, `payout_failure`, `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?: string; - }; - }; + type?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["balance_transaction"][]; + 'application/json': { + data: components['schemas']['balance_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Retrieves the balance transaction with the given ID.

* @@ -19549,32 +19356,32 @@ export interface operations { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["balance_transaction"]; - }; - }; + 'application/json': components['schemas']['balance_transaction'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

* @@ -19584,61 +19391,61 @@ export interface operations { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** 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?: string; + currency?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID. */ - payout?: string; + payout?: string /** Only returns the original transaction. */ - source?: string; + source?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `payment`, `payment_failure_refund`, `payment_refund`, `payout`, `payout_cancel`, `payout_failure`, `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?: string; - }; - }; + type?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["balance_transaction"][]; + 'application/json': { + data: components['schemas']['balance_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Retrieves the balance transaction with the given ID.

* @@ -19648,113 +19455,113 @@ export interface operations { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["balance_transaction"]; - }; - }; + 'application/json': components['schemas']['balance_transaction'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of configurations that describe the functionality of the customer portal.

*/ GetBillingPortalConfigurations: { parameters: { query: { /** Only return configurations that are active or inactive (e.g., pass `true` to only list active configurations). */ - active?: boolean; + active?: boolean /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** Only return the default or non-default configurations (e.g., pass `true` to only list the default configuration). */ - is_default?: boolean; + is_default?: boolean /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["billing_portal.configuration"][]; + 'application/json': { + data: components['schemas']['billing_portal.configuration'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a configuration that describes the functionality and behavior of a PortalSession

*/ PostBillingPortalConfigurations: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["billing_portal.configuration"]; - }; - }; + 'application/json': components['schemas']['billing_portal.configuration'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * business_profile_create_param * @description The business information shown to customers in the portal. */ business_profile: { - headline?: string; - privacy_policy_url: string; - terms_of_service_url: string; - }; + headline?: string + privacy_policy_url: string + terms_of_service_url: string + } /** @description 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?: Partial & Partial<"">; + default_return_url?: Partial & Partial<''> /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * features_creation_param * @description Information about the features available in the portal. @@ -19762,137 +19569,137 @@ export interface operations { features: { /** customer_update_creation_param */ customer_update?: { - allowed_updates: Partial<("address" | "email" | "phone" | "shipping" | "tax_id")[]> & Partial<"">; - enabled: boolean; - }; + allowed_updates: Partial<('address' | 'email' | 'phone' | 'shipping' | 'tax_id')[]> & Partial<''> + enabled: boolean + } /** invoice_list_param */ invoice_history?: { - enabled: boolean; - }; + enabled: boolean + } /** payment_method_update_param */ payment_method_update?: { - enabled: boolean; - }; + enabled: boolean + } /** subscription_cancel_creation_param */ subscription_cancel?: { /** subscription_cancellation_reason_creation_param */ cancellation_reason?: { - enabled: boolean; + enabled: boolean options: Partial< ( - | "customer_service" - | "low_quality" - | "missing_features" - | "other" - | "switched_service" - | "too_complex" - | "too_expensive" - | "unused" + | 'customer_service' + | 'low_quality' + | 'missing_features' + | 'other' + | 'switched_service' + | 'too_complex' + | 'too_expensive' + | 'unused' )[] > & - Partial<"">; - }; - enabled: boolean; + Partial<''> + } + enabled: boolean /** @enum {string} */ - mode?: "at_period_end" | "immediately"; + mode?: 'at_period_end' | 'immediately' /** @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; - }; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' + } /** subscription_pause_param */ subscription_pause?: { - enabled?: boolean; - }; + enabled?: boolean + } /** subscription_update_creation_param */ subscription_update?: { - default_allowed_updates: Partial<("price" | "promotion_code" | "quantity")[]> & Partial<"">; - enabled: boolean; + default_allowed_updates: Partial<('price' | 'promotion_code' | 'quantity')[]> & Partial<''> + enabled: boolean products: Partial< { - prices: string[]; - product: string; + prices: string[] + product: string }[] > & - Partial<"">; + Partial<''> /** @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; - }; - }; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' + } + } /** @description 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?: { [key: string]: string }; - }; - }; - }; - }; + metadata?: { [key: string]: string } + } + } + } + } /**

Retrieves a configuration that describes the functionality of the customer portal.

*/ GetBillingPortalConfigurationsConfiguration: { parameters: { path: { - configuration: string; - }; + configuration: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["billing_portal.configuration"]; - }; - }; + 'application/json': components['schemas']['billing_portal.configuration'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates a configuration that describes the functionality of the customer portal.

*/ PostBillingPortalConfigurationsConfiguration: { parameters: { path: { - configuration: string; - }; - }; + configuration: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["billing_portal.configuration"]; - }; - }; + 'application/json': components['schemas']['billing_portal.configuration'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether the configuration is active and can be used to create portal sessions. */ - active?: boolean; + active?: boolean /** * business_profile_update_param * @description The business information shown to customers in the portal. */ business_profile?: { - headline?: string; - privacy_policy_url?: string; - terms_of_service_url?: string; - }; + headline?: string + privacy_policy_url?: string + terms_of_service_url?: string + } /** @description 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?: Partial & Partial<"">; + default_return_url?: Partial & Partial<''> /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * features_updating_param * @description Information about the features available in the portal. @@ -19900,455 +19707,455 @@ export interface operations { features?: { /** customer_update_updating_param */ customer_update?: { - allowed_updates?: Partial<("address" | "email" | "phone" | "shipping" | "tax_id")[]> & Partial<"">; - enabled?: boolean; - }; + allowed_updates?: Partial<('address' | 'email' | 'phone' | 'shipping' | 'tax_id')[]> & Partial<''> + enabled?: boolean + } /** invoice_list_param */ invoice_history?: { - enabled: boolean; - }; + enabled: boolean + } /** payment_method_update_param */ payment_method_update?: { - enabled: boolean; - }; + enabled: boolean + } /** subscription_cancel_updating_param */ subscription_cancel?: { /** subscription_cancellation_reason_updating_param */ cancellation_reason?: { - enabled: boolean; + enabled: boolean options?: Partial< ( - | "customer_service" - | "low_quality" - | "missing_features" - | "other" - | "switched_service" - | "too_complex" - | "too_expensive" - | "unused" + | 'customer_service' + | 'low_quality' + | 'missing_features' + | 'other' + | 'switched_service' + | 'too_complex' + | 'too_expensive' + | 'unused' )[] > & - Partial<"">; - }; - enabled?: boolean; + Partial<''> + } + enabled?: boolean /** @enum {string} */ - mode?: "at_period_end" | "immediately"; + mode?: 'at_period_end' | 'immediately' /** @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; - }; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' + } /** subscription_pause_param */ subscription_pause?: { - enabled?: boolean; - }; + enabled?: boolean + } /** subscription_update_updating_param */ subscription_update?: { - default_allowed_updates?: Partial<("price" | "promotion_code" | "quantity")[]> & Partial<"">; - enabled?: boolean; + default_allowed_updates?: Partial<('price' | 'promotion_code' | 'quantity')[]> & Partial<''> + enabled?: boolean products?: Partial< { - prices: string[]; - product: string; + prices: string[] + product: string }[] > & - Partial<"">; + Partial<''> /** @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; - }; - }; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' + } + } /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Creates a session of the customer portal.

*/ PostBillingPortalSessions: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["billing_portal.session"]; - }; - }; + 'application/json': components['schemas']['billing_portal.session'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The ID of an existing [configuration](https://stripe.com/docs/api/customer_portal/configuration) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration. */ - configuration?: string; + configuration?: string /** @description The ID of an existing customer. */ - customer: string; + customer: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * @description 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. * @enum {string} */ locale?: - | "auto" - | "bg" - | "cs" - | "da" - | "de" - | "el" - | "en" - | "en-AU" - | "en-CA" - | "en-GB" - | "en-IE" - | "en-IN" - | "en-NZ" - | "en-SG" - | "es" - | "es-419" - | "et" - | "fi" - | "fil" - | "fr" - | "fr-CA" - | "hr" - | "hu" - | "id" - | "it" - | "ja" - | "ko" - | "lt" - | "lv" - | "ms" - | "mt" - | "nb" - | "nl" - | "pl" - | "pt" - | "pt-BR" - | "ro" - | "ru" - | "sk" - | "sl" - | "sv" - | "th" - | "tr" - | "vi" - | "zh" - | "zh-HK" - | "zh-TW"; + | 'auto' + | 'bg' + | 'cs' + | 'da' + | 'de' + | 'el' + | 'en' + | 'en-AU' + | 'en-CA' + | 'en-GB' + | 'en-IE' + | 'en-IN' + | 'en-NZ' + | 'en-SG' + | 'es' + | 'es-419' + | 'et' + | 'fi' + | 'fil' + | 'fr' + | 'fr-CA' + | 'hr' + | 'hu' + | 'id' + | 'it' + | 'ja' + | 'ko' + | 'lt' + | 'lv' + | 'ms' + | 'mt' + | 'nb' + | 'nl' + | 'pl' + | 'pt' + | 'pt-BR' + | 'ro' + | 'ru' + | 'sk' + | 'sl' + | 'sv' + | 'th' + | 'tr' + | 'vi' + | 'zh' + | 'zh-HK' + | 'zh-TW' /** @description The `on_behalf_of` account to use for this session. 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/charges-transfers#on-behalf-of). 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?: string; + on_behalf_of?: string /** @description The default URL to redirect customers to when they click on the portal's link to return to your website. */ - return_url?: string; - }; - }; - }; - }; + return_url?: string + } + } + } + } /**

Returns a list of your receivers. Receivers are returned sorted by creation date, with the most recently created receivers appearing first.

*/ GetBitcoinReceivers: { parameters: { query: { /** Filter for active receivers. */ - active?: boolean; + active?: boolean /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** Filter for filled receivers. */ - filled?: boolean; + filled?: boolean /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Filter for receivers with uncaptured funds. */ - uncaptured_funds?: boolean; - }; - }; + uncaptured_funds?: boolean + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["bitcoin_receiver"][]; + 'application/json': { + data: components['schemas']['bitcoin_receiver'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves the Bitcoin receiver with the given ID.

*/ GetBitcoinReceiversId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["bitcoin_receiver"]; - }; - }; + 'application/json': components['schemas']['bitcoin_receiver'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

List bitcoin transacitons for a given receiver.

*/ GetBitcoinReceiversReceiverTransactions: { parameters: { query: { /** Only return transactions for the customer specified by this customer ID. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - receiver: string; - }; - }; + receiver: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["bitcoin_transaction"][]; + data: components['schemas']['bitcoin_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

List bitcoin transacitons for a given receiver.

*/ GetBitcoinTransactions: { parameters: { query: { /** Only return transactions for the customer specified by this customer ID. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; - receiver?: string; + limit?: number + receiver?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["bitcoin_transaction"][]; + data: components['schemas']['bitcoin_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of charges you’ve previously created. The charges are returned in sorted order, with the most recent charges appearing first.

*/ GetCharges: { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** Only return charges for the customer specified by this customer ID. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return charges that were created by the PaymentIntent specified by this PaymentIntent ID. */ - payment_intent?: string; + payment_intent?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return charges for this transfer group. */ - transfer_group?: string; - }; - }; + transfer_group?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["charge"][]; + 'application/json': { + data: components['schemas']['charge'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

To charge a credit card or other payment source, you create a Charge object. If your API key is in test mode, the supplied payment source (e.g., card) won’t actually be charged, although everything else will occur as if in live mode. (Stripe assumes that the charge would have completed successfully).

*/ PostCharges: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["charge"]; - }; - }; + 'application/json': components['schemas']['charge'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description 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?: number; - application_fee?: number; + amount?: number + application_fee?: number /** @description A fee in %s that will be applied to the charge and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the `Stripe-Account` header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees). */ - application_fee_amount?: number; + application_fee_amount?: number /** @description Whether to immediately capture the charge. Defaults to `true`. When `false`, the charge issues an authorization (or pre-authorization), and will need to be [captured](https://stripe.com/docs/api#capture_charge) later. Uncaptured charges expire after a set number of days (7 by default). For more information, see the [authorizing charges and settling later](https://stripe.com/docs/charges/placing-a-hold) documentation. */ - capture?: boolean; + capture?: boolean /** @description A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js). */ card?: Partial<{ - address_city?: string; - address_country?: string; - address_line1?: string; - address_line2?: string; - address_state?: string; - address_zip?: string; - cvc?: string; - exp_month: number; - exp_year: number; - metadata?: { [key: string]: string }; - name?: string; - number: string; + address_city?: string + address_country?: string + address_line1?: string + address_line2?: string + address_state?: string + address_zip?: string + cvc?: string + exp_month: number + exp_year: number + metadata?: { [key: string]: string } + name?: string + number: string /** @enum {string} */ - object?: "card"; + object?: 'card' }> & - Partial; + Partial /** @description 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?: string; + currency?: string /** @description The ID of an existing customer that will be charged in this request. */ - customer?: string; + customer?: string /** @description An arbitrary string which you can attach to a `Charge` object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the `description` of the charge(s) that they are describing. */ - description?: string; + description?: string destination?: Partial<{ - account: string; - amount?: number; + account: string + amount?: number }> & - Partial; + Partial /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The Stripe account ID for which these funds are intended. Automatically set if you use the `destination` parameter. For details, see [Creating Separate Charges and Transfers](https://stripe.com/docs/connect/charges-transfers#on-behalf-of). */ - on_behalf_of?: string; + on_behalf_of?: string /** @description The email address to which this charge's [receipt](https://stripe.com/docs/dashboard/receipts) will be sent. The receipt will not be sent until the charge is paid, and no receipts will be sent for test mode charges. If this charge is for a [Customer](https://stripe.com/docs/api/customers/object), the email address specified here will override the customer's email address. If `receipt_email` is specified for a charge in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails). */ - receipt_email?: string; + receipt_email?: string /** * optional_fields_shipping * @description Shipping information for the charge. Helps prevent fraud on charges for physical goods. @@ -20356,111 +20163,111 @@ export interface operations { shipping?: { /** optional_fields_address */ address: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - carrier?: string; - name: string; - phone?: string; - tracking_number?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + carrier?: string + name: string + phone?: string + tracking_number?: string + } /** @description A payment source to be charged. This can be the ID of a [card](https://stripe.com/docs/api#cards) (i.e., credit or debit card), a [bank account](https://stripe.com/docs/api#bank_accounts), a [source](https://stripe.com/docs/api#sources), a [token](https://stripe.com/docs/api#tokens), or a [connected account](https://stripe.com/docs/connect/account-debits#charging-a-connected-account). For certain sources---namely, [cards](https://stripe.com/docs/api#cards), [bank accounts](https://stripe.com/docs/api#bank_accounts), and attached [sources](https://stripe.com/docs/api#sources)---you must also pass the ID of the associated customer. */ - source?: string; + source?: string /** @description For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - statement_descriptor_suffix?: string; + statement_descriptor_suffix?: string /** * transfer_data_specs * @description 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?: { - amount?: number; - destination: string; - }; + amount?: number + destination: string + } /** @description A string that identifies this transaction as part of a group. For details, see [Grouping transactions](https://stripe.com/docs/connect/charges-transfers#transfer-options). */ - transfer_group?: string; - }; - }; - }; - }; + transfer_group?: string + } + } + } + } /**

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.

*/ GetChargesCharge: { parameters: { path: { - charge: string; - }; + charge: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["charge"]; - }; - }; + 'application/json': components['schemas']['charge'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates the specified charge by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ PostChargesCharge: { parameters: { path: { - charge: string; - }; - }; + charge: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["charge"]; - }; - }; + 'application/json': components['schemas']['charge'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The ID of an existing customer that will be associated with this request. This field may only be updated if there is no existing associated customer with this charge. */ - customer?: string; + customer?: string /** @description An arbitrary string which you can attach to a charge object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the `description` of the charge(s) that they are describing. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * fraud_details * @description A set of key-value pairs you can attach to a charge giving information about its riskiness. If you believe a charge is fraudulent, include a `user_report` key with a value of `fraudulent`. If you believe a charge is safe, include a `user_report` key with a value of `safe`. Stripe will use the information you send to improve our fraud detection algorithms. */ fraud_details?: { /** @enum {string} */ - user_report: "" | "fraudulent" | "safe"; - }; + user_report: '' | 'fraudulent' | 'safe' + } /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description This is the email address that the receipt for this charge will be sent to. If this field is updated, then a new email receipt will be sent to the updated address. */ - receipt_email?: string; + receipt_email?: string /** * optional_fields_shipping * @description Shipping information for the charge. Helps prevent fraud on charges for physical goods. @@ -20468,24 +20275,24 @@ export interface operations { shipping?: { /** optional_fields_address */ address: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - carrier?: string; - name: string; - phone?: string; - tracking_number?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + carrier?: string + name: string + phone?: string + tracking_number?: string + } /** @description A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-options) for details. */ - transfer_group?: string; - }; - }; - }; - }; + transfer_group?: string + } + } + } + } /** *

Capture the payment of an existing, uncaptured, charge. This is the second half of the two-step payment flow, where first you created a charge with the capture option set to false.

* @@ -20494,179 +20301,179 @@ export interface operations { PostChargesChargeCapture: { parameters: { path: { - charge: string; - }; - }; + charge: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["charge"]; - }; - }; + 'application/json': components['schemas']['charge'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The amount to capture, which must be less than or equal to the original amount. Any additional amount will be automatically refunded. */ - amount?: number; + amount?: number /** @description An application fee to add on to this charge. */ - application_fee?: number; + application_fee?: number /** @description An application fee amount to add on to this charge, which must be less than or equal to the original amount. */ - application_fee_amount?: number; + application_fee_amount?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The email address to send this charge's receipt to. This will override the previously-specified email address for this charge, if one was set. Receipts will not be sent in test mode. */ - receipt_email?: string; + receipt_email?: string /** @description For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - statement_descriptor_suffix?: string; + statement_descriptor_suffix?: string /** * transfer_data_specs * @description 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?: { - amount?: number; - }; + amount?: number + } /** @description A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-options) for details. */ - transfer_group?: string; - }; - }; - }; - }; + transfer_group?: string + } + } + } + } /**

Retrieve a dispute for a specified charge.

*/ GetChargesChargeDispute: { parameters: { path: { - charge: string; - }; + charge: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["dispute"]; - }; - }; + 'application/json': components['schemas']['dispute'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } PostChargesChargeDispute: { parameters: { path: { - charge: string; - }; - }; + charge: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["dispute"]; - }; - }; + 'application/json': components['schemas']['dispute'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * dispute_evidence_params * @description Evidence to upload, to respond to a dispute. Updating any field in the hash will submit all fields in the hash for review. The combined character count of all fields is limited to 150,000. */ evidence?: { - access_activity_log?: string; - billing_address?: string; - cancellation_policy?: string; - cancellation_policy_disclosure?: string; - cancellation_rebuttal?: string; - customer_communication?: string; - customer_email_address?: string; - customer_name?: string; - customer_purchase_ip?: string; - customer_signature?: string; - duplicate_charge_documentation?: string; - duplicate_charge_explanation?: string; - duplicate_charge_id?: string; - product_description?: string; - receipt?: string; - refund_policy?: string; - refund_policy_disclosure?: string; - refund_refusal_explanation?: string; - service_date?: string; - service_documentation?: string; - shipping_address?: string; - shipping_carrier?: string; - shipping_date?: string; - shipping_documentation?: string; - shipping_tracking_number?: string; - uncategorized_file?: string; - uncategorized_text?: string; - }; + access_activity_log?: string + billing_address?: string + cancellation_policy?: string + cancellation_policy_disclosure?: string + cancellation_rebuttal?: string + customer_communication?: string + customer_email_address?: string + customer_name?: string + customer_purchase_ip?: string + customer_signature?: string + duplicate_charge_documentation?: string + duplicate_charge_explanation?: string + duplicate_charge_id?: string + product_description?: string + receipt?: string + refund_policy?: string + refund_policy_disclosure?: string + refund_refusal_explanation?: string + service_date?: string + service_documentation?: string + shipping_address?: string + shipping_carrier?: string + shipping_date?: string + shipping_documentation?: string + shipping_tracking_number?: string + uncategorized_file?: string + uncategorized_text?: string + } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Whether to immediately submit evidence to the bank. If `false`, evidence is staged on the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank by making another request with this attribute set to `true` (the default). */ - submit?: boolean; - }; - }; - }; - }; + submit?: boolean + } + } + } + } PostChargesChargeDisputeClose: { parameters: { path: { - charge: string; - }; - }; + charge: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["dispute"]; - }; - }; + 'application/json': components['schemas']['dispute'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /** *

When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.

* @@ -20683,259 +20490,259 @@ export interface operations { PostChargesChargeRefund: { parameters: { path: { - charge: string; - }; - }; + charge: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["charge"]; - }; - }; + 'application/json': components['schemas']['charge'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { - amount?: number; + 'application/x-www-form-urlencoded': { + amount?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - payment_intent?: string; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + payment_intent?: string /** @enum {string} */ - reason?: "duplicate" | "fraudulent" | "requested_by_customer"; - refund_application_fee?: boolean; - reverse_transfer?: boolean; - }; - }; - }; - }; + reason?: 'duplicate' | 'fraudulent' | 'requested_by_customer' + refund_application_fee?: boolean + reverse_transfer?: boolean + } + } + } + } /**

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.

*/ GetChargesChargeRefunds: { parameters: { path: { - charge: string; - }; + charge: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["refund"][]; + data: components['schemas']['refund'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Create a refund.

*/ PostChargesChargeRefunds: { parameters: { path: { - charge: string; - }; - }; + charge: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["refund"]; - }; - }; + 'application/json': components['schemas']['refund'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { - amount?: number; + 'application/x-www-form-urlencoded': { + amount?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - payment_intent?: string; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + payment_intent?: string /** @enum {string} */ - reason?: "duplicate" | "fraudulent" | "requested_by_customer"; - refund_application_fee?: boolean; - reverse_transfer?: boolean; - }; - }; - }; - }; + reason?: 'duplicate' | 'fraudulent' | 'requested_by_customer' + refund_application_fee?: boolean + reverse_transfer?: boolean + } + } + } + } /**

Retrieves the details of an existing refund.

*/ GetChargesChargeRefundsRefund: { parameters: { path: { - charge: string; - refund: string; - }; + charge: string + refund: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["refund"]; - }; - }; + 'application/json': components['schemas']['refund'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Update a specified refund.

*/ PostChargesChargeRefundsRefund: { parameters: { path: { - charge: string; - refund: string; - }; - }; + charge: string + refund: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["refund"]; - }; - }; + 'application/json': components['schemas']['refund'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - metadata?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + expand?: string[] + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Returns a list of Checkout Sessions.

*/ GetCheckoutSessions: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return the Checkout Session for the PaymentIntent specified. */ - payment_intent?: string; + payment_intent?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return the Checkout Session for the subscription specified. */ - subscription?: string; - }; - }; + subscription?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["checkout.session"][]; + 'application/json': { + data: components['schemas']['checkout.session'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a Session object.

*/ PostCheckoutSessions: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["checkout.session"]; - }; - }; + 'application/json': components['schemas']['checkout.session'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * after_expiration_params * @description Configure actions after a Checkout Session has expired. @@ -20943,40 +20750,40 @@ export interface operations { after_expiration?: { /** recovery_params */ recovery?: { - allow_promotion_codes?: boolean; - enabled: boolean; - }; - }; + allow_promotion_codes?: boolean + enabled: boolean + } + } /** @description Enables user redeemable promotion codes. */ - allow_promotion_codes?: boolean; + allow_promotion_codes?: boolean /** * automatic_tax_params * @description Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions. */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** * @description Specify whether Checkout should collect the customer's billing address. * @enum {string} */ - billing_address_collection?: "auto" | "required"; + billing_address_collection?: 'auto' | 'required' /** @description The URL the customer will be directed to if they decide to cancel payment and return to your website. */ - cancel_url: string; + cancel_url: string /** * @description A unique string to reference the Checkout Session. This can be a * customer ID, a cart ID, or similar, and can be used to reconcile the * session with your internal systems. */ - client_reference_id?: string; + client_reference_id?: string /** * consent_collection_params * @description Configure fields for the Checkout Session to gather active consent from customers. */ consent_collection?: { /** @enum {string} */ - promotions?: "auto"; - }; + promotions?: 'auto' + } /** * @description ID of an existing Customer, if one exists. In `payment` mode, the customer’s most recent card * payment method will be used to prefill the email, name, card details, and billing address @@ -20990,7 +20797,7 @@ export interface operations { * * You can set [`payment_intent_data.setup_future_usage`](https://stripe.com/docs/api/checkout/sessions/create#create_checkout_session-payment_intent_data-setup_future_usage) to have Checkout automatically attach the payment method to the Customer you pass in for future reuse. */ - customer?: string; + customer?: string /** * @description Configure whether a Checkout Session creates a [Customer](https://stripe.com/docs/api/customers) during Session confirmation. * @@ -21002,7 +20809,7 @@ export interface operations { * Can only be set in `payment` and `setup` mode. * @enum {string} */ - customer_creation?: "always" | "if_required"; + customer_creation?: 'always' | 'if_required' /** * @description 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. @@ -21010,31 +20817,31 @@ export interface operations { * on file. To access information about the customer once a session is * complete, use the `customer` field. */ - customer_email?: string; + customer_email?: string /** * customer_update_params * @description Controls what fields on Customer can be updated by the Checkout Session. Can only be provided when `customer` is provided. */ customer_update?: { /** @enum {string} */ - address?: "auto" | "never"; + address?: 'auto' | 'never' /** @enum {string} */ - name?: "auto" | "never"; + name?: 'auto' | 'never' /** @enum {string} */ - shipping?: "auto" | "never"; - }; + shipping?: 'auto' | 'never' + } /** @description The coupon or promotion code to apply to this Session. Currently, only up to one may be specified. */ discounts?: { - coupon?: string; - promotion_code?: string; - }[]; + coupon?: string + promotion_code?: string + }[] /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * Format: unix-time * @description The Epoch time in seconds at which the Checkout Session will expire. It can be anywhere from 1 to 24 hours after Checkout Session creation. By default, this value is 24 hours from creation. */ - expires_at?: number; + expires_at?: number /** * @description A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices). * @@ -21045,132 +20852,132 @@ export interface operations { line_items?: { /** adjustable_quantity_params */ adjustable_quantity?: { - enabled: boolean; - maximum?: number; - minimum?: number; - }; - description?: string; - dynamic_tax_rates?: string[]; - price?: string; + enabled: boolean + maximum?: number + minimum?: number + } + description?: string + dynamic_tax_rates?: string[] + price?: string /** price_data_with_product_data */ price_data?: { - currency: string; - product?: string; + currency: string + product?: string /** product_data */ product_data?: { - description?: string; - images?: string[]; - metadata?: { [key: string]: string }; - name: string; - tax_code?: string; - }; + description?: string + images?: string[] + metadata?: { [key: string]: string } + name: string + tax_code?: string + } /** recurring_adhoc */ recurring?: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: string[]; - }[]; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: string[] + }[] /** * @description The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used. * @enum {string} */ locale?: - | "auto" - | "bg" - | "cs" - | "da" - | "de" - | "el" - | "en" - | "en-GB" - | "es" - | "es-419" - | "et" - | "fi" - | "fil" - | "fr" - | "fr-CA" - | "hr" - | "hu" - | "id" - | "it" - | "ja" - | "ko" - | "lt" - | "lv" - | "ms" - | "mt" - | "nb" - | "nl" - | "pl" - | "pt" - | "pt-BR" - | "ro" - | "ru" - | "sk" - | "sl" - | "sv" - | "th" - | "tr" - | "vi" - | "zh" - | "zh-HK" - | "zh-TW"; + | 'auto' + | 'bg' + | 'cs' + | 'da' + | 'de' + | 'el' + | 'en' + | 'en-GB' + | 'es' + | 'es-419' + | 'et' + | 'fi' + | 'fil' + | 'fr' + | 'fr-CA' + | 'hr' + | 'hu' + | 'id' + | 'it' + | 'ja' + | 'ko' + | 'lt' + | 'lv' + | 'ms' + | 'mt' + | 'nb' + | 'nl' + | 'pl' + | 'pt' + | 'pt-BR' + | 'ro' + | 'ru' + | 'sk' + | 'sl' + | 'sv' + | 'th' + | 'tr' + | 'vi' + | 'zh' + | 'zh-HK' + | 'zh-TW' /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * @description The mode of the Checkout Session. Required when using prices or `setup` mode. Pass `subscription` if the Checkout Session includes at least one recurring item. * @enum {string} */ - mode?: "payment" | "setup" | "subscription"; + mode?: 'payment' | 'setup' | 'subscription' /** * payment_intent_data_params * @description A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode. */ payment_intent_data?: { - application_fee_amount?: number; + application_fee_amount?: number /** @enum {string} */ - capture_method?: "automatic" | "manual"; - description?: string; - metadata?: { [key: string]: string }; - on_behalf_of?: string; - receipt_email?: string; + capture_method?: 'automatic' | 'manual' + description?: string + metadata?: { [key: string]: string } + on_behalf_of?: string + receipt_email?: string /** @enum {string} */ - setup_future_usage?: "off_session" | "on_session"; + setup_future_usage?: 'off_session' | 'on_session' /** shipping */ shipping?: { /** address */ address: { - city?: string; - country?: string; - line1: string; - line2?: string; - postal_code?: string; - state?: string; - }; - carrier?: string; - name: string; - phone?: string; - tracking_number?: string; - }; - statement_descriptor?: string; - statement_descriptor_suffix?: string; + city?: string + country?: string + line1: string + line2?: string + postal_code?: string + state?: string + } + carrier?: string + name: string + phone?: string + tracking_number?: string + } + statement_descriptor?: string + statement_descriptor_suffix?: string /** transfer_data_params */ transfer_data?: { - amount?: number; - destination: string; - }; - transfer_group?: string; - }; + amount?: number + destination: string + } + transfer_group?: string + } /** * payment_method_options_param * @description Payment-method-specific configuration. @@ -21179,35 +20986,35 @@ export interface operations { /** payment_method_options_param */ acss_debit?: { /** @enum {string} */ - currency?: "cad" | "usd"; + currency?: 'cad' | 'usd' /** mandate_options_param */ mandate_options?: { - custom_mandate_url?: Partial & Partial<"">; - default_for?: ("invoice" | "subscription")[]; - interval_description?: string; + custom_mandate_url?: Partial & Partial<''> + default_for?: ('invoice' | 'subscription')[] + interval_description?: string /** @enum {string} */ - payment_schedule?: "combined" | "interval" | "sporadic"; + payment_schedule?: 'combined' | 'interval' | 'sporadic' /** @enum {string} */ - transaction_type?: "business" | "personal"; - }; + transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; - }; + verification_method?: 'automatic' | 'instant' | 'microdeposits' + } /** payment_method_options_param */ boleto?: { - expires_after_days?: number; - }; + expires_after_days?: number + } /** payment_method_options_param */ oxxo?: { - expires_after_days?: number; - }; + expires_after_days?: number + } /** payment_method_options_param */ wechat_pay?: { - app_id?: string; + app_id?: string /** @enum {string} */ - client: "android" | "ios" | "web"; - }; - }; + client: 'android' | 'ios' | 'web' + } + } /** * @description A list of the types of payment methods (e.g., `card`) this Checkout Session can accept. * @@ -21219,26 +21026,26 @@ export interface operations { * other characteristics. */ payment_method_types?: ( - | "acss_debit" - | "afterpay_clearpay" - | "alipay" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "eps" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "klarna" - | "oxxo" - | "p24" - | "sepa_debit" - | "sofort" - | "wechat_pay" - )[]; + | 'acss_debit' + | 'afterpay_clearpay' + | 'alipay' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'eps' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'klarna' + | 'oxxo' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' + )[] /** * phone_number_collection_params * @description Controls phone number collection settings for the session. @@ -21247,265 +21054,265 @@ export interface operations { * before using this feature. Learn more about [collecting phone numbers with Checkout](https://stripe.com/docs/payments/checkout/phone-numbers). */ phone_number_collection?: { - enabled: boolean; - }; + enabled: boolean + } /** * setup_intent_data_param * @description A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in `setup` mode. */ setup_intent_data?: { - description?: string; - metadata?: { [key: string]: string }; - on_behalf_of?: string; - }; + description?: string + metadata?: { [key: string]: string } + on_behalf_of?: string + } /** * shipping_address_collection_params * @description When set, provides configuration for Checkout to collect a shipping address from a customer. */ shipping_address_collection?: { allowed_countries: ( - | "AC" - | "AD" - | "AE" - | "AF" - | "AG" - | "AI" - | "AL" - | "AM" - | "AO" - | "AQ" - | "AR" - | "AT" - | "AU" - | "AW" - | "AX" - | "AZ" - | "BA" - | "BB" - | "BD" - | "BE" - | "BF" - | "BG" - | "BH" - | "BI" - | "BJ" - | "BL" - | "BM" - | "BN" - | "BO" - | "BQ" - | "BR" - | "BS" - | "BT" - | "BV" - | "BW" - | "BY" - | "BZ" - | "CA" - | "CD" - | "CF" - | "CG" - | "CH" - | "CI" - | "CK" - | "CL" - | "CM" - | "CN" - | "CO" - | "CR" - | "CV" - | "CW" - | "CY" - | "CZ" - | "DE" - | "DJ" - | "DK" - | "DM" - | "DO" - | "DZ" - | "EC" - | "EE" - | "EG" - | "EH" - | "ER" - | "ES" - | "ET" - | "FI" - | "FJ" - | "FK" - | "FO" - | "FR" - | "GA" - | "GB" - | "GD" - | "GE" - | "GF" - | "GG" - | "GH" - | "GI" - | "GL" - | "GM" - | "GN" - | "GP" - | "GQ" - | "GR" - | "GS" - | "GT" - | "GU" - | "GW" - | "GY" - | "HK" - | "HN" - | "HR" - | "HT" - | "HU" - | "ID" - | "IE" - | "IL" - | "IM" - | "IN" - | "IO" - | "IQ" - | "IS" - | "IT" - | "JE" - | "JM" - | "JO" - | "JP" - | "KE" - | "KG" - | "KH" - | "KI" - | "KM" - | "KN" - | "KR" - | "KW" - | "KY" - | "KZ" - | "LA" - | "LB" - | "LC" - | "LI" - | "LK" - | "LR" - | "LS" - | "LT" - | "LU" - | "LV" - | "LY" - | "MA" - | "MC" - | "MD" - | "ME" - | "MF" - | "MG" - | "MK" - | "ML" - | "MM" - | "MN" - | "MO" - | "MQ" - | "MR" - | "MS" - | "MT" - | "MU" - | "MV" - | "MW" - | "MX" - | "MY" - | "MZ" - | "NA" - | "NC" - | "NE" - | "NG" - | "NI" - | "NL" - | "NO" - | "NP" - | "NR" - | "NU" - | "NZ" - | "OM" - | "PA" - | "PE" - | "PF" - | "PG" - | "PH" - | "PK" - | "PL" - | "PM" - | "PN" - | "PR" - | "PS" - | "PT" - | "PY" - | "QA" - | "RE" - | "RO" - | "RS" - | "RU" - | "RW" - | "SA" - | "SB" - | "SC" - | "SE" - | "SG" - | "SH" - | "SI" - | "SJ" - | "SK" - | "SL" - | "SM" - | "SN" - | "SO" - | "SR" - | "SS" - | "ST" - | "SV" - | "SX" - | "SZ" - | "TA" - | "TC" - | "TD" - | "TF" - | "TG" - | "TH" - | "TJ" - | "TK" - | "TL" - | "TM" - | "TN" - | "TO" - | "TR" - | "TT" - | "TV" - | "TW" - | "TZ" - | "UA" - | "UG" - | "US" - | "UY" - | "UZ" - | "VA" - | "VC" - | "VE" - | "VG" - | "VN" - | "VU" - | "WF" - | "WS" - | "XK" - | "YE" - | "YT" - | "ZA" - | "ZM" - | "ZW" - | "ZZ" - )[]; - }; + | 'AC' + | 'AD' + | 'AE' + | 'AF' + | 'AG' + | 'AI' + | 'AL' + | 'AM' + | 'AO' + | 'AQ' + | 'AR' + | 'AT' + | 'AU' + | 'AW' + | 'AX' + | 'AZ' + | 'BA' + | 'BB' + | 'BD' + | 'BE' + | 'BF' + | 'BG' + | 'BH' + | 'BI' + | 'BJ' + | 'BL' + | 'BM' + | 'BN' + | 'BO' + | 'BQ' + | 'BR' + | 'BS' + | 'BT' + | 'BV' + | 'BW' + | 'BY' + | 'BZ' + | 'CA' + | 'CD' + | 'CF' + | 'CG' + | 'CH' + | 'CI' + | 'CK' + | 'CL' + | 'CM' + | 'CN' + | 'CO' + | 'CR' + | 'CV' + | 'CW' + | 'CY' + | 'CZ' + | 'DE' + | 'DJ' + | 'DK' + | 'DM' + | 'DO' + | 'DZ' + | 'EC' + | 'EE' + | 'EG' + | 'EH' + | 'ER' + | 'ES' + | 'ET' + | 'FI' + | 'FJ' + | 'FK' + | 'FO' + | 'FR' + | 'GA' + | 'GB' + | 'GD' + | 'GE' + | 'GF' + | 'GG' + | 'GH' + | 'GI' + | 'GL' + | 'GM' + | 'GN' + | 'GP' + | 'GQ' + | 'GR' + | 'GS' + | 'GT' + | 'GU' + | 'GW' + | 'GY' + | 'HK' + | 'HN' + | 'HR' + | 'HT' + | 'HU' + | 'ID' + | 'IE' + | 'IL' + | 'IM' + | 'IN' + | 'IO' + | 'IQ' + | 'IS' + | 'IT' + | 'JE' + | 'JM' + | 'JO' + | 'JP' + | 'KE' + | 'KG' + | 'KH' + | 'KI' + | 'KM' + | 'KN' + | 'KR' + | 'KW' + | 'KY' + | 'KZ' + | 'LA' + | 'LB' + | 'LC' + | 'LI' + | 'LK' + | 'LR' + | 'LS' + | 'LT' + | 'LU' + | 'LV' + | 'LY' + | 'MA' + | 'MC' + | 'MD' + | 'ME' + | 'MF' + | 'MG' + | 'MK' + | 'ML' + | 'MM' + | 'MN' + | 'MO' + | 'MQ' + | 'MR' + | 'MS' + | 'MT' + | 'MU' + | 'MV' + | 'MW' + | 'MX' + | 'MY' + | 'MZ' + | 'NA' + | 'NC' + | 'NE' + | 'NG' + | 'NI' + | 'NL' + | 'NO' + | 'NP' + | 'NR' + | 'NU' + | 'NZ' + | 'OM' + | 'PA' + | 'PE' + | 'PF' + | 'PG' + | 'PH' + | 'PK' + | 'PL' + | 'PM' + | 'PN' + | 'PR' + | 'PS' + | 'PT' + | 'PY' + | 'QA' + | 'RE' + | 'RO' + | 'RS' + | 'RU' + | 'RW' + | 'SA' + | 'SB' + | 'SC' + | 'SE' + | 'SG' + | 'SH' + | 'SI' + | 'SJ' + | 'SK' + | 'SL' + | 'SM' + | 'SN' + | 'SO' + | 'SR' + | 'SS' + | 'ST' + | 'SV' + | 'SX' + | 'SZ' + | 'TA' + | 'TC' + | 'TD' + | 'TF' + | 'TG' + | 'TH' + | 'TJ' + | 'TK' + | 'TL' + | 'TM' + | 'TN' + | 'TO' + | 'TR' + | 'TT' + | 'TV' + | 'TW' + | 'TZ' + | 'UA' + | 'UG' + | 'US' + | 'UY' + | 'UZ' + | 'VA' + | 'VC' + | 'VE' + | 'VG' + | 'VN' + | 'VU' + | 'WF' + | 'WS' + | 'XK' + | 'YE' + | 'YT' + | 'ZA' + | 'ZM' + | 'ZW' + | 'ZZ' + )[] + } /** @description The shipping rate options to apply to this Session. */ shipping_options?: { - shipping_rate?: string; + shipping_rate?: string /** method_params */ shipping_rate_data?: { /** delivery_estimate */ @@ -21513,30 +21320,30 @@ export interface operations { /** delivery_estimate_bound */ maximum?: { /** @enum {string} */ - unit: "business_day" | "day" | "hour" | "month" | "week"; - value: number; - }; + unit: 'business_day' | 'day' | 'hour' | 'month' | 'week' + value: number + } /** delivery_estimate_bound */ minimum?: { /** @enum {string} */ - unit: "business_day" | "day" | "hour" | "month" | "week"; - value: number; - }; - }; - display_name: string; + unit: 'business_day' | 'day' | 'hour' | 'month' | 'week' + value: number + } + } + display_name: string /** fixed_amount */ fixed_amount?: { - amount: number; - currency: string; - }; - metadata?: { [key: string]: string }; + amount: number + currency: string + } + metadata?: { [key: string]: string } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - tax_code?: string; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + tax_code?: string /** @enum {string} */ - type?: "fixed_amount"; - }; - }[]; + type?: 'fixed_amount' + } + }[] /** * @description Describes the type of transaction being performed by Checkout in order to customize * relevant text on the page, such as the submit button. `submit_type` can only be @@ -21544,78 +21351,78 @@ export interface operations { * in `subscription` or `setup` mode. * @enum {string} */ - submit_type?: "auto" | "book" | "donate" | "pay"; + submit_type?: 'auto' | 'book' | 'donate' | 'pay' /** * subscription_data_params * @description A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode. */ subscription_data?: { - application_fee_percent?: number; - default_tax_rates?: string[]; + application_fee_percent?: number + default_tax_rates?: string[] items?: { - plan: string; - quantity?: number; - tax_rates?: string[]; - }[]; - metadata?: { [key: string]: string }; + plan: string + quantity?: number + tax_rates?: string[] + }[] + metadata?: { [key: string]: string } /** transfer_data_specs */ transfer_data?: { - amount_percent?: number; - destination: string; - }; + amount_percent?: number + destination: string + } /** Format: unix-time */ - trial_end?: number; - trial_period_days?: number; - }; + trial_end?: number + trial_period_days?: number + } /** * @description The URL to which Stripe should send customers when payment or setup * is complete. * If you’d like to use information from the successful Checkout Session on your page, * read the guide on [customizing your success page](https://stripe.com/docs/payments/checkout/custom-success-page). */ - success_url: string; + success_url: string /** * tax_id_collection_params * @description Controls tax ID collection settings for the session. */ tax_id_collection?: { - enabled: boolean; - }; - }; - }; - }; - }; + enabled: boolean + } + } + } + } + } /**

Retrieves a Session object.

*/ GetCheckoutSessionsSession: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - session: string; - }; - }; + session: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["checkout.session"]; - }; - }; + 'application/json': components['schemas']['checkout.session'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

A Session can be expired when it is in one of these statuses: open

* @@ -21624,210 +21431,210 @@ export interface operations { PostCheckoutSessionsSessionExpire: { parameters: { path: { - session: string; - }; - }; + session: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["checkout.session"]; - }; - }; + 'application/json': components['schemas']['checkout.session'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

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.

*/ GetCheckoutSessionsSessionLineItems: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - session: string; - }; - }; + session: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["item"][]; + data: components['schemas']['item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Lists all Country Spec objects available in the API.

*/ GetCountrySpecs: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["country_spec"][]; + 'application/json': { + data: components['schemas']['country_spec'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a Country Spec for a given Country code.

*/ GetCountrySpecsCountry: { parameters: { path: { - country: string; - }; + country: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["country_spec"]; - }; - }; + 'application/json': components['schemas']['country_spec'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of your coupons.

*/ GetCoupons: { parameters: { query: { /** 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?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["coupon"][]; + 'application/json': { + data: components['schemas']['coupon'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

You can create coupons easily via the coupon management page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.

* @@ -21838,199 +21645,199 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["coupon"]; - }; - }; + 'application/json': components['schemas']['coupon'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed). */ - amount_off?: number; + amount_off?: number /** * applies_to_params * @description A hash containing directions for what this Coupon will apply discounts to. */ applies_to?: { - products?: string[]; - }; + products?: string[] + } /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed). */ - currency?: string; + currency?: string /** * @description Specifies how long the discount will be in effect if used on a subscription. Can be `forever`, `once`, or `repeating`. Defaults to `once`. * @enum {string} */ - duration?: "forever" | "once" | "repeating"; + duration?: 'forever' | 'once' | 'repeating' /** @description Required only if `duration` is `repeating`, in which case it must be a positive integer that specifies the number of months the discount will be in effect. */ - duration_in_months?: number; + duration_in_months?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Unique string of your choice that will be used to identify this coupon when applying it to a customer. If you don't want to specify a particular code, you can leave the ID blank and we'll generate a random code for you. */ - id?: string; + id?: string /** @description A positive integer specifying the number of times the coupon can be redeemed before it's no longer valid. For example, you might have a 50% off coupon that the first 20 readers of your blog can use. */ - max_redemptions?: number; + max_redemptions?: number /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set. */ - name?: string; + name?: string /** @description A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if `amount_off` is not passed). */ - percent_off?: number; + percent_off?: number /** * Format: unix-time * @description Unix timestamp specifying the last time at which the coupon can be redeemed. After the redeem_by date, the coupon can no longer be applied to new customers. */ - redeem_by?: number; - }; - }; - }; - }; + redeem_by?: number + } + } + } + } /**

Retrieves the coupon with the given ID.

*/ GetCouponsCoupon: { parameters: { path: { - coupon: string; - }; + coupon: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["coupon"]; - }; - }; + 'application/json': components['schemas']['coupon'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.

*/ PostCouponsCoupon: { parameters: { path: { - coupon: string; - }; - }; + coupon: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["coupon"]; - }; - }; + 'application/json': components['schemas']['coupon'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set. */ - name?: string; - }; - }; - }; - }; + name?: string + } + } + } + } /**

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.

*/ DeleteCouponsCoupon: { parameters: { path: { - coupon: string; - }; - }; + coupon: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_coupon"]; - }; - }; + 'application/json': components['schemas']['deleted_coupon'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of credit notes.

*/ GetCreditNotes: { parameters: { query: { /** Only return credit notes for the customer specified by this customer ID. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** Only return credit notes for the invoice specified by this invoice ID. */ - invoice?: string; + invoice?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["credit_note"][]; + 'application/json': { + data: components['schemas']['credit_note'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces * its amount_due. For a status=paid invoice, a credit note does not affect its amount_due. Instead, it can result @@ -22052,433 +21859,433 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["credit_note"]; - }; - }; + 'application/json': components['schemas']['credit_note'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The integer amount in %s representing the total amount of the credit note. */ - amount?: number; + amount?: number /** @description The integer amount in %s representing the amount to credit the customer's balance, which will be automatically applied to their next invoice. */ - credit_amount?: number; + credit_amount?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description ID of the invoice. */ - invoice: string; + invoice: string /** @description Line items that make up the credit note. */ lines?: { - amount?: number; - description?: string; - invoice_line_item?: string; - quantity?: number; - tax_rates?: Partial & Partial<"">; + amount?: number + description?: string + invoice_line_item?: string + quantity?: number + tax_rates?: Partial & Partial<''> /** @enum {string} */ - type: "custom_line_item" | "invoice_line_item"; - unit_amount?: number; + type: 'custom_line_item' | 'invoice_line_item' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }[]; + unit_amount_decimal?: string + }[] /** @description The credit note's memo appears on the credit note PDF. */ - memo?: string; + memo?: string /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The integer amount in %s representing the amount that is credited outside of Stripe. */ - out_of_band_amount?: number; + out_of_band_amount?: number /** * @description Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` * @enum {string} */ - reason?: "duplicate" | "fraudulent" | "order_change" | "product_unsatisfactory"; + reason?: 'duplicate' | 'fraudulent' | 'order_change' | 'product_unsatisfactory' /** @description ID of an existing refund to link this credit note to. */ - refund?: string; + refund?: string /** @description The integer amount in %s representing the amount to refund. If set, a refund will be created for the charge associated with the invoice. */ - refund_amount?: number; - }; - }; - }; - }; + refund_amount?: number + } + } + } + } /**

Get a preview of a credit note without creating it.

*/ GetCreditNotesPreview: { parameters: { query: { /** The integer amount in %s representing the total amount of the credit note. */ - amount?: number; + amount?: number /** The integer amount in %s representing the amount to credit the customer's balance, which will be automatically applied to their next invoice. */ - credit_amount?: number; + credit_amount?: number /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** ID of the invoice. */ - invoice: string; + invoice: string /** Line items that make up the credit note. */ lines?: { - amount?: number; - description?: string; - invoice_line_item?: string; - quantity?: number; - tax_rates?: Partial & Partial<"">; + amount?: number + description?: string + invoice_line_item?: string + quantity?: number + tax_rates?: Partial & Partial<''> /** @enum {string} */ - type: "custom_line_item" | "invoice_line_item"; - unit_amount?: number; + type: 'custom_line_item' | 'invoice_line_item' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }[]; + unit_amount_decimal?: string + }[] /** The credit note's memo appears on the credit note PDF. */ - memo?: string; + memo?: string /** 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** The integer amount in %s representing the amount that is credited outside of Stripe. */ - out_of_band_amount?: number; + out_of_band_amount?: number /** Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` */ - reason?: "duplicate" | "fraudulent" | "order_change" | "product_unsatisfactory"; + reason?: 'duplicate' | 'fraudulent' | 'order_change' | 'product_unsatisfactory' /** ID of an existing refund to link this credit note to. */ - refund?: string; + refund?: string /** The integer amount in %s representing the amount to refund. If set, a refund will be created for the charge associated with the invoice. */ - refund_amount?: number; - }; - }; + refund_amount?: number + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["credit_note"]; - }; - }; + 'application/json': components['schemas']['credit_note'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ GetCreditNotesPreviewLines: { parameters: { query: { /** The integer amount in %s representing the total amount of the credit note. */ - amount?: number; + amount?: number /** The integer amount in %s representing the amount to credit the customer's balance, which will be automatically applied to their next invoice. */ - credit_amount?: number; + credit_amount?: number /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** ID of the invoice. */ - invoice: string; + invoice: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Line items that make up the credit note. */ lines?: { - amount?: number; - description?: string; - invoice_line_item?: string; - quantity?: number; - tax_rates?: Partial & Partial<"">; + amount?: number + description?: string + invoice_line_item?: string + quantity?: number + tax_rates?: Partial & Partial<''> /** @enum {string} */ - type: "custom_line_item" | "invoice_line_item"; - unit_amount?: number; + type: 'custom_line_item' | 'invoice_line_item' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }[]; + unit_amount_decimal?: string + }[] /** The credit note's memo appears on the credit note PDF. */ - memo?: string; + memo?: string /** 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** The integer amount in %s representing the amount that is credited outside of Stripe. */ - out_of_band_amount?: number; + out_of_band_amount?: number /** Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` */ - reason?: "duplicate" | "fraudulent" | "order_change" | "product_unsatisfactory"; + reason?: 'duplicate' | 'fraudulent' | 'order_change' | 'product_unsatisfactory' /** ID of an existing refund to link this credit note to. */ - refund?: string; + refund?: string /** The integer amount in %s representing the amount to refund. If set, a refund will be created for the charge associated with the invoice. */ - refund_amount?: number; + refund_amount?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["credit_note_line_item"][]; + data: components['schemas']['credit_note_line_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

When retrieving a credit note, you’ll get a lines property containing the the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

*/ GetCreditNotesCreditNoteLines: { parameters: { path: { - credit_note: string; - }; + credit_note: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["credit_note_line_item"][]; + data: components['schemas']['credit_note_line_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves the credit note object with the given identifier.

*/ GetCreditNotesId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["credit_note"]; - }; - }; + 'application/json': components['schemas']['credit_note'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates an existing credit note.

*/ PostCreditNotesId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["credit_note"]; - }; - }; + 'application/json': components['schemas']['credit_note'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Credit note memo. */ - memo?: string; + memo?: string /** @description 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?: { [key: string]: string }; - }; - }; - }; - }; + metadata?: { [key: string]: string } + } + } + } + } /**

Marks a credit note as void. Learn more about voiding credit notes.

*/ PostCreditNotesIdVoid: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["credit_note"]; - }; - }; + 'application/json': components['schemas']['credit_note'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.

*/ GetCustomers: { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A case-sensitive filter on the list based on the customer's `email` field. The value must be a string. */ - email?: string; + email?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["customer"][]; + 'application/json': { + data: components['schemas']['customer'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new customer object.

*/ PostCustomers: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["customer"]; - }; - }; + 'application/json': components['schemas']['customer'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The customer's address. */ address?: Partial<{ - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string }> & - Partial<"">; + Partial<''> /** @description An integer amount in %s that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice. */ - balance?: number; - coupon?: string; + balance?: number + coupon?: string /** @description An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard. */ - description?: string; + description?: string /** @description Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers. */ - invoice_prefix?: string; + invoice_prefix?: string /** * customer_param * @description Default invoice settings for this customer. @@ -22486,139 +22293,138 @@ export interface operations { invoice_settings?: { custom_fields?: Partial< { - name: string; - value: string; + name: string + value: string }[] > & - Partial<"">; - default_payment_method?: string; - footer?: string; - }; + Partial<''> + default_payment_method?: string + footer?: string + } /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The customer's full name or business name. */ - name?: string; + name?: string /** @description The sequence to be used on the customer's next invoice. Defaults to 1. */ - next_invoice_sequence?: number; - payment_method?: string; + next_invoice_sequence?: number + payment_method?: string /** @description The customer's phone number. */ - phone?: string; + phone?: string /** @description Customer's preferred languages, ordered by preference. */ - preferred_locales?: string[]; + preferred_locales?: string[] /** @description The API ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount. */ - promotion_code?: string; + promotion_code?: string /** @description The customer's shipping information. Appears on invoices emailed to this customer. */ shipping?: Partial<{ /** optional_fields_address */ address: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - name: string; - phone?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + name: string + phone?: string }> & - Partial<"">; - source?: string; + Partial<''> + source?: string /** * tax_param * @description Tax details about the customer. */ tax?: { - ip_address?: Partial & Partial<"">; - }; + ip_address?: Partial & Partial<''> + } /** * @description The customer's tax exemption. One of `none`, `exempt`, or `reverse`. * @enum {string} */ - tax_exempt?: "" | "exempt" | "none" | "reverse"; + tax_exempt?: '' | 'exempt' | 'none' | 'reverse' /** @description The customer's tax IDs. */ tax_id_data?: { /** @enum {string} */ type: - | "ae_trn" - | "au_abn" - | "au_arn" - | "br_cnpj" - | "br_cpf" - | "ca_bn" - | "ca_gst_hst" - | "ca_pst_bc" - | "ca_pst_mb" - | "ca_pst_sk" - | "ca_qst" - | "ch_vat" - | "cl_tin" - | "es_cif" - | "eu_vat" - | "gb_vat" - | "ge_vat" - | "hk_br" - | "id_npwp" - | "il_vat" - | "in_gst" - | "is_vat" - | "jp_cn" - | "jp_rn" - | "kr_brn" - | "li_uid" - | "mx_rfc" - | "my_frp" - | "my_itn" - | "my_sst" - | "no_vat" - | "nz_gst" - | "ru_inn" - | "ru_kpp" - | "sa_vat" - | "sg_gst" - | "sg_uen" - | "th_vat" - | "tw_vat" - | "ua_vat" - | "us_ein" - | "za_vat"; - value: string; - }[]; - }; - }; - }; - }; + | 'ae_trn' + | 'au_abn' + | 'au_arn' + | 'br_cnpj' + | 'br_cpf' + | 'ca_bn' + | 'ca_gst_hst' + | 'ca_pst_bc' + | 'ca_pst_mb' + | 'ca_pst_sk' + | 'ca_qst' + | 'ch_vat' + | 'cl_tin' + | 'es_cif' + | 'eu_vat' + | 'gb_vat' + | 'ge_vat' + | 'hk_br' + | 'id_npwp' + | 'il_vat' + | 'in_gst' + | 'is_vat' + | 'jp_cn' + | 'jp_rn' + | 'kr_brn' + | 'li_uid' + | 'mx_rfc' + | 'my_frp' + | 'my_itn' + | 'my_sst' + | 'no_vat' + | 'nz_gst' + | 'ru_inn' + | 'ru_kpp' + | 'sa_vat' + | 'sg_gst' + | 'sg_uen' + | 'th_vat' + | 'tw_vat' + | 'ua_vat' + | 'us_ein' + | 'za_vat' + value: string + }[] + } + } + } + } /**

Retrieves a Customer object.

*/ GetCustomersCustomer: { parameters: { path: { - customer: string; - }; + customer: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": Partial & - Partial; - }; - }; + 'application/json': Partial & Partial + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the source parameter, that becomes the customer’s active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the source parameter: for each of the customer’s current subscriptions, if the subscription bills automatically and is in the past_due state, then the latest open invoice for the subscription with automatic collection enabled will be retried. This retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice. Changing the default_source for a customer will not trigger this behavior.

* @@ -22627,76 +22433,76 @@ export interface operations { PostCustomersCustomer: { parameters: { path: { - customer: string; - }; - }; + customer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["customer"]; - }; - }; + 'application/json': components['schemas']['customer'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The customer's address. */ address?: Partial<{ - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string }> & - Partial<"">; + Partial<''> /** @description An integer amount in %s that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice. */ - balance?: number; + balance?: number /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ bank_account?: Partial<{ - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; - country: string; - currency?: string; + account_holder_type?: 'company' | 'individual' + account_number: string + country: string + currency?: string /** @enum {string} */ - object?: "bank_account"; - routing_number?: string; + object?: 'bank_account' + routing_number?: string }> & - Partial; + Partial /** @description A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js). */ card?: Partial<{ - address_city?: string; - address_country?: string; - address_line1?: string; - address_line2?: string; - address_state?: string; - address_zip?: string; - cvc?: string; - exp_month: number; - exp_year: number; - metadata?: { [key: string]: string }; - name?: string; - number: string; + address_city?: string + address_country?: string + address_line1?: string + address_line2?: string + address_state?: string + address_zip?: string + cvc?: string + exp_month: number + exp_year: number + metadata?: { [key: string]: string } + name?: string + number: string /** @enum {string} */ - object?: "card"; + object?: 'card' }> & - Partial; - coupon?: string; + Partial + coupon?: string /** @description ID of Alipay account to make the customer's new default for invoice payments. */ - default_alipay_account?: string; + default_alipay_account?: string /** @description ID of bank account to make the customer's new default for invoice payments. */ - default_bank_account?: string; + default_bank_account?: string /** @description ID of card to make the customer's new default for invoice payments. */ - default_card?: string; + default_card?: string /** * @description If you are using payment methods created via the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method) parameter. * @@ -22704,15 +22510,15 @@ export interface operations { * * If you want to add a new payment source and make it the default, see the [source](https://stripe.com/docs/api/customers/update#update_customer-source) property. */ - default_source?: string; + default_source?: string /** @description An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard. */ - description?: string; + description?: string /** @description Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers. */ - invoice_prefix?: string; + invoice_prefix?: string /** * customer_param * @description Default invoice settings for this customer. @@ -22720,290 +22526,290 @@ export interface operations { invoice_settings?: { custom_fields?: Partial< { - name: string; - value: string; + name: string + value: string }[] > & - Partial<"">; - default_payment_method?: string; - footer?: string; - }; + Partial<''> + default_payment_method?: string + footer?: string + } /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The customer's full name or business name. */ - name?: string; + name?: string /** @description The sequence to be used on the customer's next invoice. Defaults to 1. */ - next_invoice_sequence?: number; + next_invoice_sequence?: number /** @description The customer's phone number. */ - phone?: string; + phone?: string /** @description Customer's preferred languages, ordered by preference. */ - preferred_locales?: string[]; + preferred_locales?: string[] /** @description The API ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount. */ - promotion_code?: string; + promotion_code?: string /** @description The customer's shipping information. Appears on invoices emailed to this customer. */ shipping?: Partial<{ /** optional_fields_address */ address: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - name: string; - phone?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + name: string + phone?: string }> & - Partial<"">; - source?: string; + Partial<''> + source?: string /** * tax_param * @description Tax details about the customer. */ tax?: { - ip_address?: Partial & Partial<"">; - }; + ip_address?: Partial & Partial<''> + } /** * @description The customer's tax exemption. One of `none`, `exempt`, or `reverse`. * @enum {string} */ - tax_exempt?: "" | "exempt" | "none" | "reverse"; + tax_exempt?: '' | 'exempt' | 'none' | 'reverse' /** @description Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. */ - trial_end?: Partial<"now"> & Partial; - }; - }; - }; - }; + trial_end?: Partial<'now'> & Partial + } + } + } + } /**

Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.

*/ DeleteCustomersCustomer: { parameters: { path: { - customer: string; - }; - }; + customer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_customer"]; - }; - }; + 'application/json': components['schemas']['deleted_customer'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of transactions that updated the customer’s balances.

*/ GetCustomersCustomerBalanceTransactions: { parameters: { path: { - customer: string; - }; + customer: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["customer_balance_transaction"][]; + data: components['schemas']['customer_balance_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates an immutable transaction that updates the customer’s credit balance.

*/ PostCustomersCustomerBalanceTransactions: { parameters: { path: { - customer: string; - }; - }; + customer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["customer_balance_transaction"]; - }; - }; + 'application/json': components['schemas']['customer_balance_transaction'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The integer amount in **%s** to apply to the customer's credit balance. */ - amount: number; + amount: number /** @description 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 the customer's [`currency`](https://stripe.com/docs/api/customers/object#customer_object-currency) is set, this value must match it. If the customer's `currency` is not set, it will be updated to this value. */ - currency: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Retrieves a specific customer balance transaction that updated the customer’s balances.

*/ GetCustomersCustomerBalanceTransactionsTransaction: { parameters: { path: { - customer: string; - transaction: string; - }; + customer: string + transaction: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["customer_balance_transaction"]; - }; - }; + 'application/json': components['schemas']['customer_balance_transaction'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Most credit balance transaction fields are immutable, but you may update its description and metadata.

*/ PostCustomersCustomerBalanceTransactionsTransaction: { parameters: { path: { - customer: string; - transaction: string; - }; - }; + customer: string + transaction: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["customer_balance_transaction"]; - }; - }; + 'application/json': components['schemas']['customer_balance_transaction'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

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.

*/ GetCustomersCustomerBankAccounts: { parameters: { path: { - customer: string; - }; + customer: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["bank_account"][]; + data: components['schemas']['bank_account'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

When you create a new credit card, you must specify a customer or recipient on which to create it.

* @@ -23014,241 +22820,240 @@ export interface operations { PostCustomersCustomerBankAccounts: { parameters: { path: { - customer: string; - }; - }; + customer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_source"]; - }; - }; + 'application/json': components['schemas']['payment_source'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A token returned by [Stripe.js](https://stripe.com/docs/js) representing the user’s Alipay account details. */ - alipay_account?: string; + alipay_account?: string /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ bank_account?: Partial<{ - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; - country: string; - currency?: string; + account_holder_type?: 'company' | 'individual' + account_number: string + country: string + currency?: string /** @enum {string} */ - object?: "bank_account"; - routing_number?: string; + object?: 'bank_account' + routing_number?: string }> & - Partial; + Partial /** @description A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js). */ card?: Partial<{ - address_city?: string; - address_country?: string; - address_line1?: string; - address_line2?: string; - address_state?: string; - address_zip?: string; - cvc?: string; - exp_month: number; - exp_year: number; - metadata?: { [key: string]: string }; - name?: string; - number: string; + address_city?: string + address_country?: string + address_line1?: string + address_line2?: string + address_state?: string + address_zip?: string + cvc?: string + exp_month: number + exp_year: number + metadata?: { [key: string]: string } + name?: string + number: string /** @enum {string} */ - object?: "card"; + object?: 'card' }> & - Partial; + Partial /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - source?: string; - }; - }; - }; - }; + source?: string + } + } + } + } /**

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.

*/ GetCustomersCustomerBankAccountsId: { parameters: { path: { - customer: string; - id: string; - }; + customer: string + id: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["bank_account"]; - }; - }; + 'application/json': components['schemas']['bank_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Update a specified source for a given customer.

*/ PostCustomersCustomerBankAccountsId: { parameters: { path: { - customer: string; - id: string; - }; - }; + customer: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": Partial & - Partial & - Partial; - }; - }; + 'application/json': Partial & + Partial & + Partial + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The name of the person or business that owns the bank account. */ - account_holder_name?: string; + account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - account_holder_type?: "company" | "individual"; + account_holder_type?: 'company' | 'individual' /** @description City/District/Suburb/Town/Village. */ - address_city?: string; + address_city?: string /** @description Billing address country, if provided when creating card. */ - address_country?: string; + address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - address_line1?: string; + address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - address_line2?: string; + address_line2?: string /** @description State/County/Province/Region. */ - address_state?: string; + address_state?: string /** @description ZIP or postal code. */ - address_zip?: string; + address_zip?: string /** @description Two digit number representing the card’s expiration month. */ - exp_month?: string; + exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - exp_year?: string; + exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Cardholder name. */ - name?: string; + name?: string /** owner */ owner?: { /** source_address */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - email?: string; - name?: string; - phone?: string; - }; - }; - }; - }; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + email?: string + name?: string + phone?: string + } + } + } + } + } /**

Delete a specified source for a given customer.

*/ DeleteCustomersCustomerBankAccountsId: { parameters: { path: { - customer: string; - id: string; - }; - }; + customer: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": Partial & - Partial; - }; - }; + 'application/json': Partial & Partial + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Verify a specified bank account for a given customer.

*/ PostCustomersCustomerBankAccountsIdVerify: { parameters: { path: { - customer: string; - id: string; - }; - }; + customer: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["bank_account"]; - }; - }; + 'application/json': components['schemas']['bank_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account. */ - amounts?: number[]; + amounts?: number[] /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /** *

You can see a list of the cards belonging to a customer. * Note that the 10 most recent sources are always available on the Customer object. @@ -23257,50 +23062,50 @@ export interface operations { GetCustomersCustomerCards: { parameters: { path: { - customer: string; - }; + customer: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["card"][]; + 'application/json': { + data: components['schemas']['card'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

When you create a new credit card, you must specify a customer or recipient on which to create it.

* @@ -23311,389 +23116,388 @@ export interface operations { PostCustomersCustomerCards: { parameters: { path: { - customer: string; - }; - }; + customer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_source"]; - }; - }; + 'application/json': components['schemas']['payment_source'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A token returned by [Stripe.js](https://stripe.com/docs/js) representing the user’s Alipay account details. */ - alipay_account?: string; + alipay_account?: string /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ bank_account?: Partial<{ - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; - country: string; - currency?: string; + account_holder_type?: 'company' | 'individual' + account_number: string + country: string + currency?: string /** @enum {string} */ - object?: "bank_account"; - routing_number?: string; + object?: 'bank_account' + routing_number?: string }> & - Partial; + Partial /** @description A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js). */ card?: Partial<{ - address_city?: string; - address_country?: string; - address_line1?: string; - address_line2?: string; - address_state?: string; - address_zip?: string; - cvc?: string; - exp_month: number; - exp_year: number; - metadata?: { [key: string]: string }; - name?: string; - number: string; + address_city?: string + address_country?: string + address_line1?: string + address_line2?: string + address_state?: string + address_zip?: string + cvc?: string + exp_month: number + exp_year: number + metadata?: { [key: string]: string } + name?: string + number: string /** @enum {string} */ - object?: "card"; + object?: 'card' }> & - Partial; + Partial /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - source?: string; - }; - }; - }; - }; + source?: string + } + } + } + } /**

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.

*/ GetCustomersCustomerCardsId: { parameters: { path: { - customer: string; - id: string; - }; + customer: string + id: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["card"]; - }; - }; + 'application/json': components['schemas']['card'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Update a specified source for a given customer.

*/ PostCustomersCustomerCardsId: { parameters: { path: { - customer: string; - id: string; - }; - }; + customer: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": Partial & - Partial & - Partial; - }; - }; + 'application/json': Partial & + Partial & + Partial + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The name of the person or business that owns the bank account. */ - account_holder_name?: string; + account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - account_holder_type?: "company" | "individual"; + account_holder_type?: 'company' | 'individual' /** @description City/District/Suburb/Town/Village. */ - address_city?: string; + address_city?: string /** @description Billing address country, if provided when creating card. */ - address_country?: string; + address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - address_line1?: string; + address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - address_line2?: string; + address_line2?: string /** @description State/County/Province/Region. */ - address_state?: string; + address_state?: string /** @description ZIP or postal code. */ - address_zip?: string; + address_zip?: string /** @description Two digit number representing the card’s expiration month. */ - exp_month?: string; + exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - exp_year?: string; + exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Cardholder name. */ - name?: string; + name?: string /** owner */ owner?: { /** source_address */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - email?: string; - name?: string; - phone?: string; - }; - }; - }; - }; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + email?: string + name?: string + phone?: string + } + } + } + } + } /**

Delete a specified source for a given customer.

*/ DeleteCustomersCustomerCardsId: { parameters: { path: { - customer: string; - id: string; - }; - }; + customer: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": Partial & - Partial; - }; - }; + 'application/json': Partial & Partial + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } GetCustomersCustomerDiscount: { parameters: { path: { - customer: string; - }; + customer: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["discount"]; - }; - }; + 'application/json': components['schemas']['discount'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Removes the currently applied discount on a customer.

*/ DeleteCustomersCustomerDiscount: { parameters: { path: { - customer: string; - }; - }; + customer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_discount"]; - }; - }; + 'application/json': components['schemas']['deleted_discount'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of PaymentMethods for a given Customer

*/ GetCustomersCustomerPaymentMethods: { parameters: { path: { - customer: string; - }; + customer: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** A required filter on the list, based on the object `type` field. */ type: - | "acss_debit" - | "afterpay_clearpay" - | "alipay" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "eps" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "klarna" - | "oxxo" - | "p24" - | "sepa_debit" - | "sofort" - | "wechat_pay"; - }; - }; - responses: { - /** Successful response. */ - 200: { - content: { - "application/json": { - data: components["schemas"]["payment_method"][]; + | 'acss_debit' + | 'afterpay_clearpay' + | 'alipay' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'eps' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'klarna' + | 'oxxo' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' + } + } + responses: { + /** Successful response. */ + 200: { + content: { + 'application/json': { + data: components['schemas']['payment_method'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

List sources for a specified customer.

*/ GetCustomersCustomerSources: { parameters: { path: { - customer: string; - }; + customer: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Filter sources according to a particular object type. */ - object?: string; + object?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: (Partial & - Partial & - Partial & - Partial & - Partial)[]; + data: (Partial & + Partial & + Partial & + Partial & + Partial)[] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

When you create a new credit card, you must specify a customer or recipient on which to create it.

* @@ -23704,410 +23508,409 @@ export interface operations { PostCustomersCustomerSources: { parameters: { path: { - customer: string; - }; - }; + customer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_source"]; - }; - }; + 'application/json': components['schemas']['payment_source'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A token returned by [Stripe.js](https://stripe.com/docs/js) representing the user’s Alipay account details. */ - alipay_account?: string; + alipay_account?: string /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ bank_account?: Partial<{ - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; - country: string; - currency?: string; + account_holder_type?: 'company' | 'individual' + account_number: string + country: string + currency?: string /** @enum {string} */ - object?: "bank_account"; - routing_number?: string; + object?: 'bank_account' + routing_number?: string }> & - Partial; + Partial /** @description A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js). */ card?: Partial<{ - address_city?: string; - address_country?: string; - address_line1?: string; - address_line2?: string; - address_state?: string; - address_zip?: string; - cvc?: string; - exp_month: number; - exp_year: number; - metadata?: { [key: string]: string }; - name?: string; - number: string; + address_city?: string + address_country?: string + address_line1?: string + address_line2?: string + address_state?: string + address_zip?: string + cvc?: string + exp_month: number + exp_year: number + metadata?: { [key: string]: string } + name?: string + number: string /** @enum {string} */ - object?: "card"; + object?: 'card' }> & - Partial; + Partial /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ - source?: string; - }; - }; - }; - }; + source?: string + } + } + } + } /**

Retrieve a specified source for a given customer.

*/ GetCustomersCustomerSourcesId: { parameters: { path: { - customer: string; - id: string; - }; + customer: string + id: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_source"]; - }; - }; + 'application/json': components['schemas']['payment_source'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Update a specified source for a given customer.

*/ PostCustomersCustomerSourcesId: { parameters: { path: { - customer: string; - id: string; - }; - }; + customer: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": Partial & - Partial & - Partial; - }; - }; + 'application/json': Partial & + Partial & + Partial + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The name of the person or business that owns the bank account. */ - account_holder_name?: string; + account_holder_name?: string /** * @description The type of entity that holds the account. This can be either `individual` or `company`. * @enum {string} */ - account_holder_type?: "company" | "individual"; + account_holder_type?: 'company' | 'individual' /** @description City/District/Suburb/Town/Village. */ - address_city?: string; + address_city?: string /** @description Billing address country, if provided when creating card. */ - address_country?: string; + address_country?: string /** @description Address line 1 (Street address/PO Box/Company name). */ - address_line1?: string; + address_line1?: string /** @description Address line 2 (Apartment/Suite/Unit/Building). */ - address_line2?: string; + address_line2?: string /** @description State/County/Province/Region. */ - address_state?: string; + address_state?: string /** @description ZIP or postal code. */ - address_zip?: string; + address_zip?: string /** @description Two digit number representing the card’s expiration month. */ - exp_month?: string; + exp_month?: string /** @description Four digit number representing the card’s expiration year. */ - exp_year?: string; + exp_year?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Cardholder name. */ - name?: string; + name?: string /** owner */ owner?: { /** source_address */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - email?: string; - name?: string; - phone?: string; - }; - }; - }; - }; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + email?: string + name?: string + phone?: string + } + } + } + } + } /**

Delete a specified source for a given customer.

*/ DeleteCustomersCustomerSourcesId: { parameters: { path: { - customer: string; - id: string; - }; - }; + customer: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": Partial & - Partial; - }; - }; + 'application/json': Partial & Partial + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Verify a specified bank account for a given customer.

*/ PostCustomersCustomerSourcesIdVerify: { parameters: { path: { - customer: string; - id: string; - }; - }; + customer: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["bank_account"]; - }; - }; + 'application/json': components['schemas']['bank_account'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account. */ - amounts?: number[]; + amounts?: number[] /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

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.

*/ GetCustomersCustomerSubscriptions: { parameters: { path: { - customer: string; - }; + customer: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["subscription"][]; + data: components['schemas']['subscription'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new subscription on an existing customer.

*/ PostCustomersCustomerSubscriptions: { parameters: { path: { - customer: string; - }; - }; + customer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription"]; - }; - }; + 'application/json': components['schemas']['subscription'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A list of prices and quantities that will generate invoice items appended to the first invoice for this subscription. You may pass up to 20 items. */ add_invoice_items?: { - price?: string; + price?: string /** one_time_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). */ - application_fee_percent?: number; + application_fee_percent?: number /** * automatic_tax_config * @description Automatic tax settings for this subscription. */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** * Format: unix-time * @description For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor. */ - backdate_start_date?: number; + backdate_start_date?: number /** * Format: unix-time * @description 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. */ - billing_cycle_anchor?: number; + billing_cycle_anchor?: number /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. */ billing_thresholds?: Partial<{ - amount_gte?: number; - reset_billing_cycle_anchor?: boolean; + amount_gte?: number + reset_billing_cycle_anchor?: boolean }> & - Partial<"">; + Partial<''> /** * Format: unix-time * @description 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. */ - cancel_at?: number; + cancel_at?: number /** @description Boolean indicating whether this subscription should cancel at the end of the current period. */ - cancel_at_period_end?: boolean; + cancel_at_period_end?: boolean /** * @description 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. Defaults to `charge_automatically`. * @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' /** @description The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. */ - coupon?: string; + coupon?: string /** @description Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. */ - days_until_due?: number; + days_until_due?: number /** @description 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?: string; + default_payment_method?: string /** @description 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?: string; + default_source?: string /** @description 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?: Partial & Partial<"">; + default_tax_rates?: Partial & Partial<''> /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A list of up to 20 subscription items, each with an attached price. */ items?: { billing_thresholds?: Partial<{ - usage_gte: number; + usage_gte: number }> & - Partial<"">; - metadata?: { [key: string]: string }; - price?: string; + Partial<''> + metadata?: { [key: string]: string } + price?: string /** recurring_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. */ - off_session?: boolean; + off_session?: boolean /** * @description Use `allow_incomplete` to create subscriptions with `status=incomplete` if the first invoice cannot be paid. Creating subscriptions with this status allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * @@ -24118,11 +23921,7 @@ export interface operations { * `pending_if_incomplete` is only used with updates and cannot be passed when creating a subscription. * @enum {string} */ - payment_behavior?: - | "allow_incomplete" - | "default_incomplete" - | "error_if_incomplete" - | "pending_if_incomplete"; + payment_behavior?: 'allow_incomplete' | 'default_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete' /** * payment_settings * @description Payment settings to pass to invoices created by the subscription. @@ -24134,241 +23933,241 @@ export interface operations { /** mandate_options_param */ mandate_options?: { /** @enum {string} */ - transaction_type?: "business" | "personal"; - }; + transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; + verification_method?: 'automatic' | 'instant' | 'microdeposits' }> & - Partial<"">; + Partial<''> bancontact?: Partial<{ /** @enum {string} */ - preferred_language?: "de" | "en" | "fr" | "nl"; + preferred_language?: 'de' | 'en' | 'fr' | 'nl' }> & - Partial<"">; + Partial<''> card?: Partial<{ /** mandate_options_param */ mandate_options?: { - amount?: number; + amount?: number /** @enum {string} */ - amount_type?: "fixed" | "maximum"; - description?: string; - }; + amount_type?: 'fixed' | 'maximum' + description?: string + } /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: 'any' | 'automatic' }> & - Partial<"">; - }; + Partial<''> + } payment_method_types?: Partial< ( - | "ach_credit_transfer" - | "ach_debit" - | "acss_debit" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "sepa_debit" - | "sofort" - | "wechat_pay" + | 'ach_credit_transfer' + | 'ach_debit' + | 'acss_debit' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' )[] > & - Partial<"">; - }; + Partial<''> + } /** @description 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?: Partial<{ /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number }> & - Partial<"">; + Partial<''> /** @description The API ID of a promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. */ - promotion_code?: string; + promotion_code?: string /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) resulting from the `billing_cycle_anchor`. Valid values are `create_prorations` or `none`. * * Passing `create_prorations` will cause proration invoice items to be created when applicable. Prorations can be disabled by passing `none`. If no value is passed, the default is `create_prorations`. * @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** * transfer_data_specs * @description If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. */ transfer_data?: { - amount_percent?: number; - destination: string; - }; + amount_percent?: number + destination: string + } /** @description Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. */ - trial_end?: Partial<"now"> & Partial; + trial_end?: Partial<'now'> & Partial /** @description 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?: boolean; + trial_from_plan?: boolean /** @description Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. */ - trial_period_days?: number; - }; - }; - }; - }; + trial_period_days?: number + } + } + } + } /**

Retrieves the subscription with the given ID.

*/ GetCustomersCustomerSubscriptionsSubscriptionExposedId: { parameters: { path: { - customer: string; - subscription_exposed_id: string; - }; + customer: string + subscription_exposed_id: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription"]; - }; - }; + 'application/json': components['schemas']['subscription'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostCustomersCustomerSubscriptionsSubscriptionExposedId: { parameters: { path: { - customer: string; - subscription_exposed_id: string; - }; - }; + customer: string + subscription_exposed_id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription"]; - }; - }; + 'application/json': components['schemas']['subscription'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A list of prices and quantities that will generate invoice items appended to the first invoice for this subscription. You may pass up to 20 items. */ add_invoice_items?: { - price?: string; + price?: string /** one_time_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). */ - application_fee_percent?: number; + application_fee_percent?: number /** * automatic_tax_config * @description Automatic tax settings for this subscription. */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** * @description Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). * @enum {string} */ - billing_cycle_anchor?: "now" | "unchanged"; + billing_cycle_anchor?: 'now' | 'unchanged' /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. */ billing_thresholds?: Partial<{ - amount_gte?: number; - reset_billing_cycle_anchor?: boolean; + amount_gte?: number + reset_billing_cycle_anchor?: boolean }> & - Partial<"">; + Partial<''> /** @description 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. */ - cancel_at?: Partial & Partial<"">; + cancel_at?: Partial & Partial<''> /** @description Boolean indicating whether this subscription should cancel at the end of the current period. */ - cancel_at_period_end?: boolean; + cancel_at_period_end?: boolean /** * @description 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. Defaults to `charge_automatically`. * @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' /** @description The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. */ - coupon?: string; + coupon?: string /** @description Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. */ - days_until_due?: number; + days_until_due?: number /** @description 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?: string; + default_payment_method?: string /** @description 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?: string; + default_source?: string /** @description 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. Pass an empty string to remove previously-defined tax rates. */ - default_tax_rates?: Partial & Partial<"">; + default_tax_rates?: Partial & Partial<''> /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A list of up to 20 subscription items, each with an attached price. */ items?: { billing_thresholds?: Partial<{ - usage_gte: number; + usage_gte: number }> & - Partial<"">; - clear_usage?: boolean; - deleted?: boolean; - id?: string; - metadata?: Partial<{ [key: string]: string }> & Partial<"">; - price?: string; + Partial<''> + clear_usage?: boolean + deleted?: boolean + id?: string + metadata?: Partial<{ [key: string]: string }> & Partial<''> + price?: string /** recurring_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. */ - off_session?: boolean; + off_session?: boolean /** @description If specified, payment collection for this subscription will be paused. */ pause_collection?: Partial<{ /** @enum {string} */ - behavior: "keep_as_draft" | "mark_uncollectible" | "void"; + behavior: 'keep_as_draft' | 'mark_uncollectible' | 'void' /** Format: unix-time */ - resumes_at?: number; + resumes_at?: number }> & - Partial<"">; + Partial<''> /** * @description Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * @@ -24379,11 +24178,7 @@ export interface operations { * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. * @enum {string} */ - payment_behavior?: - | "allow_incomplete" - | "default_incomplete" - | "error_if_incomplete" - | "pending_if_incomplete"; + payment_behavior?: 'allow_incomplete' | 'default_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete' /** * payment_settings * @description Payment settings to pass to invoices created by the subscription. @@ -24395,60 +24190,60 @@ export interface operations { /** mandate_options_param */ mandate_options?: { /** @enum {string} */ - transaction_type?: "business" | "personal"; - }; + transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; + verification_method?: 'automatic' | 'instant' | 'microdeposits' }> & - Partial<"">; + Partial<''> bancontact?: Partial<{ /** @enum {string} */ - preferred_language?: "de" | "en" | "fr" | "nl"; + preferred_language?: 'de' | 'en' | 'fr' | 'nl' }> & - Partial<"">; + Partial<''> card?: Partial<{ /** mandate_options_param */ mandate_options?: { - amount?: number; + amount?: number /** @enum {string} */ - amount_type?: "fixed" | "maximum"; - description?: string; - }; + amount_type?: 'fixed' | 'maximum' + description?: string + } /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: 'any' | 'automatic' }> & - Partial<"">; - }; + Partial<''> + } payment_method_types?: Partial< ( - | "ach_credit_transfer" - | "ach_debit" - | "acss_debit" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "sepa_debit" - | "sofort" - | "wechat_pay" + | 'ach_credit_transfer' + | 'ach_debit' + | 'acss_debit' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' )[] > & - Partial<"">; - }; + Partial<''> + } /** @description 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?: Partial<{ /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number }> & - Partial<"">; + Partial<''> /** @description The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. */ - promotion_code?: string; + promotion_code?: string /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -24457,26 +24252,26 @@ export interface operations { * Prorations can be disabled by passing `none`. * @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** * Format: unix-time * @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations. */ - proration_date?: number; + proration_date?: number /** @description If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. This will be unset if you POST an empty value. */ transfer_data?: Partial<{ - amount_percent?: number; - destination: string; + amount_percent?: number + destination: string }> & - Partial<"">; + Partial<''> /** @description Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. */ - trial_end?: Partial<"now"> & Partial; + trial_end?: Partial<'now'> & Partial /** @description 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?: boolean; - }; - }; - }; - }; + trial_from_plan?: boolean + } + } + } + } /** *

Cancels a customer’s subscription. If you set the at_period_end parameter to true, the subscription will remain active until the end of the period, at which point it will be canceled and not renewed. Otherwise, with the default false value, the subscription is terminated immediately. In either case, the customer will not be charged again for the subscription.

* @@ -24487,371 +24282,371 @@ export interface operations { DeleteCustomersCustomerSubscriptionsSubscriptionExposedId: { parameters: { path: { - customer: string; - subscription_exposed_id: string; - }; - }; + customer: string + subscription_exposed_id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription"]; - }; - }; + 'application/json': components['schemas']['subscription'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Can be set to `true` if `at_period_end` is not set to `true`. Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items. */ - invoice_now?: boolean; + invoice_now?: boolean /** @description Can be set to `true` if `at_period_end` is not set to `true`. Will generate a proration invoice item that credits remaining unused time until the subscription period end. */ - prorate?: boolean; - }; - }; - }; - }; + prorate?: boolean + } + } + } + } GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount: { parameters: { path: { - customer: string; - subscription_exposed_id: string; - }; + customer: string + subscription_exposed_id: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["discount"]; - }; - }; + 'application/json': components['schemas']['discount'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Removes the currently applied discount on a customer.

*/ DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount: { parameters: { path: { - customer: string; - subscription_exposed_id: string; - }; - }; + customer: string + subscription_exposed_id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_discount"]; - }; - }; + 'application/json': components['schemas']['deleted_discount'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of tax IDs for a customer.

*/ GetCustomersCustomerTaxIds: { parameters: { path: { - customer: string; - }; + customer: string + } query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["tax_id"][]; + data: components['schemas']['tax_id'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new TaxID object for a customer.

*/ PostCustomersCustomerTaxIds: { parameters: { path: { - customer: string; - }; - }; + customer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["tax_id"]; - }; - }; + 'application/json': components['schemas']['tax_id'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * @description Type of the tax ID, one of `ae_trn`, `au_abn`, `au_arn`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `es_cif`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `th_vat`, `tw_vat`, `ua_vat`, `us_ein`, or `za_vat` * @enum {string} */ type: - | "ae_trn" - | "au_abn" - | "au_arn" - | "br_cnpj" - | "br_cpf" - | "ca_bn" - | "ca_gst_hst" - | "ca_pst_bc" - | "ca_pst_mb" - | "ca_pst_sk" - | "ca_qst" - | "ch_vat" - | "cl_tin" - | "es_cif" - | "eu_vat" - | "gb_vat" - | "ge_vat" - | "hk_br" - | "id_npwp" - | "il_vat" - | "in_gst" - | "is_vat" - | "jp_cn" - | "jp_rn" - | "kr_brn" - | "li_uid" - | "mx_rfc" - | "my_frp" - | "my_itn" - | "my_sst" - | "no_vat" - | "nz_gst" - | "ru_inn" - | "ru_kpp" - | "sa_vat" - | "sg_gst" - | "sg_uen" - | "th_vat" - | "tw_vat" - | "ua_vat" - | "us_ein" - | "za_vat"; + | 'ae_trn' + | 'au_abn' + | 'au_arn' + | 'br_cnpj' + | 'br_cpf' + | 'ca_bn' + | 'ca_gst_hst' + | 'ca_pst_bc' + | 'ca_pst_mb' + | 'ca_pst_sk' + | 'ca_qst' + | 'ch_vat' + | 'cl_tin' + | 'es_cif' + | 'eu_vat' + | 'gb_vat' + | 'ge_vat' + | 'hk_br' + | 'id_npwp' + | 'il_vat' + | 'in_gst' + | 'is_vat' + | 'jp_cn' + | 'jp_rn' + | 'kr_brn' + | 'li_uid' + | 'mx_rfc' + | 'my_frp' + | 'my_itn' + | 'my_sst' + | 'no_vat' + | 'nz_gst' + | 'ru_inn' + | 'ru_kpp' + | 'sa_vat' + | 'sg_gst' + | 'sg_uen' + | 'th_vat' + | 'tw_vat' + | 'ua_vat' + | 'us_ein' + | 'za_vat' /** @description Value of the tax ID. */ - value: string; - }; - }; - }; - }; + value: string + } + } + } + } /**

Retrieves the TaxID object with the given identifier.

*/ GetCustomersCustomerTaxIdsId: { parameters: { path: { - customer: string; - id: string; - }; + customer: string + id: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["tax_id"]; - }; - }; + 'application/json': components['schemas']['tax_id'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Deletes an existing TaxID object.

*/ DeleteCustomersCustomerTaxIdsId: { parameters: { path: { - customer: string; - id: string; - }; - }; + customer: string + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_tax_id"]; - }; - }; + 'application/json': components['schemas']['deleted_tax_id'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of your disputes.

*/ GetDisputes: { parameters: { query: { /** Only return disputes associated to the charge specified by this charge ID. */ - charge?: string; + charge?: string created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return disputes associated to the PaymentIntent specified by this PaymentIntent ID. */ - payment_intent?: string; + payment_intent?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["dispute"][]; + 'application/json': { + data: components['schemas']['dispute'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves the dispute with the given ID.

*/ GetDisputesDispute: { parameters: { path: { - dispute: string; - }; + dispute: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["dispute"]; - }; - }; + 'application/json': components['schemas']['dispute'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

When you get a dispute, contacting your customer is always the best first step. If that doesn’t work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your dashboard, but if you prefer, you can use the API to submit evidence programmatically.

* @@ -24860,69 +24655,69 @@ export interface operations { PostDisputesDispute: { parameters: { path: { - dispute: string; - }; - }; + dispute: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["dispute"]; - }; - }; + 'application/json': components['schemas']['dispute'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * dispute_evidence_params * @description Evidence to upload, to respond to a dispute. Updating any field in the hash will submit all fields in the hash for review. The combined character count of all fields is limited to 150,000. */ evidence?: { - access_activity_log?: string; - billing_address?: string; - cancellation_policy?: string; - cancellation_policy_disclosure?: string; - cancellation_rebuttal?: string; - customer_communication?: string; - customer_email_address?: string; - customer_name?: string; - customer_purchase_ip?: string; - customer_signature?: string; - duplicate_charge_documentation?: string; - duplicate_charge_explanation?: string; - duplicate_charge_id?: string; - product_description?: string; - receipt?: string; - refund_policy?: string; - refund_policy_disclosure?: string; - refund_refusal_explanation?: string; - service_date?: string; - service_documentation?: string; - shipping_address?: string; - shipping_carrier?: string; - shipping_date?: string; - shipping_documentation?: string; - shipping_tracking_number?: string; - uncategorized_file?: string; - uncategorized_text?: string; - }; + access_activity_log?: string + billing_address?: string + cancellation_policy?: string + cancellation_policy_disclosure?: string + cancellation_rebuttal?: string + customer_communication?: string + customer_email_address?: string + customer_name?: string + customer_purchase_ip?: string + customer_signature?: string + duplicate_charge_documentation?: string + duplicate_charge_explanation?: string + duplicate_charge_id?: string + product_description?: string + receipt?: string + refund_policy?: string + refund_policy_disclosure?: string + refund_refusal_explanation?: string + service_date?: string + service_documentation?: string + shipping_address?: string + shipping_carrier?: string + shipping_date?: string + shipping_documentation?: string + shipping_tracking_number?: string + uncategorized_file?: string + uncategorized_text?: string + } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Whether to immediately submit evidence to the bank. If `false`, evidence is staged on the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank by making another request with this attribute set to `true` (the default). */ - submit?: boolean; - }; - }; - }; - }; + submit?: boolean + } + } + } + } /** *

Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.

* @@ -24931,479 +24726,479 @@ export interface operations { PostDisputesDisputeClose: { parameters: { path: { - dispute: string; - }; - }; + dispute: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["dispute"]; - }; - }; + 'application/json': components['schemas']['dispute'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Creates a short-lived API key for a given resource.

*/ PostEphemeralKeys: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["ephemeral_key"]; - }; - }; + 'application/json': components['schemas']['ephemeral_key'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The ID of the Customer you'd like to modify using the resulting ephemeral key. */ - customer?: string; + customer?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The ID of the Issuing Card you'd like to access using the resulting ephemeral key. */ - issuing_card?: string; - }; - }; - }; - }; + issuing_card?: string + } + } + } + } /**

Invalidates a short-lived API key for a given resource.

*/ DeleteEphemeralKeysKey: { parameters: { path: { - key: string; - }; - }; + key: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["ephemeral_key"]; - }; - }; + 'application/json': components['schemas']['ephemeral_key'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

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).

*/ GetEvents: { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** 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?: boolean; + delivery_success?: boolean /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** 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?: string; + type?: string /** 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?: string[]; - }; - }; + types?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["event"][]; + 'application/json': { + data: components['schemas']['event'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.

*/ GetEventsId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["event"]; - }; - }; + 'application/json': components['schemas']['event'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ GetExchangeRates: { parameters: { query: { /** 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** 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?: number; + limit?: number /** 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["exchange_rate"][]; + 'application/json': { + data: components['schemas']['exchange_rate'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves the exchange rates from the given currency to every supported currency.

*/ GetExchangeRatesRateId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - rate_id: string; - }; - }; + rate_id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["exchange_rate"]; - }; - }; + 'application/json': components['schemas']['exchange_rate'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of file links.

*/ GetFileLinks: { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** Filter links by their expiration status. By default, all links are returned. */ - expired?: boolean; + expired?: boolean /** Only return links for the given file. */ - file?: string; + file?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["file_link"][]; + 'application/json': { + data: components['schemas']['file_link'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new file link object.

*/ PostFileLinks: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["file_link"]; - }; - }; + 'application/json': components['schemas']['file_link'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * Format: unix-time * @description A future timestamp after which the link will no longer be usable. */ - expires_at?: number; + expires_at?: number /** @description The ID of the file. The file's `purpose` must be one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `finance_report_run`, `identity_document_downloadable`, `pci_document`, `selfie`, `sigma_scheduled_query`, or `tax_document_user_upload`. */ - file: string; + file: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Retrieves the file link with the given ID.

*/ GetFileLinksLink: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - link: string; - }; - }; + link: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["file_link"]; - }; - }; + 'application/json': components['schemas']['file_link'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates an existing file link object. Expired links can no longer be updated.

*/ PostFileLinksLink: { parameters: { path: { - link: string; - }; - }; + link: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["file_link"]; - }; - }; + 'application/json': components['schemas']['file_link'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A future timestamp after which the link will no longer be usable, or `now` to expire the link immediately. */ - expires_at?: Partial<"now"> & Partial & Partial<"">; + expires_at?: Partial<'now'> & Partial & Partial<''> /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Returns a list of the files that your account has access to. The files are returned sorted by creation date, with the most recently created files appearing first.

*/ GetFiles: { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** The file purpose to filter queries by. If none is provided, files will not be filtered by purpose. */ purpose?: - | "account_requirement" - | "additional_verification" - | "business_icon" - | "business_logo" - | "customer_signature" - | "dispute_evidence" - | "document_provider_identity_document" - | "finance_report_run" - | "identity_document" - | "identity_document_downloadable" - | "pci_document" - | "selfie" - | "sigma_scheduled_query" - | "tax_document_user_upload"; + | 'account_requirement' + | 'additional_verification' + | 'business_icon' + | 'business_logo' + | 'customer_signature' + | 'dispute_evidence' + | 'document_provider_identity_document' + | 'finance_report_run' + | 'identity_document' + | 'identity_document_downloadable' + | 'pci_document' + | 'selfie' + | 'sigma_scheduled_query' + | 'tax_document_user_upload' /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["file"][]; + 'application/json': { + data: components['schemas']['file'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

To upload a file to Stripe, you’ll need to send a request of type multipart/form-data. The request should contain the file you would like to upload, as well as the parameters for creating a file.

* @@ -25414,223 +25209,223 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["file"]; - }; - }; + 'application/json': components['schemas']['file'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "multipart/form-data": { + 'multipart/form-data': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A file to upload. The file should follow the specifications of RFC 2388 (which defines file transfers for the `multipart/form-data` protocol). */ - file: string; + file: string /** * file_link_creation_params * @description Optional parameters to automatically create a [file link](https://stripe.com/docs/api#file_links) for the newly created file. */ file_link_data?: { - create: boolean; + create: boolean /** Format: unix-time */ - expires_at?: number; - metadata?: Partial<{ [key: string]: string }> & Partial<"">; - }; + expires_at?: number + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } /** * @description The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file. * @enum {string} */ purpose: - | "account_requirement" - | "additional_verification" - | "business_icon" - | "business_logo" - | "customer_signature" - | "dispute_evidence" - | "identity_document" - | "pci_document" - | "tax_document_user_upload"; - }; - }; - }; - }; + | 'account_requirement' + | 'additional_verification' + | 'business_icon' + | 'business_logo' + | 'customer_signature' + | 'dispute_evidence' + | 'identity_document' + | 'pci_document' + | 'tax_document_user_upload' + } + } + } + } /**

Retrieves the details of an existing file object. Supply the unique file ID from a file, and Stripe will return the corresponding file object. To access file contents, see the File Upload Guide.

*/ GetFilesFile: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - file: string; - }; - }; + file: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["file"]; - }; - }; + 'application/json': components['schemas']['file'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

List all verification reports.

*/ GetIdentityVerificationReports: { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return VerificationReports of this type */ - type?: "document" | "id_number"; + type?: 'document' | 'id_number' /** Only return VerificationReports created by this VerificationSession ID. It is allowed to provide a VerificationIntent ID. */ - verification_session?: string; - }; - }; + verification_session?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["identity.verification_report"][]; + 'application/json': { + data: components['schemas']['identity.verification_report'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves an existing VerificationReport

*/ GetIdentityVerificationReportsReport: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - report: string; - }; - }; + report: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["identity.verification_report"]; - }; - }; + 'application/json': components['schemas']['identity.verification_report'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of VerificationSessions

*/ GetIdentityVerificationSessions: { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return VerificationSessions with this status. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work). */ - status?: "canceled" | "processing" | "requires_input" | "verified"; - }; - }; + status?: 'canceled' | 'processing' | 'requires_input' | 'verified' + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["identity.verification_session"][]; + 'application/json': { + data: components['schemas']['identity.verification_session'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Creates a VerificationSession object.

* @@ -25645,47 +25440,47 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["identity.verification_session"]; - }; - }; + 'application/json': components['schemas']['identity.verification_session'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * session_options_param * @description A set of options for the session’s verification checks. */ options?: { document?: Partial<{ - allowed_types?: ("driving_license" | "id_card" | "passport")[]; - require_id_number?: boolean; - require_live_capture?: boolean; - require_matching_selfie?: boolean; + allowed_types?: ('driving_license' | 'id_card' | 'passport')[] + require_id_number?: boolean + require_live_capture?: boolean + require_matching_selfie?: boolean }> & - Partial<"">; - }; + Partial<''> + } /** @description The URL that the user will be redirected to upon completing the verification flow. */ - return_url?: string; + return_url?: string /** * @description The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. * @enum {string} */ - type: "document" | "id_number"; - }; - }; - }; - }; + type: 'document' | 'id_number' + } + } + } + } /** *

Retrieves the details of a VerificationSession that was previously created.

* @@ -25696,32 +25491,32 @@ export interface operations { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - session: string; - }; - }; + session: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["identity.verification_session"]; - }; - }; + 'application/json': components['schemas']['identity.verification_session'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates a VerificationSession object.

* @@ -25731,52 +25526,52 @@ export interface operations { PostIdentityVerificationSessionsSession: { parameters: { path: { - session: string; - }; - }; + session: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["identity.verification_session"]; - }; - }; + 'application/json': components['schemas']['identity.verification_session'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * session_options_param * @description A set of options for the session’s verification checks. */ options?: { document?: Partial<{ - allowed_types?: ("driving_license" | "id_card" | "passport")[]; - require_id_number?: boolean; - require_live_capture?: boolean; - require_matching_selfie?: boolean; + allowed_types?: ('driving_license' | 'id_card' | 'passport')[] + require_id_number?: boolean + require_live_capture?: boolean + require_matching_selfie?: boolean }> & - Partial<"">; - }; + Partial<''> + } /** * @description The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. * @enum {string} */ - type?: "document" | "id_number"; - }; - }; - }; - }; + type?: 'document' | 'id_number' + } + } + } + } /** *

A VerificationSession object can be canceled when it is in requires_input status.

* @@ -25785,32 +25580,32 @@ export interface operations { PostIdentityVerificationSessionsSessionCancel: { parameters: { path: { - session: string; - }; - }; + session: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["identity.verification_session"]; - }; - }; + 'application/json': components['schemas']['identity.verification_session'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /** *

Redact a VerificationSession to remove all collected information from Stripe. This will redact * the VerificationSession and all objects related to it, including VerificationReports, Events, @@ -25835,460 +25630,460 @@ export interface operations { PostIdentityVerificationSessionsSessionRedact: { parameters: { path: { - session: string; - }; - }; + session: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["identity.verification_session"]; - }; - }; + 'application/json': components['schemas']['identity.verification_session'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first.

*/ GetInvoiceitems: { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** The identifier of the customer whose invoice items to return. If none is provided, all invoice items will be returned. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** 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?: string; + invoice?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** 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?: boolean; + pending?: boolean /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["invoiceitem"][]; + 'application/json': { + data: components['schemas']['invoiceitem'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostInvoiceitems: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoiceitem"]; - }; - }; + 'application/json': components['schemas']['invoiceitem'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The integer amount in %s of the charge to be applied to the upcoming invoice. Passing in a negative `amount` will reduce the `amount_due` on the invoice. */ - amount?: number; + amount?: number /** @description 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?: string; + currency?: string /** @description The ID of the customer who will be billed when this invoice item is billed. */ - customer: string; + customer: string /** @description An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking. */ - description?: string; + description?: string /** @description Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items. */ - discountable?: boolean; + discountable?: boolean /** @description The coupons to redeem into discounts for the invoice item or invoice line item. */ discounts?: Partial< { - coupon?: string; - discount?: string; + coupon?: string + discount?: string }[] > & - Partial<"">; + Partial<''> /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The ID of an existing invoice to add this invoice item to. When left blank, the invoice item will be added to the next upcoming scheduled invoice. This is useful when adding invoice items in response to an invoice.created webhook. You can only add invoice items to draft invoices and there is a maximum of 250 items per invoice. */ - invoice?: string; + invoice?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** * period * @description The period associated with this invoice item. */ period?: { /** Format: unix-time */ - end: number; + end: number /** Format: unix-time */ - start: number; - }; + start: number + } /** @description The ID of the price object. */ - price?: string; + price?: string /** * one_time_price_data * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; + unit_amount_decimal?: string + } /** @description Non-negative integer. The quantity of units for the invoice item. */ - quantity?: number; + quantity?: number /** @description The ID of a subscription to add this invoice item to. When left blank, the invoice item will be be added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription. */ - subscription?: string; + subscription?: string /** @description 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?: string[]; + tax_rates?: string[] /** @description The integer unit amount in %s of the charge to be applied to the upcoming invoice. This `unit_amount` will be multiplied by the quantity to get the full amount. Passing in a negative `unit_amount` will reduce the `amount_due` on the invoice. */ - unit_amount?: number; + unit_amount?: number /** * Format: decimal * @description Same as `unit_amount`, but accepts a decimal value in %s with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. */ - unit_amount_decimal?: string; - }; - }; - }; - }; + unit_amount_decimal?: string + } + } + } + } /**

Retrieves the invoice item with the given ID.

*/ GetInvoiceitemsInvoiceitem: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - invoiceitem: string; - }; - }; + invoiceitem: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoiceitem"]; - }; - }; + 'application/json': components['schemas']['invoiceitem'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostInvoiceitemsInvoiceitem: { parameters: { path: { - invoiceitem: string; - }; - }; + invoiceitem: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoiceitem"]; - }; - }; + 'application/json': components['schemas']['invoiceitem'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The integer amount in %s of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount. */ - amount?: number; + amount?: number /** @description An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking. */ - description?: string; + description?: string /** @description Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items. Cannot be set to true for prorations. */ - discountable?: boolean; + discountable?: boolean /** @description The coupons & existing discounts which apply to the invoice item or invoice line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts. */ discounts?: Partial< { - coupon?: string; - discount?: string; + coupon?: string + discount?: string }[] > & - Partial<"">; + Partial<''> /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** * period * @description The period associated with this invoice item. */ period?: { /** Format: unix-time */ - end: number; + end: number /** Format: unix-time */ - start: number; - }; + start: number + } /** @description The ID of the price object. */ - price?: string; + price?: string /** * one_time_price_data * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; + unit_amount_decimal?: string + } /** @description Non-negative integer. The quantity of units for the invoice item. */ - quantity?: number; + quantity?: number /** @description 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. Pass an empty string to remove previously-defined tax rates. */ - tax_rates?: Partial & Partial<"">; + tax_rates?: Partial & Partial<''> /** @description The integer unit amount in %s of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount. */ - unit_amount?: number; + unit_amount?: number /** * Format: decimal * @description Same as `unit_amount`, but accepts a decimal value in %s with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. */ - unit_amount_decimal?: string; - }; - }; - }; - }; + unit_amount_decimal?: string + } + } + } + } /**

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.

*/ DeleteInvoiceitemsInvoiceitem: { parameters: { path: { - invoiceitem: string; - }; - }; + invoiceitem: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_invoiceitem"]; - }; - }; + 'application/json': components['schemas']['deleted_invoiceitem'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ GetInvoices: { parameters: { query: { /** The collection method of the invoice to retrieve. Either `charge_automatically` or `send_invoice`. */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** Only return invoices for the customer specified by this customer ID. */ - customer?: string; + customer?: string due_date?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** 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?: "draft" | "open" | "paid" | "uncollectible" | "void"; + status?: 'draft' | 'open' | 'paid' | 'uncollectible' | 'void' /** Only return invoices for the subscription specified by this subscription ID. */ - subscription?: string; - }; - }; + subscription?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["invoice"][]; + 'application/json': { + data: components['schemas']['invoice'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

This endpoint creates a draft invoice for a given customer. The draft invoice created pulls in all pending invoice items on that customer, including prorations. The invoice remains a draft until you finalize the invoice, which allows you to pay or send the invoice to your customers.

*/ PostInvoices: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoice"]; - }; - }; + 'application/json': components['schemas']['invoice'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The account tax IDs associated with the invoice. Only editable when the invoice is a draft. */ - account_tax_ids?: Partial & Partial<"">; + account_tax_ids?: Partial & Partial<''> /** @description A fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees). */ - application_fee_amount?: number; + application_fee_amount?: number /** @description Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice. When `false`, the invoice's state will not automatically advance without an explicit action. */ - auto_advance?: boolean; + auto_advance?: boolean /** * automatic_tax_param * @description Settings for automatic tax lookup for this invoice. */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** * @description 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. Defaults to `charge_automatically`. * @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' /** @description A list of up to 4 custom fields to be displayed on the invoice. */ custom_fields?: Partial< { - name: string; - value: string; + name: string + value: string }[] > & - Partial<"">; + Partial<''> /** @description The ID of the customer who will be billed. */ - customer: string; + customer: string /** @description The number of days from when the invoice is created until it is due. Valid only for invoices where `collection_method=send_invoice`. */ - days_until_due?: number; + days_until_due?: number /** @description 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?: string; + default_payment_method?: string /** @description 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?: string; + default_source?: string /** @description The tax rates that will apply to any line item that does not have `tax_rates` set. */ - default_tax_rates?: string[]; + default_tax_rates?: string[] /** @description An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. */ - description?: string; + description?: string /** @description The coupons to redeem into discounts for the invoice. If not specified, inherits the discount from the invoice's customer. Pass an empty string to avoid inheriting any discounts. */ discounts?: Partial< { - coupon?: string; - discount?: string; + coupon?: string + discount?: string }[] > & - Partial<"">; + Partial<''> /** * Format: unix-time * @description The date on which payment for this invoice is due. Valid only for invoices where `collection_method=send_invoice`. */ - due_date?: number; + due_date?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Footer to be displayed on the invoice. */ - footer?: string; + footer?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description 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?: string; + on_behalf_of?: string /** * payment_settings * @description Configuration settings for the PaymentIntent that is generated when the invoice is finalized. @@ -26300,60 +26095,60 @@ export interface operations { /** mandate_options_param */ mandate_options?: { /** @enum {string} */ - transaction_type?: "business" | "personal"; - }; + transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; + verification_method?: 'automatic' | 'instant' | 'microdeposits' }> & - Partial<"">; + Partial<''> bancontact?: Partial<{ /** @enum {string} */ - preferred_language?: "de" | "en" | "fr" | "nl"; + preferred_language?: 'de' | 'en' | 'fr' | 'nl' }> & - Partial<"">; + Partial<''> card?: Partial<{ /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: 'any' | 'automatic' }> & - Partial<"">; - }; + Partial<''> + } payment_method_types?: Partial< ( - | "ach_credit_transfer" - | "ach_debit" - | "acss_debit" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "sepa_debit" - | "sofort" - | "wechat_pay" + | 'ach_credit_transfer' + | 'ach_debit' + | 'acss_debit' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' )[] > & - Partial<"">; - }; + Partial<''> + } /** @description Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description The ID of the subscription to invoice, if any. If not set, the created invoice will include all pending invoice items for the customer. If set, the created invoice will only include pending invoice items for that subscription and pending invoice items not associated with any subscription. The subscription's billing cycle and regular subscription events won't be affected. */ - subscription?: string; + subscription?: string /** * transfer_data_specs * @description If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge. */ transfer_data?: { - amount?: number; - destination: string; - }; - }; - }; - }; - }; + amount?: number + destination: string + } + } + } + } + } /** *

At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.

* @@ -26366,184 +26161,184 @@ export interface operations { query: { /** Settings for automatic tax lookup for this invoice preview. */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** The code of the coupon to apply. If `subscription` or `subscription_items` is provided, the invoice returned will preview updating or creating a subscription with that coupon. Otherwise, it will preview applying that coupon to the customer for the next upcoming invoice from among the customer's subscriptions. The invoice can be previewed without a coupon by passing this value as an empty string. */ - coupon?: string; + coupon?: string /** The identifier of the customer whose upcoming invoice you'd like to retrieve. */ - customer?: string; + customer?: string /** Details about the customer you want to invoice or overrides for an existing customer. */ customer_details?: { address?: Partial<{ - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string }> & - Partial<"">; + Partial<''> shipping?: Partial<{ /** optional_fields_address */ address: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - name: string; - phone?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + name: string + phone?: string }> & - Partial<"">; + Partial<''> /** tax_param */ tax?: { - ip_address?: Partial & Partial<"">; - }; + ip_address?: Partial & Partial<''> + } /** @enum {string} */ - tax_exempt?: "" | "exempt" | "none" | "reverse"; + tax_exempt?: '' | 'exempt' | 'none' | 'reverse' tax_ids?: { /** @enum {string} */ type: - | "ae_trn" - | "au_abn" - | "au_arn" - | "br_cnpj" - | "br_cpf" - | "ca_bn" - | "ca_gst_hst" - | "ca_pst_bc" - | "ca_pst_mb" - | "ca_pst_sk" - | "ca_qst" - | "ch_vat" - | "cl_tin" - | "es_cif" - | "eu_vat" - | "gb_vat" - | "ge_vat" - | "hk_br" - | "id_npwp" - | "il_vat" - | "in_gst" - | "is_vat" - | "jp_cn" - | "jp_rn" - | "kr_brn" - | "li_uid" - | "mx_rfc" - | "my_frp" - | "my_itn" - | "my_sst" - | "no_vat" - | "nz_gst" - | "ru_inn" - | "ru_kpp" - | "sa_vat" - | "sg_gst" - | "sg_uen" - | "th_vat" - | "tw_vat" - | "ua_vat" - | "us_ein" - | "za_vat"; - value: string; - }[]; - }; + | 'ae_trn' + | 'au_abn' + | 'au_arn' + | 'br_cnpj' + | 'br_cpf' + | 'ca_bn' + | 'ca_gst_hst' + | 'ca_pst_bc' + | 'ca_pst_mb' + | 'ca_pst_sk' + | 'ca_qst' + | 'ch_vat' + | 'cl_tin' + | 'es_cif' + | 'eu_vat' + | 'gb_vat' + | 'ge_vat' + | 'hk_br' + | 'id_npwp' + | 'il_vat' + | 'in_gst' + | 'is_vat' + | 'jp_cn' + | 'jp_rn' + | 'kr_brn' + | 'li_uid' + | 'mx_rfc' + | 'my_frp' + | 'my_itn' + | 'my_sst' + | 'no_vat' + | 'nz_gst' + | 'ru_inn' + | 'ru_kpp' + | 'sa_vat' + | 'sg_gst' + | 'sg_uen' + | 'th_vat' + | 'tw_vat' + | 'ua_vat' + | 'us_ein' + | 'za_vat' + value: string + }[] + } /** The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the customer or subscription. This only works for coupons directly applied to the invoice. To apply a coupon to a subscription, you must use the `coupon` parameter instead. Pass an empty string to avoid inheriting any discounts. To preview the upcoming invoice for a subscription that hasn't been created, use `coupon` instead. */ discounts?: Partial< { - coupon?: string; - discount?: string; + coupon?: string + discount?: string }[] > & - Partial<"">; + Partial<''> /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** List of invoice items to add or update in the upcoming invoice preview. */ invoice_items?: { - amount?: number; - currency?: string; - description?: string; - discountable?: boolean; + amount?: number + currency?: string + description?: string + discountable?: boolean discounts?: Partial< { - coupon?: string; - discount?: string; + coupon?: string + discount?: string }[] > & - Partial<"">; - invoiceitem?: string; - metadata?: Partial<{ [key: string]: string }> & Partial<"">; + Partial<''> + invoiceitem?: string + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** period */ period?: { /** Format: unix-time */ - end: number; + end: number /** Format: unix-time */ - start: number; - }; - price?: string; + start: number + } + price?: string /** one_time_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - unit_amount?: number; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }[]; + unit_amount_decimal?: string + }[] /** The identifier of the unstarted schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields. */ - schedule?: string; + schedule?: string /** The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions. */ - subscription?: string; + subscription?: string /** 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`. */ - subscription_billing_cycle_anchor?: Partial<"now" | "unchanged"> & Partial; + subscription_billing_cycle_anchor?: Partial<'now' | 'unchanged'> & Partial /** Timestamp indicating when the subscription should be scheduled to cancel. Will prorate if within the current period and prorations have been enabled using `proration_behavior`. */ - subscription_cancel_at?: Partial & Partial<"">; + subscription_cancel_at?: Partial & Partial<''> /** Boolean indicating whether this subscription should cancel at the end of the current period. */ - subscription_cancel_at_period_end?: boolean; + subscription_cancel_at_period_end?: boolean /** This simulates the subscription being canceled or expired immediately. */ - subscription_cancel_now?: boolean; + subscription_cancel_now?: boolean /** 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. */ - subscription_default_tax_rates?: Partial & Partial<"">; + subscription_default_tax_rates?: Partial & Partial<''> /** A list of up to 20 subscription items, each with an attached price. */ subscription_items?: { billing_thresholds?: Partial<{ - usage_gte: number; + usage_gte: number }> & - Partial<"">; - clear_usage?: boolean; - deleted?: boolean; - id?: string; - metadata?: Partial<{ [key: string]: string }> & Partial<"">; - price?: string; + Partial<''> + clear_usage?: boolean + deleted?: boolean + id?: string + metadata?: Partial<{ [key: string]: string }> & Partial<''> + price?: string /** recurring_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] /** * Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -26551,227 +26346,227 @@ export interface operations { * * Prorations can be disabled by passing `none`. */ - subscription_proration_behavior?: "always_invoice" | "create_prorations" | "none"; + subscription_proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** 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 cannot be before the subscription was on its current plan. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'. */ - subscription_proration_date?: number; + subscription_proration_date?: number /** Date a subscription is intended to start (can be future or past) */ - subscription_start_date?: number; + subscription_start_date?: number /** 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. */ - subscription_trial_end?: Partial<"now"> & Partial; + subscription_trial_end?: Partial<'now'> & Partial /** Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `subscription_trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `subscription_trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. */ - subscription_trial_from_plan?: boolean; - }; - }; + subscription_trial_from_plan?: boolean + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoice"]; - }; - }; + 'application/json': components['schemas']['invoice'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ GetInvoicesUpcomingLines: { parameters: { query: { /** Settings for automatic tax lookup for this invoice preview. */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** The code of the coupon to apply. If `subscription` or `subscription_items` is provided, the invoice returned will preview updating or creating a subscription with that coupon. Otherwise, it will preview applying that coupon to the customer for the next upcoming invoice from among the customer's subscriptions. The invoice can be previewed without a coupon by passing this value as an empty string. */ - coupon?: string; + coupon?: string /** The identifier of the customer whose upcoming invoice you'd like to retrieve. */ - customer?: string; + customer?: string /** Details about the customer you want to invoice or overrides for an existing customer. */ customer_details?: { address?: Partial<{ - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string }> & - Partial<"">; + Partial<''> shipping?: Partial<{ /** optional_fields_address */ address: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - name: string; - phone?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + name: string + phone?: string }> & - Partial<"">; + Partial<''> /** tax_param */ tax?: { - ip_address?: Partial & Partial<"">; - }; + ip_address?: Partial & Partial<''> + } /** @enum {string} */ - tax_exempt?: "" | "exempt" | "none" | "reverse"; + tax_exempt?: '' | 'exempt' | 'none' | 'reverse' tax_ids?: { /** @enum {string} */ type: - | "ae_trn" - | "au_abn" - | "au_arn" - | "br_cnpj" - | "br_cpf" - | "ca_bn" - | "ca_gst_hst" - | "ca_pst_bc" - | "ca_pst_mb" - | "ca_pst_sk" - | "ca_qst" - | "ch_vat" - | "cl_tin" - | "es_cif" - | "eu_vat" - | "gb_vat" - | "ge_vat" - | "hk_br" - | "id_npwp" - | "il_vat" - | "in_gst" - | "is_vat" - | "jp_cn" - | "jp_rn" - | "kr_brn" - | "li_uid" - | "mx_rfc" - | "my_frp" - | "my_itn" - | "my_sst" - | "no_vat" - | "nz_gst" - | "ru_inn" - | "ru_kpp" - | "sa_vat" - | "sg_gst" - | "sg_uen" - | "th_vat" - | "tw_vat" - | "ua_vat" - | "us_ein" - | "za_vat"; - value: string; - }[]; - }; + | 'ae_trn' + | 'au_abn' + | 'au_arn' + | 'br_cnpj' + | 'br_cpf' + | 'ca_bn' + | 'ca_gst_hst' + | 'ca_pst_bc' + | 'ca_pst_mb' + | 'ca_pst_sk' + | 'ca_qst' + | 'ch_vat' + | 'cl_tin' + | 'es_cif' + | 'eu_vat' + | 'gb_vat' + | 'ge_vat' + | 'hk_br' + | 'id_npwp' + | 'il_vat' + | 'in_gst' + | 'is_vat' + | 'jp_cn' + | 'jp_rn' + | 'kr_brn' + | 'li_uid' + | 'mx_rfc' + | 'my_frp' + | 'my_itn' + | 'my_sst' + | 'no_vat' + | 'nz_gst' + | 'ru_inn' + | 'ru_kpp' + | 'sa_vat' + | 'sg_gst' + | 'sg_uen' + | 'th_vat' + | 'tw_vat' + | 'ua_vat' + | 'us_ein' + | 'za_vat' + value: string + }[] + } /** The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the customer or subscription. This only works for coupons directly applied to the invoice. To apply a coupon to a subscription, you must use the `coupon` parameter instead. Pass an empty string to avoid inheriting any discounts. To preview the upcoming invoice for a subscription that hasn't been created, use `coupon` instead. */ discounts?: Partial< { - coupon?: string; - discount?: string; + coupon?: string + discount?: string }[] > & - Partial<"">; + Partial<''> /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** List of invoice items to add or update in the upcoming invoice preview. */ invoice_items?: { - amount?: number; - currency?: string; - description?: string; - discountable?: boolean; + amount?: number + currency?: string + description?: string + discountable?: boolean discounts?: Partial< { - coupon?: string; - discount?: string; + coupon?: string + discount?: string }[] > & - Partial<"">; - invoiceitem?: string; - metadata?: Partial<{ [key: string]: string }> & Partial<"">; + Partial<''> + invoiceitem?: string + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** period */ period?: { /** Format: unix-time */ - end: number; + end: number /** Format: unix-time */ - start: number; - }; - price?: string; + start: number + } + price?: string /** one_time_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - unit_amount?: number; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }[]; + unit_amount_decimal?: string + }[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** The identifier of the unstarted schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields. */ - schedule?: string; + schedule?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions. */ - subscription?: string; + subscription?: string /** 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`. */ - subscription_billing_cycle_anchor?: Partial<"now" | "unchanged"> & Partial; + subscription_billing_cycle_anchor?: Partial<'now' | 'unchanged'> & Partial /** Timestamp indicating when the subscription should be scheduled to cancel. Will prorate if within the current period and prorations have been enabled using `proration_behavior`. */ - subscription_cancel_at?: Partial & Partial<"">; + subscription_cancel_at?: Partial & Partial<''> /** Boolean indicating whether this subscription should cancel at the end of the current period. */ - subscription_cancel_at_period_end?: boolean; + subscription_cancel_at_period_end?: boolean /** This simulates the subscription being canceled or expired immediately. */ - subscription_cancel_now?: boolean; + subscription_cancel_now?: boolean /** 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. */ - subscription_default_tax_rates?: Partial & Partial<"">; + subscription_default_tax_rates?: Partial & Partial<''> /** A list of up to 20 subscription items, each with an attached price. */ subscription_items?: { billing_thresholds?: Partial<{ - usage_gte: number; + usage_gte: number }> & - Partial<"">; - clear_usage?: boolean; - deleted?: boolean; - id?: string; - metadata?: Partial<{ [key: string]: string }> & Partial<"">; - price?: string; + Partial<''> + clear_usage?: boolean + deleted?: boolean + id?: string + metadata?: Partial<{ [key: string]: string }> & Partial<''> + price?: string /** recurring_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] /** * Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -26779,80 +26574,80 @@ export interface operations { * * Prorations can be disabled by passing `none`. */ - subscription_proration_behavior?: "always_invoice" | "create_prorations" | "none"; + subscription_proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** 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 cannot be before the subscription was on its current plan. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'. */ - subscription_proration_date?: number; + subscription_proration_date?: number /** Date a subscription is intended to start (can be future or past) */ - subscription_start_date?: number; + subscription_start_date?: number /** 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. */ - subscription_trial_end?: Partial<"now"> & Partial; + subscription_trial_end?: Partial<'now'> & Partial /** Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `subscription_trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `subscription_trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. */ - subscription_trial_from_plan?: boolean; - }; - }; + subscription_trial_from_plan?: boolean + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["line_item"][]; + data: components['schemas']['line_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves the invoice with the given ID.

*/ GetInvoicesInvoice: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - invoice: string; - }; - }; + invoice: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoice"]; - }; - }; + 'application/json': components['schemas']['invoice'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Draft invoices are fully editable. Once an invoice is finalized, * monetary values, as well as collection_method, become uneditable.

@@ -26864,83 +26659,83 @@ export interface operations { PostInvoicesInvoice: { parameters: { path: { - invoice: string; - }; - }; + invoice: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoice"]; - }; - }; + 'application/json': components['schemas']['invoice'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The account tax IDs associated with the invoice. Only editable when the invoice is a draft. */ - account_tax_ids?: Partial & Partial<"">; + account_tax_ids?: Partial & Partial<''> /** @description A fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees). */ - application_fee_amount?: number; + application_fee_amount?: number /** @description Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice. */ - auto_advance?: boolean; + auto_advance?: boolean /** * automatic_tax_param * @description Settings for automatic tax lookup for this invoice. */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** * @description Either `charge_automatically` or `send_invoice`. This field can be updated only on `draft` invoices. * @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' /** @description A list of up to 4 custom fields to be displayed on the invoice. If a value for `custom_fields` is specified, the list specified will replace the existing custom field list on this invoice. Pass an empty string to remove previously-defined fields. */ custom_fields?: Partial< { - name: string; - value: string; + name: string + value: string }[] > & - Partial<"">; + Partial<''> /** @description The number of days from which the invoice is created until it is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices. */ - days_until_due?: number; + days_until_due?: number /** @description 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?: string; + default_payment_method?: string /** @description 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?: string; + default_source?: string /** @description The tax rates that will apply to any line item that does not have `tax_rates` set. Pass an empty string to remove previously-defined tax rates. */ - default_tax_rates?: Partial & Partial<"">; + default_tax_rates?: Partial & Partial<''> /** @description An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. */ - description?: string; + description?: string /** @description The discounts that will apply to the invoice. Pass an empty string to remove previously-defined discounts. */ discounts?: Partial< { - coupon?: string; - discount?: string; + coupon?: string + discount?: string }[] > & - Partial<"">; + Partial<''> /** * Format: unix-time * @description The date on which payment for this invoice is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices. */ - due_date?: number; + due_date?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Footer to be displayed on the invoice. */ - footer?: string; + footer?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description 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?: Partial & Partial<"">; + on_behalf_of?: Partial & Partial<''> /** * payment_settings * @description Configuration settings for the PaymentIntent that is generated when the invoice is finalized. @@ -26952,238 +26747,238 @@ export interface operations { /** mandate_options_param */ mandate_options?: { /** @enum {string} */ - transaction_type?: "business" | "personal"; - }; + transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; + verification_method?: 'automatic' | 'instant' | 'microdeposits' }> & - Partial<"">; + Partial<''> bancontact?: Partial<{ /** @enum {string} */ - preferred_language?: "de" | "en" | "fr" | "nl"; + preferred_language?: 'de' | 'en' | 'fr' | 'nl' }> & - Partial<"">; + Partial<''> card?: Partial<{ /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: 'any' | 'automatic' }> & - Partial<"">; - }; + Partial<''> + } payment_method_types?: Partial< ( - | "ach_credit_transfer" - | "ach_debit" - | "acss_debit" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "sepa_debit" - | "sofort" - | "wechat_pay" + | 'ach_credit_transfer' + | 'ach_debit' + | 'acss_debit' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' )[] > & - Partial<"">; - }; + Partial<''> + } /** @description Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge. This will be unset if you POST an empty value. */ transfer_data?: Partial<{ - amount?: number; - destination: string; + amount?: number + destination: string }> & - Partial<"">; - }; - }; - }; - }; + Partial<''> + } + } + } + } /**

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.

*/ DeleteInvoicesInvoice: { parameters: { path: { - invoice: string; - }; - }; + invoice: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_invoice"]; - }; - }; + 'application/json': components['schemas']['deleted_invoice'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostInvoicesInvoiceFinalize: { parameters: { path: { - invoice: string; - }; - }; + invoice: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoice"]; - }; - }; + 'application/json': components['schemas']['invoice'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/invoicing/automatic-charging) of the invoice. When `false`, the invoice's state will not automatically advance without an explicit action. */ - auto_advance?: boolean; + auto_advance?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

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.

*/ GetInvoicesInvoiceLines: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - invoice: string; - }; - }; + invoice: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["line_item"][]; + data: components['schemas']['line_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.

*/ PostInvoicesInvoiceMarkUncollectible: { parameters: { path: { - invoice: string; - }; - }; + invoice: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoice"]; - }; - }; + 'application/json': components['schemas']['invoice'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

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.

*/ PostInvoicesInvoicePay: { parameters: { path: { - invoice: string; - }; - }; + invoice: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoice"]; - }; - }; + 'application/json': components['schemas']['invoice'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * @description In cases where the source used to pay the invoice has insufficient funds, passing `forgive=true` controls whether a charge should be attempted for the full amount available on the source, up to the amount to fully pay the invoice. This effectively forgives the difference between the amount available on the source and the amount due. * * Passing `forgive=false` will fail the charge if the source hasn't been pre-funded with the right amount. An example for this case is with ACH Credit Transfers and wires: if the amount wired is less than the amount due by a small amount, you might want to forgive the difference. Defaults to `false`. */ - forgive?: boolean; + forgive?: boolean /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `true` (off-session). */ - off_session?: boolean; + off_session?: boolean /** @description Boolean representing whether an invoice is paid outside of Stripe. This will result in no charge being made. Defaults to `false`. */ - paid_out_of_band?: boolean; + paid_out_of_band?: boolean /** @description A PaymentMethod to be charged. The PaymentMethod must be the ID of a PaymentMethod belonging to the customer associated with the invoice being paid. */ - payment_method?: string; + payment_method?: string /** @description A payment source to be charged. The source must be the ID of a source belonging to the customer associated with the invoice being paid. */ - source?: string; - }; - }; - }; - }; + source?: string + } + } + } + } /** *

Stripe will automatically send invoices to customers according to your subscriptions settings. However, if you’d like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.

* @@ -27192,109 +26987,109 @@ export interface operations { PostInvoicesInvoiceSend: { parameters: { path: { - invoice: string; - }; - }; + invoice: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoice"]; - }; - }; + 'application/json': components['schemas']['invoice'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.

*/ PostInvoicesInvoiceVoid: { parameters: { path: { - invoice: string; - }; - }; + invoice: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["invoice"]; - }; - }; + 'application/json': components['schemas']['invoice'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Returns a list of issuer fraud records.

*/ GetIssuerFraudRecords: { parameters: { query: { /** Only return issuer fraud records for the charge specified by this charge ID. */ - charge?: string; + charge?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["issuer_fraud_record"][]; + 'application/json': { + data: components['schemas']['issuer_fraud_record'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Retrieves the details of an issuer fraud record that has previously been created.

* @@ -27304,300 +27099,300 @@ export interface operations { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - issuer_fraud_record: string; - }; - }; + issuer_fraud_record: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuer_fraud_record"]; - }; - }; + 'application/json': components['schemas']['issuer_fraud_record'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ GetIssuingAuthorizations: { parameters: { query: { /** Only return authorizations that belong to the given card. */ - card?: string; + card?: string /** Only return authorizations that belong to the given cardholder. */ - cardholder?: string; + cardholder?: string /** Only return authorizations that were created during the given date interval. */ created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return authorizations with the given status. One of `pending`, `closed`, or `reversed`. */ - status?: "closed" | "pending" | "reversed"; - }; - }; + status?: 'closed' | 'pending' | 'reversed' + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["issuing.authorization"][]; + 'application/json': { + data: components['schemas']['issuing.authorization'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves an Issuing Authorization object.

*/ GetIssuingAuthorizationsAuthorization: { parameters: { path: { - authorization: string; - }; + authorization: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.authorization"]; - }; - }; + 'application/json': components['schemas']['issuing.authorization'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates the specified Issuing Authorization object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ PostIssuingAuthorizationsAuthorization: { parameters: { path: { - authorization: string; - }; - }; + authorization: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.authorization"]; - }; - }; + 'application/json': components['schemas']['issuing.authorization'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Approves a pending Issuing Authorization object. This request should be made within the timeout window of the real-time authorization flow.

*/ PostIssuingAuthorizationsAuthorizationApprove: { parameters: { path: { - authorization: string; - }; - }; + authorization: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.authorization"]; - }; - }; + 'application/json': components['schemas']['issuing.authorization'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description If the authorization's `pending_request.is_amount_controllable` property is `true`, you may provide this value to control how much to hold for the authorization. Must be positive (use [`decline`](https://stripe.com/docs/api/issuing/authorizations/decline) to decline an authorization request). */ - amount?: number; + amount?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Declines a pending Issuing Authorization object. This request should be made within the timeout window of the real time authorization flow.

*/ PostIssuingAuthorizationsAuthorizationDecline: { parameters: { path: { - authorization: string; - }; - }; + authorization: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.authorization"]; - }; - }; + 'application/json': components['schemas']['issuing.authorization'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Returns a list of Issuing Cardholder objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

*/ GetIssuingCardholders: { parameters: { query: { /** Only return cardholders that were created during the given date interval. */ created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** Only return cardholders that have the given email address. */ - email?: string; + email?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return cardholders that have the given phone number. */ - phone_number?: string; + phone_number?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return cardholders that have the given status. One of `active`, `inactive`, or `blocked`. */ - status?: "active" | "blocked" | "inactive"; + status?: 'active' | 'blocked' | 'inactive' /** Only return cardholders that have the given type. One of `individual` or `company`. */ - type?: "company" | "individual"; - }; - }; + type?: 'company' | 'individual' + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["issuing.cardholder"][]; + 'application/json': { + data: components['schemas']['issuing.cardholder'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new Issuing Cardholder object that can be issued cards.

*/ PostIssuingCardholders: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.cardholder"]; - }; - }; + 'application/json': components['schemas']['issuing.cardholder'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * billing_specs * @description The cardholder's billing address. @@ -27605,25 +27400,25 @@ export interface operations { billing: { /** required_address */ address: { - city: string; - country: string; - line1: string; - line2?: string; - postal_code: string; - state?: string; - }; - }; + city: string + country: string + line1: string + line2?: string + postal_code: string + state?: string + } + } /** * company_param * @description Additional information about a `company` cardholder. */ company?: { - tax_id?: string; - }; + tax_id?: string + } /** @description The cardholder's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * individual_param * @description Additional information about an `individual` cardholder. @@ -27631,978 +27426,978 @@ export interface operations { individual?: { /** date_of_birth_specs */ dob?: { - day: number; - month: number; - year: number; - }; - first_name: string; - last_name: string; + day: number + month: number + year: number + } + first_name: string + last_name: string /** person_verification_param */ verification?: { /** person_verification_document_param */ document?: { - back?: string; - front?: string; - }; - }; - }; + back?: string + front?: string + } + } + } /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The cardholder's name. This will be printed on cards issued to them. The maximum length of this field is 24 characters. */ - name: string; + name: string /** @description The cardholder's phone number. This will be transformed to [E.164](https://en.wikipedia.org/wiki/E.164) if it is not provided in that format already. 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?: string; + phone_number?: string /** * authorization_controls_param_v2 * @description 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?: { allowed_categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] blocked_categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] spending_limits?: { - amount: number; + amount: number categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] /** @enum {string} */ - interval: "all_time" | "daily" | "monthly" | "per_authorization" | "weekly" | "yearly"; - }[]; - spending_limits_currency?: string; - }; + interval: 'all_time' | 'daily' | 'monthly' | 'per_authorization' | 'weekly' | 'yearly' + }[] + spending_limits_currency?: string + } /** * @description Specifies whether to permit authorizations on this cardholder's cards. Defaults to `active`. * @enum {string} */ - status?: "active" | "inactive"; + status?: 'active' | 'inactive' /** * @description One of `individual` or `company`. * @enum {string} */ - type: "company" | "individual"; - }; - }; - }; - }; + type: 'company' | 'individual' + } + } + } + } /**

Retrieves an Issuing Cardholder object.

*/ GetIssuingCardholdersCardholder: { parameters: { path: { - cardholder: string; - }; + cardholder: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.cardholder"]; - }; - }; + 'application/json': components['schemas']['issuing.cardholder'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates the specified Issuing Cardholder object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ PostIssuingCardholdersCardholder: { parameters: { path: { - cardholder: string; - }; - }; + cardholder: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.cardholder"]; - }; - }; + 'application/json': components['schemas']['issuing.cardholder'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * billing_specs * @description The cardholder's billing address. @@ -28610,25 +28405,25 @@ export interface operations { billing?: { /** required_address */ address: { - city: string; - country: string; - line1: string; - line2?: string; - postal_code: string; - state?: string; - }; - }; + city: string + country: string + line1: string + line2?: string + postal_code: string + state?: string + } + } /** * company_param * @description Additional information about a `company` cardholder. */ company?: { - tax_id?: string; - }; + tax_id?: string + } /** @description The cardholder's email address. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * individual_param * @description Additional information about an `individual` cardholder. @@ -28636,1015 +28431,1015 @@ export interface operations { individual?: { /** date_of_birth_specs */ dob?: { - day: number; - month: number; - year: number; - }; - first_name: string; - last_name: string; + day: number + month: number + year: number + } + first_name: string + last_name: string /** person_verification_param */ verification?: { /** person_verification_document_param */ document?: { - back?: string; - front?: string; - }; - }; - }; + back?: string + front?: string + } + } + } /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description 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) for more details. */ - phone_number?: string; + phone_number?: string /** * authorization_controls_param_v2 * @description 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?: { allowed_categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] blocked_categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] spending_limits?: { - amount: number; + amount: number categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] /** @enum {string} */ - interval: "all_time" | "daily" | "monthly" | "per_authorization" | "weekly" | "yearly"; - }[]; - spending_limits_currency?: string; - }; + interval: 'all_time' | 'daily' | 'monthly' | 'per_authorization' | 'weekly' | 'yearly' + }[] + spending_limits_currency?: string + } /** * @description Specifies whether to permit authorizations on this cardholder's cards. * @enum {string} */ - status?: "active" | "inactive"; - }; - }; - }; - }; + status?: 'active' | 'inactive' + } + } + } + } /**

Returns a list of Issuing Card objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

*/ GetIssuingCards: { parameters: { query: { /** Only return cards belonging to the Cardholder with the provided ID. */ - cardholder?: string; + cardholder?: string /** Only return cards that were issued during the given date interval. */ created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Only return cards that have the given expiration month. */ - exp_month?: number; + exp_month?: number /** Only return cards that have the given expiration year. */ - exp_year?: number; + exp_year?: number /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** Only return cards that have the given last four digits. */ - last4?: string; + last4?: string /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return cards that have the given status. One of `active`, `inactive`, or `canceled`. */ - status?: "active" | "canceled" | "inactive"; + status?: 'active' | 'canceled' | 'inactive' /** Only return cards that have the given type. One of `virtual` or `physical`. */ - type?: "physical" | "virtual"; - }; - }; + type?: 'physical' | 'virtual' + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["issuing.card"][]; + 'application/json': { + data: components['schemas']['issuing.card'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates an Issuing Card object.

*/ PostIssuingCards: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.card"]; - }; - }; + 'application/json': components['schemas']['issuing.card'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The [Cardholder](https://stripe.com/docs/api#issuing_cardholder_object) object with which the card will be associated. */ - cardholder?: string; + cardholder?: string /** @description The currency for the card. */ - currency: string; + currency: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The card this is meant to be a replacement for (if any). */ - replacement_for?: string; + replacement_for?: string /** * @description If `replacement_for` is specified, this should indicate why that card is being replaced. * @enum {string} */ - replacement_reason?: "damaged" | "expired" | "lost" | "stolen"; + replacement_reason?: 'damaged' | 'expired' | 'lost' | 'stolen' /** * shipping_specs * @description The address where the card will be shipped. @@ -29652,2702 +29447,2688 @@ export interface operations { shipping?: { /** required_address */ address: { - city: string; - country: string; - line1: string; - line2?: string; - postal_code: string; - state?: string; - }; - name: string; + city: string + country: string + line1: string + line2?: string + postal_code: string + state?: string + } + name: string /** @enum {string} */ - service?: "express" | "priority" | "standard"; + service?: 'express' | 'priority' | 'standard' /** @enum {string} */ - type?: "bulk" | "individual"; - }; + type?: 'bulk' | 'individual' + } /** * authorization_controls_param * @description Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details. */ spending_controls?: { allowed_categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] blocked_categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] spending_limits?: { - amount: number; + amount: number categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] /** @enum {string} */ - interval: "all_time" | "daily" | "monthly" | "per_authorization" | "weekly" | "yearly"; - }[]; - }; + interval: 'all_time' | 'daily' | 'monthly' | 'per_authorization' | 'weekly' | 'yearly' + }[] + } /** * @description Whether authorizations can be approved on this card. Defaults to `inactive`. * @enum {string} */ - status?: "active" | "inactive"; + status?: 'active' | 'inactive' /** * @description The type of card to issue. Possible values are `physical` or `virtual`. * @enum {string} */ - type: "physical" | "virtual"; - }; - }; - }; - }; + type: 'physical' | 'virtual' + } + } + } + } /**

Retrieves an Issuing Card object.

*/ GetIssuingCardsCard: { parameters: { path: { - card: string; - }; + card: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.card"]; - }; - }; + 'application/json': components['schemas']['issuing.card'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates the specified Issuing Card object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ PostIssuingCardsCard: { parameters: { path: { - card: string; - }; - }; + card: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.card"]; - }; - }; + 'application/json': components['schemas']['issuing.card'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * @description Reason why the `status` of this card is `canceled`. * @enum {string} */ - cancellation_reason?: "lost" | "stolen"; + cancellation_reason?: 'lost' | 'stolen' /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** * encrypted_pin_param * @description The desired new PIN for this card. */ pin?: { - encrypted_number?: string; - }; + encrypted_number?: string + } /** * authorization_controls_param * @description Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details. */ spending_controls?: { allowed_categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] blocked_categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] spending_limits?: { - amount: number; + amount: number categories?: ( - | "ac_refrigeration_repair" - | "accounting_bookkeeping_services" - | "advertising_services" - | "agricultural_cooperative" - | "airlines_air_carriers" - | "airports_flying_fields" - | "ambulance_services" - | "amusement_parks_carnivals" - | "antique_reproductions" - | "antique_shops" - | "aquariums" - | "architectural_surveying_services" - | "art_dealers_and_galleries" - | "artists_supply_and_craft_shops" - | "auto_and_home_supply_stores" - | "auto_body_repair_shops" - | "auto_paint_shops" - | "auto_service_shops" - | "automated_cash_disburse" - | "automated_fuel_dispensers" - | "automobile_associations" - | "automotive_parts_and_accessories_stores" - | "automotive_tire_stores" - | "bail_and_bond_payments" - | "bakeries" - | "bands_orchestras" - | "barber_and_beauty_shops" - | "betting_casino_gambling" - | "bicycle_shops" - | "billiard_pool_establishments" - | "boat_dealers" - | "boat_rentals_and_leases" - | "book_stores" - | "books_periodicals_and_newspapers" - | "bowling_alleys" - | "bus_lines" - | "business_secretarial_schools" - | "buying_shopping_services" - | "cable_satellite_and_other_pay_television_and_radio" - | "camera_and_photographic_supply_stores" - | "candy_nut_and_confectionery_stores" - | "car_and_truck_dealers_new_used" - | "car_and_truck_dealers_used_only" - | "car_rental_agencies" - | "car_washes" - | "carpentry_services" - | "carpet_upholstery_cleaning" - | "caterers" - | "charitable_and_social_service_organizations_fundraising" - | "chemicals_and_allied_products" - | "child_care_services" - | "childrens_and_infants_wear_stores" - | "chiropodists_podiatrists" - | "chiropractors" - | "cigar_stores_and_stands" - | "civic_social_fraternal_associations" - | "cleaning_and_maintenance" - | "clothing_rental" - | "colleges_universities" - | "commercial_equipment" - | "commercial_footwear" - | "commercial_photography_art_and_graphics" - | "commuter_transport_and_ferries" - | "computer_network_services" - | "computer_programming" - | "computer_repair" - | "computer_software_stores" - | "computers_peripherals_and_software" - | "concrete_work_services" - | "construction_materials" - | "consulting_public_relations" - | "correspondence_schools" - | "cosmetic_stores" - | "counseling_services" - | "country_clubs" - | "courier_services" - | "court_costs" - | "credit_reporting_agencies" - | "cruise_lines" - | "dairy_products_stores" - | "dance_hall_studios_schools" - | "dating_escort_services" - | "dentists_orthodontists" - | "department_stores" - | "detective_agencies" - | "digital_goods_applications" - | "digital_goods_games" - | "digital_goods_large_volume" - | "digital_goods_media" - | "direct_marketing_catalog_merchant" - | "direct_marketing_combination_catalog_and_retail_merchant" - | "direct_marketing_inbound_telemarketing" - | "direct_marketing_insurance_services" - | "direct_marketing_other" - | "direct_marketing_outbound_telemarketing" - | "direct_marketing_subscription" - | "direct_marketing_travel" - | "discount_stores" - | "doctors" - | "door_to_door_sales" - | "drapery_window_covering_and_upholstery_stores" - | "drinking_places" - | "drug_stores_and_pharmacies" - | "drugs_drug_proprietaries_and_druggist_sundries" - | "dry_cleaners" - | "durable_goods" - | "duty_free_stores" - | "eating_places_restaurants" - | "educational_services" - | "electric_razor_stores" - | "electrical_parts_and_equipment" - | "electrical_services" - | "electronics_repair_shops" - | "electronics_stores" - | "elementary_secondary_schools" - | "employment_temp_agencies" - | "equipment_rental" - | "exterminating_services" - | "family_clothing_stores" - | "fast_food_restaurants" - | "financial_institutions" - | "fines_government_administrative_entities" - | "fireplace_fireplace_screens_and_accessories_stores" - | "floor_covering_stores" - | "florists" - | "florists_supplies_nursery_stock_and_flowers" - | "freezer_and_locker_meat_provisioners" - | "fuel_dealers_non_automotive" - | "funeral_services_crematories" - | "furniture_home_furnishings_and_equipment_stores_except_appliances" - | "furniture_repair_refinishing" - | "furriers_and_fur_shops" - | "general_services" - | "gift_card_novelty_and_souvenir_shops" - | "glass_paint_and_wallpaper_stores" - | "glassware_crystal_stores" - | "golf_courses_public" - | "government_services" - | "grocery_stores_supermarkets" - | "hardware_equipment_and_supplies" - | "hardware_stores" - | "health_and_beauty_spas" - | "hearing_aids_sales_and_supplies" - | "heating_plumbing_a_c" - | "hobby_toy_and_game_shops" - | "home_supply_warehouse_stores" - | "hospitals" - | "hotels_motels_and_resorts" - | "household_appliance_stores" - | "industrial_supplies" - | "information_retrieval_services" - | "insurance_default" - | "insurance_underwriting_premiums" - | "intra_company_purchases" - | "jewelry_stores_watches_clocks_and_silverware_stores" - | "landscaping_services" - | "laundries" - | "laundry_cleaning_services" - | "legal_services_attorneys" - | "luggage_and_leather_goods_stores" - | "lumber_building_materials_stores" - | "manual_cash_disburse" - | "marinas_service_and_supplies" - | "masonry_stonework_and_plaster" - | "massage_parlors" - | "medical_and_dental_labs" - | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" - | "medical_services" - | "membership_organizations" - | "mens_and_boys_clothing_and_accessories_stores" - | "mens_womens_clothing_stores" - | "metal_service_centers" - | "miscellaneous" - | "miscellaneous_apparel_and_accessory_shops" - | "miscellaneous_auto_dealers" - | "miscellaneous_business_services" - | "miscellaneous_food_stores" - | "miscellaneous_general_merchandise" - | "miscellaneous_general_services" - | "miscellaneous_home_furnishing_specialty_stores" - | "miscellaneous_publishing_and_printing" - | "miscellaneous_recreation_services" - | "miscellaneous_repair_shops" - | "miscellaneous_specialty_retail" - | "mobile_home_dealers" - | "motion_picture_theaters" - | "motor_freight_carriers_and_trucking" - | "motor_homes_dealers" - | "motor_vehicle_supplies_and_new_parts" - | "motorcycle_shops_and_dealers" - | "motorcycle_shops_dealers" - | "music_stores_musical_instruments_pianos_and_sheet_music" - | "news_dealers_and_newsstands" - | "non_fi_money_orders" - | "non_fi_stored_value_card_purchase_load" - | "nondurable_goods" - | "nurseries_lawn_and_garden_supply_stores" - | "nursing_personal_care" - | "office_and_commercial_furniture" - | "opticians_eyeglasses" - | "optometrists_ophthalmologist" - | "orthopedic_goods_prosthetic_devices" - | "osteopaths" - | "package_stores_beer_wine_and_liquor" - | "paints_varnishes_and_supplies" - | "parking_lots_garages" - | "passenger_railways" - | "pawn_shops" - | "pet_shops_pet_food_and_supplies" - | "petroleum_and_petroleum_products" - | "photo_developing" - | "photographic_photocopy_microfilm_equipment_and_supplies" - | "photographic_studios" - | "picture_video_production" - | "piece_goods_notions_and_other_dry_goods" - | "plumbing_heating_equipment_and_supplies" - | "political_organizations" - | "postal_services_government_only" - | "precious_stones_and_metals_watches_and_jewelry" - | "professional_services" - | "public_warehousing_and_storage" - | "quick_copy_repro_and_blueprint" - | "railroads" - | "real_estate_agents_and_managers_rentals" - | "record_stores" - | "recreational_vehicle_rentals" - | "religious_goods_stores" - | "religious_organizations" - | "roofing_siding_sheet_metal" - | "secretarial_support_services" - | "security_brokers_dealers" - | "service_stations" - | "sewing_needlework_fabric_and_piece_goods_stores" - | "shoe_repair_hat_cleaning" - | "shoe_stores" - | "small_appliance_repair" - | "snowmobile_dealers" - | "special_trade_services" - | "specialty_cleaning" - | "sporting_goods_stores" - | "sporting_recreation_camps" - | "sports_and_riding_apparel_stores" - | "sports_clubs_fields" - | "stamp_and_coin_stores" - | "stationary_office_supplies_printing_and_writing_paper" - | "stationery_stores_office_and_school_supply_stores" - | "swimming_pools_sales" - | "t_ui_travel_germany" - | "tailors_alterations" - | "tax_payments_government_agencies" - | "tax_preparation_services" - | "taxicabs_limousines" - | "telecommunication_equipment_and_telephone_sales" - | "telecommunication_services" - | "telegraph_services" - | "tent_and_awning_shops" - | "testing_laboratories" - | "theatrical_ticket_agencies" - | "timeshares" - | "tire_retreading_and_repair" - | "tolls_bridge_fees" - | "tourist_attractions_and_exhibits" - | "towing_services" - | "trailer_parks_campgrounds" - | "transportation_services" - | "travel_agencies_tour_operators" - | "truck_stop_iteration" - | "truck_utility_trailer_rentals" - | "typesetting_plate_making_and_related_services" - | "typewriter_stores" - | "u_s_federal_government_agencies_or_departments" - | "uniforms_commercial_clothing" - | "used_merchandise_and_secondhand_stores" - | "utilities" - | "variety_stores" - | "veterinary_services" - | "video_amusement_game_supplies" - | "video_game_arcades" - | "video_tape_rental_stores" - | "vocational_trade_schools" - | "watch_jewelry_repair" - | "welding_repair" - | "wholesale_clubs" - | "wig_and_toupee_stores" - | "wires_money_orders" - | "womens_accessory_and_specialty_shops" - | "womens_ready_to_wear_stores" - | "wrecking_and_salvage_yards" - )[]; + | 'ac_refrigeration_repair' + | 'accounting_bookkeeping_services' + | 'advertising_services' + | 'agricultural_cooperative' + | 'airlines_air_carriers' + | 'airports_flying_fields' + | 'ambulance_services' + | 'amusement_parks_carnivals' + | 'antique_reproductions' + | 'antique_shops' + | 'aquariums' + | 'architectural_surveying_services' + | 'art_dealers_and_galleries' + | 'artists_supply_and_craft_shops' + | 'auto_and_home_supply_stores' + | 'auto_body_repair_shops' + | 'auto_paint_shops' + | 'auto_service_shops' + | 'automated_cash_disburse' + | 'automated_fuel_dispensers' + | 'automobile_associations' + | 'automotive_parts_and_accessories_stores' + | 'automotive_tire_stores' + | 'bail_and_bond_payments' + | 'bakeries' + | 'bands_orchestras' + | 'barber_and_beauty_shops' + | 'betting_casino_gambling' + | 'bicycle_shops' + | 'billiard_pool_establishments' + | 'boat_dealers' + | 'boat_rentals_and_leases' + | 'book_stores' + | 'books_periodicals_and_newspapers' + | 'bowling_alleys' + | 'bus_lines' + | 'business_secretarial_schools' + | 'buying_shopping_services' + | 'cable_satellite_and_other_pay_television_and_radio' + | 'camera_and_photographic_supply_stores' + | 'candy_nut_and_confectionery_stores' + | 'car_and_truck_dealers_new_used' + | 'car_and_truck_dealers_used_only' + | 'car_rental_agencies' + | 'car_washes' + | 'carpentry_services' + | 'carpet_upholstery_cleaning' + | 'caterers' + | 'charitable_and_social_service_organizations_fundraising' + | 'chemicals_and_allied_products' + | 'child_care_services' + | 'childrens_and_infants_wear_stores' + | 'chiropodists_podiatrists' + | 'chiropractors' + | 'cigar_stores_and_stands' + | 'civic_social_fraternal_associations' + | 'cleaning_and_maintenance' + | 'clothing_rental' + | 'colleges_universities' + | 'commercial_equipment' + | 'commercial_footwear' + | 'commercial_photography_art_and_graphics' + | 'commuter_transport_and_ferries' + | 'computer_network_services' + | 'computer_programming' + | 'computer_repair' + | 'computer_software_stores' + | 'computers_peripherals_and_software' + | 'concrete_work_services' + | 'construction_materials' + | 'consulting_public_relations' + | 'correspondence_schools' + | 'cosmetic_stores' + | 'counseling_services' + | 'country_clubs' + | 'courier_services' + | 'court_costs' + | 'credit_reporting_agencies' + | 'cruise_lines' + | 'dairy_products_stores' + | 'dance_hall_studios_schools' + | 'dating_escort_services' + | 'dentists_orthodontists' + | 'department_stores' + | 'detective_agencies' + | 'digital_goods_applications' + | 'digital_goods_games' + | 'digital_goods_large_volume' + | 'digital_goods_media' + | 'direct_marketing_catalog_merchant' + | 'direct_marketing_combination_catalog_and_retail_merchant' + | 'direct_marketing_inbound_telemarketing' + | 'direct_marketing_insurance_services' + | 'direct_marketing_other' + | 'direct_marketing_outbound_telemarketing' + | 'direct_marketing_subscription' + | 'direct_marketing_travel' + | 'discount_stores' + | 'doctors' + | 'door_to_door_sales' + | 'drapery_window_covering_and_upholstery_stores' + | 'drinking_places' + | 'drug_stores_and_pharmacies' + | 'drugs_drug_proprietaries_and_druggist_sundries' + | 'dry_cleaners' + | 'durable_goods' + | 'duty_free_stores' + | 'eating_places_restaurants' + | 'educational_services' + | 'electric_razor_stores' + | 'electrical_parts_and_equipment' + | 'electrical_services' + | 'electronics_repair_shops' + | 'electronics_stores' + | 'elementary_secondary_schools' + | 'employment_temp_agencies' + | 'equipment_rental' + | 'exterminating_services' + | 'family_clothing_stores' + | 'fast_food_restaurants' + | 'financial_institutions' + | 'fines_government_administrative_entities' + | 'fireplace_fireplace_screens_and_accessories_stores' + | 'floor_covering_stores' + | 'florists' + | 'florists_supplies_nursery_stock_and_flowers' + | 'freezer_and_locker_meat_provisioners' + | 'fuel_dealers_non_automotive' + | 'funeral_services_crematories' + | 'furniture_home_furnishings_and_equipment_stores_except_appliances' + | 'furniture_repair_refinishing' + | 'furriers_and_fur_shops' + | 'general_services' + | 'gift_card_novelty_and_souvenir_shops' + | 'glass_paint_and_wallpaper_stores' + | 'glassware_crystal_stores' + | 'golf_courses_public' + | 'government_services' + | 'grocery_stores_supermarkets' + | 'hardware_equipment_and_supplies' + | 'hardware_stores' + | 'health_and_beauty_spas' + | 'hearing_aids_sales_and_supplies' + | 'heating_plumbing_a_c' + | 'hobby_toy_and_game_shops' + | 'home_supply_warehouse_stores' + | 'hospitals' + | 'hotels_motels_and_resorts' + | 'household_appliance_stores' + | 'industrial_supplies' + | 'information_retrieval_services' + | 'insurance_default' + | 'insurance_underwriting_premiums' + | 'intra_company_purchases' + | 'jewelry_stores_watches_clocks_and_silverware_stores' + | 'landscaping_services' + | 'laundries' + | 'laundry_cleaning_services' + | 'legal_services_attorneys' + | 'luggage_and_leather_goods_stores' + | 'lumber_building_materials_stores' + | 'manual_cash_disburse' + | 'marinas_service_and_supplies' + | 'masonry_stonework_and_plaster' + | 'massage_parlors' + | 'medical_and_dental_labs' + | 'medical_dental_ophthalmic_and_hospital_equipment_and_supplies' + | 'medical_services' + | 'membership_organizations' + | 'mens_and_boys_clothing_and_accessories_stores' + | 'mens_womens_clothing_stores' + | 'metal_service_centers' + | 'miscellaneous' + | 'miscellaneous_apparel_and_accessory_shops' + | 'miscellaneous_auto_dealers' + | 'miscellaneous_business_services' + | 'miscellaneous_food_stores' + | 'miscellaneous_general_merchandise' + | 'miscellaneous_general_services' + | 'miscellaneous_home_furnishing_specialty_stores' + | 'miscellaneous_publishing_and_printing' + | 'miscellaneous_recreation_services' + | 'miscellaneous_repair_shops' + | 'miscellaneous_specialty_retail' + | 'mobile_home_dealers' + | 'motion_picture_theaters' + | 'motor_freight_carriers_and_trucking' + | 'motor_homes_dealers' + | 'motor_vehicle_supplies_and_new_parts' + | 'motorcycle_shops_and_dealers' + | 'motorcycle_shops_dealers' + | 'music_stores_musical_instruments_pianos_and_sheet_music' + | 'news_dealers_and_newsstands' + | 'non_fi_money_orders' + | 'non_fi_stored_value_card_purchase_load' + | 'nondurable_goods' + | 'nurseries_lawn_and_garden_supply_stores' + | 'nursing_personal_care' + | 'office_and_commercial_furniture' + | 'opticians_eyeglasses' + | 'optometrists_ophthalmologist' + | 'orthopedic_goods_prosthetic_devices' + | 'osteopaths' + | 'package_stores_beer_wine_and_liquor' + | 'paints_varnishes_and_supplies' + | 'parking_lots_garages' + | 'passenger_railways' + | 'pawn_shops' + | 'pet_shops_pet_food_and_supplies' + | 'petroleum_and_petroleum_products' + | 'photo_developing' + | 'photographic_photocopy_microfilm_equipment_and_supplies' + | 'photographic_studios' + | 'picture_video_production' + | 'piece_goods_notions_and_other_dry_goods' + | 'plumbing_heating_equipment_and_supplies' + | 'political_organizations' + | 'postal_services_government_only' + | 'precious_stones_and_metals_watches_and_jewelry' + | 'professional_services' + | 'public_warehousing_and_storage' + | 'quick_copy_repro_and_blueprint' + | 'railroads' + | 'real_estate_agents_and_managers_rentals' + | 'record_stores' + | 'recreational_vehicle_rentals' + | 'religious_goods_stores' + | 'religious_organizations' + | 'roofing_siding_sheet_metal' + | 'secretarial_support_services' + | 'security_brokers_dealers' + | 'service_stations' + | 'sewing_needlework_fabric_and_piece_goods_stores' + | 'shoe_repair_hat_cleaning' + | 'shoe_stores' + | 'small_appliance_repair' + | 'snowmobile_dealers' + | 'special_trade_services' + | 'specialty_cleaning' + | 'sporting_goods_stores' + | 'sporting_recreation_camps' + | 'sports_and_riding_apparel_stores' + | 'sports_clubs_fields' + | 'stamp_and_coin_stores' + | 'stationary_office_supplies_printing_and_writing_paper' + | 'stationery_stores_office_and_school_supply_stores' + | 'swimming_pools_sales' + | 't_ui_travel_germany' + | 'tailors_alterations' + | 'tax_payments_government_agencies' + | 'tax_preparation_services' + | 'taxicabs_limousines' + | 'telecommunication_equipment_and_telephone_sales' + | 'telecommunication_services' + | 'telegraph_services' + | 'tent_and_awning_shops' + | 'testing_laboratories' + | 'theatrical_ticket_agencies' + | 'timeshares' + | 'tire_retreading_and_repair' + | 'tolls_bridge_fees' + | 'tourist_attractions_and_exhibits' + | 'towing_services' + | 'trailer_parks_campgrounds' + | 'transportation_services' + | 'travel_agencies_tour_operators' + | 'truck_stop_iteration' + | 'truck_utility_trailer_rentals' + | 'typesetting_plate_making_and_related_services' + | 'typewriter_stores' + | 'u_s_federal_government_agencies_or_departments' + | 'uniforms_commercial_clothing' + | 'used_merchandise_and_secondhand_stores' + | 'utilities' + | 'variety_stores' + | 'veterinary_services' + | 'video_amusement_game_supplies' + | 'video_game_arcades' + | 'video_tape_rental_stores' + | 'vocational_trade_schools' + | 'watch_jewelry_repair' + | 'welding_repair' + | 'wholesale_clubs' + | 'wig_and_toupee_stores' + | 'wires_money_orders' + | 'womens_accessory_and_specialty_shops' + | 'womens_ready_to_wear_stores' + | 'wrecking_and_salvage_yards' + )[] /** @enum {string} */ - interval: "all_time" | "daily" | "monthly" | "per_authorization" | "weekly" | "yearly"; - }[]; - }; + interval: 'all_time' | 'daily' | 'monthly' | 'per_authorization' | 'weekly' | 'yearly' + }[] + } /** * @description Dictates whether authorizations can be approved on this card. If this card is being canceled because it was lost or stolen, this information should be provided as `cancellation_reason`. * @enum {string} */ - status?: "active" | "canceled" | "inactive"; - }; - }; - }; - }; + status?: 'active' | 'canceled' | 'inactive' + } + } + } + } /**

Returns a list of Issuing Dispute objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

*/ GetIssuingDisputes: { parameters: { query: { /** Select Issuing disputes that were created during the given date interval. */ created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Select Issuing disputes with the given status. */ - status?: "expired" | "lost" | "submitted" | "unsubmitted" | "won"; + status?: 'expired' | 'lost' | 'submitted' | 'unsubmitted' | 'won' /** Select the Issuing dispute for the given transaction. */ - transaction?: string; - }; - }; + transaction?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["issuing.dispute"][]; + 'application/json': { + data: components['schemas']['issuing.dispute'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostIssuingDisputes: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.dispute"]; - }; - }; + 'application/json': components['schemas']['issuing.dispute'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * evidence_param * @description Evidence provided for the dispute. */ evidence?: { canceled?: Partial<{ - additional_documentation?: Partial & Partial<"">; - canceled_at?: Partial & Partial<"">; - cancellation_policy_provided?: Partial & Partial<"">; - cancellation_reason?: string; - expected_at?: Partial & Partial<"">; - explanation?: string; - product_description?: string; + additional_documentation?: Partial & Partial<''> + canceled_at?: Partial & Partial<''> + cancellation_policy_provided?: Partial & Partial<''> + cancellation_reason?: string + expected_at?: Partial & Partial<''> + explanation?: string + product_description?: string /** @enum {string} */ - product_type?: "" | "merchandise" | "service"; + product_type?: '' | 'merchandise' | 'service' /** @enum {string} */ - return_status?: "" | "merchant_rejected" | "successful"; - returned_at?: Partial & Partial<"">; + return_status?: '' | 'merchant_rejected' | 'successful' + returned_at?: Partial & Partial<''> }> & - Partial<"">; + Partial<''> duplicate?: Partial<{ - additional_documentation?: Partial & Partial<"">; - card_statement?: Partial & Partial<"">; - cash_receipt?: Partial & Partial<"">; - check_image?: Partial & Partial<"">; - explanation?: string; - original_transaction?: string; + additional_documentation?: Partial & Partial<''> + card_statement?: Partial & Partial<''> + cash_receipt?: Partial & Partial<''> + check_image?: Partial & Partial<''> + explanation?: string + original_transaction?: string }> & - Partial<"">; + Partial<''> fraudulent?: Partial<{ - additional_documentation?: Partial & Partial<"">; - explanation?: string; + additional_documentation?: Partial & Partial<''> + explanation?: string }> & - Partial<"">; + Partial<''> merchandise_not_as_described?: Partial<{ - additional_documentation?: Partial & Partial<"">; - explanation?: string; - received_at?: Partial & Partial<"">; - return_description?: string; + additional_documentation?: Partial & Partial<''> + explanation?: string + received_at?: Partial & Partial<''> + return_description?: string /** @enum {string} */ - return_status?: "" | "merchant_rejected" | "successful"; - returned_at?: Partial & Partial<"">; + return_status?: '' | 'merchant_rejected' | 'successful' + returned_at?: Partial & Partial<''> }> & - Partial<"">; + Partial<''> not_received?: Partial<{ - additional_documentation?: Partial & Partial<"">; - expected_at?: Partial & Partial<"">; - explanation?: string; - product_description?: string; + additional_documentation?: Partial & Partial<''> + expected_at?: Partial & Partial<''> + explanation?: string + product_description?: string /** @enum {string} */ - product_type?: "" | "merchandise" | "service"; + product_type?: '' | 'merchandise' | 'service' }> & - Partial<"">; + Partial<''> other?: Partial<{ - additional_documentation?: Partial & Partial<"">; - explanation?: string; - product_description?: string; + additional_documentation?: Partial & Partial<''> + explanation?: string + product_description?: string /** @enum {string} */ - product_type?: "" | "merchandise" | "service"; + product_type?: '' | 'merchandise' | 'service' }> & - Partial<"">; + Partial<''> /** @enum {string} */ - reason?: - | "canceled" - | "duplicate" - | "fraudulent" - | "merchandise_not_as_described" - | "not_received" - | "other" - | "service_not_as_described"; + reason?: 'canceled' | 'duplicate' | 'fraudulent' | 'merchandise_not_as_described' | 'not_received' | 'other' | 'service_not_as_described' service_not_as_described?: Partial<{ - additional_documentation?: Partial & Partial<"">; - canceled_at?: Partial & Partial<"">; - cancellation_reason?: string; - explanation?: string; - received_at?: Partial & Partial<"">; + additional_documentation?: Partial & Partial<''> + canceled_at?: Partial & Partial<''> + cancellation_reason?: string + explanation?: string + received_at?: Partial & Partial<''> }> & - Partial<"">; - }; + Partial<''> + } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The ID of the issuing transaction to create a dispute for. */ - transaction: string; - }; - }; - }; - }; + transaction: string + } + } + } + } /**

Retrieves an Issuing Dispute object.

*/ GetIssuingDisputesDispute: { parameters: { path: { - dispute: string; - }; + dispute: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.dispute"]; - }; - }; + 'application/json': components['schemas']['issuing.dispute'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostIssuingDisputesDispute: { parameters: { path: { - dispute: string; - }; - }; + dispute: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.dispute"]; - }; - }; + 'application/json': components['schemas']['issuing.dispute'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * evidence_param * @description Evidence provided for the dispute. */ evidence?: { canceled?: Partial<{ - additional_documentation?: Partial & Partial<"">; - canceled_at?: Partial & Partial<"">; - cancellation_policy_provided?: Partial & Partial<"">; - cancellation_reason?: string; - expected_at?: Partial & Partial<"">; - explanation?: string; - product_description?: string; + additional_documentation?: Partial & Partial<''> + canceled_at?: Partial & Partial<''> + cancellation_policy_provided?: Partial & Partial<''> + cancellation_reason?: string + expected_at?: Partial & Partial<''> + explanation?: string + product_description?: string /** @enum {string} */ - product_type?: "" | "merchandise" | "service"; + product_type?: '' | 'merchandise' | 'service' /** @enum {string} */ - return_status?: "" | "merchant_rejected" | "successful"; - returned_at?: Partial & Partial<"">; + return_status?: '' | 'merchant_rejected' | 'successful' + returned_at?: Partial & Partial<''> }> & - Partial<"">; + Partial<''> duplicate?: Partial<{ - additional_documentation?: Partial & Partial<"">; - card_statement?: Partial & Partial<"">; - cash_receipt?: Partial & Partial<"">; - check_image?: Partial & Partial<"">; - explanation?: string; - original_transaction?: string; + additional_documentation?: Partial & Partial<''> + card_statement?: Partial & Partial<''> + cash_receipt?: Partial & Partial<''> + check_image?: Partial & Partial<''> + explanation?: string + original_transaction?: string }> & - Partial<"">; + Partial<''> fraudulent?: Partial<{ - additional_documentation?: Partial & Partial<"">; - explanation?: string; + additional_documentation?: Partial & Partial<''> + explanation?: string }> & - Partial<"">; + Partial<''> merchandise_not_as_described?: Partial<{ - additional_documentation?: Partial & Partial<"">; - explanation?: string; - received_at?: Partial & Partial<"">; - return_description?: string; + additional_documentation?: Partial & Partial<''> + explanation?: string + received_at?: Partial & Partial<''> + return_description?: string /** @enum {string} */ - return_status?: "" | "merchant_rejected" | "successful"; - returned_at?: Partial & Partial<"">; + return_status?: '' | 'merchant_rejected' | 'successful' + returned_at?: Partial & Partial<''> }> & - Partial<"">; + Partial<''> not_received?: Partial<{ - additional_documentation?: Partial & Partial<"">; - expected_at?: Partial & Partial<"">; - explanation?: string; - product_description?: string; + additional_documentation?: Partial & Partial<''> + expected_at?: Partial & Partial<''> + explanation?: string + product_description?: string /** @enum {string} */ - product_type?: "" | "merchandise" | "service"; + product_type?: '' | 'merchandise' | 'service' }> & - Partial<"">; + Partial<''> other?: Partial<{ - additional_documentation?: Partial & Partial<"">; - explanation?: string; - product_description?: string; + additional_documentation?: Partial & Partial<''> + explanation?: string + product_description?: string /** @enum {string} */ - product_type?: "" | "merchandise" | "service"; + product_type?: '' | 'merchandise' | 'service' }> & - Partial<"">; + Partial<''> /** @enum {string} */ - reason?: - | "canceled" - | "duplicate" - | "fraudulent" - | "merchandise_not_as_described" - | "not_received" - | "other" - | "service_not_as_described"; + reason?: 'canceled' | 'duplicate' | 'fraudulent' | 'merchandise_not_as_described' | 'not_received' | 'other' | 'service_not_as_described' service_not_as_described?: Partial<{ - additional_documentation?: Partial & Partial<"">; - canceled_at?: Partial & Partial<"">; - cancellation_reason?: string; - explanation?: string; - received_at?: Partial & Partial<"">; + additional_documentation?: Partial & Partial<''> + canceled_at?: Partial & Partial<''> + cancellation_reason?: string + explanation?: string + received_at?: Partial & Partial<''> }> & - Partial<"">; - }; + Partial<''> + } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

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.

*/ PostIssuingDisputesDisputeSubmit: { parameters: { path: { - dispute: string; - }; - }; + dispute: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.dispute"]; - }; - }; + 'application/json': components['schemas']['issuing.dispute'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Returns a list of Issuing Settlement objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

*/ GetIssuingSettlements: { parameters: { query: { /** Only return issuing settlements that were created during the given date interval. */ created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["issuing.settlement"][]; + 'application/json': { + data: components['schemas']['issuing.settlement'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves an Issuing Settlement object.

*/ GetIssuingSettlementsSettlement: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - settlement: string; - }; - }; + settlement: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.settlement"]; - }; - }; + 'application/json': components['schemas']['issuing.settlement'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates the specified Issuing Settlement object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ PostIssuingSettlementsSettlement: { parameters: { path: { - settlement: string; - }; - }; + settlement: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.settlement"]; - }; - }; + 'application/json': components['schemas']['issuing.settlement'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; - }; - }; - }; - }; + metadata?: { [key: string]: string } + } + } + } + } /**

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.

*/ GetIssuingTransactions: { parameters: { query: { /** Only return transactions that belong to the given card. */ - card?: string; + card?: string /** Only return transactions that belong to the given cardholder. */ - cardholder?: string; + cardholder?: string /** Only return transactions that were created during the given date interval. */ created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return transactions that have the given type. One of `capture` or `refund`. */ - type?: "capture" | "refund"; - }; - }; + type?: 'capture' | 'refund' + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["issuing.transaction"][]; + 'application/json': { + data: components['schemas']['issuing.transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves an Issuing Transaction object.

*/ GetIssuingTransactionsTransaction: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - transaction: string; - }; - }; + transaction: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.transaction"]; - }; - }; + 'application/json': components['schemas']['issuing.transaction'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates the specified Issuing Transaction object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ PostIssuingTransactionsTransaction: { parameters: { path: { - transaction: string; - }; - }; + transaction: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["issuing.transaction"]; - }; - }; + 'application/json': components['schemas']['issuing.transaction'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Retrieves a Mandate object.

*/ GetMandatesMandate: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - mandate: string; - }; - }; + mandate: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["mandate"]; - }; - }; + 'application/json': components['schemas']['mandate'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of your order returns. The returns are returned sorted by creation date, with the most recently created return appearing first.

*/ GetOrderReturns: { parameters: { query: { /** Date this return was created. */ created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** The order to retrieve returns for. */ - order?: string; + order?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["order_return"][]; + 'application/json': { + data: components['schemas']['order_return'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves the details of an existing order return. Supply the unique order ID from either an order return creation request or the order return list, and Stripe will return the corresponding order information.

*/ GetOrderReturnsId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["order_return"]; - }; - }; + 'application/json': components['schemas']['order_return'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of your orders. The orders are returned sorted by creation date, with the most recently created orders appearing first.

*/ GetOrders: { parameters: { query: { /** Date this order was created. */ created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** Only return orders for the given customer. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** Only return orders with the given IDs. */ - ids?: string[]; + ids?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return orders that have the given status. One of `created`, `paid`, `fulfilled`, or `refunded`. */ - status?: string; + status?: string /** Filter orders based on when they were paid, fulfilled, canceled, or returned. */ status_transitions?: { canceled?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial fulfilled?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial paid?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial returned?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; - }; + Partial + } /** Only return orders with the given upstream order IDs. */ - upstream_ids?: string[]; - }; - }; + upstream_ids?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["order"][]; + 'application/json': { + data: components['schemas']['order'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new order object.

*/ PostOrders: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["order"]; - }; - }; + 'application/json': components['schemas']['order'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A coupon code that represents a discount to be applied to this order. Must be one-time duration and in same currency as the order. An order can have multiple coupons. */ - coupon?: string; + coupon?: string /** @description 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: string; + currency: string /** @description The ID of an existing customer to use for this order. If provided, the customer email and shipping address will be used to create the order. Subsequently, the customer will also be charged to pay the order. If `email` or `shipping` are also provided, they will override the values retrieved from the customer object. */ - customer?: string; + customer?: string /** @description The email address of the customer placing the order. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description List of items constituting the order. An order can have up to 25 items. */ items?: { - amount?: number; - currency?: string; - description?: string; - parent?: string; - quantity?: number; + amount?: number + currency?: string + description?: string + parent?: string + quantity?: number /** @enum {string} */ - type?: "discount" | "shipping" | "sku" | "tax"; - }[]; + type?: 'discount' | 'shipping' | 'sku' | 'tax' + }[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * customer_shipping * @description Shipping address for the order. Required if any of the SKUs are for products that have `shippable` set to true. @@ -32355,237 +32136,237 @@ export interface operations { shipping?: { /** optional_fields_address */ address: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - name: string; - phone?: string; - }; - }; - }; - }; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + name: string + phone?: string + } + } + } + } + } /**

Retrieves the details of an existing order. Supply the unique order ID from either an order creation request or the order list, and Stripe will return the corresponding order information.

*/ GetOrdersId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["order"]; - }; - }; + 'application/json': components['schemas']['order'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates the specific order by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ PostOrdersId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["order"]; - }; - }; + 'application/json': components['schemas']['order'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A coupon code that represents a discount to be applied to this order. Must be one-time duration and in same currency as the order. An order can have multiple coupons. */ - coupon?: string; + coupon?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The shipping method to select for fulfilling this order. If specified, must be one of the `id`s of a shipping method in the `shipping_methods` array. If specified, will overwrite the existing selected shipping method, updating `items` as necessary. */ - selected_shipping_method?: string; + selected_shipping_method?: string /** * shipping_tracking_params * @description Tracking information once the order has been fulfilled. */ shipping?: { - carrier: string; - tracking_number: string; - }; + carrier: string + tracking_number: string + } /** * @description Current order status. One of `created`, `paid`, `canceled`, `fulfilled`, or `returned`. More detail in the [Orders Guide](https://stripe.com/docs/orders/guide#understanding-order-statuses). * @enum {string} */ - status?: "canceled" | "created" | "fulfilled" | "paid" | "returned"; - }; - }; - }; - }; + status?: 'canceled' | 'created' | 'fulfilled' | 'paid' | 'returned' + } + } + } + } /**

Pay an order by providing a source to create a payment.

*/ PostOrdersIdPay: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["order"]; - }; - }; + 'application/json': components['schemas']['order'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A fee in %s that will be applied to the order and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the `Stripe-Account` header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees). */ - application_fee?: number; + application_fee?: number /** @description The ID of an existing customer that will be charged for this order. If no customer was attached to the order at creation, either `source` or `customer` is required. Otherwise, the specified customer will be charged instead of the one attached to the order. */ - customer?: string; + customer?: string /** @description The email address of the customer placing the order. Required if not previously specified for the order. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description A [Token](https://stripe.com/docs/api#tokens)'s or a [Source](https://stripe.com/docs/api#sources)'s ID, as returned by [Elements](https://stripe.com/docs/elements). If no customer was attached to the order at creation, either `source` or `customer` is required. Otherwise, the specified source will be charged intead of the customer attached to the order. */ - source?: string; - }; - }; - }; - }; + source?: string + } + } + } + } /**

Return all or part of an order. The order must have a status of paid or fulfilled before it can be returned. Once all items have been returned, the order will become canceled or returned depending on which status the order started in.

*/ PostOrdersIdReturns: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["order_return"]; - }; - }; + 'application/json': components['schemas']['order_return'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description List of items to return. */ items?: Partial< { - amount?: number; - description?: string; - parent?: string; - quantity?: number; + amount?: number + description?: string + parent?: string + quantity?: number /** @enum {string} */ - type?: "discount" | "shipping" | "sku" | "tax"; + type?: 'discount' | 'shipping' | 'sku' | 'tax' }[] > & - Partial<"">; - }; - }; - }; - }; + Partial<''> + } + } + } + } /**

Returns a list of PaymentIntents.

*/ GetPaymentIntents: { parameters: { query: { /** 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?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** Only return PaymentIntents for the customer specified by this customer ID. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["payment_intent"][]; + 'application/json': { + data: components['schemas']['payment_intent'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Creates a PaymentIntent object.

* @@ -32603,41 +32384,41 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_intent"]; - }; - }; + 'application/json': components['schemas']['payment_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description 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: number; + amount: number /** @description 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?: number; + application_fee_amount?: number /** * automatic_payment_methods_param * @description When enabled, this PaymentIntent will accept payment methods that you have enabled in the Dashboard and are compatible with this PaymentIntent's other parameters. */ automatic_payment_methods?: { - enabled: boolean; - }; + enabled: boolean + } /** * @description Controls when the funds will be captured from the customer's account. * @enum {string} */ - capture_method?: "automatic" | "manual"; + capture_method?: 'automatic' | 'manual' /** @description Set to `true` to attempt to [confirm](https://stripe.com/docs/api/payment_intents/confirm) this PaymentIntent immediately. This parameter defaults to `false`. When creating and confirming a PaymentIntent at the same time, parameters available in the [confirm](https://stripe.com/docs/api/payment_intents/confirm) API may also be provided. */ - confirm?: boolean; + confirm?: boolean /** @enum {string} */ - confirmation_method?: "automatic" | "manual"; + confirmation_method?: 'automatic' | 'manual' /** @description 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: string; + currency: string /** * @description ID of the Customer this PaymentIntent belongs to, if one exists. * @@ -32645,15 +32426,15 @@ export interface operations { * * If present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. */ - customer?: string; + customer?: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. This parameter is intended for simpler integrations that do not handle customer actions, like [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). */ - error_on_requires_action?: boolean; + error_on_requires_action?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description ID of the mandate to be used for this payment. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). */ - mandate?: string; + mandate?: string /** * secret_key_param * @description This hash contains details about the Mandate to create. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). @@ -32662,30 +32443,30 @@ export interface operations { /** customer_acceptance_param */ customer_acceptance: { /** Format: unix-time */ - accepted_at?: number; + accepted_at?: number /** offline_param */ - offline?: { [key: string]: unknown }; + offline?: { [key: string]: unknown } /** online_param */ online?: { - ip_address: string; - user_agent: string; - }; + ip_address: string + user_agent: string + } /** @enum {string} */ - type: "offline" | "online"; - }; - }; + type: 'offline' | 'online' + } + } /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description Set to `true` to indicate that the customer is not in your checkout flow during this payment attempt, and therefore is unable to authenticate. This parameter is intended for scenarios where you collect card details and [charge them later](https://stripe.com/docs/payments/cards/charging-saved-cards). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). */ - off_session?: Partial & Partial<"one_off" | "recurring">; + off_session?: Partial & Partial<'one_off' | 'recurring'> /** @description The Stripe account ID for which these funds are intended. For details, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ - on_behalf_of?: string; + on_behalf_of?: string /** * @description ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. * * If this parameter is omitted with `confirm=true`, `customer.default_source` will be attached as this PaymentIntent's payment instrument to improve the migration experience for users of the Charges API. We recommend that you explicitly provide the `payment_method` going forward. */ - payment_method?: string; + payment_method?: string /** * payment_method_data_params * @description If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear @@ -32695,201 +32476,201 @@ export interface operations { payment_method_data?: { /** payment_method_param */ acss_debit?: { - account_number: string; - institution_number: string; - transit_number: string; - }; + account_number: string + institution_number: string + transit_number: string + } /** param */ - afterpay_clearpay?: { [key: string]: unknown }; + afterpay_clearpay?: { [key: string]: unknown } /** param */ - alipay?: { [key: string]: unknown }; + alipay?: { [key: string]: unknown } /** param */ au_becs_debit?: { - account_number: string; - bsb_number: string; - }; + account_number: string + bsb_number: string + } /** param */ bacs_debit?: { - account_number?: string; - sort_code?: string; - }; + account_number?: string + sort_code?: string + } /** param */ - bancontact?: { [key: string]: unknown }; + bancontact?: { [key: string]: unknown } /** billing_details_inner_params */ billing_details?: { address?: Partial<{ - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string }> & - Partial<"">; - email?: Partial & Partial<"">; - name?: string; - phone?: string; - }; + Partial<''> + email?: Partial & Partial<''> + name?: string + phone?: string + } /** param */ boleto?: { - tax_id: string; - }; + tax_id: string + } /** param */ eps?: { /** @enum {string} */ bank?: - | "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" - | "dolomitenbank" - | "easybank_ag" - | "erste_bank_und_sparkassen" - | "hypo_alpeadriabank_international_ag" - | "hypo_bank_burgenland_aktiengesellschaft" - | "hypo_noe_lb_fur_niederosterreich_u_wien" - | "hypo_oberosterreich_salzburg_steiermark" - | "hypo_tirol_bank_ag" - | "hypo_vorarlberg_bank_ag" - | "marchfelder_bank" - | "oberbank_ag" - | "raiffeisen_bankengruppe_osterreich" - | "schoellerbank_ag" - | "sparda_bank_wien" - | "volksbank_gruppe" - | "volkskreditbank_ag" - | "vr_bank_braunau"; - }; + | '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' + | 'dolomitenbank' + | 'easybank_ag' + | 'erste_bank_und_sparkassen' + | 'hypo_alpeadriabank_international_ag' + | 'hypo_bank_burgenland_aktiengesellschaft' + | 'hypo_noe_lb_fur_niederosterreich_u_wien' + | 'hypo_oberosterreich_salzburg_steiermark' + | 'hypo_tirol_bank_ag' + | 'hypo_vorarlberg_bank_ag' + | 'marchfelder_bank' + | 'oberbank_ag' + | 'raiffeisen_bankengruppe_osterreich' + | 'schoellerbank_ag' + | 'sparda_bank_wien' + | 'volksbank_gruppe' + | 'volkskreditbank_ag' + | 'vr_bank_braunau' + } /** param */ fpx?: { /** @enum {string} */ bank: - | "affin_bank" - | "agrobank" - | "alliance_bank" - | "ambank" - | "bank_islam" - | "bank_muamalat" - | "bank_rakyat" - | "bsn" - | "cimb" - | "deutsche_bank" - | "hong_leong_bank" - | "hsbc" - | "kfh" - | "maybank2e" - | "maybank2u" - | "ocbc" - | "pb_enterprise" - | "public_bank" - | "rhb" - | "standard_chartered" - | "uob"; - }; + | 'affin_bank' + | 'agrobank' + | 'alliance_bank' + | 'ambank' + | 'bank_islam' + | 'bank_muamalat' + | 'bank_rakyat' + | 'bsn' + | 'cimb' + | 'deutsche_bank' + | 'hong_leong_bank' + | 'hsbc' + | 'kfh' + | 'maybank2e' + | 'maybank2u' + | 'ocbc' + | 'pb_enterprise' + | 'public_bank' + | 'rhb' + | 'standard_chartered' + | 'uob' + } /** param */ - giropay?: { [key: string]: unknown }; + giropay?: { [key: string]: unknown } /** param */ - grabpay?: { [key: string]: unknown }; + grabpay?: { [key: string]: unknown } /** param */ ideal?: { /** @enum {string} */ bank?: - | "abn_amro" - | "asn_bank" - | "bunq" - | "handelsbanken" - | "ing" - | "knab" - | "moneyou" - | "rabobank" - | "regiobank" - | "revolut" - | "sns_bank" - | "triodos_bank" - | "van_lanschot"; - }; + | 'abn_amro' + | 'asn_bank' + | 'bunq' + | 'handelsbanken' + | 'ing' + | 'knab' + | 'moneyou' + | 'rabobank' + | 'regiobank' + | 'revolut' + | 'sns_bank' + | 'triodos_bank' + | 'van_lanschot' + } /** param */ - interac_present?: { [key: string]: unknown }; + interac_present?: { [key: string]: unknown } /** param */ klarna?: { /** date_of_birth */ dob?: { - day: number; - month: number; - year: number; - }; - }; - metadata?: { [key: string]: string }; + day: number + month: number + year: number + } + } + metadata?: { [key: string]: string } /** param */ - oxxo?: { [key: string]: unknown }; + oxxo?: { [key: string]: unknown } /** param */ p24?: { /** @enum {string} */ bank?: - | "alior_bank" - | "bank_millennium" - | "bank_nowy_bfg_sa" - | "bank_pekao_sa" - | "banki_spbdzielcze" - | "blik" - | "bnp_paribas" - | "boz" - | "citi_handlowy" - | "credit_agricole" - | "envelobank" - | "etransfer_pocztowy24" - | "getin_bank" - | "ideabank" - | "ing" - | "inteligo" - | "mbank_mtransfer" - | "nest_przelew" - | "noble_pay" - | "pbac_z_ipko" - | "plus_bank" - | "santander_przelew24" - | "tmobile_usbugi_bankowe" - | "toyota_bank" - | "volkswagen_bank"; - }; + | 'alior_bank' + | 'bank_millennium' + | 'bank_nowy_bfg_sa' + | 'bank_pekao_sa' + | 'banki_spbdzielcze' + | 'blik' + | 'bnp_paribas' + | 'boz' + | 'citi_handlowy' + | 'credit_agricole' + | 'envelobank' + | 'etransfer_pocztowy24' + | 'getin_bank' + | 'ideabank' + | 'ing' + | 'inteligo' + | 'mbank_mtransfer' + | 'nest_przelew' + | 'noble_pay' + | 'pbac_z_ipko' + | 'plus_bank' + | 'santander_przelew24' + | 'tmobile_usbugi_bankowe' + | 'toyota_bank' + | 'volkswagen_bank' + } /** param */ sepa_debit?: { - iban: string; - }; + iban: string + } /** param */ sofort?: { /** @enum {string} */ - country: "AT" | "BE" | "DE" | "ES" | "IT" | "NL"; - }; + country: 'AT' | 'BE' | 'DE' | 'ES' | 'IT' | 'NL' + } /** @enum {string} */ type: - | "acss_debit" - | "afterpay_clearpay" - | "alipay" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "eps" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "klarna" - | "oxxo" - | "p24" - | "sepa_debit" - | "sofort" - | "wechat_pay"; + | 'acss_debit' + | 'afterpay_clearpay' + | 'alipay' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'eps' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'klarna' + | 'oxxo' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' /** param */ - wechat_pay?: { [key: string]: unknown }; - }; + wechat_pay?: { [key: string]: unknown } + } /** * payment_method_options_param * @description Payment-method-specific configuration for this PaymentIntent. @@ -32898,136 +32679,126 @@ export interface operations { acss_debit?: Partial<{ /** payment_intent_payment_method_options_mandate_options_param */ mandate_options?: { - custom_mandate_url?: Partial & Partial<"">; - interval_description?: string; + custom_mandate_url?: Partial & Partial<''> + interval_description?: string /** @enum {string} */ - payment_schedule?: "combined" | "interval" | "sporadic"; + payment_schedule?: 'combined' | 'interval' | 'sporadic' /** @enum {string} */ - transaction_type?: "business" | "personal"; - }; + transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; + verification_method?: 'automatic' | 'instant' | 'microdeposits' }> & - Partial<"">; + Partial<''> afterpay_clearpay?: Partial<{ - reference?: string; + reference?: string }> & - Partial<"">; - alipay?: Partial<{ [key: string]: unknown }> & Partial<"">; - au_becs_debit?: Partial<{ [key: string]: unknown }> & Partial<"">; - bacs_debit?: Partial<{ [key: string]: unknown }> & Partial<"">; + Partial<''> + alipay?: Partial<{ [key: string]: unknown }> & Partial<''> + au_becs_debit?: Partial<{ [key: string]: unknown }> & Partial<''> + bacs_debit?: Partial<{ [key: string]: unknown }> & Partial<''> bancontact?: Partial<{ /** @enum {string} */ - preferred_language?: "de" | "en" | "fr" | "nl"; + preferred_language?: 'de' | 'en' | 'fr' | 'nl' }> & - Partial<"">; + Partial<''> boleto?: Partial<{ - expires_after_days?: number; + expires_after_days?: number }> & - Partial<"">; + Partial<''> card?: Partial<{ - cvc_token?: string; + cvc_token?: string /** installments_param */ installments?: { - enabled?: boolean; + enabled?: boolean plan?: Partial<{ - count: number; + count: number /** @enum {string} */ - interval: "month"; + interval: 'month' /** @enum {string} */ - type: "fixed_count"; + type: 'fixed_count' }> & - Partial<"">; - }; + Partial<''> + } /** @enum {string} */ - network?: - | "amex" - | "cartes_bancaires" - | "diners" - | "discover" - | "interac" - | "jcb" - | "mastercard" - | "unionpay" - | "unknown" - | "visa"; + network?: 'amex' | 'cartes_bancaires' | 'diners' | 'discover' | 'interac' | 'jcb' | 'mastercard' | 'unionpay' | 'unknown' | 'visa' /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: 'any' | 'automatic' /** @enum {string} */ - setup_future_usage?: "" | "none" | "off_session" | "on_session"; + setup_future_usage?: '' | 'none' | 'off_session' | 'on_session' }> & - Partial<"">; - card_present?: Partial<{ [key: string]: unknown }> & Partial<"">; - eps?: Partial<{ [key: string]: unknown }> & Partial<"">; - fpx?: Partial<{ [key: string]: unknown }> & Partial<"">; - giropay?: Partial<{ [key: string]: unknown }> & Partial<"">; - grabpay?: Partial<{ [key: string]: unknown }> & Partial<"">; - ideal?: Partial<{ [key: string]: unknown }> & Partial<"">; - interac_present?: Partial<{ [key: string]: unknown }> & Partial<"">; + Partial<''> + card_present?: Partial<{ [key: string]: unknown }> & Partial<''> + eps?: Partial<{ [key: string]: unknown }> & Partial<''> + fpx?: Partial<{ [key: string]: unknown }> & Partial<''> + giropay?: Partial<{ [key: string]: unknown }> & Partial<''> + grabpay?: Partial<{ [key: string]: unknown }> & Partial<''> + ideal?: Partial<{ [key: string]: unknown }> & Partial<''> + interac_present?: Partial<{ [key: string]: unknown }> & Partial<''> klarna?: Partial<{ /** @enum {string} */ preferred_locale?: - | "da-DK" - | "de-AT" - | "de-DE" - | "en-AT" - | "en-BE" - | "en-DE" - | "en-DK" - | "en-ES" - | "en-FI" - | "en-FR" - | "en-GB" - | "en-IE" - | "en-IT" - | "en-NL" - | "en-NO" - | "en-SE" - | "en-US" - | "es-ES" - | "es-US" - | "fi-FI" - | "fr-BE" - | "fr-FR" - | "it-IT" - | "nb-NO" - | "nl-BE" - | "nl-NL" - | "sv-FI" - | "sv-SE"; + | 'da-DK' + | 'de-AT' + | 'de-DE' + | 'en-AT' + | 'en-BE' + | 'en-DE' + | 'en-DK' + | 'en-ES' + | 'en-FI' + | 'en-FR' + | 'en-GB' + | 'en-IE' + | 'en-IT' + | 'en-NL' + | 'en-NO' + | 'en-SE' + | 'en-US' + | 'es-ES' + | 'es-US' + | 'fi-FI' + | 'fr-BE' + | 'fr-FR' + | 'it-IT' + | 'nb-NO' + | 'nl-BE' + | 'nl-NL' + | 'sv-FI' + | 'sv-SE' }> & - Partial<"">; + Partial<''> oxxo?: Partial<{ - expires_after_days?: number; + expires_after_days?: number }> & - Partial<"">; + Partial<''> p24?: Partial<{ - tos_shown_and_accepted?: boolean; + tos_shown_and_accepted?: boolean }> & - Partial<"">; + Partial<''> sepa_debit?: Partial<{ /** payment_method_options_mandate_options_param */ - mandate_options?: { [key: string]: unknown }; + mandate_options?: { [key: string]: unknown } }> & - Partial<"">; + Partial<''> sofort?: Partial<{ /** @enum {string} */ - preferred_language?: "" | "de" | "en" | "es" | "fr" | "it" | "nl" | "pl"; + preferred_language?: '' | 'de' | 'en' | 'es' | 'fr' | 'it' | 'nl' | 'pl' }> & - Partial<"">; + Partial<''> wechat_pay?: Partial<{ - app_id?: string; + app_id?: string /** @enum {string} */ - client: "android" | "ios" | "web"; + client: 'android' | 'ios' | 'web' }> & - Partial<"">; - }; + Partial<''> + } /** @description The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. If this is not provided, defaults to ["card"]. */ - payment_method_types?: string[]; + payment_method_types?: string[] /** @description 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?: string; + receipt_email?: string /** @description The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). */ - return_url?: string; + return_url?: string /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * @@ -33036,7 +32807,7 @@ export interface operations { * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ - setup_future_usage?: "off_session" | "on_session"; + setup_future_usage?: 'off_session' | 'on_session' /** * optional_fields_shipping * @description Shipping information for this PaymentIntent. @@ -33044,39 +32815,39 @@ export interface operations { shipping?: { /** optional_fields_address */ address: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - carrier?: string; - name: string; - phone?: string; - tracking_number?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + carrier?: string + name: string + phone?: string + tracking_number?: string + } /** @description For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - statement_descriptor_suffix?: string; + statement_descriptor_suffix?: string /** * transfer_data_creation_params * @description The parameters used to automatically create a Transfer when the payment succeeds. * For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ transfer_data?: { - amount?: number; - destination: string; - }; + amount?: number + destination: string + } /** @description A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. */ - transfer_group?: string; + transfer_group?: string /** @description Set to `true` only when using manual confirmation and the iOS or Android SDKs to handle additional authentication steps. */ - use_stripe_sdk?: boolean; - }; - }; - }; - }; + use_stripe_sdk?: boolean + } + } + } + } /** *

Retrieves the details of a PaymentIntent that has previously been created.

* @@ -33088,34 +32859,34 @@ export interface operations { parameters: { query: { /** The client secret of the PaymentIntent. Required if a publishable key is used to retrieve the source. */ - client_secret?: string; + client_secret?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - intent: string; - }; - }; + intent: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_intent"]; - }; - }; + 'application/json': components['schemas']['payment_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates properties on a PaymentIntent object without confirming.

* @@ -33128,32 +32899,32 @@ export interface operations { PostPaymentIntentsIntent: { parameters: { path: { - intent: string; - }; - }; + intent: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_intent"]; - }; - }; + 'application/json': components['schemas']['payment_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description 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?: number; + amount?: number /** @description 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?: Partial & Partial<"">; + application_fee_amount?: Partial & Partial<''> /** @description 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?: string; + currency?: string /** * @description ID of the Customer this PaymentIntent belongs to, if one exists. * @@ -33161,15 +32932,15 @@ export interface operations { * * If present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. */ - customer?: string; + customer?: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. */ - payment_method?: string; + payment_method?: string /** * payment_method_data_params * @description If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear @@ -33179,201 +32950,201 @@ export interface operations { payment_method_data?: { /** payment_method_param */ acss_debit?: { - account_number: string; - institution_number: string; - transit_number: string; - }; + account_number: string + institution_number: string + transit_number: string + } /** param */ - afterpay_clearpay?: { [key: string]: unknown }; + afterpay_clearpay?: { [key: string]: unknown } /** param */ - alipay?: { [key: string]: unknown }; + alipay?: { [key: string]: unknown } /** param */ au_becs_debit?: { - account_number: string; - bsb_number: string; - }; + account_number: string + bsb_number: string + } /** param */ bacs_debit?: { - account_number?: string; - sort_code?: string; - }; + account_number?: string + sort_code?: string + } /** param */ - bancontact?: { [key: string]: unknown }; + bancontact?: { [key: string]: unknown } /** billing_details_inner_params */ billing_details?: { address?: Partial<{ - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string }> & - Partial<"">; - email?: Partial & Partial<"">; - name?: string; - phone?: string; - }; + Partial<''> + email?: Partial & Partial<''> + name?: string + phone?: string + } /** param */ boleto?: { - tax_id: string; - }; + tax_id: string + } /** param */ eps?: { /** @enum {string} */ bank?: - | "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" - | "dolomitenbank" - | "easybank_ag" - | "erste_bank_und_sparkassen" - | "hypo_alpeadriabank_international_ag" - | "hypo_bank_burgenland_aktiengesellschaft" - | "hypo_noe_lb_fur_niederosterreich_u_wien" - | "hypo_oberosterreich_salzburg_steiermark" - | "hypo_tirol_bank_ag" - | "hypo_vorarlberg_bank_ag" - | "marchfelder_bank" - | "oberbank_ag" - | "raiffeisen_bankengruppe_osterreich" - | "schoellerbank_ag" - | "sparda_bank_wien" - | "volksbank_gruppe" - | "volkskreditbank_ag" - | "vr_bank_braunau"; - }; + | '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' + | 'dolomitenbank' + | 'easybank_ag' + | 'erste_bank_und_sparkassen' + | 'hypo_alpeadriabank_international_ag' + | 'hypo_bank_burgenland_aktiengesellschaft' + | 'hypo_noe_lb_fur_niederosterreich_u_wien' + | 'hypo_oberosterreich_salzburg_steiermark' + | 'hypo_tirol_bank_ag' + | 'hypo_vorarlberg_bank_ag' + | 'marchfelder_bank' + | 'oberbank_ag' + | 'raiffeisen_bankengruppe_osterreich' + | 'schoellerbank_ag' + | 'sparda_bank_wien' + | 'volksbank_gruppe' + | 'volkskreditbank_ag' + | 'vr_bank_braunau' + } /** param */ fpx?: { /** @enum {string} */ bank: - | "affin_bank" - | "agrobank" - | "alliance_bank" - | "ambank" - | "bank_islam" - | "bank_muamalat" - | "bank_rakyat" - | "bsn" - | "cimb" - | "deutsche_bank" - | "hong_leong_bank" - | "hsbc" - | "kfh" - | "maybank2e" - | "maybank2u" - | "ocbc" - | "pb_enterprise" - | "public_bank" - | "rhb" - | "standard_chartered" - | "uob"; - }; + | 'affin_bank' + | 'agrobank' + | 'alliance_bank' + | 'ambank' + | 'bank_islam' + | 'bank_muamalat' + | 'bank_rakyat' + | 'bsn' + | 'cimb' + | 'deutsche_bank' + | 'hong_leong_bank' + | 'hsbc' + | 'kfh' + | 'maybank2e' + | 'maybank2u' + | 'ocbc' + | 'pb_enterprise' + | 'public_bank' + | 'rhb' + | 'standard_chartered' + | 'uob' + } /** param */ - giropay?: { [key: string]: unknown }; + giropay?: { [key: string]: unknown } /** param */ - grabpay?: { [key: string]: unknown }; + grabpay?: { [key: string]: unknown } /** param */ ideal?: { /** @enum {string} */ bank?: - | "abn_amro" - | "asn_bank" - | "bunq" - | "handelsbanken" - | "ing" - | "knab" - | "moneyou" - | "rabobank" - | "regiobank" - | "revolut" - | "sns_bank" - | "triodos_bank" - | "van_lanschot"; - }; + | 'abn_amro' + | 'asn_bank' + | 'bunq' + | 'handelsbanken' + | 'ing' + | 'knab' + | 'moneyou' + | 'rabobank' + | 'regiobank' + | 'revolut' + | 'sns_bank' + | 'triodos_bank' + | 'van_lanschot' + } /** param */ - interac_present?: { [key: string]: unknown }; + interac_present?: { [key: string]: unknown } /** param */ klarna?: { /** date_of_birth */ dob?: { - day: number; - month: number; - year: number; - }; - }; - metadata?: { [key: string]: string }; + day: number + month: number + year: number + } + } + metadata?: { [key: string]: string } /** param */ - oxxo?: { [key: string]: unknown }; + oxxo?: { [key: string]: unknown } /** param */ p24?: { /** @enum {string} */ bank?: - | "alior_bank" - | "bank_millennium" - | "bank_nowy_bfg_sa" - | "bank_pekao_sa" - | "banki_spbdzielcze" - | "blik" - | "bnp_paribas" - | "boz" - | "citi_handlowy" - | "credit_agricole" - | "envelobank" - | "etransfer_pocztowy24" - | "getin_bank" - | "ideabank" - | "ing" - | "inteligo" - | "mbank_mtransfer" - | "nest_przelew" - | "noble_pay" - | "pbac_z_ipko" - | "plus_bank" - | "santander_przelew24" - | "tmobile_usbugi_bankowe" - | "toyota_bank" - | "volkswagen_bank"; - }; + | 'alior_bank' + | 'bank_millennium' + | 'bank_nowy_bfg_sa' + | 'bank_pekao_sa' + | 'banki_spbdzielcze' + | 'blik' + | 'bnp_paribas' + | 'boz' + | 'citi_handlowy' + | 'credit_agricole' + | 'envelobank' + | 'etransfer_pocztowy24' + | 'getin_bank' + | 'ideabank' + | 'ing' + | 'inteligo' + | 'mbank_mtransfer' + | 'nest_przelew' + | 'noble_pay' + | 'pbac_z_ipko' + | 'plus_bank' + | 'santander_przelew24' + | 'tmobile_usbugi_bankowe' + | 'toyota_bank' + | 'volkswagen_bank' + } /** param */ sepa_debit?: { - iban: string; - }; + iban: string + } /** param */ sofort?: { /** @enum {string} */ - country: "AT" | "BE" | "DE" | "ES" | "IT" | "NL"; - }; + country: 'AT' | 'BE' | 'DE' | 'ES' | 'IT' | 'NL' + } /** @enum {string} */ type: - | "acss_debit" - | "afterpay_clearpay" - | "alipay" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "eps" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "klarna" - | "oxxo" - | "p24" - | "sepa_debit" - | "sofort" - | "wechat_pay"; + | 'acss_debit' + | 'afterpay_clearpay' + | 'alipay' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'eps' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'klarna' + | 'oxxo' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' /** param */ - wechat_pay?: { [key: string]: unknown }; - }; + wechat_pay?: { [key: string]: unknown } + } /** * payment_method_options_param * @description Payment-method-specific configuration for this PaymentIntent. @@ -33382,134 +33153,124 @@ export interface operations { acss_debit?: Partial<{ /** payment_intent_payment_method_options_mandate_options_param */ mandate_options?: { - custom_mandate_url?: Partial & Partial<"">; - interval_description?: string; + custom_mandate_url?: Partial & Partial<''> + interval_description?: string /** @enum {string} */ - payment_schedule?: "combined" | "interval" | "sporadic"; + payment_schedule?: 'combined' | 'interval' | 'sporadic' /** @enum {string} */ - transaction_type?: "business" | "personal"; - }; + transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; + verification_method?: 'automatic' | 'instant' | 'microdeposits' }> & - Partial<"">; + Partial<''> afterpay_clearpay?: Partial<{ - reference?: string; + reference?: string }> & - Partial<"">; - alipay?: Partial<{ [key: string]: unknown }> & Partial<"">; - au_becs_debit?: Partial<{ [key: string]: unknown }> & Partial<"">; - bacs_debit?: Partial<{ [key: string]: unknown }> & Partial<"">; + Partial<''> + alipay?: Partial<{ [key: string]: unknown }> & Partial<''> + au_becs_debit?: Partial<{ [key: string]: unknown }> & Partial<''> + bacs_debit?: Partial<{ [key: string]: unknown }> & Partial<''> bancontact?: Partial<{ /** @enum {string} */ - preferred_language?: "de" | "en" | "fr" | "nl"; + preferred_language?: 'de' | 'en' | 'fr' | 'nl' }> & - Partial<"">; + Partial<''> boleto?: Partial<{ - expires_after_days?: number; + expires_after_days?: number }> & - Partial<"">; + Partial<''> card?: Partial<{ - cvc_token?: string; + cvc_token?: string /** installments_param */ installments?: { - enabled?: boolean; + enabled?: boolean plan?: Partial<{ - count: number; + count: number /** @enum {string} */ - interval: "month"; + interval: 'month' /** @enum {string} */ - type: "fixed_count"; + type: 'fixed_count' }> & - Partial<"">; - }; + Partial<''> + } /** @enum {string} */ - network?: - | "amex" - | "cartes_bancaires" - | "diners" - | "discover" - | "interac" - | "jcb" - | "mastercard" - | "unionpay" - | "unknown" - | "visa"; + network?: 'amex' | 'cartes_bancaires' | 'diners' | 'discover' | 'interac' | 'jcb' | 'mastercard' | 'unionpay' | 'unknown' | 'visa' /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: 'any' | 'automatic' /** @enum {string} */ - setup_future_usage?: "" | "none" | "off_session" | "on_session"; + setup_future_usage?: '' | 'none' | 'off_session' | 'on_session' }> & - Partial<"">; - card_present?: Partial<{ [key: string]: unknown }> & Partial<"">; - eps?: Partial<{ [key: string]: unknown }> & Partial<"">; - fpx?: Partial<{ [key: string]: unknown }> & Partial<"">; - giropay?: Partial<{ [key: string]: unknown }> & Partial<"">; - grabpay?: Partial<{ [key: string]: unknown }> & Partial<"">; - ideal?: Partial<{ [key: string]: unknown }> & Partial<"">; - interac_present?: Partial<{ [key: string]: unknown }> & Partial<"">; + Partial<''> + card_present?: Partial<{ [key: string]: unknown }> & Partial<''> + eps?: Partial<{ [key: string]: unknown }> & Partial<''> + fpx?: Partial<{ [key: string]: unknown }> & Partial<''> + giropay?: Partial<{ [key: string]: unknown }> & Partial<''> + grabpay?: Partial<{ [key: string]: unknown }> & Partial<''> + ideal?: Partial<{ [key: string]: unknown }> & Partial<''> + interac_present?: Partial<{ [key: string]: unknown }> & Partial<''> klarna?: Partial<{ /** @enum {string} */ preferred_locale?: - | "da-DK" - | "de-AT" - | "de-DE" - | "en-AT" - | "en-BE" - | "en-DE" - | "en-DK" - | "en-ES" - | "en-FI" - | "en-FR" - | "en-GB" - | "en-IE" - | "en-IT" - | "en-NL" - | "en-NO" - | "en-SE" - | "en-US" - | "es-ES" - | "es-US" - | "fi-FI" - | "fr-BE" - | "fr-FR" - | "it-IT" - | "nb-NO" - | "nl-BE" - | "nl-NL" - | "sv-FI" - | "sv-SE"; + | 'da-DK' + | 'de-AT' + | 'de-DE' + | 'en-AT' + | 'en-BE' + | 'en-DE' + | 'en-DK' + | 'en-ES' + | 'en-FI' + | 'en-FR' + | 'en-GB' + | 'en-IE' + | 'en-IT' + | 'en-NL' + | 'en-NO' + | 'en-SE' + | 'en-US' + | 'es-ES' + | 'es-US' + | 'fi-FI' + | 'fr-BE' + | 'fr-FR' + | 'it-IT' + | 'nb-NO' + | 'nl-BE' + | 'nl-NL' + | 'sv-FI' + | 'sv-SE' }> & - Partial<"">; + Partial<''> oxxo?: Partial<{ - expires_after_days?: number; + expires_after_days?: number }> & - Partial<"">; + Partial<''> p24?: Partial<{ - tos_shown_and_accepted?: boolean; + tos_shown_and_accepted?: boolean }> & - Partial<"">; + Partial<''> sepa_debit?: Partial<{ /** payment_method_options_mandate_options_param */ - mandate_options?: { [key: string]: unknown }; + mandate_options?: { [key: string]: unknown } }> & - Partial<"">; + Partial<''> sofort?: Partial<{ /** @enum {string} */ - preferred_language?: "" | "de" | "en" | "es" | "fr" | "it" | "nl" | "pl"; + preferred_language?: '' | 'de' | 'en' | 'es' | 'fr' | 'it' | 'nl' | 'pl' }> & - Partial<"">; + Partial<''> wechat_pay?: Partial<{ - app_id?: string; + app_id?: string /** @enum {string} */ - client: "android" | "ios" | "web"; + client: 'android' | 'ios' | 'web' }> & - Partial<"">; - }; + Partial<''> + } /** @description The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. */ - payment_method_types?: string[]; + payment_method_types?: string[] /** @description 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?: Partial & Partial<"">; + receipt_email?: Partial & Partial<''> /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * @@ -33520,41 +33281,41 @@ export interface operations { * If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. * @enum {string} */ - setup_future_usage?: "" | "off_session" | "on_session"; + setup_future_usage?: '' | 'off_session' | 'on_session' /** @description Shipping information for this PaymentIntent. */ shipping?: Partial<{ /** optional_fields_address */ address: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - carrier?: string; - name: string; - phone?: string; - tracking_number?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + carrier?: string + name: string + phone?: string + tracking_number?: string }> & - Partial<"">; + Partial<''> /** @description For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - statement_descriptor_suffix?: string; + statement_descriptor_suffix?: string /** * transfer_data_update_params * @description The parameters used to automatically create a Transfer when the payment succeeds. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ transfer_data?: { - amount?: number; - }; + amount?: number + } /** @description A string that identifies the resulting payment as part of a group. `transfer_group` may only be provided if it has not been set. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. */ - transfer_group?: string; - }; - }; - }; - }; + transfer_group?: string + } + } + } + } /** *

A PaymentIntent object can be canceled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action, or processing.

* @@ -33563,37 +33324,37 @@ export interface operations { PostPaymentIntentsIntentCancel: { parameters: { path: { - intent: string; - }; - }; + intent: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_intent"]; - }; - }; + 'application/json': components['schemas']['payment_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * @description Reason for canceling this PaymentIntent. Possible values are `duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned` * @enum {string} */ - cancellation_reason?: "abandoned" | "duplicate" | "fraudulent" | "requested_by_customer"; + cancellation_reason?: 'abandoned' | 'duplicate' | 'fraudulent' | 'requested_by_customer' /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /** *

Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.

* @@ -33604,48 +33365,48 @@ export interface operations { PostPaymentIntentsIntentCapture: { parameters: { path: { - intent: string; - }; - }; + intent: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_intent"]; - }; - }; + 'application/json': components['schemas']['payment_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The amount to capture from the PaymentIntent, which must be less than or equal to the original amount. Any additional amount will be automatically refunded. Defaults to the full `amount_capturable` if not provided. */ - amount_to_capture?: number; + amount_to_capture?: number /** @description 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?: number; + application_fee_amount?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ - statement_descriptor_suffix?: string; + statement_descriptor_suffix?: string /** * transfer_data_update_params * @description The parameters used to automatically create a Transfer when the payment * is captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ transfer_data?: { - amount?: number; - }; - }; - }; - }; - }; + amount?: number + } + } + } + } + } /** *

Confirm that your customer intends to pay with current or provided * payment method. Upon confirmation, the PaymentIntent will attempt to initiate @@ -33676,67 +33437,67 @@ export interface operations { PostPaymentIntentsIntentConfirm: { parameters: { path: { - intent: string; - }; - }; + intent: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_intent"]; - }; - }; + 'application/json': components['schemas']['payment_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The client secret of the PaymentIntent. */ - client_secret?: string; + client_secret?: string /** @description Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. This parameter is intended for simpler integrations that do not handle customer actions, like [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication). */ - error_on_requires_action?: boolean; + error_on_requires_action?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description ID of the mandate to be used for this payment. */ - mandate?: string; + mandate?: string /** @description This hash contains details about the Mandate to create */ mandate_data?: Partial<{ /** customer_acceptance_param */ customer_acceptance: { /** Format: unix-time */ - accepted_at?: number; + accepted_at?: number /** offline_param */ - offline?: { [key: string]: unknown }; + offline?: { [key: string]: unknown } /** online_param */ online?: { - ip_address: string; - user_agent: string; - }; + ip_address: string + user_agent: string + } /** @enum {string} */ - type: "offline" | "online"; - }; + type: 'offline' | 'online' + } }> & Partial<{ /** customer_acceptance_param */ customer_acceptance: { /** online_param */ online: { - ip_address?: string; - user_agent?: string; - }; + ip_address?: string + user_agent?: string + } /** @enum {string} */ - type: "online"; - }; - }>; + type: 'online' + } + }> /** @description Set to `true` to indicate that the customer is not in your checkout flow during this payment attempt, and therefore is unable to authenticate. This parameter is intended for scenarios where you collect card details and [charge them later](https://stripe.com/docs/payments/cards/charging-saved-cards). */ - off_session?: Partial & Partial<"one_off" | "recurring">; + off_session?: Partial & Partial<'one_off' | 'recurring'> /** @description ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. */ - payment_method?: string; + payment_method?: string /** * payment_method_data_params * @description If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear @@ -33746,201 +33507,201 @@ export interface operations { payment_method_data?: { /** payment_method_param */ acss_debit?: { - account_number: string; - institution_number: string; - transit_number: string; - }; + account_number: string + institution_number: string + transit_number: string + } /** param */ - afterpay_clearpay?: { [key: string]: unknown }; + afterpay_clearpay?: { [key: string]: unknown } /** param */ - alipay?: { [key: string]: unknown }; + alipay?: { [key: string]: unknown } /** param */ au_becs_debit?: { - account_number: string; - bsb_number: string; - }; + account_number: string + bsb_number: string + } /** param */ bacs_debit?: { - account_number?: string; - sort_code?: string; - }; + account_number?: string + sort_code?: string + } /** param */ - bancontact?: { [key: string]: unknown }; + bancontact?: { [key: string]: unknown } /** billing_details_inner_params */ billing_details?: { address?: Partial<{ - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string }> & - Partial<"">; - email?: Partial & Partial<"">; - name?: string; - phone?: string; - }; + Partial<''> + email?: Partial & Partial<''> + name?: string + phone?: string + } /** param */ boleto?: { - tax_id: string; - }; + tax_id: string + } /** param */ eps?: { /** @enum {string} */ bank?: - | "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" - | "dolomitenbank" - | "easybank_ag" - | "erste_bank_und_sparkassen" - | "hypo_alpeadriabank_international_ag" - | "hypo_bank_burgenland_aktiengesellschaft" - | "hypo_noe_lb_fur_niederosterreich_u_wien" - | "hypo_oberosterreich_salzburg_steiermark" - | "hypo_tirol_bank_ag" - | "hypo_vorarlberg_bank_ag" - | "marchfelder_bank" - | "oberbank_ag" - | "raiffeisen_bankengruppe_osterreich" - | "schoellerbank_ag" - | "sparda_bank_wien" - | "volksbank_gruppe" - | "volkskreditbank_ag" - | "vr_bank_braunau"; - }; + | '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' + | 'dolomitenbank' + | 'easybank_ag' + | 'erste_bank_und_sparkassen' + | 'hypo_alpeadriabank_international_ag' + | 'hypo_bank_burgenland_aktiengesellschaft' + | 'hypo_noe_lb_fur_niederosterreich_u_wien' + | 'hypo_oberosterreich_salzburg_steiermark' + | 'hypo_tirol_bank_ag' + | 'hypo_vorarlberg_bank_ag' + | 'marchfelder_bank' + | 'oberbank_ag' + | 'raiffeisen_bankengruppe_osterreich' + | 'schoellerbank_ag' + | 'sparda_bank_wien' + | 'volksbank_gruppe' + | 'volkskreditbank_ag' + | 'vr_bank_braunau' + } /** param */ fpx?: { /** @enum {string} */ bank: - | "affin_bank" - | "agrobank" - | "alliance_bank" - | "ambank" - | "bank_islam" - | "bank_muamalat" - | "bank_rakyat" - | "bsn" - | "cimb" - | "deutsche_bank" - | "hong_leong_bank" - | "hsbc" - | "kfh" - | "maybank2e" - | "maybank2u" - | "ocbc" - | "pb_enterprise" - | "public_bank" - | "rhb" - | "standard_chartered" - | "uob"; - }; + | 'affin_bank' + | 'agrobank' + | 'alliance_bank' + | 'ambank' + | 'bank_islam' + | 'bank_muamalat' + | 'bank_rakyat' + | 'bsn' + | 'cimb' + | 'deutsche_bank' + | 'hong_leong_bank' + | 'hsbc' + | 'kfh' + | 'maybank2e' + | 'maybank2u' + | 'ocbc' + | 'pb_enterprise' + | 'public_bank' + | 'rhb' + | 'standard_chartered' + | 'uob' + } /** param */ - giropay?: { [key: string]: unknown }; + giropay?: { [key: string]: unknown } /** param */ - grabpay?: { [key: string]: unknown }; + grabpay?: { [key: string]: unknown } /** param */ ideal?: { /** @enum {string} */ bank?: - | "abn_amro" - | "asn_bank" - | "bunq" - | "handelsbanken" - | "ing" - | "knab" - | "moneyou" - | "rabobank" - | "regiobank" - | "revolut" - | "sns_bank" - | "triodos_bank" - | "van_lanschot"; - }; + | 'abn_amro' + | 'asn_bank' + | 'bunq' + | 'handelsbanken' + | 'ing' + | 'knab' + | 'moneyou' + | 'rabobank' + | 'regiobank' + | 'revolut' + | 'sns_bank' + | 'triodos_bank' + | 'van_lanschot' + } /** param */ - interac_present?: { [key: string]: unknown }; + interac_present?: { [key: string]: unknown } /** param */ klarna?: { /** date_of_birth */ dob?: { - day: number; - month: number; - year: number; - }; - }; - metadata?: { [key: string]: string }; + day: number + month: number + year: number + } + } + metadata?: { [key: string]: string } /** param */ - oxxo?: { [key: string]: unknown }; + oxxo?: { [key: string]: unknown } /** param */ p24?: { /** @enum {string} */ bank?: - | "alior_bank" - | "bank_millennium" - | "bank_nowy_bfg_sa" - | "bank_pekao_sa" - | "banki_spbdzielcze" - | "blik" - | "bnp_paribas" - | "boz" - | "citi_handlowy" - | "credit_agricole" - | "envelobank" - | "etransfer_pocztowy24" - | "getin_bank" - | "ideabank" - | "ing" - | "inteligo" - | "mbank_mtransfer" - | "nest_przelew" - | "noble_pay" - | "pbac_z_ipko" - | "plus_bank" - | "santander_przelew24" - | "tmobile_usbugi_bankowe" - | "toyota_bank" - | "volkswagen_bank"; - }; + | 'alior_bank' + | 'bank_millennium' + | 'bank_nowy_bfg_sa' + | 'bank_pekao_sa' + | 'banki_spbdzielcze' + | 'blik' + | 'bnp_paribas' + | 'boz' + | 'citi_handlowy' + | 'credit_agricole' + | 'envelobank' + | 'etransfer_pocztowy24' + | 'getin_bank' + | 'ideabank' + | 'ing' + | 'inteligo' + | 'mbank_mtransfer' + | 'nest_przelew' + | 'noble_pay' + | 'pbac_z_ipko' + | 'plus_bank' + | 'santander_przelew24' + | 'tmobile_usbugi_bankowe' + | 'toyota_bank' + | 'volkswagen_bank' + } /** param */ sepa_debit?: { - iban: string; - }; + iban: string + } /** param */ sofort?: { /** @enum {string} */ - country: "AT" | "BE" | "DE" | "ES" | "IT" | "NL"; - }; + country: 'AT' | 'BE' | 'DE' | 'ES' | 'IT' | 'NL' + } /** @enum {string} */ type: - | "acss_debit" - | "afterpay_clearpay" - | "alipay" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "eps" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "klarna" - | "oxxo" - | "p24" - | "sepa_debit" - | "sofort" - | "wechat_pay"; + | 'acss_debit' + | 'afterpay_clearpay' + | 'alipay' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'eps' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'klarna' + | 'oxxo' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' /** param */ - wechat_pay?: { [key: string]: unknown }; - }; + wechat_pay?: { [key: string]: unknown } + } /** * payment_method_options_param * @description Payment-method-specific configuration for this PaymentIntent. @@ -33949,140 +33710,130 @@ export interface operations { acss_debit?: Partial<{ /** payment_intent_payment_method_options_mandate_options_param */ mandate_options?: { - custom_mandate_url?: Partial & Partial<"">; - interval_description?: string; + custom_mandate_url?: Partial & Partial<''> + interval_description?: string /** @enum {string} */ - payment_schedule?: "combined" | "interval" | "sporadic"; + payment_schedule?: 'combined' | 'interval' | 'sporadic' /** @enum {string} */ - transaction_type?: "business" | "personal"; - }; + transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; + verification_method?: 'automatic' | 'instant' | 'microdeposits' }> & - Partial<"">; + Partial<''> afterpay_clearpay?: Partial<{ - reference?: string; + reference?: string }> & - Partial<"">; - alipay?: Partial<{ [key: string]: unknown }> & Partial<"">; - au_becs_debit?: Partial<{ [key: string]: unknown }> & Partial<"">; - bacs_debit?: Partial<{ [key: string]: unknown }> & Partial<"">; + Partial<''> + alipay?: Partial<{ [key: string]: unknown }> & Partial<''> + au_becs_debit?: Partial<{ [key: string]: unknown }> & Partial<''> + bacs_debit?: Partial<{ [key: string]: unknown }> & Partial<''> bancontact?: Partial<{ /** @enum {string} */ - preferred_language?: "de" | "en" | "fr" | "nl"; + preferred_language?: 'de' | 'en' | 'fr' | 'nl' }> & - Partial<"">; + Partial<''> boleto?: Partial<{ - expires_after_days?: number; + expires_after_days?: number }> & - Partial<"">; + Partial<''> card?: Partial<{ - cvc_token?: string; + cvc_token?: string /** installments_param */ installments?: { - enabled?: boolean; + enabled?: boolean plan?: Partial<{ - count: number; + count: number /** @enum {string} */ - interval: "month"; + interval: 'month' /** @enum {string} */ - type: "fixed_count"; + type: 'fixed_count' }> & - Partial<"">; - }; + Partial<''> + } /** @enum {string} */ - network?: - | "amex" - | "cartes_bancaires" - | "diners" - | "discover" - | "interac" - | "jcb" - | "mastercard" - | "unionpay" - | "unknown" - | "visa"; + network?: 'amex' | 'cartes_bancaires' | 'diners' | 'discover' | 'interac' | 'jcb' | 'mastercard' | 'unionpay' | 'unknown' | 'visa' /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: 'any' | 'automatic' /** @enum {string} */ - setup_future_usage?: "" | "none" | "off_session" | "on_session"; + setup_future_usage?: '' | 'none' | 'off_session' | 'on_session' }> & - Partial<"">; - card_present?: Partial<{ [key: string]: unknown }> & Partial<"">; - eps?: Partial<{ [key: string]: unknown }> & Partial<"">; - fpx?: Partial<{ [key: string]: unknown }> & Partial<"">; - giropay?: Partial<{ [key: string]: unknown }> & Partial<"">; - grabpay?: Partial<{ [key: string]: unknown }> & Partial<"">; - ideal?: Partial<{ [key: string]: unknown }> & Partial<"">; - interac_present?: Partial<{ [key: string]: unknown }> & Partial<"">; + Partial<''> + card_present?: Partial<{ [key: string]: unknown }> & Partial<''> + eps?: Partial<{ [key: string]: unknown }> & Partial<''> + fpx?: Partial<{ [key: string]: unknown }> & Partial<''> + giropay?: Partial<{ [key: string]: unknown }> & Partial<''> + grabpay?: Partial<{ [key: string]: unknown }> & Partial<''> + ideal?: Partial<{ [key: string]: unknown }> & Partial<''> + interac_present?: Partial<{ [key: string]: unknown }> & Partial<''> klarna?: Partial<{ /** @enum {string} */ preferred_locale?: - | "da-DK" - | "de-AT" - | "de-DE" - | "en-AT" - | "en-BE" - | "en-DE" - | "en-DK" - | "en-ES" - | "en-FI" - | "en-FR" - | "en-GB" - | "en-IE" - | "en-IT" - | "en-NL" - | "en-NO" - | "en-SE" - | "en-US" - | "es-ES" - | "es-US" - | "fi-FI" - | "fr-BE" - | "fr-FR" - | "it-IT" - | "nb-NO" - | "nl-BE" - | "nl-NL" - | "sv-FI" - | "sv-SE"; + | 'da-DK' + | 'de-AT' + | 'de-DE' + | 'en-AT' + | 'en-BE' + | 'en-DE' + | 'en-DK' + | 'en-ES' + | 'en-FI' + | 'en-FR' + | 'en-GB' + | 'en-IE' + | 'en-IT' + | 'en-NL' + | 'en-NO' + | 'en-SE' + | 'en-US' + | 'es-ES' + | 'es-US' + | 'fi-FI' + | 'fr-BE' + | 'fr-FR' + | 'it-IT' + | 'nb-NO' + | 'nl-BE' + | 'nl-NL' + | 'sv-FI' + | 'sv-SE' }> & - Partial<"">; + Partial<''> oxxo?: Partial<{ - expires_after_days?: number; + expires_after_days?: number }> & - Partial<"">; + Partial<''> p24?: Partial<{ - tos_shown_and_accepted?: boolean; + tos_shown_and_accepted?: boolean }> & - Partial<"">; + Partial<''> sepa_debit?: Partial<{ /** payment_method_options_mandate_options_param */ - mandate_options?: { [key: string]: unknown }; + mandate_options?: { [key: string]: unknown } }> & - Partial<"">; + Partial<''> sofort?: Partial<{ /** @enum {string} */ - preferred_language?: "" | "de" | "en" | "es" | "fr" | "it" | "nl" | "pl"; + preferred_language?: '' | 'de' | 'en' | 'es' | 'fr' | 'it' | 'nl' | 'pl' }> & - Partial<"">; + Partial<''> wechat_pay?: Partial<{ - app_id?: string; + app_id?: string /** @enum {string} */ - client: "android" | "ios" | "web"; + client: 'android' | 'ios' | 'web' }> & - Partial<"">; - }; + Partial<''> + } /** @description The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. */ - payment_method_types?: string[]; + payment_method_types?: string[] /** @description 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?: Partial & Partial<"">; + receipt_email?: Partial & Partial<''> /** * @description The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. * If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. * This parameter is only used for cards and other redirect-based payment methods. */ - return_url?: string; + return_url?: string /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * @@ -34093,130 +33844,130 @@ export interface operations { * If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. * @enum {string} */ - setup_future_usage?: "" | "off_session" | "on_session"; + setup_future_usage?: '' | 'off_session' | 'on_session' /** @description Shipping information for this PaymentIntent. */ shipping?: Partial<{ /** optional_fields_address */ address: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - carrier?: string; - name: string; - phone?: string; - tracking_number?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + carrier?: string + name: string + phone?: string + tracking_number?: string }> & - Partial<"">; + Partial<''> /** @description Set to `true` only when using manual confirmation and the iOS or Android SDKs to handle additional authentication steps. */ - use_stripe_sdk?: boolean; - }; - }; - }; - }; + use_stripe_sdk?: boolean + } + } + } + } /**

Verifies microdeposits on a PaymentIntent object.

*/ PostPaymentIntentsIntentVerifyMicrodeposits: { parameters: { path: { - intent: string; - }; - }; + intent: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_intent"]; - }; - }; + 'application/json': components['schemas']['payment_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account. */ - amounts?: number[]; + amounts?: number[] /** @description The client secret of the PaymentIntent. */ - client_secret?: string; + client_secret?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Returns a list of your payment links.

*/ GetPaymentLinks: { parameters: { query: { /** Only return payment links that are active or inactive (e.g., pass `false` to list all inactive payment links). */ - active?: boolean; + active?: boolean /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["payment_link"][]; + 'application/json': { + data: components['schemas']['payment_link'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a payment link.

*/ PostPaymentLinks: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_link"]; - }; - }; + 'application/json': components['schemas']['payment_link'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * after_completion_params * @description Behavior after the purchase is complete. @@ -34224,52 +33975,52 @@ export interface operations { after_completion?: { /** after_completion_confirmation_page_params */ hosted_confirmation?: { - custom_message?: string; - }; + custom_message?: string + } /** after_completion_redirect_params */ redirect?: { - url: string; - }; + url: string + } /** @enum {string} */ - type: "hosted_confirmation" | "redirect"; - }; + type: 'hosted_confirmation' | 'redirect' + } /** @description Enables user redeemable promotion codes. */ - allow_promotion_codes?: boolean; + allow_promotion_codes?: boolean /** @description 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. Can only be applied when there are no line items with recurring prices. */ - application_fee_amount?: number; + application_fee_amount?: number /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field. */ - application_fee_percent?: number; + application_fee_percent?: number /** * automatic_tax_params * @description Configuration for automatic tax collection. */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** * @description Configuration for collecting the customer's billing address. * @enum {string} */ - billing_address_collection?: "auto" | "required"; + billing_address_collection?: 'auto' | 'required' /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported. */ line_items?: { /** adjustable_quantity_params */ adjustable_quantity?: { - enabled: boolean; - maximum?: number; - minimum?: number; - }; - price: string; - quantity: number; - }[]; + enabled: boolean + maximum?: number + minimum?: number + } + price: string + quantity: number + }[] /** @description 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 associated with this Payment Link will automatically be copied to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link. */ - metadata?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The account on behalf of which to charge. */ - on_behalf_of?: string; + on_behalf_of?: string /** @description The list of payment method types that customers can use. Only `card` is supported. If no value is passed, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods) (20+ payment methods [supported](https://stripe.com/docs/payments/payment-methods/integration-options#payment-method-product-support)). */ - payment_method_types?: "card"[]; + payment_method_types?: 'card'[] /** * phone_number_collection_params * @description Controls phone number collection settings during checkout. @@ -34277,329 +34028,329 @@ export interface operations { * We recommend that you review your privacy policy and check with your legal contacts. */ phone_number_collection?: { - enabled: boolean; - }; + enabled: boolean + } /** * shipping_address_collection_params * @description Configuration for collecting the customer's shipping address. */ shipping_address_collection?: { allowed_countries: ( - | "AC" - | "AD" - | "AE" - | "AF" - | "AG" - | "AI" - | "AL" - | "AM" - | "AO" - | "AQ" - | "AR" - | "AT" - | "AU" - | "AW" - | "AX" - | "AZ" - | "BA" - | "BB" - | "BD" - | "BE" - | "BF" - | "BG" - | "BH" - | "BI" - | "BJ" - | "BL" - | "BM" - | "BN" - | "BO" - | "BQ" - | "BR" - | "BS" - | "BT" - | "BV" - | "BW" - | "BY" - | "BZ" - | "CA" - | "CD" - | "CF" - | "CG" - | "CH" - | "CI" - | "CK" - | "CL" - | "CM" - | "CN" - | "CO" - | "CR" - | "CV" - | "CW" - | "CY" - | "CZ" - | "DE" - | "DJ" - | "DK" - | "DM" - | "DO" - | "DZ" - | "EC" - | "EE" - | "EG" - | "EH" - | "ER" - | "ES" - | "ET" - | "FI" - | "FJ" - | "FK" - | "FO" - | "FR" - | "GA" - | "GB" - | "GD" - | "GE" - | "GF" - | "GG" - | "GH" - | "GI" - | "GL" - | "GM" - | "GN" - | "GP" - | "GQ" - | "GR" - | "GS" - | "GT" - | "GU" - | "GW" - | "GY" - | "HK" - | "HN" - | "HR" - | "HT" - | "HU" - | "ID" - | "IE" - | "IL" - | "IM" - | "IN" - | "IO" - | "IQ" - | "IS" - | "IT" - | "JE" - | "JM" - | "JO" - | "JP" - | "KE" - | "KG" - | "KH" - | "KI" - | "KM" - | "KN" - | "KR" - | "KW" - | "KY" - | "KZ" - | "LA" - | "LB" - | "LC" - | "LI" - | "LK" - | "LR" - | "LS" - | "LT" - | "LU" - | "LV" - | "LY" - | "MA" - | "MC" - | "MD" - | "ME" - | "MF" - | "MG" - | "MK" - | "ML" - | "MM" - | "MN" - | "MO" - | "MQ" - | "MR" - | "MS" - | "MT" - | "MU" - | "MV" - | "MW" - | "MX" - | "MY" - | "MZ" - | "NA" - | "NC" - | "NE" - | "NG" - | "NI" - | "NL" - | "NO" - | "NP" - | "NR" - | "NU" - | "NZ" - | "OM" - | "PA" - | "PE" - | "PF" - | "PG" - | "PH" - | "PK" - | "PL" - | "PM" - | "PN" - | "PR" - | "PS" - | "PT" - | "PY" - | "QA" - | "RE" - | "RO" - | "RS" - | "RU" - | "RW" - | "SA" - | "SB" - | "SC" - | "SE" - | "SG" - | "SH" - | "SI" - | "SJ" - | "SK" - | "SL" - | "SM" - | "SN" - | "SO" - | "SR" - | "SS" - | "ST" - | "SV" - | "SX" - | "SZ" - | "TA" - | "TC" - | "TD" - | "TF" - | "TG" - | "TH" - | "TJ" - | "TK" - | "TL" - | "TM" - | "TN" - | "TO" - | "TR" - | "TT" - | "TV" - | "TW" - | "TZ" - | "UA" - | "UG" - | "US" - | "UY" - | "UZ" - | "VA" - | "VC" - | "VE" - | "VG" - | "VN" - | "VU" - | "WF" - | "WS" - | "XK" - | "YE" - | "YT" - | "ZA" - | "ZM" - | "ZW" - | "ZZ" - )[]; - }; + | 'AC' + | 'AD' + | 'AE' + | 'AF' + | 'AG' + | 'AI' + | 'AL' + | 'AM' + | 'AO' + | 'AQ' + | 'AR' + | 'AT' + | 'AU' + | 'AW' + | 'AX' + | 'AZ' + | 'BA' + | 'BB' + | 'BD' + | 'BE' + | 'BF' + | 'BG' + | 'BH' + | 'BI' + | 'BJ' + | 'BL' + | 'BM' + | 'BN' + | 'BO' + | 'BQ' + | 'BR' + | 'BS' + | 'BT' + | 'BV' + | 'BW' + | 'BY' + | 'BZ' + | 'CA' + | 'CD' + | 'CF' + | 'CG' + | 'CH' + | 'CI' + | 'CK' + | 'CL' + | 'CM' + | 'CN' + | 'CO' + | 'CR' + | 'CV' + | 'CW' + | 'CY' + | 'CZ' + | 'DE' + | 'DJ' + | 'DK' + | 'DM' + | 'DO' + | 'DZ' + | 'EC' + | 'EE' + | 'EG' + | 'EH' + | 'ER' + | 'ES' + | 'ET' + | 'FI' + | 'FJ' + | 'FK' + | 'FO' + | 'FR' + | 'GA' + | 'GB' + | 'GD' + | 'GE' + | 'GF' + | 'GG' + | 'GH' + | 'GI' + | 'GL' + | 'GM' + | 'GN' + | 'GP' + | 'GQ' + | 'GR' + | 'GS' + | 'GT' + | 'GU' + | 'GW' + | 'GY' + | 'HK' + | 'HN' + | 'HR' + | 'HT' + | 'HU' + | 'ID' + | 'IE' + | 'IL' + | 'IM' + | 'IN' + | 'IO' + | 'IQ' + | 'IS' + | 'IT' + | 'JE' + | 'JM' + | 'JO' + | 'JP' + | 'KE' + | 'KG' + | 'KH' + | 'KI' + | 'KM' + | 'KN' + | 'KR' + | 'KW' + | 'KY' + | 'KZ' + | 'LA' + | 'LB' + | 'LC' + | 'LI' + | 'LK' + | 'LR' + | 'LS' + | 'LT' + | 'LU' + | 'LV' + | 'LY' + | 'MA' + | 'MC' + | 'MD' + | 'ME' + | 'MF' + | 'MG' + | 'MK' + | 'ML' + | 'MM' + | 'MN' + | 'MO' + | 'MQ' + | 'MR' + | 'MS' + | 'MT' + | 'MU' + | 'MV' + | 'MW' + | 'MX' + | 'MY' + | 'MZ' + | 'NA' + | 'NC' + | 'NE' + | 'NG' + | 'NI' + | 'NL' + | 'NO' + | 'NP' + | 'NR' + | 'NU' + | 'NZ' + | 'OM' + | 'PA' + | 'PE' + | 'PF' + | 'PG' + | 'PH' + | 'PK' + | 'PL' + | 'PM' + | 'PN' + | 'PR' + | 'PS' + | 'PT' + | 'PY' + | 'QA' + | 'RE' + | 'RO' + | 'RS' + | 'RU' + | 'RW' + | 'SA' + | 'SB' + | 'SC' + | 'SE' + | 'SG' + | 'SH' + | 'SI' + | 'SJ' + | 'SK' + | 'SL' + | 'SM' + | 'SN' + | 'SO' + | 'SR' + | 'SS' + | 'ST' + | 'SV' + | 'SX' + | 'SZ' + | 'TA' + | 'TC' + | 'TD' + | 'TF' + | 'TG' + | 'TH' + | 'TJ' + | 'TK' + | 'TL' + | 'TM' + | 'TN' + | 'TO' + | 'TR' + | 'TT' + | 'TV' + | 'TW' + | 'TZ' + | 'UA' + | 'UG' + | 'US' + | 'UY' + | 'UZ' + | 'VA' + | 'VC' + | 'VE' + | 'VG' + | 'VN' + | 'VU' + | 'WF' + | 'WS' + | 'XK' + | 'YE' + | 'YT' + | 'ZA' + | 'ZM' + | 'ZW' + | 'ZZ' + )[] + } /** * subscription_data_params * @description 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?: { - trial_period_days?: number; - }; + trial_period_days?: number + } /** * transfer_data_params * @description 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?: { - amount?: number; - destination: string; - }; - }; - }; - }; - }; + amount?: number + destination: string + } + } + } + } + } /**

Retrieve a payment link.

*/ GetPaymentLinksPaymentLink: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - payment_link: string; - }; - }; + payment_link: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_link"]; - }; - }; + 'application/json': components['schemas']['payment_link'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates a payment link.

*/ PostPaymentLinksPaymentLink: { parameters: { path: { - payment_link: string; - }; - }; + payment_link: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_link"]; - }; - }; + 'application/json': components['schemas']['payment_link'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description 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?: boolean; + active?: boolean /** * after_completion_params * @description Behavior after the purchase is complete. @@ -34607,410 +34358,410 @@ export interface operations { after_completion?: { /** after_completion_confirmation_page_params */ hosted_confirmation?: { - custom_message?: string; - }; + custom_message?: string + } /** after_completion_redirect_params */ redirect?: { - url: string; - }; + url: string + } /** @enum {string} */ - type: "hosted_confirmation" | "redirect"; - }; + type: 'hosted_confirmation' | 'redirect' + } /** @description Enables user redeemable promotion codes. */ - allow_promotion_codes?: boolean; + allow_promotion_codes?: boolean /** * automatic_tax_params * @description Configuration for automatic tax collection. */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** * @description Configuration for collecting the customer's billing address. * @enum {string} */ - billing_address_collection?: "auto" | "required"; + billing_address_collection?: 'auto' | 'required' /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported. */ line_items?: { /** adjustable_quantity_params */ adjustable_quantity?: { - enabled: boolean; - maximum?: number; - minimum?: number; - }; - id: string; - quantity?: number; - }[]; + enabled: boolean + maximum?: number + minimum?: number + } + id: string + quantity?: number + }[] /** @description 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 associated with this Payment Link will automatically be copied to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link. */ - metadata?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The list of payment method types that customers can use. Only `card` is supported. Pass an empty string to enable automatic payment methods that use your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). */ - payment_method_types?: Partial<"card"[]> & Partial<"">; + payment_method_types?: Partial<'card'[]> & Partial<''> /** @description Configuration for collecting the customer's shipping address. */ shipping_address_collection?: Partial<{ allowed_countries: ( - | "AC" - | "AD" - | "AE" - | "AF" - | "AG" - | "AI" - | "AL" - | "AM" - | "AO" - | "AQ" - | "AR" - | "AT" - | "AU" - | "AW" - | "AX" - | "AZ" - | "BA" - | "BB" - | "BD" - | "BE" - | "BF" - | "BG" - | "BH" - | "BI" - | "BJ" - | "BL" - | "BM" - | "BN" - | "BO" - | "BQ" - | "BR" - | "BS" - | "BT" - | "BV" - | "BW" - | "BY" - | "BZ" - | "CA" - | "CD" - | "CF" - | "CG" - | "CH" - | "CI" - | "CK" - | "CL" - | "CM" - | "CN" - | "CO" - | "CR" - | "CV" - | "CW" - | "CY" - | "CZ" - | "DE" - | "DJ" - | "DK" - | "DM" - | "DO" - | "DZ" - | "EC" - | "EE" - | "EG" - | "EH" - | "ER" - | "ES" - | "ET" - | "FI" - | "FJ" - | "FK" - | "FO" - | "FR" - | "GA" - | "GB" - | "GD" - | "GE" - | "GF" - | "GG" - | "GH" - | "GI" - | "GL" - | "GM" - | "GN" - | "GP" - | "GQ" - | "GR" - | "GS" - | "GT" - | "GU" - | "GW" - | "GY" - | "HK" - | "HN" - | "HR" - | "HT" - | "HU" - | "ID" - | "IE" - | "IL" - | "IM" - | "IN" - | "IO" - | "IQ" - | "IS" - | "IT" - | "JE" - | "JM" - | "JO" - | "JP" - | "KE" - | "KG" - | "KH" - | "KI" - | "KM" - | "KN" - | "KR" - | "KW" - | "KY" - | "KZ" - | "LA" - | "LB" - | "LC" - | "LI" - | "LK" - | "LR" - | "LS" - | "LT" - | "LU" - | "LV" - | "LY" - | "MA" - | "MC" - | "MD" - | "ME" - | "MF" - | "MG" - | "MK" - | "ML" - | "MM" - | "MN" - | "MO" - | "MQ" - | "MR" - | "MS" - | "MT" - | "MU" - | "MV" - | "MW" - | "MX" - | "MY" - | "MZ" - | "NA" - | "NC" - | "NE" - | "NG" - | "NI" - | "NL" - | "NO" - | "NP" - | "NR" - | "NU" - | "NZ" - | "OM" - | "PA" - | "PE" - | "PF" - | "PG" - | "PH" - | "PK" - | "PL" - | "PM" - | "PN" - | "PR" - | "PS" - | "PT" - | "PY" - | "QA" - | "RE" - | "RO" - | "RS" - | "RU" - | "RW" - | "SA" - | "SB" - | "SC" - | "SE" - | "SG" - | "SH" - | "SI" - | "SJ" - | "SK" - | "SL" - | "SM" - | "SN" - | "SO" - | "SR" - | "SS" - | "ST" - | "SV" - | "SX" - | "SZ" - | "TA" - | "TC" - | "TD" - | "TF" - | "TG" - | "TH" - | "TJ" - | "TK" - | "TL" - | "TM" - | "TN" - | "TO" - | "TR" - | "TT" - | "TV" - | "TW" - | "TZ" - | "UA" - | "UG" - | "US" - | "UY" - | "UZ" - | "VA" - | "VC" - | "VE" - | "VG" - | "VN" - | "VU" - | "WF" - | "WS" - | "XK" - | "YE" - | "YT" - | "ZA" - | "ZM" - | "ZW" - | "ZZ" - )[]; + | 'AC' + | 'AD' + | 'AE' + | 'AF' + | 'AG' + | 'AI' + | 'AL' + | 'AM' + | 'AO' + | 'AQ' + | 'AR' + | 'AT' + | 'AU' + | 'AW' + | 'AX' + | 'AZ' + | 'BA' + | 'BB' + | 'BD' + | 'BE' + | 'BF' + | 'BG' + | 'BH' + | 'BI' + | 'BJ' + | 'BL' + | 'BM' + | 'BN' + | 'BO' + | 'BQ' + | 'BR' + | 'BS' + | 'BT' + | 'BV' + | 'BW' + | 'BY' + | 'BZ' + | 'CA' + | 'CD' + | 'CF' + | 'CG' + | 'CH' + | 'CI' + | 'CK' + | 'CL' + | 'CM' + | 'CN' + | 'CO' + | 'CR' + | 'CV' + | 'CW' + | 'CY' + | 'CZ' + | 'DE' + | 'DJ' + | 'DK' + | 'DM' + | 'DO' + | 'DZ' + | 'EC' + | 'EE' + | 'EG' + | 'EH' + | 'ER' + | 'ES' + | 'ET' + | 'FI' + | 'FJ' + | 'FK' + | 'FO' + | 'FR' + | 'GA' + | 'GB' + | 'GD' + | 'GE' + | 'GF' + | 'GG' + | 'GH' + | 'GI' + | 'GL' + | 'GM' + | 'GN' + | 'GP' + | 'GQ' + | 'GR' + | 'GS' + | 'GT' + | 'GU' + | 'GW' + | 'GY' + | 'HK' + | 'HN' + | 'HR' + | 'HT' + | 'HU' + | 'ID' + | 'IE' + | 'IL' + | 'IM' + | 'IN' + | 'IO' + | 'IQ' + | 'IS' + | 'IT' + | 'JE' + | 'JM' + | 'JO' + | 'JP' + | 'KE' + | 'KG' + | 'KH' + | 'KI' + | 'KM' + | 'KN' + | 'KR' + | 'KW' + | 'KY' + | 'KZ' + | 'LA' + | 'LB' + | 'LC' + | 'LI' + | 'LK' + | 'LR' + | 'LS' + | 'LT' + | 'LU' + | 'LV' + | 'LY' + | 'MA' + | 'MC' + | 'MD' + | 'ME' + | 'MF' + | 'MG' + | 'MK' + | 'ML' + | 'MM' + | 'MN' + | 'MO' + | 'MQ' + | 'MR' + | 'MS' + | 'MT' + | 'MU' + | 'MV' + | 'MW' + | 'MX' + | 'MY' + | 'MZ' + | 'NA' + | 'NC' + | 'NE' + | 'NG' + | 'NI' + | 'NL' + | 'NO' + | 'NP' + | 'NR' + | 'NU' + | 'NZ' + | 'OM' + | 'PA' + | 'PE' + | 'PF' + | 'PG' + | 'PH' + | 'PK' + | 'PL' + | 'PM' + | 'PN' + | 'PR' + | 'PS' + | 'PT' + | 'PY' + | 'QA' + | 'RE' + | 'RO' + | 'RS' + | 'RU' + | 'RW' + | 'SA' + | 'SB' + | 'SC' + | 'SE' + | 'SG' + | 'SH' + | 'SI' + | 'SJ' + | 'SK' + | 'SL' + | 'SM' + | 'SN' + | 'SO' + | 'SR' + | 'SS' + | 'ST' + | 'SV' + | 'SX' + | 'SZ' + | 'TA' + | 'TC' + | 'TD' + | 'TF' + | 'TG' + | 'TH' + | 'TJ' + | 'TK' + | 'TL' + | 'TM' + | 'TN' + | 'TO' + | 'TR' + | 'TT' + | 'TV' + | 'TW' + | 'TZ' + | 'UA' + | 'UG' + | 'US' + | 'UY' + | 'UZ' + | 'VA' + | 'VC' + | 'VE' + | 'VG' + | 'VN' + | 'VU' + | 'WF' + | 'WS' + | 'XK' + | 'YE' + | 'YT' + | 'ZA' + | 'ZM' + | 'ZW' + | 'ZZ' + )[] }> & - Partial<"">; - }; - }; - }; - }; + Partial<''> + } + } + } + } /**

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.

*/ GetPaymentLinksPaymentLinkLineItems: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - payment_link: string; - }; - }; + payment_link: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["item"][]; + data: components['schemas']['item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of PaymentMethods. For listing a customer’s payment methods, you should use List a Customer’s PaymentMethods

*/ GetPaymentMethods: { parameters: { query: { /** The ID of the customer whose PaymentMethods will be retrieved. If not provided, the response list will be empty. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** A required filter on the list, based on the object `type` field. */ type: - | "acss_debit" - | "afterpay_clearpay" - | "alipay" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "eps" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "klarna" - | "oxxo" - | "p24" - | "sepa_debit" - | "sofort" - | "wechat_pay"; - }; - }; - responses: { - /** Successful response. */ - 200: { - content: { - "application/json": { - data: components["schemas"]["payment_method"][]; + | 'acss_debit' + | 'afterpay_clearpay' + | 'alipay' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'eps' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'klarna' + | 'oxxo' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' + } + } + responses: { + /** Successful response. */ + 200: { + content: { + 'application/json': { + data: components['schemas']['payment_method'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Creates a PaymentMethod object. Read the Stripe.js reference to learn how to create PaymentMethods via Stripe.js.

* @@ -35021,96 +34772,96 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_method"]; - }; - }; + 'application/json': components['schemas']['payment_method'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * payment_method_param * @description If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. */ acss_debit?: { - account_number: string; - institution_number: string; - transit_number: string; - }; + account_number: string + institution_number: string + transit_number: string + } /** * param * @description If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method. */ - afterpay_clearpay?: { [key: string]: unknown }; + afterpay_clearpay?: { [key: string]: unknown } /** * param * @description If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method. */ - alipay?: { [key: string]: unknown }; + alipay?: { [key: string]: unknown } /** * param * @description If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account. */ au_becs_debit?: { - account_number: string; - bsb_number: string; - }; + account_number: string + bsb_number: string + } /** * param * @description If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account. */ bacs_debit?: { - account_number?: string; - sort_code?: string; - }; + account_number?: string + sort_code?: string + } /** * param * @description If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method. */ - bancontact?: { [key: string]: unknown }; + bancontact?: { [key: string]: unknown } /** * billing_details_inner_params * @description Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods. */ billing_details?: { address?: Partial<{ - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string }> & - Partial<"">; - email?: Partial & Partial<"">; - name?: string; - phone?: string; - }; + Partial<''> + email?: Partial & Partial<''> + name?: string + phone?: string + } /** * param * @description If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method. */ boleto?: { - tax_id: string; - }; + tax_id: string + } /** @description If this is a `card` PaymentMethod, this hash contains the user's card details. For backwards compatibility, you can alternatively provide a Stripe token (e.g., for Apple Pay, Amex Express Checkout, or legacy Checkout) into the card hash with format `card: {token: "tok_visa"}`. When providing a card number, you must meet the requirements for [PCI compliance](https://stripe.com/docs/security#validating-pci-compliance). We strongly recommend using Stripe.js instead of interacting with this API directly. */ card?: Partial<{ - cvc?: string; - exp_month: number; - exp_year: number; - number: string; + cvc?: string + exp_month: number + exp_year: number + number: string }> & Partial<{ - token: string; - }>; + token: string + }> /** @description The `Customer` to whom the original PaymentMethod is attached. */ - customer?: string; + customer?: string /** * param * @description If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method. @@ -35118,36 +34869,36 @@ export interface operations { eps?: { /** @enum {string} */ bank?: - | "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" - | "dolomitenbank" - | "easybank_ag" - | "erste_bank_und_sparkassen" - | "hypo_alpeadriabank_international_ag" - | "hypo_bank_burgenland_aktiengesellschaft" - | "hypo_noe_lb_fur_niederosterreich_u_wien" - | "hypo_oberosterreich_salzburg_steiermark" - | "hypo_tirol_bank_ag" - | "hypo_vorarlberg_bank_ag" - | "marchfelder_bank" - | "oberbank_ag" - | "raiffeisen_bankengruppe_osterreich" - | "schoellerbank_ag" - | "sparda_bank_wien" - | "volksbank_gruppe" - | "volkskreditbank_ag" - | "vr_bank_braunau"; - }; + | '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' + | 'dolomitenbank' + | 'easybank_ag' + | 'erste_bank_und_sparkassen' + | 'hypo_alpeadriabank_international_ag' + | 'hypo_bank_burgenland_aktiengesellschaft' + | 'hypo_noe_lb_fur_niederosterreich_u_wien' + | 'hypo_oberosterreich_salzburg_steiermark' + | 'hypo_tirol_bank_ag' + | 'hypo_vorarlberg_bank_ag' + | 'marchfelder_bank' + | 'oberbank_ag' + | 'raiffeisen_bankengruppe_osterreich' + | 'schoellerbank_ag' + | 'sparda_bank_wien' + | 'volksbank_gruppe' + | 'volkskreditbank_ag' + | 'vr_bank_braunau' + } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * param * @description If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method. @@ -35155,38 +34906,38 @@ export interface operations { fpx?: { /** @enum {string} */ bank: - | "affin_bank" - | "agrobank" - | "alliance_bank" - | "ambank" - | "bank_islam" - | "bank_muamalat" - | "bank_rakyat" - | "bsn" - | "cimb" - | "deutsche_bank" - | "hong_leong_bank" - | "hsbc" - | "kfh" - | "maybank2e" - | "maybank2u" - | "ocbc" - | "pb_enterprise" - | "public_bank" - | "rhb" - | "standard_chartered" - | "uob"; - }; + | 'affin_bank' + | 'agrobank' + | 'alliance_bank' + | 'ambank' + | 'bank_islam' + | 'bank_muamalat' + | 'bank_rakyat' + | 'bsn' + | 'cimb' + | 'deutsche_bank' + | 'hong_leong_bank' + | 'hsbc' + | 'kfh' + | 'maybank2e' + | 'maybank2u' + | 'ocbc' + | 'pb_enterprise' + | 'public_bank' + | 'rhb' + | 'standard_chartered' + | 'uob' + } /** * param * @description If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method. */ - giropay?: { [key: string]: unknown }; + giropay?: { [key: string]: unknown } /** * param * @description If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method. */ - grabpay?: { [key: string]: unknown }; + grabpay?: { [key: string]: unknown } /** * param * @description If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method. @@ -35194,25 +34945,25 @@ export interface operations { ideal?: { /** @enum {string} */ bank?: - | "abn_amro" - | "asn_bank" - | "bunq" - | "handelsbanken" - | "ing" - | "knab" - | "moneyou" - | "rabobank" - | "regiobank" - | "revolut" - | "sns_bank" - | "triodos_bank" - | "van_lanschot"; - }; + | 'abn_amro' + | 'asn_bank' + | 'bunq' + | 'handelsbanken' + | 'ing' + | 'knab' + | 'moneyou' + | 'rabobank' + | 'regiobank' + | 'revolut' + | 'sns_bank' + | 'triodos_bank' + | 'van_lanschot' + } /** * param * @description If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method. */ - interac_present?: { [key: string]: unknown }; + interac_present?: { [key: string]: unknown } /** * param * @description If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method. @@ -35220,18 +34971,18 @@ export interface operations { klarna?: { /** date_of_birth */ dob?: { - day: number; - month: number; - year: number; - }; - }; + day: number + month: number + year: number + } + } /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * param * @description If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method. */ - oxxo?: { [key: string]: unknown }; + oxxo?: { [key: string]: unknown } /** * param * @description If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method. @@ -35239,171 +34990,171 @@ export interface operations { p24?: { /** @enum {string} */ bank?: - | "alior_bank" - | "bank_millennium" - | "bank_nowy_bfg_sa" - | "bank_pekao_sa" - | "banki_spbdzielcze" - | "blik" - | "bnp_paribas" - | "boz" - | "citi_handlowy" - | "credit_agricole" - | "envelobank" - | "etransfer_pocztowy24" - | "getin_bank" - | "ideabank" - | "ing" - | "inteligo" - | "mbank_mtransfer" - | "nest_przelew" - | "noble_pay" - | "pbac_z_ipko" - | "plus_bank" - | "santander_przelew24" - | "tmobile_usbugi_bankowe" - | "toyota_bank" - | "volkswagen_bank"; - }; + | 'alior_bank' + | 'bank_millennium' + | 'bank_nowy_bfg_sa' + | 'bank_pekao_sa' + | 'banki_spbdzielcze' + | 'blik' + | 'bnp_paribas' + | 'boz' + | 'citi_handlowy' + | 'credit_agricole' + | 'envelobank' + | 'etransfer_pocztowy24' + | 'getin_bank' + | 'ideabank' + | 'ing' + | 'inteligo' + | 'mbank_mtransfer' + | 'nest_przelew' + | 'noble_pay' + | 'pbac_z_ipko' + | 'plus_bank' + | 'santander_przelew24' + | 'tmobile_usbugi_bankowe' + | 'toyota_bank' + | 'volkswagen_bank' + } /** @description The PaymentMethod to share. */ - payment_method?: string; + payment_method?: string /** * param * @description If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account. */ sepa_debit?: { - iban: string; - }; + iban: string + } /** * param * @description If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method. */ sofort?: { /** @enum {string} */ - country: "AT" | "BE" | "DE" | "ES" | "IT" | "NL"; - }; + country: 'AT' | 'BE' | 'DE' | 'ES' | 'IT' | 'NL' + } /** * @description 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. * @enum {string} */ type?: - | "acss_debit" - | "afterpay_clearpay" - | "alipay" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "eps" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "klarna" - | "oxxo" - | "p24" - | "sepa_debit" - | "sofort" - | "wechat_pay"; + | 'acss_debit' + | 'afterpay_clearpay' + | 'alipay' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'eps' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'klarna' + | 'oxxo' + | 'p24' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' /** * param * @description If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method. */ - wechat_pay?: { [key: string]: unknown }; - }; - }; - }; - }; + wechat_pay?: { [key: string]: unknown } + } + } + } + } /**

Retrieves a PaymentMethod object.

*/ GetPaymentMethodsPaymentMethod: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - payment_method: string; - }; - }; + payment_method: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_method"]; - }; - }; + 'application/json': components['schemas']['payment_method'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates a PaymentMethod object. A PaymentMethod must be attached a customer to be updated.

*/ PostPaymentMethodsPaymentMethod: { parameters: { path: { - payment_method: string; - }; - }; + payment_method: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_method"]; - }; - }; + 'application/json': components['schemas']['payment_method'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * billing_details_inner_params * @description Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods. */ billing_details?: { address?: Partial<{ - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string }> & - Partial<"">; - email?: Partial & Partial<"">; - name?: string; - phone?: string; - }; + Partial<''> + email?: Partial & Partial<''> + name?: string + phone?: string + } /** * update_api_param * @description If this is a `card` PaymentMethod, this hash contains the user's card details. */ card?: { - exp_month?: number; - exp_year?: number; - }; + exp_month?: number + exp_year?: number + } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /** *

Attaches a PaymentMethod object to a Customer.

* @@ -35420,127 +35171,127 @@ export interface operations { PostPaymentMethodsPaymentMethodAttach: { parameters: { path: { - payment_method: string; - }; - }; + payment_method: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_method"]; - }; - }; + 'application/json': components['schemas']['payment_method'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The ID of the customer to which to attach the PaymentMethod. */ - customer: string; + customer: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Detaches a PaymentMethod object from a Customer.

*/ PostPaymentMethodsPaymentMethodDetach: { parameters: { path: { - payment_method: string; - }; - }; + payment_method: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payment_method"]; - }; - }; + 'application/json': components['schemas']['payment_method'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Returns a list of existing payouts sent to third-party bank accounts or that Stripe has sent you. The payouts are returned in sorted order, with the most recently created payouts appearing first.

*/ GetPayouts: { parameters: { query: { arrival_date?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** The ID of an external account - only return payouts sent to this external account. */ - destination?: string; + destination?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return payouts that have the given status: `pending`, `paid`, `failed`, or `canceled`. */ - status?: string; - }; - }; + status?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["payout"][]; + 'application/json': { + data: components['schemas']['payout'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

To send funds to your own bank account, you create a new payout object. Your Stripe balance must be able to cover the payout amount, or you’ll receive an “Insufficient Funds” error.

* @@ -35553,140 +35304,140 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payout"]; - }; - }; + 'application/json': components['schemas']['payout'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A positive integer in cents representing how much to payout. */ - amount: number; + amount: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description The ID of a bank account or a card to send the payout to. If no destination is supplied, the default external account for the specified currency will be used. */ - destination?: string; + destination?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * @description The method used to send this payout, which can be `standard` or `instant`. `instant` is only supported for payouts to debit cards. (See [Instant payouts for marketplaces for more information](https://stripe.com/blog/instant-payouts-for-marketplaces).) * @enum {string} */ - method?: "instant" | "standard"; + method?: 'instant' | 'standard' /** * @description The balance type of your Stripe balance to draw this payout from. Balances for different payment sources are kept separately. You can find the amounts with the balances API. One of `bank_account`, `card`, or `fpx`. * @enum {string} */ - source_type?: "bank_account" | "card" | "fpx"; + source_type?: 'bank_account' | 'card' | 'fpx' /** @description A string to be displayed on the recipient's bank or card statement. This may be at most 22 characters. Attempting to use a `statement_descriptor` longer than 22 characters will return an error. Note: Most banks will truncate this information and/or display it inconsistently. Some may not display it at all. */ - statement_descriptor?: string; - }; - }; - }; - }; + statement_descriptor?: string + } + } + } + } /**

Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list, and Stripe will return the corresponding payout information.

*/ GetPayoutsPayout: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - payout: string; - }; - }; + payout: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payout"]; - }; - }; + 'application/json': components['schemas']['payout'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates the specified payout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request accepts only the metadata as arguments.

*/ PostPayoutsPayout: { parameters: { path: { - payout: string; - }; - }; + payout: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payout"]; - }; - }; + 'application/json': components['schemas']['payout'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

A previously created payout can be canceled if it has not yet been paid out. Funds will be refunded to your available balance. You may not cancel automatic Stripe payouts.

*/ PostPayoutsPayoutCancel: { parameters: { path: { - payout: string; - }; - }; + payout: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payout"]; - }; - }; + 'application/json': components['schemas']['payout'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /** *

Reverses a payout by debiting the destination bank account. Only payouts for connected accounts to US bank accounts may be reversed at this time. If the payout is in the pending status, /v1/payouts/:id/cancel should be used instead.

* @@ -35695,1556 +35446,1556 @@ export interface operations { PostPayoutsPayoutReverse: { parameters: { path: { - payout: string; - }; - }; + payout: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["payout"]; - }; - }; + 'application/json': components['schemas']['payout'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; - }; - }; - }; - }; + metadata?: { [key: string]: string } + } + } + } + } /**

Returns a list of your plans.

*/ GetPlans: { parameters: { query: { /** Only return plans that are active or inactive (e.g., pass `false` to list all inactive plans). */ - active?: boolean; + active?: boolean /** 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?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return plans for the given product. */ - product?: string; + product?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["plan"][]; + data: components['schemas']['plan'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.

*/ PostPlans: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["plan"]; - }; - }; + 'application/json': components['schemas']['plan'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether the plan is currently available for new subscriptions. Defaults to `true`. */ - active?: boolean; + active?: boolean /** * @description 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`. * @enum {string} */ - aggregate_usage?: "last_during_period" | "last_ever" | "max" | "sum"; + aggregate_usage?: 'last_during_period' | 'last_ever' | 'max' | 'sum' /** @description A positive integer in %s (or 0 for a free plan) representing how much to charge on a recurring basis. */ - amount?: number; + amount?: number /** * Format: decimal * @description Same as `amount`, but accepts a decimal value with at most 12 decimal places. Only one of `amount` and `amount_decimal` can be set. */ - amount_decimal?: string; + amount_decimal?: string /** * @description 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. * @enum {string} */ - billing_scheme?: "per_unit" | "tiered"; + billing_scheme?: 'per_unit' | 'tiered' /** @description 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: string; + currency: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description An identifier randomly generated by Stripe. Used to identify this plan when subscribing a customer. You can optionally override this ID, but the ID must be unique across all plans in your Stripe account. You can, however, use the same plan ID in both live and test modes. */ - id?: string; + id?: string /** * @description Specifies billing frequency. Either `day`, `week`, `month` or `year`. * @enum {string} */ - interval: "day" | "month" | "week" | "year"; + interval: 'day' | 'month' | 'week' | 'year' /** @description The number of intervals between subscription billings. 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?: number; + interval_count?: number /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description A brief description of the plan, hidden from customers. */ - nickname?: string; + nickname?: string product?: Partial<{ - active?: boolean; - id?: string; - metadata?: { [key: string]: string }; - name: string; - statement_descriptor?: string; - tax_code?: string; - unit_label?: string; + active?: boolean + id?: string + metadata?: { [key: string]: string } + name: string + statement_descriptor?: string + tax_code?: string + unit_label?: string }> & - Partial; + Partial /** @description Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. */ tiers?: { - flat_amount?: number; + flat_amount?: number /** Format: decimal */ - flat_amount_decimal?: string; - unit_amount?: number; + flat_amount_decimal?: string + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - up_to: Partial<"inf"> & Partial; - }[]; + unit_amount_decimal?: string + up_to: Partial<'inf'> & Partial + }[] /** * @description 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 successively change as the quantity grows. * @enum {string} */ - tiers_mode?: "graduated" | "volume"; + tiers_mode?: 'graduated' | 'volume' /** * transform_usage_param * @description Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`. */ transform_usage?: { - divide_by: number; + divide_by: number /** @enum {string} */ - round: "down" | "up"; - }; + round: 'down' | 'up' + } /** @description 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?: number; + trial_period_days?: number /** * @description 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`. * @enum {string} */ - usage_type?: "licensed" | "metered"; - }; - }; - }; - }; + usage_type?: 'licensed' | 'metered' + } + } + } + } /**

Retrieves the plan with the given ID.

*/ GetPlansPlan: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - plan: string; - }; - }; + plan: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["plan"]; - }; - }; + 'application/json': components['schemas']['plan'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostPlansPlan: { parameters: { path: { - plan: string; - }; - }; + plan: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["plan"]; - }; - }; + 'application/json': components['schemas']['plan'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether the plan is currently available for new subscriptions. */ - active?: boolean; + active?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description A brief description of the plan, hidden from customers. */ - nickname?: string; + nickname?: string /** @description The product the plan belongs to. This cannot be changed once it has been used in a subscription or subscription schedule. */ - product?: string; + product?: string /** @description 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?: number; - }; - }; - }; - }; + trial_period_days?: number + } + } + } + } /**

Deleting plans means new subscribers can’t be added. Existing subscribers aren’t affected.

*/ DeletePlansPlan: { parameters: { path: { - plan: string; - }; - }; + plan: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_plan"]; - }; - }; + 'application/json': components['schemas']['deleted_plan'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of your prices.

*/ GetPrices: { parameters: { query: { /** Only return prices that are active or inactive (e.g., pass `false` to list all inactive prices). */ - active?: boolean; + active?: boolean /** 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?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** Only return prices for the given currency. */ - currency?: string; + currency?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return the price with these lookup_keys, if any exist. */ - lookup_keys?: string[]; + lookup_keys?: string[] /** Only return prices for the given product. */ - product?: string; + product?: string /** Only return prices with these recurring fields. */ recurring?: { /** @enum {string} */ - interval?: "day" | "month" | "week" | "year"; + interval?: 'day' | 'month' | 'week' | 'year' /** @enum {string} */ - usage_type?: "licensed" | "metered"; - }; + usage_type?: 'licensed' | 'metered' + } /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return prices of type `recurring` or `one_time`. */ - type?: "one_time" | "recurring"; - }; - }; + type?: 'one_time' | 'recurring' + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["price"][]; + data: components['schemas']['price'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new price for an existing product. The price can be recurring or one-time.

*/ PostPrices: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["price"]; - }; - }; + 'application/json': components['schemas']['price'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether the price can be used for new purchases. Defaults to `true`. */ - active?: boolean; + active?: boolean /** * @description 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. * @enum {string} */ - billing_scheme?: "per_unit" | "tiered"; + billing_scheme?: 'per_unit' | 'tiered' /** @description 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: string; + currency: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters. */ - lookup_key?: string; + lookup_key?: string /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description A brief description of the price, hidden from customers. */ - nickname?: string; + nickname?: string /** @description The ID of the product that this price will belong to. */ - product?: string; + product?: string /** * inline_product_params * @description These fields can be used to create a new product that this price will belong to. */ product_data?: { - active?: boolean; - id?: string; - metadata?: { [key: string]: string }; - name: string; - statement_descriptor?: string; - tax_code?: string; - unit_label?: string; - }; + active?: boolean + id?: string + metadata?: { [key: string]: string } + name: string + statement_descriptor?: string + tax_code?: string + unit_label?: string + } /** * recurring * @description The recurring components of a price such as `interval` and `usage_type`. */ recurring?: { /** @enum {string} */ - aggregate_usage?: "last_during_period" | "last_ever" | "max" | "sum"; + aggregate_usage?: 'last_during_period' | 'last_ever' | 'max' | 'sum' /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number /** @enum {string} */ - usage_type?: "licensed" | "metered"; - }; + usage_type?: 'licensed' | 'metered' + } /** * @description 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. * @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' /** @description Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. */ tiers?: { - flat_amount?: number; + flat_amount?: number /** Format: decimal */ - flat_amount_decimal?: string; - unit_amount?: number; + flat_amount_decimal?: string + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - up_to: Partial<"inf"> & Partial; - }[]; + unit_amount_decimal?: string + up_to: Partial<'inf'> & Partial + }[] /** * @description 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 successively change as the quantity grows. * @enum {string} */ - tiers_mode?: "graduated" | "volume"; + tiers_mode?: 'graduated' | 'volume' /** @description If set to true, will atomically remove the lookup key from the existing price, and assign it to this price. */ - transfer_lookup_key?: boolean; + transfer_lookup_key?: boolean /** * transform_usage_param * @description Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`. */ transform_quantity?: { - divide_by: number; + divide_by: number /** @enum {string} */ - round: "down" | "up"; - }; + round: 'down' | 'up' + } /** @description A positive integer in %s (or 0 for a free price) representing how much to charge. */ - unit_amount?: number; + unit_amount?: number /** * Format: decimal * @description Same as `unit_amount`, but accepts a decimal value in %s with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. */ - unit_amount_decimal?: string; - }; - }; - }; - }; + unit_amount_decimal?: string + } + } + } + } /**

Retrieves the price with the given ID.

*/ GetPricesPrice: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - price: string; - }; - }; + price: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["price"]; - }; - }; + 'application/json': components['schemas']['price'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged.

*/ PostPricesPrice: { parameters: { path: { - price: string; - }; - }; + price: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["price"]; - }; - }; + 'application/json': components['schemas']['price'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether the price can be used for new purchases. Defaults to `true`. */ - active?: boolean; + active?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters. */ - lookup_key?: string; + lookup_key?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description A brief description of the price, hidden from customers. */ - nickname?: string; + nickname?: string /** * @description 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. * @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' /** @description If set to true, will atomically remove the lookup key from the existing price, and assign it to this price. */ - transfer_lookup_key?: boolean; - }; - }; - }; - }; + transfer_lookup_key?: boolean + } + } + } + } /**

Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.

*/ GetProducts: { parameters: { query: { /** Only return products that are active or inactive (e.g., pass `false` to list all inactive products). */ - active?: boolean; + active?: boolean /** Only return products that were created during the given date interval. */ created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** Only return products with the given IDs. */ - ids?: string[]; + ids?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return products that can be shipped (i.e., physical, not digital products). */ - shippable?: boolean; + shippable?: boolean /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return products with the given url. */ - url?: string; - }; - }; + url?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["product"][]; + data: components['schemas']['product'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new product object.

*/ PostProducts: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["product"]; - }; - }; + 'application/json': components['schemas']['product'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether the product is currently available for purchase. Defaults to `true`. */ - active?: boolean; + active?: boolean /** @description 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?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description An identifier will be randomly generated by Stripe. You can optionally override this ID, but the ID must be unique across all products in your Stripe account. */ - id?: string; + id?: string /** @description A list of up to 8 URLs of images for this product, meant to be displayable to the customer. */ - images?: string[]; + images?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The product's name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions. */ - name: string; + name: string /** * package_dimensions_specs * @description The dimensions of this product for shipping purposes. */ package_dimensions?: { - height: number; - length: number; - weight: number; - width: number; - }; + height: number + length: number + weight: number + width: number + } /** @description Whether this product is shipped (i.e., physical goods). */ - shippable?: boolean; + shippable?: boolean /** * @description An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all. * * This may be up to 22 characters. The statement description may not include `<`, `>`, `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. * It must contain at least one letter. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description A [tax code](https://stripe.com/docs/tax/tax-codes) ID. */ - tax_code?: string; + tax_code?: string /** @description A label that represents units of this product in Stripe and on customers’ receipts and invoices. When set, this will be included in associated invoice line item descriptions. */ - unit_label?: string; + unit_label?: string /** @description A URL of a publicly-accessible webpage for this product. */ - url?: string; - }; - }; - }; - }; + url?: string + } + } + } + } /**

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.

*/ GetProductsId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["product"]; - }; - }; + 'application/json': components['schemas']['product'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ PostProductsId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["product"]; - }; - }; + 'application/json': components['schemas']['product'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether the product is available for purchase. */ - active?: boolean; + active?: boolean /** @description 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?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A list of up to 8 URLs of images for this product, meant to be displayable to the customer. */ - images?: Partial & Partial<"">; + images?: Partial & Partial<''> /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The product's name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions. */ - name?: string; + name?: string /** @description The dimensions of this product for shipping purposes. */ package_dimensions?: Partial<{ - height: number; - length: number; - weight: number; - width: number; + height: number + length: number + weight: number + width: number }> & - Partial<"">; + Partial<''> /** @description Whether this product is shipped (i.e., physical goods). */ - shippable?: boolean; + shippable?: boolean /** * @description An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all. * * This may be up to 22 characters. The statement description may not include `<`, `>`, `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. * It must contain at least one letter. May only be set if `type=service`. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description A [tax code](https://stripe.com/docs/tax/tax-codes) ID. */ - tax_code?: Partial & Partial<"">; + tax_code?: Partial & Partial<''> /** @description A label that represents units of this product in Stripe and on customers’ receipts and invoices. When set, this will be included in associated invoice line item descriptions. May only be set if `type=service`. */ - unit_label?: string; + unit_label?: string /** @description A URL of a publicly-accessible webpage for this product. */ - url?: string; - }; - }; - }; - }; + url?: string + } + } + } + } /**

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.

*/ DeleteProductsId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_product"]; - }; - }; + 'application/json': components['schemas']['deleted_product'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of your promotion codes.

*/ GetPromotionCodes: { parameters: { query: { /** Filter promotion codes by whether they are active. */ - active?: boolean; + active?: boolean /** Only return promotion codes that have this case-insensitive code. */ - code?: string; + code?: string /** Only return promotion codes for this coupon. */ - coupon?: string; + coupon?: string /** 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?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** Only return promotion codes that are restricted to this customer. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["promotion_code"][]; + 'application/json': { + data: components['schemas']['promotion_code'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

A promotion code points to a coupon. You can optionally restrict the code to a specific customer, redemption limit, and expiration date.

*/ PostPromotionCodes: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["promotion_code"]; - }; - }; + 'application/json': components['schemas']['promotion_code'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether the promotion code is currently active. */ - active?: boolean; + active?: boolean /** @description The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for a specific customer. If left blank, we will generate one automatically. */ - code?: string; + code?: string /** @description The coupon for this promotion code. */ - coupon: string; + coupon: string /** @description The customer that this promotion code can be used by. If not set, the promotion code can be used by all customers. */ - customer?: string; + customer?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * Format: unix-time * @description The timestamp at which this promotion code will expire. If the coupon has specified a `redeems_by`, then this value cannot be after the coupon's `redeems_by`. */ - expires_at?: number; + expires_at?: number /** @description A positive integer specifying the number of times the promotion code can be redeemed. If the coupon has specified a `max_redemptions`, then this value cannot be greater than the coupon's `max_redemptions`. */ - max_redemptions?: number; + max_redemptions?: number /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * restrictions_params * @description Settings that restrict the redemption of the promotion code. */ restrictions?: { - first_time_transaction?: boolean; - minimum_amount?: number; - minimum_amount_currency?: string; - }; - }; - }; - }; - }; + first_time_transaction?: boolean + minimum_amount?: number + minimum_amount_currency?: string + } + } + } + } + } /**

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.

*/ GetPromotionCodesPromotionCode: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - promotion_code: string; - }; - }; + promotion_code: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["promotion_code"]; - }; - }; + 'application/json': components['schemas']['promotion_code'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates the specified promotion code by setting the values of the parameters passed. Most fields are, by design, not editable.

*/ PostPromotionCodesPromotionCode: { parameters: { path: { - promotion_code: string; - }; - }; + promotion_code: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["promotion_code"]; - }; - }; + 'application/json': components['schemas']['promotion_code'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether the promotion code is currently active. A promotion code can only be reactivated when the coupon is still valid and the promotion code is otherwise redeemable. */ - active?: boolean; + active?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Returns a list of your quotes.

*/ GetQuotes: { parameters: { query: { /** The ID of the customer whose quotes will be retrieved. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** The status of the quote. */ - status?: "accepted" | "canceled" | "draft" | "open"; - }; - }; + status?: 'accepted' | 'canceled' | 'draft' | 'open' + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["quote"][]; + 'application/json': { + data: components['schemas']['quote'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostQuotes: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["quote"]; - }; - }; + 'application/json': components['schemas']['quote'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description 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. There cannot be any line items with recurring prices when using this field. */ - application_fee_amount?: Partial & Partial<"">; + application_fee_amount?: Partial & Partial<''> /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field. */ - application_fee_percent?: Partial & Partial<"">; + application_fee_percent?: Partial & Partial<''> /** * automatic_tax_param * @description Settings for automatic tax lookup for this quote and resulting invoices and subscriptions. */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** * @description Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice 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. Defaults to `charge_automatically`. * @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' /** @description The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed. */ - customer?: string; + customer?: string /** @description The tax rates that will apply to any line item that does not have `tax_rates` set. */ - default_tax_rates?: Partial & Partial<"">; + default_tax_rates?: Partial & Partial<''> /** @description A description that will be displayed on the quote PDF. If no value is passed, the default description configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used. */ - description?: string; + description?: string /** @description The discounts applied to the quote. You can only set up to one discount. */ discounts?: Partial< { - coupon?: string; - discount?: string; + coupon?: string + discount?: string }[] > & - Partial<"">; + Partial<''> /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * Format: unix-time * @description A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. If no value is passed, the default expiration date configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used. */ - expires_at?: number; + expires_at?: number /** @description A footer that will be displayed on the quote PDF. If no value is passed, the default footer configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used. */ - footer?: string; + footer?: string /** * from_quote_params * @description Clone an existing quote. The new quote will be created in `status=draft`. When using this parameter, you cannot specify any other parameters except for `expires_at`. */ from_quote?: { - is_revision?: boolean; - quote: string; - }; + is_revision?: boolean + quote: string + } /** @description A header that will be displayed on the quote PDF. If no value is passed, the default header configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used. */ - header?: string; + header?: string /** * quote_param * @description All invoices will be billed using the specified settings. */ invoice_settings?: { - days_until_due?: number; - }; + days_until_due?: number + } /** @description A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost. */ line_items?: { - price?: string; + price?: string /** price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring?: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The account on behalf of which to charge. */ - on_behalf_of?: Partial & Partial<"">; + on_behalf_of?: Partial & Partial<''> /** * subscription_data_create_params * @description When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if `subscription_data[effective_date]` is present and in the future, otherwise a subscription is created. */ subscription_data?: { - effective_date?: Partial<"current_period_end"> & Partial & Partial<"">; - trial_period_days?: Partial & Partial<"">; - }; + effective_date?: Partial<'current_period_end'> & Partial & Partial<''> + trial_period_days?: Partial & Partial<''> + } /** @description The data with which to automatically create a Transfer for each of the invoices. */ transfer_data?: Partial<{ - amount?: number; - amount_percent?: number; - destination: string; + amount?: number + amount_percent?: number + destination: string }> & - Partial<"">; - }; - }; - }; - }; + Partial<''> + } + } + } + } /**

Retrieves the quote with the given ID.

*/ GetQuotesQuote: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - quote: string; - }; - }; + quote: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["quote"]; - }; - }; + 'application/json': components['schemas']['quote'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

A quote models prices and services for a customer.

*/ PostQuotesQuote: { parameters: { path: { - quote: string; - }; - }; + quote: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["quote"]; - }; - }; + 'application/json': components['schemas']['quote'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description 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. There cannot be any line items with recurring prices when using this field. */ - application_fee_amount?: Partial & Partial<"">; + application_fee_amount?: Partial & Partial<''> /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field. */ - application_fee_percent?: Partial & Partial<"">; + application_fee_percent?: Partial & Partial<''> /** * automatic_tax_param * @description Settings for automatic tax lookup for this quote and resulting invoices and subscriptions. */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** * @description Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice 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. Defaults to `charge_automatically`. * @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' /** @description The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed. */ - customer?: string; + customer?: string /** @description The tax rates that will apply to any line item that does not have `tax_rates` set. */ - default_tax_rates?: Partial & Partial<"">; + default_tax_rates?: Partial & Partial<''> /** @description A description that will be displayed on the quote PDF. */ - description?: string; + description?: string /** @description The discounts applied to the quote. You can only set up to one discount. */ discounts?: Partial< { - coupon?: string; - discount?: string; + coupon?: string + discount?: string }[] > & - Partial<"">; + Partial<''> /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * Format: unix-time * @description A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. */ - expires_at?: number; + expires_at?: number /** @description A footer that will be displayed on the quote PDF. */ - footer?: string; + footer?: string /** @description A header that will be displayed on the quote PDF. */ - header?: string; + header?: string /** * quote_param * @description All invoices will be billed using the specified settings. */ invoice_settings?: { - days_until_due?: number; - }; + days_until_due?: number + } /** @description A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost. */ line_items?: { - id?: string; - price?: string; + id?: string + price?: string /** price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring?: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The account on behalf of which to charge. */ - on_behalf_of?: Partial & Partial<"">; + on_behalf_of?: Partial & Partial<''> /** * subscription_data_update_params * @description When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if `subscription_data[effective_date]` is present and in the future, otherwise a subscription is created. */ subscription_data?: { - effective_date?: Partial<"current_period_end"> & Partial & Partial<"">; - trial_period_days?: Partial & Partial<"">; - }; + effective_date?: Partial<'current_period_end'> & Partial & Partial<''> + trial_period_days?: Partial & Partial<''> + } /** @description The data with which to automatically create a Transfer for each of the invoices. */ transfer_data?: Partial<{ - amount?: number; - amount_percent?: number; - destination: string; + amount?: number + amount_percent?: number + destination: string }> & - Partial<"">; - }; - }; - }; - }; + Partial<''> + } + } + } + } /**

Accepts the specified quote.

*/ PostQuotesQuoteAccept: { parameters: { path: { - quote: string; - }; - }; + quote: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["quote"]; - }; - }; + 'application/json': components['schemas']['quote'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Cancels the quote.

*/ PostQuotesQuoteCancel: { parameters: { path: { - quote: string; - }; - }; + quote: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["quote"]; - }; - }; + 'application/json': components['schemas']['quote'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

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.

*/ GetQuotesQuoteComputedUpfrontLineItems: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - quote: string; - }; - }; + quote: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["item"][]; + data: components['schemas']['item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Finalizes the quote.

*/ PostQuotesQuoteFinalize: { parameters: { path: { - quote: string; - }; - }; + quote: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["quote"]; - }; - }; + 'application/json': components['schemas']['quote'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * Format: unix-time * @description A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. */ - expires_at?: number; - }; - }; - }; - }; + expires_at?: number + } + } + } + } /**

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.

*/ GetQuotesQuoteLineItems: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - quote: string; - }; - }; + quote: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["item"][]; + data: components['schemas']['item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Download the PDF for a finalized quote

*/ GetQuotesQuotePdf: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - quote: string; - }; - }; + quote: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/pdf": string; - }; - }; + 'application/pdf': string + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of early fraud warnings.

*/ GetRadarEarlyFraudWarnings: { parameters: { query: { /** Only return early fraud warnings for the charge specified by this charge ID. */ - charge?: string; + charge?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return early fraud warnings for charges that were created by the PaymentIntent specified by this PaymentIntent ID. */ - payment_intent?: string; + payment_intent?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["radar.early_fraud_warning"][]; + 'application/json': { + data: components['schemas']['radar.early_fraud_warning'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Retrieves the details of an early fraud warning that has previously been created.

* @@ -37253,425 +37004,417 @@ export interface operations { GetRadarEarlyFraudWarningsEarlyFraudWarning: { parameters: { path: { - early_fraud_warning: string; - }; + early_fraud_warning: string + } query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["radar.early_fraud_warning"]; - }; - }; + 'application/json': components['schemas']['radar.early_fraud_warning'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of ValueListItem objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

*/ GetRadarValueListItems: { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Return items belonging to the parent list whose value matches the specified value (using an "is like" match). */ - value?: string; + value?: string /** Identifier for the parent value list this item belongs to. */ - value_list: string; - }; - }; + value_list: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["radar.value_list_item"][]; + 'application/json': { + data: components['schemas']['radar.value_list_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new ValueListItem object, which is added to the specified parent value list.

*/ PostRadarValueListItems: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["radar.value_list_item"]; - }; - }; + 'application/json': components['schemas']['radar.value_list_item'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The value of the item (whose type must match the type of the parent value list). */ - value: string; + value: string /** @description The identifier of the value list which the created item will be added to. */ - value_list: string; - }; - }; - }; - }; + value_list: string + } + } + } + } /**

Retrieves a ValueListItem object.

*/ GetRadarValueListItemsItem: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - item: string; - }; - }; + item: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["radar.value_list_item"]; - }; - }; + 'application/json': components['schemas']['radar.value_list_item'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Deletes a ValueListItem object, removing it from its parent value list.

*/ DeleteRadarValueListItemsItem: { parameters: { path: { - item: string; - }; - }; + item: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_radar.value_list_item"]; - }; - }; + 'application/json': components['schemas']['deleted_radar.value_list_item'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of ValueList objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

*/ GetRadarValueLists: { parameters: { query: { /** The alias used to reference the value list when writing rules. */ - alias?: string; + alias?: string /** A value contained within a value list - returns all value lists containing this value. */ - contains?: string; + contains?: string created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["radar.value_list"][]; + 'application/json': { + data: components['schemas']['radar.value_list'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new ValueList object, which can then be referenced in rules.

*/ PostRadarValueLists: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["radar.value_list"]; - }; - }; + 'application/json': components['schemas']['radar.value_list'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The name of the value list for use in rules. */ - alias: string; + alias: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * @description Type of the items in the value list. One of `card_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, `case_sensitive_string`, or `customer_id`. Use `string` if the item type is unknown or mixed. * @enum {string} */ - item_type?: - | "card_bin" - | "card_fingerprint" - | "case_sensitive_string" - | "country" - | "customer_id" - | "email" - | "ip_address" - | "string"; + item_type?: 'card_bin' | 'card_fingerprint' | 'case_sensitive_string' | 'country' | 'customer_id' | 'email' | 'ip_address' | 'string' /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The human-readable name of the value list. */ - name: string; - }; - }; - }; - }; + name: string + } + } + } + } /**

Retrieves a ValueList object.

*/ GetRadarValueListsValueList: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - value_list: string; - }; - }; + value_list: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["radar.value_list"]; - }; - }; + 'application/json': components['schemas']['radar.value_list'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostRadarValueListsValueList: { parameters: { path: { - value_list: string; - }; - }; + value_list: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["radar.value_list"]; - }; - }; + 'application/json': components['schemas']['radar.value_list'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The name of the value list for use in rules. */ - alias?: string; + alias?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The human-readable name of the value list. */ - name?: string; - }; - }; - }; - }; + name?: string + } + } + } + } /**

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.

*/ DeleteRadarValueListsValueList: { parameters: { path: { - value_list: string; - }; - }; + value_list: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_radar.value_list"]; - }; - }; + 'application/json': components['schemas']['deleted_radar.value_list'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of your recipients. The recipients are returned sorted by creation date, with the most recently created recipients appearing first.

*/ GetRecipients: { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - type?: "corporation" | "individual"; + starting_after?: string + type?: 'corporation' | 'individual' /** Only return recipients that are verified or unverified. */ - verified?: boolean; - }; - }; + verified?: boolean + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["recipient"][]; + 'application/json': { + data: components['schemas']['recipient'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Creates a new Recipient object and verifies the recipient’s identity. * Also verifies the recipient’s bank account information or debit card, if either is provided.

@@ -37681,73 +37424,72 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["recipient"]; - }; - }; + 'application/json': components['schemas']['recipient'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A bank account to attach to the recipient. You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details, with the options described below. */ - bank_account?: string; + bank_account?: string /** @description A U.S. Visa or MasterCard debit card (_not_ prepaid) to attach to the recipient. If the debit card is not valid, recipient creation will fail. You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's debit card details, with the options described below. Although not all information is required, the extra info helps prevent fraud. */ - card?: string; + card?: string /** @description An arbitrary string which you can attach to a `Recipient` object. It is displayed alongside the recipient in the web interface. */ - description?: string; + description?: string /** @description The recipient's email address. It is displayed alongside the recipient in the web interface, and can be useful for searching and tracking. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The recipient's full, legal name. For type `individual`, should be in the format `First Last`, `First Middle Last`, or `First M Last` (no prefixes or suffixes). For `corporation`, the full, incorporated name. */ - name: string; + name: string /** @description The recipient's tax ID, as a string. For type `individual`, the full SSN; for type `corporation`, the full EIN. */ - tax_id?: string; + tax_id?: string /** @description Type of the recipient: either `individual` or `corporation`. */ - type: string; - }; - }; - }; - }; + type: string + } + } + } + } /**

Retrieves the details of an existing recipient. You need only supply the unique recipient identifier that was returned upon recipient creation.

*/ GetRecipientsId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": Partial & - Partial; - }; - }; + 'application/json': Partial & Partial + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates the specified recipient by setting the values of the parameters passed. * Any parameters not provided will be left unchanged.

@@ -37758,196 +37500,196 @@ export interface operations { PostRecipientsId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["recipient"]; - }; - }; + 'application/json': components['schemas']['recipient'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A bank account to attach to the recipient. You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details, with the options described below. */ - bank_account?: string; + bank_account?: string /** @description A U.S. Visa or MasterCard debit card (not prepaid) to attach to the recipient. You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's debit card details, with the options described below. Passing `card` will create a new card, make it the new recipient default card, and delete the old recipient default (if one exists). If you want to add additional debit cards instead of replacing the existing default, use the [card creation API](https://stripe.com/docs/api#create_card). Whenever you attach a card to a recipient, Stripe will automatically validate the debit card. */ - card?: string; + card?: string /** @description ID of the card to set as the recipient's new default for payouts. */ - default_card?: string; + default_card?: string /** @description An arbitrary string which you can attach to a `Recipient` object. It is displayed alongside the recipient in the web interface. */ - description?: string; + description?: string /** @description The recipient's email address. It is displayed alongside the recipient in the web interface, and can be useful for searching and tracking. */ - email?: string; + email?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The recipient's full, legal name. For type `individual`, should be in the format `First Last`, `First Middle Last`, or `First M Last` (no prefixes or suffixes). For `corporation`, the full, incorporated name. */ - name?: string; + name?: string /** @description The recipient's tax ID, as a string. For type `individual`, the full SSN; for type `corporation`, the full EIN. */ - tax_id?: string; - }; - }; - }; - }; + tax_id?: string + } + } + } + } /**

Permanently deletes a recipient. It cannot be undone.

*/ DeleteRecipientsId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_recipient"]; - }; - }; + 'application/json': components['schemas']['deleted_recipient'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of all refunds you’ve previously created. The refunds are returned in sorted order, with the most recent refunds appearing first. For convenience, the 10 most recent refunds are always available by default on the charge object.

*/ GetRefunds: { parameters: { query: { /** Only return refunds for the charge specified by this charge ID. */ - charge?: string; + charge?: string created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return refunds for the PaymentIntent specified by this ID. */ - payment_intent?: string; + payment_intent?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["refund"][]; + 'application/json': { + data: components['schemas']['refund'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Create a refund.

*/ PostRefunds: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["refund"]; - }; - }; + 'application/json': components['schemas']['refund'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { - amount?: number; - charge?: string; + 'application/x-www-form-urlencoded': { + amount?: number + charge?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - payment_intent?: string; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + payment_intent?: string /** @enum {string} */ - reason?: "duplicate" | "fraudulent" | "requested_by_customer"; - refund_application_fee?: boolean; - reverse_transfer?: boolean; - }; - }; - }; - }; + reason?: 'duplicate' | 'fraudulent' | 'requested_by_customer' + refund_application_fee?: boolean + reverse_transfer?: boolean + } + } + } + } /**

Retrieves the details of an existing refund.

*/ GetRefundsRefund: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - refund: string; - }; - }; + refund: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["refund"]; - }; - }; + 'application/json': components['schemas']['refund'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates the specified refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

* @@ -37956,973 +37698,973 @@ export interface operations { PostRefundsRefund: { parameters: { path: { - refund: string; - }; - }; + refund: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["refund"]; - }; - }; + 'application/json': components['schemas']['refund'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Returns a list of Report Runs, with the most recent appearing first.

*/ GetReportingReportRuns: { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["reporting.report_run"][]; + 'application/json': { + data: components['schemas']['reporting.report_run'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new object and begin running the report. (Certain report types require a live-mode API key.)

*/ PostReportingReportRuns: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["reporting.report_run"]; - }; - }; + 'application/json': components['schemas']['reporting.report_run'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * run_parameter_specs * @description Parameters specifying how the report should be run. Different Report Types have different required and optional parameters, listed in the [API Access to Reports](https://stripe.com/docs/reporting/statements/api) documentation. */ parameters?: { - columns?: string[]; - connected_account?: string; - currency?: string; + columns?: string[] + connected_account?: string + currency?: string /** Format: unix-time */ - interval_end?: number; + interval_end?: number /** Format: unix-time */ - interval_start?: number; - payout?: string; + interval_start?: number + payout?: string /** @enum {string} */ reporting_category?: - | "advance" - | "advance_funding" - | "anticipation_repayment" - | "charge" - | "charge_failure" - | "connect_collection_transfer" - | "connect_reserved_funds" - | "contribution" - | "dispute" - | "dispute_reversal" - | "fee" - | "financing_paydown" - | "financing_paydown_reversal" - | "financing_payout" - | "financing_payout_reversal" - | "issuing_authorization_hold" - | "issuing_authorization_release" - | "issuing_dispute" - | "issuing_transaction" - | "network_cost" - | "other_adjustment" - | "partial_capture_reversal" - | "payout" - | "payout_reversal" - | "platform_earning" - | "platform_earning_refund" - | "refund" - | "refund_failure" - | "risk_reserved_funds" - | "tax" - | "topup" - | "topup_reversal" - | "transfer" - | "transfer_reversal"; + | 'advance' + | 'advance_funding' + | 'anticipation_repayment' + | 'charge' + | 'charge_failure' + | 'connect_collection_transfer' + | 'connect_reserved_funds' + | 'contribution' + | 'dispute' + | 'dispute_reversal' + | 'fee' + | 'financing_paydown' + | 'financing_paydown_reversal' + | 'financing_payout' + | 'financing_payout_reversal' + | 'issuing_authorization_hold' + | 'issuing_authorization_release' + | 'issuing_dispute' + | 'issuing_transaction' + | 'network_cost' + | 'other_adjustment' + | 'partial_capture_reversal' + | 'payout' + | 'payout_reversal' + | 'platform_earning' + | 'platform_earning_refund' + | 'refund' + | 'refund_failure' + | 'risk_reserved_funds' + | 'tax' + | 'topup' + | 'topup_reversal' + | 'transfer' + | 'transfer_reversal' /** @enum {string} */ timezone?: - | "Africa/Abidjan" - | "Africa/Accra" - | "Africa/Addis_Ababa" - | "Africa/Algiers" - | "Africa/Asmara" - | "Africa/Asmera" - | "Africa/Bamako" - | "Africa/Bangui" - | "Africa/Banjul" - | "Africa/Bissau" - | "Africa/Blantyre" - | "Africa/Brazzaville" - | "Africa/Bujumbura" - | "Africa/Cairo" - | "Africa/Casablanca" - | "Africa/Ceuta" - | "Africa/Conakry" - | "Africa/Dakar" - | "Africa/Dar_es_Salaam" - | "Africa/Djibouti" - | "Africa/Douala" - | "Africa/El_Aaiun" - | "Africa/Freetown" - | "Africa/Gaborone" - | "Africa/Harare" - | "Africa/Johannesburg" - | "Africa/Juba" - | "Africa/Kampala" - | "Africa/Khartoum" - | "Africa/Kigali" - | "Africa/Kinshasa" - | "Africa/Lagos" - | "Africa/Libreville" - | "Africa/Lome" - | "Africa/Luanda" - | "Africa/Lubumbashi" - | "Africa/Lusaka" - | "Africa/Malabo" - | "Africa/Maputo" - | "Africa/Maseru" - | "Africa/Mbabane" - | "Africa/Mogadishu" - | "Africa/Monrovia" - | "Africa/Nairobi" - | "Africa/Ndjamena" - | "Africa/Niamey" - | "Africa/Nouakchott" - | "Africa/Ouagadougou" - | "Africa/Porto-Novo" - | "Africa/Sao_Tome" - | "Africa/Timbuktu" - | "Africa/Tripoli" - | "Africa/Tunis" - | "Africa/Windhoek" - | "America/Adak" - | "America/Anchorage" - | "America/Anguilla" - | "America/Antigua" - | "America/Araguaina" - | "America/Argentina/Buenos_Aires" - | "America/Argentina/Catamarca" - | "America/Argentina/ComodRivadavia" - | "America/Argentina/Cordoba" - | "America/Argentina/Jujuy" - | "America/Argentina/La_Rioja" - | "America/Argentina/Mendoza" - | "America/Argentina/Rio_Gallegos" - | "America/Argentina/Salta" - | "America/Argentina/San_Juan" - | "America/Argentina/San_Luis" - | "America/Argentina/Tucuman" - | "America/Argentina/Ushuaia" - | "America/Aruba" - | "America/Asuncion" - | "America/Atikokan" - | "America/Atka" - | "America/Bahia" - | "America/Bahia_Banderas" - | "America/Barbados" - | "America/Belem" - | "America/Belize" - | "America/Blanc-Sablon" - | "America/Boa_Vista" - | "America/Bogota" - | "America/Boise" - | "America/Buenos_Aires" - | "America/Cambridge_Bay" - | "America/Campo_Grande" - | "America/Cancun" - | "America/Caracas" - | "America/Catamarca" - | "America/Cayenne" - | "America/Cayman" - | "America/Chicago" - | "America/Chihuahua" - | "America/Coral_Harbour" - | "America/Cordoba" - | "America/Costa_Rica" - | "America/Creston" - | "America/Cuiaba" - | "America/Curacao" - | "America/Danmarkshavn" - | "America/Dawson" - | "America/Dawson_Creek" - | "America/Denver" - | "America/Detroit" - | "America/Dominica" - | "America/Edmonton" - | "America/Eirunepe" - | "America/El_Salvador" - | "America/Ensenada" - | "America/Fort_Nelson" - | "America/Fort_Wayne" - | "America/Fortaleza" - | "America/Glace_Bay" - | "America/Godthab" - | "America/Goose_Bay" - | "America/Grand_Turk" - | "America/Grenada" - | "America/Guadeloupe" - | "America/Guatemala" - | "America/Guayaquil" - | "America/Guyana" - | "America/Halifax" - | "America/Havana" - | "America/Hermosillo" - | "America/Indiana/Indianapolis" - | "America/Indiana/Knox" - | "America/Indiana/Marengo" - | "America/Indiana/Petersburg" - | "America/Indiana/Tell_City" - | "America/Indiana/Vevay" - | "America/Indiana/Vincennes" - | "America/Indiana/Winamac" - | "America/Indianapolis" - | "America/Inuvik" - | "America/Iqaluit" - | "America/Jamaica" - | "America/Jujuy" - | "America/Juneau" - | "America/Kentucky/Louisville" - | "America/Kentucky/Monticello" - | "America/Knox_IN" - | "America/Kralendijk" - | "America/La_Paz" - | "America/Lima" - | "America/Los_Angeles" - | "America/Louisville" - | "America/Lower_Princes" - | "America/Maceio" - | "America/Managua" - | "America/Manaus" - | "America/Marigot" - | "America/Martinique" - | "America/Matamoros" - | "America/Mazatlan" - | "America/Mendoza" - | "America/Menominee" - | "America/Merida" - | "America/Metlakatla" - | "America/Mexico_City" - | "America/Miquelon" - | "America/Moncton" - | "America/Monterrey" - | "America/Montevideo" - | "America/Montreal" - | "America/Montserrat" - | "America/Nassau" - | "America/New_York" - | "America/Nipigon" - | "America/Nome" - | "America/Noronha" - | "America/North_Dakota/Beulah" - | "America/North_Dakota/Center" - | "America/North_Dakota/New_Salem" - | "America/Ojinaga" - | "America/Panama" - | "America/Pangnirtung" - | "America/Paramaribo" - | "America/Phoenix" - | "America/Port-au-Prince" - | "America/Port_of_Spain" - | "America/Porto_Acre" - | "America/Porto_Velho" - | "America/Puerto_Rico" - | "America/Punta_Arenas" - | "America/Rainy_River" - | "America/Rankin_Inlet" - | "America/Recife" - | "America/Regina" - | "America/Resolute" - | "America/Rio_Branco" - | "America/Rosario" - | "America/Santa_Isabel" - | "America/Santarem" - | "America/Santiago" - | "America/Santo_Domingo" - | "America/Sao_Paulo" - | "America/Scoresbysund" - | "America/Shiprock" - | "America/Sitka" - | "America/St_Barthelemy" - | "America/St_Johns" - | "America/St_Kitts" - | "America/St_Lucia" - | "America/St_Thomas" - | "America/St_Vincent" - | "America/Swift_Current" - | "America/Tegucigalpa" - | "America/Thule" - | "America/Thunder_Bay" - | "America/Tijuana" - | "America/Toronto" - | "America/Tortola" - | "America/Vancouver" - | "America/Virgin" - | "America/Whitehorse" - | "America/Winnipeg" - | "America/Yakutat" - | "America/Yellowknife" - | "Antarctica/Casey" - | "Antarctica/Davis" - | "Antarctica/DumontDUrville" - | "Antarctica/Macquarie" - | "Antarctica/Mawson" - | "Antarctica/McMurdo" - | "Antarctica/Palmer" - | "Antarctica/Rothera" - | "Antarctica/South_Pole" - | "Antarctica/Syowa" - | "Antarctica/Troll" - | "Antarctica/Vostok" - | "Arctic/Longyearbyen" - | "Asia/Aden" - | "Asia/Almaty" - | "Asia/Amman" - | "Asia/Anadyr" - | "Asia/Aqtau" - | "Asia/Aqtobe" - | "Asia/Ashgabat" - | "Asia/Ashkhabad" - | "Asia/Atyrau" - | "Asia/Baghdad" - | "Asia/Bahrain" - | "Asia/Baku" - | "Asia/Bangkok" - | "Asia/Barnaul" - | "Asia/Beirut" - | "Asia/Bishkek" - | "Asia/Brunei" - | "Asia/Calcutta" - | "Asia/Chita" - | "Asia/Choibalsan" - | "Asia/Chongqing" - | "Asia/Chungking" - | "Asia/Colombo" - | "Asia/Dacca" - | "Asia/Damascus" - | "Asia/Dhaka" - | "Asia/Dili" - | "Asia/Dubai" - | "Asia/Dushanbe" - | "Asia/Famagusta" - | "Asia/Gaza" - | "Asia/Harbin" - | "Asia/Hebron" - | "Asia/Ho_Chi_Minh" - | "Asia/Hong_Kong" - | "Asia/Hovd" - | "Asia/Irkutsk" - | "Asia/Istanbul" - | "Asia/Jakarta" - | "Asia/Jayapura" - | "Asia/Jerusalem" - | "Asia/Kabul" - | "Asia/Kamchatka" - | "Asia/Karachi" - | "Asia/Kashgar" - | "Asia/Kathmandu" - | "Asia/Katmandu" - | "Asia/Khandyga" - | "Asia/Kolkata" - | "Asia/Krasnoyarsk" - | "Asia/Kuala_Lumpur" - | "Asia/Kuching" - | "Asia/Kuwait" - | "Asia/Macao" - | "Asia/Macau" - | "Asia/Magadan" - | "Asia/Makassar" - | "Asia/Manila" - | "Asia/Muscat" - | "Asia/Nicosia" - | "Asia/Novokuznetsk" - | "Asia/Novosibirsk" - | "Asia/Omsk" - | "Asia/Oral" - | "Asia/Phnom_Penh" - | "Asia/Pontianak" - | "Asia/Pyongyang" - | "Asia/Qatar" - | "Asia/Qostanay" - | "Asia/Qyzylorda" - | "Asia/Rangoon" - | "Asia/Riyadh" - | "Asia/Saigon" - | "Asia/Sakhalin" - | "Asia/Samarkand" - | "Asia/Seoul" - | "Asia/Shanghai" - | "Asia/Singapore" - | "Asia/Srednekolymsk" - | "Asia/Taipei" - | "Asia/Tashkent" - | "Asia/Tbilisi" - | "Asia/Tehran" - | "Asia/Tel_Aviv" - | "Asia/Thimbu" - | "Asia/Thimphu" - | "Asia/Tokyo" - | "Asia/Tomsk" - | "Asia/Ujung_Pandang" - | "Asia/Ulaanbaatar" - | "Asia/Ulan_Bator" - | "Asia/Urumqi" - | "Asia/Ust-Nera" - | "Asia/Vientiane" - | "Asia/Vladivostok" - | "Asia/Yakutsk" - | "Asia/Yangon" - | "Asia/Yekaterinburg" - | "Asia/Yerevan" - | "Atlantic/Azores" - | "Atlantic/Bermuda" - | "Atlantic/Canary" - | "Atlantic/Cape_Verde" - | "Atlantic/Faeroe" - | "Atlantic/Faroe" - | "Atlantic/Jan_Mayen" - | "Atlantic/Madeira" - | "Atlantic/Reykjavik" - | "Atlantic/South_Georgia" - | "Atlantic/St_Helena" - | "Atlantic/Stanley" - | "Australia/ACT" - | "Australia/Adelaide" - | "Australia/Brisbane" - | "Australia/Broken_Hill" - | "Australia/Canberra" - | "Australia/Currie" - | "Australia/Darwin" - | "Australia/Eucla" - | "Australia/Hobart" - | "Australia/LHI" - | "Australia/Lindeman" - | "Australia/Lord_Howe" - | "Australia/Melbourne" - | "Australia/NSW" - | "Australia/North" - | "Australia/Perth" - | "Australia/Queensland" - | "Australia/South" - | "Australia/Sydney" - | "Australia/Tasmania" - | "Australia/Victoria" - | "Australia/West" - | "Australia/Yancowinna" - | "Brazil/Acre" - | "Brazil/DeNoronha" - | "Brazil/East" - | "Brazil/West" - | "CET" - | "CST6CDT" - | "Canada/Atlantic" - | "Canada/Central" - | "Canada/Eastern" - | "Canada/Mountain" - | "Canada/Newfoundland" - | "Canada/Pacific" - | "Canada/Saskatchewan" - | "Canada/Yukon" - | "Chile/Continental" - | "Chile/EasterIsland" - | "Cuba" - | "EET" - | "EST" - | "EST5EDT" - | "Egypt" - | "Eire" - | "Etc/GMT" - | "Etc/GMT+0" - | "Etc/GMT+1" - | "Etc/GMT+10" - | "Etc/GMT+11" - | "Etc/GMT+12" - | "Etc/GMT+2" - | "Etc/GMT+3" - | "Etc/GMT+4" - | "Etc/GMT+5" - | "Etc/GMT+6" - | "Etc/GMT+7" - | "Etc/GMT+8" - | "Etc/GMT+9" - | "Etc/GMT-0" - | "Etc/GMT-1" - | "Etc/GMT-10" - | "Etc/GMT-11" - | "Etc/GMT-12" - | "Etc/GMT-13" - | "Etc/GMT-14" - | "Etc/GMT-2" - | "Etc/GMT-3" - | "Etc/GMT-4" - | "Etc/GMT-5" - | "Etc/GMT-6" - | "Etc/GMT-7" - | "Etc/GMT-8" - | "Etc/GMT-9" - | "Etc/GMT0" - | "Etc/Greenwich" - | "Etc/UCT" - | "Etc/UTC" - | "Etc/Universal" - | "Etc/Zulu" - | "Europe/Amsterdam" - | "Europe/Andorra" - | "Europe/Astrakhan" - | "Europe/Athens" - | "Europe/Belfast" - | "Europe/Belgrade" - | "Europe/Berlin" - | "Europe/Bratislava" - | "Europe/Brussels" - | "Europe/Bucharest" - | "Europe/Budapest" - | "Europe/Busingen" - | "Europe/Chisinau" - | "Europe/Copenhagen" - | "Europe/Dublin" - | "Europe/Gibraltar" - | "Europe/Guernsey" - | "Europe/Helsinki" - | "Europe/Isle_of_Man" - | "Europe/Istanbul" - | "Europe/Jersey" - | "Europe/Kaliningrad" - | "Europe/Kiev" - | "Europe/Kirov" - | "Europe/Lisbon" - | "Europe/Ljubljana" - | "Europe/London" - | "Europe/Luxembourg" - | "Europe/Madrid" - | "Europe/Malta" - | "Europe/Mariehamn" - | "Europe/Minsk" - | "Europe/Monaco" - | "Europe/Moscow" - | "Europe/Nicosia" - | "Europe/Oslo" - | "Europe/Paris" - | "Europe/Podgorica" - | "Europe/Prague" - | "Europe/Riga" - | "Europe/Rome" - | "Europe/Samara" - | "Europe/San_Marino" - | "Europe/Sarajevo" - | "Europe/Saratov" - | "Europe/Simferopol" - | "Europe/Skopje" - | "Europe/Sofia" - | "Europe/Stockholm" - | "Europe/Tallinn" - | "Europe/Tirane" - | "Europe/Tiraspol" - | "Europe/Ulyanovsk" - | "Europe/Uzhgorod" - | "Europe/Vaduz" - | "Europe/Vatican" - | "Europe/Vienna" - | "Europe/Vilnius" - | "Europe/Volgograd" - | "Europe/Warsaw" - | "Europe/Zagreb" - | "Europe/Zaporozhye" - | "Europe/Zurich" - | "Factory" - | "GB" - | "GB-Eire" - | "GMT" - | "GMT+0" - | "GMT-0" - | "GMT0" - | "Greenwich" - | "HST" - | "Hongkong" - | "Iceland" - | "Indian/Antananarivo" - | "Indian/Chagos" - | "Indian/Christmas" - | "Indian/Cocos" - | "Indian/Comoro" - | "Indian/Kerguelen" - | "Indian/Mahe" - | "Indian/Maldives" - | "Indian/Mauritius" - | "Indian/Mayotte" - | "Indian/Reunion" - | "Iran" - | "Israel" - | "Jamaica" - | "Japan" - | "Kwajalein" - | "Libya" - | "MET" - | "MST" - | "MST7MDT" - | "Mexico/BajaNorte" - | "Mexico/BajaSur" - | "Mexico/General" - | "NZ" - | "NZ-CHAT" - | "Navajo" - | "PRC" - | "PST8PDT" - | "Pacific/Apia" - | "Pacific/Auckland" - | "Pacific/Bougainville" - | "Pacific/Chatham" - | "Pacific/Chuuk" - | "Pacific/Easter" - | "Pacific/Efate" - | "Pacific/Enderbury" - | "Pacific/Fakaofo" - | "Pacific/Fiji" - | "Pacific/Funafuti" - | "Pacific/Galapagos" - | "Pacific/Gambier" - | "Pacific/Guadalcanal" - | "Pacific/Guam" - | "Pacific/Honolulu" - | "Pacific/Johnston" - | "Pacific/Kiritimati" - | "Pacific/Kosrae" - | "Pacific/Kwajalein" - | "Pacific/Majuro" - | "Pacific/Marquesas" - | "Pacific/Midway" - | "Pacific/Nauru" - | "Pacific/Niue" - | "Pacific/Norfolk" - | "Pacific/Noumea" - | "Pacific/Pago_Pago" - | "Pacific/Palau" - | "Pacific/Pitcairn" - | "Pacific/Pohnpei" - | "Pacific/Ponape" - | "Pacific/Port_Moresby" - | "Pacific/Rarotonga" - | "Pacific/Saipan" - | "Pacific/Samoa" - | "Pacific/Tahiti" - | "Pacific/Tarawa" - | "Pacific/Tongatapu" - | "Pacific/Truk" - | "Pacific/Wake" - | "Pacific/Wallis" - | "Pacific/Yap" - | "Poland" - | "Portugal" - | "ROC" - | "ROK" - | "Singapore" - | "Turkey" - | "UCT" - | "US/Alaska" - | "US/Aleutian" - | "US/Arizona" - | "US/Central" - | "US/East-Indiana" - | "US/Eastern" - | "US/Hawaii" - | "US/Indiana-Starke" - | "US/Michigan" - | "US/Mountain" - | "US/Pacific" - | "US/Pacific-New" - | "US/Samoa" - | "UTC" - | "Universal" - | "W-SU" - | "WET" - | "Zulu"; - }; + | 'Africa/Abidjan' + | 'Africa/Accra' + | 'Africa/Addis_Ababa' + | 'Africa/Algiers' + | 'Africa/Asmara' + | 'Africa/Asmera' + | 'Africa/Bamako' + | 'Africa/Bangui' + | 'Africa/Banjul' + | 'Africa/Bissau' + | 'Africa/Blantyre' + | 'Africa/Brazzaville' + | 'Africa/Bujumbura' + | 'Africa/Cairo' + | 'Africa/Casablanca' + | 'Africa/Ceuta' + | 'Africa/Conakry' + | 'Africa/Dakar' + | 'Africa/Dar_es_Salaam' + | 'Africa/Djibouti' + | 'Africa/Douala' + | 'Africa/El_Aaiun' + | 'Africa/Freetown' + | 'Africa/Gaborone' + | 'Africa/Harare' + | 'Africa/Johannesburg' + | 'Africa/Juba' + | 'Africa/Kampala' + | 'Africa/Khartoum' + | 'Africa/Kigali' + | 'Africa/Kinshasa' + | 'Africa/Lagos' + | 'Africa/Libreville' + | 'Africa/Lome' + | 'Africa/Luanda' + | 'Africa/Lubumbashi' + | 'Africa/Lusaka' + | 'Africa/Malabo' + | 'Africa/Maputo' + | 'Africa/Maseru' + | 'Africa/Mbabane' + | 'Africa/Mogadishu' + | 'Africa/Monrovia' + | 'Africa/Nairobi' + | 'Africa/Ndjamena' + | 'Africa/Niamey' + | 'Africa/Nouakchott' + | 'Africa/Ouagadougou' + | 'Africa/Porto-Novo' + | 'Africa/Sao_Tome' + | 'Africa/Timbuktu' + | 'Africa/Tripoli' + | 'Africa/Tunis' + | 'Africa/Windhoek' + | 'America/Adak' + | 'America/Anchorage' + | 'America/Anguilla' + | 'America/Antigua' + | 'America/Araguaina' + | 'America/Argentina/Buenos_Aires' + | 'America/Argentina/Catamarca' + | 'America/Argentina/ComodRivadavia' + | 'America/Argentina/Cordoba' + | 'America/Argentina/Jujuy' + | 'America/Argentina/La_Rioja' + | 'America/Argentina/Mendoza' + | 'America/Argentina/Rio_Gallegos' + | 'America/Argentina/Salta' + | 'America/Argentina/San_Juan' + | 'America/Argentina/San_Luis' + | 'America/Argentina/Tucuman' + | 'America/Argentina/Ushuaia' + | 'America/Aruba' + | 'America/Asuncion' + | 'America/Atikokan' + | 'America/Atka' + | 'America/Bahia' + | 'America/Bahia_Banderas' + | 'America/Barbados' + | 'America/Belem' + | 'America/Belize' + | 'America/Blanc-Sablon' + | 'America/Boa_Vista' + | 'America/Bogota' + | 'America/Boise' + | 'America/Buenos_Aires' + | 'America/Cambridge_Bay' + | 'America/Campo_Grande' + | 'America/Cancun' + | 'America/Caracas' + | 'America/Catamarca' + | 'America/Cayenne' + | 'America/Cayman' + | 'America/Chicago' + | 'America/Chihuahua' + | 'America/Coral_Harbour' + | 'America/Cordoba' + | 'America/Costa_Rica' + | 'America/Creston' + | 'America/Cuiaba' + | 'America/Curacao' + | 'America/Danmarkshavn' + | 'America/Dawson' + | 'America/Dawson_Creek' + | 'America/Denver' + | 'America/Detroit' + | 'America/Dominica' + | 'America/Edmonton' + | 'America/Eirunepe' + | 'America/El_Salvador' + | 'America/Ensenada' + | 'America/Fort_Nelson' + | 'America/Fort_Wayne' + | 'America/Fortaleza' + | 'America/Glace_Bay' + | 'America/Godthab' + | 'America/Goose_Bay' + | 'America/Grand_Turk' + | 'America/Grenada' + | 'America/Guadeloupe' + | 'America/Guatemala' + | 'America/Guayaquil' + | 'America/Guyana' + | 'America/Halifax' + | 'America/Havana' + | 'America/Hermosillo' + | 'America/Indiana/Indianapolis' + | 'America/Indiana/Knox' + | 'America/Indiana/Marengo' + | 'America/Indiana/Petersburg' + | 'America/Indiana/Tell_City' + | 'America/Indiana/Vevay' + | 'America/Indiana/Vincennes' + | 'America/Indiana/Winamac' + | 'America/Indianapolis' + | 'America/Inuvik' + | 'America/Iqaluit' + | 'America/Jamaica' + | 'America/Jujuy' + | 'America/Juneau' + | 'America/Kentucky/Louisville' + | 'America/Kentucky/Monticello' + | 'America/Knox_IN' + | 'America/Kralendijk' + | 'America/La_Paz' + | 'America/Lima' + | 'America/Los_Angeles' + | 'America/Louisville' + | 'America/Lower_Princes' + | 'America/Maceio' + | 'America/Managua' + | 'America/Manaus' + | 'America/Marigot' + | 'America/Martinique' + | 'America/Matamoros' + | 'America/Mazatlan' + | 'America/Mendoza' + | 'America/Menominee' + | 'America/Merida' + | 'America/Metlakatla' + | 'America/Mexico_City' + | 'America/Miquelon' + | 'America/Moncton' + | 'America/Monterrey' + | 'America/Montevideo' + | 'America/Montreal' + | 'America/Montserrat' + | 'America/Nassau' + | 'America/New_York' + | 'America/Nipigon' + | 'America/Nome' + | 'America/Noronha' + | 'America/North_Dakota/Beulah' + | 'America/North_Dakota/Center' + | 'America/North_Dakota/New_Salem' + | 'America/Ojinaga' + | 'America/Panama' + | 'America/Pangnirtung' + | 'America/Paramaribo' + | 'America/Phoenix' + | 'America/Port-au-Prince' + | 'America/Port_of_Spain' + | 'America/Porto_Acre' + | 'America/Porto_Velho' + | 'America/Puerto_Rico' + | 'America/Punta_Arenas' + | 'America/Rainy_River' + | 'America/Rankin_Inlet' + | 'America/Recife' + | 'America/Regina' + | 'America/Resolute' + | 'America/Rio_Branco' + | 'America/Rosario' + | 'America/Santa_Isabel' + | 'America/Santarem' + | 'America/Santiago' + | 'America/Santo_Domingo' + | 'America/Sao_Paulo' + | 'America/Scoresbysund' + | 'America/Shiprock' + | 'America/Sitka' + | 'America/St_Barthelemy' + | 'America/St_Johns' + | 'America/St_Kitts' + | 'America/St_Lucia' + | 'America/St_Thomas' + | 'America/St_Vincent' + | 'America/Swift_Current' + | 'America/Tegucigalpa' + | 'America/Thule' + | 'America/Thunder_Bay' + | 'America/Tijuana' + | 'America/Toronto' + | 'America/Tortola' + | 'America/Vancouver' + | 'America/Virgin' + | 'America/Whitehorse' + | 'America/Winnipeg' + | 'America/Yakutat' + | 'America/Yellowknife' + | 'Antarctica/Casey' + | 'Antarctica/Davis' + | 'Antarctica/DumontDUrville' + | 'Antarctica/Macquarie' + | 'Antarctica/Mawson' + | 'Antarctica/McMurdo' + | 'Antarctica/Palmer' + | 'Antarctica/Rothera' + | 'Antarctica/South_Pole' + | 'Antarctica/Syowa' + | 'Antarctica/Troll' + | 'Antarctica/Vostok' + | 'Arctic/Longyearbyen' + | 'Asia/Aden' + | 'Asia/Almaty' + | 'Asia/Amman' + | 'Asia/Anadyr' + | 'Asia/Aqtau' + | 'Asia/Aqtobe' + | 'Asia/Ashgabat' + | 'Asia/Ashkhabad' + | 'Asia/Atyrau' + | 'Asia/Baghdad' + | 'Asia/Bahrain' + | 'Asia/Baku' + | 'Asia/Bangkok' + | 'Asia/Barnaul' + | 'Asia/Beirut' + | 'Asia/Bishkek' + | 'Asia/Brunei' + | 'Asia/Calcutta' + | 'Asia/Chita' + | 'Asia/Choibalsan' + | 'Asia/Chongqing' + | 'Asia/Chungking' + | 'Asia/Colombo' + | 'Asia/Dacca' + | 'Asia/Damascus' + | 'Asia/Dhaka' + | 'Asia/Dili' + | 'Asia/Dubai' + | 'Asia/Dushanbe' + | 'Asia/Famagusta' + | 'Asia/Gaza' + | 'Asia/Harbin' + | 'Asia/Hebron' + | 'Asia/Ho_Chi_Minh' + | 'Asia/Hong_Kong' + | 'Asia/Hovd' + | 'Asia/Irkutsk' + | 'Asia/Istanbul' + | 'Asia/Jakarta' + | 'Asia/Jayapura' + | 'Asia/Jerusalem' + | 'Asia/Kabul' + | 'Asia/Kamchatka' + | 'Asia/Karachi' + | 'Asia/Kashgar' + | 'Asia/Kathmandu' + | 'Asia/Katmandu' + | 'Asia/Khandyga' + | 'Asia/Kolkata' + | 'Asia/Krasnoyarsk' + | 'Asia/Kuala_Lumpur' + | 'Asia/Kuching' + | 'Asia/Kuwait' + | 'Asia/Macao' + | 'Asia/Macau' + | 'Asia/Magadan' + | 'Asia/Makassar' + | 'Asia/Manila' + | 'Asia/Muscat' + | 'Asia/Nicosia' + | 'Asia/Novokuznetsk' + | 'Asia/Novosibirsk' + | 'Asia/Omsk' + | 'Asia/Oral' + | 'Asia/Phnom_Penh' + | 'Asia/Pontianak' + | 'Asia/Pyongyang' + | 'Asia/Qatar' + | 'Asia/Qostanay' + | 'Asia/Qyzylorda' + | 'Asia/Rangoon' + | 'Asia/Riyadh' + | 'Asia/Saigon' + | 'Asia/Sakhalin' + | 'Asia/Samarkand' + | 'Asia/Seoul' + | 'Asia/Shanghai' + | 'Asia/Singapore' + | 'Asia/Srednekolymsk' + | 'Asia/Taipei' + | 'Asia/Tashkent' + | 'Asia/Tbilisi' + | 'Asia/Tehran' + | 'Asia/Tel_Aviv' + | 'Asia/Thimbu' + | 'Asia/Thimphu' + | 'Asia/Tokyo' + | 'Asia/Tomsk' + | 'Asia/Ujung_Pandang' + | 'Asia/Ulaanbaatar' + | 'Asia/Ulan_Bator' + | 'Asia/Urumqi' + | 'Asia/Ust-Nera' + | 'Asia/Vientiane' + | 'Asia/Vladivostok' + | 'Asia/Yakutsk' + | 'Asia/Yangon' + | 'Asia/Yekaterinburg' + | 'Asia/Yerevan' + | 'Atlantic/Azores' + | 'Atlantic/Bermuda' + | 'Atlantic/Canary' + | 'Atlantic/Cape_Verde' + | 'Atlantic/Faeroe' + | 'Atlantic/Faroe' + | 'Atlantic/Jan_Mayen' + | 'Atlantic/Madeira' + | 'Atlantic/Reykjavik' + | 'Atlantic/South_Georgia' + | 'Atlantic/St_Helena' + | 'Atlantic/Stanley' + | 'Australia/ACT' + | 'Australia/Adelaide' + | 'Australia/Brisbane' + | 'Australia/Broken_Hill' + | 'Australia/Canberra' + | 'Australia/Currie' + | 'Australia/Darwin' + | 'Australia/Eucla' + | 'Australia/Hobart' + | 'Australia/LHI' + | 'Australia/Lindeman' + | 'Australia/Lord_Howe' + | 'Australia/Melbourne' + | 'Australia/NSW' + | 'Australia/North' + | 'Australia/Perth' + | 'Australia/Queensland' + | 'Australia/South' + | 'Australia/Sydney' + | 'Australia/Tasmania' + | 'Australia/Victoria' + | 'Australia/West' + | 'Australia/Yancowinna' + | 'Brazil/Acre' + | 'Brazil/DeNoronha' + | 'Brazil/East' + | 'Brazil/West' + | 'CET' + | 'CST6CDT' + | 'Canada/Atlantic' + | 'Canada/Central' + | 'Canada/Eastern' + | 'Canada/Mountain' + | 'Canada/Newfoundland' + | 'Canada/Pacific' + | 'Canada/Saskatchewan' + | 'Canada/Yukon' + | 'Chile/Continental' + | 'Chile/EasterIsland' + | 'Cuba' + | 'EET' + | 'EST' + | 'EST5EDT' + | 'Egypt' + | 'Eire' + | 'Etc/GMT' + | 'Etc/GMT+0' + | 'Etc/GMT+1' + | 'Etc/GMT+10' + | 'Etc/GMT+11' + | 'Etc/GMT+12' + | 'Etc/GMT+2' + | 'Etc/GMT+3' + | 'Etc/GMT+4' + | 'Etc/GMT+5' + | 'Etc/GMT+6' + | 'Etc/GMT+7' + | 'Etc/GMT+8' + | 'Etc/GMT+9' + | 'Etc/GMT-0' + | 'Etc/GMT-1' + | 'Etc/GMT-10' + | 'Etc/GMT-11' + | 'Etc/GMT-12' + | 'Etc/GMT-13' + | 'Etc/GMT-14' + | 'Etc/GMT-2' + | 'Etc/GMT-3' + | 'Etc/GMT-4' + | 'Etc/GMT-5' + | 'Etc/GMT-6' + | 'Etc/GMT-7' + | 'Etc/GMT-8' + | 'Etc/GMT-9' + | 'Etc/GMT0' + | 'Etc/Greenwich' + | 'Etc/UCT' + | 'Etc/UTC' + | 'Etc/Universal' + | 'Etc/Zulu' + | 'Europe/Amsterdam' + | 'Europe/Andorra' + | 'Europe/Astrakhan' + | 'Europe/Athens' + | 'Europe/Belfast' + | 'Europe/Belgrade' + | 'Europe/Berlin' + | 'Europe/Bratislava' + | 'Europe/Brussels' + | 'Europe/Bucharest' + | 'Europe/Budapest' + | 'Europe/Busingen' + | 'Europe/Chisinau' + | 'Europe/Copenhagen' + | 'Europe/Dublin' + | 'Europe/Gibraltar' + | 'Europe/Guernsey' + | 'Europe/Helsinki' + | 'Europe/Isle_of_Man' + | 'Europe/Istanbul' + | 'Europe/Jersey' + | 'Europe/Kaliningrad' + | 'Europe/Kiev' + | 'Europe/Kirov' + | 'Europe/Lisbon' + | 'Europe/Ljubljana' + | 'Europe/London' + | 'Europe/Luxembourg' + | 'Europe/Madrid' + | 'Europe/Malta' + | 'Europe/Mariehamn' + | 'Europe/Minsk' + | 'Europe/Monaco' + | 'Europe/Moscow' + | 'Europe/Nicosia' + | 'Europe/Oslo' + | 'Europe/Paris' + | 'Europe/Podgorica' + | 'Europe/Prague' + | 'Europe/Riga' + | 'Europe/Rome' + | 'Europe/Samara' + | 'Europe/San_Marino' + | 'Europe/Sarajevo' + | 'Europe/Saratov' + | 'Europe/Simferopol' + | 'Europe/Skopje' + | 'Europe/Sofia' + | 'Europe/Stockholm' + | 'Europe/Tallinn' + | 'Europe/Tirane' + | 'Europe/Tiraspol' + | 'Europe/Ulyanovsk' + | 'Europe/Uzhgorod' + | 'Europe/Vaduz' + | 'Europe/Vatican' + | 'Europe/Vienna' + | 'Europe/Vilnius' + | 'Europe/Volgograd' + | 'Europe/Warsaw' + | 'Europe/Zagreb' + | 'Europe/Zaporozhye' + | 'Europe/Zurich' + | 'Factory' + | 'GB' + | 'GB-Eire' + | 'GMT' + | 'GMT+0' + | 'GMT-0' + | 'GMT0' + | 'Greenwich' + | 'HST' + | 'Hongkong' + | 'Iceland' + | 'Indian/Antananarivo' + | 'Indian/Chagos' + | 'Indian/Christmas' + | 'Indian/Cocos' + | 'Indian/Comoro' + | 'Indian/Kerguelen' + | 'Indian/Mahe' + | 'Indian/Maldives' + | 'Indian/Mauritius' + | 'Indian/Mayotte' + | 'Indian/Reunion' + | 'Iran' + | 'Israel' + | 'Jamaica' + | 'Japan' + | 'Kwajalein' + | 'Libya' + | 'MET' + | 'MST' + | 'MST7MDT' + | 'Mexico/BajaNorte' + | 'Mexico/BajaSur' + | 'Mexico/General' + | 'NZ' + | 'NZ-CHAT' + | 'Navajo' + | 'PRC' + | 'PST8PDT' + | 'Pacific/Apia' + | 'Pacific/Auckland' + | 'Pacific/Bougainville' + | 'Pacific/Chatham' + | 'Pacific/Chuuk' + | 'Pacific/Easter' + | 'Pacific/Efate' + | 'Pacific/Enderbury' + | 'Pacific/Fakaofo' + | 'Pacific/Fiji' + | 'Pacific/Funafuti' + | 'Pacific/Galapagos' + | 'Pacific/Gambier' + | 'Pacific/Guadalcanal' + | 'Pacific/Guam' + | 'Pacific/Honolulu' + | 'Pacific/Johnston' + | 'Pacific/Kiritimati' + | 'Pacific/Kosrae' + | 'Pacific/Kwajalein' + | 'Pacific/Majuro' + | 'Pacific/Marquesas' + | 'Pacific/Midway' + | 'Pacific/Nauru' + | 'Pacific/Niue' + | 'Pacific/Norfolk' + | 'Pacific/Noumea' + | 'Pacific/Pago_Pago' + | 'Pacific/Palau' + | 'Pacific/Pitcairn' + | 'Pacific/Pohnpei' + | 'Pacific/Ponape' + | 'Pacific/Port_Moresby' + | 'Pacific/Rarotonga' + | 'Pacific/Saipan' + | 'Pacific/Samoa' + | 'Pacific/Tahiti' + | 'Pacific/Tarawa' + | 'Pacific/Tongatapu' + | 'Pacific/Truk' + | 'Pacific/Wake' + | 'Pacific/Wallis' + | 'Pacific/Yap' + | 'Poland' + | 'Portugal' + | 'ROC' + | 'ROK' + | 'Singapore' + | 'Turkey' + | 'UCT' + | 'US/Alaska' + | 'US/Aleutian' + | 'US/Arizona' + | 'US/Central' + | 'US/East-Indiana' + | 'US/Eastern' + | 'US/Hawaii' + | 'US/Indiana-Starke' + | 'US/Michigan' + | 'US/Mountain' + | 'US/Pacific' + | 'US/Pacific-New' + | 'US/Samoa' + | 'UTC' + | 'Universal' + | 'W-SU' + | 'WET' + | 'Zulu' + } /** @description The ID of the [report type](https://stripe.com/docs/reporting/statements/api#report-types) to run, such as `"balance.summary.1"`. */ - report_type: string; - }; - }; - }; - }; + report_type: string + } + } + } + } /**

Retrieves the details of an existing Report Run.

*/ GetReportingReportRunsReportRun: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - report_run: string; - }; - }; + report_run: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["reporting.report_run"]; - }; - }; + 'application/json': components['schemas']['reporting.report_run'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a full list of Report Types.

*/ GetReportingReportTypes: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; + expand?: string[] + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["reporting.report_type"][]; + 'application/json': { + data: components['schemas']['reporting.report_type'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves the details of a Report Type. (Certain report types require a live-mode API key.)

*/ GetReportingReportTypesReportType: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - report_type: string; - }; - }; + report_type: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["reporting.report_type"]; - }; - }; + 'application/json': components['schemas']['reporting.report_type'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ GetReviews: { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["review"][]; + 'application/json': { + data: components['schemas']['review'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves a Review object.

*/ GetReviewsReview: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - review: string; - }; - }; + review: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["review"]; - }; - }; + 'application/json': components['schemas']['review'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Approves a Review object, closing it and removing it from the list of reviews.

*/ PostReviewsReviewApprove: { parameters: { path: { - review: string; - }; - }; + review: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["review"]; - }; - }; + 'application/json': components['schemas']['review'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Returns a list of SetupAttempts associated with a provided SetupIntent.

*/ GetSetupAttempts: { parameters: { @@ -38933,115 +38675,115 @@ export interface operations { * dictionary with a number of different query options. */ created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** * Only return SetupAttempts created by the SetupIntent specified by * this ID. */ - setup_intent: string; + setup_intent: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["setup_attempt"][]; + 'application/json': { + data: components['schemas']['setup_attempt'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of SetupIntents.

*/ GetSetupIntents: { parameters: { query: { /** 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?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** Only return SetupIntents for the customer specified by this customer ID. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return SetupIntents associated with the specified payment method. */ - payment_method?: string; + payment_method?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["setup_intent"][]; + 'application/json': { + data: components['schemas']['setup_intent'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Creates a SetupIntent object.

* @@ -39053,31 +38795,31 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["setup_intent"]; - }; - }; + 'application/json': components['schemas']['setup_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Set to `true` to attempt to confirm this SetupIntent immediately. This parameter defaults to `false`. If the payment method attached is a card, a return_url may be provided in case additional authentication is required. */ - confirm?: boolean; + confirm?: boolean /** * @description ID of the Customer this SetupIntent belongs to, if one exists. * * If 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. */ - customer?: string; + customer?: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * secret_key_param * @description This hash contains details about the Mandate to create. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm). @@ -39086,24 +38828,24 @@ export interface operations { /** customer_acceptance_param */ customer_acceptance: { /** Format: unix-time */ - accepted_at?: number; + accepted_at?: number /** offline_param */ - offline?: { [key: string]: unknown }; + offline?: { [key: string]: unknown } /** online_param */ online?: { - ip_address: string; - user_agent: string; - }; + ip_address: string + user_agent: string + } /** @enum {string} */ - type: "offline" | "online"; - }; - }; + type: 'offline' | 'online' + } + } /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description The Stripe account ID for which this SetupIntent is created. */ - on_behalf_of?: string; + on_behalf_of?: string /** @description ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. */ - payment_method?: string; + payment_method?: string /** * payment_method_options_param * @description Payment-method-specific configuration for this SetupIntent. @@ -39112,52 +38854,52 @@ export interface operations { /** setup_intent_payment_method_options_param */ acss_debit?: { /** @enum {string} */ - currency?: "cad" | "usd"; + currency?: 'cad' | 'usd' /** setup_intent_payment_method_options_mandate_options_param */ mandate_options?: { - custom_mandate_url?: Partial & Partial<"">; - default_for?: ("invoice" | "subscription")[]; - interval_description?: string; + custom_mandate_url?: Partial & Partial<''> + default_for?: ('invoice' | 'subscription')[] + interval_description?: string /** @enum {string} */ - payment_schedule?: "combined" | "interval" | "sporadic"; + payment_schedule?: 'combined' | 'interval' | 'sporadic' /** @enum {string} */ - transaction_type?: "business" | "personal"; - }; + transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; - }; + verification_method?: 'automatic' | 'instant' | 'microdeposits' + } /** setup_intent_param */ card?: { /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; - }; + request_three_d_secure?: 'any' | 'automatic' + } /** setup_intent_payment_method_options_param */ sepa_debit?: { /** payment_method_options_mandate_options_param */ - mandate_options?: { [key: string]: unknown }; - }; - }; + mandate_options?: { [key: string]: unknown } + } + } /** @description The list of payment method types (e.g. card) that this SetupIntent is allowed to use. If this is not provided, defaults to ["card"]. */ - payment_method_types?: string[]; + payment_method_types?: string[] /** @description The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm). */ - return_url?: string; + return_url?: string /** * setup_intent_single_use_params * @description If this hash is populated, this SetupIntent will generate a single_use Mandate on success. */ single_use?: { - amount: number; - currency: string; - }; + amount: number + currency: string + } /** * @description Indicates how the payment method is intended to be used in the future. If not provided, this value defaults to `off_session`. * @enum {string} */ - usage?: "off_session" | "on_session"; - }; - }; - }; - }; + usage?: 'off_session' | 'on_session' + } + } + } + } /** *

Retrieves the details of a SetupIntent that has previously been created.

* @@ -39169,72 +38911,72 @@ export interface operations { parameters: { query: { /** The client secret of the SetupIntent. Required if a publishable key is used to retrieve the SetupIntent. */ - client_secret?: string; + client_secret?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - intent: string; - }; - }; + intent: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["setup_intent"]; - }; - }; + 'application/json': components['schemas']['setup_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates a SetupIntent object.

*/ PostSetupIntentsIntent: { parameters: { path: { - intent: string; - }; - }; + intent: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["setup_intent"]; - }; - }; + 'application/json': components['schemas']['setup_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * @description ID of the Customer this SetupIntent belongs to, if one exists. * * If 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. */ - customer?: string; + customer?: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. */ - payment_method?: string; + payment_method?: string /** * payment_method_options_param * @description Payment-method-specific configuration for this SetupIntent. @@ -39243,37 +38985,37 @@ export interface operations { /** setup_intent_payment_method_options_param */ acss_debit?: { /** @enum {string} */ - currency?: "cad" | "usd"; + currency?: 'cad' | 'usd' /** setup_intent_payment_method_options_mandate_options_param */ mandate_options?: { - custom_mandate_url?: Partial & Partial<"">; - default_for?: ("invoice" | "subscription")[]; - interval_description?: string; + custom_mandate_url?: Partial & Partial<''> + default_for?: ('invoice' | 'subscription')[] + interval_description?: string /** @enum {string} */ - payment_schedule?: "combined" | "interval" | "sporadic"; + payment_schedule?: 'combined' | 'interval' | 'sporadic' /** @enum {string} */ - transaction_type?: "business" | "personal"; - }; + transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; - }; + verification_method?: 'automatic' | 'instant' | 'microdeposits' + } /** setup_intent_param */ card?: { /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; - }; + request_three_d_secure?: 'any' | 'automatic' + } /** setup_intent_payment_method_options_param */ sepa_debit?: { /** payment_method_options_mandate_options_param */ - mandate_options?: { [key: string]: unknown }; - }; - }; + mandate_options?: { [key: string]: unknown } + } + } /** @description The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. If this is not provided, defaults to ["card"]. */ - payment_method_types?: string[]; - }; - }; - }; - }; + payment_method_types?: string[] + } + } + } + } /** *

A SetupIntent object can be canceled when it is in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.

* @@ -39282,37 +39024,37 @@ export interface operations { PostSetupIntentsIntentCancel: { parameters: { path: { - intent: string; - }; - }; + intent: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["setup_intent"]; - }; - }; + 'application/json': components['schemas']['setup_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * @description Reason for canceling this SetupIntent. Possible values are `abandoned`, `requested_by_customer`, or `duplicate` * @enum {string} */ - cancellation_reason?: "abandoned" | "duplicate" | "requested_by_customer"; + cancellation_reason?: 'abandoned' | 'duplicate' | 'requested_by_customer' /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /** *

Confirm that your customer intends to set up the current or * provided payment method. For example, you would confirm a SetupIntent @@ -39331,61 +39073,61 @@ export interface operations { PostSetupIntentsIntentConfirm: { parameters: { path: { - intent: string; - }; - }; + intent: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["setup_intent"]; - }; - }; + 'application/json': components['schemas']['setup_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The client secret of the SetupIntent. */ - client_secret?: string; + client_secret?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description This hash contains details about the Mandate to create */ mandate_data?: Partial<{ /** customer_acceptance_param */ customer_acceptance: { /** Format: unix-time */ - accepted_at?: number; + accepted_at?: number /** offline_param */ - offline?: { [key: string]: unknown }; + offline?: { [key: string]: unknown } /** online_param */ online?: { - ip_address: string; - user_agent: string; - }; + ip_address: string + user_agent: string + } /** @enum {string} */ - type: "offline" | "online"; - }; + type: 'offline' | 'online' + } }> & Partial<{ /** customer_acceptance_param */ customer_acceptance: { /** online_param */ online: { - ip_address?: string; - user_agent?: string; - }; + ip_address?: string + user_agent?: string + } /** @enum {string} */ - type: "online"; - }; - }>; + type: 'online' + } + }> /** @description ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. */ - payment_method?: string; + payment_method?: string /** * payment_method_options_param * @description Payment-method-specific configuration for this SetupIntent. @@ -39394,151 +39136,151 @@ export interface operations { /** setup_intent_payment_method_options_param */ acss_debit?: { /** @enum {string} */ - currency?: "cad" | "usd"; + currency?: 'cad' | 'usd' /** setup_intent_payment_method_options_mandate_options_param */ mandate_options?: { - custom_mandate_url?: Partial & Partial<"">; - default_for?: ("invoice" | "subscription")[]; - interval_description?: string; + custom_mandate_url?: Partial & Partial<''> + default_for?: ('invoice' | 'subscription')[] + interval_description?: string /** @enum {string} */ - payment_schedule?: "combined" | "interval" | "sporadic"; + payment_schedule?: 'combined' | 'interval' | 'sporadic' /** @enum {string} */ - transaction_type?: "business" | "personal"; - }; + transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; - }; + verification_method?: 'automatic' | 'instant' | 'microdeposits' + } /** setup_intent_param */ card?: { /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; - }; + request_three_d_secure?: 'any' | 'automatic' + } /** setup_intent_payment_method_options_param */ sepa_debit?: { /** payment_method_options_mandate_options_param */ - mandate_options?: { [key: string]: unknown }; - }; - }; + mandate_options?: { [key: string]: unknown } + } + } /** * @description The URL to redirect your customer back to after they authenticate on the payment method's app or site. * If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. * This parameter is only used for cards and other redirect-based payment methods. */ - return_url?: string; - }; - }; - }; - }; + return_url?: string + } + } + } + } /**

Verifies microdeposits on a SetupIntent object.

*/ PostSetupIntentsIntentVerifyMicrodeposits: { parameters: { path: { - intent: string; - }; - }; + intent: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["setup_intent"]; - }; - }; + 'application/json': components['schemas']['setup_intent'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account. */ - amounts?: number[]; + amounts?: number[] /** @description The client secret of the SetupIntent. */ - client_secret?: string; + client_secret?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

Returns a list of your shipping rates.

*/ GetShippingRates: { parameters: { query: { /** Only return shipping rates that are active or inactive. */ - active?: boolean; + active?: boolean /** 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?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** Only return shipping rates for the given currency. */ - currency?: string; + currency?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["shipping_rate"][]; + 'application/json': { + data: components['schemas']['shipping_rate'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new shipping rate object.

*/ PostShippingRates: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["shipping_rate"]; - }; - }; + 'application/json': components['schemas']['shipping_rate'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * delivery_estimate * @description The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions. @@ -39547,335 +39289,335 @@ export interface operations { /** delivery_estimate_bound */ maximum?: { /** @enum {string} */ - unit: "business_day" | "day" | "hour" | "month" | "week"; - value: number; - }; + unit: 'business_day' | 'day' | 'hour' | 'month' | 'week' + value: number + } /** delivery_estimate_bound */ minimum?: { /** @enum {string} */ - unit: "business_day" | "day" | "hour" | "month" | "week"; - value: number; - }; - }; + unit: 'business_day' | 'day' | 'hour' | 'month' | 'week' + value: number + } + } /** @description The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions. */ - display_name: string; + display_name: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * fixed_amount * @description Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`. */ fixed_amount?: { - amount: number; - currency: string; - }; + amount: number + currency: string + } /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * @description Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. * @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' /** @description A [tax code](https://stripe.com/docs/tax/tax-codes) ID. The Shipping tax code is `txcd_92010001`. */ - tax_code?: string; + tax_code?: string /** * @description The type of calculation to use on the shipping rate. Can only be `fixed_amount` for now. * @enum {string} */ - type?: "fixed_amount"; - }; - }; - }; - }; + type?: 'fixed_amount' + } + } + } + } /**

Returns the shipping rate object with the given ID.

*/ GetShippingRatesShippingRateToken: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - shipping_rate_token: string; - }; - }; + shipping_rate_token: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["shipping_rate"]; - }; - }; + 'application/json': components['schemas']['shipping_rate'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates an existing shipping rate object.

*/ PostShippingRatesShippingRateToken: { parameters: { path: { - shipping_rate_token: string; - }; - }; + shipping_rate_token: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["shipping_rate"]; - }; - }; + 'application/json': components['schemas']['shipping_rate'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether the shipping rate can be used for new purchases. Defaults to `true`. */ - active?: boolean; + active?: boolean /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Returns a list of scheduled query runs.

*/ GetSigmaScheduledQueryRuns: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["scheduled_query_run"][]; + 'application/json': { + data: components['schemas']['scheduled_query_run'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves the details of an scheduled query run.

*/ GetSigmaScheduledQueryRunsScheduledQueryRun: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - scheduled_query_run: string; - }; - }; + scheduled_query_run: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["scheduled_query_run"]; - }; - }; + 'application/json': components['schemas']['scheduled_query_run'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of your SKUs. The SKUs are returned sorted by creation date, with the most recently created SKUs appearing first.

*/ GetSkus: { parameters: { query: { /** Only return SKUs that are active or inactive (e.g., pass `false` to list all inactive products). */ - active?: boolean; + active?: boolean /** Only return SKUs that have the specified key-value pairs in this partially constructed dictionary. Can be specified only if `product` is also supplied. For instance, if the associated product has attributes `["color", "size"]`, passing in `attributes[color]=red` returns all the SKUs for this product that have `color` set to `red`. */ - attributes?: { [key: string]: string }; + attributes?: { [key: string]: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** Only return SKUs with the given IDs. */ - ids?: string[]; + ids?: string[] /** Only return SKUs that are either in stock or out of stock (e.g., pass `false` to list all SKUs that are out of stock). If no value is provided, all SKUs are returned. */ - in_stock?: boolean; + in_stock?: boolean /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** The ID of the product whose SKUs will be retrieved. Must be a product with type `good`. */ - product?: string; + product?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["sku"][]; + 'application/json': { + data: components['schemas']['sku'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new SKU associated with a product.

*/ PostSkus: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["sku"]; - }; - }; + 'application/json': components['schemas']['sku'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether the SKU is available for purchase. Default to `true`. */ - active?: boolean; + active?: boolean /** @description A dictionary of attributes and values for the attributes defined by the product. If, for example, a product's attributes are `["size", "gender"]`, a valid SKU has the following dictionary of attributes: `{"size": "Medium", "gender": "Unisex"}`. */ - attributes?: { [key: string]: string }; + attributes?: { [key: string]: string } /** @description 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: string; + currency: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The identifier for the SKU. Must be unique. If not provided, an identifier will be randomly generated. */ - id?: string; + id?: string /** @description The URL of an image for this SKU, meant to be displayable to the customer. */ - image?: string; + image?: string /** * inventory_create_specs * @description Description of the SKU's inventory. */ inventory: { - quantity?: number; + quantity?: number /** @enum {string} */ - type: "bucket" | "finite" | "infinite"; + type: 'bucket' | 'finite' | 'infinite' /** @enum {string} */ - value?: "" | "in_stock" | "limited" | "out_of_stock"; - }; + value?: '' | 'in_stock' | 'limited' | 'out_of_stock' + } /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * package_dimensions_specs * @description The dimensions of this SKU for shipping purposes. */ package_dimensions?: { - height: number; - length: number; - weight: number; - width: number; - }; + height: number + length: number + weight: number + width: number + } /** @description The cost of the item as a nonnegative integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a zero-decimal currency). */ - price: number; + price: number /** @description The ID of the product this SKU is associated with. Must be a product with type `good`. */ - product: string; - }; - }; - }; - }; + product: string + } + } + } + } /**

Retrieves the details of an existing SKU. Supply the unique SKU identifier from either a SKU creation request or from the product, and Stripe will return the corresponding SKU information.

*/ GetSkusId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": Partial & Partial; - }; - }; + 'application/json': Partial & Partial + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates the specific SKU by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

* @@ -39884,124 +39626,124 @@ export interface operations { PostSkusId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["sku"]; - }; - }; + 'application/json': components['schemas']['sku'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Whether this SKU is available for purchase. */ - active?: boolean; + active?: boolean /** @description A dictionary of attributes and values for the attributes defined by the product. When specified, `attributes` will partially update the existing attributes dictionary on the product, with the postcondition that a value must be present for each attribute key on the product. */ - attributes?: { [key: string]: string }; + attributes?: { [key: string]: string } /** @description 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?: string; + currency?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The URL of an image for this SKU, meant to be displayable to the customer. */ - image?: string; + image?: string /** * inventory_update_specs * @description Description of the SKU's inventory. */ inventory?: { - quantity?: number; + quantity?: number /** @enum {string} */ - type?: "bucket" | "finite" | "infinite"; + type?: 'bucket' | 'finite' | 'infinite' /** @enum {string} */ - value?: "" | "in_stock" | "limited" | "out_of_stock"; - }; + value?: '' | 'in_stock' | 'limited' | 'out_of_stock' + } /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The dimensions of this SKU for shipping purposes. */ package_dimensions?: Partial<{ - height: number; - length: number; - weight: number; - width: number; + height: number + length: number + weight: number + width: number }> & - Partial<"">; + Partial<''> /** @description The cost of the item as a positive integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a zero-decimal currency). */ - price?: number; + price?: number /** @description The ID of the product that this SKU should belong to. The product must exist, have the same set of attribute names as the SKU's current product, and be of type `good`. */ - product?: string; - }; - }; - }; - }; + product?: string + } + } + } + } /**

Delete a SKU. Deleting a SKU is only possible until it has been used in an order.

*/ DeleteSkusId: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_sku"]; - }; - }; + 'application/json': components['schemas']['deleted_sku'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new source object.

*/ PostSources: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["source"]; - }; - }; + 'application/json': components['schemas']['source'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources. Not supported for `receiver` type sources, where charge amount may not be specified until funds land. */ - amount?: number; + amount?: number /** @description 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. */ - currency?: string; + currency?: string /** @description The `Customer` to whom the original source is attached to. Must be set when the original source is not a `Source` (e.g., `Card`). */ - customer?: string; + customer?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * @description The authentication `flow` of the source to create. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`. It is generally inferred unless a type supports multiple flows. * @enum {string} */ - flow?: "code_verification" | "none" | "receiver" | "redirect"; + flow?: 'code_verification' | 'none' | 'receiver' | 'redirect' /** * mandate_params * @description Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status. @@ -40010,35 +39752,35 @@ export interface operations { /** mandate_acceptance_params */ acceptance?: { /** Format: unix-time */ - date?: number; - ip?: string; + date?: number + ip?: string /** mandate_offline_acceptance_params */ offline?: { - contact_email: string; - }; + contact_email: string + } /** mandate_online_acceptance_params */ online?: { /** Format: unix-time */ - date?: number; - ip?: string; - user_agent?: string; - }; + date?: number + ip?: string + user_agent?: string + } /** @enum {string} */ - status: "accepted" | "pending" | "refused" | "revoked"; + status: 'accepted' | 'pending' | 'refused' | 'revoked' /** @enum {string} */ - type?: "offline" | "online"; - user_agent?: string; - }; - amount?: Partial & Partial<"">; - currency?: string; + type?: 'offline' | 'online' + user_agent?: string + } + amount?: Partial & Partial<''> + currency?: string /** @enum {string} */ - interval?: "one_time" | "scheduled" | "variable"; + interval?: 'one_time' | 'scheduled' | 'variable' /** @enum {string} */ - notification_method?: "deprecated_none" | "email" | "manual" | "none" | "stripe_email"; - }; - metadata?: { [key: string]: string }; + notification_method?: 'deprecated_none' | 'email' | 'manual' | 'none' | 'stripe_email' + } + metadata?: { [key: string]: string } /** @description The source to share. */ - original_source?: string; + original_source?: string /** * owner * @description Information about the owner of the payment instrument that may be used or required by particular source types. @@ -40046,108 +39788,108 @@ export interface operations { owner?: { /** source_address */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - email?: string; - name?: string; - phone?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + email?: string + name?: string + phone?: string + } /** * receiver_params * @description Optional parameters for the receiver flow. Can be set only if the source is a receiver (`flow` is `receiver`). */ receiver?: { /** @enum {string} */ - refund_attributes_method?: "email" | "manual" | "none"; - }; + refund_attributes_method?: 'email' | 'manual' | 'none' + } /** * redirect_params * @description Parameters required for the redirect flow. Required if the source is authenticated by a redirect (`flow` is `redirect`). */ redirect?: { - return_url: string; - }; + return_url: string + } /** * shallow_order_specs * @description Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it. */ source_order?: { items?: { - amount?: number; - currency?: string; - description?: string; - parent?: string; - quantity?: number; + amount?: number + currency?: string + description?: string + parent?: string + quantity?: number /** @enum {string} */ - type?: "discount" | "shipping" | "sku" | "tax"; - }[]; + type?: 'discount' | 'shipping' | 'sku' | 'tax' + }[] /** order_shipping */ shipping?: { /** address */ address: { - city?: string; - country?: string; - line1: string; - line2?: string; - postal_code?: string; - state?: string; - }; - carrier?: string; - name?: string; - phone?: string; - tracking_number?: string; - }; - }; + city?: string + country?: string + line1: string + line2?: string + postal_code?: string + state?: string + } + carrier?: string + name?: string + phone?: string + tracking_number?: string + } + } /** @description An arbitrary string to be displayed on your customer's statement. As an example, if your website is `RunClub` and the item you're charging for is a race ticket, you may want to specify a `statement_descriptor` of `RunClub 5K race ticket.` While many payment types will display this information, some may not display it at all. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description An optional token used to create the source. When passed, token properties will override source parameters. */ - token?: string; + token?: string /** @description The `type` of the source to create. Required unless `customer` and `original_source` are specified (see the [Cloning card Sources](https://stripe.com/docs/sources/connect#cloning-card-sources) guide) */ - type?: string; + type?: string /** @enum {string} */ - usage?: "reusable" | "single_use"; - }; - }; - }; - }; + usage?: 'reusable' | 'single_use' + } + } + } + } /**

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.

*/ GetSourcesSource: { parameters: { query: { /** The client secret of the source. Required if a publishable key is used to retrieve the source. */ - client_secret?: string; + client_secret?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - source: string; - }; - }; + source: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["source"]; - }; - }; + 'application/json': components['schemas']['source'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates the specified source by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

* @@ -40156,30 +39898,30 @@ export interface operations { PostSourcesSource: { parameters: { path: { - source: string; - }; - }; + source: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["source"]; - }; - }; + 'application/json': components['schemas']['source'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Amount associated with the source. */ - amount?: number; + amount?: number /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * mandate_params * @description Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status. @@ -40188,34 +39930,34 @@ export interface operations { /** mandate_acceptance_params */ acceptance?: { /** Format: unix-time */ - date?: number; - ip?: string; + date?: number + ip?: string /** mandate_offline_acceptance_params */ offline?: { - contact_email: string; - }; + contact_email: string + } /** mandate_online_acceptance_params */ online?: { /** Format: unix-time */ - date?: number; - ip?: string; - user_agent?: string; - }; + date?: number + ip?: string + user_agent?: string + } /** @enum {string} */ - status: "accepted" | "pending" | "refused" | "revoked"; + status: 'accepted' | 'pending' | 'refused' | 'revoked' /** @enum {string} */ - type?: "offline" | "online"; - user_agent?: string; - }; - amount?: Partial & Partial<"">; - currency?: string; + type?: 'offline' | 'online' + user_agent?: string + } + amount?: Partial & Partial<''> + currency?: string /** @enum {string} */ - interval?: "one_time" | "scheduled" | "variable"; + interval?: 'one_time' | 'scheduled' | 'variable' /** @enum {string} */ - notification_method?: "deprecated_none" | "email" | "manual" | "none" | "stripe_email"; - }; + notification_method?: 'deprecated_none' | 'email' | 'manual' | 'none' | 'stripe_email' + } /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** * owner * @description Information about the owner of the payment instrument that may be used or required by particular source types. @@ -40223,271 +39965,271 @@ export interface operations { owner?: { /** source_address */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - email?: string; - name?: string; - phone?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } + email?: string + name?: string + phone?: string + } /** * order_params * @description Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it. */ source_order?: { items?: { - amount?: number; - currency?: string; - description?: string; - parent?: string; - quantity?: number; + amount?: number + currency?: string + description?: string + parent?: string + quantity?: number /** @enum {string} */ - type?: "discount" | "shipping" | "sku" | "tax"; - }[]; + type?: 'discount' | 'shipping' | 'sku' | 'tax' + }[] /** order_shipping */ shipping?: { /** address */ address: { - city?: string; - country?: string; - line1: string; - line2?: string; - postal_code?: string; - state?: string; - }; - carrier?: string; - name?: string; - phone?: string; - tracking_number?: string; - }; - }; - }; - }; - }; - }; + city?: string + country?: string + line1: string + line2?: string + postal_code?: string + state?: string + } + carrier?: string + name?: string + phone?: string + tracking_number?: string + } + } + } + } + } + } /**

Retrieves a new Source MandateNotification.

*/ GetSourcesSourceMandateNotificationsMandateNotification: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - mandate_notification: string; - source: string; - }; - }; + mandate_notification: string + source: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["source_mandate_notification"]; - }; - }; + 'application/json': components['schemas']['source_mandate_notification'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

List source transactions for a given source.

*/ GetSourcesSourceSourceTransactions: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - source: string; - }; - }; + source: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["source_transaction"][]; + 'application/json': { + data: components['schemas']['source_transaction'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ GetSourcesSourceSourceTransactionsSourceTransaction: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - source: string; - source_transaction: string; - }; - }; + source: string + source_transaction: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["source_transaction"]; - }; - }; + 'application/json': components['schemas']['source_transaction'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Verify a given source.

*/ PostSourcesSourceVerify: { parameters: { path: { - source: string; - }; - }; + source: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["source"]; - }; - }; + 'application/json': components['schemas']['source'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The values needed to verify the source. */ - values: string[]; - }; - }; - }; - }; + values: string[] + } + } + } + } /**

Returns a list of your subscription items for a given subscription.

*/ GetSubscriptionItems: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** The ID of the subscription whose items will be retrieved. */ - subscription: string; - }; - }; + subscription: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["subscription_item"][]; + 'application/json': { + data: components['schemas']['subscription_item'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Adds a new item to an existing subscription. No existing items will be changed or replaced.

*/ PostSubscriptionItems: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription_item"]; - }; - }; + 'application/json': components['schemas']['subscription_item'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. */ billing_thresholds?: Partial<{ - usage_gte: number; + usage_gte: number }> & - Partial<"">; + Partial<''> /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** * @description Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * @@ -40498,32 +40240,28 @@ export interface operations { * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. * @enum {string} */ - payment_behavior?: - | "allow_incomplete" - | "default_incomplete" - | "error_if_incomplete" - | "pending_if_incomplete"; + payment_behavior?: 'allow_incomplete' | 'default_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete' /** @description The ID of the price object. */ - price?: string; + price?: string /** * recurring_price_data * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; + unit_amount_decimal?: string + } /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -40532,88 +40270,88 @@ export interface operations { * Prorations can be disabled by passing `none`. * @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** * Format: unix-time * @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. */ - proration_date?: number; + proration_date?: number /** @description The quantity you'd like to apply to the subscription item you're creating. */ - quantity?: number; + quantity?: number /** @description The identifier of the subscription to modify. */ - subscription: string; + subscription: string /** @description A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. */ - tax_rates?: Partial & Partial<"">; - }; - }; - }; - }; + tax_rates?: Partial & Partial<''> + } + } + } + } /**

Retrieves the subscription item with the given ID.

*/ GetSubscriptionItemsItem: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - item: string; - }; - }; + item: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription_item"]; - }; - }; + 'application/json': components['schemas']['subscription_item'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates the plan or quantity of an item on a current subscription.

*/ PostSubscriptionItemsItem: { parameters: { path: { - item: string; - }; - }; + item: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription_item"]; - }; - }; + 'application/json': components['schemas']['subscription_item'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. */ billing_thresholds?: Partial<{ - usage_gte: number; + usage_gte: number }> & - Partial<"">; + Partial<''> /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. */ - off_session?: boolean; + off_session?: boolean /** * @description Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * @@ -40624,32 +40362,28 @@ export interface operations { * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. * @enum {string} */ - payment_behavior?: - | "allow_incomplete" - | "default_incomplete" - | "error_if_incomplete" - | "pending_if_incomplete"; + payment_behavior?: 'allow_incomplete' | 'default_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete' /** @description The ID of the price object. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided. */ - price?: string; + price?: string /** * recurring_price_data * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; + unit_amount_decimal?: string + } /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -40658,46 +40392,46 @@ export interface operations { * Prorations can be disabled by passing `none`. * @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** * Format: unix-time * @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. */ - proration_date?: number; + proration_date?: number /** @description The quantity you'd like to apply to the subscription item you're creating. */ - quantity?: number; + quantity?: number /** @description A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. */ - tax_rates?: Partial & Partial<"">; - }; - }; - }; - }; + tax_rates?: Partial & Partial<''> + } + } + } + } /**

Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.

*/ DeleteSubscriptionItemsItem: { parameters: { path: { - item: string; - }; - }; + item: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_subscription_item"]; - }; - }; + 'application/json': components['schemas']['deleted_subscription_item'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Delete all usage for the given subscription item. Allowed only when the current plan's `usage_type` is `metered`. */ - clear_usage?: boolean; + clear_usage?: boolean /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -40706,16 +40440,16 @@ export interface operations { * Prorations can be disabled by passing `none`. * @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** * Format: unix-time * @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. */ - proration_date?: number; - }; - }; - }; - }; + proration_date?: number + } + } + } + } /** *

For the specified subscription item, returns a list of summary objects. Each object in the list provides usage information that’s been summarized from multiple usage records and over a subscription billing period (e.g., 15 usage records in the month of September).

* @@ -40725,49 +40459,49 @@ export interface operations { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - subscription_item: string; - }; - }; + subscription_item: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["usage_record_summary"][]; + 'application/json': { + data: components['schemas']['usage_record_summary'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Creates a usage record for a specified subscription item and date, and fills it with a quantity.

* @@ -40780,712 +40514,703 @@ export interface operations { PostSubscriptionItemsSubscriptionItemUsageRecords: { parameters: { path: { - subscription_item: string; - }; - }; + subscription_item: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["usage_record"]; - }; - }; + 'application/json': components['schemas']['usage_record'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * @description Valid values are `increment` (default) or `set`. When using `increment` the specified `quantity` will be added to the usage at the specified timestamp. The `set` action will overwrite the usage quantity at that timestamp. If the subscription has [billing thresholds](https://stripe.com/docs/api/subscriptions/object#subscription_object-billing_thresholds), `increment` is the only allowed value. * @enum {string} */ - action?: "increment" | "set"; + action?: 'increment' | 'set' /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The usage quantity for the specified timestamp. */ - quantity: number; + quantity: number /** @description The timestamp for the usage event. This timestamp must be within the current billing period of the subscription of the provided `subscription_item`, and must not be in the future. When passing `"now"`, Stripe records usage for the current time. Default is `"now"` if a value is not provided. */ - timestamp?: Partial<"now"> & Partial; - }; - }; - }; - }; + timestamp?: Partial<'now'> & Partial + } + } + } + } /**

Retrieves the list of your subscription schedules.

*/ GetSubscriptionSchedules: { parameters: { query: { /** Only return subscription schedules that were created canceled the given date interval. */ canceled_at?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** Only return subscription schedules that completed during the given date interval. */ completed_at?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** Only return subscription schedules that were created during the given date interval. */ created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** Only return subscription schedules for the given customer. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Only return subscription schedules that were released during the given date interval. */ released_at?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** Only return subscription schedules that have not started yet. */ - scheduled?: boolean; + scheduled?: boolean /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["subscription_schedule"][]; + 'application/json': { + data: components['schemas']['subscription_schedule'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.

*/ PostSubscriptionSchedules: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription_schedule"]; - }; - }; + 'application/json': components['schemas']['subscription_schedule'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description The identifier of the customer to create the subscription schedule for. */ - customer?: string; + customer?: string /** * default_settings_params * @description Object representing the subscription schedule's default settings. */ default_settings?: { - application_fee_percent?: number; + application_fee_percent?: number /** automatic_tax_config */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** @enum {string} */ - billing_cycle_anchor?: "automatic" | "phase_start"; + billing_cycle_anchor?: 'automatic' | 'phase_start' billing_thresholds?: Partial<{ - amount_gte?: number; - reset_billing_cycle_anchor?: boolean; + amount_gte?: number + reset_billing_cycle_anchor?: boolean }> & - Partial<"">; + Partial<''> /** @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; - default_payment_method?: string; + collection_method?: 'charge_automatically' | 'send_invoice' + default_payment_method?: string /** subscription_schedules_param */ invoice_settings?: { - days_until_due?: number; - }; + days_until_due?: number + } transfer_data?: Partial<{ - amount_percent?: number; - destination: string; + amount_percent?: number + destination: string }> & - Partial<"">; - }; + Partial<''> + } /** * @description Configures how the subscription schedule behaves 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. * @enum {string} */ - end_behavior?: "cancel" | "none" | "release" | "renew"; + end_behavior?: 'cancel' | 'none' | 'release' | 'renew' /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls. */ - from_subscription?: string; + from_subscription?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. */ phases?: { add_invoice_items?: { - price?: string; + price?: string /** one_time_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; - application_fee_percent?: number; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] + application_fee_percent?: number /** automatic_tax_config */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** @enum {string} */ - billing_cycle_anchor?: "automatic" | "phase_start"; + billing_cycle_anchor?: 'automatic' | 'phase_start' billing_thresholds?: Partial<{ - amount_gte?: number; - reset_billing_cycle_anchor?: boolean; + amount_gte?: number + reset_billing_cycle_anchor?: boolean }> & - Partial<"">; + Partial<''> /** @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; - coupon?: string; - default_payment_method?: string; - default_tax_rates?: Partial & Partial<"">; + collection_method?: 'charge_automatically' | 'send_invoice' + coupon?: string + default_payment_method?: string + default_tax_rates?: Partial & Partial<''> /** Format: unix-time */ - end_date?: number; + end_date?: number /** subscription_schedules_param */ invoice_settings?: { - days_until_due?: number; - }; + days_until_due?: number + } items: { billing_thresholds?: Partial<{ - usage_gte: number; + usage_gte: number }> & - Partial<"">; - price?: string; + Partial<''> + price?: string /** recurring_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; - iterations?: number; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] + iterations?: number /** @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** transfer_data_specs */ transfer_data?: { - amount_percent?: number; - destination: string; - }; - trial?: boolean; + amount_percent?: number + destination: string + } + trial?: boolean /** Format: unix-time */ - trial_end?: number; - }[]; + trial_end?: number + }[] /** @description When the subscription schedule starts. We recommend using `now` so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on. */ - start_date?: Partial & Partial<"now">; - }; - }; - }; - }; + start_date?: Partial & Partial<'now'> + } + } + } + } /**

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.

*/ GetSubscriptionSchedulesSchedule: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - schedule: string; - }; - }; + schedule: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription_schedule"]; - }; - }; + 'application/json': components['schemas']['subscription_schedule'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates an existing subscription schedule.

*/ PostSubscriptionSchedulesSchedule: { parameters: { path: { - schedule: string; - }; - }; + schedule: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription_schedule"]; - }; - }; + 'application/json': components['schemas']['subscription_schedule'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * default_settings_params * @description Object representing the subscription schedule's default settings. */ default_settings?: { - application_fee_percent?: number; + application_fee_percent?: number /** automatic_tax_config */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** @enum {string} */ - billing_cycle_anchor?: "automatic" | "phase_start"; + billing_cycle_anchor?: 'automatic' | 'phase_start' billing_thresholds?: Partial<{ - amount_gte?: number; - reset_billing_cycle_anchor?: boolean; + amount_gte?: number + reset_billing_cycle_anchor?: boolean }> & - Partial<"">; + Partial<''> /** @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; - default_payment_method?: string; + collection_method?: 'charge_automatically' | 'send_invoice' + default_payment_method?: string /** subscription_schedules_param */ invoice_settings?: { - days_until_due?: number; - }; + days_until_due?: number + } transfer_data?: Partial<{ - amount_percent?: number; - destination: string; + amount_percent?: number + destination: string }> & - Partial<"">; - }; + Partial<''> + } /** * @description Configures how the subscription schedule behaves 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. * @enum {string} */ - end_behavior?: "cancel" | "none" | "release" | "renew"; + end_behavior?: 'cancel' | 'none' | 'release' | 'renew' /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. Note that past phases can be omitted. */ phases?: { add_invoice_items?: { - price?: string; + price?: string /** one_time_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; - application_fee_percent?: number; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] + application_fee_percent?: number /** automatic_tax_config */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** @enum {string} */ - billing_cycle_anchor?: "automatic" | "phase_start"; + billing_cycle_anchor?: 'automatic' | 'phase_start' billing_thresholds?: Partial<{ - amount_gte?: number; - reset_billing_cycle_anchor?: boolean; + amount_gte?: number + reset_billing_cycle_anchor?: boolean }> & - Partial<"">; + Partial<''> /** @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; - coupon?: string; - default_payment_method?: string; - default_tax_rates?: Partial & Partial<"">; - end_date?: Partial & Partial<"now">; + collection_method?: 'charge_automatically' | 'send_invoice' + coupon?: string + default_payment_method?: string + default_tax_rates?: Partial & Partial<''> + end_date?: Partial & Partial<'now'> /** subscription_schedules_param */ invoice_settings?: { - days_until_due?: number; - }; + days_until_due?: number + } items: { billing_thresholds?: Partial<{ - usage_gte: number; + usage_gte: number }> & - Partial<"">; - price?: string; + Partial<''> + price?: string /** recurring_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; - iterations?: number; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] + iterations?: number /** @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; - start_date?: Partial & Partial<"now">; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' + start_date?: Partial & Partial<'now'> /** transfer_data_specs */ transfer_data?: { - amount_percent?: number; - destination: string; - }; - trial?: boolean; - trial_end?: Partial & Partial<"now">; - }[]; + amount_percent?: number + destination: string + } + trial?: boolean + trial_end?: Partial & Partial<'now'> + }[] /** * @description If the update changes the current phase, indicates if the changes should be prorated. Possible values are `create_prorations` or `none`, and the default value is `create_prorations`. * @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; - }; - }; - }; - }; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' + } + } + } + } /**

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.

*/ PostSubscriptionSchedulesScheduleCancel: { parameters: { path: { - schedule: string; - }; - }; + schedule: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription_schedule"]; - }; - }; + 'application/json': components['schemas']['subscription_schedule'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Defaults to `true`. */ - invoice_now?: boolean; + invoice_now?: boolean /** @description If the subscription schedule is `active`, indicates if the cancellation should be prorated. Defaults to `true`. */ - prorate?: boolean; - }; - }; - }; - }; + prorate?: boolean + } + } + } + } /**

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.

*/ PostSubscriptionSchedulesScheduleRelease: { parameters: { path: { - schedule: string; - }; - }; + schedule: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription_schedule"]; - }; - }; + 'application/json': components['schemas']['subscription_schedule'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Keep any cancellation on the subscription that the schedule has set */ - preserve_cancel_date?: boolean; - }; - }; - }; - }; + preserve_cancel_date?: boolean + } + } + } + } /**

By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.

*/ GetSubscriptions: { parameters: { query: { /** The collection method of the subscriptions to retrieve. Either `charge_automatically` or `send_invoice`. */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial current_period_end?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial current_period_start?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** The ID of the customer whose subscriptions will be retrieved. */ - customer?: string; + customer?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** Filter for subscriptions that contain this recurring price ID. */ - price?: string; + price?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** 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?: - | "active" - | "all" - | "canceled" - | "ended" - | "incomplete" - | "incomplete_expired" - | "past_due" - | "trialing" - | "unpaid"; - }; - }; + status?: 'active' | 'all' | 'canceled' | 'ended' | 'incomplete' | 'incomplete_expired' | 'past_due' | 'trialing' | 'unpaid' + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["subscription"][]; + 'application/json': { + data: components['schemas']['subscription'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.

*/ PostSubscriptions: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription"]; - }; - }; + 'application/json': components['schemas']['subscription'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A list of prices and quantities that will generate invoice items appended to the first invoice for this subscription. You may pass up to 20 items. */ add_invoice_items?: { - price?: string; + price?: string /** one_time_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). */ - application_fee_percent?: number; + application_fee_percent?: number /** * automatic_tax_config * @description Automatic tax settings for this subscription. */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** * Format: unix-time * @description For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor. */ - backdate_start_date?: number; + backdate_start_date?: number /** * Format: unix-time * @description 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. */ - billing_cycle_anchor?: number; + billing_cycle_anchor?: number /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. */ billing_thresholds?: Partial<{ - amount_gte?: number; - reset_billing_cycle_anchor?: boolean; + amount_gte?: number + reset_billing_cycle_anchor?: boolean }> & - Partial<"">; + Partial<''> /** * Format: unix-time * @description 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. */ - cancel_at?: number; + cancel_at?: number /** @description Boolean indicating whether this subscription should cancel at the end of the current period. */ - cancel_at_period_end?: boolean; + cancel_at_period_end?: boolean /** * @description 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. Defaults to `charge_automatically`. * @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' /** @description The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. */ - coupon?: string; + coupon?: string /** @description The identifier of the customer to subscribe. */ - customer: string; + customer: string /** @description Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. */ - days_until_due?: number; + days_until_due?: number /** @description 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?: string; + default_payment_method?: string /** @description 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?: string; + default_source?: string /** @description 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?: Partial & Partial<"">; + default_tax_rates?: Partial & Partial<''> /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A list of up to 20 subscription items, each with an attached price. */ items?: { billing_thresholds?: Partial<{ - usage_gte: number; + usage_gte: number }> & - Partial<"">; - metadata?: { [key: string]: string }; - price?: string; + Partial<''> + metadata?: { [key: string]: string } + price?: string /** recurring_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. */ - off_session?: boolean; + off_session?: boolean /** * @description Use `allow_incomplete` to create subscriptions with `status=incomplete` if the first invoice cannot be paid. Creating subscriptions with this status allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * @@ -41496,11 +41221,7 @@ export interface operations { * `pending_if_incomplete` is only used with updates and cannot be passed when creating a subscription. * @enum {string} */ - payment_behavior?: - | "allow_incomplete" - | "default_incomplete" - | "error_if_incomplete" - | "pending_if_incomplete"; + payment_behavior?: 'allow_incomplete' | 'default_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete' /** * payment_settings * @description Payment settings to pass to invoices created by the subscription. @@ -41512,239 +41233,239 @@ export interface operations { /** mandate_options_param */ mandate_options?: { /** @enum {string} */ - transaction_type?: "business" | "personal"; - }; + transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; + verification_method?: 'automatic' | 'instant' | 'microdeposits' }> & - Partial<"">; + Partial<''> bancontact?: Partial<{ /** @enum {string} */ - preferred_language?: "de" | "en" | "fr" | "nl"; + preferred_language?: 'de' | 'en' | 'fr' | 'nl' }> & - Partial<"">; + Partial<''> card?: Partial<{ /** mandate_options_param */ mandate_options?: { - amount?: number; + amount?: number /** @enum {string} */ - amount_type?: "fixed" | "maximum"; - description?: string; - }; + amount_type?: 'fixed' | 'maximum' + description?: string + } /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: 'any' | 'automatic' }> & - Partial<"">; - }; + Partial<''> + } payment_method_types?: Partial< ( - | "ach_credit_transfer" - | "ach_debit" - | "acss_debit" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "sepa_debit" - | "sofort" - | "wechat_pay" + | 'ach_credit_transfer' + | 'ach_debit' + | 'acss_debit' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' )[] > & - Partial<"">; - }; + Partial<''> + } /** @description 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?: Partial<{ /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number }> & - Partial<"">; + Partial<''> /** @description The API ID of a promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. */ - promotion_code?: string; + promotion_code?: string /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) resulting from the `billing_cycle_anchor`. Valid values are `create_prorations` or `none`. * * Passing `create_prorations` will cause proration invoice items to be created when applicable. Prorations can be disabled by passing `none`. If no value is passed, the default is `create_prorations`. * @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** * transfer_data_specs * @description If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. */ transfer_data?: { - amount_percent?: number; - destination: string; - }; + amount_percent?: number + destination: string + } /** @description Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. */ - trial_end?: Partial<"now"> & Partial; + trial_end?: Partial<'now'> & Partial /** @description 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?: boolean; + trial_from_plan?: boolean /** @description Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. */ - trial_period_days?: number; - }; - }; - }; - }; + trial_period_days?: number + } + } + } + } /**

Retrieves the subscription with the given ID.

*/ GetSubscriptionsSubscriptionExposedId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - subscription_exposed_id: string; - }; - }; + subscription_exposed_id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription"]; - }; - }; + 'application/json': components['schemas']['subscription'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostSubscriptionsSubscriptionExposedId: { parameters: { path: { - subscription_exposed_id: string; - }; - }; + subscription_exposed_id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription"]; - }; - }; + 'application/json': components['schemas']['subscription'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A list of prices and quantities that will generate invoice items appended to the first invoice for this subscription. You may pass up to 20 items. */ add_invoice_items?: { - price?: string; + price?: string /** one_time_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). */ - application_fee_percent?: number; + application_fee_percent?: number /** * automatic_tax_config * @description Automatic tax settings for this subscription. */ automatic_tax?: { - enabled: boolean; - }; + enabled: boolean + } /** * @description Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). * @enum {string} */ - billing_cycle_anchor?: "now" | "unchanged"; + billing_cycle_anchor?: 'now' | 'unchanged' /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. */ billing_thresholds?: Partial<{ - amount_gte?: number; - reset_billing_cycle_anchor?: boolean; + amount_gte?: number + reset_billing_cycle_anchor?: boolean }> & - Partial<"">; + Partial<''> /** @description 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. */ - cancel_at?: Partial & Partial<"">; + cancel_at?: Partial & Partial<''> /** @description Boolean indicating whether this subscription should cancel at the end of the current period. */ - cancel_at_period_end?: boolean; + cancel_at_period_end?: boolean /** * @description 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. Defaults to `charge_automatically`. * @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; + collection_method?: 'charge_automatically' | 'send_invoice' /** @description The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. */ - coupon?: string; + coupon?: string /** @description Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. */ - days_until_due?: number; + days_until_due?: number /** @description 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?: string; + default_payment_method?: string /** @description 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?: string; + default_source?: string /** @description 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. Pass an empty string to remove previously-defined tax rates. */ - default_tax_rates?: Partial & Partial<"">; + default_tax_rates?: Partial & Partial<''> /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description A list of up to 20 subscription items, each with an attached price. */ items?: { billing_thresholds?: Partial<{ - usage_gte: number; + usage_gte: number }> & - Partial<"">; - clear_usage?: boolean; - deleted?: boolean; - id?: string; - metadata?: Partial<{ [key: string]: string }> & Partial<"">; - price?: string; + Partial<''> + clear_usage?: boolean + deleted?: boolean + id?: string + metadata?: Partial<{ [key: string]: string }> & Partial<''> + price?: string /** recurring_price_data */ price_data?: { - currency: string; - product: string; + currency: string + product: string /** recurring_adhoc */ recurring: { /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - }; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number + } /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; + tax_behavior?: 'exclusive' | 'inclusive' | 'unspecified' + unit_amount?: number /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: Partial & Partial<"">; - }[]; + unit_amount_decimal?: string + } + quantity?: number + tax_rates?: Partial & Partial<''> + }[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. */ - off_session?: boolean; + off_session?: boolean /** @description If specified, payment collection for this subscription will be paused. */ pause_collection?: Partial<{ /** @enum {string} */ - behavior: "keep_as_draft" | "mark_uncollectible" | "void"; + behavior: 'keep_as_draft' | 'mark_uncollectible' | 'void' /** Format: unix-time */ - resumes_at?: number; + resumes_at?: number }> & - Partial<"">; + Partial<''> /** * @description Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * @@ -41755,11 +41476,7 @@ export interface operations { * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. * @enum {string} */ - payment_behavior?: - | "allow_incomplete" - | "default_incomplete" - | "error_if_incomplete" - | "pending_if_incomplete"; + payment_behavior?: 'allow_incomplete' | 'default_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete' /** * payment_settings * @description Payment settings to pass to invoices created by the subscription. @@ -41771,60 +41488,60 @@ export interface operations { /** mandate_options_param */ mandate_options?: { /** @enum {string} */ - transaction_type?: "business" | "personal"; - }; + transaction_type?: 'business' | 'personal' + } /** @enum {string} */ - verification_method?: "automatic" | "instant" | "microdeposits"; + verification_method?: 'automatic' | 'instant' | 'microdeposits' }> & - Partial<"">; + Partial<''> bancontact?: Partial<{ /** @enum {string} */ - preferred_language?: "de" | "en" | "fr" | "nl"; + preferred_language?: 'de' | 'en' | 'fr' | 'nl' }> & - Partial<"">; + Partial<''> card?: Partial<{ /** mandate_options_param */ mandate_options?: { - amount?: number; + amount?: number /** @enum {string} */ - amount_type?: "fixed" | "maximum"; - description?: string; - }; + amount_type?: 'fixed' | 'maximum' + description?: string + } /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: 'any' | 'automatic' }> & - Partial<"">; - }; + Partial<''> + } payment_method_types?: Partial< ( - | "ach_credit_transfer" - | "ach_debit" - | "acss_debit" - | "au_becs_debit" - | "bacs_debit" - | "bancontact" - | "boleto" - | "card" - | "fpx" - | "giropay" - | "grabpay" - | "ideal" - | "sepa_debit" - | "sofort" - | "wechat_pay" + | 'ach_credit_transfer' + | 'ach_debit' + | 'acss_debit' + | 'au_becs_debit' + | 'bacs_debit' + | 'bancontact' + | 'boleto' + | 'card' + | 'fpx' + | 'giropay' + | 'grabpay' + | 'ideal' + | 'sepa_debit' + | 'sofort' + | 'wechat_pay' )[] > & - Partial<"">; - }; + Partial<''> + } /** @description 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?: Partial<{ /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; + interval: 'day' | 'month' | 'week' | 'year' + interval_count?: number }> & - Partial<"">; + Partial<''> /** @description The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. */ - promotion_code?: string; + promotion_code?: string /** * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. * @@ -41833,26 +41550,26 @@ export interface operations { * Prorations can be disabled by passing `none`. * @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; + proration_behavior?: 'always_invoice' | 'create_prorations' | 'none' /** * Format: unix-time * @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations. */ - proration_date?: number; + proration_date?: number /** @description If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. This will be unset if you POST an empty value. */ transfer_data?: Partial<{ - amount_percent?: number; - destination: string; + amount_percent?: number + destination: string }> & - Partial<"">; + Partial<''> /** @description Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. */ - trial_end?: Partial<"now"> & Partial; + trial_end?: Partial<'now'> & Partial /** @description 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?: boolean; - }; - }; - }; - }; + trial_from_plan?: boolean + } + } + } + } /** *

Cancels a customer’s subscription immediately. The customer will not be charged again for the subscription.

* @@ -41863,396 +41580,396 @@ export interface operations { DeleteSubscriptionsSubscriptionExposedId: { parameters: { path: { - subscription_exposed_id: string; - }; - }; + subscription_exposed_id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["subscription"]; - }; - }; + 'application/json': components['schemas']['subscription'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items. */ - invoice_now?: boolean; + invoice_now?: boolean /** @description Will generate a proration invoice item that credits remaining unused time until the subscription period end. */ - prorate?: boolean; - }; - }; - }; - }; + prorate?: boolean + } + } + } + } /**

Removes the currently applied discount on a subscription.

*/ DeleteSubscriptionsSubscriptionExposedIdDiscount: { parameters: { path: { - subscription_exposed_id: string; - }; - }; + subscription_exposed_id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_discount"]; - }; - }; + 'application/json': components['schemas']['deleted_discount'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

A list of all tax codes available to add to Products in order to allow specific tax calculations.

*/ GetTaxCodes: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["tax_code"][]; + 'application/json': { + data: components['schemas']['tax_code'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Retrieves the details of an existing tax code. Supply the unique tax code ID and Stripe will return the corresponding tax code information.

*/ GetTaxCodesId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["tax_code"]; - }; - }; + 'application/json': components['schemas']['tax_code'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of your tax rates. Tax rates are returned sorted by creation date, with the most recently created tax rates appearing first.

*/ GetTaxRates: { parameters: { query: { /** Optional flag to filter by tax rates that are either active or inactive (archived). */ - active?: boolean; + active?: boolean /** Optional range for filtering created date. */ created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** Optional flag to filter by tax rates that are inclusive (or those that are not inclusive). */ - inclusive?: boolean; + inclusive?: boolean /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["tax_rate"][]; + 'application/json': { + data: components['schemas']['tax_rate'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new tax rate.

*/ PostTaxRates: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["tax_rate"]; - }; - }; + 'application/json': components['schemas']['tax_rate'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Flag determining whether the tax rate is active or inactive (archived). Inactive tax rates cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set. */ - active?: boolean; + active?: boolean /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ - country?: string; + country?: string /** @description An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. */ - description?: string; + description?: string /** @description The display name of the tax rate, which will be shown to users. */ - display_name: string; + display_name: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description This specifies if the tax rate is inclusive or exclusive. */ - inclusive: boolean; + inclusive: boolean /** @description 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?: string; + jurisdiction?: string /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description This represents the tax rate percent out of 100. */ - percentage: number; + percentage: number /** @description [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States. */ - state?: string; + state?: string /** * @description The high-level tax type, such as `vat` or `sales_tax`. * @enum {string} */ - tax_type?: "gst" | "hst" | "jct" | "pst" | "qst" | "rst" | "sales_tax" | "vat"; - }; - }; - }; - }; + tax_type?: 'gst' | 'hst' | 'jct' | 'pst' | 'qst' | 'rst' | 'sales_tax' | 'vat' + } + } + } + } /**

Retrieves a tax rate with the given ID

*/ GetTaxRatesTaxRate: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - tax_rate: string; - }; - }; + tax_rate: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["tax_rate"]; - }; - }; + 'application/json': components['schemas']['tax_rate'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates an existing tax rate.

*/ PostTaxRatesTaxRate: { parameters: { path: { - tax_rate: string; - }; - }; + tax_rate: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["tax_rate"]; - }; - }; + 'application/json': components['schemas']['tax_rate'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Flag determining whether the tax rate is active or inactive (archived). Inactive tax rates cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set. */ - active?: boolean; + active?: boolean /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ - country?: string; + country?: string /** @description An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. */ - description?: string; + description?: string /** @description The display name of the tax rate, which will be shown to users. */ - display_name?: string; + display_name?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: string; + jurisdiction?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States. */ - state?: string; + state?: string /** * @description The high-level tax type, such as `vat` or `sales_tax`. * @enum {string} */ - tax_type?: "gst" | "hst" | "jct" | "pst" | "qst" | "rst" | "sales_tax" | "vat"; - }; - }; - }; - }; + tax_type?: 'gst' | 'hst' | 'jct' | 'pst' | 'qst' | 'rst' | 'sales_tax' | 'vat' + } + } + } + } /**

To connect to a reader the Stripe Terminal SDK needs to retrieve a short-lived connection token from Stripe, proxied through your server. On your backend, add an endpoint that creates and returns a connection token.

*/ PostTerminalConnectionTokens: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["terminal.connection_token"]; - }; - }; + 'application/json': components['schemas']['terminal.connection_token'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The id of the location that this connection token is scoped to. If specified the connection token will only be usable with readers assigned to that location, otherwise the connection token will be usable with all readers. Note that location scoping only applies to internet-connected readers. For more details, see [the docs on scoping connection tokens](https://stripe.com/docs/terminal/fleet/locations#connection-tokens). */ - location?: string; - }; - }; - }; - }; + location?: string + } + } + } + } /**

Returns a list of Location objects.

*/ GetTerminalLocations: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["terminal.location"][]; + 'application/json': { + data: components['schemas']['terminal.location'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Creates a new Location object. * For further details, including which address fields are required in each country, see the Manage locations guide.

@@ -42262,324 +41979,322 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["terminal.location"]; - }; - }; + 'application/json': components['schemas']['terminal.location'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * create_location_address_param * @description The full address of the location. */ address: { - city?: string; - country: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** @description A name for the location. */ - display_name: string; + display_name: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Retrieves a Location object.

*/ GetTerminalLocationsLocation: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - location: string; - }; - }; + location: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["terminal.location"]; - }; - }; + 'application/json': components['schemas']['terminal.location'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates a Location object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ PostTerminalLocationsLocation: { parameters: { path: { - location: string; - }; - }; + location: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["terminal.location"]; - }; - }; + 'application/json': components['schemas']['terminal.location'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * optional_fields_address * @description The full address of the location. */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** @description A name for the location. */ - display_name?: string; + display_name?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Deletes a Location object.

*/ DeleteTerminalLocationsLocation: { parameters: { path: { - location: string; - }; - }; + location: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_terminal.location"]; - }; - }; + 'application/json': components['schemas']['deleted_terminal.location'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of Reader objects.

*/ GetTerminalReaders: { parameters: { query: { /** Filters readers by device type */ - device_type?: "bbpos_chipper2x" | "bbpos_wisepos_e" | "verifone_P400"; + device_type?: 'bbpos_chipper2x' | 'bbpos_wisepos_e' | 'verifone_P400' /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A location ID to filter the response list to only readers at the specific location */ - location?: string; + location?: string /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** A status filter to filter readers to only offline or online readers */ - status?: "offline" | "online"; - }; - }; + status?: 'offline' | 'online' + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description A list of readers */ - data: components["schemas"]["terminal.reader"][]; + data: components['schemas']['terminal.reader'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Creates a new Reader object.

*/ PostTerminalReaders: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["terminal.reader"]; - }; - }; + 'application/json': components['schemas']['terminal.reader'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description Custom label given to the reader for easier identification. If no label is specified, the registration code will be used. */ - label?: string; + label?: string /** @description The location to assign the reader to. */ - location?: string; + location?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description A code generated by the reader used for registering to an account. */ - registration_code: string; - }; - }; - }; - }; + registration_code: string + } + } + } + } /**

Retrieves a Reader object.

*/ GetTerminalReadersReader: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - reader: string; - }; - }; + reader: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": Partial & - Partial; - }; - }; + 'application/json': Partial & Partial + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ PostTerminalReadersReader: { parameters: { path: { - reader: string; - }; - }; + reader: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": Partial & - Partial; - }; - }; + 'application/json': Partial & Partial + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description The new label of the reader. */ - label?: string; + label?: string /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Deletes a Reader object.

*/ DeleteTerminalReadersReader: { parameters: { path: { - reader: string; - }; - }; + reader: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_terminal.reader"]; - }; - }; + 'application/json': components['schemas']['deleted_terminal.reader'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Creates a single-use token that represents a bank account’s details. * This token can be used with any API method in place of a bank account dictionary. This token can be used only once, by attaching it to a Custom account.

@@ -42589,218 +42304,218 @@ export interface operations { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["token"]; - }; - }; + 'application/json': components['schemas']['token'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * connect_js_account_token_specs * @description Information for the account this token will represent. */ account?: { /** @enum {string} */ - business_type?: "company" | "government_entity" | "individual" | "non_profit"; + business_type?: 'company' | 'government_entity' | 'individual' | 'non_profit' /** connect_js_account_token_company_specs */ company?: { /** address_specs */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** japan_address_kana_specs */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** japan_address_kanji_specs */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; - directors_provided?: boolean; - executives_provided?: boolean; - name?: string; - name_kana?: string; - name_kanji?: string; - owners_provided?: boolean; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } + directors_provided?: boolean + executives_provided?: boolean + name?: string + name_kana?: string + name_kanji?: string + owners_provided?: boolean /** company_ownership_declaration */ ownership_declaration?: { /** Format: unix-time */ - date?: number; - ip?: string; - user_agent?: string; - }; - ownership_declaration_shown_and_signed?: boolean; - phone?: string; - registration_number?: string; + date?: number + ip?: string + user_agent?: string + } + ownership_declaration_shown_and_signed?: boolean + phone?: string + registration_number?: string /** @enum {string} */ structure?: - | "" - | "free_zone_establishment" - | "free_zone_llc" - | "government_instrumentality" - | "governmental_unit" - | "incorporated_non_profit" - | "limited_liability_partnership" - | "llc" - | "multi_member_llc" - | "private_company" - | "private_corporation" - | "private_partnership" - | "public_company" - | "public_corporation" - | "public_partnership" - | "single_member_llc" - | "sole_establishment" - | "sole_proprietorship" - | "tax_exempt_government_instrumentality" - | "unincorporated_association" - | "unincorporated_non_profit"; - tax_id?: string; - tax_id_registrar?: string; - vat_id?: string; + | '' + | 'free_zone_establishment' + | 'free_zone_llc' + | 'government_instrumentality' + | 'governmental_unit' + | 'incorporated_non_profit' + | 'limited_liability_partnership' + | 'llc' + | 'multi_member_llc' + | 'private_company' + | 'private_corporation' + | 'private_partnership' + | 'public_company' + | 'public_corporation' + | 'public_partnership' + | 'single_member_llc' + | 'sole_establishment' + | 'sole_proprietorship' + | 'tax_exempt_government_instrumentality' + | 'unincorporated_association' + | 'unincorporated_non_profit' + tax_id?: string + tax_id_registrar?: string + vat_id?: string /** verification_specs */ verification?: { /** verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; + back?: string + front?: string + } + } + } /** individual_specs */ individual?: { /** address_specs */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** japan_address_kana_specs */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** japan_address_kanji_specs */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } dob?: Partial<{ - day: number; - month: number; - year: number; + day: number + month: number + year: number }> & - Partial<"">; - email?: string; - first_name?: string; - first_name_kana?: string; - first_name_kanji?: string; - full_name_aliases?: Partial & Partial<"">; - gender?: string; - id_number?: string; - last_name?: string; - last_name_kana?: string; - last_name_kanji?: string; - maiden_name?: string; - metadata?: Partial<{ [key: string]: string }> & Partial<"">; - phone?: string; + Partial<''> + email?: string + first_name?: string + first_name_kana?: string + first_name_kanji?: string + full_name_aliases?: Partial & Partial<''> + gender?: string + id_number?: string + last_name?: string + last_name_kana?: string + last_name_kanji?: string + maiden_name?: string + metadata?: Partial<{ [key: string]: string }> & Partial<''> + phone?: string /** @enum {string} */ - political_exposure?: "existing" | "none"; - ssn_last_4?: string; + political_exposure?: 'existing' | 'none' + ssn_last_4?: string /** person_verification_specs */ verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; - tos_shown_and_accepted?: boolean; - }; + back?: string + front?: string + } + } + } + tos_shown_and_accepted?: boolean + } /** * token_create_bank_account * @description The bank account this token will represent. */ bank_account?: { - account_holder_name?: string; + account_holder_name?: string /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; + account_holder_type?: 'company' | 'individual' + account_number: string /** @enum {string} */ - account_type?: "checking" | "futsu" | "savings" | "toza"; - country: string; - currency?: string; - routing_number?: string; - }; + account_type?: 'checking' | 'futsu' | 'savings' | 'toza' + country: string + currency?: string + routing_number?: string + } card?: Partial<{ - address_city?: string; - address_country?: string; - address_line1?: string; - address_line2?: string; - address_state?: string; - address_zip?: string; - currency?: string; - cvc?: string; - exp_month: string; - exp_year: string; - name?: string; - number: string; + address_city?: string + address_country?: string + address_line1?: string + address_line2?: string + address_state?: string + address_zip?: string + currency?: string + cvc?: string + exp_month: string + exp_year: string + name?: string + number: string }> & - Partial; + Partial /** @description The customer (owned by the application's account) for which to create a token. This can be used only with an [OAuth access token](https://stripe.com/docs/connect/standard-accounts) or [Stripe-Account header](https://stripe.com/docs/connect/authentication). For more details, see [Cloning Saved Payment Methods](https://stripe.com/docs/connect/cloning-saved-payment-methods). */ - customer?: string; + customer?: string /** * cvc_params * @description The updated CVC value this token will represent. */ cvc_update?: { - cvc: string; - }; + cvc: string + } /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** * person_token_specs * @description Information for the person this token will represent. @@ -42808,482 +42523,482 @@ export interface operations { person?: { /** address_specs */ address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + } /** japan_address_kana_specs */ address_kana?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } /** japan_address_kanji_specs */ address_kanji?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - town?: string; - }; + city?: string + country?: string + line1?: string + line2?: string + postal_code?: string + state?: string + town?: string + } dob?: Partial<{ - day: number; - month: number; - year: number; + day: number + month: number + year: number }> & - Partial<"">; + Partial<''> /** person_documents_specs */ documents?: { /** documents_param */ company_authorization?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ passport?: { - files?: string[]; - }; + files?: string[] + } /** documents_param */ visa?: { - files?: string[]; - }; - }; - email?: string; - first_name?: string; - first_name_kana?: string; - first_name_kanji?: string; - full_name_aliases?: Partial & Partial<"">; - gender?: string; - id_number?: string; - last_name?: string; - last_name_kana?: string; - last_name_kanji?: string; - maiden_name?: string; - metadata?: Partial<{ [key: string]: string }> & Partial<"">; - nationality?: string; - phone?: string; - political_exposure?: string; + files?: string[] + } + } + email?: string + first_name?: string + first_name_kana?: string + first_name_kanji?: string + full_name_aliases?: Partial & Partial<''> + gender?: string + id_number?: string + last_name?: string + last_name_kana?: string + last_name_kanji?: string + maiden_name?: string + metadata?: Partial<{ [key: string]: string }> & Partial<''> + nationality?: string + phone?: string + political_exposure?: string /** relationship_specs */ relationship?: { - director?: boolean; - executive?: boolean; - owner?: boolean; - percent_ownership?: Partial & Partial<"">; - representative?: boolean; - title?: string; - }; - ssn_last_4?: string; + director?: boolean + executive?: boolean + owner?: boolean + percent_ownership?: Partial & Partial<''> + representative?: boolean + title?: string + } + ssn_last_4?: string /** person_verification_specs */ verification?: { /** person_verification_document_specs */ additional_document?: { - back?: string; - front?: string; - }; + back?: string + front?: string + } /** person_verification_document_specs */ document?: { - back?: string; - front?: string; - }; - }; - }; + back?: string + front?: string + } + } + } /** * pii_token_specs * @description The PII this token will represent. */ pii?: { - id_number?: string; - }; - }; - }; - }; - }; + id_number?: string + } + } + } + } + } /**

Retrieves the token with the given ID.

*/ GetTokensToken: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - token: string; - }; - }; + token: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["token"]; - }; - }; + 'application/json': components['schemas']['token'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Returns a list of top-ups.

*/ GetTopups: { parameters: { query: { /** A positive integer representing how much to transfer. */ amount?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** 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?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return top-ups that have the given status. One of `canceled`, `failed`, `pending` or `succeeded`. */ - status?: "canceled" | "failed" | "pending" | "succeeded"; - }; - }; + status?: 'canceled' | 'failed' | 'pending' | 'succeeded' + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["topup"][]; + 'application/json': { + data: components['schemas']['topup'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Top up the balance of an account

*/ PostTopups: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["topup"]; - }; - }; + 'application/json': components['schemas']['topup'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A positive integer representing how much to transfer. */ - amount: number; + amount: number /** @description 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: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The ID of a source to transfer funds from. For most users, this should be left unspecified which will use the bank account that was set up in the dashboard for the specified currency. In test mode, this can be a test bank token (see [Testing Top-ups](https://stripe.com/docs/connect/testing#testing-top-ups)). */ - source?: string; + source?: string /** @description Extra information about a top-up for the source's bank statement. Limited to 15 ASCII characters. */ - statement_descriptor?: string; + statement_descriptor?: string /** @description A string that identifies this top-up as part of a group. */ - transfer_group?: string; - }; - }; - }; - }; + transfer_group?: string + } + } + } + } /**

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.

*/ GetTopupsTopup: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - topup: string; - }; - }; + topup: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["topup"]; - }; - }; + 'application/json': components['schemas']['topup'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates the metadata of a top-up. Other top-up details are not editable by design.

*/ PostTopupsTopup: { parameters: { path: { - topup: string; - }; - }; + topup: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["topup"]; - }; - }; + 'application/json': components['schemas']['topup'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Cancels a top-up. Only pending top-ups can be canceled.

*/ PostTopupsTopupCancel: { parameters: { path: { - topup: string; - }; - }; + topup: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["topup"]; - }; - }; + 'application/json': components['schemas']['topup'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - }; - }; - }; + expand?: string[] + } + } + } + } /**

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.

*/ GetTransfers: { parameters: { query: { created?: Partial<{ - gt?: number; - gte?: number; - lt?: number; - lte?: number; + gt?: number + gte?: number + lt?: number + lte?: number }> & - Partial; + Partial /** Only return transfers for the destination specified by this account ID. */ - destination?: string; + destination?: 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. */ - ending_before?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + starting_after?: string /** Only return transfers with the specified transfer group. */ - transfer_group?: string; - }; - }; + transfer_group?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["transfer"][]; + data: components['schemas']['transfer'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostTransfers: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["transfer"]; - }; - }; + 'application/json': components['schemas']['transfer'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A positive integer in %s representing how much to transfer. */ - amount?: number; + amount?: number /** @description 3-letter [ISO code for currency](https://stripe.com/docs/payouts). */ - currency: string; + currency: string /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description The ID of a connected Stripe account. See the Connect documentation for details. */ - destination: string; + destination: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: { [key: string]: string }; + metadata?: { [key: string]: string } /** @description You can use this parameter to transfer funds from a charge before they are added to your available balance. A pending balance will transfer immediately but the funds will not become available until the original charge becomes available. [See the Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-availability) for details. */ - source_transaction?: string; + source_transaction?: string /** * @description The source balance to use for this transfer. One of `bank_account`, `card`, or `fpx`. For most users, this will default to `card`. * @enum {string} */ - source_type?: "bank_account" | "card" | "fpx"; + source_type?: 'bank_account' | 'card' | 'fpx' /** @description A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-options) for details. */ - transfer_group?: string; - }; - }; - }; - }; + transfer_group?: string + } + } + } + } /**

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.

*/ GetTransfersIdReversals: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; + starting_after?: string + } path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { + 'application/json': { /** @description Details about each object. */ - data: components["schemas"]["transfer_reversal"][]; + data: components['schemas']['transfer_reversal'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

When you create a new reversal, you must specify a transfer to create it on.

* @@ -43294,71 +43009,71 @@ export interface operations { PostTransfersIdReversals: { parameters: { path: { - id: string; - }; - }; + id: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["transfer_reversal"]; - }; - }; + 'application/json': components['schemas']['transfer_reversal'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description A positive integer in %s representing how much of this transfer to reverse. Can only reverse up to the unreversed amount remaining of the transfer. Partial transfer reversals are only allowed for transfers to Stripe Accounts. Defaults to the entire transfer amount. */ - amount?: number; + amount?: number /** @description An arbitrary string which you can attach to a reversal object. It is displayed alongside the reversal in the Dashboard. This will be unset if you POST an empty value. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description Boolean indicating whether the application fee should be refunded when reversing this transfer. If a full transfer reversal is given, the full application fee will be refunded. Otherwise, the application fee will be refunded with an amount proportional to the amount of the transfer reversed. */ - refund_application_fee?: boolean; - }; - }; - }; - }; + refund_application_fee?: boolean + } + } + } + } /**

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.

*/ GetTransfersTransfer: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - transfer: string; - }; - }; + transfer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["transfer"]; - }; - }; + 'application/json': components['schemas']['transfer'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates the specified transfer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

* @@ -43367,68 +43082,68 @@ export interface operations { PostTransfersTransfer: { parameters: { path: { - transfer: string; - }; - }; + transfer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["transfer"]; - }; - }; + 'application/json': components['schemas']['transfer'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ - description?: string; + description?: string /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

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.

*/ GetTransfersTransferReversalsId: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - id: string; - transfer: string; - }; - }; + id: string + transfer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["transfer_reversal"]; - }; - }; + 'application/json': components['schemas']['transfer_reversal'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /** *

Updates the specified reversal by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

* @@ -43437,676 +43152,676 @@ export interface operations { PostTransfersTransferReversalsId: { parameters: { path: { - id: string; - transfer: string; - }; - }; + id: string + transfer: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["transfer_reversal"]; - }; - }; + 'application/json': components['schemas']['transfer_reversal'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; - }; - }; - }; - }; + metadata?: Partial<{ [key: string]: string }> & Partial<''> + } + } + } + } /**

Returns a list of your webhook endpoints.

*/ GetWebhookEndpoints: { parameters: { query: { /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; + ending_before?: string /** Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; + limit?: number /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 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?: string; - }; - }; + starting_after?: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": { - data: components["schemas"]["webhook_endpoint"][]; + 'application/json': { + data: components['schemas']['webhook_endpoint'][] /** @description True if this list has another page of items after this one that can be fetched. */ - has_more: boolean; + has_more: boolean /** * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. * @enum {string} */ - object: "list"; + object: 'list' /** @description The URL where this list can be accessed. */ - url: string; - }; - }; - }; + url: string + } + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

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.

*/ PostWebhookEndpoints: { responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["webhook_endpoint"]; - }; - }; + 'application/json': components['schemas']['webhook_endpoint'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** * @description Events sent to this endpoint will be generated with this Stripe Version instead of your account's default Stripe Version. * @enum {string} */ api_version?: - | "2011-01-01" - | "2011-06-21" - | "2011-06-28" - | "2011-08-01" - | "2011-09-15" - | "2011-11-17" - | "2012-02-23" - | "2012-03-25" - | "2012-06-18" - | "2012-06-28" - | "2012-07-09" - | "2012-09-24" - | "2012-10-26" - | "2012-11-07" - | "2013-02-11" - | "2013-02-13" - | "2013-07-05" - | "2013-08-12" - | "2013-08-13" - | "2013-10-29" - | "2013-12-03" - | "2014-01-31" - | "2014-03-13" - | "2014-03-28" - | "2014-05-19" - | "2014-06-13" - | "2014-06-17" - | "2014-07-22" - | "2014-07-26" - | "2014-08-04" - | "2014-08-20" - | "2014-09-08" - | "2014-10-07" - | "2014-11-05" - | "2014-11-20" - | "2014-12-08" - | "2014-12-17" - | "2014-12-22" - | "2015-01-11" - | "2015-01-26" - | "2015-02-10" - | "2015-02-16" - | "2015-02-18" - | "2015-03-24" - | "2015-04-07" - | "2015-06-15" - | "2015-07-07" - | "2015-07-13" - | "2015-07-28" - | "2015-08-07" - | "2015-08-19" - | "2015-09-03" - | "2015-09-08" - | "2015-09-23" - | "2015-10-01" - | "2015-10-12" - | "2015-10-16" - | "2016-02-03" - | "2016-02-19" - | "2016-02-22" - | "2016-02-23" - | "2016-02-29" - | "2016-03-07" - | "2016-06-15" - | "2016-07-06" - | "2016-10-19" - | "2017-01-27" - | "2017-02-14" - | "2017-04-06" - | "2017-05-25" - | "2017-06-05" - | "2017-08-15" - | "2017-12-14" - | "2018-01-23" - | "2018-02-05" - | "2018-02-06" - | "2018-02-28" - | "2018-05-21" - | "2018-07-27" - | "2018-08-23" - | "2018-09-06" - | "2018-09-24" - | "2018-10-31" - | "2018-11-08" - | "2019-02-11" - | "2019-02-19" - | "2019-03-14" - | "2019-05-16" - | "2019-08-14" - | "2019-09-09" - | "2019-10-08" - | "2019-10-17" - | "2019-11-05" - | "2019-12-03" - | "2020-03-02" - | "2020-08-27"; + | '2011-01-01' + | '2011-06-21' + | '2011-06-28' + | '2011-08-01' + | '2011-09-15' + | '2011-11-17' + | '2012-02-23' + | '2012-03-25' + | '2012-06-18' + | '2012-06-28' + | '2012-07-09' + | '2012-09-24' + | '2012-10-26' + | '2012-11-07' + | '2013-02-11' + | '2013-02-13' + | '2013-07-05' + | '2013-08-12' + | '2013-08-13' + | '2013-10-29' + | '2013-12-03' + | '2014-01-31' + | '2014-03-13' + | '2014-03-28' + | '2014-05-19' + | '2014-06-13' + | '2014-06-17' + | '2014-07-22' + | '2014-07-26' + | '2014-08-04' + | '2014-08-20' + | '2014-09-08' + | '2014-10-07' + | '2014-11-05' + | '2014-11-20' + | '2014-12-08' + | '2014-12-17' + | '2014-12-22' + | '2015-01-11' + | '2015-01-26' + | '2015-02-10' + | '2015-02-16' + | '2015-02-18' + | '2015-03-24' + | '2015-04-07' + | '2015-06-15' + | '2015-07-07' + | '2015-07-13' + | '2015-07-28' + | '2015-08-07' + | '2015-08-19' + | '2015-09-03' + | '2015-09-08' + | '2015-09-23' + | '2015-10-01' + | '2015-10-12' + | '2015-10-16' + | '2016-02-03' + | '2016-02-19' + | '2016-02-22' + | '2016-02-23' + | '2016-02-29' + | '2016-03-07' + | '2016-06-15' + | '2016-07-06' + | '2016-10-19' + | '2017-01-27' + | '2017-02-14' + | '2017-04-06' + | '2017-05-25' + | '2017-06-05' + | '2017-08-15' + | '2017-12-14' + | '2018-01-23' + | '2018-02-05' + | '2018-02-06' + | '2018-02-28' + | '2018-05-21' + | '2018-07-27' + | '2018-08-23' + | '2018-09-06' + | '2018-09-24' + | '2018-10-31' + | '2018-11-08' + | '2019-02-11' + | '2019-02-19' + | '2019-03-14' + | '2019-05-16' + | '2019-08-14' + | '2019-09-09' + | '2019-10-08' + | '2019-10-17' + | '2019-11-05' + | '2019-12-03' + | '2020-03-02' + | '2020-08-27' /** @description Whether this endpoint should receive events from connected accounts (`true`), or from your account (`false`). Defaults to `false`. */ - connect?: boolean; + connect?: boolean /** @description An optional description of what the webhook is used for. */ - description?: string; + description?: string /** @description The list of events to enable for this endpoint. You may specify `['*']` to enable all events, except those that require explicit selection. */ enabled_events: ( - | "*" - | "account.application.authorized" - | "account.application.deauthorized" - | "account.external_account.created" - | "account.external_account.deleted" - | "account.external_account.updated" - | "account.updated" - | "application_fee.created" - | "application_fee.refund.updated" - | "application_fee.refunded" - | "balance.available" - | "billing_portal.configuration.created" - | "billing_portal.configuration.updated" - | "capability.updated" - | "charge.captured" - | "charge.dispute.closed" - | "charge.dispute.created" - | "charge.dispute.funds_reinstated" - | "charge.dispute.funds_withdrawn" - | "charge.dispute.updated" - | "charge.expired" - | "charge.failed" - | "charge.pending" - | "charge.refund.updated" - | "charge.refunded" - | "charge.succeeded" - | "charge.updated" - | "checkout.session.async_payment_failed" - | "checkout.session.async_payment_succeeded" - | "checkout.session.completed" - | "checkout.session.expired" - | "coupon.created" - | "coupon.deleted" - | "coupon.updated" - | "credit_note.created" - | "credit_note.updated" - | "credit_note.voided" - | "customer.created" - | "customer.deleted" - | "customer.discount.created" - | "customer.discount.deleted" - | "customer.discount.updated" - | "customer.source.created" - | "customer.source.deleted" - | "customer.source.expiring" - | "customer.source.updated" - | "customer.subscription.created" - | "customer.subscription.deleted" - | "customer.subscription.pending_update_applied" - | "customer.subscription.pending_update_expired" - | "customer.subscription.trial_will_end" - | "customer.subscription.updated" - | "customer.tax_id.created" - | "customer.tax_id.deleted" - | "customer.tax_id.updated" - | "customer.updated" - | "file.created" - | "identity.verification_session.canceled" - | "identity.verification_session.created" - | "identity.verification_session.processing" - | "identity.verification_session.redacted" - | "identity.verification_session.requires_input" - | "identity.verification_session.verified" - | "invoice.created" - | "invoice.deleted" - | "invoice.finalization_failed" - | "invoice.finalized" - | "invoice.marked_uncollectible" - | "invoice.paid" - | "invoice.payment_action_required" - | "invoice.payment_failed" - | "invoice.payment_succeeded" - | "invoice.sent" - | "invoice.upcoming" - | "invoice.updated" - | "invoice.voided" - | "invoiceitem.created" - | "invoiceitem.deleted" - | "invoiceitem.updated" - | "issuing_authorization.created" - | "issuing_authorization.request" - | "issuing_authorization.updated" - | "issuing_card.created" - | "issuing_card.updated" - | "issuing_cardholder.created" - | "issuing_cardholder.updated" - | "issuing_dispute.closed" - | "issuing_dispute.created" - | "issuing_dispute.funds_reinstated" - | "issuing_dispute.submitted" - | "issuing_dispute.updated" - | "issuing_transaction.created" - | "issuing_transaction.updated" - | "mandate.updated" - | "order.created" - | "order.payment_failed" - | "order.payment_succeeded" - | "order.updated" - | "order_return.created" - | "payment_intent.amount_capturable_updated" - | "payment_intent.canceled" - | "payment_intent.created" - | "payment_intent.payment_failed" - | "payment_intent.processing" - | "payment_intent.requires_action" - | "payment_intent.succeeded" - | "payment_link.created" - | "payment_link.updated" - | "payment_method.attached" - | "payment_method.automatically_updated" - | "payment_method.detached" - | "payment_method.updated" - | "payout.canceled" - | "payout.created" - | "payout.failed" - | "payout.paid" - | "payout.updated" - | "person.created" - | "person.deleted" - | "person.updated" - | "plan.created" - | "plan.deleted" - | "plan.updated" - | "price.created" - | "price.deleted" - | "price.updated" - | "product.created" - | "product.deleted" - | "product.updated" - | "promotion_code.created" - | "promotion_code.updated" - | "quote.accepted" - | "quote.canceled" - | "quote.created" - | "quote.finalized" - | "radar.early_fraud_warning.created" - | "radar.early_fraud_warning.updated" - | "recipient.created" - | "recipient.deleted" - | "recipient.updated" - | "reporting.report_run.failed" - | "reporting.report_run.succeeded" - | "reporting.report_type.updated" - | "review.closed" - | "review.opened" - | "setup_intent.canceled" - | "setup_intent.created" - | "setup_intent.requires_action" - | "setup_intent.setup_failed" - | "setup_intent.succeeded" - | "sigma.scheduled_query_run.created" - | "sku.created" - | "sku.deleted" - | "sku.updated" - | "source.canceled" - | "source.chargeable" - | "source.failed" - | "source.mandate_notification" - | "source.refund_attributes_required" - | "source.transaction.created" - | "source.transaction.updated" - | "subscription_schedule.aborted" - | "subscription_schedule.canceled" - | "subscription_schedule.completed" - | "subscription_schedule.created" - | "subscription_schedule.expiring" - | "subscription_schedule.released" - | "subscription_schedule.updated" - | "tax_rate.created" - | "tax_rate.updated" - | "topup.canceled" - | "topup.created" - | "topup.failed" - | "topup.reversed" - | "topup.succeeded" - | "transfer.created" - | "transfer.failed" - | "transfer.paid" - | "transfer.reversed" - | "transfer.updated" - )[]; + | '*' + | 'account.application.authorized' + | 'account.application.deauthorized' + | 'account.external_account.created' + | 'account.external_account.deleted' + | 'account.external_account.updated' + | 'account.updated' + | 'application_fee.created' + | 'application_fee.refund.updated' + | 'application_fee.refunded' + | 'balance.available' + | 'billing_portal.configuration.created' + | 'billing_portal.configuration.updated' + | 'capability.updated' + | 'charge.captured' + | 'charge.dispute.closed' + | 'charge.dispute.created' + | 'charge.dispute.funds_reinstated' + | 'charge.dispute.funds_withdrawn' + | 'charge.dispute.updated' + | 'charge.expired' + | 'charge.failed' + | 'charge.pending' + | 'charge.refund.updated' + | 'charge.refunded' + | 'charge.succeeded' + | 'charge.updated' + | 'checkout.session.async_payment_failed' + | 'checkout.session.async_payment_succeeded' + | 'checkout.session.completed' + | 'checkout.session.expired' + | 'coupon.created' + | 'coupon.deleted' + | 'coupon.updated' + | 'credit_note.created' + | 'credit_note.updated' + | 'credit_note.voided' + | 'customer.created' + | 'customer.deleted' + | 'customer.discount.created' + | 'customer.discount.deleted' + | 'customer.discount.updated' + | 'customer.source.created' + | 'customer.source.deleted' + | 'customer.source.expiring' + | 'customer.source.updated' + | 'customer.subscription.created' + | 'customer.subscription.deleted' + | 'customer.subscription.pending_update_applied' + | 'customer.subscription.pending_update_expired' + | 'customer.subscription.trial_will_end' + | 'customer.subscription.updated' + | 'customer.tax_id.created' + | 'customer.tax_id.deleted' + | 'customer.tax_id.updated' + | 'customer.updated' + | 'file.created' + | 'identity.verification_session.canceled' + | 'identity.verification_session.created' + | 'identity.verification_session.processing' + | 'identity.verification_session.redacted' + | 'identity.verification_session.requires_input' + | 'identity.verification_session.verified' + | 'invoice.created' + | 'invoice.deleted' + | 'invoice.finalization_failed' + | 'invoice.finalized' + | 'invoice.marked_uncollectible' + | 'invoice.paid' + | 'invoice.payment_action_required' + | 'invoice.payment_failed' + | 'invoice.payment_succeeded' + | 'invoice.sent' + | 'invoice.upcoming' + | 'invoice.updated' + | 'invoice.voided' + | 'invoiceitem.created' + | 'invoiceitem.deleted' + | 'invoiceitem.updated' + | 'issuing_authorization.created' + | 'issuing_authorization.request' + | 'issuing_authorization.updated' + | 'issuing_card.created' + | 'issuing_card.updated' + | 'issuing_cardholder.created' + | 'issuing_cardholder.updated' + | 'issuing_dispute.closed' + | 'issuing_dispute.created' + | 'issuing_dispute.funds_reinstated' + | 'issuing_dispute.submitted' + | 'issuing_dispute.updated' + | 'issuing_transaction.created' + | 'issuing_transaction.updated' + | 'mandate.updated' + | 'order.created' + | 'order.payment_failed' + | 'order.payment_succeeded' + | 'order.updated' + | 'order_return.created' + | 'payment_intent.amount_capturable_updated' + | 'payment_intent.canceled' + | 'payment_intent.created' + | 'payment_intent.payment_failed' + | 'payment_intent.processing' + | 'payment_intent.requires_action' + | 'payment_intent.succeeded' + | 'payment_link.created' + | 'payment_link.updated' + | 'payment_method.attached' + | 'payment_method.automatically_updated' + | 'payment_method.detached' + | 'payment_method.updated' + | 'payout.canceled' + | 'payout.created' + | 'payout.failed' + | 'payout.paid' + | 'payout.updated' + | 'person.created' + | 'person.deleted' + | 'person.updated' + | 'plan.created' + | 'plan.deleted' + | 'plan.updated' + | 'price.created' + | 'price.deleted' + | 'price.updated' + | 'product.created' + | 'product.deleted' + | 'product.updated' + | 'promotion_code.created' + | 'promotion_code.updated' + | 'quote.accepted' + | 'quote.canceled' + | 'quote.created' + | 'quote.finalized' + | 'radar.early_fraud_warning.created' + | 'radar.early_fraud_warning.updated' + | 'recipient.created' + | 'recipient.deleted' + | 'recipient.updated' + | 'reporting.report_run.failed' + | 'reporting.report_run.succeeded' + | 'reporting.report_type.updated' + | 'review.closed' + | 'review.opened' + | 'setup_intent.canceled' + | 'setup_intent.created' + | 'setup_intent.requires_action' + | 'setup_intent.setup_failed' + | 'setup_intent.succeeded' + | 'sigma.scheduled_query_run.created' + | 'sku.created' + | 'sku.deleted' + | 'sku.updated' + | 'source.canceled' + | 'source.chargeable' + | 'source.failed' + | 'source.mandate_notification' + | 'source.refund_attributes_required' + | 'source.transaction.created' + | 'source.transaction.updated' + | 'subscription_schedule.aborted' + | 'subscription_schedule.canceled' + | 'subscription_schedule.completed' + | 'subscription_schedule.created' + | 'subscription_schedule.expiring' + | 'subscription_schedule.released' + | 'subscription_schedule.updated' + | 'tax_rate.created' + | 'tax_rate.updated' + | 'topup.canceled' + | 'topup.created' + | 'topup.failed' + | 'topup.reversed' + | 'topup.succeeded' + | 'transfer.created' + | 'transfer.failed' + | 'transfer.paid' + | 'transfer.reversed' + | 'transfer.updated' + )[] /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The URL of the webhook endpoint. */ - url: string; - }; - }; - }; - }; + url: string + } + } + } + } /**

Retrieves the webhook endpoint with the given ID.

*/ GetWebhookEndpointsWebhookEndpoint: { parameters: { query: { /** Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + expand?: string[] + } path: { - webhook_endpoint: string; - }; - }; + webhook_endpoint: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["webhook_endpoint"]; - }; - }; + 'application/json': components['schemas']['webhook_endpoint'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } /**

Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.

*/ PostWebhookEndpointsWebhookEndpoint: { parameters: { path: { - webhook_endpoint: string; - }; - }; + webhook_endpoint: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["webhook_endpoint"]; - }; - }; + 'application/json': components['schemas']['webhook_endpoint'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { + 'application/x-www-form-urlencoded': { /** @description An optional description of what the webhook is used for. */ - description?: string; + description?: string /** @description Disable the webhook endpoint if set to true. */ - disabled?: boolean; + disabled?: boolean /** @description The list of events to enable for this endpoint. You may specify `['*']` to enable all events, except those that require explicit selection. */ enabled_events?: ( - | "*" - | "account.application.authorized" - | "account.application.deauthorized" - | "account.external_account.created" - | "account.external_account.deleted" - | "account.external_account.updated" - | "account.updated" - | "application_fee.created" - | "application_fee.refund.updated" - | "application_fee.refunded" - | "balance.available" - | "billing_portal.configuration.created" - | "billing_portal.configuration.updated" - | "capability.updated" - | "charge.captured" - | "charge.dispute.closed" - | "charge.dispute.created" - | "charge.dispute.funds_reinstated" - | "charge.dispute.funds_withdrawn" - | "charge.dispute.updated" - | "charge.expired" - | "charge.failed" - | "charge.pending" - | "charge.refund.updated" - | "charge.refunded" - | "charge.succeeded" - | "charge.updated" - | "checkout.session.async_payment_failed" - | "checkout.session.async_payment_succeeded" - | "checkout.session.completed" - | "checkout.session.expired" - | "coupon.created" - | "coupon.deleted" - | "coupon.updated" - | "credit_note.created" - | "credit_note.updated" - | "credit_note.voided" - | "customer.created" - | "customer.deleted" - | "customer.discount.created" - | "customer.discount.deleted" - | "customer.discount.updated" - | "customer.source.created" - | "customer.source.deleted" - | "customer.source.expiring" - | "customer.source.updated" - | "customer.subscription.created" - | "customer.subscription.deleted" - | "customer.subscription.pending_update_applied" - | "customer.subscription.pending_update_expired" - | "customer.subscription.trial_will_end" - | "customer.subscription.updated" - | "customer.tax_id.created" - | "customer.tax_id.deleted" - | "customer.tax_id.updated" - | "customer.updated" - | "file.created" - | "identity.verification_session.canceled" - | "identity.verification_session.created" - | "identity.verification_session.processing" - | "identity.verification_session.redacted" - | "identity.verification_session.requires_input" - | "identity.verification_session.verified" - | "invoice.created" - | "invoice.deleted" - | "invoice.finalization_failed" - | "invoice.finalized" - | "invoice.marked_uncollectible" - | "invoice.paid" - | "invoice.payment_action_required" - | "invoice.payment_failed" - | "invoice.payment_succeeded" - | "invoice.sent" - | "invoice.upcoming" - | "invoice.updated" - | "invoice.voided" - | "invoiceitem.created" - | "invoiceitem.deleted" - | "invoiceitem.updated" - | "issuing_authorization.created" - | "issuing_authorization.request" - | "issuing_authorization.updated" - | "issuing_card.created" - | "issuing_card.updated" - | "issuing_cardholder.created" - | "issuing_cardholder.updated" - | "issuing_dispute.closed" - | "issuing_dispute.created" - | "issuing_dispute.funds_reinstated" - | "issuing_dispute.submitted" - | "issuing_dispute.updated" - | "issuing_transaction.created" - | "issuing_transaction.updated" - | "mandate.updated" - | "order.created" - | "order.payment_failed" - | "order.payment_succeeded" - | "order.updated" - | "order_return.created" - | "payment_intent.amount_capturable_updated" - | "payment_intent.canceled" - | "payment_intent.created" - | "payment_intent.payment_failed" - | "payment_intent.processing" - | "payment_intent.requires_action" - | "payment_intent.succeeded" - | "payment_link.created" - | "payment_link.updated" - | "payment_method.attached" - | "payment_method.automatically_updated" - | "payment_method.detached" - | "payment_method.updated" - | "payout.canceled" - | "payout.created" - | "payout.failed" - | "payout.paid" - | "payout.updated" - | "person.created" - | "person.deleted" - | "person.updated" - | "plan.created" - | "plan.deleted" - | "plan.updated" - | "price.created" - | "price.deleted" - | "price.updated" - | "product.created" - | "product.deleted" - | "product.updated" - | "promotion_code.created" - | "promotion_code.updated" - | "quote.accepted" - | "quote.canceled" - | "quote.created" - | "quote.finalized" - | "radar.early_fraud_warning.created" - | "radar.early_fraud_warning.updated" - | "recipient.created" - | "recipient.deleted" - | "recipient.updated" - | "reporting.report_run.failed" - | "reporting.report_run.succeeded" - | "reporting.report_type.updated" - | "review.closed" - | "review.opened" - | "setup_intent.canceled" - | "setup_intent.created" - | "setup_intent.requires_action" - | "setup_intent.setup_failed" - | "setup_intent.succeeded" - | "sigma.scheduled_query_run.created" - | "sku.created" - | "sku.deleted" - | "sku.updated" - | "source.canceled" - | "source.chargeable" - | "source.failed" - | "source.mandate_notification" - | "source.refund_attributes_required" - | "source.transaction.created" - | "source.transaction.updated" - | "subscription_schedule.aborted" - | "subscription_schedule.canceled" - | "subscription_schedule.completed" - | "subscription_schedule.created" - | "subscription_schedule.expiring" - | "subscription_schedule.released" - | "subscription_schedule.updated" - | "tax_rate.created" - | "tax_rate.updated" - | "topup.canceled" - | "topup.created" - | "topup.failed" - | "topup.reversed" - | "topup.succeeded" - | "transfer.created" - | "transfer.failed" - | "transfer.paid" - | "transfer.reversed" - | "transfer.updated" - )[]; + | '*' + | 'account.application.authorized' + | 'account.application.deauthorized' + | 'account.external_account.created' + | 'account.external_account.deleted' + | 'account.external_account.updated' + | 'account.updated' + | 'application_fee.created' + | 'application_fee.refund.updated' + | 'application_fee.refunded' + | 'balance.available' + | 'billing_portal.configuration.created' + | 'billing_portal.configuration.updated' + | 'capability.updated' + | 'charge.captured' + | 'charge.dispute.closed' + | 'charge.dispute.created' + | 'charge.dispute.funds_reinstated' + | 'charge.dispute.funds_withdrawn' + | 'charge.dispute.updated' + | 'charge.expired' + | 'charge.failed' + | 'charge.pending' + | 'charge.refund.updated' + | 'charge.refunded' + | 'charge.succeeded' + | 'charge.updated' + | 'checkout.session.async_payment_failed' + | 'checkout.session.async_payment_succeeded' + | 'checkout.session.completed' + | 'checkout.session.expired' + | 'coupon.created' + | 'coupon.deleted' + | 'coupon.updated' + | 'credit_note.created' + | 'credit_note.updated' + | 'credit_note.voided' + | 'customer.created' + | 'customer.deleted' + | 'customer.discount.created' + | 'customer.discount.deleted' + | 'customer.discount.updated' + | 'customer.source.created' + | 'customer.source.deleted' + | 'customer.source.expiring' + | 'customer.source.updated' + | 'customer.subscription.created' + | 'customer.subscription.deleted' + | 'customer.subscription.pending_update_applied' + | 'customer.subscription.pending_update_expired' + | 'customer.subscription.trial_will_end' + | 'customer.subscription.updated' + | 'customer.tax_id.created' + | 'customer.tax_id.deleted' + | 'customer.tax_id.updated' + | 'customer.updated' + | 'file.created' + | 'identity.verification_session.canceled' + | 'identity.verification_session.created' + | 'identity.verification_session.processing' + | 'identity.verification_session.redacted' + | 'identity.verification_session.requires_input' + | 'identity.verification_session.verified' + | 'invoice.created' + | 'invoice.deleted' + | 'invoice.finalization_failed' + | 'invoice.finalized' + | 'invoice.marked_uncollectible' + | 'invoice.paid' + | 'invoice.payment_action_required' + | 'invoice.payment_failed' + | 'invoice.payment_succeeded' + | 'invoice.sent' + | 'invoice.upcoming' + | 'invoice.updated' + | 'invoice.voided' + | 'invoiceitem.created' + | 'invoiceitem.deleted' + | 'invoiceitem.updated' + | 'issuing_authorization.created' + | 'issuing_authorization.request' + | 'issuing_authorization.updated' + | 'issuing_card.created' + | 'issuing_card.updated' + | 'issuing_cardholder.created' + | 'issuing_cardholder.updated' + | 'issuing_dispute.closed' + | 'issuing_dispute.created' + | 'issuing_dispute.funds_reinstated' + | 'issuing_dispute.submitted' + | 'issuing_dispute.updated' + | 'issuing_transaction.created' + | 'issuing_transaction.updated' + | 'mandate.updated' + | 'order.created' + | 'order.payment_failed' + | 'order.payment_succeeded' + | 'order.updated' + | 'order_return.created' + | 'payment_intent.amount_capturable_updated' + | 'payment_intent.canceled' + | 'payment_intent.created' + | 'payment_intent.payment_failed' + | 'payment_intent.processing' + | 'payment_intent.requires_action' + | 'payment_intent.succeeded' + | 'payment_link.created' + | 'payment_link.updated' + | 'payment_method.attached' + | 'payment_method.automatically_updated' + | 'payment_method.detached' + | 'payment_method.updated' + | 'payout.canceled' + | 'payout.created' + | 'payout.failed' + | 'payout.paid' + | 'payout.updated' + | 'person.created' + | 'person.deleted' + | 'person.updated' + | 'plan.created' + | 'plan.deleted' + | 'plan.updated' + | 'price.created' + | 'price.deleted' + | 'price.updated' + | 'product.created' + | 'product.deleted' + | 'product.updated' + | 'promotion_code.created' + | 'promotion_code.updated' + | 'quote.accepted' + | 'quote.canceled' + | 'quote.created' + | 'quote.finalized' + | 'radar.early_fraud_warning.created' + | 'radar.early_fraud_warning.updated' + | 'recipient.created' + | 'recipient.deleted' + | 'recipient.updated' + | 'reporting.report_run.failed' + | 'reporting.report_run.succeeded' + | 'reporting.report_type.updated' + | 'review.closed' + | 'review.opened' + | 'setup_intent.canceled' + | 'setup_intent.created' + | 'setup_intent.requires_action' + | 'setup_intent.setup_failed' + | 'setup_intent.succeeded' + | 'sigma.scheduled_query_run.created' + | 'sku.created' + | 'sku.deleted' + | 'sku.updated' + | 'source.canceled' + | 'source.chargeable' + | 'source.failed' + | 'source.mandate_notification' + | 'source.refund_attributes_required' + | 'source.transaction.created' + | 'source.transaction.updated' + | 'subscription_schedule.aborted' + | 'subscription_schedule.canceled' + | 'subscription_schedule.completed' + | 'subscription_schedule.created' + | 'subscription_schedule.expiring' + | 'subscription_schedule.released' + | 'subscription_schedule.updated' + | 'tax_rate.created' + | 'tax_rate.updated' + | 'topup.canceled' + | 'topup.created' + | 'topup.failed' + | 'topup.reversed' + | 'topup.succeeded' + | 'transfer.created' + | 'transfer.failed' + | 'transfer.paid' + | 'transfer.reversed' + | 'transfer.updated' + )[] /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + expand?: string[] /** @description 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?: Partial<{ [key: string]: string }> & Partial<"">; + metadata?: Partial<{ [key: string]: string }> & Partial<''> /** @description The URL of the webhook endpoint. */ - url?: string; - }; - }; - }; - }; + url?: string + } + } + } + } /**

You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.

*/ DeleteWebhookEndpointsWebhookEndpoint: { parameters: { path: { - webhook_endpoint: string; - }; - }; + webhook_endpoint: string + } + } responses: { /** Successful response. */ 200: { content: { - "application/json": components["schemas"]["deleted_webhook_endpoint"]; - }; - }; + 'application/json': components['schemas']['deleted_webhook_endpoint'] + } + } /** Error response. */ default: { content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; + 'application/json': components['schemas']['error'] + } + } + } requestBody: { content: { - "application/x-www-form-urlencoded": { [key: string]: unknown }; - }; - }; - }; + 'application/x-www-form-urlencoded': { [key: string]: unknown } + } + } + } } export interface external {} diff --git a/test/v3/fixtures/.prettierrc b/test/v3/fixtures/.prettierrc new file mode 100644 index 000000000..ebe15dc8d --- /dev/null +++ b/test/v3/fixtures/.prettierrc @@ -0,0 +1,6 @@ +{ + "printWidth": 150, + "semi": false, + "singleQuote": true, + "trailingComma": "all" +} diff --git a/test/v3/index.test.js b/test/v3/index.test.js index 388791109..bf7fc8b30 100644 --- a/test/v3/index.test.js +++ b/test/v3/index.test.js @@ -15,7 +15,7 @@ describe("cli", () => { it(`reads ${schema} spec (v3) from file`, async () => { const filename = schema.replace(/\.(json|yaml)$/, ".ts"); - execSync(`${cmd} specs/${schema} -o generated/${filename} --prettier-config .prettierrc`, { cwd }); + execSync(`${cmd} specs/${schema} -o generated/${filename} --prettier-config fixtures/.prettierrc`, { cwd }); const generated = fs.readFileSync(new URL(`./generated/${filename}`, cwd), "utf8"); const expected = eol.lf(fs.readFileSync(new URL(`./expected/${filename}`, cwd), "utf8")); expect(generated).to.equal(expected); @@ -25,7 +25,7 @@ describe("cli", () => { const filename = schema.replace(/\.(json|yaml)/, ".additional.ts"); execSync( - `${cmd} specs/${schema} -o generated/${filename} --prettier-config .prettierrc --additional-properties`, + `${cmd} specs/${schema} -o generated/${filename} --prettier-config fixtures/.prettierrc --additional-properties`, { cwd } ); const generated = fs.readFileSync(new URL(`./generated/${filename}`, cwd), "utf8"); @@ -36,9 +36,12 @@ describe("cli", () => { it(`reads ${schema} spec (v3) from file (immutable types)`, async () => { const filename = schema.replace(/\.(json|yaml)/, ".immutable.ts"); - execSync(`${cmd} specs/${schema} -o generated/${filename} --prettier-config .prettierrc --immutable-types`, { - cwd, - }); + execSync( + `${cmd} specs/${schema} -o generated/${filename} --prettier-config fixtures/.prettierrc --immutable-types`, + { + cwd, + } + ); const generated = fs.readFileSync(new URL(`./generated/${filename}`, cwd), "utf8"); const expected = eol.lf(fs.readFileSync(new URL(`./expected/${filename}`, cwd), "utf8")); expect(generated).to.equal(expected); @@ -47,7 +50,7 @@ describe("cli", () => { it(`reads ${schema} spec (v3) from file (exported type instead of interface)`, async () => { const filename = schema.replace(/\.(json|yaml)/, ".exported-type.ts"); - execSync(`${cmd} specs/${schema} -o generated/${filename} --prettier-config .prettierrc --export-type`, { + execSync(`${cmd} specs/${schema} -o generated/${filename} --prettier-config fixtures/.prettierrc --export-type`, { cwd, }); const generated = fs.readFileSync(new URL(`./generated/${filename}`, cwd), "utf8"); @@ -58,9 +61,12 @@ describe("cli", () => { it(`reads ${schema} spec (v3) from file (generate tuples using array minItems / maxItems)`, async () => { const filename = schema.replace(/\.(json|yaml)/, ".support-array-length.ts"); - execSync(`${cmd} specs/${schema} -o generated/${filename} --prettier-config .prettierrc --support-array-length`, { - cwd, - }); + execSync( + `${cmd} specs/${schema} -o generated/${filename} --prettier-config fixtures/.prettierrc --support-array-length`, + { + cwd, + } + ); const generated = fs.readFileSync(new URL(`./generated/${filename}`, cwd), "utf8"); const expected = eol.lf(fs.readFileSync(new URL(`./expected/${filename}`, cwd), "utf8")); expect(generated).to.equal(expected); @@ -83,7 +89,7 @@ describe("json", () => { it(`reads ${schema} from JSON`, async () => { const spec = fs.readFileSync(new URL(`./specs/${schema}`, cwd), "utf8"); const generated = await openapiTS(yaml.load(spec), { - prettierConfig: fileURLToPath(new URL("../../.prettierrc", cwd)), + prettierConfig: fileURLToPath(new URL("fixtures/.prettierrc", cwd)), }); const expected = eol.lf( fs.readFileSync(new URL(`./expected/${schema.replace(/\.(json|yaml)$/, ".ts")}`, cwd), "utf8") From 4e7b1e505ff9bae0ce92610f88d63583d24516a3 Mon Sep 17 00:00:00 2001 From: Duncan Beevers Date: Mon, 2 May 2022 16:59:03 -0700 Subject: [PATCH 2/2] fix: Serialize falsey defaults and examples Closes #890 --- src/utils.ts | 9 +- test/bin/expected/paths-enum.ts | 1 + test/bin/expected/prettier-js.ts | 1 + test/bin/expected/prettier-json.ts | 1 + test/bin/expected/specs/manifold.ts | 34 +- test/bin/expected/specs/petstore.ts | 1 + test/bin/expected/stdin.ts | 1 + test/bin/expected/stdout.ts | 1 + test/opts/expected/remote-schema.ts | 1 + test/v2/expected/falsey-example.additional.ts | 38 ++ .../expected/falsey-example.exported-type.ts | 38 ++ test/v2/expected/falsey-example.immutable.ts | 38 ++ .../falsey-example.support-array-length.ts | 38 ++ test/v2/expected/falsey-example.ts | 38 ++ test/v2/expected/http.ts | 34 +- test/v2/expected/manifold.immutable.ts | 34 +- test/v2/expected/manifold.ts | 34 +- test/v2/expected/petstore.immutable.ts | 1 + test/v2/expected/petstore.ts | 1 + test/v2/specs/falsey-example.yaml | 34 ++ test/v3/expected/falsey-example.additional.ts | 41 +++ .../expected/falsey-example.exported-type.ts | 41 +++ test/v3/expected/falsey-example.immutable.ts | 41 +++ .../falsey-example.support-array-length.ts | 41 +++ test/v3/expected/falsey-example.ts | 41 +++ test/v3/expected/github.additional.ts | 335 +++++++++++++++--- test/v3/expected/github.exported-type.ts | 335 +++++++++++++++--- test/v3/expected/github.immutable.ts | 335 +++++++++++++++--- .../expected/github.support-array-length.ts | 335 +++++++++++++++--- test/v3/expected/github.ts | 335 +++++++++++++++--- test/v3/expected/http.ts | 21 +- test/v3/expected/jsdoc.additional.ts | 1 + test/v3/expected/jsdoc.exported-type.ts | 1 + test/v3/expected/jsdoc.immutable.ts | 1 + .../v3/expected/jsdoc.support-array-length.ts | 1 + test/v3/expected/jsdoc.ts | 1 + test/v3/expected/manifold.additional.ts | 21 +- test/v3/expected/manifold.exported-type.ts | 21 +- test/v3/expected/manifold.immutable.ts | 21 +- .../expected/manifold.support-array-length.ts | 21 +- test/v3/expected/manifold.ts | 21 +- .../petstore-openapitools.additional.ts | 1 + .../petstore-openapitools.exported-type.ts | 1 + .../petstore-openapitools.immutable.ts | 1 + ...store-openapitools.support-array-length.ts | 1 + test/v3/expected/petstore-openapitools.ts | 1 + test/v3/expected/petstore.additional.ts | 1 + test/v3/expected/petstore.exported-type.ts | 1 + test/v3/expected/petstore.immutable.ts | 1 + .../expected/petstore.support-array-length.ts | 1 + test/v3/expected/petstore.ts | 1 + test/v3/specs/falsey-example.yaml | 37 ++ 52 files changed, 2131 insertions(+), 305 deletions(-) create mode 100644 test/v2/expected/falsey-example.additional.ts create mode 100644 test/v2/expected/falsey-example.exported-type.ts create mode 100644 test/v2/expected/falsey-example.immutable.ts create mode 100644 test/v2/expected/falsey-example.support-array-length.ts create mode 100644 test/v2/expected/falsey-example.ts create mode 100644 test/v2/specs/falsey-example.yaml create mode 100644 test/v3/expected/falsey-example.additional.ts create mode 100644 test/v3/expected/falsey-example.exported-type.ts create mode 100644 test/v3/expected/falsey-example.immutable.ts create mode 100644 test/v3/expected/falsey-example.support-array-length.ts create mode 100644 test/v3/expected/falsey-example.ts create mode 100644 test/v3/specs/falsey-example.yaml diff --git a/src/utils.ts b/src/utils.ts index a4a4d1d7d..542f92cfe 100644 --- a/src/utils.ts +++ b/src/utils.ts @@ -42,7 +42,14 @@ export function prepareComment(v: CommentObject): string | void { const supportedJsDocTags: Array = ["description", "default", "example"]; for (let index = 0; index < supportedJsDocTags.length; index++) { const field = supportedJsDocTags[index]; - if (v[field]) commentsArray.push(`@${field} ${v[field]} `); + const allowEmptyString = field === "default" || field === "example"; + if (v[field] === undefined) { + continue; + } + if (v[field] === "" && !allowEmptyString) { + continue; + } + commentsArray.push(`@${field} ${v[field]} `); } // * JSDOC 'Constant' without value diff --git a/test/bin/expected/paths-enum.ts b/test/bin/expected/paths-enum.ts index 26aaa673b..73eb9fc74 100644 --- a/test/bin/expected/paths-enum.ts +++ b/test/bin/expected/paths-enum.ts @@ -79,6 +79,7 @@ export interface components { * @enum {string} */ status?: "placed" | "approved" | "delivered"; + /** @default false */ complete?: boolean; }; Category: { diff --git a/test/bin/expected/prettier-js.ts b/test/bin/expected/prettier-js.ts index 733c95a71..a0c0ff3f1 100644 --- a/test/bin/expected/prettier-js.ts +++ b/test/bin/expected/prettier-js.ts @@ -79,6 +79,7 @@ export interface components { * @enum {string} */ status?: 'placed' | 'approved' | 'delivered' + /** @default false */ complete?: boolean } Category: { diff --git a/test/bin/expected/prettier-json.ts b/test/bin/expected/prettier-json.ts index 733c95a71..a0c0ff3f1 100644 --- a/test/bin/expected/prettier-json.ts +++ b/test/bin/expected/prettier-json.ts @@ -79,6 +79,7 @@ export interface components { * @enum {string} */ status?: 'placed' | 'approved' | 'delivered' + /** @default false */ complete?: boolean } Category: { diff --git a/test/bin/expected/specs/manifold.ts b/test/bin/expected/specs/manifold.ts index b6ea325a3..23a8b9b60 100644 --- a/test/bin/expected/specs/manifold.ts +++ b/test/bin/expected/specs/manifold.ts @@ -688,23 +688,32 @@ export interface definitions { name: definitions["Name"]; /** @enum {string} */ type: "boolean" | "string" | "number"; - /** @description This sets whether or not the feature can be customized by a consumer. */ + /** + * @description This sets whether or not the feature can be customized by a consumer. + * @default false + */ customizable?: boolean; /** * @description This sets whether or not the feature can be upgraded by the consumer after the * resource has provisioned. Upgrading means setting a higher value or selecting a * higher element in the list. + * + * @default false */ upgradable?: boolean; /** * @description This sets whether or not the feature can be downgraded by the consumer after the * resource has provisioned. Downgrading means setting a lower value or selecting a * lower element in the list. + * + * @default false */ downgradable?: boolean; /** * @description Sets if this feature’s value is trackable from the provider, * this only really affects numeric constraints. + * + * @default false */ measurable?: boolean; values?: definitions["FeatureValuesList"]; @@ -725,6 +734,8 @@ export interface definitions { * @description The cost that will be added to the monthly plan cost when this value * is selected or is default for the plan. * Cost is deprecated in favor of the `price.cost` field. + * + * @default 0 */ cost?: number; /** @@ -736,12 +747,16 @@ export interface definitions { * @description Cost is the price in cents that will be added to plan's base cost * when this value is selected or is default for the plan. * Number features should use the cost range instead. + * + * @default 0 */ cost?: number; /** * @description When a feature is used to multiply the cost of the plan or of * another feature, multiply factor is used for calculation. * A feature cannot have both a cost and a multiply factor. + * + * @default 0 */ multiply_factor?: number; /** @@ -771,7 +786,10 @@ export interface definitions { * @default 1 */ increment?: number; - /** @description Minimum value that can be set by a user if customizable */ + /** + * @description Minimum value that can be set by a user if customizable + * @default 0 + */ min?: number; /** @description Maximum value that can be set by a user if customizable */ max?: number; @@ -790,6 +808,8 @@ export interface definitions { /** * @description An integer in 10,000,000ths of cents, will be multiplied by the * numeric value set in the feature to determine the cost. + * + * @default 0 */ cost_multiple?: number; }; @@ -819,6 +839,8 @@ export interface definitions { /** * @description When true, everyone can see the product when requested. When false it will * not be visible to anyone except those on the provider team. + * + * @default false */ public?: boolean; /** @@ -827,6 +849,8 @@ export interface definitions { * but can still be provisioned directly if it's label is known. * Any pages that display information about the product when not listed, * should indicate to webcrawlers that the content should not be indexed. + * + * @default false */ listed?: boolean; /** @@ -842,18 +866,24 @@ export interface definitions { * @description Indicates whether or not the product is in `Beta` and should be * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. + * + * @default false */ beta?: boolean; /** * @description Indicates whether or not the product is in `New` and should be * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. + * + * @default false */ new?: boolean; /** * @description Indicates whether or not the product is in `New` and should be * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. + * + * @default false */ featured?: boolean; }; diff --git a/test/bin/expected/specs/petstore.ts b/test/bin/expected/specs/petstore.ts index 9199645c1..681b80868 100644 --- a/test/bin/expected/specs/petstore.ts +++ b/test/bin/expected/specs/petstore.ts @@ -79,6 +79,7 @@ export interface components { * @enum {string} */ status?: "placed" | "approved" | "delivered"; + /** @default false */ complete?: boolean; }; Category: { diff --git a/test/bin/expected/stdin.ts b/test/bin/expected/stdin.ts index 9199645c1..681b80868 100644 --- a/test/bin/expected/stdin.ts +++ b/test/bin/expected/stdin.ts @@ -79,6 +79,7 @@ export interface components { * @enum {string} */ status?: "placed" | "approved" | "delivered"; + /** @default false */ complete?: boolean; }; Category: { diff --git a/test/bin/expected/stdout.ts b/test/bin/expected/stdout.ts index 9199645c1..681b80868 100644 --- a/test/bin/expected/stdout.ts +++ b/test/bin/expected/stdout.ts @@ -79,6 +79,7 @@ export interface components { * @enum {string} */ status?: "placed" | "approved" | "delivered"; + /** @default false */ complete?: boolean; }; Category: { diff --git a/test/opts/expected/remote-schema.ts b/test/opts/expected/remote-schema.ts index 683794a51..5654e3fa1 100644 --- a/test/opts/expected/remote-schema.ts +++ b/test/opts/expected/remote-schema.ts @@ -93,6 +93,7 @@ export interface external { * @enum {string} */ status?: "placed" | "approved" | "delivered"; + /** @default false */ complete?: boolean; }; Category: { diff --git a/test/v2/expected/falsey-example.additional.ts b/test/v2/expected/falsey-example.additional.ts new file mode 100644 index 000000000..2a705afed --- /dev/null +++ b/test/v2/expected/falsey-example.additional.ts @@ -0,0 +1,38 @@ +/** + * This file was auto-generated by openapi-typescript. + * Do not make direct changes to the file. + */ + +export interface paths { + '/test': { + get: { + parameters: { + query: { + search: string + } + } + responses: { + 200: unknown + } + } + } +} + +export interface definitions { + TestSchema: { + /** + * @default false + * @example false + */ + isEnabled?: boolean + /** + * @default 0 + * @example 0 + */ + count?: number + } +} + +export interface operations {} + +export interface external {} diff --git a/test/v2/expected/falsey-example.exported-type.ts b/test/v2/expected/falsey-example.exported-type.ts new file mode 100644 index 000000000..d4a6f9665 --- /dev/null +++ b/test/v2/expected/falsey-example.exported-type.ts @@ -0,0 +1,38 @@ +/** + * This file was auto-generated by openapi-typescript. + * Do not make direct changes to the file. + */ + +export type paths = { + '/test': { + get: { + parameters: { + query: { + search: string + } + } + responses: { + 200: unknown + } + } + } +} + +export type definitions = { + TestSchema: { + /** + * @default false + * @example false + */ + isEnabled?: boolean + /** + * @default 0 + * @example 0 + */ + count?: number + } +} + +export type operations = {} + +export type external = {} diff --git a/test/v2/expected/falsey-example.immutable.ts b/test/v2/expected/falsey-example.immutable.ts new file mode 100644 index 000000000..2e2ade2fa --- /dev/null +++ b/test/v2/expected/falsey-example.immutable.ts @@ -0,0 +1,38 @@ +/** + * This file was auto-generated by openapi-typescript. + * Do not make direct changes to the file. + */ + +export interface paths { + readonly '/test': { + readonly get: { + readonly parameters: { + readonly query: { + readonly search: string + } + } + readonly responses: { + readonly 200: unknown + } + } + } +} + +export interface definitions { + readonly TestSchema: { + /** + * @default false + * @example false + */ + readonly isEnabled?: boolean + /** + * @default 0 + * @example 0 + */ + readonly count?: number + } +} + +export interface operations {} + +export interface external {} diff --git a/test/v2/expected/falsey-example.support-array-length.ts b/test/v2/expected/falsey-example.support-array-length.ts new file mode 100644 index 000000000..2a705afed --- /dev/null +++ b/test/v2/expected/falsey-example.support-array-length.ts @@ -0,0 +1,38 @@ +/** + * This file was auto-generated by openapi-typescript. + * Do not make direct changes to the file. + */ + +export interface paths { + '/test': { + get: { + parameters: { + query: { + search: string + } + } + responses: { + 200: unknown + } + } + } +} + +export interface definitions { + TestSchema: { + /** + * @default false + * @example false + */ + isEnabled?: boolean + /** + * @default 0 + * @example 0 + */ + count?: number + } +} + +export interface operations {} + +export interface external {} diff --git a/test/v2/expected/falsey-example.ts b/test/v2/expected/falsey-example.ts new file mode 100644 index 000000000..2a705afed --- /dev/null +++ b/test/v2/expected/falsey-example.ts @@ -0,0 +1,38 @@ +/** + * This file was auto-generated by openapi-typescript. + * Do not make direct changes to the file. + */ + +export interface paths { + '/test': { + get: { + parameters: { + query: { + search: string + } + } + responses: { + 200: unknown + } + } + } +} + +export interface definitions { + TestSchema: { + /** + * @default false + * @example false + */ + isEnabled?: boolean + /** + * @default 0 + * @example 0 + */ + count?: number + } +} + +export interface operations {} + +export interface external {} diff --git a/test/v2/expected/http.ts b/test/v2/expected/http.ts index b6ea325a3..23a8b9b60 100644 --- a/test/v2/expected/http.ts +++ b/test/v2/expected/http.ts @@ -688,23 +688,32 @@ export interface definitions { name: definitions["Name"]; /** @enum {string} */ type: "boolean" | "string" | "number"; - /** @description This sets whether or not the feature can be customized by a consumer. */ + /** + * @description This sets whether or not the feature can be customized by a consumer. + * @default false + */ customizable?: boolean; /** * @description This sets whether or not the feature can be upgraded by the consumer after the * resource has provisioned. Upgrading means setting a higher value or selecting a * higher element in the list. + * + * @default false */ upgradable?: boolean; /** * @description This sets whether or not the feature can be downgraded by the consumer after the * resource has provisioned. Downgrading means setting a lower value or selecting a * lower element in the list. + * + * @default false */ downgradable?: boolean; /** * @description Sets if this feature’s value is trackable from the provider, * this only really affects numeric constraints. + * + * @default false */ measurable?: boolean; values?: definitions["FeatureValuesList"]; @@ -725,6 +734,8 @@ export interface definitions { * @description The cost that will be added to the monthly plan cost when this value * is selected or is default for the plan. * Cost is deprecated in favor of the `price.cost` field. + * + * @default 0 */ cost?: number; /** @@ -736,12 +747,16 @@ export interface definitions { * @description Cost is the price in cents that will be added to plan's base cost * when this value is selected or is default for the plan. * Number features should use the cost range instead. + * + * @default 0 */ cost?: number; /** * @description When a feature is used to multiply the cost of the plan or of * another feature, multiply factor is used for calculation. * A feature cannot have both a cost and a multiply factor. + * + * @default 0 */ multiply_factor?: number; /** @@ -771,7 +786,10 @@ export interface definitions { * @default 1 */ increment?: number; - /** @description Minimum value that can be set by a user if customizable */ + /** + * @description Minimum value that can be set by a user if customizable + * @default 0 + */ min?: number; /** @description Maximum value that can be set by a user if customizable */ max?: number; @@ -790,6 +808,8 @@ export interface definitions { /** * @description An integer in 10,000,000ths of cents, will be multiplied by the * numeric value set in the feature to determine the cost. + * + * @default 0 */ cost_multiple?: number; }; @@ -819,6 +839,8 @@ export interface definitions { /** * @description When true, everyone can see the product when requested. When false it will * not be visible to anyone except those on the provider team. + * + * @default false */ public?: boolean; /** @@ -827,6 +849,8 @@ export interface definitions { * but can still be provisioned directly if it's label is known. * Any pages that display information about the product when not listed, * should indicate to webcrawlers that the content should not be indexed. + * + * @default false */ listed?: boolean; /** @@ -842,18 +866,24 @@ export interface definitions { * @description Indicates whether or not the product is in `Beta` and should be * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. + * + * @default false */ beta?: boolean; /** * @description Indicates whether or not the product is in `New` and should be * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. + * + * @default false */ new?: boolean; /** * @description Indicates whether or not the product is in `New` and should be * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. + * + * @default false */ featured?: boolean; }; diff --git a/test/v2/expected/manifold.immutable.ts b/test/v2/expected/manifold.immutable.ts index c2769e8f7..9b9a2580f 100644 --- a/test/v2/expected/manifold.immutable.ts +++ b/test/v2/expected/manifold.immutable.ts @@ -688,23 +688,32 @@ export interface definitions { readonly name: definitions['Name'] /** @enum {string} */ readonly type: 'boolean' | 'string' | 'number' - /** @description This sets whether or not the feature can be customized by a consumer. */ + /** + * @description This sets whether or not the feature can be customized by a consumer. + * @default false + */ readonly customizable?: boolean /** * @description This sets whether or not the feature can be upgraded by the consumer after the * resource has provisioned. Upgrading means setting a higher value or selecting a * higher element in the list. + * + * @default false */ readonly upgradable?: boolean /** * @description This sets whether or not the feature can be downgraded by the consumer after the * resource has provisioned. Downgrading means setting a lower value or selecting a * lower element in the list. + * + * @default false */ readonly downgradable?: boolean /** * @description Sets if this feature’s value is trackable from the provider, * this only really affects numeric constraints. + * + * @default false */ readonly measurable?: boolean readonly values?: definitions['FeatureValuesList'] @@ -725,6 +734,8 @@ export interface definitions { * @description The cost that will be added to the monthly plan cost when this value * is selected or is default for the plan. * Cost is deprecated in favor of the `price.cost` field. + * + * @default 0 */ readonly cost?: number /** @@ -736,12 +747,16 @@ export interface definitions { * @description Cost is the price in cents that will be added to plan's base cost * when this value is selected or is default for the plan. * Number features should use the cost range instead. + * + * @default 0 */ readonly cost?: number /** * @description When a feature is used to multiply the cost of the plan or of * another feature, multiply factor is used for calculation. * A feature cannot have both a cost and a multiply factor. + * + * @default 0 */ readonly multiply_factor?: number /** @@ -771,7 +786,10 @@ export interface definitions { * @default 1 */ readonly increment?: number - /** @description Minimum value that can be set by a user if customizable */ + /** + * @description Minimum value that can be set by a user if customizable + * @default 0 + */ readonly min?: number /** @description Maximum value that can be set by a user if customizable */ readonly max?: number @@ -790,6 +808,8 @@ export interface definitions { /** * @description An integer in 10,000,000ths of cents, will be multiplied by the * numeric value set in the feature to determine the cost. + * + * @default 0 */ readonly cost_multiple?: number } @@ -819,6 +839,8 @@ export interface definitions { /** * @description When true, everyone can see the product when requested. When false it will * not be visible to anyone except those on the provider team. + * + * @default false */ readonly public?: boolean /** @@ -827,6 +849,8 @@ export interface definitions { * but can still be provisioned directly if it's label is known. * Any pages that display information about the product when not listed, * should indicate to webcrawlers that the content should not be indexed. + * + * @default false */ readonly listed?: boolean /** @@ -842,18 +866,24 @@ export interface definitions { * @description Indicates whether or not the product is in `Beta` and should be * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. + * + * @default false */ readonly beta?: boolean /** * @description Indicates whether or not the product is in `New` and should be * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. + * + * @default false */ readonly new?: boolean /** * @description Indicates whether or not the product is in `New` and should be * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. + * + * @default false */ readonly featured?: boolean } diff --git a/test/v2/expected/manifold.ts b/test/v2/expected/manifold.ts index 8a83a64d6..aa308cf1f 100644 --- a/test/v2/expected/manifold.ts +++ b/test/v2/expected/manifold.ts @@ -688,23 +688,32 @@ export interface definitions { name: definitions['Name'] /** @enum {string} */ type: 'boolean' | 'string' | 'number' - /** @description This sets whether or not the feature can be customized by a consumer. */ + /** + * @description This sets whether or not the feature can be customized by a consumer. + * @default false + */ customizable?: boolean /** * @description This sets whether or not the feature can be upgraded by the consumer after the * resource has provisioned. Upgrading means setting a higher value or selecting a * higher element in the list. + * + * @default false */ upgradable?: boolean /** * @description This sets whether or not the feature can be downgraded by the consumer after the * resource has provisioned. Downgrading means setting a lower value or selecting a * lower element in the list. + * + * @default false */ downgradable?: boolean /** * @description Sets if this feature’s value is trackable from the provider, * this only really affects numeric constraints. + * + * @default false */ measurable?: boolean values?: definitions['FeatureValuesList'] @@ -725,6 +734,8 @@ export interface definitions { * @description The cost that will be added to the monthly plan cost when this value * is selected or is default for the plan. * Cost is deprecated in favor of the `price.cost` field. + * + * @default 0 */ cost?: number /** @@ -736,12 +747,16 @@ export interface definitions { * @description Cost is the price in cents that will be added to plan's base cost * when this value is selected or is default for the plan. * Number features should use the cost range instead. + * + * @default 0 */ cost?: number /** * @description When a feature is used to multiply the cost of the plan or of * another feature, multiply factor is used for calculation. * A feature cannot have both a cost and a multiply factor. + * + * @default 0 */ multiply_factor?: number /** @@ -771,7 +786,10 @@ export interface definitions { * @default 1 */ increment?: number - /** @description Minimum value that can be set by a user if customizable */ + /** + * @description Minimum value that can be set by a user if customizable + * @default 0 + */ min?: number /** @description Maximum value that can be set by a user if customizable */ max?: number @@ -790,6 +808,8 @@ export interface definitions { /** * @description An integer in 10,000,000ths of cents, will be multiplied by the * numeric value set in the feature to determine the cost. + * + * @default 0 */ cost_multiple?: number } @@ -819,6 +839,8 @@ export interface definitions { /** * @description When true, everyone can see the product when requested. When false it will * not be visible to anyone except those on the provider team. + * + * @default false */ public?: boolean /** @@ -827,6 +849,8 @@ export interface definitions { * but can still be provisioned directly if it's label is known. * Any pages that display information about the product when not listed, * should indicate to webcrawlers that the content should not be indexed. + * + * @default false */ listed?: boolean /** @@ -842,18 +866,24 @@ export interface definitions { * @description Indicates whether or not the product is in `Beta` and should be * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. + * + * @default false */ beta?: boolean /** * @description Indicates whether or not the product is in `New` and should be * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. + * + * @default false */ new?: boolean /** * @description Indicates whether or not the product is in `New` and should be * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. + * + * @default false */ featured?: boolean } diff --git a/test/v2/expected/petstore.immutable.ts b/test/v2/expected/petstore.immutable.ts index 019045295..96583c08f 100644 --- a/test/v2/expected/petstore.immutable.ts +++ b/test/v2/expected/petstore.immutable.ts @@ -78,6 +78,7 @@ export interface definitions { * @enum {string} */ readonly status?: 'placed' | 'approved' | 'delivered' + /** @default false */ readonly complete?: boolean } readonly Category: { diff --git a/test/v2/expected/petstore.ts b/test/v2/expected/petstore.ts index 062705bbf..6572e5ccf 100644 --- a/test/v2/expected/petstore.ts +++ b/test/v2/expected/petstore.ts @@ -78,6 +78,7 @@ export interface definitions { * @enum {string} */ status?: 'placed' | 'approved' | 'delivered' + /** @default false */ complete?: boolean } Category: { diff --git a/test/v2/specs/falsey-example.yaml b/test/v2/specs/falsey-example.yaml new file mode 100644 index 000000000..b981a00c2 --- /dev/null +++ b/test/v2/specs/falsey-example.yaml @@ -0,0 +1,34 @@ +swagger: '2.0' +info: + title: '' + version: '1.0.0' +paths: + /test: + get: + tags: + - test + description: '' + summary: '' + responses: + 200: + description: '' + parameters: + - in: query + name: search + type: string + description: '' + required: true +definitions: + TestSchema: + type: object + properties: + isEnabled: + type: boolean + description: '' + default: false + example: false + count: + type: number + description: '' + default: 0 + example: 0 \ No newline at end of file diff --git a/test/v3/expected/falsey-example.additional.ts b/test/v3/expected/falsey-example.additional.ts new file mode 100644 index 000000000..da66ba3d2 --- /dev/null +++ b/test/v3/expected/falsey-example.additional.ts @@ -0,0 +1,41 @@ +/** + * This file was auto-generated by openapi-typescript. + * Do not make direct changes to the file. + */ + +export interface paths { + '/test': { + get: { + parameters: { + query: { + isEnabled: boolean + count: number + } + } + responses: { + 200: unknown + } + } + } +} + +export interface components { + schemas: { + TestSchema: { + /** + * @default false + * @example false + */ + isEnabled?: boolean + /** + * @default 0 + * @example 0 + */ + count?: number + } & { [key: string]: unknown } + } +} + +export interface operations {} + +export interface external {} diff --git a/test/v3/expected/falsey-example.exported-type.ts b/test/v3/expected/falsey-example.exported-type.ts new file mode 100644 index 000000000..b10cf2481 --- /dev/null +++ b/test/v3/expected/falsey-example.exported-type.ts @@ -0,0 +1,41 @@ +/** + * This file was auto-generated by openapi-typescript. + * Do not make direct changes to the file. + */ + +export type paths = { + '/test': { + get: { + parameters: { + query: { + isEnabled: boolean + count: number + } + } + responses: { + 200: unknown + } + } + } +} + +export type components = { + schemas: { + TestSchema: { + /** + * @default false + * @example false + */ + isEnabled?: boolean + /** + * @default 0 + * @example 0 + */ + count?: number + } + } +} + +export type operations = {} + +export type external = {} diff --git a/test/v3/expected/falsey-example.immutable.ts b/test/v3/expected/falsey-example.immutable.ts new file mode 100644 index 000000000..b2c0d748f --- /dev/null +++ b/test/v3/expected/falsey-example.immutable.ts @@ -0,0 +1,41 @@ +/** + * This file was auto-generated by openapi-typescript. + * Do not make direct changes to the file. + */ + +export interface paths { + readonly '/test': { + readonly get: { + readonly parameters: { + readonly query: { + readonly isEnabled: boolean + readonly count: number + } + } + readonly responses: { + readonly 200: unknown + } + } + } +} + +export interface components { + readonly schemas: { + readonly TestSchema: { + /** + * @default false + * @example false + */ + readonly isEnabled?: boolean + /** + * @default 0 + * @example 0 + */ + readonly count?: number + } + } +} + +export interface operations {} + +export interface external {} diff --git a/test/v3/expected/falsey-example.support-array-length.ts b/test/v3/expected/falsey-example.support-array-length.ts new file mode 100644 index 000000000..5d91cf508 --- /dev/null +++ b/test/v3/expected/falsey-example.support-array-length.ts @@ -0,0 +1,41 @@ +/** + * This file was auto-generated by openapi-typescript. + * Do not make direct changes to the file. + */ + +export interface paths { + '/test': { + get: { + parameters: { + query: { + isEnabled: boolean + count: number + } + } + responses: { + 200: unknown + } + } + } +} + +export interface components { + schemas: { + TestSchema: { + /** + * @default false + * @example false + */ + isEnabled?: boolean + /** + * @default 0 + * @example 0 + */ + count?: number + } + } +} + +export interface operations {} + +export interface external {} diff --git a/test/v3/expected/falsey-example.ts b/test/v3/expected/falsey-example.ts new file mode 100644 index 000000000..5d91cf508 --- /dev/null +++ b/test/v3/expected/falsey-example.ts @@ -0,0 +1,41 @@ +/** + * This file was auto-generated by openapi-typescript. + * Do not make direct changes to the file. + */ + +export interface paths { + '/test': { + get: { + parameters: { + query: { + isEnabled: boolean + count: number + } + } + responses: { + 200: unknown + } + } + } +} + +export interface components { + schemas: { + TestSchema: { + /** + * @default false + * @example false + */ + isEnabled?: boolean + /** + * @default 0 + * @example 0 + */ + count?: number + } + } +} + +export interface operations {} + +export interface external {} diff --git a/test/v3/expected/github.additional.ts b/test/v3/expected/github.additional.ts index c327ff78a..a3b9a0a03 100644 --- a/test/v3/expected/github.additional.ts +++ b/test/v3/expected/github.additional.ts @@ -6182,7 +6182,10 @@ export interface components { * @example 2021-05-12T20:33:44Z */ delivered_at: string - /** @description Whether the webhook delivery is a redelivery. */ + /** + * @description Whether the webhook delivery is a redelivery. + * @example false + */ redelivery: boolean /** * @description Time spent delivering. @@ -6269,7 +6272,10 @@ export interface components { * @example 2021-05-12T20:33:44Z */ delivered_at: string - /** @description Whether the delivery is a redelivery. */ + /** + * @description Whether the delivery is a redelivery. + * @example false + */ redelivery: boolean /** * @description Time spent delivering. @@ -6707,7 +6713,10 @@ export interface components { maintain?: boolean } & { [key: string]: unknown } owner: components['schemas']['simple-user'] - /** @description Whether the repository is private or public. */ + /** + * @description Whether the repository is private or public. + * @default false + */ private: boolean /** * Format: uri @@ -6868,9 +6877,11 @@ export interface components { * @example master */ default_branch: string + /** @example 0 */ open_issues_count: number /** * @description Whether this repository acts as a template that can be used to generate new repositories. + * @default false * @example true */ is_template?: boolean @@ -6900,7 +6911,10 @@ export interface components { * @example true */ has_downloads: boolean - /** @description Whether the repository is archived. */ + /** + * @description Whether the repository is archived. + * @default false + */ archived: boolean /** @description Returns whether or not this repository disabled. */ disabled: boolean @@ -7048,9 +7062,17 @@ export interface components { * @example true */ allow_squash_merge?: boolean - /** @description Whether to allow Auto-merge to be used on pull requests. */ + /** + * @description Whether to allow Auto-merge to be used on pull requests. + * @default false + * @example false + */ allow_auto_merge?: boolean - /** @description Whether to delete head branches when pull requests are merged */ + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + * @example false + */ delete_branch_on_merge?: boolean /** * @description Whether to allow merge commits for pull requests. @@ -7515,7 +7537,10 @@ export interface components { maintain?: boolean } & { [key: string]: unknown } owner: components['schemas']['simple-user'] - /** @description Whether the repository is private or public. */ + /** + * @description Whether the repository is private or public. + * @default false + */ private: boolean /** * Format: uri @@ -7676,9 +7701,11 @@ export interface components { * @example master */ default_branch: string + /** @example 0 */ open_issues_count: number /** * @description Whether this repository acts as a template that can be used to generate new repositories. + * @default false * @example true */ is_template?: boolean @@ -7708,7 +7735,10 @@ export interface components { * @example true */ has_downloads: boolean - /** @description Whether the repository is archived. */ + /** + * @description Whether the repository is archived. + * @default false + */ archived: boolean /** @description Returns whether or not this repository disabled. */ disabled: boolean @@ -7856,9 +7886,17 @@ export interface components { * @example true */ allow_squash_merge?: boolean - /** @description Whether to allow Auto-merge to be used on pull requests. */ + /** + * @description Whether to allow Auto-merge to be used on pull requests. + * @default false + * @example false + */ allow_auto_merge?: boolean - /** @description Whether to delete head branches when pull requests are merged */ + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + * @example false + */ delete_branch_on_merge?: boolean /** * @description Whether to allow merge commits for pull requests. @@ -8078,8 +8116,11 @@ export interface components { node_id?: string } & { [key: string]: unknown }) | null + /** @example 0 */ forks?: number + /** @example 0 */ open_issues?: number + /** @example 0 */ watchers?: number allow_forking?: boolean } & { [key: string]: unknown } @@ -9196,6 +9237,7 @@ export interface components { public_gists: number /** @example 20 */ followers: number + /** @example 0 */ following: number /** * Format: uri @@ -9250,6 +9292,7 @@ export interface components { members_can_create_public_pages?: boolean /** @example true */ members_can_create_private_pages?: boolean + /** @example false */ members_can_fork_private_repositories?: boolean | null /** Format: date-time */ updated_at: string @@ -10109,8 +10152,11 @@ export interface components { node_id?: string } & { [key: string]: unknown }) | null + /** @example 0 */ forks?: number + /** @example 0 */ open_issues?: number + /** @example 0 */ watchers?: number allow_forking?: boolean } & { [key: string]: unknown }) @@ -10406,6 +10452,7 @@ export interface components { * @example 0307116bbf7ced493b8d8a346c650b71 */ body_version: string + /** @example 0 */ comments_count: number /** * Format: uri @@ -10618,7 +10665,10 @@ export interface components { /** @example admin */ role_name?: string owner: components['schemas']['nullable-simple-user'] - /** @description Whether the repository is private or public. */ + /** + * @description Whether the repository is private or public. + * @default false + */ private: boolean /** * Format: uri @@ -10779,9 +10829,11 @@ export interface components { * @example master */ default_branch: string + /** @example 0 */ open_issues_count: number /** * @description Whether this repository acts as a template that can be used to generate new repositories. + * @default false * @example true */ is_template?: boolean @@ -10811,7 +10863,10 @@ export interface components { * @example true */ has_downloads: boolean - /** @description Whether the repository is archived. */ + /** + * @description Whether the repository is archived. + * @default false + */ archived: boolean /** @description Returns whether or not this repository disabled. */ disabled: boolean @@ -10849,9 +10904,17 @@ export interface components { * @example true */ allow_squash_merge?: boolean - /** @description Whether to allow Auto-merge to be used on pull requests. */ + /** + * @description Whether to allow Auto-merge to be used on pull requests. + * @default false + * @example false + */ allow_auto_merge?: boolean - /** @description Whether to delete head branches when pull requests are merged */ + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + * @example false + */ delete_branch_on_merge?: boolean /** * @description Whether to allow merge commits for pull requests. @@ -10859,7 +10922,11 @@ export interface components { * @example true */ allow_merge_commit?: boolean - /** @description Whether to allow forking this repo */ + /** + * @description Whether to allow forking this repo + * @default false + * @example false + */ allow_forking?: boolean subscribers_count?: number network_count?: number @@ -10897,7 +10964,10 @@ export interface components { * @example 2016-09-05T14:20:22Z */ updated_at: string - /** @description Whether or not the card is archived */ + /** + * @description Whether or not the card is archived + * @example false + */ archived?: boolean column_name?: string project_id?: string @@ -11183,6 +11253,7 @@ export interface components { size: number /** @example master */ default_branch: string + /** @example 0 */ open_issues_count: number /** @example true */ is_template?: boolean @@ -11233,7 +11304,9 @@ export interface components { temp_clone_token?: string | null /** @example true */ allow_squash_merge?: boolean + /** @example false */ allow_auto_merge?: boolean + /** @example false */ delete_branch_on_merge?: boolean /** @example true */ allow_merge_commit?: boolean @@ -11241,6 +11314,7 @@ export interface components { allow_forking?: boolean /** @example 42 */ subscribers_count: number + /** @example 0 */ network_count: number license: components['schemas']['nullable-license-simple'] organization?: components['schemas']['nullable-simple-user'] @@ -12042,6 +12116,7 @@ export interface components { received_events_url?: string /** @example "Organization" */ type?: string + /** @example false */ site_admin?: boolean } & { [key: string]: unknown } name?: string @@ -12207,6 +12282,7 @@ export interface components { committer: components['schemas']['nullable-git-user'] /** @example Fix all the bugs */ message: string + /** @example 0 */ comment_count: number tree: { /** @example 827efc6d56897b048c772eb4087f854f46256132 */ @@ -12783,7 +12859,10 @@ export interface components { billable_owner: components['schemas']['simple-user'] repository: components['schemas']['minimal-repository'] machine: components['schemas']['nullable-codespace-machine'] - /** @description Whether the codespace was created from a prebuild. */ + /** + * @description Whether the codespace was created from a prebuild. + * @example false + */ prebuild: boolean | null /** * Format: date-time @@ -12831,9 +12910,15 @@ export interface components { url: string /** @description Details about the codespace's git repository. */ git_status: { - /** @description The number of commits the local repository is ahead of the remote. */ + /** + * @description The number of commits the local repository is ahead of the remote. + * @example 0 + */ ahead?: number - /** @description The number of commits the local repository is behind the remote. */ + /** + * @description The number of commits the local repository is behind the remote. + * @example 0 + */ behind?: number /** @description Whether the local repository has unpushed changes. */ has_unpushed_changes?: boolean @@ -13321,7 +13406,10 @@ export interface components { } & { [key: string]: unknown } author_association: components['schemas']['author_association'] auto_merge: components['schemas']['auto_merge'] - /** @description Indicates whether or not the pull request is a draft. */ + /** + * @description Indicates whether or not the pull request is a draft. + * @example false + */ draft?: boolean } & { [key: string]: unknown } /** Simple Commit Status */ @@ -13781,17 +13869,20 @@ export interface components { creator: components['schemas']['nullable-simple-user'] /** * @description A short description of the status. + * @default * @example Deployment finished successfully. */ description: string /** * @description The environment of the deployment that the status is for. + * @default * @example production */ environment?: string /** * Format: uri * @description Deprecated: the URL to associate with this status. + * @default * @example https://example.com/deployment/42/output */ target_url: string @@ -13818,12 +13909,14 @@ export interface components { /** * Format: uri * @description The URL for accessing your environment. + * @default * @example https://staging.example.com/ */ environment_url?: string /** * Format: uri * @description The URL to associate with this status. + * @default * @example https://example.com/deployment/42/output */ log_url?: string @@ -15422,7 +15515,11 @@ export interface components { * @description The timestamp when a pending domain becomes unverified. */ pending_domain_unverified_at?: string | null - /** @description Whether the Page has a custom 404 page. */ + /** + * @description Whether the Page has a custom 404 page. + * @default false + * @example false + */ custom_404: boolean /** * Format: uri @@ -16086,7 +16183,10 @@ export interface components { } & { [key: string]: unknown } author_association: components['schemas']['author_association'] auto_merge: components['schemas']['auto_merge'] - /** @description Indicates whether or not the pull request is a draft. */ + /** + * @description Indicates whether or not the pull request is a draft. + * @example false + */ draft?: boolean merged: boolean /** @example true */ @@ -16098,6 +16198,7 @@ export interface components { merged_by: components['schemas']['nullable-simple-user'] /** @example 10 */ comments: number + /** @example 0 */ review_comments: number /** * @description Indicates whether maintainers can modify the pull request. @@ -16335,9 +16436,15 @@ export interface components { target_commitish: string name: string | null body?: string | null - /** @description true to create a draft (unpublished) release, false to create a published one. */ + /** + * @description true to create a draft (unpublished) release, false to create a published one. + * @example false + */ draft: boolean - /** @description Whether to identify the release as a prerelease or a full release. */ + /** + * @description Whether to identify the release as a prerelease or a full release. + * @example false + */ prerelease: boolean /** Format: date-time */ created_at: string @@ -17254,6 +17361,7 @@ export interface components { public_gists: number /** @example 20 */ followers: number + /** @example 0 */ following: number /** * Format: date-time @@ -19122,7 +19230,10 @@ export interface operations { selected_organization_ids?: number[] /** @description List of runner IDs to add to the runner group. */ runners?: number[] - /** @description Whether the runner group can be used by `public` repositories. */ + /** + * @description Whether the runner group can be used by `public` repositories. + * @default false + */ allows_public_repositories?: boolean } & { [key: string]: unknown } } @@ -19203,7 +19314,10 @@ export interface operations { * @enum {string} */ visibility?: 'selected' | 'all' - /** @description Whether the runner group can be used by `public` repositories. */ + /** + * @description Whether the runner group can be used by `public` repositories. + * @default false + */ allows_public_repositories?: boolean } & { [key: string]: unknown } } @@ -20975,7 +21089,10 @@ export interface operations { requestBody: { content: { 'application/json': { - /** @description Whether to block all notifications from a thread. */ + /** + * @description Whether to block all notifications from a thread. + * @default false + */ ignored?: boolean } & { [key: string]: unknown } } @@ -21235,6 +21352,7 @@ export interface operations { * @description Toggles whether organization members can fork private organization repositories. Can be one of: * \* `true` - all organization members can fork private repositories within the organization. * \* `false` - no organization members can fork private repositories within the organization. + * @default false */ members_can_fork_private_repositories?: boolean /** @example "http://github.blog" */ @@ -21531,7 +21649,10 @@ export interface operations { selected_repository_ids?: number[] /** @description List of runner IDs to add to the runner group. */ runners?: number[] - /** @description Whether the runner group can be used by `public` repositories. */ + /** + * @description Whether the runner group can be used by `public` repositories. + * @default false + */ allows_public_repositories?: boolean } & { [key: string]: unknown } } @@ -21614,7 +21735,10 @@ export interface operations { * @enum {string} */ visibility?: 'selected' | 'all' | 'private' - /** @description Whether the runner group can be used by `public` repositories. */ + /** + * @description Whether the runner group can be used by `public` repositories. + * @default false + */ allows_public_repositories?: boolean } & { [key: string]: unknown } } @@ -23672,21 +23796,25 @@ export interface operations { repositories: string[] /** * @description Indicates whether repositories should be locked (to prevent manipulation) while migrating data. + * @default false * @example true */ lock_repositories?: boolean /** * @description Indicates whether attachments should be excluded from the migration (to reduce migration archive file size). + * @default false * @example true */ exclude_attachments?: boolean /** * @description Indicates whether releases should be excluded from the migration (to reduce migration archive file size). + * @default false * @example true */ exclude_releases?: boolean /** * @description Indicates whether projects owned by the organization or users should be excluded. from the migration. + * @default false * @example true */ exclude_owner_projects?: boolean @@ -24302,7 +24430,10 @@ export interface operations { description?: string /** @description A URL with more information about the repository. */ homepage?: string - /** @description Whether the repository is private. */ + /** + * @description Whether the repository is private. + * @default false + */ private?: boolean /** * @description Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see "[Creating an internal repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)" in the GitHub Help documentation. @@ -24324,11 +24455,17 @@ export interface operations { * @default true */ has_wiki?: boolean - /** @description Either `true` to make this repo available as a template repository or `false` to prevent it. */ + /** + * @description Either `true` to make this repo available as a template repository or `false` to prevent it. + * @default false + */ is_template?: boolean /** @description The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. */ team_id?: number - /** @description Pass `true` to create an initial commit with empty README. */ + /** + * @description Pass `true` to create an initial commit with empty README. + * @default false + */ auto_init?: boolean /** @description Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, "Haskell". */ gitignore_template?: string @@ -24349,9 +24486,15 @@ export interface operations { * @default true */ allow_rebase_merge?: boolean - /** @description Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. */ + /** + * @description Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. + * @default false + */ allow_auto_merge?: boolean - /** @description Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. */ + /** + * @description Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. + * @default false + */ delete_branch_on_merge?: boolean } & { [key: string]: unknown } } @@ -24760,7 +24903,10 @@ export interface operations { title: string /** @description The discussion post's body text. */ body: string - /** @description Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. */ + /** + * @description Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. + * @default false + */ private?: boolean } & { [key: string]: unknown } } @@ -25797,7 +25943,10 @@ export interface operations { * @example Update all gems */ note?: string | null - /** @description Whether or not the card is archived */ + /** + * @description Whether or not the card is archived + * @example false + */ archived?: boolean } & { [key: string]: unknown } } @@ -26445,6 +26594,7 @@ export interface operations { /** * @description Either `true` to make the repository private or `false` to make it public. Default: `false`. * **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. + * @default false */ private?: boolean /** @@ -26482,7 +26632,10 @@ export interface operations { * @default true */ has_wiki?: boolean - /** @description Either `true` to make this repo available as a template repository or `false` to prevent it. */ + /** + * @description Either `true` to make this repo available as a template repository or `false` to prevent it. + * @default false + */ is_template?: boolean /** @description Updates the default branch for this repository. */ default_branch?: string @@ -26501,13 +26654,25 @@ export interface operations { * @default true */ allow_rebase_merge?: boolean - /** @description Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. */ + /** + * @description Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. + * @default false + */ allow_auto_merge?: boolean - /** @description Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. */ + /** + * @description Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. + * @default false + */ delete_branch_on_merge?: boolean - /** @description `true` to archive this repository. **Note**: You cannot unarchive repositories through the API. */ + /** + * @description `true` to archive this repository. **Note**: You cannot unarchive repositories through the API. + * @default false + */ archived?: boolean - /** @description Either `true` to allow private forks, or `false` to prevent private forks. */ + /** + * @description Either `true` to allow private forks, or `false` to prevent private forks. + * @default false + */ allow_forking?: boolean } & { [key: string]: unknown } } @@ -31479,9 +31644,15 @@ export interface operations { * @default production */ environment?: string - /** @description Short description of the deployment. */ + /** + * @description Short description of the deployment. + * @default + */ description?: string | null - /** @description Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false` */ + /** + * @description Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false` + * @default false + */ transient_environment?: boolean /** @description Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise. */ production_environment?: boolean @@ -31595,18 +31766,30 @@ export interface operations { * @enum {string} */ state: 'error' | 'failure' | 'inactive' | 'in_progress' | 'queued' | 'pending' | 'success' - /** @description The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`. */ + /** + * @description The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`. + * @default + */ target_url?: string - /** @description The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `""` */ + /** + * @description The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `""` + * @default + */ log_url?: string - /** @description A short description of the status. The maximum description length is 140 characters. */ + /** + * @description A short description of the status. The maximum description length is 140 characters. + * @default + */ description?: string /** * @description Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. * @enum {string} */ environment?: 'production' | 'staging' | 'qa' - /** @description Sets the URL for accessing your environment. Default: `""` */ + /** + * @description Sets the URL for accessing your environment. Default: `""` + * @default + */ environment_url?: string /** @description Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true` */ auto_inactive?: boolean @@ -32199,7 +32382,10 @@ export interface operations { 'application/json': { /** @description The SHA1 value to set this reference to */ sha: string - /** @description Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work. */ + /** + * @description Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work. + * @default false + */ force?: boolean } & { [key: string]: unknown } } @@ -36010,13 +36196,22 @@ export interface operations { name?: string /** @description Text describing the contents of the tag. */ body?: string - /** @description `true` to create a draft (unpublished) release, `false` to create a published one. */ + /** + * @description `true` to create a draft (unpublished) release, `false` to create a published one. + * @default false + */ draft?: boolean - /** @description `true` to identify the release as a prerelease. `false` to identify the release as a full release. */ + /** + * @description `true` to identify the release as a prerelease. `false` to identify the release as a full release. + * @default false + */ prerelease?: boolean /** @description If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see "[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." */ discussion_category_name?: string - /** @description Whether to automatically generate the name and body for this release. If `name` is specified, the specified name will be used; otherwise, a name will be automatically generated. If `body` is specified, the body will be pre-pended to the automatically generated notes. */ + /** + * @description Whether to automatically generate the name and body for this release. If `name` is specified, the specified name will be used; otherwise, a name will be automatically generated. If `body` is specified, the body will be pre-pended to the automatically generated notes. + * @default false + */ generate_release_notes?: boolean } & { [key: string]: unknown } } @@ -37087,9 +37282,15 @@ export interface operations { name: string /** @description A short description of the new repository. */ description?: string - /** @description Set to `true` to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: `false`. */ + /** + * @description Set to `true` to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: `false`. + * @default false + */ include_all_branches?: boolean - /** @description Either `true` to create a new private repository or `false` to create a new public one. */ + /** + * @description Either `true` to create a new private repository or `false` to create a new public one. + * @default false + */ private?: boolean } & { [key: string]: unknown } } @@ -38475,7 +38676,10 @@ export interface operations { title: string /** @description The discussion post's body text. */ body: string - /** @description Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. */ + /** + * @description Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. + * @default false + */ private?: boolean } & { [key: string]: unknown } } @@ -41404,7 +41608,10 @@ export interface operations { description?: string /** @description A URL with more information about the repository. */ homepage?: string - /** @description Whether the repository is private. */ + /** + * @description Whether the repository is private. + * @default false + */ private?: boolean /** * @description Whether issues are enabled. @@ -41426,7 +41633,10 @@ export interface operations { has_wiki?: boolean /** @description The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. */ team_id?: number - /** @description Whether the repository is initialized with a minimal README. */ + /** + * @description Whether the repository is initialized with a minimal README. + * @default false + */ auto_init?: boolean /** * @description The desired language or platform to apply to the .gitignore. @@ -41456,9 +41666,17 @@ export interface operations { * @example true */ allow_rebase_merge?: boolean - /** @description Whether to allow Auto-merge to be used on pull requests. */ + /** + * @description Whether to allow Auto-merge to be used on pull requests. + * @default false + * @example false + */ allow_auto_merge?: boolean - /** @description Whether to delete head branches when pull requests are merged */ + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + * @example false + */ delete_branch_on_merge?: boolean /** * @description Whether downloads are enabled. @@ -41468,6 +41686,7 @@ export interface operations { has_downloads?: boolean /** * @description Whether this repository acts as a template that can be used to generate new repositories. + * @default false * @example true */ is_template?: boolean diff --git a/test/v3/expected/github.exported-type.ts b/test/v3/expected/github.exported-type.ts index 229657c6b..c2a2104eb 100644 --- a/test/v3/expected/github.exported-type.ts +++ b/test/v3/expected/github.exported-type.ts @@ -6180,7 +6180,10 @@ export type components = { * @example 2021-05-12T20:33:44Z */ delivered_at: string - /** @description Whether the webhook delivery is a redelivery. */ + /** + * @description Whether the webhook delivery is a redelivery. + * @example false + */ redelivery: boolean /** * @description Time spent delivering. @@ -6267,7 +6270,10 @@ export type components = { * @example 2021-05-12T20:33:44Z */ delivered_at: string - /** @description Whether the delivery is a redelivery. */ + /** + * @description Whether the delivery is a redelivery. + * @example false + */ redelivery: boolean /** * @description Time spent delivering. @@ -6703,7 +6709,10 @@ export type components = { maintain?: boolean } owner: components['schemas']['simple-user'] - /** @description Whether the repository is private or public. */ + /** + * @description Whether the repository is private or public. + * @default false + */ private: boolean /** * Format: uri @@ -6864,9 +6873,11 @@ export type components = { * @example master */ default_branch: string + /** @example 0 */ open_issues_count: number /** * @description Whether this repository acts as a template that can be used to generate new repositories. + * @default false * @example true */ is_template?: boolean @@ -6896,7 +6907,10 @@ export type components = { * @example true */ has_downloads: boolean - /** @description Whether the repository is archived. */ + /** + * @description Whether the repository is archived. + * @default false + */ archived: boolean /** @description Returns whether or not this repository disabled. */ disabled: boolean @@ -7042,9 +7056,17 @@ export type components = { * @example true */ allow_squash_merge?: boolean - /** @description Whether to allow Auto-merge to be used on pull requests. */ + /** + * @description Whether to allow Auto-merge to be used on pull requests. + * @default false + * @example false + */ allow_auto_merge?: boolean - /** @description Whether to delete head branches when pull requests are merged */ + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + * @example false + */ delete_branch_on_merge?: boolean /** * @description Whether to allow merge commits for pull requests. @@ -7506,7 +7528,10 @@ export type components = { maintain?: boolean } owner: components['schemas']['simple-user'] - /** @description Whether the repository is private or public. */ + /** + * @description Whether the repository is private or public. + * @default false + */ private: boolean /** * Format: uri @@ -7667,9 +7692,11 @@ export type components = { * @example master */ default_branch: string + /** @example 0 */ open_issues_count: number /** * @description Whether this repository acts as a template that can be used to generate new repositories. + * @default false * @example true */ is_template?: boolean @@ -7699,7 +7726,10 @@ export type components = { * @example true */ has_downloads: boolean - /** @description Whether the repository is archived. */ + /** + * @description Whether the repository is archived. + * @default false + */ archived: boolean /** @description Returns whether or not this repository disabled. */ disabled: boolean @@ -7845,9 +7875,17 @@ export type components = { * @example true */ allow_squash_merge?: boolean - /** @description Whether to allow Auto-merge to be used on pull requests. */ + /** + * @description Whether to allow Auto-merge to be used on pull requests. + * @default false + * @example false + */ allow_auto_merge?: boolean - /** @description Whether to delete head branches when pull requests are merged */ + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + * @example false + */ delete_branch_on_merge?: boolean /** * @description Whether to allow merge commits for pull requests. @@ -8064,8 +8102,11 @@ export type components = { url?: string node_id?: string } | null + /** @example 0 */ forks?: number + /** @example 0 */ open_issues?: number + /** @example 0 */ watchers?: number allow_forking?: boolean } @@ -9172,6 +9213,7 @@ export type components = { public_gists: number /** @example 20 */ followers: number + /** @example 0 */ following: number /** * Format: uri @@ -9226,6 +9268,7 @@ export type components = { members_can_create_public_pages?: boolean /** @example true */ members_can_create_private_pages?: boolean + /** @example false */ members_can_fork_private_repositories?: boolean | null /** Format: date-time */ updated_at: string @@ -10080,8 +10123,11 @@ export type components = { url?: string node_id?: string } | null + /** @example 0 */ forks?: number + /** @example 0 */ open_issues?: number + /** @example 0 */ watchers?: number allow_forking?: boolean } | null @@ -10376,6 +10422,7 @@ export type components = { * @example 0307116bbf7ced493b8d8a346c650b71 */ body_version: string + /** @example 0 */ comments_count: number /** * Format: uri @@ -10588,7 +10635,10 @@ export type components = { /** @example admin */ role_name?: string owner: components['schemas']['nullable-simple-user'] - /** @description Whether the repository is private or public. */ + /** + * @description Whether the repository is private or public. + * @default false + */ private: boolean /** * Format: uri @@ -10749,9 +10799,11 @@ export type components = { * @example master */ default_branch: string + /** @example 0 */ open_issues_count: number /** * @description Whether this repository acts as a template that can be used to generate new repositories. + * @default false * @example true */ is_template?: boolean @@ -10781,7 +10833,10 @@ export type components = { * @example true */ has_downloads: boolean - /** @description Whether the repository is archived. */ + /** + * @description Whether the repository is archived. + * @default false + */ archived: boolean /** @description Returns whether or not this repository disabled. */ disabled: boolean @@ -10819,9 +10874,17 @@ export type components = { * @example true */ allow_squash_merge?: boolean - /** @description Whether to allow Auto-merge to be used on pull requests. */ + /** + * @description Whether to allow Auto-merge to be used on pull requests. + * @default false + * @example false + */ allow_auto_merge?: boolean - /** @description Whether to delete head branches when pull requests are merged */ + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + * @example false + */ delete_branch_on_merge?: boolean /** * @description Whether to allow merge commits for pull requests. @@ -10829,7 +10892,11 @@ export type components = { * @example true */ allow_merge_commit?: boolean - /** @description Whether to allow forking this repo */ + /** + * @description Whether to allow forking this repo + * @default false + * @example false + */ allow_forking?: boolean subscribers_count?: number network_count?: number @@ -10867,7 +10934,10 @@ export type components = { * @example 2016-09-05T14:20:22Z */ updated_at: string - /** @description Whether or not the card is archived */ + /** + * @description Whether or not the card is archived + * @example false + */ archived?: boolean column_name?: string project_id?: string @@ -11153,6 +11223,7 @@ export type components = { size: number /** @example master */ default_branch: string + /** @example 0 */ open_issues_count: number /** @example true */ is_template?: boolean @@ -11203,7 +11274,9 @@ export type components = { temp_clone_token?: string | null /** @example true */ allow_squash_merge?: boolean + /** @example false */ allow_auto_merge?: boolean + /** @example false */ delete_branch_on_merge?: boolean /** @example true */ allow_merge_commit?: boolean @@ -11211,6 +11284,7 @@ export type components = { allow_forking?: boolean /** @example 42 */ subscribers_count: number + /** @example 0 */ network_count: number license: components['schemas']['nullable-license-simple'] organization?: components['schemas']['nullable-simple-user'] @@ -12002,6 +12076,7 @@ export type components = { received_events_url?: string /** @example "Organization" */ type?: string + /** @example false */ site_admin?: boolean } name?: string @@ -12165,6 +12240,7 @@ export type components = { committer: components['schemas']['nullable-git-user'] /** @example Fix all the bugs */ message: string + /** @example 0 */ comment_count: number tree: { /** @example 827efc6d56897b048c772eb4087f854f46256132 */ @@ -12733,7 +12809,10 @@ export type components = { billable_owner: components['schemas']['simple-user'] repository: components['schemas']['minimal-repository'] machine: components['schemas']['nullable-codespace-machine'] - /** @description Whether the codespace was created from a prebuild. */ + /** + * @description Whether the codespace was created from a prebuild. + * @example false + */ prebuild: boolean | null /** * Format: date-time @@ -12781,9 +12860,15 @@ export type components = { url: string /** @description Details about the codespace's git repository. */ git_status: { - /** @description The number of commits the local repository is ahead of the remote. */ + /** + * @description The number of commits the local repository is ahead of the remote. + * @example 0 + */ ahead?: number - /** @description The number of commits the local repository is behind the remote. */ + /** + * @description The number of commits the local repository is behind the remote. + * @example 0 + */ behind?: number /** @description Whether the local repository has unpushed changes. */ has_unpushed_changes?: boolean @@ -13267,7 +13352,10 @@ export type components = { } author_association: components['schemas']['author_association'] auto_merge: components['schemas']['auto_merge'] - /** @description Indicates whether or not the pull request is a draft. */ + /** + * @description Indicates whether or not the pull request is a draft. + * @example false + */ draft?: boolean } /** Simple Commit Status */ @@ -13721,17 +13809,20 @@ export type components = { creator: components['schemas']['nullable-simple-user'] /** * @description A short description of the status. + * @default * @example Deployment finished successfully. */ description: string /** * @description The environment of the deployment that the status is for. + * @default * @example production */ environment?: string /** * Format: uri * @description Deprecated: the URL to associate with this status. + * @default * @example https://example.com/deployment/42/output */ target_url: string @@ -13758,12 +13849,14 @@ export type components = { /** * Format: uri * @description The URL for accessing your environment. + * @default * @example https://staging.example.com/ */ environment_url?: string /** * Format: uri * @description The URL to associate with this status. + * @default * @example https://example.com/deployment/42/output */ log_url?: string @@ -15352,7 +15445,11 @@ export type components = { * @description The timestamp when a pending domain becomes unverified. */ pending_domain_unverified_at?: string | null - /** @description Whether the Page has a custom 404 page. */ + /** + * @description Whether the Page has a custom 404 page. + * @default false + * @example false + */ custom_404: boolean /** * Format: uri @@ -16010,7 +16107,10 @@ export type components = { } author_association: components['schemas']['author_association'] auto_merge: components['schemas']['auto_merge'] - /** @description Indicates whether or not the pull request is a draft. */ + /** + * @description Indicates whether or not the pull request is a draft. + * @example false + */ draft?: boolean merged: boolean /** @example true */ @@ -16022,6 +16122,7 @@ export type components = { merged_by: components['schemas']['nullable-simple-user'] /** @example 10 */ comments: number + /** @example 0 */ review_comments: number /** * @description Indicates whether maintainers can modify the pull request. @@ -16259,9 +16360,15 @@ export type components = { target_commitish: string name: string | null body?: string | null - /** @description true to create a draft (unpublished) release, false to create a published one. */ + /** + * @description true to create a draft (unpublished) release, false to create a published one. + * @example false + */ draft: boolean - /** @description Whether to identify the release as a prerelease or a full release. */ + /** + * @description Whether to identify the release as a prerelease or a full release. + * @example false + */ prerelease: boolean /** Format: date-time */ created_at: string @@ -17178,6 +17285,7 @@ export type components = { public_gists: number /** @example 20 */ followers: number + /** @example 0 */ following: number /** * Format: date-time @@ -19046,7 +19154,10 @@ export type operations = { selected_organization_ids?: number[] /** @description List of runner IDs to add to the runner group. */ runners?: number[] - /** @description Whether the runner group can be used by `public` repositories. */ + /** + * @description Whether the runner group can be used by `public` repositories. + * @default false + */ allows_public_repositories?: boolean } } @@ -19127,7 +19238,10 @@ export type operations = { * @enum {string} */ visibility?: 'selected' | 'all' - /** @description Whether the runner group can be used by `public` repositories. */ + /** + * @description Whether the runner group can be used by `public` repositories. + * @default false + */ allows_public_repositories?: boolean } } @@ -20897,7 +21011,10 @@ export type operations = { requestBody: { content: { 'application/json': { - /** @description Whether to block all notifications from a thread. */ + /** + * @description Whether to block all notifications from a thread. + * @default false + */ ignored?: boolean } } @@ -21155,6 +21272,7 @@ export type operations = { * @description Toggles whether organization members can fork private organization repositories. Can be one of: * \* `true` - all organization members can fork private repositories within the organization. * \* `false` - no organization members can fork private repositories within the organization. + * @default false */ members_can_fork_private_repositories?: boolean /** @example "http://github.blog" */ @@ -21451,7 +21569,10 @@ export type operations = { selected_repository_ids?: number[] /** @description List of runner IDs to add to the runner group. */ runners?: number[] - /** @description Whether the runner group can be used by `public` repositories. */ + /** + * @description Whether the runner group can be used by `public` repositories. + * @default false + */ allows_public_repositories?: boolean } } @@ -21534,7 +21655,10 @@ export type operations = { * @enum {string} */ visibility?: 'selected' | 'all' | 'private' - /** @description Whether the runner group can be used by `public` repositories. */ + /** + * @description Whether the runner group can be used by `public` repositories. + * @default false + */ allows_public_repositories?: boolean } } @@ -23590,21 +23714,25 @@ export type operations = { repositories: string[] /** * @description Indicates whether repositories should be locked (to prevent manipulation) while migrating data. + * @default false * @example true */ lock_repositories?: boolean /** * @description Indicates whether attachments should be excluded from the migration (to reduce migration archive file size). + * @default false * @example true */ exclude_attachments?: boolean /** * @description Indicates whether releases should be excluded from the migration (to reduce migration archive file size). + * @default false * @example true */ exclude_releases?: boolean /** * @description Indicates whether projects owned by the organization or users should be excluded. from the migration. + * @default false * @example true */ exclude_owner_projects?: boolean @@ -24220,7 +24348,10 @@ export type operations = { description?: string /** @description A URL with more information about the repository. */ homepage?: string - /** @description Whether the repository is private. */ + /** + * @description Whether the repository is private. + * @default false + */ private?: boolean /** * @description Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see "[Creating an internal repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)" in the GitHub Help documentation. @@ -24242,11 +24373,17 @@ export type operations = { * @default true */ has_wiki?: boolean - /** @description Either `true` to make this repo available as a template repository or `false` to prevent it. */ + /** + * @description Either `true` to make this repo available as a template repository or `false` to prevent it. + * @default false + */ is_template?: boolean /** @description The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. */ team_id?: number - /** @description Pass `true` to create an initial commit with empty README. */ + /** + * @description Pass `true` to create an initial commit with empty README. + * @default false + */ auto_init?: boolean /** @description Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, "Haskell". */ gitignore_template?: string @@ -24267,9 +24404,15 @@ export type operations = { * @default true */ allow_rebase_merge?: boolean - /** @description Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. */ + /** + * @description Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. + * @default false + */ allow_auto_merge?: boolean - /** @description Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. */ + /** + * @description Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. + * @default false + */ delete_branch_on_merge?: boolean } } @@ -24678,7 +24821,10 @@ export type operations = { title: string /** @description The discussion post's body text. */ body: string - /** @description Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. */ + /** + * @description Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. + * @default false + */ private?: boolean } } @@ -25713,7 +25859,10 @@ export type operations = { * @example Update all gems */ note?: string | null - /** @description Whether or not the card is archived */ + /** + * @description Whether or not the card is archived + * @example false + */ archived?: boolean } } @@ -26356,6 +26505,7 @@ export type operations = { /** * @description Either `true` to make the repository private or `false` to make it public. Default: `false`. * **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. + * @default false */ private?: boolean /** @@ -26391,7 +26541,10 @@ export type operations = { * @default true */ has_wiki?: boolean - /** @description Either `true` to make this repo available as a template repository or `false` to prevent it. */ + /** + * @description Either `true` to make this repo available as a template repository or `false` to prevent it. + * @default false + */ is_template?: boolean /** @description Updates the default branch for this repository. */ default_branch?: string @@ -26410,13 +26563,25 @@ export type operations = { * @default true */ allow_rebase_merge?: boolean - /** @description Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. */ + /** + * @description Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. + * @default false + */ allow_auto_merge?: boolean - /** @description Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. */ + /** + * @description Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. + * @default false + */ delete_branch_on_merge?: boolean - /** @description `true` to archive this repository. **Note**: You cannot unarchive repositories through the API. */ + /** + * @description `true` to archive this repository. **Note**: You cannot unarchive repositories through the API. + * @default false + */ archived?: boolean - /** @description Either `true` to allow private forks, or `false` to prevent private forks. */ + /** + * @description Either `true` to allow private forks, or `false` to prevent private forks. + * @default false + */ allow_forking?: boolean } } @@ -31365,9 +31530,15 @@ export type operations = { * @default production */ environment?: string - /** @description Short description of the deployment. */ + /** + * @description Short description of the deployment. + * @default + */ description?: string | null - /** @description Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false` */ + /** + * @description Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false` + * @default false + */ transient_environment?: boolean /** @description Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise. */ production_environment?: boolean @@ -31481,18 +31652,30 @@ export type operations = { * @enum {string} */ state: 'error' | 'failure' | 'inactive' | 'in_progress' | 'queued' | 'pending' | 'success' - /** @description The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`. */ + /** + * @description The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`. + * @default + */ target_url?: string - /** @description The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `""` */ + /** + * @description The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `""` + * @default + */ log_url?: string - /** @description A short description of the status. The maximum description length is 140 characters. */ + /** + * @description A short description of the status. The maximum description length is 140 characters. + * @default + */ description?: string /** * @description Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. * @enum {string} */ environment?: 'production' | 'staging' | 'qa' - /** @description Sets the URL for accessing your environment. Default: `""` */ + /** + * @description Sets the URL for accessing your environment. Default: `""` + * @default + */ environment_url?: string /** @description Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true` */ auto_inactive?: boolean @@ -32083,7 +32266,10 @@ export type operations = { 'application/json': { /** @description The SHA1 value to set this reference to */ sha: string - /** @description Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work. */ + /** + * @description Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work. + * @default false + */ force?: boolean } } @@ -35878,13 +36064,22 @@ export type operations = { name?: string /** @description Text describing the contents of the tag. */ body?: string - /** @description `true` to create a draft (unpublished) release, `false` to create a published one. */ + /** + * @description `true` to create a draft (unpublished) release, `false` to create a published one. + * @default false + */ draft?: boolean - /** @description `true` to identify the release as a prerelease. `false` to identify the release as a full release. */ + /** + * @description `true` to identify the release as a prerelease. `false` to identify the release as a full release. + * @default false + */ prerelease?: boolean /** @description If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see "[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." */ discussion_category_name?: string - /** @description Whether to automatically generate the name and body for this release. If `name` is specified, the specified name will be used; otherwise, a name will be automatically generated. If `body` is specified, the body will be pre-pended to the automatically generated notes. */ + /** + * @description Whether to automatically generate the name and body for this release. If `name` is specified, the specified name will be used; otherwise, a name will be automatically generated. If `body` is specified, the body will be pre-pended to the automatically generated notes. + * @default false + */ generate_release_notes?: boolean } } @@ -36953,9 +37148,15 @@ export type operations = { name: string /** @description A short description of the new repository. */ description?: string - /** @description Set to `true` to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: `false`. */ + /** + * @description Set to `true` to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: `false`. + * @default false + */ include_all_branches?: boolean - /** @description Either `true` to create a new private repository or `false` to create a new public one. */ + /** + * @description Either `true` to create a new private repository or `false` to create a new public one. + * @default false + */ private?: boolean } } @@ -38340,7 +38541,10 @@ export type operations = { title: string /** @description The discussion post's body text. */ body: string - /** @description Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. */ + /** + * @description Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. + * @default false + */ private?: boolean } } @@ -41264,7 +41468,10 @@ export type operations = { description?: string /** @description A URL with more information about the repository. */ homepage?: string - /** @description Whether the repository is private. */ + /** + * @description Whether the repository is private. + * @default false + */ private?: boolean /** * @description Whether issues are enabled. @@ -41286,7 +41493,10 @@ export type operations = { has_wiki?: boolean /** @description The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. */ team_id?: number - /** @description Whether the repository is initialized with a minimal README. */ + /** + * @description Whether the repository is initialized with a minimal README. + * @default false + */ auto_init?: boolean /** * @description The desired language or platform to apply to the .gitignore. @@ -41316,9 +41526,17 @@ export type operations = { * @example true */ allow_rebase_merge?: boolean - /** @description Whether to allow Auto-merge to be used on pull requests. */ + /** + * @description Whether to allow Auto-merge to be used on pull requests. + * @default false + * @example false + */ allow_auto_merge?: boolean - /** @description Whether to delete head branches when pull requests are merged */ + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + * @example false + */ delete_branch_on_merge?: boolean /** * @description Whether downloads are enabled. @@ -41328,6 +41546,7 @@ export type operations = { has_downloads?: boolean /** * @description Whether this repository acts as a template that can be used to generate new repositories. + * @default false * @example true */ is_template?: boolean diff --git a/test/v3/expected/github.immutable.ts b/test/v3/expected/github.immutable.ts index 044fbd1b0..22ff2c357 100644 --- a/test/v3/expected/github.immutable.ts +++ b/test/v3/expected/github.immutable.ts @@ -6180,7 +6180,10 @@ export interface components { * @example 2021-05-12T20:33:44Z */ readonly delivered_at: string - /** @description Whether the webhook delivery is a redelivery. */ + /** + * @description Whether the webhook delivery is a redelivery. + * @example false + */ readonly redelivery: boolean /** * @description Time spent delivering. @@ -6267,7 +6270,10 @@ export interface components { * @example 2021-05-12T20:33:44Z */ readonly delivered_at: string - /** @description Whether the delivery is a redelivery. */ + /** + * @description Whether the delivery is a redelivery. + * @example false + */ readonly redelivery: boolean /** * @description Time spent delivering. @@ -6703,7 +6709,10 @@ export interface components { readonly maintain?: boolean } readonly owner: components['schemas']['simple-user'] - /** @description Whether the repository is private or public. */ + /** + * @description Whether the repository is private or public. + * @default false + */ readonly private: boolean /** * Format: uri @@ -6864,9 +6873,11 @@ export interface components { * @example master */ readonly default_branch: string + /** @example 0 */ readonly open_issues_count: number /** * @description Whether this repository acts as a template that can be used to generate new repositories. + * @default false * @example true */ readonly is_template?: boolean @@ -6896,7 +6907,10 @@ export interface components { * @example true */ readonly has_downloads: boolean - /** @description Whether the repository is archived. */ + /** + * @description Whether the repository is archived. + * @default false + */ readonly archived: boolean /** @description Returns whether or not this repository disabled. */ readonly disabled: boolean @@ -7042,9 +7056,17 @@ export interface components { * @example true */ readonly allow_squash_merge?: boolean - /** @description Whether to allow Auto-merge to be used on pull requests. */ + /** + * @description Whether to allow Auto-merge to be used on pull requests. + * @default false + * @example false + */ readonly allow_auto_merge?: boolean - /** @description Whether to delete head branches when pull requests are merged */ + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + * @example false + */ readonly delete_branch_on_merge?: boolean /** * @description Whether to allow merge commits for pull requests. @@ -7506,7 +7528,10 @@ export interface components { readonly maintain?: boolean } readonly owner: components['schemas']['simple-user'] - /** @description Whether the repository is private or public. */ + /** + * @description Whether the repository is private or public. + * @default false + */ readonly private: boolean /** * Format: uri @@ -7667,9 +7692,11 @@ export interface components { * @example master */ readonly default_branch: string + /** @example 0 */ readonly open_issues_count: number /** * @description Whether this repository acts as a template that can be used to generate new repositories. + * @default false * @example true */ readonly is_template?: boolean @@ -7699,7 +7726,10 @@ export interface components { * @example true */ readonly has_downloads: boolean - /** @description Whether the repository is archived. */ + /** + * @description Whether the repository is archived. + * @default false + */ readonly archived: boolean /** @description Returns whether or not this repository disabled. */ readonly disabled: boolean @@ -7845,9 +7875,17 @@ export interface components { * @example true */ readonly allow_squash_merge?: boolean - /** @description Whether to allow Auto-merge to be used on pull requests. */ + /** + * @description Whether to allow Auto-merge to be used on pull requests. + * @default false + * @example false + */ readonly allow_auto_merge?: boolean - /** @description Whether to delete head branches when pull requests are merged */ + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + * @example false + */ readonly delete_branch_on_merge?: boolean /** * @description Whether to allow merge commits for pull requests. @@ -8064,8 +8102,11 @@ export interface components { readonly url?: string readonly node_id?: string } | null + /** @example 0 */ readonly forks?: number + /** @example 0 */ readonly open_issues?: number + /** @example 0 */ readonly watchers?: number readonly allow_forking?: boolean } @@ -9172,6 +9213,7 @@ export interface components { readonly public_gists: number /** @example 20 */ readonly followers: number + /** @example 0 */ readonly following: number /** * Format: uri @@ -9226,6 +9268,7 @@ export interface components { readonly members_can_create_public_pages?: boolean /** @example true */ readonly members_can_create_private_pages?: boolean + /** @example false */ readonly members_can_fork_private_repositories?: boolean | null /** Format: date-time */ readonly updated_at: string @@ -10080,8 +10123,11 @@ export interface components { readonly url?: string readonly node_id?: string } | null + /** @example 0 */ readonly forks?: number + /** @example 0 */ readonly open_issues?: number + /** @example 0 */ readonly watchers?: number readonly allow_forking?: boolean } | null @@ -10376,6 +10422,7 @@ export interface components { * @example 0307116bbf7ced493b8d8a346c650b71 */ readonly body_version: string + /** @example 0 */ readonly comments_count: number /** * Format: uri @@ -10588,7 +10635,10 @@ export interface components { /** @example admin */ readonly role_name?: string readonly owner: components['schemas']['nullable-simple-user'] - /** @description Whether the repository is private or public. */ + /** + * @description Whether the repository is private or public. + * @default false + */ readonly private: boolean /** * Format: uri @@ -10749,9 +10799,11 @@ export interface components { * @example master */ readonly default_branch: string + /** @example 0 */ readonly open_issues_count: number /** * @description Whether this repository acts as a template that can be used to generate new repositories. + * @default false * @example true */ readonly is_template?: boolean @@ -10781,7 +10833,10 @@ export interface components { * @example true */ readonly has_downloads: boolean - /** @description Whether the repository is archived. */ + /** + * @description Whether the repository is archived. + * @default false + */ readonly archived: boolean /** @description Returns whether or not this repository disabled. */ readonly disabled: boolean @@ -10819,9 +10874,17 @@ export interface components { * @example true */ readonly allow_squash_merge?: boolean - /** @description Whether to allow Auto-merge to be used on pull requests. */ + /** + * @description Whether to allow Auto-merge to be used on pull requests. + * @default false + * @example false + */ readonly allow_auto_merge?: boolean - /** @description Whether to delete head branches when pull requests are merged */ + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + * @example false + */ readonly delete_branch_on_merge?: boolean /** * @description Whether to allow merge commits for pull requests. @@ -10829,7 +10892,11 @@ export interface components { * @example true */ readonly allow_merge_commit?: boolean - /** @description Whether to allow forking this repo */ + /** + * @description Whether to allow forking this repo + * @default false + * @example false + */ readonly allow_forking?: boolean readonly subscribers_count?: number readonly network_count?: number @@ -10867,7 +10934,10 @@ export interface components { * @example 2016-09-05T14:20:22Z */ readonly updated_at: string - /** @description Whether or not the card is archived */ + /** + * @description Whether or not the card is archived + * @example false + */ readonly archived?: boolean readonly column_name?: string readonly project_id?: string @@ -11153,6 +11223,7 @@ export interface components { readonly size: number /** @example master */ readonly default_branch: string + /** @example 0 */ readonly open_issues_count: number /** @example true */ readonly is_template?: boolean @@ -11203,7 +11274,9 @@ export interface components { readonly temp_clone_token?: string | null /** @example true */ readonly allow_squash_merge?: boolean + /** @example false */ readonly allow_auto_merge?: boolean + /** @example false */ readonly delete_branch_on_merge?: boolean /** @example true */ readonly allow_merge_commit?: boolean @@ -11211,6 +11284,7 @@ export interface components { readonly allow_forking?: boolean /** @example 42 */ readonly subscribers_count: number + /** @example 0 */ readonly network_count: number readonly license: components['schemas']['nullable-license-simple'] readonly organization?: components['schemas']['nullable-simple-user'] @@ -12002,6 +12076,7 @@ export interface components { readonly received_events_url?: string /** @example "Organization" */ readonly type?: string + /** @example false */ readonly site_admin?: boolean } readonly name?: string @@ -12165,6 +12240,7 @@ export interface components { readonly committer: components['schemas']['nullable-git-user'] /** @example Fix all the bugs */ readonly message: string + /** @example 0 */ readonly comment_count: number readonly tree: { /** @example 827efc6d56897b048c772eb4087f854f46256132 */ @@ -12733,7 +12809,10 @@ export interface components { readonly billable_owner: components['schemas']['simple-user'] readonly repository: components['schemas']['minimal-repository'] readonly machine: components['schemas']['nullable-codespace-machine'] - /** @description Whether the codespace was created from a prebuild. */ + /** + * @description Whether the codespace was created from a prebuild. + * @example false + */ readonly prebuild: boolean | null /** * Format: date-time @@ -12781,9 +12860,15 @@ export interface components { readonly url: string /** @description Details about the codespace's git repository. */ readonly git_status: { - /** @description The number of commits the local repository is ahead of the remote. */ + /** + * @description The number of commits the local repository is ahead of the remote. + * @example 0 + */ readonly ahead?: number - /** @description The number of commits the local repository is behind the remote. */ + /** + * @description The number of commits the local repository is behind the remote. + * @example 0 + */ readonly behind?: number /** @description Whether the local repository has unpushed changes. */ readonly has_unpushed_changes?: boolean @@ -13267,7 +13352,10 @@ export interface components { } readonly author_association: components['schemas']['author_association'] readonly auto_merge: components['schemas']['auto_merge'] - /** @description Indicates whether or not the pull request is a draft. */ + /** + * @description Indicates whether or not the pull request is a draft. + * @example false + */ readonly draft?: boolean } /** Simple Commit Status */ @@ -13721,17 +13809,20 @@ export interface components { readonly creator: components['schemas']['nullable-simple-user'] /** * @description A short description of the status. + * @default * @example Deployment finished successfully. */ readonly description: string /** * @description The environment of the deployment that the status is for. + * @default * @example production */ readonly environment?: string /** * Format: uri * @description Deprecated: the URL to associate with this status. + * @default * @example https://example.com/deployment/42/output */ readonly target_url: string @@ -13758,12 +13849,14 @@ export interface components { /** * Format: uri * @description The URL for accessing your environment. + * @default * @example https://staging.example.com/ */ readonly environment_url?: string /** * Format: uri * @description The URL to associate with this status. + * @default * @example https://example.com/deployment/42/output */ readonly log_url?: string @@ -15352,7 +15445,11 @@ export interface components { * @description The timestamp when a pending domain becomes unverified. */ readonly pending_domain_unverified_at?: string | null - /** @description Whether the Page has a custom 404 page. */ + /** + * @description Whether the Page has a custom 404 page. + * @default false + * @example false + */ readonly custom_404: boolean /** * Format: uri @@ -16010,7 +16107,10 @@ export interface components { } readonly author_association: components['schemas']['author_association'] readonly auto_merge: components['schemas']['auto_merge'] - /** @description Indicates whether or not the pull request is a draft. */ + /** + * @description Indicates whether or not the pull request is a draft. + * @example false + */ readonly draft?: boolean readonly merged: boolean /** @example true */ @@ -16022,6 +16122,7 @@ export interface components { readonly merged_by: components['schemas']['nullable-simple-user'] /** @example 10 */ readonly comments: number + /** @example 0 */ readonly review_comments: number /** * @description Indicates whether maintainers can modify the pull request. @@ -16259,9 +16360,15 @@ export interface components { readonly target_commitish: string readonly name: string | null readonly body?: string | null - /** @description true to create a draft (unpublished) release, false to create a published one. */ + /** + * @description true to create a draft (unpublished) release, false to create a published one. + * @example false + */ readonly draft: boolean - /** @description Whether to identify the release as a prerelease or a full release. */ + /** + * @description Whether to identify the release as a prerelease or a full release. + * @example false + */ readonly prerelease: boolean /** Format: date-time */ readonly created_at: string @@ -17178,6 +17285,7 @@ export interface components { readonly public_gists: number /** @example 20 */ readonly followers: number + /** @example 0 */ readonly following: number /** * Format: date-time @@ -19046,7 +19154,10 @@ export interface operations { readonly selected_organization_ids?: readonly number[] /** @description List of runner IDs to add to the runner group. */ readonly runners?: readonly number[] - /** @description Whether the runner group can be used by `public` repositories. */ + /** + * @description Whether the runner group can be used by `public` repositories. + * @default false + */ readonly allows_public_repositories?: boolean } } @@ -19127,7 +19238,10 @@ export interface operations { * @enum {string} */ readonly visibility?: 'selected' | 'all' - /** @description Whether the runner group can be used by `public` repositories. */ + /** + * @description Whether the runner group can be used by `public` repositories. + * @default false + */ readonly allows_public_repositories?: boolean } } @@ -20897,7 +21011,10 @@ export interface operations { readonly requestBody: { readonly content: { readonly 'application/json': { - /** @description Whether to block all notifications from a thread. */ + /** + * @description Whether to block all notifications from a thread. + * @default false + */ readonly ignored?: boolean } } @@ -21155,6 +21272,7 @@ export interface operations { * @description Toggles whether organization members can fork private organization repositories. Can be one of: * \* `true` - all organization members can fork private repositories within the organization. * \* `false` - no organization members can fork private repositories within the organization. + * @default false */ readonly members_can_fork_private_repositories?: boolean /** @example "http://github.blog" */ @@ -21451,7 +21569,10 @@ export interface operations { readonly selected_repository_ids?: readonly number[] /** @description List of runner IDs to add to the runner group. */ readonly runners?: readonly number[] - /** @description Whether the runner group can be used by `public` repositories. */ + /** + * @description Whether the runner group can be used by `public` repositories. + * @default false + */ readonly allows_public_repositories?: boolean } } @@ -21534,7 +21655,10 @@ export interface operations { * @enum {string} */ readonly visibility?: 'selected' | 'all' | 'private' - /** @description Whether the runner group can be used by `public` repositories. */ + /** + * @description Whether the runner group can be used by `public` repositories. + * @default false + */ readonly allows_public_repositories?: boolean } } @@ -23590,21 +23714,25 @@ export interface operations { readonly repositories: readonly string[] /** * @description Indicates whether repositories should be locked (to prevent manipulation) while migrating data. + * @default false * @example true */ readonly lock_repositories?: boolean /** * @description Indicates whether attachments should be excluded from the migration (to reduce migration archive file size). + * @default false * @example true */ readonly exclude_attachments?: boolean /** * @description Indicates whether releases should be excluded from the migration (to reduce migration archive file size). + * @default false * @example true */ readonly exclude_releases?: boolean /** * @description Indicates whether projects owned by the organization or users should be excluded. from the migration. + * @default false * @example true */ readonly exclude_owner_projects?: boolean @@ -24220,7 +24348,10 @@ export interface operations { readonly description?: string /** @description A URL with more information about the repository. */ readonly homepage?: string - /** @description Whether the repository is private. */ + /** + * @description Whether the repository is private. + * @default false + */ readonly private?: boolean /** * @description Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see "[Creating an internal repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)" in the GitHub Help documentation. @@ -24242,11 +24373,17 @@ export interface operations { * @default true */ readonly has_wiki?: boolean - /** @description Either `true` to make this repo available as a template repository or `false` to prevent it. */ + /** + * @description Either `true` to make this repo available as a template repository or `false` to prevent it. + * @default false + */ readonly is_template?: boolean /** @description The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. */ readonly team_id?: number - /** @description Pass `true` to create an initial commit with empty README. */ + /** + * @description Pass `true` to create an initial commit with empty README. + * @default false + */ readonly auto_init?: boolean /** @description Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, "Haskell". */ readonly gitignore_template?: string @@ -24267,9 +24404,15 @@ export interface operations { * @default true */ readonly allow_rebase_merge?: boolean - /** @description Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. */ + /** + * @description Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. + * @default false + */ readonly allow_auto_merge?: boolean - /** @description Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. */ + /** + * @description Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. + * @default false + */ readonly delete_branch_on_merge?: boolean } } @@ -24678,7 +24821,10 @@ export interface operations { readonly title: string /** @description The discussion post's body text. */ readonly body: string - /** @description Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. */ + /** + * @description Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. + * @default false + */ readonly private?: boolean } } @@ -25713,7 +25859,10 @@ export interface operations { * @example Update all gems */ readonly note?: string | null - /** @description Whether or not the card is archived */ + /** + * @description Whether or not the card is archived + * @example false + */ readonly archived?: boolean } } @@ -26356,6 +26505,7 @@ export interface operations { /** * @description Either `true` to make the repository private or `false` to make it public. Default: `false`. * **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. + * @default false */ readonly private?: boolean /** @@ -26391,7 +26541,10 @@ export interface operations { * @default true */ readonly has_wiki?: boolean - /** @description Either `true` to make this repo available as a template repository or `false` to prevent it. */ + /** + * @description Either `true` to make this repo available as a template repository or `false` to prevent it. + * @default false + */ readonly is_template?: boolean /** @description Updates the default branch for this repository. */ readonly default_branch?: string @@ -26410,13 +26563,25 @@ export interface operations { * @default true */ readonly allow_rebase_merge?: boolean - /** @description Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. */ + /** + * @description Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. + * @default false + */ readonly allow_auto_merge?: boolean - /** @description Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. */ + /** + * @description Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. + * @default false + */ readonly delete_branch_on_merge?: boolean - /** @description `true` to archive this repository. **Note**: You cannot unarchive repositories through the API. */ + /** + * @description `true` to archive this repository. **Note**: You cannot unarchive repositories through the API. + * @default false + */ readonly archived?: boolean - /** @description Either `true` to allow private forks, or `false` to prevent private forks. */ + /** + * @description Either `true` to allow private forks, or `false` to prevent private forks. + * @default false + */ readonly allow_forking?: boolean } } @@ -31365,9 +31530,15 @@ export interface operations { * @default production */ readonly environment?: string - /** @description Short description of the deployment. */ + /** + * @description Short description of the deployment. + * @default + */ readonly description?: string | null - /** @description Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false` */ + /** + * @description Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false` + * @default false + */ readonly transient_environment?: boolean /** @description Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise. */ readonly production_environment?: boolean @@ -31481,18 +31652,30 @@ export interface operations { * @enum {string} */ readonly state: 'error' | 'failure' | 'inactive' | 'in_progress' | 'queued' | 'pending' | 'success' - /** @description The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`. */ + /** + * @description The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`. + * @default + */ readonly target_url?: string - /** @description The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `""` */ + /** + * @description The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `""` + * @default + */ readonly log_url?: string - /** @description A short description of the status. The maximum description length is 140 characters. */ + /** + * @description A short description of the status. The maximum description length is 140 characters. + * @default + */ readonly description?: string /** * @description Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. * @enum {string} */ readonly environment?: 'production' | 'staging' | 'qa' - /** @description Sets the URL for accessing your environment. Default: `""` */ + /** + * @description Sets the URL for accessing your environment. Default: `""` + * @default + */ readonly environment_url?: string /** @description Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true` */ readonly auto_inactive?: boolean @@ -32083,7 +32266,10 @@ export interface operations { readonly 'application/json': { /** @description The SHA1 value to set this reference to */ readonly sha: string - /** @description Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work. */ + /** + * @description Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work. + * @default false + */ readonly force?: boolean } } @@ -35878,13 +36064,22 @@ export interface operations { readonly name?: string /** @description Text describing the contents of the tag. */ readonly body?: string - /** @description `true` to create a draft (unpublished) release, `false` to create a published one. */ + /** + * @description `true` to create a draft (unpublished) release, `false` to create a published one. + * @default false + */ readonly draft?: boolean - /** @description `true` to identify the release as a prerelease. `false` to identify the release as a full release. */ + /** + * @description `true` to identify the release as a prerelease. `false` to identify the release as a full release. + * @default false + */ readonly prerelease?: boolean /** @description If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see "[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." */ readonly discussion_category_name?: string - /** @description Whether to automatically generate the name and body for this release. If `name` is specified, the specified name will be used; otherwise, a name will be automatically generated. If `body` is specified, the body will be pre-pended to the automatically generated notes. */ + /** + * @description Whether to automatically generate the name and body for this release. If `name` is specified, the specified name will be used; otherwise, a name will be automatically generated. If `body` is specified, the body will be pre-pended to the automatically generated notes. + * @default false + */ readonly generate_release_notes?: boolean } } @@ -36954,9 +37149,15 @@ export interface operations { readonly name: string /** @description A short description of the new repository. */ readonly description?: string - /** @description Set to `true` to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: `false`. */ + /** + * @description Set to `true` to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: `false`. + * @default false + */ readonly include_all_branches?: boolean - /** @description Either `true` to create a new private repository or `false` to create a new public one. */ + /** + * @description Either `true` to create a new private repository or `false` to create a new public one. + * @default false + */ readonly private?: boolean } } @@ -38341,7 +38542,10 @@ export interface operations { readonly title: string /** @description The discussion post's body text. */ readonly body: string - /** @description Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. */ + /** + * @description Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. + * @default false + */ readonly private?: boolean } } @@ -41265,7 +41469,10 @@ export interface operations { readonly description?: string /** @description A URL with more information about the repository. */ readonly homepage?: string - /** @description Whether the repository is private. */ + /** + * @description Whether the repository is private. + * @default false + */ readonly private?: boolean /** * @description Whether issues are enabled. @@ -41287,7 +41494,10 @@ export interface operations { readonly has_wiki?: boolean /** @description The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. */ readonly team_id?: number - /** @description Whether the repository is initialized with a minimal README. */ + /** + * @description Whether the repository is initialized with a minimal README. + * @default false + */ readonly auto_init?: boolean /** * @description The desired language or platform to apply to the .gitignore. @@ -41317,9 +41527,17 @@ export interface operations { * @example true */ readonly allow_rebase_merge?: boolean - /** @description Whether to allow Auto-merge to be used on pull requests. */ + /** + * @description Whether to allow Auto-merge to be used on pull requests. + * @default false + * @example false + */ readonly allow_auto_merge?: boolean - /** @description Whether to delete head branches when pull requests are merged */ + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + * @example false + */ readonly delete_branch_on_merge?: boolean /** * @description Whether downloads are enabled. @@ -41329,6 +41547,7 @@ export interface operations { readonly has_downloads?: boolean /** * @description Whether this repository acts as a template that can be used to generate new repositories. + * @default false * @example true */ readonly is_template?: boolean diff --git a/test/v3/expected/github.support-array-length.ts b/test/v3/expected/github.support-array-length.ts index 61cc1f438..f2b2c8944 100644 --- a/test/v3/expected/github.support-array-length.ts +++ b/test/v3/expected/github.support-array-length.ts @@ -6180,7 +6180,10 @@ export interface components { * @example 2021-05-12T20:33:44Z */ delivered_at: string - /** @description Whether the webhook delivery is a redelivery. */ + /** + * @description Whether the webhook delivery is a redelivery. + * @example false + */ redelivery: boolean /** * @description Time spent delivering. @@ -6267,7 +6270,10 @@ export interface components { * @example 2021-05-12T20:33:44Z */ delivered_at: string - /** @description Whether the delivery is a redelivery. */ + /** + * @description Whether the delivery is a redelivery. + * @example false + */ redelivery: boolean /** * @description Time spent delivering. @@ -6703,7 +6709,10 @@ export interface components { maintain?: boolean } owner: components['schemas']['simple-user'] - /** @description Whether the repository is private or public. */ + /** + * @description Whether the repository is private or public. + * @default false + */ private: boolean /** * Format: uri @@ -6864,9 +6873,11 @@ export interface components { * @example master */ default_branch: string + /** @example 0 */ open_issues_count: number /** * @description Whether this repository acts as a template that can be used to generate new repositories. + * @default false * @example true */ is_template?: boolean @@ -6896,7 +6907,10 @@ export interface components { * @example true */ has_downloads: boolean - /** @description Whether the repository is archived. */ + /** + * @description Whether the repository is archived. + * @default false + */ archived: boolean /** @description Returns whether or not this repository disabled. */ disabled: boolean @@ -7042,9 +7056,17 @@ export interface components { * @example true */ allow_squash_merge?: boolean - /** @description Whether to allow Auto-merge to be used on pull requests. */ + /** + * @description Whether to allow Auto-merge to be used on pull requests. + * @default false + * @example false + */ allow_auto_merge?: boolean - /** @description Whether to delete head branches when pull requests are merged */ + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + * @example false + */ delete_branch_on_merge?: boolean /** * @description Whether to allow merge commits for pull requests. @@ -7506,7 +7528,10 @@ export interface components { maintain?: boolean } owner: components['schemas']['simple-user'] - /** @description Whether the repository is private or public. */ + /** + * @description Whether the repository is private or public. + * @default false + */ private: boolean /** * Format: uri @@ -7667,9 +7692,11 @@ export interface components { * @example master */ default_branch: string + /** @example 0 */ open_issues_count: number /** * @description Whether this repository acts as a template that can be used to generate new repositories. + * @default false * @example true */ is_template?: boolean @@ -7699,7 +7726,10 @@ export interface components { * @example true */ has_downloads: boolean - /** @description Whether the repository is archived. */ + /** + * @description Whether the repository is archived. + * @default false + */ archived: boolean /** @description Returns whether or not this repository disabled. */ disabled: boolean @@ -7845,9 +7875,17 @@ export interface components { * @example true */ allow_squash_merge?: boolean - /** @description Whether to allow Auto-merge to be used on pull requests. */ + /** + * @description Whether to allow Auto-merge to be used on pull requests. + * @default false + * @example false + */ allow_auto_merge?: boolean - /** @description Whether to delete head branches when pull requests are merged */ + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + * @example false + */ delete_branch_on_merge?: boolean /** * @description Whether to allow merge commits for pull requests. @@ -8064,8 +8102,11 @@ export interface components { url?: string node_id?: string } | null + /** @example 0 */ forks?: number + /** @example 0 */ open_issues?: number + /** @example 0 */ watchers?: number allow_forking?: boolean } @@ -9172,6 +9213,7 @@ export interface components { public_gists: number /** @example 20 */ followers: number + /** @example 0 */ following: number /** * Format: uri @@ -9226,6 +9268,7 @@ export interface components { members_can_create_public_pages?: boolean /** @example true */ members_can_create_private_pages?: boolean + /** @example false */ members_can_fork_private_repositories?: boolean | null /** Format: date-time */ updated_at: string @@ -10080,8 +10123,11 @@ export interface components { url?: string node_id?: string } | null + /** @example 0 */ forks?: number + /** @example 0 */ open_issues?: number + /** @example 0 */ watchers?: number allow_forking?: boolean } | null @@ -10376,6 +10422,7 @@ export interface components { * @example 0307116bbf7ced493b8d8a346c650b71 */ body_version: string + /** @example 0 */ comments_count: number /** * Format: uri @@ -10588,7 +10635,10 @@ export interface components { /** @example admin */ role_name?: string owner: components['schemas']['nullable-simple-user'] - /** @description Whether the repository is private or public. */ + /** + * @description Whether the repository is private or public. + * @default false + */ private: boolean /** * Format: uri @@ -10749,9 +10799,11 @@ export interface components { * @example master */ default_branch: string + /** @example 0 */ open_issues_count: number /** * @description Whether this repository acts as a template that can be used to generate new repositories. + * @default false * @example true */ is_template?: boolean @@ -10781,7 +10833,10 @@ export interface components { * @example true */ has_downloads: boolean - /** @description Whether the repository is archived. */ + /** + * @description Whether the repository is archived. + * @default false + */ archived: boolean /** @description Returns whether or not this repository disabled. */ disabled: boolean @@ -10819,9 +10874,17 @@ export interface components { * @example true */ allow_squash_merge?: boolean - /** @description Whether to allow Auto-merge to be used on pull requests. */ + /** + * @description Whether to allow Auto-merge to be used on pull requests. + * @default false + * @example false + */ allow_auto_merge?: boolean - /** @description Whether to delete head branches when pull requests are merged */ + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + * @example false + */ delete_branch_on_merge?: boolean /** * @description Whether to allow merge commits for pull requests. @@ -10829,7 +10892,11 @@ export interface components { * @example true */ allow_merge_commit?: boolean - /** @description Whether to allow forking this repo */ + /** + * @description Whether to allow forking this repo + * @default false + * @example false + */ allow_forking?: boolean subscribers_count?: number network_count?: number @@ -10867,7 +10934,10 @@ export interface components { * @example 2016-09-05T14:20:22Z */ updated_at: string - /** @description Whether or not the card is archived */ + /** + * @description Whether or not the card is archived + * @example false + */ archived?: boolean column_name?: string project_id?: string @@ -11153,6 +11223,7 @@ export interface components { size: number /** @example master */ default_branch: string + /** @example 0 */ open_issues_count: number /** @example true */ is_template?: boolean @@ -11203,7 +11274,9 @@ export interface components { temp_clone_token?: string | null /** @example true */ allow_squash_merge?: boolean + /** @example false */ allow_auto_merge?: boolean + /** @example false */ delete_branch_on_merge?: boolean /** @example true */ allow_merge_commit?: boolean @@ -11211,6 +11284,7 @@ export interface components { allow_forking?: boolean /** @example 42 */ subscribers_count: number + /** @example 0 */ network_count: number license: components['schemas']['nullable-license-simple'] organization?: components['schemas']['nullable-simple-user'] @@ -12002,6 +12076,7 @@ export interface components { received_events_url?: string /** @example "Organization" */ type?: string + /** @example false */ site_admin?: boolean } name?: string @@ -12165,6 +12240,7 @@ export interface components { committer: components['schemas']['nullable-git-user'] /** @example Fix all the bugs */ message: string + /** @example 0 */ comment_count: number tree: { /** @example 827efc6d56897b048c772eb4087f854f46256132 */ @@ -12733,7 +12809,10 @@ export interface components { billable_owner: components['schemas']['simple-user'] repository: components['schemas']['minimal-repository'] machine: components['schemas']['nullable-codespace-machine'] - /** @description Whether the codespace was created from a prebuild. */ + /** + * @description Whether the codespace was created from a prebuild. + * @example false + */ prebuild: boolean | null /** * Format: date-time @@ -12781,9 +12860,15 @@ export interface components { url: string /** @description Details about the codespace's git repository. */ git_status: { - /** @description The number of commits the local repository is ahead of the remote. */ + /** + * @description The number of commits the local repository is ahead of the remote. + * @example 0 + */ ahead?: number - /** @description The number of commits the local repository is behind the remote. */ + /** + * @description The number of commits the local repository is behind the remote. + * @example 0 + */ behind?: number /** @description Whether the local repository has unpushed changes. */ has_unpushed_changes?: boolean @@ -13267,7 +13352,10 @@ export interface components { } author_association: components['schemas']['author_association'] auto_merge: components['schemas']['auto_merge'] - /** @description Indicates whether or not the pull request is a draft. */ + /** + * @description Indicates whether or not the pull request is a draft. + * @example false + */ draft?: boolean } /** Simple Commit Status */ @@ -13721,17 +13809,20 @@ export interface components { creator: components['schemas']['nullable-simple-user'] /** * @description A short description of the status. + * @default * @example Deployment finished successfully. */ description: string /** * @description The environment of the deployment that the status is for. + * @default * @example production */ environment?: string /** * Format: uri * @description Deprecated: the URL to associate with this status. + * @default * @example https://example.com/deployment/42/output */ target_url: string @@ -13758,12 +13849,14 @@ export interface components { /** * Format: uri * @description The URL for accessing your environment. + * @default * @example https://staging.example.com/ */ environment_url?: string /** * Format: uri * @description The URL to associate with this status. + * @default * @example https://example.com/deployment/42/output */ log_url?: string @@ -15352,7 +15445,11 @@ export interface components { * @description The timestamp when a pending domain becomes unverified. */ pending_domain_unverified_at?: string | null - /** @description Whether the Page has a custom 404 page. */ + /** + * @description Whether the Page has a custom 404 page. + * @default false + * @example false + */ custom_404: boolean /** * Format: uri @@ -16010,7 +16107,10 @@ export interface components { } author_association: components['schemas']['author_association'] auto_merge: components['schemas']['auto_merge'] - /** @description Indicates whether or not the pull request is a draft. */ + /** + * @description Indicates whether or not the pull request is a draft. + * @example false + */ draft?: boolean merged: boolean /** @example true */ @@ -16022,6 +16122,7 @@ export interface components { merged_by: components['schemas']['nullable-simple-user'] /** @example 10 */ comments: number + /** @example 0 */ review_comments: number /** * @description Indicates whether maintainers can modify the pull request. @@ -16259,9 +16360,15 @@ export interface components { target_commitish: string name: string | null body?: string | null - /** @description true to create a draft (unpublished) release, false to create a published one. */ + /** + * @description true to create a draft (unpublished) release, false to create a published one. + * @example false + */ draft: boolean - /** @description Whether to identify the release as a prerelease or a full release. */ + /** + * @description Whether to identify the release as a prerelease or a full release. + * @example false + */ prerelease: boolean /** Format: date-time */ created_at: string @@ -17192,6 +17299,7 @@ export interface components { public_gists: number /** @example 20 */ followers: number + /** @example 0 */ following: number /** * Format: date-time @@ -19060,7 +19168,10 @@ export interface operations { selected_organization_ids?: number[] /** @description List of runner IDs to add to the runner group. */ runners?: number[] - /** @description Whether the runner group can be used by `public` repositories. */ + /** + * @description Whether the runner group can be used by `public` repositories. + * @default false + */ allows_public_repositories?: boolean } } @@ -19141,7 +19252,10 @@ export interface operations { * @enum {string} */ visibility?: 'selected' | 'all' - /** @description Whether the runner group can be used by `public` repositories. */ + /** + * @description Whether the runner group can be used by `public` repositories. + * @default false + */ allows_public_repositories?: boolean } } @@ -20911,7 +21025,10 @@ export interface operations { requestBody: { content: { 'application/json': { - /** @description Whether to block all notifications from a thread. */ + /** + * @description Whether to block all notifications from a thread. + * @default false + */ ignored?: boolean } } @@ -21169,6 +21286,7 @@ export interface operations { * @description Toggles whether organization members can fork private organization repositories. Can be one of: * \* `true` - all organization members can fork private repositories within the organization. * \* `false` - no organization members can fork private repositories within the organization. + * @default false */ members_can_fork_private_repositories?: boolean /** @example "http://github.blog" */ @@ -21465,7 +21583,10 @@ export interface operations { selected_repository_ids?: number[] /** @description List of runner IDs to add to the runner group. */ runners?: number[] - /** @description Whether the runner group can be used by `public` repositories. */ + /** + * @description Whether the runner group can be used by `public` repositories. + * @default false + */ allows_public_repositories?: boolean } } @@ -21548,7 +21669,10 @@ export interface operations { * @enum {string} */ visibility?: 'selected' | 'all' | 'private' - /** @description Whether the runner group can be used by `public` repositories. */ + /** + * @description Whether the runner group can be used by `public` repositories. + * @default false + */ allows_public_repositories?: boolean } } @@ -23604,21 +23728,25 @@ export interface operations { repositories: string[] /** * @description Indicates whether repositories should be locked (to prevent manipulation) while migrating data. + * @default false * @example true */ lock_repositories?: boolean /** * @description Indicates whether attachments should be excluded from the migration (to reduce migration archive file size). + * @default false * @example true */ exclude_attachments?: boolean /** * @description Indicates whether releases should be excluded from the migration (to reduce migration archive file size). + * @default false * @example true */ exclude_releases?: boolean /** * @description Indicates whether projects owned by the organization or users should be excluded. from the migration. + * @default false * @example true */ exclude_owner_projects?: boolean @@ -24234,7 +24362,10 @@ export interface operations { description?: string /** @description A URL with more information about the repository. */ homepage?: string - /** @description Whether the repository is private. */ + /** + * @description Whether the repository is private. + * @default false + */ private?: boolean /** * @description Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see "[Creating an internal repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)" in the GitHub Help documentation. @@ -24256,11 +24387,17 @@ export interface operations { * @default true */ has_wiki?: boolean - /** @description Either `true` to make this repo available as a template repository or `false` to prevent it. */ + /** + * @description Either `true` to make this repo available as a template repository or `false` to prevent it. + * @default false + */ is_template?: boolean /** @description The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. */ team_id?: number - /** @description Pass `true` to create an initial commit with empty README. */ + /** + * @description Pass `true` to create an initial commit with empty README. + * @default false + */ auto_init?: boolean /** @description Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, "Haskell". */ gitignore_template?: string @@ -24281,9 +24418,15 @@ export interface operations { * @default true */ allow_rebase_merge?: boolean - /** @description Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. */ + /** + * @description Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. + * @default false + */ allow_auto_merge?: boolean - /** @description Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. */ + /** + * @description Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. + * @default false + */ delete_branch_on_merge?: boolean } } @@ -24692,7 +24835,10 @@ export interface operations { title: string /** @description The discussion post's body text. */ body: string - /** @description Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. */ + /** + * @description Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. + * @default false + */ private?: boolean } } @@ -25727,7 +25873,10 @@ export interface operations { * @example Update all gems */ note?: string | null - /** @description Whether or not the card is archived */ + /** + * @description Whether or not the card is archived + * @example false + */ archived?: boolean } } @@ -26370,6 +26519,7 @@ export interface operations { /** * @description Either `true` to make the repository private or `false` to make it public. Default: `false`. * **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. + * @default false */ private?: boolean /** @@ -26405,7 +26555,10 @@ export interface operations { * @default true */ has_wiki?: boolean - /** @description Either `true` to make this repo available as a template repository or `false` to prevent it. */ + /** + * @description Either `true` to make this repo available as a template repository or `false` to prevent it. + * @default false + */ is_template?: boolean /** @description Updates the default branch for this repository. */ default_branch?: string @@ -26424,13 +26577,25 @@ export interface operations { * @default true */ allow_rebase_merge?: boolean - /** @description Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. */ + /** + * @description Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. + * @default false + */ allow_auto_merge?: boolean - /** @description Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. */ + /** + * @description Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. + * @default false + */ delete_branch_on_merge?: boolean - /** @description `true` to archive this repository. **Note**: You cannot unarchive repositories through the API. */ + /** + * @description `true` to archive this repository. **Note**: You cannot unarchive repositories through the API. + * @default false + */ archived?: boolean - /** @description Either `true` to allow private forks, or `false` to prevent private forks. */ + /** + * @description Either `true` to allow private forks, or `false` to prevent private forks. + * @default false + */ allow_forking?: boolean } } @@ -31475,9 +31640,15 @@ export interface operations { * @default production */ environment?: string - /** @description Short description of the deployment. */ + /** + * @description Short description of the deployment. + * @default + */ description?: string | null - /** @description Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false` */ + /** + * @description Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false` + * @default false + */ transient_environment?: boolean /** @description Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise. */ production_environment?: boolean @@ -31591,18 +31762,30 @@ export interface operations { * @enum {string} */ state: 'error' | 'failure' | 'inactive' | 'in_progress' | 'queued' | 'pending' | 'success' - /** @description The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`. */ + /** + * @description The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`. + * @default + */ target_url?: string - /** @description The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `""` */ + /** + * @description The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `""` + * @default + */ log_url?: string - /** @description A short description of the status. The maximum description length is 140 characters. */ + /** + * @description A short description of the status. The maximum description length is 140 characters. + * @default + */ description?: string /** * @description Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. * @enum {string} */ environment?: 'production' | 'staging' | 'qa' - /** @description Sets the URL for accessing your environment. Default: `""` */ + /** + * @description Sets the URL for accessing your environment. Default: `""` + * @default + */ environment_url?: string /** @description Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true` */ auto_inactive?: boolean @@ -32193,7 +32376,10 @@ export interface operations { 'application/json': { /** @description The SHA1 value to set this reference to */ sha: string - /** @description Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work. */ + /** + * @description Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work. + * @default false + */ force?: boolean } } @@ -36008,13 +36194,22 @@ export interface operations { name?: string /** @description Text describing the contents of the tag. */ body?: string - /** @description `true` to create a draft (unpublished) release, `false` to create a published one. */ + /** + * @description `true` to create a draft (unpublished) release, `false` to create a published one. + * @default false + */ draft?: boolean - /** @description `true` to identify the release as a prerelease. `false` to identify the release as a full release. */ + /** + * @description `true` to identify the release as a prerelease. `false` to identify the release as a full release. + * @default false + */ prerelease?: boolean /** @description If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see "[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." */ discussion_category_name?: string - /** @description Whether to automatically generate the name and body for this release. If `name` is specified, the specified name will be used; otherwise, a name will be automatically generated. If `body` is specified, the body will be pre-pended to the automatically generated notes. */ + /** + * @description Whether to automatically generate the name and body for this release. If `name` is specified, the specified name will be used; otherwise, a name will be automatically generated. If `body` is specified, the body will be pre-pended to the automatically generated notes. + * @default false + */ generate_release_notes?: boolean } } @@ -37083,9 +37278,15 @@ export interface operations { name: string /** @description A short description of the new repository. */ description?: string - /** @description Set to `true` to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: `false`. */ + /** + * @description Set to `true` to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: `false`. + * @default false + */ include_all_branches?: boolean - /** @description Either `true` to create a new private repository or `false` to create a new public one. */ + /** + * @description Either `true` to create a new private repository or `false` to create a new public one. + * @default false + */ private?: boolean } } @@ -38513,7 +38714,10 @@ export interface operations { title: string /** @description The discussion post's body text. */ body: string - /** @description Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. */ + /** + * @description Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. + * @default false + */ private?: boolean } } @@ -41437,7 +41641,10 @@ export interface operations { description?: string /** @description A URL with more information about the repository. */ homepage?: string - /** @description Whether the repository is private. */ + /** + * @description Whether the repository is private. + * @default false + */ private?: boolean /** * @description Whether issues are enabled. @@ -41459,7 +41666,10 @@ export interface operations { has_wiki?: boolean /** @description The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. */ team_id?: number - /** @description Whether the repository is initialized with a minimal README. */ + /** + * @description Whether the repository is initialized with a minimal README. + * @default false + */ auto_init?: boolean /** * @description The desired language or platform to apply to the .gitignore. @@ -41489,9 +41699,17 @@ export interface operations { * @example true */ allow_rebase_merge?: boolean - /** @description Whether to allow Auto-merge to be used on pull requests. */ + /** + * @description Whether to allow Auto-merge to be used on pull requests. + * @default false + * @example false + */ allow_auto_merge?: boolean - /** @description Whether to delete head branches when pull requests are merged */ + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + * @example false + */ delete_branch_on_merge?: boolean /** * @description Whether downloads are enabled. @@ -41501,6 +41719,7 @@ export interface operations { has_downloads?: boolean /** * @description Whether this repository acts as a template that can be used to generate new repositories. + * @default false * @example true */ is_template?: boolean diff --git a/test/v3/expected/github.ts b/test/v3/expected/github.ts index 588cd1cf9..d5d4511bb 100644 --- a/test/v3/expected/github.ts +++ b/test/v3/expected/github.ts @@ -6180,7 +6180,10 @@ export interface components { * @example 2021-05-12T20:33:44Z */ delivered_at: string - /** @description Whether the webhook delivery is a redelivery. */ + /** + * @description Whether the webhook delivery is a redelivery. + * @example false + */ redelivery: boolean /** * @description Time spent delivering. @@ -6267,7 +6270,10 @@ export interface components { * @example 2021-05-12T20:33:44Z */ delivered_at: string - /** @description Whether the delivery is a redelivery. */ + /** + * @description Whether the delivery is a redelivery. + * @example false + */ redelivery: boolean /** * @description Time spent delivering. @@ -6703,7 +6709,10 @@ export interface components { maintain?: boolean } owner: components['schemas']['simple-user'] - /** @description Whether the repository is private or public. */ + /** + * @description Whether the repository is private or public. + * @default false + */ private: boolean /** * Format: uri @@ -6864,9 +6873,11 @@ export interface components { * @example master */ default_branch: string + /** @example 0 */ open_issues_count: number /** * @description Whether this repository acts as a template that can be used to generate new repositories. + * @default false * @example true */ is_template?: boolean @@ -6896,7 +6907,10 @@ export interface components { * @example true */ has_downloads: boolean - /** @description Whether the repository is archived. */ + /** + * @description Whether the repository is archived. + * @default false + */ archived: boolean /** @description Returns whether or not this repository disabled. */ disabled: boolean @@ -7042,9 +7056,17 @@ export interface components { * @example true */ allow_squash_merge?: boolean - /** @description Whether to allow Auto-merge to be used on pull requests. */ + /** + * @description Whether to allow Auto-merge to be used on pull requests. + * @default false + * @example false + */ allow_auto_merge?: boolean - /** @description Whether to delete head branches when pull requests are merged */ + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + * @example false + */ delete_branch_on_merge?: boolean /** * @description Whether to allow merge commits for pull requests. @@ -7506,7 +7528,10 @@ export interface components { maintain?: boolean } owner: components['schemas']['simple-user'] - /** @description Whether the repository is private or public. */ + /** + * @description Whether the repository is private or public. + * @default false + */ private: boolean /** * Format: uri @@ -7667,9 +7692,11 @@ export interface components { * @example master */ default_branch: string + /** @example 0 */ open_issues_count: number /** * @description Whether this repository acts as a template that can be used to generate new repositories. + * @default false * @example true */ is_template?: boolean @@ -7699,7 +7726,10 @@ export interface components { * @example true */ has_downloads: boolean - /** @description Whether the repository is archived. */ + /** + * @description Whether the repository is archived. + * @default false + */ archived: boolean /** @description Returns whether or not this repository disabled. */ disabled: boolean @@ -7845,9 +7875,17 @@ export interface components { * @example true */ allow_squash_merge?: boolean - /** @description Whether to allow Auto-merge to be used on pull requests. */ + /** + * @description Whether to allow Auto-merge to be used on pull requests. + * @default false + * @example false + */ allow_auto_merge?: boolean - /** @description Whether to delete head branches when pull requests are merged */ + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + * @example false + */ delete_branch_on_merge?: boolean /** * @description Whether to allow merge commits for pull requests. @@ -8064,8 +8102,11 @@ export interface components { url?: string node_id?: string } | null + /** @example 0 */ forks?: number + /** @example 0 */ open_issues?: number + /** @example 0 */ watchers?: number allow_forking?: boolean } @@ -9172,6 +9213,7 @@ export interface components { public_gists: number /** @example 20 */ followers: number + /** @example 0 */ following: number /** * Format: uri @@ -9226,6 +9268,7 @@ export interface components { members_can_create_public_pages?: boolean /** @example true */ members_can_create_private_pages?: boolean + /** @example false */ members_can_fork_private_repositories?: boolean | null /** Format: date-time */ updated_at: string @@ -10080,8 +10123,11 @@ export interface components { url?: string node_id?: string } | null + /** @example 0 */ forks?: number + /** @example 0 */ open_issues?: number + /** @example 0 */ watchers?: number allow_forking?: boolean } | null @@ -10376,6 +10422,7 @@ export interface components { * @example 0307116bbf7ced493b8d8a346c650b71 */ body_version: string + /** @example 0 */ comments_count: number /** * Format: uri @@ -10588,7 +10635,10 @@ export interface components { /** @example admin */ role_name?: string owner: components['schemas']['nullable-simple-user'] - /** @description Whether the repository is private or public. */ + /** + * @description Whether the repository is private or public. + * @default false + */ private: boolean /** * Format: uri @@ -10749,9 +10799,11 @@ export interface components { * @example master */ default_branch: string + /** @example 0 */ open_issues_count: number /** * @description Whether this repository acts as a template that can be used to generate new repositories. + * @default false * @example true */ is_template?: boolean @@ -10781,7 +10833,10 @@ export interface components { * @example true */ has_downloads: boolean - /** @description Whether the repository is archived. */ + /** + * @description Whether the repository is archived. + * @default false + */ archived: boolean /** @description Returns whether or not this repository disabled. */ disabled: boolean @@ -10819,9 +10874,17 @@ export interface components { * @example true */ allow_squash_merge?: boolean - /** @description Whether to allow Auto-merge to be used on pull requests. */ + /** + * @description Whether to allow Auto-merge to be used on pull requests. + * @default false + * @example false + */ allow_auto_merge?: boolean - /** @description Whether to delete head branches when pull requests are merged */ + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + * @example false + */ delete_branch_on_merge?: boolean /** * @description Whether to allow merge commits for pull requests. @@ -10829,7 +10892,11 @@ export interface components { * @example true */ allow_merge_commit?: boolean - /** @description Whether to allow forking this repo */ + /** + * @description Whether to allow forking this repo + * @default false + * @example false + */ allow_forking?: boolean subscribers_count?: number network_count?: number @@ -10867,7 +10934,10 @@ export interface components { * @example 2016-09-05T14:20:22Z */ updated_at: string - /** @description Whether or not the card is archived */ + /** + * @description Whether or not the card is archived + * @example false + */ archived?: boolean column_name?: string project_id?: string @@ -11153,6 +11223,7 @@ export interface components { size: number /** @example master */ default_branch: string + /** @example 0 */ open_issues_count: number /** @example true */ is_template?: boolean @@ -11203,7 +11274,9 @@ export interface components { temp_clone_token?: string | null /** @example true */ allow_squash_merge?: boolean + /** @example false */ allow_auto_merge?: boolean + /** @example false */ delete_branch_on_merge?: boolean /** @example true */ allow_merge_commit?: boolean @@ -11211,6 +11284,7 @@ export interface components { allow_forking?: boolean /** @example 42 */ subscribers_count: number + /** @example 0 */ network_count: number license: components['schemas']['nullable-license-simple'] organization?: components['schemas']['nullable-simple-user'] @@ -12002,6 +12076,7 @@ export interface components { received_events_url?: string /** @example "Organization" */ type?: string + /** @example false */ site_admin?: boolean } name?: string @@ -12165,6 +12240,7 @@ export interface components { committer: components['schemas']['nullable-git-user'] /** @example Fix all the bugs */ message: string + /** @example 0 */ comment_count: number tree: { /** @example 827efc6d56897b048c772eb4087f854f46256132 */ @@ -12733,7 +12809,10 @@ export interface components { billable_owner: components['schemas']['simple-user'] repository: components['schemas']['minimal-repository'] machine: components['schemas']['nullable-codespace-machine'] - /** @description Whether the codespace was created from a prebuild. */ + /** + * @description Whether the codespace was created from a prebuild. + * @example false + */ prebuild: boolean | null /** * Format: date-time @@ -12781,9 +12860,15 @@ export interface components { url: string /** @description Details about the codespace's git repository. */ git_status: { - /** @description The number of commits the local repository is ahead of the remote. */ + /** + * @description The number of commits the local repository is ahead of the remote. + * @example 0 + */ ahead?: number - /** @description The number of commits the local repository is behind the remote. */ + /** + * @description The number of commits the local repository is behind the remote. + * @example 0 + */ behind?: number /** @description Whether the local repository has unpushed changes. */ has_unpushed_changes?: boolean @@ -13267,7 +13352,10 @@ export interface components { } author_association: components['schemas']['author_association'] auto_merge: components['schemas']['auto_merge'] - /** @description Indicates whether or not the pull request is a draft. */ + /** + * @description Indicates whether or not the pull request is a draft. + * @example false + */ draft?: boolean } /** Simple Commit Status */ @@ -13721,17 +13809,20 @@ export interface components { creator: components['schemas']['nullable-simple-user'] /** * @description A short description of the status. + * @default * @example Deployment finished successfully. */ description: string /** * @description The environment of the deployment that the status is for. + * @default * @example production */ environment?: string /** * Format: uri * @description Deprecated: the URL to associate with this status. + * @default * @example https://example.com/deployment/42/output */ target_url: string @@ -13758,12 +13849,14 @@ export interface components { /** * Format: uri * @description The URL for accessing your environment. + * @default * @example https://staging.example.com/ */ environment_url?: string /** * Format: uri * @description The URL to associate with this status. + * @default * @example https://example.com/deployment/42/output */ log_url?: string @@ -15352,7 +15445,11 @@ export interface components { * @description The timestamp when a pending domain becomes unverified. */ pending_domain_unverified_at?: string | null - /** @description Whether the Page has a custom 404 page. */ + /** + * @description Whether the Page has a custom 404 page. + * @default false + * @example false + */ custom_404: boolean /** * Format: uri @@ -16010,7 +16107,10 @@ export interface components { } author_association: components['schemas']['author_association'] auto_merge: components['schemas']['auto_merge'] - /** @description Indicates whether or not the pull request is a draft. */ + /** + * @description Indicates whether or not the pull request is a draft. + * @example false + */ draft?: boolean merged: boolean /** @example true */ @@ -16022,6 +16122,7 @@ export interface components { merged_by: components['schemas']['nullable-simple-user'] /** @example 10 */ comments: number + /** @example 0 */ review_comments: number /** * @description Indicates whether maintainers can modify the pull request. @@ -16259,9 +16360,15 @@ export interface components { target_commitish: string name: string | null body?: string | null - /** @description true to create a draft (unpublished) release, false to create a published one. */ + /** + * @description true to create a draft (unpublished) release, false to create a published one. + * @example false + */ draft: boolean - /** @description Whether to identify the release as a prerelease or a full release. */ + /** + * @description Whether to identify the release as a prerelease or a full release. + * @example false + */ prerelease: boolean /** Format: date-time */ created_at: string @@ -17178,6 +17285,7 @@ export interface components { public_gists: number /** @example 20 */ followers: number + /** @example 0 */ following: number /** * Format: date-time @@ -19046,7 +19154,10 @@ export interface operations { selected_organization_ids?: number[] /** @description List of runner IDs to add to the runner group. */ runners?: number[] - /** @description Whether the runner group can be used by `public` repositories. */ + /** + * @description Whether the runner group can be used by `public` repositories. + * @default false + */ allows_public_repositories?: boolean } } @@ -19127,7 +19238,10 @@ export interface operations { * @enum {string} */ visibility?: 'selected' | 'all' - /** @description Whether the runner group can be used by `public` repositories. */ + /** + * @description Whether the runner group can be used by `public` repositories. + * @default false + */ allows_public_repositories?: boolean } } @@ -20897,7 +21011,10 @@ export interface operations { requestBody: { content: { 'application/json': { - /** @description Whether to block all notifications from a thread. */ + /** + * @description Whether to block all notifications from a thread. + * @default false + */ ignored?: boolean } } @@ -21155,6 +21272,7 @@ export interface operations { * @description Toggles whether organization members can fork private organization repositories. Can be one of: * \* `true` - all organization members can fork private repositories within the organization. * \* `false` - no organization members can fork private repositories within the organization. + * @default false */ members_can_fork_private_repositories?: boolean /** @example "http://github.blog" */ @@ -21451,7 +21569,10 @@ export interface operations { selected_repository_ids?: number[] /** @description List of runner IDs to add to the runner group. */ runners?: number[] - /** @description Whether the runner group can be used by `public` repositories. */ + /** + * @description Whether the runner group can be used by `public` repositories. + * @default false + */ allows_public_repositories?: boolean } } @@ -21534,7 +21655,10 @@ export interface operations { * @enum {string} */ visibility?: 'selected' | 'all' | 'private' - /** @description Whether the runner group can be used by `public` repositories. */ + /** + * @description Whether the runner group can be used by `public` repositories. + * @default false + */ allows_public_repositories?: boolean } } @@ -23590,21 +23714,25 @@ export interface operations { repositories: string[] /** * @description Indicates whether repositories should be locked (to prevent manipulation) while migrating data. + * @default false * @example true */ lock_repositories?: boolean /** * @description Indicates whether attachments should be excluded from the migration (to reduce migration archive file size). + * @default false * @example true */ exclude_attachments?: boolean /** * @description Indicates whether releases should be excluded from the migration (to reduce migration archive file size). + * @default false * @example true */ exclude_releases?: boolean /** * @description Indicates whether projects owned by the organization or users should be excluded. from the migration. + * @default false * @example true */ exclude_owner_projects?: boolean @@ -24220,7 +24348,10 @@ export interface operations { description?: string /** @description A URL with more information about the repository. */ homepage?: string - /** @description Whether the repository is private. */ + /** + * @description Whether the repository is private. + * @default false + */ private?: boolean /** * @description Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see "[Creating an internal repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)" in the GitHub Help documentation. @@ -24242,11 +24373,17 @@ export interface operations { * @default true */ has_wiki?: boolean - /** @description Either `true` to make this repo available as a template repository or `false` to prevent it. */ + /** + * @description Either `true` to make this repo available as a template repository or `false` to prevent it. + * @default false + */ is_template?: boolean /** @description The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. */ team_id?: number - /** @description Pass `true` to create an initial commit with empty README. */ + /** + * @description Pass `true` to create an initial commit with empty README. + * @default false + */ auto_init?: boolean /** @description Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, "Haskell". */ gitignore_template?: string @@ -24267,9 +24404,15 @@ export interface operations { * @default true */ allow_rebase_merge?: boolean - /** @description Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. */ + /** + * @description Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. + * @default false + */ allow_auto_merge?: boolean - /** @description Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. */ + /** + * @description Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. + * @default false + */ delete_branch_on_merge?: boolean } } @@ -24678,7 +24821,10 @@ export interface operations { title: string /** @description The discussion post's body text. */ body: string - /** @description Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. */ + /** + * @description Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. + * @default false + */ private?: boolean } } @@ -25713,7 +25859,10 @@ export interface operations { * @example Update all gems */ note?: string | null - /** @description Whether or not the card is archived */ + /** + * @description Whether or not the card is archived + * @example false + */ archived?: boolean } } @@ -26356,6 +26505,7 @@ export interface operations { /** * @description Either `true` to make the repository private or `false` to make it public. Default: `false`. * **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. + * @default false */ private?: boolean /** @@ -26391,7 +26541,10 @@ export interface operations { * @default true */ has_wiki?: boolean - /** @description Either `true` to make this repo available as a template repository or `false` to prevent it. */ + /** + * @description Either `true` to make this repo available as a template repository or `false` to prevent it. + * @default false + */ is_template?: boolean /** @description Updates the default branch for this repository. */ default_branch?: string @@ -26410,13 +26563,25 @@ export interface operations { * @default true */ allow_rebase_merge?: boolean - /** @description Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. */ + /** + * @description Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. + * @default false + */ allow_auto_merge?: boolean - /** @description Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. */ + /** + * @description Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. + * @default false + */ delete_branch_on_merge?: boolean - /** @description `true` to archive this repository. **Note**: You cannot unarchive repositories through the API. */ + /** + * @description `true` to archive this repository. **Note**: You cannot unarchive repositories through the API. + * @default false + */ archived?: boolean - /** @description Either `true` to allow private forks, or `false` to prevent private forks. */ + /** + * @description Either `true` to allow private forks, or `false` to prevent private forks. + * @default false + */ allow_forking?: boolean } } @@ -31365,9 +31530,15 @@ export interface operations { * @default production */ environment?: string - /** @description Short description of the deployment. */ + /** + * @description Short description of the deployment. + * @default + */ description?: string | null - /** @description Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false` */ + /** + * @description Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false` + * @default false + */ transient_environment?: boolean /** @description Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise. */ production_environment?: boolean @@ -31481,18 +31652,30 @@ export interface operations { * @enum {string} */ state: 'error' | 'failure' | 'inactive' | 'in_progress' | 'queued' | 'pending' | 'success' - /** @description The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`. */ + /** + * @description The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`. + * @default + */ target_url?: string - /** @description The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `""` */ + /** + * @description The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `""` + * @default + */ log_url?: string - /** @description A short description of the status. The maximum description length is 140 characters. */ + /** + * @description A short description of the status. The maximum description length is 140 characters. + * @default + */ description?: string /** * @description Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. * @enum {string} */ environment?: 'production' | 'staging' | 'qa' - /** @description Sets the URL for accessing your environment. Default: `""` */ + /** + * @description Sets the URL for accessing your environment. Default: `""` + * @default + */ environment_url?: string /** @description Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true` */ auto_inactive?: boolean @@ -32083,7 +32266,10 @@ export interface operations { 'application/json': { /** @description The SHA1 value to set this reference to */ sha: string - /** @description Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work. */ + /** + * @description Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work. + * @default false + */ force?: boolean } } @@ -35878,13 +36064,22 @@ export interface operations { name?: string /** @description Text describing the contents of the tag. */ body?: string - /** @description `true` to create a draft (unpublished) release, `false` to create a published one. */ + /** + * @description `true` to create a draft (unpublished) release, `false` to create a published one. + * @default false + */ draft?: boolean - /** @description `true` to identify the release as a prerelease. `false` to identify the release as a full release. */ + /** + * @description `true` to identify the release as a prerelease. `false` to identify the release as a full release. + * @default false + */ prerelease?: boolean /** @description If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see "[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." */ discussion_category_name?: string - /** @description Whether to automatically generate the name and body for this release. If `name` is specified, the specified name will be used; otherwise, a name will be automatically generated. If `body` is specified, the body will be pre-pended to the automatically generated notes. */ + /** + * @description Whether to automatically generate the name and body for this release. If `name` is specified, the specified name will be used; otherwise, a name will be automatically generated. If `body` is specified, the body will be pre-pended to the automatically generated notes. + * @default false + */ generate_release_notes?: boolean } } @@ -36953,9 +37148,15 @@ export interface operations { name: string /** @description A short description of the new repository. */ description?: string - /** @description Set to `true` to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: `false`. */ + /** + * @description Set to `true` to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: `false`. + * @default false + */ include_all_branches?: boolean - /** @description Either `true` to create a new private repository or `false` to create a new public one. */ + /** + * @description Either `true` to create a new private repository or `false` to create a new public one. + * @default false + */ private?: boolean } } @@ -38340,7 +38541,10 @@ export interface operations { title: string /** @description The discussion post's body text. */ body: string - /** @description Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. */ + /** + * @description Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. + * @default false + */ private?: boolean } } @@ -41264,7 +41468,10 @@ export interface operations { description?: string /** @description A URL with more information about the repository. */ homepage?: string - /** @description Whether the repository is private. */ + /** + * @description Whether the repository is private. + * @default false + */ private?: boolean /** * @description Whether issues are enabled. @@ -41286,7 +41493,10 @@ export interface operations { has_wiki?: boolean /** @description The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. */ team_id?: number - /** @description Whether the repository is initialized with a minimal README. */ + /** + * @description Whether the repository is initialized with a minimal README. + * @default false + */ auto_init?: boolean /** * @description The desired language or platform to apply to the .gitignore. @@ -41316,9 +41526,17 @@ export interface operations { * @example true */ allow_rebase_merge?: boolean - /** @description Whether to allow Auto-merge to be used on pull requests. */ + /** + * @description Whether to allow Auto-merge to be used on pull requests. + * @default false + * @example false + */ allow_auto_merge?: boolean - /** @description Whether to delete head branches when pull requests are merged */ + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + * @example false + */ delete_branch_on_merge?: boolean /** * @description Whether downloads are enabled. @@ -41328,6 +41546,7 @@ export interface operations { has_downloads?: boolean /** * @description Whether this repository acts as a template that can be used to generate new repositories. + * @default false * @example true */ is_template?: boolean diff --git a/test/v3/expected/http.ts b/test/v3/expected/http.ts index 9280fd9c2..0150048fb 100644 --- a/test/v3/expected/http.ts +++ b/test/v3/expected/http.ts @@ -824,23 +824,32 @@ export interface components { name: components["schemas"]["Name"]; /** @enum {string} */ type: "boolean" | "string" | "number"; - /** @description This sets whether or not the feature can be customized by a consumer. */ + /** + * @description This sets whether or not the feature can be customized by a consumer. + * @default false + */ customizable?: boolean; /** * @description This sets whether or not the feature can be upgraded by the consumer after the * resource has provisioned. Upgrading means setting a higher value or selecting a * higher element in the list. + * + * @default false */ upgradable?: boolean; /** * @description This sets whether or not the feature can be downgraded by the consumer after the * resource has provisioned. Downgrading means setting a lower value or selecting a * lower element in the list. + * + * @default false */ downgradable?: boolean; /** * @description Sets if this feature’s value is trackable from the provider, * this only really affects numeric constraints. + * + * @default false */ measurable?: boolean; values?: components["schemas"]["FeatureValuesList"]; @@ -947,6 +956,8 @@ export interface components { /** * @description When true, everyone can see the product when requested. When false it will * not be visible to anyone except those on the provider team. + * + * @default false */ public?: boolean; /** @@ -955,6 +966,8 @@ export interface components { * but can still be provisioned directly if it's label is known. * Any pages that display information about the product when not listed, * should indicate to webcrawlers that the content should not be indexed. + * + * @default false */ listed?: boolean; /** @@ -968,18 +981,24 @@ export interface components { * @description Indicates whether or not the product is in `Beta` and should be * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. + * + * @default false */ beta?: boolean; /** * @description Indicates whether or not the product is in `New` and should be * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. + * + * @default false */ new?: boolean; /** * @description Indicates whether or not the product is in `New` and should be * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. + * + * @default false */ featured?: boolean; }; diff --git a/test/v3/expected/jsdoc.additional.ts b/test/v3/expected/jsdoc.additional.ts index 92ee6ef3e..16e76edc2 100644 --- a/test/v3/expected/jsdoc.additional.ts +++ b/test/v3/expected/jsdoc.additional.ts @@ -44,6 +44,7 @@ export interface components { * @example 2020-07-10 10:10:00.000 */ updated_at?: string + /** @example false */ deleted?: boolean } & { [key: string]: unknown } /** Image for preview */ diff --git a/test/v3/expected/jsdoc.exported-type.ts b/test/v3/expected/jsdoc.exported-type.ts index a4fbf5e5d..8e887479a 100644 --- a/test/v3/expected/jsdoc.exported-type.ts +++ b/test/v3/expected/jsdoc.exported-type.ts @@ -44,6 +44,7 @@ export type components = { * @example 2020-07-10 10:10:00.000 */ updated_at?: string + /** @example false */ deleted?: boolean } /** Image for preview */ diff --git a/test/v3/expected/jsdoc.immutable.ts b/test/v3/expected/jsdoc.immutable.ts index 2c3961643..224a138a3 100644 --- a/test/v3/expected/jsdoc.immutable.ts +++ b/test/v3/expected/jsdoc.immutable.ts @@ -44,6 +44,7 @@ export interface components { * @example 2020-07-10 10:10:00.000 */ readonly updated_at?: string + /** @example false */ readonly deleted?: boolean } /** Image for preview */ diff --git a/test/v3/expected/jsdoc.support-array-length.ts b/test/v3/expected/jsdoc.support-array-length.ts index 70bcda2a2..509fdac73 100644 --- a/test/v3/expected/jsdoc.support-array-length.ts +++ b/test/v3/expected/jsdoc.support-array-length.ts @@ -44,6 +44,7 @@ export interface components { * @example 2020-07-10 10:10:00.000 */ updated_at?: string + /** @example false */ deleted?: boolean } /** Image for preview */ diff --git a/test/v3/expected/jsdoc.ts b/test/v3/expected/jsdoc.ts index 70bcda2a2..509fdac73 100644 --- a/test/v3/expected/jsdoc.ts +++ b/test/v3/expected/jsdoc.ts @@ -44,6 +44,7 @@ export interface components { * @example 2020-07-10 10:10:00.000 */ updated_at?: string + /** @example false */ deleted?: boolean } /** Image for preview */ diff --git a/test/v3/expected/manifold.additional.ts b/test/v3/expected/manifold.additional.ts index ccff5ad3c..c0e574e43 100644 --- a/test/v3/expected/manifold.additional.ts +++ b/test/v3/expected/manifold.additional.ts @@ -826,23 +826,32 @@ export interface components { name: components['schemas']['Name'] /** @enum {string} */ type: 'boolean' | 'string' | 'number' - /** @description This sets whether or not the feature can be customized by a consumer. */ + /** + * @description This sets whether or not the feature can be customized by a consumer. + * @default false + */ customizable?: boolean /** * @description This sets whether or not the feature can be upgraded by the consumer after the * resource has provisioned. Upgrading means setting a higher value or selecting a * higher element in the list. + * + * @default false */ upgradable?: boolean /** * @description This sets whether or not the feature can be downgraded by the consumer after the * resource has provisioned. Downgrading means setting a lower value or selecting a * lower element in the list. + * + * @default false */ downgradable?: boolean /** * @description Sets if this feature’s value is trackable from the provider, * this only really affects numeric constraints. + * + * @default false */ measurable?: boolean values?: components['schemas']['FeatureValuesList'] @@ -951,6 +960,8 @@ export interface components { /** * @description When true, everyone can see the product when requested. When false it will * not be visible to anyone except those on the provider team. + * + * @default false */ public?: boolean /** @@ -959,6 +970,8 @@ export interface components { * but can still be provisioned directly if it's label is known. * Any pages that display information about the product when not listed, * should indicate to webcrawlers that the content should not be indexed. + * + * @default false */ listed?: boolean /** @@ -972,18 +985,24 @@ export interface components { * @description Indicates whether or not the product is in `Beta` and should be * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. + * + * @default false */ beta?: boolean /** * @description Indicates whether or not the product is in `New` and should be * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. + * + * @default false */ new?: boolean /** * @description Indicates whether or not the product is in `New` and should be * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. + * + * @default false */ featured?: boolean } & { [key: string]: unknown } diff --git a/test/v3/expected/manifold.exported-type.ts b/test/v3/expected/manifold.exported-type.ts index 286993632..3e4c19750 100644 --- a/test/v3/expected/manifold.exported-type.ts +++ b/test/v3/expected/manifold.exported-type.ts @@ -824,23 +824,32 @@ export type components = { name: components['schemas']['Name'] /** @enum {string} */ type: 'boolean' | 'string' | 'number' - /** @description This sets whether or not the feature can be customized by a consumer. */ + /** + * @description This sets whether or not the feature can be customized by a consumer. + * @default false + */ customizable?: boolean /** * @description This sets whether or not the feature can be upgraded by the consumer after the * resource has provisioned. Upgrading means setting a higher value or selecting a * higher element in the list. + * + * @default false */ upgradable?: boolean /** * @description This sets whether or not the feature can be downgraded by the consumer after the * resource has provisioned. Downgrading means setting a lower value or selecting a * lower element in the list. + * + * @default false */ downgradable?: boolean /** * @description Sets if this feature’s value is trackable from the provider, * this only really affects numeric constraints. + * + * @default false */ measurable?: boolean values?: components['schemas']['FeatureValuesList'] @@ -947,6 +956,8 @@ export type components = { /** * @description When true, everyone can see the product when requested. When false it will * not be visible to anyone except those on the provider team. + * + * @default false */ public?: boolean /** @@ -955,6 +966,8 @@ export type components = { * but can still be provisioned directly if it's label is known. * Any pages that display information about the product when not listed, * should indicate to webcrawlers that the content should not be indexed. + * + * @default false */ listed?: boolean /** @@ -968,18 +981,24 @@ export type components = { * @description Indicates whether or not the product is in `Beta` and should be * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. + * + * @default false */ beta?: boolean /** * @description Indicates whether or not the product is in `New` and should be * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. + * + * @default false */ new?: boolean /** * @description Indicates whether or not the product is in `New` and should be * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. + * + * @default false */ featured?: boolean } diff --git a/test/v3/expected/manifold.immutable.ts b/test/v3/expected/manifold.immutable.ts index c31fc4f2d..c610cd181 100644 --- a/test/v3/expected/manifold.immutable.ts +++ b/test/v3/expected/manifold.immutable.ts @@ -824,23 +824,32 @@ export interface components { readonly name: components['schemas']['Name'] /** @enum {string} */ readonly type: 'boolean' | 'string' | 'number' - /** @description This sets whether or not the feature can be customized by a consumer. */ + /** + * @description This sets whether or not the feature can be customized by a consumer. + * @default false + */ readonly customizable?: boolean /** * @description This sets whether or not the feature can be upgraded by the consumer after the * resource has provisioned. Upgrading means setting a higher value or selecting a * higher element in the list. + * + * @default false */ readonly upgradable?: boolean /** * @description This sets whether or not the feature can be downgraded by the consumer after the * resource has provisioned. Downgrading means setting a lower value or selecting a * lower element in the list. + * + * @default false */ readonly downgradable?: boolean /** * @description Sets if this feature’s value is trackable from the provider, * this only really affects numeric constraints. + * + * @default false */ readonly measurable?: boolean readonly values?: components['schemas']['FeatureValuesList'] @@ -947,6 +956,8 @@ export interface components { /** * @description When true, everyone can see the product when requested. When false it will * not be visible to anyone except those on the provider team. + * + * @default false */ readonly public?: boolean /** @@ -955,6 +966,8 @@ export interface components { * but can still be provisioned directly if it's label is known. * Any pages that display information about the product when not listed, * should indicate to webcrawlers that the content should not be indexed. + * + * @default false */ readonly listed?: boolean /** @@ -968,18 +981,24 @@ export interface components { * @description Indicates whether or not the product is in `Beta` and should be * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. + * + * @default false */ readonly beta?: boolean /** * @description Indicates whether or not the product is in `New` and should be * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. + * + * @default false */ readonly new?: boolean /** * @description Indicates whether or not the product is in `New` and should be * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. + * + * @default false */ readonly featured?: boolean } diff --git a/test/v3/expected/manifold.support-array-length.ts b/test/v3/expected/manifold.support-array-length.ts index 4a49d45e4..24ec72e23 100644 --- a/test/v3/expected/manifold.support-array-length.ts +++ b/test/v3/expected/manifold.support-array-length.ts @@ -824,23 +824,32 @@ export interface components { name: components['schemas']['Name'] /** @enum {string} */ type: 'boolean' | 'string' | 'number' - /** @description This sets whether or not the feature can be customized by a consumer. */ + /** + * @description This sets whether or not the feature can be customized by a consumer. + * @default false + */ customizable?: boolean /** * @description This sets whether or not the feature can be upgraded by the consumer after the * resource has provisioned. Upgrading means setting a higher value or selecting a * higher element in the list. + * + * @default false */ upgradable?: boolean /** * @description This sets whether or not the feature can be downgraded by the consumer after the * resource has provisioned. Downgrading means setting a lower value or selecting a * lower element in the list. + * + * @default false */ downgradable?: boolean /** * @description Sets if this feature’s value is trackable from the provider, * this only really affects numeric constraints. + * + * @default false */ measurable?: boolean values?: components['schemas']['FeatureValuesList'] @@ -947,6 +956,8 @@ export interface components { /** * @description When true, everyone can see the product when requested. When false it will * not be visible to anyone except those on the provider team. + * + * @default false */ public?: boolean /** @@ -955,6 +966,8 @@ export interface components { * but can still be provisioned directly if it's label is known. * Any pages that display information about the product when not listed, * should indicate to webcrawlers that the content should not be indexed. + * + * @default false */ listed?: boolean /** @@ -968,18 +981,24 @@ export interface components { * @description Indicates whether or not the product is in `Beta` and should be * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. + * + * @default false */ beta?: boolean /** * @description Indicates whether or not the product is in `New` and should be * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. + * + * @default false */ new?: boolean /** * @description Indicates whether or not the product is in `New` and should be * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. + * + * @default false */ featured?: boolean } diff --git a/test/v3/expected/manifold.ts b/test/v3/expected/manifold.ts index 4a49d45e4..24ec72e23 100644 --- a/test/v3/expected/manifold.ts +++ b/test/v3/expected/manifold.ts @@ -824,23 +824,32 @@ export interface components { name: components['schemas']['Name'] /** @enum {string} */ type: 'boolean' | 'string' | 'number' - /** @description This sets whether or not the feature can be customized by a consumer. */ + /** + * @description This sets whether or not the feature can be customized by a consumer. + * @default false + */ customizable?: boolean /** * @description This sets whether or not the feature can be upgraded by the consumer after the * resource has provisioned. Upgrading means setting a higher value or selecting a * higher element in the list. + * + * @default false */ upgradable?: boolean /** * @description This sets whether or not the feature can be downgraded by the consumer after the * resource has provisioned. Downgrading means setting a lower value or selecting a * lower element in the list. + * + * @default false */ downgradable?: boolean /** * @description Sets if this feature’s value is trackable from the provider, * this only really affects numeric constraints. + * + * @default false */ measurable?: boolean values?: components['schemas']['FeatureValuesList'] @@ -947,6 +956,8 @@ export interface components { /** * @description When true, everyone can see the product when requested. When false it will * not be visible to anyone except those on the provider team. + * + * @default false */ public?: boolean /** @@ -955,6 +966,8 @@ export interface components { * but can still be provisioned directly if it's label is known. * Any pages that display information about the product when not listed, * should indicate to webcrawlers that the content should not be indexed. + * + * @default false */ listed?: boolean /** @@ -968,18 +981,24 @@ export interface components { * @description Indicates whether or not the product is in `Beta` and should be * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. + * + * @default false */ beta?: boolean /** * @description Indicates whether or not the product is in `New` and should be * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. + * + * @default false */ new?: boolean /** * @description Indicates whether or not the product is in `New` and should be * advertised as such. This does not have any impact on who can access the * product, it is just used to inform consumers through our clients. + * + * @default false */ featured?: boolean } diff --git a/test/v3/expected/petstore-openapitools.additional.ts b/test/v3/expected/petstore-openapitools.additional.ts index a1ee76285..98efc4054 100644 --- a/test/v3/expected/petstore-openapitools.additional.ts +++ b/test/v3/expected/petstore-openapitools.additional.ts @@ -83,6 +83,7 @@ export interface components { * @enum {string} */ status?: 'placed' | 'approved' | 'delivered' + /** @default false */ complete?: boolean } & { [key: string]: unknown } /** diff --git a/test/v3/expected/petstore-openapitools.exported-type.ts b/test/v3/expected/petstore-openapitools.exported-type.ts index 270d67a05..ef9ca4a4d 100644 --- a/test/v3/expected/petstore-openapitools.exported-type.ts +++ b/test/v3/expected/petstore-openapitools.exported-type.ts @@ -83,6 +83,7 @@ export type components = { * @enum {string} */ status?: 'placed' | 'approved' | 'delivered' + /** @default false */ complete?: boolean } /** diff --git a/test/v3/expected/petstore-openapitools.immutable.ts b/test/v3/expected/petstore-openapitools.immutable.ts index b8e4884b4..f00f0c9cc 100644 --- a/test/v3/expected/petstore-openapitools.immutable.ts +++ b/test/v3/expected/petstore-openapitools.immutable.ts @@ -83,6 +83,7 @@ export interface components { * @enum {string} */ readonly status?: 'placed' | 'approved' | 'delivered' + /** @default false */ readonly complete?: boolean } /** diff --git a/test/v3/expected/petstore-openapitools.support-array-length.ts b/test/v3/expected/petstore-openapitools.support-array-length.ts index d426ccef4..2918a2ca3 100644 --- a/test/v3/expected/petstore-openapitools.support-array-length.ts +++ b/test/v3/expected/petstore-openapitools.support-array-length.ts @@ -83,6 +83,7 @@ export interface components { * @enum {string} */ status?: 'placed' | 'approved' | 'delivered' + /** @default false */ complete?: boolean } /** diff --git a/test/v3/expected/petstore-openapitools.ts b/test/v3/expected/petstore-openapitools.ts index d426ccef4..2918a2ca3 100644 --- a/test/v3/expected/petstore-openapitools.ts +++ b/test/v3/expected/petstore-openapitools.ts @@ -83,6 +83,7 @@ export interface components { * @enum {string} */ status?: 'placed' | 'approved' | 'delivered' + /** @default false */ complete?: boolean } /** diff --git a/test/v3/expected/petstore.additional.ts b/test/v3/expected/petstore.additional.ts index 568cfdf97..332bf1b5c 100644 --- a/test/v3/expected/petstore.additional.ts +++ b/test/v3/expected/petstore.additional.ts @@ -79,6 +79,7 @@ export interface components { * @enum {string} */ status?: 'placed' | 'approved' | 'delivered' + /** @default false */ complete?: boolean } & { [key: string]: unknown } Category: { diff --git a/test/v3/expected/petstore.exported-type.ts b/test/v3/expected/petstore.exported-type.ts index 144051c8c..a70d99e64 100644 --- a/test/v3/expected/petstore.exported-type.ts +++ b/test/v3/expected/petstore.exported-type.ts @@ -79,6 +79,7 @@ export type components = { * @enum {string} */ status?: 'placed' | 'approved' | 'delivered' + /** @default false */ complete?: boolean } Category: { diff --git a/test/v3/expected/petstore.immutable.ts b/test/v3/expected/petstore.immutable.ts index d495878be..62bbe98ef 100644 --- a/test/v3/expected/petstore.immutable.ts +++ b/test/v3/expected/petstore.immutable.ts @@ -79,6 +79,7 @@ export interface components { * @enum {string} */ readonly status?: 'placed' | 'approved' | 'delivered' + /** @default false */ readonly complete?: boolean } readonly Category: { diff --git a/test/v3/expected/petstore.support-array-length.ts b/test/v3/expected/petstore.support-array-length.ts index 733c95a71..a0c0ff3f1 100644 --- a/test/v3/expected/petstore.support-array-length.ts +++ b/test/v3/expected/petstore.support-array-length.ts @@ -79,6 +79,7 @@ export interface components { * @enum {string} */ status?: 'placed' | 'approved' | 'delivered' + /** @default false */ complete?: boolean } Category: { diff --git a/test/v3/expected/petstore.ts b/test/v3/expected/petstore.ts index 733c95a71..a0c0ff3f1 100644 --- a/test/v3/expected/petstore.ts +++ b/test/v3/expected/petstore.ts @@ -79,6 +79,7 @@ export interface components { * @enum {string} */ status?: 'placed' | 'approved' | 'delivered' + /** @default false */ complete?: boolean } Category: { diff --git a/test/v3/specs/falsey-example.yaml b/test/v3/specs/falsey-example.yaml new file mode 100644 index 000000000..626cd0375 --- /dev/null +++ b/test/v3/specs/falsey-example.yaml @@ -0,0 +1,37 @@ +openapi: 3.0 +paths: + /test: + get: + summary: '' + description: '' + responses: + 200: + description: '' + parameters: + - in: query + name: isEnabled + description: '' + schema: + type: boolean + example: true + required: true + - in: query + name: count + description: '' + schema: + type: number + example: 1 + required: true +components: + schemas: + TestSchema: + type: object + properties: + isEnabled: + type: boolean + default: false + example: false + count: + type: number + default: 0 + example: 0 \ No newline at end of file